Hyperion Planning Software User Manual
Oglas
Oglas
H Y P E R I O N ® S Y S T E M ™ 9
PLANNING
™
R E L E A S E 9 . 2 . 0 . 3
A D M I N I S T R A T O R ’ S G U I D E
Copyright 2001–2007 Hyperion Solutions Corporation.
All rights reserved.
“Hyperion,” the Hyperion logo, and Hyperion’s product names are trademarks of Hyperion. References to other companies and their products use trademarks owned by the respective companies and are for reference purpose only.
No portion hereof 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 recipient’s personal use, without the express written permission of Hyperion.
The information contained herein is subject to change without notice. Hyperion shall not be liable for errors contained herein or consequential damages in connection with the furnishing, performance, or use hereof.
Any Hyperion software described herein is licensed exclusively subject to the conditions set forth in the Hyperion license agreement.
Use, duplication or disclosure by the U.S. Government is subject to restrictions set forth in the applicable Hyperion license agreement and as provided in DFARS 227.7202-1(a) and 227.7202-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (Oct
1988), FAR 12.212(a) (1995), FAR 52.227-19, or FAR 52.227-14, as applicable.
Hyperion Solutions Corporation
5450 Great America Parkway
Santa Clara, California 95054
Printed in the U.S.A.
Contents
Preface
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv
CHAPTER 1 Using Planning
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
System ™ 9 BI+ ™ Web Analysis ™ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Contents
iii
CHAPTER 2 Getting Started with Planning
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
CHAPTER 3 Creating an Application
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Optimizing the Performance of Currency Conversion Calc Scripts . . . . . . . . . . . . . . . . . 68
iv
Clearing Options when Creating or Refreshing an Application Database . . . . . . . . . . . . . 79
CHAPTER 4 Setting Up Security
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
CHAPTER 5 Setting Up Alias Tables
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
CHAPTER 6 Setting Up the Calendar and Currencies
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Contents
v
CHAPTER 7 Setting Up Custom Dimensions
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
vi
Using Attributes and Attribute Values in Hyperion Application Link . . . . . . . . . . . . . . . 164
CHAPTER 8 Setting Up Scenarios and Versions
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Moving Scenario and Version Members Within the Dimension Hierarchy . . . . . . . . . . . . . . 176
CHAPTER 9 Loading Members and Data
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Contents
vii
CHAPTER 10 Managing Shared Services Models
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
viii
CHAPTER 11 Using Data Forms
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
Contents
ix
CHAPTER 12 Managing the Budgeting Process
CHAPTER 13 Working With Applications
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
x
CHAPTER 14 Menus, Smart Lists, UDAs, and Formulas
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
CHAPTER 15 Customizing Planning Web Client
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
Contents
xi
CHAPTER 16 Troubleshooting
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
Maximum Number of Applications Already Connected or Database is Locked . . . . . . . . . . 361
Slow Performance When Opening Data Forms Using a Dial-Up Connection . . . . . . . . . . . 364
APPENDIX A Customizing Data Forms with JavaScript
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
APPENDIX B Naming Restrictions for Analytic Services
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
Naming Restrictions for Dimensions, Members, Aliases, and Data Forms . . . . . . . . . . . . . . 399
xii
APPENDIX C Common Member Attributes
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
APPENDIX D Reference Application for Planning
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
Dimension Members in Planning Database—Small Application . . . . . . . . . . . . . . . . . . . 411
Dimension Members in Planning Database—Large Application . . . . . . . . . . . . . . . . . . . 411
Glossary
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
Index
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
Contents
xiii
xiv
Preface
Welcome to the Hyperion System 9 Planning Administrator’s Guide and help system. This preface discusses the following topics:
●
●
●
●
●
●
●
●
“Document Structure” on page xvi
“Where to Find Documentation” on page xvii
“Help Menu Commands” on page xviii
“Additional Support” on page xix
“Documentation Feedback” on page xx
Purpose
This documentation shows you how to create and maintain planning applications in Hyperion
System 9 Planning, as well as set up dimensions, the calendar, currencies, exchange rates, alias tables, data forms, task lists, reports, budgeting assumptions, and access rights. The Hyperion
System 9 Planning Administrator’s Guide and help system also step you through uploading data from and downloading data to Planning. It explains the Planning concepts and procedures that you need to use the software.
Included is information on optimizing performance, troubleshooting, and details on how
Planning interacts with and is enhanced by other Hyperion products.
Audience
This documentation 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, task lists, and access rights
Initiating and managing the budget process
Creating data forms, Hyperion System 9 Smart View for Office™ worksheets, and reports
Preface
xv
●
●
Uploading data to and downloading data from Planning
Customizing the Web interface
Document Structure
This document contains the following information:
Chapter 1, “Using Planning,” introduces Planning and other Hyperion products that are used
to enhance and extend Planning’s functionality and performance.
Chapter 2, “Getting Started with Planning,”
describes how to start Hyperion System 9 BI+™
Analytic Services™ server, start and navigate Planning, and register application servers for use with Planning.
Chapter 3, “Creating an Application,” describes how to create an application in Planning using
the Setup Application task on the Hyperion Planning Desktop and how to schedule a refresh of existing applications.
Chapter 4, “Setting Up Security,” describes how to assign access rights to users and groups.
Chapter 5, “Setting Up Alias Tables,”
describes how to set up and maintain multiple alias tables within a Planning application.
Chapter 6, “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 7, “Setting Up Custom Dimensions,”
describes how to work with the Entity dimension, the Account dimension, user-defined custom dimensions, and the members, attributes, and attribute values within each of the dimensions.
Chapter 8, “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 9, “Loading Members and Data,” describes how to populate Planning applications
with members and data from external systems.
Chapter 10, “Managing Shared Services Models,”
describes how to use Hyperion System 9
Shared Services
™
to share metadata and data between Hyperion applications.
Chapter 11, “Using Data Forms,”
describes how to create, modify, and manage data 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. It also describes how to set up and manage task lists, and copy data with supporting detail.
Chapter 13, “Working With Applications,”
describes how to set individual preferences and global settings for various aspects of the application, copy Planning data, and delete certain application information using SQL.
Chapter 14, “Menus, Smart Lists, UDAs, and Formulas,”
describes how to create and use menus, Smart Lists, UDAs, and member formulas.
xvi
Chapter 15, “Customizing Planning Web Client,” describes how to customize different aspects
of the Planning Web interface.
Chapter 16, “Troubleshooting,”
describes common errors when using Planning and potential resolutions for those errors.
Appendix A, “Customizing Data Forms with JavaScript,” describes how programmers can use
JavaScript to customize Web data forms.
Appendix B, “Naming Restrictions for Analytic Services,” describes the rules for naming
applications, databases, dimensions, members, and aliases in Analytic Services.
Appendix C, “Common Member Attributes,” lists the common member attributes used in
Shared Services and the equivalent member attributes in the Hyperion product.
Appendix D, “Reference Application for Planning,” provides an overview and set up
instructions for the Reference Application for Planning.
The
defines terms related to Planning.
The
contains a list of Hyperion Planning terms and their page references.
Where to Find Documentation
All Planning documentation is accessible from the following locations:
●
●
●
The HTML Information Map is available from the Help menu for all operating systems; for products installed on Microsoft Windows systems, it is also available from the Start menu.
❍
❍
For Planning Desktop, start the product, and then select Start > Programs > Hyperion
System 9 > Planning > Planning Information Map.
For Planning Web, start the product, and select Help > Information Map.
Online help is available from within Planning. After you log on to the product, you can access online help by clicking the Help button or selecting Help from the menu bar.
The Hyperion Download Center can be accessed from the Hyperion Solutions Web site.
➤
To access documentation from the Hyperion Download Center:
1
Go to the Hyperion Solutions Web site and navigate to Services > WorldWide Support > Download Center.
Note:
Your Login ID for the Hyperion Download Center is your e-mail address. The Login ID and Password required for the
Hyperion Download Center are different from the Login ID and Password required for Hyperion Support Online through Hyperion.com. If you are not sure whether you have a Hyperion Download Center account, follow the on-screen instructions.
2 In the Login ID and Password text boxes, enter your e-mail address and password.
3
In the Language list box, select the appropriate language and click Login.
4
If you are a member on multiple Hyperion Solutions Download Center accounts, select the account that you want to use for the current session.
Where to Find Documentation
xvii
5
To access documentation online, from the Product List, select the appropriate product and follow the on-screen instructions.
Help Menu Commands
describes the commands that are available from the Help menu in Planning:
Table i
Help Menu Commands
Command
Help on this Topic
Contents
Information Map
Technical Support
Hyperion Developer’s
Network
Hyperion Home
About Hyperion System 9
Planning
Description
Launches a help topic specific to the window or Web page
Launches the Planning Contents page
Launches the Planning Information Map, which provides the following assistance:
●
Online help in PDF and HTML format
●
Links to related resources to assist you in using Planning
Launches the Hyperion Technical Support site, where you submit defects and contact
Technical Support.
●
●
Launches the Hyperion Developer Network site, where you access information about known defects and best practices. This site also provides tools and information to assist you in getting starting using Hyperion products:
●
Sample models
A resource library containing FAQs, tips, and technical white papers
Demos and Webcasts demonstrating how Hyperion products are used
Launches Hyperion’s corporate Web site, where you access a variety of information about Hyperion:
●
Sample models
●
●
A resource library containing FAQs, tips, and technical white papers
Demos and Webcasts demonstrating how Hyperion products are used
Launches the About Hyperion System 9 Planning dialog box, which contains copyright and release information, along with version details
Conventions
The following table shows the conventions that are used in this document:
Table ii
Conventions Used in This Document
Item
➤
Brackets [ ]
Meaning
Arrows indicate the beginning of procedures consisting of sequential steps or one-step procedures.
In examples, brackets indicate that the enclosed elements are optional.
xviii
Table ii
Conventions Used in This Document (Continued)
Item
Bold
CAPITAL LETTERS
Ctrl+0
Ctrl+Q, Shift+Q
Example text
Courier italics
ARBORPATH
Meaning
Bold in procedural steps highlights user interface elements on which the user must perform actions.
Capital letters denote commands and various IDs. (Example: CLEARBLOCK command)
Keystroke combinations shown with the plus sign (+) indicate that you should press the first key and hold it while you press the next key. Do not type the plus sign.
For consecutive keystroke combinations, a comma indicates that you press the combinations consecutively.
Courier font indicates that the example text is code or syntax.
Courier italic text indicates a variable field in command syntax. Substitute a value in place of the variable shown in Courier italics.
When you see the environment variable ARBORPATH in italics, substitute the value of ARBORPATH from your site.
Ellipses (...)
Mouse orientation
Menu options letter. These variables are sometimes found in formulas.
Ellipsis points indicate that text has been omitted from an example.
This document provides examples and procedures using a right-handed mouse.
If you use a left-handed mouse, adjust the procedures accordingly.
Options in menus are shown in the following format. Substitute the appropriate option names in the placeholders, as indicated.
Menu name > Menu command > Extended menu command
For example:
1.
Select File > Desktop > Accounts.
Additional Support
In addition to providing documentation and online help, Hyperion offers the following product information and support.
●
●
“Education Services” on page xx
“Consulting Services” on page xx
“Technical Support” on page xx
●
For details on education, consulting, or support options, click the Services link at the Hyperion
Solutions Web site.
Additional Support
xix
Education Services
Hyperion offers instructor-led training, custom training, and e-Learning covering all Hyperion applications and technologies. Training is geared to administrators, end users, and information systems professionals.
Consulting Services
Experienced Hyperion consultants and partners implement software solutions tailored to clients’ particular reporting, analysis, modeling, and planning requirements. Hyperion also offers specialized consulting packages, technical assessments, and integration solutions.
Technical Support
Hyperion provides enhanced telephone and electronic-based support to clients to resolve product issues quickly and accurately. This support is available for all Hyperion products at no additional cost to clients with current maintenance agreements.
Documentation Feedback
Hyperion strives to provide complete and accurate documentation. Your opinion on the documentation is of value, so please send your comments by going to http://www.hyperion.com/services/support_programs/doc_survey/index.cfm
.
xx
Using Planning
C h a p t e r
1
This topic introduces Planning and other Hyperion products that are used to enhance and extend Planning’s functionality and performance.
In This Chapter
Using Planning
21
About Planning
Planning is a Web-based budgeting and planning solution that drives collaborative, eventbased operational planning processes throughout the organization for a wide range of financial and operational needs. Planning is a comprehensive approach for the complete and closedloop planning process that drives continuous business improvement. With 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, 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 Smart View
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
Integrates with other systems to load data (through Hyperion Application Link)
Smart View
Smart View provides a common Microsoft Office interface for Analytic Services, Hyperion®
System™ 9 Financial Management™, Planning, Hyperion® System™ 9 BI+™ Interactive
Reporting™, Hyperion® System™ 9 BI+™ Production Reporting™, Hyperion® System™ 9
BI+™ Financial Reporting™, and Hyperion® System™ 9 BI+™ Web Analysis™. Tasks that previously were repeated across products are now performed only once. The single interface also enables users to leverage multiple products simultaneously.
Smart View replaces the Spreadsheet Add-in versions earlier than Hyperion Financial
Management Release 4.0 and Hyperion Planning Release 4.0. Smart View replaces all versions of Essbase Spreadsheet Services Release 7.1.3 and earlier. Essbase Spreadsheet Add-in for
Analytic Services continues to be supported with this release.
Smart View provides tighter Microsoft Office integration by offering the following BI+ content features:
●
●
Import content into Excel, Word, PowerPoint, and Outlook
Expose functions for Financial Management and Analytic Services content in Word,
PowerPoint, and Outlook
Supported Microsoft Office versions are 2000, 2002, and 2003.
22
Using menu-driven options in Microsoft Office, you can import data and images from
Hyperion products into Microsoft Office.
Smart View enables you to take advantage of Microsoft Office features, such as smart tags, to add functions and import reports. The end user must log in to the data source within
Microsoft Office, enabling easy distribution and sharing of the Microsoft Office document.
However, if you log in to a data source connection in Microsoft Word, then you must log in again to access data in Excel or PowerPoint.
To view imported data within Microsoft Office, each user in an organization must install Smart
View.
The following topics provide more information about Smart View:
●
●
●
●
●
●
“BI+ Content Import” on page 26
For more information on using Smart View, see the Hyperion System 9 Smart View for Office
User’s Guide or Online Help that is installed with Smart View.
Benefit to Users
Smart View provides the following benefits:
●
●
●
●
●
A common Microsoft Office interface for Analytic Services, Financial Management,
Planning, Financial Reporting, Interactive Reporting, Production Reporting, and Web
Analysis
New and improved features compared with the former Financial Management and
Planning Add-ins and Essbase Spreadsheet Services
Ability to import content from Financial Reporting, Interactive Reporting, Production
Reporting, and Web Analysis
Ability to use smart tags to import BI+ content and functions
Auto deployment to notify end users when a newer version of Smart View is available.
Note:
Auto deployment is installed with Release 9.0, but is only activated to upgrade client machines with releases after
9.0.
Smart View
23
24
Key Features
Smart View includes the key features described in the following topics:
●
●
●
●
●
“BI+ Content Import” on page 26
Ad Hoc Analysis
Smart View provides the following Ad Hoc features:
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
Double-click to invoke the Ad Hoc analysis grid
Display Point of View member selector
Drag and drop members from the POV to the grid
Set the default POV by the user
Support duplicate member names
Zoom in and zoom out capabilities on dimension members and hybrid members
Drill-through
Pivot dimension members to columns or rows
Display cell text
Submit data
Keep only or remove only certain data cells
Adjust data values in cells
Calculate and consolidate data
Support asymmetric grids and free form mode
Save formatting
Preserve formulas
Undo and redo last actions
Select members, including Dynamic Time Series members
Suppress rows
Indent columns
Navigate without data
Zoom in levels
Specify member retention
Enable or disable double-clicking
●
●
●
●
●
●
●
Enable or disable undo feature
Specify labels for missing and no access data cells
Specify member display options
Specify data display options
Display messages
Apply cell styles
VBA functions, which support customization and automation of Smart View commands using Visual Basic for Application functions
Note:
Only Analytic Services and Financial Management support Ad Hoc.
Data Forms
Smart View provides the following data forms features:
●
●
●
●
●
●
●
●
●
●
●
●
●
View instructions
Adjust data
Manipulate existing data by performing unary operations
Lock and spread back values to base periods (Planning only)
Enter supporting detail (Planning only)
Enter cell text
Work offline
Synchronize with Financial Management, Planning, and Hyperion ® System ™ 9 Workforce
Planning ™ applications
Launch Business Rules (Planning only)
View Business Rules with runtime prompts (Planning only)
Preserve formulas
Apply cell styles
Select Smart List options
Note:
Only Financial Management and Planning support data forms.
Functions
Smart View provides the following function features:
●
●
Use Function Builder, an interface that guides the end user when creating functions
Support the following functions:
❍
HsGetValue
❍
HsSetValue
Smart View
25
26
●
●
❍
❍
❍
HsDescription
HsGetText (not supported in Analytic Services)
HsSetText (not supported in Analytic Services)
❍
❍
HsCurrency (not supported in Analytic Services)
HsLabel (not supported in Analytic Services)
Refresh the active worksheet or the entire workbook
Migrate existing Financial Management spreadsheet add-in functions to the new syntax
Note:
Only Analytic Services and Financial Management support functions.
BI+ Content Import
Smart View provides integration of Financial Reporting, Interactive Reporting, Production
Reporting, and Web Analysis with Microsoft Office products.
Smart View provides the following BI+ content import features:
●
●
●
●
Query the Hyperion product repositories to import BI+ content as an image in Microsoft
Excel, Word, and PowerPoint
Refresh previously inserted images and data
Export formatted images for Word and PowerPoint (Office 2002 and 2003 only)
Export formatted grids for Excel
Note:
Importing charts from Production Reporting is not supported in this release.
Smart Tags
Smart tags are predefined properties that associate available actions with a keyword. For example, if the end user types smart v iew
in an Excel cell, the smart tag icon is displayed next to Smart View.
Smart View provides the following smart tag features with Office 2003:
●
●
●
Display functions:
❍
❍
HsGetValue
HsGetText (not supported in Analytic Services)
❍
❍
HsCurrency (not supported in Analytic Services)
HsDescription
Import BI+ content into Microsoft Office 2003 (Excel, Word, PowerPoint, and Outlook, if
Word is the e-mail editor)
Refresh previously inserted BI+ content.
Planning Web Client
Planning provides complete functionality for the Web user, including reporting and analysis, process management, data form design, and management of access rights and task lists.
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, Planning lowers the total cost of ownership and simplifies deployment to many users who have access to the application anytime, anywhere.
Additional Products
To extend the power and flexibility of Planning, you can use it with additional products.
Hyperion Application Link
Hyperion Application Link is a suite of application integration services that integrates external source data with Hyperion’s business analysis software. It is purchased separately. You can use it to load data values, accounts, entities, and custom dimensions from flat files or ODBCcompliant databases into Planning. You can also load data from an Enterprise Resource
Planning (ERP) system such as SAP, J.D. Edwards World, or J.D. Edwards OneWorld.
Analytic Services
Planning leverages Hyperion System 9 BI+ Analytic Services analytic and calculation capabilities, security filters, APIs, pre-built financial intelligence, calculation functions and multi-database application support. Planning capitalizes on OLAP and data warehouse technologies by embedding powerful analysis, enhanced scalability, and data management functionality into a purpose-built planning application. Planning stores the application definition in a relational database and then uses this information to create the necessary
Analytic Services databases and security privileges for your application.
Hyperion® System™ 9 BI+™ Financial Reporting™
Financial Reporting 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. Financial Reporting meets a wide range of reporting needs on multidimensional data, including profit-and-loss statements, balance sheets and statutory reporting. Financial Reporting integrates with and extends the capabilities of Planning.
Additional Products
27
28
Planning users can use Financial Reporting 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. Financial Reporting makes 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® System™ 9 Business Rules™
Business Rules is an underlying component of Planning that provides comprehensive support for the planning needs of global finance organizations. Business Rules guides users through the creation, maintenance, customization, 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.
Planning users can use Business Rules to create, validate, launch, and organize business rules.
The following list describes the benefits of using Business Rules with Planning.
●
●
●
●
●
Macros simplify the creation of business rules and sequences, and save business rule designers time by enabling them to reuse pieces of business rules in other business rules or macros.
Variables of the saved selection type can be used not only at runtime, but also during design time to make business rules easier to design.
The logical organization of business rules, sequences, macros, and variables into projects makes them easier for you to maintain.
Enhanced calculation scripts that contain runtime prompts ensure valid inputs from, and provide guidelines for, budget preparers.
In Business Rules, predefined and reusable formulas that define unique cost and revenue calculations save business rule designers time during the design process.
Hyperion
®
System
™
9 BI+
™
Web Analysis
™
Web Analysis is an online analytical processing (OLAP) analysis, presentation, and reporting solution for the enterprise. Using Web Analysis with 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.
Web Analysis 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 Planning and Analytic Services, Web Analysis allows organizations to deliver information to large user communities at a low cost.
User Licensing for Third-Party Software
To use 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 WebLogic and WebSphere)
Planning Usage Scenario
The following topics outline the ways in which Planning may be used and the type of users that perform the various tasks. It contains the following topics:
●
●
●
●
●
●
“Setting Up the Application” on page 30
“Launching Business Rules” on page 38
“Starting the Budget Review Process” on page 38
“Post-Planning Activities” on page 40
Deployment
The IT professional at the customer site is responsible for the installation and configuration of
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 3
Server Installation Users and Tasks
User Type
IT professional
IT professional
IT professional
IT professional
IT professional
IT professional
IT professional
Task
Installs all Planning system requirements, including operating systems, relational database,
Web server, application server, and Web browser
Installs Analytic Services
Sets up the data source name (DSN) for the OLAP and relational databases
Installs Planning, as well as Financial Reporting, Hyperion Application Link, and Business Rules
(available by installing Hyperion® System™ 9 BI+™ Analytic Administration Services™)
Creates necessary relational databases and connections
Configures the Web server
Sets up users in an external authentication provider
Planning Usage Scenario
29
30
Table 3
Server Installation Users and Tasks (Continued)
User Type
IT professional
IT professional
Task
Optional: Creates a test application and adds users
Tests the installation and configuration
The following table lists the installation and configuration tasks that need to be performed on the client computers.
Table 4
Client Installation Users and Tasks
User Type
IT professional
IT professional
IT professional
Task
Installs the Planning remote Windows client, Smart View, Microsoft Excel 2000, Business Rules
(available by installing Analytic Administration Services), Financial Reporting, and Hyperion
Application Link
Installs a Web browser
Tests the connection from both the Web and the network
Setting Up the Application
Setting up the application consists of the activities described in the following topics:
●
●
●
●
●
●
●
●
●
●
“Creating Metadata” on page 31
“Setting Up Users and Security” on page 32
“Creating and Refreshing the Application” on page 32
“Designing Data Forms” on page 33
“Designing Worksheets” on page 33
“Populating the Application with Data” on page 34
“Creating Business Rules” on page 34
“Initializing the Planning Cycle” on page 36
The following topics provide more detail on each aspect of setting up the application.
Creating Metadata
●
●
●
●
●
Hyperion consulting partners and the 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 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)
Account
Entity
Scenario
Version
Period
Year
Some examples of additional custom dimensions include Products, Customers, Employees,
Sales Channels, and Projects.
Dimensions can be added manually through the Planning Web. However, the metadata typically exists in another external system, such as a general ledger, and can be transformed and uploaded into Planning using Hyperion Application Link and the Planning Adapter.
The administrator is involved in creating the metadata for Planning applications.
Table 5
Creating Metadata - Users and Tasks
User Type
Administrator
Administrator
Administrator
Administrator
Administrator
Task
Designs and creates an application in Planning
Defines metadata (currencies, scenarios, versions, calendar)
Enters exchange rates
Defines attributes and attribute values
Loads custom dimensions using Hyperion Application Link
Planning Usage Scenario
31
32
Setting Up Users and Security
An IT professional must set up users and groups and configure an external authentication provider before you can access those users in a Planning application. For information, see the
Hyperion System 9 Shared Services User Management Guide.
Within Planning, you assign individual users or groups to secured objects. Secured objects include:
●
●
●
●
●
●
●
●
Scenarios
Versions
Accounts
Entities
Custom dimensions
Web data forms
Business rules
Task lists
Table 6
Setting Up Users and Security - Users and Tasks
User Type
IT professional
Administrator
Administrator
Task
Sets up all Planning users with a supported external authentication provider
Synchronizes externally-authenticated users with a Planning application
Assigns users and groups to secured objects
Creating and Refreshing the Application
●
●
●
●
The administrator creates and periodically refreshes the Analytic Services outline and security structure for the Planning application. The Analytic Services outline and security structure are created based on the metadata that is stored in the Planning application’s relational database.
Planning programatically creates:
An Analytic Services application
Multiple Analytic Services databases (one per plan type)
Analytic Services security filters
Analytic Services outlines (all metadata)
❍
❍
❍
❍
Members
Shared members
User-defined attributes and attribute values
Exchange rates
Table 7
Generating the Database - Users and Tasks
User Type
Administrator
Task
Creates and refreshes the Planning application based on the metadata that is stored in the application’s relational database
Designing Data Forms
●
●
●
●
●
●
●
●
●
●
●
Using the Web client, the administrators and interactive users can design, organize, and maintain Web data forms. Data form design includes the following tasks:
Naming and describing the data form
Determining the layout of the data form (for example, which dimensions are assigned to which axis: columns, rows, POV, and page)
Setting the precision of the displayed values
Determining other data form properties, including annotations on accounts, displaying missing data as blank cells, suppressing missing data, and showing the data form fully expanded
Selecting which members are assigned to the data form
Selecting members by their attributes
Creating asymmetrical columns or rows
Associating business rules to a specific data form
Creating data form instructions
Setting up the display or printing properties
Assigning data form access to Planning users and groups
Table 8
Designing Data Forms - Users and Tasks
User Type Task
Administrator and interactive user
Creates and maintains data forms in Planning
Administrator and interactive user
Creates and manages folders in Planning for data form management
Administrator and interactive user Assigns access rights to data forms
Designing Worksheets
Any Planning user can install Smart View to work with data forms in Excel. These forms enable users to leverage their existing Excel worksheet models, build custom formulas, and report formats in a spreadsheet environment, or to work in a disconnected mode from Planning. For
more information about Smart View, see “Smart View” on page 22
.
Planning Usage Scenario
33
34
Populating the Application with Data
Administrators typically pre-populate the Planning application with data. Interactive users can also assist in bulk loading data directly into the applications.
Table 9
Populating the Application with Data - Users and Tasks
User Type
Administrator and interactive user
Any user type
Any user type
Any user type
Task
Performs bulk loads of actuals data, previous forecasts, and so forth, directly into Planning databases using Hyperion Application Link with the Essbase Adapter or Essbase
Administration Services for Essbase 7/Analytic Administration Services for Analytic
Services 9.2.
Enters values for global saved planning assumptions that are referenced in business rules
Enters data directly into the Planning application through a Web-based data form or Smart
View
Calculates and creates data using business rules or by using the Web-based copy version or copy data capabilities
Creating Business Rules
Both administrators and interactive users can design business rules in Hyperion System 9
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
❍
Capital expenditures
❍
Account receivables
Sources and uses of cash
Business rules can be designed with runtime prompts and can also be set up to run as a sequence. Business rules that reside in the Business Rules repository can be launched from
Planning Web and from Smart View.
Table 10
Creating Business Rules - Users and Tasks
User
Administrator
Task
Assigns users access to business rules
Administrator and interactive user
Creates models using Business Rules
Administrator, interactive user, and planner who have been assigned access by the
Administrator
Launches certain business rules to further populate the Planning application (for example,
Budget2 = Actual x 15%)
For information on creating and using business rules, see the Hyperion System 9 Business Rules
Administrator’s Guide and the Hyperion System 9 Business Rules Web Launcher User’s Guide. For more information on using business rules with Planning, see
“Using Business Rules” on page 267 .
Setting Targets
Administrators need to set up target type versions for the Planning application. A user’s access to target data is determined by their access 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 Analytic Services database so that the target data is not replaced by lower-level #Missing values.
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 Essbase Adapter
Modeling with Business Rules
Pushing targets down to lower-level members using business rules.
Table 11
Setting the Target - Users and Tasks
User Type
Administrator
Administrator
Administrator
Any user
Administrator
Any user
Task
Adds a standard target-type version
Assigns users access to the target version (typically, read-only access)
Configures the Analytic Services database so that target data is not replaced by lower-level
#Missing values
Creates target data
Publishes targets using Financial Reporting
Displays targets on data forms for guidance or input
Planning Usage Scenario
35
36
Reporting
Financial Reporting 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 Planning users who are using the
Web Viewer.
Financial Reporting works directly against the Analytic Services databases and adheres to the
Analytic Services security filters that are generated by Planning.
Table 12
Reporting - Users and Tasks
User Type Task
Administrator and interactive user
Creates and launches management reports using Financial Reporting
Any user
Any user
Prints reports to verify the bulk data loads and calculations
Views reports through the Financial Reporting Web Viewer throughout the planning cycle
Initializing the Planning Cycle
All users are involved in initializing the planning cycle at some level.
Table 13
Initializing the Planning Cycle - Users and Tasks
User Type
Administrator
Any user
Task
Selects which planning units are available for the iterative review, analysis, and approval process
Any user can indicate as a user preference 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
Administrators can set up task lists, which guide users through the planning process by listing tasks that need to be completed, along with instructions and due dates. Planning users start the planning cycle by logging into an application and opening the Web data forms to which they have access. Users read any data form instructions and review any historical or target data for guidance when preparing the plan. Users can enter data directly into the data form using a variety of techniques, including:
●
●
●
●
Entering data into 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
Copying data from one dimensional intersection to another dimensional intersection
●
●
Copying data from one version to another version
Using the supporting detail feature, which serves as a built-in calculator for developing data that is not in the member outline
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 forms, based on the data form design, provide for shorter text annotations. For example, these may be used to describe variances to targets or actuals.
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 Analytic Services database.
The subtotals on the data form are calculated and stored if the Calculate Data Form business rule is selected to run on save when the data form is created. By default, the Calculate Data
Form business rule is not selected to run on save.
Business rules are run that are set up to calculate automatically when users select to save.
The currently stored data values can be refreshed in the data 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 data form either before, or after the data is saved.
Table 14
Building a Plan - Users and Tasks
User Type
Any user with appropriate security access
Any user with appropriate security access
Any user with appropriate security access
Any user with appropriate security access
Any user with appropriate security access
Any user with appropriate security access
Any user with appropriate security access
Any user with appropriate security access
Any user with appropriate security access
Any user with appropriate security access
Task
Accesses a task list that provides guidance to expected actions
Accesses Web-based data forms
Reads data form-level instructions for planning guidelines, and reviews any historical or target data for guidance when preparing a plan
Enters data
Adjusts data values
Enters annotations (for example, assumptions) for planning units
Calculates business rules
Prints reports and analyses using Smart View, Financial Reporting,
Web Analysis, or third-party reporting tools
Copies the version of data to another version within the same scenario
Saves the data
Planning Usage Scenario
37
38
Launching Business Rules
The administrator or interactive user can create and launch business rules from Business Rules, which is available through the Analytic Administration Services Console. You can create business rules with runtime prompts or sequences. After a business rule is exported to the
Analytic Services database, any user can launch it from the Planning Web client or Smart View.
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 form or a Smart View worksheet can be launched from that source.
Table 15
Launching Business Rules - Users and Tasks
User Task
Administrator who has granted himself launch privileges, for each Planning application
Launch business rules from Business Rules (available from the
Analytic Administration Services Console)
Interactive user who has been granted launch privileges for each Planning application by the
Business Rules Admin
Launch business rules from Business Rules (available from the
Analytic Administration Services Console)
Any user (administrator, interactive user or planner) with launch privileges
Launch business rules from Planning Web client or Smart View
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 First 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 Process Definition Web page in the Planning application
Sorts the status page by entity, current process state, or current owner
Reviews annotations and planning unit history
Opens the data 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
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 16
Starting the Budget Review Process - Users and Tasks
User
Administrator
Any user with appropriate security access
Any user with appropriate security access
Any user with appropriate security access
Any user with appropriate security access
Any user with appropriate security access
Task
Starts the planning unit for the planning cycle
Enters data
Calculates data
Optionally, creates a copy of their submission
Promotes data for review
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.
Notifies the reviewer that the planning unit is ready for review Any user with appropriate security access
Any user with appropriate security access
Any user with appropriate security access
Any user with appropriate security access
Any user with appropriate security access
Reviews data values of the promoted planning unit
Reads and modifies promoted data through a Web-based data form
Saves and runs the business rules
Reads promoted data using Financial Reporting, Web Analysis, Smart View, or third-party reporting tools
Planning Usage Scenario
39
40
Table 16
Starting the Budget Review Process - Users and Tasks (Continued)
User
Any user with appropriate security access
Administrator
Administrator
Administrator
Administrator
Administrator
Administrator and interactive user
Task
●
●
●
●
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
Checks the status of the planning process, by the planning unit
Reads supporting annotations
Views the process history (audit trail)
Completes the planning cycle
Changes user access of scenarios and versions in Analytic Services to read-only
Publishes reports using Financial Reporting
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.
Table 17
Post-Planning Activities - Users and Tasks
User Type
All users with appropriate security access
Task
Administrator and interactive user
Uploads planning data by scenario to other applications, such as Financial Management, a general ledger, or an ERP.
Copies a version of the newly-completed plan to a new version or copies data from one dimensional intersection to another dimensional intersection.
Administrator and interactive user
Performs a bulk load of the new actual data into a Planning application to report on actual performance versus plan (for example, actual results versus budget).
All users with appropriate security access
Accesses a Web-based data form, Financial Reporting, Smart View, Hyperion® System™ 9
Performance Scorecard™ or third-party reporting tools to read updates to actuals and analysis of performance to plan.
Getting Started with Planning
C h a p t e r
2
This section describes how to start Analytic Services server, start and navigate Planning, and register application servers for use with Planning.
In This Chapter
Getting Started with Planning
41
Starting Analytic Services
The data for Planning applications resides on the Analytic Services server. Analytic Services must be running before you can open Planning applications. After Analytic Services is started, it can be minimized and run in the background or run as a service.
Connecting to Multiple Instances of Analytic Server
You can connect to multiple instances of the Analytic Server simultaneously from the Planning application by specifying the port number in the DSN and the
HspJSHome.properties
file.
(For information on the default location of the properties file, see “Default Location of the
Properties File” on page 45 .) Specify the port number in the Analytic Server text box using the
following format:
<
server
>:<
port
>
Note:
You can install more than one instance of the Analytic Server on the same computer. For information about how to install and configure an additional instance of the Analytic Server, see “Running Analytic Servers, Applications, and Databases” in the Hyperion System 9 BI+ Analytic Services Database Administrator’s Guide.
42
Getting Started with Planning
Starting the Relational Database
A relational database must be running before you can open Planning applications. After the relational database has been started, it can be minimized and run in the background or run as a service. This section contains the following topics:
●
●
●
“Optimizing an SQL Relational Database” on page 43
“Creating the Properties File” on page 43
“Configuring JDBC Connection Pooling” on page 46
Optimizing an SQL Relational Database
You can configure the timeout value through the Timeout registry key setting. Depending on the size of your database records, some of the SQL queries issued by Planning could take longer to execute than the default ADO timeout of 30 seconds. This could lead to failure when you try to refresh the application database. You can increase the timeout value (for example, to 180 seconds) to decrease the likelihood of a refresh failure.
➤
To optimize the timeout value:
1
Open the Registry Editor.
2
Navigate to the following location:
HKEY_LOCAL_MACHINE\SOFTWARE\Hyperion Solutions\Planning
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.
Note:
Its type must be DWORD.
Creating the Properties File
Before planners can access Planning, you must create its properties file. (For more information
about the properties file, see “About the Properties File” on page 44
.)
➤
To create the Planning properties file:
1
Launch the Configuration Utility by doing one of the following:
●
Select Start > Hyperion System 9 Shared Services > Configuration Utility.
●
Double-click the configtool.bat
file from the following location:
C:\HYPERION_HOME\common\config\9.0.0
The Hyperion welcome screen for the Hyperion Configuration Utility™ is displayed.
2
Click Next.
The Hyperion products installed on your computer are displayed.
3
Select Planning from the list of Hyperion products to configure, and click Next.
Starting the Relational Database
43
4
Select Create the Planning Properties File from the list of configuration tasks to perform, and click Next.
5
Deselect the Regenerate Planning properties file checkbox.
6
Make changes, if necessary, to the displayed destination path for the properties file.
7
Make changes, if necessary to the displayed Shared Services information (Server Name, Port Number,
User Name and Password). This information is used to store the Planning properties file in Shared
Services.
Scroll down to see the rest of the Create Properties panel.
8
If you are using Hyperion System 9 Business Rules
™
(HBR), perform the following tasks: a.
Select the Enable HBR check box.
b. Make any necessary changes to the default information for your Hyperion System 9 BI+
Analytic Administration Services™ (AAS) server name, port number, user name and password.
c.
Make any necessary changes to the default RMI port number. If you make a change, you have to manually update the RMIRegistry.
9
If you are using Oracle as your RDBMS, enter the name of the Oracle Server name used for Planning and the Oracle Database Name.
10
Click Next.
The Planning properties file (HspJSHome.properties) is generated and uploaded to the Shared
Services server. When the Planning properties file generation process is complete, the
Configuration Utility prompts:
Do you want to go back to the Product Selection Panel?
11
Choose one of the following options:
●
●
Select Yes to return to the product selection screen to perform configuration tasks for other products.
Select No to proceed to the configuration status screen, then click Finish to exit.
The
HspJSHome.properties
file is generated and uploaded to the Shared Services server. For information on the default location of the properties file, see
About the Properties File
The
HspJsHome.properties
file contains all the information required for users to log on to a
Planning application on the Web. It contains such information as which relational database each Planning application uses, which Analytic Services server each Planning application uses, and the logon information for the relational and Analytic Services servers. It also contains some general information applicable to all applications such as which Web application server is being used (for example, Apache Tomcat, WebLogic, and so on), the path to the external authentication configuration file, license deployment ID, and so on.
44
Getting Started with Planning
You can customize the properties file (for example, to view generated calculations or to add fonts). If you customize the properties file after creating it, your changes are preserved even if you regenerate the file using the Configuration Utility.
Default Location of the Properties File
If you specified the default path in the steps outlined in
application server you are using:
Table 18
Default Location of the HspJSHome.properties File
Web Application Server
Apache Tomcat
BEA WebLogic
IBM WebSphere
Default Path
<
drive letter
>:
\Hyperion\HyperionPlanning\AppServer\
InstalledApps\Tomcat\5.0.28\Webapps\HyperionPlanning\
Web-Inf\classes
<
drive letter
>:
\Hyperion\HyperionPlanning\AppServer\
InstalledApps\Weblogic\<version>\<domain name>\applications
<
drive letter
>:
\WebSphere\AppServer\installedApps\
<server name>\HyperionPlanning.ear\HyperionPlanning.war
Changing the JDBC Driver with the Properties File
The Configuration utility (as described in
“Creating the Properties File” on page 43 ) sets up
the default JDBC driver, the embedded Hyperion JDBC driver. However, if you need to, you can change the JDBC driver that Planning uses by changing JDBC driver name and URL in the properties file.
➤
To change the JDBC driver:
1
Open the
HspJSHome.properties
file.
For information on locating this file, see “Default Location of the Properties File” on page 45
.
2
Modify the following two lines in the properties file to reflect the updated JDBC driver, using the values in the following table:
<application name>_JDBC_DRIVER=
<application name>_JDBC_URL=
Table 19
Values for JDBC Lines in the Properties File
JDBC Driver Type
Oracle Thin
DB2 native
DB2 native for remote
DB2 server
JDBC_Driver Value
oracle.jdbc.driver.OracleDriver
COM.ibm.db2.jdbc.app.DB2Driver
COM.ibm.db2.jdbc.net.DB2Driver
JDBC_URL Value
jdbc:oracle:thin:@%SERVER_NAME%:
1521:%DB_NAME% jdbc:db2:%DB_NAME% jdbc:db2://myhost.mydomain.com:6
789/%DB_NAME"
Starting the Relational Database
45
3
Save the modified properties file.
4
Locate the necessary .
jar
file (for Oracle) or .
zip
file (for DB2):
●
●
If you are using Oracle, find the following file: classes12.jar
. It is located in the
OraHome\jdbc\lib
directory.
If you are using DB2, find the following file: db2java.jar or db2java.zip
file. It is located in the
\Program Files\sqllib\java directory.
5
Copy the .
jar
or .
zip
file in Step 4 to the appropriate destination directory, which depends on the Web application server you are using:
Table 20
Destination Directory for Each Web Application Server
Web Application Server
Apache Tomcat
BEA WebLogic
IBM WebSphere
Destination Directory
<
drive letter
>:
\Hyperion\HyperionPlanning\AppServer\
InstalledApps\Tomcat\5.0.28\Webapps\HyperionPlanning\
Web-Inf\classes
Take the following steps:
●
Extract the .
ear
file.
●
Copy the .
jar
or .
zip
file in Step 4 to the
HPDomain\applications directory.
●
Add the file to the CLASSPATH in startHPServer.cmd
<
drive letter>:\WebSphere\AppServer\installedApps\
<server name>\HyperionPlanning.ear\HyperionPlanning.war\
6
Stop and restart the Web application server.
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 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 Planning. An additional connection is created for the next four users who log on to Planning, resulting in a total of five connections. Any additional users who log on will share the five existing connections.
Note:
The JDBC connection settings in the HspJSHome.properties file are set by default to a minimum of 2 and a maximum of 10. The Planning application will not function correctly if you lower the maximum, JDBC_MAX, to less than 2.
46
Getting Started with Planning
➤
To reconfigure the JDBC connection pool parameters:
1
Open the
HspJSHome.properties
file.
For information on locating the properties file, see
“Default Location of the Properties File” on page 45 .
Note:
If this file does not exist, see
“Creating the Properties File” on page 43
for instructions on creating the Properties file.
2
Change the minimum and maximum values in the following lines:
●
●
JDBC_MIN_CONNECTIONS=2
JDBC_MAX_CONNECTIONS=10
3
Save and close the properties file.
Starting Planning on the Desktop
You can start Planning from the Microsoft Windows Desktop. You should have a basic understanding of the Microsoft Windows environment before you start using Planning. For information on using Microsoft Windows, see the Microsoft Windows User's Guide.
➤
To start the Planning Desktop from the Start menu: from the Microsoft Windows Desktop, select Start > Programs > Hyperion System 9 > Planning > Planning.
Using the Toolbar, Status Bar, and Navigation Frame
You can show or hide various components on the 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.
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 Planning. Showing these components provides you with access to Planning tasks. You must show the navigation frame to access any of the Planning tasks.
There are three types of nodes in the navigation frame.
●
●
●
The top-level nodes contain category nodes. 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 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.
Using the Toolbar, Status Bar, and Navigation Frame
47
F igure 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.
●
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:
●
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 Planning on the Web
To start 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 Planning applications. By default, the address is http://<computer_name>:<port>/Index.jsp
where
<computer_name> and
<port> are the name and port of the computer hosting the
Planning Web server
.
The Configuration utility assigns
<port> to 8300 by default, as shown in this example: http://localhost:8300/HyperionPlanning/LogOn.jsp
48
Getting Started with Planning
Here are some other points to know:
●
●
To launch Planning on the Web, make sure the Web server is started and the Web application server is running. To do this, select Start > Control Panel > Services.
As an alternative for logging on to Planning on the Web, you can enter or select the following URL address if Web users are not using Microsoft Windows, where <server's IP
address> is the IP address of the computer hosting the Planning application server. The URL is case-sensitive.
//<server's IP address>/HyperionPlanning/LogOn.jsp
Note:
You must set up a Properties file for Java components for each Planning application to make it available to the
Web. The Properties file must be regenerated whenever you upgrade applications from an earlier release of
Planning or delete existing applications.
For existing Planning applications, this is done automatically when the upgrade utility is used to migrate to the
.
Note:
Planning support users on a variety of network bandwidths, including users that access their networks through
56K dialup connections. The performance on a 56K dialup connection can be enhanced by using HTTP
compression on the Planning server. See “Slow Performance When Opening Large Data Forms” on page 363
.
Logging On without Browser Controls
Planners can log on to Planning without browser toolbars and menus. This gives them more room for their work.
➤
To log on without browser controls:
1
Enter this URL in your browser, http://<computer_name>:<port>/HyperionPlanning/Index.jsp
where
<computer_name>
and <port>are the name and port of the computer hosting the Planning Web server.
For example: http://localhost:8300/HyperionPlanning/Index.jsp
2
At the Logon page, enter your logon information,
●
●
●
For Application, select a Planning application to use.
For User Name, enter your system user ID.
For Password, enter your system password.
3
Click Log On.
You are logged in to Planning in a new browser window that does not display browser controls.
For more information, see the Hyperion System 9 Planning User’s Guide or help system.
Logging On without Browser Controls
49
Using Application Servers
You can access Planning applications through application servers in Planning desktop.
However, before you can access applications, you must first register the application servers on your workstation from within Planning desktop.
Registering a Server
➤
To register a server:
1
From the left navigation frame on the Hyperion Desktop, double-click Planning > Open Application.
2
In the Server drop-down list, type the name of the server that you want to register.
Note:
A server must exist in the Windows NT domain before it can be registered.
3 Click the Connect to Server button.
This registers the server and adds the server name to the drop-down list.
Unregistering a Server
➤
To unregister a server:
1
From the left navigation frame on the Hyperion Desktop, double-click Planning > Open Application.
2 From the Server drop-down list, select the server that you want to unregister.
3
Click the Unregister Server button.
This unregisters the server and removes the server name from the drop-down list.
Closing Planning and Analytic Services
Before you can close Planning on the Desktop, all task windows must be closed. If they are not closed, the system prompts you to close them before exiting Planning. You should also close all
Planning applications. However, keep in mind that this may affect other administrators who are currently logged on to the application.
Closing Planning returns you to the Microsoft Windows Desktop.
➤
To close Planning from the Desktop, select File > Exit.
➤
To close Analytic Services Server:
1
Maximize the Analytic Services window.
2
Type Quit.
50
Getting Started with Planning
➤
To log off from a Planning Web page, select File > Log Off. You are returned to the Log On page. You can log on again or log on to another application.
➤
To close Planning on the Web, select File > Exit. You are returned to your desktop.
Closing Planning and Analytic Services
51
52
Getting Started with Planning
Creating an Application
C h a p t e r
3
This section describes how to create an application in Planning using the Setup Application assistant and how to schedule a refresh of existing applications.
In This Chapter
Creating an Application
53
Prerequisites
Before you create an application, complete the following tasks:
●
●
●
●
●
Create a relational database.
Create and configure a Microsoft Data Link (.UDL).
Create a data source name (DSN).
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 System 9 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 Planning modules. The following is a list of the steps involved in 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 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 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 ®
System
™
9 BI+
™
Financial Reporting
™
Studio
™ User’s Guide.
This chapter covers only the first task. The remaining tasks for creating an application in
Planning are covered in subsequent chapters.
54
Creating an Application
Creating Applications with the Setup Application Task
The Setup Application task in Planning is the starting point for gathering information that is essential to building the Planning application and creating its corresponding metadata. Setup
Application guides you through the steps necessary to create applications quickly and easily.
Note:
Before you create an application with the Setup Application task, you must configure external authentication. See the Hyperion System 9 Shared Services User Management Guide.
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
)
)
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 58 )
Saving the application (see “Saving the Application” on page 59 )
Using the Select Workspace Frame
The Select workspace frame enables 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 Planning applications or relational databases.
Data sources are set up during the installation process. The IT administrator and the Planning budget administrator coordinate to ensure that data sources are set up for all the Planning applications that will be created.
➤
To use the Select workspace frame:
1 From the navigation frame on the Planning Desktop, double-click 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 display 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.
Creating Applications with the Setup Application Task
55
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.
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 special meaning to the relational database you are using, or be the same as an existing Analytic Services application. In addition, if Analytic Services is installed on a UNIX server, the application name cannot contain the underscore character. (This is a limitation of Planning and applies to Windows systems as well.) Hyperion recommends limiting the application name to alphanumeric characters.
Note:
Hyperion highly recommends that you not name an application “Planning.” Doing so may cause issues when you upgrade to a future release.
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 enables 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 102 .
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. Predefined 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 enable 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. Planning then automatically distributes the value the user enters over the base time periods that make up the summary time period.
56
Creating an Application
If you select a weekly distribution pattern other than Even Distribution, 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, 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:
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 445 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. For more information on the practical limits of calendar years and time periods, see
“Defining How Calendars Roll Up” on page 102
.
➤
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.
Creating Applications with the Setup Application Task
57
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 Currency 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
.
➤
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, you cannot change this option.
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.
Setting Up Plan Types
The Plan Types workspace frame allows you to include up to three plan types in the application. A separate Analytic Services 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 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
58
Creating an Application
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 names after the application has been created.
➤
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.
Note:
Plan type names can be up to eight characters. Although it is possible to enter more than eight bytes
(combination of single-byte and double-byte characters), you will receive an error message that the name is too long when you create the Analytic Services database.
Note:
If Analytic Services is installed on a UNIX server, the plan type name cannot contain the underscore character.
3
Optional: Repeat these steps for Plan Types 2 and 3.
4
Click Next.
Saving the Application
The Finish workspace frame enables 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.
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 Analytic Services dimensional outlines and alias tables are created and/or updated, and exchange rate values are repopulated into the Analytic
Services outlines.
Creating Applications with the Setup Application Task
59
Creating Additional Applications
Each time you want to create an additional 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, described in
“Creating Applications with the Setup Application Task” on page 55 .
UDL Encryption Enhancement
This release of Planning includes an enhancement for password encryption. You can configure the data source so the database connection string is encrypted.
For each Planning data source, you select the connection type: encrypted connection string,
DataLink file (.UDL), or system connection. The type of connection is stored in the registry as a ConnectionType registry key. Each Planning data source can have its own encrypted connection. After it is encrypted, the database connection string is stored in the
ConnectionString registry key. At run time, Planning detects the corresponding connection type associated with the data source, retrieves and decrypts the connection string, and uses the appropriate connection type.
For DB2 databases, when you create a data source for a Planning application with the “Use
Encrypted Connection String” option selected, you must select “Microsoft OLE DB Provider for ODBC drivers” after clicking Set. After choosing this provider and clicking Next, select
“Use Data Source Name” in the “Specify Source of Data” area on the Data Link
Properties/Connect tab. (The “Use Connection String” option is not supported, and is not related to the encrypted connection string option.) After you select “Use Data Source Name,” the Planning data source information is stored as an encrypted connection string in the registry.
Using Applications
After you create an application, you can then open, delete, or close the application, as described in the following topics:
●
●
●
●
“Opening Applications” on page 61
“Deleting Applications” on page 61
“Closing Applications” on page 63
“Unlocking Applications” on page 63
60
Creating an 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 the server’s 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 Planning Desktop, double-click Planning > Open Application.
2
From the Server drop-down list, select the server on which the application resides.
If the server on which the application resides is not displayed in the drop-down list, enter the name of the server in the Server text box.
3
Click Connect to Server.
If the server is not displayed in the drop-down list, the server is now automatically registered and will be listed in the drop-down list.
Note:
To remove a server from the drop-down list, click Unregister Server.
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:
When you are logged on, the server and application names are displayed in the Connected To text box on the
Open Application dialog box.
Deleting Applications
Only the application owner can delete a Planning application. When the application owner deletes an application, the Analytic Services application is also deleted and the application is no longer available to any Planning user. Before deleting an application, the application owner must be sure that no other user is currently using the application. Hyperion recommends that you back up the application’s system tables before you delete the application. Before deleting an application, you must also unregister it with Shared Services. (For more information on
registering and unregistering an application with Shared Services, see “Registering
Tip:
The default application owner is the administrator that created the application. The application owner can later re-assign ownership to another administrator.
Using Applications
61
➤
To back up system tables:
1
Determine which SQL database is the first database created when the first application for 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.
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 database 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
Change the System Data Link file to the Sysdat UDL as described in the Hyperion System 9 Planning
Installation Guide.
➤
To delete an application:
1 From the navigation frame on the Planning Desktop, double-click 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 display 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 display 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.
8
Click OK.
62
Creating an Application
Closing Applications
You can close a Planning application at any time.
➤
To close an application:
1
Close all the open windows on the Planning Desktop (for example, the Exchange Rates task).
2
Click Close Application to close the selected application.
Unlocking Applications
Occasionally a Planning application can become locked. This can be caused by an event such as abnormally exiting the application and 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 Planning application.
You must run the unlock application utility from the Planning application server. You can run it from the command line or you can invoke the executable directly.
It is a good idea to make sure there are no users in the Planning Desktop before running the utility. You can confirm this by launching the task manager on the Planning server and making sure there are no processes called hsxser~1 (hsxserver) or hspds.
➤
To unlock a Planning application:
1 Locate the UnlockApp utility by navigating to the
Utils
folder.
For example, if you installed Planning to the default location, the file is located in the
<drive>:\Hyperion\HyperionPlanning\Utils
directory.
2
Double-click
UnlockApp.exe
.
3
Select the application to be unlocked, 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
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 Planning users who are currently logged on to a specific application. You can either do this through the Planning
Desktop or through a command line utility. If you are sending a broadcast message through the
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,
Using Broadcast Messaging
63
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 Smart View 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 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 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 Financial Reporting, Hyperion Application Link,
Business Rules, Essbase Administration Services for Essbase 7/Analytic Administration
Services for Analytic Services 9.2, Web Analysis, or any other third-party reporting tools do not receive broadcast messages.
For information on:
●
●
Sending an announcement when scheduling an application refresh, see “Scheduling
Application Databases to be Refreshed” on page 72 .
Forcing users off the system, see “Limiting Use of an Application During Maintenance” on page 317 .
➤
To send a broadcast message through the Planning Desktop:
1
From the navigation frame on the Planning Desktop, double-click 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 Planning. BroadcastMessage.exe must be run on a server that is registered by the Planning application for which you want to send a broadcast message.
64
Creating an Application
2
The format and required arguments in the
BroadcastMessage
command line are:
broadcastmessage Server Name,Application Name,User Name,
Password,Message
Where:
●
●
●
●
●
Server Name
is assumed to be the localhost name.
Application Name
is the name of the application to whose logged-on users you want to send a message.
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 ABCserver, ,testapp,Jsmith001,admin,Please log off the application immediately for routine maintenance.
Viewing Usage Statistics
You can see how many and which 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 stored in the
HspJSHome.properties
file.
detail cache, see
“Allocating Memory for Supporting Detail Cache” on page 78
.
Those users who are logged on to the application through the Planning Windows client,
Financial Reporting, Hyperion Application Link, Smart View , Business Rules, Essbase
Administration Services for Essbase 7/Analytic Administration Services for Analytic Services
9.2, Web Analysis, or any other third-party reporting tools are not included in the list of logged on-users.
➤
To view usage statistics:
1 From Planning Web, log on to an application.
2
Select Administration > Statistics.
The usage statistics displayed are for each server.
Viewing Usage Statistics
65
Creating Application Databases
After you create an application, you need to create the Analytic Services multidimensional databases that store the application data. A separate Analytic Services database is created to store data for each plan type in the application. The databases are structured according to the dimensions, their hierarchical members, attributes, and other data that is specified in an application. In addition, Analytic Services creates an encrypted data file (
Essbase.sec
) to store security information.
This section contains the following topics:
●
●
●
●
●
“Optimizing the Performance of Currency Conversion Calc Scripts” on page 68
“Refreshing Application Databases” on page 69
“Working With Analytic Services Partitions” on page 72
“Scheduling Application Databases to be Refreshed” on page 72
“Examples of Scheduling an Application Refresh” on page 76
You can create Analytic Services databases for the application before completing the structure of the application. However, when the structure is complete, you need to refresh the Analytic
Services databases. When you make changes to the application structure (for example, when you modify properties of an Entity member, add a scenario, or change access assignments), those changes are stored in Planning’s relational database until you refresh the Analytic
Services 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
Analytic Services 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, if you have made changes to the database, Hyperion recommends that you always select to refresh the database information in conjunction with both the security information and the currency conversion calc script information.
Note:
All users must be logged off from the Planning application before the Analytic Services databases can be refreshed. For information on forcing users off the system, see
“Limiting Use of an Application During
Caution!
When you follow the steps below, the data in existing databases is erased and the Planning plan types are rebuilt. Hyperion recommends that you back up the existing application before proceeding. See
“Backing Up Applications and Application Databases” on page 79 .
66
Creating an Application
➤
To create databases in Analytic Services for an application:
1
From the navigation frame on the Planning Desktop, double-click Planning > Manage Application >
Manage Database.
2
To prevent users from logging on to the application while Planning prepares to create the databases, select the Lock Current Application From Other Users option.
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 Analytic Services multidimensional databases that store the application data.
Select Security Filters to store security information in an encrypted data file
(
Essbase.sec
).
Tip:
To generate security filters for all users in the application, select this check box, but do not select the Validate Limit check box. You might want to select this option and not the other options, which may affect data and metadata in the existing databases, if you updated access assignments in Planning and want to synchronize the entire security state to Analytic Services.
●
●
●
Select Shared Members if you are applying security directly to shared members in addition to base members. If you are applying security only to base members, clear this option.
Select Validate Limit to identify which, if any, security filters exceed the Analytic Services security filter limit of 64 KB per row. Users who exceed the security filter limit display in the Failed Security Filters dialog box.
This option validates the size of the security filters to make sure they do not exceed the size limit before actually building the security filters in Analytic Services. 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 calc script. Selecting the Currency Conversion CalcScript option does not launch the calc script.
4
If you select the Currency Conversion CalcScript option, the Currency Conversion CalcScript Parameters area is enabled. You can select from among the following options:
●
●
●
In the CalcScript Name text box, enter a name for the application currency conversion calc script.
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 calc script. Or select All to include all currencies. The selected currencies are target currencies to which you want to convert.
Creating Application Databases
67
●
●
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. The selected scenarios are the scenarios you want to include for currency conversions.
In the Version text box, select one or more versions as parameters for the application currency conversion calc script. Or select All to include all versions. The selected versions are the versions you want to include for currency conversions.
5
Click Create.
Optimizing the Performance of Currency Conversion Calc
Scripts
If multiple currencies are enabled for the Planning application and you have checked the
Currency Conversion Calc Script check box on the Manage Database task, a currency conversion calc script is created, based on the selected scenarios, versions, and currencies. (For
When the currency conversion calc script is created, a second calc script is automatically generated by Planning. Its purpose is to copy the appropriate exchange rates to the account, based on the account rate type. The 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 because it allows the currency conversion calc script to run in BLOCK mode, which is more efficient than running in CELL mode.
Note:
The selected scenarios, versions, and currencies must be able to store data in the Analytic Services database outline. Dynamic Calc, Dynamic Calc and Store, and Label Only 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 Analytic Services discards the results of the calculation for these members.
To correctly convert currencies, the first time a currency conversion is launched, administrators must run both the copy currency rates calc script and the currency conversion calc script. After you launch the
HSPCrtB.csc
or the
HspCrtT.csc copy calc script, you do not need to launch either one again unless you change the database outline (for example, by adding or changing exchange rates, account rate types, versions, scenarios, accounts, or userdefined dimension members).
To create the copy currency calc script for existing calc scripts, you need to regenerate currency
conversion calc scripts in the Manage Database task on the Planning Desktop. See “Creating
Application Databases” on page 66 .
68
Creating an Application
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.
Planning provides the flexibility to decide what information to transfer to Analytic Services databases and when to transfer that information. You can transfer the database changes, security information, or application currency conversion information at the same time or separately. This allows you to make database changes quickly available to users for data form creation and data entry. You may then select to transfer the security information during nonpeak hours, which maximizes system availability.
Caution!
When you follow the steps below, data may be removed, depending on the changes to the application. Hyperion recommends that you back up the existing application before proceeding. See
“Backing Up Applications and Application Databases” on page 79 .
➤
To refresh application databases in Analytic Services:
1
From the navigation frame on the Planning Desktop, double-click 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 Planning prepares to refresh 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 one of the Database options to refresh the Analytic Services multidimensional databases that store the application data:
❍
Incremental Update of Database – Refreshes the information in the Analytic Services database that has changed since the last time it was saved (that is, its last time stamp).
The functionality for this option is the same as for the Database check box in previous
Planning releases.
❍
Full Update of Database – Refreshes the entire Analytic Services database. Planning ignores which aspects have changed since the database was last saved (that is, it ignores the time stamps) and refreshes the entire database. You might use this option after performing a complex load of dimensions and members using Hyperion Application
Link.
Select Security Filters to store security information in an encrypted data file
(
Essbase.sec
).
To optimize performance, refresh checks for and updates security filters based on the changes made since the last time the databases were refreshed. The Security Filters option works in conjunction with the other Create/Refresh options in these ways:
Creating Application Databases
69
❍
❍
❍
If both Security Filters and Database are selected and refresh determines that the
Analytic Services hierarchy was changed and needs to be updated (for example, if a member was added), all security filters are rebuilt.
If Security Filters is selected and the status of the Shared Members selection has changed since the last refresh, then all security filters are rebuilt.
If Security Filters is selected and a user or group’s access has changed, then only the security filters for the user or group whose access has changed are rebuilt.
Note:
To update only a few user security filters, use the Create Security Filters task.
●
●
●
Select Shared Members if you are applying security to shared members in addition to base members. If you are applying security only to base members, clear this option.
Select Validate Limit to identify which, if any, security filters exceed the Analytic Services security filter limit of 64 KB per row. Users who exceed the security filter limit display in the Failed Security Filters dialog box.
This option can be used to validate security filter size limit before actually building the security filters in Analytic Services. To do so, select only this option.
Select Currency Conversion CalcScript to create a user-defined currency conversion calc script.
Selecting the Currency Conversion CalcScript option does not launch the calc script.
4
If you select the Currency Conversion CalcScript option, the Currency Conversion CalcScript Parameters area is enabled. Set the following options:
●
●
●
●
●
In the CalcScript Name text box, enter a name for the application currency conversion calc script.
In the Version Type area, select either Bottom-Up or Target. The selection you make affects the versions that are listed in the Version text box.
In the Currencies text box, select one or more currencies as parameters for the application currency conversion calc script, or select All to include all currencies. The selected currencies are target currencies to which you want to convert.
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. The selected scenarios are the scenarios you want to include for currency conversions.
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. The selected versions are the versions you want to include for currency conversions.
5
Click Refresh.
70
Creating an Application
Refreshing a Database with Level 0 Members Set to Dynamic Calc
If a level 0 member in the database outline is set to the storage option Dynamic Calc or
Dynamic Calc and Store, when you create or refresh the database, Planning completes the operation successfully, even if the members are not associated with a member formula.
Planning
adds a placeholder formula for those members that do not currently have a member formula.
About Database Restructures
Planning handles restructuring a database in the following ways:
●
●
●
Multiple outline changes are batched into a single database restructure.
During a restructure, either an attribute-only restructure or a full restructure is performed.
An attribute-only restructure is performed when only attribute-related changes occurred since the last restructure; otherwise, a full restructure is performed. The advantage of attribute-only restructures is that they can be executed concurrently with calc scripts and data entry operations, while full restructures cannot.
By default, Planning checks for restructure requests from the server every 5 seconds. You can reset this time interval so that Planning checks for restructures either less or more frequently than every 5 seconds.
➤
To configure the time interval between which Planning checks the server to determine the need for a restructure and, if finding changes, performs the appropriate restructure of the database:
1
Open the
HspJSHome.properties file.
For information on locating the properties file, see
“Default Location of the Properties File” on page 45 .
2
Add the following line to the properties file:
[APPLICATION NAME]_OLAP_BATCH_UPDATE=[n] where:
APPLICATION NAME
is the name of the application affected by this setting. Only the named application is affected by this setting. The application name is case-sensitive.
n
is the number of milliseconds between times that Planning checks for the need for a database restructure based on changes. At the time of the check, if outline-related changes have occurred since the last check, the changes are batched and the database is restructured. If no changes have occurred since the last check, then Planning waits another n milliseconds before checking again.
The parameter _OLAP_BATCH_UPDATE must be in all uppercase.
3
Save the
HspJSHome.properties
file.
For example, adding the following line to
HspJSHome.properties
sets the checking interval to 4 seconds for the application named HPAPP:
HPAPP_OLAP_BATCH_UPDATE=4000
Creating Application Databases
71
Working With Analytic Services Partitions
If you have licensed Analytic Services Partitioning, you can take advantage of partitions to access data that is shared between databases that may span applications or servers. For information on how to create and use partitions, see the Hyperion System 9 BI+ Analytic
Services Database Administrator’s Guide.
When you refresh a Planning application database, you may overwrite the Analytic Services partitions or corrupt the Analytic Services database. So, before you refresh an application database in Planning, you need to remove the Analytic Services partition definitions. After you have refreshed the Planning application, then redefine the Analytic Services partitions.
Note:
If you are using replicated partitions, an alternative is to create the partition definition at the time of replication, run the partition, and then drop the partition definition. Therefore, when running an application refresh, you do not need to remove the partition definition because it is created only at the time the partition is run.
Scheduling Application Databases to be Refreshed
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.
The application refresh utility checks to make sure the application is not locked before it runs.
application. So, users trying to edit a user or assign access, for example, receive a message,
“Cannot process your request because the application is being refreshed.” Web users will also see this message if an administrator has opened the Manage Database task on the Desktop.
During a scheduled application refresh, the metadata for an existing Planning application is updated in the Analytic Services database. The following lists some of the items that are updated during a refresh:
●
●
●
●
●
●
Analytic Services security filters
Currency conversion calc scripts
Accounts or any associated properties are propagated from the relational database to the
Analytic Services database
Custom attributes and access rights are added, modified, or deleted in the Analytic Services database
The exchange rate values are repopulated in the Analytic Services outline to incorporate additions, modifications, and deletions
Member formulas for certain accounts are generated or updated
72
Creating an Application
●
●
Additions or changes to alias tables and their association to dimensions or members are updated
The Analytic Services 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.
Keep the following points in mind:
●
●
●
●
The application refresh utility verifies only the syntax of the arguments you supply to run the utility. It does not perform a check to verify that the members you supply in the arguments are valid. If you supply an invalid scenario, version, or currency for the application or if you supply a nonreporting currency, the calc script is still generated, but running it produces an error. Therefore, you must supply valid parameters in the argument list for the calc script to run successfully.
Planning does not log Web users out of their applications during a scheduled refresh.
However, if an administrator launches the appscheduler.exe
utility using
/CL or
/RL
, any connections to the specified application from Smart View or Planning Desktop are terminated.
The appscheduler.exe
utility must be run from a computer where Planning Client has been installed. Installing Planning Server is not necessary to run this utility.
Hyperion recommends that administrators first send a broadcast message to all users to save their work and close the application before they refresh the Analytic Services application.
➤
To create a batch file that creates or refreshes a Planning application into a Analytic Services database:
1
Start Analytic Services.
2
Use the Microsoft Windows Scheduled Tasks tool (or another scheduler that accepts command line prompts) to enter the AppScheduler command line.
The appscheduler.exe is installed in the
Utils directory on the server computer when you install Planning.
3 The format and parameters in the AppScheduler command line are:
AppScheduler
([<
Server Name
>],<
Application Name
>,<
User Name
>,<
User
Password
>,<
Create/Refresh Specification
or
Broadcast
Message
>,<
Create/Refresh Options
>,[<
Currency Conversion CalcScript
Name
>],[<
Currency List
>],[<
Scenario List
>],[<
Version List
>],[<
Version Type
Specification
>], [<
Security on Shared Members
>])
The optional parameters are necessary only if you select to generate currency conversion calc scripts or security filters during the application refresh.
Creating Application Databases
73
●
●
●
●
●
[Server Name]
is optional. If you substitute a comma for this parameter, 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 or Broadcast Message
is the function to be performed on the application. Specify one of the following:
❍
❍
Use
/C
to create an application.
Use
/R to refresh the aspects of the application database that have changed since it was last saved.
❍
❍
❍
❍
Use
/RA
to refresh the entire application database, regardless of which aspects of the database have changed since it was last saved.
Use
/CL
to shut down the current instance of the Planning application, terminating any existing Planning Desktop and Smart View connections, launch a new locked version of the Planning application, and then create the databases for the specified
Analytic Services application. The Planning application remains locked until the appscheduler.exe
utility exits.
Use
/RL
to shut down the current instance of the Planning application, terminating any existing Planning Desktop and Smart View connections, launch a new locked version of the Planning application, and then refresh the databases for the Analytic
Services application. The Planning application remains locked until the appscheduler.exe
utility exits.
Use
/M
to broadcast a message to all users logged in to the specified application name.
You do not need to enter delimiters around the message text. The Message text cannot include a comma “,”.
For example: Appscheduler Hyperion,HPApp, user1,
password,/M,Please save your work and exit the 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 application currency conversion calc scripts.
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 calc script and is necessary only if you specified to generate an application currency conversion calc script.
If you include the Currency Conversion CalcScript Name parameter, you must also include the following four parameters.
74
Creating an Application
●
●
●
●
●
Currency List
is the list of currencies to be included in the application currency conversion calc script and are reporting currencies. This option is necessary only if you specified to generate an application currency conversion calc script. Be sure that the currencies you specify exist in the application.
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 calc script. This option is necessary only if you specified to generate an application currency conversion calc script. Be sure that the scenarios you specify exist in the application.
When specifying multiple scenarios, use a semicolon as a delimiter. For example,
scenario1;scenario2;scenario3.
Version List
is the list of versions to be included in the application currency conversion calc script. This option is necessary only if you specified to generate an application currency conversion calc script. Be sure that the versions you specify exist in the application.
When specifying multiple versions, use a semicolon as a delimiter. For example,
version1;version2;version3.
Version Type Specification
is the indicator for the type of versions that are included in the application currency conversion calc script.
❍
❍
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. Include this parameter if you are applying security to shared members in addition to base members. If you are applying security only to base members, ignore security on shared members.
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.
4 View the results of the application refresh, including any errors, in the Windows Event Viewer Application
Log.
If you are using a batch file to run appscheduler.exe, you may want to capture 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.
To see examples of some typical command lines, see
“Examples of Scheduling an Application
.
Creating Application Databases
75
Examples of Scheduling an Application Refresh
The following examples show typical command lines to both create and refresh an application, either with or without generating currency conversion calc scripts.
Create Application without Generating Currency Conversion CalcScripts
appscheduler HYPERION,HypApp,User,password,/C,1;2
Refresh Application without Generating Currency Conversion CalcScripts
appscheduler HYPERION,HypApp,User,password,/R,1;2
Create Application and Generate Currency Conversion CalcScripts for Bottom-up Versions with Security on Shared Members enforced
appscheduler HYPERION,HypApp,User,password,/C,1;2;3, currencyconvcalcname,currency1;currency2;currency3,scenario1; scenario2,version1;version2;version3,0,1
Refresh Application and Generate Currency Conversion CalcScripts for Target Versions with
Security on Shared Members enforced
appscheduler HYPERION,HypApp,User,password,/R,1;2;3, currencyconvcalcname,currency1;currency2;currency3,scenario1; scenario2,version1;version2;version3,1,1
Send a Log Off Message Announcement
appscheduler, Application,User,password, /M, Please save your work and log off immediately.
For more information on the APPSCHEDULER.EXE utility, see “Scheduling Application
Databases to be Refreshed” on page 72 .
Optimizing Application Performance
You can optimize application performance in the following ways:
●
●
●
●
Assigning dimensions as either dense or sparse. See
.
Changing the order of the dimensions from most dense to least dense. See “Changing the
Order of the Dimensions” on page 77
.
Allocating memory for supporting detail cache. See “Allocating Memory for Supporting
Clearing certain options when creating or refreshing an application database. See
Options when Creating or Refreshing an Application Database” on page 79 .
76
Creating an Application
Assigning 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.
Usually, the most common candidates for dense dimensions are Period and Account. The
Period dimension is usually highly populated with data and the Account dimension is usually dense due to the calculation-intensive nature of the dimension.
Note:
Analytic Services requires at least one dimension, and that it be set to dense. Custom attributes cannot be assigned to dense dimensions.
For more information about dense and sparse dimensions, see
.
Changing the Order of the Dimensions
You can also speed calculation time by changing the order in which the dimensions in the
Dimension list are calculated. The order of the dimensions is critical in the structure and performance of an Analytic Services database.
Dense dimensions calculate faster than sparse dimensions, and all dimensions should be listed from most dense to least dense.
Sparse dimensions should be separated into aggregating and non-aggregating dimensions, with the aggregating dimensions placed before the non-aggregating dimensions. An aggregating dimension is one in which the children aggregate into the parent and create new data. A non-aggregating dimension is one in which there is no new data created by the hierarchies (for example, a Scenario or Version dimension).
Therefore, you can optimize performance by ordering dimensions according to the following guidelines:
1. Make the Period and Account dimensions dense.
2. Order all dense dimensions from the most dense to the least dense. Usually, the most dense will be Period, followed by Account.
3. Separate sparse dimensions into aggregating and non-aggregating dimensions and place the aggregating dimensions before the non-aggregating dimensions. Within each type
(aggregating and non-aggregating), order the sparse dimensions from most dense to least dense.
➤
To optimize performance of a Planning application:
1
Select Administration > Dimensions.
2
Select the Performance Settings tab.
Optimizing Application Performance
77
3
From the Select Plan Type drop-down list, select a plan type.
The dimensions that belong to the plan type are displayed along with the number of dimensions for that plan type. Each application can have up to three plan types.
4
From the Dimensions list, select a dimension.
If the application is created with only one currency, the HSP_Rates dimension is not displayed.
5
Do one of the following:
●
●
Select 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.
Select 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
Do one of the following:
●
Click to move the dimension up in the list.
●
Click to move the dimension down in the list.
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.
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 stored in the
HspJSHome.properties
file.
➤
To change the default memory allocation for supporting detail cache:
1
Open the
HspJSHome.properties
file.
If this file does not exist, see “Creating the Properties File” on page 43
for instructions on
creating the properties file. For information on locating the properties file, see “Default
Location of the Properties File” on page 45 .
2
Change the PLAN_SUPPORTING_DETAIL_CACHE_SIZE entry.
3
Save and close the properties file.
For instructions on viewing the supporting detail cache usage, see
“Viewing Usage Statistics” on page 65
.
78
Creating an Application
Clearing Options when Creating or Refreshing an
Application Database
If you have a data form with a large number of members, when you create or refresh an application or open a data form on the Web, you may experience slow performance. You can dramatically improve performance by clearing the check box for Shared Members in the
Security Filters part of the Manage Database task. For more information on this check box, see
.
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 (Planning prompts you to perform a backup first)
Before moving an application to a new server
Before upgrading 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 steps described in the following topics:
●
●
●
Backing up the application in Analytic Services
Backing up the relational database for Planning and Hyperion System 9 BI+ Financial
Reporting Studio
Backing up the required components of Planning
For more information on backing up an application, see the Hyperion System 9 Planning
Installation Guide.
Backing Up Applications and Application Databases
79
80
Creating an Application
Setting Up Security
C h a p t e r
4
This section describes how to assign and report on access in Planning. For information on setting up external authentication, see the Hyperion System 9 Shared Services Installation Guide.
For information on setting up users and groups, see the Hyperion System 9 Shared Services User
Management Guide.
In This Chapter
Setting Up Security
81
About Access Rights and Security
Security and access rights enable you to control access to Planning applications and application elements. Setting up security lets you protect data and prevent unauthorized users from viewing or changing data. For example, you can restrict access to certain data elements or data forms within an application.
Security exists at several levels:
●
●
●
Authentication by an external provider. For information on configuring external authentication, see the Hyperion System 9 Shared Services Installation Guide.
The provisioning of users and groups in the Hyperion System 9 Shared Services User
Management Console
TM
. For information on setting up users and groups, see the Hyperion
System 9 Shared Services User Management Guide. An appendix on Planning provides information that is specific to Planning.
Note that Shared Services supports a number of roles that each have certain privileges in managing projects, users, and groups. For example, a user with the Project Manager role can create and manage projects in Shared Services. A user with the role of Provisioning
Manager can provision users and groups to applications.
Assigning users and groups access to the various aspects of the application. After users and groups are provisioned in the Shared Services User Management Console, you assign them access to the appropriate aspects of the Planning application. For more information, use this chapter and the Planning appendix in Hyperion System 9 Shared Services User Management
Guide.
Before using Planning, you must configure the application’s Distributed Component Object
Model (DCOM) settings. See
.
Configuring DCOM
Before using 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:
●
●
●
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 System 9 Planning Installation
Guide.
82
Setting Up Security
About Security in Planning
Security determines a user’s privileges in Planning. Access rights for users and groups can vary from one application to another. 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 forms
Task lists
Business rules
After you establish or update user and group security, the Planning application needs to be refreshed to complete the update to Analytic Services security filters. However, before doing this, you can validate that the size of the security filters does not exceed the Analytic Services limit of 64 KB per row. For more information about validating the security filters, see
“Creating Application Databases” on page 66
. Additionally, if you need to update only a few user security filters, you can do that with the Create Security Filters task. For more information about updating individual user security filters, see
“Creating Security Filters” on page 83
.
Note:
When you change the user type for a user, the user has full read/write access to the application through Smart
View and through Analytic Services until you refresh the Analytic Services database. Once the database has been refreshed, the appropriate access rights are applied to the user.
Creating Security Filters
When you add or modify users using the User Management Console, you can create or update a security filter in Analytic Services for one user or multiple users. 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.
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 66
.
About Security in Planning
83
➤
To create security filters for users:
1
From the navigation frame on the Planning Desktop, double-click Planning > Create Security Filters.
2
Select the users whose security filters you want to update.
3
Click .
About 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 assign access rights, as described in the following topic:
“Setting Up Security in Financial Reporting” on page 85
For information on which application elements can be secured, see “About Security in
.
Note:
Changing a user’s or group’s access to the dimension members affects the members that are displayed on the axis on the data form (after the application is refreshed). You should refresh Planning applications making any changes to user or group security.
You can assign access rights to a dimension member, data form, or task list when you add or modify that dimension member, data form or task list. In each instance, there is an Assign
Access option where you can assign access rights.
Note:
Before you can assign access to a user-defined custom dimension, you must select the dimension property Apply
Security. See “Setting Dimension Properties” on page 145
. Also, to generate a correct security filter for a particular user in Analytic Services, that user must have access assigned to members of all secured Planning dimensions. By default, the secured dimensions are Account, Entity, Version, and Scenario. In addition, if any user-defined dimensions have been secured, the user must then also have access assigned to members of these dimensions. If access has not been assigned in any one of these dimensions, the security filter built for this user in Analytic Services is set to None.
Access rights consist of the following options:
●
●
●
Read—Allows view access to the dimension member, data form, or task list for the specified user or group
Write—Allows view and modify access to the dimension member, data form, or task list for the specified user or group
None—Prohibits access to the dimension member, data form, or task list for the specified user or group
Note:
The default access is None and does not need to be specified.
84
Setting Up Security
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 describes inheritance options.
Table 21
Options for Inheriting Access Rights
Inheritance Option
Member
Children iChildren
Descendant iDescendant
Result
The access right is assigned only to the currently selected member.
The access right is assigned to all children members in the level below the currently selected member.
The access right is assigned to the currently selected member and all children members in the level below it.
The access right is assigned to all descendant members below the currently selected member.
The access right is assigned to the currently selected member and all descendant members below it.
Setting Up Security in Financial Reporting
Financial Reporting supports three types of security:
●
●
●
User Authentication
❍
Logon security
❍
Access to Financial Reporting and data source
Application Rights
❍
❍
❍
Access to tasks within Financial Reporting
Rights to design or view reports
Data Rights
❍
Access to data source data such as members and values
Access to Financial Reporting objects such as reports and folders
About Assigning Access Rights
85
Importing Access Rights
The
ImportSecurity
utility lets you load access rights for users and members from a text file into Planning. You can create a text file that specifies access information and load that information directly into your Planning application. This utility is useful for adding security after you have added a large number of users. (For information on adding users, see Hyperion
System 9 Shared Services User Management Guide.) The utility has a parameter that clears all existing access assignments:
SL_CLEARALL
. You can use this parameter alone to clear all existing access assignments, or you can use the parameter with other
ImportSecurity parameters to completely replace all existing access assignments with the import file.
Note:
Importing access rights overwrites existing access assignments only for explicitly imported members, users, or groups. All other existing access assignments remain intact.
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
Utils directory. If you installed Planning to the default location, the
Utils
directory is located in the following path:
<driveletter>:\Hyperion\HyperionPlanning\Utils
.
All users, groups, and members must already be defined in the application.
Access assignments to data forms are not imported.
Before importing security on a user-defined custom dimension, you must first allow security to be set on it by selecting the Apply Security check box on the dimension’s Property tab. If this check box has not been selected for a user-defined custom dimension, security for it cannot be imported. See
“Setting Dimension Properties” on page 145 .
Each line in the secfile.txt
file must specify security information.
Each line must contain the following items, separated by one of the following delimiters: , tab ; | : space. Comma is the default.
Item
username or group name member name access rights
Analytic Services access flags
Description
The name of a user or the name of a group that is already defined in the User
Management Console.
A member (account, entity, user-defined custom dimension, scenario or version) in the application.
Read, Write or None.
If there are duplicate lines for a username/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.
@CHILDREN, @ICHILDREN, @DESCENDANTS, @IDESCENDANTS and MEMBER.
Note: The implementation of security for these functions is the same as that in
Analytic Services.
86
Setting Up Security
For example, a file might contain the following lines:
User1,Account1,read,@CHILDREN
User2,Entity2,write,@DESCENDANTS
User3,Version_1,write,MEMBER
North America,Account101,write,@ICHILDREN
Note:
If a member, user, or group name contains a character that you are also using as the delimiter, enclose the name in double quotes. For example, if you are using a space as the delimiter, enclose the name South America in double quotes: “South America”.
To import security information into a group that has the same name as a user, append the following to the line in the
Secfile.txt
file that pertains to the group: sl_group
For example: admin,member1,read,member admin,member1,read,member,sl_group
The first line imports security for a user named Admin. The second line imports security for the group named Admin. If you omitted sl_group
, security information would be imported only for the user named Admin.
➤
To import security information into Planning:
1
Locate the
ImportSecurity
utility by navigating to the
Utils
directory.
If you installed Planning to the default location, the
Utils
directory is located in the following path:
<driveletter>:\Hyperion\Planning\Utils
.
2
From the Command Prompt, type the following command, one space, and the parameters, separating each parameter with a comma: importsecurity
UDL
,[delimiter],[
run_silent],
[SL_CLEARALL] where:
Parameter
udl
Explanation
The full path and name of the Planning UDL file that points to the application for which you are importing security.
delimiter run_silent
Optional: SL_TAB, SL_COMMA, SL_PIPE, SL_SPACE, SL_COLON, SL_SEMI-COLON. If no delimiter is specified, the comma default is assumed to be the delimiter.
Optional: Whether to execute the utility silently or with progress messages:
0 = execute with messages
1 = execute silently, with no messages
If this parameter is not included in the command line, the value is assumed to be 0, to display progress messages during execution.
[SL_CLEARALL]
Optional: Specify to clear all existing access assignments when importing the new access assignments. This option must be in uppercase.
Importing Access Rights
87
For example: importsecurity c:\
Hyperion\HyperionPlanning\Utils
\MyUDL.udl,SL_TAB,1
For example, to clear all access assignments in the application, type: importsecurity appUDL,,,SL_CLEARALL
3
After you execute the utility, check the log file importsecurity.log
in the
Utils
directory to verify the results.
The new security information is now accessible from the Dimensions tab on the Web. To see the new security information reflected on the Enter Data page, refresh the application databases with the Security Filters option checked. You do not need to restart the application server.
Tips When Importing Access Rights
This section offers some suggestions for optimizing performance and avoiding problems when importing access rights:
●
●
If you plan to import the access for many users, you can improve performance by making sure that their full names are not used. On Planning Web, select Preferences > Advanced
Settings option > System Settings tab and then clear the check box Display Users’ Full
Names.
If you are running both the
ImportSecurity utility and
AuthSrvr.bat
, you can avoid a warning about the RMI port already being in use by taking these steps:
❍
On the client computer, run
AuthSrvr.bat
from the command prompt, with the new port number as a parameter.
❍
On the server computer, update the
HspJSHome.properties
file with the following line:
Authentication port=<authentication port number>.
(For
information on locating the properties file, see “Default Location of the Properties
Reporting on Access Assignments
To help administrators effectively view the current access assignments in an application, the
User Management console provides an Access Control Report. The following sections describes how to use the Access Control Report to view current access assignments in the Planning application. You can view or print the reports.
➤
To report on current access assignments for users and groups in Planning:
1
Take one of the following actions from the User Management Console:
●
●
Select a Planning application under Projects and right-click. From the menu, select Access
Control Report.
Select a Planning application under Projects and select Administration > Access Control
Report.
88
Setting Up Security
2
On the Select User or Group tab, from the drop-down list, select whether you want to report on users, on groups, or on both users and groups by selecting one of the following:
●
●
●
Available Users
–to report on the users in the Planning application.
Available Groups
–to report on the groups in the Planning application.
Available Users and Groups
–to report on both the users and groups in the Planning application.
3
From the left panel of Available users or groups, select the users and groups you want to report on by taking any of the following actions:
●
Click the Add icon,
, to move the highlighted users and groups from the Available Users
and Groups
list to the Selected Users and Groups list.
●
Click the Remove icon,
, to move the highlighted users and groups from the Selected
Users and Groups
list to the Available Users and Groups.
●
Click the Add All icon,
, to move all the users or groups from the Available Users and
Groups
list to the Selected Users and Groups list.
●
Click the Remove All icon,
, to move all the users and groups from the Selected Users
and Groups
list to the Available Users and Groups list.
4
Click Next.
The Select Objects tab is displayed. For information on using this tab, see
.
Selecting the Reporting Objects
On the Select Objects tab, you select which type of objects you want to report on: Accounts,
Scenarios, Versions, Entities, user-defined custom dimensions, or Forms.
➤
To select which objects to report on:
1
Start the Access Control Report as described in
“Reporting on Access Assignments” on page 88
.
2
On the Select Objects tab, to select the Planning objects on which you want to report, take any of the following actions:
●
Click the Add icon,
, to move the highlighted objects from the Available Objects list to the Selected Objects list.
●
Click the Remove icon,
, to move the highlighted objects from the Selected Objects list to the Available Objects list.
Reporting on Access Assignments
89
●
Click the Add All icon,
, to move all the objects from the Available Objects to the Selected
Objects
list.
●
Click the Remove All icon,
, to move all the objects from the Selected Objects list to the
Available Objects
list.
3
Click Next.
The Report Options tab is displayed. For information on using this tab, see “Selecting the
Reporting Options” on page 90 .
Selecting the Reporting Options
On the Report Options tab, you select which aspects of access assignments you want to see and how you want the reported items grouped.
➤
To specify options for the access report:
1
Start the Access Control Report as described in
“Reporting on Access Assignments” on page 88
.
2
On the Report Options tab, from the Show Matching Access of Type check boxes, select the check boxes that correspond to the type of access on which you want to report:
●
●
●
Read
–to view Read access assignments
Write
–to view Write access assignments
None
–to view access assignments of None
3
From the Group the Results By, select how you want the results of the report grouped, by either:
●
●
Users
–to view the report sorted by the users’ names
Objects
–to view the report sorted by the assigned objects
4
From the Report Type sections, select the Assigned Access check box or the Effective Access check box, as described in the following table:
90
Setting Up Security
Table 22
Access Report Types
Report Type Description Options
Assigned Access
Effective Access
Summarizes the access assignments that an administrator has explicitly assigned
You can include information on whether the access is assigned by member selection relation or by belonging to a group. Select the following check boxes to reflect your choices:
●
●
Select the Show Matching Access of Relation check boxes to include which access assignments by member relationships you want to view: Member, Children, Children
(inclusive), Descendants, or Descendants
(inclusive).
Select the Show Inherited From Group check box to include information on those access assignments that are inherited by users belonging to a group.
Summarizes the access assignments as
Planning evaluates them (for example, by member selection relation such as
Children or by belonging to a group). This report is especially useful where there are conflicts in access assignments.
To include information that describes the origin of the effective access, select the Show Effective
Access Origin check box. For example, a user named JSomebody may be assigned Write access to Entity1 and also belong to a group named Sales that is assigned Read access to Entity1. Selecting this check box would show that JSomebody has
Write access to Entity1 because individual assigned access supersedes access that is inherited by belonging to a group.
5
Click Finish.
Adobe Acrobat launches, displaying the report online. For information on the displayed report, see
“Working With the Report on Access Assignments” on page 91
.
Working With the Report on Access Assignments
The report on access assignments is displayed in Adobe Acrobat, reflecting the selections you made using the Access Control Report. For more information on using the Access Control
Report, see
“Reporting on Access Assignments” on page 88 .
You can use the Adobe Acrobat toolbar to work with the report.
Setting up Audit Trails
Administrators can select the aspects of the application for which they want to track changes.
For example, they can track changes to metadata, such as when someone changes a member's property or adds a currency. They can also track changes in security, data forms, business rules, workflow, users, and so on. To view the results of the selected auditing options, an administrator creates and runs a report using any RDBMS report writer.
Reporting on Access Assignments
91
➤
To specify the aspects of the application for which you want Planning to record changes:
1
Perform one of the following actions:
●
●
Select Administration >
Reporting
.
Select File > New > Report.
2
Select the Auditing tab.
3
On the Auditing tab, select which actions Planning tracks:
Tip:
To avoid affecting performance, be selective in which application elements you audit.
Table 23
Actions That Can be Audited
Audit Options Tracked Actions
Dimension Administration
●
Changes to a dimension hierarchy: adding a member or dimension, moving, deleting, changing properties, renaming a member or dimension
●
●
●
Changes to performance settings: resetting a dimension's dense or sparse setting, changing the order of dimensions
Changes to currencies: adding or deleting a currency, setting a triangulation or reporting currency
Changes caused by utilities that affect Planning Web (for example, importing a data form design with the ImportFormDefinition utility)
Alias Table Administration Changes to alias tables: creating, copying, renaming, deleting, and clearing an alias table
Data
●
●
●
Changes to values in cells
Changes to supporting detail
Changes to account annotations
Launch Business Rules When calc scripts and business rules are launched (including runtime prompts)
Data Form Definition Changes to data forms: creating and modifying a data form, adding a row from the
Enter Data page
Note: The audit record does not record specifically how a data form design changed.
Changes to folders: creating, moving, deleting a folder Data Form Folder
Administration
Workflow
Copy Version
Security
●
●
Changes in process management:
●
Change in the owner of a planning unit
Change in the status of a planning unit
Whether a planning unit is started or excluded
When a version is copied, including the copy option (include supporting detail and annotations)
Note: The audit record does not record the details (for example, the data, supporting detail, and annotations) of the copied version.
Changes to access assignments to dimension members or data forms
92
Setting Up Security
Table 23
Actions That Can be Audited
Audit Options
Users Administration
Groups Administration
Tracked Actions
Adding, changing, or deleting users
Adding, changing, or deleting groups; adding or removing users from groups
Note:
For corresponding examples of tracked changes, see
“Examples of Tracked Actions” on page 93 .
4
Click Save Selections.
Depending on the audit options you select, changes to the application are recorded in a table named HSP_AUDIT_RECORDS, stored in the relational database.
5
Restart the Web application server.
6
At any time, view the results in the HSP_AUDIT_RECORDS table using any RDBMS report writer.
Note:
If anyone resets the audit options, those changes are also recorded.
Examples of Tracked Actions
For each recorded action, Planning tracks the following aspects:
Tracked Changes Examples
The type of change
The affected object (The columns ID_1 and ID_2 in the audit report help define the object that was changed. Its meaning changes by object type.)
Metadata, data, data form, security, planning units
Data Form: Expenses 04
Group: Marketing
User
Time Posted
Action
SBakey
12/12/2005 9:17
Add
Property
Old value
New value
Currency
Default
USD
Viewing and Clearing the Audit Report
Audit results are recorded in a table named HSP_AUDIT_RECORDS, stored in the relational database. You can view the audit results in HSP_AUDIT_RECORDS using any RDBMS report writer. To clear the audit report of all entries, use the SQL DELETE command on the
HSP_AUDIT_RECORDS
table in the relational database. To clear the audit report of entries that are a certain number of days old, compare them against the time_posted field.
Reporting on Access Assignments
93
For example, use the following SQL command to delete all entries from the audit records table:
DELETE FROM HSP_AUDIT_RECORDS
For example, to view audit records, sorted by the time they were posted:
SELECT * FROM HSP_AUDIT_RECORDS ORDER BY TIME_POSTED
94
Setting Up Security
Setting Up Alias Tables
C h a p t e r
5
This section describes how to set up and maintain alias tables in a Planning application.
In This Chapter
Setting Up Alias Tables
95
About Alias Tables
You can assign one or more alternate names, or aliases, to Planning Account, Currency, Entity,
Scenario, Period, Version, Year, and user-defined dimension members. Aliases provide the ability to create unique sets of identifiers when working with dimensions and members.
Planning allows up to 10 aliases per 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 Resources, Engineering, Sales, and so on). Members may also have aliases for different languages.
When creating a Planning application, Analytic Services 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. You cannot delete the default table.
However, you can create up to nine new alias tables for storing new aliases in Analytic Services.
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
Essbase Administration Services for Essbase 7/Analytic Administration Services for Analytic
Services 9.2 and select Outline > Aliases > Set Table and select a specific alias table.
Note:
You can only use alias tables that are created from within Planning. Alias tables that are created outside of
Planning are deleted during an application refresh.
Multiple alias tables support the following language combinations:
●
●
●
●
English, French, German, Spanish, and Italian
Japanese and English
Korean and English
Turkish and English
You can then set which alias table to use for the display of members in the application. For example, each time you open the Dimensions tab, either the default alias table or the alias table you selected as a preference is selected. The name of the selected alias table is displayed in the
Alias column header on the Dimensions tab. Planners can also set their preferred alias table by
selecting File > Preferences. See “Setting a Default Alias Table” on page 99 .
96
Setting Up Alias Tables
Creating Alias Tables
➤
To create an alias table:
1
Perform one of the following actions:
●
●
Select Administration >
Alias Tables
.
Select File > New > Alias Table.
2
Click Add.
3
In the Explorer User Prompt text box, enter a name of up to 30 characters for the alias table.
Note:
The alias table name cannot contain the tab, double quote “, or backslash \ characters. The alias table name cannot start with any of the following characters:
‘ \ < | , = @ _ + - { } ( ) .
4
Click OK.
Editing or Renaming an Alias Table
➤
To edit or rename an alias table:
1
Perform one of the following actions:
●
●
Select Administration > Alias Tables.
Select File > New > Alias Table.
2
Select the alias table you want to edit or rename.
3
Click Edit.
4
In the Explorer User Prompt text box, enter a name of up to 30 characters for the alias table.
Note:
The alias table name cannot contain the Tab, double quote “, or backslash \ characters. The alias table name cannot start with any of the following characters: ‘ \ < | , = @ _ + - { } ( ) .
5 Click OK.
Editing or Renaming an Alias Table
97
Deleting Alias Tables
➤
To delete an alias table:
1
Perform one of the following actions:
●
●
Select Administration >
Alias Tables
.
Select File > New > Alias Table.
2
Select the alias table you want to delete.
Note:
You cannot delete the default alias table.
3 Click Delete.
4
When you are prompted to confirm your intention to delete the alias table, click OK.
Clearing Alias Tables
You may choose to clear the contents of an alias table.
➤
To clear an alias table:
1
Perform one of the following actions:
●
●
Select Administration >
Alias Tables
.
Select File > New > Alias Table.
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 Values.
4 When you are prompted to confirm your intention to clear the contents of the alias table, click OK.
Copying Alias Tables
➤
To copy an alias table:
1
Perform one of the following actions:
●
●
Select Administration >
Alias Tables
.
Select File > New > Alias Table.
2
Select the alias table you want to copy.
3
Click Copy.
98
Setting Up Alias Tables
4
From the drop-down list, select the destination alias table to which you want to copy the aliases.
Note:
The destination alias table must be an existing table because the copy does not create a new table.
5
Click Copy.
Setting a Default Alias Table
If you have created alias tables that provide alternate names, or aliases, to Account, Currency,
Entity, Scenario, Period, Version, Year, and user-defined dimensions and members, you can select a new alias table as the default for the application. Users can still set their preference for 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. Administrators also see the name of this alias table displayed in the Alias column header on the Dimensions tab.
➤
To select the application’s default alias table:
1
Select Administration > Application Settings.
2
Select the Application Settings tab.
3
From the Alias Table drop-down list, select an alias table to be used as the default.
To revert to the application’s original default, select Default.
4
Select one of the following:
●
To save the current selections, click Save.
To reset the selections to those last saved, click Reset.
●
For information on setting other system defaults, see
“Setting Application Defaults” on page 315 and
“Specifying System Settings” on page 316 .
Setting a Default Alias Table
99
100
Setting Up Alias Tables
C h a p t e r
6
Setting Up the Calendar and
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.
In This Chapter
Setting Up the Calendar and Currencies
101
Customizing the Calendar
●
●
●
●
●
●
●
●
You use the Period dimension on the Dimensions tab to view and change the yearly calendar rollup structure. The time periods that span the Planning database are set up by the administrator creating the application. You can add more years to the calendar by working with the Year dimension. This section contains the following topics:
“Defining How Calendars Roll Up” on page 102
“Creating and Editing Summary Time Periods” on page 103
“Deleting Summary Time Periods” on page 104
“Working with Years” on page 105
“Setting the Fiscal Year” on page 106
“Renaming Time Periods” on page 106
“Assigning Aliases to Summary Time Periods” on page 107
“Editing the BegBalance Member” on page 107
The following table summarizes the various functions and options available on the
Dimensions tab when the Period dimension is selected, with links to the sections that discuss them in more detail.
Table 24
Calendar Tasks
Task
Define how years roll up.
Create and edit Summary Time Period.
Delete Summary Time Periods.
Work with the Period dimension hierarchy.
Set the fiscal year.
Search for a Time Period member.
Topic
See “Defining How Calendars Roll Up” on page 102
.
See “Creating and Editing Summary Time Periods” on page 103
.
See “Deleting Summary Time Periods” on page 104 .
See “Working with a Dimension Hierarchy” on page 126 .
See “Setting the Fiscal Year” on page 106 .
See “Finding Dimensions or Members” on page 128
.
Defining How Calendars Roll Up
The default rollup structure is based on the base time periods that are defined by the administrator when the application is set up. The following table illustrates the rollup scenario for each possible base time period:
Table 25
Calendar Roll Up
Base Time Period
12 Months
Roll Up
Four quarters are created per year. Months roll up into their parent quarter and quarters roll up into a year.
102
Setting Up the Calendar and Currencies
Table 25
Calendar Roll Up (Continued)
Base Time Period
Quarters
Custom
Roll Up
Quarters roll up into a year.
There are no default rollup structures. Instead, a flat list of the custom base time periods is displayed.
After the calendar in the application is created, you cannot change the base time period or reduce the number of years in the calendar. As the administrator, you can change the names, descriptions, aliases, and ranges of the summary time periods in the hierarchy.
You can have up to 100 calendar years and 500 time periods in an application. Actual limits are a function of both calendar years and time periods. How many time periods and years you can set also depends on whether your application uses multiple currencies. Hyperion recommends these practical limits for an application:
●
●
400 time periods per year and 27 years
360 time periods per year and 30 years
Creating and Editing Summary Time Periods
The New/Edit Time Period page lets you add and change summary time periods or the
BegBalance member (see
“Editing the BegBalance Member” on page 107
). You can change such aspects as the name, description, alias, starting period, and ending period. However, you cannot change the order of base time periods or skip base time periods. Also, the range cannot extend beyond the current fiscal year.
➤
To create or edit a summary time period:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select Period.
3
Perform one of the following actions:
●
To add a time period, select the level in the dimension hierarchy above which you want to add the time period and click Add.
Note:
You must work from the top of the hierarchy to the bottom when you create summary time periods. Otherwise,
Planning views the rollup structure as asymmetrical and you cannot continue. The new summary time period displays in the hierarchy as a parent of the selected item. Also note that to enforce a balanced hierarchy, all base members must be the same number of levels from the root.
●
To edit a time period, select the time period and click Edit.
Customizing the Calendar
103
4
In the Name text box, enter or change the name for the summary time period.
5
Optional: In the Description text box, enter a description of up to 255 characters for the summary time period.
6
Optional: From the Alias drop-down list, select an alias table to be used for the summary time period.
Enter an alias in the text box.
The default table is used if you do not make a specific choice.
7 From the Start Period drop-down list, select the starting period.
Some points to know about changing the range of a summary time period:
●
The range cannot extend beyond the current fiscal year. For information on resetting the
current fiscal year, see “Setting the Fiscal Year” on page 106
.
●
●
If you select a summary time period with no sibling above it, then the Start Period dropdown list displays its first child.
If you select a summary time period that has a sibling above it, then the Start Period dropdown list displays all children except the first child of the sibling above it.
8 From the End Period drop-down list, select the ending period.
●
●
If you select a summary time period with no sibling below it, the End Period drop-down list displays its last child.
If you select a summary time period with a sibling below it, the End Period drop-down list displays all children from the Start Period through the next sibling’s children, except for the last child.
9
Click Save.
Deleting Summary Time Periods
When you remove a summary time period from the hierarchy, its children are moved into another summary time period, as follows:
●
●
●
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.
➤
To delete a summary time period:
1 Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select Period.
104
Setting Up the Calendar and Currencies
3
From the Period hierarchy, select the summary time period that you want to delete.
Note:
You cannot delete a base time period.
4
Click Delete.
5 When prompted to confirm the deletion, click OK.
Working with Years
You use the Year dimension on the Dimensions tab to work with the years in the calendar.
When creating the Planning application, the administrator sets up the number of years in the planning calendar. After the calendar in the application is created, you cannot reduce the number of years in the calendar. You can, however, add years to the calendar, change the current year or period, and assign aliases to time periods or years.
The following table summarizes the various functions and options available on the
Dimensions tab when the Year dimension is selected, with links to the sections that discuss them in more detail.
Table 26
Year Tasks
Task
Add years to the calendar.
Set the fiscal year.
Work with the Year dimension hierarchy.
Search for a Year.
Topic
See “Adding Years to the Calendar” on page 105
.
See “Setting the Fiscal Year” on page 106 .
See “Working with a Dimension Hierarchy” on page 126 .
See “Finding Dimensions or Members” on page 128
.
Adding Years to the Calendar
You can add years to the calendar. You cannot reduce the number of years in the calendar without creating a new database. For information on the practical number of years in an
application, see “Defining How Calendars Roll Up” on page 102 .
➤
To add years to the calendar:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select Year.
3
Click Add Years.
Customizing the Calendar
105
4
In the Number of Years to Add text box, enter the number of years you want to add to the calendar.
For information on the practical limits on the number of years in an application, see “Defining
How Calendars Roll Up” on page 102
.
5 Click Add Years.
Setting the Fiscal Year
Initially, the Set Current Time Period and Year dialog box displays the current time period and year for the calendar that was defined when the application was created. You can change either the time period or the current year.
➤
To change the current year or time period:
1 Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select either Year or Period.
3 Click Options.
4
On the Set Current Time Period and Year dialog box, from the Current Year drop-down list, select the current year.
Note:
The Current Month and Current Year selections set the defaults for the Month and Year drop-down lists when a new scenario is created. For example, if the Current Year is set to FY08 and the Current Month is set to Aug, when a user creates a new scenario, these values are displayed as defaults in the Start Yr, Start Period, End Yr, End Period fields in the Create Scenario dialog box.
5
From the Current Time Period drop-down list, select the current period.
6
Click Save.
Renaming Time Periods
You can rename root-level, base time periods, and user-defined summary time periods. For instructions, see
“Creating and Editing Summary Time Periods” on page 103
.
106
Setting Up the Calendar and Currencies
Assigning Aliases to Summary Time Periods
You can assign an alternate name, or alias, to years on the Edit Aliases dialog box. You can also assign and change aliases to base time periods and summary time periods. See
Editing Summary Time Periods” on page 103 .
➤
To assign or change an alias for a year:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select Year.
3
Select the year for which you want to assign an alias.
4
Click Edit Year.
5
On the Edit Aliases dialog box, from the Alias Table drop-down list, select the alias table you want to use.
6
In the text box, type an alias name.
7
Click Save.
Editing the BegBalance Member
You can now edit the BegBalance member of the Period dimension. As the first time period in the application, the BegBalance member is useful for entering beginning data when you start a new application, a new fiscal year, or a new calendar year. You can rename BegBalance, give it a description, and give it an alias.
➤
To edit the BegBalance time period:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimensions drop-down list, select Period.
3
Select the first member, BegBalance.
4
Click Edit.
5
In the Edit Period dialog box, take any of these actions:
●
●
●
In the Name text box, type a new name for the BegBalance member.
In the Description text box, type a description of up to 255 characters.
From the Alias drop-down list, select an alias table to be used for the BegBalance member, then enter an alias to be used.
6 Click Save.
Customizing the Calendar
107
Setting Up Currencies
You can plan, forecast, and analyze your financial information in a single currency or in multiple currencies, as described in the following sections:
●
●
●
●
●
●
●
●
“Enabling Multiple Currencies” on page 109
“Working with Multiple Currencies” on page 109
“About the Calculate Currencies Business Rule” on page 110
“Exchange Rate Types” on page 111
“Number Formatting” on page 111
“Reporting Currencies” on page 112
“Seeing How a Currency is Used” on page 112
As the 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 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
The following table summarizes the various functions and options available on the
Dimensions tab when the Currency dimension is selected, with links to the topics that discuss them.
Task
Create currencies.
Edit Currencies.
Delete Currencies.
Show Currency Usage.
Topic
See
“Creating Currencies” on page 113 .
See
“Editing Currencies” on page 115
.
See
“Deleting Currencies” on page 116
.
See
“Seeing How a Currency is Used” on page 112
.
108
Setting Up the Calendar and Currencies
Enabling Multiple Currencies
When you create an application, you specify whether the application uses only one currency or multiple currencies. 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 enable
multiple currency support per entity on the data forms you create. See “Setting a Data Form’s
. When selecting business rules for a data form, you can select the
Calculate Currencies business rule to convert values among the available currencies. See
“Selecting Business Rules” on page 268
.
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:
●
●
●
●
●
When the local currency is selected on a data 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 as described in
“Creating Currencies” on page 113
.
You can load values (from historical scenarios, for example) into a reporting currency by using the Essbase Adapter to populate values directly into Analytic Services.
Currencies that are defined for the application, including reporting and non-reporting currencies, are valid currencies for data entry. The valid currencies for data entry are displayed in a list that users can access by clicking the Currency 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.
Applications with 500 time periods can successfully run currency conversion calc scripts only if the time periods have default names, TP 1 through 500. Otherwise, the conversion calc script you are trying to create exceeds the 64K limit.
Setting Up Currencies
109
●
●
●
●
●
User-defined currency conversion calc scripts created when a database is created or refreshed may be made available in Smart View, depending on user access. If a user-defined currency conversion calc script is selected to run in a worksheet, Hyperion recommends that the user change the order so that the currency conversion calc script is placed first, before the Calculate Data Form script.
Because currency codes associated with input values are stored as numeric values in
Analytic Services, these codes are also calculated in dimension formulas, calc scripts, and business rules. The calculated values of these currency codes may translate to currency codes that are incorrect or invalid. As a result, where there are children with mixed currencies, it is important to review the calculated results on the upper levels.
If a parent has multiple children, of whom only one child has an overridden currency, the parent inherits the overridden currency code in Analytic Services (which is not displayed on a Web data form).
In certain cases, parent entities display #MISSING when trying to convert to a selected currency. Make sure that a currency rate is entered for each combination of local currencies and selected currencies on a data form or report. Also ensure that currency combinations exist for all mixed-currency children entities and their parent member.
Input of multiple currencies to a single entity is not supported in Smart View. As such, if there are mixed currency types on a worksheet, the user could inadvertently enter values in the wrong currency.
About the Calculate Currencies Business Rule
The Calculate Currencies business rule is based on the dimensions and members on the data form. This business rule converts data from the local currency to the reporting currency specified on the data form, applying the exchange rate conversions.
Keep the following points in mind when working with the Calculate Currencies business rule:
●
●
●
●
It does not calculate subtotals. To subtotal values, run the Calculate Data Form business rule
(or a customized business rule that includes aggregation) after converting currencies.
It ignores #missing values.
It can be turned on or off by associating or disassociating it with a data form (a data form design option).
It is by default set to not run when saving data.
For information on converting currencies for the application as a whole, see step 4 on page 67
.
110
Setting Up the Calendar and Currencies
Exchange Rate Types
There are three types of exchange rates associated with a currency:
●
●
●
Historical
Average
Ending
The exchange rate type used for each account is specified in the Member Property dialog box 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 period. For the Beginning Balance period, you can enter a single rate value that is always used for that time period for average and ending rate types.
Planning supports currency conversion by triangulation through an interim currency, called
the triangulation currency. See “Triangulation” on page 119 .
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 data form with the Local member selected for the Currency dimension.
When you select Yen as the currency member for the data 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 form. This applies to non-currency as well as currency data types. However, users can override these settings on an individual basis in data forms. You can determine the initial display of these items:
●
The thousands separator:
❍
None—Display numbers with no thousands separator.
Example: 1000
❍
❍
❍
Comma—Display numbers with a comma separating thousands values.
Example: 1,000
Dot—Display numbers with a dot separating thousands values.
Example: 1.000
Space—Display numbers with a space separating thousands values.
Example: 1 000
Setting Up Currencies
111
●
●
●
The decimal separator:
❍
Dot—Display the decimal separator as a dot.
Example: 1000.00
❍
Comma—Display the decimal separator as a comma.
Example: 1000,00
The display of negative numbers:
❍
Prefixed minus—Display a minus sign in front of negative numbers.
❍
Example: -1000
Suffixed minus—Display a minus sign behind negative numbers.
Example: 1000-
Parentheses—Display parentheses around negative numbers.
❍
Example: (1000)
The color of negative numbers:
❍
❍
Black—Display negative numbers in black.
Red—Display negative numbers in red.
Reporting Currencies
A reporting currency is the currency in which your company prepares its financial statements.
Planning supports currency conversion from local currencies to one or more reporting currencies. The converted reporting currency values are stored and are read-only for all users.
An application’s default currency is also the default reporting currency. You can disable a currency as a reporting currency.
Seeing How a Currency is Used
You can view information about 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.
Is used by an entity.
Has a conversion or exchange relationship set up with other currencies.
➤
To see how a currency is used:
1 Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select Currencies.
112
Setting Up the Calendar and Currencies
3
From the list of currencies, select the currency for which you want information.
4
Click Show Usage.
Creating Currencies
You can create currencies in an application as needed. You can select from a predefined list or create your own. You can specify the following properties when you create 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 alias table to use to display aliases for this currency
The number formatting, including thousands separator, decimal separator, negative sign, and negative color
Whether or not it is a reporting currency
➤
To create a new currency:
1 Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select Currency.
3 Click Add.
4
Take one of the following actions:
●
●
To add a predefined currency to the application, select Select Standard Currencies.
To add a currency to the application, select Create 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.
Optional: In the Description text box, enter a descriptive name for the new currency.
For example, Japanese yen.
❍
❍
Either enter a symbol in the Symbol text box or select a predefined symbol from the
Symbol drop-down list.
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).
For example, 3 yen represents 3000 Japanese yen if scaling is set to thousands.
Setting Up Currencies
113
❍
❍
❍
❍
Optional: From the Triangulation Currency drop-down list, select a currency for converting the new currency to a different currency through a common third currency, which is the triangulation currency.
Optional: From the Alias Table drop-down list, select the alias table to be used for this currency. The default table is used if you do not make a specific choice.
Optional: In the Alias text box, enter a descriptive name for the alias you want to assign to this currency.
Optional: From the Thousands Separator drop-down list, select an option to display numbers with thousands values:
❑
Use Default Setting to use the application’s default setting.
❑
❑
None to display members with no thousands separator, for example, 1000.
Comma to display numbers with a comma separating thousands values, for example, 1,000.
❑
❑
Dot to display numbers with a dot separating thousands values, for example,
1.000.
Space to display numbers with a space separating thousands values, for example, 1
000.
Note:
The thousands separator and decimal separator must be different.
❍
Optional: From the Decimal Separator drop-down list, select an option to display numbers with decimal values:
❑
❑
Dot to display the decimal separator as a dot, for example, 1000.00.
Comma to display the decimal separator as a 1000,00.
Note:
The decimal separator and thousands separator must be different.
❍
❍
❍
Optional: From the Negative Sign drop-down list, select one of the following options to display numbers with negative values:
❑
❑
Prefixed minus to display a minus sign in front of negative numbers, for example,
-1000.
Suffixed minus to display a minus sign behind negative numbers, for example,
1000-.
❑
Parentheses to display parentheses around negative number, for example, (1000).
Optional: From the Negative Color drop-down list, select a color option to display numbers with negative values:
❑
Black to display negative numbers in black.
Red to display negative numbers in red.
❑
Optional: Select the Reporting Currency option to designate the currency as a reporting currency.
114
Setting Up the Calendar and Currencies
5
Click Save.
Editing Currencies
To change the properties of a currency, follow the steps in this topic.
➤
To modify a currency:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select Currency.
3
Select the currency you want to edit.
4
Click Edit.
5
Modify the properties as necessary:
●
●
●
●
●
To change the currency’s symbol, either enter the new symbol in the Symbol text box or select a symbol from the Symbol drop-down list.
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 thousands, and so on). For example, 3 yen represents 3000 Japanese yen if scaling is set to thousands.
From the Triangulation Currency drop-down list, select a currency for converting the currency to a different currency through a common, third currency, which is the triangulation currency.
From the Thousands Separator drop-down list, select an option to display numbers with thousands values:
❑
❑
❑
❑
❑
Use Default Setting to use the application’s default setting.
None to display members with no thousands separator, for example, 1000.
Comma to display numbers with a comma separating thousands values, for example, 1,000.
Dot to display numbers with a dot separating thousands values, for example,
1.000.
Space to display numbers with a space separating thousands values, for example,
1 000.
Note:
The thousands separator and decimal separator must be different.
Setting Up Currencies
115
●
From the Decimal Separator drop-down list, select an option to display numbers with decimal values:
❍
❍
Dot to display the decimal separator as a dot, for example, 1000.00.
Comma to display the decimal separator as a 1000,00.
Note:
The decimal separator and thousands separator must be different.
●
●
●
●
●
From the Negative Sign drop-down list, select an option to display numbers with negative values:
❍
❍
Prefixed minus to display a minus sign in front of negative numbers, for example,
- 1000.
Suffixed minus to display a minus sign behind negative numbers, for example, 1000-.
❍
Parentheses to display parentheses around negative numbers, for example, (1000).
From the Negative Color drop-down list, select a color option to display numbers with negative values:
❍
❍
Black to display negative numbers in black.
Red to display negative numbers in red.
From the Alias Table drop-down list, select an alias table to be used, and modify the alias for the currency, if necessary.
Select or deselect the Reporting Currency option.f
The Marked for Delete check box enables you to see which dimension members are out of sync between the Planning application and Shared Services before they are actually deleted.
For more information on this property, see “Unmarking Members That are Pending
.
Note:
You cannot modify the Code property.
6
Repeat steps 3 through 5 for each currency that you want to modify.
7
Click Save.
Deleting Currencies
You may select one or more currencies to delete. However, you may not delete the default currency.
➤
To delete a currency:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
116
Setting Up the Calendar and Currencies
2
From the Dimension drop-down list, select Currencies.
3
From the Currency area, select the currency you want to delete.
4
Click Show 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. For more
Where Members Are Used in the Application” on page 131 .
5
Click Close to close the Member Usage window.
6
Click OK.
7
Click Delete.
8
When prompted to confirm the deletion, click OK.
Note:
After deleting a currency, you need to update and validate business rules, reports, and Hyperion Application Link adapter processes.
Setting Up Exchange Rates
You use exchange rates to convert values from one currency to another. This enables 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 form that has values on it for the Japan entity and the data 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 the option for using 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.
The following topics explain how to set up exchange rates:
●
●
●
●
“About Exchange Rate Tables” on page 118
“Hsp_Rates Dimension” on page 118
“Calculation Method” on page 119
Setting Up Exchange Rates
117
●
●
●
“Setting Up Exchange Rate Tables” on page 119
“Modifying Exchange Rate Tables” on page 121
“Deleting Exchange Rate Tables” on page 122
About Exchange Rate Tables
Each application has a default currency, which you specify when creating the application.
When you set 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.
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, 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 Exchange Rates task on the Planning Desktop. 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 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 66 and
“Refreshing Application Databases” on page 69 .
Hsp_Rates Dimension
Applications that support multiple currencies include an additional dimension called
Hsp_Rates. This dimension is used to store exchange rates. It includes these two members
(besides others, which store rates for existing currencies):
●
●
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
.
118
Setting Up the Calendar and Currencies
Triangulation
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/Japanese yen exchange rate, you can calculate the US dollar/Japanese yen exchange rate by using the Euro as the triangulation currency. 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.
You can also 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.
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.
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 options on the Exchange Rate Table window:
Table 27
Exchange Rate Table Window Options
Currency
From
Method
Historical
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.
Select the currency to enter rates from which to convert (source currency).
The mathematical operator (either multiply or divide) that determines how values are calculated between the source and destination currencies.
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 time prior to the application’s calendar, or a rate that was in effect when an event occurred.
Setting Up Exchange Rates
119
Table 27
Exchange Rate Table Window Options (Continued)
BegBalance
Average
Ending
Show Columns for
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.
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.
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.
Lets you control which columns display in the grid by clicking the check boxes for Average
Rates, End Rates, Method, Historical, and BegBalance.
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 Table Click to select another Exchange Rate table to edit.
➤
To set up an exchange rate table:
1
From the navigation frame on the Desktop, double-click Hyperion Planning > Hyperion Planning >
Exchange Rates.
2
Do one of the following:
●
●
In the Exchange Rate Tables area on the right, click New Rate Table.
From the menu, select Task > New Rate Table.
3
In the Name text box, enter the name of the new exchange rate table.
The name may be up to 32 characters.
4
In the Description text box, enter a description for the new exchange rate table.
The description may be up to 128 characters.
5
Click OK.
6
Highlight the exchange rate you created, and then 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 that you want to set up when
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.
120
Setting Up the Calendar and Currencies
11
Enter values into the cells for the desired time periods:
●
●
●
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 data form.
13
Optional: Click Years to set which years the grid displays.
●
●
Select the years that you want to display.
Click OK.
Note:
To undo your changes since you last saved the exchange rate table, click Restore.
14
Click Save.
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 Desktop, double-click Hyperion Planning > Hyperion Planning > 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.
Note:
To undo your changes since you last saved the exchange rate table, click Restore.
6
Click Save.
Note:
Launch the currency conversion calc script to recalculate values.
Setting Up Exchange Rates
121
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 Desktop, double-click Hyperion Planning > Hyperion Planning > Exchange
Rates.
2
From the Exchange Rate Tables list, select the table you want to delete.
3
Do one of the following:
●
●
Right-click and select Delete Rate Table.
Select Task > Delete Rate Table.
4
When prompted to confirm the deletion, click Yes.
122
Setting Up the Calendar and Currencies
Setting Up Custom Dimensions
C h a p t e r
7
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.
In This Chapter
Setting Up Custom Dimensions
123
Working with Dimensions
Dimensions represent the core components of a 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
Planning: Account, Entity, Scenario, Version, Period, Year, and Currency. In addition, you can create up to 13 user-defined custom dimensions that are specific to your organization.
See the following topics for more information on dimensions:
●
●
●
●
“About Dimensions and Members” on page 124
“About Sparse and Dense Dimensions” on page 124
“About Dimension Hierarchies” on page 125
“Working with a Dimension Hierarchy” on page 126
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
Most multidimensional 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.
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 Account dimensions. The Product dimension represents the product units, the Market dimension represents the geographical regions in which the products are sold, and the Account dimension represents the Account 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 Account 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 Account 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, 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, Planning designates the Account and Period dimensions as dense and
124
Setting Up Custom Dimensions
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
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 Period 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 Period dimension, you roll up monthly 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 Period 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 Period is 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.
Working with Dimensions
125
Working with a Dimension Hierarchy
The Dimensions tab enables you to set and change aspects of Account, Entity, Scenario,
Version, Currency, Period, Year, and user-defined custom dimensions. The following table summarizes the various tasks you can perform in the Dimensions tab, with links to the topics that discuss them in more detail.
Task
Select a dimension with which to work.
Topic
Select the dimension from the Dimension drop-down list. For more
information on dimensions, see “Working with Dimensions” on page 124
.
Set up or change dimension properties such as description, alias, or data storage type.
Add a dimension.
Click Edit. See “Setting Dimension Properties” on page 145
.
Move a dimension member.
Click Add Dimension. See
“Adding or Editing User-Defined Custom
See “Finding Dimensions or Members” on page 128 .
Search for a dimension member.
Expand or collapse the dimension hierarchy.
Click Expand or Collapse. See
Dimension Hierarchy” on page 127 .
Add or edit a dimension member.
Click Add Child or Add Sibling. See “Adding or Editing Members” on page 146 .
See
“Moving Members Within the Dimension Hierarchy” on page 129
.
Delete a dimension member.
See
“Deleting Members” on page 152 . To flag a member for
possible deletion using Shared Services, see
That are Pending Deletion” on page 135 .
See
Assign access to a dimension member.
View a member’s ancestors.
Navigate to another part of the dimension hierarchy.
Click Show Ancestors. See “Viewing a Member’s Ancestors” on page 131
.
See
“Navigating the Dimension Hierarchy” on page 127 .
This section contains the following topics:
●
●
●
●
●
●
●
●
“Expanding and Collapsing a Dimension Hierarchy” on page 127
“Navigating the Dimension Hierarchy” on page 127
“Finding Dimensions or Members” on page 128
“Moving Members Within the Dimension Hierarchy” on page 129
“Minimizing and Restoring Columns” on page 130
“Viewing a Member’s Ancestors” on page 131
“Determining Where Members Are Used in the Application” on page 131
126
Setting Up Custom Dimensions
Expanding and Collapsing a Dimension Hierarchy
You can expand a dimension and all its members, or you can expand a particular member within a dimension. Alternately, you can collapse a dimension and all its members.
➤
To expand a dimension or member:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select the dimension you want to expand.
3
Select the dimension or member you want to expand.
4
Do one of the following:
●
●
●
●
Click Expand.
Press the Right Arrow.
Click .
Click the closed folder.
➤
To collapse a dimension or member:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select the dimension you want to expand.
3
Select the dimension or member you want to collapse.
4
Do one of the following:
●
●
●
●
Click Collapse.
Press the Left Arrow.
Click .
Click the open folders.
Navigating the Dimension Hierarchy
You can navigate a long dimension hierarchy in many ways:
●
●
Press the Up Arrow to move to the previous member in the dimension hierarchy. If you are currently at the top of the member list and there is a previous page, you move to the last member of the previous page.
Press the Down Arrow to move to the next member in the dimension hierarchy. If you are currently at the bottom of the member list and there is a next page, you move to the first member of the next page.
Working with Dimensions
127
●
●
●
●
●
In the Page text box at the bottom of the list, enter the page of the dimension hierarchy you want to view and click Go or press Enter.
Click Start to view the first page of the dimension hierarchy.
Click Prev to view the previous page.
Click Next to view the next page.
Click End to view the last page of the dimension hierarchy.
Tip:
By default, 14 members are displayed per page. You can set a smaller or larger number of members per page by selecting File > Preferences > Display Options tab, then specifying a desired value for Show __ Members on Each Dimensions Page.
Finding Dimensions or Members
➤
To quickly select another dimension on the Dimensions tab, at the Dimension drop-down list, type the first letters of the dimension’s name.
To quickly navigate to a specific member, you can search for members in the dimension hierarchy. The dimension hierarchy can be either expanded or collapsed for a successful search.
➤
To find a dimension member in the dimension hierarchy:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select the dimension whose member you want to find.
3
From the Search drop-down list, select an option to search for a name, alias or both.
4
In the Search text box, enter the name or alias of the member for which you want to search.
Note:
You can enter a partial string to find a match.
5
Click the Search Down icon, , or the Search Up icon, , to scroll through the search results.
Sorting Members
You can sort members in ascending or descending order, and by children or descendants.
Sorting members affects the Analytic Services outline itself.
➤
To sort members:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
128
Setting Up Custom Dimensions
2
From the Dimension drop-down list, select the dimension whose members you want to sort.
3
On the Dimensions tab, select the members whose children or descendants you want to sort.
4
From the Sort drop-down list, select whether you want to sort the Children or Descendants.
Sorting by children affects only the members in the level immediately below the selected member. Sorting by descendants affects all the descendants of the selected member.
5
Click to sort by ascending order or to sort by descending order.
6
When prompted to confirm your selection, click OK.
Note:
The next time you create or refresh the database, the Analytic Services outline is generated with members placed in the same order as displayed on the Dimensions tab.
Moving Members Within the Dimension Hierarchy
After you define members and their properties, you can change their order in the dimension hierarchy. You can move one member or a group of members in the same branch.
Note:
If you move Account members whose Valid For Plan Type settings differ from their new parent, the moved members’ Valid For Plan Type settings change to match the Valid For setting of their new parents. If you move members whose Source Plan Type settings differ from their new parent, the moved members’ Source Plan Type is reset to match the first valid plan type.
➤
To move one member’s or branch’s position among its siblings:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select the dimension whose members you want to move.
3
On the Dimensions tab, select the member or branch you want to move.
4
Do one of the following:
●
Click to move the member up one position.
●
Click to move the member down one position.
➤
To move members, including parents and their children, within the dimension hierarchy:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select the dimension whose members you want to move.
3
On the Dimensions tab, select the member or branch that you want to move.
Working with Dimensions
129
4
Click Cut or type Ctrl + X.
5
Place the cursor on the destination level under which you want to move the members.
6
Click Paste or type Ctrl + V.
7
When prompted to confirm the move, click OK.
Note:
After moving members within the dimension hierarchy, you must update and validate business rules, reports, and
Hyperion Application Link Adapter processes.
Note these points about the Cut function:
●
●
●
It remembers a cut member even if you expand, collapse, sort, search, or change pages in the dimension hierarchy. It also remembers a cut member if you add a child or sibling member, edit or delete a member, assign access to a member, or click the View link.
It does not remember a cut member if you add or edit a dimension, navigate to a page other than the Dimensions tab, delete the member, or log off Planning.
It is not available for root dimension members.
Minimizing and Restoring Columns
When working with columns on the Dimensions tab, you can conveniently minimize and restore individual columns to keep relevant information onscreen without scrolling horizontally or to hide information that's irrelevant to you. Look for tool tips on resizing columns by placing the cursor over the column headings.
➤
To minimize and restore columns:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select the column you want to minimize or restore.
3
Take one of the following actions:
●
●
●
To minimize a column, double-click its column heading, or right-click it and select
Minimize.
To return a column to its original width, double-click any minimized column heading, or right-click it and select Restore.
To restore all previously minimized columns to their original widths, right-click a column heading and select Restore All.
Note:
Because each dimension page displays different columns, Planning saves column widths for each dimension independently. Column widths are saved for the duration of the session whenever you add, edit, or delete a dimension member, or whenever you select another dimension using the Dimension drop-down list.
130
Setting Up Custom Dimensions
Viewing a Member’s Ancestors
If a dimension hierarchy is very long, you may want to easily view a member’s ancestors in the dimension hierarchy.
➤
To view a member’s ancestors:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
On the Dimensions tab, from the Dimension drop-down list, select the dimension whose member’s ancestors you want to view.
3
Select the member in the dimension hierarchy.
4
Click Show Ancestors.
5
When you are done viewing the information, click Close.
Determining Where Members Are Used in the Application
The Show Usage button enables you to view where a particular dimension member is used in the application (in which data forms, planning units, exchange rates, and so on). This information can be especially useful before you try to delete a member.
➤
To view where a member is used in the application:
1
Perform one of the following actions:
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
●
2
On the Dimensions tab, from the Dimension drop-down list, select the dimension whose member’s usage you want to view.
3 Click Show Usage.
4
From the drop-down list at the bottom of the Member Usage window, select where in the application you want to view the member's usage.
The drop-down list choices are appropriate for the dimension member selected. For example, if you selected a currency member, the drop-down list includes Data Forms, Exchange Rates,
Entity, and Triangulation Currencies.
5
Click Go.
6
When you are done viewing the information, click Close.
Working with Dimensions
131
About Custom Dimensions
●
●
●
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.
This section contains the following topics:
“Aggregation Options” on page 132
“Unmarking Members That are Pending Deletion” on page 135
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 represents the Sales member minus the COGS member.
Storage Options
To optimize performance and disk usage, you can select from several storage and calculation options for dimension members. The following table describes the available options:
Table 28
Storage Options
Option
Dynamic Calc and Store
Store
Impact
Calculates the data values of the member, then stores these values. See
Calc Versus Dynamic Calc and Store” on page 133 .
Stores the data values of the member. See
“About Store Data Storage” on page 134 .
132
Setting Up Custom Dimensions
Table 28
Storage Options (Continued)
Option
Dynamic Calc
Never Share
Shared
Label Only
Impact
Calculates the data values of the member, then disregards these values. See
“Dynamic Calc Versus Dynamic Calc and Store” on page 133
.
Prohibits two or more members in the same dimension from sharing data values.
See
“About Never Share Data Storage” on page 134
.
Allows two or more members in the same dimension to share data values. See
“About Shared Data Storage” on page 134
.
Has no data associated with the member. See
“About Label Only Data Storage” on page 134 .
About Dynamic Calc
With a dynamically calculated member, Planning calculates the data values of the member, then disregards these values.
●
●
The Analytic Services limit is 100 children under a dynamic calc parent.
Changing a member's storage option to Dynamic Calc may result in loss of data, depending on how that data was originally derived. You may need to update outlines, calculations, or both to get the dynamically calculated value.
Dynamic Calc Versus Dynamic Calc and Store
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.
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.
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.
About Custom Dimensions
133
About Store Data Storage
You should not set a parent member to Store if its children are set to Dynamic Calc. With this combination, when a user saves and refreshes a data form, the new total for the parent is not calculated.
About Shared Data Storage
You should use Shared when you want to allow for alternate rollup structures in the
application. For more information about shared members, see “Working with Shared
About Never Share Data Storage
The default data storage type when you add a user-defined custom dimension is Never Share.
You should also use Never Share for parent members that have only one child member that aggregates to that parent so that the appropriate security can be applied to the child member.
About Label Only Data Storage
Label-only members are virtual members; they are typically used for navigation and typically have no data associated with them.
They can help you to group members or to more easily navigate and report from Hyperion
System 9 BI+ Financial Reporting TM or Smart View.
Some points to know about the label-only data storage option:
●
●
●
●
●
●
You cannot assign level 0 members as label-only.
Even though a label-only member has no data associated with it, it can still display a value.
Making a dimension member label-only helps minimize database space by decreasing the block size.
You cannot assign attributes to label-only members.
In multi-currency applications, you cannot apply the label-only storage option to members of the following dimensions: Entity, Versions, Currencies, and user-defined custom dimensions. To store exchange rates, these members should remain Never Share.
The Data Storage option for children of label-only parents is set to Never Share by default.
Caution!
Do not design a data form in which a label-only parent follows its first child member, because you will not be able to save data in the first child member. Instead, set up the data form with the label-only parent selected before its children or omit selecting the label-only parent for the data form.
134
Setting Up Custom Dimensions
Unmarking Members That are Pending Deletion
When you import dimension members from Shared Services, any members that exist in
Planning but do not exist in Shared Services automatically get “marked for delete,” which indicates that they are pending deletion. This member property enables you to see which dimension members are out of sync between the Planning application and Shared Services before they are actually deleted. You have the opportunity to assess the implications of deleting members before they are physically deleted. Before you can import metadata from Shared
Services, you must resolve all members that are marked for delete. You resolve the inconsistency between Planning and Shared Services in one of two ways:
●
●
Deleting them from Planning
Unmarking them for deletion and then exporting them to Shared Services so they exist in
both places. (For more information on using Shared Services, see Chapter 10, “Managing
.)
Members that are marked for delete are preserved and their associated data remains intact until you specifically delete the members. You can also unmark members set for deletion by resetting the property value.
Some points to know about the marked for delete state:
●
The Dimensions tab indicates with icons which members are marked for deletion:
●
●
●
●
●
●
❍
indicates that the member is marked for deletion.
❍
indicates that the member is marked for deletion because its ancestor is specifically marked for deletion.
When a parent member is marked for delete, its descendants are also marked for deletion.
However, when a base member is marked for delete, any associated shared members are not marked for deletion.
Members that are marked for deletion (and their descendants) behave like other members.
For example, you can modify, move, sort, and search for members that are marked for delete, and you can select them when creating a data form or working with planning units.
When using Shared Services, you can see which members are marked for deletion, or out of sync between Planning and Shared Services. You must resolve these inconsistencies before you import metadata.
Deleting a member that is marked for deletion follows the same rules as deleting any other member. For example, deleting a parent also deletes its children and any associated shared members. For more information on deleting members, see
“Deleting Members” on page 152 .
Differences in dimension hierarchies between Planning and Shared Services do not matter when dimension members’ names are compared.
A dimension member that is renamed in Shared Services is considered a new member and not a duplicate of its previously named counterpart in Planning. Thus, when the model is imported from Shared Services to Planning, the renamed dimension member is imported and not marked for deletion.
About Custom Dimensions
135
●
●
Attribute members can be marked for deletion.
Year and Period dimension members are not marked for deletion. If you import Year or
Period dimension members from Shared Services, members that exist in Planning but not in Shared Services are not deleted during the import.
➤
To unmark for deletion an individual member:
1
Perform one of the following actions:
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
●
2 On the Dimensions tab, from the dimensions drop-down list, select the dimension with whose member you want to work.
3
Click Edit.
4 On the Member Properties tab, clear the Marked for Delete check box.
5
Click Save.
To unmark a large number of members, you use the Manage Members Marked for Delete page.
➤
To unmark for deletion a large number of members:
1
Select Administration > Dimensions.
2
From the Dimensions tab, click the Marked for Delete icon,
.
3
At the Manage Members Marked for Delete dialog box, from the dimensions drop-down list, select the dimension whose members you want to unmark for deletion.
4
Click Go.
5
Take any of the following actions:
●
●
●
●
●
To select members individually, select the check box by the member’s name and then click
Unmark.
To select all the marked members, select the check box next to the Select Members to
Unmark title and click Unmark.
To unmark all the listed members, click Unmark All.
To view the member in the dimension hierarchy on the Dimensions tab, click the member’s name.
To view the Custom Attribute page, click on the attribute member’s name.
6 Click OK to confirm the unmarking.
7
Click Cancel to close the Manage Members Marked for Delete page.
136
Setting Up Custom Dimensions
About 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
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 data form, you can also allow multiple currencies per entity. This allows for multiple currency data entry and reporting against a single entity. However, 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.
This chapter discusses the following topics:
●
●
“Entity Members and Plan Types” on page 137
Entity Members and Plan Types
When you define an entity member, you assign a plan type for which it is valid. If you do not assign a plan type to a member, that member’s children do not have access to that plan type. If you move a member, and the new parent of that member is valid for different plan types, then the member remains valid only for the plan types it has in common with the new parent.
Your organization may require that different entity members prepare different 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 forms are associated with plan types, this allows you to control which entity members can enter data for each plan type.
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 forms for the Revenue plan type,
Eastern US is not selectable for those data 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
.
About the Entity Dimension
137
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 U.S. Dollars is the default currency, you may specify Yen as the base currency for the Japan entity and U.S. Dollars for the
United States entity. When you display a data form that has values on it for the Japan entity and the data form’s display currency is set to U.S. Dollars, the values are converted to U.S. Dollars per the rates in the exchange rate table (this example assumes that Yen is the local currency and
U.S. Dollars is the reporting currency).
About 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.
This section discusses the following topics:
●
●
●
●
“Account Members and Plan Types” on page 138
“Saved Assumptions” on page 142
“Data Type and Exchange Rate Type” on page 143
Account Members and Plan Types
When you define an account member, you assign a plan type for which it is valid. If you do not assign a plan type to a member, that member’s children do not have access to that plan type. If you move a member, and the new parent of that member is valid for different plan types, then the member remains valid only for the plan types it has in common with 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.
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 data forms for the P&L plan type is the value that was entered for the Revenue plan type. If you move an account member and the new parent of that member has a different source plan type, the source plan type of the member is set to the first new valid plan type of that member. The valid plan types are determined by the ones the member has in common with its new parents.
138
Setting Up Custom Dimensions
You can also add accounts by performing a bulk load using Hyperion Application Link. For more information about bulk loading accounts, see
“Loading Members and Data” on page 177
.
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 Analytic Services member formulas (that is, whether the account is treated as an expense that gets subtracted from the budgeted amount or whether the account is treated as a non-expense where the budgeted amount is subtracted from the actual amount). With certain time balance properties, you can also set whether database calculations include or exclude missing or zero values.
See the following topics
●
●
●
●
●
“Examples of How Account Types are Used” on page 139 :
“Summary of Account Types” on page 140
“Time Balance Property” on page 140
“Account Types and Variance Reporting” on page 141
“Setting Account Calculations for Zeros and Missing Values” on page 141
Examples of How Account Types are Used
Account types are used for the following purposes.
Table 29
Using Account Types
Account Type
Expense
Revenue
Asset
Purpose
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.
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.
Represents a resource that belongs to your company. For example, when you plan accounts receivable, you may have separate account members for each customer.
Liability and Equity Both represent a residual interest or a single outside obligation to an outside creditor.
Saved assumption Represents the planning assumptions that you make. Examples include floor space, headcount, rates, prices, and so on. Saved assumptions enable you to centralize your planning assumptions to ensure consistency across the application.
About the Account Dimension
139
Summary of Account Types
The following table summarizes the account types:
Table 30
Summary of Account Types
Account Type
Revenue
Expense
Asset
Liability
Equity
Saved Assumption
Time Balance
Flow
Flow
Balance
Balance
Balance
User-defined
Variance Reporting
Non-Expense
Expense
Non-Expense
Non-Expense
Non-Expense
User-defined
The variance reporting and time balance settings are predefined for all account types except the
Saved Assumption type, which is user-defined.
Time Balance Property
An account’s time balance property specifies how Planning calculates the data value of summary time periods as described in the following table:
Table 31
Time Balance Properties
Time Balance Property
Flow
First
Balance
Average
Weighted Average -
Actual_Actual
Description
Uses an aggregate of all of the data values for a summary time period as a total for the period.
Uses the beginning data value in a summary time period as the total for the period.
Uses the ending data value in a summary time period as the total for the period.
Uses an average for all the child values in a summary time period as a total for the time period.
Uses a weighted daily average, based on the actual number of days in a year. This accounts for leap year, in which February has 29 days.
In the example, the average for Q1 is calculated as follows: (1) Multiply the value for each month in Q1 by the number of days in the month, (2) Sum these values, and (3) Divide the total by the number of days in Q1.
Assuming it is a leap year, the result is calculated as follows:
(10 * 31 + 15 * 29 + 20 * 31) / 91 = 15
Example
Jan: 10
Feb: 15
Mar: 20
Q1: 45
Jan: 10
Feb: 15
Mar: 20
Q1: 10
Jan: 10
Feb: 15
Mar: 20
Q1: 20
Jan: 10
Feb: 15
Mar: 20
Q1: 15
Jan: 10
Feb: 15
Mar: 20
Q1: 15
140
Setting Up Custom Dimensions
Table 31
Time Balance Properties (Continued)
Time Balance Property
Weighted Average -
Actual_365
Description
Uses a weighted daily average, based on 365 days in a year, assuming that
February has 28 days. This does not account for leap years.
In the example, the average for Q1 is calculated as follows: (1) Multiply the value for each month in Q1 by the number of days in the month, (2) Sum these values, and (3) Divide the total by the number of days in Q1.
Assuming it is not a leap year, the result is calculated as follows:
(10 * 31 + 15 * 28 + 20 * 31) / 90 = 15
Example
Jan: 10
Feb: 15
Mar: 20
Q1: 15
Note:
You can use the Weighted Average - Actual_Actual and Weighted Average - Actual_365 time balance properties only with a standard monthly calendar that rolls up to four quarters.
For information on how Planning calculates and spreads data with the different Time Balance settings, see the Hyperion System 9 Planning User’s Guide.
Account Types and Variance Reporting
An account’s variance reporting property determines whether the account is treated as an expense when used in Analytic Services 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 determine the variance.
Setting Account Calculations for Zeros and Missing Values
If you set the time balance property to First, Balance, or Average, you can specify how database calculations treat zeros and missing values with the Skip options. The following table illustrates how Q1 is calculated when the time balance property is set to First when each of the Skip options selected.
Table 32
Effect of Skip Options When Time Balance is Set to First
Skip Option
None
Missing
Description
Indicates that zeros and #missing values are considered when the parent value is calculated. This is the default. In the example, the value of the first child (Jan) is 0, and zeros are considered when the parent value is calculated, so the value for Q1 is 0.
Excludes #missing values when calculating parent values. In the example, the value of the first child (Jan) is #missing, and #missing values are not considered when the parent value is calculated, so the value for Q1 is the value of the second child (Feb), or 20.
Example
Jan: 0
Feb: 20
Mar: 25
Q1: 0
Jan: #missing
Feb: 20
Mar: 25
Q1: 20
About the Account Dimension
141
Table 32
Effect of Skip Options When Time Balance is Set to First (Continued)
Skip Option
Zeros
Description
Excludes zero values when calculating parent values. In the example, the value of the first child (Jan) is 0, and zero values are not considered when the parent value is calculated. Therefore, the value for Q1 is the value of the second child (Feb), or 20.
Missing and Zeros Excludes #missing and zero values when calculating parent values. In the example, the value of the first child (Jan) is zero, and the value of the second child (Feb) is missing. Because missing and zero values are not considered when the parent value is calculated, the value for Q1 is the value of the third child (Mar), or 25.
Example
Jan: 0
Feb: 20
Mar: 25
Q1: 20
Jan: 0
Feb: #missing
Mar: 25
Q1: 25
Saved Assumptions
Saved assumptions enable you to 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, Planning calculates the variance by subtracting the actual amount from the budgeted amount. When you define a saved assumption as a non-expense, 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, Planning subtracts the actual amount from the budgeted amount.
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.
142
Setting Up Custom Dimensions
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.
About 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 for each project. 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 after you have created them.
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 userdefined custom dimension are valid for the plan types assigned at the dimension level.
You can also add user-defined custom dimensions by performing a bulk load using Hyperion
Application Link. For more information about loading dimensions, see “Importing Custom
Dimension Members” on page 178
.
About User-Defined Custom Dimensions
143
Adding or Editing User-Defined Custom Dimensions
The Add Dimension page lets you create or change user-defined custom dimensions.
➤
To add or change a user-defined dimension:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
On the Dimensions tab, click Add Dimension.
3
Set or change the following property options:
Table 33
Properties for User-Defined Custom Dimensions
Property
Dimension
Alias
Description
Valid for Plan Types
Apply Security
Data Storage
Value
Enter or change the name of the dimension. The name can contain up to 80 characters and must be unique across all dimensions.
The dimension name cannot contain the tab, double quote “, or backslash \ characters.
The name cannot start with any of the following characters:
‘ \ < | , = @ _ + - { } ( ) .
Optional: From the Alias drop-down list, select an alias table. 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 must follow the naming conventions for dimension names, described above.
Optional: Enter a description of up to 255 characters.
Select the plan types for which the dimension is valid.
Note: When changing the properties of a user-defined dimension, deselecting this option for the dimension makes all the members of that dimension invalid for the plan type that was deselected.
Select the Apply Security check box to allow security to be set on custom dimension members. If you do not select this check box, there is no security on the dimension; that is, all users can access its members without restriction. You must select this check box before you can assign access rights to the dimension members.
Select a data storage option. The default is Never Share. See
.
4
Click Save.
Custom Attributes is not enabled until you save the dimension.
5
When asked to confirm that you want to add a new dimension, click OK.
Note:
Click Refresh to revert to the previous values on the page and keep the page open. Click Cancel to revert to the previous values on the page and close the page.
144
Setting Up Custom Dimensions
Setting Dimension Properties
On the Dimensions Property tab, you set properties for dimensions.
➤
To set properties for a dimension:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select the dimension you want to set up or change.
3
Click Edit.
4
On the Dimension Properties dialog box, set the following property options:
Table 34
Dimension Properties
Property
Dimension
Alias
Description
Valid for Plan Types
Apply Security
Data Storage
Enable custom attribute display
Value
Enter or change the name of the dimension. The name can contain up to 80 characters and must be unique across all dimensions.
The dimension name cannot contain the tab, double quote “, or backslash \ characters.
The member name cannot start with any of the following characters:
‘ \ < | , = @ _ + - { } ( ) .
Optional: From the Alias drop-down list, select an alias table. 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 must follow the naming conventions for dimension names, described above.
Optional: Enter a description of up to 255 characters.
Select the plan types for which the dimension is valid. This option is not available for
Entity or Account dimensions.
Select the Apply Security check box to allow security to be set on custom dimension members. If you do not select this check box, there is no security on the dimension; that is, all users can access its members without restriction. You must select this check box before you can assign access rights to the dimension members.
Select data storage options. See “Storage Options” on page 132 .
Select to display the available and selected attributes for dimensions with associated attributes. Selecting this option enables custom attribute display for all dimensions with attributes. Likewise, clearing it disables the display for all dimensions with attributes.
5
Click Save to save the new information to the relational database and see the changes reflected in the dimension hierarchy.
Note:
Click Refresh to revert to the previous values on the page and keep the page open. Click Cancel to revert to the previous values on the page and close the page.
Setting Dimension Properties
145
Working with Members
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 members.
Members of the Entity, Account, and user-defined custom dimensions can be shared.
This section contains the following topics:
●
●
●
●
“Adding or Editing Members” on page 146
“Assigning Access to Members” on page 149
“Deleting Members” on page 152
“Deleting a Parent Member and Its Descendants” on page 153
Adding or Editing Members
On the Member Property tab, you set up and change the characteristics of dimension members.
➤
To add or edit a member:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select the dimension whose member you want to add or edit.
3
From the dimension hierarchy:
●
●
●
To add a child member, select the parent level of the dimension hierarchy to which you want to add a member and click Add Child. A child member displays one level below the selected member in the hierarchy.
To add a sibling, select the level of the dimension hierarchy to which you want to add a sibling and click Add Sibling. A sibling member displays at the same level in the hierarchy as the selected member.
To edit an existing member, select that member from the dimension hierarchy and press
Enter or click Edit.
4
On the Member Properties tab, set or change the properties for the selected member:
Table 35
Member Properties
Property
Name
Description
Value
Enter or change the member name. The name can contain up to 80 characters and must be unique across all dimensions.
The member name cannot contain the Tab, double quote “, or backslash \ characters.
The member name cannot start with any of the following characters:
‘ \ < | , = @ _ + - { } ( ) .
Optional: Enter a description of up to 255 characters.
146
Setting Up Custom Dimensions
Table 35
Member Properties (Continued)
Property
Alias
Value
Optional: From the Alias Table drop-down list, select the alias table to store the alias name.
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.
For Account members only:
Account Type
From the Account Type drop-down list, select the account type. See “Account Types” on page 139 .
For Account members only:
Variance Reporting
If the account type is Saved Assumptions, from the Variance Reporting drop-down list, 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.
For Account members only:
Time Balance
From the Time Balance drop-down list, 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.
For Account members only:
Exchange Rate Type
From the Exchange Rate Type, select one of the options. See “Data Type and Exchange
.
For Account members only:
Data Type
From the Data Type drop-down list, select a data type. See “Data Type and Exchange
.
Distribution
Data Storage
Sets the weekly distribution (for example, 4-4-5, 5-5-4). Leaf Account members have the Distribution option if the corresponding option was selected when creating the application and if the base Time Period option is 12 months.
See
“Defining the Base Time Period and Monthly Distribution Spread” on page 56
.
From the Data Storage drop-down list, select a data storage property used in building a Analytic Services cube. The default Data Storage setting for new custom dimension
members (except root members) is Never Share. See “Storage Options” on page 132 .
Two Pass Calculation
For Entity members only:
Base Currency
Selecting this option causes 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 and entity members with the Dynamic Calc or
Dynamic Calc and Store properties.
Select the base currency for the entity member. See
.
Working with Members
147
Table 35
Member Properties (Continued)
Property
Plan Type
Value
Select one or more plan types for which the member is valid. For more information about plan types, see
“Account Members and Plan Types” on page 138
Members and Plan Types” on page 137 .
From the drop-down list, select an aggregation option for each selected plan type. See
“Aggregation Options” on page 132
.
Note: You can select a source plan only if more than one plan type is valid for the member.
Only the plan types and aggregation options for which the member’s parent is valid are available. If the parent is not valid for a particular plan type or aggregation option, then neither is the child member. Deselecting a plan type for either an account or entity parent member also deselects that property for all the descendents of that parent.
CAUTION! Deselecting a plan type for any dimension member after data is entered into the application may result in loss of data when the application is refreshed. For an account member, data is lost if the deselected plan type is the source plan type.
Marked for Delete
For Entity members only:
Base Currency
Clear to unmark the member for deletion. For more information on this option, see
“Unmarking Members That are Pending Deletion” on page 135 .
From the Base Currency drop-down list, select the base currency for the entity member.
For Account members only:
Source Plan Type
Select the source plan type for the member. See “Account Members and Plan Types” on page 138 .
Note: Because a shared member is basically a pointer to the base member and is not stored in Analytic Services, the source plan type is disabled for shared members.
Note: The Source Plan Type of a shared account member displays as matching the source plan type of the base member, even though the Source Plan field is unavailable because it does not apply to shared members.
Smart Lists
Optional: Select a Smart List to associate with the member. See “Working with Smart
Tip:
If you do not see the new member on the current page, click Next. The number of members per page may have been exceeded with the new member.
5
Click Save to save the new information to the relational database and see the changes reflected in the dimension hierarchy.
6
Refresh the database from the Planning Desktop to make an edited member visible to planners entering data.
After creating a dimension member, you typically complete these tasks:
●
●
Assign access to it. For more information about assigning access rights to members, see
“Assigning Access to Members” on page 149
.
Set up any attributes for it. For more information about using attributes and attribute values, see
“Working with Attributes” on page 155
and “Working with Attribute Values” on page 159 .
148
Setting Up Custom Dimensions
Note:
After adding a member to a dimension, refresh the database. Then, to view the new member in a data form that selects the member by relationship (for example, Children), select another form on the Data Form Management page, then select the form with the new member.
Assigning Access to Members
The following topics provide information about access:
●
●
●
●
“About Access Rights” on page 149
Note:
Before you can assign access to members of user-defined custom dimensions, you must first allow security to be set on it by selecting the Apply Security check box on the dimension’s Property tab.
➤
To assign access to members:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select the dimension for whose members you want to assign access.
3
From the dimension hierarchy, select the member for which you want to assign access.
4
Click Assign Access.
The Assign Access page displays any existing access assignments.
5 Perform any of these actions:
Task
Add access
Change access
Remove access
Topic
See “Adding Access” on page 150
.
See “Editing Access” on page 151
.
See “Deleting Access” on page 151
.
About Access Rights
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 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.
Working with Members
149
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 explains the available inheritance options.
Table 36
Access Rights Inheritance Options
Inheritance Option
Member
Children
Children (inclusive)
Descendant
Descendant
Result
The access right is assigned only to the currently selected member.
The access right is assigned to all children members in the level below the currently selected member.
The access right is assigned to the currently selected member and all children members in the level below it.
The access right is assigned to all descendant members below the currently selected member.
The access right is assigned to the currently selected member and all descendant members below it.
Adding Access
The Add Access page lets you specify which users and groups can access the selected member.
➤
To assign access rights to a member:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select the dimension for whose member you want to add access.
3
Click Assign Access.
4
Click Add Access.
5
Optional: To get the latest set of users and groups from the User Management Console, click Refresh
Users and Groups.
6
From the Users and Groups list on the Add Access dialog box, select the users and groups you want to have access to the selected member.
7
For the selected member, select the type of access you want to assign to the users or groups.
●
●
●
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 From the Relation drop-down list, select a relationship.
For example, by selecting Children, you assign access to the children of the selected member.
See
“About Access Rights” on page 149 .
150
Setting Up Custom Dimensions
9
Click Add.
10
Click Close.
Editing Access
Tip:
You can quickly access the Edit Access page for a member by clicking View in the Security column on the Dimensions tab.
➤
To modify access rights for a member:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select the dimension for whose member you want to add access.
3
Click Assign Access.
4
Optional: To get the latest set of users and groups from the User Management Console, click Refresh
User/Group Lists.
5
Click Edit Access.
6
For the selected member on the Edit Access dialog box, select the type of access you want to assign to the displayed users or groups.
●
●
●
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.
For example, by selecting Children, you assign access to the children of the selected member.
See
“About Access Rights” on page 149 .
8
Click Set.
9
Click Close.
Deleting Access
➤
To remove access rights for a member:
1 Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select the dimension for whose member you want to remove access.
3 Click Assign Access.
Working with Members
151
4
On the Assign Access dialog box, from the Users and Groups list, select the users and groups for whom you want to remove access to the selected member.
5
Click Remove Access.
6
When you are prompted to confirm the deletion, click OK.
7
Click Close.
Deleting Members
Caution!
Each data value is identified by a set of dimension member values and a plan type. Deleting any of the dimension members or deselecting the plan type results in loss of data when the application is refreshed. Deleting an entity member also deletes all planning units (including data) that are associated with it.
Before you delete a member, you should understand where in the application it is currently used (in which data forms, planning units, exchange rates, and so on). The Show Usage button
.
You must delete the entity member throughout Planning before deleting it from the
Dimensions tab. For example, if the entity member you want to delete is used in a data form, you must delete it from the data form before deleting it from the Dimensions tab.
Tip:
When deleting a large subtree of entities, you can greatly improve the performance of the delete operation if the planning units for the subtree are excluded (by excluding the root member) for
➤
To delete a member:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select the dimension whose member you want to delete.
3
From the dimension hierarchy, select the entity member you want to delete.
4
Click Delete or press Delete.
Note:
Deleting a base member also deletes its shared members.
152
Setting Up Custom Dimensions
5
When you are prompted to confirm the deletion, click OK.
Note:
After deleting an entity member, you need to update and validate business rules, reports, and Hyperion
Application Link adapter process.
Deleting a Parent Member and Its Descendants
Caution!
Each data value is identified by a set of dimension member values and a plan type. Deleting any of the dimension members or deselecting the plan type results in loss of data when the application is refreshed.
➤
To delete a parent member and all its descendants from the dimension hierarchy:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select the dimension whose member and descendants you want to delete.
3
Select the member whose branch you want to delete.
4
Click Delete.
5
When you are prompted to confirm the deletion, click OK.
Working with Shared Members
The ability to create shared members allows for alternate rollup structures within a 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.
Shared members are available for Entity, Account, and user-defined custom dimensions. 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.
Working with Shared Members
153
Here are some other points to know:
●
●
●
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. (The base member, however, does not have to be a level zero.) Therefore, data can be entered to a shared member, and the value is stored with its base member.
Renaming a base member renames all shared members.
Shared members are displayed the same as base members in the dimension hierarchy for member selection in Business Rules and Smart View. For Business Rules, because there is no labeling distinction, selecting shared members for certain action components (for example,
Copy Data) may not be applicable.
For information on creating shared members, see
“Creating Shared Members” on page 154 .
Creating Shared Members
You create a shared member like you do any other member, described in
Members” on page 146 , with these differences:
●
●
●
The base member cannot be the parent of the shared member. You can create the shared member anywhere else in the dimension hierarchy.
You must give the shared member the same name as its base member. You can give it a different description, however.
You must select Shared as the Data Storage option for the shared 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 “About Assigning Access Rights” on page 84 .
The following example assigns access rights to shared members by assigning access to the parent of the shared member. The security filters with the effective access described in the table below is generated only if the database is refreshed or created with both the Security and
Shared Members check boxes selected in the Manage Database task on the Desktop.
154
Setting Up Custom Dimensions
Example
Entity
United States
CA (base)
NY
West
CA (shared)
NV
Sales Region 1
CA (shared)
Table 37
Example of Access with Shared Members
Case
Case 1
Case 2
Case 3
Access Assignment
CA (base) = None iDescendants (West) = Read iDescendants (United States) = None iDescendants (West) = Read iDescendants (Sales Region 1) = Write iDescendants (United States) = Write iDescendants (West) = None iDescendants (Sales Region 1) = Read
Effective Access for CA
Read
Write
Write
Working with Attributes
The Manage Attributes and Values page lets you create, change, and delete both attributes and attribute values, as described in the following topics:
●
●
●
●
“About Attributes” on page 156
“Creating Attributes” on page 157
“Renaming Attributes” on page 158
“Deleting Attributes” on page 158
➤
To set up and change attributes and attribute values:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select the dimension for which you want to define an attribute or attribute value.
Note:
Only sparse dimensions can contain attributes.
Working with Attributes
155
3
Select the top level in the dimension hierarchy.
4
Click Custom Attributes.
If the dimension you selected is not a sparse dimension, Custom Attributes is not available.
5 Select the options you need.
Task
Creating an attribute
Changing an attribute’s name
Deleting an attribute
Creating an attribute value
Assigning an attribute value to members
Changing an attribute value
Deleting an attribute value
Topic
See “Creating Attributes” on page 157
.
See “Renaming Attributes” on page 158
.
See “Deleting Attributes” on page 158
.
See “Creating Attribute Values” on page 159 .
See “Assigning Attribute Values to Members” on page 160 .
See “Modifying Attribute Values” on page 162
.
See “Deleting Attribute Values” on page 162 .
For more information on attributes, see these topics:
●
●
●
“About Attributes” on page 156
“Working with Attribute Values” on page 159
“Using Attributes and Attribute Values” on page 163
About 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 data 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 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.
Note:
You can assign attributes only to sparse dimensions. You cannot assign attributes to label-only members. If you need to add an attribute to a dense dimension, you must change that dimension to sparse for all plan types on the Preferences tab.
156
Setting Up Custom Dimensions
Because the Account dimension is usually defined as a dense dimension, you cannot assign attributes to it. If you must assign attributes to the Account dimension, change it to a sparse dimension for all plan types. Alternately, if you change a dimension from sparse to dense, all existing attributes and attribute values for that dimension are automatically deleted. For more
information on changing the sparsity/density option for a dimension, see “Optimizing
Application Performance” on page 76
.
Creating Attributes
Planning allows you to create attributes at the dimension level for sparse dimensions, which are typically Entity and user-defined custom dimensions. Once you create an attribute for a dimension, you can create the values for that attribute and assign those values to dimension members.
➤
To create an attribute:
1 Perform one action:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select the dimension for which you want to create an attribute.
3 Click Custom Attributes.
Only sparse dimensions can contain attributes. If the dimension you selected is not a sparse dimension, Custom Attributes is not available. To see which dimensions are sparse, click the
Performance Settings tab.
4
Above the Attributes column, click Create.
5
On the Create Attribute dialog box, in the Name text box, enter a unique name of up to 32 characters.
Note:
The attribute value name cannot contain the tab, double quote “, or backslash \ characters. The attribute value name cannot start with any of the following characters: ‘ \ < | , = @ _ + - { } ( ) .
Some points to know about the Plan Type Options:
●
●
●
The options are available only for Entity dimension attributes.
If you later modify the attribute you are creating, Plan Type Options are not displayed.
You cannot later change the Plan Type option you set when you create the attribute.
6
Press Enter if you have more attributes to enter; click Save when you are done entering new attributes.
7
At the Create Attribute dialog box, click Cancel.
See
“Working with Attributes” on page 155
.
Working with Attributes
157
Renaming Attributes
You can rename attributes that you have already created.
➤
To rename an attribute:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select the dimension for which you want to change an attribute.
Note:
Only sparse dimensions can contain attributes.
3 Click Custom Attributes.
Note:
If the dimension you selected is not a sparse dimension, Custom Attributes is not available.
4
From the Attributes column, select the attribute you want to rename.
5
Above the Attributes column, click Modify.
6
On the Modify Attribute dialog box, in the Name text box, enter a unique new name of up to 32 characters.
Note:
The attribute value name cannot contain the Tab, double quote “, or backslash \ characters. The attribute value name cannot start with any of the following characters: ‘ \ < | , = @ _ + - { } ( ) .
7
Click Save.
After changing an attribute, you need to update and validate business rules, reports, and
Hyperion Application Link adapter processes. See “Working with Attributes” on page 155 .
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.
➤
To delete an attribute:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
158
Setting Up Custom Dimensions
2
From the Dimension drop-down list, select the dimension for which you want to delete an attribute.
Note:
Only sparse dimensions can contain attributes.
3
Click Custom Attributes.
If the dimension you selected is not a sparse dimension, Custom Attributes is not available.
4
Select the attribute you want to delete.
5
Above the Attributes column, click Delete.
6
When you are prompted to confirm the deletion, click OK.
After deleting an attribute, you need to update and validate business rules, reports, and
Hyperion Application Link adapter processes. See “Working with Attributes” on page 155 .
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, you must assign them to the same member level within a dimension.
Data values for attribute values are dynamically calculated but not stored.
This section contains the following topics:
●
●
●
●
“Creating Attribute Values” on page 159
“Assigning Attribute Values to Members” on page 160
“Modifying Attribute Values” on page 162
“Deleting Attribute Values” on page 162
See
“Working with Attributes” on page 155
.
Creating Attribute Values
You can define attribute values for sparse dimensions, which are typically the Entity and userdefined custom dimensions. After you define an attribute value for a dimension, you can assign it to the members of that dimension.
Working with Attribute Values
159
➤
To create attribute values:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select the dimension for which you want to create an attribute value.
Note:
Only sparse dimensions can contain attributes.
3
Select the top level in the dimension hierarchy.
4 Click Custom Attributes.
Note:
If the dimension you selected is not a sparse dimension, Custom Attributes is not available.
5
On the Manage Attributes and Values page, select the attribute for which you want to specify a value.
6
Above the Attribute Values column, click Create.
7
On the Create Attribute Value dialog box, in the Name text box, enter a unique name of up to 32 characters.
Note:
The attribute value name cannot contain the tab, double quote “, or backslash \ characters. The attribute value name cannot start with any of the following characters:
‘ \ < | , = @ _ + - { } ( ) .
8 Press Enter if you have more attribute values to enter; click Save when you are done entering new attribute values.
9
At the Create Attribute dialog box, click Cancel.
See
“Working with Attributes” on page 155
.
Assigning Attribute Values to Members
You can define attribute values for Entity, user-defined custom dimensions, and Account members if the Account dimension is designated as a sparse dimension in all plan types. After you have defined an attribute and an attribute value for a dimension, you can assign attribute values to the members of that dimension.
On the Attribute Values tab, you set and change how attribute values are assigned to dimension members.
Note:
Attribute values for a given attribute must be assigned to the same-level sparse dimension members. Assigning an attribute value to a different level causes an error during the application refresh.
160
Setting Up Custom Dimensions
➤
To assign an attribute value to a member:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select the dimension for whose member you want to assign an attribute value.
Note:
Only sparse dimensions can contain attributes. To see which dimensions are sparse, click the Performance
Settings tab.
3 In the Dimension hierarchy, select a member to which you want to assign an attribute value.
4
Click Edit.
Or, for members that are already assigned attribute values: on the Dimensions tab, the column titled Attributes displays View. Click View to change a member’s attribute value assignment.
Note:
If the selected dimension is not a sparse dimension, Custom Attributes is not available.
5
Select the Attribute Values tab.
6
From the Attribute Values list, select the attributes values you want to assign to the member.
You can select one attribute value from each group of attributes.
indicates that the attribute member is marked for deletion. See
“Unmarking Members That are Pending Deletion” on page 135 .
7
Do any of the following:
●
●
To assign the attribute value to the selected member: click the Add icon, .
To remove an attribute value from the selected member: from the Assigned Attribute
Values list, select the attribute value you want to remove and click the Remove icon, .
●
To remove all attribute values from the selected member: click the Remove All icon,
8
Click Save.
.
Note:
Click Refresh to revert to the previous values on the page and keep the page open. Click Cancel to revert to the previous values on the page and close the page.
See
“Working with Attributes” on page 155
.
Working with Attribute Values
161
Modifying Attribute Values
➤
To modify an attribute value:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select the dimension for which you want to modify an attribute value.
Note:
Only sparse dimensions can contain attributes.
3
Select the top level in the dimension hierarchy.
4 Click Custom Attributes.
Note:
If the dimension you selected is not a sparse dimension, Custom Attributes is not available.
5
From the Attributes list, select the attribute that contains the attribute value you want to modify.
6
From the Attribute Values list, select the attribute value you want to change.
7
Above the Attribute Values column, click Modify.
8
On the Modify Attribute Value dialog box, in the Name text box, enter a unique name of up to 32 characters.
Note:
The attribute value name cannot contain the tab, double quote “, or backslash \ characters. The attribute value name cannot start with any of the following characters:
‘ \ < | , = @ _ + - { } ( ) .
9 If the Marked for Delete property is selected, you can clear it to unmark the member for deletion. See
“Unmarking Members That are Pending Deletion” on page 135 .
10
Click Save.
See
“Working with Attributes” on page 155
.
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. Maybe you assigned the attribute value Small to the dimension members Sodas and
Juices. When you delete the attribute value Small, it is removed from the members Sodas and
Juices. However, because the values for Small are dynamically calculated, no data values are lost.
162
Setting Up Custom Dimensions
➤
To delete an attribute value:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select the dimension that contains an attribute for which you want to delete an attribute value.
Note:
Only sparse dimensions can contain attributes.
3
Select the top level in the dimension hierarchy.
4 Click Custom Attributes.
Note:
If the dimension you selected is not a sparse dimension, Custom Attributes is not available.
5
From the Attributes list, select the attribute that contains the attribute values you want to delete.
6
From the Attribute Values list, select the attribute values you want to delete.
To select all the attribute values for deletion, select the check box by the Attribute Values title.
7 Above the Attribute Values column, click Delete.
8
To confirm deletion, click OK.
After deleting an attribute value, you need to update and validate business rules, reports, and
Hyperion Application Link adapter processes. See “Working with Attributes” on page 155 .
Using Attributes and Attribute Values
After you assign attributes to custom dimensions and attribute values to dimension members, it is important to understand how they are used within Planning, and with other Hyperion products.
See
“Working with Attributes” on page 155
.
Using Attributes and Attribute Values in Data Forms
Attribute values provide users with another way of selecting dimension members when they are using Web-based data 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.
Using Attributes and Attribute Values
163
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 the option 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.
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, this supports loading attribute values to existing attributes only. Therefore, you must create attributes before you load attribute values.
164
Setting Up Custom Dimensions
C h a p t e r
8
Setting Up Scenarios and
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 allows for many iterations of a plan.
You use the Scenario 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. Planning tracks the status of each planning unit as it moves through the review process.
In This Chapter
Setting Up Scenarios and Versions
165
Setting Up Scenarios
Planning allows you to create scenarios to group data that an application uses. This section describes how to set up and maintain scenarios within a Planning application. The following table lists the tasks you can perform and links to the procedures for each task.
Task
Learn more about scenarios.
Create a scenario.
Edit a scenario.
Delete a scenario.
Topic
See “About Scenarios” on page 166 .
See “Creating a Scenario” on page 167
.
“Editing a Scenario” on page 168 .
“Deleting a Scenario” on page 169
.
Copy a scenario.
Assign access to a scenario.
Work with the Scenario dimension hierarchy.
“Copying a Scenario” on page 169
.
“Assigning Access to Members” on page 149
.
“Working with a Dimension Hierarchy” on page 126 .
Delete supporting detail associated with a scenario.
See “Deleting Supporting Detail Associated With a Scenario” on page 319
.
About Scenarios
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.
Assign user access rights by scenario.
Report on certain scenarios.
Compare and analyze different 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 the properties described in the following topics:
●
●
●
“Exchange Rate Table” on page 167
166
Setting Up Scenarios and Versions
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 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.
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 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.
Creating a Scenario
➤
To create a scenario:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select Scenarios.
3
Click Add.
4
In the Scenario text box, enter a name of up to 80 characters for the new scenario.
5
Optional: In the Description text box, enter a description of up to 255 characters for the new scenario.
6
From the Start Yr., Start Period, End Yr., and End Period 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.
Setting Up Scenarios
167
8
Optional: From the Alias Table drop-down list, select an alias table to associate with the scenario and enter the alias description for the scenario.
9
Select the Include BegBal as Time Period option if you want to include the BegBalance time period in this scenario for currency conversion.
10
Select the Enabled for Process Management option if you want to include this scenario in process management.
If you select this check box, this scenario will display in the scenario drop-down list on the
Check Status and Manage Process page.
11
Click Save.
Editing a Scenario
➤
To modify a scenario:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select Scenario.
3
Select the scenario you want to edit.
4 Click Edit.
5
Optional: In the Scenario text box, enter a name of up to 80 characters for the scenario.
6
Optional: In the Description text box, enter a description of up to 255 characters for the scenario.
7 From the Start Yr., Start Period, End Yr., and End Period drop-down lists, select the time period you want to associate with the scenario.
8
Optional: From the Exchange Rate Table drop-down list, 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.
9
Optional: From the Alias Table drop-down list, select an alias table to associate with the scenario and enter the alias description for the scenario.
10
Select the Include BegBal as Time Period option if you want to include the BegBalance time period in this scenario for currency conversion.
11
Select the Enabled for Process Management option if you want to include this scenario in process management.
If you select this check box, this scenario will display in the scenario drop-down list on the
Check Status and Manage Process page.
12 Click Save.
168
Setting Up Scenarios and Versions
Deleting a Scenario
When you delete a scenario, all planning units that use the scenario (including data) are deleted. You cannot delete a scenario that is used in a planning unit that has been started. Also, you cannot delete a scenario that is assigned to an axis on a data form. You first need to remove the reference to the scenario from the data form and then assign a different scenario to an axis on the data form.
➤
To delete one or more scenarios:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select Scenarios.
3
Select the scenario(s) you want to delete. At least one scenario must remain in the application.
4
Click Delete.
5
When you are prompted to confirm the deletion, click OK.
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
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select Scenarios.
3
Select the scenario you want to copy.
4
Click Copy Scenario.
5
In the Copy to Scenario text box, enter a name of up to 80 characters for the new scenario.
6
Optional: In the Description text box, enter a description of up to 255 characters for the new scenario.
7
From the Start Yr., Start Period, End Yr., and End Period drop-down lists, select the time period you want to associate with the new scenario.
8
Optional: From the Exchange Rate Table drop-down list, select an exchange rate table to associate with the new scenario.
Setting Up Scenarios
169
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
Optional: From the Alias Table drop-down list, select an alias table to associate with the scenario and enter the alias description for the scenario.
10
Select the Include BegBal as Time Period option if you want to include the BegBalance time period in this scenario for currency conversion.
11
Select the Enabled for Process Management option if you want to include this scenario in process management.
If you select this check box, this scenario will display in the scenario drop-down list on the
Check Status and Manage Process page.
12
Click Save.
Setting Up Versions
Planning allows you to create versions to group data that an application uses. This section describes how to set up and maintain versions within a Planning application. The following table lists the tasks you can perform and links to the procedures for each task.
Task
Learn more about versions.
Create a version.
Edit a version.
Topic
See
“About Versions” on page 170 .
See
“Creating a Version” on page 172
.
See
“Editing a Version” on page 172 .
Delete a version.
Display a version.
See
“Deleting a Version” on page 173 .
See
“Displaying Versions” on page 174 .
Copy a version.
Assign access to a version.
See
See
“Copying Versions” on page 174 .
“Assigning Access to Members” on page 149 .
Work with the Version dimension hierarchy.
See
“Working with a Dimension Hierarchy” on page 126
.
About Versions
You use the Scenario 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. Planning tracks the status of each planning unit as it moves through the review process.
170
Setting Up Scenarios and 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 are 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
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 displayonly 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).
Setting Up Versions
171
Creating a Version
➤
To create a version:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select Version.
3
Click Add.
4
In the Version text box, enter the name of the version you are adding to the application.
5
From the 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.
6
Optional: In the Description text box, enter a description of up to 255 characters for the new version.
7
Optional: From the Alias Table drop-down list, select an alias table to associate with the version and enter the alias description for the version.
8
Select the Enabled for Process Management option if you want to include this version in process management. If you select this check box, this version displays in the version drop-down list on the Check
Status and Manage Process page.
Note:
This option is not available for Target versions.
9
Click Save.
Editing 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 it.
For example, you may want to give users read-only access to the version Final.
➤
To modify a version:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select Version.
3
Select the version you want to edit.
4 Click Edit.
172
Setting Up Scenarios and Versions
5
Optional: In the Version text box, modify the name of the version.
6
Optional: From the Type drop-down list, modify 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.
7
Optional: In the Description text box, enter a description of up to 255 characters for the edited version.
8
Optional: From the Alias Table drop-down list, select an alias table to associate with the version and enter the alias description for the version.
9
Select the Enabled for Process Management option if you want to include this version in process management.
If you select this check box, this version displays in the version drop-down list on the Check
Status and Manage Process page.
Note:
This option is not available for Target versions.
10
Click Save.
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 used in a planning unit that has been started. Also, you cannot delete a version that is currently assigned to an axis on a data form. You must first remove the reference to the version from the data form and then assign another version to an axis on the data form. At least one version must remain in the application.
➤
To delete one or more versions:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select Versions.
3
Select the version(s) you want to delete.
4 Click Delete.
5
When you are prompted to confirm the deletion, click OK.
Note:
If a planning unit has been started, you cannot delete a version that is associated with it.
Setting Up Versions
173
Note:
After deleting a version, you need to update and validate business rules, reports, and Hyperion Application Link adapter processes.
Displaying Versions
➤
To view different types of versions:
1
Perform one of the following actions:
●
●
Select Administration > Dimensions.
Select File > New > Dimension Member.
2
From the Dimension drop-down list, select Version.
By default, all existing versions display.
3
In the Display drop-down list, 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 use the Copy Version 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
Select File > Workflow > Copy Version.
2
In the Scenario drop-down list, select the scenario you want to copy.
3 In the Copy From drop-down list, select the version from which you want to copy data.
4
In the Copy To drop-down list, select the version into which you want to copy data.
5
Click Go.
Note:
The entities for the selected version display in the Available Entities list.
6
In the Available Entities list, select the entities to which you want to copy data.
174
Setting Up Scenarios and Versions
Note:
The Available Entities list displays only the entities to which you have write access.
7
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.
8
Repeat steps 6 and 7 until the Selected Entities list is complete.
9
Optional: To copy any comments or annotations that are associated with accounts, select the Copy
Account Annotations check box.
10
Optional: To copy any supporting detail that is associated with versions, select the Copy Supporting Detail 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.
11 Click Copy Data.
12
Click OK.
Sorting Version and Scenario Members
You can sort version and scenario members, in ascending or descending order. Sorting members affects the Analytic Services outline itself.
➤
To sort version and scenario members:
1
On the Dimensions tab, select the Scenario or Version dimension.
2
Take one of the following actions in the Sort box:
●
To sort by ascending order, click .
●
To sort by descending order, click .
3
When prompted to confirm your selection, click OK.
Note:
The next time you create or refresh the database, the Analytic Services outline is generated with members placed in the same order as displayed on the Dimensions tab.
Sorting Version and Scenario Members
175
Moving Scenario and Version Members Within the Dimension
Hierarchy
You can change the order of scenario and version members in the dimension hierarchy.
➤
To move a member's position in the dimension hierarchy:
1
On the Dimensions tab, select the scenario or version you want to move.
2
Take one of the following actions:
●
To move the member up one position, click .
●
To move the member down one position, click .
3
When prompted to confirm your selection, click OK.
Note:
The next time you create or refresh the database, the Analytic Services outline is generated with members placed in the same order as displayed on the Dimensions tab.
176
Setting Up Scenarios and Versions
Loading Members and Data
C h a p t e r
9
This section describes how to populate Planning applications with members and data from external systems.
In This Chapter
Loading Members and Data
177
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 Planning applications.
When you import members, any that do not currently exist in the 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 Planning application, they are imported into a relational database that stores the application definition. You must refresh the 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 Planning application.
Note:
You cannot use Hyperion Application Link to export data values from Planning.
Quick Steps for Importing Custom Dimension Members
This chapter covers how to import custom dimension members into a 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 Planning application.
3. Use Hyperion Application Link (which includes using the Planning Adapter and the flat file Adapter) to load the custom dimension data into a Planning application. The Planning
Log On page must be loaded before you can connect to the Planning server through
Hyperion Application Link.
4. Refresh Planning.
178
Loading Members and Data
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 Account, Entity, and custom dimensions from any flat file or ODBC-compliant database into Planning. You can also load the same data into
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 Planning. It includes a wizard, called Hyperion Translation Manager, that helps you map your source data into Planning equivalents.
This section contains the following topics:
●
●
●
●
●
●
“Using Flow Diagrams” on page 179
“Using the Hyperion Planning Adapter” on page 180
“Using the Hyperion Essbase Adapter” on page 182
“Using the Flat File Adapter” on page 184
“Connecting Ports” on page 185
“Running an Adapter Process” on page 186
Using Flow Diagrams
To load data into a 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 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.
Using Hyperion Application Link
179
Flow Diagram Workspace
The following table explains the elements of the flow diagram workspace:
Table 38
Flow Diagram Workspace
Element
Adapters
Methods
Ports
Connectors
Adapter Palette
Function
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.
These indicate the specific task that the adapter performs, such as read data from a file or write data to a file.
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 Planning adapter represent the member properties. They can receive data from other adapters, but cannot send data.
These are the communication paths between adapters and are used to exchange data between adapters.
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.
Creating an Adapter Process
Before you begin loading custom dimensions into a Planning application, you must create an adapter process in VBIS.
➤
To create an adapter process:
1
Select Start > Programs > Vignette
®
V7 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.
Note:
In the Hyperion Planning Adapter, custom dimension names are case-sensitive. Loading data in a different case causes an error message.
180
Loading Members and Data
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 Planning relational repository rather than directly into
Analytic Services, 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 Planning relational repository, rather than directly into Analytic Services.
For more detailed information about using the Hyperion Planning Adapter, see the Hyperion
Planning Adapter Online Help.
Adding a Hyperion Planning Adapter
➤
To add a Hyperion Planning Adapter:
1
Start Analytic Services Server.
2
Select Start > Programs > Vignette ® V7 Business Integration Studio.
3
Drag the Hyperion Planning Adapter icon from the Palette or the Adapter Libraries window and drop it in the flow diagram workspace.
4
Enter the name of the Planning Web server and click OK.
5
When you connect to the server, the Logon to Planning dialog box displays. From the Applications dropdown list, select the Planning application.
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.
Using Hyperion Application Link
181
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.
Loading Data
Use the Data Load page to define the data to load directly into an Analytic Services database using the Planning Adapter. This data load is in addition to the regular metadata load in
Hyperion Application Link.
➤
To specify the parameters for the data to load:
1
Select File > Data Load Administration.
2
From the Available Data Load Dimensions drop-down list, select a dimension, then click Go.
The data load dimension is the dimension to which you are loading metadata using HAL and corresponds to the method in the Planning Adapter.
3
From the Available Driver Dimensions drop-down list, select the dimension to which you are loading data in an Analytic Services database.
4
Select the members of the driver dimension to which you want to load data values.
These members become ports in the Planning Adapter.
5
Click Save.
To review your driver member settings, select a data load dimension and driver dimension, then click Go.
For more detailed information about using the Hyperion Planning Adapter, see the Hyperion
Planning Adapter Online Help.
Using the Hyperion Essbase Adapter
You use the Hyperion Essbase Adapter to load members from a Analytic Services database into custom dimensions within a Planning application. For example, there may be certain additional dimensions in a Analytic Services database that you want to use in a Planning application that you cannot obtain from any other external source.
182
Loading Members and Data
Also, you may find that you use Analytic Services for analysis of sales. The Hyperion Essbase
Adapter supports loading values to Planning. You can then use these values in a Planning application for forecasting, budgeting, and projections. For more detailed information about using the Hyperion Essbase Adapter, see the Hyperion Essbase Adapter Online Help.
Adding a Hyperion Essbase Adapter
The Hyperion Essbase Adapter can be used to load data to Planning applications. You can use either the Data Load Rules and the Essbase Administration Services for Essbase 7/Analytic
Administration Services for Analytic Services 9.2 or Hyperion Application Link with the
Hyperion Essbase Adapter to load data into a Planning application.
➤
To add a Hyperion Essbase Adapter:
1
Select Start > Programs > Vignette
®
V7 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 Analytic Services server.
In the Application text box, enter the name of the Analytic Services 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 Analytic Services application. The
Data Source tab in the Properties dialog box displays by default.
5
From the Database drop-down list, select a Analytic Services 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 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:
Using Hyperion Application Link
183
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 Analytic Services 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 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 Planning adapter.
You can control how the file is read by specifying information in the flat file adapter Properties dialog box.
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.
184
Loading Members and Data
●
●
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
®
V7 Business Integration Studio.
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 Length 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.
Using Hyperion Application Link
185
➤
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 pointer changes to a connect icon when it is in the correct position.
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 pointer 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 Analytic Services server must be running when you run an adapter process. 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, click Start 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 Planning application from external systems. For example, you can load data for actuals from the ERP system so that you can calculate variances. Or, you may have an existing Analytic Services database (for example, operational analysis) from which you want to load historical or current data into a Planning application You use Essbase
Administration Services for Essbase 7/Analytic Administration Services for Analytic Services
9.2 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.
Each field in a record must be separated by spaces, tabs, new lines, or carriage returns.
186
Loading Members and Data
●
●
●
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.
This section contains the following topics:
●
●
●
“Loading from Essbase Administration Services” on page 187
“Data Load File Example” on page 188
Loading from Essbase Administration Services
➤
To load from Essbase Administration Services:
1 Open Essbase Administration Services for Essbase 7/Analytic Administration Services for Analytic Services
9.2.
2
Follow the instructions in the Analytic Services documentation for connecting to the server and then entering a username and password.
3
Minimize the Essbase Administration Services for Essbase 7/Analytic Administration Services for Analytic
Services 9.2.
4 Select Start > Programs > Windows NT Explorer.
5
Browse to the directory that contains the data files you want to load.
6
Select the text files that you want to load and drag those files onto Essbase Administration Services for
Essbase 7/Analytic Administration Services for Analytic Services 9.2 on the Windows Task Bar at the bottom of the screen. Hold the mouse there until Essbase Administration Services for Essbase 7/Analytic
Administration Services for Analytic Services 9.2 maximizes.
7 Continue holding the mouse and drag the files onto the Essbase Administration Services for Essbase
7/Analytic Administration Services for Analytic Services 9.2 window, then release the mouse.
8
Follow the instructions in the Analytic Services documentation for selecting the application to which you want to load the data files.
9
Select the database to which you want to load the data files.
Note:
Select the database that corresponds to the plan type in the Planning application into which you selected to load the data.
Importing Data
187
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
Sorting Members Using a Utility
This section describes how to use the Planning Sort Member utility, which enables you to sort dimension members outside of Planning. The Sort Member utility, called
SortMember.cmd
, works just like the sort functionality on the Dimensions tab in Planning Web. You can sort
Entity, Account, Scenario, Versions, and user-defined custom dimensions. You cannot sort
Period, Year, or Currency dimension members. You might want to use this utility to sort dimension members without opening Planning, after loading members into Planning using
Hyperion Application Link.
You use the SortMember.cmd utility through a command line interface. Only administrators can run this utility.
➤
To use the SortMember.cmd utility, launch the SortMember.cmd utility from the
Utils directory, using the following syntax:
SortMember
<servername> <username> <password> <application> <member>
<children|descendants> <ascend|descend>
Table 39
SortMember Utility Parameters
Parameter
<servername>
<username>
<password>
<application>
Explanation
The server name on which the Planning application resides.
If the application resides on a remote server, the
HspJsHome.properties file used by
SortMember.cmd must contain the appropriate remote server references for this application. For information on locating the properties file, see
“Default Location of the Properties File” on page 45
.
The name of the Planning administrator
The Planning administrator password
The name of the Planning application that contains the dimension members to sort
188
Loading Members and Data
Table 39
SortMember Utility Parameters
Parameter
<member>
<children|descendants>
<ascend|descend>
Explanation
The parent member whose children or descendants you want to sort
Whether to sort by children or descendants
Sorting by children affects only the members in the level immediately below the specified member. Sorting by descendants affects all the descendants of the specified member.
Whether to sort by ascending order or by descending order
For example:
SortMember localhost admin password BUDGET account200 descendants ascend
Note:
If the application server, HBR Service, or Hyperion RMI service is running when the SortMember utility is launched, you might see some java.rmi or “Port already in use:11333” errors. They do not affect the functionality of this utility.
Sorting Members Using a Utility
189
190
Loading Members and Data
C h a p t e r
10
Managing Shared Services
Models
This chapter explains Shared Services (formerly called Hyperion Hub) models as they are shared between multiple Hyperion products. This chapter contains the following topics:
In This Chapter
Managing Shared Services Models
191
Overview
Shared Services enables multiple applications to share information within a common framework. The following table lists the high-level tasks that you can perform with Shared
Services.
Task
Managing Models
Sharing Metadata
Sharing Data
For Information
“About Managing Models” on page 194
“About Sharing Metadata” on page 195
“About Sharing Data” on page 195
About Models
Shared Services provides a database, organized into applications, in which applications can store, manage, and share metadata models. A model is a container of application-specific data, such as a file or string. There are two types of models; dimensional hierarchies such as entities and accounts, and nondimensional objects such as security files, member lists, rules, scripts, and Web forms.
Some Hyperion products require that models be displayed within a folder structure (similar to
Windows Explorer). Folder views enable the administrator to migrate an entire folder structure or a portion of a folder structure easily using Shared Services.
The process of copying a model or folder from a local application to Shared Services is known as exporting. The process of copying a model or folder from Shared Services to a local application is known as importing.
Prerequisites
Shared Services supports external directories for user authentication. To use Shared Services functionality, you must configure Planning to use external authentication.
Note:
After installing Shared Services, you must configure external authentication. For more information about installation and configuration of Shared Services, see the Hyperion System 9 Shared Services Installation Guide.
Registering Applications
Before you can use Shared Services, you must register your product with Shared Services using the Configuration Utility. For more information about using the Configuration Utility to register your product with Shared Services, see the Hyperion System 9 Planning Installation
Guide.
192
Before you can use Shared Services with a Hyperion Planning application, you must register the application so that Hyperion Planning knows where to find Shared Services. Links to
Shared Services display on the Planning Administration menu only after you register a
Planning application with the Shared Services.
➤
To register a Planning application for use with Shared Services:
1
Select Administration > Application Settings.
2
From the Show drop-down list, select Advanced Settings.
3
Click Go.
4
On the System Settings tab, in the Shared Services Server URL text box, type the URL to the Shared
Services server in the following format: http://<hostname>:<port number>
The hostname can include a domain, but the domain is not required if the server can resolve the hostname to the Shared Services server using other means. For example: http://product:8000 or http://finserv.hyperion.com:8080
Note:
Even if Shared Services and Planning are running on the same server, you should not register the Shared Services
URL as localhost:<port#>. Instead, you should use the DNS-listed hostname for that server, such as shareserver:8080 .
5
Click Register Shared Services.
To unregister the application, click Unregister Shared Services. You must unregister an application before deleting it.
6
Click Save.
Assigning an Application to a Shared Services Project
If you log into a Planning application that is not yet registered to a Shared Services Project in the User Management Console, the Add Application to Project in User Management Console dialog box is displayed.
➤
To assign an unassigned Planning application to a Project in the User Management Console:
1
At the Add Application To Project in User Management Console dialog box, select an option.
Registering Applications
193
The following options are available:
Table 40
Assign Application to Project Options
Option
New Project
Existing Projects
Unassigned Project
Description
Creates a text box into which you enter the name of the new Project you want to create in the User Management Console. When you click Submit, the current application name is displayed under the new Project name in the
User Management Console.
Note: This option is available only if you are have the Project Manager role in
Shared Services.
Enables you to select from the drop-down list an existing project to which you want the current application assigned. When you click Submit, the current application name is displayed under the Project you selected.
Leaves the current application as unassigned in the User Management
Console. The current application name is displayed under the Unassigned
Applications folder in the User Management Console.
2
When you are ready to save your selection, click Submit.
About Managing Models
Shared Services enables you to store metadata models and application folders. A separate application is provided for each product.
Shared Services provides some of the basic management functionality for models and folders:
●
●
●
●
●
Version tracking
Access control
Synchronization between models and folders in the application and corresponding models and folders in Shared Services
Ability to edit model content and set member properties of dimensional models
Ability to rename and delete models
Users must be assigned the Manage Models user role to perform the preceding actions on
Shared Services models.
Note:
The Manage Models user must have Manage permission for a model via the Shared Services Model Access window in order to assign permissions to it.
See
“Working with Models” on page 200 for detailed information about models.
For more information about assigning user roles, see the Hyperion System 9 Shared Services
User Management Guide available on the Hyperion Download Center.
194
About Sharing Metadata
Shared Services enables products to store private applications, nonshared models, and to share common models through common applications. Shared applications free multiple applications from maintaining a web of connections. To share an application, Administrators first share the applications using the common application by exporting the model to the application directory in Shared Services. Then the administrator specifies the shared models.
Because filters specify the model during import, they also enable the sharing of asymmetric models between applications.
See
“Working with Shared Applications” on page 196
for the basic process of setting up and implementing sharing among applications.
About Sharing Data
In addition to sharing application metadata, Shared Services enables you to move data between applications. The method used to move data is called data integration. Data integration definitions specify the data moving between a source application and a destination application, and enable the data movements to be grouped, ordered, and scheduled. A data integration wizard is provided to facilitate the process of creating a data integration.
Users must be assigned the Create Integrations user role to create Shared Services data integrations. As a Create Integrations user, you can perform the following actions on data integrations:
●
●
●
●
●
●
●
Assign access to integrations
Create an integration
Edit an integration
Copy an integration
Delete an integration
Create a data integration group
View (including filtering the view of) an integration
To view and run Shared Services data integrations, users must be assigned the Run Integrations user role. As a Run Integrations user, you can perform the following actions on data integrations:
●
●
●
View (including filtering the view of) an integration
Run, or schedule to run, an integration
Run, or schedule to run, a group integration
Before data can be moved between applications, the models for both the source and destination application must be synchronized between Shared Services and the product.
About Sharing Data
195
See
“Sharing Data” on page 226 for details about moving data between applications.
For more information about assigning user roles, see the Hyperion System 9 Shared Services
User Management Guide available on the Hyperion Download Center.
Working with Applications
Metadata models are stored in directories in Shared Services. Shared Services provides two types of applications: private applications and shared applications. Private applications are used by applications to store their models. Shared applications enable private applications to share models with other applications.
Working with Private Applications
Shared Services manages models at the application level. Each application that is registered with Shared Services has a corresponding application in Shared Services, in which it stores its
Shared Services models. An application has exclusive use of the application models.
To put a local copy of a model under control of Shared Services, you export the model to the application directory in Shared Services. To make a model in Shared Services available to an application, you import the model to the application.
Hyperion Shared Services provides management capabilities to manage models. For example, you can perform the following tasks, among others:
●
●
●
●
Track model versions
Control access to models
Edit member properties in dimensional models
Synchronize models between the application and Shared Services
See
“Working with Models” on page 200 for detailed information about how to manage
models.
Working with Shared Applications
Shared applications enable you to share models among applications and with other products.
Shared Services uses shared applications to support sharing models. A shared application defines the information that is common between two or more applications. Within a shared application, an application can contain private models or shared models.
The following example outlines the process for sharing models between applications or products:
1.
App1
exports its models to Shared Services. The models are stored in the private application for
App1
in Shared Services.
2.
App1
selects a shared application to share with, for example,
Common
.
196
3.
App1
designates specific models for sharing. When a model is shared, it is available for use with other applications.
4.
App2
selects the
Common.Shared
application (the same application that is shared by
App1
).
5.
App2
selects models in the shared application.
The shared models are displayed in the Model Listing view for
App2
.
An application that is shared can contain both private models and shared models in the Model
Listing View. Private models are for the exclusive use of the individual application. Shared models are available to any application that shares the same shared application.
Filters enable you to designate which part of a shared model to use in an application. In this way, you can share models with other applications if the models share a core set of common members; the models are not required to be identical. When you import a shared model, the
filter removes members that you have not designated as common. See “Filtering the Content of
for information on creating filters.
Managing Applications for Metadata Synchronization
Shared Services enables you to create, rename, and delete shared applications for metadata synchronization.
You can view a list of all applications on the Manage Applications Browse tab. The Share tab enables you to manage sharing of an application.
Figure 2 shows a sample Application Listing view.
F igure 2
Manage Applications Browse Tab
Working with Applications
197
198
Creating Applications
Shared Services enables you to create a shared application.
Shared Services provides one shared default application called
Common
. Should additional shared applications be needed, they must be created by application users or administrators.
➤
To create a shared application:
1
Select Administration > Manage Projects.
2
If it is not already selected, select the Browse tab.
3
Click Add.
4
In the Shared Application Name text field, type a name for the application.
See
“Application Naming Restrictions” on page 198
for a list of restrictions on application names.
5
Click one of these options:
●
●
Add to add the application
Cancel to cancel the operation
Application Naming Restrictions
The following list specifies restrictions on application names:
●
●
●
The maximum length is limited to 80 characters regardless of the application in which you are working.
Names are not case sensitive.
All alphanumeric and special characters can be used, with the exception of the forward slash
(
/)
and double quotation (“) characters.
Deleting Applications
You need Manage permission on an application to delete an application.
Note:
Users must have the appropriate product-specific user roles to delete an application. For a listing of product user roles, see the appropriate product-specific appendix in the Hyperion System 9 User Management Guide.
➤
To delete an application:
1
Select Administration > Manage Projects.
2
If it is not already selected, select the Browse tab.
Ensure that each of the applications currently using the shared application are no longer sharing access to the application that you want to delete.
3
Select the application to delete and click Delete.
4
Click OK to confirm deletion of the application.
Sharing Applications
To be able to share models with other applications, you must share a private application with a shared application in Shared Services.
Figure 3 shows a sample Select Shared Application window.
F igure 3
Select Shared Application Window
➤
To share an application with a shared application in Shared Services:
1
Select Administration > Manage Projects.
2
If it is not already selected, select the Share tab.
A list of shared applications is displayed, including
Common
, which is the default shared application provided by Shared Services.
3
Select the application with which you want to share.
4
Click Share to begin sharing the application with the shared application that you specified.
After you have set up access to a shared application, you can designate models to be shared. See
“Sharing Models” on page 213 .
You can stop sharing access to a shared application at any time. When you do so, models that are shared with the current application are copied into the application.
➤
To stop sharing with a shared application:
1
Select Administration > Manage Projects.
2
If it is not already selected, select the Share tab.
A list of shared applications is displayed.
3
Select the application with which you want to stop sharing.
4
Click Stop Share to stop sharing with the designated application.
Working with Applications
199
Working with Models
Shared Services enables you to store and manage models in Shared Services. The Manage
Models Browse tab lists the models that are in the product.
➤
To list the models that are in Shared Services:
1
Select Administration > Manage Models.
2
If it is not already selected, select the Browse tab.
Figure 4 shows a sample Manage Models Browse tab.
Note:
Some Hyperion products do not display folders in the Manage Models Browse tab.
F igure 4
Manage Models Browse Tab
200
Note:
If the current application is new, the view might not show models. Application models are displayed in the Browse tab after you explicitly export them to Shared Services. See
“Synchronizing Models and Folders” on page 201
for information.
All models are displayed in ascending order. The Manage Models Browse tab provides information about each model in Shared Services:
●
●
●
●
●
Model name
Model type
Last time the model was updated
Whether the model is locked and who locked it
If a filter is attached to the model and whether the filter is enabled:
indicates a filter that is enabled
indicates a filter that is disabled
You can see only the models to which you have at least Read access. If you do not have access to a model, it is not displayed in the Manage Models Browse tab.
Icons indicate where models are located:
indicates a private model
indicates a shared model
Some Hyperion products require that models be displayed within a folder structure (similar to
Windows Explorer). Folder views enable the administrator to migrate an entire folder structure or a portion of a folder structure easily using Shared Services. Folders are visible on the Manage
Models Browse tab, Manage Models Sync tab, and Manage Models Share tab. Path information for folders is displayed directly above the column headers and path text is hyperlinked to refresh the page within the context of the selected folder.
Icons indicate where folders are located:
indicates a private folder
indicates a shared folder
From the Manage Models Browse tab, you can perform any of the following operations:
●
●
●
●
●
●
●
View and edit members and member properties in dimensional models. See
Editing Model Content” on page 207
.
Filter content that is imported to an application from a shared model. See “Filtering the
Content of Models” on page 215
.
Compare the latest application version of a model to the latest version stored in Hyperion
Shared Services. See “Comparing Models” on page 205 .
Track model history. See
“Tracking Model History” on page 217 .
View model properties. See
“Viewing and Setting Model Properties” on page 224
.
Rename models. See “Renaming Models” on page 212 .
Delete models. See
.
You can synchronize the Shared Services version of a model with the application version, by importing the model from Shared Services to the application, or by exporting the model from the application to Shared Services. To do so, select the Manage Models Sync tab. See
“Synchronizing Models and Folders” on page 201 .
You can share a model with other applications. To do so, select the Manage Models Share tab.
See
.
Synchronizing Models and Folders
The Manage Models window lists the latest version of each model in Shared Services. Shared
Services also tracks models in the application and determines whether a version of each model resides in the Planning application only, in Shared Services only, or in both places.
Working with Models
201
When the latest version of a model resides in both the Planning application and in Shared
Services, the Planning application and Shared Services are said to be synchronized, or in sync, with regard to that model.
If a model is out of sync, you can synchronize it by importing the model to the application or exporting the model to Shared Services, depending on where the latest version resides.
You need Write permission to synchronize a model.
Note:
Models within folders can also be synchronized using the Shared Services sync operation. If a folder is selected, then all models within that folder and within any subfolders will be synchronized.
➤
To synchronize models and folders:
1
Select Administration > Manage Models.
2
Select the Sync tab.
Figure 5 shows a sample Sync Preview Models window.
F igure 5
Sync Preview Models Window
202
The Sync Preview window lists all models and folders in Shared Services and in the Planning application. The Sync Operation field provides a recommended operation to apply to each model or folder. For more information about sync operations, see
“Sync Operations” on page 203 .
3
Optional: For models with Select Sync Operation, you can compare the latest version of the model in
Shared Services to the model in the application by clicking the Compare button. Before clicking Compare, you must select a Sync Operation in the drop-down list box.
The latest version of the model in Shared Services is compared to the latest version in the application. The contents of the two models are shown line-by-line in a side-by-side format.
Hub Version refers to the model in Shared Services. Application Version refers to the model in the application. For information on resolving differences between the models, see
.
After you resolve the differences in a model, you are returned to the Sync Preview page.
4
Select each model that you want to synchronize.
For models with Select Sync Operation, select a Sync Operation depending on whether the application or Shared Services has the latest version of the model.
Note:
Before exporting a model from an application to Shared Services, check
“Model Naming Restrictions” on page 205
to verify that the model names do not violate Shared Services naming restrictions.
5
Synchronize the selected models.
a.
Click Sync.
A window is displayed that enables you to enter comments for each of the selected models.
b. Type comments for each model, or type comments for one model and click Apply To All to apply the same comment to all models.
c.
Click Sync.
A progress message is displayed during the sync operation.
6
Click Report to see a report of the operations that have been completed.
7 Click Refresh to update the message.
8
Click Close to return to the Sync Preview window.
Sync Operations
The Sync Preview window lists all models in Shared Services and in the application. The Sync
Operation field provides a recommended operation to apply to each model, as follows:
●
If a model exists in the application but not in Shared Services, the sync operation is Export to Hyperion Hub. You cannot change this operation. If you select the model, when you synchronize, the specified model is copied to Shared Services.
Note:
Keep in mind when exporting that Shared Services supports dimensions that contain up to 100,000 members.
●
●
If a model exists in Shared Services but not in the application, the sync operation is Import
From Hyperion Hub. You cannot change this operation. If you select the model, when you synchronize, the specified model is copied to the application.
If a model exists in both the application and Shared Services, the sync operation is selectable. Select from one of the following options:
Note:
Remember these factors when deciding which compare operation to perform. With export, the compare operation considers the application model to be the “master” model. With import, the compare operation considers the
Shared Services model to be the “master” model. In the following descriptions, the “master” model is underlined.
Working with Models
203
204
❍
❍
Export with Merge — Merges the application model content with the content in
Shared Services. Notice the following factors:
❑
❑
This option considers any filters during the merge process and ensures that filtered members are not lost.
If a property only exists in the application model, then the property is retained in the merged model.
❑
❑
❑
❑
If a property only exists in the Shared Services model, then the property is retained in the merged model.
If a property exists in both models, the value of the property in the application model will be retained in the merged model.
A member in the application model but not in the Shared Services model will be retained in the merged model
A member in the Shared Services model but not in the application model will not be retained in the merged model.
❑
❑
A member which exists both in the Shared Services model and in the application model, but in different generation levels, will be merged and the position in the application model will be maintained.
If an application system member exists only in a Shared Services model, export with merge will not delete this member. If an application system member exists both in a Shared Services model and in the application model, export with merge will merge the properties as usual and take the system member-specific attributes from the application model. See
“Application System Members” on page 211 .
For properties with attributes, the merge is based on the attribute value. For example, if the following “Alias” attribute exists in the Shared Services model:
<Alias table=
“
French
“
>Text in French<\Alias> and if the following “Alias” attribute exists in the application model:
<Alias table=
“English“>Text in English<\Alias> then the merged result will contain both attributes and will look like the following example:
<Alias table=
“
French
“
>Text in French<\Alias>
<Alias table=
“
English
“
>Text in English<\Alias>
If the value for both “Alias” attributes is the same in both models, then the value for the application model is retained in the merged model.
Export with Overwrite — Replaces the Shared Services model with the application model.
❍
❍
Import and Merge — Merges the content from the Shared Services model with the application model content.
Import and Replace — Replaces the application model with the Shared Services model.
❍
Clear before Import — Removes the existing content of the application model and replaces it with the content from the Shared Services model.
Model Naming Restrictions
The following list specifies restrictions on model names:
●
●
●
The maximum length is limited to 80 characters regardless of the application in which you are working.
Names are not case sensitive.
You can use all alphanumeric and special characters, with the exception of the forward slash
(
/)
and double quotation (“) characters. Therefore, you cannot export a dimension to
Shared Services that contains forward slash or double quotation characters.
Note:
The restrictions on names listed in this section are enforced explicitly by Shared Services. Planning may enforce additional restrictions on names. If you are sharing models with one or more other products, you should be aware of additional naming restrictions that may be enforced by those products.
Comparing Models
At any time, you can compare a model in Shared Services to its corresponding version in the application. The latest version in Shared Services is compared to the model in the application.
To compare different versions in Shared Services, see
“Tracking Model History” on page 217 .
➤
To compare the application representation of a model with the Shared Services representation of the model:
1
Select Administration > Manage Models.
2
Select the Sync tab.
The Sync Preview window lists all models in Shared Services and in the application. The Sync
Operation field provides a recommended operation to apply to each model or folder. For more information about sync operations, see
.
3
Select a Sync Operation in the drop-down list box for the model of interest.
4 Click the Compare button next to the Sync Operation box.
The latest version of the model in the application is compared with the latest version in Shared
Services.
5
Perform any compare operations.
For a detailed description of the compare operations, see “Compare Operations” on page 206
.
6
Click OK to return to the Sync Preview window.
Working with Models
205
Compare Operations
The contents of the two models are shown line-by-line in a side-by-side format. Application
Version refers to the model in the application. Application versions of a model are displayed on the left side of the Resolve Models (Compare) window. Hub Version refers to the model in
Shared Services. Hub versions of a model are displayed on the right side of the Compare
Models window.
Figure 6 shows a sample Resolve Models (Compare) window.
F igure 6
Resolve Models (Compare) Window
206
By default, the Resolve Models window displays up to 50 rows per page, displays any folders in an expanded format, and displays only those models with differences.
Color coding highlights any differences between the content of the two models, as follows:
●
Red indicates that the element has been deleted from the model.
●
●
Green indicates that the element has been inserted into the model.
Blue indicates that the element has been changed.
Note:
The compare operation filters out any application system members that are not relevant to the product being viewed. For example, if viewing HFM models, Shared Services will filter out any application system members that are not valid for HFM. For more information about application system members, see
Table 41 describes the Resolve Models (Compare) window elements.
Table 41
Resolve Models (Compare) Window Elements
Element
Expand All button
Collapse All button
<<FirstDiff button
<PrevDiff button
NextDiff> button
LastDiff>> button
View All button
Show Diff Only button
View button
<--
-->
Description
Click to display the selected member and any children under the selected member in an expanded format (default)
Click to display the selected member and any children under the selected member in a collapsed format
Click to jump to the first model element with a difference
Click to display the difference immediately previous to the current difference
Click to display the next difference after the current difference
Click to jump to the last model element with a difference
Click to display all model elements, not just the elements with differences
Click to display only the model elements with differences (default)
Note: For contextual purposes, Show Diff Only also displays the members immediately previous to and immediately after the member with a difference.
Click to display the member property differences for a selected element
A red arrow indicates a deleted element in the Application Version of a model
A green arrow indicates an inserted element in the Application Version of a model
Click to jump to the first page of the model
Page drop-down list box
Rows
Click to display the previous page of the model
Select a page to display in the Taskflow Listing area.
Click to display in the Taskflow Listing area the page you selected in the Page dropdown list box.
Click to display the next page of the model
Click to jump to the last page of the model
The number of rows displayed on each page (default is 50)
Viewing and Editing Model Content
The Shared Services interface provides an editor that enables you to view and edit the content of models directly in Shared Services. You can use the editor only with dimensional mode. You need Read permission to view the content of a model. You need Write permission to edit or delete a model.
Working with Models
207
Figure 7 shows a sample View Model window.
F igure 7
View Model Window
208
The editor enables you to manage dimension members by performing these tasks:
●
●
●
●
●
●
●
●
View all members for a model, including application system members
Add a sibling or a child to a member
Change the description of a member
Rename a member
Move a member up or down in the hierarchy
Move a member left or right (across generations) in the hierarchy
Edit dimension member properties
Enable or disable a filter
If you are renaming a member, keep the following rules in mind: a.
You cannot rename a shared member.
b. You cannot create a duplicate member name (the rename operation performs a uniqueness check).
c.
You cannot rename an application system member.
Note:
Renaming a member and moving a member across generations within Shared Services enables products to retain the member properties for a shared model. Therefore, if you want to retain member properties across all products for a shared model, perform the rename or move member operation within Shared Services rather than within the individual product.
➤
To view or edit dimension members:
1
Select Administration > Manage Models.
2
If it is not already selected, select the Browse tab.
3
Select a model and click View.
The dimension editor shows the members of the selected model, including any application system members. See
“Application System Members” on page 211 .
4 Use the editing keys to make the following changes:
●
●
●
●
●
●
Add a child or sibling member
Rename a member (notice the rules about renaming members in the previous section)
Delete a member
Move a member up, down, left, or right in the dimensional hierarchy
Edit member properties
For more information about editing member properties, see “Editing Member Properties” on page 209
.
If a filter exists for a model, enable or disable a filter
For more information about filters, see
“Filtering the Content of Models” on page 215
.
Note:
If you click on a member and it is not editable, then the member is an application system member. For more information about application system members, see
“Application System Members” on page 211
.
5
Click Validate to perform a simple validation check.
The validation check verifies the following facts and lists any exceptions:
❍
❍
That you have not created names that are too long (for example, 20 characters for
Hyperion Financial Management, 80 characters for Hyperion Planning)
That you have not created any duplicate names
Note:
Shared Services does not perform validations for Alias/UDA uniqueness.
6
Click Save to save the changes that you have made and to create a new version of the model in Shared
Services.
Editing Member Properties
You can make changes to the settings of member properties of dimensional models and save the changes to a new version of the model.
➤
To edit member property settings:
1
Select Administration > Manage Models.
2
If it is not already selected, select the Browse tab.
Working with Models
209
3
Select a model name and click View.
The dimension editor shows the members of the selected model, including any application system members. See
“Application System Members” on page 211 .
4 Select a member and click Edit.
The Edit Member window provides separate tabs for properties that are unique to a particular product. For example, the HP tab contains properties used by Planning and the HFM tab contains properties used by Financial Management. Each tab also displays properties that are common or shared between multiple products. Shared properties are preceded by an icon, , that indicates that a property is shared.
Note:
You cannot edit properties for an application system member. For more information about application system
members, see “Application System Members” on page 211 .
Figure 8 shows a sample Edit Member window.
F igure 8
Edit Member Window
210
To view which products share a particular shared property, hover the cursor over the shared property icon. A tool tip is displayed with the names of the products that share the property.
5 Select a tab and use the editing keys to change member property settings as you prefer.
Note:
Alias properties may be displayed in a different order in Hyperion Shared Services than in Planning. See the discussion following the procedure for details.
6
In the Edit Member window, click Save to save the property settings that you have made.
7
In the Edit Member window, click Close to close the window.
Note:
The Edit Member window remains open unless you manually close it.
8
Click one of these options:
●
Save to save the changes you have made and create a new version of the model
Close to return to the Model Listing view
●
If a member has an alias property, all the aliases and alias table names for the member are displayed in the Edit Member window. For example:
Planning:
<Alias table="English">MyAlias in English</Alias>
<Alias table="German">MyAlias in German</Alias>
<Alias table="French">MyAlias in French</Alias>
Shared Services:
Alias (English): MyAlias in English
Alias (German): MyAlias in German
Alias (French): MyAlias in French
The order in which Shared Services reads the alias tables is not necessarily the order in which the aliases are shown in Planning, which can be changed by user preferences.
Application System Members
Application system members store critical system information such as currency rates and ownership information. Each product has certain application system members that, when exported to Shared Services, are displayed in the model hierarchy.
You can view the details and properties of an application system member, however you cannot delete, edit, add children to, or rename an application system member in Shared Services.
Application system members will be filtered out of the hierarchy if they are not relevant to the product being viewed. The compare operation filters out any application system members that are not valid for your product. For example, if you are viewing HFM models, Shared Services will filter out any application system members that are not valid for HFM. For more
information about compare operations, see “Compare Operations” on page 206
.
You can import and export models that contain application system members. Keep the following in mind while performing the following sync operations:
●
●
●
Import operations will only import application system members if they are valid for your product. For instance, if a shared model has a system member called “active” which is only valid for HFM, when this model is imported by Planning, it ignores this member.
Export with Overwrite replaces the Shared Services model with the application model, including any application system members.
Export with Merge merges the application model content with the content in Shared
Services. Notice the following factors:
Working with Models
211
212
❍
❍
❍
If an application system member exists only in Shared Services, export with merge will not delete this member.
If an application system member exists both in Shared Services and in the product, export with merge will merge the properties as usual and take the system memberspecific attributes from the product side of the model.
All other export with merge scenarios will behave exactly the same way for system members as they do for normal members. See
.
Renaming Models
Shared Services enables you to rename models in Shared Services. For example, you might want to rename a model if two applications want to share dimensional models that are named differently. For example, one application uses plural dimension names and the other application uses singular names. To share the models requires renaming one or both of them to a common name.
Renaming a model changes the name only in Shared Services. The internal representation of the name does not change. If you import a new version of a renamed model to the application, the new version retains the original name.
You need Write access to a model to rename it.
➤
To rename a model:
1
Select Administration > Manage Models.
2 If it is not already selected, select the Browse tab.
3
Select a model and click Rename.
4
Type a new name in the New Name text box.
5 Click one of these options:
●
●
Rename to save the new name
Cancel to cancel the name change
See
“Model Naming Restrictions” on page 205
for a list of restrictions on model names.
Deleting Models
You can delete a model if you have Write access to it.
➤
To delete a model:
1
Select Administration > Manage Models.
2
If it is not already selected, select the Browse tab.
3
Select a model and click Delete.
4
Click OK to confirm deletion.
Sharing Models
You set up the sharing of models between applications by designating a common shared application to be used by two or more applications. See
“Working with Shared Applications” on page 196
and
“Sharing Applications” on page 199
for details about shared applications.
You can select two types of models to share:
●
●
You designate models in the private application in Shared Services to share with other applications.
You select models from a shared application that have been made available for sharing by another application.
Note:
Models within folders can also be shared using the Shared Services share operation. If a folder is selected, then all the models within that folder and within any subfolders will be shared.
➤
To share models:
1
Select Administration > Manage Models.
2
Select the Share tab.
The sample Share Models window shown in Figure 9
lists both private and shared models.
F igure 9
Share Models Window
Icons indicate whether a model is shared:
indicates a private model that is not shared
indicates a shared model
indicates a model with a conflict (model exists in both the private application and in the shared application in Shared Services)
Working with Models
213
214
The Share Operation column provides a recommended operation to apply to each model, as follows:
Note:
The Share Operation column displays only the first 10 characters of the shared application name. If the shared application name exceeds 10 characters, then Shared Services appends ellipses (...) to the end of the application name.
●
●
Share to <shared_application_name> — Copies the content of the model in the private application to the shared application. The share operation also deletes the model in the private application and creates a link in the private application to the model in the shared application.
Unshare from <shared_application_name> — Copies the content of the model in the shared application to the private application and removes the link to the shared application.
Note:
The model remains in the shared application. A copy of this previously shared model will be available in the user’s private/working application.
●
If there is a conflict and the model exists in both a private application and a shared application, the share operation is selectable. This conflict sometimes occurs because a model was previously shared and then unshared. Selecting a share operation enables you to reshare a model that was previously shared.
Use the drop-down list box to select one of the following options:
❍
❍
❍
Share from <shared_application_name> (Overwrite) — Deletes the model in the private application and creates a link to the model in the shared application.
Share to <shared_application_name> (Merge) — Merges the content of the model in the private application with the content of the model in the shared application. The model in the private application is then deleted and a link is created to the model in the shared application.
Share to <shared_application_name> (Overwrite) — Replaces the content of the model in the shared application with the content of the model in the private application. The model in the private application is then deleted and a link is created to the model in the shared application.
3
Select one or more models to share and, if the share operation for a model is selectable, choose a share operation.
4
Click Share to begin the sharing operation.
5
Click Refresh to update the status of the operation.
6
Click Report to view information about the status of the operation, including whether it was successful and the reason for failure if the operation failed.
7
Click OK to return to the Share Models view.
You can stop sharing a model at any time. When you stop sharing a model, a copy of the model is created in the private application in Shared Services.
➤
To stop sharing a model:
1
Select Administration > Manage Models.
2
Select the Share tab.
3
In Share Models, select one or more models to remove from sharing.
4
Click Share.
5
When the status is complete, click OK.
The selected models are stopped from sharing and a copy of each model is made to the private application in Shared Services.
Filtering the Content of Models
When you share models with other applications or products, it is possible that the models have most members in common, or have a common core of members, but do not have all members in common. Shared Services enables you to write a filter that retains specified members of the shared model to remove when the model is imported to an application.
For example, a Financial Management application exports an account dimension and shares it in a common shared directory. A Planning application decides to use the account dimension from the Financial Management application and links to the shared account dimension.
The Planning application conducts budgeting on profit and loss accounts only and therefore does not require any balance sheet accounts from the account dimension. The Planning application writes a filter that removes the Total Assets member and all of its descendants and the Total Liabilities member and all of its descendents.
You can write filters for dimensional models only, and, you cannot have multiple filters on a particular dimension. Writing filters requires Write access to a model.
➤
To write a new filter or to modify an existing filter:
1 Select Administration > Manage Models.
2
If it is not already selected, select the Browse tab.
3
Select a model and click Filter.
In the Create/Edit Filter window, the Members List area shows the members of the model and the Filtered Out Members text box shows members that are to be retained in the model on import.
Working with Models
215
Figure 10 shows a sample Members List area of the Create/Edit Filter window.
F igure 10
Create/Edit Filter Window: Members List Area
216
4
From the Members List area, select a member.
5
Click Add to move the selected member from the Members List area to the Filtered Out Members text box.
The Select Member drop-down list box indicates how much of the hierarchy is to be filtered, as follows:
●
Descendants (Inc). Filters the selected member and all of its descendants.
●
Descendants. Filters descendants of the selected member (but not the member itself).
Member. Filters the selected member only.
●
You can move selected members back to Members List from Filtered Out Members with the
Remove and Remove All buttons.
6
Repeat the two previous steps until you have selected as many members to retain as needed.
7
Click one of these options:
●
●
Save to save the filter
Close to cancel the changes you have made
The filter icon, , in the Model Listing view indicates that a model has an attached filter.
After a filter is applied to a model, you see only those members within a model that are not filtered out. If you would like to see all the members in a filtered model, you can disable the filter and then, after viewing, enable the filter again.
➤
To disable an existing filter:
1
Select Administration > Manage Models.
2
If it is not already selected, select the Browse tab.
3
Select a filtered model and click Filter.
4
Click Disable.
5
Click Save to view the model in the Model Listing view.
The disabled filter icon, , in the Model Listing view indicates a model has an attached filter, but the filter is disabled.
➤
To enable an existing filter:
1
Select Administration > Manage Models.
2
If it is not already selected, select the Browse tab.
3 Select a filtered model with a disabled filter icon and click Filter.
4
Click Enable.
5
Click Save to view the model in the Model Listing view.
The enabled filter icon in the Model Listing view, indicates that the filter is enabled.
➤
To delete an existing filter:
1
Select Administration > Manage Models.
2
If it is not already selected, select the Browse tab.
3
Select a filtered model and click Filter.
4
Click Delete.
5
When prompted to confirm the deletion of the filter, click OK.
Tracking Model History
Shared Services maintains a version history for each model in the product, if versioning is enabled for the model. To see if versioning is enabled for a model and to enable versioning if it
is not enabled, see “Viewing and Setting Model Properties” on page 224
.
Working with Models
217
Figure 11 shows a sample Model History window.
F igure 11
Model History Window
218
➤
To view the version history of a model in Shared Services:
1
Select Administration > Manage Models.
2
If it is not already selected, select the Browse tab.
3
Select a model and click History.
Shared Services displays a list of model versions, including the name of the person who updated the version, the update date, and comments for each model.
4
From the version list, you can perform any of the following tasks:
●
●
●
●
View the contents of any model. i.
Click a version.
ii. Click View.
See
“Viewing and Editing Model Content” on page 207 for more information.
Compare any two model versions to each other. i.
Select any two versions.
ii. Click Compare.
The contents of the two model versions are shown line-by-line in a side-by-side format.
See
“Comparing Models” on page 205
for more detailed information.
Replace the current model in the application with a version in the list. i.
Select any version.
ii. Click Import.
The specified version is imported to the application and replaces the current model. If a filter was applied to a previous version of a model, the model is imported with the filter applied.
View the properties of any model.
i.
Click a version.
ii. Click Properties.
See
“Viewing and Setting Model Properties” on page 224 for more information.
Managing Permissions to Models
Shared Services enables you to manage access permissions to models in applications independent of any Planning application. You assign permissions on a model-by-model basis to individual users or to groups of users. You can also assign permissions at the application level.
User names and passwords are managed by an external authentication provider, so they must be created externally—using NTLM, LDAP, or MSAD—before they can be added to Planning.
The Shared Services administrator adds authenticated users to Shared Services by using the
Shared Services User Management Console. The Shared Services administrator also creates and manages groups by using the User Management Console. See the Hyperion Shared Services User
Management Guide for details.
When applications are created in the Shared Services respository, all permissions are denied for all users, except the user who created the application. The creator of the application or the administrator (the admin user) must assign permissions for the new application.
Similarly, when data integrations are created, all permissions are denied for all users (via a group called Users), except the user who created the data integration. To change the default setting for a user, you must explicitly add the user to the DataBroker application and apply the desired access rights.
Note:
To override the DataBroker application access settings, it is possible to apply access rights to individual integration models. This can be done in the Manage Models page that displays the integration models in the
DataBroker application. How each product navigates the user to this page is different so refer to each product's documentation for instructions on accessing the Manage Models page.
To access specific models in Shared Services, users must be assigned access rights individually 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 rights of the individual user take precedence.
To give users access to models other than their own, an administrator must add the users and assign their permissions.
Permissions
Model management provides the following types of permissions:
●
●
Read. The ability to view the contents of a model.
You cannot import a model if you have only Read access to it.
Write. The ability to change a model.
Write access includes the ability to export, import, and edit a model. Write access does not automatically include Read permission. You must assign Read permission explicitly, in addition to Write permission, if you want a user to have these permissions.
Working with Models
219
220
●
Manage. The ability to create new users and change permissions for users.
Manage access does not automatically include Read and Write permissions. You must assign Read and Write permissions explicitly, in addition to Manage permission, if you want a user to have all these permissions.
The following table summarizes the actions that a user can take in regard to a model with each of the permissions.
Action
Sync
Import
Export
View
Filter
Compare
History
Set Properties
Assign Access
Share
Assign Permissions
Edit
Rename
Delete
Table 42
Access Permissions
No
No
No
No
No
Yes
Yes
No
No
Access Permission
Read
No
No
No
Yes
No
Yes
Yes
Yes
Yes
Write
Yes
Yes
Yes
Yes
Yes
Yes Yes
No Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Manage
Yes
Yes
Yes
Yes
Yes
You can apply permissions to groups and to individual users. Users are automatically granted the permissions of the groups to which they belong. You can, however, explicitly add or deny permissions to a user to override group permissions.
For each type of access permission (Read, Write, and Manage), you must apply one of the following actions:
●
●
●
Grant. Explicitly grant the permission to the user or group.
Granting permissions to a member of a group overrides permissions inherited from the group. For example, if a group is denied a permission, you can explicitly grant the permission to a member of the group.
Deny. Explicitly deny the permission to the user or group.
Denying permissions to a member of a group overrides permissions inherited from the group. For example, if a group is granted a permission, you can explicitly deny the permission to a member of the group.
None. Do not apply the permission to the user or group.
Not applying a permission is different from denying a permission. Not applying a permission does not override permissions inherited from a group. Specifying None for particular permissions for individual users enables you to apply permissions on a group basis.
Note:
If a user belongs to groups with mutually exclusive permissions to the same model, permissions that are assigned override permissions that are denied. For example, if a user belongs to a group that denies Read access to a particular model and belongs to another group that assigns Read access to the model, the user in fact is granted
Read access to the model.
Assigning Permissions to Models
You assign permissions on individual models in applications. You assign permissions on the models to individual users or to groups of users. You must have Manage permission for a model to assign permissions to it.
Users inherit the permissions of the groups to which they belong. Permissions that you assign to an individual user, however, override any group permissions that the user inherits.
Note:
The following procedure can be used to assign permissions to metadata models or to data integrations. To assign access to metadata models, begin the procedure when metadata models are displayed. To assign access to integrations, begin the procedure when integrations are displayed.
➤
To assign permissions to models:
1
Select Administration > Manage Models.
2
If it is not already selected, select the Browse tab.
3
Select a model and click Access.
You can view the permissions that are assigned to users and groups for the selected model in the Model Access window.
Figure 12 on page 222 shows a sample Model Access window.
Working with Models
221
F igure 12
Model Access Window
4
To add users or groups, click Add.
The Add Access window is displayed. The Available Users/Groups text box lists users who are authenticated as Hyperion Shared Services users. If a user that you want is not on the list, contact the Hyperion Shared Services administrator. The administrator can use Hyperion
Shared Services Configuration Console to add authenticated users.
F igure 13
Add Access Window: Select Available Users Area
222
5
In the Available Users/Groups text box, select users or groups to assign to this model (press Ctrl to select multiple users). Click Add to move the selected users and groups to the Selected Users/Groups text box or click Add All to move all users and groups to the Selected Users/Groups text box.
Note:
Group names are preceded by an asterisk (*).
6
Assign permissions to the selected users and groups by selecting one of the Grant, Deny, or None option buttons for the Read, Write, and Manage permissions.
F igure 14
Add Access Window: Type of Access Area
Note:
Assigning (or denying) a permission does not implicitly assign (or deny) any other permissions; that is, assigning
Write permission does not implicitly assign Read permission, and assigning Manage permission does not implicitly assign Read and Write permissions. Likewise, denying Read permission does not implicitly deny Write and Manage permissions, and denying Write permission does not implicitly deny Manage permission. You must explicitly assign all permissions that you want a user to have.
for details about the Read, Write, and Manage permissions and the Grant, Deny, and None actions that you can apply to each permission.
7
Click Add to assign the new permissions.
Editing Permissions to Models
You can edit the permissions of individual users and groups on individual models. You must have Manage permission for a model to change permissions for it.
➤
To edit permissions to models:
1
Select Administration > Manage Models.
2
If it is not already selected, select the Browse tab.
3
Select a model name and click Access.
You can view the permissions that are assigned to users and groups for the selected model.
4
Select the check box next to one or more users or groups and click Edit.
The window shows the permissions currently assigned to the selected users or groups.
Note:
The icon indicates an individual user and the icon indicates a group of users.
5
Change permissions for the selected user or group by selecting one of the Grant, Deny, or None option buttons for the Read, Write, and Manage permissions.
for details about the Read, Write, and Manage permissions and the Grant, Deny, and None actions that you can apply to each permission.
6
Click one of these options:
●
●
Update to accept the changes
Close to cancel the changes
Working with Models
223
224
To view any changes made to model access, you must log out of the product application, close the browser, and then re-login to the product application.
Deleting Permissions to Models
You can delete all permissions for users and groups to individual models. You must have
Manage permission for a model to delete access to it.
➤
To delete access to a model:
1
Select Administration > Manage Models.
2
If it is not already selected, select the Browse tab.
3
Select a model name and click Access.
You can view the permissions that are assigned to users and groups for the selected model.
4
Select the check box next to one or more users or groups and click Delete.
Note:
When you click Delete, the permissions are immediately removed without a warning message being displayed.
Viewing and Setting Model Properties
Shared Services provides property data for each model in the product. You can view all model properties and set selected properties.
F igure 15
Model Properties Window
Shared Services displays the following model properties:
●
●
●
●
●
●
●
●
Creator. Name of the user who created the model
Updated By. Name of the person who updated the model
If there have been no updates, the name of the creator is listed and the Updated Date is the same as the Created date.
Create Date. The date on which the model was created in (exported to) Shared Services
Updated Date. The date on which the model was last updated in Shared Services
Versioning. Whether versioning is enabled
If versioning is not enabled, you can enable it by changing this setting. Once versioning is enabled, however, you cannot disable it.
Lock Status. Whether the model is locked or unlocked
You can change this setting to lock the model for your exclusive use or to unlock the model to allow other users to work with it. Models are locked for only 24 hours. After 24 hours, the model is automatically unlocked.
Share Information. Is provided if the model is shared with a shared application
❍
Source Application. The name of the shared application
❍
❍
Source Model. The path to the model in the shared application
Transformation. The name of the transformation, if any, that Shared Services applies to the model to make it usable to the application
Dimension Properties. Is provided only if the model is a shared dimension model
❍
Dimension Type. The name of the dimension type.
❍
❍
If the Dimension Type value is None, then you can select a new dimension type in the
Dimension Type drop-down list box next to the Change To button.
Change To. Only shown if the Dimension Type value is None.
Click the Change To button after you select a new dimension type value in the
Dimension Type drop-down list box.
Dimension Type drop-down list box. Only shown if the Dimension Type value is
None.
Use the drop-down list box to select a new dimension type. Then click Change To to change the dimension type.
You need Read access to view model properties and Write access to change model properties.
➤
To view or change model properties:
1
Select Administration > Manage Models.
2 If it is not already selected, select the Browse tab.
3
Select a model and click Properties.
You can view the properties for the model.
Working with Models
225
4
You can make the following changes to model properties:
●
●
●
If versioning is not enabled, enable it by clicking the Enable button next to Versioning.
After versioning is enabled, model management maintains a version history for the model.
You cannot disable versioning for a model after you enable it.
Lock or unlock the model by clicking the Lock or Unlock button next to Lock Status.
If the Dimension Type value is None, select a new dimension type in the drop-down list box next to the Change To button. After you select a new dimension type, click Change To and accept the resulting confirmation dialog box to invoke the change.
5
Click Close to return to the previous page and save any changes that you have made.
Sharing Data
Shared Services enables you to move data between applications. The method used to move data is called data integration. A data integration specifies the following information:
●
●
●
●
Source product and application
Destination product and application
Source dimensions and members
Destination dimensions and members
A data integration wizard is provided to facilitate the process of creating a data integration.
Whoever has write access to the
DataBroker.DataBroker
application can create data integrations. Users with read access to the
DataBroker.DataBroker
application can run data integrations. Access rights to this application are granted through the Shared Services User
Management Console. See the Hyperion Shared Services User Management Guide.
By default, all Shared Services users have full access (Read, Write, and Manage) to all integrations.
A data integration can be run manually or scheduled to run at a specific time. Data integrations can also be placed in groups and run sequentially.
Prerequisites for Moving Data Between Applications
Before data can be moved between applications, the models for both the source and destination application must be synchronized between Shared Services and the application. See
“Synchronizing Models and Folders” on page 201 for instructions on synchronizing models.
Although Planning and Shared Services provide tools to create integrations, the movement of data between applications, particularly applications from different products, requires that you be very familiar with the data.
226
Assigning Access to Integrations
You assign access to integrations using a similar process to assigning access to metadata models.
Note:
By default, all users except the creator of the integration are denied access rights to data integrations (via a group called Users). To change the default setting for a user, you must explicitly add the user to the DataBroker application and apply the desired access rights. To override the DataBroker application access settings, it is
.
➤
To assign access to integrations:
1
Select Administration > Manage Models.
2
Go to “Assigning Permissions to Models” on page 221 and complete the procedure to assign permissions
to integrations of your choosing.
Accessing Data Integration Functions
Write privileges are required to perform most data integration functions. A user with Read only privileges can view (including filtering the view) and run integrations. A user with Write privileges, however, can view, run, create, edit, copy, and delete an integration.
Note:
In order for a user to not see a specific integration model, the user needs to be explicitly assigned Deny Read at a minimum (Write and Manage can be any setting) for the DataBroker application.
➤
To access all data integration functionality, click Administration > Manage Data.
Figure 16 shows a sample Manage Data window.
F igure 16
Manage Data Window
A list of integrations is displayed. The list includes names, source applications, and destination applications. An application name identifies a product, application, and a shared application in the form: <
Product.Application.Shared Application
>, for example,
HFM.App1.beta
.
Sharing Data
227
228
Note:
When viewing a list of integrations, performance may become slower as you add more integrations and as more users view the list.
Group integrations do not have a source and destination; each integration in a group specifies its individual source and destination. A group icon in the source and destination columns identifies a group integration. The link,
View group details
, lists the integrations in the group.
You can perform any of the following functions from the Integrations page:
●
●
●
●
Create, edit, or copy an integration (see “Creating or Editing a Data Integration” on page 229 )
Create a data integration group (see “Grouping Integrations” on page 241
)
Delete an integration (see
“Deleting Integrations” on page 236 )
Run, or schedule to run, an integration (see “Scheduling Integrations” on page 237 )
Filtering Integration Lists
In a list, by default, all available integrations are displayed. You can filter the list, based on the source product and application, or the destination product and application.
➤
To filter an integration list:
1
Click Administration > Manage Data.
A list of integrations is displayed. The integrations for all products and applications are shown by default.
For a sample Manage Data window, see Figure 16 on page 227 .
Two combination boxes, Source and Destination, are displayed above the Filter View button.
Each combination contains two drop-down list boxes, the first to specify a product and the second to specify a application.
Note:
A list of integrations is displayed when you create an integration group. If you are creating a group, begin with step 2.
2
Select a product from the product Source or Destination drop-down list box or from both the product
Source and Destination drop-down list boxes.
The second Source or Destination drop-down list box is populated with the applications for the selected product.
3
Select a particular application or leave All Registered Applications selected.
You can select only one application.
4
Click Filter View to update the list based on the selections that you made.
The filter enables the display of integrations that act on a particular source product or application, or on a destination product or application, or on a combination of both. For example, if you specify HBM as the source application and Planning as the destination application, the list includes all integrations whose source is Business Modeling (HBM) or whose destination is Planning.
The following examples illustrate the different combinations of product and application that you can specify in the Source and Destination combination boxes
●
If a source product is specified and the three other drop-down boxes specify all
, the list displays all integrations with the specified source product.
●
●
If a source product and a source application are specified and the two destination dropdown boxes specify all
, the list displays all integrations with the specified source application.
If a source product and destination product are specified and the two application dropdown list boxes specify all
, the list displays all integrations from the given source product to the given destination product. If an integration is bidirectional (can be transposed) and either source-to-destination or destination-to-source matches the given products, the integration is listed.
Creating or Editing a Data Integration
Shared Services provides a data integration wizard to enable the process of moving data between applications.
Note:
To create a data integration, you must be assigned Write access to the DataBroker application. Access rights to this application are granted through the Shared Services User Management Console. See the Hyperion Shared
Services User Management Guide.
➤
To create a new integration or edit an existing integration:
1
Click Administration > Manage Data.
A list of integrations is displayed. For a sample Manage Data window, see Figure 16 on page 227 .
2
Take one of the following actions:
●
●
If you want to create an integration, click New.
If you want to edit an integration, select an integration and click Edit.
Note:
Locking of integration models in edit mode is not supported. As a consequence, it is possible for multiple users to simultaneously open an integration and make changes. If more than one administrator edits the same integration simultaneously, the last one to save takes precedence. The entire integration is overwritten with the last version saved. No warning message is displayed.
●
If you want to use an existing integration to create a new integration, select an existing integration and click Copy.
Sharing Data
229
Note:
Action buttons (New, Edit, Delete, Copy, and Run) that are enabled for a user are defined at the DataBroker application level and not at the model level. However, for existing integration models, the actions that a user can perform are controlled at the model level. For example, if a user has full access rights to the DataBroker application, but Read access to a specific integration model, all buttons are enabled but when the user tries to edit and save this integration, an error is displayed.
The first page of the wizard is displayed.
Figure 17 shows a sample Create Integration window.
F igure 17
Create Integration Window
230
For a new integration, the fields are blank. For an integration to be edited or copied, the fields are populated with existing values.
Figure 18 on page 231 shows a sample Edit Integration window.
F igure 18
Edit Integration Window
3
Enter information and select or clear check boxes.
Table 43
Edit Integration Window Options
Item
Integration Name
Source
Destination
Bidirectional
System Override
Description
A text box for a unique name for the integration. For an edited integration, text box is read-only and cannot be changed. To rename an integration, copy the integration to a new name, and delete the original integration.
A combination text box to identify the source for the data. The first box contains a drop-down list of products registered with Shared Services. When you specify a product, the second box is populated with applications belonging to the product.
When you specify an application, the third box is populated with data sources.
Data sources include elements like Hyperion Planning Plan Type. If you select an application that does not require or support data sources, “Default Data Source” is displayed in a disabled field that you cannot change.
A combination text box to identify the destination for the data. The first box contains a drop-down list of products registered with Shared Services. When you specify a product, the second box is populated with applications belonging to the product.
A check box that determines the direction in which the integration can be run. If the box is not checked, data is moved from the source to the destination. If the box is checked, the user can choose a direction (source to destination or destination to source) when scheduling or running the integration.
A check box that enables writing to read-only fields in the destination application.
Sharing Data
231
232
Table 43
Edit Integration Window Options (Continued)
Item
Suppress Empty
Scale
Notes
Description
A check box that enables the integration, for performance reasons, not to transfer missing cell (#missing) values. If the box is checked, to ensure that data is transferred successfully, you must prepare the destination database before running
the integration. See “Prerequisites for Moving Data Between Applications” on page 226 for details.
A text box for a value that acts as a multiplier for the data. Enter a value with which you want to scale the integration data. For example, to convert data from a positive to negative value during the data transfer, specify a scale value of -1. Each transferred data value is then multiplied by -1, in effect, converting them to negative values.
A text box for optional comments and notes.
4
Click Next to go to the second page of the wizard.
The second page of the create integration wizard enables you to specify the dimensions that are equivalent (shared) for purposes of the current integration.
By default, the wizard identifies dimensions of the same name (in source and destination applications) as shared. A line between dimensions indicates that they are shared.
To optimize performance, when creating an integration that has more than one shared dimension, dimension order is important. The order of shared dimensions in the integration is controlled by the order in which you share dimensions. In general, you should place the one shared dimension that has the largest number of selected members for that integration as the last shared dimension. To do this, it is best to determine first what members for each dimension will be used in an integration. Of those dimensions that will be shared, identify the one where your member selection yields the largest number of members. On page 2 where you identify shared dimensions, if that dimension is automatically shared, unshare it. Then share all desired dimensions except for that one dimension. Then share that one remaining dimension last before moving on to third page of the wizard. This will ensure that this dimension is displayed last in the Shared Dimension Members panel on the third page of the wizard.
5
Take one or more of the following actions:
●
●
●
If you want to specify the shared dimensions, select one or more pairs of dimensions (in source and destination applications) and click Share.
A dimension can be shared with only one dimension in the other application. A line is drawn between any two dimensions that are shared.
If you want to unshare any dimensions that are shared by default, select one or more dimensions in either application and click Unshare; or click Unshare All to remove sharing from all dimensions.
If you want to return to the default shared dimensions, click Default.
Note:
You are not required to identify every dimension that is in fact identical. The reason to identify shared dimensions is to specify the dimensions for which you want to move a range of members. For any particular integration, if you are interested in only one member for a dimension, you can leave the dimension unshared.
The third page of the wizard enables you to pick ranges of members from the shared dimensions to define the slice of data that will be transferred.
6
Click Next to go to the third page of the wizard.
The window displays dimensions in two categories:
●
Shared Dimension Members. Dimensions identified as shared on the previous wizard page
●
Common POV. Dimensions not identified as shared
Each POV (point of view) uses the same background POV members and a unique set of dynamic POV members. You specify the dynamic POVs.
7
Select shared dimension members: a.
Next to a shared dimension, from which you want to select members, select the Select
Members menu control.
b. Select From Source or From Destination.
A list of members from the appropriate application (source or destination) is displayed.
c.
Select one or more members.
d. Click Select.
You can also specify a function to identify a set of members. For example, type
Match(*)
or
AllMembers()
to specify all members of the same name and the same dimension in the source and destination applications.
When you run an integration with a function, the function transfers data only for members that are common to applications. For both the source and destination applications, however, the integration must iterate through every member identified by the function. For example, the following table shows members from a time dimension for two applications:
Application 1 (Source)
1997
1998
1999
2000
2001
--
Application 2
(Destination)
1999
2000
2001
2002
2003
2004
If you specify an
AllMembers()
function, the integration must check all 11 members; however, data is transferred only for 1999, 2000, and 2001, because these years are common to both applications. Warning messages are returned for the other years.
Note:
You must select at least one member from each dimension in Common Members or specify a function that identifies a common member.
Sharing Data
233
234
When using double quotation marks ( “ ) and parentheses () in member names in the Create
Integration Wizard, follow these guidelines:
The following examples illustrate valid use of these characters in member names: abc
“abc” func(abc)
“func(abc)”
“func(a,b,c)”
“func(a(b)c)” func(a(b)c)
These are examples of invalid member strings: func(a”b”c) func(a,b,c) func(a(b)c) func(“abc)
If you select invalid member names from the Data Integration Wizard, it automatically adjusts the syntax to be valid before passing the name on. However, if you manually type an incorrect name, the wizard does not correct the invalid name, and an error is returned.
The following members may be valid within an application, but may behave differently: a,b,c will be treated as three members, not one named “a,b,c”.
Different styles can be mixed in a single shared pair of dimensions’ value input box, for example: a, b, c, “abc”, ”Children(a,b,c)”, iDescendants(a(b)c), “Ancestors(a(bc)”
8
Optional: Create POVs.
You can create one or more POVs but are not required to create any. That is, you can create a single POV using background POV dimensions, you can use dynamic POVs to create multiple
POVs, or you can leave the POV dimensions blank.
The Common POV area shows all dimensions not identified as shared on the previous wizard page. Dimensions from the source and destination applications are shown in separate columns.
Initially, all dimensions are in the Background POV area and the Dynamic POV area is blank. a.
Next to a dimension in the source application select the magnifying glass.
b. From the list of members select a single member.
c.
Repeat steps a and b for all other dimensions in the source application for which you want a member selected.
Note:
You can leave background POV dimensions blank if the application does not require a value for them.
d. Next to a dimension in the destination application, select the magnifying glass.
e.
From the list of members select a single member.
f.
Repeat steps d and e for all other dimensions in the destination application for which you want a member selected.
Note:
You can leave background POV dimensions blank if the application does not require a value for them.
g. Click the Dynamic POV icon next to a dimension to move the dimension from the
Background POV area to the Dynamic POV area.
h. Click Add to create a POV that is based on the static and dynamic members that you have selected.
i.
Optional:
If you want to create another POV, select a different member and click Add.
You can repeat this step by selecting different members for the dynamic POV and clicking
Add for each selection.
The numbering in the lower right corner identifies the POV, for example, POV 3 of 5. You can navigate to each POV by using the left and right arrow keys.
You can also move the dimension in the Dynamic POV area back to the Background POV area and move a different POV to the dynamic area and create another set of POVs. j.
Optional:
If you want to replace the content of any existing POV that you have access to, complete the following steps.
i.
Use the arrow keys in the lower right corner to navigate to a POV.
ii. Change the content in one of the Dynamic POV areas.
iii. Click Replace.
When the integration is run, it copies the data from the dimension member or members in the source application list to the dimension member or members in the destination application list.
9
Optional: If you want to see a list of POVs, click View All.
10 Optional: If you want to remove a POV, complete the following steps. a.
Click the left (<) or right (>) paging icon to navigate to a POV. b. Click Remove.
11
Save the integration, or cancel the changes that you made by taking one of the following actions:
●
●
Click Save to save the integration.
The Create Integration window remains open. You can make additional changes to the integration and save it again when finished.
Click Save and Close.
The integration is saved and the list of integrations is displayed. To schedule the new integration to run, see
“Scheduling Integrations” on page 237
.
Sharing Data
235
236
●
●
Click Save and Run.
The integration is saved and the page to schedule an integration to run is displayed; see
“Scheduling Integrations” on page 237 .
Click Close.
Any changes that you made since the last save are lost. Any new group that has not been saved is not created.
Note:
Case-sensitivity in integration and integration groups is handled differently depending on the relational database.
For Oracle configurations, if you save a new integration or group with a name comprised of the same characters but different case, such as "ABC" overwriting "Abc," you are prompted to overwrite the existing one. After you overwrite, two integrations are created: "Abc" with the old contents and a new integration or group named "ABC" with the new contents. In the case of non-Oracle configurations, if you try to overwrite "Abc" with "ABC", an initial message warning about overwriting is displayed. If you continue to overwrite, an exception is displayed stating that the name already exists and you are forced to select a new name.
Deleting Integrations
You can delete integrations that are no longer useful.
➤
To delete an integration:
1
Click Administration > Manage Data.
A list of integrations is displayed.
Note:
If the integration of interest is not displayed, check the Filter View Source and Destination drop-down boxes to see if the list of integrations is filtered. See
“Filtering Integration Lists” on page 228
for information about how to filter an integration list.
2
Select one or more integrations to delete.
3
Click Delete.
A delete confirmation message is displayed.
4 Click one of these options:
●
●
OK to delete the selected integration or integrations
Close to cancel the delete operation
Scheduling Integrations
You can run an integration immediately or schedule it to run at a particular date and time. You can also place an integration in a group and schedule the group to run. See
“Scheduling Group Integrations” on page 243
.
➤
To schedule an integration to run:
1
Click Administration > Manage Data.
A list of integrations and integration groups is displayed.
Note:
If the integration of interest is not displayed, check the Filter View Source and Destination drop-down boxes to see if the list of integrations is filtered. See
“Filtering Integration Lists” on page 228
for information about how to filter the integration list.
2
Select an integration to run.
Note:
You can select one integration only at a time to schedule for running.
3
Optional: If the integration is bidirectional, the source and destination application can be reversed.
Selecting an application from the Source drop-down list box and the Destination drop-down list box automatically shows the other application that will be used as the destination.
Note:
If the source and destination applications are the same, it can be confusing with a bidirectional integration to know which way the data is being moved. The first entry in the Source drop-down box
is the original, default source application.
4
Click Run.
A popup window is displayed to schedule the integration to run.
Figure 19 shows a sample Run Integration window.
F igure 19
Run Integration Window
Sharing Data
237
238
5
To run the integration immediately, click OK.
Immediately is selected by default.
6
Click Schedule for and scroll to select the month, day, and time in the drop-down list boxes to schedule the integration to run at a particular time.
7
Click one of these options:
●
OK to schedule the integration
Close to cancel the operation
●
The integration you scheduled is added to the list of scheduled integrations. For information
on viewing scheduled integrations, see “Viewing the Status of an Integration” on page 238
.
Managing Scheduled Integrations
When you schedule an integration, the integration is added to the list of scheduled integrations. The scheduled integration list includes integrations that are waiting to run
(pending), integrations that are currently running (running), integrations that have been cancelled (cancelled) and integrations that have already run (completed or failed). Integrations remain on the list until you remove them.
You can perform the following actions on integrations on the scheduled integration list:
●
●
●
●
●
View the status of a running, completed, or failed integration; see
Cancel a running integration; see
“Canceling an Integration” on page 239 .
Run a copy of an integration; see “Copying an Integration to Run” on page 239
.
Reschedule an integration; see “Rescheduling an Integration” on page 240
.
Remove an integration from the list of scheduled integrations; see “Removing an
Viewing the Status of an Integration
The scheduled integration page lists all integrations.
➤
To view all scheduled integrations, select Administration > Scheduled Integrations.
Figure 20 shows a sample Scheduled Integrations window.
F igure 20
Scheduled Integrations Window
The Status column indicates whether an integration is pending, running, completed, or failed.
➤
To view details about a completed or failed integration, click the Failed or Completed link in the Status column.
Note:
Data integrations that contain members with parentheses in the name, for example "Account1()", will fail. If this is the reason for the failure, you will see an “Unknown function name Account1" error.
Canceling an Integration
You can cancel an integration that is scheduled to run or in progress (running).
➤
To cancel an integration:
1
Click Administration > Scheduled Integrations.
2
Select an integration.
You can select a single integration only.
3
Click Cancel.
A confirmation message is displayed.
4
Click one of these options:
●
●
OK to cancel the integration
Close to cancel the operation
Copying an Integration to Run
You can schedule the same integration to run multiple times by making a copy of the integration and scheduling the copy to run.
➤
To schedule a copy of an integration to run:
1
Click Administration > Scheduled Integrations.
2
Select an integration.
You can select a single integration only.
3
Click Run Copy.
A popup window is displayed to schedule the integration to run.
4
To run the integration immediately, click OK.
Immediately is selected by default.
5
To schedule the integration to run at a particular time, click Schedule for and scroll to select the month, day, and time in the drop-down list boxes.
Sharing Data
239
240
6
Click one of these options:
●
●
OK to schedule the integration
Close to cancel the operation
The integration you scheduled is added to the list of scheduled integrations. You can schedule an integration multiple times, which results in the integration being listed multiple times on this page.
Rescheduling an Integration
You can reschedule an integration that is waiting to run to a different date or time.
➤
To reschedule an integration:
1
Click Administration > Scheduled Integrations.
2
Select an integration.
You can select a single integration only.
3
Click Run Copy.
A popup window is displayed to reschedule the integration to run.
4
To run the integration immediately, click OK.
Immediately is selected by default.
The currently scheduled month, day, and time are displayed in the Schedule for combination boxes.
5
To schedule the integration to run at a particular time, click Schedule for and scroll to select the month, day, and time in the drop-down list boxes.
6
Click one of these options:
●
●
OK to schedule the integration
Close to cancel the operation
Removing an Integration
You can remove an integration that is pending to run or one that has already run (completed or failed).
➤
To remove an integration:
1 Click Administration > Scheduled Integrations.
2
Select an integration.
You can select multiple integrations to remove.
3
Click Remove.
A confirmation message is displayed.
4
Click one of these options:
●
●
OK to remove the integration or integrations you have selected
Close to cancel the operation
Note:
In some cases, removing an integration or group that has been run and then attempting to remove it from the
Scheduled Integrations page results in a blank screen. In these cases, select the Back button in your browser and refresh your screen using either F5 or your browser's Refresh button.
Grouping Integrations
You can create groups of integrations to run at the same time. Before creating a group, you must first create individual integrations that can be added to a group; see
integrations.
➤
To create or edit an integration group:
1
Click Administration > Manage Data.
A list of integrations is displayed.
2
Take one of the following actions:
●
●
●
To create a blank new group, click New Group.
A Create Integration Group page with blank fields is displayed.
To create a new group with a list of integrations, select one or more integrations from the list of saved integrations, and click New Group.
A Create Integration Group page with populated fields is displayed.
To edit an existing group, select the group and click Edit.
A Create Integration Group page with populated fields is displayed.
Sharing Data
241
Figure 21 on page 242 shows a sample Create Integration Group window.
F igure 21
Create Integration Group Window
242
3
Type a name for the group, or change the name for an existing group.
The name must be unique among existing group and integration names.
4
Optional: Type or change comments in the notes field.
5 Click Next to go to the next page.
Note:
If you click Save or Save and Close, the group (name and notes) is saved. You can edit the group later and add integrations.
6
Select one or more integrations from Available Integrations.
You can nest an integration group within another group, therefore the list of integrations includes integration groups in addition to individual integrations. For an individual integration, the list displays the source and destination product and directory. For a group, click on the View group details link to see the integrations contained in the group.
Note:
.
7
Click Add to copy the selected integrations to Selected Integrations.
The selected integrations are copied, not moved, to Selected Integrations. You can add an integration multiple times if you want to run it more than once.
8 Optional: If you are editing an existing group, or if you add integrations that you want to remove, select one or more integrations in Selected Integrations and click Remove to remove them from the group.
You can click Remove All to remove all integrations from the group.
Integrations are run in the order that they are shown in Selected Integrations.
9 Optional: Select an integration and click the up or down arrow keys to move the integration up or down in the list to change the order in which it is run.
10
Save the group, or cancel the changes you have made by taking one of the following actions:
●
●
●
●
Click Save to save the group.
The Create Integration Group window remains open. You can make additional changes to the group and save it again when finished.
Click Save and Close.
The group is saved and the list of integrations is displayed. To schedule the new group to
run, see “Scheduling Group Integrations” on page 243
.
Click Save and Run.
The group is saved and the page to schedule a group to run is displayed; see “Scheduling
Group Integrations” on page 243
.
Click Close.
Any changes you made since the last save are lost. If it is a new group and it has not been saved yet, no group is created.
Scheduling Group Integrations
You can run an integration group immediately or schedule it to run at a particular date and time.
➤
To schedule a group to run:
Note:
If you selected Save and Run when you created the integration group, the page to run the integration group is displayed. Skip to
1
Click Administration > Manage Data.
A list of integrations and integration groups is displayed.
Note:
If the group of interest is not displayed, check the Filter View Source and Destination drop-down list boxes to see if the list of integrations is filtered. See
“Filtering Integration Lists” on page 228
for information about how to filter the integration list.
Sharing Data
243
2
Select a group to run.
Note:
You can select one group only at a time to schedule for running.
3
Click Run.
A page is displayed to schedule the group to run.
Figure 22 shows a sample Run Group
Integration window.
F igure 22
Run Group Integration Window
244
4
To run the group immediately, click OK.
Immediately is selected by default.
5
To schedule the group to run at a particular time, click Schedule for and scroll to select the month, day, and time in the drop-down list boxes.
6
Click one of these options:
●
OK to schedule the group
Close to cancel the operation
●
The group you scheduled is added to the list of scheduled integrations. For information on
viewing scheduled integrations, see “Viewing the Status of an Integration” on page 238
.
Note:
If one of the integrations within a group encounters an error while running, the entire group stops running.
Using Data Forms
C h a p t e r
11
This section describes how to create, modify, and manage data forms and the folders in which they are stored.
In This Chapter
Using Data Forms
245
About Data Forms
Data forms are spreadsheet-like grids with rows and columns for entering data through the
Web. You can create as many data forms as needed to meet the needs of different users in your organization. For example, you may create a data form for fixed assets that is used by budget preparers in the finance department, and another data form with the schedule of expense accounts that is used by line managers.
This section contains the following topics:
●
●
●
●
●
●
●
●
“Data Forms and Plan Types” on page 246
“Data Forms and Access Rights” on page 246
“Data Forms and Currencies” on page 247
“Designing a Data Form for Multiple Currencies” on page 247
“Data Forms and Versions” on page 247
“Data Forms and Attributes” on page 248
“Data Forms and Shared Members” on page 248
“Data Forms and Calculations” on page 248
Data Forms and Plan Types
When you create a data form, you assign it to a plan type. The data form contains dimension members that are valid for the plan type you select. For example, if you assign a data form to the Revenue plan type, you cannot add accounts to the data form that are not valid for the
Revenue plan type. The data entered on the data form is saved to the database for the data form’s plan type. You cannot change the plan type for a data form once it has been assigned.
On a data form, accounts whose source plan type is the plan type for the data form are editable.
You should only add an account to a data form for a plan type other than the account’s source plan type if you want the account to be read-only on that data form.
Data Forms and Access Rights
When you assign access to a data form, you control which users can access and change the data form design (for example, data form properties such as formats, layout, and instructions) and which users can access the data 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 data form designs using the Manage Data Forms task. Administrators and interactive users have access to this task. When a user designs a data form in the Web client, the selection list to set properties is filtered based on access rights. For example, when setting up the data form layout for page, column, row, and point of view, a user can select from the list of dimension members to which the user has read or write access.
246
Using Data Forms
Users enter data through the Enter Data page. All users have access to the Enter Data page.
Access to specific data forms created by administrators or interactive users is based on access rights. For example, a user having read access to a data form can see the data form listed and can select the data form for entering data. Whether users can actually change the data in the data form depends on whether they have access to its members.
When users access a data form in the Web client for data entry, their access to the rows and columns on the data form is determined by the data access rights they have been assigned to the members on the rows and columns of the data form. In order for a data form to be editable by a user, the user must have access to at least one member of each secured dimension on the data form. For example, if a user has read-only access to the Europe entity, all of the rows and columns on the data form that include the Europe entity display in a read-only format.
Data Forms and Currencies
The Currency dimension on a data form determines the currency in which the data form values display. When a row or column on a data 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 data form uses a currency member other than Local, data values are converted to the selected currency for that row or column, and the data form is read-only.
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 Data Form for Multiple Currencies
To allow users to work with currencies other than entities’ base currencies, you must also complete one of these tasks when selecting members for a data form:
●
●
To compare converted currencies in the same data form for rows and columns, select members from at least two different currencies.
To convert currencies for all the members in the data 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 business rule to view all the values in that currency.
Data Forms and Versions
For bottom up versions, rows and columns with Level 0 members allow data entry. A bottomlevel 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 in order to allow data entry on a bottom up version. Target versions allow data entry in both parent and children members.
About Data Forms
247
Data Forms and Attributes
You can use attributes to select members that share an attribute. For example, you can select the Cost Center attribute to include members on the data form that have the Cost Center attribute. Values can be entered into rows and columns that use attributes and are saved to the database.
Data 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 data form.
Values can be entered into rows or columns that display shared members and are saved to the base members in the database. You cannot select shared members as a single member on a data form. You can select a shared member only using a relationship function. Shared members are displayed the same as base members in data forms.
Data Forms and Calculations
To optimize calculations on a data form, select row members using relationships (for example,
Descendants or Children) instead of selecting children individually. If you select members individually, calculating totals for the parent of all the children could take several passes, depending on the number of levels in the hierarchy.
Understanding the Composition of a Data Form
Before you create data forms, it is important to understand the basic components of data forms, as described in the se topics:
●
●
●
“Rows and Columns” on page 249
Point of View
By selecting members for the dimensions assigned to the point of view, you determine the context for the pages, rows, and columns. For example, if the Scenario dimension is set to
Budget in the point of view, all data entered in the pages, row, and columns goes 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.
When defining the point of view, you can specify which members are visible on the data form.
displayed on the POV. See
“Managing User Variables” on page 273
.
248
Using Data Forms
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 by selecting them from the page axis.
You display member names or aliases on the page axis. You can also specify the number of members in a page dimension that enables a search facility on the page drop-down lists on the data entry page. You may want to take advantage of this feature if dimensions contain a large number of members, to make it easier for users to locate the members with which they want to work. See
“Defining the Page and POV” on page 263
.
Rows and Columns
Rows and columns define the grid into which users enter data. For example, you can assign
Unit Sales to the row axis and January to the columns axis. When users access data forms through the Web client, they can enter data into the cell where the Unit Sales row intersects with the January column.
By default, data forms have a single set of rows and columns. You can add additional sets of rows and columns to create data forms with asymmetrical combinations for members in rows and columns. See
“Creating Asymmetric Rows and Columns” on page 262 .
Managing Data Forms and Folders
The Data Form Management page lets you manage data forms and folders. You can perform the following tasks from the Data Form Management page:
Task
Create folders
Move folders
Delete folders
Create data forms
Assign access to data forms
Move data forms
Delete data forms
Topic
See
“Creating Folders” on page 250
See
See
“Deleting Folders” on page 251
See
“Creating Data Forms” on page 251
See
“Assigning Access to Data Forms” on page 271
See
“Moving Data Forms” on page 276
See
“Deleting Data Forms” on page 277
Managing Data Forms and Folders
249
To view all the data forms in a folder, click the folder’s name in the Data Form Folders area. To select all the data forms in the data forms list, select the check box at the top of the list.
Creating Folders
Folders help organize the data forms you create. You can create as many folders as needed, and you can arrange the folders in a hierarchy. For example, you can create a top-level folder called
P&L. Within the P&L folder, you can create folders named Revenue and Operating Expenses to organize P&L data forms. You can move folders within the hierarchy, and give folders the same name if they are not on the same hierarchical level.
You cannot:
●
●
●
●
●
Rename folders
Assign access rights to folders
Delete folders unless they are empty
Select multiple folders
Rename, move, or delete the top level folder called Data Forms, which contains all the folders and forms for the application
➤
To create folders:
1
Select Administration > Manage Data Forms.
2 From the Folders list on the left side of the page, select the folder under which to create the folder.
3
Above the Folders list, click Create.
4
In the text box, enter a name for the new folder.
You cannot rename a folder.
5
Click OK.
Moving Folders
When you move folders, all the data forms and nested folders within the folder are also moved.
➤
To move folders:
1
Select Administration > Manage Data Forms.
2
From the Folders list on the left side of the page, select the folder you want to move.
3
Above the Folders list, click Move.
4
From Destination Folder, select the folder to which you want to move the selected folder.
5
Click OK.
250
Using Data Forms
Deleting Folders
➤
To delete folders:
1
Select Administration > Manage Data Forms.
2
From the Folders list on the left side of the page, select the folder you want to delete.
You cannot delete a folder that contains folders or data forms.
3
Above the Folders list, click Delete.
4
When you are prompted to confirm your intention to delete the folder, click OK.
Creating Data Forms
To create data forms, you define these aspects of the data form:
●
●
●
●
●
●
●
Data form properties. See
“Setting Data Form Properties” on page 252 .
Row and column layout. See “Setting the Row and Column Layout” on page 252
.
Page and POV definition. See
and
.
Member selection. See “Selecting Members” on page 258 .
Display options. See
“Setting a Data Form’s Display Options” on page 264 .
Business rules selection and properties. See
“Selecting Business Rules” on page 268 and
“Setting Properties of Business Rules” on page 269 .
Access rights. See “Adding Access to Data Forms” on page 271
.
➤
To create data forms:
1
Perform one action:
●
●
Select Administration > Manage Data Forms.
Select File > New > Data Form.
2
From the Data Form Folders list on the left side of the page, select the folder under which you want to store the new data form.
3
From the right side of the page, click Create.
4
The Data Form Design Wizard displays and guides you through the process of creating a data form.
Creating Data Forms
251
Setting Data Form Properties
On the Properties tab, you name the data form and set its basic characteristics. You can make the data form read-only, so users cannot enter data.
➤
To set data form properties:
1
Perform one action:
●
●
Select Administration > Manage Data Forms.
Select File > New > Data Form.
2
From the Data Form Folders list on the left side of the page, select the folder containing the data form.
3
From the list of data forms on the right side of the page, select the data form whose properties you want to set, and click Edit.
4
In the Data Form text box, enter a name for the data form of up to 80 characters.
You can change the name of the data form later by updating the text in the Data Form text box.
5
Optional: In the Description text box, enter a description for the data form of up to 255 characters.
6
If the Plan Type drop-down list is displayed, select the plan type to associate with the data form.
7 Optional: To make the data form read-only, select Make data form read-only.
8
Optional: In the Enter Instructions text box, enter instructions that users can view.
9
Click Next to continue setting up the data form.
The Row/Column Layout tab is displayed. See “Setting the Row and Column Layout” on page 252 .
Setting the Row and Column Layout
On the Row/Column Layout tab, you assign dimensions to the columns and rows on the data form by selecting them from drop-down lists. For each dimension, 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, column width, and segment properties.
Segments are areas of data forms that have special properties, such as separator lines for columns and rows, and hidden or read-only data. Segments can be defined separately for rows and columns. For example, you can hide several members in a row, or give different properties to some members in a column. You can also suppress the hierarchy so row definitions are not indented and columns do not include line breaks.
Note these points when setting the row and column layout:
●
●
You must select at least one member for each dimension.
A data form must have at least one dimension assigned to the row and column axis.
252
Using Data Forms
●
●
You cannot select the same dimension for more than one axis. (You can have dimensions on more than one axis if you set user variables in the POV.)
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 dimensions and members for the column and row axis:
1
Set the form’s properties as described in “Setting Data Form Properties” on page 252
.
2
On the Row/Column Layout tab, in the Column Dimensions area, use the first 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. See “Adding Column Definitions” on page 256 .
3
Select each dimension’s members by performing an action:
●
In the Members text box, type the names.
●
Under Select, click the Select Members icon, .
See
“Selecting Members” on page 258 and
“Creating Asymmetric Rows and Columns” on page 262 .
4
Repeat the previous steps to assign more dimensions to the column axis.
5
In the Segment Properties area, select any of these options:
Table 44
Segment Properties for Data Form Columns
Option
Hide
Suppress Hierarchy
Read only
Show Separator
Apply to All Segments
Description
Hide the segment so it is not displayed on the data form
For columns, do not display line breaks
Create a read-only segment in the data form to allow comparing old, read-only data with new, editable data
Create a bold border before the segment to visually distinguish parts of the data form
Apply these settings to all columns in segments
Creating Data Forms
253
6
In the Column Properties area, select any of these options:
Table 45
Column Properties for Data Form Columns
Option
Suppress missing data
Column width
Description
Select to suppress missing data, and hide columns unless at least one cell has a data value. Deselect to display the column with
“#missing” in cells where data is missing.
●
●
●
●
●
Small—Display 7 decimal places on the data form
Medium—Display 10 decimal places on the data form
Large—Display 13 decimal places on the data form.
Size-to-Fit—Force all column headings to fit in the displayed space.
Custom—Display over 13 decimal places on the data form. You can enter a value up to 999.
7
In the Row Dimensions area, from the first Dimension drop-down list, 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. See
“Adding Row Definitions” on page 256 .
8
Perform an action to select each dimension’s members:
●
In the Member text box, type the names.
●
Click the Select Members icon, , under Select.
See
“Selecting Members” on page 258 .
For information about selecting different sets of members across the same dimension for a row,
see “Creating Asymmetric Rows and Columns” on page 262
.
9
Optional: Repeat the previous steps to assign more dimensions to the row axis.
10
In the Segment Properties area, select any of these options:
Table 46
Segment Properties for Data Form Rows
Option
Hide
Suppress Hierarchy
Read only
Show Separator
Apply to All Segments
Description
Hide the segment so it is not displayed on the data form
For rows, do not display indentation
Create a read-only segment in the data form to allow comparing old, read-only data with new, editable data
Create a bold border before the segment to visually distinguish parts of the data form
Apply these settings for rows in all segments
254
Using Data Forms
11
In the Row Properties area, select any of these options:
Table 47
Row Properties for Data Form Rows
Option Description
Suppress missing blocks
Select to aid performance of the Suppress missing data setting when suppressing a large number of rows, such as 90% or more. The Suppress missing blocks setting can degrade performance if few or no rows are suppressed. Hyperion recommends that you test data forms before and after using this setting to determine if performance is improved. You should also test data forms whenever you make significant changes to your application.
Note: With this setting, attributes may not be displayed in data forms. Also, certain suppressed blocks may have dynamic calc members ignored.
Suppress missing data
Select to suppress missing data, and hide rows without data unless at least one cell has a data value. Deselect to display rows with “#missing” in cells when data is missing. You cannot simultaneously select Suppress Missing Data and Allow Users to
Dynamically Add Rows.
Allow users to dynamically add rows
Enable users who have write access to the data form to dynamically change and refresh the data form’s definition by adding rows. Selected members to which they have access appear on the data form. You cannot simultaneously select Allow Users to Dynamically Add Rows and Suppress Missing Data.
12
Perform one action:
●
●
Click Previous to return to the previous tab.
Click Next to continue setting up the data form. The Page/Point of View tab is displayed.
See
“Defining the Page and POV” on page 263 .
Setting Column and Row Properties
As well as setting properties for rows and columns on data forms, you can set properties for individual rows and dimensions.
➤
To set properties for individual rows and columns:
1
Perform an action:
●
Select Administration > Manage Data Forms.
Select File > New > Data Form.
●
2
From the Data Form Folders list on the left side of the page, select the folder containing the data form you want to work with.
3
From the list of data forms on the right side of the page, select the data form whose layout you want to set.
4
Click Edit.
5
Fill out the Properties tab as described in
“Setting Data Form Properties” on page 252 .
6
Specify dimension members for the rows and columns as described in
.
Creating Data Forms
255
7
On the Row/Column Layout tab, to the right of the row or column dimension whose property you want to set, click the Dimension Properties icon,
.
8
Select any of these options:
Table 48
Property Options for Individual Row and Columns
Option
Display
Start expanded
Description
Select one or both options to display member name and member alias.
Select to start the member list expanded, or deselect to show the list collapsed.
9
Click Submit.
Adding Column Definitions
On the Additional Column Definition page, you can further define the member selections for a column’s dimensions. You can also create asymmetric columns. See
.
➤
To select members for dimensions in the column axis:
1
On the Additional Column Definition page, click the Select Members icon, , under Select
.
2
On the Member Selection page, select members for the dimension.
3
Click Submit.
4
Repeat this for the necessary dimensions.
5
Perform one action:
●
●
Click Submit to save your selections.
Click Return to Data Form Layout to continue designing the data form.
Use the Edit Columns button on the Row/Column Layout tab to 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 262
.
➤
To further select members for dimensions in the row axis:
1
On the Additional Row Definition page, click the Select Members icon, , under Select
.
256
Using Data Forms
2
On the Member Selection dialog box, select members for the dimension.
3
Click Submit.
4
Repeat this for the necessary dimensions.
5
Perform one action:
●
●
Click Submit to save your selections.
Click Return to Data Form Layout to continue designing the data form.
6
Click Submit.
Use the Edit Rows button on the Row/Column Layout tab to further define the row’s dimensions and members.
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 dialog box, next to the column you want to change or delete, click one of these items:
●
●
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 Data Form Layout.
Changing Row Definitions
The Edit Row Definitions dialog box 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 Data Form Layout.
Creating Data Forms
257
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.
➤
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.
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.
If the dimension contains many members, you can navigate directly to a member by searching for it. To search for a specific member in the dimension hierarchy, click the Search icon, .
In the Search text box, type part or all of the member’s name and click the Search Down icon,
, or the Search Up icon, .
2
Move members to or from the Selected Members list:
●
Click the Add icon, , to move the selected members to the right Selected Members list.
●
Click the Remove icon, , to remove the selected members from the Selected Members list.
●
●
Click the Remove All icon, , to remove all members from the Selected Members list.
When selecting members for the page, row, or column axis, you can use the Member relation drop-down list to select a range of members based on database outline relationships.
The following table describes member relationships, and the members that are included on data forms for each relationship:
Table 49
Member Relationships
Relationship
Member
Descendants
Descendants (inc)
Ancestors
Ancestors (inc)
Siblings
Members Included on the Data Form
The selected member
All descendants of the selected member, excluding the selected member
The selected member and all its descendants
All members above the selected member, excluding the selected member
The selected member and all its ancestors
All members from the same level in the hierarchy as the selected member, excluding the selected member
258
Using Data Forms
Table 49
Member Relationships (Continued)
Relationship
Siblings (inc)
Parents
Parents (inc)
Children
Children (inc)
Level 0 Descendants
Members Included on the Data Form
The selected member and all its siblings
The member in the level above the selected member
The selected member and its parent
All members in the level immediately below the selected member
The selected member and all its children
All descendants of the selected member that have no children
Members chosen using the Relation drop-down list are displayed in their unexpanded state.
You can also select attribute values to associate with the selected members from the Attributes section. Select the check box next to the Attributes title to select all attributes. See
Attribute Values as Members” on page 259 .
3 Click Submit.
Notes for Administrators:
●
●
●
●
●
You can change users’ access to a dimension member to display different members in data forms after plans are refreshed.
The order of members in the Selected Members list determines the order on the data form.
To change the order of members, select a member and then click the up or down arrow in the Selected Members title bar. Use the scroll bar on the right to view long member lists or the horizontal scroll bar at the bottom to see members that have long names or are nested.
To define different sets of members for a dimension, see “Creating Asymmetric Rows and
.
To select members that are attribute values, see
“Selecting Attribute Values as Members” on page 259 .
To create data forms that can display account annotations, see
Display Options” on page 264 .
Selecting Attribute Values as Members
When selecting members for a data 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, 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.
Creating Data Forms
259
●
●
●
●
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 form in which attribute values are selected as members shows the attribute name as well as the base dimension member names and/or aliases.
Selecting Substitution Variables as Members
Substitution variables act as global placeholders for information that changes regularly. Each variable has a value assigned to it that can be set and changed centrally on the Analytic Services server at any time. Substitution variables are especially useful when you are developing and reporting on rolling forecasts. When you select substitution variables as members on the data form, the values for those members are based on information that is dynamically generated.
For example, you could set the current month member to the substitution variable
CurMnth
so that when the month changes, you do not have to update the month value manually in the data form or the report script.
Keep these points in mind when using substitution variables:
●
●
●
When you open or calculate values in a data form, Analytic Services replaces the substitution variable with the value assigned to it. By default, each substitution variable is retrieved and cached from the Analytic Services server every five minutes. You can change the retrieval interval by setting a new value for the
SUBST_VAR_CACHE_LIFETIME
property in the
HspJSHome.properties file; the default value is 300 seconds, or five minutes. (For more information on the
HspJSHome.properties
file, see
“Creating the Properties File” on page 43
and
“Default Location of the Properties File” on page 45
.)
You create and assign values to substitution variables using Essbase Administration Services for Essbase 7/Analytic Administration Services for Analytic Services 9.2 or ESSCMD. These substitution variables are then available in Planning when you select members for a Web data form. For rules on setting substitution variables names and values, see the Hyperion
System 9 BI+ Analytic Services Database Administrator’s Guide.
A substitution variable must be appropriate for the context in the data form. For example, you could select a substitution variable named
CurrQtr
with a value of Qtr2 as a member of the Time Period dimension. However, it is not valid to select a substitution variable named
CurrYr
for the Year dimension if its value is Feb. You can set substitution variables on the Analytic Services server, application, or database level. The same substitution variable can exist on multiple levels; Planning uses the first one it finds as it searches for them in this order: database, then application, then server.
260
Using Data Forms
●
●
Planning checks the validity of substitution variables not when you design the data form but when the substitution variables are actually used (for example, when the data form is opened). Therefore, test substitution variables by saving the data form and then opening it.
For information on errors generated when substitution variables are calculated, you can check several logs. See the Analytic Services server log for information on attempts to use a substitution variable that is no longer contained in Analytic Services. See the Planning log for information on substitution variables that are not valid in the data form.
➤
To specify substitution variables in data forms:
1
Set up the data form as described in the
“Creating Data Forms” on page 251
.
2
On the Member Selection dialog box, select substitution variables in the same way that you select members: by using the right arrow, left arrow, and double left arrows to move substitution variables to and from the Selected Members list.
Listed substitution variables also show their current associated value. For example, the substitution variable
CurrentScenario might display a value as follows:
CurrentScenario=Actual
When selected, a substitution variable is preceded by an ampersand. For example:
&CurrentScenario
3
Click Submit.
Selecting User Variables as Members
User variables act as filters in data forms, enabling planners to focus only on the members they are interested in, such as departments in a particular division. Before you can associate a user variable with a data form, you must create the user variable. For information on creating user
variables, see “Managing User Variables” on page 273 .
When you set up a data form with a user variable, planners must select a value for the variable before opening the data form. For example, if you create a user variable called Division, planners must select a division before working in the data form. The first time planners select a variable for a data form, they must do so in preferences. After that, they can change the variable in the data form or in preferences.
➤
To select user variables for data forms:
1
Set up the data form as described in the
“Creating Data Forms” on page 251
.
2
On the Member Selection dialog box, select a user variable in the same way that you select members: by using the right arrow, left arrow, and double left arrows to move user variables to and from the Selected
Members list.
The user variables list displays all the user variables that you have set up for the current dimension. For example, the available user variable for the Entity dimension might display as follows:
Division = [User Variable]
Creating Data Forms
261
When selected, a user variable is preceded by an ampersand. For example:
Idescendants(&Division)
3
Click Submit.
Before opening the data form, planners must select a value for the user variable in preferences.
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
➤
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 Select Members icon, , under Select
.
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
Perform one action:
●
●
Click Submit to save your selections.
Click Return to Data Form Layout to continue designing the data form.
You can set up data forms that allow users to dynamically change the data form’s definition by creating additional rows with members, as needed.
Enabling Users to Dynamically Add Rows
You can set up data forms that allow users to dynamically change the data form’s definition by creating additional rows with members, as needed. Users with write access to the data form can add rows to change the data form on the Enter Data page, if that option is enabled. For
information on enabling this option, see step 5
in the topic “Setting the Row and Column
For example, some users budget for next year based on the current year’s actual data. They want to see money spent for a given account or use historical trends to build a new plan. Yet they also need to add rows to data forms to budget for new items with new dimension members.
262
Using Data Forms
Defining the Page and POV
On the Page/Point of View Layout tab, you can select dimensions and members for the page axis, select to display member names or aliases, and choose to make them visible or not on data forms. You can also define the POV dimensions and members for any dimensions that are valid for the data form’s plan type and not assigned to a page, column, or row axis. The POV lets you set the unique set of dimension members that define specific intersections of data.
When you set user variables for data forms, the variable name is displayed on the POV toolbar.
See
“Managing User Variables” on page 273
.
➤
To define the page axis and POV:
1
In the Page Dimensions area, from the first Dimension 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 Select Members icon, , under Select.
For more information about selecting members, see
“Selecting Members” on page 258
.
Tip:
You can specify the number of members in a page dimension that enables a search facility on the page drop-down lists on the data entry page. You may want to take advantage of this feature if dimensions contain a large number of members, to make it easier for users to locate the members they want to work with. You set this option by selecting File > Preferences > Display
Options tab. Under the Page Selection Options, enter a value in the Allow Search When
Number of Pages Exceeds option. See the Hyperion System 9 Planning User’s Guide or Web help system.
3
Repeat the previous 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. By selecting File > Preferences > Display Options tab, users can also specify whether 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.
5
In the Point of View Dimensions area, select each dimension’s member by doing one of the following:
●
In the Member text box, type the name.
●
Click the Select Members icon, , under Select.
For more information about selecting members, see
“Selecting Members” on page 258
.
6
Select the Visible check box to make the dimension member name or alias visible on the data form.
If Visible is not selected, the member name or alias does not appear on the data form. Hiding point of view dimension members that are irrelevant to users can make a data form easier to use. For example, a user-defined dimension such as Employee may be meaningful on a headcount hiring data form, but irrelevant on a data form to plan capital spending.
Creating Data Forms
263
7
Select or deselect the Member Name and Alias options to display the member name or member alias.
8
Save the data form by performing one action:
●
●
●
●
Click Save to save the data form and return to the Data Form Management page.
Click Save As to save the current data form definition and settings under a new name. The previous data form remains intact.
Click Previous to return to the previous tab.
Click Next to continue setting up the data form.
Setting a Data Form’s Display Options
On the Other Options tab, you can set options for the data form’s display, functionality, and printing. You can control the precision of data by applying minimum and maximum values for different account types. For example, you can truncate and round the decimal portion of longer numbers.
You can also enable Smart Lists and account-level annotations. Users can add annotations to accounts in data forms if they have write access to the account, entity, scenario, and version members. Account level annotations can vary by different combinations of Scenario, Version, and Entity dimensions. Note these guidelines when enabling users to add annotations to accounts:
●
●
●
●
The Account dimension must be assigned to a row axis.
Account, Entity, Versions, and Scenario dimensions cannot be assigned to the column axis.
The Entity dimension can be assigned to either the row, page, or POV axis.
Version and Scenario dimensions must be assigned to either the page or POV axis.
➤
To set display options for data forms:
1
In the Precision area, select options to set the number of decimal positions that are displayed for Currency
Values, Non-Currency Values, and Percentage Values.
Specify Minimum values to add zeros to numbers with a small number of decimals. Specify
Maximum values to truncate and round the decimal portion of longer numbers. For example:
Table 50
Data Precision Examples
Actual Value
100
100
100.12345
100.12345
100.12345
100.12345
Minimum Precision
0
3
Any number <=5
7
Any number <=5
0
Maximum Precision
Any
Any
None
None
3
0
Displayed Value
100
100.000
100.12345
100.1234500
100.123
100
264
Using Data Forms
Table 50
Data Precision Examples (Continued)
Actual Value
100.12345
100
Minimum Precision
2
2
Maximum Precision
4
4
Displayed Value
100.1234
100.00
2
In the Display Properties area, select the appropriate check boxes to enable the following features:
●
●
●
●
Display missing values as blank—Leave data form cells empty where data does not exist. If
this option is not selected, empty cells display the text “#missing.” (See “Displaying
#Missing with Smart Lists” on page 331
.)
Enable account annotations —Enable users to add annotations of up to 1500 characters to accounts during data entry (displays if the data form meets the criteria listed above for enabling account level annotations).
Allow multiple currencies per entity—If the application supports multiple currencies, this option allows entities to support multiple currencies, regardless of their base currency.
Users can select the currency for displayed cell values in a data form on the fly.
Enable Smart Lists—Enable Smart Lists to display on the data form (see “Working with
).
3
In the Printing Options area, set your preferences for how the information in the data form is displayed:
Table 51
Printing Options
Option
Page Size
Orientation
Font
Font size
Percentage of page to use for row headers
Number of data columns per page
Explanation
Select the printed page size for the data form: A3, A4, Ledger, Legal, Letter, or
11"X17". The default is A4.
Select the PDF display orientation:
Portrait—Vertical
Landscape—Horizontal
Select from the 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
.
Type a number from 1 to 26 to set the font size for the information displayed in the
PDF file.
Type a number from 1 to 99 to set the 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 data and column headers. The default value is 35.
If rows or columns do not fit on a page, type the number of columns to display on each page.
Creating Data Forms
265
Table 51
Printing Options (Continued)
Option
Include supporting detail
Show shading
Explanation
Select to include supporting detail as extra rows in PDF files. Select a value from the list to specify how the supporting detail is displayed:
Normal Order—Prints supporting detail in the same order it appears on the
Supporting Detail page, after the member it is associated with.
Reverse Order—Prints supporting detail in reverse order, before the member associated with it. Supporting detail for children appears above their parents, and the order of siblings is preserved.
Format data
Apply precision
Select to apply number format settings from the data form to the displayed data.
Select to apply the data form’s precision settings (desired number of decimal points) to the data that is displayed in PDF files.
If you consistently have more rows or columns than will fit on one page, select to repeat the headers on all displayed pages.
Repeat headers on all pages
Show account annotations If the data form designer enabled account annotations for the data form, select to display account annotations in PDF files.
Show cell text Select to display text notes associated with individual or groups of cells.
Show attribute members
Show currency codes
If attribute members are selected in the data form, select to display them in PDF files.
If the data form supports multiple currencies, select to display the currency codes of values in PDF files.
Select to display rows with shading.
4
From Available Menus, select which menus to associate with the data form by moving them to Selected
Menus:
●
moves the selected menus
●
moves all menus
● removes the selected menus
●
removes all menus
5
If you select multiple menus, set the order in which they are displayed by clicking or .
Multiple menus are displayed sequentially, with separators between them.
6
Click Save.
266
Using Data Forms
Adding Fonts
By default, Planning supports a number of built-in (type-1) fonts for printing data 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 Planning applications on the application server can access the added fonts.
➤
To add fonts that are available for printing data forms:
1
Open the Planning properties file (
HspJSHome.properties)
.
If this file does not exist, see “Creating the Properties File” on page 43
for instructions on
creating the properties file. For information on locating the properties file, see “Default
Location of the Properties File” on page 45 .
2
Add an entry to the properties file, 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.
Here is an example (ignore the line breaks):
PDF_FONT_FILE=c:\\winnt\\fonts\\comic.ttf,c:\\winnt\\fonts\\msgothic.tt
c, 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 Business Rules, which is a module of Analytic
Administration Services. Business rules can reside directly in the Business Rules repository, or can be exported to Analytic Services as calculation scripts. They can be launched directly from
Planning Web or associated with Web data forms. All users, including data form designers and planners, can see and launch only business rules to which they have access.
In 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 System 9 Business Rules Administrator’s Guide and the Hyperion System 9 Business Rules User’s Guide.
Using runtime prompts, see “Using Runtime Prompts” on page 270
.
Note these points when working with business rules:
●
Data that behaves as a rate (for example, prices and percentage data types) should be backcalculated for Summary Time Periods (for example, Quarters) using business rules.
Using Business Rules
267
●
●
To avoid prolonged calculation times, exclude Dynamic Calc members from business rules.
In the Business Rules Copy Data Action Component, shared members are displayed the same as base members, and are not distinguished in the entities tree for member selection.
Selecting Business Rules
On the Business Rules tab, you can associate one or more business rules to which you have access with a data form, by plan type. This lets users launch any or all of the associated business rules from the data form to allocate and calculate values. You can also set whether each business rule that is associated with a data form automatically launches when the Save button is clicked during data entry.
➤
To select business rules for the data form:
1
Perform one action:
●
●
Select Administration > Manage Data Forms.
Select File > New > Data Form.
2
From the Data Form Folders list on the left side of the page, select the folder containing the data form.
3
From the list of data forms on the right side of the page, select the data form for which you want to select business rules.
4
Click Edit.
5
Fill out the Properties tab, as described in
“Setting Data Form Properties” on page 252
.
6
On the Row/Column Layout tab, specify the dimensions and members for rows and columns, as described in
“Setting the Row and Column Layout” on page 252
.
7
On the Page/Point of View Layout tab, specify the dimensions and members for the page axis in the data
form, as described in “Defining the Page and POV” on page 263
.
8
9
On the Business Rules tab, from the Plan Type drop-down list, select the plan type.
10
From the Business Rules list, select the business rules you want to associate with the data form.
11
Move the business rules to 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 Data Form and Calculate Currencies business rules are selected. The Calculate Data
Form business rule is automatically created for each data form to calculate subtotals. The Calculate Currencies business rule is created for data forms that include multiple currencies in a row, column, or page, to enable converting values among the available currencies. You can deselect the Calculate Currencies business rule if you use a customized calc script to calculate currency conversions. You can also deselect the Calculate Data Form business rule; if you do, planners cannot calculate data in the data form.
268
Using Data Forms
12
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 the Calculate Data Form and the Calculate Currencies business rules, it is important that the currency conversions be run first, before subtotaling.
13
To set properties for the business rules, click Properties.
See
“Setting Properties of Business Rules” on page 269
.
14
Perform one action:
●
●
●
●
Click Save to save the data form and return to the Data Form Management page.
Click Save As to save the current data form definition and settings under a new name. The previous data form remains intact.
Click Previous to return to the previous tab.
Click Next to continue setting up the data form.
Note:
When you open a data form, all business rules associated with the data form are displayed regardless of access rights. You can reposition or remove these business rules. When adding business rules to data forms, you can select only business rules to which you have access.
Setting Properties of Business Rules
On the Business Rule Properties dialog box, you can set whether each business rule that is associated with a data form automatically launches when Save is clicked during data entry. If a business rule has runtime prompts, you can also set whether the default member selection on the runtime 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 data form. See
“Creating Data Forms” on page 251 .
➤
To set up properties for a business rule:
1
On the Business Rule Properties dialog box, select the Run on Save check box next to the business rules you want to run automatically during save operations.
If a business rule contains a runtime prompt, before the rule is saved, the user is prompted to enter the runtime prompt.
The business rule Calculate Data Form is programmatically created for each data form to calculate subtotals. The Calculate Currencies business rule is created for data forms that include multiple currencies to enable the conversion of values among the available currencies.
2
Optional: If a business rule has runtime prompts and you want the default member selection on the runtime prompt window to match the current member selection in the page and POV axes of the open data form, select Use Members on Data Form.
Using Business Rules
269
Note:
The Use Members on Data Form option is available only for business rules that have runtime prompts. This option is most effective when used by runtime prompts that use a dimension only once. To pass the member selection on the data form into the runtime prompt, you must also select Remember the Last Page Selected, accessed by selecting File > Preferences > Display Options tab.
3
Optional: If you want to hide the runtime prompt value from the user, select the Hide Prompt check box.
This feature is only enabled if you have selected the Use Members on Data Form check box preceding it.
You can hide runtime prompts if they meet this criteria:
●
●
All runtime prompt member values are filled in (appropriate dimension members can be read from the data form)
No dimensions are repeated in the runtime prompt
For additional information, see the Hyperion System 9 Business Rules Administrator’s Guide.
4
Click OK.
Using Runtime Prompts
In Business Rules, administrators and interactive users can create business rules that, when launched from Planning, prompt users for such variables as members, text, or numbers.
Prompts should be specific and tell users what type of data is expected, as in these examples:
●
●
●
●
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?
Note:
When launching a business rule with a runtime prompt, Planning validates the value entered, but it does not validate the business rule.
To set the default member selection in a runtime prompt, see
“Setting Properties of Business
.
Previewing Data Forms
While you are designing or changing data forms you can preview the structure to view the dimensions that are assigned to the POV, columns, rows, and page axes. Previewing does not display data associated with data forms.
➤
To preview a data form’s design, select the Preview tab.
Note:
Member attributes and aliases are not displayed in Data Form Preview.
270
Using Data Forms
Assigning Access to Data Forms
By assigning access to data forms, administrators and interactive users determine:
●
●
Administrators and interactive users who can view and change various data form designs.
By default, administrators have write access to all data forms for design modifications.
Interactive users have write access to certain data forms based on access rights.
Users who can access the data forms for view or data input. By default, administrators have write access to all data forms. Interactive users and planners have access to data forms based on access rights. Whether users have access to the data in the data form depends on whether they have access to its members.
Adding Access to Data Forms
➤
To assign access to data forms:
1
Perform one action:
●
●
Select Administration > Manage Data Forms.
Select File > New > Data Form.
2
From the Data Form Folders list on the left side of the page, select the folder containing the data form for which you want to assign access.
3
From the list of data forms on the right side of the page, select the data form for which you want to assign access.
Note:
Access rights are assigned to data forms, not to folders. You can assign access to one data form at a time.
4
Click Assign Access.
5 Click Add Access and select the users or groups you want to have access to the data form.
6
Optional: To get the latest set of users and groups from the User Management Console, click Refresh
Users and Groups.
7 In the Type of Access box, select the kind of access you want the selected users or groups to have to the data form:
●
●
●
Read—User can view the data form and enter data
Write—Users can change the data form design, view the data form, and enter data
None—Users cannot view the data form
8
Click Add.
9
Click Close.
Assigning Access to Data Forms
271
Changing Access to a Data Form
➤
To change which users can use a data form or change the data form’s design:
1
Perform one action:
●
●
Select Administration > Manage Data Forms.
Select File > New > Data Form.
2
From the Data Form Folders list on the left side of the page, select the folder containing the data form for which you want to assign access.
3
From the list of data forms on the right side of the page, select the data form for which you want to change access.
Note:
Access rights are assigned to data forms, not to folders. You can change access to only one data form at a time.
4
Click Assign Access.
5 Select the users or groups for which you want to change the access assignment and click Edit Access.
6
Optional: To get the latest set of users and groups from the User Management Console, click Refresh
User/Group Lists.
7 In the Type of Access box, select the kind of access you want the selected users or groups to have to the data form:
●
●
●
Read—User can see the data form and enter data
Write—Users can change the data form design, see the data form, and enter data
None—Users cannot see the data form
8
Click Set.
9
Click Close.
➤
To remove access from data forms:
1 Perform one action:
●
Select Administration > Manage Data Forms.
Select File > New > Data Form.
●
2
From the Data Form Folders list on the left side of the page, select the folder containing the data form for which you want to remove access.
3
From the list of data forms on the right side of the page, select the data form for which you want to remove access.
Note:
Access rights are assigned to data forms, not to folders. You can remove access to only one data form at a time.
4
Click Assign Access.
272
Using Data Forms
5
Select the users or groups for which you want to remove the access assignment and click Remove Access.
6
When you are prompted to confirm your intention to remove access, click OK.
Managing User Variables
You can set user variables to limit the number of dimension members that display on a data form. This can increase performance by helping planners focus on certain members. For example, if you set up a data form with a user variable called Division for the Entity dimension, planners can select a member for their own division. You can set up as many user variables as you want for each dimension. You can select user variables for any axis in the data form: row, column, page, or POV.
When you set up a user variable for a data form, users cannot open the data form until they select a value for the variable in preferences. After users select an initial value, they can change it at any time, either directly in the data form or in preferences. On data forms, user variables
are displayed on the POV. See “Defining the Page and POV” on page 263
.
Here is the typical sequence of steps in setting up and using user variables:
1. If necessary, create the appropriate parent-level members in the dimension outline.
For example, the parent levels could correspond to business unit divisions.
2. Define user variables for each dimension you want planners to be able to filter.
See
“Selecting User Variables” on page 273 .
3. When designing the data form, associate the user variable with the data form.
See
“Selecting User Variables as Members” on page 261
.
4. Instruct planners to select a member for the user variable associated with the data form.
Before planners can open data forms that have user variables, they must select a member for the variable in preferences (by selecting File > Preferences > User Variable Options).
See the Hyperion System 9 Planning User’s Guide or user’s help system.
Selecting User Variables
➤
To select user variables:
1
Perform one action:
●
●
Select Administration > Manage User Variables.
Select File > New > User Variable.
2 Click Add.
3
On the Select User Variable page, for Dimension Name, select the dimension for which you want to create a user variable.
4 For User Variable Name, type the name of the new user variable.
5
Click OK.
Assigning Access to Data Forms
273
You can now associate the new user variable with a data form. See “Selecting User Variables as
Members” on page 261 . After that, planners can select members for the user variable to focus
the data form on certain members. See the Hyperion System 9 Planning User’s Guide or user’s help system.
Deleting User Variables
➤
To delete user variables:
1 Perform one action:
●
●
Select Administration > Manage User Variables.
Select File > New > User Variable.
2
Select the user variable you want to delete.
3 Click Delete.
4
When asked to confirm your intention to delete the user variable, click OK.
Printing Data Form Definitions
Administrators can print data form definition reports to assist with managing data forms.
Reports can include information on dimension members, business rules, access rights associated with data forms, and other standard data form components.
➤
To create and print data form definition reports:
1
Perform one action:
●
●
Select Administration > Reporting.
Select File > New > Report.
2
Select the Data Forms tab.
The Available Data Forms area displays all data forms in all folders in the application.
3
Select the data forms whose definitions you want to print by taking one or more of the following actions:
●
To move data forms to the Selected Data Forms area, select them and click .
●
To move all data forms to the Selected Data Forms area, click .
●
To move data forms from the Selected Data Forms area, select them and click .
●
To move all data forms to the Available Data Forms area, click .
Tip:
You can also click and drag to select multiple data forms.
274
Using Data Forms
4
Optional: Select Include Member Selection List to include column and row dimension members on the report. This is selected by default.
5
Optional: Select Include Business Rules to include a list of business rules that are associated with the data form. This is deselected by default.
6
Click Create Report.
Adobe Acrobat generates a consolidated report with information about the selected data forms:
●
●
Plan type
Description
●
●
●
●
●
Column dimension, column members, if selected, and any additional column definitions
Row dimension, row members, if selected, and any additional row definitions
Page and Point of View dimensions
Access rights assigned to the data form
Business rules associated with the data form, if selected
7
To print the report, click Print on the Adobe Acrobat toolbar.
Searching for Data Forms
To quickly navigate to a specific data form, you can search for and automatically select data forms in a folder.
➤
To search for data forms:
1
Perform one action:
●
Select Administration > Manage Data Forms.
Select File > New > Data Form.
●
2
On the Data Form Management page, in the Search text box, enter the name or part of the name of the data form that you want to find and select.
Ignoring capitalization, Search finds the next occurrence of a match.
3
Click to search forward (down) from the cursor position or to search backwards (up) from the cursor location.
Searching for Data Forms
275
Modifying Data Forms
➤
To modify data forms:
1
Perform one action:
●
●
Select Administration > Manage Data Forms.
Select File > New > Data Form.
2
From the Data Form Folders list on the left side of the Data Form Management page, select the folder where the data form you want to modify is stored.
3
From the Data Forms list on the right, select the data form you want to modify.
4
Click Edit.
5
Make the necessary changes to the data form. See:
●
●
●
●
●
●
●
“Setting Data Form Properties” on page 252
“Setting the Row and Column Layout” on page 252
“Defining the Page and POV” on page 263
“Selecting Members” on page 258
“Setting a Data Form’s Display Options” on page 264
“Selecting Business Rules” on page 268
“Changing Access to a Data Form” on page 272
Moving Data Forms
➤
To move data forms:
1
Perform one action:
●
●
Select Administration > Manage Data Forms.
Select File > New > Data Form.
2
From the Data Form Folders list on the left side of the page, select the folder where the data form you want to move is stored.
3
From the Data Forms list on the right side of the page, select the data form you want to move.
Note:
You can move multiple data forms at once if they are in the same folder.
4
From the right side of the page, click Move.
5 From the drop-down list, select the destination folder.
6
Click OK.
276
Using Data Forms
Deleting Data Forms
➤
To delete data forms:
1
Perform one action:
●
●
Select Administration > Manage Data Forms.
Select File > New > Data Form.
2
From the Data Form Folders list on the left side of the page, select the folder where the data form you want to delete is stored.
3
From the Data Forms list on the right side of the page, select the data form you want to delete.
4
From the right side of the page, click Delete.
5
When you are prompted to confirm your intention to delete the data form, click OK.
Importing Data Form Definitions
Planning includes a utility called
ImportFormDefinition
that imports a data form definition from a text-based file into a data form in a Planning application. You can specify whether to import the rows, the columns, or both, for the data form.
Note:
This utility loads the form definition, not the data for the form.
Using the
ImportFormDefinition
utility provides an efficient method of importing row and column definitions from a data source that is sparsely populated. Planning imports only the rows or columns that contain data to the data form definition.
The
ImportFormDefinition
utility is available only for use on Windows-based systems. If you installed Planning on a UNIX system, you can run the utility on the Windows-based system on which you installed Planning Desktop.
To import a data form, you perform these general steps:
1. Prepare the data form for importing. See
“Preparing the Data Form” on page 277 .
2. Prepare the data file. See “Preparing the Data File” on page 278
.
3. Run the utility to import the data form definition. See
“ImportFormDefinition Examples” on page 280 .
Preparing the Data Form
Before you import rows and columns for the data form definition, you must set up the data form in your Planning application.
Importing Data Form Definitions
277
Prepare your data form as usual and set up dimensions on the row, column, page and POV, depending on your requirements. For example, in most cases you would define the layout of the columns when you define the data form and use the ImportFormDefinition options to import only the rows.
Note:
The resulting data form looks like the data form definition, not the way the data is structured in the data file.
The rows that are imported from the data file to the data form definition are filtered based on the members you specify on the data form and the import options you specify. It is important to define the members on each axis of the data form appropriately, and define the import options you want, as this affects which data is imported. Examples are discussed in
“ImportFormDefinition Examples” on page 280
.
Preparing the Data File
The
ImportFormDefinition
utility imports data from a text-based file that is in Analytic
Services Column Export Format. You can generate this format directly, or if you already have a method for loading data into Analytic Services, you can load the data and then generate the file.
To create an Analytic Services Column Export Format file using Analytic Services, useEssbase
Administration Services for Essbase 7/Analytic Administration Services for Analytic Services
9.2 and select Database > Export. Specify the Server File Name, and select Export in Column
Format. (Hyperion recommends that you also select Level 0 Data.) You do not have to modify the file in any way after you export it from Analytic Services.
If you generate the file yourself, it must meet these requirements:
●
●
●
●
●
●
The first line of the file represents the column of the data file. It must be a list of members from a single dimension.
Each line after the first line must include a member from every dimension other than the one representing the column, followed by data.
Member names must be enclosed in double quotation marks.
The delimiter must be a space.
Data must not be enclosed in double quotation marks.
Data cells that are blank must include #Mi.
Note:
The layout of the data form, not the format of the data file, determines how the resulting data form appears. You can use the same data file to load many different data forms because the data file represents what appears in the data form, not where it appears.
278
Using Data Forms
Importing the Data Form Definition
Planning includes the
ImportFormDefinition
utility, a batch file that sets up your system classpath and runs a Java-based utility. This batch file runs only on a Windows-based system.
(You can run it on a Windows-based system even if your application servers are UNIX based.)
During installation, the Setup program installs
ImportFormDefinition.bat
in the Utils directory. If you installed Planning to the default location, the
Utils
directory is located in the following path:
<drive letter>:\Hyperion\HyperionPlanning\Utils
.
➤
To run the ImportFormDefinition utility:
1
Copy the HspJShome.properties file from your application server directory into the Utils directory.
For information on locating the properties file, see
“Default Location of the Properties File” on page 45 .
2
Launch the ImportFormDefinition utility from the Utils directory, using this syntax:
ImportFormDefinition
/A:appname /U:username /P:password /F:formname
/D:filename [/AR] [/AC] [/SR] [/SC] [/KC] [/KR]
Table 52
ImportFormDefinition Utility Parameters
Switch
/A
/U
/P
/F
/D
/AR
/AC
/KC
Purpose Required?
Yes
Specify the name of the Planning application.
Specify the Planning administrator user name.
Yes
Specify the Planning administrator password.
Yes
Specify the Planning data form name.
Yes
Specify the name and location of the Analytic Services Column Export format data file. The location could be the full path and file name, or any format required for the operating system to find the file. For example, on a Windowsbased system, you can specify an FTP site.
Yes
Add the rows found in data file. This option is on by default. You can disable adding rows by specifying /-AR. For example, in some cases you might want to define the rows in Planning and import only the column definition from the data file.
No
Add columns found in data file. This option is on by default. You can disable adding columns by specifying /-AC. For example, in most cases you would want to define the columns in Planning and import only the row definition from the text file.
No
Keep the existing member selections for the columns in the data form. This option is on by default. You can instead clear existing columns by specifying
/-KC.
Data forms must have at least one column definition. If you clear columns but do not add them, the data form is not saved and an error is displayed.
No
Importing Data Form Definitions
279
Table 52
ImportFormDefinition Utility Parameters (Continued)
Switch
/KR
/SR
/SC
Purpose Required?
Keep the existing member selections for the rows in the data form. This option is on by default. You can instead clear existing member selections in rows by specifying /-KR.Note: A data form must have at least one row definition, so if you clear rows, but do not add them, then the data form will fail to save, and you will get an error.
No
Sort rows in the data form. This option is on by default. You can disable sorting rows by specifying /-SR.
Sort columns in the data form. This option is on by default. You can disable sorting columns by specifying /-SC.
No
No
For example, you can enter this syntax:
ImportFormDefinition /A:MyPlan /U:Admin /P:password /F:
"My Budget" /D:exportfilename /AR /-AC
The
ImportFormDefinition
utility displays progress messages. Creating the data form could take some time, depending on the amount of data in the file.
The
ImportFormDefinition
utility imports the definition to the Planning data form, ensuring that all the cells that have data in the data file are represented on the data form. Cells in the data file that contain #Missing do not cause rows or columns to be added to the data form.
Note these points when importing data form definitions:
●
●
●
If you disable importing rows or columns, the
ImportFormDefinition
utility filters the imported data by any rows or columns defined on the data form.
If you run the
ImportFormDefinition
utility more than once, it merges the new results with the existing data form definition.
If you run the
ImportFormDefinition
utility more than once and you specify sorting, it sorts new and existing rows or columns by dimension order.
ImportFormDefinition Examples
It is important to define the members on each axis of the data form appropriately, and define the import options you want, as this affects which data is imported. If you want to only import rows that contain data for the specified columns, use the following procedure:
280
Using Data Forms
1. In Planning, specify the columns you want on the data form design. For example, you might specify Descendants Inclusive of YearTotal on the Column.
2. For the dimension for which you want to import members to the row, add the dimension root to the data form design. For example, to load accounts on the row, place the root of the Account dimension on the row of the data form design.
3. When you run the ImportFormDefinition utility, use the following options: /AR /-AC
The ImportFormDefinition utility loads accounts from the data file if the members from each dimension that make up that cell match the members on the data form columns, pages, and
POV.
The added rows are filtered by members on the page. For example, if you place some members on the page, only accounts that contain data for those members are added to the data form.
Rows are filtered by the members on the POV. For example, if the data file contains data for the salary account for 2004, but only 2005 is on the POV, that salary account is not added to the row even though it exists in the data file.
Importing and Exporting Data Forms
Planning includes a utility called
FormDefUtil.cmd
that exports and imports a Web data form definition to and from an XML-based file. This utility enables you to move data form definitions from one Planning application to another. You might want to use this if you are moving from a development environment to a production environment.
Planning includes the
FormDefUtil.cmd
utility for use through a command line interface.
Planning installs this utility in the
Utils
directory. If you installed Planning to the default location, the
Utils
directory is located in the following path:
<driveletter>:\Hyperion\HyperionPlanning\Utils
. Only administrators can run this utility.
This utility runs only on a Windows-based system. You can run it on a Windows-based system even if your application servers are UNIX based.
➤
To run the
FormDefUtil.cmd
utility, launch the
FormDefUtil.cmd
utility from the
\Utils directory, using this syntax:
formdefutil
<import|export> <filename|formname|-all>
<server name> <user name> <password> <application>
Parameter/Switch
<import|export>
<filename|formname|all>
Purpose
Specifies whether to import or export the data form definition.
When used with import, specifies the name of the XML file that contains the data form definition. When used with export, specifies the name of the Planning data form that you want to export to XML.
Use -all with import or export to import or export all the XML files or data form definitions in the current application.
Required?
Yes
Yes.
-all is optional.
Importing and Exporting Data Forms
281
Parameter/Switch
<server name>
<user name>
<password>
<application>
Purpose
Specifies the server name on which the Planning application resides.
Required?
Yes
Specifies the name of the Planning administrator.
Yes
Specifies the Planning administrator password.
Yes
When used with export, specifies the name of the Planning application that contains the data form definitions to export. When used with import, specifies the name of the Planning application to which you want to import the data form definition.
Yes
When you export a data form definition, the utility creates an XML file in the current directory. It also logs errors in a file named
FormDefUtil.log, which is saved in the directory from which you run the utility. This directory is by default \Utils .
Tip:
You can copy the utility to any directory and launch it from there to save files to a directory other than
\Utils
.
For example:
●
●
●
●
To import a single file: c:>FormDefUtil.cmd import
“ c:\Hyperion\ Planning\Utils\ form1.xml
“
localhost admin password APPSQL33
To export a single file: c:>FormDefUtil.cmd export Form1 localhost admin password APPSQL33
To export all data form definitions: c:>FormDefUtil.cmd export -all localhost admin password APPSQL33
To import all data form definitions: c:>FormDefUtil.cmd import -all localhost admin password APPSQL33
282
Using Data Forms
C h a p t e r
12
Managing the Budgeting Process
This section describes the concept of a planning unit and its life cycle through the budgeting and review processes. It also describes how to manage task lists and copy data to help guide users through the planning process.
In This Chapter
Managing the Budgeting Process
283
About the Budgeting Process
●
●
●
●
●
●
The 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. 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
●
●
●
●
●
This section contains the following topics:
“Starting the Review Process” on page 286
“Entity Hierarchy” on page 287
“Setting Up E-mail for Workflow Notification” on page 287
“Printing Planning Unit Annotations” on page 287
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.
For example, consider this data outline:
●
●
●
The Version dimension has two members: Best Case, Worst Case.
The Entity dimension has three members: New York, California, Connecticut.
The Scenario dimension has two members: Actual, Budget.
284
Managing the Budgeting Process
The planning unit might consist of a version (Worst Case), an entity (New York), and a scenario (Actual) as shaded in the following example:
You start, view, and promote planning units using Planning Web’s Check Status task. Planning
Web also maintains a history of the budget review process and supports users’ annotations. For more information about Check Status, see the Planning Web help.
A planning unit is in one of six possible states:
●
●
●
●
●
●
Not Started - This is the initial state of all planning units. Any budget administrator can initiate the review process using the Start action.
First Pass - This is 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
About the Budgeting Process
285
planning cycle is procedural, requiring coordination among the administrators. Once all the planning units are approved, the budget cycle is complete. Any administrator can approve a planning unit or reject a planning unit that has already been approved.
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.
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
Se lect File > Workflow > Manage Process
.
2
From the Scenario drop-down list, select a scenario.
3 From the Version drop-down list, select a version.
Note:
The scenarios and versions displayed in the drop-down list are enabled for process management during the
creation of the scenario or version. See “Setting Up Scenarios” on page 166
or “Setting Up Versions” on page 170
.
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.
For more information on working with planning units, see the Hyperion System 9 Planning
User’s Guide or help system.
286
Managing the Budgeting Process
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.
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.
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.
Setting Up E-mail for Workflow Notification
The application owner must specify the application’s e-mail server before anyone else can successfully enable e-mail notification. After they set up e-mail notification, users receive an email 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.
For information on specifying the e-mail server, see “Specifying System Settings” on page 316 .
If the specified e-mail server name is valid, the application owner now becomes the source of all e-mail notifications. If the e-mail server name is not valid, no one else can enable e-mail notification.
Printing Planning Unit Annotations
●
●
●
Administrators can check the current status of planning units by creating a report on all planning unit annotations for a selected set of scenarios, versions, and entities. Reports on planning unit annotations can also be created that are based on process status.
Consider these points when creating a report on planning unit annotations:
The planning unit's title, author, date, and annotation text are displayed automatically.
Annotation text, not data that may be associated with the planning unit, is displayed.
Planning unit annotations are displayed chronologically, with the most recent entry first.
Note:
If you are using a Thai language system, the time stamp in annotations and audit reports displays in the Gregorian calendar, rather than the Buddhist calendar. This is due to a limitation in the JDK (Java Development Kit) 1.3.1 for application servers.
About the Budgeting Process
287
➤
To create and print a report on planning unit annotations:
1
Select Administration > Reporting.
2
Select the Planning Unit Annotations tab.
3
In the Planning Units area, select the planning units on whose annotations you want to report by taking one of the following actions:
●
Enter the names of the Scenarios, Versions, and Entities
●
Click to select the Scenarios, Versions, and Entities
4
In the Process Status area, select the check boxes of the status states on which you want to report for the specified planning units. The default for all status states is On.
5
Click Create Report.
Adobe Acrobat generates a comprehensive report with the following information about the
Planning Unit:
●
Name of the application
●
●
●
●
●
Selected set of Scenarios, Versions, and Entities
Planning Unit title and status
Date of origin
Author
Content of the annotation
6
To print the report, click Print on the Adobe Acrobat toolbar.
Overview of Managing Task Lists
An organization’s plan or forecast often requires that end users perform multiple activities or tasks to complete the process. This may be performed infrequently by end users and requires guidance and training from administrators.
Task lists guide users through the planning process by listing tasks that need to be completed, along with instructions and due dates. This helps users work independently and reduces the burden on administrators to provide assistance.
Administrators and interactive users create and manage tasks and task lists. For detailed procedures, see the following topics:
●
●
●
●
●
●
“Managing Task Lists” on page 289
“Creating Task List Folders” on page 289
“Creating Task Lists” on page 291
“Adding Instructions to Task Lists” on page 291
“Adding and Defining Tasks” on page 292
“Assigning Access to Task Lists” on page 300
288
Managing the Budgeting Process
Managing Task Lists
Task lists contain groups of tasks that users complete as they move through the planning process. Use the Manage Task List page to create and manage task lists, and to set up folders to organize them.
➤
To manage task lists:
1
Be sure that you are working in Advanced mode.
To switch to Advanced mode, select View > Advanced. If you are already working in Advanced mode, the Advanced command is not available.
2
To open the Manage Task Lists page, take one of the following actions:
●
●
Select Administration > Manage Task Lists.
Select File > New > Task List.
3
Use the Manage Task Lists page to set up task list folders and create and manage task lists.
For detailed instructions, see the following topics:
●
“Creating Task List Folders” on page 289
●
“Creating Task Lists” on page 291
Creating Task List Folders
You can use the Manage Task Lists page to create folders for organizing task lists.
➤
To create task list folders:
1
Open the Manage Task Lists page.
For instructions, see steps 1 and 2 in “Managing Task Lists” on page 289 .
2
In the Task List Folders area, click in a folder, such as Task Lists, in which to create the task list folder.
The first time you create a task list folder, only the Task Lists folder is displayed in the Task List
Folders area. After additional folders are created, they appear beneath the Task Lists folder. You can click the plus sign (+) or minus sign (-) to expand or collapse the folders.
3
In the left side of the Manage Task Lists page, click Create.
A dialog box is displayed, prompting you for the name of the new folder.
4
In the dialog box, enter the name of the task list, and then click OK.
The new task list folder appears in the folder that you selected before clicking the Create button.
Managing Task Lists
289
Moving Task List Folders
After you create a task list folder, you can move it within the Task Lists folder. You cannot move the Task Lists folder.
➤
To move task list folders:
1
Open the Manage Task Lists page.
For instructions, see steps 1 and 2 in “Managing Task Lists” on page 289 .
2
In the Task List Folders area, select the folder that you want to move.
After you select a folder, a Move button appears above the Task List Folders area. You cannot move the pre-created Task Lists folder.
3
Above the Task List Folders area, click Move.
4
In the dialog box that is displayed, select the destination folder, and then click OK.
The selected task list folder is moved to the new location.
Deleting Task List Folders
If you created a task list folder that you no longer need, you can delete it if it does not contain any other folders. You cannot delete the pre-created Task Lists folder.
➤
To delete task list folders:
1
Open the Manage Task Lists page.
For instructions, see steps 1 and 2 in “Managing Task Lists” on page 289 .
2
In the Task List Folders area, select the folder that you want to delete.
You can delete any folder except the Task Lists folder. After you select a folder, a Delete button appears above the Task List Folders area.
3 Above the Task List Folders area, click Delete.
4
When you are prompted to confirm the deletion, click OK.
If you select a folder that contains additional folders, an error message is displayed. You cannot delete folders that contain other folders.
290
Managing the Budgeting Process
Creating Task Lists
Task lists organize groups of tasks for users. Before you can create tasks for users, you must first create a task list to contain the tasks.
Creating a task list involves two basic procedures:
●
●
First, you create and name the task list, using the instructions in this topic.
Next, you define the content of the task list by adding instructions and tasks, and setting up access. See the following topics:
❍
“Adding Instructions to Task Lists” on page 291
❍
❍
“Adding and Defining Tasks” on page 292
“Assigning Access to Task Lists” on page 300
➤
To create a task list:
1
Open the Manage Task Lists page.
For instructions, see steps 1 and 2 in “Managing Task Lists” on page 289 .
2
In the Task List Folders area, click the folder in which you want to create the task list.
3
Above the Task List area on the right side of the Manage Task Lists page, click Create.
A dialog box prompts you to enter the name of the new task list.
4
In the dialog box, enter the name of the task list that you want to create, and then click OK.
The name of the task list is displayed in the Task List area on the right side of the page.
5
Now that you have created and named the task list, continue with the following procedures to define it:
●
●
●
To add instructions, see “Adding Instructions to Task Lists” on page 291
.
To add and define tasks, see “Adding and Defining Tasks” on page 292
.
To assign access permissions, see
“Assigning Access to Task Lists” on page 300 .
Adding Instructions to Task Lists
After you create a task list, you can add instructions to help users work with the task list. For instructions on creating a task list, see
“Creating Task Lists” on page 291 .
➤
To add instructions to a task list:
1
Open the Manage Task Lists page.
For instructions, see steps 1 and 2 in “Managing Task Lists” on page 289 .
2
In the Task List Folders area, click the folder that contains the task list that you want to modify, and then select the task list.
The task list is displayed in the Task List area on the right side of the page.
Managing Task Lists
291
3
In the Task List area, select the task list that you want to modify, and then click Edit.
The Edit Task List dialog box appears.
4
In the Edit Task List dialog box, select the Instructions tab.
5 In the Enter Instructions text box, type instructions for the task list, and then click Save and Close.
Adding and Defining Tasks
After you create a task list, you add and define tasks for the task list. For example, tasks might include entering data in appropriate data forms, running required business rules, and submitting numbers for approval.
To add and define tasks, complete the procedures in “Adding Tasks to Task Lists” on page 292
and
“Setting Task Properties” on page 294 .
Adding Tasks to Task Lists
After you create a task list, you add tasks to it. Adding tasks involves two basic procedures. First, you use the Edit Task List dialog box to add the task. Next, you use the Add Task dialog box to set the task name, the type of task, and instructions for completing the task.
You can set a completion date and alerts to remind users when a due date is approaching or has passed. Alerts are displayed on task lists as colored circles, and give the following information about the status of the task:
●
●
Green—on schedule
Yellow—approaching due date
Red—overdue
●
You can also specify two types of e-mail messages to send to users. Due date messages are sent after a task’s due date, to alert users that the task was not completed by the due date. Alert messages are reminders that are sent after an “alert date” that you set, and are repeated until the due date is reached for a task. In order to send these messages, you must set up an e-mail server as described in
“Specifying System Settings” on page 316
.
➤
To add tasks to task lists:
1
Open the Edit Task List dialog box: a.
Select Administration > Manage Task Lists to open the Manage Task Lists page.
b. In the Task List Folders area, click the folder that contains the task list you want to modify.
c.
In the Task List area on the right side of the page, select a task list, and then click Edit.
2
In the Edit Task List dialog box, click Add Child to add a task.
The Add Task dialog box is displayed.
292
Managing the Budgeting Process
3
In the Task field, type a name for the task.
4
From the Type drop-down list, select the type of task that you are adding:
●
●
●
●
●
URL Task—opens a specified URL
Web Data Form—opens a Web data form
Business Rule—launches a business rule that you specify
Workflow—starts the review process with a scenario and version that you specify
Descriptive—describes an action that users must take
5
In the Instructions text box, enter instructions to help users understand how to complete the task.
6 Optional: To enter a due date for the task, select the Due Date check box, and then enter the date and time by which users must complete this task: a.
Select the month, day, and year from the drop-down lists. (You can change the date display
format in Planning preferences. See “Specifying System Settings” on page 316 .)
b. Select the hours, minutes, and AM or PM from the drop-down lists.
After you select the Due Date check box, the Alert check box is selectable, and you have the option of setting up e-mail reminder messages to be sent to users. An e-mail server must be set
up, using the instructions in “Specifying System Settings” on page 316 .
7
Optional: If you select the Due Date check box, you can set up e-mail messages to be sent if the task is not completed by the due date: a.
In the Due Date area, select the Repeat Every check box. b. Type a number in the Repeat Every text box, and then select an option from the drop-down list to indicate the frequency of the e-mail reminder. For example, to send a message every 4 hours after the due date and time have passed, type 4 in the text box, and then select Hour(s) from the drop-down list.
8
Optional: If you select the Due Date check box, you can set up alert e-mail messages to be sent after the alert date and before the due date: a.
Set the date when you want alert messages to begin by selecting the month, day, and year from the drop-down lists. b. Set the time when you want alert messages to start by selecting the hours, minutes, and AM or PM from the drop-down lists.
c.
In the Alert area, select the Repeat Every check box. d. Type a number in the Repeat Every text box, and then select an option from the drop-down list to indicate the frequency of the e-mail reminder. For example, to indicate that a message should be sent once a day after the alert date and until the due date, type 1 in the text box and then select Day(s) from the drop-down list.
9
Optional: Select the Dependency check box if you want to make completion of this task dependent on completing a primary task.
10
Click Save and Close.
11
.
Managing Task Lists
293
Setting Task Properties
After you create a task, you must set up properties for all types of tasks except Descriptive tasks.
➤
To set task properties:
1
Open the Edit Task List dialog box: a.
Select Administration > Manage Task Lists to open the Manage Task Lists page.
b. In the Task List Folders area, click the folder that contains the task list you want to modify.
c.
In the Task List area on the right side of the page, select a task list, and then click Edit.
2
In the Edit Task List dialog box, select a task, and then click Edit.
3
In the Edit Task dialog box, click the Property tab.
The Property tab displays fields that are appropriate for the type of task you selected.
4
In the Properties tab, take one of the following actions, depending on the type of task for which you are setting properties:
Table 53
Setting Task Properties
Type of Task
Workflow
Action
URL Enter a fully qualified URL that you want to associate with this task, such as http://www.hyperion.com. Optionally, select Use Single Sign On to enable users to open a URL for another Hyperion product that accepts single sign-on. For information about setting up single sign-on, see the Hyperion System 9 Shared Services Installation Guide.
Web data form For Data Form Folder, select the folder containing the Web data form that is associated with this task. For Data Form, select the Web data form that you want users to work on as part of this task.
Business rule For Plan Type, select the plan type associated with the business rule that you want the user to execute. For Business Rule Name, select the business rule that you want the user to execute.
For Scenario and Version, select the scenario and version you want the user to work in.
Note:
For Descriptive tasks, you do not need to take any action.
5
In the Edit Task dialog box, click Save.
6
In the Edit Task List dialog box, click Close.
294
Managing the Budgeting Process
Editing Task Lists
You can use the Edit Task List dialog box to make changes to a task list, as described in the following topics:
●
●
●
●
●
●
“Moving Task Lists” on page 298
“Deleting Task Lists” on page 299
Editing Tasks
You can use the Edit Task dialog box to modify the type of task, its instructions, the due date and alert date, and whether e-mail reminder messages are sent to users.
Due date messages are sent after a task’s due date, to alert users that the task was not completed by the due date. Alert messages are reminders that are sent after an “alert date” that you set, and are repeated until the due date is reached for a task. In order to send these messages, you must
set up an e-mail server as described in “Specifying System Settings” on page 316 .
➤
To edit a task:
1
Open the Edit Task List dialog box: a.
Select Administration > Manage Task Lists to open the Manage Task Lists page.
b. In the Task List Folders area, click the folder that contains the task list you want to modify.
c.
In the Task List area on the right side of the page, select a task list, and then click Edit.
2
In the Edit Task List dialog box, select a task, and then click Edit.
3
In the Edit Task dialog box, make any of the following changes:
●
●
Modify the name of the task.
Select a different type of task:
❍
❍
URL Task—opens a specified URL
Web Data Form—opens a Web data form
❍
❍
❍
Business Rule—launches a business rule that you specify
Workflow—starts the review process with a scenario and version that you specify
Descriptive—describes an action that users must take
4
In the Instructions text box, modify the instructions for completing the task.
Managing Task Lists
295
5
Optional: To enter a due date for the task, select the Due Date check box, and then enter the date and time by which users must complete this task: a.
Select the month, day, and year from the drop-down lists. (You can change the date display
format in Planning preferences. See “Specifying System Settings” on page 316 .)
b. Select the hours, minutes, and AM or PM from the drop-down lists.
After you select the Due Date check box, the Alert check box is selectable, and you can set up e-mail reminder messages to be sent to users.
6 Optional: If you select the Due Date check box, you can set up e-mail messages to be sent if the task is not completed by the due date: a.
In the Due Date area, select the Repeat Every check box. b. Type a number in the Repeat Every text box, and then select an option from the drop-down list to indicate the frequency of the e-mail reminder. For example, to send a message every 4 hours after the due date and time have passed, type 4 in the text box, and then select Hour(s) from the drop-down list.
7 Optional: If you select the Due Date check box, you can set up alert e-mail messages to be sent after the alert date until the due date: a.
Set the date when you want alert messages to begin by selecting the month, day, and year from the drop-down lists. b. Set the time when you want alert messages to start by selecting the hours, minutes, and AM or PM from the drop-down lists.
c.
In the Alert area, select the Repeat Every check box. d. Type a number in the Repeat Every text box, and then select an option from the drop-down list to indicate the frequency of the e-mail reminder. For example, to indicate that a message should be sent once a day after the alert date and until the due date, type 1 in the text box and then select Day(s) from the drop-down list.
8 Optional: Select the Dependency check box if you want to make completion of this task dependent on completing a primary task.
9
To edit properties for the task, click the Property tab and follow the procedures described in
10
When you finish making changes, click Save in the Edit Task dialog box.
11
In the Edit Task List dialog box, click Close.
296
Managing the Budgeting Process
Copying Tasks
In the Edit Task List dialog box, you can make a copy of a task list and save it with a different name to use it for another purpose. You can copy one task list at a time.
➤
To make a copy of a task list:
1
After you create a task list, open the Edit Task List dialog box: a.
Select Administration > Manage Task Lists to open the Manage Task Lists page.
b. In the Task List Folders area, click the folder that contains the task list you want to modify.
c.
In the Task List area on the right side of the page, select a task list, and then click Edit.
2
In the Edit Task List dialog box, select the task list that you want to copy.
3
Click Save As.
A dialog box prompts you for the name of the new task list.
4
In the dialog box, enter the name of the new task list, and then click OK.
The task list is saved with the name that you specified in the same folder as the original task list.
To close the Edit Task List dialog box, click Close.
Moving Tasks
In the Edit Task List dialog box, you can move tasks up and down to change their position on the task list. When you move a task that has subordinate tasks, the subordinate tasks move, too.
You can also cut and paste tasks to move them to a different level of the hierarchy. You cannot use cut and paste within the same level.
➤
To move tasks at the same level up or down on a task list:
1
After you create a task list, open the Edit Task List dialog box: a.
Select Administration > Manage Task Lists to open the Manage Task Lists page.
b. In the Task List Folders area, click the folder that contains the task list you want to modify.
c.
In the Task List area on the right side of the page, select a task list and then click Edit.
2 In the Edit Task List dialog box, select the task you want to move.
You can select only one task to move at a time.
3
Perform an action:
●
Click Up Arrow to move the task up one position.
●
Click Down Arrow to move the task down one position.
The task and any subordinate tasks move up or down in the task list.
4
Click Save and Close.
➤
To move a task within the task list hierarchy:
1
After you create a task list, open the Edit Task List dialog box:
Managing Task Lists
297
a.
Select Administration > Manage Task Lists to open the Manage Task Lists page.
b. In the Task List Folders area, click the folder that contains the task list you want to modify.
c.
In the Task List area on the right side of the page, select a task list, and then click Edit.
2
In the Edit Task List dialog box, select the task you want to move.
Be sure that only one check box is selected. You can only select one task to move at a time.
3
Click Cut.
4
Do one of the following:
●
●
To move the task to a new position on the task list, select the task you want to appear above the task.
To move the task to the root tasklist, do not select any specific task position.
5
Click Paste.
6
When prompted to confirm the move, click OK.
Moving Task Lists
You can move task lists within a task list folder to change the position of the task lists. You can move several task lists at a time.
➤
To move task lists:
1
Open the Manage Task Lists page.
For instructions, see steps 1 and 2 in “Managing Task Lists” on page 289 .
2
In the Task List Folders area on the left side of the page, click the folder that contains the task list that you want to move.
3
In the Task List Folders area, select the task list.
The task list is displayed in the Task List area on the right side of the page. The Move button appears above the Task List Folders area on the left side of the page.
4
In the Task List Folders area on the left side of the page, click Move.
5
In the dialog box that appears, select the destination folder to move the task to the desired location.
6
Click OK.
Deleting Tasks
You can use the Edit Task List dialog box to delete tasks when you no longer need them.
➤
To delete tasks:
1
Open the Manage Task Lists page.
For instructions, see steps 1 and 2 in “Managing Task Lists” on page 289 .
298
Managing the Budgeting Process
2
In the Task List Folders area on the left side of the page, click the name of the folder that contains the task that you want to delete.
The task lists in the folder are displayed.
3 In the Task List Folders area, select the task list that contains the task that you want to delete.
The task list is displayed in the Task List area on the right side of the page.
4
In the Task List area on the right side of the page, select the check box next to the task list that contains the task that you want to delete.
5
In the Task List area, click Edit.
6
In the Edit Task List dialog box, select any tasks that you want to delete, and then click Delete.
7
When you are prompted to confirm the deletion, click OK.
Deleting Task Lists
You can use the Manage Task Lists page to delete task lists when you no longer need them.
➤
To delete task lists:
1
Open the Manage Task Lists page.
For instructions, see steps 1 and 2 in “Managing Task Lists” on page 289 .
2
In the Task List Folders area, click the folder that contains the task list with the task that you want to delete, and then select the task list.
The task list is displayed in the Task List area on the right side of the page.
3
In the Task List area, select any task lists that you want to delete, and then click Delete.
4
When you are prompted to confirm the deletion, click OK.
Linking Tasks to Planning Web Pages
The Copy Data Link feature helps you easily link tasks in task lists to specific pages in the application. You can copy and paste the URL address from a page in the Planning application to a task when you are creating or changing tasks in a task list. Then the task list user can easily access the same page in the Planning application from within the task list. Financial
Management has a similar feature that enables creating a workspace.
The following steps assume that you have already set up a task list. If you have not, see
“Creating Task Lists” on page 291
.
➤
To copy the URL to a task list:
1
Access the page in the Planning application to which you want to link a task in a task list.
2
Select Administration > Copy Document Link.
3
Open the task list to which you want to link a task.
4
Select the task to which you want to link the copied Planning page and select Edit.
Managing Task Lists
299
See “Setting Task Properties.”
5
Click the Properties tab.
6
Perform an action:
●
●
Click Ctrl+V.
From the Microsoft Internet Explorer menu, select Edit > Paste.
7
Click Save.
8
Click Close.
Assigning Access to Task Lists
You can assign access to task lists to determine who can view and modify task lists. By default, administrators and interactive users can manage and assign access privileges for task lists.
Interactive users and planners have access to certain task lists based on access rights. You can add, change, or remove access to a task list.
Adding Access to a Task List
You can assign different types of access to task lists, including management access and assigned access.
➤
To assign access to task lists:
1
Open the Manage Task Lists page.
For instructions, see steps 1 and 2 in “Managing Task Lists” on page 289 .
2
Select the task list that you want to modify: a.
In the Task List Folders area, click the name of the folder that contains the task list, and then select the task list that you want to modify.
b. In the Task List area, select the check box next to the task list that you want to modify.
3
In the Task List area, click Assign Access.
4
In the Assign Access dialog box, click Add Access.
5
Optional: To get the latest set of users and groups from the User Management Console, click Refresh
Users and Groups.
6
In the Users and Groups area, select the users or groups who will have access to the task list.
7
In the Type of Access area, select how you want the selected users or groups to use the task list:
●
●
●
●
Assign—enables users or user groups to view and use the task list
Manage—enables users to modify the task list
Manage and Assign—enables users to modify the task list, and to see and use the task list
None—prevents users from seeing this task list
8
Click Add.
300
Managing the Budgeting Process
9
Click Close.
Changing Access to a Task List
You can change which users can use or modify a task list.
➤
To change access to a task list:
1
Open the Manage Task Lists page.
For instructions, see steps 1 and 2 in “Managing Task Lists” on page 289 .
2
Select the task list that you want to modify: a.
In the Task List Folders area, click the name of the folder that contains the task list, and then select the task list that you want to modify.
b. In the Task List area, select the check box next to the task list that you want to modify.
3
In the Task List area, click Assign Access.
4
In the Assign Access dialog box, select the users or groups for whom you want to change access, and then click Edit Access.
5
Optional: To get the latest set of users and groups from the User Management Console, click Refresh
User/Group Lists.
6
In the Type of Access area, select how you want the selected users or groups to use the task list:
●
●
●
●
Assign—enables users or user groups to view and use the task list
Manage—enables users to modify the task list
Manage and Assign—enables users to modify the task list, and to see and use the task list
None—prevents users from seeing this task list
7
Click Set.
8
Click Close.
Removing Access to a Task List
You can remove access to a task list when all the tasks are completed, when a user moves to a different position or leaves the company, or when the tasks are no longer necessary.
➤
To remove access from a task list:
1
Open the Manage Task Lists page.
For instructions, see steps 1 and 2 in “Managing Task Lists” on page 289 .
2
Select the task list that you want to modify: a.
In the Task List Folders area, click the name of the folder that contains the task list, and then select the task list that you want to modify.
b. In the Task List area, select the check box next to the task list that you want to modify.
Managing Task Lists
301
3
In the Task List area, click Assign Access.
4
Select the user or group whose access you want to remove, and then click Remove Access.
5
When you are prompted to verify the action, click OK.
6
Click Close.
Copying Data
When planners create a budget, it is often useful to copy the entire plan from one year to another or from one business unit to another. Administrators can support the planning effort by using the Copy Data feature to copy all relational data, including supporting detail, from one dimensional intersection to another dimensional intersection.
For example, you can copy Budget, FY05, Final to Forecast, FY06, First Draft. You can also copy data from FY04 to FY05 to help planners prepare a budget, or you can copy data from one business unit to another.
When you use the Copy Data feature, note the following points:
●
●
●
●
●
●
●
The settings that you select in the Copy Data page are preserved for the current session only.
After you log out, the fields are restored to the default settings.
The members and dimensions that you copy must be present in the selected plan types.
Data must be copied into cells that can accept data. For example, you cannot copy data into read-only or dynamic cells.
You can use copy account annotations, supporting detail, and cell text. However, you cannot copy planning unit annotations.
Analytical Service data is copied regardless of the options that you select in the Copy Data
Options area.
Because this is an administrative function, Planning assumes that you have full access to the data you are copying. In addition, you are not prevented from copying to planning units that are approved.
This feature does not calculate data. If you want to perform calculations, such as increasing the forecast by 5%, you can apply the appropriate business rule after copying the data.
➤
To copy data:
1
Select Administration > Copy Data.
2
For Plan Type, select a plan type, and then click Go.
You can copy from one plan type at a time. When you click Go, the appropriate dimensions are displayed for this plan type.
3
In the Static Dimensions area, enter the set of dimension members for the intersections of data: a.
In the Dimension area, select a dimension from which to copy. b. In the Members area, click the Member Selection icon to select the members from which to copy.
302
Managing the Budgeting Process
You can select multiple members. For example, for Time Periods, you can select Jan, Feb, and Mar.
4
Optional: To add another static dimension to the list, click Add Dimension, and then repeat the previous step to define the dimension. (To remove a dimension from the list, select None - Select a Dimension. The dimension moves to the Dimensions with Source and Destination area, below.)
5
In the Dimensions with Source and Destination area, enter the dimensions into which you want to copy data: a.
In the Source area, click the Member Selection icon to select a member to use for the destination. b. In the Destination area, click the Member Selection icon to select a member to use for the destination.
6
In the Copy Data Options area, select any of the following types of information that you want to copy:
●
●
●
Copy Account Annotations
Copy Supporting Details
Copy Cell Text
7
Click Copy Data.
The data is copied from one intersection to the other.
If the data is not copied successfully, a message is displayed. To get information to help you resolve the issue, check the log file.
8
If you want to copy data for another plan type, select a different plan type in
procedure.
Copying Data
303
304
Managing the Budgeting Process
Working With Applications
C h a p t e r
13
This chapter explains how to:
●
●
●
●
Move a Planning application from one server to another (for example, moving from a test environment to a production environment).
Copy and rename an application on the same server.
Set individual preferences and global settings for various aspects of the application.
Delete certain application information.
In This Chapter
Working With Applications
305
Moving an Application
To move an application means to move it to a different environment while keeping its name intact.
This topic assumes the following:
●
●
●
●
●
●
The two environments are referred to as Test and Production. The application is moved from Test to Production and is named HYPPLAN. The relational database created for this planning application in the Production environment is named HYPPLANDB.
Each environment has all the necessary components installed.
The test and production environments contain the same users.
You are using Planning Release 9.2.x.
The test and production environments are using the same external authentication providers as specified in the
CSS.XML
file.
You backed up your Shared Services and OpenLDAP repositories as specified in the
Hyperion System 9 Shared Services Installation Guide.
Note:
Before moving or copying an application, make sure that you have upgraded your applications to the latest release and perform a Refresh on the source application.
The following topics explain how to move Hyperion applications:
●
●
●
“Moving a Planning Application” on page 306
“Moving Business Rules Data” on page 308
“Moving Reporting Data” on page 311
Moving a Planning Application
➤
To move a Planning application:
1
Find the application owner of the application that you want to move, and make sure it is recognized from the test and production environments, and is not a local computer account. If it cannot be recognized, add the user as an administrator, and promote that user to be the application owner.
Note:
To find the application owner from the relational database: select USER_ID from HSP_USERS where ROLE=3
(usually it’s 500001). Then select OBJECT_NAME from HSP_OBJECT where OBJECT_ID=<USER_ID>.
2 Make sure the application owner is a user in the test and production environments.
3
Make a backup of the relational database for the development application (for example, hypplan.bak
), and then restore the backup of the development database to a new relational database in the production environment.
4
Create and configure a UDL or encrypted connection string pointing to the new relational database.
306
Working With Applications
See “Creating Applications Using a Microsoft Data Link UDL” or “Creating Applications Using an Encrypted Connection String” in the Hyperion System 9 Planning Installation Guide.
5
Create and configure a data source pointing to the new relational database.
See “Creating Applications Using a Microsoft Data Link UDL” or “Creating Applications Using an Encrypted Connection String” in the Hyperion System 9 Planning Installation Guide.
6
Create a new entry for the application in the HSX_DATASOURCES table by doing the following: a.
To add a new record, open the HSX_DATASOURCES table and insert a new line.
Note:
This table is found in the database used by the UDL associated with the System Data Link file in the Planning
Desktop. b. For the new record, enter the following values in the column fields:
❍
❍
Product=Planning
AppName=name of new application
❍
❍
Description=optional
DSN=name of the DSN created for the new application c.
Close or commit the table after you edit it.
7
On the Analytic Services server, create an application (for example, named HYPPLAN). Make sure the
application name is the same as you entered in the HSX_DATASOURCES table in step 6 .
8
Open Planning and open the application in the Production environment.
9
Use the Manage Database task to create the Analytic Services outline.
Note:
You can also use the AppScheduler utility to schedule the application creation or refresh. For example, you can create the application HYPPLAN by entering the following: Appscheduler localhost,
HYPPLAN,user1, password, /C or /R. For more information, see Scheduling Application
Databases to be Refreshed in the Hyperion Planning Administrator’s Guide.
Note:
If you have custom Analytic Services outlines (.otl files), you should open them using Essbase Administration
Services for Essbase 7/Analytic Administration Services for Analytic Services 9.2 from the Development machine and perform a Save As over the existing *.otl on the Production machine. If you have custom calc scripts
(.csc), load rules (.rul), or report scripts (.rep), you can copy the files to the Analytic Services application directory. 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 has been copied from the development server, you should select the option to Refresh the database only on the production server. Otherwise, the files must be copied from the development server again.
Note:
Users on the Analytic Services server that hosts the original application do not already have to be defined on the
Analytic Services server for the new application. The users will be automatically added to Analytic Services when a Database Create or Database Refresh is performed with the Security Filters option checked. However, the
Analytic Services server must run on a network that recognizes these users.
Moving an Application
307
10
Run the Configuration Utility in Planning to create the Planning properties file (HspJSHome.properties). For more information, see the Hyperion System 9 Planning Installation Guide.
You can also create the Planning properties file by specifying parameters from the cmd prompt.
Example 1—Planning without Hyperion Business Rules
HspSetupSupport.exe c:\temp 11333 no where
HspSetupSupport.exe = Properties file utility that is run from <drive
letter>:\hyperion\HyperionPlanning\Utils folder c:\temp = properties file location
11333 = RMI port no = no connection to HBR
Example 2—Planning with Hyperion Business Rules
HspSetupSupport.exe c:\temp 11333 yes server3 10080 admin password where
HspSetupSupport.exe = Properties file utility that is run from <drive
letter>:\hyperion\HyperionPlanning\Utils folder c:\temp = properties file location
11333 = RMI port yes = connection to HBR server3 = AAS server name
10080 = AAS server port admin = AAS admin user name password = AAS admin user password
If the utility runs successfully, the HspJSHome.properties file is created in the location you specified.
11
After you have generated the properties file, log on to HYPLAN on the Planning Web and register the application with Shared Services.
Moving Business Rules Data
The Business Rules repository stores all repository objects (including business rules, sequences, macros, and variables) defined in Business Rules. To migrate the repository to a new server, you can use the Migrate Repository feature in Business Rules. To do so, you need to set up a connection to the server from which you want to migrate, test the connection, and then select the business rules, variables, macros, sequences, and projects you want to migrate.
Note:
You need to migrate any existing graphical repositories (from release 2.x forward) and any existing Business Rules repositories (from release 4.x forward) to the Business Rules repository for this release in order to work with these rules.
308
Working With Applications
➤
To migrate Hyperion Business Rules data:
1
Launch the Administration Console by selecting Start > Programs > Hyperion System 9 BI+ > Analytic
Administration Services > Administration Console.
2
In the Analytic Administration Services Login dialog box, enter a server name and your user name and password to log on to Analytic Administration Services.
3
In the left navigation frame of Analytic Administration Services, expand the Business Rules node. Then expand the Administration node.
4
Right-click Administration and select Migrate Repository.
The Migrate Business Rules window is displayed with the Business Rules tab selected; this tab is empty initially. After you connect to a server, database, and repository from which to migrate, this tab lists the business rules that you can migrate.
Note:
You cannot migrate any access privileges that are associated with business rules, variables, macros, sequences, or projects.
5
Click Connect to connect to the repository from which you want to migrate repository objects.
6
On the Enter Source Repository Information dialog box, do the following: a.
From the Repository Version drop-down list, select one of the following repository versions from which to migrate:
Note:
If you are migrating a 4.0 repository to a 4.1 repository, run the Externalize Users utility in Analytic Administration
Services first. When you run this utility, all native Analytic Administration Services and Business Rules users from the previous release are migrated from the Analytic Administration Services/Business Rules repository into the
Shared Services repository. For more information on using the Externalize Users utility to migrate users to Shared
Services, see the Hyperion System 9 Analytic Administration Ser vices Installation Guide.
Business Rules 4.1 Repository: Select this option to migrate graphical and non-graphical business rules and other repository objects such as variables, macros, sequences, and projects from a Business Rules 4.1 repository into another Business Rules 4.1 repository.
You may want to use this option if you need to migrate your repository to a new server (for example, from a development to a production server).
Note: You cannot migrate rules from an active repository to another repository. For example, if you have repositories A and B, and A is the active repository, you cannot migrate rules from the A repository into the B repository, though you can migrate rules from the B repository into the A repository.
Business Rules 4.0 Repository: Select this option to migrate non-graphical business rules and other repository objects such as variables, macros, sequences, and projects, as well as any database locations and access privileges assigned to them, from a Business Rules 4.0 repository into a Business Rules 4.1 repository. When you migrate your Business Rules 4.0 repository to a 4.1 repository, all Business Rules repository objects including rules, sequences, variables, macros, and projects, as well as any database locations and access privileges assigned to them, are migrated to Shared Services automatically. During migration, any Business Rules roles assigned to users are migrated and assigned equivalent roles in Shared Services. In addition, any Business Rules groups are migrated to Shared
Moving an Application
309
Services. If the groups have roles assigned to them, these roles are also migrated and assigned equivalent roles in Shared Services. If a Business Rules group does not exist in
Shared Services, it is created. After they are migrated to the Shared Services repository, existing Business Rules users and groups are automatically provisioned for use in Business
Rules. You can work with Business Rules users and groups, and assign roles to them, in
Hyperion System 9 Shared Services User Management Console. For an overview of Shared
Services User Management Console, Hyperion’s new centralized interface for managing users, groups, and roles for all Hyperion products, see the Hyperion System 9 Shared
Services User Management Guide.
Graphical Repository: Select this option to migrate graphical business rules from a graphical repository (from 2.x through 4.0.1) into a Business Rules 4.1 repository. All of your graphical business rules remain graphical business rules in the Business Rules 4.1 repository.
Note: You cannot convert non-graphical business rules into graphical business rules by migrating to a new repository. b. From the Repository Type drop-down list, select one of the following repository types from which to migrate:
❍
Microsoft SQL
❍
❍
❍
Oracle
DB2
Microsoft Access
Note:
You can only select Microsoft Access if you are migrating from a graphical repository. c.
Enter the name and port number of the server on which the repository resides. If you are using an Oracle repository, enter the instance.
d. For SQL and DB2, enter the database name (this is the empty Business Rules database that was created in Microsoft SQL Server or DB2 during configuration) followed by the username and password for that database.
e.
Click Test Connection to test the connection to the database. If the connection fails, make any necessary changes until you can connect successfully. f.
Click Connect to connect to the server.
Note: Select Current if you want to connect to the server that you are connected to currently.
The business rules and sequences that you can migrate to this release of Business Rules are listed on the Business Rules tab and the Sequences tabs, respectively. If you are migrating a 4.0 or 4.1 repository, any variables, macros, and projects that you can migrate are listed on their respective tabs.
7
Do one of the following:
●
If you are migrating a 4.0 or 4.1 database, on the Business Rules, Variables, Macros,
Sequences, and Projects tabs, select the check boxes next to the names of the business rules, variables, macros, sequences, and projects you want to migrate. Or click the Select
All button to migrate all of them.
310
Working With Applications
●
If you are migrating a graphical repository, select the check boxes next to the names of the business rules and sequences you want to migrate. Or click the Select All button to migrate all of them. Go to step 9 .
Note:
If you want to migrate all of the items listed on each tab, click the Select All button for each tab.
8
If you are migrating a 4.0 or 4.1 database, click the Dependents button to migrate the variables and macros that are associated with the business rules you selected.
The variables and macros associated with the business rules you selected are listed on the
Variables and Macros tabs.
9
Click Migrate to migrate the objects you selected.
10
Run the Configuration Utility in Planning to create the Planning properties file. See the Hyperion System 9
Planning Installation Guide. If you want to create the Planning properties file from the cmd prompt, see
.
Moving Reporting Data
You may be moving reporting data from Financial Reporting or from Hyperion Reports 7.2.x.
➤
To migrate data from Financial Reporting:
●
Follow the instructions in the Hyperion System 9 BI+ Financial Reporting, Interactive
Reporting, Production Reporting, Web Analysis Migration Guide and Migration Planning
Guide.
➤
To migrate data from Hyperion Reports 7.2.x:
1
Configure the production reports server and make sure that you can create and run a sample report.
2 Restore the development reports relational database over the production reports relational database.
3
Stop your Hyperion Reports Services.
4
On the production server, run the following program:
C:\Hyperion\HyperionReports\bin\CreateRegistry.cmd
Note:
The location of this program may vary, depending on where you installed Hyperion Reports.
5
Restart your Hyperion Reports Services.
6
To reconfigure the server, log on to Hyperion Reports.
7
In the Hyperion Reports Administrator area of the Hyperion Report Server Configuration dialog box, enter the user ID and password of the Hyperion Reports administrator for the development reports relational database.
This is the first user who configured the server in the development environment.
Moving an Application
311
8
Click OK.
Copying a 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:
Before moving or copying an application, make sure that you have upgraded your applications to the latest release and perform a Refresh on the source application. For information on moving an application from one application server to another, see
“Moving an Application” on page 306
.
If you have calculation scripts or member formulas in the application you are copying, see the
Analytic Services documentation for information on copying these components.
The following sample procedure is based on copying a Microsoft SQL application.
➤
To copy a Planning application:
1 Back up the relational database to which the application is connected.
Note:
The UDL file or encrypted connection string 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” in the Planning Administrator’s Guide.
2 Create a new relational database repository and 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 stating 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.
3
Create and configure a UDL or encrypted connection string pointing to the new relational database.
See “Creating Applications Using a Microsoft Data Link UDL” or “Creating Applications Using an Encrypted Connection String” in the Hyperion System 9 Planning Installation Guide.
4
Create and configure a data source pointing to the new relational database.
See “Creating Applications Using a Microsoft Data Link UDL” or “Creating Applications Using an Encrypted Connection String” in the Hyperion System 9 Planning Installation Guide.
5
Create a new entry for the application in the HSX_DATASOURCES table by doing the following:
312
Working With Applications
a.
To add a new record, open the HSX_DATASOURCES table and insert a new line.
Note:
This table is found in the database used by the UDL associated with the System Data Link file in the Planning
Desktop. b. For the new record, enter the following values in the column fields:
❍
❍
Product=Planning
AppName=name of new application
❍
❍
Description=optional
DSN=name of the DSN created for the new application
Note:
The application name must be different than the original application name and must be the same as the name
you enter for the Analytic Services application that you create in step 6 .
c.
Close or commit the table after you edit it.
6
On the Analytic Services server, create an application (for example, named HYPPLAN). Make sure the
application name is the same as you entered in the HSX_DATASOURCES table in step 5 .
Note:
Users on the Analytic Services server that hosts the original application do not need to already be defined on the
Analytic Services server for the new application. The users are automatically added to Analytic Services when a
Database Create or Database Refresh is performed with the Security Filters option checked. However, the Analytic
Services server must run on a network that recognizes these users.
7
Open the new application in Planning and refresh to Analytic Services.
Note:
If Analytic Services outlines have been copied to the new application, perform a Database Refresh. If Analytic
Services outlines have not been copied to the new application in Analytic Services, perform a Database Create.
You need to run the Configuration Utility for Planning and regenerate the Planning properties file to display the new application on the Web. After you have generated the properties file, log on to HYPLAN on the Planning Web and register the application with Shared Services.
Copying a Planning Application
313
About Setting Preferences
The Preferences page enables all users to set individual preferences in the current application, and administrators and application owners to specify certain global settings for the current application. Note that the selections affect only the current application.
The content and type of tabs available from the Preferences page depend on the user type.
Planners and interactive user types have access to these tabs from the Preferences page:
●
●
Application Settings tab
Display Options tab
For more information on these tabs, see the Hyperion System 9 Planning User’s Guide or Web help system. For more information on setting preferences, see the following topics:
●
●
●
●
●
●
●
“Setting Personal Preferences” on page 314
“Setting Application Defaults” on page 315
“Specifying System Settings” on page 316
“Limiting Use of an Application During Maintenance” on page 317
“Specifying Custom Tools” on page 317
“Setting Display Options” on page 318
“Setting Printing Options” on page 318
Administrators have access to a Show drop-down list that controls which tabs are available.
Using the following tabs, administrators can set their personal preferences, set defaults for the application, and specify system settings.
Option on the Show Drop-down List Description
Current Application Defaults By selecting Current Application Defaults and clicking Go, administrators have access to the Application Settings tab and the Display Options tab.
When saved, the values set on these tabs become the application defaults.
Other users can override these defaults, and can revert to the defaults by selecting the Use Application Defaults check box on the preferences tabs.
For more information on setting these options, see the Hyperion System 9
Planning User’s Guide or Web help system.
Advanced Settings By selecting Advanced Settings and clicking Go, administrators have access
to the System Settings tab and the Custom Tools tab. See “Specifying
and “Customizing the Planning Tools Page” on page 340
.
Setting Personal Preferences
Any user type (for example, planner or administrator) can set personal preferences for certain aspects of the current application, such as which alias table to use and whether to display planning units that have not been started.
314
Working With Applications
➤
To set personal preferences:
1
Select File > Preferences.
2
Do any of the following:
●
●
●
●
Select the Application Settings tab to set e-mail options, select an alias table, and set options for member selection and workflow. For more information on these options, see the Hyperion System 9 Planning User’s Guide or Web help system.
Select the Display Options tab to set options for number formatting, page selection, warnings for large data forms, and the number of dimensions to show on a page. For more information on these options, see the Hyperion System 9 Planning User’s Guide or Web help system.
Select the Printing Options tab to specify how pages are printed. For more information on these options, see the Hyperion System 9 Planning User’s Guide or Web help system.
Select the User Variables Options tab to limit the number of dimension members that display on a data form by setting a user variable. For information on setting up user
variables, see “Managing User Variables” on page 273 .
Note:
Selecting the Use Application Default check box for an option resets the value to the current application default.
See
“Setting Application Defaults” on page 315
.
Setting Application Defaults
Administrators can specify certain settings to be used as defaults across the current application.
Individual users can override such application-wide defaults by setting their preferences; or they can use the application defaults by selecting the Use Application Default check box where it’s available.
➤
To set application defaults:
1
Select Administration > Application Settings.
2
From the Show drop-down list, select Current Application Defaults.
3
Click Go.
4
Do any of the following:
●
●
Select the Application Settings tab to set e-mail options, select an alias table, and set options for member selection and workflow. For more information on these options, see the Hyperion System 9 Planning User’s Guide or Web help system.
Select the Display Options tab to set options for number formatting, page selection, warnings for large data forms, and the number of dimensions to show on a page. For more information on these options, see the Hyperion System 9 Planning User’s Guide or Web help system.
5
Click Save.
When saved, these settings become the application defaults, which other users can select with the Use Application Defaults check box.
About Setting Preferences
315
Specifying System Settings
Administrators can specify certain settings to be used across the current application. Nonadministrators do not have access to such application-wide settings. Only the application owner can set two of the system settings: E-mail Server and the Password for Synchronizing
With Analytic Services.
➤
To specify system settings:
1
Select Administration > Application Settings.
2
From the Show drop-down list, select Advanced Settings.
3
Click Go.
4
Select the System Settings tab.
5
Set any of the following options:
Table 54
Options for System Settings
Option
E-mail Server
E-mail Character Set
Task List Date Format
Shared Services URL
Display Users’ Full Names
Description
In the text box, type the machine name of the server hosting e-mail services for the application users. For example: mail.hyperion.com
From the drop-down list, select one of the following to set the character set used for e-mail messages:
UTF-8 - to use the Unicode encoding format (this is the default)
Regional Setting - to use the system's regional setting
From the drop-down list, select an option to set the date format for tasks in a task list: MM-DD-YYYY or DD-MM-YYYY.
Note: This setting changes the date display format only in the Edit Task dialog box.On all task list pages, the date display depends on the locale settings of your system.
In the text box, type the URL for the Shared Services server and click Register
Shared Services. See “Registering Applications” on page 192 .
Select Yes to show users’ full names (for example, John Smith) in addition to their user name (for example, JSmith) when working with users. Select No to suppress the display of users’ full names.
Note: If the Display Users' Full Names check box is selected, you cannot have two users with identical full names. If you try to add a user with the same full name as an existing user, an error message is displayed.
Enable Use of the Application for Determine whether users can access the application when it is in maintenance mode, such as during backups. Select Owner, Administrators, or All users to give access to the application owner, to administrators, or to all users. See
“Limiting Use of an Application During Maintenance” on page 317
.
Select User Assign an administrator to be the application owner. (By default, the person who creates the application is the application owner. However, the owner may grant ownership to another administrator.)
316
Working With Applications
6
Repeat the above steps for each application for which you want to specify system settings.
Limiting Use of an Application During Maintenance
Application owners or administrators can grant and withdraw access to the application for other users by using the Enable Use of the Application For option. If users are logged on to the application and an administrator withdraws their access to the application, the users receive a message and are forced off the system. This option is useful when an administrator needs to perform system maintenance or backups, during which no users should be logged on to the application.
Note:
Restricting use of an application as described here has no effect on users of Smart View.
➤
To grant or withdraw users’ access to the application:
1
Select Administration > Application Settings.
2
From the Show drop-down list, select Advanced Settings.
3
Click Go.
4
Select the System Settings tab.
5
Under Application Maintenance Mode, select one of the following settings from the Enable Use of the
Application For drop-down list:
●
●
●
All users – Enables all users to log on to the application or to continue working with the application if they are currently logged on.
Administrators – Enables only other administrators to log on to the application.
Interactive users and planner user types are forced off and prevented from logging on to the application until the option is set back to All Users.
Owner – Enables only the owner of the application to log on to the application. All other users are prevented from logging on to the application or, if they are currently logged on, they are forced off the system until the option is set back to All Users or Administrators.
This option is available only to the application owner; only the application owner can restrict other administrators from using the application.
6
If your selection is more restrictive than the current setting, you are asked to confirm your selection. Click
OK if you intend to limit access to the application.
7 Click Save.
Specifying Custom Tools
Administrators can set up custom tools, or links, for users on the Tools page. If users have access to a link, they can select Tools > Links, and then click the link to open the page in a secondary window in their browser. For information on setting up printing options, see
“Customizing the Planning Tools Page” on page 340
.
About Setting Preferences
317
➤
To specify custom tools:
1
Select Administration > Application Settings.
2
From the Show drop-down list, select Advanced Settings.
3
Click Go.
4
Select the Custom Tools tab.
5
For each link that you want to set up, do the following:
●
●
●
For Name, enter the name that you want to display for the link.
For URL, enter a fully qualified URL, such as http://www.hyperion.com
For User Type, select the type of user that you want to access the link, such as Basic or
Administrator.
6 Click Save.
Setting Display Options
In addition to the various display options described in the Hyperion System 9 Planning User’s
Guide and Web help system, administrators can also set how many members to display on each page when working on the Dimensions tab.
➤
To specify how many dimension members to display per page:
1 Select File > Preferences, and then select the Display Options tab.
2
Enter a value for the Show __ Members on Each Dimensions Page option.
Planner user types do not see this option.
3
Click Save.
Setting Printing Options
For information on setting up printing options, see
“Setting a Data Form’s Display Options” on page 264
Deleting Application Information Using SQL
Planning provides several SQL files that enable you to delete certain information associated with an application:
●
●
Account annotations. See
“Deleting Account Annotations” on page 319 .
Supporting detail associated with a scenario. See “Deleting Supporting Detail Associated
.
318
Working With Applications
Deleting Account Annotations
The aadelete.sql
file, installed in the
Utils
directory, enables you to delete account annotations. It includes SQL queries that delete annotations for a selected account name.
➤
To delete account annotations associated with an account name:
1
Stop the Web application server.
2
Update the SQL queries section of the aadelete.sql
file that corresponds to your type of relational database by substituting the name of the account whose annotations you want to delete.
3
Run the queries in the aadelete.sql
file that are appropriate for your relational database.
Example of Deleting Account Annotations
In the following example, all account annotation for an account named Account1 is deleted:
DELETE
FROM HSP_ACCOUNT_DESC
WHERE ACCOUNT_ID=(SELECT OBJECT_ID FROM HSP_OBJECT
WHERE OBJECT_NAME='ACCOUNT1')
INSERT INTO HSP_ACTION
(FROM_ID, TO_ID, ACTION_ID, OBJECT_TYPE, MESSAGE, ACTION_TIME,
PRIMARY_KEY) VALUES (0,0,2,18,NULL,GETDATE(),NULL)
Deleting Supporting Detail Associated With a Scenario
The sddelete.sql
file, installed in the
Utils
directory, enables you to delete supporting detail that is associated with a scenario. It includes SQL queries that delete supporting detail for a selected scenario.
➤
To delete supporting detail associated with a particular scenario:
1
Stop the Web application server.
2
Update the SQL queries section of the sddelete.sql file that corresponds to your type of relational database by substituting the name of the scenario whose supporting detail you want to delete.
3
Run the queries in the sddelete.sql
file that are appropriate for your relational database.
4
Start the Web application server.
Deleting Application Information Using SQL
319
Example of Deleting Supporting Detail Associated With a Scenario
In the following example, all supporting detail of a scenario named Actual is deleted:
DELETE
FROM HSP_COLUMN_DETAIL_ITEM
WHERE DETAIL_ID IN
(SELECT DETAIL_ID
FROM HSP_COLUMN_DETAIL
WHERE DIM1 =
(SELECT OBJECT_ID
FROM HSP_OBJECT
WHERE OBJECT_NAME ='ACTUAL'));
DELETE
FROM HSP_COLUMN_DETAIL
WHERE DIM1 =
(SELECT OBJECT_ID
FROM HSP_OBJECT
WHERE object_name ='Actual');
Deleting Shared Descendants Using a Utility
●
●
Planning includes a utility—
DeleteSharedDescendants
—that enables you, outside of
Planning, to delete all shared dimension members that are descendants of a given member. The
DeleteSharedDescendants utility enables you to delete shared Entity, Account, and userdefined dimension members. All shared descendant members, not just the immediate children of the member specified, are deleted.
You use the
DeleteSharedDescendants utility through a command line interface. Only administrators can run this utility.
When working with the
DeleteSharedDescendants utility, here are some points to keep in mind:
Before you launch this utility, close the Manage Database task on the Planning Desktop.
If the application server, HBR Service, or Hyperion RMI service is running when the
Delete Shared Descendants
utility is launched, you may see some java.rm
i or “Port already in use:11333” errors. They do not affect the functionality of this utility.
➤
To use the
DeleteSharedDescendants utility:
1
Launch the
DeleteSharedDescendants.cmd
file from the
Utils
directory, using the following syntax:
If you installed Planning in the default location, the
Utils
directory is in the following path:
<
drive letter
>:
\Hyperion\HyperionPlanning\Utils
.
DeleteSharedDescendants <servername> <username> <password>
<application> <member>
320
Working With Applications
Table 55
DeleteSharedDescendants Utility Parameters
Variable
<servername>
<username>
<password>
<application>
<member>
Description
The server name on which the Planning application resides. If the application resides on a remote server, the
HspJsHome.properties file used by
DeleteSharedDescendants.cmd
must contain the appropriate remote server references for this application. For information on locating the properties file, see
“Default Location of the Properties File” on page 45
.
The name of the Planning administrator
The Planning administrator password
The name of the Planning application that contains the shared dimension members to delete.
The member whose shared descendants you want to delete.
Note: If a member name contains a space, you must surround it by quotation marks (for example, “Member One”). If the shared member itself is specified in the command line, a message “No shared descendants of <member_name> were found” is displayed.
For example:
●
●
DeleteSharedDescendants localhost admin password BUDGET account200
For information on the results of running the utility, check the two log files, which are generated in the same directory as the utility:
DeleteSharedDescendants.log
, which contains status messages.
DeleteSharedDescendantsExceptions.log
, which contains error messages.
Note:
If you run this utility while the manage Database task is open on the Planning Desktop, there is no error message displayed, but the member is not deleted from the application. The LOG and CMD files in the Utils directory show that one shared member was found, but 0 shared members were deleted.
Deleting Shared Descendants Using a Utility
321
322
Working With Applications
C h a p t e r
14
Menus, Smart Lists, UDAs, and
Formulas
This section describes how to set up and customize menus, Smart Lists, UDAs, and member formulas in a Planning application.
In This Chapter
Menus, Smart Lists, UDAs, and Formulas
323
Working with Menus
Administrators can set up right-click menus and associate them with data forms to enable users to click rows or columns in a data form and select menu items to do such things as:
●
●
●
●
Launch another application
Launch a URL
Launch a business rule, with or without runtime prompts
Move to another data form
Move directly to the Manage Process page with a predefined scenario and version
●
To support context-sensitive actions, the context of the right-click is relayed to the next action.
Planning passes the following context: the POV and the Page, the member the user clicked on, and—if you clicked on a row—the members to the left on the row, or—if you clicked on a column—the members above the column.
Use the Manage Menus page to create, edit, and delete menus. The page lists menus defined in the application.
Notes:
●
●
When designing data forms, on the Other Options tab, you select which menus are available
for Data Form menu item types. See “Setting a Data Form’s Display Options” on page 264
.
As you update your application, update the appropriate menus. For example, if you delete a business that a menu references, remove it from the menu.
➤
To create, edit, or delete a menu:
1
Select Administration > Manage Menus.
2
Perform an action:
●
●
●
To create a menu, click Create, enter the name for the menu, and click OK.
To change a menu, select it and click Edit.
To delete menus, select them, click Delete, and click OK.
To add, change, or delete menu items, see “Working with Menu Items” on page 324 .
Working with Menu Items
Use Edit Menu to add or change items on a menu. Edit Menu displays the menu items on the current menu, including their names, labels, required dimensions, icon, and its type—URL,
Data Form, Business Rule, Workflow, or Menu Header.
➤
To manage items on a menu:
1
Select Administration > Manage Menus.
2
Select a menu and click Edit.
324
Menus, Smart Lists, UDAs, and Formulas
3
First time only: To add the first item to the menu, click Add Child and Save.
4
Select a menu item and perform an action:
●
●
●
To add a menu item below the selected item, click Add Child (available only for Menu
Header menu types).
To add a menu item at the same level as the selected item, click Add Sibling.
To edit a menu item, click Edit.
●
●
To delete a menu item, click Delete.
To change the order of menu items within the same level, click the Up or Down Arrow. You can move multiple items simultaneously.
Use the Edit Menu Item dialog box to define the menu item properties. See
Changing Menu Items” on page 325
.
5
Click Save.
Click Save As to save the current selections under a new menu name.
Adding or Changing Menu Items
Use the Edit or Add Menu Item dialog box to define menu item properties.
➤
To define a menu item:
1
Select Administration > Manage Menus.
2
Select a menu and click Edit.
3 Select the menu item and click either:
●
●
Edit
.
Add Sibling
.
4
Define the menu item:
Item
Menu Item
Label
Icon
Description
Enter a unique name that contains:
●
Only alphanumeric and underscore characters (for example: Status)
●
No special characters or spaces
Enter the text to display when the menu is selected. Spaces and special characters are allowed.
Menu labels are displayed in the user interface. Labels can either be text or they can reference a resource variable by name. For example, to set a menu’s label to File, either set it to File directly or set it to the name of a resource—such as LABEL_FILE—which may be localized. For information on localizing labels, see
Chapter 15, “Customizing Planning Web
Optional: In context of the Planning server, enter the path and filename to a graphic to display next to the menu. For example:
/HyperionPlanning/Images/globe.gif
Working with Menus
325
Item
Type
Required Dimension
Description
Select the menu item type:
●
●
Data Form—launch a selected data form. Note: The member selection context for the member, page, and POV is retained when the user right-clicks in the source data form so that if the target data form contains any of these dimension members on the page, its page is set to match the context.
URL—navigate the user to the specified URL
●
●
Business Rule—launch the selected business rule
Workflow—move the user to the Manage Process page to work with a planning unit
●
Menu Header—create a menu under which you can create children menu items. To display a separator bar on the menu at this item, enter a single hyphen as the Label. In this case, the Required Dimension list is not available.
Your selection determines the available Properties. For example, no properties are available for the Menu Header type.
Select the dimension for which the menu item is displayed. For example, if you select
Account, when users click into Account members on a data form, this menu item is available with a right-click. Selecting No Required Dimension makes the menu available whenever the user right-clicks in the data form, regardless of the current dimension member.
5
Define menu item properties, which differ depending on the menu item type:
Type
Data Form
URL
Options
1. From Data Form Folder, select the folder containing the destination data form.
2. From Data Form, select the data form.
1. In URL, enter the complete URL to which to direct the user. For example: http://<
server name
>/HFM/Logon/HsvLogon.asp
.
2. Select Use Single Sign-on to append the SSO token to the URL.
3. Select Launch in a Separate Window to launch the URL in a separate window than
Planning’s main window.
326
Menus, Smart Lists, UDAs, and Formulas
Type
Business Rule
Workflow
Options
1. From Plan Type, select the plan type for which the business rule is available.
2. From Business Rules, select the business rule to launch.
3. From View Type, select how to display runtime prompt pages:
❍
❍
Classic View—use the default Planning view
Streamline View—display each runtime prompt on a separate line instead of a section; eliminate icon and reduce screen text
4. Optional: In Window Title, enter a title to display instead of Runtime Prompts.
5. Optional: In OK Button Label, enter the text to display for the OK button.
6. Optional: In Cancel Button Label, enter the text to display for the Cancel button.
7. Optional: Select Launch in a Separate Window to launch the business rule in a separate window than Planning’s main window.
Specify the planning unit to which the user is directed by selecting a scenario and a version.
6
Click Save.
Working with Smart Lists
Using Smart Lists, administrators set up custom drop-down lists that users access from data form cells. When clicking into cells whose members are associated with a Smart List (as a member property), users select an item from the drop-down list instead of entering data; in fact, users cannot type in a cell that contains a Smart List. Smart Lists display in cells as down arrows that expand into Smart Lists when users click into the cells.
For example, you could create a drop-down Smart List called Justification that provides selections for Research, Customer Feedback, and Expansion. When users click into Account cells named Reason (whose members are associated with the Justification Smart List), they click the down arrow, which expands into a drop-down list with the following selections:
●
●
●
●
●
●
Research
Customer Feedback
Expansion
Users select one of the Smart List options as the value for the cell.
Use the Smart Lists page to create, edit, and delete Smart Lists. The page lists Smart Lists defined in the application.
An overview to using Smart Lists:
Define Smart Lists, described in this section.
Associate Smart Lists with members (see Table 35, “Member Properties,” on page 146 ).
Select dimensions for which Smart Lists are displayed (see “Setting the Evaluation Order of
).
Working with Smart Lists
327
●
●
●
Optional
: Turn Smart Lists on or off for various data forms. See
Display Options” on page 264 .
Optional
: Use Smart List values in member formulas. See
“Including Smart List Values as
.
Optional
: Set how #missing cells associated with Smart Lists display in data forms. See
“Displaying #Missing with Smart Lists” on page 331 .
➤
To create, edit, or delete Smart Lists:
1
Select Administration > Manage Smart Lists.
2
Perform an action:
●
●
To create a Smart List, click Create, enter the name, and click OK.
To change a Smart List, select it and click Edit.
To delete Smart Lists, select them, click Delete and OK.
●
See
“Adding or Changing Smart List Properties” on page 328 and
.
Note:
Data cells can display only one Smart List. If multiple Smart Lists intersect at cells, set which one takes precedence. See
“Setting the Evaluation Order of Smart Lists” on page 330
.
Adding or Changing Smart List Properties
Use the Edit Smart List Properties tab to set Smart List properties.
➤
To set Smart List properties:
1
Select Administration > Manage Smart Lists.
2 Select a Smart List and click Edit.
3
Define Smart List properties on the Properties tab:
Property
Smart List
Label
Display Order
Description
Enter a unique name that contains:
●
Only alphanumeric and underscore characters (for example: Position)
●
No special characters or spaces
Smart List names can be referenced in formula expressions (see “Working with
Formula Expressions” on page 334
).
Enter the text to display when the Smart List is selected. Spaces and special characters are allowed.
Note: Smart List labels can reference a resource, which can be translated into different languages. See
“About Customizing Text, Color, and Images” on page 346
.
How Smart Lists are sorted in the drop-down list: by ID, Name, or Label
328
Menus, Smart Lists, UDAs, and Formulas
Property
#Missing Drop-Down Label
#Missing Data Form Label
Automatically Generate ID
Description
Enter a label (for example, “No Justification”) to be displayed as an entry in the
Smart List whose value is #missing.
Notes:
●
It displays as the first selection in the Smart List drop-down, allowing
#missing as a valid selection in the data form.
●
When the cell is not in focus, this label displays only if Drop-Down Setting is selected in the next option. Otherwise, #missing or a blank cell is displayed, depending on the Display Missing Values As Blank selection for the data form
).
●
#missing labels determine only the display of cells with #missing data;
#missing remains the stored value.
See “Displaying #Missing with Smart Lists” on page 331
.
Determines how #missing vales are represented in cells associated with Smart
Lists. Options:
●
●
Drop-Down Setting—displays the label set in #Missing Drop-Down Label.
Data Form Setting—displays #missing or leaves cells blank, depending on the
not the focus. When the cell is in focus, the Smart List item that is selected from the drop-down is displayed.
See “Displaying #Missing with Smart Lists” on page 331
.
Select to automatically generate the numeric ID for each Smart List entry. If you do not select this option, you can customize Smart List ID values. See
Changing Smart List Entries” on page 329
.
4 Click Save.
5
Select the Entries tab.
Use the Entries tab to define the selections on the Smart Lists. See “Adding or Changing Smart
.
Adding or Changing Smart List Entries
Use the Edit /Add Smart Lists Entries tab to define the selections in the Smart List.
➤
To define Smart List entries:
1
Select Administration > Manage Smart Lists.
2 Select a Smart List and click Edit.
3
On the Entries tab, define drop-down list items:
●
●
For first items only
: enter information into the first row.
To add an item, click Add and fill in its row.
Working with Smart Lists
329
●
●
To delete an item, select it and click Delete.
To edit an item, change the information in its row:
Entry Property
ID
Name
Label
Description
Unique number that sets the order for the displayed entry.
Note: Customizable only if Automatically Generate ID is not selected on the Properties tab.
Unique alphanumeric name that contains:
●
●
Only alphanumeric and underscore characters (for example:
Customer_Feedback)
No special characters or spaces
Displayed text for the Smart List entry on the drop-down list (for example: Customer Feedback).
Note:
Items highlighted in red are duplicates.
4
Perform an action:
●
●
Click Save.
Select the Preview tab. See
“Previewing Smart Lists” on page 330
.
Previewing Smart Lists
Preview the defined Smart List on the Preview tab. The tab shows the Smart List:
●
●
As displayed in a drop-down list
As displayed in a table
See
“Working with Smart Lists” on page 327 .
Setting the Evaluation Order of Smart Lists
You associate Smart Lists to members as a member property (see Table 35, “Member
Properties,” on page 146 ). Use the Smart List Evaluation Order tab to turn those properties on
or off for dimensions. On it, you control:
●
●
For each plan type, which dimensions display Smart Lists in data forms. If no dimensions are selected for a plan type, no Smart Lists are displayed.
Which Smart List takes precedence when multiple Smart Lists intersect.
➤
To turn Smart Lists on or off for dimensions and set their evaluation order:
1
Select Administration > Manage Smart Lists.
330
Menus, Smart Lists, UDAs, and Formulas
2
Select the Smart List Evaluation Order tab.
3
Select the plan type and click Go.
4
From Available Dimensions, select which dimensions display Smart Lists by moving them to Selected
Dimensions:
●
moves the selected dimensions
●
moves all dimensions
●
● removes the selected dimensions
removes all dimensions
Note:
If there are no dimensions selected, no Smart Lists are available for the selected plan type. While you can select multiple dimensions per plan type, for ease of use, Hyperion recommends selecting one dimension per plan type.
5
For multiple dimensions, set the order of precedence for Smart Lists among the selected dimensions by clicking or .
Smart Lists associated with the first dimension in the list take precedence over Smart Lists associated with the subsequent dimensions.
6
Click Save.
7
Set which data forms use Smart Lists (see “Setting a Data Form’s Display Options” on page 264 ).
Displaying #Missing with Smart Lists
Administrators set the values that are displayed in Smart Lists and data cells, including what is displayed when there is no data in the cell. When there is no data in a cell, the cell can display no value (that is, the cell is blank), #missing, or—if for cells associated with Smart Lists— another value that you specify.
Use the following options to control the display of #missing in such cells when they are not in focus. To display #missing data in these cells as:
Blank
#missing
A custom label, such as “No
Change”
●
●
When designing the data form, select the option: Display Missing Values
as Blank.
When setting Smart List properties, select the option: Data Form Setting.
●
●
When designing the data form, do not select the option: Display Missing
Values as Blank.
When setting Smart List properties, select the option: Data Form Setting.
When setting the Smart List properties:
●
●
Enter the custom label in the #Missing Drop-Down Label field (for example,
No Change
).
Select the option: Drop-Down Setting.
Working with Smart Lists
331
See
“Adding or Changing Smart List Properties” on page 328 and
“Setting a Data Form’s Display Options” on page 264
.
Working with UDAs
You can use user-defined attributes (UDAs)—words or phrases describing a particular characteristic of members—within calc scripts, member formulas, and reports so that they return lists of members associated with the specified UDA. For example, say you have a
Product dimension with various product members. You could create a UDA called New
Products and base certain calculations only on new products. For information on creating and using UDAs, see the Hyperion System 9 BI+ Analytic Services Database Administrator’s Guide and Online Help.
UDAs are specific to dimensions. For example, creating a UDA for an Account member makes it available for any non-shared Account member. Deleting it removes it for all Account members. To make UDAs available for multiple dimensions, create the same UDA for multiple dimensions. For example, create a UDA named New for both Account and Entity dimensions to make the UDA named New available for Account and Entity members.
You create, change, and select UDAs for members from the UDA tab.
➤
To select UDAs for members:
1
Select Administration > Dimensions.
2
From the Dimension drop-down list, select the dimension for whose members you want to associate the
UDA.
3
From the dimension hierarchy, select any member and click Edit.
4
Select the UDA tab.
5
Optional: To create a new UDA, click Add.
See
.
6
Select UDAs for the member by moving them to Selected UDA and clicking Save:
●
moves the selected UDAs
● removes the selected UDAs
●
removes all UDAs
7
Optional: To undo your changes and restore the previous information, click Refresh.
Creating UDAs
On the Create a UDA dialog box, you name the new UDA. See “Working with UDAs” on page 332 .
332
Menus, Smart Lists, UDAs, and Formulas
➤
To create a UDA:
1
Navigate to the UDA tab, following the first four steps in
“Working with UDAs” on page 332
.
2
On the UDA tab, click Add.
3
Enter a name and click Save.
See
Changing UDAs
On the Modify UDA dialog box, you change UDA names.
➤
To change a UDA:
1
To navigate to the UDA tab, follow the first four steps in “Working with UDAs” on page 332 .
2
On the UDA tab, select a UDA and click Edit.
3
Change the name and click Save.
Deleting UDAs
Deleting a UDA removes it for the whole dimension.
➤
To delete a UDA:
1
Navigate to the UDA tab, following the first four steps in “Working with UDAs” on page 332 .
2
Select the UDA and click Delete.
Note:
If you delete a UDA, you must update all member formulas, calc scripts, and reports that reference it.
Working with Member Formulas
Using member formulas, you can combine operators, calculation functions, dimension and member names, and numeric constants to perform specific calculations on members. Member formulas can also include:
●
●
Any operator type, function, value, member name, UDA, and so on that is allowed in
Analytic Services formulas (see the Hyperion System 9 BI+ Analytic Services Database
Administrator’s Guide and Online Help)
Predefined Planning formula expressions—including Smart List values—that expand into
a formula or value upon database refresh (see “Working with Formula Expressions” on page 334 )
On the Member Formula tab, you define formulas for members.
Working with Member Formulas
333
➤
To define member formulas:
1
Select Administration > Dimensions.
2
From the Dimension drop-down list, select the dimension for whose member you want to add or change a formula.
3
Select the member.
4
Select the Member Formula tab.
5
In the text box, define formulas for the member.
See the Hyperion System 9 BI+ Analytic Services Database Administrator’s Guide for syntax,
.
6
Optional: To check the validity of the member formula, click Validate Member Formula and OK.
7 Click Save.
Before you click Save, clicking Refresh restores the previous member formula information.
See
“Viewing Details of Formula Validation” on page 334 .
Viewing Details of Formula Validation
The Status of Member Formula Validation dialog box displays details about the member formula validation.
➤
To view details of the member formula validation:
1
On Member Formulas, click Validate Member Formula.
2
If the member formula is not valid, click Show Details.
If the member formula is valid, Show Details is not selectable.
3 Click OK.
Working with Formula Expressions
Planning member formulas support Analytic Services native formulas and Planning formula expressions that are evaluated and expanded into Analytic Services code blocks when the database is refreshed. In these expressions, you can address Smart Lists by name, which
Planning replaces with their numerical values in calculations.
In the text box on the Member Formula tab, you can include predefined formula expressions in member formulas, and test them with the Validate Member Formula button. You can also load them using Hyperion Application Link or Shared Services.
The benefits of using these expressions are:
●
You can update the dimension outline without updating all the business rules and calc scripts that depend on the outline. Calculations become much more independent of specifics in the outline.
334
Menus, Smart Lists, UDAs, and Formulas
●
●
You can use Smart Lists as objects in calculations.
Performance is not decreased when you use formula expressions because they are run only when you refresh the database.
➤
To use a formula expression in a member formula:
1 Select Administration > Dimensions.
2
From the Dimension drop-down list, select the dimension for whose member you want to add or change a formula.
3 Select the member and click Edit.
4
Select the Member Formula tab.
5
In the text box, define formulas for the member.
You can include Planning formula expressions and Analytic Services native formulas in the member formula.
See the Hyperion System 9 BI+ Analytic Services Database Administrator’s Guide for syntax, rules, and usage on Analytic Services native formulas. See
“Formula Expressions” on page 336
for descriptions of the Planning formula expressions you can use in the member formula.
Note:
Planning provides predefined formula expressions that you can use in member formulas. You cannot edit or create your own formula expressions.
6
Optional: To check the validity of the member formula, click Validate Member Formula and OK.
7 Optional: If there are errors in the member formula, click Show Details to view a description of the errors.
8
Optional: Click Refresh to restore the previous member formula if you do not want to save the changes you made to the member formula.
9 Click Save.
Prerequisites
Before using formula expressions in member formulas, you should understand:
●
Analytic Services formulas and calculations
The application outline
●
For more information, see the Hyperion System 9 BI+ Analytic Services Database
Administrator’s Guide.
Syntax
Member formula expressions support functions and variables. Follow these syntax rules for functions and variables when you create formula expressions:
●
Enclose variables or properties with square brackets, [ ]. If you omit square brackets, the variable is treated as a native variable.
Working with Member Formulas
335
●
●
●
●
●
Enclose member names with quotation marks (for example, “Account 200”).
Characters in variables are case-insensitive, but cannot have extra spaces or characters such as the underscore ( _ ).
You can include subcalls to other functions within an expression.
Do not enter text where a number is required.
The order of the outline is important in a member formula. For example, do not reference a value that has not been calculated yet.
Including Smart List Values as Variables
You can include a Smart List as a variable in a formula expression.
For example, in the formula expression, “Status”= [Status.Departed]
“Status” is the member name, Status is the Smart List name, and Departed is a Smart List entry. If the Smart List ID for Departed is 2, Analytic Services replaces Status.Departed with 2 in the member formula (Planning treats Smart Lists as numbers). If the Smart List ID for
Departed is 2, Analytic Services puts 2 in the calculation and stores 2 in the database.
Write Smart Lists in this format: [SmartListName.SmartListEntry]
For information on setting up Smart Lists, see “Working with Smart Lists” on page 327
.
Formula Expressions
Planning formula expressions can include the following predefined variables and functions.
Table 56
Variables in Formula Expressions
Variable
OpenInputValueBlock
CloseInputValueBlock
NumberOfPeriodsInYear
NumberOfYears
Description
Generates an IF statement if the Planning application is a multi-currency application. Generates an empty string if the
Planning application is a single currency application.
Note: This variable is used with ClosedInputValueBlock.
Generates an End IF statement if the Planning application is a multi-currency application. Generates an empty string if the Planning application is a single currency application.
Note: This variable is used with OpenInputValueBlock.
Returns the number of time periods in the year
Returns the number of years in the application
336
Menus, Smart Lists, UDAs, and Formulas
Table 57
Functions in Formula Expressions
Function
Dimension(dimTag)
Period(periodName)
CrossRef(accountName)
CrossRef(accountName, prefix) getCalendarTPIndex() getFiscalTPIndex()
CYTD(memberName)
CYTD(memberName, calTpIndexName, fiscalTpIndexName)
Description
Returns the name of a predefined dimension. The dimtags are:
●
DIM_NAME_PERIOD
●
●
DIM_NAME_YEAR]
DIM_NAME_ACCOUNT
●
●
DIM_NAME_ENTITY
DIM_NAME_SCENARIO
●
●
DIM_NAME_VERSION
DIM_NAME_CURRENCY
●
●
●
●
Returns the specified period. The periodName options are:
●
FIRST_QTR_PERIOD
SECOND_QTR_PERIOD
THIRD_QTR_PERIOD
FOURTH_QTR_PERIOD
●
FIRST_PERIOD
LAST_PERIOD
Generates a cross reference for the account
Generates a cross-reference for the account. The account name contains a prefix that you define. The default prefix is
No, followed by a blank space and the account name. For example, No Salary.
Generates a member formula that returns an index for the time period; the index is based on the calendar year.
Generates a member formula that returns an index for the time period; the index is based on the fiscal year.
Generates a calendar year-to-date formula for the member
Generates a calendar year-to-date formula for:
●
The member
The time period index based on the calendar year
●
●
The time period index based on the fiscal year
Use this function when the members are renamed. The default member names are: “Cal TP-Index” and “Fiscal TP-
Index”.
Working with Member Formulas
337
Understanding Common Errors
Follow the rules of syntax carefully. (For more information, see
“Syntax” on page 335 .) If the
formula expression syntax contains errors, the error messages are returned after you validate the member formula. To get information about the error messages, click Show Details on the
Member Formula tab.
The most common error message you may receive when using formula expressions (excluding error messages generated by Analytic Administration Services) is a “Failed to execute” error message. This message is generated when you use one or more of the parameters in the expression incorrectly. Following is a list of the incorrect usages of parameters that generate a
“Failed to execute” error message:
●
●
●
●
●
You enter the wrong number of parameters in the formula expression.
You misspell the member name in the formula.
You do not surround the member name with quotation marks.
You misspell the function or variable name in the formula expression.
You include a number where a string is required.
338
Menus, Smart Lists, UDAs, and Formulas
C h a p t e r
15
Customizing Planning Web
Client
You can customize various different aspects of the Planning Web user interface:
●
●
●
●
●
Links on the Tools page
Style such as font size and alignment
Style of rows and column members in data forms
Text, images, and color
Workflow
In This Chapter
Customizing Planning Web Client
339
Customizing the Planning Tools Page
Administrators can customize the Planning Tools page by adding links to commonly used tools for analyzing, tracking, and reporting on planning data. Other Planning users can then select
Tools > Links, and click on links that launch associated tools. The customized links appear on the Planning Tools page, in the Tools: Analyze and Report section.
➤
To add a link to the Planning Tools page:
1
Select File > Preferences.
2
From the Show drop-down list, select Advanced Settings.
3
Click Go.
4
Select the Custom Tools tab.
5
In the Name text box, enter the name of the link that you want to display on the Tools > Links page.
6
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
7
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
8 When you are finished adding links, click Save.
Users can access the links that you set by selecting Tools > Links, and then clicking a link on the
Tools page in the Tools: Analyze and Report section.
Tip:
To revert to the previous settings, click Reset.
340
Customizing Planning Web Client
Customizing Cascading Style Sheets
In Planning, cascading style sheets help define the user interface (UI) themes, which control the appearance of the Planning product. You can customize a Planning cascading style sheet to meet the needs of your business environment. Some commonly implemented style sheet customizations include the following:
●
●
●
●
Changing font colors to add emphasis or create a color-coding scheme
Adjusting the background color of certain UI elements
Inserting your organization’s logo
Creating a different color scheme for the desktop
Before you customize a Planning cascading style sheet, ensure that you have basic knowledge of cascading style sheets and that you are familiar with style sheet editor tools. Some of the settings are necessary for the proper display of portions of the product.
Changes to cascading style sheets are made on the Web application server, so any changes affect all users connected to the Web application server. Style sheets are located in the
<DeploymentDirectory> for your Web application server. For information on where to find this directory for various Web application servers, see
“Default Location of Cascading Style Sheet
Planning primarily uses two cascading style sheets: a global sheet that defines Web UI elements common to multiple Hyperion products, and one that is specific to Planning. The global cascading style sheet is called global.css
.
The following table lists the major sections in the global.css
file, and shows the sections that Hyperion strongly recommends against customizing.
Table 58
Major Sections in the global.css File
Customizable Sections
Non-Navigation Styles
Tadpole Masthead
Tadpole Content Area
Tadpole Logon Styles
Tabs
Tab Anchor Tags
Tab Body
TaskTabs
Task Tab Body
Sections Not Recommended for Customizing
Tadpole Menubar
Tadpole Menuitem
Menu Styles (order is important)
Tadpole Minimized Masthead
Tadpole Toolbar
Tadpole Viewpane
Tadpole Tree
Customizing Cascading Style Sheets
341
Table 58
Major Sections in the global.css File (Continued)
Sections Not Recommended for Customizing Customizable Sections
Groupbox
Groupbox Anchor Tabs
Buttons
When Drawing Buttons in HTML
When Using Button Tag
When Using Input Tag
➤
To customize a cascading style sheet:
1
Create a new CSS file,
HspCustom.css
, in
<DeploymentDirectory>\custom.
The path for
<DeploymentDirectory>
depends on the Web application server you are using.
See
“Default Location of Cascading Style Sheet Files” on page 342
.
2
Copy global.css
and planning.css in the following directory:
<DeploymentDirectory>\ui_themes\tadpole\
.
3
Paste the CSS files into
<DeploymentDirectory>\custom\HspCustom.css
.
4
Make all changes to the
HspCustom.css file in the following directory:
<DeploymentDirectory>\custom
.
For information on customizing the styles in data forms to reflect members’ hierarchical positions within the row or column axis, see
“Customizing the Style of Row and Column
Members in Data Forms” on page 345
.
All Planning Web pages include a reference to the
HspCustom.css
file, and any settings made here override those in global.css
and planning.css
.
Default Location of Cascading Style Sheet Files
The cascading style sheets for Planning are located by default in the following directory:
<DeploymentDirectory>\ui_themes\tadpole
. The path for
<DeploymentDirectory> depends on which Web application server you are using.
For example, for Apache Tomcat 5.0.28, the files could be installed in the following location:
C:\Hyperion\HyperionPlanning\AppServer\InstalledApps\Tomcat\5.0.28\
Webapps\HyperionPlanning\ui_themes\tadpole
342
Customizing Planning Web Client
For information about the default directory of other Web application servers, see the following examples.
Example: Tomcat 5.0.28
C:\Hyperion\HyperionPlanning\AppServer\InstalledApps\Tomcat\5.0.28\
HyperionPlanning\webapps\HyperionPlanning
Example: WebSphere
C:\WebSphere\AppServer\installedApps\<server name>\
HyperionPlanning.ear\HyperionPlanning.war
Example: WebLogic 8.1
C:\Hyperion\HyperionPlanning\AppServer\InstalledApps\WebLogic\8.1\
HPDomain
Applications deployed with WebLogic are deployed in .EAR format. This does not leave an expanded version of the files where you can easily modify the contents. If you are using
WebLogic, you must extract the .EAR file, and then customize the settings. See “Customizing
Planning When Using WebLogic” on page 349
.
Modifying Cascading Style Sheets
Here are some helpful hints for working with Hyperion cascading style sheets:
●
●
●
●
●
●
●
●
●
Before making any changes to a cascading style sheet, copy the original version and make it easily accessible.
Styles that are common across multiple products can be found in the global.css
file.
Styles for products requiring unique styles can be found in the
<productname>.css file
.
Some of the user interface controls are components that are part of third-party technologies used in Hyperion products. Changing the styles of these third-party controls requires changes in all associated files.
Avoid making changes to styles that affect layout, including the following:
❍
❍
❍
❍
Padding
Borders
Text and Vertical Align
Position
❍
White-space
Changes to color
affects the color of fonts. Changes to background
affects the color of elements such as buttons.
To change the color of hyperlink text, use the hyperlink style ( a:link
, a:hover
, and a:visited
).
Carefully consider any changes to toolbar buttons, because the changes may require editing all of the buttons in the product.
Ηyperion toolbar buttons rely on a dark-blue background to be displayed properly.
Customizing Cascading Style Sheets
343
Customization Examples
This section provides topics on common customizations:
●
●
●
“Including Your Logo” on page 344
“Changing the Color of the Content Area Background” on page 344
“Changing the Color of Hyperlinks and Visited Hyperlinks” on page 345
Including Your Logo
You can update the global.css
file to use your organization’s logo or image.
➤
To include your logo:
1
Place the new image in the following directory:
<WebAppServer>\<ApplicationDirectory>\ui_themes\tadpole\images_global
2
Open the global.css
file using a style sheet editor tool.
3
In the Tadpole Masthead section of the global.css
file, change the reference to the image:
.masthead TD.co_brand {
background-image: URL("images_global/<image_name>.gif");
4
Open the BannerTop.jin file, and then make the same change to the
<td>
tag that has the following comment:
Insert Co-Brand Logo onto this TD
.
<!--Insert Co-Brand Logo onto this TD -->
<td class=”co_brand logo_padding”>
<img class=”co_brand” src=”<%=iconPath %>spacer.gif”/>
</td>
5
To change the image on the Logon screen to your organization’s logo or image, replace the logon_panel.jpg
file with the new image in the following directory:
<WebAppServer>\<ApplicationDirectory>\ui_themes\tadpole\images_global
Changing the Color of the Content Area Background
You can change the background color of the content area on the right side of the page by editing the Tadpole Logon Styles section of the global.css
file. The following table shows how to edit the file to change the background color of the content area from the default color to white.
344
Customizing Planning Web Client
Table 59
Changing the Color of the Content Area Background
Default Content Area Background
.content table.content {
background: #e5eaef;
}
White Content Area Background
.content table.content {
background: #ffffff;
}
Changing the Color of Hyperlinks and Visited Hyperlinks
You can change the color of hyperlinks and visited hyperlinks by editing the Non-Navigation
Styles section of the global.css
file. The following table shows how to edit the file to change the color of hyperlinks from the default black to red.
Table 60
Changing the Color of Hyperlinks and Visited Hyperlinks
Black Hyperlinks and Visited Hyperlinks
a:link, a:visited {
color: #000000;
}
Red Hyperlinks and Visited Hyperlinks
.content table.content {
background: #ff0000;
}
Customizing the Style of Row and Column Members in
Data Forms
You can customize the Planning cascading style sheets to display data forms with different styles for the levels of members in rows and columns, depending on their hierarchical position in the data form.
Keep the following points in mind when you customize the style of rows and column members:
●
●
●
●
●
These customized styles are applied regardless of which dimension is displayed in the data form.
Text alignment in rows is not supported.
The styles are based on members’ displayed hierarchical level, not necessarily the Analytic
Services relationships.
Setting large font sizes on a row impacts the row’s alignment.
The customized styles are not reflected when the data form is printed to a PDF file.
➤
To customize the style of row and column members:
1
Modify the planning.css
file using the instructions in
“Customizing Cascading Style Sheets” on page 341 .
2
In the planning.css
file, customize the following header tags:
Customizing the Style of Row and Column Members in Data Forms
345
Table 61
Header Tags in Planning.css File
Rows
rowHeader_0 rowHeader_1 rowHeader_2 rowHeader_3 rowHeader_4
Columns
columnHeader_0 columnHeader_1 columnHeader_2 columnHeader_3 columnHeader_4
The tags rowHeader_0
and columnHeader_0
affect the lowest-level class. The tags rowHeader_4
and columnHeader_4
affect the highest-level class. Members above level 4 display with the level 4 style.
About Customizing Text, Color, and Images
You can customize the text, colors, or images that appear in various locations throughout the
Planning Web interface. You can also localize text that is included in the interface. These topics explain how to customize resources:
●
●
●
●
●
“Customizing Text, Color, and Images” on page 346
“Customizing Text in Non-Latin Languages” on page 348
“Restricted Characters in Customized Messages” on page 349
“Customizing Planning When Using WebLogic” on page 349
“Customizing Planning When Using WebLogic and UNIX” on page 351
Customizing Text, Color, and Images
This topic describes how to customize text, color, and images for the following items in the
Planning Web interface:
●
●
Labels and messages, using
HspCustomMsgs_en.template
Customizable colors and images, using
HspCustomImgs_en.template
Whenever you add labels, you must add them to the
HspCustomMsgs
resource file. For example, when you add Smart Lists entries or menu items, include the new labels in the resource file. When your application is localized, update the corresponding resource file. For
346
Customizing Planning Web Client
example, to localize an application into three languages, add new labels to all three localized
HspCustomMsg
files (each with their language code in the filename) and include the translated words.
When you make changes in these files, keep the following points in mind:
●
●
●
●
●
●
●
You must avoid certain characters when customizing text or messages. See “Restricted
Characters in Customized Messages” on page 349
.
Some colors are named, and others are given as hex values or RGB values.
Image file names and the
Images
directory are case-sensitive on some Web application servers and operating systems.
You must store any new images that you add to the Web interface using
HspCustomImgs_en.properties in the
Images
directory. If Planning was installed using the default Hyperion Home directory, the
Images
directory is located in the following path:
<WebAppServer>\<applicationDirectory>\Images
The silent deployment implemented by WebLogic 8.1 does not extract files from the EAR and WAR archives. You must manually extract, modify, and then archive the customization
files. See “Customizing Planning When Using WebLogic” on page 349
.
To customize other types of images, see “Customizing Cascading Style Sheets” on page 341 .
The procedure describes how to customize the English messages in the
HspCustomMsgs_en
file. To localize the application, update the file for the appropriate language.
➤
To customize text, color, and images:
1
In the
Images
folder, locate the
HspCustomMsgs_en.template
file and the
HspCustomImgs_en.template
file.
If Planning was installed using the default Hyperion Home directory, the
HspCustomMsgs_en.template
and
HspCustomImgs_en.template files are located in the following path:
<DeploymentDirectory>\Images
For details about this path, see “Default Location of Cascading Style Sheet Files” on page 342
. If
you are using WebLogic, see “Default Location of the Properties File” on page 45
.
2
Copy and paste the
HspCustomMsgs_en.template file and the
HspCustomImgs_en.template
file to the same directory as the
HspJSHome.properties
file.
3
Rename the files as
HspCustomMsgs_en.properties
and
HspCustomImgs_en.properties
.
4
Make your changes in the
HspCustomMsgs_en.properties file and the
HspCustomImgs_en.properties
file.
Each line in the
HspCustomMsgs_en.properties
file represents a text resource that you can customize. Each line in the
HspCustomImgs_en.properties file represents a color or image resource that you can customize.
The lines start with the name of the resource, followed by an equal sign and the resource that you can customize. You do not need to include punctuation at the end of the line. Carriage returns signal the end of the resource.
About Customizing Text, Color, and Images
347
For example, you can change the Tools menu label used on the Tools > Links page from “Tools:
Analyze and Report” to “Tools: Additional Resources” by going to the following line in the
HspCustomMsgs_en.properties file:
LABEL_HOME_TOOLS=Tools: Analyze and Report and making the following modification:
LABEL_HOME_TOOLS=Tools: Additional Resources
5
When you are finished making changes to the .
properties
files, save your changes.
6
For the changes to take effect, stop and restart the Web application server.
Customizing Text in Non-Latin Languages
You can customize the text that appears in the Planning Web interface for languages that use different alphabets than English, such as Chinese, Russian, and Japanese.
To do this, use the native2ascii
program, which is included with the Sun JDK. Some application servers such as WebLogic install this program for you. If you do not have the native2ascii
program, you can 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 directory that contains your
HspJsHome.properties
file.
For the location of the properties file, see
“Default Location of the Properties File” on page 45 .
2
Rename the
HspCustomMsgs_en.template
file to 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 sample file for Russian into the directory that contains your
HspJsHome.properties
file:
@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 the
HspCustomMsgs_ru.properties file.
7
Restart the Web application server.
All characters should now display correctly. For a complete list of canonical encoding, refer to the following Web site: http://java.sun.com/j2se/1.3/docs/guide/intl/encoding.doc.html.
348
Customizing Planning Web Client
To generate a new .
properties
file, make any additional customization changes to the
.
source
file, and then run the .BAT file again.
Restricted Characters in Customized Messages
You can modify text strings to meet your company’s business needs. For example, you can customize messages with information to help planners complete their tasks. For best results,
Hyperion recommends that you avoid certain characters that can cause errors in custom messages. You might or might not receive errors when using these characters, depending on how the text string is used and whether the string is generated by Java or JavaScript. (In most cases, text messages are generated by Java, and pop-up boxes and some buttons are generated by JavaScript.)
For example, you can add the following string inside a JavaScript call: someJavaScript(“<%= HspMsgs.SOME_RESOURCE %>”);
If the string includes quotation marks (“), JavaScript reads it like this: someJavaScript(“some string with “quotes””);
Because JavaScript cannot parse double quotation marks, this results in errors.
The best practice is to avoid using the following characters in custom messages:
●
●
●
●
Single quotation marks (‘)
Double quotation marks (“)
Back slash (\)
Forward slash (/)
Customizing Planning When Using WebLogic
The silent deployment implemented by WebLogic 8.1 does not extract files from the EAR and
WAR archives. For this reason, you must manually extract, modify, and then archive the customization files.
The following procedure is for Windows. If you are using WebLogic with UNIX, see
“Customizing Planning When Using WebLogic and UNIX” on page 351 .
➤
To customize Planning with WebLogic and Windows:
1
Shut down the WebLogic Web application server.
2
Use winzip
or jar.exe
to extract
HyperionPlanning.ear to a temporary folder (for example,
C:\mytemp\ear
).
The default location of
HyperionPlanning.ear
is:
C:\Hyperion\HyperionPlanning\AppServer\InstallableApps\Common
3
In the temporary folder (for example, in
C:\mytemp\ear)
, extract
HyperionPlanning.war to another temporary folder (for example,
C:\mytemp\war
).
About Customizing Text, Color, and Images
349
4
Make a copy of the
HspCustomMsgs_en.template
and
HspCustomImgs_en.template
files, located in the folder
C:\mytemp\war\custom
.
5
Rename the files with the .
properties
extension (for example,
HspCustomMsgs_en.properties
and
HspCustomImgs_en.properties
).
6
Modify the files to include the customized messages and images.
For information on customizing these files, see step 4
in “Customizing Text, Color, and
.
7
Cut and paste the .
properties
files to the same folder as the
HspJSHome.properties
file.
For the location of the properties file, see
“Default Location of the Properties File” on page 45 .
8
To modify the style sheet that Planning uses: a.
Make a copy of the
HspStyle.css file located in the
C:\mytemp\war
folder, and then place it in the
C:\mytemp\war\custom
folder.
b. Rename the existing, empty
HspCustom.css file in this folder to
HspCustomx.css or completely delete this file. c.
Rename
HspStyle.css
to
HspCustom.css
and make all the necessary changes.
9
Create a folder called
Images
under
C:\mytemp\ear
, and then copy any customized image GIF files into the
C:\mytemp\ear\Images folder.
10 Create a folder called custom
under
C:\mytemp\ear
, and then copy the
HspCustom.css
file to
C:\mytemp\ear\custom
.
11
Add the customized CSS and GIF files into
HyperionPlanning.war
.
The instructions below use the jar.exe
tool to perform this step. Installing the WebLogic
Web application server puts the jar.exe
file in the
C:\bea\jdk131\bin
folder.
a.
Invoke the command line interface, and then navigate to the
C:\mytemp\ear
folder.
b. Type the following command: c:\bea\jdk131\bin\jar uvf HyperionPlanning.war Images\*.gif
For example: c:\mytemp\ear>c:\bea\jdk131\bin\jar uvf HyperionPlanning.war
Images\*.gif
c.
Type the following command: c:\bea\jdk131\bin\jar uvf HyperionPlanning.war custom\*.css
For example: c:\mytemp\ear>c:\bea\jdk131\bin\jar uvf HyperionPlanning.war custom\*.css
12 Add the updated WAR file back into the EAR file.
a.
If the command line is not already at this location: invoke the command line interface and navigate to the
C:\mytemp\ear
folder.
b. Type the following command:
350
Customizing Planning Web Client
c:\bea\jdk131\bin\jar uvf c:\bea\Hyperion\applications\HyperionPlanning.ear
HyperionPlanning.war
For example: c:\mytemp\ear>c:\bea\jdk131\bin\jar uvf c:\bea\Hyperion\applications\HyperionPlanning.ear
HyperionPlanning.war
13
Restart the WebLogic Web application server to redeploy
HyperionPlanning.ear
into WebLogic.
After you perform this procedure, you can make any modifications to messages directly in the
HspCustomMsgs_en.properties
file without going through the steps again. If the images exist in the
Images
folder, you can make any changes to the product areas where they are used directly in the
HspCustomImgs_en.properties
file without repeating these steps. However, if you add new images or modify the style sheet, you must perform these steps again.
Customizing Planning When Using WebLogic and UNIX
The silent deployment implemented by WebLogic 8.1 does not extract files from the EAR and
WAR archives. For this reason, you must manually extract, modify, and then archive the customization files.
If you are running WebLogic on a UNIX machine, perform the following steps to customize the text, colors, and images of the Planning Web interface.
➤
To customize Planning with WebLogic and UNIX:
1
Manually decompress the
HyperionPlanning.ear
file.
Locate the
HspCustomMsgs_en.template
file in the following directory:
<DeploymentDirectory>/Common
.
For example, the default location is:
Hyperion/HyperionPlanning/AppServer/InstallableApps/Common
2
Copy and paste the
HspCustomMsgs_en.template
file to the directory where the
HspJSHome.properties
file is located.
The location of this file depends on where you decompressed the
HyperionPlanning.ear
file. See
“Default Location of the Properties File” on page 45
.
3
Rename the file to
HspCustomMsgs_en.properties
.
4
Update the
HspCustomMsgs_en.properties
file, and then save your changes.
For information on customizing this file, see
“Customizing Text, Color, and Images” on page 346 .
About Customizing Text, Color, and Images
351
Customizing the Colors, States, and Actions for Process Status
You can customize the color, state name, and action name for the process status in Planning workflow tasks. The following procedures require some knowledge of how to maintain and manipulate the relational database you are using:
●
●
●
“Customizing the Colors” on page 352
“Customizing the States” on page 353
“Customizing the Actions” on page 354
Customizing the Colors
By default, each process status state in the Workflow Tasks page is black. However, you can customize each state to display in a different color (for example, red for Not Started, green for
First Pass, and so on). Valid colors include all named colors, meaning colors that browsers recognize. Refer to the Microsoft Web site for an up-to-date list of supported named colors.
The information for process status state colors is stored in the
HSP_PM_STATES
table in the
COLOR
column. You must run statements for your particular relational database to change the color value in the database.
After you customize the colors as described in this topic, restart the Web application server.
Example: 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, and the color. By default, the value of the color is
<NULL>
, which converts to black.
Note the state_id
of the process status state for which you want to change the color, and then run the following query:
UPDATE HSP_PM_STATES SET COLOR = '<new color>' WHERE STATE_ID =
<state_id>
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 must issue a COMMIT; command to commit the transaction.
352
Customizing Planning Web Client
Customizing the States
You can customize each process status state to display a different name. For example, you can change “Approved” to “Promoted.” By default, the following process status states are available for users:
●
●
●
●
●
●
Not Started
First Pass
Approved
Not Signed Off
Under Review
Signed Off
The process status state information is stored in the
HSP_PM_STATES
table in the
NAME column. You must run statements for your relational database to change the state value in the database.
Example: SQL Relational Database
Get a list of all the available process status states and their current names by running the following query: select * from hsp_pm_states
This returns various information, including the state_id
, the name of the process status state, and the color.
Note the state_id
of the process status state for which you want to change the name, and then run the following query:
UPDATE HSP_PM_STATES SET NAME = '<NewName>' WHERE STATE_ID = <state_id>
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 must issue a COMMIT; command to commit the transaction.
Customizing the Colors, States, and Actions for Process Status
353
Customizing the Actions
You can customize each process status action to display a different name. For example, you can change “Approved” to “Promoted.” By default, the following process status actions are available for users:
●
●
●
●
●
●
Start
Exclude
Reject
Approve
Sign Off
Promote
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.
Example: 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
and the name of the process status action.
Note the state_id
of the process status action for which you want to change the name, and then run the following query:
UPDATE HSP_PM_ACTIONS SET NAME = '<NewName>' WHERE ACTION_ID =
<action_id>
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 must issue a COMMIT; command to commit the transaction.
354
Customizing Planning Web Client
Troubleshooting
C h a p t e r
16
This section describes how to resolve some common issues.
In This Chapter
Troubleshooting
355
Calculation Script is Too Long or Complex
Scenario:
Using the Currency Conversion Calcscript option on the Manage Database task on the
Planning Desktop, you generate application-wide calc scripts that you can launch from the
Web to convert currencies. When generating such calc scripts, if you get the error message,
“Calculation script is too long or complex,” the calc script you are trying to create exceeds the
64K limit. \
Solution:
➤
To solve this problem:
1
Limit the calc script to only one scenario.
If the calc script is successfully generated, skip to step 3.
2 If you still get the error message, then limit the calc script to only one reporting currency.
If you are successful in generating the calc script, try selecting two reporting currencies. If that works, then continue adding reporting currencies until you again get the error message. Then skip to step 3.
If you are unsuccessful in generating the calc script with only one reporting currency, then you should remove some currencies from the application.
3 Use the Currency Conversion Calcscript option in the Manage Database task to generate as many other, smaller currency conversion calc scripts as you need to include the desired scenarios, reporting currencies, and versions.
Cannot Find Member
Scenario:
Solution:
When trying to refresh the database, you receive the error message, “Cannot Find Member xxx.”
Perform a full refresh (instead of an incremental refresh) on the database. You can do this either from the Manage Database window on the Planning Desktop, or with the appscheduler.exe utility’s
/RA
option.
356
Cannot Process Request
Scenario:
Solution:
Users trying to work with an application (for example, those trying to edit a user or assign access) receive the error message, “Cannot process your request because the application is being refreshed.” While an application database is being created or refreshed (including a refresh that is scheduled with the AppScheduler utility), aspects of the application are locked and users are unable to change any of the following application items:
●
●
●
●
●
●
●
●
●
All dimensions and members
Users
Groups
Security
Aliases
Alias tables
Exchange rates
Year
Period
Wait until the database has been created or refreshed.
Conflicting Change by Users
Scenario:
Solution:
When you are trying to change data, you receive the error message: “You are trying to change data that has been changed by a user on another server.”
The data you tried to change is currently being changed by a user on another server. Wait a few seconds and try again. If you continue to get this message, try closing the page and then reopen it. For example, if you are using the Edit User dialog box when you get this error, close the Edit
User dialog box and then click Edit User again. If the error message continues, restart the Web application server.
Conflicting Change by Users
357
Copy Version Error
Scenario:
Solution:
After using Copy Version with a large number of members selected, the following error message is displayed: "An error occurred when running specified calc script, please check logs for details." The log for the Web application server contains the following error message:
"com.hyperion.planning.olap.HspOlapException: The length of the calc script exceeds the maximum allowed length."
Copy Version is accomplished through a calculation script, and Analytic Services limits the size of calculation scripts to 64K. When copying a large number of members, the 64K limit can be reached, which causes the Copy Version to fail. To avoid this problem, select fewer members to be copied with Copy Version.
To prevent a failed Copy Version, you can roughly estimate how many members you can successfully copy. Because member names are used in the script, the 64K limit must be able to accommodate the number of members being copied and the length of the member names. For example, if the selected member names are an average of 10 characters long, then fewer than
6,400 members can be copied. The script also includes syntax characters (for example, the calc script command itself and a comma for each member name). So, assuming a calc script command length of 500 characters, you can roughly estimate how many members can be successfully copied with Copy Version by using the following formula:
(Number of members * Average length of members' names) + Number of members + 500 <=
64,000
Currency Conversion Calc Script Failed
Scenario:
Solution:
When verifying your calc scripts, the following error message displays 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.”
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.
Database Locked by Another Administrator
Scenario:
Solution:
Occasionally, Planning applications may become locked. This can be caused by events such as abnormally exiting the application and Planning.
For information on how to unlock an application, see
“Unlocking Applications” on page 63 .
358
Exiting Planning
Scenario:
In some cases, multiple instances of Planning processes may occur on the Planning server, especially if the processes are not completed between logon sessions, or if both the Web and NT client are opened simultaneously. This could result in the inability to refresh data and unnecessarily reduce available memory.
Solution:
After all Planning Web users are logged off, the administrator needs to manually remove these processes from the Planning server.
➤
To stop Planning processes manually:
1
Open Task Manager by right-clicking on the Windows task bar and selecting Task Manager.
2
Select the Processes tab.
3
Sort by clicking the Image Name column heading.
4
End all instances of these processes:
●
●
HspDS.exe
HSXSER~1.EXE (you may see a different number)
Exiting Planning
359
500 Error Message
Scenario:
Solution:
You may receive a 500 ERROR message on a data 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.
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 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 WebSphere:
1
Highlight the default server in the administrator console.
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:
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 Planning and Hyperion System 9 BI+ Financial Reporting.
echo on
"%JAVA_HOME%\bin\java" -hotspot -ms256m -mx256m -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
Manage Database Errors
Scenario:
Solution:
Manage database errors can occur when the 8.3 naming convention is not used. When the application database is created or refreshed, the error may display as: “Manage Database Errors detected (Start 1060044): Could not open outline -2147218904
.”
To resolve Manage Database errors, you may need to redirect the operating system environment variables. Analytic Services requires an 8.3 character-naming convention for the
Temp and Tmp environment variables in the operating system. Follow the steps below to check the naming convention and re-assign these variables if needed.
360
File Naming Convention
Ensure that you are logged on to the 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, complete one of the following procedures:
➤
To check the environment variables for Windows 2000:
1
Close Planning.
2 Close Analytic Services.
3
On the Windows desktop, right-click My Computer.
4
Select Properties.
5 Select the Advanced tab.
6
Select Environment Variables.
7
Change the settings for Temp and Tmp in the user variable to the 8.3 naming convention.
For example,
C:\Temp
8
Open Essbase Administration Services for Essbase 7/Analytic Administration Services for Analytic Services
9.2, and then open the outline.
9
Close Essbase Administration Services for Essbase 7/Analytic Administration Services for Analytic Services
9.2, and then restart Planning.
10
Try to create or refresh the database with the Manage Database task on the Planning Desktop. If the error recurs, repeat steps a) through i), but this time also create a folder called
C:\tmp
and set the System
Environment variables Temp and Tmp to
C:\tmp
.
If after going through the above steps, the error persists, create a
Temp
folder under
C:\temp
.
Repeat the previous steps, redirecting first the user variables and then the system variables to
C:\temp\temp
. If you continue to receive the error, redirect the environment variables back to
C:\temp
.
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 folder.
Maximum Number of Applications Already Connected or
Database is Locked
Scenario:
You are using DB2 as your relational database, and you receive either of the following messages when you try to create or refresh the database:
●
●
… maximum number of applications already connected
Database is locked …
Maximum Number of Applications Already Connected or Database is Locked
361
By default, the
MAXAPPLS
parameter is set to 40.
Solution:
You should increase the number of applications allowed by increasing the MAXAPPLS parameter.
➤
To increase the
MAXAPPLS
parameter:
1
In Control Center, right-click the database and select Configure Parameters.
Alternately, you can set the parameter from the DB2 window.
2
Set the
MAXAPPLS
parameter, using the following format: db2 -v update db cfg for <database name> using MAXAPPLS <n> db2 -v terminate where:
<database name>
is the name of the relational database
<n>
is the number of applications that can be connected at one time
For example, to increase the number of maximum number of applications that can be connected at one time to 100 for a database named Business, you would specify: db2 -v update db cfg for Business using MAXAPPLS 100 db2 -v terminate
Missing 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 Planning icon or the flat file icon is lost.
Solution:
Locate the 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:
●
Planning is
Planning.PRX
●
Flat file is
Files.prx
.
362
Session Timeout
Scenario:
If a user quits a session by closing the browser instead of logging off, the session times out after a period of time, and the user name is removed from the Statistics page. You can change the number of minutes before the session times out by modifying the timeout settings for your
Web application server. For example, for Apache Tomcat 5.0.28, modify the web.xml
file in the
Web-inf
directory. For more information about modifying timeout settings, see the documentation for your Web application server.
Solution:
➤
To change the session timeout setting:
1
Open the timeout setting file for your Web application server.
For example, in Apache Tomcat 5.0.28, open the web.xml
file in the
<driveletter>:\Tomcat\conf
directory.
2 Modify the timeout setting for the Web application server, and then save your changes.
For example, for Apache Tomcat 5.0.28, change the number
60
in the session-timeout setting to the number of minutes you want to use.
For more information about modifying timeout settings, see the documentation for your Web application server.
Slow Performance When Opening Large Data Forms
Scenario:
Unusually large data forms with many cells may require significant time to open.
Solution:
You can choose to display a warning when someone tries to open data forms that are larger than a specified number of cells. When a user tries to open a data form that is beyond the specified size limit, Planning displays a warning about the time needed to open the data form.
The user can choose whether or not to open the data form.
The default value for the number of cells that trigger the warning is 5,000. Administrators can change the default value.
➤
To set the number of data form cells that trigger a warning message upon opening:
1
In Planning, select File > Preferences.
2
Select the Display Options tab.
3
In the text box Warn If Data Form Larger Than __ Cells, type a value.
For more information on improving performance when you have a large number of users, see
“Clearing Options when Creating or Refreshing an Application Database” on page 79 .
Slow Performance When Opening Large Data Forms
363
Slow Performance When Opening Data Forms Using a Dial-Up
Connection
Scenario:
Solution:
Opening a data form using a slow network connection (for example, with a modem) takes a long time.
You can significantly increase the network bandwidth when opening data forms by modifying the web.xml
file, as described in this section. This solution compresses by approximately 90% the data stream sent from the Planning server to the client.
Note:
If you are using a WebLogic (all supported versions) Web application server, complete the second procedure, which is specific to WebLogic. If you are using any other Web application server, complete the first procedure, which contains general instructions.
➤
To modify the web.xml
file to improve performance, for any Web application server except
WebLogic:
1
With a text editor, open the web.xml
file, located in
HyperionPlanning.ear
or
HyperionPlanning.war
.
2
After the tag
</description>
and before the tag
<listener>, insert the following lines:
<filter>
<filter-name>HspCompressionFilter</filter-name> <filterclass>com.hyperion.planning.HspCompressionFilter</filter-class>
<init-param>
<param-name>compressionThreshold</param-name>
<param-value>2048</param-value>
</init-param>
<init-param>
<param-name>debug</param-name> <param-value>1</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>HspCompressionFilter</filter-name>
<url-pattern>/EnterData.jsp</url-pattern>
</filter-mapping>
3
Save the web.xml
file.
If you are using WebLogic, you must manually modify the .
ear
file and redeploy it for the Web application server.
➤
To improve performance with a WebLogic application server:
1
Unzip the
HyperionPlanning.ear
file to
C\:ear
, for example.
2
Unzip
Hyperion.war
under
C:\ear
to
C:\war
.
3
With a text editor, open the
C:war\WEB-INF\web.xml
file and modify it using the instructions in step
2 in the preceding procedure.
364
4
Compress the content in
C:\war
to
C:\ear\HyperionPlanning.war.
5
Compress the content in
C:\ear
into
C:ear\HyperionPlanning.ear
6
Deploy the new
HyperionPlanning.ear
for the WebLogic Web application server.
Unable to Create Application Error
Scenario:
Solution:
When you try to create a new application in Planning, you may receive the following error message when you click Finish in the Create Application task: “Unable to create application
<application name>. Error number: -2147160060.”
There may be several causes of this issue. To resolve it, ensure that the following conditions are met:
●
●
●
●
●
●
●
Analytic Services must be running.
Advanced User Rights must be set up on the local machine.
Administrator user must be set up in DCOM for HsxServer and HspDataSource.
If the Analytic Services supervisor username is the same as the Planning administrator username, the passwords must be identical.
If you are using local authentication, the machine name must be different from the username.
The name of the Planning application cannot be the same as an existing Analytic Services application name.
If you are using DB2, you might get an error message if the database is not set up correctly.
This error can be due to various causes, such as auditing tables that are not set up properly.
Unable to Refresh Application Error
Scenario:
When using a DB2 database, you try to refresh an application in Planning and receive an error message.
Solution:
DB2 could not refresh or correctly generate its transaction log because there was not enough space allocated for the log files.
To resolve this error, take one of the following actions.
➤
Allocate more space for the DB2 transaction log:
1 In DB2 Command Center, select Tools > Wizard > Configure Database Logging Wizard.
2
Connect to the database and make sure that Circular Logging is selected.
3
On the next screen, increase the number of primary (for example, 20) and secondary log files (for example,
10).
Unable to Refresh Application Error
365
4
Increase the size of each log file (for example, 2000).
5
Click Next to accept all the defaults.
6
On the Summary screen, enter the user name and password.
7
Click Finish.
8
Restart DB2.
9
Refresh the database.
➤
Avoid the error by performing a database refresh more frequently, after making a few changes, instead of waiting until you have made all changes into the application.
Unsuccessful Log On
Scenario:
Solutions:
When logging on to Planning Web client, a user receives the error: “Unsuccessful login. Please try again.”
Ensure that you are using a valid username and password.
Ensure that Analytic Services server and Shared Services are running.
Review the error log.
If the Log On button does not appear when you are attempting to log on, you can resolve the problem by adjusting the security settings in your Web browser, and adding the Planning server name as a Trusted Site. For example, in Internet Explorer, select Tools > Internet
Options > Security > Trusted Sites > Sites and add http://<servername> to the trusted sites zone.
Unable to Find Properties File
Scenario:
Solution:
When you try to connect to Planning through the Web, you may receive the error: “An exception was reported: Unable to find properties file: HspJSHome.properties.”
You must create the Properties file. For instructions, see
“Creating the Properties File” on page 43 .
366
A P P E N D I X
A
Customizing Data Forms with
JavaScript
This section describes how to use JavaScript to customize data forms. If you are a programmer familiar with JavaScript, you can customize the look and behavior of Planning data forms by writing custom JavaScript and including it in an application.
To deploy the changes described in this section, use the instructions provided in Chapter 15,
“Customizing Planning Web Client.”
In This Appendix
Customizing Data Forms with JavaScript
387
About Customizing Data Forms
You can customize data forms in the following ways:
●
●
●
You can add a button to a data form that links to any Web page or runs custom JavaScript code that you add. You can specify on which data forms the buttons appear.
You can modify the application’s behavior when a user saves a data form. You can replace or augment the default Planning behavior.
You can modify the application’s behavior when the focus enters or leaves a cell. You can replace or augment the default Planning behavior.
There are no additional system requirements for end users if you include custom JavaScript in your Planning application. Administrators do not have to take any special steps to enable the custom JavaScript for the application. You simply modify an existing JavaScript file with your changes, and the data forms you specify include your changes.
Modifying JavaScript
To add custom JavaScript to a Planning application, you modify the code in
ValidateData.js
, which is installed in
\<default web application
directory
>\<Planning>\web\custom
. For examples of how you can customize data forms, see the sample code and comments in
SampleValidateData.js
, which is installed in the
\<default web application directory>\<Planning>\web\custom
.
See the following examples of default directories for Web application servers:
Example: Tomcat 5.0.28
C:\Hyperion\HyperionPlanning\AppServer\InstalledApps\Tomcat\5.0.28\
HyperionPlanning\webapps\HyperionPlanning
Example: WebSphere
C:\WebSphere\AppServer\installedApps\<server name>\
HyperionPlanning.ear\HyperionPlanning.war
Example: WebLogic 8.1
C:\Hyperion\HyperionPlanning\AppServer\InstalledApps\WebLogic\8.1\
HPDomain
Applications deployed with WebLogic are deployed in .EAR format. This does not leave an expanded version of the files where you can easily modify the contents. If you are using
WebLogic, you must extract the .EAR file, and then customize the settings.
Planning provides the following functions to help you customize data forms:
●
●
●
●
●
“customCellEnterPre” on page 390
“customCellEnterPost” on page 391
“customCellValidatePre” on page 392
“customCellValidatePost” on page 393
388
Customizing Data Forms with JavaScript
●
●
“drawCustomButtons” on page 394
Modifying JavaScript
389
customCellEnterPre
Description
Use customCellEnterPre
when you want custom behavior to occur when focus comes into a cell, before the default Planning logic runs.
For example, when the focus enters a cell, you can display a message that indicates the acceptable range for the value the user is about to enter. Or when the focus enters particular cells, such as certain accounts, you can display a message that prompts the user to enter supporting detail.
After customCellEnterPre
runs, if customCellEnterPre
returns True, the Planning default logic runs. If customCellEnterPre
returns False, no additional logic follows the custom code.
SampleValidateData.js
includes an example that displays a message prompting the user to enter supporting detail when the focus comes into particular cells.
Arguments
Argument
Row
Col
Cell
Description
An integer that defines the row for the cell.
An integer that defines the column for the cell.
A handle for the HTML input object.
Returns
Return Value
True
False
Description
Indicates that the Planning default logic will run after this code completes.
Indicates that no further logic (Planning default logic or customCellEnterPost) will run after this code completes.
See Also
390
Customizing Data Forms with JavaScript
customCellEnterPost
Description
Use customCellEnterPost
when you want custom behavior to occur when focus comes into a cell, after the default Planning logic runs.
You can use customCellEnterPost
in the same ways you can use customCellEnterPre.
Choose which to use based on when you want the code to run. customCellEnterPost
runs when focus comes into the cell, after Planning's default logic if both customCellEnterPre and Planning’s default logic return True.
If customCellEnterPre
or Planning default logic returns False, this function is disabled.
Return values have no effect.
SampleValidateData.js
includes an example for customCellEnterPre
that you can also use for customCellEnterPost
. The example displays a message prompting the user to enter supporting detail when the focus comes into particular cells.
Arguments
Argument
Row
Col
Cell
Description
An integer that defines the row for the cell.
An integer that defines the column for the cell.
A handle for the HTML input object.
Returns
Returns
Return Value
True
False
See Also
Description
Indicates that the Planning default logic will run after this code completes.
Indicates that no further logic will run after this code completes.
Modifying JavaScript
391
customCellValidatePre
Description
Use customCellValidatePre
when you want custom behavior to occur when focus leaves a cell, before the default Planning logic runs.
For example, you can compare the value a user entered for the cell to another value and display an alert if the variance is too great. Or you could limit a value to a range and display an alert if the value a user entered is out of the range. You could also define a new spreading algorithm that occurs when the focus leaves a cell, replacing the Planning default spreading algorithm.
For example, usually Planning spreads by time period, but you can write custom JavaScript that pre-aggregates the data on the client side prior to writing the values back to Analytic
Services.
After customCellValidatePre
runs, if customCellValidatePre
returns True, the
Planning default logic runs.
If customCellValidatePre
returns False, no additional logic follows the custom code. In this case, the data form uses your custom code and skips the Planning default logic, which could cause a user to submit an invalid grid.
SampleValidateData.js
includes an example that executes additional validation when the focus leaves a cell. When the focus leaves a cell, the JavaScript code compares the value the user entered for the current year to last year’s value. If the current year’s value is more than 10% larger than the previous year's value, a message is displayed.
Arguments
Argument
Row
Col
Cell
Description
An integer that defines the row for the cell.
An integer that defines the column for the cell.
A handle for the HTML input object.
Returns
Argument
True
False
Description
Indicates that the Planning default logic will run after this code completes.
Indicates that the no further logic will run after this code completes.
See Also
392
Customizing Data Forms with JavaScript
customCellValidatePost
Description
Use customCellValidatePost
when you want custom behavior to occur when focus leaves a cell, after the default Planning logic runs.
You can use customCellValidatePost
in the same ways you can use customCellValidatePre.
Choose which to use based on when you want the code to run.
customCellValidatePost
runs when the focus leaves a cell, after Planning's default logic if both customCellValidatePre
and Planning’s default logic return True.
If customCellValidatePre
or Planning default logic returns False, this function is disabled.
Return values have no effect.
SampleValidateData.js
includes an example for customCellValidatePre
that you can use for customCellValidatePost.
The example executes additional validation when the focus leaves a cell. When the focus leaves a cell, the JavaScript code compares the value the user entered for the current year to last year’s value. If the current year’s value is more than 10% larger than the previous year's value, a message is displayed.
Arguments
Argument
Row
Col
Cell
Description
An integer that defines the row for the cell.
An integer that defines the column for the cell.
A handle for the HTML input object.
Returns
Return Value
True
False
Description
Indicates that the Planning default logic will run after this code completes.
Indicates that the no further logic will run after this code completes.
See Also
Modifying JavaScript
393
customOnLoad
Description
Use customOnLoad
if you want custom behavior to occur when a data form is loaded (or reloaded). A new JavaScript variable called savedData
indicates whether or not a Save has just been completed.
You can customize the logic that occurs when the customOnLoad
function is called, augmenting the default Planning logic. For example, when users open a data form, you could display an instruction, or you could add some checking to determine if the data loaded matches some tolerances and inform the users of any corrective actions that must be taken if it does not.
Arguments
No arguments.
Returns
No return values.
drawCustomButtons
Description
Use drawCustomButton
to add a custom button to a data form. The button can link to any data entry page or launch custom JavaScript code you include in
ValidateData.js
. You can specify on which data forms the buttons appear.
For example, you can add a button that validates the data form, or add a button that runs a
Hyperion Report.
SampleValidateData.js
includes an example that adds a button labeled Validate to a data form. When a user clicks the button, the JavaScript code compares the values entered for the current year to last year’s values. If the current year’s values are more than 10% larger than the previous year's values, a message is displayed.
Arguments
No arguments.
Returns
No return values.
394
Customizing Data Forms with JavaScript
validateForm
Description
Use validateForm
when you want to provide data form-level behavior that is launched when a user clicks Save.
With the Planning default behavior, when a user clicks Save on a data form, the validateForm
function submits the grid.
You can customize the logic that occurs when the validateForm
function is called, augmenting the default Planning logic. For example, you can calculate a variance between budget and actuals by comparing the values in two columns, and when a user clicks Save, display an alert if the variance is too high.
SampleValidateData.js
includes an example that executes additional validation when a user clicks Save. When a user clicks Save, the JavaScript code compares the values the user entered for the current year to last year’s values. If the current year’s values are more than 10% larger than the previous year's values, a message is displayed.
Arguments
No arguments.
Returns
Return Value
True
False
Description
Saves the grid.
Cancels the save.
Modifying JavaScript
395
Deploying Custom JavaScript
This section describes some of the issues you need to understand if you include custom
JavaScript in a Planning application.
●
●
●
●
●
●
●
●
Make sure you specify which data forms the code is applicable to. See the sample code in
SampleValidateData.js
for an example.
You need to maintain the custom JavaScript when you upgrade to a new version of
Planning. Because you’re modifying a standard Planning JavaScript file, the next time you upgrade you need to merge your code with the updated version of
ValidateData.js.
(If there are no changes to
ValidateData.js
, you could back up the file before installing the upgrade of Planning and then copy your version of the file.)
Because the default Planning calc scripts can run after the data on a data form is saved, the default calc scripts could overwrite the actions of your custom JavaScript. In addition, if you have set up any custom calc scripts that are set up to run automatically after the data on a data form is saved, these calc scripts could overwrite the actions of your custom JavaScript.
If you are programming custom JavaScript that determines how values are propagated throughout the hierarchy, you need to be aware of the possible conflict with calc scripts.
Custom JavaScript can modify cells that aren't visible on the data form if they are part of the data form design. For example, if a a quarter is collapsed, custom JavaScript can still affect the values for the individual months.
Custom JavaScript cannot affect suppressed rows or columns.
Depending on the complexity of the code, using the cell-level JavaScript functions could have an adverse effect on the performance of your application. For complex JavaScript, consider using the data form-level function ( validateForm
) or a custom button to launch the JavaScript code.
validateDataHelper.js
, which is installed in
\<default Web application
directory
>\<
Planning
>\web\custom
, contains utility functions you might want to use.
If you choose to use custom JavaScript in your Planning application that overrides the
Planning default behavior, you are responsible for making sure that the data is valid. You can use the default JavaScript functions that Planning uses for validation to verify that the data is valid after your custom JavaScript runs. These validation functions are in enterData.js
, which is installed in
\<default Web application directory>\
<Planning>\web
. See the
LeaveCell
function for an example of how these functions are used.
396
Customizing Data Forms with JavaScript
A P P E N D I X
B
Naming Restrictions for
Analytic Ser vices
This appendix describes the rules for naming applications, databases, dimensions, members, and aliases in Analytic Services. For detailed information on creating Analytic Services applications and databases, see the Analytic Services product documentation.
In This Appendix
Naming Restrictions for Analytic Services
397
Naming Restrictions for Applications and Databases
When naming applications and databases, follow these rules:
●
●
●
Use no more than 8 bytes when naming non-Unicode-mode applications and databases; use no more than 30 characters when naming Unicode-mode applications and databases.
Do not use spaces anywhere in the name.
Do not use the following special characters anywhere in the name:
* asterisks
\ backslashes
[] brackets
: colons
, commas
" double quotation marks
; semicolons
>
< greater than signs less than signs
. periods
/ slashes tabs
| vertical bars
●
●
In relational database environments, extended characters except for the underscore (_) character cannot be used in Planning application names.
For aggregate storage databases only, do not use any of the following words as application or database names:
DEFAULT
LOG
METADATA
TEMP
Enter the name in the case in which you want the word displayed. The application or database name is created exactly as you enter it. If you enter the name as all capital letters (for instance,
NEWAPP), Analytic Services does not automatically convert it to upper- and lowercase (for instance, Newapp).
398
Naming Restrictions for Analytic Services
Naming Restrictions for Dimensions, Members, Aliases, and
Data Forms
When naming dimensions, members, and aliases in the database outline, follow these rules:
●
●
●
●
Use no more than 80 bytes when naming non-Unicode-mode dimensions, members, or aliases; use no more than 80 characters when naming Unicode-mode dimensions, members, or aliases.
Names are not case-sensitive unless case-sensitivity is enabled. See “Setting Outline
Properties” in Hyperion System 9 BI+ Analytic Administration Services Online Help.
Do not use HTML tags in member names, dimension names, aliases, and descriptions.
Do not use quotation marks(" "), brackets ([]), backslash (\),or tabs anywhere in a name.
Note:
Brackets ([]) are supported in block storage outlines, but are not recommended because their use causes errors when converting to an aggregate storage outline.
●
At the beginning of a dimension or member name, do not use the following characters:
\ backslashes
{ }
,
-
=
< braces commas dashes, hyphens, or minus equal signs less than signs
_
|
+
'
() parentheses
. periods plus signs single quotation marks underscores vertical bars
●
●
●
●
●
Do not place spaces at the beginning or end of a name. Analytic Services ignores spaces at the beginning or end of a name.
Do not use a forward slash (/) in member names.
Do not use the following characters in data form names on Planning Web: quotation marks ("), forward slash ( /), or backward slash ( \)
Do not use a space in prefixes to time periods in custom calendars.
Do not use the following words as dimension or member names:
❍
❍
❍
❍
Calculation script commands, operators, and keywords. For a list of commands, see the Analytic Services Technical Reference.
Report writer commands. For a list of commands, see the Analytic Services Technical
Reference.
Function names and function arguments. For a list of functions, see the Analytic
Services Technical Reference.
Names of other dimensions and members (unless the member is shared), and generation names, level names, and aliases in the database.
Naming Restrictions for Dimensions, Members, Aliases, and Data Forms
399
❍
Any of the following words:
ALL
AND
ASSIGN
AVERAGE
CALC
CALCMBR
COPYFORWARD
CROSSDIM
CURMBRNAME
DIM
DIMNAME
DIV
DYNAMIC
EMPTYPARM
EQ
EQOP
EXCEPT
EXP
EXPERROR
FLOAT
FUNCTION
GE
GEN
GENRANGE
GROUP
GT
ID
IDERROR
INTEGER
LE
LEVELRANGE
LOOPBLOCK
LOOPPARMS
LT
MBR
MBRNAME
MBRONLY
MINUS
MISSING
MUL
MULOP
NE
NON
NONINPUT
NOT
OR
PAREN
PARENPARM
PERCENT
PLUS
RELOP
SET
SKIPBOTH
SKIPMISSING
SKIPNONE
SKIPZERO
TO
TOLOCALRATE
TRAILMISSING
TRAILSUM
UMINUS
UPPER
VARORXMBR
XMBRONLY
$$UNIVERSE$$
#MISSING
#MI
Note:
If you enable Dynamic Time Series members, do not use the associated generation names—History, Year, Season,
Period, Quarter, Month, Week, or Day.
400
Naming Restrictions for Analytic Services
Using Dimension and Member Names in Calculation Scripts,
Report Scripts, Formulas, Filters, and Substitution Variable
Values
In substitution variable values, calculation scripts, report scripts, filter definitions, partition definitions, or formulas, you must enclose member names in brackets ([]) when used within
MDX statements and otherwise in quotation marks (" ") for block storage databases, in the following situations:
●
●
The name starts with one or more numerals (for example, 100).
The name contains spaces or any of the following characters:
& ampersand
* asterisk
-
!
\ backslash
{ } braces
:
, colon comma dash, hyphen, or minus
= exclamation point equal sign
>
< greater than sign less than sign
() parentheses
% percent sign
.
+
;
/ period plus sign semicolon slash
~ tilde
In calculation scripts and formulas, you must enclose member names that are also Analytic
Services keywords in quotation marks (" ") for block storage databases, and in brackets ([]) for aggregate storage databases including the following member names:
BEGIN
DOUBLE
ELSE
END
FUNCTION
GLOBAL
IF
MACRO
MEMBER
RANGE
RETURN
STRING
THEN
You must enclose in quotes names that contain any of the following characters in calculation scripts, report scripts or formulas, and names that start with any of these characters:
Spaces + - * / ( ) : , @ ; ) { } [ ] <
Using Dimension and Member Names in Calculation Scripts, Report Scripts, Formulas, Filters, and Substitution Variable Values
401
Naming Restrictions for User Names
User names in Analytic Services must be under 30 characters.
402
Naming Restrictions for Analytic Services
Common Member Attributes
A P P E N D I X
C
The tables in this section list the common member attributes used in Shared Services.
The tables list the common name for the attribute as used in Shared Services and the equivalent member attribute in the Hyperion product.
The tables list only the attributes that are different between Shared Services and the other
Hyperion products.
Note:
NA indicates that the attribute is not used by the Hyperion product.
In This Appendix
Common Member Attributes
403
Member Attributes
Table 62
Common Member Attributes
Shared Services Attribute
Alias
SharedMember
DataStorage2
DataStorage4
UDA1-n
Consolidation
Consolidation2
Consolidation4
MemberFormula2
MemberFormula4
DataStorage - StoreData
DataStorage - SharedMember
DataStorage - Dynamic Calc
DataStorage - Dynamic Calc
And Store
DataStorage - None
NA
NA
NA
Hyperion Financial
Management Attribute
Description
NA
NA
NA
UserDefined1-3
NA
NA
NA
NA
NA
IsCalculated=No
NA
Configuration Attributes
Table 63
Common Configuration Attributes
Shared Services Attribute
DefaultCurrency
WeeksDistribution
FullName
EmailServer
NA
NA
NA
Hyperion Financial
Management Attribute
DefaultCurrency
StartYear
EndYear
FirstYear
LastYear
Planning Attribute
Alias
DataStorage
Reserved for future use
Reserved for future use
UDAs (Reserved for future use) NA
AggSymbol (plantype1) NA
Hyperion Business Modeling
Attribute
Name
NA
NA
NA
AggSymbol (plantype2)
AggSymbol (plantype3)
Reserved for future use
Reserved for future use
Stored
SharedMember
Dynamic & Calc
Dynamic-Calc & Store
NA
NA
NA
NA
NA
NA
NA
NA
PlanType NA
Planning Attribute
DefaultCurrency
Support445
UseFullName
EmailServer
First_year
NA
Hyperion Business Modeling
Attribute
CurrencyName
NA
NA
OutgoingEmail
Server
NA
NA
404
Table 63
Common Configuration Attributes (Continued)
Shared Services Attribute
NumberOfYears
CurrentYear
BaseTimePeriod
PeriodsInYear
Hyperion Financial
Management Attribute
NA
NA
BaseFrequency
NumberOfPeriods
Account Member Attributes
Table 64
Common Account Member Attributes
Shared Services Attribute
DefaultAccountType
PlanningAccount
Type
Consolidation
AccountType
Hyperion Financial
Management Attribute
AccountType
NA
AccountType
Account Type Attributes
Table 65
Common Account Type Attributes
Shared Services Attribute
Expense
Revenue
LabelOnly
Hyperion Financial
Management Attribute
Expense
Income
GroupLabel
Entity Member Attributes
Table 66
Common Entity Member Attributes
Shared Services Attribute
Currency
Hyperion Financial
Management Attribute
DefCurrency
Planning Attribute
Num_year
Current_year
Base_time_period
Periods_in_year
Planning Attribute
NA
AccountType
NA
Planning Attribute
Expense
Revenue
LabelOnly
Planning Attribute
BaseCurrency
Hyperion Business Modeling
Attribute
NA
NA
TimelineType
NA
Hyperion Business Modeling
Attribute
Type
NA
NA
Hyperion Business Modeling
Attribute
Cost
Revenue
NA
Hyperion Business Modeling
Attribute
NA
Entity Member Attributes
405
Scenario Member Attributes
Table 67
Common Scenario Member Attributes
Shared Services Attribute
DefaultFrequency
ConsolidationType
EnableProcess
Management
Hyperion Financial
Management Attribute
DefaultFreq
ConsolidateYTD
SupportsProcess
Management
Planning Attribute
NA
NA
EnabledForPM
Version Member Attributes
Table 68
Common Version Member Attributes
Shared Services Attribute
EnableProcess
Management
VersionType NA
Hyperion Financial
Management Attribute
NA
Planning Attribute
EnabledForPM
Year Member Attributes
Table 69
Common Year Member Attributes
Shared Services Attribute
Name
Hyperion Financial
Management Attribute
Label
Planning Attribute
Name
Consolidation Method Attributes
Table 70
Common Consolidation Method Attributes
Shared Services Attribute
ConsolidationMethod
Comment
Hyperion Financial
Management Attribute
ConsolMethod
Description
Planning Attribute
NA
Comment
Hyperion Business Modeling
Attribute
NA
NA
NA
Hyperion Business Modeling
Attribute
NA
NA
Hyperion Business Modeling
Attribute
ID or Name
Hyperion Business Modeling
Attribute
NA
NA
406
Container Model Attributes
Table 71
Common Container Model Attributes
Shared Services Attribute
UserName
Password
Hyperion Financial
Management Attribute
NA
NA
Element Model Attributes
Table 72
Common Element Model Attributes
Shared Services Attribute
TagSet
Hyperion Financial
Management Attribute
NA
Planning Attribute
NA
NA
Planning Attribute
NA
Hyperion Business Modeling
Attribute
LoginUserName
Login Password
Hyperion Business Modeling
Attribute
Application
Element Model Attributes
407
408
A P P E N D I X
D
Reference Application for
Planning
This appendix describes the structure of the Reference Applications for Planning. It also describes how to create and initialize the Reference Application.
In This Appendix
Reference Application for Planning
409
Introduction
The Reference Application is a Planning application, included in the base installation of the product that provides sample application designs and application objects. The Reference
Application contains a full set of dimensions, sample data forms, business rules, and reports. A data set is included to present a realistic application size and user experience. A wizard is provided to load the data for the application and increase the size of the application (including additional dimension members and data) from a small application to a larger application. For specifics about the application and the wizard for loading data and enhancing the size of the
application, see “About the Application” on page 410
and
“Creating the Reference Application” on page 414
.
About the Application
The application that serves as a reference model for Planning installations simulates a company that specializes in the production, sales, and installation of audio systems, digital video, televisions, and VCRs. The company produces all of the components in world-class production facilities in the USA, Mexico, Philippines, Taiwan, Kuwait, and Venezuela. They have a worldwide sales organization that sells these components through several different channels: commercial, retail, direct, catalog, and online. Administrative headquarters located throughout the world manage the operations of the business based on a geographic hierarchy.
When you create the Reference Application, a database is created for Planning. The Reference
Application provides applications for Planning. You can work with a small application or a large application. Use the application that best matches the installation at your site, depending on the products you have installed and the number of entities and account members in your applications.
For example, if you are using Planning and your largest application includes 1,000 accounts and 20,000 employee entities, use the Planning—Large Application.
Note:
The Reference Application for Planning works only on the Windows operating system.
410
About the Dimension Members
The Reference Application for Planning includes the predefined dimension outlines described in this section. To determine which application best matches the application installed at your company, see the following topics:
●
●
“Dimension Members in Planning Database—Small Application” on page 411
“Dimension Members in Planning Database—Large Application” on page 411
Dimension Members in Planning Database—Small
Application
Use this application if you have installed Planning and you have a “small” application. See the following description of the small application. If your application contains more members than the small application, consider using the application described in
“Dimension Members in Planning Database—Large Application” on page 411
.
Table 73
Planning Database—Small Application
Dimension
Period
Account
Entity
Scenario
Version
Currency
HSP_Rates
Year
Segment
Channel
Sparse
Sparse
Sparse
Sparse
Sparse
Sparse
Type
Dense
Dense
Sparse
Sparse
4
6
20
5
29
14
Members
19
155
2,122
4
4
6
20
5
29
14
Members stored
19
148
1,208
4
Block size in bytes: 62,624
Dimension Members in Planning Database—Large
Application
Use this application if you have installed Planning and you have a “large” application. See the following description of the large application. If your application contains fewer members, consider using the application described in
“Dimension Members in Planning Database—
Small Application” on page 411
.
About the Dimension Members
411
Planning cube: Consol database
Table 74
Planning Database—Large Application
Dimension
Period
Account
Entity
Scenario
Version
Currency
HSP_Rates
Year
Segment
Channel
Type
Dense
Dense
Sparse
Sparse
Sparse
Sparse
Sparse
Sparse
Sparse
Sparse
6
20
5
29
14
Members
19
1,233
20,094
4
4
Block size in bytes: 174,952
6
20
5
29
14
Members stored
19
1,151
19,180
4
4
About the Databases
The following table describes the plan types, or databases, associated with each application.
Table 75
Database Created
Planning
Application Uses
X
Database Name
X
Database Description
Stores expenses related to departments and sales activity. Also stores data needed for the company’s financial statement and capital-related expenses
About the Data Forms
The Reference Application for Planning includes the predefined data forms that are described in this section.
412
Data Forms in Planning
The following predefined data forms are used:
Table 76
Data Forms in Planning
Form Name
03 Services Revenue - Installation
02 Other Operating Expenses
01 Dept Expenses
03 Services Revenue - Installation with HBR
Size
Small
Medium
Large
Run Business Rules on Save
Number of Cells
391
986
2,482
391
About the Business Rules
The Reference Application for Planning includes the predefined business rules described in this section.
Business Rules in Planning
The Reference Application for Planning includes two business rules. Both business rules have runtime prompts associated with them to enable your setting parameters while working. The business rule named ProdRev is set to Run on Save; the business rule named IndivContr is not set to Run on Save. The following table describes the two business rules.
Table 77
Business Rules for Planning
Descriptor
Business
Rule Name
HBR w/RTP on Save ProdRev
HBR w/ RTP w/no
Run on Save
IndivContr
Runtime Prompts Associated Form
Entity
Description
03 Services Revenue
- Installation with
HBR
This calculation takes unit values that are entered into the Units member and lags them one month in the member called Lagged Units
1 Mth.
Entity
Scenario
Version
Year
02 Other Operating
Expenses
This calculation evaluates the value entered into
Account member 506110 for the Individual Contractor
Expense and determines the additional Individual
Contractor expenses by different plan types.
About the Business Rules
413
About Users
The Reference Application for Planning includes only one user: the administrator who creates and initializes the Reference Application.
About Reports
The Reference Application for Planning includes the following set of predefined Financial
Reporting reports:
Table 78
Predefined Reports for Planning
Database
Consol
Consol
Consol
Report Name Description
1.0 Department Expenses by Entity Details the specific, general, and administrative costs for FY05 and FY06 by Entity
2.0 Income Statement by Entity Provides an income statement that gives visibility into high-level revenue and expense components by
Entity
3.0 Revenue Analysis by Entity Details the revenue components by Segment,
Channel, and Entity
You can locate the predefined reports in the following directory:
<Hyperion_Home>\Planning\ReferenceApplication\Reports\
Creating the Reference Application
The structure for the Reference Application for Planning is automatically installed when you install Planning. To create the Reference Application, you use the Setup Application task on the
Planning Desktop.
➤
To create the Reference Application:
1
From the Planning Desktop, select the Setup Application task.
2
At the Select page, select the Reference Application check box.
414
3
Click OK and proceed through the Setup Application pages, as described in
After you have created the Reference Application using the Setup Application, you must initialize it and create the database. See:
●
●
“Initializing the Reference Application” on page 415
“Creating the Database” on page 416
Initializing the Reference Application
Before you can use the Reference Application, you must initialize it. This procedure assumes
that you have already created the Reference Application, as described in “Creating the
Reference Application” on page 414
.
Initializing the Reference Application
415
➤
To initialize the Reference Application, from Planning Web, select Edit > Reference Application
> Initialize Reference Application.
Creating the Database
Before you can use the Reference Application, you must create the application, initialize it, and create the database. This section describes the last step, how to create the Reference Application database. For information on preparing for this section, see:
●
●
“Creating the Reference Application” on page 414
“Initializing the Reference Application” on page 415
➤
To create the database for the Reference Application:
1
From the navigation frame on the Planning Desktop, double-click Planning > Manage Application >
Manage Database.
2 Accept all the defaults and click Create.
You are now ready to load data into the small Reference Application, as described in
Data into the Reference Application” on page 417 . For a description of the dimensions in the
database you created, see “About the Dimension Members” on page 411 .
416
Loading Data into the Reference Application
You can load data into the small Reference Application after you have performed the steps described in the following topics:
●
●
“Creating the Reference Application” on page 414
“Initializing the Reference Application” on page 415
“Creating the Database” on page 416
●
The Reference Application includes a Planning Reference Application Load and Upgrade
Wizard that enables you to:
●
●
Load the initial data into the small application
Upgrade the small application to a large application to enable you to work with larger applications.
This section describes how to use the wizard to load data. For information on upgrading from a small to a large Reference Application, see
“Upgrading to a Large Reference Application” on page 418 .
Note:
To use the wizard, you must have installed the following on the Planning Desktop computer: Hyperion Application
Link Basic 9.2 or 7.0, the Planning Adapter 9.2, and the Analytic Services Adapter 9.2.
➤
To load data into the Reference Application:
1 Double-click on the file
RefAppUpgradeUtility.exe.
By default, the file is located in the following directory path:
<Hyperion_Home>\Planning\ReferenceApplication\UpgradeUtility\
RefAppUgradeUtility.exe
2
On the Welcome page, select Load Data to the Application.
3
Click Next.
4
On the Specify Planning Information page, enter the following information into the text boxes:
Loading Data into the Reference Application
417
Table 79
Specify Planning Information Page
Text Box
Reference Application
Server
Analytic Services User ID
Analytic Services Password
Description
The name you gave the Reference Application when you created it with the Setup
Application task, as described in “Creating the Reference Application” on page 414
.
The name of the server on which the Reference Application is installed.
Your user ID in Analytic Services.
Your password in Analytic Services. Enter it again in the Confirm Password text box.
5
Click Next.
6
At the Summary page, review the information and if you are satisfied with it, click Load.
The Load process can take up to 20 minutes.
7
When a message displays that the load process has completed, take one of the following actions:
●
●
To exit the wizard, click OK. (You can skip the next steps.)
To view any of the logs to learn more about the information that was loaded or problems encountered, click View Logs. Proceed to the next steps.
8
For log information, click an option to view the following information:
●
●
Data Load Message Log
–data that was loaded
Data Load Exception Log
–data that could not be loaded
9 Click Close.
Upgrading to a Large Reference Application
You can upgrade from a small to a large application using the Planning Reference Application
Load and Upgrade Wizard. The upgrade process described in this section loads members, synchronizes with Analytic Services, and loads data.
Note:
Before you can upgrade to a large Reference Application, you must first load data into the small application, as described in
“Loading Data into the Reference Application” on page 417
.
➤
To upgrade from a small to a large Reference Application:
1
Double-click on the file
RefAppUpgradeUtility.exe.
By default, the file is located in the following directory path:
<Hyperion_Home>\Planning\ReferenceApplication\UpgradeUtility\
RefAppUgradeUtility.exe
2
On the Welcome page, select Upgrade to a Large Application.
418
3
Click Next.
4
On the Specify Planning Information page, enter the following information into the text boxes:
Table 80
Specify Planning Information Page
Text Box
Reference Application
Planning User ID
Planning Server
Planning Password
Analytic Services User ID
Analytic Services Password
Description
The name you gave the Reference Application when you created it with the Setup
Application task, as described in “Creating the Reference Application” on page 414
.
Your user ID in Planning.
The name of the server on which the Reference Application is installed.
Your password in Planning. Enter it again in the Confirm Password text box.
Your user ID in Analytic Services.
Your password in Analytic Services. Enter it again in the Confirm Password text box.
5
Click Next.
6
At the Summary page, review the information and if you are satisfied with it, click Upgrade.
The upgrade process can take up to 30 minutes.
7
When a message displays that the upgrade process has completed, take one of the following actions:
●
●
To exit the wizard, click OK. (You can skip the next steps.)
To view any of the logs to learn more about the information that was upgraded or problems encountered, click View Logs. Proceed to the next steps.
Upgrading to a Large Reference Application
419
420
8
For log information, click an option to view the following information:
●
●
●
●
Member Load Message Log
– dimension members that were loaded
Member Load Exception Log
–dimension members that could not be loaded
Data Load Message Log
–data that was loaded
Data Load Exception Log
–data that could not be loaded
9
Click Close.
Glossary
#Missing See
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 examples: accounts payable, accrued expenses, and long-term debt. Equity examples: common stock, preferred stock, additional paidin-capital, and retained earnings.
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.
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.
alias An alternative name for a dimension, member, or description.
alias table A database table that contains a list of secondary names for a given member within a dimension.
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 data 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 data form. For example, a data 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. 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.
Glossary
421
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.
balance account An account type that stores unsigned values that relate to a particular point in time.
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 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 file containing commands that define how a block storage 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.
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.
An Analytic Services database is a cube.
currency The monetary unit of measure associated with a balance or transaction.
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 U. S. dollar into the euro, the exchange rate (for example, 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 nonmonetary) associated with the query intersection.
data form A grid display that allows users to enter data into the database from a Web browser, and to view and analyze data or related text. Certain dimension member values are fixed, giving users a specific view into the data.
data source 1. A data storage application. Varieties include multidimensional databases, relational databases, and files.
2. A named client-side object connecting report components to databases. Data source properties include database connections and queries.
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.
422
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.
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.
dimensional hierarchy A type of Shared Services model that typically includes a hierarchy of related group
members, such as entities or accounts. See also
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 Navigation through the query result set using the organization of the dimensional hierarchy. Drilling down moves the user perspective from general aggregated data to more detailed data. While default drill down typically refers to parent-child navigation, drilling can be customized to use other dimension member relationships.
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.
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.
export The process of moving a model, including its contents, from the application to Shared Services. See also
.
external authentication The practice of storing user logon credentials in a corporate authentication repository (such as a Lightweight Directory Access Protocol [LDAP] directory) as an alternative to maintaining users and groups that are native to each Hyperion product.
file delimiter One or more characters, such as a comma
(,), separating fields in a data source.
filter In Shared Services, a method that enables users to filter selected members from the model when the model is imported. See also
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.
generation A layer in a hierarchical tree structure that defines member relationships in a database. For example, generations are ordered incrementally from the top member of 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.
Glossary
423
Hyperion System 9 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 System 9 Financial Reporting A graphical report writer that enables users to create a wide variety of financial reports for printing and online access.
Hyperion System 9 Shared Services An application enabling users to share data between supported Hyperion products by publishing data to Shared Services and running data integrations.
import The process of moving a model, including its contents, from Shared Services to the application. See also
.
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 forms, create worksheets using Smart
View for Office, create reports using Financial Reporting, create and launch integrations using Hyperion Application
Link, create and launch business rules using Business Rules and/or Analytic Services, enter and view data in Web data forms and Smart View.
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.
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 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.
model A file or string of content containing an application-specific representation of data. Models are the basic data managed by Shared Services. Models are of two major types: dimensional and non-dimensional application objects.
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 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 Smart View for Office.
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.
424
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 form, all the data in the form is displayed in Euro values.
precision Number of decimal places displayed in a number.
private application An application for the exclusive use of a product to store and manage Shared Services models.
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 action to move a data unit to the next review level. This would allow a user who has the appropriate access to review the date. For example, an analyst may promote the data unit to the next level for his supervisor’s review.
RDBMS See
relational database management system
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. 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.
runtime prompt A system variable that allows values to be entered during the execution of an allocation process.
Values can be members, strings, or numbers.
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 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 agent A Web access management solutions provider employed by companies to protect Web resources; also known as Web security agent. The Netegrity
SiteMinder product is an example of a security agent.
security platform A framework providing the ability for
Hyperion applications to use external authentication and single sign-on.
security rights Rights defined by a user’s data access permissions and activity-level privileges as explicitly defined for a user and as inherited from other user groups.
shared application An application in Shared Services that enables two or more products to share their models. See
also
.
shared member A member that shares storage space with another member of the same name. A storage property designates members as shared. The use of shared members prevents duplicate calculation of members that occur more than once in an Analytic Services outline.
shortcut menu A menu that is displayed when you rightclicks a selection, an object, 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 East and siblings of each other.
Glossary
425
single sign-on The ability of an externally-authenticated user to access multiple, linked Hyperion applications after logging on to the first application. The user can launch other applications from the first application (and from other linked Hyperion applications) without logging on again. The user’s ID and password are already authenticated.
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.
substitution variable A variable that acts as a global placeholder for information that changes regularly. The variable and a corresponding string value is set; the value can then be changed at any time. Substitution variables can be used in calculation scripts, report scripts, rules files, outline formulas, security filters, partition definitions,
MDX statements, Smart View for Office, Analytic Services
API, and Planning data forms.
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.
synchronized The condition that exists when the latest version of a model resides in both the application and in
Shared Services. See
.
system administrator A person responsible for installing and initially configuring 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.
user variable A variable that dynamically renders data forms based on a user’s member selection, displaying only the specified entity. For example, the user variable named
Department enables you to display only specific departments and employees.
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.
426
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Symbols
#missing data displaying as empty cells,
representing with Smart Lists,
suppressing in columns,
suppressing in rows,
#Missing Data Form Label option,
#Missing Drop-Down Label option,
Numerics
4-4-5 weekly pattern,
500 error message,
5-4-4 weekly pattern,
56K dialup connections, using,
A
access rights assigning to data forms,
assigning to task lists,
assigning to users and groups,
available options,
defining for scenarios,
inheritance options,
modifying for members,
overview,
reporting on,
Index
access to application, withdrawing,
Account members account types,
annotating,
data type and exchange rate type,
plan types,
saved assumptions,
account types
default time balance property,
described, 139 examples of use, 139
summary of,
Actual_365 weighted average time balance, 141
Actual_Actual weighted average time balance,
adapter palette,
adapter process
running,
Add Smart List Entries tab,
administrators
and application ownership, 31 ,
application owner,
creating the application,
populating the application, 34
Advanced Settings option
Index Symbols
427
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
aggregation options,
alias names about,
displaying on data form rows, 256
alias tables
copying,
deleting,
editing,
setting the application default, 99
Allow Multiple Currencies Per Entity option, 265
Allow Search When Number of Pages Exceeds option,
Allow Users to Dynamically Add Rows option,
Analytic Services
connecting to multiple servers, 42
multidimensional databases, 66
naming restrictions,
starting,
working with partitions,
Analyze and Report page, setting links for,
ancestors, determining for a member, 131
annotating
application databases, implications of creating,
overview to creating and refreshing, 32
overview to populating with data, 34
application currency conversion calcscript
and create database,
application databases about,
refreshing, 69 refreshing incrementally, 69
application defaults overriding,
setting,
Application drop-down list,
Application Maintenance Mode, 317
application management. See Shared Services applications.
application servers
unregistering,
applications
creating additional,
currency conversion calcscripts,
defining currencies,
defining the calendar range, 57
forcing users off,
overview,
problem creating,
Reference Application,
registering for Shared Services, 316
saving,
setting up plan types,
unlocking,
using,
Apply Precision option,
Apply Security check box,
APPSCHEDULER utility,
ARBORPATH variable,
Assigned Access check box,
asymmetric rows and columns, 262
attribute values
428
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
defining,
deleting,
effect of changing dimension from sparse to dense, 157
overview,
using in data forms,
using in Hyperion Application Link, 164
attributes
deleting,
effect of changing dimension from sparse to dense, 157
on data forms,
overview,
renaming,
using in data forms,
using in Hyperion Application Link, 164
audience for this guide,
Automatically Generate ID option,
Average option in Exchange Rate Table window, 120
average time balance property, 140
B
background mode, importing users, 87
backing up an application,
databases,
base currency for Entity members, 138
base time period defining,
spreading data,
BegBalance member. See Beginning Balance time period
BegBalance option in Exchange Rate Table window, 120
Beginning Balance time period
bottom-up versions,
browser controls, hiding,
budget process impact of the entities hierarchy,
Business Rules and broadcast messages,
business rules
C
editing,
overview,
post-planning activities,
migrating data,
and dynamic calc members,
in Reference Application,
launch upon Save,
launching overview,
migrating,
overview to using with data forms,
selecting members for runtime prompts, 269
Streamline View,
using,
Calculate Currencies business rule about,
deselecting,
Index B
429
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
importance of launching order,
Calculate Data Form business rule
creation of,
description,
importance of launching order,
Run on Save option,
calculation method of currency conversion,
calendar range, defining,
Calendar workspace frame,
calendars adding years to,
changing the current year or time period,
creating in applications,
creating summary time periods, 103
defining roll ups,
deleting summary time periods, 104
practical limits,
cascading style sheets, customizing, 341
category nodes on the Desktop,
cells, read-only,
to
change-tracking,
characters, reserved,
Classic View option,
ClosedInputValueBlock variable, 336
closing applications,
collapsed member list, setting,
colors, customizing in the UI, 346
column definitions
changing,
column properties, setting,
Column Width option,
columns
read-only, 253 separators for, 253
suppress hierarchy,
commands, Help menu,
common member attributes in Shared Services,
compression filter,
conflicting changes to data, 357
Copy Data Link feature,
Copy Version error when using,
using,
copying an application,
data,
supporting detail,
CrossRef(accountName) function,
CrossRef(accountName, prefix) function, 337
currencies calculating conversions,
conversions with,
defining in an application,
editing,
enabling multiple,
multiple,
reporting,
112 viewing information about, 112
currency conversion calc script failed,
Currency option in Exchange Rate Table window, 119
Current Application Defaults option about,
using,
custom attribute display, enabling, 145
customizing text about,
customizing the UI
430
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
of data forms,
of row and column members, 345
of the Tools page,
of the Web client,
when using WebLogic,
when using WebLogic and UNIX, 351
with a cascading style sheet, 341
customOnLoad,
CYTD(memberName) function,
CYTD(memberName, calTpIndexName,
fiscalTpIndexName) function, 337
D
data copying,
suppress missing in columns,
suppressing missing in rows, 255
data entry forms. See data forms
data files load file example,
Data Form menu item,
data forms about,
access rights, described,
asymmetric rows and columns, 262
attribute values as members,
business rules for,
currencies,
customizing with JavaScript,
designing with multiple currencies, 247
displaying Smart Lists in, 330
importing data form definitions, 277
,
in Reference Application,
large, improving performance,
layout,
members,
menus, associating with,
multiple currencies,
naming restrictions,
options,
plan types,
point of view,
previewing design,
printing form definitions,
properties, 252 read-only, 252
shared members,
data integrations. See Shared Services data integrations.
data load dimension,
data source name (DSN),
Data Storage property about,
setting,
data type for Account members, 143
Database check box. See refreshing databases
databases
Analytic Services,
66 implications of creating, 66
naming rules,
See also applications, application databases
setting restructuring interval, 71
unlocking,
DCOM, configuring,
decimal places on the data form,
defaults
Index D
431
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
alias table,
overriding with personal preferences,
setting for the application, 315
setting system,
Define Basis tab,
DeleteSharedDescendants utility,
dense dimensions,
changing to sparse,
Dependency check box,
dialup connections,
dimension hierarchy expanding and collapsing,
navigating,
setting the number of members displayed,
sorting members,
Dimension(dimtag) function, 337
dimensions
Account,
aggregation options,
expanding,
finding,
hierarchies,
overview,
relationship to members,
sparse,
storage options,
user-defined,
Display Missing Values as Blank option, 265
Display Order option for Smart Lists, 328
Display Users’ Full Names option and importing security,
setting,
distribution of data over time periods, 56
documents conventions used,
feedback,
structure of,
documents, accessing
Hyperion Download Center,
Hyperion Solutions Web site, xvii
Information Map,
online help,
down arrows in data cells,
drawCustomButtons,
driver dimensions,
DSN (data source name),
Due Date check box,
Dynamic Calc and Store option, setting, 132
dynamic calc members about,
and currency conversion calc script,
database refresh and member formulas,
in currency conversion calc script, 358
setting,
dynamic calc versus dynamic calc and store,
dynamically adding rows about,
enabling,
E
Edit Smart List Entries tab,
Edit Smart List Properties tab, 328
education services,
Effective Access check box,
e-mail notification, about setting up,
Enable Account Annotations option,
Enable custom attribute display option, 145
Enable Smart Lists check box,
Ending option in Exchange Rate Table window, 120
enterprise resource planning (ERP),
Entity dimension,
Entity members alias table,
and plan types,
equity account type, example,
432
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Essbase. See Analytic Services
examples of deleting account annotations,
of deleting supporting detail associated with a
exchange rate tables defining for scenarios,
deleting,
exchange rates
types,
types for Account members,
expanded member list, setting for rows, 256
expense account type,
examples,
exporting data forms,
expressions. See formula expressions
fonts
in PDF file,
forcing users off the system, 317
FormDefUtil utility,
formula expressions,
prerequisites for using,
syntax for,
335 using in member formulas, 335
functions in Smart View,
functions. See formula expressions
G
getCalendarTPIndex() function, 337 getFiscalTPIndex() function, 337
global settings about,
specifying,
global.css style sheet,
Group the Results By option,
F
Failed to execute error message, 338
Financial Reporting
security,
First time balance property, 140
FIX statement, troubleshooting, 358
Flat File Adapter
flat file load file,
Flow time balance property,
folders
H
HAL. See Hyperion Application Link
Help menu commands,
Historical option in Exchange Rate Table window, 119
Hsp_Audit_Records table,
Hsp_Rates dimension,
HspCustomImgs_en.template file, 347
HspCustomMsgs_en.template file,
HspJSHome.properties file adding fonts to,
configuring JDBC connection pooling,
default location,
overview,
Index F
433
I
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
supporting detail cache,
Hyperion Application Link
creating an adapter process,
effect of deleting a member, 153
flow diagram workspace,
missing icon,
using attributes and attribute values, 164
Hyperion Consulting Services, xx
Hyperion Download Center,
Hyperion Education Services, xx
Hyperion Essbase Adapter
Hyperion Hub applications. See Shared Services
applications.
Hyperion Hub data integrations. See Shared Services data
integrations.
Hyperion Hub models. See Shared Services models.
Hyperion Planning Adapter
loading attribute values,
181 loading shared members, 181
Hyperion Planning Spreadsheet Add-in. See Smart View
Hyperion product information, xix
Hyperion products single sign-on,
Hyperion Smart View for Office. See Smart View
Hyperion Solutions Web site, xvii
Hyperion Technical Support, xx
IBM DB2 database database is locked message,
361 enabling more connections, 361
images customizing with the cascading style sheet,
J
customizing with the HspCustomImgs_en file,
ImportFormDefinition utility, 277
importing access rights,
data,
importing content into Smart View, 26
importing models. See Shared Services models.
Include Supporting Detail option, 266
incremental refresh,
Information Map,
inheritance options
Children (inclusive) option,
Descendant (inclusive) option,
iChildren option, 85 iDescendant option, 85
initializing the Reference Application,
integrating data. See Shared Services data integrations.
JavaScript, customizing data forms with, 387
JDBC driver, changing,
L
label only data storage about,
setting,
labels
in Smart Lists,
landscape printing orientation, 265
language in the UI, localizing,
leap year, accounting for,
liability account type, example,
Linking tasks to Planning Web pages, 299
links to URLs
434
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
from the Tools page,
loading data
into the Reference Application, 417
labels,
Lock Current Application From Other Users option, 69
locking users out of an application,
logged-on users,
logging on to Planning Web,
unsuccessful try,
M
Marked for Delete property,
Member Alias option,
member attributes used in Shared Services,
member formulas
using formula expressions in, 335
validating, 334 viewing results of validation, 334
working with,
Member Name option,
member selection on data forms,
setting for runtime prompts, 269
members
assigning access to,
assigning attribute values to,
deleting,
determining ancestors, 131 determining where used,
editing,
expanding,
finding,
effect of moving on plan types,
importing custom dimension members,
importing using Hyperion Application Link, 179
moving within the dimension hierarchy, 129
names, displaying on data form,
of the Entity dimension,
unmarking for deletion,
working with shared members, 153
Menu Header menu item,
menu items
icons for,
introduction,
Menu Header,
types,
URLs,
Workflow type,
menus
associating with data forms, 266
introduction,
message announcements,
for scheduled application refresh,
metadata
shared through Shared Services,
Method option in Exchange Rate Table window, 119
minimizing dimension columns,
missing data in accounts calculations,
model management. See Shared Services models.
Index M
435
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
monthly distribution patterns, 56
multiple currencies,
designing data forms with,
enabling,
loading exchange rate data, 183
Oracle, creating the HspJSHome.properties file,
overview of Planning,
of Reference Application,
owner of the application, assigning, 316
N
naming
members,
naming conventions applications,
databases,
members,
naming restrictions
Analytic Services user names,
for applications and databases, 398
for dimensions, members, and aliases, 399
in calculation scripts and report scripts, 401
in formulas and filters,
native2ascii program,
navigation frame on the Desktop, 47
network bandwidth, increasing,
Never Share option about,
setting,
non-expense account types, 141
Number of Data Columns Per Page option, 265
NumberOfPeriodsInYear variable,
NumberOfYears variable,
O
OpenInputValueBlock variable,
optimizing performance
of calculations on data forms,
of currency conversion,
over dial-up connections,
when importing access assignments, 88
P
page axis about,
defining,
enabling search facility,
partitions,
PDF printing, fonts in,
Percentage of Page to Use for Row Headers option,
performance optimizing currency conversion,
optimizing in applications,
optimizing over dial-up connections,
when importing access assignments,
when opening large data forms,
Period(periodName) function,
personal preferences, setting,
plan building overview,
plan types
effect of moving members,
Entity members,
setting up in applications, 58
planning cycle overview,
Planning Desktop controlling the display,
starting,
annotating,
enabling e-mail notification, 287 printing annotations, 287
starting the review process, 286
point of view about,
defining,
263 hiding or showing members on, 263
populating the application, overview,
portrait printing orientation, 265
436
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
ports, connecting,
post-planning activities overview,
preferences, setting personal,
prerequisites for using this guide,
Preview tab for Smart Lists, 330
previewing data form design,
printing
options for data forms,
planning unit annotations, 287
private applications. See Shared Services applications.
process status states
overview to customizing,
properties file. See HspJSHome.properties file
Q
quick connect port connection,
R
range of time periods, setting,
Read-only option for data forms,
RefAppUpgradeUtility file, 417
Reference Application business rules,
creating the database,
overview,
upgrading to a large application,
Refresh Users and Groups button
when assigning access to a data form, 271
when assigning access to a dimension member,
when assigning access to a task list, 300
refreshing databases,
incrementally,
registering the application server, 50
relational database, optimizing,
Repeat Every check box,
Repeat Headers on All Pages option, 266
reporting currencies,
reports
Required Dimension drop-down list,
reserved characters
restoring dimension columns,
revenue account type
summary,
RMI port number,
roll ups, defining in calendars,
row definitions about dynamically adding,
changing,
dynamically adding,
row properties, setting,
Row/Column Layout tab,
rows
suppress hierarchy,
Russian font, adding,
S
problem-solving, scheduling,
in Reference Application,
on access assignments,
saved assumptions,
scaling,
scenarios
and currency conversion calc scripts, 68
changing the order,
copying,
defining access rights,
Index Q
437
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
defining exchange rate tables,
defining time periods,
deleting,
deleting supporting detail, 319
editing,
scheduling
sddelete.sql file,
searching among pages,
security about,
setting up in Financial Reporting, 85
security filters generating for all users,
generating for one or more users,
segments
suppress hierarchy, for columns,
suppress hierarchy, for rows,
Select Another Rate Table option,
separator lines, described, 252
separators
servers
unregistering,
shading display option,
shared members,
applying security to,
setting,
setting,
shared models. See Shared Services models.
Shared option overview,
Shared Services
assigning a Planning application to a project, 193
registering an application,
Shared Services applications common shared application,
naming restrictions,
overview,
overview of private applications,
overview of shared applications,
sharing, 199 stopping sharing, 199
Shared Services data integrations
assigning access,
Create Integrations user role,
editing,
filtering integration lists, 228
overview,
prerequisites,
scheduling group integrations, viewing integrations,
Shared Services models
application system members,
assigning permissions,
compare operations,
configuring for external authentication, 192
438
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
deleting,
described, 192 dimensional hierarchies, 192
editing member properties, 209
managing permissions,
naming restrictions,
non-dimensional hierarchies, 192
overview,
permissions,
private,
properties, viewing and setting,
registering applications,
renaming,
setting properties,
shared,
shared applications,
sharing data, 195 sharing metadata, 195
sync operations,
types of permission,
versioning,
viewing properties,
Shared Services Server URL option,
Show __ Members on Each Dimensions Page option,
Show Account Annotations option, 266
Show Ancestors button,
Show Attribute Members option,
Show Columns option in Exchange Rate Table window,
Show Currency Codes option, 266
Show drop-down list about,
options on,
Show Inherited From Group check box,
Show Matching Access of Relation check box, 91
Show Matching Access of Type option,
Show Separator option,
Show Shading option,
Show Usage button,
Smart Lists
adding or changing entries, 329
and data entry,
customizing,
displaying in data forms,
representing #missing,
setting precedence,
setting properties,
using in formula expressions, 336
working with,
Smart View
and business rules,
benefits,
functions,
importing content,
key features,
overview,
overview to setting up worksheets, 33
terminating for application refresh, 74
sorting members,
SortMember utility,
source plan type
effect of moving members,
sparse dimensions,
effect of changing to dense,
spreading data,
Spreadsheet Add-in. See Smart View
Index S
439
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Start Expanded option,
starting Planning on the Desktop,
on the Web,
with the Launch page,
statistics on usage,
storage options,
Store option about,
setting,
style sheets, customizing,
summary time periods changing the range,
deleting,
supporting detail associated with a scenario, deleting,
benefit,
copying,
detection cache allocating memory for,
percentage used,
Suppress Hierarchy option for columns,
for rows,
Suppress Missing Data option for columns,
for rows,
suppressed hierarchy, described, 252
tasks
overview,
reordering,
alert messages,
copying,
defining,
dependencies,
due date messages,
overview,
technical support,
terminating applications for refresh, 74
text about customizing,
customizing in the UI,
time balance calculations,
time periods changing,
defining for scenarios,
practical limit,
Time Periods dimension, about,
timeout for sessions,
Tools Analyze and Report page, setting links for,
tools, setting custom,
triangulation overview,
T
target versions description,
Task List Date Format option, 316
task list folders
deleting,
task lists assigning access,
U
UDAs changing,
working with,
unlocking applications,
unmarking members that are pending deletion, 135
unregistering the application server, 50
440
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
URL tasks, single sign-on, 294
URLs, setting up,
user names, displaying full names, 316
user variables
deleting,
overview,
users
displaying full names,
utilities
for deleting shared descendants, 320
for importing and exporting data forms,
for importing data form definitions,
for importing security,
for loading data into the Reference Application, 417
for scheduling a refresh,
for sorting members,
for unlocking an application,
W
editing,
error when copying,
setting up bottom-up versions,
, 171 setting up target versions, 171
target, and currency conversion,
Warn If Data Form Larger Than __ Cells option,
Web Analysis, overview,
Web client about,
starting,
web.xml file,
WebLogic, customizing the UI with,
weekly distribution patterns, 56
Weighted Average time balance properties,
Y
years adding to calendar,
changing current,
maximum,
practical limit,
Years option in Exchange Rate Table window,
V
Valid For plan type setting
and Entity members,
effect of moving members,
specifying,
Validate Member Formula option,
validate security filter size, 70
validateForm,
variance reporting and account type, 140
versioning. See Shared Services models.
versions
and currency conversion calc scripts, 68
changing the order,
copying,
Z
zeros in accounts calculations,
Index V
441
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
442
Prenesi
Javna povezava posodobljena
Javna povezava do vašega klepeta je bila posodobljena. You may view and manage your chat links after registration here.
Javna povezava do dokumenta
Oglas