04.TM1 Operation Guide 10.1.1

TM1 Operation Guide 10.1.
1
Contents
1. Introduction
2. What's new
2.1. New features in Cognos TM1 Operations Guide version 10.1.1
2.1.1. New onitoring options avai!a"!e in the Cognos TM1 10.1.1 Operations Conso!e
2.2. New features in version 10.1.0
2.2.1. Cognos TM1 Operations Conso!e
2.2.2. t1#fer
2.2.$. od"c%test too!
2.$. Changed features in version 10.1.0
2.$.1. &ara!!e! Interaction concurrenc' set "' defau!t
2.$.2. (ocuentation changes to the I)M Cognos TM1 Operation Guide
$. TM1 *'ste and +eature Configuration
$.1. TM1 *'ste and +eature Configuration Overview
$.2. Capa"i!it' ,ssignents
$.2.1. Cognos TM1 ,pp!ication We" Capa"i!ities
$.2.2. *etting Capa"i!ities
$.2.$. -nderstanding the .ffect of )!an/s in the Capa"i!it' ,ssignents
$.2.$.1. -nderstanding 0eca!c and Coit in a &ersona! Wor/space
$.$. -sing &ersistent +eeders
$.$.1. *aving data with persistent feeders
$.$.2. Modif'ing ru!es for cu"es with feeders
$.$.$. 1and!ing corrupted or inva!idated feeder fi!es
$.2. Configuring and Managing *and"o#es in 'our TM1 .nvironent
$.2.1. Meor' -sage Considerations for *and"o#es and &ersona! Wor/spaces
$.2.2. Managing +i!es and +o!ders for *and"o#es
$.2.$. TM1 *erver Configuration &araeters for *and"o#es
$.2.2. -nderstanding *and"o# (ifferences ,ong (ifferent TM1 C!ients
$.3. -sing &ara!!e! Interaction with a Cognos TM1 server
$.3.1. )est practice use of &ara!!e! Interaction
2. Cognos TM1 ,din *erver Operations
2.1. TM1 ,din *erver
2.2. 0unning the Cognos TM1 ,din *erver on a Windows operating s'ste
2.2.1. 0unning the Cognos TM1 ,din *erver as an ,pp!ication on Windows
2.2.1.1. 4iewing ,din *erver *tatus
2.$. 0unning the Cognos TM1 ,din *erver on -NI5
2.$.1. 4iewing ,din *erver *tatus 0eport
2.2. *pecif'ing the 6ocation of the ,din 1ost
2.2.1. *pecif'ing Mu!tip!e ,din 1osts
3. 0eote Cognos TM1 *erver Operations
3.1. Overview of 0eote *erver Operations
3.2. *etting -p a 0eote TM1 *erver to 0un as an ,pp!ication
3.$. *etting -p a 0eote TM1 *erver to 0un as a Windows *ervice
3.$.1. Insta!!ing a TM1 *erver to 0un as a Windows *ervice
3.$.2. 0eoving a TM1 *erver fro 0unning as a Windows *ervice
3.2. *tarting a 0eote TM1 *erver
3.2.1. *tarting a TM1 *erver *et -p as a Windows ,pp!ication
3.2.2. *tarting a TM1 *erver Insta!!ed as a Windows *ervice
3.2.2.1. *etting up a *ervice to *tart ,utoatica!!'
3.2.$. *tarting a -NI5 TM1 *erver
3.2.$.1. Modif'ing the startup%t1s.sh *cript
TM1 Operation Guide 10.1.1 http://pic.dhe.ibm.com/infocenter/ctm1/v10r1m0/advanced/print.jsp?topi...
1 of 425 26-09-2014 11:18
3.2.$.2. 0unning the -NI5 TM1 *erver in )ac/ground Mode
3.3. Connecting to a 0eote *erver
3.3.1. 0efreshing the 6ist of 0eote *ervers
3.3.2. 0e7*etting the ,din 1ost
3.3.$. 0e7*etting 6oca! *erver Options
3.8. (isconnecting fro a 0eote *erver
3.9. *hutting (own a Windows TM1 *erver
3.9.1. *hutting (own a Windows TM1 *erver 0unning as a *ervice
3.:. *hutting (own a -NI5 TM1 *erver
3.:.1. *hutting (own a -NI5 TM1 *erver 0unning in )ac/ground Mode
3.;. 6ogging Transactions
3.;.1. (ata )ac/up and 0ecover'
3.;.2. .na"!ing and (isa"!ing 6ogging
3.;.$. 4iewing the Transaction 6og
3.;.2. *etting *earch 6oc/ 6iit
3.;.3. )ac/ing Out 0ecords fro the Transaction 6og
3.;.8. 0eoving 6og +i!es fro the (is/
3.10. Monitoring *erver &erforance
3.11. Managing C!ient Connections
3.11.1. )roadcasting Messages to C!ients
3.11.2. (isconnecting C!ients fro the *erver
3.11.$. *hutting (own a *erver 0eote!'
3.12. 0eote *erver Meor' Manageent
3.12.1. ,"out *targate 4iews
3.1$. -sing TM1 in )u!/ 6oad Mode
3.1$.1. Considerations for -sing )u!/ 6oad Mode
3.1$.1.1. *tarting )u!/ 6oad Mode
3.1$.1.2. .nding )u!/ 6oad Mode
3.1$.2. TM1 C ,&I
3.1$.$. Tur"oIntegrator &rocess Coands
8. TM1 *ecurit' Overview
8.1. Overview to authentication
8.2. O"<ect *ecurit'
9. Managing -sers and Groups
9.1. TM1 -sers and Groups *ecurit' Overview
9.1.1. Ip!eenting a TM1 *ecurit' *chee
9.1.2. TM1 -ser and Group *ecurit' .#ap!es
9.2. -nderstanding ,dinistrative Groups and ,uthorit'
9.2.1. ,(MIN Group
9.2.2. *ecurit',din Group
9.2.2.1. 0estrictions on 0ep!ication and *'nchroni=ation
9.2.2.2. 0estrictions for 0u!es and &rocesses
9.2.2.$. Co"ining *ecurit',din Me"ership with Other Groups
9.2.2.2. -sing the *ecurit',din Group with the TM1 C ,&I
9.2.2.3. 0estrictions on ,dding -sers to the ,(MIN Group
9.2.$. (ata,din Group
9.2.$.1. Me"ership in -ser Groups
9.2.$.2. Me"ership in "oth the *ecurit',din and (ata,din Groups
9.2.$.$. 0estrictions on 0ep!ication and *'nchroni=ation
9.2.$.2. 0estrictions on 0u!es for *ecurit' Contro! Cu"es
9.$. ,dding and (e!eting -sers and Groups
9.$.1. ,dding a -ser
9.$.2. ,dding a Group
9.$.$. (e!eting a -ser
9.$.2. (e!eting a Group
2 of 425 26-09-2014 11:18
9.2. ,ssigning -sers to Groups
9.2.1. Me"ership in Mu!tip!e Groups
9.3. *ecuring TM1 (ata
9.3.1. 0estricting ,ccess to the (ata (irector'
9.3.2. ,ssigning &asswords
9.3.$. -sing *tandard *ecurit' for &asswords
9.8. *etting and C!earing &asswords
9.8.1. *etting a &assword
9.8.2. C!earing a &assword
9.8.$. Changing a &assword
9.9. *etting an .#piration for a -ser
:. *'ste and &erforance Monitoring
:.1. Overview of TM1 *'ste and &erforance Monitoring
:.2. -sing the ,din *erver 6og
:.2.1. Message *everit' 6eve!s for ,din *erver 6ogging
:.2.2. Configuring ,din *erver 6ogging
:.2.$. .na"!ing ,din *erver 6ogging
:.2.2. 4iewing the ,din *erver 6og +i!e
:.$. 6ogging Transactions
:.$.1. (ata )ac/up and 0ecover'
:.$.2. .na"!ing and (isa"!ing Transaction 6ogging
:.$.$. 4iewing the Transaction 6og
:.$.2. )ac/ing Out 0ecords fro the Transaction 6og
:.$.3. 0eoving Transaction 6og +i!es fro the (is/
:.$.8. Trou"!eshooting> 0ecovering fro a Corrupt Transaction 6og +i!e
:.2. -sing the *erver Message 6og
:.2.1. Message *everit' 6eve!s
:.2.2. 6oggers
:.2.$. 6ogging &roperties +i!e
:.2.2. Configuring and .na"!ing *erver Message 6ogging
:.2.2.1. .na"!ing and (isa"!ing 6ogging
:.2.2.2. Configuring 6ogging Message 6eve!
:.2.2.$. Configuring 6ogging Output
:.2.3. 4iewing the *erver Message 6og
:.2.3.1. *earching for Te#t in the Message 6og
:.2.3.2. Cop'ing Te#t fro the Message 6og
:.3. C!ient 6ogging
:.8. -sing the ,udit 6og
:.8.1. -nderstanding ,udit 6og .vents
:.8.1.1. O"<ect .vents
:.8.1.2. *'ste7wide .vents
:.8.1.$. ,udit 6og Messages for (iension *orting .vents
:.8.2. Configuring ,udit 6ogging
:.8.$. -pdating the ,udit 6og with the 6atest .vents
:.8.2. -sing the ,udit 6og Window to 4iew 6og Messages
:.8.2.1. Opening the ,udit 6og Window
:.8.2.2. Creating and 0unning ?ueries
:.8.2.$. 4iewing 0esu!ts
:.8.2.2. 4iewing .vent (etai!s
:.8.2.3. Cop'ing (ata to the Windows C!ip"oard
:.8.2.8. -sing the +ind +eature
:.8.2.9. .#porting 0esu!ts
:.9. Monitoring *erver &erforance -sing Contro! Cu"es
:.9.1. .na"!ing &erforance Monitoring
:.9.2. (isa"!ing &erforance Monitoring
3 of 425 26-09-2014 11:18
:.9.$. 4iewing &erforance *tatistics for C!ients@ Cu"es@ and *ervers
:.:. -sing the TM1 Top -ti!it'
:.:.1. (isp!a'ing user naes in TM1 Top
:.:.2. Configuring the T1top.ini +i!e
:.:.$. 0unning TM1 Top
:.:.$.1. 0unning TM1 Top with Coand7!ine Options
:.:.2. 4iewing and -nderstanding the TM1 Top (isp!a'
:.:.2.1. Nora! disp!a' ode
:.:.2.2. *and"o# disp!a' ode
:.:.2.$. ?ueue disp!a' ode
:.:.2.2. -nderstanding TM1 6oc/ Modes
:.:.2.3. -nderstanding Thread &rocessing *tates
:.:.3. TM1 Top Coands
:.:.8. Cance!ing a Thread's &rocessing
:.:.8.1. -nderstanding the Cance! &rocess
:.:.8.2. -nderstanding the 4erif' &rocess
:.:.8.$. -sing the 4erif' and Cance! Coands
:.;. -sing &erforance Counters
:.;.1. Iportant Note a"out 0unning &erforance Counter Too!s
:.;.2. ,vai!a"!e &erforance Counters
:.;.$. 4iewing &erforance Counters with the TM1 &erfMon -ti!it'
:.;.$.1. 0unning TM1&erfMon
:.;.$.2. 4iewing the TM1 &erfMon (isp!a' Output
:.;.$.$. .#iting TM1 &erfMon
:.;.2. 4iewing &erforance Counters with the Microsoft Windows &erforance Monitor
:.;.2.1. Opening the Microsoft Windows &erforance Monitor
:.;.2.2. ,dding and 4iewing &erforance Counters in the Microsoft Windows &erforance
Monitor
:.10. Capturing Core (ups for TM1 *erver Crash ,na!'sis
:.11. (e"ugging Too!s for Windows
:.11.1. Insta!!ing and 0unning ,(&!us
:.11.1.1. 0unning ,(&!us (irect!' on the *erver
:.11.1.1.1. Monitoring the *erver
:.11.1.1.2. -sing CT067C to +orce a *erver Crash
:.11.1.1.$. Ta/ing a *napshot of Current *erver *tate
:.11.1.2. 0unning ,(&!us 0eote!' fro a C!ient
:.11.1.2.1. Insta!!ing and 0unning ,(&!us on the *erver
:.11.1.2.2. 0unning ,(&!us fro a C!ient
:.11.1.2.$. *topping ,(&!us
:.11.2. 0unning (r. Watson
:.11.2.1. *etting (r. Watson as the (efau!t (e"ugging Too!
:.11.$. Co!!ecting +i!es for ,na!'sis +o!!owing a *erver Crash
:.11.2. Transitting +i!es to Cognos
:.11.2.1. -p!oading fro a Coand &ropt
:.11.2.2. -p!oading fro a We" )rowser
:.11.2.$. -p!oading to Aour +T& *erver
;. Cognos TM1 Too!s and -ti!ities
;.1. t1#fer
;.1.1. t1#fer s'nta#
;.1.2. Copressing directories with t1#fer
;.1.$. (ecopressing directories with t1#fer
;.1.2. Notes on t1#fer
;.1.3. .rror essages for t1#fer
;.1.8. t1#fer usage notes
;.2. od"c%test too!
4 of 425 26-09-2014 11:18
10. -sing the Cognos TM1 Operations Conso!e
10.1. (isp!a' user naes
10.2. Create an Operation Group for onitoring
10.$. ,dd an ,din1ost and Cognos TM1 server nae to the Cognos TM1 Operations Conso!e
10.2. *et the !og fi!e and server nueric paraeters
10.3. (own!oad or up!oad the configuration fi!e
10.8. ('naic reporting using the Monitor option
10.9. 1ea!th chec/ indicator
10.:. 1ea!th status ta"
10.;. Monitor server eor' and perforance data
10.10. *et a fi!ter
10.11. *chedu!e the !og fi!e
10.12. (own!oad the !og fi!e
10.1$. 4iew the !og fi!e
11. ,dinistering I)M Cognos TM1 We"
11.1. I)M Cognos TM1 We" Overview
11.2. ,dinistering the TM1 *erver fro I)M Cognos TM1 We"
11.2.1. ,dinistering &rocesses
11.2.2. ,dinistering Chores
11.2.$. *etting C!ient &roperties
11.2.2. *etting Cu"e &roperties
11.2.3. *etting (iension &roperties
11.$. Changing Aour &assword
11.2. Configuring a Custo 1oepage for I)M Cognos TM1 We"
11.2.1. Configuring (ifferent 1oepages for Individua! -sers
11.2.2. Configuring a G!o"a! 1oepage for ,!! -sers
11.2.2.1. -sing the 1oe&ageO"<ect &araeter
11.2.2.2. *etting a G!o"a! I)M Cognos TM1 We" 1oepage to a Cu"e 4iew
11.2.2.$. *etting a G!o"a! I)M Cognos TM1 We" 1oepage to a We"sheet
11.2.2.$.1. Opening a We"sheet that references an .#ce! fi!e outside of TM1
11.2.2.$.2. Opening a We"sheet o"<ect that was up!oaded to the TM1 server
11.2.2.2. *etting a G!o"a! I)M Cognos TM1 We" 1oepage to a -06
11.3. Modif'ing I)M Cognos TM1 We" Configuration &araeters
11.3.1. .diting the We".Config +i!e
11.3.2. Configuring TM1 Wor/f!ow &araeters
11.3.$. (isp!a'ing the Custo Too!"ar
11.3.2. (isp!a'ing the Content of the Custo Too!"ar
11.3.3. Changing the 1eight of the Custo Too!"ar
11.3.8. (isp!a'ing or 1iding the 4iews Node in the Navigation &ane
11.3.9. (isp!a'ing or 1iding ,dinistration options in the Navigation &ane
11.3.:. Changing the I)M Cognos TM1 We" *ession Tieout
11.3.:.1. -ne#pected tieouts
11.3.:.2. ,d<usting the tieout paraeter
11.3.:.$. Changing the (efau!t *etting in Microsoft II* 4ersion 8 we"server of Microsoft
Windows *erver 200$
11.3.;. Changing the Cu"e 4iewer &age *i=e
11.3.10. *etting the Ma#iu Nu"er of *heets to .#port fro a Cu"e 4iewer
11.3.11. ,d<usting the 1ttp0untie .#ecutionTieout &araeter
11.3.12. *etting the TM1.#ce!*ervice&ortNu"er &araeter
11.3.1$. Configuring the Cognos TM1 We" 6ogin &age using ,din1ostNae and TM1*erverNae
paraeters
11.3.12. Configuring I)M Cognos TM1 We" *tartup and ,ppearance *ettings
11.3.12.1. NavTree1idden &araeter
11.3.12.2. NavTreeCo!!apsedOn*tart &araeter
11.3.12.$. 1ideTa")ar &araeter
5 of 425 26-09-2014 11:18
11.3.12.2. 1ideWe"sheetToo!)ar &araeter
11.3.12.3. 1ideCu"eviewerToo!)ar &araeter
11.3.13. -sing the Custo6in/ &araeter to Open Other -06s and We" &ages
11.3.18. Configuring the I)M Cognos TM1 We" 4irtua! Cache (irector'
11.3.19. Contro!!ing Chart *ca!ing and Increents with the *art,#is.na"!ed &araeter
11.3.1:. .na"!ing the We"sheet &aging Too!"ar
11.3.1;. -sing the TM1 We" &age0esetMode paraeter
11.3.20. ,!!owing pasting in va!idated ce!!s
11.3.21. Wrapping string va!ues in cu"e views
11.8. &erforing We" +o!der Maintenance
11.9. -sing I)M Cognos TM1 We" 6ogging
11.9.1. Message *everit' 6eve!s for I)M Cognos TM1 We" 6ogging
11.9.2. I)M Cognos TM1 We" 6og
11.9.2.1. Configuring and .na"!ing I)M Cognos TM1 We" 6ogging
11.9.2.2. 4iewing the I)M Cognos TM1 We" 6og +i!e
11.9.$. TM1 .#ce! *ervices 6og
11.9.$.1. Configuring TM1 .#ce! *ervices 6ogging
11.9.$.2. .na"!ing TM1 .#ce! *ervices 6ogging
11.9.$.$. 4iewing the TM1 .#ce! *ervices 6og +i!e
12. -nderstanding Cu"e (ependenc'
12.1. Changes in (ependenc' Mapping
12.2. C!earing Cu"e (ependencies
12.$. Creating Cu"e (ependencies
12.2. -sing ,ddCu"e(ependenc' to .sta"!ish (ependencies
12.2.1. (e"ugging and Identif'ing Cu"e (ependencies
1$. 0ep!icating Cu"es
1$.1. 0ep!ication Overview
1$.1.1. 0e!ationships Created "' 0ep!ication
1$.1.2. 0eBuired ,ccess &rivi!eges
1$.1.$. ,din *erver Considerations
1$.1.$.1. *etting up 0ep!ication
1$.1.2. Configuring the T1s.cfg +i!e to *upport 0ep!ication
1$.2. Maintaining 0ep!ication Connections
1$.2.1. Creating a 0ep!ication Connection
1$.2.2. Modif'ing a 0ep!ication Connection
1$.2.$. (e!eting a 0ep!ication Connection
1$.$. 0ep!ication &rocess
1$.$.1. 0ep!icating a Cu"e
1$.$.2. *pecif'ing Inforation a"out the 0ep!icated Cu"e
1$.$.2.1. *pecif'ing Cu"e Inforation
1$.$.2.2. *pecif'ing (iension Inforation
1$.$.2.$. *pecif'ing 0u!e Inforation
1$.$.2.2. *pecif'ing 4iew Inforation
1$.$.2.3. *pecif'ing *u"set Inforation
1$.$.$. What 1appens when TM1 0ep!icates a Cu"e
1$.2. *'nchroni=ation &rocess
1$.2.1. *'nchroni=ing on (eand
1$.2.2. *chedu!ing *'nchroni=ation
1$.2.$. *'nchroni=ing over -nsta"!e or Wide ,rea Networ/ Connections
12. ,ccessi"i!it' features
12.1. Ce'"oard shortcuts
12.2. I)M and accessi"i!it'
13. Contro! Cu"es
13.1. *ecurit' Contro! Cu"es
13.1.1. DCe!!*ecurit'%Cu"eNae
6 of 425 26-09-2014 11:18
13.1.2. DChore*ecurit'
13.1.$. DC!ient*ecurit'
13.1.2. DCu"e*ecurit'
13.1.3. D(iension*ecurit'
13.1.8. D.!eent*ecurit'%(iensionNae
13.1.9. D&rocess*ecurit'
13.2. C!ient and Group ,dinistration Contro! Cu"es
13.2.1. DC!ientsGroups
13.2.2. DC!ient&roperties
13.$. O"<ect ,ttri"ute and &ropert' Contro! Cu"es
13.$.1. DConnection&roperties
13.$.2. DCu"e&roperties
13.$.$. D(iension&roperties
13.$.2. D(iension,ttri"utes
13.$.3. D.!eent,ttri"utes%(iensionNae
13.$.8. D1ierarch'&roperties
13.2. &erforance Monitoring Contro! Cu"es
13.2.1. D*tats)'C!ient
13.2.2. D*tats)'Cu"e
13.2.$. D*tats)'Cu"e)'C!ient
13.2.2. D*tats+or*erver
13.3. Other Contro! Cu"es
13.3.1. D1o!d%-serNae%Cu"eNae
18. Contro! (iensions
18.1. DChores
18.2. DC!ient&roperties
18.$. DC!ients
18.2. DConnection&roperties
18.3. DConnections
18.8. DCu"e+unctions
18.9. DCu"e&roperties
18.:. DCu"es
18.;. D(iension,ttri"utes
18.10. D(iension&roperties
18.11. D(iensions
18.12. D.!eent,ttri"utes%(iensionNae
18.1$. DGroups
18.12. D1ierarchies
18.13. D1ierarch'&roperties
18.18. D1o!d
18.19. D&erfC!ients
18.1:. D&erfCu"es
18.1;. D&rocesses
18.20. D*tats*tats)'C!ient
18.21. D*tats*tats)'Cu"e
18.22. D*tats*tats)'Cu"e)'C!ient
18.2$. D*tats*tats+or*erver
18.22. DTieInterva!s
19. .#ce! .vents 1and!ed "' TM1
1:. Notices
1:.1. E
7 of 425 26-09-2014 11:18
1. Introduction
This docuent is intended for use with I)MF CognosF TM1F .
This docuent descri"es TM1 architecture@ server operations@ authentication@ and coponent securit'.
TM1 integrates "usiness p!anning@ perforance easureent and operationa! data to ena"!e copanies
to optii=e "usiness effectiveness and custoer interaction regard!ess of geograph' or structure. TM1
provides iediate visi"i!it' into data@ accounta"i!it' within a co!!a"orative process and a consistent view
of inforation@ a!!owing anagers to Buic/!' sta"i!i=e operationa! f!uctuations and ta/e advantage of new
opportunities.
Finding information
To find I)M Cognos product docuentation on the we"@ inc!uding a!! trans!ated docuentation@ access
one of the I)M Cognos Inforation Centers Ghttp>HHpu"!i"."ou!der.i".coHinfocenterHcogicHv1r00
Hinde#.<spI. 0e!ease Notes are pu"!ished direct!' to Inforation Centers@ and inc!ude !in/s to the !atest
technotes and ,&,0s.
Samples disclaimer
The Great Outdoors Copan'@ GO *a!es@ an' variation of the Great Outdoors nae@ and &!anning *ap!e
depict fictitious "usiness operations with sap!e data used to deve!op sap!e app!ications for I)M and
I)M custoers. These fictitious records inc!ude sap!e data for sa!es transactions@ product distri"ution@
finance@ and huan resources. ,n' rese"!ance to actua! naes@ addresses@ contact nu"ers@ or
transaction va!ues is coincidenta!. Other sap!e fi!es a' contain fictiona! data anua!!' or achine
generated@ factua! data copi!ed fro acadeic or pu"!ic sources@ or data used with perission of the
cop'right ho!der@ for use as sap!e data to deve!op sap!e app!ications. &roduct naes referenced a'
"e the tradear/s of their respective owners. -nauthori=ed dup!ication is prohi"ited.
Accessibility features
This product does not current!' support accessi"i!it' features that he!p users with a ph'sica! disa"i!it'
such as restricted o"i!it' or !iited vision@ to use this product. The TM1 Operations Conso!e is
accessi"!e. *ee the ,ccessi"i!it' topic for ore inforation.
Forard!loo"ing statements
This docuentation descri"es the current functiona!it' of the product. 0eferences to ites that are not
current!' avai!a"!e a' "e inc!uded. No ip!ication of an' future avai!a"i!it' shou!d "e inferred. ,n' such
references are not a coitent@ proise@ or !ega! o"!igation to de!iver an' ateria!@ code@ or
functiona!it'. The deve!opent@ re!ease@ and tiing of features or functiona!it' reain at the so!e
discretion of I)M.
8 of 425 26-09-2014 11:18
#. $%at&s ne
This section contains a !ist of new@ changed@ and reoved features for this re!ease.
It wi!! he!p 'ou p!an 'our upgrade and app!ication dep!o'ent strategies and the training reBuireents
for 'our users.
To !ocate the ost current product docuentation@ go to the I)MF CognosF TM1F inforation center
Ghttp>HHpu"!i"."ou!der.i".coHinfocenterHct1Hv10r10Hinde#.<spI
'e features in Cognos TM1 Operations Guide (ersion 10.1.1
6isted "e!ow are new features in I)M Cognos TM1 Operation Guide since the !ast re!ease.
'e features in (ersion 10.1.0
6isted "e!ow are new features in I)M Cognos TM1 since the !ast re!ease.
C%anged features in (ersion 10.1.0
6isted "e!ow are changes to features in I)M Cognos TM1 since the !ast re!ease.
9 of 425 26-09-2014 11:18
#.1. 'e features in Cognos TM1 Operations Guide (ersion 10.1.1
6isted "e!ow are new features in I)MF CognosF TM1F Operation Guide since the !ast re!ease.
'e monitoring options a(ailable in t%e Cognos TM1 10.1.1 Operations Console
In this version of the software@ 'ou can onitor soe additiona! ites in the I)M Cognos TM1
Operations Conso!e.
)arent topic* What's new
10 of 425 26-09-2014 11:18
#.1.1. 'e monitoring options a(ailable in t%e Cognos TM1 10.1.1
Operations Console
In this version of the software@ 'ou can onitor soe additiona! ites in the I)M Cognos TM1 Operations
Conso!e.
Monitor Cognos TM1 ser(er memory and performance information
CognosF TM1F s'ste eor' and perforance statistics are now avai!a"!e through the Cognos TM1
Operations Conso!e.
*ee Monitor server eor' and perforance data.
Instant ser(er %ealt% c%ec" across all monitored ser(ers
The Cognos TM1 Operations Conso!e 1ea!th *tatus ta" shows the current status of a!! Cognos TM1
servers in the tree using the 1ea!th Chec/ icons.
*ee 1ea!th status ta".
Filtering log messages
,dinistrators can now fi!ter the t'pes of essages inc!uded in the Cognos TM1 Operations Conso!e !ogs
to e!iinate repetitive or unwanted essages and contro! the !og fi!e si=e.
*ee *et a fi!ter.
)arent topic* New features in Cognos TM1 Operations Guide version 10.1.1
11 of 425 26-09-2014 11:18
#.#. 'e features in (ersion 10.1.0
6isted "e!ow are new features in I)MF CognosF TM1F since the !ast re!ease.
Cognos TM1 Operations Console
The I)M Cognos TM1 Operations Conso!e is a new wa' for adinistrators to onitor and ta/e action
on Cognos TM1 server activit'.
tm1+fer
The t1#fer uti!it' copresses and oves I)M Cognos TM1 server o"<ects fro one p!atfor to
another p!atfor whi!e preserving i#ed case naes for o"<ects on "oth Microsoft Windows and -NI5
p!atfors.
odbc,test tool
The odbc_test too! is used to diagnose and test an I)M Cognos TM1 O()C connection on -NI5.
12 of 425 26-09-2014 11:18
#.#.1. Cognos TM1 Operations Console
The I)MF CognosF TM1F Operations Conso!e is a new wa' for adinistrators to onitor and ta/e
action on Cognos TM1 server activit'.
The Cognos TM1 Operations Conso!e provides a visua! and effective wa' to understand how Cognos TM1
servers and user !oads are wor/ing. *ervers can "e identified and various aspects of the onitoring can
"e anaged using the Cognos TM1 Operations Conso!e. The conso!e is a we"7"ased c!ient that is
dep!o'ed and targeted to specific Cognos TM1 servers to generate !ogs and provide a graphica! disp!a' to
he!p anage server !oads.
*ee the IBM Cognos TM1 Operations Console Guide.
)arent topic* New features in version 10.1.0
13 of 425 26-09-2014 11:18
#.#.#. tm1+fer
The t1#fer uti!it' copresses and oves I)MF CognosF TM1F server o"<ects fro one p!atfor to
another p!atfor whi!e preserving i#ed case naes for o"<ects on "oth Microsoft Windows and -NI5
p!atfors.
*ee the t1#fer.
14 of 425 26-09-2014 11:18
#.#.-. odbc,test tool
The odbc_test too! is used to diagnose and test an I)MF CognosF TM1F O()C connection on -NI5.
*ee the od"c%test too!..
15 of 425 26-09-2014 11:18
#.-. C%anged features in (ersion 10.1.0
6isted "e!ow are changes to features in I)MF CognosF TM1F since the !ast re!ease.
)arallel Interaction concurrency set by default
The &ara!!e! Interaction feature introduced in the previous re!ease is now on "' defau!t.
.ocumentation c%anges to t%e I/M Cognos TM1 Operation Guide
, nu"er of configuration topics were oved fro this guide to "etter organi=e docuentation for
this re!ease.
16 of 425 26-09-2014 11:18
#.-.1. )arallel Interaction concurrency set by default
The &ara!!e! Interaction feature introduced in the previous re!ease is now on "' defau!t.
Iproveents to concurrenc' processing achieved used the &ara!!e! Interaction feature are now
autoatica!!' avai!a"!e to a!! users "' defau!t. &revious!' a configuration paraeter needed to "e set to
use this feature.
*ee the -sing &ara!!e! Interaction with a Cognos TM1 server.
)arent topic* Changed features in version 10.1.0
17 of 425 26-09-2014 11:18
#.-.#. .ocumentation c%anges to t%e I/M Cognos TM1 Operation Guide
, nu"er of configuration topics were oved fro this guide to "etter organi=e docuentation for this
re!ease.
The fo!!owing topics were oved fro the IBM Cognos TM1 Operation Guide to the IBM Cognos TM1
Installation and Configuration Guide>
CognosF TM1F s'ste architecture
T1s.cfg server configuration fi!e and paraeters
T1p.ini c!ient configuration fi!e and paraeters
Cognos TM1 authentication !ogon and **6 securit' configuration
*ee the IBM Cognos TM1 Installation and Configuration Guide.
)arent topic* Changed features in version 10.1.0
18 of 425 26-09-2014 11:18
-. TM1 System and Feature Configuration
This section descri"es how to configure the I)MF CognosF TM1F server and c!ients.
TM1 System and Feature Configuration O(er(ie
-se the fo!!owing coponents and features to configure the I)M Cognos TM1 server and c!ients.
Capability Assignments
,dinistrators can set certain capa"i!ities "' usergroup using the Capa"i!it' ,ssignent enu found
in the *erver .#p!orer@ *erver Menu.
0sing )ersistent Feeders
To iprove re!oad tie of cu"es with feeders@ set the &ersistent+eeders configuration paraeter to
true GTI to store the ca!cu!ated feeders to a .feeders fi!e.
Configuring and Managing Sandbo+es in your TM1 1n(ironment
,s the TM1 adinistrator@ 'ou shou!d understand soe technica! ites when using *and"o#es and
&ersona! Wor/spaces in 'our TM1 environent.
0sing )arallel Interaction it% a Cognos TM1 ser(er
&ara!!e! Interaction is an I)M Cognos TM1 server7re!ated feature that a!!ows for greater concurrenc'
of read and write operations on the sae cu"e o"<ect.
19 of 425 26-09-2014 11:18
-.1. TM1 System and Feature Configuration O(er(ie
-se the fo!!owing coponents and features to configure the I)MF CognosF TM1F server and c!ients.
Configuration .escription
T1s.cfg fi!e , configuration fi!e that specifies environent inforation for the TM1
server.
Aou can edit the T1s.cfg fi!e to ref!ect the environent of the
associated server.
+or detai!s and a cop!ete !isting of a!! the paraeters@ see the IBM
Cognos TM1 Installation and Configuration Guide.
T1p.ini fi!e , configuration fi!e that specifies the environent inforation for the
TM1 c!ients GTM1 &erspectives@ TM1 ,rchitect@ and C!ientI .
+or detai!s and a cop!ete !isting of a!! the paraeters@ see the IBM
Capa"i!it' ,ssignents , set of capa"i!ities that adinistrators can ena"!e or disa"!e "' user
group.
Capa"i!ities a!!ow 'ou to anage options such as &ersona! Wor/space
Write"ac/ Mode@ *and"o#es@ (ata 0eservation@ and access to *erver
.#p!orer.
+or detai!s@ see Capa"i!it' ,ssignents.
&ersistent +eeders , paraeter that can iprove re!oad tie of cu"es with feeders@
especia!!' those with an' cop!e# feeder ca!cu!ations@ "' saving
feeders and then re7!oading the at server startup without
reca!cu!ating those feeders.
+or detai!s@ see -sing &ersistent +eeders.
*and"o#es , feature that a!!ows users to create and wor/ in their own data areas
separate fro "ase data.
,dinistrator tas/s for this feature inc!ude understanding the feature
and its eor' usage@ ena"!ing the necessar' configuration
paraeters and anaging re!ated fi!es and fo!ders.
+or detai!s@ see Configuring and Managing *and"o#es in 'our TM1
.nvironent.
&ara!!e! Interaction , server7re!ated feature that a!!ows for greater concurrenc' of read
and write operations on the sae cu"e o"<ect. &ara!!e! Interaction
he!ps to /eep writers to a cu"e fro "eing "!oc/ed waiting for readers
of the sae cu"e to finish their read operation.
20 of 425 26-09-2014 11:18
Configuration .escription
+or detai!s@ see -sing &ara!!e! Interaction with a Cognos TM1 server.
(ata 0eservation , server7re!ated feature that a!!ows 'ou to configure e#c!usive write7
access to regions of a cu"e for individua! users. Once reserved@ the
data in that region can on!' "e odified "' that specific user unti! the
reservation is re!eased.
,dinistrator tas/s for (0 inc!ude configuring re!ated properties in the
DCu"e&roperties contro! cu"e and the Capa"i!it' ,ssignents window.
To actua!!' app!' and anage (ata 0eservations@ 'ou ust use the
re!ated Tur"oIntegrator and ,&I functions that a!!ow 'ou to
prograatica!!' o"tain@ re!ease and anage reservations.
+or cop!ete detai!s@ see the J-sing (ata 0eservationsJ and J.na"!ing
(ata 0eservationJ sections in the I)M Cognos TM1 Developer Guide.
)arent topic* TM1 *'ste and +eature Configuration
21 of 425 26-09-2014 11:18
-.#. Capability Assignments
,dinistrators can set certain capa"i!ities "' usergroup using the Capa"i!it' ,ssignent enu found in
the *erver .#p!orer@ *erver Menu.
With the *erver .#p!orer open@ se!ect a server to disp!a' the *erver Menu and se!ect Capability
Assignments.
)' defau!t a!! assignents are "!an/. The "!an/ settings have different ip!ications for each capa"i!it'.
Changes ade to these assignents ta/e effect after 'ou !og out of TM1F then !og "ac/ in. )e sure to
save the settings to the server to have changes ta/e effect.
The fo!!owing capa"i!ities can "e set per usergroup>
Access to Ser(er 1+plorer
-se this capa"i!it' to !aunch the *erver .#p!orer "' defau!t for this usergroup. Aou can set this
capa"i!it' to (en' to prevent the *erver .#p!orer fro "eing used "' this usergroup. )' defau!t@ this
capa"i!it' is set to "!an/ or Grant. To "!oc/ access to the server e#p!orer@ c!ic/ the intersection of the
usergroup and the capa"i!it' and se!ect .eny.
)ersonal $or"space $ritebac" Mode
This capa"i!it' defines how data changes are hand!ed in this usergroup.
When this capa"i!it' is granted@ users have the a"i!it' to ho!d data changes in a private wor/space
"efore anua!!' deciding when to coit the changes to the "ase data. -sers can further "e granted
the a"i!it' to nae and anage u!tip!e private scenarios ca!!ed sand"o#es Gsee the *and"o#
Capa"i!it'I.
When &ersona! Wor/space Write"ac/ Mode is granted>
-sers operate in a non7direct write"ac/ situation so the' can private!' ad<ust data va!ues "efore
a/ing the avai!a"!e to the rest of the counit'. The specia! sand"o# used when &ersona!
Wor/space Write"ac/ Mode is granted a/es it eas' to tr' out different data changes without the
cop!e#it' of naed sand"o#es.
(ata that is changed disp!a's in a different co!or to reind the user that this change has not 'et
"een erged to the "ase data. Once the data change in a &ersona! Wor/space is coitted@ the
ce!! co!oring reverts to "!ac/ to identif' it as part of the "ase data.
-sers ust anua!!' coit their data changes to a/e the avai!a"!e to other users. If users
are not used to wor/ing in a sand"o#@ for e#ap!e@ if the' were used to the c!assic direct
write"ac/ ode of ear!ier versions of TM1 @ the' a' find it cha!!enging to ree"er to coit
their changes anua!!' "' pressing the Coit "utton.
Often wor/ing in &ersona! Wor/space ode iproves perforance over wor/ing in direct
write"ac/ since changes to the "ase data occur !ess freBuent!' than when ever' data change
ust "e erged to the "ase.
When this capa"i!it' is set to (en'@ the users do not have a &ersona! Wor/space write"ac/ so the'
wor/ direct!' in the "ase. This is the defau!t "ehavior for this capa"i!it'. The advantage to this
capa"i!it' setting is that data changes happen iediate!'@ "ut an' users want the f!e#i"i!it' to
contro! when to coit their changes and a/e the avai!a"!e to other users.
)' defau!t@ usergroups do not have the &ersona! Wor/space Write"ac/ ode capa"i!it' granted. )'
defau!t this capa"i!it' is "!an/ which acts !i/e a (en'.
To ena"!e a usergroup to use a &ersona! Wor/space@ c!ic/ the intersection of the usergroup and this
capa"i!it' and se!ect Grant.
Note a!so that usergroups a' (en' the &ersona! Wor/space Write"ac/ Mode capa"i!it' "ut sti!! use
22 of 425 26-09-2014 11:18
the *and"o# capa"i!it'. In that case@ users wor/ direct!' in the "ase "ut have the option to save
changes to a naed sand"o#. When the' create a naed sand"o#@ then the Coit and reset (ata
"uttons "ecoe avai!a"!e. If the' ove "ac/ to the )ase@ the' return to direct write"ac/. *ee *etting
Capa"i!ities for the possi"!e option co"inations of &ersona! Wor/space Write"ac/ Mode and *and"o#
capa"i!ities.
If the s'ste7wide a"i!it' to have sand"o#es is turned off using the (isa"!e*and"o#ingKT in the
server configuration fi!e@ the &ersona! Wor/space Write"ac/ Mode and *and"o# capa"i!ities are
ignored. )' defau!t (isa"!e*and"o#ing is not present or is set to +.
Sandbo+
This capa"i!it' ena"!es the usergroup to create naed sand"o#es that can "e used to "ui!d what7if
scenarios. With this capa"i!it' granted@ users can create and nae ore than one set of data changes
which are over!aid on top of the "ase data. -sers can /eep their sand"o#es private and decide when
to coit the data changes to a/e the pu"!ic. *and"o#ing is a powerfu! feature@ "ut soe users
wi!! find the cop!e#it' of anaging u!tip!e scenarios against a coon "ase cha!!enging.
)' defau!t a!! users have this capa"i!it'. The "!an/ setting acts !i/e a Grant.
To prevent this usergroup fro using naed sand"o#es@ set this capa"i!it' to .eny.
If the a"i!it' to have sand"o#es is turned off using the (isa"!e*and"o#ing configuration paraeter in
the server's configuration fi!e@ the &ersona! Wor/space Write"ac/ Mode and *and"o# capa"i!ities are
ignored. )' defau!t this paraeter is not present or is set to +. (isa"!e*and"o#ing is descri"ed in the
IBM Cognos TM1 Installation and Configuration Guide.
.ata 2eser(ation capabilities
(ata 0eservation G(0I is a server7re!ated feature that a!!ows 'ou to configure e#c!usive write7access
to regions of a cu"e for individua! users. Once reserved@ the data in that region can on!' "e odified
"' that specific user unti! the reservation is re!eased.
(0 uses the Manage.ata2eser(ation and .ata2eser(ationO(erride capa"i!ities to a!!ow
e"ers of a user group to acBuire@ re!ease@ and override (0s for these!ves and other users.
+or detai!s@ see the J-sing (ata 0eservationsJ and J.na"!ing user groups to anage (ata
0eservationsJ sections in the I)MF CognosF TM1 Developer Guide.
Cognos TM1 Application $eb Capabilities
The Write"ac/ Mode and *and"o# capa"i!ities are ignored "' Cognos TM1 ,pp!ication We".
Setting Capabilities
Aou deterine the write"ac/ ode using a co"ination of Grant or (en' settings to the &ersona!
Wor/space Write"ac/ Mode and the *and"o# Capa"i!ities.
0nderstanding t%e 1ffect of /lan"s in t%e Capability Assignments
)' defau!t a!! Capa"i!it' ,ssignents are set to "!an/@ which eans either (en' or Grant depending
on the defau!t setting of each Capa"i!it'.
23 of 425 26-09-2014 11:18
-.#.1. Cognos TM1 Application $eb Capabilities
The Write"ac/ Mode and *and"o# capa"i!ities are ignored "' CognosF TM1F ,pp!ication We".
In Cognos TM1 ,pp!ication We"@ the capa"i!ities are set "' app!ication. ,!! users associated with a
particu!ar app!ication@ wor/ in the wa' set for that app!ication.
If 'ou are wor/ing with u!tip!e sand"o#es@ 'ou ust su"it fro Cognos TM1 ,pp!ication We"@ 'ou
cannot su"it fro the Wor/f!ow page.
)arent topic* Capa"i!it' ,ssignents
24 of 425 26-09-2014 11:18
-.#.#. Setting Capabilities
Aou deterine the write"ac/ ode using a co"ination of Grant or (en' settings to the &ersona!
Wor/space Write"ac/ Mode and the *and"o# Capa"i!ities.
To let t%e usergroup )ersonal
$or"space
$ritebac" Mode
Sandbo+
Wor/ direct!' in the "ase with the a"i!it' to create u!tip!e sand"o#es.
This is the defau!t case.
(en' Grant
Wor/ in a sing!e@ private wor/ area without naed sand"o#es. Grant (en'
Wor/ with "oth a Jdefau!tJ private wor/ area and naed sand"o#es. Grant Grant
Wor/ in (irect write"ac/ with no sand"o#. This is the c!assic TM1F
ode. This setting is sii!ar to the addition of (isa"!e*and"o#ingKT to
the configuration fi!e which prevents the use of sand"o#es and puts a!!
users into direct write"ac/.
(en' (en'
25 of 425 26-09-2014 11:18
-.#.-. 0nderstanding t%e 1ffect of /lan"s in t%e Capability
Assignments
)' defau!t a!! Capa"i!it' ,ssignents are set to "!an/@ which eans either (en' or Grant depending on
the defau!t setting of each Capa"i!it'.
+or e#ap!e@ )!an/ in the &ersona! Wor/space Write"ac/ Mode Capa"i!it' eans (en'. )!an/ in the
*and"o# Capa"i!it' eans Grant.
When a user is a e"er of ore than one group@ the "!an/ setting a!!ows conf!icts that ight occur to
"e reso!ved "ased on an' e#p!icit!' set assignent.
When a user is a e"er of ore than one usergroup@ an' e#p!icit!' set Grant or (en' overrides a "!an/.
In the case of conf!icting e#p!icit!' set assignents@ a (en' capa"i!it' overrides a Grant.
*ee the J-sing &ersona! Wor/spaces and *and"o#esJ in the I)MF CognosF TM1F User Guide for ore
inforation a"out the ip!ications of &ersona! Wor/spaces and *and"o#ing on users.
0nderstanding 2ecalc and Commit in a )ersonal $or"space
The fo!!owing ta"!e shows the different effects of Coit and 0eca!c in a &ersona! Wor/space with
and without Bueuing.
26 of 425 26-09-2014 11:18
-.#.-.1. 0nderstanding 2ecalc and Commit in a )ersonal $or"space
The fo!!owing ta"!e shows the different effects of Coit and 0eca!c in a &ersona! Wor/space with and
without Bueuing.
$ritebac" Action Sends .ata
(irect
0ead77L
0eca!c
Write77L
0eca!c
+ro the )ase TM1F Mode!.
To the )ase TM1 Mode!.
&ersona! Wor/space
0ead77L
0eca!c
Write77L
0eca!c
+ro the )ase TM1 Mode!.
To the Personal Workspace.
&ersona! Wor/space
Coit *ends the Personal Workspace data to the TM1 )ase Mode!.
&ersona! Wor/space
with ?ueuing
Coit *ends the &ersona! Wor/space to the Queue
When a!! resources are avai!a"!e@ the &ersona! Wor/space data is
processed and sent to the )ase TM1 Mode!.
)arent topic* -nderstanding the .ffect of )!an/s in the Capa"i!it' ,ssignents
27 of 425 26-09-2014 11:18
-.-. 0sing )ersistent Feeders
To iprove re!oad tie of cu"es with feeders@ set the &ersistent+eeders configuration paraeter to true
GTI to store the ca!cu!ated feeders to a .feeders fi!e.
,n' insta!!ation with server !oad ties of over 3 inutes can pro"a"!' iprove their perforance using
this paraeter.
+or ore detai!s a"out the associated paraeter for this feature ca!!ed Cu"e*ave(ata@ see the IBM
When this paraeter is set to T and the server encounters a persistent feeder fi!e@ it !oads the saved
feeders which reduces the tie nora!!' ta/en to reca!cu!ate those feeders. +eeders are saved when the
data is saved or ru!es are edited. Aou do not e#p!icit!' save the feeders
+or insta!!ations with an' cop!e# feeder ca!cu!ations persisting feeders and then re7!oading the at
server startup wi!! iprove perforance. +or sip!e feeders@ the tie ta/en to read feeders fro dis/
a' e#ceed the tie to re7ca!cu!ate the feeders "ut ost insta!!ations wi!! "enefit.
-sing the &ersistent +eeders feature wi!! increase 'our s'ste si=e on dis/ on!'. Meor' si=e is not
affected "' the use of this paraeter.
Sa(ing data it% persistent feeders
When &ersistent+eedersKT@ and a cu"e that uses ru!es is saved@ the feeders are stored a!ong side the
cu"e data in a .feeders fi!e.
Modifying rules for cubes it% feeders
When ru!es for a cu"e are odified the feeders for the ru!es associated with that cu"e are re7run to
pic/ up an' changes in the feeder stateents in the ru!es fi!e.
3andling corrupted or in(alidated feeder files
If a corrupted or inva!id feeder fi!e is detected@ a!! the saved feeders wi!! "e de!eted and the server
wi!! e#it with appropriate essages in the !og fi!e.
28 of 425 26-09-2014 11:18
-.-.1. Sa(ing data it% persistent feeders
When &ersistent+eedersKT@ and a cu"e that uses ru!es is saved@ the feeders are stored a!ong side the
cu"e data in a .feeders fi!e.
The cu"e fi!es are ca!!ed cue!na"e.cu" and cue!na"e.feeders.
When a cu"e is !oaded@ if a .feeders fi!e e#ists@ it is read to re7!oad the feeders and nora! feeder
eva!uation is s/ipped. If the feeders fi!e does not e#ist nora! feeder ca!cu!ation occurs and the .feeders
fi!e is written after a!! the feeders have "een ca!cu!ated. This wi!! "e the "ehavior the first tie the TM1F
server is "rought up on a data director' with the PersistentFeeders=T. ,s part of the server startup the
.feeders fi!es for a!! the re!evant cu"es wi!! "e written. , new persistent feeders fi!es is written for an'
cu"e for which the persistent feeders fi!e is not found at server startup. This eans that the .feeders fi!es
a' "e de!eted fro the data director' to force a cop!ete re7ca!cu!ation of feeders when the server ne#t
starts. In a TI process@ use the (e!ete,!!&ersistent+eedersGI TI function to de!ete a!! persistent feeders.
The odified tie of the .feeders fi!e is copared to that of the "ase cu"e fi!e at !oad tie. If the cu"e
fi!e is newer than the feeders fi!e@ the .feeders fi!e is regarded as inva!id and is de!eted. The .feeders fi!e
is a!wa's written after the cu"e fi!e so it shou!d a!wa's "e newer than the cu"e fi!e.
)arent topic* -sing &ersistent +eeders
29 of 425 26-09-2014 11:18
-.-.#. Modifying rules for cubes it% feeders
When ru!es for a cu"e are odified the feeders for the ru!es associated with that cu"e are re7run to pic/
up an' changes in the feeder stateents in the ru!es fi!e.
The TM1F server never de!etes feeders these!ves in eor' so this reca!cu!ation wi!! on!' add new
feeders@ it wi!! not de!ete feeders which a' no !onger "e va!id due to the ru!e fi!e edits.
,fter the feeders are reca!cu!ated@ the persistent feeder fi!es for the cu"e whose ru!e was edited@ and a!!
dependent cu"es Gdue to ()GMI stateents in the ru!esI are rewritten. )ecause feeders in eor' are
never de!eted@ this eans that ru!e fi!e edits a' !eave soe feeders set which are no !onger va!id Gno
ru!es actua!!' app!'I. These unused feeders wi!! "e saved with the persistent feeders. )ecause of the
possi"i!it' of unused feeders@ the adinistrator a' want to periodica!!' Gduring soe tie when there is
!itt!e deand on the serverI re7ca!cu!ate a!! the feeders. This is done "' ca!!ing the
(e!ete,!!&ersistent+eedersGI Tur"oIntegrator function@ shutting down the server@ and then "ringing the
server "ac/ up. When the server is "rought "ac/ up@ "ecause there is no persistent feeder inforation@ a!!
the feeders wi!! "e re7ca!cu!ated and new persistent feeder inforation wi!! "e written to dis/. *ee the
Tur"oIntegrator +unctions chapter of the 0eference Guide for ore inforation.
30 of 425 26-09-2014 11:18
-.-.-. 3andling corrupted or in(alidated feeder files
If a corrupted or inva!id feeder fi!e is detected@ a!! the saved feeders wi!! "e de!eted and the server wi!!
e#it with appropriate essages in the !og fi!e.
In that case@ 'ou ust restart the server to re!oad and re7copute a!! of the feeders. The essages in
the !og wi!! "e of the for>
#$%%& '((O( #&1&!&)!1* 1+,1&,#%-*)) Cognos. -/erver 0ll persistent feeder files 1ill e deleted and
server 1ill s2ut do1n
#$%%& '((O( #&1&!&)!1* 1+,1&,#%-*)) TM1. -/erver (estart server to re!load dataase-
+eeder fi!es are deeed Jinva!idJ if there is a forat error in the fi!e@ or if the date7tie of the feeder fi!e
is o!der than the corresponding cu"e G.C-)I fi!e which a' happen if one tries to anua!!' cop' feeder or
cu"e fi!es fro one data director' to another. When a feeder fi!e is deeed to "e inva!id@ a essage is
written to the s'ste !og fi!e e#p!aining the e#act reason that the feeder fi!e is deeed to "e inva!id. The
essage has the for>
'((O( #&1&!&)!1* 1+,&&,##-+3$ TM1 -/erver Invalid feeder file detected for cue 455554 reason, ---
This essage wi!! t'pica!!' Gin the case of a u!ti7threaded !oad or an error with an cu"e which !oads
ear!' in the startup processI not "e near the end of the fi!e@ "ut rather wi!! "e in the idd!e of the !oad
seBuence. *earching the essage !og for J.00O0J wi!! show the error.
31 of 425 26-09-2014 11:18
-.4. Configuring and Managing Sandbo+es in your TM1 1n(ironment
,s the TM1F adinistrator@ 'ou shou!d understand soe technica! ites when using *and"o#es and
&ersona! Wor/spaces in 'our TM1 environent.
Meor' usage for *and"o#es and &ersona! Wor/spaces
Managing the fi!es and fo!ders that support *and"o#es and &ersona! Wor/spaces
TM1 server configuration paraeters for *and"o#es and &ersona! Wor/spaces
The sand"o# feature !ets 'ou create 'our own &ersona! Wor/spaces or *and"o#es separate fro 'our
"ase data. , sand"o# is not a cop' of the "ase data@ "ut is a separate over!a' or !a'er of 'our own data
va!ues that 'ou have entered on top of the "ase data.
The new data va!ues that 'ou enter in a *and"o# or &ersona! Wor/space are not saved to the "ase data
unti! 'ou e#p!icit!' coit the changed data in the sand"o# to the "ase data. This "ehavior is different
than wor/ing direct!' in "ase data where an' new data va!ues that 'ou enter are written direct!' "ac/ to
the TM1 server.
+or ore detai!s on using the *and"o# or &ersona! Wor/space feature@ see the inforation on *and"o#s
and &ersona! Wor/spaces in the I)MF CognosF TM1 User Guide and the I)M Cognos TM1
TuroIntegrator Guide.
Memory 0sage Considerations for Sandbo+es and )ersonal $or"spaces
If 'ou are using the sand"o# feature@ 'ou shou!d "e aware that sand"o#es reBuire usage of soe
additiona! aount of 0,M eor' and hard dis/ space. .rror essages disp!a' when users approach
their sand"o# eor' !iit.
Managing Files and Folders for Sandbo+es
.ach TM1 server stores the support fi!es for sand"o#es in the su"7fo!ders of the TM1 server data
director'.
TM1 Ser(er Configuration )arameters for Sandbo+es
The TM1 server configuration fi!e@ T1s.cfg@ uses paraeters for ena"!ing and anaging the sand"o#
feature.
0nderstanding Sandbo+ .ifferences Among .ifferent TM1 Clients
The sand"o# feature wor/s s!ight!' different!' in Cognos TM1 ,pp!ication We" copared to the !egac'
c!ients of TM1 &erspectives @ *erver .#p!orer@ and TM1 We".
32 of 425 26-09-2014 11:18
-.4.1. Memory 0sage Considerations for Sandbo+es and )ersonal
$or"spaces
If 'ou are using the sand"o# feature@ 'ou shou!d "e aware that sand"o#es reBuire usage of soe
additiona! aount of 0,M eor' and hard dis/ space. .rror essages disp!a' when users approach
their sand"o# eor' !iit.
Aou can contro! the aount of eor' used for sand"o#es per user "' ad<usting the
MaximumUserSandboxSize paraeter in the TM1F server configuration fi!e@ T1s.cfg. +or ore detai!s@
see the !ist of paraeters in the IBM Cognos TM1 Installation and Configuration Guide.
)arent topic* Configuring and Managing *and"o#es in 'our TM1 .nvironent
33 of 425 26-09-2014 11:18
-.4.#. Managing Files and Folders for Sandbo+es
.ach TM1F server stores the support fi!es for sand"o#es in the su"7fo!ders of the TM1 server data
director'.
If 'ou are "ac/ing up this data@ 'ou a' want to consider these fi!es and the ip!ications of "ac/ing up
and restoring sand"o# fi!es.
,dinistrators can de!ete sand"o#es using a variet' of criteria.
*ee the *erver*and"o#es(e!ete configuration paraeter in the IBM. Cognos. TM1 Installation and
Configuration Guide for ore inforation.
34 of 425 26-09-2014 11:18
-.4.-. TM1 Ser(er Configuration )arameters for Sandbo+es
The TM1F server configuration fi!e@ T1s.cfg@ uses paraeters for ena"!ing and anaging the sand"o#
feature.
DisableSandboxing paraeter
MaxUserSandboxSize paraeter
+or ore detai!s a"out the T1s.cfg fi!e and these paraeters@ see the IBM Cognos TM1 Installation
and Configuration Guide.
Capa"i!it' ,ssignents
The use of &ersona! Wor/spaces or *and"o#es is contro!!ed using the Capa"i!it' ,ssignents option
avai!a"!e on the *erver .#p!orer@ *erver enu. *ee the *'ste Configuration chapter of the I)MF
CognosF TM1 Operation Guide for ore inforation.
35 of 425 26-09-2014 11:18
-.4.4. 0nderstanding Sandbo+ .ifferences Among .ifferent TM1
Clients
The sand"o# feature wor/s s!ight!' different!' in Cognos TM1F ,pp!ication We" copared to the !egac'
c!ients of TM1 &erspectives @ *erver .#p!orer@ and TM1 We".
This inforation is targeted to those users or adinistrators who use a co"ination of these c!ients.
.efault Sandbo+ and /ase .ata
0egard!ess of other configuration settings@ in the Cognos TM1 ,pp!ication We" c!ient@ the defau!t sand"o#
is ca!!ed defau!t.
This option operates in the sae wa' as the *and"o# feature in other c!ients. Aou cannot turn on a
&ersona! Wor/space in the Cognos TM1 ,pp!ication We" c!ient. Cognos TM1 ,pp!ication We" a!so does not
perit direct write"ac/ so 'ou cannot wor/ direct!' with the "ase data when using Cognos TM1
,pp!ication We".
Cognos TM1 ,pp!ication We" users can su"it their sand"o# data to "ase data on!' as part of the Cognos
TM1 ,pp!ication We" wor/f!ow process.
5isibility of Sandbo+es in .ifferent TM1 Clients
)' design@ Cognos TM1 ,pp!ication We" does not disp!a' an' sand"o#es created in TM1 &erspectives @
*erver .#p!orer or TM1 We".
+or e#ap!e@ a sand"o# created in TM1 We" does not disp!a' in the Cognos TM1 ,pp!ication We" c!ient
sand"o# drop7down !ist.
36 of 425 26-09-2014 11:18
-.6. 0sing )arallel Interaction it% a Cognos TM1 ser(er
&ara!!e! Interaction is an I)MF CognosF TM1F server7re!ated feature that a!!ows for greater concurrenc'
of read and write operations on the sae cu"e o"<ect.
-sing &ara!!e! Interaction@ writers to a cu"e wi!! not "e "!oc/ed waiting for readers of the sae cu"e to
finish their read operation. +or e#ap!e@ 1it2out the &ara!!e! Interaction feature@ a user that is writing
data to a cu"e can "e "!oc/ed and forced to wait if another user is perforing an intensive read operation
on that sae cu"e@ such as reca!cu!ating a !arge cop!e# view.
'ote* ,s of Cognos TM1 version 10.1@ &ara!!e! Interaction is ena"!ed "' defau!t.
$%en to 0se )arallel Interaction
&ara!!e! Interaction is ost usefu! for cu"es that t'pica!!' e#perience a !arge co"ination of "oth read and
write activit'.
In this case@ &ara!!e! Interaction provides an iproveent over the Cognos TM1 !egac' concurrenc' ode
"' a!!owing read and write operations to e#ecute at essentia!!' the sae tie. In soe cases@ read
operations ight ta/e a !itt!e !onger when using &ara!!e! Interaction.
Memory usage considerations
Cognos TM1 ight possi"!' use ore eor' when &ara!!e! Interaction is ena"!ed as copared to using
Cognos TM1 in !egac' ode without this feature.
.#act eor' usage varies depending on the specific cu"es in 'our Cognos TM1 server and the aount
of readHwrite activit' on those cu"es.
1nabling )arallel Interaction for t%e Cognos TM1 ser(er
&ara!!e! Interaction is ena"!ed "' defau!t.
Aou can contro! this feature using the g!o"a! ParallelInteraction configuration paraeter in the
T1s.cfg fi!e to ena"!e or disa"!e the feature for a!! of the cu"es in a Cognos TM1 server.
+or ore detai!s@ see the !ist of configuration paraeters in the IBM Cognos TM1 Installation and
Configuration Guide.
/est practice use of )arallel Interaction
To o"tain a#iu perforance gains provided "' &ara!!e! Interaction@ fo!!ow these "est practice
guide!ines.
37 of 425 26-09-2014 11:18
-.6.1. /est practice use of )arallel Interaction
To o"tain a#iu perforance gains provided "' &ara!!e! Interaction@ fo!!ow these "est practice
guide!ines.
&ara!!e! Interaction G&II is a server configuration that iproves response tie of writing data "' reoving
!oc/ contention resu!ting fro concurrent cu"e data access Gwhen the s'ste reads data or when the
s'ste writes dataI. When ena"!ed@ &ara!!e! Interaction changes the CognosF TM1F O"<ect 6oc/ing
ode! so that write operations are not "!oc/ed "' concurrent data read or data write operations to the
sae cu"e Gor dependent cu"es "ased on ru!esI. 0ead operations a!wa's inc!udes the ost current write
activit' as of the tie the read operation "egins.
Coparisons "etween Cognos TM1 with or without &ara!!e! Interaction show significant perforance
iproveents for writer response tie and an overa!! greater throughput of transactions with test cases
that siu!ate high user concurrenc'.
Cognos TM1 &ara!!e! Interaction provides iediate writer response ties in cases where writer
perforance had "een negative!' ipacted without &ara!!e! Interaction. Iproveents inc!ude>
*upport of concurrent writers e#ecuting high7!eve! data spreading input
*upport of high user counts for readers deanding instantaneous access to fresh!'7entered data
Maintenance of ore recent!'7updated environents during cu"e data !oads over the course of a da'
.#ecution of Tur"oIntegrator (ata ,!!ocation processes sourcing data fro Input Cu"es
.#ecution of Tur"oIntegrator (ata Manipu!ation processes to increenta!!' "ui!d 0eader Cu"es
sourcing data fro Input Cu"es
&ara!!e! Interaction is usefu! for an' Cognos TM1 app!ication invo!ving write"ac/ activit'. *ufficient server
C&- cores are needed to rea!i=e the "enefit of &ara!!e! Interaction and to process the greater throughput
of concurrent read and write operations. *ufficient cores a!so ensure that an' reaining J"!oc/ingJ
activit' resu!ting fro eta data aintenance does not interfere with writer perforance. &ara!!e!
Interaction does not iprove Buer' perforance@ so it is not recoended for Cognos TM1 read7on!'
app!ications.
)arallel Interaction impact on Cognos TM1 ser(er core utili7ation
If the environent has sufficient server cores to process the increenta! transactiona! activit'@ using
&ara!!e! Interaction in Cognos TM1 for wor/ that is su"<ect to readerHwriter contention generates higher
transaction throughput than sii!ar wor/ perfored in previous versions of Cognos TM1 . With &ara!!e!
Interaction writers are no !onger "!oc/ed "' concurrent readers or other writers to the sae cu"e Gand
dependent cu"esIN therefore@ the Cognos TM1 server cores tend to process ore transactions during
periods of high concurrenc'.
Custoers o"serve significant!' higher C&- uti!i=ation using Cognos TM1 &ara!!e! Interaction during
periods of high readHwrite concurrenc' as copared to previous versions of Cognos TM1 .
Insufficient Cognos TM1 server core capacit' a' negative!' ipact the potentia! perforance
advantages of &ara!!e! Interaction. Cognos TM1 custoers upgrading to Cognos TM1 ;.3.2 or !ater fro
prior versions shou!d onitor Cognos TM1 server C&- uti!i=ation when operating with &ara!!e! Interaction
to ensure that server cores are not Jsaturated@J which is indicated "' a greater than :0O server
uti!i=ation for oderate to !ong periods of tie. If use of &ara!!e! Interaction resu!ts in Cognos TM1 *erver
core saturation@ add additiona! cores to the server as avai!a"!e or consider a server with ore avai!a"!e
cores.
)arallel Interaction impact on reader performance
In scenarios invo!ving high vo!ue i#ed readHwrite activit'@ the read operations a' "e s!ight!' s!ower
38 of 425 26-09-2014 11:18
in Cognos TM1 ;.3.2 or higher with &ara!!e! Interaction On copared to Cognos TM1 ;.3.1. This situation
occurs "ecause with &ara!!e! Interaction@ writers uti!i=e C&- resources ore efficient!' and copete with
readers for those resources. With the greater throughput of write activit' in Cognos TM1 ;.3.2 or higher@
&ara!!e! Interaction ore freBuent!' inva!idates interna! caches which can a!so negative!' ipact reader
perforance.
&ara!!e! Interaction does not 'ie!d perforance "enefits for readers in read7on!' Cognos TM1 app!ications.
)arallel Interaction&s impact on Cognos TM1 Semap%ore best practice
&rior to Cognos TM1 ;.3.2@ custoers ep!o'ed a Tur"oIntegrator )est &ractice ca!!ed J*eaphoreJ to
prevent Tur"oIntegrator process JthrashingJ Ga wastefu! situation of successive ro!!"ac/s and retries
which resu!ts in perforance issues for the end usersI. Thrashing is caused "' concurrent e#ecution of
Tur"oIntegrator processes that !oc/ed the sae o"<ects and "!oc/ed each other.
+or instance@ consider an end user data input We"sheet with an ,ction )utton that ca!!s a process to cop'
data fro input cu"es to a reporting cu"e. This operation cou!d resu!t in concurrent e#ecution of a
process that perfors a read operation fo!!owed "' a write operation. (uring periods of high concurrenc'@
the write operation cou!d encounter a !oc/ed cu"e Gas a resu!t of another write operationI@ causing the
process to ro!!"ac/ its wor/ and re7initiate the process. *u"seBuent re7tries "' the process cou!d a!so
encounter a !oc/ed destination cu"e@ causing another ro!!"ac/ and resu!ting in a thrashing scenario that
negative!' ipacts end7user perforance.
The Cognos TM1 *eaphore )est &ractice approach reBuired the Tur"oIntegrator processes to update a
coon cu"e in the &ro!og section to register these!ves for e#ecutionN this action eant that if the
process he!d the !oc/ on the seaphore cu"e@ it wou!d e#ecute to cop!etion without interference fro
!oc/s "' concurrent!'7run processes. If the attept to write to the coon cu"e in the &ro!og
encountered a !oc/@ the ro!!"ac/ tie had@ "' coparison@ a inia! ipact on perforance. With
&ara!!e! Interaction@ concurrent writes to the seaphore cu"e do not cause seria!i=ationN a!! writes occur
in para!!e!.
With Cognos TM1 ;.3.2 &ara!!e! Interaction@ the Cognos TM1 *eaphore )est &ractice as descri"ed a"ove
a' not "e needed or a' need to "e ad<usted to ensure a sii!ar "ehavior. If the process is on!'
reading and writing data@ the *eaphore approach is no !onger needed to achieve "etter perforance. In
this case the concurrent processes run to cop!etion with no !oc/ing "ehavior.
If the process is perforing eta data aintenance@ a new Tur"oIntegrator function ca!!ed
s'nchroni=edGI is avai!a"!e to ensure that the process doesn't cause unnecessar' usage or contention of
Cognos TM1 and s'ste resources. +or ore detai!s@ see the topic J*eria!i=ing Tur"oIntegrator processes
using s'nchroni=edGIJ in the IBM Cognos TM1 TuroIntegrator Guide.
&erforing aintenance to a coon diension ight "e a suita"!e a!ternative. The )est &ractice for
using a diension as a seaphore contro!!ing o"<ect reBuires that the )ase Tur"oIntegrator process ca!!s
a (iension *eaphore process using .#ecute &rocess in the &ro!og ta". The (iension *eaphore
process wi!! sip!' insert a du' e!eent in the contro!!ing diension@ there"' !oc/ing that diension
so no other process that aintains that diension can proceed. The )ase process then reoves the
du' e!eent in the .pi!og ta".
)arallel Interaction impact on use of /atc% 0pdate Start and /atc% 0pdate Finis%
$ait
The e#isting )est &ractice to iprove data !oading perforance e#ecutes u!tip!e Tur"oIntegrator
processes in para!!e!@ wrapping each of the with )atch -pdate *tartH)atch -pdate +inish Wait functions.
This approach is coon!' used to sp!it up a !arge data !oad into severa! sa!!er data !oads Gthe count
depends on the cores avai!a"!e to anage the data !oadI. .#ecuting processes within )atch -pdate
functions a!!ows each process to operate independent!' up to the point of ta/ing an I5 !oc/ on the target
cu"es. ,t that tie the first finishing process updates the cu"e and the others fo!!ow seBuentia!!'. The
end resu!t is a faster data !oad than a sing!e Tur"oIntegrator process.
39 of 425 26-09-2014 11:18
&ara!!e! Interaction a!!ows for siu!taneous e#ecution of processes reading andHor writing to the sae
cu"e Gnone of the data !oading processes "!oc/ing the othersI without the need for )atch -pdate *tart H
)atch -pdate Wait +inish. 0ee"er that processes doing eta data updates resu!t in "!oc/ing actions.
Cognos TM1 ;.3.2 tests with &ara!!e! Interaction On copared with siu!taneous data !oads using )atch
-pdate revea! that perforance is faster without )atch -pdate. Therefore@ when &ara!!e! Interaction is
On@ it is "est to reove the use of )atch -pdate fro Tur"oIntegrator processes.
+or read7on!' environents where &ara!!e! Interaction is Off@ )atch -pdate *tartH)atch -pdate +inish Wait
reains a )est &ractice for increasing the perforance data !oading using siu!taneous data !oading
Tur"oIntegrator processes.
)arallel Interaction impact on Cognos TM1 ser(er memory
Interna! testing coparing Cognos TM1 ;.3.1 to Cognos TM1 ;.3.2 with &ara!!e! Interaction have shown
the Cognos TM1 ;.3.2 *erver to a!!ocate "etween 10O to $0O ore 0,M than the Cognos TM1 ;.3.1
server. *oe of this increased eor' use is due to the interna! structures created "' &ara!!e!
Interaction@ however the additiona! throughput of transactions and their ipact on 4iew Cache is a!so a
contri"uting factor. &!an for $0O ore eor' usage with Cognos TM1 ;.3.2 than with prior versions of
Cognos TM1 .
Operations t%at cause ob8ect loc"ing and potential performance delays
&ara!!e! Interaction great!' iproves writer perforance and provides predicta"!e perforance as reader
and writer user counts sca!e. 1owever@ there are Cognos TM1 operations that can as/ the "enefits of
&ara!!e! Interaction "' !oc/ing o"<ects resu!ting in response7tie perforance de!a's.
1stablis%ing Cube .ependencies
To ensure proper data integrit' and cache anageent in cross7cu"e references in ru!es G()
stateents or ,TT0NH* stateentsI@ interna! re!ationships Gdependenc'I "etween cu"es ust "e
created. .sta"!ishing the cu"e dependenc' is a Buic/ operation@ "ut when it is perfored as part of a
!ong running view or Tur"oIntegrator process@ it "!oc/s concurrent read and write activit' to the
dependent cu"e GCu"e , feeds Cu"e )@ so Cu"e ) is JdependentJ on Cu"e ,@ and the dependenc'
propert' setting on Cu"e ) "!oc/s activit' to Cu"e )I. Once a Cu"e (ependenc' is esta"!ished@ it
reains va!id for the duration of the server session un!ess it "ecoes inva!idated "' a 0u!e fi!e or
diension aintenance.
(uring *erver !oad@ Cognos TM1 esta"!ishes cu"e dependencies "ased on feeder stateents in ru!e
fi!es. +eeder stateents with data7dependent cu"e references or ru!es fi!es containing ,TT0N or
,TT0* functions do not esta"!ish Cu"e (ependencies during server !oadN rather those dependencies
are esta"!ished during a first7tie Buer' or data update invo/ing these cross7cu"e ru!es.
To iprove this situation@ create a Tur"oIntegrator process that esta"!ishes a!! potentia! cu"e
dependencies in the ode! using the ,ddCu"e(ependenc' function for each cu"e7dependent
re!ationship esta"!ished "' ru!es. The process containing these e#p!icit Cu"e (ependenc' functions
shou!d "e e#ecuted iediate!' fo!!owing a Cognos TM1 *erver *tartup@ after ru!e fi!e changes@ and
fo!!owing diension aintenance. This activit' Buic/!' esta"!ishes server7wide cu"e dependencies
and e!iinates the possi"i!it' that a !ong running Buer' or process wi!! trigger a cu"e dependenc'
during periods of user activit' that ight "!oc/ o"<ects and cause contention issues for concurrent
readers and writers.
Cu"e dependencies can "e deterined "' scanning ru!es fi!es for () stateents and ,TT0N and
,TT0* functions. ,n ,TT0NH* function creates a dependenc' on the "ase cu"e's corresponding
e!eent attri"ute cu"e. ,!ternative!'@ a s'ste adinistrator can add the fo!!owing stateent to their
T1s7!og.properties fi!e to have Cognos TM1 !og each tie it creates a cu"e dependenc'>
Log4j.logger.TM1.Cube.Dependency=INFO
.ntries in the !og fi!e wi!! !oo/ !i/e the fo!!owing>
40 of 425 26-09-2014 11:18
9968 [] INFO 2011-03-28 19:18:21.718 TM1.Cube.Dependency
Adding cube dependency: cube "SalesCube" depends on cube "PriceCube"
In this e#ap!e@ &riceCu"e is the ase cue and *a!esCu"e is the dependent cue. The correct
app!ication of this dependenc' when creating an e#p!icit ,ddCu"e(ependenc' function is as fo!!ows>
AddCubeDependency(PriceCube','SalesCube')
*ee -nderstanding Cu"e (ependenc' for ore inforation.
5ieConstruct in a TurboIntegrator )rocess
-se a 4iewConstruct function in Tur"oIntegrator processes to pre7cache a view to iprove
perforance for su"seBuent 4iew e#ecution Gassuing the cache has not "een inva!idatedI. This
function "!oc/s reads and writes to the 4iew's cu"e for the duration of the process.
*ee the 4iewConstruct function in the IBM Cognos TM1 (eference Guide.
1lement Maintenance
.!eent Maintenance wi!! cause "!oc/s to readers and writers of an' cu"e containing the aintained
diension. Contention issues a' arise when the diension is aintained as part of a !onger running
Tur"oIntegrator process. Iso!ate eta data aintenance fro data aintenance in distinct
Tur"oIntegrator &rocesses so that the eta data aintenance operation doesn't carr' its !oc/
throughout the data aintenance operation Gwhich is non7"!oc/ing with &ara!!e! InteractionI. This
goa! can "e accop!ished in separate!'7e#ecuted Chores or "' using the TM10unTI uti!it' to e#ecute
processes e#terna! to Cognos TM1 .
The TM10unTI uti!it' was provided in TM1 ;.3.2 inor fo!!ow7up re!ease and is part of the standard
insta!!ation as of Cognos TM1 10.1.0.
0pdating an Alias
-pdating an a!ias attri"ute causes "!oc/s to readers and writers of an' cu"e containing the
aintained diension. Contention issues arise when the diension is aintained as part of a !onger
running Tur"oIntegrator process. Iso!ate a!ias aintenance in Tur"oIntegrator &rocesses to !essen the
"!oc/ing ipact.
)arent topic* -sing &ara!!e! Interaction with a Cognos TM1 server
41 of 425 26-09-2014 11:18
4. Cognos TM1 Admin Ser(er Operations
This section provides an overview of the I)MF CognosF TM1F ,din *erver and descri"es the t'pica!
adinistrator tas/s of running the ,din *erver on Windows and -NI5 s'stes.
+or detai!s a"out Cognos TM1 s'ste architecture@ see the IBM Cognos TM1 Installation and
TM1 Admin Ser(er
The TM1 ,din *erver is a process that /eeps trac/ of a!! TM1 servers running on a networ/. ,n
,din *erver runs on a coputer /nown as an ,din 1ost.
2unning t%e Cognos TM1 Admin Ser(er on a $indos operating system
,fter 'ou insta!! the I)M Cognos TM1 ,din *erver on a Microsoft Windows s'ste@ 'ou can anage
the server either anua!!' or "' using the Cognos Configuration uti!it'.
2unning t%e Cognos TM1 Admin Ser(er on 0'I9
,fter 'ou insta!! the TM1 ,din *erver on a -NI5 s'ste@ 'ou can start@ stop and anage the ,din
*erver either anua!!' or "' using the I)M Cognos Configuration uti!it'.
Specifying t%e :ocation of t%e Admin 3ost
Aou specif' the !ocation of the ,din 1ost different!' for c!ients Guser interfacesI and reote servers.
42 of 425 26-09-2014 11:18
4.1. TM1 Admin Ser(er
The TM1F ,din *erver is a process that /eeps trac/ of a!! TM1 servers running on a networ/. ,n ,din
*erver runs on a coputer /nown as an ,din 1ost.
When the TM1 server starts@ the server registers itse!f with an ,din *erver that is running on a specified
,din 1ost. TM1 c!ients reference the ,din *erver to deterine which TM1 servers are avai!a"!e on the
networ/.
The fo!!owing diagra shows how c!ients and servers use the ,din *erver.
The ,din *erver aintains the fo!!owing inforation for each avai!a"!e TM1 server>
*erver nae
I& address
&rotoco!
&ort nu"er
,!! this inforation is supp!ied "' the TM1 server when the server registers itse!f on the ,din *erver.
,n ,din *erver ust "e running "efore a TM1 server can start. If 'ou have specified an ,din 1ost in
the T1s.cfg fi!e or the server coand !ine@ the TM1 server wi!! attept to connect to an ,din *erver
on that host. The TM1 server wi!! fai! to coe up if it is una"!e to connect to the ,din *erver for an'
reason.
If 'ou have not specified an ,din 1ost@ the TM1 server attepts to connect to an ,din *erver on the
!oca! achine. If an ,din *erver is not current!' running on the !oca! achine@ the TM1 server starts a
new ,din *erver and connects to it.
The ,din *erver "ecoes aware of TM1 servers on the networ/ "' !istening for notification fro the
servers. -sua!!'@ the TM1 server sends notification of its presence at a regu!ar interva! ca!!ed the
Jheart"eat interva!@J which is 80 seconds "' defau!t. When the ,din *erver detects the TM1 server@ that
server "ecoes registered and avai!a"!e to c!ients on the networ/. 1owever@ if the ,din *erver does not
detect the presence of a registered TM1 server over a period eBua! to three ties the heart"eat interva!@
that TM1 server is reoved fro the !ist of servers avai!a"!e on the networ/. ConseBuent!'@ the TM1
server wi!! not "e avai!a"!e to c!ients on the networ/.
43 of 425 26-09-2014 11:18
)' defau!t@ the ,din *erver uses port 32;3. If port 32;3 is a!read' in use@ 'ou can assign a new port
nu"er "' creating a new service ca!!ed T1adsrv. ,!! TM1 app!ications !oo/ for a naed service ca!!ed
T1adsrv@ and if that service e#ists@ the app!ications use the port nu"er assigned to the service. If
the service does not e#ist@ TM1 app!ications use port 32;3.
)arent topic* Cognos TM1 ,din *erver Operations
44 of 425 26-09-2014 11:18
4.#. 2unning t%e Cognos TM1 Admin Ser(er on a $indos operating
system
,fter 'ou insta!! the I)MF CognosF TM1F ,din *erver on a Microsoft Windows s'ste@ 'ou can
anage the server either anua!!' or "' using the Cognos Configuration uti!it'.
Aou can a!so run specific Tur"oIntegrator processes as part of startup.
*ee the JChoresJ chapter in the IBM Cognos TM1 TuroIntegrator Guide for ore inforation.
Manually starting t%e Cognos TM1 Admin Ser(er on $indos
Aou can anua!!' run the Cognos TM1 ,din *erver as a service or an app!ication on Microsoft Windows.
-se the T1adsd.e#e fi!e in the install6dirP"in director' to run the ,din *erver as a Windows service.
To add the Cognos TM1 ,din *erver as a Windows service@ run the fo!!owing coand at a
coand propt fro the install6dirP"in director'>
Tm1admsd -install
To reove the Cognos TM1 ,din *erver Windows service@ run the fo!!owing coand at a
coand propt fro the install6dirP"in director'>
Tm1admsd -remove
-se the T1adsrv.e#e fi!e to run the ,din *erver as a Windows app!ication. +or detai!s@ see 0unning
the Cognos TM1 ,din *erver as an ,pp!ication on Windows.
0sing Cognos Configuration to manage t%e Cognos TM1 Admin Ser(er on
$indos
+or detai!s on using the Cognos Configuration uti!it' to anage the Cognos TM1 ,din *erver on a
Microsoft Windows operating s'ste@ see the IBM Cognos TM1 Installation and Configuration Guide.
2unning t%e Cognos TM1 Admin Ser(er as an Application on $indos
To run the ,din *erver as an app!ication@ use the T1adsrv.e#e e#ecuta"!e fi!e.
45 of 425 26-09-2014 11:18
4.#.1. 2unning t%e Cognos TM1 Admin Ser(er as an Application on
$indos
To run the ,din *erver as an app!ication@ use the T1adsrv.e#e e#ecuta"!e fi!e.
This fi!e is p!aced in the install6dirP"in director' when 'ou insta!! I)MF CognosF TM1F . Aou can run the
,din *erver "' dou"!e7c!ic/ing the T1adsrv.e#e fi!e@ "ut we recoend that 'ou create a shortcut
to the e#ecuta"!e fi!e in the *tartup director' on the ,din 1ost. That wa'@ the ,din *erver is !aunched
whenever the ,din 1ost starts.
)rocedure
C!ic/ the Start "utton on the Windows tas/"ar. 1.
Choose Settings@ Tas"bar. 2.
C!ic/ the Start Menu )rograms ta". $.
C!ic/ Add.
The Create *hortcut dia!og "o# opens.
2.
.nter the fu!! path to T1adsrv.e#e in the Command line fie!d@ or c!ic/ /rose to navigate to the
fi!e.
3.
If necessar'@ specif' a coand !ine paraeter to set the heart"eat interva! for the ,din *erver.
)arameter
7 h
*ets the heart"eat interva!@ in seconds@ for TM1 servers registered with the ,din *erver.
The defau!t heart"eat interva! is 80 seconds.
8.
C!ic/ 'e+t.
The *e!ect &rogra +o!der dia!og "o# opens.
9.
*e!ect Startup. :.
C!ic/ 'e+t.
The *e!ect a Tit!e dia!og "o# opens.
;.
T'pe a nae for the shortcut and c!ic/ Finis%. 10.
5ieing Admin Ser(er Status
When an ,din *erver is running as an app!ication on an ,din 1ost@ an icon is appended to the
Windows s'ste tra'.
)arent topic* 0unning the Cognos TM1 ,din *erver on a Windows operating s'ste
46 of 425 26-09-2014 11:18
4.#.1.1. 5ieing Admin Ser(er Status
When an ,din *erver is running as an app!ication on an ,din 1ost@ an icon is appended to the
Windows s'ste tra'.
To view the current status of the ,din *erver@ dou"!e7c!ic/ the icon.
The I)MF CognosF TM1F ,din *erver window shows the fo!!owing inforation>
Tie at which the ,din *erver was started
Machine on which it is running
&ort "eing used
(etai!s of each TM1 server current!' registered with the ,din *erver
To shut down an ,din *erver running as an app!ication@ c!ic/ Stop Admin Ser(er.
Aou cannot view the status of an ,din *erver running as a Windows service.
)arent topic* 0unning the Cognos TM1 ,din *erver as an ,pp!ication on Windows
47 of 425 26-09-2014 11:18
4.-. 2unning t%e Cognos TM1 Admin Ser(er on 0'I9
,fter 'ou insta!! the TM1F ,din *erver on a -NI5 s'ste@ 'ou can start@ stop and anage the ,din
*erver either anua!!' or "' using the I)MF CognosF Configuration uti!it'.
Manually starting t%e Cognos TM1 Admin Ser(er on 0'I9
To anua!!' run the TM1 ,din *erver on a -NI5 s'ste@ run the t1adsrv.e#e fi!e fro the
install6dirH"in director'.
0sing Cognos Configuration to manage t%e Cognos TM1 Admin Ser(er on 0'I9
+or detai!s on using the I)M Cognos Configuration uti!it' to anage the TM1 ,din *erver on a -NI5
s'ste@ see the IBM Cognos TM1 Installation and Configuration Guide.
5ieing Admin Ser(er Status 2eport
To view an ,din *erver status report@ run t1adstat.e#e fro the install6dirH"in director'.
48 of 425 26-09-2014 11:18
4.-.1. 5ieing Admin Ser(er Status 2eport
To view an ,din *erver status report@ run t1adstat.e#e fro the install6dirH"in director'.
The ,din *erver report contains the fo!!owing inforation>
Tie at which the ,din *erver was started
Machine on which it is running
&ort "eing used
(etai!s of each TM1F server current!' registered with the ,din *erver
)arent topic* 0unning the Cognos TM1 ,din *erver on -NI5
49 of 425 26-09-2014 11:18
4.4. Specifying t%e :ocation of t%e Admin 3ost
Aou specif' the !ocation of the ,din 1ost different!' for c!ients Guser interfacesI and reote servers.
To specif' the ,din 1ost referenced "' c!ients@ edit the ,din1ost paraeter in the T1p.ini c!ient
configuration fi!e.
Aou can change the T1p.ini fi!e "' using the TM1F Options enu in *erver .#p!orer.
Aou can a!so anua!!' edit the T1p.ini fi!e. +or ore inforation@ see the T1p.ini topic in the IBM
To specif' the ,din 1ost with which reote servers register@ use one of the fo!!owing ethods>
.dit the ,din1ost paraeter in the T1s.cfg fi!e.
-se the 7v coand7!ine paraeter when 'ou "ring up the Windows version of the TM1 server.
+or inforation on server configuration paraeters@ see the topic a"out the T1s.cfg fi!e in the IBM
Specifying Multiple Admin 3osts
Aou can set a TM1 c!ient to reference u!tip!e ,din 1osts "' separating host naes with
seico!ons.
50 of 425 26-09-2014 11:18
4.4.1. Specifying Multiple Admin 3osts
Aou can set a TM1F c!ient to reference u!tip!e ,din 1osts "' separating host naes with seico!ons.
, c!ient that specifies u!tip!e ,din 1osts can access an' TM1 servers that are registered with the
,din *ervers on the specified hosts.
)arent topic* *pecif'ing the 6ocation of the ,din 1ost
51 of 425 26-09-2014 11:18
6. 2emote Cognos TM1 Ser(er Operations
This section descri"es how I)MF CognosF TM1F reote servers wor/@ and how 'ou can anage their
operations.
+or cop!ete detai!s a"out Cognos TM1 s'ste architecture@ see the IBM Cognos TM1 Installation and
+or detai!s on using the I)M Cognos Configuration uti!it' to anage TM1 reote servers on a Windows or
-NI5 s'ste@ see the IBM Cognos TM1 Installation and Configuration Guide.
O(er(ie of 2emote Ser(er Operations
The fo!!owing figure i!!ustrates the operations of a reote TM1 server. These operations are e#p!ained
in the te#t that fo!!ows.
Setting 0p a 2emote TM1 Ser(er to 2un as an Application
,fter 'ou run the TM1 Insta!!ation Wi=ard on a Microsoft Windows s'ste and insta!! the sap!e TM1
servers@ 'ou can use the I)M Cognos Configuration uti!it' to run each sap!e server as a Microsoft
Windows service. ,s an a!ternative@ 'ou can anua!!' set up the TM1 server to run as an app!ication.
Setting 0p a 2emote TM1 Ser(er to 2un as a $indos Ser(ice
Aou can anua!!' insta!! a TM1 server to run as a Windows service@ or reove an e#isting one@ using
the coand !ine options of the t1sd.e#e fi!e. The t1sd.e#e fi!e is insta!!ed in the installP"in
director'.
Starting a 2emote TM1 Ser(er
The topics in this section descri"e how to start a!! versions of the TM1 server.
Connecting to a 2emote Ser(er
To connect to a reote TM1 server@ a c!ient ust point to an ,din 1ost on which an ,din *erver is
running. The ,din *erver aintains inforation a"out reote TM1 servers avai!a"!e on the
networ/@ inc!uding nae@ protoco!@ address@ and port nu"er. The ,din 1ost used "' the c!ient is
specified in the T1p.ini fi!e.
.isconnecting from a 2emote Ser(er
Aou can disconnect fro a reote server.
S%utting .on a $indos TM1 Ser(er
Aou can shut down a reote server that has "een set up to run as a Windows app!ication.
S%utting .on a 0'I9 TM1 Ser(er
Aou can shut down a server running in the foreground.
:ogging Transactions
.ach TM1 server trac/s the data transactions ade "' its c!ients. When a c!ient changes a cu"e
va!ue@ TM1 records the change in a transaction !og fi!e naed T1s.!og@ which is !ocated in the TM1
server data director'.
Monitoring Ser(er )erformance
TM1 inc!udes a perforance onitoring feature that !ets 'ou record the perforance statistics for
c!ients@ cu"es@ and servers. When 'ou ena"!e perforance onitoring@ TM1 popu!ates severa! contro!
cu"es on a inute7"'7inute "asis. Aou can then "rowse these cu"es to ana!'=e the server
perforance.
Managing Client Connections
,s a TM1 server adinistrator@ 'ou can use the C!ients Messaging Center to anage c!ient
connections.
2emote Ser(er Memory Management
The TM1 server uses a sparse eor' anageent schee@ which a!!ows the server to ho!d ver'
52 of 425 26-09-2014 11:18
!arge cu"es in uch !ess space than the sae data wou!d occup' in a re!ationa! data"ase. Therefore@
the eor' anageent schee a!!ows the server to accoodate ver' !arge data"ases in 0,M
without the need to use dis/ space.
0sing TM1 in /ul" :oad Mode
)u!/ 6oad Mode ena"!es I)M Cognos TM1 to run in a specia! optii=ed sing!e7user or sing!e
choreHprocess ode. This ode can a#ii=e Cognos TM1 perforance for dedicated tas/s during
ties when !itt!e or no other activit' is e#pected.
53 of 425 26-09-2014 11:18
6.1. O(er(ie of 2emote Ser(er Operations
The fo!!owing figure i!!ustrates the operations of a reote TM1F server. These operations are e#p!ained in
the te#t that fo!!ows.
On startup@ the reote server !oads diensions and cu"es fro the data director' into the server
achine 0,M. ,t the sae tie@ the server opens a new transactiona! !og fi!e ca!!ed T1s.!og in the
data director'. ,fter the cu"es are !oaded@ the reote server is avai!a"!e.
The reote TM1 server registers itse!f with one or ore ,din *ervers so that c!ients can connect to
the reote TM1 server.
C!ient app!ications contact ,din *ervers to !ocate avai!a"!e TM1 servers. The c!ients !og into the TM1
servers whose data the' want to access.
C!ients edit the cu"e data@ sending the va!ues "ac/ to the TM1 server.
,s new va!ues are received fro c!ients@ the TM1 server writes the records to the T1s.!og fi!e@
/eeping trac/ of ever' data change@ inc!uding the date and tie the edit occurred@ and the I( of the
c!ient who ade the edit.
,s the server ca!cu!ates new va!ues in response to c!ient reBuests@ the server stores the in eor'@
increasing the aount of eor' used "' the server.
When the server shuts down@ a!! records in the T1s.!og fi!e are saved to dis/@ and the transaction
!og fi!e is renaed "' appending a dateHtie stap to it. The T1s.!og fi!e is saved in the server's
data director' to "ac/ out data transactions@ as descri"ed in )ac/ing Out 0ecords fro the
Transaction 6og.
If the server is intentiona!!' shut down without saving the changes@ the !og fi!e is saved with a
tieHdate stap and the e#tension is changed to .re<. Aou can process the
T1s7777""dd22""ss.re< fi!e through Tur"oIntegrator to recover the transactions.
To save a!! changes to the data on a TM1 server at an' tie without shutting down the server@
right7c!ic/ a server in *erver .#p!orer and C!ic/ Sa(e .ata. ,!! records in the T1s.!og fi!e are
54 of 425 26-09-2014 11:18
iediate!' written to dis/@ the transaction !og fi!e is renaed "' appending a dateHtie stap to it@
and a new T1s.!og fi!e is created to accept an' su"seBuent edits to cu"e va!ues.
,n' changes to the etadata@ such as diension definitions and cu"e definitions@ are iediate!'
saved to dis/. The changes to the etadata are not written to the transaction !og fi!e.
)arent topic* 0eote Cognos TM1 *erver Operations
55 of 425 26-09-2014 11:18
6.#. Setting 0p a 2emote TM1 Ser(er to 2un as an Application
,fter 'ou run the TM1F Insta!!ation Wi=ard on a Microsoft Windows s'ste and insta!! the sap!e TM1
servers@ 'ou can use the I)M Cognos Configuration uti!it' to run each sap!e server as a Microsoft
Windows service. ,s an a!ternative@ 'ou can anua!!' set up the TM1 server to run as an app!ication.
)rocedure
Open the install6dirP"in director' in Windows Internet .#p!orer. 1.
0ight7c!ic/ T1s.e#e. 2.
*e!ect Create S%ortcut.
Windows creates *hortcut to T1s.e#e in the install6dirP"in director'.
$.
0ight7c!ic/ *hortcut to T1s.e#e. 2.
*e!ect )roperties.
The &roperties window opens.
3.
C!ic/ the S%ortcut ta".
The Target fie!d on this ta" contains the fu!! path to T1s.e#e.
8.
In the Target fie!d@ add the 7= f!ag and specif' the fu!! path to the director' containing the T1s.cfg
fi!e for the server.
+or e#ap!e@ 7= C>PTM1Psa!esdata indicates that the T1s.cfg fi!e for the server resides in the C>PTM1
Psa!esdata director'.
'ote* If the path to the director' contains an' "!an/ spaces@ enc!ose the entire path with dou"!e
Buotes.
The contents of the Target fie!d shou!d rese"!e the fo!!owing>
"C:\Program Files\IBM\cognos\tm1\bin\tm1s.exe" -z C:\TM1\salesdata
9.
C!ic/ O; to save the shortcut.
Aou ight want to ove the shortcut to the des/top for eas' access.
:.
56 of 425 26-09-2014 11:18
6.-. Setting 0p a 2emote TM1 Ser(er to 2un as a $indos Ser(ice
Aou can anua!!' insta!! a TM1F server to run as a Windows service@ or reove an e#isting one@ using
the coand !ine options of the t1sd.e#e fi!e. The t1sd.e#e fi!e is insta!!ed in the installP"in director'.
The topics in this section descri"e how to configure a TM1 server to run as a Windows service.
Installing a TM1 Ser(er to 2un as a $indos Ser(ice
To insta!! a TM1 server to run as a Windows service@ use the fo!!owing coand !ine forat >
tm1sd.exe -install parameters
2emo(ing a TM1 Ser(er from 2unning as a $indos Ser(ice
To reove a TM1 server that is running as a service@ use the fo!!owing coand !ine forat.
57 of 425 26-09-2014 11:18
6.-.1. Installing a TM1 Ser(er to 2un as a $indos Ser(ice
To insta!! a TM1F server to run as a Windows service@ use the fo!!owing coand !ine forat >
tm1sd.exe -install parameters
The fo!!owing ta"!e !ists the avai!a"!e paraeters.
)arameter 2e<uired=Optional
.escription
7n 0eBuired
Nae of the TM1 *erver. This wi!! "ecoe the Windows service nae as shown
when 'ou disp!a' the properties of an insta!!ed service.
7= 0eBuired
(ata director' that contains the t1.cfg fi!e for the TM1 data"ase.
7u Optiona!
4a!id user nae for the coputer on which 'ou are wor/ing. -se one of the
fo!!owing forats>
(oain and user nae in the forat Do"ain8userna"e. +or e#ap!e@
entpP<sith.
-ser nae for a !oca! user account.
If 'ou do not provide a user nae@ the current user account is used "' defau!t.
7w Optiona!
&assword for the a"ove account.
+or e#ap!e@ the fo!!owing coand !ine insta!!s the sdata TM1 server as a Windows service for the
current user.
tm1sd.exe -install -n sdata -z C:\Program Files\Cognos\TM1\Custom\TM1Data\SData
)arent topic* *etting -p a 0eote TM1 *erver to 0un as a Windows *ervice
58 of 425 26-09-2014 11:18
6.-.#. 2emo(ing a TM1 Ser(er from 2unning as a $indos Ser(ice
To reove a TM1F server that is running as a service@ use the fo!!owing coand !ine forat.
tm1sd.exe -remove -n ServerName
where /erver9a"e is the Microsoft Windows service nae of the TM1 server 'ou want to reove.
+or e#ap!e@ the fo!!owing coand !ine reoves an e#isting service for the sdata TM1 server.
tm1sd.exe -remove -n sdata
)arent topic* *etting -p a 0eote TM1 *erver to 0un as a Windows *ervice
59 of 425 26-09-2014 11:18
6.4. Starting a 2emote TM1 Ser(er
The topics in this section descri"e how to start a!! versions of the TM1F server.
Starting a TM1 Ser(er Set 0p as a $indos Application
Aou can start a reote server that has "een set up as a Windows app!ication.
Starting a TM1 Ser(er Installed as a $indos Ser(ice
To start a reote server that has "een insta!!ed as a service@ cop!ete the fo!!owing steps.
Starting a 0'I9 TM1 Ser(er
To assist 'ou in starting a -NI5 TM1 server@ a sap!e script naed startup%t1s.sh is avai!a"!e in the
install6dirH"in or H"in82 director'.
60 of 425 26-09-2014 11:18
6.4.1. Starting a TM1 Ser(er Set 0p as a $indos Application
Aou can start a reote server that has "een set up as a Windows app!ication.
)rocedure
(ou"!e7c!ic/ the TM1F *a!es (ata icon.
2esults
, server window opens. The server window !ists the cu"es and diensions !oaded into the server 0,M.
)arent topic* *tarting a 0eote TM1 *erver
61 of 425 26-09-2014 11:18
6.4.#. Starting a TM1 Ser(er Installed as a $indos Ser(ice
To start a reote server that has "een insta!!ed as a service@ cop!ete the fo!!owing steps.
)rocedure
Open the Microsoft Windows *ervices anager.
, !ist of insta!!ed services opens.
1.
*e!ect the entr' for the TM1F server 'ou want to start@ for e#ap!e )lanning Sample@ and c!ic/ the
Start "utton.
,n ,din *erver ust "e running "efore a TM1 server can start. If 'ou have specified an ,din 1ost
in the T1s.cfg fi!e@ the TM1 server wi!! attept to connect to an ,din *erver on that host. The TM1
server wi!! fai! to coe up if it is una"!e to connect to an ,din *erver for an' reason.
If 'ou have not specified an ,din 1ost@ the TM1 server attepts to connect to an ,din *erver on
the !oca! achine. If an ,din *erver is not current!' running on the !oca! achine@ either as a
service or an app!ication@ the TM1 server starts a new ,din *erver app!ication and connects to it.
2.
Setting up a Ser(ice to Start Automatically
To set up an insta!!ed service to start autoatica!!' when Microsoft Windows re"oots@ cop!ete the
fo!!owing steps.
62 of 425 26-09-2014 11:18
6.4.#.1. Setting up a Ser(ice to Start Automatically
To set up an insta!!ed service to start autoatica!!' when Microsoft Windows re"oots@ cop!ete the
fo!!owing steps.
)rocedure
Open Windows *ervices anager.
, !ist of insta!!ed services opens.
1.
(ou"!e7c!ic/ the TM1F Ser(er entr'.
The Ser(ice )roperties dia!og "o# opens.
2.
*e!ect Automatic as the *tartup T'pe and c!ic/ O;. $.
)arent topic* *tarting a TM1 *erver Insta!!ed as a Windows *ervice
63 of 425 26-09-2014 11:18
6.4.-. Starting a 0'I9 TM1 Ser(er
To assist 'ou in starting a -NI5 TM1F server@ a sap!e script naed startup%t1s.sh is avai!a"!e in the
install6dirH"in or H"in82 director'.
With a few inor odifications@ 'ou can use this sap!e script to start 'our -NI5 TM1 server. When 'ou
use the script to start a server@ TM1 uses the T1s.cfg fi!e in the specified data director' to direct the
"ehavior of the server.
Modifying t%e startup,tm1s.s% Script
Modif' the path paraeters to custoi=e the startup%t1s.sh script.
2unning t%e 0'I9 TM1 Ser(er in /ac"ground Mode
Aou can run the TM1 server in "ac/ground ode "' adding the paraeter 0unningIn)ac/ground to
the t1s.cfg fi!e and setting the paraeter to T.
64 of 425 26-09-2014 11:18
6.4.-.1. Modifying t%e startup,tm1s.s% Script
Modif' the path paraeters to custoi=e the startup%t1s.sh script.
)rocedure
Open the fi!e in a te#t editor. 1.
*et the tm1_path paraeter to the director' containing the t1s.e#e server e#ecuta"!e fi!e. In ost
circustances@ this director' is install_dir/bin.
2.
*et the tm1_data_path paraeter to 'our server data director'. $.
*et the TM1_PATH paraeter to director' containing the t1s.e#e server e#ecuta"!e fi!e. In ost
circustances@ this director' is install_dir/bin.
'ote* Aou ust set "oth tm1_path and TM1_PATH to the sae director'.
2.
*ave the script.
+or e#ap!e>
> ./startup_tm1s.sh /software/AutoInstall/TM1/samples/tm1/SData
Aou can save to a new fi!e nae if desired. If 'ou have insta!!ed u!tip!e TM1F servers@ 'ou shou!d
create server7specific scripts with uniBue fi!e naes for each server.
3.
0un .Hstartup%t1s.sh Gor the new fi!e naeI to start 'our TM1 server. 8.
1+ample
Note that if 'ou use an a"so!ute path to start the server@ 'ou ust use an a"so!ute path to stop it.
*ii!ar!'@ if 'ou use a re!ative path to start the server@ 'ou ust use a re!ative path to stop it. +or
e#ap!e@ if 'ou use>
> ./startup_tm1s.sh "../samples/tm1/SData"
then the shutdown script ust a!so use the sae re!ative path>
> ./shutdown_tm1s.sh "../samples/tm1/SData"
Aou cannot i# and atch the path description ethods "etween startup and shutdown of the sae
data"ase.
)arent topic* *tarting a -NI5 TM1 *erver
65 of 425 26-09-2014 11:18
6.4.-.#. 2unning t%e 0'I9 TM1 Ser(er in /ac"ground Mode
Aou can run the TM1F server in "ac/ground ode "' adding the paraeter 0unningIn)ac/ground to the
t1s.cfg fi!e and setting the paraeter to T.
RunningInBackground=T
Aou ust anua!!' add the 0unningIn)ac/ground paraeter to T1s.cfg. This paraeter is not part of
the standard t1s.cfg fi!e created when 'ou insta!! the TM1 server. +or detai!s a"out server configuration
paraeters@ see the IBM. Cognos. TM1 Installation and Configuration Guide.
When 'ou run the TM1 server in "ac/ground ode@ 'ou ust use shutdown%t1s.sh to shut down the
server. *ee *hutting (own a -NI5 TM1 *erver 0unning in )ac/ground Mode.
)arent topic* *tarting a -NI5 TM1 *erver
66 of 425 26-09-2014 11:18
6.6. Connecting to a 2emote Ser(er
To connect to a reote TM1F server@ a c!ient ust point to an ,din 1ost on which an ,din *erver is
running. The ,din *erver aintains inforation a"out reote TM1 servers avai!a"!e on the networ/@
inc!uding nae@ protoco!@ address@ and port nu"er. The ,din 1ost used "' the c!ient is specified in the
T1p.ini fi!e.
)rocedure
,ccess *erver .#p!orer. 1.
(ou"!e7c!ic/ the icon for the server to which 'ou want to connect.
The *erver 6ogin dia!og "o# opens.
2.
.nter the correct user nae and password@ and c!ic/ O;.
If the connection to the server is successfu!@ TM1 disp!a's the Cu"es@ (iensions@ 0ep!ications@
&rocesses@ and Chores icons for that server. GThe 0ep!ications icon disp!a's on!' if 'ou !ogged in as a
e"er of the ,(MIN group.I
'ote* The TM1 reote server coes with a predefined adinistrator I( of ,(MIN@ and a password of
app!e.
$.
2efres%ing t%e :ist of 2emote Ser(ers
If 'ou do not see the reote server to which 'ou want to connect in the !ist of avai!a"!e servers@ 'ou
can refresh this !ist.
2e!Setting t%e Admin 3ost
Aou can set or change the ,din 1ost.
2e!Setting :ocal Ser(er Options
The fo!!owing ta"!e descri"es the 6oca! *erver options that 'ou can change through the TM1 Options
dia!og "o#.
67 of 425 26-09-2014 11:18
6.6.1. 2efres%ing t%e :ist of 2emote Ser(ers
If 'ou do not see the reote server to which 'ou want to connect in the !ist of avai!a"!e servers@ 'ou can
refresh this !ist.
)rocedure
C!ic/ File@ 2efres% A(ailable Ser(ers. TM1F disp!a's a!! running servers that are registered on the
,din 1ost to which the c!ient is pointing.
)arent topic* Connecting to a 0eote *erver
68 of 425 26-09-2014 11:18
6.6.#. 2e!Setting t%e Admin 3ost
Aou can set or change the ,din 1ost.
)rocedure
+ro *erver .#p!orer@ c!ic/ File@ Options.
The TM1F Options dia!og "o# opens.
1.
.nter the nae of the ,din 1ost in the ,din 1ost fie!d. Aou can concatenate two or ore hosts "'
separating the host naes with a seico!on.
Aou can a!so c!ic/ the drop7down enu to se!ect fro previous!' accessed ,din 1osts.
2.
C!ic/ O;.
When 'ou change the ,din 1ost@ TM1 disconnects 'ou fro the reote servers to which 'ou are
connected and restarts 'our TM1 c!ient. If a !oca! server is running@ that server is shut down and
restarted.
$.
69 of 425 26-09-2014 11:18
6.6.-. 2e!Setting :ocal Ser(er Options
The fo!!owing ta"!e descri"es the 6oca! *erver options that 'ou can change through the TM1F Options
dia!og "o#.
:ocal Ser(er Option .escription
(ata (irector' (irector' for the !oca! server data fi!es.
Connect to 6oca!
*erver on *tartup
*e!ect or c!ear the Connect to 6oca! *erver on *tartup chec/ "o# to contro!
whether the TM1 c!ient autoatica!!' connects to the !oca! server at startup.
70 of 425 26-09-2014 11:18
6.>. .isconnecting from a 2emote Ser(er
Aou can disconnect fro a reote server.
)rocedure
In *erver .#p!orer@ se!ect the icon for the server fro which 'ou want to disconnect. 1.
C!ic/ Ser(er@ :og Out. 2.
71 of 425 26-09-2014 11:18
6.?. S%utting .on a $indos TM1 Ser(er
Aou can shut down a reote server that has "een set up to run as a Windows app!ication.
)rocedure
C!ic/ the Close "utton in the server window.
S%utting .on a $indos TM1 Ser(er 2unning as a Ser(ice
Aou can shut down a reote server that has "een insta!!ed as a Microsoft Windows service.
72 of 425 26-09-2014 11:18
6.?.1. S%utting .on a $indos TM1 Ser(er 2unning as a Ser(ice
Aou can shut down a reote server that has "een insta!!ed as a Microsoft Windows service.
)rocedure
Open the Microsoft Windows *ervices anager.
, !ist of services opens.
1.
0ight7c!ic/ the TM1F Ser(er and se!ect Stop.
+or detai!s and additiona! steps on shutting down a server fro a reote !ocation when !ogged in as
the TM1 ,(MIN user@ see Managing C!ient Connections.
2.
2esults
The TM1 server running as a Windows service autoatica!!' shuts down during s'ste shutdown. In
soe instances@ a server running a !arge or cop!e# ode!@ ight not proper!' shut down during s'ste
shutdown@ power fai!ure@ or anua! service shutdown. ,n iproper shutdown is defined as a shutdown in
which the TM1 server is suari!' terinated "efore it has cop!eted a!! shutdown procedures. This can
happen during nora! s'ste shutdown "ecause Windows a!!ots a !iited tie Gappro#iate!' 20
secondsI for service shutdown. ,fter the a!!otted tie e#pires@ the s'ste shutdown proceeds regard!ess
of whether the service shutdown is cop!ete.
When the TM1 server is running as a service@ it autoatica!!' recovers an' data changes fro the
previous sessions in which an iproper shutdown occurs. The changes are recovered fro records in the
server's T1s.!og fi!e.
+or detai!s on Microsoft's approach to service shutdown or on increasing the aount of tie a!!otted "'
Windows for service shutdown@ see the Microsoft support we"site.
)arent topic* *hutting (own a Windows TM1 *erver
73 of 425 26-09-2014 11:18
6.@. S%utting .on a 0'I9 TM1 Ser(er
Aou can shut down a server running in the foreground.
)rocedure
&ress CT06QC in the window fro which 'ou started the server. 1.
)efore 'ou e#it@ the server propts 'ou to save a!! data to dis/. &ress .NT.0 Gor 0.T-0NI to save a!!
data. T'pe No and press .NT.0 to shut down the server without saving the data.
2.
S%utting .on a 0'I9 TM1 Ser(er 2unning in /ac"ground Mode
To shut down the TM1 server running in "ac/ground ode@ run shutdown%t1s.sh !ocated in the
insta!!%dirH"in director'.
74 of 425 26-09-2014 11:18
6.@.1. S%utting .on a 0'I9 TM1 Ser(er 2unning in /ac"ground Mode
To shut down the TM1F server running in "ac/ground ode@ run shutdown%t1s.sh !ocated in the
insta!!%dirH"in director'.
The shutdown%t1s.sh fi!e accepts the fo!!owing paraeters>
)arameter .escription
7n 0eBuired
The nae of the TM1 server 'ou want to shut down. Note that this server ust
have "een started in "ac/ground ode.
7v 0eBuired
I& address of the ,din *erver on which the TM1 server is registered.
7user 0eBuired
-ser nae of the person "ringing down the server. This person ust have the
necessar' access and privi!eges to shut down the server.
7pwd 0eBuired
&assword for the person "ringing down the server.
7tie Optiona!
(e!a'@ in seconds@ at which the server wi!! "e shut down after running
shutdown%t1s.sh
7cance! Optiona!
Cance!s an' previous!' issued shutdown%t1s.sh coands. 4a!id va!ues are T and
+.
7unsave Optiona!
)' defau!t@ TM1 saves the data "efore a TM1 server is shut down with the
shutdown%t1s.sh coand. The 7unsave paraeter shuts down a server without
saving the data. 4a!id va!ues are T and +.
+or e#ap!e@ the fo!!owing coand !ine a!!ows a user naed ,din with a password of ,dinistrator to
shut down a TM1 server naed TM1*.04 registered on an ,din 1ost !ocated at 209.110.100.208. The
coand !ine indicates a $07second interva! "etween the tie the coand is issued and the tie the
server shuts down. The server is shut down without saving the data.
./startup_tm1s.sh -n TM1SERV -v 207.110.100.206 -user ADMIN
-pwd Administrator -time 30 -unsave T
75 of 425 26-09-2014 11:18
Note that if 'ou use an a"so!ute path to start the server@ 'ou ust use an a"so!ute path to stop it.
*ii!ar!'@ if 'ou use a re!ative path to start the server@ 'ou ust use a re!ative path to stop it. +or
e#ap!e@ if 'ou use>
> ./startup_tm1s.sh "../samples/tm1/SData"
then the shutdown script ust a!so use the sae re!ative path>
> ./shutdown_tm1s.sh "../samples/tm1/SData"
Aou cannot i# and atch the path description ethods "etween startup and shutdown of the sae
data"ase.
)arent topic* *hutting (own a -NI5 TM1 *erver
76 of 425 26-09-2014 11:18
6.A. :ogging Transactions
.ach TM1F server trac/s the data transactions ade "' its c!ients. When a c!ient changes a cu"e va!ue@
TM1 records the change in a transaction !og fi!e naed T1s.!og@ which is !ocated in the TM1 server data
director'.
The inforation recorded in the !og fi!e inc!udes>
(ate and tie the change was ade.
Nae of the c!ient who ade the change.
Whether the new data is sip!e data GNI or string data G*I.
4a!ue "efore the change.
4a!ue after the change.
Nae of the cu"e in which the change was ade.
.!eents that identif' the ce!! that changed.
Optiona! user7provided string that is attached to each transaction. Aou create the string with the
TM1*erver6og*et+!ag*tring ,&I function.
The !og fi!e is a coa7de!iited ,*CII fi!e@ as shown in the fo!!owing sap!e>
"19980602212741","19980602212741","Admin","N","380.","250.","salescube","Budget",
"Belgium","L
Series 1.6 L Sedan","Units","Jun","" "19980602212744","19980602212744","Admin","N",
"430.","600.","salescube","Budget","Belgium","L
Series 1.6 L Sedan","Units","Sep","" "19980602212749","19980602212749","Admin","N",
"610.","800.","salescube","Budget","Belgium","L
Series 1.6 L Sedan","Units","Oct",""
.ata /ac"up and 2eco(ery
The T1s.!og fi!e reains open whi!e the TM1 server is running.
1nabling and .isabling :ogging
)' defau!t@ TM1 !ogs transactions to a!! cu"es !oaded on the server. ,s the s'ste adinistrator@ 'ou
have the option to turn off !ogging for particu!ar cu"es.
5ieing t%e Transaction :og
Aou can Buer' the transaction !og GT1s.!ogI to view the records of a!! the !ogs current!' in the TM1
server data director'. When 'ou Buer' the transaction !og@ TM1 co"ines a!! the !og fi!es into one
!ogica! fi!e that satisfies the Buer' paraeters.
Setting Searc% :oc" :imit
When the Transaction 6og is searching@ other users are !oc/ed out of perforing activit' on the !og.
)' defau!t the !og searches 3000 !ines "efore it teporari!' re!eases the !oc/ so that other users can
access the !og.
/ac"ing Out 2ecords from t%e Transaction :og
,fter 'ou Buer' the transaction !og@ 'ou can use the Transaction 6og ?uer' 0esu!ts dia!og "o# to "ac/
out the transactions. When 'ou "ac/ out a transaction@ the va!ue in the O6(4,6-. co!un rep!aces
the va!ue in the N.W4,6-. co!un.
2emo(ing :og Files from t%e .is"
The TM1 !og fi!es can ta/e up a su"stantia! aount of dis/ space after the server has "een running
for soe tie. Aou shou!d reove the o!d !og fi!es fro 'our dis/ ever' so often@ depending on the
vo!ue of the changes 'ou a/e and the si=e of 'our dis/. Aou can "ac/ up these fi!es "efore 'ou
erase the.
77 of 425 26-09-2014 11:18
78 of 425 26-09-2014 11:18
6.A.1. .ata /ac"up and 2eco(ery
The T1s.!og fi!e reains open whi!e the TM1F server is running.
When 'ou "ring down the server nora!!'@ TM1 renaes the !og fi!e "' appending a tie stap to it@ and
with the fo!!owing naing convention>
Tm1syyyymmddhhmmss.log
The tie stap@ 7777""dd22""ss@ represents the current Greenwich Mean Tie at the tie the server
was "rought down. +or e#ap!e@ if the server cae down on Ranuar' 2@ 2002@ at 2>$0 &M@ the nae of
the !og fi!e is T1s2002010212$000.!og.
TM1 recovers the data autoatica!!' in the event that a server coes down a"nora!!'@ and !eaves the
T1s.!og fi!e on the dis/. The ne#t tie 'ou "ring up the server@ TM1 recovers the changes in either of
two wa's>
Automatically reco(ers t%e c%anges 77 when 'ou are running the TM1 server as a Windows
service
)rompts you to reco(er t%e c%anges 77 when 'ou are running the TM1 server as an app!ication
If 'ou intentiona!!' shut down a TM1 server without saving the data@ TM1 saves the transaction !og with a
tie stap and changes the fi!e e#tension to .re<. +or e#ap!e@ T1s2002010212$000.re<. The .re< !og
fi!e ensures that 'ou a!wa's have a record of the data transactions@ even if 'ou shut down the server
without saving the data. If 'ou accidenta!!' shut down the server without saving the changes@ 'ou can
process the .re< fi!e through Tur"oIntegrator to recover the data.
)arent topic* 6ogging Transactions
79 of 425 26-09-2014 11:18
6.A.#. 1nabling and .isabling :ogging
)' defau!t@ TM1F !ogs transactions to a!! cu"es !oaded on the server. ,s the s'ste adinistrator@ 'ou
When 'ou disa"!e !ogging@ TM1 acce!erates updating the data "ut 'ou cannot recover the updates in the
event of a s'ste fai!ure.
Aou can ena"!e !ogging for individua! cu"es.
)rocedure
Open *erver .#p!orer. 1.
*e!ect the Cu"es icon for the server 'ou are wor/ing with. 2.
*e!ect Cubes@ Security Assignments.
The TM1 *ecurit' ,ssignents dia!og "o# opens.
$.
C!ic/ the ce!! at the intersection of the 6ogging co!un and the cu"e nae.
TM1 ena"!es !ogging when a chec/ "o# contains an 5@ and disa"!es !ogging when the chec/ "o# is
ept'.
2.
C!ic/ O;. 3.
80 of 425 26-09-2014 11:18
6.A.-. 5ieing t%e Transaction :og
Aou can Buer' the transaction !og GT1s.!ogI to view the records of a!! the !ogs current!' in the TM1F
server data director'. When 'ou Buer' the transaction !og@ TM1 co"ines a!! the !og fi!es into one !ogica!
fi!e that satisfies the Buer' paraeters.
+or e#ap!e@ if 'ou Buer' for a!! the records starting on Ran. 2@ 2002 at 2>$0 &M GMT@ TM1 returns a!! the
records in a!! the transaction !ogs with a tie stap of 2002010212$000 or !ater.
'ote* Aou ust use a ;. 3 or newer TM1 c!ient to view !og fi!es on a ;.3.# server. The transaction !og
does not disp!a' correct!' when 'ou use a pre7;.3 c!ient to view !og fi!es on a ;.3.# server.
)rocedure
*e!ect the server in *erver .#p!orer. 1.
C!ic/ Ser(er@ 5ie Transaction :og.
The Transaction 6og ?uer' dia!og "o# opens.
2.
C!ic/ the right arrow in a paraeter fie!d to set the paraeters for the Buer'.
There are four paraeters 'ou can set>
*tarting Tie ?ueries a!! the records written to the transaction !og on or after the starting
tie.
*tart date and tie for the Buer'. The date and tie forat is MMH((HAAAA
11>MM>** GMT. The defau!t start date and tie is 00>01>00 GMT on the date
'ou !aunch the Buer'.
.nd Tie .nd date and tie for the Buer'. The date and tie forat is MMH((HAAAA
11>MM>**
The defau!t is %%H%%H%%%% %%>%%>%%@ which is an open end date and tie. If 'ou
accept the defau!t@ TM1 Bueries a!! the records up to the tie 'ou !aunch the
Buer'.
C!ients The c!ientGsI against which 'ou app!' the Buer'.
Aou can Buer' against either a sing!e c!ient or a!! the c!ients. The defau!t is a!!
c!ients GSI.
Cu"es The cu"eGsI against which 'ou app!' the Buer'.
Aou can Buer' against either a sing!e cu"e or a!! the cu"es. The defau!t is a!!
cu"es GSI
$.
C!ic/ O;.
The Buer' returns a ta"!e with a!! the transaction records that satisf' the paraeters 'ou set. The
ta"!e disp!a's in the Transaction 6og ?uer' 0esu!ts dia!og "o#.
)' defau!t@ records are sorted in ascending order "' 6OGTIM..
2.
81 of 425 26-09-2014 11:18
,t an' tie after 'ou start the Buer'@ 'ou can c!ic/ Cance! to stop the search. When 'ou choose
Cance!@ nothing is returned for 'our search.
To sort on a different co!un@ c!ic/ the co!un heading. To change the order of a co!un sort@ c!ic/
the co!un heading a second tie.
3.
C!ic/ 1dit@ Find to search the records in the Buer' resu!ts ta"!e. 8.
82 of 425 26-09-2014 11:18
6.A.4. Setting Searc% :oc" :imit
When the Transaction 6og is searching@ other users are !oc/ed out of perforing activit' on the !og. )'
defau!t the !og searches 3000 !ines "efore it teporari!' re!eases the !oc/ so that other users can access
the !og.
Aou can change the nu"er of !ines searched "efore the !oc/ is teporari!' re!eased using the
:og2elease:ineCount paraeter set in the TM1s.cfg fi!e. +or ore inforation@ see the T1s.cfg fi!e
topic in the IBM. Cognos. TM1 Installation and Configuration Guide.
83 of 425 26-09-2014 11:18
6.A.6. /ac"ing Out 2ecords from t%e Transaction :og
,fter 'ou Buer' the transaction !og@ 'ou can use the Transaction 6og ?uer' 0esu!ts dia!og "o# to "ac/ out
the transactions. When 'ou "ac/ out a transaction@ the va!ue in the O6(4,6-. co!un rep!aces the va!ue
in the N.W4,6-. co!un.
)rocedure
1igh!ight the recordGsI 'ou want to "ac/ out.
To high!ight an individua! record@ c!ic/ the record.
To high!ight u!tip!e ad<acent records@ c!ic/ the first record and *1I+TQc!ic/ the !ast record.
To high!ight u!tip!e non7ad<acent records@ CT06Qc!ic/ each record.
1.
C!ic/ 1dit@ Select.
,!! the high!ighted records now disp!a' a chec/ ar/ in the "o# ad<acent to the first co!un. The
chec/ ar/s indicate that the record is se!ected to "e "ac/ed out.
To se!ect a!! the records without first high!ighting the@ c!ic/ 1dit@ Select All.
2.
C!ic/ 1dit@ /ac" Out.
TM1F "ac/s out the records in reverse chrono!ogica! order as identified "' the 6OGTIM. co!un.
$.
84 of 425 26-09-2014 11:18
6.A.>. 2emo(ing :og Files from t%e .is"
The TM1F !og fi!es can ta/e up a su"stantia! aount of dis/ space after the server has "een running for
soe tie. Aou shou!d reove the o!d !og fi!es fro 'our dis/ ever' so often@ depending on the vo!ue
of the changes 'ou a/e and the si=e of 'our dis/. Aou can "ac/ up these fi!es "efore 'ou erase the.
(o not reove the !og fi!es when the TM1 server is running. +irst shut down the server@ and then de!ete
the !og fi!es fro 'our dis/.
85 of 425 26-09-2014 11:18
6.10. Monitoring Ser(er )erformance
TM1F inc!udes a perforance onitoring feature that !ets 'ou record the perforance statistics for
c!ients@ cu"es@ and servers. When 'ou ena"!e perforance onitoring@ TM1 popu!ates severa! contro!
cu"es on a inute7"'7inute "asis. Aou can then "rowse these cu"es to ana!'=e the server perforance.
The fo!!owing contro! cu"es are popu!ated during perforance onitoring. +or detai!s@ see Contro! Cu"es.
Cube .escription
D*tats)'C!ient Trac/s the essage count@ average essage si=e@ tota! e!apsed tie@ and
other easures for each c!ient on the server.
D*tats)'Cu"e Trac/s the eor' used for each cu"e on the server.
D*tats)'Cu"e)'C!ient Trac/s the nu"er and e!apsed tie of ce!! updates@ ce!! retrieva!s@ view
ca!cu!ations@ and view retrieva!s for each c!ient and cu"e on the server.
D*tats+or*erver Trac/s the connected c!ients@ active threads@ and eor' used "' the
server.
)rocedure
C!ic/ Ser(er@ Start )erformance Monitor.
Aou have ena"!ed perforance onitoring on a per7session "asis.
If 'ou want to ena"!e perforance onitoring at the start of ever' server session@ 'ou can set the
&erforanceMonitorOn paraeter in the T1s.cfg fi!e to autoatica!!' "egin perforance onitoring
when a server starts.
+or ore detai!s a"out configuration paraeters@ see the IBM Cognos TM1 Installation and
To end perforance onitoring during a server session>
2.
*e!ect the server in *erver .#p!orer. $.
C!ic/ Ser(er@ Stop )erformance Monitor. 2.
86 of 425 26-09-2014 11:18
6.11. Managing Client Connections
,s a TM1F server adinistrator@ 'ou can use the C!ients Messaging Center to anage c!ient connections.
Tas/s inc!ude>
)roadcasting Messages to C!ients
(isconnecting C!ients fro the *erver
*hutting (own a *erver 0eote!'
/roadcasting Messages to Clients
If 'ou are a e"er of the ,(MIN group for a TM1 server@ 'ou can "roadcast essages to an' c!ients
that are connected to the server. +or e#ap!e@ 'ou can infor c!ients that the' are going to "e
disconnected fro the server or that the server is going to "e shut down.
.isconnecting Clients from t%e Ser(er
Aou can disconnect c!ients fro a TM1 server.
S%utting .on a Ser(er 2emotely
Aou can shut down a server reote!' fro a TM1 c!ient.
87 of 425 26-09-2014 11:18
6.11.1. /roadcasting Messages to Clients
If 'ou are a e"er of the ,(MIN group for a TM1F server@ 'ou can "roadcast essages to an' c!ients
that are connected to the server. +or e#ap!e@ 'ou can infor c!ients that the' are going to "e
disconnected fro the server or that the server is going to "e shut down.
)rocedure
In the !eft pane of *erver .#p!orer@ se!ect the server on which 'ou want to "roadcast a essage. 1.
C!ic/ Ser(er@ Ser(er Manager.
The C!ients Messaging Center dia!og "o# opens.
2.
*e!ect .o not%ing to "roadcast the essage without shutting down the TM1 server. $.
*e!ect /roadcast a Message. 2.
.nter the essage 'ou want to "roadcast in the )roadcast Message "o#. 3.
C!ic/ Select Clients.
The *u"set .ditor opens with a su"set of a!! the c!ients that are current!' connected to the TM1
server. Aou cannot send essages to c!ients that are not current!' connected to the server.
8.
*e!ect the c!ients 'ou want to receive the essage and c!ic/ O;. 9.
C!ic/ O; in the C!ients Messaging Center to "roadcast the essage. :.
)arent topic* Managing C!ient Connections
88 of 425 26-09-2014 11:18
6.11.#. .isconnecting Clients from t%e Ser(er
Aou can disconnect c!ients fro a TM1F server.
)rocedure
In the !eft pane of *erver .#p!orer@ se!ect the server fro which 'ou want to disconnect c!ients. 1.
2.
*e!ect .isconnect Clients. $.
*pecif' a Minutes interva! to deterine when the c!ients wi!! "e disconnected. 2.
C!ic/ Select Clients.
The *u"set .ditor opens with a su"set of a!! c!ients that e#ist on the server. The su"set is not a
su"set of a!! c!ients current!' connected.
3.
*e!ect the c!ients 'ou want to disconnect and c!ic/ O;.
, essage is sent to a!! se!ected c!ients with a warning that the' wi!! "e disconnected at the interva!
'ou specified in *tep 2.
8.
If 'ou want to "roadcast a ore detai!ed essage to the se!ected c!ients@ 'ou can se!ect the
)roadcast Message to *e!ected C!ients option and enter a essage in the )roadcast Message "o#.
9.
C!ic/ O; in the C!ients Messaging Center. :.
89 of 425 26-09-2014 11:18
6.11.-. S%utting .on a Ser(er 2emotely
Aou can shut down a server reote!' fro a TM1F c!ient.
)rocedure
In the !eft pane of *erver .#p!orer@ se!ect the server 'ou want to shut down. 1.
2.
*e!ect S%utdon Ser(er. $.
*pecif' a Minutes interva! to deterine when the server wi!! "e shut down. 2.
C!ic/ O;.
,n' c!ients current!' connected to the server receive a essage that the server wi!! "e shut down in
the nu"er of inutes 'ou specified in *tep 2.
3.
90 of 425 26-09-2014 11:18
6.1#. 2emote Ser(er Memory Management
The TM1F server uses a sparse eor' anageent schee@ which a!!ows the server to ho!d ver' !arge
cu"es in uch !ess space than the sae data wou!d occup' in a re!ationa! data"ase. Therefore@ the
eor' anageent schee a!!ows the server to accoodate ver' !arge data"ases in 0,M without
the need to use dis/ space.
The 0,M that is used "' the server is not static. When the reote server ca!cu!ates the conso!idations@
the server stores the resu!ts for !ater reference. The second tie a conso!idated va!ue is reBuested@ TM1
can de!iver the va!ue without ca!cu!ation@ which provides a great iproveent in speed.
The reote server eor' anageent approach eans that the !onger the server runs@ the faster it
"ecoes@ as an ever7increasing nu"er of conso!idations are stored and do not need to "e reca!cu!ated.
The aount of eor' the server uses increases increenta!!'. The server does not ta/e eor'
"'te7"'7"'te@ "ut rather ta/es a !arger piece ever' so often.
TM1 does not re!ease the eor' "ac/ to the operating s'ste unti! the TM1 server is terinated.
Instead@ TM1 puts eor' it no !onger needs into a gar"age !ist@ to "e reused as reBuired. ,ccording!'@
the eor' consuption for the TM1 server@ as reported "' the operating s'ste@ is the tota! of the
actua! current eor' usage and the gar"age eor'. Aou can view an accurate report of the actua!
eor' usage and gar"age eor' "' viewing the D*tats+or*erver contro! cu"e@ which is descri"ed in
Contro! Cu"es.
,!! the reote server p!atfors support virtua! eor'@ where dis/ space is used as if it were 0,M. The
server runs in virtua! eor'@ "ut it s!ows down the perforance significant!'. The "est practice is for
'ou to /eep a!! the cu"es in rea! 0,M at a!! ties.
Aou shou!d /eep an e'e on the eor' consuption "' using the s'ste7onitoring uti!ities. If the
s'ste runs s!ow!'@ 'ou ight need to add ore 0,M to 'our server.
*oe operating s'stes aintain a configura"!e !iit on the eor' the' wi!! a!!ocate to an' one
process. If 'our s'ste appears una"!e to ta/e a!! the eor' that shou!d "e avai!a"!e to it@ 'ou ight
want to !oo/ at the operating s'ste paraeters.
Aou can !iit the aount of eor' a!!ocated to an' individua! view "' adding the Ma#iu4iew*i=e
paraeter to the T1s.cfg server configuration fi!e. +or ore detai!s a"out configuration paraeters@ see
the IBM Cognos TM1 Installation and Configuration Guide.
About Stargate 5ies
, *targate view is a ca!cu!ated and stored su"section of a TM1 cu"e that TM1 creates when 'ou
"rowse a cu"e with the Cu"e 4iewer or In7*preadsheet )rowser. The purpose of a *targate view is to
a!!ow Buic/er access to the cu"e data.
91 of 425 26-09-2014 11:18
6.1#.1. About Stargate 5ies
, *targate view is a ca!cu!ated and stored su"section of a TM1F cu"e that TM1 creates when 'ou "rowse
a cu"e with the Cu"e 4iewer or In7*preadsheet )rowser. The purpose of a *targate view is to a!!ow
Buic/er access to the cu"e data.
, *targate view is different fro a TM1 view o"<ect. The *targate view contains on!' the data for a
defined section of a cu"e@ and does not contain the foratting inforation and "rowser settings that are
in a view o"<ect.
, *targate view that TM1 creates when 'ou "rowse a cu"e in the Cu"e 4iewer or In7*preadsheet )rowser
contains on!' the data defined "' the current tit!e e!eents and row and co!un su"sets.
TM1 stores a *targate view when 'ou access a view that ta/es !onger to retrieve than the thresho!d
defined "' the 4MT propert' in the DCu"e&roperties contro! cu"e. GIf a 4MT va!ue is not e#p!icit!' defined@
a *targate view is generated when a view ta/es !onger than five seconds. This is the defau!t thresho!d
when 4MT is not specified in the DCu"e&roperties contro! cu"e.I
, *targate view persists in eor' on!' as !ong as the "rowser view fro which it originates reains
unchanged. When 'ou reca!cu!ate the "rowser view@ TM1 creates a new *targate view "ased on the
reca!cu!ated view and rep!aces the e#isting *targate view in eor'. When 'ou c!ose the "rowser view@
TM1 reoves the *targate view fro eor'.
)arent topic* 0eote *erver Meor' Manageent
92 of 425 26-09-2014 11:18
6.1-. 0sing TM1 in /ul" :oad Mode
)u!/ 6oad Mode ena"!es I)MF CognosF TM1F to run in a specia! optii=ed sing!e7user or sing!e
choreHprocess ode. This ode can a#ii=e Cognos TM1 perforance for dedicated tas/s during ties
when !itt!e or no other activit' is e#pected.
*oe e#ap!es of using )u!/ 6oad Mode inc!ude>
Cognos TM1 adinistrators that needs to anua!!' perfor aintenance operations.
, night7tie window to !oad !arge aounts of data.
Cognos TM1 t'pica!!' runs in a u!ti7user ode where u!tip!e users@ chores and processes can a!! run
concurrent!' accessing Cognos TM1 data. In )u!/ 6oad Mode@ the Cognos TM1 server prevents concurrent
activit' "' teporari!' suspending other users@ chores and processes and e!iinates the overhead
reBuired "' a u!ti7user environent.
)u!/ 6oad Mode doesn't actua!!' !og out users@ "ut on!' suspends their interaction with Cognos TM1 . ,s
soon as )u!/ 6oad Mode is done@ an' users that were previous!' !ogged in are reactivated and
user7interaction with Cognos TM1 resues.
Aou can ena"!e )u!/ 6oad Mode direct!' within a TI process or with the TM1 ,&I. In either case@ 'ou use
coands to enter and !eave )u!/ 6oad Mode.
Considerations for 0sing /ul" :oad Mode
Aou shou!d consider the fo!!owing when using )u!/ 6oad Mode.
TM1 C A)I
-se the fo!!owing TM1 ,&I functions to ena"!e and disa"!e )u!/ 6oad Mode.
TurboIntegrator )rocess Commands
Aou can ena"!e )u!/ 6oad Mode in either the &ro!og or .pi!og section of a TI process. +or efficienc'@
we recoend ena"!ing )u!/ 6oad Mode in the first@ or ver' c!ose to the first@ stateent in the &ro!og
section of 'our process.
93 of 425 26-09-2014 11:18
6.1-.1. Considerations for 0sing /ul" :oad Mode
Aou shou!d consider the fo!!owing when using )u!/ 6oad Mode.
)u!/ 6oad Mode does not disp!a' a essage to end7users to a!ert the. Aou wi!! need to p!an and
coordinate 'our usage of )u!/ 6oad Mode according!'.
On!' a sing!e user or process a' "e active during )u!/ 6oad Mode. No new connections can "e
esta"!ished to the server whi!e it is operating in )u!/ 6oad Mode.
, TI process can not use the ExecuteCommand to !aunch a coand !ine progra that attepts to !og
"ac/ into the sae CognosF TM1F server. The !ogin attept wi!! fai!.
,n' schedu!ed chores that are schedu!ed to e#ecute during the tie )u!/ 6oad Mode is ena"!ed are
deactivated and not run.
Starting /ul" :oad Mode
When the server enters )u!/ 6oad Mode@ a!! processing "' other threads is paused.
1nding /ul" :oad Mode
When )u!/ 6oad Mode is disa"!ed@ a!! s'ste and user threads wi!! "e resued and user !ogins wi!! "e
a!!owed.
)arent topic* -sing TM1 in )u!/ 6oad Mode
94 of 425 26-09-2014 11:18
6.1-.1.1. Starting /ul" :oad Mode
When the server enters )u!/ 6oad Mode@ a!! processing "' other threads is paused.
,n' e#isting user threads and running chores wi!! "e suspended. On!' the thread that initiated )u!/ 6oad
Mode wi!! reain active. ,!! schedu!ed chores wi!! "e deactivated@ e#cept the chore that initiates )u!/
6oad Mode. ,!! s'ste7specific threads and TM1Top connections wi!! a!so "e suspended.
)arent topic* Considerations for -sing )u!/ 6oad Mode
95 of 425 26-09-2014 11:18
6.1-.1.#. 1nding /ul" :oad Mode
When )u!/ 6oad Mode is disa"!ed@ a!! s'ste and user threads wi!! "e resued and user !ogins wi!! "e
a!!owed.
Custo app!ications that use the TM1F ,&I to ena"!e )u!/ 6oad Mode shou!d a!so ca!! the necessar' TM1
,&I function to e5it )u!/ 6oad Mode. 1owever@ if the c!ient connection is severed Gthe networ/ fai!s or the
c!ient !ogs out@ crashes or disconnectsI@ the server wi!! autoatica!!' e#it )u!/ 6oad Mode.
*ii!ar!'@ if a TI processHchore is running in )u!/ 6oad Mode and the process e#its@ whether successfu!!'
or with errors@ the server wi!! autoatica!!' e#it )u!/ 6oad Mode.
When the server returns to nora! u!ti7user ode@ an' chores that were deactivated get reactivated
and return to their nora! schedu!e. If the chores were schedu!ed to run@ "ut were prevented "' )u!/
6oad Mode@ the' wi!! not get e#ecuted iediate!'@ "ut wi!! e#ecute according to the schedu!e. Aou a'
have to ad<ust the !aunch tie of 'our schedu!ed chores to prevent the fro getting !oc/ed out during
the ties 'ou ena"!e )u!/ 6oad Mode.
)arent topic* Considerations for -sing )u!/ 6oad Mode
96 of 425 26-09-2014 11:18
6.1-.#. TM1 C A)I
-se the fo!!owing TM1F ,&I functions to ena"!e and disa"!e )u!/ 6oad Mode.
TM1V TM1ServerEnableBulkLoadMode(TM1P hPool, TM1Server hServer)
TM1V TM1ServerDisableBulkLoadMode(TM1P hPool, TM1Server hServer)
where>
TM1P is a poo! hand!e o"tained with TM1ValPoolCreate.
TM1Server is a hand!e to the current server.
97 of 425 26-09-2014 11:18
6.1-.-. TurboIntegrator )rocess Commands
Aou can ena"!e )u!/ 6oad Mode in either the &ro!og or .pi!og section of a TI process. +or efficienc'@ we
recoend ena"!ing )u!/ 6oad Mode in the first@ or ver' c!ose to the first@ stateent in the &ro!og
section of 'our process.
,fter ena"!ing )u!/ 6oad Mode in a process@ it can on!' "e disa"!ed on the !ast !ine in the .pi!og section. If
'ou attept to disa"!e )u!/ 6oad Mode an'where e!se in the process@ the process wi!! not copi!e.
If the ode is ena"!ed in one TI process@ it reains ena"!ed unti! e#p!icit!' disa"!ed or unti! the chore
cop!etes. This eans 'ou can ena"!e the ode in a process within a chore and then run a series of TI
processes "efore disa"!ing it. Aou can a!so enter and e#it )u!/ 6oad Mode repeated!'@ using the ode on!'
for certain critica! parts of a chore.
-se the fo!!owing TI coands to ena"!e and disa"!e )u!/ 6oad Mode in a TI process.
EnableBulkLoadMode()
DisableBulkLoadMode() 7 This function can on!' "e used on the !ast !ine in the .pi!og section of 'our TI
process when using )u!/ 6oad Mode.
98 of 425 26-09-2014 11:18
>. TM1 Security O(er(ie
Aou can contro! access and authentication to the servers.
The securit' features in I)MF CognosF TM1F ena"!e 'ou to contro! authentication and o"<ect securit'.
This defines who !ogs in to 'our I)M Cognos TM1 server and which o"<ects those users are a!!owed to
access.
+or cop!ete detai!s a"out configuring authentication securit'@ see the IBM Cognos TM1 Installation and
O(er(ie to aut%entication
Aou can configure the I)M Cognos TM1 server to use a specific authentication ode to contro! user
!ogin access.
TM1 Ob8ect Security
,s the TM1 adinistrator@ 'ou can contro! access to TM1 o"<ects "' assigning specific !eve!s of o"<ect
securit' to TM1 groups.
99 of 425 26-09-2014 11:18
>.1. O(er(ie to aut%entication
Aou can configure the I)MF CognosF TM1F server to use a specific authentication ode to contro! user
!ogin access.
)' defau!t@ when 'ou insta!! the Cognos TM1 server it is configured to use the standard Cognos TM1
authentication.
,fter 'ou insta!! the Cognos TM1 server@ 'ou can change the authentication ethod "' changing the
paraeters in the TM1 configuration fi!es.
Ta"!e 1. Cognos TM1 server authentication ethods
Aut%entication Met%ods .escription
TM1 Aut%entication Cognos TM1 server as/s 'ou for a user nae and password@ and
va!idates the !ogin inforation against the securit' cu"e !ogin
inforation.
Integrated :ogin Microsoft Windows perfors the Cognos TM1 authentication.
:.A) Aut%entication Cognos TM1 server as/s 'ou for a user nae and password@ and
va!idates the !ogin inforation against an e#terna! 6(,& server.
I/M Cognos Security The Cognos TM1 server authenticates users using I)M Cognos securit'.
)arent topic* TM1 *ecurit' Overview
100 of 425 26-09-2014 11:18
>.#. TM1 Ob8ect Security
,s the TM1F adinistrator@ 'ou can contro! access to TM1 o"<ects "' assigning specific !eve!s of o"<ect
securit' to TM1 groups.
*uppose 'ou have a group naed .#ecutives in 'our TM1 data"ase. Aou want these e#ecutives to review
the copan' "udget suar' data@ which is stored in the )ud*uar' cu"e in 'our TM1 data"ase. Aou
can use TM1 to assign the .#ecutives group 0ead privi!eges to the )ud*uar' cu"e.
Aou set TM1 access contro! the sae wa' for an' of the products in the TM1 suite. +or e#ap!e@ if users
in the .#ecutives group have 0ead access to the )ud*uar' cu"e when the' run TM1 &erspectives @
the' a!so have 0ead access to that cu"e when the' run the TM1 We" c!ient.
+or ore inforation a"out the procedures reBuired to set securit' for TM1 o"<ects@ see the I)MF
CognosF TM1 Developer Guide.
)arent topic* TM1 *ecurit' Overview
101 of 425 26-09-2014 11:18
?. Managing 0sers and Groups
This section e#p!ains how to anage users and groups in I)MF CognosF TM1F . In TM1 @ securit' is
"ased on the groups users "e!ong to.
TM1 0sers and Groups Security O(er(ie
TM1 anages securit' "' organi=ing TM1 users into groups. TM1 inc!udes a set of three predefined
adinistrative groups and a!so a!!ows 'ou to create 'our own custo groups. -sers can "e!ong to
one or u!tip!e groups.
0nderstanding Administrati(e Groups and Aut%ority
TM1 supports the separation of adinistrative duties and ro!es in TM1 "' dividing adinistrative
users into the fo!!owing predefined adinistrator groups>
Adding and .eleting 0sers and Groups
Aou can add and de!ete users and groups on the TM1 server.
Assigning 0sers to Groups
Aou can assign users to a groups.
Securing TM1 .ata
)ecause 'our copan' uses TM1 for high7!eve! p!anning and ana!'sis@ TM1 data can "e sensitive and
confidentia!.
Setting and Clearing )assords
Aou can set@ c!ear@ and change passwords for users.
Setting an 1+piration for a 0ser
When 'ou add a user to TM1 @ 'ou can set a !iit on the nu"er of da's the user can access the
server.
102 of 425 26-09-2014 11:18
?.1. TM1 0sers and Groups Security O(er(ie
TM1F anages securit' "' organi=ing TM1 users into groups. TM1 inc!udes a set of three predefined
adinistrative groups and a!so a!!ows 'ou to create 'our own custo groups. -sers can "e!ong to one or
u!tip!e groups.
TM1 has two a<or t'pes of user groups>
Administrati(e Groups 7 Inc!udes on!' the predefined groups of ,(MIN@ (ata,din and
*ecurit',din. +or ore detai!s@ see J-nderstanding ,dinistrative Groups and ,uthorit'J.
0ser Groups 7 Inc!udes a!! user7created groups@ which t'pica!!' contain non7adinistrative TM1
users.
Aou can use the TM1 C!ientsHGroups "o# to anage TM1 users and groups. The C!ientsHGroups dia!og "o#
organi=es groups and users separate!'.
,s a TM1 adinistrator@ 'ou ust "e running TM1 ,rchitect or TM1 &erspectives on 'our achine to
adinister securit' on the I)MF CognosF TM1 server .
Implementing a TM1 Security Sc%eme
Aou can ip!eent a TM1 securit' schee to secure o"<ects on a reote server@ in the fo!!owing wa'>
TM1 0ser and Group Security 1+amples
To i!!ustrate I)M Cognos TM1 securit' and a!!ow 'ou to e#perient with securit' features@ the TM1
sap!e data G*dataI that is insta!!ed with the I)M Cognos TM1 server coes with a set of pre7defined
groups and users.
)arent topic* Managing -sers and Groups
103 of 425 26-09-2014 11:18
?.1.1. Implementing a TM1 Security Sc%eme
Aou can ip!eent a TM1F securit' schee to secure o"<ects on a reote server@ in the fo!!owing wa'>
)rocedure
(efine securit' groups. 1.
,ssign access rights to the groups. 2.
(efine the TM1 users. $.
,ssign users to groups.
The securit' !eve!s 'ou can ip!eent are>
Cu"e7!eve! securit' 7 Contro!s access to cu"es.
.!eent7!eve! securit' 7 Contro!s access to the ce!!s identified "' e!eents.
(iension7!eve! securit' 7 Contro!s the a"i!it' to add@ reove@ and reorder the e!eents in a
diension. This t'pe of securit' is independent of cu"e7!eve! and e!eent7!eve! securit'@ e#cept
when users have no access to a diension.
Ce!!7!eve! securit' 7 Contro!s access to a ce!!.
'ote* , TM1 c!ient and server counicate direct!' over the networ/ using a TM1 usernae and
password. This securit' is cop!ete!' independent of standard fi!e s'ste securit' and is not affected
"' user rights on networ/ directories or fi!e servers.
2.
)arent topic* TM1 -sers and Groups *ecurit' Overview
104 of 425 26-09-2014 11:18
?.1.#. TM1 0ser and Group Security 1+amples
To i!!ustrate I)MF CognosF TM1F securit' and a!!ow 'ou to e#perient with securit' features@ the TM1
sap!e data G*dataI that is insta!!ed with the I)M Cognos TM1 server coes with a set of pre7defined
groups and users.
To view these groups and users@ right7c!ic/ the *data server in the *erver .#p!orer and c!ic/ Security L
Clients=Groups.
The TM1 C!ientsHGroups dia!og "o# appears.
The fo!!owing ta"!e contains the passwords for the sap!e users.
'ote* &asswords are hidden in the C!ientsHGroups window and disp!a' as either (efined or -ndefined.
0ser 'ame )assord Group Members%ip
,din app!e ,(MIN
-sr1 red North ,erica
-sr2 orange *outh ,erica
-sr$ "!ue North ,erica and *outh ,erica
)arent topic* TM1 -sers and Groups *ecurit' Overview
105 of 425 26-09-2014 11:18
?.#. 0nderstanding Administrati(e Groups and Aut%ority
TM1F supports the separation of adinistrative duties and ro!es in TM1 "' dividing adinistrative users
into the fo!!owing predefined adinistrator groups>
A.MI' group 7 Me"ers of the ,(MIN group have access to a!! areas of TM1 and represent
super7users with a!! privi!eges.
.ataAdmin group 7 Me"ers in the (ata,din group have ,(MIN privi!eges to ever'thing that is
not re!ated to securit'. This group can view@ edit and save TM1 o"<ects@ such as cu"es@ diensions@
ru!es and processes@ Me"ers in this group can view securit' settings in read7on!' ode "ut are not
a!!owed to odif' securit' settings.
SecurityAdmin group 7The *ecurit',din group can on!' perfor securit' operations in TM1 . This
inc!udes creating@ editing and de!eting TM1 users and groups. This group can anage the access
rights of other users to TM1 o"<ects@ such as cu"es@ diensions and ru!es@ "ut this group can not
view the data in those sae TM1 o"<ects.
The securit' assignents for these three adinistrator groups are hard7coded and can not "e odified.
Aou can use these predefined adinistrator groups to contro! and separate TM1 adinistrative ro!es
aong different users to satisf' interna! or e#terna! securit' reBuireents and ru!es.
'ote* 0ep!ication and s'nchroni=ation operations in TM1 shou!d on!' "e perfored "' e"ers of the
,(MIN group. Me"ers of the (ata,din and *ecurit',din groups do not have a!! the reBuired access
privi!eges to perfor these operations.
The fo!!owing sections provide detai!s a"out each adinistrative group.
A.MI' Group
The ,(MIN group@ which is created for adinistrative purposes on!'@ shou!d contain on!' a ver' sa!!
group of trusted TM1 adinistrators.
SecurityAdmin Group
The *ecurit',din group can on!' perfor securit' operations in TM1 . Me"ers can access the
securit' re!ated features of TM1 @ "ut can not view the data in non7securit' TM1 o"<ects@ such as
cu"es@ diensions and ru!es. The e"ers in this group are a!!owed to create@ edit and de!ete TM1
users and groups. ,dditiona!!'@ these users can anage the access rights of other users to TM1
o"<ects such as cu"es and diensions.
.ataAdmin Group
Me"ers in the (ata,din group have ,(MIN privi!eges to ever'thing that is not re!ated to securit'.
-sers in this group can view@ edit and save TM1 o"<ects@ inc!uding cu"es@ diensions@ ru!es and
processes. The (ata,din group can view securit' settings in read7on!' ode@ "ut is not a!!owed to
odif' an' securit' settings.
106 of 425 26-09-2014 11:18
?.#.1. A.MI' Group
The ,(MIN group@ which is created for adinistrative purposes on!'@ shou!d contain on!' a ver' sa!!
group of trusted TM1F adinistrators.
Me"ers of the ,(MIN group a!wa's have the highest !eve! of securit' for a!! o"<ects on the reote
server@ and can do the fo!!owing>
,ssign and revo/e other user's access rights.
Create and de!ete cu"es@ diensions@ e!eents@ processes@ and chores.
,dd@ reove@ and reorder e!eents in a diension.
Change cu"e data.
Create and de!ete pu"!ic views and su"sets.
0eserve and !oc/ cu"es@ e!eents@ and diensions@ so that other users cannot update the.
0eove reservations and !oc/s fro cu"es@ e!eents@ and diensions.
Create rep!icated o"<ects on the server.
Change TM1 ce!! securit'.
Create and de!ete TM1 ru!es.
Roint e"ership in the ,(MIN group and *ecurit',din group or the ,(MIN group and the (ata,din
group is treated as ,(MIN.
Me"ers of the ,(MIN group are the on!' TM1 users that can add users to the ,(MIN group.
)arent topic* -nderstanding ,dinistrative Groups and ,uthorit'
107 of 425 26-09-2014 11:18
?.#.#. SecurityAdmin Group
The *ecurit',din group can on!' perfor securit' operations in TM1F . Me"ers can access the
securit' re!ated features of TM1 @ "ut can not view the data in non7securit' TM1 o"<ects@ such as cu"es@
diensions and ru!es. The e"ers in this group are a!!owed to create@ edit and de!ete TM1 users and
groups. ,dditiona!!'@ these users can anage the access rights of other users to TM1 o"<ects such as
cu"es and diensions.
If integrated !ogin is not "eing used@ the securit' adinistrator is a!so a"!e to reset user passwords.
,s a e"er of the *ecurit',din group@ 'ou can anage TM1 securit' using the fo!!owing too!s in
*erver .#p!orer>
C!ientsHGroups window 7 ,ssign TM1 c!ients to TM1 groups.
*ecurit' ,ssignents windows 7 Contro! user access to TM1 o"<ects such as cu"es@ diensions and
processes.
*ecurit' contro! cu"es 7 Manua!!' app!' securit' privi!eges for TM1 o"<ects and user groups.
2estrictions on 2eplication and Sync%roni7ation
Me"ers of the *ecurit',din group do not have a!! the reBuired access privi!eges to perfor
rep!ication and s'nchroni=ation operations in TM1 and shou!d not attept to perfor these
operations.
2estrictions for 2ules and )rocesses
Me"ers in the *ecurit',din group can not write or odif' ru!es and processes. The' can not view
ru!es@ "ut can view processes in read7on!' ode.
Combining SecurityAdmin Members%ip it% Ot%er Groups
Me"ership in the *ecurit',din group is not intended to "e co"ined with e"ership in the
(ata,din group or an' other user group. The *ecurit',din is restricted fro accessing
non7securit' o"<ects and these restrictions a!wa's app!' regard!ess of what other groups the user
"e!ongs to. ,dditiona!!'@ TM1 does not a!!ow users to "e added to an' other user group after the'
have "een assigned to the *ecurit',din group.
0sing t%e SecurityAdmin Group it% t%e TM1 C A)I
The TM1 C ,&I does not a!!ow prograers to configure <oint e"ership with the *ecurit',din
group. The C!ientGroup,ssign function re<ects an' attept to p!ace a user that is a e"er of the
*ecurit',din group into another group.
2estrictions on Adding 0sers to t%e A.MI' Group
Me"ers of the *ecurit',din group are not a!!owed to add users to the ,(MIN group. On!'
e"ers in the fu!! ,(MIN group can add other users to the ,(MIN group. This prevents the
*ecurit',din fro creating a user account in the ,(MIN group that the' cou!d then use with fu!!
adinistrative privi!eges.
108 of 425 26-09-2014 11:18
?.#.#.1. 2estrictions on 2eplication and Sync%roni7ation
Me"ers of the *ecurit',din group do not have a!! the reBuired access privi!eges to perfor rep!ication
and s'nchroni=ation operations in TM1F and shou!d not attept to perfor these operations.
)arent topic* *ecurit',din Group
109 of 425 26-09-2014 11:18
?.#.#.#. 2estrictions for 2ules and )rocesses
Me"ers in the *ecurit',din group can not write or odif' ru!es and processes. The' can not view
ru!es@ "ut can view processes in read7on!' ode.
+or ore detai!s a"out processes@ see the I)MF CognosF TM1F Developers Guide.
110 of 425 26-09-2014 11:18
?.#.#.-. Combining SecurityAdmin Members%ip it% Ot%er Groups
Me"ership in the *ecurit',din group is not intended to "e co"ined with e"ership in the
(ata,din group or an' other user group. The *ecurit',din is restricted fro accessing non7securit'
o"<ects and these restrictions a!wa's app!' regard!ess of what other groups the user "e!ongs to.
,dditiona!!'@ TM1F does not a!!ow users to "e added to an' other user group after the' have "een
assigned to the *ecurit',din group.
These restrictions prevent the *ecurit',din fro adding hi or herse!f to another group to gain access
to data or operations that are not a!!owed for the *ecurit',din.
111 of 425 26-09-2014 11:18
?.#.#.4. 0sing t%e SecurityAdmin Group it% t%e TM1 C A)I
The TM1F C ,&I does not a!!ow prograers to configure <oint e"ership with the *ecurit',din
group. The C!ientGroup,ssign function re<ects an' attept to p!ace a user that is a e"er of the
*ecurit',din group into another group.
112 of 425 26-09-2014 11:18
?.#.#.6. 2estrictions on Adding 0sers to t%e A.MI' Group
Me"ers of the *ecurit',din group are not a!!owed to add users to the ,(MIN group. On!' e"ers in
the fu!! ,(MIN group can add other users to the ,(MIN group. This prevents the *ecurit',din fro
creating a user account in the ,(MIN group that the' cou!d then use with fu!! adinistrative privi!eges.
113 of 425 26-09-2014 11:18
?.#.-. .ataAdmin Group
Me"ers in the (ata,din group have ,(MIN privi!eges to ever'thing that is not re!ated to securit'.
-sers in this group can view@ edit and save TM1F o"<ects@ inc!uding cu"es@ diensions@ ru!es and
processes. The (ata,din group can view securit' settings in read7on!' ode@ "ut is not a!!owed to
odif' an' securit' settings.
+or e#ap!e@ as a e"er of the (ata,din group@ 'ou can open the C!ientsHGroups window or an' of
the *ecurit' ,ssignents windows for TM1 o"<ects Gcu"es@ diensions@ processesI@ however these
windows disp!a' in read7on!' ode and 'ou can not a/e changes.
Members%ip in 0ser Groups
Co"ined e"ership in the (ata,din group and an' other user group is a!!owed. 1owever@ this
co"ination is treated as the (ata,din group. ,n' restrictions iposed "' the user group access
are overridden "' the (ata,din access.
Members%ip in bot% t%e SecurityAdmin and .ataAdmin Groups
Me"ership in the (ata,din group is not intended to "e co"ined with e"ership in the
*ecurit',din group.
2estrictions on 2eplication and Sync%roni7ation
Me"ers of the (ata,din group do not have a!! the reBuired access privi!eges to perfor rep!ication
and s'nchroni=ation operations in TM1 and shou!d not attept to perfor these operations.
2estrictions on 2ules for Security Control Cubes
, (ata,din can not create ru!es on securit' contro! cu"es. This restriction prevents a (ata,din
fro creating a ru!e that cou!d odif' ce!!s in a securit' contro! cu"e.
114 of 425 26-09-2014 11:18
?.#.-.1. Members%ip in 0ser Groups
Co"ined e"ership in the (ata,din group and an' other user group is a!!owed. 1owever@ this
co"ination is treated as the (ata,din group. ,n' restrictions iposed "' the user group access are
overridden "' the (ata,din access.
+or e#ap!e@ if a user is a e"er of the (ata,din group and a user group@ and that user group does
not have securit' rights to a cu"e@ the user wi!! sti!! "e a"!e to see the cu"e "ased on their (ata,din
rights.
)arent topic* (ata,din Group
115 of 425 26-09-2014 11:18
?.#.-.#. Members%ip in bot% t%e SecurityAdmin and .ataAdmin Groups
Me"ership in the (ata,din group is not intended to "e co"ined with e"ership in the
*ecurit',din group.
If a user "e!ongs to "oth the (ata,din group and the *ecurit',din group@ their securit' rights are
*ecurit',din on!'. )eing a e"er in "oth the *ecurit',din and (ata,din group a!!ows the user to
view and edit securit' settings for the users and groups.
116 of 425 26-09-2014 11:18
?.#.-.-. 2estrictions on 2eplication and Sync%roni7ation
Me"ers of the (ata,din group do not have a!! the reBuired access privi!eges to perfor rep!ication
and s'nchroni=ation operations in TM1F and shou!d not attept to perfor these operations.
117 of 425 26-09-2014 11:18
?.#.-.4. 2estrictions on 2ules for Security Control Cubes
, (ata,din can not create ru!es on securit' contro! cu"es. This restriction prevents a (ata,din fro
creating a ru!e that cou!d odif' ce!!s in a securit' contro! cu"e.
118 of 425 26-09-2014 11:18
?.-. Adding and .eleting 0sers and Groups
Aou can add and de!ete users and groups on the TM1F server.
Adding a 0ser
To add a user@ cop!ete the fo!!owing steps.
Adding a Group
The I)M Cognos TM1 server can contain up to 83@3$3 groups. The GroupsCreation6iit paraeter in
the server's TM1s.cfg fi!e deterines the nu"er of groups 'ou can create during a sing!e TM1 server
session.
.eleting a 0ser
To de!ete a user@ cop!ete the fo!!owing steps.
.eleting a Group
To de!ete a group@ cop!ete the fo!!owing steps.
119 of 425 26-09-2014 11:18
?.-.1. Adding a 0ser
To add a user@ cop!ete the fo!!owing steps.
)rocedure
Open the *erver .#p!orer. 1.
*e!ect the icon for the server 'ou are wor/ing with. 2.
0ight7c!ic/ the icon and c!ic/ Security L Clients=Groups.
The C!ientsHGroups dia!og "o# opens.
$.
C!ic/ Clients L Add 'e Client.
The Creating New C!ient dia!og "o# opens.
2.
.nter the nae of the new user in the .nter New C!ient Nae "o#.
'ote* TM1F ignores spaces in user naes and passwords. +or e#ap!e@ TM1 treats Mc Coric/ with
a space and the nae McCoric/ without a space as the sae nae.
3.
C!ic/ O;.
TM1 adds the user as a new row in the C!ientsHGroups grid.
When 'ou first add a new user@ the user is granted defau!t o"<ect securit' privi!eges according to the
fo!!owing ru!es>
If user groups are a!read' defined for 'our server@ the new user has None privi!ege to a!! o"<ects
on the server. Aou ust assign the user to a group to a!!ow access to TM1 o"<ects.
If user groups are not defined for 'our server@ the new user has Write privi!ege to a!! o"<ects on
the server.
8.
)arent topic* ,dding and (e!eting -sers and Groups
120 of 425 26-09-2014 11:18
?.-.#. Adding a Group
The I)MF CognosF TM1F server can contain up to 83@3$3 groups. The GroupsCreation6iit paraeter
in the server's TM1s.cfg fi!e deterines the nu"er of groups 'ou can create during a sing!e TM1 server
session.
)rocedure
*e!ect the icon for the server 'ou are wor/ing with. 2.
0ight7c!ic/ the server icon@ and c!ic/ Security L Clients=Groups.
The C!ientsHGroups dia!og "o# disp!a's.
$.
C!ic/ Groups L Add 'e Group.
The Creating New Group dia!og "o# disp!a's.
2.
.nter the nae of the new group in the .nter New Group Nae "o#. 3.
C!ic/ O;.
TM1 adds the group as a new co!un in the C!ientsHGroups dia!og "o#.
'ote* )' defau!t@ 'ou can add up to 20 groups per session. To increase the nu"er of groups 'ou
can add per session@ change the va!ue of the GroupsCreation6iit paraeter in the TM1s.cfg fi!e.
+or ore detai!s a"out configuration paraeters@ see the IBM Cognos TM1 Installation and
8.
121 of 425 26-09-2014 11:18
?.-.-. .eleting a 0ser
To de!ete a user@ cop!ete the fo!!owing steps.
)rocedure
+ro the *erver .#p!orer@ right7c!ic/ the server icon@ and c!ic/ Security L Clients=Groups. 1.
In the Clients=Groups dia!og "o#@ c!ic/ the user 'ou want to de!ete. 2.
C!ic/ Clients L .elete Client. $.
C!ic/ Bes to confir the de!etion. 2.
122 of 425 26-09-2014 11:18
?.-.4. .eleting a Group
To de!ete a group@ cop!ete the fo!!owing steps.
)rocedure
In the Clients=Groups dia!og "o#@ c!ic/ a ce!! in the co!un that represents the group 'ou want to
de!ete.
2.
C!ic/ Groups L .elete Group. $.
C!ic/ Bes to confir the de!etion. 2.
123 of 425 26-09-2014 11:18
?.4. Assigning 0sers to Groups
Aou can assign users to a groups.
)rocedure
In the Clients=Groups dia!og "o#@ c!ic/ the chec/ "o# at the intersection of the user nae and the
group nae.
2.
C!ic/ O;. $.
Members%ip in Multiple Groups
, user who is a e"er of u!tip!e groups receives the highest !eve! of rights fro a!! groups.
124 of 425 26-09-2014 11:18
?.4.1. Members%ip in Multiple Groups
, user who is a e"er of u!tip!e groups receives the highest !eve! of rights fro a!! groups.
+or e#ap!e@ in the sap!e data@ -sr$ is a e"er of two groups.
North ,erica@ which has Write access to the Canada@ Me#ico@ and -nited *tates e!eents in the
0egion diension@ and 0ead access to the other e!eents in the 0egion diension.
*outh ,erica@ which has Write access to the ,rgentina@ )ra=i!@ Chi!e@ and -rugua' e!eents in the
0egion diension@ and 0ead access to the other e!eents in the 0egion diension.
TM1F gives -sr$Write access to the ,rgentina@ )ra=i!@ Canada@ Chi!e@ Me#ico@ -nited *tates@ and -rugua'
e!eents@ and 0ead access to the other e!eents in the 0egion diension.
)arent topic* ,ssigning -sers to Groups
125 of 425 26-09-2014 11:18
?.6. Securing TM1 .ata
)ecause 'our copan' uses TM1F for high7!eve! p!anning and ana!'sis@ TM1 data can "e sensitive and
confidentia!.
TM1 provides a!! the too!s 'ou need to secure 'our data@ "ut as with an' securit' s'ste@ rea! securit' is
on!' as good as the procedures 'ou ip!eent. We suggest ip!eenting the fo!!owing procedures to
enhance TM1 securit'>
2estricting Access to t%e .ata .irectory
-sing 'our networ/ fi!e s'ste securit'@ 'ou shou!d a!wa's protect the data director' so it is invisi"!e
to ever'one "ut the networ/ !ogin used "' the server itse!f.
Assigning )assords
Me"ers of the ,(MIN group have rights sii!ar to those of super users or root users on networ/
s'stesN the' can go an'where and do an'thing.
0sing Standard Security for )assords
Treat TM1 passwords the sae wa' as other networ/ passwords.
126 of 425 26-09-2014 11:18
?.6.1. 2estricting Access to t%e .ata .irectory
-sing 'our networ/ fi!e s'ste securit'@ 'ou shou!d a!wa's protect the data director' so it is invisi"!e to
ever'one "ut the networ/ !ogin used "' the server itse!f.
No atter how e!a"orate the securit' on the server@ if users can see the data director'@ the' can view
data using TM1F direct!' fro the dis/@ without connecting to the TM1 server .
)arent topic* *ecuring TM1 (ata
127 of 425 26-09-2014 11:18
?.6.#. Assigning )assords
Me"ers of the ,(MIN group have rights sii!ar to those of super users or root users on networ/
s'stesN the' can go an'where and do an'thing.
Give out ,(MIN passwords carefu!!'@ and "e sure ,(MIN users /now the' shou!d not revea! or share their
passwords with an'one.
128 of 425 26-09-2014 11:18
?.6.-. 0sing Standard Security for )assords
Treat TM1F passwords the sae wa' as other networ/ passwords.
)e sure that users /now not to share passwords. ,!so@ either encourage or reBuire users to change their
passwords often.
129 of 425 26-09-2014 11:18
?.>. Setting and Clearing )assords
Aou can set@ c!ear@ and change passwords for users.
&asswords can contain an' /e'"oard character.
&asswords are not case sensitive. +or e#ap!e@ the password ,)C12$ is eBuiva!ent to a"c12$.
*paces are a!!owed in passwords@ "ut spaces are ignored "' the TM1F server . The TM1 server
considers the password ,)C 12$ (.+ to "e eBuiva!ent to ,)C12$(.+.
Setting a )assord
Aou can set up a password.
Clearing a )assord
To c!ear a password@ cop!ete the fo!!owing steps.
C%anging a )assord
Aou can change 'our password an' tie 'ou are connected to a reote server. -sers who are not
adinistrators can do the sae.
130 of 425 26-09-2014 11:18
?.>.1. Setting a )assord
Aou can set up a password.
)rocedure
In the Clients=Groups dia!og "o#@ c!ic/ the ce!! at the intersection of the user nae and the
&assword co!un.
The ce!! contains the va!ue of 0ndefined.
2.
T'pe the new password for the user and press 1nter.
, password can contain a a#iu of 238 characters.
TM1F propts 'ou to ret'pe the new password.
$.
0et'pe the password and c!ic/ O;.
The ce!! now contains a va!ue of .efined.
2.
C!ic/ O;. 3.
)arent topic* *etting and C!earing &asswords
131 of 425 26-09-2014 11:18
?.>.#. Clearing a )assord
To c!ear a password@ cop!ete the fo!!owing steps.
)rocedure
In the Clients=Groups dia!og "o#@ se!ect the ce!! at the intersection of the &assword co!un and the
user nae.
2.
C!ic/ Clients L Clear )assord.
TM1F as/s 'ou to confir whether 'ou rea!!' want to c!ear the password.
$.
C!ic/ Bes.
TM1 c!ears the password@ and disp!a's a va!ue of 0ndefined in the ce!!.
2.
C!ic/ O;.
'ote* When 'ou c!ear a password@ the user can re7esta"!ish it the ne#t tie the' !og in to the TM1
server.
3.
132 of 425 26-09-2014 11:18
?.>.-. C%anging a )assord
Aou can change 'our password an' tie 'ou are connected to a reote server. -sers who are not
adinistrators can do the sae.
)rocedure
In the *erver .#p!orer@ se!ect the icon for the server 'ou are wor/ing with. 1.
C!ic/ Ser(er L Security L C%ange )assord.
The &assword Change dia!og "o# disp!a's.
2.
T'pe the new password in the &assword "o#@ and c!ic/ O;.
TM1F propts 'ou to ret'pe the new password.
$.
0et'pe the password@ and c!ic/ O;. 2.
133 of 425 26-09-2014 11:18
?.?. Setting an 1+piration for a 0ser
When 'ou add a user to TM1F @ 'ou can set a !iit on the nu"er of da's the user can access the server.
)rocedure
In the Clients=Groups dia!og "o#@ in the ce!! at the intersection of the user nae and the .#piration
(a's co!un@ enter the nu"er of da's 'ou want to a!!ow the user to access the TM1 server .
,fter the specified nu"er of da's@ the user wi!! not "e a"!e to !og in to the server.
2.
C!ic/ O;. $.
134 of 425 26-09-2014 11:18
@. System and )erformance Monitoring
There are !og fi!es@ too!s@ and uti!ities avai!a"!e for onitoring the s'ste perforance of an I)MF
CognosF TM1F server .
O(er(ie of TM1 System and )erformance Monitoring
TM1 inc!udes a co!!ection of too!s that provide !ogging and rea!tie perforance onitoring of the
TM1 servers in 'our organi=ation.
0sing t%e Admin Ser(er :og
The TM1 ,din *erver !og is usefu! for trou"!eshooting connection issues when using the TM1 *ecure
*oc/et 6a'er G**6I with custo certificates or certificates fro the Microsoft Windows certificate
store.
:ogging Transactions
.ach TM1 server trac/s the data transactions ade "' its c!ients.
0sing t%e TM1 Ser(er Message :og
The TM1 server records status essages on the activit' of the server in a !og fi!e.
Client :ogging
,s of I)M Cognos TM1 version ;.3.1@ a c!ient7side !ogging too! is avai!a"!e that can co!!ect data a"out
activit' for TM1 c!ients@ such as I)M Cognos TM1 ,rchitect and I)M Cognos TM1 &erspectives.
0sing t%e Audit :og
The TM1 audit !og onitors changes to etadata@ such as odifications to diensions@ views and
su"sets.
Monitoring Ser(er )erformance 0sing Control Cubes
TM1 inc!udes a perforance onitoring feature that !ets 'ou record the perforance statistics for
c!ients@ cu"es@ and servers.
0sing t%e TM1 Top 0tility
The TM1 Top uti!it' d'naica!!' onitors the threads running in an instance of the TM1 server. TM1
Top can a!so disp!a' inforation a"out the sand"o#es and <o" Bueue for a specific server.
0sing TM1 )erformance Counters
TM1 perforance counters are a co!!ection of va!ues that are continuous!' updated to provide
rea!tie onitoring of TM1 server perforance.
Capturing Core .umps for TM1 Ser(er Cras% Analysis
Aou want to ensure that ever'thing is in p!ace in case 'ou e#perience a TM1 server crash.
.ebugging Tools for $indos
Aou can use either ,(&!us or (r. Watson as a de"ugging too! to co!!ect server crash inforation on a
Windows s'ste.
135 of 425 26-09-2014 11:18
@.1. O(er(ie of TM1 System and )erformance Monitoring
TM1F inc!udes a co!!ection of too!s that provide !ogging and rea!tie perforance onitoring of the TM1
servers in 'our organi=ation.
Aou can onitor TM1 perforance and activit' using the fo!!owing too!s.
Message :ogging
0d"in /erver log
, !og fi!e containing essages a"out counication "etween TM1 c!ients@ the ,din *erver and
individua! TM1 servers.
Transactions :og
, !og fi!e that trac/s the data transactions ade "' the c!ients !ogged into one TM1 server.
0ecorded inforation inc!udes the date and tie the change was ade@ nae of the c!ient who
ade the change@ "efore and after va!ue@ nae of the cu"e in which the change was ade@ and
the e!eents that identif' the ce!! that changed.
/erver Message :og
, !og fi!e containing detai!s on the activit' of the TM1 server@ such as an e#ecuted processes@
chores@ !oaded cu"es and diensions@ and a s'nchroni=ed rep!ication.
0udit :og
, !og fi!e that onitors changes to TM1 o"<ects and s'ste7wide events@ such as odifications to
diensions@ views and su"sets and successfu!H unsuccessfu! !ogin activit'.
Monitoring Ser(er )erformance 0sing Control Cubes
Minute7"'7inute perforance statistics for c!ients@ cu"es@ and servers. This perforance data is
trac/ed and stored in the fo!!owing TM1 contro! cu"esN D*tats)'C!ient@ D*tats)'Cu"e@
D*tats)'Cu"e)'C!ient@ and D*tats+or*erver.
TM1 Top
, uti!it' that d'naica!!' onitors the threads and processes running in an instance of a sing!e TM1
server. TM1 Top is a stand7a!one uti!it' that runs within a conso!e GcoandI window on a Microsoft
Windows coputer.
)erformance Counters
, co!!ection of continuous!' updated va!ues that provide rea!7tie onitoring of specific TM1 server
properties and activities such as usage of cu"es@ views@ su"sets@ diensions@ and readHwrite activit'.
&erforance counters are viewa"!e in graphica! forat using the Microsoft Windows &erforance
Monitor@ or in a te#t7on!' disp!a' using the TM1 &erfMon uti!it'.
TM1 Operations Console
, we"7"ased uti!it' that disp!a's and !ogs TM1 server activit'. *ee the IBM Cognos TM1 Operations
Console Guide for ore inforation.
)arent topic* *'ste and &erforance Monitoring
136 of 425 26-09-2014 11:18
@.#. 0sing t%e Admin Ser(er :og
The TM1F ,din *erver !og is usefu! for trou"!eshooting connection issues when using the TM1 *ecure
*oc/et 6a'er G**6I with custo certificates or certificates fro the Microsoft Windows certificate store.
It contains essages a"out the counication "etween TM1 c!ients@ the TM1 ,din *erver@ and
individua! TM1 servers.
Most of the essages in this !og are created during the startup process for c!ients and servers. Messages
are !ogged when>
TM1 servers start up and register with the TM1 ,din *erver.
TM1 c!ients contact the TM1 ,din *erver for a !ist of avai!a"!e TM1 servers.
**6 securit' is esta"!ished "etween TM1 c!ients@ the TM1 ,din *erver@ and individua! TM1 servers.
*ee the J,uthentication and securit' configurationJ chapter in the IBM Cognos TM1 Installation and
Message Se(erity :e(els for Admin Ser(er :ogging
The ,din *erver !og categori=es essages into three severit' !eve!s.
Configuring Admin Ser(er :ogging
Configuration for TM1 ,din *erver !ogging is contained in the t1adsrv7!og.properties fi!e. This
fi!e is !ocated in the install6dirP"in director'.
1nabling Admin Ser(er :ogging
6ogging for the TM1 ,din *erver is ena"!ed "' defau!t when 'ou insta!! TM1 .
5ieing t%e Admin Ser(er :og File
The defau!t !ogging configuration writes !og essages to the t1adsrv.!og fi!e.
137 of 425 26-09-2014 11:18
@.#.1. Message Se(erity :e(els for Admin Ser(er :ogging
The ,din *erver !og categori=es essages into three severit' !eve!s.
These !eve!s are a!so used in the !ogging properties fi!e to configure !ogging to a specific !eve!.
(.)-G (etai!ed@ technica! essages that are usefu! when custoer support or
deve!opent engineering need to de"ug the app!ication.
When !ogging is configured to this !eve!@ (.)-G@ IN+O@ and .00O0 essages
are !ogged.
IN+O Inforationa! essages that high!ight the progress of the app!ication and report
nora! transitions within the app!ication.
When !ogging is configured to this !eve!@ IN+O and .00O0 essages are !ogged.
.00O0 ,n error condition of which 'ou shou!d "e aware. ,ction shou!d "e ta/en to fi# or
report the issue to custoer support.
When !ogging is configured to this !eve!@ on!' .00O0 essages are !ogged.
)arent topic* -sing the ,din *erver 6og
138 of 425 26-09-2014 11:18
@.#.#. Configuring Admin Ser(er :ogging
Configuration for TM1F ,din *erver !ogging is contained in the t1adsrv7!og.properties fi!e. This fi!e
is !ocated in the install6dirP"in director'.
This fi!e is !ocated in the install6dirP"in director'.
The sections of the properties fi!e are>
:ogger section
Configures the TM1 su"7coponents and essage severit' !eve! that 'ou want to !og.
.#ap!e>
log4j.rootLogger=INFO*, R1
log4j.logger.TM1=INFO
SIN+O is the essage !eve!.
Appender section
.#ap!e>
Contro!s the output destination of the !ogging. The defau!t configuration uses the 0o!!ing+i!e,ppender
option to write essages to the t1adsrv.!og fi!e.
# R1 is set to be a RollingFileAppender
log4j.appender.R1=org.apache.log4j.RollingFileAppender
log4j.appender.R1.File=tm1admsrv.log*
log4j.appender.R1.MaxFileSize-10 MB
log4j.appender.R1.MaxBackupIndex=2
St"1ad"srv-log is the !og fi!e nae.
)attern :ayout section
Contro!s the output fie!ds and foratting of the essages that are written to the !og fi!e. The defau!t
settings use a tie reference of GMT.
.#ap!e>
# R1 uses PatternLayout
log4j.appender.R1.layout=org.apache.log4j.PatternLayout
log4j.appender.R1.layout.ConversionPattern=%t %p %d(%Y-%m-%d %H:%M:%S,%Q) %c %m%n
log4j.appender.R1.layout.TimeZone=GMT
The defau!t !ogging configuration !ogs a!! IN+O !eve! essages. Aou can ad<ust the !ogging essage !eve!
"' editing the fo!!owing two stateents in the !ogging properties fi!e>
log4j.rootLogger=INFO, R1
139 of 425 26-09-2014 11:18
+or e#ap!e@ rep!ace IN+O with the (.)-G !ogging !eve!>
log4j.rootLogger=DEBUG, R1
log4j.logger.TM1=DEBUG
'ote* The defau!t !ogging configuration is intended for ever'7da' use and does not t'pica!!' reBuire
ad<ustent. Contact custoer support for assistance if 'ou need to configure the !ogging properties fi!e
for trou"!eshooting purposes.
140 of 425 26-09-2014 11:18
@.#.-. 1nabling Admin Ser(er :ogging
6ogging for the TM1F ,din *erver is ena"!ed "' defau!t when 'ou insta!! TM1 .
The insta!!ation p!aces the t1adsrv7!og.properties fi!e and the TM1 ,din *erver progra fi!e@
t1adsrv.e#e@ into the install6dirP"in director'.
6ogging is activated when the TM1 ,din *erver starts up and detects the t1adsrv7!og.properties fi!e
in the sae director'.
141 of 425 26-09-2014 11:18
@.#.4. 5ieing t%e Admin Ser(er :og File
The defau!t !ogging configuration writes !og essages to the t1adsrv.!og fi!e.
The !og fi!e is an ,*CII te#t fi!e that 'ou can open in an' te#t editor@ such as Microsoft Windows Notepad.
)rocedure
6ocate the t1adsrv.!og fi!e in the install6dirP"in director'. 1.
Open and view the !og fi!e with a te#t editor@ such as Microsoft Windows Notepad.
.ach !ine in the !og fi!e represents one uniBue essage@ arranged in the fo!!owing forat>
T%read
I.
Message
:e(el
.ate and Time Subcomponent
'ame
Message Te+t
$;2: IN+O 200970171;
1;>10>22@ 12:
TM1F .Co.**6 .rror connecting to reote
achine
1280 (.)-G 200970171;
1;>12>02@ $;8
TM1 .*erver 6ogger initia!i=ed
$$2: (.)-G 200970171;
1;>12>02@ $;8
TM1 ..vent Tiwed wait for event
002$):3: succeeded
$$2: (.)-G 200970171;
1;>12>02@ $;8
TM1 ..vent (estro' event 002$):3:
succeeded
1280 (.)-G 200970171;
1;>12>02@ $;8
TM1 . .vent *igna! event 002$):3:
succeeded
2.
142 of 425 26-09-2014 11:18
@.-. :ogging Transactions
.ach TM1F server trac/s the data transactions ade "' its c!ients.
When a c!ient changes a cu"e va!ue@ TM1 records the change in a transaction !og fi!e naed T1s.!og@
which is !ocated in the TM1 server data director'.
The inforation recorded in the !og fi!e inc!udes>
(ate and tie the change was ade.
Nae of the c!ient who ade the change.
Whether the new data is sip!e data GNI or string data G*I.
4a!ue "efore the change.
4a!ue after the change.
Nae of the cu"e in which the change was ade.
.!eents that identif' the ce!! that changed.
Optiona! user7provided string that is attached to each transaction. Aou create the string with the
TM1*erver6og*et+!ag*tring ,&I function.
The !og fi!e is a coa7de!iited ,*CII fi!e@ as shown in the fo!!owing sap!e>
"19980602212741","19980602212741","Admin","N","380.","250.","salescube",
"Budget","Belgium","L
Series 1.6 L Sedan","Units","Jun",""
Series 1.6 L Sedan","Units","Sep",""
Series 1.6 L Sedan","Units","Oct",""
.ata /ac"up and 2eco(ery
When 'ou "ring down the server nora!!'@ TM1 renaes the !og fi!e "' appending a tie stap to it@
using the fo!!owing naing convention> T1s ''''ddhhss.!og.
1nabling and .isabling Transaction :ogging
)' defau!t@ TM1 !ogs transactions to a!! cu"es !oaded on the server. ,s the s'ste adinistrator@ 'ou
5ieing t%e Transaction :og
Aou can Buer' the transaction !og GT1s.!ogI to view the records of a!! the !ogs current!' in the TM1
/ac"ing Out 2ecords from t%e Transaction :og
,fter 'ou Buer' the transaction !og@ 'ou can use the Transaction 6og ?uer' 0esu!ts dia!og "o# to "ac/
out the transactions.
2emo(ing Transaction :og Files from t%e .is"
The TM1 !og fi!es can ta/e up a su"stantia! aount of dis/ space after the server has "een running
for soe tie.
Troubles%ooting* 2eco(ering from a Corrupt Transaction :og File
In soe cases@ an une#pected or incop!ete shutdown of the TM1 server@ due to a server crash or
143 of 425 26-09-2014 11:18
power outage@ can cause the transaction !og fi!e to "ecoe corrupt. If this happens@ the server wi!!
not "e a"!e to restart.
144 of 425 26-09-2014 11:18
@.-.1. .ata /ac"up and 2eco(ery
When 'ou "ring down the server nora!!'@ TM1F renaes the !og fi!e "' appending a tie stap to it@
using the fo!!owing naing convention> T1s ''''ddhhss.!og.
The T1s.!og fi!e reains open whi!e a TM1 server is running.
The tie stap@ 7777""dd22""ss@ represents the current Greenwich Mean Tie at the tie the server
was "rought down. +or e#ap!e@ if the server cae down on Ranuar' 2@ 2002@ at 2>$0 &M@ the nae of
the !og fi!e is T1s2002010212$000.!og.
TM1 recovers the data autoatica!!' in the event that a server coes down a"nora!!'@ and !eaves the
T1s.!og fi!e on the dis/. The ne#t tie 'ou "ring up the server@ TM1 recovers the changes in either of
two wa's>
Automatically reco(ers t%e c%anges 77 when 'ou are running the TM1 server as a Microsoft
Windows service.
)rompts you to reco(er t%e c%anges 77 when 'ou are running the TM1 server as an app!ication
If 'ou intentiona!!' shut down a TM1 server without saving the data@ TM1 saves the transaction !og with a
tie stap and changes the fi!e e#tension to .re<. +or e#ap!e@ T1s2002010212$000.re<. The .re< !og
fi!e ensures that 'ou a!wa's have a record of the data transactions@ even if 'ou shut down the server
without saving the data. If 'ou accidenta!!' shut down the server without saving the changes@ 'ou can
process the .re< fi!e through Tur"oIntegrator to recover the data.
145 of 425 26-09-2014 11:18
@.-.#. 1nabling and .isabling Transaction :ogging
)' defau!t@ TM1F !ogs transactions to a!! cu"es !oaded on the server. ,s the s'ste adinistrator@ 'ou
When 'ou disa"!e !ogging@ TM1 acce!erates updating the data "ut 'ou cannot recover the updates in the
event of a s'ste fai!ure.
)rocedure
Open *erver .#p!orer. 1.
*e!ect the Cu"es icon for the server 'ou are wor/ing with. 2.
*e!ect Cubes@ Security Assignments.
The TM1 *ecurit' ,ssignents dia!og "o# opens.
$.
C!ic/ the ce!! at the intersection of the 6ogging co!un and the cu"e nae.
TM1 ena"!es !ogging when a chec/ "o# contains an 9@ and disa"!es !ogging when the chec/ "o# is
ept'.
2.
C!ic/ O;. 3.
146 of 425 26-09-2014 11:18
@.-.-. 5ieing t%e Transaction :og
Aou can Buer' the transaction !og GT1s.!ogI to view the records of a!! the !ogs current!' in the TM1F
When 'ou Buer' the transaction !og@ TM1 co"ines a!! the !og fi!es into one !ogica! fi!e that satisfies the
Buer' paraeters. +or e#ap!e@ if 'ou Buer' for a!! the records starting on Ran. 2@ 2002 at 2>$0 &M GMT@
TM1 returns a!! the records in a!! the transaction !ogs with a tie stap of 2002010212$000 or !ater.
)rocedure
C!ic/ Ser(er@ 5ie Transaction :og.
The Transaction 6og ?uer' dia!og "o# opens.
2.
C!ic/ the right arrow in a paraeter fie!d to set the paraeters for the Buer'.
There are four paraeters 'ou can set>
*tarting Tie ?ueries a!! the records written to the transaction !og on or after the
starting tie.
*tart date and tie for the Buer'. The date and tie forat is
MMH((HAAAA 11>MM>** GMT. The defau!t start date and tie is
00>01>00 GMT on the date 'ou !aunch the Buer'.
.nd Tie .nd date and tie for the Buer'. The date and tie forat is
MMH((HAAAA 11>MM>**
The defau!t is %%H%%H%%%% %%>%%>%%@ which is an open end date and
tie. If 'ou accept the defau!t@ TM1 Bueries a!! the records up to the
tie 'ou !aunch the Buer'.
C!ients The c!ientGsI against which 'ou app!' the Buer'.
Aou can Buer' against either a sing!e c!ient or a!! the c!ients. The defau!t
is a!! c!ients GSI.
Cu"es The cu"eGsI against which 'ou app!' the Buer'.
Aou can Buer' against either a sing!e cu"e or a!! the cu"es. The defau!t
is a!! cu"es GSI
$.
C!ic/ O;.
The Buer' returns a ta"!e with a!! the transaction records that satisf' the paraeters 'ou set. The
ta"!e disp!a's in the Transaction 6og ?uer' 0esu!ts dia!og "o#.
)' defau!t@ records are sorted in ascending order "' 6OGTIM..
2.
To sort on a different co!un@ c!ic/ the co!un heading. To change the order of a co!un sort@ c!ic/ 3.
147 of 425 26-09-2014 11:18
the co!un heading a second tie.
C!ic/ 1dit@ Find to search the records in the Buer' resu!ts ta"!e. 8.
148 of 425 26-09-2014 11:18
@.-.4. /ac"ing Out 2ecords from t%e Transaction :og
,fter 'ou Buer' the transaction !og@ 'ou can use the Transaction 6og ?uer' 0esu!ts dia!og "o# to "ac/ out
the transactions.
When 'ou "ac/ out a transaction@ the va!ue in the O6(4,6-. co!un rep!aces the va!ue in the
N.W4,6-. co!un.
)rocedure
1igh!ight the recordGsI 'ou want to "ac/ out.
To high!ight an individua! record@ c!ic/ the record.
To high!ight u!tip!e ad<acent records@ c!ic/ the first record and *1I+TQc!ic/ the !ast record.
To high!ight u!tip!e nonad<acent records@ CT06Qc!ic/ each record.
1.
C!ic/ 1dit@ Select.
,!! the high!ighted records now disp!a' a chec/ ar/ in the "o# ad<acent to the first co!un. The
chec/ ar/s indicate that the record is se!ected to "e "ac/ed out.
To se!ect a!! the records without first high!ighting the@ c!ic/ 1dit@ Select All.
2.
C!ic/ 1dit@ /ac" Out.
TM1F "ac/s out the records in reverse chrono!ogica! order as identified "' the 6OGTIM. co!un.
$.
149 of 425 26-09-2014 11:18
@.-.6. 2emo(ing Transaction :og Files from t%e .is"
The TM1F !og fi!es can ta/e up a su"stantia! aount of dis/ space after the server has "een running for
soe tie.
Aou shou!d reove the o!d !og fi!es fro 'our dis/ ever' so often@ depending on the vo!ue of the
changes 'ou a/e and the si=e of 'our dis/. Aou can "ac/ up these fi!es "efore 'ou erase the.
(o not reove the !og fi!es when the TM1 server is running. +irst shut down the server@ and then de!ete
the !og fi!es fro 'our dis/.
150 of 425 26-09-2014 11:18
@.-.>. Troubles%ooting* 2eco(ering from a Corrupt Transaction :og
File
In soe cases@ an une#pected or incop!ete shutdown of the TM1F server@ due to a server crash or
power outage@ can cause the transaction !og fi!e to "ecoe corrupt. If this happens@ the server wi!! not "e
a"!e to restart.
In this case@ 'ou wi!! need to trou"!eshoot the cause of the shutdown@ verif' that the transaction !og fi!e is
corrupt@ reove the !og fi!e and contact Custoer *upport for assistance.
.etermining if t%e Transaction :og File is Corrupt
When the TM1 server restarts after an une#pected shutdown@ it attepts to recover data fro the
transaction !og fi!e@ T1s.!og. If TM1 detects that the !og fi!e is corrupt@ the server wi!! not start and
infors 'ou of the situation via visua! propts andHor !ogged essages. The e#act t'pe of essage
depends on how 'ou are running the TM1 server>
On a -NI5 s'ste or as a Microsoft Windows service.
,s a Microsoft Windows app!ication.
TM1 Ser(er 2unning on a 0'I9 System or as a Microsoft $indos Ser(ice
If 'ou are running the TM1 server on a -NI5 s'ste or as a Microsoft Windows service@ TM1 cance!s the
autoatic recover' when tr'ing to restart the server and writes a warning essage to the TM1 server
essage !og@ t1server.!og. This essage indicates that the transaction !og is corrupt. ,n e#ap!e
essages in the TM1 *erver Message !og indicating a corrupt transaction fi!e and the warning essages
are shown in the fo!!owing ta"!e.
T%read
I.
Message
:e(el
.ate and Time Subcomponent
'ame
Message Te+t
2098 +,T,6 20097107$0 1:>20>10@
20$
TM1 .*erver )ad transaction !og record>
:2:.9...
2098 +,T,6 20097107$0 1:>20>12@
;21
TM1 .*erver *erver terinated
TM1 Ser(er 2unning as a Microsoft $indos Application
If 'ou are running the TM1 server as a Windows app!ication@ TM1 first propts 'ou to recover the
changes when the server restarts.
If 'ou se!ect 'o@ the server wi!! continue running@ "ut the pro"!e that caused the une#pected shutdown
a' sti!! e#ist.
If 'ou se!ect Bes@ TM1 disp!a's the fo!!owing warning essage and a!so writes a essage to the TM1
server essage !og as descri"ed a"ove.
*e!ect O; to shutdown the TM1 server.
2esol(ing a Corrupt Transaction :og File
To reso!ve this condition@ ove the transaction !og fi!e@ t1s.!og@ fro the TM1 server data director' to a
teporar' !ocation on 'our s'ste. ,t this point@ 'ou shou!d "e a"!e to successfu!!' restart the server@
"ut 'ou shou!d a!so contact Custoer *upport for assistance in reso!ving the cause of the une#pected
shutdown.
151 of 425 26-09-2014 11:18
@.4. 0sing t%e TM1 Ser(er Message :og
The TM1F server records status essages on the activit' of the server in a !og fi!e.
These essages contain detai!s on activit' such as e#ecuted processes@ chores@ !oaded cu"es and
diensions@ and s'nchroni=ed rep!ication.
The TM1 server essage !ogging s'ste is designed to inii=e the ipact on perforance whi!e
a!!owing greater contro! over the Buantit' and focus of data produced "' !ogging.
The !ogging s'ste inc!udes the fo!!owing coponents>
Message severit' !eve!s 7 Categories for c!assif'ing and reporting essages "' severit'N (.)-G@
IN+O@ W,0N@ .00O0@ and +,T,6.
TM1 !oggers 7 &araeters that provide enhanced contro! for se!ective!' !ogging specific areas or
su"7coponents of CognosF TM1 .
6ogging properties fi!e 7 , te#t7"ased fi!e that ena"!es 'ou to configure and ena"!e !ogging for a
specific TM1 server.
Message !og viewer 7 , too! for viewing the essage !og in *erver .#p!orer and ,rchitect.
'ote* 6og essages are disp!a'ed in .ng!ish on!'.
Message Se(erity :e(els
The !ogging s'ste categori=es essages into severit' !eve!s.
TM1 :oggers
TM1 !oggers represent the different areas or su"coponents of TM1 that produce !og essages.
:ogging )roperties File
The !ogging properties fi!e@ t1s7!og.properties@ ena"!es 'ou to contro! which essage !eve!s are
!ogged for the different su"coponents of TM1 .
Configuring and 1nabling Ser(er Message :ogging
-se a cop' of the !ogging properties fi!e@ t1s7!og.properties@ to configure and ena"!e essage
!ogging for a specific TM1 server.
5ieing t%e TM1 Ser(er Message :og
To view a !ist of the essages that the TM1 server has recorded@ cop!ete the fo!!owing steps.
152 of 425 26-09-2014 11:18
@.4.1. Message Se(erity :e(els
The !ogging s'ste categori=es essages into severit' !eve!s.
(.)-G (etai!ed@ technica! essages that are usefu! when custoer support or
engineering need to de"ug the app!ication.
.#ap!es> J**6 Connection openedJ@ J0eoving *?6 Connection fro
eor'J
IN+O Inforationa! essages that high!ight the progress of the app!ication and
report nora! transitions within the app!ication.
.#ap!es> J*erver is read'J@ J6oading diension...J
W,0N , potentia!!' harfu! situation or condition of which 'ou shou!d "e aware.
,ction a' "e reBuired@ "ut operation of the server is not interrupted.
.#ap!e> J,ttept to add a new group e#ceeded the !iit on group creationJ
.00O0 ,n error condition of which 'ou shou!d "e aware. ,ction shou!d "e ta/en to fi#
or report the issue to custoer support. The error a' "e so severe that the
server shuts down or it a' resu!t in the current c!ient reBuest "eing
cance!ed.
.#ap!es> J.rror connecting to reote achineJ@ J+ai!ed to create a cu"eJ
+,T,6 , ver' severe error event that wi!! possi"!' cause the server to shut down or
resu!t in the current c!ient reBuest "eing cance!ed. Aou shou!d iediate!'
ta/e action to fi# the issue and report the event to custoer support.
)arent topic* -sing the TM1 *erver Message 6og
153 of 425 26-09-2014 11:18
@.4.#. TM1 :oggers
TM1F !oggers represent the different areas or su"coponents of TM1 that produce !og essages.
+or e#ap!e@ diensions and cu"es produce essages when !oading and the server reports essages
when starting and stopping.
Aou can contro! the Buantit' and focus of the !ogging "' se!ective!' turning on or off individua! TM1
!oggers in the !ogging properties fi!e.
The defau!t !ogging configuration is IN+O !eve! essages for a!! areas of TM1 .
'ote* Custoer support can provide 'ou with guidance and assistance to ena"!e individua! TM1 !oggers.
154 of 425 26-09-2014 11:18
@.4.-. :ogging )roperties File
The !ogging properties fi!e@ t1s7!og.properties@ ena"!es 'ou to contro! which essage !eve!s are !ogged
for the different su"coponents of TM1F .
The t1s7!og.properties fi!e is a te#t fi!e that contains the paraeters for configuring !ogging for a
specific TM1 server.
.ach TM1 server uses its own !ogging properties fi!e and chec/s for the fi!e whenever the server is
started. ,fter startup@ the server chec/s for updates to the properties fi!e and ad<usts the !ogging as
needed. Aou can a/e changes to a properties fi!e in rea!7tie and the TM1 server wi!! d'naica!!' read
the changes and ad<ust the !ogging.
'ote* The TM1 !oca! server on!' chec/s the !ogging properties fi!e@ t1s7!og.properties@ when the !oca!
server starts up. +or detai!s@ see .na"!ing and (isa"!ing Transaction 6ogging.
, sap!e !ogging properties fi!e is provided in the director' of each sap!e TM1 data"ase that 'ou insta!!.
*ap!e TM1 data"ases are insta!!ed in the fo!!owing !ocations>
$indos s'ste>install6dirPsap!esPt1Psa"ple6dir
0'I9 s'ste> install6dirHsap!esHt1Hsa"ple6dir
Where sa"ple6dir is the director' for a sap!e TM1 data"ase. +or e#ap!e>
)lanning Sample .ata* install6dirPsap!esPt1P&!an*ap
Sample .ata> install6dirPsap!esPt1P*(ata
1ere is an e#ap!e of the !ogging properties fi!e>
Log4j.rootLogger=INFO, S1
Log4j.logger.TM1=INFO
# S1 is set to be a SharedMemoryAppender log4j.appender.S1=org.apache.log4j.
SharedmemoryAppender
#Specify the size of the shared memory segment log4j.appender.S1.MemorySize=5
MB
#Specify the max filesize log4j.appender.S1.MaxFileSize=10
MB
Specify the max backup index log4j.appender.S1.MaxBackupIndex=3
155 of 425 26-09-2014 11:18
@.4.4. Configuring and 1nabling Ser(er Message :ogging
-se a cop' of the !ogging properties fi!e@ t1s7!og.properties@ to configure and ena"!e essage !ogging
for a specific TM1F server.
1nabling and .isabling :ogging
6ogging is ena"!ed when a TM1 server detects a !ogging properties fi!e in the sae director' where
the server's configuration fi!e@ T1s.cfg@ is !ocated.
Configuring :ogging Message :e(el
-se the fo!!owing two stateents in the !ogging properties fi!e as the standard configuration to !og a!!
IN+O !eve! essages for a!! areas of TM1 .
Configuring :ogging Output
6ogging output is configured in the appender section of the !ogging properties fi!e with the fo!!owing
paraeters.
156 of 425 26-09-2014 11:18
@.4.4.1. 1nabling and .isabling :ogging
6ogging is ena"!ed when a TM1F server detects a !ogging properties fi!e in the sae director' where the
server's configuration fi!e@ T1s.cfg@ is !ocated.
)rocedure
.dit a cop' of the sap!e !ogging properties fi!e@ t1s7!og.properties@ to configure !ogging essage
!eve! and output settings@ as descri"ed in Configuring 6ogging Message 6eve! and Configuring 6ogging
Output.
1.
&!ace the !ogging properties fi!e@ t1s7!og.properties@ into the sae director' where the configuration
fi!e@ T1s.cfg@ is !ocated for the TM1 server 'ou want to onitor.
The !ocation of the T1s.cfg fi!e is t'pica!!' the data director' of the TM1 server@ "ut cou!d "e a
different !ocation depending on 'our specific TM1 configuration. +or e#ap!e@ if 'our T1s.cfg fi!e is
!ocated in the C>Psa!esdata director' on a Microsoft Windows s'ste@ then cop' the !ogging
properties fi!e into this director'.
,fter the t1s7!og.properties fi!e is p!aced in the sae director' as the T1s.cfg fi!e@ the server wi!!
start !ogging "ased on the settings configured in the !ogging properties fi!e. It is not necessar' to
restart the TM1 server to initia!i=e !ogging@ un!ess 'ou are running a !oca! server.
'ote* The TM1 !oca! server on!' chec/s the !ogging properties fi!e@ t1s7!og.properties@ when the
!oca! server starts up. ,fter startup@ a !oca! server never chec/s for changes in the !ogging properties
fi!e@ so a!! settings in a !oca! server's !ogging properties fi!e ust "e considered static. If 'ou change
an' !ogging properties for a !oca! server@ 'ou ust restart the server to app!' the new !ogging
settings.
2.
To teporari!' turn off !ogging@ set the TM1 !ogger va!ues to either IN+O or O++. -sing a va!ue of
IN+O is recoended.
*etting a !ogger va!ue to IN+O wi!! continue soe !ogging@ "ut at a uch decreased aount
copared to a setting of (.)-G. -sing a setting of IN+O@ instead of O++@ is usefu! "ecause TM1
wi!! sti!! !og iportant essages for W,0N@ .00O0 and +,T,6 essages.
*etting a !ogger va!ue to O++ wi!! stop a!! !ogging for that !ogger@ and 'ou cou!d iss an' potentia!
W,0N@ .00O0 and +,T,6 essages.
$.
)arent topic* Configuring and .na"!ing *erver Message 6ogging
157 of 425 26-09-2014 11:18
@.4.4.#. Configuring :ogging Message :e(el
-se the fo!!owing two stateents in the !ogging properties fi!e as the standard configuration to !og a!!
IN+O !eve! essages for a!! areas of TM1F .
log4j.rootLogger=INFO, S1
-se the fo!!owing forat to configure !ogging at a specific essage !eve!>
TM1 logger=Message level, Appender
Where>
TM1 logger is the nae of the TM1 su"coponent that 'ou want to !og. Contact custoer support for
assistance using TM1 !oggers.
Message level is the essage severit' !eve! that 'ou want to !og. 4a!id va!ues inc!ude> (.)-G@ IN+O@
W,0N@ .00O0@ +,T,6@ or O++@ as descri"ed in the section JMessage *everit' 6eve!s.J
Message !eve!s are !ogged as fo!!ows>
*etting !ogging to (.)-G wi!! report a!! severit' !eve!s essages.
*etting !ogging to W,0N wi!! report W,0N@ .00O0@ and +,T,6 essages.
*etting !ogging to O++ disa"!es a!! !ogging for the specific TM1 !ogger.
0ppender is the output destination. -se a va!ue of *1 for the TM1 shared eor' appender which
transfers essages to eor' "efore saving the to a fi!e.
+or e#ap!e@ to turn on !ogging at the (.)-G !eve! for a!! TM1 su"7coponents@ 'ou wou!d use the
fo!!owing stateents>
log4j.rootLogger=DEBUG, S1
log4j.logger.TM1=DEBUG
158 of 425 26-09-2014 11:18
@.4.4.-. Configuring :ogging Output
6ogging output is configured in the appender section of the !ogging properties fi!e with the fo!!owing
paraeters.
Meor'*i=e
Ma#+i!e*i=e
Ma#)ac/upInde#
TieTone
.ach paraeter is descri"ed in the fo!!owing ta"!e.
Meor'*i=e *pecifies the si=e of the shared eor' segent. This eor' represents
the area of s'ste eor' where !og essages are sent "efore "eing
written to the !og fi!e.
(efau!t va!ue is 3 M).
-se the fo!!owing forat>
!og2<.appender.*1.Meor'*i=eK*i=e -nits
where>
*i=e is the nueric va!ue for the eor' si=e.
-nits can "e C)@ or M).
+or e#ap!e@ to set the Meor'*i=e to 3 M)@ enter the fo!!owing>
!og2<.appender.*1.Meor'*i=eK3 M)
Ma#+i!e*i=e *pecifies the a#iu fi!e si=e that the !og fi!e is a!!owed to ta/e up on
dis/.
(efau!t si=e is 100 M).
-ses the fo!!owing forat>
!og2<.appender.*1.Ma#+i!e*i=eK*i=e-nits
where>
*i=e is the nueric va!ue for the fi!e si=e.
-nits can "e C)@ M)@ or G).
+or e#ap!e@ to !iit the !og fi!e si=e to 10 M)@ enter the fo!!owing>
!og2<.appender.*1.Ma#+i!e*i=eK10 M)
If the Ma#)ac/upInde# paraeter is set to 1 or greater@ then the !ogging
process autoatica!!' creates a "ac/up fi!e when the !og fi!e reaches the
Ma#+i!e*i=e. The tota! nu"er of "ac/up fi!es is deterined "'
Ma#)ac/upInde# option.
159 of 425 26-09-2014 11:18
160 of 425 26-09-2014 11:18
@.4.6. 5ieing t%e TM1 Ser(er Message :og
To view a !ist of the essages that the TM1F server has recorded@ cop!ete the fo!!owing steps.
)rocedure
*e!ect the server in the *erver .#p!orer. 1.
C!ic/ Ser(er@ 5ie Message :og.
The Message 6og window opens.
The essage !og fie!ds are defined in the fo!!owing ta"!e.
Message Field .escription
Thread I( I( nu"er of the thread in the TM1 server that generated the !ogging
event.
.#ap!e> 2488
Message 6eve! *everit' !eve! of the essage "eing reported> (.)-G@ IN+O@ W,0N@
.00O0@ or +,T,6.
(ate and Tie (ate and tie the essage was !ogged@ "ased on the TieTone
paraeter setting in the !ogging properties fi!e. (ata and tie can "e
recorded as either GMT or 6oca!. +or ore detai!s@ see Configuring 6ogging
Output.
0eported in the forat> ''''77dd hh>.ss@i!!iseconds
.#ap!e> 2006-10-02 16:49.01,925
TM1 6ogger Nae Nae of the TM1 su"7coponent that generated the essage or activit'.
.#ap!e>
Start time: Tue Dec 05 2006 11:02:47
Message Te#t &re7defined te#t essage that descri"es the error or activit' "eing
reported.
2.
If a essage in the !og shows an error condition for an e#ecuted process or rep!ication@ 'ou can
dou"!e7c!ic/ the essage to view the detai!s of wh' the activit' generated the error.
$.
Searc%ing for Te+t in t%e Message :og
Aou can search for te#t in the essage !og.
Copying Te+t from t%e Message :og
Aou can cop' te#t fro the essage !og.
161 of 425 26-09-2014 11:18
@.4.6.1. Searc%ing for Te+t in t%e Message :og
Aou can search for te#t in the essage !og.
)rocedure
C!ic/ 1dit@ Find or press CT06Q+.
The +ind dia!og "o# opens.
1.
.nter the te#t 'ou to find and then c!ic/ Find 'e+t.
If the te#t is found@ the !ine containing the atched te#t is high!ighted and shown in the Message 6og
window.
2.
)arent topic* 4iewing the TM1 *erver Message 6og
162 of 425 26-09-2014 11:18
@.4.6.#. Copying Te+t from t%e Message :og
Aou can cop' te#t fro the essage !og.
)rocedure
*e!ect the !ine of te#t 'ou want to cop'. 1.
*e!ect 1dit@ Copy or press CT06QC to cop'.
The current!' se!ected !ine is copied to the Microsoft Windows c!ip"oard and can then "e pasted into
other app!ications.
2.
)arent topic* 4iewing the TM1 *erver Message 6og
163 of 425 26-09-2014 11:18
@.6. Client :ogging
,s of I)MF CognosF TM1F version ;.3.1@ a c!ient7side !ogging too! is avai!a"!e that can co!!ect data
a"out activit' for TM1 c!ients@ such as I)M Cognos TM1 ,rchitect and I)M Cognos TM1 &erspectives.
(ue to the !arge aounts of data that can "e co!!ected@ this too! shou!d on!' "e used under the direction
of custoer support.
1ere is a sap!e C!ient 6og>
log4j.rootLogger=DEBUG, R1
#Server Explore
log4j.logger.COrionMainApp=DEBUG
log4j.logger.CCubeView=DEBUG
log4j.logger.CubeViewGrid=DEBUG
log4j.logger.COrionTreeView=DEBUG
log4j.logger.COrionApp=DEBUG
log4j.logger.CMultiSelect=DEBUG
log4j.logger.CCreateSandbox=DEBUG
log4j.logger.loggerViewDimension=DEBUG
#Subset Editor
log4j.logger.CSubsetWnd=DEBUG
log4j.logger.CSubsetEntry=DEBUG
log4j.logger.CSubsetListProp=DEBUG
log4j.logger.CSubsetListBox2=DEBUG
log4j.logger.CSubsetListView1=DEBUG
log4j.logger.CSubsetRegExp=DEBUG
log4j.logger.CSubsetSelByAttr=DEBUG
log4j.logger.CSingleSelect=DEBUG
#ISB
log4j.logger.CXLCtrlsApp=DEBUG
log4j.logger.CConnectServerDlg=DEBUG
log4j.logger.CViewCtrl=DEBUG
log4j.logger.CGetViewDlg=DEBUG
log4j.logger.CubeViewerISB=DEBUG
log4j.logger.ExcelReportPrintDPage=DEBUG
log4j.logger.CTM1Connector=DEBUG
log4j.logger.ExcelReportPrintIncludedSheetsPage=DEBUG
log4j.logger.CAutoExcel=DEBUG
log4j.logger.SubsetEditorIntLog=DEBUG
#Perspectives
log4j.logger.TM1Perspectives=DEBUG
log4j.logger.TM1AF=DEBUG
log4j.logger.TM1ExcelAPI=DEBUG
log4j.appender.R1=org.apache.log4j.RollingFileAppender
log4j.appender.R1.File=c:\\ClientDebugLog.log
log4j.appender.R1.MaxFileSize=10 MB
log4j.appender.R1.MaxBackupIndex=50
log4j.appender.R1.layout=org.apache.log4j.PatternLayout
log4j.appender.R1.layout.ConversionPattern=%X{pid}
%t %p %d{%Y-%m-%d %H:%M:%S,%Q} %c %m%n
log4j.appender.R1.layout.TimeZone=GMT
To turn on C!ient *ide !ogging@ create a fi!e ca!!ed tm1p-log.properties in the C:\Documents and
Settings\Administrator\Application Data\Applix\TM !ocation on the c!ient's s'ste achine. The
TM1p.ini fi!e ust "e in the sae fo!der.
)e sure that !ocation is a!so set in the log4j.appender.R1.File=c:\\ClientDebugLog.log !ine of the
!og fi!e.
164 of 425 26-09-2014 11:18
If 'ou put the !og fi!es direct!' on the c>drive as in the e#ap!e @
log4j.appender.R1.File=c:\\ClientLog.log
)e sure to use PP s!ashes.
If 'ou want to use a tep director'@ specif' the !ocation using the other s!ash>
log4j.appender.R1.File=c:/temp/ClientLog.log
)e sure to update the fi!e paraeter with the new !ocation if 'ou change the t1p7!og.properties fi!e@ for
e#ap!e>
location.log4j.appender.R1.File=c:\<new location>\ClientDebugLog.log
If the presence of this fi!e and at !east one coponent within it is set to (.)-G@ c!ient side !ogging is
co!!ected. log4j.rootLogger=DEBUG can on!' "e set to O++ or (.)-G Gwhich turns c!ient !ogging ONI.
To turn off !ogging@ reove or renae this fi!e. Aou can turn off !ogging for an individua! coponent "'
changing the va!ue fro (.)-G to O++.
To custoi=e the !og fi!e@ 'ou can change>
6ocation of the !og fi!e is set in log4j.appender.R1.File=c:\\ClientDebugLog.log
6og fi!e a# si=e is set in log4j.appender.R1.MaxFileSize=10 MB. When this si=e is et a new !og
fi!e is created.
)ac/up inde# is set in log4j.appender.R1.MaxBackupIndex=50.
165 of 425 26-09-2014 11:18
@.>. 0sing t%e Audit :og
The TM1F audit !og onitors changes to etadata@ such as odifications to diensions@ views and
su"sets.
This !og can "e used for accounta"i!it' purposes where !aws or regu!ations@ such as *ar"anes7O#!e'@
reBuire auditing of certain activities in ission critica! software.
.ach TM1 server aintains its own separate audit !og. ,dinistrators can use a server's audit !og to
answer these Buestions>
What o"<ect was changedU
1ow was the o"<ect odifiedU
Who ade the changeU
When was the change adeU
Aou can Buer' and view the audit !og using the ,udit 6og window@ avai!a"!e in TM1 *erver .#p!orer.
'ote* )' defau!t@ audit !ogging is disa"!ed and ust "e anua!!' ena"!ed for each server 'ou want to
onitor. +or detai!s@ see Configuring ,udit 6ogging.
0nderstanding Audit :og 1(ents
The audit !og contains records of changes to a<or TM1 o"<ects and s'ste7wide activit'.
Configuring Audit :ogging
)' defau!t@ audit !ogging is disa"!ed. Aou ust anua!!' configure audit !ogging using the audit !og
paraeters in the TM1 server's configuration fi!e GT1s.cfgI.
0pdating t%e Audit :og it% t%e :atest 1(ents
When audit !ogging is ena"!ed@ TM1 runs the !ogging in the "ac/ground and autoatica!!' updates
the audit !og at a set interva!.
0sing t%e Audit :og $indo to 5ie :og Messages
The content of the audit !og is accessi"!e through the ,udit 6og window@ avai!a"!e in TM1 *erver
.#p!orer.
166 of 425 26-09-2014 11:18
@.>.1. 0nderstanding Audit :og 1(ents
The audit !og contains records of changes to a<or TM1F o"<ects and s'ste7wide activit'.
These records are ca!!ed events.
TM1 Ob8ect 1(ents
The audit !og onitors activit' for the TM1 o"<ects.
System!ide 1(ents
*'ste7wide events inc!ude operations re!ated direct!' to the TM1 server such as>
Audit :og Messages for .imension Sorting 1(ents
When 'ou sort or change the order of e!eents in a diension@ the e#act essage recorded in the
,udit !og depends on the sort ethod that was usedN autoatic or anua!.
)arent topic* -sing the ,udit 6og
167 of 425 26-09-2014 11:18
@.>.1.1. TM1 Ob8ect 1(ents
The audit !og onitors activit' for the TM1F o"<ects.
The o"<ects are>
,pp!ications
Chores
C!ients
Cu"es
(iensions
.!eents
Groups
&rocesses
0u!es
*u"sets
4iews.
, coon set of events@ such as o"<ect created or de!eted@ are !ogged for a!! these o"<ects. ,dditiona!!'@
events are !ogged that are specific to each o"<ect. +or e#ap!e@ the e#ecution of a process is an event
that is !ogged on!' for process o"<ects.
)arent topic* -nderstanding ,udit 6og .vents
168 of 425 26-09-2014 11:18
@.>.1.#. System!ide 1(ents
*'ste7wide events inc!ude operations re!ated direct!' to the TM1F server such as>
*uccessfu! and fai!ed !ogin attepts
*erver startup and shutdown
Changes to server paraeters
169 of 425 26-09-2014 11:18
@.>.1.-. Audit :og Messages for .imension Sorting 1(ents
When 'ou sort or change the order of e!eents in a diension@ the e#act essage recorded in the ,udit
!og depends on the sort ethod that was usedN autoatic or anua!.
Automatic .imension Sorting
When 'ou set an autoatic t'pe sort for a diension@ the audit !og records a specific descriptive essage
a"out the action. ,n autoatic sort is perfored using the .imension 1lement Ordering dia!og "o#
avai!a"!e when 'ou right7c!ic/ on a diension and se!ect Set 1lements Order.
+or e#ap!e@ the fo!!owing essage wou!d "e reported in the audit !og for an autoatic sort change to
the account diension>
"136","account","DESCENDING","DimensionSortElementsSense
property set for Dimension 'account': DESCENDING"
The ,udit 6og window wou!d disp!a' the fo!!owing essage>
&ropert' *ort.!eents*ense was set to '(.*C.N(ING' for diension 'account'.
Manual .imension Sorting
When 'ou edit the order of a diension in anua! ode using the (iension .ditor@ the audit !og records
on!' a generic essage. Manua! ode inc!udes changing the e!eent order "' hand@ or se!ecting *ort
fro the .dit enu in the (iension .ditor@ and c!ic/ing the *et (iension order "utton fo!!owed "'
saving the diension.
+or e#ap!e@ the fo!!owing generic essage wou!d "e reported in the audit !og for a anua! sort change
to the account diension>
21,account,Dimension updated: account
The ,udit 6og window wou!d disp!a' the fo!!owing essage>
(iension 'account' was updated.
170 of 425 26-09-2014 11:18
@.>.#. Configuring Audit :ogging
)' defau!t@ audit !ogging is disa"!ed. Aou ust anua!!' configure audit !ogging using the audit !og
paraeters in the TM1F server's configuration fi!e GT1s.cfgI.
To ena"!e audit !ogging for a specific TM1 server@ cop!ete the fo!!owing steps.
)rocedure
Open the T1s.cfg fi!e for that server. 1.
*et the fo!!owing paraeters in the T1s.cfg fi!e>
AuditLogOn=T
AuditLogUpdateInterval=60
2.
0estart the server.
'ote* ,fter changing the va!ue for the ,udit6ogOn paraeter@ 'ou ust restart the TM1 server for
the new va!ue to "e app!ied.
+or ore detai!s a"out the T1s.cfg fi!e and the audit !og paraeters@ see the IBM. Cognos. TM1
Installation and Configuration Guide.
$.
171 of 425 26-09-2014 11:18
@.>.-. 0pdating t%e Audit :og it% t%e :atest 1(ents
When audit !ogging is ena"!ed@ TM1F runs the !ogging in the "ac/ground and autoatica!!' updates the
audit !og at a set interva!.
This interva! is deterined "' the ,udit6og-pdateInterva! paraeter in the t1s.cfg fi!e.
Aou can anua!!' update the audit !og whenever 'ou want "' using the &rocess ,udit 6og .vents
coand in TM1 *erver .#p!orer. This action updates the audit !og to inc!ude the !atest events and is
especia!!' usefu! to do <ust "efore 'ou open the ,udit 6og window to run Bueries.
)rocedure
*e!ect a TM1 server in *erver .#p!orer. 1.
C!ic/ Ser(er@ )rocess Audit :og 1(ents. 2.
C!ic/ Bes to confir the update process.
The audit !og now contains the !atest audit event records.
$.
172 of 425 26-09-2014 11:18
@.>.4. 0sing t%e Audit :og $indo to 5ie :og Messages
The content of the audit !og is accessi"!e through the ,udit 6og window@ avai!a"!e in TM1F *erver
.#p!orer.
Aou use the ,udit 6og window to Buer' the audit !og and to view the audit !og event essages retrieved
"' the Buer'.
The ,udit 6og window contains two ain pane!s>
Cuery panel 7 -se the ?uer' pane! to "ui!d Bueries that search the audit !og for a specific tie
period or t'pe of event.
2esults panel 7 -se the 0esu!ts pane! to view and navigate the records retrieved "' 'our Buer'.
Opening t%e Audit :og $indo
Aou can open the ,udit 6og window.
Creating and 2unning Cueries
-se search paraeters in the ?uer' pane! of the ,udit 6og window to narrow 'our search.
5ieing 2esults
The 0esu!ts pane! grid organi=es the audit !og records fro the Buer' into the fo!!owing co!uns.
5ieing 1(ent .etails
*oe events have additiona! inforation stored as event detai!s.
Copying .ata to t%e $indos Clipboard
Aou can cop' event data fro the grid to the Windows c!ip"oard.
0sing t%e Find Feature
The 0esu!ts pane! inc!udes a +ind too! that searches for specified te#t in the 0esu!ts grid.
1+porting 2esults
The 0esu!ts pane! a!so inc!udes an e#port option for e#porting resu!ts in 5M6@ coa de!iited@ and
ta" de!iited fi!e forats.
173 of 425 26-09-2014 11:18
@.>.4.1. Opening t%e Audit :og $indo
Aou can open the ,udit 6og window.
)rocedure
*e!ect a TM1F server in *erver .#p!orer. 1.
C!ic/ Ser(er@ 5ie Audit :og.
The ,udit 6og window opens.
Aou can then se!ect the Buer' paraeters that 'ou want and c!ic/ the 2un Cuery "utton to
retrieve the records for the Buer'.
2.
)arent topic* -sing the ,udit 6og Window to 4iew 6og Messages
174 of 425 26-09-2014 11:18
@.>.4.#. Creating and 2unning Cueries
-se search paraeters in the ?uer' pane! of the ,udit 6og window to narrow 'our search.
)rocedure
*et the .ate and Time option.
This option inc!udes pre7defined tie periods inc!uding toda'@ and the !ast 10@ $0@ 80 and ;0 da's.
If 'ou are !oo/ing for events fro a specific tie period@ se!ect Custom Time )eriod fro the Time
)eriod drop7down "o#. .nter a start and end tie.
1.
*et the 1(ent Oner option.
This option as/s the Buestion JWho caused this eventUJ This can "e an actua! TM1F user or a
schedu!ed chore.
C!ic/ All to search for events caused "' an' user or an' schedu!ed chore.
C!ic/ Client to search for events caused on!' "' a user.
C!ic/ Sc%eduled C%ore to search for events caused on!' "' a schedu!ed chore.
To se!ect a specific user or schedu!ed chore@ c!ic/ the *e!ect "utton ne#t to the re!ated fie!d.
The Select Client or Select C%ore dia!og "o# opens.
To se!ect an individua! user or chore nae@ c!ic/ the ite.
To se!ect an ad<acent range of user or chore naes@ c!ic/ the first ite in the range@ ho!d down
*1I+T@ and c!ic/ the !ast ite in the range.
To se!ect u!tip!e nonad<acent user or chore naes@ ho!d down CT06 and c!ic/ each ite.
2.
*et the 1(ent Type option.
-se this option to se!ect the e#act t'pe of event for which 'ou want to search. +or e#ap!e@ Jfind
unsuccessfu! !ogin atteptsJ or Jfind events where a diension was de!etedJ.
C!ic/ All to search for "oth t'pes of audit eventsN s'ste7wide and o"<ect re!ated events.
C!ic/ System!ide to search for on!' s'ste7wide audit events.
To search for a specific s'ste7wide event@ se!ect the event fro the 1(ent !ist.
The defau!t setting@ S@ searches for a!! s'ste7wide events.
C!ic/ Ob8ect to search for events re!ated to on!' TM1 o"<ects.
The Ob8ect option has the fo!!owing su"7options>
*et the Ob8ect Type option to !iit the Buer' to on!' a specific t'pe of TM1 o"<ect. +or e#ap!e@
events re!ated on!' to diensions.
*et the Ob8ect 'ame option to find events for a specific o"<ect nae.
*et the 1(ent option to search for a specific o"<ect event.
The !ist of events changes depending on which t'pe of o"<ect 'ou se!ect in the Ob8ect Type
drop7down "o#.
C!ic/ the *e!ect O"<ect Nae "utton ne#t to the Ob8ect 'ame fie!d to disp!a' a dia!og "o#
where 'ou can se!ect o"<ects "' nae.
$.
175 of 425 26-09-2014 11:18
To se!ect an individua! o"<ect nae@ c!ic/ the ite.
To se!ect an ad<acent range of o"<ect naes@ c!ic/ the first ite in the range@ ho!d down *1I+T@
and c!ic/ the !ast ite in the range.
To se!ect u!tip!e non7ad<acent o"<ect naes@ ho!d down CT06 and c!ic/ each ite.
'ote* When 'ou set O"<ect T'pe to 1lement@ the *e!ect O"<ect Nae "utton "ecoes
disa"!ed "ecause the e!eent !ist cou!d "e too !arge to disp!a'. If 'ou want to search for events
re!ated to a specific e!eent@ 'ou ust anua!!' enter an e!eent nae using the fo!!owing forat>
DimensionName:ElementName
+or e#ap!e> region>ita!'
C!ic/ the 2un Cuery "utton .
The records retrieved "' the Buer' appear in the 2esults pane! grid.
2.
176 of 425 26-09-2014 11:18
@.>.4.-. 5ieing 2esults
The 0esu!ts pane! grid organi=es the audit !og records fro the Buer' into the fo!!owing co!uns.
Message Field .escription
(ate (ate and tie of the event.
-ser TM1F c!ient GuserI or schedu!ed chore that was responsi"!e for causing
the event.
.vent T'peH(escription )rief description of the event.
O"<ect T'pe T'pe of TM1 o"<ect associated with the event.
O"<ect Nae Nae of the TM1 o"<ect associated with the event.
(etai!s (isp!a's an icon to indicate that detai!ed inforation e#ists for the specific
event.
If an event has detai!s@ 'ou can view the detai!s "' c!ic/ing on the .etails
for that record.
Aou can sort the resu!ts in the grid in ascending or descending order for an' co!un "' c!ic/ing on the
co!un tit!e.
177 of 425 26-09-2014 11:18
@.>.4.4. 5ieing 1(ent .etails
*oe events have additiona! inforation stored as event detai!s.
If an event has detai!s@ a (etai!s icon is disp!a'ed in the (etai!s co!un for that event.
To view the detai!s for an event@ c!ic/ the (etai! icon for that event.
.vent detai!s disp!a' in the ,udit 6og (etai!s window@ separate fro the ain ,udit 6og window. Aou can
open u!tip!e ,udit 6og (etai!s windows at a tie to copare the side7"'7side.
178 of 425 26-09-2014 11:18
@.>.4.6. Copying .ata to t%e $indos Clipboard
Aou can cop' event data fro the grid to the Windows c!ip"oard.
The cop' feature is avai!a"!e in "oth the ,udit 6og and ,udit 6og (etai!s windows.
)rocedure
To cop' event data@ high!ight an individua! ce!! in the 0esu!ts grid and then c!ic/ the Copy "utton on
the 0esu!ts too!"ar.
179 of 425 26-09-2014 11:18
@.>.4.>. 0sing t%e Find Feature
The 0esu!ts pane! inc!udes a +ind too! that searches for specified te#t in the 0esu!ts grid.
)rocedure
C!ic/ Find in the 0esu!ts too!"ar.
The +ind dia!og "o# appears.
1.
.nter the te#t 'ou want to find 2.
C!ic/ Find 'e+t.
If the te#t is found@ the ce!! containing the atching te#t is high!ighted in the 0esu!ts grid.
$.
180 of 425 26-09-2014 11:18
@.>.4.?. 1+porting 2esults
The 0esu!ts pane! a!so inc!udes an e#port option for e#porting resu!ts in 5M6@ coa de!iited@ and ta"
de!iited fi!e forats.
The e#port feature is avai!a"!e in "oth the ,udit 6og and ,udit 6og (etai!s windows.
To e#port audit !og data@ cop!ete the fo!!owing steps.
)rocedure
C!ic/ 1+port in the 0esu!ts too!"ar.
The *ave ,s dia!og "o# appears.
1.
.nter a fi!enae and !ocation for the fi!e. 2.
*e!ect the fi!e forat using the Sa(e as type option.
5M6 GS.#!I
C*4 GCoa de!iitedI GS.csvI
Te#t GTa" de!iitedI GS.t#tI
$.
C!ic/ Sa(e. 2.
181 of 425 26-09-2014 11:18
@.?. Monitoring Ser(er )erformance 0sing Control Cubes
TM1F inc!udes a perforance onitoring feature that !ets 'ou record the perforance statistics for
c!ients@ cu"es@ and servers.
When 'ou ena"!e perforance onitoring@ TM1 popu!ates severa! contro! cu"es on a inute7"'7inute
"asis. Aou can then "rowse these cu"es to ana!'=e the server perforance.
The fo!!owing contro! cu"es are popu!ated during perforance onitoring. +or detai!s@ see Contro! Cu"es.
Control Cube 'ame .escription
D*tats)'C!ient Trac/s the essage count@ average essage si=e@ tota! e!apsed tie@ and
other easures for each c!ient on the server.
D*tats)'Cu"e Trac/s the eor' used for each cu"e on the server.
D*tats)'Cu"e)'C!ient Trac/s the nu"er and e!apsed tie of ce!! updates@ ce!! retrieva!s@ view
ca!cu!ations@ and view retrieva!s for each c!ient and cu"e on the server.
D*tats+or*erver Trac/s the connected c!ients@ active threads@ and eor' used "' the
server.
1nabling )erformance Monitoring
Aou can ena"!e perforance onitoring during a server session.
.isabling )erformance Monitoring
Aou can end perforance onitoring during a server session.
5ieing )erformance Statistics for ClientsD CubesD and Ser(ers
,fter ena"!ing perforance onitoring@ 'ou can view the status.
182 of 425 26-09-2014 11:18
@.?.1. 1nabling )erformance Monitoring
Aou can ena"!e perforance onitoring during a server session.
)rocedure
C!ic/ Ser(er@ Start )erformance Monitor. 2.
2esults
Aou have ena"!ed perforance onitoring on a per7session "asis.
If 'ou want to ena"!e perforance onitoring at the start of ever' server session@ 'ou can set the
&erforanceMonitorOn paraeter in the T1s.cfg fi!e to autoatica!!' "egin perforance onitoring
when a server starts.
)arent topic* Monitoring *erver &erforance -sing Contro! Cu"es
183 of 425 26-09-2014 11:18
@.?.#. .isabling )erformance Monitoring
Aou can end perforance onitoring during a server session.
)rocedure
C!ic/ Ser(er@ Stop )erformance Monitor. 2.
184 of 425 26-09-2014 11:18
@.?.-. 5ieing )erformance Statistics for ClientsD CubesD and Ser(ers
,fter ena"!ing perforance onitoring@ 'ou can view the status.
)rocedure
In the *erver .#p!orer@ c!ic/ 5ie@ .isplay Control Ob8ects.
,!! of the Contro! Cu"es wi!! now "e disp!a'ed@ inc!uding the &erforance Monitoring Contro! Cu"es.
1.
Open an' of the &erforance Monitoring Contro! Cu"es to view the cu"e.
The avai!a"!e contro! cu"es inc!ude>
*tats)'C!ient
*tats)'Cu"e
*tats)'Cu"e)'C!ient
*tats+or*erver
+or detai!s@ see Contro! Cu"es and Contro! (iensions.
'ote* The perforance onitor does not update to ref!ect an' new cu"es created or new users
added 12ile the perforance onitor is running. 0estart the perforance onitor to update it with
ites that were added.
2.
185 of 425 26-09-2014 11:18
@.@. 0sing t%e TM1 Top 0tility
The TM1F Top uti!it' d'naica!!' onitors the threads running in an instance of the TM1 server. TM1 Top
can a!so disp!a' inforation a"out the sand"o#es and <o" Bueue for a specific server.
This uti!it' is sii!ar to the -NI5 JtopJ uti!it' which a!!ows d'naic onitoring of the processes running
on a given s'ste.
TM1 Top is a standa!one uti!it' that runs within a conso!e GcoandI window on a Microsoft Windows
s'ste. It is designed to a/e inia! deands on the TM1 server and the supporting networ/ and
s'ste.
With the e#ception of a user7initiated !ogin process@ TM1 Top does not use an' cu"e or diension
resources in the TM1 server@ and does not use or interact with the data or !oc/s on the TM1 server. The
server7side processing that supports TM1 Top runs in a separate !ight thread to a!!ow TM1 Top to report
server state even if the server is unresponsive to users.
'ote* The TM1 Top user interface and he!p te#t are not trans!ated and disp!a' in .ng!ish in non7.ng!ish
versions of TM1 .
.isplaying user names in TM1 Top
The MaskUserNameInServerTools paraeter deterines if user naes are disp!a'ed or as/ed out
in the TM1 Top conso!e disp!a'.
Configuring t%e Tm1top.ini File
)efore running TM1 Top@ edit the initia!i=ation fi!e T1top.ini.
2unning TM1 Top
To run TM1 Top@ edit the T1top.ini fi!e to set the paraeters 'ou want to use then run the .e#e
coand.
5ieing and 0nderstanding t%e TM1 Top .isplay
When TM1 Top is running@ it disp!a's a set of fie!ds and status inforation.
TM1 Top Commands
TM1 Top provides a coand propt to interact with the uti!it'.
Canceling a T%read&s )rocessing
, s'ste adinistrator can use TM1 Top to reBuest the cance!!ation of certain thread operations or
functions that are processing7intensive.
186 of 425 26-09-2014 11:18
@.@.1. .isplaying user names in TM1 Top
The MaskUserNameInServerTools paraeter deterines if user naes are disp!a'ed or as/ed out in
the TM1F Top conso!e disp!a'.
When MaskUserNameInServerTools=TRUE is set in the Tm1s.cfg@ user naes are as/ed in the TM1 Top
for securit' purposes. To unas/ the naes@ the adinistrator can use the V Gverif'I coand to !og in
as an adinistrator.
This paraeter is set to +,6*. "' defau!t. If 'ou do not e#p!icit!' set this paraeter to T0-.@ the TM1
Top conso!e disp!a's user naes even when adinistrator access has not "een verified.
)arent topic* -sing the TM1 Top -ti!it'
187 of 425 26-09-2014 11:18
@.@.#. Configuring t%e Tm1top.ini File
)efore running TM1F Top@ edit the initia!i=ation fi!e T1top.ini.
The T1top.ini fi!e is an ,*CII fi!e that specifies environent inforation for the TM1 Top uti!it'.
)' defau!t@ a sap!e T1top.ini fi!e is insta!!ed to the install6dirP"in director'. When 'ou run TM1 Top@ the
T1top.ini fi!e shou!d "e !ocated in the sae director' as the TM1 Top e#ecuta"!e fi!e.
, sap!e of a configured T1top.ini fi!e is shown "e!ow.
adminhost=
servername=planning sample
logfile=c:\temp\tm1top.log
logperiod=50
logappend=T
refresh=10
adminsvrsslcertid=
adminsvrsslcertauthority=
adminsvrsslcertrevlist=
exportadminsvrsslcert=
adminsvrsslexportkeyid=
If 'ou configure TM1 to use **6 for secure data transission@ then 'ou ust configure the **6
paraeters in the T1top.ini fi!e. +or detai!s a"out configuring TM1 Top to wor/ with **6@ see
Configuring the T1top.ini +i!e.
(o not inc!ude an' spaces "etween the paraeter nae and the paraeter va!ue when editing the
T1top.ini fi!e.
The paraeters in the T1top.ini fi!e are descri"ed in the fo!!owing ta"!e.
,din1ost Machine nae or I& address of the coputer running the ,din *erver. (efau!t
va!ue is !oca!host.
6og+i!e *pecifies the path and fi!e to which the !og inforation is written. ,s TM1 Top is
running@ the status !ines can "e continuous!' written to this ,*CII fi!e so that
the activit' over tie can "e onitored.
+orat is> !ogfi!eKpat2!to!log!file
where pat2!to!log!file ust specif' the cop!ete path@ fi!enae@ and fi!e
e#tension. , defau!t fi!enae and fi!e e#tension is not provided.
6og&eriod *pecifies the tie interva! "etween updates "eing written to the !og fi!e. This
va!ue shou!d "e a u!tip!e of the 0efresh tie paraeter.
The forat for this paraeter is> !ogperiodKnn
188 of 425 26-09-2014 11:18
where nn is the nu"er of e!apsed seconds "etween updates to the !og fi!e.
*etting this to =ero disa"!es !ogging.
+or e#ap!e@ if the screen 0efresh is set to 2 seconds@ 6og&eriod cou!d "e set to
10 seconds so that ever' fifth screen disp!a' wi!! "e output to decrease the
aount of data written to the fi!e.
The defau!t va!ue is 2 seconds.
6og,ppend *pecifies if !og data is appended to the !og fi!e that is set with the 6og+i!e
paraeter@ or if the fi!e is overwritten when a new session is started. If the
6og,ppend paraeter is not set@ the e#isting !og fi!e wi!! "e overwritten.
4a!id va!ues are T and + as shown in the fo!!owing e#ap!es>
If 'ou set 6og,ppendKT@ !og data is appended to the !og fi!e specified "' the
6og+i!e paraeter.
If 'ou set 6og,ppendK+@ the e#isting !og fi!e wi!! "e over7written.
The defau!t va!ue is +@ which overwrites the e#isting !og fi!e.
0efresh Tie interva! "etween refreshing of the TM1 Top disp!a'. +orat is>
refreshKnn
where nn is the tie interva! in seconds.
(efau!t va!ue is 2 seconds.
*erverNae TM1 server nae. This is the *erverNae fro the server configuration fi!e@
T1s.cfg.
'ote* Aou can a!so enter these va!ues at the coand propt when starting TM1 Top@ overriding the
va!ues in the T1top.ini fi!e. +or detai!s@ see 0unning TM1 Top with Coand7!ine Options.
189 of 425 26-09-2014 11:18
@.@.-. 2unning TM1 Top
To run TM1F Top@ edit the T1top.ini fi!e to set the paraeters 'ou want to use then run the .e#e
coand.
)rocedure
.dit the initia!i=ation fi!e@ T1top.ini@ as descri"ed in Configuring the T1top.ini +i!e. 1.
&!ace the T1top.e#e and T1top.ini fi!es in the install6dirP"in director'.
'ote* )' defau!t@ the T1top.e#e fi!e and a sap!e T1top.ini fi!e are insta!!ed in the install6dirP"in
director' when 'ou insta!! the TM1 server.
2.
0un the T1top.e#e fi!e fro a coand propt to start TM1 Top.
tm1top.exe
)' defau!t@ the T1top.ini fi!e is read fro the sae director' that contains the TM1 Top e#ecuta"!e.
To specif' a different !ocation for the T1top.ini fi!e@ use the 7i coand7!ine paraeter as fo!!ows.
tm1top.exe -i path-to-initialization-file
$.
2unning TM1 Top it% Command!line Options
Aou can over7ride the "asic paraeter va!ues in the T1top.ini fi!e "' entering the on the coand
!ine when starting TM1 Top.
190 of 425 26-09-2014 11:18
@.@.-.1. 2unning TM1 Top it% Command!line Options
Aou can over7ride the "asic paraeter va!ues in the T1top.ini fi!e "' entering the on the coand
!ine when starting TM1F Top.
'ote* **6 securit' paraeters can not "e entered at the coand !ine and ust "e specified in the
T1top.ini fi!e if TM1 is configured to use **6. +or detai!s@ see JConfiguring the TM1 Top -ti!it' to -se
**6.J
-se the fo!!owing forat to run TM1 Top with coand7!ine options>
tm1top.exe -OptionName1 OptionValue1 -OptionName2
OptionValue2 ..
Where OptionNae and Option4a!ue can "e an' of the fo!!owing paraeter and va!ue co"inations>
7adinhost ad"in!2ost!na"e
7servernae server!2ost!na"e
7refresh refres2!period
7!ogfi!e file!pat2
7!ogperiod nnn
7!ogappend T or +
+or e#ap!e@ to run TM1 Top with the *erverNae paraeter set to sdata and the refresh paraeter set
to 3 seconds@ enter the fo!!owing>
tm1top.exe -servername sdata -refresh 5
'ote* -se Buotes for paraeter va!ues that inc!ude spaces@ as fo!!ows>
tm1top.exe -servername "planning sample"
To show a !ist of avai!a"!e paraeters@ use the HU option as fo!!ows>
tm1top.exe /?
+or ore detai!s on TM1 Top paraeters@ see Configuring the T1top.ini +i!e.
)arent topic* 0unning TM1 Top
191 of 425 26-09-2014 11:18
@.@.4. 5ieing and 0nderstanding t%e TM1 Top .isplay
When TM1F Top is running@ it disp!a's a set of fie!ds and status inforation.
.ach row in the disp!a' represents one uniBue thread running in the TM1 server that 'ou are onitoring.
The tit!e "ar of the conso!e window disp!a's the current va!ues for the ,din1ost@ *erverNae@ and
0efresh paraeters.
'ote* To see ore !ines or a wider disp!a'@ 'ou can re7si=e the conso!e window or use a sa!!er font si=e.
If the disp!a' fi!!s the entire height of the conso!e window@ 'ou can use the up and down arrow /e's on
'our /e'"oard to go to the ne#t or previous page within the conso!e window.
TM1 Top can run in the fo!!owing different disp!a' odes "' pressing the re!ated /e' when the progra is
running>
Nora! GnI
*and"o# GsI
?ueue G<I
'ormal display mode
In nora! disp!a' ode@ status fie!ds are disp!a'ed "' TM1 Top.
Sandbo+ display mode
Aou can switch TM1 Top to sand"o# ode.
Cueue display mode
Aou can switch TM1 Top to Bueue ode.
0nderstanding TM1 :oc" Modes
TM1 uses a set of three !oc/ odes to contro! access to TM1 data.
0nderstanding TM1 T%read )rocessing States
TM1 Top disp!a's the current processing state of each thread in the *tate fie!d.
192 of 425 26-09-2014 11:18
@.@.4.1. 'ormal display mode
In nora! disp!a' ode@ status fie!ds are disp!a'ed "' TM1F Top.
Field 'ame .escription
I( The thread I( of the under!'ing s'ste thread in the TM1 server.
-ser Nae The nae of the user or process that started the thread. This can "e one of three
possi"!e thread t'pes.
0ser T%read 7 Nae of an actua! user that is !ogged into TM1 . , va!ue of
UUU eans the user is current!' in the !ogin stage.
'ote* The MaskUserNameInServerTools paraeter deterines if user naes
are disp!a'ed or as/ed out in the TM1 Top conso!e disp!a'. +or detai!s@ see
(isp!a'ing user naes in TM1 Top
C%ore T%read 7 , chore running on the TM1 server. The nae of the chore
thread is disp!a'ed in the fo!!owing forat>
C>c2ore!na"e
-ser Nae
;continued<
The nae of the process running under the chore is disp!a'ed in the +unction
fie!d.
System T%read 7 , TM1 s'ste process running on the TM1 server.
(isp!a'ed in the fo!!owing forat>
Th>na"e of s7ste" t2read
Th>&seudo 7 The &seudo thread is used to c!ean up user7defined conso!idation
G-(CI o"<ects.
Th>*tats 7 The *tats thread represents the thread for the perforance
onitor feature that is started when a user se!ects the *tart &erforance
Monitor option in TM1 ,rchitect and *erver .#p!orer.
Th>('naicConf 7 This thread d'naica!!' reads and updates paraeters in
the TM1 server configuration fi!e@ t1s.cfg.
*tate The current processing state of a specific thread. This va!ue can "e one of the
fo!!owing va!ues>
Id!e
0un
Coit
0o!!"ac/
Wait
6ogin
+or ore inforation@ see -nderstanding TM1 Thread &rocessing *tates.
193 of 425 26-09-2014 11:18
Field 'ame .escription
+unction The current ,&I function that the thread is e#ecuting.
If the thread is running a chore@ as opposed to a function for an interactive user@
the +unction fie!d wi!! disp!a' the nae of the process that is current!' e#ecuting
under that chore.
O"< 6oc/ *tatus 6oc/ status of the !ast o"<ect that was !oc/ed.
(isp!a'ed in the forat> (= I>= W=
Where>
(@ I>@ and W represent the different !oc/ odes on the o"<ect. +or ore
inforation@ see -nderstanding TM1 6oc/ Modes.
= is the nu"er of !oc/s for each specific !oc/ ode.
'ote* > The nae of the o"<ect is disp!a'ed in the *tate fie!d.
-ser 6oc/ *tatus Tota! !oc/ status and count for a!! o"<ects "eing used "' a thread.
(isp!a'ed in the forat> (= I>= W=
Where>
(@ I>@ and W represent the different !oc/ odes on the o"<ects. +or ore
= is the tota! nu"er of !oc/s@ across a!! o"<ects@ for each specific !oc/ ode.
Tie The tota! tie@ in seconds@ that the current ,&I function or chore process has
"een processing.
The nae of the ,&I function or chore process is disp!a'ed in the +unction fie!d.
)arent topic* 4iewing and -nderstanding the TM1 Top (isp!a'
194 of 425 26-09-2014 11:18
@.@.4.#. Sandbo+ display mode
Aou can switch TM1F Top to sand"o# ode.
&ressing the s /e' whi!e TM1 Top is running switches to sand"o# ode. &ressing n returns 'ou to the
nora! TM1 Top disp!a'.
In addition to the I( and -sernae fie!ds@ the fo!!owing fie!ds "ecoe avai!a"!e in sand"o# ode>
Fields .escription
,ctive *and"o# Nae of the current!' active sand"o#.
Tota! *and"o# Meor' The Tota! *and"o# Meor' "eing consued for a!! sand"o#es "'
user.
Nu"er of *and"o#es Nu"er of sand"o#es for this user.
195 of 425 26-09-2014 11:18
@.@.4.-. Cueue display mode
Aou can switch TM1F Top to Bueue ode.
&ressing the < /e' whi!e TM1 Top is running switches to Bueue ode. &ressing n returns 'ou to the
nora! TM1 Top disp!a'.
In addition to the I( and -sernae fie!ds@ the fo!!owing fie!ds "ecoe avai!a"!e in Bueue ode>
Fields .escription
Nae Nae of the sand"o# in the Bueue.
Node Nae Nae of the node for the sand"o# in the Bueue.
*tatus (ate@ tie@ and state when the status was ta/en for the sand"o# in
the Bueue.
Tie in ?ueue 6ength of tie sand"o# has "een in the Bueue "efore it was
processed.
196 of 425 26-09-2014 11:18
@.@.4.4. 0nderstanding TM1 :oc" Modes
TM1F uses a set of three !oc/ odes to contro! access to TM1 data.
When the TM1 server is running@ these !oc/s are app!ied to individua! o"<ects@ such as cu"es@ views@ and
diensions@ as these o"<ects are accessed.
TM1 Top disp!a's the status of these !oc/s for the o"<ects "eing used "' the current threads running in a
TM1 server. 6oc/ status is disp!a'ed "' TM1 Top under the *tate@ O"< 6oc/ *tatus@ and Tota! 6oc/ *tatus
fie!ds.
The !oc/ odes for TM1 o"<ects are descri"ed in the fo!!owing ta"!e.
:oc" Mode .escription
0 2!loc" Gread !oc/I 7 , shared !oc/ that a!!ows an' threads to read fro an
o"<ect at the sae tie@ "ut does not a!!ow another thread to odif' or write
to this o"<ect unti! a!! 07!oc/s have "een re!eased.
I5 I9!loc" Gintent7to7write7!oc/I 7 , !oc/ that reserves the right for a thread to
o"tain a W7!oc/ on an o"<ect when a!! 07!oc/s have "een re!eased. On!' one
thread at a tie is a!!owed to have an I57!oc/ on an o"<ect.
W $!loc" Gwrite !oc/I 7 ,n e#c!usive !oc/ that a!!ows on!' one thread at a tie
to access and write changes to an o"<ect. No other thread can read or odif'
this o"<ect unti! the W7!oc/ has "een re!eased.
197 of 425 26-09-2014 11:18
@.@.4.6. 0nderstanding TM1 T%read )rocessing States
TM1F Top disp!a's the current processing state of each thread in the *tate fie!d.
, thread can "e in one of the fo!!owing processing states.
State .escription
Id!e Thread is current!' not processing.
0un Indicates the thread is active!' running. ,!so disp!a's the !oc/ ode and o"<ect
"eing accessed "' the thread in the fo!!owing forat>
0un> :ock Mode!;O?ect 9a"e<!O?ect T7pe
Where>
6oc/ Mode is one of the possi"!e o"<ect !oc/ odesN 0@ I5@ or W. +or ore
O"<ect Nae is the nae of the !ast TM1 o"<ect that was "eing acted on "' the
,&I function disp!a'ed in the +unction fie!d.
O"<ect T'pe is a nueric va!ue representing the t'pe of TM1 o"<ect.
Coit Thread is current!' coitting changes to the o"<ects it was accessing.
0o!!"ac/ Indicates the thread encountered a conf!ict whi!e coitting and cou!d not proceed.
The thread wi!! autoatica!!' re7tr' unti! the conf!ict is reso!ved.
Wait Thread is current!' waiting for a specific condition to cop!ete. (isp!a'ed in the
forat>
Wait> Wait /tatus ! ;O?ect 9a"e< ! O?ect T7pe
Where>
Wait *tatus can "e one of the fo!!owing conditions>
$2 7 GWait+orWriter.ventI Thread is waiting for 07!oc/s to "e re!eased so it
can o"tain a W7!oc/ on the o"<ect.
I92 7 GWait+orI50eader.ventI Thread is waiting for a W7!oc/ to finish so it
can get either an 07!oc/ or an I57!oc/ on an o"<ect.
I9C 7 GWait+orI5Conf!ict.ventI Thread is reBuesting an I57!oc/@ "ut is
waiting for another thread with an I57!oc/ on the sae o"<ect to finish and
re!ease the !oc/.
I9Cur 7 GWait+orI5Current.ventI Thread is reBuesting an I57!oc/ for an
o"<ect@ "ut is waiting for a thread with a 07!oc/ on the sae o"<ect to
re!ease its !oc/.
$C 7 GWait+orCop!etion.ventI Thread is waiting for another thread to
cop!ete and re!ease its !oc/s.
198 of 425 26-09-2014 11:18
State .escription
.22 7 G(ata 0eservation 0e!easeI Thread is waiting for a (ata 0eservation
to "e re!eased.
O?ect 9a"e is the nae of the !ast TM1 o"<ect that was "eing acted on "' the
,&I function disp!a'ed in the +unction fie!d.
O?ect T7pe is a nueric va!ue representing the t'pe of TM1 o"<ect.
6ogin , user is current!' !ogging into the TM1 server.
199 of 425 26-09-2014 11:18
@.@.6. TM1 Top Commands
TM1F Top provides a coand propt to interact with the uti!it'.
Aou can enter the fo!!owing coands at the TM1 Top coand propt identified "' Cmd:_ in the top
!eft corner>
Command .escription
N (isp!a's TM1 Top nora! Gthread statusI ode.
* (isp!a's TM1 Top sand"o# ode.
? (isp!a's TM1 Top Bueue ode.
W Writes the current TM1 Top inforation to a fi!e.
5 .#its the TM1 Top uti!it'.
1 (isp!a's he!p te#t.
4 4erifies a TM1 Top adinistrator session.
(isp!a's a user nae and password propt so the TM1 adinistrator can !og into the
current session of TM1 Top and enter coands to cance! processing in other
threads.
C Cance!s processing in another thread.
'ote* )efore using the Cance! coand@ an adinistrator ust first !og into the
current session of TM1 Top "' using the 4 G4erif'I coand.
C Cance!s a sand"o# su"ission in the <o" Bueue for a specific <o" I( nu"er.
0eBuires adinistrator !ogin with the 4 G4erif'I coand.
-p@ (own arrow
/e's
-se the up and down arrow /e's to scro!! the status disp!a' if there are ore !ines in
the status than the height of the conso!e window.
200 of 425 26-09-2014 11:18
@.@.>. Canceling a T%read&s )rocessing
, s'ste adinistrator can use TM1F Top to reBuest the cance!!ation of certain thread operations or
functions that are processing7intensive.
TM1 Top can cance! on!' the fo!!owing t'pes of threads@ deterined "' the current state of the thread and
the function the thread is current!' processing>
T%reads in a 2un state 7 TM1 can cance! on!' threads with a state of 0un that are running functions
invo!ving either TI processing@ constructing a view@ or ca!cu!ating a view.
T%reads in a $ait state 7 ,n' thread that in a Wait state can "e cance!!ed.
The state of a thread is indicated under the *tate fie!d in the TM1 Top disp!a'.
This functiona!it' provides a wa' to cance! an action that is negative!' ipacting other threads "'
consuing too uch of the server's processing tie. +or e#ap!e@ a TI process that gets stuc/ in a !oop@
or when a user tries to copute a ver' !arge and deanding view.
To cance! a thread@ 'ou ust use the Cance! and 4erif' coands together@ as descri"ed "e!ow.
0nderstanding t%e Cancel )rocess
The Cance! process cance!s a running or waiting thread.
0nderstanding t%e 5erify )rocess
,s a coproise "etween a fu!! !ogin procedure and no securit' at a!!@ TM1 Top reBuires that the TM1
Top user ust first "e JverifiedJ as having adinistrator access "efore the Cance! coand can "e
used.
0sing t%e 5erify and Cancel Commands
Aou can verif' a TM1 Top session and cance! a thread.
201 of 425 26-09-2014 11:18
@.@.>.1. 0nderstanding t%e Cancel )rocess
The Cance! process cance!s a running or waiting thread.
If a thread has a 0un state@ and the process invo!ves TI processing@ constructing a view@ or
ca!cu!ating a view@ then the thread can "e cance!!ed. Whi!e running@ the thread wi!! chec/ to see if its
Je#it indicatorJ has "een set@ and if set@ the thread wi!! e#it out of the current operation.
If a thread is in the Wait state@ the thread is cance!!ed in two steps. +irst@ the cance! coand
re!eases the thread !oc/ reBuest@ and then the cance! coand cance!s the thread processing.
)arent topic* Cance!ing a Thread's &rocessing
202 of 425 26-09-2014 11:18
@.@.>.#. 0nderstanding t%e 5erify )rocess
,s a coproise "etween a fu!! !ogin procedure and no securit' at a!!@ TM1F Top reBuires that the TM1
Top user ust first "e JverifiedJ as having adinistrator access "efore the Cance! coand can "e used.
TM1 Top was designed to run without reBuiring a user to !og on to the server. This a!!ows TM1 Top to run
against a server which ight "e resource dead!oc/ed. If a !ogin procedure was reBuired@ then the !ogin
process wou!d a!so "ecoe dead!oc/ed "ecause it reBuires access to cu"es and other data that are
anipu!ated under the resource !oc/s.
1owever@ it is not desira"!e to a!!ow <ust an' user running TM1 Top to cance! user threads. This
verification process is initiated using the 4 Gverif'I coand. The process can "e done in advance and is
aintained for the !ife of the TM1 Top connection.
203 of 425 26-09-2014 11:18
@.@.>.-. 0sing t%e 5erify and Cancel Commands
Aou can verif' a TM1F Top session and cance! a thread.
)rocedure
.nter 4 to disp!a' the fo!!owing propt to verif' a TM1 Top session>
Verify Admin Access
Admin User Name:
1.
.nter the !ogin nae of an adin user.
The fo!!owing propt disp!a's>
Verify Admin Access
Admin Password:
2.
.nter the password for the adin user.
If 'ou entered a va!id adin user nae and password@ then the fo!!owing confiration disp!a's>
Admin access verified
Press any key to continue:
$.
,fter the session has "een verified@ enter C to initiate the Cance! process.
The fo!!owing propt disp!a's>
Cancel processing of a thread
Thread-id:
2.
.nter the I( of the thread to "e cance!ed. Aou can find the thread I( disp!a'ed in the first co!un of
the TM1 Top disp!a'.
3.
204 of 425 26-09-2014 11:18
@.A. 0sing TM1 )erformance Counters
TM1F perforance counters are a co!!ection of va!ues that are continuous!' updated to provide rea!tie
onitoring of TM1 server perforance.
These va!ues are increented and decreented in rea!tie to trac/ specific TM1 properties and activities
for cu"es@ views@ su"sets@ diensions@ and readHwrite activit'.
Aou can view perforance counters with the fo!!owing too!s>
TM1 &erfMon uti!it' 7 , te#t7on!' disp!a' of TM1 perforance counters that runs in a conso!e window
on Microsoft Windows and -NI5 s'stes. The TM1 &erfMon uti!it' can onitor !oca! TM1 servers on!'.
Microsoft Windows &erforance Monitor 7 , Microsoft Windows too! that provides an interactive@
graphica! disp!a' of TM1 perforance counters to onitor !oca! and reote Windows TM1 servers.
Important 'ote about 2unning TM1 )erformance Counter Tools
Aou need the sae adinistrator rights and privi!eges to run TM1 &erfMon on a Microsoft Windows
s'ste as 'ou do to run the Microsoft Windows &erforance Monitor.
A(ailable TM1 )erformance Counters
TM1 provides a set of ore than $0 perforance counters@ organi=ed into groups@ such as Cu"es@
(iensions@ *u"sets@ Meor'@ Threads@ and 4iews.
5ieing TM1 )erformance Counters it% t%e TM1 )erfMon 0tility
TM1 &erfMon is a conso!e uti!it' for Microsoft Windows and -NI5 s'stes that provides a te#t disp!a'
of TM1 perforance counters.
5ieing TM1 )erformance Counters it% t%e Microsoft $indos )erformance Monitor
-se the Microsoft Windows &erforance Monitor to view TM1 perforance counters in a
graphica!7t'pe disp!a' for Windows TM1 servers on!'.
205 of 425 26-09-2014 11:18
@.A.1. Important 'ote about 2unning TM1 )erformance Counter Tools
Aou need the sae adinistrator rights and privi!eges to run TM1F &erfMon on a Microsoft Windows
s'ste as 'ou do to run the Microsoft Windows &erforance Monitor.
The user ust "e a e"er of the !oca! ,dinistrators group to run either TM1 &erfMon or the
Microsoft Windows &erforance Monitor.
The user ust "e a e"er of the ,dinistrators group@ on "oth the !oca! and reote s'stes@ to
onitor a reote TM1 server using the Microsoft Windows &erforance Monitor.
4iewing TM1 perforance counters with the Microsoft Windows &erforance Monitor is not supported on
827"it Inte! Itaniu II s'stes. When running TM1 with this configuration@ use the TM1&erfMon conso!e
uti!it' to view TM1 perforance counters.
)arent topic* -sing TM1 &erforance Counters
206 of 425 26-09-2014 11:18
@.A.#. A(ailable TM1 )erformance Counters
TM1F provides a set of ore than $0 perforance counters@ organi=ed into groups@ such as Cu"es@
(iensions@ *u"sets@ Meor'@ Threads@ and 4iews.
.#ap!es of TM1 perforance counters inc!ude>
Threads created
4iews and (iensions created and destro'ed
*u"sets created@ dup!icated@ destro'ed@ and de!eted
0ead !oc/ reBuests and waits
'ote* To see a cop!ete@ updated !ist of avai!a"!e TM1 perforance counters@ with descriptions@ use the
Microsoft Windows &erforance Monitor as descri"ed in ,dding and 4iewing TM1 &erforance Counters in
the Microsoft Windows &erforance Monitor.
207 of 425 26-09-2014 11:18
@.A.-. 5ieing TM1 )erformance Counters it% t%e TM1 )erfMon
0tility
TM1F &erfMon is a conso!e uti!it' for Microsoft Windows and -NI5 s'stes that provides a te#t disp!a' of
TM1 perforance counters.
2unning TM1)erfMon
0un the t1perfon.e#e fi!e fro a coand !ine on either a Microsoft Windows or -NI5 s'ste.
5ieing t%e TM1 )erfMon .isplay Output
Aou can view disp!a' output fro TM1 &erfMon.
1+iting TM1 )erfMon
Aou can e#it the TM1 &erfMon whi!e the uti!it' is sti!! !ooping.
208 of 425 26-09-2014 11:18
@.A.-.1. 2unning TM1)erfMon
0un the t1perfon.e#e fi!e fro a coand !ine on either a Microsoft Windows or -NI5 s'ste.
-se the fo!!owing forat and paraeters>
tm1perfmon -servername 9a"e -loop :oopCount -sleep /leepTi"e
Where>
9a"e is the nae of the TM1F server to onitor. -se Buotes when the server nae inc!udes spaces.
+or e#ap!e>
-servername "planning sample"
:oopCount is the nu"er of ties to repeat@ or refresh@ the disp!a' of counter va!ues. (efau!t va!ue is
1@ no !oop. This va!ue is optiona!.
, va!ue of 0 causes TM1 &erfMon to !oop indefinite!'.
To cance! TM1 &erfMon whi!e !ooping@ press the CT06Q)rea/ /e's to return to the coand propt.
/leepTi"e is the tie@ in seconds@ "etween !oops. (efau!t va!ue is 3 seconds. This va!ue is optiona!.
+or e#ap!e@ the fo!!owing coand !ine wou!d run TM1 &erfMon continuous!' to onitor a TM1 server
naed p!anning sap!e. The disp!a' wou!d continue to refresh ever' 3 seconds@ using the defau!t va!ue
for the s!eep option@ unti! 'ou e#it "' pressing the CT06Q)rea/ /e's.
tm1perfmon -servername "planning sample" -loop 0
The fo!!owing coand !ine wou!d run TM1 &erfMon to onitor the sa!esdata TM1 server@ !ooping a tota!
of 10 ties with a 3 second refresh rate "etween disp!a' updates.
tm1perfmon -servername salesdata -loop 10 -sleep 5
'ote* If 'ou do not inc!ude va!ues for the !oop and s!eep options@ as shown in the fo!!owing e#ap!e@
TM1 &erfMon wi!! run and disp!a' the TM1 perforance counters once on!'.
tm1perfmon -servername salesdata
)arent topic* 4iewing TM1 &erforance Counters with the TM1 &erfMon -ti!it'
209 of 425 26-09-2014 11:18
@.A.-.#. 5ieing t%e TM1 )erfMon .isplay Output
Aou can view disp!a' output fro TM1F &erfMon.
It !oo/s sii!ar to the fo!!owing>
C:\>tm1perfmon -server cdata
TM1 Version: 9.0.3.226
Output data and time Tue Dec 05 17:36:42 2006
Counter Name/ Value
Threads: Threads created 6
Threads: Threads Creation Retry Attemtps 0
Threads: Thread Creations Failures 0
Views: Views Created 23
Views: Empty Views Created 0
Views: Views Destroyed 0
Dimensions: Dimensions Created 0
Dimensions: Dimensions Destroyed 119
Cubes: Cubes Invalidated 0
Cubes: Dependent Cubes Invalidated 1
Subsets: Subset Create Empty 0
Subsets: Subset Calculated by Expression 0
Subsest: Subset Calculated with Empty Expression 0
Subsets: Subset Calculated by Expression 0
Subsets: Subset Created by Expression 0
Subsets: Subset Created by MDX Expression 0
Subsets: Subset Duplicated 0
Subsets: Subsets destroyed 0
Subsets: Subsets Deleted 0
The tit!e fie!ds in the disp!a' inc!ude>
Field .escription
Counter Nae Group nae and counter nae for each TM1 perforance counter.
(isp!a'ed in the forat> GroupNae>CounterNae
+or e#ap!e> Threads>Threads Created
4a!ue Nueric va!ue for the TM1 perforance counter at the specific output date
and tie.
210 of 425 26-09-2014 11:18
211 of 425 26-09-2014 11:18
@.A.-.-. 1+iting TM1 )erfMon
Aou can e#it the TM1F &erfMon whi!e the uti!it' is sti!! !ooping.
)rocedure
&ress CT06Q)rea/ at an' tie.
212 of 425 26-09-2014 11:18
@.A.4. 5ieing TM1 )erformance Counters it% t%e Microsoft $indos
)erformance Monitor
-se the Microsoft Windows &erforance Monitor to view TM1F perforance counters in a graphica!7t'pe
disp!a' for Windows TM1 servers on!'.
The Microsoft Windows &erforance Monitor is supp!ied with current versions of Microsoft Windows and
runs as an add7in to the Microsoft Manageent Conso!e.
Opening t%e Microsoft $indos )erformance Monitor
Open the Microsoft Windows &erforance Monitor.
Adding and 5ieing TM1 )erformance Counters in t%e Microsoft $indos )erformance
Monitor
Aou can view TM1 perforance counters "' adding the with the ,dd Counters dia!og "o# in the
Microsoft Windows &erforance Monitor. This dia!og a!so !ets 'ou view a "rief e#p!anation of each
counter.
213 of 425 26-09-2014 11:18
@.A.4.1. Opening t%e Microsoft $indos )erformance Monitor
Open the Microsoft Windows &erforance Monitor.
)rocedure
C!ic/ Start@ Settings@ Control )anel@ Administrati(e Tools@ )erformance.
The Microsoft Windows &erforance Monitor opens.
)arent topic* 4iewing TM1 &erforance Counters with the Microsoft Windows &erforance Monitor
214 of 425 26-09-2014 11:18
@.A.4.#. Adding and 5ieing TM1 )erformance Counters in t%e
Microsoft $indos )erformance Monitor
Aou can view TM1F perforance counters "' adding the with the ,dd Counters dia!og "o# in the
Microsoft Windows &erforance Monitor. This dia!og a!so !ets 'ou view a "rief e#p!anation of each counter.
This dia!og a!so !ets 'ou view a "rief e#p!anation of each counter.
)rocedure
C!ic/ Add in the &erforance Monitor too!"ar.
The ,dd Counters dia!og "o# disp!a's.
'ote* Microsoft Windows can soeties disp!a' the fo!!owing essage when 'ou open or c!ose the
,dd Counters dia!og.
J,t !east one data sap!e is issing. (ata co!!ection is ta/ing !onger than e#pected. Aou ight avoid
this essage "' increasing the sap!e interva!. This essage wi!! not "e shown again during this
session.J
This essage is inforationa! on!' and t'pica! if the s'ste "ecoes too "us' when adding new
counters. C!ic/ O; to c!ear the essage.
1.
*e!ect I/M Cognos TM1 fro the &erforance o"<ect !ist.
The avai!a"!e perforance counters disp!a' in the perforance counter !ist.
2.
*e!ect a perforance counter fro the !ist of avai!a"!e counters.
Aou can a!so c!ic/ .#p!ain to see a te#t description of the current!' se!ected counter.
$.
*e!ect the instance of the server 'ou want to onitor. 2.
C!ic/ Add to add the se!ected counter to the perforance disp!a'. 3.
C!ic/ Close to c!ose the ,dd Counters dia!og and return to the &erforance Monitor.
The &erforance Monitor wi!! add the TM1 perforance counters to the onitoring process and
update the disp!a' as shown in the fo!!owing figure.
8.
215 of 425 26-09-2014 11:18
)arent topic* 4iewing TM1 &erforance Counters with the Microsoft Windows &erforance Monitor
216 of 425 26-09-2014 11:18
@.10. Capturing Core .umps for TM1 Ser(er Cras% Analysis
Aou want to ensure that ever'thing is in p!ace in case 'ou e#perience a TM1F server crash.
It is iperative that the appropriate de"ugging too!s are configured correct!' and the correct fi!es are
co!!ected and sent to I)MF CognosF support andHor engineering for ana!'sis.
217 of 425 26-09-2014 11:18
@.11. .ebugging Tools for $indos
Aou can use either ,(&!us or (r. Watson as a de"ugging too! to co!!ect server crash inforation on a
Windows s'ste.
Installing and 2unning A.)lus
,(&!us is part of the Microsoft (e"ugging Too!s for Windows pac/age.
2unning .r. $atson
(r. Watson is part of the Windows operating s'ste@ so 'ou do not need to insta!! the too!.
Collecting Files for Analysis Folloing A TM1 Ser(er Cras%
If the TM1 server crashes@ 'ou ust co!!ect the fo!!owing fi!es for I)M support and engineering to
ana!'=e>
Transmitting Files to Cognos
Once a!! reBuired fi!es are co!!ected@ 'ou ust de!iver the fi!es to Cognos support for ana!'sis.
218 of 425 26-09-2014 11:18
@.11.1. Installing and 2unning A.)lus
,(&!us is part of the Microsoft (e"ugging Too!s for Windows pac/age.
Aou can down!oad the ost recent pac/age at http>HHwww.icrosoft.coHwhdcHdevtoo!sHde"ugging
Hdefau!t.sp#.
)oth a $27"it version and a 827"it version of (e"ugging Too!s for Windows is avai!a"!e@ "e sure to
down!oad the version that is appropriate for 'our operating s'ste.
+or cop!ete detai!s on ,(&!us@ inc!uding s'ste reBuireents@ see http>HHsupport.icrosoft.co
H/"H2:8$30.
2unning A.)lus .irectly on t%e TM1 Ser(er
0un ,(&!us direct!' on the coputer where the TM1F server is insta!!ed.
2unning A.)lus 2emotely from a TM1 Client
Aou can run ,(&!us on a different coputer.
)arent topic* (e"ugging Too!s for Windows
219 of 425 26-09-2014 11:18
@.11.1.1. 2unning A.)lus .irectly on t%e TM1 Ser(er
0un ,(&!us direct!' on the coputer where the TM1F server is insta!!ed.
)rocedure
*tart the TM1 server. 1.
Open a coand propt window and cd to the (e"ugging Too!s for Windows director'. The defau!t
director' on a $27"it s'ste is C>P&rogra +i!esP(e"ugging Too!s for Windows G#:8I.
2.
Open the Windows Tas/ Manager and note the process I( G&I(I for T1s.e#e Gif running the server
as an app!icationI or T1sd.e#e Gif running the server as a serviceI.
$.
,t the coand propt@ enter adplus crash p [PID]
+or e#ap!e@ adplus crash p 492
If 'ou cannot deterine the process I( for the server 'ou want to onitor@ 'ou can a!so use one of
the fo!!owing coands to start ,(&!us>
adplus -crash -pn tm1sd.exe if running the TM1 server as a service
adplus -crash -pn tm1s.exe if running the TM1 server as an app!ication
2.
, warning essage appears indicating that an environent varia"!e is not set. Aou do not have to
ta/e an' action "ased on this warning. C!ic/ O; to disiss the warning.
,nother essage appears indicating that a new su"director' wi!! "e created in the (e"ugging Too!s
for Windows director'. The new su"director'@ which is naed Crash%Mode%Date/ta"p%Ti"e/ta"p@
receives the dup fi!es that are generated when the TM1 server crashes.
3.
C!ic/ O; to disiss the essage.
Note that a new coand propt window is now open on 'our des/top. The Microsoft Conso!e
(e"ugger Gcd".e#eI runs in this window@ as shown in the fo!!owing iage.
8.
Monitoring t%e TM1 Ser(er
If 'ou are onitoring the server@ <ust continue 'our dai!' activit'.
0sing CT2:!C to Force a TM1 Ser(er Cras%
Aou can force a server crash.
220 of 425 26-09-2014 11:18
Ta"ing a Snaps%ot of Current Ser(er State
Aou can ta/e a snapshot of the current server state@ whi!e !eaving the TM1 server running>
)arent topic* Insta!!ing and 0unning ,(&!us
221 of 425 26-09-2014 11:18
@.11.1.1.1. Monitoring t%e TM1 Ser(er
If 'ou are onitoring the server@ <ust continue 'our dai!' activit'.
When the server crashes@ three dup fi!es G.dpI are created in the
Crash%Mode%Date/ta"p%Ti"e/ta"psu"director'. The on!' one I)MF needs to de"ug the server crash is
the ...2nd chance_AccessViolationfi!e.
)arent topic* 0unning ,(&!us (irect!' on the TM1 *erver
222 of 425 26-09-2014 11:18
@.11.1.1.#. 0sing CT2:!C to Force a TM1 Ser(er Cras%
Aou can force a server crash.
.nter CT2:!C in the cd".e#e coand propt window.
The nae of the resu!ting dup G.dpI fi!e wi!! inc!ude the string ...1st_chance_CONTROL_C_OR
Debug_Break.... This is the fi!e I)MF needs to de"ug the TM1F server.
223 of 425 26-09-2014 11:18
@.11.1.1.-. Ta"ing a Snaps%ot of Current Ser(er State
Aou can ta/e a snapshot of the current server state@ whi!e !eaving the TM1F server running>
)rocedure
*tart the TM1 server. 1.
Open the Windows Tas/ Manager and note the process I( G&I(I for T1s.e#e Gif running the TM1
server as an app!icationI or T1sd.e#e Gif running the TM1 server as a serviceI.
2.
Open a coand propt window and cd to the (e"ugging Too!s for Windows director' $.
,t the coand propt@ enter adplus hang p <PID>.
+or e#ap!e@ adplus hang p 492
'ote* Aou can run a -hang coand even when adp!us is a!read' running in -crash ode.
, warning essage appears indicating that an environent varia"!e is not set. Aou do not have to
ta/e an' action "ased on this warning.
2.
C!ic/ O; to disiss the warning.
,nother essage appears indicating that ,(p!us is running in 1,NG ode. The essage a!so
indicates that a su"director' wi!! "e created in the (e"ugging Too!s for Windows director'. The new
su"director'@ which is naed 1ang%Mode%Date/ta"p%Ti"e/ta"p@ receives the dup fi!es that
record the current server state.
3.
C!ic/ O; to disiss the essage.
, new dup fi!e is iediate!' generated@ recording the current server state.
8.
Open the new su"director' in the (e"ugging Too!s for Windows director' and note the presence of a
sing!e dup G.dpI fi!e. This is the fi!e I)MF needs to de"ug 'our server.
9.
224 of 425 26-09-2014 11:18
@.11.1.#. 2unning A.)lus 2emotely from a TM1 Client
Aou can run ,(&!us on a different coputer.
In soe environents@ 'ou ight want to anage and run ,(&!us fro the coputer on which a TM1F
c!ient is running@ rather than direct!' fro the TM1 server.
Installing and 2unning A.)lus on t%e Ser(er
Aou can insta!! and run ,(&!us on the coputer where the TM1 server is running.
2unning A.)lus from a TM1 Client
Aou can run ,(&!us fro a coputer on which a TM1 c!ient is insta!!ed.
Stopping A.)lus
Aou can stop ,(&!us.
)arent topic* Insta!!ing and 0unning ,(&!us
225 of 425 26-09-2014 11:18
@.11.1.#.1. Installing and 2unning A.)lus on t%e Ser(er
Aou can insta!! and run ,(&!us on the coputer where the TM1F server is running.
)rocedure
Insta!! the Microsoft (e"ugging Too!s for Windows pac/age. 1.
Create a "atch fi!e naed Remoteshell.cmd in the de"ugging too!s insta!!ation director' GC>P&rogra
+i!esP(e"ugging Too!s for Windows G#:8I if 'ou accepted the defau!t insta!!ation director' on a $27"it
s'ste.I This "atch fi!e shou!d contain the fo!!owing sing!e !ine>
C:\Program Files\Debugging Tools for Windows (x86)\remote.exe /s "cmd.exe"
remoteshell
2.
+ro a coand propt@ enter the fo!!owing !ine>
at # "inutes past current ti"e@ #* 2our for"at C>P&rogra +i!esP(e"ugging Too!s for Windows
G#:8IPreoteshe!!.cd
+or e#ap!e@ if 'our s'ste c!oc/ shows 2>23 &M@ enter the fo!!owing !ine at the coand propt>
at 16:47 C:\Program Files\Debugging Tools for Windows (x86)\remoteshell.cmd
This coand. wi!! run the reoteshe!!.cd "atch fi!e at 2>29 &M
$.
,fter the specified tie@ run the at coand fro a coand propt. (o not inc!ude an'
paraeters to the coand@ t'pe on!' at.
If the remoteshell.cmd "atch fi!e ran successfu!!'@ 'ou shou!d see a report that !ists the *tatus@ (a'@
Tie and Coand 6ine !isting such as Jc>P&rogra +i!esP(e"ugging Too!s for
WindowsPreoteshe!!.cd.J
+or ore detai!s on the at coand@ see http>HHtechnet2.icrosoft.coHwindowsserverHenH!i"rar'
H20";"e"17$39:72:f;7;$e179ca8980c1c1310$$.sp#.
2.
Open the Windows Tas/ Manager and note the process I( G&I(I for T1s.e#e Gif running the TM1
server as an app!icationI or T1sd.e#e Gif running the TM1 server as a serviceI. Aou wi!! need to
/now the &I( when running ,(&!us fro the TM1 c!ient.
3.
)arent topic* 0unning ,(&!us 0eote!' fro a TM1 C!ient
226 of 425 26-09-2014 11:18
@.11.1.#.#. 2unning A.)lus from a TM1 Client
Aou can run ,(&!us fro a coputer on which a TM1F c!ient is insta!!ed.
)rocedure
Cop' the reote.e#e and "rea/in.e#e fi!es fro the de"ugging too!s insta!!ation director' on the TM1
server coputer. GC>P&rogra +i!esP(e"ugging Too!s for Windows G#:8I if 'ou accepted the defau!t
insta!!ation director' on a $27"it s'ste.I
1.
*ave reote.e#e and "rea/in.e#e to an easi!' identified director' on the coputer running the TM1
c!ient. These instructions assue that reote.e#e is saved in C>Pde"uggers.
2.
Open a coand propt and cd to the C:\debuggers fo!der. $.
.nter the fo!!owing coand>
reote.e#e Hc re"ote server na"e reoteshe!!
re"ote server na"e is the nae of the coputer on which the TM1 server is insta!!edN it is not the
nae of the TM1 server. +or e#ap!e@ if sithers is the nae of the coputer where the server is
insta!!ed@ 'ou wou!d enter the coand
remote.exe /c smithers remoteshell
2.
Aou are now running coands on the server coputer fro the coand propt on the c!ient
coputer. To confir that 'ou are proper!' connected to the server@ enter dir C:\ at the coand
propt. Aou shou!d see the contents of the C drive on the server.
3.
+ro the coand propt@ cd to the de"ugging too!s insta!!ation director' on the TM1 server
coputer. ,gain@ this is C>P&rogra +i!esP(e"ugging Too!s for Windows G#:8I if 'ou accepted the
defau!t insta!!ation director' on a $27"it s'ste.
8.
.nter the fo!!owing at the coand propt>
Adplus -crash -quiet -p <PID>
&I( is the process I( of the TM1 server. +or e#ap!e@ if the process I( for the server is 13::@ enter
Adplus -crash -quiet -p 1588 at the coand propt.
Aou shou!d receive confiration that the de"ugger is attached to the TM1 server.
,(&!us is now read' to co!!ect de"ugging inforation and wi!! continue to onitor the server unti! it
crashes.
9.
227 of 425 26-09-2014 11:18
@.11.1.#.-. Stopping A.)lus
Aou can stop ,(&!us.
-sua!!'@ 'ou wi!! want to !et ,(&!us run unti! a server crash occurs. 1owever@ if 'ou need to stop ,(&!us@
enter the fo!!owing !ine at the coand propt on the c!ient coputer>
breakin.exe <PID>
&I( is the process I( of the TM1F server. +or e#ap!e@ if the process I( for the TM1 server is 13::@
enter breakin.exe 1588 at the coand propt to stop the de"ugging process.
228 of 425 26-09-2014 11:18
@.11.#. 2unning .r. $atson
(r. Watson is part of the Windows operating s'ste@ so 'ou do not need to insta!! the too!.
)rocedure
+ro the Windows tas/"ar@ c!ic/ Start@ then c!ic/ 2un 1.
In the 0un dia!og "o#@ enter drwtsn32@ then c!ic/ O;. 2.
In the (r. Watson dia!og "o#@ the 6og +i!e &ath can "e set to an' path and Crash (up can "e set to
an' pathHfi!enae 'ou want. Ta/e note of the pathHfi!enae 'ou set for the Crash (up@ as this fi!e
ust "e sent to I)MF for ana!'sis.
$.
*et and ena"!e on!' the fo!!owing options>
Nu"er of Instructions> 10
Nu"er of .rrors to *ave> 10
Crash (up T'pe> +u!!
(up *'"o! Ta"!e
(up ,!! Thread Contents
Create Crash (up +i!e
2.
C!ic/ O; to "egin running (r. Watson. 3.
Setting .r. $atson as t%e .efault .ebugging Tool
If 'ou have ,(&!us or another de"ugging too! insta!!ed on 'our s'ste@ 'ou a' need to set (r.
Watson as the defau!t de"ugger.
229 of 425 26-09-2014 11:18
@.11.#.1. Setting .r. $atson as t%e .efault .ebugging Tool
If 'ou have ,(&!us or another de"ugging too! insta!!ed on 'our s'ste@ 'ou a' need to set (r. Watson
as the defau!t de"ugger.
)rocedure
+ro the Windows tas/"ar@ c!ic/ Start@ then c!ic/ 2un. 1.
In the 0un dia!og "o#@ enter drwtsn32 -i@ then c!ic/ O;.
Aou can now confir that (r. Watson is running as the defau!t de"ugger.
2.
+ro the Windows tas/"ar@ c!ic/ Start@ then c!ic/ 2un. $.
In the 0un dia!og "o#@ enter regedit@ then c!ic/ O;. 2.
+ro the 0egistr' .ditor@ c!ic/ 1dit@ then c!ic/ Find. 3.
*earch for Ae.ebug in the registr'.
The settings for the ,e(e"ug /e' shou!d show drwatsn32 set as 'our (e"ugger.
8.
)arent topic* 0unning (r. Watson
230 of 425 26-09-2014 11:18
@.11.-. Collecting Files for Analysis Folloing A TM1 Ser(er Cras%
If the TM1F server crashes@ 'ou ust co!!ect the fo!!owing fi!es for I)MF support and engineering to
ana!'=e>
The dup fi!e generated "' 'our de"ugging too!.
If 'ou are running ,(&!us@ the dup fi!e is naed
ProcessID%Process9a"e%2nd%chance%,ccess4io!ation%Ti"e/ta"p.dp. +or e#ap!e@
&I(72;2%TM1*(..5.%2nd%chance%,ccess4io!ation%fu!!%O():%200:70$70:%1071973;7032%01.C.dp
If 'ou are running (r. Watson@ the dup fi!e nae and !ocation was set with the Crash (up option
when 'ou started (r. Watson.
The T1server.!og fi!e. This fi!e is !ocated in the TM1 server data director'.
,!! TM1&rocess.rror.!og fi!es generated during the server session that crashed.
When a process error !og fi!e is generated@ TM1 assigns a uniBue nae that !ets 'ou readi!' identif'
which Tur"oIntegrator process generated the error fi!e and the tie at which the fi!e was created. +i!e
naes are assigned using the convention TM1&rocess.rror%ti"e sta"p%process na"e.!og. In this
convention@ ti"e sta"p is the tie Ge#pressed as ''''ddhhss GMTI at which the fi!e was
generated and process na"e is the nae of the Tur"oIntegrator process that caused the errors.
There a' "e u!tip!e TM1&rocess.rror.!og fi!es associated with the server session that crashed. ,!!
TM1&rocess.rror.!og fi!es are stored in the server data director'.
If 'ou are running TM1 Top@ co!!ect the TM1 Top !og fi!e. The !ocation and nae of the !og fi!e are
deterined "' the !ogfi!e paraeter to the T1top.ini configuration fi!e.
The T1top.ini configuration fi!e is !ocated in the sae director' as the TM1 Top e#ecuta"!e fi!e
GT1top.e#eI@ which is usua!!' install dirP "in. If 'ou accepted the defau!t TM1 insta!!ation director'@
the fu!! path is C:\Program Files\IBM\cognos\tm1\bin.
(O NOT co!!ect the TM1 transaction !og GT1s.!ogI un!ess specifica!!' reBuested "' I)M support.
231 of 425 26-09-2014 11:18
@.11.4. Transmitting Files to Cognos
Once a!! reBuired fi!es are co!!ected@ 'ou ust de!iver the fi!es to CognosF support for ana!'sis.
There are severa! options for de!ivering the fi!es.
The Buic/est wa' to de!iver fi!es to I)MF is to up!oad the to the I)M +T& server. Aou can access the
I)M +T& server fro a coand propt or fro a We" "rowser.
0ploading from a Command )rompt
Aou can up!oad fi!es to the I)M +T& server fro a coand propt.
0ploading from a $eb /roser
Aou can up!oad fi!es to the I)M +T& server fro a We" "rowser.
0ploading to Bour FT) Ser(er
,!ternative!'@ 'ou can up!oad the fi!es to 'our own +T& server and contact I)M support with
instructions for retrieving the fi!es.
232 of 425 26-09-2014 11:18
@.11.4.1. 0ploading from a Command )rompt
Aou can up!oad fi!es to the I)MF +T& server fro a coand propt.
)rocedure
cd to the director' where the fi!e 'ou want to up!oad resides. 1.
,t the coand propt@ enter ftp testcase.boulder.ibm.com. 2.
When propted for a usernae@ enter anonymous. $.
When propted for a password@ enter 'our eai! address.
The 5irtual user anonymous logged in essage confirs that 'ou are connected to the +T&
server.
2.
cd to the /toibm/im director'. 3.
,t the coand propt@ enter bin to set the up!oad ode to "inar'. 8.
,t the coand propt@ enter put fo!!owed "' the nae of the fi!e 'ou want to up!oad. +or e#ap!e@
to up!oad a fi!e naed M'(up+i!es.=ip@ enter put My.umpFiles.7ip.
9.
)arent topic* Transitting +i!es to Cognos
233 of 425 26-09-2014 11:18
@.11.4.#. 0ploading from a $eb /roser
Aou can up!oad fi!es to the I)MF +T& server fro a We" "rowser.
)rocedure
Go to %ttps*==testcase.boulder.ibm.com. 1.
6og in with user nae anonymous. No password is reBuired for an anon'ous !ogin. 2.
C!ic/ the toibm fo!der. $.
C!ic/ the im fo!der. 2.
C!ic/ /rose and navigate to the fi!e 'ou want to up!oad. 3.
C!ic/ 0pload file EbinaryF. 8.
234 of 425 26-09-2014 11:18
@.11.4.-. 0ploading to Bour FT) Ser(er
,!ternative!'@ 'ou can up!oad the fi!es to 'our own +T& server and contact I)MF support with instructions
for retrieving the fi!es.
Aou shou!d use 'our own +T& server on!' if 'ou cannot esta"!ish a connection to the I)M +T& server.
235 of 425 26-09-2014 11:18
A. Cognos TM1 Tools and 0tilities
-se the fo!!owing too!s and uti!ities with I)MF CognosF TM1F .
Ta"!e 1. TM1 Too!s and -ti!ities
Tool .escription
TM1Top Coand !ine too! for onitoring TM1 server activit'. *ee -sing the TM1 Top
-ti!it'.
Cognos TM1
Operations Conso!e
We"7"ased@ enhanced version of TM1Top with added features and a graphica! user
interface. *ee the IBM Cognos TM1 Operations Console Guide.
TM10unTI Coand !ine interface too! that initiates a Cognos TM1 Tur"oIntegrator GTII
process fro within an' app!ication capa"!e of issuing operating s'ste
coands. *ee J-sing TM10unTIJ in the TM1 TuroIntegrator Guide-
*'nchroni=edGI Cognos TM1 Tur"oIntegrator GTII function used in a Tur"oIntegrator script to force
seria! e#ecution of a designated set of Tur"oIntegrator processes. *ee J*eria!i=ing
Tur"oIntegrator processes using s'nchroni=edGI in the IBM Cognos TM1
TuroIntegrator Guide.
t1#fer Coand !ine uti!it' used to copress Cognos TM1 server data"ase fi!es and
ove fro one p!atfor to another p!atfor whi!e preserving i#ed case naes
for o"<ects on "oth Microsoft Windows and -NI5 p!atfors. *ee t1#fer.
O()C%test
The odbc_test too! is used to diagnose and test the Cognos TM1 O()C connection
on -NI5. *ee od"c%test too!.
(e"ugging too!s *ee (e"ugging Too!s for Windows for too!s designed specifica!!' for de"ugging
Cognos TM1 .
tm1+fer
The t1#fer uti!it' copresses and oves TM1 server o"<ects fro one p!atfor to another p!atfor
whi!e preserving i#ed case naes for o"<ects on "oth Microsoft Windows and -NI5 p!atfors.
odbc,test tool
The odbc_test too! is used to diagnose and test an I)M Cognos TM1 O()C connection on -NI5.
236 of 425 26-09-2014 11:18
A.1. tm1+fer
The t1#fer uti!it' copresses and oves TM1F server o"<ects fro one p!atfor to another p!atfor
whi!e preserving i#ed case naes for o"<ects on "oth Microsoft Windows and -NI5 p!atfors.
tm1+fer synta+
The t1#fer too! uses one paraeter.
Compressing directories it% tm1+fer
To copress the TM1 data"ase fi!es@ invo/e the t1#fer too! at the coand !ine fo!!owed "' the
path and nae of the director' that contains the TM1 data"ase fi!es. The t1#fer too! recogni=es that
it is a director' and copresses it.
.ecompressing directories it% tm1+fer
To decopress a =ipped fi!e containing TM1 data"ase fi!es@ invo/e the t1#fer too! at the coand
!ine fo!!owed "' the path and nae of the =ipped fi!e. The t1#fer too! recogni=es that it is a =ipped
fi!e and decopresses it.
'otes on tm1+fer
Ceep in ind the fo!!owing other considerations when using t1#fer.
1rror messages for tm1+fer
The fo!!owing ta"!e !ists the error essage 'ou a' encounter when using t1#fer.
tm1+fer usage notes
These notes a' "e he!pfu! when using t1#fer for the first tie.
)arent topic* Cognos TM1 Too!s and -ti!ities
237 of 425 26-09-2014 11:18
A.1.1. tm1+fer synta+
The t1#fer too! uses one paraeter.
tm1xfer <directory> | <file> | -v | -h | -?
On!' the first paraeter is processed. ,n' e#tra paraeters are ignored "' the app!ication. The eaning
of each paraeter is e#p!ained in the fo!!owing ta"!e. ,n' incorrect paraeter or inva!id fi!e nae and
path generates an appropriate error essage.
Ta"!e 1. t1#fer paraeters
Vdirector'L *pecifies the path and nae of the TM1F data"ase director' that contains the fi!es to
"e odified and copressed for transfer.
Vfi!eL *pecifies the path and nae of the copressed fi!e which contains a!! the data"ase
fi!es. This fi!e is decopressed into a new director' with the sae nae.
7v (isp!a's the version nu"er of the t1#fer too!.
7h (isp!a's coprehensive he!p docuentation for the app!ication.
7U (isp!a's a short he!p dia!og@ which inc!udes usage s'nta# and version nu"er.
no paraeters (isp!a's the short he!p dia!og Gsae as 7UI.
)arent topic* t1#fer
238 of 425 26-09-2014 11:18
A.1.#. Compressing directories it% tm1+fer
To copress the TM1F data"ase fi!es@ invo/e the t1#fer too! at the coand !ine fo!!owed "' the path
and nae of the director' that contains the TM1 data"ase fi!es. The t1#fer too! recogni=es that it is a
director' and copresses it.
, new fi!e is created with the e#tension J.=ipJ that contains a!! the copressed data"ase fi!es. The nae
of the new fi!e is the nae of the director' specified at the coand !ine.
The nae of the origina! director' is a!so stored inside the .=ip fi!e. If the .=ip fi!e a!read' e#ists@ the
t1#fer too! a!erts 'ou that a fi!e with the sae nae a!read' e#ists and propts 'ou to indicate
whether the new fi!e shou!d overwrite the o!der fi!e. If 'ou choose yes@ then the t1#fer too! proceeds to
copress the data"ase fi!es and overwrite the o!der .=ip fi!e. Otherwise@ the app!ication wi!! e#it without
changing an' fi!es.
The t1#fer too! perfors the fo!!owing actions>
t1#fer does the necessar' p!atfor specific hand!ing of fi!e naes and fi!e o"<ects to a/e sure that
ever' fi!e is converted to this forat during the copression process. ,!! su"directories in the ain
data"ase director' are recursive!' copressed.
t1#fer ignores raw store fi!es and the' are not inc!uded in the =ipped fi!e. If the raw store fi!es are
detected@ the t1#fer a!erts 'ou to process audit !og events anua!!' "efore igrating.
t1#fer ignores diension difference fi!es and the' are not inc!uded in the =ipped fi!e.
t1#fer stores the fi!es inside the =ipped fi!e different!' than a coon =ip app!ication. Therefore@
when decopressing TM1 fi!es that were previous!' copressed with the t1#fer too!@ using a
coon =ip app!ication such as WinTip@ the resu!ting decopressed fi!es resu!t in unusa"!e fi!es. This
is done to discourage the use of other =ip app!ications@ since the t1#fer too! does e#tra fi!e
processing that is not done "' other copression uti!ities.
Copression .#ap!e
The fo!!owing e#ap!e assues that there is a TM1 data"ase ca!!ed *a!es &!anning on a TM1 *erver on a
Microsoft Windows p!atfor@ and that the data"ase director' on disc is ca!!ed sa!es%p!anning.
C:\Users\obaluch\Documents\dbfile>dir
Volume in drive C has no label.
Volume Serial Number 4C9A-1CE1
Directory of C:\Users\obaluch\Documents\dbfile
05/11/2011 05:54 PM <DIR> .
05/11/2011 05:54 PM <DIR> ..
05/11/2011 06:11 PM <DIR> sales_planning
0 Files(s) 0 bytes(s)
3 Dir(s) 91,081,957,376 bytes free
To ove the data"ase fi!es to a ,I5F server@ invo/e the fo!!owing coand at the coand propt on
the Windows p!atfor>
C:\Users\obaluch>tm1_xfer sales_planning
This action resu!ts in the fo!!owing fi!es>
C:\Users\obaluch\Documents\dbfile>dir
Volume in drive C has no label.
239 of 425 26-09-2014 11:18
Volume Serial Number 4C9A-1CE1
Directory of C:\Users\obaluch\Documents\dbfile
05/11/2011 05:54 PM <DIR> .
05/11/2011 05:54 PM <DIR> ..
05/11/2011 06:11 PM <DIR> sales_planning
05/11/2011 06:24 PM 43,611,174 sales_planning.zip
1 Files(s) 43,611,174 bytes(s)
3 Dir(s) 91,038,346,202 bytes free
The t1#fer too! recogni=es that sa!es%p!anning is a director' with data"ase fi!es@ and copresses it into
a J.=ipJ fi!e. The resu!t is another fi!e ca!!ed sa!es%p!anning.=ip.
240 of 425 26-09-2014 11:18
A.1.-. .ecompressing directories it% tm1+fer
To decopress a =ipped fi!e containing TM1F data"ase fi!es@ invo/e the t1#fer too! at the coand !ine
fo!!owed "' the path and nae of the =ipped fi!e. The t1#fer too! recogni=es that it is a =ipped fi!e and
decopresses it.
, director' is created with the sae nae as the origina! director' which was copressed@ which is
usua!!' the sae as the .=ip fi!e@ "ut not a!wa's. This is true "ecause the nae of the origina! director' is
stored inside the .=ip fi!e@ and the output director' is naed using the stored nae. If the nae of the
=ip fi!enae is changed to soething different@ it sti!! uses the origina! nae.
If a director' with the sae nae a!read' e#ists@ the t1#fer too! issues a waring essage and propt
'ou to indicate if it shou!d "e overwritten. If 'ou se!ect yes@ the app!ication de!etes the current director'
and creates an ept' director' with the =ip fi!e nae. If 'ou se!ect no@ the app!ication e#its without
changing or decopressing an' fi!es.
Inside the ain data"ase director'@ the t1#fer too! reconstructs the origina! su"director' hierarch'.
The data"ase fi!es are decopressed inside the director' and processed to hand!e i#ed case o"<ect
naes and -nicode "ased on the p!atfor and !oca!e. On Windows p!atfors@ the fi!es are stored with
i#ed case fi!e naes encoded using -T+718. The fi!es do not reBuire e"edded o"<ect naes. *ince the
fi!es inside the .=ip fi!e are stored using i#ed case and using -T+718@ there is usua!!' no e#tra
conversion necessar'.
+i!e paths@ the }applications fi!e@ and the wor/"oo/s in the fo!der of the sae nae ust "e edited so
that an' references with paths containing JHJ ust "e converted to paths containing JPJ.
On -NI5 p!atfors@ the fi!es are stored using an :7"it encoding such as -T+7: or I*O7::3;71@ and a!!
!owercase. If -T+7: is used@ then -nicode characters are encoded using that s'ste. Otherwise@ -nicode
characters are converted to the for -Q5555@ where 5555 is the -T+718 code point for that character.
t1#fer on!' processes fi!es with version nu"er ;.1 or higher. .ar!ier fi!e versions are ignored. To
process ear!ier version fi!es@ first convert the to version ;.1 or !ater.
The t1#fer too! does not autoatica!!' odif' the tm1s.cfg fi!e. Aou ust anua!!' change an'
settings such as data"ase path. The t1#fer too! does not autoatica!!' odif' the server nae@ for
e#ap!e the server nae inside Microsoft .#ce! wor/"oo/ app!ications.
(ecopression .#ap!e
On an ,I5F s'ste@ the =ipped fi!e ca!!ed sa!es%p!anning.=ip is copied over to !ocation on the fi!es'ste
where the data"ase director' shou!d "e !ocated. To e#tract the data"ase fi!es@ run the fo!!owing coand
on ,I5>
Issue coand
bash-3.2$ ls
aix64 tests sales_planning.zip

bash-3.2$ tm1xfer sales_planning.zip
,fter>
bash-3.2$ ls
aix64 tests sales_planning sales_planning.zip
The t1#fer too! recogni=es that sa!es%p!anning.=ip is a =ipped fi!e@ and proceeds to un=ip the data"ase
fi!es and to odif' the fi!enaes and fi!es to hand!e i#ed case o"<ects and -nicode encoding. This is
done "ased on the current p!atfor and !oca!e.
241 of 425 26-09-2014 11:18
242 of 425 26-09-2014 11:18
A.1.4. 'otes on tm1+fer
Ceep in ind the fo!!owing other considerations when using t1#fer.
The t1#fer too! copresses and decopresses ost fi!es !ocated in the data"ase fo!der@ e#cept the
fo!!owing t'pes> raw stores and diension differences.
Important* If raw stores are present@ run the J&rocess ,udit 6og .ventsMJ coand for that TM1F
server.
Arc%i(es created using anot%er application t%an t%e tm1+fer tool
The t1#fer too! can "e used to pac/ and ove data"ase fi!es "etween two TM1 servers running on the
sae t'pe of p!atfor@ for e#ap!e fro Windows to Windows. In this case@ the fi!es are copressed in
the t1#fer forat@ and then decopressed for Windows and the current !oca!e. It is iportant to
ree"er that t1#fer fi!ters out a few fi!e t'pes. These inc!ude raw stores and diension differences@
so these wi!! "e !ost.
t1#fer archives fi!es in a forat different fro other copression uti!ities such as WinTip or Win0ar. +or
this reason@ archives created using t1#fer cannot "e decopressed using other copression uti!ities@
and vice versa.
If a cop!ete cop' of the data"ase fi!es has to "e oved "etween two s'stes on the sae p!atfor
t'pe and the sae !oca!e@ it a' "e a "etter idea to use a copression uti!it' that doesn't do an' fi!e
processing@ such a WinTip or tar. On the other hand@ the t1#fer too! shou!d "e used when oving
data"ase fi!es "etween s'stes running on the sae p!atfor "ut different !oca!es@ since it wi!! odif'
the fi!es "ased on !oca!esN for e#ap!e@ "etween two -NI5 s'stes@ where one is using en%-*.utf: !oca!e
and another en%-*.iso::3;1
)latforms it% older (ersion of TM1 ser(er
The t1#fer too! va!idates if the fi!e version is at !east version TM1 version ;.1 and a"ove. If it is a fi!e
version !ower than ;.1@ it ignores the fi!e.
3andling of pri(ate applications
,!though the content of private ,pp!ications is transferred@ and an' references to TM1 o"<ect fi!es within
the app!ication Gfor e#ap!e@ within a we"sheetI are odified to ensure the reference reains va!id on
-NI5@ the t1#fer too! does not retain the origina! naes of private app!ications that are igrated to
-NI5 fro Windows.
Ser(er name in tm1s.cfg
If the nae of the TM1 server is different after a data"ase is transferred to another host achine W and it
nora!!' is W the server nae ust "e anua!!' changed in the t1s.cfg fi!e. t1#fer does not a/e this
change autoatica!!'.
Ser(er names in $or"boo"s
Custo app!ications often contain an' wor/"oo/s that contain references to the TM1 server nae. This
nae ust change when a TM1 data"ase is transferred "etween heterogeneous p!atfors GWindows to
-NI5 or vice versaI and wi!! often change when oving "etween servers on the sae p!atfor. t1#fer
does not provide an' assistance in changing server naes within wor/"oo/s.
243 of 425 26-09-2014 11:18
A.1.6. 1rror messages for tm1+fer
The fo!!owing ta"!e !ists the error essage 'ou a' encounter when using t1#fer.
Ta"!e 1. .rror Messages for t1#fer
Message .escription 2emedy
This !oca!e is not supported "'
'our RavaX insta!!ation
The fi!es'ste encoding is not
supported "' this progra.
-pdate 'our Rava insta!!ation so it
supports the fi!es'ste encoding
AargB does not e#ist The fi!e or director' nae
provided in the coand !ine
arguent is a fi!e or director'
that does not e#ist.
.nsure that the fi!e or director'
nae on the coand !ine is
correct.
Cannot reso!ve AfileB,
A"essageB
There was a pro"!e reso!ving
the fu!! path to the fi!e.
-se the specific inforation in
the essage to deterine the
source of the pro"!e.
Cannot reso!ve Aase6dirB,
A"essageB
the fu!! path to the "ase
director'.
Cannot seria!i=e out !ist of fi!es>
A"essageB
There was an error writing this
Rava o"<ect to dis/.
Cannot open Afilena"eB for
reading> A"essageB
t1#fer does not have
perission to read this fi!e in the
data"ase director'.
Chec/ 'our fi!e s'ste
perissions. -se the specific
inforation in the essage to
deterine the source of the
pro"!e.
.rror writing to =ip fi!e>
A"essageB
There was a pro"!e writing to
the =ip fi!e.
Ma/e sure the dis/ is not fu!! and
that t1#fer has appropriate
write perissions. -se the
specific inforation in the
essage to deterine the source
of the pro"!e.
.rror c!osing =ip fi!e> A"essageB There was a pro"!e c!osing the
=ip fi!e. -sua!!' this pro"!e
reso!ves itse!f when t1#fer
e#its.
.rror opening =ip fi!e>
A"essageB
t1#fer chec/s for a issing fi!eN
however@ Rava reBuires a
+i!eNot+ound.#ception !og
essage.
Afilena"eB> Not a va!id archive The passed arguent e#ists "ut
it is not a va!id archive that was
created "' t1#fer
.nsure the fi!e nae on the
coand !ine is correct.
.rror reading =ip fi!e> A"essageB There was an error reading the
=ip fi!e. The fi!e a' have "een
corrupted or there a' "e a
perission pro"!e.
Ma/e sure the =ip fi!e transferred
correct!' and t1#fer has read
access to it. -se the specific
inforation in the essage to
deterine the source of the
244 of 425 26-09-2014 11:18
Message .escription 2emedy
pro"!e.
.rror reading Afilena"eB There was an unspecified error
whi!e reading the current fi!e
.rror interpreting path>
A"essageB
this path
+i!e read error> A"essageB There was a pro"!e reading this
fi!e.
.nsure that t1#fer has read
perission for the fi!e.
.rror reading ,pp!ication .ntries
diension
There was an error reading
}ApplicationEntries.dim in the
data"ase.
If 'ou cannot open
}ApplicationEntries.dim using
TM1F @ then the fi!e cou!d "e
corrupt. If the fi!e is not corrupt@
then ensure the fi!e's perissions
give t1#fer read access.
245 of 425 26-09-2014 11:18
A.1.>. tm1+fer usage notes
These notes a' "e he!pfu! when using t1#fer for the first tie.
On Microsoft Windows@ the coand is e#ecuted in CM(..5. Gor copati"!e coand processorI.
On -NI5@ use an' suita"!e she!! Gfor e#ap!e@ C7she!! or )ashI.
The standard I)MF CognosF TM1F insta!! does not add the Cognos TM1 server "in director' to the
users &,T1 varia"!e. *ince 'ou nora!!' wi!! run this too! in the director' containing the Cognos TM1
data fi!es Gwhich are not the "in director'I@ 'ou a' encounter the error J't1#fer' is not recogni=ed
as an interna! or e#terna! coand@ opera"!e progra or "atch fi!e.J
There are three wa's to hand!e this situation>
+u!!' Bua!if' the coand nae with the t1 server "in path naeN for e#ap!e> Jc:\Program
Files\IBM\cognos\tm1\bin\tm1xferJ
1.
Teporari!' add the t1 server path to the &,T1 varia"!e using the *.T coandN for e#ap!e
set PATH=%PATH%;c:\Program Files\IBM\cognos\tm1\bin\tm1xfer
2.
To peranent!' set the TM1 server path to the &,T1 varia"!e> right7c!ic/ My Computer@ L
)roperties@ Ad(anced ta"@ c!ic/ 1n(ironment 5ariables@ scro!! to find &,T1 in the *'ste
4aria"!es@ c!ic/ 1dit@ then append the Cognos TM1 server "in path to the e#isting path using a
seico!on de!iiterN for e#ap!e>. ;c:\Program Files\IBM\cognos\tm1\bin\tm1xfer.
$.
The steps a' "e s!ight!' different in 'our operating s'ste.
'ote* When specif'ing Windows path or fi!enae in CM(..5.@ the string a' have to "e enc!osed in
dou"!e Buotes if it contains an' spaces in the nae. +or e#ap!e@ to e#ecute t1#fer on a fo!der
ca!!ed (ata +i!es@ 'ou need to specif' t1#fer J(ata +i!esJ not t1#fer (ata +i!es.
t1#fer ta/es a fo!der nae as a starting point and pac/s ever'thing in that fo!der and "e!ow it.
T'pica!!'@ it wou!d "e used on the (ata director' on!'.co7resident with the (ata fo!der ight "e other
fi!es@ such as t1s.cfg and !og fi!es.Aou a' have put these in specia! fo!ders. If these fi!es need to
"e copied to the target p!atfor@ then a teporar' fo!der shou!d "e created soewhere that can "e
used to contain a cop' of the (ata fo!der and a!! the other fi!es to "e transferred. t1#fer can then "e
used to pac/ up that teporar' fo!der.
Two t'pica! use case scenarios are> GaI oving a Cognos TM1 data"ase Gand app!ication dataI to a
different server and G"I dep!o'ing a Cognos TM1 data"ase deve!oped on one p!atfor Gsuch as
WindowsI to different p!atfor Gsuch as 6inu# or ,I5I. In the case of GaI 'ou pro"a"!' want to ove
ever'thing .!og fi!es@ t1s.cfg etc. In the case of G"I@ 'ou pro"a"!' <ust want to cop' the data
fo!der.In the case of GaI 'ou ight need to a/e changes to t1s.cfg Gfor e#ap!e@ if drive !etters or
paths are different on the target achine. In the case of G"I@ change t1s.cfg "ecause the path
conventions are different G"ac/s!ash versus s!ash etc.I
t1#fer generates essages. These can "e directed to a fi!e "' using the CM(..5. or -NI5 *he!!
redirection optionN for e#ap!e@ t1#fer data L t1#fer.!og
The Cognos TM1 server shou!d "e shut down "efore running t1#fer to pac/ up the fi!es. t1#fer
soeties detects that the Cognos TM1 *server was not proper!' shut down@ and wi!! propt the
user to deterine whether the' shou!d continue or not.
246 of 425 26-09-2014 11:18
A.#. odbc,test tool
The odbc_test too! is used to diagnose and test an I)MF CognosF TM1F O()C connection on -NI5.
-se odbc_test to test an O()C access code in e#act!' the sae wa' that the TM1 server uses this code.
One of the process switches is the path to the TM1 server configuration fi!e director'@ sii!ar to the TM1
server's -z switch so that e#act!' the sae O()C !i"rar' can "e !oaded on -NI5 using odbc_test..
Synta+
odbc_test -z <path to config directory>
[-dbname <db name> -user <username> -passwd <passwd> -query <select query> -n #-of-rows-
to-retrieve]
[-n nu"er!or!recordsY
[-t ;do ti"ing<Y
[-r nu"er!repetitionsY
[-h] prints the he!p fi!e.
-se -u to a/e the under!'ing *?6 ca!!s use the wide -nicode f!avor of the O()C interface.
*pecif' a -t switch to tie the ca!!s running this with <ust the path to the configuration director' to <ust
!oad the !i"rar' and !ist the avai!a"!e data sources.
This progra wi!! run the specified Buer'@ and !ists the first 10 records. The fi!e odbc_test.ini wi!! "e
read "efore the coand !ine switches are processed. The fie!ds in this fi!e are>
config_dir:
path-to-config-directory>
dataset_name>
user_name>
user_passwd>
sql_query>
The sql_query> !ine and a!! su"seBuent !ines are concatenated to a/e the *?6 Buer'.
)arent topic* Cognos TM1 Too!s and -ti!ities
247 of 425 26-09-2014 11:18
10. 0sing t%e Cognos TM1 Operations Console
,fter insta!!ation and configuration@ run the I)MF CognosF TM1F Operations Conso!e fro a we"
"rowser.
The first tie 'ou use it 'ou need to set up soe organi=ation structures to identif' the servers "eing
onitored.
.isplay user names
The MaskUserNameInServerTools paraeter deterines if user naes are disp!a'ed or as/ed out
in the I)M Cognos TM1 Operations Conso!e disp!a's.
Create an Operation Group for monitoring
)efore 'ou can onitor a I)M Cognos TM1 server using the Cognos TM1 Operations Conso!e@ define a
!ogica! grouping for the servers "eing onitored.
Add an Admin3ost and Cognos TM1 ser(er name to t%e Cognos TM1 Operations Console
To identif' the I)M Cognos TM1 server to the Cognos TM1 Operations Conso!e@ add it to the data"ase
instance.
Set t%e log file and ser(er numeric parameters
-se the Configure option to set the nueric paraeters that define how the !og fi!e nuerics and
other server paraeters are gathered.
.onload or upload t%e configuration file
To a/e changes to the t1operationsconso!e.#! fi!e@ 'ou can use the -p!oad and (own!oad
options.
.ynamic reporting using t%e Monitor option
The Monitor option on the I)M Cognos TM1 Operations Conso!e opens a d'naica!!'7refreshed disp!a'
of the server activit' that can "e further focused using the +i!ter settings.
3ealt% c%ec" indicator
The 1ea!th chec/ indicator provides a!ost instant feed"ac/ on the status of the server.
3ealt% status tab
The I)M Cognos TM1 Operations Conso!e disp!a's the 1ea!th Chec/ status of u!tip!e servers.
Monitor ser(er memory and performance data
The I)M Cognos TM1 Operations Conso!e can onitor Cognos TM1 *erver eor' and perforance
data.
Set a filter
The +i!ters dia!og "o# !ets 'ou focus the t'pe of activit' shown in the *tatus disp!a'.
Sc%edule t%e log file
Aou can define the schedu!e for how often the !og fi!e runs.
.onload t%e log file
The (own!oad option generates a te#t version of the !og fi!e@ sii!ar to the TM1Top output.
5ie t%e log file
The 4iew 6og option provides a copact@ static snapshot of the !og.
248 of 425 26-09-2014 11:18
10.1. .isplay user names
The MaskUserNameInServerTools paraeter deterines if user naes are disp!a'ed or as/ed out in
the I)MF CognosF TM1F Operations Conso!e disp!a's.
When MaskUserNameInServerTools=TRUE is set in the Tm1s.cfg@ user naes are as/ed in theCognos
TM1 Operations Conso!e for securit' purposes. To unas/ the naes@ the adinistrator can right7c!ic/
the server in the Cognos TM1 Operations Conso!e and then c!ic/ Aut%enticate to verif' the adinistrator
status.
This paraeter is set to +,6*. "' defau!t. If 'ou do not e#p!icit!' set this paraeter to T0-.@ the Cognos
TM1 Operations Conso!e disp!a's user naes even when adinistrator access has not "een verified.
)arent topic* -sing the Cognos TM1 Operations Conso!e
249 of 425 26-09-2014 11:18
10.#. Create an Operation Group for monitoring
)efore 'ou can onitor a I)MF CognosF TM1F server using the Cognos TM1 Operations Conso!e@ define
a !ogica! grouping for the servers "eing onitored.
+or e#ap!e@ 'ou ight have a group of servers designated as J(eve!opent@J J&roduction@J or JTest.J
To add a new Operation Group>
C!ic/ the operation group icon fro the too!"ar or use the ,ction enu to se!ect Add Operation
Group.
1.
.nter a nae for the group. 2.
C!ic/ Create. $.
,fter the group is created@ use the right7c!ic/ or ,ction "utton option to add the ,din1ost and Cognos
TM1 server nae.
,fter the group is defined@ use the !og fi!e options to design the wa' 'ou want to onitor the servers.
250 of 425 26-09-2014 11:18
10.-. Add an Admin3ost and Cognos TM1 ser(er name to t%e Cognos
TM1 Operations Console
To identif' the I)MF CognosF TM1F server to the Cognos TM1 Operations Conso!e@ add it to the
data"ase instance.
About t%is tas"
,fter 'ou have added a (ata"ase Instance@ 'ou can identif' the ,din1ost.
)rocedure
0ight7c!ic/ the data"ase instance and se!ect Add Admin%ost 1.
.nter the fu!!'7Bua!ified nae of the ,din1ost. 2.
C!ic/ O; $.
2esults
The ,dinhost is identified. Once the ,din1ost is in the tree@ 'ou can se!ect it and right7c!ic/ to add the
nae of the Cognos TM1 server running on that host that 'ou want to onitor.
251 of 425 26-09-2014 11:18
10.4. Set t%e log file and ser(er numeric parameters
-se the Configure option to set the nueric paraeters that define how the !og fi!e nuerics and other
server paraeters are gathered.
Cop!ete the fo!!owing paraeters for each !og fi!e.
:og period
*pecifies the tie interva! "etween updates "eing written to the !og fi!e.
+or e#ap!e@ if the screen 0efresh is set to 2 seconds@ 6og&eriod cou!d "e set to 10 seconds so that
ever' fifth screen disp!a' wi!! "e output to decrease the aount of data written to the fi!e.
(efau!t is 2 seconds.
:og Append
)' defau!t a new !og fi!e is not appended@ it overwrites the e#isting !og. *e!ect True to append new
!ogfi!es to the e#isting !og.
2efres% period
)' defau!t@ the !og waits 2 seconds "efore refreshing the data. Aou can enter a !onger or shorter
tie for the refresh here in seconds.
Tolerance factor
)' defau!t@ the data is new G0I. To perit data in the !og to "e o!der@ enter a nu"er here in
seconds for how o!d the data can "e "efore reBuiring a new po!!ing.
Time Out
)' defau!t@ attepts to connect to the server end after 2 seconds. Aou can change this nu"er to
shorten or !engthen the tie the !og wi!! /eep tr'ing "efore giving up.
If the I)MF CognosF TM1F Operations Conso!e server does not get the updated status in the
seconds specified here@ then the o!d data Gif it e#istsI is sent with an indication that a tieout has
occurred.
Memory Stats refres% period
)' defau!t@ the !og waits 2 inutes "efore refreshing the data. Aou can enter a !onger or shorter
tie for the refresh here in inutes.
Memory Stats tolerance factor
)' defau!t@ the data is new G0I. To perit data in the eor' statistics to "e o!der@ enter a nu"er
here in seconds for how o!d the data can "e "efore reBuiring a new po!!ing.
Memory Stats timeout
)' defau!t@ attepts to connect to the server end after 2 inutes. Aou can change this nu"er to
shorten or !engthen the tie the !og wi!! /eep tr'ing "efore giving up.
If the I)M Cognos TM1 Operations Conso!e server does not get the updated status in the inutes
specified here@ then the o!d data Gif it e#istsI is sent with an indication that a tieout has occurred.
252 of 425 26-09-2014 11:18
10.6. .onload or upload t%e configuration file
To a/e changes to the t1operationsconso!e.#! fi!e@ 'ou can use the -p!oad and (own!oad options.
Once 'ou have popu!ated the I)MF CognosF TM1F .nvironent pane with the configuration fi!e@ 'ou
can use the -p!oad and (own!oad options to a/e changes to the configuration. Aou can a!so inc!ude
sap!e data for a configuration fi!e using these coands.
When 'ou choose 0pload @ 'ou can "rowse to the !ocation of the configuration fi!e and c!ic/ O;.
Choose .onload to see the configuration fi!e as an #! fi!e that 'ou can save on 'our !oca! achine.
253 of 425 26-09-2014 11:18
10.>. .ynamic reporting using t%e Monitor option
The Monitor option on the I)MF CognosF TM1F Operations Conso!e opens a d'naica!!'7refreshed
disp!a' of the server activit' that can "e further focused using the +i!ter settings.
The Monitor option disp!a's genera! status@ sand"o#es@ or sand"o# Bueue inforation d'naica!!' "ased
on the !og fi!e paraeters 'ou have chosen. Aou can a!so co"ine these windows to onitor different
/inds of activit' at the sae tie. -se the +i!ter dia!og "o# to focus the disp!a's to specific /inds of
activit'@ for e#ap!e@ to on!' processes in a run state.
When there are processes disp!a'ed@ 'ou can right7c!ic/ a process to se!ect ;ill process to terinate the
process.
To sort the disp!a' "' a particu!ar co!un@ c!ic/ the co!un heading so that an arrow disp!a's. -p arrow
sorts on that co!un headingN down arrow is the defau!t sort.
The 1ea!th chec/ gives an instant indication of the server's status.
Status
)' defau!t the *tatus choice shows a!! states and !ists the I(@ -ser@ *tate@ +unction@ O"<ect 6oc/
*tatus@ -ser 6oc/ *tatus@ and Tie.
+or Threads@ 'ou can onitor the Threads in -se@ ?ueue (epth@ ,verage ?ueue Tie@ (eBueue
(e!ta@ ?ueue Tie (e!ta@ and ,&I Ca!!s (e!ta.
Sandbo+
)' defau!t the *and"o# !ists the I(@ -ser@ ,ctive *and"o#@ Tota! *and"o# Meor' and the Nu"er
of *and"o#es.
Sandbo+ Cueue
)' defau!t the *and"o# ?ueue !ists the I(@ Nae@ -ser@ Node Nae@ *tatus@ and Tie in ?ueue.
)erformance Statistics
,n ,din user can a!so access the &erforance *tatistics avai!a"!e for this server. *ee Monitor
server eor' and perforance data for ore inforation.
254 of 425 26-09-2014 11:18
10.?. 3ealt% c%ec" indicator
The 1ea!th chec/ indicator provides a!ost instant feed"ac/ on the status of the server.
The fo!!owing !ist shows the indicators avai!a"!e>
Online
*erver is on!ine. This server is running.
Starting
The server is starting.
/ul":oad Mode
*erver is in )u!/6oadMode.
/usy
*erver is "us'. *erver a' "e starting@ stopping@ "e in )u!/ 6oad Mode@ or no response was
received fro the server.
Offline
*erver is off!ineHnot a"!e to contact. This server is not running or has "een una"!e to connect to the
CognosF TM1F Operations Conso!e.
Stopping
*erver is in the process of stopping.
0nsupported
*erver is unsupported. The hea!th chec/ is not avai!a"!e for servers running a Cognos TM1 version
prior to the 10.1.0 re!ease.
The 1ea!th Chec/ a!so disp!a's the nu"er of threads in the server and the nu"er of threads waiting for
a !oc/ to "e granted.
*ince the hea!th status is updated ever' 10 seconds@ the inforation is current to within 10 seconds or
!ess depending on when the server status changed since the !ast refresh
If the report contains a refresh rate@ the data is updated at the refresh rate specified for that report.
255 of 425 26-09-2014 11:18
10.@. 3ealt% status tab
The I)MF CognosF TM1F Operations Conso!e disp!a's the 1ea!th Chec/ status of u!tip!e servers.
The 1ea!th status ta" shows the current state of a!! the TM1 servers in the current session. This is the
defau!t disp!a' for the TM1 Operations Conso!e.
256 of 425 26-09-2014 11:18
10.A. Monitor ser(er memory and performance data
The I)MF CognosF TM1F Operations Conso!e can onitor Cognos TM1 *erver eor' and
perforance data.
In order to use the &erforance Monitoring features avai!a"!e in the Cognos TM1 Operations Conso!e@ 'ou
ust first>
In Cognos TM1 ,rchitect@ right7c!ic/ the server fro the *erver .#p!orer and se!ect Ser(erD Start
)erformance Monitor.
On!' ,din users can run the s'ste perforance onitoring reports of the Cognos TM1 Operations
Conso!e. )efore accessing the &erforance *tatistics option@ se!ect the 5erify Admin Access option
fro the Cognos TM1 Operations Conso!e Monitor enu and enter a va!id ,dinistrator usernae
and password.
The fo!!owing statistics are avai!a"!e on the &erforance *tatistics report>
Meor' -sed for 4iews
Meor' -sed for Ca!cu!ations
Meor' -sed for +eeders
Meor' -sed for Input (ata
Tota! Meor' -sed
In addition@ the *tatus options for each server "eing onitor disp!a's the fo!!owing statistics>
Meor' -sed
Gar"age Meor'
257 of 425 26-09-2014 11:18
10.10. Set a filter
The +i!ters dia!og "o# !ets 'ou focus the t'pe of activit' shown in the *tatus disp!a'.
Aou can fi!ter disp!a's "' specific threads or "' their specific states to Buic/!' identif' activit'.
)' defau!t a!! states are shown in the status disp!a'. Chec/ one or an' of these choices to focus on the
state shown> Id!e@ 0un@ Coit@ 0o!!"ac/@ Wait@ 6ogin@ +inish.
Aou can a!so focus the Thread inforation "' *'ste@ Chores@ and -ser Threads.
0eport co!uns can "e sorted to a!!ow faster identification of "us' servers.
Aou can a!so fi!ter the !og entries. *ee *chedu!e the !og fi!e.
258 of 425 26-09-2014 11:18
10.11. Sc%edule t%e log file
Aou can define the schedu!e for how often the !og fi!e runs.
To schedu!e a new !og fi!e event@ right7c!ic/ the server in the I)MF CognosF TM1F .nvironent pane
and se!ect :ogging Sc%eduler.
)' defau!t the !ogging is set to .isable :ogging. Automated :ogging generates a !og fi!e for whatever
activit' is ta/ing p!ace at that tie for the aount of tie that the onitor window is open.
To e#aine or create a custoi=ed !ogging schedu!e@ c!ic/ Sc%eduled :ogging and cop!ete the dia!og
"o# with the detai!s for the start and stop ties of 'our !ogging schedu!e.
:og type
Choose *tatus@ *and"o#@ or *and"o# ?ueue
:og Separately
)' defau!t each !og for status@ sand"o#@ and sand"o# status is aintained separate!'. Choose +a!se
to co"ine a!! these !ogs into a coon fi!e.
2emember* When 6og *eparate!' is True@ the down!oaded !og option provides that t'pe of !og fi!e.
When 6og *eparate!' is +a!se@ the coon !og fi!e is down!oaded.
:og .uration
C!ic/ the *tart (ate@ *tart Tie@ *top (ate@ and *top Tie to open a ca!endar to he!p set these
paraeters for when the !og is run.
Once 'ou have a !og event schedu!ed@ 'ou can use this dia!og "o# to edit or de!ete it.
,dinistrators can a!so fi!ter the !og fi!es to e!iinate dup!icate entries and to reduce the !og fi!e si=e. The
!og fi!e enus offer states to use when fi!tering !ogging essages.
259 of 425 26-09-2014 11:18
10.1#. .onload t%e log file
The (own!oad option generates a te#t version of the !og fi!e@ sii!ar to the TM1Top output.
Choose which t'pe of !og to down!oad> *tatus@ *and"o#@ or *and"o# ?ueue.
260 of 425 26-09-2014 11:18
10.1-. 5ie t%e log file
The 4iew 6og option provides a copact@ static snapshot of the !og.
Choose which t'pe of !og to view> *tatus@ *and"o#@ or *and"o# ?ueue.
261 of 425 26-09-2014 11:18
11. Administering I/M Cognos TM1 $eb
Aou can configure I)MF CognosF TM1F to wor/ over the We".
I/M Cognos TM1 $eb O(er(ie
I)M Cognos TM1 We" e#tends the ana!'tica! power of TM1 "' a!!owing 'ou to cop!ete the fo!!owing
tas/s in a We" "rowser>
Administering t%e TM1 Ser(er from I/M Cognos TM1 $eb
The options avai!a"!e in the ,dinistration node in the Navigation pane of I)M Cognos TM1 We" var'
according to the TM1 group to which 'ou "e!ong.
C%anging Bour )assord
-sers can change their own I)M Cognos TM1 We" passwords.
Configuring a Custom 3omepage for I/M Cognos TM1 $eb
Aou can configure a custo hoepage for I)M Cognos TM1 We" to disp!a' a We"sheet@ cu"e view@ or
a -06 after users have successfu!!' !ogged into I)M Cognos TM1 We". This hoepage can provide
users with a starting point for accessing and wor/ing with TM1 data.
Modifying I/M Cognos TM1 $eb Configuration )arameters
The We".config adinistration fi!e is an 5M6 fi!e that resides in the I)M Cognos TM1 We" virtua!
director'.
)erforming $eb Folder Maintenance
I)M Cognos TM1 We" uses two we" fo!ders for teporar' fi!es. Aou shou!d periodica!!' onitor these
fo!ders and c!ean the out during s'ste downtie.
0sing I/M Cognos TM1 $eb :ogging
I)M Cognos TM1 We" adinistrators can use the fo!!owing two !og fi!es for status and trou"!eshooting
of I)M Cognos TM1 We". The severit' !eve!s in the !og fi!es he!p organi=e essages.
262 of 425 26-09-2014 11:18
11.1. I/M Cognos TM1 $eb O(er(ie
I)MF CognosF TM1F We" e#tends the ana!'tica! power of TM1 "' a!!owing 'ou to cop!ete the
fo!!owing tas/s in a We" "rowser>
,na!'=e cu"e data
Manipu!ate foratted .#ce! reports
(ri!!@ pivot@ se!ect@ and fi!ter data
)ui!d charts
&erfor soe server adinistration tas/s
)arent topic* ,dinistering I)M Cognos TM1 We"
263 of 425 26-09-2014 11:18
11.#. Administering t%e TM1 Ser(er from I/M Cognos TM1 $eb
The options avai!a"!e in the ,dinistration node in the Navigation pane of I)MF CognosF TM1F We"
var' according to the TM1 group to which 'ou "e!ong.
If 'ou are a e"er of the ,(MIN group on a TM1 server@ the ,dinistration node disp!a's the fo!!owing
options.
icon Option
,dinistration
&rocesses
0eview and e#ecute processes on the TM1 server.
Chores
0eview and e#ecute chores on the TM1 server.
C!ient &roperties
0eview and set properties for the c!ient achines.
Cu"e &roperties
0eview and set properties of cu"es.
(iension &roperties
0eview and set properties for diensions.
Change &assword
Change 'our TM1 adin password.
If 'ou are a e"er of an' other user group@ the ,dinistration node disp!a's the Change &assword
option. The &rocesses and Chores options ight "e avai!a"!e as we!!@ depending on 'our securit'
privi!eges for processes and chores on the server. If 'ou have 0ead privi!ege to an' processes on the
server@ the &rocesses option is avai!a"!e. *ii!ar!'@ if 'ou have 0ead privi!ege to an' chores on the server@
the Chores option is avai!a"!e.
)rocedure
6og in to I)M Cognos TM1 We" as a TM1 adinistrator. 1.
C!ic/ Administration in the !eft Navigation pane. 2.
C!ic/ the option re!evant to the adinistrative tas/ 'ou want to perfor.
.ach adinistrative tas/ is descri"ed "e!ow.
$.
Administering )rocesses
264 of 425 26-09-2014 11:18
Aou can adinister processes on the TM1 server.
Administering C%ores
Aou can adinister chores on the TM1 server.
Setting Client )roperties
Aou can review and set c!ient GuserI properties.
Setting Cube )roperties
Aou can review and set cu"e properties.
Setting .imension )roperties
Aou can review and set diension properties.
265 of 425 26-09-2014 11:18
11.#.1. Administering )rocesses
Aou can adinister processes on the TM1F server.
)rocedure
In the ,dinistration pane@ c!ic/ )rocesses.
I)MF CognosF TM1 We" disp!a's a !ist of processes 'ou esta"!ished on 'our TM1 server.
1.
To disp!a' the contro! processes@ se!ect the .isplay Control )rocesses chec/ "o#. To hide the
contro! processes@ c!ear the .isplay Control )rocesses chec/ "o#.
2.
C!ic/ a process to se!ect it.
I)M Cognos TM1 We" disp!a's two "o#es ne#t to the process !ist. ,!! va!ues in these "o#es are
read7on!'N the' a!!ow 'ou to review 'our process "ut not to change attri"utes or paraeters.
)rocess Attributes 7 ,t the top right of the &rocesses page@ TM1 disp!a's the process attri"utes
for the se!ected process.
*ap!e &rocess ,ttri"utes>
)lan,load,budget,odbc
(atasource T'pe O()C
*ecurit' Owner
*ecurit' *tatus ,4,I6,)6.
0eada"!e True
Writea"!e +a!se
.ncr'pted +a!se
)rocess )arameters 7 ,t the "otto right of the &rocesses page@ TM1 disp!a's the defau!t
process paraeters 'ou esta"!ished on the &araeters ta" of the Tur"oIntegrator process.
*ap!e &rocess ,ttri"utes>
)rocess )arameters Type
&4ersion +A 200$ )udget *tring
&*tart(ate Ran7200$ *tring
&.nd(ate (ec7200$ *tring
'ote* If 'our process does not use paraeters@ the &rocess &araeters "o# does not appear.
$.
To change the process attri"utes@ use the TM1 *erver .#p!orer. +or detai!s@ see the I)M Cognos TM1
User Guide.
2.
To run a process@ c!ic/ a process in the !ist and c!ic/ 1+ecute )rocess . 3.
)arent topic* ,dinistering the TM1 *erver fro I)M Cognos TM1 We"
266 of 425 26-09-2014 11:18
11.#.#. Administering C%ores
Aou can adinister chores on the TM1F server.
)rocedure
In the ,dinistration pane@ c!ic/ C%ores.
I)MF CognosF TM1 We" disp!a's a !ist of chores 'ou esta"!ished on 'our TM1 server.
1.
To disp!a' the contro! chores@ se!ect the .isplay Control C%ores chec/ "o#. To hide the contro!
chores@ c!ear the .isplay Control C%ores chec/ "o#.
2.
C!ic/ a chore to se!ect it.
I)M Cognos TM1 We" disp!a's the fo!!owing inforation a"out the chore>
)rocess list 7 6ists TM1 processes that run when 'ou e#ecute the chore. The processes run in
the order the' appear in the !ist.
/asic C%ore )arameters 7 Indicates whether the schedu!e of the chore is active@ the nu"er of
processes in the chore@ the !ast start tie@ and how often the chore runs.
C%ore sc%edule 7 *hows the da's on which the chore is schedu!ed to run@ and how often the
chore runs.
:ast e+ecution time 7 *hows the !ast tie the chore was run.
TM1 a!so disp!a's the Chore ,dinistration too!"ar at the top of the page.
The Chore ,dinistration too!"ar contains the fo!!owing "uttons.
/utton /utton 'ame .escription
*ave Chore *aves the changes 'ou a/e to the chore.
$.
267 of 425 26-09-2014 11:18
To activate a chore to run on the set schedu!e@ se!ect a chore@ and c!ic/ Acti(ate. 2.
To deactivate a chore so that it no !onger runs on schedu!e@ se!ect the chore@ and c!ic/ .eacti(ate. 3.
To edit a chore@ se!ect a chore@ and c!ic/ 1dit C%ore .
I)M Cognos TM1 We" disp!a's the C%ore )rocess :ist 1ditor dia!og "o#.
-se the arrows to "ui!d and arrange a !ist of processes that run when 'ou e#ecute the chore.
C!ic/ Apply to save 'our process !ist.
C!ic/ Sa(e to save 'our changes.
8.
To run a chore@ se!ect a chore@ and c!ic/ 1+ecute C%ore . 9.
268 of 425 26-09-2014 11:18
11.#.-. Setting Client )roperties
Aou can review and set c!ient GuserI properties.
)rocedure
In the ,dinistration pane@ c!ic/ Client )roperties.
I)MF CognosF TM1F We" disp!a's a !ist of c!ients 'ou esta"!ished on 'our TM1 server.
1.
To disp!a' the properties for a c!ient@ c!ic/ a c!ient in the !ist.
I)M Cognos TM1 We" disp!a's the propert' va!ues for that c!ient.
,!! "ut the Ma+imum G of Connections and )assord 1+piration properties are read7on!'.
2.
To set the a#iu nu"er of connections that can "e esta"!ished on the TM1 server "' the
se!ected c!ient@ high!ight the Ma+imum G of Connections va!ue and enter a new nu"er.
$.
To set the nu"er of da's that the c!ients password reains va!id@ high!ight the )assord
1+piration va!ue and enter a new nu"er.
, )assord 1+piration va!ue of 0 eans that the password does not e#pire.
2.
C!ic/ Sa(e to save the c!ient propert' changes. 3.
269 of 425 26-09-2014 11:18
11.#.4. Setting Cube )roperties
Aou can review and set cu"e properties.
)rocedure
In the ,dinistration pane@ c!ic/ Cube )roperties.
I)MF CognosF TM1F We" disp!a's a !ist of cu"es avai!a"!e on 'our TM1 server.
1.
To inc!ude contro! cu"es in the !ist@ se!ect the .isplay Control Cubes chec/ "o#. To e#c!ude contro!
cu"es fro the !ist@ c!ear the .isplay Control Cubes chec/ "o#.
2.
To view the properties for a cu"e@ c!ic/ a cu"e in the !ist.
I)M Cognos TM1 We" disp!a's a "o# containing properties and corresponding va!ues for the se!ected
cu"e. Aou can change the :oad on .emand and :ogging properties.
$.
To change the va!ue of a cu"e propert'@ c!ic/ the down arrow ne#t to a propert' and se!ect a va!ue. 2.
C!ic/ Sa(e to save 'our changes. 3.
270 of 425 26-09-2014 11:18
11.#.6. Setting .imension )roperties
Aou can review and set diension properties.
)rocedure
In the ,dinistration pane@ c!ic/ .imension )roperties.
I)MF CognosF TM1F We" disp!a's a !ist of diensions on 'our TM1 server.
1.
To disp!a' the contro! diensions@ se!ect the .isplay Control .imensions chec/ "o#. To hide the
contro! diensions@ c!ear the .isplay Control .imensions chec/ "o#.
2.
To view properties for a diension@ c!ic/ a diension in the !ist.
I)M Cognos TM1 We" disp!a's the properties and associated va!ues for the diension. Aou can
change severa! diension propert' va!ues.
$.
To change a propert' va!ue for a diension@ c!ic/ the down arrow ne#t to a propert' and se!ect a new
va!ue.
2.
C!ic/ Sa(e to save 'our changes. 3.
271 of 425 26-09-2014 11:18
11.-. C%anging Bour )assord
-sers can change their own I)MF CognosF TM1F We" passwords.
)rocedure
C!ic/ the Administration node in the !eft Navigation pane. 1.
C!ic/ C%ange )assord.
The Change -ser &assword page opens.
2.
.nter 'our current password in the 1nter Current )assord "o#. $.
.nter 'our new password in the 1nter 'e )assord "o#. 2.
.nter 'our new password a second tie in the 5erify 'e )assord "o#. 3.
C!ic/ Sa(e C%anges to save 'our new password. 8.
272 of 425 26-09-2014 11:18
11.4. Configuring a Custom 3omepage for I/M Cognos TM1 $eb
Aou can configure a custo hoepage for I)MF CognosF TM1F We" to disp!a' a We"sheet@ cu"e view@
or a -06 after users have successfu!!' !ogged into I)M Cognos TM1 We". This hoepage can provide
users with a starting point for accessing and wor/ing with TM1 data.
, hoepage can "e configured g!o"a!!' for a!! I)M Cognos TM1 We" users or assigned individua!!' for
different users or sets of users. +or e#ap!e@ if 'ou configure the hoepage option to disp!a' an 1TM6
fi!e or other t'pe of we" page@ then 'ou can provide users with instructions@ tas/s@ !in/s@ or an' other
content that can "e disp!a'ed in a we" page.
If a hoepage is configured@ it disp!a's on the first ta" in I)M Cognos TM1 We" and cannot "e c!osed "'
users. When configured@ a 1oe !in/ is disp!a'ed in the header area of I)M Cognos TM1 We" that a!!ows
users to easi!' return to the hoepage.
,n I)M Cognos TM1 We" hoepage can "e configured in one of the fo!!owing two wa's>
.ifferent %omepage for different I/M Cognos TM1 $eb users 7 -se the C!ient *ettings dia!og
in TM1 ,rchitect and *erver .#p!orer to configure a startup hoepage for different c!ients GusersI of
I)M Cognos TM1 We".
Global %omepage for all I/M Cognos TM1 $eb users 7 -se the 1oe&ageO"<ect paraeter in
the we".config fi!e to configure a hoepage that app!ies g!o"a!!' to a!! I)M Cognos TM1 We" users.
'ote* ,n' hoepage assignent 'ou a/e with the C!ient *ettings dia!og can over7ride the g!o"a!
setting in the we".config if 'ou set ,!!owOverwriteKtrue in the 1oe&ageO"<ect paraeter of the
we".config fi!e.
Configuring .ifferent 3omepages for Indi(idual 0sers
The C!ient *ettings dia!og@ in ,rchitect and *erver .#p!orer@ configures a startup hoepage for
different I)M Cognos TM1 We" c!ients GusersI.
Configuring a Global 3omepage for All 0sers
The 1oe&ageO"<ect paraeter@ in the we".config fi!e@ ena"!es a g!o"a! hoepage that disp!a's for
a!! I)M Cognos TM1 We" users.
273 of 425 26-09-2014 11:18
11.4.1. Configuring .ifferent 3omepages for Indi(idual 0sers
The C!ient *ettings dia!og@ in ,rchitect and *erver .#p!orer@ configures a startup hoepage for different
I)MF CognosF TM1F We" c!ients GusersI.
+or e#ap!e@ 'ou can assign one hoepage for I)M Cognos TM1 We" users in the *a!es departent and
another hoepage for users in the +inance departent.
'ote* Aou can use the Client Settings dia!og to assign hoepages for specific users@ over7riding the
g!o"a! hoepage setting for the 3ome)ageOb8ect paraeter in the we".config fi!e.
)rocedure
In ,rchitect or *erver .#p!orer@ right c!ic/ on the server and se!ect Security@ Clients=Groups.
The C!ientsHGroups dia!og opens.
1.
C!ic/ Settings.
The C!ient *ettings dia!og opens.
2.
*e!ect the c!ient fro the Current Client !ist for which the hoepage setting wi!! app!'. $.
.nter a We"sheet@ cu"e view@ or -06 for the hoepage as fo!!ows>
To disp!a' a -06@ t'pe the -06 address@ inc!uding the http>HH protoco!@ into the 1oepage "o#.
Aou can enter a -06 for either a we"site or an individua! fi!e.
To se!ect a We"sheet or cu"e view as the hoepage@ c!ic/ /rose. The *e!ect an I)M Cognos
TM1 We" 1oepage dia!og opens where 'ou can se!ect a reference to a We"sheet or cu"e view
fro the ,pp!ication tree.
,fter se!ecting a We"sheet or cu"e view reference@ c!ic/ O; to return to the C!ient *ettings dia!og.
2.
*e!ect the settings that contro! the appearance of the Navigation pane.
'ote* The Navigation pane settings 'ou set here wi!! on!' app!' if the corresponding paraeter in the
we".config fi!e is set to ,!!owOverwriteKtrue. +or detai!s@ see Configuring I)M Cognos TM1 We"
*tartup and ,ppearance *ettings.
The avai!a"!e settings for contro!!ing the appearance of the Navigation pane inc!ude>
Include t%e 'a(igation )ane 7 (eterines if the Navigation pane is disp!a'ed or not disp!a'ed
when the se!ected c!ient !ogs in to I)M Cognos TM1 We".
Open pane on :ogin 7 *ets the Navigation pane to disp!a' in the e#panded ode when the
se!ected c!ient !ogs in to I)M Cognos TM1 We".
Close pane on :ogin 7 *ets the Navigation pane to disp!a' in its inii=ed ode when the
se!ected c!ient !ogs in to I)M Cognos TM1 We".
Sa(e Client&s 'a(igation )ane Settings 7 (eterines if the persona! settings for the
Navigation pane are saved when the c!ient !ogs out of I)M Cognos TM1 We".
3.
*e!ect one of the options fro the Apply To !ist to configure which c!ient or c!ients wi!! "e a"!e to
view the hoepage.
Current Client 7 ,pp!ies the hoepage setting for on!' the c!ient se!ected in the current C!ient
!ist.
Selected Clients 7 .na"!es the *e!ect "utton so 'ou can open the *u"set .ditor to se!ect a
co!!ection of c!ients that wi!! use the sae hoepage setting.
All Clients 7 ,pp!ies the sae hoepage setting to a!! TM1 c!ients.
8.
274 of 425 26-09-2014 11:18
If 'ou choose Selected Clients@ and then c!ic/ Select@ the *u"set .ditor opens so 'ou can se!ect a
su"set of TM1 c!ients that can use the hoepage.
-se the *u"set .ditor to se!ect a su"set of c!ients and then c!ic/ O; to return to the C!ient *ettings
dia!og. The nu"er of c!ients se!ected in the *u"set .ditor is suari=ed in the C!ient *ettings
dia!og.
C!ic/ Apply Settings to configure the hoepage for the c!ient or c!ients that 'ou se!ected in the
,pp!' To !ist.
9.
0epeat steps 2@ 3@ 8@ and 9 to configure a hoepage for a different set of TM1 c!ients. :.
C!ic/ O; to c!ose the C!ient *ettings dia!og.
Aou have now configured a hoepage for I)M Cognos TM1 We". The se!ected I)M Cognos TM1 We"
c!ients wi!! see the assigned hoepage the ne#t tie the' successfu!!' !og in to I)M Cognos TM1
We".
;.
)arent topic* Configuring a Custo 1oepage for I)M Cognos TM1 We"
275 of 425 26-09-2014 11:18
11.4.#. Configuring a Global 3omepage for All 0sers
The 1oe&ageO"<ect paraeter@ in the we".config fi!e@ ena"!es a g!o"a! hoepage that disp!a's for a!!
I)MF CognosF TM1F We" users.
'ote* Aou can override the g!o"a! 1oe&ageO"<ect paraeter "' using the C!ient *ettings dia!og to
assign different hoepage's for individua! TM1 c!ients. +or detai!s@ see Configuring (ifferent 1oepages
for Individua! -sers
The 1oe&ageO"<ect paraeter wor/s for three t'pes of o"<ects>
Cu"eviewer
We"sheet
-06
The hoepage o"<ect disp!a's after the user successfu!!' !ogs in to I)M Cognos TM1 We".
0sing t%e 3ome)ageOb8ect )arameter
1ow to use the 1oe&ageO"<ect paraeter.
Setting a Global I/M Cognos TM1 $eb 3omepage to a Cube 5ie
-se the fo!!owing forat to set a cu"e view as the hoepage for I)M Cognos TM1 We".
Setting a Global I/M Cognos TM1 $eb 3omepage to a $ebs%eet
Aou can assign a We"sheet as the I)M Cognos TM1 We" hoepage@ depending on how the .#ce! fi!e
was added to TM1 .
Setting a Global I/M Cognos TM1 $eb 3omepage to a 02:
Aou can set the 1oe&ageO"<ect paraeter to a -06.
)arent topic* Configuring a Custo 1oepage for I)M Cognos TM1 We"
276 of 425 26-09-2014 11:18
11.4.#.1. 0sing t%e 3ome)ageOb8ect )arameter
1ow to use the 1oe&ageO"<ect paraeter.
The 3ome)ageOb8ect paraeter uses the fo!!owing forat>
Vadd /e'KJ1oe&ageO"<ectJ va!ueKJO?ectPat2 ;Type= O?ectT7pe ;Description= O?ectTitle ;
0llo1Over1rite =true" />
where>
O?ectPat2 is the path to the We"sheet@ cu"e view@ or -06 o"<ect that 'ou want to open. The e#act
forat of the path depends on the t'pe of o"<ect.
O?ectT7pe is the /e'word for the o"<ect 'ou want to openN we"sheet@ cu"eviewer@ or -06.
O?ectTitle is a "rief tit!e 'ou assign to the o"<ect that disp!a's in the tit!e "ar of the we" "rowser and
on the hoepage ta" in I)MF CognosF TM1F We".
0llo1Over1rite can "e set to a va!ue of true or fa!se as fo!!ows>
If 'ou set ,!!owOverwriteKtrue then the 1oe&ageO"<ect paraeter can "e overridden "' setting a
different hoepage for individua! c!ients using the C!ient *ettings dia!og in ,rchitect and *erver .#p!orer.
If 'ou set ,!!owOverwriteKfa!se then the 1oe&ageO"<ect paraeter app!ies g!o"a!!' to a!! TM1 users
and can not "e individua!!' configured with the C!ient *ettings dia!og in ,rchitect and *erver .#p!orer.
The fo!!owing sections descri"e using the 1oe&ageO"<ect paraeter for We"sheets@ cu"e views@ and
-06s.
)arent topic* Configuring a G!o"a! 1oepage for ,!! -sers
277 of 425 26-09-2014 11:18
11.4.#.#. Setting a Global I/M Cognos TM1 $eb 3omepage to a Cube
5ie
-se the fo!!owing forat to set a cu"e view as the hoepage for I)MF CognosF TM1F We".
value=CubeName$$ViewName$$Status
where the fo!!owing arguents are separated "' ZZ characters>
Cue9a"e is the nae of cu"e to which the view "e!ongs.
Cie19a"e is the nae of the cu"e view to disp!a'.
*tatus is the pu"!ic or private status of the cu"e view.
'ote* Aou ust inc!ude a va!ue of either &-)6IC or &0I4,T. to correct!' identif' the specific cu"e view
that 'ou want to open.
+or e#ap!e@ to open a pu"!ic view naed &rice fro the *a!esCu"e>
&ltadd key="HomePageObject" value="SalesCube$$Price$$Public;Type=cubeviewer;
Description=MyStartCube;AllowOverwrite=true"
/>
278 of 425 26-09-2014 11:18
11.4.#.-. Setting a Global I/M Cognos TM1 $eb 3omepage to a
$ebs%eet
Aou can assign a We"sheet as the I)MF CognosF TM1F We" hoepage@ depending on how the .#ce!
fi!e was added to TM1 .
Opening a $ebs%eet t%at references an 1+cel file outside of TM1
Aou can open a We"sheet that references an .#ce! fi!e.
Opening a $ebs%eet ob8ect t%at as uploaded to t%e TM1 ser(er
Aou can open a We"sheet o"<ect that was up!oaded.
279 of 425 26-09-2014 11:18
11.4.#.-.1. Opening a $ebs%eet t%at references an 1+cel file outside
of TM1
Aou can open a We"sheet that references an .#ce! fi!e.
)rocedure
-se the forat>
value="WebsheetPath
where We"sheet&ath is the !ocation and nae of the .#ce! fi!e. This can "e either a path for a !oca! fi!e@ or
a -NC path for a fi!e !ocated on a networ/.
+or e#ap!e@ to set a -NC networ/ path for We"sheet>
value=//MySystem/Samples/classic_slice.xls
2esults
The cop!ete 1oe&ageO"<ect paraeter !oo/s !i/e this>
<add key="HomePageObject" value="//MySystem/Samples/classic_slice.xls;Type=websheet;
Description=MyWebsheet;AllowOverwrite=true"/>
)arent topic* *etting a G!o"a! I)M Cognos TM1 We" 1oepage to a We"sheet
280 of 425 26-09-2014 11:18
11.4.#.-.#. Opening a $ebs%eet ob8ect t%at as uploaded to t%e TM1
ser(er
Aou can open a We"sheet o"<ect that was up!oaded.
)rocedure
In *erver .#p!orer@ use the &roperties pane to find the TM1F assigned nae for the up!oaded .#ce!
fi!e.
1.
*et the va!ue paraeter using the fo!!owing forat>
value="TM1://ServerName/blob/PUBLIC/.\}Externals\
TM1 _Filename
where>
/erver9a"e is the nae of the TM1 sever where the .#ce! fi!e is !ocated.
TM1 6location is the nae that TM1 assigned to the up!oaded .#ce! fi!e.
+or e#ap!e>
value="TM1://sdata/blob/PUBLIC/.\}Externals\Report_2006.xls_20070123212746.xls
The cop!ete 1oe&ageO"<ect paraeter !ine !oo/s !i/e this>
<add key="HomePageObject" value="TM1://sdata/blob/PUBLIC/.\}Externals\
Report_2006.xls_20070123212746.xls;Type=websheet;Description=My
Uploaded Websheet;AllowOverwrite=true" />
2.
)arent topic* *etting a G!o"a! I)M Cognos TM1 We" 1oepage to a We"sheet
281 of 425 26-09-2014 11:18
11.4.#.4. Setting a Global I/M Cognos TM1 $eb 3omepage to a 02:
Aou can set the 1oe&ageO"<ect paraeter to a -06.
-se this forat>
value="URL_Path
Where U(:6Pat2 can point to a we" site or an individua! we" page fi!e.
+or e#ap!e>
To set the hoepage to a -06 that points to a fi!e>
<addkey="HomePageObject" value="homepage.html;Type=URL;
Description=MyStart Page;AllowOverwrite=true"
/>
To set the hoepage to a -06 that points to a we" site>
<addkey="HomePageObject" value="http://www.yahoo.com;Type=URL;
Description=Yahoo;AllowOverwrite=true"/>
282 of 425 26-09-2014 11:18
11.6. Modifying I/M Cognos TM1 $eb Configuration )arameters
The We".config adinistration fi!e is an 5M6 fi!e that resides in the I)MF CognosF TM1F We" virtua!
director'.
The paraeters in this fi!e contro! the fo!!owing I)M Cognos TM1 We" features.
4iew node
,dinistration node
We" session tieout
Cu"e 4iewer page si=e
Nu"er of sheets to e#port fro a Cu"e 4iewer
I)M Cognos TM1 We" startup and appearance settings
1ere are the ost coon I)M Cognos TM1 We" paraeters in the We".config fi!e that 'ou can change.
MainTitle3eig%t 7 *ets the height of the ain tit!e "ar.
.isplayCustomToolbar 7 *et to A or N to disp!a' or hide the TM1 Wor/f!ow too!"ar.
CustomToolbar02: 7 .sta"!ishes a target asp# fi!e in the I)M Cognos TM1 We" virtua! director'.
The asp# fi!e defines a custo too!"ar. +or e#ap!e@ the fi!e TM1We"&!anManToo!"ar.asp# defines the
TM1 Wor/f!ow too!"ar.
'ote* In I)M Cognos TM1 We" ;.#@ TM1We"&!anManToo!"ar.asp# is the on!' custo too!"ar TM1
supports.
CustomToolbar3eig%t 7 *ets the height of the TM1 Wor/f!ow too!"ar.
'a(Tree.isplaySer(er5ie 7 1ides or disp!a's the Ser(er 5ie node in the Navigation tree.
'a(Tree.isplayAdministration 7 1ides or disp!a's the ,dinistration node in the Navigation tree.
SmartA+is1nabled 7 *et to true "' defau!t. This paraeter@ set to fa!se@ disa"!es our newer
sarta#is autoatic sca!e Gand interva!I ca!cu!ator@ and reverts "ac/ to the !egac' ode.
1diting t%e $eb.Config File
Aou can edit the We".config fi!e.
Configuring TM1 $or"flo )arameters
Aou can odif' the appearance of the TM1 Wor/f!ow too!"ar in I)M Cognos TM1 We".
.isplaying t%e Custom Toolbar
Aou can disp!a' or hide a custo too!"ar in I)M Cognos TM1 We" "' odif'ing the paraeter
(isp!a'CustoToo!"ar in We".config.
.isplaying t%e Content of t%e Custom Toolbar
If 'ou set the We".config paraeter (isp!a'CustoToo!"ar to A@ I)M Cognos TM1 We" e#ecutes the
code in the odu!e indicated "' the paraeter CustoToo!"ar-06.
C%anging t%e 3eig%t of t%e Custom Toolbar
Aou can change the height of a custo too!"ar.
.isplaying or 3iding t%e 5ies 'ode in t%e 'a(igation )ane
Aou can disp!a' or hide the 4iews node in the Navigation pane.
.isplaying or 3iding Administration options in t%e 'a(igation )ane
Aou can configure TM1 We" to disp!a' either a!! or soe of the options under the ,dinistration node
in the Navigation pane.
283 of 425 26-09-2014 11:18
C%anging t%e I/M Cognos TM1 $eb Session Timeout
Aou can change the defau!t session id!e tieout.
C%anging t%e Cube 5ieer )age Si7e
Aou can change the nu"er of rows and co!uns disp!a'ed in the Cu"e 4iewer of TM1 the I)M
Cognos TM1 .
Setting t%e Ma+imum 'umber of S%eets to 1+port from a Cube 5ieer
)' defau!t@ the a#iu nu"er of sheets 'ou can e#port fro a Cu"e 4iewer to a printer is 100.
Aou can configure I)M Cognos TM1 We" to e#port ore sheets.
Ad8usting t%e 3ttp2untime 1+ecutionTimeout )arameter
Aou can ad<ust the I)M Cognos TM1 We" http0untiee#ecutionTieout paraeter under certain
conditions.
Setting t%e TM11+celSer(ice)ort'umber )arameter
Aou can edit the TM1.#ce!*ervice&ortNu"er paraeter that specifies the port nu"er at which the
TM1 .#ce! *ervice is !istening.
Configuring t%e Cognos TM1 $eb :ogin )age using Admin3ost'ame and TM1Ser(er'ame
parameters
The AdminHostName and TM1ServerName paraeters contro! whether or not the I)M Cognos TM1 We"
!ogin page propts the user to enter va!ues for the TM1 ,din 1ost and TM1 server.
Configuring I/M Cognos TM1 $eb Startup and Appearance Settings
Aou can contro! the appearance of the Navigation pane@ ta" "ar@ and We"sheet and Cu"eviewer
too!"ars when users !og in to I)M Cognos TM1 We".
0sing t%e Custom:in" )arameter to Open Ot%er 02:s and $eb )ages
The Custo6in/ paraeter disp!a's a !in/ in the I)M Cognos TM1 We" too!"ar that can open a -06
address or we" page.
Configuring t%e I/M Cognos TM1 $eb 5irtual Cac%e .irectory
I)M Cognos TM1 We" reBuires a virtua! director'@ outside of the I)M Cognos TM1 We" app!ication
director'@ as a !ocation for teporar' fi!es.
Controlling C%art Scaling and Increments it% t%e SmartA+is1nabled )arameter
The *art,#is.na"!ed paraeter contro!s the autoatic sca!e and increent settings of the 5 and
A7a#is in I)M Cognos TM1 We" charts.
1nabling t%e $ebs%eet )aging Toolbar
The We"sheet paging feature inc!udes a too!"ar in I)M Cognos TM1 We" that provides easier
navigation in We"sheets that contain a !arge nu"er of rows.
0sing t%e TM1 $eb )age2esetMode parameter
The I)M Cognos TM1 We" &age0esetMode paraeter a!!ows 'ou to contro! soe of the "ehavior of
page orientation in We"sheets when 'ou perfor certain actions such as reca!cu!ating@ re"ui!ding@ or
changing a tit!e diension e!eent for an ,ctive +or in a We"sheet.
Alloing pasting in (alidated cells
Aou cannot paste on a ce!! when Microsoft .#ce! va!idation is set in the we". &aste.nforceent
overrides this restriction and a!!ows 'ou to perfor a paste into a ce!! with va!idation@ however@ using
this paraeter ignores an' va!idation set on the ce!!.
$rapping string (alues in cube (ies
-se Cu"eviewer*tringWrap to set the paraeters used when viewing string e!eent ce!!s in a We"
Cu"e 4iew.
284 of 425 26-09-2014 11:18
11.6.1. 1diting t%e $eb.Config File
Aou can edit the We".config fi!e.
The we".cofig fi!e is an #! fi!e and shou!d "e opened on!' with an 5M67t'pe editor. Opening it using a
regu!ar te#t editor such as Microsoft Wordpad can resu!t in incorrect characters "eing added that a'
corrupt the fi!e.
)rocedure
6og out of I)MF CognosF TM1F We". 1.
Open the Windows Contro! &ane!. 2.
C!ic/ Administrati(e ToolsD Internet Information Ser(ices.
The Internet Inforation *ervices window opens.
$.
In the !eft Navigation pane@ e#pand 'our !oca! coputer fo!ders. 6ocate and se!ect the I)M Cognos
TM1 We" virtua! director'.
2.
6ocate the We".config fi!e in the Content pane@ right7c!ic/ the fi!e@ and c!ic/ Open.
'ote* The we".cofig fi!e is an #! fi!e and shou!d "e opened on!' with an 5M67t'pe editor. Opening it
using a regu!ar te#t editor such as Microsoft Word &ad can resu!t in incorrect characters "eing added
that a' corrupt the fi!e.
3.
.dit the paraeters and save 'our changes.
'ote* If We".config is set to read7on!' on 'our hard dis/@ I)M Cognos TM1 We" propts 'ou to
overwrite the fi!e. C!ic/ Bes to confir overwriting the fi!e.
8.
6ogin to I)M Cognos TM1 We" to see the resu!t of 'our edits. 9.
)arent topic* Modif'ing I)M Cognos TM1 We" Configuration &araeters
285 of 425 26-09-2014 11:18
11.6.#. Configuring TM1 $or"flo )arameters
Aou can odif' the appearance of the TM1F Wor/f!ow too!"ar in I)MF CognosF TM1 We".
-se the fo!!owing paraeters in We".config.
)arameter .efault Setting=
.escription
(isp!a'CustoToo!"ar N
(isp!a's or hides the TM1 Wor/f!ow too!"ar. The defau!t is N. *et
this va!ue to A to disp!a' the TM1 Wor/f!ow too!"ar.
CustoToo!"ar-r! TM1We"&!anManToo!"ar.asp#
Nae of the custo too!"ar e#ecuta"!e. The on!' supported
too!"ar is the defau!t va!ue shown here.
CustoToo!"ar1eight 2:
1eight in pi#e!s@ of the TM1 Wor/f!ow too!"ar.
&M%Too!"arCaption TM1 Wor/f!ow
*tring caption on the TM1 Wor/f!ow too!"ar.
&M%Too!"arCaptionWidth 120
Width of the string caption on the TM1 Wor/f!ow too!"ar caption.
&M%4ersionCaption &rocess
Caption for the &rocess !ist in TM1 Wor/f!ow.
&M%4ersionCaptionWidth 90
Width of the Caption for the 4ersion !ist in the TM1 Wor/f!ow
too!"ar.
&M%4ersion6istWidth 130
Width of the 4ersion !ist in TM1 Wor/f!ow.
&M%Tas/Caption Tas/
Caption for the Tas/ !ist in the TM1 Wor/f!ow too!"ar.
286 of 425 26-09-2014 11:18
.escription
&M%Tas/CaptionWidth 30
Width of the Tas" list caption in the TM1 Wor/f!ow too!"ar.
&M%Tas/6istWidth 200
Width of the Tas" list in the TM1 Wor/f!ow too!"ar.
&M%,ctionCaption ,ction
Caption for the Action !ist.
&M%,ctionCaptionWidth 33
Width of the Action !ist caption.
&M%,ction6istWidth 120
Width of the Action !ist.
&M%,!!Tas/sCaption The defau!t is an ept' string.
Caption for the All Tas"s !ist.
&M%,!!Tas/sCaptionWidth $0
Width of the All Tas"s !ist caption.
&M%*tatusCaption The defau!t is an ept' string.
Caption for the 5ersion Status "utton.
&M%*tatusCaptionWidth $0
Width of the 5ersion status "utton caption.
&M%Custoi=eCaption The defau!t is an ept' string.
Caption for the Customi7e "utton.
&M%Custoi=eCaptionWidth $0
Width for the Customi7e "utton caption.
287 of 425 26-09-2014 11:18
.escription
&M%6oadCaption The defau!t is an ept' string.
Caption for the :oad "utton.
&M%6oadCaptionWidth $0
Width of the :oad "utton caption.
288 of 425 26-09-2014 11:18
11.6.-. .isplaying t%e Custom Toolbar
Aou can disp!a' or hide a custo too!"ar in I)MF CognosF TM1F We" "' odif'ing the paraeter
(isp!a'CustoToo!"ar in We".config.
'ote* In TM1 ;.#@ TM1We"&!anManToo!"ar.asp# is the on!' custo too!"ar supported.
)rocedure
.dit the We".config fi!e in the I)M Cognos TM1 We" virtua! director'. 1.
6ocate the (isp!a'CustoToo!"ar paraeter@ which contains a va!ue of N. The defau!t va!ue of N hides
the custo too!"ar@ as shown "e!ow>

<add key="DisplayCustomToolbar" value='N' />
2.
To disp!a' the custo too!"ar@ change the (isp!a'CustoToo!"ar va!ue to A. )e sure to use uppercase. $.
*ave the We".config fi!e. 2.
C!ic/ the 2efres% "utton in 'our "rowser.
The custo too!"ar disp!a's in the "anner at the top of the I)M Cognos TM1 We" page.
3.
289 of 425 26-09-2014 11:18
11.6.4. .isplaying t%e Content of t%e Custom Toolbar
If 'ou set the We".config paraeter (isp!a'CustoToo!"ar to A@ I)MF CognosF TM1F We" e#ecutes the
code in the odu!e indicated "' the paraeter CustoToo!"ar-06.
'ote* The on!' supported setting for the CustoToo!"ar-06 paraeter is TM1We"&!anManToo!"ar.asp#.
(o not change this setting.

<add key="CustomToolbarUrl" value="TM1WebPlanManToolbar.aspx"
/>
290 of 425 26-09-2014 11:18
11.6.6. C%anging t%e 3eig%t of t%e Custom Toolbar
Aou can change the height of a custo too!"ar.
)rocedure
.dit We".config in the I)MF CognosF TM1F We" virtua! director'. 1.
6ocate the CustoToo!"ar1eight paraeter@ which contro!s the disp!a' of the *erver 4iew node. Note
the va!ue of 2: Gin pi#e!sI.

<add key="CustomToolbarHeight value="28" />
2.
Change the nu"er of pi#e!s to change the height of the custo too!"ar. $.
*ave the We".config fi!e. 2.
291 of 425 26-09-2014 11:18
11.6.>. .isplaying or 3iding t%e 5ies 'ode in t%e 'a(igation )ane
Aou can disp!a' or hide the 4iews node in the Navigation pane.
)rocedure
.dit We".config in the I)MF CognosF TM1F We" virtua! director'. 1.
6ocate the NavTree(isp!a'*erver4iew@ which contro!s the disp!a' of the Ser(er 5ie node. The
defau!t va!ue@ A@ disp!a's the 5ies node in the Navigation pane.

<add key="NavTreeDisplayServerView" value="Y" />
2.
To hide the 4iews node@ change the NavTree(isp!a'*erver4iew va!ue to N. $.
*ave We".config. 2.
6og in to I)M Cognos TM1 We".
Now the Navigation pane disp!a's without the 4iew node.
3.
292 of 425 26-09-2014 11:18
11.6.?. .isplaying or 3iding Administration options in t%e 'a(igation
)ane
Aou can configure TM1F We" to disp!a' either a!! or soe of the options under the ,dinistration node in
the Navigation pane.
About t%is tas"
The NavTreeDisplayAdministration paraeter contro!s the disp!a' of the ,dinistration node. The
defau!t va!ue of this paraeter is A@ which disp!a's a!! the adinistration options under the ,dinistration
node in the Navigation pane. If 'ou disa"!e this feature@ the options for )rocesses@ Client )roperties@
Cube )roperties@ and .imension )roperties are hidden@ "ut the C%ange )assord option is sti!!
disp!a'ed.
)rocedure
.dit Web.config in the I)MF CognosF TM1 We" virtua! director'. 1.
6ocate the NavTreeDisplayAdministration paraeter.

<add key="NavTreeDisplayAdministration" value="Y"/>
2.
To hide a!! the adinistration options e#cept for the C%ange )assord option@ change the
NavTreeDisplayAdministration va!ue to N.
<add key="NavTreeDisplayAdministration" value="N"/>
$.
*ave Web.config. 2.
6og in to Cognos TM1 We".
The Navigation tree now disp!a's the ,dinistration node with on!' the C%ange )assord option.
3.
293 of 425 26-09-2014 11:18
11.6.@. C%anging t%e I/M Cognos TM1 $eb Session Timeout
Aou can change the defau!t session id!e tieout.
)' defau!t@ I)MF CognosF TM1F We" app!ies a 207inute session id!e tieout. If 'ou !og in to I)M
Cognos TM1 We"@ and I)M Cognos TM1 We" reains id!e for 20 inutes@ 'ou are autoatica!!' !ogged
out.
)rocedure
.dit Web.config. 1.
6ocate the fo!!owing code>

<sessionState
mode="InProc"
stateConnectionString="tcpip=127.0.0.1:42424"
sqlConnectionString="data source=127.0.0.1;Trusted_Connection=yes"
cookieless="false"
timeout="20"
/>
2.
Change the tieout va!ue Gin inutesI. $.
*ave Web.config. 2.
6og in to I)M Cognos TM1 We". 3.
0ne+pected timeouts
-ne#pected tieouts a' occur when the (efau!t &araeter is changed or when the precedence of
settings resu!ts in une#pected "ehavior.
Ad8usting t%e timeout parameter
Aou can use these techniBues to ad<ust the tieout paraeter in TM1 @ Microsoft II*@ and TM1 We".
C%anging t%e .efault Setting in Microsoft IIS 5ersion > ebser(er of Microsoft $indos
Ser(er #00-
Aou can use these techniBues to ad<ust the tieout paraeter in TM1 @ Microsoft II*@ and TM1 We".
294 of 425 26-09-2014 11:18
11.6.@.1. 0ne+pected timeouts
-ne#pected tieouts a' occur when the (efau!t &araeter is changed or when the precedence of
settings resu!ts in une#pected "ehavior.
The defau!t tieout paraeter in we".config and Microsoft II* wor/er process is set at We" *ession
TieoutK20 in@ Id!eConnectionTieOut*econdsK120 sec@ and Id!eTieoutK20 in.
Tieouts can "e configured at three different !eve!s>
TM1F We" tieout settings> we".config@ TM1 we" app
TM1 server tieout settings> t1s.cfg
Microsoft II* settings for tieout of wor/er processes> II* w$wp.e#e Q (efau!t,pp&oo! Q achine.cfg
The setting in the t1s.cfg fi!e app!ies at the server !eve!@ whi!e the we".config app!ies to accessing the
virtua! director' for TM1 We".
The Id!eConnectionTieOut*econds wi!! disconnect a user's TM1 session@ whi!e the tieout paraeter in
the we".config on!' app!ies to a user's connection to the TM1 We" we"site.
The setting in the we".config fi!e ta/es precedence over id!e tieout in II* and achine.config. When
tieout is issing in we".config then the setting fro achine.config ta/es precedence.
+or "est resu!ts@ do not change the defau!t settings. To prevent a TM1 We" session fro tiing out@ if 'ou
do change the defau!t setting@ ta/e into account 'our "usiness reBuireents and the precedence of
tieout settings.
To diagnose a tieout pro"!e@ "e sure a setting has "een ade in the t1s.cfg. No tieout setting
eans 'ou never tie out.
Id!eConnectionTieOut *econds specifies a tieout !iit for id!e c!ient connections in seconds. +or
e#ap!e@ if 'ou inc!ude the !ine Id!eConnectionTieOut*econdsK;00 in t1s.cfg@ the server disconnects
id!e c!ient connections after ;00 seconds.
)arent topic* Changing the I)M Cognos TM1 We" *ession Tieout
295 of 425 26-09-2014 11:18
11.6.@.#. Ad8usting t%e timeout parameter
Aou can use these techniBues to ad<ust the tieout paraeter in TM1F @ Microsoft II*@ and TM1 We".
)rocedure
Increase tieout Id!eConnectionTieOut*econds Gt1s.cfgI fro ;00 sec to 9200 sec GK 120 inI. 1.
Increase tieout of II* wor/er process fro sec GK20 inI to 9200 sec GK 120 inI cscript
O*'ste(riveOPInetpu"P,din*criptsPadsuti!.v"s set W$*4CH,pp&oo!sH,pp!ication&oo!Nae n
2.
Increase tieout (efau!t,pp&oo! fro defau!t 20 in to 120 in. $.
Increase tieout TM1 We" *ession Gwe".configI fro defau!t 20 in to 120 in. 2.
http0untie e#ecutionTieoutKJ9200J Gwe".configI 3.
0estart II* after changing tieout settings. 8.
296 of 425 26-09-2014 11:18
11.6.@.-. C%anging t%e .efault Setting in Microsoft IIS 5ersion >
ebser(er of Microsoft $indos Ser(er #00-
Aou can use these techniBues to ad<ust the tieout paraeter in TM1F @ Microsoft II*@ and TM1 We".
)rocedure
Increase tieout Id!eConnectionTieOut*econds Gt1s.cfgI fro ;00 sec to 9200 sec GK 120 inI. 1.
0ight7c!ic/ and se!ect &roperties@ ta" &erforance@ We" Garden>Ma#iu nu"er of wor/er
processes
2.
297 of 425 26-09-2014 11:18
11.6.A. C%anging t%e Cube 5ieer )age Si7e
Aou can change the nu"er of rows and co!uns disp!a'ed in the Cu"e 4iewer of TM1F the I)MF
CognosF TM1 .
)' defau!t@ We" Cu"e 4iewer disp!a's pages of TM1 data with 20 co!uns and 100 rows@ and inc!udes the
diensions !ist in the row count.
)rocedure
.dit We".config. 1.
CubeViewerRowPageSize
CubeViewerColumnPageSize
2.
Change the va!ue for the row andHor co!un page si=e. $.
*ave We".config. 2.
6og in to I)M Cognos TM1 We".
+or e#ap!e@ if 'ou set the row page si=e to 10@ the Cu"e 4iewer disp!a's nine rows of data@ p!us the
row of diensions.
3.
298 of 425 26-09-2014 11:18
11.6.10. Setting t%e Ma+imum 'umber of S%eets to 1+port from a
Cube 5ieer
)' defau!t@ the a#iu nu"er of sheets 'ou can e#port fro a Cu"e 4iewer to a printer is 100. Aou
can configure I)MF CognosF TM1F We" to e#port ore sheets.
)rocedure
.dit We".config. 1.
MaximumSheetsForExport
2.
Change the va!ue for the a#iu nu"er of sheets to e#port. $.
*ave We".config. 2.
299 of 425 26-09-2014 11:18
11.6.11. Ad8usting t%e 3ttp2untime 1+ecutionTimeout )arameter
Aou can ad<ust the I)MF CognosF TM1F We" http0untiee#ecutionTieout paraeter under certain
conditions.
If I)M Cognos TM1 We" disp!a's the fo!!owing error essage when opening a !arge or cop!e# We"sheet@
'ou can ad<ust the I)M Cognos TM1 We" http0untiee#ecutionTieout paraeter.
Server Error in '/ TM1 ' Application. Request timed
out.
The e#ecutionTieout paraeter specifies the a#iu nu"er of seconds that a reBuest@ such as
opening a We"sheet@ is a!!owed to e#ecute "efore "eing autoatica!!' shut down "' Microsoft Internet
Inforation *ervices GII*I.
)rocedure
.dit We".config. 1.
6ocate the s7ste"-1e section. 2.
,dd or edit the http0untie e#ecutionTieout paraeter as fo!!ows>
&lthttpRuntime executionTimeout="value"
/>
where the forat of value can "e either seconds or 11>MM>**.
If a va!ue is not specified in We".config@ then the va!ue in the Microsoft .N.T +raewor/ configuration
fi!e@ Machine.config@ is used. If no va!ue is specified in either fi!e@ then the defau!t va!ue for this
paraeter is ;0.
$.
*ave We".config. 2.
300 of 425 26-09-2014 11:18
11.6.1#. Setting t%e TM11+celSer(ice)ort'umber )arameter
Aou can edit the TM1.#ce!*ervice&ortNu"er paraeter that specifies the port nu"er at which the
TM1F .#ce! *ervice is !istening.
The TM1 .#ce! *ervice is an app!ication that runs in the "ac/ground to hand!e I)MF CognosF TM1 We"
reBuests for converting .#ce! fi!es into 5M6 forat.
Aou can edit the TM1.#ce!*ervice&ortNu"er paraeter in the We".config fi!e using the fo!!owing forat>
<add key="TM1ExcelServicePortNumber" value="PortNumber"
/>
where Port9u"er ust "e set to a va!id port nu"er@ as shown in the fo!!owing e#ap!e>
<add key="TM1ExcelServicePortNumber" value="4785"
/>
301 of 425 26-09-2014 11:18
11.6.1-. Configuring t%e Cognos TM1 $eb :ogin )age using
Admin3ost'ame and TM1Ser(er'ame parameters
The AdminHostName and TM1ServerName paraeters contro! whether or not the I)MF CognosF TM1F
We" !ogin page propts the user to enter va!ues for the TM1 ,din 1ost and TM1 server.
If 'ou set a va!ue for either of these paraeters in the Web.config fi!e@ then the !ogin process uses the
specified va!ue and does not propt the user for this inforation.
Admin3ost'ame )arameter
This paraeter specifies the nae of the ,din 1ost on which a TM1 ,din *erver is running. .dit the
AdminHostName paraeter in the Web.config fi!e using the fo!!owing forat>
<add key="AdminHostName" value="HostName"/>
where HostName can "e one of the fo!!owing va!ues>
If HostName is "!an/ Gdefau!t va!ueI@ then the !ogin page disp!a's the ,din 1ost propt.
If HostName is set to the nae of a va!id TM1 ,din 1ost@ then I)M Cognos TM1 We" uses that
,din 1ost for the !ogin process and does not propt the user.
TM1Ser(er'ame )arameter
This paraeter sets the nae of the TM1 server. .dit the TM1ServerName paraeter in the Web.config
fi!e using the fo!!owing forat>
<add key="TM1ServerName" value="ServerName"/>
where ServerName can "e one of the fo!!owing va!ues>
If ServerName is "!an/ Gdefau!t va!ueI@ then the TM1 server propt is disp!a'ed on the I)M Cognos
TM1 We" !ogin page@ as shown "e!ow.
If ServerName is set to a va!id TM1 server nae@ then the !ogin page does not disp!a' a propt for
either the ,din 1ost or the TM1 server.
If the AdminSvrSSLCertID paraeter is incorrect!' configured@ the server nae pu!!7down disp!a's as
ept' and an error is !ogged in the TM1Web.config fi!e. *ee J0unning TM1 in *ecure Mode using
**6J in the I)M Cognos TM1 Operation Guide for ore inforation.
,fter the user enters a va!id -ser Nae and &assword@ I)M Cognos TM1 We" wi!! !ogin to the TM1 server
specified "' the TM1ServerName paraeter in the Web.config fi!e.
+or e#ap!e@ the TM1ServerName paraeter cou!d "e set to p!anning sap!e@ as shown in the fo!!owing
code.
<add key="TM1ServerName" value="planning sample" />
302 of 425 26-09-2014 11:18
11.6.14. Configuring I/M Cognos TM1 $eb Startup and Appearance
Settings
Aou can contro! the appearance of the Navigation pane@ ta" "ar@ and We"sheet and Cu"eviewer too!"ars
when users !og in to I)MF CognosF TM1F We".
These paraeters are !ocated in the app/ettings section of the we".config fi!e for I)M Cognos TM1 We"
and app!' g!o"a!!' to a!! users of I)M Cognos TM1 We".
'ote* +or detai!s on using the 1oe&ageO"<ect paraeter to set a custo hoepage@ see Configuring a
Custo 1oepage for I)M Cognos TM1 We".
'a(Tree3idden )arameter
The NavTree1idden paraeter deterines if the Navigation pane disp!a's when users !og in to I)M
Cognos TM1 We".
'a(TreeCollapsedOnStart )arameter
The NavTreeCo!!apsedOn*tart paraeter deterines if the Navigation pane wi!! "e inii=ed or
e#panded when users !og in. If co!!apsed@ a sa!! vertica! "ar disp!a's to provide the user with a wa'
to restore the pane.
3ideTab/ar )arameter
The 1ideTa")ar paraeter deterines if I)M Cognos TM1 We" can disp!a' u!tip!e ta"s when a user
opens u!tip!e I)M Cognos TM1 We" o"<ects@ or if on!' one view is disp!a'ed.
3ide$ebs%eetTool/ar )arameter
The 1ideWe"sheetToo!)ar paraeter deterines if the We"sheet too!"ar is disp!a'ed when users
open a We"sheet.
3ideCube(ieerTool/ar )arameter
The 1ideCu"eviewerToo!)ar paraeter deterines if the Cu"eviewer too!"ar is disp!a'ed when users
open a cu"e view.
303 of 425 26-09-2014 11:18
11.6.14.1. 'a(Tree3idden )arameter
The NavTree1idden paraeter deterines if the Navigation pane disp!a's when users !og in to I)MF
CognosF TM1F We".
This can "e he!pfu! if 'ou are disp!a'ing a custo hoepage for users and 'ou want to cop!ete!' hide
the Navigation pane.
The NavTree1idden paraeter uses the fo!!owing forat in the we".config fi!e>
<add key="NavTreeHidden" value="false;AllowOverwrite=true"
/>
where>
va!ue can "e either true or fa!se
If set to fa!se@ the Navigation pane wi!! "e disp!a'ed when user's !og in to I)M Cognos TM1 We".
If set to true@ the Navigation pane wi!! not "e disp!a'ed when user's !og in to I)M Cognos TM1 We".
,!!owOverwrite can "e set to true or fa!se as fo!!ows>
If 'ou set ,!!owOverwriteKtrue@ the NavTree1idden paraeter is assigned g!o"a!!' to a!! users@ "ut
can "e overridden for individua! c!ients using the C!ient *ettings dia!og in ,rchitect and *erver
.#p!orer.
If 'ou set ,!!owOverwriteKfa!se@ the NavTree1idden paraeter app!ies g!o"a!!' to a!! TM1 users and
can not "e overridden for individua! c!ients using the C!ient *ettings dia!og in ,rchitect and *erver
.#p!orer.
)arent topic* Configuring I)M Cognos TM1 We" *tartup and ,ppearance *ettings
304 of 425 26-09-2014 11:18
11.6.14.#. 'a(TreeCollapsedOnStart )arameter
The NavTreeCo!!apsedOn*tart paraeter deterines if the Navigation pane wi!! "e inii=ed or
e#panded when users !og in. If co!!apsed@ a sa!! vertica! "ar disp!a's to provide the user with a wa' to
restore the pane.
The NavTreeCo!!apsedOn*tart paraeter uses the fo!!owing forat in the we".config fi!e>
<add key="NavTreeCollapsedOnStart" value="false;AllowOverwrite=true"
/>
where>
va!ue can "e either true or fa!se.
If va!ue is set to fa!se@ the Navigation pane wi!! "e e#panded and disp!a' in its defau!t ode when
user's !og in to I)MF CognosF TM1F We".
If va!ue is set to true@ the Navigation pane wi!! "e co!!apsed when user's !og in to I)M Cognos TM1
We".
,!!owOverwrite can "e set to true or fa!se as fo!!ows>
If 'ou set ,!!owOverwriteKtrue@ the NavTreeCo!!apsedOn*tart paraeter is assigned g!o"a!!' to a!!
users@ "ut can "e overridden for individua! c!ients using the C!ient *ettings dia!og in TM1 ,rchitect
and *erver .#p!orer.
If 'ou set ,!!owOverwriteKfa!se@ the NavTreeCo!!apsedOn*tart paraeter app!ies g!o"a!!' to a!! TM1
users and cannot "e overridden for individua! c!ients using the C!ient *ettings dia!og in TM1 ,rchitect
and *erver .#p!orer.
305 of 425 26-09-2014 11:18
11.6.14.-. 3ideTab/ar )arameter
The 1ideTa")ar paraeter deterines if I)MF CognosF TM1F We" can disp!a' u!tip!e ta"s when a
user opens u!tip!e I)M Cognos TM1 We" o"<ects@ or if on!' one view is disp!a'ed.
This can "e usefu! if 'ou want to !iit users to one view at a tie.
The 1ideTa")ar paraeter uses the fo!!owing forat in the we".config fi!e>
<add key="HideTabBar" value="false;AllowOverwrite=true"
/>
where va!ue can "e either true or fa!se.
If va!ue is set to fa!se@ u!tip!e ta"s can "e disp!a'ed. This is the defau!t "ehavior of I)M Cognos TM1
We".
If va!ue is set to true@ u!tip!e ta"s are not disp!a'ed and on!' one o"<ect can "e opened at a tie.
The ,!!owOverwrite option is not current!' used for this paraeter.
306 of 425 26-09-2014 11:18
11.6.14.4. 3ide$ebs%eetTool/ar )arameter
The 1ideWe"sheetToo!)ar paraeter deterines if the We"sheet too!"ar is disp!a'ed when users open a
We"sheet.
The 1ideWe"sheetToo!)ar paraeter uses the fo!!owing forat in the we".config fi!e>
<add key="HideWebsheetToolBar" value="false;AllowOverwrite=true"
/>
If va!ue is set to fa!se@ the We"sheet too!"ar wi!! disp!a' in I)MF CognosF TM1F We".
If va!ue is set to true@ the We"sheet too!"ar wi!! not disp!a' in I)M Cognos TM1 We".
307 of 425 26-09-2014 11:18
11.6.14.6. 3ideCube(ieerTool/ar )arameter
The 1ideCu"eviewerToo!)ar paraeter deterines if the Cu"eviewer too!"ar is disp!a'ed when users
open a cu"e view.
The 1ideCu"eviewerToo!)ar paraeter uses the fo!!owing forat in the we".config fi!e>
<add key="HideCubeviewerToolBar" value="false;AllowOverwrite=true"
/>
If va!ue is set to fa!se@ the We"sheet too!"ar wi!! disp!a' in I)MF CognosF TM1F We".
If va!ue is set to true@ the We"sheet too!"ar wi!! not disp!a' in I)M Cognos TM1 We".
308 of 425 26-09-2014 11:18
11.6.16. 0sing t%e Custom:in" )arameter to Open Ot%er 02:s and
$eb )ages
The Custo6in/ paraeter disp!a's a !in/ in the I)MF CognosF TM1F We" too!"ar that can open a -06
address or we" page.
Aou can configure this paraeter with 'our own custo te#t and -06 for the !in/. When 'ou c!ic/ the !in/@
the target of the -06 opens in a new window using 'our s'ste's defau!t we" "rowser.
The defau!t setting for this paraeter is disa"!ed 7 a!! the va!ues for the paraeter are set to "!an/. This
prevents the !in/ fro disp!a'ing on the too!"ar.
<add key="CustomLink" value=";Description=;Url=;"
/>
To configure the Custo6in/ paraeter@ edit the we".config fi!e using the fo!!owing forat.
<add key="CustomLink" value="LinkTitle;Description=LinkTooltip;Url=LinkURL;"
/>
where
:inkTitle is the te#t that disp!a's for the !in/ in the too!"ar.
:inkTooltip is the he!p te#t that disp!a's when 'ou hover the ouse over the !in/.
:inkU(: is the -06 that 'ou want to open when 'ou c!ic/ the !in/.
+or e#ap!e>
<add key="CustomLink" value="IBM Web Site;Description=Open
the IBM Web Site;Url=http://www.ibm.com"/>
'ote* Aou ust fo!!ow standard character escape ru!es for 5M6 when adding a -06 to the 5M67"ased
we".config fi!e. +or e#ap!e@ rep!ace the &character with the &escape seBuence.
309 of 425 26-09-2014 11:18
11.6.1>. Configuring t%e I/M Cognos TM1 $eb 5irtual Cac%e .irectory
I)MF CognosF TM1F We" reBuires a virtua! director'@ outside of the I)M Cognos TM1 We" app!ication
director'@ as a !ocation for teporar' fi!es.
The .#ce!*heet and -serTep(ir directories are !ocated under this director' and are used during the
viewing of We"sheets and the e#porting of We"sheets and Cu"e 4iews fro I)M Cognos TM1 We". )'
defau!t@ the I)M Cognos TM1 We" insta!!ation configures this virtua! director' in the fo!!owing !ocation>
TM1_install_directory\TM1WebEx
'ote* This configuration does not t'pica!!' reBuire an' changes@ however@ if necessar'@ 'ou can configure
this setting using the -se*eparate4irtua!Cache paraeter in the we".config fi!e as fo!!ows>
<add key="UseSeparateVirtualCache" value="Y;Url=;AbsolutePath="/>
where the -r! and ,"so!ute&ath paraeters ust reso!ve to the sae !ocation.
-r! is the -06 path to the virtua! director' that 'ou want I)M Cognos TM1 We" to use as the cache
director'.
The defau!t is -r!Khttp>HHWe/erver9a"eHTM1We".#.
,"so!ute&ath is the path to the ph'sica! director' that 'ou want I)M Cognos TM1 We" to use as the
cache director'.
The defau!t is ,"so!ute&athKC>P&rogra +i!esPI)MPcognosPt1Pt1we"e#.
Important* The -se*eparate4irtua!Cache paraeter ust "e set to either A or not used at a!!. If this
paraeter is e#c!uded fro the we".config fi!e@ I)M Cognos TM1 We" uses TM1We".# as the defau!t
!ocation for the virtua! cache director'.
$arning* I)M Cognos TM1 We" wi!! not wor/ if the -se*eparate4irtua!Cache paraeter is set to N.
310 of 425 26-09-2014 11:18
11.6.1?. Controlling C%art Scaling and Increments it% t%e
SmartA+is1nabled )arameter
The *art,#is.na"!ed paraeter contro!s the autoatic sca!e and increent settings of the 5 and A7a#is
in I)MF CognosF TM1F We" charts.
When this paraeter is ena"!ed Gdefau!tI@ I)M Cognos TM1 We" uses a new enhanced disp!a' process
that autoatica!!' ad<usts the a#is sca!e and increent settings for charts. If disa"!ed@ I)M Cognos TM1
We" disp!a's charts using the !egac' autoatic sca!ing that was avai!a"!e in the ;.0 version of I)M
Cognos TM1 We".
To ena"!e this paraeter and use the new enhanced I)M Cognos TM1 We" ;.1.# charting@ edit the
we".config fi!e as fo!!ows>
<add key="SmartAxisEnabled" value="true" />
To disa"!e this paraeter and use the I)M Cognos TM1 We" ;.0 charting@ edit the we".config fi!e as
fo!!ows>
<add key="SmartAxisEnabled" value="false" />
311 of 425 26-09-2014 11:18
11.6.1@. 1nabling t%e $ebs%eet )aging Toolbar
The We"sheet paging feature inc!udes a too!"ar in I)MF CognosF TM1F We" that provides easier
navigation in We"sheets that contain a !arge nu"er of rows.
This too!"ar a!!ows 'ou to ove page "' page through a range of rows in the We"sheet or <up to a
range of rows that 'ou specif'.
The We"sheet paging too!"ar is disa"!ed "' defau!t. -se the WebsheetPaging paraeter in the we".config
fi!e to ena"!e and configure the We"sheet paging too!"ar.
)rocedure
Open the we".config fi!e and !ocate the  !ine. 1.
To ena"!e the We"sheet paging feature@ set the va!ue of the WebsheetPaging paraeter to
Enabled=true as fo!!ows>

<add key="WebsheetPaging" value="Enabled=true;PageSize=100"
/>
2.
*et the appro#iate nu"er of We"sheet rows that 'ou want viewa"!e in I)M Cognos TM1 We" "'
configuring the PageSize paraeter. +or e#ap!e>
<add key="WebsheetPaging" value="Enabled=true;
PageSize=50"
/>
$.
To disa"!e the We"sheet paging feature@ set the va!ue of the WebsheetPaging paraeter to
Enabled=false as fo!!ows>
<add key="WebsheetPaging" value="Enabled=false;PageSize=100"
/>
2.
*ave and c!ose the we".config fi!e. 3.
312 of 425 26-09-2014 11:18
11.6.1A. 0sing t%e TM1 $eb )age2esetMode parameter
The I)MF CognosF TM1F We" &age0esetMode paraeter a!!ows 'ou to contro! soe of the "ehavior of
page orientation in We"sheets when 'ou perfor certain actions such as reca!cu!ating@ re"ui!ding@ or
changing a tit!e diension e!eent for an ,ctive +or in a We"sheet.
$%en to use t%e )age2esetMode parameter
&aging and row "ehavior can var' in a We"sheet due to the specific !a'out of o"<ects@ such as iages@
charts@ andHor ,ctive +ors@ within a We"sheet and certain actions@ such as reca!cu!ating@ re"ui!ding@ or
changing a tit!e diension e!eent for an ,ctive +or in a We"sheet. In soe cases@ an une#pected
disp!a' of paging and rows can appear when viewing a We"sheet in TM1 . This "ehavior depends on the
specific content and action perfored in the We"sheet.
-se the &age0esetMode paraeter when 'ou want to contro! soe of the "ehavior of page orientation in
a We"sheet when 'ou p!an to perfor certain actions such as reca!cu!ating@ re"ui!ding@ or changing a tit!e
diension e!eent for an ,ctive +or in a We"sheet.
The &age0esetMode paraeter was introduced as of version ;.3.2
)age2esetMode configuration e+ample
-se the &age0esetMode paraeter to contro! the "ehavior of page orientation with We"sheets when
perforing the fo!!owing actions>
0eca!cu!ating a We"sheet
0e"ui!ding a We"sheet that contains an ,ctive +or
Initia! !oading of a We"sheet that contains an ,ctive +or
Changing a tit!e diension e!eent in a We"sheet with an ,ctive +or
)' defau!t@ as of version ;.3.2@ the &age0esetMode paraeter is set to a va!ue of $ in the we".config fi!e
when 'ou insta!!.
Aou can configure the &age0esetMode paraeter in the fo!!owing section of the we".config fi!e>
<add key="WebsheetPaging" value="Enabled=true;PageSize=10;PageResetMode=1" />
The fo!!owing va!ues can "e used with the &age0esetMode paraeter.
Ta"!e 1. &age0esetMode &araeter 4a!ues
5alue .escription
0 6egac' ode. The We"sheet pageview is not reset.
1 ,n' re"ui!d of the We"sheet resets the pageviews on a!! sheets Gta"sI in the wor/"oo/.
This does not reBuire an' present active for.
+or e#ap!e>
When 'ou perfor on!' a reca!c operation@ the We"sheet pageviews sta' in the sae p!ace
and do not go "ac/ to the top of the We"sheet.
When 'ou perfor a re"ui!d action or use the ,ctionK0e"ui!d stateent with the -06 ,&I
on a We"sheet@ TM1 We" resets the disp!a' of the We"sheet to the top of the page.
313 of 425 26-09-2014 11:18
5alue .escription
$ Inc!udes a!! cases for a setting of 1 and a!so resets the pageview of the sheet Gta"I that
contains the ,ctive +or when a tit!e diension e!eent is changed for that ,ctive +or.
This "ehavior is regard!ess of how or where the tit!e diension e!eent change occurs. The
action cou!d have occurred on another sheet Gta"I in the We"sheet@ either interactive!' or
"' ca!cu!ation.
+or e#ap!e>
When 'ou change a tit!e diension e!eent and auto reca!c is ena"!ed@ the We"sheet
pageview that contains the ,ctive +or is updated for the new tit!e diension se!ection
and the disp!a' of that pageview is reset to the top of the page.
When 'ou are on another page within a We"sheet Gfor e#ap!e@ page 2 of 10I and a tit!e
diension e!eent is changed@ the We"sheet pageview that contains the ,ctive +or is
updated for the new tit!e diension se!ection and the disp!a' of that pageview is reset to
the top of the page.
314 of 425 26-09-2014 11:18
11.6.#0. Alloing pasting in (alidated cells
Aou cannot paste on a ce!! when Microsoft .#ce! va!idation is set in the we". &aste.nforceent overrides
this restriction and a!!ows 'ou to perfor a paste into a ce!! with va!idation@ however@ using this
paraeter ignores an' va!idation set on the ce!!.
)' defau!t@ if 'ou have Microsoft .#ce! data va!idation turned on for a we" ce!!@ I)MF CognosF TM1F wi!!
not a!!ow a non7va!id ce!! va!ue to "e t'ped in. 1owever@ paste functiona!it' has "een restricted on these
t'pes of ce!!s. This "ehavior happens on!' for Microsoft .#ce! data va!idation. Cognos TM1 pic/!ists ce!!s
are va!idated different!' and are not affected "' this restriction.
When the &aste.nforceent we" configuration paraeter is turned on@ pasting into a ce!! with (ata
4a!idation is a!!owed. It is iportant to ree"er that a!!owing the paste to occur eans that data
va!idation is no !onger used so potentia!!' inva!id ce!! va!ues a' "e entered.
)' defau!t@ pasting is not a!!owed on ce!!s with data va!idation.
<add key="PasteEnforcement" value="Mode=0" />
To a!!ow pasting into Microsoft .#ce! va!idated ce!!s on the we"@ set the va!ue to Mode=1 in this paraeter
and save the we".config fi!e.
315 of 425 26-09-2014 11:18
11.6.#1. $rapping string (alues in cube (ies
-se Cu"eviewer*tringWrap to set the paraeters used when viewing string e!eent ce!!s in a We" Cu"e
4iew.
To contro! the wa' a view is disp!a'ed and wrapped@ set the va!ues using the Cu"eviewer*tringWrap
paraeter and save the we" configuration fi!e. Ce!!s that are not disp!a'ed are sti!! edita"!e in a scro!!a"!e
area "' c!ic/ing in the wrapped region.
1nabled
Turn wrapping of string ce!!s in this view on or off. When set to J+a!seJ the co!un width is as wide
as the !ongest string for an' row in the current view. *et to JTrueJ "' defau!t to turn on wrapping
using these defau!t paraeters.
MinC%aractersTo$rap
*et the iniu nu"er of characters needed "efore wrapping. +or instance@ string va!ues with
!ess than 30 characters wi!! not wrap within a ce!!. *et to 30 "' defau!t.
Ma+.isplayC%aracters
*et the a#iu nu"er of characters to disp!a' within the string ce!!. The ce!! a' contain ore
than this nu"er of characters@ "ut the' wi!! on!' "e disp!a'ed when dou"!e7c!ic/ing on the ce!!. If
the MinCharactersToWrap is 30 and the Ma#(isp!a'Characters is 200@ string ce!!s containing 200 or
ore characters wi!! consue appro#iate!' 2 !ines. *et to 200 "' defau!t.
Ma+.isplayC%aracters
*et the a#iu nu"er of characters 'ou want disp!a'ed. This is a pi#e! setting used to ca!i"rate
the string disp!a' for optia! appearance. *et to 200 "' defau!t.
$idt%Of$rapCell
*et the nu"er of characters used in the wrapped portion of the disp!a'. *et to 220 "' defau!t.
-se the fo!!owing forat in the we".config fi!e Gthe fo!!owing !isting has a return in it for c!arit' "ut 'ou
shou!d not enter a returnI.
<add key="CubeviewerStringWrap" value="Enabled=true;MinCharactersToWrap=50;
MaxDisplayCharacters=200;WidthOfWrapCell=240" />
2emember* Cu"eviewer*tringWrap does not app!' to We"sheets.
316 of 425 26-09-2014 11:18
11.>. )erforming $eb Folder Maintenance
I)MF CognosF TM1F We" uses two we" fo!ders for teporar' fi!es. Aou shou!d periodica!!' onitor
these fo!ders and c!ean the out during s'ste downtie.
+or "est practice@ onitor the fo!!owing fo!ders@ and de!ete their o!der content during s'ste downtie
when the fo!ders "ecoe fu!!.
1+cels%eet 7 When 'ou view an .#ce! sheet@ I)M Cognos TM1 We" writes severa! teporar' fi!es to
this fo!der.
The defau!t !ocation is> C:\Program Files\IBM\cognos\tm1\tm1webex
0serTemp.ir 7 Contains teporar' fi!es when e#porting fro I)M Cognos TM1
The defau!t !ocation is> C:\Program Files\IBM\cognos\tm1\tm1webex
317 of 425 26-09-2014 11:18
11.?. 0sing I/M Cognos TM1 $eb :ogging
I)MF CognosF TM1F We" adinistrators can use the fo!!owing two !og fi!es for status and
trou"!eshooting of I)M Cognos TM1 We". The severit' !eve!s in the !og fi!es he!p organi=e essages.
Web.config 7 I)M Cognos TM1 We" !og fi!e
TM1ExcelService.exe.config 7 I)M CognosTM1 .#ce! *ervices !og fi!e
Message Se(erity :e(els for I/M Cognos TM1 $eb :ogging
The !ogging process for I)M Cognos TM1 We" and TM1 .#ce! *ervices categori=es !og essages into
three severit' !eve!s.
I/M Cognos TM1 $eb :og
The I)M Cognos TM1 We" !og records essages for I)M Cognos TM1 We" activit' and errors.
TM1 1+cel Ser(ices :og
The TM1 .#ce! *ervices !og records essages for the TM1 .#ce! *ervice 7 an app!ication that runs in
the "ac/ground to hand!e I)M Cognos TM1 We" reBuests for converting .#ce! fi!es into 5M6 forat.
318 of 425 26-09-2014 11:18
11.?.1. Message Se(erity :e(els for I/M Cognos TM1 $eb :ogging
The !ogging process for I)MF CognosF TM1F We" and TM1 .#ce! *ervices categori=es !og essages
into three severit' !eve!s.
These !eve!s are a!so used in the !ogging properties fi!e to configure !ogging to a specific !eve!.
(.)-G (etai!ed@ technica! essages that are usefu! when TM1 custoer support or
deve!opent engineering need to de"ug the app!ication.
When !ogging is configured to this !eve!@ (.)-G@ IN+O@ and .00O0 essages are
!ogged.
IN+O Inforationa! essages that high!ight the progress of the app!ication and report
nora! transitions within the app!ication.
When !ogging is configured to this !eve!@ IN+O and .00O0 essages are !ogged.
.00O0 ,n error condition of which 'ou shou!d "e aware. ,ction shou!d "e ta/en to fi# or
report the issue to TM1 custoer support.
When !ogging is configured to this !eve!@ on!' .00O0 essages are !ogged.
)arent topic* -sing I)M Cognos TM1 We" 6ogging
319 of 425 26-09-2014 11:18
11.?.#. I/M Cognos TM1 $eb :og
The I)MF CognosF TM1F We" !og records essages for I)M Cognos TM1 We" activit' and errors.
The !og fi!e is an ,*CII te#t fi!e that 'ou can open in an' te#t editor@ such as Microsoft Windows Notepad.
Configuring and 1nabling I/M Cognos TM1 $eb :ogging
Aou can change the !ogging essage !eve! for I)M Cognos TM1 We" !ogging.
5ieing t%e I/M Cognos TM1 $eb :og File
The I)M Cognos TM1 We" insta!!ation configures I)M Cognos TM1 We" !ogging to write essages to
the tm1web.log fi!e in the TM1 61e director'.
320 of 425 26-09-2014 11:18
11.?.#.1. Configuring and 1nabling I/M Cognos TM1 $eb :ogging
Aou can change the !ogging essage !eve! for I)MF CognosF TM1F We" !ogging.
6ogging !eve!s are stored in the !ogging properties section of the Web.config fi!e.
6ogging is ena"!ed when the !ogging properties in the web.config fi!e are correct!' configured to turn on
!ogging. 6ogging for I)M Cognos TM1 We" is configured "' defau!t when I)M Cognos TM1 We" is
insta!!ed.
The we".config fi!e is insta!!ed in the TM1 We" install6director7. If 'ou insta!!ed I)M Cognos TM1 We" to
the defau!t insta!!ation !ocation@ the web.config fi!e is !ocated in the director' C:\Program Files\IBM
\cognos\tm1\tm1web.
The defau!t we" !ogging configuration is intended for ever'da' use and does not t'pica!!' reBuire
ad<ustent. +or assistance if 'ou need to configure the !ogging properties for trou"!eshooting purposes@
contact I)M Cognos Custoer *upport.
The fo!!owing is a sap!e of the !ogging properties section in the web.config fi!e.
<log4net>
<root>
<level value="ERROR" />
<appender-ref ref="LogFileAppender" />
</root>
<appender name="LogFileAppender" type="log4net.Appender.RollingFileAppender">
<file value="log\tm1web.log" />
<appendToFile value="true" />
<datePattern value="yyyyMMdd" />
<rollingStyle value="Date" />
<filter type="log4net.Filter.LevelRangeFilter">
<acceptOnMatch value="true" />
<levelMin value="INFO" />
<levelMax value="FATAL" />
</filter>
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%date [%thread] %-5level
%logger - %message%newline" />
</layout>
</appender>
</log4net>
Where>
The essage !eve! is indicated "'> <level value="ERROR" />
The !og fi!e nae is indicated "'> <file value="log\tm1web.log" />
321 of 425 26-09-2014 11:18
Attention* )' defau!t@ the !og fi!e is created "eneath the root of 'our we" server. ,s such@ it cou!d "e
accessi"!e "' unauthori=ed individua!s. Consider setting the file value paraeter to write the !og fi!e to
a secure !ocation. The paraeter can accept a re!ative or !itera! path.
the iniu and a#iu essage !eve! ranges are indicated "'>
)rocedure
Open the web.config fi!e in a te#t editor@ such as Microsoft Windows Notepad. 1.
6ocate the fo!!owing section of code>
2.
Change the !eve! to one of the va!id va!uesN (.)-G@ IN+O@ or .00O0.
+or e#ap!e@ to change the essage !eve! to (.)-G@ edit this !ine as fo!!ows>
<level value="DEBUG" />
$.
6ocate the settings for the levelMin and levelMax paraeters.
,d<ust the va!ues for the levelMin and levelMax paraeters to a range that inc!udes the !eve! 'ou
want to !og.
+or e#ap!e@ to !og (.)-G !eve! essages@ change the levelMin paraeter to (.)-G.
<levelMin value="DEBUG" />
2.
*ave and c!ose the fi!e. 3.
)arent topic* I)M Cognos TM1 We" 6og
322 of 425 26-09-2014 11:18
11.?.#.#. 5ieing t%e I/M Cognos TM1 $eb :og File
The I)MF CognosF TM1F We" insta!!ation configures I)M Cognos TM1 We" !ogging to write essages
to the tm1web.log fi!e in the TM1 61e director'.
<TM1_web_install_directory>\log
About t%is tas"
If 'ou insta!!ed I)M Cognos TM1 We" to the defau!t insta!!ation !ocation@ then the tm1web.log fi!e is
!ocated in the fo!!owing director'>
C:\Program Files\IBM\cognos\tm1\tm1web\log
+or "ac/up purposes@ a cop' of the tm1web.log fi!e is renaed and saved on a dai!' "asis using the
fo!!owing naing convention>
tm1web.log<year><mm><dd>
+or e#ap!e@ tm1web.log20070116.
)rocedure
6ocate the tm1web.log fi!e in the VTM1_web__install>\log\ director'. 1.
Open and view the fi!e with a te#t editor@ such as Microsoft Windows Notepad. 2.
2esults
.ach !ine in the !og fi!e represents one uniBue essage@ arranged in the fo!!owing forat>
2007-01-17 11:13:36,916 [2600] ERROR Cognos.TM1.Web.PageTM1WebpageUtils
- <Chores> not localized
Where>
2007-01-17 11:13:36,916 is the date and tie
[2600] is the thread I(
ERROR is the essage !eve!
Cognos.TM1.Web.PageTM1WebpageUtils is the su" coponent nae
<Chores> not localized is the essage te#t.
)arent topic* I)M Cognos TM1 We" 6og
323 of 425 26-09-2014 11:18
11.?.-. TM1 1+cel Ser(ices :og
The TM1F .#ce! *ervices !og records essages for the TM1 .#ce! *ervice 7 an app!ication that runs in the
"ac/ground to hand!e I)MF CognosF TM1 We" reBuests for converting .#ce! fi!es into 5M6 forat.
The TM1 .#ce! *ervices !og fi!e is an ,*CII te#t fi!e that 'ou can open in an' te#t editor@ such as Microsoft
Windows Notepad.
Configuring TM1 1+cel Ser(ices :ogging
Aou can ad<ust the !ogging essage !eve!.
1nabling TM1 1+cel Ser(ices :ogging
6ogging for TM1 .#ce! *ervices is configured "' defau!t when 'ou insta!! I)M Cognos TM1 We".
5ieing t%e TM1 1+cel Ser(ices :og File
The I)M Cognos TM1 We" insta!!ation configures TM1 .#ce! *ervices !ogging to write essages to a
fi!e ca!!ed tm1excelservice.log. On a dai!' "asis@ this fi!e is renaed and archived using a specific
naing convention.
324 of 425 26-09-2014 11:18
11.?.-.1. Configuring TM1 1+cel Ser(ices :ogging
Aou can ad<ust the !ogging essage !eve!.
The configuration for TM1F .#ce! *ervices !ogging is stored in the TM1ExcelService.exe.config fi!e.
The TM1ExcelService.exe.config fi!e is !ocated in the TM1 install_dir\bin director'. If 'ou insta!!ed
TM1 to the defau!t insta!!ation !ocation@ then this fi!e is !ocated in C:\Program Files\IBM\cognos
\tm1\bin.
'ote* The defau!t !ogging configuration is intended for ever'7da' use and does not t'pica!!' reBuire
ad<ustent. Contact Cognos TM1 custoer support for assistance if 'ou need to configure the
TM1ExcelService.exe.config fi!e for trou"!eshooting purposes.
, sap!e of the TM1ExcelService.exe.config fi!e is shown>
<log4net>
<root>
<appender-ref ref="LogFileAppender" />
</root>
<appender name="LogFileAppender" type="log4net.Appender.RollingFileAppender">
<file value="tm1excelservice.log" />
<appendToFile value="true" />
<datePattern value="yyyyMMdd" />
<rollingStyle value="Date" />
<filter type="log4net.Filter.LevelRangeFilter">
<acceptOnMatch value="true" />
</filter>
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%date [%thread] %-5level
%logger - %message%newline" />
</layout>
</appender>
</log4net>
Where>
The essage !eve! is indicated "'> <level value="ERROR" />
The !og fi!e nae is indicated "'> <file value="tm1excelservice.log" />
The iniu and a#iu essage !eve! ranges are indicated "'>
325 of 425 26-09-2014 11:18
)rocedure
Open the TM1ExcelService.exe.config fi!e in a te#t editor@ such as Microsoft Windows Notepad. 1.
6ocate the fo!!owing section of code
2.
Change the !eve! to one of the va!id va!uesN (.)-G@ IN+O@ or .00O0.
+or e#ap!e@ to change the essage !eve! to (.)-G@ edit this !ine as fo!!ows>
<level value="DEBUG" />
$.
6ocate the settings for the levelMin and levelMax paraeters.
,d<ust the va!ues for the levelMin and levelMax paraeters to a range that inc!udes the !eve! 'ou
want to !og.
+or e#ap!e@ to !og (.)-G !eve! essages@ change the levelMin paraeter to (.)-G.
<levelMin value="DEBUG" />
2.
*ave and c!ose the fi!e. 3.
)arent topic* TM1 .#ce! *ervices 6og
326 of 425 26-09-2014 11:18
11.?.-.#. 1nabling TM1 1+cel Ser(ices :ogging
6ogging for TM1F .#ce! *ervices is configured "' defau!t when 'ou insta!! I)MF CognosF TM1 We".
The insta!!ation p!aces the TM1ExcelService.exe.config fi!e and the TM1 .#ce! *ervices fi!e@
TM1ExcelService.exe@ into the TM1 install_dir\bindirector'.
6ogging is started when TM1 .#ce! *ervices starts up and detects the TM1ExcelService.exe.config fi!e
in the sae director'.
327 of 425 26-09-2014 11:18
11.?.-.-. 5ieing t%e TM1 1+cel Ser(ices :og File
The I)MF CognosF TM1F We" insta!!ation configures TM1 .#ce! *ervices !ogging to write essages to a
fi!e ca!!ed tm1excelservice.log. On a dai!' "asis@ this fi!e is renaed and archived using a specific
naing convention.
tm1excelservice.log<year><mm><dd>
+or e#ap!e@ tm1excelservice.log20070116.
)rocedure
6ocate the tm1excelservice.log fi!e in the TM1 install_dir\bin director'. 1.
Open and view the fi!e with a te#t editor@ such as Microsoft Windows Notepad. 2.
2esults
.ach !ine in the fi!e represents one uniBue essage@ arranged in the fo!!owing forat>
2007-01-16 10:59:40,846 [3156] ERROR Cognos.TM1.ExcelServices.TM1ExcelService
- 'PDFcamp Printer' printer
Where>
2007-01-16 10:59:40,846 is the date and tie
[3156] is the thread I(
ERROR is the essage !eve!
Cognos.TM1.ExcelServices.TM1ExcelService is the TM1 su"7coponent nae
'PDFcamp Printer' printer is the essage te#t.
328 of 425 26-09-2014 11:18
1#. 0nderstanding Cube .ependency
I)MF CognosF TM1F server esta"!ishes dependencies so it can proper!' inva!idate cu"e caches.
(ependencies are esta"!ished genera!!' when a user e#ecutes a Buer' on a cu"e and when that Buer'
inc!udes a ru!e7ca!cu!ated va!ue fro another cu"e. , dependenc' can "e esta"!ished to one or an'
cu"es "ased on the scope of the ru!e within the )ase cu"e.
1ere is a sip!e e#ap!e of a dependenc' within TM1 >
In this sip!e case@ the caches in )ase cu"e are inva!ided when>
there is a change in the )ase cu"e itse!f
or
there is a change in the dependent cu"e
*ince a dependenc' is esta"!ished@ when there is a change in the dependent cu"e@ the )ase cu"e ust
a!so change.
Without this dependenc' ap@ the )ase cu"e data cou!d "ecoe inconsistent with the (ependent cu"e.
The )ase data is dependent upon the data in the dependent cu"e so an' change in the (ependent cu"e
reBuires the )ase cache to change a!so.
C%anges in .ependency Mapping
TM1 ;.2.1 +&$ introduced a change to the dependenc' apping to a/e TM1 ore sta"!e and to
perfor "etter.
Clearing Cube .ependencies
The fo!!owing ta"!e descri"es the TM1 events or actions that destro' a cu"e's dependenc'.
Creating Cube .ependencies
The fo!!owing ta"!e descri"es the TM1 events or actions that add a cu"e dependenc'.
0sing AddCube.ependency to 1stablis% .ependencies
The ,ddCu"e(ependenc' function is used to create a anua! dependenc' "etween two cu"es.
329 of 425 26-09-2014 11:18
1#.1. C%anges in .ependency Mapping
TM1F ;.2.1 +&$ introduced a change to the dependenc' apping to a/e TM1 ore sta"!e and to
perfor "etter.
There is an artifact of this change that users upgrading to TM1 ;.2.1 +&$ and a"ove shou!d understand.
In previous re!eases@ this dependenc' ap "etween cu"es was esta"!ished when ru!es were e#ecuted
that referenced other cu"es. 1owever@ these dependencies were c!eared when there was an' inva!idation
"etween the cu"es and these dependencies wou!d again "e re7esta"!ished once the ru!e was run to
esta"!ish the dependenc'.
(ependenc' "ehavior now fo!!ows these ru!es>
(ependencies once esta"!ished are NOT c!eared "ased on data inva!idation.
Cu"e dependencies can "e esta"!ished ahead of tie using the ,ddCu"e(ependenc' TM1 function.
When dependencies are created@ the dependenc' !ists are protected "' an o"<ect !oc/ "etween the cu"es
affected.
The fact that dependenc' !ists are protected "' an o"<ect !oc/ and JhangsJ off a cu"e has an iportant
effect on app!ication upgrade. The dependenc' "!oc/s writers as we!! as readers fro a cu"e o"<ect when
a reader Bueries a cu"e and when there is a need to add or write to the dependenc' !ist o"<ect for that
cu"e. This !oc/ persists for the duration of the read Buer'. +or fast Bueries@ this ipact is inia! and a
one tie JcostJ for each cu"e7to7cu"e dependenc'. +or s!ower Bueries@ however@ other users a' "e
"!oc/ed for usua!!' !ong periods. In cop!e# app!ications@ the dependenc' o"<ect a' "e !oc/ed an'
ties initia!!' as users e#ecute on!' certain ru!es. 1ere is an e#ap!e>
In this e#ap!e@ the arrows show data f!ow "ased on ru!e connections. Cu"e ) has a two ru!es> one that
pu!!s fro Cu"e C and the other pu!!s fro Cu"e (. Cu"e ( has a sing!e ru!e that pu!!s fro Cu"es . and
+.
When -ser 1 reads fro Cu"e )@ a ru!e ca!cu!ated there reBuires data pu!!ed fro Cu"e C. *o Cu"e )@ C
and re!ated cu"e o"<ects are "!oc/ed unti! -ser 1's Buer' is cop!eted.
330 of 425 26-09-2014 11:18
When -ser 2 reads fro Cu"e )@ a ru!e ca!cu!ated there reBuires data pu!!ed fro Cu"e (. Cu"e )@ (@
and re!ated cu"e o"<ects are now "!oc/ed unti! -ser 2's Buer' is cop!eted.
To address this situation@ the Tur"oIntegrator function ,ddCu"e(ependenc' was created to esta"!ish
dependencies. This function a!!ows users to esta"!ish dependencies after events such as a re7start of the
server. In the ;.3 series@ other enhanceents are avai!a"!e to "etter esta"!ish dependencies without an'
anua! intervention.
)arent topic* -nderstanding Cu"e (ependenc'
331 of 425 26-09-2014 11:18
1#.#. Clearing Cube .ependencies
The fo!!owing ta"!e descri"es the TM1F events or actions that destro' a cu"e's dependenc'.
1(ent .ependency Action
*erver *hutdown Cu"e dependenc' !ists are destro'ed.
0u!e Copi!e GNote> an' diensiuon update
casues a ru!e copi!e.
.!iinates on!' those cu"es where ru!es have "een
de!eted or odified.
When cu"e dependencies are c!eared@ depending on the app!ication and the !eve! of user activit'@ 'ou
a' want to esta"!ish those cu"e dependencies anua!!'.
332 of 425 26-09-2014 11:18
1#.-. Creating Cube .ependencies
The fo!!owing ta"!e descri"es the TM1F events or actions that add a cu"e dependenc'.
1(ent .ependency Action
*erver *tartup Gnot avai!a"!e for TM1 ;.2.1 +&$
1*9I
Ca!cu!ated +eeders wi!! create dependencies.
*erver *tartup Q &ersistent +eeders Gnot avai!a"!e
for TM1 ;.2.1 +&$ 1*9I
&ersistent +eeders a!so store dependenc' aps for
each cu"e.
0u!e Copi!e Ca!cu!ated +eeders for the particu!ar cu"e ru!e wi!!
create dependencies.
0u!e Ca!cu!ation Create dependencies "ased which ru!e is e#ecuted
"' the Buer'.
TI +unction TI +unction can create dependencies "etween
cu"es.
333 of 425 26-09-2014 11:18
1#.4. 0sing AddCube.ependency to 1stablis% .ependencies
The ,ddCu"e(ependenc' function is used to create a anua! dependenc' "etween two cu"es.
,ddCu"e(ependenc' is a Tur"oIntegrator function@ va!id on!' in Tur"oIntegrator processes.
This function creates a anua!!'7created dependenc' "etween Cu"e , and Cu"e ).
*'nta#> AddCubeDependency('CubeA','CubeB');
Argument .escription
Cu"e, The nae of the "ase cu"e.
Cu"e) The nae of the dependent cu"e.
Cu"e ) re!ies on a ru!e that is dependent on Cu"e ,.
This function can "e set in an'where in the Tur"oIntegrator ,dvanced ta".
.ebugging and Identifying Cube .ependencies
-sing Tur"oIntegrator to preset dependencies a' "e necessar'.
334 of 425 26-09-2014 11:18
1#.4.1. .ebugging and Identifying Cube .ependencies
-sing Tur"oIntegrator to preset dependencies a' "e necessar'.
To identif' e#isting cu"e dependencies reBuires an in7depth understanding of an app!ication so that 'ou
can ana!'=e a!! of the ru!es for each cu"e inc!uding contro! cu"es. .ven when 'ou have that !eve! of
/now!edge a"out an app!ication@ it is iportant to turn on the fo!!owing !ogging capa"i!it' to identif' cu"e
dependencies as the' are esta"!ished.
+or e#ap!e@ when the fo!!owing coand is added to the the t1s7!og.properties fi!e>
log4j.logger.TM1.Cube.Dependency=DEBUG
the fo!!owing inforation is returned that identifies dependencies>
INFO 2010-06-09 18:09:23.728 TM1.Cube.Dependency
Adding cube dependency: cube
"}ElementSecurity_}Cubes" depends on cube "}CubeSecurity"
The Tur"oIntegrator coand for this wou!d "e>
AddCubeDependency('}CubeSecurity','}ElementSecurity_}Cubes');
)arent topic* -sing ,ddCu"e(ependenc' to .sta"!ish (ependencies
335 of 425 26-09-2014 11:18
1-. 2eplicating Cubes
This section descri"es how 'ou can rep!icate cu"es fro one I)MF CognosF TM1F server to another@
and s'nchroni=e the updates across the copied cu"es.
2eplication O(er(ie
(epending on 'our access privi!eges@ 'ou can cop' cu"es Gand their associated diensions@ ru!es@
su"sets@ and viewsI fro one server to another@ and s'nchroni=e the updates aong the copied
cu"es either at specified tie interva!s or on deand. The process of cop'ing cu"es fro one server
to another is ca!!ed rep!ication.
Maintaining 2eplication Connections
In order to rep!icate cu"es@ 'ou ust first create a rep!ication connection "etween two servers.
2eplication )rocess
,fter 'ou create a rep!ication connection "etween two servers@ 'ou can rep!icate the cu"es fro the
source server to the target server.
Sync%roni7ation )rocess
Aou a!wa's initiate the s'nchroni=ation process fro the target server@ which is the server that
contains the irror cu"es. Aou ust have adinistrator authorit' for this server to initiate the
s'nchroni=ation process.
336 of 425 26-09-2014 11:18
1-.1. 2eplication O(er(ie
(epending on 'our access privi!eges@ 'ou can cop' cu"es Gand their associated diensions@ ru!es@
su"sets@ and viewsI fro one server to another@ and s'nchroni=e the updates aong the copied cu"es
either at specified tie interva!s or on deand. The process of cop'ing cu"es fro one server to another
is ca!!ed rep!ication.
'ote* 0ep!ication and s'nchroni=ation operations in I)MF CognosF TM1F shou!d on!' "e perfored "'
e"ers of the ,(MIN group. Me"ers of the (ata,din and *ecurit',din groups do not have a!! the
reBuired access privi!eges to perfor these operations.
Ad(antages of 0sing 2eplication
0ep!ication offers the fo!!owing advantages.
.nhances response tie "ecause users can update a cu"e !oca!!' without having to counicate
across a networ/.
6ets users access and update a cop' of a cu"e@ even when the' are not connected to the reote
server on which the origina! cu"e resides.
Great!' enhances the sca!a"i!it' of TM1 .
TM1 provides "i7directiona! s'nchroni=ation for rep!icated cu"es. (uring the s'nchroni=ation process@ TM1
copies the data updates and etadata fro the origina! cu"e to its rep!icated versions@ and copies the
data updates fro the rep!icated versions "ac/ to the origina! cu"e.
Considerations $%en 0sing 2eplication
The fo!!owing considerations app!' to rep!ication>
TM1 (ersions7 ,!! TM1 servers in a rep!ication process ust "e the identica! version.
2emote ser(ers 7 Aou can rep!icate cu"es that reside on reote servers on!'. Aou cannot rep!icate
cu"es that reside on !oca! servers.
:ocal ser(ers 7 TM1 c!ients can rep!icate cu"es to their !oca! server on!' if the' are running that
server as an independent process. The achine ust have a networ/ card. To run a !oca! server as
an independent process@ c!ients need to se!ect the 6oca! *erver .#ecution Mode> Independent &rocess
option in the TM1 Options dia!og "o#.
Access pri(ileges 7 When 'ou rep!icate a source cu"e on a reote server to a !oca! server@ an'
e!eents to which the !oca! c!ient has NON. access on the reote server@ wi!! have a va!ue of =ero. If
the c!ient has 0.,( Gor higherI access to a conso!idation that inc!udes e!eents to which the c!ient
has NON. access@ the conso!idation wi!! appear to "e the su of on!' those e!eents to which the
c!ient has 0.,( Gor higherI access. The conso!idation@ as reported to the c!ient@ wi!! not "e the su of
a!! e!eents@ as in the source cu"e.
'ote* When 'ou set securit' !eve!s and esta"!ish rep!ication to the !oca! servers@ 'ou ust /now the
ip!ications of rep!icating data to which a c!ient does not have at !east 0.,( access.
Tm1s.cfg file 7 The T1s.cfg fi!e ust "e configured to register the target and source servers with
the sae TM1 ,din *erver. +or detai!s@ see Configuring the T1s.cfg +i!e to *upport 0ep!ication.
:engt% of directory pat% and cube name 7 The tota! !ength of the pathnae for the target TM1
server's data director' and the nae of the cu"e 'ou are rep!icating can not e#ceed the Windows
pathnae !iit of appro#iate!' 238 characters. If this !iit is e#ceeded@ due to a !ong pathnae or
cu"e nae@ TM1 disp!a's the fo!!owing error essage> Cou!d not register the cu"e.
Transaction :ogging 7 If 'ou are perforing a s'nchroni=ation process@ transaction !ogging ust "e
ena"!ed for the irror cu"es on the target server that are part of the rep!ication and s'nchroni=ation
337 of 425 26-09-2014 11:18
process. If 'ou are perforing a "i7directiona! s'nchroni=ation@ transaction !ogging ust "e ena"!ed
for a!! the re!ated cu"es on "oth the source and target servers.
TM1 uses these !og fi!es to /eep trac/ of the changes ade to the source and irror cu"es. To verif'
that transaction !ogging is ena"!ed@ see .na"!ing and (isa"!ing Transaction 6ogging in the I)M Cognos
TM1 Operation Guide.
Cube)roperties Control Cube 7 The va!ues stored in the Cu"e&roperties contro! cu"e are specific to
a TM1 server and are not copied fro the aster to the target server during a rep!ication process.
+or e#ap!e@ if 'ou wanted the Measures diension for a rep!icated cu"e to "e set on the target
server@ 'ou wou!d have to anua!!' set the va!ue in the Cu"e&roperties contro! cu"e on the target
server.
2elations%ips Created by 2eplication
, rep!ication creates a re!ationship "etween two cu"es and "etween two servers. There are two t'pes
of re!ationships> cu"e and server. , rep!ication creates server configurations.
2e<uired Access )ri(ileges
To rep!icate a cu"e@ 'ou need the fo!!owing access privi!eges>
Admin Ser(er Considerations
When 'ou esta"!ish a rep!ication connection@ "oth the source server and the target server ust "e
registered on the sae ,din *erver. If the two servers do not share the sae ,din *erver@ the
rep!ication and s'nchroni=ation resu!ts are unpredicta"!e.
Configuring t%e Tm1s.cfg File to Support 2eplication
The target and source TM1 servers ust "e registered with the sae TM1 ,din *erver. .ach server
can "e registered with other ,din servers@ "ut the target and source servers ust share at !east
one coon ,din *erver.
)arent topic* 0ep!icating Cu"es
338 of 425 26-09-2014 11:18
1-.1.1. 2elations%ips Created by 2eplication
, rep!ication creates a re!ationship "etween two cu"es and "etween two servers. There are two t'pes of
re!ationships> cu"e and server. , rep!ication creates server configurations.
Cube 2elations%ips
When 'ou rep!icate a cu"e@ the origina! cu"e is ca!!ed the source cu"e@ and a cop' of that cu"e is ca!!ed
the irror cu"e. Aou can rep!icate a sing!e cu"e on an' different servers@ and 'ou can rep!icate a
rep!icated cu"e.
Ser(er 2elations%ips
To rep!icate a cu"e@ 'ou ust !og on to a reote server and create a rep!ication connection. This
connection esta"!ishes the reote server that 'ou <ust !ogged on to as a source server and the server
'ou !ogged in fro as the target server.
,fter 'ou esta"!ish a rep!ication connection@ 'ou can rep!icate as an' cu"es as 'ou want to through this
connection. TM1F uses the !ogon I( for the rep!ication connection to deterine 'our access rights to the
source data.
The sae TM1 server can "e "oth a target server for soe cu"es@ and a source server for other cu"es. In
this situation@ there wou!d "e two rep!ication connections "etween the target and source servers@ as
i!!ustrated in the fo!!owing diagra.
The s'nchroni=ation process occurs at the server !eve!@ rather than at the cu"e !eve!. When 'ou
s'nchroni=e the rep!ication connection@ TM1 updates a!! the irror cu"es that are part of the sae
rep!ication connection. +or e#ap!e@ if 'ou rep!icate Cu"es , and ) fro a centra! server to the 0egion 2
server@ "oth of these cu"es are updated when 'ou initiate the s'nchroni=ation process for the rep!ication
connection "etween these two servers.
Typical Ser(er Configurations
The t'pica! server configurations that TM1 create when 'ou rep!icate cu"es are shown in the fo!!owing
diagra.
'ote* ,s the TM1 adinistrator@ 'ou ust ensure that no !oops are created through a rep!ication.
When 'ou rep!icate a sing!e cu"e on an' different servers@ 'ou create a star configuration of servers.
+or e#ap!e@ 'ou can rep!icate Cu"e , fro a centra! server to four regiona! servers.
339 of 425 26-09-2014 11:18
When 'ou rep!icate a rep!icated cu"e@ 'ou create a chain configuration of servers. +or e#ap!e@ using the
star configuration of servers@ Cu"e , can "e rep!icated fro 0egion $ to a !oca! server.
Aou can co"ine the star and chain configurations@ as shown "e!ow.
340 of 425 26-09-2014 11:18
)arent topic* 0ep!ication Overview
341 of 425 26-09-2014 11:18
1-.1.#. 2e<uired Access )ri(ileges
To rep!icate a cu"e@ 'ou need the fo!!owing access privi!eges>
0ead access or higher to the cu"e 'ou want to rep!icate.
If 'ou have access privi!eges for on!' certain e!eents in a cu"e@ TM1F copies the va!ues for those
e!eents@ "ut does not popu!ate the rest of the cu"e.
,din access to the server where 'ou are creating the rep!icated cu"e. Aou ust "e in the ,(MIN
group on that server. Me"ers of the (ata,din and *ecurit',din groups do not have a!! the
reBuired access privi!eges to perfor rep!ication and s'nchroni=ation operations.
-sers have ,din access to their !oca! servers and can rep!icate an' cu"e for which the' have 0ead
access to the !oca! server.
,s the TM1 adinistrator@ 'ou are responsi"!e for rep!icating cu"es on the reote servers.
'ote* ,!though 'ou can rep!icate a cu"e if 'ou have 0ead access to it@ 'ou need 0eserve access to the
cu"e to write updates "ac/ to cu"e during the s'nchroni=ation process. *ee *'nchroni=ation &rocess.
342 of 425 26-09-2014 11:18
1-.1.-. Admin Ser(er Considerations
When 'ou esta"!ish a rep!ication connection@ "oth the source server and the target server ust "e
registered on the sae ,din *erver. If the two servers do not share the sae ,din *erver@ the
rep!ication and s'nchroni=ation resu!ts are unpredicta"!e.
+or detai!s on verif'ing that the source and target servers register with the sae ,din *erver@ see
Configuring the T1s.cfg +i!e to *upport 0ep!ication.
+or detai!s on the ,din *erver@ see TM1 ,din *erver.
Setting up 2eplication
There are three stages 'ou ust fo!!ow to set up a rep!ication for a TM1 s'ste.
343 of 425 26-09-2014 11:18
1-.1.-.1. Setting up 2eplication
There are three stages 'ou ust fo!!ow to set up a rep!ication for a TM1F s'ste.
)rocedure
Create a rep!ication connection "etween the target and source servers. +or ore inforation@ see
0ep!ication &rocess.
1.
0ep!icate one or ore cu"es fro the target server to the source server. 2.
,fter 'ou a/e updates to the cu"es@ initiate the s'nchroni=ation process@ if s'nchroni=ation is done
on deand. +or ore inforation@ see *'nchroni=ation &rocess.
$.
)arent topic* ,din *erver Considerations
344 of 425 26-09-2014 11:18
1-.1.4. Configuring t%e Tm1s.cfg File to Support 2eplication
The target and source TM1F servers ust "e registered with the sae TM1 ,din *erver. .ach server
can "e registered with other ,din servers@ "ut the target and source servers ust share at !east one
coon ,din *erver.
.dit the ,din1ost paraeter in the T1s.cfg fi!e for the target TM1 server so it registers with the sae
,din *erver as the source.
AdminHost=hostname1;hostname2
where>
2ostna"e1 is the coputer nae or I& address of the TM1 ,din 1ost where the target TM1 server
is registered.
2ostna"e# is the coputer nae or I& address of the TM1 ,din 1ost where the source TM1 server
is registered.
Aou can use a i# of coputer naes and I& addresses and 'ou can a!so !ist u!tip!e ,din hosts>
+or e#ap!e>
AdminHost=boston;newyork
or
AdminHost=192.168.1.17;192.168.1.22
or
AdminHost=boston;192.168.1.17;192.168.1.22;myserver;192.168.1.40
+or ore detai!s a"out configuration paraeters@ see the IBM. Cognos. TM1 Installation and
345 of 425 26-09-2014 11:18
1-.#. Maintaining 2eplication Connections
In order to rep!icate cu"es@ 'ou ust first create a rep!ication connection "etween two servers.
Creating a 2eplication Connection
To create a rep!ication connection "etween two servers@ cop!ete the fo!!owing steps.
Modifying a 2eplication Connection
Aou can change the user nae and password properties of a rep!ication connection. If 'ou change
these properties@ 'ou are !ogged in to the rep!ication server as a different user. The e#isting
rep!ication re!ationships "etween the source cu"e and the irror cu"e a' no !onger "e va!id. The
privi!eges of the new c!ient a' not "e eBuiva!ent to those of the o!d c!ient. In this case@ the
s'nchroni=ation process does not wor/.
.eleting a 2eplication Connection
Aou can sever the re!ationship "etween the source and target servers "' de!eting a rep!ication
connection. When 'ou do this@ 'ou de!ete the re!ationship "etween the source and irror cu"es. Aou
can sti!! update 'our !oca! cop' of the cu"e@ "ut 'ou can no !onger s'nchroni=e the updates with the
source cu"e.
346 of 425 26-09-2014 11:18
1-.#.1. Creating a 2eplication Connection
To create a rep!ication connection "etween two servers@ cop!ete the fo!!owing steps.
)rocedure
Ma/e sure that the target server is visi"!e. 2.
(ou"!e7c!ic/ the 0ep!ications icon for the target server.
+or e#ap!e@ to rep!icate a cu"e fro the sdata server to the financiareporting1 server@ dou"!e7c!ic/
the 0ep!ications icon under the financiareporting1 server.
The Create *erver 0ep!ication O"<ect dia!og "o# opens.
'ote* If the server a!read' has a rep!ication connection@ 'ou ust se!ect the 0ep!ications icon@
right7c!ic/ the icon@ and c!ic/ Insert 'e 2eplication to open the Create *erver 0ep!ication dia!og
"o#.
$.
+i!! in the dia!og "o# as fo!!ows>
*e!ect the source server in the From Ser(er "o#.
*pecif' the usernae and password with which 'ou want to connect to the source server.
If the source server uses CognosF : securit' GC,M authenticationI@ enter the Cognos :
Naespace I( of the source server in the it% 'amespace "o#.
Note that 'ou ust provide the Naespace I( of the naespace@ not the descriptive nae of the
naespace.
2.
C!ic/ O;.
The s'ste connects 'ou to the specified server@ and adds the server nae under the 0ep!ications
icon for the target server.
,fter 'ou create a rep!ication connection@ 'ou can anua!!' s'nchroni=e data "etween the target
and source servers or create a chore to autoate s'nchroni=ation. +or detai!s@ see *'nchroni=ation
&rocess.
3.
)arent topic* Maintaining 0ep!ication Connections
347 of 425 26-09-2014 11:18
1-.#.#. Modifying a 2eplication Connection
Aou can change the user nae and password properties of a rep!ication connection. If 'ou change these
properties@ 'ou are !ogged in to the rep!ication server as a different user. The e#isting rep!ication
re!ationships "etween the source cu"e and the irror cu"e a' no !onger "e va!id. The privi!eges of the
new c!ient a' not "e eBuiva!ent to those of the o!d c!ient. In this case@ the s'nchroni=ation process does
not wor/.
)rocedure
,ccess the server that contains the rep!ication connection 'ou want to odif'. 2.
(ou"!e7c!ic/ the 0ep!ications icon to e#pand it. $.
0ight7c!ic/ the server whose connection 'ou want to odif'@ and c!ic/ Modify 2eplication
)arameters.
The Modif' *erver 0ep!ication O"<ect dia!og "o# opens.
2.
Ma/e the appropriate changes@ and c!ic/ O;. 3.
348 of 425 26-09-2014 11:18
1-.#.-. .eleting a 2eplication Connection
Aou can sever the re!ationship "etween the source and target servers "' de!eting a rep!ication
connection. When 'ou do this@ 'ou de!ete the re!ationship "etween the source and irror cu"es. Aou can
sti!! update 'our !oca! cop' of the cu"e@ "ut 'ou can no !onger s'nchroni=e the updates with the source
cu"e.
)rocedure
,ccess the server that contains the rep!ication connection 'ou want to de!ete. 2.
(ou"!e7c!ic/ the 0ep!ications icon to e#pand it. $.
0ight7c!ic/ the server whose connection 'ou want to de!ete and c!ic/ .elete 2eplication.
'ote* If 'ou created a chore to autoate s'nchroni=ation@ 'ou ust de!ete the chore "efore de!eting
the rep!ication. +or detai!s on autoating s'nchroni=ation@ see *'nchroni=ation &rocess.
2.
349 of 425 26-09-2014 11:18
1-.-. 2eplication )rocess
,fter 'ou create a rep!ication connection "etween two servers@ 'ou can rep!icate the cu"es fro the
source server to the target server.
TM1F a!!ows the rep!ication of contro! cu"es@ inc!uding these cu"es>
}DimensionProperties
}CubeProperties
}ConnectionProperties
In ost circustances@ 'ou shou!d not rep!icate these cu"es. If 'ou do@ "e aware that the cu"es on the
target server overwrite the cu"es on the source server when s'nchroni=ation occurs@ there"' reoving a!!
the rep!ication and s'nchroni=ation settings that were ade through the -I.
2eplicating a Cube
When rep!icating a cu"e@ the tota! !ength of the pathnae for the target TM1 server's data director'
and cu"e nae can not e#ceed the Microsoft Windows pathnae !iit of appro#iate!' 238
characters. If this !iit is e#ceeded@ due to a !ong pathnae or cu"e nae@ TM1 disp!a's the
fo!!owing error essage> Cou!d not register the cu"e.
Specifying Information about t%e 2eplicated Cube
The 0ep!icate Cu"e dia!og "o# !ets 'ou specif' the fo!!owing inforation a"out the irror cu"e 'ou
are creating>
$%at 3appens %en TM1 2eplicates a Cube
When TM1 rep!icates a cu"e@ the fo!!owing action occurs>
350 of 425 26-09-2014 11:18
1-.-.1. 2eplicating a Cube
When rep!icating a cu"e@ the tota! !ength of the pathnae for the target TM1F server's data director'
and cu"e nae can not e#ceed the Microsoft Windows pathnae !iit of appro#iate!' 238 characters. If
this !iit is e#ceeded@ due to a !ong pathnae or cu"e nae@ TM1 disp!a's the fo!!owing error essage>
Cou!d not register the cu"e.
)rocedure
(ou"!e7c!ic/ the 2eplications icon for the target server.
The tree e#pands to !ist e#isting rep!ication connections.
1.
(ou"!e7c!ic/ the rep!ication connection 'ou want to use.
The tree e#pands to !ist the cu"es that 'ou can rep!icate.
2.
0ight7c!ic/ the cu"e 'ou want to rep!icate and c!ic/ 2eplicate.
The 0ep!icate Cu"e dia!og "o# opens.
$.
+i!! in the 0ep!icate Cu"e dia!og "o# as descri"ed in *pecif'ing Inforation a"out the 0ep!icated
Cu"e.
2.
C!ic/ O;.
TM1 rep!icates the cu"e@ as descri"ed in What 1appens when TM1 0ep!icates a Cu"e.
'ote* ,fter 'ou c!ic/ O; to rep!icate a cu"e@ 'ou cannot change the specifications for this particu!ar
rep!ication. 1owever@ 'ou can create another rep!icated version of the source cu"e with different
specifications.
3.
)arent topic* 0ep!ication &rocess
351 of 425 26-09-2014 11:18
1-.-.#. Specifying Information about t%e 2eplicated Cube
The 0ep!icate Cu"e dia!og "o# !ets 'ou specif' the fo!!owing inforation a"out the irror cu"e 'ou are
creating>
Nae of the irror cu"e.
Nae of each diension in the irror cu"e.
Whether the irror cu"e uses diensions that are rep!icated fro the source server or !oca!
diensions.
Whether the diensions rep!icated fro the source server are s'nchroni=ed when the cu"es are
s'nchroni=ed.
Whether the irror cu"e uses ru!es that are rep!icated fro the source cu"e.
Whether the ru!es rep!icated fro the source server wi!! "e s'nchroni=ed when the cu"es are
s'nchroni=ed.
The 0ep!icated Cu"e dia!og "o# that disp!a's when 'ou rep!icate the dep!etion cu"e fro the inventor'
server is shown in the fo!!owing figure. The rep!ication status ight "e different@ depending on whether
'ou have a!read' rep!icated the diensions in the cu"e.
'ote* The sections that fo!!ow descri"e how to change the TM1F defau!t settings. We recoend that
'ou do not change an' defau!t settings un!ess 'ou fu!!' understand the ip!ications of doing so.
Specifying Cube Information
)' defau!t@ TM1 naes the irror cu"e with the source cu"e nae.
Specifying .imension Information
)' defau!t@ TM1 specifies that each diension in the irror cu"e wi!! "e copied fro the source
server@ and then s'nchroni=ed when the irror cu"e is s'nchroni=ed with its source.
Specifying 2ule Information
)' defau!t@ TM1 specifies that each ru!e in the irror cu"e is copied fro the source cu"e@ and then
s'nchroni=ed when the irror cu"e is s'nchroni=ed with its source.
Specifying 5ie Information
)' defau!t@ TM1 specifies that each pu"!ic view in the irror cu"e is copied fro the source cu"e@ and
then s'nchroni=ed when the irror cu"e is s'nchroni=ed with its source.
Specifying Subset Information
)' defau!t@ TM1 specifies that each pu"!ic su"set in the irror cu"e is copied fro the source cu"e@
and then s'nchroni=ed when the irror cu"e is s'nchroni=ed with its source.
352 of 425 26-09-2014 11:18
1-.-.#.1. Specifying Cube Information
)' defau!t@ TM1F naes the irror cu"e with the source cu"e nae.
)rocedure
To specif' another nae for the irror cu"e@ enter the nae in the Nae fie!d.
'ote* (o not renae a cu"e if 'ou are rep!icating ru!es in that cu"e.
1.
To rep!icate the cu"e and a!!ow !ater s'nchroni=ation@ se!ect Copy .ata and Set to Sync%roni7e. 2.
To rep!icate the cu"e "ut disa"!e !ater s'nchroni=ation@ se!ect Copy .ata but .o 'ot Set to
Sync%roni7e.
$.
)arent topic* *pecif'ing Inforation a"out the 0ep!icated Cu"e
353 of 425 26-09-2014 11:18
1-.-.#.#. Specifying .imension Information
)' defau!t@ TM1F specifies that each diension in the irror cu"e wi!! "e copied fro the source server@
and then s'nchroni=ed when the irror cu"e is s'nchroni=ed with its source.
TM1 does not change the diension naes when it copies the.
Aou can override the defau!t settings for a diension when 'ou rep!icate a cu"e.
)rocedure
To renae a diension@ s!ow!' c!ic/ the diension twice Gdo not dou"!e7c!ic/I@ and t'pe the new
nae.
CA0TIO'*
.o not rename a dimension if you are replicating rules in t%e associated cube.
1.
To direct TM1 to cop' a diension "ut not s'nchroni=e it@ se!ect the diension@ and c!ear the *et
(iension to *'nchroni=e option.
2.
To direct TM1 to use a !oca! diension instead of a rep!icated diension>
(ou"!e7c!ic/ the diension to open the *e!ect (iension for use in 0ep!icated Cu"e dia!og "o#.
*e!ect the diension 'ou want to use and c!ic/ O;.
CA0TIO'*
/y defaultD TM1 o(errites t%e local dimension it% t%e source dimension. If you do not
ant TM1 to o(errite t%e dimensionD select t%e .on&t O(errite .imension option. T%is
automatically directs TM1 to treat t%e local dimension as a stand!alone dimension.
$.
354 of 425 26-09-2014 11:18
1-.-.#.-. Specifying 2ule Information
)' defau!t@ TM1F specifies that each ru!e in the irror cu"e is copied fro the source cu"e@ and then
s'nchroni=ed when the irror cu"e is s'nchroni=ed with its source.
)rocedure
To specif' that 'ou want TM1 to cop' the ru!es "ut not s'nchroni=e the@ c!ear the *et 0u!e to
*'nchroni=e option.
1.
To specif' that 'ou do not want TM1 to cop' ru!es for the irror cu"e@ se!ect the .o 'ot Copy 2ule
option.
2.
355 of 425 26-09-2014 11:18
1-.-.#.4. Specifying 5ie Information
)' defau!t@ TM1F specifies that each pu"!ic view in the irror cu"e is copied fro the source cu"e@ and
)rocedure
To specif' that 'ou do not want TM1 to cop' views for the irror cu"e@ c!ear the 2eplicate 5ies
option.
356 of 425 26-09-2014 11:18
1-.-.#.6. Specifying Subset Information
)' defau!t@ TM1F specifies that each pu"!ic su"set in the irror cu"e is copied fro the source cu"e@ and
)rocedure
To specif' that 'ou do not want TM1 to cop' su"sets for the irror cu"e@ c!ear the 2eplicate Subsets
option.
357 of 425 26-09-2014 11:18
1-.-.-. $%at 3appens %en TM1 2eplicates a Cube
When TM1F rep!icates a cu"e@ the fo!!owing action occurs>
Optiona!!'@ TM1 rep!icates the cu"e diensions. When 'ou initiate the rep!ication process@ 'ou decide
which diensions 'ou want to rep!icate@ and of those@ which diensions 'ou want to s'nchroni=e
when 'ou s'nchroni=e the cu"es. Aou can a!so choose to use one or ore !oca! diensions with a
rep!icated cu"e.
Optiona!!'@ TM1 rep!icates the cu"e ru!es. When 'ou initiate the rep!ication process@ 'ou decide which
ru!es 'ou want to rep!icate@ and of those@ which ru!es 'ou want to s'nchroni=e when 'ou s'nchroni=e
the cu"es.
0epresents the cu"e as an icon under the Cu"es icon on the target server.
Naes the source server in the 0ep!ication *erver fie!d on the attri"utes "ar for each rep!icated cu"e.
Naes the source server in the 0ep!ication *erver fie!d on the attri"utes "ar for each rep!icated
diension.
358 of 425 26-09-2014 11:18
1-.4. Sync%roni7ation )rocess
Aou a!wa's initiate the s'nchroni=ation process fro the target server@ which is the server that contains
the irror cu"es. Aou ust have adinistrator authorit' for this server to initiate the s'nchroni=ation
process.
Aou can s'nchroni=e on deand or schedu!e the s'nchroni=ation process to "e autoatic.
TM1F updates the data in a!! the irror cu"es that are part of the sae rep!ication connection.
Aou cannot specif' individua! cu"es to update.
TM1 a!so updates the rep!icated diensions if 'ou ade changes to their definitions and ru!es.
TM1 a!wa's writes updates fro the source cu"es to the irror cu"es.
TM1 does the fo!!owing with updates 'ou a/e to the irror cu"e>
Writes the updates "ac/ to the source cu"e@ if the updates were ade "' users with 0eserve
access to the source cu"e.
(oes not write the updates "ac/ to the source cu"e@ if the updates were ade "' users with 0ead
or Write access to the source cu"e.
TM1 uses the transaction !og fi!es to /eep trac/ of the changes ade to the source and irror
cu"es. (uring the s'nchroni=ation process@ TM1 uses the !og fi!es to deterine which updates to
a/e.
If 'ou are perforing a s'nchroni=ation process@ transaction !ogging ust "e ena"!ed for the
irror cu"es on the target server that are part of the rep!ication and s'nchroni=ation process.
If 'ou are perforing a "i7directiona! s'nchroni=ation@ transaction !ogging ust "e ena"!ed for a!!
the re!ated cu"es on "oth the source and target servers.
To verif' that transaction !ogging is ena"!ed@ see .na"!ing and (isa"!ing Transaction 6ogging in the
I)MF CognosF TM1 Operation Guide.
If there is an update conf!ict for a particu!ar ce!!@ TM1 uses the ost recent update@ no atter where
this update was ade Gthat is@ in the source cu"e or the irror cu"eI.
Sync%roni7ing on .emand
To s'nchroni=e updates on deand@ cop!ete the fo!!owing steps.
Sc%eduling Sync%roni7ation
Aou can create a chore to autoatica!!' s'nchroni=e data at a regu!ar interva! using Tur"oIntegrator.
Sync%roni7ing o(er 0nstable or $ide Area 'etor" Connections
Aou can use the Ma#iu*'nch,ttepts and *'nc-nit*i=e paraeters to iprove the sta"i!it' of a
s'nchroni=ation process that is running over an unsta"!e networ/ connection such as a !ong distance
wide area networ/ GW,NI with high !atenc'@ poor "andwidth and poor transission Bua!it'.
359 of 425 26-09-2014 11:18
1-.4.1. Sync%roni7ing on .emand
To s'nchroni=e updates on deand@ cop!ete the fo!!owing steps.
)rocedure
In the *erver .#p!orer@ access the server that contains the irror cu"es. 1.
(ou"!e7c!ic/ the 0ep!ications icon. 2.
0ight7c!ic/ the icon for the rep!ication connection for whose cu"es 'ou want to s'nchroni=e@ and c!ic/
Sync%roni7e All .ata.
$.
)arent topic* *'nchroni=ation &rocess
360 of 425 26-09-2014 11:18
1-.4.#. Sc%eduling Sync%roni7ation
Aou can create a chore to autoatica!!' s'nchroni=e data at a regu!ar interva! using Tur"oIntegrator.
+or detai!s on Tur"oIntegrator@ see the I)MF CognosF TM1F TuroIntegrator Guide.
)rocedure
In the *erver .#p!orer@ se!ect the C%ores icon "eneath the target server for which 'ou want to
autoate s'nchroni=ation.
1.
0ight7c!ic/ the C%ores icon and c!ic/ Create 'e C%ore.
The Chore *etup Wi=ard opens.
2.
*e!ect the rep!ication for which 'ou want to autoate s'nchroni=ation. $.
C!ic/ the arrow "utton to ove the rep!ication fro the ,vai!a"!e !ist to the *e!ected 6ist. 2.
C!ic/ 'e+t.
The second screen of the C%ore Setup $i7ard disp!a's.
3.
-se the ca!endar and Tie fie!d to set a start date and tie for the initia! s'nchroni=ation. 8.
-se the fie!ds in the Chore .#ecution +reBuenc' "o# to set the interva! at which the s'nchroni=ation
shou!d "e e#ecuted.
9.
C!ic/ Finis% to cop!ete the schedu!ing. :.
361 of 425 26-09-2014 11:18
1-.4.-. Sync%roni7ing o(er 0nstable or $ide Area 'etor"
Connections
Aou can use the Ma#iu*'nch,ttepts and *'nc-nit*i=e paraeters to iprove the sta"i!it' of a
s'nchroni=ation process that is running over an unsta"!e networ/ connection such as a !ong distance wide
area networ/ GW,NI with high !atenc'@ poor "andwidth and poor transission Bua!it'.
+or ore detai!s@ see the Ma#iu*'nch,ttepts and *'nc-nit*i=e paraeters in the IBM. Cognos.
TM1. Installation and Configuration Guide.
362 of 425 26-09-2014 11:18
14. Accessibility features
,ccessi"i!it' features he!p users who have a ph'sica! disa"i!it'@ such as restricted o"i!it' or !iited
vision@ to use inforation techno!og' products.
;eyboard s%ortcuts
*tandard Microsoft Windows navigation /e's are used in addition to app!ication7specific /e's.
I/M and accessibility
*ee the I)MF ,ccessi"i!it' Center for ore inforation a"out the coitent that I)M has to
accessi"i!it'.
363 of 425 26-09-2014 11:18
14.1. ;eyboard s%ortcuts
*tandard Microsoft Windows navigation /e's are used in addition to app!ication7specific /e's.
Aou can use /e'"oard shortcuts to navigate through the app!ication and perfor tas/s. If 'ou are using a
screen reader@ 'ou ight want to a#ii=e 'our window so the /e'"oard shortcut ta"!e is cop!ete!'
e#panded and accessi"!e.
Note> The fo!!owing /e'"oard shortcuts are "ased on -* standard /e'"oards.
Ta"!e 1. Ce'"oard shortcuts
Action S%ortcut "ey
&erfor the coand for an active coand "utton .nter
C!ose an o"<ect or pane that is c!osa"!e Ctr!Q+2
Go to the first ite or o"<ectN Go 1oe 1oe
Go to the !ast ite or o"<ectN Go to the .nd .nd
Move forward through the panes of the app!ication +8
Move "ac/ward through the panes of the app!ication *hiftQ+8
Move the focus to the ,pp!ication )ar G"!ue dotI +10
Move to the ne#t ite in the ta" inde# order at the sae !eve!N c'c!e to the first ta"
inde# when 'ou are at the end
Ta"
Move to the previous ite in the ta" inde# order at the sae !eve!N c'c!e to the !ast
ta" inde# when 'ou are at the "eginning
*hiftQTa"
Togg!e on or off *pace "ar
Move to the ne#t option "utton and se!ect it 0ight arrow@ (own
arrow
Move to the previous option "utton and se!ect it -p arrow@ 6eft
arrow
Open and disp!a' the contents of a drop7down !ist (own arrow
C!ose an open drop7down !ist .sc
Move to the ne#t se!ecta"!e node after the current node. If the node that 'ou se!ect
has chi!dren nodes and is e#panded@ go to the first chi!d node
(own arrow
Move to the previous se!ecta"!e node -p arrow
.#pand the current se!ection if it is not e#panded. If the node is e#panded@ go to
the first chi!d node
0ight arrow and
p!us sign
Co!!apse the current se!ection if it is e#panded. If the node is co!!apsed@ go to the
parent node "efore the current se!ection
6eft arrow and
inus sign
.#pand the chi!dren enu ites 0ight arrow
Co!!apse the chi!dren enu ites 6eft arrow
Open a conte#t enu 0ight7c!ic/ /e'
C!ose an open conte#t enu .sc
*cro!! down (own arrow or
&age (own
364 of 425 26-09-2014 11:18
Action S%ortcut "ey
*cro!! up -p arrow or &age
-p
Move to the ne#t widget in the ta" inde# order at the sae !eve! in the canvas Ta"
Move to the previous widget in the ta" inde# order at the sae !eve! in the canvas *hiftQTa"
,dd a data"ase instance ,!tQN
-p!oad a configuration fi!e ,!tQ-
(own!oad a configuration fi!e ,!tQ*
Ti!e vertica!!' ,!tQ?
Ti!e hori=onta!!' ,!tQW
)o# ti!e ,!tQ.
0efresh the tree ,!tQ0
)arent topic* ,ccessi"i!it' features
365 of 425 26-09-2014 11:18
14.#. I/M and accessibility
*ee the I)MF ,ccessi"i!it' Center for ore inforation a"out the coitent that I)M has to
accessi"i!it'.
I)M ,ccessi"i!it' CenterGwww.i".coHa"!eI
)arent topic* ,ccessi"i!it' features
366 of 425 26-09-2014 11:18
16. Control Cubes
I)MF CognosF TM1F uses contro! cu"es.
The I)M Cognos TM1 server autoatica!!' generates the contro! cu"es. )' defau!t@ !ogging is ena"!ed for
a!! contro! cu"es.
The fo!!owing inforation is provided for each contro! cu"e>
&urpose
(iensions that for the cu"e
'ote* +or a cop!ete description of the contro! diensions@ see Contro! (iensions.
To togg!e the disp!a' of contro! cu"es and other contro! o"<ects in *erver .#p!orer@ c!ic/ 5ie@ .isplay
Control Ob8ects. ,!! contro! cu"es appear in *erver .#p!orer with a prefi# of a right cur!' "race G DI. +or
e#ap!e@ DCe!!*ecurit'%*a!esCu"e.
Security Control Cubes
*ecurit' contro! cu"es app!' securit' privi!eges for TM1 o"<ects to user groups on the TM1 server .
Client and Group Administration Control Cubes
The c!ient and group adinistration contro! cu"es assign c!ients to user groups and store properties
for a!! c!ients on the TM1 server .
Ob8ect Attribute and )roperty Control Cubes
The o"<ect attri"ute and propert' contro! cu"es store attri"ute and propert' va!ues for o"<ects on the
TM1 server .
)erformance Monitoring Control Cubes
TM1 inc!udes a perforance onitoring feature that !ets 'ou record perforance statistics for c!ients@
cu"es@ and servers.
Ot%er Control Cubes
The fo!!owing sections descri"e a!! other contro! cu"es avai!a"!e on the TM1 server .
367 of 425 26-09-2014 11:18
16.1. Security Control Cubes
*ecurit' contro! cu"es app!' securit' privi!eges for TM1F o"<ects to user groups on the TM1 server .
Most of these contro! cu"es are popu!ated with the privi!eges assigned in the TM1 *ecurit' ,ssignents
window@ "ut 'ou can a!so app!' privi!eges direct!' in the contro! cu"es. 1owever@ 'ou cannot app!'
privi!eges to the ,(MIN groupN this group a!wa's has ,(MIN privi!eges to a!! o"<ects on the TM1 server .
HCellSecurity,Cube'ame
TM1 creates an ept' DCe!!*ecurit'%Cu"eNae contro! cu"e when 'ou initiate the process of
defining the ce!!7!eve! securit'.
HC%oreSecurity
The DChore*ecurit' contro! cu"e stores securit' privi!eges for a!! chores on the TM1 server.
HClientSecurity
The DC!ient*ecurit' contro! cu"e defines user group access to properties for individua! c!ients on the
TM1 server .
HCubeSecurity
The DCu"e*ecurit' contro! cu"e stores securit' privi!eges for a!! cu"es@ inc!uding other contro! cu"es
on the TM1 server .
H.imensionSecurity
The D(iension*ecurit' contro! cu"e stores securit' definitions for a!! diensions@ inc!uding contro!
diensions on the TM1 server .
H1lementSecurity,.imension'ame
The D.!eent*ecurit'%(iensionNae contro! cu"e stores securit' definitions for a!! the e!eents in
the (iensionNae diension.
H)rocessSecurity
The D&rocess*ecurit' contro! cu"e stores securit' definitions for a!! Tur"oIntegrator processes on the
TM1 server .
)arent topic* Contro! Cu"es
368 of 425 26-09-2014 11:18
HCellSecurity,Cube'ame
13.1.1. TM1F creates an ept' DCe!!*ecurit'%Cu"eNae contro! cu"e when 'ou initiate the process of
defining the ce!!7!eve! securit'.
To do so@ se!ect a cu"e in *erver .#p!orer@ and c!ic/ Security@ Create Cell Security Cube. Aou can use
the contro! cu"e to define the ce!!7!eve! securit' for the se!ected cu"e. TM1 app!ies the ce!!7!eve! securit'
to the user groups.
The ce!!s in a DCe!!*ecurit'%Cu"eNae contro! cu"e can contain one of the fo!!owing three strings@ which
correspond to the securit' privi!eges that 'ou can assign to the ce!!s>
0ead
Write
None
+or detai!s on defining the ce!!7!eve! securit' and for definitions of the securit' privi!eges@ see the I)MF
CognosF TM1 Developer Guide-
.imensions
, DCe!!*ecurit'%Cu"eNae cu"e contains a!! the diensions that are present in the cu"e for which 'ou
want to define the ce!!7!eve! securit'. In addition@ a DCe!!*ecurit'%Cu"eNae cu"e contains the fo!!owing
diension>
.imension 1lements
DGroups .ach user group defined for the TM1 server.
+or e#ap!e@ if 'ou create a ce!! securit' contro! cu"e for *a!esCu"e in the TM1 sap!e data@ the resu!ting
DCe!!*ecurit'%*a!esCu"e cu"e contains a!! the diensions of *a!esCu"e Gactvs"ud@ region@ ode!@
account1@ and onthI@ and the DGroups diension.
)arent topic* *ecurit' Contro! Cu"es
369 of 425 26-09-2014 11:18
HC%oreSecurity
13.1.2. The DChore*ecurit' contro! cu"e stores securit' privi!eges for a!! chores on the TM1F server.
This contro! cu"e is popu!ated with the va!ues app!ied in the TM1 *ecurit' ,ssignents window@ which
'ou can access "' c!ic/ing C%ores@ Security Assignments in *erver .#p!orer.
Aou can a!so enter securit' privi!eges direct!' in the DChore*ecurit' cu"e.
The ce!!s in the DChore*ecurit' cu"e can contain the string 0ead@ which assigns the 0ead securit'
privi!ege. The ce!!s can a!so "e !eft ept'@ which assigns the None securit' privi!ege.
+or detai!s on using the TM1 user interface to define chore securit' and for definitions of securit'
privi!eges@ see the I)MF CognosF TM1 Developer Guide.
.imensions
The DChore*ecurit' contro! cu"e contains the fo!!owing diensions>
.imension 1lements
DChores .ach chore current!' defined on the TM1 server .
DGroups .ach user group defined for the TM1 server .
370 of 425 26-09-2014 11:18
HClientSecurity
13.1.$. The DC!ient*ecurit' contro! cu"e defines user group access to properties for individua! c!ients on
the TM1F server .
+or e#ap!e@ in the standard *(ata sap!e data"ase that is inc!uded with the TM1 server @ the ,(MIN
group has ,(MIN access to properties for a!! c!ients on the server. The North ,erica and *outh ,erica
groups have 0.,( access to properties for a!! c!ients on the server.
+or e#ap!e@ in the standard *(ata sap!e data"ase that is inc!uded with the TM1 server @ the ,(MIN
and (ata,din groups have ,(MIN access to properties for a!! c!ients on the server. The *ecurit',din
group has 0.,( access to properties for a!! c!ients on the server@ and the North ,erica and *outh
,erica groups have NON. access to properties.
The access privi!eges defined in the DC!ient*ecurit' cu"e are iportant "ecause severa! ,&I functions
reBuire specific privi!eges to read andHor set c!ient properties. +or instance@ the TM1C!ient&assword,ssign
function can "e used on!' "' c!ients who are e"ers of a group with ,(MIN access to properties@ for
the c!ient to who a password is assigned. *ii!ar!'@ the TM1O"<ect&ropert'Get function reBuires 0.,(
access to c!ient properties@ whi!e TM1O"<ect&ropert'*et reBuires W0IT. access.
TM1 does not popu!ate this cu"e through the -I@ nor is access assigned when 'ou create a new user or
new group. Aou ust assign access privi!eges direct!' in the DC!ient*ecurit' cu"e.
371 of 425 26-09-2014 11:18
HCubeSecurity
13.1.2. The DCu"e*ecurit' contro! cu"e stores securit' privi!eges for a!! cu"es@ inc!uding other contro!
cu"es on the TM1F server .
'ou can access "' c!ic/ing Cubes@ Security Assignments in *erver .#p!orer.
Aou can a!so enter securit' definitions direct!' in the DCu"e*ecurit' cu"e.
The ce!!s in the DCu"e*ecurit' contro! cu"e can contain one of the fo!!owing five strings@ which
correspond to the securit' privi!eges that 'ou can assign to cu"es>
0ead
Write
0eserve
,din
6oc/
The cu"e does not accept the string None. To assign the None privi!ege to a cu"e@ !eave the appropriate
ce!! in the DCu"e*ecurit' cu"e ept'.
+or detai!s on defining cu"e securit' through the TM1 user interface and for definitions of securit'
privi!eges@ see the I)MF CognosF TM1 Developer Guide-
.imensions
The DCu"e*ecurit' contro! cu"e contains the fo!!owing diensions>
.imension 1lements
DCu"es Cu"es avai!a"!e on the TM1 server .
DGroups Groups defined for the TM1 server .
372 of 425 26-09-2014 11:18
H.imensionSecurity
13.1.3. The D(iension*ecurit' contro! cu"e stores securit' definitions for a!! diensions@ inc!uding
contro! diensions on the TM1F server .
'ou can access "' c!ic/ing .imensions@ Security Assignments in *erver .#p!orer.
Aou can a!so enter securit' definitions direct!' in the D(iension*ecurit' cu"e.
The ce!!s in the D(iension*ecurit' contro! cu"e can contain one of the fo!!owing five strings@ which
correspond to the securit' privi!eges that 'ou can assign to diensions>
0ead
Write
0eserve
,din
6oc/
The cu"e does not accept the string None. To assign the None privi!ege to a diension@ !eave the
appropriate ce!! in the D(iension*ecurit' cu"e ept'.
+or detai!s on defining diension securit' through the TM1 user interface and for definitions of securit'
privi!eges@ see the I)MF CognosF TM1 Developer Guide.
.imensions
The D(iension*ecurit' contro! cu"e contains the fo!!owing diensions>
.imension 1lements
D(iensions (iensions avai!a"!e on the TM1 server .
373 of 425 26-09-2014 11:18
H1lementSecurity,.imension'ame
13.1.8. The D.!eent*ecurit'%(iensionNae contro! cu"e stores securit' definitions for a!! the
e!eents in the (iensionNae diension.
, uniBue D.!eent*ecurit'%(iensionNae cu"e e#ists for each diension for which 'ou have defined
e!eent securit'.
This contro! cu"e is popu!ated with the va!ues app!ied in the TM1F *ecurit' ,ssignents window@ which
'ou can access "' se!ecting a diension and c!ic/ing .imension@Security@ 1lements Security
Assignments in *erver .#p!orer.
Aou can a!so enter securit' definitions direct!' in an D.!eent*ecurit'%(iensionNae cu"e.
The ce!!s in this contro! cu"e can contain one of the fo!!owing five strings@ which correspond to the
securit' privi!eges that 'ou can assign to diensions>
0ead
Write
0eserve
,din
6oc/
The cu"e does not accept the string None. To assign the None privi!ege to an e!eent@ !eave the
appropriate ce!! in the contro! cu"e ept'.
+or detai!s on defining e!eent securit' through the TM1 user interface and for definitions of securit'
privi!eges@ see the I)MF CognosF TM1 Developer Guide-
.imensions
,n D.!eent*ecurit'%(iensionNae cu"e contains the fo!!owing diensions>
.imension 1lements
(iensionNae ,!! e!eents of the diension are present.
374 of 425 26-09-2014 11:18
H)rocessSecurity
13.1.9. The D&rocess*ecurit' contro! cu"e stores securit' definitions for a!! Tur"oIntegrator processes on
the TM1F server .
.imensions
The D&rocess*ecurit' cu"e contains the fo!!owing diensions>
.imension 1lements
D&rocesses ,!! processes defined on the TM1 server .
375 of 425 26-09-2014 11:18
16.#. Client and Group Administration Control Cubes
The c!ient and group adinistration contro! cu"es assign c!ients to user groups and store properties for a!!
c!ients on the TM1F server .
HClientsGroups
The DC!ientsGroups cu"e stores group assignents for a!! c!ients on the TM1 server .
HClient)roperties
The DC!ient&roperties contro! cu"e stores propert' va!ues for a!! c!ients on the TM1 server .
376 of 425 26-09-2014 11:18
HClientsGroups
13.2.1. The DC!ientsGroups cu"e stores group assignents for a!! c!ients on the TM1F server .
This contro! cu"e is popu!ated with va!ues that ref!ect the assignents app!ied in the C!ientsHGroups
window@ which 'ou can access "' c!ic/ing Ser(er@ Security@ Clients=Groups in *erver .#p!orer. Aou can
a!so enter va!ues direct!' in the DC!ientsGroups cu"e.
+or detai!s on assigning c!ients to user groups@ see the IBM. Cognos. TM1 Developer Guide.
The ce!!s in the DC!ientsGroups cu"e contain strings that assign c!ients to one or ore of the user groups
avai!a"!e on the TM1 server .
In this e#ap!e>
,din c!ient is assigned to the ,(MIN group
-sr1 c!ient is assigned to the North ,erica group
-sr2 c!ient is assigned to the *outh ,erica group
-sr$ c!ient is assigned to "oth the North ,erica and *outh ,erica groups
.imensions
The DC!ientsGroups contro! cu"e contains the fo!!owing diensions>
.imension 1lements
DC!ients C!ients current!' defined for the TM1 server .
)arent topic* C!ient and Group ,dinistration Contro! Cu"es
377 of 425 26-09-2014 11:18
HClient)roperties
13.2.2. The DC!ient&roperties contro! cu"e stores propert' va!ues for a!! c!ients on the TM1F server .
Aou can use c!ient properties to define a c!ient password@ the a#iu nu"er of connections a!!owed@
c!ient status@ and ore.
The DC!ient&roperties cu"e is popu!ated with va!ues that ref!ect the settings in the C!ientsHGroups
window@ which 'ou can access "' c!ic/ing Ser(er@ Security@ Clients=Groups fro *erver .#p!orer.
, Ma#iu&orts va!ue of 0 for a c!ient in the DC!ient&roperties cu"e indicates that a a#iu port !iit
is not defined for the c!ient.
Aou can enter or edit va!ues for Ma#iu&orts and &assword.#piration(a's direct!' in the
DC!ient&roperties cu"e.
'ote* Aou shou!d not edit va!ues for &,**WO0( direct!' in the cu"e. The passwords are stored in the
cu"e in an encr'pted foratN if 'ou edit passwords direct!' in the cu"e@ the passwords are unusa"!e and
prevent c!ients fro !ogging on to the TM1 server .
.imensions
The DC!ient&roperties cu"e contains the fo!!owing diensions>
.imension 1lements
DC!ients C!ients current!' defined for the TM1 server .
DC!ient&roperties &roperties that can "e set for TM1 c!ients@ inc!uding &assword@
&assword.#piration(a's@ and Ma#iu&orts.
+or cop!ete detai!s on this diension@ see Contro! (iensions.
)arent topic* C!ient and Group ,dinistration Contro! Cu"es
378 of 425 26-09-2014 11:18
16.-. Ob8ect Attribute and )roperty Control Cubes
The o"<ect attri"ute and propert' contro! cu"es store attri"ute and propert' va!ues for o"<ects on the
TM1F server .
HConnection)roperties
The DConnection&roperties contro! cu"e stores propert' va!ues for a!! rep!ication connections on the
TM1 server .
HCube)roperties
The DCu"e&roperties contro! cu"e stores propert' va!ues for a!! cu"es@ "oth native and rep!icated@ on
the TM1 server .
H.imension)roperties
The D(iension&roperties contro! cu"e stores propert' va!ues for a!! diensions@ "oth native and
rep!icated@ on the TM1 server .
H.imensionAttributes
The D(iension,ttri"utes contro! cu"e stores attri"ute va!ues for a!! diensions@ "oth native and
rep!icated@ on the TM1 server .
H1lementAttributes,.imension'ame
The D.!eent,ttri"utes%(iensionNae contro! cu"e stores e!eent attri"ute va!ues for the
(iensionNae diension.
H3ierarc%y)roperties
The D1ierarch'&roperties contro! cu"e stores custo naed !eve!s for the hierarch' !eve!s of TM1
diensions.
379 of 425 26-09-2014 11:18
13.$.1. The DConnection&roperties contro! cu"e stores propert' va!ues for a!! rep!ication connections on
the TM1F server .
The rep!ication connection properties define the c!ient and password to esta"!ish a rep!ication connection@
and the s'nchroni=ation status for the star and p!anet servers.
.imensions
The DConnection&roperties cu"e contains the fo!!owing diensions>
.imension 1lements
DConnections 0ep!ication connections defined for the TM1 server .
DConnection&roperties &roperties that can "e set for rep!ication connections@ inc!uding -ser@
&assword@ *'ncstar and *'ncp!anet.
)arent topic* O"<ect ,ttri"ute and &ropert' Contro! Cu"es
380 of 425 26-09-2014 11:18
HCube)roperties
13.$.2. The DCu"e&roperties contro! cu"e stores propert' va!ues for a!! cu"es@ "oth native and rep!icated@
on the TM1F server .
This contro! cu"e is popu!ated with va!ues that ref!ect the settings in the Cu"e &roperties dia!og "o#@
which 'ou can access "' se!ecting a cu"e and c!ic/ing Cube@ )roperties in *erver .#p!orer.
With rep!icated cu"es@ the DCu"e&roperties cu"e is popu!ated with va!ues that ref!ect the settings in the
0ep!icate Cu"e dia!og "o#@ which 'ou can access "' se!ecting a cu"e under a rep!ication connection and
c!ic/ing Cube@ 2eplicate fro *erver .#p!orer.
The DCu"e&roperties contro! cu"e a!so stores severa! properties that can on!' "e set direct!' in the
contro! cu"e@ such as 4MM and 4MT.
The cu"e properties define how a cu"e is !oaded on the TM1 server @ which diension to use as a
easures diension@ which diension to use as a tie diension@ and whether cu"e !ogging is ena"!ed.
With rep!icated cu"es@ the va!ues in the DCu"e&roperties cu"e a!so define the source cu"e for a
rep!ication@ the rep!ication status of a cu"e@ and whether ru!es and views shou!d "e s'nchroni=ed.
.imensions
The DCu"e&roperties cu"e contains the fo!!owing diensions>
.imension 1lements
DCu"es Cu"es avai!a"!e on the TM1 server .
DCu"e&roperties &roperties that can "e set for cu"es.
381 of 425 26-09-2014 11:18
13.$.$. The D(iension&roperties contro! cu"e stores propert' va!ues for a!! diensions@ "oth native and
rep!icated@ on the TM1F server .
This contro! cu"e is popu!ated with va!ues that ref!ect the settings in the (iension.!eentOrdering
dia!og "o#@ which 'ou can access "' se!ecting a diension and c!ic/ing .imension@ Set 1lements
Order fro *erver .#p!orer.
With rep!icated cu"es@ the D(iension&roperties cu"e is a!so popu!ated with va!ues that ref!ect the
settings in the 0ep!icate Cu"e dia!og "o#@ which 'ou can access "' se!ecting a cu"e under a rep!ication
connection and c!ic/ing Cube@ 2eplicate in *erver .#p!orer.
The diension properties define how a diension is !oaded and sorted on the TM1 server . With
rep!icated diensions@ the va!ues in the D(iension&roperties cu"e a!so define the source diension for
a rep!icated diension@ the rep!ication status of a diension@ and whether su"sets and attri"utes shou!d
"e s'nchroni=ed.
.imensions
The D(iension&roperties cu"e contains the fo!!owing diensions>
.imension 1lements
D(iension&roperties &roperties that can "e set for diensions.
382 of 425 26-09-2014 11:18
13.$.2. The D(iension,ttri"utes contro! cu"e stores attri"ute va!ues for a!! diensions@ "oth native and
rep!icated@ on the TM1F server .
This contro! cu"e cu"e is popu!ated with va!ues that ref!ect the settings in the ,ttri"utes .ditor window@
which 'ou can access "' se!ecting a (iensions group and c!ic/ing .imensions@ 1dit Attributes fro
*erver .#p!orer. Aou can a!so enter attri"ute va!ues direct!' in the D(iension,ttri"utes cu"e.
.imensions
The D(iension,ttri"utes cu"e contains the fo!!owing diensions>
.imension 1lements
D(iension,ttri"utes ,ttri"utes that have "een defined for diensions on the TM1 server .
383 of 425 26-09-2014 11:18
13.$.3. The D.!eent,ttri"utes%(iensionNae contro! cu"e stores e!eent attri"ute va!ues for the
(iensionNae diension.
, uniBue D.!eent,ttri"utes%(iensionNae cu"e e#ists for each diension for which 'ou have defined
e!eent attri"utes.
,n D.!eent,ttri"utes%(iensionNae cu"e is popu!ated with va!ues that ref!ect the settings in the
,ttri"utes .ditor window@ which 'ou can access "' se!ecting a diension and c!ic/ing .imension@ 1dit
1lement Attributes in *erver .#p!orer. Aou can a!so enter e!eent attri"ute va!ues direct!' in an
D.!eent,ttri"utes%(iensionNae cu"e.
.imensions
,n D.!eent,ttri"utes%(iensionNae cu"e contains the fo!!owing diensions>
.imension 1lements
(iensionNae ,!! e!eents of the diension are present.
D.!eent,ttri"utes%(iensionNae .!eent attri"utes defined for the (iensionNae
diension.
+or detai!s on defining e!eent attri"utes@ see the
I)MF CognosF TM1F Developer Guide.
384 of 425 26-09-2014 11:18
13.$.8. The D1ierarch'&roperties contro! cu"e stores custo naed !eve!s for the hierarch' !eve!s of
TM1F diensions.
Aou can enter 'our own naes for these !eve!s in the D1ierarch'&roperties contro! cu"e and then use
these naes outside of TM1 to access TM1 data with I)MF CognosF 0eport *tudio@ M(5 stateents or
other M(5 O6,& too!s. Aou can a!so use this contro! cu"e to assign a defau!t e"er for the diension.
+or detai!s on using naed !eve!s with diensions@ see the re!ated section in the I)M Cognos TM1
Developer Guide.
.imensions
The D1ierarch'&roperties cu"e contains the fo!!owing diensions>
.imension 1lements
D(iensions Contains a !ist of a!! the diension naes in the TM1 server .
D1ierarchies Inc!udes on!' one e!eent for assigning naed !eve!s to the se!ected
diension.
D1ierarch'&roperties Inc!udes the fo!!owing two t'pes of e!eents
, sing!e e!eent@ naed defaultMember@ for assigning the defau!t
e"er of the diension.
, set of 21 e!eents Glevel000 7 level020I for assigning naes to
the diension hierarch' !eve!s.
+or ore detai!s@ see D1ierarch'&roperties.
385 of 425 26-09-2014 11:18
16.4. )erformance Monitoring Control Cubes
TM1F inc!udes a perforance onitoring feature that !ets 'ou record perforance statistics for c!ients@
cu"es@ and servers.
When 'ou ena"!e perforance onitoring@ TM1 popu!ates the perforance onitoring contro! cu"es on a
inute7"'7inute "asis. Aou can then "rowse these cu"es to ana!'=e server perforance.
&erforance onitoring is ena"!ed on a per7server "asis. To ena"!e perforance onitoring for a server@
se!ect the server in *erver .#p!orer and c!ic/ Ser(er@ Start )erformance Monitor. +or detai!s on
perforance onitoring@ see 0eote Cognos TM1 *erver Operations.
HStats/yClient
+or each c!ient on the server@ the D*tats)'C!ient contro! cu"e trac/s the essage count@ average
essage si=e@ tota! e!apsed tie@ and other easures.
HStats/yCube
+or each cu"e on the server@ theD*tats)'Cu"e contro! cu"e trac/s eor' use@ the nu"er of
popu!ated string ce!!s@ popu!ated nueric ce!!s@ stored ca!cu!ated ce!!s@ fed ce!!s@ and stored views.
HStats/yCube/yClient
+or each c!ient and cu"e on the server@ the D*tats)'Cu"e)'C!ient contro! cu"e trac/s the nu"er and
e!apsed tie of ce!! updates@ ce!! retrieva!s@ view ca!cu!ations@ and view retrieva!s.
HStatsForSer(er
The D*tats+or*erver contro! cu"e trac/s the connected c!ients@ active threads@ and eor' used for
the server.
386 of 425 26-09-2014 11:18
HStats/yClient
13.2.1. +or each c!ient on the server@ the D*tats)'C!ient contro! cu"e trac/s the essage count@ average
essage si=e@ tota! e!apsed tie@ and other easures.
.imensions
The D*tats)'C!ient cu"e contains the fo!!owing diensions>
.imension 1lements
D*tats*tats)'C!ient This diension contains the fo!!owing easures>
Message Count
Message )'tes
0eBuest Count
.!apse Tie
)'tesHMessage
Measures are descri"ed in Contro! (iensions.
D&erfC!ients .ach c!ient on the server@ p!us the conso!idated e!eent C!ients Tota!@
which is a conso!idation of a!! c!ients.
DTieInterva!s *ee a description of the DTieInterva!s diension in Contro! (iensions.
)arent topic* &erforance Monitoring Contro! Cu"es
387 of 425 26-09-2014 11:18
HStats/yCube
13.2.2. +or each cu"e on the server@ theD*tats)'Cu"e contro! cu"e trac/s eor' use@ the nu"er of
popu!ated string ce!!s@ popu!ated nueric ce!!s@ stored ca!cu!ated ce!!s@ fed ce!!s@ and stored views.
.imensions
The D*tats)'Cu"e cu"e contains the fo!!owing diensions>
.imension 1lements
D*tats*tats)'Cu"e This diension contains the fo!!owing easures>
Meor' -sed for 4iews> Counts views which have "een opened.
Counts a!! views@ whether private or pu"!ic@ regard!ess of user.
It is NOT dependent on who happens to "e !ogged in.
Nu"er of *tored 4iews> Counts a!! views which have "een opened@
whether private or pu"!ic@ regard!ess of user. Inc!udes a!! views which
have "een !oo/ed at.
Nu"er of *tored Ca!cu!ated Ce!!s
Nu"er of &opu!ated *tring Ce!!s
Nu"er of &opu!ated Nueric Ce!!s
Nu"er of +ed Ce!!s
Meor' -sed for Ca!cu!ations
Meor' -sed for +eeders
Meor' -sed for Input (ata
Tota! Meor' -sed
D&erfCu"es This diension contains nueric e!eents for each cu"e on the server@
p!us the conso!idated e!eent Cu"es Tota!@ which is a conso!idation of
a!! c!ients.
DTieInterva!s *ee a description of the DTieInterva!s diension in Contro!
(iensions.
388 of 425 26-09-2014 11:18
HStats/yCube/yClient
13.2.$. +or each c!ient and cu"e on the server@ the D*tats)'Cu"e)'C!ient contro! cu"e trac/s the nu"er
and e!apsed tie of ce!! updates@ ce!! retrieva!s@ view ca!cu!ations@ and view retrieva!s.
Ce!! updates do not wor/ when setting ce!!s in a view via ,rchitect.
.imensions
The D*tats)'Cu"e)'C!ient cu"e contains the fo!!owing diensions>
.imension 1lements
D&erfC!ients .ach c!ient on the server@ p!us the conso!idated e!eent C!ients Tota!@
which is a conso!idation of a!! c!ients.
D&erfCu"es .ach cu"e on the server@ p!us the conso!idated e!eent Cu"es Tota!@
which is a conso!idation of a!! cu"es.
DCu"e+unctions This diension contains the fo!!owing nueric e!eents>
Ce!! -pdate
Ce!! 0etrieva!
4iew Ca!cu!ation
4iew 0etrieva!
D*tats*tats)'Cu"e)'C!ient This diension contains the fo!!owing easures>
Count
.!apse Tie Gi!!isecondsI
389 of 425 26-09-2014 11:18
HStatsForSer(er
13.2.2. The D*tats+or*erver contro! cu"e trac/s the connected c!ients@ active threads@ and eor' used
for the server.
.imensions
The D*tats+or*erver cu"e contains the fo!!owing diensions>
.imension 1lements
D*tats*tats+or*erver This diension contains the fo!!owing easures>
Nu"er of Connected C!ients
Nu"er of ,ctive Threads
Meor' -sed G"'tesI
Meor' in Gar"age G"'tesI
390 of 425 26-09-2014 11:18
16.6. Ot%er Control Cubes
The fo!!owing sections descri"e a!! other contro! cu"es avai!a"!e on the TM1F server .
H3old,0ser'ame,Cube'ame
The D1o!d%-serNae%Cu"eNae contro! cu"e trac/s the ce!!s he!d "' the -serNae c!ient on the
Cu"eNae cu"e.
391 of 425 26-09-2014 11:18
H3old,0ser'ame,Cube'ame
13.3.1. The D1o!d%-serNae%Cu"eNae contro! cu"e trac/s the ce!!s he!d "' the -serNae c!ient on
the Cu"eNae cu"e.
.imensions
The D1o!d%-serNae%Cu"eNae cu"e contains the fo!!owing diensions>
.imension 1lements
D1o!d This diension contains the fo!!owing e!eents>
Origina!4a!
1o!d *tatus
Ot%er .imensions in t%e H3old,0ser'ame,Cube'ame cube
The D1o!d%-serNae%Cu"eNae cu"e a!so contains a!! of the diensions present in the Cu"eNae
cu"e. +or e#ap!e@ the D1o!d%,din%*a!es cu"e contains the D1o!d diension as we!! as a!! the
diensions present in the *a!es cu"e.
)arent topic* Other Contro! Cu"es
392 of 425 26-09-2014 11:18
1>. Control .imensions
I)MF CognosF TM1F uses contro! diensions to trac/ perforance statistics@ adinister securit'@
anage c!ients and groups@ and store o"<ect attri"utes and properties.
The fo!!owing inforation is provided for each diension>
(escription of diension e!eents
Contro! cu"es that use the diension
HC%ores
The DChores diension is used on!' in the DChore*ecurit' contro! cu"e.
HClient)roperties
This DC!ient&roperties diension is used on!' in the DC!ient&roperties contro! cu"e.
HClients
The DC!ients diension contains string e!eents that correspond to the c!ients defined on the I)M
Cognos TM1 server .
The DConnection&roperties diension is used on!' in the DConnection&roperties contro! cu"e.
HConnections
The DConnections diension contains string e!eents that correspond to the rep!ication connections
defined on the I)M Cognos TM1 server . This diension is used on!' in the DConnection&roperties
contro! cu"e.
HCubeFunctions
The DCu"e+unctions diension is used on!' in the D*tats)'Cu"e)'C!ient contro! cu"e.
HCube)roperties
The DCu"e&roperties diension is used on!' in the DCu"e&roperties contro! cu"e.
HCubes
The DCu"es diension contains string e!eents corresponding to the cu"es@ inc!uding contro! cu"es@
on the I)M Cognos TM1 server .
The D(iension,ttri"utes diension contains nueric e!eents that correspond to the attri"utes
defined for diensions on the I)M Cognos TM1 server .
The D(iension&roperties diension is used on!' in the D(iension&roperties contro! cu"e.
H.imensions
The D(iensions diension contains string e!eents that correspond to the diensions@ inc!uding
contro! diensions@ on the I)M Cognos TM1 server .
The D.!eent,ttri"utes%(iensionNae diension contains nueric e!eents that correspond to
the e!eent attri"utes defined for the (iensionNae diension.
HGroups
The DGroups diension contains string e!eents that correspond to the user groups defined on the
I)M Cognos TM1 server .
H3ierarc%ies
The D1ierarchies diension is used in the D1ierarch'&roperties contro! cu"e.
393 of 425 26-09-2014 11:18
The D1ierarch'&roperties diension is used in the D1ierarch'&roperties contro! cu"e@ a!ong with the
D1ierarchies diension@ to assign naed !eve!s to the hierarch' !eve!s of a TM1 diension.
H3old
The D1o!d diension is used in an' D1o!d%-serNae%Cu"eNae cu"es.
H)erfClients
The D&erfC!ients diension contains nueric e!eents that correspond to the c!ients defined on the
I)M Cognos TM1 server as we!! as a conso!idation of a!! c!ients naed C!ients Tota!.
H)erfCubes
The D&erfCu"es diension contains nueric e!eents that correspond to the cu"es on the I)M
Cognos TM1 server and a conso!idation of a!! cu"es naed Cu"es Tota!.
H)rocesses
The D&rocesses diension contains string e!eents that correspond to the Tur"oIntegrator processes
defined on the I)M Cognos TM1 server .
HStatsStats/yClient
The D*tats*tats)'C!ient diension is used in the D*tats)'C!ient contro! cu"e.
HStatsStats/yCube
The D*tats*tats)'Cu"e diension is used on!' in the D*tats)'Cu"e contro! cu"e.
HStatsStats/yCube/yClient
The D*tats*tats)'Cu"e)'C!ient diension is used on!' in the D*tats)'Cu"e)'C!ient contro! cu"e.
HStatsStatsForSer(er
The D*tats*tats+or*erver diension is used on!' in the D*tats+or*erver contro! cu"e.
HTimeInter(als
,!! perforance onitoring contro! cu"es use the DTieInterva!s contro! diension.
394 of 425 26-09-2014 11:18
HC%ores
18.1. The DChores diension is used on!' in the DChore*ecurit' contro! cu"e.
The diension contains string e!eents corresponding to the naes of the chores defined on the I)MF
CognosF TM1F server.
)arent topic* Contro! (iensions
395 of 425 26-09-2014 11:18
HClient)roperties
18.2. This DC!ient&roperties diension is used on!' in the DC!ient&roperties contro! cu"e.
The diension contains the fo!!owing string e!eents that corresponds to the fo!!owing properties that
can "e defined for c!ients on the I)MF CognosF TM1F server.
1lement .escription
Ma#iu&orts Indicates the a#iu nu"er of ports GconnectionsI that
an individua! c!ient can open on the TM1 server.
&,**WO0( *tores and disp!a's the c!ient password in an encr'pted for.
&assword.#piration(a's Indicates the nu"er of da's for which a given c!ient's
password reains va!id.
&assword6astTie-pdated Indicates the !ast tie GGMTI the password for a given c!ient
was updated. The tie forat is ''''ddhhss.
*T,T-* When a c!ient is !ogged on to the TM1 server@ the *T,T-*
va!ue is ,CTI4.. Otherwise the *T,T-* va!ue is ept'.
396 of 425 26-09-2014 11:18
HClients
18.$. The DC!ients diension contains string e!eents that correspond to the c!ients defined on the I)MF
CognosF TM1F server .
This diension is used in the DC!ientGroups and DC!ient&roperties contro! cu"e.
397 of 425 26-09-2014 11:18
18.2. The DConnection&roperties diension is used on!' in the DConnection&roperties contro! cu"e.
This diension contains the fo!!owing string e!eents that correspond to the properties that can "e
defined for rep!ication connections on the I)MF CognosF TM1F server .
1lement .escription
INT.G0,T.(*.C-0ITA (eterines if the rep!ication connection uses Integrated 6ogin. If
the connection uses Integrated 6ogin@ the va!ue of this propert' is
A.*@ otherwise the va!ue is NO.
6,*T*ANC Tie GGMTI at which the data was !ast s'nchroni=ed on the p!anet
server@ fro which the rep!ication connection was esta"!ished. The
tie forat is ''''ddhhss.
6,*T*ANC*T,0 Tie GGMTI at which the data was !ast s'nchroni=ed on the star
server for the rep!ication connection. The tie forat is
''''ddhhss.
6,*T*ANC*T,00.CO0( Tie GGMTI at which the ost recent s'nchroni=ation resu!ted in
data oving fro the star server to the p!anet. The tie forat is
''''ddhhss.
This e!eent differs fro 6,*T*ANC*T,0 in that 6,*T*ANC*T,0
reports the tie of the ost recent s'nchroni=ation@ even if the
s'nchroni=ation did not resu!t in an' data oving "etween star
server to the p!anet.
N,M.*&,C. The naespace I( of the Cognos naespace when esta"!ishing a
rep!ication connection to a server that uses I)M Cognos : securit'.
Note that this propert' stores the I( of the Cognos naespace@
not the descriptive nae of the naespace.
&,**WO0( *tores and disp!a's the password in an encr'pted forat for
esta"!ishing a rep!ication connection.
*ANC&6,N.T (eterines if the data on the p!anet server is updated during the
s'nchroni=ation process. If the data on the p!anet server is
updated@ the va!ue of this propert' is A.*@ otherwise the va!ue is
NO.
*ANC*T,0 (eterines if the data on the star server is updated during the
s'nchroni=ation process. If the data on the star server is updated@
the va!ue of this propert' is A.*@ otherwise the va!ue is NO.
398 of 425 26-09-2014 11:18
1lement .escription
-*.0 +or a given rep!ication connection@ stores the nae of the user
who esta"!ished the connection.
399 of 425 26-09-2014 11:18
HConnections
18.3. The DConnections diension contains string e!eents that correspond to the rep!ication
connections defined on the I)MF CognosF TM1F server . This diension is used on!' in the
DConnection&roperties contro! cu"e.
400 of 425 26-09-2014 11:18
HCubeFunctions
18.8. The DCu"e+unctions diension is used on!' in the D*tats)'Cu"e)'C!ient contro! cu"e.
The diension contains the fo!!owing string e!eents corresponding to functions that can "e perfored
on a cu"e>
1lement .escription
Ce!! 0etrieva! Ce!!s retrieved "' a user in a non7stored view. This etric inc!udes
ca!cu!ated ce!!s@ such as ru!es@ conso!idations@ and user7defined ca!cu!ations.
Ce!! -pdate Ce!! updates inc!ude user input through the Cu"e 4iewer@ In7*preadsheet
)rowser@ TM1F We"@ and s!ices.
Ce!!s updated through ru!e ca!cu!ations or other ethods are not inc!uded in
this etric.
4iew Ca!cu!ation Nu"er of views reBuested@ which can "e user reBuests for Cu"e 4iewer or
s!ices.
4iew 0etrieva! Nu"er of views reBuested and disp!a'ed.
401 of 425 26-09-2014 11:18
HCube)roperties
18.9. The DCu"e&roperties diension is used on!' in the DCu"e&roperties contro! cu"e.
The diension contains the fo!!owing string e!eents corresponding to the properties that can "e defined
for cu"es on the I)MF CognosF TM1F server .
1lement .escription
(eand6oad Indicates if a cu"e is autoatica!!' !oaded when the server starts or is !oaded
'on deand' on!' when a cu"e va!ue is reBuested.
When a cu"e is !oaded on deand@ the va!ue of the (eand6oad propert' is
A.*@ otherwise the propert' va!ue is NO.
6oc/ When a cu"e is !oc/ed@ this propert' stores the nae of the TM1 c!ient that
has !oc/ed the cu"e.
6ogging Indicates if !ogging is ena"!ed for a given cu"e. When cu"e !ogging is
ena"!ed@ the va!ue of this propert' is A.*@ otherwise the va!ue is NO.
Measures%(iension If a easures diension has "een defined for a given cu"e@ this propert'
stores the nae of the diension.
0ep!ication +or rep!icated cu"es@ this propert' stores the nae of the rep!ication
connection with which the rep!icated cu"e is associated.
0ep*rcNae +or rep!icated cu"es@ this propert' stores the nae of the source cu"e.
0ep*tatus If a cu"e is rep!icated on the server@ the va!ue of 0ep*tatus is Copied@
otherwise this propert' va!ue is ept'.
*'nc0u!e +or rep!icated cu"es@ this propert' indicates whether ru!es are s'nchroni=ed
when the associated cu"e is s'nchroni=ed.
*'nc4iews +or rep!icated cu"es@ this propert' indicates whether views are s'nchroni=ed
when the associated cu"e is s'nchroni=ed.
Tie%(iension If a tie diension has "een defined for a given cu"e@ this propert' stores
the nae of the diension.
4MM +or each cu"e@ this propert' deterines the aount of 0,M reserved on the
server for the storage of stargate views. The ore eor' ade avai!a"!e
for stargate views@ the "etter perforance wi!! "e. Aou ust@ however@ a/e
sure sufficient eor' is avai!a"!e for the TM1 server to !oad a!! cu"es.
402 of 425 26-09-2014 11:18
1lement .escription
If no 4MM va!ue is specified the defau!t va!ue is 83@3$8 "'tes. The va!id
range is 18@$:2 7 2@2;$2@;2$@2;8 "'tes.
4MT +or each cu"e@ this propert' defines the tie thresho!d@ in seconds@ "e'ond
which the a!gorith that stores TM1 stargate views is triggered.
If the tie reBuired to ca!cu!ate a cu"e view surpasses the specified
thresho!d@ TM1 attepts to store a stargate view. If there is not enough
eor' avai!a"!e to store the stargate view@ TM1 purges the o!dest stargate
view that is not current!' in use@ and continues to purge views in this anner
unti! sufficient eor' is ade avai!a"!e.
If no 4MM va!ue is specified the defau!t va!ue is five seconds. The va!id range
is 1 7 23;@200 seconds.
+or detai!s on stargate views@ see ,"out *targate 4iews.
403 of 425 26-09-2014 11:18
HCubes
18.:. The DCu"es diension contains string e!eents corresponding to the cu"es@ inc!uding contro!
cu"es@ on the I)MF CognosF TM1F server .
The DCu"es diension is used on!' in the D(iension,ttri"utes contro! cu"e.
404 of 425 26-09-2014 11:18
18.;. The D(iension,ttri"utes diension contains nueric e!eents that correspond to the attri"utes
defined for diensions on the I)MF CognosF TM1F server .
The D(iension,ttri"utes diension is used in the DCu"e*ecurit' and DCu"e&roperties contro! cu"e.
405 of 425 26-09-2014 11:18
18.10. The D(iension&roperties diension is used on!' in the D(iension&roperties contro! cu"e.
The D(iension&roperties diension contains the fo!!owing string e!eents that correspond to the
properties that can "e defined for diensions on the I)MF CognosF TM1F server .
1lement .escription
(efau!t%1ierarch' Not current!' used.
(eand6oad Not current!' used.
6ast%Tie%-pdated Tie GGMTI at which a diension was !ast updated. The tie forat is
''''ddhhss.
6oc/ When a diension is !oc/ed@ this propert' stores the nae of the TM1
c!ient that has !oc/ed the diension.
0ep!ication +or rep!icated cu"es@ this propert' stores the nae of the rep!ication
connection with which the rep!icated cu"e is associated.
0ep*rcNae +or rep!icated diensions@ this propert' stores the nae of the source
diension.
0ep*tatus If a diension is rep!icated on the server@ the va!ue of 0ep*tatus is
Copied. Otherwise the 0ep*tatus va!ue is ept'.
*ortCoponents*ense Not current!' used.
*ortCoponentsT'pe Not current!' used.
*ort.!eents*ense When diension e!eents are sorted autoatica!!'@ this propert'
stores the sense app!ied to the se!ected sorting. .!eents can "e
sorted in either the ,scending or (escending sense.
*ort.!eentsT'pe When diension e!eents are sorted autoatica!!'@ this propert'
stores the t'pe of sorting used. There are three t'pes of autoatic
e!eent sorting> )'Nae@ )'6eve!@ and )'1ierarch'.
*'nc,ttri"utes +or rep!icated cu"es@ this propert' indicates whether e!eent
attri"utes are s'nchroni=ed when the associated diension is
s'nchroni=ed.
406 of 425 26-09-2014 11:18
1lement .escription
*'nc*u"sets +or rep!icated cu"es@ this propert' indicates whether su"sets are
s'nchroni=ed when the associated diension is s'nchroni=ed.
407 of 425 26-09-2014 11:18
H.imensions
18.11. The D(iensions diension contains string e!eents that correspond to the diensions@ inc!uding
contro! diensions@ on the I)MF CognosF TM1F server .
The D(iensions diension is used on!' in the D(iensions&roperties contro! cu"e.
408 of 425 26-09-2014 11:18
18.12. The D.!eent,ttri"utes%(iensionNae diension contains nueric e!eents that correspond to
the e!eent attri"utes defined for the (iensionNae diension.
The D.!eent,ttri"utes%(iensionNae diension is used on!' in the
D.!eent,ttri"utes%(iensionNae contro! cu"e.
409 of 425 26-09-2014 11:18
HGroups
18.1$. The DGroups diension contains string e!eents that correspond to the user groups defined on
the I)MF CognosF TM1F server .
The DGroups diension is used on!' in the DC!ientGroups contro! cu"e.
410 of 425 26-09-2014 11:18
H3ierarc%ies
18.12. The D1ierarchies diension is used in the D1ierarch'&roperties contro! cu"e.
This diension contains on!' one e!eent@ naed hierarchy0@ that is used with the D1ierarch'&roperties
diension to assign naed !eve!s to the hierarch' !eve!s of a TM1F diension.
411 of 425 26-09-2014 11:18
18.13. The D1ierarch'&roperties diension is used in the D1ierarch'&roperties contro! cu"e@ a!ong with
the D1ierarchies diension@ to assign naed !eve!s to the hierarch' !eve!s of a TM1F diension.
The D1ierarch'&roperties diension contains the fo!!owing e!eents>
1lement .escription
defaultMember , string e!eent that stores the nae of the defau!t e"er of
the diension.
The e!eent nae 'ou enter here a' fi!ter the diension when
TM1 data is retrieved fro an e#terna! app!ication !i/e I)MF
CognosF 0eport *tudio.
-se the nae of the top e!eent in the diension hierarch' so a!!
the diension e!eents are retrieved "' defau!t.
level000 7 level020 , set of string e!eents that store custo naes for the hierarch'
!eve!s of a diension.
412 of 425 26-09-2014 11:18
H3old
18.18. The D1o!d diension is used in an' D1o!d%-serNae%Cu"eNae cu"es.
User9a"e is the nae of the TM1F user who has app!ied ho!ds against cu"e va!ues@ whi!e Cue9a"e is
the nae of the cu"e in which va!ues are "eing he!d.
The D1o!d diension contains the fo!!owing e!eents>
1lement .escription
Origina!4a! This nueric e!eent trac/s the ost recent va!ue of !eaf ce!!s that
are edited in the Cu"eNae cu"e. These ost recent va!ues are
used for severa! data spreading ethods and shou!d not "e edited.
1o!d*tatus This string e!eent identifies ce!!s he!d "' -serNae in the
Cu"eNae cu"e.
, va!ue of 1 indicates that -serNae has app!ied a !eaf ho!d to a
ce!!. , va!ue of C indicates that -serNae has app!ied a
conso!idation ho!d against a ce!!.
413 of 425 26-09-2014 11:18
H)erfClients
18.19. The D&erfC!ients diension contains nueric e!eents that correspond to the c!ients defined on
the I)MF CognosF TM1F server as we!! as a conso!idation of a!! c!ients naed C!ients Tota!.
The D&erfC!ients diension is used in the fo!!owing perforance onitoring cu"es>
D*tats"'C!ient
D*tats)'Cu"e
D*tats)'Cu"e)'C!ient
The D&erfC!ients diension differs fro the DC!ients diension in that the D&erfC!ients diension
contains nueric e!eents@ whi!e the DC!ients diension contains string e!eents.
414 of 425 26-09-2014 11:18
H)erfCubes
18.1:. The D&erfCu"es diension contains nueric e!eents that correspond to the cu"es on the I)MF
CognosF TM1F server and a conso!idation of a!! cu"es naed Cu"es Tota!.
The D&erfCu"es diension is used in the D*tats)'Cu"e and D*tats)'Cu"e)'C!ient perforance
onitoring cu"es.
The D&erfCu"es diension differs fro the DCu"es diension in that the D&erfCu"es diension contains
nueric e!eents@ whi!e the DCu"es diension contains string e!eents.
415 of 425 26-09-2014 11:18
H)rocesses
18.1;. The D&rocesses diension contains string e!eents that correspond to the Tur"oIntegrator
processes defined on the I)MF CognosF TM1F server .
The D&rocesses diension is used on!' in the D&rocess*ecurit' contro! cu"e.
416 of 425 26-09-2014 11:18
HStatsStats/yClient
18.20. The D*tats*tats)'C!ient diension is used in the D*tats)'C!ient contro! cu"e.
This diension contains the fo!!owing easures>
1lement .escription
)'tesHMessage ,verage nu"er of "'tes per essage. The va!ue for this e!eent is
ca!cu!ated "' the stateent [')'tesHMessage'YK['Message
)'tes'YH['Message Count'Y in the ru!e for the D*tats)'C!ient cu"e.
.!apse Tie GsI Tie Gin i!!isecondsI reBuired to process reBuests to the TM1F
server.
Message )'tes Nu"er of "'tes that have "een sent across in the reBuests.
Message Count , essage is a reBuest to the TM1 server for a !ist of o"<ects@ such
as a !ist of diensions.
0eBuest Count Measures the nu"er of reBuests for inforation fro the TM1
server.
417 of 425 26-09-2014 11:18
HStatsStats/yCube
18.21. The D*tats*tats)'Cu"e diension is used on!' in the D*tats)'Cu"e contro! cu"e.
This diension trac/s perforance statistics when perforance onitoring is ena"!ed@ and contains the
fo!!owing e!eents>
1lement .escription
Meor' -sed for Ca!cu!ations This etric easures the eor' used in a!! TM1F ca!cu!ations@
inc!uding conso!idations@ ru!es@ and user7defined ca!cu!ations.
Meor' -sed for +eeders This etric easures the aount of eor' used to feed ce!!s
through TM1 ru!es.
Meor' -sed for Input (ata This inc!udes eor' a!!ocated to data !oaded through
Tur"oIntegrator or process wor/sheets. This easures the eor'
used for a!! data input other than s!ice or Cu"e 4iewer input.
Meor' -sed for 4iews This etric easured the aount of eor'@ in "'tes@ used to store
views for a given cu"e on the TM1 server.
Nu"er of +ed Ce!!s This is the nu"er of ce!!s in the cu"e targeted "' feeders.
Nu"er of &opu!ated Nueric
Ce!!s
This etric counts a!! the popu!ated string ce!!s in a given cu"e.
*tring ce!!s are ce!!s identified "' at !east one string e!eent.
Nu"er of &opu!ated *tring Ce!!s This etric counts a!! the popu!ated string ce!!s in a given cu"e.
*tring ce!!s are ce!!s identified "' at !east one string e!eent.
Nu"er of *tored Ca!cu!ated
Ce!!s
This etric counts a!! stored ca!cu!ated ce!!s inc!uding ru!es@
diensiona! conso!idations@ and user7defined conso!idations.
Nu"er of *tored 4iews This etric easures the nu"er of naed views of a given cu"e.
Tota! Meor' -sed The tota! aount of eor' used "' a cu"e@ easured in "'tes.
418 of 425 26-09-2014 11:18
HStatsStats/yCube/yClient
18.22. The D*tats*tats)'Cu"e)'C!ient diension is used on!' in the D*tats)'Cu"e)'C!ient contro! cu"e.
The diension contains the fo!!owing e!eents>
1lement .escription
Count +or a given cu"e function@ this etric easures the nu"er of functions
e#ecuted.
.!apsed Tie GsI +or a given t'pe of cu"e function@ this etric easures the e!apsed tie
reBuired to e#ecute a!! functions.
419 of 425 26-09-2014 11:18
HStatsStatsForSer(er
18.2$. The D*tats*tats+or*erver diension is used on!' in the D*tats+or*erver contro! cu"e.
The diension trac/s perforance statistics when perforance onitoring is ena"!ed@ and contains the
fo!!owing e!eents>
1lement .escription
Meor' In Gar"age TM1F does not re!ease eor' "ac/ to the operating s'ste whi!e
the TM1 server is running. Instead@ the server retains unused
eor' in 'gar"age' for !ater use. Meor' that has "een a!!ocated
to the server "ut is not in use is represented "' this etric.
Meor' -sed The tota! aount of eor' used "' the server@ in "'tes.
Nu"er of ,ctive Threads This easures the nu"er of threads active on the TM1 server. .ach
c!ient connection constitutes a thread. Threads are a!so used to
e#ecute chores and processes.
Nu"er of Connected C!ients This statistic easures the nu"er of active connections to the TM1
server. ,n individua! c!ient can have u!tip!e connections to the TM1
server active siu!taneous!'. .ach connection is counted in this
etric.
420 of 425 26-09-2014 11:18
HTimeInter(als
18.22. ,!! perforance onitoring contro! cu"es use the DTieInterva!s contro! diension.
This diension contains 18: nueric e!eents for tie interva!s at the inute and hour !eve!@ as fo!!ows>
120 e!eents corresponding to the inutes of the current and the prior hour. .!eents in the current
hour are naed 0M00@ 0M01@ ... 0M3;. .!eents in the prior hour are naed 1M00@ 1M01@ ... 1M3;.
*ap!ing for the perforance onitoring cu"es is done ever' inute. New va!ues are stored in
consecutive inutes of the current hour. When the hour is cop!ete@ the va!ues of the current hour are
copied to the prior hour@ and the current hour is c!eared to accept new va!ues.
2: e!eents corresponding to the hours of the current and the prior da'. .!eents in the current da'
are naed 0100@ 0101@ ... 012$. .!eents for the previous da' are naed 1100@ ... 1101@ 112$.
.ver' hour@ a new suar' GaverageI va!ue fro the inutes is posted in the corresponding hour!'
e!eent. When the da' is over@ the current da''s data rep!aces that of the prior da' and the current
da' is c!eared to accept new data.
1ours and inutes in this diension ref!ect the s'ste c!oc/ tie when 'ou started the perforance
onitor. +or e#ap!e@ if 'ou start the perforance onitor at 10>$1 ,M !oca! s'ste tie@ the first
DTieInterva!s e!eent to receive a va!ue is 0M$1@ which is the $1st inute of the current hour. The ne#t
e!eent to receive a va!ue wou!d "e 0M$2.
421 of 425 26-09-2014 11:18
1?. 1+cel 1(ents 3andled by TM1
*oe Microsoft .#ce! events are hand!ed "' the I)MF CognosF TM1F add7in for .#ce!.
:ist of 1(ents
1+cel 1(ent 'ame .escription
NewWor/"oo/ This event is hand!ed to trac/ the nu"er of wor/"oo/s opened.
Wor/"oo/Open This event is hand!ed to trac/ the nu"er of wor/"oo/s opened and
a!so to set the state of TM1 too!"ars and charts.
Wor/"oo/)efore*ave This event is hand!ed to detect odified status of dependent TM1
O"<ects and to propt save on such o"<ects.
Wor/"oo/)eforeC!ose This event is hand!ed to detect odified status of dependent o"<ects
and propt save on such o"<ects@ as we!! as to un!oad TM1 too!"ars
and enu "ars when the TM1 add7in is un!oaded. To achieve this@ TM1
detects the wor/"oo/ saved status@ posts an appropriate *ave &ropt
essage "o#@ and hand!es the saving of the current wor/"oo/.
Wor/"oo/,ctivate This event is hand!ed to correct!' set the status of TM1 too!"ars and
enu "ars.
Wor/"oo/,ddin-ninsta!! This event is hand!ed to reove TM1 too!"ars and enu "ars fro a
wor/"oo/.
*heet,ctivate This event is hand!ed to update the TM1 too!"ar and enu "ar states@
as we!! as to update sheet7specific varia"!es.
*heet(eactivate This event is hand!ed to detect sheet de!etion.
*heet*e!ectionChange This event is hand!ed to update TM1 enus and too!"ar states.
*heetChange This event is hand!ed to update the TM1 data"ase with the changes
ade to a particu!ar ce!!.
*heet)efore(ou"!eC!ic/ This event is hand!ed to post TM1 7specific dia!og "o#es on particu!ar
TM1 ce!!s.
*heet)efore0ightC!ic/ This event is hand!ed to add and odif' .#ce! conte#t enu.
422 of 425 26-09-2014 11:18
1@. 'otices
This inforation was deve!oped for products and services offered wor!dwide.
I)M a' not offer the products@ services@ or features discussed in this docuent in other countries.
Consu!t 'our !oca! I)M representative for inforation on the products and services current!' avai!a"!e in
'our area. ,n' reference to an I)M product@ progra@ or service is not intended to state or ip!' that
on!' that I)M product@ progra@ or service a' "e used. ,n' functiona!!' eBuiva!ent product@ progra@ or
service that does not infringe an' I)M inte!!ectua! propert' right a' "e used instead. 1owever@ it is the
user's responsi"i!it' to eva!uate and verif' the operation of an' non7I)M product@ progra@ or service.
This docuent a' descri"e products@ services@ or features that are not inc!uded in the &rogra or
!icense entit!eent that 'ou have purchased.
I)M a' have patents or pending patent app!ications covering su"<ect atter descri"ed in this docuent.
The furnishing of this docuent does not grant 'ou an' !icense to these patents. Aou can send !icense
inBuiries@ in writing@ to>
I)M (irector of 6icensing
I)M Corporation
North Cast!e (rive
,ron/@ NA 10302719:3
-.*.,.
+or !icense inBuiries regarding dou"!e7"'te G()C*I inforation@ contact the I)M Inte!!ectua! &ropert'
(epartent in 'our countr' or send inBuiries@ in writing@ to>
Inte!!ectua! &ropert' 6icensing
6ega! and Inte!!ectua! &ropert' 6aw
I)M Rapan 6td.
182$712@ *hiotsurua@ Aaato7shi
Canagawa 2227:302 Rapan
The fo!!owing paragraph does not app!' to the -nited Cingdo or an' other countr' where such
provisions are inconsistent with !oca! !aw> INT.0N,TION,6 )-*IN.** M,C1IN.* CO0&O0,TION
&0O4I(.* T1I* &-)6IC,TION J,* I*J WIT1O-T W,00,NTA O+ ,NA CIN(@ .IT1.0 .5&0.** O0
IM&6I.(@ INC6-(ING@ )-T NOT 6IMIT.( TO@ T1. IM&6I.( W,00,NTI.* O+ NON7IN+0ING.M.NT@
M.0C1,NT,)I6ITA O0 +ITN.** +O0 , &,0TIC-6,0 &-0&O*.. *oe states do not a!!ow disc!aier of
e#press or ip!ied warranties in certain transactions@ therefore@ this stateent a' not app!' to 'ou.
This inforation cou!d inc!ude technica! inaccuracies or t'pographica! errors. Changes are periodica!!'
ade to the inforation hereinN these changes wi!! "e incorporated in new editions of the pu"!ication.
I)M a' a/e iproveents andHor changes in the productGsI andHor the prograGsI descri"ed in this
pu"!ication at an' tie without notice.
,n' references in this inforation to non7I)M We" sites are provided for convenience on!' and do not in
an' anner serve as an endorseent of those We" sites. The ateria!s at those We" sites are not part of
the ateria!s for this I)M product and use of those We" sites is at 'our own ris/.
I)M a' use or distri"ute an' of the inforation 'ou supp!' in an' wa' it "e!ieves appropriate without
incurring an' o"!igation to 'ou.
6icensees of this progra who wish to have inforation a"out it for the purpose of ena"!ing> GiI the
e#change of inforation "etween independent!' created progras and other progras Ginc!uding this
oneI and GiiI the utua! use of the inforation which has "een e#changed@ shou!d contact>
I)M *oftware Group
,ttention> 6icensing
$933 0iverside (r
Ottawa@ ON C14 1)9
423 of 425 26-09-2014 11:18
Canada
*uch inforation a' "e avai!a"!e@ su"<ect to appropriate ters and conditions@ inc!uding in soe cases@
pa'ent of a fee.
The !icensed progra descri"ed in this docuent and a!! !icensed ateria! avai!a"!e for it are provided "'
I)M under ters of the I)M Custoer ,greeent@ I)M Internationa! &rogra 6icense ,greeent or an'
eBuiva!ent agreeent "etween us.
,n' perforance data contained herein was deterined in a contro!!ed environent. Therefore@ the
resu!ts o"tained in other operating environents a' var' significant!'. *oe easureents a' have
"een ade on deve!opent7!eve! s'stes and there is no guarantee that these easureents wi!! "e the
sae on genera!!' avai!a"!e s'stes. +urtherore@ soe easureents a' have "een estiated
through e#trapo!ation. ,ctua! resu!ts a' var'. -sers of this docuent shou!d verif' the app!ica"!e data
for their specific environent.
Inforation concerning non7I)M products was o"tained fro the supp!iers of those products@ their
pu"!ished announceents or other pu"!ic!' avai!a"!e sources. I)M has not tested those products and
cannot confir the accurac' of perforance@ copati"i!it' or an' other c!ais re!ated to non7I)M
products. ?uestions on the capa"i!ities of non7I)M products shou!d "e addressed to the supp!iers of those
products.
,!! stateents regarding I)M's future direction or intent are su"<ect to change or withdrawa! without
notice@ and represent goa!s and o"<ectives on!'.
This inforation contains e#ap!es of data and reports used in dai!' "usiness operations. To i!!ustrate
the as cop!ete!' as possi"!e@ the e#ap!es inc!ude the naes of individua!s@ copanies@ "rands@ and
products. ,!! of these naes are fictitious and an' sii!arit' to the naes and addresses used "' an
actua! "usiness enterprise is entire!' coincidenta!.
If 'ou are viewing this inforation softcop'@ the photographs and co!or i!!ustrations a' not appear.
I
424 of 425 26-09-2014 11:18
I
1@.1. )roduct Information
This docuent app!ies to I)M Cognos TM1 4ersion 10.1.1 and a' a!so app!' to su"seBuent re!eases. To
chec/ for newer versions of this docuent@ visit the I)M Cognos Inforation Centers
Ghttp>HHpu"!i"."ou!der.i".coHinfocenterHcogicHv1r00Hinde#.<spI.
Copyrig%t
6icensed Materia!s 7 &ropert' of I)M
E Cop'right I)M Corp. 2009@ 2012.
-* Governent -sers 0estricted 0ights W -se@ dup!ication or disc!osure restricted "' G*, ,(& *chedu!e
Contract with I)M Corp.
I)M@ the I)M !ogo@ i".co@ TM1@ and Cognos are tradear/s or registered tradear/s of Internationa!
)usiness Machines Corp.@ registered in an' <urisdictions wor!dwide. Other product and service naes
ight "e tradear/s of I)M or other copanies. , current !ist of I)M tradear/s is avai!a"!e on the We"
at J Cop'right and tradear/ inforation J at www.i".coH!ega!Hcop'trade.sht!.
The fo!!owing ters are tradear/s or registered tradear/s of other copanies>
,do"e@ the ,do"e !ogo@ &ost*cript@ and the &ost*cript !ogo are either registered tradear/s or
tradear/s of ,do"e *'stes Incorporated in the -nited *tates@ andHor other countries.
Microsoft@ Windows@ Windows NT@ and the Windows !ogo are tradear/s of Microsoft Corporation in
the -nited *tates@ other countries@ or "oth.
Inte!@ Inte! !ogo@ Inte! Inside@ Inte! Inside !ogo@ Inte! Centrino@ Inte! Centrino !ogo@ Ce!eron@ Inte!
5eon@ Inte! *peed*tep@ Itaniu@ and &entiu are tradear/s or registered tradear/s of Inte!
Corporation or its su"sidiaries in the -nited *tates and other countries.
6inu# is a registered tradear/ of 6inus Torva!ds in the -nited *tates@ other countries@ or "oth.
-NI5 is a registered tradear/ of The Open Group in the -nited *tates and other countries.
Rava and a!! Rava7"ased tradear/s and !ogos are tradear/s or registered tradear/s of Orac!e
andHor its affi!iates.
Microsoft product screen shotGsI used with perission fro Microsoft.
)arent topic* Notices
425 of 425 26-09-2014 11:18

04.TM1 Operation Guide 10.1.1

Caricato da

Informazioni sul documento

Copyright

Formati disponibili

Condividi questo documento

Condividi o incorpora il documento

Opzioni di condivisione

Hai trovato utile questo documento?

Questo contenuto è inappropriato?

Copyright:

Formati disponibili

04.TM1 Operation Guide 10.1.1

Caricato da

Copyright:

Formati disponibili

TM1 Operation Guide 10.1.

Potrebbero piacerti anche