Install
TM1 Installation Guide 9.4.1
Introduction
TM1 Installation Overview
Installation Checklist
TM1 Service Account
.NET Framework Requirements
Microsoft ASP.NET Framework 3.0 is not Registered
Enable TM1 Excel Service
ASPNET User is not Defined
Logging Installation Messages
Installing Components on Different Machines
Important Notes on Distributed Installations
Starting the Installation Wizard
Accept the License Agreement
Choose a Product to Install
Microsoft Framework Reminder
Custom or Standard Installation Options
Installation Location
Selecting Components to Install
Installing TM1
Custom TM1 Installation
Custom TM1 Components
Configuring TCP/IP Ports for TM1
Username and Password for TM1 Services
Installing TM1 on Networks without Domains
Security Settings
Integrated Login Modes
Configuring the TM1 Server
Configuring TM1 Clients
Begin the Installation
Post-Installation Tasks
Standard TM1 Installation
Installing TM1 Perspectives
Custom TM1 Perspectives Installation
Configuring TM1 Perspectives
Standard TM1 Perspectives Installation
Installing TM1 Web
Custom TM1 Web Installation
Configuring TM1 Web Components
Configuring TCP/IP Ports for TM1 Web
Username and Password for TM1 Services
Security Settings
Configuring the TM1 Server
Configuring TM1 Clients
Configuring Web Components
Standard TM1 Web Installation
Installing TM1 for 64-bit Windows
Custom 64-bit TM1 Installation
Configuring TCP/IP Ports for 64-bit TM1
Username and Password
Security Settings
Configuring the 64-bit TM1 Server
Standard 64-bit Installation
Installing TM1 x86 on a x64 Windows System
WOW64 (32-bit) Application Space
Installation Notes about TM1 Components
Importance of Installation Order
Location of Installed TM1 Program Files
Naming Conventions for x86 and x64 TM1 Services
Installing TM1 x86 in Windows x64
Running the TM1 Database with Both x86 and x64 TM1 Servers
Installing TM1 on UNIX
Pre-Installation Tasks
UNIX Installation Checklist
UNIX Compatible Components
Starting the Installation Wizard
Select a Language
Select TM1 UNIX Components
Accept the License Agreement
Set the Installation Location
Configure TCP/IP Ports
TM1 Server Configuration
Installation Summary
After You Complete the Installation
S89IBM_TM1 Startup Script
Uninstalling UNIX TM1
Silent UNIX Installation
Console Installation
Starting a UNIX TM1 Server
Running the UNIX TM1 Server in Background Mode
Installing TM1 Workflow
Workflow Prerequisites
Licensing
Running the Workflow Installation Wizard
Selecting Workflow Installation Components
Workflow Components
Destination Folder for Workflow Components
Installing Workflow for the First Time
Installing Workflow for One Existing TM1 Database
Installing Workflow for Multiple TM1 Databases
Upgrading to Workflow from Planning Manager 1.3
Upgrading Planning Manager for One Existing TM1 Database
Upgrading Planning Manager for Multiple TM1 Databases
Configuring Workflow for Excel
Troubleshooting the Workflow Excel Add-in
Using Workflow with TM1 Web
Workflow On The Web
Workflow Features in TM1 Web
Localizing TM1 Web Toolbar Captions
Using IBM Cognos 8 Security with TM1
IBM Cognos 8 Security Overview
Setting Up a TM1 Server to Use IBM Cognos 8 Security
Configuring the TM1 Server
Configuring the TM1 Client
Defining a Cognos User to Function as a TM1 Administrator
Importing Cognos Groups into TM1
Creating Users
Administering TM1 Object Security
Configuring TM1 Web to Use IBM Cognos 8 Security
Logging in to TM1 Top
User Considerations When Using IBM Cognos 8 Authentication
Installing TM1 Viewer Portlets for IBM Cognos 8 Portal Services
Configure TM1 to use IBM Cognos 8 Security
Install the TM1 Viewer Portlets
Configure Access to IBM Cognos 8 From the TM1 Viewer Portlets
Uninstall the TM1 Viewer Portlets
Maintaining and Upgrading Your TM1 Installation
Maintaining TM1 Components
Modify Components
Repair the TM1 Installation
Remove TM1
Upgrading TM1
Backing Up Your TM1 Data
Restoring Your TM1 Database
Administer and Deploy
TM1 Operations Guide 9.4.1
Introduction
TM1 System Architecture
TM1 Architecture
TM1 Admin Server
Running the Windows Admin Server
Running the UNIX Admin Server
Specifying the Location of the Admin Host
Specifying Multiple Admin Hosts
TM1 Files
Data Directory
Specifying the Location of the Data Directory
Specifying Multiple Data Directories
Required Network Access
TM1 System Configuration
The Tm1s.cfg File
Location of the Tm1s.cfg File
Sample Tm1s.cfg File
Parameters in the Tm1s.cfg File
The Tm1p.ini File
Location of the TM1p.ini File
Parameters of the TM1p.ini File
Remote Server Operations
Overview of Remote Server Operations
Setting Up a Remote TM1 Server to Run as an Application
Setting Up a Remote TM1 Server to Run as a Windows Service
Installing a TM1 Server to Run as a Windows Service
Removing a TM1 Server from Running as a Windows Service
Starting a Remote TM1 Server
Starting a TM1 Server Set Up as a Windows Application
Starting a TM1 Server Installed as a Windows Service
Starting a UNIX TM1 Server
Connecting to a Remote Server
Refreshing the List of Remote Servers
Re-Setting the Admin Host
Re-Setting Local Server Options
Disconnecting from a Remote Server
Shutting Down a Windows TM1 Server
Shutting Down a Windows TM1 Server Running as a Service
Shutting Down a UNIX TM1 Server
Shutting Down a UNIX TM1 Server Running in Background Mode
Logging Transactions
Data Backup and Recovery
Enabling and Disabling Logging
Viewing the Transaction Log
Backing Out Records from the Transaction Log
Removing Log Files from the Disk
Monitoring Server Performance
Managing Client Connections
Broadcasting Messages to Clients
Disconnecting Clients from the Server
Shutting Down a Server Remotely
Remote Server Memory Management
About Stargate Views
Replicating Cubes
Replication Overview
Relationships Created by Replication
Required Access Privileges
Admin Server Considerations
Configuring the Tm1s.cfg File to Support Replication
Maintaining Replication Connections
Creating a Replication Connection
Modifying a Replication Connection
Deleting a Replication Connection
Replication Process
Replicating a Cube
Specifying Information about the Replicated Cube
What Happens when TM1 Replicates a Cube
Synchronization Process
Synchronizing on Demand
Scheduling Synchronization
System and Performance Monitoring
Overview of TM1 System and Performance Monitoring
Using the Admin Server Log
Message Severity Levels for Admin Server Logging
Configuring Admin Server Logging
Enabling Admin Server Logging
Viewing the Admin Server Log File
Logging Transactions
Data Backup and Recovery
Enabling and Disabling Logging
Viewing the Transaction Log
Backing Out Records from the Transaction Log
Removing Log Files from the Disk
Troubleshooting: Recovering from a Corrupt Transaction Log File
Using the TM1 Server Message Log
Message Severity Levels
TM1 Loggers
Logging Properties File
Configuring and Enabling Logging
Viewing the TM1 Server Message Log
Using the Audit Log
Understanding Audit Log Events
Configuring Audit Logging
Updating the Audit Log with the Latest Events
Using the Audit Log Window to View Log Messages
Monitoring Server Performance Using Control Cubes
Enabling Performance Monitoring
Disabling Performance Monitoring
Viewing Performance Statistics for Clients, Cubes, and Servers
Using the TM1 Top Utility
Installing TM1 Top
Configuring the Tm1top.ini File
Running TM1 Top
Viewing and Understanding the TM1 Top Display
TM1 Top Commands
Canceling a Thread's Processing
Using TM1 Performance Counters
Important Notes about Running TM1 Performance Counter Tools
Available TM1 Performance Counters
Viewing TM1 Performance Counters with the TM1 PerfMon Utility
Viewing TM1 Performance Counters with the Microsoft Windows Performance Monitor
Administering IBM Cognos TM1 Web
IBM Cognos TM1 Web Overview
IBM Cognos TM1 Web Architecture
Accessing Multiple TM1 Servers from IBM Cognos TM1 Web
Limiting Access to a Single TM1 Server from IBM Cognos TM1 Web
Installing and Running IBM Cognos TM1 Web
Software Requirements
Installing the IBM Cognos TM1 Web Software
Configuring Language Settings in Microsoft Internet Explorer
Displaying and Entering Numbers Based on Regional Settings
Configuring Microsoft Internet Explorer Version 7 for IBM Cognos TM1 Web
Running IBM Cognos TM1 Web in Mozilla Firefox Web Browser
Running the 64-bit version of IBM Cognos TM1 Web on Windows x64
Running IBM Cognos TM1 Web on a WAN Server and Exporting Excel and PDF Files
Administering the TM1 Server from IBM Cognos TM1 Web
Administering Processes
Administering Chores
Setting Client Properties
Setting Cube Properties
Setting Dimension Properties
Changing Your Password
Configuring a Custom Homepage for IBM Cognos TM1 Web
Configuring Different Homepages for Individual Users
Configuring a Global Homepage for All Users
Modifying IBM Cognos TM1 Web Configuration Parameters
Editing the Web.Config File
Configuring TM1 Workflow Parameters
Displaying the Custom Toolbar
Displaying the Content of the Custom Toolbar
Changing the Height of the Custom Toolbar
Displaying or Hiding the Views Node in the Navigation Pane
Displaying or Hiding the Administration Node in the Navigation Pane
Changing the IBM Cognos TM1 Web Session Timeout
Changing the Cube Viewer Page Size
Setting the Maximum Number of Sheets to Export from a Cube Viewer
Adjusting the HttpRuntime ExecutionTimeout Parameter
Setting the TM1ExcelServicePortNumber Parameter
Configuring the Login Page using the AdminHostName and TM1ServerName Parameters
Configuring IBM Cognos TM1 Web Startup and Appearance Settings
Using the EVLink Parameter to Open TM1 Executive Viewer
Configuring the IBM Cognos TM1 Web Virtual Cache Directory
Controlling Chart Scaling and Increments with the SmartAxisEnabled Parameter
Enabling the Websheet Paging Toolbar
Setting Web Permissions
Modifying the IBM Cognos TM1 Web Virtual Directory to Allow Anonymous Access
Setting Security for IBM Cognos TM1 Web Folders
Performing Web Folder Maintenance
Using IBM Cognos TM1 Web Logging
Message Severity Levels for IBM Cognos TM1 Web Logging
IBM Cognos TM1 Web Log
TM1 Excel Services Log
TM1 Security Overview
Authentication
TM1 Authentication
Integrated Login
LDAP Authentication
TM1 Object Security
ETLDAP Utility
ETLDAP Utility Overview
Using ETLDAP
Modifying LDAP Attributes
Running ETLDAP
Configuring the LDAP Login Parameters
Examining the Elements of an LDAP Query
Building an LDAP Query
Connecting to the TM1 Server
Mapping LDAP Attributes to TM1 Fields
Specifying the ETLDAP Export Options
Exporting LDAP Information to TM1
Synchronizing TM1 Data with LDAP
Modified Record Attribute
Updating TM1 with LDAP Changes
Integrated Login
What Is Integrated Login?
Setting up Integrated Login
Step 1 - Select Integrated Login Option During TM1 Installation
Step 2 - Run the ETLDAP Utility
Step 3 - Set Access Rights for TM1 Users
Configuring Integrated Login for TM1 Web Using NTLM
Configuring Integrated Login for TM1 Web Using Kerberos
Determining if Your Web Server is Running in IIS 5.0 Isolation Mode
Configuring TM1 Web with Integrated Login on IIS 5 Using Kerberos
Configuring TM1 Web with Integrated Login for a System Account on IIS 6 Using Kerberos
Configuring TM1 Web with Integrated Login for a Domain User on IIS 6 Using Kerberos
Configuring Internet Explorer for Integrated Login
Additional Resources
Setting Up Integrated Login Manually
Logging In with Integrated Login
Integrated Login with TM1 Architect
Integrated Login With the TM1 Perspectives
Integrated Login With TM1 Web
LDAP Authentication
Validating Users with an LDAP Server
LDAP Authentication Parameters
Configuring LDAP Validation
Run the TM1 Installation Wizard and Select LDAP Authentication
Change the Parameter in TM1S.cfg to TM1
Run the ETLDAP Utility
Modify Group Assignments for New Users
Change the PasswordSource Parameter in TM1S.cfg to LDAP
Using IBM Cognos 8 Security with TM1
IBM Cognos 8 Security Overview
Setting Up a TM1 Server to Use IBM Cognos 8 Security
Configuring the TM1 Server
Configuring the TM1 Client
Defining a Cognos User to Function as a TM1 Administrator
Importing Cognos Groups into TM1
Creating Users
Administering TM1 Object Security
Configuring TM1 Web to Use IBM Cognos 8 Security
Logging in to TM1 Top
User Considerations When Using IBM Cognos 8 Authentication
Running TM1 in Secure Mode Using SSL
Overview of Running TM1 in Secure Mode Using SSL
TM1-Generated Certificates
Configuring the TM1 Admin Server to Use SSL
Configuring the TM1 Server to Use SSL
Configuring TM1 Clients to Use SSL
Configuring the TM1 Top Utility to Use SSL
Configuring TM1 Web to Use SSL
Configuring the TM1 C API to Use SSL
Configuring the TM1 Java API to Use SSL
Configuring the TM1 ETLDAP Utility to Use SSL
Using Independent Certificates
Using the Windows Certificate Store
Using the File System
Managing Users and Groups
TM1 Users and Groups Security Overview
Implementing a TM1 Security Scheme
TM1 User and Group Security Examples
Understanding Administrative Groups and Authority
ADMIN Group
SecurityAdmin Group
DataAdmin Group
Adding and Deleting Users and Groups
Adding a User
Adding a Group
Deleting a User
Deleting a Group
Assigning Users to Groups
Membership in Multiple Groups
Securing TM1 Data
Restricting Access to the Data Directory
Assigning Passwords
Using Standard Security for Passwords
Setting and Clearing Passwords
Setting a Password
Clearing a Password
Changing a Password
Setting an Expiration for a User
Control Cubes
Security Control Cubes
}CellSecurity_CubeName
}ChoreSecurity
}ClientSecurity
}CubeSecurity
}DimensionSecurity
}ElementSecurity_DimensionName
}ProcessSecurity
Client and Group Administration Control Cubes
}ClientsGroups
}ClientProperties
Object Attribute and Property Control Cubes
}ConnectionProperties
}CubeProperties
}DimensionProperties
}DimensionAttributes
}ElementAttributes_DimensionName
Performance Monitoring Control Cubes
}StatsByClient
}StatsByCube
}StatsByCubeByClient
}StatsForServer
Other Control Cubes
}Hold_UserName_CubeName
Control Dimensions
}Chores
}ClientProperties
}Clients
}ConnectionProperties
}Connections
}CubeFunctions
}CubeProperties
}Cubes
}DimensionAttributes
}DimensionProperties
}Dimensions
}ElementAttributes_DimensionName
}Groups
}Hold
}PerfClients
}PerfCubes
}Processes
}StatsStatsByClient
}StatsStatsByCube
}StatsStatsByCubeByClient
}StatsStatsForServer
}TimeIntervals
HP-UX 11i Kernel Parameters
Editing Kernel Parameter Values
Kernel Parameters to Edit for TM1 Optimization
maxdsiz_64bit
maxssiz_64bit
max_thread_proc
Excel Events Handled by TM1
Glossary
Author and Create
TM1 New Features Guide 9.4.1
Introduction
Active Forms
Active Forms Overview
Creating an Active Form
Creating an Active Form from the Cube Viewer
Creating an Active Form in Excel
Further Details
New TM1 Administrator Roles
Overview
Admin Group
SecurityAdmin Group
Restrictions on Replication and Synchronization
Restrictions for Rules and Processes
Combining SecurityAdmin Membership with Other Groups
Using with the TM1 C API
Restrictions on Adding Users to the ADMIN Group
DataAdmin Group
Membership in User Groups
Membership in both the SecurityAdmin and DataAdmin Groups
Restrictions on Replication and Synchronization
Restrictions on Rules for Security Control Cubes
Further Details
New TM1 Audit Log
Audit Log Events
Viewing the Audit Log
Creating and Running Queries
Viewing Results
Viewing Event Details
Using the Find Feature
Exporting Results
Further Details
TM1 .NET API
Overview
Software Requirements
API Components
TM1 .NET API DLL File
TM1 .NET API Help System
Viewing the TM1 .NET API Help System
Other New Features
Progress Message Improvements
ClientMessagePortNumber Tm1s.cgf Parameter
Installation/Configuration Notes
API Functions
Long String Support
Limitations
Microsoft Windows Vista Support
Excel 2007 Support
TM1 Ribbon
TM1 Web
Unicode Support
Unicode in TurboIntegrator
Other Considerations
64-bit IIS Support
System Requirements
Action Button Enhancements
Paging in TM1 Websheets
Enabling the Websheet Paging Toolbar
Using the Websheet Paging Toolbar
Multiple Skin Support in TM1 Web
Configuration
Creating Your Own Custom Skins for TM1 Web
TM1 Users Guide 9.4.1
Introduction
Getting Started
Before You Start
Required Other Software
Excel Macro Security Setting
Local and Remote TM1 Servers
Starting TM1 Clients
Running TM1 Perspectives and TM1 Client
Running TM1 Architect
Setting TM1 Client Options
Setting Login Parameters
Setting Local Server Options
Setting Admin Server Secure Socket Layer Options
Using the Server Explorer Window
Viewing Information about Objects on the TM1 Server
Accessing Remote Servers
Logging in to a Remote Server
Hiding and Viewing Objects in Server Explorer
Browsing Data
Browsing Data
Accessing Data through the Cube Viewer
Accessing Data through the In-Spreadsheet Browser
Understanding Cell Data
Expanding Detail in a View
Stacking Dimensions
Drilling Down through Consolidations
Changing Title Dimension Elements
Changing Title Elements in the Cube Viewer
Changing Title Elements in the In-Spreadsheet Browser
Drilling Through to Detailed Data
Drill-Through Example
Working with Subsets
Narrowing the List of Elements
Selection Criteria
Saving Subsets
Creating Dimension Subsets
Selecting Elements
Deleting Elements from a Subset
Sorting Subset Elements
Changing the Direction of Expansion for Consolidated Elements
Adding a User-Defined Consolidation to a Subset
Creating User-Defined Consolidations on the Fly
Creating Dynamic Subsets
Creating an Expression-Based Dynamic Subset
Creating a Filter-Based Dynamic Subset
Editing Dynamic Subsets
Working with Cube Views
Saving Cube Views
Opening Saved Views
Opening Views from the Server Explorer
Opening Views from the Cube Viewer
Opening Views from the In-Spreadsheet Browser
Filtering Views
Checking Filter Status
Canceling a View Filter
Changing Display Options
Hiding Cells Containing Zeros
Formatting Cells
Changing the Column Orientation
Modifying Cell Values
Recalculating a View
Saving Cell Changes to Disk
Exporting Cube Data
Exporting Data from a Cube
Exporting Data from a Saved View
Controlling the Types of Values to Export from a Cube
Defining Range Parameters for Exporting Cube Data
Using Data Spreading
Using Data Spreading
General Procedures for Data Spreading
Using the Proportional Spread Method
Using the Equal Spread Method
Using the Repeat Method
Using the Percent Change Method
Using the Straight Line Method
Using the Growth % Method
Using the Relative Proportional Spread Method
Using the Relative Percent Adjustment Method
Using the Repeat Leaves Method
Using the Equal Spread Leaves Method
Using the Clear Method
Excluding Cells from Data Spreading
Applying Leaf Holds
Releasing Leaf Holds
Holding Consolidation Values Constant
Interaction of Consolidation Holds and Leaf Holds
Applying Consolidation Holds
Releasing Consolidation Holds
Data Spreading Syntax
Quick Reference Table
Spreading Across a Selected Range of Cells
Syntax Examples
Data Spreading Notes
Data Spreading Not Supported in DBR Functions
Data Spread Menu in Worksheets is not Dynamic
Data Spreading Applies Across Multiple Populated Ranges
Spreading Applies to a Single Cube
Using Worksheets to Access Data
Overview
Slicing a View into a Worksheet
Taking a Snapshot of a View
Modifying Worksheets
Changing Element Names in Worksheets
Typing Element Names in Worksheets
Copying Element Names from a TM1 Client
Using TM1 Worksheet Functions to Retrieve Element Names
Entering Invalid Element Names in Worksheets
Understanding Cube References
Writing Cube References
Changing Cell Values Stored in Cubes
Creating Formulas with the Formula Editor
Correcting Cube References
Creating TM1 Worksheet Functions Using the Excel Insert Function
Creating Dynamic Reports
Using the DNEXT Function
Using the DFRST Function
Using the ELCOMP Function
Active Forms
Active Forms Overview
Creating an Active Form
Creating an Active Form from the Cube Viewer
Creating an Active Form in Excel
Saving an Active Form
Recalculating an Active Form
Deleteing an Active Form
Working with Active Forms
Suppressing/Displaying Zeroes
Filtering
Data Spreading and Holding
Drilling to Related Data
Editing Row Subsets
Saving the Row Subset as a Static List of Elements
Changing Title Elements
Inserting a Dependent Section
Inserting Columns
Formatting Active Forms
Revealing the Format Range
Understanding Application of Default Formatting
Modifying Active Form Format Definitions
Creating Additional Formats
Applying Formatting in an Active Form
Active Forms in TM1 Web
Active Form Functions
Active Form Usage Notes
Sheet Names Cannot Include Dash (-) Character
Merging Cells In an Active Form Requires a Rebuild
Active Forms Require at Least One Row DImension
Creating Reports
Overview of TM1 Reports
Creating TM1 Reports
Setting the Page Layout for a TM1 Report
Starting the Print Report Wizard
Selecting the Sheets for the Report
Selecting the Title Dimensions for the Report
Selecting Workbook Print Options
Selecting a Print Destination
Printing a TM1 Report
Saving a TM1 Report as an Excel Document
Saving a TM1 Report as a PDF Document
Saving and Loading TM1 Print Jobs
Working with Websheets
Starting TM1 Web
Using TM1 Web
Websheet Overview
Viewing a Websheet
Using the Websheet Toolbar
Using the Websheet Paging Toolbar
Editing Data in a Websheet
Editing Data in Websheet Cells
Using Data Spreading in a Websheet
Excluding Cells from Data Spreading
Excluding Consolidations from Data Spreading
Changing Websheet Properties
Recognizing Inherited Excel Features in Websheets
Hide Columns
Conditional Formatting
Hyperlinks
Freeze Panes
Generating a Report from a Websheet
Websheet Export Limitations
Working in the TM1 Web Cube Viewer
Opening a Cube View in TM1 Web
Using the TM1 Web Cube Viewer Toolbar
Navigating Pages
Reviewing Data Changes
Saving Data in a Cube View
Configuring a Cube View
Expanding and Collapsing Consolidations
Pivoting Dimensions
Hiding Dimensions
Filtering a Cube View
Selecting Elements from a Subset
Drilling from a Cube View
Editing Data in a Cube View
Editing Data in Cube View Cells
Using Data Spreading in a Cube View
Excluding Cells from Data Spreading
Excluding Consolidations from Data Spreading
Creating a New Cube View
Generating a Report from a Cube View
Cube Viewer Export Limitation
Working with TM1 Web Charts
Viewing a Chart
Changing the Chart Type, Colors, Legend, and 3D View
Changing Chart Properties
Changing Basic Chart Properties
Changing the Chart Legend
Changing the 3D Style
Changing Chart Labels
Changing the X Axis and Y Axis
Changing the Appearance of Your Chart
Expanding and Collapsing Consolidations in a Chart
Drilling from a Cube Viewer Chart
Editing Subsets in TM1 Web
Subset Editing Overview
Subset Editor Types
Dynamic versus Static Subsets
Opening the Subset Editor
Building a Simple Subset
Displaying the Advanced Subset Editor
Using the Advanced Subset Editor Toolbar
Moving Elements
Moving Consolidations
Keeping Elements
Deleting Elements
Filtering Elements
Finding Elements
Sorting Elements
Expanding and Collapsing Consolidations
Inserting Parents
Creating Custom Consolidations
Creating a Custom Consolidation from an Existing Subset
Creating a Custom Consolidation from Selected Elements
Sample Cubes
SalesPriorCube
Dimensions and Elements
Dimension Consolidations
PnLCube
Dimensions and Elements
Dimension Consolidations
PriceCube
Dimensions and Elements
Dimension Consolidations
SalesCube
Dimensions and Elements
Dimension Consolidations
SalesByQuarterCube
Dimensions and Elements
Dimension Consolidations
SalesByQuarterCube-TotalModel
Dimensions and Elements
Dimension Consolidations
TM1 Display Formats
Establishing a Custom Format
Character Values
Numeric Values
Date and Time Display Formats
TM1 Toolbars
The Standard Toolbar
The Spreading Toolbar
The Developer Toolbar
The Active Forms Toolbar
The Servers Toolbar
Servers Toolbar Limitations
Develop
TM1 API Guide 9.4.1
Introduction
The TM1 Programming Environment
Location of the TM1 API DLLs
Setting a Path to the DLLs
Supported Compilers
Servers
Local Servers
Remote Servers
The Admin Host and Admin Server
The Role of a TM1 Server
Multitasking and Symmetric Multiprocessor Support
TM1 Server Performance
Sample Code for the TM1 API
TM1 Programming Concepts
System Functions
Connecting to the API
Disconnecting from the API
Managing Server Connections
Setting the Admin Host Server
Progress Callback Functions
Requesting the Version of the System
Thread Safety
Values
Handles
Simple TM1 Data Types
Value Handling Functions
String Handling
Object Handling
Array Handling
Updating Value Capsules
Pending Values
Managing Value Pools
Object Attributes
Security
Security Levels
Groups
Clients
Assigning Clients to Groups
Assigning Rights to Objects and Groups
Meta Security
Managing Locks and Reservations
Determining Access Rights for a Client
Error Handling
Examining Error Values
Error Codes
Backup and Recovery
The Transaction Log File
Treatment of Time
Naming Conventions
Log File Structure
Automatic Recovery
Accessing the log files
Logging Changes to Dimensions
Creating a TM1 Project in C or C++
Generating a Console Project
Setting Paths
Adding Test Code
Building and Running the Program
Creating a TM1 Project in Visual Basic
Adding Code to your Visual Basic Project
Logging in to a TM1 Server
Logging Out of TM1
TM1 Objects
TM1 Objects
Object Handles
Object Properties
Lists of Objects
Creating and Registering Objects
Registration functions
Public, Private and Unregistered Objects
Accessing Parent Objects - Security
Object Names
Loading Objects
Deleting Objects
Saving Objects to Disk
Copying Objects
Servers
Server Properties
Server Functions
Dimensions and Elements
Parent Object
Child Objects
Registration
Creating a Dimension
Updating a Dimension
Deleting a Dimension
Elements
Dimension Properties
Dimension Functions
Cubes
Parent Object
Child Objects
Registration
Creating a Cube
Retrieving and Updating Cube Cells
Deleting a Cube
Cube Properties
Cube Functions
Cube Perspectives
Rules
Rule Properties
Rule Functions
Creating a New Rule
Updating an Existing Rule
Subset Object
Parent Object
Registration
Creating a Subset
Deleting a Subset
Updating a Subset
Subset Object Properties
Subset Functions
Subset Element Display Functions
View Object
Parent Object
Registration
Creating a View
Deleting a View
View Object Properties
View Functions
BLOB Objects
Property Object
Child Object
Registration
Creating a BLOB
Updating a BLOB
Deleting a BLOB
File Storage
BLOB Object Properties
Blob Functions
Spreading
Spreading Overview
Spreading Internals
Spreading to a Single Leaf Cell
Spreading To a Consolidated Cell
Spreading to a Range
After Spreading is Complete
The Spreading Function Arguments
Proportional Spread, Equal Spread and Repeat
Clear
Percent Change
Straight Line
Growth%
Relative Proportional Spread
Relative Percent Adjustment
Repeat Leaves
Equal Spread Leaves
Applying Holds
Spreading Control Codes
TM1 Functions for C
Function Types and Naming Conventions
Data Spreading Syntax
Configuring the TM1 C API to Use SSL
TM1 Functions for Visual Basic
Function Types and Naming Conventions
Properties
TM1 Developer Guide 9.4.1
Introduction
Introduction to TM1 Development
Understanding Multidimensionality
Durables Cube
Your Role as Developer
Understanding TM1 Object Naming Conventions
Creating Cubes and Dimensions
Designing Cubes
Selecting the Number of Dimensions
Consolidating Detail Using Dimension Hierarchies
Types of Elements
Element Attributes
Designing Cubes - Summary
Creating Dimensions
Creating Dimensions Using the Dimension Editor Window
Modifying a Dimension
Managing the Display of Elements in the Dimension Editor
Creating Dimensions Using Dimension Worksheets
Creating Cubes
Ordering Dimensions in a Cube
Creating a Cube
Optimizing the Order of Dimensions in a Cube
Editing Cube Properties
Replicating Cubes between Servers
Cube Relationships
Server Relationships
Advanced Calculations for Business Data
Overview of Cube Rules
Guidelines for Writing TM1 Rules Statements
General Considerations
Syntax for Describing the Area
Syntax for Formulas
Using Cube References
Arranging Rules Statements
Specifying Different Rules at the N: and C: Levels
Bypassing Rules
Qualifying Element Names
Rules Editor and Rules Worksheets
Creating Rules Worksheets
Saving Rules Worksheets
Rules and Dimension Consolidations
Order of Calculation
Overriding C: Level Elements with Rules
Stacking Rules
Sample Applications
Calculating Ratios
Sharing Data between Cubes
Restricting Rules to Simple Values
Calculating an Average Price
Linking Two Asymmetrical Cubes
Creating Drill-Through Processes and Rules
Creating a Drill Process
Editing Drill Processes
Deleting Drill Processes
Creating a Drill Assignment Rule
Drill-Through Example
Debugging Rules
Tracing Calculations
Tracing Feeders
Organizing Objects in TM1 Applications
TM1 Application Overview
Types of References
Behavior of References
Display Order for References in Applications
Using Applications and References in TM1 Web
Security Considerations for Creating and Viewing Applications
Creating and Managing Applications
Creating a Top-Level Application
Renaming Applications
Deleting Applications
Creating a Secondary-Level Application within an Existing Application
Adding TM1 Object References to an Application
Making a Reference Public
Adding References to Private Views and Subsets to an Application
Simultaneously Creating a New Object and Adding a Reference to an Application
Adding File References to an Application
Understanding Public and Private File References
Behavior of Files Uploaded to the TM1 Server
Updating Excel Files on the TM1 Server
Updating Non-Excel Files on the TM1 Server
Adding URL References to an Application
Working with Object, File, and URL References in TM1 Applications
Viewing TM1 Application Properties
Deleting Object, File, and URL References from TM1 Applications
Renaming Object, File, and URL References in TM1 Applications
Deleting Source Objects that are Referenced by TM1 Applications
Administering Security for TM1 Applications
Assigning Security Privileges for TM1 Applications and References to User Groups
Publishing TM1 Applications and References
Privatizing TM1 Applications and References
Viewing Logical Groupings in TM1 Applications
Publishing TM1 Applications to TM1 Web
Setting TM1 Websheet Properties
Publishing Excel Files to TM1 Web without Using Excel on the TM1 Web Server
Creating Hyperlinks to Uploaded Files
Viewing Websheets that Contain the 0x1A Hexadecimal Character
Importing Data with Processing Worksheets
Processing Worksheets Overview
Importing Data Using Processing Worksheets
Reading in the First Input Row
Comparing Input Records with a Cube's Structures
Converting Using IF Formulas
Converting Using a Lookup Cube
Creating Database Send (DBS) Formulas
Processing a Data Source into a Cube
Controlling Access to TM1 Objects
Assigning Security Rights to Groups
Interaction of Different Object Security Rights
Securing Cubes
Assigning Security Rights for Cubes
Reserving and Releasing Cubes
Locking and Unlocking a Cube
Securing Elements
Assigning Security Rights for Elements
Reserving and Releasing Elements
Locking and Unlocking an Element
Securing Dimensions
Assigning Security Rights for Dimensions
Reserving and Releasing Dimensions
Locking and Unlocking a Dimension
Securing Processes
Assigning Security Rights for Processes
Allowing Processes to Modify Security Data
Securing Chores
Assigning Security Rights for Chores
Securing Applications and References
Securing Cells
Creating a Cell Security Control Cube
Using Rules to Define Cell-Level Security
Using TM1 Action Buttons to Build Worksheet Applications
Overview
Adding an Action Button to a Worksheet
Configuring an Action Button to Run a Process
Selecting the Process to Run
Setting Process Parameters
Setting Process Options for Calculation
Setting Process Options to Show Messages
Configuring an Action Button to Navigate to Another Worksheet
Select a Target Worksheet
Enable the Match Title Elements Option
Example of SUBNM Title Dimension Matching
Example of DBRW Row and Column Dimension Mapping
Setting the Replace Current Workbook Option
Setting Calculation Options for after Navigating to a Worksheet
Configuring an Action Button to Run a Process and Navigate to a Worksheet
Configuring an Action Button to Recalculate or Rebuild a Worksheet
Understanding Action Button Behavior with TM1 Active Forms
Basic Action Button Behavior
Additional Action Button Behavior
Setting the Appearance Properties of an Action Button
Using Advanced Navigation and Mapping Options
Configuring Source to Target Mapping
Example of Mapping a Source Value to a Target Cell
Example of Mapping a Source SUBNM to a Target Cell
Example of Mapping the Selected DBRW to the Target Worksheet
Modifying an Existing Action Button
Editing the Caption, Background Image, and Properties of an Existing Action Button
Moving and Resizing an Existing Action Button
Developing Custom Web Applications with the URL API
URL API Overview
Basic URL API Syntax
Base URL
Parameters
ObjectId Parameter
Using URL Escape Characters
Basic URL API Concepts
Setting Admin Host Name and TM1 Web Server Name Parameters
Managing User Login and Logout
Using the Action Parameter
Using the OpenObject Parameter to Open an TM1 Web Object
Operating on an Existing TM1 Web Object with the ObjectId Parameter
Accessing the Websheet Object
Opening a Websheet Object
Selecting Title Elements for a Websheet Object
Applying Actions to a Websheet Object
Setting Display Properties for the Websheet Object
Accessing the Cubeviewer Object
Opening a Cubeviewer Object
Setting Display Properties for the Cubeviewer Object
Selecting Title Elements for the Cubeviewer Object
Applying Actions to a Cubeviewer Object
Displaying Charts with the Cubeviewer Object
Setting Event Callback Functions for Cubeviewer and Websheet Objects
Enabling a Callback Function for Websheet and Cubeviewer Objects
Setting a Global Callback Function for All Title Dimensions
Accessing the Navigation Tree Object
Opening the Navigation Tree Object
Using the Navigation Tree Object in HTML Mode
Using the Navigation Tree Object in XML Mode
Using TM1 Viewer Portlets in IBM Cognos 8
Create a Page with TM1 Content
Modify a TM1 Viewer Portlet
TM1 Cube Viewer
TM1 Navigation Viewer
TM1 Websheet Viewer
Supported Excel Functions - TM1 Web
Supported Functions
Date and Time Functions
Financial Functions
Information Functions
Logical Functions
Lookup and Reference Functions
Math and Trigonometric Functions
Statistical Functions
Text and Data Functions
Unsupported Excel Functions - TM1 Web
Database and List Management Functions
Date and Time Functions
Financial Functions
Information Functions
Lookup and Reference Functions
Math and Trigonometric Functions
Statistical Functions
Text and Data Functions
TM1 Reference Guide 9.4.1
Introduction
TM1 Windows and Dialog Boxes
Action Button Properties Dialog Box
Process Tab
Worksheet Tab
Appearance Tab
Advanced Options Dialog Box
Advanced Mapping Grid
Attributes Editor
File Menu
Edit Menu
Options
Audit Log Window
Query Panel
Event Type Options
Results Panel
Results Panel Toolbar
Results Grid
Audit Log Details Window
Details Toolbar
Details Grid
Chore Setup Wizard
Screen 1 (Step 1)
Screen 2 (Step 2)
Clients/Groups Window
Security Menu
Clients Menu
Groups Menu
Clients/Groups Grid
Clients Messaging Center Dialog Box
Create a Dimension Dialog Box
Create Server Replication Object Dialog Box
Creating Cube Dialog Box
Cube Optimizer
Cube Properties Dialog Box
Cube Viewer
File Menu
Edit Menu
View Menu
Options Menu
Delete Named Subsets Dialog Box
Delete Named Views Dialog Box
Dimension Editor
Dimension Menu
Edit Menu
View Menu
Dimension Element Insert Dialog Box
Dimension Element Ordering Dialog Box
Dimension Element Properties Dialog Box
Edit Formula Dialog Box
Edit Reference to Cube Dialog Box
Filter Elements by Attribute Dialog Box
Filter Elements by Level Dialog Box
Filter Subset Dialog Box
Filter View Dialog Box
Get View Dialog Box (In-Spreadsheet Browser)
In-Spreadsheet Browser Menu
Message Log Window
File Menu
Edit Menu
Help Menu
New Attribute Dialog Box
Open Subset Dialog Box
Open View Dialog Box
Print Report Wizard
All Screens
Screen 1 of 3
Screen 2 of 3
Screen 3 of 3
Process Options Dialog Box
Replicate Cube Dialog Box
Rules Editor
Save Subset Dialog Box
Save View Dialog Box
Save View Dialog Box (In-Spreadsheet Browser)
Security Assignments Dialog Box
None Privilege
Read Privilege
Write Privilege
Reserve Privilege
Lock Privilege
Admin Privilege
Select Dimension
Select Cube Dialog Box
Select Cube for Rules Dialog Box
Select Dimension Dialog Box
Select Dimension Worksheet Dialog Box
Select Element Dialog Box
Select Rule Worksheet Dialog Box
Server Explorer (Main Window)
Dynamic Menu
TM1 Servers Group
Server
Applications
Cubes
Cube
Dimensions
Dimension
CubeViews
CubeView
Subsets
Subset
Replications
Replication
Replicated Cube
Processes
Process
Chores
Chore
Subset Editor
Subset Menu
Edit Menu
View Menu
Tools Menu
Cube Information
Rule Information
Dimension Information
TM1 Aliases Dialog Box
TM1 Options Dialog Box
Login Parameters
Local Server
Admin Server Secure Socket Layer
Transaction Log Query Dialog Box
Transaction Log Query Results Dialog Box
TurboIntegrator Editor
File Menu
Edit Menu
Tabs
View Extract Window
Select elements
View Styles Dialog Box
Rules Functions
Arithmetic Operators in TM1 Rules
Comparison Operators in TM1 Rules
Logical Operators in TM1 Rules
Cube Data Rules Functions
DB
ISLEAF
UNDEF
UNDEFVALS
Date and Time Rules Functions
DATE
DATES
DAY
DAYNO
MONTH
NOW
TIME
TIMST
TIMVL
TODAY
YEAR
Dimension Information Rules Functions
ATTRN
ATTRS
ConsolidateChildren
DIMNM
DIMSIZ
DNEXT
DNLEV
TABDIM
Element Information Rules Functions
DIMIX
DTYPE
ELCOMP
ELCOMPN
ELISANC
ELISCOMP
ELISPAR
ELLEV
ELPAR
ELPARN
ELWEIGHT
Financial Rules Functions
FV
PAYMT
PV
Logical Rules Functions
CONTINUE
IF
STET
Mathematical Rules Functions
ABS
ACOS
ASIN
ATAN
COS
EXP
INT
ISUND
LN
LOG
MAX
MIN
MOD
RAND
ROUND
ROUNDP
SIGN
SIN
SQRT
TAN
Text Rules Functions
CAPIT
CHAR
CODE
DELET
FILL
INSRT
LONG
LOWER
NUMBR
SCAN
STR
SUBST
TRIM
UPPER
Miscellaneous Rules Functions
FEEDERS
FEEDSTRINGS
SKIPCHECK
TM1 Macro Functions
Accessing Macro Functions
Accessing macro functions from Excel versions 5 and 7
Accessing macro functions from Excel version 8 and later
Accessing macro functions from VBA modules
D_PICK
DBProportionalSpread
D_FSAVE
D_SAVE
E_PICK
I_EXPORT
I_NAMES
I_PROCESS
M_CLEAR
N_CONNECT
OPTGET
N_DISCONNECT
OPTSET
PublishSubset
PublishView
QUDEFINE
QUDEFINEEX
QUEXPORT
QULOOP
QUSUBSET
R_SAVE
SUBDEFINE
SUBPICK
T_CLEAR
T_CREATE
T_CREATE16
T_PICK
T_SAVE
TM1RECALC
TM1RECALC1
VUSLICE
W_DBSENABLE
TM1 Worksheet Functions
Worksheet Function Overview
DBR
DBRA
DBRW
DBS
DBSA
DBSS
DBSW
DFRST
DIMIX
DIMNM
DIMSIZ
DNEXT
DNLEV
DTYPE
ELCOMP
ELCOMPN
ELISCOMP
ELISPAR
ELLEV
ELPAR
ELPARN
ELSLEN
ELWEIGHT
SUBNM
SUBSIZ
TABDIM
TM1RptElIsConsolidated
TM1RptElIsExpanded
TM1RptElLev
TM1RptFilter
TM1RptRow
TM1RptTitle
TM1RptView
TM1User
VIEW
TM1 TurboIntegrator Functions
ASCII and Text TurboIntegrator Functions
ASCIIDelete
ASCIIOutput
SetInputCharacterSet
SetOutputCharacterSet
TextOutput
Attribute Manipulation TurboIntegrator Functions
AttrDelete
AttrInsert
AttrPutN
AttrPutS
Chore Management TurboIntegrator Functions
ChoreQuit
SetChoreVerboseMessages
Cube Manipulation TurboIntegrator Functions
CellGetN
CellGetS
CellIsUpdateable
CellPutN
CellPutProportionalSpread
CellPutS
CubeCreate
CubeDestroy
CubeExists
CubeGetLogChanges
CubeSetLogChanges
CubeUnload
Dimension Manipulation TurboIntegrator Functions
DimensionCreate
DimensionDeleteAllElements
DimensionDestroy
DimensionElementComponentAdd
DimensionElementComponentDelete
DimensionElementDelete
DimensionElementInsert
DimensionElementPrincipalName
DimensionExists
DimensionSortOrder
ODBC TurboIntegrator Functions
ODBCClose
ODBCOpen
ODBCOutput
Process Control TurboIntegrator Functions
ExecuteCommand
ExecuteProcess
GetProcessErrorFileDirectory
GetProcessErrorFilename
If
ItemReject
ItemSkip
ProcessBreak
ProcessError
ProcessQuit
While
Rules Management TurboIntegrator Functions
CubeProcessFeeders
RuleLoadFromFile
Security TurboIntegrator Functions
AddClient
AddGroup
AssignClientToGroup
AssignClientPassword
DeleteClient
DeleteGroup
ElementSecurityGet
ElementSecurityPut
RemoveClientFromGroup
SecurityRefresh
Server Manipulation TurboIntegrator Functions
BatchUpdateFinish
BatchUpdateFinishWait
BatchUpdateStart
SaveDataAll
ServerShutdown
Subset Manipulation TurboIntegrator Functions
SubsetAliasSet
SubsetCreate
SubsetCreateByMDX
SubsetDeleteAllElements
SubsetDestroy
SubsetElementDelete
SubsetElementInsert
SubsetExists
SubsetExpandAboveSet
SubsetFormatStyleSet
SubsetGetElementName
SubsetGetSize
SubsetIsAllSet
View Manipulation TurboIntegrator Functions
PublishView
ViewColumnDimensionSet
ViewColumnSuppressZeroesSet
ViewConstruct
ViewCreate
ViewDestroy
ViewExists
ViewExtractSkipCalcsSet
ViewExtractSkipRuleValuesSet
ViewExtractSkipZeroesSet
ViewRowDimensionSet
ViewRowSuppressZeroesSet
ViewSubsetAssign
ViewSuppressZeroesSet
ViewTitleDimensionSet
ViewTitleElementSet
ViewZeroOut
Miscellaneous TurboIntegrator Functions
Expand
FileExists
NumberToString
NumberToStringEx
StringToNumber
StringToNumberEx
WildcardFileSearch
TM1ProcessError.log file
TM1 TurboIntegrator Variables
TurboIntegrator Local Variables
DatasourceNameForServer
DatasourceNameForClient
DatasourceType
DatasourceUsername
DatasourcePassword
DatasourceCubeview
DatasourceDimensionSubset
DatasourceASCIIDelimiter
DatasourceASCIIDecimalSeparator
DatasourceASCIIThousandSeparator
DatasourceASCIIQuoteCharacter
DatasourceASCIIHeaderRecords
Value_Is_String
NValue
SValue
OnMinorErrorDoItemSkip
MinorErrorLogMax
DataSourceODBOCatalog
DataSourceODBOConnectionString
DataSourceODBOCubeName
DataSourceODBOHierarchyName
DataSourceODBOLocation
DataSourceODBOProvider
DataSourceODBOSAPClientID
DataSourceODBOSAPClientLanguage
TurboIntegrator Global Variables
NumericGlobalVariable('VariableName');
StringGlobalVariable('VariableName');
Implicit Global Variables
DataMinorErrorCount
MetadataMinorErrorCount
ProcessReturnCode
PrologMinorErrorCount
TurboIntegrator User Variables
NumericSessionVariable('VariableName');
StringSessionVariable('VariableName');
MDX Function Support
Support for Microsoft-defined MDX expressions and functions
List of Supported Member expressions
List of Supported Member functions
List of Supported Numeric functions
List of Supported Set expressions
List of Supported Set functions
List of Supported Tuple expressions
TM1-Specific MDX functions
TM1FILTERBYPATTERN( <set>, <pattern_str> )
TM1FILTERBYLEVEL( <set>, <level_number>)
TM1DRILLDOWNMEMBER( <set1>, <set2>|ALL [,RECURSIVE] )
TM1Member
TM1SORT( <set>, ASC|DESC )
TM1SORTBYINDEX( <set>, ASC|DESC )
TM1SUBSETALL( <dimname>)
TM1SubsetToSet
TM1TupleSize
TM1-Specific MDX expressions
<dimension>.<subsetname>
<member>.ANCESTORS
TM1 Rules Guide 9.4.1
Introduction
Introduction to TM1 Rules
Requirements for Running the TM1 Rules Editor
Overview of Cube Rules
Accessing TM1 Rules
Using the Rules Editor Window
Menus
Toolbars
Status Bar
Auto-save Feature
Basic Code Editing Features
Advanced Code Editing Features
Using Find and Replace
Using Bookmarks to Navigate Rules
Using Regions to Define Sections of Code
Inserting Brackets to Create an Area Definition
Inserting a Cube Reference
Inserting a Function
Using the Preferences Dialog to Adjust Font Schemes
Using the Control Options Dialog
Components of a TM1 Rule
Components of a Calculation Statement
Terminator
Bypassing Rules
General Considerations
How Do Rules Work?
Calculate on Demand
Precedence of Rules Statements
Rules and Dimension Consolidations
Comparing Floating Point Numbers
Memory Utilization and Rules
A Simple Rule
Setting Your Local Data Directory for Use with this Guide
Purchase Cost Calculation
Writing the Rule
Opening the Rules Editor
Creating the Rule
Compiling the Rule
Viewing the Results
Exchange Rates
Exchange Rate Calculation within a Cube
Exchange Rate as an Attribute of the Market Dimension
Exchange Rate Tracked by Market
The DB Formula
The Rule
How a DB Formula Works
Writing the Exchange Rate Rule Statement
Exchange Rate Calculation Using a Lookup Cube
Using a Nested DB Function
Writing Nested DBs
Other Lookup Cube Examples
Calculating Purchase Cost - USD
Using DB Functions to Move Data Between Cubes
Creating Rules Statements for the Inventory Cube
Calculating Quantity in Stock - Kgs
Calculating Purchase Cost
Calculating Average Purchase Price/Kgs
Adding the Statements to the Rule for the Inventory Cube
Improving Performance with Feeders
Sparsity
Sparsity and Rules Calculation
Skipcheck and Feeders
Single-Cube Feeders
Adding Feeders to the Rule for the Purchase Cube
Feeding One Cube from Another
Troubleshooting Feeders
Tracing Feeders
Checking Feeders
Moving Data and Changing Levels
The Production and Plan Cubes
Creating a Calculation Statement for Planned Production Qty - Kgs
Rules for Time-Based Calculations
The Problem
Four Solutions
First Try: Sequential Monthly Statements
A Second Way: Using the DIMNM - DIMIX Idiom
A Third Approach: Using DIMIX for Comparisons
Best Solution: Using a String Cube to Store a Variable
Feeding Time Series
Hard-Coded Feeders
Deliberate Overfeeding
Using DNEXT for Feeding
Fixed Allocations
Calculating the Quantities of Fish Required by Fishcake Type
Creating the Calculation Statement for Qty Required - Kgs
Feeding Qty Required - Kgs
Creating the Feeder Statement for Qty Required - Kgs
Stocks and Flows
Depletion with a Spreadsheet
Implementing a Depletion Model Using Rules
Feeding the Depletion Process
Feeding the First Statement
Feeding the Second Statement
Feeding the Remaining Statements
Feeding the Calculation for Quantity in Stock - Kgs in the Inventory Cube
Final Rule for the Depletion Cube
Final Rule for the Inventory Cube
Calculating Total Product Costs
Calculating Daily Fish Costs in the Inventory Cube
Calculating Daily Purchase Costs
Calculating the Cost of Fish Used
Required Feeders
Allocating Costs in the FishRequired Cube
Required Feeder
Viewing the Results
Moving Costs to the Produce Cube
Required Feeders
Viewing the Results
Using the Rules Tracer
Tracing Calculations
Tracing Feeders
Checking Feeders
TM1 TurboIntegrator Guide 9.4.1
Introduction
TurboIntegrator Basics
Data Sources Available with TurboIntegrator
String Length Limit in TurboIntegrator
Importing Options
Saving Metadata Changes in A TurboIntegrator Process
TurboIntegrator Functions
Processes and Chores
Order of Operations within a TurboIntegrator Process
Notes on TurboIntegrator Processes
Importing an ASCII File
Creating a Dimension from an ASCII Flat File
Defining a Data Source
Identifying Variables in the Data Source
Mapping Variables
Saving and Executing the TurboIntegrator Process
Fixed Length Records
Creating a Cube from an ASCII Flat File
Defining the Cube Data Source
Defining Cube Variables
Mapping Cube Variables
Mapping Cube Element Variables to Dimensions
Mapping Cube Data Variables
Mapping Consolidation Variables
Saving and Executing the Process
Importing from an ODBC Source
Defining an ODBC Data Source
Generating a TurboIntegrator Process from an MDX Statement
Building the MDX TurboIntegrator Process
Importing from a TM1 View or Subset
Using a TM1 Cube View as a Data Source
Create a Cube Process
Using a TM1 Subset as a Data Source
Define Dimension Subset as Data Source
Define Dimension Variables
Mapping Dimension Variables
Saving and Executing the Dimension
Importing from MSAS
OLE DB for OLAP Data Sources
ODBO Provider Name
ODBO Location
ODBO Datasource
ODBC Catalog
Connection Strings: MSAS vs. TM1
Connecting to an OLE DB for OLAP Datasource When Using CAM Authentication
Importing a MAS Cube
Connecting to Analysis Services with TurboIntegrator
The Load ODBO Cube Tab
Cube Dimensions Tab
Saving and Running the MAS Process
Importing a MAS Dimension
Define MAS Connection Parameters
Load ODBO Dimension Tab
Save and Run the Dimension MAS Process
TM1 Message Log
Importing Data from SAP RFC
SAP Objects and Terminology
Analogous Objects in SAP and TM1
SAP Object Hierachy
SAP RFC Software Prerequisites
The Saprfc.ini File and RFC Libraries
Installing the TM1 Interface to SAP BW
Importing an InfoCube from SAP
Establishing a Connection to SAP BW
Mapping an SAP InfoCube to a TM1 Cube
Mapping SAP Characteristics to TM1 Dimensions
Setting Characteristic Restrictions
Selecting Characteristic Settings
Results
Importing a Characteristic from SAP
Mapping an SAP Characteristic to a TM1 Dimension
Importing Security from SAP
Select the SAP Security Definitions to Import
Import Security Results
Importing and Converting Currency Data from SAP
Mapping SAP Currencies to TM1 Cubes and Dimensions
Currency Results
Importing an SAP Table
Creating an SAP Table Query
Identifying and Mapping Variables
Table Results
Writing TM1 Data to SAP
Mapping Dimensions and Values from a TM1 View to an ODS Table
ODS Results
Editing Advanced Procedures and Chores
Editing Procedures
Executing a Process on Demand
Scheduling a Process for Automatic Execution with Chores
Important Note on Chore Start Times
Editing a Chore
Activating a Chore
Deactivating a Chore
Deleting a Chore
Executing a Chore on Demand
TurboIntegrator Tutorial
Setting the Tutorial Data Directory
TurboIntegrator Overview
Creating a TurboIntegrator Process
Creating Dimensions Using TurboIntegrator
Creating a Cube and Processing Data
Advanced Scripting
Editing the Prolog, Metadata, Data, and Epilog Procedures
Creating Subsets
Creating Attributes
TurboIntegrator Reserved Words
Rule Function Names
Process Function Names
Implicit Variable Names
TurboIntegrator Keywords
TM1 Workflow Administrator's Guide 9.4.1
Introduction
Getting Started with TM1 Workflow
Installing TM1 Workflow
TM1 Workflow Design
Starting the TM1 Workflow Service
Building a TM1 Workflow
Opening the Admin Console
Identifying the Workflow Dimension
Saving the Workflow
Task and Review Hierarchy
Tasks
Creating a Task and Review Structure
Adding Tasks
Task Actions
Types of Tasks
Prompting for Comments in a Task Action
Adding a Custom Task Action
Task Statuses
Defining Task Statuses
Adding Custom Task Statuses
Task Attributes
Setting Task Attributes
Design Time Attributes
Run Time Attributes
Attributes Added for Custom Actions
Setting Attribute Languages
Workflow Status
Adding a New Workflow Status
Using the Workflow Toolbar
Accomplishing Tasks
Choosing Tasks
Taking Action on a Task
The All Tasks List
Task Details
Process Status
Customize on the Workflow Toolbar
Load
Connect
Help on the Workflow Toolbar
Running TM1 Workflow on TM1 Web
Using TM1Web Skins in Workflow
Workflow Security and Navigation
Specifying Objects for Navigation
Using the TM1 Application Organizer Folder
Navigating to a Workbook
Navigating to Specific Cells
Navigating to a TM1 View
Navigating to a TM1 Web URL API
Navigating to an Executive Viewer URL API
Navigating with Multiple Dimension Elements
Workflow Security
Setting Up Security for Workflow Worksheets
Workflow Messaging
Setting the Default Message for a Task Action
Setting Up Messages for An Individual Task
Defining Email Addresses
Adding Attachments
Enabling Attachments Within Workflow
Enabling Process-Level Attachments
Using the All Tasks Button to Add an Attachment
Viewing Attachments
Using the TM1 Workflow Definition
Displaying the Workflow Definition
Using the Workflow Definition Grid
The TM1 Workflow Application Environment
Setting System-Wide Options
Setting User-Based Options
Setting Client Update Capability
Setting User Help Text in Workflow
Setting Admin Help Text in TM1 Workflow
Advanced TM1 Workflow Process Design
Using TurboIntegrator in a TM1 Workflow Process
The Workflow Execution Sequence
Troubleshoot
TM1 Readme 9.4.1
IBM Cognos TM1 Readme
Review the Readme Updates and Fix List
Installation and Configuration
Opening Previous TM1 Databases in TM1 9.4
Upgrading to TM1 9.4/9.4 MR1 from Previous 9.x Versions of TM1
Upgrading from TM1 9.4 to TM1 9.4 MR1
Choosing Simplified Chinese Language When Installing TM1 on a Japanese Windows System
Language Versions of Documentation and Installation Help
Fonts and Images May Not Display Correctly with Some Display Resolutions
Modifying the TM1 Web 9.4 Installation
Planning Sample Server Name Not Correct for an x64 TM1 Server
Default Installation Directory Incorrect for TM1 Workflow Web Server on an x64 System
IIS Must Be Installed Before .NET Framework
Client Configuration When Installing TM1 x86 Version on x64 System
TM1 Workflow x64 Installation Procedure
End-of-life Statements
HP-UX RISC Platform Support
Windows Itanium Platform Support
TM1 In-Spreadsheet Browser
TM1 HTTP Proxy Connector
Other Platforms/Components
New Features in TM1 9.4 MR1
Excel Function Support in Websheets - COUNTIF and SUMIF
ClientPropertiesSyncInterval Server Parameter
Setting ClientPropertiesSyncInterval
Changes in Functionality and Behavior between TM1 9.4 andTM1 9.4 MR1
Active Forms
Workbook Recalculation Variable TM1REBUILDOPTION
Known Issues for IBM Cognos TM1 9.4 MR1
Action Button
APIs
Applications
Audit Log
ETLDAP Tool
Excel 2007
Formatting
Incompatible Versions
IIS x64
Long Strings
Role-Based Security
Rules Editor
Rules Functions
TM1 Connector for Use With SAP
TM1 Perspectives
TM1 Web
TurboIntegrator/Chores
Unicode
Vista Performance Monitoring Counters
Workflow
IBM Cognos TM1 Fix Pack 1 Release Notes 9.4.1.1
Release Notes - Updates By Date
Updated: February 27, 2009
Known Issues - Installation and Configuration
New Features in TM1 9.4 MR1 FP1
Known Issues - AIX
Known Issues - Documentation
Known Issues - TM1 Excel Functions
Known Issues - TM1Top Utility
Known Issues - Unicode
Known Issues - Windows Vista
Known Issues - Workflow
IBM Cognos TM1 Release Notes
Review the Release Notes Updates and Fix List
Installation and Configuration
Upgrading to TM1 9.4 MR1 FP1 Requires 9.4 MR1 to be Installed
Opening Previous TM1 Databases in TM1 9.4
Upgrading to TM1 9.4/9.4 MR1 from Previous 9.x Versions of TM1
Upgrading from TM1 9.4 to TM1 9.4 MR1
Choosing Simplified Chinese Language When Installing TM1 on a Japanese Windows System
Language Versions of Documentation and Installation Help
Fonts and Images May Not Display Correctly with Some Display Resolutions
Modifying the TM1 Web 9.4 Installation
Planning Sample Server Name Not Correct for an x64 TM1 Server
Default Installation Directory Incorrect for TM1 Workflow Web Server on an x64 System
IIS Must Be Installed Before .NET Framework
Client Configuration When Installing TM1 x86 Version on x64 System
TM1 Workflow x64 Installation Procedure
TM1 Portlets - Single Sign-on Requires ClientCAMURI Parameter and Cognos 8 URL to use Machine Name
TM1 Silent Installation Displays Error 2753
API Configuration
Windows Vista Installation Issues
TM1 Server Cannot Start as a Service if Installed with a Name that Includes a Double-byte Character String
AIX Installation Issues
Data Synchronization Requires Cube Logging
TM1 Web Login Does Not Show Available TM1 Servers if Web.config has Invalid SSL Certifcate ID
End-of-life Statements
HP-UX RISC Platform Support
Windows Itanium Platform Support
TM1 In-Spreadsheet Browser
TM1 HTTP Proxy Connector
Axnet/aagateway service
Other Platforms/Components
New Features in TM1 9.4 MR1 FP1
Excel Function Support in Websheets - COUNTIF and SUMIF
TM1 Action Button - Server Name Property can use a Cell or Named-range Reference
ClientPropertiesSyncInterval Server Parameter
Setting ClientPropertiesSyncInterval
Changes in Functionality and Behavior between TM1 9.4 and TM1 9.4 MR1 FP1
Active Forms
Workbook Recalculation Variable TM1REBUILDOPTION
Known Issues for IBM Cognos TM1 9.4 MR1 FP1
Action Button
AIX - Japanese Messages for TM1 Server Startup Do Not Display Correctly in Command Prompt
APIs
Applications
Audit Log
Documentation
ETLDAP Tool
Excel 2007
Excel Functions - Some TM1 Functions are Incorrectly Space Sensitive When Evaluating Element Names
Formatting
Incompatible Versions
IIS x64
Long Strings
Role-Based Security
Rules Editor
Rules Functions
TM1 Connector for Use With SAP
TM1 Perspectives
TM1Top Log File Displays Extra Spaces and Corrupt Multi-byte Characters
TM1 Web
TurboIntegrator/Chores
Unicode
Windows Vista
Workflow
IBM Cognos TM1 Fix Pack 2 Release Notes 9.4.1.2
IBM Cognos TM1 9.4.1 FP2 Release Notes
Review the TM1 9.4.1 Base Release Notes
Review the Fix List for TM1 9.4.1 FP2
Installation and Configuration
Upgrading to TM1 9.4.1 FP2 Requires 9.4.1 or 9.4.1 FP1 to be Installed
Manually Update IIS Virtual Directory if TM1 Web was Originally Installed to a Drive other than C Drive
TM1 Workflow Requires Manual Uninstall and Re-install After Upgrading TM1 Web to 9.4.1 FP2
Use the Enforce8BitStringLengthOnRead Parameter for Loading and Conversion Issues with a TM1 9.1.x Database in 9.4.1 FP2
Install and Activate ClearType on TM1 Web Server to Enhance Display and Rendering of TM1 Websheets
TM1 Java API and Compatible Java SDK Versions
Check IBM AIX Memory Resource Limits When Running TM1 on AIX
Documentation Updates for TM1 9.4.1 FP2
TM1 Support for IBM AIX Version 6.1
Additional Recommendations about TM1 Object Names and Character Encoding for TM1 Servers on UNIX and Windows Systems
Using TM1 in Bulk Load Mode
Using Cell Protection for Active Forms in TM1 Perspectives and TM1 Web
Updated Information and Software Prerequisites for Using TurboIntegrator to Import Data from SAP RFC
A TI Process Should Not Perform any Operation that Creates a New Simultaneous Connection to the Same TM1 Server.
Corrected Information about Using the TM1 API with Integrated Login
TM1 N_CONNECT Function Is Not Supported with Integrated Login
Re-configuring TM1 to Use IBM Cognos 8 Security with Another Instance of IBM Cognos 8 Requires Re-loading of Users and Groups
TM1 Web EVLink Parameter Renamed to CustomLink
Using the AllRuleCalcStargateOptimization Parameter to Improve Performance with Views and Rule-Calculated Consolidations
Cell Level Security Must be Configured Using the English-language Keywords that Define TM1 Security Levels
Cannot Search for Multiple Words Separated by Double-byte Space Character
TM1 Action Button - Server Name Property can use a Cell or Named-range Reference
Known Issues for IBM Cognos TM1 9.4.1 FP2
Action Button
IBM AIX
APIs
Applications
Audit Log
Microsoft Excel 2007
Formatting
Incompatible Versions
IIS x64
Long Strings
Role-Based Security
Rules Editor
Rules Functions
TM1 Connector for Use With SAP
TM1 Perspectives
TM1 Web
TurboIntegrator/Chores
Unicode
Windows Vista
Workflow
IBM Cognos TM1 Fix Pack 3 Release Notes 9.4.1.3
IBM Cognos TM1 9.4.1 FP3 Release Notes
Review the TM1 9.4.1 Base Release Notes
Review the Fix List for TM1 9.4.1 FP3
Installation and Configuration
Upgrading to TM1 9.4.1 FP3 Requires a Previous Version of 9.4.1 to be Installed
Manually Update IIS Virtual Directory if TM1 Web was Originally Installed to a Drive other than C Drive
TM1 Workflow Requires Manual Uninstall and Re-install After Upgrading TM1 Web to 9.4.1 FP3
Use the Enforce8BitStringLengthOnRead Parameter for Loading and Conversion Issues with a TM1 9.1.x Database in 9.4.1 FP3
Install and Activate ClearType on TM1 Web Server to Enhance Display and Rendering of TM1 Websheets
TM1 Java API and Compatible Java SDK Versions
Check IBM AIX Memory Resource Limits When Running TM1 on AIX
Documentation Updates for TM1 9.4.1 FP3
Configuring Security in Microsoft Internet Explorer 7 for TM1 Web
LockPagesInMemory Parameter
ServicePrincipalName Parameter
DatasourceQuery TurboIntegrator Local Variable
TM1 Support for IBM AIX Version 6.1
Additional Recommendations about TM1 Object Names and Character Encoding for TM1 Servers on UNIX and Windows Systems
Using TM1 in Bulk Load Mode
Using Cell Protection for Active Forms in TM1 Perspectives and TM1 Web
Updated Information and Software Prerequisites for Using TurboIntegrator to Import Data from SAP RFC
A TI Process Should Not Perform any Operation that Creates a New Simultaneous Connection to the Same TM1 Server
Corrected Information about Using the TM1 API with Integrated Login
TM1 N_CONNECT Function Is Not Supported with Integrated Login
Re-configuring TM1 to Use IBM Cognos 8 Security with Another Instance of IBM Cognos 8 Requires Re-loading of Users and Groups
TM1 Web EVLink Parameter Renamed to CustomLink
Using the AllRuleCalcStargateOptimization Parameter to Improve Performance with Views and Rule-Calculated Consolidations
Cell Level Security Must be Configured Using the English-language Keywords that Define TM1 Security Levels
Cannot Search for Multiple Words Separated by Double-byte Space Character
TM1 Action Button - Server Name Property can use a Cell or Named-range Reference
Known Issues for IBM Cognos TM1 9.4.1 FP3
Action Button
IBM AIX
APIs
Applications
Audit Log
Microsoft Excel 2007
Formatting
Incompatible Versions
IIS x64
Long Strings
Role-Based Security
Rules Editor
Rules Functions
TM1 Connector for Use With SAP
TM1 Perspectives
TM1 Web
TurboIntegrator/Chores
Unicode
Windows Vista
Workflow
Viewing information in the information center
Accessibility and keyboard shortcuts in the information center
Prerequisite software for the information center
Navigating in the information center
Searching in the information center
Using the master index
Setting bookmarks and printing in the information center
Viewing information in different languages
ibm.com: About IBM - Privacy - Contact
About IBM
Privacy
Contact