Home >Documents >TM1 Reference Guide - IBMpublic.dhe.ibm.com/software/data/cognos/... · TM1 Reference Guide Product...

TM1 Reference Guide - IBMpublic.dhe.ibm.com/software/data/cognos/... · TM1 Reference Guide Product...

Date post:19-Jan-2021
Category:
View:3 times
Download:0 times
Share this document with a friend
Transcript:
  • TM1 Reference Guide

  • Product Information

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

    Copyright

    Copyright © 2008 Cognos Incorporated.

    Portions of Cognos® 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,907,428 B2; 6,853,375 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.

    Cognos and the Cognos logo are trademarks of Cognos Incorporated in the United States and/or other countries. All other names are trademarks or registered trademarks of their respective companies.

    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 either the product or the document will be documented in subsequent editions.

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

    This software/documentation contains proprietary information of Cognos Incorporated. All rights are reserved. Reverse engineering of this software is prohibited. No part of this software/documentation 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 Incorporated.

    Publication Date: February 2008

    TM1 Reference Guide

    http://support.cognos.com

  • Table of Contents | Index

    Table of Contents

    Chapter 1 TM1 Windows and Dialog BoxesAction Button Properties Dialog Box  . . . . . . . . . . . . . . . . . . . . . . . . . 1‐3Advanced Options Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐12Attributes Editor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐16Chore Setup Wizard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐20Clients/Groups Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐22Clients Messaging Center Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . 1‐26Create a Dimension Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐27Create Server Replication Object Dialog Box . . . . . . . . . . . . . . . . . . 1‐27Creating Cube Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐28Cube Properties Dialog Box  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐30Cube Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐31Delete Named Subsets Dialog Box  . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐36Delete Named Views Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐36Dimension Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐37Dimension Element Insert Dialog Box  . . . . . . . . . . . . . . . . . . . . . . . 1‐43Dimension Element Ordering Dialog Box  . . . . . . . . . . . . . . . . . . . . 1‐45Dimension Element Properties Dialog Box  . . . . . . . . . . . . . . . . . . . 1‐47Edit Formula Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐48

    iii

  • Table of Contents | Index

    Edit Reference to Cube Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐49Filter Elements by Attribute Dialog Box. . . . . . . . . . . . . . . . . . . . . . 1‐50Filter Elements by Level Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . 1‐50Filter Subset Dialog Box  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐51Filter View Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐53Get View Dialog Box (In‐Spreadsheet Browser) . . . . . . . . . . . . . . . 1‐56In‐Spreadsheet Browser Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐57Message Log Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐59New Attribute Dialog Box  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐61Open Subset Dialog Box  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐61Open View Dialog Box  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐61Print Report Wizard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐62Process Options Dialog Box  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐68Replicate Cube Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐69Save Subset Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐69Save View Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐71Save View Dialog Box (In‐Spreadsheet Browser) . . . . . . . . . . . . . . 1‐71Security Assignments Dialog Box  . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐72Select Cube Dialog Box  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐81Select Cube for Rules Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐81Select Dimension Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐81Select Dimension Worksheet Dialog Box . . . . . . . . . . . . . . . . . . . . . 1‐81Select Element Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐81

    iv TM1 Reference Guide

  • Table of Contents | Index

    Select Rule Worksheet Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐82Server Explorer (Main Window) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐82Subset Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐99TM1 Aliases Dialog Box  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐110TM1 Options Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐110Transaction Log Query Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . 1‐114Transaction Log Query Results Dialog Box . . . . . . . . . . . . . . . . . . 1‐115TurboIntegrator Editor  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐117

    Data Source Tab  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐118Variables Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐121Maps Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐123Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐129Schedule Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐131

    View Extract Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐132View Styles Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐134

    Chapter 2 Rules FunctionsArithmetic Operators in TM1 Rules  . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐2Comparison Operators in TM1 Rules . . . . . . . . . . . . . . . . . . . . . . . . . 2‐3Logical Operators in TM1 Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐4Cube Data Rules Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐4

    DB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐5ISLEAF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐6

    v

  • Table of Contents | Index

    UNDEF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐7UNDEFVALS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐8

    Date and Time Rules Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐9DATE  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐10DATES  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐12DAY  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐13DAYNO  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐14MONTH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐15NOW. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐16TIME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐17TIMST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐18TIMVL  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐22TODAY. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐25YEAR  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐27

    Dimension Information Rules Functions  . . . . . . . . . . . . . . . . . . . . . 2‐27ATTRN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐28ATTRS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐29ConsolidateChildren  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐30DIMNM  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐34DIMSIZ. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐36DNEXT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐37DNLEV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐38TABDIM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐40

    vi TM1 Reference Guide

  • Table of Contents | Index

    Element Information Rules Functions. . . . . . . . . . . . . . . . . . . . . . . . 2‐41DIMIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐42DTYPE  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐44ELCOMP  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐45ELCOMPN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐47ELISANC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐48ELISCOMP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐50ELISPAR. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐52ELLEV. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐54ELPAR  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐56ELPARN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐58ELWEIGHT  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐59

    Financial Rules Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐61FV  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐62PAYMT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐63PV  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐64

    Logical Rules Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐65CONTINUE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐66IF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐67STET  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐68

    Mathematical Rules Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐69ABS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐70ACOS  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐71

    vii

  • Table of Contents | Index

    ASIN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐72ATAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐73COS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐74EXP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐75INT  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐76ISUND  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐77LN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐78LOG. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐79MAX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐80MIN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐81MOD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐82RAND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐83ROUND  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐84ROUNDP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐85SIGN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐87SIN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐88SQRT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐89TAN  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐90

    Text Rules Functions  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐91CAPIT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐92CHAR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐93CODE  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐94DELET  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐95

    viii TM1 Reference Guide

  • Table of Contents | Index

    FILL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐96INSRT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐97LONG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐98LOWER. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐99NUMBR  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐100SCAN  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐101STR  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐102SUBST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐103TRIM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐104UPPER  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐105

    Miscellaneous Rules Functions  . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐106FEEDERS  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐107FEEDSTRINGS  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐108SKIPCHECK  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐109

    Chapter 3 TM1 Macro FunctionsAccessing Macro Functions  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐2

    Accessing macro functions from Excel versions 5 and 7  . . . . . . 3‐2Accessing macro functions from Excel version 8 and later  . . . . 3‐3Accessing macro functions from VBA modules. . . . . . . . . . . . . . 3‐4D_PICK. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐5DBProportionalSpread. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐6D_FSAVE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐8

    ix

  • Table of Contents | Index

    D_SAVE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐10E_PICK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐11I_EXPORT  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐14I_NAMES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐16I_PROCESS  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐17M_CLEAR  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐18N_CONNECT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐19N_DISCONNECT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐20OPTGET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐21OPTSET  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐23PublishSubset  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐25PublishView. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐26QUDEFINE  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐27QUDEFINEEX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐30QUEXPORT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐34QULOOP  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐36QUSUBSET  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐38R_SAVE  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐40SUBDEFINE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐41SUBPICK  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐43T_CLEAR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐45T_CREATE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐46T_CREATE16. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐48

    x TM1 Reference Guide

  • Table of Contents | Index

    T_PICK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐49T_SAVE  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐50TM1RECALC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐51TM1RECALC1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐52VUSLICE  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐53W_DBSENABLE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐54

    Chapter 4 TM1 Worksheet FunctionsWorksheet Function Overview  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐1

    DBR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐3DBRA  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐5DBRW. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐7DBS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐10DBSA. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐12DBSS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐14DBSW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐16DFRST. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐18DIMIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐19DIMNM  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐20DIMSIZ. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐22DNEXT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐23DNLEV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐24DTYPE  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐26

    xi

  • Table of Contents | Index

    ELCOMP  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐27ELCOMPN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐28ELISCOMP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐29ELISPAR. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐31ELLEV. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐33ELPAR  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐35ELPARN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐37ELSLEN  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐38ELWEIGHT  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐39SUBNM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐41SUBSIZ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐43TABDIM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐44TM1User. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐45VIEW. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐46

    Chapter 5 TM1 TurboIntegrator FunctionsASCII and Text TurboIntegrator Functions . . . . . . . . . . . . . . . . . . . . 5‐3

    ASCIIDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐4ASCIIOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐5SetInputCharacterSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐8SetOutputCharacterSet  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐12TextOutput. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐18

    Attribute Manipulation TurboIntegrator Functions . . . . . . . . . . 5-20

    xii TM1 Reference Guide

  • Table of Contents | Index

    AttrDelete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐21AttrInsert  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐22AttrPutN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐24AttrPutS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐25

    Chore Management TurboIntegrator Functions . . . . . . . . . . . . . . . 5‐26ChoreQuit  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐27SetChoreVerboseMessages  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐28

    Cube Manipulation TurboIntegrator Functions  . . . . . . . . . . . . . . . 5‐29CellGetN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐30CellGetS  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐31CellIsUpdateable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐32CellPutN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐34CellPutProportionalSpread . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐36CellPutS  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐38CubeCreate  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐40CubeDestroy  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐41CubeExists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐42CubeGetLogChanges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐43CubeSetLogChanges  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐44CubeUnload. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐45

    Dimension Manipulation TurboIntegrator Functions . . . . . . . . . 5-46DimensionCreate  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐47DimensionDeleteAllElements. . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐48

    xiii

  • Table of Contents | Index

    DimensionDestroy  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐49DimensionElementComponentAdd  . . . . . . . . . . . . . . . . . . . . . . 5‐50DimensionElementComponentDelete . . . . . . . . . . . . . . . . . . . . . 5‐51DimensionElementDelete  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐52DimensionElementInsert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐53DimensionElementPrincipalName. . . . . . . . . . . . . . . . . . . . . . . . 5‐55DimensionExists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐56DimensionSortOrder  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐57

    ODBC TurboIntegrator Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐60ODBCClose  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐61ODBCOpen  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐62ODBCOutput. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐63

    Process Control TurboIntegrator Functions . . . . . . . . . . . . . . . . 5-65ExecuteCommand. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐66ExecuteProcess  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐68GetProcessErrorFileDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐72GetProcessErrorFilename  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐73If. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐74ItemReject. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐76ItemSkip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐77ProcessBreak  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐78ProcessError. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐79ProcessQuit  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐80

    xiv TM1 Reference Guide

  • Table of Contents | Index

    While. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐81Rules Management TurboIntegrator Functions. . . . . . . . . . . . . . . . 5‐83

    CubeProcessFeeders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐84RuleLoadFromFile  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐85

    Security TurboIntegrator Functions . . . . . . . . . . . . . . . . . . . . . . 5-88AddClient. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐89AddGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐90AssignClientToGroup  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐91AssignClientPassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐92DeleteClient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐93DeleteGroup  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐94ElementSecurityGet  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐95ElementSecurityPut  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐96RemoveClientFromGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐98SecurityRefresh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐99

    Server Manipulation TurboIntegrator Functions. . . . . . . . . . . . 5-100BatchUpdateFinish . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐101BatchUpdateFinishWait . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐104BatchUpdateStart  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐106SaveDataAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐107ServerShutdown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐108

    Subset Manipulation TurboIntegrator Functions . . . . . . . . . . . 5-109SubsetAliasSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐110

    xv

  • Table of Contents | Index

    SubsetCreate  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐111SubsetCreateByMDX  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐112SubsetDeleteAllElements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐113SubsetDestroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐114SubsetElementDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐115SubsetElementInsert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐116SubsetExists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐117SubsetExpandAboveSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐118SubsetFormatStyleSet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐120SubsetGetElementName  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐122SubsetGetSize  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐123SubsetIsAllSet  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐124

    View Manipulation TurboIntegrator Functions . . . . . . . . . . . . 5-125PublishView. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐126ViewColumnDimensionSet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐128ViewColumnSuppressZeroesSet  . . . . . . . . . . . . . . . . . . . . . . . . 5‐130ViewConstruct. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐132ViewCreate  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐133ViewDestroy  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐134ViewExists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐135ViewExtractSkipCalcsSet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐136ViewExtractSkipRuleValuesSet  . . . . . . . . . . . . . . . . . . . . . . . . . 5‐138ViewExtractSkipZeroesSet  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐140

    xvi TM1 Reference Guide

  • Table of Contents | Index

    ViewRowDimensionSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐142ViewRowSuppressZeroesSet  . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐144ViewSubsetAssign  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐146ViewSuppressZeroesSet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐147ViewTitleDimensionSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐149ViewTitleElementSet  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐150ViewZeroOut. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐151

    Miscellaneous TurboIntegrator Functions . . . . . . . . . . . . . . . . . 5-152Expand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐153FileExists  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐155NumberToString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐156NumberToStringEx. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐157StringToNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐158StringToNumberEx. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐159WildcardFileSearch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐160

    TM1ProcessError.log file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐163

    Chapter 6 TM1 TurboIntegrator VariablesTurboIntegrator Local Variables  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6‐1

    DatasourceNameForServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6‐2DatasourceNameForClient  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6‐3DatasourceType  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6‐4DatasourceUsername . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6‐5

    xvii

  • Table of Contents | Index

    DatasourcePassword  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6‐6DatasourceCubeview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6‐7DatasourceDimensionSubset  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6‐8DatasourceASCIIDelimiter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6‐9DatasourceASCIIDecimalSeparator. . . . . . . . . . . . . . . . . . . . . . . 6‐10DatasourceASCIIThousandSeparator . . . . . . . . . . . . . . . . . . . . . 6‐11DatasourceASCIIQuoteCharacter  . . . . . . . . . . . . . . . . . . . . . . . . 6‐12DatasourceASCIIHeaderRecords . . . . . . . . . . . . . . . . . . . . . . . . . 6‐13Value_Is_String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6‐14NValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6‐15SValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6‐16OnMinorErrorDoItemSkip  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6‐17MinorErrorLogMax  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6‐19DataSourceODBOCatalog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6‐21DataSourceODBOConnectionString  . . . . . . . . . . . . . . . . . . . . . . 6‐22DataSourceODBOCubeName. . . . . . . . . . . . . . . . . . . . . . . . . . . . 6‐23DataSourceODBOHierarchyName  . . . . . . . . . . . . . . . . . . . . . . . 6‐24DataSourceODBOLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6‐25DataSourceODBOProvider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6‐26DataSourceODBOSAPClientID  . . . . . . . . . . . . . . . . . . . . . . . . . . 6‐27DataSourceODBOSAPClientLanguage . . . . . . . . . . . . . . . . . . . . 6‐28

    TurboIntegrator Global Variables  . . . . . . . . . . . . . . . . . . . . . . . . . . . 6‐29NumericGlobalVariable(ʹVariableNameʹ);  . . . . . . . . . . . . . . . . . 6‐30

    xviii TM1 Reference Guide

  • Table of Contents | Index

    StringGlobalVariable(ʹVariableNameʹ); . . . . . . . . . . . . . . . . . . . . 6‐30Implicit Global Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6‐31

    DataMinorErrorCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6‐32MetadataMinorErrorCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6‐33ProcessReturnCode  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6‐34PrologMinorErrorCount  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6‐36

    TurboIntegrator User Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6‐37NumericSessionVariable(ʹVariableNameʹ);. . . . . . . . . . . . . . . . . 6‐38StringSessionVariable(ʹVariableNameʹ); . . . . . . . . . . . . . . . . . . . 6‐38

    Chapter 7 MDX Function SupportSupport for Microsoft‐defined MDX expressions and functions  . . 7‐1

    List of Supported Member expressions . . . . . . . . . . . . . . . . . . 7-2List of Supported Member functions . . . . . . . . . . . . . . . . . . . . 7-2List of Supported Numeric functions  . . . . . . . . . . . . . . . . . . . . . . 7‐3List of Supported Set expressions  . . . . . . . . . . . . . . . . . . . . . . . . . 7‐3List of Supported Set functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . 7‐4List of Supported Tuple expressions . . . . . . . . . . . . . . . . . . . . . . . 7‐4

    TM1‐Specific MDX functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7‐5TM1FILTERBYPATTERN( ,  ). . . . . . . . . . . . . 7‐6TM1FILTERBYLEVEL( , ). . . . . . . . . . . . . . 7‐7TM1DRILLDOWNMEMBER( , |ALL [,RECURSIVE] )7‐8TM1Member  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7‐9

    xix

  • Table of Contents | Index

    TM1SORT( , ASC|DESC ). . . . . . . . . . . . . . . . . . . . . . . . . . . 7‐10TM1SORTBYINDEX( , ASC|DESC ). . . . . . . . . . . . . . . . . . 7‐11TM1SUBSETALL( )  . . . . . . . . . . . . . . . . . . . . . . . . . . 7‐12TM1SubsetToSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7‐13TM1TupleSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7‐14

    TM1‐Specific MDX expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7‐15.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7‐16.ANCESTORS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7‐17

    Index

    xx TM1 Reference Guide

  • Table of Contents | Index

    Preface

    Business Performance Management with Cognos TM1Business Performance Management is the continuous management and monitoring of Financial, Operational, Customer and Organizational performance across the enterprise. Business Performance Management solutions have the following capabilities to facilitate the proactive steering of business direction:

    • Wide deployment

    • Collaborative decision making

    • Continuous and real‐time review and refinement

    • Monitoring of Key Performance Indicators

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

    About This ManualThe TM1 Reference Guide is a collection of reference materials that describes TM1 functions, variables, and other programming elements.

    ix

  • Table of Contents | Index

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

    The Cognos TM1 Documentation SetThe Cognos TM1 documentation set is delivered as part of the Cognos TM1 installation. To view any TM1 manual in PDF format, click Start →All Programs →Cognos → TM1 →Documentation and select the manual you want to view. You can also access a complete library of TM1 documentation in HTML format by choosing Help →Contents and Index from the Server Explorer.

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

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

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

    Menu Name → Option Name

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

    code examples Code examples are in courier.

    x TM1 Operations Guide

  • Table of Contents | Index

    1 TM1 Windows and Dialog Boxes

    This chapter describes all significant TM1 windows and dialog boxes.

    Action Button Properties Dialog Box Advanced Options Dialog Box

    Attributes Editor Chore Setup Wizard

    Clients/Groups Window Clients Messaging Center Dialog Box

    Create a Dimension Dialog Box Creating Cube Dialog Box

    Create Server Replication Object Dialog Box Cube Properties Dialog Box

    Cube Viewer Delete Named Subsets Dialog Box

    Delete Named Views Dialog Box Dimension Editor

    Dimension Element Insert 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 View Dialog Box Filter Subset Dialog Box

    Get View Dialog Box (In-Spreadsheet Browser) In-Spreadsheet Browser Menu

    Message Log Window New Attribute Dialog Box

    TM1 Windows and Dialog Boxes 1-1

  • Table of Contents | Index

    Open Subset Dialog Box Open View Dialog Box

    Print Report Wizard Process Options Dialog Box

    Save Subset Dialog Box Save View Dialog Box

    Save View Dialog Box (In-Spreadsheet Browser) 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)

    TM1 Aliases Dialog Box Replicate Cube Dialog Box

    Security Assignments Dialog Box Subset Editor

    TM1 Options Dialog Box Transaction Log Query Dialog Box

    Transaction Log Query Results Dialog Box TurboIntegrator Editor

    View Extract Window View Styles Dialog Box

    1-2 TM1 Reference Guide

  • Action Button Properties Dialog Box Table of Contents | Index

    Action Button Properties Dialog Box

    Use the Action Button Properties dialog box to add a TM1 Action button to a worksheet. You can configure the button to run a process and/or navigate to another worksheet.

    For examples and steps on using Action buttons in worksheets, see the chapter, “Using the TM1 Action Button to Build Worksheet Applications” in the TM1 Developers Guide.

    TM1 Server This list includes the names of all TM1 servers currently available on your network.Select the TM1 server where the process or target worksheet is located for your Action button.

    Connect This button is available only when you are not connected to the server currently selected in the TM1 Server list box.Click this button to connect to the server that you selected in the TM1 Server list box.

    Disconnect This button is available only when you are connected to the server currently selected in the TM1 Server list box.Click this button to disconnect from the server that you selected in the TM1 Server box.

    TM1 Windows and Dialog Boxes 1-3

  • Action Button Properties Dialog Box Table of Contents | Index

    The Action Button Properties dialog box has the following tabs that configure the Action button.

    Action Select the action that you want the Action button to perform when it is clicked.• Run a Turbo Integrator Process – Select this option to 

    configure an Action button that runs a process. When you select this option, the Process tab becomes enabled.

    • Go to another Worksheet – Select this option to configure an Action button that navigates to another worksheet. When you select this option, the Worksheet tab becomes enabled.

    • Run a Process, then go to a Worksheet – Select this option to configure an Action button that runs a process and then navigates to another worksheet. When you select this option, both the Process and Worksheet tabs become enabled.

    OK Closes the Action Button Properties dialog box and inserts an Action button into your worksheet.

    Cancel Closes the Action Button Properties dialog box without inserting an Action button.

    1-4 TM1 Reference Guide

  • Action Button Properties Dialog Box Table of Contents | Index

    Process Tab

    Use the Process tab to configure an Action button to run a process.

    Process Use this list to select the process you want to run in one of the following ways:• To run a process that is available on the current TM1 

    server, select the process name from the list.• To retrieve both the process name and parameter values 

    from the current worksheet, select Get Process info from Worksheet.

    Options Opens the Process Options dialog where you can control the behavior of the Action button before and after the process is run.For details, see the section “Process Options Dialog Box.”

    Process Name This option appears only when you select the Get Process info from Worksheet in the Process list.Enter an Excel reference that provides the name of the process to run in one of the following ways.• To reference a single cell, use the following format: 

    =ColumnNameRowName. For example: =A1.• To reference a named range in Excel, use the following 

    format: =NameOfRange• To select the cell from the current worksheet, click the 

    Excel Reference   button next to the Process Name box.

    TM1 Windows and Dialog Boxes 1-5

  • Action Button Properties Dialog Box Table of Contents | Index

    Parameters Enter values for the process parameters, depending on how you selected the process name from the Process list.• If you selected a process from the Process list, the 

    Parameters grid appears with a list of the parameters for the selected process. You can enter values for each parameter directly into the grid or use an Excel reference that dynamically retrieves a parameter value from the current worksheet.

    • If you selected the Get Process info from Worksheet option in the Process list, you must use an Excel reference to retrieve the parameter values from the current worksheet. You can enter a reference to a single cell, a range of cells, or a named range. Any reference must point to the appropriate number of cells, depending on the number of parameters that the process is expecting.

    Click the Excel Reference   button to directly select the cell or range of cells from the worksheet.For examples, see “Procedure 3 – Selecting the Process to Run” in the TM1 Developers Guide.

    Excel Reference Creates an Excel reference that dynamically retrieves the process name or parameter value(s) from the current worksheet when the Action button is clicked.

    1-6 TM1 Reference Guide

  • Action Button Properties Dialog Box Table of Contents | Index

    Worksheet Tab

    Use the Worksheet tab to configure an Action button to navigate to another Excel worksheet.

    Look In Use one of the following methods to select a worksheet:• TM1 Applications – Select this option if you want to 

    choose a worksheet from the TM1 Applications tree.• Files – Select this option if you want to choose a 

    worksheet from your computer.

    Browse Click this button to select the worksheet to which you want to navigate.• If you selected the TM1 Applications option, a dialog box 

    appears where you can select a worksheet from the TM1 Applications tree.

    • If you selected the Files option, the Open dialog box appears where you can browse and select a file from your computer.

    TM1 Windows and Dialog Boxes 1-7

  • Action Button Properties Dialog Box Table of Contents | Index

    Workbook Contains the path and name of the Excel workbook to which you want to navigate. You can enter this value in one of the following ways:• Click the Browse button next to the Look In option to 

    select a workbook from either the TM1 Applications tree or from the files on your computer.

    • Click the Excel Reference   button to select a cell that evaluates to a workbook path and name.

    • Manually enter a workbook name and path.• Manually enter an Excel reference that evaluates to a 

    workbook path and name.The path for a workbook in the TM1 Applications tree uses the format:\\For example:Planning Sample\Bottom Up Input\Budget Input

    The path for a network file uses the format:\\\\For example:\\boston\reports\2007_summary.xls

    For details and examples, see “Procedure 3 – Selecting a Target Worksheet” in the TM1 Developers Guide.

    1-8 TM1 Reference Guide

  • Action Button Properties Dialog Box Table of Contents | Index

    Sheet Contains the name of the worksheet to which you want to navigate. You can enter this value in one of the following ways:• Click the Browse button to select a workbook and then 

    select a worksheet from the Sheet list.• Manually enter a worksheet name.• Manually enter an Excel reference that evaluates to a 

    worksheet name.

    • Click the Excel Reference   button to select a cell that evaluates to a worksheet name.

    For details and examples, see “Procedure 3 – Selecting a Target Worksheet” in the TM1 Developers Guide.

    Match Title Elements This option automatically matches and sets the title dimensions between the source and target worksheets when a user clicks the Action button to navigate to the target worksheet.For details and examples, see the section “Procedure 4 – Setting the Match Title Elements Option” in the TM1 Developers Guide.

    TM1 Windows and Dialog Boxes 1-9

  • Action Button Properties Dialog Box Table of Contents | Index

    Appearance Tab

    Use the Appearance tab to configure the visual appearance of the Action button.

    Replace Current Workbook

    This option determines how the target worksheet is opened.• If this option is not selected (default), the target 

    worksheet is opened in a new window in Excel or on a new tab in TM1 Web.

    • If this option is selected, the target worksheet is opened in the same window or tab, replacing the source worksheet.

    CAUTION: If you enable this option, remember to save your workbook before testing the new button. You could lose your changes if you click the button and cause the current workbook to close.

    Advanced Options Click this button to open the Advanced Options dialog box where you can manually map fields between the source and target worksheets for an Action button that navigates from one worksheet to another.For details, see the section “Advanced Options Dialog Box.“

    Caption Sets the caption text that displays on the Action button.

    Font Click this button to display the Font dialog box where you can set the font style and size for the button text.

    1-10 TM1 Reference Guide

  • Action Button Properties Dialog Box Table of Contents | Index

    Show Background Image

    Allows you to select an image file (bmp, gif, or jpg format) that will be stretched to fit the Action button.Select this option and then click Browse to locate and select the image file that you want to use.

    Display as Hyperlink Displays the Action button as a hyperlink with blue, underlined text instead of a standard button.This option is not available when you select the Show Background Image option.

    Preview This area shows a preview of the text caption, font style, font color and background color for the button.

    Colors Allows you to set the text and background colors for the Action button.Click the Text or Background color sample to display the Color dialog box where you can select a standard color or define a custom color.This option is not available when you select the Display as Hyperlink option.

    TM1 Windows and Dialog Boxes 1-11

  • Advanced Options Dialog Box Table of Contents | Index

    Advanced Options Dialog Box

    Use the Advanced Options dialog box to manually map fields between the source and target worksheets when you insert an Action button that navigates from one worksheet to another. This tool helps you map dimensions, cells, and values from the source worksheet to the target worksheet.

    NOTE: Advanced mapping is applied after any automatic mapping has been performed by the Match Title Elements option.

    For examples on using the Advanced Options dialog box, see “Using Advanced Navigation and Mapping Options” in the TM1 Developers Guide.

    Advanced Mapping Grid

    Use the Advanced Mapping grid to define the mapping of fields between the source and target worksheets. You can use the grid to specify how elements in 

    Add Adds a new row to the Advanced Mapping grid.

    Delete Deletes the selected row from the Advanced Mapping grid.

    OK Closes the Advanced Options dialog box and saves your settings.

    Cancel Closes the Advanced Options dialog box without saving your settings.

    1-12 TM1 Reference Guide

  • Advanced Options Dialog Box Table of Contents | Index

    the source and target worksheets get matched up when the target sheet opens. Each row in the grid defines one mapping configuration.

    Source Type This field represents the type of object for the value you want to map.Select the Source Type as follows:• SUBNM – Indicates that you are mapping from a cell that 

    contains a title dimension in the source worksheet.• Selected DBRW – Indicates that you are mapping from a 

    cell that contains a DBRW formula in the source worksheet.• Value – Indicates that you will enter a string or numeric 

    value that will be sent to the target.

    Source Object This field takes a value depending on what is selected in the Source Type field.Enter the Source Object as follows:• If Source Type is set to SUBNM, then you need to specify 

    the name of the title dimension that exists in the source worksheet.

    • If Source Type is set to Selected DBRW, then you need to specify the name of a row or column title dimension that exists in the source worksheet.

    • If Source Type is set to Value, then you need to enter a string or numeric value that will be sent to the target worksheet.

    You can also retrieve these values from the source worksheet by using the = symbol to create an Excel reference.

    TM1 Windows and Dialog Boxes 1-13

  • Advanced Options Dialog Box Table of Contents | Index

    Target Type This field is the type of cell in the target worksheet where the value from the Source Object field will be inserted.Select the Target Type as follows:• SUBNM – Indicates the target is a title dimension in the 

    target worksheet.• Named Range – Indicates the target is a named range in the 

    target worksheet.• Range – Indicates the target location is a cell in the target 

    worksheet.CAUTION: If you set Target Type to either a Named Range or Range, any pre‐existing data or formula in the target cell will be overwritten when you navigate with the Action button. If the target cell contains a TM1 DBRW function, then the function will be lost and the cell will not be able to connect to, read from, or write to the TM1 server.

    1-14 TM1 Reference Guide

  • Advanced Options Dialog Box Table of Contents | Index

    Target Object This field represents the location in the target worksheet where the value from the Source Object will be inserted.Enter the Target Object as follows, depending on your selection for Target Type:• If Target Type is set to SUBNM, you need to specify the 

    name of the title dimension in the target worksheet.• If Target Type is set to Named Range, you need to specify 

    the name of the range in the target worksheet.• If Target Type is set to Range, you need to specify the cell 

    location in the target worksheet.You can also use an Excel reference to retrieve the value for the Target Object field.For a detailed example, see “Procedure 4 – Setting Target Object” in the TM1 Developers Guide.

    Subset Enter a value for the Subset field when the Target Type field is set to SUBNM.

    Alias Enter a value for the Alias field when the Target Type field is set to SUBNM.

    TM1 Windows and Dialog Boxes 1-15

  • Attributes Editor Table of Contents | Index

    Attributes Editor

    Use the Attributes Editor to create and edit attributes for cubes, dimensions, elements, and replications. 

    Note that all elements include a Format attribute, which defines how element values display in the Cube Viewer. The default Format attribute value is Unstyled.

    File menu

    Edit menu

    Close Closes the Attributes Editor.

    Undo cell Undoes the last cell action. This option applies only to individual cells. You cannot undo actions applied to a range of cells.

    Cut Cuts the contents of selected cells to the Clipboard.

    Copy Copies the contents of selected cells to the Clipboard.

    Paste Pastes the contents of the Clipboard to selected cells.

    Add new attribute Opens the New Attribute dialog box, from which you can create a new attribute for the elements in the dimension.

    1-16 TM1 Reference Guide

  • Attributes Editor Table of Contents | Index

    Options

    The following options are available only when defining element attributes.

    Delete selected attribute

    Deletes a selected attribute. You must delete attributes individually; you cannot delete multiple attributes simultaneously.

    Clear Clears the contents of selected cells.

    Edit Element Format

    Opens the Number Format dialog box, from which you can assign Format attribute values.

    Format This option is available only when you select cells at the intersection of the Format column and element rows.Select an option from the Category list box to specify a display format for the selected cells.There are nine formats:

    General ‐ This format displays numbers without commas separating digits to the left of the decimal point. Negative values are prefixed with a minus sign (‐). Use the Precision option to specify the number of digits that follow the decimal point. Note that Rules‐derived values return integers only when set to General format.

    TM1 Windows and Dialog Boxes 1-17

  • Attributes Editor Table of Contents | Index

    Fixed ‐ This format displays numbers without commas separating digits to the left of the decimal point. Negative values are prefixed with a minus sign (‐); users have the option to use parentheses for negatives if preferred. Use the Precision option to specify the number of digits that follow the decimal point.

    Currency ‐ This format displays numbers with the currency symbol specified in your Windows Regional Settings Properties, and uses commas to separate every third digit to the left of the decimal point. Negative values are prefixed with a minus sign (‐). Use the Precision option to specify the number of digits that follow the decimal point.

    Date ‐ Eleven date formats are predefined.

    Time ‐ Five time formats are predefined.

    Percentage ‐ This format multiplies numbers by 100 and displays a following percent sign (%). Digits to the left of the decimal point do not use commas, and negative values are prefixed with a minus sign (‐). Use the Precision option to specify the number of digits that follow the decimal point. 

    1-18 TM1 Reference Guide

  • Attributes Editor Table of Contents | Index

    Scientific ‐ This format displays numbers in scientific notation. Negative values are prefixed with a minus sign (‐). Use the Precision option to specify the number of digits that follow the decimal point. 

    Custom ‐ You can define a custom format expression as needed.

    Precision This option determines the number of decimal places to display for a selected format. If a value has more decimal places than the specified precision, it is rounded off for display purposes only; the entire value is stored in the TM1 database.

    TM1 Windows and Dialog Boxes 1-19

  • Chore Setup Wizard Table of Contents | Index

    Chore Setup Wizard

    Use the Chore Setup Wizard to schedule a replication or process for synchronization or execution at a regular interval.

    The Wizard consists of two screens. In the first, you select the replications and processes to be included in the chore. In the second, you specify the start time for the initial execution of the chore and the subsequent interval at which the chore should execute.

    Screen 1 (Step 1)

    Available list Lists all replications and processes available for scheduling as chores.

    Selected list Lists the replications or processes selected for inclusion in the current chore.

    Add Click this button to move selected replications or processes from the Available list to the Selected list

    Add All Click this button to move all replications or processes from the Available list to the Selected list.

    Remove Click this button to move selected replications or processes from the Selected list to the Available list.

    1-20 TM1 Reference Guide

  • Chore Setup Wizard Table of Contents | Index

    Screen 2 (Step 2)

    Remove All Click this button to move all replications or processes from the Selected list to the Available list.

    Specify Values for Parameters

    Click to open the Parameter Values dialog box, from which you can specify values for any parameters associated with the selected process.

    Chore Start Date and Time

    Select a start date on the calendar and specify a start time in the Time field.

    Chore Execution Frequency

    Fill the appropriate fields to establish the interval at which the chore should be executed.

    Chore Schedule is Active

    Fill this box to activate the chore for execution at the specified start time and interval. Clear this box to activate the chore at a later time.

    TM1 Windows and Dialog Boxes 1-21

  • Clients/Groups Window Table of Contents | Index

    Clients/Groups Window

    The Clients/Groups window lets you create and modify clients and user groups on a server.

    Clients/Groups grid

    The Clients/Groups grid displays client names as row headings and user groups as column headings. An ‘X’ at the intersection of a client name and user group indicates the group to which the user belongs. Users can belong to multiple groups.

    The grid also includes several columns that display properties for clients on the server. 

    • The cell at the intersection of a client name and the Password column contains the password for the client. 

    • The cell at the intersection of a client name and the Expiration Days column contains the number of days for which the password is valid for the client. After this number of days elapses, the client can no longer log into the server with the assigned password. A client whose password is soon to expire begins receiving notification of the expiration five days before the expiration date.

    • The cell at the intersection of the client name and the Status column indicates whether the client is active on the server. 

    • The cell at the intersection of the client name and the Max Connections column indicates the maximum number of connections that can be established to the server with the associated client name and password.

    1-22 TM1 Reference Guide

  • Clients/Groups Window Table of Contents | Index

    Security menu

    Clients menu

    Groups menu

    Close Closes the Clients/Groups dialog box.

    Add New Client Opens the Creating New Client dialog box, from which you can create a new client on the server.

    Delete Client Deletes the currently selected client from the server.

    Disconnect Client Disconnects the currently selected client from the server.

    Set Password Sets the password for the currently selected client.

    Clear Password Clears the password for the currently selected client.

    Add New Group Opens the Creating New Group dialog box, from which you can create a new user group on the server.

    Delete Group Deletes the currently selected user group from the server.

    TM1 Windows and Dialog Boxes 1-23

  • Clients/Groups Window Table of Contents | Index

    Clients/Groups grid

    You can enter data for clients directly in the Clients/Groups grid.

    The grid includes several columns, as described below.

    Username Displays the usernames of all clients on the server.

    Password Identifies whether a password is defined for a given client.You can click in a cell at the intersection of the Password column and a client row, then type a password to assign a password to the client.After entering a password, TM1 prompts you to re‐enter the password for confirmation.

    Expiration Days Indicates the number of days that a given clientʹs password is valid.To assign expiration for a clientʹs password, click in the cell at the intersection of the Expiration Days column and the client row, then type an expiration value.

    Max Connections Identifies the maximum number of connections that can be made to the server by a given client.To assign a maximum number of connections for a client, click in the cell at the intersection of the Max Connections column and the client row, then type the maximum number of connections for the client.

    1-24 TM1 Reference Guide

  • Clients/Groups Window Table of Contents | Index

    Status Indicates the current connection status of a given client.

    User Groups There is one column for every user group on the server.To assign a client to a user group, fill the check box at the intersection of the user group column and the client name.Clients can belong to multiple user groups.

    TM1 Windows and Dialog Boxes 1-25

  • Clients Messaging Center Dialog Box Table of Contents | Index

    Clients Messaging Center Dialog Box

    The Clients Messaging Center dialog box lets you manage client connections to a TM1 server. You can also use this dialog box to remotely shut down a TM1 server. You must be a member of the ADMIN group for a server to access this dialog box.

    Select a server in the left pane of the Server Explorer, then choose Server → Server Manager to open the Clients Messaging Center dialog box.

    Shutdown Server Select this option to shut down the TM1 server, then specify a Minutes interval.

    Disconnect Clients Select this option to disconnect clients from the TM1 server, then specify a Minutes interval.You must click Select Clients to create or select a subset of clients to be disconnected.

    Broadcast Message to Selected Clients

    Select this option to broadcast a text message to clients connected to the TM1 server.Enter the message in the text box then click Select Clients to create or select a subset of clients to receive the message.

    1-26 TM1

of 599/599
TM1 Reference Guide
Embed Size (px)
Recommended