IBM Cognos TM1

Version 9.5.2

Contributor Administrator Guide

Product Information
This document applies to IBM Cognos TM1 Version 9.5.2 and may also apply to subsequent releases. To check for newer versions of this document, visit the IBM Cognos Information Centers (http://publib.boulder.ibm.com/infocenter/cogic/v1r0m0/index.jsp).

Copyright
Licensed Materials - Property of IBM Copyright IBM Corp. 2009, 2011. US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. IBM, the IBM logo, ibm.com, TM1, and Cognos are trademarks or registered trademarks of International Business Machines Corp., in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at www.ibm.com/legal/copytrade.shtml. Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both. Microsoft product screen shot(s) used with permission from Microsoft.

Table of Contents
Introduction

5 7

Chapter 1: Using IBM Cognos TM1 Contributor Administration Chapter 2: Creating and managing planning applications

Logging on to IBM Cognos TM1 Contributor 9 Opening the TM1 Contributor Administration window 10 Creating a new application 10 Defining views 11 Setting an approval hierarchy 11 Setting application properties 13 Validating an application 15 Deploying an application 16 Activating or deactivating a TM1 Contributor application 16 Resetting an application 16 Importing and exporting applications 17 Exporting an application 17 Importing an application 17 Chapter 3: Managing rights for TM1 Contributor applications

19

Understanding and assigning rights that support Multi-Node Editing 19 Assigning rights for approvers 20 Assigning rights for non-approvers 20 Cascading Rights Assignments for Consolidated and Descendant Nodes 21 How Workflow Order and States apply to Consolidated and Leaf Nodes 21 How users open and access multiple nodes 22 How users take ownership of multiple nodes 22 Understanding Multi-Node Edit in the Workflow Page 23 Understanding Multi-Node Edit in the Grid Window 23 Taking ownership of nodes away from other users 23 How users submit data for multiple nodes 24 Sandbox behavior when working with multiple consolidated and leaf nodes 24 Opening the Manage Rights window 24 Assigning rights in the Manage Rights window 25 Modifying TM1 Contributor rights 28 Changing Right, Review Depth, or View Depth settings 28 Deleting rights from an application 28 Exporting rights definitions 28 Importing rights definitions 29 Chapter 4: Configuring TM1 Contributor

31

Configuring the TM1 Contributor service 31 TM1 Contributor service configuration 31 Configuring integration with Cognos Business Intelligence 31

Licensed Materials Property of IBM Copyright IBM Corp. 2009, 2011.

Table of Contents Index

33

4 IBM Cognos TM1

Introduction
This document is intended for use with IBM Cognos TM1. This manual describes how to configure and administer TM1 Contributor. Business Performance Management is the continuous management and monitoring of Financial, Operational, Customer and Organizational performance across the enterprise. Business Performance Management solutions have the following capabilities to facilitate the proactive steering of business direction: Wide deployment Collaborative decision making Continuous and real-time review and refinement Monitoring of Key Performance Indicators

IBM Cognos TM1 integrates business planning, performance measurement and operational data to enable companies to optimize business effectiveness and customer interaction regardless of geography or structure. TM1 provides immediate visibility into data, accountability within a collaborative process and a consistent view of information, allowing managers to quickly stabilize operational fluctuations and take advantage of new opportunities.

Audience
To use this guide, you should be a programmer or developer familiar with the concepts of TM1 and have a strong programming background.

Finding information
To find IBM Cognos product documentation on the web, including all translated documentation, access one of the IBM Cognos Information Centers at http://publib.boulder.ibm.com/infocenter/ cogic/v1r0m0/index.jsp. Updates to Release Notes are published directly to Information Centers. You can also read PDF versions of the product release notes and installation guides directly from IBM Cognos product disks.

Samples disclaimer
The Great Outdoors Company, GO Sales, any variation of the Great Outdoors name, and Planning Sample depict fictitious business operations with sample data used to develop sample applications for IBM and IBM customers. These fictitious records include sample data for sales transactions, product distribution, finance, and human resources. Any resemblance to actual names, addresses, contact numbers, or transaction values is coincidental. Other sample files may contain fictional data manually or machine generated, factual data compiled from academic or public sources, or data used with permission of the copyright holder, for use as sample data to develop sample applications. Product names referenced may be the trademarks of their respective owners. Unauthorized duplication is prohibited. Licensed Materials Property of IBM Copyright IBM Corp. 2009, 2011.

Introduction

Accessibility features
This product does not currently support accessibility features that help users with a physical disability, such as restricted mobility or limited vision, to use this product.

Forward-looking statements
This documentation describes the current functionality of the product. References to items that are not currently available may be included. No implication of any future availability should be inferred. Any such references are not a commitment, promise, or legal obligation to deliver any material, code, or functionality. The development, release, and timing of features or functionality remain at the sole discretion of IBM.

6 IBM Cognos TM1

Chapter 1: Using IBM Cognos TM1 Contributor Administration

IBM Cognos TM1 Contributor combines the power of TM1 with the rich features of Cognos Planning in a web-based client application. The IBM Cognos TM1 Administrator Guide describes the steps needed to configure and administer the Contributor component: Configuration Describes the configuration settings that can be made in Contributor to define server name, admin_host name, client URL as well as SSL and configuration settings needed for Cognos 8 integration. Applications Describes how to use the Administration and Modeling tool to design a TM1 cube and build an application off of it to be used by Contributor. The Administrators Portal and Workflow pages are described here as well. Security Describes how to define groups and assign the scope of actions each user group can take within an application.

Licensed Materials Property of IBM Copyright IBM Corp. 2009, 2011.

Chapter 1: Using IBM Cognos TM1 Contributor Administration

8 IBM Cognos TM1

Chapter 2: Creating and managing planning applications

To build a planning application, you start with a TM1 cube. The TM1 Contributor Administration tool guides you through the process of defining the data, groups, and roles each member of the planning workflow needs to contribute to their financial objects.

Logging on to IBM Cognos TM1 Contributor

The first time you log on to TM1 Contributor, you must specify several configuration parameters for your specific implementation. Once these parameters are set, subsequent logon attempts require you to provide only a valid username and password for the TM1 server on which your Contributor planning application resides.

Steps
1. In a web browser, enter the URL for your Contributor installation, typically http://<server_ name>:port_#/pmpsvc. 2. Enter the name of the computer on which your Admin Server is running in the Admin Host box. 3. The Server Name menu lists all of the TM1 servers registered on the Admin Server. Select the server you want to use for your Contributor planning application. 4. In the Web Client URL box, enter the full URL for the contributor.aspx file. Typically, this will be http://<web_server_name>:port_#/TM1Web/contributor.aspx. 5. Click OK. The Contributor Log On screen appears. 6. Enter your user name in the User ID box. To create and manage Contributor planning applications, the user name you enter must be a member of the ADMIN group on the TM1 server. If you want to create and manage applications across multiple TM1 servers, you must use the same administrative user name and password on all servers. 7. Enter your password in the Password box. 8. Click OK. The Contributor Portal opens.

Licensed Materials Property of IBM Copyright IBM Corp. 2009, 2011.

Chapter 2: Creating and managing planning applications

Opening the TM1 Contributor Administration window

Click the Design an Application button Administration window. The Contributor Administration window lets you define the views to be included in your Contributor application and set an approval hierarchy that defines the workflow of your application. You can also view and set properties for your application, for the views in the application, and for the application approval hierarchy. The Contributor Administration window includes a Guidance tool that displays a visual representation of the application creation process. The Guidance tool shows the four major steps in creating a Contributor application: Defining views Defining an approval hierarchy Deploying the application Defining security on the Contributor Portal to open the TM1 Contributor

Each major step in the Guidance tool includes a button that you can click to orient yourself to the correct location on the Contributor Administration window to complete the step. At any time during the creation process, you can click the Guidance button tool. to reveal the Guidance

Creating a new application

Follow these steps to create a new Contributor application.

Steps
1. On the Contributor Administration window, click File > New. The New Planning Application dialog box opens. 2. Enter the name of your Contributor application in the Application name box. 3. Select the TM1 server with which you want to associate the application from the Server name list. A Contributor application can be associated with a single TM1 server. 4. Click OK.

10 IBM Cognos TM1

Chapter 2: Creating and managing planning applications

Defining views
The views used in your Contributor application must exist on your TM1 server before you attempt to create an application. For details on creating cubes and views, please refer to the IBM Cognos TM1 Developer Guide.

Steps
1. In the Design pane of the Contributor Administration window, expand the Views folder to reveal the Drop TM1 Views Here region. 2. In the Objects pane of the Contributor Administration window, expand the Cubes folder. 3. Click the cube containing the view you want to add to your application. 4. Expand the Views folder beneath the cube. 5. Click the view you want to add to your application. You can CTRL-click to select multiple non-adjacent views, or SHIFT-click to select multiple adjacent views. 6. Drag the view(s) from the TM1 Objects pane and drop on the Drop TM1 Views Here region in the Design pane. 7. Repeat steps 3 through 6 for all views you want to add to your application.

Setting view properties

You can set two properties for a view: Help Text and Tab Name. Help Text is text that appears when a user clicks the View > Help option when working with a view in the Contributor client. Use this property to display instructions or information that assists users in entering data in the view. The help text you enter is also available in the workflow page. Tab Name is the name displayed on the view tab in the Contributor client. Modify this property if you want the tab to display something other than the view name.

Steps
1. Click the view in the Design pane of the Contributor Administration window. 2. In the Properties pane, enter a value for an editable property.

Setting an approval hierarchy

An approval hierarchy is a dimension subset that exists on your TM1 server. It is a representation of the approval/reporting structure of your business, department, or enterprise. Each element in the subset is referred to as a "node" in the approval hierarchy. The approval hierarchy determines the workflow of your Contributor application. As work is completed on leaf nodes in the approval hierarchy, the workflow logic that is part of Contributor guides submissions upward through the approval hierarchy, until the top node is reached. At each step in the ascension through the approval hierarchy, users can selectively edit, review, or submit views in the application, contingent upon access rights. Contributor Administrator Guide 11

Chapter 2: Creating and managing planning applications

Planning for Multi-Node Editing when setting an approval hierarchy

Multi-Node Editing helps simplify the data editing and submitting process of the workflow in your Contributor application. If you assign the appropriate nodes and rights to users, they can take ownership, and edit and submit data for a consolidated node and all descendant nodes from within the same grid window without having to open separate grid windows for each individual node. For more details, see "Understanding and assigning rights that support Multi-Node Editing" (p. 19).

Approval hierarchy requirements and limitations

Be aware of the following issues regarding approval hierarchies. An approval hierarchy can be used only once on a given TM1 server. Once an approval hierarchy is assigned to a Contributor application, it cannot be used for any other Contributor application on the same TM1 server. At least one view in your Contributor application must include the dimension that contains your approval hierarchy subset. The subset for your approval hierarchy must contain a single top level element. If you attempt to use a subset that contains multiple top level elements as an approval hierarchy you will receive an error. All members in the subset used for your approval hierarchy must have only a single immediate parent. The subset used for your approval hierarchy cannot contain any string elements. Once a subset is designated as an approval hierarchy, all security for the parent dimension of the subset is controlled by TM1 Contributor.

Defining the approval hierarchy

Follow these steps to define the approval hierarchy for your Contributor application.

Steps
1. In the Design pane of the Contributor Administration window, expand the Approval folder to reveal the Drop Approval Subset Here region. 2. In the Objects pane of the Contributor Administration window, expand the Dimensions folder. 3. Click the dimension containing the subset you want to use as your approval hierarchy. 4. Expand the Subsets folder beneath the cube. 5. Click the subset you want to use as your approval hierarchy. 6. Drag the subset from the Objects pane and drop on the Drop Approval Subset Here region in the Design pane.

12 IBM Cognos TM1

Chapter 2: Creating and managing planning applications

Setting application properties

You can set several properties that determine the appearance and behavior of your Contributor application.

Setting properties in the Contributor Administration window

Follow these steps to set properties in the Contributor Administration window.

Steps
1. In the Design pane of the Contributor Administration window, click the application name. The Properties pane displays the properties of the current application. Editable properties appear with a white background. Non-editable properties appear with a shaded background. 2. For each property you want to modify, enter or select a new value in the Property column. The following table describes all application properties that can be set in the Contributor Administration window.

Property Name
Application Name

Description
The name of your application. This is the name that identifies the application in the Contributor Portal and other locations.

Values
You can assign any name to your application, but there is a 128 character limit for application names, inclusive of the full file path used when saving the application.

Enable Charting

This property determines Yes - Charting is enable in whether charting capabilities the Contributor client. are available in the ContribuNo - Charting is disabled in tor client. the Contributor client. Yes - Users can create multiple sandboxes in the Contributor client. No - Users are restricted to a single sandbox in the Contributor client.

Enable Multiple Sandbox- This property determines whether users can create ing multiple sandboxes in the Contributor client.

Enable Slicing Export

This property determines if Yes - Users can export views users can export (slice) views from the Contributor client from the Contributor client to Excel. to Excel. No - Exporting views is disabled in the Contributor client.

Contributor Administrator Guide 13

Chapter 2: Creating and managing planning applications

Property Name
Enable Subset Editor

Description
This property determines if the Subset Editor is available to modify subsets in the Contributor client.

Values
Yes - Users can open the Subset Editor and modify subsets in the Contributor client. No - Users cannot modify subsets in the Contributor client.

Help Text

This property sets the User Enter text that will instruct Instructions text that appears users on using your Contribwhen users access the applica- utor application. tion through the Contributor Portal. This property determines Web Client is the only valid which clients are available to choice for this parameter. Contributor users.

Select Clients

Setting properties in the Contributor Portal

Follow these steps to set properties in the Contributor Portal.

Steps
1. Open the Contributor Portal. 2. Click the Properties button to open the Set Properties window.

3. Set properties as described in the following table.

Property Name
4. Workflow Settings

Description

Settings

Workflow page refresh rate The interval, in minutes, at Enter the number of minwhich the workflow page utes for the refresh interval. The default interval is is refreshed. five minutes. Application Text: Language The language in which your application runs. Select any of the available languages from the menu.

14 IBM Cognos TM1

Chapter 2: Creating and managing planning applications

Property Name
Name

Description
The name of your application. This is the name that identifies the application in the Contributor Portal and other locations. This property sets the User Instructions text that appears when users access the application through the Contributor Portal.

Settings
You can assign any name to your application, but there is a 200 character limit for application names. Enter text that will instruct users on using your Contributor application.

Help

Views Name This property sets the name that is displayed on the view tab in the Contributor client. This property sets the text that appears when a user clicks the Help button when working with a view in the Contributor client. Modify this property if you want the tab to display something other than the view name. Enter instructions or information that assists users in entering data in the view.

Help

5. Click OK.

Validating an application
When you validate an application, a validation process ensures that all conditions required to deliver the application are in place. Among other things, the validation process includes the following items. Review of approval hierarchy for correct structure. Check that all objects in the application definition are available on the TM1 server. Check that at least one view in your Contributor application includes the dimension that contains your approval hierarchy subset.

Step
Click the Validate button application. on the Contributor Administration window to validate your

Contributor Administrator Guide 15

Chapter 2: Creating and managing planning applications

Deploying an application
Deploying an application makes the application available in the Contributor Portal. However, after deploying the application you must define rights before other users can access and use the application. See "Managing rights for TM1 Contributor applications" for details on defining rights.

Step
1. Click the Deploy button tion. 2. Open the Server Explorer. 3. Click the TM1 server to which you have deployed the Contributor application. 4. Click Server > Save Data to save all application data to the server. on the Contributor Administration window to deploy your applica-

Activating or deactivating a TM1 Contributor application

When you initially deploy an application, it is inactive by default. This means the application must be activated before users can open it from the Contributor Portal. You can optionally deactivate an application, meaning it is not available to users from the Contributor Portal. Regardless of whether an application is activated or deactivated, all applications are visible to Contributor administrators in the Contributor Portal.

Steps
1. To activate an application, click the Activate Application button on the Contributor Portal. on the Contributor

2. To deactivate an application, click the Deactivate Application button Portal.

Resetting an application
After an application has been deployed, you can reset all nodes in the approval hierarchy to their original state. Resetting an application discards all progress made in the planning process, letting you begin the planning process anew. Note that resetting an application does not reset or discard any data changes.

Steps
1. Open the Contributor Portal. 2. Select the check box next your application name. 3. Click the Reset Application button .

4. Click OK when prompted to confirm the reset.

16 IBM Cognos TM1

Chapter 2: Creating and managing planning applications

Importing and exporting applications

Importing and exporting Contributor applications should be performed only when moving a Contributor application from a TM1 server that has a deployed application to a server that does not have that application or uses a different dimension for the approval hierarchy of said exported application.

Exporting an application
You can export a Contributor application. An exported application can be used as a template for a new application, or can be used as a backup of an existing application. When you export an application, Contributor creates a .zip archive containing several XML files that describe the structure and security of your application.

Steps
1. Open the Contributor Portal. 2. Click the Export Application button .

3. Click Save on the File Download dialog box. 4. Navigate to the directory where you want to save the export file. 5. Click Save.

Importing an application
Once an application has been exported, you can import it back into Contributor and use is as the basis for a new application.

Steps
1. Open the Contributor Portal. 2. Click the Import Application button .

The Application Import window opens. 3. Select the Server onto which you want to import the application. 4. Click Browse next to the Application file field. 5. Navigate to the application (.zip) file, then click Open. 6. Select the Import application security option if you want to import security settings with the application. Clear this option if you do not want to import security settings. 7. Select the Import application properties option if you want to import property settings with the application. Clear this option if you do not want to import property settings. 8. Click Import.

Contributor Administrator Guide 17

Chapter 2: Creating and managing planning applications

18 IBM Cognos TM1

Chapter 3: Managing rights for TM1 Contributor applications

After you create an IBM Cognos TM1 Contributor application, you must define rights for all user groups that you want to have access to the application. For each node in your approval hierarchy, rights are assigned to the user groups that exist on the TM1 server that hosts your Contributor application. The rights that you assign determine the actions that can be performed by members of the user groups. When you assign rights for a Contributor application, one new user group is created on the TM1 server for each node in your approval hierarchy. For example, if your approval hierarchy contains 80 nodes, 80 new user groups will be created on the TM1 server. If the number of nodes in your approval hierarchy is greater than the GroupsCreationLimit parameter value in the servers Tm1s.cfg file, rights assignment will fail and you will receive an error. If the GroupsCreationLimit parameter is not explicitly set in Tm1s.cfg, the default value is 20. To successfully assign rights for a Contributor application, the GroupsCreationLimit parameter for your TM1 server should be set to a value equal to or slightly greater than the number of nodes in your approval hierarchy before you begin assigning rights for the application. After setting the GroupsCreationLimit parameter to the required value, you must restart the TM1 server before continuing with Contributor rights assignment. After defining rights and deploying the Contributor application, you should reset the GroupsCreationLimit parameter to the original or default value. It is not necessary to restart the TM1 server after resetting the GroupsCreationLimit parameter value, but you may be able to free some memory if you do so. The GroupsCreationLimit parameter, along with all other parameters in the TM1 servers Tm1s.cfg configuration file, is fully described in the IBM CognosTM1 Operations Guide.

Understanding and assigning rights that support Multi-Node Editing

This section describes the details about how users can work with multiple consolidated and leaf nodes in an application. Multi-Node Editing allows users to take ownership, edit data, and submit data for a consolidated node and related leaf nodes in the approval hierarchy without having to separately open and work on the individual leaf nodes. This ability is available as of TM1 Contributor 9.5.2. TM1 Contributor versions 9.5 nd 9.5.1 did not allow multi-node editing and required users to individually open each node to take ownership, edit, and submit.

Deciding if you want to use Multi-Node Editing

The introduction of Multi-Node Edit feature has not changed the user interface or user interaction of the Managed Rights window. However, the rights you assign in this window will affect how users can take advantage of Multi-Node Edit. Licensed Materials Property of IBM Copyright IBM Corp. 2009, 2011. 19

Chapter 3: Managing rights for TM1 Contributor applications If you want users of an application to take advantage of Multi-Node Editing, you must take this into consideration when assigning rights for the approval hierarchy and users in your application. Review the topics in this section to better understand Multi-Node Editing.

Assigning rights for approvers

In a typical application, approvers will be assigned Review or Submit access rights at consolidation nodes in the approval hierarchy. As an application designer, you just need to consider the following additional questions: Does the approver need to see all levels below the designated consolidation? If so, you can control how many hierarchy levels that the user sees by using the Review and View depth options in the Managed Rights window. Does the approver need to edit leaf nodes or just submit or reject them? If so, you can allow approvers to edit leaf nodes by enabling the Allow Reviewer Edit checkbox in the Managed Rights window.

Assigning rights for non-approvers

In order to provide a non-approver user (contributor) the ability to perform multi-node editing, you must assign them at least View rights to the consolidated node. Assigning View rights at the consolidated node is the minimum rights necessary for Multi-Node Edit capabilities. This minimum rights assignment makes the consolidation node into a "starting point" from which the user can access, edit and submit all descendant nodes to which they have the appropriate rights. Note: Users must take ownership at the consolidated node in order to use the Multi-Node Edit ability, allowing them to work with the related leaf nodes all at the same time. As an application designer, consider the following questions when assigning rights to non-approver users: Does the non-approver require the ability to update more than one node at a time? Do they need to use Multi-Node Edit? If no (Multi-Node Edit is not required) then you can simply assign Edit or Submit rights to individual leaf nodes for the non-approver. If yes, then you need to ask: Will the non-approving user have Submit rights to all nodes reporting to a parent consolidated node? If yes, then determine if the non-approving user will be responsible for submitting the consolidated node or if another user will be submitting the consolidated node. If the non-approver will be submitting the consolidation node, then assigning Submit rights to the non-approver at the consolidation is appropriate. If another user will be submitting the consolidation node, then assigning Review rights to the non-approver at the consolidation node is appropriate. If no (the non-approving user doesn't have Submit rights to all children nodes) then assign View rights to the consolidation, and follow up with assigning Submit rights to the designated child nodes.

20 IBM Cognos TM1

Chapter 3: Managing rights for TM1 Contributor applications

Cascading Rights Assignments for Consolidated and Descendant Nodes

When you assign rights for a consolidated node, those rights are also "cascaded" or applied to all the descendant nodes of that consolidated node. Descendant nodes include both consolidated and leaf nodes under the initial consolidated node. Cascading rights assignments have the following behavior depending on the which access right you apply to the initial consolidated node: View rights assigned at a consolidated node will also be assigned to all descendent nodes. Review rights assigned at a consolidated node will set View rights to that consolidation and Submit rights to all descendants. Submit rights assigned at a consolidated node will set Submit rights to that consolidation and Submit rights to all descendants.

Exceptions for Cascading Rights

The Allow Reviewer Edit checkbox and the Review and View depth options in the Managed Rights window can override the cascading of Review and Submit rights on a consolidated node as follows: When the Allow Reviewer Edit checkbox is not selected, the application will essentially assign View access rights where Submit or Edit rights would have existed. When you set a number (n) for the Review and View depth options, the application will not display nodes below n-levels down from the initial node. You can use these options as a way to keep lower level nodes from appearing for higher level managers that just want to focus on higher consolidation levels.

How Workflow Order and States apply to Consolidated and Leaf Nodes
Workflow states are automatically assigned to nodes as users of your application work with the nodes. The following table summarizes the possible workflow states for consolidated and leaf nodes. The table is also organized to show the typical workflow order of how the states change. Note that child nodes of a consolidated node can be either leaf nodes or other consolidated nodes under the same consolidation.

Icon

Workflow State
Available

Applies to Consolidated Node? Applies to Leaf Node?

Initial state for a consolidated node. Initial state for a leaf node.

Incomplete

Some child nodes under the consol- N/A idated node have been reserved, but not all. N/A Ownership has been taken.

Reserved

Contributor Administrator Guide 21

Chapter 3: Managing rights for TM1 Contributor applications

Icon

Workflow State
Work in progress

Applies to Consolidated Node? Applies to Leaf Node?

All child nodes under the consoli- N/A dated node have been reserved. All child nodes under the consoli- N/A dated node have been submitted. The consolidated node has been submitted. The leaf node has been submitted.

Ready

Locked

How users open and access multiple nodes

Opening a node is the first step in working with a node. Users open a node by clicking on it in the workflow page and then the data for that node displays in the grid window. Users can open any node from the workflow page and view the related data in the grid window as long as they have View or higher rights for that node. If you assign the appropriate nodes and rights to a user, they will be able to take ownership, and edit and submit data for a consolidated node and all descendant nodes from within the same grid window without having to open separate windows for each individual node.

How users take ownership of multiple nodes

Users take ownership of a node by first opening the node from the workflow page and then clicking the Take ownership button in the toolbar of the grid window. A user cannot edit data in the grid window for a node until they take ownership of that node. Users with View or greater rights to a consolidated node can choose to take ownership for either a consolidated node or individual leaf nodes in the approval hierarchy. When a user takes ownership of a consolidated node, they are automatically given ownership to the underlying leaf nodes for which they have the appropriate rights. When a user takes ownership of individual leaf nodes under a consolidation, they will have to work with each node separately and wont be able to take advantage of the multiple editing and submitting ability of Multi-Node Edit.

Ascendant and descendant ownership

You can take ownership at a child node, and then later take ownership for its parent or grandparent node (or any ascendant). However, once you have ownership of an ascendant node, you cannot subsequently take ownership for a descendant node. When you transition your ownership up the approval hierarchy tree, content from all applicable Personal Workspaces and all named sandboxes of applicable descendent nodes will be merged and appear in the ascendant's node. For details, see "Sandbox behavior when working with multiple consolidated and leaf nodes" (p. 24)

22 IBM Cognos TM1

Chapter 3: Managing rights for TM1 Contributor applications

Understanding Multi-Node Edit in the Workflow Page

As of TM1 Contributor 9.5.2, the workflow page shows a simplified display of only one workflow tree representing all consolidated and leaf nodes that are accessible by the current user. Previous versions of TM1 Contributor had displayed two trees, one labeled Contributions and another labeled Reviews, depending on the tasks for the current user. As of TM1 Contributor 9.5.2, the following workflow states have been renamed: "Not started" was renamed to "Available" "Work in progress" was renamed to "Reserved" for leaf nodes only. The Work in progress state is now only used for consolidated nodes.

Understanding Multi-Node Edit in the Grid Window

As of TM1 Contributor 9.5.2, the data grid window has the following behavior that supports MultiNode Edit. Multi-Node Edit enables the Take Ownership button when a consolidated node is opened and the user has the appropriate rights. The data grid displays a drop-down list for the approval dimension so users can access the approval hierarchy directly in the grid window after taking ownership of a consolidated node. A data spread on a consolidated cell at the consolidated node level now applies the new values to the underlying leaf nodes, based on a users rights, without having to separately open and edit each leaf node. A new Submit Leaf Children button in the data grid toolbar submits data for all leaf nodes under a consolidated node. The data grid window has a new field called Current Ownership Node that displays information related to multi-node editing.

Taking ownership of nodes away from other users

Users with Submit or Edit access rights can take ownership of a node away ("bounce") from another user. However, the results depend on how the node was originally acquired by the first user, as described in the following scenarios. If you take ownership of leaf node "X" that another user had previously taken ownership of individually (not from a consolidated node), then that user will lose ownership of node "X" and it will transition to you. If you take ownership of node "X" that another user had previously acquired ownership of as part of a package from an ascendant node, you will bounce node "X" and all other nodes in that package that belonged to that user. If node "X" is a leaf node, you will acquire ownership of only that individual leaf node. All other nodes in the package that belonged to the previous user will be set to the Available state.

Contributor Administrator Guide 23

Chapter 3: Managing rights for TM1 Contributor applications If node "X" is a consolidated node, then you will acquire ownership of all the descendant nodes for which you have the appropriate rights. All other nodes in the consolidation that belonged to the previous user will be set to the Available state.

How users submit data for multiple nodes

Users can submit data for multiple nodes as follows: To submit all leaf nodes under a consolidated node, click the Submit leaf children icon in the toolbar of the grid window. Note: This action submits only the leaf nodes to which the user has the appropriate rights. To submit all leaf nodes and a consolidated node requires two separate steps. First, click the Submit leaf children icon in the toolbar of the grid window, and then click the Submit icon.

Sandbox behavior when working with multiple consolidated and leaf nodes
When working with multiple nodes and then taking ownership of a consolidated node, you should understand the following behavior about how data is merged from your default work area and named sandboxes into the consolidated node. When you take ownership of an ascendant consolidated node after previously having ownership for descendent consolidated or leaf nodes the following actions take place: The data in your default work area (Personal Workspace) is merged to the default work area for the consolidated node. The data in any named sandboxes you have created is merged into new sandboxes with the same name in the consolidated node. Sandboxes that share the same name from the descendent nodes are merged together into a single sandbox with the same name in the consolidated node. Sandboxes with unique names are simply moved into the consolidated node. After the data for the named sandboxes has been merged to the consolidated node, the named sandboxes in the descendent nodes will be removed.

Opening the Manage Rights window

You manage Contributor rights in the Manage Rights window, which you can access from either the TM1 Contributor Administration window or TM1 Contributor Portal. The top portion of the Manage Rights window contains a grid displaying current rights assignments, while the bottom of the window contains several boxes that you use to assign rights.

24 IBM Cognos TM1

Chapter 3: Managing rights for TM1 Contributor applications

Steps
1. To open the Manage Rights window from the Contributor Administration window, click Define on the Guidance tool. 2. To open the Manage Rights window from the Contributor Portal, click the Manage Rights for Application button next to your application name.

Assigning rights in the Manage Rights window

Use the Manage Rights window to assign access rights for each node of the approval hierarchy in your application. You can assign rights for specific node and user group combinations. For information about assigning rights that allow users to work with multiple descendant nodes from within a consolidated node, see "Understanding and assigning rights that support Multi-Node Editing" (p. 19).

Using the Allow Reviewer Edit option

The Allow Reviewer Edit option is a checkbox available in the toolbar of the Manage Rights window. When this option is enabled, users with Review rights can take ownership of any child node that has not been submitted, and then edit values in those nodes and submit the nodes.

Node Access Rights

There are four access rights in TM1 Contributor: View, Edit, Submit, and Review. Rights display in hierarchical order regardless of the language setting. The rights that are available for selection vary depending upon whether you are working on a leaf node (a node with no children) or a consolidated node (a node with at least one child). The following table summarizes the available rights and how they are applied to consolidated and leaf nodes.

Contributor Administrator Guide 25

Chapter 3: Managing rights for TM1 Contributor applications

Icon

Access right
View

Description

Applicable to which nodes?

Users can view the node in Leaf nodes the Contributor application. Consolidated nodes Note: View rights assigned at a consolidated node are also applied to all descendant nodes.

Edit

Users can take ownership of Leaf nodes the node in the application and can edit values in the node. Users can take ownership of the node, edit values in the node, and submit the node for review. Users can also reject submissions from child nodes. Users can edit and submit their own nodes, and can also review and reject child nodes that have been submitted. Additionally, if the Allow Leaf nodes Consolidated nodes Note: Submit rights assigned at a consolidated node are also applied to all descendant nodes. Consolidated nodes Note: If you assign Review rights for a consolidated node, it will assign View rights to that consolidated node and Submit rights to all descendant nodes. However, if the Allow

Submit

Review

Reviewer Edit option is Reviewer Edit option is disabled, then enabled, users can take own- only View rights are applied to ership of any child node that descendant nodes. has not been submitted, and then edit values in those nodes and submit the nodes. Complete these steps to assign rights for each node in your approval hierarchy.

Steps to assign rights

1. Click the node for which you want to assign rights in the Select Node box. 2. Click the user group to whom you want to assign rights in the Select Group box. 3. In the Define Security box, select the right that you want to assign to the user group. 4. Select a Review Depth. The Review Depth option is enabled only when the Review or Submit right is selected. The Review Depth determines how many levels beneath the current node will inherit the selected

26 IBM Cognos TM1

Chapter 3: Managing rights for TM1 Contributor applications access right. If you want only the immediate children of the current node to inherit rights, select 1. If you want the two levels beneath the current node to inherit rights, select 2, and so on. Note: The Review Depth setting can never be greater than the View Depth setting. 5. Select a View Depth. The View Depth determines how many levels below the current node are visible to the user group. If you want members of the user group to be able to view only the current node and its immediate children, select 1. If you want members of the user group to be able to view only the current node and the next two levels of children, select 2, and so on. 6. Click Add. The rights you just defined are added to the grid at the top of the Manage Rights window. 7. Repeat steps 1 through 7 for each node and/or user group in your application. As you add rights to the nodes in an application, the Select Node box displays icons next to node names, indicating which rights have been assigned to each node.

Icon

Right
View Edit Submit Review

When you hover the pointer over a rights icon, a pop-up message shows which user groups have been assigned that right to the current node. In the following image, the BUDGET VIEWER and MARKETING user groups have been assigned the View right to the Germany node.

8. Click Save

to save the rights assignments for the application.

If the TM1 server is stopped after an application is created but before the application is saved, the security set is not saved. In this case the Contributor application information is still saved.

Contributor Administrator Guide 27

Chapter 3: Managing rights for TM1 Contributor applications

Modifying TM1 Contributor rights

After you have successfully created rights for your application, you can modify Right, Review Depth, and View Depth settings for any node/user group combination by making selections in the drop-down menus available in the grid at the top of the Manage Rights window. You can also delete rights.

Changing Right, Review Depth, or View Depth settings

Follow these steps to modify the Right, Review Depth, or View Depth setting for any node/user group.

Steps
1. Open the Manage Rights window. 2. Click the setting that you want to modify. When you click an editable setting, a drop-down menu is enabled. 3. Select a new setting value from the menu. 4. Click Save to save the modified rights assignments for the application.

Deleting rights from an application

Follow these steps to delete a rights assignment for any node/user group.

Steps
1. Open the Manage Rights window. 2. Click the rights assignment that you want to delete. To select multiple non-adjacent rights assignments, CTRL-click each assignment. To select multiple adjacent rights assignments, SHIFT-click the first and last assignment. 3. Click to delete the rights assignments from the application.

4. Click Yes when prompted to confirm the deletion. 5. Click Save to save the modified rights assignments for the application.

Exporting rights definitions

Once you have defined and saved rights for an application, you can export the rights definitions for later use in other applications.

Steps
1. Open the Manage Rights window. 2. Click Export .

28 IBM Cognos TM1

Chapter 3: Managing rights for TM1 Contributor applications The File Download dialog box opens. 3. Click Save. 4. Navigate to the directory where you want to save the rights definitions. 5. Enter a name for the rights file. The file must use the .txt extension. 6. Click Save.

Importing rights definitions

If a rights definition file exists and is applicable to the approval hierarchy of your application, you can import the rights file to set rights for your application.

Steps
1. Open the Manage Rights window. 2. Click Import .

The Import Rights dialog box opens. 3. Click Browse. 4. Navigate to the directory containing the rights definition file. 5. Click the rights definition file, then click Open. 6. Click Import. TM1 Contributor imports and validates the rights. 7. If your application has some existing rights defined, you are prompted to specify how the imported rights should be handled. Click Yes to merge the imported rights with any existing rights. Click No to discard any existing rights and replace them with the imported rights. 8. Click Save to save the imported rights assignments for the application.

Contributor Administrator Guide 29

Chapter 3: Managing rights for TM1 Contributor applications

30 IBM Cognos TM1

Chapter 4: Configuring TM1 Contributor

This section describes various configuration settings that an administrator can make to the Contributor service and how to achieve integration with IBM Cognos Business Intelligence (BI).

Configuring the TM1 Contributor service

Administrators can configure the following aspects of IBM Cognos TM1 Contributor: "TM1 Contributor service configuration" (p. 31) "Configuring integration with Cognos Business Intelligence" (p. 31)

TM1 Contributor service configuration

The pmpsvc.config.xml file is found in the following location:
C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps\pmpsvc\WEB-INF\ configuration\pmpsvc.config.xml

This configuration file determines, among other things, the: Admin Host Server Name TM1 Web Client URL

These values are set the first time TM1 Contributor is launched. There are several other parameters that can be configured for your Contributor service. All parameters are documented in the pmpsvc_config.xsd file, which can be found in the same directory as the pmpsvc.config.xml file.

Configuring integration with Cognos Business Intelligence

TM1 Contributor can integrate with IBM Cognos Business Intelligence (BI) v8.4 by: Using a single-sign on (CAM) Leveraging the Apache Tomcat instance with Cognos BI Placing application hyperlinks in public folders

The integration allows organizations that have Cognos BI to perform a basic integration of Contributor for their user community. To enable integration: 1. Setup CAM integration between TM1 and Cognos BI 2. Deploy the following files: Licensed Materials Property of IBM Copyright IBM Corp. 2009, 2011.

31

Chapter 4: Configuring TM1 Contributor

Copy from TM1 Install Dir

\Cadmin\pmpsvc.war \Cadmin\gateway\planning.html \Cadmin\gateway\variables_plan.html \Cadmin\gateway\icon_active_ application.gif

To C8 Install Dir
\webapps \webcontent \templates\ps\portal \webcontent\ps\portal\images

3. Start or Re-Start C8 Now TM1 is ready to be used within the Cognos BI framework. While most users would just consume the content generated from deployed applications from Contributor, administrators must use a slightly different URL to create and maintain applications:
http://<c8 servername>:9300/pmpsvc

Note: Once you logout and try to log back on, the software will re-direct you to C8 and not port :9300. To gain access to the administrative role, the administrator must use the :9300 URL. When an application is deployed, the following objects get generated: A folder in Public Folders identifying the IBM Cognos Planning Applications. A URL link to the application that is deployed. This URL can be re-used to be embedded in an IFRAME or a Portlet. Note: When embedding the workflow page in an IFRAM or Portlet, if no action is taken to disable it, the header of the workflow page will have two headers within C8. To disable the banner you can add the following parameter to the URL: &banner=0 Any application maintenance such as activating, deactivating or deleting an application is synchronized within only the folder generated by Contributor. Any other created or copied URL reference will not be synchronized.

32 IBM Cognos TM1

Index
A
activate application, 16 allow multi node views, 14 application activate, 16 create, 10 define view, 11 deploy, 16 export, 17 help, 14 import, 17 language, 14 name, 13, 14 properties, 13 reset, 16 validation, 15 approval hierarchy, 11 assigning rights, 25

H
help text, 13

I
import application, 17 import rights, 29

L
language application, 14 logon configuration, 9

M
managing rights, 24 modifying rights, 28 Multi-Node Edit cascading rights, 21 in the grid window, 23 in the workflow page, 23 opening multiple nodes, 22 overview, 19 ownership of multiple nodes, 22 rights for approvers, 20 rights for non-approvers, 20 submitting multiple nodes, 24 taking ownership from other users, 23 with sandboxes, 24 workflow order and states, 21

C
client configuration, 31 Cognos BI, 31

D
deactivate application, 16 delete rights, 28 deploy application, 16 design an application, 11

P E
enable charting, 13 enable multiple sandboxing, 13 enable slicing export, 13 enable subset editor, 13 export application, 17 export rights, 28 password, 9 pmpsvc.config, 31 portal page, 10 portal properties, 14

R
reset application, 16 review depth, 25 rights, 19 modifying, 28

G
guidance tool, 10 Licensed Materials Property of IBM Copyright IBM Corp. 2009, 2011.

33

Index rights, for multi-node editing, 19

S
security, 19 set clients, 13

U
URL, 9 username, 9

V
validation application, 15 view for application, 11 help, 14 name, 14 properties, 11 view depth, 25

W
workflow page refresh rate, 14

34 IBM Cognos TM1