Professional Documents
Culture Documents
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
Table of Contents | Index
Table of Contents
Table of Contents 1
Table of Contents | Index
Chapter 3 Workflow
Administration Console
TM1 Workflow Administration Console . . . . . . . . . . . . . . . . . . . . . . 3‐2
Adding a Task and Review Template . . . . . . . . . . . . . . . . . . . . . . 3‐3
Assigning Budget Responsibility and Task Security. . . . . . . . . 3‐11
Adding a Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐17
Adding a Version to a Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐23
Building a Version From Another Version . . . . . . . . . . . . . . . . . 3‐24
Building a Version From a Task and Review Template . . . . . . 3‐27
Table of Contents 3
Table of Contents | Index
Task Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐6
The All Tasks List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐7
Task Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐8
Version Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐9
Customize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐11
TM1 Workflow Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐12
Check for a Post_TI Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A‐10
Execute the Post‐Ti process or the Post Action TI process . . . .A‐11
Process Email. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A‐11
Reload Task Dropdown on the Workflow Toolbar . . . . . . . . . .A‐12
Table of Contents 5
Table of Contents | Index
Preface
ix
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.
Audience
This guide is intended for TM1 server administrators and anyone developing
planning and budgeting applications with TM1.
Related Documentation
The 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
support.login@cognos.com.
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.
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
Table of Contents | Index
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.
Italics Words are italicized for emphasis or to draw your attention
to a new term. For example, “Do not press the RETURN
key.”
Finding Information
To 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.
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 Help
For 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.
Preface xiii
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.
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.
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:
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.
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:
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.
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
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.
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:
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.
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.
Total Business Unit consolidation dragged to the Task and Review Structure panel.
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.
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.
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.
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.
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.
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.
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:
• 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.
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.
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.
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.
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.
•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.
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.
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.
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.
3. Click Alert. Your default email client appears.
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 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.
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.
5. Click . The following dialog box appears.
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.
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.
5. Click OK.
1. Click Submit. The following dialog box appears:
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:
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.
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.
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.
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.
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.
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
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.
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.
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.
4. Click in the cell B6.
5. Enter the following formula in that cell:
=sum(My_define+3)
The following figure shows the result.
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.
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:
To set up this navigation, follow these steps:
1. Choose TM1 →Workflow →Admin from the Excel menubar. The TM1 Work-
flow Administration Console appears.
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.
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.
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.
The following sections describe how to apply or edit navigation in the
Security and Navigation screen.
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.
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.
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.
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
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. Use the file browser in the top panel locate the workbook you want to use
for task navigation.
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.
4. Choose a sheet from the Worksheet option box.
5. Click OK.
6. Click Close.
7. Click Next.
8. Click Finish.
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.
To edit an existing workbook navigation assignment so that a task uses a
different workbook:
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.
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.
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.
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.
values of a set of named ranges. Use the *, #, and _ characters. The following
table shows some example of how these are used.
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.
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.
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:
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.
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.
Cell‐level security is applied when the version status is In Progress. The
security privilege applied is based on the current task status.
The following table describes which cell‐level security is applied for a given
task status for specific Workflow users.
Owner Read
Owner Write
Owner Read
Owner Write
Owner Read
Owner None
Owner Read
Owner None
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.
Version
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.
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.
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.
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
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
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.
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:
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‐
5. Choose another dimension from the Dimension list.
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.
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.
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.
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.
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.
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.
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 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
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.
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.
The Workflow wizard adds the new task and review template to the
administration console.
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:
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.
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.
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.
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.
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.
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.
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.
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
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.
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.
6. Click Next. The following dialog box appears.
7. Click a task and review template. Click Next.
8. The Edit Version dialog box appears.
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.
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.
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
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
• 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.
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.
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.
• 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.
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:
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.
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.
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.
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.
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.
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.
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.
10. Click OK.
11. Right‐click each of your budget versions, and choose Edit.
12. Click Next.
13. Click Finish.
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.
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.
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.
You can add your own task actions to Workflow. The following procedure
shows how to add an action called execute. Follow these steps:
1. Run the Workflow Administration console.
2. Right‐click Task Actions and choose Insert New Task Action.
4. Click OK. The Task Action dialog box appears.
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.
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.
9. Click OK. The new task action should appear in the task action list.
New execute
Task action.
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.
12. Click Close.
You should now be able to use your new task action as part of your planning
process.
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.
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.
• The task status is Completed.
• The user performs a Revoke on the task.
When you double‐click a task status in the Workflow administration console,
the Task Properties dialog appears:
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.
Default Action
Action List
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
Field Description
Field Description
Field Description
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.
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
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.
Fill in the fields in this dialog box according to the following table:
Field Description
Field Description
The version status tree is available from the
button on the Workflow toolbar.
Field Description
Field Description
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.
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.
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.
The following table lists the design time attributes that ship with Workflow.
Field Description
Type There are two types of tasks: simple and delegatable.
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.
Field Description
Field Description
Workbook This specifies the workbook, the path to the workbook file,
Workbook Path and the sheet within the workbook for the task.
Worksheet
Task run time attributes are described in the following table.
Field Description
Status Contains the current status of the task.
Field Description
When you add a custom task action, the following attributes are added to
Workflow.
Attribute Description
<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.
Attribute Description
<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.
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.
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.
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.
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.
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.
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.
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.
Version Status
When you click the Status button, the Version Status dialog box appears:
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.
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.
Field Description
Email Your email address. This is used by Workflow for sending
alerts.
The TM1 Workflow tab has two fields:
• Display Data Saved Messages
• Save Data on Parameter Change
For example, suppose you run the Workflow admin console and double‐click
the Delegate Task Action object. The following dialog box appears:
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.
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
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
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.
Parameter Description
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.
A-3
Customizing Actions Table of Contents | Index
Parameter Description
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.
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
Version The name of the plan version.
Plan The name of the plan.
A-5
The Workflow Execution Sequence Table of Contents | Index
When a user clicks a task action from the Workflow Toolbar (such as Submit)
the following sequence occurs.
If you are not logged in, a login dialog box appears, allowing you to establish a
connection with the Workflow server.
• Task ID
• Version
• Plan
• Your TM1 User Name
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.
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.
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.
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.
Workflow collects the following information:
A-7
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.
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.
The Workflow dialog box appears in the following figure.
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
The Workflow Execution Sequence Table of Contents | Index
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.
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.
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.
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.
13 Process 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
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.
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.
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
Creating a Template - Before Template Creation Table of Contents | Index
B-3
Creating a Plan - Before Plan Creation Table of Contents | Index
B-5
Creating a Plan - Cubes After Plan Creation Table of Contents | Index
Creating a Version
B-7
Creating a Task Table of Contents | Index
Creating a Task
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.
B-9
Object Map Table of Contents | Index
Cube }sm_client_properties
This 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
B-11
Object Map Table of Contents | Index
Workflow Cube }sm_task_status_action
This 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
Views
Sm_complete_delegator
Sm_complete_owner
Sm_delegate_delegator
Sm_delegate_owner
B-13
Object Map Table of Contents | Index
Cube }sm_client_properties
This 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
B-15
Object Map Table of Contents | Index
Workflow Cube }sm_task_status_action
This 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
Views
Sm_complete_delegator
Sm_complete_owner
Sm_delegate_delegator
Sm_delegate_owner
Action Map
The following table lists each user action allowed by Workflow, and the
Workflow objects that are affected by the action.
B-17
Action Map Table of Contents | Index
Index
Symbols assigning 1‐20, 3‐11
# 2‐23 budget version 1‐3
* 2‐23 components of 1‐10
_ 2‐23 creating 1‐11–1‐27
task and review structure 1‐10
A task statuses 1‐10
Alert button 1‐30 budget versions
application environment parameters notes 1‐10
system options 4‐3
Task Actions 4‐2 C
task attributes 4‐2 cell level security 2‐27, 2‐33
task statuses 4‐2 client attributes 5‐11
user options 4‐3 client properties
version statuses 4‐2 email 1‐45
Apply Cell Level Security 4‐36 Client Properties dialog box 4‐4
Approve (task action) 4‐17 Complete (task action) 4‐17
assignments, multiple 1‐18 cubes
planning 1‐3
B
binding address template 2‐2 D
binding address template field DBRW functions 2‐3
special characters 2‐22 Default for Delegator 4‐30
BLOB 4‐14 Default for owner 4‐31
budget responsibility Default for Owner Complete 4‐28
Index 1
Table of Contents | Index
Delegate (task action) 4‐17 task and review 1‐4
Delegator Security 4‐29
Display Data Saved Messages 5‐12 L
Display in All Tasks 4‐35 Logging in to Workflow 5‐2
Display in Status Tree 4‐35
Display in Toolbar 4‐37 M
due date multiple assignments 1‐18
for version 1‐26
N
E named range navigation
Element Level Security 4‐35 binding address template 2‐2
email DBRW functions 2‐3
alert button 1‐30 defined 2‐2
client property 1‐45 setting up 2‐18–2‐26
messages for a task 1‐40 named ranges
sending notifications 1‐27 DBRW functions 2‐26
setting email addresses 1‐44 navigation
task actions 1‐32 adding to a task 2‐12, 2‐13
task attributes 1‐40 defining for planning worksheets 2‐7
template setup 1‐33 editing 2‐13, 2‐18
when email is sent 1‐32 title dimension 2‐12
email template setup dialog box 1‐33 workbook 2‐13
notes 1‐10
H
help text O
setting for a user 4‐10 organizational hierarchy 1‐4
setting for an administrator 4‐14 Owner Security 4‐30
hierarchy
organizational 1‐4
P T
planning cubes 1‐3 task actions 4‐2
Prompt For Saving Changes 5‐12 toolbar option 4‐17
task and review hierarchy 1‐3, 1‐4
R task and review templates 1‐4
Reject (task action) 4‐17 defined 1‐9
Revoke (task action) 4‐17 task attributes 4‐2
design time 4‐38
S run time 4‐40
Save Data on Parameter Change 5‐12 task details 5‐8
security 1‐26, 2‐27 task status properties 4‐27
as applied per task status 2‐29 Default for Delegator 4‐30
cell level 2‐27, 2‐33 Default for owner 4‐31
cell‐level 2‐30 Default for Owner Complete 4‐28
modifying 2‐30 Delegator Security 4‐29
version 2‐27 Owner Security 4‐30
}sm_templates dimension 1‐10 Status 4‐31
Start (task action) 4‐17 task statuses 4‐25
start date tasks 1‐5
for version 1‐26 actions 1‐9
Status 4‐31 attributes 1‐9
Submit (task action) 4‐17 defined 1‐5
SUBNM navigation delegated 1‐7
defined 2‐1 owner 1‐7
editing an existing assignment 2‐13 properties and characteristics of 1‐7
setting up 2‐5–2‐13 security group 1‐9
subset editor, tm1 2‐32 simple 1‐7
system options 4‐3 status 1‐9
types 1‐7
Index 3
Table of Contents | Index
templates 1‐9 finished 4‐32
templates, task and review 1‐4 in progress 4‐32
toolbar, Workflow inactive 4‐32
All Tasks list 5‐7 under development 4‐32
customize button 5‐11
load button 5‐2 W
task actions 5‐6 workbook, Excel
task list 5‐4 editing navigation 2‐18
version status 5‐9 workbooks, Excel
in TM1 applications 2‐16
U private 2‐16
user options 4‐3 Workflow
affects on your business data 1‐2
V overview 1‐2
version dimension 1‐3 required structures 1‐3
Version Security Settings 1‐26 toolbar 5‐1
version status workflow button 4‐25–??
setting 1‐25 worksheets
Version Status options 1‐25 navigating 2‐13
version status properties
Apply Cell Level Security 4‐36
Display in All Tasks 4‐35
Display in Status Tree 4‐35
Display in Toolbar 4‐37
Element Level Security 4‐35
status 4‐37
version statuses 4‐2
adding 4‐33
changing 4‐32