+ All Categories
Home > Documents > Tm1 Workflow Administrators Guide En

Tm1 Workflow Administrators Guide En

Date post: 27-Apr-2015
Category:
Upload: tkingcka
View: 696 times
Download: 4 times
Share this document with a friend
216
TM1 Workflow Administrator’s Guide
Transcript
Page 1: Tm1 Workflow Administrators Guide En

TM1 Workflow Administrator’s Guide

Page 2: Tm1 Workflow Administrators Guide En

Table of Contents | Index

Product Information

This document applies to IBM Cognos® TM1 9.4 and may also apply to subsequent releases. To check for newer versions of this document, visit the IBM Cognos Global Customer Services Web site (http://support.Cognos.com).

Copyright

Copyright © 2008 Cognos ULC (formerly Cognos Incorporated). Cognos ULC is an IBM Company. 

Portions of Cognos ULC software products are protected by one or more of the following U.S. Patents: 6,609,123 B1; 6,611,838 B1; 6,662,188 B1; 6,728,697 B2; 6,741,982 B2; 6,763,520 B1; 6,768,995 B2; 6,782,378 B2; 6,847,973 B2; 6,853,375 B2; 6,907,428 B2; 6,986,135 B2; 6,995,768 B2; 7,062,479 B2; 7,072,822 B2; 7,111,007 B2; 7,130,822 B1; 7,155,398 B2; 7,171,425 B2; 7,185,016 B1; 7,213,199 B2; 7,243,106 B2; 7,257,612 B2; 7,275,211 B2; 7,281,047 B2; 7,293,008 B2; 7,296 040 B2; 7,318,058 B2; 7,325,003 B2.

Cognos and the Cognos logo are trademarks of Cognos ULC (formerly Cognos Incorporated) in the United States and/or other countries. IBM and the IBM logo are trademarks of International Business Machines Corporation in the United States, or other countries, or both. Other company, product, or service names may be trademarks or service marks of others.

While every attempt has been made to ensure that the information in this document is accurate and complete, some typographical errors or technical inaccuracies may exist. Cognos does not accept responsibility for any kind of loss resulting from the use of information contained in this document. 

This document shows the publication date. The information contained in this document is subject to change without notice. Any improvements or changes to the information contained in this document will be documented in subsequent editions. 

U.S. Government Restricted Rights. The software and accompanying materials are provided with Restricted Rights. Use, duplication, disclosure by the Government is subject to the restrictions in subparagraph (C)(1)(ii) of the Rights in Technical Data and Computer clause at DFARS 252.227‐7013, or subparagraphs (C)(1) and (2) of the Commercial Computer Software ‐ Restricted Rights at 48CFR52.227‐ as applicable. The Contractor is Cognos Corporation, 15 Wayside Road, Burlington, MA 01803.

This document contains proprietary information of Cognos. All rights are reserved. No part of this document may be copied, photocopied, reproduced, stored in a retrieval system, transmitted in any form or by any means, or translated into another language without the prior written consent of Cognos.

Publication Date: July 2008

Page 3: Tm1 Workflow Administrators Guide En

Table of Contents | Index

Table of Contents

Chapter 1 Workflow Concepts and AdministrationWhat is Workflow?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐2Required Workflow Structures  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐3

Budget Version  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐3Task and Review Hierarchy  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐4Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐5Task and Review Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐9Budget Versions  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐10

Creating a New Budget Version  . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐11Step 1 ‐ Run the Version Wizard and Build the Task and Review Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐11Step 2 ‐ Assigning Budget Responsibility and Task Security. . 1‐20Step 3 ‐ Setting Task Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐22Step 4 ‐ Initializing Your Version . . . . . . . . . . . . . . . . . . . . . . . . . 1‐25Notifying Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐27

Workflow Messaging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐32Configuring Email for a Submit Action. . . . . . . . . . . . . . . . . . . . 1‐32Setting up Messages for a Task. . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐40Setting Up Email for Budget Participants . . . . . . . . . . . . . . . . . . 1‐44

Table of Contents 1

Page 4: Tm1 Workflow Administrators Guide En

Table of Contents | Index

Chapter 2 Security and NavigationNavigation Overview  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐1

Navigation with Named Ranges  . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐2Setting Up SUBNM Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐5

Adding SUBNM Navigation to a Task  . . . . . . . . . . . . . . . . . . . . 2‐12Editing a SUBNM Navigation Assignment  . . . . . . . . . . . . . . . . 2‐13Adding Worksheet Navigation to a Task . . . . . . . . . . . . . . . . . . 2‐13Editing a Workbook Navigation Assignment  . . . . . . . . . . . . . . 2‐18

Setting Up Named Range Navigation. . . . . . . . . . . . . . . . . . . . . . . . 2‐18Step 1 ‐ Set the Binding Address Template Field. . . . . . . . . . . . 2‐19Binding Address Template Field Modifiers . . . . . . . . . . . . . . . . 2‐22Step 2 ‐ Add a Named Range to Your Spreadsheet . . . . . . . . . . 2‐24Step 3 ‐ Change the DBRW Formulas in the Spreadsheet  . . . . 2‐25

Setting Up Security for Your Planning Worksheets  . . . . . . . . . . . . 2‐27When is Cell‐Level Security Applied?. . . . . . . . . . . . . . . . . . . . . 2‐28Modifying Workflow Security  . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐30

Chapter 3 Workflow Administration Console

TM1 Workflow Administration Console  . . . . . . . . . . . . . . . . . . . . . . 3‐2Adding a Task and Review Template . . . . . . . . . . . . . . . . . . . . . . 3‐3Assigning Budget Responsibility and Task Security. . . . . . . . . 3‐11

Adding a Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐17Adding a Version to a Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐23

2 TM1 Workflow Administrator’s Guide

Page 5: Tm1 Workflow Administrators Guide En

Table of Contents | Index

Building a Version From Another Version . . . . . . . . . . . . . . . . . 3‐24Building a Version From a Task and Review Template . . . . . . 3‐27

Chapter 4 Customizing WorkflowThe Workflow Application Environment. . . . . . . . . . . . . . . . . . . . . . 4‐2System Options and User Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐4

Default Values, Client Overrides and Customizations . . . . . . . . 4‐7Setting User Help Text in Workflow . . . . . . . . . . . . . . . . . . . . . . 4‐10Setting Admin Help Text in Workflow . . . . . . . . . . . . . . . . . . . . 4‐14

Task Actions  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐17Adding a Custom Task Action . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐17

Task Statuses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐25Task Status Properties  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐27

Version Statuses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐32Adding a Version Status  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐33

Task Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐38Design Time Attributes  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐38Run Time Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐40Attributes Added for Custom Actions  . . . . . . . . . . . . . . . . . . . . 4‐41

Chapter 5 Using the Workflow ToolbarLogging in to Workflow  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐2Choosing Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐3Choosing Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐4

Table of Contents 3

Page 6: Tm1 Workflow Administrators Guide En

Table of Contents | Index

Task Actions  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐6The All Tasks List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐7

Task Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐8Version Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐9Customize  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐11

TM1 Workflow Tab  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐12

Appendix A Workflow Execution StackCustomizing Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A‐2

Pre_TI Process Structure  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A‐4The Workflow Execution Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . .A‐6

Workflow Checks to See if You are Logged In. . . . . . . . . . . . . . .A‐6Workflow Determines The following information  . . . . . . . . . . .A‐6Workflow Checks the DisplayConfirmMessage setting for the Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A‐6Check to determine if a Pre‐TI Process is associated with the UserA‐6Execute the Pre‐Ti process or the Pre Action TI process. . . . . . .A‐7Collect Workflow Information . . . . . . . . . . . . . . . . . . . . . . . . . . . .A‐7Determine Whether the Task is a Completable or Delegated Task.A‐8Use the Workflow Matrix to Determine the New Task Status. .A‐8Set Task Attributes Based On the New Status . . . . . . . . . . . . . .A‐10Update the Workflow Toolbar Structures and Data . . . . . . . . .A‐10

4 TM1 Workflow Administrator’s Guide

Page 7: Tm1 Workflow Administrators Guide En

Table of Contents | Index

Check for a Post_TI Process  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A‐10Execute the Post‐Ti process or the Post Action TI process . . . .A‐11Process Email. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A‐11Reload Task Dropdown on the Workflow Toolbar . . . . . . . . . .A‐12

Appendix B Workflow ArchitectureCreating a Template ‐ Before Template Creation  . . . . . . . . . . . . . . . B‐2Creating a Template ‐ After Template Creation  . . . . . . . . . . . . . . . . B‐3Creating a Plan ‐ Before Plan Creation . . . . . . . . . . . . . . . . . . . . . . . . B‐4Creating a Plan ‐ Dimensions After Plan Creation . . . . . . . . . . . . . . B‐5Creating a Plan ‐ Cubes After Plan Creation . . . . . . . . . . . . . . . . . . . B‐6Creating a Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B‐7Creating a Task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B‐8Object Map  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B‐9Action Map  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B‐17

Table of Contents 5

Page 8: Tm1 Workflow Administrators Guide En

Table of Contents | Index

6 TM1 Workflow Administrator’s Guide

Page 9: Tm1 Workflow Administrators Guide En

Table of Contents | Index

Preface

Business Performance Management with IBM Cognos TM1Business 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.

About This ManualThe TM1 Workflow Administrator’s Guide guide describes how to install, configure and customize IBM Cognos TM1 Workflow. TM1 Workflow 

ix

Page 10: Tm1 Workflow Administrators Guide En

Table of Contents | Index

integrates with your TM1 budgeting and planning application, and allows you to establish a workflow structure, security, and other organizational structures.

AudienceThis guide is intended for TM1 server administrators and anyone developing planning and budgeting applications with TM1.

Related DocumentationThe following table lists other documentation in the TM1 Documentation Library. Only those documents that are pertinent to your user‐level are available. If a link is unavailable, you may receive a “This page cannot be found” message. If necessary you can access the document on the Cognos Global Customer Services Web site (http://support.cognos.com). Logon credentials are available from your administrator or by request from [email protected].

TM1 API Describes the functions and features of the IBM Cognos TM1 API. The API is intended to give complete access to all the features and functionality of the TM1 OLAP engine.

TM1 Developers Guide Describes how to create and maintain objects on a TM1 server, administer security, and develop TM1 applications.

x TM1 Workflow Administrator’s Guide

Page 11: Tm1 Workflow Administrators Guide En

Table of Contents | Index

TM1 Installation Describes how to install the IBM Cognos TM1 software components on Windows and UNIX operating systems.

TM1 Operations Guide Provides a basic understanding of TM1 architecture, server operations, authentication, and component security.

TM1 Reference Guide A collection of reference materials that describes TM1 functions, variables, and other programming elements.

TM1 Rules Guide Describes how to use TM1 rules to build an application that reveals business data in sophisticated and useful ways based on simple raw data.

TM1 TurboIntegrator Guide Describes how to use TM1 TurboIntegrator to import data and metadata into TM1 from a variety of sources.

Preface xi

Page 12: Tm1 Workflow Administrators Guide En

Table of Contents | Index

Conventions Used in This ManualThe following typeface conventions are used throughout this guide:

Finding InformationTo find the most current product documentation, including all localized documentation, access the IBM Cognos Global Customer Services Web site (http://support.cognos.com). Click the Documentation link to access documentation guides. Click the Knowledge Base link to access all documentation, technical papers, and multimedia materials. 

Arial Arial text indicates that this option or object appears as part of the user interface.File names and directories are also indicated by Arial text.

Arial Bold Bold Arial text indicates an option to choose or text to type. It usually appears in numbered steps.

Italics Words are italicized for emphasis or to draw your attention to a new term. For example, “Do not press the RETURN key.”

Menu Name → Option Name

Whenever you see a reference to a menu option, the option is identified using the following notation:Menu Name → Option NameFor example, “Choose File →Options.”

code examples Code examples are in courier.

xii TM1 Workflow Administrator’s Guide

Page 13: Tm1 Workflow Administrators Guide En

Table of Contents | Index

Product documentation is also available in online help from the Help menu or button in IBM Cognos products. You can also download documentation in PDF format from the IBM Cognos Global Customer Services Web site. 

Getting HelpFor more information about using IBM Cognos products or for technical assistance, visit the IBM Cognos Global Customer Services Web site (http://support.cognos.com). This site provides product information, services, user forums, and a knowledge base of documentation and multimedia materials. To log a Service Request, go to IBM Cognos Insight! at http://support.cognos.com/en/support/insight. For general inquiries, contact your local IBM Cognos Support office. Contact information can be found at http://support.cognos.com/en/support/about/contact.html. For information about education and training, click the Training link.

Printing Copyright MaterialsYou can print selected pages, a section, or the whole book. IBM Cognos grants you a non‐exclusive, non‐transferable license to use, copy, and reproduce the copyright materials, in printed or electronic format, solely for the purpose of operating, maintaining, and providing internal training on the Cognos software.

Preface xiii

Page 14: Tm1 Workflow Administrators Guide En

Table of Contents | Index

xiv TM1 Workflow Administrator’s Guide

Page 15: Tm1 Workflow Administrators Guide En

Table of Contents | Index

1 Workflow Concepts and Administration

This chapter provides some basic information about Workflow. It also describes how to create basic structures required by Workflow.

• What is Workflow?

• Required Workflow Structures

• Creating a New Budget Version

• Workflow Messaging

Workflow Concepts and Administration 1-1

Page 16: Tm1 Workflow Administrators Guide En

What is Workflow? Table of Contents | Index

What is Workflow?

Workflow works with your budgeting data to create an organized, systematic budget environment. It eases communication between people involved in the budgeting process. It allows you to track activities in your budget process to see if they are being completed on time. It assures that completed budgeting tasks are moved on to the proper people in your organization for approval or modification.

Workflow makes almost no modifications to your business data. This ‘light footprint’ approach means that you do not have to reconstruct your budgeting application in order to use Workflow. Your users can work with the same TM1‐based worksheets that they are familiar with. Workflow works largely by modifying its own data structures, leaving your data in its familiar form and format.

1-2 TM1 Workflow Administrator’s Guide

Page 17: Tm1 Workflow Administrators Guide En

Required Workflow Structures Table of Contents | Index

Required Workflow Structures

The following structures are required by Workflow:

• A version dimension ‐ Most budgeting systems built in TM1 have a dimension that lists budget versions. When you create a new version of a budget with Workflow, you add the name of that version as an element to this dimension.

• A Task and Review hierarchy ‐ Workflow helps you to build a hierarchy of budget participants and assign tasks to those participants.

• A set of worksheets for planning and budgeting ‐ Workflow includes a tool bar that installs into Microsoft Excel. This tool bar allows you to apply Workflow’s structure to your worksheets.

• Planning cubes ‐ These cubes are the TM1 structures that hold your planning data. Aside from adding elements to the version dimension in these cubes, Workflow makes no changes to your data.

Budget Version

A budget version is the top‐level object in any budgeting system. Before you can work on your budgeting for a given fiscal period, you must create a budget version.

You may create several budget version during a budgeting cycle. Having different version may allow you to perform budget planning for various business conditions. For example, you may have one budget version for Q4 2004 that assumes that Q3 sales were flat, while a second budget version for the same period assumes that sales were up in Q3.

Workflow includes a wizard that helps you to build a budget version.

Workflow Concepts and Administration 1-3

Page 18: Tm1 Workflow Administrators Guide En

Required Workflow Structures Table of Contents | Index

Task and Review Hierarchy

The Task and Review hierarchy is at the center of the Workflow system. A Task and Review hierarchy is a set of TM1 users to which tasks are assigned. This hierarchy mimics the flow of information through your organization during a typical budget process. Workflow helps you to build the Task and Review hierarchy, and integrate it with your planning data. 

There is a single Task and Review hierarchy associated with each budget version. To simplify the process of managing versions, hierarchies can be saved as templates and applied to multiple budget versions.

The Task and Review hierarchy is typically a subset of your organizational hierarchy. A budget process often incorporates a stripped‐down version of your organizational hierarchy, including only the members of your staff involved in generating quarterly or annual budgets. For example, budget numbers might be generated at the lowest levels of the hierarchy, then submitted to a manager. The manager adjusts the budget numbers received from his staff, and submits a consolidated budget to the vice president. The vice president presents numbers from all his departments to the CFO. This entire set of transactions might look like the following figure:

1-4 TM1 Workflow Administrator’s Guide

Page 19: Tm1 Workflow Administrators Guide En

Required Workflow Structures Table of Contents | Index

Tasks

Each member of the hierarchy is responsible for a set of tasks. In Workflow, tasks are jobs that are performed during any budget cycle. For example, each department in your company might enter payroll information for the budget period. In this case, entering payroll information is a planning task.

Different members of the Task and Review hierarchy are assigned different tasks. The Budget Specialist in the diagram above performs different tasks from the Vice President or the CFO. The following diagram expands the Task and Review hierarchy in the previous diagram to include a set of tasks for each group.

Workflow Concepts and Administration 1-5

Page 20: Tm1 Workflow Administrators Guide En

Required Workflow Structures Table of Contents | Index

1-6 TM1 Workflow Administrator’s Guide

Page 21: Tm1 Workflow Administrators Guide En

Required Workflow Structures Table of Contents | Index

Tasks have the following properties and characteristics:

• Tasks have an owner. The owner is a TM1 user. 

• There are two types of tasks. There are delegated tasks and simple tasks. Delegated tasks are passed down the hierarchy by a delegator. The person or group performing the task is called the owner of the task. When the owner of the task completes work on it, they submit the task back to the delegator.

For example, consider the following figure:

Workflow Concepts and Administration 1-7

Page 22: Tm1 Workflow Administrators Guide En

Required Workflow Structures Table of Contents | Index

In this figure, European Sales Budget is a delegated task. It was delegated by the Vice President of European Operations to the Director of European Sales.

In this example, The Director of European Sales is responsible for compiling her own budget. She has three simple tasks to complete: Payroll, Revenue, and Expenses. These are subtasks of the European Sales Budget task. When she completes a simple task, she 

1-8 TM1 Workflow Administrator’s Guide

Page 23: Tm1 Workflow Administrators Guide En

Required Workflow Structures Table of Contents | Index

marks it as complete.Once she completes these tasks, they roll up into the European Sales Budget task. When she has finished working on this task, she submits it to the Vice President of European Operations.

• Tasks have associated actions. For delegated tasks, you can submit or revoke. When you submit a task, you return it to the delegator. For simple tasks, you can complete or revoke. If you choose Revoke for any task, the task status is set to Not Started.

• Tasks have a status. For example, a task can be Not Started, Finished, or In Progress. You can add statuses to match your budget process. If you use cell security in your planning, cell security is set based on the current status of a given task.

• Tasks have attributes. Owner and Delegator are task attributes. For a complete list, see the Workflow control cube }sm_control_attribute_settings.

• Tasks have an assigned security group. Security for the task is built from this TM1 group. You must be sure that the task owner is a member of the security group. Otherwise, the owner will not be able to change the task’s data.

• Tasks have associated comments. You can configure Workflow to accept short written comments from budget participants.

Task and Review Templates

A Task and Review template is a hierarchical list of budget tasks and the TM1 groups to whom those tasks are assigned. Whenever you create a version with a new Task and Review structure, that structure is saved as a separate module called a template. You can also explicitly build a Task and Review template 

Workflow Concepts and Administration 1-9

Page 24: Tm1 Workflow Administrators Guide En

Required Workflow Structures Table of Contents | Index

through the Workflow wizard. You can reuse a Task and Review template when you build additional budget versions. 

Budget versions include a Task and Review hierarchy. When you build a budget version, you must choose one of the following options:

• Build a Task and Review hierarchy from scratch.

• Use a Task and Review hierarchy template.

• Copy an entire budget version, which includes a Task and Review hierarchy.

NOTE: When you create a Task and Review hierarchy template, you add an element to the }sm_templates dimension.

Budget Versions

A budget version includes all of the following components:

• A Task and Review structure. As mentioned above, this can be built when you create the version, copied from a Task and Review template, or it may be inherited from another version that you copied when you created this version.

• A set of statuses for each task.

• Runtime properties for each task, such as the date that the task was started, or the date it was completed.

• Notes. These are text description of work associated with a particular task. They can contain information about ongoing work, questions for specific people who are working on a budget task, or any other information budget participants want to provide.

1-10 TM1 Workflow Administrator’s Guide

Page 25: Tm1 Workflow Administrators Guide En

Creating a New Budget Version Table of Contents | Index

Creating a New Budget Version

The first step in configuring Workflow is to create a budget version. You must be a TM1 administrator to create a budget version. To create a budget version with Workflow, you must complete the following procedures:

• Step 1 ‐ Choose a version dimension and build the initial Task and Review structure.

• Step 2 ‐ Assign Budget Responsibility and Task Security.

• Step 3 ‐ Set Attributes for each task.

• Step 4 ‐ Initialize the budget version.

Step 1 - Run the Version Wizard and Build the Task and Review Structure

The version wizard runs automatically the first time you choose Admin from the Workflow menu. To get started creating your first budget version, follow these steps:

1. Run Microsoft Excel.

2. Choose TM1 → Server Explorer and log in to your Workflow database. Alternatively, you can click any Workflow toolbar button and enter your login information.

3. Choose TM1 → Workflow → Admin. 

The first time you run this option, the following dialog box appears:

Workflow Concepts and Administration 1-11

Page 26: Tm1 Workflow Administrators Guide En

Creating a New Budget Version Table of Contents | Index

Choose the dimension in your TM1 database where budget versions are stored. A version dimension is a required component of a Workflow system.

4. Click   and choose a dimension from the list.

1-12 TM1 Workflow Administrator’s Guide

Page 27: Tm1 Workflow Administrators Guide En

Creating a New Budget Version Table of Contents | Index

5. Enter the name of the new version in the Version Element ID field. An ele‐ment with this name is added to the version dimension you chose in step 4.

6. Enter an alias for the version name in the Element Alias field. 

The alias is optional. If you do not enter an alias name, the alias will be the same as the element name.

7. Click Next. 

The Create Task and Review Structure dialog box appears.

Workflow Concepts and Administration 1-13

Page 28: Tm1 Workflow Administrators Guide En

Creating a New Budget Version Table of Contents | Index

This dialog box allows you to build the Task and Review hierarchy for your budgeting system. Your hierarchy may exist in a single TM1 dimension or it may be exist across several dimensions. You may also want to add elements to the Task and Review hierarchy by hand. The Workflow version wizard supports all of this. The example that follows builds a Task and Review hierarchy from two dimensions: plan_business_unit and plan_department.

8. Click on an element in the Elements list. Drag that element into the Task and Review Structure panel. If you click on a consolidated element, the ele‐ment and all of its children are moved to the Task and Review Structure panel. The following figure shows the results of dragging the Total Busi-ness Unit element.

1-14 TM1 Workflow Administrator’s Guide

Page 29: Tm1 Workflow Administrators Guide En

Creating a New Budget Version Table of Contents | Index

9. Choose another dimension from the Dimension list. 

The elements of that dimension appear in the Subset Elements list. Click and drag elements from this dimension into the appropriate places in the Task and Review Structure panel. 

Total Business Unit consolidation dragged to the Task and Review Structure panel.

Workflow Concepts and Administration 1-15

Page 30: Tm1 Workflow Administrators Guide En

Creating a New Budget Version Table of Contents | Index

The following figure shows the result of choosing the Marketing element from the plan_department dimension, and adding that element as a child of US.

Notice that the parent’s name (US) and the dragged object (Marketing) are concatenated. This helps to keep the node names in the hierarchy unique.

There are two parameters in parentheses for each node. The first parameter is the task owner. The second parameter is the security group. The tag (unassigned, no security group) indicates that no group has been assigned as an owner of this budgeting task, and no security group assignment has been established for the task. Assigning ownership and security for budgeting tasks comes at a later point in the process.

10. To add a sales office to each location, right‐click the location in the Task and Review Structure panel, and choose Insert → Child.

11. Type US Sales.

1-16 TM1 Workflow Administrator’s Guide

Page 31: Tm1 Workflow Administrators Guide En

Creating a New Budget Version Table of Contents | Index

The new US Sales department is added to your hierarchy. It has the tag (Unassigned, No Security Group) until you assign an owner and a security group.

You can add departments with the same name to the hierarchy. However, we highly recommend that the names be unique, if possible. This will make the tasks easier to identify from within Excel. 

NOTE: If you drag a item into the Task and Review structure from the Elements list, the name of the new tree node is the <parent_name> element Name. If you create a node by right-clicking in the Task and Review structure, or dragging elements from one part of the Task and Review structure to another, the names are not modified. In this case, you must be careful to create unique names.

12. To drag more than one element from the Elements list to the Task and Review hierarchy, click Allow Multiple Assignments. The dialog box should look like the following figure.

Workflow Concepts and Administration 1-17

Page 32: Tm1 Workflow Administrators Guide En

Creating a New Budget Version Table of Contents | Index

NOTE: When Allow Multiple Assignments is enabled, you cannot drag from the Elements list to the Task and Review Template list.

To move engineering to the Task and Review structure as a child of both UK and Germany, click the Engineering checkbox in the left panel, and UK and Germany check boxes in the right panel. The result is shown in the following figure.

1-18 TM1 Workflow Administrator’s Guide

Page 33: Tm1 Workflow Administrators Guide En

Creating a New Budget Version Table of Contents | Index

13. Click  . An entry for engineering is added to both UK and Germany. Note that the names of the parents and the names of the added nodes are concatenated to create unique hierarchy entries.

Workflow Concepts and Administration 1-19

Page 34: Tm1 Workflow Administrators Guide En

Creating a New Budget Version Table of Contents | Index

14. When your Task and Review structure is complete, click Next. 

The next step is to establish a security group and an owner for each node in the Task and Review structure.

Step 2 - Assigning Budget Responsibility and Task Security

Each node in your Task and Review structure must be assigned a user who is responsible for completing that department’s portion of the budget. This user is called the task owner. In addition, each node in the Task and Review structure must be assigned a security group. All security in TM1 is controlled through TM1 groups. If you are using Workflow security, only members of the assigned security group will have access rights to the tasks’s data.

The TM1 Group and User Assignment Dialog Box

The following figure shows the TM1 Group and User Assignment dialog box.

1-20 TM1 Workflow Administrator’s Guide

Page 35: Tm1 Workflow Administrators Guide En

Creating a New Budget Version Table of Contents | Index

This dialog box shows you all the TM1 groups and all the TM1 users in your system. To make assignments, drag an element from the TM1 groups and users list onto a node in the Task and Review Template panel.

You can drag a TM1 user, or a TM1 user from within a TM1 group. The effects of dragging each of these objects are as follows:

Workflow Concepts and Administration 1-21

Page 36: Tm1 Workflow Administrators Guide En

Creating a New Budget Version Table of Contents | Index

• If you drag a user, you set the task’s owner.

• If you open a TM1 group, and drag a user from within that group, the user becomes the task’s owner, and the user’s group becomes the task’s security group.

Suppose you build a small hierarchy of tasks that have no assigned owner and no security group, as shown in the following figure.

The following figure shows the results of dragging a user (Deeds) to the ROW Direct task, and the user Davis from the Budget Planner group to the ROW Indirect task.

Notice that ROW Indirect is displayed in black letters, while the other nodes are in blue. Black letters indicate that the node has all the required assignments. Blue letters indicate that additional assignments are required.

Continue to click and drag users into the Task and Review Structure pane until every node in your hierarchy has an assigned owner. Then, click Next.

Step 3 - Setting Task Attributes

The Set Task Attributes screen of the Workflow Version Wizard is shown in the following figure.

1-22 TM1 Workflow Administrator’s Guide

Page 37: Tm1 Workflow Administrators Guide En

Creating a New Budget Version Table of Contents | Index

Use this screen to edit attributes for tasks in the Task and Review structure. For example, you can set a starting date and time stamp for all tasks. Follow these steps:

1. Click Allow Multiple Assignments.

Workflow Concepts and Administration 1-23

Page 38: Tm1 Workflow Administrators Guide En

Creating a New Budget Version Table of Contents | Index

2. Click the check box next to each node in the Task and Review structure whose attribute you want to set. 

3. Scroll down the Set/Edit Attributes For the Selected Task list. Locate Started Datetime.

4. Click the Started Datetime field, then click  . A calendar appears, as shown in the following figure.

5. Choose a date. Today’s date is circled on the calendar.

6. Click the hour or minutes value in the date and time stamp.

7. Use the up and down arrow keys to change the hour and minutes. (typing numbers does not change this field.)

8. Click  .

9. Click OK. 

The Version Wizard - Initialize Plan dialog box appears.

1-24 TM1 Workflow Administrator’s Guide

Page 39: Tm1 Workflow Administrators Guide En

Creating a New Budget Version Table of Contents | Index

Step 4 - Initializing Your Version

The last step in creating a new version is to initialize some values for the version object itself. The Version Wizard - Initialize Plan dialog box allows you to do this.

Follow these steps to complete your budget version:

1. Choose one of the following Version Status options:

•In Progress ‐ This budget version will be available to Workflow users.

•Under Development ‐ This budget version needs modification before it can be released to other users.

Workflow Concepts and Administration 1-25

Page 40: Tm1 Workflow Administrators Guide En

Creating a New Budget Version Table of Contents | Index

•Finished ‐ This budget version is available for viewing by other Workflow users, but it cannot be modified. This is used for archived budget data.

•Inactive ‐ This budget version is not for public viewing, and may be discarded at some time in the future ‐ perhaps after it is backed up.

2. Enter any notation on the version in the Version Notes box.

3. Select a Start Date for the version. This is the first date that people in your Task and Review hierarchy are allowed to make changes to your budget data.

4. Select a Due Date for the version. This is the date on which the budget is to be completed.

5. Choose one of the following Version Security Settings options from the field:

•None ‐ No additional security is applied to the version. Your existing security still applies.

•Cell Level ‐ TM1 cell‐level security is applied to cells in the version based on current version status. Cell‐level security is covered later in this chapter.

6. Enable or disable the Version Hierarchy Visible to TM1 Admin Group option. If you enable this option, members of the TM1 Admin group who click the  

 or   buttons on the Workflow toolbar will be able to see every task in the version. If you disable the option, members of the admin group will be able to see only the tasks that they are assigned, and all chil‐dren of those tasks.

7. Click Next.

1-26 TM1 Workflow Administrator’s Guide

Page 41: Tm1 Workflow Administrators Guide En

Creating a New Budget Version Table of Contents | Index

8. Click Finish. Workflow notifies you that version setup is complete and prompts you to notify users that the version is available.

9. Click Yes to send email notification to users. Click No complete the setup process without notifying users. 

Email notification is covered in next section.

If you click No, the version is complete and available for use. The next step is to set up navigation and security for your planning worksheets. Setting up security and navigation is described in Chapter 3 of this manual.

Notifying Users

If you click Yes to send email notification to users, the following dialog box appears.

Workflow Concepts and Administration 1-27

Page 42: Tm1 Workflow Administrators Guide En

Creating a New Budget Version Table of Contents | Index

Follow these steps to send email to your planning participants:

1. Double‐click the version you just created. The tree expands to show you the Task and Review structure for that version.

1-28 TM1 Workflow Administrator’s Guide

Page 43: Tm1 Workflow Administrators Guide En

Creating a New Budget Version Table of Contents | Index

2. Click the check box beside one or more tasks. This indicates that the user assigned to perform the task will be sent email notifying them that the ver‐sion is complete, and they can begin work. For this example, suppose you click the task US Marketing.

Workflow Concepts and Administration 1-29

Page 44: Tm1 Workflow Administrators Guide En

Creating a New Budget Version Table of Contents | Index

3. Click Alert. Your default email client appears.

1-30 TM1 Workflow Administrator’s Guide

Page 45: Tm1 Workflow Administrators Guide En

Creating a New Budget Version Table of Contents | Index

4. The To: field contains the email address of the TM1 users who owns the US Marketing task.

5. Enter subject and body text as required.

6. Send the email.

Workflow Concepts and Administration 1-31

Page 46: Tm1 Workflow Administrators Guide En

Workflow Messaging Table of Contents | Index

Workflow Messaging

Workflow sends messages to your budget participants during certain times in your budget process. Messages are triggered by two events:

• The creation of a new budget version.

• The execution of a task action from the Workflow toolbar.

The following section shows how to customize a message that is sent through email when someone submits a portion of the budget.

Configuring Email for a Submit Action

Email is configured in two places in Workflow:

• The default message for each task action is set through the task actions list in the Workflow Administration console.

• Individual tasks can override the task action defaults. Messages for individual tasks are set through the version wizard.

Setting the Default Message for a Task Action

This section shows how to set up a default email message for all Submit actions in Workflow. Follow these steps:

1. Run the Workflow Administration console.

2. Under Application Parameters, open the Task Actions list.

3. Double‐click a task action. The following dialog box appears when you double‐click Submit.

1-32 TM1 Workflow Administrator’s Guide

Page 47: Tm1 Workflow Administrators Guide En

Workflow Messaging Table of Contents | Index

4. Click Subject and Message. The Subject and Message field now looks like this.

5. Click  . The following dialog box appears.

Workflow Concepts and Administration 1-33

Page 48: Tm1 Workflow Administrators Guide En

Workflow Messaging Table of Contents | Index

6. You can modify this default message according to your business require‐ments. The variables on the right are mail merge substitution fields that allow you to make the message dynamic. 

7. Click OK.

Setting up Comments for a Task Action

Users who perform a task action, such as submitting a budget proposal, can be given the opportunity to include comments on the action. The advantage of 

1-34 TM1 Workflow Administrator’s Guide

Page 49: Tm1 Workflow Administrators Guide En

Workflow Messaging Table of Contents | Index

comments over email messaging is that comments are stored in the planning database, and can be reviewed at a later date.

To set up comments for an action, follow these steps:

1. Run the Workflow Administration console.

2. Open the Task Action list, and double‐click an action. The Task Properties dialog box appears.

3. Set DisplayConfirmMessage to Y.

4. Click Apply.

Workflow Concepts and Administration 1-35

Page 50: Tm1 Workflow Administrators Guide En

Workflow Messaging Table of Contents | Index

5. Click OK.

Adding Comments to a Task

This section shows how you can add comments to a task. In the following example, the Submit action has been configured to prompt for comments. 

The following figure shows a task that is ready to be submitted.

1-36 TM1 Workflow Administrator’s Guide

Page 51: Tm1 Workflow Administrators Guide En

Workflow Messaging Table of Contents | Index

1. Click Submit. The following dialog box appears:

Workflow Concepts and Administration 1-37

Page 52: Tm1 Workflow Administrators Guide En

Workflow Messaging Table of Contents | Index

2. Enter text in the Comments field.

3. The Action Confirmation dialog box includes two options:

• Send Email - When you click OK, the default mail client for your workstation appears. For example, if your workstation is configured to use Microsoft Outlook, a dialog box like the following appears:

1-38 TM1 Workflow Administrator’s Guide

Page 53: Tm1 Workflow Administrators Guide En

Workflow Messaging Table of Contents | Index

• Include Comments - If you enable this option and the Send Email option, the mail message will include your comments.

Viewing Archived Comments

Once comments have been added to a task, you can view those comments by clicking All Tasks and scrolling to the right. The following figure shows the Submit Comment field for two completed tasks.

Workflow Concepts and Administration 1-39

Page 54: Tm1 Workflow Administrators Guide En

Workflow Messaging Table of Contents | Index

Setting up Messages for a Task

This section shows how to set up email messages for a task within a version. The task settings override the default task action messages. Follow these steps:

1. Run the Workflow Administration console.

2. Right‐click a budget version and choose Edit. The Edit Version Details dia‐log box appears.

1-40 TM1 Workflow Administrator’s Guide

Page 55: Tm1 Workflow Administrators Guide En

Workflow Messaging Table of Contents | Index

3. Click Edit Task Tree. The Edit Task and Review Structure dialog box appears.

4. Click the Task Attributes tab. The following figure shows this tab.

5. Click a task in the Task and Review Structure on the right. You can edit messages for only one node of the tree at a time.

6. Scroll to the bottom of the attributes list. The following figure shows the messaging attributes.

Workflow Concepts and Administration 1-41

Page 56: Tm1 Workflow Administrators Guide En

Workflow Messaging Table of Contents | Index

There is one subject field for each task action. The rest of this procedure shows how to modify the email message sent when a user submits a task. 

7. Click Submit Subject. The Submit Subject field now looks like this.

8. Click  . The following dialog box appears.

1-42 TM1 Workflow Administrator’s Guide

Page 57: Tm1 Workflow Administrators Guide En

Workflow Messaging Table of Contents | Index

9. Enter the message that you want sent when this task is submitted back to the delegator.

10. Click OK. Your subject should appear in the Task Attributes tab.

Workflow Concepts and Administration 1-43

Page 58: Tm1 Workflow Administrators Guide En

Workflow Messaging Table of Contents | Index

Setting Up Email for Budget Participants

You can configure email addresses for your budget participants through the Workflow Administration console. Follow these steps to establish an email address for the user Admin.

1. Run the Workflow Admin Console.

2. Expand the User Attributes list.

3. Double‐click Admin. The Client Properties dialog box appears.

1-44 TM1 Workflow Administrator’s Guide

Page 59: Tm1 Workflow Administrators Guide En

Workflow Messaging Table of Contents | Index

4. Click Email. The value field is highlighted yellow.

5. Enter the user’s email address.

6. Click Apply.

7. If you want to modify more than one email address, you can choose another user from the drop‐down list, then modify that user’s email.

8. Click OK when you are finished adding email addresses.

NOTE: If no email addresses are input for Workflow users, your email system will attempt to look up your TM1 user names in your default address book.

Workflow Concepts and Administration 1-45

Page 60: Tm1 Workflow Administrators Guide En

Workflow Messaging Table of Contents | Index

1-46 TM1 Workflow Administrator’s Guide

Page 61: Tm1 Workflow Administrators Guide En

Navigation Overview Table of Contents | Index

2 Security and Navigation

Workflow allows you to bind Microsoft Excel workbooks, and TM1 data to a task within the Workflow system. When a user chooses a task from the Workflow menu, the correct workbook will open, the correct worksheet within the workbook will display, and the formulas within the worksheet will adjust so that the user is working with the data that is relevant to the task they selected.

Workflow security allow you to control who changes your data, and when.

This chapter describes how to build navigation and security into your Workflow system. The following topics are covered

• Setting Up SUBNM Navigation

• Setting Up Range Navigation

• Setting Up Security for Your Planning Worksheets

Navigation Overview

Workflow navigation features allow you to control the data that is presented to a user that chooses a task from the Workflow toolbar. There are two different mechanisms for building navigation into your plans:

• Navigation using SUBNM functions

• Navigation using named ranges

Security and Navigation 2-1

Page 62: Tm1 Workflow Administrators Guide En

Navigation Overview Table of Contents | Index

The most common form of navigation involves manipulating SUBNM functions in a worksheet. For example, if a user chooses a task called Germany, you could configure Workflow to do the following:

• Open an Excel Workbook called Planning _Germany.xls.

• Migrate to sheet1 in the Excel workbook.

• Search the specified sheet for a SUBNM for the Business Unit dimension.

• Set the SUBNM to the value GERMANY. 

When you recalculate the sheet, the DBRW functions in the sheet that use the cell containing the SUBNM as an argument display the data for the Germany business unit.

Navigation with Named Ranges

Some customers have requested the ability to navigate through their Workflow system without using SUBNM functions. With Workflow, these customers can set up navigation using named ranges. 

Named ranges are variables stored within the Excel workbook. The values of these variables might be stored in a spreadsheet cell, stored in a range of cells, or be stored by Excel in a variable with no cell address. Named ranges can be used in Excel formulas, like a variable in a programming language.

Navigation through named ranges occurs after, and in addition to, navigation with SUBNM functions. named range navigation works like this:

1. You must specify a pattern match in the Binding Address Template attribute. 

2. Workflow searches through all the named ranges in the spreadsheet. 

2-2 TM1 Workflow Administrator’s Guide

Page 63: Tm1 Workflow Administrators Guide En

Navigation Overview Table of Contents | Index

3. If Workflow finds a named range that matches the contents of the Binding Address Template attribute in the Workflow system options, Workflow sets that named range to the name of its element or alias. 

4. DBRW functions that use the named range as an argument are affected by any change in the value of the named range. 

The next two sections show how to build a spreadsheet with a simple named range. For a complete example of building named range navigation see the section entitled, “Setting Up named range Navigation for your Planning Worksheets,” later in this chapter.

Named ranges: A Simple Example

The following procedure shows how to add a simple named range to an empty spreadsheet:

1. Open Microsoft Excel.

2. In cell B3, enter a 6.

3. Click in the name box on the Excel toolbar, and enter My_define.

4. Click in the cell B6.

Security and Navigation 2-3

Page 64: Tm1 Workflow Administrators Guide En

Navigation Overview Table of Contents | Index

5. Enter the following formula in that cell:

=sum(My_define+3)

The following figure shows the result.

Getting a List of Named ranges in a Spreadsheet

To see a complete list of the named ranges in a spreeadsheet, choose Insert → Name → Define from the Excel menu. The following dialog box appears:

2-4 TM1 Workflow Administrator’s Guide

Page 65: Tm1 Workflow Administrators Guide En

Setting Up SUBNM Navigation Table of Contents | Index

Setting Up SUBNM Navigation

Workflow automatically performs one of the following actions when a user chooses a task to perform:

• Opens a specific workbook and worksheet with title elements relevant to the user’s planning task

• Sets SUBNM values in the current worksheet so that data associated with the task appears in the worksheet

For example, consider the following worksheet.

Security and Navigation 2-5

Page 66: Tm1 Workflow Administrators Guide En

Setting Up SUBNM Navigation Table of Contents | Index

In this worksheet, the plan_business_unit SUBNM is used for navigation. If you choose another task from the Workflow task list, the value of the plan_business_unit SUBNM is changed.

For example, when you choose the Canada task, the plan_business_unit changes to Canada, as shown in the following figure:

2-6 TM1 Workflow Administrator’s Guide

Page 67: Tm1 Workflow Administrators Guide En

Setting Up SUBNM Navigation Table of Contents | Index

To set up this navigation, follow these steps:

1. Choose TM1 → Workflow → Admin from the Excel menubar. The TM1 Work-flow Administration Console appears.

Security and Navigation 2-7

Page 68: Tm1 Workflow Administrators Guide En

Setting Up SUBNM Navigation Table of Contents | Index

2. Open the plan_version list.

3. Right‐click the version for which you want to define navigation and choose Edit. The Edit Version dialog box appears.

2-8 TM1 Workflow Administrator’s Guide

Page 69: Tm1 Workflow Administrators Guide En

Setting Up SUBNM Navigation Table of Contents | Index

4. Click Security and Navigation. The Security and Navigation dialog box appears.

Security and Navigation 2-9

Page 70: Tm1 Workflow Administrators Guide En

Setting Up SUBNM Navigation Table of Contents | Index

5. Click a task in the left pane of the screen. The security and navigation objects for the selected task appear in separate panes on the right side of the Security and Navigation screen.

2-10 TM1 Workflow Administrator’s Guide

Page 71: Tm1 Workflow Administrators Guide En

Setting Up SUBNM Navigation Table of Contents | Index

The above example shows the navigation settings for the UK task. When the user selects the UK task from the Workflow task list, the plan_business_unit title element in the worksheet is set to UK.

If a task is associated with a worksheet that has multiple SUBNM functions, you can define additional navigation objects for a task. You can also define the worksheet that should open when a user selects a task from the Task menu.

Security and Navigation 2-11

Page 72: Tm1 Workflow Administrators Guide En

Setting Up SUBNM Navigation Table of Contents | Index

The following sections describe how to apply or edit navigation in the Security and Navigation screen.

Adding SUBNM Navigation to a Task

SUBNM navigation ensures that a task always opens with a specified title dimension element that is relevant to the task. In the above example, title dimension navigation is used to ensure that the UK task always uses the UK element of the business unit dimension.

To add SUBNM navigation to a task:

1. Right‐click anywhere in the navigation pane of the Security and Navigation screen.

2. Choose New Dimension Navigation Element → <dimension_name>, where <dimension_name> is the name of a title dimension in the worksheet used for the budgeting task.

The Subset Editor appears.

2-12 TM1 Workflow Administrator’s Guide

Page 73: Tm1 Workflow Administrators Guide En

Setting Up SUBNM Navigation Table of Contents | Index

3. Select the element you want to use for navigation.

4. Click OK.

5. Click Close on the Security and Navigation screen.

6. Click Next. 

7. Click Finish.

Editing a SUBNM Navigation Assignment

To edit an existing SUBNM navigation assignment so that a task uses a different title dimension element:

1. Right‐click the existing dimension navigation assignment in the navigation pane of the Security and Navigation screen.

2. Select Edit Assignment. The Subset Editor appears.

3. Select the new element you want to use for navigation.

4. Click OK.

5. Click Close on the Security and Navigation screen.

6. Click Next. 

7. Click Finish.

Adding Worksheet Navigation to a Task

When you add worksheet navigation to a task, you ensure that users work in a specific worksheet when the task is selected from the Task menu. Worksheet navigation works in conjunction with other navigation objects. When the 

Security and Navigation 2-13

Page 74: Tm1 Workflow Administrators Guide En

Setting Up SUBNM Navigation Table of Contents | Index

worksheet opens, it uses the SUBNM or named range navigation specified for the task. 

For example, the following image shows both SUBNM and worksheet navigation for the UK task. When a user selects the UK task from the Task menu, the Planning_UK.xls workbook opens to the Sheet1 worksheet. Workflow sets the plan_business_unit SUBNM function to the value UK.

To add worksheet navigation to a task, follow these steps:

2-14 TM1 Workflow Administrator’s Guide

Page 75: Tm1 Workflow Administrators Guide En

Setting Up SUBNM Navigation Table of Contents | Index

1. From the Security and Navigation screen, click Workbook Path  . The Worksheet Selection dialog box appears.

2. Use the file browser in the top panel locate the workbook you want to use for task navigation.

Security and Navigation 2-15

Page 76: Tm1 Workflow Administrators Guide En

Setting Up SUBNM Navigation Table of Contents | Index

We highly recommend that all Workflow workbooks be added to a TM1 application. Your TM1 applications are displayed at the top of the Worksheet Selection dialog box. You can use public external files that are not part of a TM1 application, but TM1 applications allow you to better organize and manage your Workflow components. 

NOTE: Private workbooks inside the application organizer are not accessible from Workflow. All workbooks must be public objects.

3. When you click the workbook file, the Worksheet option box is updated with the names of the sheets in the Workbook. The SUBNM functions on the first listed worksheet are shown in the list below the worksheet field.

2-16 TM1 Workflow Administrator’s Guide

Page 77: Tm1 Workflow Administrators Guide En

Setting Up SUBNM Navigation Table of Contents | Index

4. Choose a sheet from the Worksheet option box.

5. Click OK.

6. Click Close.

7. Click Next. 

8. Click Finish.

Security and Navigation 2-17

Page 78: Tm1 Workflow Administrators Guide En

Setting Up Named Range Navigation Table of Contents | Index

When a user opens a task that uses workbook navigation, a copy of the workbook is downloaded to the user’s computer and opened in Excel. The user then works with the local copy of the worksheet. Every time the task is opened a new copy of the workbook is downloaded and opened.

Editing a Workbook Navigation Assignment

To edit an existing workbook navigation assignment so that a task uses a different workbook:

1. From the Security and Navigation screen, click Workbook Path  . The Worksheet Selection dialog box appears. 

2. Locate the workbook you want to use for task navigation.

3. Choose a sheet from the Worksheet option.

4. Click OK.

5. Click Close on the Security and Navigation screen.

6. Click Next. 

7. Click Finish.

Setting Up Named Range Navigation

This section describes how to set up Workflow navigation for an Excel workbook that does not contain SUBNM functions. You can build worksheets that read data from TM1, but contain DBRW functions that reference named ranges that are established in the workbook.

2-18 TM1 Workflow Administrator’s Guide

Page 79: Tm1 Workflow Administrators Guide En

Setting Up Named Range Navigation Table of Contents | Index

To add named range navigation to Workflow, you must complete these procedures:

• Step 1 ‐ Add %dimension% to the Binding Address Template field in Workflow.

• Step 2 ‐ Add a named range to your spreadsheet. The named range must be the name of a dimension that is specified as a navigation object, or must match the pattern in the Binding Address Template field.

• Step 3 ‐ Change the DBRW formulas in the spreadsheet to include the named range in place of a cell range.

Step 1 - Set the Binding Address Template Field

The first step in using named range navigation is to set the Binding Address Template field on the Task Properties dialog box. To access this dialog box, follow these steps:

1. Run the Workflow Administration console.

2. Open the System Options list. The Binding Address Template option appears at the bottom of the list, as shown in the following figure.

Security and Navigation 2-19

Page 80: Tm1 Workflow Administrators Guide En

Setting Up Named Range Navigation Table of Contents | Index

3. Double‐click the Binding Address Template system option. The Task Prop‐erties dialog box appears.

2-20 TM1 Workflow Administrator’s Guide

Page 81: Tm1 Workflow Administrators Guide En

Setting Up Named Range Navigation Table of Contents | Index

4. Enter the following string in the Default Value field for the Binding Address Template option:

%dimension%

5. Click Apply.

6. Click Yes at the confirmation dialog box.

The value %dimension% tells Workflow to write the dimension element name (or alias) to the named range that is identified by the dimension name. For example, suppose you defined the navigation object in the following figure.

Security and Navigation 2-21

Page 82: Tm1 Workflow Administrators Guide En

Setting Up Named Range Navigation Table of Contents | Index

In this case, the named range plan_business_unit would be modified to contain the name of the element or alias for the plan_business_unit dimension. The Element field of the navigation object shows the value to which the named range will be set. In this example, the named range would be set to UK.

Binding Address Template Field Modifiers

You can add special characters to the Binding Address Template field to search for a set of named ranges in the spreadsheet. This allows you to modify the 

2-22 TM1 Workflow Administrator’s Guide

Page 83: Tm1 Workflow Administrators Guide En

Setting Up Named Range Navigation Table of Contents | Index

values of a set of named ranges. Use the *, #, and _ characters. The following table shows some example of how these are used.

Character Definition Examples

* (asterisk) Any character or string of characters.

%dimension%*If you choose the plan_department dimension as your navigation object, This entry allows Workflow to modify the following named ranges:plan_departmentplan_department25plan_departmentNorthAmerica

Security and Navigation 2-23

Page 84: Tm1 Workflow Administrators Guide En

Setting Up Named Range Navigation Table of Contents | Index

Step 2 - Add a Named Range to Your Spreadsheet

The following procedure shows how to add a named range called plan_business_unit6 to a spreadsheet:

1. Open the workbook in Microsoft Excel.

2. Choose Insert → Name → Define.

# (pound sign) Any single numeric character

%dimension%#If you choose the plan_business_unit dimension as your navigation object, this entry allows Workflow to modify the following named ranges:plan_business_unitplan_business_unit2plan_business_unit6

_ (underscore) Any single non‐numeric character

%dimension%_If you choose the plan_business_unit dimension as your navigation object, this entry allows Workflow to modify the following named ranges:plan_business_unitplan_business_unitAplan_business_unitZ

Character Definition Examples

2-24 TM1 Workflow Administrator’s Guide

Page 85: Tm1 Workflow Administrators Guide En

Setting Up Named Range Navigation Table of Contents | Index

3. Enter plan_business_unit6 in the Names in Workbook field.

4. In the Refers to field, enter Germany.

5. Click Add.

6. Click OK.

Step 3 - Change the DBRW Formulas in the Spreadsheet

In a TM1 slice, the DBRW formulas typically look like this:

=DBRW($B$1,$B$2,$B$3,$B$5,$B$6,$B$4,$A11,C$8)

If you have a named range defined, you can use it as an argument to a DBRW function. For example, the following figure shows a DBRW function for the plan_BudgetPlanLineItem cube in the Planning Sample database:

Security and Navigation 2-25

Page 86: Tm1 Workflow Administrators Guide En

Setting Up Named Range Navigation Table of Contents | Index

The first argument ($B$1) of the DBRW function is always the TM1 server and the cube name. The third argument ($B$3 in this example) contains the cell address of the plan business unit element ‐ Germany, in this example.

The DBRW function will return the correct data as long as the third argument resolves to GERMANY. You can insert the named range built in the previous section into the DBRW function like this:

=DBRW($B$1,$B$2,plan_business_unit6,$B$5,$B$6,$B$4,$A11,C$8)

If the plan_business_unit6 named range is set to Germany, as shown in the previous section, you should be able to recalculate the spreadsheet, and it should display the proper data.

2-26 TM1 Workflow Administrator’s Guide

Page 87: Tm1 Workflow Administrators Guide En

Setting Up Security for Your Planning Worksheets Table of Contents | Index

Setting Up Security for Your Planning Worksheets

When you create a new Workflow budget version, you have the option of applying one of two security settings to the version:

• None – When you select this option Workflow does not enforce any security beyond what you have already defined for your budgeting cubes, dimensions, elements and cells. 

• Cell Level – When you select this option, Workflow applies cell‐level security to any cubes that are part of your budgeting process. that include the version dimension used in your budgeting system.

For example, the following image of the Security and Navigation screen shows a version with two cubes against which cell‐level security is applied: plan_BudgetPlan and plan_BudgetPlanLineItem. 

Security and Navigation 2-27

Page 88: Tm1 Workflow Administrators Guide En

Setting Up Security for Your Planning Worksheets Table of Contents | Index

When is Cell-Level Security Applied?

Cell‐level security is applied when the version status is In Progress. The security privilege applied is based on the current task status.

2-28 TM1 Workflow Administrator’s Guide

Page 89: Tm1 Workflow Administrators Guide En

Setting Up Security for Your Planning Worksheets Table of Contents | Index

The following table describes which cell‐level security is applied for a given task status for specific Workflow users.

Task Status Workflow User Cell-Level Security Applied

Not Started Delegator Read

Owner Read

In Progress Delegator Read

Owner Write

Approved Delegator Read

Owner Read

Rejected Delegator Read

Owner Write

Complete Delegator Read

Owner Read

Not Delegated Delegator Read

Owner None

Submitted Delegator Read

Security and Navigation 2-29

Page 90: Tm1 Workflow Administrators Guide En

Setting Up Security for Your Planning Worksheets Table of Contents | Index

Modifying Workflow Security

If you choose to implement cell‐level security for a version, you should modify the security so that is as efficient as possible. 

The following figure shows two cubes used in the budgeting process for the 2005_budget version and the number of cells in each cube to which cell‐level security will be applied.

Owner Read

Pending Delegator None

Owner None

Task Status Workflow User Cell-Level Security Applied

2-30 TM1 Workflow Administrator’s Guide

Page 91: Tm1 Workflow Administrators Guide En

Setting Up Security for Your Planning Worksheets Table of Contents | Index

The number of cells to which cell‐level security applies in the plan_BudgetPlan cube is over 12 million (12,972,960). The number of cells in the plan_BudgetPlanLineItem cube is over 7 million. Cell‐level security applied to such a large number of cells will cause a significant degradation in system performance. You can narrow the scope of cell‐level security by changing the number of elements in each subset used to define security. To do this:

1. Double‐click a dimension in the security pane of the Security and Naviga-tion screen. The TM1 Subset Editor appears.

Version

Number of cells to which cell-lev-el security ap-plies.

Dimensions and subsets used to define cell-level security.

Security and Navigation 2-31

Page 92: Tm1 Workflow Administrators Guide En

Setting Up Security for Your Planning Worksheets Table of Contents | Index

2. If an existing subset contains the elements you want to use to define cell‐level security, select the subset from the Subset drop‐down menu.

If a subset is not available, create and save one using the options on the Subset Editor. The Subset Editor is described in the TM1 Clients Guide.

3. Click OK.

4. Select any element in the current subset and again click OK on the Subset Editor. (If you fo not select an element, an error appears prompting you to do so.)

The new subset is now shown in the Security and Navigation screen and the number of cells to which cell‐level security applies is adjusted accordingly.

5. Repeat steps 1 through 5 for each dimension in the Security and Navigation screen.

In the following example, all subsets used for cell‐level security have been defined to contain only those elements that identify input data for the 2005_budget version.

2-32 TM1 Workflow Administrator’s Guide

Page 93: Tm1 Workflow Administrators Guide En

Setting Up Security for Your Planning Worksheets Table of Contents | Index

Note that the number of cells to which cell‐level security applies has been dramatically reduced. Cell‐level security is now applied to just 252 cells in the plan_BudgetPlan cube, and just 1512 cells in the plan_BudgetPlanLineItem cube. 

6. Click Close on the Security and Navigation screen.

7. Click Next on the Version Wizard.

8. Click Finish.

Security and Navigation 2-33

Page 94: Tm1 Workflow Administrators Guide En

Setting Up Security for Your Planning Worksheets Table of Contents | Index

2-34 TM1 Workflow Administrator’s Guide

Page 95: Tm1 Workflow Administrators Guide En

Table of Contents | Index

3 Workflow Administration Console

The Workflow administration console allows you to build and modify Workflow objects and structures. This chapter describes how to perform tasks with the Workflow administration console.

This chapter includes the following topics:

• TM1 Workflow Administration Console

• Adding a Plan

• Adding a Version to a Plan

Workflow Administration Console 3-1

Page 96: Tm1 Workflow Administrators Guide En

TM1 Workflow Administration Console Table of Contents | Index

TM1 Workflow Administration Console

To access the TM1 Workflow administration console, choose TM1 → Workflow → Admin. The first time you choose this option, the Workflow version wizard runs. Each time after the first, the following console appears:

This console application allows you to create new Workflow objects, including:

• Plans

• Versions

• Task and Review templates

3-2 TM1 Workflow Administrator’s Guide

Page 97: Tm1 Workflow Administrators Guide En

TM1 Workflow Administration Console Table of Contents | Index

It also allows you to customize and modify parts of the system. For example, it allows you to build and modify mail messages that are sent to budget participants during a task action.

Adding a Task and Review Template

A task and review template is a hierarchical list of budget tasks and the TM1 groups to whom those tasks are assigned. The task and review hierarchy is saved as a separate module that appears under the heading Task and Review Templates in the TM1 Workflow administration console. You can reuse a task and review template when you build budget versions. 

To create a task and review template, follow these steps:

1. From Microsoft Excel, choose TM1 → Workflow → Admin. The Workflow administration console appears.

2. Right‐click Task and Review Templates and choose Add a Task and Review Template. The following dialog box appears:

Workflow Administration Console 3-3

Page 98: Tm1 Workflow Administrators Guide En

TM1 Workflow Administration Console Table of Contents | Index

3. Enter the name of the template in the Template Element ID field. Click OK. The Create Task and Review Structure dialog box appears.

3-4 TM1 Workflow Administrator’s Guide

Page 99: Tm1 Workflow Administrators Guide En

TM1 Workflow Administration Console Table of Contents | Index

This dialog box allows you to build the task and review hierarchy for your budgeting system. Your hierarchy may exist in a single TM1 dimension or it may be stored in several dimensions. You may also want to add elements to the task and review hierarchy by hand. The Workflow version wizard supports all of this. The example that follows builds a task and review hierarchy from two dimensions: plan_business_unit and plan_department.

4. Click on an element in the Elements list. Drag that element into the Task and Review Template panel. If you click on a consolidated element, the ele‐

Workflow Administration Console 3-5

Page 100: Tm1 Workflow Administrators Guide En

TM1 Workflow Administration Console Table of Contents | Index

ment and all of its children are moved to the Task and Review Structure panel. The following figure shows the results of dragging the Total Busi-ness Unit element.

5. Choose another dimension from the Dimension list.

Total Business Unit consolidation dragged to the Task and Review Template panel.

3-6 TM1 Workflow Administrator’s Guide

Page 101: Tm1 Workflow Administrators Guide En

TM1 Workflow Administration Console Table of Contents | Index

The elements of that dimension appear in the Subset Elements list. Click and drag elements from this dimension into the appropriate places in the Task and Review Structure panel. 

The following figure shows the result of choosing the Marketing element from the plan_department dimension, and adding that element as a child of US.

Notice that the the Parent’s Name (US) and the dragged object (Marketing) are concatenated. This helps to keep the node names in the hierarchy unique.

There are two parameters in parentheses for each node. The first parameter is the task owner. The second parameter is the security group. The tag (unassigned, no security group) indicates that no group has been assigned as an owner of this budgeting task, and no security group assignment has been established for the task. Assigning ownership and security for budgeting tasks comes at a later point in the process.

6. To add a sales office to each location, right‐click on the location in the Task and Review Structure panel, and choose Insert → Child.

Workflow Administration Console 3-7

Page 102: Tm1 Workflow Administrators Guide En

TM1 Workflow Administration Console Table of Contents | Index

7. Type US Sales.

The new US Sales department is added to your hierarchy. It will have the tag (Unassigned, No Security Group) until you assign an owner and a security group.

You can add departments with the same name to the hierarchy. However, we highly recommend that the names be unique, if possible. This will make the tasks easier to identify from within Excel. 

NOTE: If you drag a item into the task and review template from the Elements list, the name of the new tree node is the <parent_name> element Name. If you create a node by right-clicking in the task and review structure, or dragging elements from one part of the task and review structure to another, the names are not modified. In this case, you must be careful to create unique names.

8. To drag more than one element from the Elements list to the Task and Review hierarchy, click Allow Multiple Assignments. The dialog box should look like the following figure.

3-8 TM1 Workflow Administrator’s Guide

Page 103: Tm1 Workflow Administrators Guide En

TM1 Workflow Administration Console Table of Contents | Index

NOTE: When Allow Multiple Assignments is enabled, you cannot drag from the Elements list to the Task and Review Template list.

To move engineering to the task and review structure as a child of both UK and Germany, click the Engineering checkbox in the left panel, and UK and 

Workflow Administration Console 3-9

Page 104: Tm1 Workflow Administrators Guide En

TM1 Workflow Administration Console Table of Contents | Index

Germany check boxes in the right panel. The result is shown in the following figure.

9. Click  . An entry for engineering is added to both UK and Germany. Note that the names of the parents and the names of the added nodes are concatenated to create unique hierarchy entries.

3-10 TM1 Workflow Administrator’s Guide

Page 105: Tm1 Workflow Administrators Guide En

TM1 Workflow Administration Console Table of Contents | Index

10. When your task and review structure is complete, click Next. The next step is to establish a security group and an owner for each node in the Task and Review structure.

Assigning Budget Responsibility and Task Security

Each node in your task and review structure must be assigned a user who is responsible for completing that department’s portion of the budget. This user is called the task owner. In addition, each node in the task and review structure must be assigned a security group. All security in TM1 is controlled through TM1 groups. Only members of the assigned security group will have access rights to the tasks’s data.

The TM1 Group and User Assignment Dialog Box

The following figure shows the TM1 Group and User Assignment dialog box.

Workflow Administration Console 3-11

Page 106: Tm1 Workflow Administrators Guide En

TM1 Workflow Administration Console Table of Contents | Index

This dialog box shows you all the TM1 groups and all the TM1 users in your system. To make assignments, drag an element from the TM1 groups and users list onto a node in the Task and Review Template panel.

3-12 TM1 Workflow Administrator’s Guide

Page 107: Tm1 Workflow Administrators Guide En

TM1 Workflow Administration Console Table of Contents | Index

You can drag a TM1 group, a TM1 user, or a TM1 user from within a TM1 group. The effects of dragging each of these objects is as follows:

• If you drag a user, you set the task’s owner.

• If you drag a TM1 group, you set the task’s security group.

• If you open a TM1 group, and drag a user from within that group, the user becomes the task’s owner, and the user’s group becomes the task’s security group.

Suppose you have three tasks that have no assigned owner and no security group, as shown in the following figure.

The following figure results from dragging a user (Deeds) to the US Marketing task, a TM1 group (Budget Planner) to the US Sales task, and the user Davis from the Budget Planner group to the US Engineering task.

Notice that US Engineering is displayed in black letters, while the other nodes are in blue. Black letters indicate that the node has all the required assignments. Blue letters indicate that additional assignments are required.

If you assign an owner and a security group to a task, and the owner is not a member of the security group, the owner may not be able to access the task’s 

Workflow Administration Console 3-13

Page 108: Tm1 Workflow Administrators Guide En

TM1 Workflow Administration Console Table of Contents | Index

data. We recommend adding owners from within a security group. This way, the owner always has acess to the task’s data.

Continue to click and drag users and groups into the Task and Review Structure pane until every node in your hierarchy has an assigned owner and a security group. Then, click Next.

Setting Task Attributes

Use the Set Task Attributes screen to edit individual attributes for each task in the Task and Review template.

3-14 TM1 Workflow Administrator’s Guide

Page 109: Tm1 Workflow Administrators Guide En

TM1 Workflow Administration Console Table of Contents | Index

Follow these steps to set task attributes:

1. Click a node in the hierarchy. 

2. Change the attributes in the Set/Edit Attributes for the Selected Task pane.

3. Click OK. 

Workflow Administration Console 3-15

Page 110: Tm1 Workflow Administrators Guide En

TM1 Workflow Administration Console Table of Contents | Index

The Workflow wizard adds the new task and review template to the administration console.

3-16 TM1 Workflow Administrator’s Guide

Page 111: Tm1 Workflow Administrators Guide En

Adding a Plan Table of Contents | Index

Adding a Plan

To add a new plan from the Workflow administration console, follow these steps:

1. Choose TM1 → Workflow → Admin. The Workflow administration console appears.

2. Right‐click any plan listed in the lefthand pane, and choose New Plan. The following dialog box appears:

Workflow Administration Console 3-17

Page 112: Tm1 Workflow Administrators Guide En

Adding a Plan Table of Contents | Index

3. Choose a budget version dimension.

NOTE: You cannot use a budget version dimension in multiple plans. Once you have used a dimension in a plan, you are forced to choose another dimension to hold your versions in the next plan you create.

4. Choose Create New Version. You can also choose an existing version that you built for another plan. The next section entitled “Building a Version From Another Version” describes this procedure.

5. Enter an element ID in the Version Element ID field. Enter an alias for the version. Both the element ID and the Alias must be unique within the dimension.

6. Click Next. The Create Task and Review structure dialog box appears.

3-18 TM1 Workflow Administrator’s Guide

Page 113: Tm1 Workflow Administrators Guide En

Adding a Plan Table of Contents | Index

7. Use the Dimension field to choose dimensions from your TM1 server, and drag elements from those dimensions into the Task and Review Template panel.

8. Click Next. The Assign Responsibility dialog box appears.

Workflow Administration Console 3-19

Page 114: Tm1 Workflow Administrators Guide En

Adding a Plan Table of Contents | Index

9. Use this dialog box to assign an owner and a security group to each node of the Task and Review structure. To do this, follow the instructions in the sec‐tion “Assigning Budget Responsibility and Task Security”

10. Click Next. The Set/Edit Attributes for the selected task dialog box appears.

11. Click OK. The Edit Version dialog box appears.

3-20 TM1 Workflow Administrator’s Guide

Page 115: Tm1 Workflow Administrators Guide En

Adding a Plan Table of Contents | Index

12. Choose an appropriate status for your version. Choose In Progress, Inac-tive, Under Development or Finished.

13. Add notes for the version in the Version Notes field.

14. Choose a Start Date and Due Date for the version.

15. Set the Version Security Setting to Cell to apply cell security to a set of cells in your TM1 database. If you set the Version Security Setting to None, Workflow will apply no security to your TM1 data beyond that which is set 

Workflow Administration Console 3-21

Page 116: Tm1 Workflow Administrators Guide En

Adding a Plan Table of Contents | Index

up in your database. The cells to which you apply cell security are deter‐mined by the subsets you specify in the Security and Navigation pane. 

16. Click Security and Navigation.

17. Set up cell security (if necessary) and navigation according to the instruc‐tions in Chapter 2 of this manual.

18. Click Close.

19. Click Next.

20. Click Finish. The Workflow wizard adds your new plan to the administra‐tion console.

3-22 TM1 Workflow Administrator’s Guide

Page 117: Tm1 Workflow Administrators Guide En

Adding a Version to a Plan Table of Contents | Index

Adding a Version to a Plan

Most budget plans will have more than one version. You can add a version to any plan in the Workflow system. 

A version must include a task and review structure. The task and review structure allows you to assign budget tasks to TM1 groups, and establish a workflow hierarchy that moves budget information across your organization as tasks are completed. 

Your new version’s task and review structure can come from one of three places: 

• You can copy the task and review structure from another version. In this case, the notes, tasks and task statuses associated with the existing version will be imported into your new version.

• You can copy the task and review structure from a task and review template. The new version contains no notes. All tasks will have a status of Not Started. It is important to note that the task and review template is copied into the version. Changing the template does not change any of the versions that use that template.

• You can build the task and review structure from scratch. 

The complete procedure for building a task and review structure from scratch is described in Chapter 2 of this manual. The remainder of this section describes building a version from another version, and building a version using a task and review template.

Workflow Administration Console 3-23

Page 118: Tm1 Workflow Administrators Guide En

Adding a Version to a Plan Table of Contents | Index

Building a Version From Another Version

In this procedure, assume that you already have a budget version that has all of the elements you want in your new version. This procedure copies that version, and creates a second version that has the same tasks, statuses, and notes as the first version.

Follow these steps.

1. Choose TM1 → Workflow → Admin. The Workflow administration console appears.

2. Right‐click a plan, and choose Add a Version. The following dialog box appears.

3-24 TM1 Workflow Administrator’s Guide

Page 119: Tm1 Workflow Administrators Guide En

Adding a Version to a Plan Table of Contents | Index

3. Click Create a new Version from an existing Version Task Structure.

4. Click Create a New Version Element ID. 

5. Enter the name and alias of the new version.

6. Click Next. The following dialog box appears.

7. Choose the version that contains the task and review structure that you want to apply to your new version. Then, click Next. The Edit Version dia‐log box appears.

Workflow Administration Console 3-25

Page 120: Tm1 Workflow Administrators Guide En

Adding a Version to a Plan Table of Contents | Index

8. Choose an appropriate status for your version. Choose In Progress, Inac-tive, Under Development or Finished.

9. Add notes for the version in the Version Notes field.

10. Choose a Start Date and Due Date for the version.

11. Set the Version Security Setting to Cell to apply cell security to a set of cells in your TM1 database. If you set the Version Security Setting to None, Workflow will apply no security to your TM1 data beyond that which is set 

3-26 TM1 Workflow Administrator’s Guide

Page 121: Tm1 Workflow Administrators Guide En

Adding a Version to a Plan Table of Contents | Index

up in your database. The cells to which you apply cell security are deter‐mined by the subsets you specify in the Security and Navigation pane. 

12. Click Security and Navigation.

13. Set up cell security (if necessary) and navigation according to the instruc‐tions in Chapter 2 of this manual.

14. Click Close.

15. Click Next.

16. Click Finish. The Workflow wizard adds your new budget version to the administration console.

Building a Version From a Task and Review Template

In this procedure, we assume that you have built a task and review template, and you want to apply that template to a new budget version. Follow these steps:

1. Choose TM1 → Workflow → Admin. The Workflow administration console appears.

2. Right‐click a plan, and choose Add a Version. 

3. Click Create a new Version from a Template Task Structure.

4. Click Create a New Version Element ID. 

5. Enter the name and alias of the new version.

Workflow Administration Console 3-27

Page 122: Tm1 Workflow Administrators Guide En

Adding a Version to a Plan Table of Contents | Index

6. Click Next. The following dialog box appears.

3-28 TM1 Workflow Administrator’s Guide

Page 123: Tm1 Workflow Administrators Guide En

Adding a Version to a Plan Table of Contents | Index

7. Click a task and review template. Click Next.

8. The Edit Version dialog box appears.

Workflow Administration Console 3-29

Page 124: Tm1 Workflow Administrators Guide En

Adding a Version to a Plan Table of Contents | Index

9. Choose an appropriate status for your version. Choose In Progress, Inac-tive, Under Development or Finished.

10. Add notes for the version in the Version Notes field.

11. Choose a Start Date and Due Date for the version.

12. Set the Version Security Setting to Cell to apply cell security to a set of cells in your TM1 database. If you set the Version Security Setting to None, Workflow will apply no security to your TM1 data beyond that which is set up in your database. The cells to which you apply cell security are deter‐mined by the subsets you specify in the Security and Navigation pane. 

13. Click Security and Navigation.

3-30 TM1 Workflow Administrator’s Guide

Page 125: Tm1 Workflow Administrators Guide En

Adding a Version to a Plan Table of Contents | Index

14. Set up cell security (if necessary) and navigation according to the instruc‐tions in Chapter 2 of this manual.

15. Click Close.

16. Click Next.

17. Click Finish. The Workflow wizard adds your new budget version to the administration console.

Workflow Administration Console 3-31

Page 126: Tm1 Workflow Administrators Guide En

Adding a Version to a Plan Table of Contents | Index

3-32 TM1 Workflow Administrator’s Guide

Page 127: Tm1 Workflow Administrators Guide En

Table of Contents | Index

4 Customizing Workflow

Workflow includes a set of Application Environment properties. These properties allow you to optimize and customize your Workflow environment. This chapter describes how to use these properties to customize Workflow for your business. The following topics are covered:

• The Workflow Application Environment

• System Options and User Options

• Task Actions

• Task Statuses

• Version Statuses

• Task Attributes

Customizing Workflow 4-1

Page 128: Tm1 Workflow Administrators Guide En

The Workflow Application Environment Table of Contents | Index

The Workflow Application Environment

The Workflow Application Environment settings appear in the administration console, as shown in the following figure.

The application environment parameters are divided into the following categories:

• Task Actions

• Task Statuses

• Version Statuses

• Task Attributes

4-2 TM1 Workflow Administrator’s Guide

Page 129: Tm1 Workflow Administrators Guide En

The Workflow Application Environment Table of Contents | Index

• System Options

• User Options

Some of these parameters are set in the version wizard, while others are set from the administration console. The sections that follow give complete information on each part of the application environment.

Customizing Workflow 4-3

Page 130: Tm1 Workflow Administrators Guide En

System Options and User Options Table of Contents | Index

System Options and User Options

The following figure shows the list of Workflow system options.

By setting the System Options to particular values, you set the default behavior for all users. You can override the system defaults by setting client properties for specific users.

These options are set for each user through the Client Properties dialog box. To access the Client Properties dialog box for a user, double‐click a user in the User Options list. The following dialog box shows the TM1 Workflow tab of the Client Properties dialog box for the user Admin.

4-4 TM1 Workflow Administrator’s Guide

Page 131: Tm1 Workflow Administrators Guide En

System Options and User Options Table of Contents | Index

NOTE: There is typically a 1 to 1 correspondence between the System Options list and the parameters on the TM1 Workflow tab of the Client Properties dialog box when you double‐click a user from the Admin console. The following figure shows these two lists side‐by‐side.

Customizing Workflow 4-5

Page 132: Tm1 Workflow Administrators Guide En

System Options and User Options Table of Contents | Index

By setting the values on the Workflow user options list, you can control the following Workflow features for the given user:

• Client and administrator help text.

• Enabling and disabling save prompts in the Workflow administration console.

• Modifying bitmap images in the TM1 administration console. Each user has an associated bitmap. This bitmap can be changed, so that you can quickly tell one user from another within Workflow.

4-6 TM1 Workflow Administrator’s Guide

Page 133: Tm1 Workflow Administrators Guide En

System Options and User Options Table of Contents | Index

• Default delegation task status and default simple task status. When you create a task, that task is assigned a starting status. This system property allows you to set that status.

• Execution control. Workflow allows you to set up a sequence of TurboIntegrator Processes that run when a user performs an action. The system options Pre Action TI Process, Pre Action TI Return, Post Action TI Process, and Post Action TI Return control the execution stack for all users in the Workflow System. For individual users, you can control the execution stack through the client properties pre_ti, pre_ti_return, post_ti, and post_ti_return. See Appendix A - Workflow Execution Stack for more information on these parameter settings.

Default Values, Client Overrides and Customizations

Set the default value for each User Option by double‐clicking the parameter in the System Options list. For example, if you double‐click the System Option Client Help Path, the following dialog box appears:

Customizing Workflow 4-7

Page 134: Tm1 Workflow Administrators Guide En

System Options and User Options Table of Contents | Index

You can set the default client help path for all clients by setting a full path to a help file in the Default Value field.

To override the default for a specific Workflow user, double‐click the user in the Admin Console User Options list. For example, to override Client Help Path for user Admin, double‐click Admin in the User Options list, then click the Workflow tab.

4-8 TM1 Workflow Administrator’s Guide

Page 135: Tm1 Workflow Administrators Guide En

System Options and User Options Table of Contents | Index

If you set the Client Help Path parameter here, the value you enter overrides the system default.

Customizations

When users are running Workflow, they can click the Customize button on the Workflow toolbar. If the Client Update field for a particular parameter is set to Y, the parameter appears in the client properties dialog box that appears when a user clicks Customize.

Customizing Workflow 4-9

Page 136: Tm1 Workflow Administrators Guide En

System Options and User Options Table of Contents | Index

For example, the following dialog box appears when the administrator double‐clicks the Client Help Type parameter in the System Options list.

Notice that the Client Update field is set to Y. This means that when a user logs in to Workflow, and clicks the Customize button, the Client Help Type parameter appears on the TM1 Workflow tab.

Setting User Help Text in Workflow

The Workflow toolbar has a help button that can be accessed by any Workflow user. The following figure shows the location of the help button on the Workflow toolbar.

4-10 TM1 Workflow Administrator’s Guide

Page 137: Tm1 Workflow Administrators Guide En

System Options and User Options Table of Contents | Index

When you click the toolbar help button, the Workflow Administrator’s Guide appears. You can modify this behavior to display a custom help file of your choice. Follow these steps:

1. Run Workflow. 

2. Log in to TM1 as an administrator.

3. Choose TM1→ Workflow → Admin from the Excel menu. The Workflow administration console appears.

4. Choose Application Environment → User Options.

5. Double‐click a user in the list. The Client Properties dialog box appears.

6. Click TM1 Workflow. The following dialog box appears.

Customizing Workflow 4-11

Page 138: Tm1 Workflow Administrators Guide En

System Options and User Options Table of Contents | Index

7. To change the behavior of the Workflow help button, you must modify the Client Help Path and the Client Help Type fields.

8. Choose one of the following settings for Client Help Type: Blob, File, URL, and App. 

4-12 TM1 Workflow Administrator’s Guide

Page 139: Tm1 Workflow Administrators Guide En

System Options and User Options Table of Contents | Index

9. The information you enter into the Client Help Path field depends on the Client Help File Type field. Refer to the following table.

Client Help File Type Client Help Path

BLOB Enter the name of a TM1 BLOB.

Clicking   displays the contents of a TM1 BLOB. A BLOB is 

any file stored in the TM1 server’s data directory that has a .BLB extension. If you specify a BLOB, the TM1 server delivers the BLOB to Workflow. Workflow strips off the .BLB extension and passes the resulting file to the operating system. The operating system determines which application produced the file by looking at its extension. It then opens the file using that application.For example, if you specify HelpInfo.htm.blb, Workflow opens the file HelpInfo.htm in a web browser.

File Clicking   displays the contents of a file. Enter a complete 

UNC to the file, including the file name. For example:\\mymachine\c$\work\plan_management\eng-planman.htm

URL Clicking   displays a web page. Enter a full URL.

For example:http:\\www.ibm.com\help

App Clicking   runs an application program. Enter the full path 

name to the program executable.

Customizing Workflow 4-13

Page 140: Tm1 Workflow Administrators Guide En

System Options and User Options Table of Contents | Index

10. Click OK. 

11. Right‐click each of your budget versions, and choose Edit.

12. Click Next.

13. Click Finish.

Setting Admin Help Text in Workflow

The settings Admin Help Type and Admin Help Path determine what help file appears when you click   on any Workflow dialog box. By default, the 

Admin Help Type is set to BLOB, and the Admin Help Path is set to eng-planman.pdf. When a user clicks  , the Workflow Administration Guide 

appears.

4-14 TM1 Workflow Administrator’s Guide

Page 141: Tm1 Workflow Administrators Guide En

System Options and User Options Table of Contents | Index

You can generate your own help text and set up Workflow to display that text. For example, the following procedure shows how to set up the help button to display a file called Help.htm. Follow these steps:

1. From the Workflow administration console, right‐click Admin Help Type and choose Add/Edit. The System Property Edit dialog box appears.

2. Change the Default Value field to File.

3. Click OK.

4. Right‐click Admin Help Path and choose Add/Edit. The System Property Edit dialog box appears.

Customizing Workflow 4-15

Page 142: Tm1 Workflow Administrators Guide En

System Options and User Options Table of Contents | Index

5. Change the Default Value field to C:\temp\help.htm.

6. Click OK.

7. Right‐click each of your budget versions, and choose Edit.

8. Click Next.

9. Click Finish.

You should now be able to click   from anywhere in Workflow and view 

the Help.htm file.

4-16 TM1 Workflow Administrator’s Guide

Page 143: Tm1 Workflow Administrators Guide En

Task Actions Table of Contents | Index

Task Actions

Task actions appear on the Workflow toolbar. The following figure shows where the Actions list appears.

By default, delegated tasks can have the following actions:

• Delegate ‐ Pass the task to an owner for completion.

• Start ‐ Choose this action when you are just starting work on a task. 

• Submit ‐ Choose this action to returns a completed task to the delegator for review.

• Revoke ‐ Revoke is essentially an ‘undo’ function. Choose this action to return the current status of the task to its previous state. 

• Reject ‐ Choose this action when further action by the owner is required. When a task delegator rejects a submitted task, the task returns to the owner.

• Approve ‐ The task is finished. No further action by the owner is required.

Simple tasks have only two actions: Complete and Revoke.

Adding a Custom Task Action

You can add your own task actions to Workflow. The following procedure shows how to add an action called execute. Follow these steps:

Task Actions List

Default Task Action

Customizing Workflow 4-17

Page 144: Tm1 Workflow Administrators Guide En

Task Actions Table of Contents | Index

1. Run the Workflow Administration console.

2. Right‐click Task Actions and choose Insert New Task Action.

The Add Task Action dialog box appears.

3. Enter the name of the new task action. In this example, the new task action is called execute.

4-18 TM1 Workflow Administrator’s Guide

Page 145: Tm1 Workflow Administrators Guide En

Task Actions Table of Contents | Index

4. Click OK. The Task Action dialog box appears.

Customizing Workflow 4-19

Page 146: Tm1 Workflow Administrators Guide En

Task Actions Table of Contents | Index

5. If you want users to be able to add comments when they perform this task action, set DisplayConfirmMessage to Y. 

6. Click the Subject and Message field. An elipse button should appear in the field as shown in the following figure.

7. Click  . The Email template setup dialog box appears.

4-20 TM1 Workflow Administrator’s Guide

Page 147: Tm1 Workflow Administrators Guide En

Task Actions Table of Contents | Index

8. This dialog box allows you to establish a template for mail that will be sent when a user performs this task. Add a standard subject and message for the mail message. You can use the mail substitution strings to add task‐specific information to the mail message. The following shows a simple example.

Customizing Workflow 4-21

Page 148: Tm1 Workflow Administrators Guide En

Task Actions Table of Contents | Index

9. Click OK. The new task action should appear in the task action list.

4-22 TM1 Workflow Administrator’s Guide

Page 149: Tm1 Workflow Administrators Guide En

Task Actions Table of Contents | Index

10. Right‐click Task Actions and choose workflow. The workflow definition dialog box appears. Your new task action should be added, as shown in the following figure.

11. Setup the appropriate task status changed on this dialog box. For example, in the following figure, the setting for In Progress has been set to Com-pleted.

New execute Task action.

Customizing Workflow 4-23

Page 150: Tm1 Workflow Administrators Guide En

Task Actions Table of Contents | Index

12. Click Close.

You should now be able to use your new task action as part of your planning process.

4-24 TM1 Workflow Administrator’s Guide

Page 151: Tm1 Workflow Administrators Guide En

Task Statuses Table of Contents | Index

Task Statuses

Each task has an associated status. Task statuses change when actions are performed. For example, if you are a task owner, and the status of a task is Not Started, and you choose to start the task, the status changes to in Progress. You can see all the status changes resulting from task actions in the following grid.

This grid appears when you click Workflow from any dialog box in the Workflow administration console.

Customizing Workflow 4-25

Page 152: Tm1 Workflow Administrators Guide En

Task Statuses Table of Contents | Index

To understand or modify a status on this grid, click a cell in the grid and choose a value from the list.

In this example, the cell at the intersection of Completed and Revoke is set to In Progress. This means the task status is set to In Progress under the following conditions:

• The user is a Delegator.

• The task type is Delegate.

4-26 TM1 Workflow Administrator’s Guide

Page 153: Tm1 Workflow Administrators Guide En

Task Statuses Table of Contents | Index

• The task status is Completed.

• The user performs a Revoke on the task.

Task Status Properties

When you double‐click a task status in the Workflow administration console, the Task Properties dialog appears:

Customizing Workflow 4-27

Page 154: Tm1 Workflow Administrators Guide En

Task Statuses Table of Contents | Index

The Task Properties dialog controls the default actions for any task assigned this status. The action list and default action for a task appears in the Workflow toolbar.

The setting for the default action depends on two factors:

• Whether the Workflow user is an owner or a delegator of the task.

• Whether the task is a delegated task or a simple task.

The following table describes the task status properties.

Field Description

Status_English Name of the status in English, such as In Progress.

Status_German Name of the status in German, such as In Bearbeitung.

Status_French Name of the status in French, such as En cours.

Display In Toolbar Set this to Y top display the status in the Workflow Toolbar.

Default for Owner Complete If you are looking at a simple task, and you are the owner of that task, the default task action is set to the value of this field.

Default Action

Action List

4-28 TM1 Workflow Administrator’s Guide

Page 155: Tm1 Workflow Administrators Guide En

Task Statuses Table of Contents | Index

Delegator Security If you are a member of the delegator group for any task to which this status is applied, the cell level security privilege specified in this field is applied to the task. For example, a delegator of a task with a status of In Progress might be assigned cell‐level security of READ. Note that this field only affects your data if the Version’s Security Setting is set to Cell-Level, and the Version Status Apply Cell-level Security setting is set to Y.If you change the value of this field, you must save the value, then re‐open and save the version to which you want to apply the new security setting. Do this by right‐clicking on the version in the Admin console, click Next, then click Finish.

Field Description

Customizing Workflow 4-29

Page 156: Tm1 Workflow Administrators Guide En

Task Statuses Table of Contents | Index

Owner Security If you are a member of the owner group for any task to which this status is applied, the cell level security privilege specified in this field is applied to the task. For example, an owner of a task with a status of In Progress might be assigned cell‐level security of WRITE. Note that this field only affects your data if the Version’s Security Setting is set to Cell-Level, and the Version Status Apply Cell-level Security setting is set to Y.If you change the value of this field, you must save the value, then re‐open and save the version to which you want to apply the new security setting. Do this by right‐clicking on the version in the Admin console, click Next, then click Finish.

Default for Delegator If you access a delegatable task from Workflow, and you are the delegator of that task, the default task action is set to the value of this field.

Field Description

4-30 TM1 Workflow Administrator’s Guide

Page 157: Tm1 Workflow Administrators Guide En

Task Statuses Table of Contents | Index

Default for owner If you access a simple task from Workflow, and you are the owner of that task, the default task action is set to the value of this field.

Status The display string for the task status. In English installations, this string should be the same as the Status_English field. In German installations, this string should be the same as the Status_German field. In French installations, this string should be the same as the Status_French field. 

Field Description

Customizing Workflow 4-31

Page 158: Tm1 Workflow Administrators Guide En

Version Statuses Table of Contents | Index

Version Statuses

When you create a new version, version statuses appear on the Apply/Create Version dialog box.

By default, you can choose between the following version statuses:

• In Progress

• Under Development

• Finished

• Inactive

4-32 TM1 Workflow Administrator’s Guide

Page 159: Tm1 Workflow Administrators Guide En

Version Statuses Table of Contents | Index

Adding a Version Status

This procedure shows how to add a version status called ‘pending approval.’ Follow these steps:

1. From the Workflow administration console, right‐click Version Statuses and choose Insert New Version Status. The Add Version Status dialog box appears.

2. Enter the name of the new version status. For this example, enter pending approval. 

3. Click OK. The following dialog box appears.

Customizing Workflow 4-33

Page 160: Tm1 Workflow Administrators Guide En

Version Statuses Table of Contents | Index

Fill in the fields in this dialog box according to the following table:

Field Description

Status_English Name of the status in English, such as In Progress.

Status_German Name of the status in German, such as In Bearbeitung.

Status_French Name of the status in French, such as En cours.

4-34 TM1 Workflow Administrator’s Guide

Page 161: Tm1 Workflow Administrators Guide En

Version Statuses Table of Contents | Index

Display in Status Tree Set this to Y or N. If this setting is Y, versions that have this status are displayed in the version status tree. If this parameter is set to N, versions with this status are not displayed in the status tree.

The version status tree is available from the   button on the Workflow toolbar.

Display in All Tasks Set this to Y or N. If this setting is Y, versions that have this status are displayed in the All Available Tasks list. If this parameter is set to N, versions with this status are not displayed in the All Available Tasks list.

The All Available Tasks list is available from the   button on the toolbar.

Element Level Security Workflow applies element‐level security to the element it adds to your version dimension. For example, suppose you set this field to READ for the version status In Progress. Tasks in the version carrying this status will be read only. Cell‐level security settings can override this default for specific cells.If you change the value of this field, you must save the value, then re‐open and save the version to which you want to apply the new security setting. Do this by right‐clicking on the version in the Admin console, click Next, then click Finish.

Field Description

Customizing Workflow 4-35

Page 162: Tm1 Workflow Administrators Guide En

Version Statuses Table of Contents | Index

Apply Cell Level Security This field determines whether cell‐level security is applied to tasks belonging to versions with this status. If this field is set to N, no cell‐level security is applied. If this setting is set to Y, cell‐level security is applied to any task that meets the following conditions:• The task belongs to a version that has the current status

applied. For example, if you are editing the version status In Progress, only tasks belonging to versions with a status of In Progress are affected by this setting.

• The version security setting is set to CELL. This setting appears in the Edit Version dialog box when you right-click a version and choose Edit.

If you change the value of this field, you must save the value, then re‐open and save the version to which you want to apply the new security setting. Do this by right‐clicking on the version in the Admin console, click Next, then click Finish.

Field Description

4-36 TM1 Workflow Administrator’s Guide

Page 163: Tm1 Workflow Administrators Guide En

Version Statuses Table of Contents | Index

4. Click Apply or OK to save your changes.

5. Right‐click each of your budget versions, and choose Edit.

6. Click Next, then click Finish.

Display in Toolbar Set this to Y or N. If this setting is Y, versions that have this status are displayed in the version list. If this parameter is set to N, versions with this status are not displayed in the version list.The version list is a drop‐down box on the Workflow toolbar.

Status The display string for the task status. In English installations, this string should be the same as the Status_English field. In German installations, this string should be the same as the Status_German field. In French installations, this string should be the same as the Status_French field. 

Field Description

Customizing Workflow 4-37

Page 164: Tm1 Workflow Administrators Guide En

Task Attributes Table of Contents | Index

Task Attributes

Task attributes are divided into two groups: design time attributes and run time attributes. Design time attributes can be set and modified by editing a task and review template. Run time attributes are set by Workflow. 

Design Time Attributes

The following table lists the design time attributes that ship with Workflow.

Field Description

Type There are two types of tasks: simple and delegatable.

Name Name of the task, such as Total Business Unit.

Security Group This is the TM1 group through which security is controlled. This group is assigned when you add the task to the task and review structure for the version.

Owner The owner of a task is the person responsible for completing the task. It is recommended that the owner be a member of the security group. Only an owner will be able to select a task from the Workflow menu.

Task A unique task id. This is a TM1 alias for the element identified by the Name field. This is generated by Workflow when you create the task. 

4-38 TM1 Workflow Administrator’s Guide

Page 165: Tm1 Workflow Administrators Guide En

Task Attributes Table of Contents | Index

Delegate SubjectDelegate Message

When you choose the task action Delegate, an email message is sent to the users participating in the the completion of the task. Workflow uses your default mail client. The Delete Subject is the subject of the mail message. The Delete Message is the message of the body text.

Submit SubjectSubmit Message

A mail message with this subject and message is sent when you submit a task.

Reject MessageReject Subject

A mail message with this subject and message is sent when you reject a task.

Approve MessageApprove Subject

A mail message with this subject and message is sent when you approve a task.

Complete MessageComplete Subject

A mail message with this subject and message is sent when you complete a simple task.

Revoke MessageRevoke Subject

A mail message with this subject and message is sent when you revoke a task.

Start MessageStart Subject

A mail message with this subject and message is sent when you start a task.

Field Description

Customizing Workflow 4-39

Page 166: Tm1 Workflow Administrators Guide En

Task Attributes Table of Contents | Index

Run Time Attributes

Task run time attributes are described in the following table. 

Source ElementSource Alias NameSource Dimension

The source dimension is the version dimension for the plan. The Source Element and Source Alias name is specified when you first create a new version.

WorkbookWorkbook PathWorksheet

This specifies the workbook, the path to the workbook file, and the sheet within the workbook for the task. 

Field Description

Status Contains the current status of the task.

<Action> Datetime fields These record the date and time that the specified action were performed on the task. For example, Submitted Datetime records the date and time that the task was submitted.

<Action> by fields These fields record the TM1 user ID that last performed the specified action. For example Submitted By records the name of the user that last submitted the task.

Field Description

4-40 TM1 Workflow Administrator’s Guide

Page 167: Tm1 Workflow Administrators Guide En

Task Attributes Table of Contents | Index

Attributes Added for Custom Actions

When you add a custom task action, the following attributes are added to Workflow.

Due Date The ending date on which the task must be completed. This field has not yet been implemented in Workflow.

Complete Comment A comment provided by the user that completed the task.

Submit Comment A comment provided by the user that submitted the task.

Reject Comment A comment provided by the user that rejected the task.

Approve Comment A comment provided by the user that approved the task.

Attribute Description

Design Time Attributes

<action_name>_Task_Action Subject Subject line for mail sent when the action occurs.

<action_name>_Task_Action Message Body text for the mail sent when the action occurs.

Run Time Attributes

Field Description

Customizing Workflow 4-41

Page 168: Tm1 Workflow Administrators Guide En

Task Attributes Table of Contents | Index

<action_name>_Task_Action User The user that performed the action.

<action_name>_Task_Action Datetime The date and time that the user performed the action.

<action_name>_Task_Action Comment The comment string provided by the user when the action was performed.

Attribute Description

4-42 TM1 Workflow Administrator’s Guide

Page 169: Tm1 Workflow Administrators Guide En

Table of Contents | Index

5 Using the Workflow Toolbar

This chapter describes how to use the Workflow toolbar. The Workflow toolbar includes a number of buttons and options that allow you to navigate between Excel workbooks, track your task statuses, take action on a task after you have completed modifying the spreadsheet data, and customize your Workflow environment.

This chapter assumes that all of the Workflow objects, security and navigation have been properly set up by your system administrator. The following topics are covered.

• Logging In to Workflow

• Loading the Task List

• Taking Action on Tasks

• The All Tasks Button

• Tracking Task Statuses

• Customizing Your Environment

Using the Workflow Toolbar 5-1

Page 170: Tm1 Workflow Administrators Guide En

Logging in to Workflow Table of Contents | Index

Logging in to Workflow

When you run Microsoft Excel with the Workflow adding loaded, the Workflow toolbar appears, as shown in the following figure.

Before you can work with your budget planning data, you must log in to TM1. To do this, you can log in through the Server Explorer, or you can log in through Workflow. To log in through Workflow, follow these steps:

1. Click Load. If you are not already logged in to Workflow, the following login dialog appears.

2. Choose a TM1 server from the Server ID list.

3. Enter your TM1 user name in the Client ID field. 

5-2 TM1 Workflow Administrator’s Guide

Page 171: Tm1 Workflow Administrators Guide En

Choosing Versions Table of Contents | Index

4. Enter your TM1 password in the Password field.

5. Click OK. If you logged in successfully, the following dialog box appears.

6. Click OK. The version list on the Workflow toolbar should populate with a list of budget versions that are active in your database.

Choosing Versions

The budget version list appears next to the Load button on the Workflow toolbar, as shown in the previous figure. There may be more than one version available to you, so click the version list and choose one of the available versions. Once you have chosen a version, the task list populates with a list of your tasks.

Version List Task List

Using the Workflow Toolbar 5-3

Page 172: Tm1 Workflow Administrators Guide En

Choosing Tasks Table of Contents | Index

Choosing Tasks

When you choose a budget version, the task list in the Workflow toolbar shows you all the tasks for which you are responsible. 

The tasks for which you are responsible are determined by your Workflow administrator when the task and review structure was built. Three sets of tasks appear in the task list:

• Tasks for which you are explicitly the owner.

• All tasks that are children of a task you own in the task and review structure.

• Tasks that you once owned that have been submitted back to the task delegator.

The following figure shows a task list for the version Q4_2005.

5-4 TM1 Workflow Administrator’s Guide

Page 173: Tm1 Workflow Administrators Guide En

Choosing Tasks Table of Contents | Index

When you select a task, Workflow opens the Excel workbook and worksheet for that task, and sets the SUBNM functions in the worksheet to values that are appropriate to the task.

Once the worksheet is displaying the appropriate data, you can fill in numbers for your task, or perform other analysis.

Using the Workflow Toolbar 5-5

Page 174: Tm1 Workflow Administrators Guide En

Task Actions Table of Contents | Index

Task Actions

When you have completed a task, you must choose a task action from the Workflow menu. Task actions do several things:

• They change the status of the task, so that other budget participants can see that you have finished the task.

• If you submit a task, the task is routed back to the delegator. This is usually a supervisor or someone higher in the task hierarchy. The delegator is responsible for reviewing the data you entered, and either accepting your numbers or rejecting them.

• It reduces the size of your task list. Once you have chosen to either Complete or Submit a task, that task is removed from your task list. The next time you load the task list, the completed task will not appear.

To take an action on a task, choose that action from the action list. The task action list is shown on the Workflow toolbar.

Task Action List and de-fault task action

Task ListVersion List

5-6 TM1 Workflow Administrator’s Guide

Page 175: Tm1 Workflow Administrators Guide En

The All Tasks List Table of Contents | Index

The All Tasks List

The All Tasks list appears next to the task action list on the Workflow toolbar. The following figure shows the All Tasks list.

The All Tasks list shows all the tasks that you own in all budget versions with a status of In Progress or Finished. The buttons on the All Tasks list allow you to browse Details of a task, or Select the task.

Using the Workflow Toolbar 5-7

Page 176: Tm1 Workflow Administrators Guide En

The All Tasks List Table of Contents | Index

Task Details

If you double‐click a task from the All Tasks list, or if you click a task and click Details, the Task Properties dialog box appears.

The Task Details dialog box lists information about the current state of the task, the date and time of task actions, the planning participants who have acted upon this task, and other information.

Click Close to return to the All Tasks dialog box.

5-8 TM1 Workflow Administrator’s Guide

Page 177: Tm1 Workflow Administrators Guide En

Version Status Table of Contents | Index

Version Status

The Version Status button is located next to the All Tasks button on the Workflow toolbar.

When you click the Status button, the Version Status dialog box appears:

Task Action List and de-fault task action

Version StatusTask List

Using the Workflow Toolbar 5-9

Page 178: Tm1 Workflow Administrators Guide En

Version Status Table of Contents | Index

This list shows all of the plans, versions and tasks that are currently available in your Workflow system. You can send a message to the group responsible for a particular task. Follow these steps:

1. Click the check box next to a task. The following figure shows the check boxes for the Direct and Indirect tasks.

NOTE: Click only the check boxes next to tasks. Check boxes next to plans and versions have no effect.

2. Click Alert. The default email client window appears. The budget partici‐pants 

3. Complete the email and send it.

5-10 TM1 Workflow Administrator’s Guide

Page 179: Tm1 Workflow Administrators Guide En

Customize Table of Contents | Index

Customize

Workflow allows you to customize certain parameters and system behavior. When you click the Customize button on the Workflow toolbar, the Client Attributes dialog box appears.

Using the Workflow Toolbar 5-11

Page 180: Tm1 Workflow Administrators Guide En

Customize Table of Contents | Index

The Name & Address tab has the following fields:

TM1 Workflow Tab

The TM1 Workflow tab has two fields:

• Display Data Saved Messages

• Save Data on Parameter Change

Display Data Saved Messages

Set this value to Yes or No.

If you set this value to Yes, when you change a value in the Workflow admin console and click Apply, a confirmation box appears telling you that the data has been saved. If you set this value to No, parameters are saved quietly when you click Apply.

Save Data on Parameter Change

Choose Never, Always, or Ask. This parameter applies to any dialog box change in the Workflow admin console. 

Field Description

Email Your email address. This is used by Workflow for sending alerts.

First Name Your first name.

Last Name Your last name.

5-12 TM1 Workflow Administrator’s Guide

Page 181: Tm1 Workflow Administrators Guide En

Customize Table of Contents | Index

For example, suppose you run the Workflow admin console and double‐click the Delegate Task Action object. The following dialog box appears:

You change Please Begin Working to Please Start Working. Then, before you click Apply, you choose the task action Submit from the list of Task Actions. One of three things happens:

Prompt for Saving Changes Result

Never The field you modified is not saved.

Always The field you modified is saved.

Ask Workflow asks you if you want to save the field.

Using the Workflow Toolbar 5-13

Page 182: Tm1 Workflow Administrators Guide En

Customize Table of Contents | Index

5-14 TM1 Workflow Administrator’s Guide

Page 183: Tm1 Workflow Administrators Guide En

Table of Contents | Index

A Workflow Execution Stack

This chapter describes all the events that occur in Workflow after a user clicks a task action. This chapter includes descriptions of how you can control and customize the execution sequence for your own environment.

The following topics are described:

• Customizing Actions

• The Workflow Execution Sequence

A-1

Page 184: Tm1 Workflow Administrators Guide En

Customizing Actions Table of Contents | Index

Customizing Actions

When a user clicks an action, an entire processing sequence occurs within Workflow. This sequence is customizable though the parameters described in the following table.

Parameter Description

Client Attributes If these are defined, they supercede the system options.

Pre_Ti This is the name of a TI process that runs before an action is processed.

Pre_TI_Return Set this parameter to Continue or Abort. If the Pre_Ti process throws an error, and the Pre_Ti_Return parameter is set to Abort, the entire task action is terminated.If Pre_Ti_Return parameter is set to Continue, processing continues for the task action regardless of whether the Pre_Ti process throws and error.This parameter allows you to stop execution of the task action if the Pre_Ti TurboIntegrator process throws an error.

Post_Ti This is the name of a TurboIntegrator process that runs after an action is processed.

A-2 TM1 Workflow Administrator’s Guide

Page 185: Tm1 Workflow Administrators Guide En

Customizing Actions Table of Contents | Index

Post_Ti_Return Set this parameter to Continue or Abort. If Workflow threw an error while processing the action, and the Post_Ti_Return parameter is set to Abort, the entire task action is terminated.If the Post_Ti process throws an error, and the Pre_Ti_Return parameter is set to Continue, the Post_Ti TurboIntegrator process runs.

System Options These are executed when the Client Attributes described above are undefined.

Pre Action TI Process This is the name of a TI process that runs before an action is processed.

Pre Action TI Return Set this parameter to Continue or Abort. If the Pre Action TI Process throws an error while processing the task action, and the Pre Action Ti Return parameter is set to Abort, the entire task action is terminated.If the Pre Action Ti Return parameter is set to Continue, the task action processing continues whether the Pre Action TI Process generates an error or not.This parameter allows you to stop execution of the task action if the Pre Action Ti TurboIntegrator process throws an error.

Parameter Description

A-3

Page 186: Tm1 Workflow Administrators Guide En

Customizing Actions Table of Contents | Index

Pre_TI Process Structure

Pre‐task and Post‐task TurboIntegrator processes that are added to the Task Action execution sequence must accept six string arguments from Workflow. Those arguments are listed in the following table.

Post Action TI Process This is the name of a TurboIntegrator process that run after Workflow processes the task action.

Post Action TI Return Set this parameter to Continue or Abort. If Workflow throws an error while processing the task action, and the Post Action Ti Return parameter is set to Abort, the entire task action is terminated.If Workflow throws an error, and the Post Action Ti Return parameter is set to Continue, the task action is completed normally.

Parameter Description

Action The name of the action, such as submit.

User The name of the user performing the action.

TaskType This argument is the word ‘Element’. This is used by some Workflow functions.

Task The Task ID.

Parameter Description

A-4 TM1 Workflow Administrator’s Guide

Page 187: Tm1 Workflow Administrators Guide En

Customizing Actions Table of Contents | Index

Error Handling and ProcessQuit

Parameters such as Post_Ti_Return allow you to test to see if the TurbIntegrator process that ran earlier in the sequence failed with an error. In order for a TurboIntegrator process to generate an error that can be detected in the sequence, you must use the TurboIntegrator function ProcessQuit.

Version The name of the plan version.

Plan The name of the plan.

Parameter Description

A-5

Page 188: Tm1 Workflow Administrators Guide En

The Workflow Execution Sequence Table of Contents | Index

The Workflow Execution Sequence

When a user clicks a task action from the Workflow Toolbar (such as Submit) the following sequence occurs.

1 Workflow Checks to See if You are Logged In

If you are not logged in, a login dialog box appears, allowing you to establish a connection with the Workflow server.

2 Workflow Determines The following information

• Task ID

• Version

• Plan

• Your TM1 User Name

3 Workflow Checks the DisplayConfirmMessage setting for the Action

If the DisplayConfirmMessage setting is Y, launch the comment dialog box.

If the user clicks cancel, the entire action is terminated. If the user enters a comment string, store the comment string.

4 Check to determine if a Pre-TI Process is associated with the User

If a Pre_TI process is associated with the current user, load the Pre_Ti_Return attribute for the task. If no Pre_Ti_Return client attribute exists, load the Pre Action TI Return system attribute.

A-6 TM1 Workflow Administrator’s Guide

Page 189: Tm1 Workflow Administrators Guide En

The Workflow Execution Sequence Table of Contents | Index

If no Pre_Ti process is associated with the current task, check to see if a Pre Action TI Process is established in the system options. If there is, load the Pre Action TI Return system attribute.

If no Pre_TI process or Pre Action TI Process is defined, skip to Step 6.

5 Execute the Pre-Ti process or the Pre Action TI process

If, after Step 4, Workflow runs a Pre_TI process, the following occurs:

The Pre_TI process runs. If the Pre_TI process returns an error and the setting for Pre_Ti_Return is not Continue, Workflow generates the error Error Executing Pre Task - Action Aborted, then terminates execution of the task action.

If the Pre_TI process runs successfully, or the setting for Pre_Ti_Return is Continue, Workflow completes the execution of the process and proceeds with Step 6.

If, after Step 4, Workflow runs a Pre Action TI process, the following occurs:

The Pre Action TI process runs. If the Pre Action TI process returns an error and the setting for Pre Action Ti Return is not Continue, Workflow generates the error Error Exciting Pre Task - Action Aborted, then terminates execution of the task action.

If the Pre Action TI process runs successfully, or the setting for Pre Action Ti Return is Continue, Workflow completes the execution of the process and proceeds with Step 6.

6 Collect Workflow Information

Workflow collects the following information:

A-7

Page 190: Tm1 Workflow Administrators Guide En

The Workflow Execution Sequence Table of Contents | Index

• The current time.

• The current status of the task for which the action is being performed.

• The current owner of the task.

• The owner of the current task’s parent in the Task and Review structure.

7 Determine Whether the Task is a Completable or Delegated Task

Workflow compares the task’s owner and the parent task’s owner. If the owner of the task and the owner of the task’s parent are the same or the task is the top task of the hierarchy, this is a completable (simple) task. If the owners are not the same, this is a delegated task.

8 Use the Workflow Matrix to Determine the New Task Status

The Workflow dialog box appears in the following figure.

A-8 TM1 Workflow Administrator’s Guide

Page 191: Tm1 Workflow Administrators Guide En

The Workflow Execution Sequence Table of Contents | Index

To determine the new task status, Workflow combines the following information:

• The type of user performing the task action (Owner or Delegator)

• The type of task (delegated or Completable)

• The Task Action Type

• The Current Task Status

From this information, Workflow determines the task status resulting from the action.

A-9

Page 192: Tm1 Workflow Administrators Guide En

The Workflow Execution Sequence Table of Contents | Index

9 Set Task Attributes Based On the New Status

If Step 8 results in any task status, Workflow sets the current task’s attributes to reflect this status, as follows:

• The Task’s Status attribute is set to the new status.

• The <Action> By attribute is set to the name of the user performing the action. For example, if this is a submit action, the Submit By attribute is set.

• The Action_Datetime attribute is set to the current time.

• If this is a user‐defined action, the <Action> User attribute is updated. For example if you are user planner and you run a custom action called execute, Workflow updates the execute planner attribute with your name.

10Update the Workflow Toolbar Structures and Data

Workflow updates control cubes. These control cubes are used to optimize toolbar performance within Workflow.

If the user chose to add a comment to the task, Workflow adds the text of the comment to the task attribute Action_Comment.

11 Check for a Post_TI Process

If a Post_TI process is associated with the current user, load the Post_Ti_Return attribute for the task. If no Post_Ti_Return client attribute exists, load the Post Action TI Return system attribute.

If no Post_Ti process is associated with the current task, check to see if a Post Action TI Process is established in the system options. If there is, load the Post Action TI Return system attribute.

A-10 TM1 Workflow Administrator’s Guide

Page 193: Tm1 Workflow Administrators Guide En

The Workflow Execution Sequence Table of Contents | Index

If no Post_TI process or Post Action TI Process is defined, skip to Step 8.

12Execute the Post-Ti process or the Post Action TI process

If, after Step 11, Workflow runs a Post_TI process, the following occurs:

The Post_TI process runs. If the Post_TI process returns an error and the setting for Post_Ti_Return is not Continue, Workflow generates the error Error Executing Post Task - Action Aborted, then terminates execution of the task action.

If the Post_TI process runs successfully, or the setting for Post_Ti_Return is Continue, Workflow completes the execution of the process and proceeds with Step 13.

If, after Step 11, Workflow runs a Post Action TI process, the following occurs:

The Post Action TI process runs. If the Post Action TI process returns an error and the setting for Post Action Ti Return is not Continue, Workflow generates the error Error Executing Post Task - Action Aborted, then terminates execution of the task action.

If the Post Action TI process runs successfully, or the setting for Post Action Ti Return is Continue, Workflow completes the execution of the process and proceeds with Step 13.

13Process Email

Email is sent if the user enables the Send Email check box when they add comments to the task. If they do this, launch the default system mail client.

A-11

Page 194: Tm1 Workflow Administrators Guide En

The Workflow Execution Sequence Table of Contents | Index

Add the comments for the task to the mail message. If there are no comments, set up the email message according to the message template established in the Design Time system attributes.

14Reload Task Dropdown on the Workflow Toolbar

When a task action is executed, frequently a task will be routed from one user to another. For example, when a user submits a delegated task, the task is routed to the task’s delegator for approval. 

Workflow determines if, after the action is completed, the task should remain in the current user’s toolbar. If appropriate, the task is removed.

A-12 TM1 Workflow Administrator’s Guide

Page 195: Tm1 Workflow Administrators Guide En

Table of Contents | Index

B Workflow Architecture

This chapter contains diagrams and tables that describe the changes to Workflow objects during a typical user session. These diagrams are helpful if you are trying to customize Workflow, and you need to understand the underlying structure of the product.

The following topics are described:

• Creating a Template ‐ Before Template Creation

• Creating a Template ‐ After Template Creation

• Creating a Plan ‐ Before Plan Creation

• Creating a Plan ‐ Dimensions After Plan Creation

• Creating a Plan ‐ Cubes After Plan Creation

• Creating a Version

• Creating a Task

• Object Map

• Action Map

B-1

Page 196: Tm1 Workflow Administrators Guide En

Creating a Template - Before Template Creation Table of Contents | Index

Creating a Template - Before Template Creation

B-2 TM1 Workflow Administrator’s Guide

Page 197: Tm1 Workflow Administrators Guide En

Creating a Template - After Template Creation Table of Contents | Index

Creating a Template - After Template Creation

B-3

Page 198: Tm1 Workflow Administrators Guide En

Creating a Plan - Before Plan Creation Table of Contents | Index

Creating a Plan - Before Plan Creation

B-4 TM1 Workflow Administrator’s Guide

Page 199: Tm1 Workflow Administrators Guide En

Creating a Plan - Dimensions After Plan Creation Table of Contents | Index

Creating a Plan - Dimensions After Plan Creation

B-5

Page 200: Tm1 Workflow Administrators Guide En

Creating a Plan - Cubes After Plan Creation Table of Contents | Index

Creating a Plan - Cubes After Plan Creation

B-6 TM1 Workflow Administrator’s Guide

Page 201: Tm1 Workflow Administrators Guide En

Creating a Version Table of Contents | Index

Creating a Version

B-7

Page 202: Tm1 Workflow Administrators Guide En

Creating a Task Table of Contents | Index

Creating a Task

B-8 TM1 Workflow Administrator’s Guide

Page 203: Tm1 Workflow Administrators Guide En

Object Map Table of Contents | Index

Object Map

The tables in this section provide a map between Workflow user‐interface structures and the TM1 objects that support them. These structures compose the underlying structure of Workflow, and should not be modified.

System Logical Object Physical Objects

Version Status Dimension: }sm_version_statusThis dimension is provided with the Workflow installation.Ι t is maintained through the Workflow Administration Console.AttributesDisplay In Status Tree (Y\N)Display In All Tasks (Y\N)Element Level Security (READ\WRITE\NONE or blank)Apply Cell Level Security (Y\N)Display In ToolBar (Y\N)Status (Alias)

Task Action Dimension: }sm_task_actionThis dimension is provided with the Workflow installation.Ι t is maintained through the Workflow Administration Console.AttributesDisplayConfirmMessage (Y\N)Message SubjectAction (Alias)

B-9

Page 204: Tm1 Workflow Administrators Guide En

Object Map Table of Contents | Index

Task Status Dimension }sm_task_statusThis dimension is provided with the Workflow installation.Ι t is maintained through the Workflow Administration Console.AttributesDisplay In ToolBar (Y\N)Status (Alias)Default for Owner Complete (a task action)Delegator Security (READ\WRITE\NONE or blank)Owner Security (READ\WRITE\NONE or blank)Default for Delegator (a task action)Default for Owner (a task action)

Task Attribute See Task above

System Properties Dimension }sm_client_propertiesThis dimension is provided with the Workflow installation.Ι t is maintained through the Workflow Administration Console.AttributesProperty (Alias)Admin Update (Y\N)Client Update (Y\N)Default Value

System Logical Object Physical Objects

B-10 TM1 Workflow Administrator’s Guide

Page 205: Tm1 Workflow Administrators Guide En

Object Map Table of Contents | Index

User Properties Cube }appClientPropertiesThis cube is provided with the Workflow installation.It is maintained through the Workflow Administration Console, and the End User Configuration Window.Dimensions}Clients}appClientProperties (Email1, First name, Last name)

Cube }sm_client_propertiesThis cube is provided with the Workflow installation.It is maintained through the Workflow Administration Console, and the End User Configuration Window.Dimensions}Clients}sm_client_properties (Measures )Each element of }sm_client_properties

System Logical Object Physical Objects

B-11

Page 206: Tm1 Workflow Administrators Guide En

Object Map Table of Contents | Index

Workflow Cube }sm_task_status_actionThis cube is provided with the Workflow installation.It is maintained through the Workflow Administration Console, and the End User Configuration Window.

Dimensions}sm_user_role (Owner or Delegator)}sm_task_action (from task action)}sm_task_status (from task status)}sm_task_type (Complete or Delegate)}sm_task_status_action_measures (Measures)

New Action – Holds the task action result of the above combination

ViewsSm_complete_delegatorSm_complete_ownerSm_delegate_delegatorSm_delegate_owner

System Logical Object Physical Objects

B-12 TM1 Workflow Administrator’s Guide

Page 207: Tm1 Workflow Administrators Guide En

Object Map Table of Contents | Index

System Logical Object Physical Objects

Version Status Dimension: }sm_version_statusThis dimension is provided with the Workflow installation.Ι t is maintained through the Workflow Administration Console.AttributesDisplay In Status Tree (Y\N)Display In All Tasks (Y\N)Element Level Security (READ\WRITE\NONE or blank)Apply Cell Level Security (Y\N)Display In ToolBar (Y\N)Status (Alias)

Task Action Dimension: }sm_task_actionThis dimension is provided with the Workflow installation.Ι t is maintained through the Workflow Administration Console.AttributesDisplayConfirmMessage (Y\N)Message SubjectAction (Alias)

B-13

Page 208: Tm1 Workflow Administrators Guide En

Object Map Table of Contents | Index

Task Status Dimension }sm_task_statusThis dimension is provided with the Workflow installation.Ι t is maintained through the Workflow Administration Console.AttributesDisplay In ToolBar (Y\N)Status (Alias)Default for Owner Complete (a task action)Delegator Security (READ\WRITE\NONE or blank)Owner Security (READ\WRITE\NONE or blank)Default for Delegator (a task action)Default for Owner (a task action)

Task Attribute See Task above

System Properties Dimension }sm_client_propertiesThis dimension is provided with the Workflow installation.Ι t is maintained through the Workflow Administration Console.AttributesProperty (Alias)Admin Update (Y\N)Client Update (Y\N)Default Value

System Logical Object Physical Objects

B-14 TM1 Workflow Administrator’s Guide

Page 209: Tm1 Workflow Administrators Guide En

Object Map Table of Contents | Index

User Properties Cube }appClientPropertiesThis cube is provided with the Workflow installation.It is maintained through the Workflow Administration Console, and the End User Configuration Window.Dimensions}Clients}appClientProperties (Email1, First name, Last name)

Cube }sm_client_propertiesThis cube is provided with the Workflow installation.It is maintained through the Workflow Administration Console, and the End User Configuration Window.Dimensions}Clients}sm_client_properties (Measures )Each element of }sm_client_properties

System Logical Object Physical Objects

B-15

Page 210: Tm1 Workflow Administrators Guide En

Object Map Table of Contents | Index

Workflow Cube }sm_task_status_actionThis cube is provided with the Workflow installation.It is maintained through the Workflow Administration Console, and the End User Configuration Window.

Dimensions}sm_user_role (Owner or Delegator)}sm_task_action (from task action)}sm_task_status (from task status)}sm_task_type (Complete or Delegate)}sm_task_status_action_measures (Measures)

New Action – Holds the task action result of the above combination

ViewsSm_complete_delegatorSm_complete_ownerSm_delegate_delegatorSm_delegate_owner

System Logical Object Physical Objects

B-16 TM1 Workflow Administrator’s Guide

Page 211: Tm1 Workflow Administrators Guide En

Action Map Table of Contents | Index

Action Map

The following table lists each user action allowed by Workflow, and the Workflow objects that are affected by the action.

User Actions Logical Objects Affected

Admin Install See above

Admin Create Plan Plan, Version, Template, Task

Admin Update Plan Plan

Admin Delete Plan Plan, Version, Task

Admin Create Version Plan, Version, Task

Admin Update Version Version, Task

Admin Delete Version Plan, Version, Task

Admin Create Template Template

Admin Update Template Template, Task

Admin Delete Template Template, Task

Admin Create Task Action Task Actions, All Versions, All Templates, Workflow

B-17

Page 212: Tm1 Workflow Administrators Guide En

Action Map Table of Contents | Index

Admin Create Task Status Task Status, Workflow

End User Execute Any Action from the toolbar or menu

Task

User Actions Logical Objects Affected

B-18 TM1 Workflow Administrator’s Guide

Page 213: Tm1 Workflow Administrators Guide En

Table of Contents | Index

Index

Symbols# 2‐23* 2‐23_ 2‐23

AAlert button 1‐30application environment parameters

system options 4‐3Task Actions 4‐2task attributes 4‐2task statuses 4‐2user options 4‐3version statuses 4‐2

Apply Cell Level Security 4‐36Approve (task action) 4‐17assignments, multiple 1‐18

Bbinding address template 2‐2binding address template field

special characters 2‐22BLOB 4‐14budget responsibility

assigning 1‐20, 3‐11budget version 1‐3

components of 1‐10creating 1‐11–1‐27task and review structure 1‐10task statuses 1‐10

budget versionsnotes 1‐10

Ccell level security 2‐27, 2‐33client attributes 5‐11client properties

email 1‐45Client Properties dialog box 4‐4Complete (task action) 4‐17cubes

planning 1‐3

DDBRW functions 2‐3Default for Delegator 4‐30Default for owner 4‐31Default for Owner Complete 4‐28

Index 1

Page 214: Tm1 Workflow Administrators Guide En

Table of Contents | Index

Delegate (task action) 4‐17Delegator Security 4‐29Display Data Saved Messages 5‐12Display in All Tasks 4‐35Display in Status Tree 4‐35Display in Toolbar 4‐37due date

for version 1‐26

EElement Level Security 4‐35email

alert button 1‐30client property 1‐45messages for a task 1‐40sending notifications 1‐27setting email addresses 1‐44task actions 1‐32task attributes 1‐40template setup 1‐33when email is sent 1‐32

email template setup dialog box 1‐33

Hhelp text

setting for a user 4‐10setting for an administrator 4‐14

hierarchyorganizational 1‐4

task and review 1‐4

LLogging in to Workflow 5‐2

Mmultiple assignments 1‐18

Nnamed range navigation

binding address template 2‐2DBRW functions 2‐3defined 2‐2setting up 2‐18–2‐26

named rangesDBRW functions 2‐26

navigationadding to a task 2‐12, 2‐13defining for planning worksheets 2‐7editing 2‐13, 2‐18title dimension 2‐12workbook 2‐13

notes 1‐10

Oorganizational hierarchy 1‐4Owner Security 4‐30

2 TM1 Workflow Administrator’s Guide

Page 215: Tm1 Workflow Administrators Guide En

Table of Contents | Index

Pplanning cubes 1‐3Prompt For Saving Changes 5‐12

RReject (task action) 4‐17Revoke (task action) 4‐17

SSave Data on Parameter Change 5‐12security 1‐26, 2‐27

as applied per task status 2‐29cell level 2‐27, 2‐33cell‐level 2‐30modifying 2‐30version 2‐27

}sm_templates dimension 1‐10Start (task action) 4‐17start date

for version 1‐26Status 4‐31Submit (task action) 4‐17SUBNM navigation

defined 2‐1editing an existing assignment 2‐13setting up 2‐5–2‐13

subset editor, tm1 2‐32system options 4‐3

Ttask actions 4‐2

toolbar option 4‐17task and review hierarchy 1‐3, 1‐4task and review templates 1‐4

defined 1‐9task attributes 4‐2

design time 4‐38run time 4‐40

task details 5‐8task status properties 4‐27

Default for Delegator 4‐30Default for owner 4‐31Default for Owner Complete 4‐28Delegator Security 4‐29Owner Security 4‐30Status 4‐31

task statuses 4‐25tasks 1‐5

actions 1‐9attributes 1‐9defined 1‐5delegated 1‐7owner 1‐7properties and characteristics of 1‐7security group 1‐9simple 1‐7status 1‐9types 1‐7

Index 3

Page 216: Tm1 Workflow Administrators Guide En

Table of Contents | Index

templates 1‐9templates, task and review 1‐4toolbar, Workflow

All Tasks list 5‐7customize button 5‐11load button 5‐2task actions 5‐6task list 5‐4version status 5‐9

Uuser options 4‐3

Vversion dimension 1‐3Version Security Settings 1‐26version status

setting 1‐25Version Status options 1‐25version status properties

Apply Cell Level Security 4‐36Display in All Tasks 4‐35Display in Status Tree 4‐35Display in Toolbar 4‐37Element Level Security 4‐35status 4‐37

version statuses 4‐2adding 4‐33changing 4‐32

finished 4‐32in progress 4‐32inactive 4‐32under development 4‐32

Wworkbook, Excel

editing navigation 2‐18workbooks, Excel

in TM1 applications 2‐16private 2‐16

Workflowaffects on your business data 1‐2overview 1‐2required structures 1‐3toolbar 5‐1

workflow button 4‐25–??worksheets

navigating 2‐13

4 TM1 Workflow Administrator’s Guide


Recommended