applix tm1 client 2.6.pdf

Applix TM1 Client

©Applix, Inc. 1997. All Rights Reserved.Applix TM1 Client - Version 2.6

Part # TM1CLNT2.6

Applix, Inc. prepared the information contained in this document for use by Applix personnel,customers, and prospects. Applix reserves the right to change the information in thisdocument without prior notice. The contents herein should not be construed as arepresentation or warranty by Applix. Applix assumes no responsibility for any errors thatmay appear in this document. The software described in this document is furnished under alicense and may be used only in accordance with the terms of such license.

Data Control for TM1, TM1 and Perspectives are trademarks of Applix Inc. IBM is atrademark of International Business Machines Corporation. Microsoft is a registeredtrademark and Windows is a trademark of Microsoft Corporation.

All other brand and product names are trademarks or registered trademarks of their respectiveowners.

RESTRICTED RIGHTS LEGENDUse, duplication, or disclosure by the U.S. Government is subject to restrictions as set forth in

subparagraphs (c) (1) (ii) of SFARS 252.277-7013, or inFAR 52.227-19, as applicable.

Print Date: 6/97

iii

Contents

Preface

Client PC Hardware Requirements........................................... ix

Client PC Software Requirements ...............................................x

About This Manual.......................................................................x

Conventions Used in This Manual ............................................ xi

How This Manual is Organized................................................ xii

Applix TM1 Documentation.................................................... xiii

Support Services ....................................................................... xiv

Chapter 1 Basic Concepts

The TM1 Client Approach ....................................................... 1-1

The Cube.................................................................................... 1-2

Reference By Name............................................................ 1-3

Multiple Dimensions ......................................................... 1-4

Automatic Consolidation .................................................. 1-5

The Slice: From Many Dimensions to Two............................. 1-6

Client/Server Architecture ...................................................... 1-8

Client and Server................................................................ 1-8

TM1 Client Administration...................................................... 1-9

Privileges ...........................................................................1-10

iv Applix TM1 Client

Transaction Logging ............................................................... 1-11

Contents v

Chapter 2 Tutorial

Loading TM1 in Excel............................................................... 2-1

Turning Off Automatic Recalculation..................................... 2-2

Setting the Reference Style ....................................................... 2-2

Loading TM1 in Lotus 1-2-3..................................................... 2-3

Turning Off Automatic Recalculation..................................... 2-3

Logging On................................................................................ 2-4

Changing Your Password ........................................................ 2-5

Viewing Cube Data................................................................... 2-6

The Default View ............................................................... 2-7

The Browse Dialog Box ..................................................... 2-7

Changing Elements Displayed.......................................... 2-8

Double-Click Drill Down .................................................. 2-8

Displaying Consolidated Values....................................... 2-9

Changing Perspectives......................................................2-10

Entering Data ...........................................................................2-11

Privileges and Entering Data ...........................................2-13

The CALC Flag..................................................................2-13

Creating a Slice Worksheet .....................................................2-14

Changing Elements Used to Retrieve Data.....................2-15

Changing the Cube Reference in a Slice Worksheet.......2-17

Saving the Slice Worksheet .....................................................2-18

Cube References.......................................................................2-18

Writing a Cube Reference.................................................2-20

Reserving and Locking Values in the Database ....................2-23

vi Applix TM1 Client

Setting Network Options........................................................ 2-26

Connecting to Multiple Servers ............................................. 2-27

Disconnecting From All TM1 Servers ................................... 2-27

Chapter 3 Worksheet Functions

DBGEN(Type,Value,Cube,K1,K2[,…K8]) ............................... 3-2

Arguments .......................................................................... 3-2

Example............................................................................... 3-2

DBGEN16(Type,Value,Cube,K1,K2[,…K16]).......................... 3-3

Arguments .......................................................................... 3-3

Example............................................................................... 3-3

DBRn(Cube,K1,K2[,...Kn]) ........................................................ 3-4

Arguments .......................................................................... 3-4

Example............................................................................... 3-4

DBRWn(Cube,K1,K2[,...Kn]) .................................................... 3-5

Arguments .......................................................................... 3-5

Example............................................................................... 3-5

DBRX(Handle,Cube,K1,K2[,...Kn]) .......................................... 3-6

Arguments .......................................................................... 3-6

Example............................................................................... 3-6

DBSn(Value,Cube,K1,K2[,...Kn]).............................................. 3-7

Arguments .......................................................................... 3-7

Example............................................................................... 3-8

DBSSn(String,Cube,K1,K2,...Kn).............................................. 3-8

Arguments .......................................................................... 3-8

Example............................................................................... 3-9

Contents vii

DBSWn(Cube,K1,K2[,...Kn])..................................................... 3-9

Arguments.......................................................................... 3-9

Example .............................................................................3-10

DFRST(Dimension)..................................................................3-10

Argument...........................................................................3-10

Example .............................................................................3-10

DIMIX(Dimension,Element) ...................................................3-11

Arguments.........................................................................3-11

Example .............................................................................3-11

DIMNM(Dimension,Index).....................................................3-11

Arguments.........................................................................3-12

Example .............................................................................3-12

DIMSIZ(Dimension) ................................................................3-12

Argument...........................................................................3-12

Example .............................................................................3-12

DNEXT(Dimension,Element)..................................................3-13

Arguments.........................................................................3-13

Example .............................................................................3-13

DNLEV(Dimension) ................................................................3-13

Argument...........................................................................3-13

Example .............................................................................3-14

DTYPE(Dimension, Element) .................................................3-14

Arguments.........................................................................3-15

Example .............................................................................3-15

ELCOMP(Dimension,Element,Index) ....................................3-15

viii Applix TM1 Client

Arguments ........................................................................ 3-15

Example............................................................................. 3-16

ELCOMPN(Dimension,Element)........................................... 3-16

Arguments ........................................................................ 3-16

Example............................................................................. 3-16

ELISCOMP(Dimension,Element1,Element2)........................ 3-17

Arguments ........................................................................ 3-17

Example............................................................................. 3-17

ELISPAR(Dimension,Element1,Element2)............................ 3-18

Arguments ........................................................................ 3-18

Example............................................................................. 3-18

ELLEV(Dimension,Element) .................................................. 3-19

Arguments ........................................................................ 3-19

Example............................................................................. 3-19

ELPAR(Dimension,Element,Index) ....................................... 3-20

Arguments ........................................................................ 3-20

Example............................................................................. 3-20

ELPARN(Dimension,Element)............................................... 3-21

Arguments ........................................................................ 3-21

Example............................................................................. 3-21

ELSLEN(Dimension,Element)................................................ 3-21

Arguments ........................................................................ 3-21

Example............................................................................. 3-22

ELWEIGHT(Dimension,Element,Component)..................... 3-22

Arguments ........................................................................ 3-22

Contents ix

Example .............................................................................3-22

SUBNM(Dimension,Subset,Index) .........................................3-23

Arguments.........................................................................3-23

Example .............................................................................3-23

SUBSIZ(Dimension,Subset).....................................................3-24

Arguments.........................................................................3-24

Example .............................................................................3-24

TABDIM(Cube,Index) .............................................................3-24

Arguments.........................................................................3-25

Example .............................................................................3-25

VIEW(Cube,K1,K2,......Kn,) .....................................................3-25

Arguments.........................................................................3-26

Example .............................................................................3-26

Chapter 4 Macro Functions

Accessing Macro Functions...................................................... 4-2

Accessing Macro Functions from Excel Versions 5 and 74-2

Accessing Macro Functions from Excel Version 8 .......... 4-3

Accessing Macro Functions from VBA ............................ 4-4

Accessing Macro Functions from Lotus 1-2-3.................. 4-4

Function Descriptions............................................................... 4-5

Appendix A Error Messages

General Errors.......................................................................... A-1

Dimension Error Messages ..................................................... A-5

Network Error Messages ........................................................ A-9

x Applix TM1 Client

Rules Error Messages............................................................. A-16

System Error Messages.......................................................... A-18

Cube Error Messages ............................................................. A-19

Index

ix

Preface

TM1 Client enables you to integrate the popular Microsoft Excel orLotus 1-2-3 spreadsheets with the powerful TM1 Server multi-dimensional On-Line Analytical Processing (OLAP) engine. Thisstructure forms the ideal client/server architecture for planning,analysis, reporting, budgeting and other decision support tasks.

TM1 Client lets you access the shared on-line analytical serverwith full security to use and/or create multi-dimensionalspreadsheets, and to conduct extensive analyses with the TM1Browse feature.

Client PC Hardware Requirements

In determining the hardware requirements for the client PC, youshould adhere to the requirements set forth by Lotus andMicrosoft for their spreadsheets. Minimum hardwareconfigurations to run TM1 Client on Excel Version 5.x or 7.x andLotus 1-2-3 Release 5 are a 386 or greater microprocessor and 8Mbof RAM. Minimum hardware configurations to run TM1 Client onExcel Version 8.0 are a 386 or greater microprocessor and 16Mb ofRAM. See the Applix TM1 Server manual for information aboutserver requirements.

Client PC Software Requirements

x Applix TM1 Client

Client PC Software Requirements

TM1 Client runs on Windows 95, NT 3.51, and NT 4.0.

TM1 Client Version 2.6 supports Microsoft Excel Versions 5, 7, and8, as well as Lotus 1-2-3 Release 5.

About This Manual

This guide is written for people who will be using Applix TM1Client to access data on a TM1 Server. It explains how to connectto TM1 Servers, and provides descriptions and explanations of allTM1 Client features.

Conventions Used in This Manual

Preface xi

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

Helvetica Helvetica text indicates that thisoption or object appears in thedocument window. For example,“Type the name of the document inthe File name entry area.”

File names, keys, directories,functions, and formulas/functionsare also indicated by Helvetica text.

Helvetica Bold Bold Helvetica text indicates anoption to chose or text to type. Itusually appears in numbered steps.

Italics Words are italicized for emphasisor to draw your attention to a newterm. For example, “Do not pressthe RETURN key, or “This action iscalled word wrapping.”

Menu Name ➝ Option Name Whenever you see a reference to amenu option, the option isidentified using the followingnotation:

Menu Name ➝ Option Name

For example, "Choose File ➝Save."

How This Manual is Organized

xii Applix TM1 Client

Certain actions require you to select cells in a worksheet. Thisguide uses the term click-select for this operation.

To click-select:

In Excel, double click on the cell.

In 1-2-3, click once on the cell and press <Ins>.

How This Manual is Organized

Chapter 1 Basic Concepts provides an overview of TM1Client and explains basic concepts you need toknow to use TM1 effectively.

Chapter 2 Tutorial provides step-by-step instructions forusing the TM1 Client with Excel or Lotus 1-2-3.

Chapter 3 Worksheet Functions provides descriptions of allworksheet functions.

Chapter 4 Macro Functions provides descriptions of allmacro functions.

Appendix A Error Messages describes TM1 error messages.

Applix TM1 Documentation

Preface xiii

Applix TM1 Documentation

In addition to this manual, there are several other manuals towhich you may want to refer.

TM1 Perspectives Describes the powerful TM1 PerspectivesOnline Analytic Processing (OLAP) productfor Microsoft Excel. This product allows youto quickly retrieve and analyzemultidimensional data from the TM1database.

TM1 Server Describes the TM1 Server, which servicesrequests for data from TM1 client programssuch as TM1 Perspectives. The server storesand maintains data, and acts as a bridgebetween the client software and your datawarehouse.

TM1 Data Control Data Control is a powerful program formanaging the data processing activities ofan Applix TM1 application. Data Controlcombines TM1’s multidimensional databaseengine, direct ODBC access to source data,and the richness of the Microsoft Excelenvironment to give the developer controland flexibility to manage the back-endfunctions of a TM1 application.

TM1 API 2.0 This manual describes all the functions andfeatures of the TM1 API 2.0. The APIprovides complete access to all the featuresand functionality of the TM1 OLAP engine.The API is designed for use with C, C++,and Microsoft Visual Basic.

Support Services

xiv Applix TM1 Client

Support Services

Applix, Inc. provides a wide range of support services, including:

Training classes Held at local sites, at the Applix corporateheadquarters, or at your facility.

Consulting Services To cover issues such as application design,performance tuning and site-specificrequirements.

Technical Services Several different service programs areavailable. (Please contact your accountmanager.)

Applix also sponsors local and national user group meetings, aperiodic newsletter, and the hosting of customer advisorycommittees. For more information about these services, pleasecontact us via telephone at (508) 870-0300, via fax at (508) 366-0995,or via electronic mail at [email protected].

1

Basic Concepts

The TM1 Client Approach

With traditional spreadsheets, data is tied to the spreadsheet. Newdata requires a new spreadsheet, and common data must beentered separately into each spreadsheet.

TM1 Client solves these problems by storing data not in thespreadsheet, but in separate database files called cubes. Cubesreside on a separate computer called the TM1 Server. Clientspreadsheets on the network read and write cube values bycommunicating with this server. Each piece of data is stored onlyonce in the database cube and can be accessedsimultaneously by any number of Client computers andspreadsheets connected to the TM1 Server.

The Cube

2 Applix TM1 Client

The following figure shows the client/server architecture.

The Cube

A TM1 cube is a type of database. However, unlike otherdatabases you may be familiar with, it is specially designed for theoperations that spreadsheet applications typically need.

Like a spreadsheet, a cube is an array of values; unlike aspreadsheet, a cube references data by name, is multidimensional,and provides automatic consolidation.

The Cube

Basic Concepts 3

Reference By Name

A TM1 cube is made up of dimensions. A dimension is a list oflabels or elements. To identify a value in a cube, TM1 Client useselement names (for example, California, Telephone, and March).

Values from cubes are retrieved by a series of functions providedwith TM1 Client. For example, to retrieve the amount budgeted inCalifornia for telephone expenses in March from the xbudget cube,you could write:

=DBR(“xbudget”, “California”, “Telephone”, “March”)

When this function is executed, the spreadsheet client sends amessage requesting data from the TM1 Server using these names,and the TM1 Server responds by returning the value. The valuereturned becomes the value of the function. The following figureillustrates this concept.

This and other functions are covered in more detail in laterchapters and in Appendix A.

The Cube

4 Applix TM1 Client

Multiple Dimensions

A cell in most stand-alone spreadsheets is identified by a row anda column. A single spreadsheet, much like a report, is two-dimensional.

Most current spreadsheet products support three-dimensionalspreadsheets or workbooks, where cells are identified by a row, acolumn, and a page. Such spreadsheets can be useful when similarspreadsheets need to be linked together. For example, if divisionsin a company each make an expense report in identical form, thereports can be stored behind one another, like pages in a book,rather than in separate files.

You need three dimensions to compare data in three differentways. In the example stated above, you have three dimensions, oraspects of comparison:

LOCATION to compare expenses in different regions.

EXPENSE to compare different categories of expenses.

MONTH to compare expenses from month to month.

The Cube

Basic Concepts 5

As long as you want to compare data in only three ways, threedimensions are sufficient. However, analysts often break up datain four ways or more. For example, you may also want to look atdata by division.

In this case, you introduce a fourth aspect of comparison thedata becomes four-dimensional. It is easy to imagine the need tocompare budgeted numbers to actual numbers, resulting in a fifthdimension.

Although you cannot visualize an object with more than threephysical dimensions, it’s not necessary to visualize the data inorder to work with it. Analysts work with multidimensional dataall the time.

No three-dimensional spreadsheet can handle such a situation.However, a TM1 cube can be created with up to 16 dimensions,allowing a wide variety of possible analyses.

Automatic Consolidation

TM1 lets you define some dimension elements as calculatedelements, which are totals of other elements. Thus, a dimensionfor months could be arranged with calculated elements as shownin the following illustration.

The Slice: From Many Dimensions to Two

6 Applix TM1 Client

When a spreadsheet calls for a value using the name Second Qtr,the TM1 server automatically adds up the corresponding valuesfor April, May, and June.

If the spreadsheet calls for a value using the name Total Year, theTM1 server adds up the values for all quarters. The TM1 databaseis specially designed to do this type of calculation at high speed.


Multiple dimensions are essential for analysis. However, to writereports or to display data in a spreadsheet, you must representdata in a two-dimensional model a paper report or aspreadsheet.


Basic Concepts 7

The most common way to select two-dimensional data from a TM1cube is by slicing the cube. Slicing a cube assigns the elements ofone dimension to the rows of a spreadsheet and the elements ofanother dimension to the columns of the spreadsheet. Otherdimensions are held constant for some selected elements. Forexample, if you have a three-dimensional cube comprised of thedimensions Months, Accounts, and Locations, some possible slicesof this cube are:

• Columns MONTHS, rows ACCOUNTS, displaying data for aselected location. This is the normal format of an incomestatement.

• Columns MONTHS, rows LOCATIONS, displaying data for aselected account. This might be used, for example, to comparesales at each location.

• Columns LOCATIONS, rows ACCOUNTS, displaying data fora selected month. This might be used to compare entireincome statements for a month.

The principle remains the same for a four-dimensional cube. Twodimensions are laid out along the rows and columns, and each ofthe other two is held constant for selected element.

If the cube also has a DIVISION dimension, some possible slicesmight be:

• Columns MONTHS, rows LOCATIONS, displaying data forone division and one account.

• Columns DIVISIONS, rows LOCATIONS, displaying data forone account and one month.

• Columns MONTHS, row DIVISIONS, displaying data for onelocation and one account.

Client/Server Architecture

8 Applix TM1 Client

If you do financial reporting, you have probably learned the hardway that management often asks for reports not accommodated byyour applications. Very often, these reports are different slices ofthe same data. Using TM1 Client, such reports are easy toproduce.

Client/Server Architecture

TM1 Client is designed with a client/server architecture. Thisarchitecture allows for a much more efficient use of computerresources. Operations such as the management of large amountsof data and the complex handling of millions of numbers requireshigh computing speed and large amounts of memory. Theseoperations are assigned to a central, more powerful servercomputer. In turn, operations such as reporting and analysisrequire less computing power and can be assigned to less powerfulclient computers. In effect, the less powerful client computersshare the resources of a more powerful server across a network.

Client and Server

As the term client/server implies, two different types of softwareare required to run the TM1 Client: the server and the clientsoftware.

The TM1 Server

The TM1 Server allows a client to access shared cube data. Theserver, when running, loads all cubes and dimensions specified bythe administrator into memory.

TM1 Server software performs three basic functions:

TM1 Client Administration

Basic Concepts 9

• It manages data and consolidations in RAM (and on pagingdrives) and responds to data requests from clients.

• It manages security, granting or denying access to databasevalues.

• It maintains a log of changes (transaction log) to the database.

The Client

As a client, you interact with the TM1 Server through aspreadsheet program. TM1 Client comes with add-in modulesthat work with industry-standard spreadsheet products. TM1Client’s capabilities are fully integrated with the spreadsheetinterface with which you are most familiar. When you invoke theTM1 Client, a TM1.ADM file returns a list of available TM1 Serverson the network. With the correct server name, user ID, andpassword, TM1 Client allows you to log on to the server andaccess the data in its memory. A single TM1 Client cansimultaneously log on to up to nine servers on a network.

TM1 Client AdministrationAn administrator manages the TM1 Client installation. Before youcan use TM1 Client, the administrator must set you up as a client.

TM1 Client cubes are loaded into the memory of the TM1 servercomputer. This provides instant access to the data. The servermust be up and running before you can access cubes.

The administrator determines which cubes are loaded on theserver. The administrator also defines which cubes individualclients can read or update. Read and update privileges can also beassigned by dimension element. These and other administrationfunctions are fully described in the Applix TM1 Server manual.

TM1 Client Administration

10 Applix TM1 Client

Privileges

The TM1 Server provides a multi-user environment, and musttherefor provide strict security access to its data. When you log onto a TM1 Server, TM1 Client determines your ability to read orupdate data in cubes based on privileges assigned by theadministrator.

The following levels of privileges can be assigned to a cube ordimension element:

NONE Client cannot view or update values. Viewinga cube with values to which you have noaccess will display N/A for those values.

READ Client can view values but not change them.

WRITE Client can view and change values.

RESERVE Client can view and change values. Inaddition, Client can temporarily reservevalues so that no one else can work with them.

LOCK Client can view, change, and reserve values.In addition, Client can permanently lockvalues so that they can no longer be changed.

There is no UNLOCK privilege. Values can be unlocked only bythe administrator.

Transaction Logging

Basic Concepts 11

Transaction Logging

TM1 Client provides backup, recovery, and control capabilities bymeans of the transaction log. Whenever a value in a cube ischanged, TM1 Client writes a record to a log file stating:

• the time of the change

• the client performing the change

• the value before the change

• the value after the change

• the name of the cube and dimension elements that identify thevalue

The administrator uses this log file to recover the database in theevent of computer failure. Also, the administrator can selectivelyundo changes made by one client or a group of clients. If you needto revert changes you have made, see your administrator.

Transaction Logging


2-1

2 - Tutorial

TM1 Client lets you connect to the TM1 Server using Excel orLotus 1-2-3.

This chapter takes you step-by-step through the basic features ofTM1 Client. It assumes that the administrator has set you up touse TM1 Client.

TM1 Client includes a subset of the functions of TM1Perspectives. The Client version has the capability to work withcubes that reside on the TM1 Server. TM1 Perspectives has theadditional capability of creating and updating dimensions,creating and working with your own cubes, and importing andexporting ASCII files.

Loading TM1 in Excel

To load TM1 in Excel, simply start Excel as you normally would.The TM1 add-in is automatically loaded and placed on the menubar as TM1.

If TM1 does not appear, contact your administrator.

Turning Off Automatic Recalculation

2-2 Applix TM1 Client


Excel has automatic recalculation set as a default. This means thatevery time you change a number or formula, all calculations in theworksheet are performed. If you work with large spreadsheets,you have already discovered that this feature can slow your worksubstantially. Applix recommends that you turn automaticrecalculation off and manually recalculate worksheets by pressingF9.

Follow these steps to turn off automatic recalculation:

1. Choose Tools → Options .

2. Click the Calculation tab.

The Calculation dialog box appears.

3. Click Manual .

4. Click OK.

Setting the Reference Style

Excel lets you select from two different reference styles, A1 andR1C1, for displaying and referring to cells. The instructions inthis manual use the A1 reference style where worksheet columnsare labeled with letters and rows are labeled with numbers.

TM1 Client accepts both the A1 and the R1C1 reference styles.

Look at the worksheet on your screen. If the columns are labeledwith letters, the worksheet is set to use the A1 reference style.

Loading TM1 in Lotus 1-2-3

Tutorial 2-3

If the columns are labeled with numbers, you can follow thesesteps to change the reference style:

1. Choose Tools → Options .

2. Click the General tab.

3. In the Reference Style panel, choose the A1 option.

4. Click OK.

Your Excel interface now corresponds to the examples providedin this manual.

Loading TM1 in Lotus 1-2-3

To load TM1 in Lotus 1-2-3, simply start 1-2-3 as you normallywould. The TM1 add-in is automatically loaded and placed on themenu bar as TM1.

If TM1 does not appear, contact your administrator.


Lotus 1-2-3 has automatic recalculation set as a default. Thismeans that every time you change a number or formula, allcalculations in the worksheet are performed. If you work withlarge spreadsheets, you have already discovered that this featurecan slow your work substantially. It is recommended that you

Logging On


turn off automatic recalculation and manually recalculateworksheets by pressing F9.

Follow these steps to turn off automatic recalculation in Lotus 1-2-3:

1. Choose Tools → User Setup .

The Tools User Setup dialog box appears.

2. Click Recalculation .

3. Click Manual .

4. Click OK.

You are now ready to use TM1 Client with Lotus 1-2-3.

Logging On

Before you can log on to a server, you must set the ServerDefinition directory in TM1 Options to point to the TM1.ADM filethat contains the list of active network servers. The administratorcan tell you where the TM1.ADM file is located. The defaultlocation used in the setup is x:\TM1\PROGRAMS, where x is thenetwork drive letter.

The log on procedure asks for a server ID, a user ID, and apassword. Obtain these from your administrator. A special userID (USR2) and password (RED) is available for training purposes.

To log on to a TM1 Server:

1. Choose TM1 → Network → Connect .

Changing Your Password

Tutorial 2-5

The Connect to TM1 Server dialog box appears.

2. Select a Server ID from the drop-down list.

3. Enter USR2 or the user ID assigned to you in the Client IDfield.

4. Enter RED or the password assigned to you in the Passwordfield.

A message appears confirming that you are logged on to theserver.

Changing Your PasswordWhen logging on to a server, you can change your password byentering CHANGE in the Password field. You will be promptedfor your current password and then for the new password youwish to use. To confirm the new password you entered, you willbe prompted to re-enter the password. The password is thenchanged.

Viewing Cube Data


You can change your password only when logging on. If you arealready logged on to a server, you must first disconnect and thenlog on again to change your password.

Viewing Cube Data

TM1 Client allows you to look directly into the database cubeswith the Browse option. The Browse option lets you display andupdate data in the database cubes.

The examples in this section access TM1 Server files. To accessthese files, you must be connected to the TM1 Server.

To browse a cube:

1. Choose TM1 → Browse Cubes .

A list of available cubes appears. Cube names are precededby the TM1 Server name and a colon (:).

2. Select the desired cube and click Show .

For example, if you select the cube xbudget, the followinginformation appears in your spreadsheet window. Thisinformation includes data for the xbudget cube, as well as theBrowse dialog box, which lets you navigate through the cube

Viewing Cube Data

Tutorial 2-7

The Default View

When you initially open a cube, the Browse option displays thedefault view of the cube as follows:

• the last dimension as columns

• the next-to-last dimension as rows

• the data for the first element of all other dimensions

In the previous example, the Browse option displays 1991California data, with the elements of xaccount as row headings,and the elements of xmonth as column headings.

The Browse Dialog Box

The Browse dialog box includes the following items:

• The name of the view, if applicable, represented by theconfiguration of the buttons on the Browse dialog box

Viewing Cube Data


• The name of the cube you are browsing

• One button per dimension in the cube

• Option buttons: File, Options, Show, Close, and Help

The Browse dialog box also allows you to change the view of acube.

You can:

• Change elements displayed. For example, you can change ayear from 1992 to 1993. You can also change a simpleelement, such as California, to a consolidated element, such asTotal U.S.

• Change perspectives. For example, you can change thedimensions used as rows or columns.

Changing Elements Displayed

In the example, you can change the elements displayed byfollowing these steps:

1. Click the xregion button on the Browse dialog box.

Viewing Cube Data

Tutorial 2-9

The Dimension dialog box appears, displaying a list of theelements contained in the xregion dimension.

2. Double-click Oregon .

Oregon replaces California in the worksheet, and the values inthe spreadsheet change to reflect the budget for Oregon.

Double-Click Drill Down

While browsing Cubes, TM1 Client allows you to double-clickdrill down on consolidated elements. This means that while youbrowse, double-clicking on a consolidated element causes TM1 toautomatically show the components of that consolidation.

Double-Cl ick on "Europe".

Components of "Europe" are d isplayed.

Viewing Cube Data


Displaying Consolidated Values

To display consolidated values, select a consolidated elementfrom the list of dimension elements.

For example, in the cube xbudget, the xregion dimension definesthe element Total U.S. as the sum of all other regions.

Follow these steps to view the consolidated value for Total U.S.

1. Click xregion on the Browse dialog box.

The Dimension dialog box displays a list of the elementscontained in the xregion dimension.

2. Select Total U.S.

3. Click OK.

Notice that it takes slightly longer to display the Total U.S. datathan it does to display any of the individual regions. This isbecause calculated values are not stored in the cubes, but areproduced as needed. This ensures that the most currentcalculated values are always available.

Changing Perspectives

Follow these steps to change dimensions used as rows (orcolumns):

1. Click and hold down xregion on the Browse dialog box.

A white box appears in place of the dimension button. Thisbox acts as a placeholder for the button as you reconfigure thedialog box.

Viewing Cube Data

Tutorial 2-11

2. Drag the box over the xmonth button and release the mousebutton.

3. Move xmonth back to the top of the dialog box by dragging itover the xyear button.

4. Click OK.

You now have a side-by-side comparison of personnelexpense costs for 1991, by month, and for every region inyour database. The Browse dialog box appears as follows.

The Browse view appears as shown below.

Entering Data


Entering Data

The Browse option lets you directly enter or change cube values.To change a value, position the cursor in a Browse worksheet celland type the new value. Changes are immediately stored in thecube on the TM1 Server. You cannot change values that arecalculated or values that you are not authorized to change.

Your ability to update cube values is determined by the privilegesset by your administrator. Depending on how your system is setup, you can have rights to read but not to write certain values.You can only change cube values for which you have WRITEprivileges.

If TM1 returns the error message Value Cannot be Updated, oneof the following conditions exist:

• You do no have WRITE privileges for that value.

• The cell contains a reference to a calculated cube value.

As USR2, you have rights to update Washington for 1993 in thexbudget cube. Create another Browse view of the xbudget cube asfollows:

1. If the Browse dialog box is open, click Close to close it.


3. Click xbudget .

4. Click the xregion button in the Browse dialog box.

The Dimension dialog box displays a list of the elementscontained in the xregion dimension.

5. Select Washington and click OK.

Entering Data

Tutorial 2-13

6. Click xyear in the Browse dialog box.

The Dimension dialog box displays a list of elementscontained in the xyear dimension.

7. Select 1993 and click OK.

8. Click Show in the Browse dialog box.

9. Position the cursor in the cell at the intersection of Januaryand Personnel Expense and type a new number.

10. Press Enter .

The value in the cell at the intersection of January and PersonnelExpense is sent to the cube on the server.

Entering Data


Privileges and Entering Data

Access to data is controlled by the privileges assigned to you.Return to the Browse view of the xbudget cube and perform thesesteps:

1. Click xyear in the Browse dialog box.

The Dimension dialog box displays a list of the elementscontained in the xyear dimension.

2. Select 1991 and click OK.

3. Click Show .

4. Move to the cell at the intersection of January and PersonnelExpense and type a new number.

5. Press Enter .

This time, the error message Write Access Denied appears.This is because you do not have WRITE privileges to regionWashington for the year 1991.

6. Click OK.

The CALC Flag

Because TM1 Client operates in a shared environment, other usersmay simultaneously be working with the same cube data that youhave updated. They may be viewing the same value you havechanged, or they may be viewing a consolidation that depends onthe value you changed. If this happens, the CALC flag, orrecalculation indicator, appears on the worksheet to indicate thattheir data is not current. When the other users recalculate theirworksheets, the most recent values display.

To recalculate a worksheet, press F9.

Creating a Slice Worksheet

Tutorial 2-15


TM1 Client allows you to create Slice worksheets. A Sliceworksheet is a standard Excel or Lotus 1-2-3 worksheet thatcorresponds to a two-dimensional view of a cube. Sliceworksheets are connected to the TM1 database by means offormulas, and provide a powerful and flexible means ofproducing analyses and reports from the database.

To create a Slice worksheet, configure the Browse dialog box forthe perspective you want to show and then choose File → Slice.TM1 Client automatically generates the worksheet.

For example, to create a Slice worksheet from the xbudget cube:


A list of all available cubes appears.

2. Select xbudget and click OK.

The Browse dialog box for xbudget displays in defaultconfiguration.

3. Click File .

The Browse File Menu dialog box appears.



4. Click Slice .

A Slice worksheet is generated based on the default view of thexbudget cube. You can use this worksheet exactly as you wouldany other Excel or Lotus 1-2-3 worksheet.

The Slice worksheet generated from the default view of xbudgetappears as follows.

The top of the Slice worksheet lists the TM1 Server and cubename, as well as the elements used to retrieve the values in theworksheet. Although you cannot, at this time, change thedimensions used for rows and columns, you can change the cubeand the elements used to retrieve the data in the worksheet.

Changing Elements Used to Retrieve Data

To change the dimension elements used to retrieve the data in theworksheet:


Tutorial 2-17

1. Position the cursor on the dimension element you want tochange and click-select the cell.

The Dimension dialog box displays a list of all elements fromthat dimension.

2. Select the desired element.

3. Click OK.

4. Press F9 to recalculate the worksheet.

The new element replaces the old element, and the worksheetrecalculates to reflect the correct values associated with thatelement.

Follow these steps to change the elements used to return data inthe example Slice worksheet shown above:

1. Click-select cell B2.

The Dimension dialog box for the xregion dimension appears.

2. Select Florida .



3. Click OK.


You can use the same procedure to pick an element from thedimension xyear.

Your ability to view Slice worksheet data depends upon theprivileges you have been granted.

NOTE: The process that creates a Slice worksheet uses thefunction DIMNM to retrieve an element name from a dimension.When you click-select a cell containing a DIMNM formula, TM1Client automatically displays the Dimension dialog box for theassociated dimension.

Changing the Cube Reference in a Slice Worksheet

To change the cube from which data is retrieved, follow thesesteps:

1. Move the cursor to cell B1.

Saving the Slice Worksheet

Tutorial 2-19

2. Choose TM1 → Pick Cube .

A list of all available cubes appears in a dialog box.

3. Select xactual .

4. Click OK.


NOTE: The cube you select must have the same structure as theone that was used to create the Slice worksheet; all dimensionsand elements must appear in the same order in both cubes.Choosing a cube with a different structure produces an errormessage.

Saving the Slice Worksheet

To save a Slice worksheet, choose File → Save or File → Save Asfrom your spreadsheet menubar. A Slice worksheet, though itlooks like a standard worksheet, reactivates the link to thedatabase whenever it is opened.

Save the Slice worksheet for xbudget under the name xslice.

Cube References

All values in a Slice worksheet are the result of cube referencefunctions that retrieve values from a database cube. To illustratethis, open the Slice worksheet you just created.

Cube References


1. If the xslice worksheet is not displayed, choose File → Openand select xslice .

2. Position the cursor on cell B6.

3. Examine the edit line.

As you can see, the number in cell B6 is the result of a formulathat uses the cube reference function DBR4. (DBR4 is one of aseries of cube reference functions provided by TM1 Client.Additional functions are explained in Chapter 4.) The celladdresses in the formula are pointing to database cells, theintersection of which defines a value in the xbudget cube.

The first argument of the function points to cell B1($B$1), whichcontains the name of the server cube tm1serv:xbudget.

The rest of the arguments point to cells B2, B3, A6, and B5, whichcontain the names California, 1991, Personnel Expenses, andJanuary, respectively.

Cube References

Tutorial 2-21

The formula DBR4($B$1,$B$3,$B$2,$A6,B$5) can also be writtenas:

DBR4(,”tm1serv:xbudget”,”California”,”1991”,”PersonnelExpenses”, “January”)

You obtain two key advantages when you write formulas usingreferences to labels in the Slice worksheet:

• The same formula can be copied to retrieve a whole slice ofdata, which saves much work.

• The data is guaranteed to correspond to the label being used,which greatly reduces the possibility of error.

NOTE: Excel puts an equal sign (=) in front of every formula, andLotus 1-2-3 precedes the functions provided by TM1 Client with“@<<TM1>>“.

Writing a Cube Reference

TM1 Client provides an option for building cube referencefunctions.

1. Choose File → Open from your spreadsheet File menu.

2. Select xslice and click Open .

3. Select the range B8 to R30.

4. Press Delete to erase all existing cube references.

5. Position the cursor on cell B8.

6. Choose TM1 → Edit Formula .

The Edit Formula dialog box appears.

Cube References


7. Click DB Ref.

TM1 prompts you to select the cell containing the cube name.

8. Click–select cell B1.

The Select Type of Cell Reference dialog box appears.

This dialog box lets you specify how the DBR formulareferences the cell containing the cube name:

• Click Absolute to use an absolute ($A$1) reference in theDBR formula.

• Click Column Rel to use a column relative (A$1) referencein the DBR formula.

• Click Row Rel to use a row relative ($A1) reference in theDBR formula.

• Click Relative to use a relative (A1) reference in the DBRformula.

Cube References

Tutorial 2-23

In this example, the cube name appears in the Sheet Titlesarea and should be referenced with an absolute cell reference.

9. Click Absolute .

TM1 makes a best guess at building the rest of the formula foryou. It searches through the worksheet to identify the variouscells that will make up the arguments of your formula. It alsoidentifies the reference types automatically (row relative,column relative) so that you can later copy the formulathroughout the sheet.

Examine the choices that TM1 makes. It looks at cell B3 forthe element from the xregion dimension. It correctly identifiesthe position of this cell and assigns it an absolute reference($B$3). It looks to cell A6 for the element from the xaccountdimension and correctly identifies the reference to this cell asrow relative ($A6).

Examine the other references. Note that in all three cases,TM1 correctly identifies the type of cell referencing to use.

10. Click OK.

Reserving and Locking Values in the Database


The Edit Formula dialog box appears with the completed DBRformula.

11. Click OK to store the formula in cell B6.

12. Position the cursor in B6.

Cell B6 displays the value retrieved by the DBR formula.

To complete the report, you must copy and paste the formulain cell B6 to the range B6:R30.

13. Choose Edit → Copy to copy the formula.

14. Select the range B6:R30.

15. Choose Edit → Paste to insert the formula into all of the cellsin the range.

The value in B6 appears in all cells in the range.

16. Press F9 to recalculate the worksheet and update all values inthe range


TM1 Client assigns each user to a group. The server in turndefines which groups can read or write which cubes. Theadministrator can also choose to assign group privileges bydimension element.


Tutorial 2-25

A user can have any one of five privileges to a cube or dimensionelement. See Chapter 1 "Basic Concepts," for more information onprivileges.

The administrator assigns privileges when setting up the TM1Server. If you are assigned LOCK privileges, you can alsoRESERVE, READ, and WRITE.

If you have Reserve and/or Lock privileges, you can temporarilyreserve or permanently lock data resources.

For example, to reserve the xbudget cube:

1. Choose TM1 → Network → Security .

The following dialog box appears.

2. Click Reserve .

A dialog box prompts you to select the type of resource (i.e.,cube or element) you want to reserve.

3. Click Cube .

A dialog box containing a list of all cubes on the TM1 Serverappears.




The RESERVE option temporarily holds a cube or dimensionelement. When data is reserved, other users can view it, but theycannot update it until you release the resource or log out.

To release the xbudget cube:

1. Choose TM1 → Network → Security .

2. Click Release .

3. Click Cube .


The LOCK command permanently freezes a cube or dimensionelement. No one can change locked data.

Once a resource is locked, only the system administrator canrelease the resource. Locked cubes are usually used to storehistorical data that should not be updated.

If you have LOCK privileges, you automatically have RESERVEprivileges.

See your administrator to have privileges assigned.

Setting Network Options

Tutorial 2-27

Setting Network Options

The dialog box shown below allows you to change a number ofdefault settings that govern the operation of TM1 Client.

TM1 Client does not allow access to the Database Directory.

The Server Definition Directory field defines the directory that containsthe TM1.ADM file. This file contains a list of all available network serversand routing information for those servers. You can enter the path to thedirectory directly in the entry field, or you can click on the browse button

to navigate to the directory.

Consult your system administrator for the correct ServerDefinition Directory.

If Poll for Cube Changes is checked, TM1 Client polls the TM1Server to check if any other users have changed values in sharedcubes. If a shared cube has changed, the calculate flag at thebottom left of the screen flashes.

If Advanced Mode is checked, the Advanced mode of thedimension dialog box is set as a default. Advanced mode provides

Connecting to Multiple Servers


complex query and navigation options for manipulatingdimensions and elements.

When you are finished making network option changes, click OK.You will then be prompted to save the file called TM1.INI.

The TM1.INI file is used by TM1 Client to store default options.Saving this file sets the options you have selected as defaultoptions. The options will then be set to these new values the nexttime you access TM1 Client.

If you choose not to update this file, your network optionschanges will not be implemented.

NOTE: TM1.INI is saved to the Windows directory.

Connecting to Multiple ServersYou can connect to as many as nine (9) TM1 Serverssimultaneously. To connect to other TM1 Servers, use the sameprocess you used to connect to the primary TM1 Server. See“Logging On” earlier in this chapter for details.

Disconnecting From All TM1 ServersTo disconnect from all TM1 Servers:

1. Choose TM1 → Network → Disconnect .

A dialog box prompts you to confirm the disconnection.

2. Click Yes to disconnect from all the TM1 Server(s) to whichyou are currently connected.

You cannot selectively disconnect from individual servers.

Disconnecting From All TM1 Servers

Tutorial 2-29

NOTE: You are automatically disconnected from all TM1 Serverswhen you exit Excel or Lotus 1-2-3.

Disconnecting From All TM1 Servers


1

Worksheet Functions

Worksheet functions return a numeric or string value, and can beused anywhere within an Excel or 123 worksheet.

These functions are available using the Insert → Function option inExcel, and through the @ → List All option in Lotus 1-2-3.

You must adhere to the function format conventions for yourworksheet environment when using TM1 functions. In Excel, youmust prefix all functions with an equal symbol (=). In 1-2-3, youmust prefix all functions with the string @<<TM1>>.

TM1 worksheet functions accept strings, values, or cell referencesas arguments. Strings must be enclosed in quotation marks, andcell references must refer to valid arguments for a given function.You can use Excel and 1-2-3 conventions for absolute and relativecell references in worksheet functions.

Formulas written with cell references for their arguments presentsignificant advantages over formulas written with strings. Thestrings in the various cells referred to can be changed, thuschanging the intersection in the database to which the formularefers. Formulas written with cell references also have theadvantage of being copyable.

DBGEN(Type,Value,Cube,K1,K2[,…K8])

2 Applix TM1 Client

DBGEN(Type,Value,Cube,K1,K2[,…K8])

DBGEN sends numeric or string values to cubes containing up toeight dimensions. This function restores cubes with theTransaction Log, and is a generic version of the DB Sendfunctions (DBSn and DBSSn).

Arguments

Type Indicates whether the value being sent isnumeric, string, or calculated. Specify N fornumeric, S for string, or C for calculated.

Value The value being sent.

Cube The cube to which the value is sent.

K1, ...K8 The names of elements defining theintersection in the cube to which the value issent.

Arguments K1 through K8 are sequence-sensitive. K1 must be an element from thefirst dimension of the cube, K2 must be anelement from the second dimension of thecube, and so on.

Example

DBGEN(“N”,5342,”92act4d”,”California”,”3.5 Diskettes”,“Net Sales”,“January”)

DBGEN16(Type,Value,Cube,K1,K2[,…K16])

Worksheet Functions 3

This example sends the value numeric value 5342 to the cube92act4d at the intersection of California, 3.5 Diskettes, Net Sales,and January.

DBGEN16(Type,Value,Cube,K1,K2[,…K16])DBGEN sends numeric or string values to cubes containing morethan eight dimensions. This function restores cubes with theTransaction Log, and is a generic version of the DB Sendfunctions (DBSn and DBSSn).

Arguments

Type Indicates whether the value being sent isnumeric, string, or calculated. Specify N fornumeric, S for string, or C for calculated.




Arguments K1 through K8 are sequence-sensitive. K1 must be an element from thefirst dimension of the cube, K2 must be anelement from the second dimension of thecube, and so on.

DBRn(Cube,K1,K2[ ,...Kn])

4 Applix TM1 Client

Example

DBGEN16(78365,”91accounting”,”California”,”Track1”,”3.5Diskettes”, “Wholesale”,"Actual”,“Net Sales”,“External”,”Code2”,”January”)

This example sends the value 78365 to the cube 91accounting atthe intersection of California, Track1, 3.5 Diskettes, Wholesale,Actual, Net Sales, External, Code2, and January.

DBRn(Cube,K1,K2[,...Kn])

This function retrieves a value from a cube of n dimensions.

Arguments

Cube The name of the database cube from which toretrieve the value.

K1,…Kn Dimension element names that define theintersection of the cube containing the valueto be retrieved.

Arguments K1 through Kn are sequence-sensitive. K1 must be an element from thefirst dimension of the cube, K2 must be anelement from the second dimension, and soon.

DBRn(Cube,K1,K2[ ,...Kn])


Example

DBR4(“92act4d”, “California”, “3.5 Diskettes”, “Net Sales”,“January”)

In this case, 92act4d is the cube name, and the function returnsthe value at the intersection of California, 3.5 Diskettes, Net Sales,and January.

DBRWn(Cube,K1,K2[ ,...Kn])

6 Applix TM1 Client

DBRWn(Cube,K1,K2[,...K n] )This function works exactly the same as the DBRn functiondescribed above with one major difference; DBRWn reducesnetwork traffic and may improve performance on wide areanetworks.

In cubes with a large number of cube references, DBRWn forcesTM1 Client to send references in “bundles” rather than individually.Normal TM1 Client DB references are updated individually duringa recalculation. DBRW references force TM1 Client to execute twopasses over the worksheet. In the first pass, the function reads allchanges to values and sends them in a single bundle to the cube. Inthe second pass, the function reads the values in the cube and sendsthem in a single bundle back to the worksheet. As a result, theworksheet recalculates twice when the function is executed.

Arguments


K1,…Kn Dimension element names that define theintersection of the cube containing the value to beretrieved.

Arguments K1 through Kn are sequence-sensitive.K1 must be an element from the first dimension ofthe cube, K2 must be an element from the seconddimension, and so on.

Example

DBRW4(“92act4d”, “California”, “3.5 Diskettes”, “Net Sales”,“January”)

DBRX(Handle,Cube,K1,K2[ ,...Kn])


In this example, the function returns the value at the intersection ofCalifornia, 3.5 Diskettes, Net Sales, and January in the 92act4dcube.

DBRX(Handle,Cube,K1,K2[,...Kn])The DBRX function retrieves a value from a places the value in aslice worksheet. This function works only with slices created froma cube browse. It is optimized to work within the slice, andperforms better than the standard DBRn function.

In Lotus 1-2-3, this function requires that you specify the numberof dimension in the cube. For example, use DBRX3 to retrieve avalue from a cube containing 3 dimensions.

Arguments

Handle A reference to a cell containing a Slice function.


K1,…Kn Dimension element names that define theintersection of the cube containing the valueto be retrieved.

Arguments K1 through Kn are sequence-sensitive. K1 must be an element from thefirst dimension of the cube, K2 must be anelement from the second dimension, and soon.

DBSn(Value,Cube,K1,K2[,...Kn])

8 Applix TM1 Client

Example

DBRX(A5,”92act4d”,”California”,”3.5 Diskettes”,”NetSales”,”January”)

DBRX4(A5,”92act4d”,”California”,”3.5 Diskettes”,”NetSales”,”January”)

In this example, cell A5 contains a Slice function which points theDBRX function to a model in memory and 92act4d is the cubename. The function returns the value at the intersection ofCalifornia, 3.5 Diskettes, Net Sales, and January.

DBSn(Value,Cube,K1,K2[,...K n])

DBSn sends a numeric value to a cube of n dimensions. Thisfunction cannot send a string to a string cube (see DBSSn functionbelow).

When you build a DBSn function with the Edit Formula option,the Edit Formula dialog box prompts you through a series of stepsto build each function argument in the correct sequence.

Arguments



DBSSn(String,Cube,K1,K2,...Kn)



Arguments K1 through K8 are sequence-sensitive.K1 must be an element from the first dimension ofthe cube, K2 must be an element from the seconddimension of the cube, and so on.

If the cube does not exist or one of the arguments does not occurin the corresponding dimension, the function returns KEYERROR.

Example

DBS4(5342,”92act4d”,”California”,”3.5 Diskettes”, “Net Sales”,“January”)

In this example, the function sends the value 5342 into the cube92act4d at the intersection of California, 3.5 Diskettes, Net Sales,and January.

DBSSn(String,Cube,K1,K2,...Kn)DBSSn sends a string to a string cube of n dimensions. Thisfunction cannot send a value to a numeric cube (see DBSnfunction above).

When you build a DBSSn function with the Edit Formula option,the Edit Formula dialog box prompts you through a series of stepsto build each function argument in the correct sequence.

DBSWn(Cube,K1,K2[,...Kn])


Arguments

String The string being sent.

Cube The cube to which the string is sent.

K1, ...K8 The names of elements defining theintersection in the cube to which the string issent.


If the cube does not exist or one of the arguments does not occurin the corresponding dimension, the function returns KEYERROR.

Example

DBSS2(“Smith”,”Info”,”California”,”Last Name”)

In this example, the formula sends the string Smith to the cubeInfo at the intersection of California and Last Name.

DBSWn(Cube,K1,K2[,...K n] )This function works exactly the same as the DBSn functiondescribed above with one major difference; DBSWn reducesnetwork traffic and may improve performance on wide areanetworks.

DBSWn(Cube,K1,K2[,...Kn])


In cubes with a large number of cube references, DBSWn forcesTM1 Client to send references in “bundles” rather thanindividually. Normal TM1 Client DB references are updatedindividually during a recalculation. DBSW references force TM1Client to execute two passes over the worksheet. In the first pass,the function reads all changes to values and sends them in a singlebundle to the cube. In the second pass, the function reads thevalues in the cube and sends them in a single bundle back to theworksheet. As a result, the worksheet recalculates twice when thefunction is executed.

Arguments





Example

DBSW4(5342,”92act4d”,”California”,”3.5 Diskettes”, “NetSales”, “January”)

In this example, the function sends the value 5342 into the cube92act4d at the intersection of California, 3.5 Diskettes, Net Sales,and January.

DFRST(Dimension)


DFRST(Dimension)

DFIRST returns the first element of a specified dimension.

Argument

Dimension A valid dimension name.

Example

DFRST(“Locations”)

If the dimension Locations contains the elements California,Oregon, and Washington, the example returns California.

DIMIX(Dimension,Element)

DIMIX returns the index number of an element within adimension.

Arguments


Element The name of an element within thedimension.

DIMNM(Dimension,Index)


If the element is not a member of thedimension specified, the function returns 0.

Example

DIMIX(“Locations”,”Washington”)

If the dimension Locations contains the elements California,Oregon, and Washington, the example returns the value 3, asWashington is the third element of the dimension.

DIMNM(Dimension,Index)

DIMNM returns the element of a dimension that corresponds tothe Index argument.

When you click select a cell containing a DIMNM function, theDimension dialog box appears. You can then select a new elementto place in your worksheet.

Arguments


Index A value less than or equal to the number ofelements in the dimension.

NOTE: To maintain functionality of the DIMNN function, do notuse cell references as arguments to the function.

DIMSIZ(Dimension)


Example

DIMNM(“Locations”,2)

If the Region dimension contains the elements California, Oregon,and Washington, the example returns Oregon.

DIMSIZ(Dimension)DIMSIZ returns the number of elements within a specified dimension.

Argument


Example

DIMSIZ(“Region”)

If the dimension Region contains 19 elements, the example returnsthe value 19.

DNEXT(Dimension,Element)

DNEXT returns the element name that follows the elementspecified as an argument to the function.

DNLEV(Dimension)


Arguments



Example

DNEXT(“Locations”,”Oregon”)

If the Locations dimension contains the elements California,Oregon, and Washington, the example returns Washington.

DNLEV(Dimension)

DNLEV returns the level number of the highest hierarchy level ina dimension.

Argument


Example

DNLEV(“Region”)

DTYPE(Dimension, Element)


In the Region dimension, the various countries (Level 0) add up toregions (Level 1). The regions then add up to super-regions (Level2), which in turn add up to the world (Level 3).

In the Region dimension, World is an element of the highesthierarchy level, Level 3. Therefore, the example returns the value 3.

DTYPE(Dimension, Element)

DTYPE returns information about the element type of a specifiedelement. Specifically, it returns N if the element is a numericelement, S if the element is a string element, and C if the elementis a calculated element.

Arguments


ELCOMP(Dimension,Element,Index)



Example

DTYPE(“Region”,”Europe”)

The element Europe in the dimension Region is a calculatedelement, so the example returns C.

ELCOMP(Dimension,Element,Index)

This function returns a component of a consolidated element in aspecified dimension.

Arguments



Index A positive value less than or equal to the totalnumber of components in the specifiedelement.

Example

ELCOMP(“Region”,”Central Europe”,2)

ELCOMPN(Dimension,Element)


In the dimension Region, the consolidated element Central Europeis a consolidation of the components Germany and France.Accordingly, the example returns France.

ELCOMPN(Dimension,Element)

ELCOMPN returns the number of components in a specifiedelement.

Arguments



If the Element argument is an “N” element,the function returns 0.

Example

ELCOMPN(“Region”,”Scandanavia”)

In the dimension Region, the C element Scandanavia is aconsolidation of three elements. The example returns 3.

ELISCOMP(Dimension,Element1,Element2)


ELISCOMP(Dimension,Element1,Element2)

This function determines whether Element1 is a component ofElement2 in the specified dimension. The function returns TRUEif Element1 is a component of Element2, otherwise the functionreturns FALSE.

Arguments


Element1 The name of an element within thedimension.


Example

ELISCOMP(“Region”,”Germany”,”Central Europe”)

In the dimension Region, the C element Central Europe is aconsolidation of two elements, Germany and France. The examplereturns TRUE.

Note that this function returns TRUE only for immediatecomponents. In the above example, Germany is a component ofCentral Europe. Further, Central Europe is a component ofEurope. However, since the function returns TRUE only forimmediate components, the following example returns FALSE.

ELISCOMP (“Region”,”Germany”,”Europe”)

ELISPAR(Dimension,Element1,Element2)


ELISPAR(Dimension,Element1,Element2)

This function determines whether Element1 is a parent ofElement2 in the specified dimension. The function returns TRUEif Element1 is a parent of Element2, otherwise the functionreturns FALSE.

Arguments




Example

ELISPAR(“Region”,”Central Europe”,”Germany”)

In the dimension Region, the C element Central Europe is theparent of both Germany and France. The example returns TRUE.

Note that this function returns TRUE only for immediate parents.In the above example, Europe is a parent of Central Europe.Further, Central Europe is a parent of Germany. However,because Europe is not an immediate parent of Germany, thefollowing example returns FALSE.

ELISPAR(“Region”,”Europe”,”Germany”)

ELLEV(Dimension,Element)


ELLEV(Dimension,Element)

ELLEV returns the level of an element within a dimension.

Arguments



Example

ELLEV(“Region”,”Europe”)

In the Region dimension, individual countries (Level 0) add up toregions (Level 1). The regions then add up to super-regions (Level2), which in turn add up to the world (Level 3).

ELPAR(Dimension,Element,Index)


The example returns 2, as Europe is a Level 2 element.

ELPAR(Dimension,Element,Index)

This function returns the parent of an element in a specifieddimension. The parent of an element is any element that uses it asa component.

Arguments



Index A positive value less than or equal to the totalnumber of consolidated elements (parents)that use the Element argument as acomponent.

Example

ELPAR(“Model”,”Wagon 4WD”,2)

In the dimension Model, the element Wagon 4WD is a componentof both Total Wagons and Total 4WD. Therefore, both TotalWagons and Total 4WD are parents of Wagon 4WD. In thestructure of the Model dimension, Total Wagons is defined first,Total 4WD is defined second.

ELPARN(Dimension,Element)


The example returns Total 4WD, as this is the second instance of aparent to Wagon 4WD within the Model dimension.

ELPARN(Dimension,Element)ELPARN returns the number of parents of an element in aspecified dimension.

Arguments



Example

ELPARN(“Model”,”Wagon 4WD”)

In the dimension Model, the element Wagon 4WD is a componentof both Total Wagons and Total 4WD. Therefore, both TotalWagons and Total 4WD are parents of Wagon 4WD. The formulareturns 2.

ELSLEN(Dimension,Element)ELSLEN returns the length of a string element within adimension.

ELWEIGHT(Dimension,Element,Component)


Arguments



If the element specified is not a member of thedimension specified, or is not a stringelement, the function returns 0.

Example

ELSLEN(“Region”,”Washington”)

The element Washington is a string element 10 characters inlength. The example returns 10.

ELWEIGHT(Dimension,Element,Component)

This function returns the weight of a component in a consolidatedelement. The weight of a component is defined in column C of thedimension spreadsheet.

Arguments


Element The name of a consolidated element withinthe dimension.

SUBNM(Dimension,Subset,Index)


Component The name of a component of the consolidatedelement.

Example

ELWEIGHT(“Account1”,”Gross Margin”,”Variable Costs”)

In the following figure, the component Variable Costs has aweight of –1.

The example returns –1.

SUBNM(Dimension,Subset,Index)This function is analogous to the DIMNM function, with theexception that it returns the nth element of a dimension subsetinstead of the dimension.

When you click select a cell containing a SUBNM function, theDimension dialog box appears. You can then select a new elementto place in your worksheet.

Arguments


Subset The name of a subset within the dimension.

SUBSIZ(Dimension,Subset)


Index A positive value less than or equal to the totalnumber of elements in the specified subset.

Example

SUBNM(“Region”,”Americas”,2)

The subset Americas of the dimension Region contains thefollowing elements in this order: North America, South America,and Central America.

The example returns South America.

NOTE: To maintain functionality of the SUBNM function, do notuse cell references as arguments to the function.

SUBSIZ(Dimension,Subset)

This function returns the number of elements in a dimensionsubset.

Arguments


Subset The name of a subset within the dimension

Example

SUBSIZ (“Region”,”Americas”)

TABDIM(Cube,Index)


The subset Americas of the dimension Region contains threeelements: North America, South America, and Central America.

The example returns 3.

TABDIM(Cube,Index)TABDIM provides information on the dimension structure of acube. Specifically, it returns the dimension name thatcorresponds to the Index argument.

Arguments

Cube A valid cube name.

Index A positive value less than or equal to the totalnumber of dimensions in the cube.

Example

TABDIM(“92act4d”,3)

The cube 92act4d is made up of the four dimensions: Region,Products, Account, and Month. The example returns Account, thethird dimension of 92act4d.

VIEW(Cube,K1,K2,......Kn,)

A single VIEW function is created when you slice a view from acube browse.

VIEW(Cube,K1,K2,......Kn,)


This function creates an optimized view of the cube specified bythe cube parameter. All DBR and DBRW formulas that refer tothe View function can then access this optimized view. In thisway, results are returned much faster.

Multiple View functions can reside in the same spreadsheet if youhave blocks of DBR formulas that refer to different TM1 viewsand/or cubes.

Arguments

Cube The name of the cube from which to retrievedata.

K1,…Kn Either specific elements in the slice to be usedas titles, or the string “!” which indicates thatthe corresponding dimension is a row orcolumn in the view.

Example

VIEW(“93sales”,$B$2,$B$3,$B$4,”!”,”!”)

1

Macro Functions

In addition to providing functions for writing formulas inworksheets, TM1 Client also provides a series of Excel and Lotus1-2-3 functions that can be incorporated into macros. Thesefunctions let you write macros and turnkey systems that takeadvantage of TM1 Client's powerful database capabilities. Mostof these additional functions provided by TM1 Client arecommand-equivalent functions—that is, they replicate thecommands you invoke from the TM1 menu.

EXCEL_FUNCTION (Arguments)

2 Applix TM1 Client

Accessing Macro Functions

There are several ways to access the TM1 macro functions. Theprocedure you use varies according to spreadsheet product andversion.

Accessing Macro Functions from Excel Versions 5 and 7

To access macro functions from Excel Version 7 and earlier:

1. Choose Insert → Macro → MS Excel 4.0 Macro .

2. Choose Insert → Function .

The Function Wizard dialog box appears.

3. Select TM1 from the Function Category list box.

4. Double-click the function you want to insert in the FunctionName list box.

5. Enter the appropriate arguments in the Function Wizarddialog box.

6. Click Finish to complete the function and return the functionto your macro.


Macros 3

Accessing Macro Functions from Excel Version 8

To access macro functions from Excel Version 8:

1. Right-click the sheet tab of the active worksheet.

A pop-up menu appears.

2. Click Insert .

The Insert dialog box appears.

3. Click the General tab.

4. Click MS Excel 4.0 Macro .

5. Choose Insert → Function .

The Paste Function dialog box appears.

6. Select TM1 from the Function Category list box.

7. Double-click the function you want to insert in the FunctionName list box.

8. Enter the appropriate arguments in the Arguments dialog box.

9. Click OK to complete the function and return the function toyour macro.


4 Applix TM1 Client

Accessing Macro Functions from VBA

To access macro functions from VBA, use the Run function asfollows:

Run (“Function”, arg1, ...)

For example:

=N_CONNECT(“Demo”, “USR2”, “Swordfish”)

becomes:

Run (“N_CONNECT”, “Demo”, “USR2”, “Swordfish”) in VBA.

Accessing Macro Functions from Lotus 1-2-3

To access macro functions from Lotus 1-2-3:

1. Type { (open brace) in the cell to contain the macro function.

2. Press F3.

The Macro Keywords dialog box appears.

3. Select the desired function from the Macro Keywords list box.

4. Click OK to return the function to your macro.


Macros 5

Function Descriptions

Each section in this chapter describes a macro function. Thefollowing format is used:

EXCEL_FUNCTION (Arguments){LOTUS_1-2-3_FUNCTION Arguments}

D_FSAVE(SourceFile){D_FSAVE SourceFile}

This function lets you save very large dimensions. TM1 supportsup to 32,000 lines in dimension definitions. However, Excelallows a maximum of 16,384 lines in its worksheets, making itimpossible to use Excel as an editor to define dimensions withmore than 16,384 lines.

In cases where you need to define dimensions with more than16,384 lines, the D_FSAVE function reads a simple comma- (orsemicolon-) delimited text file and generates a .dim dimension file.

The source file must be a simple text file with three fields per line.The fields must be separated with the delimiter defined inInternational under the Windows control panel. The structure ofthe source file is the same as a TM1 .xdi or .ldi file. The first fieldcontains the element type (C, N, S or blank for calculationcomponent), the second field contains the element name and thethird field contains the weight for a calculation component. Thesource file specified as an argument must have the name of thedimension to be created and the extension .dit. The extensionshould not be included in the SourceFile argument.

The following is an example of a typical .xdi or .ldi file and itsequivalent in text form:

{D_FSAVE SourceFile}

6 Applix TM1 Client

N,United States,N,Canada,N,Mexico,C,North America,,United States,,Canada,,Mexico,C,North America less US,,North America,,United States,-1

The macro command

=D_FSAVE(“Region”)

= {D_FSAVE Region}

creates a region .dim file from this region.dit file.

If there are errors in the structure of the text file, such asmisplaced or undefined elements, the .dim is not created. Rather,a tm1erlog.cma file is generated. The first field contains the

D PICK( )

Macros 7

offending record number and the second field contains the text ofthe error message.

D PICK( ) {D_PICK Target}

This function calls a dialog box that shows all availabledimensions in the current data directory or on an active TM1Server.

There are no arguments to the D_PICK function. When you selecta dimension name from the dialog box, this name becomes thevalue of the function.

The above macro displays a dialog box showing the dimensionsavailable in the default data directory or in a cube server. Once adimension name has been selected, the formula in A1 returns thedimension name selected from the dialog box. The macro thenselects the first cell in the active worksheet and writes the value ofthe D_PICK formula (which is the selected dimension name) tothat cell.

When the user selects a dimension name from the dialog box, thatname is stored in the range specified by the Target argument. Theargument can be either a cell address or a range name.

{D_PICK B1}

When the macro encounters the above formula, it displays adialog box showing the dimensions available in the default data

D SAVE( )

8 Applix TM1 Client

directory or on a cube server. After a dimension is selected fromthe dialog box, D_PICK places the dimension name in cell B1 ofthe worksheet.

D SAVE( ) {D_SAVE}

This function saves the active worksheet as an .xdi or .ldi file andthen creates or updates a .dim file with the contents. The .dim filecreated carries the same name as the active worksheet. If there areerrors in the structure of the active worksheet, such as misplacedor undefined elements, the .dim is not created.

In case of errors, a tm1erlog.cma file is generated with two fields.The first field contains the offending record number and thesecond field contains the text of the error message.

E_PICK(Dimension){E_PICK Dimension,Target}

This function calls a dialog box that displays all elements in thedimension specified by the Dimension argument. The dimensionspecified must be in the default data directory or on an activeTM1 Server.

When you select an element name from the dialog box, this namebecomes the value of the function.

I EXPORT(Tab,File,Z,C)

Macros 9

The above macro displays a dialog box showing the elements ofthe Region dimension. When you select an element from thedialog box, the formula in cell A1 returns the element name youselected. The macro then selects the first cell in the activeworksheet and writes the value of the D_PICK formula (which isthe selected element name) to that cell.

When you select an element name from the dialog box, theselected name is stored in the range specified by the Targetargument. The Target argument can be either a cell address or arange name. The Dimension argument must specify a dimensionin the default data directory or on an active TM1 Server.

{E_PICK Region,B1}

When a macro encounters this formula, it displays a dialog boxshowing the elements of the Region dimension. When you select aelement name from the dialog box E_PICK places the elementname in cell B1 of the worksheet.

I EXPORT(Tab,File,Z,C){I_EXPORT Tab,File,Z,C}

This function exports the data in a specified cube to a comma-delimited ASCII file with the file extension .cma. The name of thecube from which the data is to be exported is specified by thestring argument Tab. The cube specified must be in the defaultdata directory or on an active cube server. The file to be written isspecified by the File argument. The comma-delimited ASCII file iswritten to the default data directory.

When specifying the Tab and File arguments, do not use fileextensions. The function automatically assumes a file extension of.tab for the cube name and .cma for the file name.

{I_EXPORT Tab,File,Z,C}


The Boolean argument Z specifies whether or not zeroes shouldbe suppressed. That is, it specifies whether the function writes arecord for each possible intersection in the cube or only for thoseintersections that contain values other than zero.

If this argument is FALSE, the function does not writerecords for zero values. If it is TRUE, all intersectionsare written as records.

If this argument is 0, the function does not writerecords for zero values. If it is 1, all intersections arewritten as records.

The Boolean argument C specifies whether or not valuescalculated by the cube are written as records.

If this argument is FALSE, calculated values are notwritten. If this argument is TRUE, all values, bothcalculated and non-calculated, are written.

If this argument is 0, calculated values are not bewritten. If this argument is 1, all values, bothcalculated and non-calculated, are written.

=I_EXPORT(“92sales”, “Download”,FALSE,TRUE)

{I_EXPORT 92sales,Download,0,1}

In the above example, the macro function takes the values in thecube 92sales and write a comma-delimited ASCII file namedDownload.cma. The function does not write records for cube

I NAMES(File,Column)

Macros 11

intersections that contain zero values, but it does write records forvalues that are calculated by the cube.

I NAMES(File,Column){I_NAMES File,Column}

This function reads through a comma-delimited (.cma) ASCII fileand writes a list of all labels that occur within a specific field inthe ASCII file. The .cma file to be read is specified by the Fileargument. When specifying a .cma file, do not include anextension. The I_NAMES function reads only files with the .cmaextension.

The numeric argument Column specifies both the number of thefield that is read and the number of the column of the worksheetto which the list of unique names is written. If you specify a 2 forthis argument, the function reads the unique names in the secondfield of the .cma file and places them in column B (the secondcolumn) of the active worksheet.

=I_NAMES(“93sales”,3)

{I_NAMES 93sales,3}

In the above example, the function reads through the comma-delimited ASCII file 93sales.cma, records all the unique names inthe third field of that file, and writes those names in column C(the third column) of the active worksheet.

I PROCESS(File)


I PROCESS(File){I_PROCESS File}

This function converts information from standard ASCII fileformat into TM1 Client format. The function sequentially readsthe records of a comma-delimited ASCII file into the first row ofthe active worksheet and recalculates the worksheet after eachrecord is read. Each field of a record is read into a separate cell.Typically, you write DBSn formulas in the worksheet into whichthe records are being read. This DBSn formula reads the valuesin the record and sends them to the appropriate intersection in thedatabase as defined by the labels in the various fields of therecord.

While reading the records into the active sheet, TM1 Clientdisplays the following dialog box.

Pressing the Escape key during processing returns control to themacro at the cell following the location from which I_PROCESSwas invoked.

The .cma file to be read is specified by the File argument. Whenspecifying a .cma file, do not include an extension. TheI_PROCESS function reads only files with the .cma extension.

=I_PROCESS(“95sales”)

{I_PROCESS 95sales}

N_CONNECT(Server,Client,Password)

Macros 13

In this example, the function reads each record of the comma-delimited ASCII file 95sales.cma into the first row of the activespreadsheet and recalculates the active worksheet after readingeach record.

N_CONNECT(Server,Client,Password){N_CONNECT Server,Client,Password,Target}

This function connects you to a network cube server. Theargument Server specifies the name of the cube server to whichyou will connect. The argument Client specifies the client nameunder which you will be connected. The string argumentPassword specifies the password for the specified client.

This function returns the value of any error messages returned byTM1 Client. If log-on is successful, the function does not return avalue.

=N_CONNECT(“Demo”,”USR2”,”Swordfish”)

{N_CONNECT Demo,USR2,Swordfish,B1}

In the example, TM1 Client searches for and attempts to log on tothe Server named Demo as the client USR2. The formula willsupply the password Swordfish when the Server requests apassword.

If the log-on attempt fails:

The function returns the value of any error message.

The error message is sent to cell B1.

N_DISCONNECT( )


N_DISCONNECT( ){N_DISCONNECT}

This function disconnects you from all cube servers to which youare currently connected. There are no arguments to this function.

When you disconnect from servers with N_DISCONNECT, youare not prompted to confirm the action, as you are whendisconnecting with the TM1 → Network → Disconnect option.

OPTGET(Option){OPTGET Option,Target}

This function returns the current value of an option in the TM1Client options setting. The argument Option is one of the optionnames used in the TM1.INI file.

For example, if the database directory is set to C:\TM1DATA, thefollowing function returns “C:\TM1DATA”. In Excel, the functionreturns the value of the specified option. In 1-2-3, the functionstores the value of the option in the location specified by theTarget argument.

= OPTGET(“DataBaseDirectory”)

{OPTGET “DataBaseDirectory”,B1}

The following are valid arguments to the OPTGET function.

AdminDirectory Returns the current directory containing theTM1.ADM file.

AdvancedMode Returns T if Advanced Mode is activated;otherwise, returns F.

OPTSET(Option,Value)

Macros 15

AnsiFiles Returns T if options are set to use the ANSIcharacter set for processing text files;otherwise, returns F.

DataBaseDirectory Returns the current database directory.

GenDBRW Returns F if the cube slice returns DBRformulas; returns T if the cube slide returnsDBRW formulas in the spreadsheet.

NBReset Returns T if the NetBIOS reset parameter isturned on; returns F if the parameter isturned off.

NoChangeMessage Returns T if options are set so that TM1Client displays the message NO CHANGEwhen a DB Send formula points to a C levelcell. Returns F if this message isdeactivated.

PollingOn Returns F if network polling is turned off;otherwise, returns T. (Refer to the ApplixTM1 Server manual for more information.)

ViewMaxMemory Returns the number of Kbytes set forstoring TM1 views. Note that numericvalues are returned as strings.

OPTSET(Option,Value){OPTSET Option,Value}

This function sets the TM1 Client option specified by the Optionargument to the value specified by the Value argument. Botharguments must be strings or references to cells containingstrings.

{OPTSET Option,Value}


Following is the list of valid Option arguments for the OPTSETfunction. Note that many of these parameters cannot be set in thenormal TM1 Options dialog box.

AdminDirectory Sets the directory containing the TM1.ADMfile. The accompanying Value argumentmust be a complete path to the directorycontaining TM1.ADM.

AdvancedMode When the Value argument is T, activatesTM1 Client’s advanced mode. TM1 Clientthen always shows the advanced functionsin the dimension dialog box. When theValue argument is F, TM1 Client displaysthe simplified version of the dimensiondialog box.

AnsiFiles Determines whether or not TM1 uses theANSI character set when importing files. Ifthe Value argument is T, TM1 uses theANSI character set. When Value is set to F,TM1 uses the ASCII character set.

DataBaseDirectory Sets the database directory to the directoryspecified by the Value argument.

GenDBRW Switches from DBR to DBRW formulaswhen you create a cube slice. Set Valueargument to F to return DBR formulas; setto T to return DBRW formulas in thespreadsheet.

NoChangeMessage Lets you specify whether TM1 Clientdisplays the message NO CHANGE when aDB Send formula points to a C level cell.When the Value argument is T, TM1 Clientdisplays NO CHANGE when DB Sendformulas point to consolidated values.

QUDEFINE(Cube,Query,Range,Low,Hi,SkpZeroes,SkpCalcs)

Macros 17

When the Value argument is F, TM1 Clientdisplays the value sent by the DB Sendformula.

NBReset Turns NetBIOS reset on and off. Set theValue argument to F to turn NBReset off;set to T to turn it back on.

PollingOn Turns the network polling on and off. Whenthe Value argument is set to T, networkpolling is turned on. When Value is set to F,network polling is turned off. (Refer to theApplix TM1 Server manual for moreinformation on this option.)

ViewMaxMemory Sets the number of Kbytes set for storingTM1 views.

ViewMinTime Sets the limit of time in seconds to triggerthe algorithm that stores TM1 views inmemory.

QUDEFINE(Cube,Query,Range,Low,Hi,SkpZeroes,SkpCalcs){QUDEFINE Cube,Query,Range,Low,Hi,SkpZeroes,SkpCalcs}

This function specifies all the parameters for a TM1 Client queryset. It is the equivalent of opening the Query dialog box,specifying parameters and saving the query for future use. Onceyou create and save a query with this function, the query isavailable from the Query button in the Query dialog box. Thequery can also be executed by one of the three functions(QUEXPORT, QULOOP, and QUSUBSET) described below.

The following list describes the arguments to QUDEFINE.

Cube The name of the cube to be queried.

{QUDEFINECube,Query,Range,Low,Hi,SkpZeroes,SkpCalcs}


Query The name of the query set to be saved forfuture use.

{QUDEFINECube,Query,Range,Low,Hi,SkpZeroes,SkpCalcs}

Macros 19

Range The name of a range of cells used to specifythe elements to be selected from eachdimension. This range must contain as manycolumns as there are dimensions in the cube.Each column corresponds to a dimension inthe cube. The order of the columns must bethe same as the order of the dimensions in thecube. In each column, the elements to beincluded in the query are listed. You canspecify a named subset by writing the nameof the subset preceded by the character “\”.Leaving a column blank indicates that thecurrently selected subset for that dimension isto be used. If a column of the range is empty,the function queries the ALL subset of thecorresponding dimension.

The following is an example of a QUDEFINE range for the 5-dimensional cube 93sales provided with the examples installedwith TM1 Client.

In this example, the actual range is comprised of those cells withinthe heavy border. The column titles are not necessary and areincluded for purposes of clarity. A QUDEFINE function using thisrange would specify Actual as the query elements for theActvsbud dimension; Germany, France, or Spain, as the queryelements for the Region dimension; Units as the query elementsfor the Account1 dimension; and Jan, Feb, and Mar as the query

QUEXPORT(Cube,Query,File)


elements for the Month dimension. Since no elements arespecified under the Model column, the subset ALL is used.

Hi and Low The Selection Range for the query set isspecified using the Hi and Low arguments.When executing the query, TM1 Clientconsiders only cells containing values lessthan or equal to the value specified by the Hiargument and greater than or equal to thevalue specified with the Low argument.

SkpCalcs Sets the Skip Calculated Values option. Setthis argument to TRUE to ignore calculatedvalues in the query. Set this argument toFALSE to consider all values in the query.

SkpZeroes Sets the Skip Zero/Blank Values option. Setthis argument to TRUE to ignore zero orblank values in the query. Set this argumentto FALSE to consider all values in the query.

The QUDEFINE function returns TRUE if the query is successful,FALSE if TM1 is unable to execute the query.

QUEXPORT(Cube,Query,File){QUEXPORT Cube,Query,File}

This function exports an ASCII representation of the query setspecified by the Query argument (see QUDEFINE above) from thecube specified by the Cube argument. The name of the file createdupon export is specified with the File argument. The Fileargument must not include a file extension.

The cube specified must be in the default data directory or on acube server. The comma-delimited ASCII file is written to thedirectory to which Excel is currently looking.

QULOOP(Cube,Query)

Macros 21

The form of the exported ASCII file is completely normalized,with the cube name in the first field, the elements specifying aspecific cell address in the next fields, and the value contained inthe cell in the last field.

QULOOP(Cube,Query){QULOOP Cube,Query}

This function is the equivalent of the TM1 → Import/Export →Process → Cube option. QULOOP creates a record for each cell inthe cube specified by the Cube argument that meets the parametersof the query set specified by the Query argument (see QUDEFINEabove). The function then reads the record into line 1 of the activeworksheet and recalculates the worksheet.

The cube specified must be in the default data directory or on acube server.

The form of the record written is completely normalized, with thecube name in the first field, the elements specifying a specific celladdress in the next fields, and the value contained in the cell in thelast field. Thus, a 5-dimensional cube would create a record with 7fields: the first containing the cube name, the second through sixthcontaining the cell address, and the seventh containing the value inthe cell.

QUSUBSET(Cube,Query,Dimension,Subset){QUSUBSET Cube,Query,Dimension,Subset}

This function is the equivalent of executing a previously definedquery from the Dimension dialog box and saving the result of thequery as a subset.

The following list describes the arguments to QUSUBSET.

Cube The name of the cube containing the dimensionyou want to query.

R_SAVE( )


Query The name of the query you want to execute.

Dimension The name of the dimension against which youwant to execute the query.

Subset The name to assign to the subset defined by thequery result.

R_SAVE( ){R_SAVE}

This function saves the active worksheet as a Rules worksheet andcompiles it into a .rux file. The worksheet must have the samename as the cube for which the rule is being compiled. If thefunction is not successful, no .rux file is created and the tm1erlogfile indicates the line that prevented the rule from being compiled.

SUBDEFINE(Dimension,Subset,Range){SUBDEFINE Dimension,Subset,Range}

This function creates a dimension subset with the name specifiedby the Subset argument for the dimension specified by theDimension argument. The subset contains the elements in thecells specified by the Range argument.

SUBPICK(Dimension, Subset, Vertical){SUBPICK Dimension, Subset, Vertical}

This function calls a dialog box that shows all elements in aspecified dimension subset. The Dimension argument specifiesthe dimension containing the desired subset. The Subsetargument is the name of the desired subset. When you select oneor more element names from the dialog box, the selected names

T_CLEAR( )

Macros 23

are returned to the current worksheet starting at the currentcursor position.

The Vertical argument determines the orientation of the elementnames in the worksheet. In Excel, specify True to orient elementnames vertically from the current cursor position. In Lotus 1-2-3,specify 1 to orient names vertically. If you do not supply a Verticalargument, element names are oriented horizontally from thecurrent cursor position.

T_CLEAR( ){T_CLEAR}

This function clears all cubes that are currently in RAM from thecomputer’s memory. There are no arguments to this function. Itis important to note that if this function is used in a macro, TM1does not prompt you to save any unsaved cubes. It is important toensure that the macro saves all relevant cubes with the T_SAVEfunction before invoking T_CLEAR.

T_CREATE(Cube,D1,D2[,D3,...,D8]){T CREATE Cube,D1,D2[,D3,...,D8]}

This function creates a cube of up to eight dimensions.T_CREATE provides the same functionality as T_CREATE16, butprovides compatibility with older versions of TM1, where cubescould not exceed eight dimensions.

The name of the cube to be created is specified by the Cubeargument. The names of the dimensions that define the cube arespecified in string arguments D1 through D8. A minimum of twodimensions must be specified.

T_CREATE16(Cube,D1,D2[,D3,...,D16])


The cube created is placed in the default data directory. Thedimensions specified must also be in the default data directory oron a TM1 server.

NOTE: Exercise caution when executing this function within amacro. If a cube already exists with the cube name specified, thatcube is overwritten and all data in the cube is lost.

=T_CREATE(“Example”,”Region”,”Products”)

{T_CREATE Example,Region,Products,Month}

In the example, TM1 creates a cube named Example. This newcube is made up of the dimensions Region, Products, and Month,in that order.

T_CREATE16(Cube,D1,D2[,D3,...,D16]){T CREATE16 Cube,D1,D2[,D3,...,D16]}

This function creates a cube with up to 16 dimensions. The nameof the cube to be created is specified by the Cube argument. Thenames of the dimensions that define the cube are specified inarguments D1 through D16. A minimum of two dimensions mustbe specified.

The cube created is placed in the default data directory. Thedimensions specified must also be in the default data directory orin a server.

NOTE: Exercise caution when executing this function within amacro. If a cube already exists with the cube name specified, thatcube is overwritten and all data in the cube is lost.

{T CREATE16 Cube,D1,D2[,D3,...,D16]}

Macros 25

=T_CREATE16(“Example”,”Region”,”Products”,”Month”)

{T_CREATE16 Example,Region,Products,Month}

In the above example, TM1 creates cube named Example. Thisnew cube is made up of the dimensions Region, Products, andMonth, in that order.

T_PICK( )


T_PICK( ){T_PICK Target}

This function calls a dialog box that shows all available cubes inthe default data directory or on a cube server. When you select acube name from the dialog box, T_PICK returns the cube name..

There are no arguments to this function.

This macro displays a dialog box showing the cubes available inthe default data directory or on a cube server. When you select acube name, the name becomes the value of the formula in cell A1.The macro then selects the first cell in the active worksheet andwrites the value of the T_PICK formula (which is the selectedcube name) in that cell.

When you select a cube name from the dialog box, the selectedname is stored in the location specified by the Target argument.The argument can be either a cell address or a range name.

{T_PICK B1}

T_SAVE( )

Macros 27

T_SAVE( ){T_SAVE}

This function saves to disk all cubes currently in RAM. There areno arguments to this function. Note that if this function is invokedin a macro, TM1 does not prompt you for confirmation.

VUSLICE(Cube,View){VUSLICE Cube,View}

This function creates a spreadsheet slice from a saved view for agiven cube. The Cube argument is the name of the cube fromwhich the view is sliced. The View argument is the name of thesaved view you ant to slice from the cube.

The slice generated begins at the current cursor position, andtakes the format of a standard slice created from browse.

W_CALC( ){W_CALC}

This function forces a recalculation of the active worksheet, and isthe equivalent of pressing SHIFT F9.

There are no arguments to this function.

W_DBSENABLE(Logical )


W_DBSENABLE(Logical ){W_DBSENABLE Logical }

This function determines the manner in which the activeworksheet executes DBS functions. W_DBSENABLE accepts asingle argument, Logical. In Excel, the values for Logical areTRUE or FALSE. In 1-2-3, the values for Logical are 1 or 0.

Specify TRUE or 1 to execute each DBS function individually as itis encountered in a worksheet.

Specify FALSE or 0 to store the value of all DBS functions in abuffer, and execute the DBS functions in a single block when theworksheet is recalculated.

=W_DBSENABLE(TRUE)

{W_DBSENABLE 1}

1

Error Messages

General Errors

C2 Menu not available while browsing .

You have selected a TM1 help menu optionthat is not available during browsing. Youmust close the Browse dialog box to select thisoption.

C6 Could not start timer .

The Windows timer is currently not available.

C5 Invalid Number .

You have entered a string of characters thatdoes not correspond to a number.

C7 TM1S.LOG exists. See Backup andRecovery .

The TM1 Server was not brought downcorrectly and there are changes to cubes thatare not saved. You should check theTM1S.LOG to determine if a RestoreProcedure will be required before bringingthe TM1 Server back up. See Chapter 5,“Backup and Recovery.”

General Errors

2 Applix TM1 Client

C8 Error in Formula .

You have written a worksheet formula thatcontains syntax errors. Examine the formulaand correct the syntax errors.

C9 Errors Occurred, Please ExamineTM1ERLOG.CMA .

While processing a file, TM1 helpencountered records it could not correctlyprocess. The records that were not processedare written onto TM1ERLOG.CMA.

C11 Formula is too long .

You have written a rule or worksheet formulathat is longer than 256 characters andtherefore cannot be stored in a worksheet cell.Rule formulas may be split and stored in twoconsecutive cells.

C12 Memory too low to hold Cube .

The memory requirements of the cubes anddimensions you have loaded exceed theavailable memory. You may increase theamount of virtual memory available toWindows using the Control Panel / 386enhanced facility.

C13 Memory is Low .

General Errors

Error Messages 3

System memory is low. You should shutdown any extra programs and save yourwork. If the problem persists, you shouldincrease the memory for the system.

C14 No Item was Selected .

You attempted to save a subset, query orview without selecting a name. Select or typethe name and retry saving.

C15 Only One El ement May Be Selected .

When selecting elements to be used as titles ina browse view, you may only select only one.

C16 Path is too long .

You have specified a path that is longer than256 characters.

C17 Query Resulted in Empty Subset .

You have executed a query for a dimensionsubset that resulted in no elements.

C18 Can’t Update Changes .

Browse order has been changed, cannotupdate cube changes.

C19 Invalid License for this Rel ease.

Your TM1.LIC file is a license for an olderversion of the software.

C20 Feature is not Available in this Version .

General Errors

4 Applix TM1 Client

This version of the software does not supportthe feature invoked.

*NET_ERR A transmission error was detected.

Error Messages 5

*KEY_LONG The Combined key (length of cube name pluslength of names of each element) exceeds themaximum message length of 540 bytes.

*KEY_ERR An incorrect cube name or dimension elementname has been used to store or retrieve avalue from the cube.

*N/A You have referred to a value on a cube serverto which you have no READ or WRITEprivileges.

Dimension Error Messages

6 Applix TM1 Client


D2 String length not nu meric .

When an S or string dimension is defined, astring length must be defined in the thirdcolumn of the dimension worksheet. Thisstring length must be an integer number. Thiserror message appears if the third column cellto the right of a string element is left blank orcontains a non-integer number.

D3 Calculation component out of place .

TM1 help has detected an ename in column 2that has no element type defined (N, C, or S)to the left of it in column 1 and is notpreceded by a C type element or anothercalculation component.

Either move this element name beneath a Ctype element or another calculationcomponent or place an X to the left of it incolumn 1. Placing an X in column 1 causesTM1 help to ignore this element.

D4 Circular reference in: XXXX .

A calculated element forms part of its owndefinition, directly or indirectly. For example,if X1 is defined as the sum of X2 and X3, andX3 is defined as the sum of X1 and X4, thismessage will result.


Error Messages 7

D5 Duplicate El ement: XXXX .

Two elements with the same name have beendefined in the dimension. One of them mustbe removed or have its name changed.

D6 Element name is blank .

A C, N, or S has been placed in a cell incolumn 1 with no corresponding elementname to the left of it in column 2.

D7 Element not defined: XXXX .

An element has been included as acomponent of a calculated element but hasnot been defined as an N element elsewhere inthe dimension worksheet.

D8 Invalid El ement type .

A letter other than C, N, S, or X has beenplaced in a cell in column 1.

D9 Maximum number of Elements exceeded .

The number of elements in the dimensionexceeds the limits established for yourversion.

D10 No Elements in Dimension .

An attempt has been made to save adimension worksheet that contains noelements. At least one dimension elementmust be defined to eliminate this message.


8 Applix TM1 Client

D12 Invalid DD4 File .

Index file for the dimension does not have theexpected format. Re-save the dimension torecreate the index file.

D13 Invalid DIM File .

Index file for the dimension does not have theexpected format. Re-save the dimension torecreate the index file.

D15 Element has more than 72 Characters –truncating .

You have specified an element with morethan 72 characters. The name will betruncated down to 72 characters.

D16 Dimension al ready exists .

You have attempted to create a newdimension where one already exists by thesame name.

D17 Dimension does not occur in qu ery cube .

Dimension DIM file could not be found.

D18 Unrecognized stat ement .

When compiling a dimension, validstatements are N, C, X, S, or !.

D19 Type of Element may not be changed .

Cannot change type of element when


Error Messages 9

reloading dimension on active TM1 Server.

D20 Calculation Component Defined as SimpleElement .

Error occurs when ! syntax is used to defineconsolidations, and consolidation andcomponent are mismatched

D22 String Status of Dimension cannot bechanged .

You cannot add string fields to dimensionthat does not already have any whenreloading dimension to an active TM1 Server.

Network Error Messages


Network Error MessagesN1 Network Busy .

One of the servers that you are using is busy.It may be calculating a large consolidation.Wait a few minutes and then press Yes to tryagain. If problem persists, a network errormay be the cause.

N3 Already C onnected to Server XXXX .

You have attempted to connect to a server towhich you are already connected.

N4 TM1 Server Not Active .

An attempt has been made to log into a non-active server. Check the server name usedduring log-in.

N5 Request Was Not Successful .

You have issued a RESERVE, UNRESERVE,or LOCK request for an item that someoneelse has already placed a LOCK orRESERVEon, or one for which you have noLock or Reserve privileges. Have the workgroup administrator check your privileges forthe elements and cubes for which the requestwas issued.


Error Messages 11

N6 Client Not Registered .

You have attempted to log on with a username that is not listed in the }CLI_LSTdimension on the server. Check the username with which you logged on to insure thatit matches the }CLI_LST dimension.

N7 Write Access Denied .

You have attempted to either update anumber that is calculated by the cube or, inthe case of network cubes, have attempted toupdate a number for which you do not haveWRITE privileges.

N8 Invalid S erver Name XXXX .

Server name contained illegal characters orserver name was greater than eightcharacters.

N10 Invalid P assword .

You have attempted to log on with an invalidpassword. Check the password and tryagain.

N11 Maximum Number of Clients Reached .

More clients than allowed by the server’slicense have attempted to log on.

N12 Incorrect TM1 Server License .

TM1.LIC is either out of date of for the wrongsoftware version.



N19 NETBIOS Subsystem Not Active .

The NetBIOS protocol must be loaded onyour computer.

N20 Not Connected to Server XXXX .

Client is not currently connected to the TM1Server.

N21 Connection Failed .

Connection to TM1 Server failed. Check thatthe TM1 Server is still active and the networkconnection is still working.

N28 Client Already Logged In. Do You Want ToForce Client Off?

You have attempted to log-in as a clientalready active on the server. By respondingYes to this question, the connection of theother client will be severed and yourconnection will be established.

N29 Maximum Number of DimensionsExceeded .

The license you have does not support thenumber of dimensions you have specified.

N33 Can’t Update Administrator File .

Server cannot add its name to TM1.ADM file.


Error Messages 13

N34 Network Subsystem Failed .

Cannot open Network Subsystem, checknetwork installation.

N36 Server Out of Memory. Can’t Cont inue .

The Server is out of memory. Increase theamount of RAM and Virtual memory. Youshould check the TM1S.LOG to determine if arestore procedure will be required beforebringing the TM1 Server back up. See Chapter5, “Backup and Recovery.”

N37 Parameter Error. See Log for MoreInformation .

Parameter error on the TM1 Server. Checkthe log window on the TM1 Server todetermine the problem.

N38 Server Name Not Provided in ParameterList .

With an IPX or NetBIOS TM1 Server, theserver name is required in the parameter list.

N39 Can’t Load XXXX or Windows So ckets notInstalled .

Cannot load WINSOCK.DLL orWINSOCK32.DLL.

N40 Can’t Load Sockets Function .

Windows Sockets error, cannot find thefunction address.



N41 Windows So ckets Subsystem Not Readyfor Communication .

Check Sockets Subsystem.

N42 Invalid V ersion of Windows So ckets .

Version 1.1 or higher supported.

N43 Can’t Find Remote XXXX .

TM1 Server cannot find remote machine.

N44 Can’t Open Socket .

Cannot open socket. Check Windows Socketsinstallation.

N45 Connection to S erver XXXX Failed .

Unable to connect to TM1 Server. Possiblenetwork error.

N46 Connection S evered Se nding .

Communication with TM1 Server interruptedduring send.

N47 Connection S evered Receiving .

Communication with TM1 Server interruptedduring receive.

N48 Remote Computer Disc onnected.Connection Closed .

Remote computer was disconnected, or TM1application was closed.


Error Messages 15

N49 Listen Failed .

TM1 Server listen failed, check installation.

N50 Maximum Number of Tasks Exceeded .

Maximum number of tasks exceeded by APIapplication

N51 NETBIOS Error: Code XXXX .

NetBIOS internal error.

N52 Server XXXX Not Active or C onnectionFailed .

Check TM1 Server and the networkconnection.

N53 Request Not completed. ConnectionClosed .

Program timed out before request wascompleted.

N54 Version of S erver not compat ible with thisClient .

Client and TM1 Server are of different datesor versions.

N55 Reloading Failed .

Dimension or cube failed to reload. Checkfiles.


N56 Not Connected to any Server .

Client is not currently connected to a TM1Server.

N57 Can’t Open More Connections .

Client is connected to the Maximum numberof TM1 Servers.

N58 Invalid p arameter XXXX .

Check parameter list on TM1 Server forerrors.

N59 Can’t Load XXXX Or Tli Not Installed .

You have attempted to log on with an invalidpassword. Check the password and tryagain.

N62 Bind failed .

Please check your network connections.

Rules Error Messages

Error Messages 17

Rules Error Messages

R1 XXXX Not a Dimension of this CUBE.

You have written an expression of the form!dimname or dimname:elname, wheredimname is not a dimension of the cube forwhich the rules are being defined.

R2 Element Name XXXX Am biguous .

You have referred to an element which occursin more than one dimension. You mustprecede the element name with the name ofthe dimension as follows: dimname:elname.

R3 Element Name XXXX Not Found .

You have referred to an element that does notoccur in the cube.

R4 Error evaluating rule: possible circularreference .

You have either written a set of rules with acircular reference, or you have exceeded thestack capacity of the rules processor. Pleaserefer to Chapter 12, “Technical Overview/Performance Optimization,” of the TM1Perspectives User’s Manual.

R5 Formula Error On or Near This Line .

The rules compiler has identified a syntaxerror in the statement that appears on thisline.


R6 Maximum size of Rule reached .

The size of a compiled rules file is limited toabout 64k. You may need to simplify orcombine rules if you get this message.

R8 Error Evaluating Rule .

Contact your reseller or Applix, Inc. forsupport.

R9 Error Evaluating Rule: Invalid Key .

Invalid name given in DB formula.

System Error Messages

Error Messages 19

System Error Messages

S3 File XXXX not found .

You have specified a file that does not exist.

S5 Out of Memory .

Increase the amount of RAM and virtualmemory.

S6 Printer not ready .

Check that the printer is ready to print.

S7 File XXXX is Read-Only .

Check network security rights for this file orits directory.

S10 Record size too big .

ASCII file records are limited to 2048 bytes inTM1 help.

S15 Directory XXXX not f ound .

You have specified a directory that does notexist.

Cube Error Messages


Cube Error Messages

T1 Write Access Denied .

You have attempted to update a number thatis calculated by the cube or, in the case ofnetwork cubes, attempted to update anumber for which you do not have WRITEprivileges.

T8 Not enough Dimensions specified .

An attempt has been made to create a cubewith less than two dimensions. At least twodimensions must be specified when creating acube.

T11 Bad CUBE XXXX .

A cube (.tab) file has been read that does notconform to TM1 help format. The file maynot be used.

T12 Dimension other than last one containstrings .

An attempt has been made to create a cube inwhich a dimension other than the lastdimension has string elements. TM1 helpallows string elements only in the lastdimension of a cube.

Cube Error Messages

Error Messages 21

T14 Mismatch in number of Dimens ions forCUBE: XXXX .

The user has attempted to refer to a cube witha DB formula in which the number ofdimensions defined in a formula is not thesame as the number of dimensions containedin the cube. For example, if 92act4d.tabcontains four dimensions and you write aDBS5 formula referring to 92act4d.tab, thismessage will be returned.

T17 Element XXXX not in Dimens ion XXXX .

This element is not listed in the dimension.

T18 Saving Cubes Not Supported ByEvaluation V ersion .

The evaluation version does not support thesaving of changes to local cubes.

1

IndexAAccess Privileges

Definitions 1-10Automatic

Consolidation 1-5Recalculation

Turning Off in Excel 2-2Turning Off in Lotus 2-3

BBrowse Dialog Box 2-7

CCALC Flag 2-13Changing

Elements Displayed 2-8, 2-15Perspectives 2-10The Cube Displayed 2-17

Checking Options 4-14Clearing Cubes from Memory 4-22Client 1-9Client/Server Architecture 1-8Connecting

to Multiple Servers 2-27Connecting to a Cube Server 4-13Consolidated Values

Displaying 2-9Creating

a Slice Worksheet 2-14Cubes 4-22Slice Worksheets 4-25Subsets 4-21

from Queries 4-20Cube Data

Viewing 2-6Cube Displayed

Changing 2-17Cube Reference 2-18

Writing 2-20Cube(s)

Defined 1-2Cubes

Clearing from Memory 4-22Creating 4-22Saving 4-25Selecting 4-24

DD_FSAVE 4-5D_PICK 4-7D_SAVE 4-8Data Identification By Name 1-3Database Values

Reserving and Locking 2-23DBRn 3-4DBRWn 3-5, 3-9DBRXn 3-6DBSn 3-7Default View 2-7Defining Queries 4-17DFRST 3-10dimension

error messages A-5Dimension(s)

Multiple, General Information 1-4

2 Applix TM1 Client

DIMIX 3-11DIMNM 3-11DIMSIZ 3-12Disconnecting

from SERVERs 2-27Disconnecting from Cube Servers 4-14Displaying Consolidated Values 2-9DNEXT 3-13DNLEV 3-13DTYPE 3-14

EE_PICK 4-8ELCOMP 3-15, 3-16Elements Displayed

Changing 2-8, 2-15ELISCOMP 3-17ELISPAR 3-18ELLEV 3-19ELPAR 3-20ELPARN 3-21ELSLEN 3-21ELWEIGHT 3-22Entering Data 2-11error messages

cube A-19dimension A-5general A-1, A-19network A-9rules A-16system A-18

ExcelLoading 2-1

Exportingbased on Queries 4-19Cube Data 4-9

FFunctions

MacroD_FSAVE 4-5D_PICK 4-7D_SAVE 4-8E_PICK 19 4-8I_EXPORT 4-9I_NAMES 4-11I_PROCESS 4-11N_CONNECT 4-13N_DISCONNECT 4-14OPTGET 4-14OPTSET 4-15QUDEFINE 4-17QUEXPORT 4-19QULOOP 4-20QUSUBSET 4-20R_SAVE 4-21SUBDEFINE 4-21SUBPICK 4-21T_CLEAR 4-22T_CREATE 4-22T_CREATE16 4-23T_PICK 4-24T_SAVE 4-25VUSLICE 4-25

WorksheetDBGEN 3-2DBGEN16 3-3DBRn 3-4DBRWn 3-5, 3-9DBRXn 3-6DBSn 3-7DBSSn 3-8DFRST 3-10

Index 3

DIMIX 3-11DIMNM 3-11DIMSIZ 3-12DNEXT 3-13DNLEV 3-13DTYPE 3-14ELCOMP 3-15ELCOMPN 3-16ELISCOMP 3-17ELISPAR 3-18ELLEV 3-19ELPAR 3-20ELPARN 3-21ELSLEN 3-21ELWEIGHT 3-22SUBNM 3-23SUBSIZ 3-24TABDIM 3-24VIEW 3-25

II_EXPORT 4-9I_NAMES 4-11I_PROCESS 4-11

LLoading

Excel 2-1Lotus 1-2-3 2-3

Locking and Reserving DatabaseValues 2-23

Logging OnTM1 CLIENT 2-4

Lotus 1-2-3Loading 2-3

MMacro Functions

D_FSAVE 4-5D_PICK 4-7D_SAVE 4-8E_PICK 4-8I_EXPORT 4-9I_NAMES 4-11I_PROCESS 4-11N_CONNECT 4-13N_DISCONNECT 4-14OPTGET 4-14OPTSET 4-15QUDEFINE 4-17QUEXPORT 4-19QULOOP 4-20QUSUBSET 4-20R_SAVE 4-21SUBDEFINE 4-21SUBPICK 4-21T_CLEAR 4-22T_CREATE 4-22T_CREATE16 4-23T_PICK 4-24T_SAVE 4-25VUSLICE 4-25

Multiple ServersConnecting To 2-27

NN_CONNECT 4-13N_DISCONNECT 4-14Network Options

Setting 2-26

4 Applix TM1 Client

OOpening

Dimension Dialog Box 4-7OPTGET 4-14OPTSET 4-15

PPassword(s)

Changing 2-5Perspectives

Changing 2-10Privileges

Definitions 1-10Processing

from Cubes 4-20Text Files 4-11

QQUDEFINE 4-17Queries

Defining 4-17QUEXPORT 4-19QULOOP 4-20QUSUBSET 4-20

RReserving and Locking Database

Values 2-23Restoring Transaction Log 3-2, 3-3Restoring Transaction Log17- 3-3Retrieving

Component Elements 3-17Components of Elements 3-15Cube Dimensions 3-24Element Names 3-11First Element of a Dimension 3-10

Highest Level of Elements 3-13Index Number of a Dimension

Element 3-11Length of Element Names 3-21Level of Elements 3-19Next Element 3-13Number of Components 3-16Number of Elements 3-12Number of Elements in a Subset

3-24Number of Parent Elements 3-21Parent Elements 3-18Parents of Elements 3-20Subset Element Names 3-23Type of Elements 3-14Unique Names 4-11Weight of Elements 3-22

Rules Error Messages A-16

SSaving

Cube Rules 4-21Cubes 4-25Dimensions 4-8Large Dimensions 4-5the Slice Worksheet 2-18

SecurityPrivileges

Definitions 1-10Selecting

Cubes 4-24Dimension Elements 4-8Elements from Subsets 4-21

SendingNumeric Values to a Cube 3-7String Values to a Cube 3-8

Setting

Index 5

Network Options 2-26Options 4-15the Reference Style In Excel 2-2

Slice WorksheetCreating 2-14Saving 2-18

Slice(s)Definition 1-6

Spreadsheet ConnectorConnecting 4-13Disconnecting from 4-14

SUBDEFINE 4-21SUBNM 3-23SUBPICK 4-21SUBSIZ 3-24system error messages A-18

TT_CLEAR 4-22T_CREATE 4-22T_CREATE16 4-23T_PICK 4-24T_SAVE 4-25TABDIM 3-24TM1 Client

Administration 1-9General Information 1-1Logging On 2-4

TM1 Server 1-1, 1-8TM1 SERVERs

Disconnecting from 2-27Transaction Log 1-11Turning Off Automatic Recalculation

In Excel 2-2In Lotus 2-3

VViewing Cube Data 2-6VUSLICE 4-25

WWorksheet Functions

DBGEN 3-2DBGEN16 3-3DBRn 3-4DBRWn 3-5, 3-9DBRXn 3-6DBSn 3-7DBSSn 3-8DFRST 3-10DIMIX 3-11DIMNM 3-11DIMSIZ 3-12DNEXT 3-13DNLEV 3-13DTYPE 3-14ELCOMP 3-15ELCOMPN 3-16ELISCOMP 3-17ELISPAR 3-18ELLEV 3-19ELPAR 3-20ELPARN 3-21ELSLEN 3-21ELWEIGHT 3-22SUBNM 3-23SUBSIZ 3-24TABDIM 3-24VIEW 3-25

Worksheet SliceDefinition 1-6

Worksheets

6 Applix TM1 Client

Creating from Cubes 4-25Writing a Cube Reference 2-20

Index 7

applix tm1 client 2.6.pdf

Documents