Вы находитесь на странице: 1из 136

BusinessObjects Planning Guide to Integration with BusinessObjects XI

BusinessObjects Planning XI Release 2

Copyright

2008 Business Objects. All rights reserved. Business Objects owns the following U.S. patents, which may cover products that are offered and licensed by Business Objects: 5,295,243; 5,339,390; 5,555,403; 5,590,250; 5,619,632; 5,632,009; 5,857,205; 5,880,742; 5,883,635; 6,085,202; 6,108,698; 6,247,008; 6,289,352; 6,300,957; 6,377,259; 6,490,593; 6,578,027; 6,581,068; 6,628,312; 6,654,761; 6,768,986; 6,772,409; 6,831,668; 6,882,998; 6,892,189; 6,901,555; 7,089,238; 7,107,266; 7,139,766; 7,178,099; 7,181,435; 7,181,440; 7,194,465; 7,222,130; 7,299,419; 7,320,122 and 7,356,779. Business Objects and the Business Objects logo, BusinessObjects, Business Objects Crystal Vision, Business Process On Demand, BusinessQuery, Cartesis, Crystal Analysis, Crystal Applications, Crystal Decisions, Crystal Enterprise, Crystal Insider, Crystal Reports, Crystal Vision, Desktop Intelligence, Inxight, the Inxight Logo, LinguistX, Star Tree, Table Lens, ThingFinder, Timewall, Let There Be Light, Metify, NSite, Rapid Marts, RapidMarts, the Spectrum Design, Web Intelligence, Workmail and Xcelsius are trademarks or registered trademarks in the United States and/or other countries of Business Objects and/or affiliated companies. Business Objects is an SAP company. SAP is the trademark or registered trademark of SAP AG in Germany and in several other countries. All other names mentioned herein may be trademarks of their respective owners. Business Objects products in this release may contain redistributions of software licensed from third-party contributors. Some of these individual components may also be available under alternative licenses. A partial listing of third-party contributors that have requested or permitted acknowledgments, as well as required notices, can be found at: http://www.businessobjects.com/thirdparty 2008-06-15

Third-party Contributors

Contents
Chapter 1 Introduction 9 About this guide.........................................................................................10 Who should read this guide..................................................................10 Terminology conventions...........................................................................10 Get more help............................................................................................11 Chapter 2 BusinessObjects Integration 13

About BusinessObjects Integration...........................................................14 About BusinessObjects Enterprise user integration.............................14 About universe creation........................................................................15 Integration requirements and prerequisites...............................................17 Technical requirements........................................................................17 CMS access account............................................................................18 Security integration...............................................................................19 To enable BusinessObjects integration.....................................................19 BusinessObjects Integration settings...................................................20 BusinessObjects integration features...................................................23 Chapter 3 BusinessObjects Enterprise user integration 25

BusinessObjects Enterprise user integration concepts.............................26 About imported users...........................................................................26 Properties imported from BusinessObjects Enterprise........................27 Understanding BusinessObjects Planning systems.............................27 Handling parent groups and subgroups...............................................28 The BusinessObjects Enterprise user import process...............................29 Configuring BusinessObjects Enterprise user import settings...................30

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Contents

To configure BusinessObjects Enterprise import settings....................30 To export the BusinessObjects Enterprise import settings...................34 Importing BusinessObjects Enterprise users.............................................35 To import BusinessObjects Enterprise users.......................................35 To schedule a BusinessObjects Enterprise user import for automated execution..............................................................................................35 BusinessObjects Enterprise user import rules.....................................36 Security rights for users imported from BusinessObjects Enterprise........39 BusinessObjects Enterprise authentication...............................................40 Chapter 4 Process Overview for Planning Universe Creation 43

Planning the universe................................................................................45 Chapter 5 Handling time in Planning universes 47

Comparing column-based time and row-based time.................................48 Column-based time..............................................................................48 Row-based time...................................................................................49 Reasons to adopt row-based time in Planning universes....................50 How row-based time is created in BusinessObjects Planning...................51 Example case of converting column-based time to row-based time.....51 Chapter 6 Defining time structures for Planning universes 55

Defining time dimensions...........................................................................56 Time dimension structure.....................................................................58 To add a time dimension......................................................................58 To delete a time dimension...................................................................59 Defining grouping columns for a time dimension.................................59 Defining time dimension values.................................................................61 To define values for a time dimension..................................................62 Defining time pivots...................................................................................62

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Contents

About time pivot structure.....................................................................64 Time pivot storage types......................................................................66 To add a time pivot...............................................................................67 To edit the settings of a time pivot........................................................69 To delete a time pivot...........................................................................70 Defining data columns for a time pivot.................................................71 Impacts of time pivots on Data Structures update...............................75 Data Structures naming conventions.........................................................76 Chapter 7 The Planning universe structure 77

Structure terminology.................................................................................78 Universe terminology............................................................................78 BusinessObjects Planning terminology................................................79 Planning classes and objects....................................................................81 Native fact classes...............................................................................81 Time pivot classes................................................................................83 Validated dimension classes................................................................84 Time dimension classes.......................................................................86 Example case.......................................................................................86 Rollups and hierarchies.............................................................................90 About rollups and hierarchies...............................................................91 How rollups and hierarchies are applied as custom hierarchies..........91 Creating or modifying hierarchies in Designer.....................................92 Chapter 8 Defining Planning universes 93

About universe definitions and universe files............................................94 Defining universes in BusinessObjects Planning......................................94 To add a universe definition..................................................................96 To edit a universe definition..................................................................96 Universe settings..................................................................................97

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Contents

To delete a universe definition..............................................................98 Managing the classes in a universe.....................................................99 To view the manually managed elements in a universe.....................104 Properties of Planning-generated universes...........................................104 Universe placement in the repository.................................................105 Universe contents created by BusinessObjects Planning..................105 Modifying Planning universes in Designer...............................................106 Modifying Planning-managed elements.............................................106 Creating and modifying manually managed elements.......................107 Removing obsolete elements.............................................................107 Modifying universe settings in Designer.............................................108 Running an integrity check in Designer on Planning universes.........108 Chapter 9 Administering Planning universes 111

Updating Planning universes...................................................................112 Events that trigger automatic universe updates.................................112 What occurs during a universe update...............................................114 When to manually execute a universe update...................................115 Refreshing time pivots.............................................................................116 To refresh a time pivot manually.........................................................116 To schedule a time pivot refresh for automated execution.................117 Managing access to Planning universes.................................................118 User rights to Planning universes......................................................118 Applying data filters as access restrictions........................................120 Chapter 10 URL Syntax for Launching Planning Web Access Options 125

Using a BusinessObjects Enterprise logon token....................................126 Using a BusinessObjects Enterprise authentication type........................127 URL syntax for direct launch....................................................................128

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Contents

Index

131

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Contents

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Introduction

Introduction About this guide

About this guide


This guide covers configuration, administration and use of the BusinessObjects integration features in BusinessObjects Planning. Topics include: overview of integration features enabling BusinessObjects integration importing users from BusinessObjects Enterprise creating and administering universes built from BusinessObjects Planning data

This guide assumes that you have a working installation of both BusinessObjects Planning and BusinessObjects.

Who should read this guide


This guide is intended for the following audiences: Information Technology professionals responsible for administering the organization's BusinessObjects system Master System Users (administrators) of BusinessObjects Planning

Use of the BusinessObjects integration features typically requires a collaboration between these two parties. A successful implementation of the integration features requires an understanding of both systems and their use in the organization's environment.

Terminology conventions
Each implementation of BusinessObjects Planning uses terminology that is specific to the customer's environment. For example, the dimension names, time series names, and data source names used in your system may be quite different than the names used in other BusinessObjects Planning installations. When discussing BusinessObjects Planning features and capabilities, certain terminology assumptions must be made. For example, the documentation generally uses the term Department to indicate the primary planning

10

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Introduction Get more help

dimension. Your organization may use the term Cost Center or Project, however, the general concept is the same. Your system's time series and other columns may also be different than those used in the documentation. For example, you might use the time series ACT instead of CYA. You should apply your own system's terminology and structure as you read the discussion and examples in the documentation.

Get more help


Documentation

Business Objects offers a full documentation set covering all products and their deployment. You can access documentation from the product interface or from the Business Objects online documentation library. The online documentation library has the most up-to-date version of the Business Objects product documentation. The library is updated with new content as it becomes available. For details on what documentation is available for BusinessObjects Planning, see the BusinessObjects Planning Documentation Roadmap. The full electronic documentation set can be found on the web at http://sup port.businessobjects.com/documentation/product_guides/. Installation-related documentation can also be found on your product distribution, in the \Docu ments folder.
Online customer support

The Business Objects Customer Support web site contains information about Customer Support programs and services. It also has links to a wide range of technical information including knowledgebase articles, downloads, and support forums. http://www.businessobjects.com/support/
Looking for the best deployment solution for your company?

Business Objects consultants can accompany you from the initial analysis stage to the delivery of your deployment project. Expertise is available in relational and multidimensional databases, in connectivities, database design

BusinessObjects Planning Guide to Integration with BusinessObjects XI

11

Introduction Get more help

tools, planning and performance management, customized embedding technology, and more. For more information, contact your local sales office, or contact us at: http://www.businessobjects.com/services/consulting/
Looking for training options?

From traditional classroom learning to targeted e-learning seminars, we can offer a training package to suit your learning needs and preferred learning style. Find more information on the Business Objects Education web site: http://www.businessobjects.com/services/training
Send us your feedback

Do you have a suggestion on how we can improve our documentation? Is there something you particularly like or have found useful? Drop us a line, and we will do our best to ensure that your suggestion is included in the next release of our documentation: documentation@businessobjects.com
Note: If your issue concerns a Business Objects product and not the

documentation, please contact our Customer Support experts. For information about Customer Support visit: http://www.businessobjects.com/support/.
Business Objects product information

For information about the full range of Business Objects products, visit: http://www.businessobjects.com.

12

BusinessObjects Planning Guide to Integration with BusinessObjects XI

BusinessObjects Integration

BusinessObjects Integration About BusinessObjects Integration

This section discusses the basics of integrating BusinessObjects Planning with BusinessObjects XI. You should read this section to understand the scope of the integration features and the system requirements and prerequisites. The integration features do not appear in BusinessObjects Planning unless they are enabled. This section also explains how to enable the integration features.

About BusinessObjects Integration


BusinessObjects Planning can integrate with BusinessObjects in the following areas: The ability to import users from BusinessObjects Enterprise to BusinessObjects Planning The ability to automatically generate universes for BusinessObjects Planning data

Although user import and universe creation are related, they can be adopted independently and do not need to be performed in any particular order.

About BusinessObjects Enterprise user integration


This section explains the general scope of the BusinessObjects Enterprise user integration features in BusinessObjects Planning. For specific details on the features discussed in this section, see BusinessObjects Enterprise user integration on page 25.

User integration overview


Using the user integration features, you can import users from BusinessObjects Enterprise to BusinessObjects Planning. Imported users remain synchronized with BusinessObjects Enterprise and are authenticated by BusinessObjects Enterprise. Within BusinessObjects Planning, you select specific BusinessObjects Enterprise groups to import into BusinessObjects Planning. Upon the initial import, the selected groups and their component users are created in BusinessObjects Planning and flagged as imported users and groups. Basic

14

BusinessObjects Planning Guide to Integration with BusinessObjects XI

BusinessObjects Integration About BusinessObjects Integration

user information such as Account Name, Full Name and Email are copied into BusinessObjects Planning. On an ongoing basis, you can synchronize the user list with BusinessObjects Enterprise by performing periodic imports. Each time an import is performed, new users are added, deleted users are flagged as obsolete, and modified users are updated. User imports can be performed manually on an ad hoc basis, or scheduled for automated execution. Any user who is flagged as imported from BusinessObjects Enterprise is also authenticated for entry into BusinessObjects Planning by BusinessObjects Enterprise. The BusinessObjects Planning login dialog allows users to select from the standard BusinessObjects Enterprise authentication methods. Single sign-on is not supported users must always enter their credentials.

Benefits of user integration


For environments with users who require access to both BusinessObjects Planning and BusinessObjects Enterprise, user integration provides the following benefits: Single-source user creation and basic user administration. Note that the specific user rights for the BusinessObjects Planning system must still be maintained in BusinessObjects Planning. Single-source authentication. Users do not have separate passwords to access BusinessObjects Planning.

User integration is typically adopted in conjunction with BusinessObjects Planning universe creation. If automated security is enabled for Planning universes, then imported users are automatically granted access to Planning universes, and their BusinessObjects Planning data filters are translated to universe access restrictions.

About universe creation


This section explains the general scope of the universe creation features in BusinessObjects Planning. Each of the features mentioned in this section are discussed in more detail elsewhere in this guide. For an overview of the

BusinessObjects Planning Guide to Integration with BusinessObjects XI

15

BusinessObjects Integration About BusinessObjects Integration

creation process and links to specific information, see Process Overview for Planning Universe Creation on page 43.

What is a universe?
A universe is a construct that allows business intelligence users to query data without needing to directly interact with the databases data structures. Universes consist of the following: connection parameters to the database a collection of SQL structures called objects that map to the actual SQL structures in the database a schema of the tables and joins used in the database

Business intelligence users connect to the universe, and run queries against the database by using the universe objects.

Universe creation overview


Using the universe creation features in BusinessObjects Planning, you can automatically generate universes based on the BusinessObjects Planning database. Within BusinessObjects Planning, you create universe definitions by determining which BusinessObjects Planning data structures to include in each universe. The data structures are grouped into pre-defined universe classes and objects. You can choose to include all classes and objects, or specify particular classes and objects. When the universe definitions are saved, BusinessObjects Planning automatically generates universes based on those definitions and saves the universes to the Central Management Server (CMS). Once a universe is created, it is updated automatically whenever a structure-changing event occurs in BusinessObjects Planning. If automated security is enabled for the universe, then users imported from BusinessObjects Enterprise are automatically granted access to the universe and their data filters are converted to universe access restrictions. Updates to imported users also trigger an update to the universe. Because BusinessObjects Planning natively stores time-varying data across columns instead of over rows, features have been added to BusinessObjects

16

BusinessObjects Planning Guide to Integration with BusinessObjects XI

BusinessObjects Integration Integration requirements and prerequisites

Planning to allow the definition of time dimensions and time pivots. Use of these time structures allows Planning universes to present time-varying data in a way that is familiar to users of BusinessObjects business intelligence tools.

Universe creation benefits


The universe creation features provide the following benefits: A streamlined and managed process for generating and updating universes for BusinessObjects Planning databases. The ability to access BusinessObjects Planning data using any of the BusinessObjects business intelligence tools. Use of the time dimension features provides the additional benefit of drilling BusinessObjects Planning data by time (this is not possible in BusinessObjects Planning itself). The ability to automatically apply BusinessObjects Planning data filters to universes as row access restrictions.

Integration requirements and prerequisites


This guide assumes that you already have operational BusinessObjects Planning and BusinessObjects installations. This section details the requirements and prerequisites for use of the BusinessObjects integration features.

Technical requirements
Required versions

Use of the BusinessObjects integration features requires BusinessObjects XI Release 2 or BusinessObjects XI 3.0.

BusinessObjects Planning Guide to Integration with BusinessObjects XI

17

BusinessObjects Integration Integration requirements and prerequisites

Software prerequisites

A BusinessObjects Enterprise client installation must be performed on each Planning Application Server in your environment. Specifically, the Planning Application Server requires the BusinessObjects Enterprise SDK and Universe Designer. For details on performing a BusinessObjects Enterprise client installation, see the BusinessObjects Enterprise Installation Guide.

CMS access account


BusinessObjects Planning requires a BusinessObjects Enterprise user account under which to access the Central Management Server (CMS). This account is referred to in this document as the CMS access account. The CMS access account must have administrator-level rights. If you plan to import users from BusinessObjects Enterprise, the CMS access account must also have "View" rights to any groups that you want to import. Two options are available to indicate the CMS access account. You can use the existing Planning Service Account, or you can designate a different account within the Planning Configuration Manager.
Using the Planning Service Account

If no user credentials are specified in the Planning Configuration Manager, the Planning Service Account will be used as the CMS access account. The Planning Service Account is the account under which the Planning Application Server runs, as designated during the BusinessObjects Planning install. For more details on the Planning Service Account, see the BusinessObjects Planning Installation Guide. The advantage to this approach is that you do not need to designate a separate user name and password within the Planning configuration file. To use this approach, you must add the Planning Service Account as a user in BusinessObjects Enterprise and give the account the appropriate rights.

18

BusinessObjects Planning Guide to Integration with BusinessObjects XI

BusinessObjects Integration To enable BusinessObjects integration

Designating a user name and password in the Planning Configuration Manager

You can use any BusinessObjects Enterprise account as the CMS access account, as long as the account has the appropriate rights. If you are not using the Planning Service Account, you must designate the user name and password in the Configuration Manager. As a security measure for storing the password, Business Objects provides an encryption utility. You must use this utility to encrypt the password and then copy the encrypted password to the Configuration Manager. The encryption utility is located in your BusinessObjects Planning product distribution, in the \Resources\Utilities folder.

Security integration
BusinessObjects Planning supports several security integration options, including the ability to integrate with Active Directory. However, you cannot enable both security integration and BusinessObjects integration. If BusinessObjects integration is enabled, any security integration option selected in the Planning Configuration Manager will be ignored. Typically, if you want to implement both BusinessObjects integration and security integration, the security integration would be configured within BusinessObjects Enterprise. When imported users log into BusinessObjects Planning, they choose the authentication type that corresponds to the authentication type the user is mapped to within BusinessObjects Enterprise.

To enable BusinessObjects integration


BusinessObjects integration is enabled within the Planning Configuration Manager. This section only discusses the Configuration Manager settings specific to the BusinessObjects integration features. It is assumed that the other configuration settings have already been completed for proper operation of BusinessObjects Planning. For full details on the Configuration Manager, see the BusinessObjects Planning Installation Guide.

BusinessObjects Planning Guide to Integration with BusinessObjects XI

19

BusinessObjects Integration To enable BusinessObjects integration

1. On the server hosting Planning Application Server, choose Start > Programs > BusinessObjects EPM > BusinessObjects EPM Tools > BusinessObjects Planning > Configuration Manager. 2. From the tree structure in the left-hand pane, select Global Parameters > BusinessObjects Integration. The settings for BusinessObjects integration appear in the right-hand pane. 3. Complete the integration settings. See BusinessObjects Integration settings on page 20 for details on specific settings. 4. From the tree structure, select Application Server and confirm that the settings in this pane are complete. The Application Server settings are required for use of BusinessObjects integration. If these settings are not already completed, type in the host name of the Planning Application Server and the port (if you are not using the default port). 5. Save the configuration file. If File Validation errors appear in the bottom of the right-hand pane after saving, correct the appropriate entries and then save the file again before existing the Configuration Manager. You can double-click the message to be taken to the field that generated the error. 6. Restart the Planning Application Service on each Planning Application Server. The next time you log into the Planning Professional Edition, the BusinessObjects integration features will be available for use.

BusinessObjects Integration settings


If BusinessObjects integration is desired, complete all of the settings on the Global Parameters > BusinessObjects Integration node.

20

BusinessObjects Planning Guide to Integration with BusinessObjects XI

BusinessObjects Integration To enable BusinessObjects integration

Field

Description

Integration enabled

Determines whether the BusinessObjects integration features are enabled or not. The default is False. If set to True, the BusinessObjects integration features will appear in BusinessObjects Planning. You must complete the remaining settings on the BusinessObjects Integration pane to enable use of the integration feature set.
Note: You cannot enable both security integration and BusinessObjects integration. If BusinessObjects integration is enabled, any security integration option selected on the Global Parameters > Security node will be ignored.

Platform version

Select the appropriate version of your BusinessObjects Enterprise installation. Select the desired authentication type for the CMS access account. This account is used by BusinessObjects Planning to access the Central Management Server (CMS). The available options are:
secEnterprise secWindowsNT secWinAD secLDAP

CMS Authentication Type

Note: If you are using the Planning Service Account as the CMS access account, this field will be ignored. BusinessObjects Enterprise uses whichever authentication type is designated for the Planning Service Account in BusinessObjects Enterprise.

CMS Username

If you want to use the Planning Service Account as the CMS access account, leave this field blank. Otherwise, type the user name for the CMS access account.

BusinessObjects Planning Guide to Integration with BusinessObjects XI

21

BusinessObjects Integration To enable BusinessObjects integration

Field

Description

CMS Password

If the Planning Service Account is being used as the CMS access account, leave this field blank. Otherwise, you must enter a password for the CMS service account. This password must be encrypted using the encryption utility provided by Business Objects in the \Re sources\Utilities folder of your product distribution. Use the utility to encrypt the password, then copy and paste the encrypted password into the Configuration Manager.

CMS Hostname CMS Port

Type the name of the computer hosting the CMS. If you are not using the default CMS port, type the appropriate port number. Otherwise, leave the default setting of 6400. This setting defines the amount of time allowed to complete requests to the CMS, such as universe updates. If the request is not completed within the designated time, the request will time out and an error will be noted in the application server log. The default timeout value is 120 seconds. If desired, you can edit this setting. Keep in mind that defining a smaller timeout value than the default may result in requests not being completed.

Timeout in seconds of CMS requests

Related Topics

Security integration on page 19 CMS access account on page 18

22

BusinessObjects Planning Guide to Integration with BusinessObjects XI

BusinessObjects Integration To enable BusinessObjects integration

BusinessObjects integration features


If BusinessObjects integration is enabled, the following features become available in the Planning Professional Edition to support user import and universe creation:
User integration features

A menu item is added to Plan > Administration named BusinessObjects Integration. This dialog is used to configure the user import parameters and execute imports. This dialog is only available in the Primary Authentication System, and is only accessible by administrators. A User Import task type is added to the Scheduler utility to facilitate ongoing scheduled imports. The BusinessObjects Enterprise authentication options are added to the BusinessObjects Planning login dialogs.

Security settings for imported users are managed normally within Security Settings.
Universe creation features

Two new areas are added to the Data Structures dialog for definition of Time Dimensions and Time Pivots. These features are optional universes can be created without time dimensions and time pivots. See Handling time in Planning universes on page 47 for more information on the purpose of these structures. A new menu item is added to Plan > Database named Universes. This dialog is used to define universes. This dialog is available to any user who has security rights to Data Structures. A Time Pivot Refresh task type is added to the Scheduler utility to facilitate ongoing refreshes of time pivots.

BusinessObjects Planning Guide to Integration with BusinessObjects XI

23

BusinessObjects Integration To enable BusinessObjects integration

24

BusinessObjects Planning Guide to Integration with BusinessObjects XI

BusinessObjects Enterprise user integration

BusinessObjects Enterprise user integration BusinessObjects Enterprise user integration concepts

This section provides the necessary information to understand and use the BusinessObjects Enterprise user integration features in BusinessObjects Planning.
Note: The BusinessObjects Integration menu item is only available if

BusinessObjects integration has been enabled in the Configuration Manager.


Related Topics

About BusinessObjects Enterprise user integration on page 14 About BusinessObjects Integration on page 14 To enable BusinessObjects integration on page 19

BusinessObjects Enterprise user integration concepts


This section provides an overview of key concepts relating to use of the BusinessObjects Enterprise user integration features.

About imported users


Use of the user integration features introduces the concept of two user types: "imported users" and "BusinessObjects Planning users". The terms "imported user" and "imported group" refer to users and groups that were imported into BusinessObjects Planning from an outside source and that remain synchronized with the original source. The terms "BusinessObjects Planning user" and "BusinessObjects Planning group" refer to users and groups created within BusinessObjects Planning, or imported users and groups that have been converted to BusinessObjects Planning users and groups. All imported users and groups are flagged using the Imported check box at the top of the User Information tab or Group Information tab in Security Settings. As long as the Imported check box is selected, that user or group will be synchronized with the source during any future imports. You can convert an imported user or group into a BusinessObjects Planning user or group by clearing the Imported check box. If an imported user is converted, that user becomes completely managed within BusinessObjects

26

BusinessObjects Planning Guide to Integration with BusinessObjects XI

BusinessObjects Enterprise user integration BusinessObjects Enterprise user integration concepts

Planning and is unaffected by any future imports. This conversion cannot be reversed.

Properties imported from BusinessObjects Enterprise


The following user properties are imported from BusinessObjects Enterprise and mapped to BusinessObjects Planning properties: BusinessObjects Enterprise User BusinessObjects Planning User Property Property
User ID

CUID (Cluster Unique Identifier)


Account Name Full Name Email

User Name Last Name Email

In the case of groups, the BusinessObjects Enterprise CUID and Group Name are imported to the BusinessObjects Planning Group ID and Group Name. The imported properties cannot be edited in BusinessObjects Planning as long as the user or group remains flagged as an imported user. Imported properties are updated on each subsequent BusinessObjects Enterprise import.

Understanding BusinessObjects Planning systems


Any security-related activity in BusinessObjects Planning requires an understanding of BusinessObjects Planning systems.

BusinessObjects Planning Guide to Integration with BusinessObjects XI

27

BusinessObjects Enterprise user integration BusinessObjects Enterprise user integration concepts

A "system" is a unique BusinessObjects Planning User Directory and database, as defined in the Planning Configuration Manager. A BusinessObjects Planning implementation may consist of multiple systems. All implementations of BusinessObjects Planning must designate one system as the Primary Authentication System. The Primary Authentication System controls user access to all BusinessObjects Planning systems defined in your environment. Several security features, including the BusinessObjects Integration dialog, are only available in the Primary Authentication System. For more information on systems and the Primary Authentication System, see the BusinessObjects Planning Security Administrator's Guide.

Handling parent groups and subgroups


BusinessObjects Enterprise supports group hierarchies. A group can be designated as a subgroup of another group (the parent). Subgroups inherit the rights of the parent group. BusinessObjects Planning does not support group hierarchies. Each group in BusinessObjects Planning is a separate entity with no relationship to any other group. Users in BusinessObjects Planning can belong to multiple groups. When hierarchical groups are imported into BusinessObjects Planning, the hierarchical structure is flattened. Users are assigned to their subgroup and any parent groups as appropriate. For example, Group B is a subgroup of Group A, and both groups are selected for import. If a user is a member of Group B, that user will be assigned to both Group A and Group B in BusinessObjects Planning. You can choose to import a subgroup without importing its parent groups, but you cannot choose to import a parent group without importing all of its subgroups.

28

BusinessObjects Planning Guide to Integration with BusinessObjects XI

BusinessObjects Enterprise user integration The BusinessObjects Enterprise user import process

The BusinessObjects Enterprise user import process


This section outlines the user import process and provides direction on where to find more information about each step. 1. Plan the groups to be imported. In this step you should analyze your BusinessObjects Enterprise and BusinessObjects Planning deployments and determine the areas of user overlap. Which BusinessObjects Enterprise users require access to BusinessObjects Planning or to the BusinessObjects Planning universe data? Can you use existing BusinessObjects Enterprise groups or do you need to create new groups? How often should user imports be performed to keep the systems synchronized? 2. If necessary, create the groups to be imported within BusinessObjects Enterprise. For more details, see the BusinessObjects Enterprise Administrators Guide. 3. Configure and save the import settings. In this step, you define which groups to import into specific BusinessObjects Planning systems. See Configuring BusinessObjects Enterprise user import settings on page 30. 4. Perform the import. Imports can be performed manually on an ad hoc basis, or scheduled for automated execution using the Scheduler utility. Both options are discussed in Importing BusinessObjects Enterprise users on page 35. This section also describes the rules employed during an import. 5. Define the security settings for the imported users and groups. The user and group security settings for BusinessObjects Planning are typically defined by the BusinessObjects Planning Master System User. For more details on available settings, see the Planning Professional Edition Administrator's Guide or the Planning Professional Edition Online Help. A brief discussion of considerations specific to BusinessObjects Enterprise users is available in this guide see Security rights for users imported from BusinessObjects Enterprise on page 39.

BusinessObjects Planning Guide to Integration with BusinessObjects XI

29

BusinessObjects Enterprise user integration Configuring BusinessObjects Enterprise user import settings

Subsequent imports can be performed as often as necessary to synchronize the user lists.

Configuring BusinessObjects Enterprise user import settings


This section provides information on configuring the BusinessObjects Enterprise user import settings. You must configure the user import settings before you can perform an import. Once saved, these settings can be used for future imports and can be edited at any time.

To configure BusinessObjects Enterprise import settings


The BusinessObjects Integration dialog is only available in the Primary Authentication System and is only accessible by administrators. 1. Click Plan > Administration > BusinessObjects Integration. In Excel 2007: On the Plan tab, in the System Management group, click Administration > BusinessObjects Integration. 2. On the User Groups tab, select the BusinessObjects Enterprise groups to import. Use the arrow buttons to move selected groups from the Available Groups box to the Selected Groups box. For more specific details and considerations, see To select BusinessObjects Enterprise groups for import on page 31. 3. For each group in the "Assigned Group" box, select the target BusinessObjects Planning systems that you want to import the group into. If a check box is selected for a system, that group will be imported into that system. For more specific details and considerations, see To select target systems for BusinessObjects Enterprise user import on page 32. 4. On the Settings tab, select the systems to enable for import in the "Enable/Disable Import by System" box.

30

BusinessObjects Planning Guide to Integration with BusinessObjects XI

BusinessObjects Enterprise user integration Configuring BusinessObjects Enterprise user import settings

If a check box is selected for a system, that system is enabled for import. For more specific details and considerations, see To enable or disable systems for BusinessObjects Enterprise user import on page 33. 5. Click Save. If you are ready to perform the import now, click Import. See Importing BusinessObjects Enterprise users on page 35 for full details on performing imports.

To select BusinessObjects Enterprise groups for import


1. Click the User Groups tab of the BusinessObjects Integration dialog. 2. To add a group for import: a. In the Available Groups box, select the check box for each group that you want to import. You can use the Select All and Clear All buttons at the bottom of the dialog to select all groups or clear all check boxes. If a group has a plus icon next to the group name, you can expand the group to view its subgroups. Child groups can be selected independently of parent groups. Selecting a parent group automatically selects all child groups. b. Click the >> button to add the selected groups to the Assigned Groups box.
Tip: To see a list of the users in a group, right-click on the group in

the Assigned Groups box. 3. To remove a group: a. In the Assigned Groups box, click the grey box next to the group name to select the entire row. You can use the SHIFT or the CTRL key to select multiple rows. b. Click the << button to remove the group from the Assigned Groups box.

Considerations when selecting BusinessObjects Enterprise groups for import


User import is defined on a per-group basis you cannot select individual users to import.

BusinessObjects Planning Guide to Integration with BusinessObjects XI

31

BusinessObjects Enterprise user integration Configuring BusinessObjects Enterprise user import settings

You can select any group defined in BusinessObjects Enterprise that is available to the CMS access account used by BusinessObjects Planning. If the CMS access account does not have rights to view a particular group, then that group will not display in the BusinessObjects Integration dialog. Hierarchical groups (groups with subgroups) will be flattened upon import to BusinessObjects Planning. See Handling parent groups and subgroups on page 28. If you remove a group that has previously been imported, all imported users belonging to that group will become obsolete on the next import, unless they belong to another imported group.

To select target systems for BusinessObjects Enterprise user import


Once BusinessObjects Enterprise groups have been selected to import, you must indicate the target BusinessObjects Planning systems for each group. 1. Click the User Groups tab of the BusinessObjects Integration dialog. Each group selected for import is listed in the Assigned Groups box. To the right of the Group Name column, there is a column for all systems ("All"), and then a column for each individual system. By default, when a group is first selected for import, all systems are selected as import targets. 2. To add target systems for import: Select the check box for a specific system to import the group into that system. OR Select the All check box to select all systems.

3. To remove target systems for import: Clear the check box for a specific system. OR Clear the All check box to clear all systems.

32

BusinessObjects Planning Guide to Integration with BusinessObjects XI

BusinessObjects Enterprise user integration Configuring BusinessObjects Enterprise user import settings

Considerations when selecting target systems for user import


Importing into newly-added systems

By default, when a group is initially added to the Selected Groups list, all systems are selected as target systems. If a new system is added later, you must manually edit the selected groups to include that system.
Selecting the Primary Authentication System as a target system

If the users in a group do not need to access the Primary Authentication System, then you do not need to select that system as a target system. The users will still be added to the Primary Authentication System so that they can log into BusinessObjects Planning, but within the Primary Authentication System they will be assigned to the Planning No Access group. If you change your mind later and decide to indicate the Primary Authentication System as a target system, the group will be created in the Primary Authentication System and the already-existing users will be assigned to that group. Because the users are now assigned to a group, the Planning No Access assignment is removed.
Note: The automated removal of the Planning No Access assignment only

occurs because the original Planning No Access assignment was automatic. If you manually assign a user to the Planning No Access group, that assignment will remain until you remove it.
Removing a target system

If you remove a system from a groups list of target systems, and you have already imported users from that group into that system, those users will become obsolete in that system on the next import.

To enable or disable systems for BusinessObjects Enterprise user import


You can selectively enable or disable systems for import without affecting the target system assignments for the imported groups. The first time that the BusinessObjects Integration dialog is accessed, all systems are enabled for import by default. If a new system is subsequently added, you must manually enable that system.

BusinessObjects Planning Guide to Integration with BusinessObjects XI

33

BusinessObjects Enterprise user integration Configuring BusinessObjects Enterprise user import settings

1. Click the Settings tab of the BusinessObjects Integration dialog. The available BusinessObjects Planning systems display in the "Enable/Disable Import by System" box. 2. Select the check box for a system to enable that system for import, or clear a check box for a system to disable that system for import.

Impacts of disabling systems for user import


If you disable a system for user import, no users or groups will be imported into that system, even if that system is selected as a target system on the User Groups tab. (Note that name and email information for previously imported users will still be synchronized.) Disabling the Primary Authentication System disables all user import capabilities. The import process must be able to create users within the Primary Authentication System.

To export the BusinessObjects Enterprise import settings


You can export the BusinessObjects Enterprise user import settings as an XML file to assist in troubleshooting any import issues. 1. Click Plan > Administration > BusinessObjects Integration. In Excel 2007: On the Plan tab, in the System Management group, click Administration > BusinessObjects Integration. 2. Click the Settings tab. 3. Select one of the following export options: Click Export Configuration to export the configuration settings for the import. This includes the list of selected BusinessObjects Enterprise groups and target systems, and the system enablement settings. Click Export Groups / Users to export the list of BusinessObjects Enterprise groups and users that you have selected for import. 4. Navigate to the location where you want to save the export file, then click OK.

34

BusinessObjects Planning Guide to Integration with BusinessObjects XI

BusinessObjects Enterprise user integration Importing BusinessObjects Enterprise users

Importing BusinessObjects Enterprise users


Two methods are available to import BusinessObjects Enterprise groups and users. You can manually perform an import using the BusinessObjects Integration dialog, or you can schedule an import for automated execution using the Scheduler utility. For details on the rules applied to users and groups during a BusinessObjects Enterprise import, see BusinessObjects Enterprise user import rules on page 36. After an import executes successfully, be sure to check the Audit Log for any warnings.

To import BusinessObjects Enterprise users


1. Click Plan > Administration > BusinessObjects Integration. In Excel 2007: On the Plan tab, in the System Management group, click Administration > BusinessObjects Integration. 2. Review the import settings to confirm they are as desired. 3. Click Import. If any errors are experienced during the import, a message box notifies you that errors were logged to the Audit Log.
Related Topics

To configure BusinessObjects Enterprise import settings on page 30

To schedule a BusinessObjects Enterprise user import for automated execution


You can schedule a user import for automated execution using the Scheduler utility. You must have already configured and saved the import settings using the BusinessObjects Integration dialog before scheduling the import.

BusinessObjects Planning Guide to Integration with BusinessObjects XI

35

BusinessObjects Enterprise user integration Importing BusinessObjects Enterprise users

The following describes the basic steps for scheduling a user import. For full details on the Scheduler utility, see the Planning Professional Edition Online Help or the Planning Professional Edition Administrator's Guide. 1. Click Plan > Utilities > Scheduler. In Excel 2007: On the Plan tab, in the System Management group, click Utilities > Scheduler. 2. Click the New Job icon, then type a Job Name and Description for the new job. You can also add the user import task to an existing job. 3. Add the user import task to the job: a. In the Tasks for Job pane at the bottom of the dialog, click the New Task icon. The Setup Task dialog opens. b. On the Task Type list, click User Import. c. Type a Name for the task, then click OK. 4. Complete the remaining job settings (Job Recurrence and Notifications) by clicking through the Job Wizard.
Note: Remember that the scheduled time is evaluated in the context of

the Planning database server's time zone. The Job Wizard displays the database time (as "Scheduler time") and the local time for your reference.

BusinessObjects Enterprise user import rules


This section describes the rules applied by BusinessObjects Planning when performing a BusinessObjects Enterprise user import. This summary is provided to help you understand how BusinessObjects Planning handles the various user and group conditions that may be present during an import.
Group Rules

For each group to be imported, BusinessObjects Planning checks the group list of the target system to determine if the group already exists. The basis of comparison is the group ID. If no match is found for the group ID, the following occurs:

36

BusinessObjects Planning Guide to Integration with BusinessObjects XI

BusinessObjects Enterprise user integration Importing BusinessObjects Enterprise users

Before creating a new group, the software checks to make sure that no BusinessObjects Planning groups already exist with the same name. If a duplicate group name is found, then no action is taken to the existing group and no users are imported for the BusinessObjects Enterprise group. A warning message is logged in the Audit Log if this occurs. If no duplicate group name is found, then the new group is created, flagged as an imported group, and assigned filters that result in no access to data or plan workbooks. The group ID and group name are imported from BusinessObjects Enterprise. The associated users are imported into the new group.
Note: If the imported group name contains characters that are not

supported in the BusinessObjects Planning database, then that group is considered invalid and no users are imported for that group. A warning message is logged in the Audit Log if this occurs. If a match is found for the group ID, any new users are imported into the existing group. This occurs regardless of whether the group is still flagged as Imported in BusinessObjects Planning. If the group is still flagged as Imported and the group name has been changed in BusinessObjects Enterprise, then the group name is synchronized to match the new name in BusinessObjects Enterprise.

User Rules

For each user to be imported, BusinessObjects Planning checks the user list to determine if the user already exists. The basis for comparison is the user ID. If no match is found for the user ID, the following occurs: Before creating a new user, the software checks to make sure that no BusinessObjects Planning users already exist with the same name. If a duplicate user name is found, then no action is taken to the existing user. A warning message is logged in the Audit Log if this occurs. If no duplicate user name is found, then the new user is created, flagged as an imported user, and assigned to the appropriate imported groups. The user's Full Name and Email properties are imported.
Note: If the imported user name contains characters that are not

supported in the BusinessObjects Planning database, then that user

BusinessObjects Planning Guide to Integration with BusinessObjects XI

37

BusinessObjects Enterprise user integration Importing BusinessObjects Enterprise users

is considered invalid and is not imported. A warning message is logged in the Audit Log if this occurs. If a match is found for the user ID, the following occurs: If the user is flagged as an Imported user, then the user's Full Name and Email properties are updated. The user's imported group assignments are synchronized. Any group assignments that were made manually by an administrator are not changed. If the user is not flagged as an Imported user (the user was converted to a BusinessObjects Planning user), then no action is taken to the existing user.

If the Primary Authentication System was not indicated as a target system for the group the user is being imported from, then any new users added to a non-Primary Authentication System are also added to the Primary Authentication System. The new user is created, flagged as an imported user, and assigned to the Planning No Access group.
Obsolete Users

Within the pool of groups currently being imported, BusinessObjects Planning compares its list of imported users (users flagged as Imported) to the users in the current import. If a previously imported user does not exist in the current import, that user is flagged as obsolete. The most typical situations where a user would be flagged as obsolete are: The user was deleted from BusinessObjects Enterprise entirely. The user was removed from all BusinessObjects Enterprise groups that are designated for import. The user belongs to a group that was removed from the BusinessObjects Integration settings, and the user does not belong to any of the other groups designated for import.

Obsolete users cannot access the system. If the obsolete user is a Process Control stage owner or the owner of a Scheduler job, this issue is noted in the Audit Log so that an administrator can move the assignments to other users as appropriate. The names of obsolete users display in grey font in the Security Settings dialog.

38

BusinessObjects Planning Guide to Integration with BusinessObjects XI

BusinessObjects Enterprise user integration Security rights for users imported from BusinessObjects Enterprise

Obsolete users remain in the system until deleted by an administrator. For security reasons, BusinessObjects Planning does not provide the ability to manually remove the obsolete flag from a user. If a user was mistakenly removed from a BusinessObjects Enterprise group (which resulted in the user being flagged as obsolete), you can re-run the import to restore the user after correcting the issue in BusinessObjects Enterprise.

Security rights for users imported from BusinessObjects Enterprise


Generally, security rights for imported users are handled in the same way as for BusinessObjects Planning users. You must define the security rights for each user and group within Security Settings, for each BusinessObjects Planning system the user or group was imported into. Security rights are typically managed by a BusinessObjects Planning Master System User. For more details on available security rights, see the Planning Professional Edition Administrator's Guide or the Planning Professional Edition Online Help. This section details a few additional considerations when defining security rights for imported users.
Group assignments

Initially, imported users are assigned to the group or groups they were imported with. If the users group is a subgroup, the user is also assigned to the parent groups as appropriate (see Handling parent groups and subgroups on page 28). Subsequent imports synchronize the imported group assignments. For example, if a user is moved from Group A to Group B within BusinessObjects Enterprise, and both of those groups are imported into BusinessObjects Planning, then the user will be removed from Group A and added to Group B. Within BusinessObjects Planning, you can manually assign imported users to additional groups (either BusinessObjects Planning groups, or other imported groups). These manual assignments are not affected by subsequent imports.

BusinessObjects Planning Guide to Integration with BusinessObjects XI

39

BusinessObjects Enterprise user integration BusinessObjects Enterprise authentication

Filters

When a BusinessObjects Enterprise group is imported for the first time, it is assigned a set of security filters (data filters and a plan filter) that result in no access to data or plan workbooks. This is a security measure designed to prevent newly imported users from having full access to the system until you are able to set the specific security rights for the group and the imported users. If a new user is imported into an existing group, that user inherits that group's established security rights, so no additional restrictions are applied to the new user. If you have enabled automated security for Planning universes, then it is extremely important to define appropriate data filters for imported users and groups, as these data filters will be applied as row access restrictions when universes are generated from the BusinessObjects Planning database. If imported groups are left with the default "no access" filter, then the users will not have access to the associated data within BusinessObjects Planning or the Planning universe. Data filters are defined on the Filters tab within Security Settings. For more details on data filters and how they are applied to universes, see Applying data filters as access restrictions on page 120.

BusinessObjects Enterprise authentication


When BusinessObjects integration is enabled, the Professional Edition login dialog is modified to include an Authentication field. Imported users must select a BusinessObjects Enterprise authentication option that is supported in their environment.

40

BusinessObjects Planning Guide to Integration with BusinessObjects XI

BusinessObjects Enterprise user integration BusinessObjects Enterprise authentication

Figure 3-1: Example login dialog with BusinessObjects Enterprise authentication

Note:

Single sign-on is not supported. Users must enter their credentials to access BusinessObjects Planning, even if single sign-on is enabled for BusinessObjects Enterprise. An exception is when using the token URL parameter to launch a Planning web access option. If a BusinessObjects Enterprise user has one or more aliases in BusinessObjects Enterprise, that user can log into BusinessObjects Planning using an alias and the corresponding authentication type. For web login, the default login pages should be used (logined.aspx or loginsa.aspx), not the security integration login pages.

The following authentication options are available:


Authentication Option Enterprise Description BusinessObjects Enterprise authenticates the user based on their BusinessObjects Enterprise account name and password. BusinessObjects Enterprise authenticates the user based on their LDAP user name and password.

LDAP

BusinessObjects Planning Guide to Integration with BusinessObjects XI

41

BusinessObjects Enterprise user integration BusinessObjects Enterprise authentication

Authentication Option Windows AD

Description BusinessObjects Enterprise authenticates the user based on their Windows Active Directory user name and password. BusinessObjects Enterprise authenticates the user based on their Windows NT user name and password. Non-imported users can use the Planning option to be authenticated based on their BusinessObjects Planning user name and password.

Windows NT

Planning

For more details on BusinessObjects Enterprise authentication options, see the BusinessObjects Enterprise Administrators Guide. Special URL parameters are available to allow BusinessObjects Enterprise users to directly launch into Planning web access options. See URL Syntax for Launching Planning Web Access Options on page 125.

42

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Process Overview for Planning Universe Creation

Process Overview for Planning Universe Creation Planning the universe

Planning universe creation is a multi-step process. This table provides a brief overview of the universe creation steps.
Process Step Planning the universe Description For more information

In this step you plan the structure of the See Planning the uniuniverse. verse on page 45

Defining time structures

In this step, you define optional time structures in BusinessObjects Planning to enable time-based drilling of the universe data. Defining time structures is a 3-part process involving: Defining time dimensions Populating time dimensions Defining time pivots This step is optional.

See Defining time structures for Planning universes on page 55

Defining the universe

In this step, you create the universe universes on page 93 definition in BusinessObjects Planning by choosing from pre-defined classes and objects. Once the definition is saved, the universe is generated and published to the CMS. Once a universe has been generated, you can make further edits to the universe within Designer.

See Defining Planning

Administering the universe

Once a universe has been created, on- See Administering Plangoing administration of the universe in- ning universes on cludes updating the universe, updating page 111 time pivots, and managing user access.

44

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Process Overview for Planning Universe Creation Planning the universe

Planning the universe


In this phase you should analyze the reporting needs of the intended audience of the universe and plan the universe design to meet those needs. Because most or all of the universe structure and properties will be created by BusinessObjects Planning, the primary focus of the planning phase is deciding on the necessary data and understanding how it will be accessible in the universe. For example, you should consider the following questions: What BusinessObjects Planning data needs to be made available to universe consumers? Once you have decided on the data requirements, you need to understand how the BusinessObjects Planning data structures map to universe structures. Understanding the Planning universe structure will help you decide which classes and objects to include in the universe to provide your users with the data they need. See The Planning universe structure on page 77 for more details. Do users need to be able to drill the data based on time? BusinessObjects Planning natively stores time-varying data over columns instead of rows. If you require time-varying data to be stored over rows to enable time-based drilling, you must define certain time structures in BusinessObjects Planning to support this. See Handling time in Planning universes on page 47 for more details.

BusinessObjects Planning Guide to Integration with BusinessObjects XI

45

Process Overview for Planning Universe Creation Planning the universe

46

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Handling time in Planning universes

Handling time in Planning universes Comparing column-based time and row-based time

One of the primary decisions to make when developing Planning universes has to do with how time-varying data is handled. You can choose to use the default "wide" layout of the BusinessObjects Planning database, where time varies over columns, or you can create special time constructs to enable time to vary over rows. This section explains these two different approaches, to assist you in deciding how to handle time-varying data in your universes. For specifics on creating these time constructs in BusinessObjects Planning, see Defining time structures for Planning universes on page 55.

Comparing column-based time and row-based time


This section explains the differences between the native column-based time of BusinessObjects Planning and row-based time.

Column-based time
In BusinessObjects Planning, time-varying data is not tracked as a dimension. Time is instead defined using the concept of time series.
What is a time series?

A time series is a set of data columns representing a span of time. The primary defining factor of a time series is the number of periods. Each period represents a unit of time, such as a month or a week. A typical time series has 12 periods representing a one-year span of months. However, the number of periods and the implied time span may vary. For example, a time series could contain 26 periods representing a one-year span of biweekly units, or 36 periods representing a three-year span of months. Each time series is given a name which ideally conveys both the time span and the type of data contained in the time series for example, "CYA" for Current Year Actuals or "CYB" for Current Year Budget. Time series names are typically generic ("current year") instead of specific ("ACT2006") so that the same set of time series can be re-used for each planning cycle.

48

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Handling time in Planning universes Comparing column-based time and row-based time

Database structure with column-based time

The BusinessObjects Planning database contains a column for each period of each time series. The naming convention for these columns is the time series name suffixed by the period number (for example, CYA1, CYA2, etc.). This structure is described as a "wide" table layout because the time-varying data varies over columns instead of rows. For example, the fact table for a data source in BusinessObjects Planning appears like the following table:
Table 5-1: Example wide table layout in BusinessObjects Planning

DEPT 100 100

ACCT

CYA1

CYA2 150 500

CYA11 110 500

CYA12 125 500

CYB1 110 500

CYB2 160 500

CYB11 125 500

CYB12 145 500

400100 100 400200 500

This example shows a system with two dimensions (DEPT and ACCT) and two 12-period time series (CYA and CYB). (Periods 3 through 10 of each time series are omitted for space considerations.) Since it is not uncommon for a data source to have four or more time series, as well as several sets of summary fields and other columns, the column layout can be quite wide.

Row-based time
Most business intelligence applications track time as a dimension. For example, if the data in the database spans a one-year period, you might have a time dimension named Month with values from 1 to 12. In this case, the time dimension becomes one of the key columns of the table. Instead of a wide table with many columns, the table is narrow with many rows. For example, the fact table of a database using a time dimension appears like the following table:
Table 5-2: Example "narrow" table layout

DEPT

ACCT

MONTH

ACTUALS

BUDGET

BusinessObjects Planning Guide to Integration with BusinessObjects XI

49

Handling time in Planning universes Comparing column-based time and row-based time

100 100 100 100 100 100 100 100

400100 400100 400100 400100 400200 400200 400200 400200

1 2 11 12 1 2 11 12

100 150 110 125 500 500 500 500

110 160 125 145 500 500 500 500

In this example there are three dimensions, DEPT, ACCT and Month. The data is contained in two measure columns named Actuals and Budget. (Again, months 3 through 10 are omitted for space considerations.) The data is exactly the same as in the BusinessObjects Planning "wide" table example, it is the database structure that differs.
Related Topics

Column-based time on page 48

Reasons to adopt row-based time in Planning universes


There are several reasons to adopt time dimensionality for Planning universes: Familiarity. Most business intelligence tools use time dimensions. Your user community may already be used to performing analysis and building reports using a time dimension. Time-based report drilling. Use of time dimensions enables the ability to drill along time. You can define time hierarchies such as months, quarters and years and drill along those hierarchies. True date fields. BusinessObjects Planning does not natively support date fields, but date fields can be included in time dimensions. Some

50

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Handling time in Planning universes How row-based time is created in BusinessObjects Planning

functionality in other Business Objects reporting and analytic tools depend on the presence of a date field. The process of defining time dimensions and the associated supporting constructs does add a significant component to Planning universe development. If user familiarity is not an issue or if time-based report drilling is not required, it may not be worth the effort to adopt time dimensionality.

How row-based time is created in BusinessObjects Planning


Because BusinessObjects Planning does not naturally support time dimensionality, two new data structure types have been introduced to allow for row-based time in Planning universes: Time Dimensions. A time dimension defines a span of time periods to track time-varying data. Similar to standard dimensions, you can also define grouping columns for a time dimension, which can then be used as the basis for time hierarchies within the universe. Time Pivots. A time pivot defines an alternate view of a data source. Instead of storing data in time series columns, a time pivot uses a time dimension to track time-varying data over rows.

Each time pivot corresponds to a single time dimension. Time pivots consist of one or more measures that define a category of time-varying data, such as budget data or actuals data. To define the data within the measure, you map one or more time series to specific time dimension periods. Essentially, the time pivot converts the "wide" table structure of BusinessObjects Planning to a "narrow" table structure.

Example case of converting column-based time to row-based time


This example case is provided to illustrate how time dimensions and time pivots are used to create row-based time for Planning universes. The example uses typical data structures for a budgeting application.

BusinessObjects Planning Guide to Integration with BusinessObjects XI

51

Handling time in Planning universes How row-based time is created in BusinessObjects Planning

Typical column-based time in BusinessObjects Planning


A typical time span for data in a budgeting application is three years the prior year, the current year, and next year. To support this time span, the following time series exist within the Financial data source:
Year Prior year Current year Budget Time Series n/a CYB (Current Years Budget) NYB (Next Years Budget) Actuals Time Series LYA (Last Years Actuals) CYA (Current Years Actuals) n/a

Next year

Each of these time series has 12 periods representing 12 months of data.

Creating row-based time for the universe


To support time dimensionality in the Planning universe, the following constructs are created in Data Structures.
Time dimension

One time dimension is created named "Month". The Month dimension has codes from 1 to 36, representing the three-year time span of the system. To support month descriptions and time drilling, three grouping columns are defined for the time dimension: Description, Quarter, and Year. For example:
Month 1 2 3 Description January February March Quarter Q1 Q1 Q1 Year 2005 2005 2005

52

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Handling time in Planning universes How row-based time is created in BusinessObjects Planning

4 35 36

April November December

Q2 Q4 Q4

2005 2007 2007

Months 5 through 34 are omitted from the table for space considerations.
Time pivot

One time pivot named "FinancialMonthly" is created for the Financial data source. This time pivot is explicitly associated with the Month time dimension, thereby giving the time pivot 36 periods. Within the time pivot, two measures are created: "Actuals" and "Budget". The Actuals measure contains the time series LYA and CYA. LYA is mapped to periods 1-12, and CYA to periods 13-24. Periods 25-36 are left unmapped, and will return zero values (actuals data is not available for next year). The Budget measure contains the time series CYB and NYB. CYB is mapped to periods 13-24, and NYB to 25-36. Periods 1-12 are left unmapped, and will return zero values (generally, there is no need to report upon budget data earlier than the current year).

BusinessObjects Planning Guide to Integration with BusinessObjects XI

53

Handling time in Planning universes How row-based time is created in BusinessObjects Planning

54

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Defining time structures for Planning universes

Defining time structures for Planning universes Defining time dimensions

If you have determined that the universe needs to store time-varying data over rows, you must define the supporting time structures in BusinessObjects Planning. This process has three phases: 1. Defining time dimensions In this phase, you define the name of the time dimension and the grouping structures. Time dimensions are defined on a system-wide basis. 2. Defining time dimension values In this phase, you populate the time dimension table with the set of valid codes (periods) and grouping values. 3. Defining time pivots In this phase, you define the data for the alternate view by mapping time series periods to time dimension periods. Time pivots are defined on a per data source basis. For more details on the concept of time dimensions and time pivots, and why you might use them in a Planning universe, see Handling time in Planning universes on page 47. Currently, time dimensions and time pivots are only for use in universes. BusinessObjects Planning itself does not provide any means of reporting using these time structures. The Time Dimension and Time Pivot nodes only appear in the Data Structures dialog if BusinessObjects integration has been enabled in the Configuration Manager.

Defining time dimensions


Note: Time dimensions are only available if BusinessObjects Integration is

enabled. Time dimensions define a span of time periods to track time-varying data. Use of time dimensions and time pivots enables the ability to drill data based on time in Planning universes, and also provides support for date fields. Time dimensions are defined within the Data Structures dialog. Additionally, each time dimension must have a set of time dimension codes and grouping values defined within the database. See Defining time dimension values on page 61.

56

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Defining time structures for Planning universes Defining time dimensions

Note: Once defined, the settings for time dimensions and their associated

grouping columns cannot be edited. You must delete and recreate the time dimension or grouping column if you need to change its settings. To access the Time Dimensions pane: 1. Click Plan > Database > Data Structures. In Excel 2007: On the Plan tab, in the System Management group, click Database > Data Structures. 2. In the left-hand pane, click Time Dimensions. The time dimensions for the system display in the top of the right-hand pane. When you click on a time dimension, the grouping columns for that time dimension display in the bottom of the pane. The following screenshot shows an example Time Dimensions pane:

BusinessObjects Planning Guide to Integration with BusinessObjects XI

57

Defining time structures for Planning universes Defining time dimensions

Related Topics

Handling time in Planning universes on page 47

Time dimension structure


When a new time dimension is saved, BusinessObjects Planning creates a time dimension table in the database with a column for the time dimension codes. The data type for this key column is always integer (whole numbers). The name of the table and of the key column is the name defined for the time dimension. Business Objects recommends using a name that is representative of the time periods in the time dimension, such as "Month" or "Week". In addition to the key column, the time dimension can have any number of grouping columns to be used for data grouping and report drilling. The data type for each grouping column can be integer, number, string, or date.
Note: Certain functionality in Business Objects reporting and analytic tools

depends on the presence of a date column. To use this functionality with a Planning universe, a date column is recommended for the time dimension.

To add a time dimension


1. In the Time Dimensions pane of the Data Structures dialog, click the New button next to the time dimensions grid. The New Time Dimension dialog replaces the time dimensions grid. 2. In the Name box, type a name for the time dimension, and then click Save. The name is used to define the name of the time dimension table and its key column. Business Objects recommends using a name that is representative of the time periods in the time dimension, such as "Month" or "Week". For details on valid naming conventions and limitations, see Data Structures naming conventions on page 76.

58

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Defining time structures for Planning universes Defining time dimensions

3. In almost all cases you will want to define additional grouping columns for the time dimension to enable time-based grouping and drilling. See Defining grouping columns for a time dimension on page 59. 4. Click Update to add the new time dimension to the database. You must populate the time dimension table with values before the time dimension can be used. See Defining time dimension values on page 61.

To delete a time dimension


You cannot delete a time dimension if it is used in a time pivot. 1. In the Time Dimensions pane of the Data Structures dialog, click the time dimension that you want to delete. 2. Click the Delete button next to the time dimension grid. 3. Click Update to remove the time dimension from the database.

Defining grouping columns for a time dimension


Time dimension grouping columns can be used to group time-based data by units such as months, quarters and years. Time dimension grouping columns support date fields, which can be used to associate the time dimension periods with true dates. After a Planning universe has been generated, you can use Designer to create time hierarchies based on these grouping columns, to enable time-based drilling. You can define as many grouping columns as necessary for each time dimension. For information on populating the values in these grouping columns, see Defining time dimension values on page 61.

To add a grouping column to a time dimension


1. In the Time Dimensions pane of the Data Structures dialog, click the desired time dimension. The defined grouping columns for the time dimension display in the bottom half of the pane.

BusinessObjects Planning Guide to Integration with BusinessObjects XI

59

Defining time structures for Planning universes Defining time dimensions

2. Click the New button next to the column grid. The New Column dialog replaces the column grid. 3. Complete the following fields and then click Save.
Field Name Description

Type a name for the grouping column. For details on valid naming conventions and limitations, see Data Structures naming conventions on page 76.

Type

Select a data type for the column. The available types are:
String text or alpha-numeric data Number whole numbers and decimal numbers Integer whole numbers only Date dates

Size

This field only applies if the Type is set to String. Type a number to define the size of the grouping column in characters.

4. Click Update to save the new grouping column to the database.

To delete a grouping column from a time dimension


1. In the Time Dimensions pane of the Data Structures dialog, click the desired time dimension. The defined grouping columns for the time dimension display in the bottom half of the pane. 2. Click the grouping column that you want to delete, then click the Delete button next to the column grid. 3. Click Update to remove the grouping column from the database.

60

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Defining time structures for Planning universes Defining time dimension values

Defining time dimension values


Each time dimension has a table in the database to define the set of valid time dimension codes and grouping code values. The set of values for a time dimension appears similar to the set of values for standard BusinessObjects Planning dimensions. You must have a column of valid dimension codes, followed by any number of optional grouping columns. For example, the table for a Month time dimension might appear similar to the following table. The "Month" column contains the valid dimension codes, followed by three grouping columns.
Month 1 2 3 4 35 36 Description January February March April November December Quarter Q1 Q1 Q1 Q2 Q4 Q4 Year 2005 2005 2005 2005 2007 2007

Note: Months 5 through 34 are omitted from the table for space

considerations. You can edit time dimension values from within the Time Dimensions pane of the "Data Structures" dialog. Clicking the Edit Data button opens a grid where you can input values for the selected time dimension. An import utility can also be used to populate the time dimension table if desired. Contact your BusinessObjects Planning representative for assistance with import utilities. Because time dimensions are only for use in universes, BusinessObjects Planning does not contain functionality to create hierarchies for time dimensions. Once a universe has been created, you can create time dimension hierarchies easily within the universe Designer component.

BusinessObjects Planning Guide to Integration with BusinessObjects XI

61

Defining time structures for Planning universes Defining time pivots

To define values for a time dimension


The following procedure can be used to define the initial set of time dimension values, and to make periodic updates to those values. 1. Click Plan > Database > Data Structures. In Excel 2007: On the Plan tab, in the System Management group, click Database > Data Structures. 2. In the left-hand pane of the "Data Structures" dialog, click Time Dimensions. 3. In the right-hand pane, click the name of the time dimension for which you want to define values, then click Edit Data.
Note: If the Edit Data button is not active, then you must first Update

the Data Structures before you can define the values for the time dimension. The "Editing Data for Time Dimension [Name]" dialog opens. It contains a grid with one column for the time dimension codes, and one column for each defined grouping column. 4. Type the time dimension codes and grouping column values into the grid. The grid will expand to accommodate as many rows as needed. When you type in an empty row, a new empty row is automatically created underneath it.
Note: You cannot add new columns within this interface. Grouping

columns must be added from the Time Dimensions pane. 5. Click Update. The time dimension values are saved to the database immediately. You do not have to subsequently select Update in the "Data Structures" dialog in order to save the values.

Defining time pivots


Note: Time pivots are only available if BusinessObjects Integration is

enabled.

62

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Defining time structures for Planning universes Defining time pivots

A time pivot defines an alternate view of a data source, for use in Planning universes. In a time pivot, time-varying data is presented over rows instead of across columns. Each time pivot corresponds to a single time dimension. Time pivots consist of one or more measures that define a category of time-based data, such as budget data or actuals data. To define the data within the measure, you map one or more time series to specific time dimension periods. Time pivots are defined per data source within the Data Structures dialog. To access the Time Pivots pane: 1. Click Plan > Database > Data Structures. In Excel 2007: On the Plan tab, in the System Management group, click Database > Data Structures. 2. In the left-hand pane, expand the desired data source. 3. Click Time Pivots. The time pivots for the data source display in the top of the right-hand pane. When you click on a time pivot, the data columns for the selected time pivot display in the bottom half of the pane, organized by two tabs: Measures and Other Columns. The following screenshot shows an example Time Pivots pane:

BusinessObjects Planning Guide to Integration with BusinessObjects XI

63

Defining time structures for Planning universes Defining time pivots

Related Topics

Handling time in Planning universes on page 47

About time pivot structure


The purpose of a time pivot is to convert (or "pivot") the wide table structure of a BusinessObjects Planning data source to a narrow table structure, using a time dimension. For more details on the concept of time pivots, see Handling time in Planning universes on page 47.
Key columns

The key columns of a time pivot consist of all the dimensions of the data source, plus the designated time dimension for the time pivot. The remaining columns in the time pivot are the defined measures and any included other columns.

64

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Defining time structures for Planning universes Defining time pivots

For example, if you have a data source with two dimensions (DEPT and ACCT), the resulting time pivot would appear similar to the following table. In this example, Month is the designated time dimension, and Actuals and Budgets are defined measures for the time pivot.
DEPT 100 100 100 100 100 100 100 100 ACCT 400100 400100 400100 400100 400200 400200 400200 400200 MONTH 1 2 35 36 1 2 35 36 ACTUALS 100 150 0 0 500 500 0 0 BUDGET 0 0 125 145 0 0 500 500

Months 3 through 34 are omitted from the table for space considerations.
Data columns

The data columns of a time pivot are the defined measures for the time pivot plus any included other columns. Each measure consists of one or more time series that are mapped to specific periods in the time dimension. For example, you might have a measure named Actuals where the time series LYA (Last Years Actuals) is mapped to periods 1-12 and the time series CYA (Current Year Actuals) is mapped to periods 13-24. Other columns can be included in a time pivot. Because other column data is not periodic, the data will be duplicated on each row of the time dimension. This structure is only appropriate when the other column contains descriptive data (as opposed to financial data). Therefore, the data in an other column is always "Grouped By" rather than "Aggregated".

BusinessObjects Planning Guide to Integration with BusinessObjects XI

65

Defining time structures for Planning universes Defining time pivots

Summary fields cannot be included in a time pivot, because summary fields are calculated data columns that do not map to specific time periods.

Time pivot storage types


Time pivots create an alternate way of structuring data in the database. In standard data source tables, time-based data varies over columns; whereas in time pivots, time-based data varies over rows. The addition of a time pivot to a BusinessObjects Planning database means that the time-varying data must be accessible in two ways using the original data source table for BusinessObjects Planning and using the time pivot for Planning universes. This additional storage requirement can impact database performance. BusinessObjects Planning provides two options to store the data in a time pivot: View and Table. The storage option for a time pivot is defined in the Time Pivots pane of Data Structures. The storage option is defined upon the creation of the time pivot and can be edited at any time. There are two primary criteria to consider when choosing a time pivot storage option. You should evaluate the needs of your user environment to determine which of the storage types is best for you. Universe data is always current With a view, the data in the time pivot is always in sync with the data in the original data source table, so universe consumers always have access to the most current data. With a table, the data in the time pivot is generated at a specific point in time and then remains static until a refresh is requested in BusinessObjects Planning. The data presented to a universe consumer might not match with the data currently in BusinessObjects Planning. Fast access to universe data With a table, the time pivot data is pre-generated so response time for universe consumers is quick. With a view, the time pivot data is generated on-the-fly for each query, so there may be a delay in response time.
Note: With both view and table, there is no change to the data save process

in BusinessObjects Planning, and therefore no performance impact.

66

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Defining time structures for Planning universes Defining time pivots

The following table summarizes the time pivot storage options:


Storage Op- Description tion View Advantages Disadvantages

A view is a virtual table com- Universe data is Universe consumers may exprised as a result of a query. always current. perience delays when queryTime pivot data is generated ing data. on-the-fly based on the original data source. A static snapshot of the time Fast access to pivot data is stored in a table. universe data. Universe data is not always current. You must refresh the table as necessary to provide access to updated data.

Table

Related Topics

Handling time in Planning universes on page 47

To add a time pivot


Creating a time pivot is a two-part process. In the first phase, you define the name and basic settings for the time pivot. This process is discussed in this topic. In the second phase, you define the columns of data to be included in the time pivot. 1. In the Time Pivots pane of the Data Structures dialog, click the New button next to the time pivot grid. The New Time Pivot dialog replaces the time pivot grid. 2. Complete the following settings and then click Save.
Field Name Description

Type a name for the time pivot. For example: FinancialMonthly.

BusinessObjects Planning Guide to Integration with BusinessObjects XI

67

Defining time structures for Planning universes Defining time pivots

Field

Description

Time Dimension Select a time dimension to define the periods of the time pivot. You can use any of the time dimensions defined in your system. Storage Type

Select one of the following storage types for the time pivot.
View Time pivot data is held in a virtual table that is generated on-the-fly for each query. Table A static snapshot of the time pivot data is stored in a table. You must refresh the time pivot periodically to update the data.

Pivot Targeting Dimensions

This option is only available if the data source where you are defining a time pivot contains a targeting dimension. This setting cannot be edited once it is saved. Select this check box if you want the measures in the time pivot to be populated based on a specified value in the targeting dimension. If this option is enabled, when you define a measure for the time pivot you will be required to designate a specific targeting dimension value for the measure. For more details on targeting dimensions, see the Planning Professional Edition Online Help.

Once the time pivot has been saved, you can define data columns for it.
Related Topics

Refreshing time pivots on page 116 Time pivot storage types on page 66 Data Structures naming conventions on page 76 Defining data columns for a time pivot on page 71

68

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Defining time structures for Planning universes Defining time pivots

Considerations for pivoting targeting dimensions


The use of the Pivot Targeting Dimensions feature for time pivots impacts the ability to apply user data filters as row access restrictions in the universe. If you want to pivot based on a targeting dimension, you cannot use data filters that reference the targeting dimension. If Pivot Targeting Dimensions is enabled for a time pivot, the targeting dimension is no longer a key column of the time pivot. Instead, you select an element of the targeting dimension to define the data in the time pivot measures. For example, if the targeting dimension is dType, the selected element could be "AVG". Because the targeting dimension is not a column in the time pivot, any data filters that reference the targeting dimension are no longer valid (and therefore the resulting row access restrictions in the universe will be invalid as well). If a user with an invalid access restriction attempts to query the time pivot, an error will result.

To edit the settings of a time pivot


1. In the Time Pivots pane of the Data Structures dialog, click the time pivot that you want to edit. 2. Click the Edit button next to the time pivot grid. The Edit Time Pivot dialog replaces the time pivot grid. 3. Edit any of the available settings, then click Save. For more details on the settings, see To add a time pivot on page 67. 4. Click Update to update the database.

Impacts of editing time pivot settings


All settings for a time pivot can be edited, except Pivot Targeting Dimensions. The only way to change whether Pivot Targeting Dimensions is enabled or not is to delete and recreate the time pivot.

BusinessObjects Planning Guide to Integration with BusinessObjects XI

69

Defining time structures for Planning universes Defining time pivots

You can also edit the data columns associated with a time pivot see Defining data columns for a time pivot on page 71. Editing certain time pivot settings may impact other areas of the system.
Setting Storage Type Effect

Changing the storage type for a time pivot may impact your system performance. Also, if you change the storage type to Table, make sure to consider the need to refresh that table on an ongoing basis. Changing the time dimension associated with a time pivot may have the following effects:
If the time pivot already contains measures, the time series assignments for those measures may not apply to the new time dimension. You may need to delete and recreate these time series assignments as appropriate for the new time dimension. If the time pivot is used in a universe, you may need to manually edit the universe in Designer to remove the obsolete time dimension table. This only applies if the time dimension is not used elsewhere in the universe.

Time Dimension

Related Topics

Time pivot storage types on page 66 Removing obsolete elements on page 107

To delete a time pivot


If you delete a time pivot, the associated time pivot class will be removed from universe definitions but not from universe files. You may need to manually update universe files to remove the obsolete class and table. 1. In the Time Pivots pane of the Data Structures dialog, click the time pivot that you want to delete. 2. Click the Delete button next to the time pivot grid. 3. Click Update to remove the time pivot from the database.

70

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Defining time structures for Planning universes Defining time pivots

Defining data columns for a time pivot


Each time pivot can have a number of data columns. There are two types of data columns in a time pivot: Measures. A measure defines a column of data in the time pivot by mapping time series periods to time dimension periods. Other columns. Other columns that contain descriptive data can be included in a time pivot.

Related Topics

About time pivot structure on page 64

To add a measure
Each measure defines a column of data in the time pivot. You can define as many measures as necessary. Creating a measure involves adding the measure to the time pivot and then defining the time series included in the measure. 1. In the Time Pivots pane of the Data Structures dialog, click the desired time pivot. The defined measures for the time pivot display in the Measure tab in the bottom half of the dialog. 2. On the Measure tab, click the New button underneath the measure grid. The New Measure dialog replaces the measure grid. 3. Complete the following fields, then click Save.
Field Name Description

Type a name for the measure. For example: Actuals.

BusinessObjects Planning Guide to Integration with BusinessObjects XI

71

Defining time structures for Planning universes Defining time pivots

Field Value

Description

This field only applies if Pivot Targeting Dimensions is enabled for the time pivot. Select a targeting value. The measure will only contain data where the targeting dimension matches the targeting value. For example, if the targeting dimension is dType, you could select AVG as the targeting value. The measure will only contain data where dType equals AVG.

4. Define the time series in the measure. 5. Click Update to add the new measure to the database.
Related Topics

About time pivot structure on page 64 Data Structures naming conventions on page 76 Defining the time series in a measure on page 73

To edit a measure
All aspects of a measure can be edited. Although you cannot change the start period for a time series in a measure, you can add and delete time series as needed. 1. In the Time Pivots pane of the Data Structures dialog, click the desired time pivot. The defined measures for the time pivot display in the Measure tab in the bottom half of the dialog. 2. On the Measure tab, click the measure that you want to edit. 3. To edit the name or targeting value for the measure: a. Click the Edit button underneath the measure grid. The Edit Measure dialog replaces the measure grid. b. Edit the measure settings as desired and then click Save.

72

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Defining time structures for Planning universes Defining time pivots

4. To edit the time series in the measure: a. Click the New button under the time series grid to add a new time series to the measure. b. Click the Delete button under the time series grid to delete a time series from a measure. 5. Click Update to save the edits to the database.
Related Topics

Defining the time series in a measure on page 73

To delete a measure
1. In the Time Pivots pane of the Data Structures dialog, click the desired time pivot. The defined measures for the time pivot display in the Measure tab in the bottom half of the dialog. 2. On the Measure tab, click the measure that you want to delete. 3. Click the Delete button underneath the measure grid. 4. Click Update to remove the measure from the database.

Defining the time series in a measure


To define the data in a measure, you map selected time series to specific periods of the time dimension. When you select a measure in the measure grid, the time series for that measure display in the right-hand side of the pane (as "Time Series in Mea sureName "). Using this area, you can add or delete the time series in a measure.
Note: Once created, the time series in a measure cannot be edited. If you

need to edit the starting period for a time series, you must delete it and then re-add it.

To include a time series in a measure 1. On the Measure tab of the Time Pivots pane, click the desired measure.

BusinessObjects Planning Guide to Integration with BusinessObjects XI

73

Defining time structures for Planning universes Defining time pivots

The time series included in that measure display to the right of the measure grid. 2. Click the New button under the time series grid. The New Time Series dialog replaces the time series grid. 3. Complete the following fields, and then click Save.
Field Time Series Start Period Description Select a time series to include in the measure.

Type the number of the time dimension period where you want the data for the time series to start. The time series will start at that period and continue for the number of periods contained in the time series. For example, if the time series CYA is a 12-period time series, and you want CYA to populate periods 13-24 of the time pivot, type 13 as the start period.

4. Click Update to save the time series to the time pivot.

To remove a time series from a measure 1. On the Measure tab of the Time Pivots pane, click the desired measure.
The time series included in that measure display to the right of the measure grid. 2. Click the time series that you want to delete, then click the Delete button under the time series grid. 3. Click Update to remove the time series from the measure.

To include an other column in a time pivot


Other columns can be included as data columns in a time pivot. Generally, it is only appropriate to include other columns that contain descriptive data not financial data.

74

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Defining time structures for Planning universes Defining time pivots

1. In the Time Pivots pane of the Data Structures dialog, click the desired time pivot. 2. Click the Other Columns tab in the bottom half of the Time Pivots pane. The Other Columns tab displays a list of available other columns and selected other columns. Each other column listed in the Selected Other Columns box will be included in the time pivot as a data column. 3. Add or remove other columns as desired: To add other columns to a time pivot, select the desired other columns in the Available Other Columns box, then click the > button. To remove other columns from a time pivot, select the desired other columns in the Selected Other Columns box, then click the < button. The SHIFT and CTRL keys can be used to select multiple other columns. To add or remove all other columns, use the >> or << buttons.
Note: If a naming conflict exists between an other column and a column

in the time pivot, the other column will not appear in the list of available other columns. For example, if an other column has the same name as a measure, that other column will not be available.
Related Topics

About time pivot structure on page 64

Impacts of time pivots on Data Structures update


Once you have defined a time pivot, any update to Data Structures triggers a refresh of the time pivot table or view. The refresh process can be time-consuming, depending on factors such as the number of time pivots, the storage types of the time pivots, and the amount of data in the time pivots. So that you do not have to wait for this refresh to complete before exiting Data Structures, BusinessObjects Planning creates a system-generated Scheduler task to process the time pivot refresh on the application server. The task will be processed immediately, pending other tasks already in the queue. If instead you want to process the time pivot refresh as part of the Data Structures update, you can choose to do so. The option is presented in the

BusinessObjects Planning Guide to Integration with BusinessObjects XI

75

Defining time structures for Planning universes Data Structures naming conventions

update confirmation dialog that appears after you click Update in Data Structures.

Data Structures naming conventions


The following naming conventions apply to database column codes as defined in Data Structures: Codes must start with an alphabetic character (not a number) or an underscore. Note that Oracle databases do not support the use of the underscore as the first character. The remainder of the code can contain any combination of the following: alphabetic characters, numbers, underscores, dollar sign characters ($) and pound characters (#). Spaces are not allowed. Do not use any SQL or Oracle reserved words in your codes. If you need assistance determining these reserved words, please contact Support. Do not use any codes that could be confused with Excel cell references, such as A1.

76

BusinessObjects Planning Guide to Integration with BusinessObjects XI

The Planning universe structure

The Planning universe structure Structure terminology

This section discusses the different structures employed by universes and by BusinessObjects Planning, and details how the BusinessObjects Planning data structures are mapped to universe structures.

Structure terminology
The terminology used to describe data structures differs between universes and BusinessObjects Planning. This section provides brief definitions of all the key terminology used in the universe creation discussions.

Universe terminology
A universe is a construct that allows business intelligence users to query data without needing to directly interact with the databases data structures. The following table details the key universe terminology used in this guide.
Term Class Definition A class is a logical grouping of objects within the universe. An object is a universe component that maps to one or more columns in one or more tables in the universe database schema. There are three different types of objects: dimension, detail and measure. A dimension object defines parameters for analysis. Dimensions typically relate to a hierarchy such as geography, product, or time. A detail object provides descriptions for a dimension object. A measure object conveys numeric information which is used to quantify a dimension object.

Object

Dimension

Detail

Measure

78

BusinessObjects Planning Guide to Integration with BusinessObjects XI

The Planning universe structure Structure terminology

BusinessObjects Planning terminology


BusinessObjects Planning data structures define columns in the database. Users query data by using data structures codes in BusinessObjects Planning reports. There are two categories of BusinessObjects Planning terminology used in this document: existing data structures terms, and new data structures terms introduced specifically for universe development. The following two tables define these terms.
Table 7-2: Existing Data Structures terminology

Term Data source

Definition A data source is a set of data for planning and/or reporting purposes, defined by a unique combination of dimensions, time series and other columns. Each data source has a corresponding data table in the database.

Dimension

Dimensions are the independent data tracking items of a data source, such as department, account and job code. Each row in a data source table is defined by a unique combination of dimension elements. There are two types of dimensions: validated and non-validated. Validated dimensions have a defined list of valid values (for example, a list of department codes).

Time series

A time series is a series of data columns within the data source, typically representing one year. Each column of the time series holds the data for a specific time period.

BusinessObjects Planning Guide to Integration with BusinessObjects XI

79

The Planning universe structure Structure terminology

Term Other column

Definition An other column defines a single column of data in the data source. Other columns serve many different purposes and can be further classified into three types: numeric, string and description. Numeric: Numeric other columns contain singleperiod data, such as Current Year Projected. String: String other columns contain text such as comments saved from plan workbooks. Description: A special class of other columns contain descriptions for non-validated dimensions. These columns are identified by the naming convention of the text "Desc" appended to the dimension name (for example: ItemDesc). Summary fields hold the calculated results of time series and other columns for example, the total of all periods of a time series.

Summary field

Table 7-3: New Data Structures terminology for BusinessObjects Integration

Term Time dimension

Definition Time dimensions define a span of time periods for tracking time-varying data (for example, monthly or weekly). A time pivot defines an alternate view of a data source. Instead of storing data in time series columns, a time pivot uses a time dimension to track time-varying data over rows. A measure defines a column of data in a time pivot, by mapping time series periods to time dimension periods.

Time pivot

Measure

80

BusinessObjects Planning Guide to Integration with BusinessObjects XI

The Planning universe structure Planning classes and objects

Planning classes and objects


To enable automated universe creation, the native BusinessObjects Planning data structures are grouped into four types of pre-defined universe classes. When you define a Planning universe, you can choose to include all classes, or selectively include classes. The pre-defined classes are:
Class Native fact classes Time pivot classes Validated dimension classes Time dimension classes Corresponding Data Structure Data sources Time pivots Dimensions (validated only) Time dimensions

By selectively including classes, you can define the specific set of data covered by the universe. You can choose to include data by data source (native fact classes) or by time pivot (time pivot classes). A universe must contain at least one native fact class or time pivot class. Validated dimension classes and time dimension classes are supporting classes. These classes are included in the universe by default depending on the selected native fact classes and time pivot classes. You cannot manually add or remove these supporting classes. Each class contains a number of objects. When a class is added to a universe, you can choose to include all objects in that class or selectively include objects.

Native fact classes


Native fact classes correspond to BusinessObjects Planning data sources. Each object in a native fact class corresponds to a column in the data sources database table (od_all#, where # is the number of the data source).

BusinessObjects Planning Guide to Integration with BusinessObjects XI

81

The Planning universe structure Planning classes and objects

Inclusion status

User-definable. You can choose which, if any, native fact classes to include in the universe. A universe must contain at least one native fact class or time pivot class. When a native fact class is included in a universe, its associated validated dimension classes are automatically included.
Objects

Native fact classes contain the following objects. Some of these objects are required and cannot be excluded.
Planning Column Maps to Object Type Dimension Description Inclusion status

Dimensions

A dimension object is creat- Required ed for each dimension defined within the associated data source. A measure object is created Optional for each time series period that you choose to include in the class. A measure object is created Optional for each summary field that you choose to include in the class.

Time series periods Measure

Summary fields

Measure

Other Columns

Other columns are treated differently depending upon the specific type of other column, as detailed in the following rows.

82

BusinessObjects Planning Guide to Integration with BusinessObjects XI

The Planning universe structure Planning classes and objects

Planning Column

Maps to Object Type

Description

Inclusion status

Numeric Other Col- Measure (default) or By default, a measure ob- Optional umn Dimension ject is created for each numeric other column that you choose to include in the class. In cases where the other column contains descriptive codes rather than planning data, you should designate the column as a dimension object instead. String Other Column Dimension A dimension object is creat- Optional ed for each string other column that you choose to include in the class. A detail object is created for Required each description column defined within the associated data source.

Description Other Column

Detail

Remarks

Other columns which contain text comments do not translate well to universes and should be excluded. String other columns are mapped to dimension objects, which is an inappropriate designation for comments. Validated dimension descriptions are not stored in the data source table they are stored in a separate dimension table. Dimension tables are brought into the universe by using validated dimension classes.

Time pivot classes


Time pivot classes correspond to time pivots. Each object in a time pivot class corresponds to a column in the time pivot table or view.

BusinessObjects Planning Guide to Integration with BusinessObjects XI

83

The Planning universe structure Planning classes and objects

Inclusion status

User-definable. You can choose which, if any, time pivot classes to include in the universe. A universe must contain at least one native fact class or time pivot class. When a time pivot class is included in a universe, its associated time dimension classes and validated dimension classes are automatically included.
Objects

Time pivot classes contain the following objects. Some of these objects are required and cannot be excluded.
Planning Column Maps to Object Type Dimension Description Inclusion status

Dimensions

A dimension object is creat- Required ed for each dimension in the time pivot. This includes one time dimension and any number of traditional dimensions. A measure object is created Optional for each measure that you choose to include in the class. A dimension object is creat- Optional ed for each other column that you choose to include in the class.

Measures

Measure

Other columns

Dimension

Validated dimension classes


Validated dimension classes correspond to dimension tables. The Planning database contains a table for each validated dimension in the system. This

84

BusinessObjects Planning Guide to Integration with BusinessObjects XI

The Planning universe structure Planning classes and objects

table stores the codes, descriptions and grouping columns for the dimension, as defined within Setup > Dimensions. Each object in a validated dimension class corresponds to a column in the dimension table. This table is named for the dimension code for example, DEPT or ACCT.
Inclusion status

Automatic. If a validated dimension is included in a universe as part of a native fact class or time pivot class, then the corresponding validated dimension class is included in the universe by default and cannot be excluded.
Objects

The following objects are included in a validated dimension class. Some of these objects are required and cannot be excluded.
Planning Column Maps to Object Type Dimension Description Inclusion status

Code

A dimension object is creat- Required ed for the primary key column in the dimension table. A detail object is created for Required the description column in the dimension table. A dimension object is creat- Optional ed for each grouping column included in the class.

Description

Detail

Grouping columns

Dimension

Remarks

Grouping columns can be used for several different purposes. Generally, only those grouping columns which define consolidation or "rollup" levels for reporting are useful to include in universes. Grouping columns that store statistics or drivers for use in plan workbooks (for example, escalator columns) or that store reserved codes for system processes (for example, the

BusinessObjects Planning Guide to Integration with BusinessObjects XI

85

The Planning universe structure Planning classes and objects

SRCStdLine column) are typically not relevant to users other than Master System Users.

Time dimension classes


Time dimension classes correspond to time dimensions. Each object in a time dimension class corresponds to a column in the time dimension table.
Inclusion status

Automatic. If a time dimension is included in a universe as part of a time pivot class, then the corresponding time dimension class is included in the universe by default and cannot be excluded.
Objects

The following objects are included in a time dimension class. Some of these objects are required and cannot be excluded.
Planning Column Maps to Object Type Dimension Description Inclusion status

Code

An object is created for the Required primary key column in the time dimension table. An object is created for each grouping column included in the class. Optional

Grouping columns

Dimension

Example case
This example case is provided to illustrate how BusinessObjects Planning data structures are mapped to classes and objects.

86

BusinessObjects Planning Guide to Integration with BusinessObjects XI

The Planning universe structure Planning classes and objects

Example BusinessObjects Planning data structures


The example BusinessObjects Planning system has the following data structures:
Data Structure Data sources Dimensions Component Financial, Payroll

DEPT, ACCT, JobCode, Item DEPT, ACCT, and Item are used in both data sources. The JobCode dimension is only used in the Payroll data source. Item is an non-validated dimension.

Time dimensions Time Pivots

Month, Biweek

FinancialMonthly, PayrollBiweekly Time pivots are defined per data source. FinancialMonthly belongs to Financial, and PayrollBiweekly belongs to Payroll.

Example universe classes


When creating a universe for this example system, the following classes are available for inclusion:
Available Classes Financial Class Type Native fact class Automatically Included Classes DEPT Validated dimension class ACCT Validated dimension class

BusinessObjects Planning Guide to Integration with BusinessObjects XI

87

The Planning universe structure Planning classes and objects

Available Classes Payroll

Class Type Native fact class

Automatically Included Classes DEPT Validated dimension class ACCT Validated dimension class JobCode Validated dimension class DEPT Validated dimension class ACCT Validated dimension class Month Time dimension class DEPT Validated dimension class ACCT Validated dimension class JobCode Validated dimension class Biweek Time dimension class

FinancialMonthly

Time pivot class

PayrollBiMonthly

Time pivot class

If you choose to include all classes in the universe, then all data sources and all time pivots of this BusinessObjects Planning system will be available to universe consumers. Alternatively, you can choose to include specific classes. For example, you might choose to include just the FinancialMonthly class and limit the universe to just the data in the FinancialMonthly time pivot. In this case, the universe would contain four classes: FinancialMonthly and its three supporting classes (DEPT, ACCT and Month).

Example universe objects


Each of the available classes will have a different combination of objects. Two example cases are illustrated: native fact classes and validated dimension classes.
Native fact class

The example set of objects for the Financial class could be as follows:
Object Required objects Object Type Description

88

BusinessObjects Planning Guide to Integration with BusinessObjects XI

The Planning universe structure Planning classes and objects

Object DEPT

Object Type Dimension

Description This object corresponds to the DEPT dimension column. This object corresponds to the ACCT dimension column. This object corresponds to the Item dimension column. This object corresponds to the ItemDesc other column. Because it is a description column, it is created as a detail object by default.

ACCT

Dimension

Item

Dimension

ItemDesc

Detail

Optional objects CYA1 - CYA12 Measure These objects correspond to the CYA time series. There will be an individual measure object for each period in each time series. These objects correspond to the summary fields for the CYA time series. There will be an individual measure object for each summary field for each time series. This object corresponds to the RemProj other column. Because it contains numeric data, it is created as a measure object by default.

CYA_TOT, CYA_CUR, etc.

Measure

RemProj

Measure

Most likely the Financial class includes many time series, summary fields and other columns which are not listed in this example table. If you choose to include all objects in the class, then all data in the class will be available to universe consumers. Alternatively, you can select specific objects to include. In this example, the dimensions and the ItemDesc column are required, but the time series, summary fields and remaining other columns can be included as desired. In many cases you will want to selectively include objects, since some other columns may not translate well to the universe environment and should not be included.

BusinessObjects Planning Guide to Integration with BusinessObjects XI

89

The Planning universe structure Rollups and hierarchies

Validated dimension class

The example set of objects for the DEPT class could be as follows:
Object Required objects Code Dimension This object corresponds to the DEPT code column. This object corresponds to the DEPT description column. Object Type Description

Description

Detail

Optional objects Country Dimension This object corresponds to the Country grouping column. This object corresponds to the VP grouping column. This object corresponds to the SRCBgtTemplate grouping column. This is a system-reserved column that is unlikely to be needed in the universe.

VP

Dimension

SRCBgtTemplate

Dimension

Each validated dimension class likely includes many grouping columns. In most cases you should selectively include only those grouping columns which define consolidation or "rollup" levels for reporting. Other grouping columns, such as the SRCBgtTemplate column in the example, are used in system processes and are unlikely to be useful in reporting or analysis.

Rollups and hierarchies


This section explains how BusinessObjects Planning rollups and hierarchies are converted to custom hierarchies in the Planning universe.
Note: The information in this section only applies to rollups and hierarchies

defined for standard BusinessObjects Planning dimensions. Hierarchies for

90

BusinessObjects Planning Guide to Integration with BusinessObjects XI

The Planning universe structure Rollups and hierarchies

time dimensions must be created within Designer, after a universe has been created.

About rollups and hierarchies


BusinessObjects Planning uses rollups and hierarchies to enable the ability to drill data in a report. Rollups and hierarchies are defined per dimension in the Dimensions workbook, using grouping columns to define hierarchical levels. For example, a geographical rollup or hierarchy might use the grouping columns of Country, Region and City. The difference between a rollup and a hierarchy is exclusivity. In a hierarchy, each element must belong to only one parent. For example, all instances of the City element Seattle must belong to the Region element of Northwest. Rollups do not require exclusivity. For example, you could construct a rollup where department types (DeptType) roll up to vice presidents (VP). In this case, it is unlikely that each element of the DeptType grouping column belongs to only one vice president. Some Revenue departments belong to VP Simpson, and others belong to VP Edwards. Rollups allow you to create non-exclusive drilling paths. The corresponding construct in a universe is a hierarchy. A hierarchy is an ordered series of dimensions that enable multidimensional analysis (drilling). Hierarchies can contain both exclusive and non-exclusive structures.

How rollups and hierarchies are applied as custom hierarchies


When a validated dimension in BusinessObjects Planning is included in a universe, each grouping column becomes a dimension in the universe. The rollups and hierarchies defined for that validated dimension in BusinessObjects Planning are applied as custom hierarchies, using the grouping column dimensions. For example, in BusinessObjects Planning you could have a Geography hierarchy defined for the DEPT dimension. This hierarchy consists of three grouping columns as follows: Geography: Country > Region > City

BusinessObjects Planning Guide to Integration with BusinessObjects XI

91

The Planning universe structure Rollups and hierarchies

When DEPT is included in a universe, four dimensions are created in the universe: DEPT, Country, Region and City. A custom hierarchy is created for the Country, Region, and City dimensions. When you create a universe, you can choose to include all grouping columns for a dimension, or selectively include grouping columns. If you exclude a grouping column from the universe, then any rollups or hierarchies using that grouping column are still created in the universe, but the excluded grouping column is omitted.

Creating or modifying hierarchies in Designer


Hierarchies that are created by BusinessObjects Planning remain controlled by BusinessObjects Planning. If you make any changes to these hierarchies in Designer, those changes will be overwritten upon the next universe update. You can create additional hierarchies in Designer as desired. BusinessObjects Planning ignores these manually created hierarchies when universe updates are performed.
Note: If you want time hierarchies in your universe, you must create them

within Designer. Designer has easy-to-use functionality for this purpose.


Related Topics

Modifying Planning universes in Designer on page 106

92

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Defining Planning universes

Defining Planning universes About universe definitions and universe files

This section discusses how to define Planning universes. Using the universe creation features in BusinessObjects Planning, you define the contents of a universe by selecting from pre-defined classes and objects that correspond to BusinessObjects Planning data structures. When you save the universe definition in BusinessObjects Planning, the universe file is automatically created and saved to the CMS. If desired, you can make additional edits to the universe by using Designer.

About universe definitions and universe files


In discussions about defining and administering Planning universes, sometimes the distinction must be made between the universe definitions in BusinessObjects Planning and the resulting universe files in the CMS. Universe definitions are created in BusinessObjects Planning using the Universes dialog. Universe definitions consist of basic universe settings and a list of included classes and objects. Universe files (UNV files) are created in the CMS based upon the universe definitions in BusinessObjects Planning. When a universe definition is saved in BusinessObjects Planning, a process is initiated to construct or update the associated universe file to match the definition.

Defining universes in BusinessObjects Planning


Note:

The Universes menu item is only available if BusinessObjects integration has been enabled in the Configuration Manager. User access to the Universes dialog is linked to the Data Structures security setting. If a user has the right to access the Data Structures dialog, that user can also access the Universes dialog.

By defining universes, you can make BusinessObjects Planning data available to users of BusinessObjects business intelligence tools. To access the universe definitions for a system:

94

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Defining Planning universes Defining universes in BusinessObjects Planning

In Excel 2003, XP, or 2000: Click Plan > Database > Universes. In Excel 2007: On the Plan tab, in the System Management group, click Database > Universes.

The defined universes for the system display in the top half of the dialog. When you select a universe, the included classes and objects for that universe display in the bottom half of the dialog, on the Classes tab. The following screenshot shows an example Universes dialog:

After making edits in the Universes dialog, click the Update icon in the toolbar. Performing an update saves the universe definitions, and creates or updates the associated universe files in the CMS. If you do not want to save your edits, click Close to exit the dialog without saving, or click Revert to revert to the last-saved universe definition.

BusinessObjects Planning Guide to Integration with BusinessObjects XI

95

Defining Planning universes Defining universes in BusinessObjects Planning

Related Topics

Planning classes and objects on page 81 Properties of Planning-generated universes on page 104

To add a universe definition


1. Click Plan > Database > Universes. In Excel 2007: On the Plan tab, in the System Management group, click Database > Universes. 2. Click the New button to the right of the universes grid. The New Universe dialog replaces the universes grid. 3. Complete the universe settings: Type a name and description for the universe. If you want to include all classes in the universe, select Include All Classes. If you want to control universe security manually, clear the Automate Security check box. For more details on these settings, see Universe settings on page 97. 4. Click Save. The universe definition is added to the universe grid. In almost all cases, the next step is to manage the classes included in the universe. Even if you chose to include all classes, you likely need to manage the objects included in the classes. See Managing the classes in a universe on page 99. However, if you included all classes and you do not need to make any further changes, you can click Update now to generate the universe in the CMS.

To edit a universe definition


You can edit any of the universe settings. If you change the universe name, a new universe file will be created with the new name and the obsolete universe file will remain in the CMS. You must manually delete the obsolete universe file in the CMS and update any existing reports to reference the new universe file as needed.

96

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Defining Planning universes Defining universes in BusinessObjects Planning

You can also edit the classes included in a universe. See Managing the classes in a universe on page 99. 1. Click Plan > Database > Universes. In Excel 2007: On the Plan tab, in the System Management group, click Database > Universes. 2. Click the universe that you want to edit, and then click the Edit button to the right of the universe grid. The Edit Universe dialog replaces the universe grid. 3. Edit any of the universe settings as desired. See Universe settings on page 97 for more details. 4. Click Save. 5. Click Update to save the universe definition and update the universe in the CMS.

Universe settings
The following settings can be defined for each universe:
Field Name Description

Type a name for the universe. The name is limited to 50 characters. This name defines both the universe file name (.unv) and the "published" universe name presented to business intelligence users.

Description

Type a description for the universe. This description will be saved in the universe file as the universe description.

BusinessObjects Planning Guide to Integration with BusinessObjects XI

97

Defining Planning universes Defining universes in BusinessObjects Planning

Field Include All Classes

Description

Select this check box if you want to include all classes in the universe. If this option is selected for a universe, not only will all current classes be included, but any new classes will automatically be added. If this check box is not selected, then you must manually add classes to the universe.

Automate Security

By default, this check box is selected, which means that universe security is managed by BusinessObjects Planning. Users imported from BusinessObjects Enterprise are automatically granted access to the universe, and their data filters are applied as access restrictions. If you prefer to control universe security manually, clear this check box.

Related Topics

Managing the classes in a universe on page 99 Managing access to Planning universes on page 118

To delete a universe definition


Deleting a universe definition does not delete the associated universe file in the CMS. You must manually delete the universe file. 1. Click Plan > Database > Universes. In Excel 2007: On the Plan tab, in the System Management group, click Database > Universes. 2. Click the universe that you want to delete, and then click the Delete button to the right of the universe grid. 3. Click Update to remove the universe definition from the database.

98

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Defining Planning universes Defining universes in BusinessObjects Planning

Managing the classes in a universe


By defining which classes to include in a universe, and which objects are included in each class, you define the data that will be available to the universe consumer. To view the classes for a universe: 1. Click Plan > Database > Universes. In Excel 2007: On the Plan tab, in the System Management group, click Database > Universes. 2. Click the desired universe. The classes for the universe display in the Classes tab in the bottom half of the dialog. If you chose to include all classes when defining the universe, then all classes are added to the Classes tab. You cannot add or remove classes while Include All Classes is selected for the universe, but you can edit the objects in the classes. By default, when a class is automatically added to a universe, all objects in the class are automatically included as well. If you want to add or remove classes in a universe, the Include All Classes check box must be cleared for the universe.
Related Topics

Planning classes and objects on page 81

To add a class to a universe


You can add native fact classes and time pivot classes to a universe. The supporting validated dimension classes and time dimension classes will be added to the universe automatically.
Note: You cannot add a class to a universe if the Include All Classes option

is selected for the universe. If Include All Classes is enabled, the universe already contains all classes by default. If you want to selectively add or remove classes from a universe, you must first edit the universe settings to

BusinessObjects Planning Guide to Integration with BusinessObjects XI

99

Defining Planning universes Defining universes in BusinessObjects Planning

clear the Include All Classes check box. See To edit a universe definition on page 96. 1. In the Universes dialog, click the desired universe. The defined classes for that universe display in the Classes tab in the bottom half of the dialog. 2. On the Classes tab, click New. The New Class dialog replaces the classes grid. 3. On the Type list, select Native Fact or Time Pivot. 4. On the Data Source list, select the desired data source for the class. 5. If the class type is Time Pivot, select the desired time pivot from the Time Pivot list. 6. Edit the Include All Class Objects check box as desired: If the Include All Class Objects check box is selected, then all objects are included in the class. Not only will all current objects be included, but any new objects will be automatically added. If the Include All Class Objects check box is cleared, then only the required objects are included in the class. You must edit the class later if you want to include any optional objects.
Tip: If you plan to include most of the objects in a class, it is easiest to

include all objects now, and then edit the class later to remove the few objects that you do not need. 7. Click Save. The class and any necessary supporting classes are added to the classes grid. Note that supporting classes by default include all objects. You must edit the supporting class if you do not want to include all objects in that class. Remember that the universe will not be updated in the CMS until you click Update.
Related Topics

Planning classes and objects on page 81

100

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Defining Planning universes Defining universes in BusinessObjects Planning

Managing which objects are included in a class


Once a class has been added to a universe, you can edit the objects included in that class. All classes can be edited, regardless of whether the class was manually included or automatically included. Each universe class corresponds to a table in the BusinessObjects Planning database, and each object in the class corresponds to a column in the table. Some columns are required and cannot be excluded, such as dimension key columns.
Note: Required columns do not display in the classes dialog but are always

included in the class. When editing a class, you can choose to include the optional columns as dimension objects or measure objects. (The third object category, detail, is not displayed because all detail objects are required.) The mapping rules for optional columns are: Time series columns, summary field columns, and measure columns are always measure objects. Grouping columns are always dimension objects. In native fact classes, other columns can be measure objects or dimension objects. By default, numeric other columns are measure objects and string other columns are dimension objects. In time pivot classes, other columns are always dimension objects.

See Planning classes and objects on page 81 for detailed information on how BusinessObjects Planning columns map to universe objects, and which objects are required.

To select the objects to include in a class 1. In the Universes dialog, click the desired universe.
The defined classes for that universe display in the Classes tab in the bottom half of the dialog. 2. On the Classes tab, click the desired class and then click Edit. The Edit Class dialog replaces the classes grid. The dimension and measure objects currently included in the class display at the bottom of the dialog. The following screenshot shows an example Edit Class dialog.

BusinessObjects Planning Guide to Integration with BusinessObjects XI

101

Defining Planning universes Defining universes in BusinessObjects Planning

3. To edit the optional objects included in a class, clear the Include All Class Objects check box and then click Edit. The Class Objects dialog opens. This dialog has two tabs, Dimensions and Measures.
Note: Some classes do not have measure objects, in which case the

Measures tab does not appear. 4. Edit the dimensions and measures as desired: To edit the dimension objects, click the Dimensions tab and then use the arrow buttons to add or remove dimensions as desired. Any columns listed in the Universe Dimensions box will be added to the class as dimension objects. To edit the measure objects, click the Measures tab and then use the arrow buttons to add or remove measures as desired. Any columns listed in the Universe Measures box will be added to the class as measure objects.
Note: When editing a native fact class, other columns can be either

dimensions or measures. If you want to change the default assignment of an other column, go to the Dimensions or Measures tab and remove the item from the selected list. The other column will then display in the available list for both Dimensions and Measures. You can then add it to the appropriate selected list.

102

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Defining Planning universes Defining universes in BusinessObjects Planning

5. Click OK to return to the Universes dialog, and then click Save. Remember that the universe will not be updated in the CMS until you click Update.

To delete a class from a universe


You can delete native fact classes and time pivot classes from a universe definition. If necessary, any associated time dimension classes and validated dimension classes will also be deleted from the universe definition automatically.
Note: You cannot delete a class from a universe if the Include All Classes

option is selected for the universe. If you want to selectively add or remove classes from a universe, you must first edit the universe settings to clear the Include All Classes check box. See To edit a universe definition on page 96. 1. In the Universes dialog, click the desired universe. The defined classes for that universe display in the Classes tab in the bottom half of the dialog. 2. On the Classes tab, click the class that you want to delete, then click the Delete button next to the classes grid. The selected class is removed from the classes grid. Supporting classes are only removed if they are not used in any other remaining native fact classes or time pivot classes. 3. Click Update to save the change to the universe definition. If a class is deleted from a universe definition, the associated table is not deleted from the universe file in the CMS. You must use Designer to manually delete the obsolete class and associated table from the universe.
Related Topics

Removing obsolete elements on page 107

BusinessObjects Planning Guide to Integration with BusinessObjects XI

103

Defining Planning universes Properties of Planning-generated universes

To view the manually managed elements in a universe


When viewing a universe in Designer, it may be difficult to discern the manually managed elements from the Planning-managed elements. To help you identify the manually managed elements in a universe, BusinessObjects Planning provides a feature that examines the current universe in the CMS and displays a list of manually managed elements. If any of these manually managed elements are no longer needed, you can then delete them in Designer. 1. Click Plan > Database > Universes. In Excel 2007: On the Plan tab, in the System Management group, click Database > Universes. 2. In the Universes dialog, select the desired universe. 3. Click the Manual Objects tab, then click Retrieve. Any manually managed classes, tables or hierarchies found in the universe file are listed in the Manual Objects tab. This information is presented for your reference only. If you want to remove or edit any manually managed elements, you must use Designer.
Related Topics

Modifying Planning universes in Designer on page 106

Properties of Planning-generated universes


When you save universe definitions in BusinessObjects Planning, the universe files are automatically generated and saved to the Central Management Server (CMS). This section explains where these Planning-generated universes are saved, and what basic universe properties and settings are created by BusinessObjects Planning.

104

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Defining Planning universes Properties of Planning-generated universes

Universe placement in the repository


Universes generated by BusinessObjects Planning are automatically saved to the Central Management Server (CMS) repository, in the \Planning folder. Each system defined in BusinessObjects Planning has a subfolder underneath the Planning folder, which holds the universes defined for that system. The system names are derived from the Planning Configuration Manager, and the universe names are defined within the system using the Universes dialog. The connection parameters for the Planning universes are stored under the \Connections folder in the repository. These files use the naming convention of Planning.SystemName.

Universe contents created by BusinessObjects Planning


BusinessObjects Planning creates the following universe components automatically: Universe classes and objects For each class and object included in the universe definition, a corresponding class and object is created in the universe file. Schema components Database schema components tables, columns, joins and contexts are created in the universe file as necessary to support the included classes and objects. The structure of the BusinessObjects Planning database with dimension tables shared by multiple fact tables creates a universe condition known as a loop. Contexts are used to resolve these loops in Planning universes. Custom hierarchies Custom hierarchies are created in the universe file based on the rollups and hierarchies defined in BusinessObjects Planning. Database connections

BusinessObjects Planning Guide to Integration with BusinessObjects XI

105

Defining Planning universes Modifying Planning universes in Designer

The database connection for the universe is created based on the connection parameters defined for the BusinessObjects Planning system in the Configuration Manager. Row access restrictions If automated security is enabled for the universe, a row access restriction is created for each imported user based on the users data filter in BusinessObjects Planning security.

Modifying Planning universes in Designer


Once a Planning universe has been created, you can further modify the universe using Designer. The term "elements" is used in this section to refer to the various items that can be created in universes, such as classes, objects, tables, and hierarchies.
Note: Some edits to object and universe properties may cause the data

returned to universe consumers to be different from the data returned to BusinessObjects Planning users. You should only edit universe and object properties if you fully understand the effects of the change.

Modifying Planning-managed elements


Any element in a universe that corresponds to the universe definition in BusinessObjects Planning is a Planning-managed element. Planning-managed elements are controlled by BusinessObjects Planning and generally should not be modified in Designer, or else your edits will be overwritten upon the next universe update. For example, if you delete a table that BusinessObjects Planning expects to be present based upon the universe definition, BusinessObjects Planning will recreate that table when the universe is next updated. The following guidelines apply to modifying Planning-managed elements: Planning-managed classes, tables, joins, and contexts should not be edited.

106

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Defining Planning universes Modifying Planning universes in Designer

The following properties of Planning-managed columns should not be edited: name, type, and primary key. The following properties of Planning-managed objects should not be edited: name, type, table, select statement, qualification, aggregate function, and associated dimension.

Creating and modifying manually managed elements


You can manually create additional elements in a Planning universe by using Designer. Any universe element that BusinessObjects Planning does not recognize will be ignored upon future universe updates. For example, you may want to add an object that corresponds to the Current Period table in the BusinessObjects Planning database. If you create these items manually in the universe, they will be preserved when the universe is updated. If you create a join between a manually managed element and a Planning-managed element, it will also be preserved.
Related Topics

What occurs during a universe update on page 114

Removing obsolete elements


BusinessObjects Planning will not remove any unknown classes, tables, or hierarchies in a universe. This behavior is intentional, to give you maximum flexibility in making additions to the Planning universe in Designer. As a result, certain changes in BusinessObjects Planning will not be automatically reflected in the universe. If a change is made to the BusinessObjects Planning data structures which results in a class, table, or hierarchy becoming obsolete, you must manually remove that element from the universe by using Designer. To help you manage obsolete elements, BusinessObjects Planning provides a feature that lists the manually managed elements in the universe. You can view this list to help determine if the universe contains any obsolete elements that need to be removed.

BusinessObjects Planning Guide to Integration with BusinessObjects XI

107

Defining Planning universes Modifying Planning universes in Designer

In practice, once BusinessObjects Planning data structures are created and rolled out to a user community, they are very rarely removed. Obsolete elements should not occur very often in universes.
Related Topics

To view the manually managed elements in a universe on page 104

Modifying universe settings in Designer


The universe name, description and connection parameters are controlled by BusinessObjects Planning and cannot be modified. Other universe properties can be modified as desired. BusinessObjects Planning must be able to access the universe in order to update it. If you assign the universe a password or lock the universe, universe updates will fail.

Running an integrity check in Designer on Planning universes


If the Check Integrity tool is used in Designer to check the integrity of a Planning-generated universe, errors may result. The following errors are expected and can be ignored: Type of integrity check Error Cause

Check Universe Structure

The type of field name This error is always reported when has changed

integer type fields are present in the Planning database, regardless of whether the field type has changed or not.

108

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Defining Planning universes Modifying Planning universes in Designer

Type of integrity check Error

Cause

Check Universe Structure

Field name column has This error is reported because there been added

are certain system control fields in the Planning data source tables that BusinessObjects Planning does not export to the universe. The absence of these fields does not have any effect on the integrity of the Planning data available to universe consumers.

Parse Objects

The expression type is not This error always reported when incompatible with the object teger type fields are present in the type

Planning database. The universe is still valid.

BusinessObjects Planning Guide to Integration with BusinessObjects XI

109

Defining Planning universes Modifying Planning universes in Designer

110

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Administering Planning universes

Administering Planning universes Updating Planning universes

Once a universe has been created, the following aspects should be managed on an ongoing basis: Universe updates Once a universe has been created, it is updated automatically in response to structure-changing events in BusinessObjects Planning. If necessary, you can also manually execute universe updates. Time pivot updates If time pivots are included in a universe, you may need to perform time pivot refreshes. Specifically, if the Table storage type is used in the time pivot, the time pivot must be refreshed periodically to provide universe consumers with access to the latest data. User access to universes For each universe, you can choose whether or not to enable automated security management. If automated security management is enabled, then users imported into the BusinessObjects Planning system from BusinessObjects Enterprise are automatically granted access to the universe, and the users data filters are applied as row access restrictions. If you disable automated security management, or if you have users and groups that were not imported into BusinessObjects Planning but need access to the Planning universe, you must grant this access manually.

Updating Planning universes


Universes are automatically updated in response to certain events in BusinessObjects Planning. This section discusses what events trigger an automatic update of universes, and how to perform a manual update if necessary.

Events that trigger automatic universe updates


Two categories of events trigger automatic universe updates: structure-changing events and user-management events. If any errors or warnings are encountered during a universe update, they will be logged in the Planning Application Server log.

112

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Administering Planning universes Updating Planning universes

Structure-changing updates to Planning universes


The following structure-changing events in BusinessObjects Planning trigger an automatic universe update: Any Data Structures save A Dimensions save that includes a new or removed grouping column A Dimensions save that includes a change to Rollups and Hierarchies

When a structure changing-event occurs, both the universe definition in BusinessObjects Planning and the universe file in the CMS are updated. Any automatic additions to a universe definition result in a corresponding addition to the universe file in the CMS. However, deletions are not fully automated. While removed columns (objects) will be deleted in the corresponding universe file, removed classes (tables) will not be. You must manually delete these obsolete tables in the universe using Designer.
Changes that result in class additions or deletions

If a new data source or time pivot is added to a BusinessObjects Planning system, it will be automatically added to any universe that has Include All Classes enabled. If a validated dimension is added to or deleted from a data source, the validated dimension classes in a universe definition will be updated appropriately. However, if a dimension is deleted, the obsolete dimension class will not be removed from the universe file. If the time dimension in a time pivot is changed, the universe definition will be automatically updated to add the new time dimension class and remove the old time dimension class. However, the obsolete time dimension class will not be removed from the universe file. If a data source or a time pivot is deleted, any universe definitions that use the corresponding native fact classes or time pivot classes will be automatically updated to remove the class (and any supporting classes as appropriate). However, the obsolete classes will not be removed from the universe file.

Changes that result in object additions or deletions

The following changes will impact the objects in a class: Adding or deleting a grouping column Adding or deleting a dimension

BusinessObjects Planning Guide to Integration with BusinessObjects XI

113

Administering Planning universes Updating Planning universes

Adding or deleting a time series Adding or deleting an other column Adding or deleting a measure Adding or deleting a summary field

If the class impacted by the change has Include All Class Objects enabled, then any new objects will be automatically added. Otherwise you must manually edit the class if you want to include the new object. If the change results in a deletion of an object, both the universe definition and the universe file will be automatically updated for the deletion.

User-management events
If automated security is enabled for a universe, the following user-management events in BusinessObjects Planning trigger an automatic universe update: An imported user is added or deleted An imported user's obsolete status is changed An imported users data filter is changed An imported users group assignments are changed An imported user is converted to a BusinessObjects Planning user A groups data filter is changed, which impacts the data filter of an imported user

What occurs during a universe update


When a universe update is initiated, the following actions are performed in the universe file: All Planning-managed classes, objects, tables, columns, and hierarchies are updated. This update includes the addition and deletion of columns in Planning-managed tables and their associated objects. If BusinessObjects Planning cannot find a required element in the universe, that element is created. Any manually managed element in the universe is retained. This includes classes, tables, and hierarchies that were originally created by BusinessObjects Planning but which are no longer found in the universe definition.

114

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Administering Planning universes Updating Planning universes

Joins and contexts between Planning-managed tables are updated. Joins and contexts between manually managed tables are retained. Joins between manually managed tables and Planning-managed tables are retained, unless the join's column in the Planning-managed table is removed. If automated security is enabled, Planning-managed user access rights are updated and their associated row access restrictions are updated. Any manually managed access rights and restrictions are retained. The universe connection parameters are updated. The universe name and description are updated.

Planning-managed elements are universe elements that correspond to the universe definition in BusinessObjects Planning. Manually managed elements are any elements that BusinessObjects Planning does not recognize as part of the universe definition. These may be elements that you created manually in Designer, or they may be obsolete elements as a result of a deletion in BusinessObjects Planning.

When to manually execute a universe update


Although most universe updates occur automatically, there are a few situations where a Planning universe can get out of sync with the BusinessObjects Planning database. You should manually execute a universe update in the following situations: After changing the connection parameters for the BusinessObjects Planning database in the Planning Configuration Manager. If an error occurred during an automatic universe update, so that BusinessObjects Planning was updated but the universe was not.

To update a universe manually


1. Click Plan > Database > Universes. In Excel 2007: On the Plan tab, in the System Management group, click Database > Universes. 2. Click Update.

BusinessObjects Planning Guide to Integration with BusinessObjects XI

115

Administering Planning universes Refreshing time pivots

Refreshing time pivots


Periodically, you may need to refresh the time pivots that are referenced in Planning universes. When a time pivot is refreshed, its structure and data are updated according to its corresponding data source table. You can refresh time pivots manually, or you can schedule a time pivot refresh using the Scheduler utility. The need to refresh the data in a time pivot depends upon the time pivot storage type: If the storage type is Table, then the data in the time pivot is static. You must refresh the time pivot on a regular basis to update the table with the latest data from the corresponding data source table. If the storage type is View, the data in the time pivot is always current, so regular refreshes are not necessary.

Under normal circumstances, the structure of a time pivot is kept in synch with its corresponding data source table automatically. Once you have defined a time pivot, any update to Data Structures triggers a refresh of the time pivot table or view. The only time you need to refresh a time pivot for structure reasons is if an error occurred during a Data Structures save that prevented the time pivot from being updated.
Related Topics

Time pivot storage types on page 66 Impacts of time pivots on Data Structures update on page 75

To refresh a time pivot manually


You can refresh time pivots manually within the Data Structures dialog. 1. Click Plan > Database > Data Structures. In Excel 2007: On the Plan tab, in the System Management group, click Database > Data Structures. 2. In the left-hand side of the Data Structures dialog, expand the desired data source in the tree structure, then click Time Pivots. 3. In the Time Pivots pane, click the desired time pivot, then click Refresh.

116

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Administering Planning universes Refreshing time pivots

The time pivot refresh occurs immediately. Unless you have further edits to make in the Data Structures dialog, you can close the dialog without saving.

To schedule a time pivot refresh for automated execution


You can schedule a time pivot refresh for automated execution using the Scheduler utility. The primary purpose of this Scheduler task is to enable regular refreshes of table time pivots so that universe consumers have access to updated data. The following describes the basic steps for scheduling a time pivot refresh. For full details on the Scheduler utility, see the Planning Professional Edition Online Help or the Planning Professional Edition Administrator's Guide. 1. Click Plan > Utilities > Scheduler. In Excel 2007: On the Plan tab, in the System Management group, click Utilities > Scheduler. 2. Click the New Job icon, then type a Job Name and Description for the new job. You can also add the time pivot refresh task to an existing job. 3. Add the time pivot refresh task to the job: a. In the Tasks for Job pane at the bottom of the dialog, click the New Task icon. The Setup Task dialog opens. b. On the Task Type list, click Time Pivot Refresh. c. Complete the settings for the task: Type a Name for the task. In the Data source list, click the data source that contains the time pivot. In the Time Pivot box, select the time pivots to update. You can use the SHIFT or CTRL keys to select more than one time pivot.

d. Click OK. 4. Complete the remaining job settings (Job Recurrence and Notifications) by clicking through the Job Wizard.

BusinessObjects Planning Guide to Integration with BusinessObjects XI

117

Administering Planning universes Managing access to Planning universes

Note: Remember that the scheduled time is evaluated in the context of

the Planning database server's time zone. The Job Wizard displays the database time (as "Scheduler time") and the local time for your reference.

Managing access to Planning universes


This section discusses managing user access to the Planning universe files in the CMS.

User rights to Planning universes


Once a Planning universe has been saved, it is available in the CMS for access by any BusinessObjects Enterprise user who has the appropriate rights. You can grant access rights manually in BusinessObjects Enterprise, or you can use the automated security management features for Planning universes.

Automatic security management for universes


By default, universes are configured so that access rights for imported users are automatically managed by BusinessObjects Planning. When Automate Security is enabled for a universe, then any users that were imported into that BusinessObjects Planning system from BusinessObjects Enterprise are automatically granted access to the universe. Additionally, the BusinessObjects Planning data filters for those imported users are automatically applied as access restrictions on the universe. Universe access rights are granted on a per user basis. Any imported user that is not flagged as Obsolete in BusinessObjects Planning is granted universe access rights. The assigned access level is "Advanced", with the following specific rights granted: View Objects Print Universe Show Table or Object Values Data Access

118

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Administering Planning universes Managing access to Planning universes

The user is also granted Advanced access rights to the universe connection (with the specific rights of View Objects, Data Access, and Use Connection for Stored Procedures). To keep the user access rights synchronized, any relevant change to imported users in BusinessObjects Planning will trigger a universe update. During the update, the following occurs: Newly imported users are granted access to the universe. If an imported user no longer exists in BusinessObjects Planning, or is flagged as Obsolete, that user's access rights are removed. The access rights for all existing imported users are reset. The access restrictions for all imported users are regenerated based on the users current data filters.

If you want to grant access rights to other users who are not imported into BusinessObjects Planning, you can configure those access rights in BusinessObjects Enterprise manually. BusinessObjects Planning will ignore those manually managed access rights when the universe is updated.
Related Topics

BusinessObjects Enterprise user integration on page 25 Universe settings on page 97 Applying data filters as access restrictions on page 120 Updating Planning universes on page 112

Manual security management for universes


If you do not want BusinessObjects Planning to manage security for a universe, you can disable automated security. If Automate Security is disabled for a universe, all user access for that universe must be managed manually in BusinessObjects Enterprise. See your BusinessObjects Enterprise documentation for more information. With manual security management, imported users are not automatically granted access to universes, and data filters are not applied as access restrictions. User changes in BusinessObjects Planning do not trigger updates to the universe. When universe updates do occur, user rights are not affected.

BusinessObjects Planning Guide to Integration with BusinessObjects XI

119

Administering Planning universes Managing access to Planning universes

Related Topics

To edit a universe definition on page 96 Automatic security management for universes on page 118

Applying data filters as access restrictions


When automated security is enabled for a universe, the data filters of imported users are automatically applied as access restrictions in the universe. This section explains how this feature works. The access restriction feature only applies to users imported from BusinessObjects Enterprise. If you give other users access to the universe, you must handle any access restrictions for those users manually.

About data filters


In BusinessObjects Planning, data filters are used to restrict a users access to a data source. If no data filter is applied, the user can access all of the data in a data source. Data filters have the following characteristics: Data filters are defined on a per data source basis. Data filters can be defined on both a group level and an individual-user level. If a user belongs to a group, that user inherits any data filter defined for that group. The group filter is combined with any individual filter using AND. Data filters are defined as part of the user or group security settings, in Plan > Administration > Security Settings.

Data filters use standard BusinessObjects Planning filter criteria syntax. Grouping codes are often used. For more details, see the Planning Professional Edition Online Help or the Planning Professional Edition Administrator's Guide. The following table details some example data filters:

120

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Administering Planning universes Managing access to Planning universes

Filter Example
Dept.Region=Northwest

Description This filter uses a grouping code to restrict the user to data from the Northwest region only. This filter prevents the user from accessing accounts 200000 to 399999. (For example, those account numbers might be reserved for payroll-related accounts.) This filter could be applied to user Smith to restrict that user to data for departments that he or she is responsible for.

Acct <200000 and Acct >= 400000

Dept.Manager=Smith

How data filters are applied as row access restrictions


Data filters are applied as row access restrictions on a per-user basis. When a universe is created, BusinessObjects Planning resolves the full data filter for the imported user, and then applies that filter as a row access restriction in the universe. The restriction is named username_planning_overload. If a user does not have any data filters, no restriction is created. The full data filter for a user is the users individual data filter plus any data filters for groups the user belongs to. All of the applicable filters are concatenated using AND.
Access restriction syntax

The syntax used within the access restriction may differ from the original data filter syntax in BusinessObjects Planning. This difference is due to the use of grouping codes. Grouping codes are not stored in the same table as the data source data. Within BusinessObjects Planning, this is handled by automatically adding a join clause to the SELECT query.

BusinessObjects Planning Guide to Integration with BusinessObjects XI

121

Administering Planning universes Managing access to Planning universes

Within the universe, it is not possible to add a join clause to the SELECT query. Therefore, when grouping codes are used, the WHERE clause of the access restriction must be structured as a sub-select. The following example shows how a BusinessObjects Planning data filter with a grouping code is translated to an access restriction:
BusinessObjects Planning data filter Equivalent Planning universe access restriction
Dept.Region=Northwest (((SELECT DEPT.Region FROM DEPT WHERE DEPT.DEPT = OD_ALL0.DEPT) = 'Northwest'))

Differences in applying group restrictions

The way in which BusinessObjects Planning applies group filters differs from the expected behavior in BusinessObjects Enterprise. In BusinessObjects Planning, if a user belongs to multiple groups and each group has a data filter, the group filters are concatenated using AND. The user can only access data that meets the criteria of the users personal filter and all group filters. In BusinessObjects Enterprise, multiple group restrictions are concatenated using OR. A user can access data if it meets the users personal restriction and any one of the applicable group restrictions.
Group filter application in Busines- Group restriction application in sObjects Planning BusinessObjects Enterprise User AND Group1 AND Group2 User AND (Group1 OR Group2)

When a users BusinessObjects Planning data filter is applied as a universe access restriction, the BusinessObjects Planning rule applies. The data that an imported user can access will be the same in the universe as it is in BusinessObjects Planning.

122

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Administering Planning universes Managing access to Planning universes

Modifying data filters and access restrictions


Whenever an update is made in BusinessObjects Planning security that would impact an imported users data filter, the universe is automatically updated for that change. Any row access restriction generated by BusinessObjects Planning remains controlled by BusinessObjects Planning. Any changes made to that restriction in Designer will be overwritten when the next universe update is performed. If desired, you can create new access restrictions in Designer for non-imported users. BusinessObjects Planning will ignore these manually-created restrictions when the universe is updated.
Related Topics

Updating Planning universes on page 112

Disabling access restrictions


BusinessObjects Planning applies data filters for imported users as universe access restrictions by default. If desired, you can disable this feature on a per universe basis by clearing the Automate Security check box. If automated security is disabled, BusinessObjects Planning does not manage any security settings for the universe. You must manage all user access and restrictions within BusinessObjects Enterprise and Designer.
Related Topics

To edit a universe definition on page 96 Automatic security management for universes on page 118

BusinessObjects Planning Guide to Integration with BusinessObjects XI

123

Administering Planning universes Managing access to Planning universes

124

BusinessObjects Planning Guide to Integration with BusinessObjects XI

URL Syntax for Launching Planning Web Access Options

10

10

URL Syntax for Launching Planning Web Access Options Using a BusinessObjects Enterprise logon token

BusinessObjects Planning supports a number of URL parameters that can be used to directly launch into Planning web access options. If BusinessObjects integration is enabled, two additional URL parameters are available to support integrated users. For more details on Planning direct-launch URL syntax, see the BusinessObjects Planning Installation Guide.

Using a BusinessObjects Enterprise logon token


The token parameter enables the ability to launch Planning web access options from within BusinessObjects business intelligence applications such as InfoView, without requiring the user to enter login credentials. You can use the token parameter in place of the standard user name and password parameters to pass a BusinessObjects Enterprise logon token to BusinessObjects Planning. This is a temporary token that represents a user who has already been authenticated by logging into a BusinessObjects Enterprise application. BusinessObjects Planning will honor the token if the user exists as an imported user in the indicated system. To enable this integrated login, you must generate a URL that contains a BusinessObjects Enterprise logon token as well as the standard Planning direct-launch parameters.
Syntax

The syntax for use of the token parameter is:


http://servername/PlanningDesktop/loginsa.aspx?token=BOElogonto ken&ao=accessoption&system=systemname

The token parameter is the logon token generated by BusinessObjects Enterprise. The remaining parameters are standard Planning direct-launch parameters.

126

BusinessObjects Planning Guide to Integration with BusinessObjects XI

URL Syntax for Launching Planning Web Access Options Using a BusinessObjects Enterprise authentication type

10

Example

The following URL could be used to launch the Budgeting system in Web Forms:
http://myplanningserver/PlanningDesktop/LoginSA.aspx?token=my cmsserver@21126Jo9utMtOJw1or CxO21125JpQvwzyd87ozCVGb&ao=forms&system=budgeting

Related Topics

URL syntax for direct launch on page 128

Using a BusinessObjects Enterprise authentication type


The authtype parameter enables the ability to directly launch a Planning web access option using BusinessObjects Enterprise authentication. The authtype parameter is used in conjunction with the user name and password parameters to provide BusinessObjects Planning with the complete information needed to authenticate the user. The user must exist as an imported user in the indicated system.
Syntax

The syntax for use of the authtype parameter is:


http://servername/PlanningDesktop/loginsa.aspx?ao=accessop tion&system=systemname&User=username&pwd=password&authtype=BOEau thtype

The authtype parameter must be a valid BusinessObjects Enterprise authentication string, such as secEnterprise or secWindowsNT.
Example

The following URL could be used to launch the Budgeting system in Web Forms, using Enterprise authentication.
http://myplanningserver/PlanningDesktop/LoginSA.as px?ao=forms&system=budgeting&user=jdoe&password=mypass&au thtype=secEnterprise

BusinessObjects Planning Guide to Integration with BusinessObjects XI

127

10

URL Syntax for Launching Planning Web Access Options URL syntax for direct launch

URL syntax for direct launch


The basic URL syntax to directly launch a Planning web access option is as follows:
PlanningWebAddress?param1=value&param2=value

For use with BusinessObjects integration, the Planning web address must use the default stand-alone login page (loginsa.aspx). Do not use the login page for security integration. A question mark is used to separate the web address from the parameters. Each parameter is entered as parametername=value. An ampersand is used to delineate each parameter. Parameters can be listed in any order. If the parameter value contains a space, use %20 in place of the space. If the parameter value contains an ampersand, use %26 in place of the ampersand.

The following parameters are available for BusinessObjects Enterprise users to directly launch Planning web access options. Parameter Valid Values Required?

AO

Indicate an access option using one of the following codes:



Checkout - Web Checkout Forms - Web Forms Interactive - Web Interactive Pro - Professional Edition Reports - Web Reports

Required in all cases.

System

Indicate the system name as defined Required in all cases. in the Configuration Manager. Indicate the user name. The user must You must indicate either a tobe an imported user. ken or a User/Pwd/Authtype combination.

User

128

BusinessObjects Planning Guide to Integration with BusinessObjects XI

URL Syntax for Launching Planning Web Access Options URL syntax for direct launch

10

Parameter

Valid Values

Required?

Pwd

Indicate the users's password.

You must indicate either a token or a User/Pwd/Authtype combination.

AuthType

Indicate the BusinessObjects Enter- You must indicate either a toprise authentication type using one of ken or a User/Pwd/Authtype the following codes: combination.

secEnterprise secLDAP secWindowsNT secWinAD

Token

Indicate the BusinessObjects Enterprise logon token for the user.

You must indicate either a token or a User/Pwd/Authtype combination. Optional. If the data parameter is omitted, the indicated access option opens and the user selects a plan workbook or a report to open.

Data

To open a specific plan workbook, indicate the dimension element code for the workbook. To open a specific report, indicate the path and name of the report, relative to the User Directory for the designated system. The report must be located in the Reports folder or a subfolder. Forward slashes must be used to delineate the path (for example: reports/incomestate ment.xls).

Type

If the access option is Pro and the data parameter is being used, indicate either Plan or Report to specify the type of workbook being launched.

This parameter is only used in conjunction with the optional data parameter, and only if the designated access option is the Professional Edition (Pro).

BusinessObjects Planning Guide to Integration with BusinessObjects XI

129

10

URL Syntax for Launching Planning Web Access Options URL syntax for direct launch

130

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Index
A
access restrictions 120 disabling 123 how data filters are applied as 121 modifying 123 syntax of converted data filters 121 Active Directory integration, interaction with BusinessObjects integration 19 adding classes to a universe 99 grouping columns to time dimensions 59 measures 71 time dimensions 58 time pivots 67 universes 96 aliases, logging in by using 40 Application Server settings 19 authentication BusinessObjects Enterprise user integration 40 using URL syntax for web access objects 126 authtype parameter 127 Automate Security 97 automated security for universes 118 access restrictions 120 BusinessObjects Enterprise logon token using to access Planning web access options 126 BusinessObjects Enterprise user integration 26 about 14 authentication of imported users 40 benefits of 15 configuring 30 features 23 importing users and groups 35 BusinessObjects integration 26 about 14 enabling 19 requirements and prerequisites 17 scope of integration 14 settings 20 BusinessObjects User Import (dialog) 30

C
classes adding to a universe 99 BusinessObjects Planning classes, reference information 81 deleting from a universe 103 editing the objects in 101 managing in universes 99 native fact classes 81 time dimension classes 86 time pivot classes 83 validated dimension classes 84 CMS 16, 94 location of Planning-generated universes in 105 CMS access account 18, 20

B
BusinessObjects Enterprise authentication types 40 using in Planning web URL syntax 127

BusinessObjects Planning Guide to Integration with BusinessObjects XI

131

Index

CMS Authentication Type 20 CMS Hostname 20 CMS Password 20 CMS Port 20 CMS Username 20 column-based time 48 Configuration Manager 19 consulting services 11 CUID 27

E
editing measures 72 time pivots 69 universe settings 96 enabling BusinessObjects integration 19 Export Configuration 34 Export Groups / Users 34 exporting user import settings 34

D
data filters about 120 considerations for users imported from BusinessObjects Enterprise 39 universes, updating for changed filters 123 data sources how data sources are converted to classes and objects 81 Data Structures naming conventions 76 definitions of universe and BusinessObjects Planning terms 78 deleting classes from a universe 103 grouping columns from time dimensions 60 measures 73 time dimensions 59 time pivots 70 universes 98 Designer, using to modify Planning-generated universes 106, 107 dimension objects including or excluding in a class 101 dimensions conversion to classes and objects 84 naming conventions 76 documentation 11

G
grouping columns adding to time dimensions 59 deleting from time dimensions 60 groups imported groups, definition 26 parent groups and subgroups, handling during import 28

H
hierarchies defining for time dimensions 61 including in universes 90 modifying in Designer 92

I
imported users authenticating 40 converting an imported user to a BusinessObjects Planning user 26 definition 26 security rights 39 importing time dimension values 61

132

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Index

importing users and groups from BusinessObjects Enterprise 26, 35 using Scheduler 35 Include All Class Objects 99 Include All Classes 97 information resources 11 Integration enabled (BusinessObjects) 20 intended audience 10

L
logined.aspx 40 loginsa.aspx 40 logon token using to access Planning web access options 126 loops in Planning universes 105

objects (continued) selecting the objects included in a class 101 obsolete elements how some universe elements become obsolete 113 removing from universes 107 viewing 104 obsolete users 36 other columns including in a time pivot 74 naming conventions 76

P
parent groups 28 Pivot Targeting Dimensions 67 Planning No Access group 36 prerequisites 17 Primary Authentication System 23, 27

M
Manual Objects 104 measure objects including or excluding in a class 101 measures adding 71 defining the time series in 73 deleting 73 editing 72

R
refreshing time pivots 116 impacts on Data Structures update 75 manually 116 scheduling refreshes 117 repository, location of Planning-generated universes in 105 required versions 17 Revert 94 rollups including in universes 90 row-based time about 49 how it is created in Planning universes 51

N
naming conventions Data Structures 76 narrow table layout 49 native fact classes 81

O
objects BusinessObjects Planning objects 81 required objects and optional objects 101

S
scheduling time pivot refresh 117 user import 35

BusinessObjects Planning Guide to Integration with BusinessObjects XI

133

Index

security integration, interaction with BusinessObjects integration 19 single sign-on 40 software prerequisites 17 Storage Type 67 storage types 69 considerations for selecting a storage type 66 refresh requirements 116 subgroups 28 support 11 systems relationship to security 27

T
Table 67 technical requirements 17 terminology assumptions 10 comparing universe and BusinessObjects Planning terminology 78 data structures 79 universe 78 time dimension classes 86 time dimensions 56, 58 accessing the Time Dimensions pane 56 adding 58 deleting 59 example case 51 grouping columns, defining for 59 hierarchies, defining for 61 how time dimensions are converted to classes and objects 86 key column 58 naming conventions 76 structure 58 understanding the purpose of 51 values, defining for 61, 62 time pivot classes 83 Time Pivot Refresh 117

time pivots 56 accessing the Time Pivots pane 62 adding 67 data columns, defining for 71 deleting 70 editing 69 example case 51 how time pivots are converted to classes and objects 83 impacts on Data Structures update 75 measures, defining for 71 naming conventions 76 other columns, including in 74 pivoting target dimensions, considerations 69 refreshing 116 storage types, about 66 structure, about 64 understanding the purpose of 51 time series about 48 measures including in 73 removing from 74 naming conventions 76 time-varying data comparing column-based time and row-based time 48 example case of converting to row-based time 51 handling in Planning universes 48 reasons to adopt row-based time 50 Timeout in seconds of CMS requests 20 token parameter 126 training 11

U
universe creation about 15 benefits of 17

134

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Index

universe creation (continued) defining time dimensions and time pivots 56 defining universes 94 features 23 handling time in Planning universes 48 planning the universe 45 process overview 44 terminology 78 universe definitions 94 universe files 94 location in the repository 105 universes 107 adding 96 administering 112 automating security 118 classes adding 99 deleting 103 editing the objects in 101 managing 99 classes and objects for Planning universes 81 contents and settings of Planning-generated universes 105 defining 94 definition of 16 deleting 98 editing settings 96 hierarchies and rollups, including 90 how universe definitions respond to changes in BusinessObjects Planning 113 integrity check, running in Desinger 108 managing access to 118 modifying in Designer 106 obsolete elements 107 properties of Planning-generated universes 104 repository, placement in 105 settings defined in Planning 97 modifying in Designer 108

universes (continued) structure of Planning universes 78, 86 terminology 78 updating events that trigger automatic updates 112 manually 115 what occurs during an update 114 when to manually execute an update 115 user access managing automatically 118 managing manually 119 user rights 118 viewing manually managed elements 104 updating universes 112 URL syntax for web access options 126 user import 26, 35 authenticating imported users 40 configuring import settings 30 group assignments for imported users 39 groups, selecting for import 31 importing users and groups 35 obsolete users 36 parent groups and subgroups, handling 28 process overview 29 properties imported 27 rules applied during import 36 security rights for imported users 39 settings configuring 30 exporting 34 systems enabled for import enabling or disabling systems 33 impacts of disabling a system 34 target systems for import, selecting 32, 33 users converting an imported user to a BusinessObjects Planning user 26 imported users, definition 26 importing 26 obsolete users 36

BusinessObjects Planning Guide to Integration with BusinessObjects XI

135

Index

users (continued) universes, controlling rights to 118

version requirements 17 View 67

V
validated dimension classes 84

W
wide table layout 48

136

BusinessObjects Planning Guide to Integration with BusinessObjects XI

Вам также может понравиться