02.Cognos TM1 Developer Guide 10.1.0

8/10/2019 02.Cognos TM1 Developer Guide 10.1.0

http://slidepdf.com/reader/full/02cognos-tm1-developer-guide-1010 1/397

Cognos TM1 Developer Guide 10.1.0

Contents

1. Introduction

2. Introduction to TM1 Development

2.1. Understanding Multidimensionality

2.1.1. Durables Cube

2.2. Your Role as Developer

2.3. Understanding b!ect "aming Conventions2.3.1. Reserved C#aracters

2.3.2. Rule $tatements

2.3.3. b!ect "aming %&ceptions

3. Creating Cubes and Dimensions

3.1. Designing Cubes

3.1.1. $electing t#e "umber o' Dimensions

3.1.1.1. (ive)dimensional Cube

3.1.1.2. (our)dimensional Cube

3.1.2. Consolidating Detail Using Dimension *ierarc#ies

3.1.2.1. "avigating t#roug# a Dimension *ierarc#y

3.1.2.2. Using +eig#ts to %&press Consolidations

3.1.2.3. Creating Multiple Roll)ups in a Dimension

3.1.2.3.1. ,eograp#ic Roll)up

3.1.2.3.2. Management Roll)up3.1.2.-. Creating Comple& Calculations

3.1.3. Types o' %lements

3.1.-. %lement ttributes

3.1.-.1. Descriptive ttributes

3.1.-.2. lias ttributes

3.1.-.3. Display (ormat ttributes

3.1.-.-. $etting Display (ormats 'or Ro/s or Columns

3.1.-.0. ttributes versus %lements

3.1.0. Designing Cubes ) $ummary

3.2. Creating Dimensions

3.2.1. Creating Dimensions Using t#e Dimension %ditor +indo/

3.2.2. Modi'ying a Dimension

3.2.2.1. dding $iblings to %&isting %lements

3.2.2.2. dding C#ildren to %&isting %lements3.2.2.3. Rearranging t#e Dimension *ierarc#y

3.2.2.-. Deleting %lements 'rom a Dimension

3.2.2.0. Deleting %lements 'rom a Consolidation

3.2.2.. %diting %lement roperties

3.2.2.. $etting t#e rder o' %lements in a Dimension

3.2.2..1. $etting t#e rder o' Dimension %lements 'rom t#e $erver %&plorer

3.2.3. Managing t#e Display o' %lements in t#e Dimension %ditor

3.2.3.1. 4eeping %lements

3.2.3.2. *iding %lements

3.2.3.3. $orting %lements lp#abetically

3.2.3.-. $orting %lements by Inde& 5alue

3.2.3.0. $orting %lements by *ierarc#y

3.2.3.. 5ie/ing %lements by lias

3.2.-. Creating Dimensions Using Dimension +or6s#eets3.2.-.1. 4eeping Your Data $ync#roni7ed

3.2.-.1.1. Using t#e Remote $erver Data Directory

3.2.-.1.2. Using a +or6s#eet Directory

3.2.-.2. Creating Dimension +or6s#eets

3.2.-.3. (illing ut Dimension +or6s#eets

3.2.-.3.1. De'ining $imple %lements

3.2.-.3.2. De'ining Consolidated %lements

3.2.-.3.3. +eig#ting %lements in a Consolidation

3.2.-.-. $aving Dimension +or6s#eets

3.2.0. Using "amed *ierarc#y 8evels /it# TM1 Dimensions

3.2.0.1. Con'iguring "amed 8evels

3.2.0.2. $tring 8engt# 8imit 'or "amed 8evels

os TM1 Developer Guide 10.1.0 http://pic.dhe.ibm.com/infocenter/ctm1/v10r1m0/advanced/print.j

98 25-09-20



3.2.0.3. Using t#e Re'res#Md&*ierarc#y TurboIntegrator (unction /it# "amed 8evels

3.3. Creating Cubes

3.3.1. rdering Dimensions in a Cube

3.3.2. Creating a Cube

3.3.3. ptimi7ing t#e rder o' Dimensions in a Cube

3.3.-. %diting Cube roperties

3.3.-.1. %diting Measures and Time Dimension

3.3.-.2. %diting t#e 8oad on Demand roperty

3.-. Creating ic6 8ists

3.-.1. ic6 8ist Usage "otes

3.-.2. ic6 8ist Types3.-.2.1. $tatic ic6 8ists

3.-.2.2. $ubset ic6 8ists

3.-.2.3. Dimension ic6 8ists

3.-.3. Creating ic6 8ists /it# %lement ttributes

3.-.-. Creating ic6 8ists /it# Control Cubes

3.-.-.1. Creating a ic6 8ist Control Cube

3.-.-.2. De'ining ic6 8ists 'or Individual Cells in a Control Cube

3.-.-.3. Using Rules to De'ine ic6 8ists In a Control Cube

3.-.-.3.1. t#er ic6 8ist Rules %&amples

3.-.-.-. %&cluding Cells 'rom ic6 8ists

3.-.0. "ull 5alues in ic6 8ists

3.-.0.1. $electing "ull 5alues in ic6 8ists

3.-.. ic6 8ist rder o' recedence

3.0. Replicating Cubes bet/een $ervers3.0.1. Cube Relations#ips

3.0.2. $erver Relations#ips

3.0.2.1. Re9uired ccess rivileges

-. dvanced Calculations 'or :usiness Data

-.1. vervie/ o' Cube Rules

-.2. ,uidelines 'or +riting Rules $tatements

-.2.1. ,eneral Considerations

-.2.2. $ynta& 'or Describing t#e rea

-.2.2.1. Using $ubsets in an rea De'inition

-.2.2.2. Using $pecial C#aracters and "on)uni9ue %lement "ames in an rea De'inition

-.2.3. $ynta& 'or (ormulas

-.2.3.1. "umeric Constants

-.2.3.2. rit#metic perators

-.2.3.3. Using Conditional 8ogic-.2.3.-. Using Comparison perators

-.2.-. Using Cube Re'erences

-.2.-.1. Internal Cube Re'erences

-.2.-.2. %&ternal Cube Re'erences

-.2.0. rranging Rules $tatements

-.2.. $peci'ying Di''erent Rules at t#e "; and C; 8evels

-.2.. :ypassing Rules

-.2.<. =uali'ying %lement "ames

-.3. Rules %ditor and Rules +or6s#eets

-.3.1. Creating Rules +or6s#eets

-.3.2. $aving Rules +or6s#eets

-.-. Rules and Dimension Consolidations

-.-.1. rder o' Calculation

-.-.2. verriding C; 8evel %lements /it# Rules-.-.3. $tac6ing Rules

-.0. $ample pplications

-.0.1. Calculating Ratios

-.0.1.1. Creating t#e Margin> %lement

-.0.1.2. Creating t#e Margin> Rule

-.0.1.3. Understanding t#e ,enerated Rule

-.0.1.-. :ro/sing t#e ,ross Margin> 5alues

-.0.2. $#aring Data :et/een Cubes

-.0.2.1. Calculating $ales

-.0.3. Restricting Rules to $imple 5alues

-.0.-. Calculating an verage rice

-.0.0. 8in6ing T/o symmetrical Cubes


98 25-09-20



-.. Creating Drill)T#roug# rocesses and Rules

-..1. Creating a Drill rocess

-..2. %diting Drill rocesses

-..3. Deleting Drill rocesses

-..-. Creating a Drill ssignment Rule

-..0. Drill)T#roug# %&ample

-..0.1. $etting Up t#e D:C Data $ource

-..0.2. Creating a Drill rocess

-..0.3. Creating a Drill ssignment Rule 'or $ales:yMont#

-..0.-. 5ie/ing t#e Drill)T#roug# %&ample

-.. Debugging Rules-..1. Tracing Calculations

-..1.1. Tracing a Rule Calculation %&ample ?$imple@

-..1.2. Tracing a Consolidation %&ample ?Comple&@

-..1.3. Tracing a "e/ Calculation at#

-..2. Tracing (eeders

-..2.1. C#ec6ing (eeders

0. rgani7ing b!ects in TM1 pplications

0.1. pplication vervie/

0.1.1. Types o' Re'erences

0.1.2. :e#avior o' Re'erences

0.1.3. Display rder 'or Re'erences in pplications

0.1.-. Using pplications and Re'erences in t#e +eb Client

0.1.0. pplication 'olders and 'iles on t#e server

0.2. $ecurity Considerations 'or Creating and 5ie/ing pplications0.3. Creating and Managing pplications

0.3.1. Creating a Top)8evel pplication

0.3.2. Renaming pplications

0.3.3. Deleting pplications

0.3.-. Creating a $econdary)8evel pplication /it#in an %&isting pplication

0.-. dding b!ect Re'erences to an pplication

0.-.1. Ma6ing a Re'erence ublic

0.-.2. dding Re'erences to rivate 5ie/s and $ubsets to an pplication

0.-.3. $imultaneously Creating a "e/ b!ect and dding a Re'erence to an pplication

0.0. dding (ile Re'erences to an pplication

0.0.1. Understanding ublic and rivate (ile Re'erences

0.0.2. :e#avior o' 'iles uploaded to t#e server

0.0.3. Updating %&cel 'iles on t#e server

0.0.-. Updating non)%&cel 'iles on t#e server0.. dding UR8 Re'erences to an pplication

0.. +or6ing /it# b!ectA (ileA and UR8 Re'erences in pplications

0..1. 5ie/ing pplication roperties

0..2. Deleting b!ectA (ileA and UR8 Re'erences 'rom pplications

0..3. Renaming b!ectA (ileA and UR8 Re'erences in pplications

0..-. Deleting $ource b!ects t#at are Re'erenced by pplications

0.<. dministering $ecurity 'or pplications

0.<.1. ssigning $ecurity rivileges 'or pplications and Re'erences to User ,roups

0.<.2. ublis#ing applications and re'erences

0.<.2.1. ublis#ing rivate TM1 applications

0.<.2.2. ublis#ing rivate Re'erences to ublic b!ects

0.<.3. rivati7ing applications and re'erences

0.<.3.1. rivati7ing a ublic pplication

0.<.3.2. rivati7ing a ublic Re'erence0.B. 5ie/ing 8ogical ,roupings in TM1 pplications

0.1. ublis#ing applications to t#e /eb client

0.1.1. $etting +ebs#eet roperties

0.1.2. ublis#ing %&cel (iles to +eb /it#out Using %&cel on t#e +eb $erver

0.1.2.1. $imultaneously dding an %&cel (ile to an pplication and ublis#ing to TM1 +eb

0.1.2.2. Deleting an %&cel (ile 'rom TM1 +eb

0.1.2.3. Updating %&cel (iles in TM1 pplications

0.1.3. Creating *yperlin6s to Uploaded (iles

0.1.-. 5ie/ing +ebs#eets t#at Contain t#e &1 *e&adecimal C#aracter

. Importing Data /it# rocessing +or6s#eets

.1. rocessing +or6s#eets vervie/

.2. Importing Data Using rocessing +or6s#eets


98 25-09-20



.2.1. Reading in t#e (irst Input Ro/

.2.2. Comparing Input Records /it# a Cubes $tructures

.2.3. Converting Using I( (ormulas

.2.3.1. Mapping Using (i&ed 8abels

.2.-. Converting Using a 8oo6up Cube

.2.-.1. Importing Uni9ue "ames

.2.-.2. Creating a Reg"ame Dimension

.2.-.3. Creating t#e Translate Cube

.2.-.-. opulating t#e Translate Cube

.2.-.0. Creating t#e D:R (ormula

.2.0. Creating Database $end ?D:$@ (ormulas.2.0.1. D:$ $ynta&

.2.. rocessing a Data $ource into a Cube

. Controlling ccess to TM1 b!ects

.1. ssigning $ecurity Rig#ts to ,roups

.2. Interaction o' Di''erent b!ect $ecurity Rig#ts

.3. $ecuring Cubes

.3.1. ssigning $ecurity Rig#ts 'or Cubes

.3.2. Reserving and Releasing Cubes

.3.3. 8oc6ing and Unloc6ing a Cube

.-. $ecuring %lements

.-.1. ssigning $ecurity Rig#ts 'or %lements

.-.1.1. Interaction o' $ecurity Rig#ts 'or 8ea' and Consolidated %lements

.-.2. Reserving and Releasing %lements

.-.3. 8oc6ing and Unloc6ing an %lement.0. $ecuring Dimensions

.0.1. ssigning $ecurity Rig#ts 'or Dimensions

.0.2. Reserving and Releasing Dimensions

.0.3. 8oc6ing and Unloc6ing a Dimension

.. $ecuring rocesses

..1. ssigning $ecurity Rig#ts 'or rocesses

..2. llo/ing rocesses to Modi'y $ecurity Data

..2.1. %nabling t#e $ecurity ccess ption 'or a rocess

..2.2. 5ie/ing a rocess in Read)only Mode

.. $ecuring C#ores

..1. ssigning $ecurity Rig#ts 'or C#ores

.<. $ecuring pplications and Re'erences

.B. $ecuring Cells

.B.1. Creating a Cell $ecurity Control Cube.B.2. Using Rules to De'ine Cell)8evel $ecurity

<. Using TM1 ction :uttons to :uild +or6s#eet pplications

<.1. vervie/

<.2. dding an ction :utton to a +or6s#eet

<.3. Con'iguring an ction :utton to Run a rocess

<.3.1. $electing t#e rocess to Run

<.3.1.1. $elect t#e rocess "ame 'rom t#e rocess 8ist

<.3.1.2. Use an %&cel Re'erence to Retrieve t#e rocess "ame

<.3.2. $etting rocess arameters

<.3.2.1. %nter arameter 5alues into t#e arameter ,rid

<.3.2.2. Use an %&cel Re'erence to Retrieve t#e arameter 5alues

<.3.3. $etting rocess ptions 'or Calculation

<.3.-. $etting rocess ptions to $#o/ Messages

<.3.0. Using t#e ction :utton $erver "ame roperty<.-. Con'iguring an ction :utton to "avigate to not#er +or6s#eet

<.-.1. $elect a Target +or6s#eet

<.-.2. %nable t#e Matc# Title %lements ption

<.-.3. $etting t#e Replace Current +or6boo6 ption

<.-.-. $etting Calculation ptions 'or a'ter "avigating to a +or6s#eet

<.0. Con'iguring an ction :utton to Run a rocess and "avigate to a +or6s#eet

<.. Con'iguring an ction :utton to Recalculate or Rebuild a +or6s#eet

<.. Understanding ction :utton :e#avior /it# TM1 ctive (orms

<..1. :asic ction :utton :e#avior

<..2. dditional ction :utton :e#avior

<.<. $etting t#e ppearance roperties o' an ction :utton

<.B. Using dvanced "avigation and Mapping ptions


98 25-09-20



<.B.1. Con'iguring $ource to Target Mapping

<.B.1.1. $et t#e $ource Type

<.B.1.2. $et t#e $ource b!ect

<.B.1.3. $et t#e Target Type

<.B.1.-. $et t#e Target b!ect

<.B.2. %&ample o' Mapping a $ource 5alue to a Target Cell

<.B.3. %&ample o' Mapping a $ource $U:"M to a Target Cell

<.B.-. %&ample o' Mapping t#e $elected D:R+ to t#e Target +or6s#eet

<.1. Modi'ying an %&isting ction :utton

<.1.1. %diting t#e CaptionA :ac6ground ImageA and roperties o' an %&isting ction :utton

<.1.2. Moving and Resi7ing an %&isting ction :uttonB. Developing Custom +eb pplications /it# t#e UR8 I

B.1. UR8 I vervie/

B.2. :asic UR8 I $ynta&

B.2.1. :ase UR8

B.2.2. arameters

B.2.3. b!ectId arameter

B.2.-. Using UR8 %scape C#aracters

B.3. :asic UR8 I Concepts

B.3.1. $etting dmin *ost "ame and TM1 +eb $erver "ame arameters

B.3.2. Managing User 8ogin and 8ogout

B.3.2.1. 8ogging ut

B.3.3. Using t#e ction arameter /it# +eb ob!ects

B.3.-. Using t#e penb!ect arameter to pen a +eb b!ect

B.3.-.1. pening +ebs#eet and Cubevie/er ob!ectsB.3.-.2. pening t#e "avigation Tree ob!ect

B.3.0. perating on an %&isting +eb b!ect /it# t#e b!ectId arameter

B.-. ccessing t#e +ebs#eet b!ect

B.-.1. pening a +ebs#eet b!ect

B.-.1.1. Using t#e b!ect at# to pen a +ebs#eet b!ect

B.-.1.2. Using t#e pplication rgani7er at# to pen a +ebs#eet b!ect

B.-.1.3. Using an EM8 Tree "ode ID to pen a +ebs#eet b!ect

B.-.2. $electing Title %lements 'or a +ebs#eet b!ect

B.-.3. pplying ctions to a +ebs#eet b!ect

B.-.-. $etting Display roperties 'or t#e +ebs#eet b!ect

B.0. ccessing t#e Cubevie/er b!ect

B.0.1. pening a Cubevie/er b!ect

B.0.1.1. Using t#e b!ect at# to pen a Cubevie/er b!ect

B.0.1.2. Using t#e pplication rgani7er at# to pen a Cubevie/er b!ectB.0.1.3. Using an EM8 Tree "ode ID to pen a Cubevie/er b!ect

B.0.2. $etting Display roperties 'or t#e Cubevie/er b!ect

B.0.3. $electing Title %lements 'or t#e Cubevie/er b!ect

B.0.-. pplying ctions to a Cubevie/er b!ect

B.0.0. Displaying C#arts /it# t#e Cubevie/er b!ect

B.0.0.1. $etting :asic C#art ptions

B.0.0.2. $electing C#art Type

B.0.0.3. $etting C#art Color

B.. $etting %vent Callbac6 (unctions 'or Cubevie/er and +ebs#eet b!ects

B..1. %nabling a Callbac6 (unction 'or +ebs#eet and Cubevie/er b!ects

B..1.1. $etting a Callbac6 (unction 'or a $peci'ic Title Dimension

B..1.2. $etting a Callbac6 (unction 'or +ebs#eet b!ects nly

B..1.3. $etting a Callbac6 (unction 'or +ebs#eet and Cubevie/er b!ects

B..2. $etting a ,lobal Callbac6 (unction 'or ll Title DimensionsB.. ccessing t#e "avigation Tree b!ect

B..1. pening t#e "avigation Tree b!ect

B..2. Using t#e "avigation Tree b!ect in *TM8 Mode

B..2.1. Displaying t#e "avigation Tree Toolbar

B..2.2. $etting a Callbac6 (unction 'or t#e "avigation Tree b!ect

B..3. Using t#e "avigation Tree b!ect in EM8 Mode

B..3.1. EM8 pplication "ode

B..3.2. EM8 $erver "ode

B..3.3. Using EM8 Tree "ode IDs to pen +ebs#eet and Cubevie/er b!ects

1. Using Data Reservations

1.1. Data Reservation vervie/

1.2. Understanding Data Reservation be#avior /it# ot#er 'eatures


98 25-09-20



1.2.1. Data Reservations and $ecurity

1.2.2. Data Reservations and t#e user inter'ace

1.2.3. Data Reservations and Data spreading

1.2.-. Data Reservations and TurboIntegrator processes and c#ores

1.2.0. Data Reservations and $andbo&es

1.2.. Data ReservationsA $andbo&esA and Fob =ueue

1.3. %nabling Data Reservation

1.3.1. %nabling Data Reservation 'or cubes

1.3.1.1. DataReservationMode property

1.3.2. %nabling user groups to manage Data Reservations

1.-. Monitoring Data Reservations1.-.1. Displaying Data Reservation cell status in $erver %&plorer

1.-.2. Using TM1 Top to monitor t#reads /aiting 'or Data Reservations

1.-.3. Using t#e udit 8og to monitor Data Reservation events

1.-.3.1. =uerying 'or Data Reservation events

1.-.-. Using TurboIntegrator and I 'unctions to monitor Data Reservations

1.0. Managing Data Reservations /it# TurboIntegrator 'unctions

1.0.1. CubeDataReservationc9uire

1.0.2. CubeDataReservationRelease

1.0.3. CubeDataReservationReleasell

1.0.-. CubeDataReservation,et

1.0.0. CubeDataReservation,etCon'licts

1.. Managing Data Reservations /it# TM1 I 'unctions

1..1. TM1DataReservationc9uire

1..2. TM1DataReservationRelease1..3. TM1DataReservationReleasell

1..-. TM1DataReservation,etll

1..0. TM1DataReservation,etCon'licts

1... TM1DataReservation5alidate

1... I error codes 'or data reservations

11. $upported %&cel (unctions ) TM1 +eb

11.1. $upported (unctions

11.1.1. Date and Time (unctions

11.1.2. (inancial (unctions

11.1.3. In'ormation (unctions

11.1.-. 8ogical (unctions

11.1.0. 8oo6up and Re'erence (unctions

11.1.. Mat# and Trigonometric (unctions

11.1.. Te&t and Data (unctions11.1.<. $tatistical (unctions

12. Unsupported %&cel (unctions ) TM1 +eb

12.1. Database and 8ist Management (unctions

12.2. Date and Time (unctions

12.3. (inancial (unctions

12.-. In'ormation (unctions

12.0. 8oo6up and Re'erence (unctions

12.. Mat# and Trigonometric (unctions

12.. $tatistical (unctions

12.<. Te&t and Data (unctions

13. "otices

13.1. G


98 25-09-20



1. IntroductionT#is document is intended 'or use /it# I:MH CognosH TM1H .

T#is manual describes #o/ to create and maintain ob!ects on t#e I:M Cognos TM1 server A administer securityA and developTM1 applications. T#e guide also describes aspects o' TM1 security.

Finding information

To 'ind I:M Cognos product documentation on t#e /ebA including all translated documentationA access one o' t#e I:M

Cognos In'ormation Centers ?#ttp;publib.boulder.ibm.comin'ocentercogicv1rminde&.!sp@. Release "otes are publis#eddirectly to In'ormation CentersA and include lin6s to t#e latest tec#notes and Rs.

Samples disclaimer

T#e ,reat utdoors CompanyA , $alesA any variation o' t#e ,reat utdoors nameA and lanning $ample depict 'ictitiousbusiness operations /it# sample data used to develop sample applications 'or I:M and I:M customers. T#ese 'ictitiousrecords include sample data 'or sales transactionsA product distributionA 'inanceA and #uman resources. ny resemblance toactual namesA addressesA contact numbersA or transaction values is coincidental. t#er sample 'iles may contain 'ictionaldata manually or mac#ine generatedA 'actual data compiled 'rom academic or public sourcesA or data used /it# permission o't#e copyrig#t #olderA 'or use as sample data to develop sample applications. roduct names re'erenced may be t#etrademar6s o' t#eir respective o/ners. Unaut#ori7ed duplication is pro#ibited.

Accessibilit features

T#is product does not currently support accessibility 'eatures t#at #elp users /it# a p#ysical disabilityA suc# as restrictedmobility or limited visionA to use t#is product.

For!ard"loo#ing statements

T#is documentation describes t#e current 'unctionality o' t#e product. Re'erences to items t#at are not currently availablemay be included. "o implication o' any 'uture availability s#ould be in'erred. ny suc# re'erences are not a commitmentApromiseA or legal obligation to deliver any materialA codeA or 'unctionality. T#e developmentA releaseA and timing o' 'eaturesor 'unctionality remain at t#e sole discretion o' I:M.


98 25-09-20



$. Introduction to TM1 DevelopmentT#is section provides an introduction to t#e concept o' multidimensionality and describes some common responsibilities o'

developers using I:MH CognosH TM1H .

%nderstanding Multidimensionalit+it# I:M Cognos TM1 A you can create multidimensional databases t#at provide business and 'inance managers instantmeaning 'rom comple&A dynamic business models.

&our 'ole as Developer

s an I:M Cognos TM1 developerA your responsibilities 'all into 'our ma!or tas6s;%nderstanding TM1 (b)ect *aming Conventions

s a developerA you are responsible 'or creating and naming many ob!ects in t#e I:M Cognos TM1 system. You s#ouldobserve t#e 'ollo/ing conventions /#en naming TM1 ob!ects.


98 25-09-20



$.1. %nderstanding Multidimensionalit+it# I:MH CognosH TM1H A you can create multidimensional databases t#at provide business and 'inance managers instant

meaning 'rom comple&A dynamic business models.

To understand multidimensionalityA consider t#e e&ample o' t#e 5ice resident o' $ales 'or a retail company /#o /ants toanaly7e product sales across a retail c#ain t#at operates in t#e United $tates and Canada. %ac# retail store records t#e unitsalesA dollar salesA and discounts 'or t#e durable consumer products.

T#e sales are analy7ed by productA scenario ?actual versus budget@A regionA measures ?unitsA dollar salesA and discounts@A

and /ee6. +#at /e #ave identi'ied is a 'ive)dimensional model. T#e dimensions identi'y #o/ t#e data is organi7ed or #o/t#e types o' data are trac6ed.

In TM1 A t#e sales analysis can reside in one or more multidimensional structures called cubes. collection o' cubes 'orms adatabase. %ac# data point in a cube is identi'ied by one element in eac# dimension o' t#e cubeJ 'or e&ampleA actual dollarsales o' dryers during t#e second /ee6 o' Fanuary in t#e :oston store. TM1 cubes must contain no less t#an t/o and nomore t#an 20 dimensions.

Durables Cube

In t#e 'ollo/ing diagramA eac# dimension in t#e Durables cube is represented by a vertical line segment. T#e elements/it#in t#e dimension are represented by unit intervals.

+arent topic, Introduction to TM1 Development


98 25-09-20



$.1.1. Durables CubeIn t#e 'ollo/ing diagramA eac# dimension in t#e Durables cube is represented by a vertical line segment. T#e elements /it#in

t#e dimension are represented by unit intervals.

$uppose you are t#e 5ice resident o' $alesA and you need to 9uic6ly compare t#e per'ormance o' products and stores to

identi'y t#e /inning strategies and trouble spots. Using TM1 multidimensional vie/sA you can create an unlimited number o' ad #oc 9ueries.

In t#e 'ollo/ing e&ampleA you can 9uic6ly compare actual versus budgeted dollar sales across /ee6s. T#e region is :ostonand t#e product is a dryer model.

:y rearranging t#e vie/A you can compare dollar sales 'or t#e dryer model across all regions.

8ater sections o' t#is boo6 describe #o/ you can use TM1 to recon'igure vie/s and drill do/n into your multi)dimensionaldata to satis'y your analysis re9uirements.

+arent topic, Understanding Multidimensionality


398 25-09-20



$.$. &our 'ole as Developers an I:MH CognosH TM1H developerA your responsibilities 'all into 'our ma!or tas6s;

Design and create t#e cubes t#at #old business analyses.

Decide /#ere to store t#e cubes so t#ey can be s#ared across t#e organi7ation.

Import data into t#e cubes 'rom transactional systems and ot#er data sources.

Create 'ormulas t#at per'orm calculationsA suc# as average pricesA currency conversionsA and priceearning ratios.

You must #ave access rig#ts to t#e TM1 data in order to per'orm t#ese tas6s. TypicallyA your TM1 administrator is responsible'or setting access rig#ts. T#e 'ollo/ing section describes t#e distinction bet/een a local and a remote serverA and lists t#eaccess rig#ts you need to per'orm tas6s on a remote server.



398 25-09-20



$.-. %nderstanding TM1 (b)ect *aming Conventionss a developerA you are responsible 'or creating and naming many ob!ects in t#e I:MH CognosH TM1H system. You s#ould

observe t#e 'ollo/ing conventions /#en naming TM1 ob!ects.

'eserved CaractersT#e list o' invalid c#aracters is di''erent 'or naming ob!ects and /#en /riting rules or rule statements.

'ule Statements

T#e 'ollo/ing c#aracters are reserved /#en /riting rule statements. You cannot use t#ese reserved c#aracters inTM1 rule

statements;(b)ect *aming /ceptions

T#ere is no restriction on t#e c#aracters t#at you can use in elementA clientA groupA or alias namesA !it te follo!ingeceptions;



398 25-09-20



$.-.1. 'eserved CaractersT#e list o' invalid c#aracters is di''erent 'or naming ob!ects and /#en /riting rules or rule statements.

T#e 'ollo/ing c#aracters are reserved. You cannot use t#ese reserved c#aracters /#en you name TM1H applicationsA cubesAvie/sA dimensionsA subsetsA processesA and c#ores;

Caracter Description

slas#

K bac6)slas#

; colon

L 9uestion)mar6

double)9uote

N less)t#an

O greater)t#an

P pipe

Q asteris6

*ote, T#e rig#t curly brace ?@ cannot be t#e 'irst c#aracter in any TM1 ob!ect name.

+arent topic, Understanding TM1 b!ect "aming Conventions


398 25-09-20



$.-.$. 'ule StatementsT#e 'ollo/ing c#aracters are reserved /#en /riting rule statements. You cannot use t#ese reserved c#aracters inTM1H rule

statements;

Caracter Description

A comma

@ Close parent#esis

P pipe

S tilde

J semi)colon

at sign

+#en /riting rules /it# dimension)name constructsA do not use any o' t#e reserved c#aracters. Invalid dimension namec#aracters 'or rule)/riters are;, ) | ~ ; @ \ / : * ? " < >

$ee b!ect "aming %&ceptions 'or more in'ormation.



398 25-09-20



$.-.-. (b)ect *aming /ceptionsT#ere is no restriction on t#e c#aracters t#at you can use in elementA clientA groupA or alias namesA !it te follo!ing

eceptions;

MD /pressions

n element name cannot contain a circum'le& ?V@ because t#is c#aracter is used to denote relations#ips in MDE. I:MHCognosH TM1H uses MDE to 'ilter vie/s and generate dynamic subsets. T#ere'oreA an element name t#at contains acircum'le& causes errors /#en you apply 'ilters or create dynamic subsets.

n element name can contain a rig#t s9uare brac6et ? W @ but /#en an element name containing t#is c#aracter is re'erencedin an MDE e&pressionA t#e c#aracter needs to be escaped by doubling it. (or e&ampleA an element named rrayX"W %lementsAcan be re'erred to in an MDE e&pression as XrrayX"WW %lementsW.

TM1 'ules

You s#ould be a/are t#at some special c#aracters in ob!ect names may con'lict /#en used in a rules e&pression. (ore&ampleA t#e c#aracter and e&clamation point c#aracter are bot# valid c#aracters 'or ob!ect names but are also used inrules e&pressions.

T#e c#aracter can be used in any TM1 ob!ect name. *o/everA t#e c#aracter is a string comparison operator in TM1rules. I' you re'erence any ob!ect containing t#e c#aracter in rulesA t#e ob!ect name must be enclosed in single 9uotationmar6s. (or e&ampleA a dimension named productslocation must be re'erenced as productslocation in rules.

T#e e&clamation point c#aracter is also used in rules e&pressions and s#ould not be used in ob!ect names t#at /ill be usedin rules. (or e&ampleA t#e rules D: 'unction uses t#e e&clamation point as part o' t#e dimension argument.

DB('MarketExchange',!market,!date)

Maimum String 2engt for Data Director and (b)ect *ames

T#e entire string represented by t#e combination o' t#e I:M Cognos TM1 server data directory name and t#e ob!ect name islimited to 20 bytes. (or e&ampleA i' your data directory is C;K(inancial dataKTM1K ?22 bytes@A ob!ect names are limited to23- bytesA inclusive o' a 'ile e&tension suc# as.cub or .ru&.

$ome TM1 ob!ectsA suc# as vie/sA subsetsA and applicationsA are stored in sub)directories o' t#e TM1 server data directory.In t#is caseA t#e 20 byte limit is applied to t#e combination o' t#e TM1 server data directoryA t#e sub)directoryA and t#eob!ect name.

Case Sensitivit

b!ect names are not case sensitive. (or e&ampleA t#e dimension name actvsbud is e9uivalent to ct5s:ud.

Spaces in (b)ect *ames

$paces are allo/ed in all ob!ect namesA but spaces are ignored by t#e I:M Cognos TM1 server . T#e TM1 server considerst#e dimension name ct 5s :ud to be e9uivalent to ct5s:ud ?or actvsbud@.

%ser *ames

User names /it# reserved c#aracters cannot save private ob!ects.



398 25-09-20



-. Creating Cubes and DimensionsI:MH CognosH TM1H stores business data in cubes. T#is section describes #o/ to create cubes and t#eir building bloc6sA

dimensions.

*ote, ll tas6s described in t#is section re9uire TM1 erspectives or TM1 rc#itect . You cannot create cubesA createedit

dimensionsA or establis# replications /it# TM1 Client.

Designing Cubes

TM1 stores your business analyses in cubes. %ac# cell in a cube contains a measure t#at you are trac6ing in an analysis.

cube can store data against one or more measures.

Creating Dimensions

+#en you create a dimensionA you identi'y t#e lea')level elements t#at comprise t#e dimension andA optionallyA any#ierarc#ies ?consolidations@ /it#in t#e dimension.

Creating Cubes

You can al/ays create cubes on your local server. You must be t#e TM1 administrator to create cubes on remote servers.

Creating +ic# 2ists

pic6 list is a list o' valid values 'or a speci'ic element or cube cell. +#en an administrator de'ines a pic6 list 'or anelement or a cellA a drop)do/n menu containing t#e de'ined values is available in t#e speci'ied cell /#en bro/sing a cubein any o' t#e TM1 clients.

'eplicating Cubes bet!een Servers

Using t#e TM1 Replication 'eatureA you can copy cubes and ot#er associated ob!ects 'rom a remote server to your local

serverA or bet/een t/o remote servers. You can also sync#roni7e t#e data updates among t#e copied cubes eit#er atspeci'ied time intervals or on demand.


398 25-09-20



-.1. Designing CubesTM1H stores your business analyses in cubes. %ac# cell in a cube contains a measure t#at you are trac6ing in an analysis.

cube can store data against one or more measures.

You 'orm a cube /it# dimensionsA /#ic# identi'y #o/ to organi7e t#e data or t#e measures you /ant to trac6. ne elementin eac# dimension identi'ies t#e location o' a cell in a cube.

T#e 'ollo/ing e&ample cube contains t#ree dimensions; roductA MeasuresA and Mont#. %ac# measureA suc# as $alesA isorgani7ed or dimensioned by a product and a mont#. (or e&ampleA t#e cell value 3 represents t#e sales o' $edan)1 in

t#e mont# o' Fanuary [email protected] treats all dimensions t#e same /ayA /#et#er t#ey contain elements t#at identi'y measures or describe #o/ you organi7et#e measures.

Selecting te *umber of Dimensions%very cube #as at least t/o dimensions and a ma&imum o' 20 dimensions. (or e&ampleA a t/o)dimensional cube is bestsuited as a loo6up table /#en you /ant to calculate values in ot#er cubes t#at #ave more dimensions. (or e&ampleA youcan convert t#e local currency amounts to a reporting currency by using a t/o)dimensional cube t#at stores t#ee&c#ange rates. You retrieve t#e rate using t#e TM1 rule.

Consolidating Detail %sing Dimension 3ierarcies

T#e data you import into a cube provides a snaps#ot o' your business at a speci'ic level o' detail. (or e&ampleA you mig#t

import t#e /ee6ly or mont#ly sales data 'or products by city. T#e dimension elements t#at identi'y t#ese data points aresimple or lea')level elements in eac# dimension; sales 'or one /ee6A one productA one city.

Tpes of /lements

$o 'arA youve learned about simple or base)level elements t#at you can roll up to consolidations.TM1 supports t#reetypes o' elements;

/lement Attributes

T#e elements identi'y data in a cubeA and t#e element attributes describe t#e elements t#emselves.

Designing Cubes " Summar

*ere are guidelines to use /#en you design cubes;

+arent topic, Creating Cubes and Dimensions


398 25-09-20



-.1.1. Selecting te *umber of Dimensions%very cube #as at least t/o dimensions and a ma&imum o' 20 dimensions. (or e&ampleA a t/o)dimensional cube is best

suited as a loo6up table /#en you /ant to calculate values in ot#er cubes t#at #ave more dimensions. (or e&ampleA you can

convert t#e local currency amounts to a reporting currency by using a t/o)dimensional cube t#at stores t#e e&c#ange rates.

You retrieve t#e rate using t#e TM1H rule.

T#e number o' dimensions in a cube depends mostly on t#e dimensionality o' your data. Consider t#e accounts in a ro'itand 8oss $tatement.

+rofit and 2oss Statement 4in tousands5

&ear /nding -1 Dec6 $00$

"et sales 2A

Direct costs 30A

Direct labor 0A

,ross ro'it 110A

$alaries 3A

ayroll 3A0

%lectricity 0A

Rent 1A

Depreciation A

I' you /ant to e&amine #o/ t#e revenue and e&penses vary by t#eir 'actorsA you /ould need to divide t#e accounts into t/ogroups.

Accounts above te Gross +rofit lineA suc# as "et sales and Direct costsA /#ic# you can dimension by productAregionA scenario ?ctual versus :udget@A and mont#s.

Accounts belo! te Gross +rofit lineA suc# as ayrollA %lectricityA and RentA /#ic# you can dimension by regionAscenario ?ctual versus :udget@A and mont#sA but not product. You cannot directly attribute t#e over#eads to productsAso you cannot analy7e t#em at t#e same level o' detail.

T#is di''erence in dimensionality suggests t/o cubes;

(ive)dimensional cube 'or t#e accounts above t#e ,ross ro'it line

(our)dimensional cube 'or t#e accounts belo/ t#e ,ross ro'it line

Five"dimensional Cube

T#e 'ollo/ing diagram represents t#e dimensions and elements in t#e 'ive)dimensional cube. %ac# dimension isrepresented by a vertical line segment. T#e elements /it#in t#e dimension are represented by unit intervals.

Four"dimensional Cube

T#e 'ollo/ing diagram represents t#e dimensions and elements in t#e 'our)dimensional cube. %ac# dimension isrepresented by a vertical line segment. T#e elements /it#in t#e dimension are represented by unit intervals.

+arent topic, Designing Cubes


398 25-09-20





-.1.1.$. Four"dimensional CubeT#e 'ollo/ing diagram represents t#e dimensions and elements in t#e 'our)dimensional cube. %ac# dimension is represented

by a vertical line segment. T#e elements /it#in t#e dimension are represented by unit intervals.

+arent topic, $electing t#e "umber o' Dimensions


398 25-09-20



-.1.$. Consolidating Detail %sing Dimension 3ierarciesT#e data you import into a cube provides a snaps#ot o' your business at a speci'ic level o' detail. (or e&ampleA you mig#t

import t#e /ee6ly or mont#ly sales data 'or products by city. T#e dimension elements t#at identi'y t#ese data points are

simple or lea')level elements in eac# dimension; sales 'or one /ee6A one productA one city.

:y using dimension #ierarc#iesA you can easily aggregate numeric data into categories t#at are meaning'ul in your analyses.%ac# category corresponds to an aggregation o' detail 'or t/o or more elements in a dimension. (or e&ampleA you can create9uarterly elements t#at sum mont#ly sales amounts. In TM1H A elements t#at represent aggregations are calledconsolidated elements or consolidations.

T#e 'ollo/ing diagram s#o/s t#ree levels o' consolidation 'or elements o' a Region dimension. T#e cities provide t#e lo/estlevel o' detail ?8evel @. T#e cities roll up into state consolidations ?8evel 1@A /#ic# roll up into regional consolidationsA /#ic#'inally roll up into t#e %astern U$ consolidation ?8evel 3@.

*avigating troug a Dimension 3ierarc

dimension #ierarc#y provides a navigation pat# 'or analy7ing data at di''erent levels o' detail. Drilling do/n meansnavigating to greater levels o' detail along one dimension. (or e&ampleA as you drill do/n 'rom "e/ %ngland in t#e above

Region dimensionA you access t#e underlying data 'or t/o states and t#en 'our cities. Drilling up means navigating tosummary levels in dimensions.

%sing 7eigts to /press Consolidations+eig#t 'actors determine t#e contribution o' an element to a consolidation. To e&press t#at t#e Connecticut sales total isa sum o' *art'ord and "e/ *avenA you assign a de'ault /eig#t 'actor o' 1. to bot# *art'ord and "e/ *aven.

Creating Multiple 'oll"ups in a DimensionYou can roll up lo/)level numeric dataA suc# as sales and unitsA in several /ays by creating multiple #ierarc#ies in adimension. :y creating multiple roll)ups in a dimensionA you can reduce t#e number o' dimensionsA and t#e number o' empty cells in a cube.

Creating Comple Calculations

TM1 aggregates t#e consolidations you create /it#in dimensions by t#e /eig#t 'actors you assign. To create ratiosbet/een t#e elements or multiply t#e values associated /it# t#e elementsA you must create a comple& calculationA called

a rule. *ere are t/o calculations t#at re9uire TM1 rules;



398 25-09-20



-.1.$.1. *avigating troug a Dimension 3ierarc dimension #ierarc#y provides a navigation pat# 'or analy7ing data at di''erent levels o' detail. Drilling do/n means

navigating to greater levels o' detail along one dimension. (or e&ampleA as you drill do/n 'rom "e/ %ngland in t#e above

Region dimensionA you access t#e underlying data 'or t/o states and t#en 'our cities. Drilling up means navigating to

summary levels in dimensions.

+arent topic, Consolidating Detail Using Dimension *ierarc#ies


398 25-09-20



-.1.$.$. %sing 7eigts to /press Consolidations+eig#t 'actors determine t#e contribution o' an element to a consolidation. To e&press t#at t#e Connecticut sales total is a

sum o' *art'ord and "e/ *avenA you assign a de'ault /eig#t 'actor o' 1. to bot# *art'ord and "e/ *aven.

You can also consolidate elements by subtracting t#e values associated /it# t#e elements. (or e&ampleA you can e&press "etro'it as Mar6et 5alue ) c9uisition 5alue. You /ould assign a /eig#t 'actor o' 1. to Mar6et 5alue and )1. to c9uisition5alue. T#e 'ollo/ing table presents 'our /eig#ting e&amples o' consolidation.

Dimension Consolidated /lement Consolidation Metod Subordinate /lements 7eigt Factors

ccount "et ro'it $ubtraction Mar6et 5alue

c9uisition 5alue

1.

)1.

Mont# 1=uarter ddition Fanuary

(ebruary

Marc#

1.

1.

1.

eriod Yearly :udget -)-)0 Distribution Fanuary

(ebruary

Marc#

.B2

.B2

.B10

Region Connecticut ddition *art'ord

"e/ *aven

1.

1.



398 25-09-20



-.1.$.-. Creating Multiple 'oll"ups in a DimensionYou can roll up lo/)level numeric dataA suc# as sales and unitsA in several /ays by creating multiple #ierarc#ies in a

dimension. :y creating multiple roll)ups in a dimensionA you can reduce t#e number o' dimensionsA and t#e number o' empty

cells in a cube.

In t#e 'ollo/ing e&ampleA *art'ordA a simple element in t#e Region dimensionA rolls up along t/o pat#s; geograp#ic andmanagement.

Geograpic 'oll"up

Management 'oll"up



398 25-09-20



-.1.$.-.1. Geograpic 'oll"up

+arent topic, Creating Multiple Roll)ups in a Dimension


398 25-09-20



-.1.$.-.$. Management 'oll"up

+arent topic, Creating Multiple Roll)ups in a Dimension


398 25-09-20



-.1.$.8. Creating Comple CalculationsTM1H aggregates t#e consolidations you create /it#in dimensions by t#e /eig#t 'actors you assign. To create ratios bet/een

t#e elements or multiply t#e values associated /it# t#e elementsA you must create a comple& calculationA called a rule. *ere

are t/o calculations t#at re9uire TM1 rules;

,ross Margin ?,ross ro'it "et $ales@ & 1

$ales ?rice & Units@

You can also use rules to tally t#e elements. *o/everA rules ta6e longer to process t#an consolidationsA especially in large or

sparse cubes. $parse cubes #ave a #ig# percentage o' empty cells.

(or a compre#ensive e&planation o' rulesA see t#e I:MH CognosH TM1 Rules Guide.



398 25-09-20



-.1.-. Tpes of /lements$o 'arA youve learned about simple or base)level elements t#at you can roll up to consolidations.TM1H supports t#ree types

o' elements;

/lement Description

"umeric Identi'y t#e lo/est)level detail in a dimension. In a cube t#at contains only numbersA TM1

de'ines all t#e lo/est)level elements as numeric.

Consolidated ggregations o' lo/er)level detail. (or e&ampleA you could use t#e 1=uarter element in a timedimension to sum t#e sales amounts 'or t#e 'irst t#ree mont#s o' t#e year.

$tring $tores te&t strings in cells. To include a string in a cell in a cubeA t#e element 'rom t#e lastdimension de'ining t#e cell must be a string element. TM1 treats string elements t#at occur inany dimension ot#er t#an t#e last one as numeric elements.

T#e typical use 'or string elements is in a t/o)dimensional cube t#at converts codes in an input'ile to 'ormal element names. (or e&ampleA i' you /ant to convert account codes to accountnames.



398 25-09-20



-.1.8. /lement AttributesT#e elements identi'y data in a cubeA and t#e element attributes describe t#e elements t#emselves.

You can use attributes to;

8ist 'eatures o' elements. (or e&ampleA t#e s9uare 'ootage o' a store and t#e engine si7e o' a car model.

rovide alternative namesA or aliases. (or e&ampleA descriptive names o' general ledger accounts and t#e local languageversions o' product names.

Control t#e display 'ormat 'or t#e numeric data. TypicallyA you select a display 'ormat 'or t#e measures you trac6 in acube.

You can select elements by attribute value in t#e Subset /ditor. You can also display element names in TM1H dialog bo&esusing t#eir aliases.

To create attributes and assign attribute valuesA use t#e Attributes /ditor.

Descriptive Attributes

T#e 'ollo/ing table s#o/s sample attributes t#at describe car models.

Alias AttributesT#e 'ollo/ing table s#o/s ,ermanA $panis#A and (renc# versions o' %nglis# 'urniture names.

Displa Format Attributes

T#e Cube 9ie!er /indo/ displays numeric data in t#e 'ormats s#o/n in t#e 'ollo/ing table.

Setting Displa Formats for 'o!s or Columns

You mig#t /ant to 'ormat t#e numbers in a single column or ro/. (or e&ampleA numbers in a column or ro/ t#at containt/o decimal places mig#t be better represented as /#ole numbers /it# no decimal points. To 'ormat t#e numbers in asingle column or ro/A use t#e Attribute /ditor.

Attributes versus /lements

+#en you /ant to list multiple attributes values 'or a single elementA consider creating additional elements or additionaldimensions. (or e&ampleA t#e e&terior color is an attribute o' car models. T#e red models o'ten outsell t#e ot#er colormodels. I' you create one element per car and anot#er dimension /it# elements 'or eac# colorA you can use TM1 to trac6car sales by color. I' you combine sales into a single modelA you mig#t lose valuable detail.



398 25-09-20



-.1.8.1. Descriptive AttributesT#e 'ollo/ing table s#o/s sample attributes t#at describe car models.

/lements Attributes

3orsepo!er 4*umeric5 /ngine 4Tet5 Audio 4Tet5

$edan 1 1B 5)< Compact Disc

$edan 2 1- Inline - Cassette Radio

$edan 3 12 Inline - Cassette Radio

$edan - 1< 5)< Compact Disc

$edan 0 1- Inline - Cassette Radio

+arent topic, %lement ttributes


398 25-09-20



-.1.8.$. Alias AttributesT#e 'ollo/ing table s#o/s ,ermanA $panis#A and (renc# versions o' %nglis# 'urniture names.

/lements Alias Attributes

Deutsce /spa:ol Fran;ais

C#air $tu#l $illa C#aise

Des6 $c#reibtisc# %scritorio :ureau

8amp 8ampe 8Zmpara 8ampe



398 25-09-20



-.1.8.-. Displa Format AttributesT#e Cube 9ie!er /indo/ displays numeric data in t#e 'ormats s#o/n in t#e 'ollo/ing table.

Format *ame Description /ample

Currency "umbers appear /it# a currency symbol and t#e speci'ied numbero' decimal places ?recision@. TM1H uses t#e currency symbol

de'ined in t#e Microso't +indo/s Regional $ettings dialog bo&.

[B.

,eneral "umbers appear /it# a speci'ied number o' decimal places?recision@.

)B

ercentage "umbers appear as percentagesA /it# a speci'ied number o' decimalplaces ?recision@.

B.>

$cienti'ic "umbers appear in e&ponential 'ormA /it# a speci'ied number o' decimal places ?recision@.

B.e\1

Date "umbers appear as a date string. 1Fanuary 1A 1B. T#ere are anumber o' date 'ormats available.

Marc# 31A 22

Time "umbers appear as a time string. T#ere are a number o' time'ormats available.

1B;03;3

Comma laces commas in t#e appropriate places in large numbers. 1AA

Custom user)de'ined 'ormat. Custom

Using t#e Attributes /ditor /indo/A you can select a display 'ormat 'or every element in eac# dimension in a cube.

*o/everA it is recommended t#at you select display 'ormats only 'or one dimensionA t#e measures you trac6 in a cube. Youcan also select a 'ormat in t#e Cube 9ie!er /indo/ t#at applies to cells /#ose elements do not #ave a display 'ormatde'ined.

TM1 determines /#ic# display 'ormat to use in t#e Cube 9ie!er /indo/A as 'ollo/s;

+rocedure

TM1 'irst c#ec6s t#e elements in t#e column dimension 'or display 'ormats. I' dimensions are stac6edA TM1 c#ec6s 'romt#e bottom up/ard.

1.

I' no 'ormat is 'oundA TM1 c#ec6s t#e elements in t#e ro/ dimension 'or display 'ormats. I' dimensions are stac6edA TM1c#ec6s 'rom rig#t to le't.

2.

I' no 'ormat is 'oundA TM1 c#ec6s t#e title elements 'or display 'ormats. T#e elements are inspected 'rom rig#t to le't.3.

I' no 'ormat is 'oundA TM1 applies t#e 'ormat 'or t#e current vie/.

To ensure t#at TM1 applies t#e 'ormat 'or t#e cube measuresA position t#e dimension containing t#e measures as t#ebottommost column dimension.

-.



398 25-09-20



-.1.8.8. Setting Displa Formats for 'o!s or ColumnsYou mig#t /ant to 'ormat t#e numbers in a single column or ro/. (or e&ampleA numbers in a column or ro/ t#at contain t/o

decimal places mig#t be better represented as /#ole numbers /it# no decimal points. To 'ormat t#e numbers in a single

column or ro/A use t#e Attribute /ditor.

T#e Mont# dimension displays in t#e column o' t#e vie/. ny display 'ormat you assign to a column dimension overrides t#edisplay 'ormat you select 'or t#e ro/ dimension.

(or t#e 'irst tas6A lets ma6e sure t#at no 'ormatting is applied to t#e Year element o' t#e Mont# dimension. (ollo/ t#ese

steps.

+rocedure

pen t#e Format vie/ o' $alesriorCube.1.

In t#e $erver %&plorerA e&pand t#e $alesriorCube cube so t#at you can see its dimensions.2.

Rig#t)clic6 t#e Mont# dimensionA and select /dit /lement Attributes.

T#e Attribute /ditor opens.

"ote t#at t#ere are no (ormat attribute values 'or t#e Mont# dimension. You can no/ be sure t#at any 'ormats you set'or t#e ro/ dimension /ill ta6e precedence in t#e Cube 5ie/er ?or In)$preads#eet :ro/ser@.

3.

Clic6 t#e Cancel to close t#e ttribute %ditor.

(or t#is tas6A 'ollo/ t#e steps to 'ormat t#e numbers in t#e Units ro/ as /#ole numbers /it# 7ero ?@ decimal places.

-.

In t#e $erver %&plorerA rig#t)clic6 t#e Account1 dimensionA and select /dit /lement Attributes.

T#e Attribute /ditor opens.

0.

Clic6 t#e cell at t#e intersection o' t#e Units element ro/ and t#e (ormat column..

Clic6 t#e Format button.

T#e *umber Format dialog bo& opens.

.

$elect t#e Comma categoryA enter 0 in t#e +recision bo&A and clic6 (<.<.

Clic6 (< in t#e Attributes /ditor dialog bo&.B.

Clic6 'ecalculate to recalculate t#e Format vie/.

T#e %nits values no/ display as /#ole numbers /it#out decimal points.

1.



398 25-09-20





-.1.=. Designing Cubes " Summar*ere are guidelines to use /#en you design cubes;

+rocedure

8ist t#e measures you /ant to trac6 in your business analysis. %&amples o' measures include sales amountsA units soldAe&pensesA ac9uisition valuesA and campaign costs.

1.

Determine #o/ you /ant to organi7e or dimension t#e measures. In most analysesA you trac6 measures over time.

+#at is t#e base time interval; daysA /ee6sA mont#sLIs t#ere a geograp#ic dimensionL

Do t#e measures vary by customer and productL

Is t#ere a scenario dimension ?actual versus budget@L

2.

Determine #o/ you /ant to consolidate t#e dimension elements.3.

Create a list o' attributes you /ant to associate /it# t#e elements o' t#e cube. %&amples o' attributes include stores9uare 'ootageA customer IDsA and local language versions o' element names.

-.

De'ine t#e display 'ormats 'or t#e measures in your cubes. (or e&ampleA de'ine ,ross Margin as a percentage and $alesas a currency amount.

0.



398 25-09-20



-.$. Creating Dimensions+#en you create a dimensionA you identi'y t#e lea')level elements t#at comprise t#e dimension andA optionallyA any

#ierarc#ies ?consolidations@ /it#in t#e dimension.

T#ere are 'our /ays to create dimensions;

Dimension /ditor ) dd elements as /ell as create and rearrange consolidations /#ile you design dimensions. (or morein'ormationA see Creating Dimensions Using t#e Dimension %ditor +indo/.

TurboIntegrator ) Import element names 'rom an $CIIA D:CA cube vie/A or dimension subset source.

$imultaneously create multiple dimensions and establis# consolidation /it#in t#ose dimensions. (or more in'ormationAsee t#e I:MH CognosH TM1H TurboIntegrator Guide.

*ote, TM1 re9uires DataDirect drivers to access an racle D:C source on $olaris or IEH. T#ese drivers are notsupplied /it# TM1 and must be ac9uired separately.

Importing Data into a *e! Cube ) Use TurboIntegrator to map input ro/s 'rom a data source to a cube. T#en identi'yt#e input columns t#at supply t#e cell values and t#e elements t#at identi'y t#e cell location. (or more in'ormation aboutt#is processA see t#e I:M Cognos TM1 TurboIntegrator Guide.

Dimension 7or#seets ) Use t#ese modi'ied Microso't %&cel /or6s#eets to list t#e elements and #ierarc#icalrelations#ips 'or one dimension. (or more in'ormationA see Creating Dimensions Using Dimension +or6s#eets.

Creating Dimensions %sing te Dimension /ditor 7indo!

T#is section /al6s you t#roug# t#e steps 'or creating a simple rea dimension using t#e Dimension /ditor /indo/.ssume t#at t#e #ierarc#y 'or t#e rea dimension includes t#e consolidated "e/ %ngland element and t#ree simpleelementsA ConnecticutA Massac#usetts and 5ermont.

Modifing a Dimension'ter creating a dimensionA you can ma6e t#e 'ollo/ing modi'ications;

Managing te Displa of /lements in te Dimension /ditor

T#e Dimension %ditor includes several 'eatures t#at let you manage t#e /ay elements display. (or e&ampleA /#en you/or6 /it# large dimensions it mig#t be #elp'ul to display only t#e elements o' a certain #ierarc#y levelA or you mig#t/ant to vie/ t#e elements in alp#abetical order.

Creating Dimensions %sing Dimension 7or#seets dimension /or6s#eet is a modi'ied %&cel spreads#eet in /#ic# you list elements and #ierarc#ical relations#ips 'or onedimension. TM1 saves t#e /or6s#eet data in t/o 'iles; dimension /or6s#eet ?dimname.&di@ and compiled 'ile?dimname.dim@.

%sing *amed 3ierarc 2evels !it TM1 DimensionsYou can assign your o/n custom names to t#e #ierarc#y levels o' t#e TM1 dimension by using t#e}HierarchyProperties control cube. T#e named levels you create can t#en be used /#en you e&ternally access TM1

data /it# I:M Cognos Report $tudioA MDE statements or ot#er MDE 8 tools. You can also assign a de'ault member'or t#e dimension.



398 25-09-20



-.$.1. Creating Dimensions %sing te Dimension /ditor 7indo!T#is section /al6s you t#roug# t#e steps 'or creating a simple rea dimension using t#e Dimension /ditor /indo/. ssume

t#at t#e #ierarc#y 'or t#e rea dimension includes t#e consolidated "e/ %ngland element and t#ree simple elementsA

ConnecticutA Massac#usetts and 5ermont.

+rocedure

In t#e Tree pane o' t#e $erver %&plorerA select Dimensions beneat# t#e server t#at you /ant to contain t#e dimension.1.

Clic6 DimensionsA Create *e! Dimension.

T#e Dimension /ditor opens.

You can no/ add elements to t#e dimension.

2.

Clic6 /ditA Insert /lement or clic6 Insert Sibling .

T#e Dimension /lement Insert dialog bo& opens.

3.

To add a consolidated elementA do t#e 'ollo/ing;

Type *e! /ngland in t#e Insert %lement "ame 'ield.

$elect Consolidated 'rom t#e /lement Tpe list.

Clic6 Add.

Clic6 (<.

"e/ %ngland no/ appears as t#e 'irst element o' t#e dimensionA /#ic# is a consolidated element. "o/ lets add t#reec#ild elements to t#e "e/ %ngland element. s a resultA "e/ %ngland becomes t#e parent element o' t#e t#ree c#ildelements.

-.

$elect t#e *e! /ngland element.0.

Clic6 /ditA Insert Cild or clic6 Insert Cild .

T#e Dimension /lement Insert dialog bo& opens. TM1H displays a arent name o' "e/ %nglandA indicating t#at anyelements you create /ill be t#e c#ildren o' "e/ %ngland.

.

In t#e Insert %lement "ame 'ieldA type Connecticut and clic6 Add..

In t#e Insert /lement *ame 'ieldA type Massacusetts and clic6 Add.<.

In t#e Insert /lement *ame 'ieldA type 9ermont and clic6 Add.

T#e dialog bo& no/ contains t#ree c#ildren o' "e/ %nglandA eac# /it# a de'ault /eig#t o' 1.

B.

Clic6 (<.

T#e Dimension /ditor s#o/s t#e ne/ elements as c#ildren o' "e/ %ngland.

1.

Clic6 DimensionA Save or clic6 Save .

T#e Dimension Save As dialog bo& opens.

11.

%nter a dimension name and clic6 Save.

Dimension names can #ave a ma&imum o' 20 c#aracters. l/ays use descriptive dimension names.

T#e ne/ dimension displays in t#e list o' dimensions on t#e server.

12.

+arent topic, Creating Dimensions


398 25-09-20



-.$.$. Modifing a Dimension'ter creating a dimensionA you can ma6e t#e 'ollo/ing modi'ications;

dd siblings to e&isting elements.

dd c#ildren to e&isting elements.

Rearrange t#e #ierarc#y structureA suc# as repositioning elements /it#in consolidations.

Delete elements 'rom t#e dimension.

Delete elements 'rom consolidations.

%dit element propertiesA suc# as c#anging t#e /eig#t o' an element /it#in a consolidation.

Rearrange t#e order o' elements in t#e dimension.

Adding Siblings to /isting /lements

(ollo/ t#ese steps to add siblings to an e&isting element in t#e Dimension %ditor.

Adding Cildren to /isting /lements

(ollo/ t#ese steps to add c#ildren to e&isting elements in t#e Dimension %ditor.

'earranging te Dimension 3ierarc(ollo/ t#ese steps to c#ange t#e position o' elements /it#in t#e dimension #ierarc#y.

Deleting /lements from a Dimension

(ollo/ t#ese steps to delete elements 'rom a dimension.

Deleting /lements from a Consolidation(ollo/ t#ese steps to delete elements 'rom a consolidation.

/diting /lement +roperties

You can edit t#e element properties to assign a ne/ /eig#t to an element o' a consolidationA or to c#ange t#e elementtype o' a lea')level element.

Setting te (rder of /lements in a Dimension

TM1 lets you set t#e order o' elements in a dimension to determine t#e inde& value 'or eac# element in a dimension. T#e'irst element in a dimension #as an inde& value o' 1A t#e second element #as an inde& value o' 2A and so on.



398 25-09-20



-.$.$.1. Adding Siblings to /isting /lements(ollo/ t#ese steps to add siblings to an e&isting element in t#e Dimension %ditor.

+rocedure

Rig#t)clic6 t#e element to /#ic# you /ant to add siblings and select /dit Dimension Structure.1.

Clic6 /ditA Insert Sibling.

T#e Dimension /lement Insert dialog bo& opens.

2.

%nter t#e name o' t#e 'irst sibling in t#e Insert /lement *ame 'ield.3.

I' applicableA enter an %lement +eig#t.

T#e de'ault element /eig#t is 1.

-.

Clic6 Add.0.

Repeat steps 3 t#roug# 0 'or eac# sibling you /ant to add..

Clic6 (<.

TM1 adds t#e ne/ elements as siblings o' t#e element you selected in step 1.

.

+arent topic, Modi'ying a Dimension


398 25-09-20





-.$.$.-. 'earranging te Dimension 3ierarc(ollo/ t#ese steps to c#ange t#e position o' elements /it#in t#e dimension #ierarc#y.

+rocedure

In t#e Dimension /ditorA select t#e elements you /ant to move.

To select a single elementA clic6 t#e element.

To select multiple ad!acent elementA clic6 t#e 'irst elementA #old do/n $*I(TA and clic6 t#e last element. You can also

press CTR8) to select all visible elements.To select multiple non)ad!acent elementsA #old do/n CTR8A and clic6 eac# element.

1.

Drag and drop t#e elements to t#eir ne/ location in t#e dimension #ierarc#y.

s you drag t#e elementsA t#e cursor c#anges to indicate /#ere TM1 /ill drop t#e elements. lsoA t#e status bar displaysa message indicating /#ere TM1 /ill drop t#e elements.

You can also cut and paste elements to rearrange t#e dimension #ierarc#y.

2.



398 25-09-20



-.$.$.8. Deleting /lements from a Dimension(ollo/ t#ese steps to delete elements 'rom a dimension.

+rocedure

$elect t#e elements you /ant to delete.


To select multiple ad!acent elementA clic6 t#e 'irst elementA #old do/n $*I(TA and clic6 t#e last element.

To select multiple non)ad!acent elementsA #old do/n CTR8A and clic6 eac# element.

To select elements by #ierarc#y levelA attribute valueA or spelling patternA see t#e I:M Cognos TM1 User Guide.

1.

Clic6 /ditA Delete /lement.

con'irmation dialog bo& displays t#at lists t#e dimension name and as6s i' you are sure you /ant to delete t#e ob!ectt#at you #ave selected. Clic6 &es to proceed /it# t#e deletionA clic6 *o or Cancel to cancel t#e deletion.

2.



398 25-09-20



-.$.$.=. Deleting /lements from a Consolidation(ollo/ t#ese steps to delete elements 'rom a consolidation.

+rocedure

$elect t#e elements you /ant to delete.




1.

Clic6 /ditA Delete /lement from Consolidation or clic6 Delete .

con'irmation dialog bo& displays t#at lists t#e dimension name and as6s i' you are sure you /ant to delete t#e ob!ectt#at you #ave selected. Clic6 &es to proceed /it# t#e deletionA clic6 *o or Cancel to cancel t#e deletion.

TM1 deletes t#e element 'rom t#e consolidationA and 6eeps any ot#er instances o' t#e element in t#e dimension.

*ote, I' you de'ine t#e element only /it#in t#e consolidationA TM1 deletes t#e element 'rom t#e dimension as /ell.

2.



398 25-09-20



-.$.$.>. /diting /lement +ropertiesYou can edit t#e element properties to assign a ne/ /eig#t to an element o' a consolidationA or to c#ange t#e element type

o' a lea')level element.

*ote, You cannot c#ange t#e element type o' consolidated elementsA and you cannot assign an element /eig#t to any

instance o' an element t#at is not a member o' a consolidation.

+rocedure

$elect t#e element.1.

Clic6 /ditA /lement +roperties.

T#e Dimension /lement +roperties dialog bo& opens.

2.

I' necessaryA select a ne/ element type 'rom t#e /lement Tpe list.3.

I' necessaryA enter a ne/ %lement +eig#t.-.

Clic6 (<.0.



398 25-09-20





c

e

'

#

i

(or t#e e&ampleA /#en you set t#e order o' elements 'or a subsetA t#e ne/ order a''ects t#e entire dimension in t#e'ollo/ing /ay;

T#e subset o' elements t#at /as active /#en t#e element order /as set appear /it# s#aded icons.

T#e 'irst subset element maintains its position in t#e dimension relative to its nearest predecessor .

In t#e e&ampleA element d is t#e 'irst element in t#e subset /#en t#e order o' elements /as set.

%lement b is t#e nearest predecessorA exclusive of subset elementsA to d in t#e dimensionA so d no/ 'ollo/s b in t#edimension structure.

T#e ot#er subset elements appear in t#e dimension structure maintaining t#eir position relative to t#e 'irst elementin t#e subset.

Setting te (rder of Dimension /lements from te Server /plorer

You can also set t#e order o' dimension elements 'rom t#e $erver %&plorer /it#out opening t#e Dimension /ditor. Youcan also select a sorting property 'or t#e dimension 'rom t#ese t#ree automatic sort orders;



398 25-09-20



-.$.$.?.1. Setting te (rder of Dimension /lements from te Server /plorerYou can also set t#e order o' dimension elements 'rom t#e $erver %&plorer /it#out opening t#e Dimension /ditor. You can

also select a sorting property 'or t#e dimension 'rom t#ese t#ree automatic sort orders;

"ame

8evel

*ierarc#y

'ter you set t#e sorting propertyA TM1 inserts t#e elements you added to t#e dimension according to t#eir position /it#int#e sort order. (or e&ampleA i' you set an automatic sort order o' "ameA TM1 inserts t#e ne/ elements into t#e dimension inalp#abetical order.

+rocedure

Rig#t)clic6 t#e dimension in t#e $erver %&plorer.1.

Clic6 Set /lements (rder .

T#e Dimension /lement (rdering dialog bo& opens.

2.

$elect a sort type.

Sort Tpe Description

utomatic %nables t#e utomatic $ort :y options; "ameA 8evelA and *ierarc#y.

Manual rders elements as t#ey currently e&ist in t#e dimension structure and sets t#edimension sorting property to Manual.

3.

I' you select t#e Manual sort typeA s6ip to step .-.

$elect an Automatic Sort @ option.

Sort @ Description

"ame $orts elements alp#abetically

8evel $orts elements by #ierarc#y level.

*ierarc#y $orts elements according to t#e dimension #ierarc#y.

0.

I' applicableA select a Sort Direction..

Clic6 (<..

'esults

You #ave no/ set t#e order o' t#e dimension elements. +#en you open t#e dimensionA you /ill see t#e elements in order

according to t#e Sort @ option you speci'ied in step 0.

+arent topic, $etting t#e rder o' %lements in a Dimension


398 25-09-20



-.$.-. Managing te Displa of /lements in te Dimension /ditorT#e Dimension %ditor includes several 'eatures t#at let you manage t#e /ay elements display. (or e&ampleA /#en you /or6

/it# large dimensions it mig#t be #elp'ul to display only t#e elements o' a certain #ierarc#y levelA or you mig#t /ant to vie/

t#e elements in alp#abetical order.

+#en you alter t#e display o' elements in t#e Dimension /ditor6 you do not c#ange t#e dimension structureA you simplyc#ange t#e /ay TM1 presents t#e elements in t#e /indo/.

T#e upcoming sections describe #o/ to manage t#e display o' elements in t#e Dimension %ditor.

<eeping /lements(ollo/ t#ese steps to display only t#e selected elements in t#e Dimension %ditor.

3iding /lements

(ollo/ t#ese steps to #ide selected elements in t#e Dimension %ditor.

Sorting /lements Alpabeticall

You can sort t#e elements in t#e Dimension %ditor in ascending or descending alp#abetical order.

Sorting /lements b Inde 9alue

You can sort t#e elements in t#e Dimension /ditor in ascending or descending order according to t#e inde& value.

Sorting /lements b 3ierarc

You can also sort elements as t#ey appear in t#e dimension #ierarc#y.

9ie!ing /lements b AliasI' you de'ined an alias attribute 'or a dimensionA you can vie/ t#e elements by t#eir aliases in t#e Dimension /ditor.



398 25-09-20



-.$.-.1. <eeping /lements(ollo/ t#ese steps to display only t#e selected elements in t#e Dimension %ditor.

+rocedure

$elect t#e elements you /ant to display.




1.

Clic6 /ditA <eep or clic6 <eep .

T#e Dimension /ditor displays only t#e elements you selected.

2.

+arent topic, Managing t#e Display o' %lements in t#e Dimension %ditor


398 25-09-20





-.$.-.-. Sorting /lements AlpabeticallYou can sort t#e elements in t#e Dimension %ditor in ascending or descending alp#abetical order.

Sort (rder Description

scending lp#abeticalClic6 /ditA Sort @A Ascending or clic6 Sort Ascending

Descending lp#abetical Clic6 /ditA Sort @A Descending or clic6 Sort Descending



398 25-09-20



-.$.-.8. Sorting /lements b Inde 9alueYou can sort t#e elements in t#e Dimension /ditor in ascending or descending order according to t#e inde& value.

Sort (rder Description

scending Inde& 5alueClic6 /ditA Sort @A Inde Ascending or clic6 Sort @ Inde6 Ascending

Descending Inde& 5alue Clic6 /ditA Sort @A Inde Descending or clic6 Sort @ Inde6 Descending



398 25-09-20





-.$.-.>. 9ie!ing /lements b AliasI' you de'ined an alias attribute 'or a dimensionA you can vie/ t#e elements by t#eir aliases in t#e Dimension /ditor.

T#e dimensions in t#e TM1 $ample Data directory #ave aliases de'ined 'or (renc# and ,ermanA so you can vie/ all elementnames by t#eir 'oreign language e9uivalents.

+rocedure

pen t#e Mont# dimension in t#e Dimension %ditor.1.

Clic6 9ie!A ToolbarsA Alias to display t#e Alias toolbar.

T#e Alias toolbar contains t/o ob!ects; a %se Aliases toggle button to turn t#e display o' aliases on or o''A and a Select

Alias list 'rom /#ic# you can select an alias.

2.

$elect Monat ?,erman 'or Mont#@ 'rom t#e Select Alias list.3.

Clic6 t#e %se Aliases button.-.

'esults

:y de'aultA TM1 does not display t#e aliases. T#e Dimension /ditor no/ displays all elements by t#eir ,erman aliases.



398 25-09-20



-.$.8. Creating Dimensions %sing Dimension 7or#seets dimension /or6s#eet is a modi'ied %&cel spreads#eet in /#ic# you list elements and #ierarc#ical relations#ips 'or one

dimension. TM1 saves t#e /or6s#eet data in t/o 'iles; dimension /or6s#eet ?dimname.&di@ and compiled 'ile

?dimname.dim@.

+#en you create a dimension using t#e Dimension %ditor /indo/ or TurboIntegratorA TM1 /rites only to t#edimname.dim ?compiled@ 'ile.

+#en you modi'y a dimension using t#e Dimension %ditorA TM1 saves your c#anges to t#e .dim 'ile. I' an .&di 'ile e&ists'or t#e dimensionA TM1 prompts you to save c#anges to t#e dimension /or6s#eet. I' you decline to update t#e dimension

/or6s#eetA t#e dimension structure in t#e .dim 'ile /ill di''er 'rom t#at in t#e .&di 'ile.

To ensure t#at TM1 #as access to all o' your dimension c#angesA create and maintain dimensions /it# dimension/or6s#eets or t#e Dimension %ditor. Do not mi& met#ods. T#is can lead to data loss.

<eeping &our Data Sncronied

TM1 saves t#e dimension /or6s#eet 'iles to t#e 'irst directory listed in t#e 8ocal $erver Data Directory 'ield in t#eptions dialog bo&. T#ere'oreA TM1 mig#t save your dimension /or6s#eet ?.&di@ to a di''erent directory t#an yourdimension 'ile ?.dim@.

Creating Dimension 7or#seets(ollo/ t#ese stesps to create a dimension using dimension /or6s#eets.

Filling (ut Dimension 7or#seets

T#e 'ollo/ing /or6s#eet de'ines t#e structure 'or a Mont# dimension.

Saving Dimension 7or#seets

To save t#e dimension /or6s#eet and compile t#e dimensionA clic6 TM1 A Dimension 7or#seetsA Save in %&cel. TM1updates t#e dimension /or6s#eet 'ile ?dimname.&di@ and creates t#e compiled dimension 'ile ?dimname.dim@.



398 25-09-20



-.$.8.1. <eeping &our Data SncroniedTM1 saves t#e dimension /or6s#eet 'iles to t#e 'irst directory listed in t#e 8ocal $erver Data Directory 'ield in t#e ptions

dialog bo&. T#ere'oreA TM1 mig#t save your dimension /or6s#eet ?.&di@ to a di''erent directory t#an your dimension 'ile

?.dim@.

*ote, :e very care'ul /#en editing dimensions using /or6s#eets. T#ere are several /ays in /#ic# data can be lost i' you do

not ta6e proper precautions. T#e 'ollo/ing e&amples s#o/ t/o /ays you can lose dimension data.

n MondayA you edit a dimension /or6s#eet 'or t#e ccount1 dimensionA and save t#e dimension. n TuesdayA anot#er

administrator uses t#e Dimension %ditor to ma6e c#anges to t#e dimension. T#e c#anges s#e ma6es are not propagatedto t#e dimension /or6s#eet 'ile. n +ednesdayA you ma6e anot#er c#ange to t#e dimension using t#e out)o')datedimension /or6s#eet. Your c#anges over/rite t#e c#anges made by t#e ot#er administrator.

T/o administrators decide to update a dimension on t#e same server using t/o di''erent dimension /or6s#eets. T#is isvery dangerous. TM1 can over/rite t#e c#anges very easily. Use one set of dimension worksheets. Try to avoid having

more than one .xdi file for any dimension.

To avoid con'usion and possible data lossA use precautions /#en editing dimension /or6s#eets. +e recommend using one o' t#e 'ollo/ing procedures.

Use t#e remote server data directory to store t#e dimension /or6s#eets.

Use a special directory to store your dimension /or6s#eets.

%sing te 'emote Server Data Director

To edit t#e dimension /or6s#eets in t#e server data directory on t#e remote serverA 'ollo/ t#ese steps.%sing a 7or#seet Director:y using a special /or6s#eet directoryA you can s#arply restrict access to your dimension /or6s#eets. T#is can be veryuse'ul in security)conscious installations. To set up a /or6s#eet directoryA 'ollo/ t#ese steps.

+arent topic, Creating Dimensions Using Dimension +or6s#eets


398 25-09-20



-.$.8.1.1. %sing te 'emote Server Data DirectorTo edit t#e dimension /or6s#eets in t#e server data directory on t#e remote serverA 'ollo/ t#ese steps.

+rocedure

$et t#e 8ocal $erver Data Directory in t#e (ptions dialog bo& to t#e data directory used by your remote I:M CognosTM1 server .

1.

Turn o'' t#e option Connect to 8ocal $erver on $tartup.2.

5eri'y t#at any local servers running on your computer are s#ut do/n.3.

8og in to t#e remote TM1 server .-.

Ma6e all o' t#e modi'ications to your dimensions using t#e /or6s#eet 'iles in t#e remote server data directory.0.

Clic6 TM1 A Dimension 7or#seetsA Save in %&cel.

TM1 /rites bot# t#e .dim 'ile and t#e .&di 'ile to t#e remote server data directory.

.

+arent topic, 4eeping Your Data $ync#roni7ed


398 25-09-20



-.$.8.1.$. %sing a 7or#seet Director:y using a special /or6s#eet directoryA you can s#arply restrict access to your dimension /or6s#eets. T#is can be very use'ul

in security)conscious installations. To set up a /or6s#eet directoryA 'ollo/ t#ese steps.

+rocedure

Create a /or6s#eet directory some/#ere on your 'ile system.1.

Move all o' your /or6s#eet 'iles ?.&di 'or dimensionsA and .&ru 'or rules@ to t#e /or6s#eet directory.2.

$et t#e 8ocal $erver Data Directory in t#e (ptions dialog bo& to t#e /or6s#eet directory.3.

Connect to t#e remote server t#at contains t#e dimension you /ant to updateA and any ot#er servers you /ant.-.

Ma6e all o' t#e modi'ications to your dimensions using t#e /or6s#eet 'iles in t#e /or6s#eet directory.0.

Clic6 TM1 A Dimension 7or#seetsA Save in %&cel.

T#e Select Server *ame dialog bo& opens.

.

$elect t#e server on /#ic# you /ant to save t#e compiled dimension..

Clic6 (<.<.

+arent topic, 4eeping Your Data $ync#roni7ed


398 25-09-20







-.$.8.-.1. Defining Simple /lements:egin 'illing out t#e dimension /or6s#eet by de'ining t#e dimensions simple ?lea')level@ elementsA starting in ro/ 1.

+rocedure

In column A speci'y t#e element type.

(or numeric elementsA type *.

(or string elementsA type S.

In t#e e&ampleA all elements are numeric.

1.

In column :A type t#e name o' an element.2.

+arent topic, (illing ut Dimension +or6s#eets


398 25-09-20





-.$.8.-.-. 7eigting /lements in a ConsolidationUse column C to /eig#t t#e elements in a consolidation. To calculate t#e ,ross MarginA 'or e&ampleA you subtract 5ariable

Costs 'rom $ales. To e&press t#is calculationA assign t#e /eig#t )1 to t#e 5ariable Costs element in t#e consolidation. T#e

'ollo/ing /or6s#eet s#o/s t#e /eig#ting in t#e ccount1 dimension.

+arent topic, (illing ut Dimension +or6s#eets


398 25-09-20







-.$.=.1. Configuring *amed 2evelsUse t#e *ierarc#yroperties control cube to con'igure named levels.

(or more details about t#e *ierarc#yroperties control cubeA see t#e section about control cubes in t#e I:M Cognos TM1Operation Guide

+rocedure

In TM1 rc#itectA clic6 t#e9ie! menu and select Displa Control (b)ects.1.

In t#e navigation paneA clic6 to e&pand t#e Cubes node.2.Double)clic6 t#e B3ierarc+roperties control cube.

T#e *ierarc#yroperties control cube opens.

3.

Clic6 t#e title dimension list to select t#e dimension 'or /#ic# you /ant to assign named levels.-.

In t#e defaultMember cellA enter an e&isting element name to set as t#e de'ault member 'or t#is dimension.

T#e element name you enter #ere may 'ilter t#e dimension /#en TM1 data is retrieved 'rom an e&ternal application li6eI:M Cognos Report $tudio.

%nter t#e name o' t#e top element in t#e dimension #ierarc#y so all t#e dimension elements are retrieved by de'ault.

(or e&ampleA set +orld as t#e de'ault member 'or t#e Region dimension.

0.

In t#e level000 to level0$0 cellsA enter your o/n custom name 'or eac# #ierarc#y level t#at e&ists in t#e dimension.

*ote, "amed levels are limited to a lengt# o' 200 single)byte c#aracters. (or detailsA see $tring 8engt# 8imit 'or "amed8evels.

.

'ter con'iguring named levelsA you must do one o' t#e 'ollo/ing to apply t#e c#anges;

Restart t#e I:M Cognos TM1 server A or

Run t#e RefreshMdxHierarchy 'unction in a TurboIntegrator process. (or detailsA see Using t#e Re'res#Md&*ierarc#y

TurboIntegrator (unction /it# "amed 8evels.

.

'esults

*ote, C#anges to element names or dimension structure are not automatically detected by t#e named levels 'eature. I' your

dimension c#angesA you must 'irst manually update t#e named level assignments in t#e *ierarc#yroperties control cube

and t#en eit#er restart t#e TM1 server or run t#e RefreshMdxHierarchyTurboIntegrator 'unction to update t#e MDE#ierarc#ies in t#e TM1 server .

+arent topic, Using "amed *ierarc#y 8evels /it# TM1 Dimensions


398 25-09-20







-.-. Creating CubesYou can al/ays create cubes on your local server. You must be t#e TM1 administrator to create cubes on remote servers.

T#ere are t/o /ays to create cubes;

/mpt Cube ) $elect 'rom a list o' e&isting dimensions in t#e Creating Cube /indo/ to create a ne/ cube /it# nodata.

/ternal Data Sources ) Use TurboIntegrator to identi'y and map dimensions and data 'rom an e&ternal data sourcesto a ne/ or e&isting cube.

T#is section documents creating cubes in t#e Creating Cube /indo/. (or in'ormation about creating cubes inTurboIntegratorA see t#e I:M Cognos TM1 TurboIntegrator Guide.

(rdering Dimensions in a Cube

Dimensions in a cube #ave an order t#at you select /#en you create a cube. T#e order you select can a''ect systemper'ormanceA so you s#ould give some consideration to t#e order o' dimensions be'ore creating a cube.

Creating a Cube

(ollo/ t#ese steps to create a cube.

(ptimiing te (rder of Dimensions in a CubeI' youre not e&tremely 'amiliar /it# your business dataA its possible to speci'y an order o' dimensions during cubecreation t#at results in less t#an optimal per'ormance. $imilarlyA its possible 'or t#e distribution o' data in a cube toc#ange over timeA ma6ing t#e order o' dimensions speci'ied during cube creation less t#an ideal. To address t#ese

issuesA TM1 includes a 'eature t#at lets you optimi7e t#e order o' dimensions in a cubeA t#ereby consuming less memoryand improving per'ormance.

/diting Cube +ropertiesTM1 allo/s you to set cube properties t#at speci'y measures and time dimensions used by 8% D: 'or 8 applicationsAand t#at determine /#et#er a cube loads automatically or on demand. UsuallyA you set t#ese cube properties /#en youcreate a cubeA but you can edit t#e properties any time.



398 25-09-20



-.-.1. (rdering Dimensions in a CubeDimensions in a cube #ave an order t#at you select /#en you create a cube. T#e order you select can a''ect system

per'ormanceA so you s#ould give some consideration to t#e order o' dimensions be'ore creating a cube.

s a 'irst step to/ard ordering dimensionsA divide t#e dimensions into t/o groups; sparse and dense dimensions. densedimension #as a #ig# percentage o' values 'or its elements. You can estimate t#e density by ans/ering t#is 9uestion; I' oneelement in t#e dimension #as a valueA 6eeping t#e elements o' t#e ot#er dimensions constantA /#at is t#e probability t#att#e ot#er elements in t#e dimension #ave valuesL

(or e&ampleA i' you #ave a budget in Fanuary 'or a given account and regionA you probably also #ave a value 'or t#eremaining mont#s. T#ere'oreA t#e Mont# dimension is probably dense. $imilarlyA i' you #ave a budget value 'or a givenmont#A accountA and regionA you probably also #ave an actual valueA ma6ing ct5s:ud a dense dimension.

*o/everA in a /orld/ide sales cubeA you probably do not sell every product in every region. T#ere'oreA you /ould treatroduct and Region as sparse dimensions.

+e generally recommend t#at you order t#e dimensions as 'ollo/s; smallest sparse to largest sparseA 'ollo/ed by smallestdense to largest dense. *o/everA some 'le&ibility is re9uired. (or e&ampleA it is probably better to put a very smallA densedimension suc# as ct5s:ud t#at #as only t/o or t#ree elements be'ore a very large but sparse dimensionA suc# as roductA/#ic# mig#t #ave t#ousands o' elements.

+arent topic, Creating Cubes


398 25-09-20



-.-.$. Creating a Cube(ollo/ t#ese steps to create a cube.

+rocedure

pen t#e $erver %&plorer.1.

In t#e Tree paneA select Cubes beneat# t#e server on /#ic# you /ant to create t#e cube.2.

Clic6 CubesA Create *e! Cube.

T#e Creating Cube dialog bo& opens. T#e Available Dimensions bo& on t#e le't lists t#e dimensions stored on t#eserver.

3.

Type a cube name in t#e Cube *ame 'ield.

*ote, I' you do not type a nameA TM1 names t#e ne/ cube %nnamed.

-.

In t#e Available Dimensions bo&A double)clic6 t#e name o' t#e dimension you /ant to use as t#e first dimension in t#ene/ cube.

T#e dimension name moves to t#e Dimensions in ne! cube bo&.

You can also use t#e button to move selected names 'rom t#e Available Dimensions bo& to t#e Dimensions in

ne! cube bo&. To select multiple ad!acent namesA clic6 and drag across t#e names. To select multiple non)ad!acentnamesA #old do/n CRT8A and clic6 eac# name.

0.

Repeat t#e selection process 'or all t#e dimensions you /ant to include in t#e ne/ cube. You must select at least t/odimensions. T#e ma&imum number o' dimensions is 20.

.

Using t#e up and do/n arro/sA rearrange t#e dimensions i' necessary. To remove a dimension 'rom t#e listAdouble)clic6 t#e dimension name.

.

I' you /ant to speci'y t#e cube propertiesA clic6 +roperties. I' you do not /ant to assign cube propertiesA s6ip to step13.

T#e Cube +roperties dialog bo& opens.

(rom #ereA you can set a Measures and Time dimension 'or t#e cubeA and speci'y i' t#e cube is loaded automatically oron demand.

*ote, 8% D: 'or 8 clients may include provisions 'or re'erencing Measures and Time dimensions. TM1 does notre'erence Measures and Time dimensionsA but does allo/ you to set t#ese properties 'or ot#er 8 clients t#at may

access t#e cube.

<.

To set a Measures dimensionA select a dimension 'rom t#e Measures Dimension list.B.

To set a Time dimensionA select a dimension 'rom t#e Time Dimension list.1.

$peci'y #o/ to load t#e cube;

To load t#e cube into server memory only /#en a client re9uests cube dataA select t#e 2oad (n Demand bo&.

To automatically load t#e cube into memory /#en t#e server startsA clear t#e 2oad (n Demand bo&.

11.

Clic6 (< to save t#e properties and return to t#e Creating Cube dialog bo&.12.

Clic6 Create Cube to create t#e cube.

T#e $erver %&plorer /indo/ opens. T#e ne/ cube displays in alp#abetical order in t#e Cubes list in t#e Tree pane.

13.



398 25-09-20



-.-.-. (ptimiing te (rder of Dimensions in a CubeI' youre not e&tremely 'amiliar /it# your business dataA its possible to speci'y an order o' dimensions during cube creation

t#at results in less t#an optimal per'ormance. $imilarlyA its possible 'or t#e distribution o' data in a cube to c#ange over

timeA ma6ing t#e order o' dimensions speci'ied during cube creation less t#an ideal. To address t#ese issuesA TM1 includes a

'eature t#at lets you optimi7e t#e order o' dimensions in a cubeA t#ereby consuming less memory and improving

per'ormance.

+#en you optimi7e t#e order o' dimensions in a cubeA TM1 does not c#ange t#e actual order o' dimensions in t#e cubestructure. TM1 does c#ange t#e /ay dimensions are ordered internally on t#e serverA but because t#e cube structure is not

c#angedA any rulesA 'unctionsA or applications re'erencing t#e cube remain valid.

s you c#ange t#e order o' dimensionsA you can instantly vie/ a report detailing t#e impact your c#anges #ave on cubememory consumption.

(or t#e 'ollo/ing reasonsA you s#ould optimi7e t#e order o' dimensions in a cube only in a development environment /#ileyou are trying to determine optimal cube con'iguration;

$igni'icant memory resources are re9uired 'or t#e I:M Cognos TM1 server to recon'igure t#e order o' dimensions in acube. During t#e re)ordering processA t#e temporary RM on t#e TM1 server increases by a 'actor o' t/o 'or t#e cubet#at you are re)ordering. (or e&ampleA a 0 M: cube re9uires 1 M: o' RM to recon'igure.

Re)ordering puts a read loc6 on t#e serverA loc6ing all user re9uests /#ile t#e re)order is per'ormed.

*ote, You must be a member o' t#e DMI" group to optimi7e t#e order o' dimensions in cubes. T#e optimi7ation option is

only available 'or cubes on remote serversJ you cannot optimi7e t#e order o' dimensions in cubes on a local server. lsoA

/#en you optimi7e t#e order o' dimensions in a cubeA you s#ould not move t#e string dimensions from t#e last positionA normove t#e string dimensions to t#e last position.

+rocedure

In t#e Tree pane o' t#e $erver %&plorerA select t#e cube you /ant to optimi7e.1.

Clic6 CubeA 'e"order Dimensions.

T#e Cube (ptimier dialog bo& opens.

2.

$elect a dimension in t#e *e! (rder of Dimensions list bo&.3.

Clic6 t#e up or do/n arro/s to c#ange t#e order o' t#e dimension in t#e cube.-.

Clic6 Test.

"ote t#e value ne&t to t#e ercent C#ange label. I' t#is value is negativeA t#e ne/ order o' dimensions consumes lessmemory and is t#ere'ore more e''icient.

0.

Repeat steps 3 t#roug# 0 until you ac#ieve t#e most e''icient ordering o' dimensions..

Clic6 (<..



398 25-09-20







-.-.8.$. /diting te 2oad on Demand +ropert:y de'aultA TM1 loads all cubes into memory /#en a server starts. +#ile t#is allo/s 'ast access to TM1 dataA it can consume

signi'icant server resources. I' your server contains in're9uently accessed cubesA you can conserve resources by setting

t#ose cubes to load only /#en a client attempts to access t#e cube data.

+rocedure

$elect t#e cube in t#e Tree pane o' t#e $erver %&plorer.1.

Clic6 CubeA +roperties.

T#e Cube +roperties dialog bo& opens.

2.

$peci'y #o/ to load t#e cube t#e cube;

$elect t#e 2oad (n Demand bo& to load t#e cube on demand.

Clear t#e 2oad (n Demand bo& to automatically load t#e cube /#en t#e server starts.

3.

Clic6 (<.-.

+arent topic, %diting Cube roperties


398 25-09-20



-.8. Creating +ic# 2ists pic6 list is a list o' valid values 'or a speci'ic element or cube cell. +#en an administrator de'ines a pic6 list 'or an element

or a cellA a drop)do/n menu containing t#e de'ined values is available in t#e speci'ied cell /#en bro/sing a cube in any o'

t#e TM1 clients.

5alues in cells containing a pic6 list are validatedJ a user must select one o' t#e prede'ined values 'or t#e cell. I' a userattempts to enter a value t#at is not valid 'or t#e cellA an error appears indicating t#at only values 'rom t#e pic6 list can beentered in t#e cell.

+ic# 2ist %sage *otesYou s#ould be a/are o' t#e 'ollo/ing re9uirements and be#aviors /#en using pic6 lists.

+ic# 2ist Tpes

You can create t#ree types o' pic6 lists; staticA subsetA and dimension.

Creating +ic# 2ists !it /lement Attributes

T#e easiest /ay to create a pic6 list is to de'ine a te&t attribute named ic6list 'or a dimension. You can t#en speci'y t#emembers o' a pic6 list 'or eac# element /it#in t#e dimensionA using any o' t#e pic6 list types described above. +#en anelement #as a pic6 list de'inedA any cube cell identi'ied by t#at element displays a drop)do/n list containing t#e pic6 listvalues.

Creating +ic# 2ists !it Control Cubes

You can also create pic6 lists /it# control cubes. T#is gives you greater control over /#ic# cube cells s#ould contain pic6lists and allo/s greater 'le&ibility in de'ining pic6 lists 'or individual cells. You can also create rules 'or t#e pic6 list controlcubeA /#ic# allo/s you to de'ine pic6 lists 'or any section o' a cubeA 'rom a single cell to t#e entire cube.

*ull 9alues in +ic# 2istsll pic6 lists in TM1 +eb ?bot# +ebs#eets and t#e Cube 5ie/er@ al/ays contain a null value t#at a user can select. T#enull value is automatically inserted into all pic6 lists in TM1 +ebJ it does not #ave to be e&plicitly de'ined.

+ic# 2ist (rder of +recedence

+#en multiple pic6 lists apply to an individual cube cellA t#e 'ollo/ing order o' precedence is used to determine /#ic#pic6 list is used in t#e cell;



398 25-09-20





-.8.$. +ic# 2ist TpesYou can create t#ree types o' pic6 lists; staticA subsetA and dimension.

Static +ic# 2ists

static pic6 list is composed o' a comma)delimited list o' values using t#e synta&static:value1:value2:value3:value4.

Subset +ic# 2ists

subset pic6 list contains values corresponding to all elements o' a named subset. I' t#e members o' t#e subset c#angeA

t#e values available in t#e pic6 list c#ange correspondingly.

Dimension +ic# 2ists

dimension pic6 list contains values corresponding to all elements o' a dimension. I' t#e members o' t#e dimensionc#angeA t#e values available in t#e pic6 list c#ange correspondingly.

+arent topic, Creating ic6 8ists


398 25-09-20



-.8.$.1. Static +ic# 2ists static pic6 list is composed o' a comma)delimited list o' values using t#e synta& static:value1:value2:value3:value4.

(or e&ampleA static:red:orange:yellow:green results in a pic6 list containing t#e values redA orangeA yello/A and green.

To include a null value in a static pic6 listA include t/o consecutive colons /it#out intervening c#aracters in t#e pic6 listde'inition. (or e&ampleA static:value1:value2:value3:value4:: results in a pic6 list /it# a null value at t#e end.

+arent topic, ic6 8ist Types


398 25-09-20



-.8.$.$. Subset +ic# 2ists subset pic6 list contains values corresponding to all elements o' a named subset. I' t#e members o' t#e subset c#angeA t#e

values available in t#e pic6 list c#ange correspondingly.

subset pic6 list is de'ined using t#e synta& subset:dimension_name:subset_name.

(or e&ampleA subset:Products:Winter results in a pic6 list containing all elements 'rom t#e +inter subset o' t#e roducts

dimension.



398 25-09-20



-.8.$.-. Dimension +ic# 2ists dimension pic6 list contains values corresponding to all elements o' a dimension. I' t#e members o' t#e dimension c#angeA

t#e values available in t#e pic6 list c#ange correspondingly.

dimension pic6 list is de'ined using t#e synta& dimension:dimension_name.

(or e&ampleA dimension:Months results in a pic6 list containing all elements 'rom t#e Mont#s dimension.



398 25-09-20



-.8.-. Creating +ic# 2ists !it /lement AttributesT#e easiest /ay to create a pic6 list is to de'ine a te&t attribute named ic6list 'or a dimension. You can t#en speci'y t#e

members o' a pic6 list 'or eac# element /it#in t#e dimensionA using any o' t#e pic6 list types described above. +#en an

element #as a pic6 list de'inedA any cube cell identi'ied by t#at element displays a drop)do/n list containing t#e pic6 list

values.

+rocedure

In t#e $erver %&plorerA rig#t)clic6 t#e dimension 'or /#ic# you /ant to de'ine pic6 listsA t#en clic6 /dit /lement

Attributes.

1.

In t#e ttributes %ditorA clic6 /ditA Add *e! Attribute.2.

In t#e "e/ ttribute dialog bo&A enter ic6list as t#e attribute name.3.

$elect Tet as t#e attribute type.-.

Clic6 (<.

T#e ttributes %ditor no/ contains a ne/ column titled ic6list.

0.

(or eac# element 'or /#ic# you /ant to create a pic6 listA enter a valid pic6 list de'inition at t#e intersection o' t#eelement name and t#e ic6list column.

To enter a static pic6 listA enter a comma)delimited list o' values using t#e synta&static:value1:value2:value3:value4.

a.

To enter a subset pic6 listA enter t#e pic6 list de'inition using t#e synta& subset:dimension_name:subset_name.b.

To enter a a dimension pic6 listA enter t#e pic6 list de'inition using t#e synta& dimension:dimension_name.c.

.

Clic6 (< to close t#e ttributes %ditor and save t#e pic6 list de'initions..



398 25-09-20



-.8.8. Creating +ic# 2ists !it Control CubesYou can also create pic6 lists /it# control cubes. T#is gives you greater control over /#ic# cube cells s#ould contain pic6 lists

and allo/s greater 'le&ibility in de'ining pic6 lists 'or individual cells. You can also create rules 'or t#e pic6 list control cubeA

/#ic# allo/s you to de'ine pic6 lists 'or any section o' a cubeA 'rom a single cell to t#e entire cube.

pic6 list control cube is composed o' t#e same dimensions as t#e regular cube it is associated /it#A along /it# anadditional dimension named ic6list. T#e ic6list dimension contains a single string elementA named 5alue.

Creating a +ic# 2ist Control Cube

Use t#is procedure to create a pic6 list control cube.

Defining +ic# 2ists for Individual Cells in a Control Cube

(ollo/ t#ese steps to de'ine pic6 lists 'or individual cells in a control cube. T#e pic6 lists de'ined in t#e control cube areused to display pic6 list values in t#e associated regular cube.

%sing 'ules to Define +ic# 2ists In a Control Cube

Rules t#at de'ine pic6 lists 'ollo/ t#e same conventions as all ot#er TM1 rules. s /it# ot#er TM1 rulesA a rule statementt#at de'ines a pic6 list must include an area de'inition ?t#e portion o' t#e cube to /#ic# t#e rule applies@A a string9uali'ierA and a 'ormula. In t#e case o' pic6 list rulesA t#e 'ormula is simply t#e pic6 list de'inition t#at you /ant to apply.

/cluding Cells from +ic# 2ists

T#ere may be some circumstances /#en you do not /ant an individual cell or a speci'ic area o' a cube to use pic6 lists.To prevent a cell 'rom displaying a pic6 listA enter none in t#e appropriate pic6 list control cube cell or use (’none’) as

t#e 'ormula in a rules statement. (or e&ampleA [’season’]=S:(’none’);.



398 25-09-20



-.8.8.1. Creating a +ic# 2ist Control CubeUse t#is procedure to create a pic6 list control cube.

+rocedure

In t#e $erver %&plorerA rig#t)clic6 t#e regular cube 'or /#ic# you /ant to create a pic6 list control cubeA t#en Create +ic#

2ist Cube.

ne/ control cube is createdA using t#e naming convention ic6list]cubename. (or e&ampleA /#en you create a pic6 listcontrol cube 'or t#e rders cubeA t#e control cube is named ic6list]rders.

*ote, I' you cannot vie/ control cubes in t#e $erver %&plorerA clic6 9ie!A Displa Control (b)ects to enable t#e display o'

control cubes and ot#er control ob!ects.

+arent topic, Creating ic6 8ists /it# Control Cubes


398 25-09-20



-.8.8.$. Defining +ic# 2ists for Individual Cells in a Control Cube(ollo/ t#ese steps to de'ine pic6 lists 'or individual cells in a control cube. T#e pic6 lists de'ined in t#e control cube are used

to display pic6 list values in t#e associated regular cube.

+rocedure

Double)clic6 t#e control cube in t#e $erver %&plorer.

T#e control cube opens in t#e Cube 5ie/er.

1.

Con'igure t#e vie/ o' t#e control cube as necessary to vie/ t#e cells 'or /#ic# you /ant do de'ine pic6 lists. (or detailson con'iguring cube vie/sA see +or6ing /it# Cube 5ie/s in t#e I:M Cognos TM1 User Guide.

2.

In eac# cell 'or /#ic# you /ant to create a pic6 listA enter a pic6 list de'inition. You can enter any o' t#e pic6 list types int#e control cube; staticA subsetA or dimension.

3.

Clic6 FileA 'ecalculate to recalculate t#e cube vie/.-.



398 25-09-20



-.8.8.-. %sing 'ules to Define +ic# 2ists In a Control CubeRules t#at de'ine pic6 lists 'ollo/ t#e same conventions as all ot#er TM1 rules. s /it# ot#er TM1 rulesA a rule statement t#at

de'ines a pic6 list must include an area de'inition ?t#e portion o' t#e cube to /#ic# t#e rule applies@A a string 9uali'ierA and a

'ormula. In t#e case o' pic6 list rulesA t#e 'ormula is simply t#e pic6 list de'inition t#at you /ant to apply.

lso as in all ot#er TM1 rulesA /#en multiple rule statements apply to overlapping areasA t#e statements s#ould be ordered'rom most restrictive area to least restrictive area.

(or more in'ormation on creating rulesA including details on speci'ying an area de'initionA please see t#e I:M Cognos TM1

Rules Guide.

+rocedure

In t#e $erver %&plorerA rig#t)clic6 t#e ic6list control cube 'or /#ic# you /ant to create a ruleA t#en clic6 Create 'ule.

T#e Rules %ditor opens.

1.

Using a standard rules area de'initionA speci'y t#e cells you /ant t#e pic6 list to appear in.2.

Immediately a'ter t#e area de'initionA type =S:. T#is is t#e string 9uali'ierA indicating t#at t#e rule applies to string cells.3.

Immediately a'ter t#e string 9uali'ierA enter a pic6 list de'initionA enclosed in single 9uotesA t#en enclosed in parent#eses.(or e&ampleA ('static:spring:summer:winter:fall').

-.

Immediately a'ter t#e pic6 list de'initionA type a semi)colon ?J@ to terminate t#e rule statement.

Using t#e procedure described in t#ese steps s#ould result in a rule statement similar to t#e 'ollo/ing e&ampleA /#ic#indicates t#at an cell identi'ied by t#e 'abric element /ill display a static pic6 list containing t#e values /oolA cottonA sil6Aand nylon.

['fabric']=S:('static:wool:cotton:silk:nylon');

0.

(ter +ic# 2ist 'ules /amples

T#e 'ollo/ing e&amples illustrate rules statements t#at de'ine pic6 lists.



398 25-09-20



-.8.8.-.1. (ter +ic# 2ist 'ules /amplesT#e 'ollo/ing e&amples illustrate rules statements t#at de'ine pic6 lists.

'ule statement Description

['size','shirts']=S:('static:16:17:18'); T#is rule statement indicates t#at any cell identi'ied by t#e elements

sie and sirts /ill display a static pic6 list composed o' t#e values

1A 1A an 1<.

['size',{'sweaters','vests','jackets'}]=S:('static:XS:S:M:L:XL');

T#is rule statement indicates t#at any cell identi'ied by t#e element

sie and any o' t#e elements s!eatersA vestsA or )ac#ets /ill displaya static pic6 list composed o' t#e values E$A $A MA 8A and E8.

['fabric']=S:('dimension:materials'); T#is rule statement indicates t#at any cell identi'ied by t#e element

fabric /ill display a pic6 list composed o' all elements in t#e materials

dimension.

+arent topic, Using Rules to De'ine ic6 8ists In a Control Cube


398 25-09-20



-.8.8.8. /cluding Cells from +ic# 2istsT#ere may be some circumstances /#en you do not /ant an individual cell or a speci'ic area o' a cube to use pic6 lists. To

prevent a cell 'rom displaying a pic6 listA enter none in t#e appropriate pic6 list control cube cell or use (’none’) as t#e

'ormula in a rules statement. (or e&ampleA [’season’]=S:(’none’);.



398 25-09-20



-.8.=. *ull 9alues in +ic# 2istsll pic6 lists in TM1 +eb ?bot# +ebs#eets and t#e Cube 5ie/er@ al/ays contain a null value t#at a user can select. T#e null

value is automatically inserted into all pic6 lists in TM1 +ebJ it does not #ave to be e&plicitly de'ined.

ic6 lists in TM1 rc#itect and TM1 erspectives only contain a null value i' t#e pic6 list is a static type and a null value #asbeen e&plicitly de'ined 'or t#e pic6 list. Dimension pic6 lists and subset pic6 lists can never contain a null value /#en used inTM1 rc#itect and TM1 erspectives .

Selecting *ull 9alues in +ic# 2ists

T#ere are t/o /ays to select null values 'rom pic6 lists.+arent topic, Creating ic6 8ists


398 25-09-20



-.8.=.1. Selecting *ull 9alues in +ic# 2istsT#ere are t/o /ays to select null values 'rom pic6 lists.

+rocedure

In any o' t#e TM1 clientsA you can clic6 t#e pic6 list and t#en clic6 t#e null value.

Important, In TM1 erspectives slices and ctive (ormsA do not clic6 t#e null value in a string cell. T#is /ill delete t#eD:R+ 'ormula 'rom t#e cell and you /ill no longer be able to retrieve data 'or t#at cell 'rom t#e I:M Cognos TM1 server. You can sa'ely clic6 t#e null value in numeric cells.

1.

In TM1 +eb and rc#itectA you can press t#e Delete 6ey in a cell containing a pic6 list to select t#e null value.

Important, Do not press Delete to select a null value in TM1 erspectives slices or ctive (orms. T#is /ill delete t#eD:R+ 'ormula 'rom t#e cell and you /ill no longer be able to retrieve data 'or t#at cell 'rom t#e TM1 server .

2.

+arent topic, "ull 5alues in ic6 8ists


398 25-09-20



-.8.>. +ic# 2ist (rder of +recedence+#en multiple pic6 lists apply to an individual cube cellA t#e 'ollo/ing order o' precedence is used to determine /#ic# pic6

list is used in t#e cell;

I' a pic6 list control cube e&ists and contains a pic6 list de'inition 'or t#e current cube cellA t#e de'inition in t#e pic6 listcontrol cube is used.

I' a pic6 list control cube does not e&istA t#e elements t#at identi'y t#e current cell are e&amined in reverse order in asearc# 'or ic6list element attributes. T#e 'irst ic6list element attribute t#at is encountered in t#is searc# is used in t#ecell.



398 25-09-20



-.=. 'eplicating Cubes bet!een ServersUsing t#e TM1H Replication 'eatureA you can copy cubes and ot#er associated ob!ects 'rom a remote server to your local

serverA or bet/een t/o remote servers. You can also sync#roni7e t#e data updates among t#e copied cubes eit#er at

speci'ied time intervals or on demand.

Replication o''ers t#e 'ollo/ing advantages;

%n#ances response time because you can update a cube locally /it#out communicating across a net/or6.

8ets you copy t#e latest s#ared data to a laptop 'or presentations outside o' your organi7ation.

TM1 provides bi)directional sync#roni7ation 'or replicated data. During t#e sync#roni7ation processA TM1 c#ec6s t#e serversinvolved in a replication 'or t#e latest updates to t#e dataA and t#en copies t#e latest updates to t#e ot#er servers.

Replication creates a relations#ip bet/een t/o cubes and bet/een t/o servers. T#ese relations#ips are described in CubeRelations#ips.

Cube 'elationsipsReplication creates a relations#ip bet/een t/o cubes;

Server 'elationsips

:e'ore replicating a cubeA you need to log on to a remote server and create a replication connection. Replication createsa relations#ip bet/een t/o servers;



398 25-09-20



-.=.1. Cube 'elationsipsReplication creates a relations#ip bet/een t/o cubes;

!ource cube ) T#e original cube in a replication

"irror cube ) copy o' t#e source cube

Depending on your access privilegesA you can replicate a single cube on many di''erent serversA and you can replicate areplicated cube.

+arent topic, Replicating Cubes bet/een $ervers


398 25-09-20



-.=.$. Server 'elationsips:e'ore replicating a cubeA you need to log on to a remote server and create a replication connection. Replication creates a

relations#ip bet/een t/o servers;

!ource server ) T#e remote server you log in to

Target server ) T#e server you logged in from

T#e $erver %&plorer /indo/ lists t#e current replication connections beneat# t#e Replications icon. In t#is e&ampleA regions1 is t#e target server and sales is a source server.

'euired Access +rivileges

T#e 'ollo/ing access privileges are re9uired to replicate a cube;

+arent topic, Replicating Cubes bet/een $ervers


398 25-09-20



-.=.$.1. 'euired Access +rivilegesT#e 'ollo/ing access privileges are re9uired to replicate a cube;

Your security group must #ave Read access or #ig#er to t#e cube you /ant to replicate.

You must be t#e TM1 administrator on t#e target server. n your local serverA you are al/ays t#e TM1 administrator.

+arent topic, $erver Relations#ips


398 25-09-20



8. Advanced Calculations for @usiness DataT#is section describes #o/ to create drill)t#roug# processes and rulesA /#ic# enable you to lin6 t#e cells /it# related data

to provide t#e details or conte&t 'or cube values.

(or a t#oroug# e&amination o' rules in a business scenarioA see t#e I:MH CognosH TM1H Rules Guide. T#e guide contains atutorial t#at steps you t#roug# developing rules in a business environment.

*ote, T#e images o' t#e Rules %ditor in t#is section s#o/ t#e old Rules %ditor. To see images o' t#e ne/ Rules %ditorA see t#e

I:M Cognos TM1 Rules Guide.

Depending on your plat'ormA some o' t#e supplied e&ample data may not be available to all users.

(vervie! of Cube 'ules

T#e most common calculations in 8 applications involves aggregating data along a dimension. In TM1 A you createt#ese calculations by using consolidation #ierarc#ies. (or e&ampleA in a Mont# dimensionA you can de'ine a 9uarterly totalt#at sums t#e FanuaryA (ebruary and Marc# values.

Guidelines for 7riting TM1 'ules StatementsT#e general 'ormat o' a rules statement is;

'ules /ditor and 'ules 7or#seets

You can create rules t#roug# t/o inter'aces;

'ules and Dimension ConsolidationsRules /or6 in concert /it# consolidations you de'ine in dimensions. lt#oug# you can de'ine consolidations using rulesA

t#is is not recommended 'or per'ormance reasons. Consolidations de'ined in dimensions are calculated muc# more9uic6ly t#an rules)derived valuesA especially in very largeA sparse cubes.

Sample Applications

T#is section contains e&amples o' commonly used rules applications. %&amine t#ese e&amples to develop anunderstanding o' t#e synta& and scope o' rules.

Creating Drill"Troug +rocesses and 'ules

You can create a drill process and drill rules to associate a cell /it# more detailed data. T#is data can provide underlyingdetail 'or t#e cellA or ot#er in'ormation relevant to t#e cell.

Debugging 'ules

TM1 provides a tool called t#e Rules Tracer to assist in t#e development and debugging o' rules. T#eRules Tracer'unctionality is available only in t#eCube 5ie/er.


398 25-09-20



8.1. (vervie! of Cube 'ulesT#e most common calculations in 8 applications involves aggregating data along a dimension. In TM1H A you create

t#ese calculations by using consolidation #ierarc#ies. (or e&ampleA in a Mont# dimensionA you can de'ine a 9uarterly total

t#at sums t#e FanuaryA (ebruary and Marc# values.

In many applicationsA you need to per'orm calculations t#at do not involve aggregatingA suc# as cost allocations ande&c#ange translations. +it# cube rulesA you can create 'ormulas to per'orm t#ese calculations.

+it# cube rulesA you can per'orm t#e 'ollo/ing tas6s;

Multiply prices by units to yield t#e sales amounts.

verride consolidations /#en necessary. (or e&ampleA you can prevent a 9uarterly price 'rom displaying a tally o' individual mont#ly prices.

Use data in one cube to per'orm calculations in anot#er cubeA or s#are data bet/een cubes. (or e&ampleA you can pullsales data into a cube t#at contains ro'it and 8oss in'ormation.

ssign t#e same values to multiple cells.

*ote, You must be a member o' t#e DMI" group to create or edit TM1 rules.

You associate a cube rule /it# an individual cube. +#en you create a ruleA TM1 stores t#e rule in'ormation in t/o 'iles;

cube#name .ru ) $tores t#e compiled rules. +#en you load a cube 'or /#ic# you #ave de'ined rules into memoryA TM1searc#es 'or t#e cubes .ru& 'ile in t#e data directory containing t#e cube.

cube#name .blb ) $tores t#e 'ormat in'ormation 'or t#e Rules %ditor.

*ote, I' you /ant to edit a .ru& 'ile in a te&t editor ot#er t#an t#e Rules %ditorA be sure to delete t#e corresponding .blb 'ile.

I' you do not delete t#e 'ileA t#ere /ill be a discrepancy bet/een t#e contents o' t#e .ru& 'ile and t#e display in t#e Rules

%ditorA as t#e .blb 'ile determines t#e display in t#e Rules %ditor.

+arent topic, dvanced Calculations 'or :usiness Data


398 25-09-20



8.$. Guidelines for 7riting TM1 'ules StatementsT#e general 'ormat o' a rules statement is;

[Area]=Formula;

9ariable Description

Area $peci'ies t#e portion o' a cube a''ected by t#e rule.

Formula Describes #o/ TM1H calculates t#e cells in t#e cube area.

To restrict a rule to simple values in t#e rea;

[Area]= N:>Formula;

To restrict a rule to consolidated values in t#e rea;

[Area]=C:>Formula;

General Considerations

Snta for Describing te Area

T#e rea identi'ies one or more cells in a cube.

Snta for Formulas

rules 'ormula is an e&pression composed o';

%sing Cube 'eferencesll rules 'ormulas contain cube re'erencesA /#ic# point to areas /it#in a cube 'or data. T#e cube re'erences can point tot#e cube 'or /#ic# you are /riting a rule ?internal cube re'erences@ or to areas /it#in ot#er cubes ?e&ternal cubere'erences@.

Arranging 'ules Statements+#en more t#an one statement in a rule applies to t#e same reaA t#e 'irst statement ta6es precedence.

Specifing Different 'ules at te *, and C, 2evels

It is o'ten necessary to di''erentiate t#e /ay C; level and "; level cells /it#in an area are treated.

@passing 'ules

:y using t#e $T%T 'unctionA you can bypass t#e e''ect o' a rules statement 'or speci'ic areas o' a cube.

ualifing /lement *ames+#en you /ant to limit a rules statement to values identi'ied by an element t#at appears in multiple dimensionsA 9uali'yt#e element name /it# its dimension name using t#e 'ollo/ing synta&;



398 25-09-20



8.$.1. General Considerations

T#e synta& is not case)sensitive. You can use bot# uppercase and lo/ercase letters.

You can use spaces /it#in rules to improve clarity.

rules statement can occupy one or more lines in t#e Rules %ditor. statement can also contain one or more 'ormulas.

You must end eac# statement /it# a semicolon ?J@.

To add comments and to e&clude statements 'rom processingA insert a number sign ?^@ at t#e beginning o' a line or

statement. (or e&ample;#

The following rule is not active

# ['Gross Margin']=['Sales']*0.53;

+arent topic, ,uidelines 'or +riting TM1 Rules $tatements


398 25-09-20



8.$.$. Snta for Describing te AreaT#e rea identi'ies one or more cells in a cube.

Consider t#e 'ollo/ing guidelines /#en you create an rea de'inition.

$peci'y no dimension elementsA or one or more dimension elements.

%ac# element must be 'rom a di''erent dimension o' t#e cube.

%nclose eac# element in single 9uotes.

Use commas to separate eac# element.

%nclose t#e entire rea de'inition in brac6ets.

T#e 'ollo/ing table s#o/s 'our rea e&amples. %ac# successive e&ample narro/s t#e scope.

Sample Area Scope

X W ll cells in t#e cube.

XFanuaryW ll cells identi'ied by a Fanuary element.

X$alesAFanuaryW ll cells identi'ied by t#e $ales and Fanuary elements.

X,ermanyA$alesAFanuaryW ll cells identi'ied by t#e ,ermanyA $alesA and Fanuary elements.

%sing Subsets in an Area Definition

You can use a subset in place o' a single element in an rea de'inition by enclosing all subset members in curly braces.

%sing Special Caracters and *on"uniue /lement *ames in an Area Definition

You can use t#e synta& dimensionname;elementname in a rules rea de'inition to speci'y elements t#at are not uni9ueto a single dimensionA or 'or dimension names t#at contain special c#aracters.



f 398 25-09-20



8.$.$.1. %sing Subsets in an Area DefinitionYou can use a subset in place o' a single element in an rea de'inition by enclosing all subset members in curly braces.

(or e&ampleA t#e 'ollo/ing rea de'inition applies a rule to all cube cells identi'ied by t#e element $ales and t#e elementFanuaryA (ebruaryA or Marc#;

['Sales', {'January', 'February', 'March'}] =

+arent topic, $ynta& 'or Describing t#e rea


f 398 25-09-20



8.$.$.$. %sing Special Caracters and *on"uniue /lement *ames in an AreaDefinitionYou can use t#e synta& dimensionname;elementname in a rules rea de'inition to speci'y elements t#at are not uni9ue to

a single dimensionA or 'or dimension names t#at contain special c#aracters.

(or e&ampleA

['Units','Mar','}Groups':'ADMIN']

allo/s you to /rite a rule 'or t#e ,roups dimensionA /#ic# contains t#e curly brace ?@ special c#aracter.

$imilarlyA

['Units','Mar', 'Region':'North America']

lets you /rite a rule /#en t#e element "ort# merica is not uni9ue to t#e Region dimension.

+arent topic, $ynta& 'or Describing t#e rea


f 398 25-09-20





8.$.-.1. *umeric ConstantsT#e simplest components o' rules 'ormulas are numeric constants.

Consists o' numeralsA an optional leading minus sign ?)@A and an optional decimal point. (or e&ampleA 0.A A )0. $omee&amples o' invalid numeric constants are; 1)A 1A 3..-.

Contains a ma&imum lengt# o' 2 c#aracters.

You can use scienti'ic notation to enter a numeric constant.

(or e&ampleA t#e 'ollo/ing rules statement assigns t#e value 2 to all cells in t#e cube.

[ ] = 200;

+arent topic, $ynta& 'or (ormulas


f 398 25-09-20



8.$.-.$. Aritmetic (peratorsYou can combine numeric constants /it# t#e 'ollo/ing arit#metic operators.

(perator Meaning

\ ?lus sign@ ddition

) ?Minus sign@ $ubtraction

Q ?steris6@ Multiplication

?(or/ard slas#@ Division ) returns an unde'ined value and displays " in t#e vie/

K ?:ac6slas#@ _ero Display Division ) same as Division operatorA but returns 7ero/#en you divide by 7ero.

V ?Caret@ %&ponentiation

TM1H evaluates arit#metic operators in t#e 'ollo/ing order;

%&ponentiation

Multiplication

Division

ddition

$ubtraction

Use parent#eses to 'orce a di''erent order o' evaluation. (or e&ampleA t#e e&pression 2Q3\- produces t#e same result as?2Q3@\- because multiplication ta6es precedence over addition. T#e result is 1. *o/everA i' you /ant to per'orm t#eaddition 'irstA re/rite t#e 'ormula as 2Q?3\-@. T#e result c#anges 'rom 1 to 1-.



f 398 25-09-20



8.$.-.-. %sing Conditional 2ogicUse t#e I( 'unction to include conditional logic in rules. T#e general 'ormat is;

IF(test, value1, value2)

T#e I( 'unction returns one o' t/o values depending on t#e result o' a logical test.

+#en t#e e&pression Test is trueA t#e I( 'unction returns 5alue1.

+#en t#e e&pression Test is 'alseA t#e I( 'unction returns 5alue2.

T#e data type returned by an I( 'unction is determined by t#e data types o' 5alue1 and 5alue2.

5alue1 and 5alue2 must be t#e same data typeA eit#er string or numeric.

n I( 'unction /#ere 5alue1 is a string and 5alue2 is a number yields an error statement.

You can also nest I( statements;

IF(test1, value1, IF (test2, value2, value3))

T#e 'ollo/ing table s#o/s t/o I( e&amples.

/pression 'esult

I( ?OA1A@ yields 1

I( ?OA TrueA (alse@ yields True



f 398 25-09-20



8.$.-.8. %sing Comparison (peratorsYou can compare numbers /it# t#e 'ollo/ing operators.

(perator Meaning

O ,reater t#an

N 8ess t#an

O ,reater t#an or e9ual to

N 8ess t#an or e9ual to

%9ual to

NO "ot e9ual to

To compare t/o string valuesA insert t#e symbol be'ore t#e comparison operatorA as s#o/n in t#e 'ollo/ing e&ample;

IF ('A'@='B',0,1) yields the number 1.

You can combine logical e&pressions /it# logical operators.

(perator Meaning /ample

` ?mpersand@ "D ?5alue1 O 0@ ̀ ?5alue1 N 1@

Returns TRU% i' t#e value is greater t#an 0 and less t#an 1.

> ?ercent sign@ R ?5alue1 O 1@ > ?5alue1 N 0@

Returns TRU% i' t#e value is greater t#an 1 or less t#an 0.

S ?Tilde@ "T S?5alue1 O 0@

%9uivalent to ?5alue1 N 0@

You can concatenate strings using t#e pipe ?P@ c#aracter.

(or e&ampleA t#e 'ollo/ing e&pressions returns R#eingold.

(Rhein | gold)

I' t#e string resulting 'rom a concatenation is longer t#an 20- bytesA TM1H returns an error.



f 398 25-09-20



8.$.8. %sing Cube 'eferencesll rules 'ormulas contain cube re'erencesA /#ic# point to areas /it#in a cube 'or data. T#e cube re'erences can point to t#e

cube 'or /#ic# you are /riting a rule ?internal cube re'erences@ or to areas /it#in ot#er cubes ?e&ternal cube re'erences@.

Internal Cube 'eferencesInternal cube re'erences use t#e same synta& as t#e area 'or /#ic# you /rite t#e rule. %&amples include;

/ternal Cube 'eferences

Use t#e D: 'unction to point to e&ternal cubes.



f 398 25-09-20





8.$.8.$. /ternal Cube 'eferencesUse t#e D: 'unction to point to e&ternal cubes.

DB('cube', dimension1, dimension2,...dimensionn)

Argument Description

cube "ame o' t#e e&ternal cube.

dimension ne o' t#e 'ollo/ing arguments;

T#e name o' an element in a dimension o' t#e e&ternal cubeA enclosed in single9uotes.

T#e name o' a dimension preceded by an e&clamation mar6 ?@A /#ic# is calledvariable notation. n argument using variable notation returns t#e current dimensionelement in t#e cell to /#ic# a rule statement applies. (or e&ampleA in a rules)calculated cell t#at is identi'ied by t#e ,ermany element o' t#e Region dimensionARegion returns ,ermany.

n e&pression t#at resolves to an element name.

$peci'y a dimension argument 'or eac# dimension o' t#e e&ternal cube. You must order t#e dimension arguments tocorrespond to t#e order o' t#e dimensions in t#e e&ternal cube.

In t#e 'ollo/ing rules statementA all $ales values in t#e internal cube are computed by multiplying Units in t#e internal cubeby t#e values in t#e e&ternal riceTab cube;

['Sales']=['Units']*DB('PriceTab',!Region,!Product,!Month)

T#e riceTab cube contains only prices. %ac# o' its cells is identi'ied by an element in t#ree dimensions; RegionA roductAMont#. T#e internal cube contains t#ese dimensions and at least one ot#er dimension t#at #as bot# t#e $ales and Unitselements.

%very $ales cell in t#e internal cube is identi'ied by $ales and elements in t#e t#ree dimensions t#e internal cube s#ares/it# t#e riceTab cube. To populate any $ales cellA TM1H pulls a riceTab value located at t#e intersection o' t#ecorresponding elements in t#e s#ared dimensions.

T#e e&ternal cube can di''er 'rom t#e internal cube in terms o' t#e number o' dimensions and t#e number o' elementsalong eac# dimension. *o/everA a dimension you re'erence as a variable ?as in Region or roduct@ must at leastcontain all t#e elements 'ound in t#e internal cubes corresponding dimension.

+arent topic, Using Cube Re'erences


f 398 25-09-20



8.$.=. Arranging 'ules Statements+#en more t#an one statement in a rule applies to t#e same reaA t#e 'irst statement ta6es precedence.

Consider t#is e&ample. cube named riority #as t/o dimensionsA Region and Year. T#e rule #as 'our statements;

['Germany', 'Year1'] = 10;['Year1'] = 5;['United States']

= 6;[ ] = 2;

*ere are sample values 'or t#e riority cubeA all o' /#ic# are derived by t#e preceding rule.

'egion &ear 1 &ear $ &ear -

(rance 0 2 2

,ermany 1 2 2

United $tates 0

TM1H processes t#e rule statements as 'ollo/s;

T#e 'irst statement assigns t#e value 1 to t#e ,ermanyA Year1 cell. T#e 'irst statement ta6es precedence over t#esecond statementA /#ic# speci'ies t#at all Year1 cells contain 0.

T#e second statement ta6es precedence over t#e t#ird statement. T#ere'oreA t#e cell 'or United $tatesA Year 1 contains0A even t#oug# t#e t#ird statement speci'ies t#at all values 'or United $tates s#ould be .

T#e last statement X W 2 speci'ies t#at all values in t#e cube contain t#e value 2. T#is rule applies to all cells t#at arenot a''ected by preceding statementsA suc# as t#e cell (ranceA Year2.



f 398 25-09-20



8.$.>. Specifing Different 'ules at te *, and C, 2evelsIt is o'ten necessary to di''erentiate t#e /ay C; level and "; level cells /it#in an area are treated.

*, 2evel Cells ) Identi'ied only by simple elements.

C, 2evel Cells ) Identi'ied by at least one consolidated element.

Use t#e 'ollo/ing synta& to /rite a rules statement t#at applies only to "; level cells in an area;

[Area] = N:[Formula];

(or e&ample;

['Sales'] = N:['Price']*['Units']\1000;

Use t#e 'ollo/ing synta& to /rite a rules statement t#at applies only to C; level cells in an area.

[Area] = C:[Formula];

(or e&ample;

['Price'] = C:['Sales']\['Units']*1000;

+#en a speci'ic area o' a cube is calculated di''erently at t#e C; and "; levelsA you can use t#e 'ollo/ing synta&;

[Area] = N:[Formula A]; C:[Formula B];

(or e&ample;

['Price'] =

N:DB('PriceCube', !Actvsbud, !Region, !Model, !Month);

C:['Sales']\['Units']*1000;



f 398 25-09-20



8.$.?. @passing 'ules:y using t#e $T%T 'unctionA you can bypass t#e e''ect o' a rules statement 'or speci'ic areas o' a cube.

(or e&ampleA you mig#t /ant to /rite a rules statement 'or ,ross Margin t#at applies to all regions e&cept (rance. You can/rite t#e general rule and t#e e&ception in t/o /ays.

+rite t#e $T%T statement 'irst 'ollo/ed by t#e general statement;

['Gross

Margin', 'France'] = STET;

['Gross Margin'] = ['Sales'] * 0.53;

+rite one rules statement t#at includes an I( 'unction;

['Gross

Margin'] = IF(!Region @= 'France', STET, ['Sales']

* 0.53);



f 398 25-09-20



8.$.E. ualifing /lement *ames+#en you /ant to limit a rules statement to values identi'ied by an element t#at appears in multiple dimensionsA 9uali'y t#e

element name /it# its dimension name using t#e 'ollo/ing synta&;

['dimname':'element']

(or e&ampleA i' Total occurs in bot# t#e Region and roduct dimensions and you /ant t#e rule limited to cells identi'ied byTotal in t#e Region dimensionA speci'y;

['Region':'Total']=



f 398 25-09-20



8.-. 'ules /ditor and 'ules 7or#seetsYou can create rules t#roug# t/o inter'aces;

Rules %ditor ) ll previous e&amples in t#is section use t#is inter'ace.

Rules /or6s#eet ) modi'ied %&cel /or6s#eet in /#ic# you type rules statements 'or one cube in column .

TM1H saves t#e rules in t/o 'iles;

cube .ru ) Rules /or6s#eet

cube .ru ) Compiled 'ile

*ote, You can modi'y t#e rules you create t#roug# t#e rules /or6s#eets by using t#e Rules %ditor. +#en you do soA TM1

prompts you to save t#e c#anges to t#e /or6s#eet. I' you do not save t#e c#angesA t#e .&ru and .ru& 'iles /ill be out o'

sync. T#ere'oreA you cannot subse9uently modi'y t#e c#anges by editing t#e rules /or6s#eet. ll rules described in t#at

section apply to t#e rules /or6s#eets as /ell as t#e dimension /or6s#eets.

To ensure t#at TM1 #as access to all o' your c#angesA use one o' t#e inter'aces e&clusively 'or creating and maintainingrules.

Creating 'ules 7or#seets

+#en you use a rules /or6s#eet to create a rule on either a local or remote I:MH CognosH TM1 serverA your TM1 clientmust #ave a valid directory set in t#e 8ocal $erver Data Directory bo& in t#e TM1 ptions dialog bo&. T#e directory is t#elocation /#ere your TM1 client saves t#e rules /or6s#eets ?.&ru 'iles@.

Saving 'ules 7or#seets

To save t#e rule in a 'ormat t#at TM1 can useA clic6 TM1 A 'ule 7or#SeetsA Save in %&cel.



f 398 25-09-20



8.-.1. Creating 'ules 7or#seets+#en you use a rules /or6s#eet to create a rule on either a local or remote I:MH CognosH TM1H serverA your TM1 client

must #ave a valid directory set in t#e 8ocal $erver Data Directory bo& in t#e TM1 ptions dialog bo&. T#e directory is t#e

location /#ere your TM1 client saves t#e rules /or6s#eets ?.&ru 'iles@.

*ote, I' you do not set a directoryA or i' t#e directory is not validA TM1 cannot save your rules /or6s#eets.

+rocedure

Clic6 TM1 A 'ule 7or#seetsA *e! in %&cel.

T#e $elect Cube 'or Rules dialog bo& opens. T#e list contains t#e cubes on your local server and any servers you #avelogged in to during t#e current TM1 session.

1.

$elect a cube and clic6 (<.

TM1 displays a blan6 rules /or6s#eet t#at loo6s li6e ot#er %&cel /or6s#eetsA e&cept t#e 'irst column #as a /idt# o' 1.

2.

lace eac# rule statement on a separate line in column A as in t#e 'ollo/ing e&ample.

['Gross Margin%']=['Gross Margin']\['Sales']*100;

['Price']=N:DB('PriceCube',!actvsbud,!region,!model,!month);


['Sales']=N:['Price']*['Units']\1000;

You can clic6 TM1 A /dit Formula to access t#e TM1 /dit Formula dialog bo&. T#is dialog bo&A /#ic# #elps youconstruct accurate rules statementsA provides all o' t#e 'unctionality 'ound in t#e Rules %ditor. T#e Rules %ditor isdescribed later in t#is section.

3.

+arent topic, Rules %ditor and Rules +or6s#eets


f 398 25-09-20



8.-.$. Saving 'ules 7or#seetsTo save t#e rule in a 'ormat t#at TM1H can useA clic6 TM1 A 'ule 7or#SeetsA Save in %&cel.

T#e Save option updates t#e rule /or6s#eet 'ile ?cube.&ru@ and creates a compiled rules 'ile ?cube.ru&@. TM1 saves t#e .&ru'ile in your local server data directoryA and saves t#e .ru& 'ile in t#e data directory 'or t#e I:MH CognosH TM1 server . TM1immediately applies t#e ne/ rules to t#e cube.

*ote, I' you clic6 FileA Save in %&celA only t#e cube.&ru 'ile is updated. To use t#e ne/ rule in a cubeA you must create t#e

compiled rules 'ile.

+arent topic, Rules %ditor and Rules +or6s#eets


f 398 25-09-20





8.8.1. (rder of CalculationRules ta6e precedence over consolidations /it#in dimensions.

+#en TM1H calculates a cube cell and a consolidation by a ruleA TM1 e&amines t#e rules statement 'irst. *o/everA i' t#erules statement re'ers to t#e cells t#at are t#e result o' consolidationsA TM1 'irst per'orms t#e consolidation and t#encalculates t#e rules statement using t#e results.

ConverselyA i' you de'ine a cell by consolidation onlyA TM1 loo6s at t#e values needed to per'orm t#e consolidation. +#ensome values are t#e result o' calculation rulesA TM1 t#en per'orms t#e rules calculation be'ore per'orming t#e consolidation.

+arent topic, Rules and Dimension Consolidations


f 398 25-09-20



8.8.$. (verriding C, 2evel /lements !it 'ulesYou s#ould avoid /riting a rule t#at overrides a consolidated value t#at is a component o' anot#er consolidation.

simple e&ample illustrates t#is issue. $uppose you #ave a t/o)dimensional cube named $ales t#at is composed o' t#edimensions roduct and Mont#A /it# product ?Total@ and 9uarterly ?1 =uarter@ consolidations de'ined.

To calculate t#e grand total ?TotalA 1 =uarter@A TM1H can consolidate t#e product totals 'or eac# mont# or consolidate9uarterly totals 'or eac# product.

$uppose 'urt#er t#at you /rite a rule t#at calculates a value 'or Total product sales in FanA and t#at t#e rules)calculatedvalue does not sum t#e individual product values 'or Fan. rule t#at de'ines t#e value o' Total products in Fan as BBB servesas an illustration.

['Jan','Total']=999;

I' t#e grand total is calculated by consolidating t#e product totals 'or eac# mont#A t#e value /ill di''er 'rom t#e consolidationo' t#e 9uarterly totals 'or eac# product. T#is is because t#e rules)calculated value 'or total product sales in Fan overrides t#enatural consolidation de'ined in t#e roduct dimension.

You #ave no control over t#e order in /#ic# TM1 per'orms dimension consolidations. (urt#ermoreA depending on /#ic#consolidation pat# is optimal at any given momentA TM1 may alternate bet/een pat#s. Conse9uentlyA you may re9uest t#eTotalA 1 =uarter value t/ice in the same session and get di''erent results.

You can remedy t#is situation by /riting a rules statement t#at calculates t#e value o' t#e TotalA 1 =uarter consolidation ast#e sum o' its immediate c#ildren along t#e Mont# dimensionA t#ereby overriding t#e roduct dimension consolidation. T#estatement XTotalWConsolidateC#ildren?Mont#@ per'orms t#is calculation.

*o/everA t#ere remains an implicit inconsistency /#en vie/ing t#e cube; t#e sum o' t#e 9uarterly totals 'or eac# product isdi''erent 'rom t#e sum o' product total 'or eac# mont#. T#usA overriding C; level values t#at are components o' ot#erconsolidations is not recommended.


f 398 25-09-20





f 398 25-09-20



8.8.-. Stac#ing 'ules rules statement can re'er to a cell in a cube t#at is de'ined by ot#er rules statements. TM1H stac6s t#ese rules statements

until it can obtain a 'inal valueA and t#en /or6s bac6 to return a result. T#e number o' levels o' stac6ing t#at TM1 can

accommodate is limited only by t#e available memory.

I' a circular re'erence occurs /it#in a rules stac6A or t#e ma&imum level o' stac6ing is e&ceededA TM1 displays t#e errormessage;

Error Evaluating Rule: Possible Circular Reference

*ere is an e&ample o' a circular re'erence;

['Sales'] = ['Units'] * ['Price'] ;

['Price'] = ['Sales'] / ['Units'] ;



f 398 25-09-20



8.=. Sample ApplicationsT#is section contains e&amples o' commonly used rules applications. %&amine t#ese e&amples to develop an understanding

o' t#e synta& and scope o' rules.

Calculating 'atiosIn t#e 'ollo/ing e&ampleA a rule calculates t#e ,ross Margin as a percentage o' t#e $ales in t#e $alesCube cube. Youassociate t#is ratio /it# t#e ,ross Margin>A a ne/ numeric element in t#e ccount1 dimension.

Saring Data @et!een Cubes

T#e $alesCube cube does not contain price data. T#e price in'ormation 'or t#is cube is stored in a separate'our)dimensional cube called riceCube.

'estricting 'ules to Simple 9aluesIn t#e previous e&erciseA you created a rule t#at applies to all cells containing sales numbers. T#is type o' rulesupersedes consolidations /it#in dimensionsA producing incorrect results. In t#e 'ollo/ing e&erciseA you inspect a9uarterly total t#roug# a slice /or6s#eetA and restrict t#e $alesCube rule to simple valuesA t#ereby allo/ingconsolidations to 'unction properly.

Calculating an Average +rice

%&amine t#e riceA 1=uarter value in t#e Test /or6s#eet. T#is number is t#e sum o' t#e prices 'or FanuaryA (ebruaryA andMarc#. *o/everA t#e number should re'lect t#e average price 'or t#e t#ree mont#s. T#e 'ollo/ing rules statement yieldst#e desired value;

2in#ing T!o Asmmetrical CubesMost companies do not brea6 out over#ead costs by product belo/ t#e ,ross Margin line. T#ese numbersA suc# as rentand utilitiesA are available only on a regional or divisional basis. In ot#er /ordsA t#e structure o' t#e cost numbers are notsymmetrical /it# t#e sales numbers. T#ere'ore you /ould normally store t#e data in separate cubes.



f 398 25-09-20



8.=.1. Calculating 'atiosIn t#e 'ollo/ing e&ampleA a rule calculates t#e ,ross Margin as a percentage o' t#e $ales in t#e $alesCube cube. You

associate t#is ratio /it# t#e ,ross Margin>A a ne/ numeric element in t#e ccount1 dimension.

(irstA you need to create t#e ,ross Margin> element.

Creating te Margin /lement

I' your $alesCube dimension already contains t#e ,rossMargin elementA s6ip to t#e ne&t section. (ollo/ t#ese steps i' you need to add t#e element ,rossMargin> to t#e ccount1 dimension.

Creating te Margin 'ule

(olllo/ t#ese steps to create t#e ,ross Margin> 'ormula.

%nderstanding te Generated 'ule8ets e&amine t#e components o' t#e ne/ rules statement.

@ro!sing te Gross Margin 9alues

T#e sample vie/ salesmargin> no/ displays t#e calculated values 'or ,rossMargin>.

+arent topic, $ample pplications


f 398 25-09-20





8.=.1.$. Creating te Margin 'ule(olllo/ t#ese steps to create t#e ,ross Margin> 'ormula.

+rocedure

In t#e $erver %&plorerA rig#t)clic6 Sales Cube. I' t#e rule already e&istsA clic6 /dit 'ule. I' you #ave not yet created t#eruleA clic6 Create 'ule.


1.

Clic6 Area .

T#e Re'erence to Cube dialog bo& displays t#e dimensions o' t#e $alesCube cube.

2.

Clic6 Account1.

T#e $ubset %ditor /indo/ opens.

3.

In t#e le't paneA select Gross Margin and clic6 (<.

T#e Re'erence to Cube dialog bo& reopens.

-.

Clic6 (<.

T#e Rules %ditor displays X,ross Margin>W in t#e entry 'ield.

0.

Clic6 /ual ..

Clic6 Area againA and clic6 Account1..

In t#e Subset /ditor /indo/A select Gross Margin and clic6 (<.<.

Clic6 (< in t#e 'eference to Cube dialog bo&.B.

Clic6 ero Displa Division .

TM1H places a division sign a'ter X,ross MarginW.

"ote t#at t#ere are t/o division buttons in t#e Rules %ditor.

Division (perator ) I' you use t#is division operator in a rule t#at results in division by 7eroA TM1 returns anunde'ined valueA and displays " in t#e vie/.

ero Displa Division (perator ) I' you use t#is division operator in a rule t#at results in division by 7eroA TM1returns t#e value .

1.

Clic6 Area againA and clic6 Account111.

In t#e Subset /ditor /indo/A select Sales and clic6 (<.12.

Clic6 (< in t#e 'eference to Cube dialog bo&.13.

Clic6 Multiplication .1-.

Type 100 at t#e end o' t#e 'ormula.10.

Clic6 Semicolon .

*ote, You must end all rules statements /it# a semicolon.

T#e complete rule s#ould no/ appear as 'ollo/s.

['Gross Margin%']*['Gross Margin']\['Sales']*100;

1.

Clic6 Save.1.

'esults

TM1 saves t#e rule and applies it to t#e cube. ne/ Rule ob!ect opens beneat# t#e $alesCube cube. rule al/ays bears t#e

same name as t#e cube /it# /#ic# it is associated.

+arent topic, Calculating Ratios


f 398 25-09-20



8.=.1.-. %nderstanding te Generated 'ule8ets e&amine t#e components o' t#e ne/ rules statement.

Area ) $peci'ies t#e cube area t#at TM1H calculates. In t#is e&ampleA t#e ,ross Margin> element identi'ies all cellvalues derived t#roug# a rule.

Formula ) De'ines t#e calculation.

Terminator ) Terminates all rules statements /it# a semicolon ?J@.

(or more in'ormation about rules synta&A see t#e I:MH CognosH TM1 Rules Guide.



f 398 25-09-20



8.=.1.8. @ro!sing te Gross Margin 9aluesT#e sample vie/ salesmargin> no/ displays t#e calculated values 'or ,rossMargin>.

+rocedure

In t#e Server /plorer /indo/A clic6 t#e 9ie!s icon 'or t#e $alesCube cube.1.

Double)clic6 t#e vie/ salesmargin.

T#e vie/ opens in t#e Cube 9ie!er.

T#e values 'or ,ross Margin>A /#ic# are derived t#roug# t#e rule you !ust createdA appear in t#e vie/.

2.



f 398 25-09-20



8.=.$. Saring Data @et!een CubesT#e $alesCube cube does not contain price data. T#e price in'ormation 'or t#is cube is stored in a separate 'our)dimensional

cube called riceCube.

You can s#are values bet/een cubes by using t#e D: rules 'unction. 5alues are stored in one cube and re'erenced in ot#ercubes. T#e 'ollo/ing e&ample s#o/s #o/ rules 'or one cube can re'erence values in a separate cube.

+rocedure

In t#e Server /plorerA double)clic6 t#e SalesCube rule.

T#e 'ules /ditor opens.

1.

osition t#e cursor on t#e second entry line.2.

Clic6 Area .

T#e Re'erence to Cube dialog bo& displays t#e dimensions o' t#e $alesCube cube.

3.

Clic6 Account1.


-.

In t#e le't paneA select +rice and clic6 (<.

T#e Re'erence to Cube dialog bo& reopens.

0.

Clic6 (<.

T#e Rules %ditor displays XriceW in t#e entry 'ield.

.

Clic6 /ual ..

Clic6 Database 'eference .

T#e $elect Cube dialog bo& opens.

<.

$elect +riceCube and clic6 (<.

T#e Re'erence to Cube dialog bo& displays t#e dimensions o' t#e riceCube cube.

B.

Clic6 (<.

T#e 'ollo/ing 'ormula opens in t#e 'ules /ditor.

['Price']=DB('PriceCube',!Actvsbud,!Region,!Model,!Month)

Read t#e 'ormula as 'ollo/s; ny cell in t#e $alesCube cube t#at is identi'ied by t#e rice element ta6es its value 'rom acell in t#e riceCube cube. T#e location o' t#e riceCube cell is 'ound at t#e intersection o' corresponding elements in t#e'our dimensions t#at riceCube s#ares /it# $alesCube.

(or e&ampleA t#e $alesCube cell identi'ied by t#e elements ctualA ,ermanyA $ $eries 1.< 8 $edanA riceA Fan ta6es itsvalue 'rom t#e riceCube cell identi'ied by t#e elements ctualA ,ermanyA $ $eries 1.< 8 $edanA Fan.

1.

Clic6 Semicolon to place a semicolon at t#e end o' t#e 'ormula.11.

Clic6 Save to save t#e rule.

You can no/ c#ange a price in t#e riceCube cube and see t#e c#ange re'lected in t#e $alesCube cube. *o/everA youcannot edit t#e prices in $alesCube because t#ey are derived t#roug# t#e rule you !ust created.

T#e sample vie/ $alesrice includes t#e price values.

To open t#e sample vie/ $alesrice;

12.

In t#e $erver %&plorer /indo/A clic6 t#e 9ie!s icon 'or t#e $alesCube cube.13.

Double)clic6 t#e vie/ SalesMargin.

T#e vie/ opens in t#e Cube 9ie!erA complete /it# t#e rice values pulled 'rom t#e riceCube cube.

1-.

Calculating Sales

In t#e previous e&erciseA you broug#t prices into t#e $alesCube cube. I' you c#ange a price in riceCubeA TM1H does notc#ange t#e corresponding sales value in $alesCube. T#is is because t#e sales values in $alesCube e&ist as data values int#e cube. You need to create a rule to derive t#e sales values in $alesCube 'rom t#e prices and units.


f 398 25-09-20





f 398 25-09-20



8.=.$.1. Calculating SalesIn t#e previous e&erciseA you broug#t prices into t#e $alesCube cube. I' you c#ange a price in riceCubeA TM1H does not

c#ange t#e corresponding sales value in $alesCube. T#is is because t#e sales values in $alesCube e&ist as data values in t#e

cube. You need to create a rule to derive t#e sales values in $alesCube 'rom t#e prices and units.

+rocedure

Reopen t#e 'ules /ditor 'or t#e $alesCube cube.1.

:eneat# t#e XriceW 'ormulaA enter t#e 'ollo/ing rule;

HSalesJKH+riceJLH%nitsJ1000N

*ote, ll values in t#e $alesCube cube are in t#ousands e&cept t#e rice valuesA /#ic# are actual numbers. :ecause$ales numbers s#ould remain in t#ousandsA you divide by 1 in t#e rules statement.

2.

Clic6 Save to save t#e $alesCube rule.3.

Reopen t#e sample Sales+rice vie/.

TM1 s#ades all cells identi'ied by t#e $ales elementA /#ic# indicates t#at t#e values in t#ese cells are derived t#roug#rules.

-.

C#ange t#e Fanuary units value to 1A by typing 10000 in t#e cell at t#e intersection o' Units and Fan.0.

ress FO to recalculate t#e cell values..

bserve t#e ne/ sales value 'or Fanuary.

"ote t#at t#e ,ross Margin> value 'or Fanuary updatesA as t#is value is derived t#roug# a ruleA /#ic# re'erences t#e$ales element.

.

Restore t#e value -1- to t#e cell at t#e intersection o' Fan and $ales.<.

+arent topic, $#aring Data :et/een Cubes


f 398 25-09-20



8.=.-. 'estricting 'ules to Simple 9aluesIn t#e previous e&erciseA you created a rule t#at applies to all cells containing sales numbers. T#is type o' rule supersedes

consolidations /it#in dimensionsA producing incorrect results. In t#e 'ollo/ing e&erciseA you inspect a 9uarterly total t#roug#

a slice /or6s#eetA and restrict t#e $alesCube rule to simple valuesA t#ereby allo/ing consolidations to 'unction properly.

+rocedure

pen t#e sample vie/ Sales1tr o' t#e $alesCube cube.1.

Clic6 Slice to slice t#e vie/ to an %&cel /or6s#eet.

T#e slice s#ould appear as 'ollo/s.

2.

$ave t#e slice /or6s#eet /it# t#e name Test.3.

%&amine t#e $ales value 'or 1=uarter in cell :1.

ccording to t#e $alesCube ruleA t#e value is t#e product o' multiplying t#e 'irst 9uarter price by a 'raction ?11@ o' 'irst 9uarter units. InsteadA t#e value s#ould be t#e consolidation o' sales 'or t#e 'irst t#ree mont#s. *o/everA t#e valuesderived by t#e $alesCube rule ?as it currently e&ists@ ta6e precedence over t#e values derived t#roug# consolidation. Tocorrect t#isA you need to modi'y t#e rule so t#at it does not calculate t#e values 'or consolidated elements.

-.

pen t#e SalesCube rule in t#e Rules %ditor.0.

n t#e t#ird lineA insert *, in 'ront o' XriceW so t#at t#e 'ormula reads;

['Sales']= N:>['Price']*['Units']\1000;

T#e restrictor "; limits t#e rule to t#e cells identi'ied only by simple elements. T#e rule no longer applies to consolidatedelementsA leaving consolidations to 'unction properly.

.

Clic6 Save to save t#e edited rule..

ress FO to recalculate t#e test /or6s#eet.

T#e correct value no/ opens at t#e intersection o' $ales and 1=uarter.

<.



f 398 25-09-20



8.=.8. Calculating an Average +rice%&amine t#e riceA 1=uarter value in t#e Test /or6s#eet. T#is number is t#e sum o' t#e prices 'or FanuaryA (ebruaryA and

Marc#. *o/everA t#e number should re'lect t#e average price 'or t#e t#ree mont#s. T#e 'ollo/ing rules statement yields t#e

desired value;

['Price']=C:['Sales']\['Units']*1000;

T#e restrictor C; limits t#is rules statement to consolidationsJ t#at isA only /#en one or more o' t#e elements t#at identi'y arice cell are consolidated elements.

+rocedure

Reopen t#e 'ules /ditor 'or t#e $alesCube cube.1.

%nter t#e 'ollo/ing statement /it#out t#e rea de'initionA as t#e t#ird line in t#e entry 'ield.

H+riceJKD@4+riceCube6Pactvsbud6Pregion6Pmodel6Pmont5NC,HSalesJH%nitsJL1000N

You omit t#e rea de'inition because you already de'ined t#e rice area in t#e second line. +#en you /ant to applydi''erent 'ormulas to t#e same reaA you de'ine t#e area and t#en speci'y t#e 'ormulas se9uentially.

2.

Clic6 Save to save t#e edited rule.3.

In t#e test /or6s#eetA press (B to recalculate and update t#e values.

bserve t#e riceA 1=uarter valueA /#ic# still displays t#e value A132.0B. T#is is because TM1H uses t#e first rules'ormula it encounters t#at applies to t#e riceA 1 =uarter cell;

['Price']=DB('PriceCube',!actvsbud,!region,!model,!month);

T#is statement is appropriate only 'or "; level cellsA suc# as riceA Fan. Consolidated rice values s#ould be calculatedt#roug# t#e second rice statement. :y restricting t#e 'irst rice 'ormula to "; level cells onlyA you enable TM1 to applyt#e second rice 'ormula to consolidations.

*ote, TM1 evaluates t#e rules statements in t#e order t#ey appear /it#in a ruleA but t#e 'irst 'ormula 'or a given reata6es precedence over later 'ormulas 'or t#e same area. I' you #ave multiple rules statements t#at address t#e samereaA you s#ould order t#em least)restrictive to most)restrictive. (or detailsA see rranging Rules $tatements.

-.

To restrict t#e 'irst rice 'ormula to "; level cellsA open t#e SalesCube rule in t#e 'ules /ditor.0.

Insert *, in 'ront o' t#e 'irst 'ormula portion o' t#e 'irst rice statement;

['Price']= N:>DB('PriceCube',!actvsbud,!region,!model,!month);

T#e entire rule 'or t#e rice area s#ould no/ appear as 'ollo/s;



.

Clic6 Save to save t#e rule..

In t#e Test /or6s#eetA press (B to recalculate and display t#e updated values.

ll rice values s#ould no/ re'lect t#e correct calculationsA /it# t#e 1 =uarterA rice value as an average o' t#e 'irst t#reemont#s o' t#e year.

<.



f 398 25-09-20



8.=.=. 2in#ing T!o Asmmetrical CubesMost companies do not brea6 out over#ead costs by product belo/ t#e ,ross Margin line. T#ese numbersA suc# as rent and

utilitiesA are available only on a regional or divisional basis. In ot#er /ordsA t#e structure o' t#e cost numbers are not

symmetrical /it# t#e sales numbers. T#ere'ore you /ould normally store t#e data in separate cubes.

T#e cost data t#at corresponds to t#e sales data in t#e $alesCube cube is available in t#e n8Cube cube. T#e t/o cubescompareA as 'ollo/s;

n8Cube #as 'our dimensions. T#e cost data is dimensioned by version ?actual versus budget@A regionA accountA andmont#.

$alesCube #as 'ive dimensions. T#e sales data is dimensioned by version ?actual versus budget@A regionA product?model@A accountA and mont#.

T#e t/o cubes s#are t#ree dimensions; RegionA ctvsbudA and Mont#.

Measures trac6ed in t#ese cubes are identi'ied by elements in di''erent dimensions. $alesCube uses t#e ccount1dimension. n8Cube uses t#e ccount2 dimension.

n8Cube #as no data 'or $ales or 5ariable Costs. T#ese values are already calculated in detail in $alesCube.

In t#e 'ollo/ing e&erciseA you /rite rules 'or t#e n8Cube t#at pulls t#e sales and variable costs data 'rom t#e $alesCube.

+rocedure

In t#e Server /plorer /indo/A rig#t)clic6 t#e +n2CubeA and clic6 Create 'ule.

T#e 'ules /ditor opens.

1.

%nter t/o statements to speci'y t#at t#e $ales and 5ariable Costs values in t#e n8Cube pull t#e corresponding values'rom t#e $alesCube.

n t#e 'irst line o' t#e entry 'ieldA create t#is $ales 'ormula;

['Sales']=DB('SalesCube', !Actvsbud,

!Region, 'Total',

'Sales', !Month);

n t#e second lineA create t#is 5ariable Costs 'ormula;

['Variable

Costs']=DB('SalesCube', !Actvsbud, !Region,

'Total', 'Variable Costs', !Month);

2.

Clic6 Save to save t#e rules.

*ote, "ote t#at t#e $ales and 5ariable Costs values no/ appear in t#e cube. T#e ,ross Margin values are also availablebecause you de'ined t#e ,ross Margin in t#e account2 dimension as t#e di''erence bet/een t#e $ales and 5ariableCosts.

3.

In Microso't %&celA open t#e sample /or6s#eet T!oCubes.

T#e T/oCubes /or6s#eet is set up to simultaneously pull numbers 'rom $alesCube and n8Cube. T#is /or6s#eetdemonstrates #o/ numbers can 'lo/ bet/een t#e t/o cubes.

8ets c#ange t#e Units number in cell : to a very large number so t#at you can see t#e e''ect o' t#e c#ange ripplet#roug# t#e /or6s#eet.

-.

Clic6 cell : and type 100000.0.

ress (B to recalculate t#e /or6s#eet.

"ote t#at t#e Units value 'or t#e $ $eries 2.0 8 $edan c#anges t#e $ales value 'or t#at model and 'or t#e model total.T#ese c#anges a''ect t#e $ales values o' t#e n8CubeA /#ic# ripples all t#e /ay do/n to t#e %arnings :e'ore Ta&es valuein t#e n8Cube.

*ote, ll t#e cell values in t#is /or6s#eet are t#e result o' re'erences to t/o cubesA $alesCube or n8Cube. T#e/or6s#eet does not calculate any o' t#e values.

.



f 398 25-09-20



8.>. Creating Drill"Troug +rocesses and 'ulesYou can create a drill process and drill rules to associate a cell /it# more detailed data. T#is data can provide underlying

detail 'or t#e cellA or ot#er in'ormation relevant to t#e cell.

TM1H drill) t#roug# consists o' t/o components.

Drill +rocess ) De'ines t#e detailed data you /ant to associate /it# a cell

Drill Assignment 'ule ) De'ines t#e relations#ip bet/een t#e cell and t#e detailed data

'ter you create a drill process and a drill assignment rule 'or a cubeA you can e&ecute t#e process and open t#e detaileddata in a ne/ /indo/A t#ereby drilling t#roug# to a ne/ level o' detail.

Creating a Drill +rocess

drill process is a TurboIntegrator process t#at de'ines t#e detailed dataA /#ic# opens in a ne/ /indo/. T#e cube 'rom/#ic# a drill)t#roug# originates is called t#e origination cube.

/diting Drill +rocesses

+#en you create a drill process /it# a Cube 5ie/ data sourceA TurboIntegrator inserts t#e 'unctionReturn5ie/*andle?CubeA5ie/@ above or belo/ t#e Generated Statements areaA /#ic# is located on t#e /pilog

subtab o' t#e Advanced tab in t#e TurboIntegrator /indo/.

Deleting Drill +rocesses

(ollo/ t#ese steps to delete a drill process.

Creating a Drill Assignment 'ule

drill assignment rule is t#e TM1 rule t#at lin6s cube cells /it# related detailed data. s indicated aboveA t#e relateddata can be a cube vie/A D:C sourceA or any ot#er data source accessible t#roug# TurboIntegrator.

Drill"Troug /ample

T#is section guides you t#roug# t#e creation o' a drill process and drill assignment ruleA /#ic# allo/s you to drill 'rom t#e$ales:y=uarter cube to a relational table t#at is t#e original source 'or t#e cube data. T#e table contains data at t#emont#ly levelA /#ile t#e $ales:y=uarter cube contains data at t#e 9uarterly level. :y drilling t#roug# to t#e relationalsourceA you can vie/ t#e underlying detail 'or t#e cube data.



f 398 25-09-20



8.>.1. Creating a Drill +rocess drill process is a TurboIntegrator process t#at de'ines t#e detailed dataA /#ic# opens in a ne/ /indo/. T#e cube 'rom

/#ic# a drill)t#roug# originates is called t#e origination cube.

:e'ore you create a drill processA you s#ould be 'amiliar /it# t#e data you /ant to open /#en drilling 'rom t#e originationcube.

+rocedure

Rig#t)clic6 t#e origination cube in t#e Server /plorer.1.

Clic6 DrillA Create Drill +rocess.

T#e 'irst /indo/ o' t#e Drill rocess $etup +i7ard opens.

T#e /i7ard displays a table /it# parameter values 'or t#e origination cube and all its dimensions. TM1H uses t#eseparameter values to set up t#e drill process. +#en you e&ecute t#e drill process to drill 'rom an origination cube to t#edetailed dataA TM1 updates t#e parameter values to re'lect t#e cube location 'rom /#ic# t#e drill)t#roug# originates.

2.

Clic6 *et.

T#e second /indo/ o' t#e Drill rocess $etup +i7ard opens.

3.

$elect t#e Datasource Tpe 'or t#e detailed data you /ant to drill t#roug# to 'rom t#e origination cube.

T#ere are t#ree Datasource Tpe options.

(ption Description

(D@C Drills 'rom t#e origination cube to an D:C source. T#e D:C source must be accessible 'romt#e computer on /#ic# t#e I:MH CognosH TM1 server is running.

*ote, "T%; TM1 re9uires DataDirect drivers to access an racle D:C source on $olaris orIEH. T#ese drivers are not supplied /it# TM1 and must be ac9uired separately.

Cube 9ie! Drills 'rom t#e origination cube to a di''erent cube vie/. You can drill to any cube t#at resideson t#e same server as t#e origination cube.

You can de'ine a cube vie/ data source t#at e&ceeds t#e ma&imum amount o' memory t#atTM1 can allocate /#en you access a vie/. :y de'aultA t#e memory t#res#old 'or t#eMa&imum5ie/$i7e parameter in t#e Tm1s.c'g 'ile is 1M: on a 32)bit systemA and 0 M:on a -)bit system.

Important, I' you do not speci'y t#e ma&imum vie/ si7e in t#e con'iguration 'ileA TM1displays an error message /#en you attempt to drill to t#e cube vie/.

(ter Drills 'rom t#e origination cube to any data source TurboIntegrator supports.

TM1 displays t#e data source options 'or t#e data source type you selected in t#e /i7ard.

-.

De'ine t#e data source.

(or an D:C data sourceA you must supply t#e 'ollo/ing in'ormation.

(ptionDescription

Datasource *ame "ame o' t#e D:C data source ?D$"@ you /ant to access /#en drilling 'rom t#eorigination cube.

%ser *ame 5alid user name to log on to t#e D:C source.

0.


f 398 25-09-20



(ptionDescription

+ass!ord ass/ord 'or t#e user name.

uer =uery t#at de'ines t#e data to return 'rom t#e D:C source. =uery results datadisplays in a separate /indo/ /#en you drill 'rom t#e origination cube.

(or a Cube 5ie/ data sourceA you must supply t#e 'ollo/ing in'ormation.

/lement Description

Datasource *ame "ame o' t#e vie/ you /ant to open /#en drilling 'rom t#e origination cube. Clic6:ro/se to select a vie/ name or create a vie/.

(or t#e t#er data sourceA clic6 2aunc TurboIntegrator to de'ine t#e data source.

Clic6 Finis.

T#e $ave rocess s dialog bo& opens.

.

%nter a name 'or t#e drill process in t#e "ame bo&.

*ote, (or best practiceA /e recommend t#at you use a drill process name t#at identi'ies t#e origination cube associated/it# t#e drill process. (or instanceA i' you create a process to drill 'rom a cube named riceCube to an D:C sourceA you/ould name t#e drill process riceCubeToD:C$ource. T#is type o' naming convention ma6es it easier to identi'y a drillprocess name /#en you edit a drill processA or select 'rom several drill processes associated /it# a cube.

.

Clic6 Save.

TM1 saves t#e drill process as a TurboIntegrator processA but pre'i&es t#e name you assigned in step /it# t#e stringDrill]. (or e&ampleA i' you save a drill process /it# t#e name riceCubeToD:C$ourceA TM1 saves t#e process asDrill]riceCubeToD:C$ource.

<.

+arent topic, Creating Drill)T#roug# rocesses and Rules


f 398 25-09-20



8.>.$. /diting Drill +rocesses+#en you create a drill process /it# a Cube 5ie/ data sourceA TurboIntegrator inserts t#e 'unction

Return5ie/*andle?CubeA5ie/@ above or belo/ t#e Generated Statements areaA /#ic# is located on t#e /pilog subtab o'

t#e Advanced tab in t#e TurboIntegrator /indo/.

I' you c#ange t#e data source 'or a drill processA TurboIntegrator does not update t#e 'unction /it# t#e ne/ data sourcebecause t#e 'unction is outside t#e Generated Statements area. You must edit t#e Cube 5ie/ data source in t#eReturn5ie/*andle 'unction 'or t#e drill process.

*ote, (or a drill process /it# an D:C data sourceA TurboIntegrator does not insert t#e Return5ie/*andle 'unction.T#ere'oreA you do not need to edit t#e 'unction /#en you c#ange an D:C data source 'or a drill process.

+rocedure

In t#e Server /plorerA rig#t)clic6 t#e origination cube /it# /#ic# t#e drill process is associated.1.

Clic6 DrillA /dit Drill +rocess.

T#e $elect dialog bo& opens.

2.

$elect a drill process and clic6 (<.

T#e TurboIntegrator /indo/ opens.

3.

Clic6 t#e Advanced tab.-.

Clic6 t#e /pilog tab.0.

%dit t#e 'eturn9ie!3andle 'unction to re'lect t#e ne/ vie/.

(or e&ampleA to use t#e %urope]1= vie/ o' t#e $ales cube as a data sourceA t#e Return5ie/*andle 'unction /ould loo6li6e t#is;

ReturnViewHandle('Sales','Europe_1Q')

.

Clic6 Save..

Close t#e TurboIntegrator /indo/.<.



f 398 25-09-20



8.>.-. Deleting Drill +rocesses(ollo/ t#ese steps to delete a drill process.

+rocedure

In t#e $erver %&plorerA rig#t)clic6 t#e origination cube /it# /#ic# t#e drill process is associated.1.

Clic6 DrillA Delete Drill +rocesses.

T#e Delete Drill rocesses dialog bo& opens.

2.

$elect t#e process?es@ you /ant to delete.

To select multiple ad!acent drill processesA clic6 and drag across t#e processes.

To select multiple non)ad!acent processesA #old do/n CTR8A and clic6 eac# drill process.

3.

Clic6 (<.-.



f 398 25-09-20



8.>.8. Creating a Drill Assignment 'ule drill assignment rule is t#e TM1H rule t#at lin6s cube cells /it# related detailed data. s indicated aboveA t#e related data

can be a cube vie/A D:C sourceA or any ot#er data source accessible t#roug# TurboIntegrator.

+rocedure

In t#e $erver %&plorerA select t#e origination cube 'or /#ic# you /ant to create a drill assignment rule.1.

Clic6 CubeA DrillA Create Drill Assignment 'ule.


(or eac# cube area you /ant to associate /it# detailed dataA continue /it# steps 3 t#roug# <.

2.

Clic6 Area to de'ine t#e cube cells ?area@you /ant to associate /it# detailed data.

+#en you clic6 t#e Area buttonA t#e 'eference to Cube dialog bo& opens.

3.

To de'ine t#e areaA do one o' t#e 'ollo/ing;

To de'ine t#e area as t#e entire cubeA clic6 (<.

To narro/ t#e area de'initionA clic6 t#e dimension buttons and select t#e elements t#at de'ine t#e cells you /ant toassociate /it# t#e detailed dataA and t#en clic6 (<.

-.

Clic6 /ual .0.

Clic6 String ..%nter t#e name o' t#e drill process enclosed in single 9uotation mar6s to de'ine t#e detailed data you /ant to associate/it# t#e area. (or e&ampleA enter riceCubeTo$ource.

Caution, Do not include t#e Drill] pre'i& in a drill process name. (or e&ampleA enter riceCubeTo$ource 'or a drillprocess named Drill]riceCubeTo$ource.

You can associate more t#an one drill process /it# an area. %nclose all drill processesA separated by commasA /it#in aset o' single 9uotation mar6s.

*ote, You can also use conditional logic or ot#er 'unctions to return t#e name o' a drill process.

.

Clic6 Semicolon .

T#e semi)colon indicates t#e end o' a rules statement.

<.

Clic6 Save.B.

'esults

You can no/ drill t#roug# to detailed data 'or /#ic# you #ave created a drill process and a drill assignment rule.



f 398 25-09-20



8.>.=. Drill"Troug /ampleT#is section guides you t#roug# t#e creation o' a drill process and drill assignment ruleA /#ic# allo/s you to drill 'rom t#e

$ales:y=uarter cube to a relational table t#at is t#e original source 'or t#e cube data. T#e table contains data at t#e mont#ly

levelA /#ile t#e $ales:y=uarter cube contains data at t#e 9uarterly level. :y drilling t#roug# to t#e relational sourceA you can

vie/ t#e underlying detail 'or t#e cube data.

Setting %p te (D@C Data SourceT#e e&ample in t#is section drills t#roug# to an D:C source ?ccess database@. :e'ore loo6ing at t#e e&ampleA youmust set up t#e D:C data source.

Creating a Drill +rocess

You can no/ create a drill process 'or t#e $ales:y=uarterCube cube. T#e drill process de'ines an D:C data source ast#e detailed data t#at you can vie/ /#en you drill 'rom t#e $ales:y=uarterCube cube.

Creating a Drill Assignment 'ule for Sales@Mont

(ollo/ t#ese steps to create a drill assignment rule t#at ma6es t#e R%8TI"8T:8%]$ales:yMont# process available'rom t#e $ales:y=uarterCube cube.

9ie!ing te Drill"Troug /ample

(ollo/ t#ese steps to vie/ t#e result o' t#e drill process and drill assignment rule.



f 398 25-09-20





8.>.=.$. Creating a Drill +rocessYou can no/ create a drill process 'or t#e $ales:y=uarterCube cube. T#e drill process de'ines an D:C data source as t#e

detailed data t#at you can vie/ /#en you drill 'rom t#e $ales:y=uarterCube cube.

+rocedure

In t#e $erver %&plorerA rig#t)clic6 [email protected].

Clic6 DrillA Create Drill +rocess.

T#e Drill rocess $etup +i7ard opens. T#e table contains t#e de'ault parameters 'or t#e drill process.

2.

$elect t#e &ear parameter value.3.

Clic6 Select /lement.

T#e $ubset %ditor opens.

-.

$elect 1 uarter and clic6 (<.0.

Repeat steps 3 t#roug# 0 to c#ange t#e ,ross Margin> parameter value to %nits..

Clic6 *et.

T#e second screen o' t#e /i7ard opens.

.

$elect (D@C as t#e Datasource Type.<.

Clic6 @ro!se ne&t to t#e Data $ource "ame bo& and select TM1QsampleQdata.B.

%nter admin as t#e User "ame.1.

%nter t#e 'ollo/ing 9uery in t#e uer bo&.

T#is 9uery is speci'ic to t#e sample ccess database. It uses II( 'unctions t#at are uni9ue to ccess and cannot be usedagainst any ot#er database.

SELECT ActvsBud, Region, Model, Account1, Month, Data

FROM Sales WHERE ( ActvsBud = '?actvsbud?' AND Region = '?region?'

AND Model = '?model?' AND Account1 = '?account1?' AND

(

IIF( '?quarter?'= '1 Quarter', Month = 'Jan' OR Month

= 'Feb' OR Month = 'Mar',

IIF( '?quarter?'= '2 Quarter', Month = 'Apr' OR Month= 'May' OR Month = 'Jun',

IIF( '?quarter?'= '3 Quarter', Month = 'Jul' OR Month

= 'Aug' OR Month = 'Sep',

IIF( '?quarter?'= '4 Quarter', Month = 'Oct' OR Month

= 'Nov' OR Month = 'Dec',

IIF( '?quarter?'= 'Year',TRUE,TRUE)))))

)

)

*ote, :e sure to enclose t#e re'erences to t#e TM1H parameter names in 9uestion mar6s ?L@.

11.

Clic6 Finis.

T#e $ave rocess s dialog bo& opens.

12.

$ave t#e process as R%8TI"8T:8%]$ales:yMont#.13.

'esults

T#e ne/ drill process displays as an available process on t#e server. "ote t#at t#e process name includes t#e BDrillQ pre'i&A

indicating t#at it is a drill process.

You can no/ create a drill assignment rule to ma6e t#e D:C data source available 'rom t#e $ales:y=uarterCube cube.

+arent topic, Drill)T#roug# %&ample


f 398 25-09-20



8.>.=.-. Creating a Drill Assignment 'ule for Sales@Mont(ollo/ t#ese steps to create a drill assignment rule t#at ma6es t#e R%8TI"8T:8%]$ales:yMont# process available 'rom

t#e $ales:y=uarterCube cube.

+rocedure

In t#e $erver %&plorerA rig#t)clic6 [email protected].

Clic6 DrillA Create Drill Assignment 'ule.


2.

%nter t#e 'ollo/ing rule in t#e large bo&.

['Year'] = S:IF( ( ELLEV( 'actvsbud', !actvsbud ) = 0) &

( ELLEV( 'region', !region)= 0 ) &( ELLEV( 'model', !model)= 0 ) &

( ELLEV( 'account1', !account1) = 0),

'RELATIONALTABLE_SalesByMonth', '' );

[] = S:IF( ISLEAF= 1, 'RELATIONALTABLE_SalesByMonth','');

T#is rule indicates t#at t#e R%8TI"8T:8%]$ales:yMont# drill process /ill be e&ecuted /#en you select t#e Drilloption 'rom a cell t#at is eit#er;

Identi'ied by t#e Year element and )level elements 'rom all ot#er dimensions

Identi'ied by all )level elements

3.

$ave t#e rule.

You can no/ test t#e drill)t#roug# 'unctionality 'or $ales:y=uarterCube cube.

-.



f 398 25-09-20



8.>.=.8. 9ie!ing te Drill"Troug /ample(ollo/ t#ese steps to vie/ t#e result o' t#e drill process and drill assignment rule.

+rocedure

pen t#e DrillQrelational vie/ o' t#e $ales:y=uarterCube.1.

Rig#t)clic6 t#e cell at t#e intersection o' Units and Year.2.

Clic6 Drill.

n e&tract 'rom t#e TM1]sample]data data source opensA displaying t#e mont#ly detail 'or t#e cell.

3.

Clic6 (< to close t#e /indo/.-.

Drill t#roug# ot#er cells in t#e Drill]relational vie/ to vie/ t#e mont#ly detail. You s#ould be able to drill t#roug# any cellin t#e vie/.

0.

C#ange t#e Region title element 'rom ,ermany to /urope..

Rig#t)clic6 any cell in t#e vie/..

'esults

"ote t#at t#e Drill option is not available. T#is is because t#e drill assignment rule 'or $ales:y=uarterCube indicates t#at t#e

Drill option is only available 'or cells identi'ied by t#e )level elements or 'or t#e cells identi'ied by t#e Year element and

)level elements. %urope is a consolidationA so t#e Drill option is not available.



f 398 25-09-20



8.?. Debugging 'ulesTM1H provides a tool called t#e Rules Tracer to assist in t#e development and debugging o' rules. T#eRules Tracer

'unctionality is available only in t#eCube 5ie/er.

+it# t#e Rules TracerA you can do t#e 'ollo/ing;

Trace calculations ) %nsure t#at rules are being assigned to selected cells and calculated properlyA or trace t#e pat# o' consolidated elements

Trace feeders ) %nsure t#at selected lea' cells are 'eeding ot#er cells properly

Cec# feeders ) %nsure t#at t#e c#ildren o' a selected consolidated cell are 'ed properly

Tracing CalculationsTo trace a calculationA /#et#er a consolidation or a rules calculationA rig#t)clic6 t#e cell containing t#e calculation andclic6 Trace Calculation.

Tracing FeedersT#e 'ules Tracer lets you trace t#e /ay a selected cell 'eeds ot#er cells.



f 398 25-09-20



8.?.1. Tracing CalculationsTo trace a calculationA /#et#er a consolidation or a rules calculationA rig#t)clic6 t#e cell containing t#e calculation and clic6

Trace Calculation.

T#e 'ules Tracer /indo/ opens. (rom #ereA you can trace a calculation to its lea' level components. T#e Rules Tracer/indo/ contains t/o panes.

Tracing Calculation 4top pane5 ) Displays t#e de'inition o' t#e current cell locationA /it# an icon indicating /#et#er

t#e value in t#e cell is derived by Consolidation or by 'ules . lso displays t#e current value o' t#e cell. I' t#evalue is derived by rulesA t#e rule displays in t#e status bar o' t#e Tracing Calculation pane.

Trace 4bottom pane5 ) Displays t#e components o' t#e 'irst consolidated element or t#e 'irst rule in t#e cell de'inition.You can double)clic6 any item in t#e bottom pane to trace a pat# to t#e lea' level elements t#at de'ine t#e cell.

Tracing a 'ule Calculation /ample 4Simple5(ollo/ t#ese steps to vie/ a simple e&ample o' tracing a rule calculation.

Tracing a Consolidation /ample 4Comple5

T#e previous simple e&ample s#o/s #o/ t#e Rules Tracer /or6s 'or cells at t#e "; level. T#e 'ollo/ing e&ample s#o/s#o/ you can use t#e Rules Tracer to trace values t#at include consolidations.

Tracing a *e! Calculation +at

You can clic6 any cell de'inition in t#e Tracing Calculation pane o' t#e Rules Tracer to begin tracing a ne/ calculationpat#.

+arent topic, Debugging Rules


f 398 25-09-20



8.?.1.1. Tracing a 'ule Calculation /ample 4Simple5(ollo/ t#ese steps to vie/ a simple e&ample o' tracing a rule calculation.

+rocedure

pen t#e TraceQsimple vie/ o' t#e $alesCube cube.

T#is vie/ contains t#e rice values t#at are derived t#roug# rules you created earlier in t#is section.

1.

Rig#t)clic6 t#e cell at t#e intersection o' rice and Fan.2.

$elect Trace Calculation.

T#e 'ules Tracer /indo/ opens.

In t#e Tracing Calculation pane at t#e topA TM1H displays t#e current cell de'initionA along /it# 'ules iconindicating t#at t#e cell value is derived t#roug# rules. T#e rule t#at applies to t#e cell is s#adedA and t#e Calculated

value o' t#e cell displays in t#e lo/er rig#t corner o' t#e pane.

In t#e Trace pane at t#e bottomA TM1 s#o/s t#e evaluation o' t#e rule t#at applies to t#e current cell. In t#is e&ampleAt#e rule



evaluates to

['Price']=PriceCube(Actual, Germany, L Series 1.8L Sedan,

Jan)

because t#e current cell is an "; location ?not de'ined by any consolidations@.

You no/ 6no/ t#at t#e cell $alesCube?ctualA ,ermanyA 8 $eries 1.<8 $edanA riceA Fan@ ta6es its value 'romriceCube?ctualA ,ermanyA 8 $eries 1.<8 $edanA Fan@.

3.

+arent topic, Tracing Calculations


f 398 25-09-20



8.?.1.$. Tracing a Consolidation /ample 4Comple5T#e previous simple e&ample s#o/s #o/ t#e Rules Tracer /or6s 'or cells at t#e "; level. T#e 'ollo/ing e&ample s#o/s #o/

you can use t#e Rules Tracer to trace values t#at include consolidations.

+rocedure

pen t#e TraceQcomple vie/ o' t#e $alesCube cube.1.

Rig#t)clic6 t#e cell at t#e intersection o' $ales and 1 =uarter.2.

Clic6 Trace Calculation.

T#e Rules Tracer opens.

In t#e Tracing Calculation pane at t#e topA TM1H displays t#e current cell de'initionA along /it# t#e Consolidation icon

indicating t#at t#e cell value is derived t#roug# consolidation. T#e value o' t#e Consolidated cell displays in t#e lo/errig#t corner o' t#e pane.

In t#e Trace pane at t#e bottomA TM1 displays t#e components o' t#e 'irst consolidated element in t#e cell de'inition. Int#is e&ampleA T $eries is t#e 'irst consolidated element in $alesCube?ctualA ,ermanyA T $eriesA $alesA 1=uarter@. TM1displays t#e T $eries components /it# t#eir values.

3.

Double)clic6 T Series $.E2 Coupe in t#e Trace pane.

You are no/ tracing t#e value o' $alesCube?ctualA ,ermanyA T $eriesA $alesA 1=uarter@ t#roug# T $eries 2.<8 Coupe.

T#e Tracing Calculation pane no/ displays t#e cell de'inition 'or t#e element you double)clic6ed.SalesCube(Actual, Germany, T Series 2.8L Coupe, Sales,

1 Quarter)

T#e Trace pane no/ displays t#e components o' t#e 'irst consolidated element in t#is cell de'inition. T#e 'irstconsolidated element in $alesCube?ctualA ,ermanyA T $eries 2.<8 CoupeA $alesA 1 =uarter@ is 1 =uarter. TM1 s#o/s t#et#ree components FanA (ebA and MarA /it# t#eir values.

In t#e Trace paneA note t#at a Rules icon precedes eac# component nameA indicating t#at t#e components derivet#eir values t#roug# rules.

-.

Double)clic6 Ran in t#e Trace pane.

You are no/ tracing t#e value o' $alesCube?ctualA ,ermanyA T $eriesA $alesA 1=uarter@ t#roug# t#e T $eries 2.<8 Coupeand Fan.

T#e Tracing Calculation no/ displays t#e cell de'inition 'or t#e element you double)clic6ed. In t#is caseA$alesCube?ctualA ,ermanyA T $eries 2.<8 CoupeA $alesA Fan@. T#is cell is calculated by a ruleA X$alesW";XriceWK XUnitsWQ1A /#ic# is s#aded. T#e Consolidated value o' t#e cellA 1<3.2A displays in t#e lo/er rig#t corner o' t#epane.

T#e Trace pane no/ displays t#e components o' t#e rule 'ormula and t#eir values. T#e component rice #as a value o' -310.<A and is derived by anot#er rule. T#e component Units #as a value o' -3-A and is an Input 5alueA as denoted byt#e gray bullet .

:y plugging t#ese values into t#e rule 'ormulaA you can see t#at ?-310.< E -3-@K1 1<3.2A con'irming t#evalue o' $alesCube?ctualA ,ermanyA T $eries 2.<8 CoupeA $alesA Fan@.

0.

Double)clic6 +rice to vie/ t#e rule t#at is used to derive t#e rice value.

T#e 'ollo/ing rule calculates t#e rice;



T#is rule evaluates to;

PriceCube(Actual, Germany, T Series 2.8L Coupe, Jan)

/#ic# displays in t#e Trace pane as an Input 5alueA denoted by a gray bullet A indicating t#at you cannot trace t#ecalculation any 'urt#er.

.



f 398 25-09-20



8.?.1.-. Tracing a *e! Calculation +atYou can clic6 any cell de'inition in t#e Tracing Calculation pane o' t#e Rules Tracer to begin tracing a ne/ calculation pat#.

(or instanceA using t#e previous comple& e&ampleA you could clic6 t#e 'irst cell de'inition in t#e Tracing Calculation pane tobegin tracing a ne/ pat# t#roug# t#e T $eries consolidation.

+#en you clic6 a cell de'inition in t#e Tracing Calculation paneA t#e Trace pane displays t#e components o' t#e 'irstconsolidated element in t#e cell de'inition. You can t#en double)clic6 any component to begin tracing a ne/ calculation pat#.



f 398 25-09-20



8.?.$. Tracing FeedersT#e 'ules Tracer lets you trace t#e /ay a selected cell 'eeds ot#er cells.

:ecause you can only 'eed ot#er cells 'rom a lea' elementA t#e Trace Feeders command is available 'or t#e lea' cells youde'ine by rulesA but is not available 'or consolidated cells.

+rocedure

In t#e Cube 9ie!erA rig#t)clic6 t#e cell you /ant to trace.1.

Clic6 Trace Feeders.

T#e 'ules Tracer /indo/ opens. T#is /indo/ contains t/o panes.

Tracing Feeders 4top pane5 ) Displays t#e de'inition o' t#e current cell locationA and t#e 'eeder rules associated/it# t#e current cell

Trace 4bottom pane5 ) Displays t#e locations 'ed by t#e current cell

2.

Double)clic6 a location in t#e Trace pane.

T#is location becomes t#e current cell location in t#e Tracing (eeders paneA and t#e Trace pane displays any locations 'edby t#e current cell.

3.

Continue double)clic6ing t#e locations in t#e Trace pane until you #ave traced t#e 'eeders to t#e level you re9uire.-.

Cec#ing Feeders

I' a cube contains a rule /it# $4IC*%C4 and (%%D%R$ statementsA you can use t#e Rules Tracer to c#ec6 t#at TM1properly 'eeds t#e components o' t#e consolidation.

+arent topic, Debugging Rules


f 398 25-09-20



8.?.$.1. Cec#ing FeedersI' a cube contains a rule /it# $4IC*%C4 and (%%D%R$ statementsA you can use t#e Rules Tracer to c#ec6 t#at TM1H

properly 'eeds t#e components o' t#e consolidation.

+rocedure

In t#e Cube 9ie!erA rig#t)clic6 t#e consolidated cell you /ant to c#ec6.1.

Clic6 Cec# Feeders.

T#e Rules Tracer opens. T#is /indo/ contains t/o panes.

Cec#ing Feeders 4top pane5 ) Displays t#e de'inition o' t#e current cell ?consolidation@

Trace 4bottom pane5 ) Displays all components o' t#e consolidation t#at are not properly 'ed

T#e Trace pane is emptyA /#ic# means t#e consolidation is 'ed properly and t#e cubes values are accurate.

I' t#e Trace pane displays t#e components o' t#e consolidationA you must edit t#e rule associated /it# t#e current cubeto add t#e (%%D%R$ statements t#at 'eed all t#e listed components.

*ote, You can only c#ec6 t#e (%%D%R$ 'or a cell once per TM1 session. T#e action o' c#ec6ing t#e (%%D%R$ actually'eeds t#e components o' t#e consolidation. ny subse9uent c#ec6ing o' t#e (%%D%R$ does not yield accurate results. I' you /ant to c#ec6 t#e (%%D%R$ 'or a cell more t#an onceA you must recycle t#e I:MH CognosH TM1 server be'ore everyc#ec6.

2.

+arent topic, Tracing (eeders


f 398 25-09-20



=. (rganiing (b)ects in TM1 ApplicationsI:MH CognosH TM1H lets you organi7e ob!ects logically by applicationA and by type. T#is section describes #o/ to create

TM1 applications.

TM1 Application (vervie!TM1 applications are ob!ects t#at 'unction as virtual 'olders to organi7e s#ortcuts to ot#er TM1 ob!ectsA 'ilesA and UR8s ina logicalA !ob)speci'ic grouping.

Securit Considerations for Creating and 9ie!ing Applications

T#e 'ollo/ing table describes t#e security privileges re9uired to per'orm actions related to TM1 applications.Creating and Managing Applications

To begin adding applications to a I:M Cognos TM1 server A a member o' t#e DMI" or Datadmin group must 'irst createone or more top)level applications. Top)level applications are applications t#at appear directly belo/ t#e pplicationsgroup in t#e $erver %&plorer. $econdary)level applications appear /it#in a parent applicationA as e&plained in Creating a$econdary)8evel pplication /it#in an %&isting pplication.

Adding TM1 (b)ect 'eferences to an Application

You can add re'erences to ob!ects 'rom t#e I:M Cognos TM1 server on /#ic# t#e application resides as /ell as ob!ects'rom ot#er servers to /#ic# you are connected.

Adding File 'eferences to an Application

You can add 'ile re'erences to I:M Cognos TM1 applications 'or any type o' 'ile on your computer or net/or6A suc# as%&celA +ordA o/erointA D(A or any ot#er 'ile.

Adding %'2 'eferences to an ApplicationYou can add a UR8 address to an application 'or any o' t#e 'ollo/ing UR8 protocols;

7or#ing !it (b)ect6 File6 and %'2 'eferences in TM1 ApplicationsYou can double)clic6 a re'erence to an ob!ectA 'ileA or UR8 in an I:M Cognos TM1 application to per'orm t#e de'ault actionon t#e ob!ect.

Administering Securit for TM1 Applications

T#e 'ollo/ing sections describe #o/ to assign security privileges 'or I:M Cognos TM1 applications and re'erences to usergroups on t#e I:M Cognos TM1 serverA as /ell as #o/ to publis# and privati7e TM1 applications and re'erences.

9ie!ing 2ogical Groupings in TM1 Applications

ne o' t#e primary advantages o' I:M Cognos TM1 applications is t#at t#ey let you vie/ and manage ob!ects and 'iles inlogical groupings. T#is simpli'ies t#e tas6 o' using TM1 A because you can easily identi'y and locate 'iles and ob!ects in

!ob)speci'ic applications /it#out #aving to scan t#roug# large lists o' ob!ects arranged by type.

+ublising TM1 Applications to TM1 7eb

ll re'erences to cubesA vie/sA 'ilesA and UR8s in I:M Cognos TM1 applications are automatically available in TM1 +eb.


f 398 25-09-20



=.1. TM1 Application (vervie!TM1H applications are ob!ects t#at 'unction as virtual 'olders to organi7e s#ortcuts to ot#er TM1 ob!ectsA 'ilesA and UR8s in a

logicalA !ob)speci'ic grouping.

(or e&ampleA you mig#t create an application t#at organi7es all TM1 ob!ects and related 'iles 'or a "ort# merican salesorgani7ation.

You insert ob!ectsA 'ilesA and UR8s into an application by creating a s#ortcut or reference. pplications and re'erences providea 9uic6 and organi7ed /ay to open t#e target ob!ects to /#ic# t#e re'erences point.

Tpes of 'eferencesI:M Cognos TM1 applications can contain re'erences to any o' t#e 'ollo/ing items;

@eavior of 'eferences

It is important to understand t#at /#en you add ob!ect and 'ile re'erences to an applicationA t#ey e&ist by re'erence only) as a s#ortcut t#at opens t#e original I:M Cognos TM1 ob!ect or 'ile. Deleting a re'erence in an application is di''erent'rom deleting t#e source TM1 ob!ect or 'ile;

Displa (rder for 'eferences in Applications

TM1 displays re'erences in applications in t#e 'ollo/ing order. +it#in eac# re'erence groupA TM1 sorts t#e re'erencesalp#abetically in descending order.

%sing Applications and 'eferences in TM1 7eb+#en you create TM1 applications and re'erences in t#e $erver %&plorerA t#ey are automatically available in TM1 +eb.T#is applies 'or re'erences to cubesA vie/sA 'ilesA and UR8s.

Application Folders and Files on te TM1 server

T#e 'olders and 'iles t#at support TM1 applications are stored in t#e I:M Cognos TM1 server data directory.

+arent topic, rgani7ing b!ects in TM1 pplications


f 398 25-09-20



=.1.1. Tpes of 'eferencesI:MH CognosH TM1H applications can contain re'erences to any o' t#e 'ollo/ing items;

TM1 ob)ects ) n application can contain re'erences to any type o' TM1 ob!ect e&cept 'or rules and replications.

You can re'erence TM1 ob!ects on t#e same I:M Cognos TM1 server containing t#e application or any ot#er TM1 serverto /#ic# you #ave access.

Files ) n application can re'erence any type o' 'ileA suc# as an %&cel spreads#eetA a +ord documentA or any ot#er 'ile.ny %&cel 'ile can be re'erencedA regardless o' /#et#er t#e 'ile contains TM1 slicesA 'unctionsA or ot#er TM1 'eatures.

You can re'erence bot# external and uploaded 'iles;

re'erence to an external 'ile provides a s#ortcut to a 'ile t#at can e&ist in any s#ared directory on your net/or6.

re'erence to an uploaded 'ile saves a copy o' t#e original 'ile on t#e TM1 server . *o/everA c#anges to t#e originalsource 'ileA outside o' TM1 A are not automatically re'lected in t#e uploaded copy o' t#e 'ile on t#e TM1 server . You mustupdate t#e 'ile on t#e server to ma6e t#e c#anges available.

%'2s ) n application can contain lin6s to any /eb pages or resources t#at use t#e #ttp or #ttps protocol.

+arent topic, TM1 pplication vervie/


f 398 25-09-20



=.1.$. @eavior of 'eferencesIt is important to understand t#at /#en you add ob!ect and 'ile re'erences to an applicationA t#ey e&ist by re'erence only ) as

a s#ortcut t#at opens t#e original I:MH CognosH TM1H ob!ect or 'ile. Deleting a re'erence in an application is di''erent 'rom

deleting t#e source TM1 ob!ect or 'ile;

Deleting a reference 'rom an application #as no impact on t#e corresponding source TM1 ob!ect or 'ile. nly t#ere'erence is deleted.

Deleting a source ob!ect in TM1 A or a 'ile on dis6A brea6s any corresponding re'erence in an applicationA but does notdelete t#e re'erence. T#e re'erence remains but is not 'unctional i' t#e source ob!ect or 'ile is deleted.

ne e&ception to t#e above is 'or uploaded 'ile re'erences. In t#is caseA t#e 'ile is actually copied to t#e I:M Cognos TM1server . I' you delete a re'erence to an uploaded 'ileA TM1 deletes t#e uploaded copy o' t#e 'ile 'rom t#e TM1 server .

(or details on 'ile re'erencesA see dding (ile Re'erences to an pplication



f 398 25-09-20



=.1.-. Displa (rder for 'eferences in ApplicationsTM1H displays re'erences in applications in t#e 'ollo/ing order. +it#in eac# re'erence groupA TM1 sorts t#e re'erences

alp#abetically in descending order.

Cubes

5ie/s

Dimensions

$ubsets

rocesses

C#ores

(iles and UR8s

*ote, You cannot set t#e order in /#ic# re'erence groups displayA nor t#e sort order /it#in re'erence groups.



f 398 25-09-20





=.1.=. Application Folders and Files on te TM1 serverT#e 'olders and 'iles t#at support TM1H applications are stored in t#e I:MH CognosH TM1 server data directory.

Folders

T#e structure 'or TM1 application 'olders are organi7ed in t#e 'ollo/ing location;

TM1 Data Directory \ }applications

In'ormation about bot# re'erenced and uploaded 'iles are stored in t#eir related sub)'olders #ere.

'eferenced Files

In'ormation about re'erenced 'iles are stored in place#older 'iles named /it# t#e .extr e&tension.

(or e&ampleA i' you create an application re'erence to a 'ile named sheet1.xlsA TM1 creates a place#older 'ile named

sheet1.xls.extr to 6eep trac6 o' t#at entry.

%ploaded Files

In'ormation about uploaded 'iles are stored in place#older 'iles named /it# t#e .blob e&tension.

T#e actual 'iles t#at are uploaded to t#e TM1 server are stored in t#e 'ollo/ing location;

TM1 Data Directory \ }Externals

(or e&ampleA i' you upload a 'ile to t#e lanning $ample databaseA it /ould be saved #ere;

C:\Program Files\Cognos\TM1\Custom\TM1Data\PlanSamp\}Externals\

TM1 automatically appends a date and time su''i& to t#e end o' t#e 'ile name 'or any 'ile you upload. T#e su''i& uses t#e'ormat year month day time.file extension.

(or e&ampleA i' you upload t#e 'ile Sample_Budget.xls to t#e lanning $ample databaseA TM1 renames it to

Sample_Budget.xls_20090617155650.xls and stores t#e 'ile in t#e 'ollo/ing location;

C:\Program Files\Cognos\TM1\Custom\TM1Data\PlanSamp\}Externals\Sample_Budget.

xls_20090617155650.xls



f 398 25-09-20



=.$. Securit Considerations for Creating and 9ie!ing ApplicationsT#e 'ollo/ing table describes t#e security privileges re9uired to per'orm actions related to TM1H applications.

(or detailsA see dministering $ecurity 'or TM1 pplications.

Action 'euired securit privilege

Create a top)level application Must be member o' DMI" or Datadmin group

Create a secondary)level application dmin access to parent application

5ie/ and use applications and re'erences Read

dd a private re'erence to an application Read

ublis# a private application Must be member o' DMI" or Datadmin group

ublis# a private re'erence to a public ob!ect dmin

ublis# a private re'erence to a private ob!ect Cannot be done

rivati7e a public application or re'erence dmin

Delete a public application or re'erence dmin

Delete a private application dmin

Delete a private re'erence Read



f 398 25-09-20



=.-. Creating and Managing ApplicationsTo begin adding applications to a I:MH CognosH TM1H server A a member o' t#e DMI" or Datadmin group must 'irst

create one or more top)level applications. Top)level applications are applications t#at appear directly belo/ t#e pplications

group in t#e $erver %&plorer. $econdary)level applications appear /it#in a parent applicationA as e&plained in Creating a

$econdary)8evel pplication /it#in an %&isting pplication.

In t#e 'ollo/ing e&ampleA you see an applications group ?pplications@A t#ree top)level applications ?%uropean $alesA "ort#merican $alesA and acRim $ales@A and t/o secondary)level applications ?C#ina and Indonesia@ beneat# t#e acRim $alestop)level application.

Creating a Top"2evel Application

(ollo/ t#ese steps to create a top)level application.

'enaming Applications

(ollo/ t#ese steps to rename an application.

Deleting Applications

You can delete any applicationA public or privateA to /#ic# you #ave DMI" privilege.

Creating a Secondar"2evel Application !itin an /isting Application

ny I:M Cognos TM1 user /it# dmin privilege to an e&isting application can create secondary)level applications.



f 398 25-09-20



=.-.1. Creating a Top"2evel Application(ollo/ t#ese steps to create a top)level application.

+rocedure

%nsure t#at t#e pplications group is visible on your I:MH CognosH TM1H server . I' t#e group is not visibleA clic69ie!A Applications in t#e $erver %&plorer.

1.

In t#e $erver %&plorerA rig#t)clic6 t#e pplications group on t#e server /#ere you /ant to create t#e application and clic6Create *e! Application.

TM1 inserts a ne/ top)level application temporarily named "e/ (older in t#e selected pplications group.

2.

ssign a name to t#e ne/ application.

"ote t#at Microso't +indo/s #as some reserved device names t#at cannot be used as 'older or 'ile names. $ee t#e M$+indo/s /ebsite 'or an updated list o' reserved device names.

ll applications are private ob!ects t#at only t#e user /#o creates t#e application can access. You must publis# anapplication to ma6e it available to ot#er TM1 users. nly TM1 rc#itect and TM1 erspectives users can create publicapplications. TM1 Client users can create only private applications.

3.

Rig#t)clic6 t#e application and clic6 SecuritA Ma#e +ublic to ma6e t#e application available to ot#er users.

*ote, T#e type o' icon t#at is used 'or an application depends on t#e private or public status o' t#e application.

private application displays /it# a +rivate Applications icon /#ic# includes a 6ey in t#e upper rig#t corner.

public application displays /it# a +ublic Applications icon .

You can no/ begin adding re'erences andor secondary)level applications to t#e application.

-.

+arent topic, Creating and Managing pplications


f 398 25-09-20



=.-.$. 'enaming Applications(ollo/ t#ese steps to rename an application.

+rocedure

Rig#t)clic6 t#e application in t#e $erver %&plorer.1.

Clic6 'ename.

T#e current application name is selected and ready to be edited.

2.

Type a ne/ name 'or t#e application.3.

ress /*T/' .-.



f 398 25-09-20



=.-.-. Deleting ApplicationsYou can delete any applicationA public or privateA to /#ic# you #ave DMI" privilege.

*ote, +#en you delete an applicationA I:MH CognosH TM1H deletes all sub)applications and re'erences contained in t#e

application.

+#en you #ave DMI" privilege to an applicationA you must also #ave DMI" privilege to all re'erences and sub)applications/it#in t#e applicationA regardless o' t#e security privileges t#at TM1 applies t#roug# t#e TM1 $ecurity ssignments /indo/.T#ere'oreA /#en you #ave DMI" access to an applicationA you can delete sub)applications and re'erences to /#ic# you /ere

assigned only t#e R%D or ""% privilege.

To illustrate t#e DMI" privilege 'or deleting an applicationA consider t#e 'ollo/ing e&ample. T#ere are t#ree applications ona server ?pp1A pp2A and pp3@A all created by a member o' t#e DMI" group.

T#e administrator #as de'ined t#e 'ollo/ing security privileges to t#e applications 'or t#e "ort# merica user group;

Application *ame Securit +rivilege for *ort America %ser Group

pp1 dmin

pp2 Read

pp3 "one

+#en a member o' t#e "ort# merica user group logs on to t#e I:M Cognos TM1 server A #e /ill see pp1A to /#ic# #e #asDMI" privilegeA and pp2A to /#ic# #e #as R%D privilege. *e /ill not see pp3A as #e #as ""% privilege 'or t#atapplication.

"o/A i' a member o' t#e "ort# merica user group attempts to delete pp1A t#e deletion /ill succeed. T#is is e&pectedbecause t#e "ort# merica user group #as DMI" privilege to pp1A /#ic# allo/s deletion o' applications. *o/everA bot#pp2 and pp3 ?along /it# any re'erences contained t#erein@ /ill also be deleted /it#out /arningA despite t#e 'act t#at t#e"ort# merica group #as been assigned R%D and ""% privileges 'or t#e applicationsA respectively.

+rocedure


Clic6 Delete.2.

Clic6 &es /#en prompted 'or con'irmation.3.



f 398 25-09-20



=.-.8. Creating a Secondar"2evel Application !itin an /isting Applicationny I:MH CognosH TM1H user /it# dmin privilege to an e&isting application can create secondary)level applications.

+rocedure

Rig#t)clic6 t#e e&isting application.1.

Clic6 *e!A Application.

TM1 inserts a ne/ secondary)level application temporarily named "e/ (older in t#e e&isting application.

2.

ssign a name to t#e ne/ application.

TM1 creates t#e application as a private ob!ect /#ic# only you can access.

3.

I' you are a member o' t#e DMI" or Datadmin group and you /ant to publis# t#e application so t#at ot#er TM1 userscan access itA rig#t)clic6 t#e application and clic6 SecuritA Ma#e +ublic.

+#en you publis# a secondary)level applicationA security privileges 'or t#e secondary)level application are in#erited 'romt#e security privileges de'ined 'or t#e parent application. You can c#ange security privileges by 'ollo/ing t#e steps inssigning $ecurity rivileges 'or TM1 pplications and Re'erences to User ,roups.

-.



f 398 25-09-20



=.8. Adding TM1 (b)ect 'eferences to an ApplicationYou can add re'erences to ob!ects 'rom t#e I:MH CognosH TM1H server on /#ic# t#e application resides as /ell as ob!ects

'rom ot#er servers to /#ic# you are connected.

+rocedure

$elect t#e ob!ect in t#e $erver %&plorer.1.

Drag and drop t#e ob!ect onto t#e application.

re'erence to t#e ob!ect displays in t#e application.

:y de'aultA any re'erence you add to an application is a private re'erenceA as indicated by a 6ey superimposed over t#eob!ect icon. nly you can access t#e re'erence.

Icon Description

re'erence to t#e $alesCube cube t#at /as added to t#e "ort# merican $alesapplication.

TM1 adds an image o' a s#ortcut arro/ to an ob!ects icon to represent are'erence.

n image o' a 6ey is added to t#e lo/er corner o' t#e re'erence icon torepresent private re'erences and to bot# lo/er and upper rig#t)#and corners to

represent private ob!ects.

2.

Ma#ing a 'eference +ublic

I' you /ant to ma6e t#e re'erence available to ot#er I:M Cognos TM1 usersA you must publis# t#e re'erence by rig#t)clic6ing t#e re'erence and clic6ing Application ItemA SecuritA Ma#e +ublic.

Adding 'eferences to +rivate 9ie!s and Subsets to an Application

+#en you add a re'erence to a private vie/ or subset to an applicationA t#e re'erence is created as a private re'erenceA/#ic# is t#e de'ault be#avior /#en creating any re'erence in an application.

Simultaneousl Creating a *e! (b)ect and Adding a 'eference to an Application

You can create a ne/ I:M Cognos TM1 ob!ect 'rom /it#in an application. TM1 creates t#e ne/ ob!ect on t#e server/#ere t#e application residesA and inserts a private re'erence to t#e ob!ect in t#e application. You can create dimensionsAcubesA processesA and c#ores 'rom /it#in an application.



f 398 25-09-20



=.8.1. Ma#ing a 'eference +ublicI' you /ant to ma6e t#e re'erence available to ot#er I:MH CognosH TM1H usersA you must publis# t#e re'erence by rig#t)

clic6ing t#e re'erence and clic6ing Application ItemA SecuritA Ma#e +ublic.

TM1 combines t#e ob!ects icon /it# a s#ortcut arro/ to identi'y a public re'erence to a public ob!ect.

Icon Description

ublic re'erence to a public subset.

ublic re'erence to a public vie/.

To simpli'y t#e process o' creating a public re'erenceA you can rig#t)clic6 an ob!ect in t#e $erver %&plorerA #old do/n t#erig#t mouse buttonA and t#en drag and drop t#e ob!ect onto an application. +#en you drop t#e ob!ectA TM1 displays as#ortcut menu. Clic6 Create +ublic 'eference.

You can publis# re'erences in public applications only. +#en you publis# a re'erence in an applicationA security privileges 'ort#e re'erences are in#erited 'rom t#e security privileges de'ined 'or t#e parent application. You can c#ange security privileges

by 'ollo/ing t#e steps outlined in ssigning $ecurity rivileges 'or TM1 pplications and Re'erences to User ,roups.

+arent topic, dding TM1 b!ect Re'erences to an pplication


f 398 25-09-20





=.8.-. Simultaneousl Creating a *e! (b)ect and Adding a 'eference to anApplicationYou can create a ne/ I:MH CognosH TM1H ob!ect 'rom /it#in an application. TM1 creates t#e ne/ ob!ect on t#e server

/#ere t#e application residesA and inserts a private re'erence to t#e ob!ect in t#e application. You can create dimensionsA

cubesA processesA and c#ores 'rom /it#in an application.

+rocedure

In t#e $erver %&plorerA rig#t)clic6 t#e pplication 'rom /#ic# you /ant to create t#e ob!ectA and clic6 *e! (b)ect

tpeA on t#e s#ortcut menu. (or e&ampleA to create a ne/ cubeA clic6 *e!A Cube.

+#en you select an ob!ect typeA a dialog bo& or /indo/ opens. (or e&ampleA i' you clic6 *e!A CubeA t#e Creating Cubedialog bo& opens.

1.

Complete t#e procedure re9uired to create t#e type o' ob!ect you c#ose.

+#en you are doneA TM1 creates t#e ob!ect on t#e server and inserts a private re'erence to t#e ob!ect in t#e application.

T#e e&ample s#o/s t#e result o' creating t#e cube "e/ Cube 'rom /it#in t#e "ort# merican $ales application.

2.

+arent topic, dding TM1 b!ect Re'erences to an pplication


f 398 25-09-20



=.=. Adding File 'eferences to an ApplicationYou can add 'ile re'erences to I:MH CognosH TM1H applications 'or any type o' 'ile on your computer or net/or6A suc# as

%&celA +ordA o/erointA D(A or any ot#er 'ile.

*otes,

You can add a re'erence to any %&cel 'ile to an application. You are not restricted to /or6ing only /it# %&cel 'ilescontaining TM1 slices or ot#er TM1 'eatures.

(iles are opened /it# t#e program /it# /#ic# t#ey are associatedA as con'igured in t#e Microso't +indo/s 'ile type

settings. TM1 displays an icon 'or eac# 'ile based on t#is association.

+rocedure

In t#e $erver %&plorerA rig#t)clic6 t#e pplication to /#ic# you /ant to add t#e 'ile re'erenceA and clic6 Add File on t#es#ortcut menu.

T#e dd (ile dialog bo& opens.

1.

:ro/se to t#e directory containing t#e 'ile and select t#e 'ile you /ant to add to t#e application.2.

$elect an option t#at determines #o/ TM1 /ill add t#e 'ile to t#e application.

Attac te file as a reference ) 4eeps t#e 'ile in its current location and inserts a re'erence to t#e 'ile in t#e TM1application.

+#en a 'ile is added as a re'erenceA it displays as icon /it# an arro/ in TM1 . (or e&ampleA t#e icon 'or an %&cel 'ile t#at

is added using t#e ttac# t#e 'ile as a re'erence option loo6s li6e t#is in t#e TM1 application ob!ect tree.

T#e primary advantage o' t#is option is t#at any edits or modi'ications to t#e %&cel 'ile are immediately available in t#eapplication. I' you select t#is optionA t#e %&cel 'ile s#ould reside in a s#ared 'older and you s#ould navigate to t#e 'ilet#roug# your net/or6 to create a U"C pat# to t#e 'ile.

To maintain access to an attac#ed %&cel 'ile /#enever t#e I:M Cognos TM1 server is runningA t#e computer /#ere t#e'ile resides must be available on t#e net/or6.

Cop te file to te TM1 server ) Copies t#e 'ile to t#e TM1 server on /#ic# t#e application resides.

T#is type o' re'erence displays as an icon /it#out an arro/ in TM1 . (or e&ampleA an %&cel 'ile t#at is added using t#e

Copy t#e 'ile to t#e TM1 server option #as t#e 'ollo/ing icon in TM1 applications;

TM1 copies t#e uploaded 'iles to t#e %&ternals subdirectory o' t#e TM1 server data directory. (or e&ampleA i' you add an%&cel 'ile to an application on t#e sdata server t#at is part o' t#e sample TM1 databaseA TM1 saves t#e 'ile to

C;Krogram (ilesKCognosKTM1KCustomKTM1DataKsdataK%&ternals.

T#e primary advantage to t#is option is t#at t#e 'ile is available /#enever t#e TM1 server is running. *o/everA c#angesto t#e original source 'ile are not automatically re'lected in t#e 'ile on t#e TM1 server . You must update t#e 'ile on t#eserver to ma6e t#e c#anges available.

(or details on updating %&cel 'iles t#at #ave been copied to TM1 A see Updating %&cel (iles on t#e TM1 server.

(or details on updating non)%&cel 'iles t#at #ave been copied to TM1 A see Updating "on)%&cel (iles on t#e TM1server.

*ote, I' you select t#e Cop te file to te TM1 server optionA t#e 'ile you /ant to upload cannot be currently in useby anot#er program. I' you attempt to upload an open 'ileA TM1 displays an error message. Ma6e sure t#e 'ile is closedbe'ore uploading it to TM1 .

3.

$elect eit#er t#e +ublic or +rivate option.

+ublic ) Ma6es t#e 'ile re'erence available to ot#er users /#o #ave access to t#e TM1 application.

+rivate ) nly you can access t#e re'erence to t#e 'ile.

-.

Depending on #o/ TM1 is con'iguredA t#e +ublis to TM1 7eb c#ec6 bo& may appear on t#e Add File dialog bo&.

+#en t#is option is availableA TM1 re9uires you to e&plicitly select it i' you /ant to publis# an %&cel 'ile 'rom a TM1application to TM1 +eb. (or more detailsA see ublis#ing %&cel (iles to TM1 +eb /it#out Using %&cel on t#e TM1 +eb$erver.

I' t#is option is available and you /ant to publis# t#e selected %&cel 'ile to TM1 +ebA clic6 t#e +ublis to TM1 7eb

0.


f 398 25-09-20



c#ec6 bo&.

*ote, T#e +ublis to TM1 7eb c#ec6 bo& becomes enabled only a'ter you clic6 on an %&cel 'ile.

Clic6 (pen.

T#e 'ile is no/ available 'rom /it#in t#e TM1 application.

You can also access 'iles in TM1 applications 'rom TM1 +eb. (or detailsA see t#e 'ollo/ing sections later in t#is section;

ublis#ing TM1 pplications and Re'erences.

ublis#ing TM1 pplications to TM1 +eb.

.

%nderstanding +ublic and +rivate File 'eferences

I:M Cognos TM1 uses t#e 'ollo/ing icon 'ormats to visually identi'y public and private 'ile re'erences in TM1 applications.

@eavior of Files %ploaded to te TM1 server

n uploaded 'ile is any 'ile t#at is added to an I:M Cognos TM1 application using t#e Cop te file to te TM1 server

option.

%pdating /cel Files on te TM1 server

%pdating *on"/cel Files on te TM1 server

You can update a non)%&cel 'ile t#at #as been uploaded to t#e I:M Cognos TM1 server by saving t#e 'ile as an e&ternal'ile and t#en manually re)adding t#e 'ile to t#e server.



f 398 25-09-20



=.=.1. %nderstanding +ublic and +rivate File 'eferencesI:MH CognosH TM1H uses t#e 'ollo/ing icon 'ormats to visually identi'y public and private 'ile re'erences in TM1

applications.

Icon Description

ublic re'erence to a 'ile t#at /as added to TM1 as a re'erence.

rivate re'erence to a 'ile t#at /as added to TM1 as a re'erence.

ublic re'erence to a 'ile copied to t#e TM1 server .

rivate re'erence to a 'ile copied to t#e TM1 server .

+arent topic, dding (ile Re'erences to an pplication


f 398 25-09-20





=.=.-. %pdating /cel Files on te TM1 server

I:MH CognosH TM1H provides a dedicated process to !ust update %&cel 'iles t#at #ave been uploaded to t#e I:M CognosTM1 server . (or details on updating non&%&cel 'iles ?+ordA o/erointA or ot#er 'ile types@ see Updating "on)%&cel (iles ont#e TM1 server.

+rocedure

Double)clic6 t#e 'ile in t#e $erver %&plorer.

T#e 'ile opens in %&cel /it# a temporary 'ile name suc# as TM12C0D.&ls displayed in t#e title bar.

*ote, It is important to remember t#e original name o' t#e 'ile you are updating ?as opposed to t#e temporary 'ilename@. You /ill need to select t#e original 'ile later in step -.

1.

pply your edits to t#e %&cel document.2.

Clic6 TM1 A Save 7or#boo# on TM1 Server A %pdate /isting Application File on TM1 Server .

T#e $elect TM1 %&ternal (ile to Update dialog bo& opens.

3.

$elect t#e original %&cel 'ile you /ant to update.

:e sure to select t#e original %&cel 'ile you opened in $tep 1. I' you select any ot#er 'ileA TM1 /ill over/rite t#at selected'ile /it#out /arning.

-.

Clic6 (<.

TM1 updates t#e 'ile on t#e TM1 server . T#e %&cel 'ile is available 'rom /it#in its parent application.

0.



f 398 25-09-20



=.=.8. %pdating *on"/cel Files on te TM1 serverYou can update a non)%&cel 'ile t#at #as been uploaded to t#e I:MH CognosH TM1H server by saving t#e 'ile as an e&ternal

'ile and t#en manually re)adding t#e 'ile to t#e server.

+rocedure

Double)clic6 t#e 'ile in t#e $erver %&plorer.

T#e 'ile opens in t#e associated program /it# a temporary 'ile name suc# as TM13.doc displayed in t#e title bar.

(or e&ampleA an uploaded +ord 'ile opens in Microso't +ord.

1.

Using t#e program associated /it# t#e 'ileA ma6e your c#anges to t#e 'ile and t#en use t#e programs Save As 'eature tosave t#e 'ile to a ne/ location and 'ilename.

*ote, Remember t#e name and location o' t#e ne/ updated 'ile so you can add it bac6 into TM1 in t#e ne&t step.

2.

In $erver %&plorerA rig#t)clic6 on t#e old version o' t#e 'ile and clic6 Delete.

TM1 displays t#e Confirm Delete dialog so you can delete t#e old 'ile.

3.

Re)add t#e updated 'ile using t#e steps described in dding (ile Re'erences to an pplication.-.



f 398 25-09-20



=.>. Adding %'2 'eferences to an ApplicationYou can add a UR8 address to an application 'or any o' t#e 'ollo/ing UR8 protocols;

#ttp;

#ttps;

+#en you open a UR8 re'erence in an I:MH CognosH TM1H application 'rom /it#in TM1 $erver %&plorerA or TM1 +ebA t#etarget source o' t#e UR8 displays in your systems de'ault /eb bro/ser.

+rocedure

In t#e $erver %&plorerA rig#t)clic6 t#e pplication to /#ic# you /ant to add t#e UR8 re'erenceA and clic6 Add %'2 on t#es#ortcut menu.

T#e dd UR8 dialog opens.

1.

%nter a complete UR8A including t#e #ttp; or #ttps; protocol.

(or e&ample; #ttp;///.Company.com

2.

%nter a descriptive name 'or t#e UR8.

(or e&ample; Company +eb $ite

3.

Clic6 (< to add t#e UR8.

T#e UR8 is added to t#e TM1 applicationA using your systems de'ault icon 'or a UR8 lin6.

-.



f 398 25-09-20





=.?.1. 9ie!ing TM1 Application +roperties(ollo/ t#ese steps to vie/ t#e properties o' re'erences and sub)applications in an I:MH CognosH TM1H application.

+rocedure

$elect t#e application in t#e $erver %&plorer.1.

I' t#e +roperties pane is not visible in t#e $erver %&plorerA clic6 DisplaA +roperties 7indo! .

T#e +roperties pane displays in'ormation about all re'erences and sub)applications to /#ic# you #ave at least Read

access. Re'erences and sub)applications to /#ic# you #ave "one access do not appear in t#e $erver %&plorerA so youcannot vie/ t#e properties o' t#ese items.

nly immediate sub)applications o' t#e selected TM1 application appear in t#e roperties pane.

2.

To sort items in t#e +roperties pane alp#abetically by property valueA clic6 t#e column label to /#ic# you /ant to applyt#e sort. (or e&ampleA to sort items alp#abetically by current statusA clic6 t#e Status column label.

(or eac# re'erence and sub)applicationA t#e 'ollo/ing properties display.

+ropert Description

"ame T#e name o' t#e re'erence or sub)application as it appears in t#e selected application.

You can edit re'erence namesA /#ic# do not #ave to directly correspond to source ob!ectnames. (or e&ampleA in t#e 'igure aboveA t#e rice re'erence re'ers to t#e source cubenamed riceCube.

$ystem "ame (or most re'erencesA $ystem "ame is t#e actual name o' t#e source ob!ect to /#ic# are'erence points.

(or 'iles t#at #ave been uploaded to t#e I:M Cognos TM1 server A $ystem "ame is t#ename assigned to t#e 'ile on t#e TM1 server . "aming conventions 'or 'iles uploaded tot#e TM1 server are described in :e#avior o' (iles Uploaded to t#e TM1 server.

(or 'iles t#at are attac#ed as a re'erenceA $ystem "ame is t#e U"C pat# to t#e 'ile.

T#e $ystem "ame property does not apply to sub)applications.

$erver T#e TM1 server on /#ic# t#e source ob!ect 'or a re'erence resides.

(or e&ampleA in t#e above image t#e source cube 'or t#e Currency re'erence resides on t#einventory server.

rivate T#is property applies only to subsets and vie/s.

T#e rivate property indicates /#et#er t#e source 'or a subset or vie/ re'erence is aprivate ob!ect. property value o' Yes indicates t#at t#e source is a private ob!ect. "oindicates a public ob!ect.

(or e&ampleA in t#e image aboveA t#e sources 'or t#e "ort# merican Currencies subsetre'erenceA as /ell as t#e "ort# merican rice lan and "ort# merican Models vie/sA are

all private ob!ects.

$tatus T#is property indicates t#e current availability o' re'erences and sub)applications. T#ere aret#ree possible $tatus values;

Available ) T#e re'erence or sub)application is available 'or use.

*ot Connected ) You are not connected to t#e TM1 server on /#ic# t#e source ob!ect'or t#e re'erence resides. 8og in to t#e server to restore your access to t#e re'erence.

*ot Available ) T#e TM1 server on /#ic# t#e source ob!ect 'or t#e re'erence resides isnot runningA and t#ere'ore you cannot access t#e re'erence.

3.


f 398 25-09-20



+ropert Description

$ecurity T#is property indicates your security privilege 'or a re'erence or sub)application.

+arent topic, +or6ing /it# b!ectA (ileA and UR8 Re'erences in TM1 pplications


f 398 25-09-20



=.?.$. Deleting (b)ect6 File6 and %'2 'eferences from TM1 Applications(ollo/ t#ese steps to delete an ob!ect re'erence 'rom an I:MH CognosH TM1H application.

+rocedure

Rig#t)clic6 t#e ob!ect re'erence in t#e application.

*ote, You must select t#e ob!ect re'erence in t#e application. I' you select t#e source ob!ect else/#ere in t#e server#ierarc#yA you cannot delete t#e ob!ect 'rom t#e application.

1.

Clic6 Application ItemA Delete.

To delete a 'ile or UR8 re'erence 'rom an application;

Rig#t)clic6 t#e 'ile in t#e application.

Clic6 Delete.

2.



f 398 25-09-20





=.?.8. Deleting Source (b)ects tat are 'eferenced b TM1 Applications+#en you delete a source ob!ect t#at is re'erenced by an I:MH CognosH TM1H applicationA TM1 does not delete t#e

corresponding ob!ect re'erence 'rom t#e application.

(or e&ampleA i' you delete t#e Canada $ales vie/ 'rom t#e data serverA t#e re'erence to t#e Canada $ales vie/ remains int#e "ort# merican $ales application.

I' you attempt to open an ob!ect or 'ile re'erence in an applicationA and t#e source 'or t#e ob!ect or 'ile #as been deleted'rom t#e I:M Cognos TM1 server A TM1 displays an error messageA stating t#at t#e ob!ect U$ $ales on server sdata cannot

be 'ound and prompts you to delete t#e re'erence.+#en t#e source 'or an ob!ect or 'ile in an application #as been deleted 'rom t#e serverA you s#ould delete t#e correspondingre'erence 'rom t#e application. (or detailsA see Deleting b!ectA (ileA and UR8 Re'erences 'rom TM1 pplications.



f 398 25-09-20



=.E. Administering Securit for TM1 ApplicationsT#e 'ollo/ing sections describe #o/ to assign security privileges 'or I:MH CognosH TM1H applications and re'erences to

user groups on t#e I:M Cognos TM1 serverA as /ell as #o/ to publis# and privati7e TM1 applications and re'erences.

Assigning Securit +rivileges for TM1 Applications and 'eferences to %ser GroupsYou can assign security privileges 'or public items ?eit#er re'erences or sub)applications@ /it#in public I:M Cognos TM1applications to user groups on t#e I:M Cognos TM1 server . You must #ave dmin privilege to an application to assignsecurity to items /it#in t#e application.

+ublising TM1 Applications and 'eferencesT#e 'ollo/ing sections describe #o/ to publis# I:M Cognos TM1 applications and re'erences. To determine t#e securityprivileges re9uired to per'orm t#ese proceduresA see $ecurity Considerations 'or Creating and 5ie/ing pplications.

+rivatiing TM1 Applications and 'eferences

You can privati7e public I:M Cognos TM1 applications and re'erences. +#en you ma6e an application or re'erenceprivateA only you can access t#e item.



f 398 25-09-20



=.E.1. Assigning Securit +rivileges for TM1 Applications and 'eferences to %serGroupsYou can assign security privileges 'or public items ?eit#er re'erences or sub)applications@ /it#in public I:MH CognosH TM1H

applications to user groups on t#e I:M Cognos TM1 server . You must #ave dmin privilege to an application to assign

security to items /it#in t#e application.

You cannot assign security 'or private applications and re'erencesJ only t#e user /#o creates a private item can access t#eitem.

+rocedure

In t#e $erver %&plorerA rig#t)clic6 t#e TM1 application t#at contains t#e items to /#ic# you /ant to assign security.1.

Clic6 SecuritA Securit Assignments.

T#e $ecurity ssignments /indo/ opens. T#e /indo/ lists all public items ?TM1 ob!ectsA 'ilesA UR8sA andsub)applications@ t#at reside in t#e current application.

2.

$elect t#e cell at t#e intersection o' t#e item 'or /#ic# you /ant to de'ine security and t#e user group to /#ic# you /antto assign security.

3.

Clic6 one o' t#e available security privileges.

Securit +rivilege As applied to TM1 applications As applied to references

"one Members o' t#e user group cannot see t#e applicationor its contents.

Members o' t#e user group cannotsee t#e re'erence.

Read Members o' t#e user group can see t#e applicationand use any re'erences /it#in t#e application to /#ic#t#e group #as at least Read privilege. Members canalso create private re'erences in t#e application.

Members o' t#e user group can uset#e re'erence.

dmin Members o' t#e user group can see t#e applicationAuse re'erences /it#in t#e applicationA and create bot#public and private re'erences in t#e application. T#ey

can also create private sub)applications.

Members /it# dmin privilege to an application canset security privileges 'or all re'erences andsub)applications /it#in t#e application.

Members o' t#e user group can uset#e re'erence. T#ey can also updateor delete t#e re'erence. T#ey can

publis# private re'erencesA andprivati7e public re'erences.

-.

Repeat steps 3 and - 'or any ot#er items 'or /#ic# you /ant to de'ine security.0.

Clic6 (<..

'esults

(or any given user groupA it is possible to assign t#e R%D or DMI" privilege to a re'erence /#en t#e privilege assigned to

t#e ob!ect associated /it# t#e re'erence is ""%. In t#is scenarioA members o' t#e user group /ill not be able to see t#e

re'erence in an application.

(or e&ampleA i' a user group is assigned ""% privilege 'or a cubeA but R%D privilege 'or a re'erence to t#e same cubeAmembers o' t#e user group /ill not see t#e re'erence to t#e cube in an application.

+arent topic, dministering $ecurity 'or TM1 pplications


f 398 25-09-20





=.E.$.1. +ublising +rivate TM1 applications(ollo/ t#ese steps to publis# a private application.

+rocedure


Clic6 SecuritA Ma#e +ublic.

*ote, +#en you publis# a private applicationA I:MH CognosH TM1H also publis#es all private re'erences to public

ob!ects /it#in t#e application.

2.

+arent topic, ublis#ing TM1 pplications and Re'erences


f 398 25-09-20



=.E.$.$. +ublising +rivate 'eferences to +ublic (b)ectsYou can publis# private re'erences t#at reside in public applications

+rocedure

Rig#t)clic6 t#e re'erence in t#e $erver %&plorer.1.

$elect Application ItemA SecuritA Ma#e +ublic.2.

+arent topic, ublis#ing TM1 pplications and Re'erences


f 398 25-09-20



=.E.-. +rivatiing TM1 Applications and 'eferencesYou can privati7e public I:MH CognosH TM1H applications and re'erences. +#en you ma6e an application or re'erence

privateA only you can access t#e item.

+rivatiing a +ublic TM1 Application(ollo/ t#ese steps to privati7e a public application.

+rivatiing a +ublic 'eference

(ollo/ t#ese steps to privati7e a public re'erence.

+arent topic, dministering $ecurity 'or TM1 pplications


f 398 25-09-20



=.E.-.1. +rivatiing a +ublic TM1 Application(ollo/ t#ese steps to privati7e a public application.

+rocedure


$elect SecuritA Ma#e +rivate.

+#en you privati7e a public applicationA all public re'erences /it#in t#e application are automatically privati7ed as /ell.

I' a public application contains identically named re'erences to a single ob!ect typeA one public and one privateA t#e string ]ublic is appended to t#e public re'erence /#en t#e application is privati7ed.

(or e&ampleA t#e 'ollo/ing image s#o/s t#e %uropean $ales applicationA /#ic# contains t/o re'erences to vie/s named"ort#ern %urope $alesA one public and one private.

+#en you privati7e t#e %uropean $ales applicationA t#e public re'erence is converted to a private re'erence and its nameis c#anged to "ort#ern %urope $ales]ublicA indicating t#at t#is is a private re'erence to a public ob!ect.

T#e name c#ange is necessary because an application cannot contain t/o identically named private re'erences to asingle ob!ect type.

2.

+arent topic, rivati7ing TM1 pplications and Re'erences


f 398 25-09-20



=.E.-.$. +rivatiing a +ublic 'eference(ollo/ t#ese steps to privati7e a public re'erence.

+rocedure

Rig#t)clic6 t#e re'erence in t#e $erver %&plorer.1.

$elect Application ItemA SecuritA Ma#e +rivate.2.

+arent topic, rivati7ing TM1 pplications and Re'erences


f 398 25-09-20



=.O. 9ie!ing 2ogical Groupings in TM1 Applicationsne o' t#e primary advantages o' I:MH CognosH TM1H applications is t#at t#ey let you vie/ and manage ob!ects and 'iles

in logical groupings. T#is simpli'ies t#e tas6 o' using TM1 A because you can easily identi'y and locate 'iles and ob!ects in

!ob)speci'ic applications /it#out #aving to scan t#roug# large lists o' ob!ects arranged by type.

To 'urt#er simpli'y t#e use o' TM1 A you can suppress t#e display o' ob!ects by type. T#is yields a cleanerA more easilynavigated display in t#e $erver %&plorer. ?:y de'aultA all ob!ect types are displayed in t#e $erver %&plorer.@

To suppress t#e display o' a particular type o' ob!ectA clic6 9ie!A (b)ect tpe 'rom t#e $erver %&plorer. T#is clears t#e

c#ec6 mar6 ne&t to t#e ob!ect type in t#e 5ie/ menu and suppresses t#e display o' t#e ob!ect type in t#e $erver %&plorer. Int#e 'ollo/ing sampleA all ob!ects are suppressed e&cept 'or pplications.

*ote, +#en you suppress t#e display o' a given ob!ect type in t#e $erver %&plorerA re'erences to ob!ects o' t#at type still

appear /it#in TM1 applications. *o/everA control ob!ects are suppressed /it#in applications /#en t#e display o' control

ob!ects is suppressed in t#e $erver %&plorer.



f 398 25-09-20



=.10. +ublising TM1 Applications to TM1 7ebll re'erences to cubesA vie/sA 'ilesA and UR8s in I:MH CognosH TM1H applications are automatically available in TM1 +eb.

*ote, I' your installation o' TM1 +eb is con'igured to run /it#out Microso't %&cel on t#e +eb serverA you must e&plicitly

publis# all %&cel 'iles in TM1 applications to TM1 +eb i' you /ant t#e %&cel 'iles to be available as TM1 +ebs#eets. (or more

detailsA ublis#ing %&cel (iles to TM1 +eb /it#out Using %&cel on t#e TM1 +eb $erver.

ssume "ort# merican $ales is a public application t#at contains re'erences to a collection o' TM1 ob!ects and %&cel 'iles.+#en you access t#e sdata I:M Cognos TM1 server t#roug# TM1 +ebA t#ese re'erences are displayed under pplications.

+#en /or6ing in TM1 +ebA you can clic6 on a re'erence to open and display it as 'ollo/s;

Cubes and vie/s display directly in TM1 +eb.

%&cel 'iles display as TM1 +ebs#eets directly in TM1 +eb.

*ote, %&cel 'iles t#at #ave been protected t#roug# t#e %&cel commandA ToolsA +rotectionA cannot be accessed t#roug#TM1 +eb.

"on)%&cel 'iles open and display in t#eir associated program.

*ote, $ome 'ile types and programs may not be vie/able 'rom TM1 +eb.

UR8 re'erences open and display in a separate /eb bro/ser.

(or e&ampleA clic6 on an %&cel 'ile to open it in TM1 +ebs#eet 'ormat.

*ote, TM1 determines t#e column /idt#s o' t#e +ebs#eet based on t#e %&cel 'ile 'rom /#ic# t#e +ebs#eet is generated. I'

t#e columns in t#e %&cel 'ile do not accommodate t#e 'ull display o' ro/ and column labelsA t#e corresponding labels in t#e

+ebs#eet are truncated.

You can access bot# public and private applications and re'erences t#roug# TM1 +eb. nly t#e user /#o creates a privateapplication or re'erence can access t#e item t#roug# TM1 +eb. ccess to public applications and re'erences in TM1 +eb isdetermined by t#e security privileges de'ined 'or t#e source applications and re'erences on t#e TM1 server . (or details onsetting security privilegesA see ssigning $ecurity rivileges 'or TM1 pplications and Re'erences to User ,roups.

Setting TM1 7ebseet +roperties

+ebs#eet properties are con'igured in $erver %&plorer to control #o/ an %&cel 'ile appears and be#aves /#en vie/ed asa +ebs#eet in I:M Cognos TM1 +eb.

+ublising /cel Files to TM1 7eb !itout %sing /cel on te TM1 7eb Server

I' your installation o' I:M Cognos TM1 +eb is con'igured to run /it#out Microso't %&cel on t#e +eb serverA you muste&plicitly publis# all %&cel spreads#eet 'iles in TM1 applications to TM1 +eb i' you /ant t#e %&cel 'iles to be available asTM1 +ebs#eets. $imilarlyA any time you c#ange an %&cel 'ile t#at #as been previously publis#ed to TM1 +ebA you mustrepublis# t#e 'ile to ma6e t#e c#anges available in t#e +ebs#eet.

Creating 3perlin#s to %ploaded FilesI' you /ant a +ebs#eet to contain a #yperlin6 to an uploaded 'ileA t#e #yperlin6 must include t#e location and name t#atI:M Cognos TM1 assigns to t#e uploaded 'ile.

9ie!ing 7ebseets tat Contain te 01A 3eadecimal Caracter

I:M Cognos TM1 +eb cannot open a +ebs#eet t#at contains t#e &1 #e&adecimal c#aracter. I' you attempt to open a+ebs#eet containing t#e &1 #e&adecimal c#aracterA TM1 +eb issues t#e 'ollo/ing error;



f 398 25-09-20



=.10.1. Setting TM1 7ebseet +roperties+ebs#eet properties are con'igured in $erver %&plorer to control #o/ an %&cel 'ile appears and be#aves /#en vie/ed as a

+ebs#eet in I:MH CognosH TM1H +eb.

+rocedure

In t#e $erver %&plorerA open t#e TM1 application containing t#e %&cel 'ile 'rom /#ic# t#e TM1 +ebs#eet is generated.1.

Rig#t)clic6 t#e %&cel 'ile.2.

Clic6 +roperties.

T#e TM1 +eb roperties dialog bo& opens.

3.

Use t#e options on t#e General and Displa +roperties tabs to set properties 'or t#e TM1 +ebs#eet.

(or details on t#e TM1 +eb roperties optionsA see t#e I:M Cognos TM1 User Guide.

-.

Clic6 (<.0.

+arent topic, ublis#ing TM1 pplications to TM1 +eb


f 398 25-09-20



=.10.$. +ublising /cel Files to TM1 7eb !itout %sing /cel on te TM1 7ebServerI' your installation o' I:MH CognosH TM1H +eb is con'igured to run /it#out Microso't %&cel on t#e +eb serverA you must

e&plicitly publis# all %&cel spreads#eet 'iles in TM1 applications to TM1 +eb i' you /ant t#e %&cel 'iles to be available as TM1

+ebs#eets. $imilarlyA any time you c#ange an %&cel 'ile t#at #as been previously publis#ed to TM1 +ebA you must republis#

t#e 'ile to ma6e t#e c#anges available in t#e +ebs#eet.

(or details about t#is con'igurationA see t#e %&cel+ebublis#%nabled parameter in t#e I:M Cognos TM1 Operations Guide.

*ote, You cannot publis# %&cel 2 .&ls& 'iles to TM1 +eb /#en %&cel is not available on t#e +eb server. T#ese 'iles mustbe saved in %&cel 23 .&ls 'ormat i' you /ant to publis# t#em to TM1 +eb.

T#ere are several met#ods 'or publis#ing %&cel 'iles to TM1 +eb. You can;

$imultaneously add an %&cel 'ile to an application and publis# to TM1 +eb

ublis# individual %&cel 'iles t#at e&ist /it#in an application to TM1 +eb

ublis# all %&cel 'iles /it#in an application to TM1 +eb

Simultaneousl Adding an /cel File to an Application and +ublising to TM1 7eb

+#en you initially add an %&cel ' ile to an applicationA you can c#oose to simultaneously publis# t#e 'ile to I:M CognosTM1 +eb. T#is option becomes available /#en t#e con'iguration parameter ExcelWebPublishEnabled is set to true.

Deleting an /cel File from TM1 7eb

You can also delete an %&cel 'ile t#at #as previously been publis#ed to I:M Cognos TM1 +eb. +#en you delete an %&cel'ile 'rom TM1 +ebA t#e +ebs#eet is no longer available in TM1 +eb but t#e source %&cel 'ile remains in t#e TM1application.

%pdating /cel Files in TM1 Applications

To update a Microso't %&cel 'ile t#at #as been previously publis#edA c#oose t#e 'ollo/ing option 'rom t#e %&cel toolbar;TM1 A Save 7or#boo# on TM1 server A %pdate /isting Application File on TM1 server .



f 398 25-09-20



=.10.$.1. Simultaneousl Adding an /cel File to an Application and +ublising toTM1 7eb+#en you initially add an %&cel 'ile to an applicationA you can c#oose to simultaneously publis# t#e 'ile to I:MH CognosH

TM1H +eb. T#is option becomes available /#en t#e con'iguration parameter ExcelWebPublishEnabled is set to true.

T#ere are t/o /ays to add an %&cel 'ile to an application;

(rom rc#itect$erver %&plorer ) Rig#t)clic6 an application and c#oose Add File.

(rom TM1 erspectives ) C#oose TM1 A Save 7or#boo# on TM1 server A %pload *e! Application File to TM1server and t#en select an application 'older.

Regardless o' /#ic# met#od you useA TM1 displays a dialog bo& /it# an option to publis# t#e 'ile to TM1 +eb /#ile addingt#e 'ile to an application.

*ote, T#e +ublis to TM1 7eb c#ec6 bo& becomes enabled only a'ter you clic6 on an %&cel .&ls 'ile.

You can c#oose to publis# or not publis# t#e %&cel 'ile to TM1 +eb as 'ollo/s;

$elect t#e +ublis to TM1 7eb option to publis# t#e %&cel 'ile to TM1 +eb.

Clear t#e +ublis to TM1 7eb option to add t#e %&cel 'ile to t#e application but not publis# t#e 'ile to TM1 +eb.

+arent topic, ublis#ing %&cel (iles to TM1 +eb /it#out Using %&cel on t#e TM1 +eb $erver


f 398 25-09-20





=.10.$.-. %pdating /cel Files in TM1 ApplicationsTo update a Microso't %&cel 'ile t#at #as been previously publis#edA c#oose t#e 'ollo/ing option 'rom t#e %&cel toolbar; TM1 A

Save 7or#boo# on TM1 server A %pdate /isting Application File on TM1 server .

You can simultaneously republis# t#e updated %&cel 'ile to TM1H +eb by selecting t#e +ublis File to TM1 7eb option.

(or more details on updating %&cel 'ilesA see Updating %&cel (iles on t#e TM1 server.

*ote, I' you update an %&cel 'ile t#at #as previously been publis#ed to I:MH CognosH TM1 +ebA but do not select t#e

+ublis File to TM1 7eb optionA t#e 'ile in t#e application /ill di''er 'rom t#e 'ile available in TM1 +eb. T#ere is no visual

indication in t#e $erver %&plorer to alert you t#at a 'ile #as been updated in an application but #as not been republis#ed to

TM1 +eb.

+arent topic, ublis#ing %&cel (iles to TM1 +eb /it#out Using %&cel on t#e TM1 +eb $erver


f 398 25-09-20



=.10.-. Creating 3perlin#s to %ploaded FilesI' you /ant a +ebs#eet to contain a #yperlin6 to an uploaded 'ileA t#e #yperlin6 must include t#e location and name t#at

I:MH CognosH TM1H assigns to t#e uploaded 'ile.

+#en you add an uploaded 'ile to a TM1 applicationA a copy o' t#e 'ile is saved on t#e I:M Cognos TM1 server and t#e 'ilename is appended /it# a data and time stamp. (or e&ample;

Report_2006.xls_20070123212746.xls

I' you do not include t#e TM1 assigned 'ile name in t#e #yperlin6A t#e lin6 does not /or6 in TM1 +eb and an error displaysA

'or e&ampleA

(ile does not e&ist; TM1;planning sampleblobU:8IC.K%&ternalsKupload]test]2.&ls.

+rocedure

In $erver %&plorerA use t#e +roperties pane to 'ind t#e Sstem *ameA /#ic# is TM1 assigned name 'or t#e uploaded%&cel 'ile t#at /ill be t#e target o' t#e #yperlin6.

1.

Create t#e #yperlin6 to t#e uploaded %&cel 'ile using t#e 'ollo/ing 'ormat;

TM1://ServerName/blob/PUBLIC/.\}Externals\

TM1_Filename

/#ere;

!erverame is t#e TM1 sever name /#ere t#e %&cel 'ile is located.

T"'#(ilename is t#e name t#at TM1 assigned to t#e uploaded %&cel 'ile.

(or e&ample;

TM1://sdata/blob/PUBLIC/.\}Externals\Report_2006.xls_20070123212746.xls

2.

In %&celA add t#e #yperlin6 to t#e /or6s#eet /#ere you /ant t#e lin6 to e&ist.3.

dd t#e /or6s#eet to a TM1 application and t#en vie/ t#e 'ile as a +ebs#eet in TM1 +eb.-.



f 398 25-09-20



=.10.8. 9ie!ing 7ebseets tat Contain te 01A 3eadecimal CaracterI:MH CognosH TM1H +eb cannot open a +ebs#eet t#at contains t#e &1 #e&adecimal c#aracter. I' you attempt to open a

+ebs#eet containing t#e &1 #e&adecimal c#aracterA TM1 +eb issues t#e 'ollo/ing error;

%rror occurred /#ile converting t#e M$ %&cel /or6boo6 into EM8 'ormat ; A #e&adecimal value &1A is an invalid c#aracter.8ine 0-A position 3-.

I' you remove t#e &1 #e&adecimal c#aracter 'rom t#e +ebs#eetA t#e 'ile /ill open in TM1 +eb.

*ote, T#e $CIIutput TurboIntegrator 'unction places t#e &1 #e&adecimal c#aracter at t#e end o' all generated 'iles. I'

you use $CIIutput to e&port TM1 data to an $CII 'ile and t#en attempt to open t#e 'ile in t#e TM1 +ebs#eetA you /ill

encounter t#is error.



f 398 25-09-20



>. Importing Data !it +rocessing 7or#seetsT#is section describes #o/ to import data into an I:MH CognosH TM1H cube using a processing /or6s#eet. processing

/or6s#eet is a modi'ied %&cel /or6s#eet in /#ic# you use TM1 'unctions to send values to a location in an e&isting cube.

*ote, rocessing /or6s#eetsA /#ile a valid means o' importing dataA are deprecated 'unctionality in t#e current TM1 release.

+e strongly recommend using TurboIntegrator to import data into TM1 cubes.

T#e 'ollo/ing topics are described in t#is section.

rocessing +or6s#eets vervie/

Importing Data Using rocessing +or6s#eets

+rocessing 7or#seets (vervie!

processing /or6s#eet is a modi'ied %&cel /or6s#eet in /#ic# you use 'unctions to send input values to a location in ane&isting TM1 cube.

Importing Data %sing +rocessing 7or#seets

You can create a processing /or6s#eet to per'orm t#e 'ollo/ing tas6s;


f 398 25-09-20



>.1. +rocessing 7or#seets (vervie! processing /or6s#eet is a modi'ied %&cel /or6s#eet in /#ic# you use 'unctions to send input values to a location in an

e&isting TM1H cube.

You can use processing /or6s#eets to convert input values t#at do not map directly to e&isting elements. (or e&ampleA in t#e'ollo/ing tableA t#e 'irst t/o columns contain codes t#at do not directly correspond to elements in t#e cube to /#ic# valuesare being sent.

Scenario 'egion Model Measure Ran Feb Mar

1 R0- $ $eries 1.< 8 ... rice 2020B.B3 20<3. 20-1.B

2 R0- $ $eries 1.< 8 ... rice 2020B.B3 20<3. 20-1.B

1 R32 $ $eries 1.< 8 ... rice 2020B.B3 20<3. 20-1.B

2 R32 $ $eries 1.< 8 ... rice 2020B.B3 20<3. 20-1.B

1 R1 $ $eries 1.< 8 ... rice 2020B.B3 20<3. 20-1.B

2 R1 $ $eries 1.< 8 ... rice 2020B.B3 20<3. 20-1.B

1 R3 $ $eries 1.< 8 ... rice 2020B.B3 20<3. 20-1.B

2 R3 $ $eries 1.< 8 ... rice 2020B.B3 20<3. 20-1.B

In t#is e&ampleA t#e codes in t#e 'irst column represent elements in t#e ctvsbud dimension. :y using a simple I( 'unctionAyou can convert 1 to ctual and 2 to :udget.

T#e second column contains 'our region codesA /#ic# map to regions suc# as rgentinaA United $tatesA and ,reece. I' t#ese/ere t#e only valuesA you could /rite a nested I( 'ormula to convert t#e values to elements. s t#e number o' possiblevalues increasesA /riting a nested I( 'ormula can be cumbersome and error)prone. s an alternativeA you can create at/o)dimensional cube t#at serves as a loo6up table 'or retrieving element names.

+arent topic, Importing Data /it# rocessing +or6s#eets


f 398 25-09-20



>.$. Importing Data %sing +rocessing 7or#seetsYou can create a processing /or6s#eet to per'orm t#e 'ollo/ing tas6s;

Import data 'rom input ro/s t#at re9uire trans'ormations.

Update cubes but not create cubesA nor create consolidations.

Use as a staging area 'or importing data.

TM1H reads t#e input recordsA one at a timeA into t#e 'irst ro/ o' t#e processing /or6s#eetA and t#en sends t#e data valuesassociated /it# t#e record to a TM1 cube.

:eneat# t#e 'irst /or6s#eet ro/A a processing /or6s#eet includes;

Conversion instructions 'or values t#at map to element names but do not matc# element name spellings.

ny data trans'ormation calculations t#at modi'y data values be'ore importing.

Database $end ?D:$@ 'ormulas t#at map t#e input data to cells in t#e cube. %ac# 'ormula sends a value 'rom t#e 'irstro/ to a location in t#e cube identi'ied by one element in eac# dimension o' t#e cube.

*ote, You must use D:$ 'ormulasA not D:$+ 'ormulasA in processing /or6s#eets. You must use D:R 'ormulas rat#ert#an D:R+ 'ormulas in processing /or6s#eets.

t#er values in eac# input ro/ supply t#e element names directly or t#roug# conversion instructions.

T#e 'ollo/ing process summari7es t#e steps re9uired to import data;

Read in t#e 'irst input record into t#e processing /or6s#eet as an e&ample.

Compare t#e input /it# t#e cube structure.

Map t#e input values to element namesA i' necessary.

:uild a D:$ 'ormula 'or eac# input value t#at populates a cube cell.

rocess all input records.

'eading in te First Input 'o!You can use processing /or6s#eets to process data 'rom t#e 'ollo/ing data sources;

Comparing Input 'ecords !it a Cubes Structures

T#e e&amples in t#is manual process data into t#e sample $alesCube cubeA /#ic# #as t#e 'ollo/ing structure.

Converting %sing IF FormulasT#e 'irst column in price.cma contains a scenario codeA 1 'or actual and 2 'or budget. You can use t#e %&cel I('unction to convert t#e code to t#e name o' t#e corresponding element 'rom t#e ctvsbud dimension.

Converting %sing a 2oo#up Cube

Column :A t#e second input columnA supplies t#e codes t#at identi'y t#e 21 regions in /#ic# t#e car models are sold. (ore&ampleA R0- represents rgentina. To convert t#ese codes to element namesA you #ave t/o c#oices;

Creating Database Send 4D@S5 FormulasYou can create D:$ 'ormulas t#at send numeric data values to t#e cube because;

+rocessing a Data Source into a Cube

'ter you create a processing /or6s#eetA you can process data into a cube.

+arent topic, Importing Data /it# rocessing +or6s#eets


f 398 25-09-20





>.$.$. Comparing Input 'ecords !it a Cubes StructuresT#e e&amples in t#is manual process data into t#e sample $alesCube cubeA /#ic# #as t#e 'ollo/ing structure.

Dimension Sample /lements

ctvsbud ctualA :udget

Region rgentinaA :elgiumA United $tates

Model $ $eries 1.< 8 $edanA $ $eries 2. 8 $edan

ccount1 UnitsA $alesA rice

Mont# FanA (ebA MarA pr

To populate t#e $alesCube cubeA eac# record in t#e data source must contain t#e 'ollo/ing detail;

ne or more cell values.

"ames o' elements 'rom di''erent dimensions t#at identi'y t#e cell location 'or eac# imported valueA or input values t#atyou can map to element names.

T#e element in'ormation can be incomplete. (or e&ampleA /#en t#e source records contain multiple values 'or a singlemeasureA t#e measure is optional. You can supply t#e missing measure using a D:$ 'ormula.

Consider t#e 'ollo/ing recordA as it appears in a processing /or6s#eet. T#is record contains mont#ly price data 'or a singlecar model. Mapping t#is data to t#e $alesCube cube 'irst re9uires converting t/o input values to element names andsupplying missing element names.

8ets e&amine eac# input value;

Cell 1 contains a code t#at identi'ies t#e price data as actual or budget amounts. Code 1 represents ctualA and Code2 represents :udgetA /#ic# are t/o elements in t#e ctvsbud dimension. :y using t#e %&cel I( 'unctionA you canconvert t#ese values to element names.

Cell :1 supplies a region code t#at corresponds to an element name in t#e Region dimension. $uppose t#at t#e input #as21 region codes t#at re9uire conversion. To convert t#ese valuesA you can create a t/o)dimensional cube t#at serves asa loo6up table.

Cell C1 supplies car model namesA e&actly as 'ound in t#e Model dimension. "o conversion is re9uired.

Cells D1 t#roug# I1 supply t#e mont#ly data. You need to map t#is data to elements in t#e Mont# dimension.

Missing 'rom eac# source record is a cell containing riceA /#ic# is an element in t#e ccount1 dimension. You speci'y t#isvalue directly in t#e D:$ 'ormulas t#at send t#e data values to t#e cube.

+arent topic, Importing Data Using rocessing +or6s#eets


f 398 25-09-20



>.$.-. Converting %sing IF FormulasT#e 'irst column in price.cma contains a scenario codeA 1 'or actual and 2 'or budget. You can use t#e %&cel I( 'unction

to convert t#e code to t#e name o' t#e corresponding element 'rom t#e ctvsbud dimension.

+rocedure

Clic6 cell 3 o' t#e processing /or6s#eet.1.

%nter t#e 'ollo/ing 'ormula;

=IF(A1="001","Actual","Budget")

2.

Mapping %sing Fied 2abels

Cells D1 t#roug# 1 contain values t#at map to t#e 12 elements in t#e Mont# dimension ?Fan ) Dec@. :ecause t#eseinput columns al/ays map to t#e same mont#sA you can enter t#e element names directly in t#e processing /or6s#eet.



f 398 25-09-20



>.$.-.1. Mapping %sing Fied 2abelsCells D1 t#roug# 1 contain values t#at map to t#e 12 elements in t#e Mont# dimension ?Fan ) Dec@. :ecause t#ese input

columns al/ays map to t#e same mont#sA you can enter t#e element names directly in t#e processing /or6s#eet.

%lement names must e&actly matc# t#e spellings in t#e dimension. You can avoid misspelling names by copying t#em 'romt#e $ubset %ditor /indo/.

T#e 'ollo/ing steps illustrate #o/ to copy element names 'rom t#e $ubset %ditor /indo/.

+rocedure


Double)clic6 t#e Mont# dimension.


2.

$elect t#e t/elve mont#s Fan ) Dec in t#e Tree pane.3.

Clic6 /ditA +ic# /lementsA 3oriontal.-.

Return to t#e processing /or6s#eet.0.

Rig#t)clic6 cell D- and clic6 +aste.

TM1H pastes t#e element names #ori7ontally starting in cell D3.

.

+arent topic, Converting Using I( (ormulas


f 398 25-09-20



>.$.8. Converting %sing a 2oo#up CubeColumn :A t#e second input columnA supplies t#e codes t#at identi'y t#e 21 regions in /#ic# t#e car models are sold. (or

e&ampleA R0- represents rgentina. To convert t#ese codes to element namesA you #ave t/o c#oices;

Create a nested I( 'ormula. s t#e list o' codes increasesA t#is becomes a cumbersome c#oice.

Create a t/o)dimensional cube t#at serves as a loo6up cube 'or t#e region namesA and t#en retrieve t#e names using aD:R 'ormula.

+ell create a loo6up cube called Translate t#at contains t/o dimensionsA RegCodes and Reg"ame.

Importing %niue *ames

Using TurboIntegratorA you can create a dimension /#ose elements are uni9ue values 'rom an input column. In t#ise&ampleA t#e second column is price.cma.

Creating a 'eg*ame Dimension

(ollo/ t#ese steps to create t#e Reg"ame dimension /it# a single string element.

Creating te Translate Cube(ollo/ t#ese steps to create t#e Translate cube.

+opulating te Translate Cube

Using t#e Cube 5ie/erA you can no/ enter t#e corresponding region names 'or t#e region codes.

Creating te D@' FormulaYou can no/ create a D:R 'ormula t#at retrieves region names 'or eac# region code read into t#e processing /or6s#eet.



f 398 25-09-20



>.$.8.1. Importing %niue *amesUsing TurboIntegratorA you can create a dimension /#ose elements are uni9ue values 'rom an input column. In t#is e&ampleA

t#e second column is price.cma.

+rocedure


In t#e Tree paneA rig#t)clic6 +rocesses and clic6 Create *e! +rocess.

T#e TurboIntegrator dialog bo& opens.

2.

$peci'y an ASCII data source type.3.

Clic6 t#e Data $ource "ame @ro!se button and bro/se to t#e price.cma 'ile in your Kinstall]dirKdata directory.-.

Clic6 t#e 9ariables tab.0.

$peci'y a Content type o' Ignore 'or all columns e&cept t#e one t#at supplies t#e codes you /ant to import. In t#ise&ampleA column 2 ?identi'ied by a sample value o' R0-@ supplies t#e codes you /ant to import.

.

Clic6 t#e Maps tab..

$peci'y *o Action in bot# t#e Cube Action and Data Action sections o' t#e Cubes subtab.<.

Clic6 t#e Dimensions subtabA and do t#e 'ollo/ing;

Type Translate in t#e Dimension 'ield.

$elect Create 'rom t#e Action list.

$elect *umeric 'rom t#e /lement Tpe list.

B.

Clic6 FileA Save and save t#e process as create]RegCodes]dimension.1.

Clic6 FileA /ecute to create t#e RegCodes dimension.11.

'esults

RegCodes is no/ available as a dimension in t#e $erver %&plorer.

+arent topic, Converting Using a 8oo6up Cube


f 398 25-09-20



>.$.8.$. Creating a 'eg*ame Dimension(ollo/ t#ese steps to create t#e Reg"ame dimension /it# a single string element.

+rocedure


In t#e Tree paneA rig#t)clic6 Dimensions and clic6 Create *e! Dimension.

T#e Dimension /ditor opens.

2.

Clic6 /ditA Insert /lement.

T#e Dimension %lement Insert dialog bo& opens.

3.

Type *ame in t#e /lement *ame 'ield.-.

$elect String 'rom t#e /lement Tpe list.0.

Clic6 Add.

T#e *ame element no/ opens as a string element.

.

Clic6 (<..

Clic6 /ditA Save and save t#e dimension as Reg"ame.<.



f 398 25-09-20



>.$.8.-. Creating te Translate Cube(ollo/ t#ese steps to create t#e Translate cube.

+rocedure

Rig#t)clic6 Cubes in t#e $erver %&plorerA and clic6 Create ne! cube.

T#e Creating Cube /indo/ opens.

1.

Type Translate in t#e Cube *ame 'ield.2.

In t#e Available Dimensions bo&A double)clic6 'egCodes.

RegCodes moves to t#e Dimensions in ne/ cube bo&.

3.

In t#e Available Dimensions bo&A double)clic6 'eg*ame.

Reg"ame moves to t#e Dimensions in ne/ cube bo&.

-.

Clic6 (< to save t#e t/o)dimensional Translate cube.0.



f 398 25-09-20



>.$.8.8. +opulating te Translate CubeUsing t#e Cube 5ie/erA you can no/ enter t#e corresponding region names 'or t#e region codes.

T#e 'ollo/ing steps illustrate #o/ to populate t#e Translate cube /it# region names.

+rocedure

In t#e Tree pane o' t#e $erver %&plorer /indo/A double)clic6 Translate.

T#e Cube 5ie/er opens.

1.

ress (B to see t#e elements in eac# dimension o' t#e Translate cube.2.

%nter t#e region names t#at correspond to t#e region codesA using t#e table as your guide.

'egCode *ame

R0- rgentina

R32 :elgium

R00 :ra7il

R1: Canada

R0 C#ile

R-0 Denmar6

R33 (rance

R-B ,ermany

R-- ,reat :ritain

R3 ,reece

R303 Ireland

R3B Italy

R302 8u&emburg

R02 Me&ico

R31 "et#erlands

R- "or/ay

R301 ortugal

3.


f 398 25-09-20



'egCode *ame

R3- $pain

R- $/eden

R1 United $tates

R0B< Uruguay

Clic6 FileA Close to return to t#e $erver %&plorer.-.

In t#e $erver %&plorerA clic6 FileA Save Data All to save t#e cell values.0.



f 398 25-09-20



>.$.8.=. Creating te D@' FormulaYou can no/ create a D:R 'ormula t#at retrieves region names 'or eac# region code read into t#e processing /or6s#eet.

*ote, You must use D:R 'ormulasA not D:R+ 'ormulasA in processing /or6s#eets.

+rocedure

In t#e processing /or6s#eetA clic6 cell :3.1.

Clic6 TM1 A /dit Formula.

T#e %dit (ormula bar opens.

2.

Clic6 D@ 'ef .

T#e $elect Cube dialog bo& opens.

3.

Clic6 +ic#.

di''erent $elect Cube dialog bo& opens.

-.

$elect local,Translate and clic6 (<.

TM1H correctly assumes t#at t#e element 'rom t#e RegCodes dimension is in cell :1A but cannot 'ind an element 'orReg"ame and s#o/s it as unde'ined.

0.

Clic6 'eg*ame.

T#e $ubset %ditor opens.

.

$elect t#e element *ame and clic6 (<.

T#e regname 'ield no/ displays ic6ed.

.

Clic6 (< in t#e /dit 'eference to Translate dialog bo&.

T#e /dit Formula bar no/ displays t#e complete 'ormula;

=DBR("local:Translate", $B$1, "Name")

T#is 'ormula returns t#e value 'rom t#e Translate cube 'ound at t#e intersection o' t#e Regcodes element in cell :1 andt#e Regname element "ame.

<.

Clic6 (< to insert t#e 'ormula in cell :3.B.

'esults

Cell :3 no/ displays rgentinaA /#ic# is t#e correct region 'or t#e code R0-.



f 398 25-09-20





$ave t#e ricerocessing /or6s#eet.1-.

D@S SntaT#e D:$ 'unction uses t#e 'ollo/ing synta&;



f 398 25-09-20



>.$.=.1. D@S SntaT#e D:$ 'unction uses t#e 'ollo/ing synta&;

DBS (value, server:cube, e1, e2[,...en]):


value "umeric value t#at is sent to t#e cube.

server;cube T#e name o' t#e cube t#at receives t#e sent value. T#e cube name must be pre'i&ed /it# t#ename o' t#e server on /#ic# t#e cube residesA 'or e&ample sdata;$alesCube.

e16...en %lements t#at identi'y t#e cell location in t#e cube t#at receives t#e value. $peci'y t#eelement arguments in dimension order. (or e&ampleA e1 must be an element 'rom t#e 'irstdimension o' t#e cubeA e2 must be an element 'rom t#e second dimension o' t#e cube.

+arent topic, Creating Database $end ?D:$@ (ormulas


f 398 25-09-20



>.$.>. +rocessing a Data Source into a Cube'ter you create a processing /or6s#eetA you can process data into a cube.

I' you #ave been completing t#e e&ercises in t#is sectionA you 6no/ t#at t#e ricerocessing /or6s#eet processes pricevalues into t#e $alesCube cube.

You cannot use a processing /or6s#eet to /rite values to cube cells t#at are calculated by rulesA as you cannot edit rules)derived cell values.

You must 'irst veri'y t#at rice values in $alesCube are not derived by rules.

T#en you can process a data source into a cube.

+rocedure


Double)clic6 t#e SalesCube cube.2.

C#ec6 i' t#ere is a rule attac#ed to t#e cube. I' notA s6ip to step <.3.

I' a rule is attac#edA open t#e rule in t#e 'ules /ditor.-.

%&amine t#e rule to see i' rice is calculated by rules.

*ote, "ote t#at t#e rule includes t#e 'ollo/ing statement /#ic# calculates t#e value 'or rice at bot# t#e numeric andconsolidated levels;

['Price']=N:DB('PriceCube',!actvsbud,!region,!model,!month);C:['Sales']\['Units']*1000;

T#is statement calculates t#e value 'or rice at bot# t#e numeric and consolidated levels.

0.

Insert a pound sign ?^@ at t#e beginning o' bot# statements to disable t#e calculation o' rice.

#['Price']=N:DB('PriceCube',!actvsbud,!region,!model,!month);#C:['Sales']\

['Units']*1000;

.

$ave t#e rule.

You can no/ use t#e processing /or6s#eet to process t#e rice.cma source 'ile into $alesCube.

.

I' no rule is attac#edA open t#e processing /or6s#eet t#at contains t#e D:$ 'ormulas and any mapping instructions.

I' you 'ollo/ed t#e earlier e&amples in t#is sectionA open t#e ricerocessing processing /or6s#eet.

<.

Close any ot#er /or6s#eets.B.

Clic6 TM1 A +rocess DataA +rocess.

T#e $elect CubeA D:CA or (lat (ile dialog bo& opens.

1.

Clic6 Flat File.

T#e $elect Input (ile dialog bo& opens.

11.

$elect t#e rice.cma source'ile and clic6 (<.

TM1H processes t#e source 'ile. During t#e processA a progress bar displays.

TM1 se9uentially reads eac# record o' t#e source 'ile into t#e 'irst ro/ o' t#e processing /or6s#eet. T#e processing/or6s#eet recalculates a'ter eac# record is readA and t#e D:$ 'ormulas send t#e values in t#e 'irst ro/ to t#e

appropriate cell o' t#e cube.

12.

:ro/se $aleCubeA and note t#at t#e rice values #ave been updated by t#e values in rice.cma.13.



f 398 25-09-20



?. Controlling Access to TM1 (b)ectsT#is section describes #o/ you can limit access to ob!ects on an I:MH CognosH TM1H server 'or all I:M Cognos TM1

installationsA regardless o' t#e aut#entication met#od.

Assigning Securit 'igts to GroupsYou can assign ob!ect)level security 'or any non)administrative user group in TM1 . :y assigning security rig#ts togroupsA you can control a users access to TM1 ob!ects.

Interaction of Different (b)ect Securit 'igts

I' you apply di''erent security rig#ts to t#e ob!ects t#at identi'y a cell o' dataA TM1 applies t#e most restrictive securityrig#t to t#e cell.

Securing CubesYou can en#ance or restrict a groups access to individual cubes. +#en you create a ne/ cubeA ot#er groups initially #aveNone access to t#e ne/ cube. You must assign security rig#ts to t#e ne/ cube 'or ot#er groups.

Securing /lements

You can en#ance or restrict a groups access to individual elements using t#e /lement Securit Assignments dialogbo&.

Securing Dimensions

You can en#ance or restrict a groups access to individual dimensions.

Securing +rocessesYou can en#ance or restrict a groups access to individual TurboIntegrator processes.

Securing Cores

You can en#ance or restrict a groups access to individual c#ores.

Securing Applications and 'eferences

You can assign security privileges 'or public items ?re'erences or sub)applications@ /it#in public TM1 applications to usergroups on t#e I:M Cognos TM1 server . You must #ave Admin privilege to an application to assign security to items

/it#in t#e application.

Securing CellsCell)level security applies to a speci'ied cell and overrides all ot#er TM1 security. Cell)level security re9uires;


f 398 25-09-20



?.1. Assigning Securit 'igts to GroupsYou can assign ob!ect)level security 'or any non)administrative user group in TM1H . :y assigning security rig#ts to groupsA

you can control a users access to TM1 ob!ects.

*ote, You can not assign security rig#ts 'or t#e DMI"A Datadmin or $ecuritydmin groups. T#e rig#ts 'or t#ese groups are

prede'ined and appear disabled in t#e TM1 Securit Assignments dialog bo&.

"ote also t#at only t#e %nglis# versions o' t#e security)level entries are accepted. T#e 'ollo/ing 6ey/ords must be used aslisted #ere /#en manually entering security levels in t#e TM1 cell security control cube.

T#e ob!ect)level security rig#ts 'or TM1 groups are;

Admin ) ,roup #as complete access to a cubeA elementA dimensionA or ot#er ob!ect.

Lock ) ,roup can vie/ and edit a cubeA elementA dimensionA or ot#er ob!ect and can permanently loc6 ob!ects to prevent

ot#er users 'rom updating t#em.

Read ) ,roup can vie/ a cubeA elementA dimensionA processA or c#oreA but cannot per'orm operations on t#e ob!ect.

Reserve ) ,roup can vie/ and edit a cubeA elementA dimensionA or ot#er ob!ectA and can temporarily reserve ob!ects to

prevent ot#er users 'rom updating t#em.

Write ) ,roup can vie/ and update a cubeA elementA dimensionA processA or c#ore.

None ) ,roup cannot see a cubeA elementA dimensionA processA or c#oreA and cannot per'orm operations on t#e ob!ect.

T#e 'ollo/ing table describes t#e security rig#ts t#at you can assign to groups.

+rivilege (b)ect Description

Admin Cube Members o' t#e group can readA /riteA reserveA loc6A and delete t#e cube. T#ey cansave public cube vie/s. T#ey can also grant security rig#ts to ot#er users 'or t#isob!ect.

%lement Members o' t#e group can accessA updateA reserveA loc6A and delete t#e element.T#ey can also grant security rig#ts to ot#er users 'or t#is ob!ect.

Dimension Members o' t#e group can addA removeA and reorder elements in t#e dimensionA andcan reserve or loc6 t#e dimension. T#ey can save public dimension subsets. T#ey canalso grant security rig#ts to ot#er users 'or t#is ob!ect.

pplication Members o' t#e group can see t#e applicationA use re'erences /it#in t#e applicationAand create bot# public and private re'erences in t#e application.

+#en a group #as Admin privilege to an applicationA members o' t#e group can set

security privileges 'or all re'erences and sub)applications /it#in t#e application 'orot#er groups but not t#eir o/n group.

Re'erence Members o' t#e group can use t#e re'erenceA as /ell as update or delete t#ere'erence. T#ey can publis# private re'erencesA and privati7e public re'erences.

Lock Cube Members o' t#e group #ave all privileges implied by Write permissionA and can also

loc6 t#e cube. +#en a cube is loc6edA nobody can update its data.

T#e loc6 can be removed only by users /#o #ave Admin rig#ts 'or t#e cube.

8oc6s stays in place a'ter t#e remote server s#uts do/n.

%lement Members o' t#e group #ave all privileges implied by Write permissionA and can also

loc6 t#e element. +#en an element is loc6edA nobody can update cube cells identi'iedby t#e element


f 398 25-09-20




T#e loc6 can be removed only by users /#o #ave Admin rig#ts 'or t#e element.


Dimension Members o' t#e group #ave all privileges implied by Write permissionA and can also

loc6 t#e dimension. +#en a dimension is loc6edA nobody can edit t#e dimension

structure.

T#e loc6 can be removed only by users /#o #ave Admin rig#ts 'or t#e dimension.


Read Cube Members o' t#e group can see t#e cells in t#e cubeA but cannot c#ange t#eir data.

%lement Members o' t#e group can see t#e cells identi'ied by t#e elementA but cannot c#anget#eir data.

Dimension Members o' t#e group can see t#e elements in a dimensionA but cannot addA removeA

or reorder t#e elements.

rocess Members o' t#e group can see t#e process in t#e $erver %&plorerA and can manuallye&ecute t#e processA but cannot edit t#e process.

*ote, rivileges assigned to processes are ignored /#en a process is e&ecuted 'rom

/it#in a c#ore.

C#ore Members o' t#e group can see t#e c#ore in t#e $erver %&plorerA and can manuallye&ecute t#e c#oreA but cannot edit t#e c#ore.

pplication Members o' t#e group can see t#e application and use any public re'erences /it#int#e application to /#ic# t#ey #ave at least Read privilege. T#ey can create private

re'erences in t#e applicationA and also create private sub)applications

Re'erence Members o' t#e group can open t#e re'erenceA but cannot update t#e re'erence in t#eapplication. Members o' t#e group canA #o/everA per'orm a save)as operation tosave a ne/ private version o' t#e re'erence.

Reserve Cube Members o' t#e group #ave all privileges implied by Write permissionA and can also

reserve t#e cube to prevent ot#er users 'rom applying edits. T#e reservation can beremoved eit#er by t#e user /#o reserved t#e cube or by users /#o #ave Admin rig#ts

'or t#e cube.

reservation e&pires automatically /#en t#e reserving user disconnects 'rom t#eremote server or /#en t#e server s#uts do/n.

%lement Members o' t#e group #ave all privileges implied by Write permissionA and can also

reserve t#e element to prevent ot#er users 'rom updating cube cells identi'ied by t#eelement. T#e reservation can be removed eit#er by t#e user /#o reserved t#eelement or by users /#o #ave Admin rig#ts 'or t#e element.

reservation e&pires automaticallyA /#en t#e reserving user disconnects 'rom t#eremote server or /#en t#e server s#uts do/n.


f 398 25-09-20




Dimension Members o' t#e group #ave all privileges implied by Write permissionA and can also

reserve t#e dimension to prevent ot#er users 'rom rede'ining t#e dimension. T#ereservation can be removed eit#er by t#e user /#o reserved t#e dimension or byusers /#o #ave Admin rig#ts 'or t#e dimension.

reservation e&pires automatically /#en t#e reserving user disconnects 'rom t#eremote server or /#en t#e server s#uts do/n.

Write Cube Members o' t#e group can read and update cells. T#ey can save private cube vie/s.T#e Write access privilege does not apply to cells identi'ied by consolidated elements

or to cells derived 'rom rules.

%lement Members o' t#e group can read and update t#e cells identi'ied by t#e element andedit attributes o' t#e element.

Dimension Members o' t#e group can edit element attributesA edit element 'ormatsA and createprivate subsets 'or t#e dimension. Members can also edit attributes 'or t#e dimensionitsel'.

None Cube Members o' t#e group cannot see t#e cube in t#e $erver %&plorerA and t#us cannotbro/se t#e cube.

%lement Members o' t#e group cannot see t#e element in t#e $ubset %ditor or Dimension%ditorA and cannot see t#e cells identi'ied by t#e element /#en bro/sing a cube.

Dimension Members o' t#e group cannot see t#e dimension in t#e $erver %&plorerA and cannotbro/se a cube t#at contains t#e dimension.

rocess Members o' t#e group cannot see t#e process in t#e $erver %&plorerA and t#us cannot

e&ecute t#e process.

*ote, rivileges assigned to processes are ignored /#en a process is e&ecuted 'rom

/it#in a c#ore.

C#ore Members o' t#e group cannot see t#e c#ore in t#e $erver %&plorerA and t#us cannote&ecute t#e c#ore.

pplication Members o' t#e group cannot see t#e application or its contents in t#e $erver%&plorer.

Re'erence Members o' t#e group cannot see t#e re'erence in t#e $erver %&plorer.

+arent topic, Controlling ccess to TM1 b!ects


f 398 25-09-20



?.$. Interaction of Different (b)ect Securit 'igtsI' you apply di''erent security rig#ts to t#e ob!ects t#at identi'y a cell o' dataA TM1H applies t#e most restrictive security

rig#t to t#e cell.

Scenario 1

$uppose you assign a user Read access to t#e $alesCube cubeA and Write access to t#e elements in t#is cube. In t#is

scenarioA t#e Read access o' t#e cube overrides t#e Write access o' t#e elementsA and t#e user can vie/ cube data but

cannot update t#e cube data.

Scenario $

T#e $alesriorCube cube contains t#e 'ollo/ing dimensions;

ctvsbud

Region

Model

ccount1

Mont#

$uppose a user #as Write access to t#e $alesriorCube cubeA Read access to all o' t#e elements in t#e ctvsbud dimensionA

and Write access to all o' t#e elements in t#e ot#er dimensions. T#e elements in t#e ctvsbud dimension identi'y every cell

in t#e cubeA and t#ere'ore t#e user cannot update any cube data.

Scenario -

You can c#ange t#e security rig#ts 'or bot# cubes and dimensions. +#en groups #ave security rig#ts 'or a cubeA t#ose rig#tsapply to all dimensions in t#e cubeA unless you 'urt#er restrict access 'or speci'ic dimensions or elements.

$uppose you /ant several regional groups o' users to read all data in t#e $alesriorCube cube. You also /ant eac# group toupdate data in its o/n region. (or e&ampleA you /ant salespeople in t#e "ort# merica group to update "ort# merica data.

To implement t#is security sc#emeA you could;

Create groups t#at re'lect sales regions.

dd users to t#e appropriate groups.

,rant eac# regional group Write access to t#e $alesriorCube cube.

,rant t#e "ort# merica group Read access to t#ose elements t#at do not re'lect data 'or t#e "ort# merica region.

T#e TM1 sample data re'lects t#is security sc#eme. Usr1 is in t#e "ort# merica groupA /#ic# #as Write access to t#e data

associated /it# areas in t#e "ort# merica regionA and Read access to t#e data associated /it# areas in ot#er regions.



f 398 25-09-20



?.-. Securing CubesYou can en#ance or restrict a groups access to individual cubes. +#en you create a ne/ cubeA ot#er groups initially #ave

None access to t#e ne/ cube. You must assign security rig#ts to t#e ne/ cube 'or ot#er groups.

Assigning Securit 'igts for Cubes

(ollo/ t#ese steps to assign security rig#ts 'or a cube.

'eserving and 'eleasing Cubes

+#en a user reserves a cubeA t#at user gains e&clusive rig#ts to update t#e data in t#e cube. t#er users cannot update

t#e cube data until t#e cube is released. cube can be released by eit#er t#e user /#o reserved it or by a user /#o #asAdmin rig#ts 'or t#at cube.

2oc#ing and %nloc#ing a Cube

+#en a user loc6s a cubeA only t#ose users /#o #ave Admin rig#ts 'or t#at cube can update its data or unloc6 t#e cube.

%ven t#e user /#o loc6s t#e cube cannot update t#e cube data or unloc6 t#e cubeA unless #es#e #as Admin rig#ts 'or

t#at cube.



f 398 25-09-20



?.-.1. Assigning Securit 'igts for Cubes(ollo/ t#ese steps to assign security rig#ts 'or a cube.

+rocedure


$elect t#e Cubes icon 'or t#e server you are /or6ing /it#.2.

Clic6 CubesA Securit Assignments.

T#e TM1H $ecurity ssignments dialog bo& opens.

3.

Clic6 t#e cell at t#e intersection o' t#e cube name and t#e group name 'or /#ic# you /ant to assign rig#ts.

You can assign rig#ts 'or multiple cubes or to multiple groups by selecting a range o' cells. To select a range o' cellsA clic6a cell to establis# t#e top o' t#e rangeA #old do/n $#i'tA and clic6 'urt#er do/n t#e column or ro/ to establis# t#e bottomo' t#e range.

-.

$elect t#e access level you /ant to assign.

T#e name o' t#e assigned access privilege displays in t#e cell.

0.

Clic6 (<..

+arent topic, $ecuring Cubes


f 398 25-09-20



?.-.$. 'eserving and 'eleasing Cubes+#en a user reserves a cubeA t#at user gains e&clusive rig#ts to update t#e data in t#e cube. t#er users cannot update t#e

cube data until t#e cube is released. cube can be released by eit#er t#e user /#o reserved it or by a user /#o #as Admin

rig#ts 'or t#at cube.

Consider reserving a cube as a /ay to temporarily 'ree7e its data. reservation e&pires automatically /#en t#e reservinguser disconnects 'rom t#e remote server or /#en t#e server s#uts do/n.

+rocedure


$elect t#e cube you /ant to reserve.2.

Clic6 CubeA SecuritA 'eserve.

To release a cube;

3.

(ollo/ $teps 1 and 2 'or reserving a cube.-.

Clic6 CubeA SecuritA 'elease.0.



f 398 25-09-20



?.-.-. 2oc#ing and %nloc#ing a Cube+#en a user loc6s a cubeA only t#ose users /#o #ave Admin rig#ts 'or t#at cube can update its data or unloc6 t#e cube. %ven

t#e user /#o loc6s t#e cube cannot update t#e cube data or unloc6 t#e cubeA unless #es#e #as Admin rig#ts 'or t#at cube.

Consider loc6ing a cube as a /ay to permanently arc#ive its data. 8oc6s stays in place a'ter a server s#uts do/n.

+rocedure


$elect t#e cube you /ant to loc6.2.Clic6 CubeA SecuritA 2oc#.

To unloc6 a cube;

3.

(ollo/ $teps 1 and 2 'or loc6ing a cube.-.

Clic6 CubeA SecuritA %nloc#.0.



f 398 25-09-20



?.8. Securing /lementsYou can en#ance or restrict a groups access to individual elements using t#e /lement Securit Assignments dialog bo&.

Assigning Securit 'igts for /lements

(ollo/ t#ese steps to assign security rig#ts 'or elements.

'eserving and 'eleasing /lements

+#en a user reserves an elementA t#at user gains e&clusive rig#ts to update t#e data identi'ied by t#at element. t#erusers cannot update t#e elements dataA until t#e element is released. n element can be released by eit#er t#e user/#o reserved it or by a user /#o #as Admin rig#ts 'or t#at element.

2oc#ing and %nloc#ing an /lement

+#en a user loc6s an elementA only t#ose users /#o #ave Admin rig#ts 'or t#at element can update t#e data t#at it

identi'ies. %ven t#e user /#o loc6s t#e element cannot update its dataA unless t#ey #ave Admin rig#ts 'or t#at element.



f 398 25-09-20



?.8.1. Assigning Securit 'igts for /lements(ollo/ t#ese steps to assign security rig#ts 'or elements.

+rocedure


$elect t#e dimension you /ant to /or6 /it#.2.

Clic6 DimensionA SecuritA /lements Securit Assignments.

T#e TM1H $ecurity ssignments dialog bo& displays.

3.

Clic6 t#e cell at t#e intersection o' t#e element name and t#e group name.

You can assign rig#ts 'or multiple elements or to multiple groups by selecting a range o' cells. To select a range o' cellsAclic6 a cell to establis# t#e top o' t#e rangeA #old do/n $#i'tA and clic6 'urt#er do/n t#e column or ro/ to establis# t#ebottom o' t#e range.

-.



0.

Clic6 Save or (<.

*ote, I' you clic6 SaveA you can continue to assign security rig#ts to di''erent elements. You can access elements inot#er dimensions by selecting a dimension in t#e Select Dimension 'ield.

.

Interaction of Securit 'igts for 2eaf and Consolidated /lements

You can set di''erent levels o' security 'or a consolidated element and t#e lea' elements t#at belong to t#e consolidation.

+arent topic, $ecuring %lements


f 398 25-09-20



?.8.1.1. Interaction of Securit 'igts for 2eaf and Consolidated /lementsYou can set di''erent levels o' security 'or a consolidated element and t#e lea' elements t#at belong to t#e consolidation.

(or e&ampleA t#e Region dimension in t#e sample data #as t#e 'ollo/ing element #ierarc#y;

$uppose Usr- #as Read access to t#e Canada lea' element and None access to t#e "ort# merica consolidated element. Usr-can see t#e data identi'ied by t#e Canada elementA but cannot see t#e consolidated data identi'ied by t#e "ort# mericaelement.

+arent topic, ssigning $ecurity Rig#ts 'or %lements


f 398 25-09-20



?.8.$. 'eserving and 'eleasing /lements+#en a user reserves an elementA t#at user gains e&clusive rig#ts to update t#e data identi'ied by t#at element. t#er users

cannot update t#e elements dataA until t#e element is released. n element can be released by eit#er t#e user /#o reserved

it or by a user /#o #as Admin rig#ts 'or t#at element.

Consider reserving an element as a /ay to temporarily 'ree7e t#e data t#at it identi'ies. reservation e&pires automatically/#en t#e reserving user disconnects 'rom t#e remote server or /#en t#e server s#uts do/n.

+rocedure


Double)clic6 t#e dimension you /ant to /or6 /it#.

T#e $ubset %ditor displays.

2.

$elect t#e element you /ant to reserve.3.

Clic6 /ditA SecuritA 'eserve.

To release an element;

-.

(ollo/ $teps 1 t#roug# 3 'or reserving an element.0.

Clic6 /ditA SecuritA 'elease..



f 398 25-09-20



?.8.-. 2oc#ing and %nloc#ing an /lement+#en a user loc6s an elementA only t#ose users /#o #ave Admin rig#ts 'or t#at element can update t#e data t#at it

identi'ies. %ven t#e user /#o loc6s t#e element cannot update its dataA unless t#ey #ave Admin rig#ts 'or t#at element.

Consider loc6ing an element as a /ay to permanently arc#ive t#e data t#at it identi'ies. 8oc6s stays in place a'ter t#e remoteserver s#uts do/n.

+rocedure

pen t#e $erver %&plorer.1.Double)clic6 t#e dimension you /ant to /or6 /it#.

T#e $ubset %ditor displays.

2.

$elect t#e element you /ant to loc6.3.

Clic6 /ditA SecuritA 2oc#.

To unloc6 an element;

-.

(ollo/ $teps 1 t#roug# 3 'or loc6ing an element.0.

Clic6 /ditA SecuritA %nloc#..



f 398 25-09-20



?.=. Securing DimensionsYou can en#ance or restrict a groups access to individual dimensions.

:y de'aultA TM1H security controls dimensions on t#e I:MH CognosH TM1 server A as 'ollo/s;

nly members o' t#e DMI" and Datadmin groups can create and delete dimensions on t#e TM1 server.

,roups /it# Read access to a dimension can vie/ dimension and element attributes t#roug# t#e $erver %&plorerA but

cannot edit attribute values.

t#er groups initially #ave None access to ne/ dimensions.+#en no security #as been assigned to an element in a dimensionA groups #ave Write access to ne/ elements in t#at

dimension.

+#en you assign security rig#ts to at least one element in a dimensionA groups #ave None access to ne/ elements in

t#at dimension. %&isting elements 6eep t#eir original access ?Write@A unless you c#ange t#at access.

*ote, I' you c#ange t#e security in a dimensionA and you /ant to reset t#at security to t#e de'ault setting ?groups #ave

Writeaccess to ne/ elements added to t#e dimension@A s#ut do/n your TM1 server and manually delete t#e

%lement$ecurityNdimnameO.cub 'ile.

Assigning Securit 'igts for Dimensions

(ollo/ t#ese steps to assign security rig#ts 'or a dimension.

'eserving and 'eleasing Dimensions+#en a user reserves a dimensionA t#at user gains e&clusive rig#ts to addA removeA and reorder elements in t#atdimension. t#er users cannot modi'y t#e dimensionA until it is released. dimension can be released by eit#er t#e user/#o reserved it or by a user /#o #as Admin rig#ts 'or t#at dimension.

2oc#ing and %nloc#ing a Dimension

+#en a user loc6s a dimensionA only t#ose users /#o #ave Admin rig#ts 'or t#at dimension can addA removeA or reorder

elements in t#at dimension. %ven t#e user /#o loc6s t#e dimension cannot modi'y itA unless t#ey #ave Admin rig#ts 'or

t#at dimension.



f 398 25-09-20



?.=.1. Assigning Securit 'igts for Dimensions(ollo/ t#ese steps to assign security rig#ts 'or a dimension.

+rocedure


$elect t#e Dimensions icon 'or t#e server you are /or6ing /it#.2.

Clic6 DimensionsA Securit Assignments.

T#e TM1H $ecurity ssignments dialog bo& displays.

3.

Clic6 t#e cell at t#e intersection o' t#e dimension name and t#e group name.

You can assign rig#ts 'or multiple dimensions or to multiple groups by selecting a range o' cells. To select a range o' cellsA clic6 a cell to establis# t#e top o' t#e rangeA #old do/n $#i'tA and clic6 'urt#er do/n t#e column or ro/ to establis#t#e bottom o' t#e range.

-.



0.

Clic6 (<..

+arent topic, $ecuring Dimensions


f 398 25-09-20



?.=.$. 'eserving and 'eleasing Dimensions+#en a user reserves a dimensionA t#at user gains e&clusive rig#ts to addA removeA and reorder elements in t#at dimension.

t#er users cannot modi'y t#e dimensionA until it is released. dimension can be released by eit#er t#e user /#o reserved it

or by a user /#o #as Admin rig#ts 'or t#at dimension.

Consider reserving a dimension be'ore you re)de'ine it. reservation e&pires automatically /#en t#e reserving userdisconnects 'rom t#e remote server or /#en t#e server s#uts do/n.

+rocedure


$elect t#e dimension you /ant to /or6 /it#.2.

Clic6 DimensionA SecuritA 'eserve.

To release a dimension;

3.

(ollo/ $teps 1 and 2 'or reserving a dimension.-.

Clic6 DimensionA SecuritA 'elease.0.



f 398 25-09-20



?.=.-. 2oc#ing and %nloc#ing a Dimension+#en a user loc6s a dimensionA only t#ose users /#o #ave Admin rig#ts 'or t#at dimension can addA removeA or reorder

elements in t#at dimension. %ven t#e user /#o loc6s t#e dimension cannot modi'y itA unless t#ey #ave Admin rig#ts 'or t#at

dimension.

Consider loc6ing a dimension i' you /ant e&clusive control o' its de'inition.

+rocedure

pen t#e $erver %&plorer.1.$elect t#e dimension you /ant to /or6 /it#.2.

Clic6 DimensionA SecuritA 2oc# 'rom t#e pop)up menu.

To release a dimension;

3.

(ollo/ $teps 1 and 2 'or loc6ing a dimension.-.

Rig#t)clic6 t#e mouseA and clic6 DimensionA SecuritA %nloc#.0.



f 398 25-09-20



?.>. Securing +rocessesYou can en#ance or restrict a groups access to individual TurboIntegrator processes.

*ote, TM1H ignores security rig#ts assigned to TurboIntegrator processes /#en you e&ecute a process 'rom a c#ore. T#e

security rig#ts you assign to t#e c#ore determine t#e ability o' a group to e&ecute a process 'rom a c#ore. (or e&ampleA i' a

group #as Noneaccess to rocess1A but Readaccess to a c#ore t#at includes rocess1A t#e group can e&ecute rocess1 'rom

t#e c#ore.

Assigning Securit 'igts for +rocesses

(ollo/ t#ese steps to assign security rig#ts 'or a process.

Allo!ing +rocesses to Modif Securit Data

T#e TM1 Securit Access option controls /#et#er a process is allo/ed to modi'y security data in t#e script o' t#eprocess. nly members o' t#e DMI" and $ecuritydmin groups are allo/ed to set t#is option. T#is option is set on aprocess)by)process basis 'rom t#e +rocess menu in $erver %&plorer.



f 398 25-09-20



?.>.1. Assigning Securit 'igts for +rocesses(ollo/ t#ese steps to assign security rig#ts 'or a process.

+rocedure


$elect t#e rocesses icon 'or t#e server you are /or6ing /it#.2.

Clic6 +rocessesA Securit Assignments.


3.

Clic6 t#e cell at t#e intersection o' t#e process name and t#e group name.

You can assign rig#ts 'or multiple processes or to multiple groups by selecting multiple cells.

To select a range o' ad!acent cellsA clic6 a cell to establis# t#e top o' t#e rangeA #old do/n $#i'tA and clic6 'urt#er do/nt#e column or ro/ to establis# t#e bottom o' t#e range.

To select multiple non)ad!acent cellsA #old do/n CTR8A and clic6 eac# cell.

-.


T#e name o' t#e assigned access privilege displays in t#e cell?s@.

0.

Clic6 (<..

+arent topic, $ecuring rocesses


f 398 25-09-20



?.>.$. Allo!ing +rocesses to Modif Securit DataT#e TM1H Securit Access option controls /#et#er a process is allo/ed to modi'y security data in t#e script o' t#e process.

nly members o' t#e DMI" and $ecuritydmin groups are allo/ed to set t#is option. T#is option is set on a process)

by)process basis 'rom t#e +rocess menu in $erver %&plorer.

+#en t#e Securit Access option is enabled 'or a process;

Members o' t#e Datadmin group are not allo/ed to edit t#e process since it may contain scripts t#at could modi'y TM1security.

nly members in t#e 'ull DMI" group can edit a process a'ter t#e Securit Access option #as been enabled.

Members o' t#e $ecuritydmin group can vie/ processes and turn t#is option on and o''A but are never allo/ed to editt#e contents o' a process.

T#e 9ie! option on t#e +rocess menu becomes available to allo/ users in t#e Datadmin and $ecuritydmin groups tovie/ processes in read)only mode.

(or more details about t#e DMI"A $ecuritydmin and Datadmin groupsA see t#e I:MH CognosH TM1 Operation Guide.

/nabling te Securit Access (ption for a +rocess

:y de'aultA t#e Securit Access option is disabled 'or any ne/ process. I' you /ant to allo/ a ne/ process to modi'yTM1 securityA you need to manually enable t#e Securit Access option 'or t#at process.

9ie!ing a +rocess in 'ead"onl Mode

+#en t#e Securit Access option is enabled 'or a processA users in t#e Datadmin and $ecuritydmin groups can only

vie/ t#e process in read)only mode.

+arent topic, $ecuring rocesses


f 398 25-09-20



?.>.$.1. /nabling te Securit Access (ption for a +rocess:y de'aultA t#e Securit Access option is disabled 'or any ne/ process. I' you /ant to allo/ a ne/ process to modi'y TM1H

securityA you need to manually enable t#e Securit Access option 'or t#at process.

+rocedure

In $erver %&plorerA select a process.1.

Clic6 +rocessA Securit Access.

c#ec6 mar6 ne&t to t#e $ecurity ccess option indicates t#at TM1 /ill allo/ t#e selected process to modi'y securitydata.

*ote, I' you upgraded to TM1 B.- or later 'rom an earlier TM1 databaseA t#e $ecurity ccess option is automaticallyenabled 'or all o' your e&isting TM1 processes. T#is allo/s your e&isting processes to continue running /it#out re9uiringyou to individually set t#e $ecurity ccess option 'or eac# process.

2.

+arent topic, llo/ing rocesses to Modi'y $ecurity Data


f 398 25-09-20



?.>.$.$. 9ie!ing a +rocess in 'ead"onl Mode+#en t#e Securit Access option is enabled 'or a processA users in t#e Datadmin and $ecuritydmin groups can only vie/

t#e process in read)only mode.

+rocedure

In $erver %&plorerA select a process.1.

Rig#t)clic6 t#e process and clic6 9ie!.

T#e process displays in read)only mode.

2.

+arent topic, llo/ing rocesses to Modi'y $ecurity Data


f 398 25-09-20



?.?. Securing CoresYou can en#ance or restrict a groups access to individual c#ores.

Assigning Securit 'igts for Cores

(ollo/ t#ese steps to assign security rig#ts 'or a c#ore.



f 398 25-09-20



?.?.1. Assigning Securit 'igts for Cores(ollo/ t#ese steps to assign security rig#ts 'or a c#ore.

+rocedure


$elect t#e C#ores icon 'or t#e server you are /or6ing /it#.2.

Clic6 CoresA Securit Assignments.


3.

Clic6 t#e cell at t#e intersection o' t#e c#ore name and t#e group name.

You can assign rig#ts 'or multiple c#ores or to multiple groups by selecting multiple cells.

To select a range o' ad!acent cellsA clic6 a cell to establis# t#e top o' t#e rangeA #old do/n $#i't and clic6 'urt#er do/nt#e column or ro/ to establis# t#e bottom o' t#e range.

To select multiple non)ad!acent cellsA #old do/n CTR8A and clic6 eac# cell.

-.


T#e name o' t#e assigned access privilege displays in t#e cell?s@.

0.

Clic6 (<..

+arent topic, $ecuring C#ores


f 398 25-09-20



?.E. Securing Applications and 'eferencesYou can assign security privileges 'or public items ?re'erences or sub)applications@ /it#in public TM1H applications to user

groups on t#e I:MH CognosH TM1 server . You must #ave Admin privilege to an application to assign security to items

/it#in t#e application.

You cannot assign security 'or private applications and re'erencesJ only t#e user /#o creates a private item can access t#eitem.

+rocedure

In t#e $erver %&plorerA rig#t)clic6 t#e application t#at contains t#e items to /#ic# you /ant to assign security.1.

Clic6 SecuritA Securit Assignments.

T#e TM1 $ecurity ssignments /indo/ opens. T#e "ame list contains all public items ?TM1 ob!ectsA %&cel 'ilesA andsub)applications@ t#at reside in t#e current application.

2.

$elect t#e cell at t#e intersection o' t#e item 'or /#ic# you /ant to de'ine security and t#e user group to /#ic# you /antto assign security.

3.

Clic6 one o' t#e available security privileges.

(or detailsA see ssigning $ecurity Rig#ts to ,roups.

-.

Repeat steps 3 and - 'or any ot#er items 'or /#ic# you /ant to de'ine security.0.

Clic6 (<.

(or any given user groupA you can assign t#e Read or Admin privilege to a re'erence /#en you assign t#e None privilege

to t#e source ob!ect associated /it# t#e re'erence. In t#is scenarioA members o' t#e user group cannot see t#e re'erencein an application.

(or e&ampleA i' you assign t#e None privilege to a user group 'or a cubeA but assign t#e Read privilege 'or a re'erence to

t#e same cubeA members o' t#e user group cannot see t#e re'erence to t#e cube in an application.

.



f 398 25-09-20



?.O. Securing CellsCell)level security applies to a speci'ied cell and overrides all ot#er TM1H security. Cell)level security re9uires;

Creating a cell security control cube t#at contains all o' t#e dimensions o' t#e cube /#ose cell)level security youcon'igure.

$etting security 'or t#e appropriate cells in t#e security control cube by assigning security rig#ts 'or TM1 security groups.

*ote, (or element)level security to apply to a cellA no security rig#ts can be assigned to any TM1 security group 'or t#e cell.

Cell)level security overrides element)level securityA so cell)level security 'or t#e cell must be unde'ined.

Cell)level security applies to lea' elements and generally does not apply to consolidationsA alt#oug# you can use t#e None and

Read security rig#ts to control t#e display or editing o' consolidations.

Creating a Cell Securit Control Cube

(ollo/ t#ese steps to create a cell security control cube.

%sing 'ules to Define Cell"2evel SecuritIn t#e security control cubeA you can use TM1 rules to apply cell)level security instead o' entering security rig#ts intosecurity control cube cells. (or detailsA see t#e I:M Cognos TM1 perations ,uide.



f 398 25-09-20



?.O.1. Creating a Cell Securit Control Cube(ollo/ t#ese steps to create a cell security control cube.

+rocedure

In TM1H rc#itect or TM1 erspectives A rig#t)clic6 on t#e cube 'or /#ic# you /ant to de'ine cell)level security and t#enselect SecuritA Create Cell Securit Cube.

TM1 automatically creates a security control cube using t#e naming 'ormat Cell$ecurity]Cube"ame /#ere )ubeame ist#e name o' t#e cube t#at you selected. (or e&ampleA i' you selected t#e cube $alesCubeA t#en TM1 creates t#e securitycontrol cube Cell$ecurity]$alesCube.

TM1 adds all t#e dimensions o' t#e original cube to t#e ne/ly created security control cubeA plus t#e ,roups dimensionis added as t#e last dimension in t#e ne/ cube.

1.

Clic6 9ie!A Displa Control (b)ects i' t#e control cubes are not already visible.

TM1 displays t#e ne/ security control cube along /it# t#e original cube.

To apply security to cells in t#e security control cubeA by TM1 security group;

2.

pen t#e security control cube you !ust created by double)clic6ing t#e security control cubeA 'or e&ampleA3.

Clic6 'ecalculate to display t#e security control groupsA or clic6 (ptionsA Automatic 'ecalculate.-.

%&pand t#e ro/s to display t#e cells to /#ic# you /ant to assign security rig#ts.

*ote, RememberA cell)level security applies to lea' elements.

0.

%nter t#e security level in t#e cube cells to assign security rig#ts by user group.

(or detailsA see ssigning $ecurity Rig#ts to ,roups.

(or e&ampleA t#e mont#s in t#e second 9uarter 'or t#e Inspectors group #ave security assigned as None.

.

Close t#e security control cube..

$ave t#e vie/.<.

Test t#e security levels by logging in as a user /#o is a member o' t#e a''ected security group and vie/ing t#e cube 'or/#ic# you #ave set security.

B.

+arent topic, $ecuring Cells


f 398 25-09-20



?.O.$. %sing 'ules to Define Cell"2evel SecuritIn t#e security control cubeA you can use TM1H rules to apply cell)level security instead o' entering security rig#ts into

security control cube cells. (or detailsA see t#e I:MH CognosH TM1 perations ,uide.

$uppose you /ant to create a rule to apply cell)level security 'or t#e Cell$ecurity]$alesCube cube. T#e 'ollo/ing ruleprevents any users in t#e Inspectors group 'rom vie/ing any cells identi'ied by t#e element ,reece.

['Greece','Inspectors'] = S:'NONE';

*ote, Ma6e sure t#at security group names are uni9ue and ot#er dimensions or elements do not use t#e same name.

T#e bene'its o' using rules to implement security are;

You do not enter security rig#ts into cells in t#e security control cubeA saving data entry time.

:ecause TM1 does not store string rule values in memory nor saves t#em to dis6A you save on memory consumption anddis6 storage.

+arent topic, $ecuring Cells


f 398 25-09-20



E. %sing TM1 Action @uttons to @uild 7or#seet ApplicationsT#is section describes I:MH CognosH TM1H ction button 'unctionality /#ic# you can use to run processes and navigate

bet/een /or6s#eets and +ebs#eets.

(vervie!You can insert an ction button into a /or6s#eet so users can run a TurboIntegrator process andor navigate to anot#er/or6s#eet. Users can access t#ese buttons /#en /or6ing /it# /or6s#eets in Microso't %&cel /it# TM1 A or /it#+ebs#eets in TM1 +eb.

Adding an Action @utton to a 7or#seetYou can insert an ction button into any empty cell in a /or6s#eet using t#e 'ollo/ing steps.

Configuring an Action @utton to 'un a +rocessT#e 'ollo/ing steps summari7e #o/ to con'igure an ction button to run a TurboIntegrator process.

Configuring an Action @utton to *avigate to Anoter 7or#seet

You can use an ction button to navigate to anot#er /or6s#eet in t#e same /or6boo6A or to a /or6s#eet in anot#er/or6boo6.

Configuring an Action @utton to 'un a +rocess and *avigate to a 7or#seet

To con'igure an ction t#at runs a TurboIntegrator process and t#en navigates to anot#er /or6s#eetA per'orm t#e'ollo/ing steps.

Configuring an Action @utton to 'ecalculate or 'ebuild a 7or#seet

You can use an ction button to per'orm only a recalculation or rebuild operation /it#out running a TI process or

navigating to a ne/ /or6s#eet. T#is can be use'ul i' you only /ant to update t#e current s#eet or reload t#e originalversion o' an ctive (orm.

%nderstanding Action @utton @eavior !it TM1 Active FormsT#is section summari7es t#e be#avior and order o' operations /#en using an ction button /it# ctive (orms.

Setting te Appearance +roperties of an Action @utton

Use t#e Appearance tab to set t#e captionA bac6ground pictureA and ot#er visual 'eatures 'or t#e ction button.

%sing Advanced *avigation and Mapping (ptions

Use t#e Advanced (ptions dialog to manually map 'ields bet/een t#e source /or6s#eet and t#e target /or6s#eet /#eninserting an ction button t#at navigates 'rom one /or6s#eet to anot#er. T#is tool #elps you map dimensionsA cellsA andvalues 'rom t#e source /or6s#eet to t#e target /or6s#eet.

Modifing an /isting Action @utton

'ter an ction button is insertedA you can edit its propertiesA si7eA and location as described in t#e 'ollo/ing sections.


f 398 25-09-20



E.1. (vervie!You can insert an ction button into a /or6s#eet so users can run a TurboIntegrator process andor navigate to anot#er

/or6s#eet. Users can access t#ese buttons /#en /or6ing /it# /or6s#eets in Microso't %&cel /it# TM1H A or /it# +ebs#eets

in TM1 +eb.

n ction button can per'orm any o' t#e 'ollo/ing tas6s;

Run a TurboIntegrator process.

"avigate to anot#er /or6s#eet.

Run a TurboIntegrator process and t#en navigate to anot#er /or6s#eet.

Recalculate a /or6s#eet or rebuild t#e TM1 ctive (orm in a /or6s#eet.

T#e 'ollo/ing 'igure s#o/s an e&ample o' an ction button in a /or6s#eet.

+arent topic, Using TM1 ction :uttons to :uild +or6s#eet pplications


f 398 25-09-20



E.$. Adding an Action @utton to a 7or#seetYou can insert an ction button into any empty cell in a /or6s#eet using t#e 'ollo/ing steps.

+rocedure

In %&celA select an empty cell in your /or6s#eet /#ere you /ant to insert t#e ction button.

*ote, n ction button can not be inserted into a cell t#at contains data.

1.

$elect Insert Action @utton 'rom t#e TM1 menu or clic6 t#e Insert ction button on t#e TM1H toolbar.

T#e ction button is inserted into t#e currently selected cell and t#e Action @utton +roperties dialog bo& appears.

2.

In t#e Action @utton +roperties dialog bo&A clic6 t#e TM1 server list to select t#e server /#ere your data is located.

I' you /ant to dynamically retrieve t#e I:MH CognosH TM1 server name 'rom a cell or named)range /#enever t#ection button is runA clic6 t#e %se 'eference c#ec6bo& and t#en enter a cell or named)range re'erence.

To select a cell re'erenceA clic6 t#e %&cel Re'erence button and t#en clic6 t#e cell in t#e current /or6s#eet /#eret#e server name is located.

To retrieve t#e process name by re'erencing a named range in %&celA use t#e 'ollo/ing 'ormat;

=NameOfRange

T#e named range must point to only a single cell t#at contains te&t 'or t#e server name.

I' you are not currently connected to t#e server t#at you /ant to useA clic6 Connect to log in.

3.

Clic6 t#e Action option t#at you /ant t#e ction button to per'orm.

You t#en need to con'igure t#e ction button depending on t#e type o' action t#at you selected. (or detailed stepsA seet#e 'ollo/ing sections;

Action See

'un a TurboIntegrator +rocessCon'iguring an ction :utton to Run a rocess

Go to anoter 7or#seetCon'iguring an ction :utton to "avigate to not#er +or6s#eet

'un a +rocess6 ten go to anoter7or#seet

Con'iguring an ction :utton to Run a rocess and "avigate to a+or6s#eet

'ecalculate U 'ebuildCon'iguring an ction :utton to Recalculate or Rebuild a +or6s#eet

-.

$et t#e appearance properties o' t#e ction button. $ee $etting t#e ppearance roperties o' an ction :utton.0.

To 'inis# t#e ction button and return to your /or6s#eetA clic6 (< in t#e Action @utton +roperties dialog bo&..

'esults

T#e ction button is updated in your /or6s#eet and can no/ be used.



f 398 25-09-20



E.-. Configuring an Action @utton to 'un a +rocessT#e 'ollo/ing steps summari7e #o/ to con'igure an ction button to run a TurboIntegrator process.

+rocedure

In t#e Action @utton +roperties dialog bo&A select t#e 'un a TurboIntegrator +rocess option.

T#e +rocess tab displays.

1.

$elect t#e process t#at you /ant to run. $ee $electing t#e rocess to Run.2.

$et t#e rocess parameters. $ee $etting rocess arameters.3.

$elect t#e calculation option t#at you /ant TM1H to apply be'ore t#e ction button runs t#e process. $ee Con'iguring anction :utton to Recalculate or Rebuild a +or6s#eet.

-.

$elect t#e calculation option t#at you /ant TM1 to apply a'ter t#e process #as completed. $ee $etting rocess ptions'or Calculation.

0.

Con'igure t#e messages t#at you /ant TM1 to s#o/ be'ore and a'ter t#e process is run. $ee $etting rocess ptions to$#o/ Messages.

.

Selecting te +rocess to 'un

You can select t#e process you /ant to run in one o' eit#er t/o /ays;

Setting +rocess +arametersDepending on #o/ selected t#e name o' t#e process to runA enter t#e parameter values in one o' t#e 'ollo/ing t/o /ays.

Setting +rocess (ptions for Calculation

Use t#e +rocess (ptions dialog bo& to select t#e calculation operation t#at /ill be per'ormed a'ter t#e process is run.

Setting +rocess (ptions to So! Messages

Use t#e +rocess (ptions dialog bo& to control t#e di''erent message bo&es t#at TM1 can s#o/ be'ore and a'ter t#eprocess is run.

%sing te Action @utton Server *ame +ropert

T#e ction button roperties dialog bo& includes a 'ield /#ere you can enter a cell or named)range re'erence todynamically retrieve t#e I:M Cognos TM1 server name 'or an ction button.To use t#is 'eatureA clic6 t#e %se 'eferencec#ec6bo& in t#e TM1 server section on t#e Action @utton +roperties dialog bo& and t#en enter a cell or named)rangere'erence.



f 398 25-09-20



E.-.1. Selecting te +rocess to 'unYou can select t#e process you /ant to run in one o' eit#er t/o /ays;

$elect t#e process name 'rom t#e +rocess list.

Dynamically retrieve t#e process name using an %&cel re'erence.

Select te +rocess *ame from te +rocess 2ist

I' you /ant to select t#e process name 'rom a list o' available processes on t#e current I:MH CognosH TM1H server Aper'orm t#e 'ollo/ing steps.

%se an /cel 'eference to 'etrieve te +rocess *ame

I' you /ant to dynamically retrieve t#e process name by re'erencing a cell or named range in t#e current /or6s#eetAper'orm t#e 'ollo/ing steps. T#e process name /ill be retrieved /#en t#e ction button is run.

+arent topic, Con'iguring an ction :utton to Run a rocess


f 398 25-09-20



E.-.1.1. Select te +rocess *ame from te +rocess 2istI' you /ant to select t#e process name 'rom a list o' available processes on t#e current I:MH CognosH TM1H server A

per'orm t#e 'ollo/ing steps.

+rocedure

In t#e +rocess tab o' t#e Action @utton +roperties dialogA clic6 t#e +rocess list to select an available process 'rom t#e

TM1 server to /#ic# you are currently connected.

T#e arameters grid opens and displays t#e parameters 'or t#e selected process.

'esults

You t#en need to enter t#e parameter values 'or t#e selected process in t#e +arameter grid. $ee %nter arameter 5alues

into t#e arameter ,rid.

+arent topic, $electing t#e rocess to Run


f 398 25-09-20



E.-.1.$. %se an /cel 'eference to 'etrieve te +rocess *ameI' you /ant to dynamically retrieve t#e process name by re'erencing a cell or named range in t#e current /or6s#eetA per'orm

t#e 'ollo/ing steps. T#e process name /ill be retrieved /#en t#e ction button is run.

+rocedure

n t#e Action @utton +roperties dialog bo&A select Get +rocess info from 7or#seet in t#e +rocess list.1.

Clic6 t#e %&cel Re'erence button ne&t to t#e +rocess *ame bo& to select a cell 'rom t#e current /or6s#eet.

T#e Select a Cell dialog bo& opens.

2.

Clic6 t#e cell in t#e current /or6s#eet /#ere t#e process name is located.

T#e location is automatically entered into t#e Select a Cell dialog bo&.

3.

Clic6 (< to close t#e Select a Cell dialog bo&.

T#e cell re'erence appears in t#e +rocess *ame bo&.

-.

To retrieve t#e process name by re'erencing a named range in %&celA use t#e 'ollo/ing 'ormat;

= NameOfRange

T#e named range must point to only a single cell t#at contains te&t 'or t#e process name.

0.

+arent topic, $electing t#e rocess to Run


f 398 25-09-20



E.-.$. Setting +rocess +arametersDepending on #o/ selected t#e name o' t#e process to runA enter t#e parameter values in one o' t#e 'ollo/ing t/o /ays.

%nter parameter values into t#e +arameter grid.

Create an %&cel re'erence to retrieve t#e parameter values.

/nter +arameter 9alues into te +arameter Grid

I' you selected t#e process name directly 'rom t#e +rocess listA you can t#en enter t#e parameter values into t#e+arameter grid using t#e 'ollo/ing steps. You can eit#er type t#e values into t#e grid 'or eac# parameterA or use an

%&cel re'erence to dynamically retrieve a parameter value 'rom t#e current /or6s#eet /#en t#e ction button is clic6ed.

%se an /cel 'eference to 'etrieve te +arameter 9aluesI' you selected Get +rocess info from 7or#seet in t#e +rocess listA you must create an %&cel re'erence t#atdynamically retrieves t#e process parameters 'rom a /or6s#eet.



f 398 25-09-20



E.-.$.1. /nter +arameter 9alues into te +arameter GridI' you selected t#e process name directly 'rom t#e +rocess listA you can t#en enter t#e parameter values into t#e

+arameter grid using t#e 'ollo/ing steps. You can eit#er type t#e values into t#e grid 'or eac# parameterA or use an %&cel

re'erence to dynamically retrieve a parameter value 'rom t#e current /or6s#eet /#en t#e ction button is clic6ed.

+rocedure

In t#e +rocess tab o' t#e Action @utton +roperties dialogA enter t#e parameter values into t#e +arameters grid.

To directly enter t#e parameter valuesA type t#e values into t#e grid 'or eac# parameter.

1.

To create a re'erence t#at dynamically retrieves a parameter value 'rom t#e current /or6s#eetA select t#e 9alue cell and

t#en clic6 .

T#e Select a Cell dialog bo& opens.

2.

Use t#e Select a Cell dialog bo& to select t#e cell in your /or6s#eet /#ere t#e parameter value can be 'ound.3.

+arent topic, $etting rocess arameters


f 398 25-09-20



E.-.$.$. %se an /cel 'eference to 'etrieve te +arameter 9aluesI' you selected Get +rocess info from 7or#seet in t#e +rocess listA you must create an %&cel re'erence t#at dynamically

retrieves t#e process parameters 'rom a /or6s#eet.

+rocedure

Clic6 t#e %&cel Re'erence button ne&t to t#e +arameters bo& to select a re'erence 'rom t#e current /or6s#eet.

T#e Select a 'ange dialog bo& opens.

1.

$elect t#e range o' cells in your /or6s#eet /#ere t#e parameter values are located. %ac# cell must contain t#e value 'oronly one parameter.

*ote, arameters must be entered in t#e same order and type ?stringA numeric@ as in t#e process.

2.

Clic6 (< to close t#e Select a 'ange dialog.

T#e selected cell re'erence appears in t#e +arameters bo&.

I' you /ant to re'erence a named range in %&celA use t#e 'ollo/ing 'ormat;

= NameOfRange

T#e named range must point to a single cell or a range o' cellsA depending on t#e parameters t#at t#e process ise&pecting.

I' t#e parameters 'or t#e process c#angeA you must also update t#e process name and parameter settings 'or t#e ctionbutton so t#e button can correctly run t#e process.

*ote, Due to a problem in Microso't %&cel i' an ction button t#at runs a TurboIntegrator process /it# parameter inputsis created and saved in an %&cel 2 /or6s#eetA t#e ction button stops /or6ing a'ter t#e 'ile is saved and t#enre)opened. s a /or6aroundA /#en using an ction button in %&cel 2 to run a TI process t#at re9uires parametersAsave t#e /or6s#eet 'ile in t#e .&ls 'ormat.

3.

+arent topic, $etting rocess arameters


f 398 25-09-20



E.-.-. Setting +rocess (ptions for CalculationUse t#e +rocess (ptions dialog bo& to select t#e calculation operation t#at /ill be per'ormed a'ter t#e process is run.

+rocedure

Clic6 (ptions to s#o/ t#e +rocess (ptions dialog bo&.1.

$elect t#e calculation operation t#at you /ant per'ormed a'ter t#e process #as run. T#e available calculation optionsinclude;

Automaticall 'ecalculate Seet ) Recalculates t#e values in t#e current /or6s#eet.'ebuild Seet ) Reloads t#e TM1H ctive (orm to its original report de'inition con'iguration.

*one ) T#e ction button /ill not per'orm any calculation or rebuild operation on t#e /or6s#eet.

2.



f 398 25-09-20



E.-.8. Setting +rocess (ptions to So! MessagesUse t#e +rocess (ptions dialog bo& to control t#e di''erent message bo&es t#at TM1H can s#o/ be'ore and a'ter t#e

process is run.

+rocedure

n t#e +rocess tabA clic6 (ptions to open t#e +rocess (ptions dialog bo&.1.

$elect t#e con'irmation and status messages t#at you /ant TM1 to s#o/.

So! Success Message ) Displays a message a'ter t#e process #as success'ully run.So! Failure Message ) Displays a message i' t#e process does not run success'ully.

So! Confirmation Dialog ) Displays a con'irmation message be'ore t#e process is run. T#e user can clic6 &es or*o.

2.

%nter or edit t#e te&t 'or t#e messages you selected. You can also re'erence a cell or a named range to dynamicallyretrieve t#e message te&t. (or e&ample;

To retrieve t#e message te&t 'rom t#e contents o' cell 1 in t#e current /or6s#eetA enter KA1 into t#e message te&tbo&.

To re'erence a named range in %&celA use t#e 'ormat = NameOfRange.

T#e named range must point to only a single cell t#at contains t#e te&t 'or t#e message.

3.



f 398 25-09-20



E.-.=. %sing te Action @utton Server *ame +ropertT#e ction button roperties dialog bo& includes a 'ield /#ere you can enter a cell or named)range re'erence to dynamically

retrieve t#e I:MH CognosH TM1H server name 'or an ction button.To use t#is 'eatureA clic6 t#e %se 'eference c#ec6bo&

in t#e TM1 server section on t#e Action @utton +roperties dialog bo& and t#en enter a cell or named)range re'erence.



f 398 25-09-20



E.8. Configuring an Action @utton to *avigate to Anoter 7or#seetYou can use an ction button to navigate to anot#er /or6s#eet in t#e same /or6boo6A or to a /or6s#eet in anot#er

/or6boo6.

T#e 'ollo/ing steps summari7e #o/ to con'igure an ction button to navigate to anot#er /or6s#eet.

+rocedure

In t#e Action @utton +roperties dialog bo&A clic6 t#e Go to anoter 7or#seet option.

T#e 7or#seet tab displays.

1.

$elect t#e target /or6s#eet. $ee $elect a Target +or6s#eet.2.

$et t#e Matc Title /lements option. $ee %nable t#e Matc# Title %lements ption.3.

$et t#e 'eplace Current 7or#boo# option. $ee $etting t#e Replace Current +or6boo6 ption.-.

$elect t#e calculation option t#at you /ant TM1H to apply be'ore t#e ction button navigates to anot#er /or6s#eet. $eeCon'iguring an ction :utton to Recalculate or Rebuild a +or6s#eet.

0.

$elect t#e calculation option t#at you /ant TM1 to apply a'ter t#e navigation #as completed. $ee $etting Calculationptions 'or a'ter "avigating to a +or6s#eet.

.

Select a Target 7or#seet

You can select a /or6s#eet by c#oosing it 'rom a list or by directly typing its name.

/nable te Matc Title /lements (ptionT#e Matc Title /lements option automatically matc#es and sets t#e te&t o' t#e title dimensions in t#e target/or6s#eet /#en a user clic6s t#e ction button to navigate to t#e target /or6s#eet.

Setting te 'eplace Current 7or#boo# (ption

T#e 'eplace Current 7or#boo# option determines i' t#e target /or6s#eet is opened in a ne/ /indo/ or in t#e same/indo/A replacing t#e source /or6s#eet.

Setting Calculation (ptions for after *avigating to a 7or#seet

$et t#e calculation options to be applied to t#e target /or6s#eet a'ter navigating.



f 398 25-09-20



E.8.1. Select a Target 7or#seetYou can select a /or6s#eet by c#oosing it 'rom a list or by directly typing its name.

+rocedure

Clic6 t#e TM1 Applications option and t#en clic6 @ro!se.

T#e $elect a +or6s#eet dialog opens.

*ote, To select a target /or6boo6A you can also clic6 t#e Files option and t#en clic6 @ro!se. T#en select a /or6s#eet

'ile 'rom t#e (pen dialog and t#en clic6 (pen. not#er met#od to select a target /or6boo6A is to clic6 t#e /cel

'eference button.

1.

$elect a /or6s#eet and t#en clic6 (< to return to t#e Action @utton +roperties dialog.

T#e pplication 'older pat# and name o' t#e /or6s#eet you selected displays in t#e +or6boo6 bo&.

2.

To manually enter t#e pplication 'older pat# to t#e /or6boo6A type t#e pat# into t#e 7or#boo# bo&;

$tart /it# t#e 'irst 'older name under pplications and use a bac6)slas# K c#aracter to separate 'olders. Do notinclude t#e pplications 'older in t#e pat#. (or e&ample;

Planning

Sample\Bottom Up Input\Budget Input

To speci'y a /or6s#eet and cell location to /#ic# you /ant to navigateA type t#e /or6s#eet name and location in t#e

Seet bo& using t#e 'ollo/ing 'ormat;

=SheetName!ColumnNameRowName

*ote, I' you enter a /or6s#eet name t#at includes spacesA you must enclose t#e name in single 9uotes as s#o/n int#e 'ollo/ing e&ample.

My (irst $#eet[[2

3.

+arent topic, Con'iguring an ction :utton to "avigate to not#er +or6s#eet


f 398 25-09-20



E.8.$. /nable te Matc Title /lements (ptionT#e Matc Title /lements option automatically matc#es and sets t#e te&t o' t#e title dimensions in t#e target /or6s#eet

/#en a user clic6s t#e ction button to navigate to t#e target /or6s#eet.

+#en t#e Matc Title /lements option is enabledA t#e dimensions in t#e source and target /or6s#eets are automaticallymatc#ed by t#e TM1H $U:"M and D:R+ 'unctions as 'ollo/s;

TM1 automatically matc#es title dimensions in t#e source and target /or6s#eets based on t#e $U:"M 'ormula in a cell.

(or e&ampleA /#en t#e same dimension e&ists in bot# t#e source and target /or6s#eetsA t#e element selected in t#e

source /or6s#eet is set 'or t#e same dimension in t#e target /or6s#eet. +#en a column is selected in t#e source/or6s#eetA it matc#es to t#e column /it# t#e same title dimensions in t#e target /or6s#eet.

TM1 automatically matc#es t#e ro/ and column dimensions o' t#e currently selected D:R+ cell in t#e source /or6s#eetto t#e matc#ing title dimensions in t#e target /or6s#eetA i' t#ey e&ist.

(or e&ampleA i' perating %&pense and (eb)2- are t#e ro/ and column dimension elements 'or t#e currently selectedelement in t#e source /or6s#eetA /#en navigatingA t#ese dimension elements are t#en matc#ed to t#e title dimensionsin t#e target /or6s#eet. I' t#e ro/ perating %&pense and t#e column (eb)2- are bot# selected in t#e source/or6s#eetA t#e D:R+ cell is t#e cell t#at e&ists in bot# t#e perating %&pense ro/ and t#e (eb)2- column. T#e ro/and column dimensions o' t#e D:R+ cell are t#en matc#ed to title dimensions in t#e target /or6s#eet.



f 398 25-09-20



E.8.-. Setting te 'eplace Current 7or#boo# (ptionT#e 'eplace Current 7or#boo# option determines i' t#e target /or6s#eet is opened in a ne/ /indo/ or in t#e same

/indo/A replacing t#e source /or6s#eet.

(or e&ample;

I' 'eplace Current 7or#boo# is not selected ?de'ault@ and you are /or6ing in TM1H +ebA t#en t#e source /or6s#eetremains open and t#e target /or6s#eet opens in a ne/ tab.

I' 'eplace Current 7or#boo# is selected and you are /or6ing in TM1 +ebA t#en t#e source /or6s#eet /ill be replaced

by t#e target /or6s#eet on t#e same tab and a ne/ tab /ill not open.

Important, I' you enable t#e 'eplace Current 7or#boo# optionA remember to save your /or6boo6 be'ore testing t#e

ne/ button. You could lose your c#anges i' you clic6 t#e button and cause t#e current /or6boo6 to close.



f 398 25-09-20



E.8.8. Setting Calculation (ptions for after *avigating to a 7or#seet$et t#e calculation options to be applied to t#e target /or6s#eet a'ter navigating.

+rocedure

n t#e 7or#seet tabA select t#e Calculation options t#at you /ant to use.

Automaticall 'ecalculate Seet ) Recalculates t#e values in t#e current /or6s#eet.

'ebuild Seet ) Reloads t#e TM1H ctive (orm to its original report de'inition con'iguration.




f 398 25-09-20



E.=. Configuring an Action @utton to 'un a +rocess and *avigate to a 7or#seetTo con'igure an ction t#at runs a TurboIntegrator process and t#en navigates to anot#er /or6s#eetA per'orm t#e 'ollo/ing

steps.

+rocedure

In t#e Action @utton +roperties dialog bo&A clic6 t#e 'un a +rocess6 ten go to a 7or#seet option.

T#e +rocess tab displays.

1.

$elect t#e process t#at t#e ction :utton /ill run. $ee Con'iguring an ction :utton to Run a rocess.2.

$elect t#e /or6s#eet to /#ic# t#e ction button /ill navigate. $ee Con'iguring an ction :utton to "avigate to not#er+or6s#eet.

3.



f 398 25-09-20



E.>. Configuring an Action @utton to 'ecalculate or 'ebuild a 7or#seetYou can use an ction button to per'orm only a recalculation or rebuild operation /it#out running a TI process or navigating

to a ne/ /or6s#eet. T#is can be use'ul i' you only /ant to update t#e current s#eet or reload t#e original version o' an

ctive (orm.

You can also use t#e Calculate tab to select t#e calculation operation t#at you /ant TM1H to per'orm be'ore running a TIprocess or navigating to anot#er /or6s#eet.

+rocedure

Insert an ction button into your /or6s#eet as described in dding an ction :utton to a +or6s#eet.1.

n t#e Action @utton +roperties dialog bo&A clic6 t#e Calculate tab.2.

In t#e Calculate tabA select t#e calculation option t#at you /ant to use.

Automaticall 'ecalculate Seet ) Recalculates t#e values in t#e current /or6s#eet.

'ebuild Seet ) Reloads t#e TM1 ctive (orm to its original report de'inition con'iguration.


3.

$et t#e appearance o' t#e button as described in $etting t#e ppearance roperties o' an ction :utton.-.

n t#e Action @utton +roperties dialog bo&A clic6 (< to close t#e dialog and insert t#e ction button into your/or6s#eet.

0.



f 398 25-09-20



E.?. %nderstanding Action @utton @eavior !it TM1 Active FormsT#is section summari7es t#e be#avior and order o' operations /#en using an ction button /it# ctive (orms.

@asic Action @utton @eavior

%ac# time you clic6 an ction buttonA t#e 'ollo/ing steps are per'ormed in t#is order;

Additional Action @utton @eavior

'ter t#e above basic steps #ave been completedA t#e 'ollo/ing additional steps are per'ormedA depending on /#et#ert#e ction button is running a TI processA navigating to anot#er /or6s#eet or bot#.



f 398 25-09-20



E.?.1. @asic Action @utton @eavior%ac# time you clic6 an ction buttonA t#e 'ollo/ing steps are per'ormed in t#is order;

T#e D:R+ 'ormula is captured 'or t#e currently selected cell in t#e source /or6s#eet.

T#e D:R+ cell 'ormula is captured be'ore t#e 'ollo/ing Recalc ?(B@ operation because t#e recalculation could c#ange t#enumber o' active 'orm ro/s due to 7ero suppression andor MDE)based ro/ subsets.

1.

Recalculation ?(B@ or rebuild operation is per'ormed on t#e current /or6s#eetA depending on t#e calculation option t#at/as selected on t#e Calculate tab o' t#e Action @utton +roperties dialog bo&.

2.

T#e updated values are captured 'or any ot#er cells t#at are re'erenced by advanced mapping options.3.

+arent topic, Understanding ction :utton :e#avior /it# TM1 ctive (orms


f 398 25-09-20



E.?.$. Additional Action @utton @eavior'ter t#e above basic steps #ave been completedA t#e 'ollo/ing additional steps are per'ormedA depending on /#et#er t#e

ction button is running a TI processA navigating to anot#er /or6s#eet or bot#.

+#en using an ction button to run a TI process only;

T#e TI process is run.1.

T#e calculation operation t#at /as selected on t#e ction buttons +rocess (ptions dialog bo& is per'ormed.2.

+#en using an ction button to navigate only;T#e navigation action begins.1.

Target values are set in t#e target /or6s#eet.2.

T#e calculation operation t#at /as selected in t#e 7or#seet tab o' t#e Action @utton +roperties dialog bo& isper'ormed on t#e target /or6s#eet.

3.

+#en using an ction button to run a TI process and navigate to a /or6s#eet;

T#e TI process is run.1.

T#e calculation operation t#at /as selected on t#e ction buttons +rocess (ptions dialog bo& is per'ormed.2.

T#e navigation action begins.3.

Target values are set in t#e target /or6s#eet.-.

T#e calculation operation t#at /as selected in t#e 7or#seet tab o' t#e Action @utton +roperties dialog bo& isper'ormed on t#e target /or6s#eet.

0.

+arent topic, Understanding ction :utton :e#avior /it# TM1 ctive (orms


f 398 25-09-20



E.E. Setting te Appearance +roperties of an Action @uttonUse t#e Appearance tab to set t#e captionA bac6ground pictureA and ot#er visual 'eatures 'or t#e ction button.

Clic6 t#e Appearance tab to ad!ust t#e appearance properties o' t#e button.

T#e ppearance tab #as t#e 'ollo/ing options;

Caption ) $ets t#e caption te&t t#at displays on t#e button.

Font ) Displays a standard 'ont dialog /#ere you can c#ange t#e 'ont type and si7e o' t#e button te&t.

So! @ac#ground Image ) llo/s you to select an image 'ile ?bmpA gi'A or !pg 'ormat@ t#at /ill be stretc#ed to 'it t#ebutton.

Displa as 3perlin# ) +#en enabledA t#is option displays t#e button as a #yperlin6 /it# blueA underlined te&t insteado' a standard button.

+revie! ) T#is area s#o/s an e&ample o' t#e button.

Colors ) llo/s you to set te&t and bac6ground colors o' t#e button. Clic6 t#e color sample to display a Color dialog/#ere you can select a standard color or de'ine a custom color.



f 398 25-09-20



E.O. %sing Advanced *avigation and Mapping (ptionsUse t#e Advanced (ptions dialog to manually map 'ields bet/een t#e source /or6s#eet and t#e target /or6s#eet /#en

inserting an ction button t#at navigates 'rom one /or6s#eet to anot#er. T#is tool #elps you map dimensionsA cellsA and

values 'rom t#e source /or6s#eet to t#e target /or6s#eet.

*ote, dvanced mapping is applied a'ter any automatic mapping #as been per'ormed by t#e Matc Title /lements option.

To open t#e Advanced (ptions dialogA clic6 Advanced (ptions on t#e 7or#seet tab.

T#e Advanced (ptions dialog includes a grid /#ere you de'ine t#e mapping o' 'ields bet/een t#e source and target/or6s#eets. Use t#e Add and Delete buttons to manage t#e ro/s in t#e grid.

Configuring Source to Target Mapping

You map t#e source /or6s#eet to t#e target /or6s#eet by setting values 'or t#e Source TpeA Source (b)ectA TargetTpeA and Target (b)ect 'ields in t#e dvanced Mapping grid.

/ample of Mapping a Source 9alue to a Target Cell

T#is e&ample s#o/s t#e mapping o' a #ard)coded value to one cell in t#e target /or6s#eet.

/ample of Mapping a Source S%@*M to a Target CellYou can speci'y a $U:"M title dimension in t#e source /or6s#eet to map to a corresponding $U:"MA named rangeA orrange ?cell@ in t#e target /or6s#eet.

/ample of Mapping te Selected D@'7 to te Target 7or#seetIn t#is e&ampleA t#e ro/ and column title dimensions 'or t#e selected D:R+ cell are displayed in t#e target /or6s#eet.



f 398 25-09-20



E.O.1. Configuring Source to Target MappingYou map t#e source /or6s#eet to t#e target /or6s#eet by setting values 'or t#e Source TpeA Source (b)ectA Target

TpeA and Target (b)ect 'ields in t#e dvanced Mapping grid.

You can use t#e grid to speci'y #o/ elements in t#e source and target /or6s#eets get matc#ed up /#en t#e target s#eetopens. %ac# ro/ in t#e grid de'ines one mapping con'iguration.

Use t#e 'ollo/ing steps to con'igure advanced mapping;

Step See

Indicate t#e type o' ob!ect to map $et t#e $ource Type

Determine t#e value 'or t#e type o' ob!ect you are using $et t#e $ource b!ect

Indicate t#e type o' cell to map $et t#e Target Type

Indicate /#ere t#e value 'rom t#e $ource b!ect /ill be inserted $et t#e Target b!ect

Repeat t#ese steps to create more mapping con'igurations.

Set te Source Tpe

T#e Source Tpe 'ield represents t#e type o' ob!ect 'or t#e value you /ant to map.

Set te Source (b)ectT#e Source (b)ect 'ield ta6es a valueA or %&cel e&pression t#at evaluates to a valueA depending on /#at is selected int#e Source Tpe 'ield.

Set te Target TpeT#e Target Tpe is t#e type o' cell in t#e target /or6s#eet /#ere t#e value 'rom t#e Source (b)ect 'ield /ill beinserted.

Set te Target (b)ectT#e Target (b)ect is t#e location in t#e target /or6s#eet /#ere t#e value 'rom t#e $ource b!ect /ill be inserted. T#is

location can be eit#er t#e name o' a title dimensionA a speci'ic cell locationA or a named range in t#e target /or6s#eetAdepending on /#at you selected 'or Target Tpe.

+arent topic, Using dvanced "avigation and Mapping ptions


f 398 25-09-20



E.O.1.1. Set te Source TpeT#e Source Tpe 'ield represents t#e type o' ob!ect 'or t#e value you /ant to map.

$elect t#e Source Tpe as 'ollo/s;

S%@*M ) Indicates t#at you are mapping 'rom a cell t#at contains a title dimension in t#e source /or6s#eet.

$elected D:R+ ) Indicates t#at you are mapping 'rom a cell t#at contains a D:R+ 'ormula in t#e source /or6s#eet.

9alue ) Indicates t#at you /ill enter a string or numeric value t#at /ill be sent to t#e target.

+arent topic, Con'iguring $ource to Target Mapping


f 398 25-09-20



E.O.1.$. Set te Source (b)ectT#e Source (b)ect 'ield ta6es a valueA or %&cel e&pression t#at evaluates to a valueA depending on /#at is selected in t#e

Source Tpe 'ield.

%nter t#e Source (b)ect as 'ollo/s;

I' $ource Type is set to S%@*MA t#en you need to speci'y t#e name o' t#e title dimension t#at e&ists in t#e source/or6s#eet.

I' $ource Type is set to Selected D@'7A t#en you need to speci'y t#e name o' a ro/ or column title dimension t#at

e&ists in t#e source /or6s#eet.

I' $ource Type is set to 9alueA t#en you need to enter a string or numeric value t#at /ill be sent to t#e target/or6s#eet.

*ote, You can also retrieve t#ese values 'rom t#e source /or6s#eet by using t#e symbol to create an %&cel re'erence.



f 398 25-09-20



E.O.1.-. Set te Target TpeT#e Target Tpe is t#e type o' cell in t#e target /or6s#eet /#ere t#e value 'rom t#e Source (b)ect 'ield /ill be inserted.

$elect t#e Target Tpe as 'ollo/s;

S%@*M ) Indicates t#e target is a title dimension in t#e target /or6s#eet.

*amed 'ange ) Indicates t#e target is a named range in t#e target /or6s#eet.

'ange ) Indicates t#e target location is a cell in t#e target /or6s#eet.

*ote, I' you set Target Tpe to eit#er a *amed 'ange or 'angeA any pre)e&isting data or 'ormula in t#e target cell /illbe over/ritten /#en you use t#e ction button to navigate. I' t#e target cell contains a D:R+ 'unctionA t#en t#e 'unction /ill

be lost and t#e cell /ill not be able to connect toA read 'romA or /rite to t#e I:MH CognosH TM1H server .



f 398 25-09-20



E.O.1.8. Set te Target (b)ectT#e Target (b)ect is t#e location in t#e target /or6s#eet /#ere t#e value 'rom t#e $ource b!ect /ill be inserted. T#is

location can be eit#er t#e name o' a title dimensionA a speci'ic cell locationA or a named range in t#e target /or6s#eetA

depending on /#at you selected 'or Target Tpe.

%nter t#e Target (b)ect as 'ollo/s;

I' Target Tpe is set to S%@*MA speci'y t#e name o' t#e title dimension in t#e target /or6s#eet. +#en Target Tpe isset to S%@*MA you must also enter a value 'or t#e Subset and Alias 'ields.

I' Target Tpe is set to *amed 'angeA speci'y t#e name o' t#e range in t#e target /or6s#eet.

I' Target Tpe is set to 'angeA speci'y t#e cell location in t#e target /or6s#eet.

You can enter a value 'or t#e Target (b)ect by directly entering t#e location value or you can use an %&cel re'erence toretrieve t#e location.

Directl enter value

To identi'y a location in t#e target /or6s#eetA enter t#e value directly into t#e Target (b)ect 'ield /it#out t#e symbol.(or e&ampleA enter C3 to identi'y t#e location o' t#e Target (b)ect as t#e cell C3 o' t#e target /or6s#eet.

'eference /cel cell

To re'erence a cell in t#e source /or6s#eet t#at contains a location 'or t#e Target b!ectA include t#e symbol. (ore&ampleA t#e cell 1 in t#e source /or6s#eet mig#t contain t#e value C3 to represent t#e cell location 'or t#e Target

b!ect in t#e target /or6s#eet.

Repeat all o' t#e above steps to create more mapping con'igurations.



f 398 25-09-20



E.O.$. /ample of Mapping a Source 9alue to a Target CellT#is e&ample s#o/s t#e mapping o' a #ard)coded value to one cell in t#e target /or6s#eet.



f 398 25-09-20



E.O.-. /ample of Mapping a Source S%@*M to a Target CellYou can speci'y a $U:"M title dimension in t#e source /or6s#eet to map to a corresponding $U:"MA named rangeA or range

?cell@ in t#e target /or6s#eet.

(or e&ampleA t#e 'ollo/ing 'igure s#o/s t#e $ $eries 2. 8 +agon title element being inserted in t#e cell :2 in t#e target/or6s#eet as a 'ormatted caption.



f 398 25-09-20



E.O.8. /ample of Mapping te Selected D@'7 to te Target 7or#seetIn t#is e&ampleA t#e ro/ and column title dimensions 'or t#e selected D:R+ cell are displayed in t#e target /or6s#eet.



f 398 25-09-20



E.10. Modifing an /isting Action @utton'ter an ction button is insertedA you can edit its propertiesA si7eA and location as described in t#e 'ollo/ing sections.

/diting te Caption6 @ac#ground Image6 and +roperties of an /isting Action @utton

To edit t#e properties o' an ction buttonA rig#t)clic6 on t#e button and select an option 'rom t#e menu.

Moving and 'esiing an /isting Action @utton

'ter you clic6 a/ay 'rom a ne/ ction buttonA t#e button becomes enabled and is no longer in design mode. I' you /antto resi7e or move t#e buttonA you must turn on design mode in %&cel as 'ollo/s;



f 398 25-09-20



E.10.1. /diting te Caption6 @ac#ground Image6 and +roperties of an /isting Action@uttonTo edit t#e properties o' an ction buttonA rig#t)clic6 on t#e button and select an option 'rom t#e menu.

T#e rig#t)clic6 menu provides t#e 'ollo/ing main options;

Caption ) pens t#e :utton Caption dialog to edit t#e buttons caption.

@ac#ground Image ) pens a 'ile selection dialog so you can bro/se and select an image to use as t#e bac6ground o' t#e button.

+roperties ) pens t#e ction :utton roperties dialog /#ere you con'igure t#e actions to ta6e place /#en a user clic6st#e button.

+arent topic, Modi'ying an %&isting ction :utton


f 398 25-09-20



E.10.$. Moving and 'esiing an /isting Action @utton'ter you clic6 a/ay 'rom a ne/ ction buttonA t#e button becomes enabled and is no longer in design mode. I' you /ant to

resi7e or move t#e buttonA you must turn on design mode in %&cel as 'ollo/s;

+rocedure

In %&celA clic6 9ie!A ToolbarsA Control Toolbo.

T#e %&cel Control Toolbo& opens.

1.

Clic6 t#e Design Mode button.

T#e te&t labels disappear on t#e ction buttons in t#e current /or6s#eet.

2.

Clic6 on t#e Action button t#at you /ant to move or resi7e.

*andles appear on t#e button indicating it can be resi7ed and moved.

To resi7e t#e buttonA clic6 and drag any o' t#e #andles.

To move t#e buttonA clic6 and drag t#e button to a ne/ location.

3.

%&it design mode by clic6ing on t#e Design Mode button.

T#e #andles on t#e ction button disappear and t#e button returns to active mode.

-.

+arent topic, Modi'ying an %&isting ction :utton


f 398 25-09-20



O. Developing Custom 7eb Applications !it te %'2 A+IIn addition to using I:MH CognosH TM1H +eb as a stand)alone applicationA /eb programmers and TM1 application

developers can use t#e UR8 application programming inter'ace ?I@ to incorporate TM1 +eb ob!ects into custom /eb

applicationsA portalsA and das#boards.

%'2 A+I (vervie!T#e UR8 I 'unctionality is provided by creating UR8 9uery strings t#at display and access t#e 'ollo/ing TM1 +ebob!ects;

@asic %'2 A+I SntaT#e UR8 I is provided t#roug# t#e TM1+ebMain.asp& #andler 'ile. You create a UR8 9uery string using TM1 speci'icparameters and t#en pass t#e completed UR8 to t#e TM1 +eb server. T#e UR8 I can open and display +ebs#eetACubevie/erA and "avigation Tree ob!ects. You can also use t#e UR8 I to apply various actions on t#ese ob!ects.

@asic %'2 A+I Concepts

T#is section describes t#e basic concepts o' using t#e UR8 I;

Accessing te 7ebseet (b)ect +ebs#eet is a Microso't %&cel spreads#eet 'ile /it# TM1 data t#at you can vie/ in a +eb bro/ser. You can use t#e UR8I to display a +ebs#eet as described in t#is section.

Accessing te Cubevie!er (b)ect

T#e Cubevie/er ob!ect displays t#e TM1 cube vie/ in a custom /eb page.

Setting /vent Callbac# Functions for Cubevie!er and 7ebseet (b)ects

You can capture a title element c#ange event in a +ebs#eet or Cubevie/er ob!ect by using t#e TitleC#angeCallbac6parameter in t#e initial UR8 and t#en creating your o/n Fava$cript callbac6 'unction to #andle t#e callbac6 event.

Accessing te *avigation Tree (b)ect

In TM1 +ebA t#e navigation pane contains an organi7ed list o' TM1 applicationsA +ebs#eetsA cubesA and vie/s t#at areavailable 'or a speci'ic user. You can incorporate t#is same navigation list into you o/n custom /eb page using t#e"avigation Tree ob!ect.


f 398 25-09-20



O.1. %'2 A+I (vervie!T#e UR8 I 'unctionality is provided by creating UR8 9uery strings t#at display and access t#e 'ollo/ing TM1H +eb ob!ects;

+ebs#eet

Cubevie/er

"avigation Tree

+arent topic, Developing Custom +eb pplications /it# t#e UR8 I


f 398 25-09-20



O.$. @asic %'2 A+I SntaT#e UR8 I is provided t#roug# t#e TM1+ebMain.asp& #andler 'ile. You create a UR8 9uery string using TM1H speci'ic

parameters and t#en pass t#e completed UR8 to t#e TM1 +eb server. T#e UR8 I can open and display +ebs#eetA

Cubevie/erA and "avigation Tree ob!ects. You can also use t#e UR8 I to apply various actions on t#ese ob!ects.

@ase %'2Use t#e 'ollo/ing base UR8 to begin building a UR8 I call;

+arameters

arameters de'ine /#ic# ob!ect you /ant to access and /#at you /ant to do /it# t#at ob!ect. You build a complete UR8string by adding parameters to t#e base UR8 as 'ollo/s.

(b)ectId +arameter

%ac# UR8 address t#at opens a TM1 +eb ob!ect returns a UR8 /it# t#e b!ectId parameter and value embedded in it asa uni9ue re'erence to t#e speci'ic ob!ect t#at you opened. You can use t#e b!ectId parameter in a ne/ UR8 to per'ormadditional actions on t#e same ob!ect.

%sing %'2 /scape Caracters+e recommend using UR8 escape c#aracters /#en creating UR8s t#at contain spaces or ot#er special c#aracters.



f 398 25-09-20



O.$.1. @ase %'2Use t#e 'ollo/ing base UR8 to begin building a UR8 I call;

http://<HostName>/TM1Web/TM1WebMain.aspx

/#ere *ostame can be t#e domain name or I address o' t#e /eb site or computer #osting t#e TM1H +eb server.

(or e&ampleA i' t#e TM1 +eb server is running on a remote computer called my/ebserverA use t#e name o' t#at system 'ort#e *ost"ame as 'ollo/s;

http:// mywebserver/TM1Web/TM1WebMain.aspx

+arent topic, :asic UR8 I $ynta&


f 398 25-09-20



O.$.$. +arametersarameters de'ine /#ic# ob!ect you /ant to access and /#at you /ant to do /it# t#at ob!ect. You build a complete UR8

string by adding parameters to t#e base UR8 as 'ollo/s.

(or e&ampleA t#e 'ollo/ing UR8 opens t#e Cubevie/er ob!ect 'or t#e $alesCube cube and displays t#e vie/ called Region.

http://mywebserver/TM1Web/TM1WebMain.aspx?action=OpenObject&type=Cubeviewer&value=SalesCube$$Region



f 398 25-09-20



O.$.-. (b)ectId +arameter%ac# UR8 address t#at opens a TM1H +eb ob!ect returns a UR8 /it# t#e b!ectId parameter and value embedded in it as a

uni9ue re'erence to t#e speci'ic ob!ect t#at you opened. You can use t#e b!ectId parameter in a ne/ UR8 to per'orm

additional actions on t#e same ob!ect.

http://mywebserver/TM1Web/TM1WebSheet.aspx?Objectid=

id_value

(or details on using t#e b!ectId parameterA see perating on an %&isting TM1 +eb b!ect /it# t#e b!ectId arameter.



f 398 25-09-20



O.$.8. %sing %'2 /scape Caracters+e recommend using UR8 escape c#aracters /#en creating UR8s t#at contain spaces or ot#er special c#aracters.

$ome common e&amples o' UR8 escape c#aracters include;

Caracter /scape Caracter

$pace %20

[ %24

> %25

` %26

(or e&ampleA /#en including a vie/ name in your UR8 t#at contains spacesA suc# as My $ales 5ie/A use t#e 'ollo/ing'ormat;



f 398 25-09-20



O.-. @asic %'2 A+I ConceptsT#is section describes t#e basic concepts o' using t#e UR8 I;

$etting dmin *ost "ame and TM1H +eb $erver "ame arameters

Managing User 8ogin and 8ogout

Using t#e ction arameter

Using t#e penb!ect arameter to pen a TM1 +eb b!ect

perating on an %&isting TM1 +eb b!ect /it# t#e b!ectId arameter

Setting Admin 3ost *ame and TM1 7eb Server *ame +arametersYou can set t#e dmin *ost and server name in t#e UR8 9uery string by using t#e AdminHost and TM1Server parameters

as 'ollo/s;

Managing %ser 2ogin and 2ogout

Users must log into t#e I:M Cognos TM1 server /#en using t#e UR8 I to vie/ TM1 +eb ob!ects. You can manage t#euser login process in any o' t#e 'ollo/ing /ays;

%sing te Action +arameter !it TM1 7eb ob)ects

T#e action parameter speci'ies /#at type o' action to run on a TM1 +eb ob!ect. Use t#e action parameter in t#e UR89uery string as 'ollo/s;

%sing te (pen(b)ect +arameter to (pen a TM1 7eb (b)ect

To open and display a TM1 +eb ob!ectA use t#e action=OpenObject command and t#e Type parameter in t#e 'ollo/inggeneral 'ormat;

(perating on an /isting TM1 7eb (b)ect !it te (b)ectId +arameterUse t#e b!ectId parameter in a ne/ UR8 /#en you /ant to per'orm actions on a TM1 +eb ob!ect t#at is alreadyopened. T#e b!ectIdob!ect]id parameter and value identi'y t#e ob!ect on /#ic# t#e operation needs to ta6e place.



f 398 25-09-20



O.-.1. Setting Admin 3ost *ame and TM1 7eb Server *ame +arametersYou can set t#e dmin *ost and server name in t#e UR8 9uery string by using t#e AdminHost and TM1Server parameters as

'ollo/s;

&AdminHost=<value>&TM1Server=<value>

T#ese values are optional in t#e UR8A but must be provided to TM1H in eit#er t#e /eb.con'ig 'ile or t#e UR8 string. I' t#esevalues are not 'oundA t#en TM1 /ill prompt t#e user 'or t#is in'ormation /it# a mini pop up /indo/.

TM1 loo6s 'or dmin *ost and server name in t#e 'ollo/ing order;

I' t#e dmin*ost and TM1$erver parameters are set in t#e UR8A t#ey /ill override t#e values in t#e /eb.con'ig 'ile.

I' t#ese values are absent in t#e UR8 9uery stringA TM1 +eb /ill try to determine i' t#ey are set in t#e /eb.con'ig 'ile.

I' t#e AdminHost and TM1Server parameters are absent 'rom t#e UR8 string and also not in t#e /eb.con'ig 'ileA t#en t#e

entry 'ields 'or dmin *ost and server /ill be displayed 'or t#e user in a mini)login 'orm.

+arent topic, :asic UR8 I Concepts


f 398 25-09-20



O.-.$. Managing %ser 2ogin and 2ogoutUsers must log into t#e I:MH CognosH TM1H server /#en using t#e UR8 I to vie/ TM1 +eb ob!ects. You can manage t#e

user login process in any o' t#e 'ollo/ing /ays;

Integrated 2ogin ) Use Microso't +indo/s net/or6 aut#entication to control access to TM1 data. (or more detailsA seet#e I:M Cognos TM1 Operations Guide.

Include in %'2 ) $peci'y login in'ormation in t#e UR8 /#en accessing TM1 +eb ob!ects. T#e UR8 must include values'or dmin*ostA TM1$erverA User"ameA and ass/ord.

$peci'ying a pass/ord /it#in UR8 is not secure.

Mini 2ogin +opup ) I' allA or someA o' t#e login in'ormation #as not been provided in any ot#er /ayA t#en a mini pop up/indo/ displays to prompt t#e user to login be'ore t#e TM1 +eb ob!ects can be displayed.

Custom 2ogin +age ) You can create your o/n custom login page by using t#e TM1 login #andler 'ileATM1+eb8ogin*andler.asp&A to process login re9uests t#roug# eit#er a UR8 ,%T or a 'orm $T met#od. (or eit#ermet#odA you must provide values 'or dmin*ostA TM1$erverA User"ameA and ass/ord to t#e TM1+eb8ogin*andler.asp&'ile.

n e&ample o' a custom login using t#e TM1+eb8ogin*andler.asp& 'ile and t#e 'orm ost met#od 'ollo/s;

<form method="post" action="TM1WebLoginHandler.aspx?">

<input name="AdminHost" id="AdminHost" type="text" value="">

<br>

<input name="TM1Server" id="TM1Server" type="text" value="sdata">

<br><input name="UserName" id="UserName" type="text" value="admin">

<br>

<input name="Password" id="Password" type="password" value="">

<br>

<input name="SubmitBtn" id="SubmitBtn" type="submit" value="Login"

/>

</form>

'ter logging inA you can redirect t#e user to a di''erent UR8 by adding t#e redirect parameter to t#e login UR8 as 'ollo/s;

redirect=newUrl

/#ere ne/UR8 can be any valid UR8 to navigate to a'ter logging in. (or e&ample;

redirect=myStartPage.html

I' a login error occursA TM1 inserts t#e error message into t#e returned UR8 in t#e 'ollo/ing 'ormat;

error=error_message

/#ere error]message describes t#e error t#at occurred.

2ogging (ut

To logoutA use t#e 'ollo/ing UR8 component;



f 398 25-09-20



O.-.$.1. 2ogging (utTo logoutA use t#e 'ollo/ing UR8 component;

action=Logout

I' you include t#e redirect parameterA t#e user /ill be redirected to a speci'ied UR8 a'ter logging out. Use t#e 'ollo/ing'ormat to speci'y a value 'or t#e redirect parameter;

action=Logout&redirect=newURL

/#ere ne/UR8 can be any valid UR8 'or t#e user to be redirected to a'ter logging out.+arent topic, Managing User 8ogin and 8ogout


f 398 25-09-20



O.-.-. %sing te Action +arameter !it TM1 7eb ob)ectsT#e action parameter speci'ies /#at type o' action to run on a TM1H +eb ob!ect. Use t#e action parameter in t#e UR8 9uery

string as 'ollo/s;

action=<TypeOfAction>

/#ere TypeOf+ction can be one o' t#e 'ollo/ing values;

Action Description

Close Closes an e&isting ob!ect.

%&ample;

action=Close

Logout 8ogs t#e user out 'rom t#e current server session.

%&ample;

action=Logout

OpenObject pens a TM1 +eb ob!ect.

%&ample;

action=OpenObject

(or an overvie/ o' using t#e OpenObject actionA see Using t#e penb!ect arameter to pen

a TM1 +eb b!ect.

Rebuild Recalculates all values and rebuilds all subsets 'or a TM1 ctive (orm contained in a+ebs#eet.

T#is action per'orms t#e same action as /#en you clic6 t#e Rebuild button on t#e TM1 +ebtoolbar.

%&ample;

action=Rebuild

Recalc Recalculates an e&isting +ebs#eet or Cubevie/er ob!ect.

%&ample;

action=Recalc

Reload Reloads t#e Cubevie/er ob!ect only.

%&ample;

action=Reload

Save $aves c#anges made to t#e data values in a +ebs#eet or Cubevie/er ob!ect.

%&ample;

action=Save

*ote, T#e Save command does not save t#e dimension layout o' t#e vie/. nly t#e c#anged

data values are saved to TM1 . (or e&ampleA i' you re)arrange t#e dimensions in t#e vie/ and

t#en use t#e $ave actionA t#e ne/ settings 'or t#e vie/ layout are not saved.


f 398 25-09-20





f 398 25-09-20



O.-.8. %sing te (pen(b)ect +arameter to (pen a TM1 7eb (b)ectTo open and display a TM1H +eb ob!ectA use t#e action=OpenObject command and t#e Type parameter in t#e 'ollo/ing

general 'ormat;

action=OpenObject&type=object_type

/#ere ob,ect#type can be WebsheetA CubeviewerA or NavigationTree.

Depending on t#e ob!ect typeA additional options and parameters are re9uired as described in t#e ne&t sections.

(pening 7ebseet and Cubevie!er ob)ectsYou can use t#e penb!ect command to open +ebs#eet and Cubevie/er ob!ects in any o' t#e 'ollo/ing /ays;

(pening te *avigation Tree ob)ectTo open t#e "avigation Tree ob!ectA set t#e type parameter to NavigationTree.



f 398 25-09-20



O.-.8.1. (pening 7ebseet and Cubevie!er ob)ectsYou can use t#e penb!ect command to open +ebs#eet and Cubevie/er ob!ects in any o' t#e 'ollo/ing /ays;

TM1V (b)ect +at ) pens an ob!ect using t#e name and location o' t#e ob!ect as used internally by TM1 .

(or detailsA see Using t#e TM1 b!ect at# to pen a +ebs#eet b!ect and Using t#e TM1 b!ect at# to pen aCubevie/er b!ect.

Application (rganier +at ) llo/s you to use t#e visual pat# in t#e TM1 "avigation pane to speci'y t#e +ebs#eet orcube vie/ you /ant to open.

(or detailsA see Using t#e pplication rgani7er at# to pen a +ebs#eet b!ect and Using t#e pplication rgani7erat# to pen a Cubevie/er b!ect.

M2 Tree *ode ID ) pens an ob!ect using t#e uni9ue ID o' t#e ob!ect 'rom t#e EM8 version o' t#e "avigation Treeob!ect.

(or details see Using EM8 Tree "ode IDs to pen +ebs#eet and Cubevie/er b!ects.

You can also set t#e title selection and ot#er display properties in t#e same UR8 /#en using t#e (pen(b)ect command.

+arent topic, Using t#e penb!ect arameter to pen a TM1 +eb b!ect


f 398 25-09-20



O.-.8.$. (pening te *avigation Tree ob)ectTo open t#e "avigation Tree ob!ectA set t#e type parameter to NavigationTree.

action=OpenObject&type=NavigationTree

(or more detailsA see ccessing t#e "avigation Tree b!ect.

+arent topic, Using t#e penb!ect arameter to pen a TM1 +eb b!ect


f 398 25-09-20



O.-.=. (perating on an /isting TM1 7eb (b)ect !it te (b)ectId +arameterUse t#e b!ectId parameter in a ne/ UR8 /#en you /ant to per'orm actions on a TM1H +eb ob!ect t#at is already opened.

T#e b!ectIdob!ect]id parameter and value identi'y t#e ob!ect on /#ic# t#e operation needs to ta6e place.

'ter a TM1 +eb ob!ect is opened using t#e actionpenb!ect commandA t#e b!ectId is embedded into t#e returned UR8in t#e 'ollo/ing 'ormat;

ObjectId=id_value

/#ere id#value is a uni9ue number t#at you can use to re'erence t#e speci'ic TM1 ob!ect.

(or e&ampleA opening a Cubevie/er ob!ect returns t#e b!ectId in a UR8 similar to t#is;

http://mywebserver/TM1Web/TM1WebCubeviewer.aspx?ObjectId=83

'ter t#e ob!ect is initially opened in t#e /eb page documentA you can obtain t#e b!ectId value programmatically by parsingt#roug# t#e returned UR8.

dd ObjectId=object_id to t#e ne/ UR8 t#at you submit /#en per'orming an action on a speci'ic TM1 +eb ob!ect.

(or e&ampleA to recalculate t#is same cubeA create a UR8 t#at includes t#e b!ectId 'or t#e cube along /it# t#e recalc actionas 'ollo/s;

http://mywebserver/TM1Web/TM1WebMain.aspx?ObjectId=83&action=recalc

*ote, I' t#e ObjectIdparameter is missing 'rom t#e UR8 t#at you submitA TM1 per'orms t#e action on t#e currently active

ob!ect.



f 398 25-09-20



O.8. Accessing te 7ebseet (b)ect +ebs#eet is a Microso't %&cel spreads#eet 'ile /it# TM1H data t#at you can vie/ in a +eb bro/ser. You can use t#e UR8

I to display a +ebs#eet as described in t#is section.

(pening a 7ebseet (b)ectUse one o' t#e 'ollo/ing /ays to identi'y t#e +ebs#eet you /ant to open.

Selecting Title /lements for a 7ebseet (b)ect

You can set t#e title elements 'or a +ebs#eet ob!ect using t#e title]$^)R^)C^ parameter 'or any cell t#at contains a

$U:"M 'unction.Appling Actions to a 7ebseet (b)ect

You can use t#e ction arameter /it# a +ebs#eet b!ect.

Setting Displa +roperties for te 7ebseet (b)ect

You can set t#e 'ollo/ing display properties 'or t#e +ebs#eet ob!ect by including any o' t#ese properties in your UR8using t#e 'ormat;



f 398 25-09-20



O.8.1. (pening a 7ebseet (b)ectUse one o' t#e 'ollo/ing /ays to identi'y t#e +ebs#eet you /ant to open.

TM1H b!ect pat#

TM1 pplication rgani7er pat#

EM8 Tree "ode ID

%sing te TM1 (b)ect +at to (pen a 7ebseet (b)ect

To open a +ebs#eet ob!ect using t#e TM1 ob!ect pat#A use one o' t#e 'ollo/ing 'ormatsA depending on /#et#er t#e+ebs#eet e&ists as a re'erenced %&cel 'ile outside o' TM1 A or as an internal %&cel 'ile t#at /as uploaded to t#e I:MHCognosH TM1 server ;

%sing te Application (rganier +at to (pen a 7ebseet (b)ectYou can use t#e location pat# to a +ebs#eet ob!ect in t#e TM1 pplication rgani7er to open t#e ob!ect as 'ollo/s.

%sing an M2 Tree *ode ID to (pen a 7ebseet (b)ect

Use t#e penb!ect command /it# t#e Tree "ode ID valueA obtained 'rom t#e EM8 version o' t#e "avigation Tree ob!ectAto open a +ebs#eet ob!ect as 'ollo/s;

+arent topic, ccessing t#e +ebs#eet b!ect


f 398 25-09-20



O.8.1.1. %sing te TM1 (b)ect +at to (pen a 7ebseet (b)ectTo open a +ebs#eet ob!ect using t#e TM1H ob!ect pat#A use one o' t#e 'ollo/ing 'ormatsA depending on /#et#er t#e

+ebs#eet e&ists as a re'erenced %&cel 'ile outside o' TM1 A or as an internal %&cel 'ile t#at /as uploaded to t#e I:MH

CognosH TM1 server ;

To open a +ebs#eet t#at e&ists as a referenced %&cel 'ileA outside o' TM1 ;

&action=OpenObject&type=Websheet&value=

WebsheetPath

/#ere -ebsheetath is t#e location and name o' t#e e&ternal %&cel 'ile. T#is can be eit#er a pat# 'or a local 'ileA or a U"Cpat# 'or a 'ile located on a net/or6.

(or e&ample;

&action=OpenObject&type=Websheet&value=C:\Samples\classic_slice.xls

or

&action=OpenObject&type=Websheet&value=//MySystem/Samples/classic_slice.xls

+rocedure

In $erver %&plorerA use t#e +roperties pane to 'ind Sstem *ameA /#ic# is t#e TM1 assigned name 'or t#e uploaded%&cel 'ile.

1.

$et t#e value parameter in t#e UR8 using t#e 'ollo/ing 'ormat;

&action=OpenObject&type=Websheet&value=

TM1://ServerName/blob/PUBLIC/.\}Externals\TM1_Filename

/#ere;

!erverame is t#e name o' t#e I:M Cognos TM1 server /#ere t#e %&cel 'ile is located.

T"'#(ilename is t#e name t#at TM1 assigned to t#e uploaded %&cel 'ile.

(or e&ample;

&action=OpenObject&type=Websheet&value=TM1://sdata/blob/PUBLIC/.\}Externals\

Report_2006.xls_20070123212746.xls

2.

+arent topic, pening a +ebs#eet b!ect


f 398 25-09-20



O.8.1.$. %sing te Application (rganier +at to (pen a 7ebseet (b)ectYou can use t#e location pat# to a +ebs#eet ob!ect in t#e TM1H pplication rgani7er to open t#e ob!ect as 'ollo/s.

+rocedure

In $erver %&plorerA e&pand t#e pplication tree to locate t#e +ebs#eet you /ant to open.1.

:uild a string t#at represents t#e pat# to t#e ob!ect. $tart t#e pat# /it# pplications and separate any sub)'olders /it#t#e slas# symbol.

(or e&ample; Applications/My Reports/Report_2005.xls

2.

$et t#e value parameter in your UR8 to t#e pplication pat# you assembled.

action=OpenObject&type=Websheet&value= Applications/My Reports/Report_2005.xls

3.



f 398 25-09-20



O.8.1.-. %sing an M2 Tree *ode ID to (pen a 7ebseet (b)ectUse t#e penb!ect command /it# t#e Tree "ode ID valueA obtained 'rom t#e EM8 version o' t#e "avigation Tree ob!ectA to

open a +ebs#eet ob!ect as 'ollo/s;

action=OpenObject&type=Websheet&value=TreeNodeID

(or detailsA see Using EM8 Tree "ode IDs to pen +ebs#eet and Cubevie/er b!ects.



f 398 25-09-20



O.8.$. Selecting Title /lements for a 7ebseet (b)ectYou can set t#e title elements 'or a +ebs#eet ob!ect using t#e title]$^)R^)C^ parameter 'or any cell t#at contains a $U:"M

'unction.

dd t#e title]$^)R^)C^ parameter to your UR8 using t#e 'ollo/ing 'ormat;

title_ S#-R#-C#=element

/#ere;

S#-R#-C# de'ines t#e s#eet numberA ro/ number and column number 'or t#e location o' t#e $U:"M cell in t#e +ebs#eet.Replace t#e ^ symbols /it# your values 'or s#eetA ro/A and column number.

element is t#e string value 'or t#e name o' t#e ne/ title element you /ant to select.

I' you /ant to select t#e ne/ title element by element inde&A instead o' element nameA include t#e UseInde& parameter int#e UR8 as 'ollo/s;

title_S#-R#-C#=element&UseIndex=yes

or

title_S#-R#-C#=element&UseIndex=1



f 398 25-09-20



O.8.-. Appling Actions to a 7ebseet (b)ectYou can use t#e ction arameter /it# a +ebs#eet b!ect.

$ee Using t#e ction arameter /it# TM1 +eb ob!ects.



f 398 25-09-20



O.8.8. Setting Displa +roperties for te 7ebseet (b)ectYou can set t#e 'ollo/ing display properties 'or t#e +ebs#eet ob!ect by including any o' t#ese properties in your UR8 using

t#e 'ormat;

& property =value

(or e&ampleA add t#e 'ollo/ing line to your UR8 to turn o'' t#e display o' t#e toolbar.

&HideToolbar=yes

+ropert Description

HideToolbar Turns t#e tool bar on or o''. De'ault is on.

To turn o'' t#e tool bar;

HideToolbar=yes

HideToolbar=1

To turn on t#e tool bar;

HideToolbar=no

HideToolbar=0

AutoRecalc Turns automatic recalculation on or o''. De'ault is o''.

To turn o'' automatic recalculationA use one o' t#e 'ollo/ing;

AutoRecalc=off

AutoRecalc=no

AutoRecalc=0

To turn on automatic recalculationA use one o' t#e 'ollo/ing;

AutoRecalc=on

AutoRecalc=yes

AutoRecalc=1

HideTabs Turns t#e display o' t#e tabs on or o''. :y de'aultA TM1H uses t#e system propertyto determine i' tabs are s#o/n or not.

To turn o'' tabs;

HideTabs=yes

HideTabs=1

To turn on tabs;

HideTabs=no

HideTabs=0



f 398 25-09-20



O.=. Accessing te Cubevie!er (b)ectT#e Cubevie/er ob!ect displays t#e TM1H cube vie/ in a custom /eb page.

(pening a Cubevie!er (b)ect

Use one o' t#e 'ollo/ing /ays to identi'y t#e cube vie/ you /ant to open.

Setting Displa +roperties for te Cubevie!er (b)ect

You can set t#e 'ollo/ing display properties 'or t#e Cubevie/er ob!ect by including any o' t#ese properties in your UR8using t#e 'ormat;

Selecting Title /lements for te Cubevie!er (b)ect

You can set t#e title elements in a Cubevie/er ob!ect by adding t#e title parameter to your UR8 using t#e 'ollo/ing'ormat;

Appling Actions to a Cubevie!er (b)ect

You can apply t#e action parameter /it# t#e Cubevie/er ob!ect.

Displaing Carts !it te Cubevie!er (b)ect$imilar to TM1 +ebA t#e Cubevie/er ob!ect can display TM1 data in grid)onlyA c#art)onlyA or combination grid and c#artmode. Use t#e parameters described in t#is section to control c#art display optionsA suc# as c#art typeA colorsA and si7e.



f 398 25-09-20



O.=.1. (pening a Cubevie!er (b)ectUse one o' t#e 'ollo/ing /ays to identi'y t#e cube vie/ you /ant to open.

TM1H b!ect pat#

TM1 pplication rgani7er pat#

EM8 Tree "ode ID

%sing te TM1 (b)ect +at to (pen a Cubevie!er (b)ect

Use t#e 'ollo/ing 'ormat to open a Cubevie/er ob!ect /it# t#e TM1 ob!ect pat#;

%sing te Application (rganier +at to (pen a Cubevie!er (b)ect

You can use t#e location pat# to a cube vie/ ob!ect in t#e TM1 pplication rgani7er to open t#e ob!ect as 'ollo/s.

%sing an M2 Tree *ode ID to (pen a Cubevie!er (b)ect

Use t#e OpenObject command /it# t#e Tree "ode ID valueA obtained 'rom t#e EM8 version o' t#e "avigation Tree ob!ectA

to open a Cubevie/er ob!ect as 'ollo/s;

+arent topic, ccessing t#e Cubevie/er b!ect


f 398 25-09-20



O.=.1.1. %sing te TM1 (b)ect +at to (pen a Cubevie!er (b)ectUse t#e 'ollo/ing 'ormat to open a Cubevie/er ob!ect /it# t#e TM1H ob!ect pat#;

action=OpenObject&type=Cubeviewer&value= CubeName $$ ViewName $$ Status

/#ere;

)ubeame is t#e name o' cube to /#ic# t#e vie/ belongs.

/iewame is t#e name o' cube vie/.

!tatus is t#e public or private status o' t#e cube vie/.

*ote, You must include a value o' eit#er PUBLICor PRIVATEin all uppercase c#aracters to correctly identi'y t#e speci'ic cube

vie/ t#at you /ant to open.

(or e&ample;

action=OpenObject&type=Cubeviewer&value=SalesCube$$Price$$PUBLIC

+arent topic, pening a Cubevie/er b!ect


f 398 25-09-20



O.=.1.$. %sing te Application (rganier +at to (pen a Cubevie!er (b)ectYou can use t#e location pat# to a cube vie/ ob!ect in t#e TM1H pplication rgani7er to open t#e ob!ect as 'ollo/s.

+rocedure

In $erver %&plorerA e&pand t#e pplication tree to locate t#e cube vie/ you /ant to open.1.

:uild a string t#at represents t#e pat# to t#e ob!ect. $tart t#e pat# /it# Applications/ and separate any sub)'olders

/it# t#e slas# symbol.

(or e&ample; Applications/MyReports/Price

2.

$et t#e value parameter in your UR8 to t#e pplication pat# you assembled.

action=OpenObject&type=Websheet&value= Applications/MyReports/Price

3.



f 398 25-09-20



O.=.1.-. %sing an M2 Tree *ode ID to (pen a Cubevie!er (b)ectUse t#e OpenObject command /it# t#e Tree "ode ID valueA obtained 'rom t#e EM8 version o' t#e "avigation Tree ob!ectA to

open a Cubevie/er ob!ect as 'ollo/s;

action=OpenObject&type=Cubeviewer&value=

TreeNodeID

(or detailsA see Using EM8 Tree "ode IDs to pen +ebs#eet and Cubevie/er b!ects.



f 398 25-09-20



O.=.$. Setting Displa +roperties for te Cubevie!er (b)ectYou can set t#e 'ollo/ing display properties 'or t#e Cubevie/er ob!ect by including any o' t#ese properties in your UR8 using

t#e 'ormat;

& property =value

(or e&ampleA add t#e 'ollo/ing line to your UR8 to turn o'' t#e display o' t#e toolbar;

&HideToolbar=yes

Action Description

HideToolbar Turns t#e tool bar on or o''. De'ault is on.

To turn o'' t#e tool bar;

HideToolbar=yes

HideToolbar=1

To turn on t#e tool bar;

HideToolbar=no

HideToolbar=0

AutoRecalc Turns automatic recalculation on or o''. De'ault is o''.

To turn o'' automatic recalculation;

AutoRecalc=off

AutoRecalc=no

AutoRecalc=0

To turn on automatic recalculation;

AutoRecalc=on

AutoRecalc=yes

AutoRecalc=1

HideTabs Turns t#e display o' t#e tabs on or o''. :y de'aultA TM1H uses t#e systemproperty to determine i' tabs are s#o/n or not.

To turn o'' tabs;

HideTabs=yes

HideTabs=1

To turn on tabs;

HideTabs=no

HideTabs=0

HideTitlebar Turns t#e title bar on or o''. De'ault setting is on.

To turn o'' t#e title bar;

HideTitlebar=yes

HideTitlebar=1

To turn on t#e title bar;


f 398 25-09-20



Action Description

HideTitlebar=no

HideTitlebar=0

*ote, T#is setting applies to t#e Cubevie/er ob!ect only.



f 398 25-09-20



O.=.-. Selecting Title /lements for te Cubevie!er (b)ectYou can set t#e title elements in a Cubevie/er ob!ect by adding t#e title parameter to your UR8 using t#e 'ollo/ing 'ormat;

&title_ DimensionName=

element

/#ere;

0imensioname is t#e name o' t#e title dimension t#at you /ant to c#ange.

element is t#e string value 'or t#e name o' t#e ne/ title element you /ant to select.

I' you /ant to select t#e ne/ title element by element inde&A instead o' element nameA include t#e UseInde& parameter int#e UR8 as 'ollo/s;

&title_DimensionName=element&UseIndex=yes

Or

&title_DimensionName=element&UseIndex=1



f 398 25-09-20



O.=.8. Appling Actions to a Cubevie!er (b)ectYou can apply t#e action parameter /it# t#e Cubevie/er ob!ect.

$ee Using t#e ction arameter /it# TM1 +eb ob!ects.



f 398 25-09-20



O.=.=. Displaing Carts !it te Cubevie!er (b)ect$imilar to TM1H +ebA t#e Cubevie/er ob!ect can display TM1 data in grid)onlyA c#art)onlyA or combination grid and c#art

mode. Use t#e parameters described in t#is section to control c#art display optionsA suc# as c#art typeA colorsA and si7e.

Setting @asic Cart (ptionsT#e Cubevie/er ob!ect #as t#e 'ollo/ing basic c#art options;

Selecting Cart Tpe

$et t#e type o' c#art you /ant to display by using t#e ChartType parameter in 'ollo/ing 'ormat;

Setting Cart Color

$et t#e color palette 'or a c#art by using t#e Coloralette parameter as 'ollo/s;



f 398 25-09-20



O.=.=.1. Setting @asic Cart (ptionsT#e Cubevie/er ob!ect #as t#e 'ollo/ing basic c#art options;

(ption Description

ChartOnly Displays t#e Cubevie/er ob!ect in c#art)only mode.

%&amples;ChartOnly=yes

ChartOnly=1

GridOnly Displays t#e Cubevie/er ob!ect in grid)only mode.

%&amples;

GridOnly=yes

GridOnly=1

GridAndChart Displays t#e Cubevie/er ob!ect /it# bot# a grid and c#art.

%&amples;

GridAndChart=yes

GridAndChart=1

ChartSize Use t#is parameter to set t#e display si7e o' a c#art.

(ormat; ChartSize= widthAheight

/#ere t#e values 'or width and height are in pi&els.

3DView Turn 3D vie/ o' t#e c#art on and o''.

To turn on 3D vie/;

3DView=yes

3DView=1

To turn o'' 3D vie/;

3DView=no

3DView=0

ShowLegend Displays a legend 'or a c#art.

To turn on c#art legend;ShowLegend=yes

ShowLegend=1

To turn o'' c#art legend;

ShowLegend=no

ShowLegend=0

+arent topic, Displaying C#arts /it# t#e Cubevie/er b!ect


f 398 25-09-20



O.=.=.$. Selecting Cart Tpe$et t#e type o' c#art you /ant to display by using t#e ChartType parameter in 'ollo/ing 'ormat;

ChartType=x

/#ere x can be t#e numeric value 'or one o' t#e 'ollo/ing de'ined c#art types;

9alue Cart Tpe

oint

1 :ubble

2 8ine

3 $pline

- $tepline

0 (astline

:ar

$tac6edbar

< $tac6edbar1

B Column

1 $tac6edcolumn

11 $tac6edcolumn1

12 rea

13 $plinearea

1- $tac6edarea

10 $tac6edarea1

1 ie

1 Doug#nut

1< $toc6


f 398 25-09-20



9alue Cart Tpe

1B Candlestic6

2 Range

21 $plinerange

22 ,antt

23 Rangecolumn

2- Radar

20 olor

2 :o&plot

2 (unnel

2< yramid



f 398 25-09-20



O.=.=.-. Setting Cart Color$et t#e color palette 'or a c#art by using t#e Coloralette parameter as 'ollo/s;

ColorPalette=x

/#ere x can be t#e numeric value 'or one o' t#e 'ollo/ing de'ined color palettes;

*umber Color +alette

1 De'ault

2 8ig#t $teel :lue

3 %art# Tones

- ,ray $cale

0 $emi Transparent

%&cel 8i6e

8ig#t :eige

< :erry

B C#ocolate

1 (ire

11 ,reenblue



f 398 25-09-20



O.>. Setting /vent Callbac# Functions for Cubevie!er and 7ebseet (b)ectsYou can capture a title element c#ange event in a +ebs#eet or Cubevie/er ob!ect by using t#e TitleC#angeCallbac6

parameter in t#e initial UR8 and t#en creating your o/n Fava$cript callbac6 'unction to #andle t#e callbac6 event.

(or a +ebs#eetA you can capture t#e title c#ange event on a $U:"M cell.

(or a Cubevie/erA you can capture t#e c#ange o' a title dimension.

/nabling a Callbac# Function for 7ebseet and Cubevie!er (b)ects

T#e overall steps 'or enabling a callbac6 'unction are;

Setting a Global Callbac# Function for All Title Dimensions

To capture c#ange events 'or all title dimension in a +ebs#eet or Cubevie/er ob!ectA use t#e TitleC#angeCallbac6parameter /it#out speci'ying a speci'ic title dimension. I' a title dimension or $U:"M cell location is not speci'ied in t#eUR8A t#en t#e callbac6 'unction /ill capture c#ange events 'or all $U:"M cells in a +ebs#eet ob!ectA or all titledimensions in a Cubevie/er ob!ect.



f 398 25-09-20



O.>.1. /nabling a Callbac# Function for 7ebseet and Cubevie!er (b)ectsT#e overall steps 'or enabling a callbac6 'unction are;

+rocedure

dd t#e TitleC#angeCallbac6 parameter to t#e initial UR8 t#at opens t#e +ebs#eet or Cubevie/er ob!ect. Use one o' t#e'ollo/ing general 'ormats;

(or +ebs#eet ob!ects onlyA set callbac6 'or a speci'ic title dimension by $U:"M cell location.

&TitleChangeCallback_ Sheet-Row-Column=JSFunction(jsFunctionSignature)

(or +ebs#eet and Cubevie/er ob!ectsA set callbac6 'or a speci'ic title dimension by dimension name.

&TitleChangeCallback_ DimensionName=JSFunction(jsFunctionSignature)

(or +ebs#eet and Cubevie/er ob!ectsA set a global callbac6 'unction t#at applies to all title dimensions.

&TitleChangeCallback=jsFunctionName(jsFunctionSignature)

1.

Create your o/n Fava$cript callbac6 'unction to #andle t#e callbac6 eventA using t#e same 'unction signature t#at youprovided in t#e UR8. (or e&ample;

function jsFunctionName(jsFunctionSignature)

{ // add code here to handle the callback event}

2.

Setting a Callbac# Function for a Specific Title Dimension

You can set a callbac6 'unction 'or a speci'ic title dimension by speci'ying t#e dimensions $U:"M cell location ordimension name.

Setting a Callbac# Function for 7ebseet (b)ects (nlYou can use t#e TitleChangeCallback_S#-R#-C# parameter in your UR8 to set a callbac6 'unction 'or a speci'ic

dimension based on t#e $U:"M cell dimensions s#eetA ro/A column in t#e +ebs#eet.

Setting a Callbac# Function for 7ebseet and Cubevie!er (b)ects

Use t#e TitleChangeCallback_DimensionName parameter to speci'y a callbac6 'unction 'or a speci'ic title dimension

based on t#e name o' t#e dimension.

+arent topic, $etting %vent Callbac6 (unctions 'or Cubevie/er and +ebs#eet b!ects


f 398 25-09-20



O.>.1.1. Setting a Callbac# Function for a Specific Title DimensionYou can set a callbac6 'unction 'or a speci'ic title dimension by speci'ying t#e dimensions $U:"M cell location or dimension

name.

+arent topic, %nabling a Callbac6 (unction 'or +ebs#eet and Cubevie/er b!ects


f 398 25-09-20



O.>.1.$. Setting a Callbac# Function for 7ebseet (b)ects (nlYou can use t#e TitleChangeCallback_S#-R#-C# parameter in your UR8 to set a callbac6 'unction 'or a speci'ic dimension

based on t#e $U:"M cell dimensions s#eetA ro/A column in t#e +ebs#eet.

Use t#e 'ollo/ing 'ormat to speci'y a title dimension by s#eetA ro/A column location in a +ebs#eet;

&TitleChangeCallback_S#-R#-C# =JSFunction(arg1,

$dimName$, $subsetName$,

$elemName$, arg2...)

/#ere;

!1&R1&)1 is t#e s#eetA ro/A and column numbers o' t#e cell in t#e +ebs#eet t#at contains t#e SUBNM 'unction. Replace

t#e ^ symbols /it# your values 'or s#eetA ro/A and column number.

,s(unction is t#e name o' your o/n Fava$cript 'unction t#at /ill #andle t#e callbac6 event. dd code 'or t#is 'unction inyour /ebpageA using t#e same 'unction signature t#at you provide in t#e UR8.

arg'2 arg3 ... represents ot#er user)de'ined arguments in your callbac6 'unction.

I' you include 4dimame4A 4subsetame4A 4elemame4A in t#e callbac6 'unctionA t#ese arguments /ill dynamically bereplaced /it# t#e string value o' t#e dimensionA subsetA and element t#at t#e user selected.

4dimame4 is t#e name o' t#e title dimension t#at t#e user selected.

4subsetame4 is t#e name o' t#e subset 'or t#e title dimension.

4elemame4 is t#e element name t#at t#e user selected.



f 398 25-09-20



O.>.1.-. Setting a Callbac# Function for 7ebseet and Cubevie!er (b)ectsUse t#e TitleChangeCallback_DimensionName parameter to speci'y a callbac6 'unction 'or a speci'ic title dimension based

on t#e name o' t#e dimension.

&TitleChangeCallback_ DimensionName=J

SFunction(arg1,$dimName$,

$subsetName$, $elemName$,

arg2 ...)

/#ere;

0imensioname is t#e name o' t#e title dimension in t#e +ebs#eet or Cubevie/er ob!ect t#at /ill trigger t#e callbac6event.

,s(unction is t#e name o' your o/n Fava$cript 'unction t#at /ill #andle t#e callbac6 event. dd code 'or t#is 'unction inyour /ebpageA using t#e same 'unction signature t#at you provide in t#e UR8.


I' you include [dim"ame[A [subset"ame[A [elem"ame[A in t#e callbac6 'unctionA t#ese arguments /ill dynamically bereplaced /it# t#e string value o' t#e dimensionA subsetA and element t#at t#e user selected.






f 398 25-09-20



O.>.$. Setting a Global Callbac# Function for All Title DimensionsTo capture c#ange events 'or all title dimension in a +ebs#eet or Cubevie/er ob!ectA use t#e TitleC#angeCallbac6 parameter

/it#out speci'ying a speci'ic title dimension. I' a title dimension or $U:"M cell location is not speci'ied in t#e UR8A t#en t#e

callbac6 'unction /ill capture c#ange events 'or all $U:"M cells in a +ebs#eet ob!ectA or all title dimensions in a Cubevie/er

ob!ect.

*ote, callbac6 'unction /it#out a target title dimension can be superseded by using a subse9uent TitleC#angeCallbac6

command t#at does speci'y a title dimension. (or e&ampleA TitleC#angeCallbac6]Dimension"ame or

TitleC#angeCallbac6]$#eet)Ro/)Column.

Use t#e 'ollo/ing UR8 'ormat to set a callbac6 'unction 'or all title dimensions;

&TitleChangeCallback=JSFunction(arg1,

$dimName$,

$subsetName$, $elemName$, arg2...)

/#ere;

,s(unction is t#e name o' your o/n Fava$cript 'unction t#at /ill #andle t#e callbac6 event.


I' you include [dim"ame[A [subset"ame[A [elem"ame[A in t#e callbac6 'unctionA t#ese arguments /ill dynamically bereplaced /it# t#e string value o' t#e dimensionA subsetA and element t#at t#e user selected.




dd code 'or your callbac6 'unction using t#e same 'unction signature t#at you provided in t#e UR8.

+arent topic, $etting %vent Callbac6 (unctions 'or Cubevie/er and +ebs#eet b!ects


f 398 25-09-20



O.?. Accessing te *avigation Tree (b)ectIn TM1H +ebA t#e navigation pane contains an organi7ed list o' TM1 applicationsA +ebs#eetsA cubesA and vie/s t#at are

available 'or a speci'ic user. You can incorporate t#is same navigation list into you o/n custom /eb page using t#e

"avigation Tree ob!ect.

You can access t#e "avigation Tree ob!ect in t/o di''erent modes;

3TM2 mode ) Displays t#e "avigation Tree ob!ect as seen in TM1 +eb. T#is is t#e de'ault mode. llo/s users to interact/it# t#e tree i' you provide your o/n callbac6 'unctions.

M2 mode ) Returns a data)only version o' t#e "avigation Tree ob!ectA in EM8 'ormatA so you can use t#e #ierarc#y anddata as needed.

(pening te *avigation Tree (b)ectT#e "avigation Tree ob!ect is accessed in t#e same /ay as Cubevie/er and +ebs#eet ob!ects t#roug# t#eTM1+ebMain.asp& #andler 'ile using t#e action=OpenObject parameter.

%sing te *avigation Tree (b)ect in 3TM2 Mode

+#en using t#e "avigation Tree ob!ect in *TM8 modeA you can control t#e display o' t#e toolbar and also provide youro/n callbac6 'unctions to allo/ users to interact /it# t#e TM1 ob!ects displayed in t#e tree.

%sing te *avigation Tree (b)ect in M2 ModeIn EM8 modeA t#e "avigation Tree ob!ect is sent bac6 as a UT()< encoded EM8 document. T#e returned EM8 documentcontains t#e #ierarc#y o' t#e pplication 'oldersA +ebs#eetsA cubesA and vie/s stored in t#e I:M Cognos TM1 server to/#ic# you are connected.



f 398 25-09-20



O.?.1. (pening te *avigation Tree (b)ectT#e "avigation Tree ob!ect is accessed in t#e same /ay as Cubevie/er and +ebs#eet ob!ects t#roug# t#e TM1+ebMain.asp&

#andler 'ile using t#e action=OpenObject parameter.

To open t#e "avigation Tree ob!ectA use t#e 'ollo/ing 'ormat;

action=OpenObject&type= NavigationTree

T#e "avigation Tree ob!ect opens in t#e de'ault *TM8 modeA but you can speci'y eit#er *TM8 or EM8 mode by using t#eContentType parameter.

&ContentType=mode

/#ere t#e value 'or mode can be eit#er html or xml.

(or e&ample;

To open t#e "avigation Tree ob!ect in *TM8 mode;

http://mywebserver/TM1Web/TM1WebMain.

aspx?action=OpenObject&type=NavigationTree&ContentType=html>

To open t#e "avigation Tree ob!ect in EM8 mode;

http://mywebserver/TM1Web/TM1WebMain.

aspx?action=OpenObject&type=NavigationTree&ContentType=xml>

'ter a user #as logged inA t#e "avigation Tree can also be accessed directly t#roug# t#e 'ollo/ing #andlers;

TM1+eb"avigationTree.asp& 'or *TM8 mode

TM1+eb"avigationTreeEml.asp& 'or EM8 mode

+arent topic, ccessing t#e "avigation Tree b!ect


f 398 25-09-20



O.?.$. %sing te *avigation Tree (b)ect in 3TM2 Mode+#en using t#e "avigation Tree ob!ect in *TM8 modeA you can control t#e display o' t#e toolbar and also provide your o/n

callbac6 'unctions to allo/ users to interact /it# t#e TM1H ob!ects displayed in t#e tree.

Displaing te *avigation Tree Toolbar+#en vie/ing t#e "avigation Tree ob!ect in *TM8 modeA you can display or #ide t#e ob!ects toolbar by setting t#eHideToolbar parameter in t#e base UR8 using t#e 'ollo/ing 'ormat;

Setting a Callbac# Function for te *avigation Tree (b)ect

I' you /ant in'ormation on individual ob!ect nodes to be e&posed /#en a user clic6s on t#emA you need to set a callbac6'unction 'or t#e "avigation Tree ob!ect. You can use t#e returned in'ormation t#at is sent to t#e callbac6 'unction toper'orm additional actions on t#e selected ob!ect. (or e&ampleA t#e returned EM8 Tree "ode ID could be used to opent#e ob!ect.



f 398 25-09-20



O.?.$.1. Displaing te *avigation Tree Toolbar+#en vie/ing t#e "avigation Tree ob!ect in *TM8 modeA you can display or #ide t#e ob!ects toolbar by setting t#e

HideToolbar parameter in t#e base UR8 using t#e 'ollo/ing 'ormat;

&HideToolbar=x

To #ide t#e TM1H titlebar;

&HideToolbar=yes

&HideToolbar=1

To display t#e titlebar;

&HideToolbar=no

&HideToolbar=0

+arent topic, Using t#e "avigation Tree b!ect in *TM8 Mode


f 398 25-09-20



O.?.$.$. Setting a Callbac# Function for te *avigation Tree (b)ectI' you /ant in'ormation on individual ob!ect nodes to be e&posed /#en a user clic6s on t#emA you need to set a callbac6

'unction 'or t#e "avigation Tree ob!ect. You can use t#e returned in'ormation t#at is sent to t#e callbac6 'unction to per'orm

additional actions on t#e selected ob!ect. (or e&ampleA t#e returned EM8 Tree "ode ID could be used to open t#e ob!ect.

You enable a callbac6 by adding t#e Callbac6 parameter to t#e base UR8 and t#en /riting code 'or a callbac6 'unction in your/eb page.

+rocedure

Use t#e 'ollo/ing 'ormat to add t#e Callback parameter and t#e name o' your callbac6 'unction to t#e base UR8;

&Callback=name_of_callback_function

(or e&ample;

&Callback= MyCallBackFunction

1.

+rite your callbac6 'unction in t#e /eb page to #andle t#e 'ollo/ing returned variables;

MyCallBackFunction(id ,

type, isPrivate,

name, description,

source)

T#e returned variables provide t#e 'ollo/ing in'ormation about t#e selected ob!ect node;

id ) uni9ue id o' t#e selected node

type ) ob!ect type o' t#e selected ob!ect ?+ebs#eet or Cubevie/er@

isrivate ) /#et#er t#e selected ob!ect is a private or public ob!ect

name ) name o' t#e selected ob!ect

description ) description o' t#e selected ob!ect

source ) source o' t#e selected ob!ectA i' any

(or e&ampleA t#e 'ollo/ing UR8 and Fava$cript 'unction s#o/ a sample o' #o/ to capture user interaction /it# t#e"avigation Tree ob!ect.

T#e 'ollo/ing UR8 opens t#e "avigation Tree ob!ect and sets t#e callbac6 parameter to a 'unction called

#andle"avTreepenb!ect;http://localhost/TM1Web/TM1WebMain.aspx?

action=OpenObject&AdminHost=&TM1Server=sdata&type=navigationtree&ContentType=

html&Callback=handleNavTreeOpenObject>

T#e 'ollo/ing Fava$cript 'unction /ould #andle t#e callbac6 event;

function handleNavTreeOpenObject(id, type, isPrivate,

name, description, source)

{

alert('id=' + id + ';type=' + type + ';isPrivate=' +

isPrivate + ';name=' + name + ';description=' + description + ';source='

+ source);

}

+#en t#e user clic6s on an ob!ect in t#e "avigation TreeA t#e callbac6 'unction displays a message bo& s#o/ing t#ereturned in'ormation about t#e selected ob!ect.

2.

+arent topic, Using t#e "avigation Tree b!ect in *TM8 Mode


f 398 25-09-20



O.?.-. %sing te *avigation Tree (b)ect in M2 ModeIn EM8 modeA t#e "avigation Tree ob!ect is sent bac6 as a UT()< encoded EM8 document. T#e returned EM8 document

contains t#e #ierarc#y o' t#e pplication 'oldersA +ebs#eetsA cubesA and vie/s stored in t#e I:MH CognosH TM1H server to

/#ic# you are connected.

Use t#e 'ollo/ing UR8 'ormat to retrieve t#e "avigation Tree ob!ect as EM8;

http://<HostName>/TM1Web/TM1WebMain.

aspx?action=OpenObject&type=NavigationTree&ContentType=xml

T#e returned EM8 data is structured in t#e 'ollo/ing overall 'ormat;

T#e <NavigationTree> node is t#e top)level node returned.

T#e <Application> node contains application 'olders and re'erences t#at can display in TM1 +eb.

T#e <Server> node contains cubes and vie/s t#at can display in TM1 +eb.

*ote, T#e <Administration>node is not used /it# t#e UR8 I.

M2 Application *ode(or e&ampleA an e&panded <Application> node loo6s li6e t#is;

M2 Server *oden e&ample o' an e&panded <Server> node loo6s li6e t#is;

%sing M2 Tree *ode IDs to (pen 7ebseet and Cubevie!er (b)ectsYou can use an ob!ects Tree "ode ID 'rom t#e EM8 data to open a +ebs#eet or Cubevie/er ob!ect.



f 398 25-09-20



O.?.-.1. M2 Application *ode(or e&ampleA an e&panded <Application> node loo6s li6e t#is;

+arent topic, Using t#e "avigation Tree b!ect in EM8 Mode


f 398 25-09-20



O.?.-.$. M2 Server *oden e&ample o' an e&panded <Server> node loo6s li6e t#is;



f 398 25-09-20



O.?.-.-. %sing M2 Tree *ode IDs to (pen 7ebseet and Cubevie!er (b)ectsYou can use an ob!ects Tree "ode ID 'rom t#e EM8 data to open a +ebs#eet or Cubevie/er ob!ect.

+rocedure

btain t#e Tree "ode ID 'rom t#e returned EM8 data 'or t#e ob!ect you /ant to open.

(or e&ampleA tn]< is t#e Tree "ode ID 'or t#e rice vie/ in t#e 'ollo/ing EM8 sample.

1.

Use t#e Tree "ode ID string value /it# t#e penb!ect command in your UR8 as 'ollo/s;

action=OpenObject&type=Cubeviewer&value=

TreeNodeID

(or e&ampleA set valuetn]< to display t#e rice vie/ in a Cubevie/er ob!ect as 'ollo/s;

action=OpenObject&type=Cubeviewer&value=tn_8

2.



f 398 25-09-20



10. %sing Data 'eservationsT#is section describes all o' t#e administratorA modelerA developer and programmer tas6s related to enabling and

implementing t#e Data Reservation 'eature available in I:MH CognosH TM1H .

*ote, :y de'aultA Data Reservation is not enabled. n administrator must enable and con'igure t#e 'eature be'ore you can

use t#e related TurboIntegrator ?TI@ and I 'unctions to manage Data Reservations.

Data 'eservation (vervie!

Data Reservation ?DR@ is a server)related 'eature in TM1 t#at allo/s you to con'igure e&clusive /rite)access to regions o'

a cube 'or individual users. nce reservedA t#e data in t#at region can only be modi'ied by t#at speci'ic user until t#ereservation is released.

%nderstanding Data 'eservation beavior !it oter TM1 features

T#is section describes #o/ Data Reservations ?DR@ interact /it# ot#er TM1 'eatures suc# as securityA data spreadingATurboIntegrator ?TI@ processes and sandbo&es.

/nabling Data 'eservation:y de'aultA Data Reservation is not enabled. n administrator must enable and con'igure t#e 'eature be'ore you can uset#e related TurboIntegrator ?TI@ and I 'unctions to manage Data Reservations.

Monitoring Data 'eservations

You can use t#e 'ollo/ing tools to monitor Data Reservation activity and status.

Managing Data 'eservations !it TurboIntegrator functions

You can use t#e 'ollo/ing TurboIntegrator ?TI@ 'unctions to programmatically obtainA release and manage Data

Reservations.

Managing Data 'eservations !it TM1 A+I functions

You can use t#e 'ollo/ing TM1 C I 'unctions to programmatically obtainA release and manage Data Reservations.


f 398 25-09-20



10.1. Data 'eservation (vervie!Data Reservation ?DR@ is a server)related 'eature in TM1 t#at allo/s you to con'igure e&clusive /rite)access to regions o' a

cube 'or individual users. nce reservedA t#e data in t#at region can only be modi'ied by t#at speci'ic user until t#e

reservation is released.

You can use DR to support your speci'ic business processes or to control data entry by ac9uiring and releasing DataReservations on an as)needed or dynamic basis. (or e&ampleA DR provides an alternative /ay to dynamically control /rite)access to cube data instead o' trying to dynamically ad!ust TM1 security to ac#ieve similar /rite)access restrictions.

*ote, ll DRs must be managed via custom applications t#at you develop using t#e provided TurboIntegrator ?TI@ and I'unctions. You design t#e application to obtainA release and manage DRs based on t#e re9uired business process.

7en to use Data 'eservations

You /ould use Data Reservations i' you /ant to manually or dynamically manage user /rite)access to TM1 data in a /ay t#atrelates to your business process. Depending on your e&act needsA you can apply t#e 'eature eit#er as)needed or dynamicallyusing TurboIntegrator and I 'unctions.

(or e&ampleA you mig#t use DR to do t#e 'ollo/ing;

Manually run a one)time TurboIntegrator process t#at uses Data Reservations to loc6 out all users 'rom ma6ing 'urt#eredits to certain data a'ter completing a speci'ic pro!ect or closing a recent budget.

pply Data Reservations using TM1 ction buttons and TurboIntegrator processes in a Microso't %&cel spreads#eet orTM1 +ebs#eet to dynamically control /rite)access to data as users interact /it# t#e data based on t#eir roles and your

companys business process.

Use TM1 I 'unctions /it#in a custom e&ternal application to dynamically ac9uire and release Data Reservations.

3o! to use Data 'eservations

To use Data ReservationA you must 'irst enable and con'igure t#e 'eature 'or individual cubes and user groups and t#en useTurboIntegrator or I 'unctions to programmatically apply and manage DRs.

To enable DRA use t#e 'ollo/ing TM1 tools;

BCube+roperties control cube ) %nables and con'igures Data Reservation 'or individual cubes. (or detailsA see%nabling Data Reservation 'or cubes.

Capabilities Assignments ) Determines i' t#e members o' a user group can manage ?ac9uire and release@ DataReservations 'or t#emselves and ot#er users. (or detailsA see %nabling user groups to manage Data Reservations.

To apply and manage Data ReservationsA you must use TurboIntegrator and TM1 I 'unctions t#at allo/ you toprogrammatically obtainA release and manage reservations. (or detailsA see t#e 'ollo/ing topics;

Managing Data Reservations /it# TurboIntegrator 'unctions

Managing Data Reservations /it# TM1 I 'unctions

3o! do Data 'eservations interact !it oter TM1 featuresW

(or details on #o/ Data Reservations interact /it# ot#er TM1 'eatures suc# as data spreadingA TurboIntegrator processes andsecurityA see Understanding Data Reservation be#avior /it# ot#er TM1 'eatures.

Data 'eservation monitoring tools

You can use $erver %&plorerA t#e TM1 Top utilityA t#e TM1 udit logA and certain TurboIntegrator and I 'unctions to monitor

Data Reservation activity andor assignments. (or detailsA see Monitoring Data Reservations.

+arent topic, Using Data Reservations


f 398 25-09-20



10.$. %nderstanding Data 'eservation beavior !it oter TM1 featuresT#is section describes #o/ Data Reservations ?DR@ interact /it# ot#er TM1 'eatures suc# as securityA data spreadingA

TurboIntegrator ?TI@ processes and sandbo&es.

Data 'eservations and SecuritData Reservation is di''erent 'rom TM1 $ecurity in t#e 'ollo/ing /ays

Data 'eservations and te TM1 user interface

Data Reservation a''ects t#e appearance o' cells in a cube vie/ in all o' t#e di''erent TM1 user inter'acesA suc# as $erver

%&plorerA TM1 erspectives and TM1 +eb.Data 'eservations and Data spreading

Data spreading be#aves t#e same as be'ore ) cells t#at are not /ritableA suc# as calculated cells or cells /it# a #oldA ares6ipped during a spread process. +#en a user #as a Data Reservation and per'orms a data spreading operationA only t#ecells in t#at users DR region /ill be considered /ritable and all ot#er cells /ill be s6ipped.

Data 'eservations and TurboIntegrator processes and coresYou s#ould understand t#e 'ollo/ing considerations /#en using Data Reservation and also running interactive?non)sc#eduled@ and sc#eduled TurboIntegrator ?TI@ c#oresprocesses;

Data 'eservations and SandboesYou s#ould understand t#e 'ollo/ing considerations about obtaining and releasing Data Reservations on a speci'ic cube/#ile also entering data into sandbo&es o' t#at same cube.

Data 'eservations6 Sandboes6 and Rob ueue

I' you are using Data Reservations /it# sandbo&es and t#e Fob =ueue 'eatureA t#e 'ollo/ing be#avior applies /#encommitting sandbo& data to base dataA depending on /#ic# Data Reservation mode is being used by t#e cube.



f 398 25-09-20



10.$.1. Data 'eservations and SecuritData Reservation is di''erent 'rom TM1 $ecurity in t#e 'ollo/ing /ays

DR does not over)ride TM1 security assignmentsA but only adds anot#er layer o' /rite restriction on top o' standardsecurity 'or cube ob!ects.

DR applies to individual users /#ile TM1 security applies to groups o' users.

DR applies restrictions only to cube data and individual users. It does not control any ot#er TM1 ob!ects.

T#is be#avior is t#e same 'or bot# t#e R%=UIR%D and 88+%D Data Reservation modes.

+arent topic, Understanding Data Reservation be#avior /it# ot#er TM1 'eatures


f 398 25-09-20



10.$.$. Data 'eservations and te TM1 user interfaceData Reservation a''ects t#e appearance o' cells in a cube vie/ in all o' t#e di''erent TM1 user inter'acesA suc# as $erver

%&plorerA TM1 erspectives and TM1 +eb.

T#is be#avior is di''erent depending on t#e Data Reservation mode.

'/%I'/D mode

+#en a cube is con'igured to use Data Reservation in R%=UIR%D modeA all o' t#e cells appear /it# a gray bac6ground and

are not /ritable e&cept 'or t#e cells contained in your DR region. nly t#e cells in t#e DR 'or t#e current user /ill be /ritableand appear /it# a /#ite bac6ground.

A22(7/D mode

+#en a cube is con'igured to use Data Reservation in 88+%D modeA all o' t#e cells are /ritableA depending on securityAand appear /it# a /#ite bac6ground e&cept 'or t#e cells contained in t#e Data Reservations o' ot#er users. Cells reserved byot#er users appear /it# a gray bac6ground and are not /ritable.

(or details on c#ec6ing /#et#er a cell is part o' a DRA see Displaying Data Reservation cell status in $erver %&plorer.



f 398 25-09-20



10.$.-. Data 'eservations and Data spreadingData spreading be#aves t#e same as be'ore ) cells t#at are not /ritableA suc# as calculated cells or cells /it# a #oldA are

s6ipped during a spread process. +#en a user #as a Data Reservation and per'orms a data spreading operationA only t#e

cells in t#at users DR region /ill be considered /ritable and all ot#er cells /ill be s6ipped.

T#is be#avior is t#e same 'or bot# t#e R%=UIR%D and 88+%D Data Reservation modes.



f 398 25-09-20



10.$.8. Data 'eservations and TurboIntegrator processes and coresYou s#ould understand t#e 'ollo/ing considerations /#en using Data Reservation and also running interactive

?non)sc#eduled@ and sc#eduled TurboIntegrator ?TI@ c#oresprocesses;

$ome o' t#is be#avior is di''erent depending on /#ic# Data Reservation mode is being used and /#et#er t#e c#ore is runinteractively or sc#eduled.

Interactive +rocesses and Cores

+#en a user interactively runs a process or a c#oreA 'or e&ample 'rom t#e TM1 user inter'aceA t#en t#at processc#ore runsas t#at user.

(or R%=UIR%D modeA t#is means t#at t#e processc#ore can /rite only to data de'ined in t#e DRs #eld by t#at user.

(or 88+%D modeA t#e processc#ore can /rite to any cell t#at is eit#er contained in a DR 'or t#at user or #as t#eappropriate security rig#ts 'or t#at userA but t#e processc#ore cannot /rite to cells contained in anot#er users DR.

T#e 'ollo/ing be#avior is t#e same 'or bot# t#e R%=UIR%D and 88+%D Data Reservation modes.

I' a /rite operation in t#e Interactive processc#ore con'licts /it# t#e Data Reservation o' anot#er userA t#en t#eprocessc#ore 'ails and an error message is displayed to t#e user.

To run a process t#at ac9uires and releases DRsA t#e user running t#e process must belong to a user group t#at #as t#eManageDataReservation capability set to GRANT.

Sceduled Cores+#en a sc#eduled c#ore automatically runsA it runs as t#e dmin user. :ecause o' t#isA t#e c#ore may not be able to /rite tosome cells i' t#ose cells are in t#e Data Reservation o' anot#er user.

+#en a sc#eduled c#ore encounters a Data Reservation con'lictA t#e be#avior is di''erent depending on /#ic# DataReservation mode is being used by t#e cube.

In R%=UIR%D modeA i' a /rite operation in a sc#eduled c#ore con'licts /it# a Data ReservationA t#e c#ore 'ails.

To allo/ a sc#eduled c#ore to /rite to reserved cells /#en using DR in R%=UIR%D modeA you must #andle t#isprogrammatically in your TurboIntegrator process by allo/ing t#e dmin user to /rite to t#e reserved cells. You canmodi'y t#e TurboIntegrator process to ac9uire and release t#e necessary DRs 'or t#e dmin or possibly #ave t#e processtemporarily turn o''on t#e DR 'eature 'or t#e applicable cubes.

In 88+%D modeA i' a /rite operation in a sc#eduled c#ore con'licts /it# a Data ReservationA t#e c#ore /ill per'orm a

data rollbac6 and /ait 'or t#e reservation to be released. +#en t#e reservation is releasedA t#e c#ore /ill retry t#eoperation.

You cannot cancel a /aiting c#ore by c#anging t#e Data Reservation mode to R%=UIR%D or ((. T#e c#ore /ill continueto /ait until one o' t#e 'ollo/ing events occurs.

Release t#e Data Reservation t#at is bloc6ing t#e c#ore so t#e c#ore can continue.

Use t#e TM1 Top utility to cancel t#e c#ore.

$#ut do/n t#e server to cancel t#e c#ore.

Deactivate t#e sc#eduled c#ore.



f 398 25-09-20



10.$.=. Data 'eservations and SandboesYou s#ould understand t#e 'ollo/ing considerations about obtaining and releasing Data Reservations on a speci'ic cube /#ile

also entering data into sandbo&es o' t#at same cube.

DRs apply to t#e base version o' a cube and any sandbo& created 'rom t#at cube.

T#e 'ollo/ing sandbo& be#avior applies only to t#e R%=UIR%D Data Reservation mode.

I' t#e DR 'eature is enabled 'or a cubeA t#en you must #ave a DR on t#at cube to /rite to t#e base data or any sandbo&o' t#at cube.

(or e&ampleA i' a user #as a DR to t#e $ales cubeA t#en t#at user can only /rite to t#at same set o' cells in any sandbo&created 'rom t#e $ales cube.

I' your DR 'or a cube #as been releasedA t#en you can no longer /rite to any sandbo& o' t#at cube.

You can commit a sandbo& to base data a'ter a DR is releasedA #o/everA t#e edited values 'or any cells t#at are no longerreserved 'or you /ill be dropped /it# errors and your c#anges /ill be lost. To success'ully commit t#e edited values tobase dataA you must 'irst re)ac9uire t#e necessary DRs on t#at cube be'ore attempting to commit t#e sandbo&.



f 398 25-09-20



10.$.>. Data 'eservations6 Sandboes6 and Rob ueueI' you are using Data Reservations /it# sandbo&es and t#e Fob =ueue 'eatureA t#e 'ollo/ing be#avior applies /#en

committing sandbo& data to base dataA depending on /#ic# Data Reservation mode is being used by t#e cube.

In R%=UIR%D modeA all necessary Data Reservations must be #eld until t#e 9ueued operation is complete 'or t#esandbo& data to be success'ully saved to base data. I' t#e necessary Data Reservations are released be'ore t#e Fob=ueue saves t#e data or i' a Data Reservation con'lict is encounteredA t#e values in t#e con'licting cells /ill not be saved.

In 88+%D modeA i' a sandbo& commit in t#e Fob =ueue con'licts /it# a Data ReservationA t#e Fob =ueue /ill per'orma data rollbac6 'or t#at operation and /ait 'or t#e con'licting reservation to be released. ll !obs in t#e Fob =ueue /ill be

bloc6ed until t#e /aiting !ob is allo/ed to continue. T#e only /ay to unbloc6 t#e Fob =ueue is to release t#e con'lictingData Reservations.



f 398 25-09-20



10.-. /nabling Data 'eservation:y de'aultA Data Reservation is not enabled. n administrator must enable and con'igure t#e 'eature be'ore you can use t#e

related TurboIntegrator ?TI@ and I 'unctions to manage Data Reservations.

:e'ore using Data ReservationsA you must;

%nable t#e 'eature 'or individual cubes ?con'igured in t#e Cuberoperties control cube@.

(or detailsA see%nabling Data Reservation 'or cubes

llo/ user groups t#e ability to manageA ac9uire and release DRs 'or t#emselves and ot#er users ?con'igured in t#eCapability ssignments /indo/@.

(or detailsA see %nabling user groups to manage Data Reservations@.

'ter DR #as been enabled 'or a cubeA t#e 'eature applies to all users o' t#at cubeA but can only be managed by members o' t#e user groups granted permission in t#e Capability ssignments /indo/.

/nabling Data 'eservation for cubes

Use t#e DataReservationMode property in t#e Cuberoperties control cube to enable or disable Data Reservation 'or aspeci'ic cube.

/nabling user groups to manage Data 'eservations

Use t#e 'ollo/ing capabilities in t#e TM1 Capability ssignments /indo/ to allo/ members o' a user group to manage?ac9uire and release@ Data Reservations 'or t#emselves and ot#er users.



f 398 25-09-20



10.-.1. /nabling Data 'eservation for cubesUse t#e DataReservationMode property in t#e Cuberoperties control cube to enable or disable Data Reservation 'or a

speci'ic cube.

(or more details about t#e Cuberoperties control cubeA see t#e Control Cubes section in t#e I:M Cognos TM1 Operation

Guide.

+rocedure

In $erver %&plorerA clic6 t#e 9ie! menu and t#en clic6 to select Displa Control (b)ects.

ll o' t#e TM1 Control cubes appear in $erver %&plorer /it# a pre'i& o' a rig#t curly brace . (or e&ampleACuberoperties.

1.

In t#e Tree pane o' $erver %&plorerA clic6 to e&pand t#e Cubes node and t#en double)clic6 t#e BCube+roperties controlcube.

2.

%nter a value 'or one o' t#e available Data Reservation modes at t#e intersection o' t#e DataReservationMode element?property@ and t#e cube name to enable t#e Data Reservation 'eature 'or t#at cube.

3.

Data'eservationMode propertT#e DataReservationMode property uses t#e 'ollo/ing values.

+arent topic, %nabling Data Reservation


f 398 25-09-20



10.-.1.1. Data'eservationMode propertT#e DataReservationMode property uses t#e 'ollo/ing values.

9alue Description

(FF Turns o'' t#e Data Reservation 'eature 'or t#e speci'ic cube.

T#e de'ault value is ((.

'/%I'/D $ets t#e Data Reservation 'eature to R%=UIR%D mode 'or a speci'ic cube.

T#is mode disables /rite access 'or all users 'or t#e entire cube and re9uires you to e&plicitly assign DataReservations 'or any user t#at needs to /rite to t#is cube.

(or e&ampleA a user must #ave a Data Reservation on a cell i' t#ey /ant to /rite to t#at cell.

(or more details about t#e di''erences bet/een t#e di''erent Data Reservation modesA see Understanding DataReservation be#avior /it# ot#er TM1 'eatures.

A22(7/D $ets t#e Data Reservation 'eature to 88+%D mode 'or a speci'ic cube.

T#is mode maintains /rite accessA based on securityA 'or all users across t#e entire cubeA but allo/s you toselectively restrict /rite access to an area o' t#e cube by assigning Data Reservations to individual users asneeded.

(or e&ampleA 88+%D mode lets you use Data Reservation to set aside a section o' a cube 'or a speci'ic user/#ile 6eeping /rite access available 'or all ot#er users to t#e rest o' t#e cube.

+arent topic, %nabling Data Reservation 'or cubes


f 398 25-09-20



10.-.$. /nabling user groups to manage Data 'eservationsUse t#e 'ollo/ing capabilities in t#e TM1 Capability ssignments /indo/ to allo/ members o' a user group to manage

?ac9uire and release@ Data Reservations 'or t#emselves and ot#er users.

T#ese capabilities are con'igured 'or an entire user group and not 'or individual users. user must be a member o' t#egroup 'or t#e capability to apply.

*ote, nly TM1 administrators #ave access to t#e Capability ssignments /indo/.

(or more details about Capability ssignmentsA see t#e I:M Cognos TM1 Operation Guide.

Capabilit Description

ManageData'eservation llo/s t#e members o' t#e group to ac9uire and release Data Reservations.

T#is capability is server)/ide. Capabilities can not be applied to speci'ic cubes orusers.

T#is capability is al/ays set to GRANT 'or t#e standard DMI"A DatadminA and

$ecuritydmin groups and cannot be modi'ied.

5alues 'or non)administrator groups;

DENY ) De'ault value 'or all non)administrator groups.

GRANT) %nables t#is capability 'or a user group.

Data'eservation(verride llo/s t#e members o' t#e group to release reservations #eld by ot#er users.

T#is capability is al/ays set to GRANT 'or t#e standard DMI"A DatadminA and

$ecuritydmin groups and cannot be modi'ied.

5alues 'or non)administrator groups;

DENY ) De'ault value 'or all non)administrator groups.

GRANT ) %nables t#is capability 'or a user group.

+rocedure

In $erver %&plorerA rig#t)clic6 on a server and select Capabilit Assignments.1.

In t#e Capability ssignments /indo/A enter values 'or t#e ManageData'eservation and Data'eservation(verride

capabilities at t#e intersection /it# t#e user group you /ant to con'igure.2.

+arent topic, %nabling Data Reservation


f 398 25-09-20



10.8. Monitoring Data 'eservationsYou can use t#e 'ollo/ing tools to monitor Data Reservation activity and status.

$erver %&plorer

TM1 Top utility

TM1 udit 8og

TurboIntegrator and I 'unctions

Displaing Data 'eservation cell status in Server /plorerYou c#ec6 t#e status o' any cell in a cube vie/ in $erver %&plorer as 'ollo/s;

%sing TM1 Top to monitor treads !aiting for Data 'eservationsYou can use t#e TM1 Top utility to monitor t#reads t#at are /aiting 'or a data reservation to be released. ny t#read int#is state is s#o/n in TM1 Top /it# a Data Reservation Release ?DDR@ value in t#e $tate 'ield;

%sing te Audit 2og to monitor Data 'eservation eventsI' audit logging is enabled 'or t#e TM1 serverA TM1 /ill record Data Reservation events. You can t#en use t#e TM1 uditlog to 9uery and vie/ t#e #istory o' Data Reservation assignments.

%sing TurboIntegrator and A+I functions to monitor Data 'eservationss a custom solutionA you could use t#e 'ollo/ing TM1 TurboIntegrator and I 'unctions to programmatically iteratecube ob!ects and retrieve in'ormation about t#e related Data Reservations 'or eac# cube.



f 398 25-09-20



10.8.1. Displaing Data 'eservation cell status in Server /plorerYou c#ec6 t#e status o' any cell in a cube vie/ in $erver %&plorer as 'ollo/s;

+rocedure

In $erver %&plorerA open a cube vie/A rig#t)clic6 a cell and t#en clic6 /dit Status.

message bo& appears indicating /#et#er t#e cells value can be edited or t#at t#e cell is not editable because o' a DataReservation or ot#er data access restriction.

+arent topic, Monitoring Data Reservations


f 398 25-09-20



10.8.$. %sing TM1 Top to monitor treads !aiting for Data 'eservationsYou can use t#e TM1 Top utility to monitor t#reads t#at are /aiting 'or a data reservation to be released. ny t#read in t#is

state is s#o/n in TM1 Top /it# a Data Reservation Release ?DDR@ value in t#e $tate 'ield;

Wait:DRR

(or more details about TM1 Top /ait statesA see t#e section Understanding T#read rocessing $tates in t#e $ystem ander'ormance Monitoring c#apter in t#e I:M Cognos TM1 Operation Guide.



f 398 25-09-20



10.8.-. %sing te Audit 2og to monitor Data 'eservation eventsI' audit logging is enabled 'or t#e TM1 serverA TM1 /ill record Data Reservation events. You can t#en use t#e TM1 udit log

to 9uery and vie/ t#e #istory o' Data Reservation assignments.

(or more details about using t#e TM1 udit 8ogA see t#e $ystem and er'ormance Monitoring c#apter in t#e I:M CognosTM1 Operation Guide.

T#e 'ollo/ing table lists t#e 'ive udit log events t#at are speci'ic to Data Reservations.

Audit 2og /vent /vent Description

+ropert Set,CubeData'eservation/nable

Recorded /#en t#e value o' t#e CubeDataReservation%nable property 'or acube #as c#anged.

Data 'eservation, Acuired Recorded /#en ac9uiring a Data Reservation.

Data 'eservation, 'eleased Recorded /#en releasing a Data Reservation.

Data 'eservation, 'ollbac# Acuire Recorded /#en rollbac6 o' a reservation ac9uire occurs.

Data 'eservation, 'ollbac# 'elease Recorded /#en rollbac6 o' a reservation release occurs.

*otes about 'ollbac# /vents

T#e rollbac6 o' a Data Reservation ac9uire operation is to release t#e reservation.

T#e rollbac6 o' a Data Reservation release operation is to re)ac9uire t#e reservation.

uering for Data 'eservation events

ll Data Reservation events are associated /it# t#e TM1 cube ob!ect and are t#ere'ore grouped as cube events in t#eudit log. You can 9uery 'or t#ese events in t#e udit 8og /indo/ as 'ollo/s.



f 398 25-09-20



10.8.-.1. uering for Data 'eservation eventsll Data Reservation events are associated /it# t#e TM1 cube ob!ect and are t#ere'ore grouped as cube events in t#e udit

log. You can 9uery 'or t#ese events in t#e udit 8og /indo/ as 'ollo/s.

+rocedure

In $erver %&plorerA open t#e udit 8og /indo/.1.

In t#e /vent Tpe sectionA select t#e (b)ect option.2.

$et t#e (b)ect Tpe 'ield to Cube.3.

$et t#e /vent drop)do/n list to one o' t#e Data Reservation event types.-.

Run t#e 9uery.0.

+arent topic, Using t#e udit 8og to monitor Data Reservation events


f 398 25-09-20



10.8.8. %sing TurboIntegrator and A+I functions to monitor Data 'eservationss a custom solutionA you could use t#e 'ollo/ing TM1 TurboIntegrator and I 'unctions to programmatically iterate cube

ob!ects and retrieve in'ormation about t#e related Data Reservations 'or eac# cube.

TurboIntegrator ) CubeDataReservation,et .

TM1 I ) TM1DataReservation,etll .



f 398 25-09-20



10.=. Managing Data 'eservations !it TurboIntegrator functionsYou can use t#e 'ollo/ing TurboIntegrator ?TI@ 'unctions to programmatically obtainA release and manage Data Reservations.

CubeDataReservationc9uire

CubeDataReservationRelease

CubeDataReservationReleasell

CubeDataReservation,et

CubeDataReservation,etCon'licts

Data Reservations are de'ined by a speci'ic cubeA userA and tuple ?an ordered list o' elements@.

CubeData'eservationAcuire

T#is is a TM1 TurboIntegrator 'unctionA valid only in TurboIntegrator processes.

CubeData'eservation'eleaseT#is is a TM1 TurboIntegrator 'unctionA valid only in TurboIntegrator processes.

CubeData'eservation'eleaseAll

T#is is a TM1 TurboIntegrator 'unctionA valid only in TurboIntegrator processes.

CubeData'eservationGetT#is is a TM1 TurboIntegrator 'unctionA valid only in TurboIntegrator processes.

CubeData'eservationGetConflictsT#is is a TM1 TurboIntegrator 'unctionA valid only in TurboIntegrator processes.



f 398 25-09-20



10.=.1. CubeData'eservationAcuireT#is is a TM1H TurboIntegrator 'unctionA valid only in TurboIntegrator processes.

c9uires a Data Reservation 'or t#e speci'ied cubeA user and tuple.

Snta

CubeDataReservationAcquire(Cube, User , bForce, Address, [AddressDelimiter ])


Cube "ame o' t#e cube.

User "ame o' t#e o/ner 'or t#e ne/ reservation.

T#e user name supplied /ill be validated to ma6e sure it is an e&isting user.

b(orce :oolean value t#at determines t#e be#avior i' t#e re9uested reservation con'licts /it# ane&isting reservation.

I' set to ?'alse@A t#en t#e re9uest is re!ected i' it con'licts /it# an e&isting reservation.

I' set to 1 ?true@ and t#e user running t#e TurboIntegrator process #as t#eDataReservationverride capabilityA t#en t#e con'licting reservations are releasedA and t#ere9uested one is granted.

ddress To6eni7ed string se9uence o' element names t#at de'ine t#e tuple. T#e order must matc# t#eoriginal dimension order o' t#e cube.

ll t#e cells in t#e cube contained by t#e tuple ma6e up t#e region being reserved. You canc#oose one element 'rom eac# dimension or use an empty string bet/een t#e delimiters toselect an entire dimension. Depending on /#ere t#e element is located in t#e #ierarc#yA t#ere9uest reserves a single cellA a sliceA or t#e entire cube.

ddressDelimiter ptional c#aracter string t#at is used to separate element names in t#e ddress parameter.

De'ault value is P.

'eturn 9alue

:oolean ) returns true i' t#e ac9uisition succeeded.

/ample

CubeDataReservationAcquire('DRTestCube','User1',0,'ElemX|ElemY|ElemZ');

T#e 'ollo/ing e&ample sets t#e b(orce parameter to 1 to 'orce t#e DR re9uest i' a con'lict e&ists and uses a di''erentdelimiter c#aracter 'or t#e ddressDelimiter parameter.

CubeDataReservationAcquire('DRTestCube','User2',1,'ElemX*ElemY*ElemZ','*');

+arent topic, Managing Data Reservations /it# TurboIntegrator 'unctions


f 398 25-09-20



10.=.$. CubeData'eservation'eleaseT#is is a TM1H TurboIntegrator 'unctionA valid only in TurboIntegrator processes.

Releases t#e speci'ied Data Reservation.

I' t#e user speci'ied is not t#e same as t#e o/ner o' t#e reservationA t#en t#e release /ill only succeed i' t#e user speci'ied#as t#e DataReservationverride capability enabled.

Snta

CubeDataReservationRelease(Cube, User , Address,[AddressDelimiter ])



User "ame o' t#e o/ner o' t#e reservation.

T#e user name supplied /ill be validated to ma6e sure it is an e&isting user.

ddress To6eni7ed string se9uence o' element names t#at de'ine t#e tuple. T#e order must matc#

t#e original dimension order o' t#e cube.

ddressDelimiter ptional c#aracter string t#at is used to separate element names in t#e ddressparameter.

De'ault value is P.

'eturn 9alue

:oolean ) returns true i' t#e release succeeded.

/ample

CubeDataReservationRelease('DRTestCube','User1','ElemX|ElemY|ElemZ');

T#e 'ollo/ing e&ample uses a di''erent c#aracter 'or t#e ddressDelimiter parameter.

CubeDataReservationRelease('DRTestCube','User2','ElemX*ElemY*ElemZ','*');



f 398 25-09-20



10.=.-. CubeData'eservation'eleaseAllT#is is a TM1H TurboIntegrator 'unctionA valid only in TurboIntegrator processes.

Releases multiple e&isting Data Reservations.

ll reservations 'ully contained by t#e speci'ied address t#at matc# t#e user 'ilter /ill be released. blan6 user 'ilter meansall users.

I' t#e user 'ilter speci'ied is not t#e same as t#e user running t#e TurboIntegrator procesA t#en t#e DataReservationverridecapability must be enabled.

Using a blan6 user 'ilter and all /ildcards in t#e address 'ield releases all reservations.

Snta

CubeDataReservationReleaseAll(Cube, UserFilter , Address, [AddressDelimiter ])



User(ilter User name 'ilter to matc# against e&isting reservations.

ddress To6eni7ed string se9uence o' element names t#at de'ine t#e tuple. T#e order must matc#t#e original dimension order o' t#e cube.

ddressDelimiter ptional c#aracter string t#at is used to separate element names in t#e ddress parameter.

De'ault value is P.

'eturn 9alue

:oolean ) returns true i' no errors.

/ampleCubeDataReservationReleaseAll('DRTestCube','User1','ElemX|ElemY|ElemZ');

T#e 'ollo/ing e&ample releases all reservations in t#e speci'ied cube 'or all users.

CubeDataReservationReleaseAll('DRTestCube','','||');



f 398 25-09-20



10.=.8. CubeData'eservationGetT#is is a TM1H TurboIntegrator 'unctionA valid only in TurboIntegrator processes.

(inds e&isting reservations on a speci'ic cube 'or all or one user.

Snta

CubeDataReservationGet(Index , Cube, User , [AddressDelimiter ]) returns Address;


Inde& one)based loop inde& to use 'or iterating t#roug# reservations on t#e speci'ied cube.

Cube "ame o' t#e cube to searc#.

User Reservation o/ner name to use as a 'ilter.

I' le't blan6A t#e 'unction returns reservations 'or any o/ner.

I' a name is providedA t#e 'unction 'ilters t#e results 'or !ust t#e speci'ied o/ner.

ddressDelimiter ptional c#aracter string t#at is used to separate element names in t#e returned ddressparameter.

De'ault value is P.

'eturn 9alue

ddress ) Reservation creation timeA name o' t#e reservation o/ner and %lement address o' t#e reservation. Creation timecomes 'irstA 'ollo/ed by delimiterA 'ollo/ed by UserIDA 'ollo/ed by delimiterA 'ollo/ed by %lements IDs separated by t#edelimiter in order o' dimensions in t#e cube ?original order@.

n empty string is returned i' t#ere is no entry 'or t#e speci'ied inde&.

T#e 'ormat o' t#e return value is;

[creation time][delimiter][owner name][delimiter][element1][delimiter][element2][delimiter]…[elementN]

(or e&ample;

21222111P(red :loggsP%lement1P%lement2P%lement3

*ote, T#e reservations can c#ange /#ile iterating t#e list o' reservations so t#e use o' inde& is not guaranteed to give a

complete list o' reservations. Reservations can be added or removed at any position in t#e listA so reservations can be

s6ipped or repeated /#en looping t#roug# inde& values.

I' t#e o/ner 'ilter is speci'iedA t#en t#e inde& applies only to t#e members o' t#e 'iltered list. I' t#e list o' reservations #aso/ners as 'ollo/s; User1A User1A User2 and t#e re9uest speci'ies an o/ner o' User2 t#en an inde& o' 1 /ill retrieve t#e t#irdmember o' t#e list.

/ample

CubeDataReservationGet(1,'DRTestCube','User1','*');

CubeDataReservationGet(1,'DRTestCube','');

T#e 'ollo/ing sample /ould 'ind all t#e reservations o/ned by user (red :loggs in t#e %&pense Input cube and dosomet#ing use'ul /it# t#em;

vIndex = 1;

vCube = 'Expense Input';

vUserFilter = 'Fred Bloggs';

vDelim = '|';

vAddress = CubeDataReservationGet( vIndex, vCube, vUserFilter,vDelim);

WHILE (vAddress @<> '');


f 398 25-09-20



vSep1 = SCAN( vDelim, vAddress);

vDRUser = SUBST( vAddress, 1, vSep1 - 1);

vDRAddress = SUBST( vAddress, vSep1 + 1, LONG(vDRAddress) - vSep1);

# do something meaningful with the

user and reservation address here

vIndex = vIndex + 1;

vAddress = CubeDataReservationGet( vIndex, vCube, vUserFilter,vDelim);

END;



f 398 25-09-20



10.=.=. CubeData'eservationGetConflictsT#is is a TM1H TurboIntegrator 'unctionA valid only in TurboIntegrator processes.

(inds e&isting reservations on a speci'ic cube t#at /ould con'lict /it# t#e speci'ied userA address and tuple.

Snta

CubeDataReservationGetConflicts(Index , Cube, User ,

Address, [AddressDelimiter ])returns ConflictAddress;


Inde& one)based loop inde& to use 'or iterating t#roug# con'licts t#at satis'y t#is 9uery.

Cube "ame o' t#e cube to searc#

User T#e 9uery /ill searc# 'or reservations t#at /ill con'lict /it# t#is user.

ddress To6eni7ed string se9uence o' element names t#at de'ine t#e tuple. T#e order must matc#t#e original dimension order o' t#e cube.

ddressDelimiter ptional c#aracter string t#at is used to separate element names in t#e ddressparameter.

De'ault value P.

'eturn 9alue

Con'lictddress ) Reservation creation timeA name o' t#e reservation o/ner and %lement address o' t#e reservation. T#ecreation time comes 'irstA 'ollo/ed by delimiterA 'ollo/ed by UserIDA 'ollo/ed by delimiterA 'ollo/ed by %lements IDsseparated by t#e delimiter in order o' dimensions in t#e cube ?original order@.

n empty string is returned i' t#ere is no entry 'or t#e speci'ied inde&.

T#e 'ormat o' t#e return value is;

[creation time][delimiter][owner name][delimiter][element1][delimiter]

[element2][delimiter]…[elementN]

(or e&ample;

21222111P(red :loggsP%lement1P%lement2P%lement3

*ote, T#e reservations can c#ange /#ile iterating t#e list o' con'lict reservations so t#e use o' inde& is not guaranteed to

give a complete list o' reservations. Reservations can be added or removed at any position in t#e listA so reservations can be

s6ipped or repeated /#en looping t#roug# inde& values.



f 398 25-09-20



10.>. Managing Data 'eservations !it TM1 A+I functionsYou can use t#e 'ollo/ing TM1 C I 'unctions to programmatically obtainA release and manage Data Reservations.

TM1DataReservationc9uire

TM1DataReservationRelease

TM1DataReservationReleasell

TM1DataReservation,etll

TM1DataReservation,etCon'licts

TM1DataReservation5alidate

TM1Data'eservationAcuireRe9uests a DR 'or a speci'ic TM1 cubeA user and tuple.

TM1Data'eservation'elease

Releases an e&isting DR 'or a speci'ic TM1 cubeA user and tuple.

TM1Data'eservation'eleaseAllReleases multiple Data Reservations 'or t#e speci'ied TM1 user.

TM1Data'eservationGetAll

Determines /#ic# Data Reservations are currently #eld on a TM1 cube.

TM1Data'eservationGetConflictsDetermines /#ic# reservations currently #eld on a TM1 cube /ill con'lict /it# t#e speci'ied client ?user@ and address.

TM1Data'eservation9alidate5alidates all t#e Data Reservations on a TM1 cube.

A+I error codes for data reservations

T#e 'ollo/ing table describes t#e possible error codes t#at can be returned by t#e TM1 C I 'unctions 'or datareservations.



f 398 25-09-20



10.>.1. TM1Data'eservationAcuireRe9uests a DR 'or a speci'ic TM1H cubeA user and tuple.

I' t#ere is an e&isting reservation o/ned by a di''erent user /#ose region overlaps t#e re9uested reservationA t#en t#ereservation re9uest /ill be re!ected unless t#e b(orce 'lag is used. I' t#e b(orce 'lag is true and t#e user running t#e I #ast#e DataReservationverride capabilityA t#en any con'licting reservations /ill be released and t#e ne/ reservation /ill begranted.

Snta

TM1DataReservationAcquire(TM1P hPool, TM1V hCube, TM1VhClient, TM1V bForce, TM1V elementArray );

+arameter Description

#ool $tandard memory pool used by all I commands.

#Cube *andle to t#e cube you /ant to access.

#Client T#e o/ner to use 'or t#e reservation

b(orce :oolean value t#at determines t#e be#avior i' t#e re9uested reservation con'licts /it# ane&isting reservation.

I' set to ?'alse@A t#en t#e re9uest is re!ected i' it con'licts /it# an e&isting reservation.

I' set to 1 ?true@A t#en t#e 'unction replaces any con'licting reservations.

elementrray rray o' element #andles t#at de'ine t#e tupleA t#e order must matc# t#e dimension order.

'eturn 9alue

:oolean value o' true i' t#e re9uest /as granted or 'alse ot#er/ise.

+ossible /rrors

TM1%rrorCube"umber'4eysInvalid

TM1%rrorb!ect*andleInvalid

TM1%rrorCube4eyInvalid

TM1%rrorb!ect$ecurity"oReserveRig#ts

+arent topic, Managing Data Reservations /it# TM1 I 'unctions


f 398 25-09-20



10.>.$. TM1Data'eservation'eleaseReleases an e&isting DR 'or a speci'ic TM1H cubeA user and tuple.

T#e o/ner used 'or #Client must matc# t#e #older o' t#e DR 'or t#e command to succeed unless t#e user invo6ing t#e I#as t#e DataReservationverride capability enabled.

T#e addresses supplied must be an e&act matc#.

Snta

TM1DataReservationRelease(TM1P hPool, TM1V hCube, TM1V hClient,TM1V elementArray );




#Client T#e o/ner o' t#e reservation.

elementrray rray o' element #andles t#at de'ine t#e tuple. T#e order must matc# t#e dimension order.

'eturn 9alue

:oolean value o' true i' t#e re9uest succeeded or 'alse ot#er/ise. "ot 'inding t#e reservation is a 'ailure and returns 'alse.Insu''icient privilege is #andled as an error.

+ossible /rrors

TM1%rrorCube"umber'4eysInvalid



TM1%rrorb!ect$ecurity"odminRig#ts




f 398 25-09-20



10.>.-. TM1Data'eservation'eleaseAllReleases multiple Data Reservations 'or t#e speci'ied TM1H user.

T#e speci'ied address tuple speci'ies t#e starting point 'or t#e searc#. ll reservations o/ned by t#e speci'ied user 'ullycontained /it#in t#e region de'ined by t#e address are released. ny reservation t#at overlaps t#e address but is not 'ullycontained is not released.

$peci'ying a "U88 client /ill remove reservations 'or all users. I' t#e o/ner is not t#e same as t#e user e&ecuting t#ecommandA t#en t#e user must #ave t#e DataReservationverride capability. ttempts to e&ecute t#is command 'or adi''erent user or all users /it#out t#e override capability /ill be re!ected /it#out searc#ing 'or e&isting reservations.

n administrator can release all reservations on a cube by speci'ying a "U88 client and /ildcards 'or every element in t#eaddress.

Snta

TM1DataReservationReleaseAll(TM1P hPool, TM1V hCube, TM1V hClient,TM1V elementArray );




#Client T#e o/ner o' t#e reservation.

elementrray rray o' element #andles t#at de'ine t#e starting point 'or t#e release operation. T#e order mustmatc# t#e dimension order.

'eturn 9alue

:oolean value o' true i' t#ere /ere no errors.

+ossible /rrorsTM1%rrorCube"umber'4eysInvalid




TM1%rrorb!ect$ecurity"odminRig#ts



f 398 25-09-20



10.>.8. TM1Data'eservationGetAllDetermines /#ic# Data Reservations are currently #eld on a TM1H cube.

T#e client parameter is optional. I' it is not supplied ?t#e parameter is set to TM1b!ect"ull@A t#en all t#e DRs on t#e cubeare returned.

I' t#e client parameter is suppliedA t#en only t#e DRs #eld by t#at particular user are returned.

Snta

TM1DataReservationGetAll(TM1P hPool, TM1V hCube, TM1VhClient);




#Client ptional #andle 'or t#e user you /ant to 9uery 'or.

'eturn 9alue

rray o' DR data /it# t#e 'ollo/ing 'ormat;

X1W Cube name ?TM15alType$tring@

X2)nW rray o' DR in'ormation ?TM15alTyperray@

X1W Creation Time

X2W User name ?TM15alType$tring@

X3)nW rray o' element names de'ining t#e tuple ?TM15alTyperray@

X1)nW %lement name ?TM15alType$tring@

+ossible /rrorsTM1%rrorb!ect*andleInvalid



f 398 25-09-20



10.>.=. TM1Data'eservationGetConflictsDetermines /#ic# reservations currently #eld on a TM1H cube /ill con'lict /it# t#e speci'ied client ?user@ and address.

T#is command can be used to gat#er t#e in'ormation needed to determine /#y an attempt to ac9uire a reservation 'ailedAassuming t#e reservation t#at caused t#e denial is still t#ere.

Snta

TM1DataReservationGetConflicts(TM1P hPool, TM1V hCube, TM1V hClient, TM1V elementArray )


#ool $tandard memory pool used by all I commands

#Cube *andle to t#e cube you /ant to access

#Client T#e client ?user@ to compare against current reservation o/ners.

elementrray rray o' element #andles t#at de'ine t#e tuple to compare against. T#e order must matc# t#e

dimension order

'eturn 9alue

Returns an array o' DR data /it# t#e 'ollo/ing 'ormat;

X1W Cube name ?TM15alType$tring@

X2)nW rray o' DR in'ormation ?TM15alTyperray@

X1W Creation Time

X2W User name ?TM15alType$tring@

X3)nW rray o' element names de'ining t#e tuple ?TM15alTyperray@

X1)nW %lement name ?TM15alType$tring@+arent topic, Managing Data Reservations /it# TM1 I 'unctions


f 398 25-09-20



10.>.>. TM1Data'eservation9alidate5alidates all t#e Data Reservations on a TM1H cube.

ny reservation o/ned by a client ?user@ t#at no longer e&ists /ill be removed.

Snta

TM1DataReservationValidate(TM1P hPool, TM1V hCube);


#ool $tandard memory pool used by all I commands

#Cube *andle to t#e cube /e /ant to access

'eturn 9alue

:oolean value o' true.

+ossible /rrors

TM1%rrorb!ect"ot(ound ?invalid cube@



f 398 25-09-20



10.>.?. A+I error codes for data reservationsT#e 'ollo/ing table describes t#e possible error codes t#at can be returned by t#e TM1H C I 'unctions 'or data

reservations.

/rror Description

TM1%rrorCube"umber'4eysInvalid "umber o' elements doesnt matc# t#e number o' cube dimensions.

TM1%rrorb!ect*andleInvalid CubeA ClientA or %lement #andle does not map to an e&isting ob!ect.

TM1%rrorCube4eyInvalid T#e element supplied doesnt matc# an element in t#e dimension at t#at position.T#e element supplied is a UDC.

TM1%rrorb!ect$ecurity"oReserveRig#ts Capability to use reservation is not granted.

TM1%rrorb!ect$ecurity"odminRig#ts ttempt to release a reservation /#en not t#e o/ner and /it#out t#e overridecapability being granted.



f 398 25-09-20



11. Supported /cel Functions " TM1 7ebI:MH CognosH TM1H +eb supports many %&cel /or6s#eet 'unctions.

Supported Functions

T#is appendi& lists t#e supported %&cel 'unctions by category and in alp#abetical orderA and describes any di''erences inper'ormance bet/een t#e %&cel 'unctions and TM1 +eb 'unctions.


f 398 25-09-20



11.1. Supported FunctionsT#is appendi& lists t#e supported %&cel 'unctions by category and in alp#abetical orderA and describes any di''erences in

per'ormance bet/een t#e %&cel 'unctions and TM1H +eb 'unctions.

Date and Time FunctionsT#e 'ollo/ing table lists date and time 'unctions.

Financial Functions

T#e 'ollo/ing table lists 'inancial 'unctions.

Information Functions

T#e 'ollo/ing table lists in'ormation 'unctions.

2ogical FunctionsT#e 'ollo/ing table lists logical 'unctions.

2oo#up and 'eference Functions

T#e 'ollo/ing table lists loo6up and re'erence 'unctions.

Mat and Trigonometric Functions

T#e 'ollo/ing table lists mat# and trigonometric 'unctions.

Tet and Data Functions

T#e 'ollo/ing table lists te&t and data 'unctions.

Statistical FunctionsT#e 'ollo/ing table lists statistical 'unctions.

+arent topic, $upported %&cel (unctions ) TM1 +eb


f 398 25-09-20



11.1.1. Date and Time FunctionsT#e 'ollo/ing table lists date and time 'unctions.

Function Description

DT% Returns t#e serial number o' a particular date.

DT%58U% Converts a date in t#e 'orm o' te&t to a serial number.

DY Converts a serial number to a day o' t#e mont#.

DY$3 Calculates t#e number o' days bet/een t/o dates based on a 3)day year.

*UR Converts a serial number to an #our.

MI"UT% Converts a serial number to a minute.

M"T* Converts a serial number to a mont#.

"+ Returns t#e serial number o' t#e current date and time.

$%C"D Converts a serial number to a second.

TIM% Returns t#e serial number o' a particular time.

TIM%58U% Converts a time in t#e 'orm o' te&t to a serial number.

TDY Returns t#e serial number o' todays date.

+%%4DY Converts a serial number to a day o' t#e /ee6.

Y%R Converts a serial number to a year.

+arent topic, $upported (unctions


f 398 25-09-20



11.1.$. Financial FunctionsT#e 'ollo/ing table lists 'inancial 'unctions.


D: Returns t#e depreciation o' an asset 'or a speci'ied period using t#e 'i&ed)declining balance met#od.

DD: Returns t#e depreciation o' an asset 'or a speci'ied period using t#e double)declining balance met#od or someot#er met#od you speci'y.

(5 Returns t#e 'uture value o' an investment.

IMT Returns t#e interest payment 'or an investment 'or a given period.

IRR Returns t#e internal rate o' return 'or a series o' cas# 'lo/s.

I$MT Calculates t#e interest paid during a speci'ic period o' an investment.

MIRR Returns t#e internal rate o' return /#ere positive and negative cas# 'lo/s are 'inanced at di''erent rates.

"%R Returns t#e number o' periods 'or an investment.

"5 Returns t#e net present value o' an investment based on a series o' periodic cas# 'lo/s and a discount rate.

MT Returns t#e periodic payment 'or an annuity.

MT Returns t#e payment on t#e principal 'or an investment 'or a given period.

5 Returns t#e present value o' an investment.

RT% Returns t#e interest rate per period o' an annuity.

$8" Returns t#e straig#t)line depreciation o' an asset 'or one period.

$YD Returns t#e sum)o')years digits depreciation o' an asset 'or a speci'ied period.



f 398 25-09-20



11.1.-. Information FunctionsT#e 'ollo/ing table lists in'ormation 'unctions.


I$%RR Returns TRU% i' t#e value is any error value e&cept ^".

I$%RRR Returns TRU% i' t#e value is any error value.

I$" Returns TRU% i' t#e value is t#e ̂ " error value.

" Returns t#e error value ̂ ".



f 398 25-09-20



11.1.8. 2ogical FunctionsT#e 'ollo/ing table lists logical 'unctions.


"D Returns TRU% i' all its arguments are TRU%.

(8$% Returns t#e logical value (8$%.

I( $peci'ies a logical test to per'orm.

"T Reverses t#e logic o' its argument.

R Returns TRU% i' any argument is TRU%.

TRU% Returns t#e logical value TRU%.



f 398 25-09-20



11.1.=. 2oo#up and 'eference FunctionsT#e 'ollo/ing table lists loo6up and re'erence 'unctions.

*ote, Certain 'unctionsA suc# as 84U and R+$A may accept t/o dimensional arrays as arguments. TM1H +eb does not

support t/o dimensional arrays. Depending on t#e data organi7ation and re9uirementsA t#ese 'unctions can still obtain

correct valuesA 'or e&ampleA /#en t#e data being retrieved 'alls in t#e initial portions o' t#e array. To ensure correct values

/#en /or6ing /it# t#ese 'unctions on TM1+ebA you may need to reorgani7e t#e input data into repeated 'unctions using one

dimensional arrays or you may need to use direct cell re'erences.


DDR%$$ Returns a re'erence as te&t to a single cell in a /or6s#eet.

C*$% C#ooses a value 'rom a list o' values.

C8UM" Returns t#e column number o' a re'erence.

C8UM"$ Returns t#e number o' columns in a re'erence.

*84U 8oo6s in t#e top ro/ o' an array and returns t#e value o' t#e indicated cell.

*Y%R8I"4 Creates a s#ortcut or !ump t#at opens a document stored on a net/or6 serverA an intranetA or t#e Internet.

I"D%E Uses an inde& to c#oose a value 'rom a re'erence or array.

84U 8oo6s up values in a vector or array.

(($%T Returns a re'erence o''set 'rom a given re'erence.

R+ Returns t#e ro/ number o' a re'erence.

R+$ Returns t#e number o' ro/s in a re'erence.

584U 8oo6s in t#e 'irst column o' an array and moves across t#e ro/ to return t#e value o' a cell.



f 398 25-09-20



11.1.>. Mat and Trigonometric FunctionsT#e 'ollo/ing table lists mat# and trigonometric 'unctions.


:$ Returns t#e absolute value o' a number.

C$ Returns t#e arccosine o' a number.

C$* Returns t#e inverse #yperbolic cosine o' a number.

$I" Returns t#e arcsine o' a number.

$I"* Returns t#e inverse #yperbolic sine o' a number.

T" Returns t#e arctangent o' a number.

T"2 Returns t#e arctangent 'rom &) and y)coordinates.

T"* Returns t#e inverse #yperbolic tangent o' a number.

C%I8I", Rounds a number to t#e nearest integer or to t#e nearest multiple o' signi'icance.

CM:I" Returns t#e number o' combinations 'or a given number o' ob!ects.

C$ Returns t#e cosine o' a number.

C$* Returns t#e #yperbolic cosine o' a number.

D%,R%%$ Converts radians to degrees.

%5%" Rounds a number up to t#e nearest even integer.

%E Returns e raised to t#e po/er o' a given number.

(CT Returns t#e 'actorial o' a number.

(8R Rounds a number do/nA to/ard 7ero.

I"T Rounds a number do/n to t#e nearest integer.

8" Returns t#e natural logarit#m o' a number.

8, Returns t#e logarit#m o' a number to a speci'ied base.


f 398 25-09-20




8,1 Returns t#e base)1 logarit#m o' a number.

MD Returns t#e remainder 'rom division.

DD Rounds a number up to t#e nearest odd integer.

I Returns t#e value o' pi.

+%R Returns t#e result o' a number raised to a po/er.

RDUCT Multiplies its arguments.

RDI"$ Converts degrees to radians.

R"D Returns a random number bet/een and 1.

RM" Converts an arabic numeral to romanA as te&t.

RU"D Rounds a number to a speci'ied number o' digits.

RU"DD+" Rounds a number do/nA to/ard 7ero.

RU"DU Rounds a number upA a/ay 'rom 7ero.

$I," Returns t#e sign o' a number.

$I" Returns t#e sine o' t#e given angle.

$I"* Returns t#e #yperbolic sine o' a number.

$=RT Returns a positive s9uare root.

$UM dds its arguments.

$UMI( dds t#e cells speci'ied by a given criteria.

T" Returns t#e tangent o' a number.

T"* Returns t#e #yperbolic tangent o' a number.



f 398 25-09-20



11.1.?. Tet and Data FunctionsT#e 'ollo/ing table lists te&t and data 'unctions.


C*R Returns t#e c#aracter speci'ied by t#e code number.

C8%" Removes all nonprintable c#aracters 'rom te&t.

CD% Returns a numeric code 'or t#e 'irst c#aracter in a te&t string.

C"CT%"T% Foins several te&t items into one te&t item.

D88R Converts a number to te&tA using t#e [ ?dollar@ currency 'ormat.

%ECT C#ec6s to see i' t/o te&t values are identical.

(I"D (inds one te&t value /it#in anot#er ?case)sensitive@.

(IE%D (ormats a number as te&t /it# a 'i&ed number o' decimals.

8%(T Returns t#e le'tmost c#aracters 'rom a te&t value.

8%" Returns t#e number o' c#aracters in a te&t string.

8+%R Converts te&t to lo/ercase.

MID Returns a speci'ic number o' c#aracters 'rom a te&t string starting at t#e position you speci'y.

R%R Capitali7es t#e 'irst letter in eac# /ord o' a te&t value.

R%8C% Replaces c#aracters /it#in te&t.

R%T Repeats te&t a given number o' times.

RI,*T Returns t#e rig#tmost c#aracters 'rom a te&t value.

$%RC* (inds one te&t value /it#in anot#er ?not case)sensitive@.

$U:$TITUT% $ubstitutes ne/ te&t 'or old te&t in a te&t string.

T Converts its arguments to te&t.

T%ET (ormats a number and converts it to te&t.


f 398 25-09-20




TRIM Removes spaces 'rom te&t.

U%R Converts te&t to uppercase.

58U% Converts a te&t argument to a number.



f 398 25-09-20



11.1.E. Statistical FunctionsT#e 'ollo/ing table lists statistical 'unctions.


5%D%5 Returns t#e average o' t#e absolute deviations o' data points 'rom t#eir mean.

5%R,% Returns t#e average o' its arguments.

5%R,% Returns t#e average o' its argumentsA including numbersA te&tA and logical values.

:I"MDI$T Returns t#e individual term binomial distribution probability.

C"(ID%"C% Returns t#e con'idence interval 'or a population mean.

CRR%8 Returns t#e correlation coe''icient bet/een t/o data sets.

CU"T Counts #o/ many numbers are in t#e list o' arguments.

CU"T Counts #o/ many values are in t#e list o' arguments.

CU"TI( Counts t#e number o' nonblan6 cells /it#in a range t#at meet t#e given criteria.

C5R Returns covarianceA t#e average o' t#e products o' paired deviations.

D%5$= Returns t#e sum o' s9uares o' deviations.

%E"DI$T Returns t#e e&ponential distribution.

(I$*%R Returns t#e (is#er trans'ormation.

(I$*%RI"5 Returns t#e inverse o' t#e (is#er trans'ormation.

(R%C$T Returns a value along a linear trend.

,%M%" Returns t#e geometric mean.

,R+T* Returns values along an e&ponential trend.

*RM%" Returns t#e #armonic mean.

I"T%RC%T Returns t#e intercept o' t#e linear regression line.

4URT Returns t#e 6urtosis o' a data set.


f 398 25-09-20




8R,% Returns t#e 6)t# largest value in a data set.

8I"%$T Returns t#e parameters o' a linear trend.

8,%$T Returns t#e parameters o' an e&ponential trend.

ME Returns t#e ma&imum value in a list o' arguments.

ME Returns t#e ma&imum value in a list o' argumentsA including numbersA te&tA and logical values.

M%DI" Returns t#e median o' t#e given numbers.

MI" Returns t#e minimum value in a list o' arguments.

MI" Returns t#e smallest value in a list o' argumentsA including numbersA te&tA and logical values.

MD% Returns t#e most common value in a data set.

"RMDI$T Returns t#e normal cumulative distribution.

"RMI"5 Returns t#e inverse o' t#e normal cumulative distribution.

"RM$DI$T Returns t#e standard normal cumulative distribution.

"RM$I"5 Returns t#e inverse o' t#e standard normal cumulative distribution.

%R$" Returns t#e earson product moment correlation coe''icient.

%RMUT Returns t#e number o' permutations 'or a given number o' ob!ects.

R$= Returns t#e s9uare o' t#e earson product moment correlation coe''icient.

$4%+ Returns t#e s6e/ness o' a distribution.

$8% Returns t#e slope o' t#e linear regression line.

$M88 Returns t#e 6)t# smallest value in a data set.

$T"DRDI_% Returns a normali7ed value.

$TD%5 %stimates standard deviation based on a sample.

$TD%5 %stimates standard deviation based on a sampleA including numbersA te&tA and logical values.


f 398 25-09-20




$TD%5 Calculates standard deviation based on t#e entire population.

$TD%5 Calculates standard deviation based on t#e entire populationA including numbersA te&tA and logical values.

$T%YE Returns t#e standard error o' t#e predicted y)value 'or eac# & in t#e regression.

TR%"D Returns values along a linear trend.

5R %stimates variance based on a sample.

5R %stimates variance based on a sampleA including numbersA te&tA and logical values.

5R Calculates variance based on t#e entire population.

5R Calculates variance based on t#e entire populationA including numbersA te&tA and logical values.

+%I:U88 Returns t#e +eibull distribution.



f 398 25-09-20



1$. %nsupported /cel Functions " TM1 7ebI:MH CognosH TM1H +eb supports many %&cel /or6s#eet 'unctions. T#is appendi& lists t#e %&cel 'unctionsA by category

and in alp#abetical orderA t#at are not supported in TM1 +eb.

Database and 2ist Management FunctionsT#is table lists t#e management 'unctions t#at are not supported in TM1 +eb.

Date and Time Functions

T#is table lists t#e date and time 'unctions t#at are not supported in TM1 +eb.

Financial Functions

T#is table lists t#e 'inancial 'unctions t#at are not supported in TM1 +eb.

Information FunctionsT#is table lists t#e in'ormation 'unctions t#at are not supported in TM1 +eb.

2oo#up and 'eference Functions

T#is table lists t#e loo6up and re'erence 'unctions t#at are not supported in TM1 +eb.

Mat and Trigonometric Functions

T#is table lists t#e mat# and trigonometric 'unctions t#at are not supported in TM1 +eb.

Statistical Functions

T#is table lists t#e statistical 'unctions t#at are not supported in TM1 +eb.

Tet and Data FunctionsT#is table lists t#e te&t and data 'unctions t#at are not supported in TM1 +eb.


f 398 25-09-20



1$.1. Database and 2ist Management FunctionsT#is table lists t#e management 'unctions t#at are not supported in TM1H +eb.


D5%R,% Returns t#e average o' selected database entries.

DCU"T Counts t#e cells t#at contain numbers in a database.

DCU"T Counts nonblan6 cells in a database.

D,%T %&tracts 'rom a database a single record t#at matc#es t#e speci'ied criteria.

DME Returns t#e ma&imum value 'rom selected database entries.

DMI" Returns t#e minimum value 'rom selected database entries.

DRDUCT Multiplies t#e values in a particular 'ield o' records t#at matc# t#e criteria in a database.

D$TD%5 %stimates t#e standard deviation based on a sample o' selected database entries.

D$TD%5 Calculates t#e standard deviation based on t#e entire population o' selected database entries.

D$UM dds t#e numbers in t#e 'ield column o' records in t#e database t#at matc# t#e criteria.

D5R %stimates variance based on a sample 'rom selected database entries.

D5R Calculates variance based on t#e entire population o' selected database entries.

+arent topic, Unsupported %&cel (unctions ) TM1 +eb


f 398 25-09-20



1$.$. Date and Time FunctionsT#is table lists t#e date and time 'unctions t#at are not supported in TM1H +eb.


%DT% Returns t#e serial number o' t#e date t#at is t#e indicated number o' mont#s be'ore or a'ter t#e startdate.

%M"T* Returns t#e serial number o' t#e last day o' t#e mont# be'ore or a'ter a speci'ied number o' mont#s.

"%T+R4DY$ Returns t#e number o' /#ole /or6days bet/een t/o dates.

+%%4"UM Converts a serial number to a number representing /#ere t#e /ee6 'alls numerically /it# a year.

+R4DY Returns t#e serial number o' t#e date be'ore or a'ter a speci'ied number o' /or6days.

Y%R(RC Returns t#e year 'raction representing t#e number o' /#ole days bet/een start]date and end]date.



f 398 25-09-20



1$.-. Financial FunctionsT#is table lists t#e 'inancial 'unctions t#at are not supported in TM1H +eb.

Functions Description

CCRI"T Returns t#e accrued interest 'or a security t#at pays periodic interest.

CCRI"TM Returns t#e accrued interest 'or a security t#at pays interest at maturity.

MRD%,RC Returns t#e depreciation 'or eac# accounting period by using a depreciation coe''icient.

MR8I"C Returns t#e depreciation 'or eac# accounting period.

CUDY:$ Returns t#e number o' days 'rom t#e beginning o' t#e coupon period to t#e settlement date.

CUDY$ Returns t#e number o' days in t#e coupon period t#at contains t#e settlement date.

CUDY$"C Returns t#e number o' days 'rom t#e settlement date to t#e ne&t coupon date.

CU"CD Returns t#e ne&t coupon date a'ter t#e settlement date.

CU"UM Returns t#e number o' coupons payable bet/een t#e settlement date and maturity date.

CUCD Returns t#e previous coupon date be'ore t#e settlement date.

CUMIMT Returns t#e cumulative interest paid bet/een t/o periods.

CUMRI"C Returns t#e cumulative principal paid on a loan bet/een t/o periods.

DI$C Returns t#e discount rate 'or a security.

D88RD% Converts a dollar priceA e&pressed as a 'ractionA into a dollar priceA e&pressed as a decimal number.

D88R(R Converts a dollar priceA e&pressed as a decimal numberA into a dollar priceA e&pressed as a 'raction.

DURTI" Returns t#e annual duration o' a security /it# periodic interest payments.

%((%CT Returns t#e e''ective annual interest rate.

(5$C*%DU8% Returns t#e 'uture value o' an initial principal a'ter applying a series o' compound interest rates.

I"TRT% Returns t#e interest rate 'or a 'ully invested security.

MDURTI" Returns t#e Macauley modi'ied duration 'or a security /it# an assumed par value o' [1.


f 398 25-09-20



Functions Description

"MI"8 Returns t#e annual nominal interest rate.

DD(RIC% Returns t#e price per [1 'ace value o' a security /it# an odd 'irst period.

DD(YI%8D Returns t#e yield o' a security /it# an odd 'irst period.

DD8RIC% Returns t#e price per [1 'ace value o' a security /it# an odd last period.

DD8YI%8D Returns t#e yield o' a security /it# an odd last period.

RIC% Returns t#e price per [1 'ace value o' a security t#at pays periodic interest.

RIC%DI$C Returns t#e price per [1 'ace value o' a discounted security.

RIC%MT Returns t#e price per [1 'ace value o' a security t#at pays interest at maturity.

R%C%I5%D Returns t#e amount received at maturity 'or a 'ully invested security.

T:I88%= Returns t#e bond)e9uivalent yield 'or a Treasury bill.

T:I88RIC% Returns t#e price per [1 'ace value 'or a Treasury bill.

T:I88YI%8D Returns t#e yield 'or a Treasury bill.

5D: Returns t#e depreciation o' an asset 'or a speci'ied or partial period using a declining balance met#od.

EIRR Returns t#e internal rate o' return 'or a sc#edule o' cas# 'lo/s t#at is not necessarily periodic.

E"5 Returns t#e net present value 'or a sc#edule o' cas# 'lo/s t#at is not necessarily periodic.

YI%8D Returns t#e yield on a security t#at pays periodic interest.

YI%8DDI$C Returns t#e annual yield 'or a discounted securityJ 'or e&ampleA a Treasury bill.

YI%8DMT Returns t#e annual yield o' a security t#at pays interest at maturity.



f 398 25-09-20



1$.8. Information FunctionsT#is table lists t#e in'ormation 'unctions t#at are not supported in TM1H +eb.


C%88 Returns in'ormation about t#e 'ormattingA locationA or contents o' a cell.

%RRR.TY% Returns a number corresponding to an error type.

I"( Returns in'ormation about t#e current operating environment.

I$:8"4 Returns TRU% i' t#e value is blan6.

I$%5%" Returns TRU% i' t#e number is even.

I$8,IC8 Returns TRU% i' t#e value is a logical value.

I$""T%ET Returns TRU% i' t#e value is not te&t.

I$"UM:%R Returns TRU% i' t#e value is a number.

I$DD Returns TRU% i' t#e number is odd.

I$R%( Returns TRU% i' t#e value is a re'erence.

I$T%ET Returns TRU% i' t#e value is te&t.

" Returns a value converted to a number.

TY% Returns a number indicating t#e data type o' a value.



f 398 25-09-20



1$.=. 2oo#up and 'eference FunctionsT#is table lists t#e loo6up and re'erence 'unctions t#at are not supported in TM1H +eb.


R%$ Returns t#e number o' areas in a re'erence.

I"DIR%CT Returns a re'erence indicated by a te&t value.

MTC* 8oo6s up values in a re'erence or array.

RTD Retrieves real)time data 'rom a program t#at supports CM automation.

TR"$$% Returns t#e transpose o' an array.



f 398 25-09-20



1$.>. Mat and Trigonometric FunctionsT#is table lists t#e mat# and trigonometric 'unctions t#at are not supported in TM1H +eb.


(CTDU:8% Returns t#e double 'actorial o' a number.

,CD Returns t#e greatest common divisor.

8CM Returns t#e least common multiple.

MD%T%RM Returns t#e matri& determinant o' an array.

MI"5%R$% Returns t#e matri& inverse o' an array.

MMU8T Returns t#e matri& product o' t/o arrays.

MRU"D Returns a number rounded to t#e desired multiple.

MU8TI"MI8 Returns t#e multinomial o' a set o' numbers.

=UTI%"T Returns t#e integer portion o' a division.

R"D:%T+%%" Returns a random number bet/een t#e numbers you speci'y.

$%RI%$$UM Returns t#e sum o' a po/er series based on t#e 'ormula.

$=RTI Returns t#e s9uare root o' ?number Q pi@.

$U:TT8 Returns a subtotal in a list or database.

$UMRDUCT Returns t#e sum o' t#e products o' corresponding array components.

$UM$= Returns t#e sum o' t#e s9uares o' t#e arguments.

$UME2MY2 Returns t#e sum o' t#e di''erence o' s9uares o' corresponding values in t/o arrays.

$UME2Y2 Returns t#e sum o' t#e sum o' s9uares o' corresponding values in t/o arrays.

$UMEMY2 Returns t#e sum o' s9uares o' di''erences o' corresponding values in t/o arrays.

TRU"C Truncates a number to an integer.



f 398 25-09-20



1$.?. Statistical FunctionsT#is table lists t#e statistical 'unctions t#at are not supported in TM1H +eb.


:%TDI$T Returns t#e beta cumulative distribution 'unction.

:%TI"5 Returns t#e inverse o' t#e cumulative distribution 'unction 'or a speci'ied beta distribution.

C*IDI$T Returns t#e one)tailed probability o' t#e c#i)s9uared distribution.

C*II"5 Returns t#e inverse o' t#e one)tailed probability o' t#e c#i)s9uared distribution.

C*IT%$T Returns t#e test 'or independence.

CU"T:8"4 Counts t#e number o' blan6 cells /it#in a range.

CRIT:I"M Returns t#e smallest value 'or /#ic# t#e cumulative binomial distribution is less t#an or e9ual to acriterion value.

(DI$T Returns t#e ( probability distribution.

(I"5 Returns t#e inverse o' t#e ( probability distribution.

(R%=U%"CY Returns a 're9uency distribution as a vertical array.

(T%$T Returns t#e result o' an ()test.

,MMDI$T Returns t#e gamma distribution.

,MMI"5 Returns t#e inverse o' t#e gamma cumulative distribution.

,MM8" Returns t#e natural logarit#m o' t#e gamma 'unctionA ,?&@.

*Y,%MDI$T Returns t#e #yper geometric distribution.

8,I"5 Returns t#e inverse o' t#e lognormal distribution.

8,"RMDI$T Returns t#e cumulative lognormal distribution.

"%,:I"MDI$T Returns t#e negative binomial distribution.

%RC%"TI8% Returns t#e 6)t# percentile o' values in a range.

%RC%"TR"4 Returns t#e percentage ran6 o' a value in a data set.


f 398 25-09-20




I$$" Returns t#e oisson distribution.

R: Returns t#e probability t#at values in a range are bet/een t/o limits.

=URTI8% Returns t#e 9uartile o' a data set.

R"4 Returns t#e ran6 o' a number in a list o' numbers.

TDI$T Returns t#e $tudents t)distribution.

TI"5 Returns t#e inverse o' t#e $tudents t)distribution.

TRIMM%" Returns t#e mean o' t#e interior o' a data set.

TT%$T Returns t#e probability associated /it# a $tudents t)test.

_T%$T Returns t#e one)tailed probability)value o' a 7)test.



f 398 25-09-20



1$.E. Tet and Data FunctionsT#is table lists t#e te&t and data 'unctions t#at are not supported in TM1H +eb.


$C C#anges 'ull)/idt# ?double)byte@ %nglis# letters or 6ata6ana /it#in a c#aracter string to #al')/idt#?single)byte@ c#aracters.

:*TT%ET Converts a number to te&tA using t#e ?ba#t@ currency 'ormat.

FI$ C#anges #al')/idt# ?single)byte@ %nglis# letters or 6ata6ana /it#in a c#aracter string to 'ull)/idt#?double)byte@ c#aracters.

*"%TIC %&tracts t#e p#onetic ?'urigana@ c#aracters 'rom a te&t string.

uto$#apes TM1 +eb does not support Microso't ''ice utos#apes.



f 398 25-09-20



1-. *otices

T#is in'ormation /as developed 'or products and services o''ered /orld/ide.

I:M may not o''er t#e productsA servicesA or 'eatures discussed in t#is document in ot#er countries. Consult your local I:Mrepresentative 'or in'ormation on t#e products and services currently available in your area. ny re'erence to an I:MproductA programA or service is not intended to state or imply t#at only t#at I:M productA programA or service may be used.ny 'unctionally e9uivalent productA programA or service t#at does not in'ringe any I:M intellectual property rig#t may beused instead. *o/everA it is t#e users responsibility to evaluate and veri'y t#e operation o' any non)I:M productA programAor service.

I:M may #ave patents or pending patent applications covering sub!ect matter described in t#is document. T#e 'urnis#ing o'

t#is document does not grant you any license to t#ese patents. You can send license in9uiriesA in /ritingA to;

I:M Director o' 8icensingI:M Corporation"ort# Castle Drivermon6A "Y 10-)1<0U.$..

(or license in9uiries regarding double)byte ?D:C$@ in'ormationA contact t#e I:M Intellectual roperty Department in your

country or send in9uiriesA in /ritingA to;

Intellectual roperty 8icensing8egal and Intellectual roperty 8a/

I:M Fapan 8td.123)1-A $#imotsurumaA Yamato)s#i4anaga/a 2-2)<02 Fapan

T#e 'ollo/ing paragrap# does not apply to t#e United 4ingdom or any ot#er country /#ere suc# provisions are inconsistent/it# local la/; I"T%R"TI"8 :U$I"%$$ MC*I"%$ CRRTI" R5ID%$ T*I$ U:8ICTI" $ I$ +IT*UT+RR"TY ( "Y 4I"DA %IT*%R %ER%$$ R IM8I%DA I"C8UDI",A :UT "T 8IMIT%D TA T*% IM8I%D +RR"TI%$ ("")I"(RI",%M%"TA M%RC*"T:I8ITY R (IT"%$$ (R RTICU8R UR$%. $ome states do not allo/ disclaimer o' e&press or implied /arranties in certain transactionsA t#ere'oreA t#is statement may not apply to you.

T#is in'ormation could include tec#nical inaccuracies or typograp#ical errors. C#anges are periodically made to t#ein'ormation #ereinJ t#ese c#anges /ill be incorporated in ne/ editions o' t#e publication. I:M may ma6e improvementsandor c#anges in t#e product?s@ andor t#e program?s@ described in t#is publication at any time /it#out notice.

ny re'erences in t#is in'ormation to non)I:M +eb sites are provided 'or convenience only and do not in any manner serve

as an endorsement o' t#ose +eb sites. T#e materials at t#ose +eb sites are not part o' t#e materials 'or t#is I:M productand use o' t#ose +eb sites is at your o/n ris6.

I:M may use or distribute any o' t#e in'ormation you supply in any /ay it believes appropriate /it#out incurring anyobligation to you.

8icensees o' t#is program /#o /is# to #ave in'ormation about it 'or t#e purpose o' enabling; ?i@ t#e e&c#ange o' in'ormation

bet/een independently created programs and ot#er programs ?including t#is one@ and ?ii@ t#e mutual use o' t#e in'ormation

/#ic# #as been e&c#angedA s#ould contact;

I:M $o't/are ,roupttention; 8icensing300 Riverside Drtta/aA " 415 1:Canada

$uc# in'ormation may be availableA sub!ect to appropriate terms and conditionsA including in some casesA payment o' a 'ee.

T#e licensed program described in t#is document and all licensed material available 'or it are provided by I:M under terms o' t#e I:M Customer greementA I:M International rogram 8icense greement or any e9uivalent agreement bet/een us.

ny per'ormance data contained #erein /as determined in a controlled environment. T#ere'oreA t#e results obtained in ot#eroperating environments may vary signi'icantly. $ome measurements may #ave been made on development)level systemsand t#ere is no guarantee t#at t#ese measurements /ill be t#e same on generally available systems. (urt#ermoreA somemeasurements may #ave been estimated t#roug# e&trapolation. ctual results may vary. Users o' t#is document s#ouldveri'y t#e applicable data 'or t#eir speci'ic environment.

In'ormation concerning non)I:M products /as obtained 'rom t#e suppliers o' t#ose productsA t#eir publis#ed announcementsor ot#er publicly available sources. I:M #as not tested t#ose products and cannot con'irm t#e accuracy o' per'ormanceAcompatibility or any ot#er claims related to non)I:M products. =uestions on t#e capabilities o' non)I:M products s#ould be


f 398 25-09-20



addressed to t#e suppliers o' t#ose products.

ll statements regarding I:Ms 'uture direction or intent are sub!ect to c#ange or /it#dra/al /it#out noticeA and representgoals and ob!ectives only.

T#is in'ormation contains e&amples o' data and reports used in daily business operations. To illustrate t#em as completely aspossibleA t#e e&amples include t#e names o' individualsA companiesA brandsA and products. ll o' t#ese names are 'ictitiousand any similarity to t#e names and addresses used by an actual business enterprise is entirely coincidental.

I' you are vie/ing t#is in'ormation so'tcopyA t#e p#otograp#s and color illustrations may not appear.

X


Date post:	02-Jun-2018
Category:	Documents
Upload:	gabrielauctus
View:	236 times
Download:	0 times

02.Cognos TM1 Developer Guide 10.1.0

Documents