System

Administration Guide

Ver si o n 2019
2019, Jul y 2019
C opyr i ght © 2019 by M i cr oStr ategy Incor por ated. Al l r i ghts r eser ved.
Tr adem ar k Infor m ati on
The fol l ow i ng ar e ei ther tr adem ar ks or r egi ster ed tr adem ar ks of M i cr oStr ategy Incor por ated or i ts affi l i ates i n the U ni ted States and cer tai n other countr i es:

MicroStrategy, MicroStrategy 2019, MicroStrategy 11, MicroStrategy 10, MicroStrategy 10 Secure Enterprise, MicroStrategy 9,
MicroStrategy 9s, MicroStrategy Analytics, MicroStrategy Analytics Platform, MicroStrategy Desktop, MicroStrategy Library,
MicroStrategy Operations Manager, MicroStrategy Analytics Enterprise, MicroStrategy Evaluation Edition, MicroStrategy
Secure Enterprise, MicroStrategy Web, MicroStrategy Mobile, MicroStrategy Server, MicroStrategy Parallel Relational In-
Memory Engine (MicroStrategy PRIME), MicroStrategy MultiSource, MicroStrategy OLAP Services, MicroStrategy Intelligence
Server, MicroStrategy Intelligence Server Universal, MicroStrategy Distribution Services, MicroStrategy Report Services,
MicroStrategy Transaction Services, MicroStrategy Visual Insight, MicroStrategy Web Reporter, MicroStrategy Web Analyst,
MicroStrategy Office, MicroStrategy Data Mining Services, MicroStrategy Geospatial Services, MicroStrategy Narrowcast
Server, MicroStrategy Health Center, MicroStrategy Analyst, MicroStrategy Developer, MicroStrategy Web Professional,
MicroStrategy Architect, MicroStrategy SDK, MicroStrategy Command Manager, MicroStrategy Enterprise Manager,
MicroStrategy Object Manager, MicroStrategy Integrity Manager, MicroStrategy System Manager, MicroStrategy Analytics App,
MicroStrategy Mobile App, MicroStrategy Tech Support App, MicroStrategy Mobile App Platform, MicroStrategy Cloud,
MicroStrategy R Integration, Dossier, Usher, MicroStrategy Usher, Usher Badge, Usher Security, Usher Security Server, Usher
Mobile, Usher Analytics, Usher Network Manager, Usher Professional, MicroStrategy Identity, MicroStrategy Badge,
MicroStrategy Identity Server, MicroStrategy Identity Analytics, MicroStrategy Identity Manager, MicroStrategy Communicator,
MicroStrategy Services, MicroStrategy Professional Services, MicroStrategy Consulting, MicroStrategy Customer Services,
MicroStrategy Education, MicroStrategy University, MicroStrategy Managed Services, BI QuickStrike, Mobile QuickStrike,
Transaction Services QuickStrike Perennial Education Pass, MicroStrategy Web Based Training (WBT), MicroStrategy World,
Best in Business Intelligence, Pixel Perfect, Global Delivery Center, Direct Connect, Enterprise Grade Security For Every
Business, Build Your Own Business Apps, Code-Free, Welcome to Ideal, Intelligent Enterprise, HyperIntelligence, HyperCard,
HyperVoice, HyperVision, HyperMobile, HyperScreen, Zero-Click Intelligence, Enterprise Semantic Graph, The World’s Most
Comprehensive Analytics Platform, The World’s Most Comprehensive Analytics Platform. Period.

Other pr oduct and com pany nam es m enti oned her ei n m ay be the tr adem ar ks of thei r r especti ve ow ner s.
Speci fi cati ons subj ect to change w i thout noti ce. M i cr oStr ategy i s not r esponsi bl e for er r or s or om i ssi ons. M i cr oStr ategy m akes no w ar r anti es or com m i tm ents
concer ni ng the avai l abi l i ty of futur e pr oducts or ver si ons that m ay be pl anned or under devel opm ent.
CONTENTS
1. Int r oduct ion t o M icr oSt r at egy Syst em Adm inist r at ion 12

Best Pr act i ces f or M i cr oSt r at egy Syst em Ad m i ni st r at i on 13

U nd er st and i ng t he M i cr oSt r at egy Ar chi t ect ur e 14
Com m uni cat i ng w i t h Dat ab ases 19
M anagi ng Int el l i gence Ser ver 29
M anagi ng and M oni t or i ng Pr oj ect s 47

Pr ocessi ng Job s 59
U si ng Aut om at ed Inst al l at i on Techni q ues 83

2. Set t ing Up User Secur it y 85

The M i cr oSt r at egy U ser M od el 86

Cont r ol l i ng Access t o Ap p l i cat i on Funct i onal i t y 95

Cont r ol l i ng Access t o Dat a 121
M er gi ng U ser s or Gr oup s 151
Secur i t y Checkl i st Bef or e Dep l oyi ng t he Syst em 156

3. Ident ifying User s: Aut hent icat ion 159

Wor kf l ow : Changi ng Aut hent i cat i on M od es 160

M od es of Aut hent i cat i on 161

Im p l em ent i ng St and ar d Aut hent i cat i on 165

© 2019, M icr o St r at egy In c. 3

Syst em Ad m in ist r at io n Gu id e

Im p l em ent i ng Anonym ous Aut hent i cat i on 169

Im p l em ent i ng LDAP Aut hent i cat i on 171
Enab l i ng Si ngl e Si gn-On Aut hent i cat i on 212
Enab l i ng Bad ge Aut hent i cat i on f or Web and M ob i l e 328
H ow t o Enab l e Seam l ess Logi n Bet w een Web , Li b r ar y, and
Wor kst at i on 332
Im p l em ent i ng Dat ab ase War ehouse Aut hent i cat i on 336
Aut hent i cat i on Exam p l es 339

4. Secur e Com m unicat ion in M icr oSt r at egy 343

Conf i gur i ng SSL f or Int el l i gence Ser ver 344

Conf i gur i ng Web and M ob i l e Ser ver Tr ust st or e 345
SSL w i t h Cl i ent Cer t i f i cat e Ver i f i cat i on 349
Conf i gur i ng Web , M ob i l e Ser ver , and Web Ser vi ces t o
Req ui r e SSL Access 352

Conf i gur i ng Secur e Com m uni cat i on f or M i cr oSt r at egy Web ,

M ob i l e Ser ver , and Devel op er 353
Conf i gur i ng M i cr oSt r at egy Cl i ent Ap p l i cat i ons t o U se an
H TTPS U RL 355

Test i ng SSL Access 356

Cer t i f i cat e Fi l es: Com m on Ext ensi ons and Conver si ons 357
Sel f -Si gned Cer t i f i cat es: Cr eat i ng a Cer t i f i cat e Aut hor i t y f or
Devel op m ent 359

5. M anaging Your Licenses 369

M anagi ng and Ver i f yi ng Your Li censes 370

Aud i t i ng and U p d at i ng Li censes 375

U p d at i ng CPU Af f i ni t y 388

4 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

6. M anaging Your Pr oject s 395

The Pr oj ect Li f e Cycl e 397

Im p l em ent i ng t he Recom m end ed Li f e Cycl e 403
Dup l i cat i ng a Pr oj ect 405
U p d at i ng Pr oj ect s w i t h N ew Ob j ect s 413
Cop yi ng Ob j ect s Bet w een Pr oj ect s: Ob j ect M anager 417
M er gi ng Pr oj ect s t o Synchr oni ze Ob j ect s 467
Com p ar i ng and Tr acki ng Pr oj ect s 477
Del et i ng U nused Schem a Ob j ect s: M anaged Ob j ect s 481

7. M onit or ing Syst em Usage 486

M i cr oSt r at egy Syst em M oni t or s 487

M oni t or i ng Syst em Act i vi t y: Change Jour nal i ng 489
M oni t or i ng Syst em U sage: Int el l i gence Ser ver St at i st i cs 499

M oni t or i ng Qui ck Sear ch Ind i ces 515

Ad d i t i onal M oni t or i ng Tool s 516

8. Tuning Your Syst em for Best Per for m ance 544

Tuni ng: Over vi ew and Best Pr act i ces 546

Desi gni ng Syst em Ar chi t ect ur e 685

M anagi ng Syst em Resour ces 691
M anagi ng U ser Sessi ons 711
Gover ni ng Req uest s 722
M anagi ng Job Execut i on 731
Gover ni ng Resul t s Del i ver y 748
Tuni ng Your Syst em f or In-M em or y Dat aset s 755
Desi gni ng Rep or t s 757

© 2019, M icr o St r at egy In c. 5

Syst em Ad m in ist r at io n Gu id e

Conf i gur i ng Int el l i gence Ser ver and Pr oj ect s 760

Tuni ng N ar r ow cast Ser ver and Int el l i gence Ser ver 783

9. Clust er ing M ult iple M icr oSt r at egy Ser ver s 786

Over vi ew of Cl ust er i ng 787

The Cl ust er ed Ar chi t ect ur e 790
Pr er eq ui si t es f or Cl ust er i ng Int el l i gence Ser ver s 799
Cl ust er i ng Int el l i gence Ser ver s 802
M anagi ng Your Cl ust er ed Syst em 823
Connect i ng M i cr oSt r at egy Web t o a Cl ust er 850

10. Im pr oving Response Tim e: Caching 852

Page Caches 854

Resul t Caches 860
Savi ng Rep or t Resul t s: H i st or y Li st 897

El em ent Caches 920

Ob j ect Caches 936
Vi ew i ng Docum ent Cache H i t s 941

11. M anaging Int elligent Cubes 943

M anagi ng Int el l i gent Cub es: Int el l i gent Cub e M oni t or 944
Gover ni ng Int el l i gent Cub e M em or y U sage, Load i ng, and
St or age 954
Sup p or t i ng Connect i on M ap p i ngs i n Int el l i gent Cub es 969

12. Scheduling Jobs and Adm inist r at ive Tasks 971

Best Pr act i ces f or Sched ul i ng Job s and Ad m i ni st r at i ve Tasks 972

Cr eat i ng and M anagi ng Sched ul es 975

Sched ul i ng Ad m i ni st r at i ve Tasks 983

6 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Sched ul i ng Rep or t s and Docum ent s: Sub scr i p t i ons 988

Conf i gur i ng and Ad m i ni st er i ng Di st r i b ut i on Ser vi ces 1008

13. Adm inist er ing M icr oSt r at egy Web and M obile 1051

Assi gni ng Pr i vi l eges f or M i cr oSt r at egy Web 1052

U si ng t he M i cr oSt r at egy Web Ad m i ni st r at or Page 1054
Def i ni ng Pr oj ect Def aul t s 1057
U si ng Ad d i t i onal Secur i t y Feat ur es f or M i cr oSt r at egy Web
and M ob i l e 1059
Int egr at i ng N ar r ow cast Ser ver w i t h M i cr oSt r at egy Web
p r od uct s 1069
Enab l i ng U ser s t o Inst al l M i cr oSt r at egy Of f i ce f r om Web 1072
FAQs f or Conf i gur i ng and Tuni ng M i cr oSt r at egy Web
Pr od uct s 1074

14. Com bining Adm inist r at ive Tasks w it h Syst em

M anager 1078

Cr eat i ng a Wor kf l ow 1079

Def i ni ng Pr ocesses 1130
Dep l oyi ng a Wor kf l ow 1238

15. Aut om at ing Adm inist r at ive Tasks w it h Com m and

M anager 1247

U si ng Com m and M anager 1248

Execut i ng a Com m and M anager Scr i p t 1254
Com m and M anager Scr i p t Synt ax 1263

U si ng Com m and M anager f r om t he Com m and Li ne 1265

U si ng Com m and M anager w i t h OEM Sof t w ar e 1266

© 2019, M icr o St r at egy In c. 7

Syst em Ad m in ist r at io n Gu id e

16. Ver ifying Repor t s and Docum ent s w it h Int egr it y

M anager 1267

What i s an Int egr i t y Test ? 1269

Best Pr act i ces f or U si ng Int egr i t y M anager 1274
Cr eat i ng an Int egr i t y Test 1276
Execut i ng an Int egr i t y Test 1280
Vi ew i ng t he Resul t s of a Test 1295
Li st of Tags i n t he Int egr i t y Test Fi l e 1303

1. SQL Gener at ion and Dat a Pr ocessing: VLDB Pr oper t ies 1321

Sup p or t i ng Your Syst em Conf i gur at i on 1323

Accessi ng and Wor ki ng w i t h VLDB Pr op er t i es 1325
Det ai l s f or Al l VLDB Pr op er t i es 1336
Def aul t VLDB Set t i ngs f or Sp eci f i c Dat a Sour ces 1643

2. Cr eat ing a M ult ilingual Envir onm ent :

Int er nat ionalizat ion 1647

Ab out Int er nat i onal i zat i on 1650

Best Pr act i ces f or Im p l em ent i ng Int er nat i onal i zat i on 1653

Pr ep ar i ng a Pr oj ect t o Sup p or t Int er nat i onal i zat i on 1654

Pr ovi d i ng M et ad at a Int er nat i onal i zat i on 1658
Pr ovi d i ng Dat a Int er nat i onal i zat i on 1673
M aki ng Tr ansl at ed Dat a Avai l ab l e t o U ser s 1684
Achi evi ng t he Cor r ect Language Di sp l ay 1705
M ai nt ai ni ng Your Int er nat i onal i zed Envi r onm ent 1711

3. List of Pr ivileges 1728

Pr i vi l eges f or Pr ed ef i ned Secur i t y Rol es 1729

8 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Pr i vi l eges f or Out -Of -The-Box U ser Gr oup s 1731

Li st of Al l Pr i vi l eges 1749
Pr i vi l eges b y Li cense Typ e 1751

4. M ult i-Tenant Envir onm ent s: Object N am e

Per sonalizat ion 1762

H ow a Tenant Language Di f f er s f r om a St and ar d Language 1764

Gr ant i ng U ser Access t o Renam e Ob j ect s and Vi ew Tenant
Languages 1764
Renam i ng M et ad at a Ob j ect s 1766
M aki ng Tenant -Sp eci f i c Dat a Avai l ab l e t o U ser s 1777
M ai nt ai ni ng Your M ul t i -Tenant Envi r onm ent 1796

5. Int elligence Ser ver St at ist ics Dat a Dict ionar y 1799

STG_CT_DEVICE_STATS 1800

STG_CT_EXEC_STATS 1803
STG_CT_M AN IP_STATS 1815
STG_IS_CACH E_H IT_STATS 1822
STG_IS_CU BE_REP_STATS 1827
STG_IS_DOC_STEP_STATS 1833

STG_IS_DOCU M EN T_STATS 1842

STG_IS_IN BOX_ACT_STATS 1850
STG_IS_M ESSAGE_STATS 1859
STG_IS_PERF_M ON _STATS 1869
STG_IS_PR_AN S_STATS 1872

STG_IS_PROJ_SESS_STATS 1879
STG_IS_REP_COL_STATS 1883

STG_IS_REP_SEC_STATS 1886

© 2019, M icr o St r at egy In c. 9

Syst em Ad m in ist r at io n Gu id e

STG_IS_REP_SQL_STATS 1890
STG_IS_REP_STEP_STATS 1900
STG_IS_REPORT_STATS 1911
STG_IS_SCH EDU LE_STATS 1926
STG_IS_SESSION _STATS 1929
STG_M SI_STATS_PROP 1937

6. Ent er pr ise M anager Dat a Dict ionar y 1938

Ent er p r i se M anager Dat a War ehouse Tab l es 1939

Rel at i onshi p Tab l es 1993
Ent er p r i se M anager M et ad at a Tab l es 1994
Ent er p r i se M anager At t r i b ut es and M et r i cs 1996

7. Com m and M anager Runt im e 2617

St at em ent Ref er ence Gui d e 2618

Execut i ng a Scr i p t w i t h Com m and M anager Runt i m e 2618

Synt ax Ref er ence Gui d e 2620

8. M icr oSt r at egy Web Cookies 2622

Sessi on Inf or m at i on 2623

Def aul t U ser N am e 2627

Pr oj ect Inf or m at i on 2627
Cur r ent Language 2628
GU I Set t i ngs 2628
Per sonal Aut ost yl e Inf or m at i on 2629

Syst em Aut ost yl e Inf or m at i on 2629

Connect i on Inf or m at i on 2630

Avai l ab l e Pr oj ect s Inf or m at i on 2630

10 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Gl ob al U ser Pr ef er ences 2631

Cached Pr ef er ences 2631
Pr ef er ences 2632

9. Tr oubleshoot ing 2642

M et hod ol ogy f or Fi nd i ng Tr oub l e Sp ot s 2643

M em or y Dep l et i on Tr oub l eshoot i ng 2645
Aut hent i cat i on Tr oub l eshoot i ng 2653
Fi xi ng Inconsi st enci es i n t he M et ad at a 2662
Ob j ect Dep end enci es Tr oub l eshoot i ng 2669
Dat e/ Ti m e Funct i ons Tr oub l eshoot i ng 2669
Per f or m ance Tr oub l eshoot i ng 2670
Pr oj ect Per f or m ance 2670
Tr oub l eshoot i ng Dat a Im p or t ed f r om a Fi l e 2673

Sub scr i p t i on and Rep or t Resul t s Tr oub l eshoot i ng 2674

Dr i l l ed -To Rep or t Ret ur ns N o Dat a or Incor r ect Dat a 2674
Int er nat i onal i zat i on Tr oub l eshoot i ng 2679
Tr oub l eshoot i ng Int el l i gence Ser ver 2681
Logon Fai l ur e 2681

M od i f yi ng ODBC Er r or M essages 2684

Cl ust er ed Envi r onm ent s Tr oub l eshoot i ng 2686
Pr ob l em s i n a Cl ust er ed Envi r onm ent 2686
St at i st i cs Loggi ng Tr oub l eshoot i ng 2689

© 2019, M icr o St r at egy In c. 11

 1
I NTRODUCTION TO
M ICRO STRATEGY SYSTEM
ADM INISTRATION

© 2019, M icr o St r at egy In c. 12

Syst em Ad m in ist r at io n Gu id e

Thi s secti on summari zes the maj or components i n the Mi croStrategy

system archi tecture and provi des a bri ef overvi ew of some of the
basi c concepts you need to understand to admi ni ster a Mi croStrategy
system.

The fol l ow i ng are di scussed:

Best Practices for MicroStrategy System

Administration
Mi croStrategy recommends the fol l ow i ng best practi ces to keep your
system runni ng smoothl y and effi ci entl y:

l U se the proj ect l i fe cycl e of devel opment, testi ng, producti on to ful l y
test your reports, metri cs, and other obj ects before rel easi ng them
to users.

l If you need to del egate admi ni strati ve responsi bi l i ti es among

several peopl e, create a user group. A user group (or "group" for
short) i s a col l ecti on of users and/or subgroups. Groups provi de a
conveni ent w ay to manage a l arge number of users and provi de
them w i th certai n pri vi l eges. Mi croStrategy comes w i th a number of
predefi ned groups for vari ous Admi ni strati on tasks. For more
i nformati on, see About Mi croStrategy U ser Groups.

l If you have mul ti pl e users w orki ng on a proj ect w i th di fferent

functi onal i ty needs, uti l i ze securi ty rol es. A securi ty rol e i s a
col l ecti on of proj ect-l evel pri vi l eges that are assi gned to users.
They can be used i n any proj ect regi stered w i th Intel l i gence Server
and users can have di fferent securi ty rol es i n each proj ect.

l Once Intel l i gence Server i s up and runni ng, you can adj ust i ts
governi ng setti ngs to better sui t your envi ronment. For detai l ed
i nformati on about these setti ngs, see C hapter 8, Tuni ng Your

13 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

System for Best Performance.

You c an us e Enterpris e Manager to monitor v arious as pec ts of

Intelligenc e Serv er's performanc e. Enterpris e Manager is a
Mic roStrategy projec t that us es the Intelligenc e Serv er s tatis tic s
databas e as its data warehous e. For information , s ee the Enterpri se
Manager Gui de .

l If you have mul ti pl e machi nes avai l abl e to run Intel l i gence Server,
you can cl uster those machi nes to i mprove performance and
rel i abi l i ty. See C hapter 9, C l usteri ng Mul ti pl e Mi croStrategy
Servers.

l C reate caches for commonl y used reports and documents to reduce

the database l oad and i mprove the system response ti me. See
C hapter 10, Improvi ng R esponse Ti me: C achi ng.

Creating reports bas ed on Intelligent Cubes c an als o greatly s peed up

the proc es s ing time for reports . Intelligent Cubes are part of the OLAP
Serv ic es features in Intelligenc e Serv er. See C hapter 11, Managi ng
Intel l i gent C ubes .

l Schedul e admi ni strati ve tasks and reports to run duri ng off-peak

hours, so that they do not adversel y affect system performance. See
C hapter 12, Schedul i ng Jobs and Admi ni strati ve Tasks

You c an automate the deliv ery of reports and doc uments to us ers with
the Dis tribution Serv ic es add-on to Intelligenc e Serv er. See Overvi ew
of D i stri buti on Servi ces, page 1008 .

Understanding the MicroStrategy Architecture

A Mi croStrategy system i s bui l t around a three-ti er or four-ti er
structure.

© 2019, M icr o St r at egy In c. 14

Syst em Ad m in ist r at io n Gu id e

l The fi rst ti er consi sts of tw o databases: the data w arehouse, w hi ch

contai ns the i nformati on that your users anal yze; and the
Mi croStrategy metadata, w hi ch contai ns i nformati on about your
Mi croStrategy proj ects. For an i ntroducti on to these databases, see
Stori ng Informati on: the D ata Warehouse and Indexi ng your D ata:
Mi croStrategy Metadata.

l The second ti er consi sts of Mi croStrategy Intel l i gence Server, w hi ch

executes your reports, dossi ers, and documents agai nst the data
w arehouse. For an i ntroducti on to Intel l i gence Server, see
Processi ng Your D ata: Intel l i gence Server.

If Mic roStrategy Dev eloper us ers c onnec t v ia a two-tier projec t

s ourc e (als o c alled a direc t c onnec tion), they c an ac c es s the data
warehous e without Intelligenc e Serv er. For more information on two-
tier projec t s ourc es , s ee Tyi ng i t Al l Together: Proj ects and
Proj ect Sources .

l The thi rd ti er i n thi s system i s Mi croStrategy Web or Mobi l e Server,

w hi ch del i vers the reports to a cl i ent. For an i ntroducti on to
Mi croStrategy Web, see C hapter 13, Admi ni steri ng Mi croStrategy
Web and Mobi l e.

l The l ast ti er i s the Mi croStrategy Web cl i ent, Li brary cl i ent,

Workstati on cl i ent, D esktop cl i ent, or Mi croStrategy Mobi l e app,
w hi ch provi des documents and reports to the users.

In a three-tier s y s tem, Dev eloper is the las t tier.

Storing Information: the Data Warehouse

The data w arehouse i s the foundati on that your Mi croStrategy system
i s bui l t on. It stores al l the i nformati on you and your users anal yze
w i th the Mi croStrategy system. Thi s i nformati on i s usual l y pl aced or
l oaded i n the data w arehouse usi ng some sort of extracti on,
transformati on, and l oadi ng (ETL) process. Your onl i ne transacti on

15 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

processi ng (OLTP) system i s usual l y the mai n source of ori gi nal data
used by the ETL process. Proj ects i n one metadata can have di fferent
data w arehouses and one proj ect can have more than one data
w arehouse.

As a system admi ni strator, you need to know w hi ch rel ati onal

database management system (R D BMS) manages your data
w arehouse, how the Mi croStrategy system accesses i t (w hi ch
machi ne i t i s on and w hi ch OD BC dri ver and D ata Source N ame i t
uses to connect to i t), and w hat shoul d happen w hen the data
w arehouse i s l oaded (such as runni ng scri pts to i nval i date certai n
caches i n Intel l i gence Server, and so on).

Indexing your Data: MicroStrategy Metadata

Mi croStrategy metadata i s l i ke a road map or an i ndex to the
i nformati on that i s stored i n your data w arehouse. The Mi croStrategy
system uses the metadata to know w here i n the data w arehouse i t
shoul d l ook for i nformati on. It al so stores other types of obj ects that
al l ow you to access that i nformati on. These are di scussed bel ow .

The metadata resi des i n a database, the metadata reposi tory, that i s
separate from your data w arehouse. Thi s can be i ni ti al l y created
w hen you run through the Mi croStrategy C onfi gurati on Wi zard. Al l the
metadata i nformati on i s stored i n database tabl es defi ned by
Mi croStrategy.

For more information about running the Mic roStrategy Configuration

Wiz ard, s ee the Instal l ati on and C onfi gurati on Gui de .

To hel p expl ai n how the Mi croStrategy system uses the metadata to

do i ts w ork, i magi ne that a user runs a report w i th a total of revenue
for a certai n regi on i n a quarter of the year. The metadata stores
i nformati on about how the revenue metri c i s to be cal cul ated,
i nformati on about w hi ch row s and tabl es i n the data w arehouse to use
for the regi on, and the most effi ci ent w ay to retri eve the i nformati on.

© 2019, M icr o St r at egy In c. 16

Syst em Ad m in ist r at io n Gu id e

The physi cal w arehouse schema i s a type of conceptual tool that i s

cruci al for you to vi sual i ze i nformati on's l ocati on i n the data
w arehouse. Thi s i ncl udes tabl e and col umn i nformati on about w here
thi ngs are actual l y stored as w el l as maps, such as l ookup and rel ate
tabl es, that hel p the system effi ci entl y access that i nformati on.
Persons w ho create the schema obj ects i n the Mi croStrategy
metadata must reference the physi cal w arehouse schema. Therefore,
i t i s not actual l y stored i n a l ocati on i n the metadata, but i t i s i mpl i ci tl y
present i n the defi ni ti on of the schema obj ects i n the metadata.

The role of the phy s ic al warehous e s c hema is further ex plained in the

Basi c R eporti ng Gui de .

In addi ti on to the physi cal w arehouse schema's i mpl i ci t presence i n

the metadata, the fol l ow i ng types of obj ects are stored i n the
metadata:

l Schema obj ects are obj ects created, usual l y by a proj ect desi gner
or archi tect, based on the l ogi cal and physi cal model s. Facts,
attri butes, and hi erarchi es are exampl es of schema obj ects. These
obj ects are devel oped i n Mi croStrategy Archi tect, w hi ch can be
accessed from Mi croStrategy D evel oper. The Proj ect D esi gn Gui de
i s devoted to expl ai ni ng schema obj ects.

l Appl i cati on obj ects are the obj ects that are necessary to run
reports. These obj ects are general l y created by a report desi gner
and can i ncl ude reports, report templ ates, fi l ters, metri cs, prompts,
and so on. These obj ects are bui l t i n D evel oper or C ommand
Manager. The Basi c R eporti ng Gui de and Advanced R eporti ng
Gui de are devoted to expl ai ni ng appl i cati on obj ects.

l C onfi gurati on obj ects are admi ni strati ve and connecti vi ty-rel ated
obj ects. They are managed i n D evel oper (or C ommand Manager) by
an admi ni strator changi ng the Intel l i gence Server confi gurati on or
proj ect confi gurati on. Exampl es of confi gurati on obj ects i ncl ude
users, groups, server defi ni ti ons and so on.

17 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Processing Your Data: Intelligence Server

Intel l i gence Server i s the second ti er i n the Mi croStrategy system.
Intel l i gence Server must be runni ng for users to get i nformati on from
the data w arehouse usi ng Mi croStrategy cl i ents, such as
Mi croStrategy Web or D evel oper.

Intel l i gence Server i s the heart of the Mi croStrategy system. It

executes reports stored i n the metadata agai nst the data w arehouse
and passes the resul ts of the reports to users. For detai l ed
i nformati on about Intel l i gence Server, i ncl udi ng how to start and stop
i t, see Managi ng Intel l i gence Server, page 29.

A server defi ni ti on i s an i nstance of Intel l i gence Server and i ts

confi gurati on setti ngs. Mul ti pl e server defi ni ti ons can be stored i n the
metadata, but onl y one can be run at a ti me on a machi ne. If you w ant
mul ti pl e machi nes to poi nt to the same metadata, you shoul d cl uster
them. For more i nformati on about cl usteri ng, i ncl udi ng i nstructi ons on
how to cl uster Intel l i gence Servers, see C hapter 9, C l usteri ng
Mul ti pl e Mi croStrategy Servers.

Pointing multiple Intelligenc e Serv ers to the s ame metadata without

c lus tering may c aus e metadata inc ons is tenc ies . This c onfiguration is
not s upported, and Mic roStrategy s trongly rec ommends that us ers not
c onfigure their s y s tems in this way .

Tying it All Together: Projects and Project Sources

A Mi croStrategy proj ect i s an obj ect i n w hi ch you defi ne al l the
schema and appl i cati on obj ects, w hi ch together provi de for a fl exi bl e
reporti ng envi ronment. A proj ect's metadata reposi tory i s establ i shed
by the proj ect source i n w hi ch you construct the proj ect. The proj ect's
data w arehouse i s speci fi ed by associ ati ng the proj ect w i th the
appropri ate database i nstance. For detai l ed i nformati on about
proj ects, i ncl udi ng i nstructi ons on how to create a proj ect, see the
Proj ect D esi gn Gui de.

© 2019, M icr o St r at egy In c. 18

Syst em Ad m in ist r at io n Gu id e

You can manage your proj ects usi ng the System Admi ni strati on
Moni tor. For detai l s, see Managi ng and Moni tori ng Proj ects, page 47.

A proj ect source i s a contai ner stored i n D evel oper that defi nes how
D evel oper accesses the metadata reposi tory. Thi nk of a proj ect
source as a poi nter to one or more proj ects that are stored i n a
metadata reposi tory.

Tw o types of proj ect sources can be created, defi ned by the type of
connecti on they represent:

l Server connecti on, or three-ti er, w hi ch speci fi es the Intel l i gence

Server to connect to.

l D irect connecti on, or tw o-ti er, w hi ch bypasses Intel l i gence Server

and al l ow s D evel oper to connect di rectl y to the Mi croStrategy
metadata and data w arehouse. N ote that thi s i s pri mari l y for proj ect
desi gn and testi ng. Because thi s type of connecti on bypasses
Intel l i gence Server, i mportant benefi ts such as cachi ng and
governi ng, w hi ch hel p protect the system from bei ng overl oaded,
are not avai l abl e.

In older s y s tems y ou may enc ounter a 6.x Project c onnec tion (als o
two-tier) that c onnec ts direc tly to a Mic roStrategy v ers ion 6 projec t in
read-only mode.

For more i nformati on on proj ect sources, see the Instal l ati on and
C onfi gurati on Gui de.

Communicating with Databases

Establ i shi ng communi cati on betw een Mi croStrategy and your
databases or other data sources i s an essenti al fi rst step i n
confi guri ng Mi croStrategy products for reporti ng and anal yzi ng data.
Thi s secti on expl ai ns how Mi croStrategy communi cates w i th vari ous
data sources and the steps requi red to set up thi s communi cati on.

19 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

OD BC (Open D atabase C onnecti vi ty) i s a standard database access

method. OD BC enabl es a si ngl e appl i cati on to access database data,
regardl ess of the database management system (D BMS) that stores
the data. A D BMS i s a col l ecti on of programs that enabl es you to
store, modi fy, and extract i nformati on from a database.

Mi croStrategy Intel l i gence Server, w hen used i n a three- or four-ti er

confi gurati on, i s the appl i cati on that uses OD BC to access a D BMS.
OD BC dri vers transl ate Mi croStrategy Intel l i gence Server requests
i nto commands that the D BMS understands. Mi croStrategy
Intel l i gence Server connects to several databases (at a mi ni mum, the
data w arehouse and the metadata reposi tory) to do i ts w ork.

U sers of Mi croStrategy Web can al so connect to data sources usi ng

database connecti ons. A database connecti on supports connecti ng to
data sources through the use of D SN s, as w el l as through D SN l ess
connecti ons, to i mport and i ntegrate data i nto Mi croStrategy. For
steps to create database connecti ons i n Mi croStrategy Web, see
C reati ng database connecti ons i n Web.

Thi s secti on descri bes the OD BC standard for connecti ng to

databases and creati ng data source names (D SN s) for the OD BC
dri vers that are bundl ed w i th the Mi croStrategy appl i cati ons.

The di agram bel ow i l l ustrates the three-ti er metadata and data

w arehouse connecti vi ty used i n the Mi croStrategy system.

© 2019, M icr o St r at egy In c. 20

Syst em Ad m in ist r at io n Gu id e

The di agram show n above i l l ustrates proj ects that connect to onl y one
data source. H ow ever, Mi croStrategy al l ow s connecti on to mul ti pl e
data sources i n the fol l ow i ng w ays:

l Wi th Mi croStrategy Mul ti Source Opti on, a Mi croStrategy proj ect can

connect to mul ti pl e rel ati onal data sources. For i nformati on on
Mul ti Source Opti on, see the Proj ect D esi gn Gui de.

l You can i ntegrate MD X cube sources such as SAP BW, Mi crosoft

Anal ysi s Servi ces, and H yperi on Essbase w i th your Mi croStrategy
proj ects. For i nformati on on i ntegrati ng these MD X cubes sources
i nto Mi croStrategy, see the MD X C ube R eporti ng Gui de.

Thi s secti on provi des i nformati on and i nstructi ons on the fol l ow i ng
tasks:

21 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Connecting to the MicroStrategy Metadata

Mi croStrategy users need connecti vi ty to the metadata so that they
can access proj ects, create obj ects, and execute reports. Intel l i gence
Server connects to the metadata by readi ng the server metadata
connecti on regi stry w hen i t starts. H ow ever, thi s connecti on i s onl y
one segment of the connecti vi ty pi cture.

C onsi der these questi ons:

l H ow does a D evel oper user access the metadata?

l H ow does a user connect to Intel l i gence Server?

l Where i s the connecti on i nformati on stored?

The di agram bel ow i l l ustrates three-ti er metadata connecti vi ty

betw een the Mi croStrategy metadata database (ti er one), Intel l i gence
Server (ti er tw o), and D evel oper (ti er three).

In a server (three-ti er) envi ronment, D evel oper metadata connecti vi ty

i s establ i shed through the proj ect source. For steps to create a proj ect
source, see the Instal l ati on and C onfi gurati on Gui de.

© 2019, M icr o St r at egy In c. 22

Syst em Ad m in ist r at io n Gu id e

You can al so create and edi t a proj ect source usi ng the Proj ect
Source Manager i n D evel oper. When you use the Proj ect Source
Manager, you must speci fy the Intel l i gence Server machi ne to w hi ch
to connect. It i s through thi s connecti on that D evel oper users retri eve
metadata i nformati on.

The Dev eloper c onnec tion information is s tored in the Dev eloper
mac hine regis try .

Connecting to the Data Warehouse

Once you establ i sh a connecti on to the metadata, you must create a
connecti on to the data w arehouse. Thi s i s general l y performed duri ng
i ni ti al softw are i nstal l ati on and confi gurati on, but i t can al so be
establ i shed w i th the fol l ow i ng procedures i n D evel oper:

23 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l C reati ng a database i nstance: A Mi croStrategy obj ect created i n

D evel oper that represents a connecti on to the data w arehouse. A
database i nstance speci fi es w arehouse connecti on i nformati on
such as the data w arehouse D SN , Logi n ID and passw ord, and
other data w arehouse-speci fi c i nformati on. A database i nstance
shoul d have one defaul t database connecti on w i th one defaul t
database l ogi n.

l C reati ng a database connecti on: Speci fi es the D SN and database

l ogi n used to access the data w arehouse. A database i nstance
desi gnates one database connecti on as the defaul t connecti on for
Mi croStrategy users.

l C reati ng a database l ogi n: Speci fi es the user ID and passw ord used
to access the data w arehouse. The database l ogi n overw ri tes any
l ogi n i nformati on stored i n the D SN .

l U ser connecti on mappi ng: The process of mappi ng Mi croStrategy

users to database connecti ons and database l ogi ns.

For procedures to connect to the data w arehouse, see the Instal l ati on
and C onfi gurati on Gui de.

Caching Database Connections

C onnecti ng to and di sconnecti ng from databases i ncurs a smal l
amount of overhead that may cause a smal l yet noti ceabl e decrease
i n performance i n hi gh-concurrency systems. Wi th connecti on
cachi ng, Intel l i gence Server i s abl e to reuse database connecti ons.
Thi s mi ni mi zes the overhead associ ated w i th repeatedl y connecti ng
to and di sconnecti ng from databases.

C onnecti ons can exi st i n one of tw o states:

l Busy: connecti ons that are acti vel y submi tti ng a query to a
database

© 2019, M icr o St r at egy In c. 24

Syst em Ad m in ist r at io n Gu id e

l C ached: connecti ons that are sti l l connected to a database but not
acti vel y submi tti ng a query to a database

A cached connecti on i s used for a j ob i f the fol l ow i ng cri teri a are

sati sfi ed:

l The connecti on stri ng for the cached connecti on matches the

connecti on stri ng that w i l l be used for the j ob.

l The dri ver mode (mul ti process versus mul ti threaded) for the cached
connecti on matches the dri ver mode that w i l l be used for the j ob.

Intelligenc e Serv er does not c ac he any c onnec tions that hav e pre- or
pos t-SQL s tatements as s oc iated with them bec aus e thes e options may
dras tic ally alter the s tate of the c onnec tion.

Monitoring Database Instance Connections

A w arehouse database connecti on i s i ni ti ated any ti me a user
executes an uncached report or brow ses uncached el ements. The
D atabase C onnecti on Moni tor enabl es you to vi ew the number of busy
and cached connecti ons to the data w arehouse. You can al so vi ew
the name of the database i nstance, the user w ho i s usi ng the
connecti on, and the database l ogi n bei ng used to connect to the
database.

If a database connecti on i s cached, the OD BC connecti on from

Intel l i gence Server to the data w arehouse remai ns open. H ow ever, i f
the data w arehouse connecti on surpasses the connecti on ti me-out or
l i feti me governors (set i n the D atabase C onnecti ons di al og box, on
the A dvanced tab), the OD BC connecti on cl oses, and i t no l onger
di spl ays i n the D atabase C onnecti on Moni tor.

25 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To View the Current Database Connections

1. In D evel oper, l og i n to a proj ect source. You must l og i n as a

user w i th the Moni tor D atabase C onnecti ons pri vi l ege.

2. Expand A dministration, then expand System Monitors, and

then sel ect D atabase C onnections. The database connecti on
i nformati on di spl ays on the ri ght-hand si de.

To Delete a Database Connection

In the D atabase C onnecti on Moni tor, ri ght-cl i ck the connecti on and

sel ect D isconnect.

Benefiting from Centralized Database Access Control

Al l database connecti vi ty i s handl ed by Intel l i gence Server, w hi ch
provi des central i zed control of database access. The advantages of
central i zed control i ncl ude:

l C onnecti onl ess cl i ent—Al l connecti ons to databases i n the system

are made through Intel l i gence Server. Thi s means that onl y the
Intel l i gence Server machi ne needs to have database connecti vi ty. It
al so el i mi nates the need to rel y on i denti cal l y confi gured
connecti ons on cl i ent and server computers. Thi s makes i t easy to
set up, depl oy, and manage l arge systems.

l C onnecti on cachi ng—C onnecti ng to and di sconnecti ng from

databases i ncurs a smal l amount of overhead that may cause a
smal l , yet noti ceabl e, decrease i n performance i n hi gh-concurrency
systems. Wi th connecti on cachi ng, Intel l i gence Server i s abl e to
reuse database connecti ons. Thi s mi ni mi zes the overhead
associ ated w i th repeated connecti ng to and di sconnecti ng from
databases.

© 2019, M icr o St r at egy In c. 26

Syst em Ad m in ist r at io n Gu id e

l Workl oad governi ng—Because onl y Intel l i gence Server connects to

databases, i t can make sure that no one database becomes
overl oaded w i th user requests. Thi s i s especi al l y i mportant for the
data w arehouse.

l U ser connecti on mappi ng—Intel l i gence Server can map

Mi croStrategy users and user groups to data w arehouse l ogi n ID s.
Thi s al l ow s mul ti pl e users to access the database usi ng a si ngl e
database l ogi n or di fferent database l ogi ns.

l Ease of admi ni strati on/moni tori ng—Because al l database

connecti vi ty i s handl ed by Intel l i gence Server, keepi ng track of al l
connecti ons to al l databases i n the system i s easy.

l Pri ori ti zed access to databases—You can set access pri ori ty by
user, proj ect, esti mated j ob cost, or any combi nati on of these.

l Mul ti process executi on—The abi l i ty to run i n mul ti process mode

means that i f one process fai l s, such as a l ost or hung database
access thread, the others are not affected.

l D atabase opti mi zati ons—U si ng VLD B properti es, Intel l i gence

Server i s abl e to take advantage of the uni que performance
opti mi zati ons that di fferent database servers offer.

Updating VLDB Properties for ODBC Connections

VLD B properti es al l ow Intel l i gence Server to take advantage of the
uni que opti mi zati ons that di fferent databases offer. D ependi ng on the
database type, these properti es can affect how Intel l i gence Server
handl es thi ngs l i ke:

l Joi n opti ons, such as the star j oi n and ful l outer j oi n

l Metri c cal cul ati on opti ons, such as w hen to check for N U LLs and
zeros

l Pre- and post-SQL statements

27 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Query opti mi zati ons, such as sub-queri es and dri vi ng tabl es

l Tabl e types, such as temporary tabl es or deri ved tabl es

For more i nformati on about al l the VLD B properti es, see SQL
Generati on and D ata Processi ng: VLD B Properti es.

Up gr ad in g Yo u r Dat ab ase Typ e Pr o p er t ies

D efaul t VLD B properti es are set accordi ng to the database type
speci fi ed i n the database i nstance. Mi croStrategy peri odi cal l y
updates the defaul t setti ngs as database vendors add new
functi onal i ty.

When you create the metadata for a Mi croStrategy proj ect, the
database-speci fi c i nformati on i s l oaded from a fi l e suppl i ed by
Mi croStrategy (cal l ed D a t a b a s e . p d s ). If you get a new rel ease from
Mi croStrategy, the metadata i s automati cal l y upgraded usi ng the
Data ba se .p d s fi l e w i th the metadata update process. The
Admi ni strator i s the onl y user w ho can upgrade the metadata. D o thi s
by cl i cki ng Yes w hen prompted for updati ng the metadata. Thi s
happens w hen you connect to an exi sti ng proj ect after i nstal l i ng a
new Mi croStrategy rel ease.

The Mic roStrategy s y s tem c annot detec t when y ou upgrade or c hange

the databas e us ed to s tore the Mic roStrategy metadata or y our data
warehous e. If y ou upgrade or c hange the databas e that is us ed to s tore
the metadata or data warehous e, y ou c an manually update the databas e
ty pe to apply the default properties for the new databas e ty pe.

When you update the database type i nformati on, thi s process:

l Loads new l y supported database types. For exampl e, properti es for

the new est database servers that w ere recentl y added.

l Loads updated properti es for exi sti ng database types that are sti l l
supported.

© 2019, M icr o St r at egy In c. 28

Syst em Ad m in ist r at io n Gu id e

l Keeps properti es for exi sti ng database types that are no l onger
supported. If there w ere no updates for an exi sti ng database type,
but the properti es for i t have been removed from the
Da ta ba se . p d s fi l e, the process does not remove them from your
metadata.

In s ome c as es , Mic roStrategy no longer updates c ertain DBMS objec ts

as newer v ers ions are releas ed. Thes e are not normally remov ed.
Howev er, in the c as e of Orac le 8i R2 and Orac le 8i R3, the DBMS
objec ts were merged into "Orac le 8i R2/R3" for both Standard and
Enterpris e editions bec aus e Orac le 8i R3 is no longer being updated.
You may need to s elec t the merged v ers ion as part of y our databas e
ins tanc e if y ou are us ing a v ers ion of Orac le 8i. This will bec ome
apparent if date/time func tions s top work ing, partic ularly in Enterpris e
Manager.

For more i nformati on about VLD B properti es, see SQL Generati on and
D ata Processi ng: VLD B Properti es.

You may need to manual l y upgrade the database types i f you chose
not to run the update metadata process after i nstal l i ng a new rel ease.

To Manually Upgrade the Database Type Properties

1. In the D atabase Instance edi tor, cl i ck the General tab.

2. Sel ect U pgrade.

The R eadme lis ts all DBMSs that are s upported or c ertified for us e with
Mic roStrategy .

Managing Intelligence Server

Thi s secti on i ntroduces you to basi c Intel l i gence Server operati on,
i ncl udi ng starti ng and stoppi ng Intel l i gence Server and runni ng i t as a
servi ce or as an appl i cati on.

29 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

You can i mprove your system and database performance by adj usti ng
vari ous Intel l i gence Server governi ng setti ngs to fi t your system
parameters and your reporti ng needs. For detai l ed i nformati on about
these setti ngs, see C hapter 8, Tuni ng Your System for Best
Performance.

What Happens When Intelligence Server Starts?

Once a server defi ni ti on i s defi ned and sel ected for Intel l i gence
Server usi ng the C onfi gurati on Wi zard, the metadata connecti on
i nformati on and server defi ni ti on name are saved i n the machi ne's
regi stry. When Intel l i gence Server starts, i t reads thi s i nformati on to
i denti fy the metadata to w hi ch i t w i l l connect.

When Intel l i gence Server starts, i t does the fol l ow i ng:

l Ini ti al i zes i nternal processi ng uni ts

l R eads metadata connecti on i nformati on and server defi ni ti on name

from the machi ne regi stry and connects to the speci fi ed metadata
database

l Loads confi gurati on and schema i nformati on for each l oaded proj ect

l Loads exi sti ng report cache fi l es from automati c backup fi l es i nto

memory for each l oaded proj ect (up to the speci fi ed maxi mum R AM
setti ng)

This oc c urs only if report c ac hing is enabled and the Load c ac hes on
s tartup feature is enabled.

l Loads schedul es

l Loads MD X cube schemas

You c an s et Intelligenc e Serv er to load MDX c ube s c hemas when it

s tarts , rather than loading MDX c ube s c hemas upon running an MDX
c ube report. For more details on this and s teps to load MDX c ube

© 2019, M icr o St r at egy In c. 30

Syst em Ad m in ist r at io n Gu id e

s c hemas when Intelligenc e Serv er s tarts , s ee the C onfi guri ng and

C onnecti ng Intel l i gence Server s ec tion of the Instal l ati on and
C onfi gurati on Gui de .

If a system or pow er fai l ure occurs, Intel l i gence Server cannot capture
i ts current state. The next ti me the server i s started, i t l oads the state
i nformati on, caches, and H i story Li sts that w ere saved i n the l ast
automati c backup. (The automati c backup frequency i s set usi ng the
Intel l i gence Server C onfi gurati on Edi tor.) The server does not re-
execute any j ob that w as runni ng unti l the person requesti ng the j ob
l ogs i n agai n.

What Happens When Intelligence Server Stops?

When you i ni ti ate an Intel l i gence Server shutdow n, i t:

l Wri tes cache and H i story Li st i nformati on to backup fi l es

l C ancel s currentl y executi ng j obs

The us er who s ubmitted a c anc eled job s ees a mes s age in the His tory
Lis t indic ating that there was an error. The us er mus t res ubmit the job.

l C l oses database connecti ons

l Logs out connected users from the system

l R emoves i tsel f from the cl uster (i f i t w as i n a cl uster)

It does not rejoin the c lus ter automatic ally when res tarted.

As noted earl i er, i f a system or pow er fai l ure occurs, these acti ons
cannot be done. Instead, Intel l i gence Server recovers i ts state from
the l atest automati c backup.

31 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Running Intelligence Server as an Application or a

Service
Intel l i gence Server can be started as a Wi ndow s servi ce or as an
appl i cati on. If you run Intel l i gence Server as a servi ce, you can start
and stop i t from a remote machi ne w i th D evel oper or by l oggi ng i nto
the Intel l i gence Server machi ne remotel y. In addi ti on, you can
confi gure the servi ce to start automati cal l y w hen the machi ne on
w hi ch i t i s i nstal l ed starts. For more i nformati on about runni ng
Intel l i gence Server as a servi ce, see Starti ng and Stoppi ng
Intel l i gence Server as a Servi ce, page 33.

On rare occasi ons you may need to run Intel l i gence Server as an
appl i cati on. Thi s i ncl udes occasi ons w hen you need preci se control
over w hen Intel l i gence Server stops and starts or w hen you need to
change certai n advanced tuni ng setti ngs that are not avai l abl e w hen
Intel l i gence Server i s runni ng as a servi ce. For more i nformati on
about runni ng Intel l i gence Server as an appl i cati on, see Starti ng
Intel l i gence Server as an Appl i cati on, page 40.

Regist er in g an d Un r egist er in g In t elligen ce Ser ver as a UNIX

Ser vice
In U N IX, w hen you confi gure Intel l i gence Server you must speci fy that
i t starts as an appl i cati on or a servi ce. If you w ant to start Intel l i gence
Server as a servi ce, you must regi ster i t as a servi ce w i th the system.
In addi ti on, i n U N IX, i f you w ant to start Intel l i gence Server as a
servi ce after havi ng started i t as an appl i cati on, you must regi ster i t
as a servi ce.

To regis ter or unregis ter Intelligenc e Serv er as a s erv ic e in UNIX, y ou

mus t be logged in to the Intelligenc e Serv er mac hine with root
priv ileges .

You can regi ster Intel l i gence Server as a servi ce i n tw o w ays:

© 2019, M icr o St r at egy In c. 32

Syst em Ad m in ist r at io n Gu id e

l From the C onfi gurati on Wi zard: on the Speci fy a Port N umber page,
ensure that the R egister Intelligence Server as a Service check
box i s sel ected.

l From the command l i ne: i n ~ / M i c r o S t r a t e g y / b i n enter:

mstrctl -s IntelligenceServer rs

If you w ant to start Intel l i gence Server as an appl i cati on after havi ng
regi stered i t as a servi ce, you need to unregi ster i t. U nregi steri ng the
servi ce can be done onl y from the command l i ne, i n
~/Mi cr oS tr a t e g y / b i n. The syntax to unregi ster the servi ce i s:

mstrctl -s IntelligenceServer us

St ar t in g an d St o p p in g In t elligen ce Ser ver as a Ser vice

Once the servi ce i s started, i t i s desi gned to run constantl y, even after
the user w ho started i t l ogs off the system. H ow ever, you may need to
stop and restart i t for these reasons:

l R outi ne mai ntenance on the Intel l i gence Server machi ne

l C hanges to Intel l i gence Server confi gurati on opti ons that cannot be
changed w hi l e Intel l i gence Server i s runni ng

l Potenti al pow er outages due to storms or pl anned bui l di ng

mai ntenance

You can start and stop Intel l i gence Server manual l y as a servi ce
usi ng any of the fol l ow i ng methods:

l Mi croStrategy Servi ce Manager i s a management appl i cati on that

can run i n the background on the Intel l i gence Server machi ne. It i s
often the most conveni ent w ay to start and stop Intel l i gence Server.
For i nstructi ons, see Servi ce Manager, page 34.

33 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l If you are al ready usi ng D evel oper, you may need to start and stop
Intel l i gence Server from w i thi n D evel oper. For i nstructi ons, see
D evel oper, page 37.

l You can start and stop Intel l i gence Server as part of a C ommand
Manager scri pt. For detai l s, see C ommand Manager, page 38.

l Fi nal l y, you can start and stop Intel l i gence Server from the
command l i ne usi ng Mi croStrategy Server C ontrol U ti l i ty. For
i nstructi ons, see C ommand Li ne, page 38.

l You mus t hav e the Configuration ac c es s permis s ion for the s erv er
definition objec t. For information about objec t permis s ions in
Mic roStrategy , s ee C ontrol l i ng Access to Obj ects: Permi ssi ons,
page 95 . For a lis t of the permis s ion groupings for s erv er definition
objec ts , s ee C ontrol l i ng Access to Obj ects: Permi ssi ons, page 95 .

l To remotely s tart and s top the Intelligenc e Serv er s erv ic e in Windows ,

y ou mus t be logged in to the remote mac hine as a Windows us er with
adminis trativ e priv ileges .

Service Manager

Servi ce Manager i s a management tool i nstal l ed w i th Intel l i gence

Server that enabl es you to start and stop Intel l i gence Server and
choose a startup opti on. Servi ce Manager al l ow s you to start, stop,
and manage the fol l ow i ng servi ces:

l Mi croStrategy Intel l i gence Server

l Mi croStrategy Li stener

l Mi croStrategy D i stri buti on Manager

l Mi croStrategy Executi on Engi ne

l Mi croStrategy Enterpri se Manager D ata Loader

© 2019, M icr o St r at egy In c. 34

Syst em Ad m in ist r at io n Gu id e

l Mi croStrategy C ol l aborati on Servi ce

l Mi croStrategy PD F Exporter

For i nstructi ons on how to use Servi ce Manager, cl i ck H elp from

w i thi n Servi ce Manager.

Serv ic e Manager requires that port 8888 be open. If this port is not open,
c ontac t y our network adminis trator.

To Open MicroStrategy Service Manager in Windows

1. In the system tray of the Wi ndow s task bar, doubl e-cl i ck the
Mi croStrategy Servi ce Manager i con, or .

2. If the i con i s not present i n the system tray, then from the
Wi ndow s Start menu, poi nt to A ll Programs, then MicroStrategy
Tools, then sel ect Service Manager.

To Open MicroStrategy Service Manager in UNIX

In UNIX, Serv ic e Manager requires an X-Windows env ironment.

1. Brow se to the fol der speci fi ed as the home di rectory duri ng

Mi croStrategy i nstal l ati on (the defaul t i s ~ / M i c r o S t r a t e g y),
then brow se to / b i n.

2. Type ./ m s t r s v c m g r and press Enter.

35 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Using the Listener/Restarter to Start Intelligence Server

You can confi gure Intel l i gence Server to start automati cal l y w hen the
Intel l i gence Server machi ne starts. You can al so confi gure the
R estarter to restart the Intel l i gence Server servi ce automati cal l y i f i t
fai l s, but the machi ne on w hi ch i t i s i nstal l ed i s sti l l runni ng. To do
thi s, you must have the Mi croStrategy Li stener servi ce runni ng.

To Start a MicroStrategy Service Automatically When the Machine

Restarts

1. From the Wi ndow s Start menu, poi nt to A ll Programs, then

MicroStrategy Tools, then sel ect Service Manager.

2. In the Server drop-dow n l i st, sel ect the name of the machi ne on
w hi ch the servi ce i s i nstal l ed.

3. In the Service drop-dow n l i st, sel ect the servi ce.

© 2019, M icr o St r at egy In c. 36

Syst em Ad m in ist r at io n Gu id e

4. C l i ck Options.

5. Sel ect A utomatic as the Startup Type opti on.

6. C l i ck OK .

You c an als o s et this us ing the Serv ic es option in the Mic ros oft
Window's Control Panel.

To Start Intelligence Server Service Automatically when it Fails

Unexpectedly

The Mic roStrategy Lis tener s erv ic e mus t be running for the Re-s tarter
feature to work .

1. From the Wi ndow s Start menu, poi nt to A ll Programs, then

MicroStrategy Tools, then sel ect Service Manager.

2. In the Server drop-dow n l i st, sel ect the machi ne on w hi ch the

Intel l i gence Server servi ce i s i nstal l ed.

3. In the Service drop-dow n l i st, sel ect MicroStrategy Intelligence

Server.

4. C l i ck Options.

5. On the Intel l i gence Server Opti ons tab, sel ect the Enabled check
box for the R e-starter Option.

Developer

You can start and stop a l ocal Intel l i gence Server from D evel oper.
You cannot start or stop a remote Intel l i gence Server from D evel oper;
you must use one of the other methods to start or stop a remote
Intel l i gence Server.

37 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To Start or Stop Intelligence Server Using Developer

1. In D evel oper, i n the Fol der Li st, ri ght-cl i ck the A dministration

i con.

2. C hoose Start Server to start i t or Stop Server to stop i t.

Command Manager

C ommand Manager i s a scri pt-based tool that enabl es you to perform

vari ous admi ni strati ve and mai ntenance tasks w i th reusabl e scri pts.
You can start and stop Intel l i gence Server usi ng C ommand Manager.

For the C ommand Manager syntax for starti ng and stoppi ng

Intel l i gence Server, see the C ommand Manager H el p (press F1 from
w i thi n C ommand Manager). For a more general i ntroducti on to
Mi croStrategy C ommand Manager, see C hapter 15, Automati ng
Admi ni strati ve Tasks w i th C ommand Manager.

Command Line

You can start and stop Intel l i gence Server from a command prompt,
usi ng the Mi croStrategy Server C ontrol U ti l i ty. Thi s uti l i ty i s i nvoked
by the command m s t r c t l. By defaul t the uti l i ty i s i n C : \ P r o g r a m
File s ( x8 6) \ C o m m o n F i l e s \ M i c r o S t ra t e g y \ i n Wi ndow s,
and i n ~/ Mi c r o S t r a t e g y / b i n i n U N IX.

The syntax to start the servi ce i s:

mstrctl -s IntelligenceServer start --service

The syntax to stop the servi ce i s:

mstrctl -s IntelligenceServer stop

For detai l ed i nstructi ons on how to use the Server C ontrol U ti l i ty, see
Managi ng Mi croStrategy Servi ces from the C ommand Li ne, page 41.

© 2019, M icr o St r at egy In c. 38

Syst em Ad m in ist r at io n Gu id e

Windows Services Window

You can start and stop Intel l i gence Server and choose a startup
opti on usi ng the Wi ndow s Servi ces w i ndow .

To Start and Stop Intelligence Server Using the Windows Services

Window

1. On the Wi ndow s Start menu, poi nt to Settings, then choose

C ontrol Panel.

2. D oubl e-cl i ck A dministrative Tools, and then doubl e-cl i ck

Services.

3. From the Services l i st, sel ect MicroStrategy Intelligence

Server.

4. You can do any of the fol l ow i ng:

l To start the servi ce, cl i ck Start.

l To stop the servi ce, cl i ck Stop.

l To change the startup type, sel ect a startup opti on from the
drop-dow n l i st.

l A utomatic means that the servi ce starts w hen the computer

starts.

l Manual means that you must start the servi ce manual l y.

l D isabled means that you cannot start the servi ce unti l you
change the startup type to one of the other types.

5. C l i ck OK .

39 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

St ar t in g In t elligen ce Ser ver as an Ap p licat io n

Whi l e the need to do so i s rare, you can start Intel l i gence Server as
an appl i cati on. Thi s may be necessary i f you must admi ni ster
Intel l i gence Server on the machi ne on w hi ch i t i s i nstal l ed, i f
D evel oper i s not i nstal l ed on that machi ne.

Some advanced tuni ng setti ngs are onl y avai l abl e w hen starti ng
Intel l i gence Server as a servi ce. If you change these setti ngs, they
are appl i ed the next ti me Intel l i gence Server i s started as a servi ce.

Mic roStrategy rec ommends that y ou not c hange thes e s ettings unles s
reques ted to do s o by a Mic roStrategy Tec hnic al Support as s oc iate.

There are some l i mi tati ons to runni ng Intel l i gence Server as an

appl i cati on:

l The user w ho starts Intel l i gence Server as an appl i cati on must

remai n l ogged on to the machi ne for Intel l i gence Server to keep
runni ng. When the user l ogs off, Intel l i gence Server stops.

l If Intel l i gence Server i s started as an appl i cati on, you cannot

admi ni ster i t remotel y. You can admi ni ster i t onl y by l oggi ng i n to
the Intel l i gence Server machi ne.

l The appl i cati on does not automati cal l y restart i f i t fai l s.

In UNIX, if Intelligenc e Serv er has prev ious ly been c onfigured to run

as a s erv ic e, y ou mus t unregis ter it as a s erv ic e before y ou c an run it
as an applic ation. For ins truc tions on unregis tering Intelligenc e Serv er
as a s erv ic e, s ee R egi steri ng and U nregi steri ng Intel l i gence
Server as a U N IX Servi ce, page 32 .

The defaul t path for the Intel l i gence Server appl i cati on executabl e i s
C:\P ro gr am F i l e s ( x 8 6 ) \ M i c r o S t r a t e g y \ I n t e l l i g e n c e
Serv er \M ST R S v r . e x e i n Wi ndow s, and ~ / M i c r o S t r a t e g y / b i n
i n U N IX.

© 2019, M icr o St r at egy In c. 40

Syst em Ad m in ist r at io n Gu id e

Executi ng thi s fi l e from the command l i ne di spl ays the fol l ow i ng

admi ni strati on menu i n Wi ndow s, and a si mi l ar menu i n U N IX.

To use these opti ons, type the correspondi ng l etter on the command
l i ne and press Enter. For exampl e, to moni tor users, type U and press
Enter. The i nformati on i s di spl ayed.

Managing MicroStrategy Services from the Command

Line
Mi croStrategy Server C ontrol U ti l i ty enabl es you to create and
manage Intel l i gence Server server i nstances from the command l i ne.
A server i nstance i s an Intel l i gence Server that i s usi ng a parti cul ar
server defi ni ti on. For more i nformati on about server defi ni ti ons, see
Processi ng Your D ata: Intel l i gence Server.

Server C ontrol U ti l i ty can al so be used to start, stop, and restart other

Mi croStrategy servi ces—such as the Li stener, D i stri buti on Manager,
Executi on Engi ne, or Enterpri se Manager D ata Loader servi ces—and
to vi ew and set confi gurati on i nformati on for those servi ces.

41 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

The fol l ow i ng tabl e l i sts the commands that you can perform w i th the
Server C ontrol U ti l i ty. The syntax for usi ng the Server C ontrol U ti l i ty
commands i s:

mstrctl -m machinename [-l login] -s servicenamecommand

[instancename]
[(> | <) filename.xml]

Where:

l ma ch in en a m e i s the name of the machi ne hosti ng the server

i nstance or servi ce. If thi s parameter i s omi tted, the servi ce i s
assumed to be hosted on the l ocal machi ne.

l lo gi n i s the l ogi n for the machi ne hosti ng the server i nstance or

servi ce, and i s requi red i f you are not l ogged i nto that machi ne. You
are prompted for a passw ord.

l se rv ic en a m e i s the name of the servi ce, such as

Intel l i genceServer or EMServi ce.

To retriev e a lis t of s erv ic es on a mac hine, us e the c ommand

ms tr ct l - m m a c h i n e n a m e l s .

l co mm an d i s one of the commands from the l i st bel ow .

l in st an ce n a m e i s the name of a server i nstance, w here requi red. If

a name i s not speci fi ed, the command uses the defaul t i nstance
name.

l fi le na me i s the name of the fi l e to read from or w ri te to.

The n us e this
If y ou wa nt to. . .
c omma nd. . .

Get in f o rmat io n ab o u t t h e Server C o n t ro l U t ilit y

List all commands f or t he S erver Cont rol Ut ilit y. -h

© 2019, M icr o St r at egy In c. 42

Syst em Ad m in ist r at io n Gu id e

The n us e this
If y ou wa nt to. . .
c omma nd. . .

This command does not require a machine name, login, or

--help
service name.

Display t he version number of t he S erver Cont rol Ut ilit y.

-V
This command does not require a machine name, login, or --version
service name.

Get in f o rmat io n ab o u t t h e Micro St rat eg y n et wo rk

List machines t hat t he S erver Cont rol Ut ilit y can see and af f ect .
lm
This command does not require a machine name, login, or list-machines
service name.

List t he MicroS t rat egy services available on a machine. ls

list-servers
This command does not require a service name.

List t he ODB C DS Ns available on a machine. lod

list-odbc-dsn
This command does not require a service name.

C o n f ig u re a service

Display t he conf igurat ion inf ormat ion f or a service, in X ML gsvc

instancename [>
f ormat . For more inf ormat ion, see U s ing files to s tore output
filename.xml]
and prov ide input, page 27 .
get-service-
configuration
Y ou can opt ionally specif y a f ile t o save t he conf igurat ion
instancename [>
propert ies t o. filename.xml]

S pecif y t he conf igurat ion inf ormat ion f or a service, in X ML ssvc

instancename [<
f ormat . For more inf ormat ion, see U s ing files to s tore output
filename.xml]
and prov ide input, page 27 .
set-service-
configuration
Y ou can opt ionally specif y a f ile t o read t he conf igurat ion
instancename [<
propert ies f rom. filename.xml]

43 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

The n us e this
If y ou wa nt to. . .
c omma nd. . .

C o n f ig u re a server

Display t he conf igurat ion propert ies of a server, in X ML f ormat . gsc [>
For more inf ormat ion, see U s ing files to s tore output and filename.xml]
prov ide input, page 27 .
get-server-
configuration
Y ou can opt ionally specif y a f ile t o save t he conf igurat ion [>
propert ies t o. filename.xml]

S pecif y t he conf igurat ion propert ies of a server, in X ML f ormat . ssc [<
For more inf ormat ion, see U s ing files to s tore output and filename.xml]
prov ide input, page 27 .
set-server-
configuration
Y ou can opt ionally specif y a f ile t o read t he conf igurat ion [<
propert ies f rom. filename.xml]

C o n f ig u re a server in st an ce

gsic
Display t he conf igurat ion inf ormat ion f or a server inst ance, in instancename [>
X ML f ormat . For more inf ormat ion, see U s ing files to store filename.xml]
output and prov ide input, page 27 . get-server-
instance-
Y ou can opt ionally specif y a f ile t o save t he conf igurat ion configuration
propert ies t o. instancename [>
filename.xml]

S pecif y t he conf igurat ion inf ormat ion f or a server inst ance, in ssic
instancename
X ML f ormat . For more inf ormat ion, see U s ing files to store
output and prov ide input, page 27 . set-server-
instance-
configuration
Y ou can opt ionally specif y a f ile t o read t he conf igurat ion
instancename [<
propert ies f rom. filename.xml]

Man ag e server in st an ces

gdi
Display t he def ault inst ance f or a service. get-default-
instance

© 2019, M icr o St r at egy In c. 44

Syst em Ad m in ist r at io n Gu id e

The n us e this
If y ou wa nt to. . .
c omma nd. . .

sdi
instancename
S et an inst ance of a service as t he def ault inst ance. set-default-
instance
instancename

ci instancename
Creat e a new server inst ance. create-instance
instancename

cpi
instancename
Creat e a copy of a server inst ance. S pecif y t he name f or t he newinstancename
new inst ance as newinstancename . copy-instance
instancename
newinstancename

di instancename
Delet e a server inst ance. delete-instance
instancename

rs instancename

Regist er a server inst ance as a service. register-

service
instancename

us instancename

Unregist er a regist ered server inst ance as a service. unregister-

service
instancename

gl instancename
Display t he license inf ormat ion f or a service inst ance. get-license
instancename

gs instancename
Display t he st at us inf ormat ion f or a server inst ance get-status
instancename

St art o r st o p a server in st an ce

45 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

The n us e this
If y ou wa nt to. . .
c omma nd. . .

start --service
S t art a server inst ance as a service.
instancename

S t art a server inst ance as an applicat ion. For more inf ormat ion, start --
see R unning Intelligenc e Serv er as an Applic ation or a interactive
Serv ic e, page 32 . instancename

stop
S t op a server inst ance t hat has been st art ed as a service.
instancename

pause
P ause a server inst ance t hat has been st art ed as a. service
instancename

Resume a server inst ance t hat has been st art ed as a service and resume
paused. instancename

term
instancename
Terminat e a server inst ance t hat has been st art ed as a service.
terminate
instancename

Usin g Files t o St o r e Ou t p u t an d Pr o vid e In p u t

C ertai n Server C ontrol U ti l i ty commands i nvol ve XML defi ni ti ons. The
commands to di spl ay a server confi gurati on, a servi ce confi gurati on,
and a server i nstance confi gurati on al l output an XML defi ni ti on. The
commands to modi fy a server confi gurati on, a servi ce confi gurati on,
and a server i nstance confi gurati on al l requi re an XML defi ni ti on as
i nput.

It i s di ffi cul t and ti me consumi ng to type a compl ete server, servi ce, or
server i nstance confi gurati on from the command l i ne. An easi er w ay
to confi gure them i s to output the current confi gurati on to a fi l e,
modi fy the fi l e w i th a text edi tor, and then use the fi l e as i nput to a
command to modi fy the confi gurati on.

© 2019, M icr o St r at egy In c. 46

Syst em Ad m in ist r at io n Gu id e

Configuring Intelligenc e Serv er with XML files requires ex tens iv e

k nowledge of the v arious parameters and v alues us ed to define
Intelligenc e Serv er c onfigurations . Prov iding an inc orrec t XML definition
to c onfigure Intelligenc e Serv er c an c aus e errors and unex pec ted
func tionality .

For exampl e, the fol l ow i ng command saves the defaul t server

i nstance confi gurati on to an XML fi l e:

mstr ct l - s I n t e l l i g e n c e S e r v e r
gsic > fi le n a m e. x m l

The server i nstance confi gurati on i s saved i n the fi l e

file na me . xm l, i n the current di rectory.

The fol l ow i ng command modi fi es the defaul t server i nstance

confi gurati on by readi ng i nput from an XML fi l e:

mstr ct l - s I n t e l l i g e n c e S e r v e r
ssic < fi le n a m e. x m l

The XML defi ni ti on i n S e r v e r I n s t a n c e . x m l i s used to defi ne the

server i nstance confi gurati on.

Managing and Monitoring Projects

The System Admi ni strati on Moni tor l i sts al l the proj ects on an
Intel l i gence Server and al l the machi nes i n the cl uster that
Intel l i gence Server i s usi ng. You can moni tor the status of the
proj ects on a proj ect source, and l oad, unl oad, i dl e, and resume
proj ects for the enti re proj ect source or for a si ngl e node of the
cl uster. You can al so schedul e vari ous system mai ntenance tasks
from the Schedul ed Mai ntenance vi ew .

The System Admi ni strati on group contai ns the fol l ow i ng vi ew s:

47 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Proj ect, w hi ch hel ps you keep track of the status of al l the proj ects
contai ned i n the sel ected proj ect source. For detai l ed i nformati on,
see Managi ng Proj ect Status, C onfi gurati on, or Securi ty: Proj ect
Vi ew , page 48.

l C l uster, w hi ch hel ps you manage how proj ects are di stri buted
across the servers i n a cl uster. For detai l ed i nformati on, see
Managi ng C l ustered Intel l i gence Servers: C l uster Vi ew , page 50.

l The Schedul ed Mai ntenance moni tor, w hi ch l i sts al l the schedul ed

mai ntenance tasks. For detai l ed i nformati on, see Schedul i ng
Admi ni strati ve Tasks, page 983.

Managing Project Status, Configuration, or Security:

Project View
The Proj ect vi ew hel ps you keep track of the status of al l the proj ects
contai ned i n the sel ected proj ect source. It al so enabl es access to a
number of proj ect mai ntenance i nterfaces i n one pl ace. Thi s makes i t
faster and easi er to perform mai ntenance tasks such as purgi ng
caches, managi ng securi ty fi l ters, or l oadi ng or unl oadi ng proj ects
from Intel l i gence Server.

To Access the Project View

1. Expand A dministration i n the proj ect source's fol der l i st.

2. Expand the System A dministration group, and then sel ect

Project. The proj ects and thei r statuses di spl ay on the ri ght-
hand si de.

Usin g t h e Pr o ject View

The Proj ect vi ew l i sts al l the proj ects i n the proj ect source. If your
system i s set up as a cl uster of servers, the Proj ect Moni tor di spl ays
al l proj ects i n the cl uster, i ncl udi ng the proj ects that are not runni ng

© 2019, M icr o St r at egy In c. 48

Syst em Ad m in ist r at io n Gu id e

on the node from w hi ch you are accessi ng the Proj ect Moni tor. For
detai l s on proj ects i n a cl ustered envi ronment, see D i stri buti ng
Proj ects Across N odes i n a C l uster, page 818.

To vi ew the status of a proj ect, sel ect the List or D etails vi ew , and
cl i ck the + si gn next to the proj ect's name. A l i st of al l the servers i n
the cl uster expands bel ow the proj ect's name. The status of the
proj ect on each server i s show n next to the server's name. If your
system i s not cl ustered, there i s onl y one server i n thi s l i st.

For projec ts dis tributed as y mmetric ally ac ros s nodes of a c lus ter, a
primary s erv er is as s igned to eac h projec t. A projec t's primary s erv er
handles the time-bas ed s c heduling for that projec t. The primary s erv er
is dis play ed in bold, and Primary Server appears after the s erv er
name.

From the Proj ect vi ew , you can access a number of admi ni strati ve and
mai ntenance functi ons. You can:

l Manage the users and securi ty fi l ters for a proj ect

l Vi ew the change j ournal for a proj ect (for detai l s, see Moni tori ng
System Acti vi ty: C hange Journal i ng, page 489)

l Export and pri nt the proj ect's schema or other proj ect
documentati on

l Load or unl oad proj ects from Intel l i gence Server, or i dl e or resume
proj ects for mai ntenance (for detai l s, see Setti ng the Status of a
Proj ect, page 51)

To load a projec t on a s pec ific s erv er in a c lus ter, y ou us e the Clus ter
Monitor. For details on this proc edure, s ee Managi ng C l ustered
Intel l i gence Servers: C l uster Vi ew , page 50 .

49 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Purge report, el ement, or obj ect caches for proj ects

These tasks are al l avai l abl e by ri ght-cl i cki ng a proj ect i n the
Proj ect Moni tor. For more detai l ed i nformati on about any of these
opti ons, see the H el p or rel ated secti ons i n thi s gui de.

You c an perform an ac tion on multiple projec ts at the s ame time. To

do this , s elec t s ev eral projec ts ( C TR L +c lic k ), then right-c lic k and
s elec t one of the options .

You can al so schedul e any of these mai ntenance functi ons from the
Schedul e Admi ni strati on Tasks di al og box. To access thi s di al og box,
ri ght-cl i ck a proj ect i n the Proj ect vi ew and sel ect Schedule
A dministration Tasks. For more i nformati on, i ncl udi ng detai l ed
i nstructi ons on schedul i ng a task, see Schedul i ng Admi ni strati ve
Tasks, page 983.

Managing Clustered Intelligence Servers: Cluster View

The C l uster vi ew hel ps you keep track of the status of your cl ustered
Intel l i gence Servers. Through the C l uster vi ew , you can vi ew the
status of each node, add or remove nodes i n the cl uster, and vi ew
how proj ects are di stri buted across the nodes.

To Access the Cluster View

1. Expand A dministration i n the proj ect source's fol der l i st.

2. Expand the System A dministration group, and then sel ect

C luster. The proj ects and thei r statuses di spl ay on the ri ght-
hand si de.

3. To see a l i st of al l the proj ects on a node, cl i ck the + si gn next to

that node. The status of the proj ect on the sel ected server i s
show n next to the proj ect's name.

© 2019, M icr o St r at egy In c. 50

Syst em Ad m in ist r at io n Gu id e

Usin g t h e Clu st er View

From the C l uster vi ew , you can access a number of admi ni strati ve
and mai ntenance functi ons. You can:

l Manage the securi ty pol i cy setti ngs for the proj ect source

l Joi n or l eave a cl uster

l Manage the change j ournal i ng for proj ects on a cl uster

l Purge the obj ect cache for a server

These tasks are al l avai l abl e by ri ght-cl i cki ng a server i n the C l uster
vi ew .

You can al so l oad or unl oad proj ects from a machi ne, or i dl e or
resume proj ects on a machi ne for mai ntenance (for detai l s, see
Setti ng the Status of a Proj ect, page 51) by ri ght-cl i cki ng a proj ect on
a server. For more detai l ed i nformati on about any of these opti ons,
see Managi ng your Proj ects Across N odes of a C l uster, page 824.

Setting the Status of a Project

Each proj ect i n Intel l i gence Server can operate i n one of several
modes. Proj ect modes al l ow for vari ous system admi ni strati on tasks
to occur w i thout i nterrupti ng Intel l i gence Server operati on for other
proj ects. The tasks that are al l ow ed to occur depend on the j ob or
j obs that are requi red for that task.

A proj ect's status can be one of the fol l ow i ng:

l Loaded, page 52

l U nl oaded, page 52

l R equest Idl e, page 53

l Executi on Idl e, page 53

l Warehouse Executi on Idl e, page 54

51 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Ful l Idl e, page 55

l Parti al Idl e, page 55

For i nstructi ons on changi ng a proj ect's status, see C hangi ng the
Status of a Proj ect, page 56.

For exampl e scenari os w here the di fferent proj ect i dl e modes can
hel p to support proj ect and data w arehouse mai ntenance tasks, see
Proj ect and D ata Warehouse Mai ntenance Exampl e Scenari os, page
58.

Lo ad ed
A proj ect i n Loaded mode appears as an avai l abl e proj ect i n
D evel oper and Mi croStrategy Web products. In thi s mode, user
requests are accepted and processed as normal .

Un lo ad ed
U nl oaded proj ects are sti l l regi stered on Intel l i gence Server, but they
do not appear as avai l abl e proj ects i n D evel oper or Mi croStrategy
Web products, even for admi ni strators. N othi ng can be done i n the
proj ect unti l i t i s l oaded agai n.

U nl oadi ng a proj ect can be hel pful w hen an admi ni strator has
changed some proj ect confi gurati on setti ngs that do not affect run-
ti me executi on and are to be appl i ed to the proj ect at a l ater ti me. The
admi ni strator can unl oad the proj ect, and then rel oad the proj ect
w hen i t i s ti me to appl y the proj ect confi gurati on setti ngs.

A projec t unload reques t is fully proc es s ed only when all ex ec uting jobs
for the projec t are c omplete.

© 2019, M icr o St r at egy In c. 52

Syst em Ad m in ist r at io n Gu id e

Req u est Id le
R equest Idl e mode hel ps to achi eve a graceful shutdow n of the
proj ect rather than modi fyi ng a proj ect from Loaded mode di rectl y to
Ful l Idl e mode. In thi s mode, Intel l i gence Server:

l Stops accepti ng new user requests from the cl i ents for the proj ect.

l C ompl etes j obs that are al ready bei ng processed. If a user

requested that resul ts be sent to thei r H i story Li st, the resul ts are
avai l abl e i n thei r H i story Li st after the proj ect i s resumed.

Setti ng a proj ect to R equest Idl e can be hel pful to manage server l oad
for proj ects on di fferent cl usters. For exampl e, i n a cl uster w i th tw o
nodes named N ode1 and N ode2, the admi ni strator w ants to redi rect
l oad temporari l y to the proj ect on N ode2. The admi ni strator must fi rst
set the proj ect on N ode1 to R equest Idl e. Thi s al l ow s exi sti ng
requests to fi ni sh executi on for the proj ect on N ode1, and then al l
new l oad i s handl ed by the proj ect on N ode2.

Execu t io n Id le
A proj ect i n Executi on Idl e mode i s i deal for Intel l i gence Server
mai ntenance because thi s mode restri cts users i n the proj ect from
runni ng any j ob i n Intel l i gence Server. In thi s mode, Intel l i gence
Server:

l Stops executi ng al l new and currentl y executi ng j obs and, i n most

cases, pl aces them i n the j ob queue. Thi s i ncl udes j obs that requi re
SQL to be submi tted to the data w arehouse and j obs that are
executed i n Intel l i gence Server, such as answ eri ng prompts.

If a projec t is idled while Intelligenc e Serv er is in the proc es s of

fetc hing query res ults from the data warehous e for a job, that job is
c anc eled ins tead of being plac ed in the job queue. When the projec t is

53 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

res umed, if the job was s ent to the us er's His tory Lis t, an error
mes s age is plac ed in the His tory Lis t. The us er c an c lic k the mes s age
to res ubmit the job reques t.

l Al l ow s users to conti nue to request j obs, but executi on i s not

al l ow ed and the j obs are pl aced i n the j ob queue. Jobs i n the j ob
queue are di spl ayed as "Wai ti ng for proj ect" i n the Job Moni tor.
When the proj ect i s resumed, Intel l i gence Server resumes executi ng
the j obs i n the j ob queue.

Thi s mode al l ow s you to perform mai ntenance tasks for the proj ect.
For exampl e, you can sti l l vi ew the di fferent proj ect admi ni strati on
moni tors, create reports, create attri butes, and so on. H ow ever,
tasks such as el ement brow si ng, exporti ng, and runni ng reports that
are not cached are not al l ow ed.

War eh o u se Execu t io n Id le
A proj ect i n Warehouse Executi on Idl e mode i s i deal for data
w arehouse mai ntenance because thi s mode restri cts users i n the
proj ect from runni ng any SQL agai nst the data w arehouse. In thi s
mode, Intel l i gence Server:

l Accepts new user requests from cl i ents for the proj ect, but i t does
not submi t any SQL to the data w arehouse.

l Stops any new or currentl y executi ng j obs that requi re SQL to be

executed agai nst the data w arehouse and, i n most cases, pl aces
them i n the j ob queue. These j obs di spl ay as "Wai ti ng for proj ect" i n
the Job Moni tor. When the proj ect i s resumed, Intel l i gence Server
resumes executi ng the j obs i n the j ob queue.

If a projec t is idled while Intelligenc e Serv er is in the proc es s of

fetc hing query res ults from the data warehous e for a job, that job is
c anc eled ins tead of being plac ed in the job queue. When the projec t is

© 2019, M icr o St r at egy In c. 54

Syst em Ad m in ist r at io n Gu id e

res umed, if the job was s ent to the us er's His tory Lis t, an error
mes s age is plac ed in the His tory Lis t. The us er c an c lic k the mes s age
to res ubmit the job reques t.

l C ompl etes any j obs that do not requi re SQL to be executed agai nst
the data w arehouse.

Thi s mode al l ow s you to perform mai ntenance tasks on the data

w arehouse w hi l e users conti nue to access non-database-dependent
functi onal i ty. For exampl e, users can run cached reports, but they
cannot dri l l i f that dri l l i ng requi res addi ti onal SQL to be submi tted to
the data w arehouse. U sers can al so export reports and documents
i n the proj ect.

Fu ll Id le
Ful l Idl e i s a combi nati on of R equest Idl e and Executi on Idl e. In thi s
mode, Intel l i gence Server does not accept any new user requests and
acti ve requests are cancel ed. When the proj ect i s resumed,
Intel l i gence Server does not resubmi t the cancel ed j obs and i t pl aces
an error message i n the user's H i story Li st. The user can cl i ck the
message to resubmi t the request.

Thi s mode al l ow s you to stop al l Intel l i gence Server and data

w arehouse processi ng for a proj ect. H ow ever, the proj ect sti l l remai ns
i n Intel l i gence Server memory.

Par t ial Id le
Parti al Idl e i s a combi nati on of R equest Idl e and Warehouse
Executi on Idl e. In thi s mode, Intel l i gence Server does not accept any
new user requests. Any acti ve requests that requi re SQL to be
submi tted to the data w arehouse are queued unti l the proj ect i s
resumed. Al l other acti ve requests are compl eted.

55 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Thi s mode al l ow s you to stop al l Intel l i gence Server and data

w arehouse processi ng for a proj ect, w hi l e not cancel i ng j obs that do
not requi re any w arehouse processi ng. The proj ect sti l l remai ns i n
Intel l i gence Server memory.

Ch an gin g t h e St at u s o f a Pr o ject

To Load or Unload a Project

If the projec t is running on multiple c lus tered Intelligenc e Serv ers , the
projec t is loaded or unloaded from all nodes . To load or unload the
projec t from s pec ific nodes , us e the C luster v iew ins tead of the
Project v iew. For detailed ins truc tions , s ee U si ng the C l uster Vi ew ,
page 51 .

1. In D evel oper, l og i n to the proj ect source contai ni ng the proj ect.

2. U nder that proj ect source, expand A dministration, then expand

System A dministration, and sel ect Project.

3. R i ght-cl i ck the proj ect, poi nt to A dminister Project, and sel ect
Load or U nload. The proj ect i s l oaded or unl oaded. If you are
usi ng cl ustered Intel l i gence Servers, the proj ect i s l oaded or
unl oaded for al l nodes i n the cl uster.

To Idle or Resume a Project

If the projec t is running on multiple c lus tered Intelligenc e Serv ers , the
projec t s tatus c hanges for all nodes . To idle or res ume the projec t on
s pec ific nodes , us e the C luster v iew ins tead of the Project v iew. For
detailed ins truc tions , s ee U si ng the C l uster Vi ew , page 51 .

© 2019, M icr o St r at egy In c. 56

Syst em Ad m in ist r at io n Gu id e

1. In D evel oper, l og i n to the proj ect source contai ni ng the proj ect.

2. U nder that proj ect source, expand A dministration, then expand

System A dministration, and then sel ect Project.

3. R i ght-cl i ck the proj ect, poi nt to Admi ni ster Proj ect, and sel ect
Idle/R esume.

4. Sel ect the opti ons for the i dl e mode that you w ant to set the
proj ect to:

l R equest Idl e (R equest Idle): al l executi ng and queued j obs

fi ni sh executi ng, and any new l y submi tted j obs are rej ected.

l Executi on Idl e (Execution Idle for A ll Jobs): al l executi ng,

queued, and new l y submi tted j obs are pl aced i n the queue, to
be executed w hen the proj ect resumes.

l Warehouse Executi on Idl e (Execution Idle for Warehouse

jobs): al l executi ng, queued, and new l y submi tted j obs that
requi re SQL to be submi tted to the data w arehouse are pl aced
i n the queue, to be executed w hen the proj ect resumes. Any
j obs that do not requi re SQL to be executed agai nst the data
w arehouse are executed.

57 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Ful l Idl e (R equest Idle and Execution Idle for A ll jobs): al l

executi ng and queued j obs are cancel ed, and any new l y
submi tted j obs are rej ected.

l Parti al Idl e (R equest Idle and Execution Idle for Warehouse

jobs): al l executi ng and queued j obs that do not submi t SQL
agai nst the data w arehouse are cancel ed, and any new l y
submi tted j obs are rej ected. Any currentl y executi ng and
queued j obs that do not requi re SQL to be executed agai nst the
data w arehouse are executed.

To res ume the projec t from a prev ious ly idled s tate, c lear the
R equest Idle and Execution Idle c hec k box es .

5. C l i ck OK . The Idl e/R esume di al og box cl oses and the proj ect
goes i nto the sel ected mode. If you are usi ng cl ustered
Intel l i gence Servers, the proj ect mode i s changed for al l nodes i n
the cl uster.

Project and Data Warehouse Maintenance Example

Scenarios
In addi ti on to the exampl e scenari os provi ded w i th the di fferent
proj ect i dl e modes, the l i st bel ow descri bes some other mai ntenance
scenari os that can be achi eved usi ng vari ous proj ect i dl e modes:

l D atabase mai ntenance for a data w arehouse i s schedul ed to run at

mi dni ght, duri ng w hi ch ti me the data w arehouse must not be
accessi bl e to users. At 11:00 P.M., the admi ni strator sets the proj ect
mode to R equest Idl e. Al l currentl y executi ng j obs w i l l fi ni sh
normal l y. At 11:30 P.M., the admi ni strator sets the proj ect mode to
Warehouse Executi on Idl e, di sal l ow i ng any executi on agai nst the
data w arehouse w hi l e mai ntenance tasks are performed. After
mai ntenance i s compl ete, the admi ni strator sets the proj ect to
Loaded to al l ow normal executi on and functi onal i ty to resume for

© 2019, M icr o St r at egy In c. 58

Syst em Ad m in ist r at io n Gu id e

the proj ect.

l Tw o proj ects, named Proj ect1 and Proj ect 2, use the same data
w arehouse. Proj ect1 needs dedi cated access to the data w arehouse
for a speci fi c l ength of ti me. The admi ni strator fi rst sets Proj ect2 to
R equest Idl e. After exi sti ng acti vi ty agai nst the data w arehouse i s
compl ete, Proj ect2 i s restri cted agai nst executi ng on the data
w arehouse. Then, the admi ni strator sets Proj ect2 to Warehouse
Executi on Idl e mode to al l ow data w arehouse-i ndependent acti vi ty
to execute. Proj ect1 now has dedi cated access to the data
w arehouse unti l Proj ect2 i s reset to Loaded.

l When the admi ni strator schedul es a proj ect mai ntenance acti vi ty,
the i mpact on users of the proj ect duri ng thi s ti me can be reduced.
The admi ni strator can set a proj ect's i dl e mode to R equest Idl e,
fol l ow ed by Parti al Idl e, and fi nal l y to Ful l Idl e. Thi s process can
reduce user access to a proj ect and data w arehouse gradual l y,
rather than changi ng di rectl y to Ful l Idl e and thus i mmedi atel y
stoppi ng al l user acti vi ty.

Processing Jobs
Any request submi tted to Intel l i gence Server from any part of the
Mi croStrategy system i s know n as a j ob. Jobs may ori gi nate from
servers such as the Subscri pti on server or Intel l i gence Server's
i nternal schedul er, or from cl i ent appl i cati ons such as Mi croStrategy
D esktop, Mi croStrategy Li brary, Mi croStrategy Workstati on,
Mi croStrategy Web, Mobi l e, Integri ty Manager, or another custom-
coded appl i cati on.

The mai n types of requests i ncl ude report executi on requests, obj ect
brow si ng requests, el ement brow si ng requests, document requests,
and dossi er requests.

59 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

The Job Moni tor show s you w hi ch j obs are currentl y executi ng and
l ets you cancel j obs as necessary. For i nformati on about the j ob
moni tor, see Moni tori ng C urrentl y Executi ng Jobs, page 81.

By defaul t, j obs are processed on a fi rst-i n fi rst-out basi s. H ow ever,

your system probabl y has some j obs that need to be processed before
other j obs. You can assi gn a pri ori ty l evel to each j ob accordi ng to
factors such as the type of request, the user or user group requesti ng
the j ob, the source of the j ob (such as D evel oper, Mobi l e, or
Mi croStrategy Web), the resource cost of the j ob, or the proj ect
contai ni ng the j ob. Jobs w i th a hi gher pri ori ty have precedence over
j obs w i th a l ow er pri ori ty, and they are processed fi rst i f there i s a
l i mi t on the resources avai l abl e. For detai l ed i nformati on on j ob
pri ori ty, i ncl udi ng i nstructi ons on how to pri ori ti ze j obs, see
Pri ori ti zi ng Jobs, page 737.

Intelligence Server Job Processing (Common to All Jobs)

R egardl ess of the type of request, Intel l i gence Server uses some
common functi onal i ty to sati sfy them. The fol l ow i ng i s a hi gh-l evel
overvi ew of the processi ng that takes pl ace.

1. A user makes a request from a cl i ent appl i cati on such as

Mi croStrategy Web, w hi ch sends the request to Intel l i gence
Server.

2. Intel l i gence Server determi nes w hat type of request i t i s and

performs a vari ety of functi ons to prepare for processi ng.

D ependi ng on the request type, a task l i st i s composed that

determi nes w hat tasks must be accompl i shed to compl ete the
j ob, that i s, w hat components the j ob has to use w i thi n the server
that handl e thi ngs l i ke aski ng the user to respond to a prompt,
retri evi ng i nformati on from the metadata reposi tory, executi ng
SQL agai nst a database, and so on. Each type of request has a
di fferent set of tasks i n the task l i st.

© 2019, M icr o St r at egy In c. 60

Syst em Ad m in ist r at io n Gu id e

3. The components i n Intel l i gence Server perform di fferent tasks i n

the task l i st, such as queryi ng the data w arehouse, unti l a fi nal
resul t i s achi eved.

Those components are the stops the j ob makes i n w hat i s cal l ed

a pi pel i ne, a path that the j ob takes as Intel l i gence Server w orks
on i t.

4. The resul t i s sent back to the cl i ent appl i cati on, w hi ch presents
the resul t to the user.

Most of the actual processi ng that takes pl ace i s done i n steps 2 and
3 i nternal l y i n Intel l i gence Server. Al though the user request must be
recei ved and the fi nal resul ts must be del i vered (steps 1 and 4), those
are rel ati vel y si mpl e tasks. It i s more useful to expl ai n how
Intel l i gence Server w orks. Therefore, the rest of thi s secti on
di scusses Intel l i gence Server acti vi ty as i t processes j obs. Thi s
i ncl udes:

l Processi ng R eport Executi on, page 62

l Processi ng Obj ect Brow si ng, page 67

l Processi ng El ement Brow si ng, page 69

l Processi ng R eport Servi ces D ocument Executi on, page 72

l Processi ng D ossi er Executi on, page 75

l C l i ent-Speci fi c Job Processi ng, page 77

Bei ng fami l i ar w i th thi s materi al shoul d hel p you to understand and

i nterpret stati sti cs, Enterpri se Manager reports, and other l og fi l es
avai l abl e i n the system. Thi s may hel p you to know w here to l ook for
bottl enecks i n the system and how you can tune the system to
mi ni mi ze thei r effects.

61 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Processing Report Execution

R eports are perhaps the most common requests made of Intel l i gence
Server. Al l report requests have the fol l ow i ng pi eces:

l A report i nstance i s a contai ner for al l obj ects and i nformati on

needed and produced duri ng report executi on i ncl udi ng templ ates,
fi l ters, prompt answ ers, generated SQL, report resul ts, and so on.

l A task l i st i s a l i st of tasks that must be accompl i shed to compl ete a

j ob. Al l j obs have a task l i st associ ated w i th them. Intel l i gence
Server coordi nates the report i nstance bei ng passed from one
i nternal Intel l i gence Server component to another as a report i s
executed.

The most promi nent Intel l i gence Server components rel ated to report
j ob processi ng are l i sted here.

Co mp o n en t F u n ctio n

P erf orms complex calculat ions on a result set ret urned

f rom t he dat a warehouse, such as st at ist ical and f inancial
f unct ions. A lso, sort s raw result s ret urned f rom t he Query
E ngine int o a cross-t abbed grid suit able f or display t o t he
A nalyt ical E ngine
user. I n addit ion, it perf orms subt ot al calculat ions on t he
S erver
result set . Depending on t he met ric def init ions, t he
A nalyt ical E ngine will also perf orm met ric calculat ions t hat
were not or could not be perf ormed using S QL, such as
complex f unct ions.

Met adat a S erver Cont rols all access t o t he met adat a f or t he ent ire project .

Creat es, modif ies, saves, loads and delet es object s f rom
met adat a. A lso maint ains a server cache of recent ly used
object s. The Object S erver does not manipulat e met adat a
Object S erver
direct ly. The Met adat a S erver does all reading/ writ ing
f rom/ t o t he met adat a; t he Object S erver uses t he
Met adat a S erver t o make any changes t o t he met adat a.

© 2019, M icr o St r at egy In c. 62

Syst em Ad m in ist r at io n Gu id e

Co mp o n en t F u n ctio n

S ends t he S QL generat ed by t he S QL E ngine t o t he dat a

Query E ngine
warehouse f or execut ion.

Creat es and manages all server report ing inst ance

Report S erver
object s. Maint ains a cache of execut ed report s.

Resolves prompt s f or report request s. Works in conjunct ion

Resolut ion S erver wit h Object S erver and E lement S erver t o ret rieve
necessary object s and element s f or a given request .

S QL E ngine S erver Generat es t he S QL needed f or t he report .

Bel ow i s a typi cal scenari o of a report's executi on w i thi n Intel l i gence

Server. The di agram show s the report processi ng steps. An
expl anati on of each step fol l ow s the di agram.

63 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

1. Intel l i gence Server recei ves the request.

2. The R esol uti on Server checks for prompts. If the report has one
or more prompts, the user must answ er them. For i nformati on
about these extra steps, see Processi ng reports w i th prompts.

3. The R eport Server checks the i nternal cache, i f the cachi ng

feature i s turned on, to see w hether the report resul ts al ready
exi st. If the report exi sts i n the cache, Intel l i gence Server ski ps
di rectl y to the l ast step and del i vers the report to the cl i ent. If no
val i d cache exi sts for the report, Intel l i gence Server creates the
task l i st necessary to execute the report. For more i nformati on on
cachi ng, see R esul t C aches, page 860.

Prompts are res olv ed before the Serv er c hec k s for c ac hes . Us ers
may be able to retriev e res ults from c ac he ev en if they hav e
pers onaliz ed the report with their own prompt ans wers .

4. The R esol uti on Server obtai ns the report defi ni ti on and any other
requi red appl i cati on obj ects from the Obj ect Server. The Obj ect
Server retri eves these obj ects from the obj ect cache, i f possi bl e,
or reads them from the metadata vi a the Metadata Server.
Obj ects retri eved from metadata are stored i n the obj ect cache.

5. The SQL Generati on Engi ne creates the opti mi zed SQL speci fi c
to the R D BMS bei ng used i n the data w arehouse. The SQL i s
generated accordi ng to the defi ni ti on of the report and
associ ated appl i cati on obj ects retri eved i n the previ ous step.

6. The Query Engi ne runs the SQL agai nst the data w arehouse. The
report resul ts are returned to Intel l i gence Server.

7. The Anal yti cal Engi ne performs addi ti onal cal cul ati ons as
necessary. For most reports, thi s i ncl udes cross-tabbi ng the raw
data and cal cul ati ng subtotal s. Some reports may requi re

© 2019, M icr o St r at egy In c. 64

Syst em Ad m in ist r at io n Gu id e

addi ti onal cal cul ati ons that cannot be performed i n the database
vi a SQL.

8. D ependi ng on the anal yti cal compl exi ty of the report, the resul ts
mi ght be passed back to the Query Engi ne for further processi ng
by the database unti l the fi nal report i s ready (i n thi s case, steps
5–7 are repeated).

9. Intel l i gence Server's R eport Server saves or updates the report

i n the cache, i f the cachi ng feature i s turned on, and passes the
formatted report back to the cl i ent, w hi ch di spl ays the resul ts to
the user.

Pr o cessin g Rep o r t s wit h Pr o mp t s

If the report has prompts, these steps are i nserted i n the regul ar
report executi on steps presented above (see Processi ng report
executi on):

1. Intel l i gence Server sends the j ob to the R esol uti on Server

component. The R esol uti on Server di scovers that the report
defi ni ti on contai ns a prompt and tel l s Intel l i gence Server to
prompt the user for the necessary i nformati on.

2. Intel l i gence Server puts the j ob i n a sl eep mode and tel l s the
R esul t Sender component to send a message to the cl i ent
appl i cati on prompti ng the user for the i nformati on.

3. The user compl etes the prompt, and the cl i ent appl i cati on sends
the user's prompt sel ecti ons back to Intel l i gence Server.

4. Intel l i gence Server performs the securi ty and governi ng checks

and updates the stati sti cs. It then w akes up the sl eepi ng j ob,
adds the user's prompt repl y to the j ob's report i nstance, and
passes the j ob to the R esol uti on Server agai n.

65 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

5. Thi s cycl e repeats unti l al l prompts i n the report are resol ved.

A s leeping job times out after a c ertain period or if the c onnec tion
to the c lient is los t. If the prompt reply c omes bac k after the job
has timed out, the us er s ees an error mes s age.

Al l regul ar report processi ng resumes from the poi nt at w hi ch

Intel l i gence Server checks for a report cache, i f the cachi ng feature i s
turned on.

Pr o cessin g Per so n al In t elligen t Cu b e Rep o r t s

Personal Intel l i gent C ube reports are i ni ti al l y processed the same as
a regul ar report, and the report i nstance i s hel d i n Intel l i gence
Server's memory. If the user mani pul ates the report and that
mani pul ati on does not cause the base report's SQL to change, the
Anal yti cal Engi ne component servi ces the request and sends the
resul ts to the cl i ent. N o addi ti onal processi ng from the data
w arehouse i s requi red.

R eports can al so connect to Intel l i gent C ubes that can be shared by

mul ti pl e reports. These Intel l i gent C ubes al so al l ow the Anal yti cal
Engi ne to perform addi ti onal anal ysi s w i thout requi ri ng any
processi ng on the data w arehouse.

For i nformati on on personal Intel l i gent C ubes and Intel l i gent C ubes,
see the In-memory Anal yti cs Gui de.

Pr o cessin g Gr ap h Rep o r t s
When processi ng graph reports, Intel l i gence Server performs the
regul ar report processi ng (see Processi ng report executi on).
D ependi ng on the connecti on, the fol l ow i ng happens:

© 2019, M icr o St r at egy In c. 66

Syst em Ad m in ist r at io n Gu id e

l In a three-ti er connecti on, Intel l i gence Server sends the report to

D evel oper, w hi ch creates the graph i mage.

l In a four-ti er connecti on, Intel l i gence Server uses the graph

generati on component to create the graph i mage and sends i t to the
cl i ent.

Processing Object Browsing

The defi ni ti ons for al l obj ects di spl ayed i n the fol der l i st, such as
fol ders, metri cs, attri butes, and reports, are stored i n the metadata.
Whenever you expand or sel ect a fol der i n D evel oper or
Mi croStrategy Web, Intel l i gence Server must retri eve the obj ects from
the metadata before i t can di spl ay them i n the fol der l i st and the
obj ect vi ew er.

Thi s process i s cal l ed obj ect brow si ng and i t creates w hat are cal l ed
obj ect requests. It can cause a sl i ght del ay that you may noti ce the
fi rst ti me you expand or sel ect a fol der. The retri eved obj ect
defi ni ti ons are then pl aced i n Intel l i gence Server's memory (cache) so
that the i nformati on i s di spl ayed i mmedi atel y the next ti me you
brow se the same fol der. Thi s i s cal l ed obj ect cachi ng. For more
i nformati on on thi s, see Obj ect C aches, page 936.

The most promi nent Intel l i gence Server components rel ated to obj ect
brow si ng are l i sted here.

Compone ntU F u n ctio n

Met adat a
Cont rols all access t o t he met adat a f or t he ent ire project .
S erver

Object Creat es, modif ies, saves, loads and delet es object s f rom met adat a.
S erver A lso maint ains a server cache of recent ly used object s.

S ource Net Receives, de-serializes, and passes met adat a object request s t o t he
S erver object server.

67 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

The di agram bel ow show s the obj ect request executi on steps. An
expl anati on of each step fol l ow s the di agram.

1. Intel l i gence Server recei ves the request.

2. The Obj ect Server checks for an obj ect cache that can servi ce
the request. If an obj ect cache exi sts, i t i s returned to the cl i ent
and Intel l i gence Server ski ps to the l ast step i n thi s process. If
no obj ect cache exi sts, the request i s sent to the Metadata
Server.

3. The Metadata Server reads the obj ect defi ni ti on from the
metadata reposi tory.

4. The requested obj ects are recei ved by the Obj ect Server w here
are they deposi ted i nto memory obj ect cache.

5. Intel l i gence Server returns the obj ects to the cl i ent.

© 2019, M icr o St r at egy In c. 68

Syst em Ad m in ist r at io n Gu id e

Processing Element Browsing

Attri bute el ements are typi cal l y stored i n l ookup tabl es i n the data
w arehouse. Thi s i ncl udes data that i s uni que to your busi ness
i ntel l i gence system, such as N ortheast, N orthw est, C entral , and Asi a
i n the R egi on attri bute.

For a more thorough dis c us s ion of attribute elements , s ee the s ec tion in

the Basi c R eporti ng Gui de about the logic al data model.

When users request attri bute el ements from the system, they are sai d
to be el ement brow si ng and create w hat are cal l ed el ement requests.
More speci fi cal l y, thi s happens w hen users:

l Answ er prompts w hen executi ng a report

l Brow se attri bute el ements i n D evel oper usi ng the D ata Expl orer
(ei ther i n the Fol der Li st or the R eport Edi tor)

l U se D evel oper's Fi l ter Edi tor, C ustom Group Edi tor, or Securi ty
Fi l ter Edi tor

l U se the D esi gn Mode on Mi croStrategy Web to edi t the report fi l ter

When Intel l i gence Server recei ves an el ement request from the user,
i t sends a SQL statement to the data w arehouse requesti ng attri bute
el ements. When i t recei ves the resul ts from the data w arehouse, i t
then passes the resul ts back to the user. Al so, i f the el ement cachi ng
feature i s turned on, i t stores the resul ts i n memory so that addi ti onal
requests are retri eved from memory i nstead of queryi ng the data
w arehouse agai n. For more i nformati on on thi s, see El ement C aches,
page 920.

The most promi nent Intel l i gence Server components rel ated to
el ement brow si ng are l i sted here.

69 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Co mp o n en t F u n ctio n

DB E lement Transf orms element request s int o report request s and t hen sends
S erver report request s t o t he warehouse.

E lement Net Receives, de-serializes, and passes element request messages t o

S erver t he E lement S erver.

E lement Creat es and st ores server element caches in memory. Manages all
S erver element request s in t he project .

S ends t he S QL generat ed by t he S QL E ngine t o t he dat a warehouse

Query E ngine
f or execut ion.

Creat es and manages all server report ing inst ance object s.
Report S erver
Maint ains a cache of execut ed report s.

Resolves prompt s f or report request s. Works in conjunct ion wit h

Resolut ion
Object S erver and E lement S erver t o ret rieve necessary object s and
S erver
element s f or a given request .

S QL E ngine
Generat es t he S QL needed f or t he report .
S erver

The di agram bel ow show s the el ement request executi on steps. An

expl anati on of each step fol l ow s the di agram.

© 2019, M icr o St r at egy In c. 70

Syst em Ad m in ist r at io n Gu id e

1. Intel l i gence Server recei ves the request.

2. The El ement Server checks for a server el ement cache that can
servi ce the request. If a server el ement cache exi sts, the el ement
cache i s returned to the cl i ent. Ski p to the l ast step i n thi s
process.

3. If no server el ement cache exi sts, the database El ement Server

recei ves the request and transforms i t i nto a report request.

71 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

The element reques t at this point is proc es s ed lik e a report

reques t: Intelligenc e Serv er c reates a report that has only the
attributes and pos s ibly s ome filtering c riteria, and SQL is
generated and ex ec uted lik e any other report.

4. The R eport Server recei ves the request and creates a report
i nstance.

5. The R esol uti on Server recei ves the request and determi nes w hat
el ements are needed to sati sfy the request, and then passes the
request to the SQL Engi ne Server.

6. The SQL Engi ne Server generates the necessary SQL to sati sfy
the request and passes i t to the Query Engi ne Server.

7. The Query Engi ne Server sends the SQL to the data w arehouse.

8. The el ements are returned from the data w arehouse to

Intel l i gence Server and deposi ted i n the server memory el ement
cache by the El ement Server.

9. Intel l i gence Server returns the el ements to the cl i ent.

Processing Report Services Document Execution

A Mi croStrategy R eport Servi ces document contai ns obj ects
representi ng data comi ng from one or more reports. The document
al so hol ds posi ti oni ng and formatti ng i nformati on. A document i s used
to combi ne data from mul ti pl e reports i nto a si ngl e di spl ay of
presentati on qual i ty. When you create a document, you can speci fy
the data that appears and can al so control the l ayout, formatti ng,
groupi ng, and subtotal i ng of that data. In addi ti on, you can i nsert
pi ctures i nto the document and draw borders on i t. Al l these
capabi l i ti es al l ow you to create documents that are sui tabl e to present
to management.

Most of the data on a document i s from an underl yi ng dataset. A

dataset i s a Mi croStrategy report that defi nes the i nformati on that

© 2019, M icr o St r at egy In c. 72

Syst em Ad m in ist r at io n Gu id e

Intel l i gence Server retri eves from the data w arehouse or cache. Other
data that does not ori gi nate from the dataset i s stored i n the
document's defi ni ti on.

D ocument executi on i s sl i ghtl y di fferent from the executi on of a si ngl e

report, si nce documents can contai n mul ti pl e reports.

The fol l ow i ng di agram show s the document processi ng executi on

steps. An expl anati on of each step fol l ow s the di agram.

1. Intel l i gence Server recei ves a document executi on request and

creates a document i nstance i n Intel l i gence Server. Thi s
i nstance hol ds the resul ts of the request.

73 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

A document i nstance faci l i tates the processi ng of the document

through Intel l i gence Server, si mi l ar to a report i nstance that i s
used to process reports. It contai ns the report i nstances for al l
the dataset reports and therefore has access to al l the
i nformati on that may be i ncl uded i n the dataset reports. Thi s
i nformati on i ncl udes prompts, formats, and so on.

2. The D ocument Server i nspects al l dataset reports and prepares

for executi on. It consol i dates al l prompts from datasets i nto a
si ngl e prompt to be answ ered. Al l i denti cal prompts are merged
so that the resul ti ng prompt contai ns onl y one copy of each
prompt questi on.

3. The D ocument Server, w i th the assi stance of the R esol uti on

Server, asks the user to answ er the consol i dated prompt. The
user's answ ers are stored i n the D ocument Server.

4. The D ocument Server creates an i ndi vi dual report executi on j ob

for each dataset report. Each j ob i s processed by Intel l i gence
Server, usi ng the report executi on fl ow descri bed i n Processi ng
R eport Executi on, page 62. Prompt answ ers are provi ded by the
D ocument Server to avoi d further prompt resol uti on.

5. After Intel l i gence Server has compl eted al l the report executi on
j obs, the Anal yti cal Engi ne recei ves the correspondi ng report
i nstances to begi n the data preparati on step. D ocument el ements
are mapped to the correspondi ng report i nstance to construct
i nternal data vi ew s for each el ement.

Doc ument elements inc lude grouping, data fields , Grid/Graphs ,

and s o on.

6. The Anal yti cal Engi ne eval uates each data vi ew and performs
the cal cul ati ons that are requi red to prepare a consol i dated
dataset for the enti re document i nstance. These cal cul ati ons

© 2019, M icr o St r at egy In c. 74

Syst em Ad m in ist r at io n Gu id e

i ncl ude cal cul ated expressi ons, deri ved metri cs, and condi ti onal
formatti ng. The consol i dated dataset determi nes the number of
el ements for each group and the number of detai l secti ons.

7. The D ocument Server recei ves the fi nal document i nstance to

fi nal i ze the document format:

l Addi ti onal formatti ng steps are requi red i f the document i s

exported to PD F or Excel format. The export generati on takes
pl ace on the cl i ent si de i n three-ti er and on the server si de i n
four-ti er, al though the component i n charge i s the same i n both
cases.

l If the document i s executed i n H TML, the Mi croStrategy Web

cl i ent requests an XML representati on of the document to
process i t and render the fi nal output.

8. The compl eted document i s returned to the cl i ent.

Processing Dossier Execution

A dossi er i s a contai ner for formatti ng, di spl ayi ng, and di stri buti ng
mul ti pl e reports from a si ngl e request. D ossi ers are based on an
H TML templ ate, w hi ch al l ow s them to contai n any combi nati on of text,
i mages, hyperl i nks, tabl es, gri d reports, and graph reports. Any
reports i ncl uded i n a dossi er are cal l ed the chi l d reports of the
dossi er.

Because dossi ers are col l ecti ons of mul ti pl e reports, thei r executi on
process i s sl i ghtl y di fferent from si ngl e reports. The most notabl e
di fferences are show n i n the procedure bel ow .

The di agram bel ow show s the dossi er processi ng executi on steps. An

expl anati on of each step fol l ow s the di agram.

75 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

1. Intel l i gence Server recei ves a dossi er executi on request and

creates dossi er i nstance to go through Intel l i gence Server and
hol d the resul ts.

2. The dossi er server consol i dates al l prompts from chi l d reports

i nto a si ngl e prompt to be answ ered. Any i denti cal prompts are
merged so that the resul ti ng si ngl e prompt contai ns onl y one
copy of each prompt questi on.

3. R esol uti on Server asks the user to answ er the consol i dated
prompt. (The user onl y needs to answ er a si ngl e set of
questi ons.)

4. The dossi er server spl i ts the dossi er request i nto separate

i ndi vi dual j obs for the consti tuent reports. Each report goes
through the report executi on fl ow as descri bed above.

Prompts hav e already been res olv ed for the c hild reports .

5. The compl eted request i s returned to the cl i ent.

© 2019, M icr o St r at egy In c. 76

Syst em Ad m in ist r at io n Gu id e

Client-Specific Job Processing

Thi s secti on expl ai ns the j ob processi ng steps that certai n cl i ent
appl i cati ons perform as they del i ver user requests to Intel l i gence
Server. It al so covers how those cl i ents recei ve resul ts, and how the
resul ts are di spl ayed them to the user.

For i nformati on about the processi ng steps performed by Intel l i gence

Server for al l j obs, see Intel l i gence Server Job Processi ng (C ommon
to Al l Jobs), page 60.

Pr o cessin g Jo b s f r o m Micr o St r at egy Web Pr o d u ct s

Thi s secti on provi des a hi gh-l evel overvi ew of processi ng fl ow for
requests ori gi nati ng i n Mi croStrategy Web or Web U ni versal . It al so
i ncl udes the j ob process for exporti ng reports i n vari ous formats.

Job Requests from MicroStrategy Web Products

1. The user makes a request from a w eb brow ser. The request i s

sent to the w eb server vi a H TTP or H TTPS.

2. An ASP.N ET page or a servl et recei ves the request and cal l s the
Mi croStrategy Web API.

3. The Mi croStrategy Web API sends the request to Intel l i gence

Server, w hi ch processes the j ob as usual (see Processi ng
R eport Executi on, page 62).

4. Intel l i gence Server sends the resul ts back to the Mi croStrategy

Web API vi a XML.

5. Mi croStrategy Web converts the XML to H TML w i thi n the

appl i cati on code:

l In Mi croStrategy Web, the conversi on i s pri mari l y performed i n

ASP code.

77 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l In some customi zati ons, the conversi on may occur w i thi n

custom XSL cl asses. By defaul t, the product does not use XSL
for renderi ng output, except i n document obj ects.

6. Mi croStrategy Web sends the H TML to the cl i ent's brow ser,

w hi ch di spl ays the resul ts.

What Happens When I Export a Report from MicroStrategy Web?

Exporti ng a report from Mi croStrategy Web products l ets users save

the report i n another format that may provi de addi ti onal capabi l i ti es
for shari ng, pri nti ng, or further mani pul ati on. Thi s secti on expl ai ns the
addi ti onal processi ng the system must do w hen exporti ng a report i n
one of several formats. Thi s may hel p you to understand w hen certai n
parts of the Mi croStrategy pl atform are stressed w hen exporti ng.

Exporti ng a report from Mi croStrategy Web products causes

Intel l i gence Server to retri eve the enti re resul t set (no i ncremental
fetch) i nto memory and send i t to Mi croStrategy Web. Thi s i ncreases
the memory use on the Intel l i gence Server machi ne and i t i ncreases
netw ork traffi c.

For information about gov erning report s iz e limits for ex porting, s ee

Li mi ti ng the Informati on D i spl ayed at One Ti me, page 750 and the
following s ec tions .

Export to Comma Separated File (CSV) or Excel with Plain Text

Export to C omma Separated Fi l e (C SV) and Export to Excel w i th Pl ai n

Text i s done compl etel y on Intel l i gence Server. These formats contai n
onl y report data and no formatti ng i nformati on. The onl y di fference
betw een these tw o formats i s the i nternal "contai ner" that i s used.

The Mi croStrategy system performs these steps w hen exporti ng to

C SV or to Excel w i th pl ai n text:

© 2019, M icr o St r at egy In c. 78

Syst em Ad m in ist r at io n Gu id e

1. Mi croStrategy Web product recei ves the request for the export
and passes the request to Intel l i gence Server. Intel l i gence
Server takes the XML contai ni ng the report data and parses i t for
separators, headers and metri c val ues.

2. Intel l i gence Server then outputs the ti tl es of the uni ts i n the R ow

axi s. Al l these uni ts end up i n the same row of the resul t text.

3. Intel l i gence Server then outputs the ti tl e and header of one uni t
i n the C ol umn axi s.

4. R epeat step 3 unti l al l uni ts i n the C ol umn axi s are compl eted.

5. Intel l i gence Server outputs al l the headers of the R ow axi s and

al l metri c val ues one row at a ti me.

6. The fi ni shed resul t i s then passed to be output as a C SV or an

Excel fi l e, w hi ch i s then passed to the cl i ent brow ser.

Export to Excel with Formatting

Exporti ng to Excel w i th formatti ng al l ow s for reports to be exported to

an Excel fi l e and contai n the same formatti ng as show n i n the brow ser
w i ndow . The report retai ns al l cel l col ori ng, font si zes, styl es, and
other formatti ng aspects.

l To ex port to Ex c el with formatting, the c lient mac hine mus t hav e Ex c el

2000 SR-1 or later.

l To ex port to Ex c el, us ers mus t firs t s et their Ex port preferenc es by

c lic k ing Preferences , then U ser preferences , then Export , and
s elec t the Ex c el v ers ion they want to ex port to.

The Mi croStrategy system performs these steps w hen exporti ng to

Excel w i th formatti ng:

79 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

1. Mi croStrategy Web product recei ves the request for the export to
Excel and passes the request to Intel l i gence Server. Intel l i gence
Server produces an H TML document by combi ni ng the XML
contai ni ng the report data w i th the XSL contai ni ng formatti ng
i nformati on.

2. Intel l i gence Server passes the H TML document to Mi croStrategy

Web, w hi ch creates an Excel fi l e and sends i t to the brow ser.

3. U sers can then choose to vi ew the Excel fi l e or save i t

dependi ng on the cl i ent machi ne operati ng system's setti ng for
vi ew i ng Excel fi l es.

Export to PDF

Exporti ng to PD F uses Intel l i gence Server's export engi ne to create a

PD F (Portabl e D ocument Format) fi l e. PD F fi l es are vi ew ed w i th
Adobe's Acrobat reader and provi de greater pri nti ng functi onal i ty than
si mpl y pri nti ng the report from the brow ser.

Pr o cessin g Jo b s f r o m Nar r o wcast Ser ver

Mi croStrategy N arrow cast Server performs the fol l ow i ng steps to
del i ver reports to users.

For detailed information about Narrowc as t Serv er, s ee the N arrow cast
Server Getti ng Started Gui de .

Job Requests from MicroStrategy Narrowcast Server

1. A N arrow cast servi ce executi on i s tri ggered by a schedul e or

external API cal l .

2. N arrow cast Server determi nes the servi ce reci pi ents and
al l ocates w ork to Executi on Engi ne (EE) machi nes.

© 2019, M icr o St r at egy In c. 80

Syst em Ad m in ist r at io n Gu id e

3. EE machi nes determi ne personal i zed reports to be created for

each reci pi ent by usi ng reci pi ent preferences.

4. N arrow cast Server submi ts one report per user or one mul ti page
report for mul ti pl e users, dependi ng on servi ce defi ni ti on.

5. Intel l i gence Server processes the report j ob request as usual .

(See Processi ng R eport Executi on, page 62.) It then sends the
resul t back to N arrow cast Server.

6. N arrow cast Server creates formatted documents usi ng the

personal i zed report data.

7. N arrow cast Server packages documents as appropri ate for the

servi ce's del i very method, such as e-mai l , w i rel ess, and so on.

8. N arrow cast Server del i vers the i nformati on to reci pi ents by the
chosen del i very method.

Monitoring Currently Executing Jobs

The Job Moni tor i nforms you of w hat i s happeni ng w i th system tasks.
H ow ever, i t does not di spl ay detai l ed sub-steps that a j ob i s
performi ng. You can see j obs that are:

l Executi ng

l Wai ti ng i n the queue

l Wai ti ng for a user to repl y to a prompt

l C ancel i ng

l N ot compl eti ng because of an error

The Job Moni tor di spl ays w hi ch tasks are runni ng on an Intel l i gence
Server. When a j ob has compl eted i t no l onger appears i n the moni tor.
You can vi ew a j ob's i denti fi cati on number; the user w ho submi tted i t;
the j ob's status; a descri pti on of the status and the name of the report,
document, or query; and the proj ect executi ng i t.

81 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To View the Currently Executing Jobs

1. In D evel oper, l og i n to a proj ect source. You must l og i n as a

user w i th the Moni tor Jobs pri vi l ege.

2. Expand A dministration, then expand System Monitors, and

then sel ect Jobs. The j ob i nformati on di spl ays on the ri ght-hand
si de.

3. Because the Job Moni tor does not refresh i tsel f, you must
peri odi cal l y refresh i t to see the l atest status of j obs. To do thi s,
press F5.

4. To vi ew a j ob's detai l s i ncl udi ng i ts SQL, doubl e-cl i ck i t.

5. To vi ew more detai l s for al l j obs di spl ayed, ri ght-cl i ck i n the Job

Moni tor and sel ect View options. Sel ect the addi ti onal col umns
to di spl ay and cl i ck OK .

At times , y ou may s ee "Temp c lient" in the Network Addres s c olumn.

This may happen when Intelligenc e Serv er is under a heav y load and a
us er ac c es s es the lis t of av ailable projec ts . Intelligenc e Serv er c reates
a temporary s es s ion that s ubmits a job reques t for the av ailable projec ts
and then s ends the lis t to the Mic roStrategy Web c lient for dis play . This
temporary s es s ion, whic h remains open until the reques t is fulfilled, is
dis play ed as Temp c lient.

To Cancel a Job

1. Sel ect the j ob i n the Job Moni tor.

2. Press D ELETE, and then confi rm w hether you w ant to cancel the
j ob.

© 2019, M icr o St r at egy In c. 82

Syst em Ad m in ist r at io n Gu id e

Using Automated Installation Techniques

You can make i nstal l i ng the Mi croStrategy system across your
enterpri se easi er i n several w ays. They are menti oned here but more
ful l y expl ai ned i n the Instal l ati on and C onfi gurati on Gui de.

Using a Response File to Install the Product

The response fi l e i nstal l ati on al l ow s you to automate certai n aspects
of the i nstal l ati on by confi guri ng a Wi ndow s IN I-l i ke response fi l e,
cal l ed re sp on s e . i n i. Thi s opti on i s typi cal l y i mpl emented by
Ori gi nal Equi pment Manufacturer (OEM) appl i cati ons that embed
Mi croStrategy i nstal l ati ons i n other products. It can al so be
i mpl emented by IT departments that w ant to have more control over
desktop i nstal l ati ons. For more i nformati on on how to set up and use
a response fi l e, see the Instal l ati on and C onfi gurati on Gui de.

Using a Response File to Configure the Product

You can al so use a response fi l e to automate certai n aspects of the
Mi croStrategy confi gurati on. Thi s response fi l e suppl i es parameters
to the C onfi gurati on Wi zard to set up a metadata reposi tory and
stati sti cs tabl es, Intel l i gence Server, and mul ti pl e proj ect sources. For
steps on setti ng up and usi ng a response fi l e for the C onfi gurati on
Wi zard, see the Instal l ati on and C onfi gurati on Gui de.

Running a Silent Installation

Si l ent i nstal l ati ons do not present any graphi cal user i nterface (GU I).
They are typi cal l y i mpl emented by IT departments that perform
softw are di stri buti on and i nstal l ati on across the netw ork, for exampl e,
by usi ng Mi crosoft's System Management Server softw are. Thi s
i nvol ves confi guri ng a s e t u p . i s s fi l e that the Mi croStrategy
Instal l ati on Wi zard uses. For steps on setti ng up and usi ng a
setu p. is s fi l e for a si l ent Mi croStrategy i nstal l ati on, see the
Instal l ati on and C onfi gurati on Gui de.

83 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

OEMs may us e s ilent ins tallations ; howev er, it is more c ommon for
OEMs to us e a res pons e file ins tallation.

© 2019, M icr o St r at egy In c. 84

 2
SETTING U P U SER
SECURITY

© 2019, M icr o St r at egy In c. 85

Syst em Ad m in ist r at io n Gu id e

Securi ty i s a concern i n any organi zati on. The metadata and data
w arehouse may contai n sensi ti ve i nformati on that shoul d not be
vi ew ed by al l users. It i s your responsi bi l i ty as admi ni strator to make
the ri ght data avai l abl e to the ri ght users.

Mi croStrategy has a robust securi ty model that enabl es you to create

users and groups, and control w hat data they can see and w hat
obj ects they can use. The securi ty model i s covered i n the fol l ow i ng
secti ons:

l The Mi croStrategy U ser Model , page 86

l C ontrol l i ng Access to Appl i cati on Functi onal i ty, page 95

l C ontrol l i ng Access to D ata, page 121

l Mergi ng U sers or Groups, page 151

Authenti cati on, the process by w hi ch the system i denti fi es the user, i s
an i ntegral part of any securi ty model . Authenti cati ng users i s
addressed i n C hapter 3, Identi fyi ng U sers: Authenti cati on.

The MicroStrategy User Model

Thi s secti on provi des an overvi ew of w hat users and groups are i n the
system and how they can be i mported or created.

About Mi croStrategy U sers

About Mi croStrategy U ser Groups

Pri vi l eges

Permi ssi ons

C reati ng, Importi ng, and D el eti ng U sers and Groups

Moni tori ng U sers' C onnecti ons to Proj ects

86 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

About MicroStrategy Users

Li ke most securi ty archi tectures, the Mi croStrategy securi ty model i s
bui l t around the concept of a user. To do anythi ng useful w i th
Mi croStrategy, a user must be authenti cated and authori zed. The user
can then perform tasks such as creati ng obj ects or executi ng reports
and documents, and can general l y take advantage of al l the other
features of the Mi croStrategy system.

Mic roStrategy s upports a s ingle s ign-on for us ers in an enterpris e

env ironment that c ons is ts of multiple applic ations , data s ourc es , and
s y s tems . Us ers c an log in to the s y s tem onc e and ac c es s all the
res ourc es of the enterpris e s eamles s ly . For more details about
implementing s ingle s ign-on in Mic roStrategy , s ee Enabl i ng Si ngl e
Si gn-On Authenti cati on, page 212 .

U sers are defi ned i n the Mi croStrategy metadata and exi st across
proj ects. You do not have to defi ne users for every proj ect you create
i n a si ngl e metadata reposi tory.

Each user has a uni que profi l e fol der i n each proj ect. Thi s profi l e
fol der appears to the user as the "My Personal Obj ects" fol der. By
defaul t other users' profi l e fol ders are hi dden. They can be vi ew ed by,
i n the D evel oper Preferences di al og box, i n the D evel oper: Brow si ng
category, sel ecti ng the D isplay H idden Objects check box.

A dministrator i s a bui l t-i n defaul t user created w i th a new

Mi croStrategy metadata reposi tory. The Admi ni strator user has al l
pri vi l eges and permi ssi ons for al l proj ects and al l obj ects.

One of the firs t things y ou s hould do in y our Mic roStrategy ins tallation is
to c hange the pas s word for the Adminis trator us er.

© 2019, M icr o St r at egy In c. 87

Syst em Ad m in ist r at io n Gu id e

About MicroStrategy User Groups

A user group (or "group" for short) i s a col l ecti on of users and/or
subgroups. Groups provi de a conveni ent w ay to manage a l arge
number of users.

Instead of assi gni ng pri vi l eges, such as the abi l i ty to create reports,
to hundreds of users i ndi vi dual l y, you may assi gn pri vi l eges to a
group. Groups may al so be assi gned permi ssi ons to obj ects, such as
the abi l i ty to add reports to a fol der.

In addition to hav ing priv ileges of their own, s ubgroups alway s inherit
the priv ileges from their parent groups .

For a l i st of the pri vi l eges assi gned to each group, see the Li st of
Pri vi l eges secti on.

Do not modify the priv ileges for an out-of-the-box us er group. During

upgrades to newer v ers ions of Mic roStrategy , the priv ileges for the out-
of-the-box us er groups are ov erwritten with the default priv ileges .
Ins tead, y ou s hould c opy the us er group y ou need to modify and mak e
c hanges to the c opied v ers ion.

Th e Ever yo n e Gr o u p
Al l users except for guest users are automati cal l y members of the
Everyone group. The Everyone group i s provi ded to make i t easy for
you to assi gn pri vi l eges, securi ty rol e membershi ps, and permi ssi ons
to al l users.

When a projec t is upgraded from Mic roStrategy v ers ion 7.5.x or earlier
to v ers ion 9.x , the Us e Dev eloper priv ilege is automatic ally granted to
the Ev ery one group. This ens ures that all us ers who were able to
ac c es s Dev eloper in prev ious v ers ions c an c ontinue to do s o.

88 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Au t h en t icat io n -Relat ed Gr o u p s
These groups are provi ded to assi st you i n managi ng the di fferent
w ays i n w hi ch users can l og i nto the Mi croStrategy system. For
detai l s on the di fferent authenti cati on methods, see C hapter 3,
Identi fyi ng U sers: Authenti cati on.

l Public/Guest: The Publ i c group provi des the capabi l i ty for

anonymous l ogi ns and i s used to manage the access ri ghts of guest
users. If you choose to al l ow anonymous authenti cati on, each guest
user assumes the profi l e defi ned by the Publ i c group. For more
i nformati on about anonymous authenti cati on and the Publ i c/Guest
group, see Impl ementi ng Anonymous Authenti cati on, page 169.

l 3rd Party U sers: U sers w ho access Mi croStrategy proj ects through

thi rd-party (OEM) softw are.

l LD A P U sers: The group i nto w hi ch users that are i mported from an

LD AP server are added.

l LD A P Public/Guest: Thi s group i s for LD AP anonymous l ogi n. It

behaves l i ke the Publ i c/Guest group, except that i t i s for LD AP
anonymous l ogi n. When an LD AP anonymous user l ogs i n, i t i s
authori zed w i th the pri vi l eges and access ri ghts of LD AP
Publ i c/Guest and Publ i c/Guest.

For information on integrating LDAP with Mic roStrategy , s ee

Impl ementi ng LD AP Authenti cati on, page 171 .

l Warehouse U sers: U sers w ho access a proj ect through a

w arehouse connecti on.

Gr o u p s Co r r esp o n d in g t o Pr o d u ct Of f er in gs
These groups are bui l t-i n groups that correspond to the l i censes you
have purchased. U si ng these groups gi ves you a conveni ent w ay to
assi gn product-speci fi c pri vi l eges.

© 2019, M icr o St r at egy In c. 89

Syst em Ad m in ist r at io n Gu id e

l A rchitect: Archi tects functi on as proj ect desi gners and can create
attri butes, facts, hi erarchi es, proj ects, and so on.

l A nalyst: Anal ysts have the pri vi l eges to execute si mpl e reports,
answ er prompts, dri l l on reports, format reports, create reports by
mani pul ati ng R eport Obj ects, create deri ved metri cs, modi fy vi ew
fi l ter, pi vot reports, create page by, and sort usi ng advanced
opti ons.

l D eveloper: D evel opers can desi gn new reports from scratch, and
create report components such as consol i dati ons, custom groups,
data marts, documents, dri l l maps, fi l ters, metri cs, prompts, and
templ ates.

l Web R eporter: Web R eporters can vi ew schedul ed reports and

i nteracti vel y sl i ce and di ce them. They can al so use the pri nti ng,
exporti ng, and e-mai l subscri pti on features.

l Web A nalyst: Web Anal ysts can create new reports w i th basi c
report functi onal i ty, and use ad hoc anal ysi s from Intel l i gent C ubes
w i th i nteracti ve, sl i ce and di ce OLAP.

l Web Professional: Web Professi onal users have the maxi mum
access to Mi croStrategy Web functi onal i ty. They can create
Intel l i gent C ubes and reports for users, w i th ful l reporti ng, ad hoc,
and OLAP capabi l i ti es w i th seaml ess R OLAP anal ysi s.

Ad min ist r at o r Gr o u p s
l System Monitors: The System Moni tors groups provi de an easy
w ay to gi ve users basi c admi ni strati ve pri vi l eges for al l proj ects i n
the system. U sers i n the System Moni tors groups have access to the
vari ous moni tori ng and admi ni strati ve moni tori ng tool s

l System A dministrators: The System Admi ni strators group i s a

group w i thi n the System Moni tors group. It provi des al l the

90 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

capabi l i ti es of the System Moni tors group pl us the abi l i ty to modi fy

confi gurati on obj ects such as database i nstances, and so on.

Privileges
Pri vi l eges al l ow users to access and w ork w i th vari ous functi onal i ty
w i thi n the softw are. Al l users created i n the Mi croStrategy system are
assi gned a set of pri vi l eges by defaul t.

For detai l ed i nformati on about pri vi l eges, i ncl udi ng how to assi gn
pri vi l eges to a user or group, see C ontrol l i ng Access to Functi onal i ty:
Pri vi l eges, page 109. For a l i st of al l user and group pri vi l eges i n
Mi croStrategy, see the Li st of Pri vi l eges secti on.

To see w hi ch users are usi ng certai n pri vi l eges, use the Li cense
Manager. See U si ng Li cense Manager, page 375.

To View a User's Privileges

1. In D evel oper, l og i n to a proj ect source. You must l og i n as a

user w i th the C reate And Edi t U sers And Groups pri vi l ege.

2. Expand A dministration, then U ser Manager, and then the group

contai ni ng the user.

3. R i ght-cl i ck the user and sel ect Grant access to projects. The
U ser Edi tor opens to the Proj ect Access di al og box. The
pri vi l eges that the user has for each proj ect are l i sted, as w el l as
the source of those pri vi l eges (i nherent to user, i nheri ted from a
group, or i nheri ted from a securi ty rol e).

Permissions
Permi ssi ons al l ow users to i nteract w i th vari ous obj ects i n the
Mi croStrategy system. Al l users created i n the Mi croStrategy system
have certai n access ri ghts to certai n obj ects by defaul t.

© 2019, M icr o St r at egy In c. 91

Syst em Ad m in ist r at io n Gu id e

Permis s ions differ from priv ileges in that permis s ions res tric t or allow
ac tions related to a s ingle objec t, while priv ileges res tric t or allow
ac tions ac ros s all objec ts in a projec t.

For detai l ed i nformati on about permi ssi ons, i ncl udi ng how to assi gn
permi ssi ons for an obj ect to a user or group, see C ontrol l i ng Access
to Obj ects: Permi ssi ons, page 95.

To View the Permissions for an Object

1. From w i thi n D evel oper, ri ght-cl i ck the obj ect and sel ect
Properties.

2. Expand the Security category.

Creating, Importing, and Deleting Users and Groups

It i s possi bl e to create users i ndi vi dual l y usi ng the U ser Manager
i nterface i n D evel oper, or usi ng C ommand Manager (for a detai l ed
expl anati on of how to use C ommand Manager, i ncl udi ng exampl es,
see C hapter 15, Automati ng Admi ni strati ve Tasks w i th C ommand
Manager). You can al so i mport users and groups from a text fi l e, from
a Wi ndow s user di rectory, or from an LD AP di rectory.

To Create a New User with the User Editor in Developer

1. In D evel oper, l og i n to a proj ect source. You must l og i n as a

user w i th the C reate And Edi t U sers And Groups pri vi l ege.

2. Expand A dministration, then U ser Manager, and then a group

that you w ant the new user to be a member of. If you do not w ant
the user to be a member of a group, sel ect Everyone.

3. Go to File > N ew > U ser.

92 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

4. Speci fy the user i nformati on for each category i n the edi tor.

The us er login ID is limited to 50 c harac ters .

To Delete a User

If a Narrowc as t us er ex is ts that inherits authentic ation from the us er

that y ou are deleting, y ou mus t als o remov e the authentic ation definition
from that Narrowc as t us er. For ins truc tions , s ee the Mi croStrategy
N arrow cast Server Admi ni strati on Gui de .

1. In D evel oper, l og i n to a proj ect source. You must l og i n as a

user w i th the C reate And Edi t U sers And Groups pri vi l ege.

2. Expand A dministration, then U ser Manager, and then brow se to

the group contai ni ng the user.

3. Sel ect the user and press D elete.

4. C l i ck OK .

5. C l i ck N o. The fol der and i ts contents remai n on the system and

ow nershi p i s assi gned to Admi ni strator. You may l ater assi gn
ow nershi p and access control l i sts for the fol der and i ts contents
to other users.

6. C l i ck Yes and the fol der and al l of i ts contents are del eted.

Monitoring Users' Connections to Projects

When a user connects to a proj ect, a user connecti on i s establ i shed.
You may w ant to see a l i st of al l users connected to proj ects w i thi n a
proj ect source. The U ser C onnecti on Moni tor di spl ays a l i st of al l
connecti ons and al l ow s you to di sconnect a user.

© 2019, M icr o St r at egy In c. 93

Syst em Ad m in ist r at io n Gu id e

To View the Active User Connections

1. In D evel oper, l og i n to a proj ect source. You must l og i n as a

user w i th the Moni tor U ser C onnecti ons pri vi l ege.

2. Go to A dministration > System Monitors > U ser C onnections.

The user connecti on i nformati on di spl ays on the ri ght-hand si de.
For each user, there i s one connecti on for each proj ect the user
i s l ogged i n to, pl us one connecti on for < S e r v e r > i ndi cati ng
that the user i s l ogged i n to the proj ect source.

l Scheduler : Connec tions made by Intelligenc e Serv er to

proc es s s c heduled reports or doc uments appear as
<S c h e d u l e r > in the Network Addres s c olumn. Sc heduler
s es s ions c annot be manually dis c onnec ted as des c ribed abov e.
Howev er, thes e s es s ions will be remov ed automatic ally by
Intelligenc e Serv er when the us er s es s ion idle time out v alue is
reac hed.

l Temp client : At times , y ou may s ee "Temp c lient" in the

Network Addres s c olumn. This may happen when Intelligenc e
Serv er is under a heav y load and a us er ac c es s es the Projec ts
or Home page in Mic roStrategy Web (the pages that dis play the
lis t of av ailable projec ts ). Intelligenc e Serv er c reates a
temporary s es s ion that s ubmits a job reques t for the av ailable
projec ts and then s ends the lis t to the Mic roStrategy Web c lient
for dis play . This temporary s es s ion, whic h remains open until
the reques t is fulfilled, is dis play ed as "Temp c lient."

3. To vi ew a connecti on's detai l s, doubl e-cl i ck i t.

To Disconnect a User

1. In the U ser C onnecti on Moni tor, sel ect the connecti on.

2. Press D elete.

94 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

If y ou dis c onnec t us ers from the projec t s ourc e (the <Configuration>

entry in the Us er Connec tion Monitor), they are als o dis c onnec ted from
any projec ts they were c onnec ted to.

Controlling Access to Application Functionality

Access control governs the resources that an authenti cated user can
read, modi fy, or w ri te. In addi ti on to control l i ng access to data (see
C ontrol l i ng Access to D ata, page 121), you must al so control access
to appl i cati on functi onal i ty, such as the abi l i ty to create reports or
w hi ch reports are vi ew abl e. The Mi croStrategy system provi des a ri ch
set of functi onal i ty for access control w i thi n Intel l i gence Server:

Controlling Access to Objects: Permissions

Permi ssi ons defi ne the degree of control users have over i ndi vi dual
obj ects i n the system. For exampl e, i n the case of a report, a user may
have permi ssi on to vi ew the report defi ni ti on and execute the report,
but not to modi fy the report defi ni ti on or del ete the report.

Whi l e pri vi l eges are assi gned to users (ei ther i ndi vi dual l y, through
groups, or w i th securi ty rol es), permi ssi ons are assi gned to obj ects.
More preci sel y, each obj ect has an Access C ontrol Li st (AC L) that
speci fi es w hi ch permi ssi ons di fferent sets of users have on that
obj ect.

Intelligenc e Serv er inc ludes s pec ial priv ileges c alled By pas s All Objec t
Sec urity Ac c es s Chec k s and By pas s Sc hema Objec t Sec urity Ac c es s
Chec k s . Us ers with thes e priv ileges are not res tric ted by ac c es s c ontrol
permis s ions and are c ons idered to hav e full c ontrol ov er all objec ts and
s c hema objec ts , res pec tiv ely . For information about priv ileges , s ee
C ontrol l i ng Access to Functi onal i ty: Pri vi l eges, page 109 .

© 2019, M icr o St r at egy In c. 95

Syst em Ad m in ist r at io n Gu id e

To Modify Permissions for an Object in Developer

1. In D evel oper, ri ght-cl i ck the obj ect and sel ect Properties.

To modify an objec t's ACL, y ou mus t ac c es s the Properties dialog

box direc tly from Dev eloper. If y ou ac c es s the Properties dialog
box from within an editor, y ou c an v iew the objec t's ACL but c annot
mak e any c hanges .

2. Sel ect the Security category.

3. For the U ser or Group (cl i ck A dd to sel ect a new user or group),
from the Object drop-dow n l i st, sel ect the predefi ned set of
permi ssi ons, or sel ect C ustom to defi ne a custom set of
permi ssi ons. If the obj ect i s a fol der, you can al so assi gn
permi ssi ons to obj ects contai ned i n that fol der usi ng the
C hildren drop-dow n l i st.

4. C l i ck OK .

To Modify Permissions for an Object in MicroStrategy Web

1. In Mi croStrategy Web, ri ght-cl i ck an obj ect and sel ect Share.

2. To modi fy permi ssi ons for a user or group, from the Permission
Level drop-dow n l i st for that user or group, sel ect the predefi ned
set of permi ssi ons, or sel ect C ustom to defi ne a custom set of
permi ssi ons.

3. To add new users or groups to the obj ect's access control l i st

(AC L):

l C l i ck C hoose U sers/Groups.

l Sel ect the users or groups that you w ant to add to the obj ect's
AC L.

96 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l From the C hoose a Permission Level drop-dow n l i st, sel ect

the predefi ned set of permi ssi ons, or sel ect C ustom to defi ne a
custom set of permi ssi ons.

l C l i ck A dd.

4. To remove a user or group from the obj ect's AC L, cl i ck the X next

to the user or group's name.

5. When you are fi ni shed modi fyi ng the obj ect's permi ssi ons, cl i ck
OK .

Access Co n t r o l List (ACL)

The Access C ontrol Li st (AC L) of an obj ect i s a l i st of users and
groups, and the access permi ssi ons that each has for the obj ect.

For exampl e, for the N ortheast R egi on Sal es report you can speci fy
the fol l ow i ng permi ssi ons:

l The Managers and Executi ve user groups have Vi ew access to the

report.

l The D evel opers user group (peopl e w ho create and modi fy your
appl i cati ons) has Modi fy access.

l The Admi ni strators user group has Ful l C ontrol of the report.

l The Everyone user group (any user not i n one of the other groups)
shoul d have no access to the report at al l , so you assi gn the D eni ed
Al l permi ssi on groupi ng.

The defaul t AC L of a new l y created obj ect has the fol l ow i ng

characteri sti cs:

l The ow ner (the user w ho created the obj ect) has Ful l C ontrol
permi ssi on.

© 2019, M icr o St r at egy In c. 97

Syst em Ad m in ist r at io n Gu id e

l Permi ssi ons for al l other users are set accordi ng to the C hildren
AC L of the parent fol der.

Newly c reated folders inherit the s tandard ACLs of the parent folder.
They do not inherit the C hildren ACL.

l When c reating new s c hema objec ts , if the Ev ery one us er group is not
defined in the ACL of the parent folder, Dev eloper will add the
Ev ery one us er group to the ACL of the new s c hema objec t, and s et
the permis s ions to Cus tom. If the Ev ery one us er group has
permis s ions already as s igned in the parent folder ACL, they will be
inherited properly .

For ex ample, if the C hildren s etting of the parent folder's ACL

inc ludes Full Control permis s ion for the Adminis trator and View
permis s ion for the Ev ery one group, then the newly c reated objec t
ins ide that folder will hav e Full Control permis s ion for the owner, Full
Control for the Adminis trator, and View permis s ion for Ev ery one.

l When y ou hav e a us er group belongs to another us er group, granting

one group permis s ions and deny ing the other any permis s ions will
c aus e both groups to hav e the Denied All permis s ion.

For ex ample, group A belongs to group B. If the ACL on Objec t A for

group A is as s igned Full Control and the ACL on Objec t A for Group B
is Deny All, then the res olv ed ACL on Us er A is Deny All.

l Modify ing the ACL of a s hortc ut objec t does not modify the ACL of that
s hortc ut's parent objec t.

l When y ou mov e an objec t to a different folder, the mov ed objec t

retains its original ACLs until y ou c los e and reopen the projec t in
Dev eloper. Us ing Save A s to mov e an objec t to a new folder will
update the ACLs for all objec ts ex c ept metric s . When editing or
mov ing a metric , y ou s hould c opy the objec t and plac e the c opy in a
new folder s o the c opied objec t inherits its ACL from the C hildren
ACL of the folder into whic h it is c opied.

98 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Wh at Per missio n s Can b e Gr an t ed f o r an Ob ject ?

When you edi t an obj ect's AC L usi ng the obj ect's Properti es di al og
box, you can assi gn a predefi ned groupi ng of permi ssi ons or you can
create a custom groupi ng. The tabl e bel ow l i sts the predefi ned
groupi ngs and the speci fi c permi ssi ons each one grants.

Pe r mis s ions
Gr ouping De s c r iption
gr a nte d

• B rowse
Grant s permission t o access t he object f or viewing • Read
V iew only, and t o provide t ranslat ions f or an object 's name
and descript ion. • Use

• E xecut e

• B rowse

• Read

• Writ e
Modif y Grant s permission t o view and/ or modif y t he object .
• Delet e

• Use

• E xecut e

Cont rol and

Grant s all permissions f or t he object and also allows all ot her
Full Cont rol
t o modif y t he A CL f or t he object . permissions
are grant ed

E xplicit ly denies all permissions f or t he object . None none; all

Denied A ll
of t he permissions are assigned. are denied

Neit her grant s nor denies permissions. A ll

Def ault permissions are inherit ed f rom t he groups t o which none
t he user or group belongs.

A llows t he user or group t o have a cust om cust om

Cust om
combinat ion of permissions t hat you can def ine. choice

© 2019, M icr o St r at egy In c. 99

Syst em Ad m in ist r at io n Gu id e

Pe r mis s ions
Gr ouping De s c r iption
gr a nte d

Consume
• B rowse
(Only (I nt elligent Cube only) Grant s permission t o creat e
available in • Read
and execut e report s based on t his I nt elligent Cube.
MicroS t rat egy • Use
Web)

A dd • B rowse
(I nt elligent Cube only) Grant s permission t o creat e
(Only and execut e report s based on t his I nt elligent Cube, • Read
available in and republish/ re-execut e t he I nt elligent Cube t o • Use
MicroS t rat egy updat e t he dat a.
Web) • E xecut e

• B rowse

Collaborat e • Read
(I nt elligent Cube only) Grant s permission t o creat e
(Only and execut e report s based on t his I nt elligent Cube, • Writ e
available in republish/ re-execut e t he I nt elligent Cube t o updat e • Delet e
MicroS t rat egy t he dat a, and modif y t he I nt elligent Cube.
Web) • Use

• E xecut e

The permi ssi ons actual l y assi gned to the user or group w hen you
sel ect a permi ssi on groupi ng are expl ai ned i n the tabl e bel ow .

Pe r mis s ion De finition

B rowse V iew t he object in Developer and MicroS t rat egy Web

V iew t he object 's def init ion in t he appropriat e edit or, and view t he
object 's access cont rol list . When applied t o a language object , allows
Read
users t o see t he language in t he Translat ion E dit or but not edit st rings
f or t his language.

Writ e Modif y t he object 's def init ion in t he appropriat e edit or and creat e new

100 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Pe r mis s ion De finition

object s in t he parent object . For example, add a new met ric in a report
or add a new report t o a document .

Delet e Delet e t he object

Cont rol Modif y t he object 's access cont rol list

Use t he object when creat ing or modif ying ot her object s. For example,
t he Use permission on a met ric allows a user t o creat e a report
cont aining t hat met ric. For more inf ormat ion, see Permissions and
R eport/D oc ument Ex ec ution, page 106 . When applied t o a language
object , allows users t o edit and save t ranslat ions, and t o select t he
language f or display in t heir Developer or MicroS t rat egy Web language
Use
pref erences. This permission is checked at design t ime, and when
execut ing report s against an I nt elligent Cube.

A user wit h Use but not E xecut e permission f or an I nt elligent Cube

can creat e and execut e report s t hat use t hat I nt elligent Cube, but
cannot publish t he I nt elligent Cube.

E xecut e report s or document s t hat ref erence t he object . To execut e a

report or document , a user must have E xecut e access t o all object s on
t he report / document . For more inf ormat ion, see Permiss ions and
R eport/D oc ument Ex ec ution, page 106 . This permission is checked at
E xecut e
run t ime.

The user must have Use permission on an I nt elligent Cube t o

execut e report s against t hat I nt elligent Cube.

When y ou giv e us ers only Brows e ac c es s to a folder, us ing the Cus tom
permis s ions , they c an s ee that folder dis play ed, but c annot s ee a lis t of
objec ts within the folder. Howev er, if they perform a s earc h, and objec ts
within that folder matc h the s earc h c riteria, they c an s ee thos e objec ts .
To deny a us er the ability to s ee objec ts within a folder, y ou mus t deny
all ac c es s direc tly to the objec ts in the folder.

© 2019, M icr o St r at egy In c. 101

Syst em Ad m in ist r at io n Gu id e

For exampl e, grant the Brow se permi ssi on to a fol der, but
assi gn D eni ed Al l for the fol der's chi l dren obj ects, then sel ect
the A pply changes in permissions to all children objects
check box. Thi s al l ow s a user to see the fol der, but nothi ng
i nsi de i t. Al ternati vel y, i f you assi gn D eni ed Al l to the fol der
and to i ts chi l dren, the user cannot see the fol der or any of i ts
contents.

Per missio n s f o r Ser ver Go ver n in g an d Co n f igu r at io n

A server obj ect i s a confi gurati on-l evel obj ect i n the metadata cal l ed
Server D efi ni ti on. It contai ns governi ng setti ngs that appl y at the
server l evel , a l i st of proj ects regi stered on the server, connecti on
i nformati on to the metadata reposi tory, and so on. It i s created or
modi fi ed w hen a user goes through the C onfi gurati on Wi zard. Server
defi ni ti on obj ects are not di spl ayed i n the i nterface i n the same w ay
other obj ects are (reports, metri cs, and so on).

As w i th other obj ects i n the system, you can create an AC L for a

server obj ect that determi nes w hat system admi ni strati on permi ssi ons
are assi gned to w hi ch users. These permi ssi ons are di fferent from the
ones for other obj ects (see tabl e bel ow ) and determi ne w hat
capabi l i ti es a user has for a speci fi c server. For exampl e, you can
confi gure a user to act as an admi ni strator on one server, but as an
ordi nary user on another. To do thi s, you must modi fy the AC L for
each server defi ni ti on obj ect by ri ght-cl i cki ng the A dministration
i con, sel ecti ng Properties, and then sel ecti ng the Security tab.

The tabl e bel ow l i sts the groupi ngs avai l abl e for server obj ects, the
permi ssi ons each one grants, and the tasks each al l ow s you to
perform on the server.

102 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Gr ouping Pe r mis s ions Gr a nte d Allows y ou to...

Connect l B rowse Connect t o t he server

l V iew server def init ion

l B rowse propert ies
Monit oring
l Read l V iew st at ist ics set t ings

l Use t he syst em monit ors

l S t art / st op t he server

l A pply runt ime set t ings

l Updat e diagnost ics at runt ime

l Cancel jobs

l B rowse l I dle/ resume a project

l Read l Disconnect user

A dminist rat ion
l Use l S chedule report s

l E xecut e l Delet e schedules

l Trigger event s

l P erf orm cache administ rat ion

l Creat e securit y f ilt ers

l Use S ecurit y Filt er Manager

l B rowse l Change server def init ion

propert ies
l Read
l Change st at ist ics set t ings
Conf igurat ion l Writ e
l Delet e server def init ion
l Delet e
l Grant server right s t o ot her
l Cont rol users

A ll permissions t hat are

Def ault P erf orm any t ask on t hat server.
assigned t o " Def ault "

P erf orm t he t asks your cust om

Cust om. . . cust om choice
select ions allow.

© 2019, M icr o St r at egy In c. 103

Syst em Ad m in ist r at io n Gu id e

Ho w Per missio n s ar e Det er min ed

A user can have permi ssi ons for a gi ven obj ect from the fol l ow i ng
sources:

l U ser i denti ty: The user i denti ty i s w hat determi nes an obj ect's
ow ner w hen an obj ect i s created. The user i denti ty al so determi nes
w hether the user has been granted the ri ght to access a gi ven
obj ect.

l Group membershi p: A user i s granted access to an obj ect i f they

bel ong to a group w i th access to the obj ect.

l Speci al pri vi l eges: A user may possess a speci al pri vi l ege that
causes the normal access checks to be bypassed:

l Bypass Schema Obj ect Securi ty Access C hecks al l ow s the user to

i gnore the access checks for schema obj ects.

l Bypass Al l Obj ect Securi ty Access C hecks al l ow s the user to

i gnore the access checks for al l obj ects.

Permission Levels

A user can have permi ssi ons di rectl y assi gned to an obj ect, and be a
member of one or more groups that have a di fferent permi ssi on
groupi ng assi gned to the obj ect. In thi s case, user-l evel permi ssi ons
overri de group-l evel permi ssi ons, and permi ssi ons that are deni ed at
the user or group l evel overri de permi ssi ons that are granted at that
l evel . The l i st bel ow i ndi cates w hat permi ssi ons are granted w hen
permi ssi ons from mul ti pl e sources confl i ct.

1. Permi ssi ons that are di rectl y deni ed to the user are al w ays
deni ed.

2. Permi ssi ons that are di rectl y granted to the user, and not di rectl y
deni ed, are al w ays granted.

104 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

3. Permi ssi ons that are deni ed by a group, and not di rectl y granted
to the user, are deni ed.

4. Permi ssi ons that are granted by a group, and not deni ed by
another group or di rectl y deni ed, are granted.

5. Any permi ssi ons that are not granted, ei ther di rectl y or by a
group, are deni ed.

For exampl e, user Jane does not have any permi ssi ons di rectl y
assi gned for a report. H ow ever, Jane i s a member of the D esi gners
group, w hi ch has Ful l C ontrol permi ssi ons for that report, and i s al so
a member of the Managers group, w hi ch has D eni ed Al l permi ssi ons
for that report. In thi s case, Jane i s deni ed al l permi ssi ons for the
report. If Jane i s l ater di rectl y granted Vi ew permi ssi ons for the report,
she w oul d have Vi ew permi ssi ons onl y.

Default Permissions for Folders in a New Project

By defaul t, i n a new Mi croStrategy proj ect, users are onl y al l ow ed to

save obj ects w i thi n thei r personal fol ders. Onl y admi ni strati ve users
can save obj ects w i thi n the Publ i c Fol der di rectory i n a Mi croStrategy
proj ect. Fol ders i n a new proj ect are created w i th these defaul t AC Ls:

l Publ i c Obj ects fol der, Schema Obj ects fol der

l Admi ni strator: Ful l C ontrol

l Everyone: Brow se

l Publ i c/Guest: Brow se

l Inheri ted AC L

l Admi ni strator: D efaul t

l Everyone: Vi ew

© 2019, M icr o St r at egy In c. 105

Syst em Ad m in ist r at io n Gu id e

l Publ i c/Guest: Vi ew

This means that new us ers , as part of the Ev ery one group, are able
to brows e the objec ts in the Public Objec ts folder, v iew their
definitions and us e them in definitions of other objec ts (for ex ample,
c reate a report with a public metric ), and ex ec ute them (ex ec ute
reports ). Howev er, new us ers c annot delete thes e objec ts , or c reate
or s av e new objec ts to thes e folders .

l Personal fol ders

l Ow ner: Ful l C ontrol

This means that new us ers c an c reate objec ts in thes e folders and
hav e full c ontrol ov er thos e objec ts .

Per missio n s an d Rep o r t / Do cu men t Execu t io n

Tw o permi ssi ons rel ate to report and document executi on: the U se
and Execute permi ssi ons. These have the fol l ow i ng effects:

l The U se permi ssi on al l ow s the user to reference or use the obj ect
w hen they are modi fyi ng another obj ect. Thi s permi ssi on i s checked
at obj ect desi gn ti me, and w hen executi ng reports agai nst an
Intel l i gent C ube.

l The Execute permi ssi on al l ow s the user to execute reports or

documents that use the obj ect. Thi s permi ssi on i s checked onl y at
report/document executi on ti me.

A user may have four di fferent l evel s of access to an obj ect usi ng
these tw o new permi ssi ons:

l Both U se and Execute permi ssi ons: The user can use the obj ect to
create new reports, and can execute reports contai ni ng the obj ect.

106 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Execute permi ssi on onl y: The user can execute previ ousl y created
reports contai ni ng the obj ect, but cannot create new reports that use
the obj ect. If the obj ect i s an Intel l i gent C ube, the user cannot
execute reports agai nst that Intel l i gent C ube.

l U se permi ssi on onl y: The user can create reports usi ng the obj ect,
but cannot execute those reports.

A us er with Brows e, Read, and Us e (but not Ex ec ute) permis s ions for
an Intelligent Cube c an c reate and ex ec ute reports that us e that
Intelligent Cube, but c annot publis h the Intelligent Cube.

l N ei ther U se nor Execute permi ssi on: The user cannot create reports
contai ni ng the obj ect, nor can the user execute such reports, even i f
the user has Execute ri ghts on the report.

Interpreting Access Rights During Report/Document Execution

The abi l i ty to execute a report or document i s determi ned by w hether

the user has Execute permi ssi on on the report and Execute
permi ssi on on the obj ects used to defi ne that report. More
speci fi cal l y, Execute permi ssi on i s requi red on al l attri butes, custom
groups, consol i dati ons, prompts, metri cs, facts, fi l ters, templ ates, and
hi erarchi es used to defi ne the report or document. Permi ssi ons are
not checked on transformati ons and functi ons used to defi ne the
report.

If the user does not have access to an attri bute, custom group,
consol i dati on, prompt, fact, fi l ter, templ ate, or hi erarchy used to
defi ne a report, the report executi on fai l s.

If the user does not have access to a metri c used to defi ne a report,
the report executi on conti nues, but the metri c i s not di spl ayed i n the
report for that user.

Thi s enhancement al l ow s a fi ner l evel of access control w hen

executi ng reports. The same report can be depl oyed to many users

© 2019, M icr o St r at egy In c. 107

Syst em Ad m in ist r at io n Gu id e

w ho experi ence di fferent resul ts dependi ng on thei r respecti ve

permi ssi ons on metri cs.

ACLs an d Per so n alized Dr ill Pat h s in Micr o St r at egy Web

You can control w hat attri bute dri l l paths users see on reports. You
can determi ne w hether users can see al l dri l l paths for an attri bute, or
onl y those to w hi ch they have access. You determi ne thi s access
usi ng the Enable Web personalized drill paths check box i n the
Proj ect C onfi gurati on Edi tor, Project D efinition: D rilling category. (In
D evel oper, ri ght-cl i ck a proj ect and sel ect Project C onfiguration.)

Wi th the Enable Web personalized drill paths check box cl eared

(and thus, XML cachi ng enabl ed), the attri butes to w hi ch al l users i n
Mi croStrategy Web can dri l l are stored i n a report's XML cache. In thi s
case, users see al l attri bute dri l l paths w hether they have access to
them or not. When a user sel ects an attri bute dri l l path, Intel l i gence
Server then checks w hether the user has access to the attri bute. If the
user does not have access (for exampl e, because of Access C ontrol
Li sts), the dri l l i s not performed and the user sees an error message.

Al ternati vel y, i f you sel ect the Enable Web personalized drill paths
check box, at the ti me the report resul ts are created (not at dri l l ti me),
Intel l i gence Server checks w hi ch attri butes the user may access and
creates the report XML w i th onl y the al l ow ed attri butes. Thi s w ay, the
users onl y see thei r avai l abl e dri l l paths, and they cannot attempt a
dri l l acti on that i s not al l ow ed. Wi th thi s opti on enabl ed, you may see
performance degradati on on Intel l i gence Server. Thi s i s because i t
must create XML for each report/user combi nati on rather than usi ng
XML that w as cached.

For more i nformati on about XML cachi ng, see Types of R esul t
C aches, page 864.

108 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Controlling Access to Functionality: Privileges

As di scussed earl i er i n thi s secti on, there are di fferent types of users
and groups i n the user communi ty. It i s your responsi bi l i ty as a
system admi ni strator to assi gn pri vi l eges to users and groups. They
gi ve you ful l control over the user experi ence.

Pri vi l eges gi ve users access to speci fi c Mi croStrategy functi onal i ty.

For exampl e, the C reate Metri c pri vi l ege al l ow s the user to use the
Metri c Edi tor to create a new metri c, and the Moni tor C aches pri vi l ege
al l ow s the user to vi ew cache i nformati on i n the C ache Moni tor.

There is a s pec ial priv ilege c alled By pas s All Objec t Sec urity Ac c es s
Chec k s . Us ers with this priv ilege c an ignore the ac c es s c ontrol
permis s ions and are c ons idered to hav e full c ontrol ov er all objec ts . For
information about permis s ions , s ee C ontrol l i ng Access to Obj ects:
Permi ssi ons, page 95 .

Based on thei r di fferent pri vi l eges, the users and user groups can
perform di fferent types of operati ons i n the Mi croStrategy system. If a
user does not have a certai n pri vi l ege, that user does not have access
to that pri vi l ege's functi onal i ty. You can see w hi ch users are usi ng
certai n pri vi l eges by usi ng Li cense Manager (see U si ng Li cense
Manager, page 375).

Most pri vi l eges may be granted w i thi n a speci fi c proj ect or across al l
proj ects. C ertai n admi ni strati ve pri vi l eges, such as C onfi gure Group
Membershi p, do not appl y to speci fi c proj ects and can onl y be granted
at the proj ect source l evel .

For a compl ete l i st of pri vi l eges and w hat they control i n the system,
see the Li st of Pri vi l eges secti on.

© 2019, M icr o St r at egy In c. 109

Syst em Ad m in ist r at io n Gu id e

Assign in g Pr ivileges t o User s an d Gr o u p s

Pri vi l eges can be assi gned to users and user groups di rectl y or
through securi ty rol es. The di fference i s that the former grants
functi onal i ty across al l proj ects w hi l e the l atter onl y appl y w i thi n a
speci fi ed proj ect (see D efi ni ng Sets of Pri vi l eges: Securi ty R ol es,
page 113).

To Assign Privileges to Users or Groups

1. From D evel oper U ser Manager, edi t the user w i th the U ser Edi tor
or edi t the group w i th the Group Edi tor.

2. Expand U ser D efinition or Group D efinition, and then sel ect

Project A ccess.

3. Sel ect the check boxes to grant pri vi l eges to the user or group.

R ather than assi gni ng i ndi vi dual users and groups these pri vi l eges, i t
may be easi er for you to create Securi ty R ol es (col l ecti ons of
pri vi l eges) and assi gn them to users and groups. Then you can
assi gn addi ti onal pri vi l eges i ndi vi dual l y w hen there are excepti ons.
For more i nformati on about securi ty rol es, see D efi ni ng Sets of
Pri vi l eges: Securi ty R ol es, page 113.

Assigning Privileges to Multiple Users at Once

You can grant, revoke, and repl ace the exi sti ng pri vi l eges of users,
user groups, or securi ty rol es w i th the Fi nd and R epl ace Pri vi l eges
di al og box. Thi s di al og box al l ow s you to search for the user, user
group, or securi ty rol e and change thei r pri vi l eges, dependi ng on the
tasks requi red for thei r w ork.

For exampl e, your organi zati on i s upgradi ng Fl ash on al l users'

machi nes. U nti l the ti me the Fl ash update i s compl eted, the users w i l l
not be abl e to export reports to Fl ash. You can use Fi nd and R epl ace

110 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Pri vi l eges to revoke the Export to Fl ash pri vi l ege assi gned to users,
and w hen the upgrade i s compl ete you can grant the pri vi l ege to the
users agai n.

To access the Fi nd and R epl ace Pri vi l eges di al og box, i n D evel oper,
ri ght-cl i ck the U ser Manager and sel ect Find and R eplace
Privileges.

How are Privileges Inherited?

A user's pri vi l eges w i thi n a gi ven proj ect i ncl ude the fol l ow i ng:

l Pri vi l eges assi gned di rectl y to the user (see Assi gni ng Pri vi l eges to
U sers and Groups, page 110)

l Pri vi l eges assi gned to any groups of w hi ch the user i s a member

(see About Mi croStrategy U ser Groups, page 88)

Groups als o inherit priv ileges from their parent groups .

l Pri vi l eges assi gned to any securi ty rol es that are assi gned to the
user w i thi n the proj ect (see D efi ni ng Sets of Pri vi l eges: Securi ty
R ol es, page 113)

l Pri vi l eges assi gned to any securi ty rol es that are assi gned to a
group of w hi ch the user i s a member

Pr ed ef in ed User Gr o u p s an d Pr ivileges
Mi croStrategy comes w i th several predefi ned user groups. For a
compl ete l i st and expl anati on of these groups, see About
Mi croStrategy U ser Groups, page 88. These groups possess the
fol l ow i ng pri vi l eges:

l Everyone, Publ i c/Guest, 3rd Party U sers, LD AP Publ i c/Guest, and

LD AP U sers, have no predefi ned pri vi l eges.

© 2019, M icr o St r at egy In c. 111

Syst em Ad m in ist r at io n Gu id e

l The predefi ned product-based user groups possess al l the

pri vi l eges associ ated w i th thei r correspondi ng products. For a l i st of
these groups, see About Mi croStrategy U ser Groups, page 88.

International Us ers is a member of the following produc t-bas ed

groups : Analy s t, Mobile Us er, Web Reporter, and Web Analy s t. It has
the priv ileges as s oc iated with thes e groups .

l System Moni tors and i ts member groups have pri vi l eges based on
thei r expected rol es i n the company. To see the pri vi l eges assi gned
to each group, ri ght-cl i ck the group and sel ect Grant A ccess to
Projects.

How Predefined User Groups Inherit Privileges

Several of the predefi ned user groups form hi erarchi es, w hi ch al l ow

groups to i nheri t pri vi l eges from any groups at a hi gher l evel w i thi n
the hi erarchy. These hi erarchi es are as fol l ow s:

In the case of the Mi croStrategy Web user groups, the Web Anal yst
i nheri ts the pri vi l eges of the Web R eporter. The Web Professi onal
i nheri ts the pri vi l eges of both the Web Anal yst and Web R eporter. The
Web Professi onal user group has the compl ete set of Mi croStrategy
Web pri vi l eges.

l Web R eporter

l Web Anal yst

l Web Professi onal

In the case of the Mi croStrategy D evel oper user groups, the

D evel oper i nheri ts the pri vi l eges of the Anal yst and therefore has
more pri vi l eges than the Anal ysts.

l Anal yst

l D evel oper

112 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

The vari ous System Moni tors user groups i nheri t the pri vi l eges of the
System Moni tors user group and therefore have more pri vi l eges than
the System Moni tors. Each has i ts ow n speci fi c set of pri vi l eges i n
addi ti on, that are not shared by the other System Moni tors groups.

l System Moni tors

l vari ous System Moni tors groups

Thi s group i nheri ts the pri vi l eges of the Anal yst, Mobi l e U ser, Web
R eporter, and Web Anal yst groups.

l Internati onal U sers

Defining Sets of Privileges: Security Roles

A securi ty rol e i s a col l ecti on of proj ect-l evel pri vi l eges that are
assi gned to users and groups. For exampl e, you mi ght have tw o types
of users w i th di fferent functi onal i ty needs: the Executi ve U sers w ho
need to run, sort, and pri nt reports, and the Busi ness Anal ysts w ho
need addi ti onal capabi l i ti es to dri l l and change subtotal defi ni ti ons. In
thi s case, you can create tw o securi ty rol es to sui t these tw o di fferent
types of users.

Securi ty rol es exi st at the proj ect source l evel , and can be used i n
any proj ect regi stered w i th Intel l i gence Server. A user can have
di fferent securi ty rol es i n each proj ect. For exampl e, an admi ni strator
for the devel opment proj ect may have a Proj ect Admi ni strator securi ty
rol e i n that proj ect, but the N ormal U ser securi ty rol e i n al l other
proj ects on that server.

A securi ty rol e i s fundamental l y di fferent from a user group i n the

fol l ow i ng w ays:

l A group i s a col l ecti on of users that can be assi gned pri vi l eges (or
securi ty rol es) al l at once, for the proj ect source and al l proj ects i n
i t.

© 2019, M icr o St r at egy In c. 113

Syst em Ad m in ist r at io n Gu id e

l A securi ty rol e i s a col l ecti on of pri vi l eges i n a proj ect. Those

pri vi l eges are assi gned as a set to vari ous users or groups, on a
proj ect-by-proj ect basi s.

For i nformati on about how pri vi l eges are i nheri ted from securi ty rol es
and groups, see C ontrol l i ng Access to Functi onal i ty: Pri vi l eges, page
109

Man agin g Secu r it y Ro les

The Securi ty R ol e Manager l i sts al l the securi ty rol es avai l abl e i n a
proj ect source. From thi s manager you can assi gn or revoke securi ty
rol es for users i n proj ects, or create or del ete securi ty rol es. For
addi ti onal methods of managi ng securi ty rol es, see Other Ways of
Managi ng Securi ty R ol es, page 116.

To Assign a Security Role to Users or Groups in a Project

1. In D evel oper, l og i n to the proj ect source contai ni ng the securi ty

rol e.

2. Expand A dministration, then C onfiguration Managers, and

then sel ect Security R oles.

3. D oubl e-cl i ck the securi ty rol e you w ant to assi gn to the user or
group.

4. Sel ect the Members tab.

5. From the Select a Project drop-dow n l i st, sel ect the proj ect for
w hi ch to assi gn the securi ty rol e.

6. From the drop-dow n l i st of groups, sel ect the group contai ni ng a

user or group you w ant to assi gn the securi ty rol e to. The users
or groups that are members of that group are show n i n the l i st

114 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

box bel ow the drop-dow n l i st.

l By default, us ers are not s hown in this lis t box . To v iew the us ers
as well as the groups , s elec t the Show users c hec k box .

l To as s ign a top-lev el group to a s ec urity role, from the drop-

down lis t s elec t A ll Groups .

7. Sel ect a desi red user or group.

8. C l i ck the > i con. The user or group moves to the Selected

members l i st. You can assi gn mul ti pl e users or groups to the
securi ty rol e by sel ecti ng them and cl i cki ng the > i con.

9. When you are fi ni shed assi gni ng the securi ty rol e, cl i ck OK .

To Create a Security Role

1. In D evel oper, l og i n to the proj ect source you w ant to create the
securi ty rol e i n.

2. Expand A dministration, go to C onfiguration Managers >

Security R oles.

3. From the File menu, poi nt to N ew, and sel ect Security R ole.

4. Enter a name and descri pti on for the new securi ty rol e.

5. Sel ect the Privileges tab.

6. Sel ect the pri vi l eges to add to thi s securi ty rol e. For an
expl anati on of each pri vi l ege, see the Li st of Pri vi l eges secti on.

To s elec t all priv ileges in a priv ilege group, s elec t the group.

7. To assi gn the rol e to users, sel ect the Members tab and fol l ow
the i nstructi ons i n To Assi gn a Securi ty R ol e to U sers or Groups

© 2019, M icr o St r at egy In c. 115

Syst em Ad m in ist r at io n Gu id e

i n a Proj ect, page 114.

8. C l i ck OK .

To Delete a Security Role

1. In D evel oper, l og i n the proj ect source you w ant to remove the
securi ty rol e from.

2. Expand A dministration, then C onfiguration Managers, and

then sel ect Security R oles.

3. C l i ck the securi ty rol e that you w ant to remove.

4. From the File menu sel ect D elete.

5. C l i ck Yes.

Other Ways of Managing Security Roles

You can al so assi gn securi ty rol es to a user or group i n the U ser

Edi tor or Group Edi tor. From the Project A ccess category of the
edi tor, you can speci fy w hat securi ty rol es that user or group has for
each proj ect.

You can assi gn rol es to mul ti pl e users and groups i n a proj ect
through the Proj ect C onfi gurati on di al og box. The Project A ccess -
General category di spl ays w hi ch users and groups have w hi ch
securi ty rol es i n the proj ect, and al l ow s you to re-assi gn the securi ty
rol es.

You can al so use C ommand Manager to manage securi ty rol es.

C ommand Manager i s a scri pt-based admi ni strati ve tool that hel ps
you perform compl ex admi ni strati ve acti ons qui ckl y. For speci fi c
syntax for securi ty rol e management statements i n C ommand
Manager, see Securi ty R ol e Management i n the C ommand Manager
on-l i ne hel p (from C ommand Manager, press F1, or sel ect the H elp
menu). For general i nformati on about C ommand Manager, see

116 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

C hapter 15, Automati ng Admi ni strati ve Tasks w i th C ommand

Manager.

If y ou are us ing UNIX, y ou mus t us e Command Manager to manage y our

s y s tem's s ec urity roles .

Co n t r o llin g Access t o a Pr o ject

You can deny user or group access to a speci fi c Mi croStrategy proj ect
by usi ng a securi ty rol e.

To Deny User or Group Access to a Project

1. In D evel oper, ri ght-cl i ck on the proj ect you w ant to deny access
to. Sel ect Project C onfiguration.

2. Expand the Project A ccess category.

3. In the Select a security role drop-dow n l i st, sel ect the securi ty
rol e that contai ns the user or group w ho you w ant to deny proj ect
access.

4. On the ri ght-hand si de of the Proj ect access - General di al og,

sel ect the user or group w ho you w ant to deny proj ect access.
Then cl i ck the l eft arrow to remove that user or group from the
securi ty rol e.

5. U si ng the ri ght arrow , add any users to the securi ty rol e for w hom
you w ant to grant proj ect access. To see the users contai ned i n
each group, hi ghl i ght the group and check the Show users
check box.

6. Make sure the user or group w hose access you w ant deny does
not appear i n the Selected members pane on the ri ght-hand si de
of the di al og. Then cl i ck OK .

© 2019, M icr o St r at egy In c. 117

Syst em Ad m in ist r at io n Gu id e

7. In D evel oper, under the proj ect source that contai ns the proj ect
you are restri cti ng access to, expand A dministration, then
expand U ser Manager.

8. C l i ck on the group to w hi ch the user bel ongs w ho you w ant to

deny proj ect access for. Then doubl e-cl i ck on the user i n the
ri ght-hand si de of D evel oper.

9. Expand U ser D efi ni ti on, then sel ect Proj ect Access.

10. In the Securi ty R ol e Sel ecti on row , under the proj ect you w ant to
restri ct access to, revi ew the Securi ty R ol e Sel ecti on drop-dow n
l i st. Make sure that no securi ty rol e i s associ ated w i th thi s
proj ect for thi s user.

11. C l i ck OK .

When the user attempts to l og i n to the proj ect, they recei ve the
message "N o proj ects w ere returned by thi s proj ect source."

Th e Ro le-Based Ad min ist r at io n Mo d el

Begi nni ng w i th versi on 9.0, the Mi croStrategy product sui te comes
w i th a number of predefi ned securi ty rol es for admi ni strators. These
rol es makes i t easy to del egate admi ni strati ve tasks.

For exampl e, your company securi ty pol i cy may requi re you to keep
the user securi ty admi ni strator for your proj ects separate from the
proj ect resource admi ni strator. R ather than speci fyi ng the pri vi l eges
for each admi ni strator i ndi vi dual l y, you can assi gn the Proj ect
Securi ty Admi ni strator rol e to one admi ni strator, and the Proj ect
R esource Admi ni strator to another. Because users can have di fferent
securi ty rol es for each proj ect, you can use the same securi ty rol e for
di fferent users i n di fferent proj ects to further del egate proj ect
admi ni strati on duti es.

118 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

The predefi ned proj ect admi ni strati on rol es cover every proj ect-l evel
admi ni strati ve pri vi l ege except for Bypass Al l Obj ect Securi ty Access
C hecks. N one of the rol es have any pri vi l eges i n common. For a l i st
of the pri vi l eges i ncl uded w i th each predefi ned securi ty rol e, see the
Li st of Pri vi l eges secti on.

The predefi ned admi ni strati on securi ty rol es are:

l A nalyst, w ho have authori ng capabi l i ti es.

l A nalytics A rchitect, w ho can create, publ i sh, and opti mi ze a

federated data l ayer as the enterpri se’ s si ngl e versi on of the truth.
U sers can bui l d and mai ntai n schema obj ects and abstracti on
l ayers on top of vari ous, changi ng enterpri se assests.

l A pplication A dministrator, w ho have access to al l appl i cati on-

speci fi c tasks.

l A pplication A rchitect, w ho create, share, and mai ntai n i ntel l i gence

appl i cati ons for the enterpri se.

l C ertifier, w ho can certi fy obj ects i n addi ti on to havi ng authori ng

capabi l i ti es.

l C ollaborator, w ho can vi ew and col l aborate on a dossi er or

document they have access to.

l C onsumer, w ho can onl y vi ew a dossi er or document they have

access to.

l D atabase A rchitect, w ho can opti mi ze query performance and

uti l i zati on based on query type, usage patterns, and appl i cati on
desi gn requi rements by tuni ng VLD B setti ngs or confi guri ng schema
obj ects.

l Embedded A nalytics A rchitect, w ho can i nj ect, extend, and

embed anal yti cs i nto portal s, thi rd-party, mobi l e, and w hi te-l abel l ed
appl i cati ons.

© 2019, M icr o St r at egy In c. 119

Syst em Ad m in ist r at io n Gu id e

l IntroB I, w hi ch i s used for the Mi croStrategy cl ass "Introducti on to

Enterpri se Busi ness Intel l i gence."

l Mobile A rchitect, w ho bui l ds, compi l es, depl oys, and mai ntai ns
mobi l e envi ronments and appl i cati ons. Thi s user can al so opti mi ze
the end user experi ence w hen accessi ng appl i cati ons vi a mobi l e
devi ces.

l N ortheast U sers, w hi ch i s used for the Mi croStrategy cl ass

"Introducti on to Enterpri se Busi ness Intel l i gence."

l Pl atform Admi ni strator, w ho confi gures the Intel l i gence Server,

mai ntai n the securi ty l ayer, moni tor system usage, and opti mi ze
archi tecture i n order to reduce errors, maxi mi ze upti me, and boost
performance.

l Power U sers, w hi ch have the l argest subset of pri vi l eges of any

securi ty rol e.

l Project B ulk A dministrators, w ho can perform admi ni strati ve

functi ons on mul ti pl e obj ects w i th Obj ect Manager (see C opyi ng
Obj ects Betw een Proj ects: Obj ect Manager, page 417), C ommand
Manager (see C hapter 15, Automati ng Admi ni strati ve Tasks w i th
C ommand Manager), and the Bul k R eposi tory Transl ati on Tool .

l Project Operations A dministrators, w ho can perform mai ntenance

on vari ous aspects of a proj ect.

l Project Operations Monitors, w ho can vi ew the vari ous

Intel l i gence Server moni tors but cannot make any changes to the
moni tored systems.

l Project R esource Settings A dministrators, w ho can confi gure

proj ect-l evel setti ngs.

l Project Security A dministrators, w ho create users and manage

user and obj ect securi ty.

120 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l System A dministrator, w ho sets up, mai ntai ns, moni tors, and
conti nuousl y supports the i nfrastructure envi ronment through
depl oyment on cl oud, Wi ndow s, or Li nux.

For i nstructi ons on how to assi gn these securi ty rol es to users or

groups, see Managi ng Securi ty R ol es, page 114.

Do not modify the priv ileges for an out-of-the-box s ec urity role. During
upgrades to newer v ers ions of Mic roStrategy , the priv ileges for the out-
of-the-box s ec urity roles are ov erwritten with the default priv ileges .
Ins tead, y ou s hould c opy the s ec urity role y ou need to modify and mak e
c hanges to the c opied v ers ion.

Controlling Access to Data

Access control governs the resources that an authenti cated user i s
abl e to read, modi fy, or w ri te. D ata i s a maj or resource of i nterest i n
any securi ty scheme that determi nes w hat source data a user i s
al l ow ed to access. You may be more fami l i ar w i th the terms
authenti cati on (maki ng sure the user i s w ho they say they are) and
authori zati on (maki ng sure they can access the data they are enti tl ed
to see now that I know w ho they are).

The w ays by w hi ch data access can be control l ed are di scussed

bel ow :

Controlling Access to the Database: Connection

Mappings
C onnecti on mappi ngs al l ow you to assi gn a user or group i n the
Mi croStrategy system to a l ogi n ID on the data w arehouse R D BMS.
The mappi ngs are typi cal l y used to take advantage of one of several
R D BMS data securi ty techni ques (securi ty vi ew s, spl i t fact tabl es by
row s, spl i t fact tabl es by col umns) that you may have al ready created.

© 2019, M icr o St r at egy In c. 121

Syst em Ad m in ist r at io n Gu id e

For detai l s on these techni ques, see C ontrol l i ng Access to D ata at the
D atabase (R D BMS) Level , page 147.

Wh y Use Co n n ect io n Map p in gs?

U se a connecti on mappi ng i f you need to di fferenti ate Mi croStrategy
users from each other at the data w arehouse l evel or i f you need to
di rect them to separate data w arehouses. Thi s i s expl ai ned i n more
detai l bel ow .

Fi rst i t i s i mportant to know that, as a defaul t, al l users i n a

Mi croStrategy proj ect use the same database connecti on/D SN and
database l ogi n w hen connecti ng to the database. Thi s means that al l
users have the same securi ty l evel at the data w arehouse and
therefore, securi ty vi ew s cannot be assi gned to a speci fi c
Mi croStrategy user. In thi s defaul t confi gurati on, w hen the database
admi ni strator (D BA) uses an R D BMS feature to vi ew a l i st of users
connected to the data w arehouse, al l Mi croStrategy users w oul d al l
appear w i th the same name. For exampl e, i f forty users are si gned on
to the Mi croStrategy system and runni ng j obs, the D BA sees a l i st of
forty users cal l ed "MSTR users" (or w hatever name i s speci fi ed i n the
defaul t database l ogi n). Thi s i s show n i n the di agram bel ow i n w hi ch
al l j obs runni ng agai nst the data w arehouse use the "MSTR users"
database l ogi n.

122 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Cr eat in g a Co n n ect io n Map p in g

You defi ne connecti on mappi ngs w i th the Proj ect C onfi gurati on Edi tor
i n D evel oper. To create a connecti on mappi ng, you assi gn a user or
group ei ther a database connecti on or database l ogi n that i s di fferent
from the defaul t. For i nformati on on thi s, see C onnecti ng to the D ata
Warehouse, page 23.

To Create a Connection Mapping

1. In D evel oper, l og i nto your proj ect. You must l og i n as a user

w i th admi ni strati ve pri vi l eges.

2. Go to A dministration > Projects > Project C onfiguration.

3. Expand the D atabase Instances category, and then sel ect

C onnection Mapping.

4. R i ght-cl i ck i n the gri d and sel ect N ew to create a new connecti on

mappi ng.

5. D oubl e-cl i ck the new connecti on mappi ng i n each col umn to

sel ect the database i nstance, database connecti on, database
l ogi n, and l anguage.

6. D oubl e-cl i ck the new connecti on mappi ng i n the U sers col umn.
C l i ck ... (the brow se button).

7. Sel ect the desi red user or group and cl i ck OK . That user or
group i s now associ ated w i th the connecti on mappi ng.

8. C l i ck OK .

Co n n ect io n Map p in g Examp le

One case i n w hi ch you may w ant to use connecti on mappi ngs i s i f you
have exi sti ng securi ty vi ew s defi ned i n the data w arehouse and you

© 2019, M icr o St r at egy In c. 123

Syst em Ad m in ist r at io n Gu id e

w ant to al l ow Mi croStrategy users' j obs to execute on the data

w arehouse usi ng those speci fi c l ogi n ID s. For exampl e,

l The C EO can access al l data (w arehouse l ogi n ID = "C EO")

l Al l other users have l i mi ted access (w arehouse l ogi n ID = "MSTR

users")

In thi s case, you w oul d need to create a user connecti on mappi ng

w i thi n Mi croStrategy for the C EO. To do thi s:

l C reate a new database l ogi n defi ni ti on for the C EO i n Mi croStrategy

so i t matches thei r exi sti ng l ogi n ID on the data w arehouse

l C reate the new connecti on mappi ng i n Mi croStrategy to speci fy that

the C EO user uses the new database l ogi n

Thi s i s show n i n the di agram bel ow i n w hi ch the C EO connects as

C EO (usi ng the new database l ogi n cal l ed "C EO") and al l other users
use the defaul t database l ogi n "MSTR users."

Both the CEO and all the other us ers us e the s ame projec t, databas e
ins tanc e, databas e c onnec tion (and DSN), but the databas e login is
different for the CEO.

124 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

If w e w ere to create a connecti on mappi ng i n the Mi croStrategy

Tutori al proj ect accordi ng to thi s exampl e, i t w oul d l ook l i ke the
di agram bel ow .

For i nformati on on creati ng a new database connecti on, see

C onnecti ng to the D ata Warehouse, page 23. For i nformati on on
creati ng a new database l ogi n, see C onnecti ng to the D ata
Warehouse, page 23.

C onnecti on mappi ngs can al so be made for user groups and are not
l i mi ted to i ndi vi dual users. C onti nui ng the exampl e above, i f you have
a Managers group w i thi n the Mi croStrategy system that can access
most data i n the data w arehouse (w arehouse l ogi n ID = "Managers"),
you coul d create another database l ogi n and then create another
connecti on mappi ng to assi gn i t to the Managers user group.

Another case i n w hi ch you may w ant to use connecti on mappi ngs i s i f

you need to have users connect to tw o data w arehouses usi ng the
same proj ect. In thi s case, both data w arehouses must have the same
structure so that the proj ect w orks w i th both. Thi s may be appl i cabl e i f
you have a data w arehouse w i th domesti c data and another w i th
forei gn data and you w ant users to be di rected to one or the other

© 2019, M icr o St r at egy In c. 125

Syst em Ad m in ist r at io n Gu id e

based on the user group to w hi ch they bel ong w hen they l og i n to the
Mi croStrategy system.

For exampl e, i f you have tw o user groups such that:

l "U S users" connect to the U .S. data w arehouse (data w arehouse

l ogi n ID "MSTR users")

l "Europe users" connect to the London data w arehouse (data

w arehouse l ogi n ID "MSTR users")

In thi s case, you w oul d need to create a user connecti on mappi ng

w i thi n Mi croStrategy for both user groups. To do thi s, you w oul d:

l C reate tw o database connecti ons i n Mi croStrategy—one to each

data w arehouse (thi s assumes that D SN s al ready exi st for each
data w arehouse)

l C reate tw o connecti on mappi ngs i n the Mi croStrategy proj ect that

l i nk the groups to the di fferent data w arehouses vi a the tw o new
database connecti on defi ni ti ons

Thi s i s show n i n the di agram bel ow .

126 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

The projec t, databas e ins tanc e, and databas e login c an be the s ame, but
the c onnec tion mapping s pec ifies different databas e c onnec tions (and
therefore, different DSNs ) for the two groups .

Linking Database Users and MicroStrategy Users:

Passthrough Execution
You can l i nk a Mi croStrategy user to an R D BMS l ogi n ID usi ng the
U ser Edi tor (on the Authenti cati on tab, speci fy the Warehouse Login
and Password) or usi ng C ommand Manager. Thi s l i nk i s requi red for
database w arehouse authenti cati on (see Impl ementi ng D atabase
Warehouse Authenti cati on, page 336) but w orks for other
authenti cati on modes as w el l .

You can confi gure each proj ect to use ei ther connecti on mappi ngs
and/or the l i nked w arehouse l ogi n ID w hen users execute reports,
documents, or brow se attri bute el ements. If passthrough executi on i s

© 2019, M icr o St r at egy In c. 127

Syst em Ad m in ist r at io n Gu id e

enabl ed, the proj ect uses the l i nked w arehouse l ogi n ID and
passw ord as defi ned i n the U ser Edi tor (Authenti cati on tab). If no
w arehouse l ogi n ID i s l i nked to a user, Intel l i gence Server uses the
defaul t connecti on and l ogi n ID for the proj ect's database i nstance.

By defaul t, w arehouse passthrough executi on i s turned off, and the

system uses connecti on mappi ngs. If no connecti on mappi ng i s
defi ned for the user, Intel l i gence Server uses the defaul t connecti on
and l ogi n ID for the proj ect's database i nstance.

Wh y u se Passt h r o u gh Execu t io n ?
You may w ant to use passthrough executi on for these reasons:

l R D BMS audi ti ng: If you w ant to be abl e to track w hi ch users are

accessi ng the R D BMS system dow n to the i ndi vi dual database
query. Mappi ng mul ti pl e users to the same R D BMS account bl urs
the abi l i ty to track w hi ch users have i ssued w hi ch R D BMS queri es.

l Teradata spool space: If you use the Teradata R D BMS, note that i t
has a l i mi t for spool space set per account. If mul ti pl e users share
the same R D BMS account, they are col l ecti vel y l i mi ted by thi s
setti ng.

l R D BMS securi ty vi ew s: If you use securi ty vi ew s, each user needs

to l og i n to the R D BMS w i th a uni que database l ogi n ID so that a
database securi ty vi ew i s enforced.

En ab lin g Lin ked War eh o u se Lo gin s

You can confi gure l i nked w arehouse l ogi ns w i th the Proj ect
C onfi gurati on Edi tor i n D evel oper. To create a connecti on mappi ng,
you assi gn a user or group ei ther a database connecti on or database
l ogi n that i s di fferent from the defaul t. For i nformati on on thi s, see
C onnecti ng to the D ata Warehouse, page 23.

128 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To Enable Linked Warehouse Logins

1. In D evel oper, l og i nto your proj ect. You must l og i n as a user

w i th admi ni strati ve pri vi l eges.

2. From the A dministration menu, poi nt to Projects, and sel ect

Project C onfiguration.

3. Expand the D atabase Instances category, expand

A uthentication, and then sel ect Warehouse.

4. Sel ect the U se warehouse pass-through credentials check

box.

5. To use w arehouse credenti al s for al l database i nstances, sel ect

the For all database instances opti on.

6. To use w arehouse credenti al s for speci fi c database i nstances,

sel ect the For selected database instances opti on. Then sel ect
those database i nstances from the l i st bel ow .

7. C l i ck OK .

Restricting Access to Data: Security Filters

Securi ty fi l ters enabl e you to control w hat w arehouse data users can
see w hen that data i s accessed through Mi croStrategy. A securi ty
fi l ter can be assi gned to a user or group to narrow the resul t set w hen
they execute reports or brow se el ements. The securi ty fi l ter appl i es to
al l reports and documents, and al l attri bute el ement requests,
submi tted by a user.

For exampl e, tw o regi onal managers can have tw o di fferent securi ty

fi l ters assi gned to them for thei r regi ons: one has a securi ty fi l ter
assi gned to them that onl y show s the data from the N ortheast regi on,
and the other has a securi ty fi l ter that onl y show s data from the
Southw est regi on. If these tw o regi onal managers run the same
report, they may see di fferent report resul ts.

© 2019, M icr o St r at egy In c. 129

Syst em Ad m in ist r at io n Gu id e

Securi ty fi l ters serve a si mi l ar functi on to database-l evel techni ques

such as database vi ew s and row l evel securi ty. For i nformati on about
control l i ng data securi ty at the data w arehouse l evel , see C ontrol l i ng
Access to D ata at the D atabase (R D BMS) Level , page 147.

For more i nformati on about securi ty fi l ters, see the fol l ow i ng:

l Securi ty Fi l ter Exampl e, page 130

l H ow Securi ty Fi l ters Work, page 131

l C reati ng and Appl yi ng a Securi ty Fi l ter, page 132

l Securi ty Fi l ters and Metri c Level s, page 134

l U si ng a Si ngl e Securi ty Fi l ter for Mul ti pl e U sers: System Prompts,

page 144

l Mergi ng Securi ty Fi l ters, page 140

Secu r it y Filt er Examp le

A user i n the Mi croStrategy Tutori al proj ect has a securi ty fi l ter
defi ned as Subcategory=TV. When thi s user brow ses the Product
hi erarchy begi nni ng w i th the C ategory attri bute, they onl y see the
El ectroni cs category. Wi thi n the El ectroni cs category, they see onl y
the TV subcategory. Wi thi n the TV subcategory, they see al l Items
w i thi n that subcategory.

When thi s user executes a si mpl e report w i th C ategory, Subcategory,

and Item i n the row s, and R evenue i n the col umns, onl y the Items
from the TV Subcategory are returned, as show n i n the exampl e
bel ow .

130 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

If thi s user executes another report w i th C ategory i n the row s and

R evenue i n the col umns, onl y the R evenue from the TV Subcategory
i s returned, as show n i n the exampl e bel ow . The user cannot see any
data from attri bute el ements that are outsi de the securi ty fi l ter.

Ho w Secu r it y Filt er s Wo r k
Securi ty fi l ters are the same as regul ar fi l ters except that they can
contai n onl y attri bute qual i fi cati ons, custom expressi ons, and j oi nt
el ement l i sts. R el ati onshi p fi l ters and metri c qual i fi cati ons are not
al l ow ed i n a securi ty fi l ter. A securi ty fi l ter can i ncl ude as many
expressi ons as you need, j oi ned together by l ogi cal operators. For
more i nformati on on creati ng fi l ters, see the Fi l ters secti on i n the
Basi c R eporti ng Gui de.

A securi ty fi l ter comes i nto pl ay w hen a user i s executi ng reports and

brow si ng el ements. The qual i fi cati on defi ned by the securi ty fi l ter i s
used i n the WH E R E cl ause for any report that i s rel ated to the securi ty
fi l ter's attri bute. By defaul t, thi s i s al so true for el ement brow si ng:

© 2019, M icr o St r at egy In c. 131

Syst em Ad m in ist r at io n Gu id e

w hen a user brow ses through a hi erarchy to answ er a prompt, they

onl y see the attri bute el ements that the securi ty fi l ter al l ow s them to
see. For i nstructi ons on how to di sabl e securi ty fi l ters for el ement
brow si ng, see To D i sabl e Securi ty Fi l ters for El ement Brow si ng, page
134.

Securi ty fi l ters are used as part of the cache key for report cachi ng
and el ement cachi ng. Thi s means that users w i th di fferent securi ty
fi l ters cannot access the same cached resul ts, preservi ng data
securi ty. For more i nformati on about cachi ng, see C hapter 10,
Improvi ng R esponse Ti me: C achi ng.

Each user or group can be di rectl y assi gned onl y one securi ty fi l ter
for a proj ect. U sers and groups can be assi gned di fferent securi ty
fi l ters for di fferent proj ects. In cases w here a user i nheri ts one or
more securi ty fi l ters from any groups that they bel ong to, the securi ty
fi l ters may need to be merged. For i nformati on about how securi ty
fi l ters are merged, see Mergi ng Securi ty Fi l ters, page 140.

Cr eat in g an d Ap p lyin g a Secu r it y Filt er

You create and appl y securi ty fi l ters i n the Securi ty Fi l ter Manager.
Make sure you i nform your users of any securi ty fi l ters assi gned to
them or thei r group. If you do not i nform them of thei r securi ty fi l ters,
they may not know that the data they see i n thei r reports has been
fi l tered, w hi ch may cause mi si nterpretati on of report resul ts.

To c reate s ec urity filters , y ou mus t hav e the following priv ileges :

l Create Applic ation Objec ts (under the Common Priv ileges priv ilege
group)

l Us e Report Filter Editor (under the Dev eloper priv ilege group)

l Us e Sec urity Filter Manager (under the Adminis tration priv ilege group)

132 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

1. To create and appl y a securi ty fi l ter for a user or group

2. In D evel oper, from the A dministration menu, go to Projects >

Security Filter Manager.

3. From the C hoose a project drop-dow n l i st, sel ect the proj ect
that you w ant to create a securi ty fi l ter for.

4. Sel ect the Security Filters tab.

5. Sel ect one:

l To create a new securi ty fi l ter, cl i ck N ew. The Securi ty Fi l ter

Edi tor opens.

l OR , to convert an exi sti ng fi l ter i nto a securi ty fi l ter, cl i ck

Import. Brow se to the fi l ter you w ant to convert and cl i ck
Open. Speci fy a name and l ocati on for the new securi ty fi l ter
and cl i ck Save.

6. In the l eft si de of the Securi ty Fi l ter Manager, i n the Security

Filters tab, brow se to the securi ty fi l ter that you w ant to appl y,
and sel ect that securi ty fi l ter.

7. In the ri ght si de of the Securi ty Fi l ter Manager, sel ect Security

Filters.

8. Brow se to the user or group that you w ant to appl y the securi ty
fi l ter to, and sel ect that user or group.

9. C l i ck > to appl y the sel ected securi ty fi l ter to the sel ected user or
group.

10. C l i ck OK .

© 2019, M icr o St r at egy In c. 133

Syst em Ad m in ist r at io n Gu id e

To Disable Security Filters for Element Browsing

1. In D evel oper, l og i nto a proj ect. You must l og i n w i th a user

account that has admi ni strati ve pri vi l eges.

2. From the A dministration menu, poi nt to Projects, and then

sel ect Project C onfiguration.

3. Expand the Project D efinition category, and then sel ect

A dvanced.

4. U nder A ttribute element browsing, cl ear the A pply security

filters to element browsing check box.

5. C l i ck OK .

6. R estart Intel l i gence Server for your changes to take effect.

Secu r it y Filt er s an d Met r ic Levels

In certai n si tuati ons i nvol vi ng l evel metri cs, users may be abl e to see
a l i mi ted amount of data from outsi de thei r securi ty fi l ter. Speci fi cal l y,
i f a metri c i s defi ned w i th absol ute fi l teri ng on a l evel above that used
i n the securi ty fi l ter's expressi on, the fi l ter expressi on i s rai sed to the
metri c's l evel . For i nformati on about metri c l evel s and fi l teri ng i n
metri cs, see the Metri cs secti on i n the Advanced R eporti ng Gui de.

For exampl e, consi der a metri c cal l ed C ategory R evenue that i s

defi ned to return the revenue across al l i tems i n each category. Its
l evel expressi on i s Target=C ategory, Fi l teri ng=Absol ute. When a user
w i th a securi ty fi l ter Subcategory=TV executes a report w i th the
C ategory R evenue metri c, the C ategory R evenue metri c di spl ays the
total revenue for the category. The user's securi ty fi l ter i s effecti vel y
changed to show the enti re C ategory i n w hi ch TV i s a Subcategory.

Thi s behavi or can be modi fi ed by usi ng the top range attri bute and
bottom range attri bute properti es.

134 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l A top range attribute speci fi es the hi ghest l evel of detai l i n a gi ven

hi erarchy that the securi ty fi l ter al l ow s the user to vi ew . If a top
range attri bute i s speci fi ed, the securi ty fi l ter expressi on i s not
rai sed to any l evel above the top range.

l A bottom range attribute speci fi es the l ow est l evel of detai l i n a

gi ven hi erarchy that the securi ty fi l ter al l ow s the user to vi ew . If thi s
i s not speci fi ed, the securi ty fi l ter can vi ew every l evel l ow er than
the speci fi ed top range attri bute, as l ong as i t i s w i thi n the
qual i fi cati on defi ned by the fi l ter expressi on.

The top and bottom range attributes c an be s et to the s ame lev el.

For i nstructi ons on how to assi gn range attri butes to securi ty fi l ters,
see Assi gni ng a Top or Bottom R ange Attri bute to a Securi ty Fi l ter,
page 138.

The exampl es bel ow use a report w i th C ategory, Subcategory, and

Item on the row s, and three metri cs i n the col umns:

l R evenue

l Subcategory R evenue, w hi ch i s defi ned w i th absol ute fi l teri ng to

the Subcategory l evel

l C ategory R evenue, w hi ch i s defi ned w i th absol ute fi l teri ng to the

C ategory l evel

The user executi ng thi s report has a securi ty fi l ter that restri cts the
Subcategory to the TV el ement.

No Top or Bottom Range Attribute

If no top or bottom range attri bute i s speci fi ed, then at the l evel of the
securi ty fi l ter (Subcategory) and bel ow , the user cannot see data
outsi de thei r securi ty fi l ter. Above the l evel of the securi ty fi l ter, the
user can see data outsi de the securi ty fi l ter i f i t i s i n a metri c w i th

© 2019, M icr o St r at egy In c. 135

Syst em Ad m in ist r at io n Gu id e

absol ute fi l teri ng for that l evel . Even i n thi s case, the user sees onl y
data for the C ategory i n w hi ch thei r securi ty fi l ter i s defi ned.

In the exampl e report bel ow , the user's securi ty fi l ter does not speci fy
a top or bottom range attri bute. Item-l evel detai l i s di spl ayed for onl y
the i tems w i thi n the TV category. The Subcategory R evenue i s
di spl ayed for al l i tems w i thi n the TV subcategory. The C ategory
R evenue i s di spl ayed for al l i tems i n the C ategory, i ncl udi ng i tems
that are not part of the TV subcategory. H ow ever, onl y the El ectroni cs
category i s di spl ayed. Thi s i l l ustrates how the securi ty fi l ter
Subcategory=TV i s rai sed to the category l evel such that
C ategory=El ectroni cs i s the fi l ter used w i th C ategory R evenue.

Top Range Attribute: Subcategory

If a top range attri bute i s speci fi ed, then the user cannot see any data
outsi de of them securi ty fi l ter. Thi s i s true even at l evel s above the
top l evel , regardl ess of w hether metri cs w i th absol ute fi l teri ng are
used.

In the exampl e report bel ow , the user's securi ty fi l ter speci fi es a top
range attri bute of Subcategory. H ere, the C ategory R evenue i s

136 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

di spl ayed for onl y the i tems w i thi n the TV subcategory. The securi ty
fi l ter Subcategory=TV i s not rai sed to the C ategory l evel , because
C ategory i s above the speci fi ed top l evel of Subcategory.

Bottom Range Attribute: Subcategory

If a bottom range attri bute i s speci fi ed, the user cannot see data
aggregated at a l ow er l evel than the bottom l evel .

In the exampl e report bel ow , the user's securi ty fi l ter speci fi es a

bottom range attri bute of Subcategory. Item-l evel detai l i s not
di spl ayed, because Item i s a l evel bel ow the bottom l evel of
Subcategory. Instead, data for the enti re Subcategory i s show n for
each i tem. D ata at the Subcategory l evel i s essenti al l y the l ow est
l evel of granul ari ty the user i s al l ow ed to see.

© 2019, M icr o St r at egy In c. 137

Syst em Ad m in ist r at io n Gu id e

Assigning a Top or Bottom Range Attribute to a Security Filter

You assi gn top and bottom range attri butes to securi ty fi l ters i n the
Securi ty Fi l ter Manager. You can assi gn range attri butes to a securi ty
fi l ter for al l users, or to the securi ty fi l ters per user.

You can assi gn the same attri bute to a securi ty fi l ter as a top and
bottom range attri bute. A securi ty fi l ter can have mul ti pl e top or
bottom range attri butes as l ong as they are from di fferent hi erarchi es.
You cannot assi gn mul ti pl e attri butes from the same hi erarchy to
ei ther a top or bottom range. H ow ever, you can assi gn attri butes from
the same hi erarchy i f one i s a top range attri bute and one i s a bottom
range attri bute. For exampl e, you can assi gn Quarter (from the Ti me
hi erarchy) and Subcategory (from the Products hi erarchy) as top
range attri butes, and Month (from the Ti me hi erarchy) and
Subcategory as bottom range attri butes.

To modify s ec urity filters , y ou mus t hav e the Us e Sec urity Filter Manager
priv ilege.

138 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To Assign a Top or Bottom Range Attribute to a Security Filter

1. In D evel oper, from the A dministration menu, poi nt to Projects

and then sel ect Security Filter Manager.

2. From the C hoose a project drop-dow n l i st, sel ect the proj ect
that you w ant to modi fy securi ty fi l ters for.

3. Sel ect the A ttributes tab.

4. Brow se to the attri bute that you w ant to set as a top or bottom
range attri bute, and sel ect that attri bute.

5. To appl y a top or bottom range attri bute to a securi ty fi l ter for al l

users:

l In the ri ght si de of the Securi ty Fi l ter Manager, sel ect Security

Filters.

l Brow se to the securi ty fi l ter that you w ant to appl y the range
attri bute to.

l Expand that securi ty fi l ter, and sel ect ei ther the Top range
attributes or B ottom range attributes fol der.

l C l i ck > to appl y the sel ected attri bute to the sel ected securi ty
fi l ter.

6. To appl y a top or bottom range attri bute to a securi ty fi l ter for a

si ngl e user or group:

l In the ri ght si de of the Securi ty Fi l ter Manager, sel ect

Groups/U sers.

l Brow se to the user or group that you w ant to appl y the range
attri bute to.

l Expand that user or group and sel ect the securi ty fi l ter that you
w ant to appl y the range attri bute to.

© 2019, M icr o St r at egy In c. 139

Syst em Ad m in ist r at io n Gu id e

l Expand that securi ty fi l ter, and sel ect ei ther the Top range
attributes or B ottom range attributes fol der.

l C l i ck > to appl y the sel ected attri bute to the sel ected securi ty
fi l ter for the sel ected user or group.

7. C l i ck OK .

Mer gin g Secu r it y Filt er s

A user can be assi gned a securi ty fi l ter di rectl y, and can i nheri t a
securi ty fi l ter from any groups that they bel ong to. Because of thi s,
mul ti pl e securi ty fi l ters may need to be merged w hen executi ng
reports or brow si ng el ements.

Mi croStrategy supports the fol l ow i ng methods of mergi ng securi ty

fi l ters:

l Mergi ng R el ated Securi ty Fi l ters w i th OR and U nrel ated Securi ty

Fi l ters w i th AN D , page 141 (Thi s i s the defaul t method for mergi ng
securi ty fi l ters)

l Mergi ng Al l Securi ty Fi l ters w i th AN D , page 142

For the exampl es i n these secti ons, consi der a proj ect w i th the
fol l ow i ng user groups and associ ated securi ty fi l ters:

Gr oup Se c ur ity Filte r Hie r a r c hy

E lect ronics Cat egory = E lect ronics P roduct

Drama S ubcat egory = Drama P roduct

Movies Cat egory = Movies P roduct

Nort heast Region = Nort heast Geography

You control how securi ty fi l ters are merged at the proj ect l evel . You
can change the merge setti ngs i n the Proj ect C onfi gurati on Edi tor for

140 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

the sel ected proj ect, i n the Securi ty Fi l ter category. After maki ng any
changes to the securi ty fi l ter setti ngs, you must restart Intel l i gence
Server for those changes to take effect.

Changing how s ec urity filters are merged does not automatic ally
inv alidate any res ult c ac hes c reated for us ers who hav e multiple
s ec urity filters . Mic roStrategy rec ommends that y ou inv alidate all res ult
c ac hes in a projec t after c hanging how s ec urity filters are merged for
that projec t. For ins truc tions on how to inv alidate all res ult c ac hes in a
projec t, s ee Managi ng R esul t C aches, page 878 .

Merging Related Security Filters with OR and Unrelated Security Filters

with AND

By defaul t, securi ty fi l ters are merged w i th an OR i f they are rel ated,

and w i th an AN D i f they are not rel ated. That i s, i f tw o securi ty fi l ters
are rel ated, the user can see al l data avai l abl e from ei ther securi ty
fi l ter. H ow ever, i f the securi ty fi l ters are not rel ated, the user can see
onl y the data avai l abl e i n both securi ty fi l ters.

Tw o securi ty fi l ters are consi dered rel ated i f the attri butes that they
deri ve from bel ong i n the same hi erarchy, such as C ountry and
R egi on, or Year and Month. In the exampl e securi ty fi l ters gi ven
above, the El ectroni cs, TV, and Movi es securi ty fi l ters are al l rel ated,
and the N ortheast securi ty fi l ter i s not rel ated to any of the others.

U si ng thi s merge method, a user w ho i s a member of both the

El ectroni cs and D rama groups can see data from the El ectroni cs
category and the D rama subcategory, as show n bel ow :

© 2019, M icr o St r at egy In c. 141

Syst em Ad m in ist r at io n Gu id e

A user w ho i s a member of both the Movi es and D rama groups can

see data from al l subcategori es i n the Movi es category, not j ust the
D rama subcategory. A user w ho i s a member of both the El ectroni cs
and D rama categori es can see data from both categori es.

If a user w ho i s a member of the Movi es and N ortheast groups

executes a report w i th R egi on, C ategory, and Subcategory i n the
row s, onl y data from the Movi es category i n the N ortheast regi on i s
show n, as seen bel ow :

D ata for the Movi es category from outsi de the N ortheast regi on i s not
avai l abl e to thi s user, nor i s data for the N ortheast regi on for other
categori es.

Merging All Security Filters with AND

You can al so confi gure Intel l i gence Server to al w ays merge securi ty
fi l ters w i th an AN D , regardl ess of w hether they are rel ated.

As i n the fi rst method, a user w ho i s a member of both the Movi es and

N ortheast groups w oul d see onl y i nformati on about the Movi es
category i n the N ortheast regi on.

A user w ho i s a member of both the Movi es and D rama groups w oul d

see onl y data from the D rama subcategory of Movi es, as show n
bel ow :

142 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

D ata for the other subcategori es of D rama i s not avai l abl e to thi s
user.

Thi s setti ng may cause probl ems i f a user i s a member of tw o

mutual l y excl usi ve groups. For exampl e, a user w ho i s a member of
both the Movi es and El ectroni cs groups cannot see any data from the
Product hi erarchy, because that hi erarchy does not contai n any data
that bel ongs to both the Movi es and El ectroni cs categori es.

To c onfigure how s ec urity filters are merged, y ou mus t hav e the Configure
Projec t Bas ic priv ilege.

To Configure how Intelligence Server Merges Multiple Security

Filters for a User or Group

1. In D evel oper, l og i nto a proj ect. You must l og i n as a user w i th

admi ni strati ve pri vi l eges.

2. From the A dministration menu, poi nt to Projects, and then

sel ect Project C onfiguration.

3. Expand the Security Filter category, and then sel ect General.

4. U nder Security Filter Merge Options, sel ect one of the opti ons:

l U nion (OR ) Security Filters on related attributes, intersect

(A N D ) Security Filters on unrelated attributes (see Mergi ng
R el ated Securi ty Fi l ters w i th OR and U nrel ated Securi ty Fi l ters
w i th AN D , page 141)

l Intersect (A N D ) all Security Filters (see Mergi ng Al l Securi ty

Fi l ters w i th AN D , page 142)

5. C l i ck OK .

6. R estart Intel l i gence Server for your changes to take effect.

© 2019, M icr o St r at egy In c. 143

Syst em Ad m in ist r at io n Gu id e

Usin g a Sin gle Secu r it y Filt er f o r Mu lt ip le User s: Syst em

Pr o mp t s
A system prompt i s a speci al type of prompt that does not requi re an
answ er from the user. Instead, i t i s answ ered automati cal l y by
Intel l i gence Server. System prompts are i n the P u b l i c
Obje ct s/ Pr o m p t s / S y s t e m P r o m p t s fol der i n D evel oper.

l Lik e other prompt objec ts , ans wers to s y s tem prompts are us ed to

matc h c ac hes . Therefore, us ers do not s hare c ac hes for reports that
c ontain different ans wers to s y s tem prompts .

l The s y s tem prompts Tok en 1, Tok en 2, Tok en 3, and Tok en 4 are

prov ided to s upport us ing an XQuery s ourc e to authentic ate us ers for
a Mic roStrategy projec t. For s teps to report on and authentic ate us ing
XQuery s ourc es , s ee the Advanced R eporti ng Gui de .

The U ser Logi n prompt i s a system prompt that i s automati cal l y

answ ered w i th the l ogi n name of the user w ho executes the obj ect
contai ni ng the prompt. It can provi de fl exi bi l i ty w hen i mpl ementi ng
securi ty mechani sms i n Mi croStrategy. You can use thi s prompt to
i nsert the user's l ogi n name i nto any securi ty fi l ter, or any other obj ect
that can use a prompt.

If you are usi ng LD AP authenti cati on i n your Mi croStrategy system,

you can i mport LD AP attri butes i nto your system as system prompts.
You can then use these system prompts i n securi ty fi l ters, i n the same
w ay that you use the U ser Logi n system prompt, as descri bed above.
For i nstructi ons on how to i mport LD AP attri butes as system prompts,
see Managi ng LD AP Authenti cati on, page 202.

For exampl es of how to use system prompts i n securi ty fi l ters, see:

l Si mpl i fyi ng the Securi ty Fi l ter D efi ni ti on Process, page 145

l Impl ementi ng a R eport-Level Securi ty Fi l ter, page 146

144 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l U si ng D atabase Tabl es That C ontai n Securi ty Informati on, page

146

To Create a Security Filter Using a System Prompt

1. In D evel oper, from the A dministration menu, poi nt to Projects

and then sel ect Security Filter Manager.

2. From the C hoose a project drop-dow n l i st, sel ect the proj ect
that you w ant to create a securi ty fi l ter for.

3. Sel ect the Security Filters tab.

4. C l i ck N ew.

5. D oubl e-cl i ck on the text D ouble-click here to add a

qualification.

6. Sel ect A dd an advanced qualification and cl i ck OK .

7. From the Option drop-dow n l i st, sel ect C ustom Expression.

8. Type your custom expressi on i n the C ustom Expression area.

You can drag and drop a system prompt or other obj ect to
i ncl ude i t i n the custom expressi on. For detai l ed i nstructi ons on
creati ng custom expressi ons i n fi l ters, see the Fi l ters secti on of
the Advanced R eporti ng Gui de.

9. When you have fi ni shed typi ng your custom expressi on, cl i ck

Validate to make sure that i ts syntax i s correct.

10. C l i ck Save and close. Type a name for the securi ty fi l ter and
cl i ck Save.

Simplifying the Security Filter Definition Process

You can use a system prompt to appl y a si ngl e securi ty fi l ter to al l

users i n a group. For exampl e, you can create a securi ty fi l ter usi ng
the formul a Us e r @ I D = ?[ U s e r L o g i n ] that di spl ays i nformati on

© 2019, M icr o St r at egy In c. 145

Syst em Ad m in ist r at io n Gu id e

onl y for the el ement of the U ser attri bute that matches the user's
l ogi n.

For a more compl ex exampl e, you can restri ct Managers so that they
can onl y vi ew data on the empl oyees that they supervi se. Add the
U ser Logi n prompt to a securi ty fi l ter i n the form M a n a g e r = ?[ U s e r
Logi n] . Then assi gn the securi ty fi l ter to the Managers group. When
a manager named John Smi th executes a report, the securi ty fi l ter
generates SQL for the condi ti on M a n a g e r = ' J o h n S m i t h ' and onl y
John Smi th's empl oyees' data i s returned.

Implementing a Report-Level Security Filter

You can al so use the U ser Logi n system prompt to i mpl ement securi ty
fi l ter functi onal i ty at the report l evel , by defi ni ng a report fi l ter w i th a
system prompt. For exampl e, you can defi ne a report fi l ter w i th the
U ser Logi n prompt i n the form M a n a g e r = ?[ Us e r L o g i n ]. Any
reports that use thi s fi l ter return data onl y to those users w ho are
l i sted as Managers i n the system.

Using Database Tables That Contain Security Information

If your organi zati on mai ntai ns securi ty i nformati on i n database tabl es,
you can use a system prompt to bui l d Mi croStrategy securi ty
mechani sms usi ng the database securi ty tabl es. For exampl e, you can
restri ct the data returned based on a user's l ogi n by creati ng a report
fi l ter that accesses col umns i n your securi ty tabl es and i ncl udes the
U ser Logi n system prompt. You can al so restri ct data access based
on tw o or more unrel ated attri butes by usi ng l ogi cal vi ew s (database
vi ew s) and the U ser Logi n system prompt i n a securi ty fi l ter.

146 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Controlling Access to Data at the Database (RDBMS)

Level
D atabase servers have thei r ow n securi ty archi tectures that provi de
authenti cati on, access control , and audi ti ng. As menti oned above,
you may choose to use these R D BMS techni ques to manage access
to data, or you may choose to use mechani sms i n the Mi croStrategy
appl i cati on l ayer to manage access to data, or you may use a
combi nati on of the tw o. They are not mutual l y excl usi ve. One
advantage of usi ng the database-l evel securi ty mechani sms to secure
data i s that al l appl i cati ons accessi ng the database benefi t from those
securi ty measures. If onl y Mi croStrategy mechani sms are used, then
onl y those users accessi ng the Mi croStrategy appl i cati on benefi t from
those securi ty measures. If other appl i cati ons access the database
w i thout goi ng through the Mi croStrategy system, the securi ty
mechani sms are not i n pl ace.

Secu r it y Views
Most databases provi de a w ay to restri ct access to data. For exampl e,
a user may be abl e to access onl y certai n tabl es, or they may be
restri cted to certai n row s and col umns w i thi n a tabl e. The subset of
data avai l abl e to a user i s cal l ed the user's securi ty vi ew .

Securi ty vi ew s are often used w hen spl i tti ng fact tabl es by col umns
and spl i tti ng fact tabl es by row s (di scussed bel ow ) cannot be used.
The rul es that determi ne w hi ch row s each user i s al l ow ed to see
typi cal l y vary so much that users cannot be separated i nto a
manageabl e number of groups. In the extreme, each user i s al l ow ed
to see a di fferent set of row s.

N ote that restri cti ons on tabl es, or row s and col umns w i thi n tabl es,
may not be di rectl y evi dent to a user. H ow ever, they do affect the
val ues di spl ayed i n a report. You need to i nform users as to w hi ch
data they can access so that they do not i nadvertentl y run a report

© 2019, M icr o St r at egy In c. 147

Syst em Ad m in ist r at io n Gu id e

that yi el ds mi sl eadi ng fi nal resul ts. For exampl e, i f a user has access
to onl y hal f of the sal es i nformati on i n the data w arehouse but runs a
summary report on al l sal es, the summary refl ects onl y hal f of the
sal es. R eports do not i ndi cate the database securi ty vi ew used to
generate the report.

C onsul t your database vendor's product documentati on to l earn how

to create securi ty vi ew s for your database.

Sp lit t in g Fact Tab les b y Ro ws

You can spl i t fact tabl es by row s to separate a l ogi cal data set i nto
mul ti pl e physi cal tabl es based on val ues i n the row s (thi s i s al so
know n as tabl e parti ti oni ng). The resul tant tabl es are physi cal l y
di sti nct tabl es i n the data w arehouse, and securi ty admi ni strati on i s
si mpl e because permi ssi ons are granted to enti re tabl es rather than to
row s and col umns.

If the data to be secured can be separated by row s, then thi s may be a

useful techni que. For exampl e, suppose a fact tabl e contai ns the key
C ustomer ID , Address, Member Bank and tw o fact col umns, as show n
bel ow :

Cus tome r Cus tome r Me mbe r Tr a ns a c tion Cur r e nt

ID Addr e s s Ba nk Amount ($ ) Ba la nc e ($ )

1st
123456 12 E lm S t . 400. 80 40, 450. 00
Nat ional

E ast ern
945940 888 Oak S t . 150. 00 60, 010. 70
Credit

P eople's
908974 45 Crest Dr. 3, 000. 00 100, 009. 00
B ank

907 Grove 1st

886580 76. 35 10, 333. 45
Rd. Nat ional

148 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Cus tome r Cus tome r Me mbe r Tr a ns a c tion Cur r e nt

ID Addr e s s Ba nk Amount ($ ) Ba la nc e ($ )

1 Ocean E ast ern

562055 888. 50 1, 000. 00
B lvd. Credit

You can spl i t the tabl e i nto separate tabl es (based on the val ue i n
Member Bank), one for each bank: 1st N ati onal , Eastern C redi t, and
so on. In thi s exampl e, the tabl e for 1st N ati onal bank w oul d l ook l i ke
thi s:

Cus tome r Cus tome r Me mbe r Tr a ns a c tion Cur r e nt

ID Addr e s s Ba nk Amount ($ ) Ba la nc e ($ )

1st
123456 12 E lm S t . 400. 80 40, 450. 00
Nat ional

907 Grove 1st

886580 76. 35 10, 333. 45
Rd. Nat ional

The tabl e for Eastern C redi t w oul d l ook l i ke thi s:

Cus tome r Cus tome r Me mbe r Tr a ns a c tion Cur r e nt

ID Addr e s s Ba nk Amount ($ ) Ba la nc e ($ )

E ast ern
945940 888 Oak S t . 150. 00 60, 010. 70
Credit

1 Ocean E ast ern

562055 888. 50 1, 000. 00
B lvd. Credit

Thi s makes i t si mpl e to grant permi ssi ons by tabl e to managers or

account executi ves w ho shoul d onl y be l ooki ng at customers for a
certai n bank.

© 2019, M icr o St r at egy In c. 149

Syst em Ad m in ist r at io n Gu id e

In most R D BMSs, spl i t fact tabl es by row s are i nvi si bl e to system

users. Al though there are many physi cal tabl es, the system "sees"
one l ogi cal fact tabl e.

Support for Spl i t fact tabl es by row s for securi ty reasons shoul d not
be confused w i th the support that Intel l i gence Server provi des for spl i t
fact tabl es by row s for performance benefi ts. For more i nformati on
about parti ti oni ng, see the Advanced R eporti ng Gui de.

Sp lit t in g Fact Tab les b y Co lu mn s

You can spl i t fact tabl es by col umns to separate a l ogi cal data set i nto
mul ti pl e physi cal tabl es by col umns. If the data to be secured can be
separated by col umns, then thi s may be a useful techni que.

Each new tabl e has the same pri mary key, but contai ns onl y a subset
of the fact col umns i n the ori gi nal fact tabl e. Spl i tti ng fact tabl es by
col umns al l ow s fact col umns to be grouped based on user communi ty.
Thi s makes securi ty admi ni strati on si mpl e because permi ssi ons are
granted to enti re tabl es rather than to col umns. For exampl e, suppose
a fact tabl e contai ns the key l abel ed C ustomer ID and fact col umns as
fol l ow s:

Cus tome r Cus tome r Me mbe r Tr a ns a c tion Cur r e nt

ID Addr e s s Ba nk Amount ($ ) Ba la nc e ($ )

You can spl i t the tabl e i nto tw o tabl es, one for the marketi ng
department and one for the fi nance department. The marketi ng fact
tabl e w oul d contai n everythi ng except the fi nanci al fact col umns as
fol l ow s:

15 0 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Cus tome r Cus tome r Me mbe r

ID Addr e s s Ba nk

The second tabl e used by the fi nanci al department w oul d contai n onl y
the fi nanci al fact col umns but not the marketi ng-rel ated i nformati on as
fol l ow s:

Cur r e nt
Cus tome r Tr a ns a c tion
Ba la nc e
ID Amount ($ )
($ )

Merging Users or Groups

Wi thi n a gi ven proj ect source, you may need to combi ne mul ti pl e
users i nto one user defi ni ti on or combi ne a user group i nto another
user group. For exampl e, i f U serA i s taki ng over the duti es of U serB,
you may w ant to combi ne the users by mergi ng U serB's properti es
i nto U serA. The Mi croStrategy U ser Merge Wi zard merges mul ti pl e
users or groups and thei r profi l es i nto a si ngl e user or group, w i th a
si ngl e profi l e.

Topi cs covered i n thi s secti on i ncl ude:

How Users and Groups are Merged

The U ser Merge Wi zard combi nes users and thei r rel ated obj ects,
from a si ngl e proj ect source. These obj ects i ncl ude profi l e fol ders,
group membershi ps, user pri vi l eges, securi ty rol es, and securi ty

© 2019, M icr o St r at egy In c. 15 1

Syst em Ad m in ist r at io n Gu id e

fi l ters, among others. Informati on from the user or group that i s bei ng
merged i s copi ed to the desti nati on user or group. Then the user or
group that i s bei ng merged i s removed from the metadata and onl y the
desti nati on user or group remai ns.

For exampl e, you w ant to merge U serB i nto U serA. In thi s case U serA
i s referred to as the desti nati on user. In the w i zard, thi s i s show n i n
the i mage bel ow :

When y ou open the Us er Merge Wiz ard and s elec t a projec t s ourc e, the
wiz ard loc k s that projec t c onfiguration. Other us ers c annot c hange any
c onfiguration objec ts until y ou c los e the wiz ard. For more information
about loc k ing and unloc k ing projec ts , s ee Locki ng Proj ects, page
416 .

You can al so merge users i n batches i f you have a l arge number of

users to merge. Mergi ng i n batches can si gni fi cantl y speed up the
merge process. Batch-mergi ng i s an opti on i n the U ser Merge Wi zard.
C l i ck H elp for detai l s on setti ng thi s opti on.

The U ser Merge Wi zard automati cal l y merges the fol l ow i ng

properti es: pri vi l eges, group membershi ps, profi l e fol ders, and obj ect
ow nershi p (access control l i sts). You may opti onal l y choose to merge
properti es such as a user's or group's securi ty rol es, securi ty fi l ters,
and database connecti on maps. D etai l s about how the w i zard merges
each of these properti es are di scussed bel ow .

Mer gin g User Pr ivileges

The U ser Merge Wi zard automati cal l y merges al l of a user's or
group's pri vi l eges. To conti nue w i th the exampl e above, before the

15 2 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

users are merged, each user has a di sti nct set of gl obal user
pri vi l eges. After the merge, al l pri vi l eges that had been assi gned to
U serB are combi ned w i th those of the desti nati on user, U serA. Thi s
combi nati on i s performed as a uni on. That i s, pri vi l eges are not
removed from ei ther user.

For exampl e, i f U serA has the Web user pri vi l ege and U serB has the
Web user and Web Admi ni strati on pri vi l eges, after the merge, U serA
has both Web user and Web Admi ni strati on pri vi l eges.

Mer gin g User Gr o u p Memb er sh ip s

The U ser Merge Wi zard automati cal l y merges al l of a user's or
group's group membershi ps. Before the merge, each user has a
di sti nct set of group membershi ps. After the merge, al l group
membershi ps that w ere assi gned to U serB are combi ned w i th those of
the desti nati on user, U serA. Thi s combi nati on i s performed as a
uni on. That i s, group membershi ps are not removed for ei ther user.

Mer gin g User Pr o f ile Fo ld er s

The U ser Merge Wi zard automati cal l y merges al l of a user's or
group's profi l e fol ders. Before the merge, U serA and U serB have
separate and di sti nct user profi l e fol ders. After U serB i s merged i nto
U serA, onl y U serA exi sts; thei r profi l e contai ns the profi l e fol der
i nformati on from both U serA and U serB.

Mer gin g Ob ject Own er sh ip an d Access Co n t r o l List s

The U ser Merge Wi zard automati cal l y merges al l of a user's or
group's obj ect ow nershi ps and access control l i sts (AC Ls). Before the
merge, the user to be merged, U serB, ow ns the user obj ects i n thei r
profi l e fol der and al so has ful l control over the obj ects i n the access
control l i st. After the merge, ow nershi p and access to the merged
user's obj ects are granted to the desti nati on user, U serA. The merged

© 2019, M icr o St r at egy In c. 15 3

Syst em Ad m in ist r at io n Gu id e

user i s removed from the obj ect's AC L. Any other users that exi sted i n
the AC L remai n i n the AC L. For exampl e, before the merge, U serB
ow ns an obj ect that a thi rd user, U serC has access to. After the
merge, U serA ow ns the obj ect, and U serC sti l l has access to i t.

Mer gin g Pr o ject Secu r it y Ro les

The U ser Merge Wi zard does not automati cal l y merge a user's or
group's securi ty rol es. To merge them, you must sel ect the Security
R oles check box on the Merge Opti ons page i n the w i zard. Before the
merge, both users have uni que securi ty rol es for a gi ven proj ect. After
the merge, the desti nati on user profi l e i s changed based on the
fol l ow i ng rul es:

l If nei ther user has a securi ty rol e for a proj ect, the desti nati on user
does not have a securi ty rol e on that proj ect.

l If the desti nati on user has no securi ty rol e for a proj ect, the user
i nheri ts the rol e from the user to be merged.

l If the desti nati on user and the user to be merged have di fferent
securi ty rol es, then the exi sti ng securi ty rol e of the desti nati on user
i s kept.

l If you are mergi ng mul ti pl e users i nto a si ngl e desti nati on user and
each of the users to be merged has a securi ty rol e, then the
desti nati on user takes the securi ty rol e of the fi rst user to be
merged. If the desti nati on user al so has a securi ty rol e, the exi sti ng
securi ty rol e of the desti nati on user i s kept.

Mer gin g Pr o ject Secu r it y Filt er s

The U ser Merge Wi zard does not automati cal l y merge a user's or
group's securi ty fi l ters. To merge them, you must sel ect the Security
Filters check box on the Merge Opti ons page i n the w i zard. When

15 4 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

mergi ng securi ty fi l ters, the w i zard fol l ow s the same rul es as for
securi ty rol es, descri bed above.

Mer gin g Dat ab ase Co n n ect io n Map p in g

The U ser Merge Wi zard does not automati cal l y merge a user's or
group's database connecti on maps. To merge them, you must sel ect
the C onnection Mapping check box on the Merge Opti ons page i n
the w i zard. When mergi ng database connecti on mappi ngs, the Wi zard
fol l ow s the same rul es as for securi ty rol es and securi ty fi l ters,
descri bed above.

Running the User Merge Wizard

The fol l ow i ng hi gh-l evel procedure provi des an overvi ew of w hat the
U ser Merge Wi zard does. For an expl anati on of the i nformati on
requi red at any gi ven page i n the w i zard, cl i ck H elp, or press F1.

To Merge Users or Groups

1. From the Wi ndow s Start menu, poi nt to A ll Programs, then

MicroStrategy Tools, and then sel ect U ser Merge Wizard.

2. Speci fy the proj ect source contai ni ng the users/groups you w ant
to merge.

3. Sel ect w hether you w ant to merge opti onal user properti es such
as securi ty rol es, securi ty fi l ters, and database connecti on maps.
For a descri pti on of how the U ser Merge Wi zard merges these
opti onal properti es, see each i ndi vi dual property's secti on i n
H ow U sers and Groups are Merged, page 151.

4. Speci fy w hether you w ant to have the w i zard sel ect the
users/groups to merge automati cal l y (you can veri fy and correct
the merge candi dates), or i f you w ant to manual l y sel ect them.

© 2019, M icr o St r at egy In c. 15 5

Syst em Ad m in ist r at io n Gu id e

5. In the U ser Merge C andi dates page, sel ect the desti nati on users
or groups and cl i ck > to move them to the ri ght-hand si de.

6. Sel ect the users or groups to be merged and cl i ck > to move

them to the ri ght-hand si de.

7. C l i ck Finish.

Security Checklist Before Deploying the System

U se the checkl i st bel ow to make sure you have i mpl emented the
appropri ate securi ty servi ces or features for your system before i t i s
depl oyed. Al l the securi ty i mpl ementati ons l i sted bel ow are descri bed
i n detai l i n precedi ng secti ons.

Ensure that the Admi ni strator passw ord has been changed. When you
i nstal l Intel l i gence Server, the Admi ni strator account comes w i th a
bl ank passw ord that must be changed.

Set up access control s for the database (see C ontrol l i ng Access to

D ata, page 121). D ependi ng on your securi ty requi rements you may
need to:

l Set up securi ty vi ew s to restri ct access to speci fi c tabl es, row s, or

col umns i n the database

l Spl i t tabl es i n the database to control user access to data by

separati ng a l ogi cal data set i nto mul ti pl e physi cal tabl es, w hi ch
requi re separate permi ssi ons for access

l Impl ement connecti on mappi ng to control i ndi vi dual access to the

database

l C onfi gure passthrough executi on to control i ndi vi dual access to the

database from each proj ect, and to track w hi ch users are accessi ng
the R D BMS

15 6 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Assi gn securi ty fi l ters to users or groups to control access to

speci fi c data (these operate si mi l arl y to securi ty vi ew s but at the
appl i cati on l evel )

U nderstand the Mi croStrategy user model (see The Mi croStrategy

U ser Model , page 86). U se thi s model to:

l Sel ect and i mpl ement a system authenti cati on mode to i denti fy
users

l Set up securi ty rol es for users and groups to assi gn basi c pri vi l eges
and permi ssi ons

l U nderstand AC Ls (access control l i sts), w hi ch al l ow users access

permi ssi ons to i ndi vi dual obj ects

l C heck and, i f necessary, modi fy pri vi l eges and permi ssi ons for
anonymous authenti cati on for guest users. (By defaul t, anonymous
access i s di sabl ed at both the server and the proj ect l evel s.) D o not
assi gn del ete pri vi l eges to the guest user account.

Assi gn pri vi l eges and permi ssi ons to control user access to
appl i cati on functi onary. You may need to:

l Assi gn the D eni ed Al l permi ssi on to a speci al user or group so that,

even i f permi ssi on i s granted at another l evel , permi ssi on i s sti l l
deni ed

l Make sure guest users (anonymous authenti cati on) have access to
the Log fol der i n C :\Program Fi l es (x86)\C ommon
Fi l es\Mi croStrategy. Thi s ensures that any appl i cati on errors that
occur w hi l e a guest user i s l ogged i n can be w ri tten to the l og fi l es.

U se your w eb appl i cati on server securi ty features to:

l Impl ement fi l e-l evel securi ty requi rements

l C reate securi ty rol es for the appl i cati on server

© 2019, M icr o St r at egy In c. 15 7

Syst em Ad m in ist r at io n Gu id e

l Make use of standard Internet securi ty technol ogi es such as

fi rew al l s, di gi tal certi fi cates, and encrypti on.

l If you are w orki ng w i th sensi ti ve or confi denti al data, enabl e the

setti ng to encrypt al l communi cati on betw een Mi croStrategy Web
server and Intel l i gence Server.

There may be a notic eable performanc e degradation bec aus e the

s y s tem mus t enc ry pt and dec ry pt all network traffic .

l Enabl e encrypti on for Mi croStrategy Web products. By defaul t most

encrypti on technol ogi es are not used unl ess you enabl e them.

Locate the physi cal machi ne hosti ng the Mi croStrategy Web

appl i cati on i n a physi cal l y secure l ocati on.

R estri ct access to fi l es stored on the machi ne hosti ng the

Mi croStrategy Web appl i cati on by i mpl ementi ng standard fi l e-l evel
securi ty offered by your operati ng system. Speci fi cal l y, appl y thi s type
of securi ty to protect access to the Mi croStrategy admi ni strator pages,
to prevent someone from typi ng speci fi c U R Ls i nto a brow ser to
access these pages. (The defaul t l ocati on of the Admi n page fi l e i s
C:\P ro gr am F i l e s ( x 8 6 ) \ M i c r o S t r a t e g y \ W e b
ASPx \a sp \A d m i n . a s p x .) Be sure to restri ct access to:

l The asp di rectory

l Admi n.aspx

15 8 © 2019, M icr o St r at egy In c.

 3
I DENTIFYING U SERS:
AUTHENTICATION

© 2019, M icr o St r at egy In c. 15 9

Syst em Ad m in ist r at io n Gu id e

Authenti cati on i s the process by w hi ch the system i denti fi es the user.

In most cases, a user provi des a l ogi n ID and passw ord w hi ch the
system compares to a l i st of authori zed l ogi ns and passw ords. If they
match, the user i s abl e to access certai n aspects of the system,
accordi ng to the access ri ghts and appl i cati on pri vi l eges associ ated
w i th the user.

Workflow: Changing Authentication Modes

The fol l ow i ng i s a l i st of hi gh-l evel tasks that you perform w hen you
change the defaul t authenti cati on mode i n your Mi croStrategy
i nstal l ati on.

l C hoose an authenti cati on mode, and set up the i nfrastructure

necessary to support i t. For exampl e, i f you w ant to use LD AP
Authenti cati on, you must set up your LD AP di rectory and server. For
the modes of authenti cati on avai l abl e, see Modes of Authenti cati on,
page 161.

l Import your user database i nto the Mi croStrategy metadata, or l i nk

your users' accounts i n your user database w i th thei r accounts i n
Mi croStrategy. For exampl e, you can i mport users i n your LD AP
di rectory i nto the Mi croStrategy metadata, and ensure that thei r
LD AP credenti al s are l i nked to the correspondi ng Mi croStrategy
users. D ependi ng on the authenti cati on mode you choose, the
fol l ow i ng opti ons are avai l abl e:

l If your organi zati on's users do not exi st i n the Mi croStrategy

metadata:

l You can i mport thei r accounts from an LD AP di rectory, or from a

text fi l e. For the steps to i mport users, refer to the System
Admi ni strati on H el p i n D evel oper.

160 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l You can confi gure Intel l i gence Server to automati cal l y i mport
users i nto the metadata w hen they l og i n.

l If your organi zati on's users al ready exi st i n the Mi croStrategy

metadata:

l You can use a C ommand Manager scri pt to edi t the user

i nformati on i n the metadata, and l i nk the users' Mi croStrategy
accounts to thei r accounts i n your user di rectory.

l Enabl e your chosen authenti cati on mode for Mi croStrategy

appl i cati ons at the fol l ow i ng l evel s:

l Your w eb server, for exampl e, IIS or Apache.

l Your appl i cati on server, for exampl e, IIS or WebSphere.

l In Web Admi ni strator, on the D efaul t Server Properti es page.

l In Mobi l e Admi ni strator, on the D efaul t Server Properti es page.

l For al l proj ect sources that the above appl i cati ons connect to.

The speci fi c steps to i mpl ement an authenti cati on mode depend on

the mode you choose, and are descri bed i n the secti ons that
fol l ow .

Modes of Authentication
Several authenti cati on modes are supported i n the Mi croStrategy
envi ronment. The mai n di fference betw een the modes i s the
authenti cati on authori ty used by each mode. The authenti cati on
authori ty i s the system that veri fi es and accepts the l ogi n/passw ord
credenti al s provi ded by the user.

The avai l abl e authenti cati on modes for Mi croStrategy Pl atform

Products are:

© 2019, M icr o St r at egy In c. 161

Syst em Ad m in ist r at io n Gu id e

l Standard: Intel l i gence Server i s the authenti cati on authori ty. Thi s
i s the defaul t authenti cati on mode. For more i nformati on, see
Impl ementi ng Standard Authenti cati on, page 165. the System
Admi ni strati on Gui de.

l A nonymous: U sers l og i n as "Guest" and do not need to provi de a

passw ord. Thi s authenti cati on mode may be requi red to enabl e
other authenti cati on modes, such as database w arehouse. For more
i nformati on, see Impl ementi ng Anonymous Authenti cati on, page
169. the System Admi ni strati on Gui de.

l D atabase warehouse: The data w arehouse database i s the

authenti cati on authori ty. For more i nformati on, see Impl ementi ng
D atabase Warehouse Authenti cati on, page 336.

l LD A P (lightweight directory access protocol): An LD AP server i s

the authenti cati on authori ty. For more i nformati on, see
Impl ementi ng LD AP Authenti cati on, page 171.Setti ng up LD AP
Authenti cati on i n Mi croStrategy Web, Li brary, and Mobi l e

l Single sign-on: Si ngl e si gn-on encompasses several di fferent

thi rd-party authenti cati on methods, i ncl udi ng:

l SA ML authentication: A tw o w ay authenti cati on set up betw een

your Mi croStrategy server and a SAML Identi ty Provi der. For more
i nformati on, see Enabl i ng Si ngl e Si gn-On w i th SAML
Authenti cati on.

l Integrated authentication: A domai n control l er usi ng Kerberos

authenti cati on i s the authenti cati on authori ty. For more
i nformati on, see Enabl i ng i ntegrated authenti cati on.

l Trusted authentication: A thi rd-party si ngl e si gn-on tool , such as

IBM® Ti vol i ® Access Manager, C A Si teMi nder®, or Oracl e®
Access Manager, i s the authenti cati on authori ty. For more
i nformati on, see Enabl e Si ngl e Si gn-On to Li brary w i th Trusted

162 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Authenti cati on.

Trus ted authentic ation mode c annot be us ed in c ombination with

any other log in mode.

l Windows authentication: Wi ndow s i s the authenti cati on

authori ty. For more i nformati on, see Impl ementi ng Wi ndow s N T
Authenti cati on, page 296.

l U sher Security: U sers l og i nto Web and Mobi l e usi ng U sher

Securi ty. U sher enabl es users to el ectroni cal l y val i date thei r
i denti ty usi ng the U sher app and mobi l e badge on thei r smartphone,
i nstead of enteri ng a passw ord. For steps, see Enabl i ng Badge
Authenti cati on for Web and Mobi l e, page 328.

For exampl es of si tuati ons w here you mi ght w ant to i mpl ement
speci fi c authenti cati on modes, and the steps to do so, see
Authenti cati on Exampl es, page 339.

Configuring the Authentication Mode for a Project

Source
You can confi gure a proj ect source to use a speci fi c authenti cati on
mode usi ng the Proj ect Source Manager. By defaul t, proj ect sources
use standard authenti cati on (see Impl ementi ng Standard
Authenti cati on, page 165).

To Configure the Authentication Mode for a Project Source

1. In D evel oper, from the Tools menu, sel ect Project Source
Manager.

2. Sel ect the appropri ate proj ect source and cl i ck Modify.

3. On the A dvanced tab, sel ect the appropri ate opti on for the
defaul t authenti cati on mode that you w ant to use.

© 2019, M icr o St r at egy In c. 163

Syst em Ad m in ist r at io n Gu id e

4. C l i ck OK tw i ce.

5. If the proj ect source i s accessed vi a Mi croStrategy Web or

Mi croStrategy Offi ce, there are addi ti onal steps that must be
fol l ow ed to confi gure the authenti cati on mode, as fol l ow s:

l To set the authenti cati on mode i n Mi croStrategy Web, use the

Mi croStrategy Web Admi ni strator's D efaul t Server Properti es
page.

l To set the authenti cati on mode i n Mi croStrategy Offi ce, use the
pr oj ec t s o u r c e s . x m l fi l e. For detai l ed i nstructi ons, see the
Mi croStrategy for Offi ce Onl i ne H el p.

Importing Users from Different Authentication Systems

You can i mport users from mul ti pl e di fferent authenti cati on systems,
such as from a database w arehouse and from an LD AP Server, i nto a
si ngl e Mi croStrategy metadata.

Each user that i s i mported i nto Mi croStrategy from a si ngl e

authenti cati on mechani sm i s created as a separate user obj ect i n the
Mi croStrategy metadata. For exampl e, i f U ser A i s i mported from your
LD AP Server i nto Mi croStrategy, the U ser A obj ect i s created i n the
Mi croStrategy metadata. If U ser A i s al so i mported from your N T
system, a separate U ser A obj ect (w e can cal l i t U ser A-N T) i s created
i n the metadata. Every ti me a user i s i mported i nto the Mi croStrategy
metadata, a separate user obj ect i s created.

As an al ternati ve, you can i mport U ser A from a si ngl e authenti cati on
system (LD AP, for exampl e), and then l i nk the U ser A obj ect that i s
created to the same user i n your N T system, and to the same user i n
your database w arehouse, and so on. U si ng l i nki ng, you can
"connect" or map mul ti pl e authenti cati on systems to a si ngl e user
obj ect i n the Mi croStrategy metadata.

164 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Sharing User Accounts Between Users

Mic roStrategy does not rec ommend s haring us er ac c ounts .

You may deci de to map several users to the same Mi croStrategy user
account. These users w oul d essenti al l y share a common l ogi n to the
system. C onsi der doi ng thi s onl y i f you have users w ho do not need to
create thei r ow n i ndi vi dual obj ects, and i f you do not need to moni tor
and i denti fy each i ndi vi dual user uni quel y.

Implementing Standard Authentication

Standard authenti cati on i s the defaul t authenti cati on mode and the
si mpl est to set up. Each user has a uni que l ogi n and passw ord and
can be i denti fi ed i n the Mi croStrategy appl i cati on uni quel y.

By defaul t, al l users connect to the data w arehouse usi ng one

R D BMS l ogi n ID , al though you can change thi s usi ng C onnecti on
Mappi ng. For more i nformati on, see C onnecti ng to the D ata
Warehouse, page 23. In addi ti on, standard authenti cati on i s the onl y
authenti cati on mode that al l ow s a user or system admi ni strator to
change or expi re Mi croStrategy passw ords.

When usi ng standard authenti cati on, Intel l i gence Server i s the
authenti cati on authori ty. Intel l i gence Server veri fi es and accepts the
l ogi n and passw ord provi ded by the user. Thi s i nformati on i s stored i n
the metadata reposi tory.

When a proj ect source i s confi gured to use standard authenti cati on,
users must enter a val i d l ogi n ID and passw ord combi nati on before
they can access the proj ect source.

Password Policy
A val i d passw ord i s a passw ord that conforms to any speci fi cati ons
you may have set. You can defi ne the fol l ow i ng characteri sti cs of

© 2019, M icr o St r at egy In c. 165

Syst em Ad m in ist r at io n Gu id e

passw ords:

l Whether a user must change thei r passw ord w hen they fi rst l og i nto
Mi croStrategy

l H ow often the passw ord expi res

l The number of past passw ords that the system remembers, so that
users cannot use the same passw ord

l Whether a user can i ncl ude thei r l ogi n and/or name i n the passw ord

l Whether or not rotati ng characters from l ast passw ord are al l ow ed

i n new passw ords

l Mi ni mum number of character changes

l R ul es for passw ord compl exi ty, i ncl udi ng:

l The mi ni mum number of characters that the passw ord must

contai n

l The mi ni mum number of upper-case characters that the passw ord

must contai n

l The mi ni mum number of l ow er-case characters that the passw ord

must contai n

l The mi ni mum number of numeri c characters, that i s, numbers from

0 to 9, that the passw ord must contai n

l The mi ni mum number of speci al characters, that i s, symbol s, that

the passw ord must contai n

The expi rati on setti ngs are made i n the U ser Edi tor and can be set for
each i ndi vi dual user. The compl exi ty and remembered passw ord
setti ngs are made i n the Securi ty Pol i cy Setti ngs di al og box, and
affect al l users.

166 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Steps to Implement Standard Authentication

The procedure bel ow gi ves the hi gh-l evel steps for confi guri ng your
Intel l i gence Server for standard authenti cati on.

High-Level Steps to Configuration Standard Authentication

1. In D evel oper, open the Proj ect Source Manager and cl i ck

Modify.

2. On the Advanced tab, sel ect U se login ID and password

entered by the user (standard authentication). Thi s i s the
defaul t setti ng.

3. In Mi croStrategy Web, l og i n as an admi ni strator. On the

Preferences page, sel ect Project D efaults, sel ect Security, and
then enabl e Standard (user name & password) as the l ogi n
mode.

4. In D evel oper, create a database i nstance for the data w arehouse

and assi gn i t a defaul t database l ogi n. Thi s i s the R D BMS
account that w i l l be used to execute reports from al l users.

Password Hashing for Standard Authentication

Begi nni ng w i th Mi croStrategy 10.11 a new hashi ng al gori thm that
provi des much stronger securi ty w i l l be i mpl emented. Associ ated w i th
thi s new al gori thm i s a new fi el d i n D evel oper that al l ow s the
Admi ni strator to sel ect the number of i terati ons that a passw ord i s
hashed. Thi s provi des even greater securi ty on top of the al gori thm by
i terati vel y hashi ng the hash a confi gurabl e number of ti mes. The
previ ous opti on to sel ect a hashi ng al gori thm has been removed.

The new hashi ng al gori thm w as i mpl emented i n the product to

conform w i th current i ndustri al securi ty best practi ces by fol l ow i ng the
gui dance of N IST Speci al Publ i cati on 800-63B for the protecti on of

© 2019, M icr o St r at egy In c. 167

Syst em Ad m in ist r at io n Gu id e

memori zed secrets. The fol l ow i ng i s an overvi ew of the al gori thm

used for passw ord hashi ng:

l A 512-bi t random val ue i s generated for the passw ord. Thi s val ue i s
stored i n the Metadata as i t i s requi red w hen veri fyi ng the
passw ord.

l A passw ord-based key defi ni ti on functi on (i .e., PBKD F2) i s

executed w hi ch accepts three rel evant parameters:

l The previ ousl y generated random val ue (i .e., the sal t).

l A hashi ng functi on (i n thi s case SH A-512).

l The number of i terati ons to perform the PBKD F2 al gori thm (set by
the admi ni strator as descri bed bel ow ).

The PBKD F2 al gori thm combi nes the user’ s passw ord and the
random sal t and then performs i t’ s operati ons by appl yi ng the
speci fi ed hashi ng functi on (SH A-512) by the number of i terati ons
speci fi ed. The resul t i s then stored i n the Metadata as the hash of the
passw ord.

For reference the OpenSSL PKC S5-PBKD F2-H MAC functi on i s used
to perform the PBKD F2/SH A-512 hashi ng.

For new i nstal l ati ons w i th new metadata begi nni ng w i th 10.11, the
new al gori thm and hashi ng process i s automati cal l y appl i ed.

For exi sti ng depl oyments that are upgradi ng to 10.11, there are
si mi l arl y no addi ti onal acti ons that need to be taken by the
Admi ni strator beyond opti onal l y changi ng the defaul t number of hash
i terati ons. H ow ever, there are tw o i mportant caveats associ ated w i th
upgradi ng to 10.11:

l If upgradi ng Intel l i gence Server and metadata, pre-10.11

i nstal l ati ons of C OM API cl i ents must al so be upgraded as they are
not compati bl e.

168 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Once the upgrade i s undertaken, i t i s not possi bl e to revert to an

earl i er versi on of metadata.

Once an i nstal l ati on has been upgraded to 10.11, the process of

converti ng user passw ord hashes from the ol d al gori thm to the new
al gori thm w i l l occur automati cal l y, transparent to both users and
Admi ni strators. There i s no need to ask users to enter new
passw ords. After the upgrade i s performed, each user's passw ord
hash w i l l be automati cal l y updated on the next l og i n.

Ch an gin g t h e Def au lt Nu mb er o f It er at io n s
1. Open D evel oper and ri ght-cl i ck on a proj ect source and sel ect
C onfigure Intelligence Server.

If y ou are running Mic roStrategy Dev eloper on Windows for the

firs t time, run it as an adminis trator.

Right-c lic k the program ic on and s elec t R un as A dministrator .

This is nec es s ary in order to properly s et the Windows regis try

k ey s . For more information, s ee KB43491 .

2. Open Server D efinition > Security.

3. Set the number of hash i terati ons i n the Encryption Level

secti on.

Implementing Anonymous Authentication

When usi ng anonymous authenti cati on, users l og i n as guests and do
not need to provi de a passw ord. Each guest user assumes the profi l e
defi ned by the Publ i c group.

This dy namic ally c reated gues t us er is not the s ame as the "Gues t" us er
whic h is v is ible in the Us er Manager.

© 2019, M icr o St r at egy In c. 169

Syst em Ad m in ist r at io n Gu id e

Guest users i nheri t securi ty setti ngs, i ncl udi ng pri vi l eges and
permi ssi ons, proj ect access, securi ty fi l ter, and connecti on map
i nformati on, from the Publ i c/Guest group; they are not part of the
Everyone group.

By defaul t, guest users have no pri vi l eges; you must assi gn thi s group
any pri vi l eges that you w ant the guest users to have. Pri vi l eges that
are grayed out i n the U ser Edi tor are not avai l abl e by defaul t to a
guest user. Other than the unavai l abl e pri vi l eges, you can determi ne
w hat the guest user can and cannot do by modi fyi ng the pri vi l eges of
the Publ i c/Guest user group and by granti ng or denyi ng i t access to
obj ects. For more i nformati on, see C ontrol l i ng Access to
Functi onal i ty: Pri vi l eges, page 109 and C ontrol l i ng Access to
Obj ects: Permi ssi ons, page 95.

Al l obj ects created by guest users must be saved to publ i c fol ders and
are avai l abl e to al l guest users. Guest users may use the H i story Li st,
but thei r messages i n the H i story Li st are not saved and are purged
w hen the guest users l og out.

To Enable Anonymous Access to a Project Source

By default, anony mous ac c es s is dis abled at both the s erv er and the
projec t lev els .

1. In D evel oper, l og i nto the proj ect source w i th a user that has
admi ni strati ve pri vi l eges.

2. From the fol der Li st, sel ect A dministration.

3. From the File menu, sel ect Properties.

4. In the Security tab, cl i ck A dd.

5. Sel ect the Publ i c/Guest group.

6. In the A ccess Permission l i st, sel ect C onnect.

170 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

7. C l i ck OK .

8. Fol l ow the procedure i n C onfi guri ng the Authenti cati on Mode for
a Proj ect Source, page 163 and sel ect A nonymous
authentication. When users l og i nto thi s proj ect source, they are
now automati cal l y l ogged i n as guest users and not prompted for
a l ogi n or passw ord.

Implementing LDAP Authentication

Li ghtw ei ght D i rectory Access Protocol (LD AP) i s an open standard
Internet protocol runni ng over TC P/IP that i s desi gned to mai ntai n and
w ork w i th l arge user di rectory servi ces. It provi des a standard w ay for
appl i cati ons to request and manage user and group di rectory
i nformati on. LD AP performs si mpl e S e l e c t operati ons agai nst l arge
di rectori es, i n w hi ch the goal i s to retri eve a col l ecti on of attri butes
w i th si mpl e qual i fi cati ons, for exampl e, S e l e c t a l l t h e
empl oy ee s' p h o n e n u m b e r s i n t h e s u p p o r t d i v i s i o n.

An LD AP authenti cati on system consi sts of tw o components: an LD AP

server and an LD AP di rectory. An LD AP server i s a program that
i mpl ements the LD AP protocol and control s access to an LD AP
di rectory of user and group accounts. An LD AP di rectory i s the
storage l ocati on and structure of user and group accounts on an
LD AP server. Before i nformati on from an LD AP di rectory can be
searched and retri eved, a connecti on to the LD AP server must be
establ i shed.

If you use an LD AP di rectory to central l y manage users i n your

envi ronment, you can i mpl ement LD AP authenti cati on i n
Mi croStrategy. Group membershi p can be mai ntai ned i n the LD AP
di rectory w i thout havi ng to al so be defi ned i n Intel l i gence Server.
LD AP authenti cati on i denti fi es users i n an LD AP di rectory w hi ch
Mi croStrategy can connect to through an LD AP server. Supported
LD AP servers i ncl ude N ovel l D i rectory Servi ces, Mi crosoft D i rectory

© 2019, M icr o St r at egy In c. 171

Syst em Ad m in ist r at io n Gu id e

Servi ces, OpenLD AP for Li nux, and Sun ON E 5.1/i Pl anet. For the
l atest set of certi fi ed and supported LD AP servers, refer to the
R eadme.

The hi gh-l evel steps to i mpl ement LD AP authenti cati on are as

fol l ow s:

1. R evi ew the LD AP i nformati on fl ow , descri bed i n LD AP

Informati on Fl ow , page 172.

2. D ependi ng on your requi rements, col l ect i nformati on and make

deci si ons regardi ng the i nformati on i n C heckl i st: Informati on
R equi red for C onnecti ng Your LD AP Server to Mi croStrategy,
page 174.

3. R un the LD AP C onnecti vi ty Wi zard to connect your LD AP server

to Mi croStrategy, as descri bed i n Setti ng up LD AP
Authenti cati on i n Mi croStrategy Web, Li brary, and Mobi l e, page
198.

4. To make changes i n your LD AP confi gurati on, use the

procedures descri bed i n Managi ng LD AP Authenti cati on, page
202.

You can al so set up Mi croStrategy Offi ce to use LD AP authenti cati on.

For i nformati on, see the Mi croStrategy for Offi ce Onl i ne H el p.

LDAP Information Flow

The fol l ow i ng scenari o presents a hi gh-l evel overvi ew of the general
fl ow of i nformati on betw een Intel l i gence Server and an LD AP server
w hen an LD AP user l ogs i nto D evel oper or Mi croStrategy Web.

LDAP User Lo gin In f o r mat io n Flo w

1. When an LD AP user l ogs i n to Mi croStrategy Web or D evel oper,
Intel l i gence Server connects to the LD AP server usi ng the

172 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

credenti al s for the LD AP admi ni strati ve user, cal l ed an

authenti cati on user.

2. The authenti cati on user i s bound to LD AP usi ng a D i sti ngui shed

N ame (D N ) and passw ord set up i n the user's confi gurati on.

3. The authenti cati on user searches the LD AP di rectory for the user
w ho i s l oggi ng i n vi a D evel oper or Mi croStrategy Web, based on
the D N of the user l oggi ng i n.

4. If thi s search successful l y l ocates the user w ho i s l oggi ng i n, the

user's LD AP group i nformati on i s retri eved.

5. Intel l i gence Server then searches the Mi croStrategy metadata to

determi ne w hether the D N of the user l oggi ng i n i s l i nked to an
exi sti ng Mi croStrategy user or not.

6. If a l i nked user i s not found i n the metadata, Intel l i gence Server

refers to the i mport and synchroni zati on opti ons that are
confi gured. If i mporti ng i s enabl ed, Intel l i gence Server updates
the metadata w i th the user and group i nformati on i t accessed i n
the LD AP di rectory.

7. The user w ho i s l oggi ng i n i s gi ven access to Mi croStrategy, w i th

appropri ate pri vi l eges and permi ssi ons.

LDAP An o n ymo u s Lo gin In f o r mat io n Flo w

When an LD AP anonymous (empty passw ord) l ogs i nto Mi croStrategy
Web or D evel oper, Intel l i gence Server checks w hether the LD AP
anonymous bi nd to the LD AP server i s successful . When thi s
succeeds, the Intel l i gence server authori zes the LD AP anonymous
l ogi n usi ng LD A P U sers and Everyone groups. The pri vi l eges and
permi ssi ons of LD AP U sers and Everyone groups are appl i ed.

© 2019, M icr o St r at egy In c. 173

Syst em Ad m in ist r at io n Gu id e

Checklist: Information Required for Connecting Your

LDAP Server to MicroStrategy
You can connect your LD AP server from your Intel l i gence Server
usi ng the LD AP C onnecti vi ty Wi zard. Before begi nni ng the process,
ensure that you have the fol l ow i ng i nformati on:

l The connecti on detai l s for your LD AP server. The i nformati on

requi red i s as fol l ow s:

l The machi ne name or IP address of the LD AP server.

l The netw ork port that the LD AP server uses.

l Whether the LD AP server i s accessed usi ng cl ear text, or over an

encrypted SSL connecti on. If you are usi ng an SSL connecti on,
you need to do the fol l ow i ng before you begi n to set up LD AP:

l Obtai n a val i d certi fi cate from your LD AP server and save i t on

the machi ne w here Intel l i gence Server i s i nstal l ed.

l Fol l ow the procedure recommended by your operati ng system to

i nstal l the certi fi cate.

l The user name and passw ord of an LD AP user w ho can search

the LD AP di rectory. Thi s user i s cal l ed the authenti cati on user,
and i s used by the Intel l i gence Server to connect to the LD AP
server. Typi cal l y, thi s user has admi ni strati ve pri vi l eges for your
LD AP server.

l D etai l s of your LD AP SD K. The LD AP SD K i s a set of connecti vi ty

fi l e l i brari es (D LLs) that Mi croStrategy uses to communi cate w i th
the LD AP server. For i nformati on on the requi rements for your
LD AP SD K, and for steps to set up the SD K, see Setti ng up LD AP
SD K connecti vi ty.

l Your LD AP search setti ngs, w hi ch al l ow Intel l i gence Server to

effecti vel y search through your LD AP di rectory to authenti cate

174 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

and i mport users. For i nformati on on defi ni ng LD AP search

setti ngs, see D efi ni ng LD AP Search Fi l ters to Veri fy and Import
U sers and Groups at Logi n, page 182.

Addi ti onal l y, dependi ng on your organi zati on's requi rements, i t i s

recommended that you make deci si ons and gather i nformati on about
the fol l ow i ng:

l D etermi ne w hether you w ant to use connecti on pool i ng w i th your

LD AP server. Wi th connecti on pool i ng, you can reuse an open
connecti on to the LD AP server for subsequent operati ons. The
connecti on to the LD AP server remai ns open even w hen the
connecti on i s not processi ng any operati ons (al so know n as
pool i ng). Thi s setti ng can i mprove performance by removi ng the
processi ng ti me requi red to open and cl ose a connecti on to the
LD AP server for each operati on.

For background i nformati on on connecti on pool i ng, see D etermi ni ng

Whether to U se C onnecti on Pool i ng, page 187.

l D etermi ne the method that Intel l i gence Server uses to authenti cate
users i n the LD AP server. The possi bl e opti ons are descri bed
bel ow :

l Bi ndi ng: If you choose thi s method, the Intel l i gence Server
attempts to l og i n to the LD AP server w i th the user's credenti al s.

l Passw ord compari son: If you choose thi s method, the Intel l i gence
Server veri fi es the user's user name and passw ord w i th the LD AP
server, w i thout attempti ng to l og i n to the LD AP server.

For a compari son of the tw o methods of authenti cati on, see

D etermi ni ng Whether to U se Authenti cati on Bi ndi ng or Passw ord
C ompari son, page 189.

l D etermi ne w hether you need to use database passthrough

executi on. In Mi croStrategy, a si ngl e user name and passw ord
combi nati on i s frequentl y used to connect to and execute j obs

© 2019, M icr o St r at egy In c. 175

Syst em Ad m in ist r at io n Gu id e

agai nst a database. H ow ever, you can choose to pass to the

database a user's LD AP user name and passw ord used to l og i n to
Mi croStrategy. The database i s then accessed and j obs are
executed usi ng the LD AP user name and passw ord. Thi s al l ow s
each user l ogged i n to Mi croStrategy to execute j obs agai nst the
database usi ng thei r uni que user name and passw ord w hi ch can be
gi ven a di fferent set of pri vi l eges than other users.

For addi ti onal i nformati on on database passthrough executi on, see

D etermi ni ng Whether to Enabl e D atabase Passthrough Executi on
w i th LD AP, page 189.

l D etermi ne w hether you w ant to i mport LD AP user and group

i nformati on i nto the Mi croStrategy metadata. A Mi croStrategy group
i s created for each LD AP group. The fol l ow i ng opti ons are
avai l abl e:

l Import users and groups i nto Mi croStrategy: If you choose thi s

opti on, a Mi croStrategy user i s created for each user i n your
LD AP di rectory. U sers can then be assi gned addi ti onal pri vi l eges
and permi ssi ons i n Mi croStrategy.

l Li nk users and groups to Mi croStrategy, w i thout i mporti ng them: If

you choose thi s opti on, a l i nk i s created betw een Mi croStrategy
users and users i n your LD AP di rectory, w i thout creati ng new
LD AP users i n your metadata. If you have an LD AP di rectory w i th
a l arge number of users, thi s opti on avoi ds fi l l i ng your metadata
w i th new users.

For i nformati on on the benefi ts and consi derati ons for i mporti ng
LD AP user and group i nformati on i nto Mi croStrategy, see
D etermi ni ng Whether to Import LD AP U sers i nto Mi croStrategy,
page 190.

l D etermi ne w hether you w ant to automati cal l y synchroni ze user and

group i nformati on w i th the LD AP server. Thi s ensures that i f there
are changes i n the group membershi p for the users you have

176 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

i mported i nto Mi croStrategy, or users w ho are l i nked to exi sti ng

Mi croStrategy accounts, the changes i n the LD AP di rectory are
appl i ed i n Mi croStrategy w hen users l og i n, or on a schedul e that
you determi ne.

For the benefi ts and consi derati ons of synchroni zi ng user and group
i nformati on, see D etermi ni ng Whether to Automati cal l y Synchroni ze
LD AP U ser and Group Informati on, page 195.

l If you choose to i mport LD AP user and group i nformati on i nto the

Mi croStrategy metadata, determi ne the fol l ow i ng:

l D etermi ne w hether you w ant to i mport LD AP user and group

i nformati on i nto the Mi croStrategy metadata w hen users l og i n,
and w hether the i nformati on i s synchroni zed every ti me users l og
i n.

l D etermi ne w hether you w ant to i mport LD AP user and group

i nformati on i nto the Mi croStrategy metadata i n batches, and
w hether you w ant the i nformati on to be synchroni zed accordi ng to
a schedul e.

l If you w ant to i mport LD AP user and group i nformati on i n batches,

you must provi de search fi l ters to i mport the users and the groups.
For exampl e, i f your organi zati on has 1,000 users i n the LD AP
di rectory, of w hom 150 need to use Mi croStrategy, you must
provi de a search fi l ter that i mports the 150 users i nto the
Mi croStrategy metadata. For i nformati on on defi ni ng search fi l ters,
see D efi ni ng LD AP Search Fi l ters to Veri fy and Import U sers and
Groups at Logi n, page 182.

l If your LD AP organi zati onal structure i ncl udes groups contai ned
w i thi n groups, determi ne how many recursi ve groups to i mport
w hen you i mport a user or group i nto Mi croStrategy.

To understand how thi s setti ng effects the w ay the users and groups
are i mported i nto Mi croStrategy, see the fol l ow i ng di agram:

© 2019, M icr o St r at egy In c. 177

Syst em Ad m in ist r at io n Gu id e

If you choose to i mport tw o nested groups w hen Mi croStrategy i mports

LD AP groups, the groups associ ated w i th each user are i mported, up
to tw o l evel s above the user. In thi s case, for U ser 1, the groups
D omesti c and Marketi ng w oul d be i mported. For U ser 3, D evel opers
and Empl oyees w oul d be i mported.

l If you use a si ngl e si gn-on (SSO) authenti cati on system, such as

Wi ndow s authenti cati on or i ntegrated authenti cati on, determi ne
w hether you w ant to i mport the LD AP user and group i nformati on for
users of your si ngl e si gn-on system.

l D etermi ne w hether the fol l ow i ng addi ti onal i nformati on i s i mported:

l The users' emai l addresses. If you have a l i cense for

Mi croStrategy D i stri buti on Servi ces, then w hen you i mport LD AP
users, you can i mport these emai l addresses as contacts
associ ated w i th those users.

l The Trusted Authenti cated R equest U ser ID for a 3rd party user.
When a 3rd party user l ogs i n, thi s Trusted Authenti cated R equest
U ser ID w i l l be used to fi nd the l i nked Mi croStrategy user.

l Addi ti onal LD AP attri butes to i mport. For exampl e, your LD AP

di rectory may i ncl ude an attri bute cal l ed a c c o u n t E x p i r e s,
w hi ch contai ns i nformati on about w hen the users' accounts
expi re. The attri butes i n your LD AP di rectory depend on the LD AP

178 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

server that you use, and your LD AP confi gurati on.

You can create securi ty fi l ters based on the LD AP attri butes that
you i mport. For exampl e, you i mport the LD AP attri bute
co un tr yN a m e, create a securi ty fi l ter based on that LD AP
attri bute, and then you assi gn that securi ty fi l ter to al l LD AP
users. N ow , w hen a user from Brazi l vi ew s a report that breaks
dow n sal es revenue by country, they onl y see the sal es data for
Brazi l .

For i nformati on on setti ng up securi ty fi l ters based on LD AP

attri butes, see Managi ng LD AP Authenti cati on, page 202.

Once you have col l ected the above i nformati on, you can use the
LD AP C onnecti vi ty Wi zard to set up your LD AP connecti on. The steps
are descri bed i n Setti ng up LD AP Authenti cati on i n Mi croStrategy
Web, Li brary, and Mobi l e, page 198.

Set t in g Up LDAP SDK Co n n ect ivit y

From the perspecti ve of your LD AP server, Intel l i gence Server i s an
LD AP cl i ent that uses cl ear text or encrypted SSL to connect to your
LD AP server through the LD AP SD K.

The LD AP SD K i s a set of connecti vi ty fi l e l i brari es (D LLs) that

Mi croStrategy uses to communi cate w i th the LD AP server. For the
l atest set of certi fi ed and supported LD AP SD K fi l es, refer to the
R eadme.

Intel l i gence Server requi res that the versi on of the LD AP SD K you are
usi ng supports the fol l ow i ng:

l LD AP v. 3

l SSL connecti ons

© 2019, M icr o St r at egy In c. 179

Syst em Ad m in ist r at io n Gu id e

l 64-bi t archi tecture on Li nux pl atforms

For LDAP to work properly with Intelligenc e Serv er, the 64-bit LDAP
libraries mus t be us ed.

The fol l ow i ng i mage show s how behavi or of the vari ous el ements i n
an LD AP confi gurati on affects other el ements i n the confi gurati on.

1. The behavi or betw een Intel l i gence Server and the LD AP SD K

vari es sl i ghtl y dependi ng on the LD AP SD K used. The R eadme
provi des an overvi ew of these behavi ors.

2. The behavi or betw een the LD AP SD K and the LD AP server i s

i denti cal , no matter w hi ch LD AP SD K i s used.

Mi croStrategy recommends that you use the LD AP SD K vendor that

corresponds to the operati ng system vendor on w hi ch Intel l i gence
Server i s runni ng i n your envi ronment. Speci fi c recommendati ons are
l i sted i n the R eadme, w i th the l atest set of certi fi ed and supported
LD AP SD Ks, references to Mi croStrategy Tech N otes w i th versi on-
speci fi c detai l s, and SD K dow nl oad l ocati on i nformati on.

High-Level Steps to Install the LDAP SDK DLLs

1. D ow nl oad the LD AP SD K D LLs onto the machi ne w here

Intel l i gence Server i s i nstal l ed.

180 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

2. Instal l the LD AP SD K.

3. R egi ster the l ocati on of the LD AP SD K fi l es as fol l ow s:

l Wi ndow s envi ronment: Add the path of the LD AP SD K l i brari es

as a system envi ronment vari abl e so that Intel l i gence Server
can l ocate them.

l Li nux envi ronment: Modi fy the L D A P . s h fi l e l ocated i n the e nv

fol der of your Mi croStrategy i nstal l ati on to poi nt to the l ocati on
of the LD AP SD K l i brari es. The detai l ed procedure i s
descri bed i n the procedure To Add the LD AP SD K Path to the
Envi ronment Vari abl e i n U N IX, page 181 bel ow .

4. R estart Intel l i gence Server.

To Add the LDAP SDK Path to the Environment Variable in UNIX

This proc edure as s umes y ou hav e ins talled an LDAP SDK. For high-
lev el s teps to ins tall an LDAP SDK, s ee H i gh-Level Steps to Instal l
the LD AP SD K D LLs, page 180 .

1. In a Li nux consol e w i ndow , brow se to H O M E _P A T H w here H O M E_

PA TH i s the speci fi ed home di rectory duri ng i nstal l ati on. Brow se
to the fol der /e n v i n thi s path.

2. Add W ri t e pri vi l eges to the L D A P . s h fi l e by typi ng the

command c h m o d u+ w L D A P . s h and then pressi ng E n t e r.

3. Open the L D A P . s h fi l e i n a text edi tor and add the l i brary path to
the M ST R _ L D A P _L IB R A R Y _P A T H envi ronment vari abl e. For
exampl e: M S T R _L D A P _L I B R A R Y _
PA TH =' / p a t h / L D A P / l i b r a r y '

It is rec ommended that y ou s tore all libraries in the s ame path. If

y ou hav e s ev eral paths , y ou c an add all paths to the M S T R _

© 2019, M icr o St r at egy In c. 181

Syst em Ad m in ist r at io n Gu id e

LD AP _L I B R A R Y _P A T H env ironment v ariable and s eparate them

by a c olon (:). For ex ample: M S T R _L D AP _L I B R A R Y _
PA TH = ' / p a t h / L D A P / l i b r a r y : / pa t h / L D A P / l i b r a r y
2'

4. R emove Wri te pri vi l eges from the L D A P . s h fi l e by typi ng the

command c h m o d a-w L D A P . s h and then pressi ng E n t e r.

5. R estart Intel l i gence Server for your changes to take effect.

Def in in g LDAP Sear ch Filt er s t o Ver if y an d Imp o r t User s an d

Gr o u p s at Lo gin
You must provi de Intel l i gence Server w i th some speci fi c parameters
so i t can search effecti vel y through your LD AP di rectory for user
i nformati on.

When users attempt to l og i n to Mi croStrategy, the Intel l i gence Server

authenti cates users by searchi ng the LD AP di rectory for the user's
D i sti ngui shed N ame, w hi ch i s a uni que w ay to i denti fy users w i thi n
the LD AP di rectory structure.

To search effecti vel y, Intel l i gence Server must know w here to start i ts
search. When setti ng up LD AP authenti cati on, i t i s recommended that
you i ndi cate a search root D i sti ngui shed N ame to establ i sh the
di rectory l ocati on from w hi ch Intel l i gence Server starts al l user and
group searches. If thi s search root i s not set, Intel l i gence Server
searches the enti re LD AP di rectory.

Addi ti onal l y, you can speci fy search fi l ters, w hi ch hel p narrow dow n
the users and groups to search.

The fol l ow i ng secti ons descri be the search setti ngs that you can
confi gure:

182 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l H i ghest Level to Start an LD AP Search: Search R oot, page 183

provi des exampl es of these parameters as w el l as addi ti onal detai l s
of each parameter and some LD AP server-speci fi c notes.

l Fi ndi ng U sers: U ser Search Fi l ters, page 184 provi des an overvi ew
of LD AP user search fi l ters.

l Fi ndi ng Groups: Group Search Fi l ters, page 185 provi des an

overvi ew of LD AP group search fi l ters.

Highest Level to Start an LDAP Search: Search Root

The fol l ow i ng di agram and tabl e present several exampl es of

possi bl e search roots based on how users mi ght be organi zed w i thi n
a company and w i thi n an LD AP di rectory. The di agram show s a
typi cal company's departmental structure. The tabl e descri bes several
user i mport scenari os based on the di agram.

The fol l ow i ng tabl e, based on the di agram above, provi des common
search scenari os for users to be i mported i nto Mi croStrategy. The
search root i s the root to be defi ned i n Mi croStrategy for the LD AP
di rectory.

Sc e na r io Se a r c h Root

I nclude all users and groups Operat ions

© 2019, M icr o St r at egy In c. 183

Syst em Ad m in ist r at io n Gu id e

Sc e na r io Se a r c h Root

f rom Operat ions

I nclude all users and groups

f rom Operat ions, Consult ant s, S ales
and S ales

I nclude all users and groups Depart ment s (wit h an exclusion clause in t he
f rom Operat ions, Consult ant s, User/ Group search f ilt er t o exclude users who
and Technology belong t o Market ing and A dminist rat ion)

I nclude all users and groups

Depart ment s (wit h an exclusion clause in t he
f rom Technology and
User/ Group search f ilt er t o exclude users who
Operat ions but not
belong t o Consult ant s. )
Consult ant s.

For some LD AP vendors, the search root cannot be the LD AP tree's

root. For exampl e, both Mi crosoft Acti ve D i rectory and Sun ON E
requi re a search to begi n from the domai n control l er R D N (dc). The
i mage bel ow show s an exampl e of thi s type of R D N , w here "dc=sal es,
dc=mi crostrategy, dc=com":

Finding Users: User Search Filters

U ser search fi l ters al l ow Mi croStrategy to effi ci entl y search an LD AP

di rectory to authenti cate or i mport a user at l ogi n.

184 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Once Intel l i gence Server l ocates the user i n the LD AP di rectory, the
search returns the user's D i sti ngui shed N ame, and the passw ord
entered at user l ogi n i s veri fi ed agai nst the LD AP di rectory.
Intel l i gence Server uses the authenti cati on user to access, search i n,
and retri eve the i nformati on from the LD AP di rectory.

U si ng the user's D i sti ngui shed N ame, Intel l i gence Server searches
for the LD AP groups that the user i s a member of. You must enter the
group search fi l ter parameters separatel y from the user search fi l ter
parameters (see Fi ndi ng Groups: Group Search Fi l ters, page 185).

U ser search fi l ters are general l y i n the form ( &

(obj ec tc la s s = L D A P _U S E R _O B J E C T _C L A S S) (L D A P _L O G I N _
ATTR = #L DA P_ L O G I N # ) ) w here:

l LD AP _ US ER _O B J E C T _C L A S S i ndi cates the obj ect cl ass of the

LD AP users. For exampl e, you can enter ( &
(o bj ec tc l a s s =p e r s o n) ( c n = # L D A P _L O G I N # ) ).

l LD AP _ LO GI N _A T T R i ndi cates w hi ch LD AP attri bute to use to store

LD AP l ogi ns. For exampl e, you can enter ( &
(o bj ec tc l a s s =person) (c n= # L D A P _L O G I N # ) ).

l #L DA P_ L OG I N # can be used i n thi s fi l ter to represent the LD AP

user l ogi n.

D ependi ng on your LD AP server vendor and your LD AP tree structure,

you may need to try di fferent attri butes w i thi n the search fi l ter syntax
above. For exampl e, ( &( o b j e c t c l a s s = p e r s o n )
(uni qu eI D = # L D A P _L O G I N # ) ), w here u n i q u e I D i s the LD AP
attri bute name your company uses for authenti cati on.

Finding Groups: Group Search Filters

Group search fi l ters al l ow Mi croStrategy to effi ci entl y search an LD AP

di rectory for the groups to w hi ch a user bel ongs. These fi l ters can be

© 2019, M icr o St r at egy In c. 185

Syst em Ad m in ist r at io n Gu id e

confi gured i n the Intel l i gence Server C onfi gurati on Edi tor, under the
LD AP subj ect.

The group search fi l ter i s general l y i n one of the fol l ow i ng forms (or
the fol l ow i ng forms may be combi ned, usi ng a pi pe | symbol to
separate the forms):

l (&(objectclass=LDAP_GROUP_OBJECT_CLASS) (LDAP_MEMBER_
LOGIN_ATTR=#LDAP_LOGIN#))

l (&(objectclass=LDAP_GROUP_OBJECT_CLASS) (LDAP_MEMBER_DN_
ATTR=#LDAP_DN#))

l (&(objectclass=LDAP_GROUP_OBJECT_CLASS)
(gidNumber=#LDAP_GIDNUMBER#))

The group search fi l ter forms l i sted above have the fol l ow i ng
pl acehol ders:

l LD AP _ GR OU P _O B J E C T _C L A S S i ndi cates the obj ect cl ass of the

LD AP groups. For exampl e, you can enter ( &
(o bj ec tc l a s s =g r o u p O f N a m e s)( m e m b e r = # L D A P _D N # ) ).

l LD AP _ ME MB E R _[ L O G I N o r D N ]_A T T R i ndi cates w hi ch LD AP

attri bute of an LD AP group i s used to store LD AP l ogi ns/D N s of the
LD AP users. For exampl e, you can enter ( &
(o bj ec tc l a s s = g r o u p O f N a m e s )(m e m b e r= # L D A P _D N # ) ).

l #L DA P_ D N# can be used i n thi s fi l ter to represent the di sti ngui shed

name of an LD AP user.

l #L DA P_ L OG I N # can be used i n thi s fi l ter to represent an LD AP

user's l ogi n.

l #L DA P_ G ID N U M B E R # can be used i n thi s fi l ter to represent the

U N IX or Li nux group ID number; thi s corresponds to the LD AP
attri bute gi d N u m b e r.

186 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

You can i mpl ement speci fi c search patterns by addi ng addi ti onal
cri teri a. For exampl e, you may have 20 di fferent groups of users, of
w hi ch onl y fi ve groups w i l l be accessi ng and w orki ng i n
Mi croStrategy. You can add addi ti onal cri teri a to the group search
fi l ter to i mport onl y those fi ve groups.

Det er min in g Wh et h er t o Use Co n n ect io n Po o lin g

Wi th connecti on pool i ng, you can reuse an open connecti on to the
LD AP server for subsequent operati ons. The connecti on to the LD AP
server remai ns open even w hen the connecti on i s not processi ng any
operati ons (al so know n as pool i ng). Thi s setti ng can i mprove
performance by removi ng the processi ng ti me requi red to open and
cl ose a connecti on to the LD AP server for each operati on.

If you do not use connecti on pool i ng, the connecti on to an LD AP

server i s cl osed after each request. If requests are sent to the LD AP
server i nfrequentl y, thi s can hel p reduce the use of netw ork
resources.

Connection Pooling with Clustered LDAP Servers

You may have mul ti pl e LD AP servers w hi ch w ork together as a cl uster

of LD AP servers.

If connecti on pool i ng i s di sabl ed, w hen a request to open an LD AP

connecti on i s made, the LD AP server w i th the l i ghtest l oad at the ti me
of the request i s accessed. The operati on agai nst the LD AP di rectory
can then be compl eted, and i n an envi ronment w i thout connecti on
pool i ng, the connecti on to the LD AP server i s cl osed. When the next
request to open an LD AP connecti on i s made, the LD AP server w i th
the l east amount of l oad i s determi ned agai n and chosen.

If you enabl e connecti on pool i ng for a cl ustered LD AP envi ronment,

the behavi or i s di fferent than descri bed above. On the fi rst request to
open an LD AP connecti on, the LD AP server w i th the l east amount of

© 2019, M icr o St r at egy In c. 187

Syst em Ad m in ist r at io n Gu id e

l oad at the ti me of the request i s accessed. H ow ever, the connecti on

to the LD AP server i s not cl osed because connecti on pool i ng i s
enabl ed. Therefore, i nstead of determi ni ng the LD AP server w i th the
l east amount of l oad duri ng the next request to open an LD AP
connecti on, the currentl y open connecti on i s reused.

The di agrams show n bel ow i l l ustrate how subsequent connecti ons to

a cl ustered LD AP server envi ronment are handl ed, dependi ng on
w hether connecti on pool i ng i s enabl ed or di sabl ed.

188 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Det er min in g Wh et h er t o Use Au t h en t icat io n Bin d in g o r

Passwo r d Co mp ar iso n
When Mi croStrategy attempts to authenti cate an LD AP user l oggi ng i n
to Mi croStrategy, you can choose to perform an LD AP bi nd to
authenti cate the user or si mpl y authenti cate on user name and
passw ord.

By i mpl ementi ng authenti cati on bi ndi ng, Mi croStrategy authenti cates

the user by l oggi ng i n to the LD AP server w i th the user's credenti al s,
and assessi ng the fol l ow i ng user restri cti ons:

l Whether the LD AP passw ord i s i ncorrect, has been l ocked out, or

has expi red

l Whether the LD AP user account has been di sabl ed, or has been
i denti fi ed as an i ntruder and i s l ocked out

If Mi croStrategy can veri fy that none of these restri cti ons are i n effect
for thi s user account, Mi croStrategy performs an LD AP bi nd, and
successful l y authenti cates the user l oggi ng i n. Thi s i s the defaul t
behavi or for users and groups that have been i mported i nto
Mi croStrategy.

You can choose to have Mi croStrategy veri fy onl y the accuracy of the
user's passw ord w i th w hi ch the user l ogged i n, and not check for
addi ti onal restri cti ons on the passw ord or user account. To support
passw ord compari son authenti cati on, your LD AP server must al so be
confi gured to al l ow passw ord compari son onl y.

Det er min in g Wh et h er t o En ab le Dat ab ase Passt h r o u gh

Execu t io n wit h LDAP
In Mi croStrategy, a si ngl e user name and passw ord combi nati on i s
frequentl y used to connect to and execute j obs agai nst a database.
H ow ever, you can choose to pass a user's LD AP user name and
passw ord used to l og i n to Mi croStrategy to the database. The

© 2019, M icr o St r at egy In c. 189

Syst em Ad m in ist r at io n Gu id e

database i s then accessed and j obs are executed usi ng the LD AP

user name and passw ord. Thi s al l ow s each user l ogged i n to
Mi croStrategy to execute j obs agai nst the database usi ng thei r uni que
user name and passw ord, w hi ch can be gi ven a di fferent set of
pri vi l eges than other users.

D atabase passthrough executi on i s sel ected for each user

i ndi vi dual l y. For general i nformati on on sel ecti ng user authenti cati on,
see About Mi croStrategy U sers, page 87.

If a user's passw ord i s changed duri ng a sessi on i n Mi croStrategy,

schedul ed tasks may fai l to run w hen usi ng database passthrough
executi on.

Cons ider the following s c enario.

A us er with us er login Us erA and pas s word Pas s A logs in to Mic roStrategy
at 9:00 A.M. and c reates a new report. The us er s c hedules the report to run
at 3:00 P.M. later that day . Sinc e there is no report c ac he, the report will be
ex ec uted agains t the databas e. At noon, an adminis trator c hanges Us erA's
pas s word to Pas s B. Us erA does not log bac k into Mic roStrategy , and at
3:00 P.M. the s c heduled report is run with the c redentials Us erA and
Pas s A, whic h are pas s ed to the databas e. Sinc e thes e c redentials are now
inv alid, the s c heduled report ex ec ution fails .

To prevent thi s probl em, schedul e passw ord changes for a ti me w hen
users are unl i kel y to run schedul ed reports. In the case of users usi ng
database passthrough executi on w ho regul arl y run schedul ed reports,
i nform them to reschedul e al l reports i f thei r passw ords have been
changed.

Det er min in g Wh et h er t o Imp o r t LDAP User s in t o

Micr o St r at egy
To connect your LD AP users and groups to users and groups i n
Mi croStrategy, you can ei ther i mport the LD AP users and groups i nto

190 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

the Mi croStrategy metadata or you can create a l i nk betw een users

and groups i n the LD AP di rectory and i n Mi croStrategy. Importi ng a
user creates a new user i n Mi croStrategy based on an exi sti ng user i n
the LD AP di rectory. Li nki ng a user connects an LD AP user's
i nformati on to an exi sti ng user i n Mi croStrategy. You can al so al l ow
LD AP users to l og i n to the Mi croStrategy system anonymousl y,
w i thout an associ ated Mi croStrategy user. The benefi ts and
consi derati ons of each method are descri bed i n the tabl e bel ow .

Conne c tion
Be ne fits Cons ide r a tions
Ty pe

l Users and groups are creat ed l I n environment s t hat have many

in t he met adat a. LDA P users, import ing can
l Users and groups can be quickly f ill t he met adat a wit h
I mport t hese users and t heir relat ed
assigned addit ional privileges
LDA P inf ormat ion.
and permissions in
users and
MicroS t rat egy. l Users and groups may not have
groups
l Users have t heir own inboxes t he correct permissions and
and personal f olders in privileges when t hey are init ially
MicroS t rat egy. import ed int o MicroS t rat egy.

l For environment s t hat have

many LDA P users, linking
Link users avoids f illing t he met adat a
wit h users and t heir relat ed l Users t o be linked t o must
and groups
inf ormat ion. already exist in t he MicroS t rat egy
wit hout
met adat a.
import ing l Y ou can use Command
Manager t o aut omat e t he
linking process using script s.

l P rivileges are limit ed t o t hose f or

A llow t he P ublic/ Guest group and
l Users can log in immediat ely LDA P P ublic group.
anonymous
wit hout having t o creat e a new
or guest l Users' personal f olders and
MicroS t rat egy user.
users I nboxes are delet ed f rom t he
syst em af t er t hey log out .

© 2019, M icr o St r at egy In c. 191

Syst em Ad m in ist r at io n Gu id e

The opti ons for i mporti ng users i nto Mi croStrategy are descri bed i n
detai l i n the fol l ow i ng secti ons:

l Importi ng LD AP U sers and Groups i nto Mi croStrategy, page 192

l Li nki ng U sers and Groups Wi thout Importi ng, page 193

l Al l ow i ng Anonymous/Guest U sers w i th LD AP Authenti cati on, page

194

You can modi fy your i mport setti ngs at any ti me, for exampl e, i f you
choose not to i mport users i ni ti al l y, but w ant to i mport them at some
poi nt i n the future. The steps to modi fy your LD AP setti ngs are
descri bed i n Managi ng LD AP Authenti cati on, page 202.

Importing LDAP Users and Groups into MicroStrategy

You can choose to i mport LD AP users and groups at l ogi n, i n a batch

process, or a combi nati on of the tw o. Imported users are automati cal l y
members of Mi croStrategy's LD AP U sers group, and are assi gned the
access control l i st (AC L) and pri vi l eges of that group. To assi gn
di fferent AC Ls or pri vi l eges to a user, you can move the user to
another Mi croStrategy user group.

When an LD AP user i s i mported i nto Mi croStrategy, you can al so

choose to i mport that user's LD AP groups. If a user bel ongs to more
than one group, al l the user's groups are i mported and created i n the
metadata. Imported LD AP groups are created w i thi n Mi croStrategy's
LD AP U sers fol der and i n Mi croStrategy's U ser Manager.

LD AP users and LD AP groups are al l created w i thi n the Mi croStrategy

LD AP U sers group at the same l evel . Whi l e the LD AP rel ati onshi p
betw een a user and any associ ated groups exi sts i n the Mi croStrategy
metadata, the rel ati onshi p i s not vi sual l y represented i n D evel oper.
For exampl e, l ooki ng i n the LD AP U sers fol der i n Mi croStrategy
i mmedi atel y after an i mport or synchroni zati on, you mi ght see the
fol l ow i ng l i st of i mported LD AP users and groups:

192 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

If you w ant a users' groups to be show n i n Mi croStrategy, you must

manual l y move them i nto the appropri ate groups.

The rel ati onshi p betw een an i mported LD AP user or group and the
Mi croStrategy user or group i s mai ntai ned by a l i nk i n the
Mi croStrategy metadata, w hi ch i s i n the form of a D i sti ngui shed
N ame. A D i sti ngui shed N ame (D N ) i s the uni que i denti fi er of an entry
(i n thi s case a user or group) i n the LD AP di rectory.

The Mic roStrategy us er's Dis tinguis hed Name is different from the DN
as s igned for the authentic ation us er. The authentic ation us er's DN is the
DN of the Mic roStrategy ac c ount that is us ed to c onnec t to the LDAP
s erv er and s earc h the LDAP direc tory . The authentic ation us er c an be
any one who has s earc h priv ileges in the LDAP s erv er, and is generally
the LDAP adminis trator.

R emovi ng a user from the LD AP di rectory does not effect the user's
presence i n the Mi croStrategy metadata. D el eted LD AP users are not
automati cal l y del eted from the Mi croStrategy metadata duri ng
synchroni zati on. You can revoke a user's pri vi l eges i n Mi croStrategy,
or remove the user manual l y.

You cannot export users or groups from Mi croStrategy to an LD AP

di rectory.

Linking Users and Groups Without Importing

A l i nk i s a connecti on betw een an LD AP user or group and a

Mi croStrategy user or group w hi ch al l ow s an LD AP user to l og i n to

© 2019, M icr o St r at egy In c. 193

Syst em Ad m in ist r at io n Gu id e

Mi croStrategy. U nl i ke an i mported LD AP user, a l i nked LD AP user i s

not created i n the Mi croStrategy metadata.

An LD AP group can onl y be l i nked to a Mi croStrategy group, and an

LD AP user can onl y be l i nked to a Mi croStrategy user. It i s not
possi bl e to l i nk a group to a user w i thout gi vi ng the user membershi p
i n the group.

When an LD AP user or group i s l i nked to an exi sti ng Mi croStrategy

user or group, no new user or group i s created w i thi n the
Mi croStrategy metadata as w i th i mporti ng. Instead, a l i nk i s
establ i shed betw een an exi sti ng Mi croStrategy user or group and an
LD AP user or group, w hi ch al l ow s the LD AP user to l og i n to
Mi croStrategy.

The l i nk betw een an LD AP user or group and the Mi croStrategy user

or group i s mai ntai ned i n the Mi croStrategy metadata i n the form of a
shared D i sti ngui shed N ame.

The user's or group's LD AP pri vi l eges are not l i nked w i th the

Mi croStrategy user. In Mi croStrategy, a l i nked LD AP user or group
recei ves the pri vi l eges of the Mi croStrategy user or group to w hi ch i t
i s l i nked.

LD AP groups cannot be l i nked to Mi croStrategy user groups. For

exampl e, you cannot l i nk an LD AP group to Mi croStrategy's Everyone
group. H ow ever, i t i s possi bl e to l i nk an LD AP user to a Mi croStrategy
user that has membershi p i n a Mi croStrategy group.

Allowing Anonymous/Guest Users with LDAP Authentication

An LD AP anonymous l ogi n i s an LD AP l ogi n w i th an empty l ogi n

and/or empty passw ord. A successful LD AP anonymous l ogi n i s
authori zed w i th the pri vi l eges and access ri ghts of LD AP Publ i c and
Publ i c/Guest groups. The LD AP server must be confi gured to al l ow
anonymous or guest authenti cati on requests from Mi croStrategy.

194 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Bec aus e gues t us ers are not pres ent in the metadata, there are c ertain
ac tions thes e us ers c annot perform in Mic roStrategy , ev en if the
as s oc iated priv ileges and permis s ions are ex plic itly as s igned.
Ex amples inc lude mos t adminis trativ e ac tions .

When the user i s l ogged i n as an anonymous/guest user:

l The user does not have a H i story Li st, because the user i s not
physi cal l y present i n the metadata.

l The user cannot create obj ects and cannot schedul e reports.

l The U ser C onnecti on moni tor records the LD AP user's user name.

l Intel l i gence Server stati sti cs record the sessi on i nformati on under
the user name LD AP U SER .

Det er min in g Wh et h er t o Au t o mat ically Syn ch r o n ize LDAP

User an d Gr o u p In f o r mat io n
In any company's securi ty model , steps must be taken to account for a
changi ng group of empl oyees. Addi ng new users and removi ng ones
that are no l onger w i th the company i s strai ghtforw ard. Accounti ng for
changes i n a user's name or group membershi p can prove more
compl i cated. To ease thi s process, Mi croStrategy supports user
name/l ogi n and group synchroni zati on w i th the i nformati on contai ned
w i thi n an LD AP di rectory.

If you choose to have Mi croStrategy automati cal l y synchroni ze LD AP

users and groups, any LD AP group changes that have occurred w i thi n
the LD AP server w i l l be appl i ed w i thi n Mi croStrategy the next ti me an
LD AP user l ogs i n to Mi croStrategy. Thi s keeps the LD AP di rectory
and the Mi croStrategy metadata i n synchroni zati on.

By synchroni zi ng users and groups betw een your LD AP server and

Mi croStrategy, you can update the i mported LD AP users and groups
i n the Mi croStrategy metadata w i th the fol l ow i ng modi fi cati ons:

© 2019, M icr o St r at egy In c. 195

Syst em Ad m in ist r at io n Gu id e

l U ser synchronization: U ser detai l s such as user name i n

Mi croStrategy are updated w i th the l atest defi ni ti ons i n the LD AP
di rectory.

l Group synchronization: Group detai l s such as group name i n

Mi croStrategy are updated w i th the l atest defi ni ti ons i n the LD AP
di rectory.

When synchroni zi ng LD AP users and groups i n Mi croStrategy, you

shoul d be aw are of the fol l ow i ng ci rcumstances:

l If an LD AP user or group has been gi ven new membershi p to a

group that has not been i mported or l i nked to a group i n
Mi croStrategy and i mport opti ons are turned off, the group cannot
be i mported i nto Mi croStrategy and thus cannot appl y i ts
permi ssi ons i n Mi croStrategy.

For exampl e, U ser1 i s a member of Group1 i n the LD AP di rectory,

and both have been i mported i nto Mi croStrategy. Then, i n the LD AP
di rectory, U ser1 i s removed from Group1 and gi ven membershi p to
Group2. H ow ever, Group2 i s not i mported or l i nked to a
Mi croStrategy group. U pon synchroni zati on, i n Mi croStrategy, U ser1
i s removed from Group1, and i s recogni zed as a member of Group2.
H ow ever, any permi ssi ons for Group2 are not appl i ed for the user
unti l Group2 i s i mported or l i nked to a Mi croStrategy group. In the
i nteri m, U ser1 i s gi ven the pri vi l eges and permi ssi ons of the LD AP
U sers group.

l When users and groups are del eted from the LD AP di rectory, the
correspondi ng Mi croStrategy users and groups that have been
i mported from the LD AP di rectory remai n i n the Mi croStrategy
metadata. You can revoke users' and groups' pri vi l eges i n
Mi croStrategy and remove the users and groups manual l y.

l R egardl ess of your synchroni zati on setti ngs, i f a user's passw ord i s
modi fi ed i n the LD AP di rectory, a user must l og i n to Mi croStrategy
w i th the new passw ord. LD AP passw ords are not stored i n the

196 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Mi croStrategy metadata. Mi croStrategy uses the credenti al s

provi ded by the user to search for and val i date the user i n the LD AP
di rectory.

C onsi der a user named Joe D oe w ho bel ongs to a parti cul ar group,
Sal es, w hen he i s i mported i nto Mi croStrategy. Later, he i s moved to a
di fferent group, Marketi ng, i n the LD AP di rectory. The LD AP user Joe
D oe and LD AP groups Sal es and Marketi ng have been i mported i nto
Mi croStrategy. Fi nal l y, the user name for Joe D oe i s changed to
Joseph D oe, and the group name for Marketi ng i s changed to
Marketi ngLD AP.

The i mages bel ow show a sampl e LD AP di rectory w i th user Joe D oe

bei ng moved w i thi n the LD AP di rectory from Sal es to Marketi ng.

The fol l ow i ng tabl e descri bes w hat happens w i th users and groups i n
Mi croStrategy i f users, groups, or both users and groups are
synchroni zed.

© 2019, M icr o St r at egy In c. 197

Syst em Ad m in ist r at io n Gu id e

Sy nc Sy nc Us e r Na me Afte r Gr oup Na me Afte r

Us e r s ? Gr oups ? Sy nc hr oniza tion Sy nc hr oniza tion

No No Joe Doe Market ing

No Y es Joe Doe Market ingLDA P

Y es No Joseph Doe Market ing

Y es Y es Joseph Doe Market ingLDA P

Setting up LDAP Authentication in MicroStrategy Web,

Library, and Mobile
When you have col l ected the connecti on i nformati on for your LD AP
server and your LD AP SD K, you can use the LD AP C onnecti vi ty
Wi zard to set up your LD AP connecti on. The LD AP C onnecti vi ty
Wi zard hel ps step you through the i ni ti al setup of usi ng your LD AP
server to authenti cate users and groups i n Mi croStrategy. The steps
to set up your LD AP connecti on are the same for Mi croStrategy Web,
Mi croStrategy Li brary, and Mi croStrategy Mobi l e. For more
i nformati on on setti ng up LD AP w i th your Mi croStrategy, see the
System Admi ni strati on Gui de.

l You hav e c ollec ted the information for y our LDAP s erv er, and made
dec is ions regarding the LDAP authentic ation methods y ou want to us e,
as des c ribed in C heckl i st: Informati on R equi red for C onnecti ng Your
LD AP Server to Mi croStrategy, page 174 . in the System
Admi ni strati on Gui de .

l If y ou want Intelligenc e Serv er to ac c es s y our LDAP s erv er ov er a s ec ure

SSL c onnec tion, y ou mus t do the following:

1. Obtain a v alid c ertific ate from y our LDAP s erv er and s av e it on the
mac hine where Intelligenc e Serv er is ins talled. The s teps to obtain
the c ertific ate depend on y our LDAP v endor, and the operating

198 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

s y s tem that y our LDAP s erv er runs on. For s pec ific s teps , refer to
the doc umentation for y our LDAP v endor.

2. Follow the proc edure rec ommended by y our operating s y s tem to

ins tall the c ertific ate.

To Set up LDAP Authentication in MicroStrategy

Connect i ng Your LDAP Ser ver U si ng t he LDAP Connect i vi t y Wi zar d

1. In D evel oper, l og i n to a proj ect source, as a user w i th

admi ni strati ve pri vi l eges.

2. From the A dministration menu, sel ect Server, and cl i ck LD A P

C onnectivity Wizard.

3. On the Wel come page, cl i ck N ext.

4. Type the fol l ow i ng i nformati on:

l H ost: The machi ne name or IP address of the LD AP server.

l Port: The netw ork port that the LD AP server uses. For cl ear
text connecti ons, the defaul t val ue i s 38 9. If you w ant
Intel l i gence Server to access your LD AP over an encrypted
SSL connecti on, the defaul t val ue i s 6 3 6.

5. If you w ant Intel l i gence Server to access your LD AP over an

encrypted SSL connecti on, sel ect SSL (encrypted). The Server
C erti fi cate fi l e fi el d i s enabl ed.

6. In the Server C ertificate file fi el d, dependi ng on your LD AP

server vendor, poi nt to the SSL certi fi cate i n the fol l ow i ng w ays:

l Microsoft A ctive D irectory: N o i nformati on i s requi red.

l Sun ON E/iPlanet: Provi de the path to the certi fi cate. D o not

i ncl ude the fi l e name.

© 2019, M icr o St r at egy In c. 199

Syst em Ad m in ist r at io n Gu id e

l N ovell: Provi de the path to the certi fi cate, i ncl udi ng the fi l e
name.

l IB M: U se Java GSKi t 7 to i mport the certi fi cate, and provi de

the key database name w i th ful l path, starti ng w i th the home
di rectory.

l Open LD A P: Provi de the path to the di rectory that contai ns the

C A certi fi cate fi l e c a c e r t . p e m, the server certi fi cate fi l e
se rv er c r t . p e m, and the server certi fi cate key fi l e
se rv er k e y . p e m.

7. C l i ck N ext.

8. Enter the detai l s of your LD AP SD K, and cl i ck N ext.

9. Step through the LD AP C onnecti vi ty Wi zard to enter the

remai ni ng i nformati on, such as the LD AP search fi l ters to use to
fi nd users, w hether to i mport users i nto Mi croStrategy, and so on.

10. When you have entered al l the i nformati on, cl i ck Finish to exi t
the LD AP C onnecti vi ty Wi zard. You are prompted to test the
LD AP connecti on. It i s recommended that you test the connecti on
to catch any errors w i th the connecti on parameters you have
provi ded.

Enab l i ng LDAP Aut hent i cat i on f or Your Pr oj ect Sour ce

1. In the Fol der Li st, ri ght-cl i ck the proj ect source, and sel ect
Modify Project Source.

2. On the A dvanced tab, go to U se LD A P A uthentication.

3. C l i ck OK .

200 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Enab l i ng LDAP Aut hent i cat i on f or M i cr oSt r at egy Web

1. From the Wi ndow s Start menu go to A ll Programs >

MicroStrategy Tools > Web A dministrator.

2. Sel ect Intelligence Server > D efault Properties.

3. In the Login area, for LD A P A uthentication, sel ect the Enabled

check box.

4. Sel ect the D efault opti on to set LD AP as the defaul t

authenti cati on mode.

If y our env ironment inc ludes multiple Intelligenc e Serv ers

c onnec ted to one Mic roStrategy Web s erv er, us ers are
authentic ated to all the Intelligenc e Serv ers us ing their LDAP
c redentials , and then s hown a lis t of projec ts they c an ac c es s .
Howev er, if one or more of the Intelligenc e Serv ers does not us e
LDAP authentic ation, the projec ts for thos e s erv ers may not be
dis play ed. To av oid this s c enario, in the Project list drop-down
menu, ens ure that Show all the projects connected to the
Web Server before the user logs in is s elec ted.

5. C l i ck Save.

Enab l i ng LDAP Aut hent i cat i on f or M i cr oSt r at egy Li b r ar y

1. Launch the Li brary Admi n page by enteri ng the fol l ow i ng U R L i n

your w eb brow ser

ht tp :/ / < F Q D N > : < p o r t > / M i c r o S t r a t e g y L i b r a r y / a d m in

w here < F Q D N > i s the Ful l y Qual i fi ed D omai n N ame of the

machi ne hosti ng your Mi croStrategy Li brary appl i cati on and
<p or t> i s the assi gned port number.

2. On the Library Web Server tab, sel ect LD A P from the l i st of

avai l abl e A uthentication Modes.

© 2019, M icr o St r at egy In c. 201

Syst em Ad m in ist r at io n Gu id e

3. C l i ck Save.

4. R estart your Web Server to appl y the change.

Managing LDAP Authentication

Whi l e w orki ng w i th Mi croStrategy and i mpl ementi ng LD AP
authenti cati on, you may w ant to i mprove performance or troubl eshoot
your LD AP i mpl ementati on. The secti ons bel ow cover steps that can
hel p your LD AP authenti cati on and Mi croStrategy systems w ork as a
cohesi ve uni t.

l If your LD AP server i nformati on changes, or to edi t your LD AP

authenti cati on setti ngs i n general , see Modi fyi ng Your LD AP
Authenti cati on Setti ngs, page 203.

l If you w ant to modi fy the setti ngs for i mporti ng users i nto
Mi croStrategy, for exampl e, i f you i ni ti al l y chose not to i mport users,
and now w ant to i mport users and groups, see Importi ng LD AP
U sers and Groups i nto Mi croStrategy, page 204.

l If you choose to synchroni ze users and groups i n batches, and w ant

to sel ect a synchroni zati on schedul e, see Sel ecti ng Schedul es for
Importi ng and Synchroni zi ng U sers, page 208.

l If you are usi ng si ngl e si gn-on (SSO) authenti cati on systems, such
as Wi ndow s N T authenti cati on or trusted authenti cati on, you can
l i nk users' SSO credenti al s to thei r LD AP user names, as descri bed
i n U si ng LD AP w i th Si ngl e Si gn-On Authenti cati on Systems, page
209.

l D ependi ng on the w ay your LD AP di rectory i s confi gured, You can

i mport addi ti onal LD AP attri butes for users, for exampl e, a
co un tr yC o d e attri bute, i ndi cati ng the user's l ocati on. These
addi ti onal LD AP attri butes can be used to create securi ty fi l ters for
users, such as di spl ayi ng data that i s rel evant to the user's country.
For i nformati on on creati ng these securi ty fi l ters, see U si ng LD AP
Attri butes i n Securi ty Fi l ters, page 210.

202 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Mo d if yin g Yo u r LDAP Au t h en t icat io n Set t in gs

D ependi ng on changes i n your organi zati on's pol i ci es, you may need
to modi fy the LD AP authenti cati on setti ngs i n Mi croStrategy. To
modi fy your LD AP authenti cati on setti ngs, you can use the
Intel l i gence Server C onfi gurati on Edi tor. The steps to access the
LD AP setti ngs i n the Intel l i gence Server C onfi gurati on Edi tor are
descri bed bel ow .

To Access LDAP Authentication Settings in the Intelligence Server

Configuration Editor

1. In D evel oper, l og i n to a proj ect source as a user w i th

admi ni strati ve pri vi l eges.

2. From the A dministration menu, sel ect Server, and cl i ck

C onfigure MicroStrategy Intelligence Server.

3. Expand the LD A P category. The LD AP setti ngs are di spl ayed.

You can modi fy the fol l ow i ng:

l Your LD AP server setti ngs, such as the machi ne name, port,

and so on.

l Your LD AP SD K i nformati on, such as the l ocati on of the LD AP

SD K D LL fi l es.

l The LD AP search fi l ters that Intel l i gence Server uses to fi nd

and authenti cate users.

l If you are i mporti ng and synchroni zi ng users or groups i n

batches, the synchroni zati on schedul es.

l If you are i mporti ng users and groups, the i mport setti ngs.

© 2019, M icr o St r at egy In c. 203

Syst em Ad m in ist r at io n Gu id e

Imp o r t in g LDAP User s an d Gr o u p s in t o Micr o St r at egy

You can choose to i mport LD AP users and groups at l ogi n, i n a batch
process, or a combi nati on of the tw o, descri bed as fol l ow s:

l Importi ng users and groups at l ogi n: When an LD AP user l ogs i n to

Mi croStrategy for the fi rst ti me, that user i s i mported i nto
Mi croStrategy and a physi cal Mi croStrategy user i s created i n the
Mi croStrategy metadata. Any groups associ ated w i th that user that
are not al ready i n Mi croStrategy are al so i mported and created i n
the metadata.

l Importi ng users and groups i n batches: The l i st of users and groups

are returned from user and group searches on your LD AP di rectory.
Mi croStrategy users and groups are created i n the Mi croStrategy
metadata for al l i mported LD AP users and groups.

Thi s secti on covers the fol l ow i ng:

l For i nformati on on setti ng up user and group i mport opti ons, see
Importi ng U sers and Groups i nto Mi croStrategy, page 204.

l Once you have set up user and group i mport opti ons, you can i mport
addi ti onal LD AP i nformati on, such as users' emai l addresses, or
speci fi c LD AP attri butes. For steps, see Importi ng U sers' Emai l
Addresses, page 207.

l For i nformati on on assi gni ng securi ty setti ngs after users are
i mported, see U ser Pri vi l eges and Securi ty Setti ngs after Import,
page 208.

Importing Users and Groups into MicroStrategy

You can choose to i mport users and thei r associ ated groups w hen a
user l ogs i n to Mi croStrategy for the fi rst ti me.

l Ens ure that y ou hav e rev iewed the information and made dec is ions

204 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

regarding y our organiz ation's polic y on importing and s y nc hroniz ing us er

information, des c ribed in the following s ec tions :

l C heckl i st: Informati on R equi red for C onnecti ng Your LD AP

Server to Mi croStrategy, page 174

l C heckl i st: Informati on R equi red for C onnecti ng Your LD AP

Server to Mi croStrategy, page 174

l If y ou want to import us ers and groups in batc hes , y ou mus t define the
LDAP s earc h filters to return lis ts of us ers and groups to import into
Mic roStrategy . For information on defining s earc h filters , s ee C heckl i st:
Informati on R equi red for C onnecti ng Your LD AP Server to
Mi croStrategy, page 174 .

To Import Users and/or Groups into MicroStrategy

1. In D evel oper, l og i n to a proj ect source as a user w i th

admi ni strati ve pri vi l eges.

2. From the A dministration menu, sel ect Server > C onfigure

MicroStrategy Intelligence Server.

3. Expand the LD A P category, then expand Import, and then sel ect
Import/Synchronize.

4. If you w ant to i mport user and group i nformati on w hen users l og

i n, i n the Import/Synchroni ze at Logi n area, do the fol l ow i ng:

l To i mport users at l ogi n, sel ect Import U sers.

l To al l ow Mi croStrategy's user i nformati on to automati cal l y

synchroni ze w i th the LD AP user i nformati on, sel ect
Synchronize MicroStrategy U ser Login/U ser N ame with
LD A P.

l To i mport groups at l ogi n, sel ect the Import Groups.

© 2019, M icr o St r at egy In c. 205

Syst em Ad m in ist r at io n Gu id e

l To al l ow Mi croStrategy's group i nformati on to automati cal l y

synchroni ze w i th the LD AP group i nformati on, sel ect
Synchronize MicroStrategy Group N ame with LD A P.

5. If you w ant to i mport user and group i nformati on i n batches, i n

the Import/Synchroni ze i n Batch area, do the fol l ow i ng:

l To i mport users i n batches, sel ect Import U sers. You must

al so enter a user search fi l ter i n the Enter search filter for
importing list of users fi el d to return a l i st of users to i mport.

l To synchroni ze Mi croStrategy's user i nformati on w i th the LD AP

user i nformati on, sel ect Synchronize MicroStrategy U ser
Login/U ser N ame with LD A P.

l To i mport groups i n batches, sel ect Import Groups. You must

al so enter a group search fi l ter i n the Enter search filter for
importing list of groups fi el d to return a l i st of users to i mport.

l To synchroni ze Mi croStrategy's group i nformati on w i th the

LD AP group i nformati on, sel ect Synchronize MicroStrategy
Group N ame with LD A P.

6. To modi fy the w ay that LD AP user and group i nformati on i s

i mported, for exampl e, to i mport group names as the LD AP
di sti ngui shed name, under the LD AP category, under Import,
cl i ck U ser/Group.

7. C l i ck OK .

Once a user or group i s created i n Mi croStrategy, the users are gi ven

thei r ow n i nboxes and personal fol ders. Addi ti onal l y, you can do the
fol l ow i ng:

l Import users' emai l addresses. For steps, see Importi ng U sers'

Emai l Addresses, page 207.

206 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Assi gn pri vi l eges and securi ty setti ngs that control w hat a user can
access i n Mi croStrategy. For i nformati on on assi gni ng securi ty
setti ngs after users are i mported, see U ser Pri vi l eges and Securi ty
Setti ngs after Import, page 208.

l Import addi ti onal LD AP attri butes, w hi ch can then be used i n

securi ty fi l ters for users. For steps, see U si ng LD AP Attri butes i n
Securi ty Fi l ters, page 210.

Importing Users' Email Addresses

D ependi ng on your requi rements, you can i mport addi ti onal

i nformati on, such as users' emai l addresses, from your LD AP
di rectory. For exampl e, If you have a l i cense for Mi croStrategy
D i stri buti on Servi ces, then w hen you i mport LD AP users, ei ther i n a
batch or at l ogi n, you can i mport these emai l addresses as contacts
associ ated w i th those users. For i nformati on about D i stri buti on
Servi ces, see Overvi ew of D i stri buti on Servi ces, page 1008.

Mi croStrategy 9 i mports the pri mary emai l address for each LD AP

user.

To Import Users' Email Addresses from LDAP

1. In D evel oper, l og i n to a proj ect source as a user w i th

admi ni strati ve pri vi l eges.

2. From the A dministration menu, sel ect Server, and then sel ect
C onfigure MicroStrategy Intelligence Server.

3. Expand the LD A P category, then expand Import, and sel ect

Options.

4. Sel ect Import Email A ddress.

© 2019, M icr o St r at egy In c. 207

Syst em Ad m in ist r at io n Gu id e

5. Sel ect w hether to use the defaul t LD AP emai l address attri bute
of m ai l , or to use a di fferent attri bute. If you w ant to use a
di fferent attri bute, speci fy i t i n the text fi el d.

6. From the D evice drop-dow n l i st, sel ect the emai l devi ce that the
emai l addresses are to be associ ated w i th.

7. C l i ck OK .

User Privileges and Security Settings after Import

Imported users recei ve the pri vi l eges of the Mi croStrategy LD AP

U sers group. You can add addi ti onal pri vi l eges to speci fi c users i n
the LD AP U sers group usi ng the standard Mi croStrategy process i n
the U ser Edi tor. You can al so adj ust pri vi l eges for the LD AP U sers
group as a w hol e. Group pri vi l eges can be modi fi ed usi ng the
Mi croStrategy Group Edi tor.

The pri vi l eges and securi ty setti ngs assi gned to LD AP users i mported
i n Mi croStrategy depend on the users' associ ated Mi croStrategy
group pri vi l eges and securi ty permi ssi ons. To see the defaul t
pri vi l eges assi gned to a user or group, i n the fol der l i st, expand your
proj ect source, expand A dministration, and then expand U ser
Manager. R i ght-cl i ck the group (or sel ect the group and ri ght-cl i ck the
user) and sel ect Edit. The Proj ect Access tab di spl ays al l pri vi l eges
for each proj ect i n the proj ect source.

The process of synchroni zi ng users and groups can modi fy w hi ch

groups a user bel ongs to, and thus modi fy the user's pri vi l eges and
securi ty setti ngs.

Select in g Sch ed u les f o r Imp o r t in g an d Syn ch r o n izin g User s

If you choose to synchroni ze users and groups i n batches, you can
sel ect a schedul e that di ctates w hen LD AP users and groups are
synchroni zed i n Mi croStrategy. For i nformati on on creati ng and usi ng

208 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

schedul es, see C reati ng and Managi ng Schedul es, page 975. To
sel ect a synchroni zati on schedul e for LD AP, fol l ow the steps bel ow .

To Select a Schedule for Importing and Synchronizing Users

1. In D evel oper, l og i n to a proj ect source as a user w i th

admi ni strati ve pri vi l eges.

2. From the A dministration menu, sel ect Server, and then sel ect
C onfigure MicroStrategy Intelligence Server.

3. Expand the LD A P category, then cl i ck Schedules. The avai l abl e

schedul es are di spl ayed. By defaul t, al l the checkboxes for al l
the schedul es are cl eared.

4. Sel ect the schedul es to use as LD AP user and group

synchroni zati on schedul es.

5. To synchroni ze your Mi croStrategy users and groups w i th the

l atest LD AP users and groups i mmedi atel y, sel ect R un
schedules on save.

6. C l i ck OK .

Usin g LDAP wit h Sin gle Sign -On Au t h en t icat io n Syst ems
If you are usi ng si ngl e si gn-on (SSO) authenti cati on systems, such as
Wi ndow s N T authenti cati on or trusted authenti cati on, you can l i nk
users' SSO credenti al s to thei r LD AP user names, and i mport the
LD AP user and group i nformati on i nto Mi croStrategy. For i nformati on
about confi guri ng a si ngl e si gn-on system, see Enabl i ng Si ngl e Si gn-
On Authenti cati on, page 212.

D ependi ng on the SSO authenti cati on system you are usi ng, refer to
one of the fol l ow i ng secti ons for steps:

© 2019, M icr o St r at egy In c. 209

Syst em Ad m in ist r at io n Gu id e

l If you are usi ng Wi ndow s N T authenti cati on, see Impl ementi ng
Wi ndow s N T Authenti cati on, page 296.

l If you are usi ng i ntegrated or trusted authenti cati on, see Li nki ng
i ntegrated authenti cati on users to LD AP users.

Usin g LDAP At t r ib u t es in Secu r it y Filt er s

You may w ant to i ntegrate LD AP attri butes i nto your Mi croStrategy
securi ty model . For exampl e, you w ant users to onl y see sal es data
about thei r country. You i mport the LD AP attri bute c o u n t r y N a m e,
create a securi ty fi l ter based on that LD AP attri bute, and then you
assi gn that securi ty fi l ter to al l LD AP users. N ow , w hen a user from
Brazi l vi ew s a report that breaks dow n sal es revenue by country, they
onl y see the sal es data for Brazi l .

LD AP attri butes are i mported i nto Mi croStrategy as system prompts. A

system prompt i s a speci al type of prompt that i s answ ered
automati cal l y by Intel l i gence Server. The LD AP attri bute system
prompts are answ ered w i th the rel ated LD AP attri bute val ue for the
user w ho executes the obj ect contai ni ng the system prompt. You
i mport LD AP attri butes i nto Mi croStrategy from the Intel l i gence Server
C onfi gurati on Edi tor.

Once you have created system prompts based on your LD AP

attri butes, you can use those system prompts i n securi ty fi l ters to
restri ct the data that your users can see based on thei r LD AP
attri butes. For i nformati on about usi ng system prompts i n securi ty
fi l ters, i ncl udi ng i nstructi ons, see R estri cti ng Access to D ata: Securi ty
Fi l ters, page 129. For general i nformati on about securi ty fi l ters, see
R estri cti ng Access to D ata: Securi ty Fi l ters, page 129.

210 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To Import an LDAP Attribute into a Project

1. In D evel oper, l og i n to a proj ect source.

2. From the A dministration menu, poi nt to Server and then sel ect
C onfigure MicroStrategy Intelligence Server.

3. Expand the LD A P category, then expand the Import category,

and then sel ect A ttributes.

4. From the Select LD A P A ttributes drop-dow n l i st, sel ect the

LD AP attri bute to i mport.

5. From the D ata Type drop-dow n l i st, sel ect the data type of that
attri bute.

6. C l i ck A dd.

7. C l i ck OK .

Controlling Project Access with LDAP Attributes

By defaul t, an LD AP user can l og i n to a proj ect source even i f the

LD AP attri butes that are used i n system prompts are not defi ned for
that user. To i ncrease the securi ty of the system, you can prevent
LD AP users from l oggi ng i n to a proj ect source i f al l LD AP attri butes
that are used i n system prompts are not defi ned for that user.

When you sel ect thi s opti on, you prevent al l LD AP users from l oggi ng
i n to the proj ect source i f they do not have al l the requi red LD AP
attri butes. Thi s affects al l users usi ng LD AP authenti cati on, and al so
any users usi ng Wi ndow s, Trusted, or Integrated authenti cati on i f
those authenti cati on systems have been confi gured to use LD AP. For
exampl e, i f you are usi ng Trusted authenti cati on w i th a Si teMi nder
si ngl e si gn-on system, and Si teMi nder i s confi gured to use an LD AP
di rectory, thi s opti on prevents Si teMi nder users from l oggi ng i n i f they
do not have al l the requi red LD AP attri butes.

© 2019, M icr o St r at egy In c. 211

Syst em Ad m in ist r at io n Gu id e

l This s etting prev ents us ers from logging in to all projec ts in a projec t
s ourc e.

l If y our s y s tem us es multiple LDAP s erv ers , mak e s ure that all LDAP
attributes us ed by Intelligenc e Serv er are defined on all LDAP
s erv ers . If a required LDAP attribute is defined on LDAP s erv er A and
not on LDAP s erv er B, and the U ser login fails if LD A P attribute
value is not read from the LD A P server c hec k box is s elec ted,
us ers from LDAP s erv er B will not be able to log in to Mic roStrategy .

To Only Allow Users with All Required LDAP Attributes to Log In

to the System

1. In D evel oper, l og i n to a proj ect source.

2. From the A dministration menu, poi nt to Server and then sel ect
C onfigure MicroStrategy Intelligence Server.

3. Expand the LD A P category, then expand the Import category,

and then sel ect A ttributes.

4. Sel ect the U ser logon fails if LD A P attribute value is not read
from the LD A P server checkbox.

5. C l i ck OK .

Troubleshooting
There may be si tuati ons w here you can encounter probl ems or errors
w hi l e tryi ng to i ntegrate Mi croStrategy w i th your LD AP di rectory. For
troubl eshooti ng i nformati on and procedures, see Troubl eshooti ng
LD AP Authenti cati on, page 2655.

Enabling Single Sign-On Authentication

Enabl i ng authenti cati on to mul ti pl e appl i cati ons usi ng a si ngl e l ogi n
i s know n as si ngl e si gn-on authenti cati on. The topi cs bel ow expl ai n

212 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

the di fferent types of authenti cati on that can be used to enabl e si ngl e
si gn-on i n Mi croStrategy.

Enabling Single Sign-On with SAML Authentication

SAML i s a tw o-w ay setup betw een your Mi croStrategy
appl i cati onMi croStrategy Li brary and your Identi ty Provi der (IdP).
SAML support al l ow s Mi croStrategy to w ork w i th a w i de vari ety of
SAML i denti ty provi ders for authenti cati on.

To confi gure a Mi croStrategy appl i cati onMi croStrategy Li brary for

SAML authenti cati on, you w i l l need to create SAML confi gurati on fi l es
for your appl i cati on, regi ster the appl i cati on w i th your IdP, establ i sh
trust to Mi croStrategy Intel l i gence Server, and l i nk SAML users to
Mi croStrategy users.

See the appropri ate secti on for your Mi croStrategy Appl i cati on

En ab lin g SAML Au t h en t icat io n f o r Micr o St r at egy Lib r ar y

You can confi gure Mi croStrategy Li brary to use SAML authenti cati on
for si ngl e si gn-on. You w i l l need to generate SAML confi gurati on fi l es
for your Li brary appl i cati on, establ i sh a trust rel ati onshi p betw een the
Li brary server and Mi croStrategy Intel l i gence Server, regi ster the
appl i cati on w i th your SAML Identi ty Provi der (IdP), and l i nk SAML
users to Mi croStrategy users.

l A SAML Identity Prov ider

l Mic roStrategy Library is deploy ed

l A running Mic roStrategy Intelligenc e Serv er

It is rec ommended to c onfigure HTTPS for the web applic ation s erv er
running Mic roStrategy Library .

© 2019, M icr o St r at egy In c. 213

Syst em Ad m in ist r at io n Gu id e

Generating SAML Configuration Files

The fol l ow i ng steps w i l l generate the appl i cati on metadata

(SPM et ad at a . x m l) and appl i cati on SAML confi gurati on fi l es
(Mst rS am lC o n f i g . x m l) needed for SAML confi gurati on.

To ac c es s the c onfiguration page, y ou need admin priv ileges .

1. Open a brow ser and access the SAML confi gurati on page by the
fol l ow i ng U R L:

ht tp :/ /
<F QD N>
:
<p or t> /< M i c r o S t r a t e g y L i b r a r y >/ s a m l / c o n f i g / o p en

w here < F Q D N > i s the Ful l y Qual i fi ed D omai n N ame of the

machi ne hosti ng your Mi croStrategy Li brary appl i cati on and
<p or t> i s the assi gned port number.

2. Fi l l i n the fol l ow i ng:

l General:

l Entity ID : Thi s the uni que i denti fi er of the appl i cati on to be

recogni zed by the IdP.

Some IdPs may require Entity ID to be the applic ation URL.

SAML s tandards s tate it c an be any s tring as long as a unique
matc h c an be found among the IdP's regis tered entity IDs .
Follow the requirements for y our s pec ific IdP.

l Entity base U R L: Thi s i s the U R L the IdP w i l l send and

recei ve SAML requests and responses. The fi el d w i l l be
automati cal l y generated w hen you l oad the confi gurati on
page, but i t shoul d al w ays be doubl e checked. It shoul d be
the appl i cati on U R L end users w oul d use to access the
appl i cati on.

214 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

If the applic ation is s et up behind rev ers e prox y /load balanc er,
the auto-populated URL here may not be c orrec t. Ens ure y ou
are us ing the front-end URL.

l D o not use "l ocal host" for the Enti ty base U R L.

l Once confi gured, remember to al w ays use thi s U R L to

access Mi croStrategy Web. U si ng any al ternati ve host
name to vi si t w oul d end up fai l i ng the SAML
authenti cati on.

l B ehind the proxy: U si ng a reverse proxy or l oad bal ancer

can al ter the H TTP headers of the messages sent to the
appl i cati on server. These H TTP headers are checked
agai nst the desti nati on speci fi ed i n the SAML response to
make sure i t i s sent to the correct desti nati on. A mi smatch
betw een the tw o val ues can cause the message del i very to
fai l . To prevent thi s, sel ect Yes i f Mi croStrategy Li brary runs
behi nd a reverse proxy or l oad bal ancer. The base U R L fi el d
i s set to the front-end U R L. Sel ect N o i f you are not usi ng a
reverse proxy or l oad bal ancer.

l Logout mode: Sel ect Global to l ogout users from other

appl i cati ons control l ed by SSO. Thi s i s the preferred opti on.
Make sure that SSO supports gl obal l ogout before choosi ng
thi s opti on. Otherw i se, sel ect Local to prevent users from
bei ng l ogged out from al l other appl i cati ons control l ed by
SSO.

l Encryption:

l Signature algorithm: The defaul t i s to use the i ndustry

standard "SH S256 w i th R SA" encrypti on al gori thm. Set thi s
val ue i n accordance w i th the requi rements of your speci fi c
IdP.

© 2019, M icr o St r at egy In c. 215

Syst em Ad m in ist r at io n Gu id e

l Generate Encryption K ey: Set to N o by defaul t. Setti ng to

Yes w i l l generate an encrypti on key and store i t i n the
Mi croStrategy Li brary metadata XML fi l e.

If s etting Generate Encryption K ey to Yes : SAML

authentic ation will not work unles s y ou hav e the proper J AVA
enc ry ption s trength polic y and c orrec t s etup on IdP s ide.

l A ssertion A ttribute mapping:

These opti ons control how user attri butes recei ved from the
SAML responses are processed. If the SAML attri bute names
are confi gurabl e on IdP si de, you may l eave al l opti ons as
defaul t. If your IdP sends over SAML attri butes i n fi xed names
the val ues must be changed on the appl i cati on si de to match.

You c an als o c hange attribute names in Ms trSamlConfig.x ml

ev en after the c onfiguration is done.

l D isplay N ame A ttribute: U ser di spl ay name attri bute.

l Email A ttribute: U ser emai l address attri bute.

l D istiguished N ame A ttribute: U ser di sti ngui shed name

attri bute.

l Group A ttribute: U ser group attri bute.

l Group format:

l Simple: The defaul t opti on takes a user's group i nformati on

as pl ai n group names. When usi ng thi s opti on, make sure
val ues sent over by IdP i n the "Groups" attri bute are group
names and nothi ng el se.

216 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l D istinguishedN ame: D i sti ngui shedN ame means that

val ues sent over i n the "Groups" attri bute are the LD AP
D i sti ngui shedN ame of the user's groups. The opti on i s onl y
used to uti l i ze LD AP i ntegrati on or w hen the IdP onl y
sends group i nformati on as D i sti ngui shedN ames.

l A dmin Groups: C omma separated l i st of Mi croStrategy Web

Admi ni strator user groups.

The A dmin Groups has no effec t on Mic roStrategy Library

s etup. This field c an be left empty .

3. C l i ck Generate config.

4. The confi gurati on fi l es are generated i n the W E B -

IN F/ cl a s s e s / a u t h / S A M L fol der.

Registering Your SAML Identity Provider with MicroStrategy Library

Mi croStrategy Li brary needs a metadata fi l e from the IdP to i denti fy

w hi ch servi ce you are usi ng.

To regi ster your SAML IdP:

1. D ow nl oad the metadata fi l e and save i t as I D P M e t a d a t a . x m l

This file name is c as e s ens itiv e and mus t be s av ed ex ac tly as

s hown abov e.

2. Pl ace the fi l e i n the W E B -I N F / c l a s s e s / a u t h / S A M L fol der

w i th the Mi croStrategy Li brary confi gurati on fi l es you generated
previ ousl y.

Registering MicroStrategy Library with Your SAML Badge Provider

Mi croStrategy Li brary needs to be regi stered to the IdP to enabl e

SAML authenti cati on. The regi strati on methods provi ded bel ow

© 2019, M icr o St r at egy In c. 217

Syst em Ad m in ist r at io n Gu id e

shoul d appl y to most IdPs. Exact confi gurati on detai l s may di ffer
dependi ng on your IdP. C onsul t your Badge provi der's documentati on
for speci fi c i nstructi ons.

Regi st er b y U p l oad i ng SPM et ad at a.xm l

Many IdPs provi de a conveni ent w ay to regi ster an appl i cati on by

upl oadi ng a metadata fi l e.

U se the S PM e t a d a t a . x m l fi l e generated previ ousl y and fol l ow IdP's

i nstructi ons to regi ster the Mi croStrategy Li brary appl i cati on.

M anual Regi st r at i on

If upl oadi ng a metadata fi l e i s not supported by your IdP, manual

confi gurati on i s necessary.

The S PM et ad a t a . x m l fi l e contai ns al l of the i nformati on needed for

manual confi gurati on.

l The e nt it y I D = parameter i s the same Enti tyID you provi ded i n the
SAML confi g page

l As se rt io n C o n s u m e r S e r v i c e L o c a t i o n = thi s U R L i s l ocated
near the end of the fi l e.

Be aware that there are multiple URLs in this file. The

As se rt i o n C o n s u m e r S e r v i c e L o c a t i o n will c ontain the
binding s tatement H T T P -P O S T at the end.

l If the si gni ng certi fi cate i s requi red:

1. C opy the text betw een < d s : X 5 0 9 C e r t i f i c a t e > and

</ ds :X 5 0 9 C e r t i f i c a t e > tags.

2. Paste the contents i nto a text edi tor.

3. Save the fi l e as f i l e _n a m e . c e r and upl oad to IdP.

218 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SAML Assertion Attributes Configuration

Mi croStrategy Li brary uses i nformati on about users from the SAML

R esponse to create Intel l i gence Server sessi ons. The setti ngs are
how SAML users are mapped or i mported to Mi croStrategy.

The user properti es that Mi croStrategy uses for mappi ng are:

Required Attributes:

l N ame ID - Maps to Trusted Authenti cated R equest U ser ID of the

Mi croStrategy user as defi ned i n Mi croStrategy D evel oper.

Optional Attributes:

l D isplayN ame - U sed to popul ate or l i nk to a Mi croStrategy user's

Ful l name

l Email - U ser emai l

l D istinguishedN ame - U sed to extract addi ti onal user i nformati on

from the LD AP server

l Groups - Li st of groups user bel ongs to

Attribute names are c as e s ens itiv e. Mak e s ure any SAML attribute
name c onfigured here is an ex ac t matc h to the applic ation c onfiguration.

In the c as e where IdP does not allow c us tomiz ation of SAML attribute
names and prov ides fix ed names ins tead, y ou may modify the
c orres ponding attribute names in M s t r S a m l C o n f i g . x m l generated
prev ious ly .

For more i nformati on on mappi ng users betw een a SAML IdP and
Mi croStrategy, see Mappi ng SAML U sers to Mi croStrategy

© 2019, M icr o St r at egy In c. 219

Syst em Ad m in ist r at io n Gu id e

Enabling SAML Authentication Mode

To use SAML authenti cati on i t needs to be enabl ed on Mi croStrategy

Li brary as a l ogi n mode.

To Enab l e SAM L Aut hent i cat i on M od e

1. Launch the Li brary Admi n page by enteri ng the fol l ow i ng U R L i n

your w eb brow ser

ht tp :/ /
<F QD N> :< p o r t >/ M i c r o S t r a t e g y L i b r a r y / a d m i n

w here < F Q D N > i s the Ful l y Qual i fi ed D omai n N ame of the

machi ne hosti ng your Mi croStrategy Li brary appl i cati on, and
<p or t> i s the assi gned port number.

2. On the Library Web Server tab, sel ect SA ML from the l i st of

avai l abl e A uthentication Modes.

If you use Mi croStrategy Identi ty Server as your SAML i denti ty

provi der, sel ect MicroStrategy Identity Server.

3. C l i ck C reate Trusted R elationship to establ i sh trusted

communi cati on betw een Li brary Web Server and Intel l i gence
Server.

Ens ure the Intelligenc e Serv er information is entered c orrec tly

before es tablis hing this trus ted relations hip.

4. C l i ck Save.

5. R estart your Web Server to appl y the changes.

220 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Sin gle Sign -On wit h SAML Au t h en t icat io n f o r JSP Web an d

Mo b ile
You can confi gure Mi croStrategy Web and Mi croStrategy Mobi l e to
w ork w i th SAML-compl i ant si ngl e si gn-on (SSO).

Though the following prerequis ites and proc edures refer to

Mic roStrategy Web, the s ame information applies to Mic roStrategy
Mobile, ex c ept where noted.

Before y ou begin c onfiguring Mic roStrategy Web to s upport s ingle s ign-on,

mak e s ure y ou hav e done the following:

l Deploy ed a SAML-enabled identity prov ider (IdP) infras truc ture

l Verified that Mic roStrategy Web is run on a J SP s erv er.

l Deploy ed Mic roStrategy Web on this web applic ation s erv er. Deploy the
Mic roStrategy Web WAR file on the web applic ation s erv er in ac c ordanc e
with y our web applic ation s erv er doc umentation.

The fol l ow i ng procedures descri be how to confi gure and i ntegrate

SAML support for Mi croStrategy Web to i mpl ement si ngl e si gn-on.

l H ow to C onfi gure the Intel l i gence Server C onnecti on

l H ow to Generate C onfi gurati on Fi l es

l H ow to R egi ster Mi croStrategy Web w i th Your Identi ty Provi der

l H ow to Modi fy the w eb.xml Fi l e

l H ow to C onfi gure Loggi ng

l H ow to D i sabl e SAML Support for Mi croStrategy Web

© 2019, M icr o St r at egy In c. 221

Syst em Ad m in ist r at io n Gu id e

Configuring SAML Support for MicroStrategy Web

H ow t o Conf i gur e t he Int el l i gence Ser ver Connect i on

To use SAML authenti cati on, you need to confi gure the trusted
rel ati onshi p betw een the w eb server and the Intel l i gence Server. It i s
done through the Admi ni strator Page. Open the admi n page for your
w eb appl i cati on. Then, connect to the Intel l i gence Server you w ant to
use.

l Establish trust between the server and Intelligence Server:

1. Open the Server properti es edi tor.

2. N ext to Trust relationship between MicroStrategy Web

Server and MicroStrategy Intelligence Server, cl i ck Setup.

3. Enter the Intel l i gence Server admi ni strator credenti al s.

4. C l i ck C reate Trust rel ati onshi p.

l Server D efault Properties screen:

In Mi croStrategy Web, the D efaul t properti es screen i s used for

confi guri ng defaul t l ogi n mode, but the defaul t properti es do not
appl y to SAML. When SAML authenti cati on i s confi gured i n
we b. xm l , thi s screen di spl ays SAML setti ngs regardl ess of the
defaul t property val ues and al l the l ogi n fi el ds on the page are
di sabl ed. SAML i s chosen uncondi ti onal l y for trusted mode.

222 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

See the Mappi ng SAML U sers to Mi croStrategy secti on to compl ete

SAML i ntegrati on w i th Mi croStrategy Web and Mobi l e.

H ow t o Gener at e Conf i gur at i on Fi l es

Mi croStrategy SAML support rel i es on several confi gurati on fi l es.

Mi croStrategy provi des a w eb page that automati cal l y generates the
necessary fi l es based on the provi ded i nformati on.

1. To l aunch the page that generates the confi gurati on fi l es, open a
brow ser and enter the fol l ow i ng U R L:

<w eb a p p l i c a t i o n _p a t h >/ s a m l / c o n f i g / o p e n

To access, you w i l l be prompted for the appl i cati on server's

admi n credenti al s.

If y ou deploy ed Mic roStrategy Web under the name

© 2019, M icr o St r at egy In c. 223

Syst em Ad m in ist r at io n Gu id e

Mi cr oS t r a t e g y W e b , and y ou are launc hing the c onfiguration page

from the mac hine where y ou deploy ed Mic roStrategy Web, then the
URL is :

ht tp :/ /
<F QD N>
:< po rt >/ M i c r o S t r a t e g y W e b / s a m l / c o n f i g / o p e n

If y ou deploy ed Mic roStrategy Mobile under the name

Mi cr oS t r a t e g y M o b i l e , and y ou are launc hing the c onfiguration
page from the mac hine where y ou deploy ed Mic roStrategy Mobile,
then the URL is :

ht tp :/ /
<F QD N>
:< po rt >/ M i c r o S t r a t e g y M o b i l e / s a m l / c o n f i g / o p e n

2. Fi l l i n the fol l ow i ng:

l General

l Entity ID : Thi s the uni que i denti fi er of the w eb appl i cati on to

be recogni zed by the IdP.

Some IdPs may require Entity ID to be the web applic ation

URL. SAML s tandards s tate it c an be any s tring as long as a
unique matc h c an be found among the IdP's regis tered entity
IDs . Follow the requirements for y our s pec ific IdP.

l Entity base U R L: Thi s i s the U R L the IdP w i l l send and

recei ve SAML requests and responses. The fi el d w i l l be
automati cal l y generated w hen you l oad the confi gurati on
page, but i t shoul d al w ays be doubl e checked. It shoul d be
the w eb appl i cati on U R L end users w oul d use to access the
w eb appl i cati on.

224 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

If the web applic ation is s et up behind rev ers e prox y or load

balanc er, the auto-populated URL here may not be c orrec t.
See below for more information.

l Do not us e "loc alhos t" for the Entity bas e URL.

l Onc e c onfigured, remember to alway s us e this URL to

ac c es s Mic roStrategy Web – us ing any alternativ e hos t
name to v is it would end up failing the SAML authentic ation.

l B ehind the proxy: U si ng a reverse proxy or l oad bal ancer

can al ter the H TTP headers of the messages sent to the
appl i cati on server. These H TTP headers are checked
agai nst the desti nati on speci fi ed i n the SAML response to
make sure i t i s sent to the correct desti nati on. A mi smatch
betw een the tw o val ues can cause the message del i very to
fai l . To prevent thi s, sel ect Yes i f Mi croStrategy Li brary runs
behi nd a reverse proxy or l oad bal ancer. The base U R L fi el d
i s set to the front-end U R L. Sel ect N o i f you are not usi ng a
reverse proxy or l oad bal ancer.

l Encryption

l Signature algorithm: The defaul t i s to use the i ndustry

standard "SH A256 w i th R SA" encrypti on al gori thm. Set thi s
val ue i n accordance w i th the requi rements of your speci fi c
IdP.

l Generate Encryption K ey: Set to N o by defaul t. Setti ng to

Yes w i l l generate an encrypti on key and store i t i n the
Mi croStrategy Li brary metadata XML fi l e.

If s etting Generate Encryption K ey to Yes : SAML

authentic ation will not work unles s y ou hav e the proper J av a
enc ry ption s trength polic y and c orrec t s etup on IdP s ide.

© 2019, M icr o St r at egy In c. 225

Syst em Ad m in ist r at io n Gu id e

l A ssertion A ttribute mapping

These opti ons control how user attri butes recei ved from the
SAML responses are processed. If the SAML attri bute names
are confi gurabl e on IdP si de, you may l eave al l opti ons as
defaul t. If your IdP sends over SAML attri butes i n fi xed names
the val ues must be changed on the w eb appl i cati on si de to
match.

You c an als o c hange attribute names in

Ms t r S a m l C o n f i g . x m l ev en after the c onfiguration is done.

l D isplay N ame A ttribute: U ser di spl ay name attri bute

l Email A ttribute: U ser emai l address attri bute

l D istinguished N ame A ttribute: U ser di sti ngui shed name

attri bute

l Group A ttribute: U ser group attri bute

l Group format

l Simple: The defaul t opti on takes a user's group i nformati on

as pl ai n group names. When usi ng thi s opti on, make sure
val ues sent over by IdP i n the "Groups" attri bute are group
names and nothi ng el se.

l D istinguishedN ame: D i sti ngui shedN ame means that

val ues sent over i n the "Groups" attri bute are the LD AP
D i sti ngui shedN ame of the user's groups. The opti on i s onl y
used to uti l i ze LD AP i ntegrati on or w hen the IdP onl y
sends group i nformati on as D i sti ngui shedN ames.

l A dmin Groups: C omma-separated l i st of Mi croStrategy Web

Admi ni strator user groups.

226 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Mak e s ure to add Mic roStrategy Web Adminis trator us er groups

(for ex ample ad m i n ). Otherwis e, the web adminis trator page
will not be ac c es s ible after the w e b . x m l file has been modified
and the web s erv er res tarted. If it happens , y ou need to rec ov er
the original w eb . x m l , res tart the web s erv er, regenerate the
c onfiguration files , and re-regis ter Mic roStrategy Web with y our
Identity Prov ider.

3. C l i ck the Generate config button.

Three confi gurati on fi l es are w i l l be generated i n the W E B -

IN F/ cl a s s e s / r e s o u r c e s / S A M L fol der of the Mi croStrategy
Web i nstal l ati on di rectory:

l Ms tr Sa m l C o n f i g . x m l - C ontai ns run-ti me SAML support

confi gurati on parameters

l SP Me ta d a t a . x m l - C ontai ns metadata descri bi ng your w eb

appl i cati on to SSO

l Sa ml Ke y s t o r e . j k s - C ontai ns necessary cryptographi c

materi al

Do not rename any of the generated files .

H ow t o Regi st er M i cr oSt r at egy Web w i t h Your Id ent i t y Pr ovi d er

To regi ster Mi croStrategy Web w i th your IdP, you need to do the

fol l ow i ng:

l R egi ster Mi croStrategy Web w i th your IdP usi ng the

SP Me ta da t a . x m l fi l e you generated i n the previ ous step.

l C onfi gure the SAML Asserti on attri butes

Eac h SAML-c ompliant IdP has a different way to perform thes e s teps .
The s ec tions below prov ide a general ov erv iew of the proc es s .

© 2019, M icr o St r at egy In c. 227

Syst em Ad m in ist r at io n Gu id e

1. R egi ster the w eb appl i cati on w i th SSO:

U se the S P M e t a d a t a . x m l fi l e you generated i n the previ ous

step to regi ster the Mi croStrategy Web appl i cati on w i th the IdP.

If uploading a metadata file is not s upported by y our IdP, manual

c onfiguration is nec es s ary .

The S P M e t a d a ta . x m l file c ontains all of the information needed

for manual c onfiguration.

l The e n t i t y ID = parameter is the s ame Entity ID y ou prov ided

in the SAML c onfig page

l As s e r t i o n C o n s u m e r S e r v i c e L o c a t i o n = this URL is
loc ated near the end of the file.

Be aware that there are multiple URLs in this file. The

A s s e r t i o n C o n s u m e r S e r v i c e L o c a t i o n will
c ontain the binding s tatement H T T P -P O S T at the end.

l If the s igning c ertific ate is required:

1. Copy the tex t between < d s : X 50 9 C e r t i f i c a t e > and

< / d s : X 5 0 9 C e r t i f i c a t e > tags .

2. Pas te the c ontents into a tex t editor.

3. Sav e the file as f i l e _n a m e . c e r and upload to IdP.

2. C onfi gure SAML Asserti on attri butes:

Mi croStrategy Web uses i nformati on about users from the SAML

R esponse to create Intel l i gence Server sessi ons. The setti ngs
are how SAML users are mapped or i mported to Mi croStrategy.

The user properti es that Mi croStrategy uses for mappi ng are:

R equired attributes

228 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Na me I D: Maps to Trusted Authenti cated R equest U ser ID of

the Mi croStrategy user as defi ned i n Mi croStrategy D evel oper.

Optional attributes

l Di sp la y N a m e: U sed to popul ate or l i nk to a Mi croStrategy

user's Ful l name

l EM ai l : U ser emai l

l Di st in g u i s h e d N a m e: U sed to extract addi ti onal user

i nformati on from the LD AP server

l Gr ou ps : Li st of groups user bel ongs to

Attribute names are c as e s ens itiv e. Mak e s ure any SAML attribute
name c onfigured here is an ex ac t matc h to the web applic ation
c onfiguration.

In the c as e where IdP does not allow c us tomiz ation of SAML

attribute names and prov ides fix ed names ins tead, y ou may modify
the c orres ponding attribute names in M s t r S a m l C o n f i g . x m l
generated prev ious ly .

For more i nformati on on mappi ng users betw een a SAML IdP and
Mi croStrategy, see Mappi ng SAML U sers to Mi croStrategy

When c onfiguring as s ertion attributes , mak e s ure y ou s et up us ers

who belong to a group (for ex ample a d m i n ) with the s ame group
name as defined when generating c onfiguration files in
Mic roStrategy Web (s tep 2 in H ow to Generate C onfi gurati on
Fi l es ). Otherwis e, no us er will be able to ac c es s the web
adminis trator page after the w e b . x m l file has been modified and
the web s erv er res tarted. Us e G r o u p s as SAML Attribute Name.

© 2019, M icr o St r at egy In c. 229

Syst em Ad m in ist r at io n Gu id e

3. D ow nl oad the IdP metadata:

C onsul t the SSO documentati on for i nstructi ons on how to export

or dow nl oad the IdP metadata. The IdP metadata fi l e must be
named I D P M e t a d a t a . x m l and pl aced i n the W E B -
IN F/ cl a s s e s / r e s o u r c e s / S A M L fol der. Ensure that the
En ti ty I D val ue i n the I D P M e t a d a t a . x m l fi l e i s di fferent from
the E nt i t y I D val ue i n the S P M e t a d a t a . x m l fi l e to avoi d w eb
appl i cati on errors.

Mic roStrategy does not automatic ally update the

ID PM e t a d a t a . x m l file. If for any reas on the metadata c hanges
on the IdP s ide, y ou will need to download and replac e
ID PM e t a d a t a . x m l manually .

H ow t o M od i f y t he w e b . x m l Fi l e

To enabl e SAML i n a w eb appl i cati on, you need to modi fy the

web. xm l fi l e l ocated i n the W E B -I N F fol der of the Mi croStrategy Web
i nstal l ati on di rectory.

1. Stop the Mi croStrategy Web appl i cati on server.

2. D el ete or uncomment the fi rst and the l ast l i ne of the

we b. xm l fragment bel ow to enabl e SAML Authenti cati on mode.

<!-- Uncomment fragment below to enable SAML Authentication mode

<context-param>
<param-name>contextConfigLocation</param-name>
<param-
value>classpath:resources/SAML/SpringSAMLConfig.xml</param-value>
</context-param>

<context-param>
<param-name>contextInitializerClasses</param-name>
<param-

230 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

value>com.microstrategy.auth.saml.config.ConfigApplicationContextI
nitializer</param-value>
</context-param>

<filter>
<filter-name>springSecurityFilterChain</filter-name>
<filter-
class>org.springframework.web.filter.DelegatingFilterProxy</filte
r-class>
</filter>
<filter-mapping>
<filter-name>springSecurityFilterChain</filter-name>
<url-pattern>/servlet/*</url-pattern>
</filter-mapping>
<filter-mapping>
<filter-name>springSecurityFilterChain</filter-name>
<url-pattern>/saml/*</url-pattern>
</filter-mapping>

<listener>
<listener-
class>org.springframework.web.context.ContextLoaderListener</liste
ner-class>
</listener>
-->

3. Save the w e b . x m l fi l e.

If you're not usi ng SSO to connect to the WebAdmi n page:

1. Stop the Mi croStrategy Web appl i cati on server.

2. D el ete or uncomment the fi rst and the l ast l i ne of the

we b. xm l fragment bel ow to enabl e SAML Authenti cati on mode.

<!-- Uncomment fragment below to enable SAML Authentication mode

<context-param>
<param-name>contextConfigLocation</param-name>
<param-

© 2019, M icr o St r at egy In c. 231

Syst em Ad m in ist r at io n Gu id e

value>classpath:resources/SAML/SpringSAMLConfig.xml</param-value>
</context-param>

<context-param>
<param-name>contextInitializerClasses</param-name>
<param-
value>com.microstrategy.auth.saml.config.ConfigApplicationContextI
nitializer</param-value>
</context-param>

<filter>
<filter-name>springSecurityFilterChain</filter-name>
<filter-
class>org.springframework.web.filter.DelegatingFilterProxy</filte
r-class>
</filter>
<filter-mapping>
<filter-name>springSecurityFilterChain</filter-name>
<url-pattern>/servlet/mstrWeb/*</url-pattern>
</filter-mapping>
<filter-mapping>
<filter-name>springSecurityFilterChain</filter-name>
<url-pattern>/servlet/mstrWeb/*</url-pattern>
</filter-mapping>

<listener>
<listener-
class>org.springframework.web.context.ContextLoaderListener</liste
ner-class>
</listener>
-->

3. Save the w e b . x m l fi l e.

H ow t o Conf i gur e Loggi ng

1. Locate the l o g 4 j . p r o p e r t i e s fi l e i n the W E B -I N F / c l a s s es

fol der.

232 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

2. Modi fy the l o g 4 j . a p p e n d e r . S A M L A p p e n d e r . F i l e property

to poi nt to the fol der w here you w ant the SAML l ogs stored.

It is not rec ommended to leav e the file as is , s inc e the relativ e file
path is v ery unreliable and c an end up any where, and it almos t
alway s c annot be found in the web applic ation folder. Us e full file
paths here to fully c ontrol the log loc ation.

In a Windows env ironment, the file path needs to be in J av a format,

whic h means y ou either need to c hange eac h bac k s las h ("\") to a
s las h ("/"), or y ou need to es c ape the bac k s las h with another one
("\\"). There is als o a way to s horten the path by referring to the
Tomc at bas e folder as a v ariable, for ex ample:

${catalina.home}/webapps/MicroStrategy/WEB-
INF/log/SAML/SAML.log

For troubles hooting purpos es it is rec ommended to firs t c hange the

lev el of l o g 4 j . l o g g e r . P R O T O C O L _M E S S A G E to D E B U G and
leav e ev ery thing els e default. This will generate a c lean log with all
SAML mes s ages along with any error or ex c eption

3. R estart the w eb appl i cati on server to appl y al l changes.

If y ou hav e a problem ac c es s ing Mic roStrategy Web adminis trator

page, c los e and reopen y our web brows er to c lear old brows er
c ac he.

How to Disable SAML Support for MicroStrategy Web

1. R epl ace the w e b . x m l fi l e of the w eb appl i cati on w i th the

ori gi nal fi l e that you saved.

2. Open Web Admi ni strator:

© 2019, M icr o St r at egy In c. 233

Syst em Ad m in ist r at io n Gu id e

a. C hange l og-i n mode to the desi red mode.

b. R emove the trust rel ati onshi p betw een the w eb server and
Intel l i gence Server.

En ab lin g Sin gle Sign -On wit h SAML Au t h en t icat io n f o r ASP

Web an d Mo b ile
You can confi gure Mi croStrategy ASP Web and Mobi l e to support
SAML usi ng Shi bbol eth Servi ce Provi der for IIS.

Shi bbol eth Servi ce Provi der Setup

Shi bbol eth Servi ce Provi der C onfi gurati on

Identi ty Provi der C onfi gurati on

Mi croStrategy Integrati on

R ol e-based authenti cati on to secure Admi n pages i n ASP Web:

In Mi croStrategy 9.0 and above, AC L-based protecti on i s supported

for Admi n pages (asp/Admi n.aspx and asp/TaskAdmi n.aspx). By
defaul t, onl y admi ni strators have access to Admi n pages.

Addi ti onal l y, i n Mi croStrategy 11.0 a new feature to protect Admi n

pages w as i ntroduced usi ng Wi ndow s IIS U R L Authori zati on. By
defaul t, the U R L Authori zati on feature i s not i nstal l ed by the Wi ndow s
OS. IIS U R L Authori zati on i s supported by IIS 7.0 and above. You can
fi nd i nstructi ons to i nstal l IIS U R L Authori zati on here.

The authori zati on rul e has been added to Web.confi g out of the box.
Once you i nstal l the IIS U R L Authori zati on modul e, you w i l l
automati cal l y get protecti on for Admi n pages.

C ompared to the AC L based protecti on, IIS U R L authori zati on has a

central i zed confi gurati on i n Web.confi g.

234 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Shibboleth Service Provider Setup

1. Instal l the l atest versi on of Shi bbol eth Servi ce Provi der.

2. Fol l ow the i nstal l ati on i nstructi ons from Shi bbol eth for your
versi on of IIS.

Conf i gur i ng t he N ew Pl ugi n

This is bes t done from the c ommand line. You will als o need admin
priv ileges .

Conf i gur i ng t he IIS7 DLL

From the C :\ W i n d o w s \ S y s t e m 3 2 \ I n e t S r v di rectory, run the

fol l ow i ng l i nes:

appcmd install module /name:ShibNative32 /image:"c:\opt\shibboleth-

sp\lib\shibboleth\iis7_shib.dll" /precondition:bitness32
appcmd install module /name:ShibNative /image:"c:\opt\shibboleth-
sp\lib64\shibboleth\iis7_shib.dll" /precondition:bitness64

Ver i f yi ng t he i nst al l at i on

Open one of the fol l ow i ng U R Ls.

l If IIS i s set up for H TTPS:

In the following s ec tions , we as s ume the IIS is s et up for HTTPS. If

y our IIS is not s et up for HTTPS, pleas e us e HTTP in the URI when
y ou perform c onfiguration.

https://localhost/Shibboleth.sso/Status

l If IIS i s set up for H TTP:

http://localhost/Shibboleth.sso/Status

© 2019, M icr o St r at egy In c. 235

Syst em Ad m in ist r at io n Gu id e

This mus t be run as loc alhos t, and s hould return XML c ontaining
information about Shibboleth.

Shibboleth Service Provider Configuration

To confi gure the Shi bbol eth Servi ce Provi der, use the fol l ow i ng
i nstructi ons i n conj uncti on w i th the Shi bbol eth documentati on.

1. C onfi gure % S H I B B O L E T H _I N S T A L L _
DI R% \e t c \ s h i b b o l e t h \ s h i b b o l e t h 2 . x m l

l Set u se H e a d e r s to t r u e i n <ISAPI>

<I SA P I n o r m a l i z e R e q u e s t = " t r u e "

sa fe H e a d e r N a m e s = " t r u e " u s e H e a d e r s = " t r u e ">

l R epl ace si te name w i th a ful l y qual i fi ed si te name:

sh ib bo l e t h 2 . x m l – si te

<S it e i d = " 1 " n a m e = " s p . e x a m p l e . o r g " / >

w i th

<S it e i d = " 1 " n a m e = " F U L L Y _Q U A L I F I E D _S E R V I C E _

PR OV I D E R _H O S T_N A M E " / >

l R epl ace host name w i th ful l y qual i fi ed name, and paths:

sh ib bo l e t h 2 . x m l – host

<Host name="sp.example.org">
<Path name="secure"
authType="shibboleth"
requireSession="true"/>
</Host>

w i th

236 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

<Host name="FULLY_QUALIFIED_SERVICE_PROVIDER_HOST_NAME">
<Path name="MicroStrategy"
authType="shibboleth"
requireSession="true"/>
<Path name="MicroStrategyMobile"
authType="shibboleth"
requireSession="true"/>
</Host>

l R epl ace e n t i t y I D val ue w i th a sui tabl e enti ty name for your

new servi ce provi der:

Make note of thi s val ue, as i t w i l l be requi red by the Identi ty

Provi der.

sh ib bo l e t h 2 . x m l - e n t i t y I D

<ApplicationDefaults
entityID="https://sp.example.org/shibboleth"
REMOTE_USER="eppn persistent-id targeted-id"

cipherSuites="ECDHE+AESGCM:ECDHE:!aNULL:!eNULL:!LOW:!EXPORT:!RC4
:!SHA:!SSLv2">

w i th

<ApplicationDefaults entityID="https://FULLY_QUALIFIED_SERVICE_
PROVIDER_HOST_NAME/shibboleth"
REMOTE_USER="eppn persistent-id targeted-id"

cipherSuites="ECDHE+AESGCM:ECDHE:!aNULL:!eNULL:!LOW:!EXPORT:!RC4
:!SHA:!SSLv2">

l Set SSO enti tyID w i th your SAML Identi ty Provi der: Thi s may
be obtai ned from the Identi ty Provi der metadata by repl aci ng:

sh ib bo l e t h 2 . x m l - Identi ty Provi der

© 2019, M icr o St r at egy In c. 237

Syst em Ad m in ist r at io n Gu id e

<SSO entityID="https://idp.example.org/idp/shibboleth"
discoveryProtocol="SAMLDS"
discoveryURL="https://ds.example.org/DS/WAYF">
SAML2 SAML1
</SSO>

w i th the fol l ow i ng:

<SSO entityID="YOUR_SSO_SAML_ENTITY_ID">
SAML2 SAML1
</SSO>

Values for d i sc o v e r y P r o t o c o l and d i s c o v e r y U R L are

only required with Shibboleth Identity Prov ider.

l Obtai n Identi ty Provi der metadata:

l U R L option (recommended): If IdP exposes a metadata

endpoi nt, thi s i s the preferred sol uti on, otherw i se see Fi l e
opti on bel ow . Add the fol l ow i ng decl arati on bel ow the
commented out < M e t a d a t a P r o v i de r > secti on:

sh ib b o l e t h 2 .x m l - Identi ty Provi der metadata

<MetadataProvider
type="XML"
url="https://adfs.example.org/federationmetadata/2007-
06/federationmetadata.xml"/>

l File option: C opy i t to the fi l e % S H I B B O L E T H _I N S T A L L _

DI R% \ e t c \ s h ib b o l e t h \ p a r t n e r-m e t a d a t a . x m l.
U ncomment the fol l ow i ng decl arati on i n s h i b b o l e t h 2 . x ml:

sh ib b o l e t h 2 .x m l - Identi ty Provi der metadata

<MetadataProvider
type="XML"

238 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

file="partner-metadata.xml"/>

2. C onfi gure % S H I B B O L E T H _I N S T A L L _
DI R% \e t c \ s h i b b o l e t h \ a t t r i b u t e -m a p . x m l to extract
several fi el ds from the SAML asserti on, w hi ch Mi croStrategy w i l l
associ ate w i th an Intel l i gence Server user.

l Add the <Attri bute> mappi ngs under <Attri butes> root.
Shi bbol eth w i l l l ook for thi s asserti on attri bute and map i t to
the H TTP header SBU SER for the Mi croStrategy appl i cati on to
consume. H ere i s a confi gurati on for AD FS w here w e read the
w i ndow s account name cl ai m. Thi s must be consi stent w i th the
Identi ty Provi der cl ai m mappi ng that w i l l be confi gured l ater.

at tr ib u t e -m a p . x m l user mappi ng - AD FS

<Attribute

name="http://schemas.microsoft.com/ws/2008/06/identity/claims/wi
ndowsaccountname"
id="SBUSER"/>

Here is a s ample c onfiguration for Key c loak , where y ou read the

"urn:oid:0.9.2342.19200300.100.1.1" or UID c laim :

at tr i b u t e -m a p . x m l us er mapping

<Attribute
name="urn:oid:0.9.2342.19200300.100.1.1"
id="SBUSER"
nameFormat="urn:oasis:names:tc:SAML:2.0:attrname-
format:basic"/>

It is als o rec ommended to c omment out the unus ed < A t t r i b u t e>

dec larations in a t t r i b u t e -m a p . x m l .

© 2019, M icr o St r at egy In c. 239

Syst em Ad m in ist r at io n Gu id e

3. R estart the fol l ow i ng servi ces:

l Shibboleth 2 D aemon: May be done w i th Wi ndow s servi ces,

or Wi ndow s C ommand Prompt:

net stop shibd_default

net start shibd_default

l World Wide Web Publishing Service: May be done w i th

Wi ndow s servi ces, or Wi ndow s C ommand Prompt:

net stop w3svc

net start w3svc

4. Veri fy XML i s returned from

ht tp s: / / l o c a l h o s t / S h i b b o l e t h . s s o / S t a t u s agai n.
Al so, ensure the Appl i cati on e n t i t y I D and
Me ta da t a P r o v i d e r source val ues have been correctl y
confi gured i n previ ous steps.

Identity Provider Configuration

It i s necessary to (1) add the Servi ce Provi der confi gured above as a
new cl i ent i n the SAML Identi ty Provi der (for exampl e, AD FS), and (2)
ensure that the user l ogi n/U ID i s al so i ncl uded i n the SAML Asserti on.
Some gui dance i s provi ded bel ow for several Identi ty Provi ders - refer
to thei r documentati on for addi ng new cl i ents/rel yi ng parti es for
detai l s.

ADFS

1. R un the Mi crosoft Wi ndow s Server Manager.

2. U nder Tools run A D FS Management.

3. Expand to the fol l ow i ng: A D FS > Trust R elationships > R elying

Party Trusts.

240 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

4. C l i ck A dd R elying Party Trust to l aunch the w i zard.

5. When you reach the "Sel ect D ata Source" opti on, you need the
Shi bbol eth Servi ce Provi der metadata. Enter:

https://YOUR_MICROSTRATEGY_WEB_URL/Shibboleth.sso/Metadata

If the HTTP URL metadata does not work , y ou may hav e to

manually download and upload the metadata file.

6. For "D i spl ay name", i t i s recommended you use Y O U R _

MI CR OS T R A T E G Y _WE B _U R L.

7. When fi ni shed, you may be prompted to edi t cl ai m rul es. If not,

you can ri ght-cl i ck your new cl i ent and sel ect Edit claim rules.

8. C l i ck A dd R ule under the tab Issuance C laim R ules.The A dd

Transform R ule C laim Wizard appears.

© 2019, M icr o St r at egy In c. 241

Syst em Ad m in ist r at io n Gu id e

9. If your AD FS i s backed by LD AP, sel ect Send LD A P A ttributes

as C laims. Otherw i se, refer to AD FS documentati on.

10. Set the fol l ow i ng fi el ds to val ues consi stent w i th the Shi bbol eth
at tr ib u t e -m a p . x m l confi gurati on from above.

l C l ai m rul e name: u s e r

l Attri bute store: A c t i v e D i r e c t o r y

l Mappi ng: L D A P At t r i b u t e = S A M -A c c o u n t -N a m e ,
Ou tg oi n g C l a im T y p e = W i n d o w s a c c o u n t n a m e

Keycl oak

The Identi ty Provi der w i l l need ensure the user i denti ty fi el d i s al so

i ncl uded i n the SAML asserti on generated w hen a user i s
authenti cated. The exact fi el d depends upon the Identi ty Provi der.
The user i denti ty w i l l be associ ated w i th the SAML parameter name of

242 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

urn: oi d: 0. 9 . 2 3 4 2 . 1 9 2 0 0 3 0 0 . 1 0 0 . 1 . 1. Thi s parameter must be

consi stent w i th the parameter w i th the same name i n the Shi bbol eth
Servi ce Provi der a t t r i b u t e -m a p . x m l decl arati on.

MicroStrategy Integration

Int egr at i on w i t h M i cr oSt r at egy ASP Web

1. Setup the Trust rel ati onshi p betw een Mi croStrategy Web and
Intel l i gence Server:

1. Open the admi n page at

ht t p s : / / l o ca l h o s t / M i c r o S t ra t e g y / a s p / A d m i n .a s
px

© 2019, M icr o St r at egy In c. 243

Syst em Ad m in ist r at io n Gu id e

2. Go to Intelligence Servers > Servers

3. For each Intel l i gence Server, go to Properties > Modify

4. C l i ck on "Trust relationship between Web Server and

MicroStrategy Intelligence Server".

5. Enter credenti al s. When successful l y setup, there shoul d be

a check mark next to the trust.

2. N avi gate to Intelligence Servers > D efault properties > Login.

3. Enabl e Trusted A uthentication R equest l og-i n mode.

4. U nder Trusted A uthentication Provider sel ect C ustom SSO.

5. C onfi gure C : \ P r o g r a m F i l e s ( x 8 6 ) \ M i c r o S t r a t e g y \ We b
AS Px \W E B - I N F \ c la s s e s \ r e s o u r c e s\ c u s t o m _
se cu ri t y . p r o p e r t i e s parameter L o g i n P a r a m w i th same
val ue associ ated w i th the user mapped from the SAML asserti on.

M i cr oSt r at egy U ser M ap p i ng

Ensure Intel l i gence Server users are mapped to your SAML users as
i denti fi ed by the U ID . Access U ser Manager, ei ther w i th Mi croStrategy
D evel oper or the Intel l i gence Server Admi ni strati on Portal i n
Mi croStrategy Web.

Micr o St r at egy Develo p er

To map users usi ng Mi croStrategy D evel oper, open: U ser Manager >
Edit U ser Properties > A uthentication > Metadata > Trusted
A uthentication R equest > U ser ID .

244 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

In t elligen ce Ser ver Ad min ist r at io n Po r t al o n Micr o St r at egy

Web
To map users through the Web Admi ni strati on Portal , go to:
MicroStrategy Web > Intelligence Server A dministration Portal >
U ser Manager > Edit U ser Properties > A uthentication > Trusted
A uthentication Login.

© 2019, M icr o St r at egy In c. 245

Syst em Ad m in ist r at io n Gu id e

In t egr at in g SAML Su p p o r t wit h Bad ge

Thi s procedure provi des speci fi c detai l s about i ntegrati ng
Mi croStrategy Web or Li brary w i th Badge.

1. D ow nl oad the IdP metadata:

1. Open Identi ty Manager.

2. C l i ck the Logical Gateways tab.

3. C l i ck D ownload your network's B adge IdP metadata.

2. U pl oad the SP metadata to the Mi croStrategy Identi ty Server:

1. C l i ck the l arge SA ML button.

2. Enabl e the U pload Pre-configured Metadata opti on.

246 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

3. C l i ck U pload Metadata.

3. C onfi gure asserti on attri butes by sel ecti ng the LD AP attri butes
and mappi ng them to SAML Asseti on attri butes.

Select LD A P attributes:

1. Open the U sers and B adges tab and cl i ck C onfigure i n the

U ser Management secti on.

2. On the Acti ve D i rectory Synchroni zati on page, set the

Badge user attri butes by mappi ng the val ues i n the Badge
fi el d col umn to the Acti ve D i rectory Attri bute to be used.
You may add custom Badge fi el ds w i th any gi ven name.

Map LD A P attributes to SA ML A ssetion attributes:

1. On the Logi cal Gatew ays tab and cl i ck the Edit l i nk i n the
Web Appl i cati on l ogi n secti on.

2. In the C onfi gure SAML Setti ngs di al og, cl i ck C onfigure on

SA ML A ttribute C onsuming Service.

© 2019, M icr o St r at egy In c. 247

Syst em Ad m in ist r at io n Gu id e

3. Map the SAML Attri bute N ame to the U ser Fi el d that

contai ns the appropri ate Acti ve D i rectory Attri bute
confi gured i n the previ ous step.

4. C l i ck Save.

4. C heck group format setti ng by fi ndi ng the < g r o u p F o r m a t > tag

i n the Ms t r S a m l C on f i g . x m l fi l e.

If your Identi ty netw ork i s confi gured w i th Acti ve D i rectory or

LD AP, the group i nformati on shoul d be sent as
D i sti ngui shedN ames.

In t egr at in g SAML Su p p o r t wit h ADFS

Thi s procedure provi des speci fi c detai l s about i ntegrati ng
Mi croStrategy Web w i th AD FS. Al l steps bel ow are performed i n

248 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

AD FS Management C onsol e. Addi ti onal l y, the fol l ow i ng steps assume

that SAML i s al ready enabl ed i n the AD FS server. For more
i nformati on, see the AD FS documentati on.

1. D ownload the ID P metadata:

1. In the AD FS consol e, open the Endpoi nts w i ndow .

2. Fi nd the Federation Metadata entry poi nt.

3. In any brow ser, enter the U R L usi ng the format <AD FS

Server base U R L>/<Metadata entry poi nt> to dow nl oad the
metadata fi l e i n the brow ser's D ow nl oads fol der.

4. C opy the metadata fi l e i nto your appl i cati on's W E B -

IN F / c l a s s e s/ r e s o u r c e s / S A M L fol der.

5. R ename the copi ed metadata fi l e to I D P M e t a d a t a . x m l.

2. R egister with A D FS server:

l C opy the S P M e t as a t a . x m l fi l e somew here on AD FS server

machi ne.

l In the C onsol e tree, ri ght-mouse cl i ck on R elying Party

Trusts, and then choose A dd R elying Party Trust…

l In Sel ect D ata Source pane choose Import data about the
relying party from a file and then brow se to the metadata fi l e.

© 2019, M icr o St r at egy In c. 249

Syst em Ad m in ist r at io n Gu id e

l C onfi gure the rest of the opti ons accordi ng to your company
pol i cy.

3. Set the proper secure hash algorithm:

Mi croStrategy has added support for sha-256 si gni ng al gori thms

and there w i l l be no need to change the defaul t setti ng on AD FS.
Fol l ow the i nstructi ons bel ow i f you need to change the setti ng
on AD FS:

1. Open the Properti es w i ndow for the rel yi ng party trust (your
regi stered appl i cati on).

2. C l i ck the A dvanced tab.

3. C hoose the SH A -1 al gori thm.

25 0 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

4. C l i ck A pply.

4. Add C l ai m R ul es for your regi stered rel yi ng party trust:

1. R i ght cl i ck on your regi stered appl i cati on and chose "Edi t

C l ai m R ul es".

C onsul t AD FS gui des for i nstructi ons on how to add and

confi gure cl ai m rul es. You may i ncl ude al l attri butes i n one
rul e or you may create di fferent rul es for di fferent attri butes.
"N ame ID " and "Groups" are the onl y attri butes requi red by
Mi croStrategy.

2. Add the cl ai m rul es and concl ude the setup on AD FS.

"Outgoing Claim Ty pe" in the rule editor (als o s hown as the

"Is s ued Claims " in the lis t of rules ) c orres ponds to the SAML
as s ertion attribute names , and they hav e to matc h the
attribute names that were prev ious ly c onfigured in the

© 2019, M icr o St r at egy In c. 25 1

Syst em Ad m in ist r at io n Gu id e

"as s ertion attribute mapping" of Mic roStrategy SAML

c onfiguration in addition to the "Name ID" whic h is not part of
the attribute mapping s etting but a mus t for SAML to func tion.

Exampl es of rul e creati on and l i st of created rul es show n bel ow :

25 2 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

In t egr at in g SAML Su p p o r t wit h Azu r e AD

Create an Application

1. Log i n to the Azure management consol e usi ng your di rectory

credenti al s.

2. Sel ect the A zure A ctive D irectory for the SAML app i ntegrati on.

3. C hoose A pp registrations from the menu.

4. Sel ect N ew application registration at the top.

5. U nder N AME, enter the name for the appl i cati on.

6. U nder Type, sel ect Web app and/or Web A PI.

© 2019, M icr o St r at egy In c. 25 3

Syst em Ad m in ist r at io n Gu id e

7. U nder Si gn-on U R L, enter a l ocati on for the

As se rt i o n C o n s u m e r S e r v i c e tag retri eved from the
SP Me ta d a t a . x m l of the SAML setup i n Mi croStrategy Web or
Mobi l e.

8. C l i ck C reate.

Configure the Application

1. Sel ect Settings.

2. Sel ect Properties.

3. U nder APP ID U R I, enter the SP Enti ty ID , retri eved from

SP Me ta d a t a . x m l.

U R I format i s requi red. If the SP Enti ty ID i n S P M e t a d a t a . x ml

i s not i n U R I format, update the e n t i t y I D fi el d. For exampl e:

ht tp ( s ) : / / F Q D N / M i c r o S t r a t e g y

4. Sel ect R equired permissions.

l On the APPLIC ATION PER MISSION S drop-dow n, enabl e R ead

D irectory D ata.

l On the D ELEGATED PER MISSION S drop-dow n, enabl e:

l Si gn i n and read user profi l e

l R ead al l users' basi c profi l es

l R ead al l users' ful l profi l es

l R ead al l groups

5. C l i ck Save.

6. C l i ck Manifest.

25 4 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

7. Fi nd the g r o u p M e mb e r s h i p C l a i m s entry and change i t from

N ull to A ll.

"groupMembers hipClaims ": "All"

8. C l i ck Save.

9. C l i ck A pp registrations i n the l eft menu.

10. C l i ck Endpoints at the top.

11. C opy the Federati on Metadata D ocument U R L by cl i cki ng the

i con next to the U R L.

12. Save the U R L as the I D P M e t a d a t a . x m l fi l e i n the

Mi cr oS t r a t e g y / W E B -I N F / c l a s s e s / r e s o u r c e s / S A M L
fol der.

Assertion Attributes

1. Go to your AD Endpoi nts and vi ew the Federati on Metadata

document to obtai n the U R Is for the requi red attri butes.

<auth:ClaimType xmlns:auth="http://docs.oasis-
open.org/wsfed/authorization/200706"
Uri="http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenna
me">
<auth:DisplayName>Given Name</auth:DisplayName>
<auth:Description>First name of the user.</auth:Description>
</auth:ClaimType>
<auth:ClaimType xmlns:auth="http://docs.oasis-
open.org/wsfed/authorization/200706"
Uri="http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surnam
e">
<auth:DisplayName>Surname</auth:Display>
<auth:Description>Last name of the user.</auth:Description>
</auth:ClaimType>
<auth:ClaimType xmlns:auth="http://docs.oasis-

© 2019, M icr o St r at egy In c. 25 5

Syst em Ad m in ist r at io n Gu id e

open.org/wsfed/authorization/200706"
Uri="http://schemas.microsoft.com/identity/claims/displayname">
<auth:DisplayName>Display Name</auth:DisplayName>
<auth:Description>Display name of the user.</auth:Description>

2. C opy these val ues and paste them betw een the < u s e r I n f o >
tags i n the MstrSaml C onfi g.xml fi l e l ocated i n the WEB-
IN F/cl asses/resources/SAML fol der.

<userInfo>

<groupAttributeName>http://schemas.microsoft.com/ws/2008/06/identi
ty/claims/groups</groupAttributeName>
<groupFormat>Simple</groupFormat>
<dnAttributeName>DistinguishedName</dnAttributeName>

<displayNameAttributeName>http://schemas.microsoft.com/identity/cl
aims/displayname</displayNameAttributeName>

<emailAttributeName>http://schemas.xmlsoap.org/ws/2005/05/identity
/claims/emailaddress</emailAttributeName>
<adminGroups>2109318c-dee4-4658-8ca0-51623d97c611</adminGroups>
</userInfo>

Az ure AD only s ends the IDs . In the c as e of the admin

permis s ions , the ID needs to be c opied.

<adminGroups>36198b4e-7193-4378-xxx4-715e65edb580</adminGroups>
</userInfo>

Troubleshooting

Af t er t he Changes, t he Web Dep l oym ent Fai l s t o St ar t

Once the w eb.xml fi l e has been changed to i ncl ude the SAML support,
i t refers to the MD and confi gurati on fi l es i n the resources/SAML
fol der. If Web depl oyment fai l s to start, i t i s possi bl e the generated

25 6 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

fi l es from the resources/SAML/stage fol der w ere not copi ed over.

C opy the requi red fi l es to the SAML fol der and restart the appl i cati on.

Azur e Ret ur ns a Log i n Fai l ur e and Asser t i on i s i n Pl ace

Thi s resul ts from bad ID PMetadata. Ensure the correct metadata from
the appl i cati on i s copi ed to the SAML fol der.

Azur e Ret ur ns t he er r or : Ap p l i cat i on w i t h i d ent i f i er “xxx” w as not

f ound i n t he d i r ect or y “xxx”

The App ID U R I does not match the enti tyID set i n the SP Metadata.
R evi ew the U R Is and correct the names accordi ngl y. C hanges can be
made i n the SPMetadata.xml , MstrSaml C onfi g.xml fi l es, and i n Azure.
R estart the appl i cati on after you fi nal i ze the correcti ons.

In t egr at in g SAML Su p p o r t wit h Okt a

Thi s procedure provi des i nstructi ons about i ntegrati ng Mi croStrategy
Web w i th Okta. For more i nformati on, see the Okta documentati on.

Create an Application

1. Log i n as an Okta admi ni strator and go to the Admi n page.

2. Go to A pplications and cl i ck A dd A pplication.

3. Sel ect SA ML 2.0.

4. C l i ck C reate.

Configure the Application

1. Enter your app name.

2. C l i ck N ext.

3. C ompl ete SAML Setti ngs.

© 2019, M icr o St r at egy In c. 25 7

Syst em Ad m in ist r at io n Gu id e

l Single Sign on U R L: Al so referred to as "Asserti on C onsumer

Servi ce U R L", i t i s the Mi croStrategy appl i cati on address that
sends and recei ves SAML messages. If SAML setup i s al ready
fi ni shed on Mi croStrategy si de, i t i s the U R L w i thi n the
md :A ss e r t i o n C o n s u m e r S e r v i c e tag at the bottom of the
SP Me ta d a t a . x m l fi l e.

The U R L usual l y takes the bel ow form:

ht tp ( s ) : / /< h o s t s e r v e r >/ < M S TR a p p l i c a t i o n

na me > / s a m l / S S O

l A udience U R I (SP Entity ID ): It corresponds to the e n t i t y I D

val ue at the top of the S P M e t a t a d a . xm l fi l e, w hi ch i s al so the
fi rst i nput fi el d on the Mi croStrategy SAML confi gurati on page.
It i s a uni que i denti fi er of the Mi croStrategy appl i cati on.

l A TTR IB U TE STA TEMEN TS (OPTION A L): Thi s i s to confi gure

w hat SAML attri butes w i l l be sent to Mi croStrategy. If the
defaul t attri bute names w ere used at Mi croStrategy SAML
confi gurati on, the names are: E M a i l, D i s t i n g u i s h e d N a m e,
and D i s p l a y N a m e. The Mi croStrategy-si de attri bute names
can be found i n the M s t r S a m l C o n f i g . x m l fi l e. For exampl e:

<dnAttributeName>DistinguishedName</dnAttributeName>
<displayNameAttributeName>DisplayName</displayNameAttributeName>
<emailAttributeName>EMail</emailAttributeName>

It i s not requi red to confi gure al l three attri butes.

l GR OU P A TTR IB U TE STA TEMEN TS (OPTION A L): Thi s i s

used to grant access to the Mi croStrategy Web or Mobi l e
Admi ni strator page and manage user pri vi l ege i nheri tance. If
the defaul t attri bute name w as used at Mi croStrategy SAML
confi gurati on, the name i s "Groups". The Mi croStrategy-si de

25 8 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

attri bute name can be found i n the M s t r S a m l C o n f i g . x m l

fi l e. For exampl e:

<g ro u p A t t r i b u t e N a m e > G r o u p s < / g r o u p A t t r i b u t e N am

e>

U se the fi l ter to sel ect the groups that are sent over. To send
over al l the groups, sel ect R egex and enter . * i nto the fi el d.

You can l eave the other fi el ds as defaul t or confi gure them as

needed.

Finish SAML Setup

1. On the Okta admi n page, go to A pplications and open the

appl i cati on.

2. Go to A ssignments.

3. C l i ck A ssign to assi gn the appl i cati on to users or groups.

4. Go to Sign On.

5. C l i ck Identity Provider metadata.

© 2019, M icr o St r at egy In c. 25 9

Syst em Ad m in ist r at io n Gu id e

6. Save the XML fi l e as I D P M e t a d a t a . x m l, and pl ace i t i n the

Mi cr oS t r a t e g y \ W E B -I N F \ c l a s s e s \ r e s o u r c e s \ S A M L
fol der.

Map p in g SAML User s t o Micr o St r at egy

Mi croStrategy Intel l i gence Server uses the SAML asserti on attri butes
confi gured i n the Idp for authenti cati on. Thi s i nformati on i s passed
from SAML response to map the l ogged i n user to Mi croStrategy users
and groups stored i n the metadata.

User Mapping

Three pi eces of i nformati on sent over i n the SAML response can be

used to map to a Mi croStrategy user:

l N ame ID : Mi croStrategy w i l l l ook for a match of the N ame ID to the

U ser ID of Trusted A uthenticated R equest setti ng.

260 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Thi s fi el d can be set i n D evel oper by openi ng U ser Editor >

A uthentication > Metadata. You can al so set thi s fi el d i n Web
Admi ni strator by openi ng Intelligence Server A dministration
Portal > U ser Manager. The Trusted A uthentication Login fi el d i s
found i n the Authenti cati on tab w hen edi ti ng a user.

l D istinguishedN ame: Mi croStrategy w i l l l ook for a match i n user's

D i sti ngui shed name of LD A P A uthentication setti ng.

Thi s setti ng can be found i n D evel oper by openi ng U ser Editor >
A uthentication > Metadata.

l D isplayN ame: Mi croStrategy w i l l l ook for a match i n user's Full

name fi el d.

Thi s setti ng can be found i n D evel oper by openi ng U ser Editor >
General.

Mic roStrategy will c hec k for matc hes in the ex ac t order they are
pres ented.

When a match i s found i n the metadata, Mi croStrategy w i l l l og the

user i n as the correspondi ng Mi croStrategy user w i th al l of the correct
permi ssi ons and pri vi l eges granted.

If no match i s found, i t means the SAML user does not yet exi st i n
Mi croStrategy, and w i l l be deni ed access. You can choose to have
SAML users i mported to Mi croStrategy i f no match i s found, see
Importi ng and Synci ng SAML U sers.

Group Mapping

The w ay Mi croStrategy w i l l map user groups i s determi ned by the

entri es made i n the Group A ttribute and Group Format fi el ds w hen
the SAML confi gurati on fi l es w ere generated for your appl i cati on.
Groups are mapped betw een an i denti ty provi der and Mi croStrategy i n
one of tw o w ays:

© 2019, M icr o St r at egy In c. 261

Syst em Ad m in ist r at io n Gu id e

l Simple group names: Group Attri bute must contai n a l i st of

Mi croStrategy U ser Groups and Group Format must be set to Si mpl e
i n Mi croStrategy SAML confi gurati on. The Group Attri bute val ues
w i l l be used to map Mi croStrategy group's Ful l name.

Thi s setti ng can be found i n D evel oper by openi ng Group Editor >
Group D efinition > General.

l D istinguishedN ames:If Mi croStrategy i s confi gured for LD AP

i ntegrati on D i sti ngui shedN ames can be used for group mappi ng.
Group Attri bute must contai n a l i st of LD AP D i sti ngui shedN ames
and the Group Format must be set to D i sti ngui shedN ame i n
Mi croStrategy SAML confi gurati on.

Thi s setti ng can be found i n D evel oper by openi ng Group Editor >
A uthentication > Metadata.

Importing and Syncing SAML Users

N ew users and thei r associ ated groups can be dynami cal l y i mported
i nto Mi croStrategy duri ng appl i cati on l og i n. You can al so confi gure
Intel l i gence Server to sync user i nformati on for exi sti ng Mi croStrategy
users each ti me they l og i n to an appl i cati on. The fol l ow i ng setti ngs
are accessed from the Intelligence Server C onfiguration > Web
Single Sign-on > C onfiguration w i ndow i n D evel oper.

l A llow user to log on if Web Single Sign-on - MicroStrategy user

link not found: C ontrol s access to an appl i cati on w hen a
Mi croStrategy user i s not found w hen checki ng a SAML response. If
unchecked, Mi croStrategy w i l l deny access to the user. If checked,
the user obtai ns pri vi l eges and access ri ghts of a 3rd Party user
and Everyone group.

Import us er and Sy nc us er will not be av ailable unles s this s etting is

c hec k ed as On.

262 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Import user at logon: Al l ow s Mi croStrategy to i mport a user i nto

the metadata i f no matchi ng user i s found. The i mported user w i l l
popul ate al l the fi el ds that are used to check user mappi ng w i th the
correspondi ng SAML attri bute i nformati on.

All us ers imported this way will be plac ed into the "3rd party us ers "
group in Mic roStrategy , and will not be phy s ic ally added to any
Mic roStrategy groups that matc h its group members hip information.

After confi gurati on i s done, the i mported user w i l l see a pri vi l ege-
rel ated error w hen they try to access the proj ect. AMi croStrategy
admi ni strator needs has to add the proj ect access pri vi l ege for the
i mported user i n 3rd Party U sers group.

l Synch user at logon: Al l ow s Mi croStrategy to update the fi el ds

used for mappi ng users w i th the current i nformati on provi ded by the
SAML response.

This option will als o update all of a us er's group information and import
groups into "3rd party us ers " if matc hing groups are not found. This
may res ult in unwanted ex tra groups being c reated and s tored in the
metadata.

Enable Integrated Authentication

Integrated authenti cati on enabl es a Wi ndow s user to l og i n once to
thei r Wi ndow s machi ne. The user does not need to l og i n agai n
separatel y to D evel oper or Mi croStrategy Web. Thi s type of
authenti cati on uses Kerberos del egati on to val i date a user's
credenti al s. Kerberos del egati on occurs w hen a servi ce needs to
provi de the Kerberos user's credenti al s to access another servi ce. For
exampl e, i n Mi croStrategy w hen doi ng i ntegrated authenti cati on i n
Web, the w eb server needs to "del egate" the user's credenti al s to
Intel l i gence server so that the user can l og i n seaml essl y. In addi ti on
to authenti cati ng users to D evel oper and Mi croStrategy Web,
i ntegrated authenti cati on al so passes user credenti al s dow n to the

© 2019, M icr o St r at egy In c. 263

Syst em Ad m in ist r at io n Gu id e

database server. Thi s al l ow s each user's credenti al s to be used to

return data from the database.

Mi croStrategy al so supports an Acti ve D i rectory confi gurati on that

makes use of Kerberos C onstrai ned D el egati on to i mprove overal l
securi ty associ ated w i th servi ce communi cati ons. Kerberos
C onstrai ned D el egati on i s a new w ay to del egate Kerberos user's
credenti al s w i th i mproved securi ty. Impl ementi ng Kerberos
C onstrai ned D el egati on i nvol ves speci fyi ng the servi ces that are
al l ow ed i n terms of Intel l i gence Server Kerberos D el egati on, i n
essence creati ng a "w hi te l i st" of al l ow ed servi ces.

For si ngl e si gn-on w i th i ntegrated authenti cati on to w ork, users must

have user names and passw ords that are pri ntabl e, U S-ASC II
characters. Thi s l i mi tati on i s expected behavi or i n Kerberos. Thi s
l i mi tati on i s i mportant to keep i n mi nd w hen creati ng a mul ti l i ngual
envi ronment i n Mi croStrategy.

Act ive Dir ect o r y Acco u n t Co n f igu r at io n

To confi gure your Acti ve D i rectory account you w i l l need to set up a
servi ce account to associ ate w i th Intel l i gence Server as w el l as
create a Servi ce Pri nci pal N ame (SPN ) and enabl e del egati on for
your Intel l i gence Server.

Service Account Setup

For the Acti ve D i rectory user account that you w i l l associ ate w i th the
SPN :

1. Go to U ser Properties > A ccount.

2. In the A ccount options secti on, cl ear the check box next to
A ccount is sensitive and cannot be delegated.

264 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

The D o not require K erberos preauthentication option is

unc hec k ed by default and s hould be k ept that way for Mic roStrategy
s erv ic e ac c ounts us ed for Kerberos Cons trained Delegation.

Create the Intelligence Server Service Principal Name (SPN)

Once the user has been created, a Servi ce Pri nci pal N ame for the
Intel l i gence Server must be attached to the user usi ng the s e t s p n
command.

1. Execute the s e t s p n . e x e - L < y o u r _s e r v i c e _a c c o u n t >

command to ensure no other SPN i s associ ated w i th your servi ce
account.

C: \W in d o w s \ s y s t e m 3 2 >

C: \W in d o w s \ s y s t e m 3 2 s e t s p n . e x e - L m s t r s v r _a c c t

Re gi st e r e d S e r v i c e P r i n c i p a l N a m e s f o r
CN =M ic r o S t r a t e g y S e r v e r
Ac co un t , C N = U s e r s , D C = v m n e t -e s x -m s t r , D C = n e t :

2. Add the SPN usi ng the s e t s p n . e x e - A < y o u r _s e r v i c e _

ac co un t > command.

Mic roStrategy s oftware ex pec ts that the s erv ic e name will be

MS TR S V R S v c , and that the Intelligenc e Serv er port number will be
added to the end of the hos tname. The SPN s hould be formated as :
MS TR S V R S v c / < h o s t n a m e > : < p o r t> @ < r e a l m > . The realm
does not need to be s pec ified in the s e t s p n c ommand. It will
automatic ally us e the default realm of the Ac tiv e Direc tory
mac hine.

C: \W in d o w s \ s y s t e m 3 2 >

C: \W in d o w s \ s y s t e m 3 2 > s e t s p n - A
MS TR SV R S v c / e x a m p l e s e r v e r . e x a m p l e . c o m : 3 4 9 5 2
yo ur _ s e r v i c e _a c c o u n t

© 2019, M icr o St r at egy In c. 265

Syst em Ad m in ist r at io n Gu id e

Re gi st e r i n g S e r v i c e P r i n c i p a l N a m e s f o r C N = y o ur _
se rv ic e _ a c o u n t , C N = U s e r s , D C = e x a m p l e , D C = c o m

MS TR SV R S v c / e x a m p l e s e r v e r . e x a m p l e . c o m : 3 4 9 5 2

Up da te d o b j e c t

If y ou enc ounter any errors , c ontac t y our Ac tiv e Direc tory

adminis trator before c ontinuing.

Enabling Unconstrained Delegation for the Intelligence Server Service

If si ngl e-si gn on authenti cati on to a w arehouse database i s requi red,

an addi ti onal confi gurati on step must be performed on the Acti ve
D i rectory machi ne. Kerberos del egati on w i l l be requi red for the
Intel l i gence Server to authenti cate the end user to the database
server.

1. After creati ng the SPN , open the associ ated servi ce user
account.

2. On the D el egati on tab sel ect Trust this user for delegation to
any service (K erberos only).

3. C l i ck A pply, then OK .

Enabling Constrained Delegation for the Intelligence Server Service

1. After creati ng the SPN , open the associ ated servi ce user
account.

2. On the D el egati on tab sel ect Trust this user for delegation to
specified services only.

3. C l i ck A dd.

4. Provi de the servi ce account for the desti nati on servi ces then
sel ect a regi stered servi ce from the l i st.

266 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

5. R epeat steps 3 and 4 unti l each servi ce requi ri ng del egated

access have been added.

ASP v ers ions of s erv ers hos ted on IIS will be us e ex tra protoc ols
to mak e Kerberos Cons trained Delegation work , and the U se any
authentication protocol option needs to be enabled for their
s erv ic e ac c ounts .

6. C l i ck A pply, then OK .

Enabling Constrained Delegation for Intelligence Server to a Data

Source

For Intel l i gence Server to del egate to a data source:

l Sel ect the U se any authentication protocol opti on.

l Add the Intel l i gence Server to the l i st of servi ces that accept
del egated credenti al s.

l Add the data source servi ces to the l i st of servi ces that accept
del egated credenti al s.

If the data s ourc e is an MDX prov ider, ins tead of allowing delegation
to databas e s erv ic es :

l Add the MDX prov ider s erv ic e.

l On the s erv ic e ac c ount of MDX prov ider allow delegation to the

databas e s erv ic es .

© 2019, M icr o St r at egy In c. 267

Syst em Ad m in ist r at io n Gu id e

In t elligen ce Ser ver Co n f igu r at io n f o r In t egr at ed

Au t h en t icat io n

Configuring Intelligence Server on Windows

For users w i th Intel l i gence Server depl oyed on a Wi ndow s pl atform

do not need to perform any addi ti onal confi gurati on. Authenti cati on i s
passed betw een l i brari es so a Kerberos confi gurati on fi l e and keytab
are not needed. If Intel l i gence Server i s runni ng on domai n account,
the account needs to be an admi ni strator or be enabl ed to act as part
of the operati ng system.

C onti nue to D evel oper C onfi gurati on for Integrated Authenti cati on to
compl ete setup.

Configuring Intelligence Server on Linux for Integrated Authentication

The confi gurati ons l i sted bel ow are requi red to confi gure Intel l i gence
Server w i th your Wi ndow s domai n control l er and Kerberos securi ty.

Kerberos only s upports US-ASCII c harac ters . Do not us e any s pec ial
c harac ters when ins talling or c onfiguring Kerberos .

You hav e performed the s teps des c ribed in Acti ve D i rectory Account
C onfi gurati on .

Inst al l Ker b er os 5

You must have Kerberos 5 i nstal l ed on your Li nux machi ne that hosts
Intel l i gence Server. Your Li nux operati ng system may come w i th
Kerberos 5 i nstal l ed. If Kerberos 5 i s not i nstal l ed on your Li nux
machi ne, refer to the Kerberos documentati on for steps to i nstal l i t.

268 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Ensur e t hat t he Envi r onm ent Var i ab l es ar e Set

Once you have i nstal l ed Kerberos 5, you must ensure that the
fol l ow i ng envi ronment vari abl es have been created:

The v ariables mus t be s et when the Intelligenc e Serv er s tarts in order to

tak e effec t.

Va r ia ble De s c r iption De fa ult Re quir e d/Optiona l

Locat ion of all

${K RB 5_HOME } K erberos / et c/ krb5 Opt ional
conf igurat ion f iles

Locat ion of t he
${K RB 5_CONFI G} def ault K erberos / et c/ krb5/ krb5. conf Required
conf igurat ion f ile

Locat ion of t he
/ et c/ krb5/ krb5_
${K RB 5CCNA ME } K erberos credent ial Opt ional
ccache
cache

${K RB 5_ Locat ion of t he

/ et c/ krb5/ krb5. keyt ab Required
K TNA ME } K erberos keyt ab f ile

For K eberos C onstrained D elegation : The env ironment v ariable

${KRB5_CLIENT_KTNAME} needs to be s et to point to the k ey tab file
us ed by Intelligenc e Serv er.

Conf i gur e t he kr b 5.Keyt ab Fi l e f or t he Int el l i gence Ser ver

You must create and confi gure the k r b 5 . k e yt a b fi l e. The steps to

confi gure thi s fi l e on your Li nux machi ne are provi ded i n the
procedure bel ow .

The proc edure below requires a few v ariables to be entered for v arious
c ommands . This inc ludes information y ou c an gather before y ou begin the

© 2019, M icr o St r at egy In c. 269

Syst em Ad m in ist r at io n Gu id e

proc edure. The required v ariables in the following proc edure are des c ribed
below:

l IS Ma ch in e N a m e : The name of the Intelligenc e Serv er mac hine.

l IS Po rt : The port number for Intelligenc e Serv er.

l Ke yV er si o n N u m b e r : The k ey v ers ion number, retriev ed as part of

this proc edure.

l En cr yp ti o n T y p e : The enc ry ption ty pe us ed.

We rec ommend that y ou us e r c 4 -h m a c as the enc ry ption ty pe.

Other enc ry ption ty pes may c aus e c ompatibility is s ues with the
Windows Ac tiv e Direc tory .

l DO MA IN _ R E A L M : The domain realm for y our Intelligenc e Serv er, whic h

mus t be entered in upperc as e.

To Create a krb5.keytab File

1. Log i n to your Li nux machi ne.

2. R etri eve the key versi on number for your Intel l i gence Server
servi ce pri nci pal name, usi ng the fol l ow i ng command:

kv no MS T R S V R S v c /I S M a c h i n e N a m e:I S P o r t@D O M A I N _
RE AL M

The key versi on number i s di spl ayed on the command l i ne.

3. In the command l i ne, type the fol l ow i ng commands:

ktutil
addent -password -p MSTRSVRSvc/
ISMachineName:ISPort@DOMAIN_REALM -k KeyVersionNumber -e
EncryptionType
wkt /etc/krb5/krb5.keytab
exit

270 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

4. To veri fy the keytab fi l e, type the fol l ow i ng command:

kinit -k -t /etc/krb5/krb5.keytab
MSTRSVRSvc/ISMachineName:ISPort@DOMAIN_REALM

The command shoul d run w i thout prompti ng you for a username

and passw ord.

Conf i gur e t he kr b 5.conf Fi l e f or t he Int el l i gence Ser ver

You must create and confi gure a fi l e named k r b 5 . c o n f. Thi s fi l e i s

stored i n the / e t c / k r b 5 / di rectory by defaul t.

If y ou c reate a k r b 5 . c o n f file in a direc tory other than the default, y ou

mus t update the K R B 5 _C O N F I G env ironment v ariable with the new
loc ation. Refer to y our Kerberos doc umentation for s teps to modify the
KR B5 _ CO N F I G env ironment v ariable.

The contents of the k r b 5 . c o n f shoul d be as show n bel ow :

[libdefaults]
default_realm = DOMAIN_REALM
default_keytab_name = FILE:/etc/krb5/krb5.keytab
forwardable = true
no_addresses = true

[realms]
DOMAIN_REALM = {
kdc = DC_Address:88
admin_server = DC_Admin_Address:749
}

[domain_realm]
.domain.com = DOMAIN_REALM
domain.com = DOMAIN_REALM
.subdomain.domain.com = DOMAIN_REALM
subdomain.domain.com = DOMAIN_REALM

The vari abl es i n the syntax above are descri bed bel ow :

© 2019, M icr o St r at egy In c. 271

Syst em Ad m in ist r at io n Gu id e

l DO MA IN _ RE A L M: The domai n real m used for authenti cati on

purposes. A domai n real m i s commonl y of the form E X A M P L E . C O M,
and must be entered i n uppercase.

l do ma in .c o m and s u b d o m a i n . d o m a i n . c o m: U se thi s for al l

domai ns and subdomai ns w hose users must be authenti cated usi ng
the defaul t Kerberos real m.

l DC _ A dd re s s : The host name or IP address of the Wi ndow s

machi ne that hosts your Acti ve D i rectory domai n control l er. Thi s
can be the same address as D C _A d m i n _A d d r e s s.

l DC _ A dm in _ A d d r e s s: The host name or IP address of the Wi ndow s

machi ne that hosts your Acti ve D i rectory domai n control l er
admi ni strati on server. Thi s can be the same address as D C _
Ad dr es s .

Develo p er Co n f igu r at io n f o r In t egr at ed Au t h en t icat io n

To enabl e i ntegrated authenti cati on i n a Wi ndow s Mi croStrategy
envi ronment you w i l l need to confi gure your Mi croStrategy users and
the Proj ect sources.

Configure the Project Source

1. In D evel oper ri ght cl i ck on your Proj ect Source.

2. C l i ck Modify Project Source.

3. On the C onnection tab, under Server N ame, type the server

name exactl y as i t appears i s the Servi ce Pri nci pal N ame
created i n Acti ve D i rectory Account C onfi gurati on w i th the format
MS TR SV R S v c / < h o s t n a m e > : < p o r t > @ < r e a l m >.

4. In the A dvanced tab U se Integrated A uthentication.

272 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Mapping Users to Active Directory

1. In Proj ect Source open A dministration > U ser Manager.

2. R i ght cl i ck on a user and sel ect Edit > A uthentication >

Metadata.

3. Enter the Acti ve D i rectory user l og i n under Trusted

A uthentication R equest U ser ID .

4. C l i ck OK .

Linking Integrated Authentication Users to LDAP Users

When users l og i n to Mi croStrategy usi ng thei r i ntegrated

authenti cati on credenti al s, thei r LD AP group membershi ps can be
i mported and synchroni zed.

By defaul t, users' i ntegrated authenti cati on i nformati on i s stored i n

the u se rP ri n c i p a l N a m e LD AP attri bute. If your system stores
i ntegrated authenti cati on i nformati on i n a di fferent LD AP attri bute,
you can speci fy the attri bute w hen you confi gure the i mport.

To Im p or t LDAP U ser and Gr oup Inf or m at i on f or Int egr at ed

Aut hent i cat i on U ser s

1. In D evel oper, l og i n to a proj ect source. You must l og i n as a

user w i th admi ni strati ve pri vi l eges.

2. From the A dministration menu, sel ect Server, and then sel ect
C onfigure MicroStrategy Intelligence Server.

3. Expand the LD A P category, then expand Import, and then sel ect
Options.

4. Sel ect the Synchronize user/group information with LD A P

during Windows authentication and import Windows link
during B atch Import check box.

© 2019, M icr o St r at egy In c. 273

Syst em Ad m in ist r at io n Gu id e

5. Sel ect the B atch import Integrated A uthentication/Trusted

A uthentication unique ID check box.

6. By defaul t, users' i ntegrated authenti cati on ID s are stored i n the

us er Pr i n c i p a l N a m e LD AP attri bute. If your system stores
i ntegrated authenti cati on i nformati on i n a di fferent LD AP
attri bute, cl i ck Other, and type the LD AP attri bute that contai ns
users' ID s.

7. C l i ck OK .

Co n f igu r e Micr o St r at egy Ap p licat io n Ser ver s f o r In t egr at ed

Au t h en t icat io n
C onfi gurati on of your Mi croStrategy appl i cati on servers i s si mi l ar to
the process for al l ow i ng Intel l i gence Server to use i ntegrated
authenti cati on. You w i l l need to create a user and associ ated Servi ce
Pri nci pal N ame (SPN ) i n Acti ve D i rectory for each appl i cati on server
servi ce. You w i l l then need to perform pl atform speci fi c confi gurati on
steps to each of the servers. See the appropri ate secti on for your
appl i cati on server depl oyments:

l Enabl i ng Integrated Authenti cati on for the Li brary ServerJ2EE-

C ompl i ant Appl i cati on Servers

l Enabl i ng Integrated Authenti cati on for IIS

Enabling Integrated Authentication for the Library ServerJ2EE-

Compliant Application Servers

If you use a J2EE-compl i ant appl i cati on server to depl oy

Mi croStrategy Web, Mi croStrategy Li brary, Mi croStrategy Mobi l e
Server, or to depl oy Mi croStrategy Web Servi ces to support
Mi croStrategy Offi ce, you can support i ntegrated authenti cati on. If you
are confi guri ng i ntegrated authenti cati on on your Mi croStrategy

274 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Li brary server you do not need to perform the steps regardi ng

generati on and confi gurati on of .j aas fi l es.

Cr eat e a Ser vi ce Pr i nci p al N am e f or Your Li b r ar yAp p l i cat i on Ser ver

You must create a Servi ce Pri nci pal N ame (SPN ) for your J2EE
appl i cati on server, and map i t to the domai n user that the appl i cati on
server runs as. The SPN i denti fi es your appl i cati on server as a
servi ce that uses Kerberos. For i nstructi ons on creati ng an SPN , see
Acti ve D i rectory Account C onfi gurati on.

The SPN shoul d be i n the fol l ow i ng format:

HT TP / AS Ma c h i n e N a m e

The format i s descri bed bel ow :

l HT TP : Thi s i s the servi ce cl ass for the appl i cati on server.

l AS Ma ch in e N a m e: Thi s i s the ful l y qual i fi ed host name of the server

w here the appl i cati on server i s runni ng. It i s of the form m a c h i n e -
na me .e xa m p l e . c o m. Integrated authenti cati on w i l l onl y functi on
w hen accessi ng the appl i cati on server usi ng the A S M a c h i n e N a me
used to regi ster the SPN . If the ful l y qual i fi ed host name w as
regi stered as SPN , then usi ng the machi ne name or IP address w i l l
not w ork. Shoul d the appl i cati on server be accessi bl e through
FQD N and machi ne name, addi ti onal SPN s w i l l need to be
regi stered to the AD servi ce account.

In your Acti ve D i rectory, confi gure the appl i cati on server’ s domai n
user to be trusted for del egati on, and map the user to thi s SPN . For
exampl e, i f you regi ster the SPN to the Acti ve D i rectory user j 2 e e -
http , enabl e the A ccount is trusted for delegation opti on for the
user. Al so, enabl e the Trust this computer for delegation to any
service (K erberos only) opti on for the machi ne w here your
appl i cati on server i s hosted.

© 2019, M icr o St r at egy In c. 275

Syst em Ad m in ist r at io n Gu id e

Conf i gur e t he k r b 5 . k e yt a b Fi l e f or t he Ap p l i cat i on Ser ver

You must create and confi gure a k r b 5 . k e y t a b fi l e for the

appl i cati on server. In U N IX, you must use the k u t i l uti l i ty to create
thi s fi l e. In Wi ndow s, you must use the k t p a s s uti l i ty to create the
keytab fi l e.

The proc edure below requires a few v ariables to be entered for v arious
c ommands . This inc ludes information y ou c an gather before y ou begin the
proc edure. The required v ariables in the following proc edure are des c ribed
below:

• AS Ma ch i n e N a m e: The name of the machi ne that the

Li braryappl i cati on server i s i nstal l ed on.

• Ke yV er s i o n N u m b e r: The key versi on number, retri eved as part

of thi s procedure.

• DO MA IN _ R E A L M: The domai n real m for the Li braryappl i cati on

server. It i s of the form E X A M P L E . C O M, and must be entered i n
uppercase.

• En cr yp t i o n T y p e: The encrypti on type used.

It is rec ommended that y ou us e r c 4 -h m a c as the enc ry ption ty pe.

Other enc ry ption ty pes may c aus e c ompatibility is s ues with the
Windows Ac tiv e Direc tory .

• Ke yt ab _ P a t h: For J2EE appl i cati on servers under Wi ndow s,

thi s speci fi es the l ocati on of the k r b 5 . k e y t a b fi l e. It i s of the
form C: \t e m p \ e x am p l e . k e y t a b.

• AS Us er and A S U s e r P a s s w o r d: The user account for w hi ch the

SPN w as regi stered, for exampl e j 2 e e -h t t p and i ts passw ord.

To create a kr b 5 . k e y ta b fi l e i n Li nux

If y our applic ation s erv er and Intelligenc e Serv er are hos ted on the

276 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

s ame mac hine, it is required that y ou us e s eparate k ey tab and

c onfiguration files for eac h. For ex ample, if y ou are us ing
kr b5 .k e y t a b and k r b 5 . c o n f for the Intelligenc e Serv er, us e
kr b5 - ht t p . k e y t a b and k r b 5 -h t t p . c o n f for the applic ation
s erv er.

1. Log i n to your Li nux machi ne.

2. R etri eve the key versi on number for your appl i cati on server
servi ce pri nci pal name, usi ng the commands show n bel ow :

kinit ASUser
kvno ASUser

The vari abl es are descri bed i n the prerequi si tes above.

The key versi on number i s di spl ayed on the command l i ne.

3. In the command l i ne, type the fol l ow i ng commands:

If y our applic ation s erv er is ins talled on the s ame mac hine as the
Intelligenc e Serv er, replac e k r b 5 . k e yt a b below with a different
file name than the one us ed for the Intelligenc e Serv er, s uc h as
kr b5 -h t t p . k e y t a b .

ktutil
addent -password -p ASUser@DOMAIN_REALM -k KeyVersionNumber -e
EncryptionType rc4-hmac
wkt /etc/krb5/krb5.keytab
exit

4. To veri fy the keytab fi l e, type the fol l ow i ng command:

ki ni t -k -t / e t c / k r b 5 / k r b 5 . k e y t a b
AS Us er @D O M A I N _R E A L M

The command shoul d run w i thout prompti ng you for a passw ord.

To create a kr b 5 . k e y ta b fi l e i n Wi ndow s

© 2019, M icr o St r at egy In c. 277

Syst em Ad m in ist r at io n Gu id e

1. Log i n to your Wi ndow s machi ne.

2. From a command prompt, type the fol l ow i ng command:

ktpass ^
-out Keytab_Path ^
-princ ASUser@DOMAIN_REALM ^
-pass ASUserPassword ^
-crypto RC4-HMAC-NT ^
-pType KRB5_NT_PRINCIPAL

Conf i gur e t he k r b 5 . c o nf Fi l e f or t he Li b r ar yAp p l i cat i on Ser ver

You must create and confi gure a fi l e named k r b 5 . c o n f.

For Linux only : If y our Library applic ation s erv er and Intelligenc e Serv er
are hos ted on the s ame mac hine, it is required that y ou us e a s eparate
c onfiguration file. For ex ample, if y ou c reated k r b 5 . c o n f for the
Intelligenc e Serv er, us e k r b 5 -h t t p . c o n f for the applic ation s erv er.

If you have created a di fferent keytab fi l e i n Enabl i ng Integrated

Authenti cati on for the Li brary ServerJ2EE-C ompl i ant Appl i cati on
Servers, page 274, repl ace k r b 5 . k e y t a b bel ow w i th your ow n
keytab fi l e.

The contents of the k r b 5 . c o n f shoul d be as show n bel ow :

[libdefaults]
default_realm = DOMAIN_REALM
default_keytab_name = Keytab_Path
forwardable = true
no_addresses = true

[realms]
DOMAIN_REALM = {
kdc = DC_Address:88
admin_server = DC_Admin_Address:749
}

278 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

[domain_realm]
.domain.com = DOMAIN_REALM
domain.com = DOMAIN_REALM
.subdomain.domain.com = DOMAIN_REALM
subdomain.domain.com = DOMAIN_REALM

The vari abl es i n the syntax above are descri bed bel ow :

l DO MA IN _ RE A L M: The domai n real m used for authenti cati on

purposes. A domai n real m i s commonl y of the form E X A M P L E . C O M,
and must be entered i n uppercase.

l Ke yt ab _ Pa t h: The l ocati on of your k r b 5 .k e y t a b fi l e. In Li nux, i t

i s of the form / e t c / k r b 5 / k r b 5 . k e y t a b. In Wi ndow s, i t i s of the
form C: \t e m p \ k r b 5 . k e y t a b.

l do ma in .c o m and s u b d o m a i n . d o m a i n . c o m: U se these for al l

domai ns and subdomai ns w here users must be authenti cated usi ng
the defaul t Kerberos real m.

l DC _ A dd re s s : The host name or IP address of the Wi ndow s

machi ne that hosts your Acti ve D i rectory domai n control l er. Thi s
can be the same address as D C _A d m i n _A d d r e s s.

l DC _ A dm in _ A d d r e s s: The host name or IP address of the Wi ndow s

machi ne that hosts your Acti ve D i rectory domai n control l er
admi ni strati on server. Thi s can be the same address as D C _
Ad dr es s .

Conf i gur e t he j a a s . c o nf Fi l e f or t he Ap p l i cat i on Ser ver

You must confi gure the Java Authenti cati on and Authori zati on Servi ce
(JAAS) confi gurati on fi l e for your appl i cati on server.

This s tep is not required for Mic roStrategy Library Serv er.

D ependi ng on the versi on of the Java D evel opment Ki t (JD K) used by

your appl i cati on server, the format of the j a a s . c o n f fi l e vari es

© 2019, M icr o St r at egy In c. 279

Syst em Ad m in ist r at io n Gu id e

sl i ghtl y. R efer to your JD K documentati on for the appropri ate format.

Sampl e j aas.conf fi l es for the Sun and IBM JD Ks fol l ow . The fol l ow i ng
vari abl es are entered i n the . a c c e p t secti on of the j a a s . c o n f fi l e.:

l AS Ma ch in e N a m e: The name of the machi ne that the appl i cati on

server i s i nstal l ed on.

l DO MA IN _ RE A L M: The domai n real m used for authenti cati on

purposes. It i s of the form E X A M P L E . C O M, and must be entered i n
uppercase.

Sample jaas.conf for Sun JD K 1.7 and above

com.sun.security.jgss.krb5.accept {
com.sun.security.auth.module.Krb5LoginModule required
principal="ASUser@DOMAIN_REALM"
useKeyTab=true
doNotPrompt=true
storeKey=true
debug=true;
};

Sample jaas.conf for IB M JD K

com.ibm.security.jgss.initiate {
com.ibm.security.auth.module.Krb5LoginModule required
useDefaultKeytab=true
principal="ASUser@DOMAIN_REALM"
credsType=both
debug=true
storeKey=true;
};

Save the j aa s . c o n f fi l e to the same l ocati on as your k r b 5 . c o nf

fi l e.

Conf i gur e t he JVM St ar t up Par am et er s

This s tep is not required for Mic roStrategy Library Serv er.

280 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

For your J2EE-compl i ant appl i cati on server, you must set the
appropri ate JVM startup parameters. The vari abl es used are
descri bed bel ow :

l JA AS _ Pa th : The path to the j a a s . c o n f fi l e. In Li nux, i t i s of the

form /e tc / k r b 5 / j a a s . c o n f. In Wi ndow s, i t i s of the form
C: \t em p\ j a a s . c o n f.

l KR B5_Path: The path to the krb5.conf fi l e. In Li nux, i t i s of the form

/e tc /k rb 5 / k r b 5 . c o n f. In Wi ndow s, i t i s of the form
C: \t em p\ k r b 5 . c o n f .

You must modi fy the JVM startup parameters l i sted bel ow :

-Djava.security.auth.login.config=JAAS_Path
-Djava.security.krb5.conf=KRB5_Path
-Djavax.security.auth.useSubjectCredsOnly=false

Enab l e t he SPN EGO M echani sm

This s tep is not required for Mic roStrategy Library Serv er.

As part of a Mi croStrategy Web or Mobi l e Server JSP depl oyment, you

must modi fy the w e b . x m l fi l e for Mi croStrategy Web or Mobi l e, to
enabl e the Si mpl e and Protected GSSAPI N egoti ati on Mechani sm
(SPN EGO). Thi s i s accompl i shed by removi ng the comments around
the fol l ow i ng i nformati on i n the w e b . x m l fi l e:

For Mi croStrategy Web:

<filter>
<display-name>SpnegoFilter</display-name>
<filter-name>SpnegoFilter</filter-name>
<filter-class>com.microstrategy.web.filter.SpnegoFilter</filter-
class>
</filter>
<filter-mapping>
<filter-name>SpnegoFilter</filter-name>

© 2019, M icr o St r at egy In c. 281

Syst em Ad m in ist r at io n Gu id e

<servlet-name>mstrWeb</servlet-name>
</filter-mapping>

For Mi croStrategy Mobi l e Server:

<filter>
<display-name>SpnegoFilter</display-name>
<filter-name>SpnegoFilter</filter-name>
<filter-class>com.microstrategy.mobile.filter.SpnegoFilter</filter-
class>
</filter>
<filter-mapping>
<filter-name>SpnegoFilter</filter-name>
<servlet-name>mstrMobileAdmin</servlet-name>
</filter-mapping>

Enab l i ng Int egr at ed Aut hent i cat i on f or t he Li b r ar y Ser ver

1. Launch the Li brary Admi n page by enteri ng the fol l ow i ng U R L i n

your w eb brow ser

ht tp :/ / < F Q D N > : < p o r t > / M i c r o S t r a t e g y L i b r a r y / a d m in

w here < F Q D N > i s the Ful l y Qual i fi ed D omai n N ame of the

machi ne hosti ng your Mi croStrategy Li brary appl i cati on and
<p or t> i s the assi gned port number.

2. On the Library Web Server tab, sel ect Integrated from the l i st of
avai l abl e A uthentication Modes.

3. C l i ck Save.

4. R estart your Web Server to appl y the change.

R estart your appl i cati on server for al l the above setti ngs to take
effect.

282 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Enabling Integrated Authentication for IIS

Integrated authenti cati on i n Mi croStrategy requi res communi cati on

betw een your Kerberos securi ty system, IIS, and your database.

You must confi gure IIS to enabl e i ntegrated authenti cati on to the
Mi croStrategy vi rtual di rectory to support i ntegrated authenti cati on to
Mi croStrategy Web, or Mi croStrategy Web Servi ces to support
Mi croStrategy Offi ce.

If y ou are us ing Mic ros oft Analy s is Serv ic es , to s upport report

s ubs c riptions , y ou mus t us e c onnec tion mapping to pas s us ers '
c redentials to Analy s is Serv ic es . For s teps to enable c onnec tion
mapping, s ee C onnecti on Maps: Standard Authenti cati on,
C onnecti on Maps, and Parti ti oned Fact Tabl es, page 341 .

Enab l e Int egr at ed Aut hent i cat i on t o t he M i cr oSt r at egy Vi r t ual

Di r ect or y

1. On the Mi croStrategy Web server machi ne, access the IIS

Internet Servi ce Manager.

2. Brow se to and ri ght-cl i ck the MicroStrategy vi rtual fol der and

sel ect Properties.

3. Sel ect the D irectory Security tab, and then under A nonymous
access and authentication control, cl i ck Edit.

4. C l ear the Enable anonymous access check box.

5. Sel ect the Integrated Windows authentication check box.

6. C l i ck OK .

7. If you w ant to enabl e i ntegrated authenti cati on for Mi croStrategy

Mobi l e, repeat the above procedure for the MicroStrategyMobile
vi rtual fol der.

© 2019, M icr o St r at egy In c. 283

Syst em Ad m in ist r at io n Gu id e

8. If you w ant to enabl e i ntegrated authenti cati on for Mi croStrategy

Web Servi ces, repeat the above procedure for the
MicroStrategyWS vi rtual fol der.

9. R estart IIS for the changes to take effect.

Conf i gur i ng Web / M ob i l e Ser ver f or Const r ai ned Del egat i on

Currently ASP Web c an only delegate us ers from the s ame domain

U si ng Kerberos constrai ned del egati on requi res the fol l ow i ng

addi ti onal confi gurati on to your Web/Mobi l e Server:

l ASP i mpersonati on needs to be di sabl ed

l Kerberos mode i n s y s _d e f a u l t . x m l needs to be set to

DE LE GA TI O N

l ASP appl i cati on pool (i f runni ng on system account):

AppPool Identi ty doesn't w ork. use Local System

l For IIS version 7 and older: If ASP runs on domai n account, the
account needs to be an admi ni strator or be enabl ed to act as part of
the operati ng system.

Cr eat i ng a Ser vi ce Pr i nci p al N am e f or IIS

It i s recommended that you create a Servi ce Pri nci pal N ame (SPN ) for
IIS, and map i t to the domai n user that the appl i cati on server runs as.
The SPN i denti fi es your appl i cati on server as a servi ce that uses
Kerberos. For i nstructi ons on creati ng an SPN , refer to the Kerberos
documentati on.

The SPN shoul d be i n the fol l ow i ng format:

HTTP/ASMachineName

The format i s descri bed bel ow :

284 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l HT TP : Thi s i s the servi ce cl ass for the appl i cati on server.

l AS Ma ch in e N a m e: Thi s i s the ful l y qual i fi ed host name of the server

w here the appl i cati on server i s runni ng. It i s of the form m a c h i n e -
na me .e xa m p l e . c o m.

Enab l i ng Sessi on Keys f or Ker b er os Secur i t y

To enabl e si ngl e si gn-on authenti cati on to Mi croStrategy Web from a

Mi crosoft Wi ndow s machi ne, you must modi fy a Wi ndow s regi stry
setti ng on the machi ne hosti ng IIS.

Modi fi cati on of the a l l o w t g t s e s s i o n k e y regi stry setti ng i s

requi red by Mi crosoft to w ork w i th Kerberos securi ty. For i nformati on
on the i mpl i cati ons of modi fyi ng the regi stry setti ng and steps to
modi fy the regi stry setti ng, see the fol l ow i ng Mi crosoft documentati on:

The doc umentation below is produc ed by a third-party v endor and thus

is s ubjec t to c hange. Mic roStrategy mak es no guarantee on the
av ailability or ac c urac y of third-party doc umentation.

l For Mi crosoft Wi ndow s 2003, cl i ck here.

Conf i gur i ng t he kr b 5.i ni Fi l e

If your Intel l i gence Server i s hosted on a Wi ndow s machi ne, you must
confi gure the k r b 5 . i n i fi l e. Thi s fi l e i s i ncl uded w i th an i nstal l ati on
of Mi croStrategy Web, and can be found i n the fol l ow i ng di rectory:

C:\Program Files (x86)\Common Files\MicroStrategy\

The path l i sted above assumes you have i nstal l ed Mi croStrategy i n

the C :\ Pr og r a m F i l e s ( x 8 6 ) di rectory.

Kerberos only s upports US-ASCII c harac ters . Do not us e any s pec ial
c harac ters when ins talling or c onfiguring Kerberos .

© 2019, M icr o St r at egy In c. 285

Syst em Ad m in ist r at io n Gu id e

Once you l ocate the k r b 5 . i n i fi l e, open i t i n a text edi tor. The

content w i thi n the fi l e i s show n bel ow :

[libdefaults]
default_realm = <DOMAIN NAME>
default_keytab_name = <path to keytab file>
forwardable = true
no_addresses = true

[realms]
<REALM_NAME> = {
kdc = <IP address of KDC>:88
admin_server = <IP address of KDC admin>:749
}

[domain_realm]
.domain.com = <DOMAIN NAME>
domain.com = <DOMAIN NAME>
.subdomain.domain.com = <DOMAIN NAME>
subdomain.domain.com = <DOMAIN NAME>

You must confi gure the k r b 5 . i n i fi l e to support your envi ronment by

repl aci ng the entri es encl osed i n < >, w hi ch are descri bed bel ow :

l <D OM AI N N A M E > and < R E A L M _N A M E >: The domai n real m used for
authenti cati on purposes. A domai n real m i s commonl y of the form
EX AM PL E. C O M , and must be entered i n uppercase.

l <I P a dd re s s o f K D C >: The IP address or host name of the

Wi ndow s machi ne that hosts your Acti ve D i rectory domai n
control l er. Thi s can be the same address as < I P a d d r e s s o f
KD C a dm in >.

l <I P a dd re s s o f K D C a d m i n >: The host name or IP address of

the Wi ndow s machi ne that hosts your Acti ve D i rectory domai n
control l er admi ni strati on server. Thi s can be the same address as
<I P a dd re s s o f K D C >.

286 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l do ma in .c o m and s u b d o m a i n . d o m a i n . c o m: U se thi s for al l

domai ns and subdomai ns w hose users must be authenti cated usi ng
the defaul t Kerberos real m.

In t egr at ed Au t h en t icat io n Lo gin f o r Micr o St r at egy

Lib r ar yAp p licat io n s

Enabling integrated authentication login mode for MicroStrategy Web

For Mi croStrategy Web users to be abl e to use thei r Wi ndow s

credenti al s to l og i n to Mi croStrategy Web, you must enabl e
i ntegrated authenti cati on as an avai l abl e l ogi n mode. The procedure
bel ow descri bes the requi red steps for thi s confi gurati on.

To Enable Integrated Authentication Login Mode for MicroStrategy Web

1. From the Wi ndow s Start menu, go to A ll Programs >

MicroStrategy Tools > Web A dministrator.

2. On the l eft, sel ect D efault Properties.

3. In the Login area, for Integrated A uthentication, sel ect the

Enabled check box.

If y ou want integrated authentic ation to be the default login mode

for Mic roStrategy Web, for Integrated A uthentication , s elec t
the D efault option

4. C l i ck Save.

© 2019, M icr o St r at egy In c. 287

Syst em Ad m in ist r at io n Gu id e

Enabling Integrated Authentication Login Mode for MicroStrategy

Library

1. On the machi ne w here the Mi croStrategy Li brary appl i cati on i s

i nstal l ed, open the c o n f i g O v e r r i d e . p r o p e r t i e s fi l e.

l Wi ndow s: C : \ P r og r a m F i l e s ( x 8 6 ) \ C o m m o n
Fi le s\ M i c r o S t r a t e g y \ T o m c a t \ a p a c h e -t o m c a t -
8. 0. 30 \ w e b a p p s \ M i c r o S t r a t e g y L i b r a r y \ W E B -
IN F\ cl a s s e s \ c o n f i g

l Li nux: < t o m c a t _
di re ct o r y > / w e b a p p s / M i c r o S t r a t e g y L i b r a r y / W E B -
IN F/ cl a s s e s / c o n f i g

2. Add fol l ow i ng entri es to c o n f i g O v e r r i d e . p r o p e r t i e s:

l au th .k e r b e r o s . c o n f i g =: set to fi l e path of k r b 5 . c o n f fi l e

l au th .k e r b e r o s . k e y t a b =: set to fi l e path of f i l e . k e y t ab
fi l e

l au th .k e r b e r o s . p r i n c i p a l =: set to Servi ce Pri nci pal

N ame (SPN ) of the Li brary Web Server

l au th .k e r b e r o s . d e b u g = f a l s e

l au th .k e r b e r o s . i s I n i t i a t o r = t r u e

Enabling Integrated Authentication Login Mode for MicroStrategy

Mobile

To al l ow your Mi croStrategy Mobi l e users to use thei r Wi ndow s

credenti al s to l og i nto Mi croStrategy, you create a Mobi l e
confi gurati on, and sel ect Integrated Authenti cati on as the
authenti cati on method. For steps to create a Mobi l e confi gurati on for
your organi zati on, see the Mi croStrategy Mobi l e Admi ni strati on
Gui de.

288 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Co n f igu r e Web Br o wser f o r In t egr at ed Au t h en t icat io n

Integrated Authenti cati on w i th Kerberos requi res that the brow ser
bei ng used to access Mi croStrategy WebLi brary be confi gured to
retri eve the currentl y l ogged i n user from the cl i ent machi ne. The
steps for enabl i ng thi s functi onal i ty are di fferent for the three certi fi ed
brow sers for Mi croStrategy.

Kerberos s hould already be c onfigured on the Mic roStrategy Library s erv er,
Mic roStrategy Web s erv er, and the Mic roStrategy Intelligenc e s erv er.

Microsoft Internet Explorer

1. From the Internet Expl orer Setti ngs menu choose Internet
Options > A dvanced.

2. C heck the Enable Integrated Windows A uthentication setti ng.

3. Go to Security tab > Trusted sites > Sites and add

Mi croStrategy Web.

4. C l i ck C lose.

5. C l i ck C ustom level... and ensure that A nonymous logon i s not

sel ected. Any of the other opti ons are acceptabl e.

6. R estart your computer.

Google Chrome

C hrome reads a key, A u t h N e g o t i a t e D e l e g a t e W h i t e l i s t, w hi ch

confi gures C hrome to al l ow certai n si tes to al l ow del egati on and use
Kerberos. The key can be i mpl emented as a pol i cy i n a Group Pol i cy
Obj ect or added manual l y i n the regi stry on the cl i ent machi ne w here
C hrome i s i nstal l ed. To l earn more about the pol i cy, see Googl e
D ocumentati on.

To add the key manual l y to the regi stry:

© 2019, M icr o St r at egy In c. 289

Syst em Ad m in ist r at io n Gu id e

1. C l ose any open i nstances of C hrome

2. C reate a key w i th the path:

Co mp ut e r \ H K E Y _LO C A L _
MA CH IN E \ S O F T W A R E \ P o l i c i e s \ G o o g l e \ C h r o m e

3. Add a new 'Stri ng' val ue named

Au th Ne g o t i a t e D e l e g a t e W h i t e l i s t.

4. Popul ate thi s 'Stri ng' w i th the host of the Mi croStrategy Web si te,
l i ke show n bel ow :

Mozilla Firefox

Fi refox has tw o fl ags, n e t w o r k . n e g o t i a t e -a u t h . t r u s t e d -u ri s

and n et wo rk . n e g o t i a t e -a u t h . d e l e g a t i o n -u r i s, w hi ch
confi gure i t to trust certai n si tes to al l ow del egati on and use
Kerberos.

1. N avi gate to a b o u t : c o n f i g i n the brow ser.

2. Fi nd the tw o fl ags i n the l i st of confi gurati on setti ngs.

3. D oubl e-cl i ck on each fl ag and enter the host of the Mi croStrategy

290 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Web si te, as show n bel ow :

Lin kin g In t egr at ed Au t h en t icat io n User s t o LDAP User s

When users l og i n to Mi croStrategy Li brary usi ng thei r i ntegrated
authenti cati on credenti al s, thei r LD AP group membershi ps can be
i mported and synchroni zed.

By defaul t, users' i ntegrated authenti cati on i nformati on i s stored i n

the u se rP ri n c i p a l N a m e LD AP attri bute. If your system stores
i ntegrated authenti cati on i nformati on i n a di fferent LD AP attri bute,
you can speci fy the attri bute w hen you confi gure the i mport.

l The LDAP s erv er has been c onfigured, as des c ribed in Setti ng up LD AP

Authenti cati on i n Mi croStrategy Web, Li brary, and Mobi l e, page
198 .

l You hav e c onfigured the s ettings for importing us ers from y our LDAP
direc tory ., as des c ribed in Managi ng LD AP Authenti cati on, page 202 .

To Import LDAP User and Group Information for Integrated

Authentication Users

1. In D evel oper, l og i n to a proj ect source. You must l og i n as a

user w i th admi ni strati ve pri vi l eges.

2. From the A dministration menu, go to Server > C onfigure

MicroStrategy Intelligence Server.

© 2019, M icr o St r at egy In c. 291

Syst em Ad m in ist r at io n Gu id e

3. Go to LD A P > Import > Options. The Import Opti ons are

di spl ayed.

4. Sel ect the Synchronize user/group information with LD A P

during Windows authentication and import Windows link
during B atch Import check box.

5. Sel ect the B atch import Integrated A uthentication/Trusted

A uthentication unique ID check box. The U se D efaul t LD AP
Attri bute opti on i s enabl ed.

6. By defaul t, users' i ntegrated authenti cati on ID s are stored i n the

us er Pr i n c i p a l N a m e LD AP attri bute. If your system stores
i ntegrated authenti cati on i nformati on i n a di fferent LD AP
attri bute, cl i ck Other, and type the LD AP attri bute that contai ns
users' ID s.

7. C l i ck OK .

En ab lin g In t egr at ed Au t h en t icat io n t o Dat a So u r ces

Through the use of i ntegrated authenti cati on, you can al l ow each
user's credenti al s to be passed to your database server. You must
enabl e thi s opti on at the proj ect l evel .

If y our reports or doc uments us e s ubs c riptions , us ing integrated

authentic ation for y our data s ourc es prev ents the s ubs c riptions from
running.

Your databas e s erv er mus t be c onfigured to allow integrated authentic ation

for all Mic roStrategy us ers that us e it as a data warehous e. Refer to y our
third-party databas e s erv er doc umentation for ins truc tions on enabling this
s upport.

292 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To Enable Integrated Authentication to Data Sources

1. In D evel oper, l og i n to the proj ect w hose data sources you w ant
to confi gure.

2. In the A dministration menu, sel ect Projects, then choose

Project C onfiguration.

3. Expand the D atabase instances category.

4. Expand A uthentication, and sel ect Warehouse.

5. Enabl e the For selected database instances radi o button.

6. From the Metadata authentication type drop-dow n l i st, choose

K erberos.

7. In the D atabase Instance pane, enabl e the check boxes for al l

the database i nstances for w hi ch you w ant to use i ntegrated
authenti cati on, as show n bel ow .

If y ou are c onnec ting to a Mic ros oft SQL Serv er, Teradata, or TM1
data s ourc e, us e this s etting only if y our Intelligenc e Serv er is
running on Windows .

© 2019, M icr o St r at egy In c. 293

Syst em Ad m in ist r at io n Gu id e

8. C l i ck OK .

En ab lin g In t egr at ed Au t h en t icat io n f o r t h e Micr o St r at egy

Had o o p Gat eway
The Mi croStrategy H adoop Gatew ay i s a data processi ng engi ne that
you i nstal l i n your H adoop ® envi ronment. The H adoop Gatew ay l ets
you anal yze unstructured data i n H adoop, and provi des hi gh-speed
paral l el data transfer betw een the H adoop D i stri buted Fi l e System
(H D FS) and your Mi croStrategy Intel l i gence Server.

To enabl e i ntegrated authenti cati on for your H adoop cl uster, refer to

your thi rd-party documentati on.

For speci fi c steps to enabl e i ntegrated authenti cati on for your H adoop
cl uster, refer to the documentati on for your H adoop cl uster
di stri buti on.

294 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Enable Single Sign-On to Library with Trusted

Authentication
You can enabl e Si ngl e Si gn-on (SSO) authenti cati on for
Mi croStrategy Li brary usi ng thi rd-party authenti cati on provi der such
as IBM Ti vol i Access Manager, C A Si teMi nder, Oracl e Access
Manager, or Pi ngFederate ® .

Trus ted authentic ation mode c annot be us ed in c ombination with any

other log in mode.

En ab le Tr u st ed Au t h en t icat io n Mo d e
1. Launch the Li brary Admi n page by enteri ng the fol l ow i ng U R L i n
your w eb brow ser

ht tp :/ / < F Q D N > : < p o r t > / M i c r o S t r a t e g y L i b r a r y / a d m in

w here < F Q D N > i s the Ful l y Qual i fi ed D omai n N ame of the

machi ne hosti ng your Mi croStrategy Li brary appl i cati on and
<p or t> i s the assi gned port number.

2. On the Library Web Server tab, sel ect Trusted from the l i st of
avai l abl e A uthentication Modes.

3. Sel ect your authenti cati on provi der from the Provider drop-dow n
menu.

4. C l i ck the C reate Trusted R elationship button to establ i sh

trusted communi cati on betw een Li brary Web Server and
Intel l i gence Server.

Ens ure the Intelligenc e Serv er information is entered c orrec tly

before es tablis hing this trus ted relations hip.

5. C l i ck Save.

6. R estart your Web Server to appl y the changes.

© 2019, M icr o St r at egy In c. 295

Syst em Ad m in ist r at io n Gu id e

En ab le A Cu st o m Au t h en t icat io n Pr o vid er
1. Edi t Li br a r y / W E B-I N F / c l a s s e s / a u t h / t r u s t e d / c u s t o m_
se cu ri t y . p r o p e r t i e s i n a text edi tor.

2. Fi l l i n L o g i n P a r a m and D i s t i n g u i s h e d N a m e based on your

setup w i th authenti cati on provi der.

l Lo gi nP a r a m i s the name of the header vari abl e that your

provi der w i l l use for authenti cati on.

l Di st in g u i s h e d N a m e i s the name of the header vari abl e that

w i l l suppl y the D i sti ngui shed N ame of the user for LD AP
synchroni zati on.

3. R estart Mi croStrategy Li brary to appl y the changes.

Implementing Windows NT Authentication

If you use Wi ndow s 2003 as your netw ork operati ng system and your
users are al ready defi ned i n a Wi ndow s 2003 di rectory, then you can
enabl e Wi ndow s authenti cati on i n Mi croStrategy to al l ow users
access w i thout havi ng to enter thei r l ogi n i nformati on.

The Apple Safari web brows er does not s upport Windows authentic ation
with Mic roStrategy Web.

U se the procedures i n the rest of thi s secti on to enabl e si ngl e si gn-on

w i th Wi ndow s authenti cati on i n Mi croStrategy Web. For hi gh-l evel
steps to confi gure these setti ngs, see Steps to Enabl e Si ngl e Si gn-On
to Mi croStrategy Web U si ng Wi ndow s Authenti cati on, page 298.

To use Wi ndow s authenti cati on you must create users i n the

Mi croStrategy envi ronment and then l i nk them to Wi ndow s users.
Li nki ng enabl es Intel l i gence Server to map a Wi ndow s user to a
Mi croStrategy user. See Li nki ng a Wi ndow s D omai n U ser to a
Mi croStrategy U ser, page 302.

296 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

You can al so create Mi croStrategy users from exi sti ng Wi ndow s by

i mporti ng ei ther user defi ni ti ons or group defi ni ti ons.

To use Wi ndow s authenti cati on w i th Mi croStrategy Web, you must be

runni ng Mi croStrategy Web or Web U ni versal under Mi crosoft IIS.
N on-IIS w eb servers do not support Wi ndow s authenti cati on. See
Enabl i ng i ntegrated authenti cati on for IIS.

If the Wi ndow s domai n account i nformati on i s l i nked to a

Mi croStrategy user defi ni ti on, a Mi croStrategy Web user can be
l ogged i n automati cal l y through Mi croStrategy Web. When a user
accesses Mi croStrategy Web, IIS detects the Wi ndow s user and sends
the l ogi n i nformati on to Intel l i gence Server. If the Wi ndow s user i s
l i nked to a Mi croStrategy user, Intel l i gence Server starts a sessi on for
that user. For i nformati on on setti ng up Mi croStrategy Web to al l ow
si ngl e si gn-on usi ng Wi ndow s authenti cati on, see Enabl i ng Wi ndow s
Authenti cati on Logi n for Mi croStrategy Web, page 305.

En ab lin g Win d o ws Au t h en t icat io n in Micr o St r at egy Web t o

Allo w Sin gle Sign -On
Si ngl e si gn-on authenti cati on al l ow s users to type thei r l ogi n
credenti al s once, and have access to mul ti pl e softw are appl i cati ons
securel y, because the system can appl y that si ngl e authenti cati on
request to al l the appl i cati ons that the user need access to. It i s
possi bl e to use Wi ndow s authenti cati on to enabl e si ngl e si gn-on for
Mi croStrategy Web.

There are several confi gurati ons that you must make to enabl e
Wi ndow s authenti cati on i n Mi croStrategy Web. To properl y confi gure
Mi croStrategy Web, Mi crosoft Internet Informati on Servi ces (IIS), and
the l i nk betw een Mi crosoft and Mi croStrategy users, fol l ow the
procedure Steps to Enabl e Si ngl e Si gn-On to Mi croStrategy Web
U si ng Wi ndow s Authenti cati on, page 298.

© 2019, M icr o St r at egy In c. 297

Syst em Ad m in ist r at io n Gu id e

Steps to use Wi ndow s authenti cati on w i th Mi crosoft Sharepoi nt and

Mi croStrategy Web are i n the Mi croStrategy D evel oper Li brary
(MSD L). The Mi croStrategy SD K and MSD L contai n i nformati on on
customi zi ng Mi croStrategy Web.

Before c ontinuing with the proc edures des c ribed in the res t of this s ec tion,
y ou mus t firs t s et up a Windows domain that c ontains a domain name for
eac h us er that y ou want to allow s ingle s ign-on ac c es s to Mic roStrategy
Web with Windows authentic ation.

In addition, y ou mus t be c onnec ted to the Mic roStrategy Web mac hine
without a prox y . Windows authentic ation does not work ov er a prox y
c onnec tion. For more information, inc luding s ome pos s ible work -arounds ,
s ee Mic ros oft's IIS doc umentation.

Steps to Enable Single Sign-On to MicroStrategy Web Using

Windows Authentication

1. Enabl e i ntegrated Wi ndow s authenti cati on for Mi crosoft IIS. See

Enabl i ng Wi ndow s Authenti cati on for Mi crosoft IIS, page 299.

2. If you are usi ng Mi croStrategy Web U ni versal on a J2EE-based

appl i cati on server such as Apache Tomcat, enabl e the
Mi croStrategy ISAPI fi l ter i n IIS, to support Wi ndow s
authenti cati on. For steps, see Enabl i ng Wi ndow s Authenti cati on
for J2EE-Based Appl i cati on Servers, page 300.

3. C reate a l i nk betw een a Wi ndow s domai n user and a

Mi croStrategy Web user for each person that w i l l be accessi ng
Mi croStrategy Web w i th Wi ndow s authenti cati on. See Li nki ng a
Wi ndow s D omai n U ser to a Mi croStrategy U ser, page 302.

4. D efi ne a proj ect source to use Wi ndow s authenti cati on. See
D efi ni ng a Proj ect Source to U se Wi ndow s Authenti cati on, page
304.

298 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

5. Enabl e Wi ndow s authenti cati on i n Mi croStrategy Web. See

Enabl i ng Wi ndow s Authenti cati on Logi n for Mi croStrategy Web,
page 305.

6. C onfi gure each Mi croStrategy Web user's brow ser for si ngl e
si gn-on. See C onfi guri ng a Brow ser for Si ngl e Si gn-On to
Mi croStrategy Web, page 306.

Enabling Windows Authentication for Microsoft IIS

Mi crosoft Internet Informati on Servi ces i s an Internet server that i s

i ntegral to Wi ndow s authenti cati on. You must confi gure IIS to enabl e
Wi ndow s authenti cati on i n the Mi croStrategy vi rtual di rectory to
support i ntegrated authenti cati on to Mi croStrategy Web.

The steps to perform thi s confi gurati on are provi ded i n the procedure
bel ow , w hi ch may vary dependi ng on your versi on of IIS. The
fol l ow i ng l i nks can hel p you fi nd i nformati on on how to enabl e
i ntegrated authenti cati on for your versi on of IIS:

l IIS 7: See http://technet.mi crosoft.com/en-us/l i brary/

cc754628(WS.10).aspx for i nformati on on enabl i ng Wi ndow s
authenti cati on for IIS 7.

If y ou are us ing IIS 7 on Windows Serv er 2008, ens ure the following:

l The Mic roStrategy WebPool applic ation pool is s tarted, and the
Managed Pipeline is s et to Integrated .

l ASP.NET Impers onation is enabled. For information on enabling

ASP.NET Impers onation in IIS 7, s ee
http://technet.mi crosoft.com/en-us/l i brary/cc730708
(WS.10).aspx .

l IIS 6: See http://technet.mi crosoft.com/en-us/l i brary/

cc780160(WS.10).aspx for i nformati on on enabl i ng Wi ndow s
authenti cati on for IIS 6.

© 2019, M icr o St r at egy In c. 299

Syst em Ad m in ist r at io n Gu id e

l IIS 5: See http://support.mi crosoft.com/kb/215383 for i nformati on on

enabl i ng Wi ndow s authenti cati on for IIS 5.

The third-party produc ts dis c us s ed below are manufac tured by v endors

independent of Mic roStrategy , and the information prov ided is s ubjec t to
c hange. Refer to the appropriate third-party v endor doc umentation for
updated IIS s upport information.

To Enable Windows Authentication in Microsoft IIS

1. On the Mi croStrategy Web server machi ne, access the IIS

Internet Service Manager.

2. N avi gate to and ri ght-cl i ck the Mi croStrategy vi rtual fol der, and
sel ect Properties.

3. Sel ect the D irectory Security tab, and then under A nonymous
access and authentication control, cl i ck Edit.

4. C l ear the A nonymous access check box.

5. Sel ect the Integrated Windows authentication check box.

6. C l i ck OK .

7. R estart IIS for the changes to take effect.

Enabling Windows Authentication for J2EE-Based Application Servers

If you use a J2EE-compl i ant appl i cati on server other than IIS to
depl oy Mi croStrategy Web, you must confi gure IIS to share users'
Wi ndow s authenti cati on credenti al s w i th your appl i cati on server. To
al l ow IIS to share users' Wi ndow s authenti cati on credenti al s w i th your
appl i cati ons server, you must add the Mi croStrategy ISAPI fi l ter to IIS,
as descri bed i n the steps bel ow .

300 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

The third-party produc ts dis c us s ed below are manufac tured by v endors

independent of Mic roStrategy , and the information prov ided is s ubjec t to
c hange. Refer to the appropriate third-party v endor doc umentation for
the lates t information.

In your MicroStrategy installation folder, locate the MBWBAUTH.dll file. By

default, the file is located in C:\Program Files (x86)\Common
Files\MicroStrategy.

Depending on the v ers ion of IIS y ou are us ing, refer to one of the following
proc edures to enable the Mic roStrategy ISAPI filter:

l To Enabl e the Mi croStrategy ISAPI Fi l ter i n IIS 6, page 301

l To Enabl e the Mi croStrategy ISAPI Fi l ter i n IIS 7, page 302

To Enable the MicroStrategy ISAPI Filter in IIS 6

1. In IIS, ri ght-cl i ck the defaul t w eb si te, and sel ect Properties.

2. C l i ck the ISA PI Filters tab. A l i st of ISAPI fi l ters for your IIS

i nstal l ati on i s show n.

3. C l i ck A dd.

4. Brow se to the l ocati on of the M B W B A U T H . d l l fi l e. By defaul t, the

fi l e i s l ocated i n C :\ P r o g r a m F i l e s ( x 8 6 ) \ C o m m o n
Fi le s\ M i c r o S t r a t e g y.

5. Sel ect MB W B A U T H . d l l and cl i ck OK . The M B W B A U T H ISAPI fi l ter

i s added to the l i st of ISAPI fi l ters.

6. R estart your IIS server.

© 2019, M icr o St r at egy In c. 301

Syst em Ad m in ist r at io n Gu id e

To Enable the MicroStrategy ISAPI Filter in IIS 7

1. In IIS, sel ect the defaul t w eb si te. The D efaul t Web Si te H ome
page i s show n.

2. In the D efaul t Web Si te H ome page, doubl e-cl i ck ISA PI Filters.

A l i st of ISAPI fi l ters for your IIS i nstal l ati on i s show n.

3. In the Acti ons pane, cl i ck A dd.

4. In the Filter name fi el d, type a name for the fi l ter. For exampl e,
Mi cr oS t r a t e g y IS A P I F i l t e r.

5. N ext to the Executabl e fi el d, cl i ck Brow se (...).

6. Brow se to the l ocati on of the M B W B A U T H . d l l fi l e. By defaul t, the

fi l e i s l ocated i n C :\ P r o g r a m F i l e s ( x 8 6 ) \ C o m m o n
Fi le s\ M i c r o S t r a t e g y.

7. Sel ect MB W B A U T H . d l l and cl i ck OK .

8. C l i ck OK .

9. R estart your IIS server.

Linking a Windows Domain User to a MicroStrategy User

Once IIS has been confi gured to al l ow i ntegrated Wi ndow s

authenti cati on, a l i nk must be created betw een a user's Mi croStrategy
user name and the user's Wi ndow s domai n user name. The requi red
steps are detai l ed bel ow .

To Link a Windows Domain User to a MicroStrategy User

1. In D evel oper, l og i n to a proj ect source usi ng an account w i th

admi ni strati ve pri vi l eges.

302 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

2. From the Fol der Li st, expand a proj ect source, then expand
A dministration, and then expand U ser Manager.

3. N avi gate to the Mi croStrategy user you w ant to l i nk a Wi ndow s

user to. R i ght-cl i ck the Mi croStrategy user and sel ect Edit.

4. Expand A uthentication, then sel ect Metadata.

5. U nder Windows A uthentication, i n the Link Windows user

area, provi de the Wi ndow s user name for the user you w ant to
l i nk the Mi croStrategy user to. There are tw o w ays to do thi s:

l C l i ck B rowse to sel ect the user from the l i st of Wi ndow s users

di spl ayed.

l C l i ck Search to search for a speci fi c Wi ndow s user by

provi di ng the Wi ndow s l ogi n to search for and, opti onal l y, the
Wi ndow s domai n to search. Then cl i ck OK to run the search.

6. C l i ck OK .

Linking a Windows Login to an LDAP User

When usi ng LD AP w i th Mi croStrategy, you can reduce the number of

ti mes a user needs to enter the same l ogi n and passw ord by l i nki ng
thei r Wi ndow s system l ogi n w i th thei r LD AP l ogi n used i n
Mi croStrategy.

By creati ng a l i nk betw een a Wi ndow s system l ogi n, an LD AP user,

and a Mi croStrategy user, a si ngl e l ogi n i nto the machi ne
authenti cates the user for the machi ne as w el l as i n Mi croStrategy.

For exampl e, a user l ogs i n to thei r Wi ndow s machi ne w i th a l i nked

LD AP l ogi n and passw ord and i s authenti cated. The user then opens
D evel oper and connects to a proj ect source usi ng Wi ndow s
authenti cati on. R ather than havi ng to enter thei r l ogi n and passw ord
to l og i n to Mi croStrategy, the user's l ogi n and passw ord
authenti cated w hen l oggi ng i n to thei r machi ne i s used to

© 2019, M icr o St r at egy In c. 303

Syst em Ad m in ist r at io n Gu id e

authenti cate the user. D uri ng thi s process, the user account and any
rel evant user groups are i mported and synchroni zed for the user.

The LDAP Serv er is c onfigured as the Mic ros oft Ac tiv e Direc tory Serv er
domain c ontroller, whic h s tores the Windows s y s tem login information.

To Link a Windows Login with LDAP and MicroStrategy

1. In D evel oper, l og i n to a proj ect source. You must l og i n as a

user w i th admi ni strati ve pri vi l eges.

2. From the A dministration menu, sel ect Server, and then sel ect
C onfigure MicroStrategy Intelligence Server.

3. Expand the LD A P category, then expand Import, and then sel ect
Options.

4. Sel ect the Synchronize user/group information with LD A P

during Windows authentication and import Windows link
during B atch Import check box.

5. C l i ck OK .

Defining a Project Source to Use Windows Authentication

For Mi croStrategy Web users to gai n access to a proj ect i n a speci fi c

proj ect source usi ng Wi ndow s authenti cati on, the proj ect source must
fi rst be confi gured have Wi ndow s authenti cati on enabl ed. The steps
for enabl i ng thi s confi gurati on are detai l ed bel ow .

To Define a Project Source to Use Windows Authentication

1. In D evel oper, l og i n to a proj ect source usi ng an account w i th

admi ni strati ve pri vi l eges.

2. R i ght-cl i ck the proj ect source and sel ect Modify Project Source

304 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

3. On the A dvanced tab, sel ect the U se network login id

(Windows authentication) opti on.

4. C l i ck OK .

Enabling Windows Authentication Login for MicroStrategy Web

There are tw o w ays to enabl e access to Mi croStrategy Web usi ng

Wi ndow s authenti cati on. Access can be enabl ed for the Mi croStrategy
Web appl i cati on as a w hol e, or i t can be enabl ed for i ndi vi dual
proj ects at the proj ect l evel .

For steps to enabl e Wi ndow s authenti cati on for al l of Mi croStrategy

Web, see To Enabl e Wi ndow s Authenti cati on Logi n for Mi croStrategy
Web, page 305.

For steps to enabl e Wi ndow s authenti cati on for a proj ect, see To
Enabl e Wi ndow s Authenti cati on Logi n for a Proj ect, page 306.

To Enable Windows Authentication Login for MicroStrategy Web

1. From the Wi ndow s Start menu, poi nt to A ll Programs, t hen

MicroStrategy Tools, and t hen sel ect Web A dministrator

2. On the l eft, under Intelligence Server, sel ect D efault

Properties.

3. In the Login area, for Windows A uthentication, sel ect the

Enabled check box.

If y ou want Windows authentic ation to be the default login mode for

Mic roStrategy Web, for Windows Authentic ation, s elec t the Default
option.

4. C l i ck Save.

© 2019, M icr o St r at egy In c. 305

Syst em Ad m in ist r at io n Gu id e

To Enable Windows Authentication Login for a Project

1. Log i nto a Mi croStrategy Web proj ect as a user w i th

admi ni strati ve pri vi l eges.

2. At the upper l eft of the page, cl i ck the MicroStrategy i con, and

sel ect Preferences.

3. On the l eft, sel ect Project D efaults, then Security.

4. In the Login modes area, for Windows A uthentication, sel ect

the Enabled check box.

If y ou want Windows authentic ation to be the default login mode for

this projec t in Mic roStrategy Web, als o s elec t the D efault opt ion.

5. N ext to A pply, choose w hether to appl y these setti ngs to al l

proj ects, or j ust to the one you are currentl y l ogged i nto.

6. C l i ck A pply.

Configuring a Browser for Single Sign-On to MicroStrategy Web

If a Mi croStrategy Web user pl ans to use si ngl e si gn-on to l og i n to

Mi croStrategy Web, each user's brow ser must be confi gured to enabl e
i ntegrated authenti cati on. The process to enabl e i ntegrated
authenti cati on i s di fferent dependi ng on the brow ser they use:

l For Internet Expl orer, you must enabl e i ntegrated authenti cati on for
the brow ser, as w el l as add the Mi croStrategy Web server U R L as a
trusted si te. D ependi ng on your securi ty pol i cy, i ntegrated
authenti cati on may be enabl ed by defaul t for Internet Expl orer.

l For Fi refox, you must add the Mi croStrategy Web server U R L as a

trusted si te. The U R L must be l i sted i n the about:confi g page, i n the
setti ngs netw ork.negoti ate-auth.trusted-uri s and netw ork.negoti ate-
auth.del egati on-uri s.

306 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Enabling Single Sign-on to Web, Mobile, and Office with

Third-Party Authentication
You can enabl e si ngl e si gn-on (SSO) authenti cati on for the fol l ow i ng
Mi croStrategy appl i cati ons usi ng a thi rd-party tool such as IBM Ti vol i
Access Manager, C A Si teMi nder, Oracl e Access Manager, or
Pi ngFederate ® :

l Mi croStrategy Web

l Mi croStrategy Mobi l e

l Mi croStrategy Web Servi ces, to support Mi croStrategy Offi ce (IBM

Ti vol i Access Manager and C A Si teMi nder onl y)

This information applies to Mic roStrategy Offic e, the add-in for

Mic ros oft Offic e applic ations whic h is no longer ac tiv ely dev eloped.

It was s ubs tituted with a new add-in, Mic roStrategy for Offic e, whic h
s upports Offic e 365 applic ations . The initial v ers ion does not y et hav e
all the func tionalities of the prev ious add-in.

For more information, s ee the Mi croStrategy for Offi ce page i n the

2019 U pdate 1 R eadme and the Mi croStrategy for Offi ce Onl i ne
H el p .

Once a user i s authenti cated i n the thi rd-party system, the user's
permi ssi ons are retri eved from a user di rectory, such as LD AP, and
access i s granted to the Mi croStrategy appl i cati on.

In thi s securi ty model , there are several l ayers. For exampl e, w hen a
user l ogs i n to Ti vol i , Ti vol i determi nes w hether the user's credenti al s
are val i d. If the user l ogs i n w i th val i d credenti al s to Ti vol i , the user
di rectory (such as LD AP) determi nes w hether that val i d user can
connect to Mi croStrategy. The user's Mi croStrategy pri vi l eges are
stored w i thi n the Mi croStrategy Access C ontrol Li st (AC L). What a
user can and cannot do w i thi n the Mi croStrategy appl i cati on i s stored
on Intel l i gence Server i n the metadata w i thi n these AC Ls. For more

© 2019, M icr o St r at egy In c. 307

Syst em Ad m in ist r at io n Gu id e

i nformati on about pri vi l eges and AC Ls i n Mi croStrategy, see C hapter

2, Setti ng U p U ser Securi ty.

For Mi croStrategy to be abl e to get a user's pri vi l eges from the

metadata, Intel l i gence Server must be confi gured to be a trusted
machi ne i n Mi croStrategy Web, Mobi l e, and Offi ce. Thi s al l ow s the
i nformati on to be passed betw een the tw o machi nes.

The fol l ow i ng di agram i l l ustrates the archi tecture of a securi ty system

that uses thi rd-party authenti cati on.

Mi croStrategy enabl es thi s type of access by passi ng tokens betw een

Mi croStrategy, the user di rectory, and the thi rd-party authenti cati on
provi der. Properl y confi guri ng these l evel s of communi cati on i s
cri ti cal to i mpl ementi ng SSO authenti cati on.

The dis tinguis hed name of the us er pas s ed from the third-party prov ider
is URL-dec oded by default within Mic roStrategy Web, Mobile, or Web
Serv ic es before it is pas s ed to the Intelligenc e Serv er.

Si ngl e si gn-on authenti cati on performs the step of al l ow i ng a user

access to Mi croStrategy products. You al so must confi gure

308 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Mi croStrategy users to defi ne pri vi l eges and permi ssi ons that control
w hat a user can perform and access w i thi n the products.

Set t in g Up Th ir d -Par t y SSO Au t h en t icat io n in Micr o St r at egy

Pr o d u ct s
The fol l ow i ng hi gh-l evel steps are requi red to set up thi rd-party SSO
authenti cati on i n Mi croStrategy Web, Mobi l e, or Web Servi ces, and
each i s detai l ed bel ow :

l C reati ng U sers and Li nks i n Thi rd-Party Authenti cati on Systems,

page 309

l Enabl i ng Si ngl e Si gn-On Authenti cati on to Mi croStrategy Web,

Mobi l e, or Offi ce, page 310

l Importi ng and Li nki ng Thi rd-Party Authenti cati on U sers i n

Mi croStrategy, page 323

l To Log i n to Mi croStrategy Web U si ng Ti vol i Si ngl e Si gn-On, page

327

Cr eat in g User s an d Lin ks in Th ir d -Par t y Au t h en t icat io n

Syst ems
Before Mi croStrategy can be confi gured to accept Ti vol i , Si teMi nder,
Pi ngFederate or Oracl e Access Manager authenti cati on, certai n
prel i mi nary setti ngs must be establ i shed. Thi s ensures that a l i nk
exi sts betw een the authenti cati on provi der and Mi croStrategy
products, and that the l i nk i s functi oni ng as requi red.

You must compl ete al l of the fol l ow i ng steps to ensure proper

confi gurati on of your authenti cati on provi der and Mi croStrategy
products.

© 2019, M icr o St r at egy In c. 309

Syst em Ad m in ist r at io n Gu id e

Creating a User in Your Third-Party Authentication System

You can enabl e SSO authenti cati on i n Mi croStrategy by associ ati ng a

Mi croStrategy user to a user i n Ti vol i , Si teMi nder, Pi ngFederate or
Oracl e Access Manager. To test thi s associ ati on, you must create a
user i n your authenti cati on system to confi rm that access has been
properl y confi gured i n Mi croStrategy products.

For steps to create a new user, refer to your authenti cati on provi der's
documentati on.

Creating a Link to MicroStrategy Applications in Your Third-Party

Authentication System

You l i nk Ti vol i to Mi croStrategy appl i cati ons usi ng j uncti ons,

Si teMi nder usi ng Web Agents, and Oracl e Access Manager usi ng
Webgates. These l i nks redi rect users from the respecti ve provi der to
Mi croStrategy, and are requi red to enabl e SSO authenti cati on. You
must create one l i nk each, as appl i cabl e, for Mi croStrategy Web,
Mi croStrategy Mobi l e, and Mi croStrategy Web Servi ces to support
Mi croStrategy Offi ce.

Orac le Ac c es s Manager authentic ation is only av ailable for

Mic roStrategy Web.

For steps to create a j uncti on (i n Ti vol i ), a Web Agent (i n Si teMi nder),

or a Webgate (Oracl e Access Manager), refer to the product's
documentati on.

En ab lin g Sin gle Sign -On Au t h en t icat io n t o Micr o St r at egy

Web , Mo b ile, o r Of f ice
Once the i ni ti al thi rd-party authenti cati on setup i s compl ete, you must
enabl e trusted authenti cati on i n Mi croStrategy Web, Mobi l e or Offi ce,
and establ i sh trust betw een the Mi croStrategy product and

310 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Intel l i gence Server. Thi s al l ow s the authenti cati on token to be passed

from one system to the other.

Note that for Mic roStrategy Web Serv ic es to s upport Mic roStrategy
Offic e, y ou mus t es tablis h trus t between Offic e and the Intelligenc e
s erv er, and enable trus ted authentic ation in the c onfiguration files for
Web Serv ic es .

Thi s secti on expl ai ns the fol l ow i ng requi red steps to enabl e SSO
authenti cati on i n Mi croStrategy Web, Mobi l e, or Web Servi ces:

l Enabl i ng Trusted Authenti cati on i n Mi croStrategy Web, page 311

l Enabl i ng Trusted Authenti cati on i n Mi croStrategy Mobi l e, page 313

l Establ i shi ng Trust Betw een Mi croStrategy Web or Mobi l e and

Intel l i gence Server, page 314

l Establ i shi ng Trust Betw een Mi croStrategy Web Servi ces and
Intel l i gence Server, to Support Mi croStrategy Offi ce, page 318

l Enabl i ng Trusted Authenti cati on i n Mi croStrategy Web Servi ces to

Support Mi croStrategy Offi ce, page 320

If you use Internet Informati on Servi ces (IIS) as your w eb server for
Mi croStrategy Web or Web Servi ces, you must enabl e anonymous
authenti cati on to the Mi croStrategy vi rtual di rectori es to support SSO
authenti cati on to Mi croStrategy Web, Mobi l e, or Offi ce. Thi s i s
di scussed i n Enabl i ng Anonymous Authenti cati on for Internet
Informati on Servi ces, page 322.

Enabling Trusted Authentication in MicroStrategy Web

To enabl e users to l og i n to Mi croStrategy Web usi ng SSO

authenti cati on, you must enabl e trusted authenti cati on as an
avai l abl e authenti cati on mode i n Mi croStrategy Web.

© 2019, M icr o St r at egy In c. 311

Syst em Ad m in ist r at io n Gu id e

To Enable Trusted Authentication in MicroStrategy Web

1. From the Wi ndow s Start menu, poi nt to A ll Programs, then

MicroStrategy Tools, and then sel ect Web A dministrator.

2. On the l eft si de of the page, cl i ck D efault Properties.

3. Scrol l dow n to the Logi n area and, under Login mode, sel ect the
Enabled check box next to Trusted A uthentication R equest.
Al so sel ect the D efault opti on next to Trusted A uthentication
R equest, as show n bel ow :

4. From the Trusted A uthentication Providers drop-dow n l i st,

sel ect IB M Tivoli A ccess Manager, C A SiteMinder,
PingFederate, or Oracle A ccess Manager.

To use a custom authenti cati on provi der, sel ect C ustom SSO.
For i nformati on about addi ng custom authenti cati on provi ders,
refer to your Mi croStrategy SD K documentati on.

5. C l i ck Save.

Using Certificate Authentication with SiteMinder

C A Si teMi nder can be confi gured to use ei ther certi fi cate

authenti cati on or basi c authenti cati on. Mi croStrategy Web's

312 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

site mi nd er _ s e c u r i t y . p r o p e r t i e s fi l e i ndi cates that the fi rst

Si teMi nder header vari abl e to be used i s S M _U N I V E R S A L I D. Thi s
vari abl e provi des i nformati on for certi fi cate authenti cati on. If thi s
vari abl e i s empty, then the i nformati on i n the vari abl e S M _U S E R i s
used for basi c authenti cati on. For i nformati on about confi guri ng your
Si teMi nder system to use certi fi cate authenti cati on, see the
Si teMi nder documentati on.

Enabling Trusted Authentication in MicroStrategy Mobile

To enabl e users to l og i n to Mi croStrategy Mobi l e usi ng SSO

authenti cati on, you must enabl e trusted authenti cati on as an
avai l abl e authenti cati on mode i n Mi croStrategy Mobi l e. For
i nstructi ons on confi guri ng mobi l e devi ces to use trusted
authenti cati on, refer to the Admi ni steri ng Mi croStrategy Mobi l e
secti on i n the Mi croStrategy Mobi l e Admi ni strati on Gui de.

To Enable Trusted Authentication in MicroStrategy Mobile

1. From the Wi ndow s Start menu, poi nt to A ll Programs, then

MicroStrategy Tools, and then sel ect Mobile A dministrator.

2. On the l eft si de of the page, cl i ck D efault Properties.

3. From the Trusted A uthentication Providers drop-dow n l i st,

sel ect IB M Tivoli A ccess Manager, C A SiteMinder,
PingFederate, or Oracle A ccess Manager.

To use a custom authenti cati on provi der, sel ect C ustom SSO.
For i nformati on about addi ng custom authenti cati on provi ders,
refer to your Mi croStrategy SD K documentati on.

4. C l i ck Save.

To create a mobi l e confi gurati on to send to users' mobi l e devi ces,

refer to the Admi ni steri ng Mi croStrategy Mobi l e secti on i n the
Mi croStrategy Mobi l e Admi ni strati on Gui de.

© 2019, M icr o St r at egy In c. 313

Syst em Ad m in ist r at io n Gu id e

Establishing Trust Between MicroStrategy Web or Mobile and

Intelligence Server

To enabl e the authenti cati on token to pass from your thi rd-party
authenti cati on provi der to Mi croStrategy Web or Mobi l e, and then to
Intel l i gence Server, a trust rel ati onshi p must be establ i shed betw een
Mi croStrategy Web or Mobi l e and Intel l i gence Server. The steps to
establ i sh trust are descri bed bel ow .

If you need to del ete an establ i shed trust rel ati onshi p, see To D el ete
a Trust R el ati onshi p, page 317.

If y ou are us ing multiple Intelligenc e Serv er mac hines in a c lus ter, y ou

mus t firs t s et up the c lus ter, as des c ribed in C hapter 9, C l usteri ng
Mul ti pl e Mi croStrategy Servers , and then es tablis h trus t between
Web or Mobile Serv er and the c lus ter.

To es tablis h trus t between Mic roStrategy Web or Mobile and Intelligenc e

Serv er, y ou mus t hav e the following priv ileges :

l By pas s all objec t s ec urity ac c es s c hec k s

l Configure s ec urity s ettings

l Enable Intelligenc e Serv er adminis tration from Web

l Web adminis tration

For i nformati on on assi gni ng pri vi l eges to users, see C hapter ,

C ontrol l i ng Access to Functi onal i ty: Pri vi l eges.

To Establish Trust Between MicroStrategy Web or Mobile and

Intelligence Server

1. Open Mi croStrategy Web Admi ni strator or Mi croStrategy Mobi l e

Admi ni strator, as appl i cabl e:

314 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l From the Wi ndow s Start menu, poi nt to A ll Programs, then

MicroStrategy Tools, and then sel ect Web A dministrator.

l From the Wi ndow s Start menu, poi nt to A ll Programs, then

MicroStrategy Tools, and then sel ect Mobile A dministrator.

2. On the l eft, cl i ck Servers.

3. C onfi rm that Mi croStrategy Web or Mobi l e Server i s currentl y

connected to an Intel l i gence Server. If an Intel l i gence Server i s
not connected, i n the U nconnected Servers tabl e, under
A ction, cl i ck C onnect for the appropri ate Intel l i gence Server.

4. In the C onnected Servers tabl e, under Properties, cl i ck the

Modify i con .

5. N ext to Trust relationship between Web/Mobi l e Server and

MicroStrategy Intelligence Server, as appl i cabl e, cl i ck Setup.

6. Type a U ser name and Password i n the appropri ate fi el ds. The
user must have admi ni strati ve pri vi l eges for Mi croStrategy Web
or Mobi l e, as appl i cabl e.

7. From the opti ons provi ded, sel ect the authenti cati on mode used
to authenti cate the admi ni strati ve user.

© 2019, M icr o St r at egy In c. 315

Syst em Ad m in ist r at io n Gu id e

8. In the Web Server A pplication or Mobile Server A pplication

fi el d, type a uni que name for the trust rel ati onshi p.

For exampl e, you can use the U R Ls for the appl i cati ons usi ng
Ti vol i , as fol l ow s:

Mi croStrategy Web:
ht tp s: / /
Ma ch in e N a m e/J u n c t i o n N a m e/ M i c r oS t r a t e g y / a s p

Mi croStrategy Mobi l e:
ht tp s: / /
Ma ch in e N a m e
/J un ct i o n N a m e/ M i c r o S t r a t e g y M o b i l e / a s p

9. C l i ck C reate Trust R elationship.

10. C l i ck Save.

To Ver i f y t he Tr ust Rel at i onshi p

1. From the Wi ndow s Start menu, poi nt to A ll Programs, then

MicroStrategy Products, and then sel ect D eveloper.

2. Log i n to a proj ect source as a user w i th admi ni strati ve

pri vi l eges.

3. From the A dministration menu, poi nt to Server, and then sel ect
C onfigure MicroStrategy Intelligence Server.

4. On the l eft, expand the Web Single Sign-on category, and veri fy
that the trusted rel ati onshi p i s l i sted i n the Trusted Web
A pplication R egistration l i st.

5. C l i ck OK .

316 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To Delete a Trust Relationship

1. Open Mi croStrategy Web Admi ni strator or Mi croStrategy Mobi l e

Admi ni strator, as appl i cabl e:

l From the Wi ndow s Start menu, poi nt to A ll Programs, then

MicroStrategy Tools, and then sel ect Web A dministrator.

l From the Wi ndow s Start menu, poi nt to A ll Programs, then

MicroStrategy Tools, and then sel ect Mobile A dministrator.

2. On the l eft, cl i ck Servers.

3. C onfi rm that Mi croStrategy Mobi l e i s currentl y connected to an

Intel l i gence Server. If an Intel l i gence Server i s not connected, i n
the U nconnected Servers tabl e, under A ction, cl i ck C onnect
for the appropri ate Intel l i gence Server.

4. In the C onnected Servers tabl e, under Properties, cl i ck the

Modify i con .

5. N ext to Trust relationship between MicroStrategy Web/Mobi l e

Server and MicroStrategy Intelligence Server, as appl i cabl e,
cl i ck D elete.

6. Provi de your l ogi n i nformati on i n the appropri ate fi el ds.

© 2019, M icr o St r at egy In c. 317

Syst em Ad m in ist r at io n Gu id e

7. C l i ck D elete trust relationship.

8. C l i ck Save.

Establishing Trust Between MicroStrategy Web Services and

Intelligence Server, to Support MicroStrategy Office

To establ i sh trust betw een Mi croStrategy Offi ce and Intel l i gence

Server, you must use Mi croStrategy Offi ce to connect to the proj ect
source you w ant to use trusted authenti cati on for, and then establ i sh
the trust rel ati onshi p betw een Offi ce and the Intel l i gence Server.
Once you have compl eted thi s step, you must edi t the
proj ec ts ou r c e s . x m l fi l e for Web Servi ces to enabl e trusted
authenti cati on for the proj ect source. Both procedures are descri bed
bel ow .

318 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To Establish Trust Between MicroStrategy Web Services and

Intelligence Server

1. On a machi ne w here Mi croStrategy Offi ce i s i nstal l ed, open a

Mi crosoft Offi ce product, such as Excel .

2. In the Mi crosoft Offi ce ri bbon, under the Mi croStrategy Offi ce tab,

cl i ck MicroStrategy Office. Mi croStrategy Offi ce starts, w i th a
l i st of proj ect sources you can connect to.

3. From the l i st of proj ect sources on the l eft, sel ect the proj ect
source you w ant to enabl e trusted authenti cati on for.

4. In the ri ght pane, enter the l ogi n ID and passw ord for a user w i th
admi ni strati ve pri vi l eges, and cl i ck Get Projects. A l i st of
proj ects i s di spl ayed.

5. Sel ect any proj ect, and cl i ck OK .

6. In the Mi croStrategy Offi ce tool bar, cl i ck Options.

7. U nder the General category, sel ect Server.

8. N ext to Trust relationship between Web Services and

Intelligence Server, cl i ck C reate.

To U se t he Thi r d -Par t y Aut hent i cat i on U RL f or Web Ser vi ces

1. In the Web Services U R L fi el d, enter the U R L for the Ti vol i

Juncti on or Si teMi nder Web Agent, as appl i cabl e, that you
created for Mi croStrategy Web Servi ces.

2. C l i ck OK .

© 2019, M icr o St r at egy In c. 319

Syst em Ad m in ist r at io n Gu id e

Enabling Trusted Authentication in MicroStrategy Web Services to

Support MicroStrategy Office

To al l ow users to l og i n to Mi croStrategy Offi ce usi ng si ngl e si gn-on

(SSO), you must do the fol l ow i ng:

l Edi t the w eb . c o n f i g fi l e for Web Servi ces or

MW SC on fi g . p r o p e r t i e s fi l e for J2EE appl i cati on servers, to
choose a trusted authenti cati on provi der.

l Edi t the p ro j e c t s o u r c e s . x m l fi l e for Mi croStrategy Web

Servi ces and confi gure the proj ect source to use a thi rd-party
securi ty pl ug-i n. For addi ti onal i nformati on on the setti ngs i n the
pr oj ec ts o u r c e s . x m l fi l e, refer to the Instal l i ng and
Admi ni steri ng Mi croStrategy Offi ce secti on i n the Mi croStrategy for
Offi ce Onl i ne H el p.

You need adminis trativ e ac c es s to the mac hine where Mic roStrategy Web
Serv ic es is ins talled.

To Enable Trusted Authentication in MicroStrategy Office

To Choose a Tr ust ed Aut hent i cat i on Pr ovi d er

1. D ependi ng on your Web Servi ces envi ronment, on the machi ne

w here Mi croStrategy Web Servi ces i s i nstal l ed, do one of the
fol l ow i ng:

l If you are usi ng IIS as your appl i cati on server, open the
we b. co n f i g fi l e i n a text edi tor, such as N otepad. By defaul t,
the fi l e i s l ocated i n C : \ P r o g r a m F il e s
(x 86 )\ M i c r o S t r a t e g y \ W e b S e r vi c e s.

l If you are usi ng Web Servi ces i n a J2EE-compl i ant appl i cati on
server, open the M W S C o n f i g . p r o p e r t i e s fi l e i n a text

320 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

edi tor, such as N otepad. By defaul t, the fi l e i s l ocated i n the

fol der w here your appl i cati on server depl oys Web Servi ces.

2. D ependi ng on your Web Servi ces envi ronment, do the fol l ow i ng:

3. In the we b . c o n f i g fi l e, l ocate the fol l ow i ng l i ne:

<a d d k e y = " T R U S T E D A U T H P R O V I D E R " v a l u e = " 1 " / >

4. In the MW S C o n f i g .p r o p e r t i e s fi l e, l ocate the fol l ow i ng l i ne:

TRUSTEDAUTHPROVIDER=1

5. C hange v a l u e or T R U S T E D A U T H P R O V I D E R, as appl i cabl e, to

one of the fol l ow i ng, as appl i cabl e:

l To use Ti vol i as the authenti cati on provi der, type 1.

l To use Si teMi nder as the authenti cati on provi der, type 2 .

l To use a custom authenti cati on provi der, type 3.

If y ou are us ing a c us tom authentic ation prov ider, y ou mus t mak e

additional modific ations to the c u s t o m _s e c u r i t y . p r o p e r t i e s
file, whic h is loc ated by default in C : \ P r o g r a m F i l e s
(x 86 )\ M i c r o S t r at e g y \ W e b S e r v i ce s \ r e s o u r c e s . For
information on thes e modific ations , refer to the Mi croStrategy
D evel oper Li brary (MSD L) .

To Conf i gur e Web Ser vi ces t o U se Tr ust ed Aut hent i cat i on

1. On the machi ne w here Mi croStrategy Web Servi ces i s i nstal l ed,

open the p r o j e c t so u r c e s . x m l fi l e i n a text edi tor, such as
N otepad. By defaul t, the fi l e i s l ocated i n C : \ P r o g r a m F i l e s
(x 86 )\ M i c r o S t r a t e g y \ W e b S e r v i ce s.

2. In the pr o j e c t s o ur c e s . x m l fi l e, l ocate the

<P ro je c t S o u r c e > tag descri bi ng the proj ect source you w ant
to enabl e SSO for.

© 2019, M icr o St r at egy In c. 321

Syst em Ad m in ist r at io n Gu id e

3. In the <P r o j e c t S ou r c e > tag, repl ace the content of the

<A ut hM o d e > tag w i th M W S S i m p l e S e c u r i t y P l u g i n. The
contents of the new < P r o j e c t S o u r c e > tag shoul d appear
si mi l ar to the fol l ow i ng:
<P ro j e c t S o u r c e >
<P ro j e c t S o u r c e N a m e > N a m e < / P r o j e c t S o u r c e N a m e >
<S er v e r N a m e > N a m e < / S e r v e r N a m e >
<A ut h M o d e > M W S S i m p l e S e c u r i t y P l u g I n < / A u t h M o d e >
<P or t N u m b e r > 0 < / P o r t N u m b e r >
</ Pr o j e c t S o u r c e >

4. Save pr o j e c t s o u r c e s . x m l.

Enabling Anonymous Authentication for Internet Information Services

If you use Internet Informati on Servi ces (IIS) as your w eb server, you
must enabl e anonymous authenti cati on to the Mi croStrategy vi rtual
di rectory to support SSO authenti cati on to Mi croStrategy Web, Web
Servi ces or Mobi l e.

The steps to perform thi s confi gurati on are provi ded bel ow , w hi ch
may vary dependi ng on your versi on of IIS. C l i ck here to fi nd more
i nformati on about usi ng anonymous authenti cati on w i th IIS.

l IIS 7

l IIS 8

l IIS 10

You c annot us e Windows authentic ation to authentic ate us ers in

Mic roStrategy Web or Mobile if y ou enable anony mous authentic ation to
the Mic roStrategy v irtual direc tory in IIS. The s teps below s hould only
be us ed as part of an SSO authentic ation s olution with Tiv oli.

322 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To Configure IIS to Enable Anonymous Authentication to the

MicroStrategy Web, Web Services, and Mobile Virtual Directories

1. On the Mi croStrategy Web server machi ne, access the IIS

Internet Servi ce Manager.

2. Brow se to and ri ght-cl i ck the MicroStrategy vi rtual fol der and

sel ect Properties.

3. On the D irectory Security tab, under A nonymous access and

authentication control, cl i ck Edit.

4. Sel ect the A llow anonymous access check box.

5. C l i ck OK .

6. C l i ck OK .

7. To enabl e anonymous authenti cati on to Mi croStrategy Web

Servi ces, repeat the above procedure for the MicroStrategyWS
vi rtual di rectory.

8. To enabl e anonymous authenti cati on to Mi croStrategy Mobi l e,

repeat the above procedure for the MicroStrategyMobile vi rtual
di rectory on the Mobi l e Server machi ne.

9. R estart IIS for the changes to take effect.

Imp o r t in g an d Lin kin g Th ir d -Par t y Au t h en t icat io n User s in

Micr o St r at egy
For thi rd-party authenti cati on users to access Mi croStrategy
appl i cati ons, the users must be granted Mi croStrategy pri vi l eges.
Whether the LD AP D N i s sent i n the request to Intel l i gence Server i s
confi gured w hen the Ti vol i j uncti on or Si teMi nder Web Agent i s
created. For detai l s about creati ng a j uncti on or Web Agent, refer to
your Ti vol i or Si teMi nder documentati on.

© 2019, M icr o St r at egy In c. 323

Syst em Ad m in ist r at io n Gu id e

A Ti vol i or Si teMi nder user can be:

l Imported as a new Mi croStrategy user upon l oggi ng i n to

Mi croStrategy Web, w hi ch assi gns the user pri vi l eges that are
defi ned for the Mi croStrategy user. For steps to perform thi s
confi gurati on, see Importi ng Ti vol i U sers as Mi croStrategy U sers,
page 324.

l Al l ow ed guest access to Mi croStrategy Web. The Ti vol i user

i nheri ts the pri vi l eges of the Publ i c/Guest group i n Mi croStrategy.
Guest access to Mi croStrategy Web i s not necessary for i mported or
l i nked Ti vol i users. For steps to perform thi s confi gurati on, see
Enabl i ng Guest Access to Mi croStrategy Web or Mobi l e for Ti vol i
U sers, page 326.

A Ti vol i or Si teMi nder user can al so be associ ated w i th an exi sti ng

Mi croStrategy user, usi ng the Mi croStrategy U ser Edi tor. Associ ati ng
Ti vol i users rather than enabl i ng Ti vol i users to be i mported w hen
they l og i n to Mi croStrategy Web enabl es you to assi gn Mi croStrategy
pri vi l eges and other securi ty setti ngs for the user pri or to thei r i ni ti al
l ogi n. For steps to perform thi s confi gurati on, see Li nki ng Ti vol i U sers
to Exi sti ng Mi croStrategy U sers, page 325.

If a Ti vol i or Si teMi nder user has al ready been i mported i nto

Mi croStrategy, and a Mi croStrategy user has been associ ated w i th the
Ti vol i or Si teMi nder user, the Mi croStrategy metadata i s synchroni zed
w i th the i nformati on from the user di rectory, such as the LD AP server.
The w ay thi s synchroni zati on takes pl ace depends upon several
factors.

Importing Tivoli Users as MicroStrategy Users

When Mi croStrategy i s confi gured to i mport a Ti vol i user, the Ti vol i

user i s i mported as a Mi croStrategy user the fi rst ti me that the user
l ogs i n to Mi croStrategy Web after the confi gurati on i s compl eted. A

324 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Ti vol i user i s i mported i nto Mi croStrategy onl y i f the Ti vol i user has
not al ready been i mported as or associ ated w i th a Mi croStrategy user.

When a Ti vol i user i s i mported i nto Mi croStrategy:

l The Ti vol i user name i s i mported as the trusted authenti cati on

request user ID for the new Mi croStrategy user.

l The Mi croStrategy user i s added to the Everyone group by defaul t.

If no pri vi l eges are defi ned through a user di rectory such as LD AP,
then the i mported user i nheri ts the pri vi l eges associ ated w i th the
Mi croStrategy Everyone group.

l Securi ty pri vi l eges are not i mported from Ti vol i ; these must be
defi ned i n Mi croStrategy by an admi ni strator.

To iImport Tivoli Users as MicroStrategy Users

1. From the Wi ndow s Start menu, poi nt to A ll Programs, then

MicroStrategy Products, and then sel ect D eveloper.

2. Log i n to a proj ect source as a user w i th admi ni strati ve

pri vi l eges.

3. From the A dministration menu, poi nt to Server, and then

C onfigure MicroStrategy Intelligence Server.

4. On the l eft, expand the Web Single Sign-on category.

5. On the ri ght, sel ect the Import user at login check box.

6. C l i ck OK .

Linking Tivoli Users to Existing MicroStrategy Users

As an al ternati ve to i mporti ng users, you can l i nk (or associ ate) Ti vol i

users to exi sti ng Mi croStrategy users to retai n the exi sti ng pri vi l eges
and confi gurati ons defi ned for the Mi croStrategy users. Li nki ng Ti vol i
users rather than enabl i ng Ti vol i users to be i mported w hen they l og

© 2019, M icr o St r at egy In c. 325

Syst em Ad m in ist r at io n Gu id e

i n to Mi croStrategy Web enabl es you to assi gn pri vi l eges and other

securi ty setti ngs for the user pri or to thei r i ni ti al l ogi n.

To Link Tivoli Users to Existing MicroStrategy Users

1. From the Wi ndow s Start menu, poi nt to A ll Programs, then

MicroStrategy Products, and then sel ect D eveloper.

2. Log i n to a proj ect source as a user w i th admi ni strati ve

pri vi l eges.

3. In the fol der l i st on the l eft, expand A dministration, and then

expand U ser Manager.

4. Brow se to the Mi croStrategy user to l i nk to a Ti vol i user.

5. R i ght cl i ck the user and sel ect Edit.

6. Expand A uthentication, then sel ect Metadata.

7. U nder Trusted A uthentication R equest, i n the U ser ID fi el d,

type the Ti vol i user name to l i nk to the Mi croStrategy user.

The name y ou ty pe in the U ser ID field s hould be the s ame as the

one that the us er employ s when prov iding their Tiv oli login
c redentials .

8. C l i ck OK .

Enabling Guest Access to MicroStrategy Web or Mobile for Tivoli Users

If you choose to not i mport or l i nk Ti vol i users to a Mi croStrategy

user, you can enabl e guest access to Mi croStrategy Web for the Ti vol i
users. Guest users i nheri t thei r pri vi l eges from the Mi croStrategy
Publ i c/Guest group.

326 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Lo ggin g in t o Micr o St r at egy Web Usin g Tivo li Sin gle Sign -On
Once al l of the prel i mi nary steps have been compl eted and tested,
users may begi n to si gn i n to Mi croStrategy usi ng thei r Ti vol i
credenti al s. Si gn-on steps are provi ded i n the procedure bel ow .

To Log in to MicroStrategy Web Using Tivoli Single Sign-On

1. Open a w eb brow ser.

2. Type the fol l ow i ng U R L i n the address fi el d:

ht tp s: / /
Ma ch in e N a m e/J u n c t i o n N a m e/M i c r o S t r a t e g y W e b U R L

Where the vari abl es i n i tal i cs are as fol l ow s:

l Ma ch in e N a m e i s the name of the machi ne runni ng Ti vol i .

l Ju nc ti o n N a m e i s the name of the j uncti on created i n Ti vol i .

l Mi cr oS t r a t e g y W e b U R L i s the U R L to access Mi croStrategy

Web. For exampl e, M i c r o S t r a t e g y / a s p.

3. Type your Ti vol i user name and passw ord.

4. C onnect to a Mi croStrategy proj ect.

5. C l i ck Trusted A uthentication.

You are l ogged i n to the Mi croStrategy proj ect w i th your Ti vol i

user credenti al s.

If you are prompted to di spl ay both secure and non-secure i tems

on the w eb page, you can confi gure your w eb brow ser to hi de
thi s w arni ng message. R efer to your w eb brow ser documentati on
regardi ng thi s confi gurati on.

© 2019, M icr o St r at egy In c. 327

Syst em Ad m in ist r at io n Gu id e

Enabling Badge Authentication for Web and

Mobile
If you use an LD AP di rectory to central l y manage users i n your
envi ronment, you can add them to your Identi ty netw ork, and al l ow
them to l og i nto Mi croStrategy Web or Mobi l e by usi ng thei r badges
from Mi croStrategy Badge.

The users i n your LD AP di rectory can l og i nto Mi croStrategy Web by:

l Scanni ng a QR code usi ng the Badge app on thei r smart phones, i f

Badge i s confi gured as the pri mary authenti cati on method.

l Suppl ementi ng thei r user name and passw ord w i th a numeri cal
Badge C ode that i s provi ded vi a the Badge app on thei r smart
phones, i f Badge i s confi gured as the second factor of
authenti cati on.

The hi gh-l evel steps to enabl e Badge authenti cati on for Web and
Mobi l e are as fol l ow s:

1. Set up an Identi ty netw ork. Your netw ork i s the group of users i n
your organi zati on w ho can use the Badge app on thei r smart
phone to val i date thei r i denti ty to l og i nto Mi croStrategy. For
steps, see the Identi ty H el p.

2. Add your LD AP di rectory to your Identi ty netw ork. For steps to

add your LD AP di rectory to Identi ty, see the Identi ty H el p.

3. If you are i mporti ng users from LD AP, connect LD AP by

l everagi ng the connecti on betw een LD AP and your Mi croStrategy
Identi ty Server. Al ternati vel y, you can manual l y connect your
LD AP di rectory to Mi croStrategy. Otherw i se, i mport your
Mi croStrategy user data i nto the Identi ty netw ork. For more
i nformati on, see the Identi ty H el p.

328 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

4. R egi ster your Mi croStrategy envi ronment w i th Badge.

5. C onfi gure Badge i n Mi croStrategy Web and Mobi l e.

Registering your MicroStrategy Products with Badge

To establ i sh a connecti on betw een Badge and your Mi croStrategy
products, fol l ow the steps bel ow .

You hav e c reated an Identity network and badges for y our us ers . Your
network is the group of us ers in y our organiz ation who c an us e the Badge
app on their s mart phone to v alidate their identity to log into Mic roStrategy .
For s teps to c reate an Identity network , s ee the Identi ty H el p .

You hav e c onnec ted an LDAP us er direc tory to Mic roStrategy . For s teps to
c onnec t y our LDAP direc tory to Mic roStrategy , s ee Impl ementi ng LD AP
Authenti cati on, page 171 .

To Register MicroStrategy with Badge

1. In a w eb brow ser, l og i nto Mi croStrategy Identi ty Manager.

2. C l i ck Logical Gateways.

3. In the Mi croStrategy Pl atform Logi n area, cl i ck the

MicroStrategy i con and cl i ck C ontinue.

4. To change the i mage that i s di spl ayed on the l ogi n page w hen
users open Mi croStrategy Web, cl i ck Import an Icon. Sel ect an
i mage to di spl ay and cl i ck Open.

5. In the Enter D isplay N ame fi el d, enter a name to di spl ay on your

Mi croStrategy l ogi n page.

6. C l i ck N ext. The Set U p Your Mi croStrategy Pl atform page i s

show n, w i th the detai l s to confi gure your Mi croStrategy
Intel l i gence Server.

© 2019, M icr o St r at egy In c. 329

Syst em Ad m in ist r at io n Gu id e

7. N ote the val ues for Organization ID , A pplication ID , and Token.

You use these val ues to confi gure Mi croStrategy Intel l i gence
Server.

8. C l i ck D one.

Configuring Badge in MicroStrategy Web and Mobile

To al l ow your users to l og i nto Mi croStrategy Web and Mobi l e w i th
Mi croStrategy Badge, you must confi gure Badge as a trusted
authenti cati on provi der i n Web Admi ni strator and Mobi l e
Admi ni strator, as descri bed i n the steps bel ow .

You hav e regis tered y our Mic roStrategy produc ts with Badge, as des c ribed
in R egi steri ng your Mi croStrategy Products w i th Badge, page 329 ,
and noted the Organiz ation ID, Applic ation ID, and Tok en prov ided.

You hav e upgraded y our Mic roStrategy metadata. For s teps to upgrade
y our Mic roStrategy metadata, s ee the U pgrade Gui de .

Enabling Badge authentic ation without upgrading y our metadata may

c aus e y our us ers to be loc k ed out of Mic roStrategy applic ations .

If y ou are enabling two-fac tor authentic ation for Web us ing Badge, y ou hav e
added at leas t one us er to the Two-fac tor Ex empt (2FAX) us er group in y our
Mic roStrategy projec t. Mic roStrategy us ers who are members of the Two-
fac tor Ex empt (2FAX) group are ex empt from two-fac tor authentic ation, and
do not need to prov ide an Badge Code to log into Mic roStrategy Web. It is
rec ommended that thes e us ers hav e a s ec ure pas s word for their ac c ounts
and us e their ac c ounts for troubles hooting Mic roStrategy Web.

Ens ure that y ou c onfigure y our LDAP s erv er information c orrec tly in
y our Intelligenc e Serv er. If it is not c onfigured c orrec tly , two-fac tor
authentic ation c annot be us ed and therefore us ers will not be able to
log into the s erv er.

330 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Enabling Badge Authentication in Web and Mobile

To Configure Intelligence Server for Badge Authentication

1. From the Wi ndow s Start menu, sel ect A ll Programs >

MicroStrategy Tools > Web A dministrator.

2. For your Intel l i gence Server, cl i ck Modify.

3. C l i ck Setup.

4. In the C onnecti vi ty secti on, i n the MicroStrategy Identity Server

U R L fi el d, enter the Mi croStrategy Identi ty Server U R L and port
number for 1-w ay SSL.

5. In the OrgID fi el d, enter the Organization ID from Mi croStrategy

Identi ty Manager.

6. In the A ppID fi el d, enter the A pplication ID from Mi croStrategy

Identi ty Manager.

7. If you w ant to use Badge as a tw o-factor authenti cati on system,

sel ect the Enable two-factor authentication checkbox. The
Securi ty token fi el d i s enabl ed.

Mic roStrategy us ers who are members of the Two-fac tor Ex empt
(2FAX) group are ex empt from two-fac tor authentic ation, and do
not need to prov ide an Badge Code to log into Mic roStrategy Web.
It is rec ommended that thes e us ers hav e a s ec ure pas s word for
their ac c ounts , and us e their ac c ounts for troubles hooting
Mic roStrategy Web.

8. In the Security token fi el d, enter the Security Token from

Mi croStrategy Identi ty Manager.

9. To use the connecti on betw een your Mi croStrategy Identi ty

Server and LD AP, check the box l abel ed Import B adge U ser. By

© 2019, M icr o St r at egy In c. 331

Syst em Ad m in ist r at io n Gu id e

enabl i ng the i mport process, the Badge users synchroni zed from
LD AP are added w i thout havi ng to manual l y add them.

10. C l i ck Save.

To Enable Badge Authentication in Web and Mobile

1. In Web Admi ni strator, cl i ck D efault Properties.

2. In the Logi n area, for Trusted A uthentication R equest, sel ect

the Enabled checkbox.

3. From the Trusted A uthentication Providers drop-dow n menu,

sel ect B adge.

4. C l i ck Save.

5. In Mobi l e Admi ni strator, cl i ck Mobile C onfiguration.

6. For the confi gurati on name w here you w ant to enabl e Badge
authenti cati on, cl i ck the Modify i con i n the A ctions col umn.

7. C l i ck on the C onnectivity Settings tab.

8. In the D efault Project A uthentication area, open the drop-dow n

menu for the A uthentication mode setti ng and sel ect B adge.

9. C l i ck Save.

10. R eturn to the Mobile C onfiguration page and repeat the modi fy
steps for each other confi gurati on name w here you w ant to
enabl e Badge authenti cati on.

How to Enable Seamless Login Between Web,

Library, and Workstation
Enabl i ng seaml ess l ogi n al l ow s you to navi gate betw een
Mi croStrategy Web, Li brary, and Workstati on w i thout havi ng to re-

332 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

authenti cate regardl ess of your confi gured authenti cati on mode. It
uses an encrypted (secret) key to securel y share the sessi on among
the appl i cati ons.

For new i nstal l ati ons of Mi croStrategy 2019 seaml ess l ogi n w i l l be
confi gured and acti ve i f the prerequi si te components are i nstal l ed on
the same machi ne. D i stri buted envi ronments and customers
upgradi ng to versi on 2019 need to confi gure the secret key by
fol l ow i ng the steps bel ow .

Important Considerations
The fol l ow i ng are some poi nts to keep i n mi nd w hi l e confi guri ng
seaml ess l ogi n betw een Web, Li brary, and Workstati on.

l For Web and Li brary confi gurati on, use the same Intel l i gence
Server.

l Once you confi gure seaml ess l ogi n betw een Web and Li brary, i t w i l l
al so w ork i n Workstati on.

l For col l aborati on to w ork properl y, use the same secret key i n
co nf ig .j s o n .

Cloud Environments

To Co n f igu r e Web an d Lib r ar y Ap p licat io n s f o r Seamless

Lo gin
1. Launch Mi croStrategy Web.

2. Go to Preferences.

3. U nder Project D efaults > MicroStrategy Library

configuration, enter your Li brary U R L.

© 2019, M icr o St r at egy In c. 333

Syst em Ad m in ist r at io n Gu id e

<F QD N > : < p o r t > / M i c r o S t r a t e g y L i b r a r y /

4. C l i ck A pply.

5. In your cl oud envi ronment's homepage, hover over

Mi croStrategy Web and cl i ck C onfigure.

6. C l i ck Security.

7. Enter a new secret key i nto MicroStrategy Library

configuration. A secret key shoul d be betw een 5 and 30
characters l ong.

Keep the key for l ater.

8. C l i ck Save.

9. In your cl oud envi ronment's homepage, hover over Li brary,

and cl i ck C onfigure.

10. In the Li brary Server tab, i n the MicroStrategy Web > Link
fi el d, enter the Mi croStrategy Web l i nk.

11. In the Security Settings > Secret K ey fi el d enter the secret

key from step 7.

12. C l i ck Save.

On-Premises Environments

To Co n f igu r e t h e Secr et Key Bet ween Web an d Lib r ar y

If the secret key i s not avai l abl e i n the
co nf ig Ov e r r i d e . p r o p e r t i e s fi l e, you can add any phrase or
passcode to the parameter to be used as the secret key. A secret
key shoul d be betw een 5 and 30 characters l ong.

334 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

1. Open the Li brary c o n f i g O v e r r i d e . p r o p e r t i e s w i th a

text edi tor.

2. C opy the token val ue from the

id en ti t y T o k e n . s e c r e t K e y parameter.

3. Open the Web Admi ni strati on Page (

<F QD N> : < p o r t > / M i c r o S t r a t e g y / s e r v l e t / m s t r W e b Ad
mi n ).

4. Sel ect Security from the l eft-si de navi gati on.

5. U nder Mi croStrategy Li brary confi gurati on, enter your secret

key.

6. C l i ck Save.

7. R estart your Mi croStrategy Web server to appl y the changes.

To Co n f igu r e Web an d Lib r ar y Ap p licat io n s f o r Seamless

Lo gin
1. In Mi croStrategy Web open Preferences > Project D efaults.

2. Enter your Mi croStrategy Li brary U R L

(< FQ DN > : < p o r t > / M i c r o S t r a t e g y L i b r a r y) i n the Link
to MicroStrategy Library fi el d.

3. Open the Li brary Admi ni strati on C ontrol Panel

(< FQ DN > : < p o r t > / M i c r o S t r a t e g y L i b r a r y / a d m i n).

4. Open the Li brary Server tab.

5. Enter your Mi croStrategy Web U R L i nto the Link fi el d under

Mi croStrategy Web
(< FQ DN > : < p o r t > / M i c r o S t r a t e g y / s e r v l e t / m s t r W e b).

6. C l i ck Save.

© 2019, M icr o St r at egy In c. 335

Syst em Ad m in ist r at io n Gu id e

Implementing Database Warehouse

Authentication
Thi s mode of authenti cati on i denti fi es users by means of a l ogi n ID
and passw ord stored i n the data w arehouse database. The R D BMS i s
the authenti cati on authori ty and veri fi es that the l ogi n ID and
passw ord are val i d. Each report i s executed on the R D BMS under the
R D BMS account of the user w ho submi tted the report from the
Mi croStrategy system. U sers l og i n to the Mi croStrategy system w i th
thei r R D BMS l ogi n and passw ord, and each Mi croStrategy user i s
l i nked to an R D BMS account.

U se database w arehouse authenti cati on i f you w ant the data

w arehouse R D BMS to be the authori ty for i denti fyi ng users and you
do not w ant to mai ntai n user credenti al s i n Intel l i gence Server as w el l
as the R D BMS. You can al so use thi s confi gurati on i f you need to
keep an audi t trai l at the R D BMS l evel for each query executed by
each i ndi vi dual user.

If y ou us e databas e authentic ation, for s ec urity reas ons Mic roStrategy

rec ommends that y ou us e the s etting C reate caches per database
login . This ens ures that us ers who ex ec ute their reports us ing different
databas e login IDs c annot us e the s ame c ac he. You c an s et this in the
Projec t Configuration Editor in the C aching : R esult C aches :
C reation c ategory .

Database Warehouse Authentication Information Flow

The fol l ow i ng scenari o presents an overvi ew of the general fl ow of
i nformati on betw een Intel l i gence Server and a database server w hen
a database user l ogs i nto D evel oper or Mi croStrategy Web.

336 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

1. The user anonymousl y l ogs i n to a proj ect source.

Thi s i s done anonymousl y because the user has not yet l ogged
i n to a speci fi c proj ect. Because a w arehouse database i s not
associ ated w i th the proj ect source i tsel f, users are not
authenti cated unti l they sel ect a proj ect to use. For more
i nformati on about anonymous authenti cati on, i ncl udi ng
i nstructi ons on enabl i ng i t for a proj ect source, see Impl ementi ng
Anonymous Authenti cati on, page 169.

l By default, the Public /Gues t group is denied ac c es s to all

projec ts . A s ec urity role with View ac c es s to the projec ts mus t
be ex plic itly as s igned to the Public /Gues t group, s o that thes e
us ers c an s ee and log in to the av ailable projec ts .

l All us ers logging in to a databas e warehous e authentic ation

projec t s ourc e c an s ee all projec ts v is ible to the Gues t us er.
Projec t ac c es s is then granted or denied for eac h indiv idual us er
when the us er attempts to log into the projec t.

2. The user sel ects a proj ect, and then l ogs i n to that proj ect usi ng
thei r data w arehouse l ogi n ID and passw ord. They are
authenti cated agai nst the data w arehouse database associ ated
w i th that proj ect.

To enabl e database authenti cati on, you must l i nk the users i n

the Mi croStrategy metadata to R D BMS users. Li nki ng causes
Intel l i gence Server to map a w arehouse database user to a
Mi croStrategy user. If a user attempts to l og i n to a proj ect
w i thout havi ng been l i nked to a Mi croStrategy user, a "U ser not
found" error message i s returned.

Steps to Implement Database Warehouse

Authentication
The procedure bel ow gi ves the hi gh-l evel steps for confi guri ng your
Intel l i gence Server for database w arehouse authenti cati on.

© 2019, M icr o St r at egy In c. 337

Syst em Ad m in ist r at io n Gu id e

High-Level Steps for Configuring Database Warehouse

Authentication

1. C reate a D SN and a database i nstance for the authenti cati on

database.

2. C onfi gure the proj ect source to al l ow anonymous authenti cati on

(see Impl ementi ng Standard Authenti cati on, page 165).

3. C onfi gure the proj ect source to use database w arehouse

authenti cati on (see C onfi guri ng the Authenti cati on Mode for a
Proj ect Source, page 163).

4. Assi gn a securi ty rol e to the Publ i c/Guest group for each proj ect
to w hi ch you w ant to provi de access (see D efi ni ng Sets of
Pri vi l eges: Securi ty R ol es, page 113).

5. Li nk each Mi croStrategy user to an R D BMS user. In the U ser

Edi tor, i n the A uthentication: Metadata category, type the data
w arehouse l ogi n ID i n the D atabase Login fi el d.

You c an c reate the Mic roStrategy us ers by importing a lis t of the

RDBMS us ers into the Mic roStrategy s y s tem. For ins truc tions ,
s ee C reati ng, Importi ng, and D el eti ng U sers and Groups,
page 92 .

6. For each proj ect, i n the Proj ect C onfi gurati on Edi tor, i n the
D atabase instances: A uthentication: Metadata category,
speci fy the database i nstance for the authenti cati on database.

7. For each proj ect, enabl e database executi on usi ng l i nked

w arehouse l ogi ns (see Li nki ng D atabase U sers and
Mi croStrategy U sers: Passthrough Executi on, page 127).

338 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

8. To enabl e database authenti cati on i n Mi croStrategy Web, l og i n

as an admi ni strator. On the Preferences page, sel ect Project
D efaults. The Proj ect D efaul ts page i s di spl ayed.

9. U nder Securi ty, sel ect the D atabase A uthentication check box,
and then cl i ck A pply.

Database Warehouse and Metadata (6.x) Authentication

Thi s mode of authenti cati on uses the l ogi n ID and passw ord entered
by the user for both the metadata and data w arehouse databases. It i s
avai l abl e onl y for connecti ng to Mi croStrategy 6.X proj ect sources.

U nder thi s authenti cati on mode, Intel l i gence Server passes the l ogi n
credenti al s to the metadata database w hen you l og i n to the proj ect
source. You i mpl ement thi s authenti cati on mode by fol l ow i ng the
same general steps as for database w arehouse authenti cati on, i n
Steps to Impl ement D atabase Warehouse Authenti cati on, page 337.

Authentication Examples
Bel ow are a few exampl es of how the di fferent methods for user
authenti cati on can be combi ned w i th di fferent methods for database
authenti cati on to achi eve the securi ty requi rements of your
Mi croStrategy system. These exampl es i l l ustrate a few possi bi l i ti es;
other combi nati ons are possi bl e.

Security Views: Windows Authentication and Linked

Warehouse Login
You may w ant to use thi s confi gurati on i f you are usi ng securi ty vi ew s
to i mpl ement access control pol i ci es for data. For exampl e, tw o
di fferent users executi ng the same SQL query recei ve di fferent
resul ts, refl ecti ng thei r di fferent l evel s of access. For the securi ty
vi ew s to w ork, each report i s executed under the R D BMS account of
the user w ho submi tted the report from the Mi croStrategy system.

© 2019, M icr o St r at egy In c. 339

Syst em Ad m in ist r at io n Gu id e

Even though thi s approach requi res users to have accounts on the
R D BMS, you may choose to use Wi ndow s authenti cati on so that users
do not have to remember thei r R D BMS l ogi n ID and passw ord w hen
l oggi ng i n to the Mi croStrategy system. Wi th Wi ndow s authenti cati on,
users are automati cal l y l ogged i n to the Mi croStrategy system usi ng
thei r Wi ndow s ID and passw ord.

For detai l ed i nformati on about securi ty vi ew s, see C ontrol l i ng Access

to D ata at the D atabase (R D BMS) Level , page 147.

To Establish the Configuration

1. In D evel oper, open the Proj ect Source Manager, and on the
Advanced tab, sel ect U se network login ID (Windows
authentication) as the Authenti cati on mode.

2. From Web, l og i n as an admi ni strator and sel ect Preferences,

sel ect Project D efaults, sel ect Security, and then enabl e
Windows A uthentication as the l ogi n mode.

3. In D evel oper, i n the U ser Edi tor, expand A uthentication, then

sel ect Warehouse.

4. Li nk users to thei r respecti ve database user ID s usi ng the

Warehouse passthrough Login and Warehouse passthrough
password boxes for each user. For detai l s on each opti on, cl i ck
H elp.

5. Enabl e the setti ng for database executi on to use l i nked

w arehouse l ogi ns on each proj ect that you w ant to use l i nked
w arehouse l ogi ns for database executi on. To do thi s, ri ght-cl i ck
the proj ect and sel ect Project C onfiguration, expand the
D atabase instances category, cl i ck Execution, and sel ect the
U se linked warehouse login for execution check box.

340 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Connection Maps: Standard Authentication, Connection

Maps, and Partitioned Fact Tables
You may w ant to use thi s confi gurati on i f you i mpl ement access
control pol i ci es i n the R D BMS so that you can have mul ti pl e user
accounts i n the R D BMS, but not necessari l y one for every user. In
addi ti on, you must use connecti on maps to enabl e report
subscri pti ons i f you are usi ng Mi crosoft Anal ysi s Servi ces w i th
i ntegrated authenti cati on.

For exampl e, you are parti ti oni ng fact tabl es by row s, as descri bed i n
C ontrol l i ng Access to D ata at the D atabase (R D BMS) Level , page
147. You have a user ID for the 1st N ati onal Bank that onl y has
access to the tabl e contai ni ng records for that bank and another user
ID for the Eastern C redi t Bank that onl y has access to i ts
correspondi ng tabl e. D ependi ng on the user ID used to l og i n to the
R D BMS, a di fferent tabl e i s used i n SQL queri es.

Al though there are onl y a smal l number of user ID s i n the R D BMS,

there are many more users w ho access the Mi croStrategy appl i cati on.
When users access the Mi croStrategy system, they l og i n usi ng thei r
Mi croStrategy user names and passw ords. U si ng connecti on maps,
Intel l i gence Server uses di fferent database accounts to execute
queri es, dependi ng on the user w ho submi tted the report.

To Establish this Configuration

1. In D evel oper, open the Proj ect Source Manager and cl i ck

Modify.

2. On the Advanced tab, sel ect U se login ID and password

entered by the user (standard authentication) as the
A uthentication mode. Thi s i s the defaul t setti ng.

© 2019, M icr o St r at egy In c. 341

Syst em Ad m in ist r at io n Gu id e

3. From Web, l og i n as an admi ni strator and sel ect Preferences,

sel ect Project D efaults, sel ect Security, and then enabl e
Standard (user name & password) as the l ogi n mode.

4. C reate a database l ogi n for each of the R D BMS accounts.

5. C reate a user group i n the Mi croStrategy system correspondi ng

to each of the R D BMS accounts and then assi gn mul ti pl e users
to these groups as necessary.

6. D efi ne a connecti on mappi ng that maps each user group to the

appropri ate database l ogi n.

342 © 2019, M icr o St r at egy In c.

 4
SECURE
COM M UNICATION IN
M ICRO STRATEGY

© 2019, M icr o St r at egy In c. 343

Syst em Ad m in ist r at io n Gu id e

SSL (secure socket l ayer) and TLS (transport l ayer securi ty) are
encrypti on technol ogi es that encode communi cati on over the Internet
or l ocal netw ork so that onl y the reci pi ent can read i t. Mi croStrategy
Intel l i gence Server opens tw o ports for SSL communi cati on. The
defaul t port 3 9 3 2 1 uses SSL w i thout cl i ent certi fi cate veri fi cati on.
The second port 3 9 3 2 0 provi des extra securi ty by enforci ng cl i ent
certi fi cate veri fi cati on.

Mi croStrategy admi ni strators shoul d refer to the i nformati on securi ty

pol i cy of your parti cul ar organi zati on or IT department before
choosi ng an encrypti on confi gurati on for your Mi croStrategy
envi ronment.

A c ertific ate s igning reques t (CSR) mus t be generated to obtain an SSL

c ertific ate from a third party c ertific ation authority (CA). Refer to the
requirements of y our CA for the nec es s ary s teps to generate a CSR,
y our priv ate k ey , and obtain y our SSL c ertific ate. If y ou are us ing a s elf-
s igned c ertific ate, the k ey algorithm, k ey s iz e, and s ignature algorithm
s hould be s et ac c ording to y our IT adminis trator's requirements . For
s teps to generate y our c ertific ate, s ee Sel f-Si gned C erti fi cates:
C reati ng a C erti fi cate Authori ty for devel opment .

Configuring SSL for Intelligence Server

You mus t hav e the SSL c ertific ate y ou c reated for Intelligenc e Serv er.

You mus t hav e the priv ate k ey file that y ou c reated while reques ting a
c ertific ate for Intelligenc e Serv er.

To Configure SSL for Intelligence Server

1. From the Start menu, choose A ll Programs > MicroStrategy

Tools > C onfiguration Wizard.

344 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

2. On the Wel come screen, sel ect C onfigure Intelligence Server,

and cl i ck N ext.

3. If you have previ ousl y confi gured Intel l i gence Server, cl i ck N ext
unti l you reach the SSL C onfi gurati on page. If thi s i s the fi rst
ti me you are confi guri ng Intel l i gence Server, cl i ck H elp for
i nstructi ons to confi gure Intel l i gence Server.

4. In the SSL C onfi gurati on page, enabl e the C onfigure SSL check
box.

5. C l i ck the button next to the C ertificate fi el d and brow se to the

certi fi cate you created for Intel l i gence Server.

6. C l i ck the button next to the K ey fi el d and brow se to the pri vate

key fi l e you created w hi l e requesti ng the certi fi cate for
Intel l i gence Server.

7. In the Password fi el d, type the passw ord that you used w hi l e

creati ng the pri vate key for the certi fi cate.

8. In the SSL Port fi el d, type the port number to use for SSL
access. By defaul t, the port i s 3 9 3 2 1.

Configuring Web and Mobile Server Truststore

Mi croStrategy currentl y supports three certi fi cate types for setti ng up
SSL communi cati on betw een Mi croStrategy components. The tabl e
bel ow l i sts the supported certi fi cate types the necessary acti ons to
compl ete setup.

Sig n in g Micro Strateg y Web o r Mo b ile Co n fig u ratio n

Certificat
Au th o rity Server T ru ststo re L o catio n Actio n s
e T yp e

CA S igned P ublic <JRE>/lib/security/cacert l No addit ional

© 2019, M icr o St r at egy In c. 345

Syst em Ad m in ist r at io n Gu id e

Sig n in g Micro Strateg y Web o r Mo b ile Co n fig u ratio n

Certificat
Au th o rity Server T ru ststo re L o catio n Actio n s
e T yp e

server
conf igurat ion
required.

l The def ault

Java cacert s
Trust st ore is
cert if icat io s used.
n aut horit y
l C onfiguring
P ublic such as < JRE > locat ion depends on
sec ure
V erisign or t he A pplicat ion S erver being
communicatio
Thawt e used.
n for
MicroStrategy
W eb and
Mobile Server,
D eveloper,
and client
applications

l E nt erprise root
cert if icat e must
be added t o
each client
Trust st ore.
Cont act your I T
S elf -signed A dminist rat or
CA S igned by f or a copy of
/WEB-INF/trusted.jks
E nt erprise E nt erprise your ent erprise
root CA CA cert if icat e
chain.

l C onfiguring
sec ure
communication
for

346 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Sig n in g Micro Strateg y Web o r Mo b ile Co n fig u ratio n

Certificat
Au th o rity Server T ru ststo re L o catio n Actio n s
e T yp e

MicroStrategy
W eb and
Mobile Server,
D eveloper, and
client
applications

l Cert if icat e
must be added
t o client
Trust st ore

l Trust st ore
must cont ain
cert if icat e f rom
each
S elf -signed I nt elligence
S elf -S igned by S erver
/WEB-INF/trusted.jks
Cert if icat e cert if icat e
l C onfiguring
creat or
sec ure
communicatio
n for
MicroStrategy
W eb and
Mobile Server,
D eveloper,
and client
applications

Steps to Add Certificates to Web or Mobile Server Truststore

Once you have popul ated the Keystore on Intel l i gence Server w i th
your SSL certi fi cate and pri vate key, fol l ow the steps bel ow to add the

© 2019, M icr o St r at egy In c. 347

Syst em Ad m in ist r at io n Gu id e

necessary certi fi cate to the cl i ent Truststore.

1. Locate your Mi croStrategy Web or Mobi l e depl oyment and l ocate

i ts W EB - I N F di rectory.

l IIS A SP Web: C : \ P r o g r a m F i l e s
(x 86 )\ M i c r o S t r a t e g y \ W e b A S P x\ W E B -I N F \

l IIS A SP Mobile: C : \ P r o g r a m F i l e s
(x 86 )\ M i c r o S t r a t e g y \ M o b i l e A S P x \ W E B -I N F \

l JSP Web or Mobile: The l ocati on depends on your .w ar fi l e

depl oyment

2. Open a C ommand Li ne termi nal and navi gate to the W E B -I N F

di rectory.

3. Execute the fol l ow i ng keytool command found under

MI CR OS T R A T E G Y _JR E.

<M IC RO S T R A T E G Y _J R E > / b i n / k e y t o o l - i m p o r t c e r t -
tr us tc a c e r t s - al i a s " < c e r t i f i c a t e _c o m m o n _n a m e > "
-k ey st o r e t r u s t e d . j k s - s t o r e p a s s m s t r 1 2 3 -f i le
ce rt .p e m

l If the fi l e t r u s t e d . j k s does not exi st i t w i l l be created.

l The s t o r e p a s s val ue refers to your Truststore passw ord. Thi s

val ue i s set to mstr123 by defaul t. U se your uni que Truststore
passw ord i f i t w as changed.

If the trus ts tore pas s word was c hanged, the

ss l T r u s t s t o r e P a s s w o r d v alue in the
mi c r o s t r a t e g y . x m l s hould be modified ac c ordingly .

l The c e r t . p e m fi l e refers to the certi fi cate(s) previ ousl y

obtai ned.

348 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Any a l i a s val ue may be used, but the certi fi cate common

name i s recommended, as l ong as the al i as i s uni que i n the
Truststore.

SSL with Client Certificate Verification

C l i ent certi fi cate veri fi cati on, al so referred to as mutual
authenti cati on, i s an opti onal step i n the SSL protocol . Through thi s
second certi fi cate veri fi cati on, Intel l i gence Server veri fi es the i denti ty
of Mi croStrategy Web or Mobi l e server (cl i ent). C l i ent certi fi cate
veri fi cati on requi res that a Keystore and Truststore are set up on
Intel l i gence Server as w el l as on the cl i ent to compl ete the trusted
connecti on. The fol l ow i ng secti ons descri be how to set up your cl i ent
Keystore and Intel l i gence Server Truststore by generati ng sel f-si gned
certi fi cates for your Web and Mobi l e Server cl i ents.

Steps to Setup the Client Keystore

1. Open a C ommand Li ne termi nal and navi gate to the WEB-IN F

di rectory

2. Execute the fol l ow i ng keytool command found under

MI CR OS T R A T E G Y _JR E:

© 2019, M icr o St r at egy In c. 349

Syst em Ad m in ist r at io n Gu id e

<M IC RO S T R A T E G Y _J R E > / b i n / k e y t o o l - g e n k e y p a i r -
ke ya lg R S A -k e y s i z e 2 0 4 8 -s i g a l g s h a 2 5 6 w i t h r sa
-v al id i t y 3 6 5 -a l i a s < c l i e n t _ce r t i f i c a t e _
co mm on _ n a m e > - dn a m e " C N = Y O U R _FU L L Y _Q U A L I F I E D _
DO MA IN _ S E R V E R _NA M E " -k e y s t o r e c l i e n t K e y . j k s -
st or ep a s s m s t r 1 2 3

If prompted to s et a k ey pas s word, pres s Enter to default the k ey

pas s word to matc h the s tore pas s word. If y our pas s word was
c hanged from the default of mstr123 update the parameter in y our
WE B- I N F / m i c r o s t r a t e g y . x m l file. Optionally , y ou c an
c hange the loc ation or name of the Key s tore file
cl ie n t K e y . j k s at this time v ia the sslC lientK eystore
parameter in the m i c r o s t r a t e g y . x m l file.

3. R estart Mi croStrategy Web and Mobi l e Server.

4. Extract the certi fi cate i nformati on w i th the fol l ow i ng command,

repl aci ng the defaul t passw ord w i th your ow n i f necessary. The
fi l e created w i l l be needed to set up the Truststore for

35 0 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Intel l i gence Server.

ke yt oo l - e x p o r tc e r t -r f c -k e y s t o r e
cl ie nt K e y . j k s -a l i a s < c l i e n t _ce r t i f i c a t e _
co mm on _ n a m e > - fi l e c e r t . t x t - st o r e p a s s m s t r 1 2 3

5. R epeat thi s process for each Web and Mobi l e depl oyment.

Steps to Set Up Intelligence Server Truststore

1. C reate a si mpl e text fi l e, for exampl e t ru s t s t o r e . t x t, and

add the certi fi cate i nformati on for each certi fi cate created duri ng
cl i ent Keystore creati on.

2. Save thi s fi l e to the c e r t s fol der i n Intel l i gence Server

di rectory.

3. Launch C onfi gurati on Wi zard and navi gate to SSL

C onfiguration i n the C onfigure Intelligence Server secti on.

4. C heck the C onfiguring port requires C lient C ertificate check

box, as show n bel ow :

© 2019, M icr o St r at egy In c. 35 1

Syst em Ad m in ist r at io n Gu id e

5. C l i ck the B rowse button next to the Truststore fi el d and sel ect

the t ru s t s t o r e . t x t fi l e contai ni ng your cl i ent certi fi cate
i nformati on.

6. C l i ck N ext and fol l ow the C onfi gurati on Wi zard prompts to restart

Intel l i gence Server.

Configuring Web, Mobile Server, and Web

Services to Require SSL Access
You can confi gure your appl i cati on server to requi re that cl i ents, such
as users' w eb brow sers, access the fol l ow i ng appl i cati ons w i th SSL,
usi ng the H TTPS protocol :

35 2 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Mi croStrategy Web, to enabl e secure communi cati on betw een Web

and users' brow sers.

l Mi croStrategy Mobi l e Server, to enabl e secure communi cati on

betw een Mobi l e Server and Mobi l e for i Phone, i Pad and Androi d.

l Mi croStrategy Web Servi ces, to enabl e secure communi cati on

betw een Web Servi ces and Offi ce.

For steps to confi gure SSL on your appl i cati on server, see the l i nk
bel ow to vi ew the offi ci al documentati on for your server type.

l Apache Tomcat 8.x

l Mi crosoft IIS 7 and above

l Oracl e WebLogi c Server 12.x

l IBM WebSphere 8.5x

l JBoss Enterpri se Appl i cati on Pl atform Web Server

Configuring Secure Communication for

MicroStrategy Web, Mobile Server, and Developer
Once the certi fi cate stores have been set up on Intel l i gence Server,
Web, and Mobi l e servers, you can now enabl e SSL communi cati on i n
your Mi croStrategy appl i cati ons.

To Configure SSL for Web and Mobile Server

1. From the Start menu choose A ll Programs > MicroStrategy

Tools and sel ect Web A dministrator or Mobile A dministrator.

2. On the l eft, cl i ck Security.

3. U nder Traffic to the Intelligence Server, sel ect the SSL opti on.

4. C l i ck Save.

© 2019, M icr o St r at egy In c. 35 3

Syst em Ad m in ist r at io n Gu id e

To Configure SSL for Developer

l You mus t us e the Configuration Wiz ard to s et up SSL for Intelligenc e

Serv er, as des c ribed in C onfi guri ng Secure C ommuni cati on for
Mi croStrategy Web, Mobi l e Server, and D evel oper, page 353 .

l For additional s ec urity , y ou c an enable Dev eloper to v erify Intelligenc e

Serv er's c ertific ate with the Certific ate Authority (CA) before trans mitting
any data. If y ou want to enable this option, y ou mus t obtain the following:

l Your CA's SSL c ertific ate. If y ou are us ing a c ommerc ial CA, refer to
their doc umentation for ins truc tions to download their c ertific ate.

l If y ou are us ing an enterpris e CA that has Mic ros oft Certific ate
Serv ic es ins talled, v is it h t t p : / /h o s t n a me/ C e r t S r v , where
ho st na m e is the c omputer on whic h Certific ate Serv ic es is ins talled,
and c lic k D ownload a C A certificate, certificate chain, or C R L .
Under Encoding method , s elec t B ase64 .

l The CSR generated when c onfiguring SSL for Intelligenc e Serv er, as
des c ribed in Generati ng an SSL C erti fi cate Si gni ng R equest,
page 364 .

l A .pem c ertific ate c ontaining both the SSL c ertific ate and the CSR for
Intelligenc e Serv er.

1. In D evel oper, ri ght-cl i ck the server-based proj ect source that you
use to connect to Intel l i gence Server, and sel ect Modify Project
Source.

2. On the C onnection tab, sel ect the U se SSL check box.

3. If you w ant D evel oper to veri fy Intel l i gence Server's certi fi cate
w i th the C A every ti me a connecti on i s made, sel ect the Verify
Server C ertificate check box.

35 4 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

You mus t perform the following tas k s to v erify the s erv er's
c ertific ate:

l D ow nl oad the C A's certi fi cate to the computer runni ng

D evel oper.

l In the C lient SSL C ertificate A uthority C ertificate fi el d, enter

the path to the .pem certi fi cate referenced i n the prerequi si tes
above. For exampl e, C : \ C e r t i f i c a t e s \ d e s k t o p . p e m.

4. C l i ck OK .

Configuring MicroStrategy Client Applications to

Use an HTTPS URL
To requi re i Phones, i Pads, and Androi d devi ces to use H TTPS to
connect to Mobi l e Server, you must update your devi ce confi gurati ons
i n Mobi l e Server.

To requi re Mi croStrategy Offi ce to use SSL to connect to Web

Servi ces, i n the Opti ons di al og box, you must add the h t t p s : / /
prefi x to the U R L for Web Servi ces, as descri bed i n To C onfi gure
Mi croStrategy Offi ce to U se SSL, page 356.

To Configure MicroStrategy Mobile for iPhone, iPad and

Android to Use SSL
1. Open the Mobi l e Admi ni strator page.

2. C l i ck Mobile C onfiguration.

3. For the confi gurati on you w ant to edi t, cl i ck Modify.

4. C l i ck the C onnectivity Settings tab.

5. For the Mobi l e Server that has SSL enabl ed, from the R equest
Type drop-dow n l i st, sel ect H TTPS.

© 2019, M icr o St r at egy In c. 35 5

Syst em Ad m in ist r at io n Gu id e

6. C l i ck Save..

7. R epeat thi s procedure for every confi gurati on that i ncl udes the
above Mobi l e Server.

To Configure MicroStrategy Office to Use SSL

This information applies to Mic roStrategy Offic e, the add-in for

Mic ros oft Offic e applic ations whic h is no longer ac tiv ely dev eloped.

It was s ubs tituted with a new add-in, Mic roStrategy for Offic e, whic h
s upports Offic e 365 applic ations . The initial v ers ion does not y et hav e
all the func tionalities of the prev ious add-in.

For more information, s ee the Mi croStrategy for Offi ce page i n the

2019 U pdate 1 R eadme and the Mi croStrategy for Offi ce Onl i ne
H el p .

1. In Wi ndow s, go to Start > A ll Programs > MicroStrategy Tools

> Office C onfiguration.

2. U nder General, sel ect Server.

3. In the Web Services U R L fi el d, repl ace the h t t p : / / prefi x w i th

ht tp s: / / .

4. C l i ck OK .

Testing SSL Access

Perform the fol l ow i ng steps to test SSL access to Web and Web
Servi ces.

To Test SSL Access to Web and Web Services

1. In your brow ser, enter the U R L to access Web and Web Servi ces.
By defaul t, these are:

35 6 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Web (ASP.N ET):

ht tp :/ /h o s t n a m e/ M i c r o S t r a t e g y / a s p /, w here
ho st na m e i s the name of the server that Web i s runni ng on.

l Web (J2EE):
ht tp :/ /h o s t n a m e/ M i c r o S t r a t e g y / s e r v l e t / m s t r W e b,
w here h o s t n a m e i s the name of the server that Web i s runni ng
on.

l Web Servi ces:

ht tp :/ /h o s t n a m e/ M i c r o S t r a t e g y W S / M S T R W S . a s m x,
w here h o s t n a m e i s the name of the server that Web Servi ces
i s runni ng on.

An error page shoul d be di spl ayed, w i th a 403.4 error i ndi cati ng

that SSL i s requi red to access the page.

2. In the above U R Ls, repl ace h t t p : / / w i th h t t p s : / /. After a

short del ay, Web shoul d open, or the Web Servi ces method l i st
shoul d be di spl ayed (as appl i cabl e), i ndi cati ng that the SSL
access i s w orki ng.

Certificate Files: Common Extensions and

Conversions
Thi s secti on bri efl y expl ai ns common extensi ons for SSL certi fi cate
and keystore fi l es, as w el l as how to convert these fi l es betw een
formatti ng types.

Common File Extensions

C erti fi cate

C ertificate files: .crt, .cer, .ca-bundl e, .p7b, .p7c, .p7s, .pem

K eystore Files: .key, .keystore, .j ks

C ombined certificate and key files: .p12, .pfx, .pem

© 2019, M icr o St r at egy In c. 35 7

Syst em Ad m in ist r at io n Gu id e

Converting Files
To set up SSL for your Mi croStrategy envi ronment, you w i l l need to
have your certi fi cates and key fi l es i n .pem, .crt, and .key formats. If
you have fi l es from your IT admi ni strator that do not have these
extensi ons, they must be converted.

The fol l ow i ng commands to convert betw een fi l e types:

l C onvert a D ER format file to PEM format

op en ss l x 5 0 9 - i nf o r m d e r -i n c er t i f i c a t e . c e r -
ou t c er ti f i c a t e .p e m

l C onvert a .pfx or .p12 containing a private key and certificates

to PEM

op en ss l p k c s 1 2 -i n c e r t k e y . p f x -o u t c e r t k e y . p e m
-n od es

l Add - no c e r t s to onl y output the pri vate key.

l Add - no k e y s to onl y output the certi fi cates.

l C onvert .keystore or .jks to .key: R equi res tw o commands to be

run.

1. C onvert the fi l e to the .p12 extensi on

ke yt o o l - i m p or t k e y s t o r e -s r c k e y s t o r e
pr iv a t e k e y . k e y s t o r e -d e s t k e y s t o r e
pr iv a t e k e y . p 1 2 -s r c s t o r e t y p e j k s -
de st s t o r e t y p e p k c s 1 2 -s r c s t o r e p a s s p a s s w o r d -
de st s t o r e p a s s p a s s w o r d

2. C onvert to the .key extensi on

op en s s l p k c s 1 2 -n o c e r t s -n o d e s -i n
ne wk e y s t o r e . p 1 2 -o u t k e y f i l e . k e y

35 8 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Self-Signed Certificates: Creating a Certificate

Authority for Development
If you are creati ng demos or proofs-of-concept that requi re SSL, you
can set up a server that can act as a C erti fi cate Authori ty (C A) to si gn
the certi fi cates for the Mi croStrategy appl i cati ons.

Us e s elf-s igned c ertific ates only in demo or dev elopment env ironments .
Self-s igned c ertific ates are not rec ommended in a produc tion
env ironment for the following reas ons :

l If the CA s erv er is c ompromis ed, an attac k er c an us e it to s ign

c ertific ates for malic ious s ites .

l By default, us ers ' dev ic es and brows ers do not ac c ept s elf-s igned
c ertific ates , whic h may c aus e us ers to rec eiv e s ec urity warnings and
dis rupt their work flows .

You can set up a C A server usi ng the OpenSSL uti l i ty. If you are
usi ng a U N IX or Li nux machi ne, OpenSSL shoul d be i nstal l ed by
defaul t. If you are usi ng a Wi ndow s machi ne, you can dow nl oad the
OpenSSL uti l i ty from http://w w w .openssl .org/.

To set up a C A, perform the fol l ow i ng tasks:

l C reate the di rectori es and confi gurati on fi l es for the C A. See

C reati ng the D i rectori es and C onfi gurati on Fi l es for Your C A, page
360.

l C reate the server's pri vate key and root certi fi cate. See C reati ng the
Pri vate Key and R oot C erti fi cate for the C A, page 362.

l Add the root certi fi cate as a trusted certi fi cate on your netw ork. See
Addi ng your enterpri se C A as a trusted certi fi cate authori ty.

© 2019, M icr o St r at egy In c. 35 9

Syst em Ad m in ist r at io n Gu id e

l C onfi gure OpenSSL to use the server's pri vate key and certi fi cate to
si gn certi fi cate requests. See C onfi guri ng OpenSSL to U se your
Pri vate Key and R oot C erti fi cate, page 363.

l Generate an SSL C erti fi cate Si gni ng R equest (C SR ). See

Generati ng an SSL C erti fi cate Si gni ng R equest.

l C reate certi fi cates for the Mi croStrategy appl i cati ons. See Si gni ng
C erti fi cate R equests U si ng Your C A, page 366.

Creating the Directories and Configuration Files for Your

CA
To create your C A usi ng OpenSSL, you must create di rectori es to
store i mportant fi l es for the C A, such as the server's pri vate keys,
certi fi cates that have been si gned, and so on. In addi ti on, you must
create the fi l es that track the certi fi cates that have been created, and
an OpenSSL confi gurati on fi l e for your C A.

To Create the Directories and Files for the CA

1. U si ng Wi ndow s Expl orer or the U N IX Termi nal , as appl i cabl e,

create the fol l ow i ng di rectori es:

Dir e c tor y Folde r na me

A name of your choice. For

A root direct ory f or t he CA .
example, devCA

private
A subdirect ory t o st ore t he CA 's privat e key For example,
devCA/private

A subdirect ory t o st ore new cert if icat es issued certs

by t he CA For example, devCA/certs

360 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Dir e c tor y Folde r na me

newcerts
A subdirect ory t o st ore t he new cert if icat es in
an unencrypt ed f ormat For example,
devCA/newcerts

2. In the root di rectory for the C A, use a text edi tor to create the
fol l ow i ng fi l es:

File na me De s c r iption

serial Cont ains t he serial number f or t he next cert if icat e. When you
(no creat e t he f ile, you must add t he serial number f or t he f irst
ext ension) cert if icat e. For example, 01 .

index.txt Used as a dat abase t o t rack cert if icat es t hat have been issued.

3. D ependi ng on your pl atform, do one of the fol l ow i ng:

l Linux: Open a termi nal w i ndow , and navi gate to the l ocati on
w here OpenSSL i s i nstal l ed.

The default ins tallation folder may depend on the dis tribution y ou
are us ing. For ex ample, for Red Hat Enterpris e Linux , the default
folder is / e t c / p k i / t l s .

l Windows: Open a command prompt w i ndow , and navi gate to

the l ocati on w here OpenSSL i s i nstal l ed. By defaul t, thi s i s
C: \O pe n S S L -W i n 3 2 \ b i n.

4. C reate a copy of the OpenSSL confi gurati on fi l e o p e n s s l . c nf,

and paste i t i n the root di rectory you created for your C A. U se a
di fferent fi l e name, for exampl e, o p e n s sl . d e v . c n f.

© 2019, M icr o St r at egy In c. 361

Syst em Ad m in ist r at io n Gu id e

Creating the Private Key and Root Certificate for the CA

Once you have set up the fi l es and di rectori es for your C A, you can
create a root certi fi cate, w hi ch i s used to si gn certi fi cate requests
from Mi croStrategy appl i cati ons.

Thi s procedure assumes that you have fol l ow ed al l the steps i n

C reati ng the D i rectori es and C onfi gurati on Fi l es for Your C A, page
360.

To Create the Private Key and Root Certificate for the CA

1. D ependi ng on your pl atform, do one of the fol l ow i ng:

l Linux: Open a termi nal w i ndow .

l Windows: Open a command prompt w i ndow , and navi gate to

the l ocati on w here OpenSSL i s i nstal l ed. By defaul t, thi s i s
C: \O pe n S S L -W i n 3 2 \ b i n.

2. To create the pri vate key and root certi fi cate, type the fol l ow i ng
command, and press Enter:

op en ss l r e q - c o n f i g d e v C A p a t h / o p e n s s l . d e v . c n f -
ne w - x5 0 9 - e x t e n s i o n s v 3 _c a - ke y o u t
de vC Ap a t h / p r i v a t e / d e v C A . k e y - ou t
de vC Ap a t h / c e r t s / d e v C A . c r t -d a y s 1 8 2 5

Where:

l de vC Ap a t h: The root di rectory for your C A, w hi ch i s created

as part of the procedure descri bed i n C reati ng the D i rectori es
and C onfi gurati on Fi l es for Your C A, page 360. For exampl e,
/e tc /p k i / t l s / d e v C A.

l op en ss l . d e v . c n f: The copy of the defaul t OpenSSL

confi gurati on fi l e, created i n the root di rectory for your C A.

362 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l de vC A. k e y: The fi l ename for the pri vate key.

l de vC A. c r t: The fi l ename for the root certi fi cate.

3. You are prompted for a pass-phrase for the key, and for
i nformati on about your C A, such as your l ocati on, organi zati on
name, and so on. U se a strong pass-phrase to secure your
pri vate key, and type the requi red i nformati on for the C A. The
pri vate key and root certi fi cate are created.

Configuring OpenSSL to Use your Private Key and Root

Certificate
To start creati ng certi fi cates for the Mi croStrategy appl i cati ons i n your
devel opment envi ronment, you must confi gure OpenSSL to use your
C A's pri vate key and root certi fi cate to si gn certi fi cate requests. For
i nformati on on creati ng certi fi cate requests for appl i cati ons, see
Generati ng an SSL C erti fi cate Si gni ng R equest, page 364.

This proc edure as s umes that y ou hav e c ompleted the following s teps :

l Create the files and direc tory s truc ture for y our CA, inc luding a c opy of
the default OpenSSL c onfiguration file, as des c ribed in C reati ng the
D i rectori es and C onfi gurati on Fi l es for Your C A, page 360 .

l Create a priv ate k ey and root c ertific ate for y our CA, as des c ribed in
C reati ng the Pri vate Key and R oot C erti fi cate for the C A, page
362 .

To Configure OpenSSL to Use your CA's Root Certificate

1. U se a text edi tor, such as N otepad, to open the copy of the

OpenSSL confi gurati on fi l e i n your C A's root di rectory. For
exampl e, o p e n s s l . d e v . c n f.

© 2019, M icr o St r at egy In c. 363

Syst em Ad m in ist r at io n Gu id e

2. Scrol l to the C A _d e f a u l t secti on, and edi t the fol l ow i ng val ues:

l di r : C hange thi s val ue to the root fol der that you created for
your C A. For exampl e, / e t c / p k i / t s l / d e v C A.

l ce rt if i c a t e: C hange thi s val ue to

$d ir /c e r t s /d e v C A . c r t, w here d e v C A . c r t i s the root
certi fi cate that you created for your C A.

l pr iv at e _k e y: C hange thi s val ue to

$d ir /p r i v a t e /d e v C A . k e y, w here d e v C A . k e y i s the
pri vate key that you created for your C A.

3. Save the fi l e.

Generating an SSL Certificate Signing Request

You can use the OpenSSL uti l i ty to create an SSL C erti fi cate Si gni ng
R equest (C SR ) for each of your appl i cati ons.

If you are usi ng a U N IX or Li nux machi ne, the OpenSSL uti l i ty shoul d
be i nstal l ed by defaul t. If you are usi ng a Wi ndow s machi ne, you can
dow nl oad the OpenSSL uti l i ty from http://w w w .openssl .org/.

To Generate an SSL Certificate Signing Request using OpenSSL

1. D ependi ng on your pl atform, do one of the fol l ow i ng:

l Linux: Open a termi nal w i ndow .

l Windows: Open a command prompt w i ndow , and navi gate to

the l ocati on w here OpenSSL i s i nstal l ed. By defaul t, thi s i s
C: \O pe n S S L -W i n 3 2 \ b i n.

364 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To Gener at e a Pr i vat e Key f or t he Ser ver

1. Type the fol l ow i ng command, and press Enter:

op en ss l g e n r s a –d e s 3 –o u t S e r v e r _k e y . k e y

Where S e r v e r _k e y . k e y i s the name of the pri vate key fi l e. By

defaul t, the pri vate key fi l e i s created i n the current l ocati on. To
create the fi l e at a di fferent l ocati on, repl ace S e r v e r _k e y . k ey
w i th a path to create the new fi l e.

You are prompted for a pass-phrase for the key.

2. Type a secure pass-phrase for the key, and press Enter. The key
fi l e i s created.

To Gener at e t he Cer t i f i cat e Si gni ng Req uest

1. Type the fol l ow i ng command, and press Enter:

op en ss l r e q – n e w – k e y S e r v e r _ke y . k e y – o u t
Se rv er _ C S R . c s r

Where S e r v e r _k e y . k e y i s the pri vate key fi l e that you created,

and S er v e r _C S R i s the C SR fi l e.

2. You are prompted for i nformati on such as your organi zati on's
name, department name, country code, and so on. Type the
i nformati on about your organi zati on as you are prompted. When
prompted for a C ommon N ame, type the ful l y qual i fi ed domai n
name of the server that the appl i cati on runs on. For exampl e, i f
Intel l i gence Server runs on a machi ne cal l ed
in te ll i g e n c e s e r v e r, and your domai n i s
yo ur co m p a n y . c o m, the ful l y qual i fi ed domai n name i s
in te ll i g e n c e s e r v e r . y o u r c o m p a n y . c o m.

When you have entered al l the requi red i nformati on, the C SR fi l e
i s created

© 2019, M icr o St r at egy In c. 365

Syst em Ad m in ist r at io n Gu id e

3. R epeat thi s procedure for every appl i cati on that you need a
certi fi cate for.

Signing Certificate Requests Using Your CA

Once you have confi gured OpenSSL to use your C A's pri vate key and
root certi fi cate, you can si gn certi fi cate requests to create the SSL
certi fi cates for the Mi croStrategy appl i cati ons. The steps to create
certi fi cates fol l ow .

This proc edure as s umes that y ou hav e c ompleted the following s teps :

l Create the files and direc tory s truc ture for y our CA, inc luding a c opy of
the default OpenSSL c onfiguration file, as des c ribed in C reati ng the
D i rectori es and C onfi gurati on Fi l es for Your C A, page 360 .

l Create a priv ate k ey and root c ertific ate for y our CA, as des c ribed in
C reati ng the Pri vate Key and R oot C erti fi cate for the C A, page
362 .

l Configure OpenSSL to us e the priv ate k ey and root c ertific ate, as

des c ribed in C onfi guri ng OpenSSL to U se your Pri vate Key and
R oot C erti fi cate, page 363 .

l Create a c ertific ate s igning reques t (CSR file) for the applic ations that
require SSL c ertific ates , as des c ribed in Generati ng an SSL
C erti fi cate Si gni ng R equest, page 364 . Copy the CSR file to the
s erv er that hos ts y our CA.

To Sign Certificate Requests Using Your CA

1. D ependi ng on your pl atform, do one of the fol l ow i ng:

l Linux: Open a termi nal w i ndow , and navi gate to the l ocati on
w here OpenSSL i s i nstal l ed.

366 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

The default ins tallation folder may depend on the dis tribution y ou
are us ing. For ex ample, for Red Hat Enterpris e Linux , the default
folder is / e t c / p k i / t l s .

l Windows: Open a command prompt w i ndow , and navi gate to

the l ocati on w here OpenSSL i s i nstal l ed. By defaul t, thi s i s
C: \O pe n S S L -W i n 3 2 \ b i n.

2. Type the fol l ow i ng command, and press Enter:

op en ss l c a -c o n f i g d e v C A p a t h / op e n s s l . d e v . c n f -
po li cy p o l i c y _an y t h i n g - o u t
de vC Ap a t h / c e r t s / m s t r a p p . c r t - in f i l e s
CS Rp at h / m s t r a p p . c s r

Where:

l de vC Ap a t h: The root di rectory for your C A, w hi ch i s created

as part of the procedure descri bed i n C reati ng the D i rectori es
and C onfi gurati on Fi l es for Your C A, page 360. For exampl e,
/e tc /p k i / t l s / d e v C A.

l op en ss l . d e v . c n f: The OpenSSL confi gurati on fi l e for your

C A, confi gured to use your C A's pri vate key and root
certi fi cate, as descri bed i n C onfi guri ng OpenSSL to U se your
Pri vate Key and R oot C erti fi cate, page 363.

l ms tr ap p . c r t: The fi l ename for the certi fi cate to be generated

for the Mi croStrategy appl i cati on.

l CS Rp at h: The fol der w here the certi fi cate si gni ng request i s

stored.

l ms tr ap p . c s r: The certi fi cate si gni ng request for the

Mi croStrategy appl i cati on.

The certi fi cate i s generated, and i s stored i n the c e r t s fol der.

© 2019, M icr o St r at egy In c. 367

Syst em Ad m in ist r at io n Gu id e

3. C opy the generated certi fi cate to the machi ne w here the

Mi croStrategy appl i cati on i s hosted.

4. R epeat thi s procedure for al l Mi croStrategy appl i cati ons that

requi re SSL certi fi cates.

368 © 2019, M icr o St r at egy In c.

 5
M ANAGING YOUR
L ICENSES

© 2019, M icr o St r at egy In c. 369

Syst em Ad m in ist r at io n Gu id e

As a system admi ni strator, i t i s i mportant that you manage your

Mi croStrategy product l i censes to mai ntai n l i cense compl i ance.
Managi ng your l i censes can al so hel p you take ful l advantage of your
l i censes. For exampl e, you mi ght have a C PU -based Intel l i gence
Server l i cense for four C PU s, but onl y be usi ng tw o C PU s. An audi t of
your l i censes can al ert you to thi s i ssue and you can then modi fy your
setup so that you use al l four of your l i censed C PU s.

Thi s secti on covers how to manage the l i censes i nvol ved i n your
Mi croStrategy system. Topi cs i ncl ude:

l Managi ng and Veri fyi ng Your Li censes, page 370

l Audi ti ng and U pdati ng Li censes, page 375

l U pdati ng C PU Affi ni ty, page 388

Managing and Verifying Your Licenses

Mi croStrategy l i censes are managed di fferentl y accordi ng to the
l i cense type that i s purchased. R efer to your Mi croStrategy contract
and any accompanyi ng contract documentati on for descri pti ons of the
di fferent Mi croStrategy l i cense types.

Mi croStrategy uses tw o mai n categori es of l i censes:

l N amed U ser Li censes, page 371, i n w hi ch the number of users w i th

access to speci fi c functi onal i ty are restri cted

l C PU Li censes, page 373, i n w hi ch the number and speed of the

C PU s used by Mi croStrategy server products are restri cted

Mi croStrategy Li cense Manager can assi st you i n admi ni steri ng your

Mi croStrategy l i censes. For i nformati on about Li cense Manager, see
U si ng Li cense Manager, page 375.

370 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

When y ou obtain additional lic ens es from Mic roStrategy , us e Lic ens e
Manager to update y our lic ens e information. For details , s ee U pdati ng
Your Li cense, page 387 .

Named User Licenses

In a N amed U ser l i censi ng scheme, the pri vi l eges gi ven to users and
groups determi ne w hat l i censes are assi gned to users and groups.
Intel l i gence Server moni tors the number of users i n your
Mi croStrategy system w i th each pri vi l ege, and compares that to the
number of avai l abl e l i censes.

For exampl e, the Web U se Fi l ter Edi tor pri vi l ege i s a Web
Professi onal pri vi l ege. If you assi gn thi s pri vi l ege to U ser1, then
Intel l i gence Server grants a Web Professi onal l i cense to U ser1. If you
onl y have one Web Professi onal l i cense i n your system and you
assi gn any Web Professi onal pri vi l ege, for exampl e Web Edi t D ri l l i ng
And Li nks, to U ser2, Intel l i gence Server di spl ays an error message
w hen any user attempts to l og i n to Mi croStrategy Web.

The Adminis trator us er that is c reated with the repos itory is not
c ons idered in the lic ens ed us er c ount.

To fi x thi s probl em, you can ei ther change the user pri vi l eges to
match the number of l i censes you have, or you can obtai n addi ti onal
l i censes from Mi croStrategy. Li cense Manager can determi ne w hi ch
users are causi ng the metadata to exceed your l i censes and w hi ch
pri vi l eges for those users are causi ng each user to be cl assi fi ed as a
parti cul ar l i cense type (see U si ng Li cense Manager, page 375).

For more i nformati on about the pri vi l eges associ ated w i th each
l i cense type, see the Li st of Pri vi l eges secti on. Each pri vi l ege group
has an i ntroducti on i ndi cati ng any l i cense that the pri vi l eges i n that
group are associ ated w i th. U sers w i thout any product-based
pri vi l eges are l i sted i n Li cense Manager i n the group U sers without

© 2019, M icr o St r at egy In c. 371

Syst em Ad m in ist r at io n Gu id e

license association, and are not counted agai nst any Mi croStrategy
l i censes.

l Priv ileges that relate to OLAP Serv ic es , Report Serv ic es , and

Dis tribution Serv ic es lic ens es are pres ent in multiple priv ilege groups .
Thes e priv ileges are mark ed with as teris k s , and are lis ted at the top of
eac h group's lis t of priv ileges .

l Only us ers who hav e the Us e Dev eloper priv ilege in the Analy s t group
are granted Analy s t or Dev eloper lic ens es . Us ers who do not hav e the
Us e Dev eloper priv ilege are not granted either of thes e lic ens es , ev en
if they hav e all other priv ileges from thes e priv ilege groups .

l With a Reporter lic ens e, both Web and Analy tic s lic ens es are
av ailable.

Ver if yin g Named User licen ses

To veri fy your N amed U ser l i censes, Intel l i gence Server scans the
metadata reposi tory dai l y for the number of users fi tti ng each N amed
U ser l i cense type. If the number of l i censes for a gi ven type has been
exceeded, an error message i s di spl ayed w hen a user l ogs i n to a
Mi croStrategy product. C ontact your Mi croStrategy account executi ve
to i ncrease your number of N amed U ser l i censes. For detai l ed
i nformati on on the effects of bei ng out of compl i ance w i th your
l i censes, see Effects of Bei ng Out of C ompl i ance w i th Your Li censes,
page 374.

For steps to manual l y veri fy your N amed U ser l i censes usi ng Li cense
Manager, see Audi ti ng Your System for the Proper Li censes, page
385. You can confi gure the ti me of day that Intel l i gence Server
veri fi es your N amed U ser l i censes.

372 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To Configure the Time When Named User Licenses are Verified

1. In D evel oper, ri ght-cl i ck a proj ect source and sel ect C onfigure
MicroStrategy Intelligence Server.

2. Expand the Server category, and sel ect A dvanced.

3. Speci fy the ti me i n the Time to run license check (24 hr format)

fi el d.

4. C l i ck OK .

CPU Licenses
When you purchase l i censes i n the C PU format, the system moni tors
the number of C PU s bei ng used by Intel l i gence Server i n your
i mpl ementati on and compares i t to the number of l i censes that you
have. You cannot assi gn pri vi l eges rel ated to certai n l i censes i f the
system detects that more C PU s are bei ng used than are l i censed. For
exampl e, thi s coul d happen i f you have Mi croStrategy Web i nstal l ed
on tw o dual -processor machi nes (four C PU s) and you have a l i cense
for onl y tw o C PU s.

To fi x thi s probl em, you can ei ther use Li cense Manager to reduce the
number of C PU s bei ng used on a gi ven machi ne so i t matches the
number of l i censes you have, or you can obtai n addi ti onal l i censes
from Mi croStrategy. To use Li cense Manager to determi ne the number
of C PU s l i censed and, i f necessary, to change the number of C PU s
bei ng used, see U si ng Li cense Manager, page 375.

The abi l i ty to depl oy Intel l i gence Server or Mi croStrategy Web on

speci fi c, sel ected C PU s (a subset of the total number of physi cal
C PU s) on a gi ven machi ne i s cal l ed C PU affi ni ty. For detai l s on
setti ng up C PU affi ni ty, see U pdati ng C PU Affi ni ty, page 388.

© 2019, M icr o St r at egy In c. 373

Syst em Ad m in ist r at io n Gu id e

Ver if yin g CPU Licen ses

To veri fy your C PU l i censes, Intel l i gence Server scans the netw ork to
count the number of C PU s i n use by Intel l i gence Servers. If the
number of C PU l i censes has been exceeded, an error message i s
di spl ayed w hen a user l ogs i n to a Mi croStrategy product. C ontact
your Mi croStrategy account executi ve to i ncrease your number of C PU
l i censes. For detai l ed i nformati on on the effects of bei ng out of
compl i ance w i th your l i censes, see Effects of Bei ng Out of
C ompl i ance w i th Your Li censes, page 374.

For steps to manual l y veri fy your C PU l i censes usi ng Li cense

Manager, see Audi ti ng Your System for the Proper Li censes, page
385.

Effects of Being Out of Compliance with Your Licenses

If your system i s determi ned to be out of compl i ance w i th your
l i censes, an error message i s di spl ayed any ti me a user accesses an
admi ni strati ve product, such as the Mi croStrategy Web Admi ni strator
page or the Admi ni strati on i con i n D evel oper. Thi s message
descri bes the speci fi c types of l i censes that are not i n compl i ance
and states how many days remai n before Intel l i gence Server can no
l onger be restarted. Thi s error message i s onl y a w arni ng, and users
can sti l l use the admi ni strati ve product.

After the system has been out of compl i ance for fi fteen days, an
addi ti onal error message i s di spl ayed to al l users w hen they l og i nto
a proj ect source, w arni ng them that the system i s out of compl i ance
w i th the avai l abl e l i censes. Thi s error message i s onl y a w arni ng, and
users can sti l l l og i n to the proj ect source.

After the system has been out of compl i ance for thi rty days,
Intel l i gence Server can no l onger be restarted once i t i s shut dow n. In
addi ti on, i f the system i s out of compl i ance w i th N amed U ser l i censes,
the pri vi l eges associ ated w i th the out-of-compl i ance products are

374 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

di sabl ed i n the U ser Edi tor, Group Edi tor, and Securi ty R ol e Edi tor to
prevent them from bei ng assi gned to any addi ti onal users.

C ontact your Mi croStrategy account executi ve to purchase addi ti onal

l i censes. For i nformati on on how Intel l i gence Server veri fi es l i censes,
see N amed U ser Li censes, page 371 and C PU Li censes, page 373.

Auditing and Updating Licenses

Once your Mi croStrategy system i s i n pl ace, Intel l i gence Server
veri fi es how your system i s bei ng used i n rel ati on to l i censes and
users. You can use Li cense Manager to ensure that your system i s i n
compl i ance w i th your l i censes.

You can check for and manage the fol l ow i ng l i censi ng i ssues:

l More copi es of a Mi croStrategy product are i nstal l ed and bei ng

used than you have l i censes for.

l More users are usi ng the system than you have l i censes for.

l More C PU s are bei ng used w i th Intel l i gence Server than you have
l i censes for.

Using License Manager

Li cense Manager i s a tool for audi ti ng and admi ni steri ng your
Mi croStrategy l i censes and i nstal l ati on. You can run Li cense Manager
as a graphi cal user i nterface (GU I) or as a command l i ne tool , i n
ei ther Wi ndow s or Li nux envi ronments.

In both GU I mode and command l i ne mode, Li cense Manager al l ow s

you to:

l Audi t your Mi croStrategy products.

l R equest an Acti vati on C ode and acti vate your Mi croStrategy

© 2019, M icr o St r at egy In c. 375

Syst em Ad m in ist r at io n Gu id e

i nstal l ati on.

l U pdate your l i cense key.

Addi ti onal l y, i n GU I mode Li cense Manager al l ow s you to:

l D etermi ne the number of product l i censes i n use by a speci fi ed user

group.

l D i spl ay the enabl ed or di sabl ed l i censes used by a parti cul ar user

group for sel ected products.

From this information, y ou c an determine whether y ou hav e the

number of lic ens es that y ou need. You c an als o print a report, or
c reate and v iew a Web page with this information.

l U pdate l i censes by provi di ng the new l i cense key, w i thout re-

i nstal l i ng the products. For exampl e, you can:

l U pgrade from an eval uati on edi ti on to a standard edi ti on.

l U pdate the number of Intel l i gence Server processors al l ow ed.

l U pdate the processor speed al l ow ed.

l Acti vate or deacti vate your Mi croStrategy i nstal l ati on.

For more information on ac tiv ating y our Mic roStrategy ins tallation,
s ee the Instal l ati on and C onfi gurati on Gui de .

l C hange the number of C PU s bei ng used for a gi ven Mi croStrategy

product, such as Intel l i gence Server or Mi croStrategy Web, i f your
l i censes are based on C PU s.

l Tri gger a l i cense veri fi cati on check after you have made any
l i cense management changes, so the system can i mmedi atel y return
to normal behavi or.

376 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Vi ew your machi ne's confi gurati on i ncl udi ng hardw are and
operati ng system i nformati on.

l Vi ew your Mi croStrategy i nstal l ati on hi story i ncl udi ng al l l i cense

keys that have been appl i ed.

l Vi ew the versi on, edi ti on, and expi rati on date of the Mi croStrategy
products i nstal l ed on the machi ne.

If the edition is not an Ev aluation edition, the ex piration date has a

v alue of "Nev er."

For detai l ed steps to perform al l of these procedures, see the Li cense

Manager H el p (from w i thi n Li cense Manager, press F1).

To Start License Manager

Li cense Manager can be run on Wi ndow s or U N IX, i n ei ther GU I

mode or command l i ne mode.

l Windows GU I: From the Wi ndow s Start menu, poi nt to A ll

Programs, then MicroStrategy Tools, and then sel ect License
Manager. Li cense Manager opens i n GU I mode.

l Windows command line: From the Start menu, sel ect R un. Type
CM D and press Enter. A command prompt w i ndow opens. Type
ma li cm gr and press Enter. Li cense Manager opens i n command
l i ne mode, and i nstructi ons on how to use the command l i ne mode
are di spl ayed.

l Linux GU I: In a U N IX or Li nux consol e w i ndow , brow se to < H O M E _

PA TH > w here < H O M E _P A T H > i s the di rectory that you speci fi ed as
the home di rectory duri ng i nstal l ati on. Brow se to the fol der b i n and
type ./ ms tr l i c m g r, then press Enter. Li cense Manager opens i n
GU I mode.

© 2019, M icr o St r at egy In c. 377

Syst em Ad m in ist r at io n Gu id e

l Linux command line: In a Li nux consol e w i ndow , brow se to H O ME _

PA TH w here H O M E _P A T H i s the speci fi ed home di rectory duri ng
i nstal l ati on. Brow se to the fol der b i n and type . / m s t r l i c m g r -
co ns ol e , then press Enter. Li cense Manager opens i n command
l i ne mode, and i nstructi ons on how to use the command l i ne mode
are di spl ayed.

License Auditing with the Compliance Dossier

Wi th the C ompl i ance dossi er, you now have the abi l i ty as an
admi ni strator to moni tor system and product usage to ensure that you
remai n compl i ant w i th your Mi croStrategy contract. The C ompl i ance
dossi er provi des i nsi ght i nto w hat products and quanti ti es are bei ng
used based on pri vi l ege checks as w el l as how exi sti ng pri vi l eges
map to Mi croStrategy products packagi ng. Everythi ng needed to
confi gure and depl oy the C ompl i ance dossi er i s i ncl uded w i th your
i nstal l ati on or upgrade.

Once confi gured and depl oyed one C ompl i ance D ossi er w i l l al l ow
you to:

l Qui ckl y and easi l y audi t mul ti pl e sets of metadata.

l Identi fy w hen you are out of compl i ance w i th your contract.

l U nderstand and easi l y di gest the pri vi l eges associ ated w i th new
products.

l Identi fy w hi ch l i censes are over al l ocated.

l Identi fy w hi ch users are usi ng w hi ch pri vi l eges.

The C ompl i ance dossi er i s del i vered w i th your Mi croStrategy

i nstal l ati on as an Obj ect Manager package that contai ns the fol l ow i ng
obj ects:

l A dossi er named Li cense Audi t

l Tw o data i mport cubes to store your audi t i nformati on

378 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Al l other necessary dependent obj ects.

Ho w t o Dep lo y Yo u r Co mp lian ce Do ssier

1. Launch Mi croStrategy Li cense Manager and connect to a proj ect
source.

C l i ck Export (for C ompliance D ashboard) and save the

generated .csv fi l es. A C ompl i ance_D ashboard fol der i s created
automati cal l y to hol d these fi l es.

© 2019, M icr o St r at egy In c. 379

Syst em Ad m in ist r at io n Gu id e

2. Launch Mi croStrategy Obj ect Manager and i mport the

Co mp li a n c e D a s h b o a r d . m m p fi l e to any proj ect. The
C ompl i anceD ashboard package i s i nstal l ed i n the C : \ P r o g ra m
Fi le s ( x 8 6 ) \ C o m m o n F i l e s \ M i c r oS t r a t e g y fol der.

3. To create the dossi er, open the 2019 Li cense Audi t Fol der i n
your proj ect.

4. Import the .csv fi l es from the C o m p l i a n c e _D a s h b o a r d fol der

i nto the License A udit C ube.

380 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

5. Manual l y add your purchased Products and Licensed U sers to

the Licensed U sers Input by C ustomer C ube.

© 2019, M icr o St r at egy In c. 381

Syst em Ad m in ist r at io n Gu id e

6. R un the pre-formatted License A udit dossi er.

The fi ni shed C ompl i ance dossi er contai ns three chapters:

Li cense Overvi ew | Li cense D etai l s | Pri vi l ege D etai l s

The License Overview chapter provi des a summary of

envi ronment, account, and product and l i cense i nformati on. Pre-
formatted threshol ds appl i ed to the C ompliance col umn make
out of compl i ance usage i nstantl y recogni zabl e. R eporter and

382 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Intel l i gence are represented i n i ndependent secti ons to hel p

qui ckl y pi npoi nt i ssues.

The License D etails chapter provi des more i n-depth anal ysi s of
l i cense usage at the product l evel , as w el l as detai l ed
i nformati on on each user and thei r associ ated pri vi l eges.

The Pri vi l ege D etai l s chapter cosi sts of a Product-Pri vi l ege

matri x i n reference to the current Mi croStrategy Product
Packagi ng. By rul e each cl i ent l i cense requi res a correspondi ng
server l i cense, so a cl i ent pri vi l ege w i l l automati cal l y consume a
server l i cense, w i th the excepti on of R eporter pri vi l eges. The

© 2019, M icr o St r at egy In c. 383

Syst em Ad m in ist r at io n Gu id e

pri vi l eges associ ated w i th the R eporter product are l i sted i n thei r
ow n col umn i n the matri x.

This information in this c hapter is s ubjec t to c hange, bas ed on new

produc ts , new priv ileges or c hanges to produc t definitions .

Relat ed To p ics
R eporter vs. Intel l i gence U sers i n the C ompl i ance D ossi er

Rep o r t er vs. In t elligen ce User s in t h e Co mp lian ce Do ssier

The R eporter product i s combi nati on of a speci fi c set of cl i ent and
server pri vi l eges that al l ow s users to onl y execute reports, documents
and dossi ers. Any user that gets assi gned one or more pri vi l eges
under the R eporter product i s consi dered a reporter user.

Any user that i s assi gned pri vi l eges outsi de of the R eporter product
automati cal l y becomes Intel l i gence user.

The correct pri vi l eges must be assi gned to users i n order to

di fferenti ate betw een the user types i n the C ompl i ance dossi er.

384 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Auditing Your System for the Proper Licenses

Li cense Manager counts the number of l i censes based on the number
of users w i th at l east one pri vi l ege for a gi ven product. The
Admi ni strator user that i s created by defaul t w i th the reposi tory i s not
consi dered i n the count.

To audi t your system, perform the procedure bel ow on each server

machi ne i n your system.

In rare c as es , an audit c an fail if y our metadata is too large for the J av a

Virtual Mac hine heap s iz e. For s teps to modify the J av a Virtual Mac hine
heap s iz e in y our s y s tem regis try s ettings , s ee Mic roStrategy Tec h
Notes TN6446 and TN30885.

If y ou are us ing Lic ens e Manager on the phy s ic al mac hine on whic h
Intelligenc e Serv er is ins talled, and a three-tier projec t s ourc e does not

© 2019, M icr o St r at egy In c. 385

Syst em Ad m in ist r at io n Gu id e

ex is t on that mac hine, y ou c annot log in to the s erv er. To audit y our
lic ens es in this c as e, y ou mus t firs t c reate a three-tier projec t s ourc e
pointing to the Intelligenc e Serv er. You c an us e either Mic roStrategy
Configuration Wiz ard or Dev eloper's Projec t Sourc e Manager to c reate
this projec t s ourc e.

To Audit Your MicroStrategy Licenses

1. Open Mi croStrategy Li cense Manager. For i nstructi ons, see

U si ng Li cense Manager, page 375.

In c ommand line mode, the s teps to audit lic ens es v ary from thos e
below. Refer to the Lic ens e Manager c ommand line prompts to
guide y ou through the s teps to audit lic ens es .

2. On the A udit tab, expand the Intel l i gence Server fol der.

3. D oubl e-cl i ck a proj ect source name (PSN ).

4. Type your Mi croStrategy l ogi n and passw ord for the sel ected
Intel l i gence Server and cl i ck C onnect. If you are i n compl i ance,
a message appears noti fyi ng you that you are i n compl i ance w i th
your softw are l i cense agreement. C l i ck OK .

5. Sel ect the Everyone group and cl i ck A udit. A fol der tree of the
assi gned l i censes i s l i sted i n the N umber of licenses pane.

6. U sers w i th no product-based pri vi l eges are l i sted under U sers

without license association.

7. C ount the number of l i censes per product for enabl ed users.

D i sabl ed users do not count agai nst the l i censed user total , and
shoul d not be counted i n your audi t.

8. C l i ck Print.

386 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

9. For detai l ed i nformati on, cl i ck R eport to create and vi ew XML,

H TML, and C SV reports. You can al so have the report di spl ay al l
pri vi l eges for each user based on the l i cense type. To do thi s,
sel ect the Show U ser Privileges in R eport check box.

10. Total the number of users w i th each l i cense across al l machi nes.

Updating Your License

If you need to update a l i cense and you recei ve a new l i cense key
from Mi croStrategy, use the Li cense Manager to perform the upgrade.
If you have l i censes based on the number of C PU s bei ng used, you
can al so use the update process to change the number of C PU s bei ng
used by a gi ven product. For compl ete detai l s on performi ng an
upgrade i n your envi ronment, see the U pgrade Gui de.

You must update your l i cense key on al l machi nes w here

Mi croStrategy products are i nstal l ed. Li cense Manager updates the
l i cense i nformati on for the products that are i nstal l ed on that machi ne.

To Update a MicroStrategy License

1. Acqui re a new l i cense key from Mi croStrategy.

2. Open Mi croStrategy Li cense Manager. For i nstructi ons, see

U si ng Li cense Manager, page 375.

In c ommand line mode, the s teps to update y our lic ens e v ary from
thos e below. Refer to the Lic ens e Manager c ommand line prompts
to guide y ou through the s teps to update y our lic ens e.

3. On the License A dministration tab, sel ect the U pdate local

license key opti on and cl i ck N ext.

4. Type or paste the new key i n the N ew License K ey fi el d and

cl i ck N ext.

© 2019, M icr o St r at egy In c. 387

Syst em Ad m in ist r at io n Gu id e

If y ou hav e one or more produc ts that are lic ens ed bas ed on CPU
us age, the U pgrade window opens , s howing the max imum
number of CPUs eac h produc t is lic ens ed to us e on that mac hine.
You c an c hange thes e numbers to fit y our lic ens e agreement. For
ex ample, if y ou purc has e a lic ens e that allows more CPUs to be
us ed, y ou c an inc reas e the number of CPUs being us ed by a
produc t.

5. The resul ts of the upgrade are show n i n the U pgrade R esul ts

di al og box. Li cense Manager can automati cal l y request an
Acti vati on C ode for your l i cense after you update.

6. If you have updated your l i cense i nformati on, restart Intel l i gence
Server after the update. Thi s al l ow s the system to recogni ze the
l i cense key update and system behavi or can return to normal .

Updating CPU Affinity

D ependi ng on the number of C PU -based l i censes you purchase, you
can have mul ti pl e processors (C PU s) runni ng Intel l i gence Server and
Mi croStrategy Web. The abi l i ty to depl oy Intel l i gence Server or
Mi croStrategy Web on speci fi c, sel ected C PU s (a subset of the total
number of physi cal C PU s) on a gi ven machi ne i s cal l ed C PU affi ni ty
(or processor affi ni ty). As part of the i nstal l ati on process you must
provi de the number of processors to be used by Intel l i gence Server or
Mi croStrategy Web on that machi ne.

CPU Affinity for Intelligence Server on Windows

U pon i nstal l ati on, i f the target machi ne contai ns more than one
physi cal processor and the Mi croStrategy l i cense key al l ow s more
than one C PU to run Intel l i gence Server, you are prompted to provi de
the number of C PU s to be depl oyed. The upper l i mi t i s ei ther the
number of l i censed C PU s or the physi cal C PU count, w hi chever i s
l ow er.

388 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

After i nstal l ati on you can speci fy C PU affi ni ty through the

Mi croStrategy Servi ce Manager. Thi s requi res admi ni strator pri vi l eges
on the target machi ne.

To Change CPU Affinity Settings in Service Manager

1. On the machi ne w hose C PU affi ni ty you w ant to change, i n

Wi ndow s, go to Start > A ll Programs > MicroStrategy Tools >
Service Manager.

2. From the Service drop-dow n l i st, sel ect MicroStrategy

Intelligence Server.

3. C l i ck Options.

4. Sel ect the Intelligence Server Options tab.

5. In the Processor U sage secti on, sel ect w hi ch processors

Intel l i gence Server shoul d use.

6. C l i ck OK .

CPU Affinity for Intelligence Server on Linux

C PU affi ni ty behaves i n a si mi l ar manner i n both Wi ndow s and Li nux
envi ronments. Thi s secti on descri bes detai l s for setti ng up C PU
affi ni ty for runni ng Intel l i gence Server i n a Li nux envi ronment.

The abi l i ty to set C PU affi ni ty on Li nux requi res speci al system-l evel
pri vi l eges. Mi croStrategy must be run under the root Li nux account,
otherw i se an error message appears.

If the target machi ne contai ns more than one physi cal processor and
the Mi croStrategy l i cense key al l ow s more than one C PU to run
Intel l i gence Server U ni versal Edi ti on, you are prompted to provi de the
number of C PU s to be depl oyed. The upper l i mi t i s ei ther the number
of l i censed C PU s or the physi cal C PU count, w hi chever i s l ow er.

© 2019, M icr o St r at egy In c. 389

Syst em Ad m in ist r at io n Gu id e

Each Li nux pl atform exposes i ts ow n set of functi onal i ty to bi nd

processes to processors. H ow ever, Li nux al so provi des commands to
easi l y change the processor assi gnments. As a resul t, Intel l i gence
Server peri odi cal l y checks i ts ow n C PU affi ni ty and takes steps
w henever the C PU affi ni ty mask does not match the overal l C PU
l i censi ng. Whenever your l i censes do not match your depl oyment,
C PU affi ni ty i s automati cal l y adj usted to the number of C PU s
necessary to be accurate agai n.

Thi s automati c adj ustment for C PU affi ni ty attempts to appl y the

user's speci fi ed C PU affi ni ty val ue w hen i t adj usts the system, but i t
may not al w ays be abl e to do so dependi ng on the avai l abi l i ty of
processors. For exampl e, i f you ow n tw o C PU l i censes and C PU
affi ni ty i s manual l y set to use Processor 1 and Processor 2, the C PU
affi ni ty adj ustment may reset C PU usage to Processor 0 and
Processor 1 w hen the system i s automati cal l y adj usted.

Ch an gin g CPU Af f in it y in Lin u x

You can speci fy C PU affi ni ty ei ther through the Mi croStrategy Servi ce
Manager, or by modi fyi ng Intel l i gence Server opti ons. If you w ant to
vi ew and modi fy Intel l i gence Server's opti ons, i t must be regi stered as
a servi ce. You can regi ster Intel l i gence Server as a servi ce usi ng the
C onfi gurati on Wi zard by sel ecti ng the R egi ster Intel l i gence Server as
a Servi ce opti on; al ternati vel y, you can fol l ow the procedure bel ow .

To Set Up Intelligence Server to Run as a Service

1. N avi gate to the b i n di rectory i n the i nstal l ati on l ocati on.

2. Type the fol l ow i ng command:

ms tr ct l - s I n t e l l i g e n c e S e r v e r N a m e r s

Whenever you change the C PU affi ni ty, you must restart the machi ne.

390 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

CPU Affinity for MicroStrategy Web

If you have C PU -based l i censes for Mi croStrategy Web, the C PU
affi ni ty feature al l ow s you to match your C PU s and l i censes by
choosi ng w hi ch processors Mi croStrategy Web uses on a gi ven
machi ne.

This feature is only av ailable in the ASP.NET v ers ion of Mic roStrategy
Web.

Thi s secti on descri bes setti ngs that may i nteract w i th C PU affi ni ty that
you must consi der, and provi des steps to update C PU affi ni ty i n your
envi ronment.

CPU Af f in it y an d IIS
Before confi guri ng C PU affi ni ty for Mi croStrategy Web, you shoul d
understand how the C PU affi ni ty setti ng behaves on di fferent
confi gurati ons of IIS, and how i t i nteracts w i th other IIS setti ngs such
as the Web Garden mode.

IIS Versions

C PU affi ni ty can be confi gured on machi nes runni ng IIS 6.0 or 7.0.
The overal l behavi or depends on how IIS i s confi gured. The fol l ow i ng
cases are consi dered:

l Worker process isolation mode: In thi s mode, the C PU affi ni ty

setti ng i s appl i ed at the appl i cati on pool l evel . When Mi croStrategy
Web C PU affi ni ty i s enabl ed, i t i s appl i ed to al l ASP.N ET
appl i cati ons runni ng i n the same appl i cati on pool . By defaul t,
Mi croStrategy Web runs i n i ts ow n appl i cati on pool . The C PU
affi ni ty setti ng i s shared by al l i nstances of Mi croStrategy Web on a
gi ven machi ne. Worker process i sol ati on mode i s the defaul t mode

© 2019, M icr o St r at egy In c. 391

Syst em Ad m in ist r at io n Gu id e

of operati on on IIS 6.0 w hen the machi ne has not been upgraded
from an ol der versi on of Wi ndow s.

l IIS 5.0 compatibility mode: In thi s mode, al l ASP.N ET appl i cati ons
run i n the same process. Thi s means that w hen Mi croStrategy Web
C PU affi ni ty i s enabl ed, i t i s appl i ed to al l ASP.N ET appl i cati ons
runni ng on the Web server machi ne. A w arni ng i s di spl ayed before
i nstal l ati on or before the C PU affi ni ty tool (descri bed bel ow )
attempts to set the C PU affi ni ty on a machi ne w i th IIS runni ng i n IIS
5.0 compati bi l i ty mode.

This is the default mode of operation when the mac hine has been
upgraded from an older v ers ion of Windows .

Web Garden Mode

Both IIS 6.0 and IIS 7.0 support a "Web Garden" mode, i n w hi ch IIS
creates some number of processes, each w i th affi ni ty to a si ngl e C PU ,
i nstead of creati ng a si ngl e process that uses al l avai l abl e C PU s. The
admi ni strator speci fi es the total number of C PU s that are used. The
Web Garden setti ngs can i nteract w i th and affect Mi croStrategy C PU
affi ni ty.

The Web Garden s etting s hould not be us ed with Mic roStrategy Web. At
runtime, the Mic roStrategy Web CPU affinity s etting is applied after IIS
s ets the CPU affinity for the Web Garden feature. Us ing thes e s ettings
together c an produc e unintended res ults .

In both IIS 6.0 and IIS 7.0, the Web Garden feature i s di sabl ed by
defaul t.

C PU affi ni ty i nteracti on depends on how IIS i s confi gured, as

descri bed bel ow :

392 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l In w orker process i sol ati on mode, the Web Garden setti ng i s

appl i ed at the appl i cati on pool l evel . You speci fy the number of
C PU s to be used. A gi ven number of C PU s are speci fi ed, and IIS
creates that number of w 3 w p . e x e i nstances. Each of the i nstances
runs al l of the ASP.N ET appl i cati ons associ ated w i th the
appl i cati on pool . The Web Garden feature i s confi gured through the
appl i cati on pool setti ngs. For more i nformati on, refer to your IIS
documentati on.

l In IIS 5.0 compati bi l i ty mode, a si ngl e setti ng affects al l ASP.N ET

appl i cati ons. The Web Garden feature i s enabl ed or di sabl ed usi ng
the WebGarden and cpuMask attri butes under the processModel
node i n machi ne.confi g. A gi ven number of C PU s are speci fi ed i n
the mask, and IIS creates that number of a s p n e t _w p . e x e
i nstances. Each of these i nstances runs the ASP.N ET appl i cati ons.
For more i nformati on, refer to your IIS documentati on.

IIS prov ides metabas e properties (SMPAffinitiz ed and

SMPProc es s orAffinity Mas k ) to determine the CPU affinity for a giv en
applic ation pool. Do not us e thes e s ettings in c onjunc tion with the
Mic roStrategy Web CPU affinity s etting.

Up d at in g CPU Af f in it y Ch an ges
After Mi croStrategy Web i s i nstal l ed i n your envi ronment, you can
update Mi croStrategy Web's C PU affi ni ty usi ng a tool cal l ed
MAWe bA ff .e x e . Thi s tool i s l ocated i n the root di rectory of the
Mi croStrategy Web appl i cati on, w hi ch i s l ocated by defaul t at
C:\P ro gr am F i l e s ( x 8 6 ) \ M i c r o S t r a t e g y \ W e b A S P x. The
MAWe bA ff .e x e tool al l ow s you to choose the physi cal C PU s
Mi croStrategy Web can use. The number of C PU s that can be used
depends on the l i mi t speci fi ed by the l i cense.

The M AW eb Af f . e x e tool i s show n bel ow :

© 2019, M icr o St r at egy In c. 393

Syst em Ad m in ist r at io n Gu id e

The M AW eb Af f . e x e tool l i sts each physi cal C PU on a machi ne. You

can add or remove C PU s or di sabl e C PU affi ni ty usi ng the associ ated
check boxes. C l eari ng al l check boxes prevents the Mi croStrategy
Web C PU affi ni ty setti ng from overri di ng any IIS-rel ated C PU affi ni ty
setti ngs.

To Update CPU Affinity

1. D oubl e-cl i ck the M A W e b A f f . e x e tool to open the C PU affi ni ty

tool .

2. Sel ect or cl ear the check boxes for each processor as desi red.

3. C l i ck A pply or cl i ck OK .

4. R estart IIS to appl y your C PU affi ni ty changes.

394 © 2019, M icr o St r at egy In c.

 6
M ANAGING YOUR
PROJECTS

© 2019, M icr o St r at egy In c. 395

Syst em Ad m in ist r at io n Gu id e

In a Mi croStrategy system, a proj ect i s the envi ronment i n w hi ch

reporti ng i s done. A proj ect:

l D etermi nes the set of data w arehouse tabl es to be used, and

therefore the set of data avai l abl e to be anal yzed.

l C ontai ns al l schema obj ects used to i nterpret the data i n those

tabl es. Schema obj ects i ncl ude obj ects such as facts, attri butes,
and hi erarchi es.

l C ontai ns al l appl i cati on obj ects used to create reports and anal yze
the data. Appl i cati on obj ects i ncl ude obj ects such as reports,
metri cs, and fi l ters.

l D efi nes the securi ty scheme for the user communi ty that accesses
these obj ects. Securi ty obj ects i ncl ude obj ects such as securi ty
rol es, pri vi l eges, and access control l i sts.

The recommended methodol ogy and tool s for managi ng proj ects i n
the Mi croStrategy system i ncl ude:

l The Proj ect Li fe C ycl e, page 397

l Impl ementi ng the R ecommended Li fe C ycl e, page 403

l D upl i cati ng a Proj ect, page 405

l U pdati ng Proj ects w i th N ew Obj ects, page 413

l C opyi ng Obj ects Betw een Proj ects: Obj ect Manager, page 417

l Mergi ng Proj ects to Synchroni ze Obj ects, page 467

l C ompari ng and Tracki ng Proj ects, page 477

l D el eti ng U nused Schema Obj ects: Managed Obj ects, page 481

For i nformati on about creati ng a proj ect, creati ng attri butes and facts,
bui l di ng a l ogi cal data model , and other proj ect desi gn tasks, see the
Proj ect D esi gn Gui de.

396 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

The Project Life Cycle

A Mi croStrategy busi ness i ntel l i gence appl i cati on consi sts of many
obj ects w i thi n proj ects. These obj ects are ul ti matel y used to create
reports that di spl ay data to the end user. As i n other softw are
systems, these obj ects shoul d be devel oped and tested before they
can be used i n a producti on system. We cal l thi s process the proj ect
l i fe cycl e. Thi s secti on di scusses several proj ect l i fe cycl e scenari os
and the tool s you can use to i mpl ement them.

In many c as es , an applic ation c ons is ts of a s ingle projec t deliv ered to

an end us er. Mic roStrategy OEM dev elopers may c hoos e to bundle
s ev eral projec ts together to mak e a s ingle applic ation.

l For a descri pti on of the recommended scenari o, see R ecommended

Scenari o: D evel opment, Test, and Producti on, page 397

l For a real -l i fe scenari o, see R eal -Li fe Scenari o: N ew Versi on From

a Proj ect D evel oper, page 401

l For detai l s on how to i mpl ement the proj ect l i fe cycl e i n your
Mi croStrategy envi ronment, see Impl ementi ng the R ecommended
Li fe C ycl e, page 403

Recommended Scenario: Development, Test, and

Production
Thi s commonl y used scenari o i s the proj ect l i fe cycl e that
Mi croStrategy recommends you use as you devel op your proj ects. In
thi s scenari o, you typi cal l y use three envi ronments: devel opment,
test, and producti on. Each envi ronment contai ns a Mi croStrategy
proj ect.

Mi croStrategy recommends that i f you w ant to copy obj ects betw een
tw o proj ects, such as from the devel opment proj ect to the test proj ect,
those proj ects shoul d be rel ated. Tw o proj ects are consi dered to be

© 2019, M icr o St r at egy In c. 397

Syst em Ad m in ist r at io n Gu id e

rel ated i f one w as ori gi nal l y a dupl i cate of the other. To establ i sh
di fferent devel opment, test, and producti on proj ects, for exampl e, you
can create the test proj ect by copyi ng the devel opment proj ect, and
you can create the producti on proj ect by copyi ng the test proj ect. Al l
three of these proj ects are rel ated to each other. For more i nformati on
about dupl i cati ng a proj ect, see D upl i cati ng a Proj ect, page 405.

Thi s scenari o i s show n i n the di agram bel ow i n w hi ch obj ects i terate

betw een the devel opment and test proj ects unti l they are ready for
general users. Once ready, they are promoted to the producti on
proj ect.

Th e Develo p men t Pr o ject

In the devel opment envi ronment proj ect, you create obj ects. Thi s may
be a proj ect i n w hi ch devel opers w ork. They thi nk about the desi gn of
the w hol e system as they create the proj ect's schema and appl i cati on
obj ects. For detai l ed i nstructi ons on how to desi gn a proj ect schema
and create appl i cati on obj ects, see the Proj ect D esi gn Gui de.

Th e Test Pr o ject
Once the obj ects' defi ni ti ons have stabi l i zed, you move them to a test
proj ect that a w i der set of peopl e can use for testi ng. You may have
peopl e run through scri pts or typi cal usage scenari os that users at
your organi zati on commonl y perform. The testers l ook for accuracy
(are the numbers i n the reports correct?), stabi l i ty (di d the obj ects
w ork? do thei r dependent obj ects w ork?), and performance (di d the
obj ects w ork effi ci entl y, not produci ng overl oad on the data
w arehouse?).

398 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

In thi s test envi ronment, you w ant the proj ect to i ni ti al l y connect to a
devel opment data w arehouse for i ni ti al testi ng. Later, for more
stri ngent testi ng, connect the test proj ect to the producti on data
w arehouse. If obj ects need further w ork, they are changed i n the
devel opment proj ect and recopi ed to the test proj ect, but not changed
i n the test proj ect.

Th e Pr o d u ct io n Pr o ject
After the obj ects have been tested and show n to be ready for use i n a
system accessi bl e to al l users, you copy them i nto the producti on
proj ect. Thi s i s the proj ect used by most of the peopl e i n your
company. It provi des up-to-date reports and tracks vari ous busi ness
obj ecti ves.

Imp lemen t in g t h e Reco mmen d ed Scen ar io

When mi grati ng changes i nto a testi ng or devel opment envi ronment,
be as thorough as possi bl e. C areful l y consi der how your busi ness
users w i l l access and use thei r appl i cati on, reports, and dossi ers on a
dai l y basi s. Anti ci pate the needs of your busi ness users, and test
every type of scenari o before offi ci al l y mi grati ng to a producti on
envi ronment.

To set up the devel opment, test, and producti on proj ects so that they
al l have rel ated schemas, you need to fi rst create the devel opment
proj ect. For i nstructi ons on how to create a proj ect, see the Proj ect
D esi gn Gui de. Once the devel opment proj ect has been created, you
can dupl i cate i t to create the test and producti on proj ects usi ng the
Proj ect D upl i cati on Wi zard. For detai l ed i nformati on about the Proj ect
D upl i cati on Wi zard, see D upl i cati ng a Proj ect, page 405.

Once the proj ects have been created, you can mi grate speci fi c
obj ects betw een them vi a Obj ect Manager. For exampl e, after a new
metri c has been created i n the devel opment proj ect, you can copy i t to

© 2019, M icr o St r at egy In c. 399

Syst em Ad m in ist r at io n Gu id e

the test proj ect. For detai l ed i nformati on about Obj ect Manager, see
C opyi ng Obj ects Betw een Proj ects: Obj ect Manager, page 417.

You can al so merge tw o rel ated proj ects w i th the Proj ect Merge
Wi zard. Thi s i s useful w hen you have a l arge number of obj ects to
copy. The Proj ect Merge Wi zard copi es al l the obj ects i n a gi ven
proj ect to another proj ect. For an exampl e of a si tuati on i n w hi ch you
w oul d w ant to use the Proj ect Merge Wi zard, see R eal -Li fe Scenari o:
N ew Versi on From a Proj ect D evel oper, page 401. For detai l ed
i nformati on about Proj ect Merge, see Mergi ng Proj ects to Synchroni ze
Obj ects, page 467.

To help y ou dec ide whether y ou s hould us e Objec t Manager or Projec t

merge, s ee C ompari ng Proj ect Merge to Obj ect Manager, page
415 .

The Proj ect C ompari son Wi zard can hel p you determi ne w hat obj ects
i n a proj ect have changed si nce your l ast update. You can al so save
the resul ts of search obj ects and use those searches to track the
changes i n your proj ects. For detai l ed i nformati on about the Proj ect
C ompari son Wi zard, see C ompari ng and Tracki ng Proj ects, page 477.
For i nstructi ons on how to use search obj ects to track changes i n a
proj ect, see Tracki ng Your Proj ects w i th the Search Export Feature,
page 479.

Integri ty Manager hel ps you ensure that your changes have not
caused any probl ems w i th your reports. Integri ty Manager executes
some or al l of the reports i n a proj ect, and can compare them agai nst
another proj ect or a previ ousl y establ i shed basel i ne. For detai l ed
i nformati on about Integri ty Manager, see C hapter 16, Veri fyi ng
R eports and D ocuments w i th Integri ty Manager.

400 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Real-Life Scenario: New Version From a Project

Developer
In thi s scenari o, you have i ni ti al l y purchased a proj ect from a vendor
w hose products are speci al i zed for anal yzi ng sal es data. Thi s i s
proj ect versi on 1. Over the course of ti me, your devel opers have
customi zed obj ects i n the proj ect, resul ti ng i n w hat you cal l ed versi on
1.1 and l ater, versi on 1.2., and so on. N ow you have purchased
versi on 2 of the proj ect from the same vendor, and you w ant to merge
the new (Versi on 2) proj ect w i th your exi sti ng (Versi on 1.2) proj ect.

Mic roStrategy enc ourages v endors in thes e s ituations to inc lude in the
ins tallation of v ers ion 2 an "automatic " upgrade to the projec t us ing
Projec t Merge. In this way the v endor, rather than the us er or purc has er,
c an c onfigure the rules for this projec t merge. For information about
ex ec uting Projec t Merge without us er input, s ee Mergi ng Proj ects w i th
the Proj ect Merge Wi zard, page 469 .

Thi s combi nati on of the tw o proj ects creates Proj ect versi on 2.1, as
show n i n the di agram bel ow .

© 2019, M icr o St r at egy In c. 401

Syst em Ad m in ist r at io n Gu id e

The vendor's new Versi on 2 proj ect has new obj ects that are not i n
yours, w hi ch you feel confi dent i n movi ng over. But some of the
obj ects i n the Versi on 2 proj ect may confl i ct w i th obj ects that you had
customi zed i n the Versi on 1.2 proj ect. H ow do you determi ne w hi ch of
the Versi on 2 obj ects you w ant move i nto your system, or w hi ch of
your Versi on 1.2 obj ects to modi fy?

You coul d perform thi s merge obj ect-by-obj ect and mi grate them
manual l y usi ng Obj ect Manager, but thi s w i l l be ti me-consumi ng i f the
proj ect i s l arge. It may be more effi ci ent to use the Proj ect Merge tool .
Wi th thi s tool , you can defi ne rul es for mergi ng proj ects that hel p you
i denti fy confl i cti ng obj ects and handl e them a certai n w ay. Proj ect
Merge then appl i es those rul es w hi l e mergi ng the proj ects. For more
i nformati on about usi ng the Mi croStrategy Proj ect Merge tool , see
Mergi ng Proj ects to Synchroni ze Obj ects, page 467.

402 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Implementing the Recommended Life Cycle

The fol l ow i ng secti on provi des a hi gh-l evel , si mpl i fi ed overvi ew of the
procedure for i mpl ementi ng the recommended proj ect l i fe cycl e i n
your company's Mi croStrategy envi ronment. Thi s i s a si mpl i fi ed
versi on of the w orkfl ow you are l i kel y to see at your organi zati on.
H ow ever, you shoul d be abl e to appl y the basi c pri nci pl es to your
speci fi c si tuati on.

1. C reate the devel opment proj ect.

C reati ng the devel opment proj ect i nvol ves setti ng up the
database connecti ons and proj ect schema, confi guri ng user
securi ty, and bui l di ng the i ni ti al schema and appl i cati on obj ects.
For i nformati on on creati ng a proj ect, see the Proj ect D esi gn
Gui de.

2. C reate the test and producti on proj ects by dupl i cati ng the
devel opment proj ect.

Mi croStrategy recommends that you dupl i cate the devel opment

proj ect to create the test and producti on proj ects, rather than
creati ng them separatel y. D upl i cati ng ensures that al l three
proj ects have rel ated schemas, enabl i ng you to safel y use Obj ect
Manager or Proj ect Merge to copy obj ects betw een the proj ects.

For i nstructi ons on how to dupl i cate a proj ect, see D upl i cati ng a
Proj ect, page 405.

3. C reate obj ects i n the devel opment proj ect.

In the recommended scenari o, al l obj ects (attri butes, metri cs,

reports) are created i n the devel opment proj ect, and then
mi grated to the other proj ects. For more i nformati on about the
devel opment proj ect, see R ecommended Scenari o:
D evel opment, Test, and Producti on, page 397.

© 2019, M icr o St r at egy In c. 403

Syst em Ad m in ist r at io n Gu id e

For i nstructi ons on creati ng schema obj ects, see the Proj ect
D esi gn Gui de. For i nstructi ons on creati ng appl i cati on obj ects,
see the Basi c R eporti ng Gui deand Advanced R eporti ng Gui de.

4. Mi grate obj ects from the devel opment proj ect to the test proj ect.

Once the obj ects have been created and are rel ati vel y stabl e,
they can be mi grated to the test proj ect for testi ng. For
i nstructi ons on how to mi grate obj ects, see U pdati ng Proj ects
w i th N ew Obj ects, page 413.

D ependi ng on the number of obj ects you have created or

changed, you can use ei ther Obj ect Manager or Proj ect Merge to
copy the obj ects from the devel opment proj ect to the test proj ect.
For a compari son of the tw o tool s, see C ompari ng Proj ect Merge
to Obj ect Manager, page 415. For a tool to determi ne w hat
obj ects have changed, see C ompari ng and Tracki ng Proj ects,
page 477.

5. Test the new obj ects.

Testi ng i nvol ves maki ng sure that the new obj ects produce the
expected resul ts, do not cause data errors, and do not put undue
strai n on the data w arehouse. If the obj ects are found to contai n
errors, these errors are reported to the devel opment team so that
they can be fi xed and tested agai n. For more i nformati on about
the test proj ect, see R ecommended Scenari o: D evel opment,
Test, and Producti on, page 397.

Integri ty Manager i s an i nval uabl e tool i n testi ng w hether new

obj ects cause reports to generate di fferent resul ts. For detai l ed
i nformati on about Integri ty Manager, see C hapter 16, Veri fyi ng
R eports and D ocuments w i th Integri ty Manager.

404 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

6. Mi grate obj ects from the test proj ect to the producti on proj ect.

Once the obj ects have been thoroughl y tested, they can be
mi grated to the producti on proj ect and put i nto ful l use. For
i nstructi ons on how to mi grate obj ects, see U pdati ng Proj ects
w i th N ew Obj ects, page 413.

7. R epeat steps 3 through 6 as necessary.

The proj ect l i fe cycl e does not end w i th the fi rst mi grati on of new
obj ects i nto the producti on proj ect. A devel oper may come up w i th a
new w ay to use an attri bute i n a metri c, or a manager may request a
speci fi c new report. These obj ects pass through the proj ect l i fe cycl e
i n the same w ay as the proj ect's i ni ti al obj ects.

Duplicating a Project
D upl i cati ng a proj ect i s an i mportant part of the appl i cati on l i fe cycl e.
If you w ant to copy obj ects betw een tw o proj ects, Mi croStrategy
recommends that the proj ects have rel ated schemas. Thi s means that
one must have ori gi nal l y been a dupl i cate of the other, or both must
have been dupl i cates of a thi rd proj ect.

Autos ty les , whic h giv e a uniform appearanc e to reports , c an be freely

mov ed between projec ts regardles s of whether their s c hemas are
related. For ins truc tions on migrating autos ty les between projec ts , s ee
the Advanced R eporti ng Gui de .

Proj ect dupl i cati on i s done usi ng the Proj ect D upl i cati on Wi zard. For
detai l ed i nformati on about the dupl i cati on process, i ncl udi ng step-by-
step i nstructi ons, see The Proj ect D upl i cati on Wi zard, page 408.

To migrate a projec t from a Mic ros oft Ac c es s databas e to another

databas e platform, y ou mus t us e the Projec t Mov er Wiz ard. For detailed
information about this migration, s ee Mi grati ng a Proj ect to a N ew
D atabase Pl atform, page 411 .

© 2019, M icr o St r at egy In c. 405

Syst em Ad m in ist r at io n Gu id e

You can dupl i cate a Mi croStrategy proj ect i n one of the fol l ow i ng
w ays:

l From a three-ti er (server) proj ect source to a three-ti er (server)

proj ect source

l From a three-ti er (server) proj ect source to a tw o-ti er (di rect) proj ect
source

l From a tw o-ti er (di rect) proj ect source to a tw o-ti er (di rect) proj ect
source

l From a tw o-ti er (di rect) proj ect source to a three-ti er (server) proj ect
source

A server (three-ti er) proj ect source i s connected to an Intel l i gence

Server, and has the ful l range of admi ni strati ve opti ons avai l abl e. A
di rect (tw o-ti er) proj ect source i s not connected to an Intel l i gence
Server. For more i nformati on on three-ti er and tw o-ti er proj ect
sources, see the Proj ect D esi gn Gui de.

Do not refres h the warehous e c atalog in the des tination projec t. Refres h
the warehous e c atalog in the s ourc e projec t, and then us e Objec t
Manager to mov e the updated objec ts into the des tination projec t. For
information about the warehous e c atalog, s ee the Opti mi zi ng and
Mai ntai ni ng your Proj ect s ec tion in the Proj ect D esi gn Gui de .

What Objects are Duplicated with a Project?

When you dupl i cate a proj ect, al l schema obj ects (attri butes, facts,
hi erarchi es, and transformati ons) are dupl i cated. By defaul t al l
appl i cati on obj ects (reports, documents, metri cs, and so forth)
contai ned i n the proj ect are al so dupl i cated.

If you are copyi ng a proj ect to another proj ect source, you have the
opti on to dupl i cate confi gurati on obj ects as w el l . Speci fi cal l y:

406 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l You can choose w hether to dupl i cate al l confi gurati on obj ects, or
onl y the obj ects used by the proj ect.

l You can choose to dupl i cate al l users and groups, onl y the users
and groups used by the proj ect, no users and groups, or a custom
sel ecti on of users and groups.

l You can choose to dupl i cate user, contact, and subscri pti on
i nformati on.

For each type of confi gurati on obj ect (user/group, securi ty rol e,
schedul e, contact/contact group, database connecti on/i nstance,
database l ogi n) you must choose w hether to dupl i cate the obj ect i f i t
al ready exi sts i n the desti nati on proj ect source metadata. For
users/groups and securi ty rol es, you can al so choose to merge the
pri vi l eges of the source and desti nati on versi ons.

Duplicating Projects in Multiple Languages

When you dupl i cate a proj ect that contai ns w arehouse data i n
mul ti pl e l anguages, you have the opti on of dupl i cati ng al l , some, or
none of those l anguages. In addi ti on, you can sel ect the new defaul t
l anguage for the proj ect.

Whenever you dupl i cate a proj ect or update the metadata, a l anguage
check ensures that the l anguage setti ngs i n the C U R R EN T_U SER
regi stry key, the LOC AL_MAC H IN E regi stry key, and the Proj ect
l ocal e property al l match before an update takes pl ace. The l ocati on
of the Language key i s at \ S o f t w a r e \ M i c r o S t r a t e g y \ L a n g u ag e.
The system performs the fol l ow i ng checks:

l In a di rect (tw o-ti er) confi gurati on, w i thout an Intel l i gence Server,
the system checks that the l anguage under the LOC AL_MAC H IN E
regi stry key matches the l anguage under the C U R R EN T_U SER
regi stry key.

l In a server (three-ti er) confi gurati on, w i th an Intel l i gence Server, the
system checks that the l anguage under the C U R R EN T_U SER

© 2019, M icr o St r at egy In c. 407

Syst em Ad m in ist r at io n Gu id e

regi stry key on the cl i ent machi ne matches the l anguage under the
LOC AL_MAC H IN E regi stry key on the server machi ne.

The Mi croStrategy i nterface obtai ns the l anguage i nformati on from the

C U R R EN T_U SER regi stry key and the server obtai ns the l anguage
i nformati on from the LOC AL_MAC H IN E regi stry key. Thi s can l ead to
i nconsi stenci es i n the l anguage di spl ay. The l anguage check
prevents these i nconsi stenci es and ensures that the l anguage di spl ay
i s consi stent across the i nterface.

The i nternati onal i zati on setti ngs i n Obj ect Manager al l ow you to
create rel ated proj ects i n di fferent l anguages. For more i nformati on on
thi s process, see What happens w hen You C opy or Move an Obj ect,
page 425.

The Project Duplication Wizard

You shoul d al w ays use the Proj ect D upl i cati on Wi zard to dupl i cate
your proj ects. Thi s ensures that al l proj ect obj ects are dupl i cated
properl y, and that the new proj ect's schema i s i denti cal to the source
proj ect's schema.

To duplic ate a projec t, y ou mus t hav e the By pas s All Objec t Sec urity
Ac c es s Chec k s priv ilege for that projec t. In addition, y ou mus t hav e the
Create Sc hema Objec ts priv ilege for the target projec t s ourc e.

The fol l ow i ng hi gh-l evel procedure provi des an overvi ew of w hat the
Proj ect D upl i cati on Wi zard does. For an expl anati on of the
i nformati on requi red at any gi ven page i n the w i zard, see the H el p
(from the w i zard, cl i ck H elp, or press F1).

408 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

High-Level Steps to Duplicate a Project with the Project

Duplication Wizard

1. From Obj ect Manager sel ect the Project menu (or from
D evel oper sel ect the Schema menu), then sel ect D uplicate
Project.

2. Speci fy the proj ect source and proj ect i nformati on that you are
copyi ng from (the source).

3. Speci fy the proj ect source and proj ect i nformati on that you are
copyi ng to (the desti nati on).

4. Indi cate w hat types of obj ects to copy.

5. Speci fy w hether to keep or merge confi gurati on obj ect properti es

i f these al ready exi st i n the desti nati on proj ect source. For
exampl e, i f properti es such as passw ord expi rati on and so on are
di fferent by defaul t betw een the proj ect sources, w hi ch set of
properti es do you w ant to use?

6. Speci fy w hether you w ant to see the event messages as they

happen and, i f so, w hat types. Al so speci fy w hether to create l og
fi l es and, i f so, w hat types of events to l og, and w here to l ocate
the l og fi l es. By defaul t Proj ect D upl i cator show s you error
messages as they occur, and l ogs most events to a text fi l e. Thi s
l og fi l e i s created by defaul t i n C : \ P r o gr a m F i l e s
(x 86 )\ C o m m o n F i l e s \ M i c r o S t r a t e g y \.

Sch ed u lin g Pr o ject Du p licat io n

At the end of the Proj ect D upl i cati on Wi zard, you are gi ven the opti on
of savi ng your setti ngs i n an XML fi l e. You can l oad the setti ngs from
thi s fi l e l ater to speed up the proj ect dupl i cati on process. The setti ngs
can be l oaded at the begi nni ng of the Proj ect D upl i cati on Wi zard.

© 2019, M icr o St r at egy In c. 409

Syst em Ad m in ist r at io n Gu id e

You can al so use the setti ngs fi l e to run the w i zard i n command-l i ne
mode. The Proj ect D upl i cati on Wi zard command l i ne i nterface
enabl es you to dupl i cate a proj ect w i thout havi ng to l oad the
graphi cal i nterface, or to schedul e a dupl i cati on to run at a speci fi c
ti me. For exampl e, you may w ant to run the proj ect dupl i cati on i n the
eveni ng, w hen the l oad on Intel l i gence Server i s l essened. You can
create an XML setti ngs fi l e, and then use the Wi ndow s A T command
or the U ni x schedul er to schedul e the dupl i cati on to take pl ace at
ni ght.

To Duplicate a Project from the Command Line

After savi ng the setti ngs from the Proj ect D upl i cati on Wi zard, i nvoke
the Proj ect D upl i cati on Wi zard executabl e
Proj ec tD up l i c a t e . e x e. By defaul t thi s executabl e i s l ocated i n
C:\P ro gr am F i l e s ( x 8 6 ) \ C o m m o n F i l e s \ M i c r o S t r a t e g y.

The syntax i s:

ProjectDuplicate.exe -f Path\XMLFilename [-sp

SourcePassword] [-dp DestinationPassword] [-sup] [-md] [-
dn OverwriteName]

Where:

l Pa th i s the path to the saved XML setti ngs fi l e.

l XM LF il en a m e i s the name of the saved XML setti ngs fi l e.

l So ur ce Pa s s w o r d i s the passw ord for the source proj ect's proj ect
source.

l Ta rg et Pa s s w o r d i s the passw ord for the desti nati on proj ect's

proj ect source.

l -s up i ndi cates that feedback messages w i l l be suppressed (si l ent

mode).

410 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l -m d i ndi cates that the metadata of the desti nati on proj ect source
w i l l be updated i f i t i s ol der than the source proj ect source's
metadata.

l -d n O ve rw r i t e N a m e speci fi es the name of the desti nati on

proj ect. Thi s overri des the name speci fi ed i n the XML setti ngs fi l e.

For i nformati on on the syntax for the Wi ndow s A T command or a U N IX

schedul er, see the documentati on for your operati ng system.

Migrating a Project to a New Database Platform

The Proj ect Mover Wi zard gui des you through the process of
mi grati ng a Mi croStrategy proj ect from a Mi crosoft Access database to
a new database pl atform. Thi s can be useful for creati ng and testi ng a
new proj ect before i t i s pl aced i n the producti on database.

For exampl e, a busi ness anal yst has an i dea for a new busi ness
i ntel l i gence appl i cati on usi ng Mi croStrategy. The anal yst needs to
create a proof-of-concept proj ect to show thei r manager. The proj ect
w i l l eventual l y be used i n the devel opment and producti on
envi ronment, but the system admi ni strator mi ght deci de that i t i s not
i deal to create the demo proj ect i n the producti on database. Instead
the anal yst puts the proj ect together on thei r l aptop, usi ng a l ocal
Mi crosoft Access database. Once she demonstrates the proj ect and
recei ves approval for i t, the admi ni strator can use the Proj ect Mover
Wi zard to move the proj ect from the l aptop's Access database i nto the
devel opment envi ronment's database pl atform.

The fol l ow i ng hi gh-l evel procedure provi des an overvi ew of w hat the
Proj ect Mover Wi zard does. For an expl anati on of the i nformati on
requi red at any gi ven page i n the w i zard, see the H el p (from the
w i zard, cl i ck H elp, or press F1).

The projec t mus t be c ontained in a Mic ros oft Ac c es s databas e.

© 2019, M icr o St r at egy In c. 411

Syst em Ad m in ist r at io n Gu id e

To migrate a projec t to a new databas e platform, y ou mus t hav e the By pas s

All Objec t Sec urity Ac c es s Chec k s priv ilege for that projec t.

The s ourc e projec t and des tination projec t s ourc e mus t be the s ame
v ers ion of Mic roStrategy metadata. For ex ample, if y ou hav e updated the
des tination projec t s ourc e to the lates t v ers ion of Mic roStrategy , y ou mus t
als o update the s ourc e projec t before us ing Projec t Mov er to migrate it. For
information about updating a projec t's metadata, s ee the U pgrade Gui de .

To Migrate a Project to a Different Database

1. From the Wi ndow s Start menu, poi nt to A ll Programs, then

MicroStrategy Tools, and then sel ect Project Mover.

2. Sel ect the Mi crosoft Access w arehouse and metadata databases

that contai n the source proj ect, and then sel ect the source
proj ect.

3. Sel ect any SQL scri pts you w ant to run on the data w arehouse,
ei ther before or after proj ect mi grati on.

4. Sel ect the database i nto w hi ch the proj ect i s to be mi grated.

5. If proj ect metadata al ready exi sts i n the desti nati on database,
sel ect w hether to append the mi grated proj ect to the exi sti ng
data, or overw ri te that data.

6. R evi ew your choi ces and cl i ck Finish.

Migr at in g a Pr o ject Au t o mat ically

In addi ti on to accepti ng user i nput and then i mmedi atel y movi ng a
proj ect, the Proj ect Mover Wi zard can record your i nput i n a response
fi l e. Thi s fi l e contai ns al l the i nformati on needed to move a proj ect to
a new database pl atform, and can be l ater used to move a proj ect
w i thout any addi ti onal user i nput. Thi s i s especi al l y useful for

412 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

schedul i ng a proj ect mi grati on for a ti me w hen there are not many
users on the system.

To create a response fi l e, from the fi rst page of the Proj ect Mover
Wi zard cl i ck A dvanced. On the Advanced Opti ons page, sel ect
Generate a response file and enter the name and l ocati on of the new
response fi l e i n the text fi el d.

To execute a response fi l e from the Proj ect Mover Wi zard, from the
fi rst page of the w i zard cl i ck A dvanced. Then sel ect the U se
R esponse File opti on and l oad the response fi l e. The Wi zard opens
the Summary page, w hi ch l i sts al l the opti ons set by the response fi l e.
After revi ew i ng these opti ons, cl i ck Finish. The Proj ect Mover Wi zard
begi ns movi ng the proj ect.

To execute a response fi l e from the command l i ne, you need to i nvoke

the Proj ect Mover executabl e, d e m o m o v e r . e x e. By defaul t, thi s
di rectory i s C : \ P r o g r a m F i l e s ( x 8 6 ) \ C o m m o n
File s\ Mi cr o S t r a t e g y.

The syntax i s:

demomover.exe -r "File Location\Filename.ini"

w here "Fi le L o c a t i o n" i s the path to the response fi l e and

"Fil en am e. i n i " i s the name of the response fi l e.

Updating Projects with New Objects

When you create or modi fy an obj ect i n your devel opment
envi ronment, you eventual l y need to copy that obj ect to the test
proj ect, and l ater to the producti on proj ect.

For exampl e, a devel oper creates a new metri c i n the devel opment
proj ect. Once the metri c i s ready to be tested, i t needs to be present
i n the test proj ect. You coul d re-create the metri c i n the test proj ect
based on the same speci fi cati ons, but i t can be easy to mi ss an

© 2019, M icr o St r at egy In c. 413

Syst em Ad m in ist r at io n Gu id e

i mportant setti ng i n the metri c. A qui cker and more rel i abl e method i s
to use Mi croStrategy Obj ect Manager to mi grate the new metri c from
the devel opment proj ect to the test proj ect. Then, w hen the metri c i s
ready to be rol l ed out to your users, you can use Obj ect Manager
agai n to mi grate i t from the test proj ect to the producti on proj ect.

Mi croStrategy has the fol l ow i ng tool s avai l abl e for updati ng the
obj ects i n a proj ect:

l Obj ect Manager mi grates a few obj ects at a ti me. For i nformati on
about Obj ect Manager, see C opyi ng Obj ects Betw een Proj ects:
Obj ect Manager, page 417.

l An update package mi grates a previ ousl y speci fi ed group of

obj ects. U pdate packages are part of Obj ect Manager. For
i nformati on about update packages, see C opyi ng Obj ects i n a
Batch: U pdate Packages, page 443.

l Proj ect Merge mi grates al l the obj ects i n a proj ect at once. For
i nformati on about Proj ect Merge, see Mergi ng Proj ects to
Synchroni ze Obj ects, page 467.

For a compari son of these tool s, see C ompari ng Proj ect Merge to
Obj ect Manager, page 415.

l If y ou want to mov e or c opy objec ts between projec ts , Mic roStrategy

rec ommends that thos e projec ts hav e related s c hemas . This means
that either one projec t mus t be a duplic ate of the other, or both
projec ts mus t be duplic ates of a third projec t. For information about
duplic ating projec ts , inc luding ins truc tions , s ee D upl i cati ng a
Proj ect, page 405 .

l If one of the projec ts is updated to a new Mic roStrategy releas e, but

another projec t is not updated, y ou c annot mov e or c opy objec ts
between the projec ts . You mus t firs t update the other projec t before
y ou c an c opy objec ts between the projec ts .

414 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Comparing Project Merge to Object Manager

Obj ect Manager and Proj ect Merge are both desi gned for mi grati ng
obj ects betw een proj ects. Both tool s i nvol ve copyi ng obj ects betw een
proj ects i n a defi ni te order accordi ng to obj ect types. Whi ch tool you
shoul d use depends on several factors, such as how many obj ects
you need to move at once. The fol l ow i ng are some of the di fferences
betw een the tool s:

l Obj ect Manager can move j ust a few obj ects, or j ust the obj ects i n a
few fol ders. Proj ect Merge moves al l the obj ects i n a proj ect.

l U si ng Obj ect Manager to merge w hol e proj ects means movi ng many
obj ects i ndi vi dual l y or as a subset of al l obj ects. Thi s can be a l ong
and tedi ous task. Proj ect Merge packages the functi onal i ty for
easi er use because i t moves al l obj ects at one ti me.

l Obj ect Manager must l ocate the dependents of the copi ed obj ects
and then determi ne thei r di fferences before performi ng the copy
operati on. Proj ect Merge does not do a dependency search, si nce
al l the obj ects i n the proj ect are to be copi ed.

l The Proj ect Merge Wi zard al l ow s you to store merge setti ngs and
rul es i n an XML fi l e. These rul es defi ne w hat i s copi ed and how
confl i cts are resol ved. Once they are i n the XML fi l e, you can l oad
the rul es and "repl ay" them w i th Proj ect Merge. Thi s can be useful i f
you need to perform the same merge on a recurri ng schedul e. For
exampl e, i f a proj ect devel oper sends you a new proj ect versi on
quarterl y, Proj ect Merge can make thi s process easi er.

l Proj ect Merge can be run from the command prompt i n Mi crosoft
Wi ndow s. An added benefi t of thi s feature i s that proj ect merges
can be schedul ed usi ng the a t command i n Wi ndow s and can be
run si l entl y i n an i nstal l ati on routi ne.

© 2019, M icr o St r at egy In c. 415

Syst em Ad m in ist r at io n Gu id e

l The changes to be made through Obj ect Manager can be saved as

an update package and appl i ed at a l ater ti me. For i nstructi ons on
how to create and use update packages, see C opyi ng Obj ects i n a
Batch: U pdate Packages, page 443.

l The changes to be made through an Obj ect Manager update

package can be reversed usi ng an undo package. For i nstructi ons
on how to rol l back changes usi ng Obj ect Manager, see C opyi ng
Obj ects i n a Batch: U pdate Packages, page 443.

Locking Projects
When you open a proj ect i n Proj ect Merge, you automati cal l y pl ace a
metadata l ock on the proj ect. You al so pl ace a metadata l ock on the
proj ect i f you open i t i n read/w ri te mode i n Obj ect Manager, or i f you
create or i mport an update package from the command l i ne. For more
i nformati on about read/w ri te mode versus read-onl y mode i n Obj ect
Manager, see Proj ect Locki ng w i th Obj ect Manager, page 418.

A metadata l ock prevents other Mi croStrategy users from modi fyi ng

any obj ects i n the proj ect i n D evel oper or Mi croStrategy Web, w hi l e
obj ects are bei ng copi ed w i th Obj ect Manager or Proj ect Merge. It
al so prevents other Mi croStrategy users from modi fyi ng any
confi gurati on obj ects, such as users or groups, i n the proj ect source.
Locki ng a proj ect prevents metadata i nconsi stenci es.

When other users attempt to open an obj ect i n a l ocked proj ect usi ng
D evel oper or Mi croStrategy Web, they see a message that i nforms
them that the proj ect i s l ocked because a user that opened the proj ect
fi rst i s modi fyi ng i t. U sers can then choose to open the obj ect i n read-
onl y mode or vi ew more detai l s about the l ock. U sers can execute
reports i n a l ocked proj ect, but the report defi ni ti on that i s used i s the
l ast defi ni ti on saved pri or to the proj ect bei ng l ocked.

416 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

If you l ock a proj ect by openi ng i t i n Obj ect Manager, you can unl ock
the proj ect by ri ght-cl i cki ng the proj ect i n Obj ect Manager, and
choosi ng D isconnect from Project Source.

Only the us er who loc k ed a projec t, or another us er with the By pas s All
Objec t Sec urity Ac c es s Chec k s and Create Configuration Objec ts
priv ileges , c an unloc k a projec t.

You can al so l ock or unl ock a proj ect or a confi gurati on manual l y
usi ng D evel oper.

C ommand Manager scri pts can be used to automate metadata l ock

management. For i nformati on about C ommand Manager, see C hapter
15, Automati ng Admi ni strati ve Tasks w i th C ommand Manager. For
C ommand Manager syntax for managi ng metadata l ocks, see the
C ommand Manager H el p (press F1 from w i thi n C ommand Manager).

Copying Objects Between Projects: Object

Manager
Mi croStrategy Obj ect Manager can hel p you manage obj ects as they
progress through your proj ect's l i fe cycl e. U si ng Obj ect Manager, you
can copy obj ects w i thi n a proj ect or across proj ects.

Obj ect Manager and Proj ect Merge both copy mul ti pl e obj ects
betw een proj ects. U se Obj ect Manager w hen you have onl y a few
obj ects that need to be copi ed. For the di fferences betw een Obj ect
Manager and Proj ect Merge, see C ompari ng Proj ect Merge to Obj ect
Manager, page 415.

Thi s secti on i ncl udes:

© 2019, M icr o St r at egy In c. 417

Syst em Ad m in ist r at io n Gu id e

Prerequisites for Copying Objects Between Projects

l To use Obj ect Manager to copy obj ects betw een proj ects, you must
have the U se Obj ect Manager pri vi l ege for both proj ects. You do not
need to have AC L permi ssi ons for the obj ects you are mi grati ng.

l To create an update package, you must have ei ther the U se Obj ect
Manager pri vi l ege or the U se Obj ect Manager R ead-onl y pri vi l ege
for the proj ect from w hi ch you are creati ng an update package.

l If you w ant to mi grate obj ects betw een proj ects w i th Obj ect
Manager, Mi croStrategy recommends that those proj ects have
rel ated schemas. Thi s means that ei ther one proj ect must be a
dupl i cate of the other, or both proj ects must be dupl i cates of a thi rd
proj ect. For i nformati on about dupl i cati ng proj ects, i ncl udi ng
i nstructi ons, see D upl i cati ng a Proj ect, page 405.

l To move system obj ects betw een proj ects that do not have rel ated
schemas, the proj ects must ei ther have been created w i th
Mi croStrategy 9.0.1 or l ater, or have been updated to versi on 9.0.1
or l ater usi ng the Perform system object ID unification opti on. For
i nformati on about thi s upgrade, see the U pgrade Gui de.

l If one of the proj ects i s updated to a new Mi croStrategy rel ease, but
another proj ect i s not updated, you cannot move or copy obj ects
from the proj ect usi ng the updated versi on of Mi croStrategy to the
ol der versi on. H ow ever, you can move obj ects from the ol der
versi on to the updated proj ect i f the ol der versi on i s i nteroperabl e
w i th the updated versi on. For detai l ed i nformati on about
i nteroperabi l i ty betw een versi ons of Mi croStrategy, see the
R eadme.

Project Locking with Object Manager

Openi ng a connecti on to a proj ect w i th Obj ect Manager causes the
proj ect metadata to become l ocked. Other users cannot make any
changes to the proj ect unti l i t becomes unl ocked. For detai l ed

418 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

i nformati on about the effects of l ocki ng a proj ect, see Locki ng

Proj ects, page 416.

If you need to al l ow other users to change obj ects i n proj ects w hi l e

the proj ects are opened i n Obj ect Manager, you can confi gure Obj ect
Manager to connect to proj ects i n read-onl y mode. You can al so al l ow
changes to confi gurati on obj ects by connecti ng to proj ect sources i n
read-onl y mode.

C onnecti ng to a proj ect or proj ect source i n read-onl y mode has the
fol l ow i ng l i mi tati ons:

l A connecti on i n read-onl y mode may not di spl ay the most recent

i nformati on. For exampl e, i f you vi ew a fol der i n Obj ect Manager i n
a read-onl y connecti on, and then another user adds an obj ect to
that fol der, the obj ect i s not di spl ayed i n Obj ect Manager.

l You cannot copy obj ects i nto a read-onl y proj ect or proj ect source.
If you connect to a proj ect i n read-onl y mode, you can sti l l move,
copy, and del ete obj ects i n a proj ect, but you cannot copy obj ects
from another proj ect i nto that proj ect.

l By defaul t, users cannot create update packages i n read-onl y mode.

Thi s i s because obj ects, and thei r used dependenci es, may be
changed betw een the ti me they are sel ected for i ncl usi on i n the
update package and the ti me the package i s actual l y generated. If
necessary, you can confi gure Obj ect Manager to al l ow the creati on
of update packages i n read-onl y mode. For i nformati on about
update packages, see C opyi ng Obj ects i n a Batch: U pdate
Packages, page 443.

© 2019, M icr o St r at egy In c. 419

Syst em Ad m in ist r at io n Gu id e

To Open Projects or Connections in Read-Only Mode

1. From the Tools menu, sel ect Preferences.

2. Expand the Object Manager category, and then sel ect

C onnection.

3. To open proj ect sources i n read-onl y mode, sel ect the Open
configuration in read-only mode check box.

4. To open proj ects i n read-onl y mode, sel ect the Open project in
read-only mode check box.

5. To al l ow the creati on of update packages i n read-onl y mode,

sel ect the A llow update package creation in read-only mode
check box.

6. C l i ck OK .

Copying Objects
Obj ect Manager can copy appl i cati on, schema, and confi gurati on
obj ects.

l A pplication objects i ncl ude reports and documents, and the

obj ects used to create them, such as templ ates, metri cs, fi l ters,
prompts, and searches. Fol ders are al so consi dered to be
appl i cati on obj ects and confi gurati on obj ects.

l Schema objects i ncl ude attri butes, facts, hi erarchi es,

transformati ons, functi ons, parti ti on mappi ngs, col umns, and tabl es.

l C onfiguration objects i ncl ude obj ects that are used by al l proj ects
i n a proj ect source, such as users and user groups, database
i nstances and l ogi ns, securi ty rol es, and D i stri buti on Servi ces
devi ces, transmi tters, and contacts.

420 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

If y ou us e Objec t Manager to c opy a us er or us er group between projec t

s ourc es , the us er or group rev erts to default inherited ac c es s for all
projec ts in the projec t s ourc e. To c opy a us er or group's s ec urity
information for a projec t, y ou mus t c opy the us er or group in a
c onfiguration update pac k age. For information about update pac k ages ,
s ee C opyi ng Obj ects i n a Batch: U pdate Packages, page 443 .

For background i nformati on on these obj ects, i ncl udi ng how they are
created and w hat rol es they perform i n a proj ect, see the Proj ect
D esi gn Gui de.

In a Mi croStrategy system, each obj ect has a uni que Obj ect ID . Obj ect
Manager i denti fi es obj ects based on thei r Obj ect ID , not thei r name.
H ence, obj ects w i th di fferent names are treated as versi ons of the
same obj ect i f they have the same Obj ect ID .

Best Pr act ices f o r Co p yin g Ob ject s

Mi croStrategy recommends that you observe the fol l ow i ng practi ces
w hen copyi ng obj ects:

l Back up your metadata before copyi ng any obj ects. Obj ect Manager
cannot undo the copyi ng and repl aci ng of obj ects.

l Ensure that the D ependency Search, C onfl i ct R esol uti on,

Internati onal , and Mi grati on opti ons i n the Obj ect Manager
Preferences di al og box are set to fi t your proj ect's needs. For
detai l s about the D ependency Search opti ons, see What happens
w hen You C opy or Move an Obj ect, page 425. For detai l s about the
C onfl i ct R esol uti on opti ons, see R esol vi ng C onfl i cts w hen C opyi ng
Obj ects, page 434. For detai l s about the Mi grati on opti ons, see
What happens w hen You C opy or Move an Obj ect, page 425. The
Obj ect Manager H el p al so provi des a detai l ed expl anati on for each
of these opti ons.

© 2019, M icr o St r at egy In c. 421

Syst em Ad m in ist r at io n Gu id e

l C opy appl i cati on obj ects i nto the fol l ow i ng proj ect fol ders:

l My Personal Obj ects or any subfol der of My Personal Obj ects

l Publ i c Obj ects or any subfol der of Publ i c Obj ects.

l C opy schema obj ects i nto the appropri ate Schema Obj ects sub- or
descendent fol ders onl y. For exampl e, i f you are copyi ng a
hi erarchy, you shoul d onl y paste the hi erarchy i nto the Proj ect
N ame\Schema Obj ects\H i erarchi es fol der.

l When copyi ng MD X cubes betw een proj ects, make sure that the
confl i ct resol uti on acti on for the cubes, cube attri butes, and reports
that use the cubes i s set to R epl ace.

l If you need to copy obj ects from mul ti pl e fol ders at once, you can
create a new fol der, and create shortcuts i n the fol der to al l the
obj ects you w ant to copy. Then copy that fol der. Obj ect Manager
copi es the fol der, i ts contents (the shortcuts), and thei r
dependenci es (the target obj ects of those shortcuts) to the new
proj ect.

l Another w ay to copy obj ects from mul ti pl e fol ders at once i s to

create an update package from the source proj ect, and then i mport
i t i nto the target proj ect. For more i nformati on about update
packages, i ncl udi ng step-by-step i nstructi ons, see C opyi ng Obj ects
i n a Batch: U pdate Packages, page 443.

l If you are usi ng update packages to update the obj ects i n your
proj ects, use the Export opti on to create a l i st of al l the obj ects i n
each update package.

l When copyi ng obj ects that contai n l ocati on-speci fi c stri ngs (such as
metri c al i ases, custom group names, or text boxes i n documents),
make sure that you ei ther di sabl e Advanced C onfl i ct R esol uti on, or
use the same opti on i n the transl ati on preferences and i n the
confl i ct resol uti on. Otherw i se there may be i nconsi stenci es betw een

422 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

the obj ect defi ni ti on and the transl ati on i n the desti nati on proj ect.
For an expl anati on of the advanced confl i ct resol uti on opti ons,
i ncl udi ng how to enabl e or di sabl e these opti ons, see What
happens w hen You C opy or Move an Obj ect, page 425.

l R egardl ess of the transl ati on preferences, w hen copyi ng obj ects
w i th l ocati on-speci fi c stri ngs, you shoul d al w ays veri fy the resul ts.
For exampl e, empty transl ati ons i n the source or desti nati on may
resul t i n i ncorrect transl ati ons bei ng saved w i th the new obj ect. You
can use Integri ty Manager to i denti fy reports or documents that have
unexpected transl ati ons. For i nformati on about Integri ty Manager,
see C hapter 16, Veri fyi ng R eports and D ocuments w i th Integri ty
Manager.

To Copy Objects Between Projects

l To log in to a projec t s ourc e us ing Objec t Manager, y ou mus t hav e the

Us e Objec t Manager priv ilege for that projec t.

l If y ou want to c opy applic ation or s c hema objec ts between projec ts ,

Mic roStrategy rec ommends that the two projec ts hav e related
s c hemas (one mus t be a duplic ate of the other or both mus t be
duplic ates of a c ommon projec t). For details on this , s ee D upl i cati ng
a Proj ect, page 405 .

Log i n t o t he Pr oj ect s i n Ob j ect M anager

1. In Wi ndow s, go to Start > A ll Programs > MicroStrategy

Products > Object Manager.

© 2019, M icr o St r at egy In c. 423

Syst em Ad m in ist r at io n Gu id e

2. In the l i st of proj ect sources, sel ect the check box for the proj ect
source you w ant to access. You can sel ect more than one proj ect
source.

3. C l i ck Open.

4. U se the appropri ate sub-procedure bel ow dependi ng on w hether

you w ant to C opy Appl i cati on and Schema Obj ects, page 424 or
C opy C onfi gurati on Obj ects, page 425.

Cop y Ap p l i cat i on and Schem a Ob j ect s

1. In the Fol der Li st, expand the proj ect that contai ns the obj ect you
w ant to copy, then navi gate to the obj ect.

2. C opy the obj ect by ri ght-cl i cki ng and sel ecti ng C opy.

3. Expand the desti nati on proj ect i n w hi ch you w ant to paste the
obj ect, and then sel ect the fol der i n w hi ch you w ant to paste the
obj ect.

4. Paste the appl i cati on or schema obj ect i nto the appropri ate
desti nati on fol der by ri ght-cl i cki ng and sel ecti ng Paste.

For i nformati on about addi ti onal obj ects that may be copi ed w i th
a gi ven obj ect, see What happens w hen You C opy or Move an
Obj ect, page 425.

If y ou are c opy ing objec ts between two different projec t s ourc es ,

two windows are open within the main Objec t Manager window. In

424 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

this c as e, ins tead of right-c lic k ing and s elec ting C opy and Paste ,
y ou c an drag and drop objec ts between the projec ts .

5. If you copi ed any schema obj ects, you must update the
desti nati on proj ect's schema. Sel ect the desti nati on proj ect, and
from the Project menu, sel ect U pdate Schema.

Cop y Conf i gur at i on Ob j ect s

1. In the Fol der Li sts for both the source and desti nati on proj ects,
expand the A dministration fol der, then sel ect the appropri ate
manager for the type of confi gurati on obj ect you w ant to copy
(D atabase Instance Manager, Schedul e Manager, or U ser
Manager).

2. From the l i st of obj ects di spl ayed on the ri ght-hand si de i n the

source proj ect source, drag the desi red obj ect i nto the
desti nati on proj ect source and drop i t.

To dis play the lis t of us ers on the right-hand s ide, ex pand Us er

Manager, then on the left-hand s ide s elec t a group.

What happens when You Copy or Move an Object

If the obj ect you are copyi ng does not exi st i n the desti nati on proj ect,
Mi croStrategy Obj ect Manager copi es the obj ect i nto the desti nati on
proj ect. Thi s new obj ect has the same name as the source obj ect.

If the obj ect you are copyi ng does exi st i n the desti nati on proj ect, a
confl i ct occurs and Obj ect Manager opens the C onfl i ct R esol uti on
di al og box. For i nformati on about how to resol ve confl i cts, see
R esol vi ng C onfl i cts w hen C opyi ng Obj ects, page 434.

Man agin g Ob ject Dep en d en cies

When an obj ect uses another obj ect i n i ts defi ni ti on, the obj ects are
sai d to depend on one another. Obj ect Manager recogni zes tw o types

© 2019, M icr o St r at egy In c. 425

Syst em Ad m in ist r at io n Gu id e

of obj ect dependenci es: used dependenci es and used-by

dependenci es.

When you mi grate an obj ect to another proj ect, by defaul t any obj ects
used by that obj ect i n i ts defi ni ti on (i ts used dependenci es) are al so
mi grated. You can excl ude certai n obj ects and tabl es from the
dependency check and mi grati on. For i nstructi ons, see Excl udi ng
D ependent Attri butes or Tabl es from Obj ect Mi grati on, page 430.

Used Dependencies

A used dependency occurs w hen an obj ect uses other obj ects i n i ts
defi ni ti on. For exampl e, i n the Mi croStrategy Tutori al proj ect, the
metri c named R evenue uses the base formul a named R evenue i n i ts
defi ni ti on. The R evenue metri c i s sai d to have a used dependency on
the R evenue base formul a. (Addi ti onal l y, the R evenue base formul a
has a used-by dependency of the R evenue metri c.)

When you mi grate an obj ect to another proj ect, any obj ects used by
that obj ect i n i ts defi ni ti on (i ts used dependenci es) are al so mi grated.
The order of these dependent rel ati onshi ps i s mai ntai ned.

To Manage Used or Used-By Dependencies of an Object

1. After you have opened a proj ect source and a proj ect usi ng
Obj ect Manager, i n the Folder List sel ect the obj ect.

2. From the Tools menu, sel ect Object used dependencies. The
U sed dependenci es di al og box opens and di spl ays a l i st of
obj ects that the sel ected obj ect uses i n i ts defi ni ti on. The i mage
bel ow show s the used dependenci es of the R evenue metri c i n
the Mi croStrategy Tutori al proj ect: i n thi s case, the used
dependency i s the R evenue base formul a.

426 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

3. In the U sed dependenci es di al og box, you can do any the

fol l ow i ng:

l Vi ew used dependenci es for any obj ect i n the l i st by sel ecti ng

the obj ect and cl i cki ng the Object used dependencies tool bar
i con.

l Open the U sed-by dependenci es di al og box for any obj ect i n

the l i st by sel ecti ng the obj ect and cl i cki ng the Object used-by
dependencies i con on the tool bar. For i nformati on about used-
by dependenci es, see U sed-By D ependenci es, page 427.

l Vi ew the properti es of any obj ect, such as i ts ID , versi on

number, and access control l i sts, by sel ecti ng the obj ect and
from the File menu choosi ng Properties.

Used-By Dependencies

A used-by dependency occurs w hen an obj ect i s used as part of the

defi ni ti on of other obj ects. For exampl e, i n the Mi croStrategy Tutori al
proj ect, the R evenue metri c has used-by dependenci es of many
reports and even other metri cs. The R evenue metri c i s sai d to be
used by these other obj ects.

U sed-by dependents are not automati cal l y mi grated w i th thei r used

obj ects. H ow ever, you cannot del ete an obj ect that has used-by
dependenci es w i thout fi rst del eti ng i ts used obj ects.

© 2019, M icr o St r at egy In c. 427

Syst em Ad m in ist r at io n Gu id e

To Manage the Used-By Dependencies of an Object

1. After you have opened a proj ect source and a proj ect usi ng
Obj ect Manager, from the Folder List sel ect the obj ect.

2. From the Tools menu, choose Object used-by dependencies.

The U sed-by dependenci es di al og box opens and di spl ays a l i st
of obj ects that depend on the sel ected obj ect for part of thei r
defi ni ti on. The i mage bel ow show s some of the used-by
dependenci es for the R evenue metri c i n the Mi croStrategy
Tutori al proj ect.

3. In the U sed-by dependenci es di al og box, you can do any of the

fol l ow i ng:

l Vi ew used-by dependenci es for any obj ect i n the l i st by

sel ecti ng the obj ect and cl i cki ng the Object used-by
dependencies i con on the tool bar.

l Open the U sed dependenci es di al og box for any obj ect i n the
l i st by sel ecti ng the obj ect and cl i cki ng the Object used
dependencies i con on the tool bar. For i nformati on about used
dependenci es, see U sed D ependenci es, page 426.

428 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Vi ew the properti es of any obj ect, such as i ts ID , versi on

number, and access control l i sts, by sel ecti ng the obj ect and
from the File menu choosi ng Properties.

Migr at in g Dep en d en t Ob ject s

When you copy an obj ect usi ng Obj ect Manager, i t checks for any
used dependents of that obj ect and copi es them as w el l . These
dependent obj ects are copi ed to the same path as i n the source
proj ect. If thi s path does not al ready exi st i n the desti nati on proj ect,
Obj ect Manager creates the path.

For exampl e, a user copi es a report from the source proj ect to the
desti nati on proj ect. In the source proj ect, al l dependents of the report
are stored i n the P u b l i c O b j e c t s \ R e p o r t D e p e n d e n t s fol der.
Obj ect Manager l ooks i n the desti nati on proj ect's Publ i c Obj ects
fol der for a subfol der named R e p o r t D e p e n d e n t s (the same path
as i n the source proj ect). If the fol der exi sts, the dependent obj ects
are saved i n that fol der. If the desti nati on proj ect does not have a
fol der i n Publ i c Obj ects w i th the name U s e r, Obj ect Manager creates
i t and saves al l dependent obj ects there.

When y ou c reate an update pac k age, c lic k A dd A ll U sed

D ependencies to mak e s ure all us ed dependenc ies are inc luded in the
pac k age. If the dependent objec ts for a s pec ific objec t do not ex is t in
either the des tination projec t s ourc e or in the update pac k age, the
update pac k age c annot be applied. If y ou c hoos e not to add dependent
objec ts to the pac k age, mak e s ure that all dependent objec ts are
inc luded in the des tination projec t s ourc e.

Object Dependencies

Some obj ects have dependenci es that are not i mmedi atel y obvi ous.
These are l i sted bel ow :

© 2019, M icr o St r at egy In c. 429

Syst em Ad m in ist r at io n Gu id e

l Folders have a used dependency on each obj ect i n the fol der. If
you copy a fol der usi ng Obj ect Manager, al l the obj ects i n that
fol der are al so copi ed.

A folder that is c opied as part of an update pac k age does not hav e a
us ed dependenc y on its c ontents .

l Shortcut objects have a used dependency on the obj ect they are a
shortcut to. If you copy a shortcut usi ng Obj ect Manager, the obj ect
i t i s a shortcut to i s al so copi ed.

l Security filters, users, and user groups have a used dependency

on the user groups they bel ong to. If you copy a securi ty fi l ter, user,
or user group, the groups that i t bel ongs to are al so copi ed.

Groups hav e a us ed-by dependenc y on the us ers and s ec urity filters

that are as s oc iated with them. Copy ing a group does not automatic ally
c opy the us ers or s ec urity filters that belong to that group. To c opy the
us ers or s ec urity filters in a group, s elec t the us ers from a lis t of that
group's us ed-by dependents and then c opy them.

l A ttributes used in fact expressions are l i sted as dependents of

the fact. When the fact i s copi ed, the attri bute i s al so copi ed.

Attributes us ed in fac t entry lev els are not dependents of the fac t.

Excluding Dependent Attributes or Tables from Object Migration

When you copy an obj ect, or add dependent obj ects to an update
package, Obj ect Manager searches for that obj ect's used
dependenci es so i t can copy those obj ects al so. D ependi ng on the
opti ons you set i n the Obj ect Manager Preferences, you can excl ude
certai n types of dependent obj ects from thi s mi grati on.

The opti ons are:

430 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Exclude all parent attributes from an attribute and Exclude all

child attributes from an attribute: An attri bute has a used
dependency on i ts parent and chi l d attri butes i n a hi erarchy. Thus,
mi grati ng an attri bute may resul t i n mi grati ng i ts enti re hi erarchy. To
excl ude the parent or chi l d attri butes from bei ng mi grated, sel ect
the correspondi ng opti on.

l Exclude non-lookup tables from an attribute and Exclude all

tables from a fact: An attri bute or fact has a used dependency on
each tabl e that i s referenced by the attri bute or fact. Thus, by
defaul t, mi grati ng an attri bute or fact resul ts i n mi grati ng al l i ts
associ ated tabl es. You can choose to excl ude the tabl es from the
dependency search i f, for exampl e, you have mapped addi ti onal
tabl es to an attri bute or fact for testi ng purposes but do not need
those tabl es i n the producti on proj ect.

For attributes , the look up table mus t alway s ex is t in the des tination
projec t, s o it is alway s migrated.

To Exclude Types of Dependent Objects

1. From the Tools menu, sel ect Object Manager Preferences.

2. Expand D ependency search, and then sel ect D ependency

search.

3. Sel ect the check boxes for the obj ects you w ant to excl ude from
Obj ect Manager's dependency checki ng.

4. C l i ck OK .

Timest amp s f o r Migr at ed Ob ject s

By defaul t, w hen an obj ect i s mi grated, the obj ect's modi fi cati on
ti mestamp i s updated to the desti nati on Intel l i gence Server's
mi grati on process ti me. You can change thi s behavi or so that the

© 2019, M icr o St r at egy In c. 431

Syst em Ad m in ist r at io n Gu id e

ti mestamp remai ns as the l ast modi fi cati on ti me the obj ect had i n the
source proj ect.

To Set the Migrated Object Modification Timestamp

1. From the Tools menu, sel ect Object Manager Preferences.

2. Expand Migration, and then sel ect Migration.

3. To cause obj ects to keep the modi fi cati on ti mestamp from the
source proj ect, sel ect the Preserve object modification
timestamp during migration check box. If thi s check box i s
cl eared, obj ects take the modi fi cati on ti mestamp from the
desti nati on Intel l i gence Server at the ti me of mi grati on.

4. C l i ck OK .

Co p yin g Ob ject s Bet ween Pr o ject s in Dif f er en t Lan gu ages

Obj ect Manager's i nternati onal i zati on opti ons al l ow you to speci fy the
l ocal e setti ngs to be used w hen copyi ng obj ects. You can al so retai n
the obj ect's name, descri pti on, and l ong descri pti on from the
desti nati on proj ect, w hen repl aci ng obj ects i n the desti nati on proj ect
usi ng Obj ect Manager.

The abi l i ty to retai n the name, descri pti on, and l ong descri pti on i s
i mportant i n i nternati onal i zed envi ronments. When repl aci ng the
obj ects to resol ve confl i cts, retai ni ng these properti es of the obj ects
i n the desti nati on proj ect faci l i tates support of i nternati onal i zed
envi ronments. For exampl e, i f the desti nati on proj ect contai ns obj ects
w i th French names but the source proj ect has been devel oped i n
Engl i sh (i ncl udi ng Engl i sh names), you can retai n the French names
and descri pti ons for obj ects i n the desti nati on proj ect. Al ternatel y,
you can update the proj ect w i th the Engl i sh names and not change
the obj ect i tsel f.

432 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To Set the Internationalization Options

1. From the Tools menu, sel ect Object Manager Preferences.

2. Expand the International category, and sel ect Language.

3. From the Interface Language drop-dow n l i st, sel ect the

l anguage to be used i n Obj ect Manager. By defaul t thi s i s the
l anguage used i n al l Mi croStrategy products i nstal l ed on thi s
system.

4. From the Language for metadata and warehouse data if user

and project level preferences are set to default drop-dow n l i st,
sel ect w hether copi ed obj ects use the l ocal e setti ngs from
D evel oper or from the machi ne's regi onal setti ngs.

For more information on metadata and warehous e data languages ,

s ee About Internati onal i zati on . For a table on the prioritiz ation of
us er- and projec t-lev el language preferenc es , s ee C onfi guri ng
Metadata Obj ect and R eport D ata Language Preferences,
page 1781 .

5. In the International category, sel ect Translation.

6. To resol ve transl ati ons w i th a di fferent acti on than that speci fi ed

for the obj ect associ ated w i th the transl ati on, sel ect the Enable
advanced conflict resolution check box.

l To al w ays use the transl ati ons i n the desti nati on proj ect, sel ect
K eep Existing.

l To al w ays use the transl ati ons i n the source proj ect, sel ect
R eplace.

7. Sel ect the Merge translations even if object exists identically

check box to update the transl ati ons for al l copi ed obj ects i n the
desti nati on proj ect, accordi ng to the opti on speci fi ed above

© 2019, M icr o St r at egy In c. 433

Syst em Ad m in ist r at io n Gu id e

(Keep Exi sti ng or R epl ace (D efaul t)), even i f the obj ect exi sts
i denti cal l y i n both proj ects.

8. C l i ck OK .

Resolving Conflicts when Copying Objects

In the Mi croStrategy system, every obj ect has an ID (or GU ID ) and a
versi on. The versi on changes every ti me the obj ect i s updated; the ID
i s created w hen the obj ect i s created and remai ns constant for the l i fe
of the obj ect. To see the ID and versi on of an obj ect, ri ght-cl i ck the
obj ect and sel ect Properties.

When copyi ng obj ects across proj ects w i th Obj ect Manager, i f an
obj ect w i th the same ID as the source obj ect exi sts anyw here i n the
desti nati on proj ect, a confl i ct occurs and the C onfl i ct R esol uti on
di al og box (show n bel ow ) opens. It prompts you to resol ve the
confl i ct.

The tabl e bel ow l i sts the di fferent ki nds of confl i ct:

Conflic t Ex pla na tion

E xist s The object I D, object version, and pat h are t he same in t he source and
ident ically dest inat ion project s.

The object I D is t he same in t he source and dest inat ion project s, but
E xist s
t he object versions are dif f erent . The pat h may be t he same or
dif f erent ly
dif f erent .

434 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Conflic t Ex pla na tion

The object I D and object version are t he same in t he source and

dest inat ion project s, but t he pat hs are dif f erent . This occurs when one
of t he object s exist s in a dif f erent f older.

I f your language pref erences f or t he source and dest inat ion

E xist s project s are dif f erent , object s t hat are ident ical bet ween t he
ident ically project s may be report ed as E xist s I dent ically E xcept For P at h.
except f or This occurs because when dif f erent languages are used f or t he
pat h pat h names, Object Manager t reat s t hem as dif f erent pat hs. To
resolve t his, set your language pref erences f or t he project s t o t he
same language.

I f you resolve t he conf lict wit h t he R eplace act ion, t he dest inat ion
object is updat ed t o ref lect t he pat h of t he source object .

(User only) The object I D and object version of t he user are t he same in
E xist s t he source and dest inat ion project s, but at least one associat ed
ident ically Dist ribut ion S ervices cont act or cont act group is dif f erent . This may
except f or occur if you modif ied a cont act or cont act group linked t o t his user in
Dist ribut ion t he source project .
S ervices
object s I f you resolve t he conf lict wit h t he R eplace act ion, t he dest inat ion user
is updat ed t o ref lect t he cont act s and cont act groups of t he source user.

The object exist s in t he source project but not in t he dest inat ion
project .

Does not I f you clear t he Show new objects that exist only in the
exist source check box in t he Migration cat egory of t he Object
Manager P ref erences dialog box, object s t hat do not exist in t he
dest inat ion project are copied aut omat ically wit h no need f or
conf lict resolut ion.

Ch o o sin g an Act io n t o Reso lve a Co n f lict

If a confl i ct occurs you must determi ne w hat acti on Obj ect Manager
shoul d take. The di fferent acti ons are expl ai ned i n the tabl e bel ow .

© 2019, M icr o St r at egy In c. 435

Syst em Ad m in ist r at io n Gu id e

When Obj ect Manager reports a confl i ct i t al so suggests a defaul t

acti on to take for that confl i ct. For i nformati on on changi ng the defaul t
acti on, see Setti ng D efaul t Acti ons for C onfl i ct R esol uti ons, page 438.

Us e r
Effe c t
Ac tion

Use No change is made t o t he dest inat ion object . The source object is not
exist ing copied.

The dest inat ion object is replaced wit h t he source object .

I f t he conf lict t ype is E xist s I dent ically E xcept For P at h, or E xist s

I dent ically E xcept For Dist ribut ion S ervices Object s, t he
dest inat ion object is updat ed t o ref lect t he pat h or Dist ribut ion
S ervices addresses and cont act s of t he source object .

Replace Replace moves t he object int o same parent f older as t he source object .
I f t he parent pat h is t he same bet ween source and dest inat ion but t he
grandparent pat h is dif f erent , Replace may appear t o do not hing
because Replace put s t he object int o t he same parent pat h.

Non-empt y f olders in t he dest inat ion locat ion will never have t he same
version I D and modif icat ion t ime as t he source, because t he f older is
copied f irst and t he object s are added t o it , t hus changing t he version
I D and modif icat ion t imes during t he copy process.

No change is made t o t he dest inat ion object . The source object is

K eep bot h
duplicat ed in t he dest inat ion locat ion.

I f t he source object 's modif icat ion t ime is more recent t han t he
Use newer dest inat ion object 's, t he R eplace act ion is used.

Ot herwise, t he U se existing act ion is used.

I f t he source object 's modif icat ion t ime is more recent t han t he
Use older dest inat ion object 's, t he U se existing act ion is used.

Ot herwise, t he R eplace act ion is used.

Merge The privileges, securit y roles, groups, and Dist ribut ion S ervices
(user/ group addresses and cont act s of t he source user or group are added t o t hose

436 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Us e r
Effe c t
Ac tion

only) of t he dest inat ion user or group.

The select ed t able is not creat ed in t he dest inat ion project . This opt ion
Do not
is only available if t he A llow to override table creation for non-
move
lookup tables that exist only at source project check box in t he
(t able
Migration cat egory of t he Object Manager P ref erences dialog box is
only)
select ed.

Force
replace Replace t he object in t he dest inat ion project wit h t he version of t he
(Updat e object in t he updat e package, even if bot h versions of t he object have
packages t he same V ersion I D.
only)

Delet e t he object f rom t he dest inat ion project . The version of t he object
Delet e
in t he updat e package is not import ed int o t he dest inat ion project .
(Updat e
packages
I f t he object in t he dest inat ion has any used-by dependencies
only)
when you import t he updat e package, t he import will f ail.

Warehous e and other databas e tables as s oc iated with the objec ts

mov ed are handled in s pec ific way s , depending on y our c onflic t
res olution c hoic es . For details , s ee C onfl i ct R esol uti on and Tabl es,
page 441 .

If you choose to repl ace a schema obj ect, the fol l ow i ng message may
appear:

The schema has been modified. In order for the changes to

take effect, you must update the schema.

Thi s message al so appears i f you choose to repl ace an appl i cati on

obj ect that depends on an attri bute, and you have made changes to
that attri bute by modi fyi ng i ts form properti es at the report l evel or i ts
col umn defi ni ti on through another attri bute. For i nformati on about
modi fyi ng the properti es of an attri bute, see the Proj ect D esi gn Gui de.

© 2019, M icr o St r at egy In c. 437

Syst em Ad m in ist r at io n Gu id e

To update the proj ect schema, from the Obj ect Manager Project
menu, sel ect U pdate Schema. For detai l s about updati ng the proj ect
schema, see the Opti mi zi ng and Mai ntai ni ng your Proj ect secti on i n
the Proj ect D esi gn Gui de.

To Resolve a Conflict

1. Sel ect the obj ect or obj ects that you w ant to resol ve the confl i ct
for. You can sel ect mul ti pl e obj ects by hol di ng dow n SH IFT or
C TR L w hen sel ecti ng.

2. C hoose an opti on from the A ction drop-dow n l i st (see tabl e

above).

3. On the tool bar, cl i ck Proceed.

Set t in g Def au lt Act io n s f o r Co n f lict Reso lu t io n s

You can determi ne the defaul t acti ons that di spl ay i n the C onfl i ct
R esol uti on di al og box w hen a confl i ct occurs. Thi s i ncl udes setti ng
the defaul t acti ons for the fol l ow i ng obj ect categori es and types:

l Appl i cati on obj ects

l Schema obj ects

l C onfi gurati on obj ects

l Fol ders

l U sers and user groups

For a l i st of appl i cati on, confi gurati on, and schema obj ects, see
C opyi ng Obj ects, page 420. For an expl anati on of each obj ect acti on,
see C hoosi ng an Acti on to R esol ve a C onfl i ct, page 435.

You can set a di fferent defaul t acti on for obj ects speci fi cal l y sel ected
by the user, and for obj ects that are i ncl uded because they are
dependents of sel ected obj ects. For exampl e, you can set sel ected

438 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

appl i cati on obj ects to defaul t to U se newer to ensure that you al w ays
have the most recent versi on of any metri cs and reports. You can set
dependent schema obj ects to defaul t to R eplace to use the source
proj ect's versi on of attri butes, facts, and hi erarchi es.

These sel ecti ons are onl y the defaul t acti ons. You can al w ays change
the confl i ct resol uti on acti on for a gi ven obj ect w hen you copy that
obj ect.

To Set the Default Conflict Resolution Actions

1. From the Tools menu, sel ect Object Manager Preferences.

2. Expand the C onflict R esolution category, and sel ect D efault

Object A ctions.

3. Make any changes to the defaul t acti ons for each category of
obj ects.

l For an expl anati on of the di fferences betw een appl i cati on,
confi gurati on, and schema obj ects, see C opyi ng Obj ects, page
420.

l For an expl anati on of each obj ect acti on, see C hoosi ng an
Acti on to R esol ve a C onfl i ct, page 435.

4. C l i ck OK .

Co n f lict Reso lu t io n an d Access Co n t r o l List s

When you update or add an obj ect i n the desti nati on proj ect, by
defaul t the obj ect keeps i ts access control l i st (AC L) from the source
proj ect. You can change thi s behavi or i n tw o w ays:

l If you resol ve a confl i ct w i th the R epl ace acti on, and the access
control l i sts (AC L) of the obj ects are di fferent betw een the tw o

© 2019, M icr o St r at egy In c. 439

Syst em Ad m in ist r at io n Gu id e

proj ects, you can choose w hether to keep the exi sti ng AC L i n the
desti nati on proj ect or repl ace i t w i th the AC L from the source
proj ect.

l If you add a new obj ect to the desti nati on proj ect w i th the C reate
N ew or Keep Both acti on, you can choose to have the obj ect i nheri t
i ts AC L from the desti nati on fol der i nstead of keepi ng i ts ow n AC L.
Thi s i s hel pful w hen copyi ng an obj ect i nto a user's profi l e fol der,
so that the user can have ful l control over the obj ect.

The U se Ol der or U se N ew er acti ons al w ays keep the AC L of

w hi chever obj ect (source or desti nati on) i s used.

To Set the ACL Options

1. From the Tools menu, sel ect Object Manager Preferences.

2. Expand the C onflict R esolution category, and sel ect A ccess

C ontrol List.

3. U nder A C L option on replacing objects, sel ect how to handl e

the AC L for confl i cts resol ved w i th the R epl ace acti on:

l To use the AC L of the source obj ect, sel ect K eep existing
A C L when replacing objects.

l To use the AC L of the repl aced desti nati on obj ect, sel ect
R eplace existing A C L when replacing objects.

If this option is s elec ted, the ACL is replac ed ev en if the s ourc e

and des tination objec ts are identic al.

4. U nder A C L option on new objects, sel ect how to handl e the

AC L for new obj ects added to the desti nati on proj ect:

l To use the AC L of the source obj ect, sel ect K eep A C L as in

the source objects.

440 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l To i nheri t the AC L from the desti nati on fol der, sel ect Inherit
A C L from the destination folder.

5. C l i ck OK .

Co n f lict Reso lu t io n an d Tab les

When an attri bute or fact i s mi grated from one proj ect to another usi ng
Obj ect Manager, ei ther speci fi cal l y or because i t i s a dependent of
another obj ect, by defaul t al l dependent tabl es are al so mi grated.
Thi s i ncl udes w arehouse tabl es as w el l as MD X tabl es and XD A
tabl es.

You can choose not to create a dependent tabl e i n the desti nati on
proj ect by changi ng the Acti on for the tabl e from C reate N ew to
Ignore. You can al so choose not to mi grate any dependent tabl es by
speci fyi ng that they not be i ncl uded i n Obj ect Manager's dependency
search. For detai l ed i nformati on, i ncl udi ng i nstructi ons, see What
happens w hen You C opy or Move an Obj ect, page 425.

The fol l ow i ng l i st and rel ated tabl es expl ai n how the attri bute - tabl e
or fact - tabl e rel ati onshi p i s handl ed, based on the exi sti ng obj ects
and tabl es and the confl i ct resol uti on acti on you sel ect.

In the following lis t and tables , attribute, fac t, and table des c riptions
refer to the des tination projec t. For ex ample, "new attribute" means the
attribute is new to the des tination projec t: it ex is ts in the s ourc e projec t
but not the des tination projec t.

l N ew attribute or fact, new table: There i s no confl i ct resol uti on. By

defaul t the tabl e i s moved w i th the obj ect. You can choose not to
create the dependent tabl e i n the desti nati on proj ect by changi ng
the Acti on for the tabl e from C reate N ew to Ignore.

l N ew attribute or fact, existing table: The obj ect i n the source

proj ect contai ns a reference to the tabl e i n i ts defi ni ti on. The tabl e

© 2019, M icr o St r at egy In c. 441

Syst em Ad m in ist r at io n Gu id e

i n the desti nati on proj ect has no reference to the obj ect because the
obj ect i s not present i n the desti nati on proj ect. In thi s case the new
obj ect w i l l have the same references to the tabl e as i t di d i n the
source proj ect.

l Existing attribute or fact, new table: The obj ect i n the desti nati on
proj ect does not refer to the tabl e because the tabl e does not exi st
i n the desti nati on proj ect. The obj ect i n the source proj ect contai ns
a reference to the tabl e i n i ts defi ni ti on.

Obje c t
Wha t ha ppe ns in the de s tina tion pr oje c t
Ac tion

Use
The object does not ref erence t he t able.
E xist ing

The object has t he same ref erences t o t he t able as it does in t he source

Replace
project .

No change is made t o t he dest inat ion object . The source object is

K eep
duplicat ed in t he dest inat ion project . The duplicat ed object will have
B ot h
t he same ref erences t o t he t able as it does in t he source project .

l Existing attribute or fact, existing table: The obj ect has a

reference to the tabl e i n the source proj ect but has no reference to i t
i n the desti nati o proj ect.

Obje c t
Wha t ha ppe ns in the de s tina tion pr oje c t
Ac tion

Use
The object does not ref erence t he t able.
E xist ing

The object has t he same ref erences t o t he t able as it does in t he source

Replace
project .

442 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Obje c t
Wha t ha ppe ns in the de s tina tion pr oje c t
Ac tion

No change is made t o t he dest inat ion object . The source object is

K eep
duplicat ed in t he dest inat ion project . The duplicat ed object will have
B ot h
t he same ref erences t o t he t able as it does in t he source project .

l Existing attribute or fact, existing table: The obj ect has no

reference to the tabl e i n the source proj ect but has a reference to i t
i n the desti nati on proj ect.

Obje c t
Wha t ha ppe ns in the de s tina tion pr oje c t
Ac tion

Use The object has t he same ref erences t o t he t able as it did bef ore t he
E xist ing act ion.

Replace The object does not ref erence t he t able.

No change is made t o t he dest inat ion object . The source object is

K eep
duplicat ed in t he dest inat ion project . The duplicat ed object will not
B ot h
ref erence t he t able.

Copying Objects in a Batch: Update Packages

In some cases, you may need to update the obj ects i n several fol ders
at once, or at a ti me w hen the source proj ect i s offl i ne. Obj ect
Manager al l ow s you to save the obj ects you w ant to copy i n an update
package, and i mport that package i nto any number of desti nati on
proj ects at a l ater date.

For exampl e, you have several devel opers w ho are each responsi bl e
for a subset of the obj ects i n the devel opment proj ect. The devel opers
can submi t update packages, w i th a l i st of the obj ects i n the
packages, to the proj ect admi ni strator. The admi ni strator can then
i mport those packages i nto the test proj ect to appl y the changes from

© 2019, M icr o St r at egy In c. 443

Syst em Ad m in ist r at io n Gu id e

each devel oper. If a change causes a probl em w i th the test proj ect,
the admi ni strator can undo the package i mport process.

If y our update pac k age inc ludes any s c hema objec ts , y ou may need to
update the projec t s c hema after importing the pac k age. For more
information about updating the s c hema after importing an update
pac k age, s ee U pdate Packages and U pdati ng the Proj ect Schema,
page 465 .

Ab o u t Up d at e Packages
An update package i s a fi l e contai ni ng a set of obj ect defi ni ti ons and
confl i ct resol uti on rul es. When you create an update package, you
fi rst add obj ects, and then speci fy how any confl i ct i nvol vi ng the
obj ects i s resol ved. For more i nformati on on resol vi ng confl i cts w i th
obj ects, see R esol vi ng C onfl i cts w hen C opyi ng Obj ects, page 434.

In addi ti on to the standard Obj ect Manager confl i ct resol uti on rul es
(see R esol vi ng C onfl i cts w hen C opyi ng Obj ects, page 434), tw o
addi ti onal rul es are avai l abl e for update packages:

l Force R eplace: R epl ace the obj ect i n the desti nati on proj ect w i th
the versi on of the obj ect i n the update package, even i f both
versi ons of the obj ect have the same Versi on ID .

l D elete: D el ete the obj ect from the desti nati on proj ect. The versi on
of the obj ect i n the update package i s not i mported i nto the
desti nati on proj ect.

If the objec t in the des tination has any us ed-by dependenc ies when y ou
import the update pac k age, the import will fail.

Obj ect Manager supports the fol l ow i ng ki nds of update packages:

l Project update packages contai n appl i cati on and schema obj ects
from a si ngl e proj ect.

444 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l C onfiguration update packages contai n confi gurati on obj ects from

a si ngl e proj ect source.

l Project security update packages contai n securi ty i nformati on

about users and user groups, such as pri vi l eges, securi ty rol es, and
securi ty fi l ters, for a si ngl e proj ect. Si nce these update packages
i nvol ve users and groups, w hi ch are confi gurati on obj ects, they are
created at the same ti me as confi gurati on update packages.

l U ndo packages enabl e you to reverse the changes made by

i mporti ng one of the other types of packages. You create undo
packages based on exi sti ng update packages. For more i nformati on
about undo packages, i ncl udi ng i nstructi ons on creati ng and
i mporti ng them, see R ol l i ng Back C hanges: U ndo Packages, page
466.

Updating Project Access Information for Users and Groups

You can i ncl ude users and groups i n a confi gurati on update package.
H ow ever, the proj ect access i nformati on, such as pri vi l eges, securi ty
rol es, and securi ty fi l ters, for those users and groups i s not i ncl uded
i n the confi gurati on update package, because thi s i nformati on can be
di fferent for each proj ect.

Spec ific ally , c onfiguration update pac k ages do not inc lude the
information found in the Project A ccess and Security Filter
c ategories of the Us er Editor or Group Editor. All other us er and group
information is inc luded in the c onfiguration update pac k age when y ou
add a us er or group to the pac k age.

To update your users and groups w i th the proj ect access i nformati on
for each proj ect, you must create a proj ect securi ty update package
for each proj ect. You create these packages at the same ti me that you
create the confi gurati on update package, by sel ecti ng the C reate
project security packages check box and speci fyi ng w hi ch proj ects
you w ant to create a proj ect securi ty update package for. For detai l ed

© 2019, M icr o St r at egy In c. 445

Syst em Ad m in ist r at io n Gu id e

i nstructi ons on creati ng a confi gurati on update package and proj ect
securi ty update packages, see C reati ng a C onfi gurati on U pdate
Package, page 449.

You mus t import the c onfiguration update pac k age before importing the
projec t s ec urity update pac k ages .

Cr eat in g an Up d at e Package
You create update packages from w i thi n Obj ect Manager. From the
C reate Package di al og box, you sel ect the obj ects to copy from the
source proj ect, and the rul es that govern the cases w hen these
obj ects al ready exi st i n the desti nati on proj ect.

You can al so create update packages from the command l i ne, usi ng
rul es speci fi ed i n an XML fi l e. In the C reate Package di al og box, you
speci fy a contai ner obj ect, such as a fol der, search obj ect, or obj ect
prompt, and speci fy the confl i ct resol uti on rul es. Obj ect Manager
creates an XML fi l e based on your speci fi cati ons. You can then use
that XML fi l e to create an update package that contai ns al l obj ects
i ncl uded i n the contai ner. For more i nformati on and i nstructi ons, see
C reati ng an U pdate Package from the C ommand Li ne, page 452.

l Configuration update pac k ages and projec t s ec urity update pac k ages
are c reated s lightly differently from projec t update pac k ages . For
ins truc tions on how to c reate a c onfiguration update pac k age and
as s oc iated projec t s ec urity update pac k ages , s ee C reati ng a
C onfi gurati on U pdate Package, page 449 .

l By default, us ers c annot c reate projec t update pac k ages in read-only

mode. This is bec aus e objec ts , and their us ed dependenc ies , may be
c hanged between the time they are s elec ted for inc lus ion in the update
pac k age and the time the pac k age is ac tually generated. For more
information, s ee Proj ect Locki ng w i th Obj ect Manager, page 418 .

446 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To Create a Project Update Package

1. In Obj ect Manager, l og i n to a proj ect.

2. From the Tools menu, sel ect C reate Package.

You c an als o open this dialog box from the Conflic t Res olution
dialog box by c lic k ing C reate Package . In this c as e, all objec ts in
the Conflic t Res olution dialog box , and all dependents of thos e
objec ts , are automatic ally inc luded in the pac k age.

© 2019, M icr o St r at egy In c. 447

Syst em Ad m in ist r at io n Gu id e

Ad d i ng Ob j ect s t o t he Package

1. To add obj ects to the package, do one of the fol l ow i ng:

l D rag and drop obj ects from the Obj ect Brow ser i nto the C reate
Package di al og box.

l C l i ck A dd. Sel ect the desi red obj ects and cl i ck >. Then cl i ck
OK .

l C l i ck A dd. You can i mport the resul ts of a previ ousl y saved

search obj ect.

2. To add the dependents of al l obj ects to the package, cl i ck A dd

all used dependencies.

If the dependent objec ts for a s pec ific objec t do not ex is t in either

the des tination projec t s ourc e or in the update pac k age, the update
pac k age c annot be applied. If y ou c hoos e not to add dependent
objec ts to the pac k age, mak e s ure that all dependent objec ts are
inc luded in the des tination projec t s ourc e.

3. To add the dependents of speci fi c obj ects, sel ect those obj ects,
ri ght-cl i ck, and sel ect A dd used dependencies.

Conf i gur i ng t he Package

1. To change the confl i ct resol uti on acti on for an obj ect, doubl e-
cl i ck the A ction col umn for the obj ect and sel ect the new acti on
from the drop-dow n l i st. For an expl anati on of the acti ons, see
R esol vi ng C onfl i cts w hen C opyi ng Obj ects, page 434.

2. Sel ect the schema update opti ons for thi s package. For more
detai l s on these opti ons, see U pdate Packages and U pdati ng the
Proj ect Schema, page 465.

3. Sel ect the AC L opti ons for obj ects i n thi s package. For more
detai l s on these opti ons, see R esol vi ng C onfl i cts w hen C opyi ng
Obj ects, page 434.

448 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Savi ng t he Package

1. Enter the name and l ocati on of the package fi l e i n the Save A s

fi el d. The defaul t fi l e extensi on for update packages i s .mmp.

You c an s et the default loc ation in the Objec t Manager Preferenc es

dialog box , in the Object Manager: B rowsing c ategory .

2. To save a l og fi l e contai ni ng i nformati on about the package's

contents i n the Obj ect Manager di rectory, from the File menu
sel ect Save A s Text File or Save A s Excel File.

3. When you have added al l obj ects to the package, cl i ck Proceed.

Creating a Configuration Update Package

A confi gurati on update package contai ns confi gurati on obj ects from a
proj ect source, i nstead of appl i cati on and schema obj ects from a
si ngl e proj ect. As such, confi gurati on update packages are created at
the proj ect source l evel .

If y ou c hoos e to inc lude us ers or groups in a c onfiguration update

pac k age, projec t ac c es s information (s uc h as priv ileges , s ec urity roles ,
and s ec urity filters ) is not inc luded in the c onfiguration pac k age. To
migrate projec t ac c es s information about the us ers or groups , y ou mus t
c reate a projec t s ec urity update pac k age for eac h projec t at the s ame
time y ou c reate the c onfiguration update pac k age. For more information
about projec t s ec urity pac k ages , s ee U pdati ng Proj ect Access
Informati on for U sers and Groups, page 445 .

To Create a Configuration Update Package

1. In Obj ect Manager, l og i n to a proj ect source.

2. In the fol der l i st, sel ect the top-l evel proj ect source.

© 2019, M icr o St r at egy In c. 449

Syst em Ad m in ist r at io n Gu id e

3. From the Tools menu, sel ect C reate C onfiguration Package.

You c an als o open this dialog box from the Conflic t Res olution
dialog box by c lic k ing C reate Package . In this c as e, all objec ts in
the Conflic t Res olution dialog box , and all dependents of thos e
objec ts , are automatic ally inc luded in the pac k age.

Ad d i ng Conf i gur at i on Ob j ect s t o t he Package

1. To add confi gurati on obj ects to the package, cl i ck A dd

C onfiguration Objects.

2. Search for the obj ects you w ant to add to the package.

3. When the obj ects are l oaded i n the search area, cl i ck and drag
them to the C reate Package di al og box.

4. When you have added al l the desi red obj ects to the package,
cl ose the C onfi gurati on - Search for Obj ects di al og box.

5. To add the dependents of al l obj ects to the package, cl i ck A dd

all used dependencies.

If the dependent objec ts for a s pec ific objec t do not ex is t in either

the des tination projec t s ourc e or in the update pac k age, the update
pac k age c annot be applied. If y ou c hoos e not to add dependent
objec ts to the pac k age, mak e s ure that all dependent objec ts are
inc luded in the des tination projec t s ourc e.

6. To add the dependents of speci fi c obj ects, sel ect those obj ects
and cl i ck A dd used dependencies.

45 0 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Cr eat i ng Packages f or Pr oj ect -Level U ser and Gr oup Access

1. If your proj ect i ncl udes users or groups, and you w ant to i ncl ude
proj ect-l evel i nformati on about those users or groups, sel ect the
C reate project security packages check box. For i nformati on
about proj ect securi ty packages, see U pdati ng Proj ect Access
Informati on for U sers and Groups, page 445.

2. In the Projects area, sel ect the check boxes next to the proj ects
you w ant to create proj ect securi ty packages for.

Conf i gur i ng t he Package

1. To change the confl i ct resol uti on acti on for an obj ect, doubl e-
cl i ck the A ction col umn for the obj ect and sel ect the new acti on
from the drop-dow n l i st. For an expl anati on of the acti ons, see
R esol vi ng C onfl i cts w hen C opyi ng Obj ects, page 434.

If y ou are c reating projec t s ec urity update pac k ages , y ou mus t

s elec t R eplace as the c onflic t res olution ac tion for all us ers and
groups . Otherwis e the projec t-lev el s ec urity information about
thos e us ers and groups is not c opied into the des tination projec t.

2. Sel ect the AC L opti ons for obj ects i n thi s package. For more
detai l s on these opti ons, see R esol vi ng C onfl i cts w hen C opyi ng
Obj ects, page 434.

Savi ng t he Package

1. Enter the name and l ocati on of the package fi l e i n the Save A s

fi el d. The defaul t fi l e extensi on for update packages i s . m m p.

Projec t s ec urity update pac k ages are named P r o j e c t S o u r c e_

Pr oj e c t N a m e. m m p , and are c reated in the s ame loc ation as the
c onfiguration update pac k age.

© 2019, M icr o St r at egy In c. 45 1

Syst em Ad m in ist r at io n Gu id e

2. To save a l og fi l e contai ni ng i nformati on about the package's

contents i n the Obj ect Manager di rectory, from the File menu
sel ect Save A s Text File or Save A s Excel File.

3. When you have added al l obj ects to the package, cl i ck Proceed.

Creating an Update Package from the Command Line

You may w ant to schedul e the creati on of an update package at a

l ater ti me, so that the proj ect i s not l ocked duri ng normal busi ness
hours. Or you may w ant to create a package contai ni ng certai n
obj ects on a speci fi c schedul e. For exampl e, you may w ant to create
a new package every w eek that contai ns al l the new metri cs from the
devel opment proj ect.

You can use Obj ect Manager to create an XML fi l e speci fyi ng w hat
obj ects are to be i ncl uded i n the update package. That XML fi l e can
then be used to create the package from the command l i ne.

The XML fi l e speci fi es a contai ner obj ect i n the source proj ect, that i s,
a fol der, search obj ect, or obj ect prompt. When you create the
package from the XML fi l e, al l obj ects i ncl uded i n that contai ner
obj ect are i ncl uded i n the update package, as l i sted i n the tabl e
bel ow :

If the XML file s pe c ifie s a ... The upda te pa c k a ge c onta ins ...

Folder A ll object s in t he f older

S earch object A ll object s ret urned by t he search

Object prompt A ll object s ret urned by t he prompt

To c reate an XML file for a c onfiguration update pac k age, s ee Manual l y

C reati ng an U pdate Package C reati on XML Fi l e, page 455 . You
c annot c reate a c onfiguration update pac k age XML file from within

45 2 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Objec t Manager bec aus e c ontainer objec ts do not ex is t at the projec t

s ourc e lev el.

To Create an XML File for Creating an Update Package from the

Command Line

1. In Obj ect Manager, l og i n to a proj ect.

2. From the Tools menu, sel ect C reate Package.

Ad d i ng a Cont ai ner Ob j ect t o t he Package

1. C l i ck A dd.

2. You need to speci fy w hat to use as a contai ner obj ect. You can
use a search obj ect, obj ect prompt, or fol der. To speci fy a search
obj ect or obj ect prompt as the contai ner obj ect:

l Make sure the Import selected objects opti on i s sel ected.

l In the A vailable objects area, brow se to the search obj ect or

obj ect prompt.

l Sel ect the search obj ect or obj ect prompt and cl i ck >.

3. OR , to speci fy a fol der as the contai ner obj ect:

l Sel ect the Import folder and children recursively opti on.

l Type the name of the fol der i n the fi el d, or cl i ck ... (the brow se
button) and brow se to the fol der.

4. Sel ect the R eturn as a container to create XML checkbox.

5. C l i ck OK .

6. To add the dependents of al l obj ects to the package, sel ect the
A dd all used dependencies check box. Al l dependent obj ects of
al l obj ects i ncl uded i n the contai ner obj ect w i l l be i ncl uded i n
the package w hen i t i s created.

© 2019, M icr o St r at egy In c. 45 3

Syst em Ad m in ist r at io n Gu id e

If the dependent objec ts for a s pec ific objec t do not ex is t in either

the des tination projec t or in the update pac k age, the update
pac k age c annot be applied. If y ou c hoos e not to inc lude dependent
objec ts in the pac k age, mak e s ure that all dependent objec ts are
inc luded in the des tination projec t.

Conf i gur i ng t he Package

1. To change the confl i ct resol uti on acti on for an obj ect, doubl e-
cl i ck the A ction col umn for the obj ect and sel ect the new acti on
from the drop-dow n l i st. For an expl anati on of the acti ons, see
R esol vi ng C onfl i cts w hen C opyi ng Obj ects, page 434.

2. Sel ect the schema update opti ons for thi s package. For more
detai l s on these opti ons, see U pdate Packages and U pdati ng the
Proj ect Schema, page 465.

3. Sel ect the AC L opti ons for obj ects i n thi s package. For more
detai l s on these opti ons, see R esol vi ng C onfl i cts w hen C opyi ng
Obj ects, page 434.

Savi ng t he XM L Fi l e

1. Enter the name and l ocati on of the package fi l e to be created by

thi s XML i n the Save A s fi el d. The defaul t fi l e extensi on for
update packages i s . m m p.

You c an s et the default loc ation in the Objec t Manager Preferenc es

dialog box , in the Object Manager: B rowsing c ategory .

2. C l i ck C reate XML. You are prompted to type the name and

l ocati on of the XML fi l e. By defaul t, thi s i s the same as the name
and l ocati on of the package fi l e, w i th an . x m l extensi on i nstead
of . mm p .

3. C l i ck Save.

45 4 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To Create an Update Package from an XML File

Creating a pac k age from the c ommand line loc k s the projec t metadata
for the duration of the pac k age c reation. Other us ers c annot mak e any
c hanges to the projec t until it bec omes unloc k ed. For detailed
information about the effec ts of loc k ing a projec t, s ee Locki ng
Proj ects, page 416 .

C al l the Proj ect Merge executabl e, p r o j e c t m e r g e . e x e, w i th the

fol l ow i ng parameters:

Effe c t Pa r a me te r

Use t his X ML f ile t o creat e an updat e package (required) -fFilename.xml

Log int o t he project source wit h t his password (t he login I D t o be

-spPassw ord
used is st ored in t he X ML f ile)

Log int o t he project wit h t his password (t he login I D t o be used is

-smpPassw ord
st ored in t he X ML f ile)

S uppress st at us updat es (usef ul f or creat ing an updat e package in

-sup
t he background, so t hat t he st at us window does not appear)

Manually Creating an Update Package Creation XML File

You can al so create the XML fi l e to create an update package w i thout

openi ng Obj ect Manager. To do thi s, you fi rst copy a sampl e XML fi l e
that contai ns the necessary parameters, and then edi t that copy to
i ncl ude a l i st of the obj ects to be mi grated and confl i ct resol uti on
rul es for those obj ects.

This is the only way to c reate an XML file to c reate a c onfiguration

update pac k age.

Sampl e package creati on XML fi l es for proj ect update packages and
confi gurati on update packages are i n the Obj ect Manager fol der. By

© 2019, M icr o St r at egy In c. 45 5

Syst em Ad m in ist r at io n Gu id e

defaul t thi s fol der i s C : \ P r o g r a m F i l e s

(x86 )\ Mi cr o S t r a t e g y \ O b j e c t M a n a g e r \.

The XML file has the s ame s truc ture as an XML file c reated us ing the
Projec t Merge Wiz ard. For more information about c reating an XML file
for us e with Projec t Merge, s ee Mergi ng Proj ects to Synchroni ze
Obj ects, page 467 .

High-Level Steps to Manually Create an Update Package Creation

XML File

1. Make a copy of one of the sampl e XML fi l es:

l To create a proj ect update package, copy the fi l e

cr ea te P r o j e c t P a c k a g e . x m l.

l To create a confi gurati on update package, copy the fi l e

cr ea te C o n f i g P a c k a g e . x m l.

2. Edi t your copy of the XML fi l e to i ncl ude the fol l ow i ng

i nformati on, i n the appropri ate XML tags:

l SearchID (proj ect update package onl y): The GU ID of a search

obj ect that returns the obj ects to be added to the proj ect
update package.

l TimeStamp (confi gurati on update package onl y): A ti mestamp,

of the form MM/D D /YYYY hh:mm:ss (am/pm). Al l confi gurati on
obj ects modi fi ed after that ti mestamp are i ncl uded i n the
update package.

l PackageFile: The name and path of the update package. If a

package w i th thi s name al ready exi sts i n thi s path, the creati on
ti mestamp i s appended to the name of the package created by
thi s fi l e.

45 6 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l A ddD ependents:

l Yes for the package to i ncl ude al l dependents of al l obj ects

i n the package.

l N o for the package to onl y i ncl ude the speci fi ed obj ects.

l Location: In a three-ti er system, thi s i s the name of the

machi ne that i s used to connect to the proj ect source. In a tw o-
ti er system, thi s i s the D SN used to connect to the proj ect
source.

l Project (proj ect update package onl y): The proj ect contai ni ng
the obj ects to i ncl ude i n the update package.

l C onnectionMode:

l 2-tier for a di rect (2-ti er) proj ect source connecti on.

l 3-tier for a server (3-ti er) proj ect source connecti on.

3. A uthenticationMode: The authenti cati on mode used to connect

to the proj ect source, ei ther Standard or Windows.

4. Login: The user name to connect to the proj ect source. You must
provi de a passw ord for the user name w hen you run the XML fi l e
from the command l i ne.

5. For a proj ect update package, you can speci fy confl i ct resol uti on
rul es for i ndi vi dual obj ects. In an Operation bl ock, speci fy the ID
(GU ID ) and Type of the obj ect, and the acti on to be taken. For
i nformati on about the acti ons that can be taken i n confl i ct
resol uti on, see R esol vi ng C onfl i cts w hen C opyi ng Obj ects, page
434.

6. Save the XML fi l e.

7. When you are ready to create the update package from the XML
fi l e, cal l the Proj ect Merge executabl e, p r o j e c t m e r g e . e x e, as

© 2019, M icr o St r at egy In c. 45 7

Syst em Ad m in ist r at io n Gu id e

descri bed i n To C reate an U pdate Package from an XML Fi l e,

page 455.

Editing an Update Package

You can make changes to an update package after i t has been

created. You can remove obj ects from the package, change the
confl i ct resol uti on rul es for obj ects i n the package, and set the
schema update and AC L opti ons for the package.

You c annot add objec ts to an update pac k age onc e it has been c reated.
Ins tead, y ou c an c reate a new pac k age c ontaining thos e objec ts .

To Edit an Update Package

1. In Obj ect Manager, l og i n to a proj ect or proj ect source.

2. From the Tools menu, sel ect Import Package or Import

C onfiguration Package.

3. In the Selected Package fi el d, type the name and path of the

update package, or cl i ck ... (the brow se button) to brow se to the
update package.

4. C l i ck Edit. The Edi ti ng pane opens at the bottom of the di al og

box, as show n bel ow .

45 8 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

5. To change the confl i ct resol uti on acti on for an obj ect, doubl e-
cl i ck i n the D efinition R ule col umn for that obj ect and, from the
drop-dow n l i st, sel ect the new confl i ct resol uti on rul e.

When y ou edit a pac k age, the C reate N ew ac tion is c hanged to

the R eplace ac tion.

6. To rename an obj ect i n the desti nati on proj ect, doubl e-cl i ck i n
the R ename col umn for that obj ect and type the new name for
the obj ect.

7. To remove an obj ect from the update package, sel ect the obj ect
and cl i ck R emove.

8. You can al so change the schema update opti ons (for a proj ect
update package onl y) or the access control l i st confl i ct resol uti on
opti ons. For i nformati on about the schema update opti ons, see
U pdate Packages and U pdati ng the Proj ect Schema, page 465.
For i nformati on about the AC L confl i ct resol uti on opti ons, see
R esol vi ng C onfl i cts w hen C opyi ng Obj ects, page 434.

9. To create a text fi l e contai ni ng a l i st of the obj ects i n the update

package and thei r confl i ct resol uti on acti ons, cl i ck Export.

10. When you are done maki ng changes to the update package, cl i ck
Save A s. The defaul t new name for the update package i s the
ori gi nal name of the package w i th a date and ti me stamp
appended. C l i ck Save.

Imp o r t in g an Up d at e Package
An update package i s saved i n a fi l e, and can be freel y copi ed and
moved betw een machi nes.

If y ou are importing a pac k age that is s tored on a mac hine other than the

© 2019, M icr o St r at egy In c. 45 9

Syst em Ad m in ist r at io n Gu id e

Intelligenc e Serv er mac hine, mak e s ure the pac k age c an be ac c es s ed by

the Intelligenc e Serv er mac hine.

Before importing any projec t s ec urity update pac k ages , y ou mus t import
the as s oc iated c onfiguration update pac k age.

Importing a pac k age c aus es the projec t metadata to bec ome loc k ed for
the duration of the import. Other us ers c annot mak e any c hanges to the
projec t until it bec omes unloc k ed. For detailed information about the
effec ts of loc k ing a projec t, s ee Locki ng Proj ects, page 416 .

You can i mport an update package i nto a proj ect or proj ect source i n
the fol l ow i ng w ays:

l From within Object Manager: You can use the Obj ect Manager
graphi cal i nterface to i mport an update package.

l From the command line: Mi croStrategy provi des a command l i ne

uti l i ty for i mporti ng update packages. You can use a schedul er such
as Wi ndow s Schedul er to i mport the package at a l ater ti me, such
as w hen the l oad on the desti nati on proj ect i s l i ght.

The c ommand line Import Pac k age utility only s upports Standard and
Windows Authentic ation. If y our projec t s ourc e us es a different form
of authentic ation, y ou c annot us e the Import Pac k age utility to import
an update pac k age.

You can al so create an XML fi l e to i mport an update package

from the command l i ne, si mi l ar to usi ng an XML fi l e to create an
update package as descri bed i n C reati ng an U pdate Package
from the C ommand Li ne, page 452.

l U sing a C ommand Manager script: You can al so execute a

C ommand Manager scri pt to i mport an update package w i thout
usi ng Obj ect Manager. C ommand Manager i s an admi ni strati ve tool
that enabl es you to perform vari ous admi ni strati ve and proj ect
devel opment tasks by usi ng text commands that can be saved as

460 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

scri pts. For more i nformati on about C ommand Manager, see

C hapter 15, Automati ng Admi ni strati ve Tasks w i th C ommand
Manager.

To Import an Update Package from Object Manager

1. In Obj ect Manager, l og i n to the desti nati on proj ect or proj ect
source.

2. From the Tools menu, sel ect Import Package (for a proj ect
update package) or Import C onfiguration Package (for a
confi gurati on update package).

3. In the Selected Package fi el d, type the name and path of the

update package, or cl i ck ... (the brow se button) to brow se to the
update package.

4. In the U ndo Package Options, sel ect w hether to i mport thi s

update package, generate an undo package for thi s update
package, or both. For more i nformati on about undo packages,
see R ol l i ng Back C hanges: U ndo Packages, page 466.

5. To create a l og fi l e descri bi ng the changes that w oul d be made i f

the update package w ere i mported, i nstead of i mporti ng the
update package, sel ect the Generate Log Only checkbox.

6. C l i ck Proceed.

© 2019, M icr o St r at egy In c. 461

Syst em Ad m in ist r at io n Gu id e

Any objec ts that ex is t in different folders in the update pac k age

and the des tination projec t are handled ac c ording to the
Synchronize folder locations in source and destination
for migrated objects preferenc e in the Migration c ategory in
the Objec t Manager Preferenc es dialog box .

7. If the package made any changes to the proj ect schema, you may
need to update the schema for the changes to take effect. To
update the proj ect schema, from the Obj ect Manager Project
menu, sel ect U pdate Schema.

To Import an Update Package from the Command Line

C al l the Import Package executabl e, M A I m p o r t P a c k a g e . e x e. By

defaul t, thi s fi l e i s l ocated i n C : \ P r o g r a m Fi l e s ( x 8 6 ) \ C o m m on
File s\ Mi cr o S t r a t e g y. U se the fol l ow i ng parameters:

Only Standard Authentic ation and Windows Authentic ation are

s upported by the Import Pac k age utility .

Effe c t Pa r a me te r

-n
I mport package int o t his project source (required)
ProjectSourceName

Log int o t he project source wit h t his MicroS t rat egy username -u UserName
and password, using st andard aut hent icat ion (required unless
-p Password
you are using Windows aut hent icat ion)

I mport t his package int o t he specif ied project source

(required)
-f
The locat ion must be specif ied relat ive t o t he PackageLocation
I nt elligence S erver machine, not relat ive t o t he machine
running t he I mport P ackage ut ilit y.

I mport t he package int o t his project (required f or project -j ProjectName

462 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Effe c t Pa r a me te r

updat e packages)

Log inf ormat ion about t he import process t o t his f ile

-l LogLocation
The locat ion of t he log f ile must be specif ied relat ive t o
t he machine running t he I mport P ackage ut ilit y.

Force a conf igurat ion or project lock prior t o import ing t he

package. This lock is released af t er t he package is import ed.
-forcelocking
For more inf ormat ion about project and conf igurat ion locking,
see Loc king Projec ts , page 416 .

A ful l l i st of parameters can be accessed from a command prompt by

enteri ng i mp o r t p a c k a g e . e x e - h .

To Import an Update Package Using an XML File

Cr eat e t he XM L Fi l e

1. In Obj ect Manager, l og i n to the desti nati on proj ect or proj ect
source.

2. From the Tools menu, sel ect Import Package (for a proj ect
update package) or Import C onfiguration Package (for a
confi gurati on update package).

3. In the Selected Package fi el d, type the name and path of the

update package, or cl i ck ... (the brow se button) to brow se to the
update package.

4. Sel ect the Save import package XML file checkbox.

5. C l i ck Proceed. You are prompted to type the name and l ocati on

of the XML fi l e. By defaul t, thi s i s the same as the name and

© 2019, M icr o St r at egy In c. 463

Syst em Ad m in ist r at io n Gu id e

l ocati on of the package fi l e, w i th an . x m l extensi on i nstead of

. mm p . C l i ck Save.

6. When you are ready to i mport the update package, cal l the
Proj ect Merge executabl e, p r o j e c t m e r g e . e x e, w i th the
fol l ow i ng parameters:

Effe c t Pa r a me te r

-
Use t his X ML f ile t o import an updat e package (required) f
Filename.xml

Log int o t he project source wit h t his password (t he login I D t o be

-spPassw ord
used is st ored in t he X ML f ile)

Log int o t he project wit h t his password (t he login I D t o be used is -

st ored in t he X ML f ile) smpPassw ord

S uppress st at us updat es (usef ul f or import ing an updat e package in

-sup
t he background, so t hat t he st at us window does not appear)

To Import an Update Package Using Command Manager

C al l a C ommand Manager scri pt that contai ns the fol l ow i ng command:

IMPO RT PA CK A G E " F i l e n a m e . m m p" [ F O R P R O J E C T

"Pro je ct Na m e " ] ;

w here " Fi le n a m e" i s the name and l ocati on of the update package,
and " Pr oj ec t N a m e" i s the name of the proj ect that the update i s to
be appl i ed to.

If the pac k age made any c hanges to the projec t s c hema, y ou need to
update the s c hema for the c hanges to tak e effec t. The s y ntax for
updating the s c hema in a Command Manager s c ript is

UP DA TE S C H E M A [R E F R E S H S C H E M A ] [ R E C A L T A B L E K E Y S ]

464 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

[R EC AL T A B L E L O G IC A L ] [ R E C A L O B J E C T C A C H E ] F O R
PR OJ EC T " P r o j e ct N a m e" ;

Up d at e Packages an d Up d at in g t h e Pr o ject Sch ema

If a proj ect update package contai ns new or repl acement schema
obj ects, then w hen the package i s i mported the user must update the
i n-memory defi ni ti ons of these obj ects. Thi s i s done by updati ng the
proj ect schema.

When you create an update package, you can confi gure i t to

automati cal l y perform the fol l ow i ng schema update functi ons:

l R ecalculate table keys and fact entry levels, i f you changed the
key structure of a tabl e or i f you changed the l evel at w hi ch a fact i s
stored.

l R ecalculate table logical sizes, to overri de any modi fi cati ons that
you have made to l ogi cal tabl e si zes. (Logi cal tabl e si zes affect
how the Mi croStrategy SQL Engi ne determi nes w hi ch tabl es to use
i n a query.)

The update package cannot recal cul ate the obj ect cl i ent cache si ze,
and i t cannot update the schema l ogi cal i nformati on. These tasks
must be performed manual l y. So, for exampl e, i f you i mport an
attri bute that has a new attri bute form, you must manual l y update the
proj ect schema before any obj ects i n the proj ect can use that attri bute
form.

You can update the proj ect schema i n the fol l ow i ng w ays:

l In Obj ect Manager, sel ect the proj ect and, from the Project menu,
sel ect U pdate Schema.

l In D evel oper, l og i nto the proj ect and, from the Schema menu,
sel ect U pdate Schema.

l C al l a C ommand Manager scri pt w i th the fol l ow i ng command:

© 2019, M icr o St r at egy In c. 465

Syst em Ad m in ist r at io n Gu id e

UPDATE SCHEMA [REFRESHSCHEMA] [RECALTABLEKEYS]

[RECALTABLELOGICAL] [RECALOBJECTCACHE] FOR PROJECT
"projectname";

Updating the s c hema c an als o be ac c omplis hed by unloading and

reloading the projec t. For information on loading and unloading projec ts ,
s ee Setti ng the Status of a Proj ect, page 51 .

For more detai l ed i nformati on about updati ng the proj ect schema, see
the Opti mi zi ng and Mai ntai ni ng your Proj ect secti on i n the Proj ect
D esi gn Gui de.

Ro llin g Back Ch an ges: Un d o Packages

You can use undo packages to rol l back the changes made by an
update package. An undo package i s an automati cal l y created update
package consi sti ng of al l the obj ects i n an update package, as they
are currentl y confi gured i n the desti nati on proj ect. For exampl e, i f you
create an undo package for an update package contai ni ng a new
versi on of three metri cs, the undo package contai ns the versi on of
those three metri cs that currentl y exi sts i n the desti nati on proj ect.

When you i mport an update package, you have the opti on of creati ng
an undo package at the same ti me as the i mport. Al ternatel y, you can
choose to create an undo package w i thout i mporti ng the associ ated
update package.

You i mport an undo package i n the same w ay as you i mport any

update package. When you i mport an undo package, the Versi on ID
and Modi fi cati on D ate of al l obj ects i n the undo package are restored
to thei r val ues before the ori gi nal update package w as i mported.

The Intelligenc e Serv er c hange journal rec ords the importing of both the
original update pac k age and the undo pac k age. Importing an undo
pac k age does not remov e the c hange journal rec ord of the original

466 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

update pac k age. For more information about the c hange journal, s ee
Moni tori ng System Acti vi ty: C hange Journal i ng, page 489 .

Merging Projects to Synchronize Objects

You can use Mi croStrategy Proj ect Merge to synchroni ze a l arge
number of obj ects betw een proj ects. Proj ect Merge streaml i nes the
task of mi grati ng obj ects from one proj ect to another. Whi l e you can
use Obj ect Manager to copy obj ects i ndi vi dual l y, Proj ect Merge can
be used as a bul k copy tool . For di fferences betw een Obj ect Manager
and Proj ect Merge, see C ompari ng Proj ect Merge to Obj ect Manager,
page 415.

The rul es that you use to resol ve confl i cts betw een the tw o proj ects i n
Proj ect Merge can be saved to an XML fi l e and reused. You can then
execute Proj ect Merge repeatedl y usi ng thi s rul e fi l e. Thi s al l ow s you
to schedul e a proj ect merge on a recurri ng basi s. For more detai l s
about schedul i ng proj ect merges, see Mergi ng Proj ects w i th the
Proj ect Merge Wi zard, page 469.

Proj ect Merge mi grates an enti re proj ect. Al l obj ects are copi ed to the
desti nati on proj ect. Any obj ects that are present i n the source proj ect
but not the desti nati on proj ect are created i n the desti nati on proj ect.

l If y ou want to merge two projec ts , Mic roStrategy rec ommends that

the projec ts hav e related s c hemas . This means that either one projec t
mus t be a duplic ate of the other, or both projec ts mus t be duplic ates of
a third projec t. For information about duplic ating projec ts , inc luding
ins truc tions , s ee D upl i cati ng a Proj ect, page 405 .

l To merge two projec ts that do not hav e related s c hemas , the projec ts
mus t either hav e been c reated with Mic roStrategy 9.0.1 or later, or
hav e been updated to v ers ion 9.0.1 or later us ing the Perform
system object ID unification option. For information about this
upgrade, s ee the U pgrade Gui de .

© 2019, M icr o St r at egy In c. 467

Syst em Ad m in ist r at io n Gu id e

l Projec t Merge does not trans fer us er and group permis s ions on
objec ts . To migrate permis s ions from one projec t to another, us e a
projec t s ec urity update pac k age. For more information, s ee C opyi ng
Obj ects i n a Batch: U pdate Packages, page 443 .

Proj ects may need to be merged at vari ous poi nts duri ng thei r l i fe
cycl e. These poi nts may i ncl ude:

l Mi grati ng obj ects through devel opment, testi ng, and producti on
proj ects as the obj ects become ready for use.

l R ecei vi ng a new versi on of a proj ect from a proj ect devel oper.

In ei ther case, you must move obj ects from devel opment to testi ng,
and then to the producti on proj ects that your users use every day.

Topi cs covered i n thi s secti on i ncl ude:

What happens when You Merge Projects

Proj ect Merge requi res a source proj ect, a desti nati on proj ect, and a
set of rul es to resol ve obj ect confl i cts betw een the tw o proj ects. Thi s
set of rul es i s defi ned i n the Proj ect Merge Wi zard or l oaded from an
XML fi l e.

In the Mi croStrategy system, every obj ect has an ID (or GU ID ) and a

versi on. (To see the ID and versi on of an obj ect, ri ght-cl i ck the obj ect
and sel ect Properties.) Proj ect Merge checks the desti nati on proj ect
for the exi stence of every obj ect i n the source proj ect, by ID . The
resul ti ng possi bi l i ti es are descri bed bel ow :

l If an obj ect ID does not exi st i n the desti nati on proj ect, the obj ect i s
copi ed from the source proj ect to the desti nati on proj ect.

l If an obj ect exi sts i n the desti nati on proj ect and has the same obj ect
ID and versi on i n both proj ects, the obj ects are i denti cal and a copy
i s not performed.

468 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l If an obj ect exi sts i n the desti nati on proj ect and has the same obj ect
ID i n both proj ects but a di fferent versi on, there i s a confl i ct that
must be resol ved. The confl i ct i s resol ved by fol l ow i ng the set of
rul es speci fi ed i n the Proj ect Merge Wi zard and stored i n an XML
fi l e. The possi bl e confl i ct resol uti ons are di scussed i n R esol vi ng
C onfl i cts w hen Mergi ng Proj ects, page 475.

Merging projec ts with the Projec t Merge Wiz ard does not update the
modific ation date of the projec t, as s hown in the Projec t Configuration
Editor. This is bec aus e, when c opy ing objec ts between projec ts , only
the objec ts thems elv es c hange. The definition of the projec t its elf is not
modified by Projec t Merge.

Merging Projects with the Project Merge Wizard

The Proj ect Merge Wi zard al l ow s you to speci fy rul es and setti ngs for
a proj ect merge. For detai l s about al l setti ngs avai l abl e w hen runni ng
the w i zard, see the H el p. For i nformati on about the rul es for resol vi ng
confl i cts, see R esol vi ng C onfl i cts w hen Mergi ng Proj ects, page 475.

After goi ng through the steps i n the w i zard, you can ei ther execute the
merge ri ght aw ay or save the rul es and setti ngs i n a Proj ect Merge
XML fi l e. You can use thi s fi l e to run Proj ect Merge from the Wi ndow s
command prompt (see R unni ng Proj ect Merge from the C ommand
Li ne, page 471) or to schedul e a merge (see Schedul i ng a Proj ect
Merge, page 474).

Before y ou us e Projec t Merge in a s erv er (three-tier) env ironment,

c hec k the projec t s ourc e time out s etting. In Dev eloper, right-c lic k on
the projec t s ourc e and s elec t Modify Project Source to open the
Project Source Manager . On the C onnection tab, either dis able the
C onnection times out after s etting by c learing its c hec k box , or els e
enter a s uffic ient number of minutes for when the c onnec tion s hould
time out, c ons idering how long the merge proc es s es may tak e bas ed on
the s iz e of the projec ts . If y ou are uns ure about a s etting and hav e

© 2019, M icr o St r at egy In c. 469

Syst em Ad m in ist r at io n Gu id e

notic ed other proc es s es tak ing a long time, it is rec ommended y ou

dis able the time out s etting.

The fol l ow i ng scenari o runs through the Proj ect Merge Wi zard several
ti mes, each ti me fi ne-tuni ng the rul es, and the fi nal ti me actual l y
performi ng the merge.

To Safely Perform a Project Merge

Both the s ourc e and the des tination projec t mus t be loaded for the
projec t merge to c omplete. For more information on loading projec ts ,
s ee Setti ng the Status of a Proj ect, page 51 .

1. Go to Start > A ll Programs > MicroStrategy Tools > Project

Merge Wizard.

2. Fol l ow the steps i n the w i zard to set your opti ons and confl i ct
resol uti on rul es.

For details about all s ettings av ailable when running the wiz ard,
s ee the Help (pres s F1 from within the Projec t Merge Wiz ard). For
information about the rules for res olv ing c onflic ts , s ee R esol vi ng
C onfl i cts w hen Mergi ng Proj ects, page 475 .

3. N ear the end of the w i zard, w hen you are prompted to perform
the merge or generate a l og fi l e onl y, sel ect Generate log file
only. Al so, choose to Save Project Merge XML. At the end of
the w i zard, cl i ck Finish. Because you sel ected to generate a l og
fi l e onl y, thi s serves as a tri al merge.

4. After the tri al merge i s fi ni shed, you can read through the l og
fi l es to see w hat w oul d have been copi ed (or not copi ed) i f the
merge had actual l y been performed.

5. Based on w hat you l earn from the l og fi l es, you may w ant to
change some of the confl i ct resol uti on rul es you set w hen goi ng

470 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

through the w i zard. To do thi s, run the w i zard agai n and, at the
begi nni ng of the w i zard, choose to Load Project Merge XML that
you created i n the previ ous run. As you proceed through the
w i zard, you can fi ne-tune the setti ngs you speci fi ed earl i er. At
the end of the w i zard, choose to Generate the log file only
(thereby performi ng another tri al ) and choose Save Project
Merge XML. R epeat thi s step as many ti mes as necessary unti l
the l og fi l e i ndi cates that obj ects are copi ed or ski pped as you
desi re.

6. When you are sati sfi ed that no more rul e changes are needed,
run the w i zard a fi nal ti me. At the begi nni ng of the w i zard, l oad
the Proj ect Merge XML as you di d before. At the end of the
w i zard, w hen prompted to perform the merge or generate a l og
fi l e onl y, sel ect Perform merge and generate log file.

Ru n n in g Pr o ject Mer ge f r o m t h e Co mman d Lin e

A Proj ect Merge can be l aunched from the Wi ndow s command l i ne.
You can al so run several sessi ons of the Proj ect Merge Wi zard w i th
the same source proj ect, usi ng the command prompt. For i nformati on
on runni ng mul ti pl e sessi ons, see Mul ti pl e Proj ect Merges from the
Same Proj ect, page 473.

The setti ngs for thi s routi ne must be saved i n an XML fi l e w hi ch can
easi l y be created usi ng the Proj ect Merge Wi zard. Once created, the
XML fi l e serves as the i nput parameter to the command.

The syntax for the p r o j e c t m e r g e . e x e command i s show n bel ow .

The syntax for the command i s si mpl i fi ed.

projectmerge -f[ ] -sp[ ] -dp[ ] -smp[ ] -dmp[ ] -sup[ ]

-MD -SU -lto -h

Al l command l i ne parameters are descri bed i n the tabl e bel ow .

© 2019, M icr o St r at egy In c. 471

Syst em Ad m in ist r at io n Gu id e

Pa r a me te r De s c r iption a nd us e

S pecif ies t he pat h and f ile name (wit hout spaces) of t he X ML f ile t o
-f[ ] use. (Y ou must have already creat ed t he f ile using t he P roject
Merge Wizard. ) E xample: -fc:\files\merge.xml

P assword f or S OURCE P roject S ource. (The login I D t o be used is

-sp[ ]
st ored in t he X ML f ile. ) E xample: -sphello

P assword f or DE S TI NA TI ON P roject S ource. (The login I D t o be

-dp[ ]
used is st ored in t he X ML f ile. ) E xample: -dphello

P assword f or S OURCE met adat a. (The login I D t o be used is st ored

-smp[ ]
in t he X ML f ile. ) E xample: -smphello

P assword f or DE S TI NA TI ON met adat a. (The login I D t o be used is

-dmp[ ]
st ored in t he X ML f ile. ) E xample: -dmphello

S uppress progress window. This is usef ul f or running a project merge

-sup in t he background, and t he window displaying st at us of t he merge
does not appear.

Forces met adat a updat e of DE S TI NA TI ON met adat a if it is older

t han t he S OURCE met adat a. P roject Merge will not execut e unless
-MD
DE S TI NA TI ON met adat a is t he same version as or more recent t han
S OURCE met adat a.

Updat es t he schema of t he DE S TI NA TI ON project af t er t he P roject

Merge is complet ed. This updat e is required when you make any
changes t o schema object s (f act s, at t ribut es, or hierarchies).
-SU

Do not use t his swit ch if t he P roject Merge conf igurat ion X ML

cont ains an inst ruct ion t o updat e t he schema.

Take ownership of any met adat a locks t hat exist on t he source or

-lto dest inat ion project s. For more inf ormat ion about met adat a locking,
see Loc k ing Projec ts , page 416 .

-h Displays help and explanat ions f or all of t he above paramet ers.

A sampl e command usi ng thi s syntax i s provi ded bel ow . The

command assumes that "h e l l o" i s the passw ord for al l the proj ect

472 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

source and database connecti ons. The l ogi n ID s used w i th these

passw ords are stored i n the XML fi l e created by the Proj ect Merge
Wi zard.

projectmerge -fc:\temp\merge.xml -sphello -dphello -

smphello -dmphello -lto -MD -SU

If the XML file c ontains a s pac e in the name or the path, y ou mus t
enc los e the name in double quotes , s uc h as :

proj ec tm er g e - f " c : p r o g r a m f i l e s ( x 8 6 ) \ x m l \
merg e. xm l" -s p h e l l o -d p h e l l o -s m p h e l l o - d m p h e l l o -
MD - S U

Multiple Project Merges from the Same Project

The Proj ect Merge Wi zard can perform mul ti pl e si mul taneous merges
from the same proj ect source. Thi s can be useful w hen you w ant to
propagate a change to several proj ects si mul taneousl y.

During a multiple merge, the Projec t Merge Wiz ard is prev ented from
loc k ing the projec ts . This is s o that multiple s es s ions of the wiz ard c an
ac c es s the s ourc e projec ts . You will need to manually loc k the s ourc e
projec t before beginning the merge. You will als o need to manually loc k
the des tination projec ts at the c onfiguration lev el before beginning the
merge. Failing to do this may res ult in errors in projec t c reation due to
objec ts being c hanged in the middle of a merge. For information on
loc k ing and unloc k ing projec ts , s ee Locki ng Proj ects, page 416 .

To do thi s, you must modi fy the Proj ect Merge XML fi l e, and then
make a copy of i t for each sessi on that you w ant to run.

© 2019, M icr o St r at egy In c. 473

Syst em Ad m in ist r at io n Gu id e

To Execute Multiple Simultaneous Merges from One Project

1. In a text edi tor, open the Proj ect Merge Wi zard XML fi l e.

2. In the OM O n O f f S e tt i n g s secti on of the fi l e, add the fol l ow i ng

node:
<O pt io n > < I D > O M O n O f f S e t t i n g s < / I D > < S k i p P r o j e c t M er
ge So ur c e L o c k i n g S k i p P r o j e c t M e r g e D e s t C o n f i g L o c k in
g/ >< /O p t i o n >.

3. Make one copy of the XML fi l e for each sessi on of the Proj ect
Merge Wi zard you w ant to run.

4. In each XML fi l e, make the fol l ow i ng changes:

l C orrect the name of the desti nati on proj ect.

l Ensure that each fi l e uses a di fferent Proj ect Merge l og fi l e

name.

5. Manual l y l ock the source proj ect.

6. Manual l y l ock the desti nati on proj ects at the confi gurati on l evel .

7. For each XML fi l e, run one i nstance of the Proj ect Merge Wi zard
from the command l i ne.

Sch ed u lin g a Pr o ject Mer ge

To schedul e a del ayed or recurri ng Proj ect Merge, use the A T
command, w hi ch i s part of the Mi crosoft Wi ndow s operati ng system.
For i nstructi ons on how to use the AT command, refer to the Mi crosoft
Wi ndow s hel p. The sampl e AT command bel ow schedul es Proj ect
Merge to run at 6:00 PM (1 8 : 0 0) every Fri day (/ e v e r y : F).

at 18:00 /every:F projectmerge -fc:\temp\merge.xml -

sphello -dphello -smphello -dmphello -MD -SU

474 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

For a l i st of the syntax opti ons for thi s command, see R unni ng Proj ect
Merge from the C ommand Li ne, page 471.

To Schedule a Project Merge Using the Windows Command

Prompt

1. From the Mi crosoft Wi ndow s machi ne w here Proj ect Merge i s

i nstal l ed, from the Start menu, sel ect Programs, then choose
C ommand Prompt.

2. C hange the dri ve to the one on w hi ch the Proj ect Merge uti l i ty i s
i nstal l ed. The defaul t i nstal l ati on l ocati on i s the C : dri ve (the
prompt appears as: C : \ >)

3. Type an A T command that cal l s the p r o je c t m e r g e command.

For a l i st of the syntax opti ons for thi s command, see R unni ng
Proj ect Merge from the C ommand Li ne, page 471.

Resolving Conflicts when Merging Projects

C onfl i cts occur w hen a desti nati on obj ect's versi on di ffers from the
source obj ect's versi on. Thi s di fference usual l y means that the obj ect
has been modi fi ed i n one or both of the proj ects. These confl i cts are
resol ved by fol l ow i ng a set of rul es you defi ne as you step through the
Proj ect Merge Wi zard.

When you defi ne the rul es for Proj ect Merge to use, you fi rst set the
defaul t confl i ct resol uti on acti on for each category of obj ects (schema,
appl i cati on, and confi gurati on). (For a l i st of obj ects i ncl uded i n each
category, see C opyi ng Obj ects.) Then you can speci fy confl i ct
resol uti on rul es at the obj ect type l evel (attri butes, facts, reports,
consol i dati ons, events, schedul es, and so on). Obj ect type rul es
overri de obj ect category rul es. N ext you can speci fy rul es for speci fi c
fol ders and thei r contents, w hi ch overri de the obj ect type and obj ect
category rul es. Fi nal l y you can speci fy rul es for speci fi c obj ects,

© 2019, M icr o St r at egy In c. 475

Syst em Ad m in ist r at io n Gu id e

w hi ch, i n turn, overri de obj ect type rul es, obj ect category rul es, and
fol der rul es.

For exampl e, the U se N ewer acti on repl aces the desti nati on obj ect
w i th the source obj ect i f the source obj ect has been modi fi ed more
recentl y than the desti nati on obj ect. If you speci fi ed the U se newer
acti on for al l metri cs, but the Sal es metri c has been changed recentl y
and i s not yet ready for the producti on system, you can speci fy U se
existing (use the obj ect i n the desti nati on proj ect) for that metri c onl y
and i t w i l l not be repl aced.

Pr o ject Mer ge Co n f lict Reso lu t io n Ru les

If the source obj ect has a di fferent versi on than the desti nati on obj ect,
that i s, the obj ects exi st di fferentl y, you must determi ne w hat acti on
shoul d occur. The vari ous acti ons that can be taken to resol ve
confl i cts are expl ai ned i n the tabl e bel ow .

Ac tion Effe c t

Use No change is made t o t he dest inat ion object . The source object is not
exist ing copied.

The dest inat ion object is replaced wit h t he source object .

Non-empt y f olders in t he dest inat ion locat ion will never have t he
Replace
same version I D and modif icat ion t ime as t he source, because t he
f older is copied f irst and t he object s are added t o it , t hus changing
t he version I D and modif icat ion t imes during t he copy process.

K eep No change is made t o t he dest inat ion object . The source object is
bot h duplicat ed in t he dest inat ion locat ion.

I f t he source object 's modif icat ion t ime is more recent t han t he dest inat ion
Use
object 's, t he R eplace act ion is used. Ot herwise, t he U se existing act ion
newer
is used.

Use I f t he source object 's modif icat ion t ime is more recent t han t he dest inat ion

476 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Ac tion Effe c t

object 's, t he U se existing act ion is used. Ot herwise, t he R eplace act ion
older
is used.

Comparing and Tracking Projects

Often duri ng the proj ect l i fe cycl e, you do not know exactl y w hi ch
obj ects need to be moved from one proj ect to another. Thi s i s
because there are many devel opers w orki ng on a proj ect and i t i s
di ffi cul t for a si ngl e person to know al l of the w ork that has been
done. The mi grati on process becomes much easi er i f you fi rst
compare obj ects i n the source and desti nati on proj ects.

You can use the Mi croStrategy Proj ect C ompari son Wi zard to
compare obj ects i n rel ated proj ects. Thi s w i zard tel l s you w hi ch
obj ects are di fferent betw een the tw o proj ects, and w hi ch obj ects
exi st i n one proj ect but not i n the other. From thi s l i st you can deci de
w hat obj ects to move betw een proj ects, usi ng Obj ect Manager. For
i nstructi ons on movi ng obj ects w i th Obj ect Manager, see C opyi ng
Obj ects Betw een Proj ects: Obj ect Manager, page 417.

You can track changes to your proj ects w i th the Mi croStrategy Search
feature, or retri eve a l i st of al l unused obj ects i n a proj ect w i th the
Fi nd U nreferenced Obj ects feature of Obj ect Manager.

Thi s secti on covers the fol l ow i ng topi cs:

Comparing Objects Between Two Projects

The Proj ect C ompari son Wi zard compares obj ects i n a source proj ect
and a desti nati on proj ect.

For the source proj ect, you speci fy w hether to compare obj ects from
the enti re proj ect, or j ust from a si ngl e fol der and al l i ts subfol ders.

© 2019, M icr o St r at egy In c. 477

Syst em Ad m in ist r at io n Gu id e

You al so speci fy w hat types of obj ects (such as reports, attri butes, or
metri cs) to i ncl ude i n the compari son.

Every obj ect i n a Mi croStrategy proj ect has a uni que ID . Proj ect
C ompari son l ooks at each obj ect ID i n the source proj ect, and
compares i t to the obj ect i n the desti nati on proj ect w i th the same ID .
For each obj ect ID , Proj ect C ompari son i ndi cates w hether the obj ect
i s:

l Identi cal i n both proj ects

l Identi cal i n both proj ects except for the fol der path

l Onl y present i n the source proj ect

l D i fferent betw een proj ects, and new er i n the source or desti nati on
proj ect

You can pri nt thi s resul t l i st, or save i t as a text fi l e or an Excel fi l e.

Si nce the Proj ect C ompari son Wi zard i s a part of Obj ect Manager, you
can al so sel ect obj ects from the resul t set to i mmedi atel y mi grate from
the source proj ect to the desti nati on proj ect. For more i nformati on
about mi grati ng obj ects usi ng Obj ect Manager, see C opyi ng Obj ects
Betw een Proj ects: Obj ect Manager, page 417.

Usin g t h e Pr o ject Co mp ar iso n Wizar d

The fol l ow i ng hi gh-l evel procedure provi des an overvi ew of w hat the
Proj ect C ompari son Wi zard does.

To Compare Two Projects

l To c ompare two projec ts with the Projec t Comparis on Wiz ard, thos e
projec ts mus t hav e related s c hemas . This means that either one
projec t mus t be a duplic ate of the other, or both projec ts mus t be

478 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

duplic ates of a third projec t. For information about duplic ating

projec ts , inc luding ins truc tions , s ee D upl i cati ng a Proj ect, page
405 .

l The Projec t Comparis on Wiz ard is a part of Objec t Manager, and thus
requires the Us e Objec t Manager priv ilege to run. For an ov erv iew of
Objec t Manager, s ee C opyi ng Obj ects Betw een Proj ects: Obj ect
Manager, page 417 .

1. In Wi ndow s, go to Start > A ll Programs > MicroStrategy

Products > Object Manager.

2. Open a proj ect source i n Obj ect Manager.

3. From the Project menu, sel ect C ompare Projects.

4. Sel ect the source and desti nati on proj ects.

5. Speci fy w hether to compare al l obj ects or j ust obj ects i n a

speci fi c fol der, and w hat types of obj ects to compare.

6. R evi ew your choi ces at the summary screen and cl i ck Finish.

7. Sel ect Save as Text File or Save as Excel File.

8. To mi grate obj ects from the source proj ect to the desti nati on
proj ect usi ng Obj ect Manager, sel ect those obj ects i n the l i st and
cl i ck Proceed. For more i nformati on about Obj ect Manager, see
C opyi ng Obj ects Betw een Proj ects: Obj ect Manager, page 417.

Tracking Your Projects with the Search Export Feature

Exporti ng the resul ts of a search obj ect can be a useful w ay to keep
track of changes to a proj ect. The Search Export feature enabl es you
to perform a search for ei ther a speci fi c obj ect i n a proj ect or for a
group of obj ects that meet certai n cri teri a. After the search i s
performed, you can save your search defi ni ti on and search resul ts to
a text fi l e, and save the search obj ect i tsel f for l ater reuse.

© 2019, M icr o St r at egy In c. 479

Syst em Ad m in ist r at io n Gu id e

For exampl e, you can create a search obj ect i n the devel opment
proj ect that returns al l obj ects that have been changed after a certai n
date. Thi s l ets you know w hat obj ects have been updated and need to
be mi grated to the test proj ect. For more i nformati on about
devel opment and test proj ects, see The Proj ect Li fe C ycl e, page 397.

The search export fi l e contai ns the fol l ow i ng i nformati on:

l The user w ho w as l ogged i n w hen the search w as performed.

l The search type, date and ti me, and proj ect name.

l Any search cri teri a entered i nto the tabs of the Search for Obj ects
di al og box.

l Any mi scel l aneous setti ngs i n D evel oper that affected the search
(such as w hether hi dden and managed obj ects w ere i ncl uded i n the
search).

l A l i st of al l the obj ects returned by the search, i ncl udi ng any

fol ders. The l i st i ncl udes obj ect names and paths (obj ect l ocati ons
i n the D evel oper i nterface).

To Search for Objects and Save the Results in a Text File

1. In D evel oper, from the Tools menu, sel ect Search for Objects.

2. Perform your search.

3. After your search i s compl ete, from the Tools menu i n the Search
for Obj ects di al og box, sel ect Export to Text. The text fi l e i s
saved by defaul t to C : \ P r o g r a m F i l e s
(x 86 )\ M i c r o S t r a t e g y \ D e s k t o p \ Se a r c h R e s u l t s _
<d at e a n d t i m e s t a m p >. t x t, w here < d a t e a n d
ti me st a m p > i s the day and ti me w hen the search w as saved.
For exampl e, the text fi l e named S e a r c h R e s u l t _
02 26 07 1 5 2 5 5 4 . t x t w as saved on February 26, 2007, at
15:25:54, or 3:25 PM.

480 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Listing Unused Objects in a Project

In Obj ect Manager, you can retri eve a l i st of al l the obj ects i n a
proj ect that are not used by any other obj ects. For exampl e, you can
fi nd w hi ch attri butes or metri cs are no l onger used i n any reports, so
that you can del ete those obj ects.

To Find Unused Objects

Finding unus ed objec ts is a part of Objec t Manager, and thus requires

the Us e Objec t Manager priv ilege to run. For an ov erv iew of Objec t
Manager, s ee C opyi ng Obj ects Betw een Proj ects: Obj ect Manager,
page 417 .

1. From the Wi ndow s Start menu, poi nt to A ll Programs, then

MicroStrategy Products, and then sel ect Object Manager.

2. Open a proj ect source i n Obj ect Manager.

3. From the Tools menu, sel ect Find U nreferenced Objects.

4. In the Look In fi el d, enter the fol der you w ant to start your search
i n.

5. Make sure the Include Subfolders check box i s sel ected.

6. C l i ck Find N ow.

Deleting Unused Schema Objects: Managed

Objects
Mi croStrategy proj ects contai n schemas and rel ated schema obj ects,
i ncl udi ng attri butes, tabl es, hi erarchi es, and so on. For an
i ntroducti on to schema obj ects, see the Proj ect D esi gn Gui de.

© 2019, M icr o St r at egy In c. 481

Syst em Ad m in ist r at io n Gu id e

C ertai n Mi croStrategy features automati cal l y create new schema

obj ects, referred to as managed obj ects, w hi ch are not di rectl y rel ated
to the proj ect schema. The features that create thei r ow n managed
obj ects are:

l Freeform SQL and Query Bui l der. For i nformati on on Freeform SQL
and Query Bui l der, see the Advanced R eporti ng Gui de.

l MD X cube sources such as SAP BW, H yperi on Essbase, Mi crosoft

Anal ysi s Servi ces, and IBM C ognos TM1. For i nformati on on MD X
cube sources, see the MD X C ube R eporti ng Gui de.

l Import D ata, w hi ch l ets you use Mi croStrategy Web to i mport data

from di fferent data sources, such as an Excel fi l e, a tabl e i n a
database, or the resul ts of a SQL query, w i th mi ni mum proj ect
desi gn requi rements.

Managed obj ects are stored i n a speci al system fol der, and can be
di ffi cul t to del ete i ndi vi dual l y due to how these obj ects are created
and stored. If you use one of the features l i sted above, and then
deci de to remove some or al l of that feature's rel ated reports and MD X
cubes from the proj ect, there may be unused managed obj ects
i ncl uded i n your proj ect that can be del eted.

Thi s secti on covers the fol l ow i ng topi cs:

l D el eti ng Managed Obj ects One-By-One, page 482

l D el eti ng Al l U nused Managed Obj ects, page 483

Deleting Managed Objects One-By-One

When you del ete managed obj ects one-by-one, you i ndi vi dual l y sel ect
w hi ch managed obj ects you w ant to del ete and w hi ch you w ant to
keep. You can perform thi s cl ean-up for any of the Freeform SQL,
Query Bui l der, or MD X cube source database i nstances i ncl uded for
your proj ect.

482 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

For exampl e, you deci de to del ete a si ngl e Freeform SQL report that
automati cal l y created a new managed obj ect named Store. When you
del ete the report, the managed obj ect Store i s not automati cal l y
del eted. You do not pl an to use the obj ect agai n; how ever, you do
pl an to create more Freeform SQL reports and w ant to keep the
database i nstance i ncl uded i n the proj ect. Instead of del eti ng the
enti re Freeform SQL schema, you can del ete onl y the managed obj ect
Store.

To Delete Managed Objects One-By-One

1. In D evel oper, del ete any Freeform SQL, Query Bui l der, or MD X
cube reports i n the proj ect that depend on the managed obj ects
you w ant to del ete.

If you are removi ng MD X cube managed obj ects, you must al so

remove any MD X cubes that these managed obj ects depend on.

2. R i ght-cl i ck the proj ect and sel ect Search for Objects.

3. From the Tools menu, go to Options.

4. Sel ect the D isplay managed objects and D isplay managed

objects only check boxes.

5. C l i ck OK .

6. Enter your search cri teri a and sel ect Find N ow.

7. Manual l y del ete managed obj ects by ri ght-cl i cki ng thei r name i n
the search resul t and sel ecti ng D elete.

Deleting All Unused Managed Objects

Managed obj ects can become unused i n a proj ect w hen you stop
usi ng the feature that created the managed obj ects. You can del ete
al l unused managed obj ects to cl ean up your proj ect.

© 2019, M icr o St r at egy In c. 483

Syst em Ad m in ist r at io n Gu id e

For exampl e, you can create a separate database i nstance for your
Freeform SQL reports i n your proj ect. Later on, you may deci de to no
l onger use Freeform SQL, or any of the reports created w i th the
Freeform SQL feature. After you del ete al l the Freeform SQL reports,
you can remove the Freeform SQL database i nstance from the proj ect.
Once you remove the database i nstance from the proj ect, any
Freeform SQL managed obj ects that depended sol el y on that
database i nstance can be del eted.

You can i mpl ement the same process w hen removi ng database
i nstances for Query Bui l der, SAP BW, Essbase, and Anal ysi s
Servi ces.

To Delete All Unused Managed Objects from a Project

1. R emove al l reports created w i th Freeform SQL, Query Bui l der, or

MD X cubes.

If y ou are remov ing MDX c ube managed objec ts , y ou mus t als o

remov e all imported MDX c ubes .

2. In D evel oper, ri ght-cl i ck the proj ect and sel ect Project
C onfiguration.

3. Expand the D atabase instances category.

4. Sel ect ei ther SQL data warehouses or MD X data warehouses,

dependi ng on the database i nstance you w ant to remove.

Freeform SQL and Query Builder us e relational databas e

ins tanc es , while SAP BW, Es s bas e, and Analy s is Serv ic es us e
MDX c ube databas e ins tanc es . For more information on the
differenc e between the two, s ee the Instal l ati on and
C onfi gurati on Gui de .

484 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

5. C l ear the check box for the database i nstance you w ant to
remove from the proj ect. You can onl y remove a database
i nstance from a proj ect i f the database i nstance has no
dependent obj ects i n the proj ect.

6. C l i ck OK to accept the changes and cl ose the Proj ect

C onfi gurati on Edi tor.

This proc edure remov es s ome preliminary objec t dependenc ies .

Attribute and metric managed objec ts are not automatic ally deleted
by this proc edure, bec aus e y ou c an reus e the managed attributes
and metric s at a later time. If y ou do not plan to us e the attribute
and metric managed objec ts and want to delete them permanently
from y our projec t, c ontinue through the res t of this proc edure.

To Del et e U nused At t r i b ut e and M et r i c M anaged Ob j ect s

In D evel oper, from the A dministration menu, sel ect Projects >
D elete unused managed objects.

© 2019, M icr o St r at egy In c. 485

 7
M ONITORING SYSTEM
U SAGE

© 2019, M icr o St r at egy In c. 486

Syst em Ad m in ist r at io n Gu id e

Mi croStrategy provi des several w ays to track user acti vi ty, resource
usage, and performance i n your system. These i ncl ude the fol l ow i ng:

l Mi croStrategy System Moni tors, page 487

l Moni tori ng System Acti vi ty: C hange Journal i ng, page 489

l Moni tori ng System U sage: Intel l i gence Server Stati sti cs, page 499

l Addi ti onal Moni tori ng Tool s, page 516

MicroStrategy System Monitors

You can moni tor vari ous aspects of your Mi croStrategy system from
w i thi n D evel oper. The A dministration category for a proj ect source
contai ns several system moni tors for that proj ect source. These
moni tors are l i sted i n the tabl e bel ow , and are descri bed i n detai l i n
the rel evant secti on of thi s gui de.

F o r in fo rmatio n ab o u t mo n ito rin g ... See...

P roject s loaded on I nt elligence S erver, or Managing and Monitoring Projects,

on all nodes of t he clust er page 47

P roject s loaded on specif ic nodes of t he Managing your Projects Across N odes

clust er of a C lus ter, page 824

Monitoring C urrently Executing Jobs ,

Jobs t hat are current ly execut ing
page 81

Users t hat are current ly connect ed t o Monitoring U sers' C onnections to

I nt elligence S erver Projec ts , page 93

Monitoring D atabase Instance

A ct ive and cached dat abase connect ions
C onnec tions, page 25

Report and document caches Monitoring R esult C aches, page 873

Hist ory List messages Managing H istory Lists , page 912

487 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

F o r in fo rmatio n ab o u t mo n ito rin g ... See...

I nt elligent Cubes, whet her t hey are loaded Managing Intelligent C ubes : Intelligent
on I nt elligence S erver C ube Monitor, page 944

Quick search indices and t heir st at us Monitoring Quic k Search Indic es

Before y ou c an v iew a s y s tem monitor, y ou mus t hav e the appropriate

priv ilege to ac c es s that monitor. For ex ample, to v iew the J ob Monitor, y ou
mus t hav e the Monitor J obs priv ilege. For more information about
priv ileges , s ee C ontrol l i ng Access to Functi onal i ty: Pri vi l eges, page
109 .

In addition, y ou mus t hav e Monitoring permis s ion for the s erv er definition
that c ontains that monitor. You c an v iew and modify the ACL for the s erv er
definition by right-c lic k ing the A dministration ic on, s elec ting
Properties , and then s elec ting the Security tab. For more information
about permis s ions and ACLs , s ee C ontrol l i ng Access to Obj ects:
Permi ssi ons, page 95 .

To View a System Monitor

1. In D evel oper, l og i n to the proj ect source that you w ant to

moni tor. You must l og i n as a user w i th the appropri ate
admi ni strati ve pri vi l ege.

2. Expand the A dministration category.

3. To moni tor proj ects or cl usters, expand the System

A dministration category and sel ect ei ther Project or C luster
N odes.

4. To vi ew addi ti onal system moni tors, expand the System

Monitors category and sel ect the desi red moni tor. For a l i st of
the di fferent moni tors avai l abl e, and w here you can fi nd more
i nformati on about each moni tor, see the tabl e above.

© 2019, M icr o St r at egy In c. 488

Syst em Ad m in ist r at io n Gu id e

Monitoring System Activity: Change Journaling

C hange j ournal i ng i s the process of l oggi ng i nformati on about
changes to obj ects i n a proj ect. C hange j ournal i ng tracks the changes
to each obj ect i n the system. Thi s makes i t easi er for admi ni strators to
qui ckl y determi ne w hen and by w hom certai n changes w ere made.
For exampl e, reports usi ng a certai n metri c executed correctl y i n a
test tw o w eeks ago, but no l onger execute correctl y i n thi s morni ng's
test. The admi ni strator can search the change j ournal to determi ne
w ho has made changes to that metri c w i thi n the l ast tw o w eeks.

The l ogged i nformati on i ncl udes i tems such as the user w ho made the
change, the date and ti me of the change, and the type of change
(such as savi ng, copyi ng, or del eti ng an obj ect). Wi th change
j ournal i ng, you can keep track of al l obj ect changes, from si mpl e user
acti ons such as savi ng or movi ng obj ects to proj ect-w i de changes
such as proj ect dupl i cati on or proj ect mergi ng.

C ertai n busi ness regul ati ons, such as Sarbanes-Oxl ey i n the U ni ted
States, requi re detai l ed records of changes made to a BI system.
C hange j ournal i ng ai ds i n compl i ance w i th these regul ati ons.

Begi nni ng w i th Mi croStrategy 10.8, change j ournal i ng i s enabl ed by

defaul t on al l proj ects i n your producti on envi ronment.

Viewing the Change Journal Entries

When an obj ect i s changed, i nformati on about the change i s entered
i n the change j ournal . To vi ew the change j ournal for al l proj ects i n a
proj ect source, i n D evel oper, expand A dministration, then expand
System Monitors, and then sel ect C hange Journal Transactions.
The change j ournal entri es are l i sted i n the mai n w i ndow of
D evel oper.

You mus t hav e the Audit Change J ournal priv ilege to v iew the c hange
journal.

489 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To vi ew the detai l ed i nformati on for a change j ournal entry, doubl e-

cl i ck that entry. Each entry contai ns the fol l ow i ng i nformati on:

Entr y De ta ils

Object
The name of t he object t hat is changed.
name

The t ype of object changed. For example, Met ric, User, or S erver
Object t ype
Def init ion.

User name The name of t he MicroS t rat egy user t hat made t he change.

Transact ion The dat e and t ime of t he change, based on t he t ime on t he

t imest amp I nt elligence S erver machine.

Transact ion The t ype of change and t he t arget of t he change. For example, Delet e
t ype Object s, S ave Object s, or E nable Logging.

Transact ion The applicat ion t hat made t he change. For example, Developer,
source Command Manager, MicroS t rat egy Web, or S cheduler.

The name of t he project t hat cont ains t he object t hat was changed.
P roject
name I f t he object is a conf igurat ion object , t he project name is list ed
as < Conf igurat ion>

A ny comment s ent ered in t he Comment s dialog box at t he t ime of t he

Comment s
change.

Object I D The object 's GUI D, a unique MicroS t rat egy syst em ident if ier.

Machine
The name of t he machine t hat t he object was changed on.
name

Change The t ype of change t hat was made. For example, Creat e, Change, or
t ype Delet e.

Transact ion
A unique 32-digit hexadecimal number t hat ident if ies t his change.
ID

A unique 32-digit hexadecimal number t hat ident if ies t he user session

S ession I D
in which t he change was made.

Link I D For MicroS t rat egy use.

© 2019, M icr o St r at egy In c. 490

Syst em Ad m in ist r at io n Gu id e

Thi s i nformati on can al so be vi ew ed i n the col umns of the change

j ournal . To change the vi si bl e col umns, ri ght-cl i ck anyw here i n the
change j ournal and sel ect View Options. In the Vi ew Opti ons di al og
box, sel ect the col umns you w ant to see.

Increasing the Number of Change Journal Entries to View

or Export
By defaul t the change j ournal di spl ays and exports the l ast 1,000
entri es. You can i ncrease thi s number i n the B rowsing category of
the D evel oper Preferences di al og box. Vi ew i ng more entri es may
make the brow si ng and exporti ng process take l onger.

To Increase the Number of Displayed or Exported Change

Journal Entries

1. In D evel oper, from the Tools menu sel ect MicroStrategy

D eveloper Preferences.

2. In the General category, sel ect B rowsing.

3. In the Maximum number of monitoring objects displayed per

page fi el d, speci fy the maxi mum number of change j ournal
entri es to di spl ay.

4. In the Maximum number of transactions retrieved per

metadata change journaling search fi el d, speci fy the maxi mum
number of change j ournal entri es to export.

5. C l i ck OK .

Searching the Change Journal for Relevant Entries

Because the change j ournal records every transacti on, fi ndi ng the
rel evant records can be daunti ng. To make searchi ng the change
j ournal easi er, you can fi l ter i t so that you see the rel evant entri es.

For exampl e:

491 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l To fi nd out w hen certai n users w ere gi ven certai n permi ssi ons, you
can vi ew entri es rel ated to U sers.

l To di scover w hi ch user made a change that caused a report to stop

executi ng correctl y, you can vi ew the entri es rel ated to that report.

You can al so qui ckl y fi l ter the entri es so that you see the entri es for
an obj ect or the changes made by a speci fi c user. To do thi s, ri ght-
cl i ck one of the entri es for that obj ect or that user and sel ect ei ther
Filter view by object or Filter view by user. To remove the fi l ter,
ri ght-cl i ck i n the change j ournal and sel ect C lear filter view.

To Filter the Change Journal for Relevant Entries

1. In the C hange Journal Transacti ons Moni tor, ri ght-cl i ck and

sel ect Filter.

2. To fi l ter the change j ournal by changed obj ect type, proj ect,
transacti on type, or source of the change, sel ect from the
appropri ate drop-dow n l i st.

3. To fi l ter the change j ournal by mul ti pl e condi ti ons, cl i ck

A dvanced. The advanced fi l teri ng opti ons panel opens at the
bottom of the di al og box. Enter the col umns and condi ti ons.

4. To see changes made i n a speci fi c ti me range, enter the start

and end ti me and date.

5. To vi ew al l transacti ons, not j ust those that change the versi on of

an obj ect, cl ear the Show version changes only and H ide
Empty Transactions check boxes.

If the Show version changes only c hec k box is c leared, two

trans ac tions named "Link Item" are lis ted for ev ery time an
applic ation objec t is s av ed. Thes e trans ac tions are monitored for
Mic roStrategy tec hnic al s upport us e and do not indic ate that the

© 2019, M icr o St r at egy In c. 492

Syst em Ad m in ist r at io n Gu id e

applic ation objec t has been c hanged. Any time the objec t has
ac tually been c hanged, a Sav eObjec ts trans ac tion with the name
of the applic ation objec t is lis ted.

6. C l i ck OK to cl ose the di al og box and fi l ter the change j ournal .

To Quickly Filter the Change Journal by Object or User

1. In the C hange Journal Transacti ons Moni tor, ri ght-cl i ck an entry

for the obj ect or user you w ant to fi l ter by, and sel ect the type of
fi l teri ng:

l To see the changes to thi s obj ect, sel ect Filter view by object.

l To see the changes made by thi s user, sel ect Filter view by
user.

2. To remove a qui ck fi l ter, ri ght-cl i ck i n the change j ournal and

sel ect C lear filter view.

Exporting the Change Journal

You can export the contents of the change j ournal to a text fi l e. Thi s
can be useful so that you can save thi s fi l e to an archi val l ocati on, or
emai l i t to Mi croStrategy techni cal support for assi stance w i th a
probl em.

The name of thi s fi l e i s A u d i t L o g _M M D D Y Y hh m m s s. t x t, w here

MMDD YY i s the month, date, and l ast tw o di gi ts of the year, and
hhmm ss i s the ti mestamp, i n 24-hour format. Thi s fi l e i s saved i n the
Mi croStrategy C ommon Fi l es di rectory. By defaul t thi s di rectory i s
C:\P ro gr am F i l e s ( x 8 6 ) \ C o m m o n F i l e s \ M i c r o S t r a t e g y \.

When y ou ex port the c hange journal, any filters that y ou hav e us ed to

v iew the res ults of the c hange journal are als o applied to the ex port. If
y ou want to ex port the entire c hange journal, mak e s ure that no filters

493 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

are c urrently in us e. To do this , right-c lic k in the c hange journal and

s elec t C lear filter view .

To Export the Change Journal to a File

1. In D evel oper, go to A dministration > System Monitors.

2. R i ght-cl i ck C hange A udit and sel ect Export list. The change
j ournal i s exported to a text fi l e.

A prompt i s di spl ayed i nformi ng you that the l i st w as exported and

noti ng the fol der and fi l e name, and asks i f you w ant to vi ew the fi l e.
To vi ew the fi l e, cl i ck Yes.

Purging the Change Journal

You can keep the si ze of the change j ournal to a manageabl e si ze by
peri odi cal l y purgi ng ol der entri es that you no l onger need to keep.

When you purge the change j ournal , you speci fy a date and ti me. Al l
entri es i n the change j ournal that w ere recorded pri or to that date and
ti me are del eted. You can purge the change j ournal for an i ndi vi dual
proj ect, or for al l proj ects i n a proj ect source.

Mic roStrategy rec ommends arc hiv ing y our c hange journal entries
before purging. For ins truc tions on how to arc hiv e the c hange journal,
s ee Exporti ng the C hange Journal , page 493 .

To Purge the Change Journal for All Projects in a Project Source

1. In D evel oper, expand A dministration, and then expand System

Monitors.

2. R i ght-cl i ck C hange Journal Transactions and sel ect Manage

change journal.

© 2019, M icr o St r at egy In c. 494

Syst em Ad m in ist r at io n Gu id e

3. Set the date and ti me. Al l data recorded before thi s date and ti me
i s del eted from the change j ournal .

4. To purge data for al l proj ects, sel ect the A pply to all projects
check box. To purge data rel ati ng to the proj ect source
confi gurati on, l eave thi s check box cl eared.

5. C l i ck Purge N ow. When the w arni ng di al og box opens, cl i ck Yes

to purge the data, or N o to cancel the purge. If you cl i ck Yes,
change j ournal i nformati on recorded before the speci fi ed date i s
del eted.

If y ou are logging trans ac tions for this projec t s ourc e, a Purge Log
trans ac tion is logged when y ou purge the c hange journal.

6. C l i ck C ancel.

To Purge the Change Journal for a Single Project

1. In D evel oper, ri ght-cl i ck on the proj ect and sel ect Project
C onfiguration.

2. Expand Project definition, and then sel ect C hange Journaling.

3. U nder Purge C hange Journal, set the date and ti me. Al l change
j ournal data for thi s proj ect from before thi s date and ti me w i l l be
del eted from the change j ournal .

4. In the Purge timeout (seconds) fi el d, speci fy the ti meout setti ng

i n seconds.

5. C l i ck Purge N ow. When the w arni ng di al og box opens, cl i ck Yes

to purge the data, or N o to cancel the purge. If you cl i ck Yes,
change j ournal i nformati on for thi s proj ect from before the
speci fi ed date and ti me i s del eted.

6. C l i ck OK .

495 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Enabling Change Journaling

When change j ournal i ng i s enabl ed for a proj ect or proj ect source,
Intel l i gence Server l ogs i nformati on i n the change j ournal about any
change made to any obj ect i n the proj ect or proj ect source. Thi s
i ncl udes changes made i n D evel oper or Mi croStrategy Web as w el l as
through other Mi croStrategy tool s such as C ommand Manager or
Proj ect Merge.

You can enabl e change j ournal i ng for any number of proj ects i n a
proj ect source. For each proj ect, w hen change j ournal i ng i s enabl ed,
al l changes to al l obj ects i n that proj ect are l ogged.

You can al so enabl e change j ournal i ng at the proj ect source l evel . In
thi s case i nformati on about al l changes to the proj ect confi gurati on
obj ects, such as users or schedul es, i s l ogged i n the change j ournal .

By defaul t, change j ournal i ng i s enabl ed i n al l new l y created proj ects

and proj ect sources.

C l i ck here i f you are usi ng Mi croStrategy versi on 10.8 or hi gher

In versi ons of Mi croStrategy 10.8 and hi gher, change j ournal i ng i s

automati cal l y enabl ed and there i s no opti on to di sabl e i t. Thi s i s
because the Web Qui ck Search feature w i l l not functi on w i thout
change j ournal i ng enabl ed.

If your metadata database grow s too l arge due to change j ournal i ng,
best practi ce i s to keep records acti ve onl y for a certai n amount of
days and archi ve ol der records. You can set a speci fi c amount of days
usi ng D evel oper.

To Enable or Disable Change Journaling for a Project Source

1. In D evel oper, l og i n to a proj ect source. You must l og i n as a

user w i th the C onfi gure C hange Journal i ng pri vi l ege.

2. Expand A dministration, and then expand System Monitors.

© 2019, M icr o St r at egy In c. 496

Syst em Ad m in ist r at io n Gu id e

3. R i ght-cl i ck C hange Journal Transactions and sel ect Manage

C hange Journal.

4. To enabl e or di sabl e change j ournal i ng for thi s proj ect source,

sel ect or cl ear the Enable change journaling check box.

5. In the C omments fi el d, enter any comments that you may have

about the reason for enabl i ng or di sabl i ng change j ournal i ng.

6. To enabl e or di sabl e change j ournal i ng for al l proj ects i n the

proj ect source, sel ect the A pply to all projects check box. To
determi ne w hi ch proj ects have change j ournal i ng on a proj ect-
by-proj ect basi s, l eave thi s check box cl eared.

7. C l i ck OK .

497 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To Enable or Disable Change Journaling for a Project

1. From D evel oper, ri ght-cl i ck the proj ect and sel ect Project
C onfiguration.

2. Expand Project definition, and then sel ect C hange Journaling.

3. To enabl e or di sabl e change j ournal i ng for thi s proj ect, sel ect or
cl ear the Enable C hange Journaling check box.

4. C l i ck OK .

Ch an ge Jo u r n al Co mmen t s
When change j ournal i ng i s enabl ed, users are prompted for comments
every ti me they change an obj ect. These comments can provi de
documentati on as to the nature of the changes made to obj ects.

You can di sabl e the requests for obj ect comments from the D evel oper
Preferences di al og box.

To Disable the Requests for Change Journaling Comments

1. From D evel oper, go to Tools > MicroStrategy D eveloper

Preferences.

2. Expand Optional A ctions, and then sel ect General.

3. C l ear the D isplay change journal comments input dialog

check box.

4. C l i ck OK .

© 2019, M icr o St r at egy In c. 498

Syst em Ad m in ist r at io n Gu id e

Monitoring System Usage: Intelligence Server

Statistics
To tune your system for best performance, you need i nformati on about
how the system i s bei ng used. Intel l i gence Server can record usage
and performance stati sti cs for each proj ect i n your system. You can
then anal yze these stati sti cs to determi ne w hat changes need to be
made.

Thi s secti on provi des the fol l ow i ng i nformati on about Intel l i gence
Server stati sti cs:

l Overvi ew of Intel l i gence Server Stati sti cs, page 499

l Best Practi ces for R ecordi ng Intel l i gence Server Stati sti cs, page
505

l C onfi guri ng Intel l i gence Server to Log Stati sti cs, page 507

Mic roStrategy Enterpris e Manager c an help y ou analy z e the Intelligenc e

Serv er s tatis tic s data. Enterpris e Manager c ons is ts of a Mic roStrategy
projec t c ontaining a wide v ariety of reports and dos s iers that pres ent the
s tatis tic s data in an eas y -to-unders tand format. For more information
about Enterpris e Manager, s ee the Enterpri se Manager Gui de .

Overview of Intelligence Server Statistics

Intel l i gence Server can record a w i de vari ety of stati sti cs rel ati ng to
user acti vi ty, data w arehouse acti vi ty, report SQL, and system
performance. These stati sti cs are l ogged i n the stati sti cs database
(see The Stati sti cs D atabase, page 503).

The stati sti cs that are l ogged for each proj ect are set i n the Proj ect
C onfi gurati on Edi tor, i n the Statistics: General subcategory. The
opti ons are as fol l ow s:

499 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Sta tis tic s logging

Sta tis tic s logge d
option

User session and project session analysis. This opt ion must
A ll basic st at ist ics
be select ed f or any st at ist ics t o be logged.

Report job st eps Det ailed st at ist ics on t he processing of each report .

Document job st eps Det ailed st at ist ics on t he processing of each document .

The generat ed S QL f or all report jobs.

Report job S QL
This opt ion can creat e a very large st at ist ics t able.
S elect t his opt ion when you need t he job S QL dat a.

Report job
Dat a warehouse t ables and columns accessed by each
t ables/ columns
report .
accessed

Det ailed st at ist ics on report s and document s t hat are

Mobile Client s
execut ed on a mobile device.

Mobile Client s
Manipulat ions
Det ailed st at ist ics on act ions perf ormed by end users on a
This opt ion is available mobile client .
if Mobile C lients is
select ed

Only purge st at ist ics P urge st at ist ics f rom t he dat abase if t hey are f rom t he
logged f rom t he current I nt elligence S erver you are now using. This is applicable if
I nt elligence S erver. you are using clust ered I nt elligence S ervers.

You can l og di fferent stati sti cs for each proj ect. For exampl e, you may
w ant to l og the report j ob SQL for your test proj ect w hen tracki ng
dow n an error. If you l ogged report j ob SQL for your producti on
proj ect, and your users are runni ng many reports, the stati sti cs
database w oul d qui ckl y grow to an unw i el dy si ze.

© 2019, M icr o St r at egy In c. 5 00

Syst em Ad m in ist r at io n Gu id e

Reco r d in g Per f o r man ce Co u n t er s in t h e St at ist ics Tab les

Intel l i gence Server can be confi gured to col l ect performance
i nformati on from the D i agnosti cs and Performance Loggi ng Tool and
record that i nformati on i n the stati sti cs database. For more
i nformati on about l oggi ng performance counters, see C onfi guri ng
What i s Logged, page 517.

Intel l i gence Server can col l ect and l og i nformati on from the
Mi croStrategy Server Jobs and Mi croStrategy Server U sers
categori es. On U N IX or Li nux, Intel l i gence Server can al so col l ect
and l og i nformati on from the fol l ow i ng categori es:

l Memory

l System

l Process

l Processor

l N etw ork Interface

l Physi cal D i sk

Thi s i nformati on i s recorded i n the STG_IS_PER F_MON _STATS

tabl e i n the stati sti cs database.

To Configure the Performance Counters to Record Information

in the Statistics Repository

1. Open the D i agnosti cs and Performance Loggi ng Tool .

l From D evel oper: From the Tools menu, sel ect D iagnostics.

If y ou are running Mic roStrategy Dev eloper on Windows for the

firs t time, run it as an adminis trator.

5 01 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Right-c lic k the program ic on and s elec t R un as

A dministrator .

This is nec es s ary in order to properly s et the Windows regis try

k ey s . For more information, s ee KB43491 .

If the D iagnostics option does not appear on the Tools menu,

it has not been enabled. To enable this option, from the Tools
menu, s elec t MicroStrategy D eveloper Preferences . In the
General c ategory , in the A dvanced s ubc ategory , s elec t the
Show D iagnostics Menu Option c hec k box and c lic k OK .

l In Wi ndow s: From the Wi ndow s Start menu, poi nt to A ll

Programs, then MicroStrategy Tools, and then sel ect
D iagnostics C onfiguration.

l In Li nux: N avi gate to the di rectory ~ / M i c r o S t r a t e g y / b in

and enter m s t r d i a g.

2. From the Select C onfiguration drop-dow n l i st, sel ect

C astorServer Instance.

3. Sel ect the Performance C onfiguration tab.

4. Make sure the U se Machine D efault Performance

C onfiguration check box i s cl eared so that your l oggi ng setti ngs
are not overri dden by the defaul t setti ngs.

5. In the Statistics col umn, sel ect the check boxes for the counters
that you w ant to l og to the stati sti cs reposi tory.

6. In the Stati sti cs Properti es group, i n the Logging Frequency

(min), speci fy how often (i n mi nutes) you w ant the performance
counters to l og i nformati on.

7. From the Persist statistics drop-dow n l i st, sel ect Yes.

© 2019, M icr o St r at egy In c. 5 02

Syst em Ad m in ist r at io n Gu id e

8. From the File menu, sel ect Save. The changes that you have
made to the l oggi ng properti es are saved.

Th e St at ist ics Dat ab ase

Intel l i gence Server l ogs the speci fi ed stati sti cs to the stagi ng tabl es
i n the stati sti cs reposi tory. For a detai l ed exami nati on of the stagi ng
tabl es i n the stati sti cs reposi tory, see the Stati sti cs D ata D i cti onary i n
the System Admi ni strati on Gui de.

If you are usi ng Enterpri se Manager to moni tor your stati sti cs, the
database that hosts the stagi ng tabl es al so contai ns the Enterpri se
Manager data w arehouse. The i nformati on i n the stagi ng tabl es i s
processed and l oaded i nto the data w arehouse as part of the data
l oad process. For i nformati on about the structure of the Enterpri se
Manager data w arehouse, see the Enterpri se Manager D ata
D i cti onary. For steps on confi guri ng Enterpri se Manager and
schedul i ng data l oads, see the Enterpri se Manager Gui de.

Intel l i gence Server may open up to one database connecti on for each
proj ect that i s confi gured to l og stati sti cs. For exampl e, i n a proj ect
source w i th four proj ects, each of w hi ch i s l oggi ng stati sti cs, there
may be up to four database connecti ons opened for l oggi ng stati sti cs.
H ow ever, the maxi mum number of database connecti ons i s typi cal l y
seen i n hi gh-concurrency envi ronments.

In a c lus tered env ironment, eac h node of the c lus ter requires a databas e
c onnec tion for eac h projec t loaded onto that node. For ex ample, a two-
node c lus ter with 10 projec ts loaded on eac h node has 20 c onnec tions to
the warehous e (10 for eac h node). Ev en if the s ame 10 projec ts are
loaded on both nodes , 20 databas e c onnec tions ex is t.

5 03 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Supported Database Platforms

Mi croStrategy supports the fol l ow i ng database pl atforms for use w i th

Intel l i gence Server stati sti cs:

l SQL Server

l Oracl e

l Teradata

l IBM D B2 U D B

l Sybase ASE

For i nformati on about the speci fi c versi ons of each database that are
supported, see the R eadme.

Lo ggin g All St at ist ics f r o m a Pr o ject So u r ce t o t h e Same

Dat ab ase
By defaul t, al l proj ects for a proj ect source must be confi gured to l og
stati sti cs i ndi vi dual l y. Thi s confi gurati on i s cal l ed C omplete Session
Logging. It al l ow s some proj ects to l og stati sti cs to a database and
some proj ects to l og to another database.

The Enterpris e Manager data warehous e mus t be in the s ame databas e

as the s tatis tic s repos itory for a projec t. If y ou are us ing Enterpris e
Manager in a c omplete s es s ion logging c onfiguration, there are as many
Enterpris e Manager data warehous es as there are s tatis tic s
repos itories . A s eparate Enterpris e Manager projec t mus t be c onfigured
for eac h s tatis tic s repos itory .

Mi croStrategy recommends that you confi gure al l proj ects i n your

proj ect source to l og stati sti cs to the same database. Thi s i s
accompl i shed by confi guri ng your system to use Single Instance
Session Logging. Thi s can mi ni mi ze sessi on l oggi ng and opti mi ze
system performance.

© 2019, M icr o St r at egy In c. 5 04

Syst em Ad m in ist r at io n Gu id e

U nder si ngl e i nstance sessi on l oggi ng, you must sti l l speci fy w hi ch
stati sti cs are l ogged for each i ndi vi dual proj ect i n the proj ect source,
as descri bed i n Overvi ew of Intel l i gence Server Stati sti cs, page 499.

To us e s ingle ins tanc e s es s ion logging s uc c es s fully , the s elec ted s ingle
ins tanc e s es s ion logging projec t mus t be loaded onto the Intelligenc e
Serv er at s tartup. If c lus tered Intelligenc e Serv ers are being us ed, the
projec t mus t be loaded onto all the c lus tered Intelligenc e Serv ers .
Failing to load this projec t on all s erv ers at s tartup res ults in a los s of
s es s ion s tatis tic s for any Intelligenc e Serv er on whic h the projec t is not
loaded at s tartup. For details on the pos s ible s ide effec ts of not loading
all projec ts , s ee Mic roStrategy Tec h Note TN14591.

To Log All Statistics from a Project Source to the Same Database

1. In D evel oper, ri ght-cl i ck the proj ect source and sel ect C onfigure
MicroStrategy Intelligence Server.

2. On the l eft, expand Statistics, then sel ect General.

3. Sel ect the Single Instance Session Logging opti on.

4. Sel ect a proj ect from the drop-dow n l i st.

5. C l i ck OK .

Best Practices for Recording Intelligence Server Statistics

Mi croStrategy recommends the fol l ow i ng best practi ces for l oggi ng
Intel l i gence Server stati sti cs:

l C onfi gure your system for si ngl e i nstance sessi on l oggi ng, so that
al l proj ects for a proj ect source use the same stati sti cs reposi tory.
Thi s can reduce dupl i cati on, mi ni mi ze database w ri te ti me, and
i mprove performance. For i nformati on about si ngl e i nstance sessi on
l oggi ng, see Overvi ew of Intel l i gence Server Stati sti cs, page 499.

5 05 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l U se the si zi ng gui del i nes (see Si zi ng Gui del i nes for the Stati sti cs
R eposi tory, page 506) to pl an how much hard di sk space you need
for the stati sti cs reposi tory.

l U se Enterpri se Manager to moni tor and anal yze the stati sti cs
i nformati on. For more i nformati on about Enterpri se Manager, see
the Enterpri se Manager Gui de

Sizin g Gu id elin es f o r t h e St at ist ics Rep o sit o r y

The fol l ow i ng gui del i nes can hel p you determi ne how much space
you need for the stati sti cs reposi tory. These gui del i nes are for
pl anni ng purposes; Mi croStrategy recommends that you moni tor the
si ze of your stati sti cs reposi tory and adj ust your hardw are
requi rements accordi ngl y.

l When the Basi c Stati sti cs, R eport Job Steps, D ocument Job Steps,
R eport SQL, R eport Job Tabl es/C ol umns Accessed, and Prompt
Answ ers stati sti cs are l ogged, a user executi ng a report i ncreases
the stati sti cs database si ze by an average of 70 ki l obytes.

l Thi s val ue assumes that l arge and compl ex reports are run as often
as smal l reports. In contrast, i n an envi ronment w here more than 85
percent of the reports that are executed return few er than 1,000
cel l s, the average report i ncreases the stati sti cs database si ze by
l ess than 10 ki l obytes.

l When the Subscri pti on D el i veri es and Inbox Messages stati sti cs are
l ogged, each subscri pti on that i s del i vered i ncreases the stati sti cs
database si ze by l ess than 100 ki l obytes. Thi s i s i n addi ti on to the
database i ncrease from l oggi ng the report executi on.

l When performance counters are l ogged to the stati sti cs database,

each performance counter val ue that i s l ogged i ncreases the
database si ze by an average of 0.4 ki l obyte. You can control thi s
tabl e's grow th by speci fyi ng w hat counters to l og and how often to

© 2019, M icr o St r at egy In c. 5 06

Syst em Ad m in ist r at io n Gu id e

l og each. For more i nformati on on l oggi ng performance counters to

the stati sti cs database, i ncl udi ng i nstructi ons, see Overvi ew of
Intel l i gence Server Stati sti cs, page 499.

To determi ne how l arge a database you need, mul ti pl y the space

requi red for a report by the number of reports that w i l l be run over the
amount of ti me you are keepi ng stati sti cs. For exampl e, you may pl an
to keep the stati sti cs database current for si x months and archi ve and
purge stati sti cs data that are ol der than si x months. You expect users
to run an average of 400 reports per day, of w hi ch 250, or 63 percent,
return few er than 1,000 row s, so you assume that each report w i l l
i ncrease the stati sti cs tabl e by about 25 ki l obytes.

25 KB/report * 400 reports/day * 30 days/month * 6 months

= 1,800,000 KB or 1.8 GB

Accordi ng to these usage assumpti ons, you deci de to al l ocate 2 GB of

di sk space for the stati sti cs database.

Configuring Intelligence Server to Log Statistics

Bel ow i s a hi gh-l evel overvi ew of the steps to confi gure a proj ect to
l og stati sti cs.

Cr eat in g t h e St at ist ics Dat ab ase

You can store Intel l i gence Server stati sti cs i n an exi sti ng database i n
your system, or create a new database.

Do not s tore the s tatis tic s in the s ame databas e that y ou are us ing for
either y our Mic roStrategy metadata or y our data warehous e.

l To use an exi sti ng database, note i ts D ata Source N ame (D SN ).

Thi s D SN i s used w hen you create the stati sti cs tabl es.

5 07 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

If y ou c hoos e to us e Enterpris e Manager to analy z e the s tatis tic s , this

DSN is als o us ed to s pec ify the data warehous e loc ation for
Enterpris e Manager. For information on Enterpris e Manager, s ee the
Enterpri se Manager Gui de .

l To create a new database, fol l ow the procedure bel ow . For a l i st of

databases that are certi fi ed for use w i th Intel l i gence Server
stati sti cs, see Overvi ew of Intel l i gence Server Stati sti cs, page 499,
or see the R eadme.

To Create a New Statistics Database

1. C reate the empty data w arehouse database. (Thi s i s general l y

performed by your database admi ni strator.) Thi s database must
be one of the databases certi fi ed for Intel l i gence Server
stati sti cs, as l i sted i n the R eadme.

2. U se the Mi croStrategy C onnecti vi ty Wi zard to create a D ata

Source N ame for the data w arehouse. Make note of thi s D SN for
l ater.

To access the C onnecti vi ty Wi zard, go to Start > A ll Programs >

MicroStrategy Tools > C onnectivity Wizard. For detai l ed
i nstructi ons on usi ng the C onnecti vi ty Wi zard, see the
Instal l ati on and C onfi gurati on Gui de.

To av oid a s ituation in whic h s ome s tatis tic s databas e entries

reports hav e inc omplete information, s y nc hroniz e the time of the
Intelligenc e Serv er mac hine with the databas e time, if pos s ible.

Cr eat in g St at ist ics Tab les in t h e St at ist ics Dat ab ase

After the stati sti cs database has been created, or you have noted your
exi sti ng database's D SN , you need to create the empty stati sti cs
tabl es for Intel l i gence Server to use. The Mi croStrategy C onfi gurati on
Wi zard w al ks you through thi s process.

© 2019, M icr o St r at egy In c. 5 08

Syst em Ad m in ist r at io n Gu id e

To Create the Empty Statistics Tables

1. Start the Mi croStrategy C onfi gurati on Wi zard.

l Wi ndow s: go to Start > A ll Programs > MicroStrategy Tools >

C onfiguration Wizard.

l Li nux: Brow se to the di rectory speci fi ed as the home di rectory

duri ng Mi croStrategy i nstal l ati on. Brow se to the fol der b i n and
type ./ m s t r c f g w i z and press Enter.

2. On the Wel come page, sel ect C reate Metadata, H istory List and
Enterprise Manager R epositories and cl i ck N ext.

3. Sel ect the Statistics & Enterprise Manager opti on and cl ear the
other opti ons. C l i ck N ext.

4. From the D SN drop-dow n l i st, sel ect the D ata Source N ame for
the database that w i l l contai n your Enterpri se Manager
reposi tory (the same database that you w i l l use to l og
Intel l i gence Server stati sti cs).

Any table in this databas e that has the s ame name as a

Mic roStrategy s tatis tic s table is dropped. For a lis t of the
Mic roStrategy s tatis tic s tables , s ee the Intel l i gence Server
Stati sti cs D ata D i cti onary .

5. In the U ser N ame and Password fi el ds, enter a val i d l ogi n and
passw ord for the data w arehouse database.

The us er name y ou s pec ify mus t hav e permis s ion to c reate and
drop tables in the databas e, and permis s ion to c reate v iews .

6. If you w ant to use a custom SQL scri pt for creati ng the reposi tory,
cl i ck A dvanced.

5 09 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l In the Script fi el d, the defaul t scri pt fi l e name i s di spl ayed. The

sel ected scri pt depends on the database type that you
speci fi ed earl i er.

l To sel ect a di fferent scri pt, cl i ck ... (the B rowse button) to

brow se to and sel ect a scri pt that corresponds to the D BMS for
the reposi tory.

7. C l i ck N ext.

If Enterpri se Manager stati sti cs tabl es al ready exi st i n thi s

database, i t prompts you for w hether to re-create the tabl es. To
re-create them, cl i ck Yes. To l eave the exi sti ng tabl es i n pl ace,
cl i ck N o.

Clic k ing Yes deletes the ex is ting tables and all information in
them.

8. C l i ck Finish.

Set t in g t h e St at ist ics Dat ab ase In st an ce f o r a Pr o ject

Once the stati sti cs reposi tory has been created, you must confi gure
your proj ect to l og stati sti cs to thi s database.

Mi croStrategy recommends that you confi gure your system to use

si ngl e i nstance sessi on l oggi ng. In thi s confi gurati on, stati sti cs for al l
proj ects i n a proj ect source are l ogged to a si ngl e database. To
enabl e si ngl e i nstance sessi on l oggi ng, i n the Intel l i gence Server
C onfi gurati on Edi tor, i n the Statistics: General category, sel ect
Single Instance Session Logging and, from the drop-dow n l i st,
sel ect a proj ect. Then speci fy that proj ect's stati sti cs database usi ng
the procedure bel ow . For steps on enabl i ng si ngl e i nstance sessi on
l oggi ng, see Overvi ew of Intel l i gence Server Stati sti cs, page 499.

© 2019, M icr o St r at egy In c. 5 10

Syst em Ad m in ist r at io n Gu id e

To Set Up a Project to Log Statistics

1. In D evel oper, l og i n to the server (three-ti er) proj ect source

contai ni ng the proj ects for w hi ch you w ant to l og stati sti cs. You
must l og i n as a user w i th the C onfi gure Server Basi c pri vi l ege.

2. R i ght-cl i ck the proj ect that you w ant to moni tor and sel ect
Project C onfiguration.

If y ou are us ing s ingle ins tanc e s es s ion logging, the projec t that
y ou s elec t to c onfigure mus t be the projec t that y ou s elec ted when
y ou s et up s ingle ins tanc e s es s ion logging.

3. Expand the D atabase Instances category, and sel ect the SQL
D ata warehouses subcategory.

4. You need to create a new database i nstance for the stati sti cs
reposi tory database. C l i ck N ew.

5. In the D atabase instance name fi el d, type i n a name for the

stati sti cs reposi tory database i nstance.

5 11 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

6. From the D atabase connection type drop-dow n l i st, sel ect the
database type and versi on that corresponds to the stati sti cs
reposi tory database D BMS.

7. You need to create a new database connecti on to connect to the

database i nstance. C l i ck N ew.

8. In the D atabase connection name fi el d, type a name for the

database connecti on.

9. From the OD B C D ata Sources l i st, sel ect the D ata Source N ame
used to connect to the stati sti cs reposi tory database.

10. Enabl e parameteri zed queri es i n the stati sti cs reposi tory
database connecti on. To do thi s, on the A dvanced tab, sel ect
the U se parameterized queries check box.

11. You need to create a new database l ogi n to l og i n to the

database i nstance. On the General tab, cl i ck N ew.

12. Type a name for the new database l ogi n i n the D atabase login
fi el d.

If this databas e login is more than 32 c harac ters long, the

s tatis tic s logging will generate errors in the DSS Errors log.

13. Type a val i d database l ogi n ID and passw ord i n the

correspondi ng fi el ds.

Mic roStrategy does not v alidate this login ID and pas s word, s o be
c areful to ty pe them c orrec tly .

14. C l i ck OK three ti mes to return to the Proj ect C onfi gurati on Edi tor.
In each case before cl i cki ng OK , make sure your new database
l ogi n and database connecti on are sel ected.

© 2019, M icr o St r at egy In c. 5 12

Syst em Ad m in ist r at io n Gu id e

15. In the D atabase Instances category, sel ect the Statistics

subcategory.

16. From the Statistics database instance drop-dow n l i st, sel ect
your new stati sti cs database i nstance.

17. C l i ck OK .

Conf i gur e an Ad d i t i onal Dat ab ase Dr i ver Set t i ng

If your stati sti cs and Enterpri se Manager reposi tory i s i n an Oracl e,

Sybase, or Teradata database, you must confi gure an addi ti onal
OD BC dri ver setti ng so the i nformati on i s recorded properl y i n the
stati sti cs reposi tory.

1. Open the OD BC D ata Source Admi ni strator tool i n Wi ndow s.

2. Sel ect the D SN for your stati sti cs and Enterpri se Manager
reposi tory and cl i ck Modify.

3. Perform the fol l ow i ng accordi ng to your database:

l Oracl e: cl i ck the A dvanced tab and sel ect the Enable

SQLD escribeParam checkbox.

l Sybase: cl i ck the A dvanced tab and sel ect the Enable

D escribe Parameter checkbox.

l Teradata: cl i ck Options and sel ect the Enable Extended

Statement Information checkbox.

4. C l i ck OK tw i ce.

Sp ecif yin g Wh ich St at ist ics t o Lo g

Once you have speci fi ed a stati sti cs database i nstance for a proj ect,
you can sel ect w hat stati sti cs to l og. For detai l ed i nformati on about
w hat stati sti cs can be l ogged, see Overvi ew of Intel l i gence Server
Stati sti cs, page 499.

5 13 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

You must speci fy w hat stati sti cs to l og for al l proj ects that l og
stati sti cs. Si ngl e i nstance sessi on l oggi ng (see Overvi ew of
Intel l i gence Server Stati sti cs, page 499) causes al l proj ects on a
proj ect source to share the same stati sti cs database, but not to l og the
same stati sti cs.

To log information from performanc e c ounters , us e the Diagnos tic s and

Performanc e Logging Tool. For s teps on how to log performanc e
information, s ee Overvi ew of Intel l i gence Server Stati sti cs, page
499 .

To Specify Which Statistics to Log

1. In D evel oper, l og i n to the proj ect source contai ni ng the proj ect
for w hi ch you w ant to l og stati sti cs. You must l og i n as a user
w i th the C onfi gure Server Basi c pri vi l ege.

2. R i ght-cl i ck the proj ect that you w ant to moni tor and sel ect
Project C onfiguration.

3. Expand the Statistics category, and sel ect the General

subcategory.

4. Sel ect the B asic Statistics checkbox.

5. To l og advanced stati sti cs, sel ect the checkboxes for the
stati sti cs you w ant to l og. For i nformati on about each check box,
see Overvi ew of Intel l i gence Server Stati sti cs, page 499.

6. C l i ck OK .

7. To begi n l oggi ng stati sti cs, unl oad and rel oad the proj ect for
w hi ch you are l oggi ng stati sti cs:

1. In D evel oper, expand A dministration, then expand System

A dministration, then sel ect Project.

© 2019, M icr o St r at egy In c. 5 14

Syst em Ad m in ist r at io n Gu id e

2. R i ght-cl i ck the proj ect, poi nt to A dminister Project, and

sel ect U nload.

3. R i ght-cl i ck the proj ect, poi nt to A dminister Project, and

sel ect Load.

Monitoring Quick Search Indices

A qui ck search i ndex i s created w hen a proj ect i s l oaded for the fi rst
ti me. If no i ndex fol der i s found w i thi n the proj ect, Mi croStrategy w i l l
do an i ni ti al craw l and create the search i ndex w i thi n that proj ect.
Each ti me a proj ect i s l oaded or an obj ect i s created w i thi n a proj ect,
the search i ndex w i l l be updated based upon the change j ournal
entri es that are not part of the i ndex.

Rebuilding a Quick Search Index

If certai n system confi gurati ons change, i t may be necessary to
rebui l d your qui ck search i ndex. Qui ck search i ndi ces are accessi bl e
through your system moni tors. To rebui l d a search i ndex:

1. Open a proj ect source i n D evel oper.

If y ou are running Mic roStrategy Dev eloper on Windows for the

firs t time, run it as an adminis trator.

Right-c lic k the program ic on and s elec t R un as A dministrator .

This is nec es s ary in order to properly s et the Windows regis try

k ey s . For more information, s ee KB43491 .

2. Open A dministration > System Monitors > Quick Search

Indices to vi ew the i ndi ces.

3. R i ght-cl i ck and sel ect R ebuild Index.

When to Rebuild an Index

The fol l ow i ng scenari os may requi re you to rebui l d a search i ndex:

5 15 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l If you sw i tch the metadata i n your envi ronment a rebui l d w i l l be

requi red.

l If you change your i ndex fol der a rebui l d w i l l be requi red.

l If you upgrade your envi ronment a rebui l d may be necessary.

l If you can not search your obj ects normal l y.

Additional Monitoring Tools

In addi ti on to the l oggi ng tool s and system moni tors l i sted above,
Mi croStrategy provi des several tool s that hel p you track system usage
and changes to the system.

Diagnostics and Performance Logging Tool

In Mi croStrategy, the process of l oggi ng and anal yzi ng operati on and
performance i nformati on i s know n as di agnosti cs. Informati on can be
l ogged for many Intel l i gence Server and operati ng system features
and functi ons. You can confi gure the l og fi l es to record di agnosti cs
i nformati on at di fferent l evel s to di fferent fi l es. For exampl e, you can
l og al l Mi croStrategy errors to the defaul t l og fi l e of D S S E r r o r s . l og,
and l og al l i nformati on about Memory C ontract Manager (see
Governi ng Intel l i gence Server Memory U se w i th Memory C ontract
Manager, page 698) to a new l og fi l e cal l ed Me m o r y L o g . l o g. You
can al so l og performance i nformati on, such as the ti me taken to
perform vari ous operati ons and the total number of operati ons
performed.

H ow ever, i f too much i nformati on i s l ogged, i t can degrade the

system's performance. By defaul t, l oggi ng i s set to a mi ni mum. At
some poi nt you may w ant to detect probl ems i n the system for w hi ch
l oggi ng i s not enabl ed by defaul t.

Thi s secti on i ncl udes i nformati on on the fol l ow i ng topi cs:

© 2019, M icr o St r at egy In c. 5 16

Syst em Ad m in ist r at io n Gu id e

l C onfi guri ng What i s Logged, page 517

l Vi ew i ng and Anal yzi ng Log Fi l es, page 534

l Anal yzi ng a Server State D ump, page 537

Co n f igu r in g Wh at is Lo gged
The Mi croStrategy D i agnosti cs and Performance Loggi ng tool
confi gures w hi ch di agnosti c messages are recorded to Mi croStrategy
l og fi l es. You can customi ze the l oggi ng opti ons to gather i nformati on
from more or few er system components and performance counters,
and to save l og messages to di fferent l og fi l es.

To Configure Logging with the Diagnostics and Performance

Logging Tool

If y ou s av e any c hanges to s ettings in the Diagnos tic s and Performanc e

Logging tool, y ou c annot automatic ally return to the out-of-the-box
s ettings . If y ou might want to return to the original default s ettings at any
time, rec ord the default s etup for y our rec ords .

1. Open the D i agnosti cs and Performance Loggi ng Tool .

l From D evel oper: go to Tools > D iagnostics.

If the D iagnostics option does not appear on the Tools menu,

it has not been enabled. To enable this option, go to Tools >
MicroStrategy D eveloper Preferences > General >
A dvanced > Show D iagnostics Menu Option c hec k box
and c lic k OK .

l In Wi ndow s: go to Start > A ll Programs > MicroStrategy

Tools > D iagnostics C onfiguration.

5 17 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l In Li nux: N avi gate to the di rectory ~ / M i c r o S t r a t e g y / b in

and enter m s t r d i a g.

2. From the Select C onfiguration drop-dow n l i st, sel ect w hether to

confi gure l oggi ng for thi s machi ne onl y or for the enti re server
i nstance:

l To confi gure l oggi ng for thi s machi ne onl y, sel ect Machine
D efault.

l To confi gure l oggi ng for the server i nstance, sel ect

C astorServer Instance.

To c onfigure the s erv er ins tanc e with the logging s ettings that are us ed
by this mac hine, s elec t C astorServer Instance and then s elec t the
U se Machine D efault D iagnostics C onfiguration c hec k box .

© 2019, M icr o St r at egy In c. 5 18

Syst em Ad m in ist r at io n Gu id e

Conf i gur e Di agnost i cs Loggi ng

1. Sel ect the D iagnostics C onfiguration tab. For more i nformati on

about di agnosti cs l oggi ng, see D i agnosti cs C onfi gurati on, page
520.

2. To l og i nformati on about a component to the operati ng system

l og fi l e, sel ect the System Log check box for that component.

3. To l og i nformati on about a component to the Mi croStrategy

Moni tor consol e, sel ect the C onsole Log check box for that
component.

This log des tination is intended for us e for interac tiv e tes ting and
troubles hooting purpos es , and s hould not be us ed in produc tion
deploy ments .

4. To l og i nformati on about a component to a Mi croStrategy l og fi l e,

i n the File Log drop-dow n l i st for that component, sel ect the l og
fi l e.

Logging the Kernel XML API c omponent c an c aus e the log file to grow
v ery large. If y ou enable this diagnos tic , mak e s ure the log file y ou
s elec t in the File Log c olumn has a Max File Size (K B ) of at leas t
2000. For ins truc tions on how to s et the max imum s iz e of a log file, s ee
C reati ng and Managi ng Log Fi l es, page 533

Conf i gur e Per f or m ance Loggi ng

1. Sel ect the Performance C onfiguration tab. For more

i nformati on about performance l oggi ng, see C onfi gure
Performance Loggi ng Setti ngs, page 522.

2. C onfi gure the performance l og fi l e and stati sti cs l oggi ng

properti es usi ng the opti ons on the ri ght si de of the D i agnosti cs
and Performance Loggi ng Tool .

5 19 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

3. To l og i nformati on from a performance counter to the

performance l og fi l e, sel ect the File Log check box for that
counter.

4. To l og i nformati on from a performance counter to the stati sti cs

tabl es, sel ect the Statistics check box for that counter.

5. C l i ck Save.

You may need to res tart Intelligenc e Serv er for the new logging
s ettings to tak e effec t.

Once the system begi ns l oggi ng i nformati on, you can anal yze i t by
vi ew i ng the appropri ate l og fi l e. For i nstructi ons on how to read a
Mi croStrategy l og fi l e, see C reati ng and Managi ng Log Fi l es, page
533.

Diagnostics Configuration

Each component of the Mi croStrategy system can produce l og

messages. These messages can hel p you track dow n the source of
any errors that you encounter. For exampl e, i f your system seems to
be runni ng l ow on memory, you can vi ew the l og fi l es to determi ne
w hi ch components and processes are usi ng more memory than
anti ci pated.

These l og messages can be recorded i n a Mi croStrategy l og fi l e. They

can al so be recorded i n the operati ng system's l og fi l e, such as the
Wi ndow s Event Moni tor.

The component/di spatcher combi nati ons that you choose to enabl e
l oggi ng for depend on your envi ronment, your system, and your users'
acti vi ti es. In general , the most useful di spatchers to sel ect are the
fol l ow i ng:

© 2019, M icr o St r at egy In c. 5 20

Syst em Ad m in ist r at io n Gu id e

l Error: Thi s di spatcher l ogs the fi nal message before an error

occurs, w hi ch can be i mportant i nformati on to hel p detect the
system component and acti on that caused or preceded the error.

l Fatal: Thi s di spatcher l ogs the fi nal message before a fatal error
occurs, w hi ch can be i mportant i nformati on to hel p detect the
system component and acti on that caused or preceded the server
fatal i ty.

l Info: Thi s di spatcher l ogs every operati on and mani pul ati on that
occurs on the system.

Some of the most common customi zati ons to the defaul t di agnosti cs
setup are show n i n the fol l ow i ng tabl e. Each component/di spatcher
combi nati on i n the tabl e i s commonl y added to provi de di agnosti c
i nformati on about that component and i ts rel ated trace (di spatcher).
To add a combi nati on, sel ect i ts check box.

Compone nt Dis pa tc he r

A ut hent icat ion

Trace
S erver

Dat abase Classes A ll

• Cont ent S ource Trace

Met adat a S erver
• Transact ion Trace

E ngine DFC E ngine

• E lement S ource Trace

E lement S erver
• Object S ource Trace

• Cont ent S ource Trace

Object S erver • Object S ource Trace

• S cope Trace

Report Net S erver S cope Trace

5 21 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Compone nt Dis pa tc he r

• Cache Trace

Report S erver • Object S ource Trace

• Report S ource Trace

• S cheduler Trace
K ernel
• User Trace

Trace

I f you enable t his diagnost ic,

K ernel X ML A P I make sure t hat t he log f ile t hat
you select in t he File Log column
has it s Max File Siz e (K B ) set t o
at least 2000.

Performance Configuration

Mi croStrategy components can al so record vari ous performance

measurements. You can use these measurements to hel p tune your
system for better performance, or to i denti fy areas w here performance
can be i mproved. For exampl e, you may w ant to di scover exactl y how
much the C PU i s used to perform a gi ven system functi on.

Some performance counters can be l ogged to the Intel l i gence Server

stati sti cs tabl es as w el l . For more i nformati on about Intel l i gence
Server stati sti cs, see Moni tori ng System U sage: Intel l i gence Server
Stati sti cs, page 499.

Conf i gur e Per f or m ance Loggi ng Set t i ngs

When you sel ect the performance counters to be recorded, you can
determi ne how often data i s recorded, and w hether to persi st the
counters.

© 2019, M icr o St r at egy In c. 5 22

Syst em Ad m in ist r at io n Gu id e

You can enabl e or di sabl e performance l oggi ng w i thout havi ng to

cl ear al l the l oggi ng setti ngs. To enabl e l oggi ng to a fi l e, make sure
the Log C ounters drop-dow n l i st i s set to Yes. To enabl e l oggi ng to
the stati sti cs database, make sure the Persist Statistics drop-dow n
l i st i s set to Yes.

To Configure the Performance Logging Settings

1. In the D i agnosti cs and Performance Loggi ng tool , sel ect the

Performance C onfiguration tab.

2. From the Log D estination drop-dow n box, sel ect the fi l e to l og

performance counter data to.

To c reate a new performanc e log file, from the Log D estination

drop-down box , s elec t <N ew> . For ins truc tions on us ing the Log
Des tination Editor to c reate a new log file s ee C reati ng and
Managi ng Log Fi l es, page 533 .

3. In the Logging Frequency (sec) fi el d, type how often, i n

seconds, that you w ant the fi l e l og to be updated w i th the l atest
performance counter i nformati on.

4. To l og performance i nformati on to a l og fi l e, make sure the Log

C ounters drop-dow n l i st i s set to Yes.

5. In the Logging Frequency (min) fi el d, type how often, i n

mi nutes, that you w ant the stati sti cs database to be updated w i th
the l atest performance counter i nformati on.

6. To l og performance i nformati on to the stati sti cs database, make

sure the Persist Statistics drop-dow n l i st i s set to Yes.

7. When you are fi ni shed confi guri ng the performance counter l og

fi l e, cl i ck Save.

5 23 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Per f or m ance Count er s f or Sp eci f i c M i cr oSt r at egy Feat ur es

The tabl e bel ow l i sts the maj or Mi croStrategy softw are features and
the correspondi ng performance counters that you can use to moni tor
those features. For exampl e, i f the Attri bute C reati on Wi zard seems to
be runni ng sl ow l y, you can track i ts performance w i th the D SS
Attri buteC reati onWi zard, D SS ProgressIndi cator, and D SS
PropertySheetLi b performance counters.

Mic r oStr a te gy
Compone nts Tr a c e Le v e l
Fe a tur e

• DS S A t t ribut eCreat ionWizard

A t t ribut e Creat ion
• DS S P rogressI ndicat or Funct ion Level Tracing
Wizard
• DS S P ropert yS heet Lib

• DS S A t t ribut eE dit or

• DS S ColumnE dit or

• DS S CommonDialogsLib
A ll component s perf orm
• DS S Component s
Funct ion Level Tracing.
A t t ribut e E dit or • DS S E dit orCont ainer DS S Component s also
perf orms E xplorer and
• DS S E dit orManager
Component Tracing.
• DS S E xpressionboxLib

• DS S FormCat egoriesE dit or

• DS S P ropert yS heet Lib

• DS S A ut hS erver • A ut hent icat ion Tracing

• S ession Tracing
Client Connect ion • Dat a S ource Tracing
• DS S Client Connect ion
• Dat a S ource
E numerat or Tracing

Consolidat ion • DS S CommonDialogsLib A ll component s perf orm

© 2019, M icr o St r at egy In c. 5 24

Syst em Ad m in ist r at io n Gu id e

Mic r oStr a te gy
Compone nts Tr a c e Le v e l
Fe a tur e

• DS S Component s

• DS S Consolidat ionE dit orLib Funct ion Level Tracing.

DS S Component s also
E dit or • DS S E dit orCont ainer
perf orms E xplorer and
• DS S E dit orManager Component Tracing.

• DS S P rompt sLib

• DS S CommonDialogsLib

• DS S CommonE dit orCont rolsLib

• DS S Component s

• DS S Dat eLib

• DS S E dit orCont ainer

A ll component s perf orm
• DS S E dit orManager
Funct ion Level Tracing.
Cust om Group
• DS S E dit orS upport Lib DS S Component s also
E dit or
perf orms E xplorer and
• DS S E xpressionboxLib
Component Tracing.
• DS S Filt erLib

• DS S FTRCont ainerLib

• DS S Object sS elect orLib

• DS S P rompt E dit orsLib

• DS S P rompt sLib

• DS S Dat aTransmit t er

• DS S Mht Transf ormer

Dat a Transmit t ers
• DS S MI ME • Funct ion Level Tracing
and Transf ormers
• DS S S MTP S ender

• DS S Net work

E lement B rowsing • DS S DB E lement S erver A ll component s perf orm

5 25 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Mic r oStr a te gy
Compone nts Tr a c e Le v e l
Fe a tur e

• DS S E lement Net Client E lement S ource Tracing.

DS S DB E lement S erver
• DS S E lement Net S erver
also perf orms Report
• DS S E lement S erver S ource Tracing.

Fact Creat ion • DS S Fact Creat ionWizard

Funct ion Level Tracing
Wizard • DS S P rogressI ndicat or

• DS S ColumnE dit or

• DS S CommonDialogsLib

• DS S Component s A ll component s perf orm

• DS S E dit orCont ainer Funct ion Level Tracing.

Fact E dit or DS S Component s also
• DS S E dit orManager perf orms E xplorer and
• DS S E xpressionboxLib Component Tracing.

• DS S E xt ensionE dit or

• DS S Fact E dit or

• DS S CommonDialogsLib

• DS S CommonE dit orCont rolsLib

• DS S Component s

• DS S Dat eLib
A ll component s perf orm
• DS S E dit orCont ainer
Funct ion Level Tracing.
Filt er E dit or • DS S E dit orManager DS S Component s also
perf orms E xplorer and
• DS S E dit orS upport Lib
Component Tracing.
• DS S E xpressionboxLib

• DS S Filt erLib

• DS S FTRCont ainerLib

• DS S Object sS elect orLib

© 2019, M icr o St r at egy In c. 5 26

Syst em Ad m in ist r at io n Gu id e

Mic r oStr a te gy
Compone nts Tr a c e Le v e l
Fe a tur e

• DS S P rompt E dit orsLib

• DS S P rompt sLib

• DS S CommonDialogsLib

• DS S E dit orCont ainer

Hierarchy E dit or Funct ion Level Tracing
• DS S E dit orManager

• DS S HierarchyE dit or

• DS S CommonDialogsLib
A ll component s perf orm
• DS S Component s
Funct ion Level Tracing.
HTML Document
• DS S Document E dit or DS S Component s also
E dit or
perf orms E xplorer and
• DS S E dit orCont ainer
Component Tracing.
• DS S E dit orManager

• Object Tracing
• DS S MD4S erver
• A ccess Tracing

Met adat a S QL • S QL Tracing

• DS S MDS erver • Cont ent S ource
Tracing

• DS S CommonDialogsLib

• DS S Component s

• DS S Dimt yE dit orLib A ll component s perf orm

• DS S E dit orCont ainer Funct ion Level Tracing.

Met ric E dit or DS S Component s also
• DS S E dit orManager perf orms E xplorer and
• DS S E xpressionboxLib Component Tracing.

• DS S MeasureE dit orLib

• DS S P rompt sLib

5 27 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Mic r oStr a te gy
Compone nts Tr a c e Le v e l
Fe a tur e

• DS S P ropert iesCont rolsLib

A ll component s perf orm

• DS S Object S erver
Cont ent S ource Tracing.
Object B rowsing • DS S S ourceNet Client DS S Object S erver also
perf orms Object S ource
• DS S S ourceNet S erver
Tracing.

• DS S CommonDialogsLib

• DS S Component s
A ll component s perf orm
• DS S Dat aS liceE dit or
Funct ion Level Tracing.
P art it ion E dit or • DS S E dit orCont ainer DS S Component s also
perf orms E xplorer and
• DS S E dit orManager
Component Tracing.
• DS S Filt erLib

• DS S P art it ionE dit or

• DS S P rint Core

P rint S chema • DS S P rint S chema Funct ion Level Tracing

• DS S P rogressI ndicat or

• DS S A t t ribut eCreat ionWizard

• DS S Fact Creat ionWizard

P roject Creat ion • DS S P rogressI ndicat or Funct ion Level Tracing

• DS S P roject Creat ionLib

• DS S WHCat alog

• DS S A synchLib

P roject • DS S P rogressI ndicat or

Funct ion Level Tracing
Duplicat ion • DS S P roject UpgradeLib

• DS S S chemaManipulat ion

© 2019, M icr o St r at egy In c. 5 28

Syst em Ad m in ist r at io n Gu id e

Mic r oStr a te gy
Compone nts Tr a c e Le v e l
Fe a tur e

• DS S A synchLib

• DS S P rogressI ndicat or
P roject Upgrade Funct ion Level Tracing
• DS S P roject UpgradeLib

• DS S S chemaManipulat ion

• DS S CommonDialogsLib

• DS S CommonE dit orCont rolsLib

• DS S Component s
A ll component s perf orm
• DS S E dit orCont ainer
Funct ion Level Tracing.
P rompt E dit or • DS S E dit orManager DS S Component s also
perf orms E xplorer and
• DS S E dit orS upport Lib
Component Tracing.
• DS S P rompt E dit orsLib

• DS S P rompt S t yles

• DS S S earchE dit orLib

• DS S CommonDialogsLib

• DS S CommonE dit orCont rolsLib

• DS S Component s

• DS S Dat eLib
A ll component s perf orm
• DS S E dit orCont ainer
Funct ion Level Tracing.
Report E dit or • DS S E dit orManager DS S Component s also
perf orms E xplorer and
• DS S E dit orS upport Lib
Component Tracing.
• DS S E xport Lib

• DS S E xpressionboxLib

• DS S Filt erLib

• DS S FTRCont ainerLib

5 29 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Mic r oStr a te gy
Compone nts Tr a c e Le v e l
Fe a tur e

• DS S GraphLib

• DS S GridLib

• DS S Object sS elect orLib

• DS S P ageB yLib

• DS S P rint GraphI nt erf ace

• DS S P rint GridI nt erf ace

• DS S P rompt E dit orsLib

• DS S P rompt sLib

• DS S P ropert yS heet Lib

• DS S RepDrillingLib

• DS S RepFormat sLib

• DS S RepFormsLib

• DS S Report Cont rol

• DS S Report Dat aOpt ionsLib

• DS S Report S ort sLib

• DS S Report S ubt ot alLib

• Report S ource Tracing

• DS S Report Net Client
• P rocess Tracing
Report E xecut ion
• DS S Report Net S erver • P rocess Tracing

• DS S Report S erver • Report S ource Tracing

• DS S A dminE dit orCont ainer

S erver • DS S Dat abaseI nst anceWizard

Funct ion Level Tracing
A dminist rat ion
• DS S
DB Connect ionConf igurat ion

© 2019, M icr o St r at egy In c. 5 30

Syst em Ad m in ist r at io n Gu id e

Mic r oStr a te gy
Compone nts Tr a c e Le v e l
Fe a tur e

• DS S DB RoleConf igurat ion

• DS S Diagnost icsConf igurat ion

• DS S E V ent sE dit or

• DS S P riorit yMapE dit or

• DS S P rivilegesE dit or

• DS S P roject Conf igurat ion

• DS S S ecurit yRoleE dit or

• DS S S ecurit yRoleV iewer

• DS S S erverConf igurat ion

• DS S UserE dit or

• DS S V LDB E dit or

• DS S CommonDialogsLib

• DS S E dit orCont ainer

Table E dit or Funct ion Level Tracing
• DS S E dit orManager

• DS S TableE dit or

• DS S CommonDialogsLib

• DS S Component s

• DS S E dit orCont ainer

A ll component s perf orm
• DS S E dit orManager
Funct ion Level Tracing.
Templat e E dit or • DS S E xport Lib DS S Component s also
perf orms E xplorer and
• DS S FTRCont ainerLib
Component Tracing.
• DS S GraphLib

• DS S GridLib

• DS S P ageB yLib

5 31 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Mic r oStr a te gy
Compone nts Tr a c e Le v e l
Fe a tur e

• DS S P rint GraphI nt erf ace

• DS S P rint GridI nt erf ace

• DS S P rompt sLib

• DS S P ropert yS heet Lib

• DS S RepDrillingLib

• DS S RepFormat sLib

• DS S RepFormsLib

• DS S Report Cont rol

• DS S Report Dat aOpt ionsLib

• DS S Report S ort sLib

• DS S Report S ubt ot alLib

• DS S CommonDialogsLib

• DS S Component s A ll component s perf orm

• DS S E dit orCont ainer Funct ion Level Tracing.

Transf ormat ion
DS S Component s also
E dit or • DS S E dit orManager perf orms E xplorer and
• DS S E xpressionboxLib Component Tracing.

• DS S Transf ormat ionE dit or

• DS S CommonDialogsLib

• DS S Dat abaseI nst anceWizard

Warehouse
• DS S DB RoleConf igurat ion Funct ion Level Tracing
Cat alog B rowser
• DS S S chemaManipulat ion

• DS S WHCat alog

© 2019, M icr o St r at egy In c. 5 32

Syst em Ad m in ist r at io n Gu id e

Creating and Managing Log Files

D i agnosti cs i nformati on can be l ogged to mul ti pl e l og fi l es. For

exampl e, i n the defaul t confi gurati on, al l error messages are l ogged
to DS S Er ro rs . l o g, l i cense i nformati on i s l ogged to L i c e n s e . l og,
and messages from the Java Vi rtual Machi ne i n Mi croStrategy Web
are l ogged to J V M M e s s ag e s . l o g.

Performanc e information mus t all be logged to the s ame log file.

Each l og fi l e has a speci fi ed maxi mum si ze. When a Mi croStrategy

l og fi l e reaches i ts maxi mum si ze, the fi l e i s renamed w i th a .bak
extensi on, and a new l og fi l e i s created usi ng the same fi l e name. For
exampl e, i f the D S S E r r o r s . l o g fi l e reaches i ts maxi mum si ze, i t i s
renamed D SS E r r o r s . b a k, and a new D S S E r r o r s . l o g fi l e i s
created.

You can create new l og fi l es and change the maxi mum si ze of l og

fi l es i n the Log D esti nati on Edi tor.

To Change the Maximum Size of a Log File

1. In the D i agnosti cs and Performance Loggi ng Tool , go to Tools >

Log D estinations.

2. From the Select Log D estination drop-dow n l i st, sel ect the l og
fi l e.

3. In the Max File Size (K B ) fi el d, type the new maxi mum si ze of

the l og fi l e, i n ki l obytes.

If the Kernel XML API c omponent is s elec ted in the D iagnostics

tab, the Max File Size for that file s hould be s et to no lower than
2000 KB.

4. C l i ck Save and C lose.

5 33 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To Create a New Log File

1. In the D i agnosti cs and Performance Loggi ng Tool , from the

Tools menu, sel ect Log D estinations.

2. From the Select Log D estination drop-dow n l i st, sel ect <N ew>.

3. In the File N ame fi el d, type the name of the fi l e. The .l og

extensi on i s automati cal l y appended to thi s fi l e name.

4. In the Max File Size (K B ) fi el d, type the maxi mum si ze of the

new l og fi l e, i n ki l obytes.

5. C l i ck Save and C lose.

Viewin g an d An alyzin g Lo g Files

Al l Mi croStrategy l og fi l es are stored i n the l og fi l e l ocati on. Thi s
l ocati on i s set duri ng i nstal l ati on and cannot be changed.

l On Wi ndow s, al l l og fi l es are stored i n C : \ P r o g r a m F i l e s

(x 86 )\ Co m m o n F i l e s \ M i c r o S t r a t e g y \ L o g \.

l On Li nux, al l l og fi l es are stored i n

/o pt /m st r / M i c r o S t r a t e g y / l o g

These l og fi l es are pl ai n text fi l es and can be vi ew ed w i th any text

edi tor.

The Mi croStrategy Web server error l og fi l es are i n the

Mstr We b/ WE B - I N F / l o g / di rectory. These l og fi l es can be vi ew ed
from the Web Admi ni strator page, by cl i cki ng View Error log on the
l eft si de of the page. For more i nformati on about vi ew i ng l og fi l es i n
Mi croStrategy Web, see the Web Admi ni strator H el p (from the Web
Admi ni strator page, cl i ck H elp).

© 2019, M icr o St r at egy In c. 5 34

Syst em Ad m in ist r at io n Gu id e

Anatomy of a Log File

N on-error messages i n the l og fi l es have the same format. Each entry

has the fol l ow i ng parts:

Date Time [HOST:MACHINE_NAME][SERVER:SERVER_DEFINITAION_

NAME][PID:PROCESS_ID][THR:THREAD_ID][MODULE_NAME][TRACE_
TYPE]message

Se c tion De finition

Dat e Time Dat e and t ime at which t he act ion happened

HOS T The name of t he machine you are running

S E RV E R The server def init ion name

PID Numeric I D of t he process t hat perf ormed t he act ion

THR Numeric I D of t he t hread t hat perf ormed t he act ion

MODULE Name of t he MicroS t rat egy component t hat perf ormed

NA ME t he act ion

t race t ype Type of t he log f ile ent ry

message Message about t he act ion

Error messages in the log files have a similar format, but include the error and the
error code in the log files:

Date Time [HOST:MACHINE_NAME][SERVER:SERVER_DEFINITAION_NAME]

[PID:PROCESS_ID][THR:THREAD_ID][MODULE_NAME][Error][ERROR_CODE]message

Sam p l e Log Fi l e

The fol l ow i ng sampl e i s a si mpl e l og fi l e that w as generated from

Mi croStrategy Web (ASP.N ET) after runni ng the report cal l ed Length
of Empl oyment i n the Mi croStrategy Tutori al proj ect. The bul l eted l i ne
before each entry expl ai ns w hat the l og entry i s recordi ng.

5 35 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

• I nt elligence S erver creat es a report def init ion.

286:[THR:480][02/07/2003::12:24:23:860][DSS ReportServer][Report
Source Tracing]Creating Report(Definition) with Flags=0x1000180
(OSrcCch UptOSrcCch)

• I nt elligence S erver loads t he report def init ion object named Lengt h of
E mployment f rom t he met adat a.

286:[THR:480][02/07/2003::12:24:23:860][DSS ReportServer][Report
Source Tracing] where Definition = Object(Name="Length of Employment"
Type=3(Report Definition) ID=D1AE564911D5C4D04C200E8820504F4F
Proj=B19DEDCC11D4E0EFC000EB9495D0F44F
Ver=493C8E3447909F1FBF75C48E11AB7DEB)

• I nt elligence S erver creat es a report inst ance named Lengt h of E mployment .

286:[THR:480][02/07/2003::12:24:24:931][DSS ReportServer][Report
Source Tracing]Created ReportInstance(Name="Length of Employment"
ExecFlags=0x1000180(OSrcCch UptOSrcCch) ExecActn=0x1000180(RslvCB
LclCch))

• I nt elligence S erver begins execut ing t he report inst ance.

286:[THR:480][02/07/2003::12:24:24:931][DSS ReportServer][Report
Source Tracing]Executing ReportInstance(Name="Length of Employment"
ExecFlags=0x1000180(OSrcCch UptOSrcCch) ExecActn=0x1000180(RslvCB
LclCch)) with Actions=0x8300003f(Rslv GenSQL ExeSQL Alrt XTab EvalVw
LclCch UptLclCch), Flags=0x1000180(OSrcCch UptOSrcCch)

• I nt elligence S erver checks t o see whet her t he report exist s in t he report cache.

286:[THR:480][02/07/2003::12:24:25:181][DSS ReportServer][Report
Source Tracing]Finding in cache: ReportInstance(Name="Length of
Employment" ExecFlags=0x1000180(OSrcCch UptOSrcCch)
ExecActn=0x1000180(RslvCB LclCch))

• I nt elligence S erver did not f ind t he report in t he cache.

286:[THR:480][02/07/2003::12:24:25:342][DSS ReportServer][Report
Source Tracing]Not found in cache: ReportInstance(Name="Length of
Employment" ExecFlags=0x1000180(OSrcCch UptOSrcCch)
ExecActn=0x1000180(RslvCB LclCch))

• I nt elligence S erver checks f or prompt s and f inds none in t he report .

286:[THR:314][02/07/2003::12:24:25:432][DSS ReportServer][Report
Source Tracing]No prompts in ReportInstance(Name="Length of
Employment" ExecFlags=0x1000180(OSrcCch UptOSrcCch)

© 2019, M icr o St r at egy In c. 5 36

Syst em Ad m in ist r at io n Gu id e

ExecActn=0x1000180(RslvCB LclCch))

• I nt elligence S erver execut es t he report and updat es t he caches.

286:[THR:492][02/07/2003::12:24:26:634][DSS ReportServer][Report
Source Tracing]Executing ReportInstance(Job=2 Name="Length of
Employment" ExecFlags=0x1000184(OSrcCch UptOSrcCch)
ExecActn=0x1000184(ExeSQL RslvCB LclCch)) with Actions=0x300003f(Rslv
GenSQL ExeSQL Alrt XTab EvalVw LclCch UptLclCch), Flags=0x1000184
(OSrcCch UptOSrcCch)

More detail is logged for report ex ec ution if the report is run from
Dev eloper.

Working with Exceptions

When Intel l i gence Server encounters an error, i t "throw s an

excepti on." N ot al l excepti ons are fatal ; i n fact Intel l i gence Server
uses some of them i nternal l y. Fatal excepti ons cause Intel l i gence
Server to shut dow n and they are l ogged i n the D S S E r r o r s . l o g,
often as "unknow n excepti ons."

Fatal excepti on messages by themsel ves are not suffi ci ent for
accurate di agnosi s. Intel l i gence Server i ncl udes a bui l t-i n mechani sm
to capture structured excepti ons and generate a dump fi l e that has
more i nformati on i n i t. You may need to do thi s for Mi croStrategy
Techni cal Support speci al i st. For more i nformati on on di agnosi ng
excepti ons i n thi s manner, see Mi croStrategy Tech N ote TN 13130.

An alyzin g a Ser ver St at e Du mp

A server state dump (SSD ) i s a col l ecti on of i nformati on rel ated to the
state of Intel l i gence Server that i s w ri tten to the D S S E r r o r s . l o g fi l e,
usual l y as a resul t of an unexpected shutdow n of Intel l i gence Server.
It provi des i nsi ght i nto w hat w as goi ng on i n Intel l i gence Server w hen
the shutdow n occurred. Thi s i nformati on can be used to hel p
di agnose the cause of the shutdow n and avert subsequent probl ems.

5 37 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Probl ems that tri gger an SSD i ncl ude memory depl eti on (see Memory
D epl eti on Troubl eshooti ng, page 2645) or excepti ons (see Vi ew i ng
and Anal yzi ng Log Fi l es, page 534). C hanges to the server defi ni ti on
tri gger a subset of the SSD i nformati on.

Analyzing a Server State Dump

Each SSD records i nformati on under the same process ID and thread
ID . Thi s i nformati on i ncl udes the server and proj ect confi gurati on
setti ngs, memory usage, schedul e requests, user sessi ons, executi ng
j obs and processi ng uni t states, and so on. The SSD i nformati on i s
broken i nto 14 secti ons, summari zed bel ow .

Sect i on 1: Tr i gger i ng Er r or and Er r or Sp eci f i c Pr eam b l e

Thi s secti on precedes the actual SSD and provi des i nformati on on
w hat tri ggered the SSD , such as memory depl eti on or an unknow n
excepti on error.

Sect i on 2: Ser ver Execut ab l e Ver si on and Bui l d Inf or m at i on

Thi s secti on provi des i nformati on on the Intel l i gence Server

executabl e versi on and bui l d ti me so you can accuratel y i denti fy the
versi on of the Mi croStrategy softw are.

Sect i on 3: Ser ver Def i ni t i on Basi c (Cast or Ser ver Conf i gur at i on
'Pr oj ect ') Inf or m at i on

Thi s secti on provi des a subset of Intel l i gence Server l evel setti ngs as
they are defi ned i n the Intel l i gence Server C onfi gurati on Edi tor (i n
D evel oper, ri ght-cl i ck the proj ect source, and sel ect C onfigure
MicroStrategy Intelligence Server). The setti ngs consi st of:

l Server defi ni ti on name

l Maxi mum j obs per proj ect

© 2019, M icr o St r at egy In c. 5 38

Syst em Ad m in ist r at io n Gu id e

l Maxi mum connecti ons per proj ect

l N umber of proj ects

l C ommuni cati on protocol and port

Work ingSet File Direc tory and Max RAM for Work ingSet Cac he v alues
are not lis ted in an SSD.

Sect i on 4: Pr oj ect / s Basi c Inf or m at i on

Thi s secti on i ncl udes basi c i nformati on rel ated to the state and
confi gurati on of proj ects. Thi s show s setti ngs that are defi ned i n the
Proj ect C onfi gurati on Edi tor, such as:

l Proj ect name

l C ache setti ngs

l Governor setti ngs

l D BR ol e used

l D BC onnecti on setti ngs

Sect i on 5: Ser ver Def i ni t i on Ad vanced Inf or m at i on

Thi s secti on i ncl udes addi ti onal server defi ni ti on setti ngs, such as:

l Thread l oad bal anci ng mode

l Memory throttl i ng

l H i story Li st setti ngs

l Idl e ti meouts

l XML governors

l Memory C ontract Manager (MC M) setti ngs

5 39 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

MCM is des igned to help y ou av oid memory depletions . For more

information on MCM, s ee Governi ng Intel l i gence Server Memory
U se w i th Memory C ontract Manager, page 698 .

Sect i on 6: Cal l st ack, Lockst ack, and Load ed M od ul es

The cal l stack dump provi des i nformati on on the functi ons bei ng used
at the ti me the SSD w as w ri tten. Si mi l arl y, the l ockstack provi des a
l i st of acti ve l ocks. The Modul e i nfo dump provi des a l i st of fi l es that
are l oaded i nto memory by Intel l i gence Server, and thei r l ocati on i n
memory.

Thi s i nformati on can hel p Mi croStrategy Techni cal Support trace

errors to speci fi c areas of functi onal i ty.

Sect i on 7: Ser ver Pr ocess M em or y Snap shot

Thi s secti on contai ns the memory profi l e of the Intel l i gence Server
process and machi ne. If any of these val ues are near thei r l i mi t,
memory may be a cause of the probl em.

Sect i on 8: Pr oj ect St at e Sum m ar y

Thi s secti on provi des a summary of w hether each proj ect i s Loaded
and R egi stered, and the number of users l ogged i n and j obs runni ng
at the ti me of the SSD .

Sect i on 9: Sched ul e Req uest Inf or m at i on

Thi s secti on provi des a l i sti ng of schedul e requests that Intel l i gence
Server i s confi gured for. Thi s l i st i ncl udes:

l R eports

l D ocuments

l Admi ni strati on tasks, such as i dl i ng proj ects and other tasks rel ated
to cache management

© 2019, M icr o St r at egy In c. 5 40

Syst em Ad m in ist r at io n Gu id e

For addi ti onal i nformati on about schedul es and subscri pti ons, see
C hapter 12, Schedul i ng Jobs and Admi ni strati ve Tasks.

Sect i on 10: Dat ab ase Connect i on Snap shot

Thi s secti on di spl ays a snapshot of the state of the database

connecti ons betw een Intel l i gence Server and the metadata and data
w arehouse databases. Thi s i nformati on i s si mi l ar to w hat i s show n i n
the D atabase C onnecti on Moni tor. For more i nformati on about
database connecti ons, see C ommuni cati ng w i th D atabases, page 19.

Sect i on 11: U ser Inb ox Snap shot

The secti on provi des i nformati on on the si ze of vari ous user i nboxes
and i nformati on rel ated to the Worki ngSet.

Sect i on 12: Job s St at us Snap shot

Thi s secti on provi des a snapshot of the j obs that w ere executi ng at
the ti me of the SSD . Thi s i nformati on may be useful to see w hat the
l oad on Intel l i gence Server w as, as w el l as w hat w as executi ng at the
ti me of the error. If the error i s due to a speci fi c report, the i nformati on
here can hel p you reproduce i t.

Sect i on 13: U ser Sessi on Snap shot

Thi s secti on provi des detai l s on the vari ous user sessi ons i n
Intel l i gence Server at the ti me of the SSD .

Sect i on 14: Pr ocessi ng U ni t Thr ead s St at e Snap shot

Thi s secti on provi des i nformati on about the states of the threads i n
each processi ng uni t i n Intel l i gence Server. It al so provi des
i nformati on on the number of threads per Processi ng U ni t and to w hat
pri ori ty they are assi gned.

5 41 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Verifying Reports and Documents with Integrity Manager

Mi croStrategy Integri ty Manager i s an automated compari son tool
desi gned to streaml i ne the testi ng of Mi croStrategy reports and
documents i n proj ects. Thi s tool can determi ne how speci fi c changes
i n a proj ect envi ronment, such as the regul ar mai ntenance changes to
metadata obj ects or hardw are and softw are upgrades, affect the
reports and documents i n that proj ect.

For i nstance, you may w ant to ensure that the changes i nvol ved i n
movi ng your proj ect from a devel opment envi ronment i nto producti on
do not al ter any of your reports. Integri ty Manager can compare
reports i n the devel opment and the producti on proj ects, and hi ghl i ght
any di fferences. Thi s can assi st you i n tracki ng dow n di screpanci es
betw een the tw o proj ects.

You can use Integri ty Manager to execute reports or documents from a

si ngl e Mi croStrategy proj ect to confi rm that they remai n operati onal
after changes to the system. Integri ty Manager can execute any or al l
reports from the proj ect, note w hether those reports execute, and
show you the resul ts of each report.

Integri ty Manager can al so test the performance of an Intel l i gence

Server by recordi ng how l ong i t takes to execute a gi ven report or
document. You can execute the reports or documents mul ti pl e ti mes
i n the same test and record the ti me for each executi on cycl e, to get a
better i dea of the average Intel l i gence Server performance ti me. For
more i nformati on about performance tests, see Testi ng Intel l i gence
Server Performance, page 1272.

For reports you can test and compare the SQL, gri d data, graph,
Excel , or PD F output. For documents you can test and compare the
Excel or PD F output, or test w hether the documents execute properl y.
If you choose not to test and compare the Excel or PD F output, no
output i s generated for the documents. Integri ty Manager sti l l reports

© 2019, M icr o St r at egy In c. 5 42

Syst em Ad m in ist r at io n Gu id e

w hether the documents executed successful l y and how l ong i t took

them to execute.

l To ex ec ute an integrity tes t on a projec t, y ou mus t hav e the Us e

Integrity Manager priv ilege for that projec t.

l Integrity Manager c an only tes t projec ts in Serv er (three-tier) mode.

Projec ts in Direc t Connec tion (two-tier) mode c annot be tes ted with
this tool.

l To tes t the Ex c el ex port of a report or doc ument, y ou mus t hav e

Mic ros oft Ex c el ins talled on the mac hine running Integrity Manager.

Thi s secti on descri bes how to use Integri ty Manager to vi ew and

compare reports and documents. Topi cs i ncl ude:

l What i s an Integri ty Test?, page 1269

l Best Practi ces for U si ng Integri ty Manager, page 1274

l C reati ng an Integri ty Test, page 1276

l Executi ng an Integri ty Test, page 1280

l Vi ew i ng the R esul ts of a Test, page 1295

l Li st of Tags i n the Integri ty Test Fi l e, page 1303

Enterprise Manager
Mi croStrategy Enterpri se Manager hel ps you anal yze Intel l i gence
Server stati sti cs. Enterpri se Manager provi des a prebui l t
Mi croStrategy proj ect w i th more than a hundred reports and dossi ers
coveri ng al l aspects of Intel l i gence Server operati on. You can al so
use Enterpri se Manager's prebui l t facts and attri butes to create your
ow n reports so you can have i mmedi ate access to the performance
and system usage i nformati on.

For steps on setti ng up Enterpri se Manager and usi ng the reports i n i t,

see the .Enterpri se Manager Gui de.

5 43 © 2019, M icr o St r at egy In c.

 8
TUNING YOUR SYSTEM
FOR B EST PERFORM ANCE

© 2019, M icr o St r at egy In c. 5 44

Syst em Ad m in ist r at io n Gu id e

Tuni ng a Mi croStrategy system i s not an exact sci ence. Because your

system resources, appl i cati on performance, and user requi rements
and expectati ons are uni que, i t i s not possi bl e for Mi croStrategy to
i ncl ude an exact methodol ogy or set of recommendati ons for
opti mi zati on.

One of your most i mportant j obs as a Mi croStrategy system

admi ni strator i s to fi nd the bal ance that maxi mi zes the use of your
system's capaci ty to provi de the best performance possi bl e for the
requi red number of users. Thi s secti on di scusses how to anal yze your
users' requi rements, and the w ays you can confi gure and tune your
system to meet those requi rements.

The topi cs covered i n thi s secti on i ncl ude:

l Tuni ng: Overvi ew and Best Practi ces, page 546

l D esi gni ng System Archi tecture, page 685

l Managi ng System R esources, page 691

l Managi ng U ser Sessi ons, page 711

l Governi ng R equests, page 722

l Managi ng Job Executi on, page 731

l Governi ng R esul ts D el i very, page 748

l Tuni ng Your System for In-Memory D atasets

l D esi gni ng R eports, page 757

l C onfi guri ng Intel l i gence Server and Proj ects, page 760

l Tuni ng N arrow cast Server and Intel l i gence Server, page 783

5 45 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Tuning: Overview and Best Practices

To get the best performance out of your Mi croStrategy system, you
must be fami l i ar w i th the characteri sti cs of your system and how i t
performs under di fferent condi ti ons. In addi ti on to thi s, you need a
pl an for tuni ng the system. For exampl e, you shoul d have a base
record of certai n key confi gurati on setti ngs and performance
measures, such as Enterpri se Manager reports or di agnosti cs l ogs,
before you begi n experi menti ng w i th those setti ngs. Make one change
at a ti me and test the system performance. C ompare the new
performance to the base and see i f i t i mproved. If i t di d not i mprove,
change the setti ng back to i ts previ ous val ue. Thi s w ay, w hen system
performance i mproves, you know w hi ch change i s responsi bl e.

The speci fi cati ons of the machi nes that you use to run Intel l i gence
Server, how you tune those machi nes, and how they are used depend
on the number of users, number of concurrentl y acti ve users, thei r
usage patterns, and so on. Mi croStrategy provi des up-to-date
recommendati ons for these areas on the Mi croStrategy Know l edge
Base.

As a hi gh-l evel overvi ew of tuni ng the system, you shoul d fi rst defi ne
your system requi rements, and then confi gure the system's desi gn
usi ng those requi rements. The fol l ow i ng topi cs l ay the foundati on for
the speci fi c tuni ng gui del i nes that make up the rest of thi s secti on.

l D efi ni ng the System R equi rements, page 546

l C onfi guri ng the System D esi gn, page 547

l Best Practi ces for Tuni ng your System, page 682

Defining the System Requirements

You most l i kel y have certai n expectati ons or requi rements that the
system must meet for i t to be consi dered a success. For exampl e, you
may have a set of requi rements si mi l ar to one of these scenari os:

© 2019, M icr o St r at egy In c. 5 46

Syst em Ad m in ist r at io n Gu id e

l Gl obal Web-based depl oyment for 400 users w i th 15-second

response ti me for prompted reports and the abi l i ty to subscri be to
personal i zed w eekl y sal es reports.

l Internal depl oyment for 200 market research anal ysts accessi ng an
enterpri se data w arehouse on a compl etel y ad hoc basi s.

l Web-based depl oyment for 1,500 remote users w i th access to pre-

defi ned dai l y sal es and i nventory reports w i th 5-second response
ti me.

These scenari os share common requi rements that can hel p you defi ne
your ow n expectati ons for the system, such as the fol l ow i ng:

l You may requi re that the system be abl e to handl e a certai n

number of concurrent users l ogged i n, or a certai n number of
active users runni ng reports and otherw i se i nteracti ng w i th the
system.

l You may requi re a certai n level of performance, such as report

resul ts returni ng to the users w i thi n a certai n ti me, or that the
resul ts of report mani pul ati on happen qui ckl y, or that a certai n
number of reports can be run w i thi n an hour or w i thi n a day.

l You may requi re that users have access to certai n features, such
as schedul i ng a report for l ater executi on, or sendi ng a report to
someone el se vi a emai l , or that your users w i l l be abl e to access
thei r reports onl i ne through Mi croStrategy Web.

l You may requi re that certai n functionality be avai l abl e i n the

system, such as al l ow i ng report fl exi bi l i ty so users can run ad hoc,
predefi ned, prompted, page-by, or Intel l i gent C ube reports.

Configuring the System Design

It i s i mportant to understand that the Mi croStrategy busi ness
i ntel l i gence system has a l i mi ted capaci ty. It cannot serve an
unl i mi ted number of users and process an unl i mi ted number of j obs i n

5 47 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

a short ti me. Thi s capaci ty can be thought of as a box shared by the

tw o i mportant goal s of servi ng the necessary number of user sessi ons
(through w hi ch users submit requests) and maxi mi zi ng the number of
j obs executed (w hi ch return results).

The l i mi ts that the system encounters may be Intel l i gence Server

machi ne capaci ty, the data w arehouse's throughput capaci ty, or the
netw ork's capaci ty.

The mai n factors that affect the system's capaci ty are:

l The system resources avai l abl e (i ncl udi ng memory)

l The architecture of the system and netw ork

l The design of the reports that are executed

l The configuration of Intelligence Server and projects to

determi ne how system resources can be used

The di agram bel ow i l l ustrates these factors that i nfl uence the
system's capaci ty.

UNIX and Linux s y s tems allow proc es s es and applic ations to run in a
v irtual env ironment. Intelligenc e Serv er Univ ers al ins talls on UNIX and
Linux s y s tems with the required env ironment v ariables s et to ens ure
that the s erv er's jobs are proc es s ed c orrec tly . Howev er, y ou c an tune
thes e s y s tem s ettings to fit y our s y s tem requirements and improv e

© 2019, M icr o St r at egy In c. 5 48

Syst em Ad m in ist r at io n Gu id e

performanc e. For more information, s ee the Pl anni ng Your

Instal l ati on s ec tion of the Instal l ati on and C onfi gurati on Gui de .

Co n f igu r in g Ru n -Time Cap acit y Var iab les

R un-ti me capaci ty vari abl es are factors that i nfl uence performance
and capaci ty after Intel l i gence Server has started. The tw o run-ti me
capaci ty vari abl es are user sessi ons (see Managi ng U ser Sessi ons,
page 711) and executi ng j obs (see Managi ng Job Executi on, page
731).

These runti me capaci ty vari abl es are i nterrel ated w i th system

capaci ty. If you change setti ngs i n one, the others are affected. For
exampl e, i f you pl ace more emphasi s on servi ng more user sessi ons,
the j ob executi on may suffer because i t does not have as much of the
system capaci ty avai l abl e to use. Or, for exampl e, i f you i ncrease
Intel l i gence Server's capaci ty, i t coul d execute j obs more qui ckl y or i t
coul d serve more user sessi ons.

Accessin g t h e Syst em Co n f igu r at io n Ed it o r s

Many of the opti ons i n the fol l ow i ng secti ons are speci fi ed i n the
Intel l i gence Server C onfi gurati on Edi tor or the Proj ect C onfi gurati on
Edi tor.

You mus t hav e the Configure Gov erning priv ilege for the projec t or projec t
s ourc e.

You mus t hav e Configuration permis s ions for the s erv er objec t. In addition,
to ac c es s the Projec t Configuration Editor y ou mus t hav e Write permis s ion
for the projec t objec t. For more information about s erv er objec t
permis s ions , s ee Permi ssi ons for Server Governi ng and
C onfi gurati on, page 102 .

5 49 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To Access the Intelligence Server Configuration Editor

1. In D evel oper, l og i n to a proj ect source.

2. Go to A dministration > Server > C onfigure MicroStrategy

Intelligence Server.

See Intel l i gence Server C onfi gurati on D efaul t Setti ngs for
more information about the default s ettings for Intelligenc e Serv er.

To Access the Project Configuration Editor for a Project

1. In D evel oper, l og i n to a proj ect source.

2. Expand the proj ect that you w ant to confi gure.

3. Go to A dministration > Projects > Project C onfiguration.

See Proj ect C onfi gurati on D efaul t Setti ngs for more
information about the default s ettings for projec ts .

Intelligence Server Configuration Default Settings

The defaul t Intel l i gence Server confi gurati on setti ngs, defi ned i n the
Intel l i gence Server C onfi gurati on Edi tor, are provi ded bel ow .

To ac c es s the Intelligenc e Serv er Configuration Editor in Dev eloper,

right-c lic k the Intelligenc e Serv er and s elec t C onfigure
MicroStrategy Intelligence Server .

© 2019, M icr o St r at egy In c. 550

Syst em Ad m in ist r at io n Gu id e

Ser ver Def in it io n - Gen er al

Defau lt
Settin g Descrip tio n
Valu e

E nt er a descript ion f or t he server

Descript ion E mpt y
def init ion.

Client -S erver Number of E nt er t he number of net work

5
Communicat ions net work t hreads t hreads.

S et
Click Modify t o open t he P ropert ies
Conf igurat ion
P ropert ies dialog box t o ent er a S erver E mpt y
object
Def init ion.
propert ies

Cont ent S erver Dat abase

S elect a dat abase inst ance < None>
Locat ion I nst ance

Ser ver Def in it io n - Secu r it y

Defau lt
Settin g Descrip tio n
Valu e

S pecif ies t he number of f ailed login

at t empt s allowed. Once a user has
t his many f ailed login at t empt s in a
Lock af t er row, t he user is locked out of t he
A ccount Lock
(f ailed MicroS t rat egy account unt il an -1
P olicy
at t empt s) administ rat or unlocks t he account .
S et t ing t his value t o -1 indicat es
t hat users are never locked out of
t heir account s.

The number of each user's previous

Number of
P assword passwords t hat I nt elligence S erver
past password 0
P olicy st ores in memory. I nt elligence
remembered
S erver prevent s users f rom using a

551 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

password t hat is ident ical t o one

t hey have previously used. This
opt ion must be great er t han 0 t o
enable t he ot her opt ions.

Do not allow When t his opt ion is select ed,

user login and I nt elligence S erver ensures t hat new
Unchecked
f ull name in passwords do not cont ain t he user's
password login or part of t he user's name.

Do not allow
When t his opt ion is select ed,
rot at ing
I nt elligence S erver prevent s users
charact ers Unchecked
f rom using a password t hat is
f rom last
backwards f rom t he old password.
password

Minimum The minimum password lengt h. This

number of opt ion must be great er t han zero t o 0
charact ers enable t he ot her opt ions.

Minimum The minimum number of upper case

upper case (A -Z) charact ers t hat mist be present 0
charact ers in users' passwords.

Minimum The minimum number of lower case

lower case (a-z) charact ers t hat mist be present 0
E nf orce
charact ers in users' passwords.
P assword
Complexit y Minimum The minimum number of numeric (0-
numeric 9) charact ers t hat mist be present in 0
charact ers users' passwords.

The minimum number of non-

Minimum
alphanumeric (symbol) charact ers
special 0
t hat mist be present in users'
charact ers
passwords.

Minimum The minimum number of charact er 0

© 2019, M icr o St r at egy In c. 552

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

number of
charact er changes.
changes

Updat e pass-
t hrough
S elect t his checkbox t o updat e t he
credent ials
user's dat abase or LDA P credent ials Checked
when a
on a successf ul MicroS t rat egy login.
successf ul
login occurs

Dat abase S elect t o use dat abase

S elect ed
A ut hent icat ion aut hent icat ion
A ut hent icat ion
P olicy LDA P
S elect t o use LDA P aut hent icat ion Unselect ed
A ut hent icat ion

Use
Check t his checkbox t o use a public
P ublic/ P rivat e
or privat e key t o sign or verif y a
K ey t o Unchecked
t oken. This requires t he set up of a
S ign/ V erif y
public or privat e key.
Token

Token
The lif et ime, in minut es, of t he
Lif et ime 1440
t oken.
(Minut es)

E ncrypt ion Hash S elect t he number of hashing

10, 000
Level I t erat ions it erat ions.

Ser ver Def in it io n - Ch an ge Jo u r n alin g

Defau lt
Settin g Descrip tio n
Valu e

Conf igure E nable S t art ing wit h V ersion 10. 8, Change Journaling Checked

553 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

Change Change is permanent ly enabled. A dminist rat ors can

Journaling Journaling manage f ile size purging as needed.

I n t he P urge all dat a logged bef ore f ields, ent er

a dat e and t ime. A ll change journal dat a logged
bef ore t his dat e and t ime is purged when you
click P urge Now.
P urge all Current
dat a Dat e
I n t he Dat e f ield, ent er t he dat e. Y ou can also
logged and
click t he drop-down list and select a dat e f rom
bef ore Time
P urge t he calendar. To change t he mont h in t he

Change calendar, click t he < or > arrows.

Journal
I n t he Time f ield, ent er t he t ime.

E nt er t he t imeout set t ing. This is t he lengt h of

t ime I nt elligence S erver wait s f or a response
P urge
when it issues a purge command t o t he change
t imeout 600
journal. I f t here is no response by t he t ime t he
(seconds)
t imeout has elapsed, t he purge command is
cancelled.

Ser ver Def in it io n - Ad van ced

Defau lt
Settin g Descrip tio n
Valu e

B ackup f requency (minut es): cont rols

t he f requency (in minut es) at which
B ackup cache, Hist ory List messages, and
S et t ings f requency I nt elligent Cubes are backed up t o disk. 0
(minut es) A value of 0 means t hat cache, Hist ory
List messages, and I nt elligent Cubes
are backed up immediat ely af t er t hey

© 2019, M icr o St r at egy In c. 554

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

are creat ed.

555 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

B alance MicroS t rat egy S erver t hreads:

cont rols whet her t hreads wit hin t he
B alance I nt elligence S erver are allocat ed t o
MicroS t rat egy processes such as object serving,
Unchecked
S erver element serving, S QL generat ion, and
t hreads so f ort h t hat need t hem most , while less
loaded ones can ret urn t hreads t o t he
available pool.

Cache lookup cleanup f requency (sec):

Cache lookup cleans up t he cache lookup t able at t he
cleanup specif ied f requency (in seconds). This
0
f requency reduces t he amount of memory it
(seconds) consumes and t he t ime it t akes t o back
up t he lookup t able t o disk.

P roject f ailover lat ency (min): in a

clust ered syst em, cont rols t he delay
bet ween one server f ailing and it s
project s being loaded ont o ot her
P roject
servers. A high lat ency period allows
f ailover
more t ime f or t he server t o come back 30
lat ency
online bef ore project s are loaded ont o
(minut es)
ot her servers; a low lat ency period can
provide less downt ime in t he event of a
server f ailure, but higher load on t he
servers while t he project s are loading.

Conf igurat ion recovery lat ency (min): in

a clust ered syst em, cont rols t he amount
Conf igurat ion of t ime bef ore t he syst em revert s t o it s
recovery original conf igurat ion when a server has
-1
lat ency f ailed and t hen come back online. A
(minut es) high lat ency period allows more t ime t o
be cert ain t he server is permanent ly
online; a low lat ency period reduces t he

© 2019, M icr o St r at egy In c. 556

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

st rain on t he ot her machines in t he

clust er f ast er.

Time t o run license check (24 hr

Time t o run
f ormat ): set s t he specif ic t ime at which
license check 23: 59
I nt elligence S erver checks licenses
(24 hr f ormat )
daily.

I nclude LDA P S elect t his opt ion t o include LDA P

Unchecked
Users users in t he license check.

User A f f init y Clust er: in a clust ered

syst em, causes I nt elligence S erver t o
connect all sessions f or a given user t o
t he same node of t he clust er. This
improves perf ormance by reducing t he
resources necessary f or t he user's
Hist ory List .

User A f f init y I f t he User A f f init y Clust er checkbox is

Unchecked
Clust er select ed, S ubscript ion load balancing
causes I nt elligence S erver t o load-
balance subscript ions across all nodes
of t he clust er. One subscript ion job is
creat ed f or each user or user group in
t he subscript ion. I f User A and User
Group G are subscribed t o a dossier, t he
subscript ion creat es one job f or User A ,
and a second job f or User Group G.

S elect t o enable subscript ion load

balancing. I f S ubscript ion Load
S ubscript ion B alancing is enabled in a t wo-node
Load clust er, t he subscript ion f or User A Unchecked
B alancing would execut e on one node, and t he
subscript ion f or user Group G would
execut e on t he ot her node.

557 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

Use MicroS t rat egy S cheduler enables

t he scheduling f eat ures in t he
Use
MicroS t rat egy environment . I f t his
MicroS t rat egy Checked
checkbox is cleared, neit her t he report s
S cheduler
nor administ rat ion t asks can be
S cheduler scheduled.

S cheduler session t ime out (sec)

S cheduler
cont rols how long t he S cheduler
S ession 300
at t empt s t o communicat e wit h
Timeout (sec)
I nt elligence S erver bef ore t iming out .

E nable perf ormance monit oring enables

I nt elligence S erver logging in t o
Microsof t Windows P erf ormance
Monit or. S elect t his checkbox t o be able
E nable
P erf ormance t o add count ers t o t he P erf ormance
P erf ormance Checked
Monit oring Monit or specif ically f or MicroS t rat egy
Monit oring
S erver Jobs and MicroS t rat egy S erver
Users. I f you clear t he checkbox you
cannot select t hese opt ions wit hin t he
P erf ormance Monit or.

St at ist ics - Gen er al

Defau lt
Settin g Descrip tio n
Valu e

Complet e Dif f erent project s log st at ist ics t o dif f erent

S ession dat abases. This ensures complet e dat a f or all S elect ed
S erver Logging t hese project s.
Level
S ession S ingle S t at ist ics f or all project s on t his I nt elligence
S t at ist ics I nst ance S erver are logged t o a single dat abase. From
Unselect ed
S ession t he drop-down list , select t he project name
Logging whose dat abase you want t o log st at ist ics t o.

© 2019, M icr o St r at egy In c. 558

Syst em Ad m in ist r at io n Gu id e

St at ist ics - Pu r ge

Defau lt
Settin g Descrip tio n
Valu e

Today
minus
S elect S elect t he dat e range wit hin which you want t he
From/ To one
dat es purge operat ion t o be perf ormed.
year/
Today

P urge t imeout (sec. ): S pecif y a t imeout set t ing in

seconds; t he server uses t his set t ing during t he purge
P urge t imeout operat ion. The server issues a single S QL st at ement
10
(sec) t o purge each st at ist ics t able, and t he t imeout set t ing
applies t o each individual S QL st at ement issued
during t he purge operat ion.

Go ver n in g Ru les - Def au lt - Gen er al

Defau lt
Settin g Descrip tio n
Valu e

Maximum number of jobs: Limit s t he

number of concurrent jobs t hat may exist
on t his I nt elligence S erver. Concurrent
jobs include report , element , and
aut oprompt request s t hat are execut ing 10, 000

Maximum or wait ing t o execut e. Finished (open)

number of jobs, cached jobs, or jobs t hat ret urned

jobs errors are not count ed. A value of -1

indicat es no limit .

Maximum Maximum number of int eract ive jobs:

number of Limit s t he number of concurrent
-1
int eract ive int eract ive (non-scheduled) jobs t hat may
jobs exist on t his I nt elligence S erver. A value

559 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

of -1 indicat es no limit .

Maximum number of scheduled jobs:

Maximum
Limit s t he number of concurrent
number of
scheduled jobs t hat may exist on t his -1
scheduled
I nt elligence S erver. A value of -1
jobs
indicat es no limit .

Maximum number of user sessions:

Limit s t he number of user sessions
(connect ions) f or an I nt elligence S erver.
A single user account may est ablish
mult iple sessions t o an I nt elligence
S erver. E ach session connect s once t o
t he I nt elligence S erver and once f or each
Maximum number of user
project t he user accesses. P roject 320
sessions
sessions are governed separat ely wit h a
project level set t ing. When t he maximum
number of user sessions is reached, users
cannot log in, except f or t he
administ rat or, who may wish t o
disconnect current users or increase t he
governing set t ing.

User session idle t ime (sec): Limit s t he

t ime, in seconds, t hat Developer users
User session idle t ime (sec) can remain idle bef ore t heir Developer 1800
session is ended. A value of -1 indicat es
no limit .

Web user session idle t ime (sec): Limit s

Web user session idle t ime t he t ime, in seconds, t hat Web users can
600
(sec) remain idle bef ore t heir Web session is
ended. A value of -1 indicat es no limit .

Mobile A P NS and GCM Limit s t he t ime, in seconds, t hat mobile

1800
session idle t ime (sec) client connect ions remain open t o

© 2019, M icr o St r at egy In c. 5 60

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

download Newsst and subscript ions. A

value of -1 indicat es no limit .

I f t his opt ion is select ed, report s

execut ed as part of a Report S ervices
For I nt elligence S erver job Document are not count ed against t he
Unchecked
and hist ory list . . . server-level job limit s above and t he
project -level job limit s set in t he P roject
Conf igurat ion E dit or.

E nable background execut ion of

document s af t er t heir caches are hit : I f
t his opt ion is select ed, when a document
cache is hit , I nt elligence S erver displays
E nable
t he cached document and re-execut es
B ackground background
t he document in t he background. I f t his Unchecked
E xecut ion execut ion of
opt ion is cleared, when a document
document s. . .
cache is hit , I nt elligence S erver displays
t he cached document and does not re-
execut e t he document unt il a
manipulat ion is perf ormed.

Go ver n in g Ru les - Def au lt - File Gen er at io n

Defau lt
Settin g Descrip tio n
Valu e

Limit s t he size of report s (rows x columns)

when t hey are execut ed f rom MicroS t rat egy
Maximum Web. When t his limit is met , increment al
X ML
number of f et ch is used. Not e t hat t his set t ing does not 500, 000
Generat ion
X ML cells af f ect report s execut ed f rom Developer.
However, if t he report is part of an HTML
document , t hen when t his HTML document is

5 61 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

execut ed f rom eit her Web or Developer, t he

report is cut of f , and t here is no increment al
f et ch. The maximum value t hat you can
specif y is 9999999.

Limit s t he number of at t ribut es t o which

users can drill in MicroS t rat egy Web.
A t t ribut es are displayed under t he hierarchy
t o which t hey belong, and hierarchies are
Maximum displayed in alphabet ical order by t he name
number of of t he hierarchy. I f t his set t ing is set t o a low
100
X ML drill number, t he available drill at t ribut es may not
pat hs all be displayed t o t he user. However, if it is
set t oo high, perf ormance may be af f ect ed
because report s will consume more memory.
The maximum value t hat you can specif y is
3000.

Maximum Limit s t he memory consumpt ion f or X ML

memory f iles. S et t he limit according t o t he size
consumpt ion expect ed of t he X ML document s t o be 512
f or X ML generat ed t o avoid memory-relat ed errors.
(MB ) The maximum value is 2047 MB .

Maximum Limit s t he memory consumpt ion f or P DF

memory f iles. S et t he limit according t o t he expect ed
P DF
consumpt ion size of t he P DF document s t o be generat ed 512
Generat ion
f or P DF f iles t o avoid memory-relat ed errors. The
(MB ) maximum value is 2047 MB .

Limit s t he memory consumpt ion f or E xcel

Maximum
f iles generat ed f rom MicroS t rat egy Web. S et
memory
E xcel t he limit according t o t he expect ed size of
consumpt ion 512
Generat ion t he E xcel document s t o be generat ed t o
f or E xcel
avoid memory-relat ed errors. The maximum
f iles (MB )
value is 2047 MB .

© 2019, M icr o St r at egy In c. 5 62

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

Maximum Limit s t he memory consumpt ion f or HTML

memory f iles. S et t he limit according t o t he expect ed
HTML
consumpt ion size of t he HTML document s t o be generat ed 512
Generat ion
f or HTML t o avoid memory-relat ed errors. The
f iles (MB ) maximum value is 2047 MB .

Go ver n in g Ru les - Def au lt - Memo r y Set t in gs

Defau lt
Settin g Descrip tio n
Valu e

Job t hrot t ling af f ect s MicroS t rat egy Web

request s only. I f eit her of t he f ollowing
condit ions is met , all MicroS t rat egy Web
request s of any nat ure (login, report Checked
execut ion, search, and f older browsing)
are denied unt il t he condit ions are
resolved.

Maximum
S et s t he maximum amount of t ot al syst em
E nable Web I nt elligence
memory (RA M + P age File) t hat t he
request job S erver use
I nt elligence S erver process can use 97
t hrot t ling of t ot al
compared t o t he t ot al amount of memory
memory
on t he machine.
(% )

Minimum
machine This set s t he minimum amount of RA M
f ree t hat must be available compared t o t he
0
physical t ot al amount of physical memory on t he
memory machine.
(% )

S elect t o specif y how much memory can

E nable Unchecked
be reserved f or a single I nt elligence

5 63 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

S erver operat ion at a t ime.

E ach memory request is compared t o t he

value in t his f ield. I f t he request exceeds
t his limit , t he request is denied.

single E xample: I f t he allocat ion limit is set t o

memory Maximum 100 MB and a request is made f or 120
allocat ion single MB , t he request is denied, but a lat er
20
governing allocat ion request f or 95 MB is allowed.
size (MB )
E ach request is handled independent ly of
ot her request s and is resolved in t he order
it is received. The maximum value allowed
f or t he Maximum single allocat ion size
(MB yt es) set t ing is 2047 MB .

E nable t he use of t he Memory Cont ract

Manager, an I nt elligence S erver
Checked
component t hat is cont rolled by t he
f ollowing set t ings.

S pecif y t he amount of memory (in MB )

t hat cannot be used by I nt elligence
Minimum
S erver. This may be usef ul if t he machine
reserved
E nable is also used t o run sof t ware f rom ot her 0
memory
memory part ies and is not solely dedicat ed t o
(MB )
cont ract I nt elligence S erver. The maximum value
management allowed f or t his set t ing is 10239 MB .

S pecif y t he amount of memory (in MB )

t hat cannot be used by I nt elligence
Minimum
S erver. This may be usef ul if t he machine
reserved
is also used t o run sof t ware f rom ot her 10
memory
part ies and is not solely dedicat ed t o
(% )
I nt elligence S erver. The maximum value
allowed f or t his set t ing is 10239 MB . .

© 2019, M icr o St r at egy In c. 5 64

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

I f t he I nt elligence S erver machine uses a

32-bit operat ing syst em, specif y t he
Maximum
maximum amount of t he virt ual address
use of
space t hat I nt elligence S erver can use, as
virt ual 90
a percent age of t he t ot al virt ual address
address
space. Memory request s t hat would cause
space (% )
I nt elligence S erver t o exceed t his limit are
denied.

The amount of t ime I nt elligence S erver

denies request s while operat ing in memory
request idle mode. Memory request idle
Memory mode is enabled by t he Memory Cont ract
request idle Manager when a memory request would 300
t ime (sec) cause I nt elligence S erver t o exceed t he
Maximum use of virt ual address space
set t ing, based on current memory
ut ilizat ion and cont ract s.

S pecif ies t he size of t he pool of memory

Maximum (in megabyt es) allocat ed f or creat ing and
Temporary RA M f or init ially st oring report s in t he working set .
S t orage Working This is also t he size of t he largest working 2048
S et t ings S et cache set t hat can be creat ed. For 32-bit
(MB ) operat ing syst ems, t he maximum value is
2048 megabyt es (2 gigabyt es).

Go ver n in g Ru les - Def au lt - Temp o r ar y St o r age Set t in gs

Settin g Descrip tio n Defau lt Valu e

Temporary Working S pecif ies t he locat ion where t he

S t orage S et f ile user's act ive working set s are writ t en . \ TmpP ool
S et t ings direct ory t o disk if t hey have been f orced out of

5 65 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Settin g Descrip tio n Defau lt Valu e

t he pool of memory allocat ed f or t he

Maximum RA M f or working set cache.

S ession
Recovery
and . \ I nbox\ S E RV E R_
S pecif ies where t he session
Def erred DE FI NI TI ON_
inf ormat ion is writ t en t o disk.
I nbox NA ME \
st orage
direct ory
S ession
Recovery E nable
S elect t his checkbox t o allow users t o
and Web User
recover t he report , document , or
Def erred S ession Checked
dossier t hey were on when t heir
I nbox Recovery
session ended.
on Logout

S ession
How many hours a session backup can
Recovery
remain on disk bef ore it is considered
backup 168
expired. A f t er it is expired, t he user
expirat ion
cannot recover t he session.
(hrs)

© 2019, M icr o St r at egy In c. 5 66

Syst em Ad m in ist r at io n Gu id e

Go ver n in g Ru les - Def au lt - Imp o r t Dat a

Defau lt
Settin g Descrip tio n
Valu e

I f you have an OLA P S ervices license, you can

import dat a f rom sources such as E xcel
spreadsheet s int o your MicroS t rat egy syst em.
High This dat a is made available in I nt elligent Cubes 1
and can be used in report s and document s. S ee
t he Projec t D es ign Guide f or more inf ormat ion
about import ing dat a f rom ot her f ile or dat abase
sources.

A connect ion t hread is assigned t o each import

dat a job. These connect ion t hreads are assigned
Number of
f rom a pool of t hreads of high, medium, and low
connect ions Medium 1
priorit y. Y ou can conf igure t he number of t hreads
by priorit y
of each priorit y t hat are available f or import ing
dat a in t he I mport Dat a sect ion of t he
I nt elligence S erver Conf igurat ion E dit or. For
more inf ormat ion about how I nt elligence S erver
det ermines what jobs are high, medium, or low
priorit y, see Creat ing job priorit izat ions.

Low I n t his cat egory, you can specif y t he maximum 20

number of high, medium, and low priorit y
connect ion t hreads t hat are used t o import dat a
int o t he dat a warehouse.

Go ver n in g Ru les - Def au lt - Cat alo g Cach e

Defau lt
Settin g Descrip tio n
Valu e

E nable Maximum Checked

The Cat alog cache is a cache f or t he cat alog f or t he
cat alog use of
dat a warehouse dat abase. When t he Cat alog cache
cache memory 25

5 67 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

is enabled, t he client can ret rieve t he dat a

warehouse cat alog direct ly f rom I nt elligence S erver
memory, inst ead of execut ing cat alog S QL. This
can signif icant ly speed up ret rieval of t he dat a
warehouse cat alog.

The Cat alog cache is used during dat a import , and

when using Query B uilder in MicroS t rat egy Web.

(MB ) The Cat alog cache subcat egory has t he f ollowing

set t ings:

E nable cat alog cache: S elect t his checkbox t o

enable t he cat alog cache, or clear it t o disable t he
cat alog cache.

Maximum use of memory (MB ): Limit s t he

maximum amount of memory, in megabyt es, used
by t he cat alog cache.

Pr o ject s - Gen er al

Defau lt
Settin g Descrip tio n
Valu e

A t able of project s indicat ing whet her your server and

P roject Name Checked
environment are select ed.

When select ed, t his allows you t o display only t hose

S how select ed project s t hat have been assigned t o be loaded on a
Unchecked
project s only node. For display purposes it f ilt ers out project s t hat
are not loaded on any server in t he clust er.

When select ed, t his immediat ely applies your

A pply st art up changes across t he clust er. I f cleared, any changes
conf igurat ion you made are saved when you click OK , but are not Checked
on save put int o ef f ect unt il t he I nt elligence S erver is
rest art ed.

© 2019, M icr o St r at egy In c. 5 68

Syst em Ad m in ist r at io n Gu id e

Clu st er in g - Gen er al

Defau lt
Settin g Descrip tio n
Valu e

S erver The Clust ering cat egory displays t he names of all t he

servers t hat are available in a clust ered environment . Y ou Unchecked
Name
can select mult iple servers t o f orm t he clust er during a
Load manual rest art of t he MicroS t rat egy I nt elligence S erver.
B alance S ee C lus tering Multiple Mic roStrategy Serv ers t opic f or 1
Fact or more inf ormat ion about clust ering.

LDAP - Ser ver

Defau lt
Settin g Descrip tio n
Valu e

Host (S erver The host name or t he I P address of

Name or I P t he LDA P server. This is a required E mpt y
A ddress) f ield.

P ort number of t he LDA P server. P ort

389 is t he def ault f or t he clear t ext
LDA P , and P ort 636 is t he def ault f or
S S L. However, your LDA P
P ort administ rat or may have set t he LDA P 389
LDA P S erver port t o a dif f erent number t han t he
S et t ings def ault ; always conf irm t he accurat e
port number wit h your LDA P
administ rat or.

Clear t ext
(not Clear t ext is not encrypt ed S elect ed
encrypt ed)

SSL
S elect t o encrypt S S L. Unselect ed
(encrypt ed)

5 69 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

I f select S S L (encrypt ed), select t he

server cert if icat e f ile. The cert if icat e
S erver inf ormat ion required f or t he server
cert if icat e cert if icat e f ile f ield depends on t he E mpt y
f ile LDA P server vendor (product ) being
used, since t he cert if icat e comes f rom
t he LDA P server.

Wit h connect ion pooling, you can

reuse an open connect ion t o t he LDA P
server f or subsequent operat ions. The
connect ion t o t he LDA P server
Use remains open even when t he
connect ion connect ion is not processing any Unchecked
pooling operat ions. This set t ing can improve
perf ormance by removing t he
processing t ime required t o open and
close a connect ion t o t he LDA P server
f or each operat ion.

MicroS t rat egy uses aut hent icat ion

binding t o aut hent icat e users on user
name, password, and several ot her
B inding account rest rict ions. A ccount S elect ed
rest rict ions include whet her t he
account is locked, expired, disabled,
or ident if ied as an int ruder.

P assword MicroS t rat egy aut hent icat es users on

Unselect ed
comparison user name and password only.

The dist inguished name f or t he

Dist inguished
t rust ed LDA P A ut hent icat ion User E mpt y
A ut hent icat ion name (DN)
who searches t he LDA P reposit ory.
User
P assword f or t he LDA P
P assword E mpt y
A ut hent icat ion User.

© 2019, M icr o St r at egy In c. 5 70

Syst em Ad m in ist r at io n Gu id e

LDAP - Plat f o r m

Settin g Descrip tio n Defau lt Valu e

S elect t he vendor name of t he

LDA P server sof t ware t hat
I nt elligence S erver is connect ing
t o, f rom t he drop-down list .
LDA P Opt ions include HP -UX , I B M,
server Microsof t A ct ive Direct ory, Novell,
Novell
vendor Open LDA P , Ot her providers, and
name S un ONE / iP lanet . When you
select t he vendor name, t he
def ault LDA P connect ivit y f ile
names are populat ed in t he
int erf ace.

S elect t he vendor name of t he

LDA P server sof t ware t hat
I nt elligence S erver is connect ing
t o, f rom t he drop-down list .
V endor Opt ions include HP -UX , I B M,
LDA P
Microsof t A ct ive Direct ory, Novell,
Connect ivit y Novell
Open LDA P , Ot her providers, and
Driver
S un ONE / iP lanet . When you
select t he vendor LDA P
Connect ivit y Driver, t he def ault
LDA P connect ivit y f ile names are
populat ed in t he int erf ace.

S elect t he operat ing syst em

I nt elligence S erver is inst alled on,
I nt eliigence f rom t he drop-down list . This is
S erver t he operat ing syst em on which t he Windows
plat f orm LDA P Connect ivit y Driver and
connect ivit y f iles should be
inst alled.

LDA P E nt er t he LDA P connect ivit y f ile Ldapsdk. dll; Ldapssl. dll;

5 71 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Settin g Descrip tio n Defau lt Valu e

name(s) f or t he LDA P server. The

correct DLLs are aut omat ically
populat ed when t he LDA P
Connect ivit y Driver and
I nt elligence S erver plat f orm are
select ed. I t should not be
connect ivit y
necessary t o change t he def ault
f ile names
value. Y ou must separat e mult iple
DLL names wit h semicolons (; ).
S ee Identify ing U s ers :
Authentic ation f or recommeded
DLLs and inf ormat ion on LDA P
Connect ivit y Drivers.

LDAP - Filt er s

Defau lt
Settin g Descrip tio n
Valu e

P rovide t he root DN t o est ablish t he

direct ory locat ion f rom where in t he
LDA P t ree t o st art any user and group
searches. I f a root DN is not provided,
I nt elligence S erver searches t he ent ire
LDA P t ree. Y ou can t hink of t he root DN
S earch root as t he highest level in t he LDA P t ree
S earch
dist inguished where t he search can reach. The image E mpt y
S et t ings
name (DN) below represent s t he sect ion of t he LDA P
t ree t hat t he search accesses,
represent ed as t he dist inguished name
nodes wit h solid blue lines. The
dist inguished name nodes wit h dashed
grey lines are not included in t he search
since t hey are not under t he search root

© 2019, M icr o St r at egy In c. 5 72

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

dist inguished name.

5 73 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

E nt er t he user search f ilt er t o search f or

list s of users in t he LDA P direct ory.
Def ault inf ormat ion appears
aut omat ically based on t he vendor name
provided in t he P lat f orm Connect ivit y
st ep of t his wizard; t his def ault is only an
example, cont act your LDA P
administ rat or f or t he appropriat e values
t o ent er.

The user search f ilt er is generally in t he

f ollowing f orm:

(& (object class= LDA P _US E R_OB JE CT_

CLA S S )(LDA P _LOGI N_A TTR= #LDA P _
LOGI N#))

Where:
User search LDA P _US E R_OB JE CT_CLA S S indicat es E mpt y
f ilt er t he object class of t he LDA P users. For
example, you can ent er (&
(object class= person)(cn= #LDA P _
LOGI N#)).

LDA P _LOGI N_A TTR indicat es which

LDA P at t ribut e t o use t o st ore LDA P
logins. For example, you can ent er
($(object class= person)(cn= #LDA P _
LOGI N#)).

#LDA P _LOGI N# can be used in t his f ilt er

t o represent t he LDA P user login.

Not e: Depending on your LDA P server

vendor and your LDA P t ree st ruct ure, you
may need t o t ry dif f erent at t ribut es wit hin
t he search f ilt er synt ax above. For
example:

© 2019, M icr o St r at egy In c. 5 74

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

The user
search f ilt er
is generally
in t he
f ollowing
f orm:

(&
(object class=
LDA P _
US E R_
OB JE CT_
CLA S S )
(LDA P _
LOGI N_
A TTR= #LDA
P _LOGI N#))

Where:

LDA P _
US E R_
OB JE CT_
CLA S S
indicat es t he
object class
of t he LDA P
users. For
example, you
can ent er (&
(object class=
person)
(cn= #LDA P _
LOGI N#)).

LDA P _
LOGI N_

5 75 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

A TTR
indicat es
which LDA P
at t ribut e t o
use t o st ore
LDA P logins.
For example,
you can ent er
($(object clas
s= person)
(cn= #LDA P _
LOGI N#)).

#LDA P _
LOGI N# can
be used in
t his f ilt er t o
represent t he
LDA P user
login.

Not e:
Depending
on your
LDA P server
vendor and
your LDA P
t ree
st ruct ure,
you may
need t o t ry
dif f erent
at t ribut es
wit hin t he
search f ilt er
synt ax

© 2019, M icr o St r at egy In c. 5 76

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

above. For
example:

(&
(object class=
person)
(uniqueI D= #
LDA P _
LOGI N#))

where
uniqueI D is
t he LDA P
at t ribut e
name your
company
uses f or
aut hent icat io
n.

E nt er t he
group search
f ilt er t o
search f or
list s of LDA P
groups t hat
LDA P users
Group belong t o.
search Def ault E mpt y
f ilt er inf ormat ion
aut omat icall
y appears
based on t he
vendor name
provided in
t he P lat f orm

5 77 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

Connect ivit y
st ep of t his
wizard; t his
def ault is
only an
example,
cont act your
LDA P
administ rat or
f or t he
appropriat e
values t o
ent er.

The group
search f ilt er
is generally
in one of t he
f ollowing
f orms (or t he
f ollowing
f orms may
be combined
wit h a pipe |
symbol):

(&
(object class
= LDA P _
GROUP _
OB JE CT_
CLA S S )
(LDA P _
ME MB E R_
LOGI N_
A TTR= #LDA

© 2019, M icr o St r at egy In c. 5 78

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

P _LOGI N#))

(&
(object class
= LDA P _
GROUP _
OB JE CT_
CLA S S )
(LDA P _
ME MB E R_
DN_
A TTR= #LDA
P _DN#))

(&
(object class
= LDA P _
GROUP _
OB JE CT_
CLA S S )
(gidNumber=
#LDA P _
GI DNUMB E
R#))

The group
search f ilt er
f orms list ed
above have
t he f ollowing
placeholder
s:

LDA P _
GROUP _
OB JE CT_
CLA S S

5 79 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

indicat es t he
object class
of t he LDA P
groups. For
example, you
can ent er (&
(object class
= groupOf Na
mes)
(member= #L
DA P _DN#)).

LDA P _
ME MB E R_
[ LOGI N or
DN] _A TTR
indicat es
which LDA P
at t ribut e of
an LDA P
group is used
t o st ore
LDA P
logins/ DNs
of t he LDA P
users. For
example, you
can ent er (&
(object class
= groupOf Na
mes)
(member= #L
DA P _DN#)).

#LDA P _DN#
can be used

© 2019, M icr o St r at egy In c. 5 80

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

in t his f ilt er
t o represent
t he
dist inguished
name of an
LDA P user.

#LDA P _
LOGI N# can
be used in
t his f ilt er t o
represent an
LDA P user’s
login (f or
I nt elligence
S erver
version 8. 0. 1
and lat er).

#LDA P _
GI DNUMB E
R# can be
used in t his
f ilt er t o
represent t he
UNI X group
I D number;
t his
corresponds
t o t he LDA P
at t ribut e
gidNumber
(f or
I nt elligence
S erver
version 8. 0. 1

5 81 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

and lat er).

Click t he up
or down
arrows t o
Number of
specif y how
nest ed
many LDA P
group
groups t o 1
levels
import int o
above t o
MicroS t rat eg
import
y when t he
user or group
is import ed.

Click Test Connect ion t o t est t he

Test connect ion t o t he LDA P server. Y ou will
Connect ion Unselect ed
Connect ion be prompt ed f or a login and password t o
t est t he connect ion.

LDAP - Sch ed u les

Defau lt
Settin g Descrip tio n
Valu e

A long wit h set t ing up synchronizat ion schedules, you

can synchronize your MicroS t rat egy users and groups
wit h t he lat est LDA P users and groups immediat ely af t er
Run
clicking OK t o accept your changes and exit t he
schedules Unchecked
I nt elligence S erver Conf igurat ion E dit or. Users and
on save
groups are synchronized using t he user and group
search f ilt ers you def ined in I nt elligence S erver
Conf igurat ion E dit or: LDA P cat egory, Filt ers.

© 2019, M icr o St r at egy In c. 5 82

Syst em Ad m in ist r at io n Gu id e

LDAP - Imp o r t - Imp o r t / Syn ch r o n ize

Defau lt
Settin g Descrip tio n
Valu e

S elect t his checkbox t o indicat e

t hat I nt elligence S erver should
import LDA P users int o t he
I mport Users Checked
MicroS t rat egy met adat a as
MicroS t rat egy users when users
log in.

S ynchronize
S elect t his checkbox t o indicat e
MicroS t rat egy
t hat I nt elligence S erver should
User
synchronize t he users t hat are Checked
Login/ User
already in t he met adat a direct ory
Name wit h
each t ime a new user logs in.
I mport / S ynchronize LDA P

at Login S elect t his checkbox t o indicat e

t hat I nt elligence S erver should
import t he LDA P groups t o which
I mport
each import ed LDA P user belongs Checked
Groups
int o t he MicroS t rat egy met adat a
as MicroS t rat egy groups when
users log in.

S elect t his checkbox t o indicat e

S ynchronize
t hat I nt elligence S erver should
MicroS t rat egy
synchronize t he groups t hat are Checked
Group Name
already in t he met adat a direct ory
wit h LDA P
each t ime a user logs in.

S elect t his checkbox t o indicat e

t hat I nt elligence S erver should
I mport Users import a list of LDA P users int o Checked
I mport / S ynchronize
t he MicroS t rat egy met adat a as
in B at ch
MicroS t rat egy users in bat ch.

S ynchronize S elect t his checkbox t o indicat e Checked

5 83 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

MicroS t rat egy

t hat I nt elligence S erver should
User
synchronize t he users t hat are
Login/ User
already in t he met adat a direct ory
Name wit h
when users are import ed in bat ch.
LDA P

E nt er a user search f ilt er t o ret urn

a list of users t o import in bat ch.
Y ou should cont act your LDA P
administ rat or f or t he proper user
search f ilt er synt ax. A user search
f ilt er is generally of t he f ollowing
f orm:

(& (object class= LDA P _US E R_

OB JE CT_CLA S S )(LDA P _LOGI N_
A TTR= S E A RCH_S TRI NG))

The user search f ilt er f orm given

above has t he f ollowing
E nt er search placeholders:
f ilt er f or
LDA P _US E R_OB JE CT_CLA S S E mpt y
import ing list
indicat es t he object class of t he
of users
LDA P users. For example, you can
ent er (& (object class= person)
(cn= h*)).

LDA P _LOGI N_A TTR indicat es

which LDA P at t ribut e t o use t o
st ore LDA P logins. For example,
you can ent er (&
(object class= person)(cn= h*)).

S E A RCH_S TRI NG indicat es t he

search crit eria f or your user search
f ilt er. Y ou must mat ch t he correct
LDA P at t ribut e f or your search

© 2019, M icr o St r at egy In c. 5 84

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

f ilt er. For example, you can search

f or all users wit h an LDA P user
login t hat begins wit h t he let t er h
by ent ering (& (object class= person)
(cn= h*)).

Not e: Depending on your LDA P

server vendor and your t ree
st ruct ure creat ed wit hin LDA P , you
may need t o t ry dif f erent at t ribut es
wit hin t he search f ilt er synt ax
above. For example:

(& (object class= person)

(uniqueI D= S E A RCH_S TRI NG))

where uniqueI D is t he LDA P

at t ribut e your company uses f or
aut hent icat ion.

S elect t his checkbox t o indicat e

t hat I nt elligence S erver should
Checked
import groups int o t he
MicroS t rat egy met adat a.

S elect t his checkbox t o indicat e

S ynchronize t hat I nt elligence S erver should
MicroS t rat egy synchronize t he groups t hat are
Checked
Group Name already in t he met adat a direct ory
I mport Groups
wit h LDA P when groups are import ed in
bat ch.

E nt er a group search f ilt er t o ret urn

E nt er search a list of groups t o import in bat ch.
f ilt er f or Y ou should cont act your LDA P
E mpt y
import ing list administ rat or f or t he proper group
of groups search f ilt er synt ax. A group search
f ilt er is generally of t he f ollowing

5 85 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

f orm:

& (object class= LDA P _GROUP _

OB JE CT_CLA S S )(LDA P _GROUP _
A TTR= S E A RCH_S TRI NG))

The group search f ilt er f orm given

above has t he f ollowing
placeholders:

LDA P _GROUP _OB JE CT_CLA S S

indicat es t he object class of t he
LDA P groups. For example, you
can ent er (&
(object class= groupOf Names)
(cn= h*)).

LDA P _GROUP _A TTR indicat es

which LDA P at t ribut e of an LDA P
group is searched f or t o ret rieve a
list of groups. For example, you
can ent er (&
(object class= groupOf Names)
(cn= h*)).

S E A RCH_S TRI NG indicat es t he

search crit eria f or your group
search f ilt er. Y ou must mat ch t he
correct LDA P at t ribut e f or your
search f ilt er. For example, you can
search f or all groups wit h an LDA P
group name t hat begins wit h t he
let t er h by ent ering (&
(object class= groupOf Names)
(cn= h*)).

© 2019, M icr o St r at egy In c. 5 86

Syst em Ad m in ist r at io n Gu id e

LDAP - Imp o r t - User / Gr o u p

Defau lt
Settin g Descrip tio n
Valu e

S et s t he MicroS t rat egy user login t o be t he

User login same as t he LDA P user login, when t he S elect ed
MicroS t rat egy user is creat ed at import .

S et s t he MicroS t rat egy user login t o be t he

Dist inguished same as t he user’s LDA P dist inguished name,
Unselect ed
I mport name when t he MicroS t rat egy user is creat ed at
user import .
login
Y ou can provide a dif f erent LDA P at t ribut e
as
t han t he t wo list ed above t o be import ed and
used as t he MicroS t rat egy user login, when
Ot her t he MicroS t rat egy user is creat ed at import . Unselect ed
Y our LDA P administ rat or should provide you
wit h t he appropriat e LDA P at t ribut e t o be
used as t he user login.

S et s t he MicroS t rat egy user name t o be t he

User name same as t he LDA P user name, when t he S elect ed
MicroS t rat egy user is creat ed at import .

S et s t he MicroS t rat egy user name t o be t he

Dist inguished same as t he user’s LDA P dist inguished name,
Unselect ed
I mport name when t he MicroS t rat egy user is creat ed at
user import .
name
Y ou can provide a dif f erent LDA P at t ribut e
as
t han t he t wo list ed above t o be import ed and
used as t he MicroS t rat egy user name, when
Ot her t he MicroS t rat egy user is creat ed at import . Unselect ed
Y our LDA P administ rat or should provide you
wit h t he appropriat e LDA P at t ribut e t o be
used as t he user name.

I mport S et s t he MicroS t rat egy group names t o be

Group name S elect ed
group t he same as t he group names in t he LDA P

5 87 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

server f or t he groups import ed int o

MicroS t rat egy.

S et s t he MicroS t rat egy group names t o be t he

Dist inguished same as t he dist inguished names in t he LDA P
Unselect ed
name server f or t he groups import ed int o
MicroS t rat egy.
name
as Y ou can provide an LDA P at t ribut e t o be
import ed and used as t he MicroS t rat egy
group name, when MicroS t rat egy users are
Ot her import ed and creat ed along wit h t he users’ Unselect ed
groups. Y our LDA P administ rat or should
provide you wit h t he appropriat e LDA P
at t ribut e t o be used as t he group name.

LDAP - Imp o r t - Op t io n s

Defau lt
Settin g Descrip tio n
Valu e

S elect t his checkbox

t o use LDA P wit h
Windows
S ynchronize aut hent icat ion. B y
user/ group inf ormat ion creat ing a link
wit h LDA P during bet ween a Windows
Windows syst em login, an Unchecked
aut hent icat ion and LDA P user, and a
import Windows link MicroS t rat egy user, a
during B at ch I mport single login int o t he
machine
aut hent icat es t he
user f or t he machine

© 2019, M icr o St r at egy In c. 5 88

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

as well as in
MicroS t rat egy.

To support t his
opt ion, t he LDA P
S erver must be
conf igured as t he
Microsof t A ct ive
Direct ory S erver
domain cont roller,
which st ores t he
Windows syst em
login inf ormat ion.

S ee Identifying
U s ers :
Authentication f or
more inf ormat ion on
Windows
aut hent icat ion.

S elect t his checkbox

t o use an LDA P -
based single sign-on
S ynchronize syst em.
user/ group inf ormat ion
S ee Identifying Unchecked
wit h LDA P during
Trust ed aut hent icat ion U s ers :
Authentication f or
more inf ormat ion on
single sign-on.

5 89 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

Unchecked

I f you are import ing

users in a bat ch using
an LDA P -based single
sign-on syst em,
select t his checkbox
t o specif y t he unique
I D t o use in
Use def ault LDA P ident if ying t he users.
B at ch import
at t ribut e I f you select t his S elect ed
I nt egrat ed
('userP rincipalName') checkbox, specif y
A ut hent icat ion/ Trust ed
whet her t o use t he
A ut hent icat ion unique
def ault LDA P name
ID
at t ribut e
userP rincipalName
(t he def ault select ion)
or anot her LDA P
at t ribut e.

I f you are using

Ot her (t ype in t he anot her LDA P
Unselect ed
value) at t ribut e, ent er it
here.

I f you are import ing

LDA P users, eit her in
a bat ch or at login,
select t his opt ion t o
import email
I mport email address Unchecked
addresses associat ed
wit h t hose users as
MicroS t rat egy
Dist ribut ion S ervices
cont act s.

© 2019, M icr o St r at egy In c. 5 90

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

S pecif y whet her t o

use t he def ault LDA P
Use def ault LDA P email at t ribut e mail
S elect ed
at t ribut e ('mail') (t he def ault
select ion) or anot her
LDA P at t ribut e.

I f you are using

Ot her (t ype in t he anot her LDA P
Unselect ed
value) at t ribut e, ent er it
here.

I f you choose t o
import email
addresses, t he
import ed email
address becomes t he
A ddress P ropert ies - Generic
def ault email
Device email
address. This
overwrit es t he
exist ing def ault email
address, if one
exist s.

LDAP - Imp o r t - At t r ib u t es

Defau lt
Settin g Descrip tio n
Valu e

User logon S elect t he User login f ails if LDA P at t ribut e value is not
f ails if read f rom t he LDA P server checkbox t o prevent LDA P
LDA P users f rom logging int o t he MicroS t rat egy syst em if t hey Unselect ed
at t ribut e do not have all t he at t ribut es t hat have been import ed
value is int o t he syst em.

5 91 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

Warning: I f your syst em uses mult iple LDA P servers,

not read make sure t hat all LDA P at t ribut es used by I nt elligence
f rom t he S erver are def ined on all LDA P servers. I f a required
LDA P at t ribut e is def ined on LDA P server A and not on LDA P
server server B , users f rom LDA P server B will not be able t o log
in t o MicroS t rat egy if t his set t ing is enabled.

Web Sin gle Sign -On - Co n f igu r at io n

Defau lt
Settin g Descrip tio n
Valu e

The I nt elligence S erver Conf igurat ion E dit or:

Web S ingle S ign-On cat egory, Conf igurat ion
window shows det ails about applicat ions t hat
have est ablished t rust relat ionship wit h t he
I nt elligence S erver. A t rust relat ionship is
required t o enable single sign-on
aut hent icat ion t o MicroS t rat egy Web.
A llow user t o
The Web S ingle S ign-On cat egory,
log on if Web
Conf igurat ion dialog box also allows
S ingle S ign-
administ rat ors t o def ine how users are
on - Unchecked
handled when t hey log in t o MicroS t rat egy
MicroS t rat egy
Web wit h an account t hat is not linked t o a
user link not
MicroS t rat egy Web user.
f ound
S ee Identify ing U s ers : Authentication f or
more inf ormat ion about implement ing single
sign-on aut hent icat ion in MicroS t rat egy Web.

The Conf igurat ion subcat egory cont ains t he

f ollowing areas:

Trust ed Web A pplicat ion Regist rat ion: A ny

© 2019, M icr o St r at egy In c. 5 92

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

applicat ions t hat have t rust relat ionships wit h

t he I nt elligence S erver are displayed in t hese
f ields.

I f user not f ound: These opt ions allow you t o

conf igure how users are handled if t hey log in
t o MicroS t rat egy Web but are not linked t o
MicroS t rat egy users.

A llow user t o log on if Web S ingle S ign-On -

MicroS t rat egy user link not f ound: S elect ing
t his checkbox allows users t hat are not linked
t o a MicroS t rat egy user, t o log in t o
MicroS t rat egy Web as a guest .

I mport S elect t his checkbox t o import a single sign-

user on user int o t he MicroS t rat egy met adat a when
Unchecked
at t he user logs on t o MicroS t rat egy Web f or t he
logon f irst t ime.

S ynch
user S elect t his checkbox t o synch users when t hey
Unchecked
at log in.
logon

Hist o r y Set t in gs - Gen er al

Settin g Descrip tio n Defau lt Valu e

Maximum
number
Cont rols how many messages can
of 10, 000
Hist ory exist in a user's Hist ory List .
messages
set t ings
per user

Message Cont rols how many days messages can -1

5 93 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Settin g Descrip tio n Defau lt Valu e

exist in a user's Hist ory List . The

def ault value of -1 means t here is no
limit . Messages st ay in t he syst em
unt il t he user delet es t hem.

The message lif et ime can ensure t hat

no Hist ory List messages reside in t he
lif et ime syst em indef init ely. When t he user
(days) logs out of t he syst em, t he messages
are checked. I f t hey are older t han t he
lif et ime conf igured here, t he messages
are delet ed. This set t ing complement s
t he ot her Hist ory set t ing of Maximum
number of messages, which can be set
concurrent ly.

S elect ing t his opt ion st ores Hist ory

File
List messages in t he locat ion specif ied Unelect ed
B ased
in t he Hist ory Direct ory f ield.

. \ I nbox\ S E RV E R_
Hist ory The locat ion where Hist ory List
DE FI NI TI ON_
Direct ory messages are saved.
NA ME \

S elect ing t his opt ion st ores Hist ory

List messages in t he dat abase t hat is
Reposit ory associat ed wit h t he Dat abase I nst ance
Type t hat is select ed. To specif y a dat abase
inst ance, in t he I nt elligence S erver
Dat abase
Conf igurat ion E dit or, select t he S elect ed
B ased
General subcat egory of t he S erver
Def init ion cat egory, and, in t he
Dat abase I nst ance drop-down list ,
select t he dat abase inst ance t o use f or
t he Hist ory List .

Dat abase
S elect t he dat abase inst ance < None>
I nst ance

© 2019, M icr o St r at egy In c. 5 94

Syst em Ad m in ist r at io n Gu id e

Settin g Descrip tio n Defau lt Valu e

I f t his checkbox is select ed, Hist ory

caches are st ored in t he dat abase
B ackup wit hout needing t o be preserved in t he
report f ile syst em. I f t his checkbox is
hist ory cleared, Hist ory caches are st ored in Checked
caches t o t he I nt elligence S erver f ile syst em.
dat abase MicroS t rat egy recommends leaving
t his checkbox select ed f or
perf ormance and reliabilit y reasons.

E xt ernal
cent ral
st orage
direct ory S pecif y where f ile-based Hist ory List
f or messages are st ored if you are using a E mpt y
Dat abase- hybrid Hist ory List reposit ory.
based
Hist ory
LI st

Hist o r y Set t in gs - Rep lacemen t Po licy

Defau lt
Settin g Descrip tio n
Valu e

Number
When t he Hist ory List is f ull and anot her
of
message is added, I nt elligence S erver
messages
aut omat ically delet es t he specif ied number of
delet ed
Message messages, beginning wit h t he oldest 0
t o reclaim
Replacement messages. I f t his number is set t o zero, new
Hist ory
P olicy messages are not added t o t he Hist ory List
List
unt il messages are manually removed.
space

Delet e I f t his checkbox is select ed, error messages Checked

5 95 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

error
are delet ed (oldest f irst ) bef ore regular
messages
Hist ory List messages.
f irst

This drop-down list cont rols what t imest amp

I nt elligence S erver uses t o det ermine which
Hist ory List messages are t he oldest . Y ou
can select f rom:

Creat ion t ime: The t ime at which t he

Delet e
message was creat ed.
oldest Creat ion
messages Finish t ime: The t ime at which t he report Time
by f inished execut ing.

Modif icat ion t ime: The t ime at which t he

message was last modif ied.

S t art t ime: The t ime at which t he report

st art ed execut ing.

SAP User Man agemen t - Gen er al

Defau lt
Settin g Descrip tio n
Valu e

I f t his opt ion is select ed, a user wit h t he same S A P user

I mport
name is creat ed in MicroS t rat egy. This user is creat ed as Unchecked
users
a member of t he Warehouse Users group.

I f t his opt ion is select ed, t he MicroS t rat egy groups

assigned t o a MicroS t rat egy user are synchronized wit h
S earch f or t he S A P roles assigned t o t he S A P user. This means t hat
Unchecked
groups if S A P roles have been added or removed f or an S A P
user, t he associat ed MicroS t rat egy user is added or
removed f rom t he MicroS t rat egy groups t hat represent t he

© 2019, M icr o St r at egy In c. 5 96

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

S A P roles.

I f t his opt ion is select ed, all S A P roles t hat t he S A P user

is a member of are import ed as groups in MicroS t rat egy.
These groups are creat ed wit hin t he Warehouse Users
I mport group and only have t he inherit ed privileges of t he
Unchecked
groups Warehouse Users group. Once t hese groups are creat ed in
MicroS t rat egy, you can assign privileges t o t hese groups,
which are applied t o all users t hat are members of t he
groups.

Web Qu ick Sear ch - Gen er al

Defau lt
Settin g Descrip tio n
Valu e

The E nable S earch E ngine check

box must be select ed f or t he rest of
E nable S earch E ngine Checked
t he opt ions on t his int erf ace t o
become available.

To enable quick search f or a

E nable/ disable
project , f rom t he Quick S earch
Quick S earch and
drop-down list next t o t he project On
manage index f or
name, select On. Y ou are prompt ed
P roject s project s
whet her t o creat e t he search index.

The I ndex direct ory is t he f older

I ndex direct ory where t he quick search index is . \ S earchDat a
st ored.

S t op S pecif y t he list of
The list of S t op words are t hose
words words (separat ed
words t hat are not included in t he E mpt y
('Cont ains' by space) t hat
quick search index.
search should be

5 97 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

excluded f rom t he
search.

t ype only) Machine

S elect t he language t hat S t op
Language language
words should apply t o.
set t ings

Project Configuration Default Settings

The defaul t proj ect confi gurati on setti ngs, defi ned i n the Proj ect
C onfi gurati on Edi tor, are provi ded bel ow .

To ac c es s the Projec t Configuration Editor in Dev eloper, right-c lic k the

projec t s ourc e and c hoos e Project C onfiguration .

Pr o ject Def in it io n - Gen er al

Defau lt
Settin g Descrip tio n
Valu e

Descript ion Creat e or edit a descript ion of t he project . E mpt y

Click t he Modify but t on t o alt er t hree dif f erent

propert ies:

1. S ecurit y Change user permissions.

P ropert ies 2. E mpt y

Change t he def ault language.
I nt ernat ional
E nable t he change journey cat egory
3. Change
t o list t he changes t hat have been
journal
made t o t his object .

© 2019, M icr o St r at egy In c. 5 98

Syst em Ad m in ist r at io n Gu id e

Pr o ject Def in it io n - Secu r it y

Defau lt
Settin g Descrip tio n
Valu e

Use 7. 1x
securit y S et t he securit y model at report execut ion Unselect ed
model t ime, whet her securit y is checked only on t he
S ecurit y
report object it self (Use 7. 1. x securit y model)
model Use 7. 2x or on all object s t hat make up a report (Use
securit y 7. 2. x securit y model). S elect ed
model

Click Modify t o open t he P ropert ies dialog

S et project box:  S ecurit y t ab. The A CL you def ine here is
def init ion applied as t he def ault A CL f or t he project and Full cont rol
securit y all of t he object s wit hin t he project , excluding
t he object s ment ioned in t he f ollowing opt ion.

Click Modify t o open t he P ropert ies dialog

box: S ecurit y t ab. The A CL you def ine here is
applied as t he def ault A CL f or all object s in
t he project relat ed t o Freef orm S QL, Query
S et
B uilder, and MDX cube sources (S A P B W,
A ccess Freef orm
Microsof t A nalysis S ervices, Hyperion
cont rol S QL and Full
E ssbase, and I B M Cognos TM1). This
MDX  object s Cont rol
includes object s such as report s, met rics,
def ault
at t ribut es, MDX cubes, t ables, and ot her
securit y
such object s t hat are creat ed wit h t hese
MicroS t rat egy f eat ures. Y ou can modif y t his
def ault A CL f or any object in a project
individually.

S et project Click Modify t o open t he P ropert ies dialog

Full
root f older box: S ecurit y t ab. The A CL you def ine here is
Cont rol
securit y applied as t he A CL f or t he project root f older.

5 99 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Pr o ject Def in it io n - Dr illin g

Defau lt
Settin g Descrip tio n
Valu e

S elect a def ault

project drill map or
click Clear t o
remove t he def ault
drill map f rom t he
f ield.

A ll project s must
have a def ault drill
map; you cannot
remove t he
exist ing def ault
drill map f rom t his
f ield unt il you
specif y a new
def ault drill map.
I f you t ry t o
Def ault project drill map E mpt y
remove t he only
def ault drill map
f or a project , a
message indicat es
t hat ot her object s
depend on it .
When you search
f or dependent
object s, none are
f ound, because
t he dependent
object is t he
project it self .

Y ou can disable
drilling f or t he
project by

© 2019, M icr o St r at egy In c. 600

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

select ing an empt y

drill map, and t hen
clearing t he Drill
t o immediat e
children/ parent s
checkbox,
described below.

This cont rols drill-

down behavior
f rom object s on a
report ; when it is
enabled, only t he
Drill t o
immediat e children
immediat e Unchecked
or parent s of an
children/ parent s
object , rat her t han
all children or
parent s, are
displayed t o be
drilled t o.

When t his is
A dvanced select ed, Web
users can see only
personalized drill
pat hs rat her t han
all drill pat hs.
E nable Web P ersonalized drill
personalized pat hs are based Unchecked
drill pat hs on each object 's
access cont rol list
(A CL), specif ied in
t he S ecurit y
cat egory of t he
P ropert ies dialog
box. I f you set up

601 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

A CLs, all drill

pat hs are st ill
displayed in Web
unt il you enable
Web personalized
drill pat hs.

Not e: S elect ing

t his checkbox
disables X ML
caching, which can
adversely impact
MicroS t rat egy
Web perf ormance.

When t his is
enabled, all drilling
opt ions are
aut omat ically
sort ed
alphabet ically in
t he display when a
user right -clicks on
S ort drilling a drillable object .
opt ions in S ort ing occurs
ascending wit hin a hierarchy Unchecked
alphabet ical and bet ween
order hierarchies, in
ascending
alphabet ical order.

Not e: S ort ing is by

drill t ype, t hen by
set name, t hen by
pat h (at t ribut e)
name. However,

© 2019, M icr o St r at egy In c. 602

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

f or most cust om
drill pat hs, t he drill
t ype is " drillt ounit "
and t he set name
is generally empt y,
so t he most likely
def ault sort ing
order is ascending
order of pat h
(at t ribut e) name.

Pr o ject Def in it io n - Ob ject Temp lat es

Defau lt
Settin g Descrip tio n
Valu e

The object t emplat e used t o creat e a new

report f or any users who have disabled object
Def ault t emplat es f or report s. (None)
Templat e
Not e: The same def ault object t emplat e is
Report
used f or bot h report s and I nt elligent Cubes.

S how
Det ermines whet her t o show or hide t he
empt y Checked
empt y object t emplat e.
t emplat e

The object t emplat e used t o creat e a new

Def ault
t emplat e f or any users who have disabled (None)
Templat e
object t emplat es f or t emplat es.
Templat e
S how
Det ermines whet her t o show or hide t he
empt y Checked
empt y object t emplat e.
t emplat e

603 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

The object t emplat e used t o creat e a new

Def ault
met ric f or any users who have disabled object (None)
Templat e
t emplat es f or met rics.
Met ric
S how
Det ermines whet her t o show or hide t he
empt y Checked
empt y object t emplat e.
t emplat e

A s an alt ernat ive t o providing a def ault

document t emplat e t o document designers, if
Use you select t his t he designer is aut omat able
Document present ed wit h a wizard t hat st eps t hem Unselect ed
Wizard t hrough document creat ion. This can be
helpf ul f or newer or inf requent designers of
document s.
Document
The object t emplat e used t o creat e a new
Use
document f or any users who have disabled S elect ed
Templat e
object t emplat es f or document s.

S how
Det ermines whet her t o show or hide t he
empt y Checked
empt y object t emplat e.
t emplat e

Pr o ject Def in it io n - PDF Set t in gs

Defau lt
Settin g Descrip tio n
Valu e

From t he E dit drop-down list , select whet her you want t o add
E dit a header or a f oot er t o P DFs creat ed when a report is E mpt y
export ed f rom t his project .

From t he I nsert A ut o-Text drop-down list , select t he aut o-

I nsert
t ext t o display. Opt ions include Dat e, Number of P ages, E mpt y
A ut o-Text
P age B y, and more.

© 2019, M icr o St r at egy In c. 604

Syst em Ad m in ist r at io n Gu id e

Pr o ject Def in it io n - Exp o r t Set t in gs

Defau lt
Settin g Descrip tio n
Valu e

Y ou can def ine st at ic t ext t hat will appear on all report s

wit hin a project . This is part icularly usef ul f or adding t ext
such as " Conf ident ial, " " P ropriet ary, " your company's
E dit E mpt y
name, and so on. The t ext appears on every report t hat is
export ed f rom t he project . The t ext can appear as a header
or as a f oot er.

I f you have upgraded your MicroS t rat egy syst em f rom 8. 1. x

Run E xport and are experiencing problems wit h export ing report s or
to document s t o E xcel or Word, MicroS t rat egy Technical
E xcel/ Word S upport may inst ruct you t o select t he Run E xport t o
E mpt y
in 8. 1. x E xcel/ Word in 8. 1. x compat ibilit y mode checkbox.
compat ibilit y MicroS t rat egy recommends t hat you only select t his
mode checkbox if inst ruct ed t o do so by MicroS t rat egy Technical
S upport .

Do not S elect t he Do not merge or duplicat e headers when

merge or export ing t o E xcel/ Word checkbox t o repeat t he t able
duplicat e headers when export ing a report or a document t o an E xcel
headers sheet or a Word document , as per MicroS t rat egy 8. 1. x. E mpt y
when A gain, MicroS t rat egy recommends t hat you only select t his
export ing t o check box if inst ruct ed t o do so by MicroS t rat egy Technical
E xcel/ Word S upport .

The E xport t o Flash using t his f ile f ormat set t ing allows you
E xport t o
t o select t he Flash f ile f ormat f or document s and dossiers.
Flash f ile P DF
Y ou can choose t o export all t he Flash f iles in a project in
f ormat
eit her MHT or P DF f ormat .

605 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Pr o ject Def in it io n - Co mmu n icat io n s

Defau lt
Settin g Descrip tio n
Valu e

P lease
t ype t he The Window t it le is displayed af t er t he name of t he object
t ext t o (report , document , met ric, and so on) on t he t it le bar of
display in each int erf ace f or Developer users. The window t it le E mpt y
t he allows a user t o conf irm which project def init ion t hey are
window working wit h. Type t he t ext t o display in t his f ield.
t it le

Click Modify t o open t he P roject S t at us E dit or. The

P roject S t at us is a message t hat is displayed on t he
P roject
project 's home page. E nt er a message and select t he Unchecked
S t at us
Display project st at us checkbox. S elect t o display t he
project at t he t op or bot t om of t he home page.

Pr o ject Def in it io n - Hist o r y List

Defau lt
Settin g Descrip tio n
Valu e

Maximum number of messages per user -1

S ave Report S ervices document dat aset

Checked
Hist ory messages t o Hist ory List

set t ings S ave export ed result s f or int eract ive

Unchecked
execut ions sent t o Hist ory LI st

Maximum I nbox message size (MB ) -1

© 2019, M icr o St r at egy In c. 606

Syst em Ad m in ist r at io n Gu id e

Pr o ject Def in it io n - User Pr o f iles

Defau lt
Settin g Descrip tio n
Valu e

E nable or disable t he aut omat ic creat ion of t hese f olders.

Creat e
user I f you plan t o duplicat e a project , t o minimize t he t ime
involved in t he project duplicat ion process it can be usef ul t o Checked
prof iles at
login disable t his set t ing (by clearing t he checkbox) so t hat user
prof ile f olders are not aut omat ically creat ed f or new users.

Pr o ject Def in it io n - Do cu men t s an d Rep o r t s

Descrip ti
Settin g Defau lt Valu e
on

Click t o
specif y
report
det ails
propert ies.
S ee
Projec t
Report D efinition -
Report
Det ails D oc uments
det ails
P ropert i and
propert ies
es R eports -
R eport
D etails
Properties
- General
f or more
inf ormat io
n.

Click t o
Wat erma Wat ermark

607 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Descrip ti
Settin g Defau lt Valu e
on

specif y t he
def ault
wat ermark
f or
document s
and
report s.
S ee Projec t
rk
D efinition -
D oc uments
and
R eports -
W atermark
f or more
inf ormat io
n.

S elect t his
checkbox if
A llow you want
document s individual
Wat erm to document s
Checked
ark overwrit e t o be able
t his to
wat ermark overwrit e
t he
wat ermark.

S pecif y t he When a
web server document
t hat will be cont aining
Web used t o t he ht t p: / / localhost : 8080/ MicroS t rat egy/ servlet /
S erver replace WE B S E RV mst rWeb
WE B S E RV E R macro
E R macro
in

© 2019, M icr o St r at egy In c. 608

Syst em Ad m in ist r at io n Gu id e

Descrip ti
Settin g Defau lt Valu e
on

is execut ed
f rom
MicroS t rat e
gy Web, t he
macro is
replaced
wit h t he
web server
used t o
execut e t he
document .
I f t he
document
is execut ed
f rom
Developer,
document s t he
WE B S E RV
E R macro
is replaced
wit h t he
web server
specif ied in
t he S pecif y
t he web
server t hat
will be used
t o replace
WE B S E RV
E R macro
in
document s
f ield.

609 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Descrip ti
Settin g Defau lt Valu e
on

I f t he
document
is execut ed
S pecif y t he t hrough a
web server subscript io
t hat will be n, you can
used in link use t his
t o hist ory f ield t o
list f or specif y
email which web
E mpt y
subscript io server t o
ns and use in t he
not if icat ion link t o
of hist ory Hist ory List
list messages
subscript io in email
ns subscript io
ns and
not if icat ion
s.

E nable S elect t his

links in opt ion t o
Flash
export ed enable links
documen Unchecked
Flash in st and-
ts
document s alone Flash
(. mht f iles) document s.

S elect t his
opt ion t o
Mobile E nable enable
docume smart smart Unchecked
nt s client client f or
mobile
document s.

© 2019, M icr o St r at egy In c. 610

Syst em Ad m in ist r at io n Gu id e

Pr o ject Def in it io n - Do cu men t s an d Rep o r t s - Rep o r t Det ails

Pr o p er t ies - Gen er al

Defau lt
Settin g Descrip tio n
Valu e

Report S elect t his checkbox t o display a short

Unchecked
Descript ion descript ion of t he report .

P rompt S elect t his checkbox t o display t he

Unchecked
Det ails prompt det ails on t he report .

S elect t his checkbox t o include t he

Report Filt er f ilt er det ails such as t he def init ion of
Det ails Checked
Det ails t he report f ilt er, view f ilt er, and report
limit s.

S elect t his checkbox t o include det ails

Templat e about t he object s on t he report , such as
Unchecked
Det ails at t ribut es and met rics, as well as t he
met ric def init ions.

The prompt t it le is def ined when t he

prompt is creat ed and t he index is a
number indicat ing t he order of t he
I nclude
prompt s in t he dat aset report s. To Tit le and
P rompt
enable t hem t o be displayed in t he I ndex
Tit les
Report Det ails pane above a report ,
select Tit le and I ndex. S elect No Tit le
or I ndex t o exclude t he t it le and index.
P rompt
Det ails S elect an opt ion t o be displayed f rom
t he drop-down list if a prompt is
unanswered. The opt ions are:
Replacement
st ring f or Def ault : The prompt is answered by t he
Def ault
unanswered def ault prompt answer f or t he prompt in
prompt s t he t arget report .

B lank: There is no prompt in t he t arget

report .

611 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

P rompt Not A nswered: The prompt in

t he t arget is ignored, which means t hat
t he prompt is not answered. No prompt
answer is provided f rom t he source and
t he user is not prompt ed t o provide
answers.

No S elect ion: The prompt is answered

using none of t he object select ed in t he
source.

A ll/ None: The prompt is answered

using all t he object s or none of t he
object s select ed in t he source.

Y ou can specif y whet her and how you

want t o display t he at t ribut e name f or
S how
t he at t ribut e element list prompt s in
at t ribut e
t he document . The opt ions are:
name f or
Y es t o show t he at t ribut e names. No
A t t ribut e
E lement No t o exclude t he at t ribut e names.
P rompt s
Repeat ed t o repeat t he at t ribut e name
f or each prompt answer.

I nclude S elect t he checkbox t o include unused

unused prompt s, which occur when you drill on Unchecked
prompt s a report t hat cont ains a prompt .

Delimit ers are charact ers t hat can

appear around object names t o set
Use t hem of f f rom ot her t ext . B races { } are
delimit ers used as delimit ers. Y ou can select t he
Miscellaneous around f ollowing opt ions f rom t he drop-down A ut omat ic
report object list :
names
Y es t o display delimit ers f or all
met adat a object names

© 2019, M icr o St r at egy In c. 612

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

No t o exclude delimit ers f or all

met adat a object names

A ut omat ic t o display delimit ers only f or

t hose object names t hat cont ain a
special charact er. S pecial charact ers
are charact ers ot her t han a - z, A - Z, 0
- 9, #, _, and . (period).

S elect t his checkbox t o display aliases

(object names) in t he display of f ilt er
det ails. A n alias is a secondary name
f or an object on a report , which is
creat ed when a user renames t he
object , t o display a meaningf ul
Use aliases descript ion in t he cont ext of t hat
in Filt er part icular report . A n alias does not Unchecked
Det ails change t he name of t he object as it is
st ored in t he syst em, it only changes
t he name displayed on t he report . A
f ilt er uses t he act ual name of t he
object , not t he alias. Y ou can
det ermine whet her aliases replace
object names in t he f ilt er det ails.

Pr o ject Def in it io n - Do cu men t s an d Rep o r t s - Rep o r t Det ails

Pr o p er t ies - Filt er Det ails - Co n t en t s

Defau lt
Settin g Descrip tio n
Valu e

Report S elect t his checkbox t o enable report

General Checked
Filt er f ilt ers.

613 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

Choose whet her t o include t he f ilt er name

in t he Report Det ails pane or exclude it . I f
Report Filt er
you select A ut omat ic, t he report f ilt er name A ut omat ic
Name
is displayed f or a st and-alone f ilt er and not
displayed f or an embedded f ilt er.

Report S elect t his checkbox t o include a short

Filt er descript ion of t he report f ilt er in t he Report Checked
Descript ion Det ails pane.

S elect whet her t o enable t he display of

report limit s in t he Report Det ails pane. A
report limit specif ies a set of crit eria used
Report t o rest rict t he dat a ret urned in a result set
Checked
Limit s af t er t he report ’s met rics are calculat ed. A
report limit can make a report more
ef f icient t o run, because less inf ormat ion is
ret urned f rom t he dat a source.

S elect whet her t o enable t he display of

view f ilt er det ails. A view f ilt er is a quick
V iew Filt er Checked
qualif icat ion applied in memory t o t he
report result s.

Met ric
S elect t his checkbox t o display t he view
Qualif icat ion
f ilt er’s met ric qualif icat ion in t he Report Checked
in V iew
Det ails pane.
Filt er

S elect t his checkbox t o display t he drill

Drill Filt er Unchecked
f ilt er.

S elect t his checkbox t o display t he securit y

S ecurit y
f ilt er t hat is applied t o t he report and t o t he Unchecked
Filt er
object s t hat make up t he report .

A ddit ional I nclude S elect t his checkbox t o display t he f ilt er

Checked
Opt ions f ilt er t ype t ype name, such as Report Filt er, V iew

© 2019, M icr o St r at egy In c. 614

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

name Filt er, et c.

S how E mpt y S elect t his checkbox t o display empt y

Unchecked
E xpressions expressions in a f ilt er.

S elect t his t o add a line af t er each f ilt er

New line
t ype name and bef ore t he act ual def init ion
af t er f ilt er Checked
of t he f ilt er. This provides spacing, making
t ype name
complex f ilt er def init ions easier t o read.

New line S elect t his t o add a line af t er each sub-

bet ween expression, t o help dif f erent iat e bet ween Checked
f ilt er t ypes t he various f ilt ers.

S how S elect t his t o display report limit det ails

B ef ore
Report eit her above or below t he view f ilt er
V iew Filt er
Limit s det ails, if any.

S elect t o expand t he det ails displayed f or

E xpand S how
short cut f ilt ers. Y ou can enable display of
short cut Filt er
t he short cut f ilt er’s name, def init ion, or
f ilt ers Def init ion
bot h name and def init ion.

Pr o ject Def in it io n - Do cu men t s an d Rep o r t s - Rep o r t Det ails

Pr o p er t ies - Filt er Det ails - Ot h er

Defau lt
Settin g Descrip tio n
Valu e

S how Det ermines t he display of t he at t ribut e’s

at t ribut e name in t he f ilt er’s at t ribut e element list .
I n List S elect f rom t he f ollowing opt ions:
name f or I n Y es
Condit ions
List Y es t o display t he at t ribut e name. This is
condit ions t he def ault set t ing.

615 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

No t o exclude t he at t ribut e name.

Repeat ed t o repeat t he at t ribut e name

f or each at t ribut e element . E xample:
Region = Nort heast , Region = Mid-
A t lant ic.

I f you want a charact er t o separat e t he

S eparat or
at t ribut e name f rom t he at t ribut e element
af t er
name, t ype t he charact er. The common =
at t ribut e
charact ers used are an equals (= ) sign or
name
a colon.

New line
S elect t his checkbox t o display t he
af t er
at t ribut e name and it s element on Unchecked
at t ribut e
separat e lines.
name

Y ou can select t he t ext t hat separat es t he

last t wo at t ribut e element s in t he list .
The opt ions are:

cust om: The Cust om separat or f ield,

described below, is enabled when you
select t his opt ion.
S eparat or
or: The word ”or” is displayed bet ween
bet ween last
t he last t wo at t ribut e element s in t he list . comma
t wo
element s
and: The word ”and” is displayed bet ween
t he last t wo at t ribut e element s in t he list .

comma: The comma charact er , is

displayed bet ween t he last t wo at t ribut e
element s in t he list .

Cust om
Type t he charact er or t ext t o be used as a ,
separat or

© 2019, M icr o St r at egy In c. 616

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

separat or. To enable t his f ield, select

Cust om in t he opt ion described above.

New line S elect t his checkbox t o display each

bet ween at t ribut e element on a separat e line in Unchecked
element s t he Report Det ails pane.

S elect t his checkbox t o t rim any ext ra

spaces in t he at t ribut e element names.
For example, an element of an account
Trim at t ribut e is P S I 2415 : 10 :
Unchecked
element s COMME RCI A L. I f Trim element s is
select ed, t he at t ribut e is displayed as
P S I 2415 : 10: COMME RCI A L, wit h t he
ext ra spaces excluded.

Use names S elect t he desired opt ion t o display

or symbols operat or names (such as E quals or
S ymbols
f or Great er Than) or operat or symbols (such
operat ors as = or > ).

I nclude
at t ribut e
Qualif icat ion f orm names S elect t his checkbox t o display at t ribut e
Checked
Condit ions in f orm names (such as DE S C or I D).
qualif icat ion
condit ions

S elect t his opt ion t o det ermine whet her

Dynamic dat es display t he expression used t o
Def ault
Dat es generat e t he dat e, t he dat es t hemselves,
or a def ault display is used.

S elect t he desired opt ion t o specif y

New line
Logical whet her or not each condit ion is
bet ween No
Operat ors displayed on a separat e line in t he
condit ions
Report Det ails pane. Y ou can also select

617 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

A ut omat ic, which insert s a line only when

f ilt er condit ions are joined by dif f erent
logical operat ors. For more inf ormat ion,
see Def ining how logical operat ors are
displayed.

S elect t his opt ion t o display parent heses

around each condit ion, such as (Region =
Nort heast ). The opt ions are:
P arent heses Y es t o display parent heses.
around A ut omat ic
condit ions No t o exclude parent heses.

A ut omat ic t o display parent heses only

when it clarif ies any ambiguit y in t he
expression.

S elect t his opt ion t o display t he logical

operat or, f or example A ND or OR, t hat
appears bet ween f ilt er condit ions. The
opt ions are:
Logical
operat or Y es t o display all operat ors. This is t he
Y es
bet ween def ault set t ing.
condit ions
No t o exclude all operat ors.

A ND only t o display only A ND operat ors.

OR only t o display only OR operat ors.

© 2019, M icr o St r at egy In c. 618

Syst em Ad m in ist r at io n Gu id e

Pr o ject Def in it io n - Do cu men t s an d Rep o r t s - Rep o r t Det ails

Pr o p er t ies - Temp lat e Det ails

Defau lt
Settin g Descrip tio n
Valu e

Use t hese opt ions t o display t he det ails

f or report object s f rom t he base report or
t he view report . S elect one of t he
f ollowing f rom t he Unit s f rom V iew or
B ase drop-down list :
Unit s f rom
V iew
V iew or B ase To display det ails f or all t he object s on
t he report , t hat is, all t he object s in
Report Object s, select B ase.

To show det ails f or only t hose object s

displayed on t he report grid, select V iew.

Use t hese opt ions t o select whet her t he

t emplat e name of t he report is displayed
in t he Report Det ails pane. S elect one of
t he f ollowing f rom t he B ase Templat e
Logical name drop-down list :
Operat ors
Y es: S elect t his t o display t he t emplat e
name f or a st and-alone t emplat e and t he
Local Templat e name f or an embedded
B ase Templat e t emplat e. A ut omat ic
name
A ut omat ic: S elect t his t o display t he
t emplat e name f or a st and-alone
t emplat e, but not display t he Local
Templat e name f or an embedded
t emplat e. This is t he def ault set t ing.

No: S elect t his t o omit display of t he

t emplat e name, whet her or not t he
t emplat e is st and-alone or embedded.

Templat e
S elect t his checkbox t o display t he short Checked
Descript ion

619 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

descript ion of t he t emplat e. I f t he

t emplat e is embedded or does not have a
descript ion, t he Templat e Descript ion
f ield does not appear.

S elect t his checkbox t o display def init ions

Non_Met ric and expressions f or object s on t he report
Checked
t emplat e unit s ot her t han met rics, such as at t ribut es and
consolidat ions.

S elect t his checkbox t o display

Met rics def init ions and expressions f or t he Checked
met rics on t he report .

Condit ional Det ermines whet her a met ric has a

Unchecked
Met rics only condit ion applied t o it .

Formula Det ermines t he met ric f ormula. Checked

Det ermines t he level at which t he met ric

Dimensionalit y Unchecked
is calculat ed.

Det ermines t he condit ionalit y t o a met ric

when you creat e a f ilt er and add t he f ilt er
t o t he met ric’s def init ion so t hat only dat a
Condit ionalit y t hat meet s t he f ilt er condit ions is Checked
included in t hat met ric’s calculat ion. S ee
t he Bas ic R eporting Guide f or more
inf ormat ion on condit ionalit y.

Det ermines whet her a met ric has a

Transf ormat ion Unchecked
t ransf ormat ion applied t o it .

© 2019, M icr o St r at egy In c. 620

Syst em Ad m in ist r at io n Gu id e

Pr o ject Def in it io n - Do cu men t s an d Rep o r t s - Wat er mar k

Defau lt
Settin g Descrip tio n
Valu e

I f you select No wat ermarks while creat ing

a project wat ermark, and t he A llow
document s t o overwrit e t his wat ermark
checkbox in t he P roject Conf igurat ion
E dit or is select ed, a document displays it s
document wat ermark, if it is def ined f or
t he document . Report s do not display any
wat ermarks when export ed t o P DF. S ee
Creat ing document wat ermarks f or more
det ails.

I f you select No wat ermarks while creat ing

a project wat ermark, and t he A llow
No wat ermark S elect ed
document s t o overwrit e t his wat ermark
checkbox in t he P roject Conf igurat ion
E dit or is cleared, all wat ermarks are
disabled. Neit her document s nor report s
display any wat ermarks. S ee Disabling all
wat ermarks f or more det ails.

I f you select No wat ermarks while creat ing

a document wat ermark, t he document
does not display any wat ermark, even if a
project wat ermark has been def ined. S ee
Hiding a project wat ermark f or a specif ic
document f or more det ails.

S elect t his opt ion t o enable a t ext

Unselect ed
wat ermark.

Text E nt er t he wat ermark t ext , up t o 255

Text E mpt y
wat ermark charact ers.

S ize f ont S elect t o aut omat ically adjust t he f ont size

Checked
aut omat ically t o f ill t he layout .

621 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

S elect t o f ade t he wat ermark t ext , so you

Washout can view t he report t ext t hrough t he Checked
wat ermark.

S elect t o display t he wat ermark t ext

Diagonal S elect ed
diagonally.

S elect t o display t he wat ermark t ext

Horizont al Unselect ed
horizont ally.

Unselect ed

S ource S elect an image t o use as a wat ermark. E mpt y

I mage
wat ermark S elect A ut o t o scale t he wat ermark
S cale aut omat ically. S elect a percent age t o A ut o
scale t he image manually.

Pr o ject Def in it io n - Ch an ge Jo u r n alin g

Defau lt
Settin g Descrip tio n
Valu e

S elect or clear t his checkbox t o enable or

disable change journaling f or t his project
Conf igure E nable source. When change journaling is enabled f or
Change Change a project , I nt elligence S erver records Checked
Journaling Journaling inf ormat ion in t he change journal about
changes made t o t he project conf igurat ion
object s, such as users or schedules.

P urge all
P urge dat a S elect an appropriat e dat e and t ime. A ll change
Change logged journal dat a logged bef ore t his dat e and t ime is Today
Journal bef ore delet ed when you click P urge Now.
(dat e)

© 2019, M icr o St r at egy In c. 622

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

P urge all
dat a
logged Now
bef ore
(t ime)

E nt er t he purge t imeout in seconds. This is t he

lengt h of t ime I nt elligence S erver wait s f or a
P urge
response when it issues a purge command t o
t imeout 600
t he change journal. I f t here is no response by
(seconds)
t he t ime t he t imeout has elapsed, t he purge
command is canceled.

Pr o ject Def in it io n - Ad van ced

Defau lt
Settin g Descrip tio n
Valu e

HTML document direct ory Def ine t he HTML document direct ory. E mpt y

Click Regist er S t yles t o associat e prompt

t ypes wit h prompt st yles, which det ermine
P rompt cust om st yles E mpt y
how prompt s display in MicroS t rat egy
Web.

This is t he maximum number of element s

t o display in a single request f rom
Developer. E lement request s t hat exceed
Maximum t his limit but are under t he project level
A t t ribut e
number of set t ing f or maximum element rows are
element s 1, 000
element s t o st ored on t he I nt elligence S erver. This
browsing
display set t ing impact s how many element s are
displayed at one t ime in Developer's Dat a
E xplorer, and in prompt answer windows.
V alues of 0 and -1 indicat e no limit .

623 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

Not e: I f a limit has been specif ied in t he

Hierarchy E dit or or A t t ribut e E dit or t hat is
lower t han t he limit specif ied here, t hat
limit is used inst ead. I f t he limit specif ied
here is lower t han t he limit in t he
Hierarchy E dit or or A t t ribut e E dit or, t his
limit is used. I f you are not seeing as
many element s as you expect , check t he
at t ribut e’s Limit set t ing in t he A t t ribut e
E dit or or Hierarchy E dit or

I f t his checkbox is select ed, securit y

f ilt ers are applied t o at t ribut e element
browsing. For example, a user has a
securit y f ilt er def ined as
Cat egory= E lect ronics. I f t his checkbox is
A pply securit y select ed, when t he user browses t he
f ilt ers t o P roduct hierarchy, t he user can see only
Checked
element t he E lect ronics cat egory. I f t his checkbox
browsing is cleared, t he user can see all element s
when browsing t he P roduct hierarchy.
Regardless of whet her t his checkbox is
select ed or cleared, t he user can see only
element s in t he E lect ronics cat egory when
viewing a report .

Click t o
conf igure t he
analyt ical
P roject - engine
Level set t ings. S ee
V LDB D etails for
set t ings All VLD B
Properties
f or more
inf ormat ion.

© 2019, M icr o St r at egy In c. 624

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

I f t he checkbox is select ed, a user is

E nable Find
allowed t o f ind all dependent object s and
and Replace
replace t hem. I f t he checkbox is cleared, a Unchecked
object
user is not allowed t o f ind any dependent
dependencies
object s in t he project .

I f t he checkbox is select ed, users are

allowed t o view and delet e all dependent
Dependent
object s t hat may be prevent ing t he object
Object
in quest ion f rom being delet ed. A user
Opt ions E nable must have t he appropriat e A CL access on
delet ing of all dependent object s f or t he delet ion t o Unchecked
object occur (f or det ails and links t o st eps, see
dependencies A bout cont rolling access and A CLs).

I f t he checkbox is cleared, users cannot

delet e any dependent object s in t he
project .

I f t he checkbox is select ed, users see t he

at t ribut es in a hierarchy prompt displayed
Display alphabet ically. This set t ing overrides any
A t t ribut e specif ic sort ing order def ined in t he
alphabet ically Hierarchy E dit or. Checked
in hierarchy I f t he checkbox is cleared, users see t he
prompt at t ribut es in a hierarchy prompt displayed
A dvanced according t o t he sort order def ined in t he
P rompt Hierarchy E dit or.
P ropert ies
P ersonal answers allow a user t o save
prompt answers f or a specif ic prompt , and
E nable t hen reuse t he answers on any report t hat
personal uses a prompt . Checked
answers I f t he checkbox is select ed, prompt
designers can allow users t o select
personal answers while creat ing a prompt .

625 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

I f t he checkbox is cleared, select ing

personal answers f or prompt s is not
allowed.

P opulat e
Mobile
I D syst em E nt er a value t o populat e as a mobile
Unchecked
prompt f or I D syst em prompt f or non-mobile users.
non-mobile
users.

Pr o ject Def in it io n - Righ t t o Lef t

Defau lt
Settin g Descrip tio n
Valu e

E nable
S elect t his checkbox t o enable export t o P DF in
export t o
Hebrew. This f unct ionalit y is current ly f or int ernal Unchecked
P DF in
MicroS t rat egy use only.
Hebrew

Dat ab ase In st an ces - SQL Dat a War eh o u ses

Defau lt
Settin g Descrip tio n
Valu e

S elect t he primary dat abase inst ance f or t he project f rom

S elect t he
t he S elect t he P rimary Dat abase I nst ance f or t he P roject
P rimary
drop-down list .
Dat abase E mpt y
I nst ance f or Not e: I f you have a license f or t he Mult iS ource Opt ion, The
t he P roject primary dat abase inst ance act s as t he main source of dat a

© 2019, M icr o St r at egy In c. 626

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

f or a project and is used as t he def ault dat abase inst ance

f or t ables added t o t he project . S ee t he Project D es ign
Guide f or inf ormat ion on t he Warehouse Cat alog, and
accessing mult iple dat a sources wit h t he Mult iS ource
Opt ion.

V LDB Click t o conf igure V LDB propert ies. S ee D etails for All
P ropert ies VLD B Properties f or more inf ormat ion.

Dat ab ase In st an ces - St at ist ics

Defau lt
Settin g Descrip tio n
Valu e

The S QL Dat a warehouses subcat egory is where you creat e

and modif y your relat ional dat abase inst ances.

Y ou can conf igure t he f ollowing set t ings f or relat ional

dat abase inst ances:

l P rimary dat abase inst ance: S elect t he primary dat abase

inst ance f or t he project f rom t he S elect t he P rimary
Dat abase I nst ance f or t he P roject drop-down list .

l New: Creat es a new relat ional dat abase inst ance wit h t he
S QL Dat a
Dat abase I nst ance E dit or. E mpt y
warehouses
l Modif y: Let s you modif y dat abase inst ances included f or
t he project (including warehouse, dat a mart , Freef orm
S QL, and Query B uilder dat abase inst ances).

l S et as def ault : S et s t he select ed dat abase inst ance as

t he def ault dat abase inst ance f or t he project . The def ault
dat abase inst ance is t he dat abase inst ance select ed by
def ault f or Freef orm S QL and Query B uilder.

l V LDB P ropert ies: Modif y t he warehouse dat abase

627 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

inst ance V LDB propert ies using t he V LDB P ropert ies

E dit or.

l S elect ing a dat abase inst ance check box makes t hat
dat abase inst ance available in t he project f or st andard
MicroS t rat egy report ing, dat a mart s, Query B uilder, and
Freef orm S QL. I f you have a license f or t he Mult iS ource
Opt ion, select ing a check box f or a dat abase inst ance
also makes t he dat abase inst ance available f rom t he
Warehouse Cat alog t o be part of t he project ’s relat ional
schema.

The MDX Dat a warehouses subcat egory provides set t ings t o

creat e and modif y your MDX cube source dat abase
inst ances t o connect t o MDX cube sources.

Y ou can conf igure t he f ollowing set t ings f or MDX cube

sources:

l New: Creat es a new MDX cube source dat abase inst ance
wit h t he Dat abase I nst ance E dit or.

MDX  Dat a l Modif y: Let s you modif y an MDX cube dat abase
inst ance’s connect ion inf ormat ion. E mpt y
warehouse
l V LDB P ropert ies: Y ou can Modif y t he dat abase inst ance
V LDB propert ies using t he V LDB P ropert ies E dit or.

l S chema Maint enance: Opens t he S chema Maint enance

dialog box, which let s you remove MDX dat abase
inst ances f rom a project , det ermine when MDX cube
schemas are loaded int o I nt elligence S erver, and move
MDX cube schemas bet ween dif f erent dat abase
inst ances.

The Connect ion mapping cat egory list s all t he connect ion
Connect ion mappings f or t he project . I t provides t he f ollowing det ails:
E mpt y
mapping l Dat abase I nst ance: The dat abase inst ance t hat is being
mapped t o.

© 2019, M icr o St r at egy In c. 628

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

l User: The user or group associat ed wit h t he connect ion

mapping.

l Language: The def ault language used by t he connect ion

mapping.

l Dat abase Connect ion: The dat abase connect ion used by
t he mapped dat abase login.

l Dat abase Login: The dat abase login I D t hat t he users are
mapped t o.

The S t at ist ics subcat egory is where you select t he dat abase
inst ance f or t he dat abase where st at ist ics t ables are st ored.

From t he S t at ist ics dat abase inst ance drop-down list , select
S t at ist ics < None>
t he dat abase inst ance t hat represent s t he dat abase in which
t he st at ist ics t ables are st ored.

S t at ist ics can be recorded f or user sessions, caches, HTML

document s, basic or det ailed report jobs, et c.

Go ver n in g Ru les - Def au lt - Resu lt Set s

Defau lt
Settin g Descrip tio n
Valu e

Report s t hat are execut ed direct ly

I nt eract ive
I nt elligence by a user. A value of -1 indicat es 600
Report s
S erver no limit .

E lapsed Report s t hat are execut ed f rom a

Time (sec) S cheduled
subscript ion. The def ault value of - 600
Report s
1 indicat es no limit .

Wait t ime f or prompt answers S pecif y t he maximum t ime t o wait 600

629 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

f or a prompt t o be answered by t he
user in seconds. I f t he user f ails t o
(sec)
answer t he prompt in t he specif ied
t ime limit , t he job is cancelled.

S pecif y t he maximum t ime f or

warehouse jobs t o be execut ed by
I nt elligence S erver. Jobs last ing
Warehouse execut ion t ime (sec) 3600
longer t han t his set t ing are
cancelled. A value of 0 or -1
indicat es inf init e t ime.

S pecif y t he maximum number of

rows t hat can be ret urned t o
I nt elligence S erver f or a report
request , which includes int elligent
cubes. When ret rieving t he result s
f rom t he dat abase, t he Query
I nt elligent Cubes 32, 000
E ngine applies t his set t ing. I f t he
number of rows in a report exceeds
t he specif ied limit , t he report
generat es an error and t he report
is not displayed. A value of 0 or -1
Final Result indicat es no limit .
Rows
S pecif y t he maximum number of
rows t hat can be ret urned t o
I nt elligence S erver f or a dat a mart
report request . When ret rieving t he
result s f rom t he dat abase, t he
Dat a mart s Query E ngine applies t his set t ing. 32, 000
I f t he number of rows in a report
exceeds t he specif ied limit , t he
report generat es an error and t he
report is not displayed. The def ault
value of -1 indicat es no limit .

© 2019, M icr o St r at egy In c. 630

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

S pecif y t he maximum number of

rows t hat can be ret urned t o
I nt elligence S erver f or a document
or dossier request . When
ret rieving t he result s f rom t he
dat abase, t he Query E ngine
Document / Dossier
applies t his set t ing. I f t he number 50, 000, 000
views
of rows in a document or dossier
exceeds t he specif ied limit , an
error is displayed and no result s
are shown f or t he document or
dossier. A value of 0 or -1
indicat es no limit .

S pecif y t he maximum number of

rows t hat can be ret urned t o
I nt elligence S erver f or all ot her
report request s. When ret rieving
t he result s f rom t he dat abase, t he
A ll ot her report s Query E ngine applies t his set t ing. 32, 000
I f t he number of rows in a report
exceeds t he specif ied limit , t he
report generat es an error and t he
report is not displayed. A value of
0 or -1 indicat es no limit .

Limit s t he number of rows t hat can

be in an int ermediat e result set
used f or analyt ical processing.
This is not t he number of rows t hat
A ll
may be creat ed in an int ermediat e
int ermediat e 32, 000
or t emporary t able on t he
result rows
dat abase. I nt elligence S erver uses
int ermediat e t ables f or all analyt ic
calculat ions t hat cannot be done
on t he dat abase. V alues of 0 and -

631 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

1 indicat e no limit .

S pecif y t he maximum number of

rows t hat can be part of t he
int ermediat e result set when
combining dat aset s t o creat e t he
view of dat a f or a document or
Document / Dossier
dossier. I f t he number of rows in a 50, 000, 000
views
document or dossier exceeds t he
specif ied limit , an error is
displayed and no result s are shown
f or t he document or dossier. A
value of 0 or -1 indicat es no limit .

Limit s t he number of rows t hat can

be ret rieved f rom t he dat abase f or
an at t ribut e element request .
V alues of 0 and -1 indicat e no
limit . B ot h MicroS t rat egy
Developer and MicroS t rat egy Web
have t he abilit y t o increment ally
f et ch element rows f rom
A ll element browsing rows I nt elligence S erver. This set t ing -1
f or Developer is in t he P roject
Conf igurat ion E dit or (P roject
def init ion cat egory: A dvanced
subcat egory); Web uses a General
project def ault set t ing f or
increment al f et ch called Maximum
number of at t ribut e element s per
block.

Limit s t he memory consumpt ion

Memory consumpt ion during S QL during S QL generat ion. This

set t ing can be usef ul if you have 2, 000
generat ion (MB )
jobs t hat may be ext remely large,

© 2019, M icr o St r at egy In c. 632

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

f or example, when several highly

complex cust om groups exist on a
report . When you use t his set t ing,
if t he job is t oo big, t he job is
prevent ed f rom execut ing rat her
t han t he server becoming
unavailable. S et t he limit
according t o t he expect ed number
of S QL queries generat ed t o avoid
memory-relat ed errors. A value of
0 or -1 indicat es no limit .

Limit s t he memory consumpt ion

during t he import ing of dat a f rom
dat a sources such as web services
Memory consumpt ion during dat a or E xcel spreadsheet s. When you
2048
f et ching (MB ) use t his set t ing, if a dat a source is
t oo large, t he dat a is not import ed.
A value of -1 indicat es no limit . A
value of 0 or -1 indicat es no limit .

Limit s t he f ile size, in megabyt es,

when downloading a dossier f rom
MicroS t rat egy Web. I f a dossier is
larger t han t he specif ied f ile size,
an error is displayed t hat provides
t he current limit , and t he dossier is
not downloaded. A ddit ionally, t his
MicroS t rat egy (. mst r) f ile size
set t ing applies t o dossiers sent 100
(MB )
t hrough Dist ribut ion S ervices. I f a
dossier is larger t han t he specif ied
size, t he dossier is not sent . A
value of -1 indicat es no limit . A
value of 0 prevent s t he abilit y t o
download a dossier f rom Web and
t o dist ribut e a dossier t hrough

633 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

Dist ribut ion S ervices. The

maximum . mst r f ile size is 2047
MB .

Go ver n in g Ru les - Def au lt - Jo b s

Defau lt
Settin g Descrip tio n
Valu e

Limit s t he number of concurrent jobs f or a given

user account and project . Concurrent jobs include
report , element , and aut oprompt request s t hat are
Jobs per account 100
execut ing or wait ing t o execut e. Finished (open)
jobs, cached jobs, or jobs t hat ret urned errors are
not count ed. A value of -1 indicat es no limit .

Limit s t he number of concurrent jobs a user may

have during a given session. Concurrent jobs
include report , element , and aut oprompt request s
Jobs per user
t hat are execut ing or wait ing t o execut e. Finished 100
session
(open) jobs, cached jobs, or jobs t hat ret urned
errors are not count ed. A value of -1 indicat es no
limit .

Limit s t he number of concurrent jobs a single user

account may have execut ing in t he project at one
E xecut ing jobs per t ime. I f t his limit is met , addit ional jobs are placed
-1
user in t he wait ing queue unt il execut ing jobs f inish. A ll
request s are processed in t he order t hey are
received. A value of -1 indicat es no limit .

Jobs Limit s t he number of concurrent jobs t hat t he

per project can process at a t ime. Concurrent jobs 1, 000
project include report , element , and aut oprompt request s

© 2019, M icr o St r at egy In c. 634

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

t hat are execut ing or wait ing t o execut e. Finished

(open) jobs, cached jobs, or jobs t hat ret urned
errors are not count ed. A value of -1 indicat es no
limit .

I nt eract ive S pecif y t he maximum number of int eract ive jobs

jobs per t hat t he select ed project processes at a t ime. The 600
project def ault value of -1 indicat es no limit .

S cheduled S pecif y t he maximum number of scheduled jobs

jobs per t hat t he select ed project processes at a t ime. The 400
project def ault value of -1 indicat es no limit .

Go ver n in g Ru les - Def au lt - User Sessio n s

Defau lt
Settin g Descrip tio n
Valu e

Limit s t he number of user sessions (connect ions) t hat are

allowed in t he project . When t he limit is reached, new
User
users cannot log in, except f or t he administ rat or, who may
sessions per 500
wish t o disconnect current users or increase t he governing
project
set t ing. A value of -1 indicat es no limit . S ee Governing
C onc urrent U s ers f or st eps t o conf igure t his set t ing.

Concurrent
int eract ive Limit s t he number of concurrent int eract ive project
project sessions f or a given user account . When t he limit is 20
session per reached, users cannot access new project sessions.
user

635 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Go ver n in g Ru les - Def au lt - Su b scr ip t io n s

Defau lt
Settin g Descrip tio n
Valu e

Limit s t he number of report or document execut ion request s

t hat a user can subscribe t o, t o be delivered t o t he Hist ory List
Hist ory
f older. A value of -1 indicat es no limit . For st eps t o subscribe -1
List
report s/ document s t o be delivered t o a Hist ory List , see Hist ory
List S ubscript ion E dit or.

Cache Limit s t he number of cache updat es t hat a user can process at

-1
Updat e a t ime. A value of -1 indicat es no limit .

Limit s t he number of report s or document s t hat a user can

E mail send t o an email address at a t ime. A value of -1 indicat es no -1
limit .

Limit s t he number of f iles t hat a user can subscribe t o at a

File -1
t ime. A value of -1 indicat es no limit .

Limit s t he number of report s/ document s t hat t he user can

FTP subscribe t o, t o be delivered t o an FTP locat ion, at a t ime. A -1
value of -1 indicat es no limit .

Limit s t he number of report s/ document s t hat t he user can

P rint subscribe t o, t o be delivered t o a print er, at a t ime. A value of - -1
1 indicat es no limit .

Limit s t he number of report s or document s t he user can

Mobile -1
subscribe t o, t o be delivered t o a mobile device, at a t ime.

P ersonal Limit s t he number of personal views t hat can be creat ed by

-1
V iew URL sharing. A value of -1 indicat es no limit .

© 2019, M icr o St r at egy In c. 636

Syst em Ad m in ist r at io n Gu id e

Go ver n in g Ru les - Def au lt - Imp o r t Dat a

Defau lt
Settin g Descrip tio n
Valu e

The maximum size f or a f ile t o be import ed

f or use as a dat a source. Files larger t hat t his
value cannot be opened during dat a import .
The def ault value is 100 MB , t he minimum
Maximum f ile size value is 1 MB , and t he maximum value is as
30
(MB ) f ollows:

Files f rom disk: 4 GB

Ot her sources: Dependent on I nt elligence

S erver

Def ines t he maximum size of all dat a import

cubes f or each individual user regardless of
whet her t hey are published t o memory or on
disk. Y ou can set t he maximum size quot a by
ent ering one t he f ollowing values:

-1: Unlimit ed - No limit is placed on t he size

of dat a import cubes f or each user.
Maximum quot a per
100
user (MB ) 0: Def ault - The def ault size limit of 100 MB
is applied t o each user.

1+ : S pecif ic limit - E nt ering a value of 1 or

great er will apply a MB limit of t hat size t o
each user.

I n a clust ered environment t his set t ing

applies t o all nodes in t he clust er.

E nable t his checkbox t o allow users t o import

E nable Unchecked
f iles f rom t he I nt ernet using a URL.
URL
f ile A llow users t o import dat a f rom t he I nt ernet
HTTP / HTTP S Unchecked
upload by connect ing t o an HTTP or HTTP S URL.
via
FTP A llow users t o import dat a f rom t he I nt ernet Unchecked

637 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

by connect ing t o an FTP (File Transf er

P rot ocol) S erver.

A llow users t o import dat a f rom f iles on your

I nt elligence S erver machine. Warning:
E nabling t his opt ion can provide users t he
File Unchecked
abilit y t o import any crit ical or syst em f iles
t hat are st ored on your I nt elligence S erver
machine.

Cach in g - Resu lt Cach es - Cr eat io n

Defau lt
Settin g Descrip tio n
Valu e

I f t his opt ion is enabled, you can

modif y t he f ollowing:
E nable report
Checked
server caching E nable prompt ed report caching

E nable non-prompt ed report caching

E nable Document S elect t his checkbox t o enable

Out put Caching in document out put caching in various Checked
S elect ed Format s f ormat s.
P roject
Def ault S elect t o enable document caching f or
P DF Checked
B ehavior P DF document s.

S elect t o enable document caching f or

E xcel Checked
E xcel document s.

S elect t o enable document caching f or

HTML Checked
HTML document s.

S elect t o enable document caching f or

X ML/ Flash/ HTML5 Checked
X ML/ Flash/ HTML5 document s.

© 2019, M icr o St r at egy In c. 638

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

S elect t o enable document caching f or

A ll Checked
all document f ormat s.

S elect t his checkbox t o enable caching

f or report s and document s t hat cont ain
prompt s. I f your users commonly
E nable caching f or answer prompt ed report s wit h dif f erent
prompt ed report s answers each t ime t he report is run, Checked
and document s caching t hese report s and document s
may not provide signif icant benef it s. I n
t his case, you may want t o disable t his
set t ing.

Record prompt S elect t his checkbox t o display t he

answers f or cache answers t o prompt s in cached report s Checked
monit oring in t he Cache Monit or.

S elect t his checkbox t o enable X ML

caching f or report s. X ML caching
st ores t he at t ribut es t o which all users
in Web can drill in t he report ’s X ML
cache.
E nable X ML
Not e: I f you select t he E nable Web Checked
caching f or report s
personalized drill pat hs checkbox f rom
t he P roject def init ion Drilling cat egory,
X ML caching is disabled, which may
adversely impact MicroS t rat egy Web
perf ormance.

Det ermine what cache creat ion is

Creat e caches per
based on: by user, by dat abase login, Unchecked
Cache user
and/ or by dat abase connect ion.
Creat ion
Opt ions Det ermine what cache creat ion is
Creat e caches per
based on: by user, by dat abase login, Unchecked
dat abase login
and/ or by dat abase connect ion.

639 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

I mport ant : I f you use dat abase

aut hent icat ion, f or securit y reasons
MicroS t rat egy recommends select ing
t he Creat e caches per dat abase login
checkbox. Doing t his ensures t hat
users who execut e t heir report s using
dif f erent dat abase login I Ds cannot use
t he same cache.

Creat e caches per Det ermine what cache creat ion is

dat abase based on: by user, by dat abase login, Unchecked
connect ion and/ or by dat abase connect ion.

Cach in g - Resu lt Cach es - St o r age

Settin g Descrip tio n Defau lt Valu e

Cache f ile Navigat e t o t he direct ory you want t o .\Caches\SERVER_

direct ory use f or cache f iles. DEFINITION_NAME\

Disk Cache
S t orage I f you need t o encrypt t he cache f iles,
encrypt ion
set t he level of encrypt ion using t his None
level on
drop-down list .
disk

Def ine t he maximum RA M usage (in

megabyt es) f or report caching. This
Dat aset s -
set t ing needs t o be at least t he size of
Maximum
t he largest cache f ile, or t he largest
RA M 256
Memory report caches will not be used. The
usage
S t orage minimum value f or t his set t ing is 20
(MB )
megabyt es, and t he maximum value is
65536 megabyt es, or 64 gigabyt es.

Dat aset s - Def ine t he maximum number of caches 10, 000

© 2019, M icr o St r at egy In c. 640

Syst em Ad m in ist r at io n Gu id e

Settin g Descrip tio n Defau lt Valu e

allowed in t he project at one t ime.

Not e: The def ault value f or t he

maximum number of caches is 10, 000.
Maximum The maximum value t hat you can set is
number of 999, 999. I f you ent er any posit ive
caches value great er t han 999, 999, t he value
set s it self t o 1, 000, 000. I f you ent er ?,
I nt elligence S erver uses t he def ault
value.

Def ine t he maximum RA M usage (in

Format t ed megabyt es) f or report caching. This
Document s set t ing needs t o be at least t he size of
- Maximum t he largest cache f ile, or t he largest
4096
RA M report caches will not be used. The
usage minimum value f or t his set t ing is 20
(MB ) megabyt es, and t he maximum value is
65536 megabyt es, or 64 gigabyt es.

Def ine t he maximum number of caches

allowed in t he project at one t ime.

Format t ed Not e: The def ault value f or t he

Document s maximum number of caches is

- Maximum 100, 000. The maximum value t hat you 100, 000
number of can set is 999, 999. I f you ent er any

caches posit ive value great er t han 999, 999,

t he value set s it self t o 1, 000, 000. I f
you ent er ?, I nt elligence S erver uses
t he def ault value.

This set t ing cont rols how much

memory is swapped t o disk, relat ive t o
RA M swap t he size of t he cache being swapped
2
mult iplier int o memory. For example, if t he RA M
swap mult iplier set t ing is 2 and t he
request ed cache is 80 K ilobyt es, 160

641 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Settin g Descrip tio n Defau lt Valu e

K ilobyt es are swapped f rom memory

t o disk. I ncreasing t his set t ing can
increase caching ef f iciency in cases
where t he cache memory is f ull and
several concurrent report s are t rying t o
swap f rom disk.

This set t ing det ermines what

percent age of t he amount of memory
specif ied in t he Maximum RA M usage
limit s can be used f or result cache
lookup t ables. I f your report s and
document s cont ain many prompt
Maximum
answers, t he cache lookup t able may
RA M f or
reach t his limit . A t t his point ,
report 100
I nt elligence S erver no longer creat es
caches
new caches. To cont inue creat ing new
index (% )
caches, you must eit her remove
exist ing caches t o f ree up memory f or
t he cache lookup t able, or increase
t his limit . The def ault value f or t his
set t ing is 100% , and t he values can
range f rom 10% t o 100% .

When t his set t ing is enabled

Load (select ed), when I nt elligence S erver
caches on st art s up it will load report caches Checked
st art up f rom disk unt il t he maximum RA M
usage f or cache has been reached.

© 2019, M icr o St r at egy In c. 642

Syst em Ad m in ist r at io n Gu id e

Cach in g - Resu lt Cach es - Main t en an ce

Defau lt
Settin g Descrip tio n
Valu e

Causes caches t o never aut omat ically expire.

MicroS t rat egy recommends select ing t he Never expire

caches checkbox, inst ead of using use t ime-based result
cache expirat ion. A cache is dependent on t he result s in
your dat a source and should only be invalidat ed when

Never expire t he event s occur t hat result in t he cache no longer being

valid. For example, f or a daily report , t he cache may Checked
caches
need t o be delet ed when t he dat a warehouse is loaded.
For weekly report s, you may want t o delet e t he cache
and recreat e it at t he end of each week. I n product ion
syst ems, cache invalidat ion should be driven by event s
such as Warehouse Load or E nd Of Week, not short -
t erm t ime-based occurrences such as 24 hours.

S elect t he number of hours t hat a report cache should

exist bef ore it expires.

Not e: When a cache is updat ed, t he current cache

Cache lif et ime is used t o det ermine t he cache expirat ion dat e

durat ion based on t he last updat e t ime of t he cache. This means 24

(hours) t hat changing t he Cache durat ion (Hours) set t ing or t he
Never E xpire Caches set t ing does not af f ect t he
expirat ion dat e of t he already exist ing caches. I t only
af f ect s t he new caches t hat are being or will be
processed.

Do not apply B y def ault , t he caches f or report s are based on f ilt ers
aut omat ic t hat use dynamic dat es. These caches always expire at
expirat ion midnight of t he last day in t he dynamic dat e f ilt er.
logic f or For example, a report has a f ilt er based on t he dynamic Unchecked
report s dat e Today. I f t his report is execut ed on Monday, t he
cont aining cache f or t his report expires at midnight on Monday.
dynamic This is because a user who runs t he report on Tuesday
dat a expect s t o view dat a f rom Tuesday, not t he cached dat a

643 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

f rom Monday.

To change t he def ault behavior, select t he Do not A pply

A ut omat ic E xpirat ion Logic f or report s cont aining
dynamic dat es checkbox. When t his set t ing is enabled,
report caches wit h dynamic dat es expire in t he same
way as ot her report caches, according t o t he ot her
cache durat ion set t ings.

Click P urge Now t o ensure t hat a re-run report displays

P urge
t he most recent dat a st ored in your dat a source, you Unclicked
Caches
should purge caches regularly.

Cach in g - Au xiliar y Cach es - Ob ject s

Defau lt
Settin g Descrip tio n
Valu e

S et t he maximum RA M usage (MB ) f or object

caching f or t he server. The object cache is non-
Maximum
schema met adat a inf ormat ion used by I nt elligence
RA M
S erver t o speed t he ret rieval of object s f rom t he 1024
usage
met adat a. A value of -1 indicat es t he def ault value
S erver (MB )
of 50 megabyt es. A value of 0 reset s t o t he
minimum value of 1 megabyt e.

P urge
Object Click P urge Now t o delet e all object caches. Unclicked
Cache

S et t he maximum RA M usage (MB ) f or object

caching f or t he client . The object cache is non-
Maximum
schema met adat a inf ormat ion used by I nt elligence
RA M
Client S erver t o speed t he ret rieval of object s f rom t he 10
usage
met adat a. A value of -1 indicat es t he def ault value
(MB )
of 50 megabyt es. A value of 0 reset s t o t he
minimum value of 1 megabyt e.

© 2019, M icr o St r at egy In c. 644

Syst em Ad m in ist r at io n Gu id e

Cach in g - Au xiliar y Cach es - Elemen t s

Defau lt
Settin g Descrip tio n
Valu e

S et t he maximum RA M usage (MB ) f or element

caching f or t he server. The E lement cache is
st ored in memory or in a cache f ile locat ed on t he
Maximum I nt elligence S erver. I f t he E lement cache
RA M usage memory set t ing is not large enough t o hold a 512
(MB ) newly creat ed cache, t hat cache is not creat ed.
E ven t hough t he cache may have been purged on
t he I nt elligence S erver machine, it may st ill be
creat ed on t he Developer client machine.

S elect t his checkbox t o creat e element caches f or

Creat e each passt hrough login. I f you use dat abase
element aut hent icat ion, f or securit y reasons
S erver caches per MicroS t rat egy recommends select ing t his Checked
passt hrough checkbox. This ensures t hat users who execut e
login t heir report s using dif f erent pass-t hrough login
I Ds do not use t he same cache.

S elect t his checkbox t o creat e caches per

Creat e
connect ion map. Use t his set t ing if connect ion
caches per
mapping is used. S ee C ontrolling Acc ess to the Checked
connect ion
D atabas e: C onnec tion Mappings f or more
map
inf ormat ion.

P urge
element Click P urge Now t o delet e all element caches. Unclicked
caches

S et t he maximum RA M usage (MB ) f or element

caching f or t he client . The E lement cache is
Maximum st ored in memory or in a cache f ile locat ed on t he
Client RA M usage I nt elligence S erver. I f t he E lement cache 1
(MB ) memory set t ing is not large enough t o hold a
newly creat ed cache, t hat cache is not creat ed.
E ven t hough t he cache may have been purged on

645 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

t he I nt elligence S erver machine, it may st ill be

creat ed on t he Developer client machine.

Cach in g - Su b scr ip t io n Execu t io n

Defau lt
Settin g Descrip tio n
Valu e

Re-run hist ory

S elect t his checkbox t o creat e caches or updat e
list and mobile
exist ing caches when a report or document is
subscript ions Unchecked
execut ed and t hat report / document is subscribed t o
against t he
t he Hist ory List f older or a mobile device.
warehouse

Re-run, f ile,
email, print , or S elect t his checkbox t o creat e caches or updat e
FTP exist ing caches when a report or document is
Unchecked
subscript ions execut ed and t hat report / document is subscribed t o
against t he a f ile, email, or print device
warehouse

S elect t his checkbox t o prevent t he subscript ion

Do not creat e or f rom creat ing or updat ing Mat ching caches. I f t his
updat e mat ching checkbox is cleared, Mat ching caches are creat ed Unchecked
caches or updat ed as per t he st andard report or document
caching rules.

K eep document
available f or
S elect t his checkbox t o ret ain a document or report
manipulat ion f or
f or lat er manipulat ion t hat was delivered t o t he Checked
Hist ory List
Hist ory List f older.
S ubscript ions
only

© 2019, M icr o St r at egy In c. 646

Syst em Ad m in ist r at io n Gu id e

In t elligen t Cu b es - Gen er al

Settin g Descrip tio n Defau lt Valu e

S pecif ies t he f ile locat ion in which

I nt elligent Cubes are st ored when you
select t o save an I nt elligent Cube t o
secondary st orage. A long wit h st oring
I nt elligent Cubes in I nt elligence S erver
.\Cube\SERVER_
I nt elligent Cube f ile memory, you can st ore t hem in
DEFINITION_
direct ory secondary st orage, such as a hard disk.
NAME\
These I nt elligent Cubes can t hen be
loaded f rom t his secondary st orage int o
I nt elligence S erver memory when report s
require access t o t he I nt elligent Cube
dat a.

Def ines t he amount of dat a required f or

all I nt elligent Cubes t o limit t he amount
of I nt elligent Cube dat a st ored in
I nt elligence S erver memory at one t ime
f or a project . The def ault is 256
megabyt es.
Maximum RA M usage
The t ot al amount of memory used on
(MB ) 256
I nt elligence S erver by I nt elligent Cubes
f or a project is calculat ed and compared
t o t he limit you def ine. I f an at t empt t o
load an I nt elligent Cube is made t hat
would exceed t his limit , an I nt elligent
Cube is removed f rom I nt elligence S erver
memory bef ore t he new I nt elligent Cube
is loaded int o memory.

Def ines t he limit of how many I nt elligent

Maximum number of Cubes are st ored in I nt elligence S erver
cubes memory at one t ime f or a project .
1, 000
The t ot al number of I nt elligent Cubes f or
a project t hat are st ored in I nt elligence

647 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Settin g Descrip tio n Defau lt Valu e

S erver memory is compared t o t he limit

you def ine. I f an at t empt t o load an
I nt elligent Cube is made t hat would
exceed t he limit , an I nt elligent Cube is
removed f rom I nt elligence S erver
memory bef ore t he new I nt elligent Cube
is loaded int o memory.

Def ines t he maximum cube size, in

megabyt es, t hat can be downloaded f rom
I nt elligence S erver. A ddit ionally, t his
Maximum cube size
value is used by Dist ribut ion S ervices
allowed f or download 100
when sending an . mst r f ile by email. I f
(MB )
t he cube size is great er t han t he
specif ied value, t he . mst r f ile will not be
sent by email.

Def ines t he maximum t hat indexes are

allowed t o add t o t he I nt elligent Cube’s
size, as a percent age of t he original size.
Maximum % growt h For example, a set t ing of 50 percent
of an I nt elligent Cube def ines t hat a 100 MB I nt elligent Cube 500
due t o indexes can grow t o 150 MB due t o it s indexes. I f
t he I nt elligent Cube’s size exceeds t his
limit , t he least -used indexes are dropped
f rom t he I nt elligent Cube.

Def ines, in minut es, how of t en t he

Cube growt h check I nt elligent Cube’s size is checked and, if
30
f requency (minut es) necessary, how of t en t he least -used
indexes are dropped.

S elect t his checkbox t o def ine your

Creat e I nt elligent I nt elligent Cubes t o use and support
Cubes by dat abase connect ion mapping. I f you do not def ine
connect ion Unchecked
I nt elligent Cubes t o support connect ion
mapping when connect ion mapping is
used in a project , users may be able t o

© 2019, M icr o St r at egy In c. 648

Syst em Ad m in ist r at io n Gu id e

Settin g Descrip tio n Defau lt Valu e

access dat a t hey are not int ended t o

have access t o.

When an I nt elligent Cube t hat support s

connect ion mapping is published, it uses
t he connect ion mapping of t he user
account t hat published t he I nt elligent
Cube. Only users t hat have t his
connect ion mapping can creat e and view
report s t hat access t his I nt elligent Cube.
This maint ains t he dat a access securit y
and cont rol def ined by your connect ion
mappings.

I f an I nt elligent Cube needs t o be

available f or mult iple connect ion
mappings, you must publish a separat e
version of t he I nt elligent Cube f or each
of t he required connect ion mappings.

S elect t his checkbox t o include t he

process of loading all published
I nt elligent Cubes as one of t he t asks
complet ed when I nt elligence S erver is
st art ed. Report runt ime perf ormance f or
report s accessing I nt elligent Cubes is
opt imized because t he I nt elligent Cube

Load I nt elligent f or t he report has already been loaded.

Cubes on st art up However, t he overhead experienced

Checked
during I nt elligence S erver st art up is
increased because of t he processing of
loading I nt elligent Cubes.

Y ou can clear t his checkbox t o exclude

t he process of loading all published
I nt elligent Cubes as one of t he t asks
complet ed when I nt elligence S erver is
st art ed. The overhead experienced during

649 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Settin g Descrip tio n Defau lt Valu e

I nt elligence S erver st art up is decreased

as compared t o including loading
I nt elligent Cubes as part of t he st art up
t asks. However, report runt ime
perf ormance f or report s accessing
I nt elligent Cubes can be negat ively
af f ect ed because t he I nt elligent Cube
must f irst be loaded int o I nt elligence
S erver. To avoid t hese report
perf ormance issues, you can load
I nt elligent Cubes manually or wit h
subscript ions af t er I nt elligence S erver is
st art ed.

A ll report s t hat access I nt elligent Cubes

allow you t o drill wit hin t he dat a included
in an I nt elligent Cube. This provides
ROLA P -t ype analysis wit hout having t o
re-execut e against t he dat a warehouse.
For example, an I nt elligent Cube
includes Y ear and Quart er. A report
accessing t he I nt elligent Cube includes
only Y ear on t he report . On t he report ,
A llow report s t o drill you can drill down f rom Y ear t o Quart er,
out side t he which ret urns t he result s wit hout any
I nt elligent Cube ext ra load on t he dat a warehouse or Unchecked
I nt elligence S erver.

The decision t o enable or disable drilling

out side an I nt elligent Cube depends on
several f act ors. Y ou should consider t he
size and complexit y of your I nt elligent
Cubes when deciding whet her t o enable
drilling out side an I nt elligent Cube.
E nabling drilling out side relat ively small
I nt elligent Cubes can give t he benef it of
ROLA P analysis t hrough drilling, but

© 2019, M icr o St r at egy In c. 65 0

Syst em Ad m in ist r at io n Gu id e

Settin g Descrip tio n Defau lt Valu e

enabling t his analysis on relat ively large

I nt elligent Cubes can put increased load
on your dat a warehouse and I nt elligence
S erver. S ee t he In-memory Analytics
Guide f or st eps t o def ine t he drilling
behavior of I nt elligent Cubes.

S elect t his checkbox t o load I nt elligent

Cubes int o I nt elligence S erver memory
when t he I nt elligent Cube is published.
I nt elligent Cubes must be loaded int o
Load I nt elligent I nt elligence S erver memory t o allow
Cubes int o report s t o access and analyze t heir dat a.
I nt elligence S erver
To conserve I nt elligence S erver memory, Checked
memory upon
clear t his checkbox t o def ine I nt elligent
publicat ion
Cubes t o be st ored in secondary st orage
only when published. The I nt elligent
Cube can t hen be loaded int o I nt elligence
S erver memory manually, using
schedules, or whenever a report at t empt s
t o access t he I nt elligent Cube.

S elect t his checkbox t o enable dynamic

E nable
sourcing f or t he ent ire project , or clear
Dynamic Checked
t his checkbox t o disable dynamic
S ourcing
sourcing f or t he ent ire project .

Make
I nt elligent
Dynamic S elect t his checkbox t o enable dynamic
Cubes
S ourcing sourcing f or all I nt elligent Cubes in a
available
project . To disable dynamic sourcing as Unchecked
f or
t he def ault behavior f or all I nt elligent
Dynamic
Cubes in a project , clear t his checkbox.
S ourcing
by def ault

A llow S elect t his checkbox t o make I nt elligent Unchecked

65 1 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Settin g Descrip tio n Defau lt Valu e

Dynamic
S ourcing Cubes available f or dynamic sourcing
even if even if some out er join propert ies are not
out er join set . However, t his may cause incorrect
propert ies dat a t o be shown in report s t hat use
are not dynamic sourcing.
set

St at ist ics - Gen er al

Defau lt
Settin g Descrip tio n
Valu e

The st at ist ics dat abase is list ed in t he

S t at ist ics Connect ion f ield. Y ou set t he
st at ist ics dat abase inst ance in t he
S t at ist ics Connect ion < None>
P roject Conf igurat ion E dit or: Dat abase
I nst ances cat egory, S t at ist ics
subcat egory.

User session and project session

B asic st at ist ics analysis. This opt ion must be select ed Unchecked
f or any st at ist ics t o be logged.

Report job Det ailed st at ist ics on t he processing of

Unchecked
st eps each report .

Document job Det ailed st at ist ics on t he processing of

Unchecked
A dvanced st eps each document .
S t at ist ics
Collect ions The generat ed S QL f or all report jobs.

Opt ions Report job Warning: This opt ion can creat e a very
Unchecked
S QL large st at ist ics t able. S elect t his opt ion
only when you need t he job S QL dat a.

Report job Dat a warehouse t ables and columns Unchecked

© 2019, M icr o St r at egy In c. 65 2

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

t ables/ columns
accessed by each report .
accessed

Det ailed st at ist ics on report s and

Mobile Client s document s t hat are execut ed on a Unchecked
mobile device.

S t at ist ics on report s and document

Mobile Client s users execut ed on mobile client s as a
Unchecked
Manipulat ions result of a manipulat ion of t he report or
document .

Mobile Client s Locat ion inf ormat ion logged f rom a

Unchecked
Locat ion mobile client .

St at ist ics - Pu r ge

Defau lt
Settin g Descrip tio n
Valu e

The
beginning
dat e of t he Today
From dat e range minus one
f or which t o year
purge

S elect dat es st at ist ics.

The end dat e

of t he dat e
range f or
To Today
which t o
purge
st at ist ics.

65 3 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

The number
of seconds t o
wait f or t he
purge
process t o
f inish. I f t he
process does
not respond
by t he end of
t his t ime, a
P urge t imeout (seconds) t imeout f or 10
t he process
occurs, and
t he syst em
does not
cont inue t o
t ake up
syst em
resources
t rying t o st art
t he process.

Y ou can
select t he
cat egories of
st aging
A dvanced > > Unselect ed
st at ist ics t o
be purged f or
t he select ed
period:

S t art s t he
P urge Now purge Unclicked
process.

© 2019, M icr o St r at egy In c. 65 4

Syst em Ad m in ist r at io n Gu id e

Pr o ject Access - Gen er al

Defau lt
Settin g Descrip tio n
Valu e

S elect a
securit y
role f rom Use t his drop-down list t o view exist ing securit y roles and
E mpt y
t he t o assign a securit y role t o a group or t o individual users.
f ollowing
list

Use t his drop-down list t o select t he groups or users or bot h

A vailable you want t o assign a securit y role t o. To search f or a group
E mpt y
members or user name, t ype a name int o t he Find f ield and click t he
Filter but t on next t o t he Find f ield.

S how S elect t his checkbox t o display user names in a select ed

Unchecked
users group.

This box displays any user or group t hat has t he select ed

securit y role assigned t o t hem. Y ou can assign securit y
S elect ed
roles by using t he right arrow t o move users and groups E mpt y
members
f rom t he A vailable members box on t he lef t t o t he S elect ed
members box on t he right .

Secu r it y Filt er - Gen er al

Defau lt
Settin g Descrip tio n
Valu e

Click Modif y t o open t he S ecurit y Filt er

S ecurit y Filt er Manager. From t his manager you can assign
E mpt y
Manager securit y f ilt ers t o groups or individual users and
modif y a securit y f ilt er's def init ion.

S ecurit y Union (OR) B y def ault , MicroS t rat egy merges relat ed
S ecurit y securit y f ilt ers wit h OR and unrelat ed securit y S elect ed
Filt er

65 5 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

Filt ers on f ilt ers wit h A ND. That is, if t wo securit y f ilt ers
relat ed are relat ed, t he user can see all dat a available
at t ribut es, f rom eit her securit y f ilt er. However, if t he
int ersect securit y f ilt ers are not relat ed, t he user can see
(A ND) only t he dat a available in bot h securit y f ilt ers.
S ecurit y Two securit y f ilt ers are considered relat ed if
Filt ers on t he at t ribut es t hat t hey derive f rom belong in
unrelat ed t he same hierarchy, such as Count ry and

Merge at t ribut es Region, or Y ear and Mont h.

Opt ions Y ou can also conf igure I nt elligence S erver t o

always merge securit y f ilt ers wit h an A ND,
regardless of whet her t hey are relat ed. This
I nt ersect
set t ing may cause problems if a user is
(A ND) all
included in t wo mut ually exclusive securit y Unselect ed
S ecurit y
f ilt ers. For example, a user who is a member of
Filt ers
bot h t he Nort heast and S out heast regions
cannot see any dat a f rom t he Geography
hierarchy.

Rep o r t Def in it io n - SQL Gen er at io n

Defau lt
Settin g Descrip tio n
Valu e

Click Modif y t o open t he A t t ribut e weight s

dialog box. Here you can def ine at t ribut e
A t t ribut e weight s E mpt y
weight s t o be used when creat ing a
t emporary t able index.

Click Cat alog Opt ions t o open t he Warehouse

Warehouse cat alog cat alog dialog box. Conf igure opt ions f or t he E mpt y
Warehouse Cat alog.

© 2019, M icr o St r at egy In c. 65 6

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

Click A t t ribut e Opt ions t o open t he A t t ribut e

A t t ribut e creat ion Creat ion Rules dialog box . S et t he def ault E mpt y
behavior f or at t ribut e creat ion dialogs.

Click Fact Opt ions t o open t he Fact Creat ion

Fact creat ion Rules dialog box. S et t he def ault behavior f or E mpt y
f act creat ion dialogs.

Det ermine whet her t he syst em should Check

Cust om column
f or invalid charact ers and name lengt h in Checked
creat ion
cust om column names.

I f dat a is available in mult iple dat a sources

t hrough Mult iS ource Opt ion, t he primary
dat abase inst ance is used if it has t he
necessary dat a. I f t he dat a is only available in
ot her secondary dat a sources, one of t he
Use secondary dat a sources t hat includes t he dat a
Mult isource is used t o ret rieve t he necessary dat a using
Opt ion some basic int ernal logic. A ny dat a source S elect ed
def ault priorit y you def ined using Dat abase I nst ance
ordering Ordering is ignored.

Dat abase B y select ing t his opt ion, t his Mult iS ource
I nst ance Opt ion def ault ordering is used f or all report s
Ordering in a project . Y ou can enable or disable t he
use of t his ordering f or individual report s.

I f dat a is available in mult iple dat a sources

t hrough Mult iS ource Opt ion, t he dat a source
Use project used t o ret rieve t he dat a is based of f of t he
level priorit y t hat you def ined using Dat abase
dat abase I nst ance Ordering. I f dat a is only available in Unselect ed
inst ance a dat a source t hat is not included in t he
ordering priorit y list , t hen an applicable dat a source is
chosen using t he st andard Mult iS ource
Opt ion logic.

65 7 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

B y select ing t his opt ion, t he dat a source

priorit y list you def ined f or t he project is used
f or all report s in a project . Y ou can enable or
disable t he use of t his ordering f or individual
report s.

Rep o r t Def in it io n - Nu ll Valu es

Defau lt
Settin g Descrip tio n
Valu e

S et t he
value t o be
displayed
in t he
report s
when t here
is an E mpt y
empt y
value in
t he dat a
ret rieved
Null display
f rom t he
set t ings
warehouse

S et t he
value t o be
displayed
in t he
report s E mpt y
when t here
is an empt y
value in t he
dat a as a

© 2019, M icr o St r at egy In c. 65 8

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

result of
t he cross-
t abulat ion
process

S et t he
value t o be
used in
place of
empt y Unchecked
values
when t he
report dat a
is sort ed

S et t he
value t o be
displayed
in t he
report s
when t he
A ggregat ion
met ric --
null values
value
cannot be
calculat ed
at t he
desired
level

E nt er t he value t o display when an object

on a report or document ref erences an
object t hat is not available. For example, a
Missing Object Display document may use a met ric t hat is not E mpt y
included in a dat aset report . Or an MDX
report may use an at t ribut e t hat is no
longer mapped t o an MDX cube. The t ypes

65 9 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

of object s t hat may encount er t his problem

include MDX report s, Freef orm S QL
report s, views wit hin a working set report ,
and document s.

Rep o r t Def in it io n - Gr ap h

Defau lt
Settin g Descrip tio n
Valu e

Override S elect t his checkbox t o def ine a charact er set and

t he f ont t o override t he def ault s.
def ault
S elect t he charact er set t o be used f or t he new
f ont in
Use graph: S elect a charact er set f rom t he drop-down
t he
graph list . This charact er set overrides t he def ault
graph Unchecked
def ault charact er set when creat ing a new graph.
t emplat e
f ont
when S elect t he f ont t o be used f or t he new graph:
creat ing S elect a f ont f rom t he drop-down list . This f ont
a new overrides t he def ault f ont when creat ing a new
chart graph.

S elect t his checkbox t o display a zero value (0) in

Use zero place of null values when a report is displayed as a
Null inst ead graph. This act s as t he def ault behavior f or all
Unchecked
values of null graph report s in a project . Y ou can also def ine t his
values support f or each individual graph report using t he
Graph P ref erences dialog box.

S elect t he manner in which rounded ef f ect s are

applied t o graph report s in t he project . Y ou can
Rounded E f f ect s t hen def ine whet her rounded ef f ect s are applied S t andard
f or each individual graph report using t he Graph
P ref erences dialog box. Y ou have t he f ollowing

© 2019, M icr o St r at egy In c. 660

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

opt ions f or how rounded ef f ect s are applied t o

graph report s:

< None> : S elect t his opt ion t o disable rounded

ef f ect s f rom being applied t o graph report s in t he
project . E ven if t he individual graph report s are
def ined t o use rounded ef f ect s, no rounded ef f ect s
are used f or t he graph report s. I nst ead of using
t hese rounded ef f ect s, you can def ine bevel and
f ill f ormat t ing f or each individual series marker in
graph report s. Disabling t he rounded ef f ect s can
also allow t hresholds t o be displayed on cert ain
graph t ypes.

S t andard: S elect t his opt ion t o enable t he

st andard rounded ef f ect s t o be applied t o graph
report s in t he project , but disable t hreshold
f ormat t ing f or Horizont al B ar graphs. This is t he
def ault opt ion t o support backward compat ibilit y.
However, you should select Opt imized t o support
bot h rounded ef f ect s and t hreshold f ormat t ing f or
most graph t ypes.

Opt imized: S elect t his opt ion t o enable t he

opt imized rounded ef f ect s t o be applied t o graph
report s in t he project . This applies t he rounded
ef f ect s t o t he graph series, while also keeping any
f ormat t ing t hat was applied t hrough t hresholds f or
graph t ypes such as B ar graphs. However, some
graph t ypes cannot support bot h rounded ef f ect s
and t hresholds. Y ou can support t he display of
t hresholds f or t hose graph t ypes by select ing
< None> t o disable rounded ef f ect s f or all graphs
in a project , or by using t he Graph P ref erences
dialog box t o disable rounded ef f ect s f or individual
graph report s.

661 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Rep o r t Def in it io n - Ad van ced

Defau lt
Settin g Descrip tio n
Valu e

This is
t he
message
t hat will
be
displayed
E mpt y
when t he
report
execut ion
has no
dat a as a
result
No dat a
I f you select t his opt ion, empt y Grid/ Graphs
ret urned
display a message as described below.
Display
I f no t ext is ent ered in t he No dat a ret urned
message
f ield, empt y Grid/ Graphs display t he def ault
in S elect ed
message (No dat a ret urned) in t he localized
document
language.
grids
I f t ext has been ent ered in t he No dat a ret urned
f ield, empt y Grid/ Graphs display t hat t ext .

I f you select t his opt ion, empt y Grid/ Graphs are

Hide
displayed as blank Grid/ Graphs. A ny t ext
document Unselect ed
ent ered in t he No dat a ret urned f ield is not
grid
displayed.

Ret ain
page-by
S elect t his checkbox if you want t o ret ain page-
P age by select ions
by select ions when saving a report in t his Checked
report s when you
project .
save a
report

© 2019, M icr o St r at egy In c. 662

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

(OLA P S ervices only) Det ermine how dif f ering

report versions will be handled f or OLA P
S ervices report s. P revious versions of
MicroS t rat egy client s, such as Web or
Developer, may not display correct f ormat t ing
f or OLA P S ervices report s creat ed or edit ed
and saved in version 9. 0 and lat er. I f your
environment uses a mixt ure of 9. 0 client s and
older client s, select one of t he f ollowing
set t ings t o det ermine how t he syst em should
handle OLA P S ervices report s.

I f a user at t empt s t o save a 9. 0 OLA P S ervices

Overwrit ing report s
report wit h t he same name as an older report , A llow wit h
wit h MicroS t rat egy 9
select one of t he set t ings below t o det ermine a warning
OLA P S ervice
t he out come: message
Report s
A llow wit hout a warning message: The 9. 0
report aut omat ically replaces t he older report ;
t he user is not warned.

A llow wit h a warning message: A warning

message opens. The user can overwrit e t he
older report , or cancel t he save, or change t he
name of t he 9. 0 report so t hat t he older report
is not overwrit t en.

P revent : The user is not allowed t o overwrit e

t he older report , and is prompt ed t o save t he
9. 0 report wit h a dif f erent name.

Move sort When you pivot (move an object bet ween t he

keys wit h rows and t he columns of a report ), t his opt ion
S ort ing Checked
pivot ing det ermines whet her t he pivot ed object ret ains
unit it s sort ing.

663 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Lan gu age - Met ad at a

Defau lt
Settin g s Descrip tio n
Valu e

B ased
S elect t he languages t hat will be available f or t ranslat ions
S elect ed on
of t ext st rings of object s, such as report names,
Languages machine
descript ions, and cust om group element s in t he met adat a.
set t ings

Lan gu age - Dat a

Defau lt
Settin g Descrip tio n
Valu e

The E nable dat a

S QL based
int ernat ionalizat ion
Checked
E nable dat a checkbox allows
wit h
int ernat ionalizat ion users t o t ranslat e
Connect ion mapping S QL based
t he object s in t he
based
select ed project .

S elect t he languages t hat

will be available f or
t ranslat ions of t ext
S elect ed st rings of object s, such B ased on machine S elect ed
Languages as report names, set t ings Languages
descript ions, and cust om
group element s in t he
met adat a.

© 2019, M icr o St r at egy In c. 664

Syst em Ad m in ist r at io n Gu id e

Lan gu age - User Pr ef er en ces

Defau lt
Settin g Descrip tio n
Valu e

Click Modif y t o specif y t he met adat a and

User Language
dat a language f or t his project by individual E mpt y
P ref erences Manager
user.

Met adat a language

S elect t he met adat a language t o be used in
pref erence f or all users in Def ault
t his project .
t his project

Dat a language pref erence S elect t he dat a language t o be used in t his

Def ault
f or all users in t his project project .

Deliver ies - Email Deliver y - Email No t if icat io n

Defau lt
Settin g Descrip tio n
Valu e

S elect t his checkbox t o send a

not if icat ion email t o t he recipient when
t he subscribed report or document is
Checked
delivered t o t he f ile locat ion. I f t his
checkbox is cleared, all ot her opt ions in
E nable email
t his cat egory are disabled.
not if icat ion
to Recipient The MicroS t rat egy user or cont act t hat
Checked
administ rat or name subscribed t o t he delivery.
f or f ailed
Owner name The owner of t he subscript ion. Checked
email
delivery Report or
Name of t he subscribed report or
Document Checked
document .
name

P roject cont aining t he report or

P roject name Checked
document .

665 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

Delivery E mail, f ile, FTP , print , Hist oy List ,

Checked
met hod Cache, or Mobile

The schedule associat ed wit h t he

S chedule Checked
subscript ion.

S ubscript ion
The name of t he subscript ion. Checked
name

Delivery S t at us of t he delivery, such as Complet e,

Checked
st at us Timed Out , or E rror.

Dat e Dat e of t he delivery. Checked

Time Time of t he delivery. Checked

E mail A ddress t o which t he f ailed delivery

Checked
address at t empt ed t o be sent .

E rror The specif ic error message f or a f ailed

Checked
message delivery.

To include a message wit h each cache

A ppend t he
delivery not if icat ion, select t his checkbox Checked
f ollowing t ext
and t ype t he message in t he f ield.

S end
not if icat ion
t o t his
E nt er t he email address of a syst em
administ rat or
administ rat or t o receive a not if icat ion E mpt y
email
email f or t he f ailed cache delivery.
address
when
delivery f ails

© 2019, M icr o St r at egy In c. 666

Syst em Ad m in ist r at io n Gu id e

Deliver ies - Email Deliver y - Co mp r essio n

Defau lt
Settin g Descrip tio n
Valu e

S elect t his checkbox t o compress t he report or

E nable
document t hat is subscribed and delivered t o a f ile Checked
compression
locat ion.

S elect t he level of compression f or t he subscribed report

Level of
or document as High, Medium, or Low f rom t he drop- Medium
compression
down list .

I n t his f ield, specif y t he f ile ext ension f or t he

compressed f iles. The def ault ext ension is ZI P . Report s
or document s are compressed using t he ZI P algorit hm.
E xt ension of Changing t he ext ension does not change t he algorit hm;
compressed it changes only t he f ile ext ension. For example, some zip
f ile net work environment s do not allow f iles wit h t he ZI P
ext ension t o be delivered as email at t achment s. I n
t hese environment s, changing t he f ile ext ension is
necessary f or t he at t achment s t o be delivered.

Deliver ies - Email Deliver y - Email Fo o t er

Defau lt
Settin g Descrip tio n
Valu e

A ppend t he S elect t his checkbox and t ype t he t ext t hat you want t o
f ollowing add as a f oot er in t he email t hat is sent t o email Unchecked
f oot er subscript ion recipient s.

667 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Deliver ies - File Deliver y - Email No t if icat io n

Settin g Descrip tio n Defau lt Valu e

S elect t his
checkbox t o
send a
not if icat ion
email t o t he
recipient when
t he subscribed
report or
Checked
document is
delivered t o t he
f ile locat ion. I f
t his checkbox is
cleared, all
ot her opt ions in
E nable t his cat egory
email are disabled.
not if icat ion
S elect t his
f or f ile
checkbox t o
delivery
send a
S end not if icat ion
not if icat ion email t o t he
t o recipient recipient when Checked
when delivery t he subscribed
f ails report or
document f ails
t o be delivered
on schedule.

The
MicroS t rat egy
Recipient
user or cont act Checked
name
t hat subscribed
t o t he delivery.

© 2019, M icr o St r at egy In c. 668

Syst em Ad m in ist r at io n Gu id e

Settin g Descrip tio n Defau lt Valu e

The owner of
Owner name t he Checked
subscript ion.

Name of t he
Report or
subscribed
Document Checked
report or
name
document

P roject
cont aining t he
P roject name Checked
report or
document

The delivery
met hod of
email, f ile,
Delivery
FTP , print , Checked
met hod
Hist oy List ,
Cache, or
Mobile.

The schedule
associat ed wit h
S chedule Checked
t he
subscript ion.

The name of
S ubscript ion
t he Checked
name
subscript ion.

The st at us of
t he delivery,
Delivery such as
Checked
st at us Complet e,
Timed Out , or
E rror.

Dat e Dat e of t he Checked

669 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Settin g Descrip tio n Defau lt Valu e

delivery

Time of t he
Time Checked
delivery

Locat ion of t he
File locat ion Checked
f ile

Hyperlink t o t he
Link t o f ile Checked
f ile

The specif ic
E rror error message
Checked
message f or a f ailed
delivery.

To include a
message wit h
each cache
delivery
A ppend t he not if icat ion,
Checked
f ollowing t ext select t his
checkbox and
t ype t he
message in t he
f ield.

Type t he email
S end
address of a
not if icat ion
syst em
t o t his
administ rat or t o
administ rat or
receive a E mpt y
email
not if icat ion
address
email f or t he
when
f ailed cache
delivery f ails
delivery.

© 2019, M icr o St r at egy In c. 670

Syst em Ad m in ist r at io n Gu id e

Deliver ies - File Deliver y - Co mp r essio n

Defau lt
Settin g Descrip tio n
Valu e

S elect t his checkbox t o compress t he report or

E nable
document t hat is subscribed and delivered t o a f ile Checked
compression
locat ion.

S elect t he level of compression f or t he subscribed report

Level of
or document as High, Medium, or Low f rom t he drop- Medium
compression
down list .

I n t his f ield, specif y t he f ile ext ension f or t he

compressed f iles. The def ault ext ension is ZI P . Report s
or document s are compressed using t he ZI P algorit hm.
E xt ension of Changing t he ext ension does not change t he algorit hm;
compressed it changes only t he f ile ext ension. For example, some zip
f ile net work environment s do not allow f iles wit h t he ZI P
ext ension t o be delivered as email at t achment s. I n
t hese environment s, changing t he f ile ext ension is
necessary f or t he at t achment s t o be delivered.

Deliver ies - FTP Deliver y - Email No t if icat io n

Defau lt
Settin g Descrip tio n
Valu e

S elect t his checkbox t o send a not if icat ion

email t o t he recipient when t he subscribed
report or document is delivered t o t he f ile Checked
E nable locat ion. I f t his checkbox is cleared, all
email ot her opt ions in t his cat egory are disabled.
not if icat ion
f or FTP S end S elect t his checkbox t o send a not if icat ion
not if icat ion t o email t o t he recipient when t he subscribed
Checked
recipient report or document f ails t o be delivered on
when delivery schedule.

671 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

f ails

© 2019, M icr o St r at egy In c. 672

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

Recipient The MicroS t rat egy user or cont act t hat

Checked
name subscribed t o t he delivery.

Owner name The owner of t he subscript ion. Checked

Report or
Document Name of t he subscribed report or document Checked
name

P roject name P roject cont aining t he report or document Checked

Delivery The delivery met hod of email, f ile, FTP ,

Checked
met hod print , Hist oy List , Cache, or Mobile.

The schedule associat ed wit h t he

S chedule Checked
subscript ion.

S ubscript ion
The name of t he subscript ion. Checked
name

Delivery The st at us of t he delivery, such as

Checked
st at us Complet e, Timed Out , or E rror.

Dat e Dat e of t he delivery Checked

Time Time of t he delivery Checked

File locat ion Locat ion of t he f ile Checked

Link t o f ile Hyperlink t o t he f ile Checked

E rror The specif ic error message f or a f ailed

Checked
message delivery

To include a message wit h each cache

A ppend t he
delivery not if icat ion, select t his checkbox Checked
f ollowing t ext
and t ype t he message in t he f ield.

S end Type t he email address of a syst em

not if icat ion administ rat or t o receive a not if icat ion email E mpt y
t o t his f or t he f ailed cache delivery.

673 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

administ rat or
email
address when
delivery f ails

Deliver ies - FTP Deliver y - Co mp r essio n

Defau lt
Settin g Descrip tio n
Valu e

S elect t his checkbox t o compress t he report or

E nable
document t hat is subscribed and delivered t o a f ile Checked
compression
locat ion.

S elect t he level of compression f or t he subscribed report

Level of
or document as High, Medium, or Low f rom t he drop- Medium
compression
down list .

I n t his f ield, specif y t he f ile ext ension f or t he

compressed f iles. The def ault ext ension is ZI P . Report s
or document s are compressed using t he ZI P algorit hm.
E xt ension of Changing t he ext ension does not change t he algorit hm;
compressed it changes only t he f ile ext ension. For example, some zip
f ile net work environment s do not allow f iles wit h t he ZI P
ext ension t o be delivered as email at t achment s. I n
t hese environment s, changing t he f ile ext ension is
necessary f or t he at t achment s t o be delivered.

© 2019, M icr o St r at egy In c. 674

Syst em Ad m in ist r at io n Gu id e

Deliver ies - Pr in t in g - Email No t if icat io n

Defau lt
Settin g Descrip tio n
Valu e

S elect t his checkbox t o send a not if icat ion

email t o t he recipient when t he subscribed
report or document is delivered t o t he f ile Checked
locat ion. I f t his checkbox is cleared, all
ot her opt ions in t his cat egory are disabled.

S end
S elect t his checkbox t o send a not if icat ion
not if icat ion t o
email t o t he recipient when t he subscribed
recipient Checked
report or document f ails t o be delivered on
when delivery
schedule.
f ails

Recipient The MicroS t rat egy user or cont act t hat

Checked
name subscribed t o t he delivery

E nable Owner name The owner of t he subscript ion Checked

email
Report or
not if icat ion
Document Name of t he subscribed report or document Checked
f or print ing
name

P roject name P roject cont aining t he report or document Checked

Delivery Delivery met hod of email, f ile, FTP , print ,

Checked
met hod Hist oy List , Cache, or Mobile

The schedule associat ed wit h t he

S chedule Checked
subscript ion

S ubscript ion
The name of t he subscript ion Checked
name

Delivery S t at us of t he delivery, such as Complet e,

Checked
st at us Timed Out , or E rror

Dat e Dat e of t he delivery Checked

675 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

Time Time of t he delivery Checked

P rint er name The name of t he print er Checked

E rror The specif ic error message f or a f ailed

Checked
message delivery.

To include a message wit h each cache

A ppend t he
delivery not if icat ion, select t his checkbox Checked
f ollowing t ext
and t ype t he message in t he f ield.

S end
not if icat ion t o
t his E nt er t he email address of a syst em
administ rat or administ rat or t o receive a not if icat ion email E mpt y
email address f or t he f ailed cache delivery.
when delivery
f ails

Deliver ies - Pr in t in g - PDF Pr o p er t ies

Settin g Descrip tio n Defau lt Valu e

E nable print range Checked

Deliver ies - Hist o r y List - Email No t if icat io n

Defau lt
Settin g Descrip tio n
Valu e

E nable S elect t his checkbox t o send a not if icat ion

email email t o t he administ rat or when a Checked
not if icat ion subscribed report or document f ails t o be

© 2019, M icr o St r at egy In c. 676

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

delivered t o t he cache. I f t his checkbox is

cleared, all ot her opt ions in t his cat egory
are disabled.

S end
S elect t his checkbox t o send a not if icat ion
not if icat ion
email t o t he recipient when t he subscribed
t o recipient Checked
report or document f ails t o be delivered on
when delivery
schedule.
f ails

Recipient The MicroS t rat egy user or cont act t hat

Checked
name subscribed t o t he delivery

Owner name The owner of t he subscript ion Checked

Report or
Document Name of t he subscribed report or document Checked
name
f or hist ory
list P roject name P roject cont aining t he report or document Checked

Delivery Delivery met hod of E mail, f ile, FTP , print ,

Checked
met hod Hist oy List , Cache, or Mobile

The schedule associat ed wit h t he

S chedule Checked
subscript ion

S ubscript ion
The name of t he subscript ion Checked
name

Delivery S t at us of t he delivery, such as Complet e,

Checked
st at us Timed Out , or E rror

Dat e Dat e of t he delivery Checked

Time Time of t he delivery Checked

Link t o A link t o t he report or document 's Hist ory

Checked
Hist ory List List message

677 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

E rror The specif ic error message f or a f ailed

Checked
message delivery

To include a message wit h each cache

A ppend t he
delivery not if icat ion, select t his checkbox Checked
f ollowing t ext
and t ype t he message in t he f ield.

S end
not if icat ion
t o t his Type t he email address of a syst em
administ rat or administ rat or t o receive a not if icat ion email E mpt y
email f or t he f ailed cache delivery.
address when
delivery f ails

Deliver ies - Mo b ile Deliver y - Email No t if icat io n

Defau lt
Settin g Descrip tio n
Valu e

S elect t his checkbox t o send a not if icat ion

email t o t he administ rat or when a
subscribed report or document f ails t o be
Checked
delivered t o t he cache. I f t his checkbox is
E nable email
cleared, all ot her opt ions in t his cat egory
not if icat ion
are disabled.
to
administ rat or Recipient The MicroS t rat egy user or cont act t hat
f or f ailed Checked
name subscribed t o t he delivery
mobile
delivery Owner name The owner of t he subscript ion Checked

Report or
Name of t he subscribed report or
Document Checked
document
name

© 2019, M icr o St r at egy In c. 678

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

P roject
P roject cont aining t he report or document Checked
name

Delivery Delivery met hod of E mail, f ile, FTP , print ,

Checked
met hod Hist oy List , Cache, or Mobile

The schedule associat ed wit h t he

S chedule Checked
subscript ion

S ubscript ion
The name of t he subscript ion Checked
name

Delivery S t at us of t he delivery, such as Complet e,

Checked
st at us Timed Out , or E rror

Dat e Dat e of t he delivery Checked

Time Time of t he delivery Checked

E rror The specif ic error message f or a f ailed

Checked
message delivery

A ppend t he To include a message wit h each cache

f ollowing delivery not if icat ion, select t his checkbox Checked
t ext and t ype t he message in t he f ield.

S end
not if icat ion
t o t his
Type t he email address of a syst em
administ rat or
administ rat or t o receive a not if icat ion E mpt y
email
email f or t he f ailed cache delivery.
address
when
delivery f ails

679 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Deliver ies - Mo b ile Deliver y - Real Time Up d at es

Defau lt
Settin g Descrip tio n
Valu e

E nable real
S elect t his checkbox t o enable updat ed report and
t ime updat es
document dat a t o be aut omat ically sent t o Mobile users Checked
f or mobile
t hat are subscribed t o t he report or document .
delivery

Deliver ies - Cach e - Email No t if icat io n

Defau lt
Settin g Descrip tio n
Valu e

S elect t his checkbox t o send a not if icat ion

email t o t he administ rat or when a
subscribed report or document f ails t o be
Checked
delivered t o t he cache. I f t his checkbox is
cleared, all ot her opt ions in t his cat egory
are disabled.

Recipient The MicroS t rat egy user or cont act t hat

E nable email Checked
name subscribed t o t he delivery
not if icat ion
to Owner name The owner of t he subscript ion Checked
administ rat or
Report or
f or f ailed Name of t he subscribed report or
Document Checked
cache document
name
creat ion
P roject
P roject cont aining t he report or document Checked
name

Delivery Delivery met hod of email, f ile, FTP , print ,

Checked
met hod Hist oy List , Cache, or Mobile

The schedule associat ed wit h t he

S chedule Checked
subscript ion

© 2019, M icr o St r at egy In c. 680

Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

S ubscript ion
The name of t he subscript ion Checked
name

Delivery S t at us of t he delivery, such as Complet e,

Checked
st at us Timed Out , or E rror.

Dat e Dat e of t he delivery Checked

Time Time of t he delivery Checked

E rror The specif ic error message f or a f ailed

Checked
message delivery

A ppend t he To include a message wit h each cache

f ollowing delivery not if icat ion, select t his checkbox Checked
t ext and t ype t he message in t he f ield.

S end
not if icat ion
t o t his
Type t he email address of a syst em
administ rat or
administ rat or t o receive a not if icat ion E mpt y
email
email f or t he f ailed cache delivery.
address
when
delivery f ails

Deliver ies - Er r o r Han d lin g

Defau lt
Settin g Descrip tio n
Valu e

S elect whet her t o Deliver or Do not deliver t he

Do not
Deliver subscript ion if t he report or document execut ion
No dat a deliver
ret urns no dat a.
ret urned

Not if y S elect whet her t o Not if y or Do not not if y t he Do not

681 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Settin g Descrip tio n
Valu e

subscript ion if t he report or document execut ion

not if y
ret urns no dat a.

S elect whet her t o Deliver or Do not deliver t he

subscript ion if t he report or document execut ion
ret urns only some of t he dat a. P art ial result s are Do not
Deliver
delivered when t he size of t he report or document deliver
exceeds t he memory governing set t ing f or Maximum

P art ial memory consumpt ion f or P DF f iles and E xcel f iles.

result s S elect whet her t o Deliver or Do not deliver t he

subscript ion if t he report or document execut ion
ret urns only some of t he dat a. P art ial result s are Do not
Not if y
delivered when t he size of t he report or document not if y
exceeds t he memory governing set t ing f or Maximum
memory consumpt ion f or P DF f iles and E xcel f iles.

Best Practices for Tuning your System

Mi croStrategy recommends the fol l ow i ng best practi ces for desi gni ng,
confi guri ng, and tuni ng your Mi croStrategy system. For detai l ed
i nformati on about i ncreasi ng system performance by tuni ng the
governi ng setti ngs, see the remai nder of thi s secti on.

l When desi gni ng your proj ects and data w arehouse, fol l ow the
Mi croStrategy best practi ces as outl i ned i n Prerequi si tes.

l When confi guri ng your netw ork, fol l ow the Mi croStrategy best
practi ces as outl i ned i n H ow the N etw ork can Affect Performance,
page 687.

l U se Intel l i gence Server's Memory C ontract Manager to manage

memory usage, as descri bed i n Governi ng Intel l i gence Server
Memory U se w i th Memory C ontract Manager, page 698.

© 2019, M icr o St r at egy In c. 682

Syst em Ad m in ist r at io n Gu id e

l U se Mi croStrategy system pri vi l eges to restri ct users' access to

certai n features, as descri bed i n Governi ng U ser Profi l es, page 719.

l Assi gn a hi gh pri ori ty to more ti me-sensi ti ve j obs, and a l ow pri ori ty

to j obs that may use a great deal of system resources, as descri bed
i n Pri ori ti zi ng Jobs, page 737.

l Enabl e Intel l i gence Server thread bal anci ng, as descri bed i n
R esul ts Processi ng, page 742.

l Ensure that report and document desi gners are aw are of the
features that can pl ace an excepti onal l y heavy l oad on the system.
These features are l i sted i n detai l i n D esi gni ng R eports, page 757.

l Enabl e automati c memory tuni ng and dynami c buffer si zi ng.

Configuring Automatic Memory Tuning

Mi croStrategy Intel l i gence Server uses a memory management
component cal l ed SmartH eap. Thi s component i s desi gned to
maxi mi ze memory al l ocati on performance, especi al l y i n a mul ti -
threaded and mul ti -processor envi ronment.

The tabl e bel ow detai l s the envi ronment vari abl e setti ngs you can use
to adj ust automati c memory turni ng.

En viro n men t Variab le Settin g Beh avio r

E nables light memory t uning

and disables dynamic memory
MS TR_ME M_CA CHE _A UTO_CONFI G= 0 t uning. The memory usage is
consist ent wit h 10. 10 and
previous versions.

E nables high-level, aggressive

memory t uning. This can provide
MS TR_ME M_CA CHE _A UTO_CONFI G= 1
perf ormance improvement s
under concurrency f or some

683 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

En viro n men t Variab le Settin g Beh avio r

cases. The memory usage is

also expect ed t o have a
considerable increase.

E nables middle-level,
conservat ive memory t uning.
This is t he def ault behavior in
11. 0. I t can provide some
perf ormance improvement s
under concurrency f or machines
larger t han 256 GB wit h more
MS TR_ME M_CA CHE _A UTO_CONFI G= 2
t han 64 cores. The memory
usage is expect ed t o slight ly
increase, but it is lower t han
MS TR_ME M_CA CHE _A UTO_
CONFI G= 1. This set t ing does
not apply t o versions prior t o
11. 0.

I f you do not set t his variable,

t he def ault behavior is used. I n
MicroS t rat egy 10. 11 and
previous versions, t he def ault
behavior is t he same as MS TR_
MS TR_ME M_CA CHE _A UTO_CONFI G is not set
ME M_CA CHE _A UTO_
CONFI G= 0. I n MicroS t rat egy
11. 0, t he def ault behavior is t he
same as MS TR_ME M_CA CHE _
A UTO_CONFI G= 2.

Enabl i ng mi ddl e l evel or hi gh l evel memory tuni ng can potenti al l y

i ncrease the memory footpri nt of Intel l i gence Server. H ow ever,
Intel l i gence Server has the abi l i ty to rel ease the cached memory i n
Smartheap w hen Intel l i gence Server i s about to hi t Memory C ontract
Manager deni al .

© 2019, M icr o St r at egy In c. 684

Syst em Ad m in ist r at io n Gu id e

For detai l about how Intel l i gence Server rel eases the cached memory
i n Smartheap, pl ease refer to the know l edge base i n Mi croStrategy
C ommuni ty.

Designing System Architecture

The choi ces that you make w hen desi gni ng the archi tecture of your
Mi croStrategy system have a si gni fi cant i mpact on system
performance and capaci ty.

C hoi ces that you must make w hen desi gni ng your system archi tecture
i ncl ude:

l H ow the data w arehouse i s confi gured (see H ow the D ata

Warehouse can Affect Performance, page 686)

l The physi cal l ocati on of machi nes rel ati ve to each other and the
amount of bandw i dth betw een them (see H ow the N etw ork can
Affect Performance, page 687)

l Whether you cl uster several Intel l i gence Servers together and w hat
benefi ts you can get from cl usteri ng (see H ow C l usteri ng can Affect
Performance, page 691)

685 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

How the Data Warehouse can Affect Performance

The data w arehouse i s a cruci al component of the busi ness
i ntel l i gence system. If i t does not perform w el l , the enti re system's
performance suffers. The data w arehouse pl atform or R D BMS and the
data w arehouse's desi gn and tuni ng are factors that can affect your
system's performance.

Plat f o r m Co n sid er at io n s
The si ze and speed of the machi nes hosti ng your data w arehouse and
the database pl atform (R D BMS) runni ng your data w arehouse both
affect the system's performance. A l i st of supported R D BMSs can be
found i n the R eadme. You shoul d have an i dea of the amount of data
and the number of users that your system serves, and research w hi ch
R D BMS can handl e that type of l oad.

Design an d Tu n in g Co n sid er at io n s
Your data w arehouse's desi gn (al so cal l ed the physi cal w arehouse
schema) and tuni ng are i mportant and uni que to your organi zati on.
They al so affect the performance of your busi ness i ntel l i gence
system. The di scussi on of the set of trade-offs that you must make
w hen desi gni ng and tuni ng the data w arehouse i s out of the scope of
thi s gui de. Exampl es of the types of deci si ons that you must make
i ncl ude:

l Wi l l you use a normal i zed, moderatel y normal i zed, or ful l y

denormal i zed schema?

l What ki nd of l ookup, rel ate, and fact tabl es w i l l you need?

l What aggregate tabl es w i l l you need?

l What tabl es do you need to parti ti on and how ?

l What tabl es w i l l you i ndex?

© 2019, M icr o St r at egy In c. 686

Syst em Ad m in ist r at io n Gu id e

For more i nformati on about data w arehouse desi gn and data

model i ng, see the Advanced R eporti ng Gui de and Proj ect D esi gn
Gui de.

How the Network can Affect Performance

The vari ous components of the Mi croStrategy system need to be
i nstal l ed on di fferent machi nes for performance reasons. The netw ork
pl ays an i mportant rol e i n connecti ng these components. In the
di agram bel ow , the separate components of the Mi croStrategy system
are l i nked by l i nes representi ng the netw ork. The steps that occur
over each connecti on are descri bed i n the tabl e bel ow the di agram.

Ste p Pr otoc ol De ta ils

HTML sent f rom Web server t o client . Dat a size is small

compared t o ot her point s because result s have been
1 HTTP / HTTP S
increment ally f et ched f rom I nt elligence S erver and HTML
result s do not cont ain any unnecessary inf ormat ion.

TP C/ I P
X ML request s are sent t o I nt elligence S erver. X ML report
2 or
result s are increment ally f et ched f rom I nt elligence S erver.
TLS / S S L

Request s are sent t o I nt elligence S erver. (No increment al

3 TCP / I P
f et ch is used. )

687 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Ste p Pr otoc ol De ta ils

or

TLS / S S L

TCP / I P B roadcast s bet ween all nodes of t he clust er (if implement ed):
met adat a changes, I nbox, report caches. Files cont aining
4 or
cache and I nbox messages are exchanged bet ween
TLS / S S L I nt elligence S erver nodes.

TCP / I P Files cont aining cache and I nbox messages may also be
exchanged bet ween I nt elligence S erver nodes and a shared
5 or
cache f ile server if implement ed (see Sharing R es ult C aches
TLS / S S L and Intelligent C ubes in a C lus ter, page 793 ).

Object request s and t ransact ions t o met adat a. Request

6 ODB C
result s are st ored locally in I nt elligence S erver object cache.

Complet e result set is ret rieved f rom dat abase and st ored in
7 ODB C
I nt elligence S erver memory and/ or caches.

The maxi mum number of threads used i n steps 2 and 3 can be

control l ed i n the Intel l i gence Server C onfi gurati on Edi tor, i n the
Server D efinition: General category, i n the N umber of N etwork
Threads fi el d. D ependi ng on how your netw ork i s confi gured, one
netw ork thread may be suffi ci ent to serve anyw here from 64 to 1028
user connecti ons.

Net wo r k Co n f igu r at io n Best Pr act ices

The netw ork confi gurati on, that i s, w here the components are
i nstal l ed i n rel ati on to each other, can have a l arge effect on
performance. For exampl e, i f the physi cal di stance betw een
Intel l i gence Server and the data w arehouse i s great, you may see
poor performance due to netw ork del ays betw een the tw o machi nes.

© 2019, M icr o St r at egy In c. 688

Syst em Ad m in ist r at io n Gu id e

Mi croStrategy recommends the fol l ow i ng best practi ces for netw ork
desi gn:

l Pl ace the Web server machi nes cl ose to the Intel l i gence Server
machi nes.

l Pl ace Intel l i gence Server cl ose to the both the data w arehouse and
the metadata reposi tory.

l D edi cate a machi ne for the metadata reposi tory.

l If you use Enterpri se Manager, dedi cate a machi ne for the

Enterpri se Manager database (stati sti cs tabl es and data
w arehouse).

l If you have a cl ustered envi ronment w i th a shared cache fi l e server,

pl ace the shared cache fi l e server cl ose to the Intel l i gence Server
machi nes.

Net wo r k Ban d wid t h an d Ho w it s Cap acit y is Used

Your netw ork desi gn depends on the type of reports that your users
typi cal l y run. These reports, i n turn, determi ne the l oad they pl ace on
the system and how much netw ork traffi c occurs betw een the system
components.

The abi l i ty of the netw ork to qui ckl y transport data betw een the
components of the system greatl y affects i ts performance. For l arge
resul t sets, the hi ghest l oad or the most traffi c typi cal l y occurs
betw een the data w arehouse and the Intel l i gence Servers (i ndi cated
by C i n the di agram bel ow ). The l oad betw een Intel l i gence Server and
Web server i s somew hat l ess (B ), fol l ow ed by the l east l oad betw een
the Web server and the Web brow ser (A ).

Thi s i s i l l ustrated i n the di agram and expl ai ned bel ow .

689 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Incremental fetch si ze di rectl y i nfl uences the amount of traffi c at A.

l Graphi cs i ncrease netw ork bandw i dth at B.

l The l oad at C i s determi ned pri mari l y by the number of row s

retri eved from the data w arehouse. Acti ons such as sendi ng SQL or
retri evi ng obj ects from the metadata resul t i n mi ni mal traffi c.

l C ached reports do not cause any netw ork traffi c at C .

l R eport mani pul ati ons that do not cause SQL to be generated and
sent to the data w arehouse (such as pi vot, sort, and page-by) are
si mi l ar to runni ng cached reports.

l R eport mani pul ati ons that cause SQL to be generated and sent to
the data w arehouse are si mi l ar to runni ng non-cached reports of
the same si ze.

After noti ng w here the hi ghest l oad i s on your netw ork, you can adj ust
your netw ork bandw i dth or change the pl acement of system
components to i mprove the netw ork's performance.

You can tel l w hether your netw ork confi gurati on has a negati ve effect
on your system's performance by moni tori ng how much of your
netw ork's capaci ty i s bei ng used. U se the Wi ndow s Performance
Moni tor for the obj ect N etwork Interface, and the w atch the counter
Total bytes/sec as a percent of your netw ork's bandw i dth. If i t i s
consi stentl y greater than 60 percent (for exampl e), i t may i ndi cate that
the netw ork i s negati vel y affecti ng the system's performance. You
may w ant to use a fi gure di fferent than 60 percent for your system.

© 2019, M icr o St r at egy In c. 690

Syst em Ad m in ist r at io n Gu id e

To cal cul ate the netw ork capaci ty uti l i zati on percent, take the total
capaci ty, i n terms of bi ts per second, and di vi de i t by (Total bytes per
second * 8). (Mul ti pl y the Total Bytes per second by 8 because 1 byte
= 8 bi ts.)

The C urrent B andwidth counter i n Performance Moni tor gi ves an

approxi mate val ue of total capaci ty because i t i s onl y an esti mate.
You may w ant to use another netw ork moni tori ng uti l i ty such as
NetP er f to get the actual bandw i dth fi gure.

How Clustering can Affect Performance

C l usteri ng several Intel l i gence Server machi nes provi des substanti al
gai ns i n memory and C PU capaci ty because mul ti pl e machi nes are
shari ng the w ork. C l usteri ng has addi ti onal benefi ts for your system
as w el l . The cl usteri ng feature i s bui l t i nto Intel l i gence Server and i s
avai l abl e out of the box i f you have the proper l i cense. For more
i nformati on on cl usteri ng Intel l i gence Servers, i ncl udi ng i nstructi ons,
see C hapter 9, C l usteri ng Mul ti pl e Mi croStrategy Servers.

Managing System Resources

If you had unl i mi ted money, you coul d create a system that w oul d
i mpose few l i mi ts on system capaci ty. Whi l e system resources i s not
the pl ace to save money w hen bui l di ng a busi ness i ntel l i gence
system, you may not have the resources that you w ant you coul d
have.

691 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

You must make certai n choi ces about how to maxi mi ze the use of your
system's resources. Because Intel l i gence Server i s the mai n
component of the Mi croStrategy system, i t i s i mportant that the
machi nes runni ng i t have suffi ci ent resources for your needs. These
resources i ncl ude:

l The processors (Processor Type, Speed, and N umber of

Processors, page 692)

l Physi cal di sk characteri sti cs (Physi cal D i sk, page 693)

l The amount of memory (Memory, page 694)

The Instal l ati on and C onfi gurati on Gui de c ontains detailed

information about s mall, medium, and large c onfigurations .

Processor Type, Speed, and Number of Processors

Intel l i gence Server recogni zes the type and speed of the machi ne's
C PU s, and performs faster on a machi ne w i th mul ti pl e C PU s. If
Intel l i gence Server i s consi stentl y usi ng a great deal of processor
capaci ty, greater than 80 percent, for exampl e, i t may be a si gn that a
faster processor w oul d i mprove the system's capaci ty. In Wi ndow s,
you can moni tor the processor usage w i th the Wi ndow s Performance
Moni tor.

© 2019, M icr o St r at egy In c. 692

Syst em Ad m in ist r at io n Gu id e

If you upgrade a machi ne's C PU , make sure you have the appropri ate
l i cense to run Intel l i gence Server on the faster C PU . For exampl e, i f
you upgrade the processor on the Intel l i gence Server machi ne from a
2 GH z to a 2.5 GH z processor, you shoul d obtai n a new l i cense key
from Mi croStrategy.

Intel l i gence Server i s al so aw are of the number of processors i t i s

al l ow ed to use accordi ng to the l i cense key that you have purchased.
For exampl e, i f a machi ne runni ng Intel l i gence Server has tw o
processors and you upgrade i t to four, Intel l i gence Server uses onl y
the tw o processors and i gnores the addi ti onal tw o unti l you purchase
a new l i cense key from Mi croStrategy. Al so, i f several Intel l i gence
Server machi nes are cl ustered, the appl i cati on ensures that the total
number of processors bei ng used does not exceed the number
l i censed.

For detai l ed i nformati on about C PU l i censi ng, see C PU Li censes,

page 373.

Physical Disk
If the physi cal di sk i s used too much on a machi ne hosti ng
Intel l i gence Server, i t can i ndi cate a bottl eneck i n the system's
performance. To moni tor physi cal di sk usage i n Wi ndow s, use the
Wi ndow s Performance Moni tor counters for the obj ect Physical D isk
and the counter % D isk Time. If the counter i s greater than 80 percent
on average, i t may i ndi cate that the machi ne does not have enough
memory. Thi s i s because w hen the machi ne's physi cal R AM i s ful l ,
the operati ng system starts sw appi ng memory i n and out of the page
fi l e on di sk. Thi s i s not as effi ci ent as usi ng R AM. Therefore,
Intel l i gence Server's performance may suffer.

By moni tori ng the di sk uti l i zati on, you can see i f the machi ne i s
consi stentl y sw appi ng at a hi gh l evel . D efragmenti ng the physi cal
di sk may hel p l essen the amount of sw appi ng. If that does not
suffi ci entl y l essen the uti l i zati on, consi der i ncreasi ng the amount of

693 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

physi cal R AM i n the machi ne. For i nformati on on how Intel l i gence
Server uses memory, see Memory, page 694.

Mic roStrategy rec ommends that y ou es tablis h a benc hmark or bas eline
of a mac hine's normal dis k utiliz ation, perhaps ev en before Intelligenc e
Serv er is ins talled. This way y ou c an determine whether Intelligenc e
Serv er is res pons ible for ex c es s iv e s wapping bec aus e of limited RAM.

Another performance counter that you can use to gauge the di sk's
uti l i zati on i s the C urrent disk queue length, w hi ch i ndi cates how
many requests are w ai ti ng at a ti me. Mi croStrategy recommends usi ng
the % D i sk Ti me and C urrent D i sk Queue Length counters to moni tor
the di sk uti l i zati on.

Memory
If the machi ne hosti ng Intel l i gence Server has too l i ttl e memory, i t
may run sl ow l y, or even shut dow n duri ng memory-i ntensi ve
operati ons. You can use the Wi ndow s Performance Moni tor to moni tor
the avai l abl e memory, and you can govern Intel l i gence Server's
memory use w i th the Memory C ontract Manager.

Memo r y Limit at io n s: Vir t u al Memo r y

The memory used by Intel l i gence Server i s l i mi ted by the machi ne's
vi rtual memory.

Vi rtual memory i s the amount of physi cal memory (R AM) pl us the D i sk

Page fi l e (sw ap fi l e). It i s shared by al l processes runni ng on the
machi ne, i ncl udi ng the operati ng system.

When a machi ne runs out of vi rtual memory, processes on the

machi ne are no l onger abl e to process i nstructi ons and eventual l y the
operati ng system may shut dow n. More vi rtual memory can be
obtai ned by maki ng sure that as few programs or servi ces as possi bl e

© 2019, M icr o St r at egy In c. 694

Syst em Ad m in ist r at io n Gu id e

are executi ng on the machi ne, or by i ncreasi ng the amount of physi cal
memory or the si ze of the page fi l e.

Inc reas ing the amount of v irtual memory , and therefore the av ailable
priv ate by tes , by inc reas ing the page file s iz e may hav e adv ers e effec ts
on Intelligenc e Serv er performanc e bec aus e of inc reas ed s wapping.

Pri vate bytes are the bytes of vi rtual memory that are al l ocated to a
process. Pri vate bytes are so named because they cannot be shared
w i th other processes: w hen a process such as Intel l i gence Server
needs memory, i t al l ocates an amount of vi rtual memory for i ts ow n
use. The pri vate bytes used by a process can be measured w i th the
Private B ytes counter i n the Wi ndow s Performance Moni tor.

The governi ng setti ngs bui l t i nto Intel l i gence Server control i ts
demand for pri vate bytes by l i mi ti ng the number and scal e of
operati ons w hi ch i t may perform si mul taneousl y. In most producti on
envi ronments, depl eti on of vi rtual memory through pri vate bytes i s not
an i ssue w i th Intel l i gence Server.

Ho w Mu ch Memo r y d o es In t elligen ce Ser ver Use Wh en it

St ar t s Up ?
The amount of memory consumed duri ng startup i s affected by a
number of factors such as metadata si ze, the number of proj ects,
schema si ze, number of processi ng uni ts, number of database
connecti on threads requi red, and w hether Intel l i gence Server i s i n a
cl ustered confi gurati on. Because these factors are general l y stati c,
the amount of memory consumed at startup i s fai rl y constant. Thi s l ets
you accuratel y esti mate how much memory i s avai l abl e to users at
runti me.

When Intel l i gence Server starts up, i t uses memory i n the fol l ow i ng
w ays:

695 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l It i ni ti al i zes al l i nternal components and l oads the stati c D LLs

necessary for operati on. Thi s consumes 25 MB of pri vate bytes and
110 MB of vi rtual bytes. You cannot control thi s memory usage.

l It l oads al l server defi ni ti on setti ngs and al l confi gurati on obj ects.
Thi s consumes an addi ti onal 10 MB of pri vate bytes and an
addi ti onal 40 MB of vi rtual bytes. Thi s bri ngs the total memory
consumpti on at thi s poi nt to 35 MB of pri vate bytes and 150 MB of
vi rtual bytes. You cannot control thi s memory usage.

l It l oads the proj ect schema (needed by the SQL engi ne component)
i nto memory. The number and si ze of proj ects greatl y i mpacts the
amount of memory used. Thi s consumes an amount of pri vate bytes
equal to three ti mes the schema si ze and an amount of vi rtual bytes
equal to four ti mes the schema si ze. For exampl e, w i th a schema
si ze of 5 MB, the pri vate bytes consumpti on w oul d i ncrease by 15
MB (3 * 5 MB). The vi rtual bytes consumpti on w oul d i ncrease by 20
MB (4 * 5 MB). You can control thi s memory usage by l i mi ti ng the
number of proj ects that l oad at startup ti me.

l It creates the database connecti on threads. Thi s pri mari l y affects

vi rtual bytes consumpti on, w i th an i ncrease of 1 MB per thread
regardl ess of w hether that thread i s actual l y connected to the
database. You cannot control thi s memory usage.

To Calculate the Amount of Memory that Intelligence Server Uses

When it Starts

If y ou are not performing this proc edure in a produc tion env ironment,
mak e s ure that y ou s et all the c onfiguration options as they ex is t in y our
produc tion env ironment. Otherwis e, the meas urements will not reflec t
the ac tual produc tion memory c ons umption.

© 2019, M icr o St r at egy In c. 696

Syst em Ad m in ist r at io n Gu id e

1. Start Intel l i gence Server.

2. Once Intel l i gence Server has started, use Wi ndow s Performance

Moni tor to create and start a performance l og that measures
Pri vate and Vi rtual bytes of the M S T R S V R process.

3. Whi l e l oggi ng w i th Performance Moni tor, stop Intel l i gence

Server. Performance Moni tor conti nues to l og i nformati on for the
Intel l i gence Server process. You can confi rm thi s by l oggi ng the
counter i nformati on to the current acti vi ty w i ndow as w el l as the
performance l og.

4. Start Intel l i gence Server agai n. The amount of memory

consumed shoul d be easi l y measured.

Ho w d o es In t elligen ce Ser ver Use Memo r y Af t er it is

Ru n n in g?
Intel l i gence Server i ncreases i ts memory use as needed duri ng i ts
operati on. The fol l ow i ng factors determi ne w hen memory use
i ncreases:

l A dditional configuration objects: cachi ng of user, connecti on

map, and schedul e and subscri pti on i nformati on created or used
after Intel l i gence Server has been started.

l C aches: resul t (report and document) caches, obj ect caches, and
el ement caches created after Intel l i gence Server has been started.
The maxi mum amount of memory that Intel l i gence Server uses for
resul t caches i s confi gured at the proj ect l evel . For more
i nformati on about caches, see C hapter 10, Improvi ng R esponse
Ti me: C achi ng.

l Intelligent C ubes: any Intel l i gent C ubes that have been l oaded
after Intel l i gence Server has been started. The maxi mum amount of

697 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

memory used for Intel l i gent C ubes i s confi gured at the proj ect l evel .
For detai l s, see C hapter 11, Managi ng Intel l i gent C ubes.

l U ser session-related resources: H i story Li st and Worki ng set

memory, w hi ch are greatl y i nfl uenced by governi ng setti ngs, report
si ze, and report desi gn. For detai l s, see Managi ng U ser Sessi ons,
page 711 and Savi ng R eport R esul ts: H i story Li st, page 897.

l R equest and results processing: memory needed by Intel l i gence

Server components to process requests and report resul ts. Thi s i s
pri mari l y i nfl uenced by report si ze and report desi gn w i th respect to
anal yti cal compl exi ty. For detai l s, see Governi ng R equests, page
722 and R esul ts Processi ng, page 742.

l C lustering: memory used by Intel l i gence Server to communi cate

w i th other cl uster nodes and mai ntai n synchroni zed report cache
and H i story Li st i nformati on. For more i nformati on about cl usteri ng,
see C hapter 9, C l usteri ng Mul ti pl e Mi croStrategy Servers.

l Scheduling: memory used by schedul er w hi l e executi ng reports for

users w hen they are not l ogged i n to the system. For more
i nformati on about schedul i ng, see C hapter 12, Schedul i ng Jobs and
Admi ni strati ve Tasks.

Governing Intelligence Server Memory Use with Memory

Contract Manager
Memory C ontract Manager (MC M) i s desi gned to protect Intel l i gence
Server i n cases w here a memory request w oul d cause the system to
approach a state of memory depl eti on. When enabl ed, MC M grants or
deni es requests for memory from tasks i n Intel l i gence Server. The
requests are granted or deni ed accordi ng to user-confi gured l i mi ts on
the amount of memory Intel l i gence Server i s al l ow ed to use. Because
MC M i s a component i n Intel l i gence Server, i t does not manage the
actual memory used by Intel l i gence Server i tsel f.

MC M governs the fol l ow i ng types of requests:

© 2019, M icr o St r at egy In c. 698

Syst em Ad m in ist r at io n Gu id e

l D atabase requests from ei ther the Mi croStrategy metadata or the

data w arehouse

l SQL generati on

l Anal yti cal Engi ne processi ng (subtotal s, cross tabul ati on, anal yti c
functi ons)

l C ache creati on and updati ng

l R eport parsi ng and seri al i zati on for netw ork transfer

l XML generati on

The memory l oad of the requests governed by MC M depends on the

amount of data that i s returned from the data w arehouse. Therefore,
thi s memory l oad cannot be predi cted.

R equests such as graphi ng, cache l ookup, or document generati on

use a predi ctabl e amount of memory and, thus, are not governed by
MC M. For exampl e, a request for a report returns an acceptabl e
amount of data. A graph of the report's resul ts w oul d be based on the
same data and, thus, w oul d be al l ow ed. Therefore, MC M i s not
i nvol ved i n graphi ng requests. If the report w as not returned because
i t exceeded memory l i mi ts, the graphi ng request w oul d never be
i ssued.

Usin g t h e Memo r y Co n t r act Man ager

The MC M setti ngs are i n the Intel l i gence Server C onfi gurati on Edi tor,
i n the Governing R ules: D efault: Memory Settings category.

699 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

The Enable single memory allocation governing opti on l ets you

speci fy how much memory can be reserved for a si ngl e Intel l i gence
Server operati on at a ti me. When thi s opti on i s enabl ed, each memory
request i s compared to the Maximum single allocation size (MB ytes)
setti ng. If the request exceeds thi s l i mi t, the request i s deni ed. For
exampl e, i f the al l ocati on l i mi t i s set to 100 MB and a request i s made
for 120 MB, the request i s deni ed, but a request for 90 MB i s al l ow ed.

If the Intel l i gence Server machi ne has addi ti onal softw are runni ng on
i t, you may w ant to set asi de some memory for those processes to
use. To reserve thi s memory, you can speci fy the Minimum reserved
memory i n terms of ei ther the number of MB or the percent of total
system memory. In thi s case, the total avai l abl e memory i s cal cul ated
as the i ni ti al si ze of the page fi l e pl us the R AM. It i s possi bl e that a
machi ne has more vi rtual memory than MC M know s about i f the
maxi mum page fi l e si ze i s greater than the i ni ti al si ze.

Intelligenc e Serv er alway s res erv es up to 500 MB for its own operation.
If the mac hine does not hav e this muc h memory , or if the Minimum

© 2019, M icr o St r at egy In c. 700

Syst em Ad m in ist r at io n Gu id e

reserved memory would leav e les s than 500 MB av ailable for

Intelligenc e Serv er, no memory is res erv ed for other proc es s es .

When MC M recei ves a request that w oul d cause Intel l i gence Server's
memory usage to exceed the Minimum reserved memory setti ngs, i t
deni es the request and goes i nto memory request i dl e mode. In thi s
mode, MC M deni es any requests that w oul d depl ete memory. MC M
remai ns i n memory request i dl e mode unti l the memory used by
Intel l i gence Server fal l s bel ow a certai n l i mi t, know n as the l ow w ater
mark. For i nformati on on how the l ow w ater mark i s cal cul ated, see
Memory Water Marks, page 703. For i nformati on about how MC M
handl es memory request i dl e mode, see Memory R equest Idl e Mode,
page 706.

The Maximum use of virtual address space is applic able in 32-bit

Windows operating s y s tems . For 64-bit operating s y s tems , us e the
Minimum reserved memory s etting to c ontrol the amount of memory
av ailable for Intelligenc e Serv er.

The Memory request idle time i s the l ongest ti me MC M remai ns i n

memory request i dl e mode. If the memory usage has not fal l en bel ow
the l ow w ater mark by the end of the Memory request idle time, MC M
restarts Intel l i gence Server. Setti ng the i dl e ti me to -1 causes
Intel l i gence Server to remai n i dl e unti l the memory usage fal l s bel ow
the l ow w ater mark.

Ho w d o es MCM Gr an t o r Den y a Req u est ?

When a task requests memory, i t provi des MC M w i th an esti mate of
how much memory i t requi res. If the request i s granted, MC M
decreases the amount of avai l abl e memory and the task al l ocates
memory from the memory subsystem. When the task i s compl eted or
cancel ed, the memory i s rel eased and the amount of avai l abl e
memory i ncreases.

701 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

MC M does not submi t memory al l ocati ons to the memory subsystem

(such as a memory manager) on behal f of a task. R ather, i t keeps a
record of how much memory i s avai l abl e and how much memory has
been contracted out to the tasks.

A memory request i s granted i f i t meets the fol l ow i ng cri teri a:

l It i s smal l er than the Maximum single allocation size setti ng.

l It i s smal l er than the hi gh w ater mark, or the l ow w ater mark i f

Intel l i gence Server i s i n memory request i dl e mode. These w ater
marks are deri ved from the Intel l i gence Server memory usage and
the Maximum use of virtual address space and Minimum
reserved memory setti ngs. For detai l ed expl anati ons of the
memory w ater marks, see Memory Water Marks, page 703.

l It i s smal l er than 80 percent of the l argest conti guous bl ock of free

memory to account for memory fragmentati on.

To determi ne w hether a memory request i s granted or deni ed, MC M

fol l ow s the l ogi c i n the fl ow chart bel ow .

© 2019, M icr o St r at egy In c. 702

Syst em Ad m in ist r at io n Gu id e

Memory Water Marks

The hi gh w ater mark (H WM) i s the hi ghest val ue that the sum of
pri vate bytes and outstandi ng memory contracts can reach before
tri ggeri ng memory request i dl e mode. The l ow w ater mark (LWM) i s
the val ue that Intel l i gence Server's pri vate byte usage must drop to
before MC M exi ts memory request i dl e mode. MC M recal cul ates the
hi gh and l ow w ater marks after every 10 MB of memory requests. The
10 MB val ue i s a bui l t-i n benchmark and cannot be changed.

Tw o possi bl e val ues are cal cul ated for the hi gh w ater mark: one
based on vi rtual memory, and one based on vi rtual bytes. For an

703 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

expl anati on of the di fferent types of memory, such as vi rtual bytes and
pri vate bytes, see Memory, page 694.

l The hi gh w ater mark for vi rtual memory (H WM1 i n the di agram

above) i s cal cul ated as ( I n t e l l i g e n c e S e r v e r p r i v a t e
by te s + a v a i l a b l e s y s t e m m e m o r y ). It i s recal cul ated for
each potenti al memory depl eti on.

The av ailable s y s tem memory is c alc ulated us ing the Minimum

reserved memory limit if the ac tual memory us ed by other
proc es s es is les s than this limit.

l The hi gh w ater mark for vi rtual bytes (H WM2 i n the di agram above)
i s cal cul ated as ( I n t e l l i g e n c e S e r v e r p r i v a t e b y t e s ). It
i s cal cul ated the fi rst ti me the vi rtual byte usage exceeds the
amount speci fi ed i n the Maximum use of virtual address space or
Minimum R eserved Memory setti ngs. Because MC M ensures that
Intel l i gence Server pri vate byte usage cannot i ncrease beyond the
i ni ti al cal cul ati on, i t i s not recal cul ated unti l after Intel l i gence
Server returns from the memory request i dl e state.

The hi gh w ater mark used by MC M i s the l ow er of these tw o val ues.

Thi s accounts for the scenari o i n w hi ch, after the vi rtual bytes H WM i s
cal cul ated, Intel l i gence Server rel eases memory but other processes
consume more avai l abl e memory. Thi s can cause a l ater cal cul ati on
of the vi rtual memory H WM to be l ow er than the vi rtual bytes H WM.

The l ow w ater mark i s cal cul ated as 95 percent of the H WM. It i s

recal cul ated every ti me the H WM changes.

Memory Contract Management

Once the hi gh and l ow w ater marks have been establ i shed, MC M

checks to see i f si ngl e memory al l ocati on governi ng i s enabl ed. If i t
i s, and the request i s for an amount of memory l arger than the
Maximum single allocation size setti ng, the request i s deni ed.

© 2019, M icr o St r at egy In c. 704

Syst em Ad m in ist r at io n Gu id e

If si ngl e memory al l ocati on governi ng i s not enabl ed, or i f the request

i s for a bl ock smal l er than the Maximum single allocation size l i mi t,
MC M checks w hether i t i s i n memory request i dl e mode, and
cal cul ates the maxi mum contract request si ze accordi ngl y:

l For normal Intel l i gence Server operati on, the maxi mum request si ze
i s based on the hi gh w ater mark. The formul a i s [ H W M - ( 1 . 0 5 *
(I nt el li g e n c e S e rv e r P r i v a t e B y te s ) + O u t s t a n d i ng
Co nt ra ct s ) ] .

l In memory request i dl e mode, the maxi mum request si ze i s based

on the l ow w ater mark. The formul a i s [ L W M - ( 1 . 0 5 *
(I nt el li g e n c e S e rv e r P r i v a t e B y te s ) + O u t s t a n d i ng
Co nt ra ct s ) ] .

The v alue of 1.05 is a built-in s afety fac tor.

For normal Intel l i gence Server operati on, i f the request i s l arger than
the maxi mum request si ze, MC M deni es the request. It then enters
memory request i dl e mode.

If MC M i s al ready i n memory request i dl e mode and the request i s

l arger than the maxi mum request si ze, MC M deni es the request. It
then checks w hether the memory request i dl e ti me has been
exceeded, and i f so, i t restarts Intel l i gence Server. For a detai l ed
expl anati on of memory request i dl e mode, see Memory R equest Idl e
Mode, page 706.

If the request i s smal l er than the maxi mum request si ze, MC M

performs a fi nal check to account for potenti al fragmentati on of vi rtual
address space. MC M checks w hether i ts record of the l argest free
bl ock of memory has been updated i n the l ast 100 requests, and i f
not, updates the record w i th the si ze of the current l argest free bl ock.
It then compares the request agai nst the l argest free bl ock. If the
request i s more than 80 percent of the l argest free bl ock, the request
i s deni ed. Otherw i se, the request i s granted.

705 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

After granti ng a request, i f MC M has been i n memory request i dl e

mode, i t returns to normal operati on.

Memory Request Idle Mode

When MC M fi rst deni es a request, i t enters memory request i dl e

mode. In thi s mode, MC M deni es al l requests that w oul d keep
Intel l i gence Server's pri vate byte usage above the l ow w ater mark.
MC M remai ns i n memory request i dl e mode unti l one of the fol l ow i ng
si tuati ons occurs:

l Intel l i gence Server's memory usage drops bel ow the l ow w ater

mark. In thi s case, MC M exi ts memory request i dl e mode and
resumes normal operati on.

l MC M has been i n memory request i dl e mode for l onger than the

Memory request idle time. In thi s case, MC M restarts Intel l i gence
Server. Thi s frees up the memory that had been al l ocated to
Intel l i gence Server tasks, and avoi ds memory depl eti on.

The Memory request idle time l i mi t i s not enforced vi a an i nternal

cl ock or schedul er. Instead, after every deni ed request MC M checks
how much ti me has passed si nce the memory request i dl e mode w as
tri ggered. If thi s ti me i s more than the memory request i dl e ti me l i mi t,
Intel l i gence Server restarts.

Thi s el i mi nates a potenti al l y unnecessary Intel l i gence Server restart.

For exampl e, a memory request causes the request i dl e mode to be
tri ggered, but then no more requests are submi tted for some ti me. A
schedul ed check at the end of the Memory request idle time w oul d
restart Intel l i gence Server even though no new j obs are bei ng
submi tted. H ow ever, because Intel l i gence Server i s compl eti ng i ts
exi sti ng contracts and rel easi ng memory, i t i s possi bl e that the next
contract request submi tted w i l l be bel ow the l ow w ater mark. In thi s
case, MC M accepts the request and resumes normal operati on,
w i thout havi ng to restart Intel l i gence Server.

© 2019, M icr o St r at egy In c. 706

Syst em Ad m in ist r at io n Gu id e

When MCM forc es Intelligenc e Serv er to res tart bec aus e of the
Memory request idle time being ex c eeded, it als o writes the
c ontents of Intelligenc e Serv er's memory us e to dis k . This memory
dump is s av ed in the file M C M S e r v e r S t a l l D u m p . d m p in the
Intelligenc e Serv er folder. By default, this folder is loc ated at
C: \P ro g r a m F i l e s
(x 86 )\ M i c r o S t r at e g y \ I n t e l l i g e nc e S e r v e r \ .

Mi croStrategy recommends setti ng the Memory request idle time to

sl i ghtl y l onger than the ti me i t takes most l arge reports i n your system
to run. Thi s w ay, Intel l i gence Server does not shut dow n needl essl y
w hi l e w ai ti ng for a task to compl ete. To hel p you determi ne the ti me
l i mi t, use Enterpri se Manager to fi nd out the average and maxi mum
report executi on ti mes for your system. For i nstructi ons on usi ng
Enterpri se Manager, see the Enterpri se Manager Gui de.

Syst em Memo r y Dep let io n

The di agram bel ow show s an exampl e of a potenti al depl eti on of
system memory.

In thi s exampl e, MC M grants memory request A. Once granted, a new

memory contract i s accounted for i n the avai l abl e system memory.

707 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

R equest B i s then deni ed because i t exceeds the hi gh w ater mark, as

deri ved from the Maximum use of virtual address space setti ng.

Once request B has been deni ed, Intel l i gence Server enters the
memory request i dl e mode. In thi s mode of operati on, i t deni es al l
requests that w oul d push the total memory used above the l ow w ater
mark.

In the exampl e above, request C fal l s above the l ow w ater mark.

Because Intel l i gence Server i s i n memory request i dl e mode, thi s
request i s deni ed unl ess Intel l i gence Server rel eases memory from
el sew here, such as other compl eted contracts.

R equest D i s bel ow the l ow w ater mark, so i t i s granted. Once i t has

been granted, Intel l i gence Server sw i tches out of request i dl e mode
and resumes normal operati on.

If Intel l i gence Server conti nues recei vi ng requests for memory above
the l ow w ater mark before the Memory request idle time i s exceeded,
MC M shuts dow n and restarts Intel l i gence Server.

Vir t u al Byt e Dep let io n

Bel ow i s a di agram of potenti al memory depl eti on due to avai l abl e
bytes i n the Intel l i gence Server vi rtual address space.

© 2019, M icr o St r at egy In c. 708

Syst em Ad m in ist r at io n Gu id e

In thi s exampl e, Intel l i gence Server has i ncreased i ts pri vate byte
usage to the poi nt that exi sti ng contracts are pushed above the hi gh
w ater mark. R equest A i s deni ed because the requested memory
w oul d further depl ete Intel l i gence Server's vi rtual address space.

Once request A has been deni ed, Intel l i gence Server enters the
memory request i dl e mode. In thi s mode of operati on, al l requests that
w oul d push the total memory used above the l ow w ater mark are
deni ed.

The l ow w ater mark i s 95 percent of the hi gh w ater mark. In thi s

scenari o, the hi gh w ater mark i s the amount of Intel l i gence Server
pri vate bytes at the ti me w hen the memory depl eti on w as fi rst
detected. Once the vi rtual byte hi gh w ater mark has been set, i t i s not
recal cul ated. Thus, for Intel l i gence Server to exi t memory request i dl e
mode, i t must rel ease some of the pri vate bytes.

Although the v irtual by tes high water mark is not rec alc ulated, the v irtual
memory high water mark is rec alc ulated after eac h reques t. MCM
c alc ulates the low water mark bas ed on the lower of the v irtual memory
high water mark and the v irtual by tes high water mark . This ac c ounts for
the s c enario in whic h, after the v irtual by tes high water mark is
c alc ulated, Intelligenc e Serv er releas es memory but other proc es s es
c ons ume more av ailable memory . This c an c aus e a later c alc ulation of
the v irtual memory high water mark to be lower than the v irtual by tes
high water mark .

Intel l i gence Server remai ns i n memory request i dl e mode unti l the

memory usage l ooks l i ke i t does at the ti me of request B. The
Intel l i gence Server pri vate byte usage has dropped to the poi nt w here
a request can be made that i s bel ow the l ow w ater mark. Thi s request
i s granted, and MC M exi ts memory request i dl e mode.

If Intel l i gence Server does not free up enough memory to process

request B before the Memory request idle time i s exceeded, MC M
restarts Intel l i gence Server.

709 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Governing Memory for Requests from MicroStrategy

Web Products
You can l i mi t the total amount of memory that Intel l i gence Server can
use for servi ng requests from Mi croStrategy Web, and you can set the
amount of memory that must be kept free for requests from
Mi croStrategy Web. These l i mi ts are enabl ed w hen the Web R equest
job throttling check box i s sel ected. If ei ther condi ti on i s met, al l
requests from Mi croStrategy Web of any nature (l og i n, report
executi on, search, fol der brow si ng) are deni ed unti l the condi ti ons are
resol ved. For more detai l s about each setti ng, see bel ow .

l Maximum Intelligence Server use of total memory sets the

maxi mum amount of total system memory (R AM pl us Page Fi l e) that
can be used by the Intel l i gence Server process compared to the
total amount of memory on the machi ne.

Thi s setti ng i s useful to prevent the system from servi ci ng a Web

request i f memory i s depl eted. If the condi ti on i s met, Intel l i gence
Server deni es al l requests from a Mi croStrategy Web product or a
cl i ent bui l t w i th the Mi croStrategy Web API.

l Minimum machine free physical memory sets the mi ni mum

amount of R AM that must remai n avai l abl e for Web requests. Thi s
val ue i s a percentage of the total amount of physi cal memory on the
machi ne, not i ncl udi ng the Page Fi l e memory.

Thi s can be useful i f the machi ne i s runni ng appl i cati ons other than
Intel l i gence Server and you w ant to i ncrease the chances that
requests from Mi croStrategy Web products are servi ced usi ng R AM
and not the Page Fi l e, w hi ch does not w ork as effi ci entl y.

© 2019, M icr o St r at egy In c. 710

Syst em Ad m in ist r at io n Gu id e

Managing User Sessions

Each user connecti on from a Mi croStrategy cl i ent (Mi croStrategy Web,
D evel oper, N arrow cast Server, and others) establ i shes a user sessi on
on Intel l i gence Server. Each user sessi on consumes a set amount of
resources on the Intel l i gence Server machi ne and can consume
addi ti onal resources dependi ng on the acti ons that the user takes
w hi l e they are connected.

The number of ac tiv e us ers in a s y s tem (thos e ac tually ex ec uting

reports and us ing the s y s tem) is c ons idered a different c ategory of us er
from c onc urrent us ers (thos e s imply logged in).

Thi s secti on covers:

l H ow the concurrent users and user sessi ons on your system use
system resources j ust by l oggi ng i n to the system (see Governi ng
C oncurrent U sers, page 712)

l H ow memory and C PU are used by acti ve users w hen they execute

j obs, run reports, and make requests, and how you can govern
those requests (see Governi ng U ser R esources, page 715)

711 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l H ow user profi l es can determi ne w hat users are abl e to do w hen

they are l ogged i n to the system, and how you can govern those
profi l es (see Governi ng U ser Profi l es, page 719)

Wi th the U ser C onnecti on Moni tor, you can track the users w ho are
connected to the system. For detai l s about how to use thi s system
moni tor, see Moni tori ng U sers' C onnecti ons to Proj ects, page 93.

Governing Concurrent Users

When a user l ogs i n to a Mi croStrategy system, a user sessi on i s
establ i shed. Thi s user sessi on remai ns open unti l the user l ogs out of
the system or the system l ogs the user out. U sers that are l ogged i n
but are not doi ng anythi ng sti l l consume some resources on
Intel l i gence Server. The more user sessi ons that are al l ow ed on
Intel l i gence Server, the more l oad those users can put on the system
because each sessi on can run mul ti pl e j obs.

To hel p control the l oad that user sessi ons can put on the system, you
can l i mi t the number of concurrent user sessi ons al l ow ed for each
proj ect and for Intel l i gence Server. Al so, both D evel oper and
Mi croStrategy Web have sessi on ti meouts so that w hen users forget
to l og out, the system l ogs them out and thei r sessi ons do not
unnecessari l y use up Intel l i gence Server resources.

For exampl e, a user l ogs i n, runs a report, then l eaves for l unch
w i thout l oggi ng out of the system. If Intel l i gence Server i s servi ng the
maxi mum number of user sessi ons and another user attempts to l og i n
to the system, that user i s not al l ow ed to l og i n. You can set a ti me
l i mi t for the total durati on of a user sessi on, and you can l i mi t how
l ong a sessi on remai ns open i f i t i s i nacti ve or not bei ng used. In thi s
case, i f you set the i nacti ve ti me l i mi t to 15 mi nutes, the person w ho
l eft for l unch has thei r sessi on ended by Intel l i gence Server. After
that, another user can l og i n.

© 2019, M icr o St r at egy In c. 712

Syst em Ad m in ist r at io n Gu id e

Intelligenc e Serv er does not end a us er s es s ion until all the jobs
s ubmitted by that us er hav e c ompleted or timed out. This inc ludes
reports that are waiting for autoprompt ans wers . For ex ample, if a
Mic roStrategy Web us er runs a report with an autoprompt and, ins tead
of ans wering the prompt, c lic k s the brows er's Bac k button, an open job
is c reated. If the us er then c los es thier brows er or logs out without
c anc eling the job, the us er s es s ion remains open until the open job
"Waiting for Autoprompt" times out.

These user sessi on l i mi ts are di scussed bel ow as they rel ate to

softw are features and products.

Limit in g t h e Nu mb er o f User Sessio n s o n In t elligen ce Ser ver

Thi s setti ng l i mi ts the number of user sessi ons that can be connected
to an Intel l i gence Server. Thi s i ncl udes connecti ons made from
Mi croStrategy Web products, D evel oper, D i stri buti on Servi ces,
Schedul er, or other appl i cati ons that you may have created w i th the
SD K. A si ngl e user account can establ i sh mul ti pl e sessi ons on an
Intel l i gence Server. Each sessi on connects once to Intel l i gence
Server and once to each proj ect that the user accesses. In the U ser
C onnecti on Moni tor, the connecti ons made to Intel l i gence Server
di spl ay as <Server> i n the Proj ect col umn. Proj ect sessi ons are
governed separatel y w i th a proj ect l evel setti ng, U ser sessions per
project, w hi ch i s di scussed bel ow . When the maxi mum number of
user sessi ons on Intel l i gence Server i s reached, users cannot l og i n,
except for the admi ni strator, w ho can di sconnect current users by
means of the U ser C onnecti on Moni tor or i ncrease thi s governi ng
setti ng.

To speci fy thi s setti ng, i n the Intel l i gence Server C onfi gurati on Edi tor,
sel ect the Governing R ules: D efault: General category and type the
number i n the Maximum number of user sessions fi el d.

713 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Limit in g User Sessio n s Per Pr o ject

When a user accesses a proj ect, a connecti on (cal l ed a user sessi on)
i s establ i shed for the proj ect and Intel l i gence Server. In the U ser
C onnecti on Moni tor, the connecti ons made to the proj ect di spl ay the
proj ect name i n the Proj ect col umn. If you sort the l i st of connecti ons
by the Proj ect col umn, you can see the total number of user sessi ons
for each proj ect.

You can l i mi t the number of sessi ons that are al l ow ed for each
proj ect. When the maxi mum number of user sessi ons for a proj ect i s
reached, users cannot l og i n to the system. An excepti on i s made for
the system admi ni strator, w ho can l og i n to di sconnect current users
by means of the U ser C onnecti on Moni tor or i ncrease thi s governi ng
setti ng.

To speci fy thi s setti ng, i n the Proj ect C onfi gurati on Edi tor for the
proj ect, sel ect the Governing R ules: D efault: U ser sessions
category and type the number i n the U ser sessions per project fi el d.

You can al so l i mi t the number of concurrent sessi ons per user. Thi s
can be useful i f one user account, such as "Guest," i s used for
mul ti pl e connecti ons. To speci fy thi s setti ng, i n the Proj ect
C onfi gurati on Edi tor for the proj ect, sel ect the Governing R ules:
D efault: U ser sessions category and type the number i n the
C oncurrent interactive project sessions per user fi el d.

Limit in g User Sessio n Id le Times

When a user l ogs i n to D evel oper (i n a three-ti er confi gurati on) or
Mi croStrategy Web, a user sessi on i s establ i shed. As l ong as the user
l ogged i nto that sessi on i s usi ng the proj ect, creati ng or executi ng
reports, and so on, the sessi on i s consi dered acti ve. When the user
stops acti vel y usi ng the sessi on, thi s i s consi dered i dl e ti me. You can
speci fy the maxi mum amount of ti me a sessi on can remai n i dl e before
Intel l i gence Server di sconnects that sessi on. Thi s frees up the system

© 2019, M icr o St r at egy In c. 714

Syst em Ad m in ist r at io n Gu id e

resources that the i dl e sessi on w as usi ng and al l ow s other users to

l og i n to the system i f the maxi mum number of user sessi ons has been
reached.

To speci fy thi s setti ng for D evel oper, i n the Intel l i gence Server
C onfi gurati on Edi tor, sel ect the Governing R ules: D efault: General
category and, i n the U ser session idle time (sec) fi el d, type the
number of seconds of i dl e ti me that you w ant to al l ow .

To speci fy thi s setti ng for Mi croStrategy Web, i n the Intel l i gence

Server C onfi gurati on Edi tor, sel ect the Governing R ules: D efault:
General category and, i n the Web user session idle time (sec) fi el d,
type the number of seconds of i dl e ti me that you w ant to al l ow .

If des igners are building Report Serv ic es doc uments and dos s iers in
Mic roStrategy Web, s et the Web user session idle time (sec) to
3600 to av oid a projec t s ourc e timeout.

Governing User Resources

U ser sessi ons consume system resources w hen users l og i n to the
system, especi al l y w hen they use the H i story Li st and, i n
Mi croStrategy Web, the Worki ng Set. If a Web user's sessi on expi res
and the system i s confi gured to al l ow users to recover thei r sessi on
i nformati on, the stored sessi on i nformati on uses resources. Thi s
secti on di scusses these features and how you can govern them.

Lik e all reques ts , us er res ourc es are als o gov erned by the Memory
Contrac t Manager s ettings . For more information about Memory
Contrac t Manager, s ee Governi ng Intel l i gence Server Memory U se
w i th Memory C ontract Manager, page 698 .

Hist o r y List
The H i story Li st i s an i n-memory message l i st that references reports
that a user has executed or schedul ed. The resul ts are stored as

715 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

H i story or Matchi ng-H i story caches on Intel l i gence Server.

The H i story Li st can consume much of the system's resources. You

can govern the resources used by ol d H i story Li st messages i n the
fol l ow i ng w ays:

l You can del ete messages from the H i story Li st w i th a schedul ed

admi ni strati ve task. For more i nformati on and i nstructi ons on
schedul i ng thi s task, see Schedul i ng Admi ni strati ve Tasks, page
983.

l In the Intel l i gence Server C onfi gurati on Edi tor, i n the H istory
settings: General category, you can l i mi t the Maximum number of
messages per user. If a user has hi t thi s maxi mum and tri es to add
another message to the H i story Li st, the ol dest message i s
automati cal l y purged.

l In the Intel l i gence Server C onfi gurati on Edi tor, i n the H istory
settings: General category, you can set the Message lifetime
(days). Intel l i gence Server automati cal l y del etes any H i story Li st
messages that are ol der than the speci fi ed message l i feti me.

For more i nformati on about the H i story Li st, i ncl udi ng detai l s on
H i story Li st governi ng setti ngs, see Savi ng R eport R esul ts: H i story
Li st, page 897.

Wo r kin g Set
When a user runs a report from Mi croStrategy Web or Mi croStrategy
Li brary, the resul ts from the report are added to the w orki ng set for
that user's sessi on and stored i n memory on Intel l i gence Server. The
w orki ng set i s a col l ecti on of messages that reference i n-memory
report i nstances. A message i s added to the w orki ng set w hen a user
executes a report or retri eves a message from the H i story Li st. The
purpose of the w orki ng set i s to:

© 2019, M icr o St r at egy In c. 716

Syst em Ad m in ist r at io n Gu id e

l Improve Mi croStrategy Web performance for report mani pul ati ons,
w i thout havi ng to run SQL agai nst the data w arehouse for each
change

l Al l ow the effi ci ent use of the w eb brow ser's Back button

l Al l ow users to manual l y add messages to the H i story Li st

Each message i n the w orki ng set can store tw o versi ons of the report
i nstance i n memory: the original version and the result version. The
ori gi nal versi on of the report i nstance i s created the fi rst ti me the
report i s executed and i s hel d i n memory the enti re ti me a message i s
part of the w orki ng set. The resul t versi on of the report i nstance i s
added to the w orki ng set onl y after the user mani pul ates the report.
Each report mani pul ati on adds w hat i s cal l ed a del ta XML to the
report message. On each successi ve mani pul ati on, a new del ta XML
i s appl i ed to the resul t versi on. When the user cl i cks the brow ser's
Back button, previ ous del ta XMLs are appl i ed to the ori gi nal report
i nstance up to the state that the user i s requesti ng. For exampl e, i f a
user has made four mani pul ati ons, the report has four del ta XMLs;
w hen the user cl i cks the Back button, the three previ ous XMLs are
appl i ed to the ori gi nal versi on.

Governing History List and Working Set Memory Use in MicroStrategy

Web

You can control the amount of the memory that i s used by the H i story
Li st and Worki ng set i n these w ays:

l Li mi t the number of reports that a user can keep avai l abl e for
mani pul ati on i n a Mi croStrategy Web product. Thi s number i s
defi ned i n the Mi croStrategy Web products' i nterface i n Project
defaults: H istory List setti ngs. You must sel ect the Manually
opti on for addi ng messages to the H i story Li st, then speci fy the
number i n the fi el d l abel ed If manually, how many of the most

717 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

recently run reports and documents do you want to keep

available for manipulation? The defaul t i s 10 and the mi ni mum i s
1. The hi gher the number, the more memory the reports may
consume.

l Li mi t the maxi mum amount of R AM that al l users can use for the
w orki ng set. When the l i mi t i s reached and new report i nstances are
created, the l east recentl y used report i nstance i s sw apped to di sk.
To set thi s, i n the Intel l i gence Server C onfi gurati on Edi tor, under
the Governing R ules: D efault: Working Set category, type the l i mi t
i n the Maximum R A M for Working Set cache (MB ) fi el d.

l If y ou s et this limit to more memory than the operating s y s tem c an

mak e av ailable, Intelligenc e Serv er us es a v alue of 100 MB.

l If y ou s et this limit too low and y ou do not hav e enough hard dis k
s pac e to handle the amount of dis k s wapping, reports may fail to
ex ec ute in peak us age periods bec aus e the reports c annot write to
memory or to dis k .

If a us er s es s ion has an open job, the us er s es s ion remains open and

that job's report ins tanc e is remov ed from the Work ing s et when the
job has finis hed or timed out. In this way , jobs c an c ontinue ex ec uting
ev en after the us er has logged out. This may c aus e ex c es s iv e
memory us age on Intelligenc e Serv er bec aus e the s es s ion's work ing
s et is held in memory until the s es s ion is c los ed. For ins truc tions on
how to s et the timeout period for jobs , s ee Li mi ti ng the Maxi mum
R eport Executi on Ti me, page 727 .

Go ver n in g Saved User Sessio n In f o r mat io n (Micr o St r at egy

Web o n ly)
You can al l ow Web users to recover thei r document, report, or dossi er
after thei r user sessi on has been ended. If thi s feature i s enabl ed and,
for exampl e, the user runs a report and w al ks aw ay from thei r desk
and the sessi on ti mes out, the user sessi on i nformati on i s saved. The

© 2019, M icr o St r at egy In c. 718

Syst em Ad m in ist r at io n Gu id e

next ti me the Web user l ogs i n, i f the recoverabl e sessi on has not
expi red, the user can cl i ck a l i nk to return to thei r recovered report.
Enabl i ng thi s feature uses di sk space for stori ng the i nformati on. You
can govern how l ong the sessi ons are stored before expi ri ng. Long
expi rati on ti mes al l ow more i nformati on to be stored, thus usi ng more
system di sk space. Shorteni ng the expi rati on ti me more qui ckl y frees
up the system resources that the saved sessi on w as usi ng.

To confi gure these setti ngs, access the Intel l i gence Server
C onfi gurati on Edi tor, sel ect the Governing R ules: D efault:
Temporary Storage Settings category. To enabl e the feature, sel ect
the Enable Web U ser Session R ecovery on Logout check box, and
i n the Session R ecovery backup expiration (hrs) fi el d, type the
number of hours you w ant to al l ow a sessi on to be stored. In Session
R ecovery and D eferred Inbox storage directory, speci fy the fol der
w here the user sessi on i nformati on i s stored.

Governing User Profiles

The user profi l e can be defi ned as w hat the user can do w hen l ogged
i n to the system. If you al l ow users to use certai n features i n the
system, they can affect the system's performance. For exampl e, w hen
users schedul e report executi ons, thi s creates user sessi ons on
Intel l i gence Server, thus pl aci ng a l oad on i t even w hen the users are
not acti vel y l ogged i n.

You can l i mi t these types of acti vi ti es by restri cti ng vari ous pri vi l eges,
as di scussed bel ow . For general i nformati on about pri vi l eges and the
Mi croStrategy securi ty model , i ncl udi ng i nstructi ons on how to grant
and revoke pri vi l eges, see C ontrol l i ng Access to Functi onal i ty:
Pri vi l eges, page 109.

Su b scr ip t io n -Relat ed Pr ivileges

Al l ow i ng users to subscri be to reports to be run l ater can affect
system performance. You can l i mi t the use of subscri pti ons by usi ng

719 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

the Web Schedul ed R eports and Schedul e R equest pri vi l eges.

If y ou hav e Dis tribution Serv ic es or Narrowc as t Serv er implemented in

y our s y s tem and us ers hav e the Web Sc heduled Email or Web Send
Now priv ileges , they c an hav e a report emailed either at a s et time or
immediately . This c aus es the s y s tem to c reate a us er s es s ion on
Intelligenc e Serv er when the report is emailed.

For detai l ed i nformati on about subscri bi ng to reports and documents,

see Schedul i ng R eports and D ocuments: Subscri pti ons, page 988.
For i nformati on about D i stri buti on Servi ces, see Overvi ew of
D i stri buti on Servi ces, page 1008.

Hist o r y List Pr ivileges

Al l ow i ng users to use the H i story Li st can consume extra system
resources. Governi ng H i story Li st usage i s di scussed more ful l y i n the
previ ous secti on (see Governi ng U ser R esources, page 715). The
non-admi ni strati ve pri vi l eges rel ati ng to the H i story Li st are:

l Web Subscri be To H i story Li st

l Web Vi ew H i story Li st

l Web Add To H i story Li st

l U se Li nk To H i story Li st i n Emai l (D i stri buti on Servi ces)

l U se H i story Li st

Rep o r t Man ip u lat io n Pr ivileges

The more mani pul ati ons that you al l ow users to do, the greater the
potenti al for usi ng more system resources. Mani pul ati ons that can use
extra system resources i ncl ude pi voti ng, page-by, and sorti ng. You
can l i mi t these mani pul ati ons w i th the fol l ow i ng pri vi l eges:

© 2019, M icr o St r at egy In c. 720

Syst em Ad m in ist r at io n Gu id e

l To l i mi t the use of pi voti ng, use the Web Pi vot R eport and Pi vot
R eport pri vi l eges.

l To l i mi t the use of page-by, use the Web Sw i tch Page-by El ements

pri vi l ege.

l To l i mi t the use of sorti ng, use the Web Sort and Modi fy Sorti ng
pri vi l ege.

Exp o r t in g Pr ivileges
Exporti ng reports can consume l arge amounts of memory, especi al l y
w hen reports are exported to Excel w i th formatti ng. For more
i nformati on on how to l i mi t thi s memory usage, see Li mi ti ng the
N umber of XML C el l s, page 751. The pri vi l eges rel ated to exporti ng
reports are found i n the C ommon pri vi l ege group, and are as fol l ow s:

l Export to Excel

l Export to Fl ash

l Export to H TML

l Export to Mi croStrategy Fi l e

l Export to PD F

l Export to Text

To res tric t us ers from ex porting any reports from Mic roStrategy Web,
us e the Web Ex port priv ilege in the Web Reporter priv ilege group.

OLAP Ser vices Pr ivileges

If you have purchased OLAP Servi ces l i censes for your users, they
coul d use a great deal of the avai l abl e system resources. For
exampl e, i f your users are creati ng l arge Intel l i gent C ubes and doi ng
many mani pul ati ons on them, the system w i l l be l oaded much more

721 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

than i f they are runni ng occasi onal , smal l reports and not performi ng
many mani pul ati ons.

The OLAP Servi ces pri vi l eges are marked w i th a * i n the l i st of al l

pri vi l eges (see the Li st of Pri vi l eges secti on. For more detai l s about
how OLAP Servi ces uses system resources, see Intel l i gent C ubes,
page 759.

Governing Requests
Each user sessi on can execute mul ti pl e concurrent j obs or requests.
Thi s happens w hen users run documents that submi t mul ti pl e chi l d
reports at a ti me or w hen they send a report to the H i story Li st, then
execute another w hi l e the fi rst one i s sti l l executi ng. U sers can al so
l og i n to the system mul ti pl e ti mes and run reports si mul taneousl y.
Agai n, thi s may use up a great deal of the avai l abl e system
resources.

To control the number of j obs that can be runni ng at the same ti me,
you can set l i mi ts on the requests that can be executed. You can l i mi t
the requests per user and per proj ect. You can al so choose to excl ude
reports submi tted as part of a R eport Servi ces document from the j ob

© 2019, M icr o St r at egy In c. 722

Syst em Ad m in ist r at io n Gu id e

l i mi ts (see Excl udi ng D ocument D atasets from the Job Li mi ts, page
723).

Speci fi cal l y, you can l i mi t:

l The total number of j obs (Li mi ti ng the Total N umber of Jobs, page
724)

l The number of j obs per proj ect (Li mi ti ng the N umber of Jobs Per
Proj ect, page 724)

l The number of j obs per user account and per user sessi on (Li mi ti ng
the N umber of Jobs Per U ser Sessi on and Per U ser Account, page
725)

l The number of executi ng reports or data marts per user account (not
counti ng el ement requests, metadata requests, and report
mani pul ati ons) (Li mi ti ng the N umber of Executi ng Jobs Per U ser
and Proj ect, page 726)

l The amount of ti me reports can execute (Li mi ti ng the Maxi mum

R eport Executi on Ti me, page 727)

l A report's SQL (per pass) i ncl udi ng both i ts si ze and the ti me i t

executes (Li mi ti ng a R eport's SQL Per Pass, page 729)

l The amount of memory used for Intel l i gent C ubes (Governi ng

Intel l i gent C ube Memory U sage, page 955)

Excluding Document Datasets from the Job Limits

Mul ti pl e j obs may be submi tted w hen documents and reports are
executed. For exampl e, i f you execute a document that has a prompt
and three reports embedded i n i t, Intel l i gence Server processes fi ve
j obs: one for the document, one for the prompt, and three for the
embedded dataset reports.

To avoi d unexpectedl y preventi ng document from executi ng, you can

excl ude report j obs submi tted as part of document executi on from the

723 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

j ob l i mi ts. In thi s case, i f you execute a document that has a prompt

and three reports embedded i n i t, Intel l i gence Server w oul d onl y
count tw o j obs, the document and the prompt, tow ards the j ob l i mi ts
descri bed bel ow .

To excl ude document dataset j obs from the j ob l i mi ts, i n the

Intel l i gence Server C onfi gurati on Edi tor, sel ect the Governing R ules:
D efault: General category, and sel ect the For Intelligence Server
job and history list governing, exclude reports embedded in
R eport Services documents from the counts check box. Thi s
sel ecti on appl i es to the proj ect-l evel j ob l i mi ts as w el l as to the
server-l evel l i mi ts.

Limiting the Total Number of Jobs

You can l i mi t the total number of concurrent j obs bei ng processed by
Intel l i gence Server. C oncurrent j obs i ncl ude report requests, el ement
requests, and autoprompt requests that are executi ng or w ai ti ng to
execute. C ompl eted (open) j obs, cached j obs, or j obs that have
returned an error are not counted. If the j ob l i mi t i s reached, a user
sees an error message stati ng that the maxi mum number of j obs has
been reached. The user needs to submi t the j ob agai n.

To set thi s l i mi t, i n the Intel l i gence Server C onfi gurati on Edi tor, sel ect
the Governing R ules: D efault: General category, and speci fy the
val ue i n the Maximum number of jobs fi el d. You can al so speci fy a
maxi mum number of i nteracti ve j obs (j obs executed by a di rect user
request) and schedul ed j obs (j obs executed by a schedul ed request).
A val ue of -1 i ndi cates that there i s no l i mi t on the number of j obs that
can be executed.

Limiting the Number of Jobs Per Project

You can l i mi t the number of concurrent j obs that are bei ng processed
by Intel l i gence Server for a proj ect. If you have mul ti pl e proj ects on
an Intel l i gence Server, each can have i ts ow n j ob l i mi t setti ng.

© 2019, M icr o St r at egy In c. 724

Syst em Ad m in ist r at io n Gu id e

Li mi ti ng the number of concurrent j obs per proj ect hel ps reduce

unnecessary strai n on the system by l i mi ti ng the amount of resources
that concurrentl y executi ng j obs can take up.

C oncurrent j obs i ncl ude report requests, el ement requests, and

autoprompt requests that are executi ng or w ai ti ng to execute.
Fi ni shed j obs that are sti l l open, cached j obs, and j obs that returned
an error are not counted. If the l i mi t i s reached, a user sees an error
message stati ng that the number of j obs per proj ect i s too hi gh. The
user then needs to submi t the j ob agai n.

In a c lus tered s y s tem, thes e s ettings limit the number of c onc urrent jobs
per projec t on eac h node of the c lus ter.

To speci fy thi s j ob l i mi t setti ng, i n the Proj ect C onfi gurati on Edi tor for
the proj ect, sel ect the Governing R ules: D efault: Jobs category, and
speci fy the number of concurrent j obs that you w ant to al l ow for the
proj ect i n each Jobs per project fi el d. You can al so speci fy a
maxi mum number of i nteracti ve j obs (j obs executed by a di rect user
request) and schedul ed j obs (j obs executed by a schedul ed request).
A val ue of -1 i ndi cates that the number of j obs that can be executed
has no l i mi t.

Limiting the Number of Jobs Per User Session and Per

User Account
If your users' j ob requests pl ace a heavy burden on the system, you
can l i mi t the number of open j obs w i thi n Intel l i gence Server, i ncl udi ng
el ement requests, autoprompts, and reports for a user.

l To hel p control the number of j obs that can run i n a proj ect and thus
reduce thei r i mpact on system resources, you can l i mi t the number
of concurrent j obs that a user can execute i n a user sessi on. For
exampl e, i f the Jobs per user session l i mi t i s set to four and a user
has one sessi on open for the proj ect, that user can onl y execute

725 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

four j obs at a ti me. H ow ever, the user can bypass thi s l i mi t by

l oggi ng i n to the proj ect mul ti pl e ti mes. (To prevent thi s, see the
next setti ng, Jobs per user account l i mi t.)

To speci fy thi s setti ng, i n the Proj ect C onfi gurati on Edi tor for the
proj ect, sel ect the Governing R ules: Jobs category, and type the
number i n the Jobs per user session fi el d. A val ue of -1 i ndi cates
that the number of j obs that can be executed has no l i mi t

l You can set a l i mi t on the number of concurrent j obs that a user can
execute for each proj ect regardl ess of the number of user sessi ons
that user has at the ti me. For exampl e, i f the user has tw o user
sessi ons and the Jobs per user sessi on l i mi t i s set to four, the user
can run ei ght j obs. But i f thi s Jobs per user account l i mi t i s set to
fi ve, that user can execute onl y fi ve j obs, regardl ess of the number
of ti mes the user l ogs i n to the system. Therefore, thi s l i mi t can
prevent users from ci rcumventi ng the Jobs per user sessi on l i mi t by
l oggi ng i n mul ti pl e ti mes.

To speci fy thi s setti ng, i n the Proj ect C onfi gurati on Edi tor for the
proj ect, sel ect the Governing R ules: Jobs category, and type the
number of j obs per user account that you w ant to al l ow i n the Jobs
per user account fi el d. A val ue of -1 i ndi cates that the number of
j obs that can be executed has no l i mi t.

These tw o l i mi ts count the number of report, el ement, and autoprompt

j ob requests that are executi ng or w ai ti ng to execute. Jobs that have
fi ni shed, cached j obs, or j obs that returned i n error are not counted
tow ard these l i mi ts. If ei ther l i mi t i s reached, any j obs the user
submi ts do not execute and the user sees an error message.

Limiting the Number of Executing Jobs Per User and

Project
If your users tend to request j obs that do not pl ace much burden on
the system, you may w ant to l i mi t onl y executi ng reports and data

© 2019, M icr o St r at egy In c. 726

Syst em Ad m in ist r at io n Gu id e

marts, and sti l l al l ow users to answ er autoprompts and i ssue el ement

requests. You can l i mi t the number of concurrent reports (both regul ar
reports and dataset reports i n a document) i n a proj ect per user
account.

Thi s l i mi t i s cal l ed Executing jobs per user. If the l i mi t i s reached for

the proj ect, new report requests are pl aced i n the Intel l i gence Server
queue unti l other j obs fi ni sh. They are then processed i n the order i n
w hi ch they w ere pl aced i n the queue, w hi ch i s control l ed by the
pri ori ty map (see Pri ori ti zi ng Jobs, page 737).

To speci fy thi s l i mi t setti ng, i n the Proj ect C onfi gurati on Edi tor for the
proj ect, sel ect the Governing R ules: D efault: Jobs category, and
type the number of concurrent report j obs per user you w ant to al l ow
i n the Executing jobs per user fi el d. A val ue of -1 i ndi cates that the
number of j obs that can be executed has no l i mi t.

Limiting the Maximum Report Execution Time

You can l i mi t a j ob i n Intel l i gence Server by speci fyi ng the maxi mum
amount of ti me that a j ob can execute w i thi n a proj ect. Intel l i gence
Server cancel s any j obs that exceed the l i mi t.

To set thi s l i mi t, i n the Proj ect C onfi gurati on Edi tor, sel ect the
Governing R ules: D efault: R esult Sets category, and speci fy the
number of seconds i n the Intelligence Server Elapsed Time (sec)
fi el ds. You can set di fferent l i mi ts for ad-hoc reports and schedul ed
reports.

Thi s l i mi t appl i es to most operati ons that are entai l ed i n a j ob from

the ti me i t i s submi tted to the ti me the resul ts are returned to the user.
If the j ob exceeds the l i mi t, the user sees an error message and
cannot vi ew the report.

The fi gure bel ow i l l ustrates how j ob tasks make up the enti re report
executi on ti me. In thi s i nstance, the ti me l i mi t i ncl udes the ti me

727 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

w ai ti ng for the user to compl ete report prompts. Each step i s

expl ai ned i n the tabl e bel ow .

Ste p Sta tus Comme nt

Wait ing f or
1 Resolving prompt s
A ut oprompt

2* Wait ing (in queue) E lement request is wait ing in job queue f or execut ion

3* E xecut ing E lement request is execut ing on t he dat abase

Wait ing f or
4 Wait ing f or user t o make prompt select ions
A ut oprompt

5 Wait ing (in queue) Wait ing in job queue f or execut ion

Query engine execut es S QL on dat abase (can be

6 E xecut ing
mult iple passes)

7 E xecut ing A nalyt ical engine processes result s

*Steps 2 and 3 are for an el ement request. They are executed as

separate j obs. D uri ng steps 2 and 3, the ori gi nal report j ob has the
status "Wai ti ng for Autoprompt."

The following tas k s are not s hown in the ex ample abov e bec aus e they
c ons ume v ery little time. Howev er, they als o c ount toward the report
ex ec ution time.

© 2019, M icr o St r at egy In c. 728

Syst em Ad m in ist r at io n Gu id e

l El ement request SQL generati on

l R eport SQL generati on

l R eturni ng resul ts from the database

For more i nformati on about the j ob processi ng steps, see Processi ng

Jobs, page 59.

Limiting a Report's SQL Per Pass

You can l i mi t a report's SQL si ze per pass. Thi s i ncl udes l i mi ts on the
amount of ti me that each pass can take and the maxi mum si ze (i n
bytes) that the SQL statement can be. These l i mi ts are set i n the
VLD B properti es, as descri bed bel ow . For more i nformati on about
VLD B properti es i n general , see SQL Generati on and D ata
Processi ng: VLD B Properti es

You can al so l i mi t the amount of memory that Intel l i gence Server uses
duri ng report SQL generati on. Thi s l i mi t i s set for al l reports
generated on the server. To set thi s l i mi t, i n the Proj ect C onfi gurati on
Edi tor, open the Governing R ules: D efault: R esult Sets category,
and speci fy the Memory consumption during SQL generation. A
val ue of -1 i ndi cates no l i mi t.

SQL Time Ou t (Per Pass) (Dat ab ase In st an ce an d Rep o r t )

You can l i mi t the amount of ti me that each pass of SQL can take
w i thi n the data w arehouse. If the ti me for a SQL pass reaches the
maxi mum, Intel l i gence Server cancel s the j ob and the user sees an
error message. You can speci fy thi s setti ng at ei ther the database
i nstance l evel or at the report l evel .

To speci fy thi s setti ng, edi t the VLD B properti es for the database
i nstance or for a report, expand Governing settings, then sel ect the
SQL Time Out (Per Pass) opti on.

729 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Maximu m SQL Size (Dat ab ase In st an ce)

You can l i mi t the si ze (i n bytes) of the SQL statement per pass before
i t i s submi tted to the data w arehouse. If the si ze for a SQL pass
reaches the maxi mum, Intel l i gence Server cancel s the j ob and the
user sees an error message. You can speci fy thi s setti ng at the
database i nstance l evel .

To speci fy thi s, edi t the VLD B properti es for the database i nstance,
expand Governing settings, then sel ect the Maximum SQL Size
opti on.

Limiting the Size of Messages Logged to Kafka

Mi croStrategy can l og messages to Kakfa w hi ch are stored as text
fi l es. Li mi ti ng the si ze of these fi l es al l ow s you to qui ckl y di agnose
probl ems i f they occur. The defaul t setti ng for these l og fi l es i s set to
20 MB and can be adj usted i n the L o g C o n s u m e r . p r o p e r t i e s fi l e
or the Kafka C onsumer C onsol e.

When the l og fi l es reach the si ze l i mi t they w i l l automati cal l y rol l over

to a backup fi l e.

To Ad ju st t h e Set t in g in t h e Pr o p er t ies File

1. Open Lo g C o n s u m e r . p r o p e r t i e s from one of the fol l ow i ng
l ocati ons:

l Wi ndow s: C : \ P r og r a m F i l e s
(x 86 )\ M i c r o S t r a t e g y \ I n t e l l i g e n c e
Se rv er \ K a f k a C o n s u m e r \ L o g C o n s u m e r . p r o p e r t i e s

l Li nux:
[I ns ta l l P a t h ] / I n t e l l i g e n c e S e r v e r / K a f k a C o n s u me r
/L og Co n s u m e r . p r o p e r t i e s

© 2019, M icr o St r at egy In c. 730

Syst em Ad m in ist r at io n Gu id e

2. Modi fy the setti ng ma x _f i l e _s i z e _M = 2 0 by repl aci ng the

defaul t val ue of 2 0 w i th the MB you w oul d l i ke l og fi l es to be.

3. C l i ck Save.

To Ad ju st t h e Set t in g via Kaf ka Co n su mer Co n so le

1. D el ete the L o g C o n s u m e r . p r o p e r t i e s properti es fi l e.

2. Open the Kafka C onsumer C onsol e by executi ng the fol l ow i ng

command:

ja va -j a r K a f k a C o n s u m e r . j a r

3. Fol l ow the command l i ne prompts to enter the Kafka consumer

setti ngs.

Managing Job Execution

The system's abi l i ty to execute j obs i s l i mi ted by the avai l abl e system
resources and by how those resources are used by Intel l i gence
Server.

Thi s secti on di scusses the di fferent w ays you have of managi ng j ob

executi on. These i ncl ude:

731 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Managi ng D atabase C onnecti on Threads, page 732

l Pri ori ti zi ng Jobs, page 737

l R esul ts Processi ng, page 742 (the processi ng that Intel l i gence
Server performs on resul ts returned from the data w arehouse)

Managing Database Connection Threads

The mai n factor that determi nes j ob executi on performance i s the
number of database connecti ons that are made to the data
w arehouse. R eport and el ement requests are submi tted from
Intel l i gence Server to the data w arehouse through a database
connecti on thread. R esul ts of these requests are al so returned to
Intel l i gence Server through the database connecti on thread.

You must determi ne the number of threads that stri kes a good bal ance
betw een qui ckl y servi ng each user request w hi l e not overl oadi ng the
system. The overal l goal i s to pri ori ti ze j obs and provi de enough
threads so that j obs that must be processed i mmedi atel y are
processed i mmedi atel y, and the remai nder of j obs are processed as
ti mel y as possi bl e. If your system has hundreds of concurrent users
submi tti ng requests, you must determi ne at w hat poi nt to l i mi t the
number of database connecti on threads by pl aci ng user requests i n a
queue.

The number of avai l abl e database connecti on threads fal l s i n the

range depi cted as the Opti mal use of resources i n the i l l ustrati on
bel ow .

© 2019, M icr o St r at egy In c. 732

Syst em Ad m in ist r at io n Gu id e

To moni tor w hether the number of database connecti on threads i n

your system i s effecti ve, use the D atabase C onnecti on Moni tor. For
more i nformati on about thi s tool , see Moni tori ng D atabase Instance
C onnecti ons, page 25. If al l threads are "Busy" a hi gh percentage of
the ti me, consi der i ncreasi ng the number of connecti on threads as
l ong as your data w arehouse can handl e the l oad and as l ong as
Intel l i gence Server does not become overl oaded.

Once you have the number of threads cal cul ated, you can then set j ob
pri ori ti es and control how many threads are dedi cated to servi ng j obs
meeti ng certai n cri teri a.

Limit in g an d Pr io r it izin g t h e Nu mb er o f Dat ab ase

Co n n ect io n s
To set the number of database connecti on threads al l ow ed at a ti me,
modi fy the database i nstance used to connect to the data w arehouse.
U se the Job Prioritization tab i n the D atabase Instance Edi tor and
speci fy the number of hi gh, medi um, and l ow connecti ons. The sum of
these numbers i s the total number of concurrent connecti on threads
al l ow ed betw een Intel l i gence Server and the data w arehouse. These
setti ngs appl y to al l proj ects that use the sel ected database i nstance.

733 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

You s hould hav e at leas t one low-priority c onnec tion av ailable, bec aus e
low priority is the default job priority , and low-priority jobs c an us e only
low-priority databas e c onnec tion threads . Medium-priority c onnec tion
threads are res erv ed for medium- and high-priority jobs , and high-
priority c onnec tion threads are res erv ed for high-priority jobs only . For
more information about job priority , inc luding ins truc tions on how to s et
job priority , s ee Pri ori ti zi ng Jobs, page 737 .

If y ou s et all c onnec tions to z ero, jobs are not s ubmitted to the data
warehous e. This may be a us eful way for y ou to tes t whether s c heduled
reports are proc es s ed by Intelligenc e Serv er properly . J obs wait in the
queue and are not s ubmitted to the data warehous e until y ou inc reas e
the c onnec tion number, at whic h point they are then s ubmitted to the
data warehous e. Onc e the tes ting is ov er, y ou c an delete thos e jobs s o
they are nev er s ubmitted to the data warehous e.

Op t imizin g Dat ab ase Co n n ect io n Th r ead s Usin g ODBC

Set t in gs
In addi ti on to l i mi ti ng the number of database connecti on threads
created betw een Intel l i gence Server and the data w arehouse, i t i s a
good practi ce to effi ci entl y use those connecti on threads once they
are establ i shed. You w ant to ensure that the threads are bei ng used
and are not ti ed up by processes that are runni ng too l ong. To
opti mi ze how those threads are used, you can l i mi t the l ength of ti me
they can be used by certai n j obs. These l i mi ts are descri bed bel ow .

To set these l i mi ts, edi t the database i nstance, then modi fy the
database connecti on (at the bottom of the D atabase Instances di al og
box), and on the D atabase C onnecti ons di al og box, sel ect the
A dvanced tab. A val ue of 0 or -1 i ndi cates no l i mi t.

© 2019, M icr o St r at egy In c. 734

Syst em Ad m in ist r at io n Gu id e

Maximum Cancel Attempt Time

When a user runs a report that executes for a l ong ti me on the data
w arehouse, the user can cancel the j ob executi on. Thi s may be due to
an error i n the report's desi gn, especi al l y i f i t i s i n a proj ect i n a
devel opment envi ronment, or the user may si mpl y not w ant to w ai t
any l onger. If the cancel i s not successful after 30 seconds,
Intel l i gence Server del etes that j ob's database connecti on thread.
The Maximum cancel attempt time (sec) fi el d control s how l ong you
w ant Intel l i gence Server to w ai t i n addi ti on to the 30 seconds before
del eti ng the thread.

Maximum Query Execution Time

Thi s i s the maxi mum amount of ti me that a si ngl e pass of SQL can
execute on the data w arehouse. When the SQL statement or fetch
operati on begi ns, a ti mer starts counti ng. If the Maximum query
execution time (sec) l i mi t i s reached before the SQL operati on i s
concl uded, Intel l i gence Server cancel s the operati on.

Thi s setti ng i s very si mi l ar to the SQL time out (per pass) VLD B
setti ng (see Li mi ti ng a R eport's SQL Per Pass, page 729). That VLD B
setti ng overri des the Maximum query execution time (sec) setti ng.
Thi s setti ng i s made on the database connecti on and can be used to
govern the maxi mum query executi on ti me across al l proj ects that use
that connecti on. The VLD B setti ng can overri de thi s setti ng for a
speci fi c report.

Maximum Connection Attempt Time

Thi s i s the maxi mum amount of ti me that Intel l i gence Server w ai ts

w hi l e attempti ng to connect to the data w arehouse. When the
connecti on i s i ni ti ated, a ti mer starts counti ng. If the Maximum
connection attempt time (sec) l i mi t i s reached before the connecti on

735 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

i s successful , the connecti on i s cancel ed and an error message i s

di spl ayed.

Limit in g Dat ab ase Co n n ect io n Cach es

Establ i shi ng a database connecti on thread i s expensi ve i n terms of
ti me and resources. Because of thi s, Intel l i gence Server caches the
threads so that every SQL pass and j ob executi on i t performs does
not need to create a new connecti on. R ather, those processes use an
exi sti ng cached thread. H ow ever, the R D BMS may, after a certai n
ti me l i mi t, del ete the connecti on threads w i thout noti fyi ng Intel l i gence
Server. If thi s happens and an Intel l i gence Server j ob tri es to use a
cached connecti on thread, the user sees an error message. To avoi d
thi s, you can l i mi t the l ength of ti me that a database connecti on cache
can exi st. You can l i mi t the maxi mum l i feti me of a database
connecti on (see C onnecti on Li feti me, page 736), and you can l i mi t the
amount of ti me an i nacti ve database connecti on remai ns open (see
C onnecti on Idl e Ti meout, page 737).

To set these l i mi ts, edi t the database i nstance, then modi fy the
database connecti on (at the bottom of the D atabase Instances di al og
box), and on the D atabase C onnecti ons di al og box, sel ect the
A dvanced tab. For these setti ngs, a val ue of -1 i ndi cates no l i mi t, and
a val ue of 0 i ndi cates that the connecti on i s not cached and i s del eted
i mmedi atel y w hen executi on i s compl ete.

Connection Lifetime

The C onnection lifetime (sec) l i mi t i s the maxi mum amount of ti me

that a database connecti on thread remai ns cached. The C onnection
lifetime shoul d be shorter than the data w arehouse R D BMS
connecti on ti me l i mi t. Otherw i se the R D BMS may del ete the
connecti on i n the mi ddl e of a j ob.

© 2019, M icr o St r at egy In c. 736

Syst em Ad m in ist r at io n Gu id e

When the C onnection lifetime i s reached, one of the fol l ow i ng

occurs:

l If the database connecti on has a status of C ached (i t i s i dl e, but

avai l abl e) w hen the l i mi t i s reached, the connecti on i s del eted.

l If the database connecti on has a status of B usy (i t i s executi ng a

j ob) w hen the l i mi t i s reached, the connecti on i s del eted as soon as
the j ob compl etes. The database connecti on does not go i nto a
C ached state.

Connection Idle Timeout

The C onnection idle timeout (sec) l i mi t i s the amount of ti me that an

i nacti ve connecti on thread remai ns cached i n Intel l i gence Server unti l
i t i s termi nated. When a database connecti on fi ni shes a j ob and no
j ob i s w ai ti ng to use i t, the connecti on becomes cached. If the
connecti on remai ns cached for l onger than thi s ti meout l i mi t, the
database connecti on thread i s then del eted. Thi s prevents
connecti ons from tyi ng up data w arehouse and Intel l i gence Server
resources i f they are not needed.

Prioritizing Jobs
Job pri ori ty defi nes the order i n w hi ch j obs are processed. Jobs are
usual l y executed as fi rst-come, fi rst-served. H ow ever, your system
probabl y has certai n j obs that need to be processed before other j obs.

Job pri ori ty does not affect the amount of resources a j ob gets once i t
i s submi tted to the data w arehouse. R ather, i t determi nes w hether
certai n j obs are submi tted to the data w arehouse before other j obs i n
the queue.

For exampl e, an executi ve i n your company runs reports at unpl anned

ti mes and you w ant to ensure that these reports are i mmedi atel y
processed. If no pri ori ty i s set for the executi ve's reports, they are
processed w i th the other j obs i n the system. D ependi ng on data

737 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

w arehouse acti vi ty, thi s may requi re some w ai t ti me. If you assi gn a
hi gh pri ori ty to al l j obs from the executi ve's user group, Intel l i gence
Server processes and submi ts those j obs to the data w arehouse fi rst,
rather than w ai ti ng for other j obs to fi ni sh.

Intel l i gence Server processes a j ob on a database connecti on that

corresponds to the j ob's pri ori ty. If no pri ori ty i s speci fi ed for a j ob,
Intel l i gence Server processes the j ob on a l ow -pri ori ty connecti on.
For exampl e, j obs w i th hi gh pri ori ty are processed by hi gh-pri ori ty
connecti ons, and j obs w i th l ow or no pri ori ty are processed by a l ow -
pri ori ty connecti on. For i nformati on about setti ng database connecti on
thread pri ori ty, see Managi ng D atabase C onnecti on Threads, page
732.

Intel l i gence Server al so engages i n connecti on borrow i ng w hen

processi ng j obs. C onnecti on borrow i ng occurs w hen Intel l i gence
Server executes a j ob on a l ow er pri ori ty connecti on because no
connecti ons that correspond to the j ob's pri ori ty are avai l abl e at
executi on ti me. H i gh-pri ori ty j obs can run on hi gh-, medi um-, and l ow -
pri ori ty connecti ons. Li kew i se, medi um-pri ori ty j obs can run on
medi um- and l ow -pri ori ty connecti ons.

When a j ob i s submi tted and no connecti ons are avai l abl e to process
i t, ei ther w i th the same pri ori ty or w i th a l ow er pri ori ty, Intel l i gence
Server pl aces the j ob i n queue and then processes i t w hen a
connecti on becomes avai l abl e.

You can set j obs to be hi gh, medi um, or l ow pri ori ty, by one or more of
the fol l ow i ng vari abl es:

l R equest type: R eport requests and el ement requests can have

di fferent pri ori ty (Pri ori ti zi ng Jobs by R equest Type, page 740).

l A pplication type: Jobs submi tted from di fferent Mi croStrategy

appl i cati ons, such as D evel oper, Schedul er, Mi croStrategy Web,
Li brary, Mi croStrategy D esktop, Mi croStrategy Workstati on, or

© 2019, M icr o St r at egy In c. 738

Syst em Ad m in ist r at io n Gu id e

N arrow cast Server, are processed accordi ng to the pri ori ty that you
speci fy (Pri ori ti zi ng Jobs by Mi croStrategy Appl i cati on Type, page
740).

l U ser group: Jobs submi tted by users i n the groups you sel ect are
processed accordi ng to the pri ori ty that you speci fy (Pri ori ti zi ng
Jobs by U ser Group, page 740).

l C ost: Jobs w i th a hi gher resource cost are processed accordi ng to

the pri ori ty that you speci fy (Pri ori ti zi ng Jobs by R eport C ost, page
741). Job cost i s an arbi trary val ue you can assi gn to a report that
represents the resources used to process that j ob.

l Project: Jobs submi tted from di fferent proj ects are processed
accordi ng to the pri ori ty that you speci fy (Pri ori ti zi ng Jobs by
Proj ect, page 742).

These vari abl es al l ow you to create sophi sti cated rul es for w hi ch j ob
requests are processed fi rst. For exampl e, you coul d speci fy that any
el ement requests are hi gh pri ori ty, any requests from your test proj ect
are l ow pri ori ty, and any requests from users i n the D evel opers group
are medi um pri ori ty.

A j ob i s processed at the hi ghest pri ori ty assi gned to i t by any rul es.
For exampl e, i f you set al l j obs from your test proj ect at l ow pri ori ty,
and al l j obs from users i n the D evel opers group at medi um pri ori ty,
j obs i n the test proj ect that are requested by users i n the D evel opers
group are processed at medi um pri ori ty.

To Set Job Prioritization Rules

1. On the Intel l i gence Server machi ne, i n D evel oper, l og i n to a

proj ect source. You must l og i n as a user w i th admi ni strati ve
pri vi l eges.

739 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

2. Expand the A dministration fol der, then expand C onfiguration

Managers, and then sel ect D atabase Instances.

3. R i ght-cl i ck the database i nstance used to connect to the data

w arehouse and sel ect Prioritization.

4. To add new j ob pri ori ti zati on rul es, cl i ck N ew.

Pr io r it izin g Jo b s b y Req u est Typ e

You can sel ect w hether el ement requests or report requests are
processed fi rst. For exampl e, you may w ant el ement requests to be
submi tted to the data w arehouse before report requests, because
el ement requests are general l y used i n prompts and you do not w ant
users to have to w ai t l ong w hi l e prompt val ues l oad. In thi s case you
mi ght speci fy al l el ement requests to be processed at a hi gh pri ori ty
by defaul t, and al l report requests to be processed at a l ow pri ori ty by
defaul t.

Pr io r it izin g Jo b s b y Micr o St r at egy Ap p licat io n Typ e

You can assi gn a di fferent pri ori ty to j obs submi tted from D evel oper,
Mi croStrategy Web, Schedul er, and N arrow cast Server. Al l j obs
submi tted from the speci fi ed appl i cati on use the speci fi ed pri ori ty. For
exampl e, you may w ant report desi gners to be abl e to qui ckl y test
thei r reports, so you may speci fy that al l j obs that are submi tted from
D evel oper are processed at a hi gh pri ori ty.

Pr io r it izin g Jo b s b y User Gr o u p
You can assi gn a di fferent pri ori ty to j obs submi tted from di fferent
Mi croStrategy user groups. For exampl e, you can assi gn al l j obs from
users i n the Executi ve user group to be processed at a hi gh pri ori ty.

© 2019, M icr o St r at egy In c. 740

Syst em Ad m in ist r at io n Gu id e

Pr io r it izin g Jo b s b y Rep o r t Co st
R eport cost i s an arbi trary val ue that you can assi gn to a report to
hel p determi ne i ts pri ori ty i n rel ati on to other requests. If you choose
to use report cost as a pri ori ty vari abl e, you must defi ne a set of
pri ori ty groups based on report cost. The defaul t pri ori ty groups are:

l Li ght: reports w i th costs betw een 0 and 334

l Medi um: reports w i th costs betw een 335 and 666

l H eavy: reports w i th costs betw een 667 and 999

The set of cost groupi ngs must cover al l val ues from 0 to 999. You
can then assi gn a pri ori ty l evel to each pri ori ty group. For exampl e,
you can set heavy reports to l ow pri ori ty, because they are l i kel y to
take a l ong ti me to process, and set l i ght reports to hi gh pri ori ty,
because they do not pl ace much strai n on the system resources.

Once you determi ne the cost groupi ngs, you can set the report cost
val ue on i ndi vi dual reports. For exampl e, you noti ce that a report
requi res si gni fi cantl y more processi ng ti me than most other reports.
You can assi gn i t a report cost of 900 (heavy). In thi s sampl e
confi gurati on, the report has a l ow pri ori ty. For factors that may hel p
you determi ne the cost of a report, see R esul ts Processi ng, page 742.

You set the cost of a report i n the report's Properti es di al og box, i n

the Priority category. You must have system admi ni strator pri vi l eges
to set the cost of a report.

To Set the Cost for a Report

1. In D evel oper, ri ght-cl i ck the report and sel ect Properties.

2. Sel ect the Priority category.

3. In the R eport C ost fi el d, type the cost of the report. H i gher

numbers i ndi cate a report that uses a great deal of system

741 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

resources. Low er numbers i ndi cate a l ess resource-i ntensi ve

report.

4. C l i ck OK .

Pr io r it izin g Jo b s b y Pr o ject
You can assi gn a di fferent pri ori ty to reports from di fferent proj ects.
For exampl e, you may w ant al l j obs submi tted from your producti on
proj ect to have a medi um pri ori ty, so that they take precedence over
reports from your test proj ect.

Results Processing
When Intel l i gence Server processes resul ts that are returned from the
data w arehouse, several factors determi ne how much of the machi ne's
resources are used. These factors i ncl ude:

l Whether Intel l i gence Server i s usi ng thread bal anci ng (see

Intel l i gence Server Thread Bal anci ng, page 742)

l The si ze of the report (see Li mi ti ng the Maxi mum R eport Si ze, page
743)

l Whether the report i s an Intel l i gent C ube (see Li mi ti ng the Si ze and

N umber of Intel l i gent C ubes, page 747)

l Whether the report i s i mported from an external data source (see

Li mi ti ng the Memory U sed D uri ng D ata Fetchi ng, page 748)

In t elligen ce Ser ver Th r ead Balan cin g

By defaul t, threads w i thi n Intel l i gence Server process tasks i n the
order that they are recei ved. You can confi gure Intel l i gence Server to
al l ocate threads to processes, such as obj ect servi ng, el ement
servi ng, SQL generati on, and so forth, that need them most, w hi l e
l ess l oaded processes can return threads to the avai l abl e pool .

© 2019, M icr o St r at egy In c. 742

Syst em Ad m in ist r at io n Gu id e

To enabl e thread bal anci ng for Intel l i gence Server, i n the Intel l i gence
Server C onfi gurati on Edi tor, i n the Server D efinition: A dvanced
category, sel ect the B alance MicroStrategy Server threads check
box.

Limit in g t h e Maximu m Rep o r t Size

A report i nstance i s the versi on of the report resul ts that Intel l i gence
Server hol ds i n memory for cache and w orki ng set resul ts. The si ze of
the report i nstance i s proporti onal to the si ze of the report resul ts, that
i s, the row si ze mul ti pl i ed by the number of row s.

The row si ze depends on the data types of the attri butes and metri cs
on the report. D ates are the l argest data type. Text stri ngs, such as
descri pti ons and names, are next i n si ze, unl ess the descri pti on i s
unusual l y l ong, i n w hi ch case they may be l arger than dates.
N umbers, such as ID s, total s, and metri c val ues, are the smal l est.

The easi est w ay to esti mate the amount of memory that a report uses
i s to vi ew the si ze of the cache fi l es usi ng the C ache Moni tor i n
D evel oper. The C ache Moni tor show s the si ze of the report resul ts i n
bi nary format, w hi ch from testi ng has proven to be 30 to 50 percent of
the actual si ze of the report i nstance i n memory. For i nstructi ons on
how to use the C ache Moni tor to vi ew the si ze of a cache, see
Moni tori ng R esul t C aches, page 873.

Intel l i gence Server al l ow s you to govern the si ze of a report or

request i n the fol l ow i ng w ays:

l Li mi ti ng the N umber of R eport R esul t R ow s, page 744

l Li mi ti ng the N umber of El ement R ow s, page 745

l Li mi ti ng the N umber of Intermedi ate R ow s, page 746

Lik e all reques ts , large report ins tanc es are als o gov erned by the
Memory Contrac t Manager s ettings . For more information about

743 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Memory Contrac t Manager, s ee Governi ng Intel l i gence Server

Memory U se w i th Memory C ontract Manager, page 698 .

Limiting the Number of Report Result Rows

R eports w i th a l arge number of resul t row s can take up a great deal of

memory at run ti me. For exampl e, your data w arehouse may contai n
dai l y sal es data for thousands of i tems over several years. If a user
attempts to bui l d a report that l i sts the revenue from every i tem for
every day i n the data w arehouse, the report may use al l avai l abl e
Intel l i gence Server memory.

You can l i mi t a report's si ze i n Intel l i gence Server by setti ng a

maxi mum l i mi t on the number of row s that a report can contai n. Thi s
setti ng i s appl i ed by the Query Engi ne w hen retri evi ng the resul ts
from the database. If the report exceeds thi s l i mi t, the report i s not
executed and an error message i s di spl ayed.

To set the maxi mum number of resul t row s for al l reports, data marts,
and Intel l i gent C ubes i n a proj ect, i n the Proj ect C onfi gurati on Edi tor,
expand the Governing R ules: D efault: R esult Sets category, and
type the maxi mum number i n the appropri ate Final R esult R ows fi el d.
You can set di fferent l i mi ts for standard reports, Intel l i gent C ubes,
and data marts.

You can al so set the resul t row l i mi t for a speci fi c report i n that
report's VLD B properti es. The VLD B properti es l i mi t for a report
overri des the proj ect l i mi t. For exampl e, i f you set the proj ect l i mi t at
10,000 row s, but set the l i mi t to 20,000 row s for a speci fi c report that
usual l y returns more than 10,000 row s, users are abl e to see that
report w i thout any errors.

© 2019, M icr o St r at egy In c. 744

Syst em Ad m in ist r at io n Gu id e

To Set the Result Set Limit for a Specific Report

1. In D evel oper, ri ght-cl i ck the report to set the l i mi t for and sel ect
Edit.

2. From the D ata menu, sel ect VLD B properties.

3. Expand the Governing setti ngs, then sel ect R esults Set R ow
Limit.

4. Make sure the U se default inherited value check box i s cl eared.

5. In the R esults Set R ow Limit fi el d, type the l i mi t.

6. C l i ck Save and C lose.

Limiting the Number of Element Rows

Another w ay that you can l i mi t the si ze of a request i s to l i mi t the

number of el ement row s returned at a ti me. El ement row s are returned
w hen a user accesses a report prompt, and w hen usi ng the D ata
Expl orer feature i n D evel oper.

El ement row s are i ncremental l y fetched, that i s, returned i n smal l

batches, from the data w arehouse to Intel l i gence Server. The si ze of
the i ncrement depends on the maxi mum number of el ement row s
speci fi ed i n the cl i ent. Intel l i gence Server i ncremental l y fetches four
ti mes the number for each el ement request.

For more i nformati on about el ement requests, such as how they are
created, how i ncremental fetch w orks, and the caches that store the
resul ts, see El ement C aches, page 920.

Mi croStrategy recommends that you set the el ement row l i mi t to be

l arger than the maxi mum number of attri bute el ement row s that you
expect users to brow se. For exampl e, i f the Product tabl e i n the data
w arehouse has 10,000 row s that users w ant to brow se and the Order
tabl e has 200,000 row s that you do not expect users to brow se, you

745 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

shoul d set thi s l i mi t to 11,000. Intel l i gence Server i ncremental l y

fetches the el ement row s. If the el ement row s l i mi t i s reached, the
user sees an error message and cannot vi ew the prompt or the data.

To set the maxi mum number of el ement row s returned for al l el ement
requests i n a proj ect i n D evel oper, i n the Proj ect C onfi gurati on Edi tor
for that proj ect, expand the Governing R ules: D efault: R esult Sets
category and type the number i n the A ll element browsing result
rows fi el d.

To Set the Number of Objects Returned for Requests in

MicroStrategy Web

1. In Mi croStrategy Web, l og i n to a proj ect as a user w i th the Web

Admi ni strati on pri vi l ege.

2. C l i ck the MicroStrategy i con, then sel ect Preferences.

3. Sel ect Project defaults, and then sel ect the General category.

4. In the Incremental Fetch secti on, speci fy the val ues i n the
Maximum number of attribute elements per block and
Maximum number of report objects per block fi el ds.

5. C l i ck OK .

Limiting the Number of Intermediate Rows

You can l i mi t a report's si ze on Intel l i gence Server by setti ng a

maxi mum number of i ntermedi ate resul t row s that are al l ow ed i n
Intel l i gence Server. Thi s l i mi t does not appl y to the row s i n
i ntermedi ate or temporary tabl es created i n the data w arehouse.
R ather, i t control s the number of row s hel d i n memory i n the
Anal yti cal Engi ne processi ng uni t of Intel l i gence Server for anal yti c
cal cul ati ons that cannot be done on the database. Low eri ng thi s
setti ng reduces the amount of memory consumed for l arge reports. If

© 2019, M icr o St r at egy In c. 746

Syst em Ad m in ist r at io n Gu id e

the l i mi t i s reached, the user sees an error message and cannot vi ew

the report. For exampl e, thi s may happen w hen you add a compl ex
subtotal to a l arge report or w hen you pi vot a l arge report.

To speci fy thi s l i mi t for al l reports i n a proj ect, i n the Proj ect

C onfi gurati on Edi tor, sel ect the Governing R ules: D efault: R esult
Sets category and type the number i n the A ll intermediate result
rows box.

You can al so set the i ntermedi ate row l i mi t for a speci fi c report i n that
report's VLD B properti es. The VLD B properti es l i mi t for the report
overri des the proj ect l i mi t. For exampl e, i f you set the proj ect l i mi t at
10,000 row s but set the l i mi t to 20,000 row s for a speci fi c report that
usual l y returns more than 10,000 row s, users are abl e to see that
report w i thout any errors.

To Set the Intermediate Row Limit for a Specific Report

1. In D evel oper, ri ght-cl i ck the report to set the l i mi t for and sel ect
Edit.

2. From the D ata menu, sel ect VLD B properties.

3. Expand the Governing setti ngs, then sel ect Intermediate R ow

Limit.

4. Make sure the U se default inherited value check box i s cl eared.

5. In the Intermediate R ow Limit fi el d, type the l i mi t.

6. C l i ck Save and C lose.

Limit in g t h e Size an d Nu mb er o f In t elligen t Cu b es

If you have purchased OLAP Servi ces l i censes from Mi croStrategy,
your report desi gners can create Intel l i gent C ube reports. These
Intel l i gent C ubes must be stored i n Intel l i gence Server memory for

747 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

reports to access thei r data. Thi s may cause a shortage of memory for
other processes on the Intel l i gence Server machi ne.

You can govern the amount of resources used by Intel l i gent C ubes by
l i mi ti ng the amount of memory used by Intel l i gent C ubes and by
l i mi ti ng the number of Intel l i gent C ubes that can be l oaded i nto
memory.

To speci fy these setti ngs, i n the Proj ect C onfi gurati on Edi tor for the
proj ect, sel ect the C ubes: General category and type the new val ues
i n the Maximum R A M usage (MB ytes) and Maximum number of
cubes fi el ds. For detai l ed i nformati on on governi ng Intel l i gent C ube
memory usage, see D efi ni ng Memory Li mi ts for Intel l i gent C ubes,
page 961.

Limit in g t h e Memo r y Used Du r in g Dat a Fet ch in g

C ertai n Mi croStrategy features enabl e you to fetch data from external
data sources, such as w eb servi ces, MD X cubes, or Excel
spreadsheets. When data i s fetched from one of these data sources, i t
i s temporari l y stored i n Intel l i gence Server memory w hi l e bei ng
converted to a report. Thi s can cause a shortage of memory for other
processes on the Intel l i gence Server machi ne.

You can govern the amount of memory used for an i ndi vi dual data
fetch i n the Proj ect C onfi gurati on Edi tor. Sel ect the Governing
R ules: D efault: R esult Sets category, and type the new val ue i n the
Memory consumption during data fetching (MB ) fi el d. The defaul t
val ue i s -1, i ndi cati ng no l i mi t.

Governing Results Delivery

After Intel l i gence Server processes the resul ts of a j ob (see Managi ng
Job Executi on, page 731), i t then del i vers the resul ts to the user. In a
three-ti er system, resul ts del i very uses very l i ttl e of the system

© 2019, M icr o St r at egy In c. 748

Syst em Ad m in ist r at io n Gu id e

resources. Most of the tuni ng opti ons for resul ts del i very are focused
on a four-ti er system i nvol vi ng Mi croStrategy Web.

To del i ver resul ts, w hen a report i s fi rst run or w hen i t i s mani pul ated,
Intel l i gence Server generates XML and sends i t to the Mi croStrategy
Web server. The Web server then transl ates the XML i nto H TML for
di spl ay i n the user's w eb brow ser.

You can set l i mi ts i n tw o areas to control how much i nformati on i s

sent at a ti me. The l ow er of these tw o setti ngs determi nes the
maxi mum si ze of resul ts that Intel l i gence Server del i vers at a ti me:

l H ow many row s and col umns can be di spl ayed si mul taneousl y i n
Mi croStrategy Web (see Li mi ti ng the Informati on D i spl ayed at One
Ti me, page 750)

l H ow many XML cel l s i n a resul t set can be del i vered si mul taneousl y
(see Li mi ti ng the N umber of XML C el l s, page 751)

The fol l ow i ng setti ngs al so govern resul ts del i very:

l The maxi mum si ze of a report that can be exported (see Li mi ti ng

Export Si zes, page 752 and Li mi ti ng the Memory C onsumpti on for
Fi l e Generati on, page 753)

749 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l The number of XML dri l l paths i n a report (see Li mi ti ng the Total

N umber of XML D ri l l Paths, page 754)

Lik e all reques ts , dis play ed and ex ported reports are als o gov erned by
the Memory Contrac t Manager s ettings . For more information about
Memory Contrac t Manager, s ee Governi ng Intel l i gence Server
Memory U se w i th Memory C ontract Manager, page 698 .

Limiting the Information Displayed at One Time

In Mi croStrategy Web, i f a report contai ns a l arge amount of data, i t
can use a great deal of the system resources and take a si gni fi cant
amount of ti me before i t i s di spl ayed to the user. You can l essen the
i mpact of these l arge reports by l i mi ti ng the maxi mum number of row s
and col umns that are di spl ayed. If a report's resul t set i s l arger than
these l i mi ts, the report i s broken i nto pages (i ncrements) that are
fetched from the server one at a ti me.

The si ze of these i ncrements can be set as proj ect defaul ts by the

Mi croStrategy Web admi ni strator. U sers w i th the Web C hange U ser
Preferences pri vi l ege can al so customi ze these si zes.

To Limit the Number of Rows and Columns for All Users

1. In Mi croStrategy Web, l og i n to a proj ect as a user w i th the Web

Admi ni strati on pri vi l ege.

2. C l i ck the MicroStrategy i con, then cl i ck Preferences.

3. Sel ect Project defaults, and then sel ect the Grid display
category.

4. Speci fy the val ues i n the Maximum rows in grid and Maximum
columns in grid fi el ds.

5. C l i ck OK .

© 2019, M icr o St r at egy In c. 75 0

Syst em Ad m in ist r at io n Gu id e

To Limit the Number of Rows and Columns for One User

1. In Mi croStrategy Web, l og i n to a proj ect as a user w i th the Web

C hange U ser Preferences pri vi l ege.

2. C l i ck the MicroStrategy i con, then cl i ck Preferences.

3. Sel ect the Grid display category.

4. Speci fy the val ues i n the Maximum rows in grid and Maximum
columns in grid fi el ds.

If the us er s ets the number of rows and c olumns too high, the
number of XML c ells limit that is s et in Intelligenc e Serv er (s ee
Li mi ti ng the N umber of XML C el l s, page 751 ) gov erns the s iz e
of the res ult s et.

5. C l i ck OK .

Limiting the Number of XML Cells

When l arge report resul t sets are generated i nto XML, they can
requi re a si gni fi cant amount of Intel l i gence Server memory.
Mi croStrategy Web handl es thi s by i mpl ementi ng the i ncremental
fetch feature (see Li mi ti ng the Informati on D i spl ayed at One Ti me,
page 750). You can al so govern the resul t set's si ze by setti ng the
Maximum number of XML cells at the Intel l i gence Server l evel . Thi s
determi nes the maxi mum number of cel l s that can be returned from
Intel l i gence Server to the Web server at a ti me. For thi s l i mi t, the
number of cel l s i s the number of row s mul ti pl i ed by the number of
metri c col umns. Attri bute cel l s are not consi dered.

For exampl e, i f the XML l i mi t i s set at 10,000 and a report has

100,000 metri c cel l s, the report i s spl i t i nto 10 pages. The user cl i cks
the page number to vi ew the correspondi ng page.

75 1 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Addi ti onal l y, w hen users export l arge reports from Mi croStrategy Web
as formatted data, the XML i s generated i n batches. Thi s XML l i mi t
determi nes how l arge the batches are. D ependi ng on thi s XML l i mi t,
Intel l i gence Server behaves di fferentl y:

l If the l i mi t i s smal l er, i t takes a l onger ti me to generate the XML

because i t i s generated i n smal l batches, w hi ch use l ess memory
and system resources.

l If the l i mi t i s l arger, i t takes a shorter ti me to generate the XML

because i t i s generated i n few er, but l arger, batches, w hi ch use
more memory and system resources.

To set the XML l i mi t, i n the Intel l i gence Server C onfi gurati on Edi tor,
sel ect the Governing R ules: D efault: File Generation category, then
speci fy the Maximum number of XML cells. You must restart
Intel l i gence Server for the new l i mi t to take effect.

Limiting Export Sizes

When users export a report from Mi croStrategy Web, the resul ts are
not constrai ned by the i ncremental fetch l i mi t or the XML l i mi t. To
govern the si ze of reports that can be exported, you can set l i mi ts on
the number of cel l s for vari ous export formats.

To Limit the Number of Rows and Columns for All Users

1. In Mi croStrategy Web, l og i n to a proj ect as a user w i th the Web

Admi ni strati on pri vi l ege.

2. C l i ck the MicroStrategy i con, then cl i ck Preferences. ens.

3. Sel ect Project defaults, and then sel ect the Export R eports
category.

© 2019, M icr o St r at egy In c. 75 2

Syst em Ad m in ist r at io n Gu id e

4. Speci fy the val ues i n the Maximum number of cells to export to

plain text and Maximum number of cells to export to H TML
and Excel with formatting fi el ds.

5. C l i ck OK .

Limiting the Memory Consumption for File Generation

Exporti ng a report to a di fferent format can consume a great deal of
memory. The amount of memory avai l abl e for use by exporti ng fi l es
from Mi croStrategy Web i s governed by the maxi mum memory
consumpti on l i mi ts i n the Intel l i gence Server C onfi gurati on Edi tor. If
an export attempts to use more memory than these setti ngs al l ow , the
export fai l s w i th the error message "Mi croStrategy Intel l i gence Server
cannot handl e your request because a memory request has exceeded
the confi gured l i mi t. Pl ease contact the server admi ni strator."

The more formatti ng an exported report has, the more memory i t

consumes. When exporti ng l arge reports the best opti ons are pl ai n
text or C SV fi l e formats because formatti ng i nformati on i s not i ncl uded
w i th the report data. In contrast, exporti ng reports as Excel w i th
formatti ng uses a si gni fi cant amount of memory because the exported
Excel fi l e contai ns both the report data and al l the formatti ng data.
For more i nformati on about exporti ng reports, see C l i ent-Speci fi c Job
Processi ng, page 77.

Because Excel export uses si gni fi cantl y more memory than other
export formats, you can l i mi t the si ze of reports exported to Excel from
D evel oper as w el l as from Web. The defaul t memory consumpti on
l i mi t i s 100 MB.

To set the maxi mum memory consumpti on l i mi ts for exporti ng reports

from Web, i n the Intel l i gence Server C onfi gurati on Edi tor, sel ect the
Governing R ules: D efault: File Generation category, and speci fy the
Maximum memory consumption for the XML, PD F, Excel , and H TML
fi l es.

75 3 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Depending on y our Memory Contrac t Manager s ettings , an ex port c an

us e les s memory than s pec ified by thes e s ettings and s till be denied
bec aus e of a lac k of memory . For more information about Memory
Contrac t Manager, s ee Governi ng Intel l i gence Server Memory U se
w i th Memory C ontract Manager, page 698 .

To Set the Maximum Memory Consumption for Excel File

Generation

1. In D evel oper, l og i n to a proj ect source usi ng an account w i th the

C onfi gure Server Basi c pri vi l ege.

2. From the Tools menu, sel ect Project Source Manager.

3. Sel ect the proj ect source and cl i ck Modify.

4. On the Memory tab, i n the Export to Excel secti on, sel ect U se
custom value. In the Maximum R A M U sage (MB ) fi el d, speci fy
the maxi mum memory consumpti on.

5. C l i ck OK .

Limiting the Total Number of XML Drill Paths

Another w ay that you can prevent reports from consumi ng too much
memory i s to l i mi t the number of XML dri l l paths al l ow ed on reports i n
Mi croStrategy Web products. The defaul t dri l l map for reports uses al l
attri butes i ncl uded i n hi erarchi es marked as dri l l hi erarchi es. R eport
desi gners can si gni fi cantl y reduce the si ze of an attri bute's dri l l path
by modi fyi ng a report's dri l l map to i ncl ude few er dri l l opti ons. You
can al so i mpose a l i mi t for al l reports comi ng from Mi croStrategy Web
products by setti ng the Maxi mum number of XML dri l l paths.

For more i nformati on about customi zi ng dri l l maps, see the Advanced
R eporti ng Gui de.

© 2019, M icr o St r at egy In c. 75 4

Syst em Ad m in ist r at io n Gu id e

To set thi s l i mi t, i n the Intel l i gence Server C onfi gurati on Edi tor, sel ect
the Governing R ules: D efault: File Generation category, then
speci fy the Maximum number of XML drill paths. You must restart
Intel l i gence Server for the new l i mi t to take effect.

Dis abling XML c ac hing for a projec t may hav e a negativ e effec t on
performanc e, es pec ially for large reports . For more information, s ee
Types of R esul t C aches, page 864 and C ontrol l i ng Access to
Obj ects: Permi ssi ons, page 95 .

Tuning Your System for In-Memory Datasets

You can i mport l arge datasets i nto your Intel l i gence Server's memory
as Intel l i gent C ubes, and di vi de the Intel l i gent C ubes i nto mul ti pl e
segments. These segments, cal l ed parti ti ons, are processed
si mul taneousl y, di stri buted across the processor cores of your
Intel l i gence Server.

By stori ng your data i n your Intel l i gence Server's memory and

processi ng the data usi ng al l the server's processor cores, you can
anal yze l arge and compl ex datasets w i th very fast response ti mes.

The fol l ow i ng secti ons cover the setti ngs you can confi gure to
i mprove the performance of your i n-memory datasets:

l C onfi guri ng Intel l i gence Server for In-Memory D atasets, page 755

l C onfi guri ng your Proj ects for In-Memory D atasets, page 756

Configuring Intelligence Server for In-Memory Datasets

To ensure the best performance for your parti ti oned i n-memory
datasets, you can confi gure the fol l ow i ng setti ngs for your Intel l i gence
Server:

75 5 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l C onsi der i ncreasi ng the number of database connecti ons that

Intel l i gence Server uses to connect to data sources. When users
i mport data i nto Intel l i gence Server's memory, the j ob to connect to
the data source i s gi ven a l ow pri ori ty. To al l ow Intel l i gence Server
to retri eve l arge datasets, you can i ncrease the number of l ow -
pri ori ty database connecti ons that Intel l i gence Server can make.

For background i nformati on on pri ori ti zi ng j obs, see Pri ori ti zi ng

Jobs. For background i nformati on on changi ng the number of
database connecti ons, see Managi ng D atabase C onnecti on
Threads.

l C onsi der i ncreasi ng the maxi mum ti me that a database query i s

al l ow ed to run, to ensure that the Intel l i gence Server has more ti me
to retri eve l arge datasets from the data source. For background
i nformati on on i ncreasi ng the executi on ti me for database queri es,
see Managi ng D atabase C onnecti on Threads

Configuring your Projects for In-Memory Datasets

For each of proj ect that uses i n-memory datasets, make the fol l ow i ng
changes to i mprove the performance of the i n-memory datasets:

l Increase the maxi mum si ze of the datasets that users can i mport. If
users need to i mport l arge datasets i nto a proj ect, i ncrease the l i mi t
on the si ze of the dataset that they can i mport. For steps to i ncrease
thi s l i mi t, see Governi ng Intel l i gent C ube Memory U sage.

l Enabl e paral l el queri es for the reports i n your proj ect, so that
Intel l i gence Server can execute database queri es i n paral l el and
retri eve more data from your database. For steps to enabl e paral l el
queri es, and to defi ne the maxi mum number of paral l el queri es that
can be run for every report, see the Opti mi zi ng Queri es secti on.

© 2019, M icr o St r at egy In c. 75 6

Syst em Ad m in ist r at io n Gu id e

Designing Reports
In addi ti on to the fact that l arge reports can exert a heavy tol l on
system performance, a report's desi gn can al so affect i t. Some
features consume more of the system's capaci ty than others w hen
they are used.

Some report desi gn features that can use a great deal of system
resources i ncl ude:

l C ompl ex anal yti c cal cul ati ons (Anal yti c C ompl exi ty, page 757)

l Subtotal s (Subtotal s, page 758)

l Page-by (Page-By Feature, page 758)

l Prompt compl exi ty (Prompt C ompl exi ty, page 759)

l R eport Servi ces documents (R eport Servi ces D ocuments, page 759)

l Intel l i gent C ubes (Intel l i gent C ubes, page 759)

Analytic Complexity
C al cul ati ons that cannot be done w i th SQL i n the data w arehouse are
performed by the Anal yti cal Engi ne i n Intel l i gence Server. These may

75 7 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

resul t i n si gni fi cant memory use duri ng report executi on. Some
anal yti c cal cul ati ons (such as A v g D e v) requi re the enti re col umn of
the fact tabl e as i nput to the cal cul ati on. The amount of memory used
depends on the type of cal cul ati on and the si ze of the report that i s
used. Make sure your report desi gners are aw are of the potenti al
effects of these cal cul ati ons.

Subtotals
The amount of memory requi red to cal cul ate and store subtotal s can
be si gni fi cant. In some cases, the si ze of the subtotal s can surpass
the si ze of the report resul t i tsel f.

The si ze of the subtotal s depends on the subtotal i ng opti on chosen,

al ong w i th the order and the number of uni que attri butes. The easi est
w ay to determi ne the number of subtotal s bei ng cal cul ated i s to
exami ne the number of resul t row s added w i th the di fferent opti ons
sel ected i n the Advanced Subtotal s Opti ons di al og box. To access
thi s di al og box, vi ew the report i n D evel oper, then poi nt to D ata, then
Subtotals, and then choose A dvanced. For more detai l ed i nformati on
about the di fferent subtotal opti ons, see the R eports secti on i n the
Advanced R eporti ng Gui de.

Subtotal s can use a great deal of memory i f you sel ect the A ll
Subtotals opti on i n the Pages drop-dow n l i st. Thi s opti on cal cul ates
al l possi bl e subtotal cal cul ati ons at runti me and stores the resul ts i n
the report i nstance. Mi croStrategy recommends that you encourage
users and report desi gners to use l ess taxi ng opti ons for cal cul ati ng
subtotal s across pages, such as Selected Subtotals and Grand
Total.

Page-By Feature
If desi gners or users create reports that use the page-by feature, they
may use si gni fi cant system resources. Thi s i s because the enti re
report i s hel d i n memory even though the user i s seei ng onl y a porti on

© 2019, M icr o St r at egy In c. 75 8

Syst em Ad m in ist r at io n Gu id e

of i t at a ti me. To l essen the potenti al effect of usi ng page-by w i th

l arge reports, consi der spl i tti ng those reports i nto mul ti pl e reports and
el i mi nati ng the use of page-by. For more i nformati on about page-by,
see the Advanced R eporti ng Gui de.

Prompt Complexity
Each attri bute el ement or hi erarchy prompt requi res an el ement
request to be executed by Intel l i gence Server. The number of prompts
used and the number of el ements returned from the prompts determi ne
how much l oad i s pl aced on Intel l i gence Server. R eport desi gners
shoul d take thi s i nto account w hen desi gni ng prompted reports.

In addi ti on to l i mi ti ng the number of el ements returned from el ement

requests (as descri bed i n R esul ts Processi ng, page 742), you shoul d
make sure your el ement caches are bei ng used effecti vel y. For
i nformati on on managi ng el ement caches, i ncl udi ng i nstructi ons, see
El ement C aches, page 920.

Report Services Documents

R eport Servi ces documents may contai n mul ti pl e reports. Executi ng a
document can resul t i n several report requests bei ng submi tted
si mul taneousl y.

To l i mi t the effect of R eport Servi ces documents on the system,

consi der enabl i ng document cachi ng. If the documents are cached on
Intel l i gence Server, l ess l oad i s pl aced on the data w arehouse and on
the Intel l i gence Server machi ne. For i nformati on about document
cachi ng, i ncl udi ng i nstructi ons, see R esul t C aches, page 860.

Intelligent Cubes
Wi th OLAP Servi ces features, your report desi gners can create
Intel l i gent C ube reports. These reports al l ow data to be returned from
the data w arehouse, stored i n Intel l i gence Server memory, and then
shared among mul ti pl e reports.

75 9 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Because Intel l i gent C ubes must be l oaded i nto memory to be used i n

reports, they can use a great deal of system resources. Make sure
your report desi gners are fami l i ar w i th the Intel l i gent C ube desi gn
best practi ces found i n Governi ng Intel l i gent C ube Memory U sage,
page 955.

You can al so restri ct the number and si ze of Intel l i gent C ubes that
can be l oaded at once. For i nstructi ons, see R esul ts Processi ng,
page 742.

Configuring Intelligence Server and Projects

At ti mes you may need to adj ust setti ngs i n the Mi croStrategy system,
ei ther as a resul t of changes to the system or to i mprove an aspect of
system effi ci ency. Thi s secti on provi des an overvi ew of the governi ng
setti ngs throughout the system.

These governors are arranged by w here i n the i nterface you can fi nd

them.

© 2019, M icr o St r at egy In c. 760

Syst em Ad m in ist r at io n Gu id e

Intelligence Server Configuration Editor

To set the fol l ow i ng governors i n the Intel l i gence Server
C onfi gurati on Edi tor, ri ght-cl i ck the proj ect source, sel ect C onfigure
MicroStrategy Intelligence Server, then sel ect the category as
descri bed bel ow .

Onl y the categori es and setti ngs i n the Intel l i gence Server
C onfi gurati on Edi tor that affect system scal abi l i ty are descri bed
bel ow . Other categori es and setti ngs that appear i n the Intel l i gence
Server C onfi gurati on Edi tor are descri bed el sew here i n thi s gui de,
and i n the H el p for the edi to

Server definition: General category i n Intel l i gence Server

confi gurati on

Gov e r nor De s c r iption Se e pa ge

Cont rols t he number of net work

connect ions available f or H ow the
communicat ion bet ween N etw ork can
Number of net work t hreads
I nt elligence S erver and t he Affect
client , such as Developer or Performance
MicroS t rat egy Web.

Server definition: A dvanced category i n Intel l i gence Server

confi gurati on

Gov e r nor De s c r iption Se e pa ge

Cont rols t he f requency (in minut es)

at which cache and Hist ory List
C onfiguring
messages are backed up t o disk. A
B ackup f requency (minut es) R esult C ache
value of 0 means t hat cache and
Settings
hist ory messages are backed up
immediat ely af t er t hey are creat ed.

761 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Gov e r nor De s c r iption Se e pa ge

Cont rols whet her t hreads in

I nt elligence S erver are allocat ed t o
processes such as object serving,
B alance MicroS t rat egy S erver element serving, S QL generat ion, R esults
t hreads and so on t hat need t hem most , Proc essing
while processes wit h light er loads
can ret urn t hreads t o t he available
pool.

Cleans up t he cache lookup t able

at t he specif ied f requency (in
seconds). This reduces t he amount C onfiguring
Cache lookup cleanup
of memory t he cache lookup t able R esult C ache
f requency (sec)
consumes and t he t ime Settings
I nt elligence S erver t akes t o back
up t he lookup t able t o disk.

The amount of t ime (t he delay)

Project
bef ore t he project is loaded on
P roject f ailover lat ency (min. ) Failov er and
anot her server t o maint ain
Latenc y
minimum level availabilit y.

When t he condit ions t hat caused a

project f ailover disappear, t he
f ailover conf igurat ion revert s
Project
Conf igurat ion recovery lat ency aut omat ically t o t he original
Failov er and
(min. ) conf igurat ion. This set t ing is t he
Latenc y
amount of t ime (t he delay) bef ore
t he f ailover conf igurat ion revert s t o
t he original conf igurat ion.

Conf igures addit ional

E nable perf ormance
MicroS t rat egy-specif ic monit ors in Memory
monit oring
Windows P erf ormance Monit or.

Cont rols how long t he S cheduler

S cheduler session t ime out
at t empt s t o communicat e wit h
(sec)
I nt elligence S erver bef ore t iming

© 2019, M icr o St r at egy In c. 762

Syst em Ad m in ist r at io n Gu id e

Gov e r nor De s c r iption Se e pa ge

out . B y def ault , t his is set t o 300

seconds.

Governing R ules: D efault: General category i n Intel l i gence Server

confi gurati on

Gov e r nor De s c r iption Se e pa ge

Limiting the
Maximum number of The maximum concurrent number of jobs Total
jobs t hat can exist on an I nt elligence S erver. N umber of
Jobs

Limit s t he number of concurrent Limiting the

Maximum number of int eract ive (nonscheduled) jobs t hat can Total
int eract ive jobs exist on t his I nt elligence S erver. A value N umber of
of -1 indicat es no limit . Jobs

Limit s t he number of concurrent Limiting the

Maximum number of scheduled jobs t hat can exist on t his Total
scheduled jobs I nt elligence S erver. A value of -1 N umber of
indicat es no limit . Jobs

The maximum number of user sessions

Governing
Maximum number of (connect ions) f or an I nt elligence S erver. A
C oncurrent
user sessions single user account may est ablish mult iple
U sers
sessions t o an I nt elligence S erver.

The t ime allowed f or a Developer user t o

remain idle bef ore t heir session is ended. Governing
User session idle t ime
A user session is considered idle when it C oncurrent
(sec)
submit s no request s t o I nt elligence U sers
S erver.

Governing
Web user session idle The t ime allowed f or a Web user t o remain
C oncurrent
t ime (sec) idle bef ore t heir session is ended.
U sers

763 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Gov e r nor De s c r iption Se e pa ge

I f designers will be building Report

S ervices document s and dossiers in
MicroS t rat egy Web, set t he W eb
user session idle time (sec) t o
3600 t o avoid a project source
t imeout .

For I nt elligence S erver

and hist ory list Excluding
governing, exclude Do not include report s submit t ed as part D ocument
report s embedded in of a document in t he count of jobs f or t he D atasets
Report S ervices job limit s. from the Job
document s f rom t he Limits
count s

I f select ed, when a document cache is hit ,

I nt elligence S erver displays t he cached
document and re-execut es t he document
B ackground E xecut ion:
in t he background. I f t his opt ion is
E nable background
cleared, when a document cache is hit ,
execut ion of document s
I nt elligence S erver displays t he cached
af t er t heir caches are
document and does not re-execut e t he
hit .
document unt il a manipulat ion is
perf ormed. B y def ault t his opt ion is
cleared.

Limit s t he t ime, in seconds, t hat mobile

Mobile A P NS and client connect ions remain open t o
GMC session idle t ime download Newsst and subscript ions. A
(sec) value of -1 indicat es no limit . B y def ault ,
t his is set t o 1800.

Governing R ules: D efault: File Generation category i n Intel l i gence

Server confi gurati on

© 2019, M icr o St r at egy In c. 764

Syst em Ad m in ist r at io n Gu id e

Gov e r nor De s c r iption Se e pa ge

The maximum number of X ML

cells in a report result set t hat
I nt elligence S erver can send t o
t he MicroS t rat egy Web product s
Limiting the
X ML Generat ion: Maximum at a t ime. When t his limit is
N umber of XML
number of X ML cells reached, t he user sees an error
C ells
message along wit h t he part ial
result set . The user can
increment ally f et ch t he
remaining cells.

The maximum number of

at t ribut e element s t hat users can
see in t he drill across menu in Limiting the
X ML Generat ion: Maximum
MicroS t rat egy Web product s. I f Total N umber of
number of X ML drill pat hs
t his set t ing is set t oo low, t he XML D rill Paths
user does not see all t he
available drill at t ribut es.

The maximum amount of

memory (in megabyt es) t hat
Limiting the
I nt elligence S erver can use t o
X ML Generat ion: Maximum Memory
generat e a report or document in
memory consumpt ion f or X ML C onsumption
X ML. I f t his limit is reached, t he
(MB ) for File
X ML document is not generat ed
Generation
and t he user sees an error
message.

The maximum amount of memory

(in megabyt es) t hat I nt elligence Limiting the
P DF Generat ion: Maximum S erver can use t o generat e a Memory
memory consumpt ion f or P DF report or document in P DF. I f C onsumption
f iles (MB ) t his limit is reached, t he P DF for File
document is not generat ed and Generation
t he user sees an error message.

E xcel Generat ion: Maximum The maximum amount of Limiting the

765 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Gov e r nor De s c r iption Se e pa ge

memory (in megabyt es) t hat

I nt elligence S erver can use t o
Memory
generat e a report or document in
memory consumpt ion f or C onsumption
E xcel. I f t his limit is reached,
E xcel f iles (MB ) for File
t he E xcel document is not
Generation
generat ed and t he user sees an
error message.

The maximum amount of memory

(in megabyt es) t hat I nt elligence Limiting the
HTML Generat ion: Maximum S erver can use t o generat e a Memory
memory consumpt ion f or report or document in HTML. I f C onsumption
HTML f iles (MB ) t his limit is reached, t he HTML for File
document is not generat ed and Generation
t he user sees an error message.

Governing R ules: D efault: Memory Settings category i n Intel l i gence

Server confi gurati on

Gov e r nor De s c r iption Se e pa ge

A check box t hat enables t he

f ollowing governors: Governing
Memory for
E nable Web request job l Maximum Intelligence Server
R equests from
t hrot t ling use of total memory
MicroStrategy
l Minimum machine free W eb Products
physical memory

The maximum amount of t ot al

Governing
syst em memory (RA M + P age
Memory for
Maximum I nt elligence S erver File) t hat can be used by t he
R equests from
use of t ot al memory (% ) I nt elligence S erver process
MicroStrategy
( MSTRSVR.exe ) compared t o
W eb Products
t he t ot al amount of memory on

© 2019, M icr o St r at egy In c. 766

Syst em Ad m in ist r at io n Gu id e

Gov e r nor De s c r iption Se e pa ge

t he machine. I f t he limit is met ,

all request s f rom MicroS t rat egy
Web product s of any nat ure (log
in, report execut ion, search,
f older browsing) are denied unt il
t he condit ions are resolved.

The minimum amount of

physical memory (RA M) t hat
needs t o be available, as a
percent age of t he t ot al amount
Governing
of physical memory on t he
Memory for
Minimum machine f ree machine. I f t he limit is met , all
R equests from
physical memory (% ) request s f rom MicroS t rat egy
MicroStrategy
Web product s (f or example, log
W eb Products
in, report execut ion, search,
f older browsing) are denied
unt il t he condit ions are
resolved.

Governing
Intelligence
A check box t hat enables t he
E nable single memory Serv er Memory
Maximum single allocation
allocat ion governing U se w ith Memory
siz e governor.
C ontrac t
Manager

Governing
Intelligence
P revent s I nt elligence S erver Serv er Memory
Maximum single allocat ion
f rom grant ing a request t hat U se w ith
size (MB yt es)
would exceed t his limit . Memory
C ontrac t
Manager

E nable memory cont ract A check box t hat enables t he Governing

management f ollowing governors: Intelligence

767 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Gov e r nor De s c r iption Se e pa ge

l Minimum reserved memory

(MB or %) Serv er Memory
U se w ith Memory
l Maximum use of virtual
C ontrac t
address space (%)
Manager
l Memory request idle time

Governing
Intelligence
The amount of syst em memory,
Serv er Memory
Minimum reserved memory in eit her MB or a percent , t hat
U se w ith
(MB yt es or % ) must be reserved f or processes
Memory
ext ernal t o I nt elligence S erver.
C ontrac t
Manager

The maximum percent of t he

process' virt ual address space
t hat I nt elligence S erver can use
bef ore ent ering memory request
idle mode. Governing
Intelligence
Maximum use of virt ual This set t ing is used in 32-bit Serv er Memory
address space (% ) operat ing syst ems and is no U se w ith Memory
longer applicable. I n 64-bit C ontrac t
operat ing syst ems, t o cont rol Manager
t he amount of memory available
f or I nt elligence S erver, use t he
Minimum reserved memory
governor.

The amount of t ime I nt elligence

Governing
S erver denies request s t hat
Intelligence
may result in memory
Serv er Memory
Memory request idle t ime deplet ion. I f I nt elligence S erver
U se w ith
(sec) does not ret urn t o accept able
Memory
memory condit ions bef ore t he
C ontrac t
idle t ime is reached,
Manager
I nt elligence S erver shut s down

© 2019, M icr o St r at egy In c. 768

Syst em Ad m in ist r at io n Gu id e

Gov e r nor De s c r iption Se e pa ge

and rest art s.

The maximum amount of

Temporary S t orage S et t ing:
memory t hat can be used f or Governing U ser
Maximum RA M f or Working
report inst ances ref erenced by R esources
S et cache (MB )
messages in t he Working S et .

Governing R ules: D efault: Temporary Storage Settings category i n

Intel l i gence Server confi gurati on

Gov e r nor De s c r iption Se e pa ge

The locat ion where t he user's act ive

working set s are writ t en t o disk if
t hey have been f orced out of t he Governing
Working S et f ile direct ory pool of memory allocat ed f or t he U ser
Maximum RA M f or working set R esources
cache. The def ault is

. \ TmpP ool

S ession Recovery and S pecif ies t he where t he session Governing

Def erred I nbox st orage inf ormat ion is writ t en t o disk. The U ser
direct ory def ault is . \ TmpP ool R esources

Governing
E nable Web User S ession I f select ed, allows Web users t o
U ser
Recovery on Logout recover t heir sessions.
R esources

How many hours a session backup

can remain on disk bef ore it is Governing
S ession Recovery backup
considered expired. A f t er it is U ser
expirat ion (hrs)
expired, t he user cannot recover t he R esources
session.

Governing R ules: D efault: Import D ata category i n Intel l i gence

Server confi gurati on

769 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Gov e r nor De s c r iption Se e pa ge

The number of connect ion t hreads

t o creat e f or I mport Dat a jobs,
Managing
depending on whet her t he priorit y
Number of connect ions by D atabase
of t he job is high, medium or low.
priorit y C onnection
Y ou must det ermine t he number of
Threads
t hreads t hat quickly serves users
wit hout overloading t he syst em.

Governing R ules: D efault: C atalog cache category i n Intel l i gence

Server confi gurati on

Se e
Gov e r nor De s c r iption
pa ge

A check box t hat enables t he Maximum

E nable cat alog cache
use of memory (MB ) governor.

Limit s t he maximum amount of memory, in

Maximum use of memory (MB ) megabyt es, used by t he cat alog cache.
The def ault value is 25 MB

H istory Settings: General category i n Intel l i gence Server

confi gurati on

Gov e r nor De s c r iption Se e pa ge

The maximum number of Hist ory

Saving
messages t hat can exist in a user's
Maximum number of R eport
Hist ory List at any t ime. When t he
messages per user R esults :
limit is reached, t he oldest message
H istory Lis t
is removed.

The lengt h of t ime bef ore a Hist ory Saving

Message lif et ime (days)
List message expires and is R eport

© 2019, M icr o St r at egy In c. 770

Syst em Ad m in ist r at io n Gu id e

Gov e r nor De s c r iption Se e pa ge

aut omat ically delet ed. A value of -1

R esults :
indicat es t hat messages do not
H istory Lis t
expire.

S elect File B ased f or Hist ory List

Saving
messages t o be st ored on disk in a
R eport
Reposit ory t ype f ile syst em, or D atabase B ased f or
R esults :
Hist ory List messages t o be st ored
H istory Lis t
in a dat abase (recommended).

Project Configuration Editor

These governors can be set per proj ect. To access them, ri ght-cl i ck
the proj ect, sel ect Project C onfiguration, then sel ect the category as
noted bel ow .

Project definition: A dvanced category

Gov e r nor De s c r iption Se e pa ge

Maximum
The maximum number of at t ribut e Limiting the N umber of
number of
element s t hat can be being ret rieved Elements D isplay ed
element s t o
f rom t he dat a warehouse at one t ime. and C ached at a Time
display

Governing R ules: D efault: R esult sets category i n Proj ect

C onfi gurati on

Gov e r nor De s c r iption Se e pa ge

I nt elligence The amount of t ime t hat an ad-hoc report request Limiting

S erver E lapsed can t ake bef ore it is canceled. This includes t ime the
Time - I nt eract ive spent resolving prompt s, wait ing f or aut oprompt s, Maximum
report s (sec) wait ing in t he job queue, execut ing S QL, R eport

771 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Gov e r nor De s c r iption Se e pa ge

analyt ical calculat ion, and preparing report Execution

result s. Time

The amount of t ime t hat a scheduled report

Limiting the
I nt elligence request can t ake bef ore it is canceled. This
Maximum
S erver E lapsed includes t ime spent resolving prompt s, wait ing f or
R eport
Time - S cheduled aut oprompt s, wait ing in t he job queue, execut ing
Execution
report s (sec) S QL, analyt ical calculat ion, and preparing report
Time
result s.

Limiting
S pecif y t he maximum t ime t o wait f or a prompt t o
the
Wait t ime f or be answered by t he user in seconds. I f t he user
Maximum
prompt answers f ails t o answer t he prompt in t he specif ied t ime
R eport
(sec) limit , t he job is cancelled. B y def ault , t his is set
Execution
t o -1.
Time

S pecif y t he maximum t ime f or warehouse jobs t o Limiting the

Warehouse be execut ed by I nt elligence S erver. Jobs last ing Maximum
execut ion t ime longer t han t his set t ing are cancelled. A value of 0 R eport
(sec) or -1 indicat es inf init e t ime. B y def ault , t his is set Execution
t o -1. Time

The maximum number of rows t hat can be

ret urned t o I nt elligence S erver f or an I nt elligent
Final Result Rows Cube request . This set t ing is applied by t he Query
R esults
- I nt elligent E ngine when ret rieving t he result s f rom t he
Proc essing
Cubes dat abase. This is t he def ault f or all report s in a
project and can be overridden f or individual
report s by using t he V LDB set t ings.

The maximum number of rows t hat can be

ret urned t o I nt elligence S erver f or a dat a mart
report request . This set t ing is applied by t he
Final Result Rows R esults
Query E ngine when ret rieving t he result s f rom t he
- Dat a mart s Proc essing
dat abase. This is t he def ault f or all report s in a
project and can be overridden f or individual
report s by using t he V LDB set t ings.

© 2019, M icr o St r at egy In c. 772

Syst em Ad m in ist r at io n Gu id e

Gov e r nor De s c r iption Se e pa ge

S pecif y t he maximum number of rows t hat can be

ret urned t o I nt elligence S erver f or a document or
dossier request . When ret rieving t he result s f rom
Final Result Rows
t he dat abase, t he Query E ngine applies t his
- R esults
set t ing. I f t he number of rows in a document or
Document / Dossier Proc essing
dossier exceeds t he specif ied limit , an error is
views
displayed and no result s are shown f or t he
document or dossier. A value of 0 or -1 indicat es
no limit . B y def ault , t his is set t o 50000000.

The maximum number of rows t hat can be

ret urned t o I nt elligence S erver f or a st andard
report request . This set t ing is applied by t he
Final Result Rows R esults
Query E ngine when ret rieving t he result s f rom t he
- A ll ot her report s Proc essing
dat abase. This is t he def ault f or all report s in a
project and can be overridden f or individual
report s by using t he V LDB set t ings.

The maximum number of rows t hat can be in an

int ermediat e result set used f or analyt ical
A ll int ermediat e processing in I nt elligence S erver. This is t he R esults
result rows def ault f or all report s in a project and can be Proc essing
overridden by using t he V LDB set t ings f or
individual report s.

A ll int ermediat e
rows - The maximum number of rows f or int ermediat e R esults
Document / Dossier result s. The def ault value is 32, 000. Proc essing
views

A ll element The maximum number of rows t hat can be

R esults
browsing result ret rieved f rom t he dat a warehouse f or an element
Proc essing
rows request .

Memory The maximum amount of memory (in megabyt es) Limiting a

consumpt ion t hat I nt elligence S erver can use f or S QL R eport' s
during S QL generat ion. The def ault is -1, which indicat es no SQL Per
generat ion (MB ) limit . Pass

773 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Gov e r nor De s c r iption Se e pa ge

Memory
The maximum amount of memory (in megabyt es)
consumpt ion R esults
t hat I nt elligence S erver can use f or import ing
during dat a Proc essing
dat a. The def ault is 2048 MB (2 GB ).
f et ching (MB )

Limit s t he f ile size, in megabyt es, when

downloading a dossier f rom MicroS t rat egy Web. I f
a dossier is larger t han t he specif ied f ile size, an
error is displayed t hat provides t he current limit ,
and t he dossier is not downloaded. A ddit ionally, Best
MicroS t rat egy t his set t ing applies t o dossiers sent t hrough Prac tices
(. mst r) f ile size Dist ribut ion S ervices. I f a dossier is larger t han for U sing
(MB ) t he specif ied size, t he dossier is not sent . A value D istribution
of -1 indicat es no limit . A value of 0 prevent s t he Serv ices
abilit y t o download a dossier f rom Web and t o
dist ribut e a dossier t hrough Dist ribut ion S ervices.
B y def ault , t his is set t o 25. The maximum . mst r
f ile size is 2047 MB .

Governing R ules: D efault: Jobs category i n Proj ect C onfi gurati on

Gov e r nor De s c r iption Se e pa ge

Limiting the
Jobs per N umber of J obs
The maximum number of concurrent jobs per user
user Per U ser Sess ion
account and project .
account and Per U ser
Acc ount

Limiting the
Jobs per N umber of J obs
The maximum number of concurrent jobs a user can
user Per U ser Sess ion
have during a session.
session and Per U ser
Acc ount

E xecut ing The maximum number of concurrent jobs a single Limiting the

© 2019, M icr o St r at egy In c. 774

Syst em Ad m in ist r at io n Gu id e

Gov e r nor De s c r iption Se e pa ge

N umber of
user account can have execut ing in t he project . I f
jobs per Executing J obs
t his condit ion is met , addit ional jobs are placed in
user Per U ser and
t he queue unt il execut ing jobs f inish.
Project

Jobs per Limiting the

The maximum number of concurrent ad-hoc jobs
project - N umber of J obs
t hat t he project can process at a t ime.
int eract ive Per Project

Jobs per Limiting the

The maximum number of concurrent scheduled jobs
project - N umber of J obs
t hat t he project can process at a t ime.
scheduled Per Project

Limiting the
Jobs per The maximum number of concurrent jobs t hat t he
N umber of J obs
project project can process at a t ime.
Per Project

Governing R ules: D efault: U ser sessions category i n Proj ect

C onfi gurati on

Gov e r nor De s c r iption Se e pa ge

User The maximum number of user sessions t hat are allowed in Governing
sessions t he project . When t he limit is reached, users ot her t han C oncurrent
per project t he A dminist rat or cannot log in. U sers

Concurrent
int eract ive Governing
project The maximum number of concurrent sessions per user. C oncurrent
sessions U sers
per user

Governing R ules: D efault: Subscriptions category i n Proj ect

C onfi gurati on

775 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Gov e r nor De s c r iption Se e pa ge

Maximum
The maximum number of report s or document s t o
Hist ory List Managing
which a user can be subscribed f or delivery t o t he
subscript ions Subsc riptions
Hist ory List .
per user

Maximum
Cache
The maximum number of report s or document s t o Managing
Updat e
which a user can be subscribed f or updat ing caches. Subsc riptions
subscript ions
per user

Maximum
The maximum number of report s or document s t o
email Managing
which a user can be subscribed f or delivery t o an
subscript ions Subsc riptions
email address (Dist ribut ion S ervices only).
per user

Maximum f ile The maximum number of report s or document s t o

Managing
subscript ions which a user can be subscribed f or delivery t o a f ile
Subsc riptions
per user locat ion (Dist ribut ion S ervices only).

Maximum
The maximum number of report s or document s t o
print Managing
which a user can be subscribed f or delivery t o a
subscript ions Subsc riptions
print er (Dist ribut ion S ervices only).
per user

Maximum
The maximum number of report s or document s t o
Mobile Managing
which a user can be subscribed f or delivery t o a
subscript ions Subsc riptions
Mobile device (MicroS t rat egy Mobile only).
per user

Maximum The maximum number of report s/ document s t hat t he

FTP user can subscribe t o, t o be delivered t o an FTP Managing
subscript ions locat ion, at a t ime. A value of -1 indicat es no limit . Subsc riptions
per user B y def ault , t his is set t o -1.

Maximum
P ersonal The maximum number of personal views t hat can be
Managing
V iew creat ed by URL sharing. A value of -1 indicat es no
Subsc riptions
subscript ions limit . B y def ault , t his is set t o -1.
per user

© 2019, M icr o St r at egy In c. 776

Syst em Ad m in ist r at io n Gu id e

Governing Rules: Default: Import Data category in Project Configuration

Gov e r nor De s c r iption Se e pa ge

The maximum size f or a f ile t o be import ed D efining Limits for

Maximum
f or use as a dat a source. Files larger t hat Intelligent C ubes
f ile size
t his value cannot be opened during dat a C reated using the Import
(MB )
import . D ata Feature

D efining Limits for

Maximum
The maximum size of all dat a import cubes Intelligent C ubes
quot a per
f or each individual user. C reated using the Import
user (MB )
D ata Feature

C aching: R esult C aches: Storage category i n Proj ect C onfi gurati on

Gov e r nor De s c r iption Se e pa ge

Dat aset s -
The maximum amount of memory reserved f or t he C onfiguring
Maximum
creat ion and st orage of report and dat aset caches. This R esult
RA M
set t ing should be conf igured t o at least t he size of t he C ache
usage
largest cache f ile, or t hat report will not be cached. Settings
(MB yt es)

Dat aset s -
Managing
Maximum The maximum number of report and dat aset caches t hat
R esult
number of t he project can have at a t ime.
C aches
caches

Format t ed
Document s The maximum amount of memory reserved f or t he C onfiguring
- Maximum creat ion and st orage of document caches. This set t ing R esult
RA M should be conf igured t o be at least t he size of t he largest C ache
usage cache f ile, or t hat report will not be cached. Settings
(MB yt es)

Format t ed Managing
The maximum number of document caches t hat t he
Document s R esult
project can have at a t ime.
- Maximum C aches

777 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Gov e r nor De s c r iption Se e pa ge

number of
caches

The amount of memory t hat is swapped t o disk, relat ive

C onfiguring
t o t he size of t he cache being swapped int o memory. For
RA M swap R esult
example, if t he R A M swap multiplier set t ing is 2 and
mult iplier C ache
t he request ed cache is 80 K byt es, 160 K byt es are
Settings
swapped f rom memory t o disk.

Maximum
RA M f or This set t ing det ermines what percent age of t he amount
report of memory specif ied in t he Maximum RA M usage limit s
cache can be used f or result cache lookup t ables.
index (% )

C aching: R esult caches: Maintenance category i n Proj ect

C onfi gurati on

Gov e r nor De s c r iption Se e pa ge

C onfiguring
Never expire Det ermines whet her caches aut omat ically
R esult C ache
caches expire.
Settings

C onfiguring
Cache durat ion The amount of t ime t hat a result cache remains
R esult C ache
(Hours) valid.
Settings

Do not A pply
A ut omat ic
S elect t his check box f or report caches wit h C onfiguring
E xpirat ion Logic
dynamic dat es t o expire in t he same way as R esult C ache
f or report s
ot her report caches. Settings
cont aining
dynamic dat es

C aching: A uxiliary C aches: Objects category i n Proj ect

C onfi gurati on

© 2019, M icr o St r at egy In c. 778

Syst em Ad m in ist r at io n Gu id e

Gov e r nor De s c r iption Se e pa ge

S erver - Maximum The amount of memory t hat Summary Table of

RA M usage I nt elligence S erver allocat es f or Object C aching
(MB yt es) object caching. Settings

Client - Maximum Summary Table of

The amount of memory t hat Developer
RA M usage Object C aching
allocat es f or object caching.
(MB yt es) Settings

C aching: A uxiliary C aches: Elements category i n Proj ect

C onfi gurati on

Gov e r nor De s c r iption Se e pa ge

S erver - Summary
Maximum Table of
The amount of memory t hat I nt elligence S erver allocat es
RA M Element
f or element caching.
usage C ache
(MB yt es) Settings

Client - Summary
Maximum Table of
The amount of memory t hat Developer allocat es f or object
RA M Element
caching.
usage C ache
(MB yt es) Settings

C aching: Subscription Execution category i n Proj ect C onfi gurati on

Gov e r nor De s c r iption Se e pa ge

Re-run
Causes new subscript ions t o creat e caches or Managing
hist ory list
updat e exist ing caches by def ault when a report or Scheduled
and mobile
document is execut ed and t hat report / document is Administration
subscript ions
subscribed t o t he Hist ory List or a Mobile device. Task s
against t he

779 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Gov e r nor De s c r iption Se e pa ge

warehouse

Re-run f ile,
email, print , Causes new subscript ions t o creat e caches or Managing
or FTP updat e exist ing caches by def ault when a report or Scheduled
subscript ions document is execut ed and t hat report / document is Administration
against t he subscribed t o a f ile, email, or print device. Task s
warehouse

Do not
Managing
creat e or
P revent s subscript ions f rom creat ing or updat ing Scheduled
updat e
caches by def ault . Administration
mat ching
Task s
caches

K eep
document
available f or Managing
manipulat ion Ret ains a document or report f or lat er manipulat ion Scheduled
f or Hist ory t hat was delivered t o t he Hist ory List . Administration
List Task s
subscript ions
only

Intelligent C ubes: General category i n Proj ect C onfi gurati on

Gov e r nor De s c r iption Se e pa ge

D efining
Maximum The maximum amount of memory used on Memory
RA M Usage I nt elligence S erver by I nt elligent Cubes f or t his Limits for
(MB yt es) project . Intelligent
C ubes

Maximum D efining
The maximum number of I nt elligent Cubes t hat can
number of Memory
be loaded ont o I nt elligence S erver f or t his project .
cubes Limits for

© 2019, M icr o St r at egy In c. 780

Syst em Ad m in ist r at io n Gu id e

Gov e r nor De s c r iption Se e pa ge

Intelligent
C ubes

Maximum
Def ines t he maximum cube size, in megabyt es, t hat
cube size
can be downloaded f rom I nt elligent S erver.
allowed f or
A ddit ionally, t his value is used by Dist ribut ion
download
S ervices when sending a . MS TR f ile by email.
(MB )

Maximum %
growt h of an Def ines t he maximum t hat indexes are allowed t o add
I nt elligent t o t he I nt elligent Cube’s size, as a percent age of t he
Cube due t o original size.
indexes

Cube growt h
Def ines, in minut es, how of t en t he I nt elligent Cube’s
check
size is checked and, if necessary, how of t en t he
f requency (in
least -used indexes are dropped.
mins)

Database Connection
Thi s set of governors can be set by modi fyi ng a proj ect source's
database i nstance and then modi fyi ng ei ther the number of Job
Pri ori ti zati on connecti ons or the D atabase connecti on. For more
detai l s on each governor, see the page references i n the tabl e bel ow .

ODBC Settings

Gov e r nor De s c r iption Se e pa ge

Number of The t ot al number of High, Medium, and Low dat abase Managing
dat abase connect ions t hat are allowed at a t ime bet ween D atabase
connect ion I nt elligence S erver and t he dat a warehouse (set on t he C onnection
t hreads dat abase inst ance's Job Prioritiz ation t ab). Threads

781 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Gov e r nor De s c r iption Se e pa ge

Maximum Managing
cancel The maximum amount of t ime t hat t he Query E ngine D atabase
at t empt wait s f or a successf ul at t empt t o cancel a query. C onnection
t ime (sec) Threads

Maximum Managing
query The maximum amount of t ime t hat a single pass of S QL D atabase
execut ion may execut e on t he dat a warehouse. C onnection
t ime (sec) Threads

Maximum Managing
connect ion The maximum amount of t ime t hat I nt elligence S erver D atabase
at t empt wait s t o connect t o t he dat a warehouse. C onnection
t ime (sec) Threads

Database Connection Caching

Gov e r nor De s c r iption Se e pa ge

Managing
Connect ion The amount of t ime t hat an act ive dat abase
D atabase
lif et ime connect ion t hread remains open and cached on
C onnection
(sec) I nt elligence S erver.
Threads

Managing
Connect ion The amount of t ime t hat an inact ive dat abase
D atabase
idle t imeout connect ion t hread remains cached unt il it is
C onnection
(sec) t erminat ed.
Threads

VLDB Settings
These setti ngs can be changed i n the VLD B Properti es di al og box for
ei ther reports or the database i nstance. For i nformati on about
accessi ng these properti es, see the page reference for each property
i n the tabl e bel ow . For compl ete detai l s about al l VLD B properti es,
see SQL Generati on and D ata Processi ng: VLD B Properti es.

© 2019, M icr o St r at egy In c. 782

Syst em Ad m in ist r at io n Gu id e

Gov e r nor De s c r iption Se e pa ge

The maximum number of rows t hat can be in an

I nt ermediat e int ermediat e t able used by I nt elligence S erver. This R esults
row limit set t ing overrides t he project 's def ault N umber of Proc essing
intermediate result rows set t ing

The maximum number of rows t hat can be in a report

Result s S et R esults
result set . This set t ing overrides t he project 's def ault
Row Limit Proc essing
N umber of report result rows set .

Limiting a
S QL t ime The amount of t ime, in seconds, t hat any S QL pass can
R eport' s
out (per execut e on t he dat a warehouse. This can be set at t he
SQL Per
pass) dat abase inst ance and report levels.
Pass

Limiting a
Maximum The maximum size (in byt es) t hat t he S QL st at ement R eport' s
S QL size can be. This can be set at t he dat abase inst ance level. SQL Per
Pass

Tuning Narrowcast Server and Intelligence Server

If you are usi ng N arrow cast Server as part of your system to del i ver
reports to users, you shoul d be aw are of i ts i mpact on Intel l i gence
Server system resources. Thi s secti on i ncl udes rel evant di scussi ons
about:

l H ow you desi gn N arrow cast Server appl i cati ons (Appl i cati on
D esi gn C onsi derati ons, page 784)

l H ow N arrow cast Server connects to Intel l i gence Server (H ow

N arrow cast Server C onnects to Intel l i gence Server, page 785)

For more i nformati on, refer to the N arrow cast Server Getti ng Started
Gui de.

783 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Application Design Considerations

D ependi ng on how you desi gn appl i cati ons i n N arrow cast Server, you
can pl ace more or l ess l oad on Intel l i gence Server. Tw o mai n opti ons
to consi der are personal report executi on and personal page
executi on.

Personal report executi on (PR E) executes a separate report for each

set of users w i th uni que personal i zati on. U sers can have reports
executed under the context of the correspondi ng Intel l i gence Server
user i f desi red. U si ng thi s opti on, securi ty profi l es defi ned i n
D evel oper are mai ntai ned. H ow ever i f the system contai ns many
users w ho al l have uni que personal i zati on, thi s opti on can pl ace a
l arge l oad on Intel l i gence Server.

Personal page executi on (PPE) executes one mul ti -page report for al l
users i n a segment and then uses thi s si ngl e report to provi de
personal i zed content (pages) for di fferent users. Al l users have thei r
reports executed under the context of the same Intel l i gence Server
user, so i ndi vi dual securi ty profi l es are not mai ntai ned. H ow ever, the
l oad on Intel l i gence Server may be si gni fi cantl y l ow er than for PR E i n
some cases.

For more detai l ed i nformati on about these opti ons, refer to the
N arrow cast Server Appl i cati on D esi gner Gui de, speci fi cal l y the
secti on on Page Personal i zati on and D ynami c Subscri pti ons.

Tw o addi ti onal poi nts to consi der i n desi gni ng your N arrow cast
Server appl i cati ons are:

l Ti mi ng of N arrow cast Server j obs: You can schedul e reports to run

at off-peak hours w hen Intel l i gence Server's l oad from
Mi croStrategy Web products and D evel oper users i s l ow est.

l Intel l i gence Server sel ecti on: You can send N arrow cast Server j obs
to a speci fi c Intel l i gence Server to ensure that some Intel l i gence

© 2019, M icr o St r at egy In c. 784

Syst em Ad m in ist r at io n Gu id e

Servers are used sol el y for Mi croStrategy Web products or

D evel oper.

How Narrowcast Server Connects to Intelligence Server

N arrow cast Server can connect to a speci fi c Intel l i gence Server.
N arrow cast Server does thi s by usi ng one or more i nformati on
sources to poi nt to and connect to the desi red Intel l i gence Servers.

l Intelligenc e Serv er prov ides automatic load balanc ing for Narrowc as t
Serv er reques ts . Onc e an information s ourc e is c onfigured, jobs us ing
that information s ourc e go to the appropriate Intelligenc e Serv er for
the mos t effic ient res pons e.

l Narrowc as t Serv er c an c onnec t to any Intelligenc e Serv er in a

c lus ter—this does not need to be the primary node.

l You c an balanc e the load manually by c reating multiple information

s ourc es or by us ing a s ingle information s ourc e pointing to one
Intelligenc e Serv er, thereby des ignating it to handle all Narrowc as t
Serv er reques ts .

785 © 2019, M icr o St r at egy In c.

 9
CLUSTERING M ULTIPLE
M ICRO STRATEGY
SERVERS

© 2019, M icr o St r at egy In c. 786

Syst em Ad m in ist r at io n Gu id e

A cl ustered set of machi nes provi des a rel ated set of functi onal i ty or
servi ces to a common set of users. Mi croStrategy recommends
cl usteri ng Intel l i gence Servers i n envi ronments w here access to the
data w arehouse i s mi ssi on-cri ti cal and system performance i s of
utmost i mportance. Intel l i gence Server provi des you the functi onal i ty
to cl uster a group of Intel l i gence Server machi nes to take advantage
of the many benefi ts avai l abl e i n a cl ustered envi ronment.

Thi s secti on provi des the fol l ow i ng i nformati on:

Overview of Clustering
A cl uster i s a group of tw o or more servers connected to each other i n
such a w ay that they behave l i ke a si ngl e server. Each machi ne i n the
cl uster i s cal l ed a node. Because each machi ne i n the cl uster runs
the same servi ces as other machi nes i n the cl uster, any machi ne can
stand i n for any other machi ne i n the cl uster. Thi s becomes i mportant
w hen one machi ne goes dow n or must be taken out of servi ce for a
ti me. The remai ni ng machi nes i n the cl uster can seaml essl y take over
the w ork of the dow ned machi ne, provi di ng users w i th uni nterrupted
access to servi ces and data.

You can cl uster Mi croStrategy components at tw o l evel s:

l You can cl uster Intel l i gence Servers usi ng the bui l t-i n C l usteri ng
feature. A C l usteri ng l i cense al l ow s you to cl uster up to ei ght
Intel l i gence Server machi nes. For i nstructi ons on how to cl uster
Intel l i gence Servers, see C l usteri ng Intel l i gence Servers, page 802.

l You can cl uster Mi croStrategy Web servers usi ng thi rd-party

cl usteri ng softw are, such as C i sco Local R outer, Mi crosoft Wi ndow s
Load Bal anci ng Servi ce, or Mi crosoft N etw ork Load Bal anci ng. Most
cl usteri ng tool s w ork by usi ng IP di stri buti on based on the i ncomi ng
IP addresses. For detai l s on i mpl ementi ng thi s cl usteri ng method,
see the documentati on for your thi rd-party cl usteri ng softw are.

787 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

The built-in c lus tering feature allows y ou to c onnec t Mic roStrategy Web
to a c lus ter of Intelligenc e Serv ers . For ins truc tions , s ee C onnecti ng
Mi croStrategy Web to a C l uster, page 850 .

Benefits of Clustering
C l usteri ng Intel l i gence Servers provi des the fol l ow i ng benefi ts:

l Increased resource avai l abi l i ty: If one Intel l i gence Server i n a

cl uster fai l s, the other Intel l i gence Servers i n the cl uster can pi ck up
the w orkl oad. Thi s prevents the l oss of val uabl e ti me and
i nformati on i f a server fai l s.

l Strategi c resource usage: You can di stri bute proj ects across nodes
i n w hatever confi gurati on you prefer. Thi s reduces overhead
because not al l machi nes need to be runni ng al l proj ects, and
al l ow s you to use your resources fl exi bl y.

l Increased performance: Mul ti pl e machi nes provi de greater

processi ng pow er.

l Greater scal abi l i ty: As your user base grow s and report compl exi ty
i ncreases, your resources can grow .

l Si mpl i fi ed management: C l usteri ng si mpl i fi es the management of

l arge or rapi dl y grow i ng systems.

Failo ver Su p p o r t
Fai l over support ensures that a busi ness i ntel l i gence system remai ns
avai l abl e for use i f an appl i cati on or hardw are fai l ure occurs.
C l usteri ng provi des fai l over support i n tw o w ays:

l Load redi stri buti on: When a node fai l s, the w ork for w hi ch i t i s
responsi bl e i s di rected to another node or set of nodes.

l R equest recovery: When a node fai l s, the system attempts to

reconnect Mi croStrategy Web users w i th queued or processi ng

© 2019, M icr o St r at egy In c. 788

Syst em Ad m in ist r at io n Gu id e

requests to another node. U sers must l og i n agai n to be

authenti cated on the new node. The user i s prompted to resubmi t
j ob requests.

Lo ad Balan cin g
Load bal anci ng i s a strategy ai med at achi evi ng even di stri buti on of
user sessi ons across Intel l i gence Servers, so that no si ngl e machi ne
i s overw hel med. Thi s strategy i s especi al l y val uabl e w hen i t i s
di ffi cul t to predi ct the number of requests a server w i l l recei ve.
Mi croStrategy achi eves four-ti er l oad bal anci ng by i ncorporati ng l oad
bal ancers i nto the Mi croStrategy Web and Web products.

Load i s cal cul ated as the number of user sessi ons connected to a
node. The l oad bal ancers col l ect i nformati on on the number of user
sessi ons each node i s carryi ng. U si ng thi s i nformati on at the ti me a
user l ogs i n to a proj ect, Mi croStrategy Web connects them to the
Intel l i gence Server node that i s carryi ng the l i ghtest sessi on l oad. Al l
requests by that user are routed to the node to w hi ch they are
connected unti l the user di sconnects from the Mi croStrategy Web
product.

Pr o ject Dist r ib u t io n an d Pr o ject Failo ver

When you set up several server machi nes i n a cl uster, you can
di stri bute proj ects across those cl ustered machi nes or nodes i n any
confi gurati on, i n both Wi ndow s and Li nux envi ronments. Al l servers i n
a cl uster do not need to be runni ng al l proj ects. Each node i n the
cl uster can host a di fferent set of proj ects, w hi ch means onl y a subset
of proj ects need to be l oaded on a speci fi c Intel l i gence Server
machi ne. Thi s feature provi des you w i th fl exi bi l i ty i n usi ng your
resources, and i t provi des better scal abi l i ty and performance because
of l ess overhead on each Intel l i gence Server machi ne.

789 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

D i stri buti ng proj ects across nodes al so provi des proj ect fai l over
support. For exampl e, one server i s hosti ng proj ect A and another
server i s hosti ng proj ects B and C . If the fi rst server fai l s, the other
server can host al l three proj ects to ensure proj ect avai l abi l i ty.

Proj ect creati on, dupl i cati on, and del eti on i n a three-ti er, or server,
connecti on are automati cal l y broadcast to al l nodes duri ng runti me to
ensure synchroni zati on across the cl uster.

Wo r k Fen cin g
U ser fences and w orkl oad fences al l ow you to reserve nodes of a
cl uster for ei ther users or a proj ect subscri pti ons. For more
i nformati on, see R eservi ng N odes w i th Work Fences, page 820.

The Clustered Architecture

The di agram bel ow show s report di stri buti on i n a four-ti er cl ustered
envi ronment. The cl ustered Intel l i gence Servers are show n i n gray.

© 2019, M icr o St r at egy In c. 790

Syst em Ad m in ist r at io n Gu id e

The node of the cl uster that performs al l j ob executi ons i s the node
that the cl i ent appl i cati on, such as D evel oper, connects to. Thi s i s
al so the node that can be moni tored by an admi ni strator usi ng the
moni tori ng tool s.

The fol l ow i ng steps descri be a typi cal j ob process i n a cl ustered,

four-ti er envi ronment. They correspond to the numbers i n the report
di stri buti on fl ow di agram above.

1. Mi croStrategy Web users l og i nto a proj ect and request reports

from thei r Web brow sers.

2. A thi rd-party IP di stri buti on tool such as C i sco Local R outer,

Mi crosoft N etw ork Load Bal anci ng, or Mi crosoft Wi ndow s Load
Bal anci ng Servi ce di stri butes the user connecti ons from the
Mi croStrategy Web cl i ents among w eb servers.

3. The Mi croStrategy Web product l oad bal ancers on each server

col l ect l oad i nformati on from each cl uster node and then connect
the users to the nodes that carry the l i ghtest l oads and that run
the proj ect the user requested. Al l report requests are then
processed by the nodes to w hi ch the users are connected.

4. The Intel l i gence Server nodes recei ve the requests and process
them. In addi ti on, the nodes communi cate w i th each other to
mai ntai n metadata synchroni zati on and cache accessi bi l i ty
across nodes.

5. The nodes send the requests to the w arehouse as queri es.

Query fl ow i n a cl ustered envi ronment i s i denti cal to a standard query

fl ow i n an uncl ustered envi ronment (see Processi ng Jobs, page 59),
w i th tw o excepti ons:

l R esul t (report and document) caches and Intel l i gent C ubes: When a
query i s submi tted by a user, i f an Intel l i gent C ube or a cached
report or document i s not avai l abl e l ocal l y, the server w i l l retri eve

791 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

the cache (i f i t exi sts) from another node i n the cl uster. For an
i ntroducti on to report and document cachi ng, see R esul t C aches,
page 860. For an i ntroducti on to Intel l i gent C ubes, see C hapter 11,
Managi ng Intel l i gent C ubes.

l H i story Li sts: Each user's H i story Li st, w hi ch i s hel d i n memory by

each node i n the cl uster, contai ns di rect references to the rel evant
cache fi l es. Accessi ng a report through the H i story Li st bypasses
many of the report executi on steps, for greater effi ci ency. For an
i ntroducti on to H i story Li sts, see Savi ng R eport R esul ts: H i story
Li st, page 897.

Synchronizing Cached Information across Nodes in a

Cluster
In a cl ustered envi ronment, each node shares cached i nformati on w i th
the other nodes so that the i nformati on users see i s consi stent
regardl ess of the node to w hi ch they are connected w hen runni ng
reports. Al l nodes i n the cl uster synchroni ze the fol l ow i ng cached
i nformati on:

l Metadata i nformati on and obj ect caches (for detai l s, see

Synchroni zi ng Metadata, page 793)

l R esul t caches and Intel l i gent C ubes (for detai l s, see Shari ng R esul t
C aches and Intel l i gent C ubes i n a C l uster, page 793)

l H i story Li sts (for detai l s, see Synchroni zi ng H i story Li sts, page 797)

To vi ew cl ustered cache i nformati on, such as cache hi t counts, use

the C ache Moni tor.

R esul t cache setti ngs are confi gured per proj ect, and di fferent
proj ects may use di fferent methods of resul t cache storage. D i fferent
proj ects may al so use di fferent l ocati ons for thei r cache reposi tori es.
H ow ever, H i story Li st setti ngs are confi gured per proj ect source.

© 2019, M icr o St r at egy In c. 792

Syst em Ad m in ist r at io n Gu id e

Therefore, di fferent proj ects cannot use di fferent l ocati ons for thei r
H i story Li st backups.

For resul t caches and H i story Li sts, you must confi gure ei ther mul ti pl e
l ocal caches or a central i zed cache for your cl uster. The fol l ow i ng
secti ons descri be the caches that are affected by cl usteri ng, and i t
presents the procedures to confi gure caches across cl uster nodes.

Syn ch r o n izin g Met ad at a

Metadata synchroni zati on refers to the process of synchroni zi ng
obj ect caches across al l nodes i n the cl uster.

For exampl e, w hen a user connected to a node i n a cl uster modi fi es a

metadata obj ect, the cache for that obj ect on other nodes i s no l onger
val i d. The node that processed the change automati cal l y noti fi es al l
other nodes i n the cl uster that the obj ect has changed. The other
nodes then del ete the ol d obj ect cache from memory. The next
request for that obj ect that i s processed by another node i n the cl uster
i s executed agai nst the metadata, creati ng a new obj ect cache on that
node.

In addition to s erv er objec t c ac hes , c lient objec t c ac hes are als o

inv alidated when a c hange oc c urs . When a us er reques ts a c hanged
objec t, the inv alid c lient c ac he is not us ed and the reques t is proc es s ed
agains t the s erv er objec t c ac he. If the s erv er objec t c ac he has not been
refres hed with the c hanged objec t, the reques t is ex ec uted agains t the
metadata.

Sh ar in g Resu lt Cach es an d In t elligen t Cu b es in a Clu st er

In a non-cl ustered envi ronment, Intel l i gent C ubes and report and
document caches (resul t caches) are typi cal l y stored on the
Intel l i gence Server machi ne. For an overvi ew of Intel l i gent C ubes,
see C hapter 11, Managi ng Intel l i gent C ubes, or see the In-memory

793 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Anal yti cs Gui de. For an overvi ew of resul t caches, see R esul t
C aches, page 860.

In a cl ustered envi ronment, each node i n a cl uster must share i ts

resul t caches and Intel l i gent C ubes w i th the other nodes, so al l
cl ustered machi nes have the l atest cache i nformati on. For exampl e,
for a proj ect, resul t caches on each node that has l oaded the proj ect
are shared among other nodes i n the cl uster that have al so l oaded the
proj ect. C onfi guri ng caches to be shared among appropri ate nodes
el i mi nates the overhead associ ated w i th executi ng the same report or
document on mul ti pl e nodes.

l Both memory and dis k c ac hes are s hared among nodes .

l When an Intelligent Cube is updated, either through Inc remental

Refres h or by republis hing the Intelligent Cube, the updated Intelligent
Cube is av ailable on all nodes of the c lus ter as s oon as it is loaded
into memory .

Intel l i gent C ube and resul t cache shari ng among nodes can be
confi gured i n one of the fol l ow i ng w ays:

l Local caching: Each node hosts i ts ow n cache fi l e di rectory and

Intel l i gent C ube di rectory. These di rectori es need to be shared so
that other nodes can access them. For more i nformati on, see Local
C achi ng, page 796.

If y ou are us ing loc al c ac hing, the c ac he direc tory mus t be s hared as

"Clus terCac hes " and the Intelligent Cube direc tory mus t be s hared as
"Clus terCube". Thes e are the s hare names Intelligenc e Serv er look s
for on other nodes to retriev e c ac hes and Intelligent Cubes .

l C entralized caching: Al l nodes have the cache fi l e di rectory and

Intel l i gent C ube di rectory set to the same netw ork l ocati ons,
\\ <m ac hi n e n a m e > \ < s h a r e d c a c h e f o l d e r n a m e > and
\\ <m ac hi n e n a m e > \ < s h a r e d I n t e l l i g e n t C u b e f o l d er

© 2019, M icr o St r at egy In c. 794

Syst em Ad m in ist r at io n Gu id e

na me > . For more i nformati on, see C entral i zed C achi ng, page 797.

For c ac hes on Windows mac hines , and on Linux mac hines us ing
Samba, s et the path to \ \ < m a c h i n e n a m e > \ < s h a r e d c a c h e
fo ld er n a m e > . For c ac hes on Linux mac hines , s et the path to
// <S ha r e d L o c a t i o n > / < C a c h e F o l d e r > .

The fol l ow i ng tabl e summari zes the pros and cons of the resul t cache
confi gurati ons:

Pr os Cons

• A llows f ast er read and

writ e operat ions f or cache • The local cache f iles may be

f iles creat ed by t he local t emporarily unavailable if an

server. I nt elligence S erver is t aken of f

t he net work or powered down.
• Fast er backup of cache
L o cal cach in g
lookup t able. • A document cache on one node
may depend on a dat aset t hat
• A llows most caches t o is cached on anot her node,
remain accessible even if creat ing a mult i-node clust er
one node in a clust er goes dependency.
of f line.

• A ll cache operat ions are

• A llows f or easier backup
required t o go over t he net work
process.
if shared locat ion is not on one
• A llows all cache f iles t o be of t he I nt elligence S erver
accessible even if one node machines.
C en t ralized in a clust er goes of f line.
• Requires addit ional hardware if
cach in g
• May bet t er suit some shared locat ion is not on an
securit y plans because I nt elligence S erver.
nodes using a net work
• A ll caches become inaccessible
account are accessing only
if t he machine host ing t he
one machine f or f iles.
cent ralized caches goes of f line.

795 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Mi croStrategy recommends stori ng the resul t caches l ocal l y i f your

users mostl y do ad hoc reporti ng. In ad hoc reporti ng the caches are
not used very much, and the overhead i ncurred by creati ng the
caches on a remote fi l e server outw ei ghs the l ow probabi l i ty that a
cache may be used. On the other hand, i f the caches are to be heavi l y
used, central i zed cachi ng may sui t your system better.

For steps to confi gure cache fi l es w i th ei ther method, see C onfi guri ng
C aches i n a C l uster, page 803.

Local Caching

In thi s cache confi gurati on, each node mai ntai ns i ts ow n l ocal
Intel l i gent C ubes and l ocal cache fi l e and, thus, mai ntai ns i ts ow n
cache i ndex fi l e. Each node's caches are accessi bl e by other nodes
i n the cl uster through the cache i ndex fi l e. Thi s i s i l l ustrated i n the
di agram bel ow .

For exampl e, U ser A, w ho i s connected to node 1, executes a report

and thus creates report cache A on node 1. U ser B, w ho i s connected
to node 2, executes the report. N ode 2 checks i ts ow n cache i ndex fi l e
fi rst. When i t does not l ocate report cache A i n i ts ow n cache i ndex
fi l e, i t checks the i ndex fi l e of other nodes i n the cl uster. Locati ng
report cache A on node 1, i t uses that cache to servi ce the request,
rather than executi ng the report agai nst the w arehouse.

© 2019, M icr o St r at egy In c. 796

Syst em Ad m in ist r at io n Gu id e

Centralized Caching

In thi s cache confi gurati on, al l nodes i n the cl uster use one shared,
central i zed l ocati on for Intel l i gent C ubes and one shared, central i zed
cache fi l e l ocati on. These can be stored on one of the Intel l i gence
Server machi nes or on a separate machi ne dedi cated to servi ng the
caches. The Intel l i gent C ubes, H i story Li st messages, and resul t
caches for al l the Intel l i gence Server machi nes i n the cl uster are
w ri tten to the same l ocati on. In thi s opti on, onl y one cache i ndex fi l e
i s mai ntai ned. Thi s i s i l l ustrated i n the di agram bel ow .

For exampl e, U ser A, w ho i s connected to node 1, executes report A

and thus creates report cache A, w hi ch i s stored i n a central i zed fi l e
fol der. U ser B, w ho i s connected to node 2, executes report A. N ode 2
checks the central i zed cache i ndex fi l e for report cache A. Locati ng
report cache A i n the central i zed fi l e fol der, i t uses that cache to
servi ce the request, regardl ess of the fact that node 1 ori gi nal l y
created the cache.

Syn ch r o n izin g Hist o r y List s

A H i story Li st i s a set of poi nters to cache fi l es. Each user has thei r
ow n H i story Li st, and each node i n a cl uster stores the poi nters
created for each user w ho i s connected to that node. Each node's

797 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

H i story Li st i s synchroni zed w i th the rest of the cl uster. Even i f report

cachi ng i s di sabl ed, H i story Li st functi onal i ty i s not affected.

If you are usi ng a database-based H i story Li st, H i story Li st messages

and thei r associ ated caches are stored i n the database and
automati cal l y synchroni zed across al l nodes i n the cl uster.

If you are usi ng a fi l e-based H i story Li st, the Intel l i gence Server Inbox
fol der contai ns the col l ecti on of H i story Li st messages for al l users,
w hi ch appear i n the H i story fol der i n D evel oper. Inbox
synchroni zati on refers to the process of synchroni zi ng H i story Li sts
across al l nodes i n the cl uster, so that al l nodes contai n the same
H i story Li st messages. Inbox synchroni zati on enabl es users to vi ew
the same set of personal H i story Li st messages, regardl ess of the
cl uster node to w hi ch they are connected.

For more background i nformati on on H i story Li sts, see Savi ng R eport

R esul ts: H i story Li st, page 897. For steps to set up H i story Li st
shari ng i n a fi l e-based system, see C onfi guri ng C aches i n a C l uster,
page 803.

Mi croStrategy recommends that you enabl e user affi ni ty cl usteri ng to

mi ni mi ze H i story Li st resource usage. U ser affi ni ty cl usteri ng causes
Intel l i gence Server to connect al l sessi ons for a user to the same
node of the cl uster. Thi s enabl es Intel l i gence Server to keep the
user's H i story Li st on one node of the cl uster. R esource use i s
mi ni mi zed because the poi nters to the H i story Li st are not stored on
mul ti pl e machi nes. In addi ti on, i f you are usi ng a fi l e-based H i story
Li st, the H i story Li st i s never out of sync across mul ti pl e nodes of the
cl uster. For i nstructi ons on how to enabl e user affi ni ty cl usteri ng, see
C onfi guri ng C aches i n a C l uster, page 803.

© 2019, M icr o St r at egy In c. 798

Syst em Ad m in ist r at io n Gu id e

Prerequisites for Clustering Intelligence Servers

Before you can cl uster Intel l i gence Servers i n your system, you must
ful fi l these prerequi si tes.

MicroStrategy Prerequisites
l You must have purchased an Intel l i gence Server l i cense that al l ow s
cl usteri ng. To determi ne the l i cense i nformati on, use the Li cense
Manager tool and veri fy that the C l usteri ng feature i s avai l abl e for
Intel l i gence Server. For more i nformati on on usi ng Li cense
Manager, see C hapter 5, Managi ng Your Li censes.

l The computers to be cl ustered must al l have the same versi on of

Intel l i gence Server i nstal l ed.

l Al l Mi croStrategy proj ects on the cl ustered machi nes must be based

on the same metadata.

l At l east one proj ect must be defi ned i n the metadata.

l N o more than one Intel l i gence Server can be confi gured for a si ngl e
machi ne. Mul ti pl e i nstances of Intel l i gence Server shoul d not run on
the same machi ne for cl usteri ng purposes.

l The user account under w hi ch the Intel l i gence Server servi ce i s

runni ng must have ful l control of cache and H i story Li st fol ders on
al l nodes. Otherw i se, Intel l i gence Server w i l l not be abl e to create
and access cache and H i story Li st fi l es.

l Server defi ni ti ons store Intel l i gence Server confi gurati on

i nformati on. Mi croStrategy strongl y recommends that al l servers i n
the cl uster use the same server defi ni ti on. Thi s ensures that al l
nodes have the same governi ng setti ngs.

l Server defi ni ti ons can be modi fi ed from D evel oper through the
Intel l i gence Server C onfi gurati on Edi tor and the Proj ect

799 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

C onfi gurati on Edi tor. For i nstructi ons, see the Mi croStrategy Web
H el p.

l D evel oper must be i nstal l ed on a Wi ndow s machi ne to admi ni ster

the cl uster. Thi s versi on of D evel oper must be the same as the
versi on of Intel l i gence Servers. For exampl e, i f the Intel l i gence
Servers are runni ng Mi croStrategy Intel l i gent Enterpri se, D evel oper
must al so be Intel l i gent Enterpri se.

l You must have access to the C l uster vi ew of the System

Admi ni strati on moni tor i n D evel oper. Therefore, you must have the
Admi ni strati on pri vi l ege to create a cl uster. For detai l s about the
C l uster vi ew of the System Admi ni strati on moni tor, see Managi ng
Your C l ustered System, page 823.

l The computers that w i l l be cl ustered must have the same i ntra-

cl uster communi cati on setti ngs. To confi gure these setti ngs, on
each Intel l i gence Server machi ne, i n D evel oper, ri ght-cl i ck the
proj ect source and sel ect C onfigure MicroStrategy Intelligence
Server. The Intel l i gence Server C onfi gurati on Edi tor opens. U nder
the Server definition category, sel ect General.

l The same cachi ng method (l ocal i zed or central i zed cachi ng) shoul d
be used for both resul t caches and fi l e-based H i story Li sts. For
i nformati on about l ocal i zed and central i zed cachi ng, see
Synchroni zi ng C ached Informati on across N odes i n a C l uster, page
792.

Server Prerequisites
l The machi nes to be cl ustered must be runni ng the same versi on of
the same operati ng system.

l Load bal anci ng and system confi gurati on are si mpl er i f i denti cal
hardw are i s used for each of the cl ustered nodes.

© 2019, M icr o St r at egy In c. 800

Syst em Ad m in ist r at io n Gu id e

l If you are usi ng ti me-based schedul es i n a cl ustered envi ronment,

al l the nodes i n the cl uster must have thei r cl ocks synchroni zed.

l The R D BMS contai ni ng the metadata and w arehouse i nstances

must al ready be set up on machi nes separate from the Intel l i gence
Server nodes.

l Informati on on the cl ustered confi gurati on i s stored i n the metadata,

so the machi nes to be cl ustered must use the same metadata
reposi tory. The metadata may be created from any of the nodes, and
i t needs to be set up onl y once. When you create or modi fy the
server defi ni ti on i n the Mi croStrategy C onfi gurati on Wi zard, you can
speci fy ei ther a new or an exi sti ng metadata reposi tory for
Intel l i gence Server to use.

l The requi red data source names (D SN s) must be created and

confi gured for Intel l i gence Server on each machi ne. Mi croStrategy
strongl y recommends that you confi gure both servers to use the
same metadata database, w arehouse, port number, and server
defi ni ti on.

l Al l nodes must j oi n the cl uster before you make any changes to any
governi ng setti ngs, such as i n the Intel l i gence Server C onfi gurati on
Edi tor.

Prerequisites for Windows Clustering

l When Intel l i gence Server i s i nstal l ed, the l ast step i s to choose a
user i denti ty under w hi ch the servi ce w i l l run. To run a cl ustered
confi gurati on, the user must be a domai n account that has a trust
rel ati onshi p w i th each of the computers i n the cl uster. Thi s al l ow s
resources to be shared across the netw ork.

l The servi ce user's R egi onal Opti ons setti ngs must be the same as
the cl ustered system's R egi onal Opti ons setti ngs.

801 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Prerequisites for Linux Clustering

l Mi croStrategy strongl y recommends that al l servers i n a cl uster use
the same server defi ni ti on. Therefore, i n some cases you cannot
speci fy the cache l ocati on w i th an absol ute path such as
/< ma ch in e _ n a m e >. Thi s occurs because the l ocati on w oul d have
to be di fferent for each server machi ne. To sol ve thi s probl em, use
rel ati ve paths and soft l i nks. A soft l i nk i s a speci al type of U N IX fi l e
that refers to another fi l e by i ts path name. A soft l i nk i s created
w i th the l n ( l i n k ) command:

ln - s O LD N A M E N E WN A M E

Where

OL DN AM E i s the target of the l i nk, usual l y a path name.

NE WN AM E i s the path name of the l i nk i tsel f.

Most operati ons (open, read, w ri te) on the soft l i nk automati cal l y de-
reference i t and operate on i ts target (OLD N AME). Some operati ons
(for exampl e, removi ng) w ork on the l i nk i tsel f (N EWN AME).

l C onfi rm that each server machi ne w orks properl y, and then shut
dow n each machi ne.

Clustering Intelligence Servers

Bel ow i s a hi gh-l evel overvi ew of the steps to cl uster Intel l i gence
Servers:

1. C onfi rm that you have ful fi l l ed the prerequi si tes for cl usteri ng
Intel l i gence Servers.

2. C onfi gure the caches to synchroni ze i nformati on across nodes.

3. Joi n nodes.

4. Test the cl ustered system.

© 2019, M icr o St r at egy In c. 802

Syst em Ad m in ist r at io n Gu id e

5. (Opti onal ) D i stri bute proj ects across nodes.

6. (Opti onal ) R eserve nodes w i th w ork fences.

Configuring Caches in a Cluster

You can confi gure caches i n one of tw o w ays:

l Local caching: Each node hosts i ts ow n cache fi l e di rectory and

Intel l i gent C ube di rectory. These di rectori es need to be shared so
that other nodes can access them. For more i nformati on, see
Synchroni zi ng C ached Informati on across N odes i n a C l uster, page
792.

l C entralized caching: Al l nodes have the cache fi l e di rectory and

Intel l i gent C ube di rectory set to the same netw ork l ocati ons. For
more i nformati on, see Synchroni zi ng C ached Informati on across
N odes i n a C l uster, page 792.

Co n f igu r in g Cach es in a Clu st er o n Win d o ws

U se one of the procedures bel ow to share cache fi l es among the
nodes i n your cl uster. Mi croStrategy strongl y recommends that each
node i n your cl uster use the same server defi ni ti on. In thi s case, you
need to confi gure the cache l ocati on i n Intel l i gence Server onl y one
ti me. H ow ever, you must create the shared fol ders on each node
separatel y. For a detai l ed expl anati on of the tw o methods of cache
shari ng, see Synchroni zi ng C ached Informati on across N odes i n a
C l uster, page 792.

To Configure Cache Sharing Using Multiple Local Cache Files

1. Open the Proj ect C onfi gurati on Edi tor for the proj ect.

2. Sel ect C aching > R esult C aches > Storage.

3. In the C ache file directory box, type:

803 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

.\ Ca ch e s \ S e r v e rD e f i n i t i o n

w here S e r v e r D e f i n i t i o n i s the name of the server defi ni ti on.

Thi s tel l s the other cl ustered nodes to search for caches i n the
fol l ow i ng path on al l machi nes i n the cl uster:

<I nt el l i g e n c e Se r v e r A p p l i c a t i o n
Fo ld er > \ C a c h e s \S e r v e r D e f i n i t i o n

4. C l i ck OK .

5. On each machi ne i n the cl uster, open Wi ndow s Expl orer and

navi gate to the cache fi l e fol der. The defaul t l ocati on i s:

C: \P ro g r a m F i l e s
(x 86 )\ M i c r o S t r a t e g y \ I n t e l l i g e n c e
Se rv er \ C a c h e s \Se r v e r D e f i n i t i o n

w here S e r v e r D e f i n i t i o n i s the name of the server defi ni ti on.

6. R i ght-cl i ck the cache fi l e fol der, and sel ect Sharing.

© 2019, M icr o St r at egy In c. 804

Syst em Ad m in ist r at io n Gu id e

7. On the Shari ng tab, sel ect the Shared as opti on. In the Share
N ame box, del ete the exi sti ng text and type C l u s t e r C a c h e s.

8. C l i ck OK .

To Configure Cache Sharing Using a Centralized Cache File

1. Open the Proj ect C onfi gurati on Edi tor for the proj ect.

2. Sel ect C aching > R esult C aches > Storage.

3. In the C ache file directory box, type one of the fol l ow i ng:

\\ < M ac h i n e N a m e> \ <S h a r e d F o l d e r N a m e>

or

\\ <I P A d d r e s s >\< S h a r e d F o l d e r N a m e >

805 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

For exampl e, \ \ M y _F i l e _S e r v e r \ M y _C a c h e _D i r e c t o r y.

4. C l i ck OK .

5. On the machi ne that i s stori ng the central i zed cache, create the
fi l e fol der that w i l l be used as the shared fol der. The fi l e fol der
name must be i denti cal to the name you earl i er speci fi ed i n the
C ache file directory box (show n as Shared Fol der N ame
above).

Mak e s ure this c ac he direc tory is writable to the network ac c ount

under whic h Intelligenc e Serv er is running. Eac h Intelligenc e
Serv er c reates its own s ubdirec tory .

Configuring History List Sharing Using Multiple Local Cache Files

If you are usi ng a fi l e-based H i story Li st, you can set up H i story Li sts
to use mul ti pl e l ocal di sk backups on each node i n the cl uster, usi ng
a procedure si mi l ar to the procedure above, To C onfi gure C ache
Shari ng U si ng Mul ti pl e Local C ache Fi l es, page 803. The H i story Li st
messages are stored i n the H i story fol der. (To l ocate thi s fol der, i n the
Intel l i gence Server C onfi gurati on Edi tor, expand Governing R ules,
expand D efault, then sel ect H istory settings.)

The H i story Li st l ocati on i s . \ I n b o x \S e r v e r D e f i n i t i o n, w here

Serv er De fi n i t i o n i s the name of the fol der contai ni ng the
H i story Li sts. Thi s fol der must be shared w i th the share name
"C l usterInbox" because thi s i s the share name used by Intel l i gence
Server to l ook for H i story Li sts on other nodes.

Co n f igu r in g Cach es in a Clu st er o n Lin u x

To confi gure a cl uster of Intel l i gence Servers i n a Li nux envi ronment,
al l servers must have access to each others' caches and i nbox
(H i story Li st) fi l es. Both cache and H i story Li st fi l es are referred to
general l y as cache fi l es throughout thi s secti on. An Intel l i gence

© 2019, M icr o St r at egy In c. 806

Syst em Ad m in ist r at io n Gu id e

Server l ooks for cache fi l es from other nodes i n the cl uster by

machi ne name. For an expl anati on and di agrams of general cache
synchroni zati on setup, see Synchroni zi ng C ached Informati on across
N odes i n a C l uster, page 792.

The cache and Inbox fol ders must be named as fol l ow s:

/<ma ch in e_ n a m e > / C l u s t e r C a c h e s

/<ma ch in e_ n a m e > / C l u s t e r I n b o x

For exampl e, a tw o-node cl uster w i th Intel l i gence Servers i s runni ng

on machi nes U N IX1 and U N IX2. Intel l i gence Server runni ng on
U N IX1 l ooks for caches of the other Intel l i gence Server onl y on
/UNI X2 /C lu s t e r C a c h e s.

The procedures bel ow demonstrate how to confi gure the caches on

tw o servers, named U N IX1 and U N IX2. U se these steps as a
gui del i ne for confi guri ng your ow n system.

You can choose to use ei ther procedure bel ow , dependi ng on w hether

you w ant to use central i zed or l ocal cachi ng. For a detai l ed
descri pti on and di agrams of cache synchroni zati on setup, see
Synchroni zi ng C ached Informati on across N odes i n a C l uster, page
792.

To Configure a Cluster with a Centralized Cache

This proc edure as s umes that the Linux mac hines are c alled UNIX1 and
UNIX2.

To Conf i gur e t he Ser ver Def i ni t i on and Pr oj ect

1. Start Intel l i gence Server on U N IX1.

2. In D evel oper, create proj ect sources poi nti ng to U N IX1 and
U N IX2.

807 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

3. C onnect to U N IX1 usi ng D evel oper.

4. R i ght-cl i ck the proj ect source of U N IX1 and sel ect C onfigure
Server.

5. Sel ect the Server D efinition category, and sel ect H istory
Settings.

6. Set the path usi ng the fol l ow i ng conventi on:

// <S ha r e d L o c a t i o n > / < I n b o x F o l d e r >

In thi s exampl e, set i t as / / s a n d b o x / I n b o x.

7. R i ght-cl i ck the proj ect name and sel ect Project C onfiguration.

8. Sel ect C aching > R esult C aches > Storage.

9. Fol l ow i ng the conventi on

// <S ha r e d L o c a t i o n > / < C a c h e F o l d e r >, set the path to
// sa nd b o x / C a c h e s.

For c ac hes s tored on Linux mac hines us ing Samba, s et the path to
\\ <m a c h i n e n a m e > \ < s h a r e d f o l d e r n a m e > .

10. D i sconnect from the proj ect source and restart Intel l i gence
Server.

To Cr eat e t he Cache Fol d er on t he Shar ed Devi ce

1. C reate the fol ders for caches on the shared devi ce (as descri bed
i n Prerequi si tes for C l usteri ng Intel l i gence Servers, page 799
above):

mk di r / s a n d b o x / C a c h e s

mk di r / s a n d b o x / I n b o x

2. R estart both Intel l i gence Servers.

© 2019, M icr o St r at egy In c. 808

Syst em Ad m in ist r at io n Gu id e

To Configure a Cluster with Multiple Local Cache Files

This proc edure mak es the following as s umptions :

l The Li nux machi nes are cal l ed U N IX1 and U N IX2.

l Intel l i gence Server i s i nstal l ed i n M S T R _< H O M E _P A T H > on each

machi ne.

l The M ST R_ H O M E _P A T H for each machi ne i s / B u i l d / B I N / S u n O S/.

To Conf i gur e t he Ser ver Def i ni t i on and Pr oj ect

1. Start Intel l i gence Server on U N IX 1.

2. In D evel oper, create proj ect sources poi nti ng to U N IX1 and
U N IX2.

3. C onnect to U N IX1 usi ng D evel oper.

4. R i ght-cl i ck the proj ect source of U N IX1 and sel ect C onfigure
Server.

5. Sel ect the Server D efinition category, and sel ect H istory
Settings.

6. Set the path to . / C l u s t e r I n b o x and cl i ck OK .

7. R i ght-cl i ck the proj ect name and sel ect Project C onfiguration.

8. Sel ect C aching, then R esult C aches, then Storage.

9. Set the path for the cache fi l e di rectory to . / C l u s t e r C a c h e s.

10. D i sconnect from the proj ect source and shut dow n Intel l i gence
Server.

809 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To Set U p t he U N IX1 M achi ne

1. C reate the fol ders for caches:

mk di r $ M S T R _< H O M E _P A T H > / C l u s t e r C a c h e s

mk di r $ M S T R _< H O M E _P A T H > / C l u s t e r I n b o x

2. Mount the fol ders from U N IX2 on U N IX1. For exampl e:

mk di r / U N I X 2

mo un t U N I X 2 : / B u i l d / B I N / S u n O S / U N I X 2

To Set up t he U N IX2 M achi ne

1. C reate the fol ders for caches:

mk di r $ M S T R _H O M E _P A T H / C l u s t e r C a c h e s

mk di r $ M S T R _H O M E _P A T H / C l u s t e r I n b o x

2. Mount the fol ders from U N IX2 on U N IX1. For exampl e:

mk di r / U N I X 1

mo un t U N I X 1 : / B u i l d / B I N / S u n O S / U N I X 1

3. R estart both Intel l i gence Servers.

Co n f igu r in g Hist o r y List s in a Clu st er ed En vir o n men t

Mi croStrategy recommends that you enabl e user affi ni ty cl usteri ng to
reduce H i story Li st resource usage. U ser affi ni ty cl usteri ng causes
Intel l i gence Server to connect al l sessi ons for a user to the same
node of the cl uster. For background i nformati on about user affi ni ty
cl usteri ng, see Synchroni zi ng C ached Informati on across N odes i n a
C l uster, page 792.

If you are not usi ng user affi ni ty cl usteri ng, Mi croStrategy

recommends that you set the cache backup frequency to 0 (zero) to

© 2019, M icr o St r at egy In c. 810

Syst em Ad m in ist r at io n Gu id e

ensure that H i story Li st messages are synchroni zed correctl y betw een
nodes. For more i nformati on about thi s setti ng, see C onfi guri ng
R esul t C ache Setti ngs, page 884.

To Configure the History List Governing Settings for a Clustered

Environment

1. In D evel oper, l og i n to a proj ect source. You must l og i n as a

user that has admi ni strati ve pri vi l eges.

2. From the A dministration menu, go to Server > C onfigure

MicroStrategy Intelligence Server.

3. Expand the Server D efinition category, and then sel ect

A dvanced.

4. D o one of the fol l ow i ng:

l To enabl e user affi ni ty cl usteri ng, sel ect the U ser A ffinity
C luster check box.

l OR , i f you do not w ant to enabl e user affi ni ty cl usteri ng, i n the

B ackup frequency (minutes) fi el d, type 0 (zero).

5. C l i ck OK .

6. R estart Intel l i gence Server.

Configuring Session Recovery Message Sharing in a

Cluster
In a cl ustered Intel l i gence Server envi ronment, addi ti onal
confi gurati on i s requi red for the cl uster nodes to be abl e to share
Sessi on R ecovery functi onal i ty for sessi ons that exi sted on other
cl uster nodes. Thi s confi gurati on i s si mi l ar to the confi gurati on
requi red to share caches, cubes, and hi story l i st messages. The
reposi tory can be l ocated ei ther l ocal l y or i n a shared netw ork
l ocati on. In l ocal i zed storage, each cl uster node w i l l retai n the

811 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

recovery fi l es for sessi ons hosted by that node. The fi l e l ocati on w i l l

be shared to the other cl uster nodes so that each node can access
other node's recovery fi l es. In central i zed storage, al l cl uster nodes
w i l l store thei r reposi tory fi l es i n a central shared netw ork l ocati on.

Co n f igu r in g Sessio n Reco ver y Message Rep o sit o r y Sh ar in g

in a Clu st er o n Win d o ws

The domain us er running the remote Intelligenc e Serv ers mus t hav e full
read and write ac c es s to this s hared loc ation.

Shared network loc ations s hould be s et up before c onfiguring the

Intelligenc e Serv ers for c entraliz ed s torage.

Shared network loc ations s hould be ac c es s ible v ia a Univ ers al Naming

Conv ention (UNC) path, in the format of \ \ m a c h i n e n a m e \ p a t h .

To Configure Session Recovery Messages for Localized Storage

1. Open the Intelligence Server C onfiguration Editor.

2. Sel ect Governing R ules > D efault > Temporary Storage

Settings.

3. In the Session R ecovery and D eferred Inbox storage

directory box, type:

4. .\ in bo x \ S e r v e r D e f i n i t i o n w here S e r v e r D e f i n i t i o n i s
the name of the server defi ni ti on.

5. C l i ck OK .

6. R i ght-cl i ck the confi gured path fi l e fol der, and sel ect Sharing.

7. On the Shari ng tab, sel ect the Shared as opti on. In the Share
N ame box, del ete the exi sti ng text and type C l u s t e r W S R M.

© 2019, M icr o St r at egy In c. 812

Syst em Ad m in ist r at io n Gu id e

This folder mus t be s hared with the name "Clus terWSRM". This
name is us ed by Intelligenc e Serv er to look for Ses s ion Rec ov ery
mes s ages on other nodes .

8. C l i ck OK .

9. R estart Intel l i gence Server.

To Configure Session Recovery Messages for a Centralized

Storage Location

1. Open the Intelligence Server C onfiguration Editor.

2. Sel ect Governing R ules > D efault > Temporary Storage

Settings

3. In the Session R ecovery and D eferred Inbox storage

directory box, type:

\\ < M a c h i n e N a m e> \ <S h a r e d F o l d e r N a m e>

or

\\<IP Address>\<Shared Folder Name>

4. C l i ck OK .

Co n f igu r in g Sessio n Reco ver y Message Rep o sit o r y Sh ar in g

in a Clu st er o n UNIX/ Lin u x

The domain us er running the remote Intelligenc e Serv ers mus t hav e full
read and write ac c es s to this s hared loc ation.

Shared network loc ations s hould be s et up and mounted to the loc al file
s y s tem on eac h Intelligenc e Serv er before c onfiguring for c entraliz ed
s torage.

813 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To Configure Session Recovery Messages for a Centralized

Storage Location

To Cr eat e t he Sessi on Recover y Fol d er on t he Shar ed Devi ce

1. C reate the fol ders for Sessi on R ecovery messages on the shared
devi ce:

mk di r / s a n d b o x / W S R M s h a r e

2. R estart your Intel l i gence Servers.

To Conf i gur e t he Ser ver Def i ni t i on and Pr oj ect

1. R i ght-cl i ck the proj ect source and sel ect C onfigure Server.

2. Sel ect Governing R ules > D efault > Temporary Storage

Settings.

3. In the Session R ecovery and D eferred Inbox storage

directory box, set the path usi ng the fol l ow i ng conventi on:
// <m ac h i n e _n a m e > / s a n d b o x / W S R M s h a r e

4. C l i ck OK .

5. R epeat for each Intel l i gence Server.

To Configure Session Recovery Messages for Localized Storage

This proc edure mak es the following as s umptions :

l The Linux mac hines are c alled UNIX1 and UNIX2.

l Intelligenc e Serv er is ins talled in M S T R _< H O ME _P A T H > on eac h

mac hine.

l The M ST R_ < H O M E _P A T H > for eac h mac hine is

/B ui ld /B I N / S u n O S/ .

© 2019, M icr o St r at egy In c. 814

Syst em Ad m in ist r at io n Gu id e

To Conf i gur e t he Ser ver Def i ni t i on and Pr oj ect

1. Start Intel l i gence Server on U N IX 1.

2. In D evel oper, create proj ect sources poi nti ng to U N IX1 and
U N IX2.

3. C onnect to U N IX1 usi ng D evel oper.

4. R i ght-cl i ck the proj ect source of U N IX1 and sel ect C onfigure
Server.

5. Sel ect Governing R ules > D efault > Temporary Storage

Settings

6. Set the path to . / C l u s t e r I n b o x i n the Session R ecovery and

D eferred Inbox storage directory

7. C l i ck OK .

To Set U p t he U N IX1 M achi ne

1. C reate a top l evel fol der /U N IX2.

mk di r / U N I X 2

2. In thi s fol der create a sub fol der C l usterInbox

3. Mount the fol ders from U N IX2 on the U N IX1 machi ne usi ng the
fol l ow i ng command:

mo un t U N I X 2 : / B u i l d / B I N / S u n O S / U N I X 2 / C l u s t e r I n b ox

To Set U p t he U N IX2 M achi ne

1. C reate a top l evel fol der /U N IX1.

mk di r / U N I X 1

2. In thi s fol der create a sub fol der C l usterInbox

815 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

3. Mount the fol ders from U N IX2 on the U N IX1 machi ne usi ng the
fol l ow i ng command:

mo un t U N I X 2 : / B u i l d / B I N / S u n O S / U N I X 1 / C l u s t e r I n b ox

Joining the Nodes in a Cluster

You j oi n one node (or machi ne) to another node to form a cl uster
usi ng the C l uster Moni tor.

To Join a Node to a Cluster

1. In D evel oper, l og i n to a proj ect source. You must l og i n as a

user w i th the Admi ni ster C l uster pri vi l ege.

2. Expand A dministration, then expand System A dministration,

and then sel ect C luster. Informati on about each node i n the
cl uster i nformati on di spl ays on the ri ght-hand si de.

3. From the A dministration menu, poi nt to Server, then sel ect Join
cluster.

4. Type the name of the machi ne runni ng Intel l i gence Server to

w hi ch you are addi ng thi s node, or cl i ck ... to brow se for and
sel ect i t.

5. C l i ck OK .

Verifying the Clustered System is Working

Once al l nodes have been synchroni zed and added to the cl uster, you
can veri fy that the cl uster i s w orki ng properl y.

To Ver if y f r o m Develo p er
1. C onnect to one Intel l i gence Server i n the cl uster and ensure that
the C l uster vi ew i n D evel oper (under Admi ni strati on, under

© 2019, M icr o St r at egy In c. 816

Syst em Ad m in ist r at io n Gu id e

System Admi ni strati on) i s show i ng al l the proper nodes as

members of the cl uster.

2. C onnect to any node and run a l arge report.

3. U se the C ache Manager and vi ew the report detai l s to make sure

the cache i s created.

4. C onnect to a di fferent node and run the same report. Veri fy that
the report used the cache created by the fi rst node.

5. C onnect to any node and run a report.

6. Add the report to the H i story Li st.

7. Wi thout l oggi ng out that user, l og on to a di fferent node w i th the

same user name.

8. Veri fy that the H i story Li st contai ns the report added i n the fi rst
node.

To Ver if y f r o m Micr o St r at egy Web

1. Open the Mi croStrategy Web Admi ni strator page.

2. C onnect to any node i n the cl uster. Mi croStrategy Web U ni versal

shoul d automati cal l y recogni ze al l nodes i n the cl uster and show
them as connected.

If Mic roStrategy Web does not rec ogniz e all nodes in the c lus ter, it is
pos s ible that the mac hine its elf c annot res olv e the name of that node.
Mic roStrategy c lus ter implementation us es the names of the mac hines
for internal c ommunic ation. Therefore, the Web mac hine s hould be able
to res olv e names to IP addres s es . You c an edit the l m h o s t file to
relate IP addres s es to mac hine names .

You can al so perform the same cache and H i story Li st tests descri bed
above i n To Veri fy from D evel oper, page 816.

817 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Distributing Projects Across Nodes in a Cluster

You can di stri bute proj ects across nodes of a cl uster i n any cl ustered
confi gurati on. Each node can host a di fferent set of proj ects, w hi ch
means onl y a subset of proj ects needs to be l oaded on an Intel l i gence
Server. Thi s provi des you w i th fl exi bi l i ty i n usi ng your resources and
better scal abi l i ty and performance.

To di stri bute proj ects across the cl uster, you manual l y assi gn the
proj ects to speci fi c nodes i n the cl uster. Once a proj ect has been
assi gned to a node, i t i s avai l abl e for use.

If y ou do not as s ign a projec t to a node, the projec t remains unloaded

and us ers c annot us e it. You mus t then manually load the projec t for it to
be av ailable. To manually load a projec t, right-c lic k the projec t in the
Projec t Monitor and s elec t Load .

If y ou are us ing s ingle ins tanc e s es s ion logging in Enterpris e Manager

with c lus tered Intelligenc e Serv ers , the s ingle ins tanc e s es s ion logging
projec t mus t be loaded onto all the c lus tered Intelligenc e Serv ers .
Failure to load this projec t on all s erv ers at s tartup res ults in a los s of
s es s ion s tatis tic s for any Intelligenc e Serv er onto whic h the projec t is
not loaded at s tartup. For more information, s ee Mic roStrategy
Community Knowledge Bas e artic le KB14591 . For detailed information
about s es s ion logging in Enterpris e Manager, s ee the Enterpri se
Manager Gui de .

To distribute projects across nodes in a cluster

1. In D evel oper, from the A dministration menu, poi nt to Projects,

then sel ect Select Projects. Intel l i gence Server C onfi gurati on
Edi tor opens, at the Projects: General category.

2. One col umn i s di spl ayed for each node i n the cl uster that i s

© 2019, M icr o St r at egy In c. 818

Syst em Ad m in ist r at io n Gu id e

detected at the ti me the Intel l i gence Server C onfi gurati on Edi tor
opens. Sel ect the correspondi ng check box to confi gure the
system to l oad a proj ect on a node. A sel ected box at the
i ntersecti on of a proj ect row and a node col umn si gni fi es that the
proj ect i s to be l oaded at startup on that node.

If no check boxes are sel ected for a proj ect, the proj ect i s not
l oaded on any node at startup. Li kew i se, i f no check boxes are
sel ected for a node, no proj ects are l oaded on that node at
startup.

If y ou are us ing s ingle ins tanc e s es s ion logging with Enterpris e

Manager, the s ingle ins tanc e s es s ion logging projec t mus t be
loaded onto all the c lus tered Intelligenc e Serv ers at s tartup.
Failure to load this projec t on all s erv ers at s tartup res ults in a los s
of s es s ion s tatis tic s for any Intelligenc e Serv er onto whic h the
projec t is not loaded at s tartup. For s teps on implementing s ingle
ins tanc e s es s ion logging, s ee the Enterpri se Manager Gui de .
For more information about this is s ue, s ee Mic roStrategy Tec h
Note TN14591.

or

If the A ll Servers checkbox i s sel ected for a proj ect, al l nodes i n

the cl uster l oad thi s proj ect at startup. Al l i ndi vi dual node check
boxes are al so sel ected automati cal l y. When you add a new
node to the cl uster, any proj ects set to l oad on Al l Servers
automati cal l y l oad on the new node.

If y ou s elec t a c hec k mark for a projec t to be loaded on ev ery node

but y ou do not s elec t the A ll Servers c hec k box , the s y s tem
loads the projec t on the s elec ted nodes . When a new node is added
to the c lus ter, this projec t is not automatic ally loaded on that new
node.

819 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

3. Sel ect Show selected projects only to di spl ay onl y those

proj ects that have been assi gned to be l oaded on a node. For
di spl ay purposes i t fi l ters out proj ects that are not l oaded on any
node i n the cl uster.

4. Sel ect A pply startup configuration on save to al l ow your

changes to be refl ected i mmedi atel y across the cl uster. If thi s
check box i s cl eared, any changes are saved w hen you cl i ck OK ,
but they do not take effect unti l Intel l i gence Server i s restarted.

5. C l i ck OK .

If you do not see the proj ects you w ant to l oad di spl ayed i n the
Intel l i gence Server C onfi gurati on Edi tor, you must confi gure
Intel l i gence Server to use a server defi ni ti on that poi nts to the
metadata contai ni ng the proj ect. U se the Mi croStrategy C onfi gurati on
Wi zard to confi gure thi s. For detai l s, see the Instal l ati on and
C onfi gurati on Gui de.

It is pos s ible that not all projec ts in the metadata are regis tered and
lis ted in the s erv er definition when the Intelligenc e Serv er Configuration
Editor opens . This c an oc c ur if a projec t is c reated or duplic ated in a
two-tier (direc t c onnec tion) projec t s ourc e that points to the s ame
metadata as that being us ed by Intelligenc e Serv er while it is running.
Creating, duplic ating, or deleting a projec t in two-tier while a s erv er is
s tarted agains t the s ame metadata is not rec ommended.

Reserving Nodes with Work Fences

Wi thi n a cl uster, w ork fences al l ow an admi ni strator to reserve
speci fi c nodes for use by certai n users or w orkl oads duri ng normal
operati on. There are tw o types of fences:

l U ser Fence: used to process requests from a l i st of speci fi ed users

or user groups. U ser fences can be further l i mi ted by speci fyi ng
appl i cabl e proj ects.

© 2019, M icr o St r at egy In c. 820

Syst em Ad m in ist r at io n Gu id e

l Workload Fence: used to run subscri pti ons tri ggered by an event or
ti me-based schedul e for speci fi ed proj ects. N ote that on-demand
event subscri pti ons such as run i mmedi atel y, previ ew , or personal
vi ew are not i ncl uded. For more i nformati on on subscri pti ons, see
Schedul i ng R eports and D ocuments: Subscri pti ons, page 988.

For exampl e, a user fence coul d be confi gured for users w ho requi re
more processi ng pow er or hi gh avai l abi l i ty. C onversel y, a w orkl oad
fence, coul d be confi gured to l i mi t the resources for l ow er pri ori ty
subscri pti ons.

Typi cal l y, the maj ori ty of the nodes i n a cl uster w i l l not be part of a
fence, maki ng them avai l abl e for general use. Al l confi gured fences
are defi ned i n a si ngl e l i st ordered by precedence. When a request i s
recei ved, the ordered l i st of al l fences and thei r confi gurati ons are
assessed to determi ne i f the request matches any fence confi gurati on.
A request w i l l be processed by the fi rst fence found w i th an avai l abl e
node i n the ordered l i st w here the request matches the fence cri teri a.

When all nodes in the c lus ter are part of the fenc e lis t, the reques t will be
s ent to a node in the las t fenc e in the ordered lis t.

Fenc ing is not s upported with legac y c lients whic h inc ludes
Mic roStrategy Dev eloper and adminis tration tools s uc h as Command
Manager.

C onsi der the fol l ow i ng fi gure w hi ch show s a cl ustered i mpl ementati on

w i th ei ght nodes:

821 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l N odes 7 and 8 are

defi ned i n the "C XO"
user fence, meani ng
that these nodes are
reserved for
requests from users
i n the C XO group.

l N odes 5 and 6 are

defi ned i n the
"D i stSvcs" w orkl oad
fence, meani ng that these nodes are reserved for processi ng
subscri pti ons that are not on-demand events.

l N odes 1, 2, 3, and 4 are not defi ned i n a fence, meani ng that they
are avai l abl e to process requests that do not meet the cri teri a of
ei ther fence.

Usin g Fen ces wit h Asymmet r ic Pr o ject Clu st er in g

When user fences are confi gured w i th a cl uster that has proj ects that
are onl y l oaded on speci fi c nodes, users are al w ays sent to a node
that supports the proj ect. The fi rst fence found i n the pri ori ty l i st that
i ncl udes a node w here the requested proj ect i s l oaded w i l l be used.
For more i nformati on about asymmetri c proj ect cl usteri ng, see
D i stri buti ng Proj ects Across N odes i n a C l uster, page 818.

Co n f igu r in g Fen ces

U si ng C ommand Manager, you can create, modi fy, l i st, and del ete
fences w i thout restarti ng the cl ustered Intel l i gence Servers. For more
i nformati on about C ommand Manager, see C hapter 15, Automati ng
Admi ni strati ve Tasks w i th C ommand Manager.

© 2019, M icr o St r at egy In c. 822

Syst em Ad m in ist r at io n Gu id e

l You hav e properly c onfigured an Intelligenc e Serv er c lus ter and all nodes
in the c lus ter mus t us e the s ame s erv er definition.

l You c an log in to Command Manager as a us er that has the

Ds sP ri vi l e g e s C o nf i g u r e S e r v e r B a si c priv ilege, whic h is a
default priv ilege for the Serv er Res ourc e Settings Adminis trators group.

To Configure Fences

Scri pt outl i nes are provi ded i n C ommand Manager to assi st w i th

confi guri ng fences i n the Fence_Outlines fol der. For more
i nformati on about these commands, see the C ommand Manager H el p.

To Enable User Fencing in MicroStrategy Web

After your fences have been confi gured, you w i l l need to enabl e
Mi croStrategy Web to use user fences. The setti ng i s off by defaul t.

1. On the Web Admi ni strati on page open Other C onfiguration.

2. U nder Fenci ng sel ect the Enable Fencing checkbox.

3. C l i ck Save.

Managing Your Clustered System

Once your cl ustered system i s up and runni ng, you can moni tor and
confi gure the proj ects that are runni ng on each node of the cl uster.

l Managi ng your Proj ects Across N odes of a C l uster, page 824

l Proj ect Fai l over and Latency, page 826

823 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Shutti ng D ow n a N ode, page 829

l Mai ntai ni ng R esul t C aches and H i story Li sts i n a C l ustered

Envi ronment, page 831

Managing your Projects Across Nodes of a Cluster

Managi ng a proj ect across al l nodes of a cl uster can be done through
the Proj ect vi ew of the System Admi ni strati on moni tor. From thi s vi ew ,
you can unl oad or i dl e a proj ect duri ng System Admi ni strati on on
Intel l i gence Server. H ow ever, someti mes you need to perform
mai ntenance on onl y one node of the cl uster. In thi s case, you can
use the C l uster vi ew to i dl e or unl oad a proj ect from that node, w hi l e
l eavi ng the proj ect runni ng on the other nodes of the cl uster.

For detai l ed i nformati on about the effects of the vari ous i dl e states on
a proj ect, see Setti ng the Status of a Proj ect, page 51.

To Manage the Projects and Nodes in a Cluster

1. In D evel oper, l og i n to a proj ect source. You must l og i n as a

user w i th the Admi ni ster C l uster pri vi l ege.

2. Expand A dministration, then expand System A dministration,

and then sel ect C luster.

3. To see a l i st of al l the proj ects on a node, cl i ck the + si gn next to

that node.

You c an perform an ac tion on multiple s erv ers or projec ts at the s ame

time. To do this , s elec t s ev eral projec ts ( C TR L +c lic k ), then right-c lic k
and s elec t one of the options .

© 2019, M icr o St r at egy In c. 824

Syst em Ad m in ist r at io n Gu id e

To Idle or Resume a Project on a Node

1. In the C l uster vi ew , ri ght-cl i ck the proj ect w hose status you w ant
to change, poi nt to A dminister project on node, and sel ect
Idle/R esume.

2. Sel ect the opti ons for the i dl e mode that you w ant to set the
proj ect to:

l R equest Idl e (R equest Idle): al l executi ng and queued j obs

fi ni sh executi ng, and any new l y submi tted j obs are rej ected.

l Executi on Idl e (Execution Idle for A ll Jobs): al l executi ng,

queued, and new l y submi tted j obs are pl aced i n the queue, to
be executed w hen the proj ect resumes.

l Warehouse Executi on Idl e (Execution Idle for Warehouse

jobs): al l executi ng, queued, and new l y submi tted j obs that
requi re SQL to be submi tted to the data w arehouse are pl aced
i n the queue, to be executed w hen the proj ect resumes. Any
j obs that do not requi re SQL to be executed agai nst the data
w arehouse are executed.

825 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Ful l Idl e (R equest Idle and Execution Idle for A ll jobs): al l

executi ng and queued j obs are cancel ed, and any new l y
submi tted j obs are rej ected.

l Parti al Idl e (R equest Idle and Execution Idle for Warehouse

jobs): al l executi ng and queued j obs that do not submi t SQL
agai nst the data w arehouse are cancel ed, and any new l y
submi tted j obs are rej ected. Any executi ng and queued j obs
that do not requi re SQL to be executed agai nst the data
w arehouse are executed.

To res ume the projec t from a prev ious ly idled s tate, c lear the
R equest Idle and Execution Idle c hec k box es .

3. C l i ck OK .

To Load or Unload a Project from a Specific Node

In the C l uster vi ew , ri ght-cl i ck the proj ect w hose status you w ant to
change, poi nt to A dminister project on node, and sel ect Load or
U nload.

Project Failover and Latency

Proj ect fai l over support i n a cl uster i s si mi l ar to system fai l over
support. For exampl e, one server i n a cl uster i s hosti ng proj ect A and
another server i n the cl uster i s runni ng proj ects B and C . If the fi rst
server becomes unavai l abl e, the other can begi n runni ng al l three
proj ects. Proj ect fai l over support ensures that proj ects remai n
avai l abl e even i f hardw are or an appl i cati on fai l s.

Proj ect fai l over i s tri ggered w hen the number of nodes runni ng a
proj ect reaches zero due to node fai l ure. At that poi nt, the system
automati cal l y l oads any proj ects that w ere on the fai l ed system onto
another server i n the cl uster to mai ntai n the avai l abi l i ty of those
proj ects. Once the fai l ed server recovers, the system rel oads the

© 2019, M icr o St r at egy In c. 826

Syst em Ad m in ist r at io n Gu id e

ori gi nal proj ect onto the recovered server. It al so removes the proj ect
from the server that had temporari l y taken over.

Fai l over and l atency take effect onl y w hen a server fai l s. If a server i s
manual l y shut dow n, i ts proj ects are not automati cal l y transferred to
another server, and are not automati cal l y transferred back to that
server w hen i t restarts.

You can determi ne several setti ngs that control the ti me del ay, or
l atency peri od, i n the fol l ow i ng i nstances:

l After a machi ne fai l s, but before i ts proj ects are l oaded onto to a
di fferent machi ne

l After the fai l ed machi ne i s recovered, but before i ts ori gi nal proj ects
are rel oaded

To Set Project Failover Latency

1. In D evel oper, from the A dministration menu, sel ect Server, then
sel ect C onfigure MicroStrategy Intelligence Server.

2. Expand the Server D efinition category, then sel ect A dvanced.

3. Enter the Project Failover Latency and C onfiguration

R ecovery Latency, and cl i ck OK .

When deci di ng on these l atency peri od setti ngs, consi der how l ong i t
takes an average proj ect i n your envi ronment to l oad on a machi ne. If
your proj ects are l arge, they may take some ti me to l oad, w hi ch
presents a strai n on your system resources. Wi th thi s consi derati on i n
mi nd, use the fol l ow i ng i nformati on to deci de on a l atency peri od.

Pr o ject Failo ver Lat en cy

You can control the ti me del ay (l atency) before the proj ect on a fai l ed
machi ne i s l oaded on another node to mai ntai n a mi ni mum l evel of

827 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

avai l abi l i ty.

Latenc y tak es effec t only when a s erv er fails . If a s erv er is manually

s hut down, its projec ts are not automatic ally trans ferred to another
mac hine.

C onsi der the fol l ow i ng i nformati on w hen setti ng a l atency peri od:

l Setti ng a hi gher l atency peri od prevents proj ects on the fai l ed

server from bei ng l oaded onto other servers qui ckl y. Thi s can be a
good i dea i f your proj ects are l arge and you trust that your fai l ed
server w i l l recover qui ckl y. A hi gh l atency peri od provi des the fai l ed
server more ti me to come back onl i ne before i ts proj ects need to be
l oaded on another server.

l Setti ng a l ow er l atency peri od causes proj ects from the fai l ed

machi ne to be l oaded rel ati vel y qui ckl y onto another server. Thi s i s
good i f i t i s cruci al that your proj ects are avai l abl e to users at al l
ti mes.

l D i sabl i ng the l atency peri od or the fai l over process:

l If you enter 0 (zero), there i s no l atency peri od and thus there i s

no del ay; the proj ect fai l over process begi ns i mmedi atel y.

l If you enter -1, the fai l over process i s di sabl ed and proj ects are
not transferred to another node i f there i s a machi ne fai l ure.

Co n f igu r at io n Reco ver y Lat en cy

When the condi ti ons that caused the proj ect fai l over di sappear, the
system automati cal l y reverts to the ori gi nal proj ect di stri buti on
confi gurati on by removi ng the proj ect from the surrogate server and
l oadi ng the proj ect back onto the recovered server (the proj ect's
ori gi nal server).

C onsi der the fol l ow i ng i nformati on w hen setti ng a l atency peri od:

© 2019, M icr o St r at egy In c. 828

Syst em Ad m in ist r at io n Gu id e

l Setti ng a hi gher l atency peri od l eaves proj ects on the surrogate

server l onger. Thi s i s good i dea i f your proj ects are l arge and you
w ant to be sure your recovered server stays onl i ne for a speci fi c
peri od before the proj ect l oad process begi ns. A hi gh l atency peri od
provi des the recovered server more ti me after i t comes back onl i ne
before i ts proj ects are rel oaded.

l Setti ng a l ow er l atency peri od causes proj ects on the surrogate

machi ne to be removed and l oaded rel ati vel y qui ckl y onto the
recovered server. Thi s i s desi rabl e i f you w ant to reduce the strai n
on the surrogate server as soon as possi bl e.

You can al so di sabl e the l atency peri od:

l If you enter a 0 (zero), there i s no l atency peri od and thus there i s

no del ay. The confi gurati on recovery process begi ns i mmedi atel y.

l If you enter a -1, the confi gurati on recovery process i s di sabl ed and
proj ects are never automati cal l y rel oaded onto the recovered
server.

Shutting Down a Node

A node can be shut dow n i n tw o w ays:

l A dministrative shutdown: Thi s i ncl udes i nstances w hen a node i s

removed from a cl uster or the Intel l i gence Server servi ce i s
stopped.

l N ode failure: Thi s i ncl udes i nstances such as a pow er fai l ure or a
softw are error; thi s i s someti mes cal l ed a forceful shutdow n.
Forceful l y shutdow n nodes retai n thei r val i d caches i f they are
avai l abl e. H ow ever, w hi l e the node i s shut dow n, there i s no w ay to
moni tor the caches, change thei r status, or i nval i date them. They
can be del eted by manual l y del eti ng the cache fi l es on the l ocal
node or by del eti ng the appropri ate cache fi l es on a shared netw ork
l ocati on. Be aw are that cache fi l es are named w i th obj ect ID s.

The resul ts of each of these types of shutdow n are di scussed bel ow .

829 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Reso u r ce Availab ilit y

If a node i s rendered unavai l abl e because of a forceful shutdow n, i ts
cache resources are sti l l val i d to other nodes i n the cl uster and are
accessed i f they are avai l abl e. If they are not avai l abl e, new caches
are created on other nodes.

In an admi ni strati ve shutdow n, caches associ ated w i th the shut dow n

node are no l onger val i d for other nodes, even i f they are physi cal l y
avai l abl e, such as on a fi l e server.

Clien t Co n n ect io n St at u s

Developer

C l i ent connecti ons that are not cl uster-aw are, such as D evel oper, do
not experi ence any change i f a node i s removed from a cl uster.
H ow ever, the l ocal node must regenerate i ts ow n caches rather than
accessi ng the resources of other nodes. If Intel l i gence Server i s shut
dow n, any D evel oper cl i ents connected to that Intel l i gence Server
recei ve an error message noti fyi ng them of the l ost connecti on,
regardl ess of w hether that Intel l i gence Server w as i n a cl uster.

MicroStrategy Web

If a cl uster node shuts dow n w hi l e Mi croStrategy Web users are

connected, those j obs return an error message by defaul t. The error
message offers the opti on to resubmi t the j ob, i n w hi ch case
Mi croStrategy Web automati cal l y reconnects the user to another
node.

Cus tomiz ations to Mic roStrategy Web c an alter this default behav ior in
s ev eral way s .

© 2019, M icr o St r at egy In c. 830

Syst em Ad m in ist r at io n Gu id e

If a node i s removed from the cl uster, al l exi sti ng connecti ons

conti nue to functi on and remai n connected to that machi ne, al though
the machi ne no l onger has access to the cl ustered nodes' resources.
Future connecti ons from Mi croStrategy Web w i l l be to val i d cl uster
nodes.

St at u s Af t er Reb o o t
If a node goes dow n for any reason, al l j obs on that node are
termi nated. R estarti ng the node provi des an empty l i st of j obs i n the
j ob queue.

If a node i s forceful l y shut dow n i n a Wi ndow s envi ronment, i t

automati cal l y rej oi ns the cl uster w hen i t comes back up.

If multiple nodes in the c lus ter are res tarted at the s ame time, they may
not all c orrec tly rejoin the c lus ter. To prev ent this , s eparate the res tart
times by s ev eral minutes .

The nodes that are sti l l i n the cl uster but not avai l abl e are l i sted i n
the C l uster Moni tor w i th a status of Stopped.

Maintaining Result Caches and History Lists in a

Clustered Environment
Proper mai ntenance of resul t caches and H i story Li sts i s i mportant i n
any Mi croStrategy system. For detai l ed i nformati on on caches and
cache management, i ncl udi ng recommended best practi ces, see
R esul t C aches, page 860. For detai l ed i nformati on on H i story Li sts,
i ncl udi ng best practi ces, see Savi ng R eport R esul ts: H i story Li st,
page 897.

When mai ntai ni ng resul t caches and H i story Li sts i n a cl ustered

envi ronment, be aw are of the fol l ow i ng:

831 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l You can manage the caches on a node onl y i f that node i s acti ve
and j oi ned to the cl uster and i f the proj ect contai ni ng the caches i s
l oaded on that node.

l Whenever a cache on one node of the cl uster i s created or updated,

any copi es of the ol d cache for that report, on the same node or on
other nodes, are automati cal l y i nval i dated. Thi s means that onl y
one val i d copy of a cache exi sts at any ti me for a report on al l
nodes i n the cl uster. For more i nformati on about i nval i dati ng
caches, see Managi ng R esul t C aches, page 878.

l The C ache Moni tor's hi t count number on a machi ne refl ects onl y
the number of cache hi ts that machi ne i ni ti ated on any cache i n the
cl uster. If a di fferent machi ne i n the cl uster hi ts a cache on the l ocal
machi ne, that hi t i s not be counted on the l ocal machi ne's hi t count.
For more i nformati on about the C ache Moni tor, see Moni tori ng
R esul t C aches, page 873.

For exampl e, ServerA and ServerB are cl ustered, and the cl uster i s
confi gured to use l ocal cachi ng (see Synchroni zi ng C ached
Informati on across N odes i n a C l uster, page 792). A report i s
executed on ServerA, creati ng a cache there. When the report i s
executed on ServerB, i t hi ts the report cache on ServerA. The cache
moni tor on ServerA does not record thi s cache hi t, because
ServerA's cache moni tor di spl ays acti vi ty i ni ti ated by ServerA onl y.

l To ensure that H i story Li st messages are synchroni zed correctl y

betw een nodes and to reduce system overhead, ei ther enabl e user
affi ni ty cl usteri ng or set the cache backup frequency to 0 (zero). For
a di scussi on of these setti ngs, i ncl udi ng i nstructi ons, see
C onfi guri ng C aches i n a C l uster, page 803.

Main t ain in g Hist o r y List s in a Clu st er ed En vir o n men t

U ser affi ni ty cl usteri ng causes Intel l i gence Server to connect al l
sessi ons for a user to the same node of the cl uster. Thi s enabl es

© 2019, M icr o St r at egy In c. 832

Syst em Ad m in ist r at io n Gu id e

Intel l i gence Server to keep the user's H i story Li st on one node of the
cl uster. R esource use i s mi ni mi zed because the H i story Li st i s not
stored on mul ti pl e machi nes, and the H i story Li st i s never out of sync
across mul ti pl e nodes of the cl uster.

Mi croStrategy recommends that you enabl e user affi ni ty cl usteri ng i n

any cl ustered system. If you are not usi ng user affi ni ty cl usteri ng,
Mi croStrategy recommends that you set the cache backup frequency
to 0 (zero) to ensure that H i story Li st messages are synchroni zed
correctl y among nodes. For more i nformati on about thi s setti ng, see
C onfi guri ng R esul t C ache Setti ngs, page 884.

To Configure the History List Governing Settings for a Clustered

Environment

1. In D evel oper, l og i n to a proj ect source. You must l og i n as a

user w i th admi ni strati ve pri vi l eges.

2. From the A dministration menu, poi nt to Server and then sel ect
C onfigure MicroStrategy Intelligence Server.

3. Expand the Server D efinition category, and then sel ect

A dvanced.

4. D o one of the fol l ow i ng:

l To enabl e user affi ni ty cl usteri ng, sel ect the U ser A ffinity
C luster check box.

l OR , i f you do not w ant to enabl e user affi ni ty cl usteri ng, then i n

the B ackup frequency (minutes) fi el d, type 0 (zero).

5. C l i ck OK .

6. R estart Intel l i gence Server.

MicroStrategy Messaging Services

833 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Messagi ng Servi ces i s a component that i s coupl ed w i th the

Intel l i gence Server duri ng i nstal l ati ons and upgrades. Messagi ng
Servi ces i s confi gured out-of-the-box and runs automati cal l y after
the i nstal l ati on i s compl eted.

After i nstal l ati on, you can see the fol l ow i ng servi ces are
automati cal l y started:

l A pache K afka (C : \ P r o g r a m F i l e s
(x 86 )\ Mi c r o S t r at e g y \ M e s s a g i n g
Se rv ic es \ K a f k a \k a f k a _2 . 1 1 -0 . 1 0 . 1 . 0)

l A pache ZooK eeper (C : \ P r o g r a m F i l es

(x 86 )\ Mi c r o S t r at e g y \ M e s s a g i n g
Se rv ic es \ K a f k a \k a f k a _2 . 1 1 -0 . 1 0 . 1 . 0)

l MicroStrategy Intelligence Server Log C onsumer

(C :\ Pr og r a m F i l e s
(x 86 )\ Mi c r o S t r at e g y \ I n t e l l i g e n ce
Se rv er \K a f k a C o ns u m e r)

By defaul t Mi croStrategy w i l l sti l l send Intel l i gence Server

di agnosti c l ogs to l ocal di sk. D i agnosti c l ogs w i l l be sent to the
Messagi ng Servi ces Server after you perform the fol l ow i ng:

l Enabl e Mi croStrategy Messagi ng Servi ces

l Turn On the Sendi ng Log to Messagi ng Servi ces Feature

Afterw ards you w i l l see Kafka l og fi l es created i n the Kafka

i nstal l ati on fol der:

C: \P ro gr a m F i l e s ( x 8 6 ) \ M i c r o S t r a t e g y \ M e s s a g i n g
Se rv ic es \ t m p \ k a f k a -l o g s

D i fferent Kafka topi cs w i l l be created to store data for di fferent

Mi croStrategy components.

© 2019, M icr o St r at egy In c. 834

Syst em Ad m in ist r at io n Gu id e

Conf i gur i ng M essagi ng Ser vi ces af t er up gr ad i ng

By default, Mic roStrategy Mes s aging Serv ic es are ins talled along
with the Intelligenc e s erv er upgrade.

Onc e y ou hav e c ompleted the upgrade proc es s , y ou need to enable

Mic roStrategy Mes s aging Serv ic es . If not, the Intelligenc e Serv er
c ontinues to write to the original log.

Messagin g Ser vices Wo r kf lo w f o r In t elligen ce Ser ver

l Intel l i gence Server i s the Kafka Producer and can be depl oyed
a si ngl e node or cl uster.

l Kafka Server can be depl oyed as a si ngl e node or cl uster.

l Intel l i gence Server Log C onsumer can run on any machi ne that
can be connected to a Kafka Server.

En ab le Micr o St r at egy Messagin g Ser vices

Messagi ng Servi ces confi gurati on i s saved i n the Mi croStrategy
Intel l i gence Server confi gurati on. It can be enabl ed or di sabl ed on
the fl y, w i thout restarti ng your Intel l i gence Server.

835 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Command Manager Scripts for Messaging Services

To check i f Messagi ng Servi ces i s enabl ed, execute:

LI ST AL L P R O P E R T IE S F O R S E R V E R C O N F I G U R A T I O N ;

To enabl e Messagi ng Servi ces through C ommand Manager,

execute:

AL TE R S ER V E R C O N F I G U R A T I O N
EN AB LE ME S S A G I N G S E R V I C E S T R U E
CO NF IG UR E M E S S A G I N G S E R V I C E S
"b oo ts tr a p . s e r v e r s : 1 0 . 1 5 . 2 0 8 . 2 3 6 : 9 0 9 2 / b a t c h . n u m .
me ss ag es : 5 0 0 0 / q u e u e . b u f f e r i n g . m a x . m s : 2 0 0 0 " ;

In the ex ample abov e s et:

l bo ot s t r a p . s e r v e r s : to y our Kafk a Serv er IP addres s and

port number.

l ba tc h . n u m . m e s s a g e s : to the number of mes s ages to s end in

one batc h when us ing as y nc hronous mode.

l qu eu e . b u f f e r i n g . m a x . m s : to the max imum time to buffer

data when us ing as y nc hronous mode.

You c an s pec ify more Kafk a Produc er c onfiguration s ettings in this

c ommand following the s ame format.

Tu r n On t h e Sen d in g Lo g t o Messagin g Ser vices Feat u r e

You can turn on the Sendi ng Log to Messagi ng Servi ces feature
usi ng ei ther Mi croStrategy Web or C ommand Manager.

© 2019, M icr o St r at egy In c. 836

Syst em Ad m in ist r at io n Gu id e

From MicroStrategy Web

1. Log i n usi ng and Admi ni strator account.

2. Open U ser Preferences > Project D efaults.

3. Locate Sending Log to Messaging Services i n the Features

for C ustomer Feedback secti on.

4. Sel ect On from the drop-dow n menu.

5. C l i ck A pply.

From Command Manager

1. C onnect to your proj ect source.

2. Execute the fol l ow i ng:

AL TE R F E A T U R E F L A G " S E N D I N G L O G T O M E S S A G I N G
SE RV IC E S " O N ;

Mo d if yin g Messagin g Ser vices Co n f igu r at io n

Apache Kafka Server

The Kafka Server can be confi gured by modi fyi ng the

se rv er .p r o p e r t i e s fi l e found i n:

C: \P ro gr a m F i l e s ( x 8 6 ) \ M i c r o S t r a t e g y \ M e s s a g i n g
Se rv ic es \ K a f k a \ k a f k a _2 . 1 1 -0 . 1 0 . 1 . 0 \ c o n f i g

Both Apac he Kafk a Serv er and ZooKeeper s hould be res tarted after
modify ing the abov e c onfiguration file.

837 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Intelligence Server Log Consumer

By defaul t the Log C onsumer i s connecti ng to the Local Kafka

Server.

There are tw o w ays to modi fy the confi gurati on of Log C onsumer:

1. D el ete L o g C o n s u m e r . p r o p e r t i e s and execute the

fol l ow i ng command and fol l ow the steps i n the command l i ne:

C: \P ro g r a m F i l e s
(x 86 )\ M i c r o S t r a t e g y \ I n t e l l i g e n c e
Se rv er \ K a f k a C o n s u m e r > j a v a -j a r
Ka fk aC o n s u m e r . j a r

2. Modi fy fi l e C : \ P r o g r a m F i l e s
(x 86 )\ M i c r o S t r a t e g y \ I n t e l l i g e n c e
Se rv er \ K a f k a C o n s u m e r \ L o g C o n s u m e r . p r o p e r t i e s
di rectl y.

The defaul t val ues after i nstal l ati on are:

fo ld e r _p a t h=C : \ \ P r o g r a m F i l es ( x 8 6 ) \ \ C o m m o n
Fi le s \ \ M i c r o S t r a t e g y \ \ L o g \ \ D S S E r r o r s #
in di c a t e l o g f i l e l o c a t i o n

is _ s i l e n t _m o d e= t r u e # i n d i c a t e r u n c o n s u m e r
in s i l e n t m o d e

br ok e r _p o r t=9 0 9 2 # K a f k a S e r v e r p o r t n u m b e r

br ok e r _h o s t n a m e=1 2 7 . 0 . 0 . 1 # K a f k a S e r v e r I P

po ll _ t i m e _o u t=1 0 0 0 # c o n s u m e r c o n n e c t i o n
ti me o u t l i m it i n s e c o n d s

ma x_ f i l e _s i z e_M =2 0 # m a x l o g f i l e s i z e i n MB

ma x_ n u m _b a k=1 # n u m b e r o f b a c k u p f i l e s

© 2019, M icr o St r at egy In c. 838

Syst em Ad m in ist r at io n Gu id e

Micr o St r at egy Messagin g Ser vices Co n f igu r at io n f o r

Clu st er ed En vir o n men t s
If you have cl ustered your Intel l i gence Servers and w ant to use a
separate machi ne to run Mi croStrategy Messagi ng Servi ces after
upgradi ng, compl ete the fol l ow i ng steps for each node i n the
cl uster.

The minimum number of nodes for a c lus ter is 3 .

Eac h node mus t hav e the following ins talled:

l Mic roStrategy Mes s aging Serv ic es

l Apac he Kafk a

l Apac he Zook eeper

Configure Zookeeper

1. Brow se to fol der C : \ P r o g r a m F i l e s

(x 86 )\ M i c r o S t r a t e g y \ M e s s a g i n g
Se rv ic e s \ K a f k a \ k a f k a _2 . 1 1 -0 . 1 0 . 1 . 0 \ c o n f i g.

2. Edi t fi l e z o o k e e p e r . p r o p e r t i e s by addi ng fol l ow i ng

l i nes:

cl ie n t P o r t= 2 1 8 1

da ta D i r= C : \ \ P r o g r a m F i l e s
(x 86 ) \ \ M i c r o S t r a t e g y \ \ M e s s a g i n g
Se rv i c e s \ \ t m p \ \ z o o k e e p e r

ma xC l i e n t C n x n s= 0

in it L i m i t=5

sy nc L i m i t=2

839 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

se rv e r . 1= 1 0 . 27 . 2 0 . 1 6 : 2 8 8 8 : 3 88 8

se rv e r . 2= 1 0 . 27 . 2 0 . 6 0 : 2 8 8 8 : 3 88 8

se rv e r . 3= 1 0 . 15 . 2 0 8 . 2 3 6 : 2 8 8 8 :3 8 8 8

Eac h s erv er parameter mus t c ontain a unique integer identifier

as s hown abov e. You attribute the s erv er id to eac h mac hine
by c reating a tex t file named m y i d , one for eac h s erv er, whic h
res ides in that s erv er's data direc tory , as s pec ified by the
c onfiguration file parameter d a t a D i r = C : \ P r o g r a m
Fi l e s ( x 8 6 ) \ M i c r o S t r a t e g y \ M e s s a g i n g
Se r v i c e s \ t m p \ z o o k e e p e r

3. Go to fol der C : \ P r o g r a m F i l e s
(x 86 )\ M i c r o S t r a t e g y \ M e s s a g i n g S e r v i c e s \ K a f k a \k
af ka _ 2 . 1 1 -0 . 9 . 0 . 1 \ c o n f i g \ z o o k e e p e r.

4. C reate a text fi l e named m y i d contai ni ng the i denti fyi ng

val ue from the server parameter name i n the
zo ok ee p e r . p r o p e r t i e s fi l e.

Configure Kafka

1. Brow se to fol der C : \ P r o g r a m F i l e s

(x 86 )\ M i c r o S t r a t e g y \ M e s s a g i n g
Se rv ic e s \ K a f k a \ k a f k a _2 . 1 1 -0 . 1 0 . 1 . 0 \ c o n f i g.

2. Edi t fi l e s e r v e r . p r o p e r t i e s, add a row

zo ok ee p e r . c o n n e c t = 1 0 . 2 7 . 2 0 . 1 6 : 2 1 8 1 , 1 0 . 2 7 . 2 0 .6
0: 21 81 , 1 0 . 1 5 . 2 0 8 . 2 3 6 : 2 1 8 1 to the Zookeeper secti on.

## ## # # # # # # # # # # # # # # # # # # # # # # # # # Z o o k e e p e r
## ## # # # # # # # # # # # # # # # # # # # # # # # # #

© 2019, M icr o St r at egy In c. 840

Syst em Ad m in ist r at io n Gu id e

# Zo o k e e p e r c o n n e c t i o n s t r i n g ( s e e z o o k e e p e r
do cs f o r d e t ai l s ) .

# Th i s i s a c o m m a s e p a r a t e d h o s t : p o r t p a i r s ,
ea ch c o r r e s p o n d i n g t o a z k

# se r v e r . e . g .
"1 27 . 0 . 0 . 1 : 3 0 0 0 , 1 2 7 . 0 . 0 . 1 : 3 0 0 1 , 1 2 7 . 0 . 0 . 1 : 3 0 0
2" .

# Yo u c a n a l s o a p p e n d a n o p t i o n a l c h r o o t
st ri n g t o t h e u r l s t o s p e c i f y t h e

# ro o t d i r e c t o r y f o r a l l k a f k a z n o d e s .

# zo o k e e p e r . c o n n e c t = l o c a l h o s t : 2 1 8 1

zo ok e e p e r . c o n n e c t=
10 .2 7 . 2 0 . 1 6 : 2 1 8 1 , 1 0 . 2 7 . 2 0 . 6 0 : 2 1 8 1 , 1 0 . 1 5 . 2 0 8 .
23 6: 2 1 8 1

3. Modi fy the b r o k e r . i d val ue to a uni que i nteger from other

Kafka servers (the defaul t val ue i s 0), such as for node
10.27.20.60 w e use number 2.

## ## # # # # # # # # # # # # # # # # # # # # # # # # # S e r v e r B a s i c s
## ## # # # # # # # # # # # # # # # # # # # # # # # # #

# Th e i d o f t h e b r o k e r . T h i s m u s t b e s e t t o
a un i q u e i n t eg e r f o r e a c h b r o k e r .

br ok e r . i d=2

St ar t , St o p , Rest ar t , an d Ch eck St at u s o f Messagin g

Ser vices
On Wi ndow s i nstal l ati ons, open Task Manager > Services to
start, stop, restart, and check the status of Messagi ng Servi ces
components.

841 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Messagi ng Servi ces i s a component that i s coupl ed w i th the

Intel l i gence Server duri ng i nstal l ati ons and upgrades. Messagi ng
Servi ces i s confi gured out-of-the-box and runs automati cal l y after
the i nstal l ati on i s compl eted.

After i nstal l ati on, you can see the fol l ow i ng servi ces are
automati cal l y started:

l A pache K afka (
/o pt /m st r / M i c r oS t r a t e g y / i n s t a l l/ M e s s a g i n g S e r v i c
es /K af ka / k a f k a _2 . 1 1 -0 . 1 0 . 1 . 0)

l A pache ZooK eeper (

/o pt /m st r / M i c r oS t r a t e g y / i n s t a l l/ M e s s a g i n g S e r v i c
es /K af ka / k a f k a _2 . 1 1 -0 . 1 0 . 1 . 0)

l MicroStrategy Intelligence Server Log C onsumer (

/o pt /m st r / M i c r oS t r a t e g y / i n s t a l l/ I n t e l l i g e n c e S e r
ve r/ Ka fk a C o n s u me r)

By defaul t Mi croStrategy w i l l sti l l send Intel l i gence Server

di agnosti c l ogs to l ocal di sk. D i agnosti c l ogs w i l l be sent to the
Messagi ng Servi ces Server after you perform the fol l ow i ng:

l Enabl e Mi croStrategy Messagi ng Servi ces

l Turn On the Sendi ng Log to Messagi ng Servi ces Feature

Afterw ards you w i l l see Kafka l og fi l es created i n the Kafka

i nstal l ati on fol der:

/o pt /m st r / M i c r o S t r a t e g y / i n s t a l l / M e s s a g i n g S e r v i c e
s/ Ka fk a/ t m p / k a f k a -l o g s

D i fferent Kafka topi cs w i l l be created to store data for di fferent

Mi croStrategy components.

© 2019, M icr o St r at egy In c. 842

Syst em Ad m in ist r at io n Gu id e

Conf i gur i ng M essagi ng Ser vi ces af t er up gr ad i ng

By default, Mic roStrategy Mes s aging Serv ic es are ins talled along
with the Intelligenc e s erv er upgrade.

Onc e y ou hav e c ompleted the upgrade proc es s , y ou need to enable

Mic roStrategy Mes s aging Serv ic es . If not, the Intelligenc e Serv er
c ontinues to write to the original log.

Messagin g Ser vices Wo r kf lo w f o r In t elligen ce Ser ver

l Intel l i gence Server i s the Kafka Producer and can be depl oyed
a si ngl e node or cl uster.

l Kafka Server can be depl oyed as a si ngl e node or cl uster.

l Intel l i gence Server l og consumer can run on any machi ne that

can be connected to a Kafka Server.

En ab le Micr o St r at egy Messagin g Ser vices

Messagi ng Servi ces confi gurati on i s saved i n the Mi croStrategy
Intel l i gence Server confi gurati on. It can be enabl ed or di sabl ed on
the fl y, w i thout restarti ng your Intel l i gence Server.

843 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Command Manager Scripts for Messaging Services

To check i f Messagi ng Servi ces i s enabl ed, execute:

LI ST AL L P R O P E R T IE S F O R S E R V E R C O N F I G U R A T I O N ;

To enabl e Messagi ng Servi ces through C ommand Manager,

execute:

AL TE R S ER V E R C O N F I G U R A T I O N
EN AB LE ME S S A G I N G S E R V I C E S T R U E
CO NF IG UR E M E S S A G I N G S E R V I C E S
"b oo ts tr a p . s e r v e r s : 1 0 . 1 5 . 2 0 8 . 2 3 6 : 9 0 9 2 / b a t c h . n u m .
me ss ag es : 5 0 0 0 / q u e u e . b u f f e r i n g . m a x . m s : 2 0 0 0 " ;

In the ex ample abov e s et:

l bo ot s t r a p . s e r v e r s : to y our Kafk a Serv er IP addres s and

port number.

l ba tc h . n u m . m e s s a g e s : to the number of mes s ages to s end in

one batc h when us ing as y nc hronous mode.

l qu eu e . b u f f e r i n g . m a x . m s : to the max imum time to buffer

data when us ing as y nc hronous mode.

You c an s pec ify more Kafk a Produc er c onfiguration s ettings in this

c ommand following the s ame format.

Tu r n On t h e Sen d in g Lo g t o Messagin g Ser vices Feat u r e

You can turn on the Sendi ng Log to Messagi ng Servi ces feature
usi ng ei ther Mi croStrategy Web or C ommand Manager.

© 2019, M icr o St r at egy In c. 844

Syst em Ad m in ist r at io n Gu id e

From MicroStrategy Web

1. Log i n usi ng and Admi ni strator account.

2. Open U ser Preferences > Project D efaults.

3. Locate Sending Log to Messaging Services i n the Features

for C ustomer Feedback secti on.

4. Sel ect On from the drop-dow n menu.

5. C l i ck A pply.

From Command Manager

1. C onnect to your proj ect source.

2. Execute the fol l ow i ng:

AL TE R F E A T U R E F L A G " S E N D I N G L O G T O M E S S A G I N G
SE RV IC E S " O N ;

Mo d if yin g Messagin g Ser vices Co n f igu r at io n

Apache Kafka Server

The Kafka Server can be confi gured by modi fyi ng the

se rv er .p r o p e r t i e s fi l e found i n:

/o pt /m st r / M i c r o S t r a t e g y / i n s t a l l / M e s s a g i n g S e r v i c e
s/ Ka fk a/ k a f k a _2 . 11 -0 . 1 0 . 1 . 0

Both Apac he Kafk a Serv er and ZooKeeper s hould be res tarted after
modify ing the abov e c onfiguration file.

845 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Intelligence Server Log Consumer

By defaul t the Log C onsumer i s connecti ng to the Local Kafka

Server.

There are tw o w ays to modi fy the confi gurati on of Log C onsumer:

1. D el ete the L o g C o n s u m e r . p r o p e r t i e s fi l e from

/o pt /m s t r / M i c r o S t r a t e g y / i n s t a l l / I n t e l l i g e n c eS
er ve r/ K a f k a C o n s u m e r, execute the fol l ow i ng command,
and fol l ow the steps i n the termi nal :

/o pt /m s t r / M i c r o S t r a t e g y / i n s t a l l / I n t e l l i g e n c eS
er ve r/ K a f k a C o n s u m e r j a v a -j a r
Ka fk aC o n s u m e r . j a r

2. Modi fy fi l e
/o pt /m s t r / M i c r o S t r a t e g y / i n s t a l l / I n t e l l i g e n c eS
er ve r/ K a f k a C o n s u m e r / L o g C o n s u m e r . p r o p e r t i e s
di rectl y.

The defaul t val ues after i nstal l ati on are:

ma x_ n u m _b a k=1 # i n d i c a t e t h e n u m b e r o f b a c k
up f i l e s

ma x_ f i l e _s i z e_M =2 0 # i n d i c a t e t h e m a x i m u m
fi le s i z e i n M B

br ok e r _p o r t=9 0 9 2 # K a f k a S e r ve r p o r t n u m b e r

is _ s i l e n t _m o d e= t r u e # i n d i c a t e r u n c o n s u m e r
in s l i e n t m o d e

fo ld e r _
pa th = / o p t / m s t r / M i c r o S t r a t e g y / l o g / D S S E r r o r s
#i nd i c a t e l o g f o l d e r l o c a t i o n

br ok e r _h o s t n a m e=1 2 7 . 0 . 0 . 1 # K a f k a S e r v e r I P

© 2019, M icr o St r at egy In c. 846

Syst em Ad m in ist r at io n Gu id e

po ll _ t i m e _o u t=1 0 0 0 # c o n s u m e r c o n n e c t i o n t i m e
ou t l i m i t i n s e c o n d s

Micr o St r at egy Messagin g Ser vices Co n f igu r at io n f o r

Clu st er ed En vir o n men t s
If you have cl ustered your Intel l i gence Servers and w ant to use a
separate machi ne to run Mi croStrategy Messagi ng Servi ces after
upgradi ng, compl ete the fol l ow i ng steps for each node i n the
cl uster.

The minimum number of nodes for a c lus ter is 3 .

Eac h node mus t hav e the following ins talled:

l Mic roStrategy Mes s aging Serv ic es

l Apac he Kafk a

l Apac he Zook eeper

Configure Zookeeper

1. Brow se to fol der

/o pt /m s t r / M i c r o S t r a t e g y / i n s t a l l / M i c r o S t r a t e gy
/M es sa g i n g S e r v i c e s / K a f k a / k a f k a _2 . 1 1 -
0. 9. 0. 1 / c o n f i g.

2. Edi t fi l e z o o k e e p e r . p r o p e r t i e s by addi ng fol l ow i ng

l i nes:

ma xC l i e n t C n x n s= 0

in it L i m i t=5

sy nc L i m i t=2

847 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

se rv e r . 1= 1 0 . 27 . 2 0 . 1 6 : 2 8 8 8 : 3 88 8

se rv e r . 2= 1 0 . 27 . 2 0 . 6 0 : 2 8 8 8 : 3 88 8

se rv e r . 3= 1 0 . 15 . 2 0 8 . 2 3 6 : 2 8 8 8 :3 8 8 8

Eac h s erv er parameter mus t c ontain a unique integer identifier

as s hown abov e.

3. Go to fol der
/o pt /m s t r / M i c r o S t r a t e g y / i n s t a l l / M i c r o S t r a t e gy
/M es sa g i n g S e r v i c e s / K a f k a / k a f k a _2 . 1 1 -
0. 9. 0. 1 / t m p / z o o k e e p e r.

4. C reate a fi l e named m y i d contai ni ng the i denti fyi ng val ue

from the server parameter name i n the
zo ok ee p e r . p r o p e r t i e s fi l e.

Configure Kafka

1. Brow se to fol der

/o pt /m s t r / M i c r o S t r a t e g y / i n s t a l l / M i c r o S t r a t e gy
/M es sa g i n g S e r v i c e s / K a f k a / k a f k a _2 . 1 1 -
0. 9. 0. 1 / c o n f i g.

2. Edi t fi l e s e r v e r . p r o p e r t i e s, add a row

zo ok ee p e r . c o n n e c t = 1 0 . 2 7 . 2 0 . 1 6 : 2 1 8 1 , 1 0 . 2 7 . 2 0 .6
0: 21 81 , 1 0 . 1 5 . 2 0 8 . 2 3 6 : 2 1 8 1 to the Zookeeper secti on.

## ## # # # # # # # # # # # # # # # # # # # # # # # # # Z o o k e e p e r
## ## # # # # # # # # # # # # # # # # # # # # # # # # #

# Zo o k e e p e r c o n n e c t i o n s t r i n g ( s e e z o o k e e p e r
do cs f o r d e t ai l s ) .

# Th i s i s a c o m m a s e p a r a t e d h o s t : p o r t p a i r s ,
ea ch c o r r e s p o n d i n g t o a z k

© 2019, M icr o St r at egy In c. 848

Syst em Ad m in ist r at io n Gu id e

# se r v e r . e . g .
"1 27 . 0 . 0 . 1 : 3 0 0 0 , 1 2 7 . 0 . 0 . 1 : 3 0 0 1 , 1 2 7 . 0 . 0 . 1 : 3 0 0
2" .

# Yo u c a n a l s o a p p e n d a n o p t i o n a l c h r o o t
st ri n g t o t h e u r l s t o s p e c i f y t h e

# ro o t d i r e c t o r y f o r a l l k a f k a z n o d e s .

# zo o k e e p e r . c o n n e c t = l o c a l h o s t : 2 1 8 1

zo ok e e p e r . c o n n e c t=
10 .2 7 . 2 0 . 1 6 : 2 1 8 1 , 1 0 . 2 7 . 2 0 . 6 0 : 2 1 8 1 , 1 0 . 1 5 . 2 0 8 .
23 6: 2 1 8 1

3. Modi fy the b r o k e r . i d val ue to a uni que i nteger from other

Kafka servers (the defaul t val ue i s 0), such as for node
10.27.20.60 w e use number 2.

## ## # # # # # # # # # # # # # # # # # # # # # # # # # S e r v e r B a s i c s
## ## # # # # # # # # # # # # # # # # # # # # # # # # #

# Th e i d o f t h e b r o k e r . T h i s m u s t b e s e t t o
a un i q u e i n t eg e r f o r e a c h b r o k e r .

br ok e r . i d=2

St ar t , St o p , Rest ar t , an d Ch eck St at u s o f Messagin g

Ser vices
Kafka Server and Zookeeper have been regi stered as servi ce on
Li nux, so w e can use servi ce command to start, stop, and check
status. The restart command i s not supported.

To execute a servi ce command for Kafka Server and Zookeeper,

enter: /e tc / i n i t . d / k a f k a -z o o k e e p e r
{s ta rt |s t o p | s t a t u s }.

849 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To execute a servi ce command for Mi croStrategy Intel l i gence

Server Log C onsumer, enter: / e t c / i n i t . d / c o n s u m e r -
is er ve r { s t o p / s t ar t / s t a t u s }.

Connecting MicroStrategy Web to a Cluster

You connect Mi croStrategy Web to a cl uster usi ng Mi croStrategy
Web's Admi ni strati on page. If the Intel l i gence Servers are on the
same subnet as Mi croStrategy Web and are accessi bl e by U ser
D atagram Protocol (U D P), the Mi croStrategy Web Admi ni strati on page
can dynami cal l y l i st the servers by l ooki ng for the l i stener servi ce
runni ng on the machi nes. If the server i s l i sted that you w ant to
connect to, you can connect from thi s page. Al ternati vel y, you can
type the server name.

If the machi ne sel ected i s part of a cl uster, the enti re cl uster appears
on the Admi ni strati on page and i s l abel ed as a si ngl e cl uster. Once
Mi croStrategy Web i s connected to a cl uster, al l nodes reference the
same proj ect. Load bal anci ng di rects new Web connecti ons to the
l east l oaded node, as measured by user connecti ons. Once connected
to a node, the Web user runs al l Mi croStrategy acti vi ty on the same
node.

If nodes are manual l y removed from the cl uster, proj ects are treated
as separate i n Mi croStrategy Web, and the node connected to
depends on w hi ch proj ect i s sel ected. H ow ever, al l proj ects are sti l l
accessi ng the same metadata.

Clustering and Firewalls

C onnecti ng to Intel l i gence Server from Mi croStrategy Web through a
fi rew al l i s the same process regardl ess of the cl uster state. The onl y
di fference i s that al l ow abl e ports, sources, and desti nati ons may be

© 2019, M icr o St r at egy In c. 85 0

Syst em Ad m in ist r at io n Gu id e

avai l abl e betw een Mi croStrategy Web and each of the nodes i n the
cl uster.

Exporting to PDF or Excel in a Clustered Environment

In Mi croStrategy Web, users can export reports to PD F or to Excel for
l ater vi ew i ng. U sers must have the Wri te pri vi l ege for the Inbox fol der
on the Intel l i gence Server machi ne to be abl e to export reports.

To export to PD F or Excel i n a cl ustered envi ronment, users must

have the Wri te pri vi l ege for the C lusterInbox fol der on al l Intel l i gence
Servers i n the cl uster. For i nstructi ons on how to set up the
C lusterInbox fol der, see C onfi guri ng C aches i n a C l uster, page 803.

Node Failure
Mi croStrategy Web users can be automati cal l y connected to another
node w hen a node fai l s. To i mpl ement automati c l oad redi stri buti on
for these users, on the Web Admi ni strator page, under Web Server
sel ect Security, and i n the Logi n area sel ect A llow A utomatic Login
if Session is Lost.

85 1 © 2019, M icr o St r at egy In c.

 10
I M PROVING RESPONSE
TIM E: CACHING

© 2019, M icr o St r at egy In c. 85 2

Syst em Ad m in ist r at io n Gu id e

A cache i s a resul t set that i s stored on a system to i mprove response

ti me i n future requests. Wi th cachi ng, users can retri eve resul ts from
Intel l i gence Server rather than re-executi ng queri es agai nst a
database.

Intel l i gence Server supports the fol l ow i ng types of caches:

l Page caches: When a user vi ew s a publ i shed dossi er the

Intel l i gence Server generates one cache per page, so that the
cache can be hi t w hen the user sw i tches betw een pages.

l R esult caches: R eport and document resul ts that have al ready

been cal cul ated and processed, that are stored on the Intel l i gence
Server machi ne so they can be retri eved more qui ckl y than re-
executi ng the request agai nst the data w arehouse. For more
i nformati on on these, see R esul t C aches, page 860.

Intelligent Cubes c an func tion in a s imilar fas hion to res ult c ac hes :
they allow y ou to s tore data from the data warehous e in Intelligenc e
Serv er memory , rather than in the databas e. Intelligent Cubes are part
of the OLAP Serv ic es add-on to Intelligenc e Serv er. For detailed
information about Intelligent Cubes , s ee the In-memory Anal yti cs
Gui de .

l The H istory List i s a w ay of savi ng report resul ts on a per-user

basi s. For more i nformati on, see Savi ng R eport R esul ts: H i story
Li st, page 897.

l Element caches: Most-recentl y used l ookup tabl e el ements that are

stored i n memory on the Intel l i gence Server or D evel oper machi nes
so they can be retri eved more qui ckl y. For more i nformati on on
these, see El ement C aches, page 920.

l Object caches: Most-recentl y used metadata obj ects that are stored
i n memory on the Intel l i gence Server and D evel oper machi nes so
they can be retri eved more qui ckl y. For more i nformati on on these,
see Obj ect C aches, page 936.

85 3 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

You speci fy setti ngs for al l cache types except Page caches and
H i story Li st under C achi ng i n the Proj ect C onfi gurati on Edi tor. Page
cache setti ngs are confi gured vi a A pplication Properties > D ossier
C ache Management i n Mi croStrategy Workstati on. H i story Li st
setti ngs are speci fi ed i n the Intel l i gence Server C onfi gurati on Edi tor.

R esul t, el ement, and obj ect caches are created and stored for
i ndi vi dual proj ects; they are not shared across proj ects. H i story Li sts
are created and stored for i ndi vi dual users.

To make changes to cache setti ngs, you must have the Admi ni ster
C aches pri vi l ege. In addi ti on, changes to cache setti ngs do not take
effect unti l you stop and restart Intel l i gence Server.

For additional way s to improv e y our Mic roStrategy s y s tem's res pons e
time, s ee C hapter 8, Tuni ng Your System for Best Performance .

Page Caches

Introduction to Page Cache

C onsi deri ng users may sw i tch dossi er pages frequentl y i n Li brary,
page caches have been i ntroduced to i mprove dossi er performance.
Intel l i gence Server generates one cache for each dossi er page, so
that the cache can be hi t w hen the user sw i tches betw een pages. Thi s
di ffers from R esul t C aches, w hi ch records onl y a parti al resul t of the
D ossi er. R esul t caches are generated w hen runni ng a dossi er from
the Mi croStrategy Web i nterface or Mi croStrategy Mobi l e App.

For exampl e, you sw i tch to Page 1 of a mul ti -page dossi er, appl y a
chapter-l evel fi l ter and then save the dossi er. The resul t cache w oul d
onl y record the fi l tered resul ts on Page 1. It doesn't record the resul ts
of other pages, so i f you execute the dossi er agai n, the resul t cache i s
hi t. H ow ever, i f you sw i tch to Page 2, no cache can be hi t because
the resul t cache w on't i ncl ude the Page 2 resul ts.

© 2019, M icr o St r at egy In c. 85 4

Syst em Ad m in ist r at io n Gu id e

For Li brary Web and the Li brary Mobi l e App on Androi d, the page
cache i s i n JSON format, and one page corresponds to one page
cache. For the Li brary Mobi l e App on i OS, the page cache i s i n Bi nary
format, and one page corresponds to tw o page bi nari es - one bi nary
for the page defi ni ti on and another bi nary for the page data.

Types of Page Caches

A base dossi er page cache i s a dossi er shortcut that contai ns:

l N o mani pul ati ons

l Onl y page-sw i tchi ng mani pul ati ons

l A reset dossi er shortcut

A dossi er shortcut page cache contai ns any mani pul ati ons other than
the ones menti oned above.

A bookmark page cache i s generated i f the page caches are

generated for a Bookmark, they are cal l ed .

Page Cache Generation

A page cache i s generated i n the fol l ow i ng cases:

l On-the-fly:

When you run or reset a dossi er shortcut, i f there i s no val i d cache

a page cache w i l l be generated on-the-fl y.

When you sw i tch pages on a dossi er shortcut, a page cache for the
correspondi ng page w i l l be generated on-the-fl y.

If you do any mani pul ati on such as fi l teri ng, sorti ng, or dri l l i ng,
Intel l i gence Server w i l l stop generati ng page caches on-the-fl y.

85 5 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

On-the-fly page c ac he generation ignores the page c ac he gov erning

s ettings . As long as the doc ument c ac hing is enabled, the page
c ac hes will be generated ac c ording to the Library ty pe(Web, iOS,
Android) and will not c ons ider the page s iz e and page number limits .

l When creating or saving a bookmark:

When a bookmark i s created or saved, a page cache of the current

page and several pages before and after the current page w i l l be
generated. By defaul t, at most 10 page caches w i l l be generated for
one Bookmark at a ti me.

l When exiting a dossier shortcut or logging out of Library:

When you exi t a dossi er shortcut or l og out of Li brary, Intel l i gence

Server w i l l generate page caches i f there are no avai l abl e caches
for the page. The cache w i l l be generated accordi ng to the
governi ng setti ngs on Workstati on.

The governi ng setti ngs are onl y avai l abl e w hen the proj ect-l evel
D ocument C achi ng i s enabl ed and are as fol l ow s:

l C ache type: The defaul t setti ng i s to generate a JSON cache for

Web or Androi d, and Bi nary cache for i OS.

l Maximum number of pages: The defaul t setti ng i s 10 pages. If

the current page i s i n the mi ddl e of the D ossi er, the caches for the
current page and the previ ous 4 pages and the fol l ow i ng 5 pages
w i l l be generated. If the current page i s the fi rst page, the fi rst 10
page caches w i l l be generated. If the current page i s the l ast
page, the l ast 10 page caches w i l l be generated.

l Maximum size of a page cache: The defaul t setti ng i s unl i mi ted.

For a JSON cache, i f the si ze exceeds the l i mi t, the cache w i l l not
be generated; for a Bi nary cache, i f the si ze before compressi on

© 2019, M icr o St r at egy In c. 85 6

Syst em Ad m in ist r at io n Gu id e

exceeds the l i mi t, even though the si ze after compressi on doesn't

exceed the l i mi t, the cache w i l l not be generated.

l When closing Library:

If you di rectl y cl ose Li brary, there w i l l be no cl i ent request noti fyi ng

Intel l i gence Server that the page caches shoul d be generated.
H ow ever, consi deri ng cl osi ng Li brary i s a common operati on,
especi al l y for Mobi l e users, Intel l i gence Server w i l l check the
Server message on sessi on ti meout, and generate page caches
accordi ng to the governi ng setti ngs on Workstati on.

l B y scheduling:

C ache schedul i ng i s supported by D i stri buti on Servi ces. You can

create a cache subscri pti on for a base dossi er and speci fy the
U sers and/or U ser Groups.

On tri ggeri ng the cache subscri pti on di fferent caches are generated:

Cach e
Case T yp e
Gen erated

The base dossier is not published t o t he specif ied User or User

None
Group.

B ase
The base dossier is published t o t he specif ied User, but t he User
dossier
hasn't logged in t o Library yet
page caches

B ase
The base dossier is published t o t he specif ied User, and t he User dossier
only swit ches page or reset s Dossier page
caches

The base dossier is published t o t he specif ied User, and t he User Dossier
changes t he base dossier short cut

85 7 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Cach e
Case T yp e
Gen erated

page caches

User 1:
B ase
dossier
page
caches or
Dossier
The base dossier is published t o t he specif ied User Group, and t he short cut
User Group cont ains User1 and User2. A f t er t he B ase Dossier is page
published t o t he User Group, User1 has logged in t o t heir Library, caches
but User2 hasn't logged in t o t heir Library. The cache generat ion f or depending
User1 f ollows Case #3, and t he cache generat ion f or User2 f ollows on changes
Case #2. made.

User 2:
B ase
dossier
page
caches

Cache Priority Queues

The cache manager mai ntai ns tw o l ast recentl y used (LR U ) queues,
one for hi gh-pri ori ty caches and one for l ow -pri ori ty caches.

For Mic roStrategy v ers ions prior to 11.0 c ac he manager maintains only
one LRU queue for the c ac hes . If the c ac he pool bec omes full, the leas t-
rec ently -us ed c ac he would be s wapped out to free memory .

The fol l ow i ng are the pre-defi ned pri ori ty for di fferent caches:

© 2019, M icr o St r at egy In c. 85 8

Syst em Ad m in ist r at io n Gu id e

Cach e T yp e Prio rity Prio rity Valu e

B ase dossier result cache

High DssDocumentPriorityBaseCache = 0
/ page cache

DssDocumentPriorityBookmarkCache
B ookmark page cache High
= 1

S cheduled dossier /
DssDocumentPrioritySchedulerCache
dossier short cut / High
= 2
bookmark cache

Dossier short cut page DssDocumentPriorityShortCutCache

Low
cache = 3

Cache generat ed by DssDocumentPriorityShortCutCache

Low
manual export ing = 3

If a low-priority c ac he is hit by book mark , the priority will be updated

from Low to High.

There i s a soft l i mi t of 20% of the cache pool for l ow -pri ori ty caches.
Thi s i s to avoi d l ow -pri ori ty caches not bei ng generated i f there are
too many hi gh-pri ori ty caches fi l l i ng up the cache pool .

When a new cache i s goi ng to be generated, i f the cache pool i s not

ful l , the cache can be generated successful l y. If the cache pool i s ful l
the cache-sw appi ng l ogi c i s tri ggered. If the l ow -pri ori ty caches
al ready occupy more than 20% of the cache pool they w i l l be del eted
unti l the total l ow -pri ori ty cache si ze i s equal to or bel ow the l i mi t. If
the new cache sti l l needs more memory, the hi gh-pri ori ty caches w i l l
be sw apped out to free up more memory, unti l the new cache can be
generated.

85 9 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Result Caches
A resul t cache i s a cache of an executed report or document that i s
stored on Intel l i gence Server. R esul t caches are ei ther report caches
or document caches.

You c annot c reate or us e res ult c ac hes in a direc t (two-tier)

env ironment. Cac hes are s tored in Intelligenc e Serv er, not retained on
Dev eloper.

R eport caches can be created or used for a proj ect onl y i f the Enable
report server caching check box i s sel ected i n the Proj ect
C onfi gurati on Edi tor under the C aching: R esult C aches: C reation
category.

D ocument caches can be created or used for a proj ect onl y i f the
Enable D ocument Output C aching in Selected Formats check box
i s sel ected i n the Proj ect C onfi gurati on Edi tor under the C aching:
R esult C aches: C reation category, and one or more formats are
sel ected.

Doc ument c ac hes are c reated or us ed only when a doc ument is

ex ec uted in Mic roStrategy Web. Doc ument c ac hes are not c reated or
us ed when a doc ument is ex ec uted from Dev eloper.

By defaul t, resul t cachi ng i s enabl ed at the proj ect l evel . It can al so

be set per report and per document. For exampl e, you can di sabl e
cachi ng at the proj ect l evel , and enabl e cachi ng onl y for speci fi c,
frequentl y used reports. For more i nformati on, see C onfi guri ng R esul t
C ache Setti ngs, page 884.

A resul t cache i s created w hen you do any of the fol l ow i ng:

l In Mi croStrategy Web or D evel oper, execute a saved report or

document contai ni ng onl y stati c obj ects.

© 2019, M icr o St r at egy In c. 860

Syst em Ad m in ist r at io n Gu id e

l In Mi croStrategy Web or D evel oper, execute a saved report or

document contai ni ng one or more prompts. Each uni que set of
prompt sel ecti ons corresponds to a di sti nct cache.

l In Mi croStrategy Web, execute a templ ate and fi l ter combi nati on.

l Execute a report or document based on a schedul e. The schedul e

may be associ ated w i th Mi croStrategy Web, D evel oper, Mobi l e,
D i stri buti on Servi ces, or N arrow cast Server. For more i nformati on
about schedul i ng reports, see Schedul i ng R eports and D ocuments:
Subscri pti ons, page 988.

Cac hing does not apply to a drill report reques t bec aus e the report is
c ons truc ted on the fly .

When a user runs a report (or, from Mi croStrategy Web, a document),

a j ob i s submi tted to Intel l i gence Server for processi ng. If a cache for
that request i s not found on the server, a query i s submi tted to the
data w arehouse for processi ng, and then the resul ts of the report are
cached. The next ti me someone runs the report or document, the
resul ts are returned i mmedi atel y w i thout havi ng to w ai t for the
database to process the query.

The C ache Moni tor di spl ays detai l ed i nformati on about caches on a
machi ne; for more i nformati on see Moni tori ng R esul t C aches, page
873.

You can easi l y check w hether an i ndi vi dual report hi t a cache by

vi ew i ng the report i n SQL Vi ew . The i mage bel ow show s the SQL
Vi ew of a Mi croStrategy Tutori al report, Sal es by R egi on. The fi fth
l i ne of the SQL Vi ew of thi s report show s "C ache U sed: Yes."

861 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Client-s ide analy tic al proc es s ing, s uc h as ad hoc data s orting, piv oting,
v iew filters , deriv ed metric s , and s o on, does not c aus e Intelligenc e
Serv er to c reate a new c ac he.

Thi s secti on di scusses the fol l ow i ng topi cs concerni ng resul t cachi ng:

l C ache Management Best Practi ces, page 863

l Types of R esul t C aches, page 864

l Locati on of R esul t C aches, page 866

l C ache Matchi ng Al gori thm, page 868

l D i sabl i ng R esul t C achi ng, page 872

l Moni tori ng R esul t C aches, page 873

l Managi ng R esul t C aches, page 878

l C onfi guri ng R esul t C ache Setti ngs, page 884

© 2019, M icr o St r at egy In c. 862

Syst em Ad m in ist r at io n Gu id e

Cache Management Best Practices

Good resul t cache management practi ces depend on a number of
factors, such as the number of reports and documents i n the proj ect,
the avai l abl e di sk space for caches, the amount of personal i zati on i n
reports and documents, and w hether you are usi ng cl ustered
Intel l i gence Servers.

Mi croStrategy recommends the fol l ow i ng best practi ces for cache

management:

l The dri ve that hol ds the resul t caches shoul d al w ays have at l east
10% of i ts capaci ty avai l abl e.

l In a proj ect w i th many reports, consi der enabl i ng cachi ng on a

report-by-report basi s. U se Mi croStrategy Enterpri se Manager to
determi ne w hi ch reports are used often and thus are good
candi dates for cachi ng. For i nformati on about Enterpri se Manager,
see the Enterpri se Manager Gui de. For i nformati on about enabl i ng
cachi ng per report, see C onfi guri ng R esul t C ache Setti ngs, page
884.

l D i sabl e cachi ng for reports and documents w i th a hi gh amount of

personal i zati on, such as prompt answ ers or securi ty fi l ters.

l To reuse resul ts for reports and documents w i th a hi gh amount of

personal i zati on, use Mi croStrategy OLAP Servi ces to create
Intel l i gent C ubes. For more i nformati on about OLAP Servi ces, see
the In-memory Anal yti cs Gui de.

l If resul ts are cached by user ID (see C onfi guri ng R esul t C ache

Setti ngs, page 884), i t may be better to di sabl e cachi ng and i nstead
use the H i story Li st. For i nformati on about the H i story Li st, see
Savi ng R eport R esul ts: H i story Li st, page 897.

l Be aw are of the vari ous w ays i n w hi ch you can tune the cachi ng
properti es to i mprove your system's performance. For a l i st of these

863 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

properti es, and an expl anati on of each, see C onfi guri ng R esul t
C ache Setti ngs, page 884.

l If you are usi ng cl ustered Intel l i gence Servers, cachi ng presents

addi ti onal mai ntenance requi rements. For i nformati on on
mai ntai ni ng caches i n a cl ustered system, see Mai ntai ni ng R esul t
C aches and H i story Li sts i n a C l ustered Envi ronment, page 831.

Types of Result Caches

The fol l ow i ng types of resul t caches are created by Intel l i gence
Server:

l Matchi ng C aches, page 864

l H i story C aches, page 865

l Matchi ng-H i story C aches, page 865

l XML C aches, page 866

Al l document caches are Matchi ng caches; documents do not

generate H i story caches or XML caches. Intel l i gent C ube reports do
not create Matchi ng caches.

Mat ch in g Cach es
Matchi ng caches are the resul ts of reports and documents that are
retai ned for l ater use by the same requests l ater on. In general ,
Matchi ng caches are the type of resul t caches that are used most
often by Intel l i gence Server.

When resul t cachi ng i s enabl ed, Intel l i gence Server determi nes for
each request w hether i t can be served by an al ready exi sti ng
Matchi ng cache. If there i s no match, i t then runs the report or
document on the database and creates a new Matchi ng cache that
can be reused i f the same request i s submi tted agai n. Thi s cachi ng

© 2019, M icr o St r at egy In c. 864

Syst em Ad m in ist r at io n Gu id e

process i s managed by the system admi ni strator and i s transparent to

general users w ho benefi t from faster response ti mes.

Hist o r y Cach es
H i story caches are report resul ts saved for future reference i n the
H i story Li st by a speci fi c user. When a report i s executed, an opti on i s
avai l abl e to the user to send the report to the H i story Li st. Sel ecti ng
thi s opti on creates a H i story cache to hol d the resul ts of that report
and a message i n the user's H i story Li st poi nti ng to that H i story
cache. The user can l ater reuse that report resul t set by accessi ng the
correspondi ng message i n the H i story Li st. It i s possi bl e for mul ti pl e
H i story Li st messages, created by di fferent users, to refer to the same
H i story cache.

The mai n di fference betw een Matchi ng and H i story caches i s that a
Matchi ng cache hol ds the resul ts of a report or document and i s
accessed duri ng executi on; a H i story cache hol ds the data for a
H i story Li st message and i s accessed onl y w hen that H i story Li st
message i s retri eved.

For more i nformati on about H i story Li sts, see Savi ng R eport R esul ts:
H i story Li st, page 897.

Mat ch in g-Hist o r y Cach es

A Matchi ng-H i story cache i s a Matchi ng cache that i s referenced by at
l east one H i story Li st message. It i s a si ngl e cache composed of a
Matchi ng cache and a H i story cache. Properti es associ ated w i th the
Matchi ng caches and H i story caches di scussed above correspond to
the tw o parts of the Matchi ng-H i story caches.

865 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

XML Cach es
An XML cache i s a report cache i n XML format that i s used for
personal i zed dri l l paths. It i s created w hen a report i s executed from
Mi croStrategy Web, and i s avai l abl e for reuse i n Web. It i s possi bl e
for an XML cache to be created at the same ti me as i ts correspondi ng
Matchi ng cache. XML caches are automati cal l y removed w hen the
associ ated report or H i story cache i s removed.

To di sabl e XML cachi ng, sel ect the Enable Web personalized drill
paths opti on i n the Project definition: D rilling category i n the
Proj ect C onfi gurati on Edi tor. N ote that thi s may adversel y affect Web
performance. For more i nformati on about XML cachi ng, see
C ontrol l i ng Access to Obj ects: Permi ssi ons, page 95.

Location of Result Caches

Separate resul t caches are created for each proj ect on an Intel l i gence
Server. They are kept i n memory and on di sk. The server manages the
sw appi ng of these caches betw een memory and di sk automati cal l y.
C aches are automati cal l y unl oaded, begi nni ng w i th the l east recentl y
used cache, unti l the maxi mum memory governi ng l i mi ts are reached.

The amount of memory avai l abl e to store resul t caches i s l i mi ted by

the Memory Storage setti ngs. For i nformati on, see C onfi guri ng R esul t
C ache Setti ngs, page 884.

Resu lt Cach e Files

By defaul t, resul t cache fi l es are stored i n the di rectory w here
Intel l i gence Server i s i nstal l ed
\Cac he s\ S er v e r D e f i n i t i o n\M a c h i n e N a m e\ . R eport caches
are stored i n thi s fol der; document caches are stored i n the
\RWD Ca ch e\ subfol der of thi s fol der.

© 2019, M icr o St r at egy In c. 866

Syst em Ad m in ist r at io n Gu id e

Report Cache File Format

R eport caches are stored on the di sk i n a bi nary fi l e format. Each

report cache has tw o parts:

l C ache<cache ID >_Info.che contai ns i nformati on about the cache,

such as the user and prompt answ ers.

l C ache<cache ID >.che contai ns the actual data for the cache.

Report Cache Index Files

Intel l i gence Server creates tw o types of i ndex fi l es to i denti fy and

l ocate report caches:

l C achePool.idx i s an i ndex fi l e that contai ns a l i st of al l Matchi ng

and H i story caches and poi nters to the caches' l ocati ons.

l C acheLkU p.idx i s a l ookup tabl e that contai ns the l i st of al l

Matchi ng caches and thei r correspondi ng cache keys. Incomi ng
report requests are matched to report cache keys i n thi s tabl e to
determi ne w hether a Matchi ng cache can be used. Thi s process i s
cal l ed cache matchi ng (see C ache Matchi ng Al gori thm, page 868).
Thi s l ookup tabl e i s al w ays backed up to di sk w hen Intel l i gence
Server shuts dow n. Addi ti onal backups are based on the Backup
frequency and the Lookup C l eanup Frequency setti ngs (see
C onfi guri ng R esul t C ache Setti ngs, page 884).

Document Cache File Format

D ocument caches are stored on the di sk i n a bi nary fi l e format. Each

document cache has tw o parts:

l <cache ID >_info.rwdc contai ns i nformati on about the cache, such

as the user and prompt answ ers.

l <cache ID >.rwdc contai ns the actual data for the cache.

867 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Document Cache Index Files

Intel l i gence Server creates tw o types of i ndex fi l es to i denti fy and

l ocate document caches:

l R WD Pool.idx i s an i ndex fi l e that contai ns a l i st of al l Matchi ng

caches and poi nters to the caches' l ocati ons.

l R WD LkU p.idx i s a l ookup tabl e that contai ns the l i st of al l Matchi ng

caches and thei r correspondi ng cache keys. Incomi ng document
requests from Web are matched to document cache keys i n thi s
tabl e to determi ne w hether a Matchi ng cache can be used. Thi s
process i s cal l ed cache matchi ng (see C ache Matchi ng Al gori thm,
page 868). The l ookup tabl e i s al w ays backed up to di sk w hen
Intel l i gence Server shuts dow n. Addi ti onal backups are based on
the Backup frequency and the Lookup C l eanup Frequency setti ngs
(see C onfi guri ng R esul t C ache Setti ngs, page 884).

Cache Matching Algorithm

When a user requests a report, or a document from Web, cache keys
are used to determi ne w hether a cache can be used to sati sfy the
request. If the cache keys i n the request match the ones i n the resul t
cache, the cached report or document resul ts are used. The matchi ng
process takes several steps that i nvol ve a number of cache keys, and
each step i s expl ai ned i n detai l bel ow . If at any step, the matchi ng i s
not successful , then the cache i s not used and the request executes
agai nst the data w arehouse.

St ep 1 : Ch eck t h e IDs
To check w hether the requested report/document and the cached
report/document are the same, Intel l i gence Server compares the ID
and Version ID of the tw o. If they match, the process conti nues to
Step 2.

© 2019, M icr o St r at egy In c. 868

Syst em Ad m in ist r at io n Gu id e

Al ternatel y, Intel l i gence Server checks the Template ID , Template

Version ID , Filter ID , and Filter Version ID i n the requested
report/document agai nst the ones i n the cache. If al l of them match,
the process conti nues to Step 2.

If y ou are not us ing Mic roStrategy OLAP Serv ic es , any modific ation to a
report, ev en a s imple formatting c hange or an Ac c es s Control Lis t (ACL)
modific ation, c hanges the Template Vers ion ID and inv alidates the
report c ac he. With Mic roStrategy OLAP Serv ic es , the c ac he is
inv alidated only if the c ontents of the Report Objec ts pane c hange. For
more information about OLAP Serv ic es , s ee Intel l i gent C ubes, page
759 .

St ep 2 : Ch eck t h e Per so n alizat io n Imp act

If the report or document contai ns prompts, Intel l i gence Server checks
the prompt answers sel ected for the report. D i fferent prompt answ ers
change the content of the report; therefore, the cache i s not used i f
the prompt answ ers i n the report request are not the same as the ones
i n the report cache. Each set of di sti nct prompt answ ers creates a
di sti nct cache.

St ep 3 : Ch eck t h e Secu r it y Imp act

Intel l i gence Server makes sure that users w i th di fferent securi ty fi l ters
cannot access the same cache. Intel l i gence Server compares the
Security ID and Security Version ID of al l the securi ty fi l ters appl i ed
to the user i n the request, i ncl udi ng those i nheri ted from the groups to
w hi ch they bel ong, w i th the securi ty profi l e of the user w ho ori gi nated
the cache.

St ep 4 : Ch eck t h e Mo d if icat io n Imp act

Intel l i gence Server does not use a cache i f an obj ect i n the
report/document changes. To check thi s, Intel l i gence Server

869 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

compares the ID s and Version ID s of al l appl i cati on obj ects used i n

the requested report/document w i th the ones used i n the cached
report/document. If any of these ID s are di fferent, the exi sti ng cache
i s automati cal l y i nval i dated.

St ep 5 : Ch eck t h e Dat a Lan gu age

Intel l i gence Server makes sure a cache i s not used i f the user runni ng
the report i s usi ng a di fferent l anguage than the user w ho created the
cache. Each di fferent l anguage creates a di fferent cache.

St ep 6 : Ch eck t h e Dat ab ase Secu r it y Imp act (Op t io n al)

You may fi nd i t necessary to add opti onal cri teri a, l i sted bel ow , to the
cache matchi ng process. These cri teri a are useful i f database securi ty
vi ew and connecti on mappi ng are used to ensure that users w i th
di fferent securi ty profi l es, w ho see di fferent data from the data
w arehouse, cannot access the same cache. For i nformati on about
connecti on mappi ng, see C ontrol l i ng Access to the D atabase:
C onnecti on Mappi ngs, page 121).

l U ser ID : To match caches by the gl obal uni que i denti fi er (GU ID ) of

the user requesti ng the cache, i n the C achi ng: R esul t C aches:
C reati on category i n the Proj ect C onfi gurati on Edi tor, sel ect the
C reate caches per user check box.

l D atabase login: To match caches by the GU ID of the database

l ogi n assi gned to the user vi a a connecti on mappi ng, i n the
C achi ng: R esul t C aches: C reati on category i n the Proj ect
C onfi gurati on Edi tor, sel ect the C reate caches per database login
check box.

© 2019, M icr o St r at egy In c. 870

Syst em Ad m in ist r at io n Gu id e

This option is es pec ially us eful if databas e warehous e authentic ation

is us ed. For more information, s ee Impl ementi ng D atabase
Warehouse Authenti cati on, page 336 .

l D atabase connection: To match caches by the GU ID of the

database connecti on assi gned to the user vi a a connecti on
mappi ng, i n the C achi ng: R esul t C aches: C reati on category i n the
Proj ect C onfi gurati on Edi tor, sel ect the C reate caches per
database connection check box.

St ep 7 : Ch eck Ad d it io n al Cr it er ia f o r Do cu men t s
D ocument caches have addi ti onal cri teri a that must match before a
cache can be used:

l The Export Option (Al l or C urrent Page) and Locale of the

document must match the cache.

l The sel ector and group-by opti ons used i n the document must
match those used i n the cache.

l The format of the document (PD F, Excel , H TML, or XML/Fl ash) must
match the format of the cache.

l In Excel , the document and cache must both be ei ther enabl ed or

di sabl ed for use i n Mi croStrategy Offi ce.

This information applies to Mic roStrategy Offic e, the add-in for

Mic ros oft Offic e applic ations whic h is no longer ac tiv ely dev eloped.

It was s ubs tituted with a new add-in, Mic roStrategy for Offic e, whic h
s upports Offic e 365 applic ations . The initial v ers ion does not y et hav e
all the func tionalities of the prev ious add-in.

For more information, s ee the Mi croStrategy for Offi ce page i n the

2019 U pdate 1 R eadme and the Mi croStrategy for Offi ce Onl i ne
H el p .

871 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l In XML/Fl ash, the mode of the document (Vi ew , Interacti ve,

Edi tabl e, Fl ash) must match the mode of the cache.

l In XML/Fl ash, the Web preferences of the user executi ng the

document must match the Web preferences of the user w ho created
the cache.

Disabling Result Caching

By defaul t, resul t cachi ng i s enabl ed i n Intel l i gence Server. If the
performance gai n i s margi nal compared to the added overhead, you
can di sabl e report cachi ng. You may w ant to di sabl e cachi ng i n the
fol l ow i ng si tuati ons:

l The data w arehouse i s updated more than once a day.

l Most reporti ng i s ad hoc so cachi ng provi des l i ttl e val ue.

l R eports are heavi l y prompted, and the answ er sel ecti ons to the
prompts are di fferent each ti me the reports are run.

l Few users share the same securi ty fi l ters w hen accessi ng the
reports.

If y ou dis able res ult c ac hing for a projec t, y ou c an s et ex c eptions by

enabling c ac hing for s pec ific reports or doc uments . For more
information, s ee C onfi guri ng R esul t C ache Setti ngs, page 884 .

To Disable Result Caching

1. Open the Proj ect C onfi gurati on Edi tor for the proj ect.

2. Expand C aching, expand R esult C aches, then sel ect C reation.

3. To di sabl e report and document cachi ng, cl ear the Enable

report server caching check box.

© 2019, M icr o St r at egy In c. 872

Syst em Ad m in ist r at io n Gu id e

4. To di sabl e document cachi ng but not report cachi ng, l eave the
Enable report server caching check box sel ected and cl ear the
Enable document output caching in selected formats check
box.

5. C l i ck OK .

Monitoring Result Caches

You use the C ache Moni tor i n D evel oper to moni tor resul t caches.
When resul t cachi ng i s enabl ed and a user executes a report or
document, a cache entry i s l i sted i n the C ache Moni tor.

You can al so use the D i agnosti cs C onfi gurati on Tool for di agnosti c
traci ng of resul t caches (see D i agnosti cs and Performance Loggi ng
Tool , page 876), and C ommand Manager to automati cal l y update
i nformati on about resul t caches (see C ommand Manager, page 877).

A c ac he's hit c ount is the number of times the c ac he is us ed. When a

report is ex ec uted (whic h c reates a job) and the res ults of that report are
retriev ed from a c ac he ins tead of from the data warehous e, Intelligenc e
Serv er inc rements the c ac he's hit c ount. This c an happen when a us er
runs a report or when the report is run on a s c hedule for the us er. This
does not inc lude the c as e of a us er retriev ing a report from the His tory
Lis t (whic h does not c reate a job). Ev en if that report is c ac hed, it does
not inc reas e its hit c ount.

To View All Report or Document Caches for a Project in the

Cache Monitor

1. In D evel oper, l og i n to a proj ect source. You must l og i n as a

user w i th the Moni tor C aches pri vi l ege.

2. Expand A dministration, then expand System Monitors, then

expand C aches, and then sel ect R eports or D ocuments.

873 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

3. Sel ect the proj ect for w hi ch you w ant to vi ew the caches and
cl i ck OK .

4. To vi ew addi ti onal detai l s about a cache, doubl e-cl i ck that

cache.

5. To vi ew addi ti onal detai l s about al l caches, from the View menu

sel ect D etails.

6. To change the col umns show n i n the D etai l s vi ew , ri ght-cl i ck i n

the C ache Moni tor and sel ect View Options. Sel ect the col umns
you w ant to see and cl i ck OK .

7. To vi ew caches from a di fferent proj ect, ri ght-cl i ck i n the C ache

Moni tor and sel ect Filter.

8. Sel ect the proj ect for w hi ch you w ant to vi ew caches and cl i ck
OK .

9. To di spl ay H i story and XML caches i n the R eport C ache Moni tor,
ri ght-cl i ck i n the C ache Moni tor and sel ect Filter. Sel ect Show
caches for H istory List messages or Show XML caches and
cl i ck OK .

You can perform any of the fol l ow i ng opti ons after you sel ect one or
more caches and ri ght-cl i ck:

l D elete: R emoves the cache from both memory and di sk

l Invalidate: Marks the cache as unusabl e, but l eaves a reference to

i t i n users' H i story Li sts (i f any)

l Load from disk: Loads i nto memory a cache that w as previ ousl y
unl oaded to di sk

l U nload to disk: R emoves the cache from memory and stores i t on

di sk

For detai l ed i nformati on about these acti ons, see Managi ng R esul t
C aches, page 878.

© 2019, M icr o St r at egy In c. 874

Syst em Ad m in ist r at io n Gu id e

Cach e St at u ses
A resul t cache's status i s di spl ayed i n the R eport C ache Moni tor
usi ng one or more of the fol l ow i ng l etters:

Sta nds
Sta tus De s c r iption
for

R The cache is valid and ready t o be used.

P The cache is current ly being updat ed.

The cache has been invalidat ed, eit her manually or by a

change t o one of t he object s used in t he cache. I t is no
I longer used, and will be delet ed by I nt elligence S erver. For
inf ormat ion about invalid caches, see Managing R es ult
C ac hes , page 878 .

The cache has been invalidat ed because it s lif et ime has

E elapsed. For inf ormat ion about expired caches, see
Managing R es ult C ac hes , page 878 .

L The cache is loaded int o I nt elligence S erver memory.

U The cache f ile has been updat ed.

The cache has been updat ed in I nt elligence S erver memory

D
since t he last t ime it was saved t o disk.

The cache has been unloaded, and exist s as a f ile on disk

inst ead of in I nt elligence S erver memory. For inf ormat ion
F
about loading and unloading caches, see Managing R esult
C ac hes , page 878 .

Cach e Typ es
R esul t caches can be of the fol l ow i ng types:

875 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Ty pe De s c r iption

The cache is valid and available f or use.

Mat ching
A ll document caches are Mat ching caches.

Hist ory The cache ref erenced in at least one Hist ory List message.

Mat ching- The cache is valid and available f or use, and also ref erenced in at least
Hist ory one Hist ory List message.

(Web only) The cache exist s as an X ML f ile and is ref erenced by t he

X ML mat ching cache. When t he corresponding Mat ching cache is delet ed, t he
X ML cache is delet ed.

For more i nformati on about each type of cache, see Types of R esul t
C aches, page 864.

Diagn o st ics an d Per f o r man ce Lo ggin g To o l

The Intel l i gence Server l ogs are often useful w hen troubl eshooti ng
i ssues w i th report cachi ng i n a Mi croStrategy system. You can vi ew
these l ogs and confi gure w hat i nformati on i s l ogged usi ng the
D i agnosti cs and Performance Loggi ng Tool . For more i nformati on,
see C onfi guri ng What i s Logged, page 517.

To Enable Diagnostic Tracing of Result Caches

1. Open the Mi croStrategy D i agnosti cs and Performance Loggi ng

Tool . (From the Wi ndow s Start menu, poi nt to A ll Programs,
then MicroStrategy Tools, and then sel ect D iagnostics
C onfiguration.)

2. In the Select C onfiguration drop-dow n l i st, sel ect C astorServer

Instance.

© 2019, M icr o St r at egy In c. 876

Syst em Ad m in ist r at io n Gu id e

3. C l ear the U se Machine D efault D iagnostics C onfiguration

check box.

4. In the R eport Server component, i n the C ache Trace di spatcher,

cl i ck the File Log (currentl y set to <N one>) and sel ect <N ew>.

5. Enter the fol l ow i ng i nformati on i n the edi tor:

l Select Log D estination: <N ew >

l File N ame: cacheTrace

l Max File Size: 5000

l File Type: D i agnosti cs

6. C l i ck Save, and then cl i ck C lose.

7. In the R eport Server component, i n the C ache Trace di spatcher,

cl i ck the File Log (currentl y set to <N one>) and sel ect
cacheTrace.

Co mman d Man ager

You can al so use the fol l ow i ng C ommand Manager scri pts to moni tor
resul t caches:

l LI ST [A LL ] R E P O R T C A C H E S [ F O R P R O J E C T " <p r o j e c t _
na me > "] l i sts al l report caches on Intel l i gence Server for a proj ect.

l LI ST [A LL ] P R O P E R T I E S F O R R E P O R T C A C H E " < c a c h e _
na me > " IN P R O J E C T " <p r o j e c t _n a m e> " l i sts i nformati on
about a report cache.

By defaul t, these scri pts are at C : \ P r o g r a m F i l e s

(x86 )\ Mi cr o S t r a t e g y \ C o m m a n d M a n a g e r \ O u t l i n e s \ C a c h e_
Outl in es .

877 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

For more i nformati on about C ommand Manager, see C hapter 15,

Automati ng Admi ni strati ve Tasks w i th C ommand Manager, or the
C ommand Manager H el p (from w i thi n C ommand Manager, press F1).

Managing Result Caches

As a system admi ni strator, your greatest concerns about cachi ng are
consi stency and avai l abi l i ty of the cached data. You have the
i mportant responsi bi l i ty of synchroni zi ng the caches w i th the data i n
the data w arehouse. Therefore, as data changes i n the data
w arehouse, you must ensure that the outdated cached data i s ei ther
updated or di scarded. You can do thi s i n tw o mai n w ays: Inval i dati ng
and Schedul i ng. These methods, al ong w i th other mai ntenance
operati ons that you can use w hen managi ng resul t caches, are
di scussed bel ow . They i ncl ude:

l Schedul i ng U pdates of R esul t C aches, page 878

l U nl oadi ng and Loadi ng R esul t C aches to D i sk, page 879

l Inval i dati ng R esul t C aches, page 879

l D el eti ng R esul t C aches, page 882

l Purgi ng al l R esul t C aches i n a Proj ect, page 883

l Expi ri ng R esul t C aches, page 883

Sch ed u lin g Up d at es o f Resu lt Cach es

You can schedul e a report or document to be executed regul arl y, to
ensure that the resul t cache i s up-to-date. Schedul i ng i s a proacti ve
measure ai med at maki ng sure resul t caches are readi l y avai l abl e
w hen needed.

Typi cal l y, reports and documents that are frequentl y used best qual i fy
for schedul i ng. R eports and documents that are not frequentl y used
do not necessari l y need to be schedul ed because the resource cost

© 2019, M icr o St r at egy In c. 878

Syst em Ad m in ist r at io n Gu id e

associ ated w i th creati ng a cache on a schedul e mi ght not be w orth i t.

For more i nformati on on schedul i ng a resul t cache update, see
Schedul i ng R eports and D ocuments: Subscri pti ons, page 988.

Un lo ad in g an d Lo ad in g Resu lt Cach es t o Disk

You may need to unl oad caches from memory to di sk to create free
memory for other operati ons on the Intel l i gence Server machi ne.

If a report cache i s unl oaded to di sk and a user requests that report,

the report i s then l oaded back i nto memory automati cal l y. You can
al so manual l y l oad a report cache from the di sk i nto memory.

C aches are saved to di sk accordi ng to the Backup frequency setti ng

(see C onfi guri ng R esul t C ache Setti ngs, page 884). C aches are
al w ays saved to di sk regardl ess of w hether they are l oaded or
unl oaded; unl oadi ng or l oadi ng a cache affects onl y the cache's
status i n Intel l i gence Server memory.

In valid at in g Resu lt Cach es

Inval i dati ng a resul t cache i ndi cates to Intel l i gence Server that thi s
cache shoul d not be used. Inval i dati on i s a preventi ve measure that
you can take to ensure that users do not run reports that are based on
outdated cached data. Exampl es of w hen the data may be outdated
i ncl ude:

l When the data w arehouse changes, the exi sti ng caches are no
l onger val i d because the data may be out of date. In thi s case,
future report/document requests shoul d no l onger use the caches.

l When the defi ni ti on of an appl i cati on obj ect (such as a report

defi ni ti on, templ ate, fi l ter, and so on) changes, the rel ated resul t
cache i s automati cal l y marked as i nval i d.

879 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l When the cache for any of the datasets for a document becomes
i nval i dated or del eted, the document cache i s automati cal l y
i nval i dated.

C aches need to be i nval i dated w hen new data i s l oaded from the data
w arehouse so that the outdated cache i s not used to ful fi l l a request.
You can i nval i date al l caches that rel y on a speci fi c tabl e i n the data
w arehouse. For exampl e, you coul d i nval i date al l report/document
caches that use the Sal es_Trans tabl e i n your data w arehouse.

Onl y Matchi ng and Matchi ng-H i story caches can be i nval i dated.
Inval i dati ng a cache has the fol l ow i ng effects:

l An i nval i d Matchi ng cache i s automati cal l y del eted.

l An i nval i d Matchi ng-H i story cache i s converted to a H i story cache.

If al l H i story messages rel ati ng to thi s cache are del eted, the
converted H i story cache i s al so del eted.

Mic roStrategy s trongly rec ommends that y ou inv alidate Matc hing and
Matc hing-His tory c ac hes ins tead of deleting them direc tly .

Inval i d caches are del eted automati cal l y based on the C ache lookup
cleanup frequency setti ng. For more i nformati on about thi s setti ng,
see C onfi guri ng R esul t C ache Setti ngs, page 884.

You can i nval i date caches manual l y or by schedul i ng the i nval i dati on
process.

Invalidating a Cache with a Scheduled Administration Task

You can schedul e a Mi croStrategy admi ni strati on task to i nval i date

caches on a recurri ng schedul e. In the Proj ect C onfi gurati on Edi tor, i n
the C aches: R esul t C aches (Mai ntenance) category, you can sel ect a
schedul e to be used to i nval i date caches. For more i nformati on about
schedul i ng tasks, see Schedul i ng Admi ni strati ve Tasks, page 983.

© 2019, M icr o St r at egy In c. 880

Syst em Ad m in ist r at io n Gu id e

Invalidating a Cache with a Command Manager Script

You can update the data w arehouse l oad routi ne to i nvoke a

Mi croStrategy C ommand Manager scri pt to i nval i date the appropri ate
caches. Thi s scri pt i s at C : \ P r o g r a m F i l e s
(x86 )\ Mi cr o S t r a t e g y \ C o m m a n d M a n a g e r \ O u t l i n e s \ C a c h e_
Outl in es \ I n v a l i d a t e _R e p o r t _C a c h e _O u t l i n e. For more
i nformati on about C ommand Manager, see C hapter 15, Automati ng
Admi ni strati ve Tasks w i th C ommand Manager.

To i nvoke C ommand Manager from the database server, use one of

the fol l ow i ng commands:

l SQL Server: exec xp.cmdshel l cmdmgr

l Oracle: host cmdmgr

l D B 2: ! cmdmgr

l Teradata: os cmdmgr

Invalidating a Cache Manually

From the C ache Moni tor, you can manual l y i nval i date one or more
caches.

To Manually Invalidate a Cache

1. In D evel oper, l og i n to a proj ect source. You must l og i n as a

user w i th the Moni tor C aches pri vi l ege.

2. Expand A dministration, then expand System Monitors, then

expand C aches, and then sel ect R eports or D ocuments.

3. Sel ect the proj ect for w hi ch you w ant to i nval i date a cache and
cl i ck OK .

4. R i ght-cl i ck the cache to i nval i date and sel ect Invalidate C ache.

881 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Delet in g Resu lt Cach es

Typi cal l y, you do not need to manual l y del ete resul t caches i f you are
i nval i dati ng caches and managi ng H i story Li st messages. R esul t
caches are automati cal l y del eted by Intel l i gence Server i f cache
i nval i dati on and H i story Li sts are performed and mai ntai ned properl y,
as fol l ow s:

l A Matchi ng cache i s del eted automati cal l y w hen i t i s i nval i dated.

l A H i story cache i s del eted automati cal l y w hen al l H i story Li st

messages that reference i t are del eted. Mi croStrategy recommends
that you acti vel y mai ntai n H i story Li st messages, as H i story caches
are del eted automati cal l y.

l A Matchi ng-H i story cache i s handl ed i n the fol l ow i ng w ay:

l When al l the H i story Li st messages that reference a Matchi ng-

H i story cache are del eted, the cache i s converted to a Matchi ng
cache.

l When a Matchi ng-H i story cache i s i nval i dated, i t i s converted to a

H i story cache.

l An XML cache i s del eted automati cal l y w hen i ts associ ated

Matchi ng or H i story cache i s del eted.

In al l cases, cache del eti on occurs based on the C ache l ookup

cl eanup frequency setti ng. For more i nformati on about thi s setti ng,
see C onfi guri ng R esul t C ache Setti ngs, page 884.

You can manual l y del ete caches vi a the C ache Moni tor and C ommand
Manager, or schedul e del eti ons vi a the Admi ni strati on Tasks
Schedul i ng, i n the same w ay that you manual l y i nval i date caches. For
detai l s, see Inval i dati ng R esul t C aches, page 879.

© 2019, M icr o St r at egy In c. 882

Syst em Ad m in ist r at io n Gu id e

Pu r gin g all Resu lt Cach es in a Pr o ject

You can del ete al l the resul t caches i n a proj ect at once by sel ecti ng
the Purge C aches opti on i n the Proj ect C onfi gurati on Edi tor. Thi s
forces reports executed after the purge to retri eve and di spl ay the
l atest data from the data w arehouse.

Purging deletes all res ult c ac hes in a projec t, inc luding c ac hes that are
s till referenc ed by the His tory Lis t. Therefore, purge c ac hes only when
y ou are s ure that y ou no longer need to maintain any of the c ac hes in the
projec t, and otherwis e delete indiv idual c ac hes .

Even after purgi ng caches, reports and documents may conti nue to
di spl ay cached data. Thi s can occur because resul ts may be cached
at the obj ect and el ement l evel s, i n addi ti on to at the report/document
l evel . To ensure that a re-executed report or document di spl ays the
most recent data, purge al l three caches. For i nstructi ons on purgi ng
el ement and obj ect caches, see D el eti ng Al l El ement C aches, page
934 and D el eti ng Obj ect C aches, page 940.

To Purge all Result Caches in a Project

1. In D evel oper, ri ght-cl i ck the proj ect and sel ect Project
C onfiguration Editor.

2. Expand C aching, then R esult C aches, and then sel ect

Maintenance.

3. C l i ck Purge N ow.

Exp ir in g Resu lt Cach es

C ache expi rati on i s the process of marki ng a cache out of date.
Expi ri ng a cache has the same resul t as i nval i dati ng a cache, and
appl i es to Matchi ng caches and Matchi ng-H i story caches. The onl y
di fference betw een expi rati on and i nval i dati on i s that expi rati on

883 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

happens after a set peri od of ti me. For i nformati on on how

i nval i dati on w orks, see Inval i dati ng R esul t C aches, page 879.

Mi croStrategy strongl y recommends that you i nval i date a cache w hen

changes i n the data from the data w arehouse affect the cache, rather
than rel yi ng on a ti me i nterval to expi re caches. To di sabl e cache
expi rati on, i n the C achi ng: R esul t C aches: Mai ntenance subcategory
of the Proj ect C onfi gurati on Edi tor, sel ect the N ever expire caches
check box.

C ache expi rati on occurs automati cal l y accordi ng to the C ache

duration (H ours) setti ng i n the C achi ng: R esul t C aches
(Mai ntenance) subcategory i n the Proj ect C onfi gurati on Edi tor.

When a c ac he is updated, the c urrent c ac he lifetime is us ed to

determine the c ac he ex piration date bas ed on the las t update time of the
c ac he. This means that c hanging the C ache duration (H ours) s etting
or the N ever Expire C aches s etting does not affec t the ex piration
date of ex is ting c ac hes . It affec ts only the new c ac hes that are being or
will be c reated.

Configuring Result Cache Settings

R esul t cache setti ngs can be confi gured at three l evel s:

l At the server l evel

l At the proj ect l evel

l At the i ndi vi dual report/document l evel

Changes to any of the c ac hing s ettings are in effec t only after

Intelligenc e Serv er res tarts .

Resu lt Cach e Set t in gs at t h e Ser ver Level

You can confi gure the fol l ow i ng cachi ng setti ngs i n the Intel l i gence
Server C onfi gurati on Edi tor, i n the Server D efi ni ti on (Advanced)

© 2019, M icr o St r at egy In c. 884

Syst em Ad m in ist r at io n Gu id e

category. Each i s descri bed bel ow .

You can al so confi gure these setti ngs usi ng the C ommand Manager
scri pt, A lt er _ S e r v e r _C o n f i g _O u t l i n e . o t l , l ocated at
C:\P ro gr am F i l e s ( x 8 6 ) \ M i c r o S t r a t e g y \ C o m m a n d
Mana ge r\ Ou t l i n e s \ C a c h e _O u t l i n e s .

Backup Frequency (Minutes)

When a resul t cache i s created, the cache i s i ni ti al l y stored i n memory

on Intel l i gence Server. C aches are backed up to di sk as speci fi ed by
the backup frequency setti ng.

You can speci fy the cache backup frequency i n the B ackup

frequency (minutes) box under the Server D efinition: A dvanced
subcategory i n the Intel l i gence Server C onfi gurati on Edi tor.

If you speci fy a backup frequency of 0 (zero), resul t caches are saved

to di sk as soon as they are created. If you speci fy a backup frequency
of 10 (mi nutes), the resul t caches are backed up from memory to di sk
ten mi nutes after they are created.

In a cl ustered envi ronment, Mi croStrategy recommends that you set

the backup frequency to 0 (zero) to ensure that H i story Li st messages
are synchroni zed correctl y.

Bac k ing up c ac hes from memory to dis k more frequently than

nec es s ary c an drain res ourc es .

Thi s setti ng al so defi nes w hen Intel l i gent C ubes are saved to
secondary storage, as descri bed i n Stori ng Intel l i gent C ubes i n
Secondary Storage, page 967.

Cache Lookup Cleanup Frequency (Sec)

The C ache lookup cleanup frequency (sec) setti ng determi nes how
frequentl y the C a c h e L k U p . i d x fi l e i s cl eaned up. Thi s fi l e stores

885 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

cache matchi ng i nformati on and can become si gni fi cant i n si ze,

especi al l y w hen a l arge number of caches i ncl ude a l arge number of
prompts. The cl eanup process reduces the amount of memory that the
fi l e consumes and the ti me that i t takes to back up the l ookup tabl e to
di sk.

The defaul t val ue for thi s setti ng i s 0 (zero), w hi ch means that the
cl eanup takes pl ace onl y at server shutdow n. You may change thi s
val ue to another based on your needs, but make sure that i t does not
negati vel y affect your system performance. Mi croStrategy
recommends cl eani ng the cache l ookup at l east dai l y but not more
frequentl y than every hal f hour.

Resu lt Cach e Set t in gs at t h e Pr o ject Level

You can confi gure cachi ng setti ngs i n the Proj ect C onfi gurati on
Edi tor, i n the R esul t C aches category. Each i s descri bed bel ow .

To l ocate these setti ngs, ri ght-cl i ck the proj ect and sel ect Project
C onfiguration. Then, i n the Proj ect C onfi gurati on Edi tor, expand
C aching, and then sel ect R esult C aches.

You can al so confi gure these setti ngs usi ng C ommand Manager
scri pts l ocated at C : \ P ro g r a m F i l e s
(x86 )\ Mi cr o S t r a t e g y \ C o m m a n d M a n a g e r \ O u t l i n e s \ C a c h e_
Outl in es .

Enable Report Server Caching

R esul t caches can be created or used for a proj ect onl y i f the Enable
report server caching check box i s sel ected i n the Proj ect
C onfi gurati on Edi tor i n the C aching: R esult C aches: C reation
category.

If thi s opti on i s di sabl ed, al l the other opti ons i n the R esul t C aches:
C reati on and R esul t C aches: Mai ntenance categori es are grayed out,

© 2019, M icr o St r at egy In c. 886

Syst em Ad m in ist r at io n Gu id e

except for Purge N ow. By defaul t, report server cachi ng i s enabl ed.
For more i nformati on on w hen report cachi ng i s used, see R esul t
C aches, page 860.

Enable Document Output Caching in Selected Formats

D ocument caches can be created or used for a proj ect onl y i f the
Enable document output caching in selected formats check box i s
sel ected i n the Proj ect C onfi gurati on Edi tor i n the C aching: R esult
C aches: C reation category. D ocument caches are created for
documents that are executed i n the sel ected output formats. You can
sel ect al l or any of the fol l ow i ng: PD F, Excel , H TML, and
XML/Fl ash/H TML5.

Doc ument c ac hes are c reated or us ed only when a doc ument is

ex ec uted from Mic roStrategy Web. They are not c reated or us ed in
Dev eloper.

Enable Prompted Report and Document Caching

Enabl ed by defaul t, the Enable caching for prompted reports and

documents setti ng control s w hether prompted reports and documents
are cached. In an envi ronment w here the maj ori ty of reports are
prompted and each prompt i s l i kel y to recei ve a di fferent answ er each
ti me i t i s used, the probabi l i ty of matchi ng an exi sti ng cache i s l ow . In
thi s case, cachi ng these report datasets do not provi de si gni fi cant
benefi ts; therefore you may w ant to di sabl e thi s setti ng.

To di sabl e thi s setti ng, cl ear i ts check box i n the Proj ect
C onfi gurati on Edi tor under the C aching: R esult C aches: C reation
category.

887 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Record Prompt Answers for Cache Monitoring

If you Enable caching for prompted reports and documents (see

above), you can al so R ecord prompt answers for cache
monitoring. Thi s causes al l prompt answ ers to be l i sted i n the C ache
Moni tor w hen brow si ng the resul t caches. You can then i nval i date
speci fi c caches based on prompt answ ers, ei ther from the C ache
Moni tor or w i th a custom C ommand Manager scri pt.

Thi s opti on i s di sabl ed by defaul t. To enabl e i t, sel ect i ts check box i n

the Proj ect C onfi gurati on Edi tor under the C achi ng: R esul t C aches:
C reati on category.

Enable Non-Prompted Report and Document Caching

If you Enable caching for non-prompted reports and documents,

reports and documents w i thout any prompts are cached.

Thi s opti on i s enabl ed by defaul t. To di sabl e i t, cl ear i ts check box i n

the Proj ect C onfi gurati on Edi tor under the C aching: R esult C aches:
C reation category.

Enable XML Caching for Reports

If you Enable XML caching for reports, reports executed from

Mi croStrategy Web create XML caches i n addi ti on to any Matchi ng or
H i story caches they may create. For i nformati on about XML caches,
see Types of R esul t C aches, page 864.

Thi s opti on i s enabl ed by defaul t. To di sabl e i t, cl ear i ts check box i n

the Proj ect C onfi gurati on Edi tor under the C aching: R esult C aches:
C reation category.

© 2019, M icr o St r at egy In c. 888

Syst em Ad m in ist r at io n Gu id e

Create Caches per User

If the C reate caches per user setti ng i s enabl ed, di fferent users
cannot share the same resul t cache. Enabl e thi s setti ng onl y i n
si tuati ons w here securi ty i ssues (such as database-l evel Securi ty
Vi ew s) requi re users to have thei r ow n cache fi l es. For more
i nformati on, see C ache Matchi ng Al gori thm, page 868.

Ins tead of enabling this s etting, it may be more effic ient to dis able
c ac hing and ins tead us e the His tory Lis t. For information about the
His tory Lis t, s ee Savi ng R eport R esul ts: H i story Li st, page 897 .

Thi s opti on i s di sabl ed by defaul t. To enabl e i t, sel ect i ts check box i n

the Proj ect C onfi gurati on Edi tor under the C aching: R esult C aches:
C reation category.

Create Caches Per Database Login

Sel ect the C reate caches per database login opti on i f database
authenti cati on i s used. Thi s means that users w ho execute thei r
reports usi ng di fferent database l ogi n ID s cannot use the same cache.
For more i nformati on, see C ache Matchi ng Al gori thm, page 868.

Thi s opti on i s di sabl ed by defaul t. To enabl e i t, sel ect i ts check box i n

the Proj ect C onfi gurati on Edi tor under the C aching: R esult C aches:
C reation category.

Create Caches Per Database Connection

Sel ect the C reate caches per database connection opti on i f

connecti on mappi ng i s used. For more i nformati on, see C ache
Matchi ng Al gori thm, page 868.

Thi s opti on i s di sabl ed by defaul t. To enabl e i t, sel ect i ts check box i n

the Proj ect C onfi gurati on Edi tor under the C aching: R esult C aches:
C reation category.

889 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Cache File Directory

The C ache file directory, i n the Proj ect C onfi gurati on Edi tor under
the C achi ng: R esul t C aches: Storage category, speci fi es w here al l
the cache-rel ated fi l es are stored. By defaul t these fi l es are stored i n
the Intel l i gence Server i nstal l ati on di rectory, i n the
\Cac he s\ <S e r v e r d e f i n i t i o n n a m e > subfol der.

In a non-cl ustered envi ronment, report caches are typi cal l y stored on
the same machi ne that i s runni ng Intel l i gence Server.

In a cl ustered envi ronment, there are tw o opti ons:

l Local caching: Each node hosts i ts ow n cache fi l e di rectory that

needs to be shared as "C l usterC ache" so that other nodes can
access i t. C l usterC ache i s the share name Intel l i gence Server l ooks
for on other nodes to retri eve caches.

l C entralized caching: Al l nodes have the cache fi l e di rectory set to

the same netw ork l ocati on, \ \ < m a c h i n e n a m e > \ < s h a r e d
di re ct or y n a m e >. For exampl e, \ \ M y _F i l e _S e r v e r \ M y _
Ca ch e_ D ir e c t o r y.

l For c ac hes loc ated on Windows mac hines , and on Linux mac hines
us ing Samba, s et the path to \ \ < m a c h i ne n a m e > \ < s h a r e d
di re ct o r y n a m e > . For c ac hes s tored on Linux mac hines , s et the
path to / / < S h a r e d L o c a t i o n > / < C a c h e F o l d e r > .

l On UNIX s y s tems , it is rec ommended that y ou mount the s hared

loc ation as a network driv e. You mus t c reate a folder in y our
mac hine's V o l u m e s direc tory before mounting the loc ation. For
ex ample, m o u n t - t a f p a f p : / / m y _f i l e _s e r v e r / m y _
in bo x_ d i r e c t o r y / V o l u m e s / m y _n e t w o r k _m o u n t

Mak e s ure this c ac he direc tory is writable from the network ac c ount
under whic h Intelligenc e Serv er is running. Eac h Intelligenc e Serv er
c reates its own s ubdirec tory .

© 2019, M icr o St r at egy In c. 890

Syst em Ad m in ist r at io n Gu id e

For more i nformati on about w hi ch confi gurati on may be best i n

cl ustered envi ronments, see C onfi guri ng C aches i n a C l uster, page
803.

Cache Encryption Level on Disk

The C ache encryption level on disk drop-dow n l i st control s the

strength of the encrypti on on resul t caches. Encrypti ng caches
i ncreases securi ty, but may sl ow dow n the system.

By defaul t the caches that are saved to di sk are not encrypted. You
can change the encrypti on l evel i n the Proj ect C onfi gurati on Edi tor
under the C aching: R esult C aches: Storage category.

Maximum RAM Usage

The Maximum R A M usage setti ngs, i n the Proj ect C onfi gurati on
Edi tor under the C aching: R esult C aches: Storage category, control
the amount of memory that resul t caches consume on Intel l i gence
Server. When thi s setti ng i s about to be exceeded, the l east recentl y
used caches are automati cal l y unl oaded to di sk.

If the machi ne experi ences probl ems because of hi gh memory use,

you may w ant to reduce the Maximum R A M usage for the resul t
caches. You need to fi nd a good bal ance betw een al l ow i ng suffi ci ent
memory for report caches and freei ng up memory for other uses on the
machi ne. The defaul t val ue i s 25 megabytes for reports and datasets,
and 256 megabytes for formatted documents. The maxi mum val ue for
each of these i s 65536 megabytes, or 64 gi gabytes.

Mi croStrategy recommends that you i ni ti al l y set thi s val ue to 10% of

the system R AM i f i t i s a dedi cated Intel l i gence Server machi ne, that
i s, i f no other processes are runni ng on i t. Thi s setti ng depends on the
fol l ow i ng factors:

891 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l The si ze of the l argest report cache.

Thi s setti ng shoul d be at l east as l arge as the l argest report i n the

proj ect that you w ant to cache. If the amount of R AM avai l abl e i s not
l arge enough for the l argest report cache, that cache w i l l not be
used and the report w i l l al w ays execute agai nst the w arehouse. For
exampl e, i f the l argest report you w ant to be cached i n memory i s
20 MB, the maxi mum R AM usage needs to be at l east 20 MB.

l The average si ze and number of cache fi l es.

l The amount of memory on the Intel l i gence Server machi ne.

l The amount of memory used w hi l e the system i s at maxi mum

capaci ty.

You shoul d moni tor the system's performance w hen you change the
Maximum R A M usage setti ng. In general , i t shoul d not be more than
30% of the machi ne's total memory.

For more i nformati on about w hen report caches are moved i n and out
of memory, see Locati on of R esul t C aches, page 866.

Maximum Number of Caches

The Maximum number of caches setti ngs, i n the Proj ect

C onfi gurati on Edi tor under the C aching: R esult C aches: Storage
category, l i mi t the number of resul t caches, i ncl udi ng Matchi ng
caches, H i story caches, Matchi ng-H i story caches, and XML caches,
al l ow ed i n the proj ect at one ti me. The defaul t val ues are 10,000
datasets, and 100,000 formatted documents.

Thi s setti ng depends on the fol l ow i ng factors:

l The number of users and the number of H i story Li st messages they

keep.

© 2019, M icr o St r at egy In c. 892

Syst em Ad m in ist r at io n Gu id e

l The number of report caches and thei r average si ze.

l The amount of hard di sk space avai l abl e i n the cache di rectory.

RAM Swap Multiplier

If the Intel l i gence Server memory that has been al l ocated for caches
becomes ful l , i t must sw ap caches from memory to di sk. The R A M
swap multiplier setti ng, i n the Proj ect C onfi gurati on Edi tor under the
C aching: R esult C aches: Storage category, control s how much
memory i s sw apped to di sk, rel ati ve to the si ze of the cache bei ng
sw apped i nto memory. For exampl e, i f the R A M swap multiplier
setti ng i s 2 and the requested cache i s 80 ki l obytes, 160 ki l obytes are
sw apped from memory to di sk.

If the cache memory i s ful l and several concurrent reports are tryi ng to
sw ap from di sk, the sw ap attempts can fai l and re-execute those
reports. Thi s counteracts any gai n i n effi ci ency due to cachi ng. In thi s
case, i ncreasi ng the R A M swap multiplier setti ng provi des addi ti onal
free memory i nto w hi ch those caches can be sw apped.

The defaul t val ue for thi s setti ng i s 2.

Maximum RAM for Cache Index %

Thi s setti ng determi nes w hat percentage of the amount of memory

speci fi ed i n the Maximum R A M usage l i mi ts (see Maxi mum R AM
U sage, page 891) can be used for resul t cache l ookup tabl es. If your
reports and documents contai n many prompt answ ers, the cache
l ookup tabl e may reach thi s l i mi t. At thi s poi nt, Intel l i gence Server no
l onger creates new caches. To conti nue creati ng new caches, you
must ei ther remove exi sti ng caches to free up memory for the cache
l ookup tabl e, or i ncrease thi s l i mi t.

The defaul t val ue for thi s parameter i s 100%, and the val ues can
range from 10% to 100%.

893 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

You can change thi s setti ng i n the Proj ect C onfi gurati on Edi tor under
the C aching: R esult C aches: Storage category.

Load Caches on Startup

If report cachi ng i s enabl ed and the Load caches on startup setti ng

i s enabl ed, w hen Intel l i gence Server starts up, i t l oads report caches
from di sk i nto memory unti l i t reaches the Maximum R A M usage l i mi t
(see Maxi mum R AM U sage, page 891). If the Load caches on
startup setti ng i s di sabl ed, i t l oads report caches onl y w hen
requested by users.

Load caches on startup i s enabl ed by defaul t. To di sabl e i t, i n the

Proj ect C onfi gurati on Edi tor under the C aching: R esult C aches:
Storage category, cl ear the Load caches on startup check box.

For l arge proj ects, l oadi ng caches on startup can take a l ong ti me so
you have the opti on to set the l oadi ng of caches on demand onl y.
H ow ever, i f caches are not l oaded i n advance, there w i l l be a smal l
addi ti onal del ay i n response ti me w hen they are hi t. Therefore, you
need to deci de w hi ch i s best for your set of user and system
requi rements.

Never Expire Caches

The N ever expire caches setti ng, i n the Proj ect C onfi gurati on Edi tor
under the C aching: R esult C aches: Maintenance category, causes
caches to never automati cal l y expi re. Mi croStrategy recommends
sel ecti ng thi s check box, i nstead of usi ng ti me-based resul t cache
expi rati on. For more i nformati on, see Managi ng R esul t C aches, page
878.

© 2019, M icr o St r at egy In c. 894

Syst em Ad m in ist r at io n Gu id e

Cache Duration (Hours)

Al l caches that have exi sted for l onger than the C ache duration
(H ours) are automati cal l y expi red. Thi s durati on i s set to 24 hours by
defaul t. You can change the durati on i n the Proj ect C onfi gurati on
Edi tor under the C aching: R esult C aches: Maintenance category.

As menti oned earl i er, Mi croStrategy recommends agai nst usi ng ti me-
based resul t cache expi rati on. For more i nformati on, see Managi ng
R esul t C aches, page 878.

Cache Expiration and Dynamic Dates

By defaul t, caches for reports based on fi l ters that use dynami c dates
al w ays expi re at mi dni ght of the l ast day i n the dynami c date fi l ter.
Thi s behavi or occurs even i f the C ache D uration (see above) i s set
to zero.

For exampl e, a report has a fi l ter based on the dynami c date "Today."
If thi s report i s executed on Monday, the cache for thi s report expi res
at mi dni ght on Monday. Thi s i s because a user w ho executes the
report on Tuesday expects to see data from Tuesday, not the cached
data from Monday. For more i nformati on on dynami c date fi l ters, see
the Fi l ters secti on i n the Advanced R eporti ng Gui de.

To change thi s behavi or, i n the Proj ect C onfi gurati on Edi tor under the
C aching: R esult C aches: Maintenance category, sel ect the D o N ot
A pply A utomatic Expiration Logic for reports containing dynamic
dates check box. When thi s setti ng i s enabl ed, report caches w i th
dynami c dates expi re i n the same w ay as other report caches do,
accordi ng to the C ache duration setti ng.

Cache Usage Defaults for Subscriptions

By defaul t, i f a cache i s present for a subscri bed report or document,

the report or document uses the cache i nstead of re-executi ng the

895 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

report or document. If no cache i s present, one i s created w hen the

report or document i s executed. For more i nformati on about
subscri pti ons, see Schedul i ng R eports and D ocuments:
Subscri pti ons, page 988.

When you create a subscri pti on, you can force the report or document
to re-execute agai nst the w arehouse even i f a cache i s present. You
can al so prevent the subscri pti on from creati ng a new cache.

To change the defaul t behavi or for new subscri pti ons, use the
fol l ow i ng check boxes i n the Proj ect C onfi gurati on Edi tor, i n the
C achi ng: Subscri pti on Executi on category.

l To cause new H i story Li st and Mobi l e subscri pti ons to execute

agai nst the w arehouse by defaul t, sel ect the R e-run H istory List
and Mobile subscriptions against the warehouse check box.

l To cause new emai l , fi l e, and pri nt subscri pti ons to execute agai nst
the w arehouse by defaul t, sel ect the R e-run file, email, and print
subscriptions against the warehouse check box.

l To prevent new subscri pti ons of al l types from creati ng or updati ng

caches by defaul t, sel ect the D o not create or update matching
caches check box.

Result Cache Settings at the Report Level

You can enabl e cachi ng for a speci fi c report, subset report, or
document. R esul t cachi ng setti ngs made at the report l evel w i l l appl y
regardl ess of the proj ect l evel cachi ng setti ngs.

You mus t hav e the Us e Des ign Mode priv ilege to c onfigure
report/doc ument-lev el c ac he s ettings .

Resu lt Cach in g Op t io n s
To set the cachi ng opti ons for a report or subset report:

© 2019, M icr o St r at egy In c. 896

Syst em Ad m in ist r at io n Gu id e

1. In the R eport Edi tor sel ect D ata > R eport caching options.

2. Sel ect Enabled i n the R eport C achi ng Opti ons di al og box.

To set the cachi ng opti ons for a document:

1. In the D ocument Edi tor sel ect Format > D ocument Properties.

2. U nder D ocument Properties > C aching sel ect Enable

document caching .

For a doc ument, y ou c an c hoos e whic h formats , s uc h as HTML or PDF,

are c ac hed. You c an als o c hoos e to c reate a new c ac he for ev ery page-
by , inc remental fetc h bloc k , and s elec tor s etting.

To di sabl e cachi ng for a report or document even i f cachi ng i s

enabl ed at the proj ect l evel , sel ect the D isable C aching opti on.

To use the proj ect-l evel setti ng for cachi ng, sel ect the U se default
project-level behavior opti on. Thi s i ndi cates that the cachi ng
setti ngs confi gured at the proj ect l evel i n the Proj ect C onfi gurati on
Edi tor appl y to thi s speci fi c report or document as w el l .

Saving Report Results: History List

The H i story Li st i s a fol der w here Intel l i gence Server pl aces report
and document resul ts for future reference. Each user has a uni que
H i story Li st.

Wi th the H i story Li st, users can:

l Keep shortcuts to previ ousl y run reports, l i ke the Favori tes l i st w hen
brow si ng the Internet.

l Perform asynchronous report executi on. For exampl e, mul ti pl e

reports can be run at the same ti me w i thi n one brow ser, or pendi ng
reports can remai n di spl ayed even after l oggi ng out of a proj ect.

l Vi ew the resul ts of schedul ed reports.

897 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

The H i story Li st i s di spl ayed at the user l evel , but i s mai ntai ned at the
proj ect source l evel . The H i story Li st fol der contai ns messages for al l
the proj ects i n w hi ch the user i s w orki ng. The number of messages i n
thi s fol der i s control l ed by the setti ng Maximum number of
messages per user. For exampl e, i f you set thi s number at 40, and
you have 10 messages for Proj ect A and 15 for Proj ect B, you can
have no more than 15 for Proj ect C . When the maxi mum number i s
reached, the ol dest message i n the current proj ect i s purged
automati cal l y to l eave room for the new one.

If the c urrent projec t has no mes s ages but the mes s age limit has been
reac hed in other projec ts in the projec t s ourc e, the us er may be unable
to run any reports in the c urrent projec t. In this c as e the us er mus t log in
to one of the other projec ts and delete mes s ages from the His tory lis t in
that projec t.

Thi s secti on provi des the fol l ow i ng i nformati on about H i story Li sts:

l U nderstandi ng H i story Li sts, page 898

l C onfi guri ng H i story Li st D ata Storage, page 903

l Accessi ng H i story Li sts, page 908

l Archi vi ng H i story Li st Messages, page 910

l Managi ng H i story Li sts, page 912

Understanding History Lists

A H i story Li st i s a col l ecti on of pre-executed reports and documents
that have been sent to a user's personal H i story fol der. These pre-
executed reports and documents are cal l ed H i story Li st messages.

The data contai ned i n these H i story Li st messages i s stored i n the

H i story Li st reposi tory, w hi ch can be l ocated on Intel l i gence Server,
or i n the database. For more i nformati on about the di fferences

© 2019, M icr o St r at egy In c. 898

Syst em Ad m in ist r at io n Gu id e

betw een these storage opti ons, see C onfi guri ng H i story Li st D ata
Storage, page 903.

A H i story Li st message provi des a snapshot of data at the ti me the

message i s created. U si ng a di fferent report fi l ter on a H i story Li st
message does not cause the message to return di fferent data. To vi ew
a report i n the H i story Li st w i th a di fferent report fi l ter, you must re-
execute the report.

Each report that i s sent to the H i story Li st creates a si ngl e H i story Li st

message. Each document creates a H i story Li st message for that
document, pl us a message for each dataset report i n the document.

You can send report resul ts to the H i story Li st manual l y or

automati cal l y.

Sen d in g a Message t o t h e Hist o r y List Man u ally

R eport resul ts can be manual l y sent to the H i story Li st any ti me you
pl an to execute a report, duri ng report executi on, or even after a
report i s executed:

l B efore report execution:

l From D eveloper: R i ght-cl i ck the report or document name and

sel ect Send to H istory from the shortcut menu. The report or
document i s executed, and a message i s generated i n the H i story
Li st.

This option is not av ailable from a s hortc ut to a report or doc ument.

l From Web: Thi s opti on i s not avai l abl e.

l In the middle of report execution:

l From D eveloper: Whi l e the report i s bei ng executed, sel ect Send
to H istory List from the Fi l e menu.

899 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

This operation c reates two jobs , one for ex ec uting the report
(agains t the data warehous e) and another for s ending the report to
His tory Lis t. If c ac hing is enabled, the s ec ond job remains in the
waiting lis t for the firs t job to finis h; if c ac hing is not enabled, the
s ec ond job runs agains t the data warehous e again. Therefore, to
av oid was ting res ourc es , Mic roStrategy rec ommends that if
c ac hing is not enabled, us ers not s end the report to His tory Lis t in
the middle of a report ex ec ution.

l From Web: Whi l e the report i s bei ng executed, cl i ck A dd to

H istory List on the w ai t page.

This operation c reates only one job bec aus e the firs t one is modified
for the Send to His tory Lis t reques t.

l A fter report execution:

l From D eveloper: After the report i s executed, sel ect Send to

H istory from the File menu.

l From Web: After the report i s executed, sel ect A dd to H istory

List from the H ome menu.

Two jobs are c reated for Dev eloper, and only one is c reated for Web.

Sen d in g a Message t o t h e Hist o r y List Au t o mat ically

R eport resul ts can be automati cal l y sent to the H i story Li st. There are
tw o di fferent w ays to automati cal l y send messages to the H i story l i st.
You can ei ther have every report or document that you execute sent to
your H i story Li st, or you can subscri be to speci fi c reports or
documents:

l To automatically send every report and document that is

executed to your H istory List:

© 2019, M icr o St r at egy In c. 900

Syst em Ad m in ist r at io n Gu id e

l From MicroStrategy Web: Sel ect H istory List from the Proj ect
Preferences, and then sel ect A utomatically for A dd reports and
documents to my H istory List.

l From D eveloper: Sel ect MicroStrategy D eveloper Preferences

from the Tools menu, then sel ect H istory Options, and then
sel ect A utomatically send reports to H istory List during
execution.

l To schedule delivery of specific reports or documents:

l From MicroStrategy Web: On the reports page, under the name

of the report that you w ant to send to H i story Li st, sel ect
Subscriptions, and then cl i ck A dd H istory List subscription on
the My Subscri pti ons page. C hoose a schedul e for the report
executi on. A H i story Li st message i s generated automati cal l y
w henever the report i s executed based on the schedul e.

l From D eveloper: R i ght-cl i ck a report or document and sel ect

Schedule D elivery to and sel ect H istory List. D efi ne the
subscri pti on detai l s. For speci fi c i nformati on about usi ng the
Subscri pti on Edi tor, cl i ck H elp.

Filt er in g an d Pu r gin g Yo u r Hist o r y List Messages in

Develo p er
The H i story Li st Moni tor fi l ter can be used to ei ther fi l ter w hi ch
messages are di spl ayed i n the H i story Li st, or i t can defi ne the
H i story Li st messages that you w ant to purge from the H i story Li st.
The H i story Li st Moni tor fi l ter al l ow s you to defi ne vari ous parameters
to fi l ter or purge your H i story Li st messages.

To use the H i story Li st Moni tor Fi l ter to fi l ter your H i story Li st

messages, ri ght cl i ck the H i story Li st fol der, and sel ect Filter. After
you have speci fi ed the fi l ter parameters, cl i ck OK . The H i story Li st

901 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Moni tor Fi l ter cl oses, and your H i story Li st messages w i l l be fi l tered

accordi ngl y.

To use the H i story Li st Moni tor Fi l ter to purge i tems from your H i story
Li st fol der, ri ght cl i ck the H i story Li st fol der and sel ect Purge. After
you have speci fi ed the fi l ter parameters, cl i ck Purge. The H i story Li st
Moni tor Fi l ter cl oses, and the H i story Li st Messages that match the
cri teri a defi ned i n the H i story Li st Moni tor Fi l ter are del eted.

For more detai l s about the H i story Li st Moni tor Fi l ter, cl i ck H elp.

Hist o r y List s an d Cach in g

The H i story Li st i s cl osel y rel ated to cachi ng functi onal i ty. H i story
Li sts consi st of messages that poi nt to report resul ts, w hi ch are stored
as H i story caches. Therefore, w hen a H i story Li st message i s del eted,
the H i story cache that the message poi nts to i s del eted as w el l .

Multiple mes s ages c an point to the s ame His tory c ac he. In this c as e,
the His tory c ac he is deleted after all mes s ages pointing to it hav e been
deleted.

If you are usi ng a database-based H i story Li st reposi tory, by defaul t,

dupl i cates of the report caches that are associ ated w i th the H i story
Li st messages are stored i n the database, as w el l as bei ng stored
l ocal l y. Thi s w ay, i f a user del etes the l ocal report cache, the cache
that i s stored i n the database can sti l l be accessed. Thi s behavi or
appl i es to both H i story C aches and H i story-Matchi ng C aches. For
more i nformati on about types of caches, see Types of R esul t C aches,
page 864. For more i nformati on about stori ng H i story Li st data, see
C onfi guri ng H i story Li st D ata Storage, page 903.

If y ou are ex porting a report or doc ument to a databas e-bas ed His tory

Lis t, only the mos t rec ent ex port is s tored in the His tory Lis t. For
ex ample, if y ou ex port a doc ument as an Ex c el file, and then ex port it as
a PDF, only the PDF is s av ed in the His tory Lis t.

© 2019, M icr o St r at egy In c. 902

Syst em Ad m in ist r at io n Gu id e

You can use the H i story Li st messages to retri eve report resul ts, even
w hen report cachi ng i s di sabl ed.

Configuring History List Data Storage

The H i story Li st reposi tory i s the l ocati on w here al l H i story Li st data
i s stored.

There are several di fferent w ays that the H i story Li st reposi tory can
be confi gured to store data for the H i story Li st. It can be stored i n a
database, or i n a fi l e on the Intel l i gence Server machi ne. Al ternatel y,
you can use a hybri d approach that stores the message i nformati on i n
a database for i mproved search resul ts and scal abi l i ty, and the
message resul ts i n a fi l e for performance reasons.

Co n f igu r in g In t elligen ce Ser ver t o Use a Dat ab ase-Based o r

Hyb r id Hist o r y List Rep o sit o r y
The caches associ ated w i th H i story Li sts can be stored i n a database.
Stori ng the H i story Li st messages i n a database reduces the l oad on
the machi ne that hosts Intel l i gence Server.

If you are usi ng a database-based H i story Li st reposi tory, the caches

that are associ ated w i th a H i story Li st message are al so stored i n the
H i story Li st database.

You can al so confi gure Intel l i gence Server to use a hybri d H i story Li st
reposi tory. In thi s confi gurati on the H i story Li st message i nformati on
i s stored i n a database, and the cached resul ts are stored i n a fi l e.
Thi s approach preserves the scal abi l i ty of the database-based H i story
Li st, w hi l e mai ntai ni ng the i mproved performance of the fi l e-based
H i story Li st.

l Onc e Intelligenc e Serv er has been c onfigured to s tore the His tory Lis t
c ac hed data in the databas e, this s etting will apply to the entire s erv er

903 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

definition.

l Mic roStrategy does not rec ommend rev erting bac k to a file-bas ed
His tory Lis t repos itory . If y ou want to rev ert bac k to a file-bas ed
repos itory , y ou mus t replac e the ex is ting s erv er definition with a new
one.

The s torage loc ation for the His tory Lis t data (the His tory Lis t repos itory )
mus t hav e been c reated in the databas e. For information about c reating the
His tory Lis t repos itory in the databas e, s ee the Instal l ati on and
C onfi gurati on Gui de .

If y ou are us ing a hy brid His tory Lis t repos itory , the s torage loc ation for the
His tory Lis t res ults mus t hav e been c reated and s hared on the Intelligenc e
Serv er mac hine. For information about how to c onfigure this loc ation, s ee
C onfi guri ng Intel l i gence Server to U se a Fi l e-Based H i story Li st
R eposi tory, page 906 .

To Configure Intelligence Server to Use a Database-Based or

Hybrid History List Repository

1. In D evel oper, l og i n to the proj ect source as a user w i th

admi ni strati ve pri vi l eges.

2. Go to A dministration > Server > C onfigure MicroStrategy

Intelligence Server.

3. On the l eft, go to H istory Settings > General.

4. Sel ect D atabase based. The fol l ow i ng w arni ng message i s

di spl ayed:

© 2019, M icr o St r at egy In c. 904

Syst em Ad m in ist r at io n Gu id e

Onc e Intelligenc e Serv er has been c onfigured to s tore the His tory
Lis t c ac hed data in the databas e, this s etting will apply to the entire
s erv er definition.

5. C l i ck Yes.

6. By defaul t, H i story Li st caches are backed up to the database. To

store onl y H i story Li st caches on the server, cl ear the B ackup
report history caches to the database checkbox.

7. To use a hybri d H i story Li st reposi tory, i n the External central

storage directory for D atabase-based H istory List fi el d, type
the l ocati on for the fi l e-based H i story Li st message storage. For
i nformati on about how the cached resul ts are stored, see
C onfi guri ng Intel l i gence Server to U se a Fi l e-Based H i story Li st
R eposi tory, page 906.

You c an brows e to the file loc ation by c lic k ing the . . . (brows e)
button.

8. Expand Server D efinition, and then sel ect General.

9. U nder C ontent Server Location, from the D atabase Instance

menu, sel ect the database i nstance that poi nts to the H i story Li st
reposi tory i n the database.

10. C l i ck OK .

11. R estart Intel l i gence Server for the changes to take effect.

905 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To Conf i r m t hat t he H i st or y Li st Rep osi t or y has b een Conf i gur ed

Cor r ect l y

1. Log i n to the proj ect source as a user w i th admi ni strati ve

pri vi l eges.

2. Go to A dministration > Server, > C onfigure MicroStrategy

Intelligence Server.

3. On the l eft, expand H istory Settings and sel ect General. If you
have confi gured Intel l i gence Server properl y, the fol l ow i ng
message i s di spl ayed i n the R eposi tory Type area of the
Intel l i gence Server C onfi gurati on Edi tor:

Co n f igu r in g In t elligen ce Ser ver t o Use a File-Based Hist o r y

List Rep o sit o r y
When you i ni ti al l y set up your H i story Li st, you can store the H i story
Li st i n a fi l e fol der on the machi ne that hosts Intel l i gence Server. The
defaul t l ocati on of thi s fol der i s rel ati ve to the i nstal l ati on path of
Intel l i gence Server:

.\Inbox\<Server definition name>

For exampl e, C : \ P r o g r a m F i l e s
(x86 )\ Mi cr o S t r a t e g y \ I n t e l l i g e n c e
Serv er \I nb o x \ M i c r o S t r a t e g y T u t o r i a l S e r v e r .

In a non-cl ustered envi ronment, H i story Li st cached data i s typi cal l y

stored on the same machi ne that i s runni ng Intel l i gence Server.

In a cl ustered envi ronment, there are tw o storage opti ons:

© 2019, M icr o St r at egy In c. 906

Syst em Ad m in ist r at io n Gu id e

l Local caching: Each node hosts i ts ow n cache fi l e di rectory that

needs to be shared as "C l usterC ache" so that other nodes can
access i t.

l C entralized caching: Al l nodes have the cache fi l e di rectory set to

the same netw ork l ocati on, \ \ < m a c h i n e n a m e > \ < s h a r e d
di re ct or y n a m e >. For exampl e, \ \ M y _F i l e _S e r v e r \ M y _
In bo x_ D ir e c t o r y.

For c ac hes s tored on Windows mac hines , and on Linux mac hines
us ing Samba, s et the path to \ \ < m a c h i ne n a m e > \ < s h a r e d
di re ct o r y n a m e > . For c ac hes s tored on Linux mac hines , s et the
path to / / < S h a r e d L o c a t i o n > / < C a c h e F o l d e r > .

On UNIX s y s tems , it is rec ommended that y ou mount the s hared

loc ation as a network driv e. You mus t c reate a folder in y our
mac hine's V o l u m e s direc tory before mounting the loc ation. For
ex ample, m o u n t - t a f p a f p : / / m y _f i l e _s e r v e r / m y _
in bo x_ d i r e c t o r y / V o l u m e s / m y _n e t w o r k _m o u n t .

Mak e s ure that the network direc tory is writable from the network
ac c ount under whic h Intelligenc e Serv er is running. Eac h Intelligenc e
Serv er c reates its own s ubdirec tory .

For steps to confi gure Intel l i gence Server to store cached H i story Li st
data i n a fi l e-based reposi tory, see the procedure bel ow .

To Configure Intelligence Server to Use a File-Based History List

Repository

1. Log i n to the proj ect source as a user w i th admi ni strati ve

pri vi l eges.

2. Go to A dministration > Server > C onfigure MicroStrategy

Intelligence Server.

3. On the l eft, expand H istory Settings and sel ect General.

907 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

4. Sel ect File based, and type the fi l e l ocati on i n the H istory
directory fi el d.

You c an brows e to the file loc ation by c lic k ing the … (brows e)
button.

5. C l i ck OK .

Accessing History Lists

H i story Li sts can be accessed from both Mi croStrategy Web and
D evel oper. You cannot see the H i story Li sts for al l users unl ess you
have access to the H i story Li st Messages Moni tor. For more
i nformati on about the H i story Li st Messages Moni tor, see Managi ng
H i story Li sts, page 912.

Accessin g t h e Hist o r y List Fo ld er in Micr o St r at egy Web

In Mi croStrategy Web, l og i n to the desi red proj ect and cl i ck the
H istory List l i nk i n the top navi gati on bar. Thi s di spl ays al l hi story
l i st messages for the user that i s currentl y l ogged i n. The fol l ow i ng
i nformati on i s avai l abl e:

l N ame: N ame (or al i as) of the report.

l Status: Status of a report j ob, for exampl e, executi ng, processi ng

on another node, ready, and so on.

If y ou are work ing in a c lus tered env ironment, only Ready and Error
s tatus es are s y nc hroniz ed ac ros s nodes . While a job on one node is
reported as Ex ec uting, it is reported as Proc es s ing On Another Node
on all the other nodes .

l Message C reation Time: The ti me the message w as created, i n the

currentl y sel ected ti me zone.

© 2019, M icr o St r at egy In c. 908

Syst em Ad m in ist r at io n Gu id e

l D etails: More i nformati on about the report, i ncl udi ng total number of
row s, total number of col umns, server name, report path, message
ID , report ID , status, message created, message l ast updated, start
ti me, fi ni sh ti me, ow ner, report descri pti on, templ ate, report fi l ter,
vi ew fi l ter, templ ate detai l s, prompt detai l s, and SQL statements.

Eac h time a us er s ubmits a report that c ontains a prompt, the dialog

requires that they ans wer the prompt. As a res ult, multiple lis tings of the
s ame report may oc c ur. The differenc es among thes e reports c an be
found by c hec k ing the times tamp and the data c ontents .

Accessin g t h e Hist o r y List Fo ld er in Develo p er

In D evel oper, H i story Li st messages are l ocated i n the H i story fol der
under the proj ect name. The number next to the H i story Li st fol der
i ndi cates how many unread H i story Li st messages are contai ned i n
the fol der. C l i ck the H i story fol der to vi ew al l the messages. Each
message i s l i sted w i th the fol l ow i ng i nformati on:

l N ame: N ame of the report

l Finish Time: The ti me the report executi on i s fi ni shed

l Folder name: N ame of the fol der w here the ori gi nal report i s saved

l Last update time: The ti me w hen the ori gi nal report w as l ast
updated

l Message text: The status message for the H i story Li st message

l Start time: The ti me the report executi on w as started

l Status: Status of a report j ob, for exampl e, has been executed

successful l y and i s ready, i s not executed successful l y, i s currentl y
executi ng, or i s w ai ti ng to execute

909 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

You can see more detai l s of any message by ri ght-cl i cki ng i t and
sel ecti ng Quick View. Thi s opens a new w i ndow w i th the fol l ow i ng
i nformati on:

l R eport definition: Expand thi s category to see i nformati on about

the report defi ni ti on, i ncl udi ng the descri pti on, ow ner, ti me and date
i t w as l ast modi fi ed, the proj ect i t resi des i n, the report ID , the path
to the report's l ocati on, and report detai l s.

l Job execution statistics: Expand thi s category to see i nformati on

about the report executi on, i ncl udi ng the start and end ti me, the
total number of row s and col umns i n the report, the total number of
row s and col umns that contai n raw data, w hether a cache w as used,
the j ob ID , and the SQL produced.

l Message status: Expand thi s category to see i nformati on about the

message i tsel f, i ncl udi ng the l anguage, user creati on ti me, l ast
update ti me, read status, format, request type, appl i cati on, message
ID , and message text.

Archiving History List Messages

General l y, you archi ve H i story Li st messages i f you w ant to see the
report resul ts as they w ere w hen the messages w ere ori gi nal l y
created. Thi s feature i s useful w hen you need to track changes i n the
report resul ts for a schedul ed report.

Intel l i gence Server automati cal l y marks H i story Li st messages as

archi ved w hen, i n the Subscri pti on Edi tor, the The new scheduled
report will overwrite older versions of itself check box i s cl eared.
Archi ved messages can al so be created i n a Mi croStrategy Web
subscri pti on i f, on the Proj ect D efaul ts - H i story Li st Preferences
page, the The new scheduled report will overwrite older versions
of itself check box i s cl eared.

© 2019, M icr o St r at egy In c. 910

Syst em Ad m in ist r at io n Gu id e

To Ar ch ive All Hist o r y List Messages in a Pr o ject in Web

1. In Preferences Level s category, sel ect Project defaults.

2. In the Preferences category, sel ect H istory List.

3. C l ear the check box for The new scheduled report will
overwrite older versions of itself.

To Ar ch ive Hist o r y List Messages in Develo p er

1. Go to A dministration > Scheduling > Subscription C reation
Wizard.

2. C l i ck N ext.

3. Speci fy the fol l ow i ng characteri sti cs of the schedul e:

l C hoose the schedul e that you w ant to use.

l C hoose the proj ect that contai ns the obj ect that you w ant to
archi ve.

l C hoose H istory List from the D elivery Type drop-dow n menu.

4. C l i ck N ext.

5. C hoose the reports or documents that you w ant to archi ve:

l Brow se to the report or document that you w ant to archi ve. You
can sel ect mul ti pl e reports or documents by hol di ng the C trl
key w hi l e cl i cki ng them.

l C l i ck the ri ght arrow to add the report or document.

l C l i ck N ext w hen al l of the reports or documents that you w ant

to archi ve have been added.

6. Sel ect a user group to recei ve the message for the archi ved
report or document:

911 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Brow se to the user group that you w ant to send the archi ved
report to. You can sel ect mul ti pl e reports or documents by
hol di ng the C trl key w hi l e cl i cki ng them.

l C l i ck the ri ght arrow to add the group.

l C l i ck N ext w hen al l of the user groups that you w ant to recei ve

the archi ved report or document have been added.

All members in the us er group rec eiv e the His tory Lis t mes s age.

7. Speci fy the subscri pti on properti es:

l R un the schedul e i mmedi atel y

l Set the expi rati on date for the subscri pti on

l Send a del i very noti fi cati on to al l users i ncl uded i n the

subscri pti on.

8. C l ear the The new scheduled report will overwrite older

versions of itself check box, and cl i ck N ext.

9. C l i ck Finish.

Managing History Lists

Admi ni strators manage H i story Li sts and the H i story caches at the
same ti me. For i nformati on on the rel ati onshi p betw een the H i story
caches and H i story Li sts, see Types of R esul t C aches, page 864.

An admi ni strator can control the si ze of the H i story Li st and thus

control resource usage through the fol l ow i ng setti ngs:

l The maxi mum si ze of the H i story Li st i s governed at the proj ect

l evel . Each user can have a maxi mum number of H i story Li st
messages, set by an admi ni strator. For more detai l s, i ncl udi ng
i nstructi ons, see C ontrol l i ng the Maxi mum Si ze of the H i story Li st,
page 914.

© 2019, M icr o St r at egy In c. 912

Syst em Ad m in ist r at io n Gu id e

l Message l i feti me i s the l ength of ti me before a H i story Li st message

i s automati cal l y del eted. For more detai l s about message l i feti me,
see C ontrol l i ng the Li feti me of H i story Li st Messages, page 915.

l You can al so del ete H i story Li st messages accordi ng to a schedul e.

For more detai l s, i ncl udi ng i nstructi ons, see Schedul i ng H i story Li st
Message D el eti on, page 916.

l If you are usi ng a database-based H i story Li st, you can reduce the
si ze of the database by di sabl i ng the H i story Li st backup caches.
For more detai l s, i ncl udi ng i nstructi ons, see Backi ng up H i story
C aches to the H i story Li st D atabase, page 918.

If you are usi ng a database-based H i story Li st reposi tory and you

have the proper permi ssi ons, you have access to the H i story Li st
Messages Moni tor. Thi s pow erful tool al l ow s you to vi ew and manage
H i story Li st messages for al l users. For more i nformati on, see
Moni tori ng H i story Li st Messages, page 919.

Hist o r y List Backu p Fr eq u en cy

The backup frequency for H i story Li st messages i s the same as for
cachi ng. H i story Li st messages are backed up to di sk as frequentl y as
the server backup frequency setti ng speci fi es. For more i nformati on,
see C onfi guri ng R esul t C ache Setti ngs, page 884.

Hist o r y List s in a Clu st er ed En vir o n men t

In a cl ustered envi ronment, each server mai ntai ns i ts ow n H i story Li st
fi l e. H ow ever, the same messages are retri eved and presented to the
user regardl ess of the machi ne from w hi ch the H i story Li st i s
accessed. For compl ete detai l s on H i story Li sts i n a cl ustered
envi ronment, see Synchroni zi ng C ached Informati on across N odes i n
a C l uster, page 792.

913 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Co n t r o llin g t h e Maximu m Size o f t h e Hist o r y List

The maxi mum si ze of the H i story Li st i s governed at the proj ect l evel .
The proj ect admi ni strator can set a maxi mum number of H i story Li st
messages for each user. Addi ti onal l y, the proj ect admi ni strator can
set a maxi mum si ze for messages. For both setti ngs, the defaul t val ue
i s -1, w hi ch means that there i s no maxi mum.

The admi ni strator can al so speci fy w hether to create separate

messages for each dataset report that i s i ncl uded i n a R eport
Servi ces document or to create onl y a message for the document
i tsel f, and w hether to create messages for documents that have been
exported i n other formats, such as Excel or PD F. N ot creati ng these
addi ti onal H i story Li st messages can i mprove H i story Li st
performance, at the cost of excl udi ng some data from the H i story Li st.
By defaul t, al l reports and documents create H i story Li st messages.

To Configure the Messages that are Stored in the History List

1. In D evel oper, l og i nto a proj ect. You must l og i n w i th a user

account that has admi ni strati ve pri vi l eges.

2. From the A dministration menu, poi nt to Projects, and then

sel ect Project C onfiguration.

3. Expand the Project D efinition category and sel ect the H istory
list subcategory.

4. In the Maximum number of messages per user fi el d, type the

maxi mum number of H i story Li st messages to store for each user,
or type -1 for no l i mi t.

5. To create a H i story Li st message for each dataset report

i ncl uded i n a R eport Servi ces document, sel ect the Save R eport
Services document dataset messages to H istory List check

© 2019, M icr o St r at egy In c. 914

Syst em Ad m in ist r at io n Gu id e

box. To create onl y a message for the document, and not for the
dataset reports, cl ear thi s check box.

6. To create H i story Li st messages for R eport Servi ces documents

that are exported to other formats, sel ect the Save exported
results for interactive executions sent to H istory List check
box. To not create messages for documents w hen they are
exported, cl ear thi s check box.

7. In the Maximum Inbox message size (MB ) fi el d, type the

maxi mum message si ze, i n megabytes, for i nboxes. Type -1 for
no l i mi t.

8. C l i ck OK .

9. R estart Intel l i gence Server for your changes to take effect.

Co n t r o llin g t h e Lif et ime o f Hist o r y List Messages

Message l i feti me control s how l ong (i n days) messages can exi st i n a
user's H i story Li st. Thi s setti ng al l ow s admi ni strators to ensure that
no H i story Li st messages resi de i n the system i ndefi ni tel y. Messages
are tested agai nst thi s setti ng at user l ogout and del eted i f found to
be ol der than the establ i shed l i feti me.

When a message i s del eted for thi s reason, any associ ated H i story
caches are al so del eted. For more i nformati on about H i story caches,
see Types of R esul t C aches, page 864.

The defaul t val ue i s -1, w hi ch means that messages can stay i n the
system i ndefi ni tel y unti l the user manual l y del etes them.

915 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To Set Message Lifetime

1. In D evel oper, l og i n to a proj ect source.

2. From the A dministration menu, poi nt to Server and then sel ect
C onfigure MicroStrategy Intelligence Server.

3. Expand H istory Settings on the l eft, then sel ect General.

4. Type a number i n the Message lifetime (days) fi el d.

5. C l i ck OK .

Sch ed u lin g Hist o r y List Message Delet io n

You can del ete H i story Li st messages usi ng the Schedul e
Admi ni strati on Tasks feature, w hi ch i s accessed by sel ecti ng
Scheduling from the A dministration menu. Thi s al l ow s you to
peri odi cal l y and sel ecti vel y purge H i story Li st messages of certai n
users and groups. You can choose to target onl y certai n messages,
i ncl udi ng:

l Messages for a certai n proj ect or for al l proj ects

l Messages i n the H i story Li sts of al l users i n a certai n group

l Messages that are read or unread

l Messages that w ere created more than x number of days ago

The D el ete H i story Li st messages feature can al so be used for one-

ti me mai ntenance by usi ng a non-recurri ng schedul e.

© 2019, M icr o St r at egy In c. 916

Syst em Ad m in ist r at io n Gu id e

To Schedule History List Message Deletion

1. In D evel oper, l og i n to a proj ect source.

2. From the A dministration menu, sel ect Scheduling, then sel ect
Schedule A dministration Tasks.

3. Sel ect a proj ect from the Avai l abl e Proj ects l i st.

4. Sel ect D elete H istory List messages as the acti on.

5. Sel ect a schedul e from the preconfi gured opti ons, for exampl e, at
cl ose of busi ness (w eekday), fi rst of month, on database l oad,
and so on.

6. Type a number i n the Lifetime (days) box.

7. Sel ect an opti on for the messages status:

l R ead

l U nread

l Al l

8. C l i ck … (the brow se button) to sel ect a user/group for w hi ch the

H i story Li st messages w i l l be del eted.

9. C l i ck OK .

Clean in g u p t h e Hist o r y List Dat ab ase

You can cl ean up the H i story Li st database usi ng the Schedul e
Admi ni strati on Tasks feature, w hi ch i s accessed by sel ecti ng
Scheduling from the A dministration menu. Thi s al l ow s you to
peri odi cal l y remove orphaned entri es from the database, and i t al l ow s
you to remove hi story l i st messages for del eted users.

The C l ean H i story Li st database feature can al so be used for one-

ti me mai ntenance by usi ng a non-recurri ng schedul e.

917 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To Schedule History List Database Cleanup

1. In D evel oper, l og i n to a proj ect source.

2. From the A dministration menu, sel ect Scheduling, then sel ect
Schedule A dministration Tasks.

3. Sel ect a proj ect from the Avai l abl e Proj ects l i st.

4. Sel ect C lean H istory List database as the acti on.

5. C l i ck OK .

Backin g u p Hist o r y Cach es t o t h e Hist o r y List Dat ab ase

By defaul t, i n a database-based H i story Li st, the H i story caches are
backed up to the database. Thi s provi des i ncreased scal abi l i ty i n
l arge systems, and i ncreases avai l abi l i ty to the H i story caches i f a
node fai l s. It al so al l ow s you to set l onger message l i feti mes for
H i story Li st messages, because ol der H i story caches can be del eted
from the Intel l i gence Server machi ne's hard di sk and can be served
by the database i nstead.

If you are concerned about the si ze of the database used for a

database-based H i story Li st, you can di sabl e the use of the database
as a l ong-term backup for H i story caches.

To Disable the Database Backup for History Caches

1. In D evel oper, l og i n to a proj ect source.

2. From the A dministration menu, poi nt to Server and then sel ect
C onfigure MicroStrategy Intelligence Server.

3. Expand the H istory Settings category, and sel ect General.

© 2019, M icr o St r at egy In c. 918

Syst em Ad m in ist r at io n Gu id e

4. C l ear the B ackup report history caches to database check

box.

5. C l i ck OK .

Mo n it o r in g Hist o r y List Messages

The H i story Li st Messages Moni tor al l ow s you to vi ew al l H i story Li st
messages for al l users, vi ew detai l ed i nformati on about each
message, and purge the messages based on certai n condi ti ons.

To use the H i story Li st Messages Moni tor, your H i story Li st reposi tory
must be stored i n a database. For more i nformati on about confi guri ng
the H i story Li st reposi tory, see C onfi guri ng H i story Li st D ata Storage,
page 903.

To Monitor the History List Messages

1. In D evel oper, l og i n to a proj ect source. You must l og i n as a

user w i th the Admi ni ster H i story Li st Moni tor and the Moni tor
H i story Li st pri vi l eges.

2. Expand A dministration, then expand System Monitors, and

then sel ect H istory List Messages. Al l H i story Li st messages
are di spl ayed, as show n bel ow :

919 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

3. To vi ew the detai l s of a H i story Li st message, doubl e-cl i ck that

message. A Qui ck Vi ew w i ndow opens, w i th detai l ed i nformati on
about the message.

4. To fi l ter the messages di spl ayed based on cri teri a that you
defi ne, ri ght-cl i ck a message and sel ect Filter.

To Purge a History List Message

1. Sel ect the message i n the H i story Li st Moni tor.

2. R i ght-cl i ck the message and sel ect Purge.

Element Caches
When a user runs a prompted report contai ni ng an attri bute el ement
prompt or a hi erarchy prompt, an el ement request i s created.
(Addi ti onal w ays to create an el ement request are l i sted bel ow .) An
el ement request i s actual l y a SQL statement that i s submi tted to the
data w arehouse. Once the el ement request i s compl eted, the prompt
can be resol ved and sent back to the user. El ement cachi ng, set by
defaul t, al l ow s for thi s el ement to be stored i n memory so i t can be
retri eved rapi dl y for subsequent el ement requests w i thout tri ggeri ng
new SQL statements agai nst the data w arehouse.

For exampl e, i f ten users run a report w i th a prompt to sel ect a regi on
from a l i st, w hen the fi rst user runs the report, a SQL statement
executes and retri eves the regi on el ements from the data w arehouse
to store i n an el ement cache. The next ni ne users see the l i st of
el ements return much faster than the fi rst user because the resul ts are
retri eved from the el ement cache i n memory. If el ement cachi ng i s not
enabl ed, w hen the next ni ne users run the report, ni ne addi ti onal SQL
statements w i l l be submi tted to the data w arehouse, w hi ch puts
unnecessary l oad on the data w arehouse.

© 2019, M icr o St r at egy In c. 920

Syst em Ad m in ist r at io n Gu id e

El ement caches are the most-recentl y used l ookup tabl e el ements

that are stored i n memory on the Intel l i gence Server or D evel oper
machi nes so they can be retri eved more qui ckl y. They are created
w hen users:

l Brow se attri bute el ements i n D evel oper usi ng the D ata Expl orer,
ei ther i n the Fol der Li st or the R eport Edi tor

l Brow se attri bute el ements i n the Fi l ter Edi tor

l Execute a report contai ni ng a prompt exposi ng an attri bute l i st

(w hi ch i ncl udes hi erarchi es and el ement l i st types). The el ement
l i st i s di spl ayed w hen the report executes and creates an el ement
cache.

Thi s secti on di scusses the fol l ow i ng topi cs concerni ng el ement

cachi ng:

l El ement C achi ng Termi nol ogy, page 922

l Locati on of El ement C aches, page 923

l C ache Matchi ng Al gori thm, page 923

l Enabl i ng or D i sabl i ng El ement C achi ng, page 923

l Li mi ti ng the N umber of El ements D i spl ayed and C ached at a Ti me,

page 925

l C achi ng Al gori thm, page 929

l Li mi ti ng the Amount of Memory Avai l abl e for El ement C aches, page

929

l Li mi ti ng Whi ch Attri bute El ements a U ser can See, page 931

l Li mi ti ng El ement C aches by D atabase C onnecti on, page 933

l Locati on of R esul t C aches, page 866

921 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l D el eti ng Al l El ement C aches, page 934

l Summary Tabl e of El ement C ache Setti ngs, page 935

Element Caching Terminology

The fol l ow i ng termi nol ogy i s hel pful i n understandi ng the concept of
el ement cachi ng:

l Element R equest/B rowse Query: A SQL request i ssued to the data

w arehouse to retri eve a l i st of attri bute el ements. Thi s request
accesses the attri butes l ookup tabl e, w hi ch i s defi ned w hen the
attri bute i s created i n Archi tect. If the key to the l ookup tabl e i s the
attri bute i tsel f, a S E L E C T i s i ssued for the el ement request. If the
attri butes l ookup tabl e i s i n a l ow er-l evel l ookup tabl e (for exampl e,
month i n the l ookup date tabl e) a S E L E C T D I S T I N C T i s used for
the el ement request. El ement requests may al so contai n a W H E R E
cl ause i f resul ti ng from a search, fi l tered hi erarchy prompt, dri l l
request on a hi erarchy prompt, or a securi ty fi l ter.

l Element C ache Pool: The amount of memory Intel l i gence Server

al l ocates for el ement cachi ng. In the i nterface, thi s val ue i s cal l ed
Maxi mum R AM usage, set i n the Proj ect C onfi gurati on Edi tor i n the
C achi ng: Auxi l i ary C aches: El ements category. The defaul t val ue
for thi s setti ng i s 1 MB. Intel l i gence Server esti mates that each
obj ect uses 512 bytes; therefore, by defaul t, Intel l i gence Server
caches about 2,048 el ement obj ects. If an el ement request resul ts
i n more obj ects needi ng to be cached than w hat the maxi mum si ze
of the el ement cache pool al l ow s, the request i s not cached.

l Element Incremental Fetch Size: The maxi mum number of

el ements for di spl ay i n the i nterface per el ement request. On
D evel oper, the defaul t for the El ement Incremental Fetch setti ng i s
1,000 el ements; on Web, the defaul t i s 15 el ements.

© 2019, M icr o St r at egy In c. 922

Syst em Ad m in ist r at io n Gu id e

Location of Element Caches

El ement caches are stored onl y i n memory and are not saved to di sk.
They can exi st on both Intel l i gence Server and D evel oper machi nes.

When a D evel oper user tri ggers an el ement request, the cache w i thi n
the D evel oper machi ne's memory i s checked fi rst. If i t i s not there, the
Intel l i gence Server memory i s checked. If i t i s not there, the resul ts
are retri eved from the data w arehouse. Each opti on i s successi vel y
sl ow er than the previ ous one, for exampl e, the response ti me coul d
be 1 second for D evel oper, 2 seconds for Intel l i gence Server, and 20
seconds for the data w arehouse.

Cache Matching Algorithm

For an el ement cache to be used, the cache must be val i d, and i t must
match the j ob bei ng executed. The fol l ow i ng cache keys are used i n
the matchi ng process:

l Attri bute ID

l Attri bute versi on ID

l El ement ID

l Search cri teri a

l D atabase connecti on (i f the proj ect i s confi gured to check for the
cache key)

l D atabase l ogi n (i f the proj ect i s confi gured to check for the cache
key)

l Securi ty fi l ter (i f the proj ect and attri butes are confi gured to use the
cache key)

Enabling or Disabling Element Caching

When the Mi croStrategy system i s i nstal l ed for the fi rst ti me, the
el ement cachi ng i s enabl ed by defaul t. You can di sabl e i t for an enti re

923 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

proj ect, for a D evel oper cl i ent, or for a speci fi c attri bute i n the
proj ect's schema. The data source cache setti ng
DssC ac he Se t t i n g E l e m e n t M a x M e m o r y C o n s u m p t i o n control s the
total amount of memory used by the el ement server cache. Setti ng
thi s val ue to zero compl etel y di sabl es the el ement cache.

In s ituations where the data warehous e is loaded more that onc e a day ,
it may be des irable to dis able element c ac hing.

To Disable Element Caching for a Project

In the Proj ect C onfi gurati on Edi tor, i n the C achi ng: Auxi l i ary C aches
(El ements) category, under Server, set the Maximum R A M usage
(K B ytes) to 0 (zero).

To Disable Element Caching for Developer

In the Proj ect Source Manager, sel ect the Memory tab, set the
Maximum R A M usage (K B ytes) to 0 (zero).

You mi ght w ant to perform thi s operati on i f you al w ays w ant to use the
caches on Intel l i gence Server. Thi s i s because w hen el ement caches
are purged, onl y the ones on Intel l i gence Server are el i mi nated
automati cal l y w hi l e the ones i n D evel oper remai n i ntact. C aches are
general l y purged because there are frequent changes i n the data
w arehouse that make the caches i nval i d.

To Disable Element Caching for an Attribute

1. In D evel oper, ri ght-cl i ck the attri bute and sel ect Edit.

2. On the D i spl ay tab, cl ear the Enable element caching check

box.

© 2019, M icr o St r at egy In c. 924

Syst em Ad m in ist r at io n Gu id e

Limiting the Number of Elements Displayed and Cached

at a Time
Incremental el ement fetchi ng reduces the amount of memory
Intel l i gence Server uses to retri eve el ements from the data w arehouse
and i mproves the effi ci ency of Intel l i gence Server's el ement cachi ng.
You can set the maxi mum number of el ements to di spl ay i n the
i nterface per el ement request i n the Proj ect C onfi gurati on Edi tor, by
usi ng the Maximum number of elements to display setti ng i n the
Proj ect defi ni ti on: Advanced category. The defaul t val ue i s 1,000 for
D evel oper and 15 for Web.

Attri bute el ement requests can be qui te l arge (someti mes exceedi ng
100,000 el ements). R equests of thi s si ze take a l arge amount of
memory and ti me to pul l i nto Intel l i gence Server and typi cal l y force
many of the smal l er el ement caches out of the el ement cache pool .
C achi ng such l arge el ement l i sts i s often unnecessary because users
rarel y page through extremel y l arge el ement l i sts; they do a search
i nstead.

When the i ncremental el ement fetchi ng i s used, an addi ti onal pass of

SQL i s added to each el ement request. Thi s pass of SQL determi nes
the total number of el ements that exi st for a gi ven request. Thi s
number hel ps users deci de how to brow se a gi ven attri butes el ement
l i st. Thi s addi ti onal pass of SQL generates a S E L E C T C O U N T
DIST IN CT on the l ookup tabl e of the attri bute fol l ow ed by a second
SELE CT statement (usi ng an O R D E R B Y) on the same tabl e. From the
resul t of the fi rst query, Intel l i gence Server determi nes i f i t shoul d
cache al l of the el ements or onl y an i ncremental set.

The i ncremental retri eval l i mi t i s four ti mes the i ncremental fetch si ze.
For exampl e, i f your Mi croStrategy Web product i s confi gured to
retri eve 50 el ements at a ti me, 200 el ements al ong w i th the di sti nct
count val ue are pl aced i n the el ement cache. The user must cl i ck the
next opti on four ti mes to i ntroduce another S EL E C T pass, w hi ch

925 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

retri eves another 200 records i n thi s exampl e. Because the S E L E C T

COUN T D IS TI N C T val ue w as cached, thi s w oul d not be i ssued a
second ti me the S E L E C T statement i s i ssued.

To opti mi ze the i ncremental el ement cachi ng feature (i f you have

l arge el ement fetch l i mi ts or smal l el ement cache pool si zes),
Intel l i gence Server uses onl y 10 percent of the el ement cache on any
si ngl e cache request. For exampl e, i f 200 el ements use 20 percent of
the cache pool , Intel l i gence Server caches onl y 100 el ements, w hi ch
i s 10 percent of the avai l abl e memory for el ement caches.

The number of el ements retri eved per el ement cache can be set for
D evel oper users at the proj ect l evel , Mi croStrategy Web product
users, a hi erarchy, or an attri bute. Each i s di scussed bel ow .

To Limit the Number of Elements Displayed for a Project (Affects

Only Developer Users)

1. In D evel oper, l og i nto a proj ect. You must l og i n w i th a user

account that has admi ni strati ve pri vi l eges.

2. From the A dministration menu, poi nt to Projects, and then

sel ect Project C onfiguration.

3. Expand Project definition, then sel ect A dvanced.

4. Type the l i mi t i n the Maximum number of elements to display

box.

To Limit the Number of Elements Displayed for MicroStrategy

Web Product Users

1. In Mi croStrategy Web, l og i n to a proj ect as a user w i th the Web

Admi ni strati on pri vi l ege.

2. C l i ck the MicroStrategy i con, then cl i ck Preferences.

© 2019, M icr o St r at egy In c. 926

Syst em Ad m in ist r at io n Gu id e

3. Sel ect Project D efaults i n the Preferences Level category.

4. Sel ect General i n the Preferences category.

5. Type the l i mi t for the Maximum number of attribute elements

per block setti ng i n the Incremental Fetch subcategory.

To Limit the Number of Elements Displayed on a Hierarchy

1. Open the H i erarchy edi tor, ri ght-cl i ck the attri bute and sel ect
Element D isplay from the shortcut menu, and then sel ect Limit.

2. Type a number i n the Limit box.

To Limit the Number of Elements Displayed for an Attribute

1. Open the Attri bute Edi tor.

2. Sel ect the D isplay tab.

3. In the Element D isplay category, sel ect the Limit opti on and
type a number i n the box.

The element dis play limit s et for hierarc hies and attributes may
further limit the number of elements s et in the projec t properties or
Web preferenc es . For ex ample, if y ou s et 1,000 for the projec t, 500
for the attribute, and 100 for the hierarc hy , Intelligenc e Serv er
retriev es only 100 elements .

Op t imizin g Elemen t Req u est s

You may fi nd the i ncremental el ement fetchi ng feature's addi ti onal
SELE CT CO UN T D I S T I N C T query to be costl y on your data
w arehouse. In some cases, thi s addi ti onal query adds mi nutes to the
el ement brow se ti me, maki ng thi s performance unacceptabl e for
producti on envi ronments.

927 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To make thi s more effi ci ent, you can set a VLD B opti on to control how
the total row s are cal cul ated. The defaul t i s to use the S E L E C T
COUN T D IS TI N C T. The other opti on i s to have Intel l i gence Server
l oop through the tabl e after the i ni ti al S E L E C T pass, eventual l y
getti ng to the end of the tabl e and determi ni ng the total number of
records. You must deci de w hether to have the database or
Intel l i gence Server determi ne the number of el ement records.
Mi croStrategy recommends that you use Intel l i gence Server i f your
data w arehouse i s heavi l y used, or i f the S E L E C T C O U N T D I S T I N CT
query i tsel f adds mi nutes to the el ement brow si ng ti me.

Us ing Intelligenc e Serv er to determine the total number of element

rec ords res ults in more traffic between Intelligenc e Serv er and the data
warehous e.

Ei ther opti on uses si gni fi cantl y l ess memory than w hat i s used
w i thout i ncremental el ement fetchi ng enabl ed. U si ng the count
di sti nct opti on, Intel l i gence Server retri eves four ti mes the
i ncremental el ement si ze. U si ng the Intel l i gence Server opti on
retri eves four ti mes the i ncremental el ement si ze, pl us addi ti onal
resources needed to l oop through the tabl e. C ompare thi s to returni ng
the compl ete resul t tabl e (w hi ch may be as l arge as 100,000
el ements) and you w i l l see that the memory use i s much l ess.

The setti ng i s cal l ed A ttribute Element N umber C ount Method.

To Configure Attribute Element Number Count Method

1. In the D atabase Instance manager, sel ect the database i nstance.

2. From the A dministration menu, sel ect VLD B Properties.

3. U nder Query Optimizations, sel ect A ttribute Element N umber

C ount Method and on the ri ght-hand si de, sel ect one of the
opti ons:

© 2019, M icr o St r at egy In c. 928

Syst em Ad m in ist r at io n Gu id e

l To have the data w arehouse cal cul ate the count, sel ect U se
C ount(A ttribute@ ID ) to calculate total element number (will
use count distinct if necessary) - D efaul t.

l To have Intel l i gence Server cal cul ate the count, sel ect U se
OD B C cursor to calculate total element number.

4. C l i ck Save and C lose.

Caching Algorithm
The cache behaves as though i t contai ns a col l ecti on of bl ocks of
el ements. Each cached el ement i s counted as one obj ect and each
cached bl ock of el ements i s al so counted as an obj ect. As a resul t, a
bl ock of four el ements are counted as fi ve obj ects, one obj ect for each
el ement and a fi fth obj ect for the bl ock. H ow ever, i f the same el ement
occurs on several bl ocks i t i s counted onl y once. Thi s i s because the
el ement cache shares el ements betw een bl ocks.

The cache uses the "l east recentl y used" al gori thm on bl ocks of
el ements. That i s, w hen the cache i s ful l , i t di scards the bl ocks of
el ements that have been i n the cache for the l ongest ti me w i thout any
requests for the bl ocks. Indi vi dual el ements, w hi ch are shared
betw een bl ocks, are di scarded w hen al l the bl ocks that contai n the
el ements have been di scarded. Fi ndi ng the bl ocks to di scard i s a
rel ati vel y expensi ve operati on. H ence, the cache di scards one quarter
of i ts contents each ti me i t reaches the maxi mum number of al l ow ed
obj ects.

Limiting the Amount of Memory Available for Element

Caches
You can control the amount of memory that el ement caches use on
both Intel l i gence Server (set at the proj ect l evel ) and the D evel oper
machi nes. Thi s memory i s referred to as the cache pool . If
Intel l i gence Server attempts to cache a new el ement request, but
there i s not enough avai l abl e cache pool space to store al l of the new

929 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

el ements, exi sti ng el ements must be removed from memory before the
new ones can be cached. When thi s happens, the l east recentl y used
25% of el ement caches are removed from the cache.

You can confi gure the memory setti ng for both the proj ect and the
cl i ent machi ne i n the C ache: El ement subcategory i n the Proj ect
C onfi gurati on Edi tor. You shoul d consi der these factors before
confi guri ng i t:

l The number of attri butes that users brow se el ements on, for
exampl e, i n el ement prompts, hi erarchy prompts, and so on

l The number of uni que el ements

For exampl e, attri bute "Year" (10 years = 10 el ements), attri bute
"ci ty" (500 ci ti es = 500 el ements)

l Ti me and cost associ ated w i th runni ng el ement requests on the data

w arehouse

For exampl e, i f the el ement request for ci ti es runs qui ckl y (say i n 2
seconds), i t may not have to exi st i n the el ement cache.

l The amount of R AM on the Intel l i gence Server machi ne

To Set the RAM Available for Element Caches for a Project

1. In D evel oper, l og i nto a proj ect. You must l og i n w i th a user

account that has admi ni strati ve pri vi l eges.

2. From the A dministration menu, poi nt to Projects, and then

sel ect Project C onfiguration.

3. Expand C aching, expand A uxiliary C aches, then cl i ck

Elements.

4. Speci fy the amount of R AM (i n megabytes) i n the Server:

Maximum R A M usage (MB ytes) box.

© 2019, M icr o St r at egy In c. 930

Syst em Ad m in ist r at io n Gu id e

l The default v alue is 1 megaby te.

l If y ou s et the v alue to 0, element c ac hing is dis abled.

l If y ou s et it to -1, Intelligenc e Serv er us es the default v alue of 1

MB.

5. Speci fy the amount of R AM (i n megabytes) i n the Maximum R A M

usage (MB ytes) box.

The new s ettings tak e affec t only after Intelligenc e Serv er is

res tarted.

To Set the RAM Available for Element Caches on Developer

1. In the Proj ect Source Manager, cl i ck the C aching tab and w i thi n
the El ement C ache group of control s, sel ect the U se custom
value opti on.

If y ou s elec t the U se project default option, the amount of RAM

will be the s ame as s pec ified in the Client s ec tion in the Projec t
Configuration Editor des c ribed abov e.

2. Speci fy the R AM (i n megabytes) i n the C l i ent secti on i n the

Maximum R A M usage (MB ytes) fi el d.

Limiting Which Attribute Elements a User can See

You can l i mi t the attri bute el ements that a user can see to onl y the
el ements al l ow ed by thei r securi ty fi l ter. For exampl e, i f a user's
securi ty fi l ter al l ow s them to see onl y the N ortheast R egi on and they
run a report that prompts for ci ti es, onl y those ci ti es i n the N ortheast
are di spl ayed.

Thi s functi onal i ty can be enabl ed for a proj ect and l i mi ts the el ement
cache shari ng to onl y those users w i th the same securi ty fi l ter. Thi s
can al so be set for attri butes. That i s, i f you do not l i mi t attri bute

931 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

el ements w i th securi ty fi l ters for a proj ect, you can enabl e i t for
certai n attri butes. For exampl e, i f you have Item i nformati on i n the
data w arehouse avai l abl e to external suppl i ers, you coul d l i mi t the
attri butes i n the Product hi erarchy w i th a securi ty fi l ter. Thi s i s done
by edi ti ng each attri bute. Thi s w ay, suppl i ers can see thei r products,
but not other suppl i ers' products. El ement caches not rel ated to the
Product hi erarchy, such as Ti me and Geography, are sti l l shared
among users.

For more i nformati on on securi ty fi l ters, see R estri cti ng Access to

D ata: Securi ty Fi l ters, page 129.

To Limit Which Attribute Elements Users can See Per Project

1. In D evel oper, l og i nto a proj ect. You must l og i n w i th a user

account that has admi ni strati ve pri vi l eges.

2. From the A dministration menu, poi nt to Projects, and then

sel ect Project C onfiguration.

3. Expand Project definition, then sel ect A dvanced.

4. Sel ect the A pply security filters to element browsing check

box.

To Limit Which Attribute Elements Users can See Per Attribute

1. Edi t the attri bute, and cl i ck the D isplay tab.

2. Sel ect the A pply security filters to element browsing check

box.

You mus t update the s c hema before c hanges to this s etting tak e affec t
(from the Schema menu, s elec t U pdate Schema ).

© 2019, M icr o St r at egy In c. 932

Syst em Ad m in ist r at io n Gu id e

Limiting Element Caches by Database Connection

In most cases, users connect to the data w arehouse based on thei r
connecti on maps. By defaul t, al l users have the same connecti on
map, unl ess you map them to di fferent ones w i th the C onnecti on
Mappi ng edi tor. When usi ng connecti on mappi ng, you can al so
ensure that users w i th di fferent database connecti ons cannot share
el ement caches. Thi s causes the el ement cache matchi ng key to
contai n the user's database connecti on.

To Limit Element Caches by Database Connection

1. In D evel oper, l og i nto a proj ect. You must l og i n w i th a user

account that has admi ni strati ve pri vi l eges.

2. From the A dministration menu, poi nt to Projects, and then

sel ect Project C onfiguration.

3. Expand C aching, expand A uxiliary C aches, then cl i ck

Elements.

4. Sel ect the C reate element caches per connection map check
box.

The new s etting tak es affec t only after the projec t is reloaded or
after Intelligenc e Serv er is res tarted.

For more i nformati on about connecti on mappi ng, see C ontrol l i ng

Access to the D atabase: C onnecti on Mappi ngs, page 121.

Us ers may c onnec t to the data warehous e us ing their link ed warehous e
logins , as des c ribed below.

Limiting Element Caches by Database Login

Thi s setti ng al l ow s you to ensure that users w i th di fferent data
w arehouse l ogi ns cannot share el ement caches. When thi s feature i s

933 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

used, the el ement cache matchi ng key contai ns the user's database
l ogi n. Onl y users w i th the same database l ogi n are abl e to share the
el ement caches. Before you enabl e thi s feature, you must confi gure
tw o i tems.

1. The user must have a Warehouse Login and Password

speci fi ed (sel ecti ng the Authenti cati on tab i n the U ser Edi tor).

2. The proj ect must be confi gured to U se linked warehouse login

for execution (i n the Proj ect C onfi gurati on Edi tor, sel ect the
Project definition: A dvanced category).

If both of these properti es are not set, the users w i l l use thei r
connecti on maps to connect to the database.

To Limit Element Caches by Database Login

1. In D evel oper, l og i nto a proj ect. You must l og i n w i th a user

account that has admi ni strati ve pri vi l eges.

2. From the A dministration menu, poi nt to Projects, and then

sel ect Project C onfiguration.

3. Expand C aching, expand A uxiliary C aches, then sel ect

Elements.

4. Sel ect the C reate element caches per passthrough login

check box.

The new s etting tak es affec t only after the projec t is reloaded or after
Intelligenc e Serv er is res tarted.

Deleting All Element Caches

You can purge (del ete) al l of the el ement caches for a proj ect on both
the D evel oper and Intel l i gence Server machi nes. Thi s does not del ete
el ement caches on other D evel oper machi nes. You cannot del ete onl y
certai n caches; they are al l del eted at the same ti me.

© 2019, M icr o St r at egy In c. 934

Syst em Ad m in ist r at io n Gu id e

If y ou are us ing a c lus tered Intelligenc e Serv er s etup, to purge the

element c ac he for a projec t, y ou mus t purge the c ac he from eac h node
of the c lus ter indiv idually .

Even after purgi ng el ement caches, reports and documents may

conti nue to di spl ay cached data. Thi s can occur because resul ts may
be cached at the report/document and obj ect l evel s i n addi ti on to at
the el ement l evel . To ensure that a re-executed report or document
di spl ays the most recent data, purge al l three caches. For i nstructi ons
on purgi ng resul t and obj ect caches, see Managi ng R esul t C aches,
page 878 and D el eti ng Obj ect C aches, page 940.

To Delete All Element Caches for a Project

1. In D evel oper, l og i nto a proj ect. You must l og i n w i th a user

account that has admi ni strati ve pri vi l eges.

2. From the A dministration menu, go to Projects > Project

C onfiguration > C aching > A uxiliary C aches > Elements.

3. C l i ck Purge N ow.

All element c ac hes are automatic ally purged whenev er s c hema is

updated.

Summary Table of Element Cache Settings

Many of the setti ngs that hel p make el ement cachi ng an effi ci ent use
of system resources are expl ai ned i n the secti ons above.

The fol l ow i ng tabl e l i sts al l Mi croStrategy's el ement cachi ng setti ngs.

Se tting For infor ma tion...

Maximum number of element s see Limiting the N umber of Elements D isplayed

t o display and C ac hed at a Time, page 925

935 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Se tting For infor ma tion...

A t t ribut e element number count see Limiting the N umber of Elements D isplayed
met hod and C ac hed at a Time, page 925

E lement cache - Max RA M see Limiting the Amount of Memory Available

usage (MB yt es) P roject for Element C ac hes , page 929

E lement cache - Max RA M see Limiting the Amount of Memory Available for
usage (MB yt es) Developer Element C ac hes , page 929

A pply securit y f ilt er t o element see Limiting W hic h Attribute Elements a U ser
browsing c an See, page 931

Creat e caches per connect ion see Limiting Element C aches by D atabase
map C onnec tion, page 933

Creat e caches per passt hrough

see Loc ation of R esult C aches, page 866
login

P urge element caches see D eleting All Element C aches, page 934

Object Caches
When you or any users brow se an obj ect defi ni ti on (attri bute, metri c,
and so on), you create w hat i s cal l ed an obj ect cache. An obj ect
cache i s a recentl y used obj ect defi ni ti on stored i n memory on
D evel oper and Intel l i gence Server. You brow se an obj ect defi ni ti on
w hen you open the edi tor for that obj ect. You can create obj ect
caches for appl i cati ons.

For exampl e, w hen a user opens the R eport Edi tor for a report, the
col l ecti on of attri butes, metri cs, and other user obj ects di spl ayed i n
the R eport Edi tor compose the report's defi ni ti on. If no obj ect cache
for the report exi sts i n memory on D evel oper or Intel l i gence Server,
the obj ect request i s sent to the metadata for processi ng.

The report obj ect defi ni ti on retri eved from the metadata and di spl ayed
to the user i n the R eport Edi tor i s deposi ted i nto an obj ect cache i n

© 2019, M icr o St r at egy In c. 936

Syst em Ad m in ist r at io n Gu id e

memory on Intel l i gence Server and al so on the D evel oper of the user
w ho submi tted the request. As w i th el ement cachi ng, any ti me the
obj ect defi ni ti on can be returned from memory i n ei ther the D evel oper
or Intel l i gence Server machi ne, i t i s faster than retri evi ng i t from the
metadata database.

So w hen a D evel oper user tri ggers an obj ect request, the cache
w i thi n the D evel oper machi ne's memory i s checked fi rst. If i t i s not
there, the Intel l i gence Server memory i s checked. If the cache i s not
even there, the resul ts are retri eved from the metadata database.
Each opti on i s successi vel y sl ow er than the previ ous. If a
Mi croStrategy Web product user tri ggers an obj ect request, onl y the
Intel l i gence Server cache i s checked before getti ng the resul ts from
the metadata database.

Thi s secti on di scusses the fol l ow i ng topi cs concerni ng obj ect

cachi ng:

l C ache Matchi ng Al gori thm, page 937

l Enabl i ng or D i sabl i ng Obj ect C achi ng, page 938

l Li mi ti ng the Amount of Memory Avai l abl e for Obj ect C aches, page
938

l D el eti ng Obj ect C aches, page 940

l Summary Tabl e of Obj ect C achi ng Setti ngs, page 941

Cache Matching Algorithm

For an obj ect cache to be used, the cache must be val i d, and i t must
match the j ob bei ng executed. The fol l ow i ng cache keys are used i n
the matchi ng process:

l Obj ect ID

l Obj ect versi on ID

l Proj ect ID

937 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Enabling or Disabling Object Caching

Obj ect cachi ng i s enabl ed by defaul t w hen the Mi croStrategy system
i s fi rst i nstal l ed. Obj ect cachi ng cannot be di sabl ed. Intel l i gence
Server must mai ntai n a mi ni mum amount of memory (1 MB) avai l abl e
for the obj ect caches to operate effi ci entl y.

Limiting the Amount of Memory Available for Object

Caches
You can control the amount of memory that obj ect caches can use on
both Intel l i gence Server (set at the proj ect l evel ) and the D evel oper
machi nes. Thi s memory i s referred to as the cache pool . If a new
obj ect request si ze i s smal l enough to fi t i nto the obj ect cache pool ,
but there i s not enough avai l abl e cache pool space to store al l of the
new obj ects, exi sti ng obj ects must be removed from memory before
the new ones can be cached. When thi s happens, the l east recentl y
used 25% of obj ect caches are removed from the cache.

Thi s setti ng depends on the fol l ow i ng factors:

l Si ze of the proj ect i n terms of appl i cati on obj ects

l The amount of R AM on the Intel l i gence Server machi ne

For a projec t that has a large s c hema objec t, the projec t loading s peed
s uffers if the max imum memory for objec t c ac he s etting is not large
enough. This is s ue is rec orded in the D S S E rr o r s . l o g file. See
Mic roStrategy Tec h Note TN4205 for more information.

You mai ntai n obj ect cachi ng by usi ng the Server: Maximum R A M
usage (MB ytes) setti ng i n the C achi ng: Auxi l i ary C aches (Obj ects)
subcategory i n the Proj ect C onfi gurati on Edi tor. On the cl i ent
machi ne, you mai ntai n obj ect cachi ng by usi ng the C lient: Maximum
R A M usage (MB ytes) setti ng i n the C achi ng: Auxi l i ary C aches
(Obj ects) subcategory i n the Proj ect C onfi gurati on Edi tor.

© 2019, M icr o St r at egy In c. 938

Syst em Ad m in ist r at io n Gu id e

The defaul t val ues for Server: Maximum R A M U sage and C lient:
Maximum R A M U sage are 50 MB. Intel l i gence Server esti mates that
each obj ect consumes 5 KB of the cache pool , so by defaul t i t caches
10,240 obj ects i n server memory and 10,240 obj ects i n cl i ent memory.

To Set the RAM Available for Object Caches for a Project

1. In D evel oper, l og i nto a proj ect. You must l og i n w i th a user

account that has admi ni strati ve pri vi l eges.

2. From the A dministration menu, poi nt to Projects, and then

sel ect Project C onfiguration.

3. Expand C aching, expand A uxiliary C aches, then sel ect

Objects.

4. Speci fy the R AM (i n megabytes) i n the Server secti on i n the

Maximum R A M usage (MB ytes) box.

5. Speci fy the R AM (i n megabytes) i n the C l i ent secti on i n the

Maximum R A M usage (MB ytes) box.

The new s ettings tak e affec t only after Intelligenc e Serv er is res tarted.

To Set the RAM Available for Object Caches for a Developer

Machine

1. In the Proj ect Source Manager, cl i ck the C aching tab and i n the
Obj ect C ache group of control s, sel ect the U se custom value
opti on.

If y ou s elec t the U se project default option, the amount of RAM

is the s ame as s pec ified in the Client s ec tion in the Projec t
Configuration Editor des c ribed abov e.

939 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

2. Speci fy the R AM (i n megabytes) i n the Maximum R A M usage

(MB ytes) box.

Deleting Object Caches

You can purge (del ete) al l of the obj ect caches for a proj ect on both
the D evel oper and Intel l i gence Server machi nes. H ow ever, thi s does
not del ete obj ect caches on other D evel oper machi nes. You cannot
sel ect to del ete onl y certai n obj ect caches; they are al l del eted at the
same ti me.

Even after purgi ng obj ect caches, reports and documents may
conti nue to di spl ay cached data. Thi s can occur because resul ts may
be cached at the report/document and el ement l evel s, i n addi ti on to at
the obj ect l evel . To ensure that a re-executed report or document
di spl ays the most recent data, purge al l three caches. For i nstructi ons
on purgi ng resul t and el ement caches, see Managi ng R esul t C aches,
page 878 and D el eti ng Al l El ement C aches, page 934.

To Delete All Object Caches for a Project

1. In D evel oper, l og i nto a proj ect. You must l og i n w i th a user

account that has admi ni strati ve pri vi l eges.

2. From the A dministration menu, go to Projects > Project

C onfiguration > C aching > A uxiliary C aches > Objects.

3. C l i ck Purge N ow.

Objec t c ac hes are automatic ally purged whenev er y our s c hema is

updated.

C onfi gurati on obj ects are cached at the server l evel . You can choose
to del ete these obj ect caches as w el l .

© 2019, M icr o St r at egy In c. 940

Syst em Ad m in ist r at io n Gu id e

To Delete All Configuration Object Caches for a Server

1. Log i n to the proj ect source.

2. From the A dministration menu i n D evel oper, go to Server >

Purge Server Object C aches.

You cannot automati cal l y schedul e the purgi ng of server obj ect
caches from w i thi n D evel oper. H ow ever, you can compose a
C ommand Manager scri pt to purge server obj ect caches and schedul e
that scri pt to execute at certai n ti mes. For a descri pti on of thi s
process, see Mi croStrategy Tech N ote TN 12270. For more i nformati on
about C ommand Manager, see C hapter 15, Automati ng Admi ni strati ve
Tasks w i th C ommand Manager.

Summary Table of Object Caching Settings

Many of the setti ngs that hel p make obj ect cachi ng an effi ci ent use of
system resources are expl ai ned i n the secti ons above. The tabl e
bel ow l i sts al l Mi croStrategy obj ect cachi ng setti ngs.

Se tting For infor ma tion...

Object cache - Max RA M usage

(MB yt es) S ee Limiting the Amount of Memory Av ailable
for Objec t C ac hes , page 938
P roject level

Object cache - Max RA M usage S ee Limiting the Amount of Memory Av ailable

(MB yt es) Developer for Objec t C ac hes , page 938

P urge object caches S ee D eleting Objec t C aches, page 940

Viewing Document Cache Hits

You can vi ew document cache hi t data usi ng the D i agnosti cs and
Performance Loggi ng Tool . There are four performance counters

941 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

avai l abl e for retri evi ng thi s i nformati on:

l D ocument C ache U tilization R atio: N umber of document cache

fi l es w hi ch have been hi t / total number of document cache fi l es.

l D ocument C ache H it R atio: N umber of ti mes a document cache i s

found successful l y / total ti mes of fi ndi ng document cache.

l Total size (in MB ) of high priority document caches loaded in

memory: The total hi gh-pri ori ty document cache si ze i n Intel l i gence
Server memory.

l Total size (in MB ) of low priority document caches loaded in

memory: The total l ow -pri ori ty document cache si ze i n Intel l i gence
Server memory.

To enabl e these performance counters:

1. Launch the D iagnostics and Performance Logging Tool.

2. Sel ect the Performance C onfiguration tab.

3. Scrol l to the MicroStrategy Server Jobs category.

4. Sel ect the File Log check box for the counters.

The l og counters w i l l be saved i n the performance moni tor l og fi l e:

DSSP er fo rm a n c e M o n i t o r < I S e r v e r P r o c e s s I D > . c s v

© 2019, M icr o St r at egy In c. 942

 11
M ANAGING I NTELLIGENT
CUBES

© 2019, M icr o St r at egy In c. 943

Syst em Ad m in ist r at io n Gu id e

You can return data from your data w arehouse and save i t to
Intel l i gence Server memory, rather than di rectl y di spl ayi ng the resul ts
i n a report. Thi s data can then be shared as a si ngl e i n-memory copy,
among many di fferent reports created by mul ti pl e users. The reports
created from the shared sets of data are executed agai nst the i n-
memory copy, al so know n as an Intel l i gent C ube, rather than havi ng
to be executed agai nst a data w arehouse.

Intel l i gent C ubes are part of the OLAP Servi ces feature i n Intel l i gence
Server. For detai l ed i nformati on about Intel l i gent C ubes, see the In-
memory Anal yti cs Gui de.

Thi s secti on contai ns the fol l ow i ng i nformati on:

l Managi ng Intel l i gent C ubes: Intel l i gent C ube Moni tor, page 944

l Governi ng Intel l i gent C ube Memory U sage, Loadi ng, and Storage,
page 954

l Supporti ng C onnecti on Mappi ngs i n Intel l i gent C ubes, page 969

Managing Intelligent Cubes: Intelligent Cube

Monitor
You must create Intel l i gent C ubes before they can be publ i shed. For
i nformati on on creati ng Intel l i gent C ubes, see the In-memory
Anal yti cs Gui de.

Once an Intel l i gent C ube has been publ i shed, you can manage i t from
the Intel l i gent C ube Moni tor. You can vi ew detai l s about your
Intel l i gent C ubes such as l ast update ti me, hi t count, memory si ze,
and so on.

944 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To View the Available Intelligent Cubes

1. In D evel oper, l og i n to a proj ect source. You must l og i n as a

user w i th the Moni tor C ubes pri vi l ege.

2. Expand A dministration, then expand System Monitors,

C aches, and then sel ect Intelligent C ubes. Informati on about
the exi sti ng Intel l i gent C ubes di spl ays on the ri ght-hand si de.

3. To vi ew the detai l s of an Intel l i gent C ube, doubl e-cl i ck that

Intel l i gent C ube. A Qui ck Vi ew w i ndow opens, w i th detai l ed
i nformati on about the Intel l i gent C ube.

4. To change the status of an Intel l i gent C ube, ri ght-cl i ck that

Intel l i gent C ube and sel ect the desi red acti on from the l i st. For a
descri pti on of al l Intel l i gent C ube statuses, see Moni tori ng and
Modi fyi ng Intel l i gent C ube Status, page 947.

Viewing Intelligent Cube Information and Usage

Statistics
The Intel l i gent C ube Moni tor provi des i nformati on about publ i shed
Intel l i gent C ubes, as w el l as Intel l i gent C ube usage stati sti cs. The
Intel l i gent C ube Moni tor i s show n i n the i mage bel ow .

You can vi ew the fol l ow i ng i nformati on i n the Intel l i gent C ube

Moni tor:

© 2019, M icr o St r at egy In c. 945

Syst em Ad m in ist r at io n Gu id e

l C ube R eport N ame: The name of the Intel l i gent C ube.

l Project N ame: The proj ect the Intel l i gent C ube bel ongs to.

l Status: The current status of the Intel l i gent C ube. For i nformati on
on revi ew i ng and modi fyi ng the status of an Intel l i gent C ube, see
Moni tori ng and Modi fyi ng Intel l i gent C ube Status, page 947.

l Last U pdate Time: The ti me w hen the Intel l i gent C ube w as l ast
updated agai nst the data w arehouse.

l Last U pdate Job: The j ob number that most recentl y updated the
Intel l i gent C ube agai nst the data w arehouse. You can use the Job
Moni tor to vi ew i nformati on on a gi ven j ob.

l C reation Time: The ti me w hen the Intel l i gent C ube w as fi rst

publ i shed to Intel l i gence Server.

l Size (K B ): The si ze of the Intel l i gent C ube, i n ki l obytes.

l H it C ount: The number of ti mes the Intel l i gent C ube has been used
by reports si nce i t w as l ast l oaded i nto Intel l i gence Server's
memory. You can reset the H i t C ount to zero by unl oadi ng the
Intel l i gent C ube from Intel l i gence Server's memory.

l H istoric H it C ount: The total number of ti mes the Intel l i gent C ube
has been used by reports. You can reset the H i stori c H i t C ount to
zero by del eti ng the Intel l i gent C ube's cache, and then republ i shi ng
the Intel l i gent C ube.

l Open View C ount: The number of reports currentl y accessi ng the

Intel l i gent C ube.

l Owner: The user w ho publ i shed the Intel l i gent C ube.

l D atabase connection: The database connecti on account used for

the Intel l i gent C ube to run agai nst the data w arehouse.

946 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l File N ame: The fi l e l ocati on w here the Intel l i gent C ube i s saved to
the machi ne's secondary storage.

l C ube Instance ID : The ID for the current publ i shed versi on of the
Intel l i gent C ube.

l C ube D efinition ID : The ID for the Intel l i gent C ube obj ect.

l D ata Language: The l anguage used for the Intel l i gent C ube. Thi s i s
hel pful i f the Intel l i gent C ube i s used i n an i nternati onal i zed
envi ronment that supports mul ti pl e l anguages.

l Total number of rows: The number of row s of data that the

Intel l i gent C ube contai ns. To vi ew thi s fi el d, the Intel l i gent C ube
must be publ i shed at l east once.

l Total number of columns: The number of col umns of data that the
Intel l i gent C ube contai ns. To vi ew thi s fi el d, the Intel l i gent C ube
must be publ i shed at l east once.

You can al so vi ew Intel l i gent C ube i nformati on for a speci fi c

Intel l i gent C ube, by doubl e-cl i cki ng that Intel l i gent C ube i n the
Intel l i gent C ube Moni tor. Thi s opens a Qui ck Vi ew of the Intel l i gent
C ube i nformati on and usage stati sti cs.

Monitoring and Modifying Intelligent Cube Status

The status of an Intel l i gent C ube tel l s you how the Intel l i gent C ube i s
currentl y bei ng used and w hether reports can access the Intel l i gent
C ube. To modi fy the status of an Intel l i gent C ube, ri ght-cl i ck the
Intel l i gent C ube i n the Intel l i gent C ube Moni tor, and sel ect one of the
acti ons l i sted bel ow :

© 2019, M icr o St r at egy In c. 947

Syst em Ad m in ist r at io n Gu id e

Re quir e d
Ac tion Sta tus to De s c r iption
Pe r for m Ac tion

Filed, but not Loads a previously deact ivat ed I nt elligent Cube as an

A ct ivat e
A ct ive accessible set of dat a f or mult iple report s.

Removes an I nt elligent Cube inst ance f rom

Deact ivat e A ct ive I nt elligence S erver memory, but saves it t o secondary
st orage, such as a hard disk.

Re-execut es and publishes an I nt elligent Cube. When

t he dat a f or an I nt elligent Cube is modif ied and
Updat e A ct ive
saved, t he Updat e act ion updat es t he I nt elligent
Cube wit h t he lat est dat a.

S aves an I nt elligent Cube t o secondary st orage, and

keeps t he I nt elligent Cube in I nt elligence S erver
memory.
S ave t o
Loaded I f you have def ined t he backup f requency as zero
disk
minut es, I nt elligent Cubes are aut omat ically saved t o
secondary st orage, as described in Storing Intelligent
C ubes in Sec ondary Storage, page 967 .

Removes a published I nt elligent Cube as an

accessible set of dat a f or mult iple report s.

This act ion does not delet e t he I nt elligent Cube

object saved in a MicroS t rat egy project . To
A lways delet e an I nt elligent Cube object , you must log
Delet e
available int o t he project cont aining t he I nt elligent Cube
and delet e it t here.

For inf ormat ion on whet her you should deact ivat e or
unpublish an I nt elligent Cube, see D eactiv ating or
U npublis hing an Intelligent C ube, page 950 .

Moves an I nt elligent Cube f rom your machine's

Load in A ct ive, but not
secondary st orage t o I nt elligence S erver memory. For
memory Loaded
inf ormat ion on when t o load and unload I nt elligent

948 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Re quir e d
Ac tion Sta tus to De s c r iption
Pe r for m Ac tion

Cubes, see Loading and U nloading Intelligent C ubes,

page 951 .

I f t he memory limit is reached, t his act ion

unloads a previously loaded I nt elligent Cube
f rom I nt elligence S erver memory.

Moves an I nt elligent Cube f rom I nt elligence S erver

Unload memory t o your machine's secondary st orage, such
f rom Loaded as a hard disk. For inf ormat ion on when t o load and
memory unload I nt elligent Cubes, see Loading and U nloading
Intelligent C ubes , page 951 .

Addi ti onal statuses such as Processi ng and Load Pendi ng are al so

used by the Intel l i gent C ube Moni tor. These statuses denote that
certai n tasks are currentl y bei ng compl eted.

Addi ti onal l y, i f you have defi ned the backup frequency as greater than
zero mi nutes (as descri bed i n Stori ng Intel l i gent C ubes i n Secondary
Storage, page 967), the fol l ow i ng addi ti onal statuses can be
encountered:

l D irty: Thi s status occurs i f the copy of an Intel l i gent C ubes data i n
secondary storage i s not up to date w i th data i n Intel l i gence Server
memory. Thi s can occur i f an Intel l i gent C ube i s updated i n
Intel l i gence Server memory but the new data i s not saved to
secondary storage.

l Monitoring information dirty: Thi s status occurs i f Intel l i gent C ube

moni tori ng i nformati on changes, and thi s i nformati on i s not updated
i n secondary storage. Moni tori ng i nformati on i ncl udes detai l s such
as the number of reports that have accessed the Intel l i gent C ube.

© 2019, M icr o St r at egy In c. 949

Syst em Ad m in ist r at io n Gu id e

In both scenari os l i sted above, the data and moni tori ng i nformati on
saved i n secondary storage for an Intel l i gent C ube i s updated based
on the backup frequency. You can al so manual l y save an Intel l i gent
C ube to secondary storage usi ng the Save to di sk acti on l i sted i n the
tabl e above, or by usi ng the steps descri bed i n Stori ng Intel l i gent
C ubes i n Secondary Storage, page 967.

Deact ivat in g o r Un p u b lish in g an In t elligen t Cu b e

Both deacti vati ng and unpubl i shi ng an Intel l i gent C ube prevent
reports that access an Intel l i gent C ube from bei ng abl e to l oad the
Intel l i gent C ube i nto Intel l i gence Server memory. Thi s gi ves you more
admi ni strati ve control of w hen to make an Intel l i gent C ube avai l abl e
to reports.

H ow ever, each of these acti ons provi des thi s admi ni strati ve control i n
sl i ghtl y di fferent w ays that can fi t di fferent scenari os.

D eactivating an Intel l i gent C ube saves the Intel l i gent C ube to

secondary storage, such as a hard di sk. When you reacti vate the
Intel l i gent C ube, the copy i n secondary storage i s l oaded back i nto
Intel l i gence Server memory. Thi s opti on i s i deal w hen an Intel l i gent
C ube shoul d not be used for some l ength of ti me, but after that shoul d
be avai l abl e agai n i n i ts current form.

U npublishing an Intel l i gent C ube del etes the copy of data from
Intel l i gence Server memory w i thout maki ng a copy of the data. To
make the Intel l i gent C ube accessi bl e to reports, the Intel l i gent C ube
must be re-executed agai nst the data w arehouse and publ i shed to the
Intel l i gent C ube Moni tor. Thi s opti on i s i deal i f the current Intel l i gent
C ube shoul d not be reported on unti l i t i s re-executed agai nst the data
w arehouse.

95 0 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Lo ad in g an d Un lo ad in g In t elligen t Cu b es
When an Intel l i gent C ube i s publ i shed, by defaul t, i t i s automati cal l y
l oaded i nto Intel l i gence Server memory.

Intel l i gent C ubes must be l oaded i n Intel l i gence Server memory to

al l ow reports to access the data i n the Intel l i gent C ube. If an
Intel l i gent C ube i s constantl y i n use, i t shoul d be l oaded i n
Intel l i gence Server memory.

U si ng the Intel l i gent C ube Moni tor you can l oad an Intel l i gent C ube
i nto Intel l i gence Server memory, or unl oad i t to secondary storage,
such as a di sk dri ve.

By defaul t, Intel l i gent C ubes are l oaded w hen Intel l i gent C ubes are
publ i shed and w hen Intel l i gence Server starts. To change these
behavi ors, see:

l Publ i shi ng Intel l i gent C ubes Wi thout Loadi ng Them i nto

Intel l i gence Server Memory, page 952

l Loadi ng Intel l i gent C ubes w hen Intel l i gence Server Starts, page
965

l If loading an Intelligent Cube into Intelligenc e Serv er memory c aus es

the memory limit to be ex c eeded, a different Intelligent Cube is
unloaded from Intelligenc e Serv er memory .

l The ac t of loading an Intelligent Cube c an require memory res ourc es

up to twic e the s iz e of an Intelligent Cube. This c an affec t
performanc e of y our Intelligenc e Serv er as well as the ability to load
the Intelligent Cube. For information on how to plan for thes e memory
requirements , s ee Governi ng Intel l i gent C ube Memory U sage,
page 955 .

One w ay to free memory on Intel l i gence Server, w hi ch can i mprove

Intel l i gence Server performance, i s to temporari l y unl oad an
Intel l i gent C ube from memory. Thi s can be a good opti on for

© 2019, M icr o St r at egy In c. 95 1

Syst em Ad m in ist r at io n Gu id e

Intel l i gent C ubes that are not constantl y i n use, because w hen a
report accessi ng an acti ve but unl oaded Intel l i gent C ube i s executed,
that Intel l i gent C ube i s automati cal l y l oaded i nto Intel l i gence Server
memory. Be aw are that i f the Intel l i gent C ube i s very l arge there may
be some del ay i n di spl ayi ng report resul ts w hi l e the Intel l i gent C ube
i s bei ng l oaded i nto memory. For more suggesti ons on how to manage
Intel l i gence Server's memory usage, see C hapter 8, Tuni ng Your
System for Best Performance.

Publishing Intelligent Cubes Without Loading Them into Intelligence

Server Memory

By defaul t, Intel l i gent C ubes are automati cal l y l oaded i nto

Intel l i gence Server memory so that reports can access and anal yze
thei r data.

To conserve Intel l i gence Server memory, you can defi ne Intel l i gent
C ubes to onl y be stored i n secondary storage w hen the Intel l i gent
C ube i s publ i shed. The Intel l i gent C ube can then be l oaded i nto
Intel l i gence Server memory manual l y, usi ng a schedul e, or w henever
a report attempts to access the Intel l i gent C ube.

The steps bel ow show you how to defi ne w hether publ i shi ng
Intel l i gent C ubes l oads them i nto Intel l i gence Server memory. You
can enabl e thi s setti ng at the proj ect l evel , or for i ndi vi dual Intel l i gent
C ubes.

To Define Whether Publishing Intelligent Cubes Loads Them into

Intelligence Server Memory, at the Project Level

1. In D evel oper, l og i n to a proj ect usi ng an account w i th

admi ni strati ve pri vi l eges.

2. R i ght-cl i ck the proj ect and sel ect Project C onfiguration.

3. Expand Intelligent C ubes, then sel ect General .

95 2 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

4. You can sel ect or cl ear the Load Intelligent C ubes into
Intelligence Server memory upon publication check box:

l Sel ect thi s check box to l oad Intel l i gent C ubes i nto Intel l i gence
Server memory w hen the Intel l i gent C ube i s publ i shed.
Intel l i gent C ubes must be l oaded i nto Intel l i gence Server
memory to al l ow reports to access and anal yze thei r data.

l To conserve Intel l i gence Server memory, you can cl ear thi s

check box to defi ne Intel l i gent C ubes to onl y be stored i n
secondary storage upon bei ng publ i shed. The Intel l i gent C ube
can then be l oaded i nto Intel l i gence Server memory manual l y,
usi ng schedul es, or w henever a report attempts to access the
Intel l i gent C ube.

If y ou are us ing multiple Intelligenc e Serv ers in a c lus tered

env ironment, this s etting applies to all nodes .

5. C l i ck OK .

6. For any changes to take effect, you must restart Intel l i gence
Server. For cl ustered envi ronments, separate the restart ti mes for
each Intel l i gence Server by a few mi nutes.

To Define Whether Publishing Intelligent Cubes Loads Them into

Intelligence Server Memory, at the Intelligent Cube Level

1. In D evel oper, l og i n to a proj ect usi ng an account w i th

admi ni strati ve pri vi l eges.

2. In the Fol der Li st, brow se to the fol der that contai ns the
Intel l i gent C ube you w ant to confi gure.

3. R i ght-cl i ck the Intel l i gent C ube, and choose Edit.

4. From the D ata menu, sel ect C onfigure Intelligent C ube.

5. U nder the Options category, sel ect General.

© 2019, M icr o St r at egy In c. 95 3

Syst em Ad m in ist r at io n Gu id e

6. C l ear U se default project-level settings.

7. Sel ect or cl ear the Load Intelligent C ubes into Intelligence

Server memory upon publication check box:

l Sel ect thi s check box to l oad the Intel l i gent C ube i nto
Intel l i gence Server memory w hen the Intel l i gent C ube i s
publ i shed. Intel l i gent C ubes must be l oaded i nto Intel l i gence
Server memory to al l ow reports to access and anal yze thei r
data.

l To conserve Intel l i gence Server memory, cl ear thi s check box

to defi ne Intel l i gent C ubes to onl y be stored i n secondary
storage upon bei ng publ i shed. The Intel l i gent C ube can then
be l oaded i nto Intel l i gence Server memory manual l y, usi ng
schedul es, or w henever a report attempts to access the
Intel l i gent C ube.

If y ou are us ing multiple Intelligenc e Serv ers in a c lus tered

env ironment, this s etting applies to all nodes .

8. C l i ck OK .

9. In the Intel l i gent C ube Edi tor, cl i ck Save and C lose.

10. R estart Intel l i gence Server. For cl ustered envi ronments,

separate the restart ti mes for each Intel l i gence Server by a few
mi nutes.

Governing Intelligent Cube Memory Usage,

Loading, and Storage
Intel l i gent C ubes must be stored i n Intel l i gence Server memory for
reports to access thei r data. Whi l e thi s can i mprove performance of
these reports, l oadi ng too much data onto Intel l i gence Server memory
can have a negati ve i mpact on Intel l i gence Server's abi l i ty to process

95 4 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

j obs. For thi s reason, i t i s i mportant to govern how much Intel l i gent
C ube data can be stored on Intel l i gence Server.

Intel l i gent C ube data can al so be stored i n secondary storage, such

as a hard di sk, on the machi ne hosti ng Intel l i gence Server. These
Intel l i gent C ubes can be l oaded i nto memory w hen they are needed.
For more i nformati on, see Moni tori ng and Modi fyi ng Intel l i gent C ube
Status, page 947.

l Governi ng Intel l i gent C ube Memory U sage, page 955

l Loadi ng Intel l i gent C ubes w hen Intel l i gence Server Starts, page
965

l Stori ng Intel l i gent C ubes i n Secondary Storage, page 967

Governing Intelligent Cube Memory Usage

Intel l i gent C ubes must be stored i n Intel l i gence Server memory for
reports to access the data. Whi l e thi s can i mprove performance of
these reports, l oadi ng too much data onto Intel l i gence Server memory
can negati vel y affect Intel l i gence Server's abi l i ty to process j obs. For
thi s reason, i t i s i mportant to l i mi t how much Intel l i gent C ube data can
be stored on Intel l i gence Server.

Det er min in g Memo r y Limit s f o r In t elligen t Cu b es

Stori ng Intel l i gent C ubes can greatl y i mprove performance by
al l ow i ng reports to execute agai nst an i n memory copy of data.
H ow ever, stori ng too much Intel l i gent C ube data i n memory can cause
other Intel l i gence Server processes to compete for system resources
and may cause degradati ons i n performance. Thi s makes defi ni ng a
memory l i mi t for Intel l i gent C ubes an i mportant step i n mai ntai ni ng
Intel l i gence Server response ti me.

An Intel l i gent C ube memory l i mi t defi nes the maxi mum amount of
R AM of the Intel l i gence Server machi ne that can be used to store

© 2019, M icr o St r at egy In c. 95 5

Syst em Ad m in ist r at io n Gu id e

l oaded Intel l i gent C ubes. Thi s data i s al l ocated separatel y of memory

used for other Intel l i gence Server processes.

For exampl e, you defi ne a memory l i mi t on Intel l i gent C ubes to be

512 MB. You have 300 MB of Intel l i gent C ube data l oaded i nto
Intel l i gence Server memory, and normal processi ng of other
Intel l i gence Server tasks uses 100 MB of memory. In thi s scenari o,
Intel l i gence Server uses 400 MB of the R AM avai l abl e on the
Intel l i gence Server machi ne. Thi s scenari o demonstrates that to
determi ne a memory l i mi t for Intel l i gent C ubes, you must consi der the
bel ow factors:

l The amount of R AM avai l abl e on the Intel l i gence Server machi ne,
and of that R AM w hat percentage can be used by Intel l i gence
Server w i thout negati vel y affecti ng performance and successful
operati on of the host machi ne.

l The average and peak usage of R AM by Intel l i gence Server

processes other than Intel l i gent C ube storage. For i nformati on on
setti ng governi ng l i mi ts on other Intel l i gence Server processes and
moni tori ng system usage, Governi ng Intel l i gent C ube Memory
U sage, Loadi ng, and Storage.

l The amount of memory requi red to l oad al l Intel l i gent C ubes

necessary to meet reporti ng requi rements. To hel p save space,
Intel l i gent C ubes that are not used often can be unl oaded unti l they
are requi red by reports (see Moni tori ng and Modi fyi ng Intel l i gent
C ube Status, page 947).

l The Maxi mum R AM usage (Mbytes) memory l i mi t can be defi ned per
proj ect. If you have mul ti pl e proj ects that are hosted from the same
Intel l i gence Server, each proj ect may store Intel l i gent C ube data up
to i ts memory l i mi t.

l For exampl e, you have three proj ects and you set thei r Maxi mum
R AM usage (Mbytes) l i mi ts to 1 GB, 1 GB, and 2 GB. Thi s means

95 6 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

that 4 GB of Intel l i gent C ube data coul d be stored i n R AM on the

Intel l i gence Server machi ne i f al l proj ects reach thei r memory l i mi ts.

l The si ze of the Intel l i gent C ubes that are bei ng publ i shed and
l oaded i nto memory. The process of publ i shi ng an Intel l i gent C ube
can requi re memory resources i n the area of tw o to four ti mes
greater than the Intel l i gent C ube's si ze. Thi s can affect performance
of your Intel l i gence Server and the abi l i ty to publ i sh the Intel l i gent
C ube. For i nformati on on how to pl an for these memory
requi rements, see the next secti on.

l If your proj ect and Intel l i gent C ubes support mul ti pl e l anguages,
each l anguage supported may requi re addi ti onal memory.

l To hel p reduce Intel l i gent C ube memory si ze, revi ew the best
practi ces descri bed i n Best Practi ces for R educi ng Intel l i gent C ube
Memory Si ze, page 957.

Best Pr act ices f o r Red u cin g In t elligen t Cu b e Memo r y Size

Mi croStrategy recommends the fol l ow i ng best practi ces to reduce the
memory si ze of your Intel l i gent C ubes:

l Attri butes commonl y use numeri c val ues for thei r ID forms. U si ng
attri butes defi ned i n thi s w ay can save space as compared to
attri butes that use character stri ngs for thei r ID forms.

l Attri bute forms shoul d be i ncl uded onl y as requi red because
i ncl udi ng addi ti onal attri bute forms i n Intel l i gent C ubes requi res
addi ti onal memory.

l You shoul d avoi d i ncl udi ng compound metri cs and smart metri cs i n
Intel l i gent C ubes. The same resul ts provi ded by compound metri cs
and smart metri cs can often be provi ded by creati ng deri ved metri cs
i n reports that connect to Intel l i gent C ubes.

© 2019, M icr o St r at egy In c. 95 7

Syst em Ad m in ist r at io n Gu id e

l You can defi ne Intel l i gent C ube normal i zati on to reduce the amount
of memory requi red for an Intel l i gent C ube. Intel l i gent C ube
normal i zati on can be confi gured usi ng the D ata popul ati on for
Intel l i gent C ubes VLD B property. For i nstructi ons on setti ng VLD B
properti es, see SQL Generati on and D ata Processi ng: VLD B
Properti es.

Plan n in g f o r In t elligen t Cu b e Pu b lish in g an d Lo ad in g

Publ i shi ng an Intel l i gent C ube can requi re memory resources i n the
area of tw o to four ti mes greater than the si ze of an Intel l i gent C ube.
Once the Intel l i gent C ube i s publ i shed, the extra resources are
returned to the system and onl y the space requi red for the Intel l i gent
C ube and some i ndexi ng i nformati on i s taken up i n R AM. H ow ever,
you shoul d consi der thi s peak i n memory usage w hen pl anni ng for the
publ i cati on of Intel l i gent C ubes.

By default, publis hing an Intelligent Cube inc ludes the s tep of loading the
Intelligent Cube into memory . You c an modify this default behav ior as
des c ribed in Moni tori ng and Modi fyi ng Intel l i gent C ube Status,
page 947 . Loading and unloading Intelligent Cubes is des c ribed in
Moni tori ng and Modi fyi ng Intel l i gent C ube Status, page 947 .

If publ i shi ng an Intel l i gent C ube i s processed i n R AM al one w i thout

usi ng sw ap space, thi s can greatl y reduce the effect publ i shi ng an
Intel l i gent C ube has on the performance of your Intel l i gence Server
host machi ne. Sw ap space i s control l ed by the operati ng system of a
computer and usi ng thi s space for the transfer of data i nto R AM can
negati vel y affect the performance of a computer.

You can hel p to keep the processes of publ i shi ng Intel l i gent C ubes
w i thi n R AM al one by defi ni ng memory l i mi ts for Intel l i gent C ubes that
refl ect your Intel l i gence Server host's avai l abl e R AM as w el l as
schedul e the publ i shi ng of Intel l i gent C ubes at a ti me w hen R AM

95 8 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

usage i s l ow . For i nformati on on schedul i ng Intel l i gent C ube

publ i shi ng, see the In-memory Anal yti cs Gui de.

To determi ne memory l i mi ts for Intel l i gent C ubes, you shoul d revi ew

the consi derati ons l i sted i n D etermi ni ng Memory Li mi ts for Intel l i gent
C ubes, page 955. You must al so account for the potenti al peak i n
memory usage w hen publ i shi ng an Intel l i gent C ube, w hi ch can be tw o
to four ti mes the si ze of an Intel l i gent C ube.

For exampl e, your Intel l i gence Server machi ne has 2 GB of R AM and

2 GB of sw ap space. Assume that normal usage of R AM by the
operati ng system uses .4 GB of R AM. Thi s l eaves a possi bl e 1.6 GB
of R AM for Intel l i gent C ube storage and other tasks.

Wi th thi s confi gurati on, consi der the act of publ i shi ng a 1 GB
Intel l i gent C ube. Assumi ng the peak i n memory usage for publ i shi ng
thi s Intel l i gent C ube i s 2.5 ti mes the si ze of the Intel l i gent C ube, the
publ i shi ng process requi res 2.5 GB. Thi s can take up 1.6 GB of R AM,
but i t al so requi res .9 GB of sw ap space, as show n i n the di agram
bel ow .

Once the Intel l i gent C ube i s publ i shed, onl y the 1 GB for the
Intel l i gent C ube (pl us some space for i ndexi ng i nformati on) i s used i n
R AM and the remai ni ng .6 GB of R AM and .9 GB of sw ap space used
duri ng the publ i shi ng of the Intel l i gent C ube i s returned to the system,
as show n i n the i mage bel ow .

© 2019, M icr o St r at egy In c. 95 9

Syst em Ad m in ist r at io n Gu id e

Whi l e the Intel l i gent C ube can be publ i shed successful l y, usi ng the
sw ap space coul d have an affect on performance of the Intel l i gence
Server machi ne.

Wi th the same confi gurati on, consi der the act of publ i shi ng a .5 GB
Intel l i gent C ube rather than a 1 GB Intel l i gent C ube. Assumi ng the
peak i n memory usage for publ i shi ng thi s Intel l i gent C ube i s 2.5 ti mes
the si ze of the Intel l i gent C ube, the publ i shi ng process requi res 1.25
GB. Thi s process can be handl ed compl etel y w i thi n R AM, as show n i n
the di agram bel ow .

Once the Intel l i gent C ube i s publ i shed, onl y the .5 GB for the
Intel l i gent C ube (pl us some space for i ndexi ng i nformati on) i s used i n
R AM and the remai ni ng R AM used duri ng the publ i shi ng of the
Intel l i gent C ube i s returned to the system, as show n i n the i mage
bel ow .

960 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Be aw are that as more Intel l i gent C ube data i s stored i n R AM, l ess
R AM i s avai l abl e to process publ i shi ng an Intel l i gent C ube. Thi s
al ong w i th the peak memory usage of publ i shi ng an Intel l i gent C ube
and the hardw are resources of your Intel l i gence Server host machi ne
shoul d al l be consi dered w hen defi ni ng memory l i mi ts for Intel l i gent
C ube storage per proj ect.

Def in in g Memo r y Limit s f o r In t elligen t Cu b es

You can defi ne l i mi ts for the amount of Intel l i gent C ube memory
stored i n Intel l i gence Server at a gi ven ti me i n tw o w ays descri bed
bel ow :

l You can use the amount of data requi red for al l Intel l i gent C ubes to
l i mi t the amount of Intel l i gent C ube data stored i n Intel l i gence
Server memory at one ti me for a proj ect. The defaul t i s 256
megabytes.

The total amount of memory used on Intel l i gence Server by

Intel l i gent C ubes for a proj ect i s cal cul ated and compared to the
l i mi t you have defi ned. If an attempt to l oad an Intel l i gent C ube i s
made that w i l l exceed thi s l i mi t, an Intel l i gent C ube i s removed from
Intel l i gence Server memory before the new Intel l i gent C ube i s
l oaded i nto memory.

© 2019, M icr o St r at egy In c. 961

Syst em Ad m in ist r at io n Gu id e

l You can use the number of Intel l i gent C ubes to l i mi t the number of
Intel l i gent C ube stored i n Intel l i gence Server memory at one ti me
for a proj ect. The defaul t i s 1000 Intel l i gent C ubes.

The total number of Intel l i gent C ubes for a proj ect that are stored i n
Intel l i gence Server memory i s compared to the l i mi t you defi ne. If an
attempt to l oad an Intel l i gent C ube i s made that w i l l exceed the
numeri cal l i mi t, an Intel l i gent C ube i s removed from Intel l i gence
Server memory before the new Intel l i gent C ube i s l oaded i nto
memory.

To Define Limits on Intelligence Server Memory Usage by

Intelligent Cubes

1. In D evel oper, l og i n to a proj ect that uses Intel l i gent C ubes. You
must l og i n usi ng an account w i th the Admi ni ster C ubes
pri vi l ege.

2. R i ght-cl i ck the proj ect and sel ect Project C onfiguration.

3. Expand Intelligent C ubes, and then sel ect General.

4. D efi ne the val ues for the fol l ow i ng proj ect governi ng opti ons:

l Maximum R A M usage (MB ytes): D efi nes the data si ze, i n

megabytes, to l i mi t the amount of Intel l i gent C ube data that can
be stored i n Intel l i gence Server memory for a proj ect at one
ti me. The defaul t val ue i s 256 megabytes.

l Maximum number of cubes: D efi nes the maxi mum total

number of Intel l i gent C ubes that can be created for a proj ect,
i ncl udi ng Intel l i gent C ubes that are not l oaded i nto Intel l i gence
Server's memory. The defaul t val ue i s 1000 Intel l i gent C ubes.

l Maximum cube size allowed for download (MB ): D efi nes the
maxi mum si ze of a cube, i n megabytes. The defaul t i s 200.

5. C l i ck OK .

962 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Def in in g Limit s f o r In t elligen t Cu b e In d exes

Intel l i gence Server generates i ndexes to speed up access to data i n
Intel l i gent C ubes. In very l arge Intel l i gent C ubes, these i ndexes may
si gni fi cantl y i ncrease the si ze of the Intel l i gent C ube. You can defi ne
l i mi ts for how much the i ndexes can add to the si ze of the Intel l i gent
C ube at the proj ect l evel , usi ng the Proj ect C onfi gurati on Edi tor.

To Define Limits for the Intelligent Cube Indexes

1. In D evel oper, l og i n to the proj ect source for your proj ect.

2. In the Fol der Li st, ri ght-cl i ck the proj ect and choose Project
C onfiguration.

3. Expand Intelligent C ubes, and then sel ect General.

4. Edi t the fol l ow i ng val ues, as appropri ate:

l Maximum % growth of an Intelligent C ube due to indexes:

D efi nes the maxi mum that i ndexes are al l ow ed to add to the
Intel l i gent C ube's si ze, as a percentage of the ori gi nal si ze.
For exampl e, a setti ng of 50 percent defi nes that a 100 MB
Intel l i gent C ube can grow to 150 MB because i ts i ndexes. If the
Intel l i gent C ube's si ze exceeds thi s l i mi t, the l east-used
i ndexes are dropped from the Intel l i gent C ube.

l C ube growth check frequency (in mins): D efi nes, i n mi nutes,

how often the Intel l i gent C ube's si ze i s checked, and i f
necessary, how often the l east-used i ndexes are dropped.

5. C l i ck OK .

© 2019, M icr o St r at egy In c. 963

Syst em Ad m in ist r at io n Gu id e

Def in in g Limit s f o r In t elligen t Cu b es Cr eat ed u sin g t h e

Imp o r t Dat a Feat u r e
The Import D ata feature al l ow s users to create Intel l i gent C ubes usi ng
external data sources, such as Excel fi l es, tabl es i n a database, or
Freeform SQL queri es. You can defi ne l i mi ts on the si ze of fi l es that
users can upl oad, and on the total memory avai l abl e for the Intel l i gent
C ubes they can create.

To Define Limits on Intelligent Cubes Created Using the Import

Data Feature

1. In D evel oper, l og i n to a proj ect usi ng an account w i th the

Admi ni ster C ubes pri vi l ege.

2. In the Fol der Li st, ri ght-cl i ck on the proj ect and sel ect Project
C onfiguration.

3. Expand Governing R ules, expand D efault, and then sel ect

Import D ata.

4. D efi ne val ues for the fol l ow i ng opti ons:

l Maximum file size (MB ): D efi nes the maxi mum si ze for fi l es
that users can upl oad and i mport data from. The defaul t val ue
i s 30 MB. The mi ni mum val ue i s 1 MB, and the maxi mum val ue
i s 9999999 MB.

l Maximum quota per user (MB ): D efi nes the maxi mum si ze of
al l data i mport cubes for each i ndi vi dual user. Thi s quota
i ncl udes the fi l e si ze of al l data i mport cubes, regardl ess of
w hether they are publ i shed to memory or on di sk. You can set
the maxi mum si ze quota by enteri ng the fol l ow i ng val ues:

l -1: U nl i mi ted - N o l i mi t i s pl aced on the si ze of data i mport

cubes for each user.

964 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l 0: D efaul t - The defaul t si ze l i mi t of 100 MB i s appl i ed to

each user

l [1, ∞): Speci fi c l i mi t - Enteri ng a val ue of 1 or greater w i l l

appl y a MB l i mi t of that si ze to each user.

In a cl ustered envi ronment, thi s setti ng appl i es to al l nodes

i n the cl uster.

5. C l i ck OK .

Loading Intelligent Cubes when Intelligence Server

Starts
When Intel l i gence Server i s started there are vari ous tasks that are
processed to prepare a reporti ng envi ronment. You can i ncl ude
l oadi ng al l publ i shed Intel l i gent C ubes as one of the tasks compl eted
w hen Intel l i gence Server i s started. Thi s affects w hen the l oad ti me
requi red for Intel l i gent C ubes occurs.

The consi derati ons for w hether to l oad Intel l i gent C ubes at
Intel l i gence Server startup or w hen a report i s executed that accesses
a publ i shed Intel l i gent C ube are descri bed i n the tabl e bel ow .

Me thod Pr os Cons

l Report runt ime

l The overhead experienced
perf ormance f or report s
during I nt elligence S erver
accessing I nt elligent Cubes
st art up is increased due t o
is opt imized since t he
Loading t he processing of loading
I nt elligent Cube f or t he
I nt elligent Cubes I nt elligent Cubes.
report has already been
when I nt elligence loaded. l A ll I nt elligent Cubes f or a
S erver st art s project are loaded int o
l This pract ice is a good
I nt elligence S erver memory,
opt ion if I nt elligent Cubes
regardless of whet her t hey
are commonly used in a
are used by report s or not .
project .

© 2019, M icr o St r at egy In c. 965

Syst em Ad m in ist r at io n Gu id e

Me thod Pr os Cons

l The overhead experienced

during I nt elligence S erver
st art up is decreased as
compared t o including
l Report runt ime perf ormance
loading I nt elligent Cubes
f or report s accessing
as part of t he st art up t asks.
I nt elligent Cubes can be
Loading
l I f I nt elligent Cubes are not negat ively af f ect ed as t he
I nt elligent Cubes
required by any report s, I nt elligent Cube must f irst be
when a report is
t hen t hey do not need t o be loaded int o I nt elligence
execut ed t hat
loaded int o I nt elligence S erver.
accesses a
S erver and no overhead is
published
experienced. Y ou can also load I nt elligent
I nt elligent Cube
Cubes manually or wit h
l This pract ice is a good
subscript ions af t er
opt ion if I nt elligent Cubes
I nt elligence S erver is st art ed.
are support ed f or a project ,
but some of t he I nt elligent
Cubes are rarely used in
t he project .

The procedure bel ow descri bes how to enabl e or di sabl e l oadi ng

Intel l i gent C ubes w hen Intel l i gence Server starts.

The ac t of loading an Intelligent Cube c an require memory res ourc es in

the area of two times greater than the s iz e of an Intelligent Cube. This
c an affec t performanc e of y our Intelligenc e Serv er as well as the ability
to load the Intelligent Cube. For information on how to plan for thes e
memory requirements , s ee Governi ng Intel l i gent C ube Memory
U sage, page 955 .

966 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To Enable or Disable Loading Intelligent Cubes when Intelligence

Server Starts

1. In D evel oper, l og i n to a proj ect w i th a user account w i th

admi ni strati ve pri vi l eges.

2. R i ght-cl i ck the proj ect and sel ect Project C onfiguration.

3. Expand Intelligent C ubes, and then sel ect General.

4. Sel ect or cl ear the Load Intelligent cubes on startup check box
to enabl e or di sabl e l oadi ng Intel l i gent C ubes w hen Intel l i gence
Server starts.

5. C l i ck OK .

Storing Intelligent Cubes in Secondary Storage

Al ong w i th stori ng Intel l i gent C ubes i n Intel l i gence Server memory,
you can al so store them i n secondary storage, such as a hard di sk.
These Intel l i gent C ubes can then be l oaded from secondary storage
i nto Intel l i gence Server memory w hen reports requi re access to the
Intel l i gent C ube data.

To Store an Intelligent Cube in Secondary Storage

1. In D evel oper, l og i n to a proj ect source w i th admi ni strati ve

pri vi l eges.

2. R i ght-cl i ck the proj ect and sel ect Project C onfiguration.

3. Expand Intelligent C ubes, and then sel ect General.

4. In the Intelligent C ube file directory area, cl i ck ... (the B rowse

button).

5. Brow se to the fol der l ocati on to store Intel l i gent C ubes, and then
cl i ck OK .

© 2019, M icr o St r at egy In c. 967

Syst em Ad m in ist r at io n Gu id e

6. C l i ck OK .

7. From the Folder List, expand A dministration, then expand

System Monitors, then expand C aches, and then sel ect
Intelligent C ubes.

8. R i ght-cl i ck the Intel l i gent C ube to store i n secondary storage and

sel ect Save to D isk.

You c an als o define when Intelligent Cubes are automatic ally s av ed to

s ec ondary s torage, as des c ribed in D efi ni ng w hen Intel l i gent C ubes
are Automati cal l y Saved to Secondary Storage, page 968 below.

Def in in g wh en In t elligen t Cu b es ar e Au t o mat ically Saved t o

Seco n d ar y St o r age
In addi ti on to manual l y savi ng Intel l i gent C ubes to secondary storage,
you can al so defi ne w hen Intel l i gent C ubes are automati cal l y saved
to secondary storage.

To Define when Intelligent Cubes are Automatically Saved to

Secondary Storage

1. In D evel oper, l og i n to a proj ect source w i th admi ni strati ve

pri vi l eges.

2. From the A dministration menu, poi nt to Server, and then sel ect
C onfigure MicroStrategy Intelligence Server.

3. Expand the Server D efinition category, and sel ect A dvanced.

4. In the B ackup frequency (minutes) fi el d, type the i nterval (i n

mi nutes) betw een w hen Intel l i gent C ubes are automati cal l y
saved to secondary storage. A val ue of 0 means that Intel l i gent
C ubes are backed up i mmedi atel y after they are created or
updated.

968 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Be aw are that thi s opti on al so control s the frequency at w hi ch

cache and H i story Li st messages are backed up to di sk, as
descri bed i n C onfi guri ng R esul t C ache Setti ngs, page 884.

5. C l i ck OK .

6. R estart Intel l i gence Server for your changes to take effect.

Supporting Connection Mappings in Intelligent

Cubes
C onnecti on mappi ngs al l ow you to assi gn a user or group i n the
Mi croStrategy system to a speci fi c l ogi n ID on the data w arehouse.
C onnecti on mappi ngs are typi cal l y used for one of the fol l ow i ng
reasons:

l To take advantage of one of several R D BMS data securi ty

techni ques (securi ty vi ew s, spl i t fact tabl es by row s, spl i t fact tabl es
by col umns) that you may have al ready created

l To al l ow users to connect to mul ti pl e data w arehouses usi ng the

same proj ect

For detai l ed i nformati on about connecti on mappi ng, see the

Instal l ati on and C onfi gurati on Gui de.

If you use connecti on mappi ng i n a proj ect that i ncl udes Intel l i gent
C ubes, you shoul d defi ne your Intel l i gent C ubes to use and support
connecti on mappi ng. If you do not defi ne Intel l i gent C ubes to support
connecti on mappi ng w hen connecti on mappi ng i s used i n a proj ect,
users may be abl e to access data they are not i ntended to have
access to.

When an Intel l i gent C ube that supports connecti on mappi ng i s

publ i shed, i t uses the connecti on mappi ng of the user account w hi ch
publ i shed the Intel l i gent C ube. Onl y users that have thi s connecti on

© 2019, M icr o St r at egy In c. 969

Syst em Ad m in ist r at io n Gu id e

mappi ng can create and vi ew reports that access thi s Intel l i gent
C ube. Thi s mai ntai ns the data access securi ty and control defi ned by
your connecti on mappi ngs.

If an Intel l i gent C ube needs to be avai l abl e for mul ti pl e connecti on

mappi ngs, you must publ i sh a separate versi on of the Intel l i gent C ube
for each of the requi red connecti on mappi ngs.

For exampl e, Intel l i gent C ube X i s created i n a proj ect and defi ned to
support connecti on mappi ng. U ser JD oe w ho i s assi gned to
connecti on mappi ng A publ i shes Intel l i gent C ube X. The Intel l i gent
C ube i s publ i shed usi ng connecti on mappi ng X. U ser FJohnson w ho
i s assi gned connecti on mappi ng B cannot create and execute a report
connected to Intel l i gent C ube X. To al l ow FJohnson to create and
execute a report connected to Intel l i gent C ube X, a user account
assi gned to connecti on mappi ng B must publ i sh the Intel l i gent C ube.

To Support Connection Mapping for All Intelligent Cubes in a

Project

1. In D evel oper, l og i n to a proj ect w i th a user account w i th

admi ni strati ve pri vi l eges.

2. R i ght-cl i ck a proj ect and sel ect Project C onfiguration.

3. Expand Intelligent C ubes, and then sel ect General.

4. Sel ect the C reate Intelligent C ubes by database connection

check box.

If y ou do not us e c onnec tion mapping, leav e this c hec k box

c leared.

5. C l i ck OK .

970 © 2019, M icr o St r at egy In c.

 12
SCHEDULING JOBS AND
ADM INISTRATIVE TASKS

© 2019, M icr o St r at egy In c. 971

Syst em Ad m in ist r at io n Gu id e

Schedul i ng i s a feature of Intel l i gence Server that you can use to

automate vari ous tasks. Ti me-sensi ti ve, ti me-consumi ng, repeti ti ve,
and bul k tasks are i deal candi dates for schedul i ng. R unni ng a report
or document i s the most commonl y schedul ed task because
schedul i ng reports, i n conj uncti on w i th other features such as cachi ng
and cl usteri ng, can i mprove the overal l system performance. C ertai n
admi ni strati on tasks can al so be schedul ed.

Intel l i gence Server executes a task i n exactl y the same manner i f i t i s

schedul ed or not. Al l governi ng parameters and error condi ti ons appl y
to schedul ed tasks j ust as they appl y to other requests.

The s c heduling feature is turned on by default. Howev er, y ou c an

dis able s c heduling in the Intelligenc e Serv er Configuration Editor. In the
Server D efinition c ategory , in the A dvanced s ubc ategory , c lear the
U se MicroStrategy Scheduler c hec k box .

Thi s secti on di scusses the fol l ow i ng schedul i ng i tems:

l Best Practi ces for Schedul i ng Jobs and Admi ni strati ve Tasks, page
972

l C reati ng and Managi ng Schedul es, page 975

l Schedul i ng Admi ni strati ve Tasks, page 983

l Schedul i ng R eports and D ocuments: Subscri pti ons, page 988

l C onfi guri ng and Admi ni steri ng D i stri buti on Servi ces, page 1008

Best Practices for Scheduling Jobs and

Administrative Tasks
Mi croStrategy recommends the fol l ow i ng best practi ces w hen
schedul i ng j obs and admi ni strati ve tasks:

972 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Executi ng si mul taneous reports can strai n system resources. If you

have many reports or tasks that need to be executed on the same
ti me-based schedul e, consi der creati ng several si mi l ar schedul es
that tri gger 15 mi nutes apart. For exampl e, one schedul e tri ggers at
8 AM every Monday, and another tri ggers at 8:15 AM.

l To prevent users from schedul i ng many si mul taneous reports, you

can prevent users from schedul i ng j obs usi ng a schedul e by edi ti ng
the schedul e's Access C ontrol Li st (AC L). To do thi s, i n the
Schedul e Manager, ri ght-cl i ck the schedul e and sel ect Properties,
then sel ect the Securi ty tab i n the Properti es di al og box, and make
sure that onl y users w ho can use the schedul e have Modi fy or Ful l
C ontrol access to the schedul e. For more i nformati on about AC Ls,
see C ontrol l i ng Access to Obj ects: Permi ssi ons, page 95.

l Establ i sh reasonabl e l i mi ts on how many schedul ed j obs are

al l ow ed. For detai l s on thi s setti ng, see Li mi ti ng the Total N umber
of Jobs, page 724.

l If you need to create mul ti pl e si mi l ar subscri pti ons, you can create
them al l at once w i th the Subscri pti on Wi zard. For exampl e, you can
subscri be users to several reports at the same ti me.

l If you need to temporari l y di sabl e a schedul e, you can set i ts start

date for some ti me i n the future. The schedul e does not tri gger any
del i veri es unti l i ts schedul ed start date.

l In a cl ustered system, i f i t i s i mportant w hi ch node an admi ni strati ve

task i s executed on, use an event-tri ggered schedul e and tri gger the
event on that node.

l If many subscri pti ons are l i sted i n the Subscri pti on Manager, you
can fi l ter the l i st of subscri pti ons so that you see the rel evant
subscri pti ons.

© 2019, M icr o St r at egy In c. 973

Syst em Ad m in ist r at io n Gu id e

l When sel ecti ng reports to be subscri bed to, make sure al l the
reports w i th prompts that requi re an answ er actual l y have a defaul t
answ er. If a report has a prompt that requi res an answ er but has no
defaul t answ er, the subscri pti on cannot run the report successful l y
because the prompt cannot be resol ved, and the subscri pti on i s
automati cal l y i nval i dated and removed from the system.

l When a schedul ed report or document fi ni shes executi ng, a

message can di spl ay i n the subscri bed user's H i story Li st al erti ng
them that the report i s ready to be vi ew ed. The user then opens the
message to retri eve the resul ts. If the request w as not compl eted
successful l y, the user can vi ew detai l s of the error message. These
messages are avai l abl e i n the H i story Li st fol der. For more
i nformati on about H i story Li sts, see Savi ng R eport R esul ts: H i story
Li st, page 897.

l You can track the successful del i very of a subscri bed report or
document. In the Subscri pti on Edi tor or Subscri pti on Wi zard, sel ect
the Send notification to email address check box and speci fy the
emai l address. A noti fi cati on emai l i s sent to the sel ected address
w hen the subscri bed report or document i s successful l y del i vered to
the reci pi ents.

l You can track the fai l ed del i very of subscri bed reports or
documents. In the Proj ect C onfi gurati on Edi tor, i n the D eliveries:
Email notification category, enabl e the admi ni strator noti fi cati on
setti ngs for fai l ed del i veri es.

l For best performance, consi der confi guri ng the fol l ow i ng setti ngs to
sui t your subscri pti on needs:

l Tune the N umber of scheduled jobs governi ng setti ng accordi ng

to the si ze of your hardw are. Larger hardw are can handl e hi gher
setti ngs.

l Enabl e cachi ng.

974 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l If your database and database machi ne al l ow a l arger number of

w arehouse connecti ons, i ncreasi ng thi s number can i mprove
performance by al l ow i ng more j obs to execute agai nst the
w arehouse.

l Increase the Scheduler session timeout setti ng.

Ex erc is e c aution when c hanging s ettings from the default. For

details on eac h s etting, s ee the appropriate s ec tion of this manual.

l To control memory usage, consi der confi guri ng the fol l ow i ng

setti ngs:

l Li mi t the number of schedul ed j obs per proj ect and per

Intel l i gence Server.

l Increase the U ser sessi on i dl e ti me.

l Enabl e cachi ng.

l If you are usi ng D i stri buti on Servi ces, see Best Practi ces for U si ng
D i stri buti on Servi ces, page 1013.

Creating and Managing Schedules

A schedul e i s a Mi croStrategy obj ect that contai ns i nformati on
speci fyi ng w hen a task i s to be executed. One schedul e can control
several tasks. Schedul es are stored at the proj ect source l evel and
are thus avai l abl e to al l proj ects i n the proj ect source.

Intel l i gence Server supports tw o types of schedul es:

l Ti me-tri ggered schedul es execute at a date and ti me or on a

recurri ng date and ti me. For detai l s, see Ti me-Tri ggered Schedul es,
page 976.

© 2019, M icr o St r at egy In c. 975

Syst em Ad m in ist r at io n Gu id e

l Event-tri ggered schedul es execute w hen the event associ ated w i th

them i s tri ggered. For detai l s, see Event-Tri ggered Schedul es, page
976.

Time-Triggered Schedules
Wi th a ti me-tri ggered schedul e, you defi ne a date and ti me at w hi ch
the schedul ed task i s to be run. For exampl e, you can execute a task
every Sunday ni ght at mi dni ght. Ti me-tri ggered schedul es are useful
to al l ow l arge, resource-i ntensi ve tasks to run at off-peak ti mes, such
as overni ght or over a w eekend.

l Time-triggered s c hedules ex ec ute ac c ording to the time on the

mac hine where they were c reated. For ex ample, a s c hedule is c reated
us ing Dev eloper on a mac hine that is in the Pac ific time z one (GMT -
8:00). The s c hedule is s et to be triggered at 9:00 AM. The mac hine is
c onnec ted to an Intelligenc e Serv er in the Eas tern time z one (GMT -
5:00). The s c hedule ex ec utes at 12:00 PM Eas tern time, whic h is 9:00
AM Pac ific time.

l In a c lus tered env ironment, adminis trativ e tas k s as s oc iated with

time-triggered s c hedules are ex ec uted on only the primary node of the
c lus ter.

Event-Triggered Schedules
An event-tri ggered schedul e causes tasks to occur w hen an event
occurs. For exampl e, an event may tri gger w hen the database i s
l oaded, or w hen the books are cl osed at the end of a cycl e.

When an event i s tri ggered, al l tasks ti ed to that event through an

event-tri ggered schedul e begi n processi ng. For more i nformati on
about events, i ncl udi ng how to create them, see About Events and
Event-Tri ggered Schedul es, page 981.

976 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

In a c lus tered env ironment, adminis trativ e tas k s as s oc iated with ev ent-
triggered s c hedules are ex ec uted on only the node of the c lus ter that
triggered the ev ent.

Creating Schedules
To create schedul es, you must have the pri vi l eges C reate
C onfi gurati on Obj ect and C reate and Edi t Schedul es and Events. In
addi ti on, you need to have Wri te access to the Schedul e fol der. For
i nformati on about pri vi l eges and permi ssi ons, see C ontrol l i ng Access
to Appl i cati on Functi onal i ty, page 95.

To create effecti ve and useful schedul es, you must have a cl ear
understandi ng of your users' needs and the usage patterns of the
overal l system. Schedul es must be created before they are l i nked to
any tasks.

To Create a Schedule

1. In D evel oper, l og i n to a proj ect source.

2. Expand A dministration, then expand C onfiguration Managers,

and then sel ect Schedules. The l i st of schedul es for the proj ect
source di spl ays on the ri ght-hand si de.

3. From the File menu, poi nt to N ew, and then sel ect Schedule.

4. Step through the w i zard, enteri ng the requi red i nformati on:

l To create a ti me-tri ggered schedul e, w hen prompted for the

schedul e type, sel ect Time-triggered. Then sel ect the
frequency and ti me the schedul e i s tri ggered.

l To create an event-tri ggered schedul e, w hen prompted for the

schedul e type, sel ect Event-triggered. Then sel ect the event
that tri ggers the schedul e.

© 2019, M icr o St r at egy In c. 977

Syst em Ad m in ist r at io n Gu id e

5. When you reach the Summary page of the Wi zard, revi ew your
choi ces and cl i ck Finish.

You c an als o c reate a s c hedule with the Create Sc hedule s c ript for
Command Manager. For detailed s y ntax , s ee the Create Sc hedule s c ript
outline in C ommand Manager .

Managing Schedules
You can add, remove, or modi fy schedul es through the Schedul e
Manager. You can modi fy the events that tri gger event-tri ggered
schedul es through the Event Manager. For i nstructi ons on usi ng the
Event Manager, see About Events and Event-Tri ggered Schedul es,
page 981.

You can al so speci fy that certai n schedul es can execute

subscri pti ons rel ati ng onl y to certai n proj ects. For i nstructi ons, see
R estri cti ng Schedul es, page 979.

To Manage Your Schedules in the Schedule Manager

1. In D evel oper, l og i n to a proj ect source.

2. Expand A dministration, then expand C onfiguration Managers,

and then sel ect Schedules. The l i st of schedul es for the proj ect
source di spl ays on the ri ght-hand si de.

3. To manage your schedul es, sel ect from the tasks bel ow :

l To create a new schedul e, see C reati ng Schedul es, page 977.

l To modi fy a schedul e, ri ght-cl i ck the schedul e and sel ect Edit.

The Schedul e Wi zard opens w i th that schedul e's i nformati on.
Step through the w i zard and make any changes.

l To del ete a schedul e, ri ght-cl i ck the schedul e and sel ect

D elete.

978 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l To fi nd al l subscri pti ons that use one of the schedul es, ri ght-
cl i ck the schedul e and sel ect Search for dependent
subscriptions.

Restricting Schedules

You may w ant to restri ct some schedul es so that they can be used
onl y by subscri pti ons i n speci fi c proj ects. For exampl e, your On Sal es
D atabase Load schedul e may not be rel evant to your H uman
R esources proj ect. You can confi gure the H uman R esources proj ect
so that the On Sal es D atabase Load schedul e i s not l i sted as an
opti on for subscri pti ons i n that proj ect.

You may al so w ant to restri ct schedul es so that they cannot be used

to subscri be to certai n reports. For exampl e, your very l arge Al l
Worl dw i de Sal es D ata document shoul d not be subscri bed to usi ng
the Every Morni ng schedul e. You can confi gure the Al l Worl dw i de
Sal es D ata document so that the Every Morni ng schedul e i s not l i sted
as an opti on for subscri pti ons to that document.

To Restrict Schedules for a Project

1. In Mi croStrategy Web, l og i n to the proj ect you are restri cti ng

schedul es for. You must l og i n as a user w i th admi ni strati ve
access to the Mi croStrategy Web preferences.

2. C l i ck the MicroStrategy i con, then cl i ck Preferences.

3. In the l eft col umn, cl i ck Project D efaults, and then cl i ck

Schedule.

4. Sel ect Only allow users to subscribe to the schedules below.

5. The l eft col umn l i sts schedul es that users are not al l ow ed to
subscri be to. The ri ght col umn l i sts schedul es that users are
al l ow ed to subscri be to.

© 2019, M icr o St r at egy In c. 979

Syst em Ad m in ist r at io n Gu id e

When y ou firs t s elec t this option, no s c hedules are allowed. All

s c hedules are lis ted by default in the left c olumn, and the right
c olumn is empty .

6. To al l ow users to subscri be to a schedul e, sel ect the schedul e

and cl i ck the ri ght arrow . The schedul e moves to the ri ght
col umn.

7. When you are fi ni shed sel ecti ng the schedul es that users are
al l ow ed to subscri be to i n thi s proj ect, cl i ck Save.

To Restrict Schedules for a Report or Document

1. In Mi croStrategy Web, l og i n to the proj ect you are restri cti ng

schedul es for. You must l og i n as a user w i th admi ni strati ve
access to the Mi croStrategy Web preferences.

2. Execute the report or document.

3. From the Tools menu, sel ect R eport Options.

4. Sel ect the A dvanced tab.

5. Sel ect Only allow users to subscribe to the schedules below.

6. The l eft col umn l i sts schedul es that users are not al l ow ed to
subscri be to. The ri ght col umn l i sts schedul es that users are
al l ow ed to subscri be to.

When y ou firs t s elec t this option, no s c hedules are allowed. All

s c hedules are lis ted by default in the left c olumn, and the right
c olumn is empty .

7. To al l ow users to subscri be to a schedul e, sel ect the schedul e

and cl i ck the ri ght arrow . The schedul e moves to the ri ght
col umn.

980 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

8. When you are fi ni shed sel ecti ng the schedul es that users are
al l ow ed to subscri be to i n thi s proj ect, cl i ck OK .

About Events and Event-Triggered Schedules

Subscri pti ons and tasks that are based on event-tri ggered schedul es
(see Event-Tri ggered Schedul es, page 976) execute w hen a
Mi croStrategy event i s tri ggered. These tri ggers do not need to be
defi ned i n advance. A system external to Intel l i gence Server i s
responsi bl e for determi ni ng w hether the condi ti ons for tri ggeri ng an
event are met. For more i nformati on on how to tri gger events, see
Tri ggeri ng Events, page 982.

Once Intel l i gence Server has been noti fi ed that the event has taken
pl ace, Intel l i gence Server performs the tasks associ ated w i th the
correspondi ng schedul e.

In a c lus tered env ironment, adminis trativ e tas k s as s oc iated with ev ent-
triggered s c hedules are ex ec uted only by the node on whic h the ev ent is
triggered. Mic roStrategy rec ommends that y ou us e ev ent-triggered
s c hedules in s ituations where it is important to c ontrol whic h node
performs c ertain tas k s .

If proj ects are di stri buted asymmetri cal l y across the cl uster, w hen you
assi gn an event-tri ggered schedul e to a proj ect, make sure you tri gger
the event on al l nodes on w hi ch that proj ect i s l oaded. See Managi ng
Schedul ed Admi ni strati on Tasks, page 986.

Cr eat in g Even t s
You can create events i n D evel oper usi ng the Event Manager.

© 2019, M icr o St r at egy In c. 981

Syst em Ad m in ist r at io n Gu id e

To Create an Event in Developer

1. In D evel oper, l og i n to a proj ect source. You must l og i n as a

user w i th the C reate And Edi t Schedul es And Events pri vi l ege.

2. Go to A dministration > C onfiguration Managers > Events. The

l i st of events for the proj ect source di spl ays on the ri ght-hand
si de.

3. Sel ect File > N ew > Event.

4. N ame the new event.

To Create an Event Using Command Manager

You can create events w i th the fol l ow i ng C ommand Manager scri pt:

CREA TE EV EN T e v e n t _n a m e [ D E S C R I P TI O N d e s c r i p t i o n ] ;

By defaul t, thi s scri pt i s i n the fol der C : \ P r o g r a m F i l e s \

Micr oS tr at e g y \ C o m m a n d M a n a g e r \ O u t l i n e s \.

Tr igger in g Even t s
Mi croStrategy C ommand Manager can tri gger events from the
Wi ndow s command l i ne. By executi ng C ommand Manager scri pts,
external systems can tri gger events and cause the associ ated tasks to
be run. For more i nformati on about C ommand Manager, see C hapter
15, Automati ng Admi ni strati ve Tasks w i th C ommand Manager.

For exampl e, you w ant to execute several reports i mmedi atel y after a
database l oad occurs so that these reports al w ays have a val i d cache
avai l abl e. You create an event cal l ed OnD BLoad and associ ate i t w i th
an event-tri ggered schedul e. You then subscri be those reports to that
schedul e.

982 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

At the end of the database l oad routi ne, you i ncl ude a statement to
add a l i ne to a database tabl e, D B_LOAD _C OMPLETE, that i ndi cates
that the database l oad i s compl ete. You then create a database
tri gger that checks to see w hen the D B_LOAD _C OMPLETE tabl e i s
updated, and then executes a C ommand Manager scri pt. That scri pt
contai ns the fol l ow i ng l i ne:

TRIG GE R E VE N T " O n DB L o a d " ;

When the scri pt i s executed, the OnD BLoad event i s tri ggered, and
the schedul e i s executed.

You can al so use the Mi croStrategy SD K to devel op an appl i cati on

that tri ggers an event. You can then cause the database tri gger to
execute thi s appl i cati on.

Triggering Events Manually

You can manual l y tri gger events usi ng the Event Manager. Thi s i s
pri mari l y useful i n a testi ng envi ronment. In a producti on system, i t
may not be practi cal for the admi ni strator to be present to tri gger
event-based schedul es.

To Trigger an Event Manually

1. In D evel oper, l og i n to a proj ect source. You must l og i n as a

user w i th the Tri gger Event pri vi l ege.

2. Go to A dministration > C onfiguration Managers > Events.

3. R i ght-cl i ck an event and sel ect Trigger.

Scheduling Administrative Tasks

In addi ti on to schedul i ng reports and documents executi on, you can
i nstruct Intel l i gence Server to perform certai n admi ni strati ve tasks

© 2019, M icr o St r at egy In c. 983

Syst em Ad m in ist r at io n Gu id e

accordi ng to a schedul e. For exampl e, you can del ete al l H i story Li st

messages every month, or i dl e a proj ect once a w eek for mai ntenance
and then resume i t an hour l ater.

To schedul e an admi ni strati ve task, you must have the Admi ni ster
Subscri pti ons pri vi l ege and any pri vi l eges requi red for that task.

To Schedule an Administrative Task

1. In D evel oper, from the A dministration menu, poi nt to

Scheduling and then sel ect Schedule A dministration Tasks.

2. To schedul e tasks for a proj ect, sel ect that proj ect. To schedul e
tasks for the proj ect source, sel ect Al l Proj ects.

3. C hoose a task from the acti on l i st. For descri pti ons of the tasks,
see the tabl e bel ow .

4. Sel ect one or more schedul es for the task.

5. Set any addi ti onal opti ons requi red for the task.

6. C l i ck OK .

The tabl e bel ow l i sts the tasks that can be schedul ed for a proj ect.
Some of the tasks can al so be schedul ed at the proj ect source l evel ,
affecti ng al l proj ects i n that proj ect source.

Ta s k De s c r iption

C ach e o r H ist o ry L ist man ag emen t t asks

Delet e all report caches f or t he project . For more inf ormat ion, see
Managing R es ult C ac hes , page 878 .
Delet e
caches
Typically t he I nvalidat e Caches t ask is suf f icient t o clear t he
report caches.

Clean Delet e orphaned ent ries and ownerless inbox messages f rom t he

984 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Ta s k De s c r iption

Hist ory List Hist ory List dat abase. For more inf ormat ion, see Managing H istory
dat abase Lis ts , page 912

Delet e all hist ory list messages f or t he project or project source. For
more inf ormat ion, see Managing H is tory Lis ts, page 912 .
Delet e
Hist ory List
This maint enance request can be large. S chedule t he Hist ory List
messages
delet ions f or t imes when I nt elligence S erver is not busy, such as
(project or
when users are not sending request s t o t he syst em. A lt ernat ively,
project
delet e Hist ory List s in increment s; f or example, delet e t he Hist ory
source)
List s of groups of users at dif f erent t imes, such as at 1 A M, 2 A M,
and so on.

I nvalidat e t he report caches in a project . The invalid caches are

I nvalidat e
aut omat ically delet ed once all ref erences t o t hem have been delet ed.
caches
For more inf ormat ion, see Managing R es ult C aches, page 878 .

P urge
Delet e t he element caches f or a project . For more inf ormat ion, see
element
D eleting All Element C ac hes , page 934 .
caches

In t ellig en t C u b e man ag emen t t asks

A ct ivat e P ublish an I nt elligent Cube t o I nt elligence S erver, making it available

I nt elligent f or use in report s. For more inf ormat ion, see C hapter 11, Managing
Cubes Intelligent C ubes .

Deact ivat e
Unpublish an I nt elligent Cube f rom I nt elligence S erver. For more
I nt elligent
inf ormat ion, see C hapter 11, Managing Intelligent C ubes .
Cubes

Delet e
Delet e an I nt elligent Cube f rom t he server. For more inf ormat ion, see
I nt elligent
C hapter 11, Managing Intelligent C ubes .
Cube

Updat e
Updat e a published I nt elligent Cube. For more inf ormat ion, see
I nt elligent
C hapter 11, Managing Intelligent C ubes .
Cubes

Pro ject man ag emen t t asks

© 2019, M icr o St r at egy In c. 985

Syst em Ad m in ist r at io n Gu id e

Ta s k De s c r iption

Cause t he project t o st op accept ing cert ain t ypes of request s. For more
I dle project
inf ormat ion, see Setting the Status of a Projec t, page 51 .

Load B ring t he project back int o normal operat ion f rom an unloaded st at e.
project For more inf ormat ion, see Setting the Status of a Project, page 51 .

Resume B ring t he project back int o normal operat ion f rom an idle st at e. For
project more inf ormat ion, see Setting the Status of a Project, page 51 .

Take a project of f line t o users and remove t he project f rom I nt elligence

Unload
S erver memory. For more inf ormat ion, see Setting the Status of a
project
Projec t, page 51 .

Miscellan eo u s man ag emen t t asks

B at ch
LDA P
import I mport LDA P users int o t he MicroS t rat egy syst em. For more
(project inf ormat ion, see Managing LD AP Authentic ation, page 202 .
source
only)

Delet e
unused
managed Remove t he unused managed object s creat ed f or Freef orm S QL, Query
object s B uilder, and MDX cube report s. For more inf ormat ion, see D eleting
(project or U nus ed Sc hema Objec ts : Managed Objects , page 481 .
project
source)

Deliver
Deliver a push not if icat ion f or a Newsst and subscript ion t o a mobile
A P NS
device. For more inf ormat ion, see t he Mic roStrategy Mobile D es ign
P ush
and Adminis tration Guide .
Not if icat ion

Managing Scheduled Administration Tasks

The Schedul ed Mai ntenance vi ew of the System Admi ni strati on
moni tor l i sts al l the schedul ed admi ni strati ve tasks for a proj ect

986 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

source. From thi s vi ew you can see i nformati on about al l the

schedul ed tasks or del ete one or more tasks. For more i nformati on
about usi ng the System Admi ni strati on moni tor, see Managi ng and
Moni tori ng Proj ects, page 47.

To Manage Scheduled Administration Tasks

1. In D evel oper, l og i n to a proj ect source. You must l og i n as a

user w i th the Admi ni ster Subscri pti ons pri vi l ege.

2. Expand A dministration, and then expand System

A dministration.

3. Sel ect Scheduled Maintenance.

4. To vi ew detai l ed i nformati on about a schedul ed task, ri ght-cl i ck

the task and sel ect Quick View.

5. To del ete a schedul ed task, ri ght-cl i ck the task and sel ect
Expire.

Us ers are not notified when a tas k they hav e s c heduled is deleted.

Sch ed u lin g Ad min ist r at ive Tasks in a Clu st er ed Syst em

When you set up several Intel l i gence Server machi nes i n a cl uster,
you can di stri bute proj ects across those cl ustered machi nes (or
nodes) i n any confi gurati on. Each node can host a di fferent subset of
proj ects. For more i nformati on about cl usteri ng Intel l i gence Servers,
see C hapter 9, C l usteri ng Mul ti pl e Mi croStrategy Servers.

To determi ne w hi ch server handl es each schedul ed admi ni strati ve

task, use the fol l ow i ng gui del i nes:

l Tasks that are based on ti me-based schedul es are executed on the

pri mary node for each proj ect. You can fi nd a proj ect's pri mary node

© 2019, M icr o St r at egy In c. 987

Syst em Ad m in ist r at io n Gu id e

usi ng the C l uster vi ew of the System Admi ni strati on moni tor.

l Tasks that are based on event-tri ggered schedul es are executed on

the node on w hi ch the event i s tri ggered. The admi ni strator must be
sure to tri gger the event on al l nodes (that i s, al l machi nes) that are
runni ng the proj ect for w hi ch the event-based schedul e i s assi gned.

You can see w hi ch nodes are runni ng w hi ch proj ects usi ng the
C l uster vi ew of the System Admi ni strati on moni tor. For detai l s on
usi ng the C l uster vi ew of the System Admi ni strati on moni tor, see
Managi ng Your C l ustered System, page 823.

Scheduling Reports and Documents:

Subscriptions
N ormal l y, Intel l i gence Server executes report or document requests
i mmedi atel y after they are made. A subscri pti on al l ow s these requests
to be executed accordi ng to a schedul e speci fi ed by the admi ni strator.
U sers can create subscri pti ons for themsel ves, or system
admi ni strators can subscri be users to reports. In addi ti on, i f you have
a D i stri buti on Servi ces l i cense, you can del i ver subscri bed reports or
documents to other users by emai l , fi l e, FTP, or pri nt.

Schedul i ng reports and documents executi on reduces the l oad on the

system i n the fol l ow i ng w ays:

l You can create caches for frequentl y accessed reports and

documents, w hi ch provi des fast response ti mes to users w i thout
generati ng addi ti onal l oad on the database system.

l Large, l ong-runni ng reports and documents can be postponed to

l ater w hen the system l oad i s l i ghter.

A s ubs c ription for a doc ument c reates or updates only that doc ument's
c ac he for the default mode of the doc ument (HTML, PDF, Ex c el, or

988 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

XML/Flas h). If the doc ument is v iewed in other modes , it does not us e
this c ac he. For more information about how Intelligenc e Serv er
determines whether to us e a c ac he, s ee C ache Matchi ng Al gori thm,
page 868 .

When a user subscri bes or i s subscri bed to a report or document, that

user's personal i zati on sel ecti ons appl y to the subscri pti on.
Personal i zati on sel ecti ons can i ncl ude l anguage choi ce, del i very
method, del i very l ocati on, del i very format, and so on. Personal i zati on
opti ons vary dependi ng on w hat a report or document supports,
w hether the user's Mi croStrategy envi ronment i s i nternati onal i zed i n
the appropri ate l anguage for the user, and so on.

Thi s secti on provi des the fol l ow i ng i nformati on about subscri pti ons:

l Types of Subscri pti ons, page 989

l C reati ng Subscri pti ons, page 992

l Managi ng Subscri pti ons, page 1003

Types of Subscriptions
You can create the fol l ow i ng types of subscri pti ons for a report or
document:

l C ache update subscri pti ons refresh the cache for the speci fi ed
report or document. For exampl e, your system contai ns a set of
standard w eekl y and monthl y reports. These reports shoul d be kept
i n cache because they are frequentl y accessed. C ertai n tabl es i n
the database are refreshed w eekl y, and other tabl es are refreshed
monthl y. Whenever these tabl es are updated, the appropri ate
caches shoul d be refreshed.

C ache update subscri pti ons often use event-tri ggered schedul es
because caches general l y do not need to be refreshed unl ess the
underl yi ng data changes from an event l i ke a data w arehouse l oad.

© 2019, M icr o St r at egy In c. 989

Syst em Ad m in ist r at io n Gu id e

For addi ti onal suggesti ons for schedul i ng strategi es, see Managi ng
R esul t C aches, page 878. For detai l ed i nformati on about caches,
see R esul t C aches, page 860.

WebD AV subscri pti ons are a speci al type of cache update

subscri pti ons. These subscri pti ons update an Intel l i gence Server
fol der w hose contents are hosted by a WebD AV server so that the
i nformati on i n the fol der can be served to mobi l e devi ces. For
i nformati on about WebD AV fol ders, see the Advanced R eporti ng
Gui de.

l H istory List subscri pti ons create a H i story Li st message for the
speci fi ed report or document. U sers can then retri eve the report or
document from the H i story Li st message i n thei r H i story Li st fol der.
For detai l ed i nformati on about the H i story Li st, see Savi ng R eport
R esul ts: H i story Li st, page 897.

l Mobile subscri pti ons del i ver the report or document to a mobi l e
devi ce, such as an i Phone or an Androi d devi ce, vi a Mi croStrategy
Mobi l e. These subscri pti ons are avai l abl e i f you ow n the
Mi croStrategy Mobi l e product. For detai l ed i nformati on about mobi l e
subscri pti ons and Mi croStrategy Mobi l e, see the Mi croStrategy
Mobi l e Admi ni strati on Gui de .

l Intelligent C ube update subscri pti ons retri eve the most recent
i nformati on for an Intel l i gent C ube from the data w arehouse and
then publ i sh that Intel l i gent C ube. Li ke cache update subscri pti ons,
Intel l i gent C ube update subscri pti ons are good candi dates for
event-tri ggered schedul es. For detai l ed i nformati on about Intel l i gent
C ubes, see the In-memory Anal yti cs Gui de.

l Email subscri pti ons del i ver a report or document to one or more
emai l addresses.

l File subscri pti ons save the report or document as an Excel or PD F

fi l e to a di sk l ocati on on the netw ork.

990 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Print subscri pti ons automati cal l y pri nt a report or document from a
speci fi ed pri nter.

l FTP subscri pti ons automati cal l y save the report or document to a
l ocati on on an FTP server i n the fi l e format the user chooses:
command separated val ues (C SV), PD F, H TML, MS Excel , and
pl ai n text.

Email, file, print, and FTP s ubs c riptions are av ailable if y ou hav e
purc has ed a Dis tribution Serv ic es lic ens e. For information on
purc has ing Dis tribution Serv ic es , c ontac t y our Mic roStrategy ac c ount
repres entativ e.

Dist r ib u t io n Ser vices Su b scr ip t io n s

If you have a D i stri buti on Servi ces l i cense, you can set up i nformati on
fl ow s for yoursel f and other users by subscri bi ng to report and
document del i veri es. U sers can freel y personal i ze these del i veri es by
sel ecti ng del i very formats and l ocati ons, such as:

l Format: H TML, Fl ash, PD F, Excel , ZIP fi l e, pl ai n text, C SV, bul k

export, or .mstr (dossi er) fi l e

l D el i very l ocati on: Emai l , netw ork pri nter, FTP l ocati on, fi l e server
(i ncl udi ng portal s and PC s), or the user's Mi croStrategy H i story Li st,
w hi ch serves as a report archi ve and i mmedi atel y i nforms the user
of the del i very by emai l

R eports or documents that are subscri bed to for del i very through
D i stri buti on Servi ces can be compressed and passw ord protected.
Standard Mi croStrategy securi ty credenti al s are appl i ed for each user
subscri bed to recei ve a report or document.

Before you can use D i stri buti on Servi ces to del i ver reports and
documents, you must create the appropri ate devi ces, transmi tters, and
contacts. For detai l ed i nformati on on these obj ects and i nstructi ons

© 2019, M icr o St r at egy In c. 991

Syst em Ad m in ist r at io n Gu id e

on setti ng up D i stri buti on Servi ces system, see C onfi guri ng and
Admi ni steri ng D i stri buti on Servi ces, page 1008.

Creating Subscriptions
Thi s secti on provi des detai l ed i nstructi ons for subscri bi ng to a report
or document.

You can create subscri pti ons i n the fol l ow i ng w ays:

l You can subscri be to an i ndi vi dual report or document from the

R eport Edi tor or D ocument Edi tor i n D evel oper or through
Mi croStrategy Web (see To Subscri be to a R eport or D ocument i n
D evel oper, page 993 or To C reate a Subscri pti on i n Mi croStrategy
Web, page 994).

Us e this method to c reate WebDAV folder update s ubs c riptions .

A His tory Lis t mes s age is generated when a report or doc ument is
ex ec uted in Web by a s c hedule.

l If you have a D i stri buti on Servi ces l i cense, you can subscri be
mul ti pl e users to an i ndi vi dual report or document through
Mi croStrategy Web (see To C reate a Subscri pti on i n Mi croStrategy
Web, page 994).

l You can create mul ti pl e cache, H i story Li st, Intel l i gent C ube, or
Mobi l e subscri pti ons at one ti me for a user or user group usi ng the
Subscri pti on Wi zard i n D evel oper (see To C reate Mul ti pl e
Subscri pti ons at One Ti me i n D evel oper, page 994).

l If you have purchased a l i cense for C ommand Manager, you can

use C ommand Manager scri pts to create and manage your
schedul es and subscri pti ons. For i nstructi ons on creati ng these
scri pts w i th C ommand Manager, see C hapter 15, Automati ng
Admi ni strati ve Tasks w i th C ommand Manager, or see the C ommand
Manager H el p. (From w i thi n C ommand Manager, sel ect H elp.)

992 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l To c reate any s ubs c riptions , y ou mus t hav e the Sc hedule Reques t

priv ilege.

l To c reate email, file, FTP, or print s ubs c riptions , y ou mus t hav e a

Mic roStrategy Web lic ens e, a Dis tribution Serv ic es lic ens e, and the
appropriate priv ileges in the Dis tribution Serv ic es priv ilege group. For
ex ample, to c reate an email s ubs c ription y ou mus t hav e the Us e
Dis tribution Serv ic es and Subs c ribe to Email priv ileges .

To c reate an alert-bas ed s ubs c ription, y ou mus t als o hav e the Web

Create Alert priv ilege (under the Web Analy s t priv ilege group).

l To c reate mobile s ubs c riptions , y ou mus t hav e a Mic roStrategy Mobile

lic ens e.

l To s ubs c ribe other us ers to a report or doc ument, y ou mus t hav e the Web
Subs c ribe Others priv ilege (under the Web Profes s ional group). In
addition, to s ubs c ribe others in Dev eloper, y ou mus t hav e the Adminis ter
Subs c riptions , Configure Subs c ription Settings , and Monitor
Subs c riptions priv ileges (under the Adminis tration group).

l To s ubs c ribe a dy namic addres s lis t to a report or doc ument, y ou mus t

hav e the Subs c ribe Dy namic Addres s Lis t priv ilege. For information
about dy namic addres s lis ts , s ee U si ng a R eport to Speci fy the
R eci pi ents of a Subscri pti on, page 996 .

To Subscribe to a Report or Document in Developer

Only His tory Lis t, c ac he, Intelligent Cube, and Mobile s ubs c riptions c an
be c reated in Dev eloper.

1. In D evel oper, sel ect the report, document, Intel l i gent C ube, or
WebD AV fol der to be del i vered accordi ng to a schedul e.

© 2019, M icr o St r at egy In c. 993

Syst em Ad m in ist r at io n Gu id e

2. From the File menu, poi nt to Schedule D elivery To, and sel ect
the type of subscri pti on to create. For a l i st of the types of
subscri pti ons, see Types of Subscri pti ons, page 989.

3. Type a name and descri pti on for the subscri pti on.

4. From the Schedule drop-dow n l i st, sel ect a schedul e for the
subscri pti on.

5. C l i ck OK .

To Create Multiple Subscriptions at One Time in Developer

Only His tory Lis t, c ac he, Intelligent Cube, and Mobile s ubs c riptions c an
be c reated in Dev eloper.

1. In D evel oper, from the A dministration menu, poi nt to

Scheduling, and then sel ect Subscription C reation Wizard

2. Step through the Wi zard, speci fyi ng a schedul e and type for the
subscri pti ons, and the reports and documents that are
subscri bed to.

3. C l i ck Finish.

To Create a Subscription in MicroStrategy Web

1. In Mi croStrategy Web, on the reports page, under the name of the

report/document that you w ant to create a subscri pti on for, cl i ck
the Subscriptions i con .

This ic on bec omes v is ible when y ou point to the name of the report or
doc ument.

2. Sel ect A dd Subscription for the type of subscri pti on you w ant to
create. For a l i st of the types of subscri pti ons, see Types of

994 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Subscri pti ons, page 989.

3. Type a name and descri pti on for the subscri pti on.

4. From the Schedule drop-dow n l i st, sel ect a schedul e for the
subscri pti on.

5. To add addi ti onal users to the subscri pti on, cl i ck To. Sel ect the
users or groups and cl i ck OK .

6. C l i ck OK .

Pr o mp t ed Rep o r t s an d Su b scr ip t io n s
A subscri bed report can contai n prompts. H ow and w hether the report
i s executed depends on the prompt defi ni ti on. For addi ti onal
i nformati on about how prompts are defi ned, see the Prompts secti on
i n the Advanced R eporti ng Gui de.

To ensure that a prompted report i n a subscri pti on i s executed

properl y, the prompt must be requi red and must have ei ther a defaul t
answ er or a personal i zed answ er. The fol l ow i ng tabl e expl ai ns how
Intel l i gence Server resol ves the di fferent possi bl e scenari os that can
occur for each prompt i n a subscri bed report.

De fa ult /
Pr ompt Pe r s ona l
Re s ult
Re quir e d? Ans we r
pr e s e nt?

The prompt is ignored because it is not required; t he

No No
report is execut ed, but it is not f ilt ered by t he prompt .

The prompt and it s def ault or personal answer are ignored

No Y es because t he prompt is not required; t he report is
execut ed, but it is not f ilt ered by t he prompt .

Y es No The report is not execut ed. No answer is provided t o t he

© 2019, M icr o St r at egy In c. 995

Syst em Ad m in ist r at io n Gu id e

De fa ult /
Pr ompt Pe r s ona l
Re s ult
Re quir e d? Ans we r
pr e s e nt?

required prompt so MicroS t rat egy cannot complet e t he

report wit hout user int eract ion.

The report is execut ed. The prompt is answered wit h a

Y es Y es personal answer if one is available or wit h t he def ault
answer if a personal answer is not provided.

Usin g a Rep o r t t o Sp ecif y t h e Recip ien t s o f a Su b scr ip t io n

If you have a D i stri buti on Servi ces l i cense, you can use a report to
dynami cal l y speci fy the reci pi ents for a subscri pti on.

To create a dynami c reci pi ent l i st, you fi rst create a speci al source
report that contai ns al l the necessary i nformati on about the reci pi ents
of the subscri pti on. You then use the source report to defi ne the
dynami c l i st i n Mi croStrategy Web. The new dynami c reci pi ent l i st
appears i n the l i st of Avai l abl e R eci pi ents w hen defi ni ng a new
subscri pti on to a standard report or document. When the subscri pti on
i s executed, onl y the addresses returned by the source report are
i ncl uded i n the del i very.

The i nformati on i n the source report i ncl udes emai l addresses, user
ID s, and chosen devi ces to w hi ch to del i ver standard Mi croStrategy
reports and documents. Each address i n the source report must be
l i nked to a Mi croStrategy user. Any securi ty fi l ters and access control
l i sts (AC Ls) that are appl i ed to the address's l i nked user are al so
appl i ed to any reports and documents that are sent to the address.

If y ou hav e ex is ting Narrowc as t Serv er s ubs c riptions , this feature

c ontains an option in the Selec t Reports dialog box that allows y ou to
us e Narrowc as t Serv er s ourc e reports . Narrowc as t Serv er s ourc e

996 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

reports c ontained s ubs c ription information in the page-by elements .

When y ou c reate a s ourc e report to s upport a dy namic rec ipient lis t, y ou
c an des ignate the page-by elements as the loc ation where the s y s tem
s hould loc ate s ubs c ription information, thus enabling y ou to reus e y our
ex is ting Narrowc as t Serv er s ourc e reports . Steps to c hoos e this option
when c reating a dy namic rec ipient lis t are in the Mi croStrategy Web
H el p .

The procedure bel ow descri bes how to create a source report that
provi des the physi cal addresses, l i nked Mi croStrategy user ID s, and
devi ce type i nformati on necessary to create a dynami c reci pi ent l i st.
For steps to create a dynami c reci pi ent l i st usi ng thi s source report,
see the Mi croStrategy Web H el p.

You mus t hav e a Dis tribution Serv ic es lic ens e.

To c reate a dy namic rec ipient lis t, y ou mus t hav e the Create Dy namic
Addres s Lis t priv ilege.

To s ubs c ribe a dy namic addres s lis t to a report or doc ument, y ou mus t

hav e the Subs c ribe Dy namic Addres s Lis t priv ilege.

To Create a Source Report to Support a Dynamic Recipient List

1. In Mi croStrategy Web, create a gri d report contai ni ng at l east

three col umns. The col umns correspond w i th each of the three
requi red subscri pti on properti es:

l Physi cal address. For exampl e, thi s mi ght be provi ded by a

customer emai l attri bute form of the C ustomer attri bute.

l A Mi croStrategy user ID to be l i nked to the address. For

exampl e, thi s mi ght be provi ded by a customer ID attri bute form
of the C ustomer attri bute.

© 2019, M icr o St r at egy In c. 997

Syst em Ad m in ist r at io n Gu id e

l D evi ce. Thi s attri bute form uses a 32-character hexadeci mal
stri ng. For exampl e, thi s may be provi ded by a preferred
format/devi ce attri bute form of the C ustomer attri bute.

The data ty pe for the us er ID and dev ic e c olumns mus t be VARCHAR,

not CHAR.

2. Save the report w i th a name and descri pti on that makes the
report's purpose as a source report for a dynami c reci pi ent l i st
cl ear.

3. You can now use thi s source report to create a new dynami c
reci pi ent l i st i n Mi croStrategy Web. For steps to create a dynami c
reci pi ent l i st usi ng thi s source report, see the Mi croStrategy Web
H el p.

Per so n alizin g Email an d File Su b scr ip t io n s

You can personal i ze your emai l and fi l e subscri pti ons w i th macros i n
the Fi l e N ame, Subj ect, Message, ZIP Fi l e N ame, and Subfol der
fi el ds. These macros are automati cal l y repl aced w i th the appropri ate
text w hen the subscri pti on i s del i vered.

For exampl e, you create an emai l subscri pti on to a report named

D ai l y R evenue. You w ant the subj ect of the emai l to i ncl ude the name
of the report. In the Subscri pti on Edi tor, i n the Subject fi el d, you type
Subs cr ip ti o n T o { & C o n t e n t N a m e }. When the report i s
del i vered, the subj ect of the emai l i s Subscri pti on to D ai l y R evenue.
Later, the report i s changed to i ncl ude profi t, and the name of the
report i s changed to D ai l y R evenue and Profi t. The subscri pti on i s
now del i vered w i th the subj ect Subscri pti on to D ai l y R evenue and
Profi t, w i thout any change to the subscri pti on.

You c an als o us e mac ros to pers onaliz e the deliv ery loc ation and
bac k up deliv ery loc ation for a file dev ic e. For details , inc luding a lis t of

998 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

the mac ros av ailable for file dev ic es , s ee C reati ng and Managi ng
D evi ces, page 1025 .

The fol l ow i ng tabl e l i sts the macros that can be used i n emai l and fi l e
subscri pti ons, and the fi el ds i n w hi ch they can be used:

De s c r iption Ma c r o Fie lds

S ubject ,
Dat e t he subscript ion is sent {&Date}
File Name

S ubject ,
Time t he subscript ion is sent {&Time}
File Name

S ubject ,
Name of t he recipient {&RecipientName}
File Name

User login {&UserLogin} A ll f ields

Name of t he subscript ion {&Subscription} A ll f ields

P roject t hat cont ains t he subscribed

{&Project} A ll f ields
report / document

{&PromptNumber&}
Name of a prompt in t he subscribed
(where Number is t he A ll f ields
report / document
number of t he prompt )

Name of t he subscribed report / document {&ContentName} A ll f ields

Report or document det ails f or t he S ubject ,

{&ContentDetails}
subscribed report / document Message

Name of t he at t ribut e used f or burst ing (f ile {[Attribute Name]@

File Name
subscript ions) [Attribute Form]}

Name of t he at t ribut e used f or creat ing {[Attribute Name]@ S ub-f older

subf olders when burst ing (f ile subscript ions) [Attribute Form]} (burst ing)

© 2019, M icr o St r at egy In c. 999

Syst em Ad m in ist r at io n Gu id e

Deliver in g Par t s o f Rep o r t s Acr o ss Mu lt ip le Files: Bu r st in g

File Su b scr ip t io n s
Large Mi croStrategy reports and documents are often broken up i nto
separate pages by attri butes. In a si mi l ar w ay, w i th D i stri buti on
Servi ces, you can spl i t up, or burst, a report or document i nto mul ti pl e
fi l es. When the subscri pti on i s executed, a separate fi l e i s created for
each el ement of each attri bute sel ected for bursti ng. Each fi l e has a
porti on of data accordi ng to the attri butes used to group data i n the
report (page-by axi s) or document (group-by axi s).

For exampl e, you may have a report w i th i nformati on for al l regi ons.
You coul d pl ace R egi on i n the page-by axi s and burst the fi l e
subscri pti on i nto the separate regi ons. Thi s creates one report fi l e for
each regi on.

As a second exampl e, i f you choose to burst your report usi ng the

R egi on and C ategory attri butes, a separate fi l e i s created for each
combi nati on of R egi on and C ategory, such as C entral and Books as a
report, C entral and El ectroni cs as another, and so on.

When creati ng the subscri pti on for PD F, Excel , pl ai n text, and C SV

fi l e formats, you can use macros to ensure that each fi l e has a uni que
name. For exampl e, i f you choose to burst your document usi ng the
R egi on and C ategory attri butes, you can provi de { [ R e g i o n ] @
[DES C] }, { [ C a t e g o r y ] @[ D E S C ] } as the fi l e name. When the
subscri pti on i s executed, each fi l e name begi ns w i th the names of the
attri bute el ements used to generate the fi l e, such as C entral , Books or
C entral , El ectroni cs.

You mus t ex ec ute a prompted doc ument to mak e it av ailable for

burs ting.

1000 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To Burst a File Subscription Across Multiple Files

1. C reate a fi l e subscri pti on i n Mi croStrategy Web by fol l ow i ng the

steps i n To C reate a Subscri pti on i n Mi croStrategy Web, page
994, or edi t an exi sti ng fi l e subscri pti on i n Mi croStrategy Web.

2. In the Subscri pti on Edi tor, cl i ck B urst… The Sel ect Bursti ng
C ri teri a opti ons are di spl ayed. Al l attri butes used to group data
i n the report or document are show n i n the A vailable A ttributes
l i st.

3. From the A vailable A ttributes l i st, sel ect the attri butes to use to
break up the data, then cl i ck the ri ght arrow to move those
attri butes to the Selected A ttributes l i st.

4. To change the order of attri butes for bursti ng, sel ect an attri bute
i n the Selected A ttributes l i st, then cl i ck the up or dow n arrow .

5. In the File N ame fi el d, type a name for the burst fi l es. You can
use macros to ensure that each fi l e has a uni que name.

6. C l i ck OK .

Deliver in g Par t s o f Rep o r t s Acr o ss Mu lt ip le Files: Bu r st in g

File Su b scr ip t io n s t o Su b f o ld er s
Large Mi croStrategy reports and documents can be di vi ded i nto
separate pages by attri butes. In a si mi l ar w ay w i th D i stri buti on
Servi ces, you can break, or burst, a report or document i nto mul ti pl e
subfol ders, w i th each subfol der contai ni ng report or document w i th a
porti on of data di vi ded by the attri butes i n the report's page-by or the
document's group-by axi s. When the subscri pti on i s executed,
subfol ders are dynami cal l y created, i f they do not al ready exi st, w i th
the names of the attri bute el ements. To do thi s, you provi de macro
text as part of the bursti ng subfol der name w hen creati ng the fi l e

© 2019, M icr o St r at egy In c. 1001

Syst em Ad m in ist r at io n Gu id e

subscri pti on. Each attri bute i n the macro uses the syntax
{[ Att r ib ut e N a m e] @[A t t r i b u t e F o r m] }.

For exampl e, i f your report has Manager i n the page-by axi s, you may
burst the report i nto subfol ders usi ng the Manager's l ast name. In thi s
case, you provi de macro text { [ M a n a g e r ] @[ L a s t N a m e ] } as the
bursti ng subfol der name.

You can create mul ti pl e l evel s of subfol ders i f your report or

document i s grouped by mul ti pl e attri butes. As a second exampl e, you
coul d have Manager fol ders w i th C ategory subfol ders i n each. Thi s
macro text may be entered i n the subfol der name as { [ M a n a g e r ] @
[Las t N am e] } -{ [ M a n a g e r ] @[ F i r s t N a m e ] } \{ [ C a t e g o r y ] @
[DES C] } . The resul t of thi s bursti ng exampl e i s show n i n the i mage
bel ow . One of the subscri bed reports w i th books data i s i n the Books
subfol der i n the manager's subfol der named Abram-C ri sby.

In the exampl e above, the R eports\Fi l eD ev1 path w as defi ned as part
of the fi l e devi ce used for the subscri pti on. The fi l e name has the date
and ti me appended to the report name because the fi l e devi ce
defi ni ti on has the A ppend timestamp to file name check box
sel ected.

To Burst a File Subscription Across Multiple Subfolders

1. C reate a fi l e subscri pti on i n Mi croStrategy Web by fol l ow i ng the

steps i n To C reate a Subscri pti on i n Mi croStrategy Web, page
994 or edi t an exi sti ng fi l e subscri pti on i n Mi croStrategy Web.

2. In the Subscri pti on Edi tor, cl i ck B urst… The Sel ect Bursti ng
C ri teri a opti ons are di spl ayed. Al l attri butes used to group data
i n the report or document are show n i n the A vailable A ttributes
l i st.

3. From the A vailable A ttributes l i st, sel ect any attri bute to use to
create the subfol ders, then cl i ck the ri ght arrow to move the

1002 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

attri bute to the Selected A ttributes l i st. The Sub-fol der fi el d

di spl ays bel ow or to the ri ght of the Fi l e N ame fi el d.

4. To change the order of attri butes for bursti ng, sel ect an attri bute
i n the Selected A ttributes l i st, then cl i ck the up or dow n arrow .

5. In the File N ame fi el d, type a name for the fi l es to be created.

You can use macros to ensure that each fi l e has a uni que name.

6. In the Sub-folder fi el d (the one bel ow or to the ri ght of the Fi l e

N ame fi el d), type a macro to dynami cal l y create the subfol ders.

7. C l i ck OK .

Managing Subscriptions
Thi s secti on contai ns the fol l ow i ng i nformati on:

l Tasks for Managi ng Subscri pti ons, page 1003

l Admi ni steri ng Subscri pti ons, page 1006

l R esul t C aches and Subscri pti ons, page 1007

l Subscri pti ons i n a C l ustered System, page 1007

Tasks f o r Man agin g Su b scr ip t io n s

The tabl e bel ow l i sts common subscri pti on and del i very-rel ated tasks
that users or admi ni strators can perform, and w here to perform those
tasks, i n both Mi croStrategy Web and D evel oper. N ote that some
tasks can be performed onl y i n Mi croStrategy Web.

The steps i n the tabl e take you to the mai n i nterface to compl ete the
task. For detai l ed steps, cl i ck H elp once you are i n the mai n i nterface.

© 2019, M icr o St r at egy In c. 1003

Syst em Ad m in ist r at io n Gu id e

Us e r ta s k Whe r e to pe r for m the ta s k

l I n MicroS t rat egy Web: I n a report or document , f rom

Def ine pref erences f or a t he R eport H ome or D ocument H ome menu, select
report / document t o be Subscribe to , t hen select H istory List or Mobile .
delivered t o a user's
Hist ory List f older, mobile l I n Developer: I n a report or document , f rom t he File

device, or syst em cache. menu, select Schedule delivery to , t hen select

H istory List , U pdate cache , or Mobile .

Def ine pref erences f or a

report / document t o be
l I n MicroS t rat egy Web, f rom a report or document ,
delivered t o an email
f rom t he R eport H ome or D ocument H ome menu,
address, net work st orage
select Subscribe to , t hen select Email , File ,
locat ion, FTP locat ion, or
Printer , or FTP .
print er (Dist ribut ion
S ervices only).

l I n MicroS t rat egy Web: Click Preferences on t he lef t

of any page. For Hist ory List delivery, select Project
Def ine personal D efaults on t he lef t , t hen select H istory List . For
subscript ion pref erences E mail, File, P rint er, FTP delivery, select U ser
t o all report s or Preferences on t he lef t , t hen select Email
document s, in one A ddresses , File Locations , Printer Location , or
locat ion. FTP Locations .

l I n Developer: From t he Tools menu, select My

Subscriptions .

l I n MicroS t rat egy Web, add an alert t o a report ; t o do

t his, run a report , right -click a met ric on t he report ,
S et up alert -based
and select A lerts . I n t he A lert s E dit or, af t er you set
subscript ions.
up t he alert , set up t he subscript ion by select ing
D elivery Settings .

l I n MicroS t rat egy Web, if you own Dist ribut ion

S chedule a S ervices: I n a report or document , f rom t he R eport
report / document t o be H ome or D ocument H ome menu, select Subscribe
sent t o anot her user. to , t hen select H istory List , Mobile , Email , File ,
Printer , or FTP .

1004 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Us e r ta s k Whe r e to pe r for m the ta s k

l I n MicroS t rat egy Web, if you do not own Dist ribut ion
S ervices: I n a report or document , f rom t he R eport
H ome or D ocument H ome menu, select A dd to
H istory List or A dd to Mobile .

l I n Developer: I n a report or document , f rom t he File

menu, select Schedule delivery to , t hen select
H istory List , U pdate cache , or Mobile .

l I n MicroS t rat egy Web: click My Subscriptions on t he

lef t of any page. I n t he Unsubscribe column on t he
Unsubscribe f rom a report right , select a check box and click U nsubscribe .
or document . l I n Developer: From t he Tools menu, select My
Subscriptions . Right -click a subscript ion, t hen select
U nsubscribe .

l I n MicroS t rat egy Web, click My Subscriptions on

t he lef t of any page. I n t he A ct ion column, click t he
Change subscript ion Edit icon f or t he report / document whose subscript ion
det ails f or a report or you want t o edit .
document . l I n Developer: From t he Tools menu, select My
Subscriptions . Right -click a subscript ion, t hen
select Edit .

l I n MicroS t rat egy Web, f rom a report , f rom t he Tools

menu, select R eport Options , t hen select t he
Conf igure who can
D elivery t ab. Choose t o allow all users, specif ied
subscribe t o each report .
users, or no users t o subscribe t o t he report . For
st eps, see t he help.

l I n MicroS t rat egy Web, f rom a document in Design

mode, f rom t he Tools menu, select D ocument
Conf igure who can
Options . On t he lef t under Document P ropert ies,
subscribe t o each
click D elivery and t hen choose t o allow all users,
document .
specif ied users, or no users t o subscribe t o t he
document . For st eps, see t he help.

© 2019, M icr o St r at egy In c. 1005

Syst em Ad m in ist r at io n Gu id e

Ad min ist er in g Su b scr ip t io n s

You can create, remove, or modi fy subscri pti ons through the
Subscri pti on Manager.

You can set the maxi mum number of subscri pti ons of each type that
each user can have for each proj ect. Thi s can prevent excessi ve l oad
on the system w hen subscri pti ons are executed. By defaul t, there i s
no l i mi t to the number of subscri pti ons. You set these l i mi ts i n the
Proj ect C onfi gurati on Edi tor, i n the Governing R ules: D efault:
Subscriptions category.

To Manage Your Subscriptions in the Subscription Manager

1. In D evel oper, l og i n to a proj ect source.

2. Expand A dministration, then expand C onfiguration Managers,

and then sel ect Subscriptions.

3. To manage your subscri pti ons, sel ect from the tasks bel ow :

l To create a subscri pti on, ri ght-cl i ck i n the Subscri pti on

Manager and sel ect Subscription C reation Wizard. . Fol l ow
the i nstructi ons i n C reati ng Subscri pti ons, page 992.

l To modi fy a subscri pti on, ri ght-cl i ck the subscri pti on and sel ect
Edit. Make any changes and cl i ck OK .

l To del ete a subscri pti on, ri ght-cl i ck the subscri pti on and sel ect
D elete.

l To fi l ter the subscri pti ons that are l i sted, ri ght-cl i ck i n the
Subscri pti on Manager and sel ect Filter. Speci fy the fi l teri ng
cri teri a and cl i ck OK .

1006 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Resu lt Cach es an d Su b scr ip t io n s

By defaul t, i f a cache i s present for a subscri bed report or document,
the report or document uses the cache i nstead of re-executi ng the
report or document. If no cache i s present, one i s created w hen the
report or document i s executed. For i nformati on about how resul t
(report or document) caches are used i n Mi croStrategy, see R esul t
C aches, page 860.

When you create a subscri pti on, you can force the report or document
to re-execute agai nst the w arehouse even i f a cache i s present, by
sel ecti ng the R e-run against the warehouse check box i n the
Subscri pti on Wi zard. You can al so prevent the subscri pti on from
creati ng a new cache by sel ecti ng the D o not create or update
matching caches check box.

You can change the defaul t val ues for these check boxes i n the
Proj ect C onfi gurati on Edi tor, i n the C aching: Subscription
Execution category.

Su b scr ip t io n s in a Clu st er ed Syst em

When you set up several Intel l i gence Server machi nes i n a cl uster,
you can di stri bute proj ects across those cl ustered machi nes (or
nodes) i n any confi gurati on. Each node can host a di fferent subset of
proj ects. For more i nformati on, i ncl udi ng i nstructi ons, on cl usteri ng
Intel l i gence Servers, see C hapter 9, C l usteri ng Mul ti pl e Mi croStrategy
Servers.

Subscri pti ons i n a cl ustered system are l oad-bal anced across al l

nodes of the cl uster that host the proj ect contai ni ng the subscri bed
report or document. Subscri pti ons are l oad-bal anced by the number of
subscri pti on j obs created. One subscri pti on j ob i s created for each
user or user group i n the subscri pti on. For exampl e, i f U ser A and
U ser Group B are subscri bed to a dossi er, the subscri pti on creates
one j ob for U ser A, and a second j ob for U ser Group B. In a tw o-node

© 2019, M icr o St r at egy In c. 1007

Syst em Ad m in ist r at io n Gu id e

cl uster, the subscri pti on for U ser A w oul d execute on one node, and
the subscri pti on for U ser Group B w oul d execute on the other node.

Configuring and Administering Distribution

Services
Mi croStrategy D i stri buti on Servi ces provi des hi gh-vol ume and hi gh-
effi ci ency di stri buti on of reports, documents, and dossi ers to emai l
addresses, fi l e servers, netw orked pri nters, FTP l ocati ons, and
devi ces such as mobi l e phones. D i stri buti on Servi ces al so supports
vari ous Mi croStrategy Mobi l e-rel ated features.

D i stri buti on Servi ces functi onal i ty i s set up and enabl ed by an

admi ni strator i n D evel oper and i s used by al l types of users through
subscri bi ng to del i veri es i n Mi croStrategy Web. Admi ni strators can
al so subscri be one or more users to a del i very.

Thi s secti on expl ai ns the D i stri buti on Servi ces functi onal i ty and steps
to set i t up i n your Mi croStrategy system.

For detai l s about stati sti cs l oggi ng for emai l , fi l e, pri nt, and FTP
del i veri es, see Stati sti cs on Subscri pti ons and D el i veri es, page 2693.

Thi s secti on contai ns the fol l ow i ng i nformati on:

Overview of Distribution Services

The admi ni strati ve tool s avai l abl e w i th D i stri buti on Servi ces l et you
set up how reports and documents are transformed i nto emai l s and
fi l es and sent to emai l reci pi ents, fi l e l ocati ons, pri nters, mobi l e
devi ces, or FTP servers. These admi ni strati ve tool s i ncl ude
transmi tters, devi ces, and contacts.

1008 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Ab o u t t h e Deliver y Pr o cess
The fol l ow i ng hi gh-l evel steps descri be how the subscri pti on and
del i very process w ork:

1. In D evel oper, the admi ni strator creates a transmi tter, such as an

emai l transmi tter or fi l e transmi tter. For exampl e, the emai l
transmi tter i s set up w i th the opti ons that you w ant the system to
use at run ti me (w hen the emai l i s sent), to refl ect your emai l
server and other envi ronment requi rements. For i nformati on
about transmi tters, see About Transmi tters, page 1010.

2. In D evel oper, the admi ni strator creates a devi ce for each of the
transmi tters created above. Al l devi ces can have speci fi c
setti ngs provi ded to support your envi ronment and user needs;
for exampl e, how to handl e a del i very i f a pri nter i s dow n for
mai ntenance, or to add the current date to the name of a fi l e that
i s del i vered to a netw ork l ocati on regul arl y. For i nformati on
about devi ces, see About D evi ces, page 1010.

3. In D evel oper, the admi ni strator creates contacts usi ng the

transmi tters and devi ces created above. The contacts contai n
del i very addresses (emai l addresses, fi l e paths, pri nter paths, or
FTP servers) and are l i nked to a Mi croStrategy user account for
securi ty purposes. For i nformati on about contacts, see About
C ontacts, page 1011.

4. In Mi croStrategy Web, a user i denti fi es a report or document that

they w oul d l i ke to subscri be to have del i vered regul arl y.

5. In Mi croStrategy Web, the user sel ects thei r ow n address from

the To drop-dow n menu. If they choose, they can sel ect
addi ti onal addresses for themsel ves, other Mi croStrategy users,
or other contacts to al so recei ve thi s report or document usi ng
the subscri pti on.

© 2019, M icr o St r at egy In c. 1009

Syst em Ad m in ist r at io n Gu id e

6. In Mi croStrategy Web, the user chooses del i very opti ons such as
the del i very schedul e, a name for the subscri pti on, the del i very
format, an expi rati on date for the subscri pti on, and so on.

7. The subscri pti on i s created. The subscri bed users and contact
addresses recei ve the subscri bed report or document on the
schedul e that w as defi ned above.

Ab o u t Tr an smit t er s
Transmi tters are softw are components that transform Mi croStrategy
reports and documents i nto emai l s and fi l es and send those emai l s
and fi l es to emai l reci pi ents, netw ork fi l e l ocati ons, netw ork pri nters,
or FTP servers. D i stri buti on Servi ces comes w i th defaul t transmi tters
that you can use to create devi ces.

For detai l s on how to create or modi fy transmi tters, see C reati ng and
Managi ng Transmi tters, page 1016.

Ab o u t Devices
D evi ces are i nstances of transmi tters that have speci fi c transmi ssi on
and del i very properti es. D evi ces speci fy the del i very format of a
Mi croStrategy report or document and the transmi ssi on process that
sends the report or document to users w ho subscri be to i t. For
exampl e, i f you w ant to send a report to a fi l e l ocati on, you can create
a fi l e devi ce (w hi ch i s based on a Fi l e transmi tter) that speci fi es a fi l e
del i very l ocati on and fi l e properti es, such as appendi ng the current
date to the fi l e del i very l ocati on, ti meout setti ngs, and so on.

D i stri buti on Servi ces comes w i th defaul t emai l , fi l e, pri nt, and FTP
devi ces that are al ready set up. You can use the defaul t devi ces as i s,
modi fy thei r setti ngs accordi ng to your requi rements, or create your
ow n devi ces from scratch i f you requi re addi ti onal devi ces w i th
di fferent combi nati ons of properti es. For exampl e, you may requi re

1010 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

one emai l devi ce to send emai l s to Mi crosoft Outl ook and a separate
devi ce to send emai l s to w eb-based emai l accounts such as Yahoo,
Gmai l , H otmai l , and so on.

Dev ic es c an be c reated in a direc t c onnec tion (two-tier) env ironment,

but print and file loc ations for thos e dev ic es are not v alidated by the
s y s tem. Print and file loc ations for dev ic es c reated in s erv er
c onnec tions (three-tier) are automatic ally v alidated by Mic roStrategy .

For detai l s on how to create or manage devi ces, see C reati ng and
Managi ng D evi ces, page 1025.

Ab o u t Co n t act s
C ontacts provi de a user w i th a set of associ ated emai l addresses, fi l e
del i very l ocati ons, netw ork pri nter del i very l ocati ons, and FTP
servers. To make i t easi er to manage al l the addresses and del i very
l ocati ons for a user, you can create a contact for each address and
del i very l ocati on. Thus, one user can have mul ti pl e contacts
associ ated w i th thei r user account. Thi s al l ow s you to, for exampl e,
send a l ong and compl ex report to a user's w ork-rel ated emai l
address, and send a shorter, hi gh-l evel summary report to the same
user's home emai l address so they can qui ckl y check on a status over
the w eekend. The tw o emai l addresses are set up as separate
contacts. The compl ex report i s subscri bed to by the user's w ork
contact, and the summary report i s subscri bed to by the user's home
contact.

A contact can al so be used to schedul e report and document del i very

to peopl e w ho are not Mi croStrategy users and do not have user
accounts. H ow ever, the Mi croStrategy user that the contact i s
associ ated w i th must have a D i stri buti on Servi ces l i cense. For
exampl e, company sharehol ders may need to recei ve a fi nanci al
document every month. Mul ti pl e contacts are created, one for each
reci pi ent's emai l address, and then a Mi croStrategy user i s created—

© 2019, M icr o St r at egy In c. 1011

Syst em Ad m in ist r at io n Gu id e

named Sharehol der Fi nances, for exampl e—and al l the contacts are
l i nked to that user. The user i s subscri bed to the document to be
del i vered on a schedul e, and that user's securi ty profi l e i s appl i ed to
the document executi on and del i very. The addresses that the
document i s del i vered to are the i ndi vi dual sharehol ders' emai l
addresses that make up each contact l i nked to the user.

For detai l s on how to create or manage contacts, see C reati ng and

Managi ng C ontacts, page 1040.

Security and Contacts

C ontacts al l ow you to group mul ti pl e addresses by l i nki ng those

contacts to a Mi croStrategy user. The user l i nked to the contacts can
have reports and documents subscri bed to the contacts, and thus the
reports and documents are del i vered to sel ected addresses and
del i very l ocati ons defi ned for those contacts. Each contact can be
l i nked to one Mi croStrategy user account, so no other Mi croStrategy
users can see the address used by a contact.

Each contact must be l i nked to a Mi croStrategy user. The securi ty

fi l ters and access control l i sts (AC Ls) that are appl i ed to that user are
al so appl i ed to reports and documents sent to any contacts
associ ated w i th that user. For exampl e, i f a user has a securi ty fi l ter
that restri cts them from vi ew i ng sal es data about regi ons other than
thei r ow n, subscri pti ons del i vered to any contacts associ ated w i th
them do not contai n sal es data about regi ons other than thei r regi on.

When y ou c reate a s ourc e report for a dy namic rec ipient lis t, y ou mus t
s pec ify a link ed Mic roStrategy us er for eac h addres s . Any s ec urity
filters and ACLs that are applied to the addres s 's link ed us er are als o
applied to any reports and doc uments s ent to the addres s . For more
information about c reating a s ourc e report for a dy namic rec ipient lis t,
s ee C reati ng Subscri pti ons, page 992 .

1012 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Best Practices for Using Distribution Services

Mi croStrategy recommends the fol l ow i ng best practi ces w hen
schedul i ng D i stri buti on Servi ces subscri pti ons, i n addi ti on to the best
practi ces gi ven above:

l For best resul ts, fol l ow the steps l i sted i n H i gh-Level C heckl i st to
Set U p a R eport D el i very System, page 1015.

l PD F, pl ai n text, and C SV fi l e formats general l y offer the fastest

del i very performance. Performance can vary, dependi ng on i tems
i ncl udi ng your hardw are, operati ng system, netw ork connecti vi ty,
and so on.

l The performance of the pri nt del i very method depends on the speed
of the pri nter.

l When sendi ng very l arge reports or documents:

l Enabl e the zi ppi ng feature for the subscri pti on so that fi l es are
smal l er.

l U se bul k export i nstead of the C SV fi l e format. D etai l s on bul k

exporti ng are i n the R eports secti on of the Advanced R eporti ng
Gui de.

l Schedul e subscri pti on del i veri es to occur w hen your Intel l i gence
Server i s experi enci ng l ow traffi c.

l If your organi zati on i s processi ng a smal l er number of

subscri pti ons, such as 100 or few er, better performance may be
achi eved by sendi ng each subscri pti on to the l argest number of
reci pi ents possi bl e. Thi s can be achi eved by desi gni ng reports or
documents that answ er busi ness questi ons for the w i dest vari ety of
anal ysts and by addi ng prompts to the report or document. For an
i ntroducti on to creati ng and addi ng prompts to a report, see the
Basi c R eporti ng Gui de.

© 2019, M icr o St r at egy In c. 1013

Syst em Ad m in ist r at io n Gu id e

For i nformati on about how prompts are answ ered i n subscri bed
reports, see C reati ng Subscri pti ons, page 992.

If your organi zati on i s processi ng many subscri pti ons, such as

1,000 or more, better performance may be achi eved by sendi ng the
l argest number of subscri pti ons possi bl e to the few est reci pi ents.
For exampl e, i t may be possi bl e to send al l of a team's
subscri pti ons to a proj ect manager, w ho can then present and
di stri bute the subscri bed-to reports i n team meeti ngs.

If you are processi ng many subscri pti ons, consi der usi ng the bul k
export feature. D etai l s on bul k exporti ng are i n the R eports secti on
of the Advanced R eporti ng Gui de.

l When creati ng contacts, make sure that each contact has at l east
one address for each del i very type. Otherw i se the contact does not
appear i n the l i st of contacts for subscri pti ons that are for a del i very
type that the contact has no address for. For exampl e, i f a contact
does not have an emai l address, w hen an emai l subscri pti on i s
bei ng created, that contact does not appear i n the l i st of contacts.

l When sel ecti ng reports to be subscri bed to, make sure none of the
reports have prompts that requi re an answ er and have no defaul t
answ er. If a report has a prompt that requi res an answ er but has no
defaul t answ er, the subscri pti on cannot run the report successful l y,
and the subscri pti on i s automati cal l y removed from the system.

l U se macros to dynami cal l y speci fy the del i very l ocati on and backup
del i very l ocati on for a fi l e devi ce (see C reati ng and Managi ng
D evi ces, page 1025).

l The maxi mum fi l e si ze of dossi er (.mstr) fi l es that can be sent

through D i stri buti on Servi ces i s defi ned by the MicroStrategy
(.mstr) file size (MB ) setti ng. To access the setti ng, i n
Mi croStrategy D evel oper ri ght-cl i ck on the proj ect and sel ect
Project C onfiguration… Then, In the Proj ect C onfi gurati on di al og

1014 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

box, choose Project D efinition > Governing R ules > D efault >
R esult sets. The maxi mum .mstr fi l e si ze i s 2047 MB.

High-Level Checklist to Set Up a Report Delivery System

The fol l ow i ng hi gh-l evel checkl i st descri bes w hat you need to do to
set up a report del i very system i n Mi croStrategy usi ng D i stri buti on
Servi ces.

Unders tand y our us ers ' requirements for s ubs c ribing to reports and where
they want them deliv ered.

Hav e adminis trator priv ileges .

Hav e a lic ens e to us e Dis tribution Serv ic es .

If y ou us e Mic roStrategy Narrowc as t Serv ic es , during the upgrade to

Mic roStrategy Dis tribution Serv ic es be s ure to us e the Migrate
Subs c riptions for Web Deliv eries wiz ard. This wiz ard is av ailable from the
Mic roStrategy Dev eloper Tools menu. For details on eac h option in the
wiz ard, c lic k H elp .

For c omplete s teps to perform a Mic roStrategy upgrade, s ee the

U pgrade Gui de .

1. Modi fy exi sti ng transmi tters or create new transmi tters accordi ng
to your requi rements. D i stri buti on Servi ces comes w i th defaul t
emai l , fi l e, pri nt, mobi l e, and FTP transmi tters, but i f you use
these you shoul d modi fy thei r setti ngs to sui t your envi ronment.

l For best practi ces for w orki ng w i th transmi tters, see C reati ng
and Managi ng Transmi tters, page 1016.

l For steps to modi fy a transmi tter, see C reati ng and Managi ng

Transmi tters, page 1016.

l For steps to create a new transmi tter, see C reati ng and

Managi ng Transmi tters, page 1016.

© 2019, M icr o St r at egy In c. 1015

Syst em Ad m in ist r at io n Gu id e

2. Modi fy exi sti ng devi ces or create new devi ces accordi ng to your
requi rements. D i stri buti on Servi ces comes w i th defaul t devi ces,
but i f you use these you shoul d modi fy thei r setti ngs to sui t the
systems i n your envi ronment.

l For best practi ces for w orki ng w i th devi ces, see C reati ng and
Managi ng D evi ces, page 1025.

l For steps to modi fy a devi ce, see C reati ng and Managi ng

D evi ces, page 1025.

l For steps to create a new devi ce, see C reati ng and Managi ng
D evi ces, page 1025.

3. C reate contacts so users can subscri be to reports and

documents.

l For best practi ces for w orki ng w i th contacts, see C reati ng and
Managi ng C ontacts, page 1040.

l For steps to modi fy a contact, see C reati ng and Managi ng

C ontacts, page 1040.

l For steps to create a contact, see C reati ng and Managi ng

C ontacts, page 1040.

Creating and Managing Transmitters

A transmi tter i s a Mi croStrategy softw are component that D i stri buti on
Servi ces uses to package subscri bed reports and documents i nto fi l es
or emai l s, and send those fi l es or emai l s to reci pi ents.

D i stri buti on Servi ces comes w i th mul ti pl e types of transmi tters: emai l
(SMTP), fi l e, pri nt, FTP, and mobi l e. For exampl e, a fi l e transmi tter
packages and del i vers reports i n the form of fi l es (PD F, H TML, MS
Excel , pl ai n text, and C SV formats) to fi l e storage l ocati ons on
netw ork computers. A pri nt transmi tter sends reports to netw ork
pri nters for pri nti ng.

1016 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

When a user subscri bes to a Mi croStrategy report, the report i s sent to

the appropri ate transmi tter for packagi ng and del i very. For exampl e, i f
the report i s to be del i vered to a fi l e l ocati on on a netw ork computer,
the report i s sent to a fi l e transmi tter for conversi on to the appropri ate
fi l e format for del i very. Si mi l arl y, i f the report i s to be del i vered i n the
form of an emai l to a user's emai l address, the report i s sent to an
emai l transmi tter for appropri ate packagi ng and del i very.

A transmi tter uses the setti ngs speci fi ed i n devi ces to determi ne how
reports are packaged and del i vered to the requi red del i very l ocati on.
For exampl e, some devi ces may i ndi cate that reports shoul d be
packaged usi ng MIME encodi ng, but others mi ght speci fy
U U Encodi ng. For i nformati on on devi ces and thei r setti ngs, see
C reati ng and Managi ng D evi ces, page 1025.

N oti fi cati on for transmi ssi on fai l ures can be confi gured for emai l
transmi tters as descri bed bel ow . N oti fi cati on for fi l e and pri nt
transmi ssi on fai l ures can be confi gured at the proj ect l evel , usi ng the
Proj ect C onfi gurati on Edi tor.

You create and confi gure transmi tters usi ng the Transmi tter Edi tor.

Reco mmen d ed Main t en an ce Tasks f o r Tr an smit t er s

Peri odi cal l y veri fy al l emai l addresses w here del i very success or
fai l ure noti fi cati on emai l s are bei ng sent. You can see these emai l
addresses i n the Transmi tter Edi tor, on the N oti fi cati on tab.

Best Pr act ices f o r Wo r kin g wit h Tr an smit t er s

l C onfi gure a devi ce to use each type of transmi tter and test a
del i very usi ng the devi ces to make sure the transmi tters are
effecti ve and the devi ces are w orki ng.

© 2019, M icr o St r at egy In c. 1017

Syst em Ad m in ist r at io n Gu id e

l You can easi l y test an emai l transmi tter by usi ng the Save to File
check box on the Emai l Transmi tter Edi tor's Message Output tab.

l To qui ckl y create a new transmi tter, dupl i cate an exi sti ng
transmi tter (such as an out-of-the-box transmi tter provi ded by
Mi croStrategy), and then change i ts setti ngs as requi red.

Viewin g an d Mo d if yin g a Tr an smit t er an d Accessin g t h e

Tr an smit t er Ed it o r
U si ng the Transmi tter Edi tor, you can vi ew and modi fy the defi ni ti on
of a transmi tter, rename the transmi tter, dupl i cate the transmi tter, and
so on.

To View a Transmitter or Modify its Settings

1. From the D evel oper Fol der Li st, expand A dministration, expand
D elivery Managers, and sel ect Transmitters.

2. In the Transmi tter Li st area on the ri ght, ri ght-cl i ck the transmi tter
that you w ant to vi ew or change setti ngs for.

3. Sel ect Edit.

4. C hange the transmi tter setti ngs as desi red.

5. C l i ck OK .

Cr eat in g a Tr an smit t er
In D evel oper, you can create the fol l ow i ng types of transmi tters:

l Emai l : An emai l transmi tter transforms a subscri bed report or

document and attaches i t to an emai l and sends the emai l to the
i nbox of the reci pi ent.

1018 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Fi l e: A fi l e transmi tter transforms a subscri bed report or document

i nto a fi l e (PD F, H TML, Mi crosoft Excel , pl ai n text, or C SV format)
and sends the fi l e to a fi l e storage l ocati on such as a fol der on a
netw ork computer.

l Pri nt: A pri nt transmi tter sends the subscri bed report or document to
a netw ork pri nter.

l FTP: An FTP transmi tter sends the subscri bed report or document to
an FTP server.

l Mobi l e: An i Pad or i Phone transmi tter sends the subscri bed report
or document to a user's i Pad or i Phone.

When a user subscri bes to a Mi croStrategy report, the report i s sent to

the appropri ate transmi tter for packagi ng and del i very. For exampl e, i f
the report i s to be del i vered to a fi l e l ocati on on a computer, the report
i s sent to a fi l e transmi tter for packagi ng and del i very. Si mi l arl y, i f the
report i s to be del i vered i n the form of an emai l to an emai l reci pi ent,
the report i s sent to an emai l transmi tter for packagi ng and del i very.

You create new transmi tters w hen you need a speci fi c combi nati on of
properti es and setti ngs for a fi l e, emai l , pri nt, FTP, or mobi l e
transmi tter to package fi l es.

A qui ck w ay to create a new transmi tter i s to dupl i cate an exi sti ng

transmi tter and then edi t i ts setti ngs to meet the needs for the new
transmi tter. Thi s i s a ti me-savi ng method i f a si mi l ar transmi tter
al ready exi sts, or you w ant to dupl i cate the defaul t Mi croStrategy
transmi tter. To dupl i cate a transmi tter, ri ght-cl i ck the transmi tter that
you w ant to dupl i cate and sel ect D uplicate.

You create and confi gure transmi tters usi ng the Transmi tter Edi tor.

© 2019, M icr o St r at egy In c. 1019

Syst em Ad m in ist r at io n Gu id e

Creating an Email Transmitter

An emai l transmi tter creates an emai l and transforms the subscri bed
report or document i nto an attachment to the emai l , then sends the
emai l to the i nbox of the reci pi ents w ho subscri bed to the fi l e.

Once an emai l transmi tter i s created, you can create emai l devi ces
that are based on that transmi tter. When you create a devi ce, the
transmi tter appears i n the l i st of exi sti ng transmi tters i n the Sel ect
D evi ce Type di al og box. The setti ngs you speci fi ed above for the
emai l transmi tter appl y to al l emai l devi ces that w i l l be based on the
transmi tter.

To Create an Email Transmitter

1. From the D evel oper Fol der Li st, expand A dministration, expand
D elivery Managers, and sel ect Transmitters.

2. R i ght-cl i ck i n the Transmi tter Li st area on the ri ght, sel ect N ew,
and sel ect Transmitter.

3. Sel ect Email and cl i ck OK .

4. C hange the transmi tter setti ngs as desi red.

5. C l i ck OK .

Creating a File Transmitter

A fi l e transmi tter transforms a subscri bed report or document i nto a

fi l e format that the user chooses w hi l e subscri bi ng to the report or
document. The fi l e transmi tter then sends the fi l e to a fi l e storage
l ocati on on a netw ork computer.

Once a fi l e transmi tter i s created, you can create fi l e devi ces that are
based on thi s transmi tter. When you create a devi ce, the transmi tter
appears i n the l i st of exi sti ng transmi tters i n the Sel ect D evi ce Type

1020 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

di al og box. The setti ngs you speci fi ed above for the fi l e transmi tter
appl y to al l fi l e devi ces that w i l l be based on the transmi tter.

For i nformati on on creati ng a fi l e devi ce, see C reati ng and Managi ng

D evi ces, page 1025.

To Create a File Transmitter

1. From the D evel oper Fol der Li st, expand A dministration, expand
D elivery Managers, and sel ect Transmitters.

2. R i ght-cl i ck i n the Transmi tter Li st area on the ri ght, sel ect N ew,
then sel ect Transmitter.

3. Sel ect File and cl i ck OK .

4. C hange the transmi tter setti ngs as desi red.

5. C l i ck OK .

Creating a Print Transmitter

A pri nt transmi tter sends the subscri bed report or document to a

netw ork pri nter.

Once a pri nt transmi tter i s created, you can create pri nt devi ces that
are based on the transmi tter. When you create a devi ce, the
transmi tter appears i n the l i st of exi sti ng transmi tters i n the Sel ect
D evi ce Type di al og box. The setti ngs you speci fi ed above for the pri nt
transmi tter appl y to al l pri nt devi ces that are based on the transmi tter.

For i nformati on on creati ng a pri nt devi ce, see C reati ng and

Managi ng D evi ces, page 1025.

© 2019, M icr o St r at egy In c. 1021

Syst em Ad m in ist r at io n Gu id e

To Create a Print Transmitter

1. From the D evel oper Fol der Li st, expand A dministration, expand
D elivery Managers, and sel ect Transmitters.

2. R i ght-cl i ck i n the Transmi tter Li st area on the ri ght, sel ect N ew,
and sel ect Transmitter.

3. Sel ect Print and cl i ck OK .

4. C hange the transmi tter setti ngs as desi red.

5. C l i ck OK .

Creating an FTP Transmitter

An FTP transmi tter transforms a subscri bed report or document i nto a

fi l e format that the user chooses w hi l e subscri bi ng to the report or
document. The FTP transmi tter then sends the fi l e to a l ocati on on an
FTP server.

Once an FTP transmi tter i s created, you can create FTP devi ces that
are based on the transmi tter. When you create a devi ce, the
transmi tter appears i n the l i st of exi sti ng transmi tters i n the Sel ect
D evi ce Type di al og box. The setti ngs you speci fi ed above for the FTP
transmi tter appl y to al l FTP devi ces that w i l l be based on the
transmi tter.

For i nformati on on creati ng an FTP devi ce, see C reati ng and

Managi ng D evi ces, page 1025.

To Create an FTP Transmitter

1. From the D evel oper Fol der Li st, expand A dministration, expand
D elivery Managers, and sel ect Transmitters.

1022 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

2. R i ght-cl i ck i n the Transmi tter Li st area on the ri ght, sel ect N ew,
then sel ect Transmitter.

3. Sel ect FTP and cl i ck OK .

4. C hange the transmi tter setti ngs as desi red.

5. C l i ck OK .

Creating an iPad Transmitter

An i Pad transmi tter i s used to push real -ti me updates of reports or

documents to a user's i Pad. The transmi tter transforms the subscri bed
report or document i nto a form that can be di spl ayed on the i Pad, then
i t sends the report or document to the subscri ber's i Pad.

After an i Pad subscri pti on transmi tter i s created, you can create i Pad
del i very devi ces that are based on the transmi tter. When you create a
devi ce, the transmi tter appears i n the l i st of exi sti ng transmi tters i n
the Sel ect D evi ce Type di al og box.

For i nformati on on creati ng an i Pad devi ce, see C reati ng and

Managi ng D evi ces, page 1025.

To Create a iPad Subscription Transmitter

1. From the D evel oper Fol der Li st, expand A dministration, expand
D elivery Managers, and sel ect Transmitters.

2. R i ght-cl i ck i n the Transmi tter Li st area on the ri ght, sel ect N ew,
and then Transmitter.

3. Sel ect iPad Push N otifications and cl i ck OK .

4. Speci fy a name and descri pti on for the transmi tter. The
descri pti on shoul d i ncl ude i nformati on about setti ngs for thi s
transmi tter to hel p users di sti ngui sh i t from other transmi tters, so

© 2019, M icr o St r at egy In c. 1023

Syst em Ad m in ist r at io n Gu id e

they know w hen to choose thi s transmi tter w hen associ ati ng
devi ces w i th i t.

5. C l i ck OK .

Creating an iPhone Transmitter

An i Phone transmi tter i s used to push real -ti me updates of reports or

documents to a user's i Phone. The transmi tter transforms the
subscri bed report or document i nto a form that can be di spl ayed on
the i Phone, then sends the report or document to the subscri ber's
i Phone.

After an i Phone transmi tter i s created, you can create i Phone del i very
devi ces that are based on the transmi tter. When you create a devi ce,
the transmi tter appears i n the l i st of exi sti ng transmi tters i n the Sel ect
D evi ce Type di al og box.

For i nformati on on creati ng an i Phone devi ce, see C reati ng and

Managi ng D evi ces, page 1025.

To Create a iPad Subscription Transmitter

1. From the D evel oper Fol der Li st, go to A dministration > D elivery
Managers > Transmitters.

2. R i ght-cl i ck i n the Transmi tter Li st area on the ri ght, sel ect N ew,
and then Transmitter.

3. Sel ect iPhone Push N otifications and cl i ck OK .

4. Speci fy a name and descri pti on for the transmi tter. The
descri pti on shoul d i ncl ude i nformati on about setti ngs for thi s
transmi tter to hel p users di sti ngui sh i t from other transmi tters, so
they know w hen to choose thi s transmi tter w hen associ ati ng
devi ces w i th i t.

5. C l i ck OK .

1024 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Delet in g a Tr an smit t er
You can del ete a transmi tter i f you no l onger need to use i t.

You c annot delete a trans mitter if dev ic es depend on the trans mitter. You
mus t firs t delete any dev ic es that depend on the trans mitter.

To Delete a Transmitter

1. From the D evel oper Fol der Li st, expand A dministration, expand
D elivery Managers, and sel ect Transmitters.

2. In the Transmi tter Li st area on the ri ght, ri ght-cl i ck the transmi tter
that you w ant to del ete.

3. Sel ect D elete. The C onfi rm D el ete Obj ect message i s di spl ayed.
See the prerequi si te above to be sure you have properl y
prepared the system to al l ow the transmi tter to be del eted.

4. C l i ck Yes.

Creating and Managing Devices

A devi ce speci fi es the format of a Mi croStrategy report or document
and the transmi ssi on process to send the report or document to users
w ho subscri be to that report or document.

For exampl e, i f you w ant to send reports vi a emai l , and your

reci pi ents use an emai l cl i ent such as Mi crosoft Outl ook, you can
create a Mi crosoft Outl ook emai l devi ce that has setti ngs appropri ate
for w orki ng w i th Outl ook. If you need to send reports to a fi l e l ocati on
on a computer on your netw ork, you can create a fi l e devi ce
speci fyi ng the netw ork fi l e l ocati on. If you w ant to send reports to a
pri nter on your netw ork, you can create a pri nter devi ce speci fyi ng the
netw ork pri nter l ocati on and pri nter properti es.

In D evel oper, you can create the fol l ow i ng types of devi ces:

© 2019, M icr o St r at egy In c. 1025

Syst em Ad m in ist r at io n Gu id e

l Emai l : An emai l devi ce automati cal l y sends a report or document i n

the form of an emai l to an emai l address. It can al so send the report
i n the form of a user-sel ected fi l e format as an attachment w i th the
emai l .

l Fi l e: A fi l e devi ce automati cal l y sends a Mi croStrategy report or

document i n a fi l e format that the user chooses w hen subscri bi ng to
the report, to a fi l e del i very l ocati on on a computer on your netw ork.
U sers can choose from the fol l ow i ng fi l e formats: C SV (comma-
separated val ues), PD F, H TML, MS Excel , and pl ai n text. When a
user subscri bes to a report or document, the fi l e devi ce sends the
report or document to the speci fi ed l ocati on w hen the subscri pti on
requi res i t to be sent. You can speci fy your netw ork fi l e l ocati on and
fi l e properti es for the fi l e devi ce to del i ver the fi l e to. For steps to
create a fi l e devi ce, see C reati ng a Fi l e D evi ce, page 1029.

l Pri nt: A pri nt devi ce automati cal l y sends a report or document to a

speci fi ed pri nter on your netw ork. You can defi ne the pri nter
properti es for the defaul t pri nt devi ce or you can use the standard
pri nter defaul ts. For steps to create a pri nt devi ce, see C reati ng a
Pri nt D evi ce, page 1035.

l FTP: An FTP devi ce automati cal l y sends a Mi croStrategy report or

document, i n a fi l e format the user chooses, to a del i very l ocati on
on an FTP server. U sers can choose from the fol l ow i ng fi l e formats:
C SV (command separated val ues), PD F, H TML, MS Excel , and
pl ai n text. U sers subscri be to a report or document, w hi ch tri ggers
the FTP devi ce to send the report or document to the speci fi ed
l ocati on w hen the subscri pti on requi res i t to be sent. For steps to
create an FTP devi ce, see C reati ng an FTP D evi ce, page 1036.

l Mobi l e: i Pad or i Phone devi ces automati cal l y send a report or

document to a user's i Pad or i Phone. For steps to create a mobi l e
devi ce, see C reati ng an i Pad D evi ce, page 1037 and C reati ng an
i Phone D evi ce, page 1038. These subscri pti ons are avai l abl e i f you

1026 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

have Mi croStrategy Mobi l e. For detai l ed i nformati on about mobi l e

subscri pti ons and Mi croStrategy Mobi l e, see the Mi croStrategy
Mobi l e Admi ni strati on Gui de.

You create new devi ces w hen you need a speci fi c combi nati on of
properti es and setti ngs for a devi ce to del i ver fi l es. You can create a
new devi ce i n tw o w ays. You can ei ther create a compl etel y new
devi ce and enter al l the supporti ng i nformati on for the devi ce
manual l y, or you can dupl i cate an exi sti ng devi ce and edi t the
supporti ng i nformati on so i t sui ts your new devi ce. You create and
confi gure devi ces usi ng the D evi ce Edi tor.

Dev ic es c an be c reated in a direc t c onnec tion (two-tier) mode, but print

and file loc ations for thos e dev ic es are not v alidated by the s y s tem.
Print and file loc ations for dev ic es c reated when in s erv er c onnec tion
mode (three-tier) are automatic ally v alidated by Mic roStrategy .

Reco mmen d ed Main t en an ce Tasks f o r Devices

l Peri odi cal l y veri fy al l del i very l ocati ons to be sure they are acti ve
and avai l abl e.

l For fi l e del i very l ocati ons, use the D evi ce Edi tor's Fi l e: General
tab and Fi l e: Advanced Properti es tab.

l For pri nter l ocati ons, use the D evi ce Edi tor's Pri nt: General tab
and Pri nt: Advanced Properti es tab.

l For FTP l ocati ons, use the D evi ce Edi tor's FTP: General tab.

l Test a del i very usi ng each devi ce to make sure that the devi ce
setti ngs are sti l l effecti ve and any system changes that have
occurred do not requi re changes to any devi ce setti ngs.

l If you experi ence pri nti ng or del i very ti meouts, use the D evi ce
Edi tor's Fi l e: Advanced Properti es tab and Pri nt: Advanced
Properti es tab to change ti meout, retry, and other del i very setti ngs.

© 2019, M icr o St r at egy In c. 1027

Syst em Ad m in ist r at io n Gu id e

Best Pr act ices f o r Wo r kin g wit h Devices

l You can al l ow users to sel ect thei r ow n fi l e del i very or pri nt
l ocati ons. U se the D evi ce Edi tor's Fi l e: General tab and Pri nt:
General tab to al l ow user-defi ned fi l e del i very and pri nt l ocati ons.
Any user-defi ned l ocati on overri des the pri mary fi l e del i very or pri nt
l ocati on speci fi ed i n the File Location or Printer Location fi el d,
w hi ch, i n turn, overri des any backup fi l e del i very or pri nt l ocati on
speci fi ed i n the Fi l e: Advanced Properti es tab or Pri nt: Advanced
Properti es tab.

l If you have a new emai l cl i ent that you w ant to use w i th D i stri buti on
Servi ces functi onal i ty, create a new emai l devi ce and appl y setti ngs
speci fi c to your new emai l appl i cati on. To create a new devi ce
qui ckl y, use the D uplicate opti on and then change the devi ce
setti ngs so they sui t your new emai l appl i cati on.

l If you rename a devi ce or change any setti ngs of a devi ce, test the
devi ce to make sure that the changes al l ow the devi ce to del i ver
reports or documents successful l y for users.

Viewin g an d Mo d if yin g a Device an d Accessin g t h e Device

Ed it o r s
U se the D evi ce Edi tor to vi ew and modi fy the defi ni ti on of a devi ce,
rename the devi ce, and so on.

To View a Device or Change its Settings

1. From the D evel oper Fol der Li st, go to A dministration > D elivery
Managers > D evices.

2. In the D evi ce Li st area on the ri ght, ri ght-cl i ck the devi ce that

you w ant to vi ew or change setti ngs for, and sel ect Edit.

1028 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

3. C hange the devi ce setti ngs as desi red.

4. C l i ck OK .

To rename a devi ce, ri ght-cl i ck the devi ce and sel ect R ename. Type
a new name, and then press Enter. When you rename a devi ce, the
contacts and subscri pti ons usi ng the devi ce are updated
automati cal l y.

Cr eat in g a File Device

A fi l e devi ce can automati cal l y send a report or document i n the form
of a fi l e to a storage l ocati on such as a fol der on a computer on your
netw ork. U sers subscri be to a report or document that tri ggers the fi l e
devi ce to send the subscri bed report or document to the speci fi ed
l ocati on w hen the subscri pti on requi res i t to be sent.

You create a new devi ce w hen you need a speci fi c combi nati on of
properti es and setti ngs for a fi l e devi ce to del i ver fi l es.

You must speci fy the fi l e properti es and the netw ork fi l e l ocati on for
the fi l e devi ce to del i ver fi l es to. You can i ncl ude properti es for the
del i vered fi l es such as havi ng the system set the fi l e to R ead-onl y,
l abel i t as Archi ve, and so on.

A qui ck w ay to create a new fi l e devi ce i s to dupl i cate an exi sti ng

devi ce and then edi t i ts setti ngs to meet the needs for thi s new
devi ce. Thi s i s a ti me-savi ng method i f a si mi l ar devi ce al ready
exi sts, or you w ant to dupl i cate the defaul t Mi croStrategy fi l e devi ce.
To dupl i cate a devi ce, ri ght-cl i ck the devi ce that you w ant to dupl i cate
and sel ect D uplicate.

© 2019, M icr o St r at egy In c. 1029

Syst em Ad m in ist r at io n Gu id e

To Create a New File Device

1. From the D evel oper Fol der Li st, go to A dministration > D elivery
Managers > D evices.

2. R i ght-cl i ck i n the D evi ce Li st area on the ri ght, sel ect N ew, and
then D evice.

3. Sel ect File and cl i ck OK .

4. C hange the devi ce setti ngs as desi red.

5. C l i ck OK .

Once the fi l e devi ce i s created, i t appears i n the l i st of exi sti ng fi l e

devi ces w hen you create an address (i n thi s case, a path to a fi l e
storage l ocati on such as a fol der) for a Mi croStrategy user or a
contact. You sel ect a fi l e devi ce and assi gn i t to the address you are
creati ng. When a user subscri bes to a report to be del i vered to thi s
address, the report i s del i vered to the fi l e del i very l ocati on speci fi ed
i n that address, usi ng the del i very setti ngs speci fi ed i n the associ ated
fi l e devi ce.

Default File Locations and Permissions

When a new devi ce i s created the fol l ow i ng defaul t val ues are
appl i ed to the fi l e. They can be accessed from the D evice Editor: File
w i ndow :

The ACL of a file is largely determined by the parent folder (and

rec urs iv ely to the root driv e) whic h is determined before deliv ery . The
adminis trator is res pons ible for s etting the ACL of the parent folder to
meet s pec ific s ec urity needs .

1030 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Gener al Tab

l File Location: < M i c r o S t r a t e g y I n s t a l l a t i o n

Pa th >\ Fi l e S u b s c r i p t i o n

l File System Options: The C reate required folders and A ppend

timestamp to file name opti ons are enabl ed.

Ad vanced Pr op er t i es Tab

l Wi ndow s: The R ead only checkbox w i l l be enabl ed.

l U ni x/Li nux: A ccess rights for the fi l e w i l l be set to r w -r -- r --

Personalizing File Locations

You can dynami cal l y speci fy the File Location and B ackup File
Location i n a fi l e devi ce usi ng macros. For exampl e, i f you speci fy
the File Location as C : \ R e p o r t s \{ & R e c i p i e n t N a m e } \, al l
subscri pti ons usi ng that fi l e devi ce are del i vered to subfol ders of
C:\R ep or ts \ . Subscri bed reports or documents for each reci pi ent
are del i vered to a subfol der w i th that reci pi ent's name, such as
C:\R ep or ts \ J a n e S m i t h \ or C : \ R e p o r t s \ H i r o
Prot ag on is t \ .

The tabl e bel ow l i sts the macros that can be used i n the File
Location and B ackup File Location fi el ds i n a fi l e devi ce:

De s c r iption Ma c r o

Dat e on which t he subscript ion is sent {&Date}

Time at which t he subscript ion is sent {&Time}

Name of t he recipient {&RecipientName}

User I D (32-charact er GUI D) of t he recipient {&RecipientID}

© 2019, M icr o St r at egy In c. 1031

Syst em Ad m in ist r at io n Gu id e

De s c r iption Ma c r o

Dist ribut ion S ervices address t hat t he subscript ion is delivered

{&AddressName}
to

File pat h t hat a dynamic recipient list subscript ion is delivered {&RecipientList
to Address}

You can al so have a subscri pti on dynami cal l y create subfol ders
accordi ng to attri butes i n a report's page-by axi s or a document's
group-by area and pl ace the report or document there. For steps, see
C reati ng Subscri pti ons, page 992.

Delivering Files from a UNIX Intelligence Server to a Windows File

Location

If your Intel l i gence Server machi ne i s usi ng U N IX or Li nux, you can

confi gure your system to del i ver fi l es to l ocati ons on Wi ndow s
machi nes.

Thi s process uses Shari ty softw are to resol ve the Wi ndow s fi l e

l ocati on as a mount on the U N IX machi ne. Intel l i gence Server can
then treat the Wi ndow s fi l e l ocati on as though i t w ere a U N IX fi l e
l ocati on.

You mus t hav e a lic ens e for Mic roStrategy Dis tribution Serv ic es before y ou
c an us e file s ubs c riptions .

Sharity mus t be ins talled on the Intelligenc e Serv er mac hine. For
information about Sharity , s ee the Sharity webs ite at:
ht tp :/ /w ww . o b d e v . a t / p r o d u c t s / s h a r i t y / i n d e x . h t m l .

1032 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To Set Up File Delivery from a UNIX Intelligence Server to a

Windows Location

1. Make sure Shari ty i s confi gured on the Intel l i gence Server

machi ne.

2. C reate a new fi l e devi ce or edi t an exi sti ng fi l e devi ce (see

C reati ng a Fi l e D evi ce, page 1029).

3. In the Fi l e D evi ce Edi tor, on the C ross-Platform D elivery with

Sharity™ tab, sel ect the Enable delivery from Intelligence
Server running on U N IX to Windows check box.

4. In the U ser N ame fi el d, type the Wi ndow s netw ork l ogi n that i s
used to access the Wi ndow s fi l e l ocati on for mounti ng on the
Intel l i gence Server.

5. In the Password fi el d, type the passw ord for that user name.

6. In the Mount R oot fi el d, type the l ocati on on the Intel l i gence

Server machi ne w here the mount i s stored. Make sure thi s i s a
properl y formed U N IX path, usi ng forw ard sl ashes / to separate
di rectori es. For exampl e:
/b in /S h a r i t y / M o u n t 1

7. C l i ck OK .

Cr eat in g an Email Device

An emai l devi ce automati cal l y sends emai l s, w hi ch contai n reports or
documents that have been subscri bed to by users, or for users by
other users or admi ni strators. You create a new emai l devi ce
w henever you need a speci fi c combi nati on of properti es and setti ngs
to del i ver fi l es vi a emai l . For exampl e, an emai l sent through
Mi crosoft Outl ook requi res a devi ce w i th setti ngs that are di fferent
from an emai l sent through a w eb-based emai l account.

© 2019, M icr o St r at egy In c. 1033

Syst em Ad m in ist r at io n Gu id e

You can speci fy vari ous MIME opti ons for the emai l s sent by an emai l
devi ce, such as the type of encodi ng for the emai l s, the type of
attachments the emai l s, can support, and so on.

A qui ck w ay to create a new emai l devi ce i s to dupl i cate an exi sti ng

devi ce and then edi t i ts setti ngs to meet the needs for thi s new
devi ce. Thi s i s a ti me-savi ng method i f you have a si mi l ar devi ce
al ready created, or you w ant to make use of the defaul t Mi croStrategy
emai l devi ce. To dupl i cate a devi ce, ri ght-cl i ck the devi ce that you
w ant to dupl i cate and sel ect D uplicate.

An unders tanding of y our organiz ation's email s erv er or other email

deliv ery s y s tems .

To Create a New Email Device

1. From the D evel oper Fol der Li st, go to A dministration > D elivery
Managers > D evices.

2. R i ght-cl i ck i n any open space i n the D evi ce Li st area on the

ri ght, sel ect N ew, and then D evice.

3. Sel ect Email and cl i ck OK .

4. C hange the devi ce setti ngs as desi red.

5. C l i ck OK .

Once an emai l devi ce i s created, i t appears i n the l i st of exi sti ng

emai l devi ces w hen you create an address for a Mi croStrategy user or
a contact. You sel ect an emai l devi ce and assi gn i t to the address you
are creati ng. When a user subscri bes to a report to be sent to thi s
address, the report i s sent to the emai l reci pi ent speci fi ed i n that
address, usi ng the del i very setti ngs speci fi ed i n the associ ated emai l
devi ce.

1034 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Cr eat in g a Pr in t Device
A pri nt devi ce sends a report or document to a speci fi ed netw ork
pri nter, w here the report or document i s automati cal l y pri nted. You
create a new pri nt devi ce w henever you need a speci fi c combi nati on
of properti es and setti ngs to del i ver fi l es to a pri nter. You can create a
new pri nt devi ce, defi ne new pri nter properti es for the defaul t pri nt
devi ce that comes w i th Mi croStrategy, or use the defaul t devi ce w i th
i ts defaul t pri nter setti ngs.

If you are creati ng a pri nt devi ce to del i ver a report or document to a

dynami c reci pi ent l i st, you can dynami cal l y speci fy the pri nter
l ocati on usi ng the { & R e ci p i e n t L i s t A d d r es s } macro. When the
subscri pti on i s run, the macro i s repl aced w i th the Physi cal Address
speci fi ed i n i ts dynami c reci pi ent l i st. For more i nformati on on
dynami c reci pi ent l i sts, see C reati ng Subscri pti ons, page 992.

The s elec ted printer mus t be added to the lis t of printers on the mac hine on
whic h Intelligenc e Serv er is running.

To Create a New Print Device

1. From the D evel oper Fol der Li st, go to A dministration > D elivery
Managers > D evices.

2. R i ght-cl i ck i n the D evi ce Li st area on the ri ght, sel ect N ew, and
then D evice.

3. Sel ect Print and cl i ck OK .

4. C hange the devi ce setti ngs as desi red.

5. C l i ck OK .

Once a pri nt devi ce i s created, i t appears i n the l i st of exi sti ng pri nt

devi ces w hen you create an address (i n thi s case, a path to the
pri nter) for a Mi croStrategy user or a contact. You sel ect a pri nt

© 2019, M icr o St r at egy In c. 1035

Syst em Ad m in ist r at io n Gu id e

devi ce and assi gn i t to the address you are creati ng. When a user
subscri bes to a report to be sent to thi s address, the report i s sent to
the pri nter speci fi ed i n that address, usi ng the del i very setti ngs
speci fi ed i n the associ ated pri nt devi ce. For detai l s on creati ng an
address for a user or on creati ng a contact and addi ng addresses to
the contact, cl i ck H elp.

Cr eat in g an FTP Device

An FTP devi ce automati cal l y sends a report or document i n the form
of a fi l e to a l ocati on on an FTP server. U sers subscri be to a report or
document, w hi ch tri ggers the FTP devi ce to send the subscri bed
report or document to the speci fi ed l ocati on w hen the subscri pti on
requi res i t to be sent.

You create a new devi ce w henever you need a speci fi c combi nati on
of properti es and setti ngs for an FTP devi ce to del i ver fi l es.

A qui ck w ay to create a new FTP devi ce i s to dupl i cate an exi sti ng

devi ce and then edi t i ts setti ngs to meet the needs for thi s new
devi ce. Thi s i s a ti me-savi ng method i f you have a si mi l ar devi ce
al ready created, or you w ant to make use of the defaul t Mi croStrategy
FTP devi ce. To dupl i cate a devi ce, ri ght-cl i ck the devi ce that you
w ant to dupl i cate and sel ect D uplicate.

To Create a New FTP Device

1. From the D evel oper Fol der Li st, go to A dministration > D elivery
Managers > D evices.

2. R i ght-cl i ck i n the D evi ce Li st area on the ri ght, sel ect N ew, and
then D evice.

3. Sel ect FTP and cl i ck OK .

1036 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

4. C hange the devi ce setti ngs as desi red.

5. C l i ck OK .

Once the FTP devi ce i s created, i t appears i n the l i st of exi sti ng FTP
devi ces. When you create an address for a Mi croStrategy user or a
contact, you can sel ect an FTP devi ce and assi gn i t to the address
you are creati ng. When a user subscri bes to a report to be del i vered
to thi s address, the report i s del i vered to the del i very l ocati on
speci fi ed i n that address, usi ng the del i very setti ngs speci fi ed i n the
associ ated FTP devi ce. For detai l s on creati ng an address for a user
or on creati ng a contact and addi ng addresses to the contact, cl i ck
H elp.

For i nformati on on creati ng contacts, see C reati ng and Managi ng

C ontacts, page 1040.

Cr eat in g an iPad Device

An i Pad del i very devi ce i s used to automati cal l y push real -ti me
updates of reports or documents to a user's i Pad, w hen the report or
document i s updated. U sers subscri be to a report or document, w hi ch
tri ggers the i Pad devi ce to send the subscri bed report or document to
the user's i Pad.

You create a new devi ce w henever you need a speci fi c combi nati on
of properti es and setti ngs for an i Pad devi ce to del i ver reports or
documents.

A qui ck w ay to create a new i Pad devi ce i s to dupl i cate an exi sti ng

devi ce and then edi t i ts setti ngs to meet the needs for the new devi ce.
Thi s i s a ti me-savi ng method i f you have a si mi l ar devi ce al ready
created, or you w ant to dupl i cate the defaul t Mi croStrategy i Pad
devi ce. To dupl i cate a devi ce, ri ght-cl i ck the devi ce that you w ant to
dupl i cate and sel ect D uplicate.

© 2019, M icr o St r at egy In c. 1037

Syst em Ad m in ist r at io n Gu id e

To Create an iPad Device

1. In D evel oper, from the Fol der Li st on the l eft, go to

A dministration > D elivery Managers > D evices.

2. R i ght-cl i ck i n the D evi ce Li st area on the ri ght, sel ect N ew, and
then D evice.

3. Sel ect MobileA PN SForIPad and cl i ck OK .

4. Type i n or sel ect val ues for the devi ce setti ngs.

5. C l i ck OK .

After an i Pad del i very devi ce i s created, you see i t i n the l i st of

exi sti ng i Pad devi ces w hen you create an address for a Mi croStrategy
user or a contact. You sel ect an i Pad devi ce and assi gn i t to the
address you are creati ng. When a user subscri bes to a report to be
del i vered to thi s address, the report i s del i vered to the i Pad speci fi ed
i n that address, usi ng the del i very setti ngs speci fi ed i n the associ ated
i Pad devi ce.

For i nformati on on creati ng contacts, see C reati ng and Managi ng

C ontacts, page 1040.

Cr eat in g an iPh o n e Device

An i Phone del i very devi ce i s used to automati cal l y push real -ti me
updates of reports or documents to a user's i Phone, w hen the report
or document i s updated. An i Phone del i very devi ce automati cal l y
sends fi l es that contai n reports or documents that have been
subscri bed to by users.

You create a new devi ce w henever you need a speci fi c combi nati on
of properti es and setti ngs for an i Phone devi ce to del i ver reports or
documents.

1038 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

A qui ck w ay to create a new i Phone devi ce i s to dupl i cate an exi sti ng

devi ce and then edi t i ts setti ngs to meet the needs for the new devi ce.
Thi s i s a ti me-savi ng method i f you have a si mi l ar devi ce al ready
created, or you w ant to dupl i cate the defaul t Mi croStrategy i Phone
devi ce. To dupl i cate a devi ce, ri ght-cl i ck the devi ce that you w ant to
dupl i cate and sel ect D uplicate.

To Create an iPhone Device

1. In D evel oper, from the Fol der Li st on the l eft, go to

A dministration > D elivery Managers > D evices.

2. R i ght-cl i ck i n the D evi ce Li st area on the ri ght, sel ect N ew, and
then D evice.

3. Sel ect MobileA PN SForIPhone and cl i ck OK .

4. Type i n or sel ect val ues for the devi ce setti ngs.

5. C l i ck OK .

After an i Phone del i very devi ce i s created, you see i t i n the l i st of

exi sti ng i Phone devi ces w hen you create an address for a
Mi croStrategy user or a contact. You sel ect an i Phone devi ce and
assi gn i t to the address you are creati ng. When a user subscri bes to a
report to be del i vered to thi s address, the report i s del i vered to the
i Phone speci fi ed i n that address, usi ng the del i very setti ngs speci fi ed
i n the associ ated i Phone devi ce.

For i nformati on on creati ng contacts, see C reati ng and Managi ng

C ontacts, page 1040.

Delet in g a Device
You can del ete a devi ce i f i t i s no l onger needed.

Update the c ontac ts and s ubs c riptions that are us ing the dev ic e by

© 2019, M icr o St r at egy In c. 1039

Syst em Ad m in ist r at io n Gu id e

replac ing the dev ic e with a different one. To do this , c hec k whether the
dev ic e y ou want to delete is us ed by any ex is ting addres s es :

l To find c ontac ts , from the Dev eloper Folder Lis t, go to A dministration >
D elivery Managers > C ontacts. In View Options , s elec t the dev ic e
name.

l To find s ubs c riptions that are dependent on the dev ic e, right-c lic k eac h
c ontac t and s elec t Search for dependent subscriptions .

To Delete a Device

1. From the D evel oper Fol der Li st, go to A dministration > D elivery
Managers > D evices.

2. In the D evi ce Li st area on the ri ght, ri ght-cl i ck the devi ce you

w ant to del ete.

3. Sel ect D elete.

Creating and Managing Contacts

A contact i s a Mi croStrategy obj ect that represents a del i very address
(an emai l address, a fi l e storage l ocati on on a netw ork, a netw ork
pri nter path, or a l ocati on on an FTP server). Mi croStrategy users
sel ect a contact w hen they subscri be themsel ves or other users to
reports or documents. They do so by sel ecti ng a contact name, rather
than havi ng to speci fy emai l addresses, fi l e storage l ocati ons, pri nter
l ocati ons, or FTP server l ocati ons at the ti me of report subscri pti on.
D ependi ng on needs, a user may requi re mul ti pl e del i very l ocati ons
of di fferent types, such as a w ork and a personal emai l address,
several fi l e storage l ocati ons, and one or more pri nter or FTP server
l ocati ons. To make i t easi er to manage al l del i very addresses for your
users, you create contacts.

C ontacts can al so be used w hen you w ant to del i ver reports or

documents to peopl e w ho are not Mi croStrategy users.

1040 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

As an alternativ e to c ontac ts , y ou c an deliv er reports and doc uments by

s ubs c ribing indiv idual addres s es and related pers onaliz ation that are
s tored in s ourc es other than the metadata. Dy namic rec ipient lis ts are
bas ed on a s pec ial s ourc e report y ou c reate that c ontains email
addres s es , us er IDs , and c hos en dev ic es to whic h to deliv er s tandard
Mic roStrategy reports and doc uments . For details , s ee C reati ng
Subscri pti ons, page 992 .

To be avai l abl e for subscri pti ons, a new l y created contact must be
l i nked to a Mi croStrategy user. The securi ty for a contact and i ts
associ ated del i very comes from thi s l i nked user. The user l i nked to
the contact can have reports and documents subscri bed to the contact
and thus the reports and documents are del i vered to the emai l
address or del i very l ocati on i n that contact.

C ontacts can al so be combi ned i nto groups so that i t i s easi er to

sel ect mul ti pl e contacts for a subscri pti on. You can assi gn a securi ty
fi l ter to the contact group, or you can choose to use the securi ty fi l ters
l i nked to the users.

Unders tand y our us ers ' requirements for file and printer deliv ery loc ations ,
and email addres s es , as well as the reports and doc uments they are lik ely
to s ubs c ribe to or be s ubs c ribed to.

Unders tand s ec urity requirements for any c ontac ts y ou plan to c reate. The
Mic roStrategy us er who is link ed to the c ontac t defines the s ec urity applied
to the c ontac t addres s (email addres s or file or printer network path).

Hav e adminis trator priv ileges .

Reco mmen d ed Main t en an ce Tasks f o r Co n t act s

l Veri fy del i very addresses to be sure they are acti ve and avai l abl e.
The Physi cal Address col umn i n the C ontact Li st area di spl ays the
fi l e storage l ocati ons, emai l addresses, and pri nter l ocati ons w here

© 2019, M icr o St r at egy In c. 1041

Syst em Ad m in ist r at io n Gu id e

reports and documents are to be del i vered. If the Physi cal Address
col umn i s not vi si bl e i n the C ontact Li st area, ri ght-cl i ck to di spl ay
i t.

l For server outages or mai ntenance:

l C hange the defaul t del i very l ocati on of affected contacts to

another avai l abl e l ocati on. You set del i very l ocati ons on the
C ontact Edi tor's Addresses tab.

l Al ternati vel y, for short-term server outages, di sabl e the contacts

that are set up to del i ver to those servers, and then enabl e them
agai n after the servers are up agai n. You di sabl e and enabl e
contacts on the C ontact Edi tor's General tab.

l C heck the l i st of Mi croStrategy users l i nked to contacts to veri fy

w hether a user has been del eted from the system. If a user has
been del eted, you may w ant to del ete or di sabl e the associ ated
contacts.

l If the user l i nked to one or more contacts does not need to recei ve
subscri bed reports and documents, del ete any associ ated contacts.

l If the del i very of a user's subscri bed reports or documents needs to

be stopped for some ti me, di sabl e any associ ated contacts.

l Before del eti ng a contact, search for subscri pti ons dependent on
the contact by ri ght-cl i cki ng the contact and sel ecti ng Search for
dependent subscriptions. D el ete those subscri pti ons after you
have del eted the contact.

l Peri odi cal l y check the status of contacts or contact groups,

speci fi cal l y the l i st of di sabl ed contacts and contact groups, and
revi ew that status. You can fi l ter the contacts so that the C ontact
Li st area di spl ays onl y those contacts that are di sabl ed.

1042 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Best Pr act ices f o r Wo r kin g wit h Co n t act s

l U se Tree Vi ew i n the C ontact Li st area. Thi s vi ew refl ects your
organi zati on's structure and hel ps you vi sual i ze how to create
contact groups accordi ng to users w ho w i l l recei ve the same
subscri bed reports. Tree Vi ew can be hel pful as your l i st of contacts
grow s l arger because i t i s easy to col l apse and expand groupi ngs of
contacts.

l If you have many contacts and contact groups, use the fi l ter to
restri ct the number of contacts you are vi ew i ng w hen performi ng
contact mai ntenance tasks. For steps to use the fi l ter, cl i ck H elp.

l To create a new contact usi ng the fastest method, dupl i cate an

exi sti ng contact and then change the detai l s as requi red.

l When creati ng many new contacts or mai ntai ni ng a number of

contacts by movi ng del i very l ocati ons (addresses) betw een them,
copy and paste the addresses betw een the contacts.

l Before di sabl i ng or del eti ng a contact, use the Search for

dependent subscriptions opti on to revi ew subscri pti ons that mi ght
be affected by your acti on.

Viewin g an d Mo d if yin g a Co n t act an d Accessin g t h e Co n t act

List Ar ea
You can vi ew and modi fy the defi ni ti on of a contact, rename the
contact, dupl i cate the contact, del ete or di sabl e a contact, and so on,
usi ng the C ontact Edi tor.

To View a Contact or Change its Settings

1. From the D evel oper Fol der Li st, go to A dministration > D elivery
Managers > C ontacts.

© 2019, M icr o St r at egy In c. 1043

Syst em Ad m in ist r at io n Gu id e

2. In the C ontact Li st area on the ri ght, ri ght-cl i ck the contact that

you w ant to vi ew or change setti ngs for.

3. Sel ect Edit

4. C hange the name, descri pti on, or other setti ngs of the contact.

5. C l i ck OK .

In addi ti on to modi fyi ng the defi ni ti on of a contact, you can perform

the fol l ow i ng operati ons on a contact by ri ght-cl i cki ng i t:

l D uplicate: C reates a copy of the contact. See C reati ng a C ontact,

page 1045.

l R ename: Al l ow s you to rename the sel ected contact. R i ght-cl i ck the

contact and sel ect R ename. Type a new name and then press
Enter.

l C opy: C opi es the sel ected address.

l Paste: Acti ve onl y w hen you have copi ed an address. Adds the
copi ed address to the sel ected contact.

l D elete: D el etes the sel ected contact. For i mportant w arni ngs and
other detai l s, see D el eti ng a C ontact, page 1050.

l D isable C ontact/Enable C ontact: D i sabl es or enabl es the sel ected

contact. D i sabl i ng a contact means the contact w i l l no l onger be
avai l abl e for report or document subscri pti on. For exampl e, thi s
opti on i s useful w hen a pri nter or server i s dow n for mai ntenance
and the del i very address (path to the pri nter or fi l e storage l ocati on)
associ ated w i th the contact i s not avai l abl e for a ti me.

l Show C ontact Group Membership: Opens the Member of tab of the

C ontact Edi tor for the sel ected contact. Thi s tab di spl ays a l i st of
contact groups that thi s contact i s a member of.

1044 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Search for dependent subscriptions: D i spl ays a l i st of report and

document subscri pti ons that are dependent on thi s contact. Thi s
opti on i s i mportant to use before you del ete a contact.

Cr eat in g a Co n t act
You create a new contact for each del i very address that reports and
documents w i l l be del i vered to.

A qui ck w ay to create a new contact i s to dupl i cate an exi sti ng contact

and then edi t i ts setti ngs to meet the needs for thi s new contact. Thi s
i s a ti me-savi ng method i f a si mi l ar contact al ready exi sts or i f you
w ant to make use of the defaul t Mi croStrategy contact. To dupl i cate a
contact, ri ght-cl i ck the contact that you w ant to dupl i cate and sel ect
D uplicate.

To Create a Contact

1. From the D evel oper Fol der Li st, go to A dministration > D elivery
Managers > C ontacts.

2. R i ght-cl i ck i n the C ontact Li st area on the ri ght, sel ect N ew, and
then C ontact.

3. C hange the contact setti ngs as desi red.

4. C l i ck OK .

After a contact i s created, i t must be l i nked to a Mi croStrategy user to

be avai l abl e for report or document subscri pti ons. A contact does not
have any credenti al s or securi ty profi l e associ ated w i th i t. Because
the system needs a securi ty profi l e to execute the reports and
documents subscri bed to a contact, the contact must be l i nked to a
Mi croStrategy user for the requi red securi ty profi l e. Thi s means that
w hen a subscri bed report i s sent to a contact address, the report i s

© 2019, M icr o St r at egy In c. 1045

Syst em Ad m in ist r at io n Gu id e

executed usi ng the credenti al s and the securi ty profi l e of the l i nked
user.

To Link a Contact to a User

1. D oubl e-cl i ck a user to open the U ser Edi tor.

2. Expand D eliveries, then sel ect C ontacts.

3. C l i ck A dd to open the Li nk C ontacts to U ser di al og box.

4. Sel ect one or more contacts to l i nk to the user. Press C TR L to

sel ect mul ti pl e contacts. You can narrow the l i st of contacts
di spl ayed i n the pane by doi ng one of the fol l ow i ng:

l To search for the contact by name, type the contact name i n

the search fi el d.

l C hoose a group from the drop-dow n l i st. The pane i s updated

to i ncl ude onl y contacts bel ongi ng to that group.

5. C l i ck the ri ght arrow > to move the contacts to the ri ght.

6. C l i ck OK to l i nk the contacts and return to the U ser Edi tor.

Cr eat in g a Co n t act Gr o u p
A contact group i s a set of contacts that are combi ned under one
name. C ontact groups are useful to create w hen certai n reports must
be sent to mul ti pl e contacts. For exampl e, i f four contacts need to
recei ve the same subscri bed reports, you can group the contacts i nto
a contact group and subscri be the contact group to the reports, rather
than subscri bi ng each contact i ndi vi dual l y.

Once a contact group i s created, i t must be l i nked to a Mi croStrategy

user to be avai l abl e for subscri pti ons. A contact group w i thout a
l i nked user does not have any l ogi n credenti al s or securi ty profi l e
associ ated w i th i t. Because the system needs a securi ty profi l e to

1046 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

execute the reports and documents subscri bed to a contact group, the
contact group must be l i nked to a Mi croStrategy user for the requi red
securi ty profi l e. Thi s means that w hen a subscri bed report needs to
be sent to a contact group, the report i s executed usi ng the
credenti al s and the securi ty profi l e of the l i nked user.

A c ontac t group is s imilar to a Mic ros oft Outlook dis tribution lis t; eac h
member c ontac t of a c ontac t group rec eiv es the s ame s ubs c ribed
reports when the c ontac t group is c hos en as the rec ipient of a
s ubs c ription. Therefore, if a c ontac t s hould not rec eiv e c ertain reports ,
the c ontac t s hould not be made a part of a c ontac t group.

To Create a Contact Group

1. From the D evel oper Fol der Li st, go to A dministration > D elivery
Managers > C ontacts.

2. R i ght-cl i ck i n the C ontact Li st area on the ri ght, sel ect N ew, and
then C ontact Group.

3. C hange the contact setti ngs as desi red.

A c ontac t group mus t be link ed to a us er for its c ontac ts to be

av ailable for report and doc ument s ubs c ription.

4. C l i ck OK .

Placing Multiple Contact Groups in a Contact Group

You can al so group mul ti pl e contact groups i nto one contact group.
Groupi ng mul ti pl e contact groups i nto a contact group makes i t easy
to send out w i de-di stri buti on reports that have no securi ty
i mpl i cati ons, such as an empl oyee bi rthday l i st that i s sent out at the
begi nni ng of every month.

© 2019, M icr o St r at egy In c. 1047

Syst em Ad m in ist r at io n Gu id e

Al l members (contacts) of each contact group i n the top-l evel contact

group recei ve the same subscri bed reports, w hen the top-l evel
contact group i s chosen as the reci pi ent of a subscri pti on.

Main t ain in g a Lin ked User

A contact must be l i nked to a Mi croStrategy user to be avai l abl e for
subscri pti ons. A contact does not have any credenti al s or securi ty
profi l e associ ated w i th i t. Because the system needs a securi ty profi l e
to execute the reports and documents subscri bed to a contact, the
contact must be l i nked to a Mi croStrategy user for the requi red
securi ty profi l e. Thi s means that w hen a subscri bed report i s sent to a
contact, the report i s executed usi ng the l ogi n credenti al s and the
securi ty profi l e of the l i nked user.

The C ontact Li st area di spl ays a l i st of users l i nked to contacts, al ong

w i th the l i st of contacts and contact groups. R i ght-cl i ck a user and
sel ect from the fol l ow i ng opti ons:

l Edit: Opens the U ser Edi tor for the sel ected user.

Any c hanges made to the us er ac c ount in the Us er Editor will affec t

the us er's ac c ount ac ros s the Mic roStrategy s y s tem.

l R ename: R i ght-cl i ck the user and sel ect R ename.

l C opy: C opi es the sel ected del i very l ocati on (address).

l Paste: Acti ve onl y w hen you have copi ed a del i very l ocati on
(address). Adds the copi ed address to the sel ected user.

l D elete: D el etes user's del i very l ocati ons (addresses). For i mportant
prerequi si tes and other detai l s, see D el eti ng a C ontact, page 1050.

l D isable C ontact: D i sabl es user's del i very l ocati ons (addresses). If

a user's addresses are di sabl ed, the user cannot be subscri bed to
reports. If some reports are al ready subscri bed to the di sabl ed

1048 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

contacts and thei r associ ated addresses, the reports are not
del i vered to the addresses unl ess the contact i s enabl ed agai n.

Dis abling a us er's addres s es does not dis able the us er ac c ount in
Mic roStrategy .

l Show C ontact Group Membership: D i spl ays a l i st of contact

groups to w hi ch the user bel ongs.

l Search for dependent subscriptions: D i spl ays a l i st of reports

and documents subscri bed to by thi s user.

Main t ain in g Ad d r esses

An address i s any del i very l ocati on for a report or document
subscri pti on. An address can be the path to a fol der on a netw ork or
FTP server for fi l e storage, a pri nter path, or an emai l address.

A Mi croStrategy user can have several emai l , fi l e, pri nter, or FTP

server addresses for subscri bed reports to be del i vered to w hen the
user subscri bes to or i s subscri bed to a report. C ontacts (each
contai ni ng an address) are l i nked to the user. You can create and add
addresses for a user i n the D eliveries: A ddresses category of the
U ser Edi tor.

In the C ontacts Li st area, ri ght-cl i ck an address for a contact or a user

and sel ect from the fol l ow i ng opti ons:

l Edit: Opens the U ser Edi tor to the D el i veri es: Addresses category i f
you ri ght-cl i ck an address w i thi n a user. Opens the C ontact Edi tor:
Addresses tab i f you ri ght-cl i ck an address w i thi n a contact.

l R ename: R i ght-cl i ck the address and sel ect R ename.

l C opy: C opi es the sel ected address.

l Paste: Adds the copi ed address to the contact or the user.

© 2019, M icr o St r at egy In c. 1049

Syst em Ad m in ist r at io n Gu id e

l D elete: D el etes the sel ected address.

l Search for dependent subscriptions: D i spl ays a l i st of reports

and documents dependent on thi s address.

Delet in g a Co n t act
You can del ete a contact i f you no l onger w ant subscri bed reports or
documents to be del i vered to the address w i thi n that contact.
D ependi ng on your reasons for del eti ng a contact, an al ternati ve may
be to di sabl e the contact. For exampl e, i f you w ant report del i veri es to
a contact to be stopped for some ti me, you may di sabl e the contact
rather than del eti ng i t. Later, you can easi l y and qui ckl y enabl e the
contact to resume the report del i veri es to that contact.

Chec k to s ee whether y ou need to s av e any of the deliv ery loc ations

(addres s es ) that mak e up the c ontac t that y ou plan to delete. To do this ,
firs t s earc h for s ubs c riptions that are dependent on the c ontac t by right-
c lic k ing the c ontac t and s elec ting Search for dependent
subscriptions . If y ou want thos e s ubs c riptions to c ontinue to be s ent to
any of the c ontac t's deliv ery loc ations , c reate a new c ontac t and then
c opy /pas te that deliv ery loc ation into the new c ontac t.

To Delete a Contact

1. From the D evel oper Fol der Li st, go to A dministration > D elivery
Managers > C ontacts.

2. In the C ontact Li st area on the ri ght, ri ght-cl i ck the contact you

w ant to del ete.

3. Sel ect D elete.

4. C l i ck Yes.

105 0 © 2019, M icr o St r at egy In c.

 13
ADM INISTERING
M ICRO STRATEGY WEB
AND M OBILE

© 2019, M icr o St r at egy In c. 105 1

Syst em Ad m in ist r at io n Gu id e

As a Mi croStrategy system admi ni strator, you may be responsi bl e for

managi ng Mi croStrategy Web and Mobi l e envi ronments. Some of
these tasks are performed i n the D evel oper i nterface, such as
managi ng user and group pri vi l eges for Web users, or regi steri ng a
proj ect i n server (3-ti er) mode so i t can be avai l abl e i n Web. H ow ever,
other admi ni strati ve parameters are set usi ng the Mi croStrategy Web
or Mobi l e Server admi ni strati ve i nterface. In addi ti on, confi guri ng your
mobi l e devi ces can be done through the Mobi l e Server Admi ni strator.

In addi ti on to the i nformati on i n thi s secti on, each opti on i n the

Mi croStrategy Web or Mobi l e Server admi ni strati on i nterface i s
documented i n the rel evant H el p system.

Topi cs covered i n thi s secti on are:

Assigning Privileges for MicroStrategy Web

Mi croStrategy Web products are avai l abl e i n three di fferent edi ti ons,
each havi ng an associ ated set of pri vi l eges. The number of users
assi gnabl e to any one edi ti on i s based on your l i cense agreement.

Mi croStrategy provi des these edi ti ons for Mi croStrategy Web

products:

l Web Professi onal or Web Professi onal

l Web Anal yst or Web Anal yst

l Web R eporter or Web R eporter

The pri vi l eges avai l abl e i n each edi ti on are l i sted i n the Li st of
Pri vi l eges secti on. You can al so pri nt a report of al l pri vi l eges
assi gned to each user based on l i cense type; to do thi s, see Audi ti ng
Your System for the Proper Li censes, page 385.

All Mic roStrategy Web us ers that are lic ens ed for Mic roStrategy Report

105 2 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Serv ic es may v iew and interac t with a doc ument in Flas h Mode. Certain
interac tions in Flas h Mode hav e additional lic ens ing requirements :

l Us ers are required to lic ens e Mic roStrategy Web Analy s t to piv ot row
or c olumn pos ition in a grid or c ros s -tabular grid of data in Flas h
Mode.

l Us ers are required to lic ens e Mic roStrategy Web Profes s ional to
modify the properties of Widgets us ed in a doc ument in Flas h Mode.

A user assi gned to an edi ti on i s enti tl ed to a compl ete set, or

i denti fi ed subset, of the pri vi l eges l i sted for that edi ti on.

If a user i s assi gned to mul ti pl e user groups, the pri vi l eges of those
groups are addi ti ve, and determi ne the edi ti on usage of that parti cul ar
user. For exampl e, i f a user i s a member of both the Fi nance and the
Accounti ng user groups, pri vi l eges for that user are equi val ent to the
cumul ati ve set of pri vi l eges assi gned to those tw o groups.

One pri vi l ege, Web Admi ni strati on, can be assi gned to any edi ti on of
Web user. Thi s pri vi l ege al l ow s the user to access the Web
Admi ni strator page to manage server connecti ons, and to access the
Proj ect defaul ts l i nk on the Preferences page to set defaul ts for al l
users.

The Mi croStrategy securi ty model enabl es you to set up user groups

that can have subgroups w i thi n them, thus creati ng a hi erarchy. The
fol l ow i ng appl i es to the creati on of user subgroups:

l A chi l d subgroup automati cal l y i nheri ts pri vi l eges assi gned to i ts

parent group.

l A chi l d subgroup can be assi gned other pri vi l eges i n addi ti on to

i nheri ted pri vi l eges.

U ser groups correspondi ng to the three edi ti ons of Mi croStrategy Web

products are predefi ned w i th the appropri ate pri vi l ege sets. These

© 2019, M icr o St r at egy In c. 105 3

Syst em Ad m in ist r at io n Gu id e

user groups are avai l abl e under the U ser Group fol der i n the
Admi ni strati on fol der for your proj ect.

You need projec t adminis tration priv ileges to v iew and modify us er
group definitions .

See your l i cense agreement as you determi ne how each user i s

assi gned to a gi ven pri vi l ege set. Mi croStrategy Web products provi de
three Web edi ti ons (Professi onal , Anal yst, R eporter), defi ned by the
pri vi l ege set assi gned to each.

Assi gni ng pri vi l eges outsi de those desi gnated for each edi ti on
changes the user's edi ti on. For exampl e, i f you assi gn to a user i n a
Web R eporter group a pri vi l ege avai l abl e onl y to a Web Anal yst,
Mi croStrategy consi ders the user to be a Web Anal yst user.

Wi thi n any edi ti on, pri vi l eges can be removed for speci fi c users or
user groups. For more i nformati on about securi ty and pri vi l eges, see
C hapter 2, Setti ng U p U ser Securi ty.

Li cense Manager enabl es you to perform a sel f-audi t of your user

base and, therefore, hel ps you understand how your l i censes are
bei ng used. For more i nformati on, see Audi ti ng and U pdati ng
Li censes, page 375.

Using the MicroStrategy Web Administrator Page

The Admi ni strator page al l ow s you to connect and di sconnect
Mi croStrategy Web or Web U ni versal products to Intel l i gence Servers.
It al so l ets you set Mi croStrategy Web products governors such as
server and request ti me-outs and the maxi mum number of connecti ons
Mi croStrategy Web products can make to an Intel l i gence Server.

If you have the appropri ate pri vi l eges provi ded by your Web Servi ces
provi der, you can fi nd the l i nk to the Admi ni strator page on the
Mi croStrategy Web or Web U ni versal home page.

105 4 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

You can al so confi gure Mi croStrategy Web products to recogni ze

Mi croStrategy N arrow cast Server and enabl e the Scheduled D elivery
and Send N ow opti ons. For more i nformati on about enabl i ng these
features, see Integrati ng N arrow cast Server w i th Mi croStrategy Web
products, page 1069.

Controlling Access to the Administrator Page

You can restri ct access to the Web Admi ni strator page i n tw o w ays:

l Assi gn the correct pri vi l eges to sel ect users. If you're usi ng Apache
Tomcat, assi gn rel ated admi ni strati on rol es from t o m c a t e -
us er .x ml . The fol l ow i ng l i nes provi de the admi n access to the
Web Admi ni strati on page:

<r ol e r ol e n a m e = " ad m i n -g u i " / >

<r ol e r ol e n a m e = " ad m i n " / >
<r ol e r ol e n a m e = " ma n a g e r -g u i " / >
<u se r u se r n a m e = " ad m i n " p a s s w o r d = " a d m i n "
ro le s= "a d m i n -g u i , a d m i n , m a n a g e r -g u i " / >

l U se Mi crosoft IIS and Wi ndow s securi ty to l i mi t access to the page

fi l e

For information about c ontrolling ac c es s to this page when us ing

different Web s erv ers , s ee the Instal l ati on and C onfi gurati on Gui de .
Spec ific ally , s ee the s ec tion "Launc h ms trWebAdmin s erv let" or
"Controlling ac c es s to the Web Adminis trator page" ac c ording to the
platform y ou are us ing.

Assign in g t h e Web Ad min ist r at io n Pr ivilege

The l i nk to the Admi ni strator page appears onl y i f at l east one of the
fol l ow i ng cri teri a i s true:

© 2019, M icr o St r at egy In c. 105 5

Syst em Ad m in ist r at io n Gu id e

l You are l ogged i n to a proj ect and have the Web Admi ni strati on
pri vi l ege.

l Your Mi croStrategy Web product i s not connected to any

Intel l i gence Servers. In thi s case, there i s no w ay to tel l w hether
you have the Web Admi ni strati on pri vi l ege because there i s no
Intel l i gence Server to veri fy your credenti al s. H ow ever, once you
connect to an Intel l i gence Server, you do not see the l i nk unl ess
you l og i n to a proj ect i n w hi ch you have the Web Admi ni strati on
pri vi l ege.

For steps on how to assi gn thi s pri vi l ege to a user, see Setti ng U p
U ser Securi ty, page 85.

Usin g Micr o so f t IIS an d Win d o ws Secu r it y f o r Micr o St r at egy

Web Pr o d u ct s (ASP.NET)
U sers w i thout the Web Admi ni strati on pri vi l ege cannot access the
Admi ni strator page from w i thi n Mi croStrategy Web. H ow ever, thi s
does not prevent someone from si mpl y typi ng the U R L i n a Web
brow ser to navi gate to the Admi ni strator page. To prevent thi s from
happeni ng w i th the ASP.N ET versi on of Mi croStrategy Web products
usi ng Mi crosoft IIS, you must l i mi t access to the fi l e i tsel f usi ng
Mi crosoft IIS and Wi ndow s securi ty. The defaul t l ocati on of the
Admi ni strator page fi l e i s P r o g r a m F i l e s ( x 8 6 ) \
Micr oS tr at e g y \ W e b A s p x \ a s p \ A d m i n . a s p x

In the J2EE versi on, the Admi ni strator page i s a servl et and access to
the servl et i s control l ed usi ng the Web and appl i cati on servers. The
defaul t l ocati on of the Admi ni strator servl et vari es dependi ng on the
pl atform you are usi ng. For detai l s, see the Instal l ati on and
C onfi gurati on Gui de.

105 6 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Usin g Secu r it y Ro les wit h Web Un iver sal

In Mi croStrategy Web, w hen usi ng the J2EE versi on, users must have
the proper user ID and passw ord to access the Admi ni strator servl et
(mst rW eb Ad m i n ). C onsul t the documentati on for your parti cul ar Web
and appl i cati on servers for i nformati on about fi l e-l evel securi ty
requi rements and securi ty rol es.

The defaul t l ocati on of the Admi ni strator servl et vari es dependi ng on

the pl atform you are usi ng. For detai l s, see the Instal l ati on and
C onfi gurati on Gui de.

Defining Project Defaults

If you have the Web Admi ni strati on pri vi l ege, you can set the defaul t
opti ons for one or more proj ects i n the Preferences secti on. The
Proj ect defaul ts l i nk i s di spl ayed onl y i f you have the Web
Admi ni strati on pri vi l ege.

Any changes you make to the proj ect defaul ts become the defaul t
setti ngs for the current proj ect or for al l Web proj ects i f you sel ect the
A pply to all projects on the current MicroStrategy Intelligence
Server (server name) opti on from the drop-dow n l i st.

The proj ect defaul ts i ncl ude user preference opti ons, w hi ch each user
can overri de, and other proj ect defaul t setti ngs accessi bl e onl y to the
admi ni strator.

For i nformati on on the H i story Li st setti ngs, see Savi ng R eport

R esul ts: H i story Li st, page 897.

Loading and Applying Default Values

The Load D efaul t Val ues opti on w orks di fferentl y on the Proj ect
defaul ts and the U ser preferences pages:

© 2019, M icr o St r at egy In c. 105 7

Syst em Ad m in ist r at io n Gu id e

l When the admi ni strator w ho i s setti ng the Proj ect defaul ts cl i cks
Load D efault Values, the ori gi nal val ues shi pped w i th the
Mi croStrategy Web products are l oaded on the page.

l When users w ho are setti ng U ser preferences cl i ck Load D efault

Values, the proj ect defaul t val ues that the admi ni strator set on the
Proj ect defaul ts pages are l oaded.

The setti ngs are not saved unti l you cl i ck A pply. If you sel ect A pply
to all projects on the current Intelligence Server (server name)
from the drop-dow n menu, the setti ngs are appl i ed to al l proj ects, not
j ust the one you are currentl y confi guri ng.

Set t in g User Pr ef er en ces an d Pr o ject Def au lt s

U sers can change the i ndi vi dual setti ngs for thei r user preference
opti ons by accessi ng them vi a the Preferences l i nk at the top of the
Web page. H ow ever, you can set w hat defaul t val ues the users see
for these opti ons. To do thi s, cl i ck the Preferences l i nk, then cl i ck the
Project defaults l i nk on the l eft-hand si de of the page (under the
"Preferences Level " headi ng).

You can then set the defaul ts for several categori es, i ncl udi ng the
fol l ow i ng:

l General

l Fol der Brow si ng

l Gri d di spl ay

l Graph di spl ay

l H i story Li st

l Export R eports

l Pri nt R eports (PD F)

105 8 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l D ri l l mode

l Prompts

l R eport Servi ces

l Securi ty (see note bel ow for Web)

l Proj ect di spl ay (see note bel ow for Web)

l Offi ce

l C ol or Pal ette

l Emai l Addresses

l Fi l e Locati ons

l Pri nter Locati ons

l FTP Locati ons

l D ynami c Adress Li sts

Some of the following c ategories are dis play ed only in c ertain

c irc ums tanc es . For ex ample, the Report Serv ic es link appears only if
y ou hav e a lic ens e to us e Report Serv ic es .

Each category has i ts ow n page and i ncl udes rel ated setti ngs that are
accessi bl e onl y to users w i th the Web Admi ni strati on pri vi l ege. For
detai l s on each setti ng, see the Mi croStrategy Web H el p for the Web
Admi ni strator.

Using Additional Security Features for

MicroStrategy Web and Mobile
Thi s secti on descri bes how Mi croStrategy Web and Mobi l e products
can be made more secure by usi ng standard Internet securi ty
technol ogi es such as fi rew al l s, di gi tal certi fi cates, and encrypti on.

© 2019, M icr o St r at egy In c. 105 9

Syst em Ad m in ist r at io n Gu id e

For i nformati on on enabl i ng secure, encrypted communi cati ons for

Web, see Enabl i ng Secure C ommuni cati on.

Using Firewalls
A fi rew al l enforces an access control pol i cy betw een tw o systems. A
fi rew al l can be thought of as somethi ng that exi sts to bl ock certai n
netw ork traffi c w hi l e permi tti ng other netw ork traffi c. Though the
actual means by w hi ch thi s i s accompl i shed vari es w i del y, fi rew al l s
can be i mpl emented usi ng both hardw are and softw are, or a
combi nati on of both.

Fi rew al l s are most frequentl y used to prevent unauthori zed Internet

users from accessi ng pri vate netw orks connected to the Internet,
especi al l y i ntranets. If you use Mi croStrategy Web or Mobi l e products
over the Internet to access proj ects on an Intel l i gence Server that i s
most l i kel y on an i ntranet, there i s the possi bi l i ty that a mal i ci ous user
can expl oi t the securi ty hol e created by the connecti on betw een the
tw o systems.

Therefore, i n many envi ronments and for a vari ety of reasons you may
w ant to put a fi rew al l betw een your Web servers and the Intel l i gence
Server or cl uster. Thi s does not pose any probl ems for the
Mi croStrategy system, but there are some thi ngs you need to know to
ensure that the system functi ons as expected.

Another common pl ace for a fi rew al l i s betw een the Web cl i ents and
the Web or Mobi l e server. The fol l ow i ng di agram show s how a
Mi croStrategy system mi ght l ook w i th fi rew al l s i n both of these
l ocati ons:

1060 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

R egardl ess of how you choose to i mpl ement your fi rew al l s, you must
make sure that the cl i ents can communi cate w i th Mi croStrategy Web
and Mobi l e Servers, that Mi croStrategy Web and Mobi l e can
communi cate w i th Intel l i gence Server, and vi ce versa. To do thi s,
certai n communi cati on ports must be open on the server machi nes
and the fi rew al l s must al l ow Web server and Intel l i gence Server
communi cati ons to go through on those ports. Most fi rew al l s have
some w ay to speci fy thi s. C onsul t the documentati on that came w i th
your fi rew al l sol uti on for detai l s.

To Enable Communication through a Firewall

1. C l i ent Web brow sers communi cate w i th Mi croStrategy Web on

port 80 (H TTP). So, i f you have a fi rew al l betw een your cl i ents
and Mi croStrategy Web servers, you must make sure port 80 i s
al l ow ed to send and recei ve requests through the fi rew al l .

Depending on how y ou deploy ed Web Univ ers al, it may

c ommunic ate on a different port number.

2. Mi croStrategy Web products can communi cate w i th Intel l i gence

Server usi ng any port that i s greater than 1024. By defaul t, the
ports are 34952 and 34962. If you have a fi rew al l betw een your
Web servers and Intel l i gence Server, you must make sure port
34952 and 34962 are al l ow ed to send and recei ve TC P/IP
requests through the fi rew al l .

You c an c hange this port number. See the s teps in the nex t
proc edure To C hange the Port through w hi ch Mi croStrategy
Web and Intel l i gence Server C ommuni cate, page 1063 to
learn how.

3. You must confi gure your fi rew al l to al l ow Mi croStrategy Web

products to communi cate w i th Intel l i gence Server usi ng port

© 2019, M icr o St r at egy In c. 1061

Syst em Ad m in ist r at io n Gu id e

3333. Thi s i s i n addi ti on to the port confi gured i n the previ ous
step of thi s procedure.

4. The Mi croStrategy Li stener Servi ce communi cates w i th

Mi croStrategy Web products and Intel l i gence Server on port
30172. So, i f you are usi ng the Li stener Servi ce, you must make
sure port 30172 i s al l ow ed to send and recei ve TC P/IP and U D P
requests through the fi rew al l . You cannot change thi s port
number.

5. The Mi croStrategy Intel l i gence Server R EST Li stener l i stens on

port 34962 for R EST requests. So, i f you have a fi rew al l , you
must make sure 34962 i s al l ow ed to recei ve TC P requests
through the fi rew al l . If you change thi s port (34962) to a di fferent
one through C onfi gurati on Wi zard, you need to modi fy Inbound
R ul es for the Fi rew al l accordi ngl y.

6. Mi croStrategy Messagi ng Servi ces uses ports 2181, 9092, 2888,

and 3888 to communi cate w i th other Mi croStrategy Servi ces,
such as the Intel l i gence Server, N ew Export Engi ne,
Mi croStrategy Identi ty Server and Pl atform Anal yti cs. If you have
a fi rew al l betw een Mi croStrategy Servi ces you must make sure
these four ports are al l ow ed to send and recei ve TC P requests
through the fi rew al l .

7. Mi croStrategy Topol ogy uses ports 8300 and 8301 to

communi cate betw een agents. If you have a fi rew al l betw een
Mi croStrategy Servi ces you must make sure these tw o ports are
al l ow ed to send and recei ve TC P/U D P requests through the
fi rew al l .

The Mic roStrategy Serv ic es are as follows :

l Mic roStrategy Intelligenc e Serv er

l Mic roStrategy Web Univ ers al

1062 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Mic roStrategy Library

l Mic roStrategy Mobile

l Mic roStrategy Mes s aging Serv ic es

l Mic roStrategy Platform Analy tic s

l Mic roStrategy Certific ate Store

l Us her Sec urity Serv ic es

To Change the Port through which MicroStrategy Web and

Intelligence Server Communicate

By defaul t, Mi croStrategy Web and Intel l i gence Server communi cate

w i th each other usi ng port 34952 (Web U ni versal may use a di fferent
port dependi ng on how you depl oyed i t). If you w ant to change thi s,
you must change i t for both the Web servers and the Intel l i gence
Servers. The port numbers on both si des must match.

If y ou are us ing c lus ters , y ou mus t mak e s ure that all mac hines in the
Web s erv er c lus ter c an c ommunic ate with all mac hines in the
Intelligenc e Serv er c lus ter.

To Change t he Por t N um b er f or Int el l i gence Ser ver

1. In D evel oper, l og i n to the proj ect source that connects to the

server w hose port you w ant to change.

2. In the Servi ce Manager, cl i ck Options.

3. On the Intel l i gence Server Opti ons tab, type the port number you
w ant to use i n the Port N umber box. Save your changes.

4. A message appears tel l i ng you to restart Intel l i gence Server.

C l i ck OK .

5. R estart Intel l i gence Server.

© 2019, M icr o St r at egy In c. 1063

Syst em Ad m in ist r at io n Gu id e

6. In D evel oper, ri ght-cl i ck the proj ect source that connects to the
Intel l i gence Server w hose port number you changed and choose
Modify Project Source.

7. On the C onnecti on tab, enter the new port number and cl i ck OK .

You mus t update this port number for all projec t s ourc es in y our
s y s tem that c onnec t to this Intelligenc e Serv er.

To Change t he Por t N um b er f or M i cr oSt r at egy Web

1. Open the Admi ni strator page i n Mi croStrategy Web.

2. If your Mi croStrategy Web product i s connected to the

Intel l i gence Server w hose port number you changed, cl i ck
D isconnect to di sconnect i t. You cannot change the port w hi l e
connected to an Intel l i gence Server.

It probably is not c onnec ted bec aus e the Mic roStrategy Web
produc t does not y et k now the new port number y ou as s igned to
Intelligenc e Serv er.

3. In the entry that corresponds to the appropri ate Intel l i gence

Server, cl i ck Modify (i n the Properti es col umn, al l the w ay to the
ri ght).

4. In the Port box, type the port number you w ant to use. Thi s port
number must match the port number you set for Intel l i gence
Server. An entry of 0 means use port 34952 (the defaul t).

5. C l i ck Save..

If the port numbers for y our Mic roStrategy Web produc t and
Intelligenc e Serv er do not matc h, y ou get an error when the
Mic roStrategy Web produc t tries to c onnec t to Intelligenc e Serv er.

1064 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Using Cookies
A cooki e i s a pi ece of i nformati on that i s sent to your Web brow ser—
al ong w i th an H TML page—w hen you access a Web si te or page.
When a cooki e arri ves, your brow ser saves thi s i nformati on to a fi l e
on your hard dri ve. When you return to the si te or page, some of the
stored i nformati on i s sent back to the Web server, al ong w i th your
new request. Thi s i nformati on i s usual l y used to remember detai l s
about w hat a user di d on a parti cul ar si te or page for the purpose of
provi di ng a more personal experi ence for the user. For exampl e, you
have probabl y vi si ted a si te such as Amazon.com and found that the
si te recogni zes you. It may know that you have been there before,
w hen you l ast vi si ted, and maybe even w hat you w ere l ooki ng at the
l ast ti me you vi si ted.

Mi croStrategy Web products use cooki es for a w i de vari ety of thi ngs.
In fact, they use them for so many thi ngs that the appl i cati on cannot
w ork w i thout them. C ooki es are used to hol d i nformati on about user
sessi ons, preferences, avai l abl e proj ects, l anguage setti ngs, w i ndow
si zes, and so on. For a compl ete and detai l ed reference of al l cooki es
used i n Mi croStrategy Web and Mi croStrategy Web U ni versal , see the
Mi croStrategy Web C ooki es secti on.

Usin g Co o kies in Micr o St r at egy Web Pr o d u ct s

Mi croStrategy Web products provi de an opti on rel ated to the use of
cooki es on the Web Admi ni strator's Securi ty page.

To enabl e cooki es, sel ect the checkbox Store MicroStrategy

Intelligence Server sessions information in temporary cookies
instead of on the Web Server.

Thi s opti on speci fi es w hether Intel l i gence Server sessi on i nformati on

shoul d be saved i n cooki es or not. Si nce the Intel l i gence Server
sessi on i nformati on i s sensi ti ve, i t i s not secure to turn on thi s opti on
i n most cases. Thi s i s checked i n those cases w hen a cl uster i s set up

© 2019, M icr o St r at egy In c. 1065

Syst em Ad m in ist r at io n Gu id e

and does not automati cal l y handl e sessi on repl i cati on. The sessi on
repl i cati on i s the di stri buti on of the sessi on i nformati on on the cl i ent
i nstead of on the Web server so that the user can connect seaml essl y
to any of the Intel l i gence Server machi nes.

For cl ustered envi ronments, i t's recommended to uncheck thi s opti on

and enabl e sti cky sessi ons on your l oad bal ancer. For more
i nformati on, see KB483141: Best Practi ces for Setti ng U p Web
C l usters.

Using Encryption
Encrypti on i s the transl ati on of data i nto a sort of secret code for
securi ty purposes. The most common use of encrypti on i s for
i nformati on that i s sent across a netw ork so that a mal i ci ous user
cannot gai n anythi ng from i ntercepti ng a netw ork communi cati on.
Someti mes i nformati on stored i n or w ri tten to a fi l e i s encrypted. The
SSL technol ogy descri bed earl i er i s one exampl e of an encrypti on
technol ogy.

Mi croStrategy Web products can use encrypti on i n many pl aces, but

by defaul t, most are not used unl ess you enabl e them.

En cr yp t io n in Micr o St r at egy Web Pr o d u ct s

You can encrypt al l communi cati on betw een the Web server and
Intel l i gence Server. Addi ti onal overhead i s i nvol ved i n encrypti ng and
decrypti ng al l thi s netw ork traffi c so you may see a noti ceabl e
performance degradati on i f encrypti on i s enabl ed. H ow ever, i f you are
w orki ng w i th sensi ti ve or confi denti al i nformati on, thi s may be an
acceptabl e trade-off.

1066 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To Encrypt All Communication Between MicroStrategy Web

Products and Intelligence Server

1. Go to the Admi ni strator Page.

2. At the top of the page or i n the col umn on the l eft, cl i ck Security
to see the securi ty setti ngs.

3. Wi thi n the Encrypti on area, sel ect one of the fol l ow i ng encrypti on
opti ons:

l N o encryption (defaul t): D ata betw een Web and Intel l i gence
Server i s not encrypted.

l SSL: U ses Secure Socket Layer (SSL) encrypti on to secure

data betw een Web and Intel l i gence Server. Thi s i s the
recommended opti on for secure communi cati ons. If you w ant
Web to veri fy Intel l i gence Server's SSL certi fi cate before
setti ng up a connecti on, sel ect Validate Intelligence Server
certificate. For i nstructi ons to set up SSL encrypti on for Web,
see Enabl i ng Secure C ommuni cati on.

4. C l i ck Save. N ow al l communi cati on betw een the Web server and

Intel l i gence Server i s encrypted.

Applying File-Level Security

It i s i mportant to remember that no matter w hat ki nd of securi ty you set
up, there i s al w ays the possi bi l i ty that a mal i ci ous user can bypass i t
al l by gai ni ng access to the physi cal machi ne that hosts the Web
appl i cati on. For thi s reason you shoul d make sure that the machi ne i s
i n a secure l ocati on and that you restri ct access to the fi l es stored on
i t usi ng the standard fi l e-l evel securi ty offered by the operati ng
system.

In typi cal producti on envi ronments, onl y a smal l number of

admi ni strati ve users are al l ow ed to l og on to server machi nes. Al l

© 2019, M icr o St r at egy In c. 1067

Syst em Ad m in ist r at io n Gu id e

other users ei ther have very l i mi ted access to the fi l es and

appl i cati ons on the machi ne or, better yet, no access at al l .

For exampl e, w i th Mi crosoft IIS, by defaul t onl y the "Internet guest

user" needs access to the vi rtual di rectory. Thi s i s the account under
w hi ch al l fi l e access occurs for Web appl i cati ons. In thi s case, the
Internet guest user needs the fol l ow i ng pri vi l eges to the vi rtual
di rectory: read, w ri te, read and execute, l i st fol der contents, and
modi fy.

H ow ever, onl y the admi ni strator of the Web server shoul d have these
pri vi l eges to the Admi n fol der i n w hi ch the Web Admi ni strator pages
are l ocated. When secured i n thi s w ay, i f users attempt to access the
Admi ni strator page, the appl i cati on prompts them for the machi ne's
admi ni strator l ogi n ID and passw ord.

In addi ti on to the fi l e-l evel securi ty for the vi rtual di rectory and i ts
contents, the Internet guest user al so needs ful l control pri vi l eges to
the Log fol der i n the Mi croStrategy C ommon Fi l es, l ocated by defaul t
i n C: \ Pr og r a m F i l e s ( x 8 6 ) \ C o m m o n
File s\ Mi cr o S t r a t e g y. Thi s ensures that any appl i cati on errors
that occur w hi l e a user i s l ogged i n can be w ri tten to the l og fi l es.

The file-lev el s ec urity des c ribed abov e is all tak en c are of for y ou when
y ou ins tall the ASP.NET v ers ion of Mic roStrategy Web us ing Mic ros oft
IIS. Thes e details are jus t prov ided for y our information.

If you are usi ng the J2EE versi on of Mi croStrategy Web you may be
usi ng a di fferent Web server, but most Web servers have si mi l ar
securi ty requi rements. C onsul t the documentati on for your parti cul ar
Web server for i nformati on about fi l e-l evel securi ty requi rements.

Sample MicroStrategy System

The fol l ow i ng di agram summari zes w hat a typi cal Mi croStrategy
system mi ght l ook l i ke i f you take i nto account fi rew al l s, di gi tal
certi fi cates, and encrypti on:

1068 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Integrating Narrowcast Server with MicroStrategy

Web products
It i s possi bl e to enabl e Scheduled D elivery and Send N ow features
i n Mi croStrategy Web products. The Schedul ed del i very opti on al l ow s
users to have a report sent to an e-mai l address that they speci fy on a
certai n schedul e, to a pri nter or to a fi l e l ocati on. These schedul es

© 2019, M icr o St r at egy In c. 1069

Syst em Ad m in ist r at io n Gu id e

are defi ned i n Mi croStrategy N arrow cast Server and are separate from
the schedul es mai ntai ned i n Intel l i gence Server. The Send N ow
opti on al l ow s users to send a report i mmedi atel y to an e-mai l address
that they speci fy.

You mus t hav e Mic roStrategy Narrowc as t Serv er ins talled and
c onfigured before the Sc heduled e-mail and Send Now options work .
See that produc t's doc umentation for more information.

For more detai l ed i nformati on about thi s, see the Instal l ati on and
C onfi gurati on Gui de.

To confi gure the Subscri pti on Portal del i very opti on for Mi croStrategy
Web products, ei ther the fol der or the dri ve w here the Subscri pti on
Engi ne i s i nstal l ed must be shared w hi l e the system i s bei ng
confi gured. That i s, the servi ce runni ng the Subscri pti on Admi ni strator
must have read and w ri te access to ei ther:

l The fol der w here the Subscri pti on Engi ne i s i nstal l ed

l The enti re dri ve w here the Subscri pti on Engi ne i s i nstal l ed

Mi croStrategy N arrow cast Server and Mi croStrategy Web products

can automati cal l y share thi s dri ve for the l ocal Admi ni strators group.
The Subscri pti on Admi ni strator servi ce shoul d run under an account
that i s a member of the l ocal Admi ni strators group. You can unshare
the dri ve or fol der after the system i s confi gured. If you do not w ant to
automati cal l y share the dri ve, perform the steps l i sted here.

To Share the Folder where the Subscription Engine is Installed

1. Modi fy the Admi n.properti es fi l e l ocated on the Subscri pti on

Engi ne machi ne:

1070 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

.. \M ic r o S t r a t e g y \ N a r r o w c a s t S e r v e r \ S u b s c r i p t i on
En gi ne \ b u i l d \ s e r v e r \

Modi fy the fi l e contents so the correspondi ng tw o l i nes are as

fol l ow s:

Tr an sa c t i o n E n g i n e L o c a t i o n =m a c h i n e _n a m e: \ \
Su bs cr i p t i o n E n g i n e \ \ b u i l d \ \ s e r v e r

Tr an sa c t i o n E n g i n e L o c a t i o n =M A C H I N E _
NA ME : /S u b s c r i p t i o n E n g i n e / b u i ld / s e r v e r

w here m a c h i n e _n am e i s the name of the machi ne w here the

Subscri pti on Engi ne i s i nstal l ed.

2. Share the fol der w here the Subscri pti on Engi ne i s i nstal l ed for
ei ther the l ocal Admi ni strators group or for the account under
w hi ch the Subscri pti on Admi ni strator servi ce account runs. Thi s
fol der must be shared as S u b s c r i p t i o n E n g i n e.

You s hould ens ure that the pas s word for this ac c ount does not
ex pire.

If the Subscri pti on Engi ne machi ne's dri ve i s shared and

unshared mul ti pl e ti mes, the fol l ow i ng Wi ndow s message
di spl ays: "S y s t e m E r r o r : T h e n e t wo r k n a m e w a s
de le te d . "

This mes s age does not indic ate a problem. Clic k OK to mak e the
Subs c ription Adminis trator s erv ic e func tional.

3. R estart the Subscri pti on Admi ni strator servi ce.

© 2019, M icr o St r at egy In c. 1071

Syst em Ad m in ist r at io n Gu id e

Enabling Users to Install MicroStrategy Office

from Web
This information applies to Mic roStrategy Offic e, the add-in for
Mic ros oft Offic e applic ations whic h is no longer ac tiv ely dev eloped.

It was s ubs tituted with a new add-in, Mic roStrategy for Offic e, whic h
s upports Offic e 365 applic ations . The initial v ers ion does not y et hav e
all the func tionalities of the prev ious add-in.

For more information, s ee the Mi croStrategy for Offi ce page i n the

2019 U pdate 1 R eadme and the Mi croStrategy for Offi ce Onl i ne
H el p .

From the Mi croStrategy Web Admi ni strator page, you can desi gnate
the i nstal l ati on di rectory path to Mi croStrategy Offi ce, and al so
determi ne w hether a l i nk to Offi ce i nstal l ati on i nformati on appears i n
the Mi croStrategy Web i nterface.

You mus t ins tall and deploy Mic roStrategy Web Serv ic es to allow the
ins tallation of Mic roStrategy Offic e from Mic roStrategy Web. For
information about deploy ing Mic roStrategy Web Serv ic es , s ee the
Mi croStrategy for Offi ce Onl i ne H el p .

To specify the path to MicroStrategy Office and

determine whether users can install MicroStrategy
Office from Web
1. In Wi ndow s, go to Start > Programs > MicroStrategy Tools >
Web A dministrator.

2. C l i ck C onnect.

3. U nderneath Web Server on the l eft, cl i ck MicroStrategy Office.

1072 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

4. In the Path to MicroStrategy Office Installation fi el d, type the

base U R L of your Mi croStrategy Web Servi ces machi ne, for
exampl e:
http://server:port/Web_Services_virtual_directory/Office

Mic roStrategy Web automatic ally attac hes /L a n g _

xx xx / o f f i c e i n s t a l l . h t m to the end of the URL, where
La ng _x x x x refers to the c urrently defined language in
Mic roStrategy Web. For ex ample, if the language in Mic roStrategy
Web is s et to Englis h, a c ompleted URL may appear as follows :

ht tp :/ / l o c a l h o s t / M i c r o S t r a t e g y W S / o f f i c e / L a n g _
10 33 /o f f i c e i n s t a l l . h t m

5. Test the U R L path by cl i cki ng Go.

6. C l i ck your brow ser's Back button to return to the Web

Admi ni strati on - Mi croStrategy Offi ce setti ngs page.

7. To ensure that an I n s t a l l M i c r o S t r a t e g y O f f i c e l i nk i s
di spl ayed at the top of users' proj ect sel ecti on and l ogi n pages i n
Mi croStrategy Web, sel ect the Show link to installation page
for all users on the Projects and Login pages check box.
When users cl i ck the 'Instal l Mi croStrategy Offi ce' l i nk, a page
opens w i th i nstructi ons on how to i nstal l Mi croStrategy Offi ce on
thei r machi ne.

8. C l i ck Save.

© 2019, M icr o St r at egy In c. 1073

Syst em Ad m in ist r at io n Gu id e

FAQs for Configuring and Tuning MicroStrategy

Web Products
How do I Configure my MicroStrategy Web Environment
if I have a User Community of x Users? How much
Hardware am I Going to Need?
Thi s i nformati on i s addressed i n the Mi croStrategy Know l edge Base.

How do Time-Out Settings in MicroStrategy Web and

Intelligence Server Affect MicroStrategy Web Users?
Several setti ngs rel ated to sessi on ti me-out may affect Mi croStrategy
Web users.

Fi rst, i n the Intel l i gence Server C onfi gurati on Edi tor, under
Governing R ules: D efault: General, the val ue i n the Web user
session idle time (sec) fi el d determi nes the number of seconds a
user can remai n i dl e before bei ng l ogged out of Intel l i gence Server.

Second, i n the w e b . c o n f i g fi l e, l ocated by defaul t i n C : \ P r o g r a m

File s ( x8 6) \ M i c r o S t r a t e g y \ W e b A S P x, the ti me-out setti ng
determi nes the number of mi nutes after w hi ch the .N ET sessi on obj ect
i s rel eased i f i t has not been accessed. Thi s ti me-out i s i ndependent
of the Intel l i gence Server ti me-out above.

The secti on of the w e b . c o n f i g fi l e contai ni ng the ti me-out setti ng i s

as fol l ow s:

<ses si on St a t e
mode =" In Pr o c "
stat eC on ne c t i o n S t r i n g =
"tcp ip =1 27 . 0 . 0 . 1 : 4 2 4 2 4 "
sqlC on ne ct i o n S t r i n g = " d a t a s o u r c e =
127. 0. 0. 1; u s e r i d = s a ; p a s s w o r d = "
cook ie le ss = " f a l s e "

1074 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

time ou t= "2 0 "

/>

This s etting does not affec t Web Univ ers al bec aus e it does not us e .NET
arc hitec ture.

A thi rd setti ng i s the Mi croStrategy Web Admi ni strati on setti ng A llow

automatic login if session is lost. Thi s setti ng i s i n the Securi ty
secti on of the Web Admi ni strati on page. It enabl es users to be
automati cal l y reconnected to Intel l i gence Server i f the sessi on i s l ost.

This s etting does not automatic ally rec onnec t the .NET s es s ion objec t.

The fol l ow i ng tabl e demonstrates how the previ ous setti ngs i nteract i n
vari ous combi nati ons.

Inte llige nc e Allow a utoma tic Us e r

web.config
Se r v e r time - login if s e s s ion is idle Re s ult
time -out
out los t time

30 User must log

45 minut es 20 minut es E it her
minut es back in

30 User must log back

20 minut es 45 minut es No
minut es in

User is
30
20 minut es 45 minut es Y es aut omat ically
minut es
logged back in

60 User must log back

20 minut es 45 minut es E it her
minut es in

A fourth group of setti ngs i s w hether Web user sessi ons can be
backed up and recovered. That i s, i f the user w as vi ew i ng a report,
document, or dossi er w hen the sessi on w as ended, w hen the user
l ogs back i n to Web, they can cl i ck a l i nk to return to that report,
document, or dossi er. If thi s i s enabl ed, you can confi gure w here and

© 2019, M icr o St r at egy In c. 1075

Syst em Ad m in ist r at io n Gu id e

for how l ong the sessi on i s stored on di sk. After the sessi on i s
expi red, the user cannot recover the sessi on.

To confi gure these setti ngs, access the Intel l i gence Server
C onfi gurati on Edi tor, sel ect the Governing R ules: D efault:
Temporary Storage Settingscategory. To enabl e the feature, sel ect
the Enable Web U ser Session R ecovery on Logout check box, and
i n the Session R ecovery backup expiration (hrs) fi el d, type the
number of hours you w ant to al l ow a sessi on to be stored. In Session
R ecovery and D eferred Inbox storage directory, speci fy the fol der
w here the user sessi on i nformati on i s stored.

How can I Tune my MicroStrategy Web Server for Best

Performance?
l C l usteri ng mul ti pl e w eb servers i mproves performance. For more
i nformati on about thi s, see C hapter 9, C l usteri ng Mul ti pl e
Mi croStrategy Servers.

l You can modi fy certai n setti ngs i n the Mi croStrategy Web server
machi ne or appl i cati on for best performance. D etai l s for
Mi croStrategy Web and Web U ni versal fol l ow :

Micr o St r at egy Web (ASP.NET)

The most si gni fi cant thi ngs you can do:

l Tune Mi crosoft's Internet Informati on Servi ces (IIS). For detai l s, see
the Mi croStrategy Tech N otes TN 11275 and TN 7449.

l Increase the server machi ne's Java Vi rtual Machi ne heap si ze. For
i nformati on on doi ng thi s, see Mi croStrategy Tech N ote TN 6446.

Micr o St r at egy Web Un iver sal (J2 EE)

Tuni ng acti ons for the J2EE versi on of Mi croStrategy Web U ni versal
vary accordi ng to the Web server you are usi ng. For tuni ng detai l s,

1076 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

see the appropri ate secti on i n the Instal l ati on and C onfi gurati on
Gui de.

Al so, see the documentati on for your parti cul ar Web appl i cati on
server for addi ti onal tuni ng i nformati on. In general , these are the
thi ngs you can do:

l U se the Mi croStrategy Web server i nstead of the appl i cati on server

to serve stati c fi l es (such as C SS, JavaScri pt).

l Precompi l e JSPs accordi ng to the pl atform you are usi ng.

l Increase the appl i cati on server's Java Vi rtual Machi ne heap si ze.

© 2019, M icr o St r at egy In c. 1077

 14
COM BINING
ADM INISTRATIVE TASKS
WITH SYSTEM M ANAGER

© 2019, M icr o St r at egy In c. 1078

Syst em Ad m in ist r at io n Gu id e

Mi croStrategy System Manager l ets you combi ne mul ti pl e, sequenti al

processes for your Mi croStrategy envi ronment i nto a si ngl e w orkfl ow
that can be depl oyed at a schedul ed ti me or on demand. You can
create w orkfl ow s for di fferent tasks, such as i nstal l i ng, mai ntai ni ng,
and upgradi ng Mi croStrategy envi ronments; backi ng up proj ects; and
l aunchi ng or shutti ng dow n C l oud i nstances. These w orkfl ow s can be
depl oyed usi ng a standard i nterface, an i nteracti ve command l i ne
process, or a compl etel y si l ent confi gurati on process.

l C reati ng a Workfl ow , page 1079: Incl udes steps to create a

w orkfl ow usi ng System Manager, as w el l as i nformati on on al l the
components requi red to create a w orkfl ow .

l D efi ni ng Processes, page 1130: Incl udes i nformati on on al l the

processes that can be i ncl uded i n a System Manager w orkfl ow .
System Manager provi des a set of Mi croStrategy and non-
Mi croStrategy processes to i ncl ude i n a w orkfl ow .

l D epl oyi ng a Workfl ow , page 1238: Incl udes i nformati on on how to

depl oy a System Manager w orkfl ow . Thi s i ncl udes depl oyi ng a
w orkfl ow usi ng a standard i nterface, an i nteracti ve command l i ne
process, and a compl etel y si l ent confi gurati on process, w hi ch i s
sui ted for OEM depl oyments.

Creating a Workflow
You use System Manager to create a w orkfl ow vi sual l y, by draggi ng
and droppi ng processes and l i nki ng them together. Thi s al l ow s you to
see the step-by-step process that l eads the w orkfl ow from one
process to the next. Thi s vi sual approach to creati ng a w orkfl ow can
hel p you to noti ce opportuni ti es to troubl eshoot and error check
processes as part of a w orkfl ow .

1079 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

The steps provi ded bel ow show you how to create a w orkfl ow usi ng
System Manager. Addi ti onal detai l s on the vari ous components that
consti tute a System Manager w orkfl ow are provi ded after these steps.

It c an be benefic ial to determine the purpos e of y our work flow and plan the
general logic al order of the work flow before us ing Sy s tem Manager.

To Create a System Manager Workflow

The s teps prov ided below are ex pres s ed as a linear proc es s . Howev er,
as y ou c reate a work flow, the s teps of c reating and modify ing
proc es s es , c onnec tors , dec is ions , parameters , and other c omponents
of a work flow c an be interc hanged as the requirements for a work flow
are determined.

1. Open System Manager.

2. Sel ect one of the fol l ow i ng opti ons to create a w orkfl ow :

l N ew Workflow: C reates a new w orkfl ow . The steps bel ow

assume that you have sel ected thi s opti on to create a new
w orkfl ow .

l Open Workflow: Opens an exi sti ng w orkfl ow . You can create a

new w orkfl ow based on an exi sti ng w orkfl ow .

l Templates: Opens a sampl e, templ ate w orkfl ow for a

confi gurati on scenari o. The sampl e w orkfl ow s provi de a
framew ork for certai n tasks, l etti ng you modi fy the detai l s for
each process to w ork w i th the components and tool s i n your
envi ronment. For i nformati on on some of the avai l abl e sampl e
w orkfl ow s, see Sampl e Workfl ow s: Templ ates, page 1118.

© 2019, M icr o St r at egy In c. 1080

Syst em Ad m in ist r at io n Gu id e

To Create Processes in a Workflow

1. From the C onnectors and processes pane, doubl e-cl i ck a

process to add i t to the w orkfl ow . You can then move the process
around so that i t fi ts i nto the organi zati on of the w orkfl ow .

By default, the firs t proc es s c reated in a work flow is automatic ally

defined as an entry proc es s , and all other proc es s es are
automatic ally dis abled as entry proc es s es .

2. R i ght-cl i ck the process and sel ect R ename. Type a new name for
the process.

3. Sel ect the process, and then sel ect Properties i n the pane on
the ri ght si de. Provi de al l the requi red i nformati on for the
process. For detai l s on the properti es requi red for each process,
see D efi ni ng Processes, page 1130.

You can al so use parameters to suppl y i nformati on for a process.

To use a parameter i n a process or deci si on, you must use the
fol l ow i ng syntax: $ {ParameterN ame}

In the syntax l i sted above, P a r a m e t e r N a m e i s the name of the

parameter. D uri ng executi on, thi s i s repl aced w i th the val ue for
the parameter. D efi ni ng the parameters for a w orkfl ow i s
descri bed i n To D efi ne the Parameters for a Process, page 1082,
w hi ch i s a part of thi s procedure.

4. Whi l e provi di ng the i nformati on for a process, you can revi ew the
exi t codes for a process. On the Properti es pane, scrol l dow n to
the bottom and cl i ck Show D escription, as show n i n the i mage
bel ow .

1081 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

D etai l ed i nformati on on each exi t code for a process i s

di spl ayed. For addi ti onal i nformati on on how you can use exi t
codes to hel p create a w orkfl ow , see D etermi ni ng Process
R esol uti on U si ng Exi t C odes, page 1227.

Ex it c ode -4242424 is a general ex it c ode that is s hared among all

proc es s es . This ex it c ode indic ates that either the us er c anc eled
the work flow manually , or the reas on for the proc es s error c annot
be determined.

5. R epeat the steps for To C reate Processes i n a Workfl ow , page

1081 to create al l the processes requi red for a w orkfl ow .

To Define the Parameters for a Process

Each w orkfl ow has one set of parameters, w hi ch can be defi ned on

the Parameters pane on the ri ght si de. The parameters can be used to
provi de val ues for a process w hen the w orkfl ow i s executed. U si ng
parameters can al so l et you provi de thi s i nformati on i n a secure
fashi on. For more i nformati on on how to i ncl ude parameters i n a
w orkfl ow , i ncl udi ng i mporti ng parameters from a fi l e, see U si ng
Parameters for Processes, page 1228.

To Define the Logical Order of a Workflow

Once you have al l the processes requi red for a w orkfl ow , you can
begi n to defi ne the l ogi cal order of the w orkfl ow by creati ng
connectors betw een al l the processes. Each process i n a w orkfl ow

© 2019, M icr o St r at egy In c. 1082

Syst em Ad m in ist r at io n Gu id e

needs to connect to another process i n the w orkfl ow , otherw i se the

w orkfl ow coul d end prematurel y. You can al so defi ne a process as
an entry processes of a w orkfl ow , create deci si ons to di rect the
l ogi cal order of a w orkfl ow , and add comments to provi de further
i nformati on and expl anati on to a w orkfl ow .

While defining the logic al order of a work flow, y ou may find that
additional proc es s es are required. Proc es s es c an be added at any time
while c reating a work flow.

1. From the C onnectors and processes pane, sel ect from the
fol l ow i ng types of connectors:

l Success: The green arrow , to the l eft, i s the success

connector. If the process i s compl eted w i th an exi t code that i s
defi ned as a successful status, the process that the success
connector poi nts to i s the next process that i s attempted. If you
use a success connector from a process, i t i s recommended
that you al so provi de a fai l ure connector.

l Failure: The red arrow , i n the mi ddl e, i s the fai l ure connector.
If the current process i s compl eted w i th an exi t code that i s
defi ned as a fai l ure status, the process that the fai l ure
connector poi nts to i s the next process that i s attempted. If you
use a fai l ure connector from a process, i t i s recommended that
you al so provi de a success connector.

l C ontinue: The w hi te arrow , to the ri ght, i s the conti nue

connector. R egardl ess of the status of the exi t code for the
current process, the process that the conti nue connector poi nts
to i s the next process that i s attempted. If you use the conti nue

1083 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

connector from a process, you cannot use any other connectors

for that process.

Wi th a connector type sel ected, cl i ck the process to start from

and drag to the process to proceed to next i n the w orkfl ow . A
connector i s draw n betw een the tw o processes. If you use the
success and fai l ure connectors for a process, you must do thi s
process for each connector.

These steps must be repeated for every process. For i nformati on

on how to use connectors to defi ne the l ogi cal order of a
w orkfl ow , see U si ng C onnectors to C reate the Logi cal Order of a
Workfl ow , page 1090.

2. From the C onnectors and processes pane, sel ect the D ecision
i con, and then cl i ck i n the w orkfl ow area. A deci si on process i s
created i n the w orkfl ow , as show n i n the i mage bel ow .

D eci si ons provi de the abi l i ty to determi ne the next process i n a

w orkfl ow based on speci fi c exi t codes for the previ ous process,
rather than j ust the si mpl e success or fai l ure of a process. For
exampl es of how deci si ons can be used to defi ne the l ogi cal
order of a w orkfl ow , see U si ng D eci si ons to D etermi ne the N ext
Step i n a Workfl ow , page 1094.

C reate as many deci si ons as you need for your w orkfl ow . Each
deci si on shoul d use a success and a fai l ure connector to other
processes i n the w orkfl ow .

3. To enabl e or di sabl e a process as an entry process for the

w orkfl ow , i n the w orkfl ow area, ri ght-cl i ck the process and sel ect
Toggle Entry Process.

© 2019, M icr o St r at egy In c. 1084

Syst em Ad m in ist r at io n Gu id e

An entry process i s a process that can be sel ected as the fi rst

process to attempt w hen the w orkfl ow i s executed. For
i nformati on on how to use entry processes, see U si ng Entry
Processes to D etermi ne the Fi rst Step i n a Workfl ow , page 1092.

A process that i s defi ned as an entry process i s di spl ayed w i th a

green fl ag symbol , as show n i n the i mage bel ow .

By defaul t, the fi rst process created i n a w orkfl ow i s defi ned as

an entry process, and al l other processes are di sabl ed as entry
processes.

4. To process rel ated tasks one by one, from the C onnectors and
processes pane, sel ect the Iterative R etrieval i con, and then
cl i ck i n the w orkfl ow area. An i terati ve retri eval process i s
created i n the w orkfl ow , as show n i n the i mage bel ow .

Wi th an i terati ve retri eval process, you can have a w orkfl ow

retri eve i nformati on from sources i ncl udi ng a fol der, the contents
of a fi l e, or a System Manager parameter. Thi s i nformati on can
then be passed to another process i n the System Manager
w orkfl ow for processi ng a task. For exampl e, by usi ng an
i terati ve retri eval process, a fol der that stores w eekl y update
packages can be anal yzed to determi ne how many update
packages need to be appl i ed for a w eek, and then appl y these
updates one by one.

1085 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

For i nformati on on how you can use the i terati ve retri eval
process to perform rel ated tasks one by one i n a w orkfl ow , see
Processi ng R el ated Tasks One by One, page 1101.

5. To create a spl i t executi on process, from the C onnectors and

processes pane, sel ect the Split Execution i con, and then cl i ck
i n the w orkfl ow area. A spl i t executi on process i s created i n the
w orkfl ow , as show n i n the i mage bel ow .

A spl i t executi on process l ets you start mul ti pl e threads i n a

w orkfl ow to perform paral l el processi ng of the tasks. Thi s can
speed up a w orkfl ow for systems that can handl e the paral l el
processi ng.

As tasks are executed si mul taneousl y, you can al so determi ne i f

addi ti onal tasks i n the w orkfl ow shoul d be processed i f tasks that
w ere performed i n paral l el are compl eted. From the C onnectors
and processes pane, sel ect the Merge Execution i con, and then
cl i ck i n the w orkfl ow area. A merge executi on process i s created
i n the w orkfl ow , as show n i n the i mage bel ow .

For i nformati on on how you can use the spl i t executi on and
merge executi on to handl e the paral l el processi ng of tasks i n a
w orkfl ow , see Once a w orkfl ow executi on i s spl i t i nto mul ti pl e
paths, each task i s performed i ndependentl y of the other tasks.
H ow ever, w hi l e the tasks are done i ndependentl y, al l the tasks
may need to be compl eted before performi ng other tasks l ater i n

© 2019, M icr o St r at egy In c. 1086

Syst em Ad m in ist r at io n Gu id e

the w orkfl ow . For exampl e, you can create a D SN and start

Intel l i gence Server as separate tasks at the same ti me, but you
may need both of those tasks to be ful l y compl ete before starti ng
another task that requi res the D SN to be avai l abl e and
Intel l i gence Server to be operati onal . To support thi s w orkfl ow ,
you can use the merge executi on process to combi ne mul ti pl e
paths back i nto one w orkfl ow path. For exampl e, the merge
executi on process show n bel ow combi nes the three tasks
performed i n paral l el back i nto one executi on after the three
tasks are compl eted., page 1106.

6. To create a comment i n the w orkfl ow , from the C onnectors and

processes pane, sel ect the C omment i con, and then cl i ck i n the
w orkfl ow area.

C omments can be used to expl ai n the desi gn of a w orkfl ow . For

exampl e, you can use comments to expl ai n the paths of a
deci si on process, as show n i n the i mage bel ow .

You can add as many comments as needed to expl ai n a

w orkfl ow . Be aw are that the comments are vi ew abl e onl y i n
System Manager and cannot be di spl ayed to a user w hi l e the
w orkfl ow i s bei ng executed. For i nformati on on how to use
comments to add context to a w orkfl ow , see U si ng C omments to
Provi de C ontext and Informati on to a Workfl ow , page 1112.

1087 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To Define the End of a Workflow

1. C reate an exi t process, w hi ch ends the w orkfl ow and can expl ai n

how the w orkfl ow ended. From the C onnectors and processes
pane, sel ect the Exit Workflow i con, and then cl i ck i n the
w orkfl ow area. An exi t process i s created i n the w orkfl ow , as
show n i n the i mage bel ow .

2. Wi th the exi t process sel ected, from the Properti es pane, you can
choose to have the exi t process return the exi t code from the
previ ous process or return a customi zed exi t code. For more
i nformati on on how to use exi t processes to end a w orkfl ow , see
U si ng Exi t Processes to End a Workfl ow , page 1100.

3. C reate connectors from any processes that shoul d be fol l ow ed

by endi ng the w orkfl ow . Al l processes shoul d l ead to another
process i n the w orkfl ow , a deci si on, or an exi t process.

To Validate a Workflow

1. From the Workflow menu, sel ect Validate Workflow. One of the
fol l ow i ng messages i s di spl ayed:

l If the w orkfl ow i s l i sted as val i d, cl i ck OK .

l If the w orkfl ow i s not val i d, cl i ck D etails to revi ew the reasons

w hy the w orkfl ow i s not val i d. C l i ck OK and make any requi red
changes to the w orkfl ow . Once al l changes are made, val i date
the w orkfl ow agai n.

For i nformati on on w hat i s checked w hen val i dati ng a w orkfl ow ,

see Val i dati ng a Workfl ow , page 1113.

© 2019, M icr o St r at egy In c. 1088

Syst em Ad m in ist r at io n Gu id e

2. C l i ck Save Workflow A s.

3. C l i ck Save.

To Deploy a Workflow

The steps bel ow show you how to depl oy a w orkfl ow from w i thi n
System Manager. For i nformati on on depl oyi ng a w orkfl ow from the
command l i ne or as a si l ent process, see D epl oyi ng a Workfl ow , page
1238.

1. From the View menu, sel ect Options.

2. In the Log file path fi el d, type the path of a l og fi l e, or use the

fol der (brow se) i con to brow se to a l og fi l e. Al l resul ts of
depl oyi ng a w orkfl ow are saved to the fi l e that you sel ect.

3. C l i ck OK .

4. From the Workflow menu, go to Execute Workflow > R un

C onfiguration.

5. From the Starting process drop-dow n l i st, sel ect the process to
act as the fi rst process i n the w orkfl ow . You can sel ect onl y a
process that has been enabl ed as an entry process for the
w orkfl ow .

6. In the Parameters area, type any parameters requi red to execute

the processes i n the w orkfl ow , w hi ch may i ncl ude user names,
passw ords, and other val ues. To i ncl ude mul ti pl e parameter and
val ue pai rs, you must encl ose each parameter i n doubl e quotes
(" " ) and separate each parameter and val ue pai r w i th a space.
For exampl e, " U s e r N a m e = U s e r 1 " " P a s s w o r d = 1 2 3 4 " i s val i d
syntax to provi de val ues for the parameters U s e r N a m e and
Pa ss wo r d .

1089 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

For i nformati on on suppl yi ng parameters for a w orkfl ow , see

U si ng Parameters for Processes, page 1228.

7. C l i ck R un . As the w orkfl ow i s bei ng executed, the resul ts of

each process are di spl ayed i n the C onsol e pane. The resul ts are
al so saved to the l og fi l e that you speci fi ed earl i er.

If y ou need to end the work flow prematurely , from the Workflow

menu, s elec t Terminate Execution . A dialog box is dis play ed
as k ing y ou to v erify y our c hoic e to terminate the ex ec ution of the
work flow. Clic k Yes to terminate the work flow. If s ome proc es s es
in the work flow hav e already been c ompleted, thos e proc es s es are
not rolled bac k .

Using Connectors to Create the Logical Order of a

Workflow
When a process i n a w orkfl ow i s compl eted, the next step to take i n a
w orkfl ow i s determi ned usi ng connectors. C onnectors determi ne the
l ogi cal order of a w orkfl ow accordi ng to the exi t code of the process
they are comi ng from. You can sel ect from the fol l ow i ng types of
connectors:

l Success: The green arrow , to the l eft, i s the success connector. If a

process i s compl eted w i th an exi t code that i s defi ned as a
successful status, the process that the success connector poi nts to
i s the next process that i s attempted. If you use a success connector
from a process, i t i s recommended that you al so provi de a fai l ure
connector. Wi thout a fai l ure connector, the w orkfl ow may
unexpectedl y end w i th the current process.

l Failure: The red arrow , i n the mi ddl e, i s the fai l ure connector. If a
process i s compl eted w i th an exi t code that i s defi ned as a fai l ure

© 2019, M icr o St r at egy In c. 1090

Syst em Ad m in ist r at io n Gu id e

status, the process that the fai l ure connector poi nts to i s the next
process that i s attempted. If you use a fai l ure connector from a
process, i t i s recommended that you al so provi de a success
connector. Wi thout a success connector, the w orkfl ow may
unexpectedl y end w i th the current process.

l C ontinue: The w hi te arrow , to the ri ght, i s the conti nue connector.

R egardl ess of the status of the exi t code for a process, the process
that the conti nue connector poi nts to i s the next process that i s
attempted. If you use the conti nue connector from a process, you
cannot use any other connectors for that process.

When a connector i s added to a w orkfl ow , i t i s draw n from one

process to another. The arrow for the connector poi nts to the next
process to attempt i n a w orkfl ow , and the start of the connector l i nks
to the process that w as j ust compl eted.

It i s common to use a combi nati on of success and fai l ure connectors

to l ead from a process. These connectors al l ow you to conti nue w i th
the mai n w orkfl ow i f the process w as successful , and end the
w orkfl ow or troubl eshoot the probl em i f the process w as unsuccessful .
For exampl e, the steps of a w orkfl ow show n i n the i mage bel ow show
success and fai l ure connectors l eadi ng from a deci si on process.

1091 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

The fi rst deci si on process show n i n the i mage above determi nes i f
Intel l i gence Server i s operati onal . If so, the w orkfl ow fol l ow s the
success connector to conti nue on to a C ommand Manager scri pt to
perform vari ous confi gurati ons. If Intel l i gence Server i s not
operati onal , the w orkfl ow fol l ow s the fai l ure connector on an
al ternati ve path to attempt to start Intel l i gence Server before
attempti ng the C ommand Manager scri pt.

Thi s exampl e al so i ncl udes a few conti nue connectors. For exampl e,
the Start Intel l i gence Server process uses a conti nue connector to
l ead to a deci si on process. The deci si on process i s then used to
determi ne the exi t code of the previ ous process. For exampl es of how
deci si ons can be used to defi ne the l ogi cal order of a w orkfl ow , see
U si ng D eci si ons to D etermi ne the N ext Step i n a Workfl ow , page
1094.

Using Entry Processes to Determine the First Step in a

Workflow
When you depl oy a w orkfl ow , you can choose w hi ch process i s the
fi rst to attempt i n a w orkfl ow . Thi s al l ow s you to ski p steps that have

© 2019, M icr o St r at egy In c. 1092

Syst em Ad m in ist r at io n Gu id e

al ready been accompl i shed or are not requi red i n certai n

envi ronments. Bei ng abl e to sel ect the process to begi n w i th can al so
be hel pful w hen creati ng a w orkfl ow as part of testi ng and
troubl eshooti ng the steps i n a w orkfl ow .

An entry process i s any process i n a w orkfl ow that can be sel ected as

the fi rst process to attempt i n a w orkfl ow . You can enabl e and di sabl e
processes i n a w orkfl ow as avai l abl e entry processes for the
w orkfl ow . By defaul t, the fi rst process created i n a w orkfl ow i s defi ned
as an entry process; al l other processes are di sabl ed as entry
processes.

To be abl e to sel ect a process i n a w orkfl ow as the fi rst process to

attempt, i t must be enabl ed as an entry process. In the w orkfl ow area,
ri ght-cl i ck a process and sel ect Toggle Entry Process. Thi s enabl es
or di sabl es a process as an entry process for the w orkfl ow . A process
that i s defi ned as an entry process i s di spl ayed w i th a green fl ag
symbol , as show n i n the i mage bel ow .

Al though any process, other than an exi t process, can be enabl ed as

an entry process for a w orkfl ow , you shoul d l i mi t the steps that are
enabl ed as entry processes for vari ous reasons:

l Some steps i n a w orkfl ow may not w ork as entry processes. For

exampl e, a deci si on process that rel i es on the exi t code of the
previ ous process shoul d not be enabl ed as an entry process. Thi s i s
because the deci si on process coul d not retri eve the requi red exi t
code. Wi thout the abi l i ty to retri eve an exi t code, the deci si on
process w oul d not be abl e to perform a compari son, and the
w orkfl ow w oul d appear to be unresponsi ve.

1093 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l When depl oyi ng a w orkfl ow usi ng System Manager, each avai l abl e
entry process i s l i sted. Provi di ng many avai l abl e entry processes
can cause confusi on as to w hi ch entry process to use to begi n the
w orkfl ow .

l When depl oyi ng a w orkfl ow , starti ng at a certai n step can cause

previ ous steps to be ski pped enti rel y, dependi ng on the l ogi cal
order of the w orkfl ow . Ensure that ski ppi ng certai n steps sti l l al l ow s
the w orkfl ow to be val i d i n the scenari os that i t w i l l be used i n.

Using Decisions to Determine the Next Step in a

Workflow
When a process i s compl eted, the si mpl e success or fai l ure of a
process i s not al w ays enough to determi ne the next step to take i n a
w orkfl ow . D eci si on processes can be used to compare process exi t
codes, parameters, and other val ues to provi de addi ti onal control over
the next step to take i n a w orkfl ow . You can al so use deci si on
processes to check for the exi stence of a fi l e or fol der, as w el l as i f
the fi l e or fol der i s empty.

To add a deci si on process to your w orkfl ow , from the C onnectors and

processes pane, sel ect the D ecision i con, and then cl i ck i n the
w orkfl ow area. A deci si on process i s created i n the w orkfl ow , as
show n i n the i mage bel ow .

To Compare Parameters, Constants, and Exit Codes

1. Sel ect the opti on Parameter/Exit C ode C omparison.

2. Sel ect to use a parameter or an exi t code as the fi rst i tem for the
compari son:

© 2019, M icr o St r at egy In c. 1094

Syst em Ad m in ist r at io n Gu id e

l Parameter or constant: Sel ect thi s opti on to provi de a

parameter or constant for compari son. You must type the
parameter name or the constant val ue.

l Previous process exit code: Sel ect thi s opti on to use the exi t
code of the previ ous process i n the compari son. U si ng the exi t
code of a process al l ow s you to determi ne i n greater detai l w hy
a process w as successful or unsuccessful . Thi s al l ow s you to
take more speci fi c acti on to troubl eshoot potenti al probl ems i n
a w orkfl ow .

For exampl e, i f you attempt to execute a C ommand Manager

scri pt as part of a w orkfl ow , thi s type of process can fai l for
vari ous reasons. If the process fai l s w i th an exi t code equal to
four, thi s i ndi cates that a connecti on coul d not be made to
perform the scri pt. For thi s exi t code, a deci si on process coul d
l ead to a process to start Intel l i gence Server. H ow ever, i f the
process fai l s w i th an exi t code equal to si x, thi s i ndi cates that
the scri pt has a syntax error. For thi s exi t code, a deci si on
process coul d l ead to an exi t process, so the w orkfl ow coul d be
ended and the C ommand Manager scri pt coul d be manual l y
revi ew ed for syntax errors.

3. From the C omparison operator drop-dow n l i st, sel ect the

operator for the compari son.

4. In the C omparison item 2 fi el d, type a val ue. It i s common to

type a constant val ue to compare a parameter or exi t code to.

5. In the Output parameters area, you can speci fy a parameter i n

the Previous process exit code drop-dow n l i st. The parameter
speci fi ed i s updated w i th the val ue of the exi t code from the
process that w as compl eted j ust before the deci si on process.
You can use thi s techni que i f you need mul ti pl e deci si on
processes to determi ne the next course of acti on, w hi ch i s

1095 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

descri bed i n U si ng Mul ti pl e D eci si on Processes to Troubl eshoot

a Workfl ow , page 1096 bel ow .

If you do not need to use the exi t code from the previ ous process
l ater i n the w orkfl ow , you can l eave the Previ ous process exi t
code drop-dow n l i st bl ank.

To Check for the Existence of a File or Folder

1. Sel ect the opti on File/D irectory C heck.

2. In File/D irectory Path, type the path to the fi l e or di rectory to

check. You can al so cl i ck the fol der i con to brow se to and sel ect
a fi l e or di rectory.

3. From the File/D irectory C heck C ondition drop-dow n l i st, sel ect
one of the fol l ow i ng opti ons:

l Exists: Sel ect thi s opti on to check onl y i f the fi l e or di rectory

exi sts. The deci si on process returns as true i f the fi l e or
di rectory can be found.

l Exists and not empty: Sel ect thi s opti on to check i f the fi l e or
di rectory exi sts, and i f the fi l e or di rectory i s empty. For fi l es,
thi s check veri fi es that some i nformati on i s i n the fi l e. For
di rectori es, thi s check veri fi es w hether any other fi l es or
fol ders are i n the di rectory. The deci si on process returns as
true i f the fi l e or di rectory exi sts, and the fi l e or di rectory has
some type of content avai l abl e.

Usin g Mu lt ip le Decisio n Pr o cesses t o Tr o u b lesh o o t a

Wo r kf lo w
When you are creati ng a w orkfl ow , you can use mul ti pl e deci si on
processes to take more speci fi c acti on on process exi t codes and
troubl eshoot potenti al probl ems i n a w orkfl ow .

© 2019, M icr o St r at egy In c. 1096

Syst em Ad m in ist r at io n Gu id e

When a process i n a w orkfl ow i s compl eted, i t can ei ther be a success

or fai l ure. Addi ti onal l y, certai n processes can fai l for mul ti pl e
reasons. Al though a si ngl e deci si on process can determi ne i f a
process w as a success or fai l ure, you need to use mul ti pl e deci si on
processes to qual i fy how a process fai l ed. By qual i fyi ng w hy a
process fai l ed, you can more accuratel y troubl eshoot the process and,
i n some cases, even take acti on i n the w orkfl ow i tsel f to fi x the
probl em.

For exampl e, i f you attempt to execute a C ommand Manager scri pt as

part of a w orkfl ow , thi s type of process can fai l for vari ous reasons. If
the process fai l s w i th an exi t code equal to four, thi s i ndi cates that a
connecti on coul d not be made to perform the scri pt. For thi s exi t code,
a deci si on process coul d l ead to a process to start Intel l i gence
Server. H ow ever, i f the process fai l s w i th an exi t code equal to si x,
thi s i ndi cates that the scri pt has a syntax error. For thi s exi t code, a
deci si on process coul d l ead to an exi t process, so the w orkfl ow coul d
be ended and the C ommand Manager scri pt coul d be manual l y
revi ew ed for syntax errors. T troubl eshooti ng scenari o i s show n i n the
w orkfl ow bel ow .

1097 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

The fi rst deci si on process (l abel ed as Success or fai l ure?) can

determi ne w hether the C ommand Manager scri pt w as a success or a
fai l ure. Addi ti onal l y, thi s deci si on process uses the Previ ous process
exi t code to store the exi t code for the C ommand Manager scri pt
process i nto a parameter cal l ed D e c i s i o n. You must use the
Previ ous process exi t code to store the exi t code for the ori gi nal
C ommand Manager process so that thi s exi t code can be used i n the
other deci si on processes.

In a c hain of multiple-dec is ion proc es s es , y ou s hould us e the Prev ious

proc es s ex it c ode option only in the firs t dec is ion proc es s . This is
bec aus e onc e this ex it c ode is s tored in a parameter, y ou c an then
reus e that parameter in later dec is ion proc es s es as a c omparis on item.
If y ou were to mis tak enly inc lude the s ame parameter in the Prev ious
proc es s ex it c ode option for one of the later dec is ion proc es s es , the

© 2019, M icr o St r at egy In c. 1098

Syst em Ad m in ist r at io n Gu id e

parameter would be updated to hav e the ex it c ode of the prev ious

dec is ion proc es s . This would then ov erwrite the original ex it c ode, whic h
would prev ent y ou from c omparing the original ex it c ode in the later
dec is ion proc es s es .

If the scri pt w as a success, the fi rst deci si on process al l ow s the

w orkfl ow to conti nue. If the scri pt fai l s, a second deci si on process i s
started. Thi s second deci si on process (l abel ed as Fai l ed to connect
to Intel l i gence Server?) uses the val ue previ ousl y stored i n the
Deci si on parameter to determi ne i f the exi t code i s equal to four.
Wi th an exi t code equal to four, thi s deci si on process can attempt to
start Intel l i gence Server and then attempt to run the C ommand
Manager scri pt agai n. If thi s second deci si on process fai l s, w hi ch
means the exi t code i s not equal to four, a thi rd deci si on process
(l abel ed as Scri pt syntax error?) i s started.

Thi s thi rd deci si on process agai n uses the val ue that w as stored i n
the D ec is io n parameter by the fi rst deci si on process to determi ne i f
the exi t code i s equal to si x. Wi th an exi t code equal to si x, thi s
deci si on process can send an emai l to a someone to revi ew the
C ommand Manager scri pt for syntax errors, and i t can attach the scri pt
to the emai l . Once the emai l i s sent, the w orkfl ow i s exi ted. If thi s fi nal
deci si on process fai l s, that means the C ommand Manager scri pt
fai l ed for another reason. In thi s case, the w orkfl ow i s exi ted for
addi ti onal troubl eshooti ng.

When usi ng mul ti pl e deci si on processes to qual i fy the resol uti on of a

previ ous process, be aw are that as l ong as you store the ori gi nal exi t
code i n a parameter, you can use as many deci si on processes as
necessary.

Addi ti onal l y, thi s techni que of usi ng mul ti pl e deci si on processes i s a

good practi ce for processes that are i mportant to the overal l success
or fai l ure of a w orkfl ow . H ow ever, usi ng thi s techni que for every
process i n a w orkfl ow coul d cause the w orkfl ow to become overl y
compl ex and di ffi cul t to create and fol l ow . For exampl e, processes

1099 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

that send emai l s l i kel y do not requi re i nvol ved troubl eshooti ng i n the
w orkfl ow i tsel f, but a process that attempts to start Intel l i gence Server
may benefi t from i ncl udi ng potenti al troubl eshooti ng steps.

Using Exit Processes to End a Workflow

When a w orkfl ow i s depl oyed, i t i s i mportant to be abl e to noti fy
w hoever i s depl oyi ng the w orkfl ow w hen and how the w orkfl ow has
ended. An exi t process al l ow s you to end a w orkfl ow and expl ai n how
the w orkfl ow ended.

To add an exi t process to your w orkfl ow , from the C onnectors and

processes pane, sel ect the Exit Workflow i con, and then cl i ck i n the
w orkfl ow area. An exi t process i s created i n the w orkfl ow , as show n i n
the i mage bel ow .

Wi th the process sel ected, from the Properti es pane, you can defi ne
w hat type of exi t code i s provi ded w hen the exi t code i s reached:

l U se previous process exit code: Sel ect thi s opti on to return the
exi t code of the process that w as compl eted j ust before the exi t
process. If you use thi s opti on you can use the same exi t process
from mul ti pl e processes i n the w orkfl ow , and the exi t code returned
provi des i nformati on on w hatever process l ed to the exi t process.
For exampl e, the steps of a w orkfl ow show n i n the i mage bel ow
show tw o processes l eadi ng to the same exi t process.

© 2019, M icr o St r at egy In c. 1100

Syst em Ad m in ist r at io n Gu id e

When the w orkfl ow compl etes, the same exi t process returns the
exi t code ei ther on the deci si on process that determi nes i f
Intel l i gence Server can be started, or the process that compl etes a
C ommand Manager scri pt.

l U se customized exit code: Sel ect thi s opti on to defi ne your ow n

exi t code for the exi t process by typi ng i n the avai l abl e fi el d. Thi s
al l ow s you to create exi t codes customi zed to your needs. You can
use onl y numeri c val ues for the customi zed exi t code.

If you use thi s opti on, you may w ant to use mul ti pl e exi t processes
i n a w orkfl ow . You can then defi ne each exi t process w i th a uni que
exi t code. Thi s can expl ai n w hat path the w orkfl ow took and how i t
ended. Thi s can be hel pful because w orkfl ow s can have mul ti pl e
possi bl e paths i ncl udi ng a successful path w here al l processes
w ere compl eted and unsuccessful paths w here the w orkfl ow had to
be ended prematurel y.

Every w orkfl ow shoul d i ncl ude at l east one exi t process. Ensuri ng
that processes ei ther l ead to another process or to an exi t process
provi des a consi stent expectati on for the resul ts of a w orkfl ow .

Processing Related Tasks One by One

System Manager supports processi ng rel ated tasks one by one and
determi ni ng how many rel ated tasks are avai l abl e. Thi s can be done
usi ng the i terati ve retri eval process. Wi th such a process, you can
have a w orkfl ow retri eve i nformati on from sources i ncl udi ng a fol der,

1101 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

the contents of a fi l e, or a System Manager parameter. Thi s

i nformati on can then be passed to another process i n the System
Manager w orkfl ow for processi ng a task.

For exampl e, you have mul ti pl e proj ects that requi re obj ect updates
on an i ntermi ttent schedul e. At the start of each w eek, any updates
that are requi red are i ncl uded i n a separate update package for each
proj ect, and al l update package fi l es are stored i n a fol der. The
number of update packages requi red for a w eek vari es dependi ng on
requi rements of the vari ous proj ects. By usi ng the i terati ve retri eval
process, the fol der that stores the w eekl y update packages can be
anal yzed to determi ne how many update packages need to be appl i ed
for the w eek. The w orkfl ow show n bel ow then retri eves these update
packages from the fol der one by one, appl yi ng the update package,
emai l i ng the proj ect admi ni strator, and usi ng the i terati ve retri eval
process to retri eve the next update package.

The i terati ve retri eval process automati cal l y determi nes the number of
update packages i n the fol der, w hi ch al l ow s you to run the same
w orkfl ow each w eek w i thout havi ng to modi fy the w orkfl ow to account

© 2019, M icr o St r at egy In c. 1102

Syst em Ad m in ist r at io n Gu id e

for varyi ng numbers of update packages from w eek to w eek. Once al l

update packages are processed and no more update packages can be
retri eved, the i terati ve retri eval process exi ts w i th a fai l ure exi t code
to si gni fy that no more i nformati on i s avai l abl e for retri eval .

Wi th the process sel ected, from the Properti es pane, you can defi ne
how the i terati ve retri eval process retri eves i nformati on to be
processed as part of a System Manager w orkfl ow :

l Files in D irectory: Sel ect thi s opti on to retri eve fi l es from a fol der.
When retri evi ng fi l es from a fol der, be aw are that each ti me a fi l e i s
retri eved, i t i s stored i n the same parameter and thus provi ded to
the same process i n the System Manager w orkfl ow . Thi s means that
the System Manager process that uses these fi l es must be abl e to
process al l fi l es i n a fol der. In the exampl e update package
scenari o, the fol der must contai n onl y update packages. If, for
exampl e, a text fi l e w as stored i n the fol der, retri evi ng thi s text fi l e
and passi ng i t to the i mport package process w oul d cause an error
i n the w orkfl ow .

C l i ck the fol der i con to brow se to and sel ect a fol der, or type the ful l
path i n the D irectory N ame fi el d. You must al so determi ne how the
fi l es are retri eved, usi ng the fol l ow i ng opti ons:

l File N ames Only: Sel ect thi s opti on to retri eve onl y the name of
the fi l e, i ncl udi ng the fi l e extensi on. If you cl ear thi s check box,
the ful l fi l e path to the fi l e i s retri eved, w hi ch i s commonl y
requi red i f you need the l ocati on of the fi l e for other processes i n
the System Manager w orkfl ow .

l A ll Files: Sel ect thi s opti on to retri eve fi l es from onl y the top-l evel
fol der.

l A ll Files and Subfolders R ecursively: Sel ect thi s opti on to

retri eve fi l es from the top-l evel fol der and al l subfol ders.

1103 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l C ontent of File: Sel ect thi s opti on to retri eve the contents of a fi l e.
C l i ck the fol der i con to brow se to and sel ect a fi l e, or type the ful l
path i n the File N ame fi el d. You must al so determi ne i f a separator
i s used to segment the content w i thi n the fi l e, usi ng the fol l ow i ng
opti on:

l Separator: Sel ect thi s check box to retri eve the contents of a fi l e
i n mul ti pl e, separate segments. Type the separator character or
characters that are used i n the fi l e to denote separate secti ons of
content. For exampl e, you can type a comma (, ) i f the content i s
separated usi ng commas. You can al so use characters such as
\n , \ t, and \ s to represent the new l i ne, tab, and space
separators, respecti vel y.

If you cl ear thi s check box, the enti re contents of the fi l e i s returned
i n a si ngl e retri eval .

l Parameter: Sel ect thi s opti on to retri eve the contents of a

parameter. From the Parameter N ame drop-dow n l i st, sel ect a
parameter that i s i ncl uded i n the System Manager w orkfl ow . You
must al so determi ne i f a separator i s used to segment the content
w i thi n the parameter, usi ng the fol l ow i ng opti on:

l Separator: Sel ect thi s check box to retri eve the contents of a
parameter i n mul ti pl e, separate segments. Type the separator
character or characters that are used i n the parameter to denote
separate secti ons of content. For exampl e, you can type a comma
(, ) i f the content i s separated usi ng commas. You can al so use
the characters \ n, \ t, and \ s to represent the new l i ne, tab, and
space separators, respecti vel y.

If you cl ear thi s check box, the enti re contents of the parameter i s
returned i n a si ngl e retri eval .

l Output Parameter: The i nformati on retri eved must be stored i n a

parameter so that i t can be passed to another process i n the System

© 2019, M icr o St r at egy In c. 1104

Syst em Ad m in ist r at io n Gu id e

Manager w orkfl ow . Sel ect an output parameter from the drop-dow n

l i st.

Processing Multiple Tasks Simultaneously

System Manager supports executi ng tasks i n paral l el i n a w orkfl ow .
Thi s takes advantage of a system's processi ng pow er to compl ete the
tasks more qui ckl y. Thi s i s done by usi ng the spl i t executi on process.
Wi th a spl i t executi on process, you can have a w orkfl ow process tw o
or more tasks at the same ti me. The spl i t executi on process show n
bel ow takes a l i near w orkfl ow and begi ns to process three tasks i n
paral l el .

When usi ng spl i t executi ons to process mul ti pl e tasks i n a w orkfl ow at

the same ti me, consi der the fol l ow i ng best practi ces:

l Ensure that the tasks do not depend on each other. Workfl ow s are
often l i near processes that requi re that one task i s compl eted before
starti ng another task. For exampl e, you cannot run certai n
C ommand Manager scri pts unti l Intel l i gence Server i s started. Thi s
means a task to start Intel l i gence Server shoul d not be done i n
paral l el w i th other tasks that requi re Intel l i gence Server to be
operati onal .

1105 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l C onsi der the amount of processi ng that i s requi red to perform the
tasks i n paral l el , rel ati ve to your avai l abl e system resources. Whi l e
performi ng mul ti pl e tasks at once can save ti me, i t can al so sl ow
dow n overal l performance i f the requi red system resources are not
avai l abl e. Even i f a w orkfl ow i s created to start mul ti pl e tasks, you
can l i mi t the number of tasks that are performed i n paral l el to
prevent overl oadi ng the system, as descri bed i n Li mi ti ng the
N umber of Paral l el Tasks to Prevent Over C onsumpti on of System
R esources, page 1109.

l Spl i t executi on processes can use onl y the conti nue connector (see
U si ng C onnectors to C reate the Logi cal Order of a Workfl ow , page
1090) to l i nk to new tasks to perform i n paral l el . You must al so use
tw o or more conti nue connectors, as a spl i t executi on i s meant to
spl i t a w orkfl ow i nto at l east tw o paths to perform i n paral l el .

Once a w orkfl ow executi on i s spl i t i nto mul ti pl e paths, each task i s

performed i ndependentl y of the other tasks. H ow ever, w hi l e the tasks
are done i ndependentl y, al l the tasks may need to be compl eted
before performi ng other tasks l ater i n the w orkfl ow . For exampl e, you
can create a D SN and start Intel l i gence Server as separate tasks at
the same ti me, but you may need both of those tasks to be ful l y
compl ete before starti ng another task that requi res the D SN to be
avai l abl e and Intel l i gence Server to be operati onal . To support thi s
w orkfl ow , you can use the merge executi on process to combi ne
mul ti pl e paths back i nto one w orkfl ow path. For exampl e, the merge
executi on process show n bel ow combi nes the three tasks performed
i n paral l el back i nto one executi on after the three tasks are
compl eted.

© 2019, M icr o St r at egy In c. 1106

Syst em Ad m in ist r at io n Gu id e

For each merge executi on process, you must suppl y a ti me out val ue.
Thi s ti me out val ue i s the amount of ti me, i n seconds, that i s al l ow ed
to compl ete al l the paral l el tasks that are connected to the merge
executi on process. The ti me starts to count dow n once the fi rst task
connected to a merge executi on process i s compl eted. H ow the
remai ni ng tasks connected to the merge executi on are processed
depends on the connectors used to conti nue from the merge executi on
process:

It i s recommended that you use the success and fai l ure connectors to
exi t the merge process:

l Success connector: If each task that i s connected to a merge

executi on i s compl eted i n the al l otted ti me, the w orkfl ow conti nues
to the confi gurati on that i s l i nked to the merge executi on w i th the
success connector.

l Fai l ure connector: If at l east one task connected to the merge

executi on i s not compl eted i n the al l otted ti me, or al l other paths

1107 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

have been ended w i thout reachi ng the merge executi on process,

the w orkfl ow conti nues to the confi gurati on that i s l i nked to the
merge executi on w i th the fai l ure connector.

Al though merge executi on processes are hel pful to conti nue the
w orkfl ow w hen certai n tasks are compl eted, you do not have to merge
any or al l paths that are started w i th a spl i t executi on process. Each
task performed i n paral l el w i th other tasks can come to separate
compl eti ons usi ng standard exi t processes (see U si ng Exi t Processes
to End a Workfl ow , page 1100). For exampl e, i n the w orkfl ow show n
bel ow , both D SN creati on confi gurati ons must be compl eted to al so
process the Execute SQL confi gurati on. H ow ever, the path that starts
w i th an Intel l i gence Server startup confi gurati on conti nues on to
compl eti on regardl ess of w hether any of the other tasks are
compl eted.

© 2019, M icr o St r at egy In c. 1108

Syst em Ad m in ist r at io n Gu id e

Limit in g t h e Nu mb er o f Par allel Tasks t o Pr even t Over

Co n su mp t io n o f Syst em Reso u r ces
Whi l e creati ng a w orkfl ow , the spl i t executi on process can be used to
start as many tasks at the same ti me as requi red. H ow ever, each
addi ti onal task that i s attempted i n paral l el requi res addi ti onal system
resources. If your system cannot handl e the addi ti onal processi ng
requi rements to compl ete al l the tasks i n paral l el , thi s can sl ow dow n
the w orkfl ow executi on and the enti re system's performance.

To avoi d these types of performance i ssues, you can l i mi t the number

of tasks that can be processed at the same ti me for a w orkfl ow . Thi s
ensures that even i f a w orkfl ow requests a certai n number of tasks to

1109 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

be processed at the same ti me, onl y the speci fi ed l i mi t i s al l ow ed to

run at a ti me.

The defaul t val ue for the l i mi t i s the greater of ei ther the number of
C PU s for the system or 2. Al though the number of C PU s for the
system i s a reasonabl e defaul t, be aw are of the fol l ow i ng:

l Systems can process more tasks si mul taneousl y than the number of
C PU s avai l abl e.

l Systems can have mul ti pl e C PU s, but thi s does not necessari l y

mean al l the C PU s are avai l abl e to the user w ho i s depl oyi ng a
w orkfl ow . For exampl e, consi der a Li nux machi ne w i th ei ght C PU s
avai l abl e. In thi s scenari o, the Maxi mum Thread defaul t val ue i s 8.
H ow ever, the user account that i s bei ng used to depl oy the w orkfl ow
may be al l ow ed to use onl y one C PU for the Li nux machi ne. When
determi ni ng the maxi mum number of tasks to run si mul taneousl y i n
System Manager w orkfl ow s, you shoul d understand detai l s about
system resource confi gurati on.

As a w orkfl ow i s depl oyed, any tasks over the set l i mi t are put i nto a
queue. For exampl e, i f a spl i t executi on process attempts to start fi ve
tasks, but the Maxi mum Threads opti on i s set at three, tw o of the
tasks are i mmedi atel y put i n the queue. Once a task i s compl eted, the
next task i n the queue can begi n processi ng.

In terms of queueing and proc es s ing tas k s , eac h s eparate c onfiguration

is c ons idered as a s eparate tas k . Onc e a c onfiguration is c ompleted, the
c onfiguration that it link s to nex t might not be the nex t c onfiguration to
be proc es s ed. For ex ample, a s plit ex ec ution proc es s attempts to s tart
fiv e tas k s , as s hown in the image below.

© 2019, M icr o St r at egy In c. 1110

Syst em Ad m in ist r at io n Gu id e

The Maxi mum Threads opti on i s set at three, w hi ch means that tw o

of the tasks are i mmedi atel y put i n the queue. Assume then that
one of the three tasks bei ng processed (Task A) comes to
compl eti on, and i t l i nks to another task i n the w orkfl ow (Task B).
R ather than i mmedi atel y starti ng to process Task B, the w orkfl ow
must fi rst process the tasks that w ere al ready i ncl uded i n the
queue (Task E and Task F). Thi s puts Task B behi nd the tw o
exi sti ng tasks al ready i n the queue.

To Define the Parallel Task Limit

1. From the View menu, sel ect Options

2. In the Maximum C oncurrent Threads fi el d, type the maxi mum

number of tasks that can processed at the same ti me. The defaul t
val ue for thi s opti on i s the greater of ei ther the number of C PU s
for the system or 2.

3. C l i ck OK .

1111 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Using Comments to Provide Context and Information to

a Workflow
Workfl ow s can be made more hel pful i f you add i nformati on about w hy
certai n steps are performed or expl ai n the l ogi cal order of the
w orkfl ow . You can i ncl ude thi s type of i nformati on i n a w orkfl ow by
addi ng comments to the w orkfl ow .

To add a comment to your w orkfl ow , from the C onnectors and

processes pane, sel ect the C omment i con, and then cl i ck i n the
w orkfl ow area. A comment i s created i n the w orkfl ow .

You can then type the i nformati on for the comment. You can al so
resi ze the comment and move i t to the requi red l ocati on i n a w orkfl ow .

You can use comments to expl ai n to the w orkfl ow 's desi gn. For
exampl e, you can use comments to expl ai n the paths of a deci si on
process, as show n i n the i mage bel ow .

Another benefi t of usi ng comments i s to provi de i nformati on di rectl y i n

the w orkfl ow area. For exampl e, the i mage bel ow show s a w orkfl ow
w i th a comment that expl ai ns the C ommand Manager scri pt process.

© 2019, M icr o St r at egy In c. 1112

Syst em Ad m in ist r at io n Gu id e

The same i nformati on i n the comment i s i ncl uded i n the descri pti on
for the C ommand Manager scri pt process. H ow ever, provi di ng the
i nformati on i n a comment al l ow s thi s i nformati on to be di spl ayed
di rectl y i n the w orkfl ow area.

You can add as many comments as needed to expl ai n a w orkfl ow . Be

aw are that the comments are vi ew abl e onl y i n System Manager and
cannot be di spl ayed to a user w hi l e the w orkfl ow i s bei ng depl oyed.

Validating a Workflow
Val i dati ng a w orkfl ow i s an i mportant step i n creati ng a w orkfl ow .
Al though val i dati ng a w orkfl ow does not guarantee that every process
w i l l be compl eted successful l y w hen depl oyi ng a w orkfl ow , i t hel ps to
l i mi t the possi bi l i ty for errors duri ng the depl oyment.

Whi l e you are creati ng a w orkfl ow , you can use System Manager to
val i date the w orkfl ow . Thi s val i dati on process performs the fol l ow i ng
checks on the w orkfl ow :

l The w orkfl ow contai ns at l east one entry process. Thi s i s requi red
so that the w orkfl ow has at l east one process to use as the fi rst step
i n the w orkfl ow .

l Al l processes have val ues for al l requi red properti es. For exampl e,
i f you are creati ng a D SN , you must suppl y a name for the D SN , the
machi ne that stores the data source, the port number, and other
requi red val ues for the data source type.

1113 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

The val i dati on checks onl y that val ues exi st for al l requi red
properti es, not w hether the val ues are val i d for the process.

To use System Manager to val i date a w orkfl ow , from the Workflow

menu, sel ect Validate Workflow. One of the fol l ow i ng messages i s
di spl ayed:

l The workflow is valid: Thi s message i s di spl ayed i f i t passes al l

the checks l i sted above. C l i ck OK to cl ose the message.

l Incomplete workflow: Thi s message i s di spl ayed i f parts of the

w orkfl ow are not val i d. C l i ck D etails to di spl ay the i nval i d porti ons
of the w orkfl ow . C onti nue to fi x the w orkfl ow and perform the
val i dati on unti l you see the message, "The w orkfl ow i s val i d." C l i ck
OK to cl ose the message.

Addi ti onal val i dati ons that can be done manual l y on a w orkfl ow are
descri bed i n Manual l y val i dati ng a w orkfl ow bel ow .

Man u ally Valid at in g a Wo r kf lo w

As part of val i dati ng your w orkfl ow , you shoul d manual l y val i date
addi ti onal aspects of the w orkfl ow . These addi ti onal val i dati ons hel p
reduce the potenti al for i ssues to devel op w hen depl oyi ng a w orkfl ow .
Thi s i ncl udes the fol l ow i ng val i dati ons:

l Each process has ei ther one conti nue connector or one success
connector and one fai l ure connector l eadi ng from i t. Thi s ensures
that each process conti nues on to another step i n the w orkfl ow
regardl ess of w hether the process i s successful or unsuccessful .
For more i nformati on on correctl y suppl yi ng connectors for a
w orkfl ow , see U si ng C onnectors to C reate the Logi cal Order of a
Workfl ow , page 1090.

l The w orkfl ow has at l east one exi t process. Exi t processes veri fy
that a w orkfl ow depl oyment has compl eted. For more i nformati on on

© 2019, M icr o St r at egy In c. 1114

Syst em Ad m in ist r at io n Gu id e

how you can use exi t processes i n a w orkfl ow , see U si ng Exi t

Processes to End a Workfl ow , page 1100.

l Step through the l ogi cal order of the w orkfl ow and doubl e-check
that al l the possi bl e paths make sense w i th the purpose of the
w orkfl ow . You can al so use thi s as an opportuni ty to check for parts
of the w orkfl ow that coul d become cycl i cal . For exampl e, i n the
w orkfl ow show n i n the i mage bel ow , a potenti al cycl i cal path i s
hi ghl i ghted w i th purpl e, dashed arrow s.

Al though thi s cycl i cal path w oul d l et the w orkfl ow attempt to start
Intel l i gence Server mul ti pl e ti mes, i f Intel l i gence Server cannot be
started successful l y, the w orkfl ow coul d conti nue to execute unti l i t
w as manual l y ended. An al ternati ve w oul d be to modi fy the l ogi cal
order of the w orkfl ow to attempt to start Intel l i gence Server a
second ti me, but end the w orkfl ow i f the second attempt al so fai l s.
Thi s new path i s show n i n the i mage bel ow .

1115 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

As an al ternati ve to modi fyi ng a w orkfl ow to avoi d l oops, you can al so

use the U pdate Parameters confi gurati on (see Performi ng System
Processes, page 1181). Thi s confi gurati on l ets you update a
parameter, i ncl udi ng i ncremental l y, w hi ch al l ow s you to end a l oop i n
a w orkfl ow after a speci fi ed number of attempts (see Supporti ng
Loops i n a Workfl ow to Attempt C onfi gurati ons Mul ti pl e Ti mes, page
1116 bel ow ).

Supporting Loops in a Workflow to Attempt

Configurations Multiple Times
When depl oyi ng a w orkfl ow , i t may be necessary to perform the same
confi gurati on mul ti pl e ti mes. For exampl e, i f you attempt to start
Intel l i gence Server but i t does not start successful l y, you can conti nue
to attempt to start Intel l i gence Server unti l i t starts successful l y, or the
w orkfl ow i s ended. To support thi s type of a w orkfl ow , you can i ncl ude
a l oop i n your w orkfl ow .

Loops shoul d commonl y be avoi ded i n w orkfl ow s because they can

cause a w orkfl ow to conti nue to perform the same acti ons repeatedl y
w i th no w ay to end the w orkfl ow . H ow ever, you can use deci si on
processes and the U pdate Parameters process (see Performi ng

© 2019, M icr o St r at egy In c. 1116

Syst em Ad m in ist r at io n Gu id e

System Processes, page 1181) to support l oops i n w orkfl ow s. By

i ncl udi ng the U pdate Parameters process i n a w orkfl ow , you can keep
track of how many ti mes a l oop i n a w orkfl ow i s repeated. After a
certai n amount of attempts, the l oop can be exi ted even i f the requi red
confi gurati on w as not compl eted successful l y.

For exampl e, the w orkfl ow show n bel ow uses a l oop to attempt to

start Intel l i gence Server, mul ti pl e ti mes i f necessary, before
performi ng a C ommand Manager scri pt that requi res Intel l i gence
Server to be operati onal .

Wi th the w orkfl ow show n above, i f Intel l i gence Server starts

successful l y the fi rst ti me, the C ommand Manager scri pt i s executed
next and the l oop i s not needed. H ow ever, i f starti ng Intel l i gence
Server i s not successful , the fi rst thi ng that occurs i s that the U pdate
Loop C ounter confi gurati on updates a parameter for the w orkfl ow . A
parameter named Loop i s i ncl uded i n the w orkfl ow w i th the i ni ti al
val ue of zero, and the U pdate Loop C ounter confi gurati on updates
thi s parameter w i th the fol l ow i ng statement:

${Lo op } + 1

1117 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

U si ng thi s statement, the Loop parameter i s i ncreased by one each

ti me the U pdate Loop C ounter confi gurati on i s executed. Once the
Loop parameter has been i ncreased, a deci si on process i s used to
check the val ue of the Loop parameter. If the Loop parameter i s l ess
than three, the confi gurati on to start Intel l i gence Server i s attempted
agai n. Thi s al l ow s the confi gurati on to start Intel l i gence Server to be
attempted three ti mes. If Intel l i gence Server sti l l cannot start
successful l y, the l oop i s di sconti nued and the w orkfl ow i s stopped.

To us e s plit and merge ex ec utions in a work flow that us es logic al loops ,

s ee Once a w orkfl ow executi on i s spl i t i nto mul ti pl e paths, each
task i s performed i ndependentl y of the other tasks. H ow ever,
w hi l e the tasks are done i ndependentl y, al l the tasks may need to
be compl eted before performi ng other tasks l ater i n the w orkfl ow .
For exampl e, you can create a D SN and start Intel l i gence Server
as separate tasks at the same ti me, but you may need both of
those tasks to be ful l y compl ete before starti ng another task that
requi res the D SN to be avai l abl e and Intel l i gence Server to be
operati onal . To support thi s w orkfl ow , you can use the merge
executi on process to combi ne mul ti pl e paths back i nto one
w orkfl ow path. For exampl e, the merge executi on process show n
bel ow combi nes the three tasks performed i n paral l el back i nto
one executi on after the three tasks are compl eted., page 1106 .

Sample Workflows: Templates

System Manager i ncl udes sampl e, templ ate w orkfl ow s that you can
use to l earn how to create w orkfl ow s i n System Manager and use as
bui l di ng bl ocks for your ow n w orkfl ow s.

From the System Manager home page, you can access the templ ate
w orkfl ow s i n the Templ ates secti on. To choose from the ful l l i st of
templ ate w orkfl ow s, cl i ck the More Templates fol der.

© 2019, M icr o St r at egy In c. 1118

Syst em Ad m in ist r at io n Gu id e

Once the w orkfl ow i s open i n System Manager, you can sel ect each
process i n the w orkfl ow to revi ew the task that i t performs for the
w orkfl ow . You can al so modi fy the properti es of each process so that
the w orkfl ow can be used to confi gure and admi ni ster your
envi ronment. For i nformati on on the properti es avai l abl e for each type
of process avai l abl e usi ng System Manager, see D efi ni ng Processes,
page 1130.

Temp lat e: Co n f igu r in g In t elligen ce Ser ver

The templ ate 0 1 C o n f i g u r e I n t e l l i g e n c e S e r v e r . s m w can be
used to confi gure Intel l i gence Server. The templ ate i ncl udes the
fol l ow i ng tasks:

l C reates a new D SN to store a metadata.

l C onfi gures Intel l i gence Server to connect to the new D SN .

l C reates a new proj ect source, w hi ch al l ow s access to the metadata.

Before usi ng thi s templ ate, be sure the fol l ow i ng prerequi si tes are
met:

l A database l ocati on used to store a Mi croStrategy metadata. By

defaul t, the templ ate creates a D SN for a Mi crosoft SQL Server
database. You can sw ap i n a process that matches the database
type that you use to store your metadata. For a l i st of processes that
can be used to create D SN s, see C reati ng D ata Source N ames,
page 1157.

l Separate response fi l es used to connect Intel l i gence Server to the

new D SN and to create a new proj ect source. These response fi l es
can be created usi ng Mi croStrategy C onfi gurati on Wi zard, as
descri bed i n the Instal l ati on and C onfi gurati on Gui de.

1119 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Temp lat e: Co n f igu r in g Micr o St r at egy Su it e

The templ ate 0 2 R e p o r t i n g S u i t e S e t u p . s m w can be used to
confi gure Mi croStrategy Sui te. The Mi croStrategy Sui te i s a
Mi croStrategy offeri ng that l ets you eval uate Mi croStrategy as a
departmental sol uti on. For detai l ed i nformati on to dow nl oad, i nstal l ,
confi gure, and use the Mi croStrategy Sui te, see the Mi croStrategy
Sui te: Qui ck Start Gui de. Thi s templ ate i ncl udes the fol l ow i ng tasks:

l C reates a new metadata.

l C onfi gures Intel l i gence Server to connect to the new metadata.

l C reates a new proj ect source, w hi ch al l ow s access to the new

metadata.

l C reates a new database i nstance for the Mi croStrategy Sui te.

l C reates a new proj ect for the Mi croStrategy Sui te and connects i t to
the new database i nstance.

l Sends an emai l noti fi cati on that descri bes the success of

confi guri ng the Mi croStrategy Sui te.

Before usi ng thi s templ ate, be sure the fol l ow i ng prerequi si tes are
met:

l Access to the Mi croStrategy Sui te softw are, w hi ch i s avai l abl e at

http://w w w .mi crostrategy.com/freereporti ngsoftw are/.

l Separate response fi l es used to create a new metadata, connect

Intel l i gence Server to the new D SN , and create a new proj ect
source. These response fi l es can be created usi ng Mi croStrategy
C onfi gurati on Wi zard, as descri bed i n the Instal l ati on and
C onfi gurati on Gui de.

l Separate C ommand Manager scri pts used to create a database

i nstance, create a new proj ect, and connect the new proj ect to the
new database i nstance. These scri pts can be created usi ng

© 2019, M icr o St r at egy In c. 1120

Syst em Ad m in ist r at io n Gu id e

C ommand Manager, as descri bed i n C hapter 15, Automati ng

Admi ni strati ve Tasks w i th C ommand Manager.

Temp lat e: Up gr ad in g Micr o St r at egy Web , In clu d in g

Cu st o mizat io n s
The templ ate 0 3 U p g r a d e W e b W i t h C u s t o m i z a t i o n s . s m w can be
used to upgrade your Mi croStrategy Web envi ronment. Thi s upgrade
w orkfl ow al so supports i ncl udi ng any customi zati ons that you made to
your Mi croStrategy Web envi ronment. Thi s templ ate i ncl udes the
fol l ow i ng tasks:

l Stops the w eb appl i cati on server that hosts Mi croStrategy Web.

l C reates a backup copy of Mi croStrategy Web customi zati on fi l es.

l C reates a copy of the new w eb archi ve (.w ar) fi l e to depl oy the new
versi on of Mi croStrategy Web.

l R estarts the w eb appl i cati on server, w hi ch extracts the contents of

the .w ar fi l e.

l C opi es the Mi croStrategy Web customi zati on fi l es i nto the new l y

depl oyed envi ronment.

l Stops and then restarts the w eb appl i cati on server, w hi ch depl oys
the new Mi croStrategy Web envi ronment, i ncl udi ng any
customi zati ons.

Before usi ng thi s templ ate, be sure the fol l ow i ng prerequi si tes are
met:

l Access to any Mi croStrategy Web customi zati ons that are to be

appl i ed to the upgraded Mi croStrategy Web envi ronment. R evi ew
the Mi croStrategy Softw are D evel opment Li brary (MSD L) before
upgradi ng Mi croStrategy Web customi zati ons for i mportant
upgradi ng best practi ces i nformati on.

1121 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Access to the .w ar fi l e for the versi on of Mi croStrategy Web to

upgrade to.

l A fi l e used to start the w eb appl i cati on server. By defaul t, the

templ ate expects an Apache Tomcat w eb appl i cati on server. You
can sw ap i n a fi l e that starts your w eb appl i cati on server.

Temp lat e: Up gr ad in g a Met ad at a an d Execu t in g an In t egr it y

Test
The templ ate 0 4 U p g r a d e M e t a d a t a . s m w can be used to upgrade a
metadata and execute an i ntegri ty test after the upgrade i s compl ete.
Thi s templ ate i ncl udes the fol l ow i ng tasks:

l C reates a backup copy of the metadata. An emai l i s sent i f a backup

copy cannot be created.

l U pgrades the metadata. An emai l i s sent i f the upgrade i s not

compl eted successful l y. As part of a successful upgrade, the
backup fi l e i s compressed i nto a zi p fi l e, and the ori gi nal backup
fi l e i s del eted.

l Executes an Integri ty Manager basel i ne test on the upgraded

metadata.

Before usi ng thi s templ ate, be sure the fol l ow i ng prerequi si tes are
met:

l Access to the metadata, and a SQL statement that can be used to

create a copy of the metadata. By defaul t, the templ ate expects the
metadata to be stored i n a Mi crosoft SQL Server database. You can
change the suppl i ed SQL scri pt to refl ect the SQL syntax requi red
for the database management system that you use to store your
metadata.

© 2019, M icr o St r at egy In c. 1122

Syst em Ad m in ist r at io n Gu id e

l A response fi l e used to upgrade the metadata. Thi s response fi l e

can be created usi ng Mi croStrategy C onfi gurati on Wi zard, as
descri bed i n the Instal l ati on and C onfi gurati on Gui de.

l A test fi l e that defi nes how to perform the automated test of reports
and documents for the metadata. Thi s fi l e can be created usi ng
Integri ty Manager, as descri bed i n C reati ng an Integri ty Test, page
1276.

Temp lat e: Ret r ievin g t h e St at u s o f In t elligen ce Ser ver

The templ ate 0 5 I n t e l l i g e n c e S e r v e r A v a i l a b i l i t y . s m w can be
used to retri eve the status of Intel l i gence Server and start Intel l i gence
Server i f i t i s not operati onal . Thi s templ ate i ncl udes the fol l ow i ng
tasks:

l R etri eves the status of Intel l i gence Server.

l Attempts to start Intel l i gence Server i f i t i s not runni ng.

l Sends an emai l noti fi cati on that descri bes the success or fai l ure of
starti ng Intel l i gence Server.

Before usi ng thi s templ ate, be sure the fol l ow i ng prerequi si te i s met:

• Access to an Intel l i gence Server.

Temp lat e: Migr at in g Ob ject s Bet ween Two Pr o ject s an d

Execu t in g an In t egr it y Test
The templ ate 0 6 O b j e c t M i g r a t i o n . s m w can be used to mi grate
obj ects betw een tw o proj ects and execute an i ntegri ty test after the
obj ect mi grati on i s compl ete. Thi s templ ate can be used to mi grate a
proj ect from a testi ng envi ronment to a producti on envi ronment. Thi s
templ ate i ncl udes the fol l ow i ng tasks:

1123 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

This template is not prov ided if Sy s tem Manager is ins talled on a UNIX
or Linux env ironment.

l R etri eves the status of Intel l i gence Server and attempts to start
Intel l i gence Server i f i t i s not operati onal . If Intel l i gence Server
cannot be started, an emai l i s sent and the w orkfl ow i s ended.

l Merges tw o proj ects i nto a si ngl e proj ect.

l Appl i es an update package to the merged proj ect. An update

package i s a fi l e contai ni ng a set of obj ect defi ni ti ons and confl i ct
resol uti on rul es.

l R estarts Intel l i gence Server and executes an Integri ty Manager test

on the merged proj ect.

l Sends an emai l noti fi cati on i f any of the proj ect mi grati on steps
fai l s.

Before usi ng thi s templ ate, be sure the fol l ow i ng prerequi si tes are
met:

l A fi l e that defi nes how the dupl i cate proj ects are to be merged. Thi s
fi l e i s created usi ng the Proj ect Merge Wi zard. For steps on how to
create thi s confi gurati on fi l e, see Mergi ng Proj ects w i th the Proj ect
Merge Wi zard, page 469.

l An update package fi l e that defi nes how a proj ect i s to be

dupl i cated. Thi s fi l e i s created usi ng Mi croStrategy Obj ect Manager.
For steps on how to create thi s update package, see C opyi ng
Obj ects i n a Batch: U pdate Packages, page 443.

l A test fi l e that defi nes how to perform the automated test of reports
and documents for the proj ect. Thi s fi l e can be created usi ng
Integri ty Manager, as descri bed i n C reati ng an Integri ty Test, page
1276.

© 2019, M icr o St r at egy In c. 1124

Syst em Ad m in ist r at io n Gu id e

Temp lat e: In clu d in g a Clo u d -Based En vir o n men t t o In cr ease

In t elligen ce Ser ver Cap acit y
The templ ate 0 7 A d d I n t e l l i g e n c e S e r v e r C a p a c i t y . s m w can be
used to i ncl ude a cl oud-based envi ronment to i ncrease Intel l i gence
Server capaci ty. Thi s templ ate i ncl udes the fol l ow i ng tasks:

l Launches an Amazon EC 2 cl oud-based envi ronment, w hi ch can be

used to i ncrease Intel l i gence Server capaci ty.

l Ensures that Mi croStrategy Li stener i s runni ng, w hi ch i s requi red to

communi cate w i th Intel l i gence Server.

l Attempts to start Intel l i gence Server.

l Searches through a response fi l e used to create a proj ect source.

The Intel l i gence Server machi ne name i s modi fi ed to match the
machi ne name for the cl oud-based envi ronment.

l C reates a new proj ect source to connect to the cl oud-based

envi ronment.

l Searches through a C ommand Manager scri pt fi l e used to j oi n the

cl oud-based envi ronment to an Intel l i gence Server cl uster. The
Intel l i gence Server machi ne name i s modi fi ed to match the machi ne
name for the cl oud-based envi ronment.

l Joi ns the cl oud-based envi ronment to an Intel l i gence Server

cl uster.

l Sends an emai l noti fi cati on that descri bes the success of addi ng
the cl oud-based envi ronment to the Intel l i gence Server cl uster.

Before usi ng thi s templ ate, be sure the fol l ow i ng prerequi si tes are
met:

l Access to an Amazon EC 2 cl oud-based envi ronment, i ncl udi ng al l

rel evant support fi l es and i nformati on. R efer to your thi rd-party

1125 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Amazon EC 2 documentati on for i nformati on on the requi rements to

support a cl oud-based envi ronment.

l A response fi l e used to create a new proj ect source. Thi s response

fi l e can be created usi ng Mi croStrategy C onfi gurati on Wi zard, as
descri bed i n the Instal l ati on and C onfi gurati on Gui de.

l A C ommand Manager scri pt fi l e used to j oi n the cl oud-based

envi ronment to an Intel l i gence Server cl uster. Thi s scri pt can be
created usi ng C ommand Manager, as descri bed i n C reati ng and
Executi ng Scri pts, page 1250.

Temp lat e: Rest ar t in g In t elligen ce Ser ver

The templ ate 0 8 I n t e l l i g e n c e S e r v e r R e -S t a r t . s m w can be used
to restart Intel l i gence Server and noti fy users of the schedul ed restart.
Thi s templ ate i ncl udes the fol l ow i ng tasks:

l Sends an emai l to users as a w arni ng that Intel l i gence Server i s

about to be restarted.

l Attempts to restart Intel l i gence Server and determi nes the success
or fai l ure of the restart.

l Sends an emai l to ei ther the admi ni strator or the broader user

communi ty, dependi ng on w hether the restart w as successful .

Temp lat e: Up d at in g Pr o ject s wit h Mu lt ip le Up d at e Packages

The templ ate 0 9 M i g r a t e M u l t i p l e P a c a k g e s U s i n g L o o p . s m w can
be used to rol l back a recent update package for mul ti pl e proj ects as
w el l as appl y a new update package. Thi s templ ate al so serves as an
exampl e of successful l y usi ng l oops i n a System Manager w orkfl ow .
Thi s templ ate i ncl udes the fol l ow i ng tasks:

© 2019, M icr o St r at egy In c. 1126

Syst em Ad m in ist r at io n Gu id e

l D ow nl oads update package fi l es from an SFTP server.

l C reates a parameter that determi nes how many ti mes the l oop i n the
w orkfl ow has been compl eted. Thi s parameter i s used to choose the
correct update packages and to exi t the l oop i n the w orkfl ow at the
proper ti me.

l C hecks for al l requi red update package fi l es and undo package

fi l es.

l Sends an emai l to an admi ni strator i f some package fi l es are not

avai l abl e.

l Modi fi es a C ommand Manager scri pt to sel ect a di fferent undo

package and update package for each l oop through the w orkfl ow .

l C reates an undo package to rol l back changes that w ere made to a

proj ect usi ng an update package.

l C ompl etes the undo package to rol l back changes for the proj ect,
and then compl etes a new update package to update the obj ects for
the proj ect.

l Sends an emai l to an admi ni strator veri fyi ng that the updates to the
proj ect w ere compl eted.

l C onti nues to l oop through the w orkfl ow to do the same type of

updates for other proj ects, or ends the w orkfl ow after updati ng four
proj ects w i th these changes.

Before usi ng thi s templ ate, be sure the fol l ow i ng prerequi si tes are
met:

l U ndo package fi l es that defi ne how to rol l back the changes made
by an update package for a proj ect. Thi s fi l e i s created usi ng
Mi croStrategy Obj ect Manager. For steps on how to create thi s undo
package, see C opyi ng Obj ects i n a Batch: U pdate Packages, page
443.

1127 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l U pdate package fi l es that defi ne how a proj ect i s to be updated.

Thi s fi l e i s created usi ng Mi croStrategy Obj ect Manager. For steps
on how to create thi s update package, see C opyi ng Obj ects i n a
Batch: U pdate Packages, page 443.

l C ommand Manager scri pt fi l es that are used to create and

admi ni ster the undo package fi l es. These scri pt fi l es can be created
usi ng C ommand Manager, as descri bed i n C reati ng and Executi ng
Scri pts, page 1250.

Temp lat e: Pu b lish in g In t elligen t Cu b es an d Wo r kf lo w

Tr o u b lesh o o t in g
The templ ate 1 0 P u b l i s h C u b e s W i t h V a l i d a t i o n . s m w can be used
to publ i sh Intel l i gent C ubes, and as an exampl e of a w orkfl ow that
uses the D eci si on process to troubl eshoot the System Manager
w orkfl ow . Thi s templ ate i ncl udes the fol l ow i ng tasks:

l Empl oys an i terati ve retri eval process to retri eve i nformati on from a
text fi l e on the Intel l i gent C ubes to be publ i shed.

l U ses C ommand Manager scri pt fi l es to publ i sh Intel l i gent C ubes.

l U ses mul ti pl e D eci si on processes to determi ne the success or

fai l ure of publ i shi ng the Intel l i gent C ubes.

l Sends emai l s about the success or fai l ure of publ i shi ng the
Intel l i gent C ubes.

Before usi ng thi s templ ate, be sure the fol l ow i ng prerequi si tes are
met:

l A text fi l e that i ncl udes the i nformati on requi red to publ i sh the
Intel l i gent C ubes. Each l i ne of the fi l e must i ncl ude tw o col umns.
The fi rst col umn provi des the Intel l i gent C ube name, and the
second col umn provi des the ful l path to the C ommand Manager

© 2019, M icr o St r at egy In c. 1128

Syst em Ad m in ist r at io n Gu id e

scri pt fi l es used to publ i sh the Intel l i gent C ube.

l Tw o C ommand Manager scri pt fi l es used to publ i sh Intel l i gent

C ubes. These scri pt fi l es can be created usi ng C ommand Manager,
as descri bed i n C reati ng and Executi ng Scri pts, page 1250.

Temp lat e: Lau n ch in g Clo u d -Based En vir o n men t s in Par allel

The templ ate 1 1 P a r a l l e l E x e c u t i o n O f W o r k f l o w s . s m w can be
used to l aunch mul ti pl e cl oud-based envi ronments. It al so i s an
exampl e of usi ng paral l el executi on i n System Manager. Thi s
templ ate i ncl udes the fol l ow i ng tasks:

l U ses a spl i t executi on process to start tw o threads for the w orkfl ow

to perform paral l el processi ng.

l Launches tw o Amazon EC 2 cl oud-based envi ronments i n paral l el ,

w hi ch can be used to i ncrease Intel l i gence Server capaci ty.

l C hecks to see i f the cl oud-based envi ronments w ere l aunched

successful l y.

l Sends emai l s about the success or fai l ure of l aunchi ng the cl oud-
based envi ronments.

Before usi ng thi s templ ate, be sure the fol l ow i ng prerequi si te i s met:

• Access to an Amazon EC 2 cl oud-based envi ronment, i ncl udi ng al l

rel evant support fi l es and i nformati on. R efer to your thi rd-party
Amazon EC 2 documentati on for i nformati on on the requi rements to
support a cl oud-based envi ronment.

Temp lat e: Cr eat in g an d Sh ar in g Up d at e Packages

The templ ate 1 2 C r e a t e S h a r e P a c k a g e . s m w can be used to create
a proj ect update package and share that update package on an SFTP
server. Thi s templ ate i ncl udes the fol l ow i ng tasks:

1129 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l R etri eves the status of Intel l i gence Server.

l Attempts to start Intel l i gence Server i f i t i s not runni ng.

l U ses an .xml fi l e to create an update package.

l U pl oads the update package fi l e to an SFTP server.

l Sends an emai l noti fi cati on about the avai l abi l i ty of the update
package.

Before usi ng thi s templ ate, be sure the fol l ow i ng prerequi si tes are
met:

l Access to an Intel l i gence Server.

l Access to an SFTP server to store the update package.

l An .xml fi l e that can be used to create an update package.

l A text fi l e that i ncl udes a l i st of peopl e to noti fy about the

avai l abi l i ty of the new l y created update package.

Defining Processes
The tasks that are compl eted as part of a System Manager w orkfl ow
are determi ned by the processes that you i ncl ude. System Manager
provi des a set of Mi croStrategy and non-Mi croStrategy processes to
i ncl ude i n a w orkfl ow . These processes can be categori zed as
fol l ow s:

l C onfi guri ng Mi croStrategy C omponents, page 1131

l Managi ng Proj ects, page 1136

l Admi ni steri ng Intel l i gence Servers and other Mi croStrategy

Servi ces, page 1144

l Automati ng Admi ni strati ve Tasks, page 1147

l Veri fyi ng R eports and D ocuments, page 1152

© 2019, M icr o St r at egy In c. 1130

Syst em Ad m in ist r at io n Gu id e

l C reati ng D ata Source N ames, page 1157

l C ompl eti ng a Separate System Manager Workfl ow , page 1177

l Performi ng System Processes, page 1181

l Admi ni steri ng C l oud-Based Envi ronments, page 1208

System Manager w orkfl ow s often requi re i nformati on about the resul t

of a process to determi ne the next step to fol l ow i n the w orkfl ow . An
exi t code i s provi ded w hen a process i s compl eted that i s part of a
System Manager w orkfl ow . Thi s exi t code i ndi cates w hether the
process w as successful . For addi ti onal i nformati on on how to revi ew
the exi t codes for a process, see D etermi ni ng Process R esol uti on
U si ng Exi t C odes, page 1227.

Al though al l necessary confi gurati on i nformati on can be provi ded for

each process, some scenari os requi re that the detai l s about the
process be provi ded w hen the w orkfl ow i s executed. Parameters
provi de the fl exi bi l i ty of i ncl udi ng requi red confi gurati on i nformati on
w hen the w orkfl ow i s executed. For i nformati on on how parameters
can be used to provi de confi gurati on i nformati on for a process, see
U si ng Parameters for Processes, page 1228.

Configuring MicroStrategy Components

After i nstal l i ng Mi croStrategy, a few confi gurati ons need to be
compl eted to set up a Mi croStrategy envi ronment.

Cr eat in g Met ad at a, Hist o r y List , an d St at ist ics Rep o sit o r y

Tab les
You can create metadata, H i story Li st, and stati sti cs reposi tori es as
part of the process to confi gure a Mi croStrategy envi ronment.
R eposi tori es for your metadata, H i story Li st, and stati sti cs tabl es are
created i n the data source speci fi ed by the D SN s that you connect to.

1131 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

For background i nformati on on creati ng metadata, H i story Li st, and

stati sti cs reposi tori es, see the Instal l ati on and C onfi gurati on Gui de.

To perform these types of confi gurati ons, i n System Manager, from the
C onnectors and processes pane, add the C onfiguration Wizard
process to your w orkfl ow . The fol l ow i ng i nformati on i s requi red to
create metadata, H i story Li st, and stati sti cs reposi tori es:

Metadata, His tory Lis t, and s tatis tic s repos itories c an be part of the
s ame proc es s or inc luded in their own s eparate proc es s es in a Sy s tem
Manager work flow. Inc luding them as one proc es s allows y ou to do all
thes e c onfigurations in a s ingle proc es s . Howev er, inc luding them in
s eparate proc es s es allows y ou to find and fix errors s pec ific to eac h
s eparate ty pe of repos itory c onfiguration and perform eac h c onfiguration
at different s tages of the work flow.

l R esponse File: The Mi croStrategy C onfi gurati on Wi zard response

fi l e that defi nes how to create metadata, H i story Li st, and stati sti cs
reposi tori es. C l i ck the fol der i con to brow se to and sel ect a
response fi l e. For i nformati on on how to create a C onfi gurati on
Wi zard response fi l e, see the Instal l ati on and C onfi gurati on Gui de.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Co n f igu r in g In t elligen ce Ser ver

You can create, use, or del ete server defi ni ti ons that are used to
provi de a connecti on betw een Intel l i gence Server and your
Mi croStrategy metadata.

For background i nformati on on confi guri ng Intel l i gence Server, see

the Instal l ati on and C onfi gurati on Gui de.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the C onfiguration Wizard
process to your w orkfl ow . The fol l ow i ng i nformati on i s requi red to

© 2019, M icr o St r at egy In c. 1132

Syst em Ad m in ist r at io n Gu id e

create, use, or del ete server defi ni ti ons to confi gure Intel l i gence
Server:

l R esponse File: The Mi croStrategy C onfi gurati on Wi zard response

fi l e that defi nes how to confi gure Intel l i gence Server. C l i ck the
fol der i con to brow se to and sel ect a response fi l e. For i nformati on
on how to create a C onfi gurati on Wi zard response fi l e, see the
Instal l ati on and C onfi gurati on Gui de.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Cr eat in g Pr o ject So u r ces

You can create proj ect sources as part of your System Manager
w orkfl ow . A proj ect source contai ns the confi gurati on i nformati on that
each cl i ent system requi res to access an exi sti ng proj ect. It stores the
l ocati on of the metadata reposi tory and Intel l i gence Server that i s
used to run the proj ect. A proj ect source determi nes how D evel oper,
Mi croStrategy Web, and other cl i ent appl i cati ons access the
metadata.

For background i nformati on on creati ng proj ect sources, see the

Instal l ati on and C onfi gurati on Gui de.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the C onfiguration Wizard
process to your w orkfl ow . The fol l ow i ng i nformati on i s requi red to
create proj ect sources:

l R esponse File: The Mi croStrategy C onfi gurati on Wi zard response

fi l e that defi nes how to create proj ect sources. C l i ck the fol der i con
to brow se to and sel ect a response fi l e. For i nformati on on how to
create a C onfi gurati on Wi zard response fi l e, see the Instal l ati on
and C onfi gurati on Gui de.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

1133 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Up gr ad in g In t elligen ce Ser ver Co mp o n en t s an d Migr at in g

Hist o r y List Rep o sit o r ies
You can upgrade Intel l i gence Server components and mi grate your
H i story Li st from a fi l e-based system to a database-based system.
The Intel l i gence Server upgrade must be performed before any other
upgrade or mi grati on acti ons. For background i nformati on on
upgradi ng Mi croStrategy, see the U pgrade Gui de.

To perform these types of confi gurati ons, i n System Manager, from the
C onnectors and processes pane, add the C onfiguration Wizard
process to your w orkfl ow . The fol l ow i ng i nformati on i s requi red to
upgrade Intel l i gence Server components and mi grate H i story Li st
reposi tori es:

l R esponse File: The Mi croStrategy C onfi gurati on Wi zard response

fi l e that defi nes how to upgrade Intel l i gence Server components or
mi grate your H i story Li st from a fi l e-based system to a database-
based system. C l i ck the fol der i con to brow se to and sel ect a
response fi l e. For i nformati on on how to create a C onfi gurati on
Wi zard response fi l e, see the Instal l ati on and C onfi gurati on Gui de.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Up gr ad in g St at ist ics Rep o sit o r ies

You can upgrade the stati sti cs tabl es i n your stati sti cs reposi tory to
the new versi on of Mi croStrategy. Thi s stati sti cs tabl e upgrade
ensures that your Mi croStrategy Enterpri se Manager envi ronment can
benefi t from new features and enhancements i n the most recent
rel ease of Mi croStrategy.

You mus t perform an upgrade of y our Intelligenc e Serv er c omponents

before any other upgrade or migration ac tions .

© 2019, M icr o St r at egy In c. 1134

Syst em Ad m in ist r at io n Gu id e

For background i nformati on on upgradi ng stati sti cs reposi tori es, see
the U pgrade Gui de. For i nformati on on Enterpri se Manager, see the
Enterpri se Manager Gui de.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the C onfiguration Wizard
process to your w orkfl ow . The fol l ow i ng i nformati on i s requi red to
upgrade stati sti cs reposi tori es:

l R esponse File: The Mi croStrategy C onfi gurati on Wi zard response

fi l e that defi nes how to upgrade the stati sti cs tabl es i n your
stati sti cs reposi tory to the new versi on of Mi croStrategy. C l i ck the
fol der i con to brow se to and sel ect a response fi l e. For i nformati on
on how to create a C onfi gurati on Wi zard response fi l e, see
Instal l ati on and C onfi gurati on Gui de.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Migr at in g Nar r o wcast Ser ver Web Deliver y Su b scr ip t io n s t o

Micr o St r at egy Dist r ib u t io n Ser vices
You can mi grate Mi croStrategy w eb del i very subscri pti ons from a
N arrow cast Server envi ronment to D i stri buti on Servi ces.
Mi croStrategy w eb del i very subscri pti ons i ncl ude emai l , fi l e, FTP,
mobi l e, and pri nt subscri pti ons created from Mi croStrategy Web.
These subscri pti ons are created w hen a user i n Mi croStrategy Web
subscri bes to a report or document.

Mi grati ng these subscri pti ons from N arrow cast Server to D i stri buti on
Servi ces al l ow s the subscri pti ons to be central i zed w i thi n Intel l i gence
Server rather than a separate N arrow cast Server.

You mus t perform an upgrade of y our Intelligenc e Serv er c omponents

before any other upgrade or migration ac tions .

1135 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

For background i nformati on on mi grati ng N arrow cast w eb del i very

subscri pti ons to Mi croStrategy D i stri buti on Servi ces, see the U pgrade
Gui de. For i nformati on on confi guri ng and usi ng D i stri buti on Servi ces,
see C onfi guri ng and Admi ni steri ng D i stri buti on Servi ces, page 1008.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the C onfiguration Wizard
process to your w orkfl ow . The fol l ow i ng i nformati on i s requi red to
mi grate Mi croStrategy w eb del i very subscri pti ons from a N arrow cast
Server envi ronment to D i stri buti on Servi ces:

l R esponse File: The Mi croStrategy C onfi gurati on Wi zard response

fi l e that defi nes how to mi grate Mi croStrategy w eb del i very
subscri pti ons from a N arrow cast Server envi ronment to D i stri buti on
Servi ces. C l i ck the fol der i con to brow se to and sel ect a response
fi l e. For i nformati on on how to create a C onfi gurati on Wi zard
response fi l e, see Instal l ati on and C onfi gurati on Gui de.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Managing Projects
A Mi croStrategy busi ness i ntel l i gence appl i cati on consi sts of many
obj ects w i thi n proj ects. These obj ects are ul ti matel y used to create
reports and documents that di spl ay data to the end user. As i n other
softw are systems, these obj ects shoul d be devel oped and tested
before they can be used i n a producti on system. Once i n producti on,
proj ects need to be managed to account for new requi rements and
previ ousl y unforeseen ci rcumstances. Thi s process i s referred to as
the proj ect l i fe cycl e.

Wi th System Manager, you can i ncl ude these proj ect management
tasks i n a w orkfl ow . Thi s l ets you create, manage, and update your
proj ects si l entl y, w hi ch can be done duri ng off-peak hours and system
dow n ti mes. In performi ng proj ect mai ntenance i n thi s w ay, users of
the Mi croStrategy system are l ess affected by proj ect mai ntenance.

© 2019, M icr o St r at egy In c. 1136

Syst em Ad m in ist r at io n Gu id e

For background i nformati on on managi ng your proj ects, see C hapter

6, Managi ng Your Proj ects.

System Manager supports the fol l ow i ng proj ect creati on and

mai ntenance tasks:

l Mergi ng D upl i cate Proj ects to Synchroni ze Obj ects, page 1137

l D upl i cati ng Proj ects, page 1139

l Mi grati ng Proj ects to a N ew D atabase Pl atform, page 1140

l U pdati ng Proj ect Obj ects, page 1141

l C reati ng a Package to U pdate Proj ect Obj ects, page 1143

Mer gin g Du p licat e Pr o ject s t o Syn ch r o n ize Ob ject s

You can merge dupl i cate proj ects to synchroni ze many obj ects
betw een dupl i cate proj ects as part of a System Manager w orkfl ow .
Thi s process mi grates an enti re proj ect. Al l obj ects are copi ed to the
desti nati on proj ect. Any obj ects that are present i n the source proj ect
but not the desti nati on proj ect are created i n the desti nati on proj ect.

For background i nformati on on mergi ng dupl i cate proj ects, see

Mergi ng Proj ects to Synchroni ze Obj ects, page 467.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the Project Merge (Windows
Only) process to your w orkfl ow . The fol l ow i ng i nformati on i s requi red
to merge dupl i cate proj ects:

l Project Merge XML File: The fi l e that defi nes how the dupl i cate
proj ects are to be merged. Thi s fi l e i s created usi ng the Proj ect
Merge Wi zard. For steps on how to create thi s confi gurati on fi l e,
see Mergi ng Proj ects w i th the Proj ect Merge Wi zard, page 469.

1137 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

For the pas s word fields lis ted below, y ou c an us e the button to the
right of the pas s word fields to determine whether the pas s word
c harac ters are s hown or as teris k s are dis play ed ins tead.

l Source Project Source Password: The passw ord to access the

source proj ect source. The user name to access the source proj ect
source i s provi ded i n the confi gurati on fi l e created i n Proj ect Merge
Wi zard.

l D estination Project Source Password: The passw ord to access

the desti nati on proj ect source. The user name to access the
desti nati on proj ect source i s provi ded i n the confi gurati on fi l e
created i n Proj ect Merge Wi zard.

l Source Metadata Password: The passw ord to access the source

metadata. The user name to access the source metadata i s provi ded
i n the confi gurati on fi l e created i n Proj ect Merge Wi zard.

l D estination Metadata Password: The passw ord to access the

desti nati on metadata. The user name to access the desti nati on
metadata i s provi ded i n the confi gurati on fi l e created i n Proj ect
Merge Wi zard.

l U pdate the metadata if the metadata of the destination project is

older than the source project: Forces a metadata update of the
desti nati on metadata i f i t i s ol der than the source metadata and thi s
check box i s sel ected. The merge i s not executed unl ess the
desti nati on metadata i s the same versi on as or more recent than the
source metadata.

l U pdate the schema of the destination project at the end: If thi s

check box i s sel ected, the system updates the schema of the
desti nati on proj ect after the merge i s compl eted. Thi s update i s
requi red w hen you make any changes to schema obj ects such as
facts, attri butes, or hi erarchi es.

© 2019, M icr o St r at egy In c. 1138

Syst em Ad m in ist r at io n Gu id e

D o not use thi s opti on i f the confi gurati on fi l e contai ns an

i nstructi on to update the schema.

l Forcefully take over locks if any of the sessions are locked: If

thi s check box i s sel ected, the system takes ow nershi p of any
metadata l ocks that exi st on the source or desti nati on proj ects. If
thi s check box i s cl eared and sessi ons are l ocked, the proj ect
merge cannot be compl eted.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Du p licat in g Pr o ject s
You can dupl i cate proj ects as part of a System Manager w orkfl ow . If
you w ant to copy obj ects betw een tw o proj ects, Mi croStrategy
recommends that the proj ects have rel ated schemas. Thi s means that
one must have ori gi nal l y been a dupl i cate of the other, or both must
have been dupl i cates of a thi rd proj ect.

For background i nformati on on dupl i cati ng proj ects, see D upl i cati ng a
Proj ect, page 405.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the Project D uplication
(Windows Only) process to your w orkfl ow . The fol l ow i ng i nformati on
i s requi red to dupl i cate proj ects:

l XML C onfiguration File: The fi l e that defi nes how a proj ect i s to be
dupl i cated. Thi s fi l e i s created usi ng the Proj ect D upl i cati on
Wi zard. For steps on how to create thi s confi gurati on fi l e, see The
Proj ect D upl i cati on Wi zard, page 408.

l B ase Project Password: The passw ord for the source proj ect's
proj ect source. You can use the button to the ri ght of thi s passw ord
fi el d to determi ne w hether the passw ord characters are show n or
asteri sks are di spl ayed i nstead.

1139 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Target Project Password: The passw ord for the desti nati on
proj ect's proj ect source. You can use the button to the ri ght of thi s
passw ord fi el d to determi ne w hether the passw ord characters are
show n or asteri sks are di spl ayed i nstead.

l U pdate Target Metadata: If thi s check box i s sel ected, the system
forces a metadata update of the desti nati on metadata i f i t i s ol der
than the source metadata. The dupl i cati on i s not executed unl ess
the desti nati on metadata i s the same versi on as or more recent than
the source metadata.

l Overwrite the project name specified in the configuration file:

The new name to use for the desti nati on proj ect. Sel ect the check
box and type a new name to repl ace the name speci fi ed i n the XML
setti ngs fi l e.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Migr at in g Pr o ject s t o a New Dat ab ase Plat f o r m

You can mi grate, as part of a System Manager w orkfl ow , a
Mi croStrategy proj ect that i s stored i n a Mi crosoft Access database to
a new database pl atform. Thi s can be useful for creati ng and testi ng a
new proj ect before i t i s pl aced i n the producti on database.

To migrate a projec t to a new databas e platform, y ou mus t hav e the

By pas s All Objec t Sec urity Ac c es s Chec k s priv ilege for that projec t.

For background i nformati on on mi grati ng proj ects to a new database

pl atform, see Mi grati ng a Proj ect to a N ew D atabase Pl atform, page
411.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the Project Mover (Windows
Only) process to your w orkfl ow . The fol l ow i ng i nformati on i s requi red

© 2019, M icr o St r at egy In c. 1140

Syst em Ad m in ist r at io n Gu id e

to mi grate a Mi croStrategy proj ect stored i n a Mi crosoft Access

database to a new database pl atform:

l R esponse File: The Mi croStrategy Proj ect Mover response fi l e that

defi nes how to mi grate a Mi croStrategy proj ect stored i n a Mi crosoft
Access database to a new database pl atform as part of a System
Manager w orkfl ow . C l i ck the fol der i con to brow se to and sel ect a
response fi l e. For i nformati on on how to create a Proj ect Mover
response fi l e, see Mi grati ng a Proj ect to a N ew D atabase Pl atform,
page 411.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Up d at in g Pr o ject Ob ject s
You can use an update package as part of a System Manager
w orkfl ow . An update package i s a fi l e contai ni ng a set of obj ect
defi ni ti ons and confl i ct resol uti on rul es. It al l ow s you to save the
obj ects you w ant to copy i n an update package and i mport that
package i nto desti nati on proj ects l ater.

For background i nformati on on updati ng proj ects usi ng update

packages, see C opyi ng Obj ects i n a Batch: U pdate Packages, page
443.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the Import Package process to
your w orkfl ow . The fol l ow i ng i nformati on i s requi red to update a
proj ect usi ng an upgrade package:

l Project Source N ame: The name of the proj ect source that contai ns
the proj ect to update obj ects i n usi ng the update package.

l Login: The name of a val i d user to l og i n to the proj ect source.

l Password: The passw ord for the user name that you provi ded to l og
i n to the proj ect source. You can use the button to the ri ght of the

1141 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Passw ord fi el d to determi ne w hether the passw ord characters are

show n or asteri sks are di spl ayed i nstead.

l Package file: The update package fi l e that defi nes how a proj ect i s
to be dupl i cated. Thi s fi l e i s created usi ng Mi croStrategy Obj ect
Manager. For steps to create thi s update package, see C opyi ng
Obj ects i n a Batch: U pdate Packages, page 443.

If y ou are importing a pac k age that is s tored on a mac hine other than
the Intelligenc e Serv er mac hine, ens ure that the pac k age c an be
ac c es s ed by the Intelligenc e Serv er mac hine.

l D estination Project N ame: D etermi nes w hether the update

package i s a proj ect update package or a confi gurati on update
package:

l If the update package i s a proj ect update package, sel ect thi s
check box and type the name of the proj ect to update obj ects i n
usi ng the update package.

l If the update package i s a confi gurati on update package, cl ear

thi s check box.

l U se logging: If thi s check box i s sel ected, the system l ogs the
update package process. C l i ck the fol der i con to brow se to and
sel ect the fi l e to save the update package resul ts to. If thi s check
box i s cl eared, no l og i s created.

l Forcefully acquire locks: If thi s check box i s sel ected, the system
takes ow nershi p of any l ocks that exi st. If thi s check box i s cl eared
and sessi ons are l ocked, the update package cannot be compl eted.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

© 2019, M icr o St r at egy In c. 1142

Syst em Ad m in ist r at io n Gu id e

Cr eat in g a Package t o Up d at e Pr o ject Ob ject s

You can create an update package as part of a System Manager
w orkfl ow . An update package i s a fi l e contai ni ng a set of obj ect
defi ni ti ons and confl i ct resol uti on rul es. It al l ow s you to save the
obj ects you w ant to copy i n an update package, and i mport that
package i nto any number of desti nati on proj ects at a l ater date.

For background i nformati on on creati ng update packages, see

C opyi ng Obj ects i n a Batch: U pdate Packages, page 443.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the C reate Package process to
your w orkfl ow . The fol l ow i ng i nformati on i s requi red to create an
upgrade package:

l Package XML File: The .xml fi l e that contai ns the defi ni ti on to

create a package fi l e. You can use Obj ect Manager to create thi s
.xml fi l e, as descri bed i n C opyi ng Obj ects i n a Batch: U pdate
Packages, page 443.

l Source Project Source Password: The passw ord for the user
account you used to create the package .xml fi l e. Thi s
authenti cati on i nformati on i s used to l og i n to the proj ect source.
You can use the button to the ri ght of the passw ord fi el d to
determi ne w hether the passw ord characters are show n or asteri sks
are di spl ayed i nstead.

l Source Metadata Password: The passw ord for the user account
you used to create the package .xml fi l e. Thi s authenti cati on
i nformati on i s used to l og i n to the proj ect metadata. You can use
the button to the ri ght of the passw ord fi el d to determi ne w hether
the passw ord characters are show n or asteri sks are di spl ayed
i nstead.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

1143 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Administering Intelligence Servers and other

MicroStrategy Services
Intel l i gence Server and other Mi croStrategy servi ces must be
operati onal to compl ete certai n processes that are part of a System
Manager w orkfl ow . To support thi s requi rement, you can i ncl ude the
admi ni strati on of Intel l i gence Server and other Mi croStrategy servi ces
as part of a w orkfl ow .

St ar t in g, St o p p in g, o r Rest ar t in g Micr o St r at egy Ser vices

You can start, stop, or restart Mi croStrategy servi ces as part of a
System Manager w orkfl ow . Thi s hel ps to ensure Intel l i gence Server i s
operati onal , w hi ch i s requi red to perform vari ous processes. You can
al so stop Intel l i gence Server to make system-w i de updates and then
restart Intel l i gence Server once al l updates are made.

To perform these types of confi gurati on, i n System Manager, from the
C onnectors and processes pane, add the Manage MicroStrategy
Service process to your w orkfl ow . The fol l ow i ng i nformati on i s
requi red to start, stop, or restart a Mi croStrategy servi ce:

l A ction: D etermi nes w hether to start, stop, or restart the

Mi croStrategy servi ce. Sel ect the requi red acti on from thi s drop-
dow n l i st.

l You can determi ne w hi ch machi ne to admi ni ster i ts servi ces for

usi ng one of the fol l ow i ng opti ons:

l Local machine: Thi s opti on performs the start, stop, or restart

acti on for the servi ce of the machi ne used to depl oy the w orkfl ow .

l R emote machine: Thi s opti on l ets you speci fy the machi ne that
hosts the servi ce to perform the start, stop, or restart acti on for.
You must provi de the i nformati on l i sted bel ow :

© 2019, M icr o St r at egy In c. 1144

Syst em Ad m in ist r at io n Gu id e

l Machine N ame: The name of the machi ne that hosts the

servi ce.

l Login: The name of a val i d user to admi ni ster the servi ce.

l Password: The passw ord for the user name that you provi ded to
admi ni ster the servi ce. You can use the button to the ri ght of the
Passw ord fi el d to determi ne w hether the passw ord characters
are show n or asteri sks are di spl ayed i nstead.

• Service Type: D etermi nes the servi ce to start, stop, or restart.

From thi s drop-dow n l i st, you can sel ect one of the fol l ow i ng
Mi croStrategy servi ces:

▫ MicroStrategy Intelligence Server: The mai n servi ce for your

Mi croStrategy reporti ng envi ronment. It provi des the
authenti cati on, cl usteri ng, governi ng, and other admi ni strati ve
management requi rements for your Mi croStrategy reporti ng
envi ronment.

▫ MicroStrategy Listener: Al so know n as Test Li stener. A pi ng

uti l i ty that al l ow s you to check the avai l abi l i ty of an Intel l i gence
Server on your netw ork, w hether a D SN can connect to a
database, and w hether a proj ect source name can connect to a
proj ect source. From any machi ne that has the Test Li stener
i nstal l ed and operati onal , you can get i nformati on about other
Mi croStrategy servi ces avai l abl e on the netw ork w i thout havi ng
to actual l y go to each machi ne.

▫ MicroStrategy Enterprise Manager D ata Loader: The servi ce

for Enterpri se Manager that retri eves data for the proj ects for
w hi ch stati sti cs are bei ng l ogged. Thi s data i s then l oaded i nto
the Enterpri se Manager l ookup tabl es for further Enterpri se
Manager reporti ng and anal ysi s.

1145 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

▫ MicroStrategy D istribution Manager: The servi ce for

N arrow cast Server that di stri butes subscri pti on processi ng
across avai l abl e Executi on Engi nes.

▫ MicroStrategy Execution Engine: The servi ce for N arrow cast

Server that gathers, formats, and del i vers the content to the
devi ces for a subscri pti on.

▫ N otes: Informati on to descri be thi s process as part of the

w orkfl ow .

Det er min in g t h e St at u s o f Micr o St r at egy Ser vices

You can retri eve the status of a Mi croStrategy servi ce as part of a
System Manager w orkfl ow . Thi s can hel p to ensure that requi red
Mi croStrategy servi ces are operati onal , w hi ch can be requi red to
perform vari ous processes.

To retri eve thi s i nformati on, i n System Manager, from the C onnectors
and processes pane, add the Get Service Status process to your
w orkfl ow . The fol l ow i ng i nformati on i s requi red to retri eve the status
of a Mi croStrategy servi ce:

You can determi ne the machi ne for w hi ch to retri eve the servi ce
status by usi ng one of the fol l ow i ng opti ons:

l Local machine: R etri eves the status for the servi ce of the machi ne
used to depl oy the w orkfl ow .

l R emote machine: Lets you speci fy the machi ne that hosts the
servi ce to retri eve the status for the servi ce. If you sel ect thi s
opti on, you must type the name of the machi ne that hosts the
servi ce.

• Service Type: D etermi nes the servi ce to start, stop, or restart.

From thi s drop-dow n l i st, you can sel ect one of the fol l ow i ng
Mi croStrategy servi ces:

© 2019, M icr o St r at egy In c. 1146

Syst em Ad m in ist r at io n Gu id e

▫ MicroStrategy Intelligence Server: The mai n servi ce for your

Mi croStrategy reporti ng envi ronment. It provi des the
authenti cati on, cl usteri ng, governi ng, and other admi ni strati ve
management requi rements for your Mi croStrategy reporti ng
envi ronment.

▫ MicroStrategy Listener: Al so know n as Test Li stener. A pi ng

uti l i ty that al l ow s you to check the avai l abi l i ty of an Intel l i gence
Server on your netw ork, w hether a D SN can connect to a
database, and w hether a proj ect source name can connect to a
proj ect source. From any machi ne that has the Test Li stener
i nstal l ed and operati onal , you can get i nformati on about other
Mi croStrategy servi ces avai l abl e on the netw ork w i thout havi ng
to actual l y go to each machi ne.

▫ MicroStrategy Enterprise Manager D ata Loader: The servi ce

for Enterpri se Manager that retri eves data for the proj ects for
w hi ch stati sti cs are bei ng l ogged. Thi s data i s then l oaded i nto
the Enterpri se Manager l ookup tabl es for further Enterpri se
Manager reporti ng and anal ysi s.

▫ MicroStrategy D istribution Manager: The servi ce for

N arrow cast Server that di stri butes subscri pti on processi ng
across avai l abl e Executi on Engi nes.

▫ MicroStrategy Execution Engine: The servi ce for N arrow cast

Server that gathers, formats, and del i vers the content to the
devi ces for a subscri pti on.

▫ N otes: Informati on to descri be thi s process as part of the

w orkfl ow .

Automating Administrative Tasks

You can perform vari ous admi ni strati ve and appl i cati on devel opment
tasks by usi ng text commands that can be saved as scri pts or entered

1147 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

as commands to be compl eted as part of a System Manager w orkfl ow .

These scri pts and commands are created usi ng C ommand Manager.

For an i ntroducti on to C ommand Manager, see C hapter 15,

Automati ng Admi ni strati ve Tasks w i th C ommand Manager.

Man agin g Co n f igu r at io n s f o r Pr o ject So u r ces

You can use text commands as part of a System Manager w orkfl ow as
a scri pt or entered di rectl y as statements, to add, del ete, or update
l arge numbers of users and user groups, as w el l as manage vari ous
confi gurati on setti ngs for proj ect sources.

For an i ntroducti on to C ommand Manager, see C hapter 15,

Automati ng Admi ni strati ve Tasks w i th C ommand Manager.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and Processes pane, add the Intelligence Server
process to your w orkfl ow . The fol l ow i ng i nformati on i s requi red to
execute a C ommand Manager scri pt or statements:

l C onnection Information: D etermi nes w hether to use a connecti on-

l ess sessi on or to connect di rectl y to a proj ect source:

l C onnection-less Session: D efi nes the scri pt executi on as a

connecti on-l ess sessi on, w hi ch means a connecti on i s not
i mmedi atel y made to a proj ect source. A connecti on i s requi red to
perform any tasks i ncl uded i n the commands. You can use thi s
opti on w hen the C ommand Manager statements i ncl ude the
requi red connecti on i nformati on.

l C onnect To A Project Source: D efi nes the proj ect source to

connect to for the statement executi on. Provi de the fol l ow i ng
i nformati on:

© 2019, M icr o St r at egy In c. 1148

Syst em Ad m in ist r at io n Gu id e

l Project Source: The name of the proj ect source to connect to.

l Login: The name of a val i d user to connect to the proj ect

source.

l Password: The passw ord for the user name that you provi ded to
connect to the proj ect source. U se the button to the ri ght of the
Passw ord fi el d to determi ne w hether the passw ord characters
are show n or asteri sks are di spl ayed i nstead.

Mic roStrategy does not rec ommend us ing quotation mark s in y our
pas s words . If y ou are running Mic roStrategy in Windows and y our
pas s word c ontains one or more quotation mark s ("), y ou mus t
replac e them with two quotation mark s ("") and enc los e the entire
pas s word in quotes . For ex ample, if y our pas s word is 1"2"3'4'5, y ou
mus t enter the pas s word as "1""2""3'4'5".

l Execution: C hoose w hether the C ommand Manager statements to

run are i n a scri pt fi l e or the ones that you enter here:

l Script File (.scp): Brow se to and sel ect the C ommand Manager
scri pt fi l e that defi nes al l the tasks to be compl eted.

l Execute script statements: Type i n the C ommand Manager

statement or statements to be compl eted.

l Export R esults To an XML File: If sel ected, the system l ogs the
executi on resul ts, error messages, and status messages to a si ngl e
XML fi l e. C l i ck the fol der i con to brow se to and sel ect an XML fi l e.

l D isplay Output On The C onsole: If sel ected and the scri pt i s not
encrypted, the system di spl ays the resul ts on the command l i ne
used to execute the scri pt or statements.

l Stop Script Execution On Error: If executi on causes a cri ti cal

error and thi s check box i s sel ected, the system termi nates the

1149 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

executi on. C l ear thi s check box to al l ow the executi on to conti nue
even i f cri ti cal errors are encountered.

l Suppress H idden Object(s) In The R esults: If thi s check box i s

sel ected, the system omi ts hi dden obj ects i n the executi on resul ts.
H i dden obj ects are Mi croStrategy metadata obj ects w hose H I D D E N
property i s set as true.

l Logging Information: D efi nes how the resul ts of runni ng the

C ommand Manager scri pt or statements are l ogged. Sel ect one of
the fol l ow i ng opti ons:

l Log Output To D efault Location: Logs al l resul ts to the defaul t

fol der.

l Log Output To Specified File: Logs al l resul ts to the l og fi l e

speci fi ed. You can brow se to and sel ect a l og fi l e.

l Split Output Into Three D efaults (R esults, Failure, and

Success): Logs al l resul ts to three separate l og fi l es. The defaul t
l og fi l es are C m d M g rR e s u l t s . l o g, C m d M g r F a i l . l o g, and
Cm dM gr Su c c e s s . lo g, respecti vel y.

l Split Output Into Three Specified Files: Logs al l resul ts of

executi on to three separate l og fi l es that you choose:

l R esults File: Incl udes any i nformati on provi ded by successful

LIST statements that w ere executed.

l Failure File: Incl udes a l i st of statements that w ere not

executed successful l y.

l Success File: Incl udes a l i st of statements that w ere executed

successful l y.

l Include Instructions In The Log File(s): If sel ected, the system

i ncl udes the statements i n the l og fi l e or fi l es.

© 2019, M icr o St r at egy In c. 115 0

Syst em Ad m in ist r at io n Gu id e

l Include File Log H eader: If sel ected, the system i ncl udes a
header at the begi nni ng of each l og fi l e that contai ns i nformati on
such as the versi on of C ommand Manager used.

l Include Error C odes in the Log File(s): If sel ected, the system
i ncl udes any error codes returned duri ng the w orkfl ow i n the l og
fi l e or fi l es.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Man agin g Co n f igu r at io n s f o r Pr o ject So u r ces Usin g

Co mman d Man ager Ru n t ime St at emen t s
D evel opers of OEM appl i cati ons that use embedded Mi croStrategy
proj ects may need fl exi bi l i ty i n confi guri ng thei r envi ronment.
C ommand Manager R unti me i s a sl i mmed-dow n versi on of the
C ommand Manager command-l i ne executabl e for use w i th these OEM
appl i cati ons.

C ommand Manager R unti me uses a subset of the commands that are

avai l abl e i n the ful l versi on of C ommand Manager. C ommand
Manager R unti me statements can be i ncl uded i n a System Manager
w orkfl ow as a scri pt or as statements entered i n the w orkfl ow .

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and Processes pane, add the Intelligence Server
(R untime) process to your w orkfl ow . The i nformati on requi red to
execute a C ommand Manager scri pt or statements i s the same
i nformati on requi red for a standard C ommand Manager scri pt or
statements, w hi ch i s descri bed i n Managi ng C onfi gurati ons for Proj ect
Sources, page 1148. If you try to execute statements that are not
avai l abl e i n C ommand Manager R unti me as part of a System Manager
w orkfl ow , the scri pt or statements fai l w i th an exi t code of 12.

115 1 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Man agin g Co n f igu r at io n s f o r Nar r o wcast Ser ver Met ad at as

Mi croStrategy C ommand Manager l ets you manage vari ous
confi gurati on setti ngs w i thi n the Mi croStrategy pl atform, for
N arrow cast Servers.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the N arrowcast Server
(Windows Only) process to your w orkfl ow . The i nformati on requi red
to execute a C ommand Manager scri pt or statements used to manage
N arrow cast Servers i ncl udes the same i nformati on requi red for
C ommand Manager scri pt or statements used to manage proj ect
sources, w hi ch i s descri bed i n Admi ni steri ng C l oud-Based
Envi ronments, page 1208. In addi ti on to thi s requi red i nformati on,
C ommand Manager scri pts or statements used to manage N arrow cast
Servers al so requi re the fol l ow i ng i nformati on:

l D SN : The data source name that poi nts to the database that stores
the N arrow cast Server reposi tory. If the D SN requi res speci fi c
permi ssi ons, sel ect the A uthentication for D SN check box to
provi de a val i d user name and passw ord.

l D atabase: The database that stores the N arrow cast Server

reposi tory. Type the name of the database that resi des i n the D SN
you speci fi ed i n the D SN fi el d. The D SN fi el d i s part of the opti ons
descri bed i n Admi ni steri ng C l oud-Based Envi ronments, page 1208.

l System Prefix: The database prefi x used to i denti fy the N arrow cast
Server reposi tory.

Verifying Reports and Documents

You can run automated tests to determi ne how speci fi c changes i n a
proj ect envi ronment, such as the regul ar mai ntenance changes to
metadata obj ects or hardw are and softw are upgrades, affect the
reports and documents i n that proj ect as part of a System Manager
w orkfl ow . These types of test can ensure that reports and documents

© 2019, M icr o St r at egy In c. 115 2

Syst em Ad m in ist r at io n Gu id e

are w orki ng as i ntended, as w el l as determi ni ng the performance of

any new or updated Mi croStrategy depl oyments.

For background i nformati on on runni ng automated tests of reports and

documents usi ng Mi croStrategy Integri ty Manager, see C hapter 16,
Veri fyi ng R eports and D ocuments w i th Integri ty Manager.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the Integrity Manager process
to your w orkfl ow . The fol l ow i ng i nformati on i s requi red to run an
automated test of reports and documents:

l MTC C onfiguration File: The test fi l e that defi nes how to perform
the automated test of reports and documents. Thi s fi l e i s created
usi ng Integri ty Manager. For steps on how to create thi s test fi l e,
see C reati ng an Integri ty Test, page 1276.

l B ase Project Password: The passw ord for the user speci fi ed i n the
test fi l e to l og i n to the base proj ect. Thi s i s not requi red for a
basel i ne-versus-proj ect or basel i ne-versus-basel i ne i ntegri ty test.
You can use the button to the ri ght of thi s passw ord fi el d to
determi ne w hether the passw ord characters are show n or asteri sks
are di spl ayed i nstead. R efer to Speci fyi ng Passw ords for Mul ti pl e
U ser Accounts and Speci al C haracters, page 1155 bel ow for
i nformati on on provi di ng mul ti pl e passw ords or passw ords that use
speci al characters for an Integri ty Manager test.

l Target Project Password: The passw ord for the user speci fi ed i n
the test fi l e to l og i n to the desti nati on proj ect. Thi s i s not requi red
for a si ngl e-proj ect or basel i ne-versus-basel i ne i ntegri ty test. You
can use the button to the ri ght of thi s passw ord fi el d to determi ne
w hether the passw ord characters are show n or asteri sks are
di spl ayed i nstead. R efer to Speci fyi ng Passw ords for Mul ti pl e U ser
Accounts and Speci al C haracters, page 1155 bel ow for i nformati on
on provi di ng mul ti pl e passw ords or passw ords that use speci al
characters for an Integri ty Manager test.

115 3 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

You can use the fol l ow i ng parameters to provi de al ternati ve test

i nformati on and detai l s w hen runni ng an Integri ty Manager test as part
of a w orkfl ow . Al l parameters are opti onal , and i f you cl ear the check
box for a parameter l i sted bel ow , any requi red i nformati on for that
parameter i s provi ded by the Integri ty Manager test fi l e i nstead:

l Output D irectory: The di rectory for any resul ts. C l i ck the fol der
i con to brow se to and sel ect an output di rectory.

l Log File: C l i ck the fol der i con to brow se to and sel ect a l og fi l e
di rectory.

l B ase B aseline File: C l i ck the fol der i con to brow se to and sel ect a
basel i ne fi l e for the base proj ect.

l Target B aseline File: C l i ck the fol der i con to brow se to and sel ect
a basel i ne fi l e for the target proj ect.

l B ase Server N ame: The name of the machi ne that i s runni ng the
Intel l i gence Server that hosts the base proj ect for the test.

l B ase Server Port: The port that Intel l i gence Server i s usi ng. The
defaul t port i s 34952.

l Target Server N ame: The name of the machi ne that i s runni ng the
Intel l i gence Server that hosts the target proj ect for the test.

l Target Server Port: The port that Intel l i gence Server i s usi ng. The
defaul t port i s 34952.

l B ase Project N ame: The name of the base proj ect for the test.

l Login(s) for B ase Project: The l ogi n accounts requi red to run any
reports or documents i n the base proj ect for the test. For mul ti pl e
l ogi ns, encl ose al l l ogi ns i n doubl e quotes (" ") and separate each
l ogi n w i th a comma (, ).

l Target Project N ame: The name of the target proj ect for the test.

© 2019, M icr o St r at egy In c. 115 4

Syst em Ad m in ist r at io n Gu id e

l Login(s) for Target Project: The l ogi n accounts requi red to run any
reports or documents i n the base proj ect for the test. For mul ti pl e
l ogi ns, encl ose al l l ogi ns i n doubl e quotes (" ") and separate each
l ogi n w i th a comma (, ).

l Test Folder GU ID : The GU ID of the test fol der. If thi s opti on i s

used, the reports and documents speci fi ed i n the Integri ty Manager
test fi l e are i gnored. Instead, Integri ty Manager executes al l reports
and documents i n the speci fi ed fol der.

This option c an only be us ed with a s ingle-projec t integrity tes t or a

projec t-v ers us -projec t integrity tes t.

l Load B alancing for B ase Server: D etermi nes w hether to use l oad
bal anci ng for the base server. If thi s opti on i s used, i t overri des the
setti ng i n the Integri ty Manager test fi l e.

l Load B alancing for Target Server: D etermi nes w hether to use

l oad bal anci ng for the target server. If thi s opti on i s used, i t
overri des the setti ng i n the Integri ty Manager test fi l e.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Sp ecif yin g Passwo r d s f o r Mu lt ip le User Acco u n t s an d

Sp ecial Ch ar act er s
An Integri ty Manager test can i ncl ude mul ti pl e user accounts as part
of the test, as w el l as user accounts that i ncl ude speci al characters i n
thei r passw ords.

To use mul ti pl e user accounts for testi ng, the passw ords associ ated
w i th each user account must al so be provi ded. If your Integri ty
Manager test i ncl udes mul ti pl e user accounts, use the fol l ow i ng rul es
to provi de any requi red passw ords for the base proj ect and target
proj ect:

115 5 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l You must i ncl ude a passw ord for each user account defi ned i n the
Integri ty Manager test confi gurati on fi l e. H ow ever, i f al l user
accounts use a bl ank passw ord, you can l eave the base proj ect and
target proj ect passw ord fi el ds bl ank to i ndi cate that a bl ank
passw ord i s used for each user account.

l Encl ose the ful l l i st of passw ords i n doubl e quotes (").

l Separate each passw ord usi ng a comma (,).

l The passw ords must be l i sted i n the order that user accounts are
defi ned i n the Integri ty Manager test. U se Integri ty Manager to
revi ew the test fi l e as requi red to determi ne the proper order.

l If a subset of user accounts use bl ank passw ords, use a space to

i ndi cate a bl ank passw ord. For exampl e, i f the second user account
i ncl uded i n an Integri ty Manager test has a bl ank passw ord, you can
defi ne the passw ord l i st as:
"password1, ,password3"

An Integri ty Manager test can i ncl ude user accounts that i ncl ude
speci al characters i n thei r passw ords. U se the fol l ow i ng rul es to
denote speci al characters i n passw ords for the base proj ect and
target proj ect:

l If a passw ord i ncl udes a si ngl e quote (') or comma (, ), you must
encl ose the enti re passw ord i n si ngl e quotes. For exampl e, for the
passw ord s e c , r e t, you must type thi s passw ord as ' s e c , r e t '.

l To denote a si ngl e quote (') i n a passw ord, use tw o si ngl e quotes.

For exampl e, for the passw ord s e c ' r e t, you must type thi s
passw ord as ' s e c ' ' r e t '.

l To denote a doubl e quote (") i n a passw ord, type & q u o t ;. For

exampl e, for the passw ord s e c " r e t, you must type thi s passw ord
as s ec &q uo t ; r e t.

© 2019, M icr o St r at egy In c. 115 6

Syst em Ad m in ist r at io n Gu id e

l To denote an ampersand (& ) i n a passw ord, type & a m p ;. For

exampl e, for the passw ord s e c & r e t, you must type thi s passw ord
as s ec &a mp ; r e t.

Creating Data Source Names

Establ i shi ng communi cati on betw een Mi croStrategy and your
databases or other data sources i s an essenti al step i n confi guri ng
Mi croStrategy products for reporti ng and anal ysi s of your data. A data
source name (D SN ) al l ow s Mi croStrategy to connect and
communi cate to your data sources. For background i nformati on on
creati ng and supporti ng D SN s, see the Instal l ati on and C onfi gurati on
Gui de.

System Manager al l ow s you to create D SN s for the fol l ow i ng types of

databases:

l D B2 U D B, page 1158

l U D B i Seri es/D B2 for i , page 1159

l D B2 z/OS , page 1160

l Greenpl um, page 1162

l H i ve, page 1163

l Informi x, page 1164

l Informi x XPS , page 1165

l Mi crosoft SQL Server, page 1166

l MySQL, page 1170

l Oracl e, page 1171

l PostgreSQL, page 1174

l Sal esforce, page 1175

l Sybase ASE, page 1176

115 7 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

C reati ng a D SN usi ng System Manager can be successful or

unsuccessful for vari ous reasons, w hi ch are denoted usi ng exi t
codes. For i nformati on on determi ni ng the possi bl e exi t codes of
creati ng a D SN usi ng System Manager, see D etermi ni ng Process
R esol uti on U si ng Exi t C odes, page 1227.

DB2 UDB
To perform thi s confi gurati on, i n System Manager, from the
C onnectors and processes pane, add the D B 2 U D B process to your
w orkfl ow . The fol l ow i ng i nformati on i s requi red to create a D SN for
D B2 U D B w hen runni ng agai nst D B2:

l D ata Source N ame: A name to i denti fy the D B2 U D B data source

confi gurati on i n Mi croStrategy. For exampl e, Fi nance or D B2-Serv1
can serve to i denti fy the connecti on.

l IP A ddress: The IP address or name of the machi ne that runs the

D B2 U D B server.

l TC P Port: The D B2 U D B server l i stener's port number. In most

cases, the defaul t port number i s 50000, but you shoul d check w i th
your database admi ni strator for the correct number.

l D atabase N ame: The name of the database to connect to by

defaul t, w hi ch i s assi gned by the database admi ni strator.

l Overwrite: If thi s check box i s sel ected, the system updates a D SN

w i th the same name w i th the i nformati on provi ded bel ow . If thi s
check box i s cl eared and a D SN w i th the same name exi sts on the
system, no D SN i s created, and the D SN i s not updated.

l Test C onnection: If thi s check box i s sel ected, the system tests the
D SN i nformati on provi ded to determi ne i f a successful connecti on
can be made. If thi s check box i s cl eared, no connecti on test i s
performed. If thi s check box i s sel ected, you must provi de the

© 2019, M icr o St r at egy In c. 115 8

Syst em Ad m in ist r at io n Gu id e

fol l ow i ng connecti on i nformati on:

l U sername: The name of a val i d user for the database.

l Password: The passw ord for the user name that you provi ded to
connect to the database. You can use the button to the ri ght of the
Passw ord fi el d to determi ne w hether the passw ord characters are
show n or asteri sks are di spl ayed i nstead.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

UDB iSer ies/ DB2 f o r i

To perform thi s confi gurati on, i n System Manager, from the
C onnectors and processes pane, add the D B 2 U D B iSeries process
to your w orkfl ow . The fol l ow i ng i nformati on i s requi red to create a
D SN for U D B i Seri es/D B2 for i :

l D ata Source N ame: A name to i denti fy the D B2 for i data source

confi gurati on i n Mi croStrategy. For exampl e, Fi nance or D B2fori -1
can serve to i denti fy the connecti on.

l IP A ddress: The IP Address of the machi ne w here the catal og

tabl es are stored. Thi s can be ei ther a numeri c address, such as
12 3. 45 6. 7 8 9 . 9 8, or a host name. If you use a host name, i t must
be i n the HO S T S fi l e of the machi ne or a D N S server.

l C ollection: The name that i denti fi es a l ogi cal group of database

obj ects.

l Location: The D B2 l ocati on name, w hi ch i s defi ned duri ng the l ocal

D B2 i nstal l ati on.

l Isolation Level: The method by w hi ch l ocks are acqui red and

rel eased by the system.

115 9 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Package Owner: The package's AuthID i f you w ant to speci fy a

fi xed user to create and modi fy the packages on the database. The
AuthID must have authori ty to execute al l the SQL i n the package.

l TC P Port: The D B2 D R D A l i stener process's port number on the

server host machi ne provi ded by your database admi ni strator. The
defaul t port number i s usual l y 446.

l Overwrite: If thi s check box i s sel ected, the system updates a D SN

w i th the same name w i th the i nformati on provi ded bel ow . If thi s
check box i s cl eared and a D SN w i th the same name exi sts on the
system, no D SN i s created, and the D SN i s not updated.

l Test C onnection: Tests the D SN i nformati on provi ded to determi ne

i f a successful connecti on can be made. If thi s check box i s cl eared,
no connecti on test i s performed. If thi s check box i s sel ected, you
must provi de the fol l ow i ng connecti on i nformati on:

l U sername: The name of a val i d user for the database.

l Password: The passw ord for the user name that you provi ded to
connect to the database. You can use the button to the ri ght of the
Passw ord fi el d to determi ne w hether the passw ord characters are
show n or asteri sks are di spl ayed i nstead.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

DB2 z/ OS
To perform thi s confi gurati on, i n System Manager, from the
C onnectors and processes pane, add the D B 2 z/OS process to your
w orkfl ow . The fol l ow i ng i nformati on i s requi red to create a D SN for
D B2 z/OS:

l D ata Source N ame: A name to i denti fy the D B2 z/OS data source

confi gurati on i n Mi croStrategy. For exampl e, Fi nance or

© 2019, M icr o St r at egy In c. 1160

Syst em Ad m in ist r at io n Gu id e

D B2U D Bz/OS-1 can serve to i denti fy the connecti on.

l IP A ddress: The IP Address of the machi ne w here the catal og

tabl es are stored. Thi s can be ei ther a numeri c address such as
12 3. 45 6. 7 8 9 . 9 8, or a host name. If you use a host name, i t must
be i n the HO S T S fi l e of the machi ne or a D N S server.

l C ollection: The name that i denti fi es a l ogi cal group of database

obj ects, w hi ch i s al so the current schema. On D B2 z/OS, the user ID
shoul d be used as the C ol l ecti on.

l Location: The D B2 z/OS l ocati on name, w hi ch i s defi ned duri ng the

l ocal D B2 z/OS i nstal l ati on. To determi ne the D B2 l ocati on, you can
run the command D I S P L A Y D D F.

l Package C ollection: The col l ecti on or l ocati on name w here bi nd

packages are created and stored for searchi ng purposes.

l Package Owner: The package's AuthID i f you w ant to speci fy a

fi xed user to create and modi fy the packages on the database. The
AuthID must have authori ty to execute al l the SQL i n the package.

l TC P Port: The D B2 D R D A l i stener process's port number on the

server host machi ne provi ded by your database admi ni strator. The
defaul t port number i s usual l y 446.

l Overwrite: If thi s check box i s sel ected, the system updates a D SN

w i th the same name w i th the i nformati on provi ded bel ow . If thi s
check box i s cl eared and a D SN w i th the same name exi sts on the
system, no D SN i s created and the D SN i s not updated.

l Test C onnection: If thi s check box i s sel ected, the system tests the
D SN i nformati on provi ded to determi ne i f a successful connecti on
can be made. If thi s check box i s cl eared, no connecti on test i s
performed. If thi s check box i s sel ected, you must provi de the
fol l ow i ng connecti on i nformati on:

1161 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l U sername: The name of a val i d user for the database.

l Password: The passw ord for the user name that you provi ded to
connect to the database. You can use the button to the ri ght of the
Passw ord fi el d to determi ne w hether the passw ord characters are
show n or asteri sks are di spl ayed i nstead.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Gr een p lu m
To perform thi s confi gurati on, i n System Manager, from the
C onnectors and processes pane, add the Greenplum process to your
w orkfl ow . The fol l ow i ng i nformati on i s requi red to create a D SN for
Greenpl um:

l D ata Source N ame: A name to i denti fy the Greenpl um data source

confi gurati on i n Mi croStrategy. For exampl e, F i n a n c e or
Gr ee np lu m - 1 can serve to i denti fy the connecti on.

l H ost N ame: The name or IP address of the machi ne on w hi ch the

Greenpl um data source resi des. The system admi ni strator or
database admi ni strator assi gns the host name.

l Port N umber: The port number for the connecti on. The defaul t port
number for Greenpl um i s usual l y 5432. C heck w i th your database
admi ni strator for the correct number.

l D atabase N ame: The name of the database to connect to by

defaul t. The database admi ni strator assi gns the database name.

l Overwrite: If thi s check box i s sel ected, the system updates a D SN

w i th the same name w i th the i nformati on provi ded bel ow . If thi s
check box i s cl eared and a D SN w i th the same name exi sts on the
system, no D SN i s created and the D SN i s not updated.

© 2019, M icr o St r at egy In c. 1162

Syst em Ad m in ist r at io n Gu id e

l Test C onnection: If thi s check box i s sel ected, the system tests the
D SN i nformati on provi ded to determi ne i f a successful connecti on
can be made. If thi s check box i s cl eared, no connecti on test i s
performed. If thi s check box i s sel ected, you must provi de the
fol l ow i ng connecti on i nformati on:

l U sername: The name of a val i d user for the database.

l Password: The passw ord for the user name that you provi ded to
connect to the database. You can use the button to the ri ght of the
Passw ord fi el d to determi ne w hether the passw ord characters are
show n or asteri sks are di spl ayed i nstead.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Hive
To perform thi s confi gurati on, i n System Manager, from the
C onnectors and processes pane, add the H ive process to your
w orkfl ow . The fol l ow i ng i nformati on i s requi red to create a D SN for
Apache H i ve:

l D ata Source N ame: A name to i denti fy the Apache H i ve data

source confi gurati on i n Mi croStrategy. For exampl e, F i n a n c e or
Ap ac he Hi v e - 1 can serve to i denti fy the connecti on.

l H ost N ame: The name or IP address of the machi ne on w hi ch the

Apache H i ve data source resi des. The system admi ni strator or
database admi ni strator assi gns the host name.

l Port N umber: The port number for the connecti on. The defaul t port
number for Apache H i ve i s usual l y 10000. C heck w i th your
database admi ni strator for the correct number.

l D atabase N ame: The name of the database to connect to by

defaul t. If no database name i s provi ded, the defaul t database i s

1163 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

used for the connecti on. The database admi ni strator assi gns the
database name.

l Overwrite: If thi s check box i s sel ected, the system updates a D SN

w i th the same name w i th the i nformati on provi ded bel ow . If thi s
check box i s cl eared and a D SN w i th the same name exi sts on the
system, no D SN i s created and the D SN i s not updated.

l Test C onnection: If thi s check box i s sel ected, the system tests the
D SN i nformati on provi ded to determi ne i f a successful connecti on
can be made. If thi s check box i s cl eared, no connecti on test i s
performed.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

In f o r mix
To perform thi s confi gurati on, i n System Manager, from the
C onnectors and processes pane, add the Informix process to your
w orkfl ow . The fol l ow i ng i nformati on i s requi red to create a D SN for
Informi x Wi re Protocol :

l D ata Source N ame: A name to i denti fy the Informi x data source

confi gurati on i n Mi croStrategy. For exampl e, Fi nance or Informi x-1
can serve to i denti fy the connecti on.

l Server N ame: The cl i ent connecti on stri ng desi gnati ng the server
and database to be accessed.

l H ost N ame: The name of the machi ne on w hi ch the Informi x server

resi des. The system admi ni strator or database admi ni strator
assi gns the host name.

l Port N umber: The Informi x server l i stener's port number. The

defaul t port number for Informi x i s commonl y 1526.

© 2019, M icr o St r at egy In c. 1164

Syst em Ad m in ist r at io n Gu id e

l D atabase N ame: The name of the database to connect to by

defaul t, w hi ch i s assi gned by the database admi ni strator.

l Overwrite: If thi s check box i s sel ected, the system updates a D SN

w i th the same name w i th the i nformati on provi ded bel ow . If thi s
check box i s cl eared and a D SN w i th the same name exi sts on the
system, no D SN i s created and the D SN i s not updated.

l Test C onnection: If thi s check box i s sel ected, the system tests the
D SN i nformati on provi ded to determi ne i f a successful connecti on
can be made. If thi s check box i s cl eared, no connecti on test i s
performed. If thi s check box i s sel ected, you must provi de the
fol l ow i ng connecti on i nformati on:

l U sername: The name of a val i d user for the database.

l Password: The passw ord for the user name that you provi ded to
connect to the database. You can use the button to the ri ght of the
Passw ord fi el d to determi ne w hether the passw ord characters are
show n or asteri sks are di spl ayed i nstead.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

In f o r mix XPS
To perform thi s confi gurati on, i n System Manager, from the
C onnectors and processes pane, add the Informix XPS (Windows
Only) process to your w orkfl ow . The fol l ow i ng i nformati on i s requi red
to create a D SN for Informi x XPS:

l D ata Source N ame: A name to i denti fy the Informi x data source

confi gurati on i n Mi croStrategy. For exampl e, Fi nance or Informi x-1
can serve to i denti fy the connecti on.

l D atabase: The name of the database to connect to by defaul t,

w hi ch i s assi gned by the database admi ni strator.

1165 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Server N ame: The cl i ent connecti on stri ng desi gnati ng the server
and database to be accessed.

l H ost N ame: The name of the machi ne on w hi ch the Informi x server

resi des. The system admi ni strator or database admi ni strator
assi gns the host name.

l Service N ame: The servi ce name, as i t exi sts on the host machi ne.
The system admi ni strator assi gns the servi ce name.

l Protocol Type: The protocol used to communi cate w i th the server.

Sel ect the appropri ate protocol from thi s drop-dow n l i st.

l Overwrite: If thi s check box i s sel ected, the system updates a D SN

w i th the same name w i th the i nformati on provi ded bel ow . If thi s
check box i s cl eared and a D SN w i th the same name exi sts on the
system, no D SN i s created and the D SN i s not updated.

l Test C onnection: If thi s check box i s sel ected, the system tests the
D SN i nformati on provi ded to determi ne i f a successful connecti on
can be made. If thi s check box i s cl eared, no connecti on test i s
performed. If thi s check box i s sel ected, you must provi de the
fol l ow i ng connecti on i nformati on:

l U sername: The name of a val i d user for the database.

l Password: The passw ord for the user name that you provi ded to
connect to the database. You can use the button to the ri ght of the
Passw ord fi el d to determi ne w hether the passw ord characters are
show n or asteri sks are di spl ayed i nstead.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Micr o so f t SQL Ser ver

To perform thi s confi gurati on, i n System Manager, from the
C onnectors and processes pane, add the Microsoft SQL Server

© 2019, M icr o St r at egy In c. 1166

Syst em Ad m in ist r at io n Gu id e

The fol l ow i ng i nformati on i s requi red to create a D SN for Mi crosoft

SQL Server:

l D ata Source N ame: A name to i denti fy the Mi crosoft SQL Server

data source confi gurati on i n Mi croStrategy. For exampl e, Personnel
or SQLServer-1 can serve to i denti fy the connecti on.

l Windows: Sel ect thi s opti on i f you are confi guri ng the Mi crosoft
SQL Server dri ver on Wi ndow s:

l Server N ame: The name of a SQL Server on your netw ork, i n the
format Se r v e r N a m e _o r _I P A d d r e s s,P o r t N u m b e r. For
exampl e, i f your netw ork supports named servers, you can speci fy
an address such as SQ L S e r v e r -1 , 1 4 3 3. You can al so speci fy
the IP address such as 1 2 3 . 4 5 . 6 7 8 . 9 9 8 , 1 4 3 3.

Addi ti onal l y, i f you use named i nstances to di sti ngui sh SQL

Server databases, you can i ncl ude the named i nstance al ong w i th
ei ther the server name or IP address usi ng the format
Se rv er Na m e\ N a m e d I n s t a n c e or
IP Ad dr es s \N a m e d I n s t a n c e. The fol l ow i ng are exampl es of
provi di ng the server name for your SQL Server database:

12 3. 45 .6 7 8 . 9 9 8 \I n s t a n c e 1 , 1 4 3 3

SQ LS er ve r -1 \ I n s t a n c e 1 , 1 4 3 3

l D atabase N ame: The name of the database to connect to by

defaul t. The database admi ni strator assi gns the database name.

l U se Windows N T authentication for login: Sel ect thi s check box

to use Wi ndow s N T authenti cati on to pass a user's credenti al s on
the Wi ndow s machi ne to execute agai nst a SQL Server database.

If you use Wi ndow s N T authenti cati on w i th SQL Server, you must

enter the Wi ndow s N T account user name and passw ord i n Servi ce
Manager. For background i nformati on on Servi ce Manager, see

1167 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

R unni ng Intel l i gence Server as an Appl i cati on or a Servi ce, page

32.

l U N IX: Sel ect thi s opti on i f you are confi guri ng the Mi croStrategy-
branded versi on of the Mi crosoft SQL Server dri ver for use on U N IX
and Li nux:

l Server N ame: The name of a SQL Server on your netw ork. For
exampl e, i f your netw ork supports named servers, you can speci fy
an address such as SQ L S e r v e r -1. You can al so speci fy the IP
address such as 1 2 3 . 4 5 . 6 7 8 . 9 9 8. C ontact your system
admi ni strator for the server name or IP address.

Addi ti onal l y, i f you use named i nstances to di sti ngui sh SQL

Server databases, you can i ncl ude the named i nstance al ong w i th
ei ther the server name or IP address usi ng the format
Se rv er Na m e\ N a m e d I n s t a n c e or
IP Ad dr es s \N a m e d I n s t a n c e. The fol l ow i ng are exampl es of
provi di ng the server name for your SQL Server database:

SQ LS er ve r -1 \ I n s t a n c e 1

12 3. 45 .6 7 8 . 9 9 8 \I n s t a n c e 1

l D atabase N ame: The name of the database to connect to by

defaul t. The database admi ni strator assi gns the database name.

l Port N umber: The port number for the connecti on. The defaul t
port number for SQL Server i s usual l y 1433. C heck w i th your
database admi ni strator for the correct number.

l Enable SQL D atabase (A zure) support: D efi nes w hether the

D SN i s created to support SQL Azure. Sel ect thi s check box i f the
D SN i s used to access a SQL Azure data source.

l Overwrite: If thi s check box i s sel ected, the system updates a D SN

w i th the same name w i th the i nformati on provi ded bel ow . If thi s

© 2019, M icr o St r at egy In c. 1168

Syst em Ad m in ist r at io n Gu id e

check box i s cl eared and a D SN w i th the same name exi sts on the
system, no D SN i s created and the D SN i s not updated.

l Test C onnection: If thi s check box i s sel ected, the system tests the
D SN i nformati on provi ded to determi ne i f a successful connecti on
can be made. If thi s check box i s cl eared, no connecti on test i s
performed. If thi s check box i s sel ected, you must provi de the
fol l ow i ng connecti on i nformati on:

l U sername: The name of a val i d user for the database.

l Password: The passw ord for the user name that you provi ded to
connect to the database. You can use the button to the ri ght of the
Passw ord fi el d to determi ne w hether the passw ord characters are
show n or asteri sks are di spl ayed i nstead.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Micr o so f t Access
The Mi croStrategy OD BC D ri ver for SequeLi nk al l ow s you to access
Mi crosoft Access databases stored on a Wi ndow s machi ne from an
Intel l i gence Server hosted on a U N IX or Li nux machi ne.

Steps on how to perform the necessary confi gurati ons on the vari ous
machi nes to support thi s type of confi gurati on are provi ded i n the
Instal l ati on and C onfi gurati on Gui de.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the Microsoft A ccess
(Windows Only) process to your w orkfl ow . The fol l ow i ng i nformati on
i s requi red to create a D SN for Mi crosoft Access:

l D ata Source N ame: A name to i denti fy the Mi crosoft SQL Server

data source confi gurati on i n Mi croStrategy. For exampl e, Personnel
or Mi crosoftAccess-1 can serve to i denti fy the connecti on.

1169 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l D atabase: The name of the database to connect to by defaul t. C l i ck

the fol der i con to brow se to and sel ect a Mi crosoft Access database.

l Overwrite: If thi s check box i s sel ected, the system updates a D SN

w i th the same name w i th the i nformati on provi ded bel ow . If thi s
check box i s cl eared and a D SN w i th the same name exi sts on the
system, no D SN i s created and the D SN i s not updated.

l Test C onnection: Tests the D SN i nformati on provi ded to determi ne

i f a successful connecti on can be made. If thi s check box i s cl eared,
no connecti on test i s performed.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

MySQL
The Mi croStrategy OD BC D ri ver for MySQL Wi re Protocol i s for use
w i th MySQL Enterpri se on Wi ndow s and Li nux.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the MySQL process to your
w orkfl ow . The fol l ow i ng i nformati on i s requi red to create a D SN for
MySQL:

l D ata Source N ame: A name to i denti fy the MySQL data source

confi gurati on i n Mi croStrategy. For exampl e, Fi nance or MySQL-1
can serve to i denti fy the connecti on.

l H ost N ame: The name or IP address of the machi ne on w hi ch

MySQL Enterpri se 5.0 resi des. The system admi ni strator or
database admi ni strator assi gns the host name.

l Port N umber: The port number for the connecti on. The defaul t port
number for MySQL i s usual l y 3306. C heck w i th your database
admi ni strator for the correct number.

© 2019, M icr o St r at egy In c. 1170

Syst em Ad m in ist r at io n Gu id e

l D atabase N ame: The name of the database to connect to by

defaul t. The database admi ni strator assi gns the database name.

l D efault U ser ID : The name of a val i d user for MySQL Enterpri se.

l Overwrite: If thi s check box i s sel ected, the system updates a D SN

w i th the same name w i th the i nformati on provi ded bel ow . If thi s
check box i s cl eared and a D SN w i th the same name exi sts on the
system, no D SN i s created and the D SN i s not updated.

l Test C onnection: If thi s check box i s sel ected, the system tests the
D SN i nformati on provi ded to determi ne i f a successful connecti on
can be made. If thi s check box i s cl eared, no connecti on test i s
performed. If thi s check box i s sel ected, you must provi de the
fol l ow i ng connecti on i nformati on:

l U ser N ame: The name of a val i d user for the database.

l Password: The passw ord for the defaul t user name that you
provi ded. You can use the button to the ri ght of the Passw ord fi el d
to determi ne w hether the passw ord characters are show n or
asteri sks are di spl ayed i nstead.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Or acle
To perform thi s confi gurati on, i n System Manager, from the
C onnectors and processes pane, add the Oracle process to your
w orkfl ow . The fol l ow i ng i nformati on i s requi red to create a D SN for
Oracl e Wi re Protocol :

l D ata Source N ame: A name to i denti fy the Oracl e data source

confi gurati on i n Mi croStrategy. For exampl e, Fi nance or Oracl e-1
can serve to i denti fy the connecti on. A D SN i s requi red for any

1171 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Oracl e Wi re Protocol connecti on. D ependi ng on w hether you w ant

to use a standard connecti on or a TN SN ames connecti on, refer to
one of the fol l ow i ng l i sts of opti ons bel ow :

l Standard C onnection: A standard connecti on i s confi gured

through Oracl e Wi re Protocol w i th the fol l ow i ng connecti on
parameters:

l H ost N ame: The name of the Oracl e server to be accessed.

Thi s can be a server name such as Oracl e-1 or an IP address
such as 1 2 3 . 4 5 6 . 7 8 9 . 9 8.

l Port N umber: The Oracl e l i stener port number provi ded by your
database admi ni strator. The defaul t port number i s usual l y
1521.

l One of the fol l ow i ng parameters; w hi ch one you choose i s up to

your personal preference:

l SID : The Oracl e System Identi fi er for the i nstance of Oracl e

runni ng on the server. The defaul t SID i s usual l y OR C L.

l Service N ame: The gl obal database name, w hi ch i ncl udes

the database name and the domai n name. For exampl e, i f
your database name i s f i n a n c e and i ts domai n i s
bu si n e s s . c o m the servi ce name i s
fi na n c e . b u s i n e s s . c o m.

l A lternate Servers: A l i st of al ternate database servers to enabl e

connecti on fai l over for the dri ver. If the pri mary database server
entered as the SID or servi ce name i s unavai l abl e, a connecti on
to the servers i n thi s l i st i s attempted unti l a connecti on can be
establ i shed. You can l i st the servers i n SID or servi ce name
format, as show n i n the fol l ow i ng exampl es:

© 2019, M icr o St r at egy In c. 1172

Syst em Ad m in ist r at io n Gu id e

l U si ng an SID : (H o s t N a m e =D B _s e r v e r _n a m e:
Po rt Nu m b e r = 1 5 2 6 : S I D = O R C L )

l U si ng a Servi ce N ame: (H o s t N a m e =D B _s e r v e r _n a m e:
Po rt Nu m b e r = 1 5 2 6 : S e r v i c e N a m e =s e r v i c e . n a m e . c o m)

l TN SN ames C onnection: A TN SN ames connecti on uses a

TN SN AM ES . O R A fi l e to retri eve host, port number, and SID
i nformati on from a server (al i as or Oracl e net servi ce name) l i sted
i n the TN S N A M E S . O R A fi l e. A TN SN ames connecti on requi res the
fol l ow i ng parameters:

l Server N ame: A server name, w hi ch i s i ncl uded i n a

TN SN AM E S . O R A fi l e i ncl uded i n the TN SN ames Fi l e fi el d
bel ow .

l TN SN ames File: The l ocati on of your T N S N A M E S . O R A fi l e.

Make sure to enter the enti re path to the T N S N A M E S . O R A fi l e,
i ncl udi ng the fi l e name i tsel f. You can speci fy mul ti pl e
TN SN AM E S . O R A fi l es.

l Overwrite: If thi s check box i s sel ected, the system updates a D SN

w i th the same name w i th the i nformati on provi ded bel ow . If thi s
check box i s cl eared and a D SN w i th the same name exi sts on the
system, no D SN i s created and the D SN i s not updated.

l Test C onnection: If thi s check box i s sel ected, the system tests the
D SN i nformati on provi ded to determi ne i f a successful connecti on
can be made. If thi s check box i s cl eared, no connecti on test i s
performed. If thi s check box i s sel ected, you must provi de the
fol l ow i ng connecti on i nformati on:

l U ser N ame: The name of a val i d user for the database.

l Password: The passw ord for the user name you provi ded to
connect to the database. You can use the button to the ri ght of the

1173 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Passw ord fi el d to determi ne w hether the passw ord characters are

show n or asteri sks are di spl ayed i nstead.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Po st gr eSQL
To perform thi s confi gurati on, i n System Manager, from the
C onnectors and processes pane, add the PostgreSQL process to
your w orkfl ow . The fol l ow i ng i nformati on i s requi red to create a D SN
for PostgreSQL:

l D ata Source N ame: A name to i denti fy the PostgreSQL data source

confi gurati on i n Mi croStrategy. For exampl e, Fi nance or
PostgreSQL-1 can serve to i denti fy the connecti on.

l H ost N ame: The name or IP address of the machi ne on w hi ch the

PostgreSQL database resi des. The system admi ni strator or
database admi ni strator assi gns the host name.

l Port N umber: The port number for the connecti on. The defaul t port
number for PostgreSQL i s usual l y 5432. C heck w i th your database
admi ni strator for the correct number.

l D atabase N ame: The name of the database to connect to by

defaul t. The database admi ni strator assi gns the database name.

l D efault U ser ID : The name of a val i d user for the PostgreSQL

database.

l Overwrite: If thi s check box i s sel ected, the system updates a D SN

w i th the same name w i th the i nformati on provi ded bel ow . If thi s
check box i s cl eared and a D SN w i th the same name exi sts on the
system, no D SN i s created and the D SN i s not updated.

l Test C onnection: Tests the D SN i nformati on provi ded to determi ne

i f a successful connecti on can be made. If thi s check box i s cl eared,

© 2019, M icr o St r at egy In c. 1174

Syst em Ad m in ist r at io n Gu id e

no connecti on test i s performed. If thi s check box i s sel ected, you

must provi de the fol l ow i ng connecti on i nformati on:

l U sername: The name of a val i d user for the database.

l Password: The passw ord for the defaul t user name that you
provi ded. You can use the button to the ri ght of the Passw ord fi el d
to determi ne w hether the passw ord characters are show n or
asteri sks are di spl ayed i nstead.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Salesf o r ce
To perform thi s confi gurati on, i n System Manager, from the
C onnectors and processes pane, add the Salesforce process to your
w orkfl ow . The fol l ow i ng i nformati on i s requi red to create a D SN for
Sal esforce:

l D ata Source N ame: A name to i denti fy the Sal esforce data source
confi gurati on i n Mi croStrategy. For exampl e, Fi nance or Sal esforce-
1 can serve to i denti fy the connecti on.

l H ost N ame: The host name to connect to Sal esforce.com. You can
keep the defaul t val ue of l o g i n . s a l e s f o r c e . c o m.

l Overwrite: If thi s check box i s sel ected, the system updates a D SN

w i th the same name w i th the i nformati on provi ded bel ow . If thi s
check box i s cl eared and a D SN w i th the same name exi sts on the
system, no D SN i s created and the D SN i s not updated.

l Test C onnection: If thi s check box i s sel ected, the system tests the
D SN i nformati on provi ded to determi ne i f a successful connecti on
can be made. If thi s check box i s cl eared, no connecti on test i s
performed. If thi s check box i s sel ected, you must suppl y the
fol l ow i ng i nformati on to test the connecti on:

1175 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l U sername: The user name of a user account for Sal esforce.com.

The user name syntax i s U s e r N a m e@ s a l e s f o r c e . c o m, w here
Us er Na me i s the speci fi c user account.

l Password: The passw ord for the Sal esforce.com user account
that w as suppl i ed. The passw ord syntax i s
Pa ss wo rd S e c u r i ty t o k e n, w here P a s sw o r d i s the passw ord
for the user account and S e c u r i t y t o k e n i s the addi ti onal
securi ty token requi red to access Sal esforce.com. D o not use any
spaces or other characters to separate the passw ord and securi ty
token.

As part of confi guri ng a connecti on to your Sal esforce.com

system, you can i ncl ude the passw ord and securi ty token as part
of the database l ogi n, w hi ch i s a component of a database
i nstance used to access the D SN i n Mi croStrategy. For steps to
create a database l ogi n, w hi ch you can use to provi de the
Sal esforce.com passw ord and securi ty token, see the Instal l ati on
and C onfi gurati on Gui de.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Syb ase ASE

To perform thi s confi gurati on, i n System Manager, from the
C onnectors and processes pane, add the Sybase A SE process to
your w orkfl ow . The fol l ow i ng i nformati on i s requi red to create a D SN
for Sybase ASE:

l D ata Source N ame: A name to i denti fy the Sybase ASE data

source confi gurati on i n Mi croStrategy. For exampl e, Fi nance or
SybaseASE-1 can serve to i denti fy the connecti on.

l N etwork A ddress: The netw ork address, i n the format

Se rv er Na m e _ o r _I P Ad d r e s s , P o r t N u m be r. For exampl e, i f your
netw ork supports named servers, you can speci fy an address such

© 2019, M icr o St r at egy In c. 1176

Syst em Ad m in ist r at io n Gu id e

as S yb as eA S E -1 , 5 0 0 0. You can al so speci fy the IP address such

as 1 23 .4 56 . 7 8 9 . 9 8 , 5 0 0 0. C ontact your system admi ni strator for
the server name or IP address.

l D atabase N ame: The name of the database to connect to by

defaul t. The database admi ni strator assi gns the database name.

l Enable U nicode support (U TF8): Sel ect thi s check box i f the
database supports U N IC OD E.

l Overwrite: If thi s check box i s sel ected, the system updates a D SN

w i th the same name w i th the i nformati on provi ded bel ow . If thi s
check box i s cl eared and a D SN w i th the same name exi sts on the
system, no D SN i s created and the D SN i s not updated.

l Test C onnection: If thi s check box i s sel ected, the system tests the
D SN i nformati on provi ded to determi ne i f a successful connecti on
can be made. If thi s check box i s cl eared, no connecti on test i s
performed. If thi s check box i s sel ected, you must provi de the
fol l ow i ng connecti on i nformati on:

l U sername: The name of a val i d user for the database.

l Password: The passw ord for the user name that you provi ded to
connect to the database. You can use the button to the ri ght of the
Passw ord fi el d to determi ne w hether the passw ord characters are
show n or asteri sks are di spl ayed i nstead.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Completing a Separate System Manager Workflow

R ather than i ncl ude al l requi red processes i n a si ngl e System
Manager w orkfl ow , you can group processes i nto separate w orkfl ow s.
These separate w orkfl ow s can then be combi ned i n another w orkfl ow
by i ncl udi ng the separate w orkfl ow s as processes.

By separati ng tasks i nto mul ti pl e w orkfl ow s, you can then re-use

these w orkfl ow s as components of other l arger w orkfl ow s. For

1177 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

exampl e, starti ng Intel l i gence Server and troubl eshooti ng thi s servi ce
may be requi red for mul ti pl e w orkfl ow s that you create. You can
i ncl ude the steps to start and troubl eshoot Intel l i gence Server i nto a
separate w orkfl ow , and then use thi s w orkfl ow i n al l the w orkfl ow s
that requi re these steps.

Once you have created a w orkfl ow , you can i ncl ude i t as a

confi gurati on i n another w orkfl ow . In System Manager, from the
C onnectors and processes pane, add the Execute System Manager
Workflow process to your w orkfl ow . The fol l ow i ng i nformati on i s
requi red:

l Workflow File: C l i ck the fol der i con to brow se to and sel ect a
System Manager w orkfl ow fi l e. Thi s i s the w orkfl ow that i s i ncl uded
as a process i n the current w orkfl ow .

l Starting Process: Sel ect thi s check box to speci fy the fi rst process
to attempt for the w orkfl ow . Type the name of the process, i ncl udi ng
the proper case, i n the fi el d bel ow . Ensure that the process i s
enabl ed as an entry process for the w orkfl ow . For steps to enabl e a
process as an entry process, see U si ng Entry Processes to
D etermi ne the Fi rst Step i n a Workfl ow , page 1092.

l U se a Parameter File: Sel ect thi s check box to speci fy a

parameters fi l e to provi de val ues for the parameters of the w orkfl ow .
C l i ck the fol der i con to brow se to and sel ect a parameters fi l e for
the w orkfl ow . For i nformati on on usi ng parameters i n a w orkfl ow ,
see U si ng Parameters for Processes, page 1228. You can al so
speci fy parameter val ues usi ng the U se C onsol e Parameters opti on
descri bed bel ow .

l U se a C ustomized Log File: Sel ect thi s check box to speci fy a l og

fi l e to save al l resul ts of the w orkfl ow to. C l i ck the fol der i con to
brow se to and sel ect a l og fi l e. Thi s l ets you separate the resul ts of
each w orkfl ow i nto i ndi vi dual l og fi l es. If you cl ear thi s check box,

© 2019, M icr o St r at egy In c. 1178

Syst em Ad m in ist r at io n Gu id e

the resul ts of the w orkfl ow are i ncl uded i n the l og fi l e for the mai n
w orkfl ow .

l U se C onsole Parameters: Sel ect thi s check box to manual l y

suppl y val ues for parameters of the process. Type the parameters
and thei r val ues i n the fi el d bel ow . If you al so use the U se a
Parameter Fi l e opti on descri bed above, these val ues overw ri te any
val ues provi ded i n the parameters fi l e. For addi ti onal i nformati on on
how the val ue of a parameter i s determi ned, see U si ng Parameters
for Processes, page 1228.

l D isplay Output on the C onsole: Sel ect thi s check box to output al l
resul ts to the System Manager consol e. If thi s check box i s cl eared,
the resul ts of any acti ons taken as part of thi s System Manager
w orkfl ow are not di spl ayed on the consol e and i nstead onl y
provi ded i n any speci fi ed l og fi l es.

l Exi t code opti ons:

l Personalize Success Exit C ode(s): Sel ect thi s check box to

speci fy the exi t codes that i ndi cate successful executi on of the
underl yi ng w orkfl ow . Type the exi t codes i n the text box,
separati ng mul ti pl e codes w i th a comma. Val i d exi t codes must be
an i nteger. The success exi t codes you speci fy here map to a new
exi t code of 0, w hi ch i s passed on to the l arger w orkfl ow to
i ndi cate that thi s w orkfl ow executed successful l y.

l Personalize Failure Exit C ode(s): Sel ect thi s check box to

speci fy the exi t codes that i ndi cate fai l ed executi on of the
underl yi ng w orkfl ow . Type the exi t codes i n the text box,
separati ng mul ti pl e codes w i th a comma. Val i d exi t codes must be
an i nteger. The fai l ure exi t codes you speci fy here map to a new
exi t code of -1, w hi ch i s passed on to the l arger w orkfl ow to
i ndi cate that thi s w orkfl ow fai l ed.

1179 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

If you do not use the Personal i ze Exi t C ode(s) opti ons, or i f you
confi gure them i ncorrectl y, one of the fol l ow i ng exi t codes w i l l be
passed on to the l arger w orkfl ow :

l 1: Indi cates an undefi ned executi on resul t, w hi ch i s treated as a

successful executi on. Thi s success exi t code i s passed on to the
l arger w orkfl ow i f you do not use the Personal i ze Exi t C ode(s)
opti ons and the w orkfl ow executes, regardl ess of w hether the
executi on i s successful or not.

l -2: Indi cates that the i nput format of the speci fi ed exi t codes i s
i ncorrect, for exampl e, i f you use an exi t code that i s not an
i nteger, or i f you separate mul ti pl e codes w i th anythi ng other than
a comma.

l -3: Indi cates that there i s at l east one confl i ct i n the personal i zed
exi t codes. For exampl e, i f you use exi t code 4 i n both the
Success Exi t C ode(s) l i st and the Fai l ure Exi t C ode(s) l i st.

l -5555: Indi cates that the underl yi ng w orkfl ow fai l ed to i ni ti al i ze.

For exampl e, i f the w orkfl ow i s i ncompl ete, i t w i l l not start.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Retrieving MicroStrategy Information

You can retri eve vari ous i nformati on about the Mi croStrategy
softw are, w hi ch i s i nstal l ed for the machi ne System Manager i s
runni ng on, as part of a System Manager w orkfl ow . Each
Mi croStrategy property that you retri eve must be stored i n a parameter
for the w orkfl ow (see U si ng Parameters for Processes, page 1228).

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the R etrieve MicroStrategy
Properties process to your w orkfl ow . The fol l ow i ng i nformati on i s
requi red to retri eve i nformati on on the Mi croStrategy i nstal l ati on:

© 2019, M icr o St r at egy In c. 1180

Syst em Ad m in ist r at io n Gu id e

l MicroStrategy Property: The i nformati on about the system that i s

retri eved. You can sel ect from the fol l ow i ng opti ons:

l H ome Path: The path that acts as the home di rectory for the
Mi croStrategy i nstal l ati on. Thi s path i ncl udes Mi croStrategy
confi gurati on fi l es that can be modi fi ed after a successful
i nstal l ati on.

l C ommon Path: The path that contai ns i mportant fi l es. The types
of fi l es i ncl uded i n thi s path vari es dependi ng on your operati ng
system, but i t can i ncl ude fi l es such as l og fi l es, SQL fi l es, WAR
fi l es, JAR fi l es, l i brari es, and more.

l B uild Version: The bui l d versi on number of the Mi croStrategy

softw are. Thi s versi on number can be hel pful w hen
troubl eshooti ng a Mi croStrategy system and w hen w orki ng w i th
Mi croStrategy Techni cal Support.

l R elease Version: The maj or rel ease versi on of the Mi croStrategy

softw are, such as 9.2.1.

l Parameter: The System Manager parameter that i s used to store the

Mi croStrategy i nformati on that i s retri eved.

l R etrieve this additional property: Sel ect thi s check box to retri eve
addi ti onal i nformati on about the Mi croStrategy i nstal l ati on. For each
of these check boxes that you sel ect, an addi ti onal Mi croStrategy
Property and Parameter pai r i s made avai l abl e.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Performing System Processes

In addi ti on to the vari ous Mi croStrategy confi gurati ons that can be
compl eted as part of a System Manager w orkfl ow , you can al so
perform vari ous system processes. Thi s l ets you perform system
processes such as copyi ng, movi ng, or del eti ng a fi l e.

1181 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

You can al so execute any process that uses system or thi rd-party
tool s. Thi s l ets you perform custom processes that can be executed
from the system's command l i ne.

The system processes that are supported i ncl ude:

l Encrypti ng/D ecrypti ng Text or Fi l es, page 1182

l C opyi ng a Fi l e or Fol der, page 1184

l D el eti ng a Fi l e or Fol der, page 1187

l Movi ng a Fi l e or Fol der, page 1188

l Fi nd and R epl ace Informati on i n a Fi l e, page 1189

l R enami ng a Fi l e or Fol der, page 1192

l U nzi ppi ng a C ompressed Fi l e, page 1192

l C ompressi ng Fi l es i nto a Zi p Fi l e, page 1193

l D ow nl oadi ng Fi l es from an FTP or SFTP Si te , page 1194

l U pl oadi ng Fi l es to an FTP or SFTP Si te , page 1196

l Executi ng a SQL Statement, page 1198

l Sendi ng an Emai l , page 1201

l D el ayi ng a Workfl ow to Al l ow for Task C ompl eti on, page 1204

l U pdati ng Workfl ow Parameters, page 1205

l R etri evi ng Machi ne Informati on, page 1207

En cr yp t in g/ Decr yp t in g Text o r Files

You can confi gure a process to encrypt or decrypt speci fi ed text or a
fi l e.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the C ryptographic Service

© 2019, M icr o St r at egy In c. 1182

Syst em Ad m in ist r at io n Gu id e

process to your w orkfl ow . The fol l ow i ng i nformati on i s requi red to

perform thi s process:

l A ction: Sel ect ei ther Encrypt or D ecrypt from the drop-dow n l i st.
Encrypt al gori thmi cal l y encodes pl ai n text i nto a non-readabl e form.
D ecrypt deci phers the encrypted text back to i ts ori gi nal pl ai n text
form.

The Dec ry pt ac tion only work s on tex t that was enc ry pted us ing the
Enc ry pt ac tion. Als o, files enc oded us ing the Enc ry pt ac tion mus t be
dec ry pted us ing the Dec ry pt ac tion. Other enc ry ption/dec ry ption
programs will not work .

l Password: Sel ect the check box and type the requi red passw ord i f
a speci fi c passw ord i s requi red to perform thi s process. If thi s
opti on i s not sel ected, i t w i l l use the defaul t passw ord speci fi ed by
System Manager.

l Text: Sel ect thi s opti on and type the text to be encrypted or
decrypted i n the text box. Thi s i s useful for encrypti ng or decrypti ng
a smal l amount of text.

l File: Sel ect thi s opti on and cl i ck the fol der i con to sel ect the fi l e to
encrypt or decrypt. Thi s opti on i s useful i f you have a l arge amount
of text to encrypt or decrypt.

l Output File: C l i ck the fol der i con to sel ect the fi l e i n w hi ch to store
the encrypted or decrypted resul ts.

l Overwrite: Sel ect thi s check box to overw ri te the output fi l e i f i t

al ready exi sts.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Per f o r min g Cu st o m Pr o cesses

You can execute a custom process as part of a System Manager
w orkfl ow . Thi s can be any process that uses system or thi rd-party

1183 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

tool s. H ow ever, the process must be executabl e from the system's

command l i ne.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the Execute A pplication
process to your w orkfl ow . The fol l ow i ng i nformati on i s requi red to
execute a custom process:

l A pplication To Execute: The command to execute the custom

process. Thi s command must meet the syntax requi rements of the
system i t i s executed on.

l Execute In System Shell: Sel ect thi s check box to execute the
appl i cati on and any parameters i n a Wi ndow s command prompt or
U N IX shel l . If you sel ect thi s opti on, the exi t code for thi s process
represents the success or fai l ure of creati ng a new Wi ndow s
command prompt or U N IX shel l . If you cl ear thi s opti on, the exi t
code for thi s process represents the success or fai l ure of executi ng
the appl i cati on, w hi ch coul d fai l i f an i ncorrect appl i cati on name or
path i s used.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Co p yin g a File o r Fo ld er
You can copy a fi l e or fol der as part of a System Manager w orkfl ow .

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the C opy Files process to your
w orkfl ow . The fol l ow i ng i nformati on i s requi red to copy a fi l e or fol der:

l Source File or D irectory: The l ocati on of the fi l e or fol der to copy.

If the path to a fi l e i s provi ded, onl y that fi l e i s copi ed. If the path to
a fol der i s provi ded, the fol der al ong w i th al l the fi l es w i thi n i t are
copi ed. C l i ck the fol der i con to brow se to and sel ect a fi l e or fol der.

© 2019, M icr o St r at egy In c. 1184

Syst em Ad m in ist r at io n Gu id e

You can al so use w i l dcard characters (* and ?) to sel ect fi l es or

fol ders to copy. For exampl e, you can use the syntax * . t x t to copy
al l fi l es w i th the extensi on .txt i n a fol der. For addi ti onal exampl es
of how you can use these w i l dcard characters, see U si ng Wi l dcard
C haracters i n Processes, page 1236.

l D estination File or D irectory: The l ocati on of the fi l e or fol der to

copy the fi l e or fol der to.

l If you are copyi ng a fi l e, you can provi de a path to a speci fi c

fol der l ocati on and fi l e name to store the new copy.

l If you are copyi ng a fol der or have used w i l dcard characters to

sel ect mul ti pl e fi l es or fol ders, you can provi de a fol der l ocati on at
w hi ch to store the fi l es or fol ders.

l If the l ocati on you provi de does not exi st, a new di rectory i s
created w i th the name of the desti nati on and al l source fi l es are
copi ed to the di rectory. C l i ck the fol der i con to brow se to and
sel ect a fi l e or fol der.

l Overwrite: If thi s check box i s sel ected, the system repl aces the
desti nati on fi l e or fol der w i th the same name as the source fi l e or
fol der provi ded. If thi s check box i s cl eared and a fi l e or fol der w i th
the same name exi sts on the system, the source fi l e or fol der i s not
copi ed to the speci fi ed l ocati on.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Cr eat in g a File o r Fo ld er
You can create a fi l e or fol der as part of a System Manager w orkfl ow .

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the C reate File process to your
w orkfl ow . The fol l ow i ng i nformati on i s requi red to create a fi l e or
fol der:

1185 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Select Type: D etermi nes w hether to create a fi l e or fol der. Sel ect
ei ther File or D irectory.

l Parent D irectory: The l ocati on i n w hi ch to create the fi l e or fol der

i n. C l i ck the fol der i con to brow se to and sel ect a fol der.

l File or D irectory N ame: The name for the new fi l e or fol der:

l For fi l es, type any fi l e name and extensi on to create an empty fi l e

of that fi l e type. Be aw are that thi s process does not val i date
w hether the fi l e type i s val i d.

l For fol ders, type the fol der name. Al ong w i th creati ng a si ngl e
fol der at the parent di rectory l ocati on, you can create a seri es of
subfol ders by usi ng backsl ashes (\ ). For exampl e, i f the parent
l ocati on i s C :\, you can create the fol l ow i ng fol ders:

l Type te s t. Thi s creates a si ngl e fol der C : \ t e s t.

l Type te s t 1 \ t e s t 2 \ t e s t 3. Thi s creates the fol der structure

C: \t es t 1 \ t e s t 2 \ t e s t 3.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Det er min in g t h e Nu mb er o f Files in a Fo ld er

You can determi ne the number of fi l es i n a fol der as part of a System
Manager w orkfl ow .

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the C ount Files process to your
w orkfl ow . The fol l ow i ng i nformati on i s requi red to determi ne the
number of fi l es i n a fol der:

l The D irectory: The l ocati on of the top l evel fol der to determi ne the
number of fi l es. C l i ck the fol der i con to brow se to and sel ect a
fol der.

© 2019, M icr o St r at egy In c. 1186

Syst em Ad m in ist r at io n Gu id e

l File Filter: Sel ect thi s opti on to appl y a si ngl e fi l ter to the fi l es that
are to be i ncl uded i n the count of fi l es i n a fol der. You can then type
the fi l ter, i ncl udi ng w i l dcard characters such as an asteri sk (*) to
represent mul ti pl e characters, and a questi on mark (? ) to represent
a si ngl e character. For exampl e, i f you type * . e x e, onl y fi l es that
end w i th the .exe extensi on are i ncl uded i n the count. If you type
te st ?. ex e , fi l es such as t e s t 1 . e x e, t e s t 2 . e x e, t e s t 3 . e x e,
and t es tA . e x e are i ncl uded i n the count. If you cl ear thi s check
box, al l fi l es i n a fol der are i ncl uded i n the fi nal count.

l A mong A ll Files: Sel ect thi s opti on to count fi l es onl y i n the top-
l evel fol der.

l A mong A ll Files and Subfolders R ecursively: Sel ect thi s opti on to

count fi l es i n the top-l evel fol der and al l subfol ders.

l Output Parameter: The number of fi l es i n the fol der must be stored

i n a parameter so that i t can be passed to another process i n the
System Manager w orkfl ow . Sel ect an output parameter from the
drop-dow n l i st to store thi s val ue.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Delet in g a File o r Fo ld er
You can del ete a fi l e or fol der as part of a System Manager w orkfl ow .

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the D elete Files process to your
w orkfl ow . The fol l ow i ng i nformati on i s requi red to del ete a fi l e or
fol der:

l File or D irectory: The l ocati on of the fi l e or fol der to del ete. If the
path to a fi l e i s provi ded, onl y that fi l e i s del eted. If the path to a
fol der i s provi ded, the fol der and al l the fi l es i n i t are del eted. C l i ck
the fol der i con to brow se to and sel ect a fi l e or fol der.

1187 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

You can al so use w i l dcard characters (* and ?) to sel ect fi l es or

fol ders for del eti on. For exampl e, you can use the syntax * . t x t to
del ete al l fi l es w i th the extensi on .txt i n a fol der. For addi ti onal
exampl es of how you can use these w i l dcard characters, see U si ng
Wi l dcard C haracters i n Processes, page 1236.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Mo vin g a File o r Fo ld er
You can move a fi l e or fol der to a new l ocati on as part of a System
Manager w orkfl ow . When a fi l e or fol der i s moved, the fi l e or fol der
onl y exi sts i n the new l ocati on provi ded. Thi s means the fi l e or fol der
i s no l onger avai l abl e i n the ori gi nal l ocati on i t w as moved from.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the Move Files process to your
w orkfl ow . The fol l ow i ng i nformati on i s requi red to move a fi l e or
fol der:

l Source File or D irectory: The l ocati on of the fi l e or fol der to move.

If the path to a fi l e i s provi ded, onl y that fi l e i s moved. If the path to
a fol der i s provi ded, the fol der al ong w i th al l the fi l es and fol ders
w i thi n i t are moved. C l i ck the fol der i con to brow se to and sel ect a
fi l e or fol der.

You can al so use w i l dcard characters (* and ?) to sel ect fi l es or

fol ders to move. For exampl e, you can use the syntax * . t x t to
move al l fi l es w i th the extensi on .txt i n a fol der. For addi ti onal
exampl es of how you can use these w i l dcard characters, see U si ng
Wi l dcard C haracters i n Processes, page 1236

l D estination File or D irectory: The l ocati on of the fi l e or fol der to

move the fi l e or fol der to.

© 2019, M icr o St r at egy In c. 1188

Syst em Ad m in ist r at io n Gu id e

l If you are movi ng a fi l e, you can provi de a path to a speci fi c fol der
l ocati on and fi l e name to store the fi l e.

l If you are movi ng a fol der or have used w i l dcard characters to

sel ect mul ti pl e fi l es or fol ders, you can provi de a fol der l ocati on at
w hi ch to store the fi l es or fol ders.

l If the l ocati on you provi de does not exi st, a new di rectory i s
created w i th the name of the desti nati on and al l source fi l es w i l l
be copi ed to thi s di rectory. C l i ck the fol der i con to brow se to and
sel ect a fi l e or fol der.

l Overwrite: If thi s check box i s sel ected, the system repl aces the
desti nati on fi l e or fol der w i th the same name as the source fi l e or
fol der provi ded. If thi s check box i s cl eared and a fi l e or fol der w i th
the same name exi sts on the system, the fi l e or fol der i s not moved
to the speci fi ed l ocati on.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Fin d an d Rep lace In f o r mat io n in a File

You can search a fi l e for vari ous keyw ords and phrases, and then
repl ace thi s i nformati on w i th new content, as part of a System
Manager w orkfl ow . These changes can be appl i ed by overw ri ti ng the
fi l e or by creati ng a new fi l e w i th al l the appl i cabl e changes.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the Find and R eplace File
C ontent process to your w orkfl ow . The fol l ow i ng i nformati on i s
requi red to fi nd and repl ace content i n a fi l e:

l Source File: The l ocati on of the fi l e to search for content to repl ace.
C l i ck the fol der i con to brow se to and sel ect a fi l e.

l D estination File: The l ocati on and name of the fi l e that i s created

w i th al l content repl acements. You can create a new fi l e to retai n a

1189 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

copy of the ori gi nal fi l e, or sel ect the same fi l e as the source fi l e to
overw ri te the exi sti ng fi l e. To overw ri te the exi sti ng fi l e, you must
al so sel ect the opti on Overw ri te D esti nati on Fi l e If It Al ready Exi sts
descri bed bel ow . C l i ck the fol der i con to brow se to and sel ect a fi l e.

l Overwrite D estination File If It A lready Exists: If thi s check box i s

sel ected, the system repl aces the ori gi nal fi l e w i th an updated
versi on of the fi l e that has al l rel evant content updates appl i ed. If
thi s check box i s cl eared and a fi l e w i th the same name exi sts on
the system, the fi l e i s not updated.

l Match C ase: If thi s check box i s sel ected, the system repl aces
keyw ords and phrases i f the content and the case of the content
matches. If thi s check box i s cl eared, keyw ords and phrases are
repl aced i f the content matches, regardl ess of the case.

l K eyword: The keyw ord or phrase to search for i n the fi l e. The

search fi nds and repl aces al l i nstances of the keyw ord or phrase i n
the fi l e. You must type the keyw ord or phrase exactl y; w i l dcard
characters cannot be used. To repl ace mul ti pl e l i nes i n the fi l e, use
$\ n$ to i ndi cate a l i ne break.

l Value: The content used to repl ace the keyw ord or phrase. To
repl ace a keyw ord w i th mul ti pl e l i nes, use $ \ n $ to i ndi cate a l i ne
break.

For exampl e, i f you have an XML fi l e that i ncl udes mul ti pl e

i nstances of the same address, and the person or company w i th that
address has recentl y moved to another ci ty, you can fi nd and
repl ace al l i nstances of the customer address. If the XML for the
address i s:

<address1>123 Main Street</address1>

<city>Vienna</city>
<state>Virginia</state>
<zip>22180</zip>

© 2019, M icr o St r at egy In c. 1190

Syst em Ad m in ist r at io n Gu id e

In the Keyw ord text box type the fol l ow i ng:

<a dd re ss 1 > 1 2 3 M a in
St re et </ a d d r e s s 1 > $ \ n $ < c i t y > V i e n n a < / c i t y > $ \ n $ < s t a t
e> Vi rg in i a < / s t a t e > $ \ n $ < z i p > 2 2 1 8 0 < / z i p >

If the new address shoul d read as fol l ow s i n the XML

<address1>4000 Connecticut Ave NW</address1>

<address2>Suite 600</address2>
<city>Washington</city>
<state>District of Columbia</state>
<zip>20008</zip>

In the Val ue text box, type the fol l ow i ng

<address1>4000 Connecticut Ave NW</address1>$\n$<address2>Suite

600</address2>$\n$<city>Washington</city>$\n$<state>District of
Columbia</state>$\n$<zip>20008</zip>

l U se This A dditional K eyword / Value Pair: If thi s check box i s

sel ected, the system i ncl udes a fi nd and repl ace acti on to search for
and repl ace a gi ven keyw ord or phrase. Each of these check boxes
i ncl udes a si ngl e, addi ti onal fi nd and repl ace acti on. For each fi nd
and repl ace acti on that you i ncl ude, you must provi de the fol l ow i ng
i nformati on:

l K eyword: The keyw ord or phrase to search for i n the fi l e. The

search fi nds and repl aces al l i nstances of the keyw ord or phrase
w i thi n the fi l e. You must type the keyw ord or phrase exactl y;
w i l dcard characters cannot be used. If you w ant to repl ace
mul ti pl e l i nes w i thi n the fi l e, you can use $ \ n $ to i ndi cate a l i ne
break.

l Value: The content used to repl ace the keyw ord or phrase. If you
w ant to repl ace a keyw ord w i th mul ti pl e l i nes, you can use $ \ n $
to i ndi cate a l i ne break.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

1191 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Ren amin g a File o r Fo ld er

You can rename a fi l e or fol der as part of a System Manager
w orkfl ow .

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the R ename Files process to
your w orkfl ow . The fol l ow i ng i nformati on i s requi red to rename a fi l e
or fol der:

l Source File or D irectory: The l ocati on of the fi l e or fol der to

rename. C l i ck the fol der i con to brow se to and sel ect a fi l e or fol der.

l N ew N ame of File or D irectory: The new name for the fi l e or fol der.

l A ppend C urrent D ate: D etermi nes w hether the current date i s

automati cal l y added to the end of the new name. The date i s added
i n a YYYY-MM-D D format, such as N e w N a m e -2 0 1 5 -1 2 -2 1 . t x t.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Un zip p in g a Co mp r essed File

You can extract the contents of a compressed fi l e as part of a System
Manager w orkfl ow . The fi l es are extracted to the l ocati on that you
speci fy.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the U nzip Files process to your
w orkfl ow . The fol l ow i ng i nformati on i s requi red to extract the contents
of a compressed fi l e:

l Zip File: The l ocati on of the compressed fi l e to extract, w hi ch can

use ei ther zi p or gzi p format. C l i ck the fol der i con to brow se to and
sel ect a fi l e.

© 2019, M icr o St r at egy In c. 1192

Syst em Ad m in ist r at io n Gu id e

l Output D irectory: The l ocati on of w here the fi l es i n the compressed

fi l e are to be extracted to. C l i ck the fol der i con to brow se to and
sel ect a fol der.

l Overwrite: R epl aces any exi sti ng fi l es i n the output di rectory w i th

the fi l es that are bei ng extracted. If thi s check box i s cl eared and a
fi l e w i th the same name exi sts i n the output di rectory, the fi l e i s not
updated.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Co mp r essin g Files in t o a Zip File

You can compress fi l es and the contents of fol ders i nto a zi p fi l e as
part of a System Manager w orkfl ow . The fi l es are extracted to the
l ocati on that you speci fy.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the Zip Files process to your
w orkfl ow . The fol l ow i ng i nformati on i s requi red to compress fi l es and
fol ders i nto a zi p fi l e:

l Source File or Directory: The location of the file or folders to include in the zip
file. If you select a folder, all of the contents of the folder are included in the zip
file, which includes the subfolders and their content. Click the folder icon to
browse to and select files and folders.

l You can also use wildcard characters (* and ?) to select files or folders to
compress into a zip file. For example, you can use the syntax *.txt to
select all files with the extension .txt in a folder for compression into a zip file.
For additional examples of how you can use these wildcard characters, see
Using Wildcard Characters in Processes, page 1236.

l Output File: The l ocati on and name of the fi nal compressed zi p fi l e.

C l i ck the fol der i con to brow se to and sel ect an exi sti ng zi p fi l e.

1193 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Operations for Output File: D etermi nes how an exi sti ng zi p fi l e i s

updated. If thi s check box i s cl eared and an exi sti ng zi p fi l e i s
found, the zi p fi l e i s not updated and the fi l es are not compressed
i nto a zi p fi l e. If you sel ect thi s check box, you have the fol l ow i ng
opti ons:

l Overwrite: If an exi sti ng zi p fi l e i s found, the ol d versi on i s

compl etel y repl aced by a new zi p fi l e.

l A ppend: If an exi sti ng zi p fi l e i s found, the new fi l es and fol ders

are added to the exi sti ng zi p fi l e.

H ow ever, i f a fol der al ready exi sts i n the same l ocati on i n the zi p
fi l e, i t i s i gnored al ong w i th any contents of the fol der. Thi s means
that i f a fol der has new fi l es, they are not i ncl uded as part of
appendi ng fi l es to the exi sti ng zi p fi l e.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Do wn lo ad in g Files f r o m an FTP o r SFTP Sit e

You can dow nl oad fi l es from an FTP or SFTP si te as part of a System
Manager w orkfl ow . These fi l es are dow nl oaded and saved to a fol der
that you sel ect.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the D ownload using FTP
process to your w orkfl ow . The fol l ow i ng i nformati on i s requi red to
dow nl oad fi l es from an FTP or SFTP si te:

l FTP Server: The U R L for the FTP or SFTP si te. You must al so
defi ne w hether the si te al l ow s anonymous access or requi res a user
name and passw ord:

l Port N umber: The port number to access the FTP or SFTP si te.
By defaul t a val ue of 22 i s expected. Sel ect thi s check box and

© 2019, M icr o St r at egy In c. 1194

Syst em Ad m in ist r at io n Gu id e

type the port number for your FTP or SFTP si te.

l A nonymous: D efi nes the connecti on to the FTP si te as

anonymous. You cannot use thi s opti on i f you are connecti ng to
an SFTP si te. Type an account for the anonymous connecti on,
such as an emai l address.

l Login: D efi nes the connecti on to the FTP or SFTP si te as one

that requi res a user name and passw ord to l og i nto the FTP or
SFTP si te. You must provi de the fol l ow i ng i nformati on:

l U ser N ame: The name of a val i d user for the FTP or SFTP si te.

l Password: The passw ord for the user name that you provi ded to
connect to the FTP or SFTP si te. You can use the button to the
ri ght of the Passw ord fi el d to determi ne w hether the passw ord
characters are show n or asteri sks are di spl ayed i nstead.

l U se SFTP: Encrypts the enti re dow nl oad communi cati on. You
must have a secure FTP si te for thi s encrypti on to w ork
successful l y. If you cl ear thi s check box, the communi cati on i s
not encrypted.

If y ou hav e both an FTP and an SFTP s ite, y ou c an c hoos e to

c lear this c hec k box to us e the FTP s ite, or s elec t this c hec k box
to enc ry pt the c ommunic ation and us e the SFTP s ite. Howev er, if
y ou only hav e an FTP s ite or an SFTP s ite, y our us e of this option
mus t reflec t the ty pe of s ite y ou are us ing.

l D ownload Options: D etermi nes w hether to dow nl oad a si ngl e fi l e

or mul ti pl e fi l es:

l Single File: D ow nl oads a si ngl e fi l e from the FTP or SFTP si te.

Type the l ocati on of the fi l e on the FTP or SFTP si te to dow nl oad.

l Multiple Files: D ow nl oads mul ti pl e fi l es from a di rectory on the

FTP or SFTP si te. You must provi de the fol l ow i ng i nformati on:

1195 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l R emote D irectory: The fol der w i thi n the FTP or SFTP si te to

dow nl oad fi l es from.

l A ll Files: D ow nl oads al l the fi l es di rectl y w i thi n the fol der

sel ected. Subfol ders are not dow nl oaded recursi vel y i f you
sel ect thi s opti on.

l A ll Files A nd Subfolders R ecursively: D ow nl oads al l the fi l es

and subfol ders recursi vel y, w i thi n the fol der sel ected.

l D ownload To D irectory: The l ocati on of the fol der to dow nl oad the
fi l es from the FTP si te to. C l i ck the fol der i con to brow se to and
sel ect a fol der.

l Overwrite: If thi s check box i s sel ected, the system repl aces fi l es
w i th the same name as the fi l es or fol ders dow nl oaded from the FTP
or SFTP si te. If thi s check box i s cl eared and a fi l e or fol der w i th the
same name exi sts on the system, the fi l e or fol der i s not
dow nl oaded from the FTP or SFTP si te.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Up lo ad in g Files t o an FTP o r SFTP Sit e

You can upl oad fi l es to an FTP or SFTP si te as part of a System
Manager w orkfl ow . These fi l es are upl oaded to the FTP or SFTP si te
that you sel ect.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the U pload using FTP process
to your w orkfl ow . The fol l ow i ng i nformati on i s requi red to upl oad fi l es
to an FTP or SFTP si te:

l FTP Server: The U R L for the FTP or SFTP si te. You must al so
defi ne w hether the si te al l ow s anonymous access or requi res a user
name and passw ord:

© 2019, M icr o St r at egy In c. 1196

Syst em Ad m in ist r at io n Gu id e

l Port N umber: The port number to access the FTP or SFTP si te.
By defaul t a val ue of 22 i s expected. Sel ect thi s check box and
type the port number for your FTP or SFTP si te.

l A nonymous: D efi nes the connecti on to the FTP si te as

anonymous. You cannot use thi s opti on i f you are connecti ng to
an SFTP si te. Type an account for the anonymous connecti on,
such as an emai l address.

l Login: D efi nes the connecti on to the FTP or SFTP si te as one

that requi res a user name and passw ord to l og i nto the FTP or
SFTP si te. You must provi de the fol l ow i ng i nformati on:

l U ser N ame: The name of a val i d user for the FTP or SFTP si te.

l Password: The passw ord for the user name that you provi ded to
connect to the FTP or SFTP si te. You can use the button to the
ri ght of the Passw ord fi el d to determi ne w hether the passw ord
characters are show n or asteri sks are di spl ayed i nstead.

l U se SFTP: Encrypts the enti re upl oad communi cati on. You must
have a secure FTP si te for thi s encrypti on to w ork successful l y.
If you cl ear thi s check box, the communi cati on i s not encrypted.

If y ou hav e both an FTP and an SFTP s ite, y ou c an c hoos e to

c lear this c hec k box to us e the FTP s ite, or s elec t this c hec k box
to enc ry pt the c ommunic ation and us e the SFTP s ite. Howev er, if
y ou only hav e an FTP s ite or an SFTP s ite, y our us e of this option
mus t reflec t the ty pe of s ite y ou are us ing.

l U pload Options: D etermi nes w hether to upl oad a si ngl e fi l e or

mul ti pl e fi l es:

l Single File: U pl oads a si ngl e fi l e to the FTP or SFTP si te. C l i ck

the fol der i con to brow se to and sel ect a fi l e.

1197 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Multiple Files: U pl oads mul ti pl e fi l es from a di rectory to the FTP

or SFTP si te. You must provi de the fol l ow i ng i nformati on:

l Local D irectory: The l ocal fol der to upl oad the fi l es from. C l i ck
the fol der i con to brow se to and sel ect a fol der.

l A ll Files: U pl oads al l the fi l es di rectl y w i thi n the fol der

sel ected. Subfol ders are not upl oaded recursi vel y i f you sel ect
thi s opti on.

l A ll Files A nd Subfolders R ecursively: U pl oads al l the fi l es

and subfol ders recursi vel y, w i thi n the fol der sel ected.

l U pload To R emote D irectory: The l ocati on of the fol der to

upl oad the fi l es to i n the FTP or SFTP si te. Type the FTP or SFTP
si te l ocati on.

l Overwrite: If thi s check box i s sel ected, the system repl aces fi l es
w i th the same name as the fi l es or fol ders upl oaded to the FTP or
SFTP si te. If thi s check box i s cl eared and a fi l e or fol der w i th the
same name exi sts on the FTP or SFTP si te, the fi l e or fol der i s not
upl oaded.

l N otes: Informati on to descri be thi s process as part of the

w orkfl ow .

Execu t in g a SQL St at emen t

You can execute a SQL statement agai nst a database as part of a
System Manager w orkfl ow . Thi s l ets you perform tasks such as
updati ng tabl es i n a database.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the Execute SQL process to
your w orkfl ow . The fol l ow i ng i nformati on i s requi red to execute a SQL
statement agai nst a database:

© 2019, M icr o St r at egy In c. 1198

Syst em Ad m in ist r at io n Gu id e

l C onnection Information: D etermi nes w hether to connect usi ng a

data source name (D SN ) or a connecti on stri ng:

l Specify a D SN : D efi nes the connecti on to the database through

the use of a D SN . You must provi de the fol l ow i ng i nformati on:

l D ata Source N ame: The D SN used to access the database.

l A uthentication for D SN : D etermi nes i f authenti cati on i s

i ncl uded as part of the SQL statement. Be aw are that some SQL
statements can requi re speci fi c permi ssi ons, w hi ch means that
authenti cati on w oul d be requi red. Sel ect thi s check box to
authenti cate the connecti on, and suppl y the fol l ow i ng
i nformati on:

l Login: The name of a val i d user for the database.

l Password: The passw ord for the user name that you provi ded
to connect to the database. You can use the button to the ri ght
of the Passw ord fi el d to determi ne w hether the passw ord
characters are show n or asteri sks are di spl ayed i nstead.

l Specify a JD B C C onnection String: D efi nes the connecti on to

the database through the use of a JD BC connecti on stri ng. Type a
val i d connecti on stri ng i n the fi el d provi ded.

l Encoding: From thi s drop-dow n l i st, sel ect the character

encodi ng for the data source you are connecti ng to:

l N on U TF-8: Sel ect thi s opti on i f the data source uses a

character encodi ng other than U TF-8. Thi s can support
character encodi ngs such as U TF-16 and U SC -2. Thi s encodi ng
opti on i s sel ected by defaul t.

l U TF-8: Sel ect thi s opti on i f the data source uses U TF-8
character encodi ng. For exampl e, Teradata databases may
requi re U TF-8 encodi ng.

1199 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Execution: D etermi nes w hether to use a SQL scri pt to suppl y the

SQL statements, or provi de a si ngl e SQL statement di rectl y i n the
w orkfl ow :

l Execute the C ontents of an Input File: U ses a SQL scri pt fi l e to

provi de the SQL statements. The SQL scri pt fi l e can contai n
mul ti pl e SQL statements to be executed. The syntax of the SQL
must be val i d for the database i t i s executed agai nst. C l i ck the
fol der i con to brow se to and sel ect a SQL scri pt fi l e.

l Execute a Single SQL Statement: Lets you type a si ngl e SQL

statement for executi on. The syntax of the SQL must be val i d for
the database i t i s executed agai nst, and the statement must end
w i th a semi col on.

l Save Execution Output Into a File: If thi s check box i s sel ected,
the system saves al l resul ti ng output of executi ng the SQL
statements to the sel ected fi l e. N o output or data i s i ncl uded i n the
fi l e for SQL statements that do not return any output, such as create
tabl e or update tabl e statements. C l i ck the fol der i con to brow se to
and sel ect a fi l e, w hi ch can ei ther be a .txt or .csv fi l e.

If thi s check box i s cl eared, the output of executi ng the SQL

statements i s not saved to a fi l e.

l Include column headers in the output: D etermi nes w hether the

col umn headers are i ncl uded as part of the SQL statement output.
By defaul t, thi s check box i s cl eared and the col umn header
i nformati on i s not i ncl uded i n any output that i s saved for the SQL
statement. Thi s can be hel pful i f you pl an to use the output of a SQL
statement to update the val ue of a parameter i n your System
Manager w orkfl ow .

If you sel ect thi s check box, the col umn header i nformati on i s
provi ded i n the SQL output al ong w i th the associ ated val ues. Thi s
can provi de addi ti onal context to the val ues.

© 2019, M icr o St r at egy In c. 1200

Syst em Ad m in ist r at io n Gu id e

l Output Parameters: As part of executi ng SQL, you can store any

resul ts i n parameters:

l SQL Execution R esult: The resul ti ng output of executi ng the SQL

statements. Sel ect a parameter from the drop-dow n l i st to store
the SQL resul t.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Sen d in g an Email
You can send an emai l as part of a System Manager w orkfl ow . The
emai l can i ncl ude the resul ts of the w orkfl ow , w hi ch can provi de
veri fi cati on of w hat processes have been successful l y compl eted.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the Send Email process to your
w orkfl ow . The fol l ow i ng i nformati on i s requi red to send an emai l :

l From: The emai l address of the sender. For an emai l sent from a
System Manager w orkfl ow , you must type the emai l address of the
person w ho depl oys the w orkfl ow .

l To: The emai l addresses for the i ntended pri mary reci pi ents of the
emai l . U se a comma to separate each emai l address.

l C c: The emai l addresses of the secondary reci pi ents w ho shoul d

recei ve a copy of the emai l addressed to the pri mary reci pi ents.
Sel ect the check box to enter the emai l addresses. U se a comma to
separate each emai l address.

l B cc: The emai l addresses of the reci pi ents w ho shoul d recei ve the
emai l w hi l e conceal i ng thei r emai l address from the other
reci pi ents. Sel ect the check box to enter the emai l addresses. U se a
comma to separate each emai l address.

1201 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Message Subject: The ti tl e of the emai l that i s di spl ayed i n the

subj ect l i ne. Thi s can be used to gi ve a bri ef descri pti on of the
purpose behi nd depl oyi ng the w orkfl ow . Sel ect the check box to
enter the message subj ect.

l Message B ody: The mai n content of the emai l . Thi s can gi ve

addi ti onal detai l s on w hat w as compl eted as part of the w orkfl ow
and next steps for a user or admi ni strator to take. Sel ect the check
box to enter the message content.

l H TML: D efi nes the body content of the emai l to be provi ded i n
H TML format. If you cl ear thi s check box, the content i s provi ded
i n pl ai n text format.

l H igh Importance: D efi nes the emai l as havi ng hi gh i mportance. If

thi s check box i s cl eared, the emai l i s sent w i thout any i mportance
defi ned for the emai l .

l A ttach System Manager Log: If thi s check box i s sel ected, the
system i ncl udes the System Manager l og fi l e as an attachment to
the emai l . Thi s l og fi l e i ncl udes al l the resul ts of the w orkfl ow up to
the ti me of the emai l request. Any processes i n the w orkfl ow that
are compl eted after the emai l request are not i ncl uded i n the l og
fi l e. If thi s check box i s cl eared, the l og fi l e i s not attached to the
emai l .

l A ttach A ny Other File: If thi s check box i s sel ected, the system
i ncl udes a fi l e as an attachment to the emai l . C l i ck the fol der i con to
brow se to and sel ect a fi l e to i ncl ude as an attachment. You can
al so use w i l dcard characters i f the fol der or fi l e name i s not know n
w hen creati ng the w orkfl ow (see U si ng Wi l dcard C haracters i n
Processes, page 1236).

© 2019, M icr o St r at egy In c. 1202

Syst em Ad m in ist r at io n Gu id e

l If you need to send mul ti pl e fi l es, you can do one of the fol l ow i ng:

l C ompress the requi red fi l es i nto a si ngl e fi l e such as a .zi p fi l e.

You can i ncl ude compressi ng fi l es i nto a si ngl e .zi p fi l e as part of
a System Manager w orkfl ow , usi ng the process descri bed i n
C ompressi ng Fi l es i nto a Zi p Fi l e, page 1193.

l U se w i l dcard characters (* and ?) to sel ect mul ti pl e fi l es i n a

fol der. For exampl es of how you can use these w i l dcard
characters, see U si ng Wi l dcard C haracters i n Processes, page
1236.

l Outgoing SMTP Server: If thi s check box i s sel ected, the system
l ets you defi ne the outgoi ng SMTP server to use to send the emai l .
If thi s check box i s cl eared, a defaul t SMTP server i s used to send
the emai l . If you choose to speci fy an SMTP server, you must
provi de the fol l ow i ng i nformati on:

l SMTP Server: The SMTP server to use to send the emai l .

l You must sel ect the type of port used for the SMTP server.
C ontact your SMTP server admi ni strator to determi ne the proper
port type:

l Plain Text: D efi nes the connecti on to the SMTP sever i n pl ai n

text, w i thout usi ng any securi ty protocol . By defaul t, thi s opti on
i s sel ected.

l TLS Port: D efi nes the connecti on to the SMTP server as usi ng
a Transport Layer Securi ty port.

l SSL Port: D efi nes the connecti on to the SMTP server as usi ng
a Secure Sockets Layer port.

l Port N umber: The port number for the SMTP server.

l U ser N ame: The name of a user account that has the necessary
ri ghts to send emai l s usi ng the SMTP server.

1203 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l U ser Password: The passw ord for the user name that you
provi ded to send emai l s usi ng the SMTP server. You can use the
button to the ri ght of the Passw ord fi el d to determi ne w hether the
passw ord characters are show n or asteri sks are di spl ayed
i nstead.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Delayin g a Wo r kf lo w t o Allo w f o r Task Co mp let io n

Whi l e depl oyi ng a System Manager w orkfl ow , some processes can
take a consi derabl e amount of ti me. In certai n scenari os, your
w orkfl ow may need these processes to be compl eted before other
processes i n the w orkfl ow can be started. To support thi s scenari o,
you can i ncl ude a process i n your w orkfl ow to w ai t for a speci fi c
amount of ti me.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the Wait process to your
w orkfl ow . The fol l ow i ng i nformati on i s requi red to del ay the w orkfl ow :

l Waiting Time (sec): The number of seconds to remai n on the

current w ai t process before proceedi ng to the next process i n a
w orkfl ow . Type a numeri c, i nteger val ue to represent the number of
seconds to w ai t before proceedi ng to the next process i n a
w orkfl ow .

You can add addi ti onal ti me to the w ai ti ng process usi ng the

fol l ow i ng opti ons:

You mus t s upply a v alid numeric al v alue for the s ec onds of the wait
proc es s , regardles s of whether y ou define the minutes and hours for
the wait proc es s . You c an ty pe a v alue of z ero ( 0 ) to define the wait
proc es s as a length of time in only minutes and hours .

© 2019, M icr o St r at egy In c. 1204

Syst em Ad m in ist r at io n Gu id e

l Minutes: Sel ect thi s check box to determi ne the number of

mi nutes to remai n on the current w ai t process before proceedi ng
to the next process i n a w orkfl ow . Type a numeri c, i nteger val ue
to represent the number of mi nutes to w ai t before proceedi ng to
the next process i n a w orkfl ow . Thi s ti me i s added to any seconds
or hours al so defi ned for the w ai t process.

l H ours: Sel ect thi s check box to determi ne the number of hours to
remai n on the current w ai t process before proceedi ng to the next
process i n a w orkfl ow . Type a numeri c, i nteger val ue to represent
the number of hours to w ai t before proceedi ng to the next process
i n a w orkfl ow . Thi s ti me i s added to any seconds or mi nutes al so
defi ned for the w ai t process.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Up d at in g Wo r kf lo w Par amet er s
Whi l e depl oyi ng a System Manager w orkfl ow , you can update the
val ues of parameters that are used i n the w orkfl ow . U pdati ng
parameters duri ng w orkfl ow depl oyment can al l ow you to react to
changes made as part of depl oyi ng a w orkfl ow . Thi s techni que can
al so be used to hel p exi t a l oop i n a w orkfl ow that i s used for
troubl eshooti ng purposes, such as checki ng the avai l abi l i ty of an
acti ve Intel l i gence Server.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the U pdate Parameters
process to your w orkfl ow . The fol l ow i ng i nformati on i s requi red to
update parameters for a w orkfl ow :

l Parameter N ame: The name of the w orkfl ow parameter to update.

l R esolve the value from: D etermi nes i f the parameter val ue i s

updated usi ng the contents of a fi l e or a regi stry. If you cl ear thi s
check box, the constant val ue or equati on you provi de i n the N ew

1205 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Val ue fi el d i s used to update the parameter. If you sel ect thi s check
box, you must choose one of the fol l ow i ng:

l File: U pdates the parameter val ue w i th the enti re contents of a

fi l e. If you sel ect thi s opti on, you must type the ful l path to the fi l e
i n the N ew Val ue fi el d. You can use .txt or .csv fi l es to update the
val ue of a parameter.

l R egistry: U pdates the parameter val ue w i th the val ue of a regi stry

key. If you sel ect thi s opti on, you must type the ful l path to the
regi stry key i n the N ew Val ue fi el d.

l N ew Value: The new val ue to assi gn to the parameter. If you

sel ected the R esol ve the val ue from check box l i sted above, you
must type the ful l path to the fi l e or regi stry key.

If the R esolve the value from check box i s cl eared, i n addi ti on to

provi di ng constant val ues such as i ntegers or stri ngs of characters,
you can al so use equati ons to update parameter val ues. To bui l d
these equati ons, you can i ncl ude the parameter's val ue by typi ng
${ P a ra me t e r N a m e} , w here P a r a m e t e r Na m e i s the name of the
parameter that you are updati ng. You can then i ncl ude any of the
ari thmeti c operators +, - , / , and * al ong w i th other numeri c val ues.
For exampl e, you can create a Loop parameter, and update i ts val ue
w i th the fol l ow i ng new val ue equati on:

${Loop} + 1

i t i ncreases the val ue of the Loop parameter by one each ti me the

U pdate Parameters confi gurati on i s processed i n the w orkfl ow . Thi s
type of parameter val ue update supports exi ti ng l oops i n a w orkfl ow
after a certai n number of attempts. For best practi ces on usi ng the
U pdate Parameters process to support l oops i n w orkfl ow s, see
Supporti ng Loops i n a Workfl ow to Attempt C onfi gurati ons Mul ti pl e
Ti mes, page 1116.

© 2019, M icr o St r at egy In c. 1206

Syst em Ad m in ist r at io n Gu id e

l U pdate this additional parameter: D etermi nes i f an addi ti onal

parameter i s updated as part of the parameter update process. For
each U pdate thi s addi ti onal parameter check box you sel ect, you
must type a Parameter N ame and N ew Val ue i n the respecti ve
fi el ds.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Ret r ievin g Mach in e In f o r mat io n

You can retri eve i nformati on about the machi ne that System Manager
i s runni ng on as part of a System Manager w orkfl ow . Each system
property that you retri eve must be stored i n a parameter for the
w orkfl ow (see U si ng Parameters for Processes, page 1228).

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the R etrieve System
Properties process to your w orkfl ow . The fol l ow i ng i nformati on i s
requi red to retri eve i nformati on on the machi ne:

l System property: The i nformati on about the system that i s

retri eved. You can sel ect from the fol l ow i ng opti ons:

l Operating System N ame: The descri pti ve name of the operati ng

system, such as R ed H at Enterpri se Li nux.

l Operating System Version: The versi on number of the operati ng

system. The versi on numberi ng of operati ng systems vari es
greatl y, so i t i s i mportant to al so know the operati ng system name
al ong w i th the operati ng system versi on.

l U ser H ome D irectory: The path that acts as the current user's
home di rectory, w hi ch can be used to store fi l es i f other paths are
restri cted for securi ty reasons.

1207 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l IP A ddress: The IP address of the system, w hi ch can be used to

connect to the system.

l H ostname: The host name of the system, w hi ch can be used to

connect to the system.

l Java Virtual Machine (JVM) bit-size: The si ze al l ow ed for the

Java Vi rtual Machi ne, w hi ch i s al so often referred to as the heap
si ze. Thi s determi nes how much memory can be used to perform
vari ous Java tasks. You can tune thi s val ue to i mprove the
performance of your machi ne.

l Local Machine D ate: The date and ti me for the system. The ti me
i s returned as the ti me zone for the system. If the ti me zone for the
system i s changed, you must restart System Manager to return the
new ti me zone for the machi ne.

l Parameter: The System Manager parameter that i s used to store the

machi ne i nformati on that i s retri eved.

l R etrieve this additional property: Sel ect thi s check box to retri eve
addi ti onal i nformati on about the machi ne. For each of these check
boxes that you sel ect, an addi ti onal System property and Parameter
pai r i s made avai l abl e.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Administering Cloud-Based Environments

If your Mi croStrategy envi ronment i ncl udes cl oud-based
envi ronments, you can create an Amazon Machi ne Image (AMI) and
get i ts status. You can al so l aunch, manage, and termi nate your
cl oud-based envi ronments as part of a System Manager w orkfl ow .

Cr eat in g an Image
You can create an Amazon Machi ne Image (AMI) from an Amazon
EBS-backed i nstance as part of the System Manager w orkfl ow . An

© 2019, M icr o St r at egy In c. 1208

Syst em Ad m in ist r at io n Gu id e

Amazon Machi ne Image i s a templ ate that contai ns the softw are
confi gurati on for your server. Whi l e creati ng an i mage, ensure that the
EBS-backed i nstance i s ei ther runni ng or stopped.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the C reate Image process to
your w orkfl ow . The fol l ow i ng i nformati on i s requi red to create an
Amazon C l oud i mage:

l C redential Properties File: The fi l e that i ncl udes your secretkey

and accesskey for your account. C l i ck the fol der i con to brow se to
and sel ect a credenti al properti es fi l e.

l Existing Instance ID : ID of an Amazon EBS-backed i nstance that i s

ei ther runni ng or stopped.

l N ame: N ame for the new i mage.

l D escription: D escri pti on for the new i mage.

l Set N o R eboot: Sel ect thi s check box to prohi bi t the Amazon EC 2
from shutti ng dow n the Amazon EBS-backed i nstance before
creati ng the new i mage. If you cl ear thi s check box, the Amazon
EC 2 attempts to shut dow n EBS-backed i nstance before creati ng
the new i mage and then restarts the i nstance.

l B lock D evice Mapping: A bl ock devi ce i s a storage devi ce that i s

physi cal l y attached to a computer or accessed remotel y as i f i t w ere
physi cal l y attached to the computer. H ard di sks, C D -R OM dri ves,
and fl ash dri ves are a few exampl es of bl ock devi ces. A bl ock
devi ce mappi ng defi nes the bl ock devi ces to be attached to an AMI.
Thi s argument i s passed i n the form of
de vi ce na m e =b l o c k d e v i c e. Where, d e v i c e n a m e i s the name of
the devi ce w i thi n Amazon EC 2 and b l o c k d e v i c e can be one of
the fol l ow i ng:

1209 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l no ne : To omi t a mappi ng of the devi ce from the AMI used to

l aunch the i nstance, speci fy n o n e. For exampl e:
"/ de v/ sd c = n o n e".

l ep he me ra l N: To add an i nstance store vol ume to the devi ce,

speci fy e p h e m e r a lN , w here N i s the vol ume number. The range
of val i d vol ume numbers i s 0 to 3 . For exampl e:
"/ de v/ sd c = e p h e m er a l 0".

l sn ap sh ot - i d:v o l u m e -s i z e:d e l e t e -o n -
te rm in at i o n:v o l u m e -t y p e:i o p s. Where

l sn ap sh o t -i d i s the ID of the snapshot to use to create the

bl ock devi ce. To add an EBS vol ume (for EBS-backed i nstance
onl y), speci fy the snapshot i d. For exampl e " / d e v / s d h = s n a p-
7e b9 6d 1 6 " .

l vo lu me -s i z e i s the si ze of the vol ume i n GB. To add an empty

EBS vol ume, omi t the snapshot i d and speci fy a vol ume si ze.
For exampl e " / d e v / s d h = : 2 0 0 " .

l de le te -o n -t e r m i n a t i o n i s to i ndi cate w hether the EBS

vol ume shoul d be del eted on termi nati on (t r u e or f a l s e). The
defaul t val ue i s t r u e. To prevent the vol ume from bei ng
del eted on termi nati on of the i nstance, speci fy f a l s e. For
exampl e " / d e v / s d h = s n a p -7 e b 9 6 d 1 6 : : f a l s e " .

l vo lu me -t y p e:i o p s i s the vol ume type (s t a n d a r d or i o 1).

The defaul t val ue i s s t a n d a r d. For exampl e,
"/ de v/ s d h = : s t a n d a r d ". To create a provi si oned
Input/Output Operati ons Per Second (IOPS) vol ume, speci fy
io 1 and the number of IOPS that the vol ume supports. For
exampl e " / d e v / s d h = i o 1 : 5 0 0 " .

All of thes e v ariables are optional. You c an c hoos e to us e any or

all of them. Refer to y our Amaz on third-party doc umentation for

© 2019, M icr o St r at egy In c. 1210

Syst em Ad m in ist r at io n Gu id e

additional ex amples , updates , and information on the bloc k dev ic e

v ariables lis ted below.

l Output Parameters: When a cl oud-based i mage i s created, vari ous

output parameters are provi ded that i ncl ude detai l s about the cl oud-
based envi ronment. It i s recommended that you i ncl ude parameter
(see U si ng Parameters for Processes, page 1228) for the fol l ow i ng
output parameter, so that the val ue can be saved and used for other
processes:

l N ew A MI ID : The new l y created i mage ID for the Amazon Machi ne

Image (AMI).

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Get t in g Clo u d Image St at u s

Once your Amazon C l oud i mage i s created, you can determi ne i ts
state. For exampl e, you can determi ne i f an i mage i s avai l abl e or has
not yet been regi stered.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the Get Image Status process
to your w orkfl ow . The fol l ow i ng i nformati on i s requi red to get the state
of your Amazon C l oud i mage:

l C redential Properties File: The fi l e that i ncl udes your secretkey

and accesskey for your account. C l i ck the fol der i con to brow se to
and sel ect a credenti al properti es fi l e.

l A MI ID : The i mage ID for the Amazon Machi ne Image (AMI) to use

for your cl oud-based envi ronment. Type the i mage ID , w hi ch you
can retri eve from Amazon's cl oud resources.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

1211 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Lau n ch in g Clo u d -Based En vir o n men t s

You can l aunch your Amazon cl oud-based envi ronments as part of a
System Manager w orkfl ow .

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the Launch Instance process
to your w orkfl ow . The fol l ow i ng i nformati on i s requi red to l aunch a
cl oud-based envi ronment:

l C redential Properties File: The fi l e that i ncl udes your secretkey

and accesskey for your account. C l i ck the fol der i con to brow se to
and sel ect a credenti al properti es fi l e.

l A MI ID : The i mage ID for the Amazon Machi ne Image (AMI) to use

for your cl oud-based envi ronment. Type the i mage ID , w hi ch you
can retri eve from Amazon's cl oud resources.

l Instance Type: The i mage type for your cl oud-based envi ronment,
w hi ch determi nes the computi ng capaci ty of the cl oud-based
envi ronment. Sel ect the appropri ate i nstance type from the drop-
dow n l i st.

l Zone: The zone, or netw ork, that the cl oud-based envi ronment i s
l aunched and depl oyed to. Type the name for the zone.

l K ey Pair N ame: Sel ect thi s check box to create the key pai r name,
w hi ch acts as a passw ord to access the cl oud-based envi ronment
once i t i s l aunched. If you cl ear thi s check box, thi s securi ty method
i s not used w i th the cl oud-based envi ronment.

l N ame Tag: Sel ect thi s check box to create a name to di sti ngui sh
the cl oud-based envi ronment. If you cl ear thi s check box, no name
i s provi ded for the cl oud-based envi ronment.

l Security Group: Sel ect thi s check box to create new securi ty
groups or use exi sti ng securi ty groups. U se a semi col on (;) to

© 2019, M icr o St r at egy In c. 1212

Syst em Ad m in ist r at io n Gu id e

separate mul ti pl e securi ty groups. If you cl ear thi s check box, no

securi ty groups are used for the cl oud-based envi ronment.

l Output Parameters: When a cl oud-based envi ronment i s l aunched,

vari ous output parameters are provi ded that i ncl ude detai l s about
the cl oud-based envi ronment. It i s recommended that you i ncl ude
parameters (see U si ng Parameters for Processes, page 1228) for
the fol l ow i ng output parameters, so that the val ues can be saved
and used for other processes:

l Public IP A ddress: The publ i c IP address of the cl oud-based

envi ronment.

l Private IP A ddress: The pri vate IP address of the cl oud-based

envi ronment.

l Instance ID : The i nstance ID of the cl oud-based envi ronment.

Thi s i nstance ID i s requi red to termi nate a cl oud-based
envi ronment (see Termi nati ng C l oud-Based Envi ronments, page
1215).

l Public D N S N ame: The publ i c D omai n N ame System (D N S) name

of the cl oud-based envi ronment, w hi ch i s provi ded upon
l aunchi ng an i nstance. U si ng the Amazon EC 2 consol e, you can
vi ew the publ i c D N S name for a runni ng i nstance.

l Private D N S N ame: The pri vate D omai n N ame System (D N S)

name of the cl oud-based envi ronment, w hi ch i s provi ded upon
l aunchi ng an i nstance. U si ng the Amazon EC 2 consol e, you can
vi ew the pri vate D N S name for a runni ng i nstance.

l N otes: Informati on to descri be thi s process as part of the

w orkfl ow .

1213 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Man agin g Clo u d -Based En vir o n men t s

Once your Amazon cl oud-based envi ronment i s l aunched, you can
start, stop, and force stop the cl oud-based envi ronment as part of a
System Manager w orkfl ow .

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the Manage Instances process
to your w orkfl ow . The fol l ow i ng i nformati on i s requi red to manage a
cl oud-based envi ronment:

l C redential Properties File: The fi l e that i ncl udes your secretkey

and accesskey for your account. C l i ck the fol der i con to brow se to
and sel ect a credenti al properti es fi l e.

l Instance ID : The i nstance ID of the cl oud-based envi ronment.

l A ction: The l i st of acti ons—that i s, start, stop, or force stop—that

can be performed on your cl oud-based envi ronment. Sel ect the
appropri ate acti on from the drop-dow n l i st.

l Output Parameters: When a cl oud-based envi ronment i s l aunched,

vari ous output parameters are provi ded that i ncl ude detai l s about
the cl oud-based envi ronment. It i s recommended that you i ncl ude
parameters (see U si ng Parameters for Processes, page 1228) for
the fol l ow i ng output parameters, so that the val ues can be saved
and used for other processes:

l Public IP A ddress(es): The publ i c IP address of the cl oud-based

envi ronment.

l Private IP A ddress(es): The pri vate IP address of the cl oud-

based envi ronment.

l N otes: Informati on to descri be thi s process as part of the

w orkfl ow .

© 2019, M icr o St r at egy In c. 1214

Syst em Ad m in ist r at io n Gu id e

Ter min at in g Clo u d -Based En vir o n men t s

You can termi nate your Amazon cl oud-based envi ronments as part of
a System Manager w orkfl ow .

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the Terminate Instance
process to your w orkfl ow . The fol l ow i ng i nformati on i s requi red to
termi nate a cl oud-based envi ronment:

l C redential Properties File: The fi l e that i ncl udes your secretkey

and accesskey for your account. C l i ck the fol der i con to brow se to
and sel ect a credenti al properti es fi l e.

l Instance ID : The i nstance ID of the cl oud-based envi ronment.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Cr eat in g a vAp p
You can create a new vApp as part of a System Manager w orkfl ow . A
vApp i s a col l ecti on of one or more vi rtual machi nes that can be
depl oyed as a si ngl e, cl oud-based envi ronment.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the C reate vA pp process to
your w orkfl ow . The fol l ow i ng i nformati on i s requi red to create a vApp:

If y ou are uns ure of any of the option v alues required to c reate a v App,
c ontac t the v Cloud adminis trator for the nec es s ary information.

l vC loud Server N ame: The machi ne name or IP address of a vC l oud

di rector server. The syntax for provi di ng a vC l oud host name i s
Ho st Na me : P o r t N u m be r, w here H o s t N a m e i s the machi ne name
or IP address, and P o rt N u m b e r i s the port number for the host.

1215 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l U ser N ame: The name of a user account that has the necessary
ri ghts to w ork w i th and create vApps.

l Login as A dministrator: Sel ect thi s check box to l og i n to vC l oud

as an admi ni strator.

l Password: The passw ord for the user name that you provi ded to
create the vApp. You can use the button to the ri ght of the Passw ord
fi el d to determi ne w hether the passw ord characters are show n or
asteri sks are di spl ayed i nstead.

l Organization N ame: The organi zati on that authenti cates the user.

l Virtual D atacenter: The name of the vi rtual datacenter that

al l ocates the system resources for a vC l oud envi ronment.

l N ew vA pp N ame: The name that i s used to i denti fy the vApp.

l A dd VM: Sel ect thi s check box to al so create a vi rtual machi ne for
the vApp. If you sel ect thi s check box, you must provi de the
fol l ow i ng i nformati on to create a vi rtual machi ne:

l C atalog N ame: The name of the catal og that stores the templ ate
that you use to create the vi rtual machi ne.

l Template N ame: The name of the templ ate requi red to create the
vi rtual machi ne. A templ ate defi nes the i ni ti al setup and
confi gurati on of a vi rtual machi ne.

l Start the vA pp: D etermi nes i f the vi rtual machi ne and i ts

associ ated vApp are pow ered on so that i t can be used after the
creati on process i s compl eted. Sel ect thi s check box to pow er on
the vi rtual machi ne and i ts associ ated vApp. If you do not sel ect
thi s opti on, you can use the Manage VM process to pow er on the
vi rtual machi ne at a l ater ti me (see Starti ng, Stoppi ng, and
R estarti ng a Vi rtual Machi ne, page 1218).

© 2019, M icr o St r at egy In c. 1216

Syst em Ad m in ist r at io n Gu id e

l N otes: Informati on to descri be thi s process as part of the

w orkfl ow .

St ar t in g, St o p p in g, an d Rest ar t in g a vAp p
Once a vApp i s created, you can start, stop, and restart the vApp as
part of a System Manager w orkfl ow . A vApp must be pow ered on for
users to access and w ork w i th a vApp. You may need to pow er off or
shut dow n a vApp to perform vari ous admi ni strati ve mai ntenance on
the vApp.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the Manage vA pp process to
your w orkfl ow . The fol l ow i ng i nformati on i s requi red to manage a
vApp:

If y ou are uns ure about any of the option v alues required to manage a
v App, c ontac t the v Cloud adminis trator for the nec es s ary information.

l vC loud Server N ame: The machi ne name or IP address of a vC l oud

di rector server. The syntax for provi di ng a vC l oud host name i s
Ho st Na me : P o r t N u m be r, w here H o s t N a m e i s the machi ne name
or IP address, and P o rt N u m b e r i s the port number for the host.

l U ser N ame: The name of a user account that has the necessary
ri ghts to w ork w i th vApps.

l Login as A dministrator: Sel ect thi s check box to l og i n to vC l oud

as an admi ni strator.

l Password: The passw ord for the user name that you provi ded to
create the vApp. You can use the button to the ri ght of the Passw ord
fi el d to determi ne w hether the passw ord characters are show n or
asteri sks are di spl ayed i nstead.

l Organization N ame: The organi zati on that authenti cates the user.

1217 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l A ction: The type of acti on to perform on the vApp. Acti ons

performed on a vApp affect the avai l abi l i ty of al l vi rtual machi nes
i ncl uded i n the vApp. You can sel ect one of the fol l ow i ng acti ons:

l Start: Starts a vApp so that users can access and w ork w i th a

vApp.

l Stop: Stops a vApp through a vC l oud request, w hi ch makes the

vApp unavai l abl e to users. Thi s type of vC l oud pow er off request
can be moni tored by the vC l oud system to determi ne the success
or fai l ure of the acti on.

l Virtual D atacenter: The name of the vi rtual datacenter that

al l ocates the system resources for a vC l oud envi ronment.

l vA pp N ame: The name of the vApp to start, stop, or restart.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

St ar t in g, St o p p in g, an d Rest ar t in g a Vir t u al Mach in e

Once a vApp i s created, you can start, stop, and restart a vi rtual
machi ne that i s i ncl uded i n a vApp as part of a System Manager
w orkfl ow . A vi rtual machi ne must be pow ered on for users to access
and w ork w i th a vi rtual machi ne. You may need to pow er off or shut
dow n a vi rtual machi ne to perform vari ous admi ni strati ve mai ntenance
tasks on the vi rtual machi ne.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the Manage VM process to your
w orkfl ow . The fol l ow i ng i nformati on i s requi red to manage a vi rtual
machi ne:

If y ou are uns ure about any of the option v alues required to manage a
v irtual mac hine, c ontac t the v Cloud adminis trator for the nec es s ary
information.

© 2019, M icr o St r at egy In c. 1218

Syst em Ad m in ist r at io n Gu id e

l vC loud Server N ame: The machi ne name or IP address of a vC l oud

di rector server. The syntax for provi di ng a vC l oud host name i s
Ho st Na me : P o r t N u m be r, w here H o s t N a m e i s the machi ne name
or IP address, and P o rt N u m b e r i s the port number for the host.

l U ser N ame: The name of a user account that has the necessary
ri ghts to w ork w i th vApps and vi rtual machi nes.

l Login as A dministrator: Sel ect thi s check box to l og i n to vC l oud

as an admi ni strator.

l Password: The passw ord for the user name that you provi ded to
create the vApp. You can use the button to the ri ght of the Passw ord
fi el d to determi ne w hether the passw ord characters are show n or
asteri sks are di spl ayed i nstead.

l Organization N ame: The organi zati on that authenti cates the user.

l A ction: The type of acti on to perform on the vi rtual machi ne. You
can sel ect one of the fol l ow i ng acti ons:

l Power on: Starts a vi rtual machi ne so that users can access and
w ork w i th the vi rtual machi ne.

l Power off: Stops a vi rtual machi ne through a vC l oud request,

w hi ch makes the vi rtual machi ne unavai l abl e to users. Thi s type
of vC l oud pow er off request can be moni tored by the vC l oud
system to determi ne the success or fai l ure of the acti on.

l Virtual D atacenter: The name of the vi rtual datacenter that

al l ocates the system resources for a vC l oud envi ronment.

l vA pp N ame: The name of the vApp that contai ns the vi rtual

machi ne to start, stop, or restart.

l VM N ame: The name of the vi rtual machi ne w i thi n the vApp to start,
stop, or restart.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

1219 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Du p licat in g a vAp p
You can dupl i cate a vApp as part of a System Manager w orkfl ow . A
vApp i s a col l ecti on of one or more vi rtual machi nes, w hi ch can be
depl oyed as a si ngl e cl oud-based envi ronment.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the C opy vA pp process to your
w orkfl ow . The fol l ow i ng i nformati on i s requi red to dupl i cate a vApp:

If y ou are uns ure about any of the option v alues required to duplic ate a
v App, c ontac t the v Cloud adminis trator for the nec es s ary information.

l vC loud Server N ame: The machi ne name or IP address of a vC l oud

di rector server. The syntax for provi di ng a vC l oud host name i s
Ho st Na me : P o r t N u m be r, w here H o s t N a m e i s the machi ne name
or IP address, and P o rt N u m b e r i s the port number for the host.

l U ser N ame: The name of a user account that has the necessary
ri ghts to w ork w i th and create vApps.

l Login as A dministrator: Sel ect thi s check box to l og i n to vC l oud

as an admi ni strator.

l Password: The passw ord for the user name that you provi ded to
create the vApp. You can use the button to the ri ght of the Passw ord
fi el d to determi ne w hether the passw ord characters are show n or
asteri sks are di spl ayed i nstead.

l Organization N ame: The organi zati on that authenti cates the user.

l Virtual D atacenter: The name of the vi rtual datacenter that

al l ocates the system resources for a vC l oud envi ronment.

l Source vA pp N ame: The name of the vApp to dupl i cate.

l D estination vA pp N ame: The name for the dupl i cate copy of the
vApp.

© 2019, M icr o St r at egy In c. 1220

Syst em Ad m in ist r at io n Gu id e

l Start the vA pp: D etermi nes i f the dupl i cate copy of the vApp i s
pow ered on so that i t can be used after the dupl i cati on process i s
compl eted. Sel ect thi s check box to pow er on the vApp. If you do
not sel ect thi s opti on, you can use the Manage vApp process to
pow er on the vApp at a l ater ti me (see Starti ng, Stoppi ng, and
R estarti ng a vApp, page 1217).

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Delet in g a vAp p
You can del ete a vApp as part of a System Manager w orkfl ow . A vApp
i s a col l ecti on of one or more vi rtual machi nes, w hi ch can be
depl oyed as a si ngl e cl oud-based envi ronment.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the D elete vA pp process to
your w orkfl ow . The fol l ow i ng i nformati on i s requi red to del ete a vApp:

If y ou are uns ure about any of the option v alues required to delete a
v App, c ontac t the v Cloud adminis trator for the nec es s ary information.

l vC loud Server N ame: The machi ne name or IP address of a vC l oud

di rector server. The syntax for provi di ng a vC l oud host name i s
Ho st Na me : P o r t N u m be r, w here H o s t N a m e i s the machi ne name
or IP address, and P o rt N u m b e r i s the port number for the host.

l U ser N ame: The name of a user account that has the necessary
ri ghts to w ork w i th and del ete vApps.

l Login as A dministrator: Sel ect thi s check box to l og i n to vC l oud

as an admi ni strator.

l Password: The passw ord for the user name that you provi ded to
create the vApp. You can use the button to the ri ght of the Passw ord

1221 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

fi el d to determi ne w hether the passw ord characters are show n or

asteri sks are di spl ayed i nstead.

l Organization N ame: The organi zati on that authenti cates the user.

l Virtual D atacenter: The name of the vi rtual datacenter that

al l ocates the system resources for a vC l oud envi ronment.

l vA pp N ame: The name of the vApp to del ete.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Delet in g a Vir t u al Mach in e

You can del ete a vi rtual machi ne that i s part of a vApp as part of a
System Manager w orkfl ow .

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the D elete VM process to your
w orkfl ow . The fol l ow i ng i nformati on i s requi red to del ete a vi rtual
machi ne:

If y ou are uns ure of any of the option v alues required to delete a v irtual
mac hine, c ontac t the v Cloud adminis trator for the nec es s ary
information.

l vC loud Server N ame: The machi ne name or IP address of a vC l oud

di rector server. The syntax for provi di ng a vC l oud host name i s
Ho st Na me : P o r t N u m be r, w here H o s t N a m e i s the machi ne name
or IP address, and P o rt N u m b e r i s the port number for the host.

l U ser N ame: The name of a user account that has the necessary
ri ghts to w ork w i th and del ete vi rtual machi nes w i thi n vApps.

l Login as A dministrator: Sel ect thi s check box to l og i n to vC l oud

as an admi ni strator.

© 2019, M icr o St r at egy In c. 1222

Syst em Ad m in ist r at io n Gu id e

l Password: The passw ord for the user name that you provi ded to
create the vApp. You can use the button to the ri ght of the Passw ord
fi el d to determi ne w hether the passw ord characters are show n or
asteri sks are di spl ayed i nstead.

l Organization N ame: The organi zati on that authenti cates the user.

l Virtual D atacenter: The name of the vi rtual datacenter that

al l ocates the system resources for a vC l oud envi ronment and
i ncl udes the vApp that hosts the vi rtual machi ne to be del eted.

l vA pp N ame: The name of the vApp that hosts the vi rtual machi ne
that i s to be del eted.

l VM N ame: The name of the vi rtual machi ne to del ete.

l N otes: Informati on to descri be thi s process as part of the w orkfl ow .

Cr eat in g a Vir t u al Mach in e

You can create a new vi rtual machi ne and i ncl ude i t i n a vApp as part
of a System Manager w orkfl ow . A vApp i s a col l ecti on of one or more
vi rtual machi nes that can be depl oyed as a si ngl e, cl oud-based
envi ronment.

To perform thi s confi gurati on, i n System Manager, from the

C onnectors and processes pane, add the A dd VM process to your
w orkfl ow . The fol l ow i ng i nformati on i s requi red to create a vi rtual
machi ne:

If y ou are uns ure of any of the option v alues required to c reate a v irtual
mac hine within a v App, c ontac t the v Cloud adminis trator for the
nec es s ary information.

l vC loud Server N ame: The machi ne name or IP address of a vC l oud

di rector server. The syntax for provi di ng a vC l oud host name i s

1223 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Ho st Na me : P o r t N u m be r, w here H o s t N a m e i s the machi ne name

or IP address, and P o rt N u m b e r

l U ser N ame: The name of a user account that has the necessary
ri ghts to w ork w i th and create vApps.

l Login as A dministrator: Sel ect thi s check box to l og i n to vC l oud

as an admi ni strator.

l Password: The passw ord for the user name that you provi ded to
create the vApp. You can use the button to the ri ght of the Passw ord
fi el d to determi ne w hether the passw ord characters are show n or
asteri sks are di spl ayed i nstead.

l Organization N ame: The organi zati on that authenti cates the user.

l Source: These opti ons determi ne i f the new vi rtual machi ne i s

created as a dupl i cate of an exi sti ng vi rtual machi ne or a new
vi rtual machi ne i s created usi ng a templ ate:

l From vA pp: Thi s opti on dupl i cates a vi rtual machi ne that al ready
exi sts i n the vApp:

l Virtual D atacenter: The name of the vi rtual datacenter that

al l ocates the system resources for a vC l oud envi ronment, and
i ncl udes the vApp that hosts the vi rtual machi ne to be
dupl i cated.

l vA pp N ame: The name of the vApp that i ncl udes the vi rtual
machi ne to dupl i cate.

l From template: Thi s opti on creates a new vi rtual machi ne, usi ng
a templ ate defi ni ti on. A templ ate defi nes the i ni ti al setup and
confi gurati on of a vi rtual machi ne:

l C atalog N ame: The name of the catal og that stores the templ ate
that you use to create the vi rtual machi ne.

© 2019, M icr o St r at egy In c. 1224

Syst em Ad m in ist r at io n Gu id e

l Template N ame: The name of the templ ate requi red to create
the vi rtual machi ne.

l VM N ame: The name of the vi rtual machi ne to dupl i cate from a

vApp or create from a templ ate.

l D estination: These opti ons determi ne w here the new vi rtual

machi ne i s created:

l Virtual D atacenter: The name of the vi rtual datacenter that

al l ocates the system resources for a vC l oud envi ronment and
i ncl udes the vApp that w i l l host the new vi rtual machi ne.

l vA pp N ame: The name of the vApp that w i l l host the new vi rtual
machi ne.

l C onfigure N ew VM: These opti ons determi ne addi ti onal detai l s

about the new vi rtual machi ne:

l Full N ame: The name for the vi rtual machi ne that i s created.

l C omputer N ame: Sel ect thi s check box to provi de the host name
of the new vi rtual machi ne. If you cl ear thi s check box, the name
that you speci fi ed for Ful l N ame i s al so used for thi s host name.

l Local A dministrator Password: Sel ect thi s check box to provi de

an admi ni strator passw ord for the vi rtual machi ne. If you cl ear thi s
check box, a passw ord i s generated or the passw ord i n the
templ ate used to create the vi rtual machi ne i s used.

l A dministrator Password: The passw ord for the admi ni strator.

You can use the button to the ri ght of the Passw ord fi el d to
determi ne w hether the passw ord characters are show n or
asteri sks are di spl ayed i nstead.

1225 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l N umber of Times to A uto Logon: The number of ti mes the

admi ni strator can start the VM w i thout reenteri ng the l ogi n
i nformati on.

l R equire A dministrator to C hange Password on First Login:

Sel ect thi s check box to requi re that the Admi ni strator changes
the passw ord upon the fi rst l ogi n.

l N etwork and IP A ssignment: Sel ect thi s check box to provi de a

netw ork name and determi ne how IP addresses are assi gned.
Thi s hel ps to ensure that mul ti pl e vi rtual machi nes do not use the
same IP address, w hi ch can cause IP confl i ct i ssues i n your
vC l oud system. If you cl ear thi s check box, the netw ork and IP
assi gnment confi gurati on i s determi ned by the templ ate used to
create the vi rtual machi ne. When sel ecti ng thi s check box, type
the name of the netw ork i n the N etwork N ame fi el d, and sel ect
one of the fol l ow i ng IP assi gnment opti ons:

l D H C P: The IP address i s assi gned dynami cal l y by a D H C P

servi ce on the speci fi ed netw ork.

l Static IP Pool: A si ngl e, stati c IP address i s al l ocated

automati cal l y from a col l ecti on of IP addresses for the netw ork.

l Static Manual: A si ngl e, stati c IP address i s al l ocated. You

must type the IP address i n the text fi el d. Ensure that the IP
address i s val i d for your netw ork.

l Output Parameters: As part of the vi rtual machi ne creati on

process, you can store i mportant i nformati on about the new vi rtual
machi ne i n parameters:

l Public IP A ddress: The IP address used to access the new

vi rtual machi ne. Sel ect a parameter from the drop-dow n l i st to
store the i nformati on i n that parameter.

© 2019, M icr o St r at egy In c. 1226

Syst em Ad m in ist r at io n Gu id e

l C omputer N ame: The host name for the new vi rtual machi ne.
Sel ect a parameter from the drop-dow n l i st to store the i nformati on
i n that parameter.

l Local A dministrator Password: The admi ni strator passw ord for

the vi rtual machi ne. Sel ect a parameter from the drop-dow n l i st to
store the i nformati on i n that parameter.

l N otes: Informati on to descri be thi s process as part of the

w orkfl ow .

Determining Process Resolution Using Exit Codes

System Manager w orkfl ow s often requi re i nformati on about the
resol uti on of a process to determi ne the next step to fol l ow i n the
w orkfl ow . An exi t code i s provi ded w hen a process that i s part of a
System Manager w orkfl ow comes to compl eti on. Thi s exi t code
provi des i nformati on on w hether the process w as successful .

Al ong w i th determi ni ng the success or fai l ure of a process, an exi t

code can al so provi de addi ti onal i nformati on on w hy the process w as
a success or a fai l ure.

Whi l e provi di ng the i nformati on for a process, you can revi ew the exi t
codes for a process. On the Properti es pane, scrol l dow n to the
bottom and cl i ck Show D escription, as show n i n the i mage bel ow .

D etai l ed i nformati on on each exi t code for a process i s di spl ayed.

1227 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

The exi t codes for a custom process are dependent on that custom
process. R efer to any documentati on rel ated to the custom process to
determi ne possi bl e exi t codes.

You can use these exi t codes to determi ne the next step to take i n a
w orkfl ow :

l U si ng the success and fai l ure connectors l ets you gui de the
w orkfl ow based on w hether the process w as compl eted w i th a
success or fai l ure exi t code. For addi ti onal i nformati on on how
connectors determi ne the l ogi cal order of a w orkfl ow based on the
exi t code of the process they are comi ng from, see U si ng
C onnectors to C reate the Logi cal Order of a Workfl ow , page 1090.

l U si ng a deci si on process, you can gui de the w orkfl ow accordi ng to

error codes rather than j ust w hether the process w as consi dered
successful or unsuccessful . Thi s can hel p to support addi ti onal
troubl eshooti ng and error checki ng duri ng a w orkfl ow . For exampl es
of how deci si ons can be used to gui de a w orkfl ow on more than j ust
the success or fai l ure of a process, see U si ng D eci si ons to
D etermi ne the N ext Step i n a Workfl ow , page 1094.

Using Parameters for Processes

Whi l e al l the necessary confi gurati on i nformati on can be provi ded for
each process, some scenari os requi re that the detai l s about the
process be provi ded w hen the w orkfl ow i s executed. Thi s can be
requi red for the scenari os l i sted bel ow :

l Stori ng user credenti al s w i thi n System Manager i ntroduces a

securi ty ri sk.

l C onfi gurati on i nformati on i s not know n unti l or duri ng the actual

confi gurati on.

To provi de a fl exi bl e sol uti on to these types of probl ems, System

Manager l ets you defi ne parameters as part of your w orkfl ow . These
parameters can be used to defi ne confi gurati on i nformati on for the

© 2019, M icr o St r at egy In c. 1228

Syst em Ad m in ist r at io n Gu id e

processes supported by System Manager. The val ues of these

parameters can be provi ded as part of the w orkfl ow , as part of a
parameters fi l e to execute the w orkfl ow , and as i nput from the user
performi ng the w orkfl ow from the command l i ne.

Cr eat in g Par amet er s f o r a Wo r kf lo w

A w orkfl ow has one set of parameters that i s shared for al l processes.
The parameters that are created for a w orkfl ow can be used i n any
confi gurati on task that can accept parameters as val ues i n a process.
Parameters can al so be used i n deci si ons i n a w orkfl ow .

The steps bel ow show you how to create parameters for a w orkfl ow .

To Create Parameters for a Workflow

Thi s procedure assumes you are creati ng new parameters for a

w orkfl ow . For i nformati on on i mporti ng parameters for a w orkfl ow , see
Importi ng Parameters i nto a Workfl ow , page 1231.

1. Open System Manager.

l To open System Manager i n a Wi ndow s envi ronment:

1. Start > A ll Programs > MicroStrategy Products >

System Manager.

l To open System Manager i n a U N IX or Li nux envi ronment:

1. In a Li nux consol e w i ndow , brow se to H O M E _P A T H w here

HO M E _P A T H i s the speci fi ed home di rectory duri ng
i nstal l ati on.

2. Brow se to the fol der b i n.

1229 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

3. Type m s t r s y s m g r w, and then press Enter.

The System Manager home page i s di spl ayed.

2. Expand the Properties and parameters pane on the ri ght si de of

System Manager, and cl i ck Parameters near the bottom.

3. C l i ck A dd new parameter (di spl ayed as a green pl us symbol ) to

create a new parameter. N ame and Val ue fi el ds are di spl ayed.

4. Type the fol l ow i ng i nformati on:

l N ame: The name for the parameter. Thi s i s the name that i s
used to i denti fy the parameter i n a process or deci si on w i thi n
the w orkfl ow .

l Value: The val ue that i s used i n pl ace of the parameter w hen

the w orkfl ow i s executed. Thi s w orks as the defaul t val ue for
the parameter i f no val ue for the parameter i s gi ven from the
command l i ne w hen the w orkfl ow i s executed. For i nformati on
on the precedence of provi di ng val ues for parameters, see
Provi di ng Parameter Val ues duri ng D epl oyment of a Workfl ow ,
page 1234.

If the parameter provi des sensi ti ve i nformati on such as user

passw ords, you can l eave the val ue bl ank. H ow ever, be aw are
that these parameters must be provi ded a val ue w hen the
w orkfl ow i s executed.

l C onfidential: Sel ect the check box to turn off any l oggi ng and
feedback i nformati on for parameter val ues that are updated by
a process i n your w orkfl ow (defi ned as an output parameter of
a process). For exampl e, i f you save the resul t of a SQL
executi on to a parameter, thi s resul t i s hi dden from any System
Manager l ogs. If the parameter val ue for a confi denti al
parameter has to be show n i n the feedback consol e, i t i s

© 2019, M icr o St r at egy In c. 1230

Syst em Ad m in ist r at io n Gu id e

di spl ayed as asteri sks i nstead of the actual val ue. For
i nformati on on the feedback consol e, see U si ng System
Manager to Test and D epl oy a Workfl ow , page 1238.

5. Once a parameter i s created i n a w orkfl ow , you can use i t i n a

w orkfl ow , as descri bed i n U si ng Parameters i n a Workfl ow , page
1234. You can al so use the U pdate Parameters process (see
Performi ng System Processes, page 1181) to update the val ue of
a parameter duri ng the depl oyment of a w orkfl ow .

Importing Parameters into a Workflow

You can i mport parameters i nto a w orkfl ow that have been saved as a
parameters response fi l e. Thi s l ets you update the val ues for your
w orkfl ow .

When parameters are i mported i nto a w orkfl ow , any exi sti ng

parameters are updated w i th the val ues i ncl uded i n the parameters
fi l e. Parameters can onl y be updated w hen i mporti ng a parameters
fi l e. Thi s means that i f a parameter does not al ready exi st i n a
w orkfl ow , i t i s not created w hen i mporti ng the parameters fi l e.

Addi ti onal l y, i f parameters are i n the w orkfl ow that are not defi ned i n
the parameters fi l e, the val ue for the parameters i s not updated duri ng
the i mport process.

The work flow y ou are importing parameters for already has parameters
defined for it. Only thes e parameters c an be updated by importing a
parameters file.

1231 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To Import Parameters into a Workflow

1. Open System Manager.

l To open System Manager i n a Wi ndow s envi ronment:

1. Start > A ll Programs > MicroStrategy Products >

System Manager.

l To open System Manager i n a U N IX or Li nux envi ronment:

1. In a Li nux consol e w i ndow , brow se to H O M E _P A T H w here

HO M E _P A T H i s the speci fi ed home di rectory duri ng
i nstal l ati on.

2. Brow se to the fol der b i n.

3. Type m s t r s y s m g r w, and then press Enter.

The System Manager home page i s di spl ayed.

2. Expand the Properties and parameters pane on the ri ght si de of

System Manager, and cl i ck Parameters near the bottom.

3. From the Workflow menu, sel ect Import Parameter File.

4. Sel ect the parameters fi l e to i mport and cl i ck Open. You are

returned to System Manager and the parameters are updated
accordi ngl y. If the changes are not w hat you expected, you can
cl i ck C lear to undo al l the parameter updates.

Exporting Parameters to a File

You can export the parameters i n a w orkfl ow to a fi l e. Thi s fi l e can

serve vari ous purposes:

© 2019, M icr o St r at egy In c. 1232

Syst em Ad m in ist r at io n Gu id e

l You can i mport parameters i nto other w orkfl ow s.

l You can modi fy the parameter fi l e and appl y updates to the ori gi nal
w orkfl ow .

l You can modi fy the parameter fi l e and i ncl ude i t duri ng executi on to
make changes j ust before executi on.

l You can modi fy the parameter fi l e to i ncl ude comments, w hi ch can

provi de addi ti onal i nformati on on the parameters and thei r val ues.
To i ncl ude a comment i n a parameters fi l e you can use the
characters / / or # to denote a l i ne i n the parameters fi l e as a
comment. Any l i ne that begi ns w i th ei ther / / or # i s i gnored w hen
usi ng the parameters fi l e w i th System Manager.

The steps bel ow show you how to export the parameters of a w orkfl ow
to a fi l e.

To Export Parameters of a Workflow to a File

1. Open System Manager.

l To open System Manager i n a Wi ndow s envi ronment:

1. Start > A ll Programs > MicroStrategy Products >

System Manager.

l To open System Manager i n a U N IX or Li nux envi ronment:

1. In a Li nux consol e w i ndow , brow se to H O M E _P A T H w here

HO M E _P A T H i s the speci fi ed home di rectory duri ng
i nstal l ati on.

2. Brow se to the fol der b i n.

3. Type m s t r s y s m g r w, and then press Enter.

The System Manager home page i s di spl ayed.

2. From the Workflow menu, sel ect Export Parameter File.

1233 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

3. In the File name fi el d, type a name for the parameters fi l e.

4. C l i ck Save.

Usin g Par amet er s in a Wo r kf lo w

Parameters can be used i n processes or deci si ons of a w orkfl ow to
provi de fl exi bi l i ty as to w hen the i nformati on i s provi ded.

Parameters can be i ncl uded i n any opti on that takes some type of text
or numeri c data as i nput. For exampl e, a Passw ord fi el d can take a
parameter that suppl i es a passw ord to access the task or system
resource for a process. H ow ever, check boxes and any other opti ons
that do not accept text or numeri c data cannot use parameters.

To use a parameter i n a process or deci si on, you must use the

fol l ow i ng syntax:

${ Pa ra me t e r N a m e}

In the syntax l i sted above, P a r a m e t e r N a m e i s the name of the

parameter. D uri ng executi on, thi s i s repl aced w i th the val ue for the
parameter.

The val ues for parameters can be provi ded i n a few di fferent w ays.
For i nformati on on how parameter val ues can be provi ded and the
precedence of each opti on, see Provi di ng Parameter Val ues duri ng
D epl oyment of a Workfl ow , page 1234 bel ow .

Providing Parameter Values during Deployment of a Workflow

The val ue for a parameter can be provi ded i n the fol l ow i ng w ays:

l When defi ni ng the parameters for the w orkfl ow . These val ues act as
the defaul t val ue of the parameter.

l In a parameters fi l e. Thi s fi l e can be used duri ng the executi on of a

w orkfl ow to provi de updated val ues for the parameters.

© 2019, M icr o St r at egy In c. 1234

Syst em Ad m in ist r at io n Gu id e

l From the command l i ne duri ng executi on of a w orkfl ow . Thi s l ets the

user executi ng the process provi de sensi ti ve i nformati on such as
user passw ords on the command l i ne rather than savi ng them i n a
w orkfl ow .

l You can al so use the U pdate Parameters process (see Performi ng

System Processes, page 1181) to update the val ue of a parameter
duri ng the depl oyment of a w orkfl ow .

When a w orkfl ow i s executed, parameters are repl aced w i th thei r

respecti ve val ues, as descri bed bel ow :

l If the val ue for a parameter i s provi ded from the command l i ne

duri ng executi on, thi s val ue i s used. Any val ues for the parameter
provi ded i n a parameters fi l e or defaul t val ues provi ded i n the
w orkfl ow are i gnored.

l If the val ue for a parameter i s not provi ded from the command l i ne
duri ng executi on, but a val ue for the parameter i s provi ded i n a
parameters fi l e, the val ue from the parameters fi l e i s used. The
defaul t val ue provi ded i n the w orkfl ow i s i gnored.

l If the val ue for a parameter i s not provi ded i n a parameters fi l e or

from the command l i ne duri ng executi on, the defaul t val ue provi ded
w hen defi ni ng a parameter i n a w orkfl ow i s used.

The i mage bel ow summari zes how the val ue of a parameter i s

determi ned w hen executi ng a w orkfl ow :

1235 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Using Wildcard Characters in Processes

System Manager al l ow s you to use w i l dcard characters to provi de
confi gurati on i nformati on for some of the processes possi bl e w i th a
System Manager w orkfl ow . U si ng w i l dcard characters to provi de
confi gurati on i nformati on for processes i n a System Manager
w orkfl ow can al l ow you to:

l R efer to fol ders or fi l es that do not exi st yet or do not have know n
names. For exampl e, a fi l e or fol der can be created as part of the
same System Manager w orkfl ow . If the ful l name of the fi l e or fol der
i s not know n (for exampl e, the fi l e name i tsel f mi ght i ncl ude
creati on ti me i nformati on) you can use w i l dcard characters to refer
to the expected fi l e or fol der.

l Sel ect mul ti pl e fi l es for a si ngl e process, such as attachi ng mul ti pl e

fi l es to an emai l . For exampl e, rather than l i sti ng a si ngl e fi l e, you
can use w i l d cards to sel ect al l .txt fi l es i n a fol der.

System Manager processes that support w i l d cards as part of thei r

confi gurati on i ncl ude:

© 2019, M icr o St r at egy In c. 1236

Syst em Ad m in ist r at io n Gu id e

l Sendi ng an emai l (see Performi ng System Processes, page 1181)

l D el eti ng fi l es or fol ders (see Performi ng System Processes, page

1181)

l Movi ng fi l es (see Performi ng System Processes, page 1181)

l C opyi ng fi l es (see Performi ng System Processes, page 1181)

l C ompressi ng fi l es i nto a zi p fi l e (see Performi ng System Processes,

page 1181)

For the confi gurati ons of a System Manager process that can use
w i l dcard characters, the fol l ow i ng characters are supported:

l The * (asteri sk) character: You can use * to represent one or more
characters. Some exampl es of how you can use thi s w i l dcard
character i ncl ude:

l *.txt

This syntax would search for and select all .txt files in a given folder.

l filename.*

This syntax would search for and select all files, regardless of file extension,
with the name filename.

l *.*

This syntax would select all files in a given folder.

l *

This syntax would search for and select all files and folders in a given folder.

l The ? (questi on mark) character: You can use ? to represent any

si ngl e character. Some exampl es of how you can use thi s w i l dcard
character i ncl ude:

1237 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l filename?.ini

This syntax would search for and select all .ini files with the name
filename and a single character. For example, the syntax config?.ini
would select files such as config1.ini, configA.ini, and so on.

l filename.??

This syntax would search for and select all files with the name filename
and any two character file extension.

You c an als o us e a c ombination of both * and ? wildc ard c harac ters .

Deploying a Workflow
Once you create a w orkfl ow , you can depl oy the w orkfl ow to attempt
the processes that are i ncl uded i n the w orkfl ow . System Manager
provi des the fol l ow i ng methods for depl oyi ng a w orkfl ow :

l U si ng System Manager to Test and D epl oy a Workfl ow , page 1238:

System Manager's i nterface can be used to test and depl oy a
w orkfl ow .

l U si ng the C ommand Li ne to D epl oy a Workfl ow , page 1242: System

Manager's command l i ne versi on can be used to depl oy a w orkfl ow
w i thout the use of an i nterface. Thi s can be benefi ci al for si l ent
confi gurati on routi nes and OEM depl oyments.

Using System Manager to Test and Deploy a Workflow

Once you create a w orkfl ow usi ng System Manager, you can use the
same System Manager i nterface to test and depl oy a w orkfl ow .

Be aw are that some processes are dependent on the machi ne that

you use to depl oy the w orkfl ow . For exampl e, i f you i ncl ude
processes to create D SN s, the D SN s are created on the machi ne that
you use to depl oy the w orkfl ow .

© 2019, M icr o St r at egy In c. 1238

Syst em Ad m in ist r at io n Gu id e

The steps bel ow show you how to depl oy a w orkfl ow from w i thi n
System Manager.

You hav e c reated a work flow and s av ed it in a loc ation that c an be

ac c es s ed from the mac hine that y ou are deploy ing the work flow on. Steps
to c reate a work flow are prov ided in C reati ng a Workfl ow , page 1079 .

Sy s tem Manager is ins talled. This tool is ins talled as part of the general
Mic roStrategy produc t s uite.

You hav e ins talled any Mic roStrategy produc ts and c omponents that are
required for the proc es s es of a work flow. For the produc ts and c omponents
required for eac h proc es s , s ee D efi ni ng Processes, page 1130 .

If required, y ou hav e c reated a parameters file to prov ide v alues for the
parameters of the work flow and s av ed it in a loc ation that c an be ac c es s ed
from the mac hine that y ou are deploy ing the work flow on.

To Deploy a Workflow Using System Manager

1. Open System Manager.

l To open System Manager i n a Wi ndow s envi ronment:

1. Start > A ll Programs > MicroStrategy Products >

System Manager.

l To open System Manager i n a U N IX or Li nux envi ronment:

1. In a Li nux consol e w i ndow , brow se to H O M E _P A T H w here

HO M E _P A T H i s the speci fi ed home di rectory duri ng
i nstal l ati on.

2. Brow se to the fol der b i n.

3. Type m s t r s y s m g r w, and then press Enter.

The System Manager home page i s di spl ayed.

2. From the File menu, sel ect Open Workflow.

1239 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

3. Brow se to the w orkfl ow fi l e, sel ect the fi l e, and then cl i ck Open.

The w orkfl ow i s di spl ayed w i thi n System Manager.

4. If you need to suppl y val ues for the parameters i n the w orkfl ow
by i mporti ng a parameters fi l e, perform the steps provi ded i n
Importi ng Parameters i nto a Workfl ow , page 1231.

5. From the View menu, sel ect Options.

6. In the Log file path fi el d, type the path of a l og fi l e or use the

fol der (brow se) i con to brow se to a l og fi l e. Al l resul ts of
depl oyi ng a w orkfl ow are saved to the fi l e that you sel ect.

7. In the Maximum C oncurrent Threads fi el d, type the maxi mum

number of tasks that can processed at the same ti me. Thi s
ensures that even i f a w orkfl ow requests a certai n number of
tasks to be processed at the same ti me, onl y the speci fi ed l i mi t i s
al l ow ed to run at the same ti me. The defaul t val ue for thi s opti on
i s ei ther the number of C PU s for the current system, or 2,
w hi chever val ue i s greater. For i nformati on on creati ng
w orkfl ow s that execute mul ti pl e tasks at the same ti me and how
to l i mi t the number of si mul taneous tasks, see Processi ng
Mul ti pl e Tasks Si mul taneousl y, page 1105 and Li mi ti ng the
N umber of Paral l el Tasks to Prevent Over C onsumpti on of
System R esources, page 1109 respecti vel y.

8. C l i ck OK .

9. From the Workflow menu, poi nt to Execute Workflow, and then

sel ect R un C onfiguration.

You c an ex ec ute a s ingle proc es s in a work flow to tes t the

proc es s , or to perform the proc es s s eparately . To ex ec ute a s ingle
proc es s , right-c lic k the proc es s and s elec t Execute Process .

© 2019, M icr o St r at egy In c. 1240

Syst em Ad m in ist r at io n Gu id e

10. From the Starting process drop-dow n l i st, sel ect the process to
act as the fi rst process i n the w orkfl ow . You can onl y sel ect
processes that have been enabl ed as entry processes for the
w orkfl ow .

11. In the Parameters area, type any parameters requi red to execute
the processes i n the w orkfl ow , w hi ch can i ncl ude user names,
passw ords, and other val ues. To i ncl ude mul ti pl e parameter and
val ue pai rs, you must encl ose each parameter i n doubl e quotes
(" " ) and separate each parameter and val ue pai r usi ng a
space. The fol l ow i ng exampl e contai ns the syntax to provi de
val ues for the parameters U s e r N a m e and P a s s w o r d:
"U s e r N a m e = U s e r 1 " " P a s s w o r d = 1 2 3 4 "

For i nformati on on suppl yi ng parameters for a w orkfl ow , see

U si ng Parameters for Processes, page 1228.

12. C l i ck R un to begi n the w orkfl ow . As the w orkfl ow i s bei ng

executed the resul ts of each process are di spl ayed i n the
C onsol e pane. You can use the C onsol e pane to revi ew
addi ti onal detai l s on the resul ts of each process and export
these detai l s. The resul ts are al so saved to the l og fi l e that you
speci fi ed earl i er. If you marked any process parameters as
C onfi denti al , the parameter val ue w i l l ei ther not be di spl ayed i n
the feedback consol e and l ogs, or i t w i l l be masked and
di spl ayed as asteri sks i nstead of the actual val ue.

If y ou need to end the work flow prematurely , from the Workflow

menu, s elec t Terminate Execution . A dialog box is dis play ed
as k ing y ou to v erify y our c hoic e to terminate the ex ec ution of the
work flow. To terminate the ex ec ution of the work flow, c lic k Yes . If
s ome proc es s es in the work flow hav e already been c ompleted,
thos e proc es s es are not rolled bac k .

1241 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Using the Command Line to Deploy a Workflow

Once you create a w orkfl ow usi ng System Manager, you can use a
command l i ne versi on of System Manager i nterface to depl oy a
w orkfl ow . The command l i ne versi on l ets you depl oy a w orkfl ow
w i thout havi ng to use an i nterface, w hi ch may be useful for si l ent
confi gurati on routi nes and OEM depl oyments.

Be aw are that some processes are dependent on the machi ne that

you use to depl oy the w orkfl ow . For exampl e, i f you i ncl ude
processes to create D SN s, the D SN s are created on the machi ne that
you use to depl oy the w orkfl ow .

The command l i ne versi on of System Manager i s a one-l i ne command

l i ne tool . Thi s means that the command to begi n the depl oyment i s
i ncl uded i n a si ngl e statement. The syntax of the statement depends
on the envi ronment you are depl oyi ng the w orkfl ow on:

l Wi ndow s: M A S y s M g r . e x e, fol l ow ed by the parameters l i sted

bel ow .

l U N IX and Li nux: m s t r s y s m g r, fol l ow ed by the parameters l i sted

bel ow .

Of the parameters l i sted bel ow , onl y - w to speci fy a w orkfl ow fi l e i s

requi red; al l other parameters are opti onal :

l -w " W or kf l o w F i l e": Thi s parameter i s requi red to speci fy the

w orkfl ow to depl oy. W o r k f l o w F i l e i s the path to the w orkfl ow fi l e.
For exampl e, - w " C : \ C r e a t e D S N s . s m w " i s val i d syntax to
depl oy the C r e a t e D S N s . s m w w orkfl ow fi l e i n a Wi ndow s
envi ronment.

l -s " E nt ry P r o c e s s": Thi s parameter can be used to speci fy the

fi rst process to attempt for the w orkfl ow . Onl y processes that have
been enabl ed as entry processes (see U si ng Entry Processes to
D etermi ne the Fi rst Step i n a Workfl ow , page 1092) can be used as

© 2019, M icr o St r at egy In c. 1242

Syst em Ad m in ist r at io n Gu id e

the fi rst process i n a w orkfl ow . E n t r y P r o c e s s i s the name of the

process as i t i s defi ned i n the w orkfl ow .

l -f " P ar am e t e r s F i le": Thi s parameter can be used to speci fy a

parameters fi l e, w hi ch suppl i es val ues for the parameters i n the
w orkfl ow . Pa r a m e t e r s F i l e i s the path to the parameters fi l e. For
exampl e, - f " C : \ P a r a m e t e r s . s m p " i s val i d syntax to use the
Pa ra me te r s . s m p parameter fi l e i n a Wi ndow s envi ronment. For
i nformati on on creati ng a parameters fi l e, see U si ng Parameters for
Processes, page 1228.

l -l " L og Fi l e": Thi s parameter can be used to speci fy a l og fi l e.

Al l resul ts of depl oyi ng a w orkfl ow are saved to the fi l e that you
speci fy. L og F i l e i s the path to the l og fi l e. For exampl e, - l
"C :\ Wo rk f l o w R e s u l t s . l o g " i s val i d syntax to use the
Wo rk fl ow R e s u l t s .l o g l og fi l e i n a Wi ndow s envi ronment.

l -s ho wo ut p u t : Thi s parameter can be used to di spl ay al l the

resul ts of depl oyi ng the w orkfl ow to the command l i ne. If you are
depl oyi ng a w orkfl ow as a compl etel y si l ent process, excl udi ng thi s
opti on prevents these resul ts from bei ng di spl ayed on the command
l i ne. The resul ts can sti l l be retri eved from the l og fi l e after
depl oyment i s compl ete.

l -p " P ar am e t e r N a m e1 = V a l u e 1 P a r a m e t e r N a m e 2 = V a l u e 2":
Thi s parameter can be used to speci fy val ues for parameters of the
w orkfl ow . Any parameter val ues that are provi ded i n thi s w ay are
used i n pl ace of val ues provi ded i n the w orkfl ow i tsel f, as w el l as
provi ded through a parameters fi l e. Provi di ng parameter val ues
di rectl y duri ng command l i ne executi on i s often requi red to suppl y
l ogi n and passw ord credenti al s speci fi c to the machi ne or user
envi ronment for a gi ven depl oyment.

To i ncl ude mul ti pl e parameter and val ue pai rs, you must encl ose
each parameter i n doubl e quotes (" ") and separate each
parameter and val ue pai r usi ng a space. For exampl e, -p

1243 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

"U se rN am e = U s e r 1 " " P a s s w o r d = 1 2 3 4 " i s val i d syntax to

provi de val ues for the parameters U s e r N a me and P a s s w o r d.

The steps bel ow show you how to depl oy a w orkfl ow usi ng the
command l i ne versi on of System Manager.

You hav e c reated a work flow and s av ed it in a loc ation that c an be

ac c es s ed from the mac hine that y ou are deploy ing the work flow on. You
hav e c reated a work flow. Steps to c reate a work flow are prov ided in
C reati ng a Workfl ow , page 1079 .

Sy s tem Manager is ins talled. This tool is ins talled as part of the general
Mic roStrategy produc t s uite.

You hav e ins talled any Mic roStrategy produc ts and c omponents that are
required for the proc es s es of the work flow. For the produc ts and
c omponents required for eac h proc es s , s ee D efi ni ng Processes, page
1130 .

If required, y ou hav e c reated a parameters file to prov ide v alues for the
parameters of the work flow and s av ed it in a loc ation that c an be ac c es s ed
from the mac hine that y ou are deploy ing the work flow on.

To Deploy a Workflow Using the Command Line Version of

System Manager

1. Open a command l i ne.

2. C heck to veri fy that System Manager i s i nstal l ed on the machi ne:

l Wi ndow s: Type M A S y s M g r . e x e and press E n t e r.

l U N IX and Li nux: Type m s t r s y s m g r and press E n t e r.

If hel p i nformati on for usi ng the command l i ne versi on of

System Manager i s di spl ayed, thi s means that System Manager
i s i nstal l ed correctl y.

© 2019, M icr o St r at egy In c. 1244

Syst em Ad m in ist r at io n Gu id e

3. Type the command to depl oy the w orkfl ow :

l Wi ndow s: Type M A S y s M g r . e x e and i ncl ude the parameters

l i sted above i n U si ng the C ommand Li ne to D epl oy a Workfl ow ,
page 1242 as requi red. For exampl e, the command bel ow i s a
val i d command to depl oy a System Manager w orkfl ow on a
Wi ndow s envi ronment:

MA Sy sM g r . e x e -w " C : \ C r e a t e D S N s . s m w " - s " C r e at e

Or ac le D S N " - f " C : \ P a r a m e t e r s . s m p " - l
"C :\ Wo r k f l o w R e s u l t s . l o g " -s h o w o u t p u t -p
"U se rN a m e = U s e r 1 " " P a s s w o r d = 1 2 3 4 "

l U N IX and Li nux: Type m s t y s y s m g r and i ncl ude the

parameters, l i sted above i n U si ng the C ommand Li ne to D epl oy
a Workfl ow , page 1242, as requi red. For exampl e, the
command bel ow i s a val i d command to depl oy a System
Manager w orkfl ow on a U N IX or Li nux envi ronment:

ms tr sy s m g r -w " $ H O M E / C r e a t e D S N s . s m w " -s
"C re at e O r a c l e D S N " -f " $ H O M E / P a r a m e t e r s . s m p "
-l " $H O M E / W o r k f l o w R e s u l t s . lo g " - s h o w o u t p u t - p
"U se rN a m e = U s e r 1 " " P a s s w o r d = 1 2 3 4 "

4. Once you have typed the ful l command, press E n t e r. The

w orkfl ow i s started and resul ts are saved to the l og fi l e, as w el l
as di spl ayed on the screen i f you i ncl uded the parameter -
sh ow ou t p u t.

Su p p o r t in g a Silen t Dep lo ymen t wit h t h e Co mman d Lin e

The command l i ne versi on of System Manager l ets you support si l ent
and OEM depl oyments of your w orkfl ow s. You can support si l ent and
OEM depl oyments of System Manager usi ng the techni ques l i sted
bel ow :

1245 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Ensure that the machi ne that i s to be used for the depl oyment meets
al l the prerequi si tes l i sted i n U si ng the C ommand Li ne to D epl oy a
Workfl ow , page 1242.

l D etermi ne the syntax to depl oy the w orkfl ow usi ng the command

l i ne versi on of System Manager. The requi red and opti onal
parameters are descri bed i n U si ng the C ommand Li ne to D epl oy a
Workfl ow , page 1242. Thi s syntax can then be used i n one of the
fol l ow i ng w ays:

l Log i n to the machi ne to perform the depl oyment from, and use the
steps provi ded i n To D epl oy a Workfl ow U si ng the C ommand Li ne
Versi on of System Manager, page 1244 to depl oy the w orkfl ow .

l Send the requi red syntax to the user or admi ni strator of the
machi ne to perform the depl oyment from. Al ong w i th the requi red
syntax, provi de i nformati on on the parameters that the user needs
to provi de i n the command l i ne request. Thi s user can then fol l ow
the steps provi ded i n To D epl oy a Workfl ow U si ng the C ommand
Li ne Versi on of System Manager, page 1244 to depl oy the
w orkfl ow .

l R evi ew the resul ts of the depl oyment usi ng the l og fi l e speci fi ed to

veri fy that the requi red processes w ere compl eted successful l y.

© 2019, M icr o St r at egy In c. 1246

 15
AUTOM ATING
ADM INISTRATIVE TASKS
WITH COM M AND
M ANAGER

© 2019, M icr o St r at egy In c. 1247

Syst em Ad m in ist r at io n Gu id e

Mi croStrategy C ommand Manager l ets you perform vari ous

admi ni strati ve and appl i cati on devel opment tasks by usi ng text
commands that can be saved as scri pts. You can manage
confi gurati on setti ngs i n the Mi croStrategy pl atform for ei ther proj ect
sources or N arrow cast Server metadatas. Wi th C ommand Manager
you can change mul ti pl e confi gurati on setti ngs al l at once, w i thout
usi ng the D evel oper or N arrow cast Admi ni strator i nterface. You can
al so create scri pts to be run at ti mes w hen i t w oul d not be conveni ent
for you to make the changes.

The C ommand Manager scri pt engi ne uses a uni que syntax that i s
si mi l ar to SQL and other such scri pti ng l anguages. For a compl ete
gui de to the commands and statements used i n C ommand Manager,
see the C ommand Manager H el p.

Using Command Manager

Wi th C ommand Manager you can change mul ti pl e confi gurati on
setti ngs al l at once as part of an automated scri pt. For exampl e, you
can change the system to al l ow more l ow pri ori ty j obs to compl ete at
ni ght than duri ng regul ar hours. To do thi s, you coul d create a scri pt
to i ncrease the number of l ow pri ori ty database connecti ons and
modi fy several Intel l i gence Server governor setti ngs. Then, you coul d
schedul e the scri pt to run at 8 P.M. You coul d then create another
scri pt that changes the database connecti ons and Intel l i gence Server
setti ngs back for dayti me use, and schedul e that scri pt to run at 6
A.M.

To s c hedule a s c ript to run at a c ertain time, us e the Windows AT

c ommand with the c m d m g r ex ec utable. For the s y ntax for us ing the
ex ec utable, s ee Executi ng a C ommand Manager Scri pt, page 1254 .

H ere are more exampl es of tasks you can perform usi ng C ommand
Manager:

1248 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l U ser management: Add, remove, or modi fy users or user groups;

l i st user profi l es

l Security: Grant or revoke user pri vi l eges; create securi ty fi l ters and
appl y them to users or groups; change securi ty rol es and user
profi l es; assi gn or revoke AC L permi ssi ons; di sconnect users or
di sabl e thei r accounts

l Server management: Start, stop, or restart Intel l i gence Server;

confi gure Intel l i gence Server setti ngs; cl uster Intel l i gence Server
machi nes; change database connecti ons and l ogi ns; manage error
codes and customi ze output data; di sconnect acti ve sessi ons on
server or proj ect

l D atabase management: create, modi fy, and del ete connecti ons,
connecti on mappi ngs, l ogi ns, and database i nstances

l Project management: Li st or ki l l j obs; change a proj ect's mode

(i dl e, resume); expi re and del ete caches; change fi l ter or metri c
defi ni ti ons; manage facts and attri butes; manage fol ders; update the
proj ect's schema; manage shortcuts; manage hi dden properti es;
create tabl es and update w arehouse catal og tabl es

l Scheduling: Tri gger an event to run schedul ed reports

l N arrowcast Server administration: Start and stop a N arrow cast

Server; start, stop, and schedul e N arrow cast Server servi ces; add,
modi fy, and remove subscri pti on book users; defi ne and remove
user authenti cati on

Privileges Required for Using Command Manager

Any users w ho w ant to use C ommand Manager must have the U se
C ommand Manager pri vi l ege. In addi ti on, they must have the usual
pri vi l eges for any system mai ntenance tasks they w ant to perform. For
exampl e, to modi fy the number of l ow pri ori ty database connecti ons,
the user must have the C reate And Edi t D atabase Instances And
C onnecti ons pri vi l ege.

© 2019, M icr o St r at egy In c. 1249

Syst em Ad m in ist r at io n Gu id e

A common w ay to del egate admi ni strati ve tasks that can be performed

w i th C ommand Manager i s to grant a user the U se C ommand Manager
pri vi l ege al ong w i th one or more securi ty rol es. The user can then
perform al l tasks rel ated to that securi ty rol e and i s prohi bi ted from
performi ng other tasks.

For full ac c es s to all Command Manager func tionality , a us er mus t hav e

all priv ileges in the Common, Dis tribution Serv ic es , and Adminis tration
groups , ex c ept for By pas s All Objec t Sec urity Ac c es s Chec k s .

Creating and Executing Scripts

From the C ommand Manager graphi cal i nterface, you can create and
execute C ommand Manager scri pts. The scri pt edi tor has many of the
same features as a standard text edi tor, w i th copy/paste and one-l evel
undo functi onal i ty. Other features of the scri pt edi tor i ncl ude a scri pt
syntax checker, col or-coded scri pt syntax (see C ol or-C odi ng the Text
i n a Scri pt, page 1251), and sampl e scri pt outl i nes (see Scri pt
Outl i nes, page 1251).

Command Manager als o inc ludes a c ommand line interfac e for us e in

env ironments that do not s upport the graphic al interfac e, s uc h as
c ertain Linux s hell env ironments , or terminal c onnec tions . For
ins truc tions on us ing the Command Manager c ommand line interfac e,
s ee U si ng C ommand Manager from the C ommand Li ne, page
1265 .

To Start the Command Manager Graphical Interface

In Wi ndow s: From the Wi ndow s Start menu, go to A ll Programs >

MicroStrategy Tools > C ommand Manager.

In Li nux: Brow se to the Mi croStrategy H ome fol der, then to the / b i n

subfol der. Type m s t r c m d m g r w and press Enter.

125 0 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

For more i nformati on about usi ng C ommand Manager and for scri pt
syntax, see C ommand Manager.

Co lo r -Co d in g t h e Text in a Scr ip t

The C ommand Manager scri pt edi tor can di spl ay col or-coded text
accordi ng to i ts functi on i n the scri pt or procedure.

In a C ommand Manager scri pt:

l R eserved w ords di spl ay as bl ue.

l Words or phrases i n quotati on marks di spl ay as gray.

l N umbers di spl ay as red. D ates di spl ay as red w i th bl ue sl ashes.

l GU ID s di spl ay as green.

l Al l other text appears i n bl ack.

In a C ommand Manager procedure:

l Keyw ords, such as i f or b o o l e a n, di spl ay as purpl e, and bol d.

l Functi ons, cl asses, and methods di spl ay as red.

l C ommand Manager statements di spl ay as bl ue.

l C omments di spl ay as green.

l Al l other text appears i n bl ack.

Scr ip t Ou t lin es
The C ommand Manager scri pt outl i nes hel p you i nsert scri pt
statements w i th the correct syntax i nto your scri pts. Outl i nes are
preconstructed statements w i th opti onal features and user-defi ned
parameters cl earl y marked.

Outl i nes are grouped by the type of obj ects that they affect. The
outl i nes that are avai l abl e to be i nserted depend on w hether the

© 2019, M icr o St r at egy In c. 125 1

Syst em Ad m in ist r at io n Gu id e

acti ve Scri pt w i ndow i s connected to a proj ect source or a N arrow cast

server. Onl y the outl i nes that are rel evant to the connected metadata
source are avai l abl e.

To Insert an Outline Into a Script

1. Start the C ommand Manager graphi cal i nterface.

2. C onnect to a metadata source.

3. From the Edit menu, sel ect Insert Outline.

4. N avi gate the Outl i ne tree to l ocate the outl i ne you w ant, and
sel ect i t.

5. C l i ck Insert to pl ace the sel ected outl i ne i nto the scri pt.

6. C l i ck C ancel.

7. Modi fy the scri pt as needed.

Procedures in Command Manager

C ommand Manager procedures are reusabl e scri pts that can be
executed from other scri pts. You can reuse procedures w i th di fferent
i nput val ues, so that the procedure performs the same task i n a
sl i ghtl y di fferent w ay. Procedures can use C ommand Manager syntax,
or they can be w ri tten i n the Java programmi ng l anguage and
i ncorporate C ommand Manager statements i n Java commands.

For exampl e, you can create a procedure cal l ed N ew U ser that creates
a user and adds the user to groups. You can then cal l thi s procedure
from another C ommand Manager scri pt, suppl yi ng the name of the
user and the groups. To use the procedure to create a user named
KH uang and add the user to the group C ustomers, use the fol l ow i ng
syntax:

EXECUTE PROCEDURE "NewUser" ("KHuang", "Customers");

125 2 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

w here N ew U ser i s the name of the procedure, and KH uang and

C ustomers are the i nputs to the procedure.

Proc edures are av ailable only for us e with projec t s ourc es . Proc edures
c annot be us ed with Narrowc as t Serv er s tatements .

C ommand Manager contai ns many sampl e procedures that you can

vi ew and modi fy. These are stored i n the C ommand Manager
di rectory, i n \ O u t l i n e s\ P r o c e d u r e _O u t li n e s \ S a m p l e _
Proc ed ur es \

For i nstructi ons on how to use procedures, see the C ommand

Manager H el p. (From w i thi n the C ommand Manager graphi cal
i nterface, press F1.)

Usin g Java in Co mman d Man ager Pr o ced u r es

Java i s a si mpl e yet pow erful programmi ng l anguage that i s w i del y
used i n the softw are i ndustry. Java can be i ntegrated i nto C ommand
Manager procedures to automate repeti ti ve tasks such as creati ng
mul ti pl e users, or recursi vel y l i sti ng al l the fol ders i n a proj ect. Java
i s supported i n C ommand Manager out-of-the-box; no addi ti onal
softw are must be i nstal l ed to execute Java commands.

To i ncl ude Java i n a C ommand Manager scri pt, you w ri te a procedure

contai ni ng the Java code, and execute the procedure from a
C ommand Manager scri pt. Java cannot be i ncl uded di rectl y i n a
C ommand Manager scri pt. For detai l ed i nstructi ons on usi ng Java i n
procedures, see the C ommand Manager H el p. (From w i thi n the
C ommand Manager graphi cal i nterface, press F1.)

J av a is s upported only in proc edures , and proc edures are s upported

only with projec t s ourc es . J av a c ommands c annot be us ed in s c ripts to
be ex ec uted agains t a Narrowc as t Serv er metadata.

© 2019, M icr o St r at egy In c. 125 3

Syst em Ad m in ist r at io n Gu id e

Do not us e the S y s t e m . e x i t c ommand to ex it a proc edure. This

c ommand terminates the entire Command Manager proc es s .

C ommand Manager provi des tw o speci al commands that can be used

by Java scri pts to execute C ommand Manager commands:

l ex ec ut e runs any C ommand Manager command, but i t does not

return the resul ts.

l ex ec ut eC a p t u r e runs any C ommand Manager command and

returns the resul ts i n a R esul tSet obj ect. Thi s obj ect behaves l i ke a
standard R esul tSet obj ect i n Java: you can i terate through the
resul ts and retri eve i ndi vi dual i tems, w hi ch can then be used to
extract properti es of the resul ts. Thi s enabl es you to use the resul ts
el sew here i n the procedure.

For a detailed lis t of the Res ultSet c olumns us ed in eac h Command

Manager LIST s tatement, s ee the s tatement s y ntax guide for that
s tatement in the C ommand Manager Help.

Executing a Command Manager Script

You can execute C ommand Manager scri pts i n the fol l ow i ng w ays:

l From the C ommand Manager graphi cal i nterface (see C reati ng and
Executi ng Scri pts, page 1250)

l From the C ommand Manager command l i ne i nterface (see U si ng

C ommand Manager from the C ommand Li ne, page 1265)

l Invoke the C ommand Manager executabl e, i ncl udi ng necessary

parameters such as the scri pt fi l e to run, from the Wi ndow s
schedul er, Wi ndow s command prompt, or other appl i cati ons such as
system management softw are.

Command Manager Runtime is a lightweight v ers ion of Command

Manager for bundling with OEM applic ations . Command Manager

125 4 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Runtime has fewer ex ec ution options and s upports fewer s tatements

than Command Manager. For more information about Command
Manager Runtime, s ee U si ng C ommand Manager w i th OEM
Softw are, page 1266 .

Command Manager does not automatic ally loc k a projec t or

c onfiguration when it ex ec utes s tatements . To av oid metadata
c orruption, us e the LOCK PROJ ECT or LOCK CONFIGURATION
s tatements in any Command Manager s c ripts that mak e c hanges to a
projec t or s erv er c onfiguration. For more information about loc k ing and
unloc k ing a projec t or c onfiguration, s ee Proj ect and C onfi gurati on
Locki ng, page 1260 .

To Execute a Script from the Command Manager Graphical

Interface

1. Start the C ommand Manager graphi cal i nterface:

l In Wi ndow s: From the Wi ndow s Start menu, poi nt to A ll

Programs, then MicroStrategy Tools, and then choose
C ommand Manager.

l In Li nux: Brow se to the Mi croStrategy H ome fol der, then to the

/b in subfol der. Type m s t r c m d m g r w and press Enter.

2. C onnect to a proj ect source or N arrow cast Server.

3. Open the scri pt. (From the File menu, sel ect Open.)

4. From the C onnection menu, sel ect Execute. The scri pt

executes.

© 2019, M icr o St r at egy In c. 125 5

Syst em Ad m in ist r at io n Gu id e

To Execute a Script from the Command Manager Command Line

Interface

For s pec ific c ommand s y ntax for the c ommand line interfac e, s ee the
Command Manager Help.

1. From the command l i ne, type c m d m g r . e x e - i n t e r a c t i v e and

press Enter. The C ommand Manager command l i ne i nterface
opens, i n consol e mode, w i th an acti ve connecti on-l ess proj ect
source connecti on.

2. C onnect to a proj ect source or N arrow cast Server usi ng the

CO NN EC T M S T R or C O N N E C T N C S command.

3. To l oad a scri pt and execute i t, type E X E C F I L E f i l e n a m e,

w here f i l e n a m e i s the name of the scri pt. The scri pt i s l oaded
i nto the command l i ne i nterface and executed.

To invoke Command Manager from Another Application

C al l the c m d m g r . e x e command w i th the fol l ow i ng parameters:

If the projec t s ourc e name, the input file, or an output file c ontain a
s pac e in the name or path, y ou mus t enc los e the name in double quotes .

Effe c t Pa r a me te r s

C o n n ect io n ( req u ired ; ch o o se o n e)

-n
Connect t o a project source
ProjectSourceName

I f -p is omit t ed, Command Manager assumes a null -u UserName

password.
[-p Password]

125 6 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Effe c t Pa r a me te r s

I nit iat e a connect ion-less project source session -connlessMSTR

-w ODBC_DSN

Connect t o a Narrowcast S erver -u UserName

[-p Password]
I f -p or -s are omit t ed, Command Manager assumes a
null password or syst em pref ix. -d Database

[-s SystemPrefix]

-connlessNCS
I nit iat e a connect ion-less Narrowcast S erver session
[-d Database]
I f -s is omit t ed, Command Manager assumes a null
[-s
syst em pref ix.
SystemPrefix]

Scrip t in p u t ( req u ired )

S pecif y t he script f ile t o be execut ed

-f InputFile
I f t his paramet er is omit t ed, t he Command Manager
GUI is launched.

Scrip t o u t p u t ( o p t io n al; ch o o se o n ly o n e)

Log script result s, error messages, and st at us messages t o

-o OutputFile
a single f ile

Log script result s, error messages, and st at us messages t o

separat e f iles, wit h def ault f ile names of :

• CmdMgrResult s. log -break

• CmdMgrFail. log

• CmdMgrS uccess. log

Log script result s, error messages, and st at us messages t o

-or ResultsFile
separat e f iles, wit h specif ied names
-of FailFile
Y ou can omit one or more of t hese paramet ers. For
-os SuccessFile
example, if you want t o log only error messages, use

© 2019, M icr o St r at egy In c. 125 7

Syst em Ad m in ist r at io n Gu id e

Effe c t Pa r a me te r s

only t he -of paramet er.

Scrip t o u t p u t o p t io n s ( o p t io n al)

B egin each log f ile wit h a header cont aining inf ormat ion
-h
such as t he version of Command Manager used

P rint inst ruct ions in each log f ile and on t he console

This opt ion is ignored if t he script is encrypt ed. For

-i
inf ormat ion about encrypt ed Command Manager
script s, see Enc ry pting C ommand Manager Sc ripts,
page 1259 .

I f an I nt elligence S erver error occurred, print t he

I nt elligence S erver error code and t he Command Manager -e
exit code in each log f ile and on t he console

Display script out put on t he console -showoutput

S ave t he result s of t he script in an CS V f ile - csv CSVFile

S ave t he result s of t he script in an X ML f ile - xml XMLFile

Omit hidden object s in t he script result s. Hidden object s

are MicroS t rat egy met adat a object s whose HI DDE N -suppresshidden
propert y is set .

Execu t io n o p t io n s ( o p t io n al)

Halt script execut ion on crit ical errors (see H andling

-stoponerror
Ex ecution Errors , page 1261 )

A ful l l i st of parameters can al so be accessed from a command prompt

by enteri ng cm d m g r . e x e -h e l p.

By defaul t, the executabl e i s i nstal l ed i n the fol l ow i ng di rectory:

Program Files (x86)\MicroStrategy\Command Manager

125 8 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Encrypting Command Manager Scripts

By defaul t, C ommand Manager scri pts are saved i n pl ai n text format.
Thi s can create a securi ty ri sk i f your scri pt contai ns a user name and
passw ord, such as for the C ON N EC T SER VER statement. You can
avoi d thi s securi ty ri sk by savi ng these scri pts i n an encrypted format.

If you create a batch fi l e to execute a C ommand Manager scri pt from

the command l i ne, the passw ord for the proj ect source or N arrow cast
Server l ogi n must be stored i n pl ai n text i n the batch fi l e. You can
protect the securi ty of thi s i nformati on by encrypti ng the scri pt and
havi ng i t connect to a proj ect source or N arrow cast Server w hen i t i s
executed, usi ng the C ON N EC T SER VER statement. You can then
execute the scri pt from a connecti on-l ess sessi on, w hi ch does not
requi re a user name or passw ord. The user name and passw ord are
provi ded i n the C ommand Manager scri pt, as part of the C ON N EC T
SER VER statement. For detai l ed syntax i nstructi ons for usi ng the
C ON N EC T SER VER statement, see the C ommand Manager H el p
(from w i thi n the C ommand Manager graphi cal i nterface, press F1).

When you encrypt a scri pt, you speci fy a passw ord for the scri pt. Thi s
passw ord i s requi red to open the scri pt, ei ther i n the C ommand
Manager graphi cal i nterface, or usi ng the LOAD FILE command i n the
C ommand Manager command l i ne i nterface. Because a scri pt must be
opened before i t can be executed i n the C ommand Manager graphi cal
i nterface, the passw ord i s requi red to execute the scri pt from the
graphi cal i nterface as w el l . H ow ever, the passw ord i s not requi red to
execute the scri pt from the command l i ne or through the command
l i ne i nterface.

The passw ord for an encrypted scri pt cannot be bl ank, cannot contai n
any spaces, and i s case-sensi ti ve.

© 2019, M icr o St r at egy In c. 125 9

Syst em Ad m in ist r at io n Gu id e

Project and Configuration Locking

C ommand Manager does not automati cal l y l ock a proj ect or
confi gurati on w hen i t executes statements. Thus, any ti me you al ter a
proj ect metadata or Intel l i gence Server confi gurati on w i th a C ommand
Manager scri pt, i t i s possi bl e that another user coul d al ter the
metadata or confi gurati on at the same ti me. Thi s can cause metadata
or confi gurati on i nconsi stenci es, and i n the w orst case may requi re
you to rei nstal l Intel l i gence Server or restore your proj ect from a
backup.

To avoi d these i nconsi stenci es, use the LOC K PR OJEC T or LOC K
C ON FIGU R ATION statements i n any C ommand Manager scri pts that
make changes to a proj ect or server confi gurati on. These statements
pl ace a l ock on the metadata or confi gurati on. A metadata l ock
prevents other Mi croStrategy users from modi fyi ng any obj ects i n the
proj ect i n D evel oper or Mi croStrategy Web. A confi gurati on l ock
prevents other Mi croStrategy users from modi fyi ng any confi gurati on
obj ects, such as users or groups, i n the proj ect source.

When other users attempt to open an obj ect i n a l ocked proj ect or
confi gurati on, a message i nforms them that the proj ect or
confi gurati on i s l ocked because another user i s modi fyi ng i t. U sers
can then choose to open the obj ect i n read-onl y mode or vi ew more
detai l s about the l ock.

C ommand Manager has tw o ki nds of l ocks:

l Transient l ocks are automati cal l y rel eased after di sconnecti ng.

l Permanent l ocks are rel eased onl y after an U N LOC K command or

w hen the proj ect i s manual l y unl ocked. Permanent l ocks are
i ndi cated by the w ord PER MAN EN T i n the LOC K command.

If y ou loc k a projec t or c onfiguration in a Command Manager s c ript,

mak e s ure y ou releas e the loc k at the end of the s c ript with the UNLOCK
PROJ ECT or UNLOCK CONFIGURATION s tatement.

1260 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Handling Syntax Errors

Syntax errors occur w hen C ommand Manager encounters an
i nstructi on that i t does not understand. Thi s can be due to a
typographi cal error (C ER ATE for C R EATE, for exampl e) or a
statement that does not fol l ow the requi red syntax i n another w ay. For
exampl es of the correct syntax for al l C ommand Manager statements,
see the H el p.

When C ommand Manager encounters a syntax error, i t di spl ays the

porti on of the i nstructi on set w here the error w as detected i n the
Scri pt w i ndow and hi ghl i ghts the i nstructi on. An error message i s al so
di spl ayed on the Messages tab of the Scri pt w i ndow . Fi nal l y, i f
l oggi ng i s enabl ed i n the Opti ons di al og box, the error message i n the
Messages tab i s w ri tten to the l og fi l e.

Handling Execution Errors

Executi on errors occur w hen an i nstructi on i s formed correctl y but
returns an unexpected resul t w hen i t i s executed. For exampl e,
attempti ng to del ete a user w ho does not exi st i n the Mi croStrategy
metadata generates an executi on error.

C ommand Manager recogni zes tw o cl asses of executi on errors:

l C ritical errors occur w hen the mai n part of the i nstructi on i s not
abl e to compl ete. These errors i nterrupt scri pt executi on w hen the
Stop script execution on error opti on i s enabl ed (GU I) or w hen
the - st op o n e r r o r fl ag i s used (command l i ne).

For exampl e, i f you submi t an i nstructi on to create a user, u s e r 1,

that al ready exi sts i n the Mi croStrategy metadata database,
C ommand Manager cannot create the user. Because creati ng the
user i s the mai n part of the i nstructi on, thi s i s a cri ti cal error. If the
Stop script execution on error opti on i s enabl ed, the scri pt stops
executi ng and any further i nstructi ons are i gnored.

© 2019, M icr o St r at egy In c. 1261

Syst em Ad m in ist r at io n Gu id e

l N oncritical errors occur w hen the mai n part of the i nstructi on i s

abl e to compl ete. These errors never i nterrupt scri pt executi on.

For exampl e, i f you submi t an i nstructi on to create a Mi croStrategy

user group w i th tw o members, u s e r 1 and us e r 2, but user2 does
not exi st i n the Mi croStrategy metadata database, C ommand
Manager can sti l l create the group. Because creati ng the group i s
the mai n part of the i nstructi on (addi ng users i s secondary), thi s i s a
noncri ti cal error.

An error message i s w ri tten to the Messages tab of the Scri pt w i ndow

for al l executi on errors, cri ti cal or noncri ti cal . In addi ti on, i f l oggi ng i s
enabl ed i n the Opti ons di al og box, the error message i s w ri tten to the
l og fi l e.

Co mman d Man ager an d Pr o mp t ed Ob ject s

C ommand Manager cannot mani pul ate prompted obj ects. For
exampl e, i t cannot al ter the properti es of a metri c that contai ns a
prompt, and i t cannot create subscri pti ons for a report that contai ns a
prompt.

Thi s restri cti on extends to prompts at any l evel of nesti ng. For
exampl e, i f you have a custom group that contai ns a prompted metri c,
C ommand Manager cannot al ter the properti es of that custom group.

If you attempt to execute a statement that mani pul ates a prompted

obj ect, C ommand Manager returns a noncri ti cal executi on error.

Timeout Errors
To avoi d l ocki ng up the system i ndefi ni tel y, C ommand Manager has a
bui l t-i n ti meout l i mi t of 20 mi nutes. If a statement has been executi ng
for 20 mi nutes w i th no response from Intel l i gence Server, C ommand
Manager reports a request ti meout error for that command and
executes the next i nstructi on i n the scri pt. H ow ever, C ommand
Manager does not attempt to abort the command. In some cases, such

1262 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

as database-i ntensi ve tasks such as purgi ng the stati sti cs database,

the task may conti nue to execute even after C ommand Manager
reports a ti meout error.

The fol l ow i ng statements are not subj ect to the 20-mi nute C ommand
Manager ti meout l i mi t. A scri pt contai ni ng these statements conti nues
executi ng unti l Intel l i gence Server reports that the task has
succeeded or fai l ed.

l C reate Proj ect statement

l U pdate Proj ect statement

l U pdate Pri vi l eges statement

l Import Package statement

Command Manager Script Syntax

The C ommand Manager scri pt engi ne uses a uni que syntax that i s
si mi l ar to SQL and other such scri pti ng l anguages. For a compl ete
gui de to the commands and statements used i n C ommand Manager,
see the C ommand Manager H el p.

A C ommand Manager scri pt consi sts of one or more scri pt statements.

Each statement ends w i th a semi col on (; ).

Statements consi st of one or more tokens. A token i s a w ord, a l i st of

w ords encl osed i n quotati on marks, or a symbol . A token i s
recogni zed by C ommand Manager as an i ndi vi dual uni t w i th a speci fi c
meani ng. Tokens can be:

l reserved words, w hi ch are w ords w i th a speci fi c meani ng i n a

C ommand Manager scri pt. For a compl ete l i st of reserved w ords,
see the C ommand Manager H el p.

© 2019, M icr o St r at egy In c. 1263

Syst em Ad m in ist r at io n Gu id e

l identifiers, w hi ch are w ords that the user provi des as parameters

for the scri pt. For exampl e, i n the statement L I S T M E M B E R S F O R
US ER GR OU P " M a n a g e r s " ; the w ord M a n a g e r s i s an i denti fi er.
Identi fi ers must be encl osed i n quotati on marks.

In general, either double quotes or s ingle quotes c an be us ed to

enc los e identifiers . Howev er, if y ou want to inc lude either s ingle
quotes or double quotes as part of an identifier, y ou mus t either
enc los e that identifier in the other k ind of quotes , or put a c aret in front
of the interior quote. For ex ample, to refer to a metric named C o u n t
of " Ou t s t a n d i n g " C u s t o m e r R a t i n g s , y ou would need to
us e one of the following methods :

Us e s ingle quotes to enc los e the identifier:

'C ou nt o f " O u t s t a n d i n g " C u s t om e r R a t i n g s '

Us e double quotes to enc los e the identifier and put c arets in front of
the interior double quotes :

"C ou nt o f ^ " O u t s t a n d i n g ^ " C u s t o m e r R a t i n g s "

If y our identifier c ontains double-by te c harac ters , s uc h as c harac ters

us ed in the Korean, J apanes e, or Chines e c harac ter s ets , y ou mus t
enc los e the identifier in s quare brac k ets [ ] . If the identifier is als o
enc los ed in quotation mark s , thes e s quare brac k ets mus t be plac ed
ins ide the quotation mark s .

l symbols, such as ; , ' " ^

The c aret ( ^ ) func tions as an es c ape c harac ter. It c aus es any other
s pec ial c harac ter that follows it to be treated literally and not
interpreted as a s pec ial c harac ter. If y ou want to inc lude a literal c aret
in y our s tatement, y ou mus t prec ede it with another c aret. For

1264 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

ex ample, if y ou hav e a us er group named ^ C o n t r o l , in Command

manager s c ripts y ou mus t refer to it as ^ ^ C o n t r o l .

l numbers i n any notati on

l dates

l object GU ID s

l other special characters such as carri age returns, tabs, or spaces

Using Command Manager from the Command

Line
In addi ti on to the graphi cal user i nterface and the command l i ne
executi on, C ommand Manager has a text-based command l i ne
i nterface. Wi th thi s i nterface, you can create and execute C ommand
Manager scri pts i n an envi ronment w here the graphi cal user i nterface
i s unavai l abl e, such as w hen accessi ng a U N IX system vi a tel net.

When you start the command l i ne i nterface, i t i s i n consol e mode, w i th

a connecti on-l ess proj ect source connecti on. The command prompt i n
consol e mode di spl ays the metadata source and user to w hi ch
C ommand Manager i s connected.

Enteri ng a C ommand Manager scri pt i nstructi on sw i tches C ommand

Manager i nto edi t mode. From edi t mode you can conti nue typi ng your
scri pt. You can al so save or execute the scri pt.

To see a l i st of i nstructi ons for the command l i ne i nterface, from the

command l i ne i nterface type h e l p and press Enter. A l i st of
C ommand Manager command l i ne i nstructi ons and an expl anati on of
thei r effects i s di spl ayed.

© 2019, M icr o St r at egy In c. 1265

Syst em Ad m in ist r at io n Gu id e

To Start the Command Manager Command Line Interface

From the command l i ne, type c m d m g r . e x e -i n t e r a c t i v e and

press Enter. The C ommand Manager command l i ne i nterface opens,
i n consol e mode, w i th an acti ve connecti on-l ess proj ect source
connecti on.

Using Command Manager with OEM Software

D evel opers of Ori gi nal Equi pment Manufacturer (OEM) appl i cati ons
that use embedded Mi croStrategy proj ects may fi nd that they need
fl exi bi l i ty i n confi guri ng thei r envi ronment. C ommand Manager
R unti me i s a sl i mmed-dow n versi on of the C ommand Manager
command-l i ne executabl e for use w i th these OEM appl i cati ons. For
i nformati on about obtai ni ng C ommand Manager R unti me, contact your
Mi croStrategy sal es representati ve.

C ommand Manager R unti me uses a subset of the commands

avai l abl e for the ful l versi on of C ommand Manager. If you try to
execute a scri pt w i th statements that are not avai l abl e i n C ommand
Manager R unti me, the scri pt fai l s w i th the message, "You are not
l i censed to run thi s command." For a l i st of the commands avai l abl e
i n C ommand Manager R unti me, w i th syntax and exampl es for each
command, see the C ommand Manager R unti me.

1266 © 2019, M icr o St r at egy In c.

 16
VERIFYING REPORTS AND
D OCUM ENTS WITH
I NTEGRITY M ANAGER

© 2019, M icr o St r at egy In c. 1267

Syst em Ad m in ist r at io n Gu id e

Mi croStrategy Integri ty Manager i s an automated compari son tool

desi gned to streaml i ne the testi ng of Mi croStrategy reports and
documents i n proj ects. Thi s tool can determi ne how speci fi c changes
i n a proj ect envi ronment, such as the regul ar mai ntenance changes to
metadata obj ects or hardw are and softw are upgrades, affect the
reports and documents i n that proj ect.

For i nstance, you may w ant to ensure that the changes i nvol ved i n
movi ng your proj ect from a devel opment envi ronment i nto producti on
do not al ter any of your reports. Integri ty Manager can compare
reports i n the devel opment and the producti on proj ects, and hi ghl i ght
any di fferences. Thi s can assi st you i n tracki ng dow n di screpanci es
betw een the tw o proj ects.

You can use Integri ty Manager to execute reports or documents from a

si ngl e Mi croStrategy proj ect to confi rm that they remai n operati onal
after changes to the system. Integri ty Manager can execute any or al l
reports from the proj ect, note w hether those reports execute, and
show you the resul ts of each report.

Integri ty Manager can al so test the performance of an Intel l i gence

Server by recordi ng how l ong i t takes to execute a gi ven report or
document. You can execute the reports or documents mul ti pl e ti mes
i n the same test and record the ti me for each executi on cycl e, to get a
better i dea of the average Intel l i gence Server performance ti me. For
more i nformati on about performance tests, see Testi ng Intel l i gence
Server Performance, page 1272.

For reports you can test and compare the SQL, gri d data, graph,
Excel , or PD F output. For documents you can test and compare the
Excel or PD F output, or test w hether the documents execute properl y.
If you choose not to test and compare the Excel or PD F output, no
output i s generated for the documents. Integri ty Manager sti l l reports
w hether the documents executed successful l y and how l ong i t took
them to execute.

1268 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l To ex ec ute an integrity tes t on a projec t, y ou mus t hav e the Us e

Integrity Manager priv ilege for that projec t.

l Integrity Manager c an only tes t projec ts in Serv er (three-tier) mode.

Projec ts in Direc t Connec tion (two-tier) mode c annot be tes ted with
this tool.

l To tes t the Ex c el ex port of a report or doc ument, y ou mus t hav e

Mic ros oft Ex c el ins talled on the mac hine running Integrity Manager.

Thi s secti on descri bes how to use Integri ty Manager to vi ew and

compare reports and documents. Topi cs i ncl ude:

l What i s an Integri ty Test?, page 1269

l Best Practi ces for U si ng Integri ty Manager, page 1274

l C reati ng an Integri ty Test, page 1276

l Executi ng an Integri ty Test, page 1280

l Vi ew i ng the R esul ts of a Test, page 1295

l Li st of Tags i n the Integri ty Test Fi l e, page 1303

What is an Integrity Test?

In an i ntegri ty test, Integri ty Manager executes reports or documents
from a base proj ect and i nforms you as to w hi ch reports and
documents fai l ed to execute. D ependi ng on the type of i ntegri ty test,
Integri ty Manager may compare those reports and documents agai nst
those from another proj ect, or from a previ ousl y establ i shed basel i ne.
An i ntegri ty test may al so i nvol ve compari ng reports and/or
documents from tw o previ ousl y establ i shed basel i nes, and not
executi ng agai nst an Intel l i gence Server at al l .

The Integri ty Manager Wi zard w al ks you through the process of

setti ng up i ntegri ty tests. You speci fy w hat ki nd of i ntegri ty test to run,
w hat reports or documents to test, and the executi on and output

© 2019, M icr o St r at egy In c. 1269

Syst em Ad m in ist r at io n Gu id e

setti ngs. Then you can execute the test i mmedi atel y, or save the test
for l ater use and re-use. For i nformati on on reusi ng tests, see Savi ng
and Loadi ng a Test, page 1278.

Types of Integrity Tests

A single-project i ntegri ty test confi rms that reports and documents
from a proj ect execute to compl eti on, w i thout errors. Thi s i s useful
w hen changes have been made somew here i n the system, and you
w ant to ensure that none of the changes cause executi on errors i n
your reports or documents.

In a si ngl e-proj ect test, Integri ty Manager executes the speci fi ed

reports and documents. It then di spl ays a l i st of the reports al ong w i th
w hether the executi on of each report or document succeeded or
fai l ed. If a report or document fai l ed, you can doubl e-cl i ck on the
report name i n the resul ts l i st to see w hat error message w as
generated.

In addi ti on to the si ngl e-proj ect i ntegri ty test, Integri ty Manager

supports these types of comparati ve i ntegri ty tests:

l Project-versus-project i ntegri ty tests compare reports and/or

documents from tw o di fferent proj ects. Thi s i s useful w hen you are
movi ng a proj ect from one envi ronment to another (for i nstance, out
of devel opment and i nto producti on), and you w ant to ensure that
the mi grati on does not cause changes i n any reports or documents
i n the proj ect.

l B aseline-versus-project i ntegri ty tests compare reports and/or

documents from a proj ect agai nst a previ ousl y establ i shed basel i ne.
The basel i ne can be establ i shed by runni ng a si ngl e-proj ect
i ntegri ty test, or taken from a previ ous executi on of a proj ect-versus-
proj ect i ntegri ty test.

1270 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Basel i ne-versus-proj ect tests can be used as an al ternati ve to

proj ect-versus-proj ect tests w hen no base proj ect i s avai l abl e, or
w hen runni ng agai nst a producti on Intel l i gence Server w oul d be too
costl y i n terms of system resources. Al so, by usi ng basel i ne-versus-
proj ect tests a user can manual l y change the resul ts w hi ch they
w ant to compare the target proj ect w i th.

l B aseline-versus-baseline i ntegri ty tests compare reports and/or

documents from tw o previ ousl y establ i shed basel i nes agai nst each
other. These basel i nes can be establ i shed by runni ng si ngl e-proj ect
i ntegri ty tests (see bel ow ), or taken from a previ ous executi on of a
proj ect-versus-proj ect i ntegri ty test.

These tests can be useful i f you have exi sti ng basel i nes from
previ ous tests that you w ant to compare. For exampl e, your system
i s confi gured i n the recommended proj ect l i fe cycl e of devel opment
> test > producti on (for more i nformati on on thi s l i fe cycl e, see the
Managi ng your proj ects secti on i n the System Admi ni strati on
Gui de). You have an exi sti ng basel i ne from a si ngl e proj ect test of
the producti on proj ect, and the resul ts of a proj ect versus proj ect
test on the devel opment and test proj ects. In thi s si tuati on, you can
use a basel i ne versus basel i ne test to compare the producti on
proj ect to the test proj ect

In each of these comparati ve tests, Integri ty Manager executes the

speci fi ed reports and documents i n both the basel i ne and the target.
You can compare the report data, generated SQL code, graphs, Excel
exports, and PD F output for the tested reports; you can compare the
Excel exports and PD F output for tested documents, or test the
executi on of the documents w i thout exporti ng the output. Integri ty
Manager i nforms you w hi ch reports and documents are di fferent
betw een the tw o proj ects, and hi ghl i ghts i n red the di fferences
betw een them.

© 2019, M icr o St r at egy In c. 1271

Syst em Ad m in ist r at io n Gu id e

Testing Intelligence Server Performance

In addi ti on to testi ng reports and documents for executi on and for
accuracy betw een proj ects, Integri ty Manager can determi ne how l ong
i t takes an Intel l i gence Server to execute a gi ven set of reports or
documents. Thi s i s cal l ed a performance test. You can execute the
reports and documents i n the i ntegri ty test mul ti pl e ti mes, to get a
better i dea of the average ti me i t takes to execute each report.

In a performance test, Integri ty Manager records the ti me i t takes to

execute each report or document. If the reports and documents are
bei ng executed more than once, Integri ty Manager records each
executi on ti me. You can vi ew the mi ni mum, maxi mum, and average
executi on ti me for each report or document i n the R esul ts Summary
area. In a comparati ve i ntegri ty test, you can al so vi ew the di fference
i n ti me betw een the basel i ne and target reports and documents.

Per f o r man ce Test Best Pr act ices

The resul ts of a performance test can be affected by many factors.
The fol l ow i ng best practi ces can hel p ensure that you get the most
accurate resul ts from a performance test:

l Performance compari son tests shoul d be run as si ngl e-proj ect

i ntegri ty tests. Thi s reduces the l oad on Integri ty Manager and
ensures that the recorded ti mes are as accurate as possi bl e.

To compare performance on tw o Intel l i gence Servers, Mi croStrategy

recommends fol l ow i ng the steps bel ow :

1. Perform a si ngl e proj ect test agai nst one proj ect, savi ng the
performance resul ts.

2. Perform a si ngl e proj ect test agai nst the second proj ect, savi ng
the performance resul ts.

1272 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

3. C ompare the tw o performance resul ts i n a basel i ne-versus-

basel i ne test.

l Wai t unti l the performance test i s compl ete before attempti ng to

vi ew the resul ts of the test i n Integri ty Manager. Otherw i se the
i ncreased l oad on the Integri ty Manager machi ne may cause the
recorded ti mes to be i ncreased for reasons not rel ated to
Intel l i gence Server performance.

l If you are usi ng a basel i ne-versus-proj ect test or a basel i ne-versus-

basel i ne test, make sure that the tests have processed the reports
and/or documents i n the same formats. Executi on ti mes are not
recorded for each format, onl y for the aggregate generati on of the
sel ected formats. Thus, compari ng a basel i ne w i th SQL and Graph
data agai nst a test of onl y SQL data i s l i kel y to gi ve i naccurate
resul ts.

l If the U se C ache setti ng i s sel ected on the Sel ect Executi on

Setti ngs page of the Integri ty Manager Wi zard, make sure that a
val i d cache exi sts for testi ng materi al . Otherw i se the fi rst executi on
cycl e of each report takes l onger than the subsequent cycl es,
because i t must generate the cache for the other cycl es to use. One
w ay to ensure that a cache exi sts for each obj ect i s to run a si ngl e-
proj ect i ntegri ty test of each obj ect before you run the performance
test.

This s etting only affec ts reports , and does not apply to doc uments .

l In the Integri ty Manager w i zard, on the Sel ect Executi on Setti ngs
page, make sure C oncurrent Jobs i s set to 1. Thi s causes
Intel l i gence Server to run onl y one report or document at a ti me,
and provi des the most accurate benchmark resul ts for that
Intel l i gence Server.

© 2019, M icr o St r at egy In c. 1273

Syst em Ad m in ist r at io n Gu id e

l The C ycles setti ng on the Sel ect Processi ng Opti ons page of the
Integri ty Manager Wi zard i ndi cates how many ti mes each report or
document i s executed. A hi gh val ue for thi s setti ng can dramati cal l y
i ncrease the executi on ti me of your test, parti cul arl y i f you are
runni ng many reports or documents, or several l arge reports and
documents.

l U se 64-bi t Integri ty Manager w hen the compari son data i s l arge.

The defaul t posi ti on of 64-bi t Integri ty Manager i s under
C: \P ro gr a m F i l e s ( x 8 6 ) \ M i c r o S t r a t e g y \ I n t e g r i t y
Ma na ge r cal l ed M I n t M g r _6 4 . e x e. Addi ti onal l y, use 64-bi t
Integri ty Manager i f you have memory i ssues.

Best Practices for Using Integrity Manager

Mi croStrategy recommends the fol l ow i ng best practi ces w hen usi ng
Integri ty Manager:

l R un l arge i ntegri ty tests duri ng off-peak hours, so that the l oad on

Intel l i gence Server from the i ntegri ty test does not i nterfere w i th
normal operati on. You can execute i ntegri ty tests from the command
l i ne usi ng a schedul er, such as the Wi ndow s AT schedul er. For
i nformati on about executi ng i ntegri ty tests from the command l i ne,
see Executi ng a Test from the C ommand Li ne, page 1280.

l Before performi ng a system upgrade, such as a database upgrade

or a Mi croStrategy metadata upgrade, create a basel i ne of the
reports you w ant to test. You can create thi s basel i ne by executi ng
a si ngl e-proj ect i ntegri ty test. Then, after the upgrade, you can
veri fy the upgrade process by executi ng a basel i ne-versus-proj ect
test of the basel i ne and the upgrade proj ect.

l U nderstand how Integri ty Manager answ ers prompted reports, and

how you can confi gure the answ ers to prompted reports, as

1274 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

descri bed i n Executi ng Prompted R eports w i th Integri ty Manager,

page 1286.

l If you are havi ng troubl e compari ng prompted reports, you can save
stati c versi ons of those reports i n a "regressi on test" fol der i n each
proj ect, and use those stati c reports for i ntegri ty tests.

l In a comparati ve i ntegri ty test, you must have the same OS versi on

and the same font i nstal l ed on your machi ne to use the Graph
vi ew  to compare tw o PD F reports. Font renderi ng on a PD F i s
versi on and OS speci fi c, so di fferences may resul t i n formatti ng
i ssues, w hi ch can affect compari son resul ts.

l If your Mi croStrategy securi ty confi gurati on i nvol ves securi ty fi l ters,

make sure that the user executi ng the i ntegri ty test has the same
securi ty fi l ters for both proj ects. For exampl e, you can create a test
user w ho has the same securi ty fi l ter for each proj ect, and execute
al l i ntegri ty tests under thi s user.

l Al ternatel y, you can execute the test usi ng mul ti pl e Mi croStrategy

users, as descri bed i n Executi ng a Test U nder Mul ti pl e
Mi croStrategy U ser Accounts, page 1291. Make sure that the
users that you are compari ng have matchi ng securi ty fi l ters. For
exampl e, i f U ser1 i s assi gned securi ty fi l ter F i l t e r A i n proj ect
Pr oj ec t1 , make sure you compare the reports w i th a user w ho i s
al so assi gned securi ty fi l ter F i l t e r A i n proj ect P r o j e c t 2.

l When you are compari ng graph reports and noti ng the di fferences
betw een the graphs, adj ust the Granul ari ty sl i der so that the
di fferences are grouped i n a w ay that i s useful . For more
i nformati on about how Integri ty Manager eval uates and groups
di fferences i n graph and PD F reports, see Groupi ng D i fferences i n
Graph and PD F R eports, page 1299.

l If you are executi ng a performance test, fol l ow the best practi ces
descri bed i n Testi ng Intel l i gence Server Performance, page 1272.

© 2019, M icr o St r at egy In c. 1275

Syst em Ad m in ist r at io n Gu id e

l When runni ng Integri ty Manager testi ng on a l arge number of

obj ects, you may need to i ncrease the memory avai l abl e to the
Integri ty Manager process. You can do i t by speci fyi ng a parameter
w hen l aunchi ng Integri ty Manager.

Heap s iz e s hould not ex c eed the av ailable memory on the mac hine
from whic h Integrity Manager is launc hed.

For ex ample, on a mac hine with 16GB of memory , y ou s hould be able

to s afely us e 12 GB for Integrity Manager.

l Open Integri ty Manager i n command l i ne w i th the -X m x fl ag and

the correspondi ng memory si ze, such as -X m x 1 2 G for 12 GB or -
Xm x1 02 40 m for 10,240 MB.

For exampl e, to execute Integri ty Manager w i th 12 GB of memory,

run the fol l ow i ng :

MI nt Mg r W _ 6 4 . e x e -X m x 1 2 G

Creating an Integrity Test

The fol l ow i ng hi gh-l evel procedure provi des an overvi ew of the steps
i nvol ved i n creati ng an i ntegri ty test. For an expl anati on of the
i nformati on requi red at any gi ven page i n the w i zard, see the H el p
(from the w i zard, cl i ck H elp, or press F1).

To Create an Integrity Test

1. Start Integri ty Manager. Start > A ll Programs > MicroStrategy

Products > Integrity Manager.

2. From the File menu, sel ect C reate Test.

3. Sel ect the type of test you w ant to create:

1276 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l To compare reports and documents from tw o proj ects, sel ect

Project versus project.

l To compare reports and documents agai nst a previ ousl y

establ i shed basel i ne, sel ect B aseline versus project.

l To compare reports and documents from tw o previ ousl y

establ i shed basel i nes, sel ect B aseline versus baseline.

l To confi rm that reports and documents i n a proj ect execute

w i thout errors, sel ect Single project.

4. Speci fy the basel i nes and proj ects to be tested. For each proj ect,
provi de a Mi croStrategy l ogi n and passw ord w i th the U se
Integri ty Manager pri vi l ege for that proj ect.

5. Sel ect the reports and/or documents to be tested. You can sel ect
i ndi vi dual reports or documents, or enti re fol ders. You can al so
sel ect search obj ects; i n thi s case, Integri ty Manager tests al l
reports and documents from the resul ts of the search obj ect.

If y ou s elec t any Intelligent Cube reports , mak e s ure that the

Intelligent Cube the reports are bas ed on has been publis hed
before y ou perform the integrity tes t. Integrity Manager c an tes t
the SQL of Intelligent Cubes ev en if they hav e not been publis hed,
but c annot tes t Intelligent Cube reports bas ed on an unpublis hed
Intelligent Cube.

6. Speci fy test executi on opti ons, such as how to answ er any

unansw ered prompts, w hat detai l s to l og, and w hether to use
report caches.

7. Sel ect w hat types of anal ysi s to perform. For reports, you can
anal yze any or al l of the gri d data, underl yi ng SQL, graph data,
Excel export, or PD F output. For documents you can anal yze the
Excel export or PD F output.

© 2019, M icr o St r at egy In c. 1277

Syst em Ad m in ist r at io n Gu id e

Only reports that hav e been s av ed in Graph or Grid/Graph v iew

c an be analy z ed as graphs .

You can al so sel ect to record the executi on ti me of each report

and/or document, to anal yze the performance of Intel l i gence
Server.

8. R evi ew the i nformati on presented on the Summary page.

9. C l i ck Save Test. N avi gate to the desi red di rectory, enter a fi l e

name, and cl i ck OK .

For ins truc tions on ex ec uting a s av ed tes t, s ee Savi ng and

Loadi ng a Test, page 1278 .

10. To execute the test i mmedi atel y, regardl ess of w hether you
saved the setti ngs, cl i ck R un. The Integri ty Manager Wi zard
cl oses and Integri ty Manager begi ns to execute the sel ected
reports and documents. As the reports execute, the resul ts of
each report or document appear i n the R esul ts Summary area of
the Integri ty Manager i nterface.

Saving and Loading a Test

When you have set up a test usi ng the Integri ty Manager Wi zard, you
can choose to save your setti ngs to a fi l e. Thi s enabl es you to
execute the same test at a l ater ti me w i thout havi ng to re-create the
test. For exampl e, a metri c currentl y bei ng devel oped i s causi ng
errors i n several reports. You can execute a test on those reports to
check w hether the metri c sti l l causes executi on errors. Savi ng the test
setti ngs makes i t easy to run thi s test once the l atest versi on of the
metri c i s ready.

For s ec urity reas ons , the pas s words for the projec t logins (prov ided on
the Enter Bas e Projec t Information page and Enter Target Projec t

1278 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Information page) are not s av ed to the tes t file. You mus t re-enter thes e
pas s words when y ou load the tes t.

To Save Test Settings

1. Step through the Integri ty Manager Wi zard and answ er i ts

questi ons. For detai l ed i nstructi ons, see C reati ng an Integri ty
Test, page 1276.

2. When you reach the Summary page of the Integri ty Manager

Wi zard, cl i ck Save Test.

3. N avi gate to the desi red fol der and enter a fi l e name to save the
test as. By defaul t thi s fi l e w i l l have an extensi on of .mtc.

4. C l i ck OK .

You can execute the test i mmedi atel y by cl i cki ng R un. The Integri ty
Manager Wi zard cl oses and Integri ty Manager begi ns to execute the
sel ected reports and documents. As they execute, thei r resul ts appear
i n the R esul ts Summary area of the Integri ty Manager i nterface.

To Load a Previously Saved Test

1. In Integri ty Manager, from the File menu sel ect Load Test.

2. N avi gate to the fi l e contai ni ng your test i nformati on and open i t.

The default ex tens ion for integrity tes t files is .mtc .

3. Step through the w i zard and confi rm the setti ngs for the test.

4. At the Enter B ase Project Information page and Enter Target

Project Information page, enter the passw ord for the l ogi n used
to access the base or target proj ect.

5. When you reach the Summary page, revi ew the i nformati on

presented there. When you are sati sfi ed that the test setti ngs

© 2019, M icr o St r at egy In c. 1279

Syst em Ad m in ist r at io n Gu id e

show n are correct, cl i ck R un. The Integri ty Manager w i zard

cl oses and Integri ty Manager begi ns to execute the sel ected
reports and documents. As they execute, thei r resul ts appear i n
the R esul ts Summary area of the Integri ty Manager i nterface.

Executing an Integrity Test

After creati ng or l oadi ng an i ntegri ty test, you can execute i t by
cl i cki ng R un from the Summary page of the Integri ty Manager w i zard.
You can al so execute a saved test from the command l i ne, w i thout
l aunchi ng the Integri ty Manager graphi cal i nterface. For i nstructi ons,
see Executi ng a Test from the C ommand Li ne, page 1280.

You can al so re-run reports i n a test that has j ust fi ni shed executi on.
For exampl e, a number of reports i n an i ntegri ty test may fai l because
of an error i n a metri c. You can correct the metri c and then re-run
those reports to confi rm that the reports now match. To re-run the
reports, sel ect them, and then from the R un menu, sel ect R efresh
selected items.

Executing a Test from the Command Line

Integri ty Manager's command l i ne i nterface enabl es you to execute a
test w i thout havi ng to l oad the graphi cal i nterface, or to schedul e a
test to run at speci fi c ti mes or dates. For exampl e, you perform routi ne
mai ntenance on your data w arehouse every month. U si ng the
Wi ndow s A T command or the U N IX schedul er, you can schedul e a
basel i ne-versus-proj ect test to run every month i mmedi atel y after
routi ne database mai ntenance. Thi s ensures that no reports are
broken duri ng mai ntenance.

If y ou are running Integrity Manager in a Windows env ironment, y ou

mus t be logged in to Windows with an Adminis trator ac c ount. In addition,
if y ou are running Integrity Manager direc tly from the c ommand prompt,
y ou mus t s et the c ommand prompt to run with full adminis trativ e

1280 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

priv ileges . To do this , right-c lic k on the c ommand prompt s hortc ut and
s elec t R un A s . Clear the R un this program with restricted
access c hec k box and c lic k OK.

To Execute a Previously Saved Integrity Test from the Command

Line

After creati ng and savi ng a test (for i nstructi ons, see Savi ng and
Loadi ng a Test, page 1278), cal l the Integri ty Manager executabl e
MInt Mg r. ex e w i th the parameters l i sted i n the tabl e bel ow . Al l
parameters are opti onal except the -f parameter, w hi ch speci fi es the
i ntegri ty test fi l e path and name.

By defaul t, the executabl e i s i nstal l ed i n the fol l ow i ng di rectory:

C:\Program Files (x86)\MicroStrategy\Integrity Manager

Effe c t Pa r a me te r s

I nt egrit y t est f ile pat h and name -f FileName

B ase syst em password.

For inst ruct ions on how t o specif y mult iple passwords, -b BasePassword
or passwords using special charact ers, see Pas s w ord
Sy ntax , page 1283 .

Target syst em password.

For inst ruct ions on how t o specif y mult iple passwords, -t TargetPassword
or passwords using special charact ers, see Pas s w ord
Sy ntax , page 1283 .

The f ollowing paramet ers modif y t he execut ion of t he t est . They do not modif y
t he . mt c t est f ile.

-o
Out put direct ory.
OutputDirectory

© 2019, M icr o St r at egy In c. 1281

Syst em Ad m in ist r at io n Gu id e

Effe c t Pa r a me te r s

This direct ory must exist bef ore t he t est can be

execut ed.

-logfile
Log f ile pat h and name.
LogfileName

-bserver
B ase server name.
BaseServer

-tserver
Target server name.
TargetServer

B ase server port number. -bport BasePort

Target server port number. -tport TargetPort

-bproject
B ase project .
BaseProject

-tproject
Target project .
TargetProject

-blogin BaseLogin
Login f or base project .
-blogin
For mult iple logins, enclose all logins in double quot es "BaseLogin1, ..,
(" ) and separat e each login wit h a comma (, ). BaseLoginN"

-tlogin
Login f or t arget project . TargetLogin

-tlogin
For mult iple logins, enclose all logins in double quot es
"TargetLogin1, ..,
(" ) and separat e each login wit h a comma (, )
TargetLoginN"

B ase baseline f ile pat h and name.

-bbaselinefile
The GUI Ds of object s t o be t est ed in t he baseline f ile BaseBaselineFile
must mat ch any GUI Ds specif ied in t he . mt c f ile.

Target baseline f ile pat h and name.

-tbaselinefile
The GUI Ds of object s t o be t est ed in t he baseline f ile TargetBaselineFile
must mat ch any GUI Ds specif ied in t he . mt c f ile.

1282 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Effe c t Pa r a me te r s

Whet her t o use load balancing in t he base project , t hat is,

whet her t o execut e t he report s and document s across all -bloadbalance
true
nodes of t he clust er ( True ) or on a single node ( False ).
-bloadbalance
I f t his opt ion is used, it overrides t he set t ing in t he false
int egrit y t est f ile.

Whet her t o use load balancing in t he t arget project , t hat is,

whet her t o execut e t he report s and document s across all -tloadbalance true
nodes of t he clust er ( True ) or on a single node ( False ).
-tloadbalance

I f t his opt ion is used, it overrides t he set t ing in t he false

int egrit y t est f ile.

GUI D of t he t est f older. I f t his opt ion is used, t he report s and

document s specif ied in t he int egrit y t est f ile are ignored.
I nst ead, I nt egrit y Manager execut es all report s and
-folderid
document s in t he specif ied f older. FolderGUID

This opt ion can only be used wit h a single-project

int egrit y t est or a project -versus-project int egrit y t est .

Password Syntax

When speci fyi ng passw ords w i th speci al characters, or speci fyi ng

mul ti pl e passw ords, use the fol l ow i ng syntax:

l If a passw ord contai ns a si ngl e quote (') or a comma (,), that

character must be preceded by a si ngl e quote.

l If a passw ord contai ns a doubl e quote (") that character must be

substi tuted by &quot;. If a passw ord contai ns an ampersand (&) that
character must be substi tuted by &amp;.

l For exampl e, i f the passw ord i s 1 2 ' & A B C " 1 2 , 3 then the passw ord
must be speci fi ed as 1 2 ' ' & a m p ; A B C & q u o t ; 1 2 ' , 3.

© 2019, M icr o St r at egy In c. 1283

Syst em Ad m in ist r at io n Gu id e

l If mul ti pl e l ogi ns are used, a passw ord must be speci fi ed for each
l ogi n. The enti re l i st of passw ords must be encl osed i n doubl e
quotes (") and the passw ords must be separated by a comma (,).

l If mul ti pl e passw ords are used and a user i n the base proj ect or
target proj ect has an empty passw ord, the posi ti on of that user's
passw ord i n the l i st of passw ords i s i ndi cated by a space betw een
commas.

For exampl e, i f the users for an i ntegri ty test are U ser1, U ser2, and
U ser3, and U ser2 has an empty passw ord, the l i st of passw ords i s
"p as sw or d 1 , , p a s s w o r d 3 ".

Co mman d Lin e Exit Co d es

When an i ntegri ty test that has been executed from the command l i ne
ends, i t returns a number. Thi s number i s an exi t code. If the scri pt
ends unexpectedl y, thi s exi t code can hel p you fi nd the cause of the
error.

To vi ew the error code, i n the same command prompt w i ndow as the

test executi on, type e c h o % E R R O R L E V E L % and press Enter.

Ex it
Me a ning
c ode

The t est execut ion succeeded and all report s have a st at us of

0
Mat ched.

The t est execut ion succeeded, but at least one report has a st at us
1
ot her t han Mat ched.

I nt egrit y Manager was unable t o est ablish a connect ion t o

2 I nt elligence S erver, or t he connect ion was int errupt ed during t he
t est .

E it her your I nt egrit y Manager license has expired, or you do not have
3
t he privileges necessary t o run I nt egrit y Manager. Y ou can view

1284 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Ex it
Me a ning
c ode

license inf ormat ion in License Manager.

The t est execut ion f ailed. For more inf ormat ion about t his error, see
4
t he int egrit y t est log f or t his t est .

5 The t est execut ion was abort ed by t he user.

Man u ally Ed it in g an In t egr it y Test

If you need to make mi nor changes to an i ntegri ty test, i t may be faster
to make those changes by edi ti ng the test fi l e, rather than steppi ng
through the Integri ty Manager Wi zard.

The test fi l e i s a pl ai n-text XML fi l e, and can be edi ted i n a text edi tor,
such as N otepad. For an expl anati on of al l the XML tags i ncl uded i n
the test fi l e, see Li st of Tags i n the Integri ty Test Fi l e, page 1303.

Executing a Test Against a Remote Intelligence Server

Integri ty Manager uses the Wi ndow s TC P/IP h o s t s fi l e to contact
remote Intel l i gence Servers. Thi s fi l e contai ns server names and IP
addresses for other netw orked machi nes that can be accessed from
thi s machi ne.

In Wi ndow s, to execute an i ntegri ty test agai nst an Intel l i gence Server

on a machi ne other than the one Integri ty Manager i s runni ng on, you
need to add an entry to the h o s t s fi l e for the machi ne Integri ty
Manager i s runni ng on.

To Add an Entry to the Hosts File

1. In the Wi ndow s system fol der, navi gate to the

\s ys te m 3 2 \ d r i v e r s \ e t c fol der.

© 2019, M icr o St r at egy In c. 1285

Syst em Ad m in ist r at io n Gu id e

l For Wi ndow s 2000 and Wi ndow s 2003, the system fol der i s
C: \W IN N T \.

l For Wi ndow s XP, the system fol der i s C : \ W I N D O W S \.

2. Open the h o s t s fi l e w i th a text edi tor, such as N otepad.

3. For each Intel l i gence Server machi ne that you w ant to test
agai nst, add a l i ne to the fi l e i n the same format as the exampl es
gi ven i n the fi l e.

4. Save and cl ose the h o s t s fi l e. You can now execute i ntegri ty

tests agai nst the Intel l i gence Servers speci fi ed i n the fi l e.

Executing Prompted Reports with Integrity Manager

In a prompted report, the user speci fi es certai n obj ects, such as the
el ements of an attri bute, or the range of val ues for a metri c. For an
i ntroducti on to prompts, see the Basi c R eporti ng Gui de.

Integri ty Manager can use any of the fol l ow i ng methods to resol ve

prompts:

l Personal answer: Personal answ ers are defaul t prompt answ ers
that are saved for i ndi vi dual Mi croStrategy l ogi ns. Any prompts w i th
personal answ ers saved for the l ogi n usi ng Integri ty Manager can
be resol ved usi ng those personal answ ers.

l D efault object answer: A prompted report can have tw o possi bl e

defaul t answ ers: a defaul t answ er saved w i th the prompt, and a
defaul t answ er saved w i th the report. These defaul t answ ers can be
used to resol ve the prompt. If both defaul t answ ers exi st, Integri ty
Manager uses the answ er saved w i th the report.

l Integrity Manager user-defined answer: Any requi red val ue and

hi erarchy prompts can be answ ered accordi ng to the defaul ts
provi ded i n the Sel ect Prompt Setti ngs page. You can provi de

1286 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

defaul t answ ers for val ue prompts, and a defaul t number of

el ements for hi erarchy prompts.

l Integrity Manager internal answer: Integri ty Manager can use i ts

i nternal l ogi c to attempt to answ er any other requi red prompts
w i thout defaul t answ ers. For exampl e, a prompt that requi res a
certai n number of el ements to be sel ected from a l i st can be
answ ered by sel ecti ng the mi ni mum number of el ements from the
begi nni ng of the l i st.

By defaul t Integri ty Manager uses al l of these opti ons, i n the order

l i sted above. You can di sabl e some opti ons or change the order of the
opti ons i n the Advanced Opti ons di al og box i n the Integri ty Manager
Wi zard.

For exampl e, you may w ant to never use your personal answ ers to
answ er prompts, and use the user-defi ned answ ers i nstead of the
defaul t answ ers for val ue prompts. You can confi gure the user-
defi ned answ ers for val ue prompts i n the Sel ect Prompt Setti ngs
page. Then, i n the Advanced Opti ons di al og box, cl ear the Personal
answer check box and move Integrity Manager user-defined answer
above D efault object answer.

Op t io n al Pr o mp t s
You control w hether Integri ty Manager answ ers opti onal prompts on
the Sel ect Prompt Setti ngs page of the Integri ty Manager Wi zard.

l To answ er opti onal prompts i n the same w ay as requi red prompts,

sel ect the A nswer optional prompts check box.

l To l eave opti onal prompts that do not have defaul t or personal

answ ers unansw ered, cl ear the A nswer optional prompts check
box.

© 2019, M icr o St r at egy In c. 1287

Syst em Ad m in ist r at io n Gu id e

Usin g No n -Def au lt Per so n al An swer s in Pr o mp t s

By defaul t, w hen Integri ty Manager answ ers a prompt w i th a personal
answ er, i t uses onl y the defaul t personal answ er for each prompt. If a
prompt does not have a defaul t personal answ er for the current user,
Integri ty Manager moves to the next method of prompt resol uti on.

To change thi s defaul t, i n the Advanced Opti ons di al og box, sel ect
the Group personal prompt answers by their names opti on. When
thi s opti on i s sel ected, Integri ty Manager executes each
report/document once for each personal answ er for each prompt i n the
report/document. If mul ti pl e prompts i n the report/document have
personal answ ers w i th the same name, those personal answ ers are
used for each prompt i n a si ngl e executi on of the report/document.

For pers onal prompt ans wers to be grouped, the ans wers mus t hav e the
ex ac t s ame name. For ex ample, if the bas e projec t c ontains a pers onal
prompt ans wer named A n s w e r A and the target projec t c ontains a
pers onal prompt ans wer named A n s w e r _A , thos e prompt ans wers will
not be grouped together.

For exampl e, consi der a report w i th tw o prompts, Prompt1 and

Prompt2. The user executi ng the report has personal answ ers for
each of these prompts. The personal answ ers are named as fol l ow s:

Pr ompt Ans we r s

P rompt 1 A nswerA , A nswerB

A nswerA , A nswerC,
P rompt 2
A nswerD

Integri ty Manager executes thi s report four ti mes, as show n i n the

tabl e bel ow :

1288 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Ex e c ution Pr ompt 1 a ns we r Pr ompt 2 a ns we r

1 P ersonal answer A nswerA P ersonal answer A nswerA

2 P ersonal answer A nswerB (next prompt answer met hod)

3 (next prompt answer met hod) P ersonal answer A nswerC

4 (next prompt answer met hod) P ersonal answer A nswerD

Si nce Prompt1 and Prompt2 both have a personal answ er saved w i th

the name Answ erA, Integri ty Manager groups those answ ers together
i n a si ngl e executi on. Onl y Prompt1 has an answ er named Answ erB,
so Integri ty Manager executes the report w i th Answ erB for Prompt1
and uses the next avai l abl e method for answ eri ng prompts to answ er
Prompt2. In the same w ay, onl y Prompt2 has answ ers named
Answ erC and Answ erD , so w hen Integri ty Manager executes the
report usi ng those answ ers for Prompt2 i t uses the next avai l abl e
prompt answ er method for Prompt1.

Un an swer ed Pr o mp t s
If a prompt cannot be answ ered by Integri ty Manager, the report
executi on fai l s and the report's status changes to N ot Supported. A
detai l ed descri pti on of the prompt that coul d not be answ ered can be
found i n the D etai l s tab of the R eport D ata area for that fai l ed report.
To vi ew thi s descri pti on, sel ect the report i n the R esul ts summary
area and then cl i ck the D etai l s tab.

You can confi gure Integri ty Manager to open a N ot Supported report

i n Mi croStrategy Web. You can answ er any prompts manual l y and
save the report. Integri ty Manager then executes the new l y saved
report, usi ng the speci fi ed prompt answ ers.

Prompts that cannot be answ ered by Integri ty Manager's i nternal l ogi c

i ncl ude:

© 2019, M icr o St r at egy In c. 1289

Syst em Ad m in ist r at io n Gu id e

l Prompts that cannot be answ ered at al l , such as an el ement l i st

prompt that contai ns no el ements i n the l i st

l Level prompts that use the resul ts of a search obj ect to generate a
l i st of possi bl e l evel s

l Prompted metri c qual i fi cati ons (used i n fi l ters or custom groups)

l MD X expressi on prompts

To Resolve Unanswered Prompts in MicroStrategy Web

Conf i gur e t he Int egr i t y Test t o Op en t he Rep or t s i n M i cr oSt r at egy

Web

1. C reate an i ntegri ty test. Step through the Integri ty Manager

Wi zard and enter the i nformati on requi red on each page.

2. In the Sel ect Prompt Setti ngs page, cl i ck A dvanced Options.

3. Sel ect the Link to MicroStrategy Web for unresolved prompts

check box.

4. In the U R L for B ase connection and U R L for Target

C onnection fi el ds, type the U R L for the basel i ne and target
proj ects' Web servers. To test each U R L, cl i ck the Test button. If
i t i s correct, a brow ser w i ndow opens at the mai n Mi croStrategy
Web page for that server.

The defaul t U R L for Mi croStrategy Web i s:

ht tp :/ / w e b s e r v e r n a m e/ M i c r o S t r a t e g y /
as p/ Ma i n . a s p x

w here w e b s e r v e r n a m e i s the name of your Mi croStrategy Web

server machi ne.

5. C l i ck OK .

6. Fi ni sh defi ni ng the test, then execute i t.

1290 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Resol ve t he Pr om p t s i n M i cr oSt r at egy Web

1. If any reports contai n prompts that cannot be resol ved by

Integri ty Manager, the Li nk to Mi croStrategy Web for U nresol ved
Prompts di al og box opens.

2. To save the report w i th the correct prompt answ ers, cl i ck the

report's name i n the di al og box.

If a Login dialog box opens , s elec t an authentic ation method, enter

a us ername and pas s word, and c lic k OK

3. Answ er the prompts for the report and save i t. D ependi ng on your
choi ces i n the Advanced Opti ons di al og box, you may need to
save the report as a stati c, unprompted report.

4. In Integri ty Manager, cl i ck C ontinue.

To conti nue the i ntegri ty test w i thout re-runni ng the report, cl i ck

Ignore. The report i s l i sted i n the R esul ts Summary area w i th a
status of N ot Supported. To ski p al l future requests to resol ve
prompts i n Mi croStrategy Web for thi s i ntegri ty test, cl i ck Ignore
A ll.

Executing a Test Under Multiple MicroStrategy User

Accounts
When you create an i ntegri ty test, you can speci fy mul ti pl e
Mi croStrategy user accounts to execute the reports and documents i n
the test.

For exampl e, your Mi croStrategy system may use securi ty fi l ters to

restri ct access to data for di fferent users. If you know the
Mi croStrategy l ogi n and passw ord for a user w ho has each securi ty
fi l ter, you can run the i ntegri ty test under each of these users to
ensure that the securi ty fi l ters are w orki ng as desi gned after an
upgrade. You can al so compare a set of reports from the same proj ect

© 2019, M icr o St r at egy In c. 1291

Syst em Ad m in ist r at io n Gu id e

under tw o di fferent users to ensure that the users are seei ng the same
data.

On the Enabl e Mul ti pl e Logi ns page of the Integri ty Manager Wi zard,

you speci fy the authenti cati on method, Mi croStrategy l ogi n, and
passw ord for each user. Integri ty Manager executes each
report/document i n the i ntegri ty test under each user account, one
account at a ti me, i n the order the accounts are l i sted. If you are
executi ng a comparati ve i ntegri ty test, the resul ts from the fi rst user i n
the base proj ect are compared w i th the resul ts from the fi rst user i n
the target proj ect, and so on.

For exampl e, you create a proj ect-versus-proj ect i ntegri ty test w i th

reports R eport1, R eport2, and R eport3. You are testi ng the reports
w i th users Al i ce and C arol i n the base proj ect. You w ant to compare
Al i ce's resul ts i n the base proj ect w i th Bob's resul ts i n the target
proj ect, and C arol 's resul ts i n the base proj ect w i th Al i ce's resul ts i n
the target proj ect, so you confi gure the Enabl e Mul ti pl e Logi ns page
as fol l ow s:

When the test i s executed, the reports are executed i n the fol l ow i ng
order:

Re por t Ba s e pr oje c t r e por t Ta r ge t pr oje c t

e x e c ution a nd us e r r e por t a nd us e r

1 Report 1 A lice Report 1 B ob

2 Report 2 A lice Report 2 B ob

3 Report 3 A lice Report 3 B ob

4 Report 1 Carol Report 1 A lice

1292 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Re por t Ba s e pr oje c t r e por t Ta r ge t pr oje c t

e x e c ution a nd us e r r e por t a nd us e r

5 Report 2 Carol Report 2 A lice

6 Report 3 Carol Report 3 A lice

N ote that the reports executed by Al i ce i n the base proj ect are
compared w i th the reports executed by Bob i n the target proj ect, and
the reports executed by C arol i n the base proj ect are compared w i th
the reports executed by Al i ce i n the target proj ect.

To Execute a Test with Multiple Users

1. C reate an i ntegri ty test, i ncl udi ng the i nformati on descri bed i n

the steps bel ow . Step through the Integri ty Manager Wi zard and
enter the i nformati on requi red on each page. For detai l s about
the i nformati on requi red on each page, cl i ck H elp to open the
hel p for that page of the w i zard.

2. On the Wel come page, sel ect the Enable Multiple Logins check
box.

3. On the Enabl e Mul ti pl e Logi ns page, for each user, speci fy the
authenti cati on mode, l ogi n, and passw ord.

4. Make sure the users are i n the order that you w ant the test to be
executed i n. In addi ti on, i f you are creati ng a comparati ve
i ntegri ty test, make sure that the users w hose resul ts you w ant to
compare are pai red up correctl y i n the tabl es.

5. Fi ni sh steppi ng through the w i zard and enteri ng the requi red

i nformati on. When the test i s executed, each report/document i s
executed under each speci fi ed user account.

© 2019, M icr o St r at egy In c. 1293

Syst em Ad m in ist r at io n Gu id e

Ignoring Dynamic SQL When Comparing SQL

D ynami c SQL generates SQL statements that are parti al l y created at
the ti me of executi on. D ynami c SQL may be generated di fferentl y i n
the base proj ect and i n the target proj ect, so i t can cause reports to
be fl agged as N ot Matched even i f the report SQL i s otherw i se
i denti cal .

You can confi gure Integri ty Manager to i gnore dynami c SQL i n i ts

compari son. To do thi s, make changes i n tw o pl aces: a report's VLD B
properti es and i n Integri ty Manager.

To Configure Integrity Manager to Ignore Dynamic SQL

1. For reports that use dynami c SQL, encl ose the dynami c SQL i n
i denti fyi ng SQL comments. Enter the comments i n the VLD B
properti es Pre/Post statements.

For exampl e, before each secti on of dynami c SQL, i ncl ude a

begi nni ng comment l i ne, such as:

/* B EG I N D Y N A M IC S Q L * /

At the end of each secti on of dynami c SQL, i ncl ude an endi ng

comment l i ne, such as:

/* E ND D Y N A M I C S Q L * /

2. In Integri ty Manager, create a comparati ve i ntegri ty test by

steppi ng through the Integri ty Manager w i zard.

3. On the Sel ect Processi ng Opti ons page, sel ect the SQL/MD X
check box, then cl i ck A dvanced Options.

4. Sel ect the SQL/MD X category.

5. In the D ynamic SQL Start fi el d, type the text that matches the
text you entered i n the VLD B properti es to i ndi cate the begi nni ng

1294 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

of the dynami c SQL. For thi s exampl e, type / * B E G I N

DY NA MI C S Q L * /

6. In the End fi el d, type the text that matches the text you entered
i n the VLD B properti es to i ndi cate the end of the dynami c SQL.
For thi s exampl e, type / * E N D D Y N A M I C S Q L * /

7. C l i ck OK , then conti nue through the w i zard.

Matching Equivalent SQL Strings

Someti mes reports i n the base proj ect and the target proj ect i ncl ude
SQL that i s functi onal l y equi val ent but sl i ghtl y di fferent. For exampl e,
reports i n the base proj ect mi ght use a tabl e prefi x of T E S T w hi l e
reports i n the target proj ect use a tabl e prefi x of P R O D. You w ant
Integri ty Manager to treat the tabl e prefi xes as i denti cal for purposes
of compari son, because reports that di ffer onl y i n thei r tabl e prefi xes
shoul d be consi dered i denti cal .

In thi s case, you can use the SQL R epl acement feature to repl ace
TEST w i th PR E F I X i n the base proj ect, and P R O D w i th P R E F I X i n the
target proj ect. N ow , w hen Integri ty Manager compares the report SQL,
i t treats al l occurrences of T E S T i n the base and P R O D i n the target as
PREF IX , so they are not consi dered to be di fferences.

The changes made by the SQL R epl acement Tabl e are not stored i n
the SQL fi l es for each report. R ather, Integri ty Manager stores those
changes i n memory w hen i t executes the i ntegri ty test.

Access the SQL R epl acement feature from the Advanced Opti ons
di al og box, on the Sel ect Processi ng Opti ons page of the Integri ty
Manager w i zard.

Viewing the Results of a Test

Once you have started executi ng a test, i nformati on about the reports
and documents bei ng tested appears i n the R esul ts Summary area of

© 2019, M icr o St r at egy In c. 1295

Syst em Ad m in ist r at io n Gu id e

Integri ty Manager. Thi s area l i sts al l the sel ected reports and
documents, by name and path. Each report or document al so show s
one of the fol l ow i ng statuses:

l Pending reports and documents have not yet begun to execute.

l R unning reports and documents are i n the process of executi ng.

In a performanc e tes t, this s tatus appears as R unning (#/#) . The

firs t number is the c urrent ex ec ution c y c le. The s ec ond number is the
number of times the report or doc ument will be ex ec uted in the tes t.

l Paused (#/#) reports and documents, i n a performance test, have

executed some but not al l of thei r speci fi ed number of cycl es w hen
the test executi on i s paused. The fi rst number i s the number of
cycl es that have been executed. The second number i s the number
of ti mes the report or document w i l l be executed i n the test.

l C ompleted reports and documents have fi ni shed thei r executi on

w i thout errors.

l Timed Out reports and documents di d not fi ni sh executi ng i n the

ti me speci fi ed i n the Max Timeout fi el d i n the Sel ect Executi on
Setti ngs page. These reports and documents have been cancel ed
by Integri ty Manager and w i l l not be executed agai n duri ng thi s run
of the test.

l Error i ndi cates that an error has prevented thi s report or document
from executi ng correctl y. To vi ew the error, doubl e-cl i ck the status.
The report detai l s open i n the R eport D ata area of Integri ty
Manager, bel ow the R esul ts Summary area. The error message i s
l i sted i n the Executi on D etai l s secti on.

l N ot Supported reports and documents contai n one or more prompts

for w hi ch an answ er coul d not be automati cal l y generated. To see a
descri pti on of the errors, doubl e-cl i ck the status. For detai l s of how

1296 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Integri ty Manager answ ers prompts, see Executi ng Prompted

R eports w i th Integri ty Manager, page 1286.

Addi ti onal i nformati on for C ompleted reports and documents i s

avai l abl e i n the D ata, SQL, Graph, and Excel col umns:

l Matched i ndi cates that the resul ts from the tw o proj ects are
i denti cal for the report or document. In a si ngl e-proj ect i ntegri ty test,
Matched i ndi cates that the reports and documents executed
successful l y.

l N ot Matched i ndi cates that a di screpancy exi sts betw een the tw o
proj ects for the report or document. To vi ew the reports or
documents from each proj ect i n the R eport D ata area, sel ect them i n
the R esul ts Summary area.

l N ot C ompared i ndi cates that Integri ty Manager w as unabl e to

compare the reports and documents for thi s type of anal ysi s. Thi s
can be because the report or document w as not found i n the target
proj ect, because one or more prompts are not supported by Integri ty
Manager, or because an error prevented the report or document
from executi ng.

l N ot A vailable i ndi cates that Integri ty Manager di d not attempt to

execute the report or document for thi s type of anal ysi s. Thi s may
be because thi s type of anal ysi s w as not sel ected on the Sel ect
Processi ng Opti ons page, or (i f N /A i s present i n the Graph col umn)
because the report w as not saved as a Graph or Gri d/Graph.

To vi ew a C ompleted report or document and i denti fy di screpanci es,

sel ect i ts entry i n the R esul ts Summary. The report or document
appears i n the R eport D ata area of Integri ty Manager, bel ow the
R esul ts Summary.

In a comparati ve i ntegri ty test, both the base and the target report or
document are show n i n the R eport D ata area. Any di fferences
betw een the base and target are hi ghl i ghted i n red, as fol l ow s:

© 2019, M icr o St r at egy In c. 1297

Syst em Ad m in ist r at io n Gu id e

l In the D ata, SQL, or Excel vi ew , the di fferences are pri nted i n red.
In D ata and Excel vi ew , to hi ghl i ght and bol d the next or previ ous
di fference, cl i ck the N ext D ifference or Previous D ifference i con.

l In the Graph vi ew , the current di fference i s ci rcl ed i n red. To ci rcl e

the next or previ ous di fference, cl i ck the N ext D ifference or
Previous D ifference i con. To change the w ay di fferences are
grouped, use the Granul ari ty sl i der. For more i nformati on about
di fferences i n graph reports, see Groupi ng D i fferences i n Graph and
PD F R eports, page 1299.

Viewing graphs in Ov erlap lay out enables y ou to s witc h quic k ly between

the bas e and target graphs . This lay out mak es it eas y to c ompare the
dis c repanc ies between the two graphs .

Viewing and Editing Notes

N otes are used to track addi ti onal i nformati on about reports and
documents. You can vi ew the notes attached to a report or document
i n the N otes tab of the R eport D ata area.

l Us ers of Integrity Manager c an v iew, add, and edit notes ev en if they

do not hav e the priv ileges to v iew, add, or edit notes in Mic roStrategy
Web or Dev eloper.

l Notes are not s upported on v ers ions of Intelligenc e Serv er prior to

9.0. If Integrity Manager c onnec ts to an Intelligenc e Serv er of v ers ion
8.1.2 or earlier, the Notes tab dis play s the mes s age "Notes are not
s upported for this c onnec tion."

l In a bas eline-v ers us -projec t or bas eline-v ers us -bas eline tes t, the
notes for the bas elines c an be v iewed but not edited.

To make sure you are vi ew i ng the most recent versi on of the notes,
cl i ck R efresh. Integri ty Manager contacts Intel l i gence Server and
retri eves the l atest versi on of the notes attached to the report or
document.

1298 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To add a note, enter the new note and cl i ck Submit. To edi t the notes,
cl i ck Edit, make changes to the l i sted notes, and cl i ck Submit.

If a Login dialog box opens , s elec t an authentic ation method, enter a

us ername and pas s word, and c lic k OK .

Grouping Differences in Graph and PDF Reports

You mus t hav e the s ame OS v ers ion and the s ame font ins talled on y our
mac hine to c ompare two PDF reports . Font rendering on a PDF is
v ers ion and OS s pec ific , s o differenc es may res ult in formatting is s ues ,
whic h c an affec t c omparis on res ults .

When Integri ty Manager compares tw o graph or PD F reports, i t saves

the graphs as .png or .pdf fi l es. It then performs a pi xel -by-pi xel
compari son of the tw o i mages. If any pi xel s are di fferent i n the base
and target graph, the graph or PD F i s consi dered N ot Matched.

Adj acent pi xel di fferences are grouped together and treated as a

si ngl e di fference. When you vi ew the graph or PD F reports, Integri ty
Manager draw s a red boundary around the currentl y sel ected
di fference. To navi gate through the di fferences, use the N ext
D ifference and Previous D ifference i cons on the R eport D ata
tool bar.

Each di fference has a boundary of unchanged pi xel s that i s treated as

part of the di fference. You can adj ust the si ze of thi s boundary w i th
the Granularity sl i der on the R eport D ata tool bar. Increasi ng the
granul ari ty causes mul ti pl e di fferences near each other to be treated
as a si ngl e di fference. Thi s can be useful w hen you w ant to treat the
changes to the formatti ng of a ti tl e or l egend as a si ngl e di fference, so
that you can qui ckl y navi gate to any other di fferences.

In the i mage bel ow , the ti tl e for the graph has been changed betw een
the basel i ne and the target. In the base graph, the ti tl e i s i n normal
font; i n the target, i t i s i n i tal i c font.

© 2019, M icr o St r at egy In c. 1299

Syst em Ad m in ist r at io n Gu id e

The w hi te space betw een the w ords i s the same i n both the base and
target reports. When the granul ari ty i s set to a l ow l evel , thi s
unchanged space causes Integri ty Manager to treat each w ord as a
separate di fference, as seen bel ow :

If the granul ari ty i s set to a hi gher l evel , the space betw een the w ords
i s no l onger suffi ci ent to cause Integri ty Manager to treat each w ord
as a separate di fference. The di fferences i n the ti tl e are al l grouped
together, as seen bel ow :

Accessing the Saved Results of a Test

When you execute a test, Integri ty Manager saves the resul ts of that
test to a l ocati on speci fi ed i n the Sel ect Executi on Setti ngs page of
the Integri ty Manager Wi zard. If the opti on l abel ed Store output in a
time stamped sub-folder of this directory i s sel ected, the test
resul ts are stored i n a subfol der of the speci fi ed output fol der.
Otherw i se, the test resul ts are stored di rectl y i n the output fol der.

A summary of the test resul ts i s avai l abl e i n H TML, i n the fi l e

Resu lt sS um m a r y . h t m l. Thi s fi l e gathers data from the fi l e
Resu lt sS um m a r y . x m l and formats the data w i th the styl esheets
styl e. cs s and R e s u l t s S u m m a r y . x s l.

1300 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Whi l e the test i s executi ng, a temporary resul ts fi l e, t e m p . x m l, i s

created. Thi s fi l e i s updated as each report or document compl etes
executi on. If the system crashes duri ng test executi on, the most
recent resul ts are stored i n thi s fi l e.

Rep o r t Execu t io n Ou t p u t
Wi thi n the output fol der, Integri ty Manager creates a fol der named
imag es to store the i mages used i n the R e s ul t s S u m m a r y fi l es. For
a comparati ve i ntegri ty test, a fol der named c o m m o n i s created to hol d
the seri al i zed compari son fi l es.

Integri ty Manager al so creates a separate fol der w i thi n the output

fol der for the report or document resul ts from each proj ect. These
fol ders are named after the Intel l i gence Server machi nes on w hi ch the
proj ects are kept.

l For the basel i ne server, _0 i s appended to the machi ne name to

create the name of the fol der.

l For the target server, _1 i s appended to the machi ne name.

For exampl e, the i mage bel ow i s taken from a machi ne that executes
a proj ect-versus-proj ect i ntegri ty test at ni ne AM on the fi rst Monday
of each month. The basel i ne proj ect i s on a machi ne named
ARCH IM ED ES , and the target proj ect i s on a machi ne named
PYTH AG OR AS . The fol der for the resul ts from the basel i ne proj ect i s
arch im ed es _ 0, and the fol der for the resul ts from the target proj ect
i s py t ha go ra s _ 1.

© 2019, M icr o St r at egy In c. 1301

Syst em Ad m in ist r at io n Gu id e

In a bas eline-v ers us -projec t integrity tes t, the bas eline folder is named
ba se li n e _ 0 . In a bas eline-v ers us -bas eline integrity tes t, the bas eline
folder is named b a s e l i n e _0 and the target folder is named
ba se li n e _ 1 .

Each resul ts fol der contai ns a number of fi l es contai ni ng the resul ts of

each report that i s tested. These fi l es are named < I D >_
<GUI D> . <e xt >, w here < I D > i s the number i ndi cati ng the order i n
w hi ch the report w as executed, < G U I D > i s the report obj ect GU ID ,
and < ex t> i s an extensi on based on the type of fi l e. The report
resul ts are saved i n the fol l ow i ng fi l es:

l SQL i s saved i n pl ai n text format, i n the fi l e < I D >_< G U I D >. s q l.

In a c omparativ e integrity tes t, if y ou s elec t the Sav e c olor-c oded SQL

differenc es to an HTML file c hec k box , the SQL is als o s av ed in HTML
format, in the file < ID >_< G U I D >. h t m . In this file, the SQL that is
different from the SQL in the other projec t's v ers ion of the report is
highlighted in red.

l Gri d data i s saved i n C SV format, i n the fi l e < I D >_ < G U I D >. c s v,

but onl y i f you sel ect the Save C SV files check box i n the Advanced
Opti ons di al og box.

l Graph data i s saved i n PN G format, i n the fi l e < I D >_< G U I D >. pn g,

but onl y i f the report has been saved i n Graph or Gri d/Graph format.

l Excel data i s saved i n XLS format, i n the fi l e < I D >_< G U I D >. x l s,

but onl y i f you sel ect the Save XLS files check box i n the Advanced
Opti ons di al og box.

l PD F data i s saved i n PD F format, i n the fi l e < I D >_ < G U I D >. p d f.

l N otes are saved i n pl ai n text format, i n the fi l e < I D >_

<G UI D> . no t e s . t x t. Thi s fi l e i s created even i f the correspondi ng
report does not have notes.

1302 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Only report res ults for formats reques ted in the Selec t Proc es s ing
Options page during tes t s etup are generated.

l SQL, graph, and PDF data are alway s s av ed if they are generated.
Grid and Ex c el data are only s av ed if y ou c hoos e to s av e thos e
res ults during tes t c reation. Notes are alway s s av ed.

l Integrity Manager als o c reates a file named < I D >_ < G U I D >. s e r for
eac h report or doc ument. Thes e files c ontain s erializ ed binary data
that Integrity Manager us es when y ou open a prev ious ly s av ed s et of
tes t res ults , and are not intended for us e by end us ers . Thes e files are
s tored in the s ame folder as the tes t res ults .

Each resul ts fol der al so contai ns a fi l e cal l ed b a s e l i n e . x m l that

provi des a summary of the tested reports. Thi s fi l e i s used to provi de
a basel i ne summary for basel i ne-versus-proj ect and basel i ne-versus-
basel i ne i ntegri ty tests.

To Open a Previously Saved Set of Test Results

l In Integri ty Manager, go to File > Open R esults.

l Brow se to the l ocati on of the saved test.

l Sel ect the R e s u l t s S u m m a r y . x m l fi l e and cl i ck Open.

List of Tags in the Integrity Test File

When you save an i ntegri ty test, i t i s saved as an XML fi l e, w i th an
extensi on of .MTC . For i nstructi ons on savi ng or l oadi ng an i ntegri ty
test, see Savi ng and Loadi ng a Test, page 1278.

If needed, you can edi t the i ntegri ty test fi l e w i th any XML edi tor or
text edi tor, such as N otepad. The tabl e bel ow l i sts al l the XML tags i n
an i ntegri ty test fi l e, w i th an expl anati on of each tag.

© 2019, M icr o St r at egy In c. 1303

Syst em Ad m in ist r at io n Gu id e

XML Ta g Func tion

Gen eral t est in f o rmat io n

Type of int egrit y t est , as displayed in t he

Result sS ummary f ile:

• Project versus Project Integrity Test

• Baseline versus Project Integrity Test

Execution_Mode
• Baseline versus Baseline Integrity Test

• Single Project Integrity Test

This value is f or display and localizat ion

purposes only.

Type of int egrit y t est , as execut ed by I nt egrit y

Manager:

• 1 : P roject versus P roject int egrit y t est

Execution_Mode_Value
• 2 : S ingle P roject int egrit y t est

• 3 : B aseline versus P roject int egrit y t est

• 4 : B aseline versus B aseline int egrit y t est

V ersion of I nt egrit y Manager t hat creat ed t he

LocalVersion
t est .

Whet her t his int egrit y t est support s mult iple

logins:

• true : This int egrit y t est support s mult iple

isMultiUser
logins.

• false : This int egrit y t est does not support

mult iple logins.

Which ConnectionIndex (0 or 1) indicat es t he

Base_Connection_Index base connect ion. The ot her ConnectionIndex
is t he t arget connect ion.

B ase o r T arg et co n n ect io n in f o rmat io n

1304 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

XML Ta g Func tion

E xcept in a single project int egrit y t est , t his sect ion is repeat ed f or bot h
t he base connect ion and t he t arget connect ion.

0 or 1 , depending on t he value of Base_

Connection_
ConnectionIndex=
Index and whet her t he inf ormat ion below is f or
t he base or t arget connect ion.

Server_Name Name or I P address of t he I nt elligence S erver.

Port P ort number of t he I nt elligence S erver.

Login aut hent icat ion mode corresponding t o t he

Login t ag below. I f isMultiUser is set t o
true , t here can be mult iple Authentication_
Mode and Login t ag pairs.

Authentication_Mode • 1 : S t andard

• 2 : Windows

• 16 : LDA P

• 32 : Dat abase

Login I D corresponding t o t he
Authentication_Mode t ag above. I f
Login isMultiUser is set t o true , t here can be
mult iple Authentication_Mode and Login
t ag pairs.

Project Name of t he project .

Project_DssID GUI D of t he project .

The version of I nt elligence S erver t hat host s t he

Version
project .

Whet her t o use load balancing across t he clust er

f or t his connect ion, t hat is, whet her t o execut e
Use_Load_Balancing
t he report s/ document s across all nodes of t he
clust er or on a single node:

© 2019, M icr o St r at egy In c. 1305

Syst em Ad m in ist r at io n Gu id e

XML Ta g Func tion

• true : Use load balancing.

• false : Do not use load balancing.

Whet her t his connect ion uses a baseline f ile:

• true : This connect ion uses a baseline.

baselineConnection
• false : This connect ion uses a live I nt elligence
S erver.

The f ull pat h t o t he baseline f ile, if

baselineFile
baselineConnection is set t o t rue.

Ob ject s t o b e t est ed

This sect ion must be repeat ed f or each object included in t he int egrit y
t est .

Type of object t o be processed by I nt egrit y

Manager:

• 3 : Report

Type • 8 : Folder

• 18 : S hort cut

• 39 : S earch object

• 55 : Document

GUID GUI D of t he object .

Name Name of t he object .

Path P at h t o t he object wit hin t he project .

Rounds (This entry is deprecated.)

Object t ype.

Reporttype I f Type is set t o 3:

• 768 : Grid view report

1306 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

XML Ta g Func tion

• 769 : Graph view report

• 770 : S QL view report

• 774 : Grid/ Graph view report

• 776 : I nt elligent Cube

• 778 : Transact ion

• 4096 : Dat amart report

I f Type is set t o 55:

• 14081 : Document

Whet her embedded search object s are processed

by t he int egrit y t est :

chaseSearches • true : P rocess embedded search object s.

• false : Do not process embedded search

object s.

Whet her t o mat ch object s by I D or pat h name:

objMatchType • 0 : Mat ch by I D.

• 1 : Mat ch by pat h name.

Whet her object mat ching is used. This is only

available f or P roject t o P roject t est s:

• true : Object mat ching is used. This allows you

Use_Obj_Match t o select which object f rom t he base project is
compared t o which object f rom t he t arget
project .

• false : Object mat ching is not used.

Only displays if Use_Obj_Mat ch is t rue. I nside

t he map is one or more E nt ry st at ement s which
Obj_Match_Map
each cont ain a K ey/ V alue pair f or a mapped
object where:

© 2019, M icr o St r at egy In c. 1307

Syst em Ad m in ist r at io n Gu id e

XML Ta g Func tion

• K ey is t he GUI D of t he object in t he base

project

• V alue is t he GUI D of t he object in t he t arget

project

Pro mp t set t in g s

Cust om answer f or t ext prompt s. To provide

mult iple cust om answers f or t ext prompt s,
textAnswer
include each answer in a separat e textAnswer
node.

Whet her cust om answers are provided f or t ext

prompt s:

• true : Cust om answers are not provided f or

textAnswerIsNull
t ext prompt s.

• false : Cust om answers are provided f or t ext

prompt s.

Cust om answer f or numeric or B ig Decimal

prompt s. To provide mult iple cust om answers f or
numberAnswer
t hese prompt s, include each answer in a
separat e numberAnswer node.

Whet her cust om answers are provided f or

numeric and B ig Decimal prompt s:

• true : Cust om answers are not provided f or

numberAnswerIsNull
numeric and B ig Decimal prompt s.

• false : Cust om answers are provided f or

numeric and B ig Decimal prompt s.

Cust om answer f or dat e prompt s. To provide

mult iple cust om answers f or dat e prompt s,
dateAnswer
include each answer in a separat e dateAnswer
node.

dateAnswerIsNull Whet her cust om answers are provided f or dat e

1308 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

XML Ta g Func tion

prompt s:

• true : Cust om answers are not provided f or

dat e prompt s.

• false : Cust om answers are provided f or dat e

prompt s.

Number of element s t hat I nt egrit y Manager

numberElementHierPrompt
select s t o answer element hierarchy prompt s.

Whet her a cust om value is provided f or t he

number of element s used t o answer element
hierarchy prompt s:
numberElementHierPrompt
• true : A cust om value is not provided f or
IsNull
element hierarchy prompt s.

• false : A cust om value is provided f or element

hierarchy prompt s.

Whet her opt ional prompt s are answered in t his

int egrit y t est :

answerOptionalPrompt • true : Opt ional and required prompt s are

answered.

• false : Only required prompt s are answered.

The prompt answer sources t o be used by t his

int egrit y t est , in t he order t hat t hey are t o be
used, separat ed by commas. Negat ive numbers
indicat e t hat t his answer source is disabled.

A ll f our prompt answer sources must be

PromptAnswerSource
included in t his paramet er.

• 1 : P ersonal answer

• -1 : P ersonal answer (disabled)

• 2 : Def ault object answers

© 2019, M icr o St r at egy In c. 1309

Syst em Ad m in ist r at io n Gu id e

XML Ta g Func tion

• -2 : Def ault object answers (disabled)

• 3 : I nt egrit y Manager user-def ined answer

• -3 : I nt egrit y Manager user-def ined answer

(disabled)

• 4 : I nt egrit y Manager int ernal answer

• -4 : I nt egrit y Manager int ernal answer

(disabled)

A prompt answer source t o be used by t his

int egrit y t est . I f mult iple prompt answer sources
are specif ied, each must have it s own
PromptAnswerSource_VAL ent ry, in t he order
t hat t hey are t o be used. V alues include:
PromptAnswerSource_VAL
• Personal answer

• Default object answers

• Integrity Manager user-defined answer

• Integrity Manager internal answer

Whet her t o open report s wit h unanswered

prompt s in MicroS t rat egy Web:

isLinkPopup • true : Open report s wit h unanswered prompt s.

• false : Do not execut e report s wit h

unanswered prompt s.

I f isLinkPopup is set t o t rue, t he URL f or t he

BaseURL
MicroS t rat egy Web server f or t he base project .

I f isLinkPopup is set t o t rue, t he URL f or t he

TargetURL
MicroS t rat egy Web server f or t he t arget project .

Whet her t o use only def ault personal prompt

Personal_Answer_Option answers, or group personal prompt answers by
t heir names:

1310 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

XML Ta g Func tion

• U SE_D EFA U LT : Use only def ault personal

prompt answers f or each prompt .

• GR OU P_B Y_N A ME : Group personal prompt

answers by t heir names.

I f Personal_Answer_Option is set t o US E _
DE FA ULT, t his must be set t o U se only default

Personal_Answer_Option_ personal prompt answer for each prompt .

Desc
I f Personal_Answer_Option is set t o
GROUP _B Y _NA ME , t his must be set t o Group
personal prompt answers by their names .

Execu t io n Set t in g s

Maximum t ime, in minut es, t hat a report can run

MaxTimeout
bef ore I nt egrit y Manager cancels it .

Maximum number of simult aneous

numSimultaneous
report / document execut ions during t he int egrit y
Executions
t est .

Whet her t o use t he cached version of a report , if

one is available:

useCache • true : Use t he report cache.

• false : Do not use t he report cache; execut e

each report against t he I nt elligence S erver.

Full pat h t o t he locat ion where t he int egrit y t est

Output_Directory
result s are saved.

Whet her t o st ore t he t est result s in a subdirect ory

of t he Output_Directory , named by dat e and
t ime of t he int egrit y t est execut ion:
isAppendDateToOutputDir
• true : S t ore result s in a t ime-st amped
subdirect ory of t he specif ied direct ory.

• false : S t ore result s in t he specif ied direct ory.

© 2019, M icr o St r at egy In c. 1311

Syst em Ad m in ist r at io n Gu id e

XML Ta g Func tion

E nable or disable logging:

LogLevel • 1 : Logging is enabled.

• -5 : Logging is disabled.

LogFile Full pat h t o t he log f ile.

Pro cessin g o p t io n s

Whet her t o enable dat a comparison f or report s:

isDataEnabled • true : E nabled.

• false : Disabled.

Whet her t o enable S QL comparison f or report s:

isSQLEnabled • true : E nabled.

• false : Disabled.

Whet her t o enable graph comparison f or report s:

isGraphEnabled • true : E nabled.

• false : Disabled.

Whet her t o enable E xcel comparison f or report s:

isExcelEnabled • true : E nabled.

• false : Disabled.

Whet her t o enable P DF comparison f or report s:

isPdfEnabled • true : E nabled.

• false : Disabled.

Whet her t o enable E xcel comparison f or

document s:
isRsdExcelEnabled
• true : E nabled.

• false : Disabled.

isRsdPdfEnabled Whet her t o enable P DF comparison f or

1312 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

XML Ta g Func tion

document s:

• true : E nabled.

• false : Disabled.

Whet her t o enable execut ion f or document s:

isRsdExecEnabled • true : E nabled.

• false : Disabled.

Number of perf ormance t est cycles t o run f or

reportCycles
each report .

Number of perf ormance t est cycles t o run f or

documentCycles
each document .

SQL p ro cessin g o p t io n s

Whet her t o save t he generat ed S QL t o an HTML

f ile wit h dif f erences highlight ed in red:
isColorCodeSQL
• true : E nabled.

• false : Disabled.

dynamicSQLStart Text marking t he beginning of any dynamic S QL.

dynamicSQLEnd Text marking t he end of any dynamic S QL.

S QL t o be replaced by t he S QL indicat ed by t he
from
to t ag.

S QL t o replace t he S QL indicat ed by t he from

to
t ag.

Where t o apply t he S QL replacement :

• 1 : B ase only.
applyTo
• 2 : Target only.

• 3 : B ase and t arget .

© 2019, M icr o St r at egy In c. 1313

Syst em Ad m in ist r at io n Gu id e

XML Ta g Func tion

D at a p ro cessin g o p t io n s

Whet her t o save t he dat a f or each report as a

CS V f ile:
isCSVEnabled
• true : E nabled.

• false : Disabled.

Excel p ro cessin g o p t io n s

For all E xcel processing opt ions, if t he opt ion is lef t blank, t he set t ing f or
t hat opt ion is import ed f rom t he user's MicroS t rat egy Web export
pref erences, as per t he U se D efault opt ion in t he I nt egrit y Manager
Wizard.

Whet her t o save dat a f or each report as an X LS

f ile:
isXLSEnabled
• true : E nabled.

• false : Disabled.

Whet her t o include t he report t it le in t he E xcel

chart :
ExportReportTitle
• 0 : Do not export t he report t it le.

• -1 : E xport t he report t it le.

Whet her t o include which report object s are

grouped in a page-by select ion in t he E xcel
chart :
ExportPageByInfo
• 0 : Do not export t he page-by inf ormat ion.

• -1 : E xport t he page-by inf ormat ion.

Whet her t o include t he report f ilt er det ails in t he

E xcel chart :
isExportFilterDetails
• true : E xport t he f ilt er det ails.

• false : Do not export t he f ilt er det ails.

1314 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

XML Ta g Func tion

Whet her t o remove t he ext ra " Met rics" column

f rom t he E xcel chart :

• 0 : Remove t he ext ra column.

isRemoveColumn
• 1 : Do not remove t he ext ra column.

• 2 : Use t he def ault set t ing in t he

MicroS t rat egy Web pref erences.

Whet her t o include all report object s in t he E xcel

chart , or only t he object s in t he def ault page-by
select ion:
ExpandAllPages
• 0 : E xport only t he def ault page-by.

• -1 : E xport all object s.

E xcel version of t he export ed f ile:

• 1 : E xcel 2000.
excelVersion
• 2 : E xcel X P / 2003.

• 4 : E xcel 2007 or newer.

Whet her t o export met ric values as t ext or as

numeric values:
isExportMetricAsText
• true : E xport met rics as t ext .

• false : E xport met rics as numeric values.

Whet her t o export dat a header values as t ext or

as numeric values:
isExportHeaderAsText
• true : E xport headers as t ext .

• false : E xport headers as numeric values.

Whet her t o export each page of t he report t o a

separat e sheet in t he E xcel f ile:
isSeparateSheets
• true : E xport each page as a separat e sheet .

• false : E xport t he ent ire report on a single

© 2019, M icr o St r at egy In c. 1315

Syst em Ad m in ist r at io n Gu id e

XML Ta g Func tion

sheet .

Whet her t o export graphs in t he report as live

E xcel graphs, or as st at ic images:

isLiveCharts • true : E xport graphs as live E xcel graphs.

• false : E xport graphs as st at ic images in t he

Result s f older.

Whet her images and graphs in t he report can be

accessed f rom t he E xcel spreadsheet wit hout
having t o run MicroS t rat egy Web:

• 0 : I mages and graphs are not embedded in

ExcelEmbedImages t he spreadsheet , and cannot be accessed
wit hout running t he report in MicroS t rat egy
Web.

• -1 : I mages and graphs are embedded in t he

spreadsheet .

Whet her MicroS t rat egy Of f ice can ref resh

report s af t er t hey have been export ed t o E xcel:

• true : Report s can be ref reshed f rom Of f ice.

• false : Report s are st at ic and cannot be

ref reshed f rom Of f ice.

This inf ormat ion applies t o MicroS t rat egy

Of f ice, t he add-in f or Microsof t Of f ice
isOfficeRefresh
applicat ions which is no longer act ively
developed.

I t was subst it ut ed wit h a new add-in,

MicroS t rat egy f or Of f ice, which support s
Of f ice 365 applicat ions. The init ial version
does not yet have all t he f unct ionalit ies of
t he previous add-in.

For more inf ormat ion, see t he

1316 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

XML Ta g Func tion

Mic roStrategy for Office page in the 2019

U pdate 1 R eadme and t he Mic roStrategy
for Offic e Online H elp .

Text of t he cust om header added t o t he E xcel

ExcelReportHeader
spreadsheet .

The locat ion of t he cust om header in t he E xcel

export :

• 0 : Display t he cust om header bef ore ot her

ExcelReportHeader report headers.
Location
• 1 : Display t he cust om header af t er ot her
report headers.

• 2 : The cust om header replaces any ot her

report headers.

Text of t he cust om f oot er added t o t he E xcel

ExcelReportFooter
spreadsheet .

PD F p ro cessin g o p t io n s

For all P DF processing opt ions, if t he opt ion is lef t blank or not list ed in
t he MTC f ile, t hat opt ion is processed using t he def ault set t ing in
I nt elligence S erver's P DF generat ion opt ions.

Whet her t o adjust t he f ont t o f it t he report t o a

cert ain percent age of t he P DF page
( ScalePercentage ), or t o f it a cert ain number
of report pages on t he page ( ScalePagesWide
Scaling and ScalePagesTall ):

• 0 : Use ScalePercentage .

• 1 : Use ScalePagesWide and

ScalePagesTall .

P ercent age t o scale t he f ont if Scaling is set t o

ScalePercentage
0.

© 2019, M icr o St r at egy In c. 1317

Syst em Ad m in ist r at io n Gu id e

XML Ta g Func tion

Number of report pages per P DF page widt h, if

ScalePagesWide
Scaling is set t o 1.

Number of report pages per P DF page height , if

ScalePagesTall
Scaling is set t o 1.

Whet her t o print t he report 's grid and graph on

t he same page:

• 0 : P rint t he grid and graph on separat e P DF

GridandGraph
pages.

• 1 : P rint t he grid and graph on t he same P DF

page.

P age orient at ion:

Orientation • 0 : P ort rait .

• 1 : Landscape.

Whet her t o include a cover page:

PrintCoverDetails • 0 : Do not print a cover page.

• 1 : P rint a cover page.

What t o include in t he cover page, if

PrintCoverDetails is set t o 1:
CoverPageDetails
Contents • 0 : Report f ilt er det ails.

• 1 : Report det ails.

The locat ion of t he cover page, if

PrintCoverDetails is set t o 1:
CoverPageLocation
• 0 : A f t er t he report .

• 1 : B ef ore t he report .

Whet her t o include all report object s in t he P DF,

ExpandAllPages or only object s in t he def ault page-by select ion:

• 0 : E xport only t he def ault page-by.

1318 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

XML Ta g Func tion

• 1 : E xport all object s.

P aper size of t he P DF:

• 0 : Let t er (8. 5" x11" )

• 1 : Legal (8. 5" x14" )

• 2 : E xecut ive (7. 25" x10. 5" )

PaperType
• 3 : Folio (8. 5" x13" )

• 4 : A 3 (11. 69" x16. 54" )

• 5 : A 4 (8. 27" x11. 69" )

• 6 : A 5 (5. 83" x8. 27" )

MarginLeft Lef t margin, in inches.

MarginRight Right margin, in inches.

MarginTop Top margin, in inches.

MarginBottom B ot t om margin, in inches.

MaxHeaderSize Maximum header size, in inches.

MaxFooterSize Maximum f oot er size, in inches.

Whet her t o use bit maps f or graphs:

GraphFormat • 10 : Use bit maps f or graphs.

• 11 : Do not use bit maps f or graphs.

Whet her t o use draf t qualit y bit maps f or graphs,

if GraphFormat is set t o 11:
PrintQuality
• 96 : Use draf t qualit y bit maps.

• 288 : Use f ine qualit y bit maps.

Whet her t o embed f ont s in t he P DF:

EmbedFonts
• 0 : Do not embed f ont s.

© 2019, M icr o St r at egy In c. 1319

Syst em Ad m in ist r at io n Gu id e

XML Ta g Func tion

• 1 : E mbed f ont s.

HeaderLeft Lef t page header.

HeaderCenter Cent er page header.

HeaderRight Right page header.

FooterLeft Lef t page f oot er.

FooterCenter Cent er page f oot er.

FooterRight Right page f oot er.

ReportHeader Report header.

Perf o rman ce p ro cessin g o p t io n s

Whet her t o include in t he perf ormance t est t he

execut ion t imes f rom report s/ document s t hat do
not complet e execut ion:
inclErrorRptIn
• true : I nclude t he execut ion t imes f rom all
Performance
report s/ document s.

• false : I nclude only t he execut ion t imes f rom

report s/ document s t hat execut e successf ully.

1320 © 2019, M icr o St r at egy In c.

 1
SQL GENERATION AND
D ATA PROCESSING:
VLDB PROPERTIES

© 2019, M icr o St r at egy In c. 1321

Syst em Ad m in ist r at io n Gu id e

VLD B properti es al l ow you to customi ze the SQL that Mi croStrategy

generates, and determi ne how data i s processed by the Anal yti cal
Engi ne. You can confi gure properti es such as SQL j oi n types, SQL
i nserts, tabl e creati on, C artesi an j oi n eval uati on, check for nul l
val ues, and so on.

VLD B properti es can provi de support for uni que confi gurati ons and
opti mi ze performance i n speci al reporti ng and anal ysi s scenari os.
You can use the VLD B Properti es Edi tor to al ter the syntax or
behavi or of a SQL statement and take advantage of uni que, database-
speci fi c opti mi zati ons. You can al so al ter how the Anal yti cal Engi ne
processes data i n certai n si tuati ons, such as subtotal s w i th
consol i dati ons and sorti ng nul l val ues.

Each VLD B property has tw o or more VLD B setti ngs w hi ch are the
di fferent opti ons avai l abl e for a VLD B property. For exampl e, the
Metri c Joi n Type VLD B property has tw o VLD B setti ngs, Inner Joi n
and Outer Joi n.

Some of the qual i ti es that make VLD B properti es val uabl e are:

l C ompl ete database support: VLD B properti es al l ow you to easi l y

i ncorporate and take advantage of new database pl atforms and
versi ons.

l Opti mi zati on: You can take advantage of database-speci fi c setti ngs
to further enhance the performance of queri es.

l Fl exi bi l i ty: VLD B properti es are avai l abl e at mul ti pl e l evel s so that
the SQL generated for one report, for exampl e, can be mani pul ated
separatel y from the SQL generated for another, si mi l ar report. For a
di agram, see Order of Precedence, page 1323.

Modify ing any VLDB property s hould be performed with c aution only
after unders tanding the effec ts of the VLDB s ettings y ou want to apply .
A giv en VLDB s etting c an s upport or optimiz e one s y s tem s etup, but the
s ame s etting c an c aus e performanc e is s ues or errors for other

1322 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

s y s tems . Us e this manual to learn about the VLDB properties before

modify ing any default s ettings .

Supporting Your System Configuration

D i fferent SQL standards among vari ous database pl atform (D BMS)
types requi re that some VLD B properti es are i ni ti al i zed to di fferent
defaul t setti ngs dependi ng on the D BMS used. For exampl e, w hen
usi ng a Mi crosoft Access 2000 database, the Joi n Type VLD B
property i s set to Joi n 89. Thi s type of i ni ti al i zati on ensures that
di fferent D BMS types can be supported. These i ni ti al i zati ons are al so
used as the defaul t VLD B setti ngs for the respecti ve D BMS type. To
create and revi ew a detai l ed l i st of al l the defaul t VLD B setti ngs for
di fferent D BMS types, see D efaul t VLD B Setti ngs for Speci fi c D ata
Sources, page 1643.

VLD B properti es al so hel p you confi gure and opti mi ze your system.
You can use Mi croStrategy for di fferent types of data anal ysi s on a
vari ety of data w arehouse i mpl ementati ons. VLD B properti es offer
di fferent confi gurati ons to support or opti mi ze your reporti ng and
anal ysi s requi rements i n the best w ay.

For exampl e, you may fi nd that enabl i ng the Set Operator

Opti mi zati on VLD B property provi des a si gni fi cant performance gai n
by uti l i zi ng set operators such as E X C E P T and I N T E R S E C T i n your
SQL queri es. On the other hand, thi s property must offer the opti on to
be di sabl ed, si nce not al l D BMS types support these types of
operators. VLD B properti es offer you a choi ce i n confi guri ng your
system.

Order of Precedence
VLD B properti es can be set at mul ti pl e l evel s, provi di ng fl exi bi l i ty i n
the w ay you can confi gure your reporti ng envi ronment. For exampl e,

© 2019, M icr o St r at egy In c. 1323

Syst em Ad m in ist r at io n Gu id e

you can choose to appl y a setti ng to an enti re database i nstance or

onl y to a si ngl e report associ ated w i th that database i nstance.

The fol l ow i ng di agram show s how VLD B properti es that are set for
one l evel take precedence over those set for another.

The arrow s depi ct the overri de authori ty of the l evel s, w i th the report
l evel havi ng the greatest authori ty. For exampl e, i f a VLD B property i s
set one w ay for a report and the same property i s set di fferentl y for
the database i nstance, the report setti ng takes precedence.

Properti es set at the report l evel overri de properti es at every other

l evel . Properti es set at the templ ate l evel overri de those set at the
metri c l evel , the database i nstance l evel , and the D BMS l evel , and so
on.

A limited number of properties c an be applied at eac h lev el.

1324 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Accessing and Working with VLDB Properties

Opening the VLDB Properties Editor
You can change the VLD B setti ngs for di fferent l evel s usi ng the VLD B
Properti es Edi tor. (Level s are descri bed i n Order of Precedence, page
1323.) You can access the VLD B Properti es Edi tor i n several w ays,
dependi ng on w hat l evel of Mi croStrategy obj ects you w ant to i mpact
w i th your VLD B property changes. For exampl e, you can appl y a
setti ng to an enti re database i nstance, or onl y to a si ngl e report
associ ated w i th that database i nstance.

When you access the VLD B Properti es Edi tor for a database i nstance,
you see the most compl ete set of the VLD B properti es. H ow ever, not
al l properti es are avai l abl e at the database i nstance l evel . The rest of
the access methods have a l i mi ted number of properti es avai l abl e
dependi ng on w hi ch properti es are supported for the sel ected
obj ect/l evel .

The tabl e bel ow descri bes every w ay to access the VLD B Properti es
Edi tor:

T o set VL DB
p ro p erties at Op en th e VL DB Pro p erties Ed ito r th is way
th is level

I n t he A t t ribut e E dit or, on t he Tools menu, select VLD B

A t t ribut e
Properties .

Choose one of t he f ollowing:

• I n t he Dat abase I nst ance Manager, right -click t he dat abase

Dat abase inst ance you want t o modif y V LDB set t ings f or, and choose
I nst ance VLD B Properties .

• I n t he P roject Conf igurat ion E dit or, select t he D atabase

Instances: SQL data warehouses or t he D atabase

© 2019, M icr o St r at egy In c. 1325

Syst em Ad m in ist r at io n Gu id e

T o set VL DB
p ro p erties at Op en th e VL DB Pro p erties Ed ito r th is way
th is level

Instances: MD X data warehouses cat egory, t hen click

VLD B Properties .

I n t he Met ric E dit or, on t he Tools menu, point t o A dvanced

Met ric
Settings , and t hen select VLD B Properties .

I n t he P roject Conf igurat ion E dit or, expand Project definition ,

P roject and select A dvanced . I n t he P roject -Level V LDB set t ings area,
click C onfigure .

Report (or I n t he Report E dit or or Report V iewer, on t he D ata menu, select

I nt elligent VLD B Properties . This is also t he locat ion in which you can
Cube) access t he V LDB P ropert ies E dit or f or I nt elligent Cubes.

I n t he Templat e E dit or, on t he D ata menu, select VLD B

Templat e
Properties .

I n t he Transf ormat ion E dit or, on t he Tools menu, select VLD B

Properties . Only one propert y (Transf ormat ion Role P rocessing) is
Transf ormat ion
available at t his level. A ll ot her V LDB propert ies must be accessed
f rom one of t he ot her levels list ed in t his t able.

l Only a s ingle property , c alled Unbalanc ed or Ragged Hierarc hy , c an

be s et at the hierarc hy lev el. This property 's purpos e and ins truc tions
to s et it are des c ribed in the MD X C ube R eporti ng Gui de .

l VLDB properties ex is t at the filter lev el and the func tion lev el, but they
are not ac c es s ible through the VLDB Properties Editor.

l All VLDB properties at the DBMS lev el are us ed for initializ ation and
debugging only . You c annot modify a VLDB property at the DBMS
lev el.

The VLD B Properti es Edi tor has the fol l ow i ng areas:

1326 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l VLD B Settings list: Show s the l i st of fol ders i nto w hi ch the VLD B
properti es are grouped. Expand a fol der to see the i ndi vi dual
properti es. The setti ngs l i sted depend on the l evel at w hi ch the
VLD B Properti es Edi tor w as accessed (see the tabl e above). For
exampl e, i f you access the VLD B Properti es Edi tor from the proj ect
l evel , you onl y see Anal yti cal Engi ne properti es.

l Options and Parameters box: Where you set or change the

parameters that affect the SQL syntax.

l SQL preview box: (Onl y appears for VLD B properti es that di rectl y
i mpact the SQL statement.) Show s a sampl e SQL statement and
how i t changes w hen you edi t a property.

When y ou c hange a property from its default, a c hec k mark appears on

the folder in whic h the property is loc ated and on the property its elf.

Creating a VLDB Settings Report

A VLD B setti ngs report di spl ays al l the current setti ngs for each VLD B
property that i s avai l abl e through a gi ven i nstance of the VLD B
Properti es Edi tor. Part of a sampl e report of setti ngs i s show n bel ow
for VLD B properti es avai l abl e at the report l evel :

© 2019, M icr o St r at egy In c. 1327

Syst em Ad m in ist r at io n Gu id e

For each report, you can al so deci de w hether to:

l D i spl ay the physi cal setti ng names al ongsi de the names that
appear i n the i nterface. The physi cal setti ng names can be useful
w hen you are w orki ng w i th Mi croStrategy Techni cal Support to
troubl eshoot the effect of a VLD B property.

l D i spl ay descri pti ons of the val ues for each setti ng. Thi s di spl ays
the ful l descri pti on of the opti on chosen for a VLD B property.

l H i de al l setti ngs that are currentl y set to defaul t val ues. Thi s can be
useful i f you w ant to see onl y those properti es and thei r setti ngs
w hi ch have been changed from the defaul t.

The steps bel ow show you how to create a VLD B setti ngs report. A
common scenari o for creati ng a VLD B setti ngs report i s to create a l i st
of defaul t VLD B setti ngs for the database or other data source you are
connecti ng to, w hi ch i s descri bed i n D efaul t VLD B Setti ngs for
Speci fi c D ata Sources, page 1643.

1328 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To Create a VLDB Settings Report

1. Open the VLD B Properti es Edi tor to di spl ay the VLD B properti es
for the l evel at w hi ch you w ant to w ork. (For i nformati on on
accessi ng the VLD B Properti es Edi tor, see Openi ng the VLD B
Properti es Edi tor, page 1325.)

2. From the Tools menu, sel ect C reate VLD B Settings R eport.

3. A report i s generated that di spl ays al l VLD B properti es avai l abl e

at the l evel from w hi ch you accessed the VLD B Properti es
Edi tor. It al so di spl ays al l current setti ngs for each VLD B
property.

4. You can choose to have the report di spl ay or hi de the

i nformati on descri bed above, by sel ecti ng the appropri ate check
boxes.

5. You can copy the content i n the report usi ng the C trl +C keys on
your keyboard. Then paste the i nformati on i nto a text edi tor or
w ord processi ng program (such as Mi crosoft Word) usi ng the
C trl +V keys.

Viewing and Changing VLDB Properties

You can change VLD B properti es to al ter the syntax of a SQL
statement and take advantage of database-speci fi c opti mi zati ons.

Modify ing any VLDB property s hould be performed with c aution only
after unders tanding the effec ts of the VLDB s ettings that y ou want to
apply . A giv en VLDB s etting c an s upport or optimiz e one s y s tem s etup,
but the s ame s etting c an c aus e performanc e is s ues or errors for other
s y s tems . Us e this manual to learn about the VLDB properties before
modify ing any default s ettings .

Some VLD B properti es are characteri zed as "advanced properti es":

advanced properti es are rel evant onl y to certai n proj ects and system

© 2019, M icr o St r at egy In c. 1329

Syst em Ad m in ist r at io n Gu id e

confi gurati ons. To w ork w i th advanced VLD B properti es, see Vi ew i ng

and C hangi ng Advanced VLD B Properti es, page 1330.

To View and Change VLDB Properties

1. Open the VLD B Properti es Edi tor to di spl ay the VLD B properti es
for the l evel at w hi ch you w ant to w ork. (For i nformati on on
obj ect l evel s, see Order of Precedence, page 1323.)

2. Modi fy the VLD B property you w ant to change. For use cases,
exampl es, sampl e code, and other i nformati on on every VLD B
property, see D etai l s for Al l VLD B Properti es, page 1336.

3. If necessary, you can ensure that a property i s set to the defaul t.

At the bottom of the Opti ons and Parameters area for that
property (on the ri ght), sel ect the U se default inherited value
check box. N ext to thi s check box name, i nformati on appears
about w hat l evel the setti ng i s i nheri ti ng i ts defaul t from.

4. C l i ck Save and C lose.

5. You must al so save i n the obj ect or edi tor w i ndow through w hi ch
you accessed the VLD B Properti es Edi tor. For exampl e, i f you
accessed the VLD B properti es by openi ng the Metri c Edi tor and
then openi ng the VLD B Properti es Edi tor, after you cl i ck Save
and C lose i n the VLD B Properti es Edi tor, you must al so cl i ck
Save and C lose i n the Metri c Edi tor to save your changes to
VLD B properti es.

Viewing and Changing Advanced VLDB Properties

By defaul t, some VLD B properti es are hi dden w hen you open the
VLD B Properti es Edi tor. These properti es are categori zed as
advanced VLD B properti es because i n general they are used
i nfrequentl y and are rel evant to onl y certai n proj ects and system
confi gurati ons. These setti ngs are not dependent on any user
pri vi l eges.

1330 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

When modify ing adv anc ed VLDB properties , the s ame c aution s hould be
tak en as when modify ing any other VLDB property .

To Display the Advanced Properties

1. Open the VLD B Properti es Edi tor to di spl ay the VLD B properti es
for the l evel at w hi ch you w ant to w ork. (For i nformati on on
obj ect l evel s, see Order of Precedence, page 1323.)

2. From the Tools menu, sel ect Show A dvanced Settings.

3. Modi fy the VLD B property you w ant to change. For use cases,
exampl es, sampl e code, and other i nformati on on every VLD B
property, see D etai l s for Al l VLD B Properti es, page 1336.

4. If necessary, you can ensure that a property i s set to the defaul t.

At the bottom of the Opti ons and Parameters area for that
property (on the ri ght), sel ect the U se default inherited value
check box. N ext to thi s check box name, i nformati on appears
about w hat l evel the setti ng i s i nheri ti ng i ts defaul t from.

5. C l i ck Save and C lose.

6. You must al so save i n the obj ect or edi tor w i ndow through w hi ch
you accessed the VLD B Properti es Edi tor. For exampl e, i f you
accessed the VLD B properti es by openi ng the Metri c Edi tor and
then openi ng the VLD B Properti es Edi tor, after you cl i ck Save
and C lose i n the VLD B Properti es Edi tor, you must al so cl i ck
Save and C lose i n the Metri c Edi tor to save your changes to
VLD B properti es.

Setting All VLDB Properties to Default

You can return al l VLD B properti es (those di spl ayed i n your chosen
i nstance of the VLD B Properti es Edi tor) to the defaul t setti ngs
recommended for your database pl atform by Mi croStrategy.

© 2019, M icr o St r at egy In c. 1331

Syst em Ad m in ist r at io n Gu id e

If y ou perform this proc edure, any c hanges y ou may hav e made to any
or all VLDB properties dis play ed in the c hos en v iew of the VLDB
Properties Editor will be los t. For details on whic h VLDB properties are
dis play ed depending on how y ou ac c es s the VLDB Properties Editor,
s ee D etai l s for Al l VLD B Properti es, page 1336 .

To Set All VLDB Property Settings to their Default Status

1. U se ei ther or both of the fol l ow i ng methods to see your system's

VLD B properti es that are not set to defaul t. You shoul d know
w hi ch VLD B properti es you w i l l be affecti ng w hen you return
properti es to thei r defaul t setti ngs:

l Generate a report l i sti ng VLD B properti es that are not set to

the defaul t setti ngs. For steps, see C reati ng a VLD B Setti ngs
R eport, page 1327, and sel ect the check box named D o not
show settings with D efault values.

l D i spl ay an i ndi vi dual VLD B property by vi ew i ng the VLD B

property w hose defaul t/non-defaul t status you are i nterested i n.
(For steps, see Vi ew i ng and C hangi ng VLD B Properti es, page
1329.) At the bottom of the Opti ons and Parameters area for
that property (on the ri ght), you can see w hether the U se
default inherited value check box i s sel ected. N ext to thi s
check box name, i nformati on appears about w hat l evel the
setti ng i s i nheri ti ng i ts defaul t from.

2. Open the VLD B Properti es Edi tor to di spl ay the VLD B properti es
that you w ant to set to thei r ori gi nal defaul ts. (For i nformati on on
obj ect l evel s, see Order of Precedence, page 1323.)

3. In the VLD B Properti es Edi tor, you can i denti fy any VLD B
properti es that have had thei r defaul t setti ngs changed, because
they are i denti fi ed w i th a check mark. The fol der i n w hi ch the
property i s stored has a check mark on i t (as show n on the Joi ns

1332 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

fol der i n the exampl e i mage bel ow ), and the property name i tsel f
has a check mark on i t (as show n on the gear i con i n front of the
C artesi an Joi n Warni ng property name i n the second i mage
bel ow ).

4. From the Tools menu, sel ect Set all values to default. See the
w arni ng above i f you are unsure about w hether to set properti es
to the defaul t.

© 2019, M icr o St r at egy In c. 1333

Syst em Ad m in ist r at io n Gu id e

5. In the confi rmati on w i ndow that appears, cl i ck Yes. Al l VLD B

properti es that are di spl ayed i n the VLD B Properti es Edi tor are
returned to thei r defaul t setti ngs.

6. C l i ck Save and C lose to save your changes and cl ose the VLD B
Properti es Edi tor.

7. You must al so save i n the obj ect or edi tor w i ndow through w hi ch
you accessed the VLD B Properti es Edi tor. For exampl e, i f you
accessed the VLD B properti es by openi ng the Metri c Edi tor and
then openi ng the VLD B Properti es Edi tor, after you cl i ck Save
and C lose i n the VLD B Properti es Edi tor, you must al so cl i ck
Save and C lose i n the Metri c Edi tor to save your changes to
VLD B properti es.

Upgrading the VLDB Options for a Particular Database

Type
The database connecti on type speci fi es the type of database that the
database i nstance represents, for exampl e, Oracl e 8i or N etezza 4.x.
(The database connecti on type i s speci fi ed on the General tab of the
D atabase Instances Edi tor.) Thi s setti ng ensures that the appropri ate
defaul t VLD B properti es, SQL syntax, and functi ons are used for your
database type.

You must have Admi ni strator pri vi l eges to upgrade the metadata. For
i nformati on on upgradi ng the metadata and your Mi croStrategy
envi ronment, see the U pgrade Gui de. When the metadata updates the
database type i nformati on:

l It l oads new database types.

l It l oads updated properti es for exi sti ng database types that are sti l l
supported.

l It keeps properti es for exi sti ng database types that are no l onger
supported. If an exi sti ng database type does not have any updates,

1334 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

but the properti es for i t have been removed, the process does not
remove them from your metadata.

The steps bel ow show you how to upgrade database types.

l You hav e upgraded y our Mic roStrategy env ironment, as des c ribed in the
U pgrade Gui de .

l You hav e an ac c ount with adminis trativ e priv ileges .

To Update Database Types

1. In D evel oper, l og i n to a proj ect source usi ng an account w i th

admi ni strati ve pri vi l eges.

2. From the Folder List, go to A dministration > C onfiguration

Managers > D atabase Instances.

3. R i ght-cl i ck any database i nstance and sel ect Edit.

4. To the ri ght of the D atabase connection type drop-dow n l i st,

cl i ck U pgrade.

5. C l i ck Load.

6. U se the arrow s to add any requi red database types by movi ng

them from the A vailable database types l i st to the Existing
database types l i st.

7. C l i ck OK tw i ce.

Modifying the VLDB Properties for a Warehouse

Database Instance
If your database vendor updates i ts functi onal i ty, you may w ant to
reset some VLD B properti es i n Mi croStrategy. For exampl e, i f the
ti meout peri od i s set too l ow and too many report queri es are bei ng
cut off, you may w ant to modi fy the SQL Ti me Out (Per Pass) setti ng.

© 2019, M icr o St r at egy In c. 1335

Syst em Ad m in ist r at io n Gu id e

For descri pti ons and exampl es of al l VLD B properti es and to see w hat
properti es can be modi fi ed, see D etai l s for Al l VLD B Properti es, page
1336.

To modi fy the VLD B properti es rel ated to a database i nstance, use

the appropri ate steps from the tabl e i n Openi ng the VLD B Properti es
Edi tor, page 1325 to access the VLD B Properti es Edi tor for the
database i nstance. Then fol l ow the steps for Vi ew i ng and C hangi ng
VLD B Properti es, page 1329.

Details for All VLDB Properties

Modify VLDB properties with c aution and only after unders tanding the
effec ts of the VLDB s ettings y ou want to apply . A giv en VLDB s etting
c an s upport or optimiz e one s y s tem s etup, but the s ame s etting c an
c aus e performanc e is s ues or errors for other s y s tems . Us e this s ec tion
to learn about the VLDB properties before modify ing any default
s ettings .

Subtotals Over Consolidations Compatibility

C onsol i dati ons al l ow users to group speci fi c attri bute el ements
together and pl ace the group on a report templ ate as i f the group w as
an attri bute. The el ements of a consol i dati on can have ari thmeti c
cal cul ati ons performed on them. The Subtotal s over C onsol i dati ons
C ompati bi l i ty property al l ow s you to determi ne how the Anal yti cal
Engi ne cal cul ates consol i dati ons.

l Evaluate subtotals over consolidation elements and their

corresponding attribute elements (behavior for 7.2.x and earlier)
(defaul t): In Mi croStrategy versi on 7.2.x and earl i er, i f a cal cul ati on
i ncl udes a consol i dati on, the Anal yti cal Engi ne cal cul ates subtotal s
across the consol i dati on el ements as w el l as across al l attri bute
el ements that compri se the consol i dati on el ement expressi ons.

1336 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Evaluate subtotals over consolidation elements only (behavior

for 7.5 and later): In Mi croStrategy versi on 7.5 and l ater, i f a
cal cul ati on i ncl udes a consol i dati on thi s setti ng al l ow s the
Anal yti cal Engi ne to cal cul ate onl y those el ements that are part of
the consol i dati on.

When y ou enable this s etting, be aware of the following requirements

and options :

Thi s VLD B property must be set at the proj ect l evel for the cal cul ati on
to be performed correctl y.

The setti ng takes effect w hen the proj ect i s i ni ti al i zed, so after thi s
setti ng i s changed you must rel oad the proj ect or restart Intel l i gence
Server.

After you enabl e thi s setti ng, you must enabl e subtotal s at ei ther the
consol i dati on l evel or the report l evel . If you enabl e subtotal s at the
consol i dati on l evel , subtotal s are avai l abl e for al l reports i n w hi ch the
consol i dati on i s used. (C onsol i dati on Edi tor > El ements menu >
Subtotal s > Enabl ed.) If you enabl e subtotal s at the report l evel ,
subtotal s for consol i dati ons can be enabl ed on a report-by-report
basi s. (R eport Edi tor > R eport D ata Opti ons > Subtotal s > Yes. If
D efaul t i s sel ected, the Anal yti cal Engi ne reverts to the
Enabl ed/D i sabl ed property as set on the consol i dati on obj ect i tsel f.)

If the projec t is regis tered on an Intelligenc e Serv er v ers ion 7.5.x but is
ac c es s ed by c lients us ing Dev eloper v ers ion 7.2.x or earlier, leav e this
property s etting on "Ev aluate s ubtotals ov er c ons olidation elements and
their c orres ponding attribute elements ." Otherwis e, metric v alues may
return as z eroes when Dev eloper 7.2.x us ers ex ec ute reports with
c ons olidations , or when they piv ot in s uc h reports .

Change this property from the default only when all Dev eloper c lients
hav e upgraded to Mic roStrategy v ers ion 7.5.x .

© 2019, M icr o St r at egy In c. 1337

Syst em Ad m in ist r at io n Gu id e

Levels at Which You Can Set This

Proj ect onl y

Three c ons olidations c alled Super Regions are c reated, defined as follows :

l Eas t (({Cus t Region=Northeas t} + {Cus t Region=Mid-Atlantic }) + {Cus t

Region=Southeas t})

l Central ({Cus t Region=Central} + {Cus t Region=South})

l Wes t ({Cus t Region=Northwes t} + {Cus t Region=Southwes t})

With the firs t s etting s elec ted, "Ev aluate s ubtotals ov er c ons olidation
elements and their c orres ponding attribute elements ," the report appears as
follows :

The Total v alue is c alc ulated for more elements than are dis play ed in the
Super Regions c olumn. The Analy tic al Engine is inc luding the following
elements in the c alc ulation: Eas t + (Northeas t + Mid-Atlantic + Southeas t)
+ Central + (Central + South) + Wes t + (Northwes t + Southwes t).

With the s ec ond s etting s elec ted, "Ev aluate s ubtotals ov er c ons olidation
elements only ," and with s ubtotals enabled, the report appears as follows :

The Total v alue is now c alc ulated for only the Super Regions c ons olidation
elements . The Analy tic al Engine is inc luding only the following elements in
the c alc ulation: Eas t + Central + Wes t.

1338 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Ap p ly Filt er Op t io n s f o r Qu er ies Again st In -Memo r y

Dat aset s
Appl y Fi l ter Opti ons for queri es agai nst i n-memory datasets i s an
advanced property that i s hi dden by defaul t. See Vi ew i ng and
C hangi ng Advanced VLD B Properti es, page 1330. for i nformati on on
how to di spl ay thi s property.

Appl y Fi l ter Opti ons for queri es agai nst i n-memory datasets
determi nes how many ti mes the vi ew fi l ter i s appl i ed, w hi ch can affect
the fi nal vi ew of data.

Cons ider this s imple report, whic h s hows y early c os t:

You c reate a Yearly Cos t deriv ed metric that us es the following definition:

Sum(Cost){!Year%}

The lev el definition of { ! Y e a r % } defines the deriv ed metric to ignore

filtering related to Year and to perform no grouping related to Year (for
ex planation and ex amples of defining the lev el for metric s , s ee the
Advanced R eporti ng Gui de ). This means that this deriv ed metric
dis play s the total c os t for all y ears , as s hown in the report below:

You c an als o further filter this report us ing a v iew filter. For ex ample, a v iew
filter is applied to this report, whic h res tric ts the res ults to only 2014, as
s hown below:

© 2019, M icr o St r at egy In c. 1339

Syst em Ad m in ist r at io n Gu id e

By default, only Cos t for 2014 is dis play ed, but Yearly Cos t remains the
s ame s inc e it has been defined to ignore filtering and grouping related to
Year. This is s upported by the default option Apply v iew filter to pas s es
touc hing fac t tables and las t join pas s of the Apply Filter Options for queries
agains t in-memory datas ets VLDB property .

If analy s ts of this report are meant to be more aware of the c os t data that
goes into the total of Yearly Cos t, y ou c an modify the Apply Filter Options
for queries agains t in-memory datas ets VLDB property to us e the option
Apply v iew filter only to pas s es touc hing fac t tables . This dis play s the other
elements of Year, as s hown in the report below:

You have the fol l ow i ng opti ons for the Appl y Fi l ter Opti ons for queri es
agai nst i n-memory datasets VLD B property:

l A pply view filter only to passes touching fact tables: Thi s opti on
appl i es the vi ew fi l ter to onl y SQL passes that touch fact tabl es, but
not to the l ast pass that combi nes the data. As show n i n the
exampl e above, thi s can i ncl ude addi ti onal i nformati on on the fi nal
di spl ay by removi ng the vi ew fi l ter from the fi nal di spl ay of the
report.

l A pply view filter to passes touching fact tables and last join
pass (defaul t): Thi s opti on appl i es the vi ew fi l ter to SQL passes
that touch fact tabl es as w el l as the l ast pass that combi nes the
data. As show n i n the exampl e above, thi s appl i es the vi ew fi l ter to
the fi nal di spl ay of the report to ensure that the data meets the
restri cti ons defi ned by the vi ew fi l ter.

1340 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Level s at Whi ch You Can Set Thi s

Proj ect, report, and templ ate

Cu st o m Gr o u p Disp lay f o r Jo in t Elemen t s

The C ustom Group D i spl ay for Joi nt El ements VLD B property
determi nes w hether to di spl ay al l attri bute el ements or j ust a si ngl e
attri bute el ement for custom groups that i ncl ude mul ti pl e attri butes for
a si ngl e custom group el ement. A custom group must meet the
fol l ow i ng cri teri a for thi s VLD B property to affect the di spl ay of the
custom group el ements:

l Tw o or more attri butes are i ncl uded i n the qual i fi cati ons for a si ngl e
custom group el ement. Thi s i ncl udes custom group el ements that
are defi ned usi ng the fol l ow i ng fi l teri ng techni ques:

Mul ti pl e fi l ter qual i fi cati ons that are based on attri butes are used to
defi ne a custom group el ement. For exampl e, you can i ncl ude one
fi l ter qual i fi cati on that fi l ters data for onl y the year 2011, and
another fi l ter qual i fi cati on that fi l ters data for the N ortheast regi on.
Thi s w oul d i ncl ude both the attri butes Year and R egi on for the
custom group el ement. Steps to create fi l ter qual i fi cati ons for
custom group el ements are provi ded i n the Advanced R eporti ng
Gui de.

A j oi nt el ement l i st i s used to defi ne the custom group el ement. A

j oi nt el ement l i st i s a fi l ter that al l ow s you to j oi n attri bute el ements
and then fi l ter on that attri bute resul t set. In other w ords, you can
sel ect speci fi c el ement combi nati ons, such as quarter and category.
Steps to create a j oi nt el ement l i st are provi ded i n the Advanced
R eporti ng Gui de.

l The i ndi vi dual attri bute el ements must be di spl ayed for each custom
group el ement. For steps to di spl ay the i ndi vi dual attri bute el ements
for a custom group el ement, see the Advanced R eporti ng Gui de.

© 2019, M icr o St r at egy In c. 1341

Syst em Ad m in ist r at io n Gu id e

For custom groups that meet the cri teri a l i sted above, the C ustom
Group D i spl ay for Joi nt El ements VLD B property provi des the
fol l ow i ng formatti ng opti ons:

l D isplay element names from all attributes in the joint element

(defaul t): D i spl ays al l of the attri bute el ements that are i ncl uded i n
the fi l ter qual i fi cati ons for the custom group el ement. For exampl e,
the attri butes R egi on and C ategory are used i n a j oi nt el ement l i st,
w hi ch i s then used to create a custom group el ement. When thi s
custom group i s i ncl uded i n a report, the attri bute el ements, for
each qual i fi cati on of the j oi nt el ement l i st, are di spl ayed for the
custom group el ements, as show n i n the report bel ow :

The attri bute el ements for both R egi on and C ategory are di spl ayed
for each custom group el ement.

l D isplay element names from only the first attribute in the joint
element: D i spl ays onl y one attri bute el ement for the attri butes that
are i ncl uded i n the fi l ter qual i fi cati ons for the custom group
el ement. An attri bute el ement from the attri bute that i s fi rst i n terms
of al phabeti cal order i s di spl ayed for the custom group. For
exampl e, the attri butes R egi on and C ategory are used i n separate
fi l ter qual i fi cati ons, w hi ch are then used to create a custom group
el ement. When thi s custom group i s i ncl uded i n a report, the
C ategory attri bute el ement i s di spl ayed for the custom group
el ements, as show n i n the report bel ow .

1342 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Onl y the attri bute el ements for the C ategory attri bute are di spl ayed.
The attri bute el ements for R egi on are not di spl ayed because
C ategory i s fi rst i n terms of al phabeti cal order.

Level s at Whi ch You Can Set Thi s

Proj ect onl y

Disp lay Nu ll On To p
The D i spl ay N ul l on Top VLD B property determi nes w here N U LL
val ues appear w hen you sort data. The defaul t i s to di spl ay the N U LL
val ues at the top of a l i st of val ues w hen sorti ng.

Wherever N U LL val ues occur i n a report, they appear as user-defi ned

stri ngs. N U LL val ues resul t from a vari ety of scenari os. N U LL val ues
can come from data retri eved from the database, from cross-tabul ati on
on a report, or from data aggregati on on a report. You can speci fy the
characters or stri ngs that appear for N U LL val ues. To do thi s, access
the Proj ect C onfi gurati on Edi tor, sel ect the R eport definition: N ull
values category, and type the stri ngs you w ant to di spl ay i n the
appropri ate fi el ds.

Level s at Whi ch You Can Set Thi s

Proj ect, report, and templ ate

Do cu men t Gr id s f r o m Mu lt ip le Dat aset s

The D ocument Gri ds from Mul ti pl e D atasets property determi nes
w hether obj ects i n Gri d/Graphs i n documents must come from a si ngl e
dataset or can come from mul ti pl e datasets.

l Objects in document grids must come from the grid's source

dataset: If you sel ect thi s opti on, obj ects i n a Gri d/Graph must come

© 2019, M icr o St r at egy In c. 1343

Syst em Ad m in ist r at io n Gu id e

from a si ngl e dataset, the source dataset used by the Gri d/Graph.
For exampl e, a document contai ns tw o datasets. D ataset 1 contai ns
R egi on and R evenue; D ataset 2 contai ns R egi on and Profi t. You
cannot create a Gri d/Graph w i th R egi on, R evenue, and Profi t. You
can use thi s opti on for backw ards compati bi l i ty w i th exi sti ng
documents.

l A llow objects in document grids to come from multiple

datasets: By defaul t, a si ngl e Gri d/Graph can contai n obj ects from
mul ti pl e datasets, provi di ng addi ti onal l evel s of data anal ysi s. A
Gri d/Graph can contai n R egi on and R evenue from D ataset 1 as w el l
as Profi t from D ataset 2.

See the D ocument C reati on Gui de for background i nformati on on

creati ng gri ds or graphs i n documents, i ncl udi ng usi ng mul ti pl e
datasets on a si ngl e gri d or graph.

Level s at Whi ch You Can Set Thi s

Proj ect onl y

Evalu at io n Or d er in g
Eval uati on Orderi ng i s an advanced property that i s hi dden by defaul t.
For i nformati on on how to di spl ay thi s property, see Vi ew i ng and
C hangi ng Advanced VLD B Properti es, page 1330.

An eval uati on order i s the order i n w hi ch the Mi croStrategy Anal yti cal
Engi ne performs di fferent ki nds of cal cul ati ons duri ng the data
popul ati on stage. The Eval uati on Orderi ng property determi nes the
order i n w hi ch cal cul ati ons are resol ved. Mi croStrategy obj ects that
are i ncl uded i n the eval uati on order i ncl ude consol i dati ons,
compound smart metri cs, report l i mi ts, subtotal s, deri ved metri cs, and
deri ved el ements. Some resul t data can di ffer dependi ng on the
eval uati on order of these obj ects.

1344 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l 6.x order - C alculate derived metric/smart compound metric

before derived elements/consolidation and all subtotals as
smart: Thi s opti on i s used pri mari l y to support backw ard
compati bi l i ty. It i s recommended i n most scenari os to update your
proj ect to use the 9.x eval uati on order descri bed bel ow .

l 7.x order - C alculate derived metric/smart compound metric

before derived elements/consolidation and all subtotals as non-
smart: Thi s opti on al l ow s you to modi fy the order of certai n
cal cul ati ons rel ati ve to the defaul t 9.x order. Addi ti onal l y, al l
subtotal s i ncl udi ng the total subtotal are not cal cul ated as smart
subtotal s. Smart subtotal s are commonl y used to cal cul ate subtotal s
that provi de rati os or percentages.

l 9.x order - C alculate derived elements/consolidation before

derived metric/smart compound metric, " total" subtotal as
smart and other subtotals as non-smart: Thi s defaul t opti on i s
recommended i n most scenari os. For exampl e, cal cul ati ng the total
subtotal as a smart subtotal al l ow s i t to cal cul ate rati os and
percentages accuratel y i n most cases. The order of the other
cal cul ati ons al so supports the most common data anal ysi s
requi rements. A common case that can requi re a di fferent
eval uati on order than the defaul t 9.x order i s the cal cul ati on and
di spl ay of rati o and percentage val ues. If your report does not
di spl ay val ues as expected, sel ect the other eval uati on orders for
your report and re-execute the report to vi ew the new resul ts.

To revi ew the eval uati on order of a report, i n D evel oper, vi ew the

report i n SQL Vi ew . In the SQL Vi ew , the secti on l i sted as
Anal yt ic al e n g i n e c a l c u l a t i o n s t e p s descri bes the order
i n w hi ch the vari ous report obj ects are eval uated. To change the
eval uati on order for a report usi ng D evel oper, on the R eport Edi tor,
from the D ata menu, sel ect R eport D ata Options. Expand the
C alculations category, and sel ect Evaluation Order. C l ear the U se

© 2019, M icr o St r at egy In c. 1345

Syst em Ad m in ist r at io n Gu id e

default evaluationorder check box to defi ne your ow n eval uati on

order.

See the Advanced R eporti ng Gui de for exampl es of how you can
modi fy the eval uati on order of obj ects i n a proj ect.

Level s at Whi ch You Can Set Thi s

Proj ect, report, and templ ate

Filt er in g o n St r in g Valu es

The Fi l teri ng on Stri ng Val ues VLD B property determi nes w hether
fi l ters consi der trai l i ng spaces i n attri bute el ements. Thi s can affect
the data that i s restri cted w hen fi l teri ng data. Thi s VLD B property has
the fol l ow i ng opti ons:

l D o not trim trailing spaces: Attri bute el ements that i ncl ude trai l i ng
spaces can be returned as separate attri bute el ements w hen
fi l teri ng on the attri bute. For exampl e, an attri bute has tw o attri bute
el ements, one w i th the descri pti on i nformati on "South" and the
other w i th the descri pti on i nformati on "South " w hi ch has an extra
trai l i ng space at the end. By sel ecti ng thi s opti on, these attri bute
el ements can be returned as separate attri bute el ements w hen
fi l teri ng on the attri bute.

l Trim trailing spaces: Attri bute el ements that i ncl ude trai l i ng
spaces are not returned as separate attri bute el ements w hen
fi l teri ng on the attri bute. Instead, any trai l i ng spaces are i gnored.
For exampl e, an attri bute has tw o attri bute el ements, one w i th the
descri pti on i nformati on "South" and the other w i th the descri pti on
i nformati on "South " w hi ch has an extra trai l i ng space at the end.
By sel ecti ng thi s opti on, onl y a si ngl e South attri bute el ement i s
returned w hen fi l teri ng on the attri bute. Si nce trai l i ng spaces are

1346 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

commonl y vi ew ed as an error i n the data, i t i s recommended that

you use thi s defaul t Tri m trai l i ng spaces opti on to i gnore any
trai l i ng spaces.

Level s at Whi ch You Can Set Thi s

Proj ect onl y

Met r ic Level Det er min at io n

The Metri c Level D etermi nati on VLD B property defi nes how the l evel
of data i s stored for reports. Thi s l evel i s used to make other
determi nati ons for the report such as the l evel at w hi ch to report
metri c data. Thi s VLD B property has the fol l ow i ng opti ons:

l Include only lowest-level attributes in metric level (defaul t): The

report's l evel i s defi ned usi ng onl y the l ow est-l evel attri butes
avai l abl e i n the report. Thi s opti on correctl y refl ects the l evel of
data i n the report w hi l e al so opti mi zi ng the amount of resources
requi red to defi ne the l evel of the report.

For exampl e, a report i ncl udes the attri butes Year, Month, C ategory,
and Subcategory. The Year and Month attri butes are from the same
hi erarchy and Month i s the l ow est-l evel attri bute from that hi erarchy
on the report. Si mi l arl y, the C ategory and Subcategory attri butes
are from the same hi erarchy and Subcategory i s the l ow est-l evel
attri bute from that hi erarchy on the report. When sel ecti ng thi s
opti on for the Metri c Level D etermi nati on VLD B property, the l evel
of the report i s defi ned as Month and Subcategory. It can be defi ned
i n thi s w ay because these are the l ow est-l evel attri butes from the
hi erarchi es that are present on the report.

Thi s l evel can then be used w i th metri cs to determi ne the l evel at

w hi ch thei r data must be reported. If the physi cal schema of your
proj ect matches the expected l ogi cal schema, correct metri c data i s

© 2019, M icr o St r at egy In c. 1347

Syst em Ad m in ist r at io n Gu id e

di spl ayed and the resources requi red to determi ne the report l evel
are opti mi zed.

l Include higher-level related attributes in metric level: The

report's l evel i s defi ned usi ng al l attri butes avai l abl e i n the report.
Thi s opti on correctl y refl ects the l evel of data i n the report, but i t
can requi re addi ti onal resources to defi ne the l evel of the report.

C onsi der the exampl e used to descri be the previ ous opti on. If the
physi cal schema of your proj ect matches the expected l ogi cal
schema, then i ncl udi ng onl y the l ow est-l evel attri butes di spl ays
correct metri c data. H ow ever, di fferences betw een your physi cal
schema and expected l ogi cal schema can cause unexpected data to
be di spl ayed i f onl y the l ow est l evel attri butes are used to defi ne
the l evel of the report.

For exampl e, w hi l e the rel ati onshi p betw een the C ategory and
Subcategory attri butes i s defi ned as a one-to-many rel ati onshi p, the
data i n your data source refl ects a many-to-many rel ati onshi p.
Because of thi s mi smatch, i ncl udi ng onl y the l ow est-l evel attri butes
can return unexpected metri c data. By sel ecti ng thi s opti on for the
Metri c Level D etermi nati on VLD B property, the addi ti onal hi gher-
l evel attri butes are i ncl uded w hen defi ni ng the l evel of the report
and can be used to return the metri c data as i t exi sts i n the data
source. H ow ever, w hi l e thi s hel ps return accurate data i n these
types of scenari os, the hi gher-l evel attri butes requi re addi ti onal
resources to defi ne the l evel of the report.

Level s at Whi ch You Can Set Thi s

Proj ect and report

Nu ll Ch eckin g f o r An alyt ical En gin e

The N ul l C hecki ng for Anal yti cal Engi ne VLD B property determi nes
w hether or not nul l val ues are i nterpreted as zeros w hen the

1348 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Anal yti cal Engi ne cal cul ates data.

The defaul t opti on i s for aggregati on cal cul ati ons to i gnore nul l s and
for scal ar cal cul ati ons to treat nul l val ues as zero. Any proj ects that
exi sted pri or to upgradi ng metadata to Mi croStrategy 2019 retai n thei r
ori gi nal VLD B property setti ngs. See the Advanced R eporti ng Gui de.
for more i nformati on on thi s setti ng.

Changes made to this VLDB s etting c an c aus e differenc es to appear in

y our data output. Metric s us ing c ount or av erage, metric s with dy namic
aggregation s et to c ount or av erage, as well as thres holds bas ed on
s uc h metric s c ould be impac ted by altered c alc ulation behav ior.

Level s at Whi ch You Can Set Thi s

Proj ect, report, templ ate, and metri c

Remo ve Missin g Un it s in Do cu men t s

If you remove or repl ace a dataset, control s on the document that
contai n data that i s no l onger avai l abl e from the dataset w i l l be
updated and w i l l no l onger contai n data from the repl aced or removed
dataset. For a Gri d/Graph, obj ects that are avai l abl e i n another

© 2019, M icr o St r at egy In c. 1349

Syst em Ad m in ist r at io n Gu id e

dataset are updated to contai n data from the other dataset. The
R emove Mi ssi ng U ni ts i n D ocuments property then determi nes how
any obj ects that are sti l l mi ssi ng are di spl ayed i n Gri d/Graphs:

l R emove objects not available in the source dataset(s): The

mi ssi ng obj ects are not di spl ayed i n the Gri d/Graph. If the
Gri d/Graph onl y contai ns mi ssi ng obj ects, i t i s di spl ayed as an
empty pl acehol der.

l D o not remove objects not available in the source dataset(s):

The headers for the mi ssi ng obj ects are di spl ayed i n the
Gri d/Graph, w i thout any data. Mi croStrategy recommends that
obj ects mi ssi ng from datasets are di spl ayed. Thi s can al ert you i f
obj ects are removed from a report used as a dataset.

For exampl e, a document contai ns tw o datasets. D ataset 1 has

C ategory, R egi on, and the R evenue and C ost metri cs. D ataset 2 has
C ategory, Subcategory, and the R evenue and Profi t metri cs. A
Gri d/Graph contai ni ng the obj ects from D ataset 1 i s di spl ayed on the
document. A porti on of the Gri d/Graph i s show n bel ow , i n Interacti ve
Mode i n Mi croStrategy Web:

135 0 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

D ataset 1 i s removed from the document. Because C ategory and

R evenue are avai l abl e from D ataset 2, they conti nue to be di spl ayed
on the Gri d/Graph. Si nce R egi on and C ost are no l onger avai l abl e i n
any dataset on the document, they are consi dered mi ssi ng obj ects.
Whi ch opti on i s sel ected i n the R emove Mi ssi ng U ni ts i n D ocuments
property then determi nes how any obj ects that are sti l l mi ssi ng are
di spl ayed i n Gri d/Graphs, as descri bed bel ow :

l R emove objects not available in the source dataset(s): The

mi ssi ng obj ects are not di spl ayed i n the Gri d/Graph, as show n
bel ow :

l D o not remove objects not available in the source dataset(s):

H eaders for the mi ssi ng obj ects are di spl ayed i n the Gri d/Graph, as
show n bel ow :

R egardl ess of the property setti ng, a text fi el d that contai ns a dataset
obj ect (such as an attri bute or a metri c) w i l l di spl ay the obj ect name
i nstead of val ues. For exampl e, a text fi el d di spl ays {R egi on} i nstead
of N orth, South, and so on.

For an exampl e that uses mul ti pl e datasets i n a si ngl e Gri d/Graph,

see the D ocument C reati on Gui de.

© 2019, M icr o St r at egy In c. 135 1

Syst em Ad m in ist r at io n Gu id e

Level s at Whi ch You Can Set Thi s

Proj ect and document

Su b t o t al Dimen sio n alit y Awar e

Mi croStrategy 7i (7.2.x and l ater) has the abi l i ty to detect the l evel of
a metri c and subtotal i t accordi ngl y. The Subtotal D i mensi onal i ty
Aw are property al l ow s you to choose betw een the 7.1 and earl i er
subtotal i ng behavi or (FALSE) and the 7.2.x and l ater subtotal i ng
behavi or (TR U E). Mi croStrategy recommends that you set thi s
property to TR U E.

If thi s property i s set to True, and a report contai ns a metri c that i s

cal cul ated at a hi gher l evel than the report l evel , the subtotal of the
metri c i s cal cul ated based on the metri c's l evel . For exampl e, a report
at the Quarter l evel contai ni ng a yearl y sal es metri c show s the yearl y
sal es as the subtotal i nstead of summi ng the row s on the report.

Level s at Whi ch You Can Set Thi s

Proj ect, report, templ ate, and metri c

Exam p l e

Quarterl y D ol l ar Sal es metri c i s defi ned as

Sum(Revenue) Dimensionality = Quarter

Yearl y D ol l ar Sal es metri c i s defi ned as

Sum (R e ve nu e ) D i m e n s i o n a l i t y = Y e a r

Qu arterly Do llar Yearly Do llar

Year Qu arter
Sales Sales

2002 1 100 600

135 2 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Qu arterly Do llar Yearly Do llar

Year Qu arter
Sales Sales

2002 2 200 600

2002 3 100 600

2002 4 200 600

2400 or 600
Grand Tot al 600 depending on t he
set t ing (see below)

If Subtotal Dimensionality Aware is Set to FALSE

The quarterl y subtotal i s cal cul ated as 600, that i s, a total of the
Quarterl y D ol l ar Sal es val ues. The yearl y subtotal i s cal cul ated as
2400, the total of the Yearl y D ol l ar Sal es val ues. Thi s i s how
Mi croStrategy 7.1 cal cul ates the subtotal .

If Subtotal Dimensionality Aware is Set to TRU E

The quarterl y subtotal i s sti l l 600. Intel l i gence Server i s aw are of the
l evel of the Yearl y D ol l ar Sal es metri c, so rather than addi ng the
col umn val ues, i t correctl y cal cul ates the Yearl y D ol l ar Sal es total as
600.

Providing Access to Intelligent Cube Data: Dynamic

Sourcing
The tabl e bel ow summari zes the D ynami c sourci ng VLD B properti es.
Addi ti onal detai l s about each property, i ncl udi ng exampl es w here
necessary, are avai l abl e by cl i cki ng on the l i nks i n the tabl e.

© 2019, M icr o St r at egy In c. 135 3

Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

• A ggregat e t ables cont ain

t he same dat a as
corresponding det ail A ggregat e
t ables and t he t ables cont ain
Def ines whet her aggregat ion f unct ion is t he same dat a
Aggregate dynamic sourcing is S UM as
Table enabled or disabled • A ggregat e t ables cont ain corresponding
Validation f or aggregat e eit her less dat a or more det ail t ables
t ables. dat a t han t heir and t he
corresponding det ail aggregat ion
t ables and/ or t he f unct ion is S UM
aggregat ion f unct ion is
not S UM

• A t t ribut e columns in f act

t ables and lookup t ables
do not cont ain NULLs A t t ribut e

and all at t ribut e columns in f act

element s in f act t ables t ables and

are present in lookup lookup t ables do

Def ines whet her
t ables not cont ain
Attribute dynamic sourcing is
NULLs and all
Validation enabled or disabled • A t t ribut e columns in f act at t ribut e
f or at t ribut es. t ables or lookup t ables element s in f act
may cont ain NULLs t ables are
and/ or some at t ribut e present in
element s in f act t ables lookup t ables
are not present in lookup
t ables

Def ines whet her t he

I nt elligent Cube
Enable • Disable Cube P arse Log
P arse log is Disable Cube
C ube Parse in S QL V iew
displayed in t he P arse Log in
Log in SQL • E nable Cube P arse Log
S QL V iew of an S QL V iew
View in S QL V iew
I nt elligent Cube.
This log helps

135 4 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

det ermine which

report s use dynamic
sourcing t o connect
t o t he I nt elligent
Cube.

Enable Def ines whet her • Disable dynamic sourcing

f or report E nable dynamic
D ynamic dynamic sourcing is
sourcing f or
Sourc ing for enabled or disabled • E nable dynamic sourcing report
R eport f or report s. f or report

Def ines whet her t he

ext ended mismat ch
log is displayed in
t he S QL V iew of a • Disable E xt ended
Enable report . The Mismat ch Log in S QL Disable
Ex tended ext ended mismat ch V iew E xt ended
Mis match log helps det ermine
• E nable E xt ended Mismat ch Log
Log in SQL why a met ric
Mismat ch Log in S QL in S QL V iew
View prevent s t he use of
dynamic sourcing is V iew

provided in t he
ext ended mismat ch
log.

Def ines whet her t he

mismat ch log is
displayed in t he S QL
V iew of a report . • Disable Mismat ch Log in
Enable
This log helps S QL V iew Disable
Mis match
det ermine why a Mismat ch Log in
Log in SQL • E nable Mismat ch Log in
report t hat can use S QL V iew
View S QL V iew
dynamic sourcing
cannot connect t o a
specif ic I nt elligent
Cube.

© 2019, M icr o St r at egy In c. 135 5

Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

Def ines whet her t he

Report P arse log is
displayed in t he
Enable S QL V iew of a • Disable Report P arse
R eport report . This log Log in S QL V iew Disable Report
Pars e Log helps det ermine P arse Log in
in SQL whet her t he report • E nable Report P arse Log S QL V iew
View can use dynamic in S QL V iew

sourcing t o connect
t o an I nt elligent
Cube.

Def ines whet her • E nable dynamic sourcing

f or met ric E nable dynamic
Metric dynamic sourcing is
sourcing f or
Validation enabled or disabled • Disable dynamic sourcing met ric
f or met rics. f or met ric

Def ines whet her • Use case insensit ive Use case
dynamic sourcing is st ring comparison wit h insensit ive
String dynamic sourcing
enabled or disabled st ring
C omparis on
f or at t ribut es t hat • Do not allow any st ring comparison
Behav ior
are used in f ilt er comparison wit h dynamic wit h dynamic
qualif icat ions. sourcing sourcing

Aggr egat e Tab le Valid at io n

Aggregate Tabl e Val i dati on i s an advanced VLD B property that i s
hi dden by defaul t. For i nformati on on how to di spl ay thi s property, see
Vi ew i ng and C hangi ng Advanced VLD B Properti es, page 1330.

R eports that use aggregate tabl es are avai l abl e for dynami c sourci ng
by defaul t, but there are some data model i ng conventi ons that shoul d
be consi dered w hen usi ng dynami c sourci ng.

In general , aggregate tabl es al l ow accurate data to be returned to

reports from Intel l i gent C ubes through dynami c sourci ng. H ow ever, i f

135 6 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

the aggregate tabl es use an aggregati on other than Sum, or there i s

di fferent data betw een aggregate tabl es and other tabl es i n the data
w arehouse, thi s can cause aggregate tabl es to return i ncorrect data
w hen dynami c sourci ng i s used. An exampl e of an aggregate tabl e not
contai ni ng the same data i s i f an aggregate tabl e i ncl udes data for
years 2006, 2007, and 2008 but the l ookup tabl e for Year onl y
i ncl udes data for 2007 and 2008.

You can enabl e and di sabl e dynami c sourci ng for aggregate tabl es by
modi fyi ng the Aggregate Tabl e Val i dati on VLD B property. Thi s VLD B
property has the fol l ow i ng opti ons:

l A ggregate tables contain the same data as corresponding detail

tables and the aggregation function is SU M (defaul t): Thi s i s the
defaul t opti on for aggregate tabl es, w hi ch enabl es aggregate tabl es
for dynami c sourci ng.

l A ggregate tables contain either less data or more data than

their corresponding detail tables and/or the aggregation
function is not SU M: Thi s opti on di sabl es dynami c sourci ng for
aggregate tabl es. Thi s setti ng shoul d be used i f your aggregate
tabl es are not model ed to support dynami c sourci ng. The use of an
aggregati on functi on other than Sum or the mi smatch of data i n your
aggregate tabl es w i th the rest of your data w arehouse can cause
i ncorrect data to be returned to reports from Intel l i gent C ubes
through dynami c sourci ng.

You can di sabl e dynami c sourci ng i ndi vi dual l y for reports that use
aggregate tabl es or you can di sabl e dynami c sourci ng for al l reports
that use aggregate tabl es w i thi n a proj ect. Whi l e the defi ni ti on of the
VLD B property at the proj ect l evel defi nes a defaul t for al l reports i n
the proj ect, any modi fi cati ons at the report l evel take precedence over
the proj ect l evel defi ni ti on. For i nformati on on defi ni ng a proj ect-w i de
dynami c sourci ng strategy, see the In-memory Anal yti cs Gui de.

© 2019, M icr o St r at egy In c. 135 7

Syst em Ad m in ist r at io n Gu id e

Level s at Whi ch You Can Set Thi s

Proj ect, report, and templ ate

At t r ib u t e Valid at io n
Attri bute Val i dati on i s an advanced VLD B property that i s hi dden by
defaul t. For i nformati on on how to di spl ay thi s property, see Vi ew i ng
and C hangi ng Advanced VLD B Properti es, page 1330.

Attri butes are avai l abl e for dynami c sourci ng by defaul t, but there are
some data model i ng conventi ons that shoul d be consi dered w hen
usi ng dynami c sourci ng.

In general , i f attri butes use outer j oi ns accurate data can be returned

to reports from Intel l i gent C ubes through dynami c sourci ng. H ow ever,
i f attri butes use i nner j oi ns, w hi ch i s a more common j oi n type, you
shoul d veri fy that the attri bute data can be correctl y represented
through dynami c sourci ng.

Tw o scenari os can cause attri butes that use i nner j oi ns to return

i ncorrect data w hen dynami c sourci ng i s used:

l Attri bute i nformati on i n l ookup and fact tabl es i ncl udes N U LL

val ues.

l Al l attri bute el ements i n fact tabl es are not al so present i n l ookup

tabl es.

You can enabl e and di sabl e dynami c sourci ng for attri butes by
modi fyi ng the Attri bute Val i dati on VLD B property. Thi s VLD B property
has the fol l ow i ng opti ons:

l A ttribute columns in fact tables and lookup tables do not

contain N U LLs and all attribute elements in fact tables are
present in lookup tables (defaul t): Thi s opti on enabl es attri butes
for dynami c sourci ng.

135 8 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l A ttribute columns in fact tables and lookup tables may contain

N U LLs and/or some attribute elements in fact tables are not
present in lookup tables: Thi s opti on di sabl es dynami c sourci ng
for attri butes. Thi s setti ng shoul d be used i f your attri bute data i s
not model ed to support dynami c sourci ng. The i ncl usi on of N U LLs
i n your attri bute data or a mi smatch betw een avai l abl e attri bute data
i n your fact and l ookup tabl es can cause i ncorrect data to be
returned to reports from Intel l i gent C ubes through dynami c
sourci ng.

You can di sabl e dynami c sourci ng for attri butes i ndi vi dual l y or you
can di sabl e dynami c sourci ng for al l attri butes w i thi n a proj ect. Whi l e
the defi ni ti on of the VLD B property at the proj ect l evel defi nes a
defaul t for al l attri butes i n the proj ect, any modi fi cati ons at the
attri bute l evel take precedence over the proj ect l evel defi ni ti on. For
i nformati on on defi ni ng a proj ect-w i de dynami c sourci ng strategy, see
the In-memory Anal yti cs Gui de.

Level s at Whi ch You Can Set Thi s

Proj ect and attri bute

En ab le Cu b e Par se Lo g in SQL View

Enabl e C ube Parse Log i n SQL Vi ew i s an advanced VLD B property
that i s hi dden by defaul t. For i nformati on on how to di spl ay thi s
property, see Vi ew i ng and C hangi ng Advanced VLD B Properti es,
page 1330.

The Intel l i gent C ube parse l og hel ps determi ne w hi ch reports use

dynami c sourci ng to connect to an Intel l i gent C ube, as w el l as w hy
some reports cannot use dynami c sourci ng to connect to an Intel l i gent
C ube. By defaul t, the Intel l i gent C ube parse l og can onl y be vi ew ed
usi ng the Mi croStrategy D i agnosti cs and Performance Loggi ng tool .

© 2019, M icr o St r at egy In c. 135 9

Syst em Ad m in ist r at io n Gu id e

You can al so al l ow thi s l og to be vi ew ed i n the SQL Vi ew of an

Intel l i gent C ube.

Thi s VLD B property has the fol l ow i ng opti ons:

l D isable C ube Parse Log in SQL View (defaul t): Thi s opti on al l ow s
the Intel l i gent C ube parse l og to onl y be vi ew ed usi ng the
Mi croStrategy D i agnosti cs and Performance Loggi ng tool .

l Enable C ube Parse Log in SQL View: Sel ect thi s opti on to al l ow
the Intel l i gent C ube parse l og to be vi ew ed i n the SQL Vi ew of an
Intel l i gent C ube. Thi s i nformati on can hel p determi ne w hi ch reports
use dynami c sourci ng to connect to the Intel l i gent C ube.

Level s at Whi ch You Can Set Thi s

Intel l i gent C ube and proj ect

En ab le Dyn amic So u r cin g f o r Rep o r t

Enabl e D ynami c Sourci ng for R eport i s an advanced VLD B property
that i s hi dden by defaul t. For i nformati on on how to di spl ay thi s
property, see Vi ew i ng and C hangi ng Advanced VLD B Properti es,
page 1330.

By defaul t, dynami c sourci ng i s di sabl ed for reports, and they

therefore retri eve thei r resul ts by runni ng agai nst the data w arehouse.
You can enabl e dynami c sourci ng for a report so that acti ve Intel l i gent
C ubes (that are al so enabl ed for dynami c sourci ng) are checked to
see i f the report can retri eve i ts data from an Intel l i gent C ube. If an
Intel l i gent C ube fi ts the data requi rements of a report, the report can
be run w i thout executi ng agai nst the data w arehouse.

You can enabl e dynami c sourci ng for reports by modi fyi ng the Enabl e
D ynami c Sourci ng for R eport VLD B property. Thi s VLD B property has
the fol l ow i ng opti ons:

1360 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l D isable dynamic sourcing for report: D ynami c sourci ng i s

di sabl ed for reports.

l Enable dynamic sourcing for report (defaul t): D ynami c sourci ng

i s enabl ed for reports.

You can enabl e dynami c sourci ng for reports i ndi vi dual l y or you can
enabl e dynami c sourci ng for al l reports w i thi n a proj ect. Whi l e the
defi ni ti on of the VLD B property at the proj ect l evel defi nes a defaul t
for al l reports i n the proj ect, any modi fi cati ons at the report l evel take
precedence over the proj ect l evel defi ni ti on. For i nformati on on
defi ni ng a proj ect-w i de dynami c sourci ng strategy, see the In-memory
Anal yti cs Gui de.

Level s at Whi ch You Can Set Thi s

Proj ect, report, and templ ate

En ab le Ext en d ed Mismat ch Lo g in SQL View

Enabl e Extended Mi smatch Log i n SQL Vi ew i s an advanced VLD B
property that i s hi dden by defaul t. For i nformati on on how to di spl ay
thi s property, see Vi ew i ng and C hangi ng Advanced VLD B Properti es,
page 1330.

The extended mi smatch l og hel ps determi ne w hy a metri c prevents

the use of dynami c sourci ng i s provi ded i n the extended mi smatch
l og. Thi s i nformati on i s l i sted for every metri c that prevents the use of
dynami c sourci ng. By defaul t, the extended mi smatch l og can onl y be
vi ew ed usi ng the Mi croStrategy D i agnosti cs and Performance
Loggi ng tool . You can al so al l ow thi s l og to be vi ew ed i n the SQL
Vi ew of a report.

The ex tended mis matc h log c an inc reas e in s iz e quic k ly and thus is bes t
s uited for troubles hooting purpos es .

Thi s VLD B property has the fol l ow i ng opti ons:

© 2019, M icr o St r at egy In c. 1361

Syst em Ad m in ist r at io n Gu id e

l D isable Extended Mismatch Log in SQL View (defaul t): Thi s

opti on al l ow s the extended mi smatch l og to onl y be vi ew ed usi ng
the Mi croStrategy D i agnosti cs and Performance Loggi ng tool .

l Enable Extended Mismatch Log in SQL View: Sel ect thi s opti on to
al l ow the extended mi smatch l og to be vi ew ed i n the SQL Vi ew of a
report. Thi s i nformati on can hel p determi ne w hy a report that can
use dynami c sourci ng cannot connect to a speci fi c Intel l i gent C ube.

Level s at Whi ch You Can Set Thi s

R eport, templ ate, and proj ect

En ab le Mismat ch Lo g in SQL View

Enabl e Mi smatch Log i n SQL Vi ew i s an advanced VLD B property that
i s hi dden by defaul t. For i nformati on on how to di spl ay thi s property,
see Vi ew i ng and C hangi ng Advanced VLD B Properti es, page 1330.

The mi smatch l og hel ps determi ne w hy a report that can use dynami c

sourci ng cannot connect to a speci fi c Intel l i gent C ube. By defaul t, the
mi smatch l og can onl y be vi ew ed usi ng the Mi croStrategy D i agnosti cs
and Performance Loggi ng tool . You can al so al l ow thi s l og to be
vi ew ed i n the SQL Vi ew of a report.

Thi s VLD B property has the fol l ow i ng opti ons:

l D isable Mismatch Log in SQL View (defaul t): Thi s opti on al l ow s

the mi smatch l og to onl y be vi ew ed usi ng the Mi croStrategy
D i agnosti cs and Performance Loggi ng tool .

l Enable Mismatch Log in SQL View: Sel ect thi s opti on to al l ow the
mi smatch l og to be vi ew ed i n the SQL Vi ew of a report. Thi s
i nformati on can hel p determi ne w hy a report that can use dynami c
sourci ng cannot connect to a speci fi c Intel l i gent C ube.

1362 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Level s at Whi ch You Can Set Thi s

R eport, templ ate, and proj ect

En ab le Rep o r t Par se Lo g in SQL View

Enabl e R eport Parse Log i n SQL Vi ew i s an advanced VLD B property
that i s hi dden by defaul t. For i nformati on on how to di spl ay thi s
property, see Vi ew i ng and C hangi ng Advanced VLD B Properti es,
page 1330.

The report parse l og hel ps determi ne w hether the report can use
dynami c sourci ng to connect to an Intel l i gent C ube. By defaul t, the
report parse l og can onl y be vi ew ed usi ng the Mi croStrategy
D i agnosti cs and Performance Loggi ng tool . You can al so al l ow thi s
l og to be vi ew ed i n the SQL Vi ew of a report.

Thi s VLD B property has the fol l ow i ng opti ons:

l D isable R eport Parse Log in SQL View (defaul t): Thi s opti on
al l ow s the report parse l og to onl y be vi ew ed usi ng the
Mi croStrategy D i agnosti cs and Performance Loggi ng tool .

l Enable R eport Parse Log in SQL View: Sel ect thi s opti on to al l ow
the report parse l og to be vi ew ed i n the SQL Vi ew of a report. Thi s
i nformati on can hel p determi ne w hether the report can use dynami c
sourci ng to connect to an Intel l i gent C ube.

Level s at Whi ch You Can Set Thi s

R eport, templ ate, and proj ect

Met r ic Valid at io n
Metri c Val i dati on i s an advanced VLD B property that i s hi dden by
defaul t. For i nformati on on how to di spl ay thi s property, see Vi ew i ng
and C hangi ng Advanced VLD B Properti es, page 1330.

© 2019, M icr o St r at egy In c. 1363

Syst em Ad m in ist r at io n Gu id e

Metri cs are avai l abl e for dynami c sourci ng by defaul t, but there are
some data model i ng conventi ons that shoul d be consi dered w hen
usi ng dynami c sourci ng.

In general , i f metri cs use outer j oi ns, accurate data can be returned to

reports from Intel l i gent C ubes through dynami c sourci ng. H ow ever, i f
metri cs use i nner j oi ns, w hi ch i s a more common j oi n type, you shoul d
veri fy that the metri c data can be correctl y represented through
dynami c sourci ng.

If the fact tabl e that stores data for metri cs i ncl udes N U LL val ues for
metri c data, thi s can cause metri cs that use i nner j oi ns to return
i ncorrect data w hen dynami c sourci ng i s used. Thi s scenari o i s
uncommon.

You can enabl e and di sabl e dynami c sourci ng for metri cs by

modi fyi ng the Metri c Val i dati on VLD B property. Thi s VLD B property
has the fol l ow i ng opti ons:

l Enable dynamic sourcing for metric (defaul t): Thi s opti on enabl es
metri cs for dynami c sourci ng.

l D isable dynamic sourcing for metric: Thi s opti on di sabl es

dynami c sourci ng for metri cs. Thi s setti ng shoul d be used i f your
metri c data i s not model ed to support dynami c sourci ng. The
i ncl usi on of N U LLs i n fact tabl es that contai n your metri c data can
cause i ncorrect data to be returned to reports from Intel l i gent C ubes
through dynami c sourci ng.

You can di sabl e dynami c sourci ng for metri cs i ndi vi dual l y or you can
di sabl e dynami c sourci ng for al l metri cs w i thi n a proj ect. Whi l e the
defi ni ti on of the VLD B property at the proj ect l evel defi nes a defaul t
for al l metri cs i n the proj ect, any modi fi cati ons at the metri c l evel take
precedence over the proj ect l evel defi ni ti on. For i nformati on on
defi ni ng a proj ect-w i de dynami c sourci ng strategy, see the In-memory
Anal yti cs Gui de.

1364 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Level s at Whi ch You Can Set Thi s

Proj ect and metri c

St r in g Co mp ar iso n Beh avio r

Stri ng C ompari son Behavi or i s an advanced VLD B property that i s
hi dden by defaul t. For i nformati on on how to di spl ay thi s property, see
Vi ew i ng and C hangi ng Advanced VLD B Properti es, page 1330.

To ensure that dynami c sourci ng can return the correct resul ts for
attri butes, you must al so veri fy that fi l teri ng on attri butes achi eves the
same resul ts w hen executed agai nst your database versus an
Intel l i gent C ube.

The resul ts returned from a fi l ter on attri butes can potenti al l y return
di fferent resul ts w hen executi ng agai nst the database versus usi ng
dynami c sourci ng to execute agai nst an Intel l i gent C ube. Thi s can
occur i f your database i s case-sensi ti ve and you create fi l ter
qual i fi cati ons that qual i fy on the text data of attri bute forms.

If your database i s case-sensi ti ve, thi s i s enforced for the fi l ter

qual i fi cati on. H ow ever, fi l teri ng for an Intel l i gent C ube i s handl ed by
the Anal yti cal Engi ne w hi ch does not enforce case sensi ti vi ty.

C onsi der a fi l ter qual i fi cati on that fi l ters on customers that have a l ast
name begi nni ng w i th the l etter h. If your database i s case-sensi ti ve
and uses uppercase l etters for the fi rst l etter i n a name, a fi l ter
qual i fi cati on usi ng a l ow ercase h i s l i kel y to return no data. H ow ever,
thi s same fi l ter qual i fi cati on on the same data stored i n an Intel l i gent
C ube returns al l customers that have a l ast name begi nni ng w i th the
l etter h.

You can confi gure thi s dynami c sourci ng behavi or for attri butes by
modi fyi ng the Stri ng C ompari son Behavi or VLD B property. Thi s VLD B
property has the fol l ow i ng opti ons:

© 2019, M icr o St r at egy In c. 1365

Syst em Ad m in ist r at io n Gu id e

l U se case insensitive string comparison with dynamic sourcing

(defaul t): When attempti ng to use dynami c sourci ng, i t al l ow s fi l ter
qual i fi cati ons to qual i fy on the text data of attri bute forms w i thout
enforci ng case sensi ti vi ty.

Thi s i s a good opti on i f your database does not enforce case

sensi ti vi ty. In thi s scenari o, dynami c sourci ng returns the same
resul ts that w oul d be returned by the fi l ter qual i fi cati on i f the report
w as executed agai nst the database.

l D o not allow any string comparison with dynamic sourcing: Thi s

opti on di sabl es dynami c sourci ng for attri butes w hen a fi l ter
qual i fi cati on i s used to qual i fy on the text data of attri bute forms.

Thi s i s a good opti on i f your database i s case sensi ti ve. In thi s

scenari o, dynami c sourci ng coul d return di fferent resul ts than w hat
w oul d be returned by the fi l ter qual i fi cati on i f the report w as
executed agai nst the database.

You can modi fy thi s VLD B property for attri butes i ndi vi dual l y or you
can modi fy i t for al l attri butes w i thi n a proj ect. Whi l e the defi ni ti on of
the VLD B property at the proj ect l evel defi nes a defaul t for al l
attri butes i n the proj ect, any modi fi cati ons at the attri bute l evel take
precedence over the proj ect l evel defi ni ti on. For i nformati on on
defi ni ng a proj ect-w i de dynami c sourci ng strategy, see the In-memory
Anal yti cs Gui de.

Level s at Whi ch You Can Set Thi s

Proj ect and attri bute

Exporting Report Results from MicroStrategy: Export

Engine
The tabl e bel ow summari zes the Export Engi ne VLD B properti es.
Addi ti onal detai l s about each property, i ncl udi ng exampl es w here
necessary, are provi ded i n the secti ons fol l ow i ng the tabl e.

1366 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Po ssib le Defau lt
Pro p erty Descrip tio n
Valu es Valu e

GU ID of Attributes
in Profit and Los s Let s you ident if y at t ribut es
A list of at t ribut e
H ierarchy t hat include empt y element s,
I D values, each
(Separated By ' :' ) which can t hen be ignored NULL
one separat ed
that has D ummy when export ing t o Microsof t
using a colon (: ).
R ow s to be E xcel or t o a P DF f ile.
R emov ed

GUID o f At t r ib u t es in Pr o f it an d Lo ss Hier ar ch y (Sep ar at ed

By ':') t h at h as Du mmy Ro ws t o b e Remo ved
GU ID of attri butes i n profi t and l oss hi erarchy (separated by ':') that
has dummy row s to be removed i s an advanced property that i s
hi dden by defaul t. For i nstructi ons on how to di spl ay thi s property,
see Vi ew i ng and C hangi ng Advanced VLD B Properti es, page 1330.

The GU ID of attri butes i n profi t and l oss hi erarchy (separated by ':')

that has dummy row s to be removed VLD B property l ets you i denti fy
attri butes that i ncl ude empty el ements, w hi ch can then be i gnored
w hen exporti ng to Mi crosoft Excel or to a PD F fi l e. Thi s i s useful
w hen creati ng fi nanci al l i ne i tem attri butes as part of supporti ng a
fi nanci al reporti ng sol uti on i n Mi croStrategy. For a detai l ed
expl anati on of how to support fi nanci al reporti ng i n Mi croStrategy,
al ong w i th usi ng thi s VLD B property to i denti fy attri butes that i ncl ude
empty el ements, refer to the Proj ect D esi gn Gui de .

To i denti fy attri butes that i ncl ude empty el ements, type the ID val ue
for each attri bute i n the text fi el d for thi s VLD B property. To determi ne
the ID val ue for an attri bute obj ect, navi gate to an attri bute i n
D evel oper, ri ght-cl i ck the attri bute, and then sel ect Properti es. D etai l s
about the attri bute, i ncl udi ng the ID val ue are di spl ayed.

© 2019, M icr o St r at egy In c. 1367

Syst em Ad m in ist r at io n Gu id e

If you need to i denti fy mul ti pl e attri butes as havi ng empty el ements,

separate each attri bute ID usi ng a col on (: ).

Levels at Which You Can Set This

Proj ect onl y

Customizing SQL Queries: Freeform SQL

The tabl e bel ow summari zes the Freeform SQL VLD B properti es.
Addi ti onal detai l s about each property, i ncl udi ng exampl es w here
necessary, are provi ded i n the secti ons fol l ow i ng the tabl e.

Defau lt
Pro p erty Descrip tio n Po ssib le Valu es
Valu e

• Do not t urn of f
warnings f or
Freef orm S QL
st at ement s wit h
empt y result s, such
as updat es. Do not t urn
of f
• Turn of f warnings f or
warnings
Freef orm S QL
Ignore P rovides t he f lexibilit y t o f or
st at ement s wit h
Empty display or hide warnings Freef orm
empt y result s, such
R es ult for when a Freef orm S QL S QL
as updat es.
Freeform st at ement ret urns an empt y st at ement s
SQL result . • Turn of f warnings f or wit h empt y
Freef orm S QL result s,
st at ement s t hat such as
ret urn mult iple result updat es.
set s wit h an empt y
f irst result set and
ret urn second result
set , such as st ored
procedures.

1368 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Pro p erty Descrip tio n Po ssib le Valu es
Valu e

XQuery Let s you validat e Transact ion

Suc cess S ervices report s t hat use User-def ined. f alse
C ode X Query.

Ign o r e Emp t y Resu lt f o r Fr eef o r m SQL

Ignore Empty R esul t for Freeform SQL i s an advanced property that i s
hi dden by defaul t. For i nformati on on how to di spl ay thi s property, see
Vi ew i ng and C hangi ng Advanced VLD B Properti es, page 1330.

The Ignore Empty R esul t for Freeform SQL VLD B property provi des
the fl exi bi l i ty to di spl ay or hi de w arni ngs w hen a Freeform SQL
statement returns an empty resul t.

Freeform SQL i s i ntended to be used to return resul ts that can be

di spl ayed on a Freeform SQL report. H ow ever, Freeform SQL can al so
be used to execute SQL statements that create tabl es, update tabl es,
or perform other database mai ntenance tasks. These types of acti ons
do not return any resul ts and therefore w oul d return a w arni ng w hen
executi ng a Freeform SQL report. If you routi nel y use Freeform SQL
for these purposes, you can hi de these w arni ngs si nce an empty
resul t set i s expected.

Thi s VLD B property has the fol l ow i ng opti ons:

l D o not turn off warnings for Freeform SQL statements with

empty results, such as updates (defaul t): Thi s opti on al l ow s
w arni ngs to be di spl ayed w hen a Freeform SQL statement causes a
Freeform SQL report to return an empty resul t. Thi s i s a good opti on
i f you use Freeform SQL to return and di spl ay data w i th Freeform
SQL reports.

© 2019, M icr o St r at egy In c. 1369

Syst em Ad m in ist r at io n Gu id e

l Turn off warnings for Freeform SQL statements with empty

results, such as updates: Sel ect thi s opti on to hi de al l w arni ngs
w hen a Freeform SQL statement causes a Freeform SQL report to
return an empty resul t. Thi s i s a good opti on i f you commonl y use
Freeform SQL to execute vari ous SQL statements that are not
expected to return any report resul ts. Thi s prevents users from
seei ng a w arni ng every ti me a SQL statement i s executed usi ng
Freeform SQL.

H ow ever, be aw are that i f you al so use Freeform SQL to return and

di spl ay data w i th Freeform SQL reports, no w arni ngs are di spl ayed
i f the report returns a si ngl e empty resul t.

l Turn off warnings for Freeform SQL statements that return

multiple result sets with an empty first result set and return
second result set, such as stored procedures: Sel ect thi s opti on
to hi de al l w arni ngs w hen a Freeform SQL report returns an i ni ti al
empty resul t, fol l ow ed by addi ti onal resul ts that i ncl ude i nformati on.
Stored procedures can someti mes have thi s type of behavi or as
they can i ncl ude statements that do not return any resul ts (such as
update statements or create tabl e statements), fol l ow ed by
statements to return i nformati on from the updated tabl es. Thi s
prevents users from seei ng a w arni ng w hen these types of stored
procedures are executed usi ng Freeform SQL.

If you sel ect thi s opti on and a Freeform SQL report returns onl y a
si ngl e empty resul t, then a w arni ng i s sti l l di spl ayed.

Levels at Which You Can Set This

D atabase i nstance and report

XQu er y Su ccess Co d e
XQuery Success C ode i s an advanced property that i s hi dden by
defaul t. For i nstructi ons on how to di spl ay thi s property, see Vi ew i ng

1370 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

and C hangi ng Advanced VLD B Properti es, page 1330.

The XQuery Success C ode VLD B property l ets you val i date
Transacti on Servi ces reports that use XQuery. Mi croStrategy
Transacti on Servi ces and XQuery al l ow you to access and update
i nformati on avai l abl e i n thi rd-party w eb servi ces data sources. The
steps to create a Transacti on Servi ces report usi ng XQuery are
provi ded i n the Advanced R eporti ng Gui de.

When Transacti on Servi ces and XQuery are used to update data for
thi rd-party w eb servi ces, sendi ng the data to be updated i s
consi dered as a successful transacti on. By defaul t, any errors that
occur for the thi rd-party w eb servi ce duri ng a transacti on are not
returned to Mi croStrategy.

To check for errors, you can i ncl ude l ogi c i n your XQuery syntax to
determi ne i f the transacti on successful l y updated the data w i thi n the
thi rd-party w eb servi ce. Just after the XQuery tabl e decl arati on, you
can i ncl ude the fol l ow i ng syntax:

<ErrorCode>{Error_Code}</ErrorCode>
<ErrorMessage>{Error_Message}</ErrorMessage>

In the syntax above:

l Er ro r_ C od e i s a vari abl e that you must defi ne i n your XQuery

statement to retri eve the success or error code from the thi rd-party
w eb servi ce, for the acti on that attempts the transacti on. The l ogi c
to return an error code depends on the thi rd-party w eb servi ce that
you are attempti ng to perform the transacti on on.

l Er ro r_ M es s a g e i s ei ther a stati c error message that you suppl y,

or a vari abl e that you must defi ne i n your XQuery statement to
retri eve any resul ti ng error message from the thi rd-party w eb
servi ce.

By i ncl udi ng thi s syntax i n your XQuery statement, the XQuery

Success C ode VLD B property i s used to val i date the transacti on. The

© 2019, M icr o St r at egy In c. 1371

Syst em Ad m in ist r at io n Gu id e

i nformati on returned by the E r r o r _C o d e vari abl e i s compared to the

val ue suppl i ed for the XQuery Success C ode. By defaul t, the XQuery
Success C ode i s defi ned as "fal se", but you can type any val i d stri ng.
If the E r ro r_ C o d e and XQuery Success C ode are i denti cal , then the
content i n the E r r o r _M e s s a g e i s not returned and the transacti on i s
returned as a success. H ow ever, i f the E r r o r_C o d e returns any
val ue other than the XQuery Success C ode, the content for the
Erro r_ M es sa g e i s returned. Thi s l ets you val i date each transacti on
that i s sent to the thi rd-party w eb servi ce.

Levels at Which You Can Set This

D atabase i nstance and report

Limiting Report Rows, SQL Size, and SQL Time-Out:

Governing
The tabl e bel ow summari zes the Governi ng VLD B properti es.
Addi ti onal detai l s about each property, i ncl udi ng exampl es w here
necessary, are avai l abl e by cl i cki ng on the l i nks i n the tabl e.

Po ssib le Defau lt
Pro p erty Descrip tio n
Valu es Valu e

Det ermines whet her a commit

st at ement is aut omat ically issued af t er • ON
Autoc ommit ON
each S QL st at ement f or a dat abase • OFF
connect ion.

The maximum number of rows ret urned

-1 (Use value
Intermediate t o t he server f or each int ermediat e User-
f rom higher
R ow Limit pass. (0 = unlimit ed number of rows; -1 def ined
level)
= use value f rom higher level. )

Max imum Maximum size of S QL st ring accept ed User-

65536
SQL/MD X by ODB C driver (byt es). def ined

1372 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Po ssib le Defau lt
Pro p erty Descrip tio n
Valu es Valu e

Siz e

The maximum number of rows ret urned

-1 (Use value
R es ults Set t o t he S erver f or t he f inal result set . (0 User-
f rom higher
R ow Limit = unlimit ed number of rows; -1 = use def ined
level)
value f rom higher level. )

Limiting
R eport 0 (Time limit
R ow s , SQL S ingle S QL pass t ime-out in seconds. not enf orced
User-
Siz e, and (0 = t ime limit not enf orced by t his by t his
def ined
SQL Time- governing set t ing) governing
Out: set t ing)
Gov erning

Au t o co mmit
The Autocommi t VLD B property determi nes w hether a commi t
statement i s automati cal l y i ssued after each SQL statement for a
database connecti on. You have the fol l ow i ng opti ons:

l ON : A commit is automatically issued after each SQL statement

by the database connection: By defaul t, a commi t i s i ssued
automati cal l y after each SQL statement. Thi s al l ow s you to query a
database w i thout havi ng to manual l y i ssue commi t statements and
other requi red transacti on control commands.

l OFF: N o commit is automatically issued after each SQL

statement by the database connection: C ommi t statements are
not i ssued automati cal l y after each SQL statement.

Mul ti pl e SQL statements are requi red for vari ous reporti ng and
anal ysi s features i n Mi croStrategy. When mul ti pl e SQL statements
are used, each can be vi ew ed as a separate transacti on. If your
database i s bei ng updated by a separate transacti on, ETL process,

© 2019, M icr o St r at egy In c. 1373

Syst em Ad m in ist r at io n Gu id e

or other update, thi s can cause data i nconsi stency w i th each SQL
statement, si nce each SQL statement i s returned as a separate
transacti on. D i sabl i ng automati c commi t statements i ncl udes al l
SQL statements as a si ngl e transacti on, w hi ch can be used i n
conj uncti on w i th other database techni ques to ensure data
consi stency w hen reporti ng and anal yzi ng a database that i s bei ng
updated. For exampl e, i f reporti ng on an Oracl e database you can
use thi s i n conj uncti on w i th defi ni ng the i sol ati on l evel of the SQL
statements.

Be aw are that i f you di sabl e automati c commi t statements for each

SQL statement, these transacti on control commands must be
i ncl uded for the report. If you are usi ng Freeform SQL or creati ng
your ow n SQL statement for use i n Mi croStrategy, these can be
i ncl uded di rectl y i n those SQL statements. For reports that use
SQL that i s automati cal l y generated by Mi croStrategy, you can use
the Pre/Post Statement VLD B properti es (see C ustomi zi ng SQL
Statements: Pre/Post Statements, page 1477) to provi de the
requi red transacti on control commands.

Level s at Whi ch You Can Set Thi s

Proj ect and report

In t er med iat e Ro w Limit

The Intermedi ate R ow Li mi t VLD B property i s used to l i mi t the number
of row s of data returned to the server from pure SELEC T statements
i ssued apart from the fi nal pass. Apart from the fi nal pass, pure
SELEC T statements are usual l y executed i f there are anal yti cal
functi ons or parti ti on pre-queri es to process. Si nce the parti ti on pre-
queri es return onl y a handful of row s, the SELEC T statements i ssued
for anal yti cal functi on processi ng deci de the number of row s set i n
most cases. If the l i mi t i s exceeded, the report fai l s w i th an error
message. When i t i s set to the defaul t, the Intermedi ate R ow Li mi t

1374 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

takes the val ue of the R esul t Set R ow Li mi t VLD B property at the

report (hi ghest) l evel .

The tabl e bel ow expl ai ns the possi bl e val ues and thei r behavi or:

Valu e Beh avio r

0 No limit on number of rows ret urned

Number Number of rows ret urned is limit ed t o t he specif ied number

Level s at Whi ch You Can Set Thi s

R eport onl y

Maximu m SQL/ MDX Size

The Maxi mum SQL/MD X Si ze property speci fi es the SQL si ze (i n
bytes) on a pass-by-pass basi s. If the l i mi t i s exceeded, the report
executi on i s termi nated and an error message i s returned. The error
message usual l y menti ons that a SQL/MD X stri ng i s l onger than a
correspondi ng l i mi tati on. The l i mi t you choose shoul d be based on
the si ze of the SQL stri ng accepted by your OD BC dri ver.

The tabl e bel ow expl ai ns the possi bl e val ues and thei r behavi or:

Valu e Beh avio r

0 No limit on S QL pass size

Number The maximum S QL pass size (in byt es) is limit ed t o t he specif ied number

B y select ing t he check box U se default inherited value , t he value is set

Def ault t o t he def ault f or t he dat abase t ype used f or t he relat ed dat abase
inst ance. The def ault size varies depending on t he dat abase t ype.

© 2019, M icr o St r at egy In c. 1375

Syst em Ad m in ist r at io n Gu id e

Inc reas ing the max imum to a large v alue c an c aus e the report to fail in
the ODBC driv er. This is dependent on the databas e ty pe y ou are us ing.

Level s at Whi ch You Can Set Thi s

D atabase i nstance onl y

Resu lt s Set Ro w Limit

The R esul ts Set R ow Li mi t VLD B property i s used to l i mi t the number
of row s returned from the fi nal resul ts set SELEC T statements i ssued.
Thi s property i s report-speci fi c.

If the report resul t set exceeds the l i mi t speci fi ed i n the R esult Set
R ow Limit, the report executi on i s termi nated.

Thi s property overri des the N umber of report resul t row s setti ng i n the
Proj ect C onfi gurati on Edi tor: Governi ng R ul es category.

When the report contai ns a custom group, thi s property i s appl i ed to

each el ement i n the group. Therefore, the fi nal resul t set di spl ayed
coul d be l arger than the predefi ned setti ng. For exampl e, i f you set
the R esul t Set R ow Li mi t to 1,000, i t means you w ant onl y 1,000 row s
to be returned. N ow appl y thi s setti ng to each el ement i n the custom
group. If the group has three el ements and each uses the maxi mum
speci fi ed i n the setti ng (1,000), the fi nal report returns 3,000 row s.

The tabl e bel ow expl ai ns the possi bl e val ues and thei r behavi or:

Valu e Beh avio r

0 Unlimit ed number of result rows

-1 Use t he def ault value f rom a higher level

Number The maximum number of rows

1376 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Level s at Whi ch You Can Set Thi s

R eport onl y

SQL Time Ou t (Per Pass)

The SQL Ti me Out VLD B property i s used to avoi d l engthy
i ntermedi ate passes. If any pass of SQL runs l onger than the set ti me
(i n seconds), the report executi on i s termi nated.

The tabl e bel ow expl ai ns the possi bl e val ues and thei r behavi or:

Valu e Beh avio r

This governing set t ing does not impose a t ime limit on S QL pass
0
execut ion.

The maximum amount of t ime (in seconds) a S QL pass can execut e is

Number
limit ed t o t he specif ied number.

Level s at Whi ch You Can Set Thi s

D atabase i nstance and report

Retrieving Data: Indexing

The tabl e bel ow summari zes the Indexi ng VLD B properti es.
Addi ti onal detai l s about each property, i ncl udi ng exampl es w here
necessary, are avai l abl e by cl i cki ng on the l i nks i n the tabl e.

Defau lt
Pro p erty Descrip tio n Po ssib le Valu es
Valu e

Det ermines Don't allow

• Don't allow t he creat ion
Allow Index on whet her or not t o t he creat ion
of indexes on met ric
Metric allow t he creat ion of indexes on
columns
of indexes on f act met ric

© 2019, M icr o St r at egy In c. 1377

Syst em Ad m in ist r at io n Gu id e

Defau lt
Pro p erty Descrip tio n Po ssib le Valu es
Valu e

• A llow t he creat ion of

indexes on met ric
columns (if t he
or met ric columns. columns
I nt ermediat e Table
I ndex set t ing is set t o
creat e)

Def ines t he st ring

t hat is appended at
Index Post t he end of t he
String and CRE A TE I NDE X User-def ined NULL
Index Qualifier st at ement . For
example:

I N I NDE X S P A CE

Def ines t he pref ix

t o use when
aut omat ically
creat ing indexes
R etrieving f or int ermediat e
User-def ined NULL
D ata: Index ing S QL passes. The
pref ix is added t o
t he beginning of
t he CRE A TE
I NDE X st at ement .

Def ines t he st ring

t o parse in bet ween
Index Post t he CRE A TE and
String and I NDE X words. For User-def ined NULL
Index Qualifier example:

CLUS TE RE D

Det ermines • Don't creat e an index

Intermediate Don't creat e
whet her and when
Table Index • Creat e part it ioning key an index
t o creat e an index

1378 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Pro p erty Descrip tio n Po ssib le Valu es
Valu e

(t ypically applicable t o
MP P syst ems)

• Creat e part it ioning key

f or t he and secondary index on
int ermediat e t able. int ermediat e t able

• Creat e only secondary

index on int ermediat e
t able

Det ermines t he
maximum number
of columns t hat
Max C olumns
replace t he column
in C olumn User-def ined 0 (No limit )
wildcard (" ! ! ! " ) in
Placeholder
pre and post
st at ement s. 0 = all
columns (no limit ).

Det ermines t he
maximum number
Max C olumns of columns t hat can
User-def ined No limit
in Index be included in
part it ion key or
index.

• Creat e primary key Creat e

Det ermines (where applicable) if t he primary key
whet her a primary int ermediat e t able index (where
key is creat ed set t ing is set t o creat e a applicable) if
Primary Index inst ead of a primary index. t he
Type part it ioning key f or • Creat e primary int ermediat e
dat abases t hat index/ part it ioning key t able index
support bot h t ypes, (where applicable) if t he set t ing is set
such as UDB . int ermediat e t able index t o creat e a
set t ing is set t o creat e a primary index.

© 2019, M icr o St r at egy In c. 1379

Syst em Ad m in ist r at io n Gu id e

Defau lt
Pro p erty Descrip tio n Po ssib le Valu es
Valu e

primary index.

Def ines whet her an • Creat e index af t er

index is creat ed insert ing int o t able Creat e index
Sec ondary
bef ore or af t er af t er insert ing
Index Order • Creat e index bef ore
insert ing dat a int o int o t able
a t able. insert ing int o t able

• Creat e Composit e I ndex Creat e

Def ines what t ype f or Temporary Table Composit e
Sec ondary of index is creat ed Column I ndexing I ndex f or
Index Type f or t emporary t able • Creat e I ndividual Temporary
column indexing. I ndexes f or Temporary Table Column
Table Column I ndexing I ndexing

Allo w In d ex o n Met r ic
Al l ow Index on Metri c i s an advanced property that i s hi dden by
defaul t. For i nformati on on how to di spl ay thi s property, see Vi ew i ng
and C hangi ng Advanced VLD B Properti es, page 1330.

The Al l ow Index on Metri c property determi nes w hether or not to use

fact or metri c col umns i n i ndex creati on. You can see better
performance i n di fferent envi ronments, especi al l y i n Teradata, w hen
you add the fact or metri c col umn i n the i ndex. U sual l y, the i ndexes
are created on attri bute col umns; but w i th thi s setti ng, the fact or
metri c col umns are added as w el l . Al l fact or metri c col umns are
added.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

1380 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Exam p l e

D o not allow creation of indexes on fact or metric columns

(defaul t)

create table ZZT8L005Y1YEA000 (

CATEGORY_ID BYTE,
REGION_ID BYTE,
YEAR_ID SHORT,
WJXBFS1 DOUBLE,
WJXBFS2 DOUBLE)
insert into ZZT8L005Y1YEA000
select a13.[CATEGORY_ID] AS CATEGORY_ID,
a15.[REGION_ID] AS REGION_ID,
a16.[YEAR_ID] AS YEAR_ID,
sum((a11.[QTY_SOLD] * (a11.[UNIT_PRICE] -
a11.[DISCOUNT]))) as WJXBFS1,
sum((a11.[QTY_SOLD] * ((a11.[UNIT_PRICE] -
a11.[DISCOUNT]) - a11.[UNIT_COST]))) as
WJXBFS2
from [ORDER_DETAIL] a11,
[LU_ITEM] a12,
[LU_SUBCATEG] a13,
[LU_EMPLOYEE] a14,
[LU_CALL_CTR] a15,
[LU_DAY] a16
where a11.[ITEM_ID] = a12.[ITEM_ID] and
a12.[SUBCAT_ID] = a13.[SUBCAT_ID] and
a11.[EMP_ID] = a14.[EMP_ID] and
a14.[CALL_CTR_ID] = a15.[CALL_CTR_ID] and
a11.[ORDER_DATE] = a16.[DAY_DATE]
and a15.[REGION_ID] in (1)
group by a13.[CATEGORY_ID],
a15.[REGION_ID],
a16.[YEAR_ID]
create index ZZT8L005Y1YEA000_i on ZZT8L005Y1YEA000
(CATEGORY_ID, REGION_ID, YEAR_ID)

Allow the creation of indexes on fact or metric columns

Thi s exampl e i s the same as the exampl e above except that the l ast
l i ne of code shoul d be repl aced w i th the fol l ow i ng:

create index ZZT8L005YAGEA000_i on ZZT8L005YAGEA000

(CATEGORY_ID, REGION_ID, YEAR_ID, WJXBFS1, WJXBFS2)

© 2019, M icr o St r at egy In c. 1381

Syst em Ad m in ist r at io n Gu id e

Index Prefix

Thi s property al l ow s you to defi ne the prefi x to add to the begi nni ng of
the C R EATE IN D EX statement w hen automati cal l y creati ng i ndexes
for i ntermedi ate SQL passes.

For exampl e, the i ndex prefi x you defi ne appears i n the C R EATE
IN D EX statement as show n bel ow :

create index( index prefix )

IDX_TEMP1(STORE_ID, STORE_DESC)

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

In d ex Po st St r in g an d In d ex Qu alif ier
The Index Post Stri ng and Index Qual i fi er property can be used to
customi ze the C R EATE IN D EX statement. Indexes can be created
w hen the Intermedi ate Tabl e Type i s set to Permanent Tabl es,
Temporary Tabl es, and Vi ew s (most pl atforms do not support i ndexes
on vi ew s). These tw o setti ngs can be used to speci fy the type of i ndex
to be created and the storage parameters as provi ded by the speci fi c
database pl atform. If the Index Post Stri ng and Index Qual i fi er are set
to a certai n stri ng, then for al l the C R EATE IN D EX statements, the
Index Post Stri ng and Index Qual i fi er are appl i ed.

The create i ndex syntax pattern i s as fol l ow s:

l Al l pl atforms except Teradata:

cr ea te << I n d e x Q u a l i f i e r> > i n d e x i _[ T a b l e N a m e] o n

[T ab le Na m e] ( [C o l u m n L i s t] ) < <I n d e x P o s t S t r i ng> >

1382 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Teradata:

cr ea te << I n d e x Q u a l i f i e r> > i n d e x i _[ T a b l e N a m e]

([ C o lu mn L i s t] ) o n [ T a b l e N a m e] < <I n d e x P o s t
St ri ng > >

Exam p l e

Index Post String

The Index Post Stri ng setti ng al l ow s you to add a custom stri ng to the
end of the C R EATE IN D EX statement.

Index Post String = /* in tablespace1 */

create index IDX_TEMP1(STORE_ID, STORE_DESC) /* in
"tablespace1*/

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

In t er med iat e Tab le In d ex

The Intermedi ate Tabl e Index property i s used to control the pri mary
and secondary i ndexes generated for pl atforms that support them.
Thi s property i s for permanent tabl es and temporary tabl es, w here
appl i cabl e. In the VLD B Properti es Edi tor, sel ect an opti on to vi ew
exampl e SQL statements used by vari ous databases for the sel ected
opti on:

l D on't create an index (defaul t)

l Create partitioning key (typically applicable to MPP systems)

l Create portioning key and secondary index on intermediate table

l Create only secondary index on intermediate table

© 2019, M icr o St r at egy In c. 1383

Syst em Ad m in ist r at io n Gu id e

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Max Co lu mn s in Co lu mn Placeh o ld er
Max C ol umns i n C ol umn Pl acehol der i s an advanced property that i s
hi dden by defaul t. For i nformati on on how to di spl ay thi s property, see
Vi ew i ng and C hangi ng Advanced VLD B Properti es, page 1330.

The Max C ol umns i n C ol umn Pl acehol der property control s the

maxi mum number of col umns that repl ace the col umn w i l dcard ("!!!")
i n pre and post statements. Thi s l i mi t appl i es to both the pri mary and
the secondary i ndexes.

The tabl e bel ow expl ai ns the possi bl e val ues and thei r behavi or:

Valu e Beh avio r

0 A ll at t ribut e I D columns go int o t he index

Number The maximum number of at t ribut e I D columns t o use wit h t he wildcard

Level s at Whi ch You Can Set Thi s

D atabase i nstance onl y

Max Co lu mn s in In d ex
The Max C ol umns i n Index property control s the maxi mum number of
col umns that can be used w hen creati ng an i ndex. Thi s l i mi t appl i es
to both pri mary and secondary i ndexes. If the maxi mum i s fi ve
col umns but there are 10 col umns avai l abl e to i ndex, the fi rst fi ve are
sel ected. H ow ever, each attri bute has a "w ei ght" that you can set.
When SQL i s generated, the attri butes are sel ected i n ascendi ng
order of "w ei ght." By combi ni ng Attri bute Wei ghts and the Max

1384 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

C ol umns i n Index properti es, you can desi gnate any attri bute to be
i ncl uded i n the i ndex.

You c an define attribute weights in the Projec t Configuration Editor.

Selec t the R eport definition: SQL generation c ategory , and in the
Attribute weights s ec tion, c lic k Modify .

The tabl e bel ow expl ai ns the possi bl e val ues and thei r behavi or:

Valu e Beh avio r

0 A ll at t ribut e I D columns are placed in t he index

The maximum number of at t ribut e I D columns t hat are placed in t he

Number
index

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Pr imar y In d ex Typ e
Pri mary Index Type i s an advanced property that i s hi dden by defaul t.
For i nformati on on how to di spl ay thi s property, see Vi ew i ng and
C hangi ng Advanced VLD B Properti es, page 1330.

The Pri mary Index Type property determi nes the pattern for creati ng
pri mary keys and i ndexes. In the VLD B Properti es Edi tor, sel ect an
opti on to vi ew exampl e SQL statements used by vari ous databases for
the sel ected opti on. The exampl es al so di spl ay w hether the opti on i s
appl i cabl e for a gi ven database type. If you sel ect an opti on that i s
not appl i cabl e for the database type that you use, then the other
opti on i s used automati cal l y. Whi l e thi s ensures that the pri mary
i ndex type i s correct for your database, you shoul d sel ect an opti on
that i s l i sted as appl i cabl e for the database that you use.

© 2019, M icr o St r at egy In c. 1385

Syst em Ad m in ist r at io n Gu id e

Some databases such as D B2 U D B support both pri mary i ndex type

opti ons. U se the exampl e SQL statements and your thi rd-party
database documentati on to determi ne the best opti on for your
envi ronment.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Seco n d ar y In d ex Or d er
The Secondary Index Order VLD B property al l ow s you to defi ne
w hether an i ndex i s created before or after i nserti ng data i nto a tabl e.
Thi s VLD B property has the fol l ow i ng opti ons:

l C reate index after inserting into table (defaul t): Thi s opti on
creates the i ndex after i nserti ng data i nto a tabl e, w hi ch i s a good
opti on to support most database and i ndexi ng strategi es.

l C reate index before inserting into table: Thi s opti on creates the
i ndex before i nserti ng data i nto a tabl e, w hi ch can i mprove
performance for some envi ronments, i ncl udi ng Sybase IQ. The type
of i ndex created can al so hel p to i mprove performance i n these
types of envi ronments, and can be confi gured w i th the Secondary
Index Type VLD B property (see Secondary Index Order, page
1386).

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Seco n d ar y In d ex Typ e
The Secondary Index Type VLD B property al l ow s you to defi ne w hat
type of i ndex i s created for temporary tabl e col umn i ndexi ng. Thi s
VLD B property has the fol l ow i ng opti ons:

1386 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l C reate C omposite Index for Temporary Table C olumn Indexing

(defaul t): Thi s opti on creates composi te i ndexes for temporary tabl e
col umn i ndexi ng. Thi s i s a good opti on to support most database
and i ndexi ng strategi es.

l C reate Individual Indexes for Temporary Table C olumn

Indexing: Thi s opti on creates i ndi vi dual i ndexes for temporary tabl e
col umn i ndexi ng. Thi s can i mprove performance for some
envi ronments, i ncl udi ng Sybase IQ. The order i n w hi ch the i ndex i s
created can al so hel p to i mprove performance i n these types of
envi ronments, and can be confi gured w i th the Secondary Index
Order VLD B property (see Secondary Index Type, page 1386).

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Relating Column Data with SQL: Joins

The tabl e bel ow summari zes the Joi ns VLD B properti es. Addi ti onal
detai l s about each property, i ncl udi ng exampl es w here necessary, are
avai l abl e by cl i cki ng on the l i nks i n the tabl e.

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

Attribute to
Join W hen Cont rols whet her • Join common key on
Key From t ables are joined bot h sides
N either only on t he common Join common key
Side can be keys or on all • Join common on bot h sides
Supported common columns at t ribut es (reduced)

by the f or each t able. on bot h sides

Other Side

Bas e Table Cont rols whet her • Temp t able join

Join for t wo f act t ables are Temp t able join
Template • Fact t able join

© 2019, M icr o St r at egy In c. 1387

Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

direct ly joined
t oget her. I f you
choose Temp Table
Join, t he A nalyt ical
E ngine calculat es
result s
independent ly f rom
each f act t able and
places t hose result s
int o t wo
int ermediat e t ables.
These int ermediat e
t ables are t hen
joined t oget her.

A llows t he
MicroS t rat egy S QL • Do not reevaluat e
C artes ian E ngine t o use a cart esian joins Do not reevaluat e
Join new algorit hm f or
• Reevaluat e cart esian cart esian joins
Ev aluation evaluat ing whet her
or not a Cart esian joins

join is necessary.

• E xecut e

• Cancel execut ion

• Cancel execut ion only

A ct ion t hat occurs when warehouse t able
C artes ian when t he A nalyt ical is involved in eit her
Join E ngine generat es a side of cart esian join E xecut e
W arning report t hat cont ains
• I f only one side of
a Cart esian join.
cart esian join cont ains
warehouse t ables,
S QL will be execut ed
wit hout warning

D ow nw ard A llows users t o • Do not preserve all t he Do not preserve all

1388 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

rows f or met rics

higher t han t emplat e
level

• P reserve all t he rows

f or met rics higher t han
t emplat e level w/ o
report f ilt er

• P reserve all t he rows

choose how t o f or met rics higher t han
t he rows f or
handle met rics t emplat e level wit h
Outer Join met rics higher
which have a higher report f ilt er
Option t han t emplat e
level t han t he
• Do not do downward level
t emplat e.
out er join f or dat abase
t hat support f ull out er
join

• Do not do downward
out er join f or dat abase
t hat support f ull out er
join, and order t emp
t ables in last pass by
level

Cont rols which

lookup t ables are
included in t he join
against t he f act
t able. For a part ial
st ar join, t he
D SS Star • No st ar join
A nalyt ical E ngine No st ar join
Join • P art ial st ar join
joins t he lookup
t ables of all
at t ribut es present in
eit her t he t emplat e
or t he f ilt er or
met ric level, if

© 2019, M icr o St r at egy In c. 1389

Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

needed.

• Normal FROM clause

order as generat ed by
t he engine

• Move last t able in

Det ermines whet her normal FROM clause
t o use t he normal order t o t he f irst Normal FROM
From
FROM clause order clause order as
C lause • Move MQ t able in
as generat ed by t he generat ed by t he
Order normal From clause
A nalyt ical E ngine or engine
t o swit ch t he order. order t o t he last (f or
RedB rick)

• Reverse FROM clause

order as generat ed by
t he engine

I ndicat es whet her

Full Outer
t he dat abase • No support
Join No support
plat f orm support s • S upport
Support
f ull out er joins.

• Join 89

• Join 92

• S QL 89 I nner Join and

Type of column Cross Join and S QL
Join Type Join 89
join. 92 Out er Join

• S QL 89 I nner Join and

S QL 92 Out er Join
and Cross Join

Det ermines how • P art ially based on P art ially based on

Look up
lookup t ables are at t ribut e level at t ribut e level
Table Join
loaded f or join (behavior prior t o (behavior prior t o
Order
operat ions. version 8. 0. 1) version 8. 0. 1)

1390 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

• Fully based on
at t ribut e level. Lookup
t ables f or lower level
at t ribut es are joined
bef ore t hose f or higher
level at t ribut es

Maximum number
Max Tables
of t ables t o join • User-def ined No limit
in Join
t oget her.

A ct ion t hat occurs

when t he A nalyt ical
Max Tables E ngine generat es a • E xecut e
in Join report t hat exceeds Cancel execut ion
W arning t he maximum • Cancel execut ion

number of t ables in
t he join limit .

• Do not perf orm out er

join on nest ed
aggregat ion

• Do perf orm out er join

Def ines when out er
on nest ed aggregat ion
joins are perf ormed Do not perf orm
N es ted when all f ormulas
on met rics t hat are out er join on
Aggregation have t he same level
def ined wit h nest ed nest ed
Outer Joins
aggregat ion • Do perf orm downward aggregat ion
f unct ions. out er join on nest ed
aggregat ion when all
f ormulas can
downward out er join t o
a common lower level

Pres erv ing

D ata U s ing
Outer Joins

© 2019, M icr o St r at egy In c. 1391

Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

• P reserve common
element s of f inal pass
result t able and
lookup/ relat ionship
t able

• P reserve all f inal

result pass element s

• P reserve all element s

of f inal pass result P reserve common
Pres erv e t able wit h respect t o
P erf orm an out er element s of f inal
All Final lookup t able but not
join t o t he f inal pass result t able
Pas s relat ionship t able
result set in t he and
R es ult
f inal pass. • Do not list en t o per lookup/ relat ionship
Elements
report level set t ing, t able.
preserve element s of
f inal pass according t o
t he set t ing at at t ribut e
level. I f t his choice is
select ed at at t ribut e
level, it will be t reat ed
as preserve common
element s (t hat is,
choice 1)

• P reserve common
element s of lookup
and f inal pass result
t able
Pres erv e All P erf orm an out er P reserve common
Look up join t o t he lookup • P reserve lookup t able element s of lookup
Table t able in t he f inal element s joined t o and f inal pass
Elements pass. f inal pass result t able result t able
based on f act t able
keys

• P reserve lookup t able

1392 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

element s joined t o
f inal pass result t able
based on t emplat e
at t ribut es wit hout f ilt er

• P reserve lookup t able

element s joined t o
f inal pass result t able
based on t emplat e
at t ribut es wit h f ilt er

At t r ib u t e t o Jo in Wh en Key Fr o m Neit h er Sid e can b e

Su p p o r t ed b y t h e Ot h er Sid e
The Attri bute to j oi n w hen key from nei ther si de can be supported by
the other si de i s an advanced property that i s hi dden by defaul t. For
i nformati on on how to di spl ay thi s property, see Vi ew i ng and
C hangi ng Advanced VLD B Properti es, page 1330.

Thi s VLD B property determi nes how Mi croStrategy j oi ns tabl es w i th

common col umns. The opti ons for thi s property are:

l Join common key on both sides (defaul t): Joi ns on tabl es onl y
use col umns that are i n each tabl e, and are al so keys for each
tabl e.

l Join common attributes (reduced) on both sides: Joi ns betw een

tabl es use al l common attri bute col umns to perform the j oi n. Thi s
functi onal i ty can be hel pful i n a coupl e of di fferent scenari os.

l You have tw o di fferent tabl es named Tabl e1 and Tabl e2. Both
tabl es share 3 ID col umns for Year, Month, and D ate al ong w i th
other col umns of data. Tabl e1 uses Year, Month, and D ate as
keys w hi l e Tabl e2 uses onl y Year and Month as keys. Si nce the
ID col umn for D ate i s not a key for Tabl e2, you must set thi s

© 2019, M icr o St r at egy In c. 1393

Syst em Ad m in ist r at io n Gu id e

opti on to i ncl ude D ay to j oi n the tabl es al ong w i th Year and

Month.

l You have a tabl e named Tabl e1 that i ncl udes the col umns for the
attri butes Quarter, Month of Year, and Month. Si nce Month i s a
chi l d of Quarter and Month of Year, i ts ID col umn i s used as the
key for Tabl e1. There i s al so a temporary tabl e named TempTabl e
that i ncl udes the col umns for the attri butes Quarter, Month of
Year, and Year, usi ng al l three ID col umns as keys of the tabl e. It
i s not possi bl e to j oi n Tabl e1 and TempTabl e unl ess you set thi s
opti on because they do not share any common keys. If you set
thi s opti on, Tabl e1 and TempTabl e can j oi n on the common
attri butes Quarter and Month of Year.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Base Tab le Jo in f o r Temp lat e

The Base Tabl e Joi n for Templ ate i s an advanced property that i s
hi dden by defaul t. For i nformati on on how to di spl ay thi s property, see
Vi ew i ng and C hangi ng Advanced VLD B Properti es, page 1330.

When reports contai n metri cs from di fferent fact tabl es or a compound

metri c made up of data from di fferent fact tabl es, then the Base Tabl e
Joi n for Templ ate property can be used to choose betw een
i ntermedi ate tabl e j oi ns and base tabl es j oi ns. The property i s mai nl y
performance-rel ated. If i ntermedi ate tabl e j oi n i s chosen, then the
type of i ntermedi ate tabl e i s governed by the Intermedi ate Tabl e Type
VLD B property (see Intermedi ate Tabl e Type, page 1634 i n the Tabl e
Properti es secti on).

Caution mus t be tak en when c hanging this s etting s inc e the res ults c an
be different depending on the ty pes of metric s on the report.

1394 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Exam p l e

U se Temp Table Join (defaul t)

select a11.MARKET_NBR MARKET_NBR,

sum(a11.CLE_SLS_DLR)
CLEARANCESAL
into #ZZTIS00H5D3SP000
from HARI_MARKET_DIVISION a11
group by a11.MARKET_NBR
select a11.MARKET_NBR MARKET_NBR,
sum(a11.COST_AMT)
COSTAMOUNT
into #ZZTIS00H5D3SP001
from HARI_COST_MARKET_DIV a11
group by a11.MARKET_NBR
select pa1.MARKET_NBR MARKET_NBR,
a11.MARKET_DESC MARKET_DESC,
pa1.CLEARANCESAL WJXBFS1,
pa2.COSTAMOUNT WJXBFS2
from #ZZTIS00H5D3SP000 pa1
left outer join #ZZTIS00H5D3SP001 pa2
on (pa1.MARKET_NBR = pa2.MARKET_NBR)
left outer join HARI_LOOKUP_MARKET a11
on (pa1.MARKET_NBR = a11.MARKET_NBR)

Use Fact Table Join

select a11.MARKET_NBR MARKET_NBR,

max(a13.MARKET_DESC) MARKET_DESC,
sum(a12.CLE_SLS_DLR) CLEARANCESAL,
sum(a11.COST_AMT) COSTAMOUNT
from HARI_COST_MARKET_DIV a11
join HARI_MARKET_DIVISION a12
on (a11.CUR_TRN_DT = a12.CUR_TRN_DT
and a11.DIVISION_NBR = a12.DIVISION_NBR
and a11.MARKET_NBR = a12.MARKET_NBR)
join HARI_LOOKUP_MARKET a13
on (a11.MARKET_NBR = a13.MARKET_NBR)
group by a11.MARKET_NBR

© 2019, M icr o St r at egy In c. 1395

Syst em Ad m in ist r at io n Gu id e

Car t esian Jo in Evalu at io n

C artesi an Joi n Eval uati on i s an advanced property that i s hi dden by
defaul t. For i nformati on on how to di spl ay thi s property, see Vi ew i ng
and C hangi ng Advanced VLD B Properti es, page 1330.

Thi s property al l ow s the Mi croStrategy SQL Engi ne to use a new

al gori thm for eval uati ng w hether or not a C artesi an j oi n i s necessary.
The new al gori thm can someti mes avoi d a C artesi an j oi n w hen the
ol d al gori thm cannot. For backw ard compati bi l i ty, the defaul t i s the
ol d al gori thm. If you see C artesi an j oi ns that appear to be avoi dabl e,
use thi s property to determi ne w hether the engi ne's new al gori thm
avoi ds the C artesi an j oi n.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Exam p l es

D o N ot R eevaluate C artesian Joins (defaul t)

select a12.ATTR1_ID ATTR1_ID,

max(a12.ATTR1_DESC) ATTR1_DESC,
a13.ATTR2_ID ATTR2_ID,
max(a13.ATTR2_DESC) ATTR2_DESC,
count(a11.FACT_ID) METRIC
from FACTTABLE a11
cross join LU_TABLE1 a12
join LU_TABLE2 a13
on (a11.ATTR3_ID = a13.ATTR3_ID and
a12.ATTR1_ID = a13.ATTR1_CD)
group by a12.ATTR1_ID,
a13.ATTR2_ID

Reevaluate the Cartesian Joins

select a12.ATTR1_ID ATTR1_ID,

max(a12.ATTR1_DESC) ATTR1_DESC,
a13.ATTR2_ID ATTR2_ID,
max(a13.ATTR2_DESC) ATTR2_DESC,
count(a11.FACT_ID) METRIC

1396 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

from FACTTABLE a11

join LU_TABLE2 a13
on (a11.ATTR3_ID = a13.ATTR3_ID)
join LU_TABLE1 a12
on (a12.ATTR1_ID = a13.ATTR1_CD)
group by a12.ATTR1_ID,
a13.ATTR2_ID

Car t esian Jo in War n in g

C artesi an j oi ns are usual l y costl y to perform. H ow ever, a C artesi an
j oi n of tw o w arehouse tabl es i s much more costl y than a C artesi an
j oi n of tw o i ntermedi ate tabl es.

l Execute (defaul t): When any C artesi an j oi n i s encountered,

executi on conti nues w i thout w arni ng.

l C ancel execution: When a report contai ns any C artesi an j oi n,

executi on i s cancel ed.

l C ancel execution only when warehouse table is involved in

either side of C artesian join: The executi on i s cancel ed onl y w hen
a w arehouse tabl e i s i nvol ved i n a C artesi an j oi n. In other w ords,
the C artesi an j oi n i s al l ow ed w hen al l tabl es i nvol ved i n the j oi n are
i ntermedi ate tabl es.

l If only one side of C artesian join contains warehouse tables,

SQL will be executed without warning: When al l tabl es i nvol ved i n
the C artesi an j oi n are i ntermedi ate tabl es, the SQL i s executed
w i thout w arni ng. Thi s opti on al so al l ow a C artesi an j oi n i f a
w arehouse tabl e i s onl y on one si de of the j oi n and cancel s i t i f
both si des are w arehouse tabl es.

l In the rare s ituation when a warehous e table is Cartes ian-joined to an

intermediate table, the ex ec ution is us ually c anc eled. Howev er, there
may be times when y ou want to allow this to ex ec ute. In this c as e, y ou
c an c hoos e the option: If only one side of C artesian join

© 2019, M icr o St r at egy In c. 1397

Syst em Ad m in ist r at io n Gu id e

contains warehouse tables, SQL will be executed without

warning. If this option is s elec ted, the ex ec ution is c anc eled only
when warehous e tables are inv olv ed in both s ides of the Cartes ian
join.

l Some Cartes ian joins may not be a direc t table-to-table join. If one join
"Cartes ian joins " to another join, and one of the joins c ontains a
warehous e table (not an intermediate table), then the ex ec ution is
either c anc eled or allowed depending on the option s elec ted (s ee
below). For ex ample, if (TT_A join TT_B) Cartes ian join (TT_C join
WH_D) the following oc c urs bas ed on the following s ettings :

l If the s etting C ancel execution only when warehouse table is

involved in C artesian join is s elec ted, ex ec ution is c anc eled. In
the abov e ex ample, ex ec ution is c anc eled bec aus e a warehous e table
is us ed, ev en though TT_A, TT_B, and TT_C are all intermediate
tables .

l If the s etting If only one side of C artesian... is s elec ted, SQL runs
without warning. In the abov e ex ample, ex ec ution c ontinues bec aus e
a warehous e table (WH_D) is us ed on only one s ide of the join.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Do wn war d Ou t er Jo in Op t io n
D ow nw ard Outer Joi n Opti on i s an advanced property that i s hi dden
by defaul t. For i nformati on on how to di spl ay thi s property, see
Vi ew i ng and C hangi ng Advanced VLD B Properti es, page 1330.

To understand D ow nw ard Outer Joi n, consi der the fol l ow i ng report

that contai ns the attri bute Store and tw o metri cs, Sal es Per Store (M1)
and Inventory Per R egi on (M2). The attri bute R egi on i s a parent of
Store. Both M1 and M2 are set to Outer Joi n.

1398 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Sales Per Sto re In ven to ry Per Reg io n

Sto re
(M1) (M2)

Tradi ti onal l y, the outer j oi n fl ag i s i gnored, because M2 (at R egi on

l evel ) i s hi gher than the report l evel of Store. It i s di ffi cul t to preserve
al l of the stores for a metri c at the R egi on l evel . H ow ever, you can
preserve row s for a metri c at a hi gher l evel than the report. Si nce M2
i s at the regi on l evel , i t i s i mpossi bl e to preserve al l regi ons for M2
because the report onl y show s Store. To do that, a dow nw ard j oi n
pass i s needed to fi nd al l stores that bel ong to the regi on i n M2, so
that a uni on i s formed among al l these stores w i th the stores i n M1.

When performi ng a dow nw ard j oi n, another i ssue ari ses. Even though
al l the stores that bel ong to the regi on i n M2 can be found, these
stores may not be those from w hi ch M2 i s cal cul ated. If a report fi l ters
on a subset of stores, then M2 (i f i t i s a fi l tered metri c) i s cal cul ated
onl y from those stores, and aggregated to regi ons. When a dow nw ard
j oi n i s done, ei ther al l the stores that bel ong to the regi ons i n M2 are
i ncl uded or onl y those stores that bel ong to the regi ons i n M2 and i n
the report fi l ter. H ence, thi s property has three opti ons.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Exam p l e

U si ng the above exampl e and appl yi ng a fi l ter for Atl anta and
C harl otte, the defaul t D o not preserve all the rows for metrics
higher than template level opti on returns the fol l ow i ng resul ts. N ote
that C harl otte does not appear because i t has no sal es data i n the
fact tabl e; the outer j oi n i s i gnored. The outer j oi n fl ag on metri cs
hi gher than templ ate l evel i s i gnored.

© 2019, M icr o St r at egy In c. 1399

Syst em Ad m in ist r at io n Gu id e

Sales Per Sto re In ven to ry Per Reg io n

Sto re
(M1) (M2)

A t lant a 100 300

U si ng Preserve all the rows for metrics higher than template level
without report filter returns the resul ts show n bel ow . N ow C harl otte
appears because the outer j oi n i s used, and i t has an i nventory, but
Washi ngton appears as w el l because i t i s i n the R egi on, and the fi l ter
i s not appl i ed.

Sales Per Sto re In ven to ry Per

Sto re
(M1) Reg io n (M2)

A t lant a 100 300

Charlot t e 300

Washingt on 300

U si ng Preserve all the rows for metrics higher than template level
with report filter produces the fol l ow i ng resul ts. Washi ngton i s
fi l tered out but C harl otte sti l l appears because of the outer j oi n.

Sales Per Sto re In ven to ry Per Reg io n

Sto re
(M1) (M2)

A t lant a 100 300

Charlot t e 300

For backw ard compati bi l i ty, the defaul t i s to i gnore the outer j oi n fl ag
for metri cs hi gher than templ ate l evel . Thi s i s the SQL Engi ne

1400 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

behavi or for Mi croStrategy 6.x or l ow er, as w el l as for Mi croStrategy

7.0 and 7.1.

DSS St ar Jo in
D SS Star Joi n i s an advanced property that i s hi dden by defaul t. For
i nformati on on how to di spl ay thi s property, see Vi ew i ng and
C hangi ng Advanced VLD B Properti es, page 1330.

The D SS Star Joi n property speci fi es w hether a parti al star j oi n i s

performed or not. A parti al star j oi n means the l ookup tabl e of a
col umn i s j oi ned i f and onl y i f a col umn i s i n the SELEC T cl ause or
i nvol ved i n a qual i fi cati on i n the WH ER E cl ause of the SQL. In certai n
databases, for exampl e, R edBri ck and Teradata, parti al star j oi ns can
i mprove SQL performance i f certai n types of i ndexes are mai ntai ned
i n the data w arehouse. N oti ce that the l ookup tabl e j oi ned i n a parti al
star j oi n i s not necessari l y the same as the l ookup tabl e defi ned i n the
attri bute form edi tor. Any tabl e that acts as a l ookup tabl e rather than
a fact tabl e i n the SQL and contai ns the col umn i s consi dered a
feasi bl e l ookup tabl e.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Exam p l es

N o Star Join (defaul t)

select distinct a11.PBTNAME PBTNAME

from STORE_ITEM_PTMAP a11
where a11.YEAR_ID in (1994)
select a11.ITEM_NBR ITEM_NBR,
a11.CLASS_NBR CLASS_NBR,
a13.ITEM_DESC ITEM_DESC,
a13.CLASS_DESC CLASS_DESC,
a11.STORE_NBR STORE_NBR,
a14.STORE_DESC STORE_DESC,
sum(a11.REG_SLS_DLR) WJXBFS1

© 2019, M icr o St r at egy In c. 1401

Syst em Ad m in ist r at io n Gu id e

from STORE_ITEM_94 a11,

LOOKUP_DAY a12,
LOOKUP_ITEM a13,
LOOKUP_STORE a14
where a11.CUR_TRN_DT = a12.CUR_TRN_DT and
a11.CLASS_NBR = a13.CLASS_NBR and
a11.ITEM_NBR = a13.ITEM_NBR and
a11.STORE_NBR = a14.STORE_NBR
and a12.YEAR_ID in (1994)
group by a11.ITEM_NBR,
a11.CLASS_NBR,
a13.ITEM_DESC,
a13.CLASS_DESC,
a11.STORE_NBR,
a14.STORE_DESC

Partial Star Join

select distinct a11.PBTNAME PBTNAME

from STORE_ITEM_PTMAP a11,
LOOKUP_YEAR a12
where a11.YEAR_ID = a12.YEAR_ID
and a11.YEAR_ID in (1994)
Pass1 - Duration: 0:00:00.49
select a11.ITEM_NBR ITEM_NBR,
a11.CLASS_NBR CLASS_NBR,
a13.ITEM_DESC ITEM_DESC,
a13.CLASS_DESC CLASS_DESC,
a11.STORE_NBR STORE_NBR,
a14.STORE_DESC STORE_DESC,
sum(a11.REG_SLS_DLR) WJXBFS1
from STORE_ITEM_94 a11,
LOOKUP_DAY a12,
LOOKUP_ITEM a13,
LOOKUP_STORE a14
where a11.CUR_TRN_DT = a12.CUR_TRN_DT and
a11.CLASS_NBR = a13.CLASS_NBR and
a11.ITEM_NBR = a13.ITEM_NBR and
a11.STORE_NBR = a14.STORE_NBR
and a12.YEAR_ID in (1994)
group by a11.ITEM_NBR,
a11.CLASS_NBR,
a13.ITEM_DESC,
a13.CLASS_DESC,
a11.STORE_NBR,

1402 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

a14.STORE_DESC

Fr o m Clau se Or d er
Some database pl atforms, such as Oracl e and R edBri ck, perform
better dependi ng on the order of the tabl es i n the FR OM cl ause. The
FR OM C l ause Orderi ng property al ters the order that the tabl es
appear i n the FR OM cl ause. The Mi croStrategy SQL Engi ne normal l y
puts the fact tabl e fi rst i n the FR OM cl ause. When the property i s set
to sw i tch the FR OM cl ause order, the fact tabl e i s moved to the
second tabl e i n the cl ause. H ow ever, i f there are tw o fact tabl es i n the
FR OM cl ause, i t sw i tches the order of the tw o tabl es.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Exam p l es

Normal FROM clause order as generated by the engine

select a12.CUSTOMER_ID CUSTOMER_ID,

sum(a11.ORDER_AMT) WJXBFS1
from ORDER_FACT a11
join LU_ORDER a12
on (a11.ORDER_ID = a12.ORDER_ID)
group by a12.CUSTOMER_ID

Switch FROM clause order as generated by the engine

select a12.CUSTOMER_ID CUSTOMER_ID,

sum(a11.ORDER_AMT) WJXBFS1
from LU_ORDER a12
join ORDER_FACT a11
on (a11.ORDER_ID = a12.ORDER_ID)
group by a12.CUSTOMER_ID

Move MQ Table in normal FROM clause order to the last (for RedBrick)

Thi s setti ng i s added pri mari l y for R edBri ck users. The defaul t order
of tabl e j oi ns i s as fol l ow s:

© 2019, M icr o St r at egy In c. 1403

Syst em Ad m in ist r at io n Gu id e

1. Joi n the fact tabl es together.

2. Joi n the metri c qual i fi cati on tabl e.

3. Joi n the rel ati onshi p tabl e.

4. Joi n the l ookup tabl es i f needed.

Thi s opti on changes the order to the fol l ow i ng:

1. Joi n the fact tabl es together.

2. Joi n the rel ati onshi p tabl e.

3. Joi n the l ookup tabl es.

4. Joi n the metri c qual i fi cati on tabl e.

Fu ll Ou t er Jo in Su p p o r t
Ful l Outer Joi n Support i s an advanced property that i s hi dden by
defaul t. For i nformati on on how to di spl ay thi s property, see Vi ew i ng
and C hangi ng Advanced VLD B Properti es, page 1330.

The Ful l Outer Joi n Support property speci fi es w hether the database
pl atform supports ful l outer j oi n syntax:

l N o support (defaul t): Ful l outer j oi ns are not supported or

processed to return resul ts. Thi s can hel p to prevent costl y outer
j oi n queri es and al so avoi ds errors for databases that do not
support ful l outer j oi ns. Addi ti onal l y, i f your database does not
support the C O A L E S C E functi on, you shoul d set thi s property to N o
support.

l Support: Ful l outer j oi ns are attempted w hen requi red by your

report or dossi er acti ons. By sel ecti ng thi s opti on, the Joi n Type
VLD B property i s assumed to be Joi n 92 and any other setti ng i n
Joi n Type i s i gnored. Addi ti onal l y, the C O A L E S C E functi on can be
i ncl uded i n the SQL query.

1404 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Si nce ful l outer j oi ns can requi re a l ot of database and Intel l i gence

Server resources, and ful l outer j oi ns are not supported for al l
databases, i t i s recommended to enabl e support for i ndi vi dual
reports fi rst. If your resul ts are returned successful l y and ful l outer
j oi ns are used often for your report or dossi er envi ronment, you
can consi der enabl i ng support for the enti re database. H ow ever,
enabl i ng ful l outer j oi n support for speci fi c reports i s
recommended i f ful l outer j oi ns are onl y used for a smal l to
moderate amount of reporti ng needs. C reati ng a templ ate w i th ful l
outer j oi n support enabl ed can save report devel opers ti me w hen
requi ri ng ful l outer j oi ns.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Exam p l es

Full Outer Join N ot Supported (defaul t)

select a12.YEAR_ID YEAR_ID,

sum(a11.TOT_SLS_DLR) TOTALSALESCO
into #ZZTIS00H5MJMD000
from HARI_REGION_DIVISION a11
join HARI_LOOKUP_DAY a12
on (a11.CUR_TRN_DT = a12.CUR_TRN_DT)
where a12.MONTH_ID = 199411
group by a12.YEAR_ID
select a12.YEAR_ID YEAR_ID,
sum(a11.TOT_SLS_DLR) TOTALSALESCO
into #ZZTIS00H5MJMD001
from HARI_REGION_DIVISION a11
join HARI_LOOKUP_DAY a12
on (a11.CUR_TRN_DT = a12.CUR_TRN_DT)
where a12.MONTH_ID = 199311
group by a12.YEAR_ID
select pa1.YEAR_ID YEAR_ID
into #ZZTIS00H5MJOJ002

© 2019, M icr o St r at egy In c. 1405

Syst em Ad m in ist r at io n Gu id e

from #ZZTIS00H5MJMD000 pa1

union
select pa2.YEAR_ID YEAR_ID
from #ZZTIS00H5MJMD001 pa2
select distinct pa3.YEAR_ID YEAR_ID,
a11.YEAR_DESC YEAR_DESC,
pa1.TOTALSALESCO TOTALSALESCO,
pa2.TOTALSALESCO TOTALSALESCO1
from #ZZTIS00H5MJOJ002 pa3
left outer join #ZZTIS00H5MJMD000 pa1
on (pa3.YEAR_ID = pa1.YEAR_ID)
left outer join #ZZTIS00H5MJMD001 pa2
on (pa3.YEAR_ID = pa2.YEAR_ID)
left outer join HARI_LOOKUP_YEAR a11
on (pa3.YEAR_ID = a11.YEAR_ID)

Full Outer Join Supported

select a12.YEAR_ID YEAR_ID,

sum(a11.TOT_SLS_DLR) TOTALSALESCO
into #ZZTIS00H5MKMD000
from HARI_REGION_DIVISION a11
join HARI_LOOKUP_DAY a12
on (a11.CUR_TRN_DT = a12.CUR_TRN_DT)
where a12.MONTH_ID = 199411
group by a12.YEAR_ID
select a12.YEAR_ID YEAR_ID,
sum(a11.TOT_SLS_DLR) TOTALSALESCO
into #ZZTIS00H5MKMD001
from HARI_REGION_DIVISION a11
join HARI_LOOKUP_DAY a12
on (a11.CUR_TRN_DT = a12.CUR_TRN_DT)
where a12.MONTH_ID = 199311
group by a12.YEAR_ID
select distinct coalesce(pa1.YEAR_ID,
pa2.YEAR_ID) YEAR_ID,
a11.YEAR_DESC YEAR_DESC,
pa1.TOTALSALESCO TOTALSALESCO,
pa2.TOTALSALESCO TOTALSALESCO1
from #ZZTIS00H5MKMD000 pa1

1406 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

full outer join #ZZTIS00H5MKMD001 pa2

on (pa1.YEAR_ID = pa2.YEAR_ID)
left outer join HARI_LOOKUP_YEAR a11
on ( coalesce( pa1.YEAR_ID, pa2.YEAR_ID) = a11.YEAR_ID)

Jo in Typ e
The Joi n Type property determi nes w hi ch AN SI j oi n syntax pattern to
use. Some databases, such as Oracl e, do not support the AN SI 92
standard yet. Some databases, such as D B2, support both Joi n 89
and Joi n 92. Other databases, such as some versi ons of Teradata,
have a mi x of the j oi n standards and therefore need thei r ow n setti ng.

Mi croStrategy uses di fferent defaul ts for the j oi n type based on the

database you are usi ng. Thi s i s to support the most common
scenari os for your databases. When sel ecti ng a di fferent j oi n type
than the defaul t, i t i s recommended to test thi s w i th a report rather
than the enti re database. By usi ng thi s strategy you can determi ne i f
the j oi n type functi ons correctl y for your database w hi l e al so
provi di ng the requi red performance.

If the Ful l Outer Joi n Support VLD B property (see Joi n Type, page
1407) i s set to Support, thi s property i s i gnored and the Joi n 92
standard i s used.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Exam p l es

Join 89 (defaul t)

select a22.STORE_NBR STORE_NBR,

max(a22.STORE_DESC) STORE_DESC,
a21.CUR_TRN_DT CUR_TRN_DT,
sum(a21.REG_SLS_DLR) WJXBFS1
from STORE_DIVISION a21,
LOOKUP_STORE a22

© 2019, M icr o St r at egy In c. 1407

Syst em Ad m in ist r at io n Gu id e

where a21.STORE_NBR = a22.STORE_NBR

group by a22.STORE_NBR,
a21.CUR_TRN_DT

Join 92

select a21.CUR_TRN_DT CUR_TRN_DT,

a22.STORE_NBR STORE_NBR,
max(a22.STORE_DESC) STORE_DESC,
sum(a21.REG_SLS_DLR) WJXBFS1
from STORE_DIVISION a21
join LOOKUP_STORE a22
on (a21.STORE_NBR = a22.STORE_NBR)
group by a21.CUR_TRN_DT,
a22.STORE_NBR

SQL 89 Inner Join and SQL 92 Outer Join

create table ZZOL00 as

select a23.STORE_NBR STORE_NBR,
a23.MARKET_NBR MARKET_NBR,
a22.DEPARTMENT_NBR DEPARTMENT_NBR,
a21.CUR_TRN_DT CUR_TRN_DT
from LOOKUP_DAY a21,
LOOKUP_DEPARTMENT a22,
LOOKUP_STORE a23
select a21.MARKET_NBR MARKET_NBR,
max(a24.MARKET_DESC) MARKET_DESC,
sum((a22.COST_AMT * a23.TOT_SLS_DLR)) SUMTSC
from ZZOL00 a21
left outer join COST_STORE_DEP a22
on (a21.DEPARTMENT_NBR = a22.DEPARTMENT_NBR and
a21.CUR_TRN_DT = a22.CUR_TRN_DT and
a21.STORE_NBR = a22.STORE_NBR)
left outer join STORE_DEPARTMENT a23
on (a21.STORE_NBR = a23.STORE_NBR and
a21.DEPARTMENT_NBR = a23.DEPARTMENT_NBR and
a21.CUR_TRN_DT = a23.CUR_TRN_DT),
LOOKUP_MARKET a24
where a21.MARKET_NBR = a24.MARKET_NBR
group by a21.MARKET_NBR

SQL 89 Inner Join and SQL 92 Outer & Cross

create table ZZOL00 as

select a23.STORE_NBR STORE_NBR,

1408 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

a23.MARKET_NBR MARKET_NBR,
a22.DEPARTMENT_NBR DEPARTMENT_NBR,
a21.CUR_TRN_DT CUR_TRN_DT
from LOOKUP_DAY a21
cross join LOOKUP_DEPARTMENT a22
cross join LOOKUP_STORE a23
select a21.MARKET_NBR MARKET_NBR,
max(a24.MARKET_DESC) MARKET_DESC,
sum((a22.COST_AMT * a23.TOT_SLS_DLR)) SUMTSC
from ZZOL00 a21
left outer join COST_STORE_DEP a22
on (a21.DEPARTMENT_NBR = a22.DEPARTMENT_NBR
and
a21.CUR_TRN_DT = a22.CUR_TRN_DT and
a21.STORE_NBR = a22.STORE_NBR)
left outer join STORE_DEPARTMENT a23
on (a21.STORE_NBR = a23.STORE_NBR and
a21.DEPARTMENT_NBR = a23.DEPARTMENT_NBR and
a21.CUR_TRN_DT = a23.CUR_TRN_DT),
LOOKUP_MARKET a24
where a21.MARKET_NBR = a24.MARKET_NBR
group by a21.MARKET_NBR

Lo o ku p Tab le Jo in Or d er
Lookup Tabl e Joi n Order i s an advanced property that i s hi dden by
defaul t. For i nformati on on how to di spl ay thi s property, see Vi ew i ng
and C hangi ng Advanced VLD B Properti es, page 1330.

Thi s property determi nes how l ookup tabl es are l oaded for bei ng
j oi ned. The setti ng opti ons are

l Parti al l y based on attri bute l evel (behavi or pri or to versi on 8.0.1)

(defaul t)

l Ful l y based on attri bute l evel . Lookup tabl es for l ow er l evel

attri butes are j oi ned before those for hi gher l evel attri butes

If you sel ect the fi rst opti on, l ookup tabl es are l oaded for j oi n i n
al phabeti c order.

© 2019, M icr o St r at egy In c. 1409

Syst em Ad m in ist r at io n Gu id e

If you sel ect the second opti on, l ookup tabl es are l oaded for j oi n
based on attri bute l evel s, and j oi ni ng i s performed on the l ow est l evel
attri bute fi rst.

Level s at Whi ch You Can Set Thi s

R eport, templ ate, and proj ect

Max Tab les in Jo in

Max Tabl es i n Joi n i s an advanced property that i s hi dden by defaul t.
For i nformati on on how to di spl ay thi s property, see Vi ew i ng and
C hangi ng Advanced VLD B Properti es, page 1330.

The Max Tabl es i n Joi n property w orks together w i th the Max Tabl es
i n Joi n Warni ng property. It speci fi es the maxi mum number of tabl es
i n a j oi n. If the maxi mum number of tabl es i n a j oi n (speci fi ed by the
Max Tabl es In Joi n property) i s exceeded, then the Max Tabl es i n
Joi n Warni ng property deci des the course of acti on.

The tabl e bel ow expl ai ns the possi bl e val ues and thei r behavi or:

Valu e Beh avio r

0 No limit on t he number of t ables in a join

Number The maximum number of t ables in a join is set t o t he number specif ied

Level s at Whi ch You Can Set Thi s

D atabase i nstance onl y

Max Tab les in Jo in War n in g

Max Tabl es i n Joi n Warni ng i s an advanced property that i s hi dden by
defaul t. For i nformati on on how to di spl ay thi s property, see Vi ew i ng
and C hangi ng Advanced VLD B Properti es, page 1330.

1410 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

The Max Tabl es i n Joi n Warni ng property w orks i n conj uncti on w i th

the Max Tabl es i n Joi n property. If the maxi mum number of tabl es i n a
j oi n (speci fi ed by the Max Tabl es i n Joi n property) i s exceeded, then
thi s property control s the acti on taken. The opti ons are to ei ther
conti nue or cancel the executi on.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Nest ed Aggr egat io n Ou t er Jo in s

The N ested Aggregati on Outer Joi ns VLD B property al l ow s you defi ne
w hen outer j oi ns are performed on metri cs that are defi ned w i th
nested aggregati on functi ons. A nested aggregati on functi on i s w hen
one aggregati on functi on i s i ncl uded w i thi n another aggregati on
functi on. For exampl e, S u m( C o u n t( E x p r e s s i o n) ) uses nested
aggregati on because the C ount aggregati on i s cal cul ated w i thi n the
Sum aggregati on.

These types of metri cs can experi ence unexpected behavi or w hen

attempti ng to use outer j oi ns. Thi s VLD B property provi des the
fol l ow i ng opti ons to control the outer j oi n behavi or for metri cs that use
nested aggregati on:

l D o not perform outer join on nested aggregation (defaul t): Outer

j oi ns are not used for metri cs that use nested aggregati on, even i f
the metri c i s defi ned to use an outer j oi n. Thi s opti on refl ects the
behavi or of al l pre-9.0 Mi croStrategy rel eases.

l D o perform outer join on nested aggregation when all formulas

have the same level: If al l the i nner metri cs have the same l evel ,
w hi ch i s l ow er than the report l evel , and the formul a j oi n type for the
outer metri c i s set to outer, then an outer j oi n i s performed on the
i nner metri cs.

© 2019, M icr o St r at egy In c. 1411

Syst em Ad m in ist r at io n Gu id e

l D o perform downward outer join on nested aggregation when all

formulas can downward outer join to a common lower level:
R egardl ess of w hether the i nner metri cs have the same l evel , i f
more than one i nner metri c has a l evel w hi ch i s the chi l d of the
l evel s of other i nner metri cs and the formul a j oi n type for the outer
metri c i s set to outer, then a dow nw ard outer j oi n i s performed on
the rel evant i nner metri cs. The behavi or of the dow nw ard outer j oi n
fol l ow s the D ow nw ard Outer Joi n Opti on VLD B property (see
N ested Aggregati on Outer Joi ns, page 1411).

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Pr eser vin g Dat a Usin g Ou t er Jo in s

For the next tw o properti es, consi der the fol l ow i ng si mpl e exampl e
data.

Store Table (lookup)

Sto re ID Sto re Name

1 E ast

2 Cent ral

3 S out h

6 Nort h

Fact Table

Sto re ID Year Do llar Sales

1 2002 1000

1412 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Sto re ID Year Do llar Sales

2 2002 2000

3 2002 5000

1 2003 4000

2 2003 6000

3 2003 7000

4 2003 3000

5 2003 1500

The Fact tabl e has data for Store ID s 4 and 5, but the Store tabl e
does not have any entry for these tw o stores. On the other hand,
noti ce that the N orth Store does not have any entri es i n the Fact
tabl e. Thi s data i s used to show exampl es of how the next tw o
properti es w ork.

Pr eser ve All Fin al Pass Resu lt Elemen t s

Preserve Al l Fi nal Pass R esul t El ements i s an advanced
VLD B property that i s hi dden by defaul t. For an i ntroducti on to thi s
property, see Preserve Al l Fi nal Pass R esul t El ements, page 1413.
For i nformati on on how to di spl ay thi s property, see Vi ew i ng and
C hangi ng Advanced VLD B Properti es, page 1330.

The fol l ow i ng Preserve Al l Fi nal Pass R esul t El ements

VLD B property setti ngs determi ne how to outer j oi n the fi nal resul t, as
w el l as the l ookup and rel ati onshi p tabl es:

l If you choose the defaul t Preserve common elements of final

pass result table and lookup/relationship table opti on, the SQL
Engi ne generates an equi -j oi n. Therefore, you onl y see el ements

© 2019, M icr o St r at egy In c. 1413

Syst em Ad m in ist r at io n Gu id e

that are common to both tabl es.

l If you choose the Preserve all final result pass elements opti on,
the SQL Engi ne generates an outer j oi n, and your report contai ns
al l of the el ements that are i n the fi nal resul t set. When thi s setti ng
i s turned ON , outer j oi ns are generated for any j oi ns from the fact
tabl e to the l ookup tabl e, as w el l as to any rel ati onshi p tabl es. Thi s
i s because i t i s hard to di sti ngui sh w hi ch tabl e i s used as a l ookup
tabl e and w hi ch tabl e i s used as a rel ati onshi p tabl e, the tw o rol es
one tabl e often pl ays. For exampl e, LOOKU P_D AY serves as both a
l ookup tabl e for the D ay attri bute, as w el l as a rel ati onshi p tabl e for
D ay and Month.

This s etting s hould not be us ed in s tandard data warehous es , where

the look up tables are properly maintained and all elements in the fac t
table hav e entries in the res pec tiv e look up table. It s hould be us ed
only when a c ertain attribute in the fac t table c ontains more (unique)
attribute elements than its c orres ponding look up table. For ex ample,
in the ex ample abov e, the Fac t Table c ontains s ales for fiv e different
s tores , but the Store Table c ontains only four s tores . This s hould not
happen in a s tandard data warehous e bec aus e the look up table, by
definition, s hould c ontain all the attribute elements . Howev er, this
c ould happen if the fac t tables are updated more often than the look up
tables .

l If you choose the Preserve all elements of final pass result table
with respect to lookup table but not relationship table opti on, the
SQL Engi ne generates an i nner j oi n on al l passes except the fi nal
pass; on the fi nal pass i t generates an outer j oi n.

l If you choose the D o not listen to per report level setting,

preserve elements of final pass according to the setting at
attribute level. If thi s choi ce i s sel ected at attri bute l evel , i t w i l l be
treated as preserve common el ements (that i s, choice 1) opti on at
the database i nstance, report, or templ ate l evel , the setti ng for thi s

1414 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

VLD B property i s used at the attri bute l evel . Thi s val ue shoul d not
be sel ected at the attri bute l evel . If you sel ect thi s setti ng at the
attri bute l evel , the VLD B property i s set to the Preserve common
elements of final pass result table and lookup table opti on.

Thi s setti ng i s useful i f you have onl y a few attri butes that requi re
di fferent j oi n types. For exampl e, i f among the attri butes i n a report
onl y one needs to preserve el ements from the fi nal pass tabl e, you
can set the VLD B property to Preserve all final pass result
elements setti ng for that one attri bute. You can then set the report
to the D o not listen setti ng for the VLD B property. When the report
i s run, onl y the attri bute set di fferentl y causes an outer j oi n i n SQL.
Al l other attri bute l ookup tabl es w i l l be j oi ned usi ng an equal j oi n,
w hi ch l eads to better SQL performance.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, templ ate, and attri bute

Exam p l es

The fi rst tw o exampl es bel ow are based on the Preserve Al l Fi nal

Pass R esul t El ements, page 1413 exampl e above. The thi rd exampl e,
for the Preserve all elements of final pass result table with respect
to lookup table but not relationship table opti on, i s a separate
exampl e desi gned to refl ect the i ncreased compl exi ty of that opti on's
behavi or.

Preserve common elements of final pass result table and

lookup/relationship table

A report has Store and Dollar Sales on the template.

The "Pres erv e c ommon elements of final pas s res ult table and look up table"
option returns the following res ults us ing the SQL below.

© 2019, M icr o St r at egy In c. 1415

Syst em Ad m in ist r at io n Gu id e

Sto re Do llar Sales

E ast 5000

Cent ral 8000

S out h 12000

select a11.Store_id Store_id,

max(a12.Store) Store,
sum(a11.DollarSls) WJXBFS1
from Fact a11
join Store a12
on (a11.Store_id = a12.Store_id)
group by a11.Store_id

Preserve all final result pass elements

A report has Store and Dollar Sales on the template.

The "Pres erv e all final res ult pas s elements " option returns the following
res ults us ing the SQL below. Notic e that the data for Store_IDs 4 and 5 are
now s hown.

Sto re Do llar Sales

E ast 5000

Cent ral 8000

S out h 12000

3000

1500

select a11.Store_id Store_id,

max(a12.Store) Store,
sum(a11.DollarSls) WJXBFS1
from Fact a11
left outer join Store a12

1416 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

on (a11.Store_id = a12.Store_id)
group by a11.Store_id

Preserve all elements of final pass result table with respect to lookup table
but not to relationship table

A report has Country , Metric 1, and Metric 2 on the template. The following
fac t tables ex is t for eac h metric :

CAL L CENT ER_

F act 1
ID

1 1000

2 2000

1 1000

2 2000

3 1000

4 1000

EMPL OYEE_ID F act 2

1 5000

2 6000

1 5000

2 6000

3 5000

4 5000

5 1000

© 2019, M icr o St r at egy In c. 1417

Syst em Ad m in ist r at io n Gu id e

The SQL Engine performs three pas s es . In the firs t pas s , the SQL Engine
c alc ulates metric 1. The SQL Engine inner joins the "Fac t Table (Metric 1)"
table abov e with the c all c enter look up table "LU_CALL_CTR" below:

CAL L CENT ER_ID COUNT RY_ID

1 1

2 1

3 2

to c reate the following metric 1 temporary table, grouped by c ountry , us ing

the SQL that follows :

COUNT RY_ID Metric 1

1 6000

2 1000

create table ZZSP00 nologging as

select a12.COUNTRY_ID COUNTRY_ID,
sum((a11.QTY_SOLD * a11.DISCOUNT))
WJXBFS1
from ORDER_DETAIL a11,
LU_CALL_CTR a12
where a11.CALL_CTR_ID = a12.CALL_CTR_ID
group by a12.COUNTRY_ID

In the s ec ond pas s , metric 2 is c alc ulated. The SQL Engine inner joins the
"Fac t Table (Metric 2)" table abov e with the employ ee look up table "LU_
EMPLOYEE" below:

1418 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

EMPL OYEE_ID COUNT RY_ID

1 1

2 2

3 2

To c reate the following metric 2 temporary table, grouped by c ountry , us ing

the SQL that follows :

COUNT RY_ID Metric 2

1 10000

2 17000

create table ZZSP01 nologging as

select a12.COUNTRY_ID COUNTRY_ID,
sum(a11.FREIGHT) WJXBFS1
from ORDER_FACT a11,
LU_EMPLOYEE a12
where a11.EMP_ID = a12.EMP_ID
group by a12.COUNTRY_ID

In the third pas s , the SQL Engine us es the following c ountry look up table,
"LU_COUNTRY":

COUNT RY_ID COUNT RY_DESC

1 Unit ed S t at es

3 E urope

The SQL Engine left outer joins the METRIC1_TEMPTABLE abov e and the
LU_COUNTRY table. The SQL Engine then left outer joins the METRIC2_

© 2019, M icr o St r at egy In c. 1419

Syst em Ad m in ist r at io n Gu id e

TEMPTABLE abov e and the LU_COUNTRY table. Finally , the SQL Engine
inner joins the res ults of the third pas s to produc e the final res ults .

The "Pres erv e all elements of final pas s res ult table with res pec t to look up
table but not to relations hip table" option returns the following res ults us ing
the SQL below.

COUNT RY_ Metric

COUNT RY_ID Metric 1
DESC 2

1 Unit ed S t at es 6000 10000

2 1000 17000

select pa1.COUNTRY_ID COUNTRY_ID,

a11.COUNTRY_NAME COUNTRY_NAME,
pa1.WJXBFS1 WJXBFS1,
pa2.WJXBFS1 WJXBFS2
from ZZSP00 pa1,
ZZSP01 pa2,
LU_COUNTRY a11
where pa1.COUNTRY_ID = pa2.COUNTRY_ID and
pa1.COUNTRY_ID = a11.COUNTRY_ID (+)

Pr eser ve All Lo o ku p Tab le Elemen t s

For an i ntroducti on to thi s property, see Preservi ng D ata U si ng Outer
Joi ns, page 1412.

The Preserve Al l Lookup Tabl e El ements VLD B property i s used to

show al l attri bute el ements that exi st i n the l ookup tabl e, even though
there i s no correspondi ng fact i n the resul t set. For exampl e, your
report contai ns Store and Sum(Sal es), and i t i s possi bl e that a store
does not have any sal es at al l . H ow ever, you w ant to show al l the
store names i n the fi nal report, even those stores that do not have
sal es. To do that, you must not rel y on the stores i n the sal es fact
tabl e. Instead, you must make sure that al l the stores from the l ookup

1420 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

tabl e are i ncl uded i n the fi nal report. The SQL Engi ne needs to do a
l eft outer j oi n from the l ookup tabl e to the fact tabl e.

It i s possi bl e that there are mul ti pl e attri butes on the templ ate. To
keep al l the attri bute el ements, Anal yti cal Engi ne needs to do a
C artesi an Joi n betw een i nvol ved attri butes' l ookup tabl es before
doi ng a l eft outer j oi n to the fact tabl e.

In Mic roStrategy 7.1, this property was k nown as Final Pas s Res ult
Table Outer J oin to Look up Table.

Pr eser ve Com m on El em ent s of Lookup and Fi nal Pass Resul t Tab l e

(Def aul t ).

The Anal yti cal Engi ne does a normal (equal ) j oi n to the l ookup tabl e.

Pr eser ve Lookup Tab l e El em ent s Joi ned t o Fi nal Pass Resul t Tab l e
Based on Fact Tab l e Keys.

Someti mes the fact tabl e l evel i s not the same as the report or
templ ate l evel . For exampl e, a report contai ns Store, Month, Sum
(Sal es) metri c, but the fact tabl e i s at the l evel of Store, D ay, and
Item. There are tw o w ays to keep al l the store and month el ements:

l D o a l eft outer j oi n fi rst to keep al l attri bute el ements at the Store,

D ay, and Item l evel , then aggregate to the Store and Month l evel .

l D o aggregati on fi rst, then do a l eft outer j oi n to bri ng i n al l attri bute

el ements.

Thi s opti on i s for the fi rst approach. In the exampl e gi ven

previ ousl y, i t makes tw o SQL passes:

Pass 1: LOOKU P_STOR E cross j oi n LOOKU P_D AY cross j oi n

LOOKU P_ITEM è TT1

Pass 2: TT1 l eft outer j oi n Fact_Tabl e on (store, day, i tem)

© 2019, M icr o St r at egy In c. 1421

Syst em Ad m in ist r at io n Gu id e

The advantage of thi s approach i s that you can do a l eft outer j oi n and
aggregati on i n the same pass (pass 2). The di sadvantage i s that
because you do a C artesi an j oi n w i th the l ookup tabl es at a much
l ow er l evel (pass 1), the resul t of the C artesi an j oi ned tabl e (TT1) can
be very l arge.

Pr eser ve Lookup Tab l e El em ent s Joi ned t o Fi nal Pass Resul t Tab l e
Based on Tem p l at e At t r i b ut es Wi t hout Fi l t er .

Thi s opti on corresponds to the second approach descri bed above.

Sti l l usi ng the same exampl e, i t makes three SQL passes:

l Pass 1: aggregate the Fact_Tabl e to TT1 at Store and Month. Thi s

i s actual l y the fi nal pass of a normal report w i thout turni ng on thi s
setti ng.

l Pass 2: LOOKU P_STOR E cross j oi n LOOKU P_MON TH è TT2

l Pass 3: TT2 l eft outer j oi n TT1 on (store, month)

Thi s approach needs one more pass than the previ ous opti on, but the
cross j oi n tabl e (TT2) i s usual l y smal l er.

Pr eser ve Lookup Tab l e El em ent s Joi ned t o Fi nal Pass Resul t Tab l e
Based on Tem p l at e At t r i b ut es w i t h Fi l t er .

Thi s opti on i s si mi l ar to Opti on 3. The onl y di fference i s that the

report fi l ter i s appl i ed i n the fi nal pass (Pass 3). For exampl e, a report
contai ns Store, Month, and Sum(Sal es) w i th a fi l ter of Year = 2002.
You w ant to di spl ay every store i n every month i n 2002, regardl ess of
w hether there are sal es. H ow ever, you do not w ant to show any
months from other years (onl y the 12 months i n year 2002). Opti on 4
resol ves thi s i ssue.

When thi s VLD B setti ng i s turned ON (Opti on 2, 3, or 4), i t i s assumed

that you w ant to keep ALL el ements of the attri butes i n thei r l ookup
tabl es. H ow ever, someti mes you w ant such a setti ng to affect onl y
some of the attri butes on a templ ate. For a report contai ni ng Store,

1422 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Month, Sum(Sal es), you may w ant to show al l the store names, even
though they have no sal es, but not necessari l y al l the months i n the
LOOKU P_MON TH tabl e. In 7i , you can i ndi vi dual l y sel ect attri butes
on the templ ate that need to preserve el ements. Thi s can be done
from the D ata menu, sel ecti ng R eport D ata Option, and then
choosi ng A ttribute Join Type. N oti ce that the 4 opti ons show n on the
upper ri ght are the same as those i n the VLD B di al og box (i nternal l y
they are read from the same l ocati on). In the l ow er-ri ght part, you see
i ndi vi dual attri butes. By defaul t, al l attri butes are set to Outer, w hi ch
means that every attri bute parti ci pates w i th the Preserve Al l Lookup
Tabl es El ements property. You sti l l need to turn on thi s property to
make i t take effect, w hi ch can be done usi ng ei ther thi s di al og box or
the VLD B di al og box.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

The Preserve common elements of lookup and final pass result

table option s imply generates a direc t join between the fac t table and the
look up table. The res ults and SQL are as follows .

Sto re Do llar Sales

E ast 5000

Cent ral 8000

S out h 12000

select a11.Store_id Store_id,

max(a12.Store) Store,
sum(a11.DollarSls) WJXBFS1
from Fact a11
join Store a12
on (a11.Store_id = a12.Store_id)
group by a11.Store_id

© 2019, M icr o St r at egy In c. 1423

Syst em Ad m in ist r at io n Gu id e

The "Pres erv e look up table elements joined to final pas s res ult table bas ed
on fac t k ey s " option c reates a temp table that is a Cartes ian join of all
look up table k ey c olumns . Then the fac t table is outer joined to the temp
table. This pres erv es all look up table elements . The res ults and SQL are as
below:

Sto re Do llar Sales

E ast 5000

Cent ral 8000

S out h 12000

Nort h

select distinct a11.Year Year

into #ZZOL00
from Fact a11
select pa1.Year Year,
a11.Store_id Store_id
into #ZZOL01
from #ZZOL00 pa1
cross join Store a11
select pa2.Store_id Store_id,
max(a12.Store) Store,
sum(a11.DollarSls) WJXBFS1
from #ZZOL01 pa2
left outer join Fact a11
on (pa2.Store_id = a11.Store_id and
pa2.Year = a11.Year)
join Store a12
on (pa2.Store_id = a12.Store_id)
group by pa2.Store_id
drop table #ZZOL00
drop table #ZZOL01

The "Pres erv e look up table elements joined to final pas s res ult table bas ed
on template attributes without filter" option pres erv es the look up table
elements by left outer joining to the final pas s of SQL and only joins on

1424 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

attributes that are on the template. For this ex ample and the nex t, the filter
of "Store not equal to Central" is added. The res ults and SQL are as follows :

Sto re Do llar Sales

E ast 5000

Cent ral

S out h 12000

Nort h

select a11.Store_id Store_id,

sum(a11.DollarSls) WJXBFS1
into #ZZT5X00003UOL000
from Fact a11
where a11.Store_id not in (2)
group by a11.Store_id
select a11.Store_id Store_id,
a11.Store Store,
pa1.WJXBFS1 WJXBFS1
from Store a11
left outer join #ZZT5X00003UOL000 pa1
on (a11.Store_id = pa1.Store_id)
drop table #ZZT5X00003UOL000

The "Pres erv e look up table elements joined to final pas s res ult table bas ed
on template attributes with filter" option is the newes t option and is the
s ame as abov e, but y ou get the filter in the final pas s . The res ults and SQL
are as follows :

Sto re Do llar Sales

E ast 5000

S out h 12000

Nort h

© 2019, M icr o St r at egy In c. 1425

Syst em Ad m in ist r at io n Gu id e

select a11.Store_id Store_id,

sum(a11.DollarSls) WJXBFS1
into #ZZT5X00003XOL000
from Fact a11
where a11.Store_id not in (2)
group by a11.Store_id
select a11.Store_id Store_id,
a11.Store Store,
pa1.WJXBFS1 WJXBFS1
from Store a11
left outer join #ZZT5X00003XOL000 pa1
on (a11.Store_id = pa1.Store_id)
where a11.Store_id not in (2)
drop table #ZZT5X00003XOL000

Modifying Third-Party Cube Sources in MicroStrategy:

MDX
The tabl e bel ow summari zes the Mul ti D i mensi onal Expressi on (MD X)
rel ated VLD B properti es. These properti es appl y onl y to MD X cube
reports usi ng data from an MD X cube. MD X cubes are al so referred to
as MD X cube sources. Mi croStrategy supports reporti ng and anal ysi s
w i th SAP BW, Mi crosoft Anal ysi s Servi ces, H yperi on Essbase, and
IBM C ognos TM1. Addi ti onal detai l s about each property, i ncl udi ng
exampl es w here necessary, are provi ded i n the secti ons fol l ow i ng the
tabl e.

In the tabl e bel ow , the defaul t val ues for each VLD B property are the
general defaul ts that can be appl i ed most broadl y for the set of
certi fi ed MD X cube sources. C ertai n VLD B properti es use di fferent
defaul t setti ngs dependi ng on w hi ch MD X cube source you are usi ng.
To determi ne al l defaul t VLD B property setti ngs for the MD X cube
source you are reporti ng on, fol l ow the steps provi ded i n D efaul t
VLD B Setti ngs for Speci fi c D ata Sources, page 1643.

1426 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

Def ines t he dat e

f ormat used in your
Format for
MDX cube source.
D ate/Time
This ensures t he
Values C oming User-def ined DD. MM. Y Y Y Y
dat e dat a is
from D ata
int egrat ed int o
Sourc e
MicroS t rat egy
correct ly.

Det ermines how • Do not add a f ake

MDX cube report s measure t o an
t hat only include at t ribut e-only MDX A dd a f ake
MD X Add Fak e at t ribut es are report measure t o an
Measure processed in order • A dd a f ake at t ribut e-only
t o improve measure t o an MDX report
perf ormance in at t ribut e-only MDX
cert ain scenarios. report

• Do not add t he
non-empt y
keyword in t he
MDX select clause

• A dd t he non-empt y A dd t he non-
Det ermines whet her
keyword in t he empt y keyword in
or not dat a is
MD X Add N on MDX select clause t he MDX select
ret urned f rom rows
Empty only if t here are clause only if
t hat have null
met rics on t he t here are met rics
values.
report on t he report

• A lways add t he
non-empt y
keyword in t he
MDX select clause

Def ines whet her t he • MDX met ric values MDX met ric
MD X C ell
met ric values in are f ormat t ed per values are
Formatting
MicroS t rat egy MDX column f ormat t ed per

© 2019, M icr o St r at egy In c. 1427

Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

cube report s inherit

• MDX met ric values
t heir value
are f ormat t ed per column
f ormat t ing f rom an
cell
MDX cube source.

Det ermines how • Only include t he

null values are af f ect ed hierarchy
ident if ied if you use in t he " has
t he Modify ing measure values" Only include t he
MD X has Third-Party C ube set def init ion af f ect ed
Measure Values Sourc es in hierarchy in t he
in Other Mic roStrategy : • I nclude all " has measure
H ierarchies MD X V LDB t emplat e values" set
propert y t o ignore hierarchies in t he def init ion
null values coming " has measure

f rom MDX cube values" set

sources. def init ion

Det ermines whet her

level (f rom t he
bot t om of t he • Use act ual level
MD X Lev el hierarchy up) or number
N umber generat ion (f rom • Use generat ion Use act ual level
C alc ulation t he t op of t he number t o number
Method hierarchy down) calculat e level
should be used t o number
populat e t he report
result s.

A llows you t o
specif y what
measure values are
MD X Measure
def ined as NULL
Values to Treat User-def ined X
values, which can
as N ull
help t o support how
your S A P
environment

1428 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

handles non-
calculat ed
measures.

• No non-empt y
Det ermines how null opt imizat ion
values f rom an MDX • Non-empt y
cube source are opt imizat ion, use
ignored using t he def ault measure
non-empt y keyword
MD X N on Empty when at t ribut es • Non-empt y No non-empt y
Optimiz ation f rom dif f erent opt imizat ion, use opt imizat ion
hierarchies f irst measure on

(dimensions) are t emplat e

included on t he • Non-empt y
same MDX cube opt imizat ion, use
report . all measures on
t emplat e

• Do not remember
t he name of t he
measure
dimension

• Remember t he
Def ines how t he name of t he
MD X R emember Do not remember
name of t he measure
Measure t he name of t he
measure dimension dimension
D imens ion measure
is det ermined f or an
N ame • Read t he name of dimension
MDX cube source.
t he measure
dimension f rom
t he " Name of
Measure
Dimension" V LDB
set t ing

MD X TopC ount Det ermines whet her • Do not use Use TopCount

© 2019, M icr o St r at egy In c. 1429

Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

TopCount is used in
place of Rank and TopCount in t he
Order t o support place of Rank and
cert ain Order inst ead of Rank
Support
MicroS t rat egy • Use TopCount and Order
f eat ures such as inst ead of Rank
met ric f ilt er and Order
qualif icat ions.

• Do not t reat a dat e

qualif icat ion on a
key f orm as a dat e
Modifying Third- qualif icat ion on an Treat a dat e
Det ermines how
Party C ube I D f orm: qualif icat ion on a
dat e qualif icat ions
Sourc es in key f orm as a
are processed f or • Treat a dat e
Mic roStrategy : dat e qualif icat ion
MDX cube sources. qualif icat ion on a
MD X on an I D f orm
key f orm as a dat e
qualif icat ion on an
I D f orm

• Do not verif y t he
S upport s an MDX level of lit erals in
cube report ing limit or f ilt er Do not verif y t he
MD X Verify
scenario in which expressions level of lit erals in
Limit Filter
f ilt ers are creat ed limit or f ilt er
Literal Lev el • V erif y t he level of
on at t ribut e I D expressions
f orms and met rics. lit erals in limit or
f ilt er expressions

Modifying Third-
Def ines t he name
Party C ube
of t he measures
Sourc es in User-def ined [ Measures]
dimension in an
Mic roStrategy :
MDX cube source.
MD X

1430 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Fo r mat f o r Dat e/ Time Valu es Co min g f r o m Dat a So u r ce

D ate data can be stored i n a vari ety of formats i n MD X cube sources.
To ensure that your date data from your MD X cube source i s
i ntegrated i nto Mi croStrategy w i th the correct format, you can use the
Format for D ate/Ti me Val ues C omi ng from D ata Source VLD B
property to defi ne the date format used i n your MD X cube source.

The defaul t date format i s D D .MM.YYYY.

The date of J uly 4, 1776 is repres ented as 04.07.1776.

See the MD X C ube R eporti ng Gui de for i nformati on on supporti ng

MD X cube source date data i n Mi croStrategy.

Level s at Whi ch You Can Set Thi s

D atabase i nstance onl y

MDX Ad d Fake Measu r e

MD X Add Fake Measure i s an advanced property that i s hi dden by
defaul t. For i nformati on on how to di spl ay thi s property, see Vi ew i ng
and C hangi ng Advanced VLD B Properti es, page 1330.

It i s a common practi ce to i ncl ude both attri butes and metri cs on an

MD X cube report. H ow ever, MD X cube reports can al so contai n onl y
attri butes to revi ew attri bute i nformati on. If thi s type of MD X cube
report accesses data that i s parti ti oned w i thi n the MD X cube source,
the report can requi re addi ti onal resources and i mpact the
performance of the report. To avoi d thi s performance i ssue, the MD X
Add Fake Measure VLD B property provi des the fol l ow i ng opti ons:

l D o not add fake measure to attribute-only MD X report: MD X

cube reports that onl y contai n attri butes w i thout any metri cs are
processed as normal . Thi s can cause addi ti onal processi ng to be

© 2019, M icr o St r at egy In c. 1431

Syst em Ad m in ist r at io n Gu id e

requi red for thi s type of MD X cube report i f i t accesses data that i s
parti ti oned w i thi n the MD X cube source. Thi s i s the defaul t opti on
for SAP and Essbase MD X cube sources.

l A dd a fake measure to an attribute-only MD X report: MD X cube

reports that onl y contai n attri butes w i thout any metri cs al so i ncl ude
an addi ti onal structure that acts as a metri c, al though no metri cs are
di spl ayed on the report. Thi s can i mprove performance of MD X cube
reports that onl y contai n attri butes and al so access data that i s
parti ti oned w i thi n the MD X cube source. Thi s i s the defaul t opti on
for Mi crosoft Anal ysi s Servi ces MD X cube sources.

Level s at Whi ch You Can Set Thi s

D atabase i nstance and report

MDX Ad d No n Emp t y
MD X Add N on Empty i s an advanced VLD B property that i s hi dden by
defaul t. For i nformati on on how to di spl ay thi s property, see Vi ew i ng
and C hangi ng Advanced VLD B Properti es, page 1330.

The MD X Add N on Empty VLD B property determi nes how nul l val ues
are returned to Mi croStrategy from an MD X cube source and
di spl ayed on MD X cube reports. To determi ne w hether nul l data
shoul d be di spl ayed on MD X cube reports, w hen attri butes from
di fferent hi erarchi es (di mensi ons) are i ncl uded on the same MD X
cube report, see MD X N on Empty Opti mi zati on, page 1438.

You can choose from the fol l ow i ng setti ngs:

l D o not add the non-empty keyword in the MD X select clause:

When thi s opti on i s sel ected, data i s returned from row s that contai n
data and row s that have nul l metri c val ues (si mi l ar to an outer j oi n
i n SQL). The nul l val ues are di spl ayed on the MD X cube report.

1432 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l A dd the non-empty keyword in the MD X select clause only if

there are metrics on the report (defaul t): When thi s opti on i s
sel ected, and metri cs are i ncl uded on an MD X cube report, data i s
not returned from the MD X cube source w hen the defaul t metri c i n
the MD X cube source has nul l data. Any data not returned i s not
i ncl uded on MD X cube reports (si mi l ar to an i nner j oi n i n SQL). If no
metri cs are present on an MD X cube report, then al l val ues for the
attri butes are returned and di spl ayed on the MD X cube report.

l A lways add the non-empty keyword in the MD X select clause:

When thi s opti on i s sel ected, data i s not returned from the MD X
cube source w hen a metri c on the MD X cube report has nul l data.
Any data not returned i s not i ncl uded on MD X cube reports (si mi l ar
to an i nner j oi n i n SQL).

Level s at Whi ch You Can Set Thi s

D atabase i nstance and report

See the MD X C ube R eporti ng Gui de for more information on MDX

s ourc es .

Do not add the non-empty keyword in the MDX select clause

with set [dim0_select_members] as '{[0D_SOLD_TO].

[LEVEL01].members}'
set [dim1_select_members] as '{[0CALQUARTER].
[LEVEL01].members}'
select {[Measures].[3STVV9JH7ATAV9YJN06S7ZKSQ]} on
columns,CROSSJOIN(hierarchize({[dim0_select_members]}),
hierarchize({[dim1_select_members]})) dimension
properties [0D_SOLD_TO].[20D_SOLD_TO], [0D_SOLD_TO].
[10D_SOLD_TO] on rows
from [0D_DECU/QCUBE2]

Add the non-empty keyword in the MDX select clause

© 2019, M icr o St r at egy In c. 1433

Syst em Ad m in ist r at io n Gu id e

with set [dim0_select_members] as '{[0D_SOLD_TO].

[LEVEL01].members}'set [dim1_select_members] as '
{[0CALQUARTER].[LEVEL01].members}'
select {[Measures].[3STVV9JH7ATAV9YJN06S7ZKSQ]} on
columns,
non empty CROSSJOIN(hierarchize({[dim0_select_
members]}), hierarchize({[dim1_select_members]}))
dimension properties [0D_SOLD_TO].[20D_SOLD_TO], [0D_
SOLD_TO].[10D_SOLD_TO] on rowsfrom [0D_DECU/QCUBE2]

MDX Cell Fo r mat t in g

Wi th the MD X C el l Formatti ng VLD B property, you can speci fy for the
metri c val ues i n Mi croStrategy MD X cube reports to i nheri t thei r val ue
formatti ng from an MD X cube source. Thi s enabl es Mi croStrategy
MD X cube reports to use the same data formatti ng avai l abl e i n your
MD X cube source. It al so mai ntai ns a consi stent vi ew of your MD X
cube source data i n Mi croStrategy.

Inheri ti ng val ue formats from your MD X cube source al so enabl es you

to appl y mul ti pl e val ue formats to a si ngl e Mi croStrategy metri c.

Thi s VLD B property has the fol l ow i ng opti ons:

l MD X metric values are formatted per column (defaul t): If you

sel ect thi s opti on, MD X cube source formatti ng i s not i nheri ted. You
can onl y appl y a si ngl e format to al l metri c val ues on an MD X cube
report.

l MD X metric values are formatted per cell: If you sel ect thi s opti on,
MD X cube source formatti ng i s i nheri ted. Metri c val ue formats are
determi ned by the formatti ng that i s avai l abl e i n the MD X cube
source, and metri c val ues can have di fferent formats.

For exampl es of usi ng these opti ons and steps to confi gure your MD X
cube sources properl y, see the MD X C ube R eporti ng Gui de.

1434 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Level s at Whi ch You Can Set Thi s

D atabase i nstance and report

MDX h as Measu r e Valu es in Ot h er Hier ar ch ies

MD X H as Measure Val ues In Other H i erarchi es i s an advanced
property that i s hi dden by defaul t. For i nformati on on how to di spl ay
thi s property, see Vi ew i ng and C hangi ng Advanced VLD B Properti es,
page 1330.

Thi s VLD B property determi nes how nul l val ues are i denti fi ed i f you
use the MD X N on Empty Opti mi zati on VLD B property (see MD X has
Measure Val ues i n Other H i erarchi es, page 1435) to i gnore nul l
val ues comi ng from MD X cube sources.

If you defi ne the MD X N on Empty Opti mi zati on VLD B property as N o

non-empty opti mi zati on, then thi s VLD B property has no effect on how
nul l val ues are i gnored. If you use any other opti on for the MD X N on
Empty Opti mi zati on VLD B property, you can choose from the fol l ow i ng
setti ngs:

l Only include the affected hierarchy in the " has measure values"
set definition: Onl y a si ngl e hi erarchy on the MD X cube report i s
consi dered w hen i denti fyi ng and i gnori ng nul l val ues. Thi s requi res
few er resources to determi ne the nul l val ues, but some val ues can
be mi stakenl y i denti fi ed as nul l val ues i n scenari os such as usi ng
cal cul ated members i n an MD X cube source.

l Include all template hierarchies in the " has measure values" set
definition: Al l hi erarchi es that are part of an MD X cube report are
consi dered w hen i denti fyi ng and i gnori ng nul l val ues. Thi s can hel p
to ensure that some val ues are not l ost w hen Mi croStrategy i gnores
nul l val ues from the MD X cube source. Incl udi ng al l hi erarchi es to
i denti fy nul l val ues can requi re addi ti onal system resources and
ti me to compl ete.

© 2019, M icr o St r at egy In c. 1435

Syst em Ad m in ist r at io n Gu id e

Level s at Whi ch You Can Set Thi s

D atabase i nstance and report

MDX Level Nu mb er Calcu lat io n Met h o d

MD X Level N umber C al cul ati on i s an advanced property that i s
hi dden by defaul t. For i nformati on on how to di spl ay thi s property, see
Vi ew i ng and C hangi ng Advanced VLD B Properti es, page 1330.

Thi s VLD B property i s useful onl y for MD X cube reports that access
an Oracl e H yperi on Essbase MD X cube source. To hel p i l l ustrate the
functi onal i ty of the property, consi der an unbal anced hi erarchy w i th
the l evel s Products, D epartment, C ategory, SubC ategory, Item, and
SubItem. The i mage bel ow show s how thi s hi erarchy i s popul ated on
a report i n Mi croStrategy.

The l evel SubItem causes the hi erarchy to be unbal anced, w hi ch

di spl aces the l evel s of the hi erarchy w hen popul ated on a report i n
Mi croStrategy. For more i nformati on on unbal anced and ragged
hi erarchi es, see the MD X C ube R eporti ng Gui de.

You can choose from the fol l ow i ng setti ngs:

1436 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l U se actual level number (defaul t): When thi s opti on i s sel ected, an
unbal anced or ragged hi erarchy from Essbase i s popul ated on a
gri d from the bottom of the hi erarchy up, as show n i n the i mage
above.

l U se generation number to calculate level number: When thi s

opti on i s sel ected, an unbal anced or ragged hi erarchy from Essbase
i s popul ated on a gri d from the top of the hi erarchy dow n. If thi s
setti ng i s sel ected for the exampl e scenari o descri bed above, the
report i s popul ated as show n i n the i mage bel ow .

The unbal anced hi erarchy i s now di spl ayed on the report w i th an

accurate representati on of the correspondi ng l evel s.

Setti ng thi s VLD B property to Add the generati on number property

for a ragged hi erarchy from Essbase can cause i ncorrect
formatti ng.

Level s at Whi ch You Can Set Thi s

D atabase i nstance and report

MDX Measu r e Valu es t o Tr eat as Nu ll

MD X Measure Val ues to Treat as N ul l i s an advanced VLD B property
that i s hi dden by defaul t. For i nformati on on how to di spl ay thi s

© 2019, M icr o St r at egy In c. 1437

Syst em Ad m in ist r at io n Gu id e

property, see Vi ew i ng and C hangi ng Advanced VLD B Properti es,

page 1330.

The MD X Measure Val ues to Treat as N ul l VLD B property al l ow s you

to speci fy w hat measure val ues are defi ned as N U LL val ues, w hi ch
can hel p to support how your SAP envi ronment handl es non-
cal cul ated measures. The defaul t val ue to treat as N U LL i s X. Thi s
supports defi ni ng non-cal cul ated measures as N U LL val ues for SAP
7.4 envi ronments.

Level s at Whi ch You Can Set Thi s

D atabase i nstance and report

MDX No n Emp t y Op t imizat io n

MD X N on Empty Opti mi zati on i s an advanced VLD B property that i s
hi dden by defaul t. For i nformati on on how to di spl ay thi s property, see
Vi ew i ng and C hangi ng Advanced VLD B Properti es, page 1330.

The MD X N on Empty Opti mi zati on VLD B property determi nes how

nul l val ues from an MD X cube source are i gnored usi ng the non-
empty keyw ord w hen attri butes from di fferent hi erarchi es
(di mensi ons) are i ncl uded on the same MD X cube report.

You can choose from the fol l ow i ng setti ngs:

l N o non-empty optimization (defaul t): The non-empty keyw ord i s

not i ncl uded duri ng the cross j oi n of data. By sel ecti ng thi s opti on,
al l nul l data i s i ncl uded on the MD X cube report. Incl udi ng al l nul l
data can requi re more system resources to perform the necessary
cross j oi ns.

l N on-empty optimization, use default measure: The non-empty

keyw ord i s added to any requi red cross j oi ns based on the defaul t
measure w i thi n the MD X cube source. D ata i s onl y di spl ayed on an

1438 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

MD X cube report for row s i n w hi ch the defaul t measure w i thi n the

MD X cube source has data. If you use thi s opti on, you can al so
control w hether nul l val ues from MD X cube sources are i gnored
usi ng the VLD B property MD X H as Measure Val ues In Other
H i erarchi es (see MD X has Measure Val ues i n Other H i erarchi es,
page 1435).

l N on-empty optimization, use first measure on template: The

non-empty keyw ord i s added to any requi red cross j oi ns based on
the fi rst metri c used on an MD X cube report. D ata i s onl y di spl ayed
on an MD X cube report for row s i n w hi ch the fi rst metri c used on an
MD X cube report has data. For exampl e, i f R evenue and Profi t
metri cs are on an MD X cube report and R evenue i s i n the fi rst
col umn (l eft-most col umn), the non-empty keyw ord i s added based
on the R evenue metri c. In thi s scenari o, nul l or empty data may sti l l
be returned for the Profi t metri c. If you use thi s opti on, you can al so
control w hether nul l val ues from MD X cube sources are i gnored
usi ng the VLD B property MD X H as Measure Val ues In Other
H i erarchi es (See MD X has Measure Val ues i n Other H i erarchi es,
page 1435).

l N on-empty optimization, use all measures on template: The non-

empty keyw ord i s added to any requi red cross j oi ns based on al l
metri cs used on an MD X cube report. D ata i s onl y di spl ayed on an
MD X cube report for row s i n w hi ch at l east one of the metri cs used
on an MD X cube report has data. For exampl e, R evenue and Profi t
metri cs are on an MD X cube report, w hi ch i ncl udes the fol l ow i ng
data:

© 2019, M icr o St r at egy In c. 1439

Syst em Ad m in ist r at io n Gu id e

Year Categ o ry Reven u e Pro fit

B ooks $1, 000, 000 $300, 000

E lect ronics $2, 500, 000

2008
Movies $500, 000

Music

By sel ecti ng thi s opti on, the fol l ow i ng data w oul d be returned on
the MD X cube report:

Year Categ o ry Reven u e Pro fit

B ooks $1, 000, 000 $300, 000

2008 E lect ronics $2, 500, 000

Movies $500, 000

The Musi c row does not appear because al l the metri cs have nul l
val ues. If you use thi s opti on, you can al so control w hether nul l
val ues from MD X cube sources are i gnored usi ng the VLD B
property MD X H as Measure Val ues In Other H i erarchi es (See MD X
N on Empty Opti mi zati on, page 1438).

Level s at Whi ch You Can Set Thi s

D atabase i nstance and report

MDX Rememb er Measu r e Dimen sio n Name

MD X R emember Measure D i mensi on N ame i s an advanced property
that i s hi dden by defaul t. For i nformati on on how to di spl ay thi s
property, see Vi ew i ng and C hangi ng Advanced VLD B Properti es,
page 1330.

1440 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Thi s VLD B property defi nes how the name of the measure di mensi on
i s determi ned for an MD X cube source. You can choose from the
fol l ow i ng setti ngs:

l D o not remember the name of the measure dimension: The MD X

cube source i s not anal yzed to determi ne the name of the measure
di mensi on. Si nce most MD X cube sources use [ M e a s u r e s ] as the
measure di mensi on name and Mi croStrategy recogni zes thi s defaul t
name, thi s opti on i s recommended for most MD X cube sources.

l R emember the name of the measure dimension: The MD X cube

source i s anal yzed to determi ne the name of the measure
di mensi on. The name returned i s then used l ater w hen queryi ng the
MD X cube source. Thi s opti on can be used w hen an MD X cube
source does not use [ M e a s u r e s ] as the measure di mensi on
name, w hi ch i s the defaul t used for most MD X cube sources.
Essbase i s the MD X cube source that most commonl y uses a
measure di mensi on name other than [ M e a su r e s ].

l R ead the name of the measure dimension from the " N ame of
Measure D imension" VLD B setting: The measure di mensi on name
defi ned usi ng the N ame of Measure D i mensi on VLD B property (see
MD X R emember Measure D i mensi on N ame, page 1440) i s used as
the measure di mensi on name. You can use thi s opti on i f the MD X
cube source does not use [ M e a s u r e s ] as the measure di mensi on
name, and you know w hat al ternati ve name i s used for the measure
di mensi on.

Level s at Whi ch You Can Set Thi s

D atabase i nstance onl y

MDX To p Co u n t Su p p o r t
MD X TopC ount Support i s an advanced property that i s hi dden by
defaul t. For i nformati on on how to di spl ay thi s property, see Vi ew i ng

© 2019, M icr o St r at egy In c. 1441

Syst em Ad m in ist r at io n Gu id e

and C hangi ng Advanced VLD B Properti es, page 1330.

Thi s VLD B property determi nes w hether TopC ount i s used i n pl ace of
R ank and Order to support certai n Mi croStrategy features such as
metri c fi l ter qual i fi cati ons. TopC ount can be used w i th SAP BW and
Mi crosoft Anal ysi s Servi ces MD X cube sources.

You can choose from the fol l ow i ng setti ngs:

l D o not use TopC ount in the place of R ank and Order: The
functi ons R ank and Order are al w ays used i nstead of TopC ount.
Thi s opti on supports backw ards compati bi l i ty.

l U se TopC ount instead of R ank and Order (defaul t): The functi on
TopC ount i s automati cal l y used i n pl ace of R ank and Order w hen
necessary to support certai n Mi croStrategy features. Thi s i ncl udes
scenari os such as usi ng metri c fi l ter qual i fi cati ons on MD X cube
reports.

Level s at Whi ch You Can Set Thi s

D atabase i nstance and report

MDX Tr eat Key Dat e Qu alif icat io n as ID Dat e Qu alif icat io n

MD X Treat Key D ate Qual i fi cati on As ID D ate Qual i fi cati on i s an
advanced VLD B property that i s hi dden by defaul t. For i nformati on on
how to di spl ay thi s property, see Vi ew i ng and C hangi ng Advanced
VLD B Properti es, page 1330.

The MD X Treat Key D ate Qual i fi cati on As ID  D ate Qual i fi cati on VLD B
property determi nes how date qual i fi cati ons are processed for MD X
cube sources. You can choose from the fol l ow i ng setti ngs:

l D o not treat a date qualification on a key form as a date

qualification on an ID form: Thi s opti on processes date

1442 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

qual i fi cati ons by usi ng the member properti es. Whi l e thi s can
i mpact performance, you can use thi s opti on to support date
qual i fi cati ons on data that cannot be processed by usi ng the uni que
name.

l Treat a date qualification on a key form as a date qualification

on an ID form (defaul t): Thi s opti on provi des the best performance
for processi ng date qual i fi cati ons by usi ng the uni que name rather
than the member properti es.

Level s at Whi ch You Can Set Thi s

D atabase i nstance and report

MDX Ver if y Limit Filt er Lit er al Level

MD X Veri fy Li mi t Fi l ter Li teral Level i s an advanced property that i s
hi dden by defaul t. For i nformati on on how to di spl ay thi s property, see
Vi ew i ng and C hangi ng Advanced VLD B Properti es, page 1330.

Thi s VLD B property supports a uni que scenari o w hen anal yzi ng MD X
cube reports. An exampl e of thi s scenari o i s provi ded bel ow .

You have an MD X cube report that i ncl udes a l ow l evel attri bute on
the report, al ong w i th some metri cs. You create a fi l ter on the
attri bute's ID form, w here the ID i s betw een tw o ID val ues. You al so
i ncl ude a fi l ter on a metri c. Bel ow i s an exampl e of such an MD X cube
report defi ni ti on:

© 2019, M icr o St r at egy In c. 1443

Syst em Ad m in ist r at io n Gu id e

When you run the report, you recei ve an error that al erts you that an
unexpected l evel w as found i n the resul t. Thi s i s because the fi l ter on
the attri bute's ID form can i ncl ude other l evel s due to the structure of
ID val ues i n some MD X cube sources. When these other l evel s are
i ncl uded, the metri c fi l ter cannot be eval uated correctl y by defaul t.

You can support thi s type of report by modi fyi ng the MD X Veri fy Li mi t
Fi l ter Li teral Level . Thi s VLD B property has the fol l ow i ng opti ons:

l D o not verify the level of literals in limit or filter expressions

(defaul t): Whi l e the maj ori ty of MD X cube reports execute correctl y
w hen thi s opti on i s sel ected, the scenari o descri bed above w i l l fai l .

l Verify the level of literals in limit or filter expressions: Sel ecti ng

thi s opti on for an MD X cube report al l ow s reports fi tti ng the
scenari o descri bed above to execute correctl y. Thi s i s achi eved by
addi ng an i ntersecti on i n the MD X statement to support the
executi on of such an MD X cube report. For exampl e, the MD X cube
report descri bed i n the scenari o above executes correctl y and
di spl ays the fol l ow i ng data.

Level s at Whi ch You Can Set Thi s

D atabase i nstance and report

Name o f Measu r e Dimen sio n

N ame of Measure D i mensi on i s an advanced property that i s hi dden
by defaul t. For i nformati on on how to di spl ay thi s property, see
Vi ew i ng and C hangi ng Advanced VLD B Properti es, page 1330.

1444 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Thi s VLD B property defi nes the name of the measures di mensi on i n
an MD X cube source. The defaul t name for the measures di mensi on i s
[Mea su re s] . If your MD X cube source uses a di fferent name for the
measures di mensi on, you must modi fy thi s VLD B property to match
the name used i n your MD X cube source. R equi ri ng thi s change i s
most common w hen connecti ng to Essbase MD X cube sources, w hi ch
do not al w ays use [ M e a s u r e s ] as the measure di mensi on name.

Identi fyi ng the name of the measure di mensi on i s al so confi gured

usi ng the MD X R emember Measure D i mensi on N ame VLD B property,
as descri bed i n N ame of Measure D i mensi on, page 1444.

Level s at Whi ch You Can Set Thi s

D atabase i nstance and report

Calculating Data: Metrics

The tabl e bel ow summari zes the Metri cs VLD B properti es. Addi ti onal
detai l s about each property, i ncl udi ng exampl es w here necessary, are
provi ded i n the secti ons fol l ow i ng the tabl e.

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

The A nalyt ical E ngine

can eit her:

• P erf orm t he
non- • Use subquery
Abs olute N on- aggregat ion
• Use t emp t able
Agg Metric calculat ion wit h Use subquery
as set in t he
Query Type a subquery, or
Fallback Table
• P lace t he Type set t ing
result s t hat
would have
been select ed

© 2019, M icr o St r at egy In c. 1445

Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

f rom a subquery
int o an
int ermediat e
t able and join
t hat t able t o t he
rest of t he
query.

This propert y cont rols

whet her t he non-
aggregat ion calculat ion
C ompute N on-
is perf ormed bef ore or • Calculat e non-
Agg
af t er an A nalyt ical aggregat ion
Before/After
E ngine calculat ion. Use bef ore OLA P
OLAP Calculat e non-
t his propert y t o Funct ions/ Rank
Func tions (For aggregat ion
det ermine, f or example,
Ex ample, • Calculat e non- bef ore OLA P
whet her t he engine
R ank ) aggregat ion Funct ions/ Rank
ranks t he st ores and
C alc ulated in af t er OLA P
t hen perf orms a non-
Analy tical Funct ions/ Rank
aggregat ion calculat ion,
Engine
or perf orms t he non-
aggregat ion calculat ion
f irst .

Compound at t ribut es
are usually count ed by
concat enat ing t he keys • COUNT
of all t he at t ribut es t hat expression
C ount enabled COUNT
f orm t he key. I f t he
C ompound expression
dat abase plat f orm does • COUNT
Attribute enabled
not support COUNT on expression
concat enat ed st rings, disabled
t his propert y should be
disabled.

C OU N T S ome dat abase • Use COUNT Use COUNT

(column) plat f orms do not support (column) (column)

1446 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

count on a column
(COUNT(COL)). This
Support propert y convert s t he • Use COUNT(*)
COUNT(COL) st at ement
t o a COUNT(*).

• Do not use t he
met ric name as
A llows you t o choose t he def ault Do not use t he
whet her you want t o use met ric column met ric name as
D efault to t he met ric name as t he alias t he def ault
Metric N ame column alias or whet her
• Use t he met ric met ric column
t o use a MicroS t rat egy-
name as t he alias
generat ed name.
def ault met ric
column alias

• A dd " . 0" t o
int eger const ant
in met ric
This propert y expression A dd " . 0" ' t o
Integer
det ermines whet her t o int eger const ant
C ons tant in • Do Not A dd " . 0"
add a " . 0" af t er t he in met ric
Metric t o int eger
int eger. expression
const ant in
met ric
expression

• Disallow joins
Det ermines how values based on
f or met rics are unrelat ed
common Disallow joins
calculat ed when
at t ribut es based on
Join Ac ross unrelat ed at t ribut es,
unrelat ed
D atas ets f rom dif f erent dat aset s • A llow joins common
of a dossier or based on at t ribut es
document , are included unrelat ed
wit h met rics. common
at t ribut es:

© 2019, M icr o St r at egy In c. 1447

Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

Max Metric Maximum size of t he

User-def ined 256
Alias Size met ric alias st ring

Metric Join Type of join used in a • I nner Join

I nner Join
Type met ric. • Out er Join

I nf luences t he behavior • Opt imized f or

f or non-aggregat ion less f act t able
access Opt imized f or
N on-Agg Metric met rics by eit her
less f act t able
Optimiz ation opt imizing f or smaller • Opt imized f or access
t emporary t ables or f or smaller t emp
less f act t able access. t able

• Do not hing

• Check f or NULL
I ndicat es how t o handle Check f or NULL
in all queries
N ull C heck arit hmet ic operat ions in t emp t able
wit h NULL values. • Check f or NULL join only
in t emp t able
join only

• One pass

• Mult iple count

dist inct , but
count expression
must be t he
I ndicat es how t o handle same No count
Separate COUNT (and ot her • Mult iple count dist inct , use
C OU N T aggregat ion f unct ions) dist inct , but only select dist inct
D ISTIN C T when DI S TI NCT is one count and count (*)
present in t he S QL. dist inct per pass inst ead

• No count
dist inct , use
select dist inct
and count (*)
inst ead

1448 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

Det ermines t he
evaluat ion order t o
support variance and
Smart Metric variance percent age • False
False
Trans formation t ransf ormat ions on • True
smart met ric or
compound met ric
result s.

• Use only t he
grouping
propert y of a
level met ric f or
dynamic
aggregat ion
(def ault ):

• Use only t he
grouping
propert y of a
Det ermines how t he level subt ot al f or Use only t he
level of calculat ion is dynamic grouping
Subtotal def ined f or met rics t hat aggregat ion: propert y of a
D imens ionality are included on report s
• Use bot h t he level met ric f or
U se t hat ut ilize t he OLA P
grouping and dynamic
S ervices f eat ure
f ilt ering propert y aggregat ion
dynamic aggregat ion.
of a level met ric
f or dynamic
aggregat ion:

• Use bot h t he
grouping and
f ilt ering propert y
of a level
subt ot al f or
dynamic
aggregat ion:

© 2019, M icr o St r at egy In c. 1449

Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

Def ine met rics t hat

should be used t o
Trans formable perf orm t ransf ormat ions • False
False
AggMetric on compound met rics • True
t hat use nest ed
aggregat ion.

• 7. 1 st yle. A pply
t ransf ormat ion
t o all applicable
at t ribut es

• 7. 2 st yle. Only 7. 1 st yle. A pply

Trans formation I ndicat es how t o handle apply t ransf ormat ions
R ole t he t ransf ormat ion dat es t ransf ormat ion t o all applicable
Proc es sing calculat ion. t o highest at t ribut es
common child
when it is
applicable t o
mult iple
at t ribut es

• Do not hing

• Check f or zero in
I ndicat es how t o handle all queries Check f or zero in
Zero C heck
division by zero. all queries
• Check f or zero in
t emp t able join
only

Ab so lu t e No n -Agg Met r ic Qu er y Typ e

Absol ute N on-Agg Metri c Query Type i s an advanced property that i s
hi dden by defaul t. For i nformati on on how to di spl ay thi s property, see
Vi ew i ng and C hangi ng Advanced VLD B Properti es, page 1330.

145 0 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

When a report contai ns an absol ute non-aggregati on metri c, the pass

that gets the non-aggregated data can be performed i n a subquery or
i n a temporary tabl e.

l U se Temp Table as set in the Fallback Table Type setting: When

thi s opti on i s set, the tabl e creati on type fol l ow s the opti on sel ected
i n the VLD B property Fal l back Tabl e Type. The SQL Engi ne reads
the Fal l back Tabl e Type VLD B setti ng and determi nes w hether to
create the i ntermedi ate tabl e as a true temporary tabl e or a
permanent tabl e.

In mos t c as es , the default Fallbac k Table Ty pe VLDB s etting is

Temporary table. Howev er, for a few databas es , lik e UDB for 390, this
option is s et to Permanent table. Thes e databas es hav e their
Intermediate Table Ty pe defaulting to True Temporary Table, s o y ou
s et their Fallbac k Table Ty pe to Permanent. If y ou s ee permanent
table c reation and y ou want the abs olute non-aggregation metric to
us e a True Temporary table, s et the Fallbac k Table Ty pe to
Temporary table on the report as well.

l U se subquery (defaul t): Wi th thi s setti ng, the engi ne performs the
non-aggregati on cal cul ati on w i th a subquery.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Exam p l es

Use Sub-query

se le ct a1 1 . C L A S S _N B R C L A S S _N B R ,
a1 2. CL AS S_ D E S C C L A S S _D E S C ,
su m ( a1 1. TO T _S L S _Q T Y ) W J X B F S 1
fr om DS SA D M I N . M A R K E T _C L A S S a 1 1 ,
DS SA DM IN .L O O K U P _C L A S S a 1 2
wh er e a 11 . C L A S S _N B R = a 1 2 . C L A S S _N B R

© 2019, M icr o St r at egy In c. 145 1

Syst em Ad m in ist r at io n Gu id e

an d ( (( a1 1 . M A R K E T _N B R )
in ( se le ct s 2 1 . M A R K E T _N B R
fr om DS SA D M I N . L O O K U P _S T O R E s 2 1
wh er e s 21 . S T O R E _N B R i n ( 3 , 2 , 1 ) ) )
an d ( (a 11 . M A R K E T _N B R )
in ( se le ct m i n( c 1 1. M A R K E T _N B R )
fr om DS SA D M I N . L O O K U P _M A R K E T c 1 1
wh er e ( (c 1 1 . M A R K E T _N B R )
in ( se le ct s 2 1 . M A R K E T _N B R
fr om DS SA D M I N . L O O K U P _S T O R E s 2 1
wh er e s 21 . S T O R E _N B R i n ( 3 , 2 , 1 ) ) ) ) ) )
gr ou p b y a 1 1 . C L A S S_N B R ,
a1 2. CL AS S_ D E S C

Use Temporary Table as Set in the Fallback Table Type Setting

cr ea te ta b l e T P Z Z O P 0 0 a s

se le ct mi n ( c 1 1 . M A R K E T _N B R ) W J X B F S 1

fr om DS SA D M I N . L O O K U P _M A R K E T c 1 1

wh er e ( (c 1 1 . M A R K E T _N B R )

in ( se le ct s 2 1 . M A R K E T _N B R

fr om DS SA D M I N . L O O K U P _S T O R E s 2 1

wh er e s 21 . S T O R E _N B R i n ( 3 , 2 , 1 ) ) )

se le ct a1 1 . C L A S S _N B R C L A S S _N B R ,

a1 2. CL AS S_ D E S C C L A S S _D E S C ,

su m ( a1 1. TO T _S L S _Q T Y ) W J X B F S 1

fr om DS SA D M I N . M A R K E T _C L A S S a 1 1 ,

TP ZZ OP 00 p a 1 ,

DS SA DM IN .L O O K U P _C L A S S a 1 2

wh er e a 11 . M A R K E T _N B R = p a 1 . W J X B F S 1 a n d

145 2 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

a1 1. CL AS S_ N B R = a 1 2 . C L A S S _N B R

an d ( (a 11 . M A R K E T _N B R )

in ( se le ct s 2 1 . M A R K E T _N B R

fr om DS SA D M I N . L O O K U P _S T O R E s 2 1

wh er e s 21 . S T O R E _N B R i n ( 3 , 2 , 1 ) ) )

gr ou p b y a 1 1 . C L A S S_N B R ,

a1 2. CL AS S_ D E S C

Co mp u t e No n -Agg Bef o r e/ Af t er OLAP Fu n ct io n s (Fo r

Examp le, Ran k) Calcu lat ed in An alyt ical En gin e
C ompute N on-Agg Before/After OLAP Functi ons/R ank i s an advanced
property that i s hi dden by defaul t. For i nformati on on how to di spl ay
thi s property, see Vi ew i ng and C hangi ng Advanced VLD B Properti es,
page 1330.

When reports contai n cal cul ati ons based on non-aggregati on metri cs,
thi s property control s the order i n w hi ch the non-aggregati on and
cal cul ati ons are computed.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Exam p l es

C alculate N on-A ggregation B efore A nalytical (defaul t)

select a12.YEAR_ID YEAR_ID,

sum(a11.TOT_SLS_QTY) WJXBFS1
from HARI_REGION_DIVISION a11
join HARI_LOOKUP_DAY a12
on (a11.CUR_TRN_DT = a12.CUR_TRN_DT)
where a11.CUR_TRN_DT)
in (select min(a11.CUR_TRN_DT)
from HARI_LOOKUP_DAY a11

© 2019, M icr o St r at egy In c. 145 3

Syst em Ad m in ist r at io n Gu id e

group by a11.YEAR_ID))
group by a12.YEAR_ID
create table #ZZTIS00H5J7MQ000(
YEAR_ID DECIMAL(10, 0))
[Placeholder for an analytical SQL]
select a12.YEAR_ID YEAR_ID,
max(a13.YEAR_DESC) YEAR_DESC,
sum(a11.TOT_SLS_QTY) TSQDIMYEARNA
from HARI_REGION_DIVISION a11
join HARI_LOOKUP_DAY a12
on (a11.CUR_TRN_DT = a12.CUR_TRN_DT)
join #ZZTIS00H5J7MQ000 pa1
on (a12.YEAR_ID = pa1.YEAR_ID)
join HARI_LOOKUP_YEAR a13
on (a12.YEAR_ID = a13.YEAR_ID)
where ((a11.CUR_TRN_DT)
in (select min(a15.CUR_TRN_DT)
from #ZZTIS00H5J7MQ000 pa1
join HARI_LOOKUP_DAY a15
on (pa1.YEAR_ID = a15.YEAR_ID)
group by pa1.YEAR_ID))
group by a12.YEAR_ID

Calculate Non-Aggregation After Analytical

select a11.CUR_TRN_DT CUR_TRN_DT,

a12.YEAR_ID YEAR_ID,
sum(a11.TOT_SLS_QTY) WJXBFS1
from HARI_REGION_DIVISION a11
join HARI_LOOKUP_DAY a12
on (a11.CUR_TRN_DT = a12.CUR_TRN_DT)
group by a11.CUR_TRN_DT,
a12.YEAR_ID
create table #ZZTIS00H5J8NB000(
CUR_TRN_DT DATETIME,
YEAR_ID DECIMAL(10, 0),
WJXBFS1 FLOAT)
[Placeholder for an analytical SQL]
insert into #ZZTIS00H5J8NB000 values (CONVERT
(datetime, '1993-12-01 00:00:00', 120), 1993,
44)

[The rest of the IN SER T statements have been omi tted from di spl ay].

select distinct pa1.YEAR_ID YEAR_ID,

145 4 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

pa1.WJXBFS1 WJXBFS1
from #ZZTIS00H5J8NB000 pa1
where ((pa1.CUR_TRN_DT)
in (select min(c11.CUR_TRN_DT)
from HARI_LOOKUP_DAY c11
group by c11.YEAR_ID))
create table #ZZTIS00H5J8MQ001(
YEAR_ID DECIMAL(10, 0),
WJXBFS1 FLOAT)
[Placeholder for an analytical SQL]
select a12.YEAR_ID YEAR_ID,
max(a13.YEAR_DESC) YEAR_DESC,
sum(a11.TOT_SLS_QTY) TSQDIMYEARNA
from HARI_REGION_DIVISION a11
join HARI_LOOKUP_DAY a12
on (a11.CUR_TRN_DT = a12.CUR_TRN_DT)
join #ZZTIS00H5J8MQ001 pa2
on (a12.YEAR_ID = pa2.YEAR_ID)
join HARI_LOOKUP_YEAR a13
on (a12.YEAR_ID = a13.YEAR_ID)
where ((a11.CUR_TRN_DT)
in (select min(a15.CUR_TRN_DT)
from #ZZTIS00H5J8MQ001 pa2
join HARI_LOOKUP_DAY a15
on (pa2.YEAR_ID = a15.YEAR_ID)
group by pa2.YEAR_ID))
group by a12.YEAR_ID

Co u n t Co mp o u n d At t r ib u t e
C ount C ompound Attri bute i s an advanced property that i s hi dden by
defaul t. For i nformati on on how to di spl ay thi s property, see Vi ew i ng
and C hangi ng Advanced VLD B Properti es, page 1330.

C ompound attri butes are usual l y counted by concatenati ng the keys

of al l of the attri butes that form the key.

If y our databas e platform does not s upport COUNT on c onc atenated

s trings , the Count Compound Attribute property s hould be dis abled.

© 2019, M icr o St r at egy In c. 145 5

Syst em Ad m in ist r at io n Gu id e

Level s at Whi ch You Can Set Thi s

D atabase i nstance onl y

Exam p l es

C OU N T expression enabled (defaul t)

select a21.DIVISION_NBR DIVISION_NBR,

max(a22.DIVISION_DESC) DIVISION_DESC,
count(distinct char(a21.ITEM_NBR) || ||
char(a21.CLASS_NBR)) ITEM_COUNT
from LOOKUP_ITEM a21
join LOOKUP_DIVISION a22
on (a21.DIVISION_NBR = a22.DIVISION_NBR)
group by a21.DIVISION_NBR

COUNT expression disabled

create table TEMP1 as

select distinct a21.DIVISION_NBR DIVISION_NBR,
a21.ITEM_NBR ITEM_NBR,
a21.CLASS_NBR CLASS_NBR
from LOOKUP_ITEM a21
select a22.DIVISION_NBR DIVISION_NBR,
max(a22.DIVISION_DESC) DIVISION_DESC,
count(a21.ITEM_NBR) ITEM_COUNT
from TEMP1 a21
join LOOKUP_DIVISION a22
on (a21.DIVISION_NBR = a22.DIVISION_NBR)
group by a22.DIVISION_NBR

COUNT(co lu mn ) Su p p o r t
C OU N T(col umn) Support i s an advanced property that i s hi dden by
defaul t. For i nformati on on how to di spl ay thi s property, see Vi ew i ng
and C hangi ng Advanced VLD B Properti es, page 1330.

The C OU N T(col umn) Support property i s used to speci fy w hether

C OU N T on a col umn i s supported or not. If i t i s not supported, the
C OU N T(col umn) i s computed by usi ng i ntermedi ate tabl es and
C OU N T(*).

145 6 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Level s at Whi ch You Can Set Thi s

D atabase i nstance onl y

Exam p l es

Use COUNT(column)

select a11.STORE_NBR STORE_NBR,

max(a12.STORE_DESC) STORE_DESC,
count(distinct a11.COST_AMT) COUNTDISTINCT
from HARI_COST_STORE_DEP a11
join HARI_LOOKUP_STORE a12
on (a11.STORE_NBR = a12.STORE_NBR)
group by a11.STORE_NBR

Use COUNT(*)

select a11.STORE_NBR STORE_NBR,

a11.COST_AMT WJXBFS1
into #ZZTIS00H5JWDA000
from HARI_COST_STORE_DEP a11
select distinct pa1.STORE_NBR STORE_NBR,
pa1.WJXBFS1 WJXBFS1
into #ZZTIS00H5JWOT001
from #ZZTIS00H5JWDA000 pa1
where pa1.WJXBFS1 is not null
select pa2.STORE_NBR STORE_NBR,
max(a11.STORE_DESC) STORE_DESC,
count(*) WJXBFS1
from #ZZTIS00H5JWOT001 pa2
join HARI_LOOKUP_STORE a11
on (pa2.STORE_NBR = a11.STORE_NBR)
group by pa2.STORE_NBR

Def au lt t o Met r ic Name

D efaul t to Metri c N ame i s an advanced property that i s hi dden by
defaul t. For i nformati on on how to di spl ay thi s property, see Vi ew i ng
and C hangi ng Advanced VLD B Properti es, page 1330.

D efaul t to Metri c N ame al l ow s you to choose w hether you w ant to use

the metri c name or a Mi croStrategy-generated name as the col umn

© 2019, M icr o St r at egy In c. 145 7

Syst em Ad m in ist r at io n Gu id e

al i as. When metri c names are used, onl y the fi rst 20 standard
characters are used. If you have di fferent metri cs, the metri c names
start w i th the same 20 characters. It i s hard to di fferenti ate betw een
the tw o, because they are al w ays the same. The D efaul t to Metri c
N ame opti on does not w ork for some i nternati onal customers.

If y ou c hoos e to us e the metric name and the metric name begins with a
number, the letter M is attac hed to the beginning of the name during SQL
generation. For ex ample, a metric named 2003Rev enue is renamed
M2003Rev enue. This oc c urs bec aus e Teradata does not allow a leading
number in a metric name.

If you sel ect the opti on U se the metric name as the default metric
column alias, you shoul d al so set the maxi mum metri c al i as si ze.
See D efaul t to Metri c N ame, page 1457 bel ow for i nformati on on
setti ng thi s opti on.

Level s at Whi ch You Can Set Thi s

D atabase i nstance onl y

Exam p l es

D o not use the metric name as the default metric column alias
(defaul t)

insert into ZZTSU006VT7PO000

select a11.[MONTH_ID] AS MONTH_ID,
a11.[ITEM_ID] AS ITEM_ID,
a11.[EOH_QTY] AS WJXBFS1
from [INVENTORY_Q4_2003] a11,
[LU_MONTH] a12,
[LU_ITEM] a13
where a11.[MONTH_ID] = a12.[MONTH_ID] and
a11.[ITEM_ID] = a13.[ITEM_ID]
and (a13.[SUBCAT_ID] in (25)
and a12.[QUARTER_ID] in (20034))

Use the metric name as the default metric column alias

145 8 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

insert into ZZPO00

select a11.[MONTH_ID] AS MONTH_ID,
a11.[ITEM_ID] AS ITEM_ID,
a11.[EOH_QTY] AS Endonhand
from [{|Partition_Base_Table|}] a11,
[LU_MONTH] a12,
[LU_ITEM] a13
where a11.[MONTH_ID] = a12.[MONTH_ID] and
a11.[ITEM_ID] = a13.[ITEM_ID]
and (a13.[SUBCAT_ID] in (25)
and a12.[QUARTER_ID] in (20034))

In t eger Co n st an t in Met r ic
The Integer C onstant i n Metri c property determi nes w hether or not to
add a ".0" after the i nteger. Thi s prevents i ncorrect i nteger di vi si on,
for exampl e, 2/7 = 0. N ormal l y a ".0" i s added to an i nteger constant
to have a fl oat di vi si on (2.0/7.0 = 0.286). Some databases have
troubl e w i th thi s change, because some database functi ons onl y w ork
w i th i nteger data types. Thi s property al l ow s you to turn OFF the
addi ti on of the ".0" i f you have a database that does not properl y
handl e the .0 added after the i nteger.

Level s at Whi ch You Can Set Thi s

D atabase i nstance and metri c

Jo in Acr o ss Dat aset s

Joi n Across D atasets i s an advanced VLD B property that i s hi dden by
defaul t. For i nformati on on how to di spl ay thi s property, see Vi ew i ng
and C hangi ng Advanced VLD B Properti es, page 1330.

The Joi n Across D atasets VLD B property determi nes how val ues for
metri cs are cal cul ated w hen unrel ated attri butes from di fferent
datasets of a dossi er or document are i ncl uded w i th metri cs. For
exampl e, consi der a dossi er w i th tw o separate datasets that i ncl ude
the fol l ow i ng data:

© 2019, M icr o St r at egy In c. 145 9

Syst em Ad m in ist r at io n Gu id e

The datas ets are dis play ed below as s imple grid v is ualiz ations within a
dos s ier.

N oti ce that one dataset i ncl udes the R egi on attri bute, how ever the
other dataset onl y i ncl udes C ategory. The R egi on attri bute i s al so not
di rectl y rel ated to the C ategory attri bute, but i t i s i ncl uded w i th
C ategory i n one of the tw o datasets.

On thi s dossi er, you choose to create a new gri d vi sual i zati on w i th
R egi on and Sal es. These obj ects are not on the same dataset, so thi s
requi res combi ni ng the data from di fferent datasets. By defaul t, data
i s not j oi ned for the unrel ated attri butes C ategory and R egi on, and the
fol l ow i ng data i s di spl ayed:

The data for Sal es i s di spl ayed as $260 for both R egi ons, w hi ch i s
the total sal es of al l regi ons. In most scenari os, thi s sal es data shoul d
i nstead refl ect the data for each regi on. Thi s can be achi eved by
al l ow i ng data to be j oi ned for the unrel ated attri butes C ategory and
R egi on, w hi ch then di spl ays the fol l ow i ng data:

N ow the data for Sal es di spl ays $185 for N orth (a combi nati on of the
sal es for Books and El ectroni cs, w hi ch w ere both for the N orth regi on)
and $85 for South (sal es for Movi es, w hi ch w as for the South regi on).

l D isallow joins based on unrelated common attributes: By

defaul t, data i s not j oi ned for unrel ated attri butes that are i ncl uded
on the same dataset. Thi s opti on i s to support backw ard

1460 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

compati bi l i ty.

l A llow joins based on unrelated common attributes: D ata i s

j oi ned for unrel ated attri butes that are i ncl uded on the same
dataset. Thi s can al l ow metri c data to consi der unrel ated attri butes
on the same dataset to l ogi cal l y combi ne the data, and thus
provi des resul ts that are more accurate and i ntui ti ve i n most cases.

Level s at Whi ch You Can Set Thi s

Proj ect and dossi er. To defi ne thi s behavi or for a dossi er open i n
Vi sual Insi ght, from the File menu, sel ect D ocument Properties. You
can then sel ect to al l ow j oi ns across datasets.

Max Met r ic Alias Size

Max Metri c Al i as Si ze i s an advanced property that i s hi dden by
defaul t. For i nformati on on how to di spl ay thi s property, see Vi ew i ng
and C hangi ng Advanced VLD B Properti es, page 1330.

Max Metri c Al i as Si ze al l ow s you to set the maxi mum si ze of the

metri c al i as stri ng. Thi s i s useful for databases that onl y accept a
l i mi ted number of characters for col umn names.

You shoul d set the maxi mum metri c al i as si ze to few er characters

than your database's l i mi t. Thi s i s because, i n certai n i nstances, such
as w hen tw o col umn names are i denti cal , the SQL engi ne adds one or
more characters to one of the col umn names duri ng processi ng to be
abl e to di fferenti ate betw een the names. Identi cal col umn names can
devel op w hen col umn names are truncated.

For exampl e, i f your database rej ects any col umn name that i s more
than 30 characters and you set thi s VLD B property to l i mi t the
maxi mum metri c al i as si ze to 30 characters, the exampl e presented
by the fol l ow i ng metri c names sti l l causes your database to rej ect the
names duri ng SQL processi ng:

© 2019, M icr o St r at egy In c. 1461

Syst em Ad m in ist r at io n Gu id e

l Sal es Metri c i n Fai rfax C ounty for 2002

l Sal es Metri c i n Fai rfax C ounty for 2003

The system l i mi ts the names to 30 characters based on the VLD B

opti on you set i n thi s exampl e, w hi ch means that the metri c al i ases
for both col umns i s as fol l ow s:

l SALESMETR IC IN FAIR FAXC OU N TYFOR 2 (30 characters)

l SALESMETR IC IN FAIR FAXC OU N TYFOR 21 (31 characters)

The SQL engi ne adds a 1 to one of the names because the truncated
versi ons of both metri c names are i denti cal . That name i s then 31
characters l ong and so the database rej ects i t.

Therefore, i n thi s exampl e you shoul d use thi s feature to set the
maxi mum metri c al i as si ze to few er than 30 (perhaps 25), to al l ow
room for the SQL engi ne to add one or tw o characters duri ng
processi ng i n case the fi rst 25 characters of any of your metri c names
are the same.

Level s at Whi ch You Can Set Thi s

D atabase i nstance onl y

Met r ic Jo in Typ e
Metri c Joi n Type i s used to determi ne how to combi ne the resul t of
one metri c w i th that of other metri cs. When thi s property i s set to
Outer Joi n, al l the resul t row s of thi s metri c are kept w hen combi ni ng
resul ts w i th other metri cs. If there i s onl y one metri c on the report, thi s
property i s i gnored.

There are mul ti pl e pl aces to set thi s property:

1462 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l At the D B MS and database instance l evel s, i t i s set i n the VLD B

Properti es Edi tor. Thi s setti ng affects al l the metri cs i n thi s proj ect,
unl ess i t i s overri dden at a l ow er l evel .

l At the metric l evel , i t can be set i n ei ther the VLD B Properti es

Edi tor or from the Metri c Edi tor's Tools menu, and choosi ng Metric
Join Type. The setti ng i s appl i ed i n al l the reports that i ncl ude thi s
metri c.

l At the report l evel , i t can be set from the R eport Edi tor's D ata
menu, by poi nti ng to R eport D ata Options, and choosi ng Metric
Join Type. Thi s setti ng overri des the setti ng at the metri c l evel and
i s appl i ed onl y for the currentl y sel ected report.

There i s a rel ated but separate property cal l ed Formul a Joi n Type that
can al so be set at the metri c l evel . Thi s property i s used to determi ne
how to combi ne the resul t set together w i thi n thi s metri c. Thi s
normal l y happens w hen a metri c formul a contai ns mul ti pl e facts that
cause the Anal yti cal Engi ne to use mul ti pl e fact tabl es. As a resul t,
someti mes i t needs to cal cul ate di fferent components of one metri c i n
di fferent i ntermedi ate tabl es and then combi ne them. Thi s property
can onl y be set i n the Metri c Edi tor from the Tools menu, by poi nti ng
to A dvanced Settings, and then choosi ng Formula Join Type.

Both Metri c Joi n Type and Formul a Joi n Type are used i n the
Anal yti cal Engi ne to j oi n mul ti pl e i ntermedi ate tabl es i n the fi nal
pass. The actual l ogi c i s al so affected by another VLD B property, Ful l
Outer Joi n Support. When thi s property i s set to YES, i t means the
correspondi ng database supports ful l outer j oi n (92 syntax). In thi s
case, the j oi ni ng of mul ti pl e i ntermedi ate tabl es makes use of outer
j oi n syntax di rectl y (l eft outer j oi n, ri ght outer j oi n, or ful l outer j oi n,
dependi ng on the setti ng on each metri c/tabl e). H ow ever, i f the Ful l
Outer Joi n Support i s N O, then the l eft outer j oi n i s used to si mul ate a
ful l outer j oi n. Thi s can be done w i th a uni on of the ID s of the mul ti pl e
i ntermedi ate tabl es that need to do an outer j oi n and then usi ng the
uni on tabl e to l eft outer j oi n to al l i ntermedi ate tabl es, so thi s

© 2019, M icr o St r at egy In c. 1463

Syst em Ad m in ist r at io n Gu id e

approach generates more passes. Thi s approach w as al so used by

Mi croStrategy 6.x and earl i er.

Al so note that w hen the metri c l evel i s hi gher than the templ ate l evel ,
the Metri c Joi n Type property i s normal l y i gnored, unl ess you enabl e
another property, D ow nw ard Outer Joi n Opti on. For detai l ed
i nformati on, see R el ati ng C ol umn D ata w i th SQL: Joi ns, page 1387.

Level s at Whi ch You Can Set Thi s

D atabase i nstance and metri c

No n -Agg Met r ic Op t imizat io n

N on-Agg Metri c Opti mi zati on i s an advanced property that i s hi dden
by defaul t. For i nformati on on how to di spl ay thi s property, see
Vi ew i ng and C hangi ng Advanced VLD B Properti es, page 1330.

N on-Agg Metri c Opti mi zati on i nfl uences the behavi or of non-

aggregati on metri cs by ei ther opti mi zi ng for smal l er temporary tabl es
or for l ess fact tabl e access. Thi s property can hel p i mprove query
performance dependi ng on the fact tabl e si ze and the potenti al
temporary tabl e si ze. It may be more effecti ve to create a l arger
temporary tabl e so that you can avoi d usi ng the even l arger fact tabl e.
If you are short on temporary tabl e space or i nsert much data from the
fact tabl e i nto the temporary tabl e, i t may be better to use the fact
tabl e mul ti pl e ti mes rather than create temporary tabl es. Your choi ce
for thi s property depends on your data and report defi ni ti ons.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Exam p l es

Optimized for less fact table access (defaul t)

1464 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

The fol l ow i ng exampl e fi rst creates a fai rl y l arge temporary tabl e, but
then never touches the fact tabl e agai n.

select a11.REGION_NBR REGION_NBR,

a11.REGION_NBR REGION_NBR0,
a12.MONTH_ID MONTH_ID,
a11.DIVISION_NBR DIVISION_NBR,
a11.CUR_TRN_DT CUR_TRN_DT,
a11.TOT_SLS_DLR WJXBFS1
into ZZNB00
from REGION_DIVISION a11
join LOOKUP_DAY a12
on (a11.CUR_TRN_DT = a12.CUR_TRN_DT)
select pa1.REGION_NBR REGION_NBR,
pa1.MONTH_ID MONTH_ID,
min(pa1.CUR_TRN_DT) WJXBFS1
into ZZMB01
from ZZNB00 pa1
group by pa1.REGION_NBR,
pa1.MONTH_ID
select pa1.REGION_NBR REGION_NBR,
pa1.MONTH_ID MONTH_ID,
count(pa1.WJXBFS1) WJXBFS1
into ZZNC02
from ZZNB00 pa1
join ZZMB01 pa2
on (pa1.CUR_TRN_DT = pa2.WJXBFS1 and
pa1.MONTH_ID = pa2.MONTH_ID and
pa1.REGION_NBR = pa2.REGION_NBR)
group by pa1.REGION_NBR,
pa1.MONTH_ID
select distinct pa3.REGION_NBR REGION_NBR,
a13.REGION_DESC REGION_DESC,
a12.CUR_TRN_DT CUR_TRN_DT,
pa3.WJXBFS1 COUNTOFSALES
from ZZNC02 pa3
join LOOKUP_DAY a12
on (pa3.MONTH_ID = a12.MONTH_ID)
join LOOKUP_REGION a13
on (pa3.REGION_NBR = a13.REGION_NBR)

Optimized for smaller temp table

© 2019, M icr o St r at egy In c. 1465

Syst em Ad m in ist r at io n Gu id e

The fol l ow i ng exampl e does not create the l arge temporary tabl e but
must query the fact tabl e tw i ce.

select a11.REGION_NBR REGION_NBR,

a12.MONTH_ID MONTH_ID,
min(a11.CUR_TRN_DT) WJXBFS1
into ZZOP00
from REGION_DIVISION a11
join LOOKUP_DAY a12
on (a11.CUR_TRN_DT = a12.CUR_TRN_DT)
group by a11.REGION_NBR,
a12.MONTH_ID
select a11.REGION_NBR REGION_NBR,
a12.MONTH_ID MONTH_ID,
count(a11.TOT_SLS_DLR) COUNTOFSALES
into ZZMD01
from REGION_DIVISION a11
join LOOKUP_DAY a12
on (a11.CUR_TRN_DT = a12.CUR_TRN_DT)
join ZZOP00 pa1
on (a11.CUR_TRN_DT = pa1.WJXBFS1 and
a11.REGION_NBR = pa1.REGION_NBR and
a12.MONTH_ID = pa1.MONTH_ID)
group by a11.REGION_NBR,
a12.MONTH_ID
select distinct pa2.REGION_NBR REGION_NBR,
a13.REGION_DESC REGION_DESC,
a12.CUR_TRN_DT CUR_TRN_DT,
pa2.COUNTOFSALES COUNTOFSALES
from ZZMD01 pa2
join LOOKUP_DAY a12
on (pa2.MONTH_ID = a12.MONTH_ID)
join LOOKUP_REGION a13
on (pa2.REGION_NBR = a13.REGION_NBR)

Nu ll Ch eck
The N ul l C heck VLD B property i ndi cates how to handl e ari thmeti c
operati ons w i th N U LL val ues. If N ul l C heck i s enabl ed, the
N U LL2ZER O functi on i s added, w hi ch changes N U LL to 0 i n any
ari thmeti c cal cul ati on (+,-,*,/).

1466 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Sep ar at e COUNT DISTINCT

Separate C ount D i sti nct i s an advanced property that i s hi dden by
defaul t. For i nformati on on how to di spl ay thi s property, see Vi ew i ng
and C hangi ng Advanced VLD B Properti es, page 1330.

Separate C ount D i sti nct i ndi cates how to handl e C OU N T (and other
aggregati on functi ons) w hen D ISTIN C T i s present i n the SQL.

Level s at Whi ch You Can Set Thi s

D atabase i nstance

Smar t Met r ic Tr an sf o r mat io n

Smart Metri c Transformati on i s an advanced property that i s hi dden
by defaul t. For i nformati on on how to di spl ay thi s property, see
Vi ew i ng and C hangi ng Advanced VLD B Properti es, page 1330.

D ue to the eval uati on order used for smart metri cs, compound metri cs,
and transformati ons, creati ng transformati on metri cs to di spl ay the
vari ance or vari ance percentage of a smart metri c or compound metri c
can return unexpected resul ts i n some scenari os.

For definitions and ex amples of s mart metric s , c ompound metric s , and

trans formation metric s , s ee the Advanced R eporti ng Gui de .

For exampl e, the report sampl e show n bel ow i ncl udes quarterl y profi t
margi ns. Transformati on metri cs are i ncl uded to di spl ay the l ast
quarter's profi t margi n (L a s t Q u a r t e r ' s ( P r o f i t M a r g i n) and
the vari ance of the profi t margi n and l ast quarter's profi t margi n
((Pr of it M a r g i n - ( L a s t Q u a r t e r ' s ( P r o f i t M a r g i n ))).

© 2019, M icr o St r at egy In c. 1467

Syst em Ad m in ist r at io n Gu id e

Si nce Profi t Margi n i s a smart metri c, the transformati on metri c that

cal cul ates the vari ance di spl ays unexpected resul ts. For exampl e,
consi der the report row hi ghl i ghted i n the report exampl e above. The
profi t margi n for 2011 Q3 i s 15.07% and the profi t margi n for 2011 Q2
i s 14.98%. Both of these cal cul ati ons are correct. H ow ever, an
i ncorrect val ue of 15.68% i s di spl ayed as the vari ance.

You can modi fy the eval uati on order to return correct vari ance resul ts
by defi ni ng the Smart Metri c Transformati on VLD B property as True.
After maki ng thi s change, the report di spl ays the fol l ow i ng resul ts.

The vari ance i s now di spl ayed as 0.09%, w hi ch i s the correct

vari ance cal cul ati on (1 5 . 0 7 % - 1 4 . 9 8 % = 0 . 0 9 %).

1468 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

The Smart Metri c Transformati on VLD B property has the fol l ow i ng

opti ons:

l False (defaul t): Sel ect thi s opti on for backw ards compati bi l i ty w i th
exi sti ng transformati on metri cs based on smart metri cs or compound
metri cs.

l True: Sel ect thi s opti on to modi fy the eval uati on order to support
transformati on metri cs that cal cul ate a vari ance or vari ance
percentage, based on the resul ts of a smart metri c or compound
metri c. Be aw are that to appl y thi s functi onal i ty to deri ved metri cs
you must sel ect thi s opti on at the proj ect l evel .

Level s at Whi ch You Can Set Thi s

Proj ect and metri c

Su b t o t al Dimen sio n alit y Use

Subtotal D i mensi onal i ty U se i s an advanced property that i s hi dden
by defaul t. For i nformati on on how to di spl ay thi s property, see
Vi ew i ng and C hangi ng Advanced VLD B Properti es, page 1330.

Subtotal D i mensi onal i ty U se determi nes how the l evel of cal cul ati on
i s defi ned for metri cs that are i ncl uded on reports that use dynami c
aggregati on, w hi ch i s an OLAP Servi ces feature. Thi s VLD B property
has the fol l ow i ng opti ons:

l U se only the grouping property of a level metric for dynamic

aggregation (defaul t): The di mensi onal i ty, or l evel , of the metri c i s
used to defi ne how the metri c data i s cal cul ated on the report w hen
dynami c aggregati on i s al so used. When sel ecti ng thi s opti on, onl y
the groupi ng opti on for a l evel metri c i s used to cal cul ate metri c
data. For detai l ed exampl es and i nformati on on defi ni ng the
di mensi onal i ty of a metri c, refer to the documentati on on l evel

© 2019, M icr o St r at egy In c. 1469

Syst em Ad m in ist r at io n Gu id e

metri cs provi ded i n the Advanced R eporti ng Gui de.

l U se only the grouping property of a level subtotal for dynamic

aggregation: The di mensi onal i ty, or l evel , of the metri c's dynami c
aggregati on functi on i s used to defi ne how the metri c data i s
cal cul ated on the report w hen dynami c aggregati on i s al so used.
You can defi ne the l evel of cal cul ati on for a metri c's dynami c
aggregati on functi on by creati ng a subtotal , and then defi ni ng the
l evel of cal cul ati on for that subtotal . When sel ecti ng thi s opti on,
onl y the groupi ng opti on for a subtotal i s used to cal cul ate metri c
data. For detai l ed exampl es and i nformati on on creati ng subtotal s,
refer to the Advanced R eporti ng Gui de.

l U se both the grouping and filtering property of a level metric for

dynamic aggregation: The di mensi onal i ty, or l evel , of the metri c i s
used to defi ne how the metri c data i s cal cul ated on the report w hen
dynami c aggregati on i s al so used. When sel ecti ng thi s opti on, both
the groupi ng and fi l teri ng opti ons for a l evel metri c are used to
cal cul ate metri c data. For detai l ed exampl es and i nformati on on
defi ni ng the di mensi onal i ty of a metri c, refer to the documentati on
on l evel metri cs provi ded i n the Advanced R eporti ng Gui de.

l U se both the grouping and filtering property of a level subtotal

for dynamic aggregation: The di mensi onal i ty, or l evel , of the
metri c's dynami c aggregati on functi on i s used to defi ne how the
metri c data i s cal cul ated on the report w hen dynami c aggregati on i s
al so used. You can defi ne the l evel of cal cul ati on for a metri c's
dynami c aggregati on functi on by creati ng a subtotal , and then
defi ni ng the l evel of cal cul ati on for that subtotal . When sel ecti ng
thi s opti on, both the groupi ng and fi l teri ng opti ons for a subtotal are
used to cal cul ate metri c data. For detai l ed exampl es and
i nformati on on creati ng subtotal s, refer to the Advanced R eporti ng
Gui de.

1470 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Exam p l e

C onsi der a metri c that performs a si mpl e sum of cost data by usi ng
the fol l ow i ng metri c defi ni ti on:

Sum(Cost) {~+}

Thi s metri c i s named C ost, and the syntax { ~ + } i ndi cates that i t
cal cul ates data at the l evel of the report i t i s i ncl uded on. Another
metri c i s created w i th the fol l ow i ng metri c defi ni ti on:

Sum(Cost) {~+}

Thi s metri c al so uses a subtotal for i ts dynami c aggregati on functi on

that uses the fol l ow i ng defi ni ti on:

Sum(x) {~+, !Year , !Category }

N oti ce that the functi on for thi s subtotal i ncl udes addi ti onal l evel
i nformati on to perform the cal cul ati on based on the report l evel , Year,
and C ategory. As show n i n the i mage bel ow , thi s subtotal functi on,
named Sum(Year,C ategory) i s appl i ed as the metri c's dynami c
aggregati on functi on.

© 2019, M icr o St r at egy In c. 1471

Syst em Ad m in ist r at io n Gu id e

Thi s metri c i s named C ost (subtotal di mensi onal i ty). Thi s metri c al ong
w i th the si mpl e C ost metri c i s di spl ayed on the report show n bel ow ,
w hi ch al so contai ns the attri butes Year, R egi on, and C ategory.

1472 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

N oti ce that the val ues for these tw o metri cs are the same. Thi s i s
because no dynami c aggregati on i s bei ng performed, and the Subtotal
D i mensi onal i ty U se VLD B property i s al so usi ng the defaul t opti on of
U se di mensi onal i ty from metri c for dynami c aggregati on. Wi th thi s
defaul t behavi or sti l l appl i ed, the attri bute Year can be removed from
the gri d of the report to tri gger dynami c aggregati on, as show n i n the
report bel ow .

The metri c val ues are sti l l the same because both metri cs are usi ng
the l evel of the metri c. If the Subtotal D i mensi onal i ty U se VLD B
property for the report i s modi fi ed to use the opti on U se

© 2019, M icr o St r at egy In c. 1473

Syst em Ad m in ist r at io n Gu id e

di mensi onal i ty from subtotal for dynami c aggregati on, thi s affects the
report resul ts as show n i n the report bel ow .

The C ost (subtotal di mensi onal i ty) metri c now appl i es the l evel
defi ned i n the subtotal functi on that i s used as the metri c's dynami c
aggregati on functi on. Thi s di spl ays the same C ost val ue for al l
categori es i n the N ortheast regi on because the data i s bei ng returned
as the total for al l years and categori es combi ned.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, templ ate, and metri c

Tr an sf o r mab le AggMet r ic
The Transformabl e AggMetri c VLD B property al l ow s you to defi ne
w hat metri cs shoul d be used to perform transformati ons on compound
metri cs that use nested aggregati on.

For exampl e, you create tw o metri cs. The fi rst metri c, referred to as
Metri c1, uses an expressi on of S u m( F a c t ) { ~ + , A t t r i b u t e + },
w here F ac t i s a fact i n your proj ect and A t t r i b u t e i s an attri bute i n
your proj ect used to defi ne the l evel of Metri c1. The second metri c,
referred to as Metri c2, uses an expressi on of A v g( M e t r i c 1 ){ ~ + }.
Si nce both metri cs use aggregati on functi ons, Metri c2 uses nested
aggregati on.

Incl udi ng Metri c2 on a report can return i ncorrect resul ts for the
fol l ow i ng scenari o:

1474 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l A transformati on shortcut metri c i s defi ned on Metri c2.

l Metri c1 i s defi ned at a l ow er l evel than the report l evel .

In thi s scenari o, the transformati on i s appl i ed to the outer metri c,

w hi ch i n thi s case i s Metri c2. To perform the transformati on correctl y,
the transformati on shoul d be appl i ed for the i nner metri c, w hi ch i n thi s
case i s Metri c1. To appl y the transformati on to Metri c1 i n thi s
scenari o, you can use the Transformabl e AggMetri c VLD B property.
The opti ons are:

l False (defaul t): The metri c uses defaul t transformati on behavi or.
Thi s opti on shoul d be used for al l metri cs except for those metri cs
that are defi ned for a scenari o si mi l ar to Metri c2 descri bed above.

l True: The metri c i s defi ned as a metri c to use to perform a

transformati on w hen i t i s i ncl uded i n another metri c through nested
aggregati on. Thi s opti on shoul d be used onl y for metri cs that are
defi ned for a scenari o si mi l ar to Metri c2 descri bed above.

Level s at Whi ch You Can Set Tt hi s

Metri c onl y

Tr an sf o r mat io n Ro le Pr o cessin g
The Transformati on R ol e Processi ng property i s onl y avai l abl e from
the Transformati on Edi tor. From the Transformati on Edi tor, sel ect
Schema Objects and then choose Transformations. R i ght-cl i ck an
obj ect from the ri ght pane and sel ect Edit.

The Transformati on R ol e Processi ng property l ets you choose how

transformati on dates are cal cul ated w hen there are mul ti pl e attri butes
to transform. The exampl e bel ow consi ders the common D ay, Week,
and Month schema setup. The schema has Week and Month as a
parent to D ay. Week and Month are unrel ated. Thi s Month, Week, and

© 2019, M icr o St r at egy In c. 1475

Syst em Ad m in ist r at io n Gu id e

D ay hi erarchy setup i s a common scenari o w here thi s property makes

a di fference.

Exam p l e

You have a report w i th Week, Sal es, and Last Year Sal es on the
templ ate, fi l tered by Month. The defaul t behavi or i s to cal cul ate the
Last Year Sal es w i th the fol l ow i ng SQL. N oti ce that the date
transformati on i s done for Month and Week.

insert into ZZT6T02D01

select a14.DAT_YYYYWW DAT_YYYYWW,
sum(a11.SALES) SALESLY
from FT1 a11
join TRANS_DAY a12
on (a11.DAT_YYYYMMDD = a12.DAT_YYYYMMDD)
join TRANS_DAY_MON a13
on (a12.DAT_YYYYYYMM = a13.DAT_LYM)
join TRANS_DAY_WEEK a14
on (a12.DAT_YYYYWW = a14.DAT_LYW)
where a13.DAT_YYYYMM in (200311)
group by a14.DAT_YYYYWW

The new behavi or appl i es transformati on onl y to the hi ghest common

chi l d w hen i t i s appl i cabl e to mul ti pl e attri butes. The SQL i s show n i n
the fol l ow i ng syntax. N oti ce that the date transformati on i s done onl y
at the D ay l evel , because D ay i s the hi ghest common chi l d of Week
and Month. So the days are transformed, and then you fi l ter for the
correct Month, and then Group by Week.

insert into ZZT6T02D01

select a12.DAT_YYYYWW DAT_YYYYWW,
sum(a11.SALES) SALESLY
from FT1 a11
join TRANS_DAY a12
on (a11.DAT_YYYYMMDD = a12.DAT_YYYYMMLYT)
where a12.DAT_YYYYMM in (200311)
group by a12.DAT_YYYYWW

1476 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Zer o Ch eck
The Zero C heck VLD B property i ndi cates how to handl e di vi si on by
zero. If zero checki ng i s enabl ed, the ZER O2N U LL functi on i s added,
w hi ch changes 0 to N U LL i n the denomi nator of any di vi si on
cal cul ati on.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Customizing SQL Statements: Pre/Post Statements

The tabl e bel ow summari zes the Pre/Post Statements VLD B
properti es. Addi ti onal detai l s about each property, i ncl udi ng
exampl es and a l i st of w i l d cards, are avai l abl e by cl i cki ng on the
l i nks i n the tabl e.

Po ssib le Defau lt
Pro p erty Descrip tio n
Valu es Valu e

C leanup
A ppends st ring af t er f inal drop
Pos t User-def ined NULL
st at ement .
Statement

D ata Mart
SQL to be S QL st at ement s included af t er
Ex ecuted t he CRE A TE st at ement used t o User-def ined NULL
After D ata creat e t he dat a mart .
Mart C reation

D ata Mart
SQL to be
S QL st at ement s included bef ore
Ex ecuted
t he I NS E RT st at ement used t o User-def ined NULL
Before
insert dat a int o t he dat a mart .
Inserting
D ata

© 2019, M icr o St r at egy In c. 1477

Syst em Ad m in ist r at io n Gu id e

Po ssib le Defau lt
Pro p erty Descrip tio n
Valu es Valu e

D ata Mart
SQL to be S QL st at ement s included bef ore
Ex ecuted t he CRE A TE st at ement used t o User-def ined NULL
Prior to D ata creat e t he dat a mart .
Mart C reation

• Drop dat abase

connect ion
af t er running Drop
user-def ined dat abase
Def ines whet her t he dat abase S QL
D rop connect ion
connect ion is dropped af t er user-
D atabase • Do not drop af t er
def ined S QL is execut ed on t he
C onnec tion dat abase running
dat abase.
connect ion user-def ined
af t er running S QL
user-def ined
S QL

Element
Brow s ing S QL st at ement s issued af t er
User-def ined NULL
Pos t element browsing request s.
Statement

Element
S QL st at ement s issued bef ore
Brow s ing Pre User-def ined NULL
element browsing request s.
Statement

S QL st at ement s issued bet ween

mult iple insert st at ement s. For
Insert Mid t he f irst f our st at ement s, each
Statement 1- cont ains single S QL. The last User-def ined NULL
5 st at ement can cont ain mult iple
S QL st at ement s concat enat ed by
";".

Insert Post
S QL st at ement s issued af t er User-def ined NULL
Statement 1-

1478 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Po ssib le Defau lt
Pro p erty Descrip tio n
Valu es Valu e

creat e, af t er f irst insert only f or

explicit t emp t able creat ion. For
t he f irst f our st at ement s, each
5 cont ains single S QL. The last
st at ement can cont ain mult iple
S QL st at ement s concat enat ed by
";".

S QL st at ement s issued af t er
creat e bef ore f irst insert only f or
explicit t emp t able creat ion. For
Insert Pre
t he f irst f our st at ement s, each
Statement 1- User-def ined NULL
cont ains single S QL. The last
5
st at ement can cont ain mult iple
S QL st at ement s concat enat ed by
";".

S QL st at ement s issued af t er
report request s. For t he f irst f our
R eport Post
st at ement s, each cont ains single
Statement 1- User-def ined NULL
S QL. The last st at ement can
5
cont ain mult iple S QL st at ement s
concat enat ed by " ; " .

S QL st at ement s issued bef ore

report request s. For t he f irst f our
R eport Pre
st at ement s, each cont ains single
Statement 1- User-def ined NULL
S QL. The last st at ement can
5
cont ain mult iple S QL st at ement s
concat enat ed by " ; " .

S QL st at ement s issued af t er
creat ing new t able and insert .
Table Post
For t he f irst f our st at ement s,
Statement 1- User-def ined NULL
each cont ains single S QL. The
5
last st at ement can cont ain
mult iple S QL st at ement s

© 2019, M icr o St r at egy In c. 1479

Syst em Ad m in ist r at io n Gu id e

Po ssib le Defau lt
Pro p erty Descrip tio n
Valu es Valu e

concat enat ed by " ; " .

S QL st at ement s issued bef ore

creat ing new t able. For t he f irst
Table Pre
f our st at ement s, each cont ains
Statement 1- User-def ined NULL
single S QL. The last st at ement
5
can cont ain mult iple S QL
st at ement s concat enat ed by " ; " .

You can i nsert the fol l ow i ng syntax i nto stri ngs to popul ate dynami c
i nformati on by the SQL Engi ne:

l !!! i nserts col umn names, separated by commas (can be used i n

Tabl e Pre/Post and Insert Pre/Mi d statements).

l !! i nserts an excl amati on (!) (can be used i n Tabl e Pre/Post and

Insert Pre/Mi d statements). N ote that "!!=" i nserts a not equal to si gn
i n the SQL statement.

l ??? i nserts the tabl e name (can be used i n D ata Mart

Insert/Pre/Post statements, Insert Pre/Post, and Tabl e Post
statements).

l ;; i nserts a semi col on (;) i n Statement5 (can be used i n al l Pre/Post

statements). N ote that a si ngl e ";" (semi col on) acts as a separator.

l !a i nserts col umn names for attri butes onl y (can be used i n Tabl e
Pre/Post and Insert Pre/Mi d statements).

l !d i nserts the date (can be used i n al l Pre/Post statements).

l !f i nserts the report path (can be used i n al l Pre/Post statements

except El ement Brow si ng). An exampl e i s: \ M i c r o S t r a t e g y
Tu to ri al \ P u b l i c O b j e c t s \ R e p o r t s \ M i c r o S t r a t e g y

1480 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Pl at fo rm C a p a b i l it i e s \ A d h o c
Re po rt in g \ S o r t i n g \ Y e a r l y S a l e s

l !i i nserts the j ob pri ori ty of the report w hi ch i s represented as an

i nteger from 0 to 999 (can be used i n al l Pre/Post statements).

l !o i nserts the report name (can be used i n al l Pre/Post statements).

l !u i nserts the user name (can be used i n al l Pre/Post statements).

l !j i nserts the Intel l i gence Server Job ID associ ated w i th the report
executi on (can be used i n al l Pre/Post statements).

l !r i nserts the report GU ID , the uni que i denti fi er for the report obj ect
that i s al so avai l abl e i n the Enterpri se Manager appl i cati on (can be
used i n al l Pre/Post statements).

l !t i nserts a ti mestamp (can be used i n al l Pre/Post statements).

l !p i nserts the proj ect name w i th spaces omi tted (can be used i n al l
Pre/Post statements).

l !z i nserts the proj ect GU ID , the uni que i denti fi er for the proj ect (can
be used i n al l Pre/Post statements).

l !s i nserts the user sessi on GU ID , the uni que i denti fi er for the user's
sessi on that i s al so avai l abl e i n the Enterpri se Manager appl i cati on
(can be used i n al l Pre/Post statements).

l The # character i s a speci al token that i s used i n vari ous patterns

and i s treated di fferentl y than other characters. One si ngl e # i s
absorbed and tw o # are reduced to a si ngl e #. For exampl e to show
three # characters i n a statement, enter si x # characters i n the code.
You can get any desi red stri ng w i th the ri ght number of #
characters. U si ng the # character i s the same as usi ng the ;
character.

The tabl e bel ow show s the l ocati on of some of the most i mportant
VLD B/D SS setti ngs i n a Structured Query Language (SQL) query

© 2019, M icr o St r at egy In c. 1481

Syst em Ad m in ist r at io n Gu id e

structure. If the properti es i n the tabl e are set, the val ues repl ace the
correspondi ng tag i n the query:

T ag VL DB p ro p erties (MST R 7.x)

< 1> Report P reS t at ement (1-5)

< 2> Table P reS t at ement (1-5)

< 3> Table Qualif ier

< 4> Table Descript or

< 5> Table P ref ix

< 6> Table Opt ion

< 7> Table S pace

< 8> Creat e P ost S t ring

< 9> P re DDL COMMI T

< 10> I nsert P reS t at ement (1-5)

< 11> I nsert Table Opt ion

< 12> S QL Hint

< 13> P ost DDL COMMI T

< 14> I nsert P ost S t ring

< 15> I nsert MidS t at ement (1-5)

< 16> Table P ost S t at ement (1-5)

< 17> I ndex Qualif ier

< 18> I ndex P ost S t ring

< 19> S elect P ost S t ring

< 20> Report P ost S t at ement (1-5)

< 21> Commit af t er Final Drop

< 22> Cleanup P ost S t at ement

1482 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Query Structure
<1>
<2>
CREATE <3> TABLE <4> <5><table name> <6>
(<fields' definition>)
<7>
<8>
<9>(COMMIT)
<10>
INSERT INTO <5><table name><11>
SELECT <12> <fields list>
FROM <tables list>
WHERE <joins and filter>
<13>(COMMIT)
<14>
<15>
<16>
CREATE <17> INDEX <index name> ON
<fields list>
<18>
SELECT <12> <fields list>
FROM <tables list>
WHERE <joins and filter>
<19>
<20>
DROP TABLE TABLENAME
<21>
<22>

The Commit after Final Drop property (<21>) is s ent to the warehous e
ev en if the SQL View for the report does not s how it.

Clean u p Po st St at emen t
The C l eanup Post Statement property al l ow s you to i nsert your ow n
SQL stri ng after the fi nal D R OP statement. There are fi ve setti ngs,
numbered 1-5. Each text stri ng entered i n C l eanup Post Statement 1
through C l eanup Post Statement 4 i s executed separatel y as a si ngl e
statement. To execute more than 5 statements, i nsert mul ti pl e
statements i n C l eanup Post Statement 5, separati ng each statement

© 2019, M icr o St r at egy In c. 1483

Syst em Ad m in ist r at io n Gu id e

w i th a ";". The SQL Engi ne then breaks i t i nto i ndi vi dual statements
usi ng ";" as the separator and executes the statements separatel y.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Exam p l e

In the fol l ow i ng exampl e the setti ng val ues are:

Cleanup Post Statement1=/* Cleanup Post Statement1 */

Create table TABLENAME
(ATTRIBUTE_COL1 VARCHAR(20),
FORM_COL2 CHAR(20),
FACT_COL3 FLOAT)
primary index (ATTRIBUTE_COL1, FORM_COL2)
insert into TABLENAME
select A1.COL1,
A2.COL2,
A3.COL3
from TABLE1 A1,
TABLE2 A2,
TABLE3 A3
where A1.COL1 = A2.COL1 and A2.COL4=A3.COL5
insert into TABLENAME
select A1.COL1,
A2.COL2,
A3.COL3
from TABLE4 A1,
TABLE5 A2,
TABLE6 A3
where A1.COL1 = A2.COL1 and A2.COL4=A3.COL5

create index IDX_TEMP1(STORE_ID, STORE_DESC)

select A1.STORE_NBR,
max(A1.STORE_DESC)
from LOOKUP_STORE
Where A1 A1.STORE_NBR = 1
group by A1.STORE_NBR
drop table TABLENAME
/* Cleanup Post Statement 1*/

1484 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Dat a Mar t SQL t o b e Execu t ed Af t er Dat a Mar t Cr eat io n

The D ata mart SQL to be executed after data mart creati on VLD B
property al l ow s you to defi ne SQL statements that are i ncl uded after
data mart creati on. These SQL statements are i ncl uded after the
CREA TE statement for the data mart tabl e. Thi s al l ow s you to
customi ze the statement used to create data marts.

Level s at Whi ch You Can Set Thi s

D atabase i nstance and data mart

Dat a Mar t SQL t o b e Execu t ed Bef o r e In ser t in g Dat a

The D ata mart SQL to be executed before i nserti ng data VLD B
property al l ow s you to defi ne SQL statements i ssued before i nserti ng
data i nto a data mart. These SQL statements are i ncl uded before the
INSE RT statement for the data mart tabl e. Thi s al l ow s you to
customi ze the statement used to i nsert data i nto data marts.

Level s at Whi ch You Can Set Thi s

D atabase i nstance and data mart

Dat a Mar t SQL t o b e Execu t ed Pr io r t o Dat a Mar t Cr eat io n

The D ata mart SQL to be executed pri or to data mart creati on VLD B
property al l ow s you to defi ne SQL statements that are i ncl uded before
data mart creati on. These SQL statements are i ncl uded before the
CREA TE statement for the data mart tabl e. Thi s al l ow s you to
customi ze the statement used to create data marts.

Level s at Whi ch You Can Set Thi s

D atabase i nstance and data mart

© 2019, M icr o St r at egy In c. 1485

Syst em Ad m in ist r at io n Gu id e

Dr o p Dat ab ase Co n n ect io n

The D rop D atabase C onnecti on VLD B property al l ow s you to defi ne
w hether the database connecti on i s dropped after user-defi ned SQL i s
executed on the database. Thi s VLD B property has the fol l ow i ng
opti ons:

l D rop database connection after running user-defined SQL

(defaul t): The database connecti on i s dropped after user-defi ned
SQL i s executed on the database. Thi s ensures that database
connecti ons are not l eft open and unused for extended peri ods of
ti me after user-defi ned SQL i s executed.

l D o not drop database connection after running user-defined

SQL: The database connecti on remai ns open after user-defi ned
SQL i s executed on the database. Thi s can keep the database
connecti on open for addi ti onal user-defi ned SQL statements to be
executed.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Elemen t Br o wsin g Po st St at emen t

The El ement Brow si ng Post Statement VLD B property i s used to
i nsert custom SQL statements after the compl eti on of al l el ement
brow si ng requests. For exampl e, an el ement brow si ng request occurs
w hen a user expands an attri bute to vi ew i ts attri bute el ements.

Incl udi ng SQL statements after the compl eti on of el ement brow si ng
requests can al l ow you to defi ne the pri ori ty of el ement brow si ng
requests to be hi gher or l ow er than the pri ori ty for report requests.
You can al so i ncl ude any other SQL statements requi red to better
support el ement brow si ng requests. You can i ncl ude mul ti pl e
statements to be executed. Each statement must be separated by a

1486 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

semi col on (; ). The SQL Engi ne then executes the statements

separatel y.

If you modi fy the El ement Brow si ng PostStatement VLD B property, the

statements defi ned i n the R eport Post Statement VLD B property are
not used for el ement brow si ng requests. Pri ori ty of report requests
and other post-report SQL statements can be defi ned usi ng the R eport
Post Statement VLD B properti es, w hi ch are descri bed i n El ement
Brow si ng Post Statement, page 1486.

Level s at Whi ch You Can Set Thi s

D atabase i nstance onl y

Elemen t Br o wsin g Pr e St at emen t

The El ement Brow si ng Pre Statement VLD B property i s used to i nsert
custom SQL statements at the begi nni ng of al l el ement brow si ng
requests. For exampl e, an el ement brow si ng request occurs w hen a
user expands an attri bute to vi ew i ts attri bute el ements.

Incl udi ng SQL statements pri or to el ement brow si ng requests can

al l ow you to defi ne the pri ori ty of el ement brow si ng requests to be
hi gher or l ow er than the pri ori ty for report requests. You can al so
i ncl ude any other SQL statements requi red to better support el ement
brow si ng requests. You can i ncl ude mul ti pl e statements to be
executed, separated by a semi col on (;). The SQL Engi ne then
executes the statements separatel y.

If you do modi fy the El ement Brow si ng PreStatement VLD B property,

the statements defi ned i n the R eport Pre Statement VLD B property
are not used for el ement brow si ng requests. Pri ori ty of report requests
and other pre-report SQL statements can al so be defi ned usi ng the
R eport Pre Statement VLD B properti es, w hi ch are descri bed i n
El ement Brow si ng Pre Statement, page 1487.

© 2019, M icr o St r at egy In c. 1487

Syst em Ad m in ist r at io n Gu id e

Level s at Whi ch You Can Set Thi s

D atabase i nstance onl y

In ser t Mid St at emen t

The Insert Mi d Statement property i s used to i nsert your ow n custom
SQL stri ngs betw een the fi rst IN SER T IN TO SELEC T statement and
subsequent IN SER T IN TO SELEC T statements i nserti ng data i nto the
same tabl e. There are fi ve setti ngs i n total , numbered 1-5. Each text
stri ng entered i n Insert Mi d Statement 1 through Insert Mi d Statement
4 i s executed separatel y as a si ngl e statement. To execute more than
5 statements, you can put mul ti pl e statements i n Insert Mi d Statement
5, separati ng each statement w i th a ";". The SQL Engi ne then breaks
i t i nto i ndi vi dual statements usi ng ";" as the separator and executes
the statements separatel y.

Mul ti pl e IN SER T IN TO SELEC T statements to the same tabl e occur i n

reports i nvol vi ng parti ti on tabl es and outer j oi ns. The U N ION Mul ti pl e
Inserts VLD B property affects thi s property. If the U N ION Mul ti pl e
Inserts VLD B property i s set to U se U ni on, there i s onl y one i nsert
i nto the i ntermedi ate tabl e. Thi s setti ng i s appl i cabl e w hen the
Intermedi ate Tabl e Type VLD B property i s set to Permanent or
Temporary tabl e.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Exam p l es

In the fol l ow i ng exampl e, the setti ng val ues are:

Insert MidStatement1=/* ??? Insert MidStatement1 */

UNION Multiple Inserts = Do Not Use UNION

select a11.PBTNAME PBTNAME

from HARI_STORE_ITEM_PTMAP a11

1488 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

create table ZZTIS00H5YAPO000 (

ITEM_NBR DECIMAL(10, 0),
CLASS_NBR DECIMAL(10, 0),
STORE_NBR DECIMAL(10, 0),
XKYCGT INTEGER,
TOTALSALES FLOAT)
insert into ZZTIS00H5YAPO000
select a11.ITEM_NBR ITEM_NBR,
a11.CLASS_NBR CLASS_NBR,
a11.STORE_NBR STORE_NBR,
0 XKYCGT,
sum(a11.TOT_SLS_DLR) TOTALSALES
from HARI_STORE_ITEM_93 a11
group by a11.ITEM_NBR,
a11.CLASS_NBR,
a11.STORE_NBR
/* ZZTIS00H5YAPO000 Insert MidStatement1 */
insert into ZZTIS00H5YAPO000
select a11.ITEM_NBR ITEM_NBR,
a11.CLASS_NBR CLASS_NBR,
a11.STORE_NBR STORE_NBR,
1 XKYCGT,
sum(a11.TOT_SLS_DLR) TOTALSALES
from HARI_STORE_ITEM_94 a11
group by a11.ITEM_NBR,
a11.CLASS_NBR,
a11.STORE_NBR
select pa1.ITEM_NBR ITEM_NBR,
pa1.CLASS_NBR CLASS_NBR,
max(a11.ITEM_DESC) ITEM_DESC,
max(a11.CLASS_DESC) CLASS_DESC,
pa1.STORE_NBR STORE_NBR,
max(a12.STORE_DESC) STORE_DESC,
sum(pa1.TOTALSALES) TOTALSALES
from ZTIS00H5YAPO000 pa1
join HARI_LOOKUP_ITEM a11
on (pa1.CLASS_NBR = a11.CLASS_NBR and
pa1.ITEM_NBR = a11.ITEM_NBR)
join HARI_LOOKUP_STORE a12
on (pa1.STORE_NBR = a12.STORE_NBR)
group by pa1.ITEM_NBR,
pa1.CLASS_NBR,
pa1.STORE_NBR

UNION Multiple Inserts = Use UNION

© 2019, M icr o St r at egy In c. 1489

Syst em Ad m in ist r at io n Gu id e

select a11.PBTNAME PBTNAME

from HARI_STORE_ITEM_PTMAP a11
create table ZZTIS00H5YEPO000 (
ITEM_NBR DECIMAL(10, 0),
CLASS_NBR DECIMAL(10, 0),
STORE_NBR DECIMAL(10, 0),
XKYCGT INTEGER,
TOTALSALES FLOAT)
insert into ZZTIS00H5YEPO000
select a11.ITEM_NBR ITEM_NBR,
a11.CLASS_NBR CLASS_NBR,
a11.STORE_NBR STORE_NBR,
0 XKYCGT,
sum(a11.TOT_SLS_DLR) TOTALSALES
from HARI_STORE_ITEM_93 a11
group by a11.ITEM_NBR,
a11.CLASS_NBR,
a11.STORE_NBR
union all
select a11.ITEM_NBR ITEM_NBR,
a11.CLASS_NBR CLASS_NBR,
a11.STORE_NBR STORE_NBR,
1 XKYCGT,
sum(a11.TOT_SLS_DLR) TOTALSALES
from HARI_STORE_ITEM_94 a11
group by a11.ITEM_NBR,
a11.CLASS_NBR,
a11.STORE_NBR
select pa1.ITEM_NBR ITEM_NBR,
pa1.CLASS_NBR CLASS_NBR,
max(a11.ITEM_DESC) ITEM_DESC,
max(a11.CLASS_DESC) CLASS_DESC,
pa1.STORE_NBR STORE_NBR,
max(a12.STORE_DESC) STORE_DESC,
sum(pa1.TOTALSALES) TOTALSALES
from ZZTIS00H5YEPO000 pa1
join HARI_LOOKUP_ITEM a11
on (pa1.CLASS_NBR = a11.CLASS_NBR and
pa1.ITEM_NBR = a11.ITEM_NBR)
join HARI_LOOKUP_STORE a12
on (pa1.STORE_NBR = a12.STORE_NBR)
group by pa1.ITEM_NBR,
pa1.CLASS_NBR,
pa1.STORE_NBR

1490 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

In ser t Po st St at emen t
Thi s property i s used to i nsert your custom SQL statements after
C R EATE and after the fi rst IN SER T IN TO SELEC T statement for
expl i ci t temp tabl e creati on. There are fi ve setti ngs, numbered 1-5.
Each text stri ng entered i n Insert Post Statement 1 through Insert Post
Statement 4 i s executed separatel y as a si ngl e statement. To execute
more than 5 statements, i nsert mul ti pl e statement i n Insert Post
Statement 5, separati ng each statement w i th a ";". The SQL Engi ne
then breaks i t i nto i ndi vi dual statements usi ng ";" as the separator
and executes the statements separatel y.

Mul ti pl e IN SER T IN TO SELEC T statements to the same tabl e occur i n

reports i nvol vi ng parti ti on tabl es and outer j oi ns. The U N ION Mul ti pl e
Inserts VLD B property does not affect thi s property, but the Tabl e
C reati on Type property does. The Tabl e C reati on Type property i s
appl i cabl e w hen the Intermedi ate Tabl e Type VLD B property i s set to
Permanent or Temporary tabl e.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Exam p l e

In the fol l ow i ng exampl e, the setti ng val ues are:

Insert PostStatement1=/* ??? Insert PostStatement1 */

Table Creation Type= Explicit

select a11.PBTNAME PBTNAME

from HARI_STORE_ITEM_PTMAP a11
create table ZZTIS00H601PO000 (
ITEM_NBR DECIMAL(10, 0),
CLASS_NBR DECIMAL(10, 0),
STORE_NBR DECIMAL(10, 0),
XKYCGT INTEGER,
TOTALSALES FLOAT)
insert into ZZTIS00H601PO000

© 2019, M icr o St r at egy In c. 1491

Syst em Ad m in ist r at io n Gu id e

select a11.ITEM_NBR ITEM_NBR,

a11.CLASS_NBR CLASS_NBR,
a11.STORE_NBR STORE_NBR,
0 XKYCGT,
sum(a11.TOT_SLS_DLR) TOTALSALES
from HARI_STORE_ITEM_93 a11
group by a11.ITEM_NBR,
a11.CLASS_NBR,
a11.STORE_NBR
insert into ZZTIS00H601PO000
select a11.ITEM_NBR ITEM_NBR,
a11.CLASS_NBR CLASS_NBR,
a11.STORE_NBR STORE_NBR,
1 XKYCGT,
sum(a11.TOT_SLS_DLR) TOTALSALES
from HARI_STORE_ITEM_94 a11
group by a11.ITEM_NBR,
a11.CLASS_NBR,
a11.STORE_NBR
/* ZZTIS00H601PO000 Insert PostStatement1 */
select pa1.ITEM_NBR ITEM_NBR,
pa1.CLASS_NBR CLASS_NBR,
max(a11.ITEM_DESC) ITEM_DESC,
max(a11.CLASS_DESC) CLASS_DESC,
pa1.STORE_NBR STORE_NBR,
max(a12.STORE_DESC) STORE_DESC,
sum(pa1.TOTALSALES) TOTALSALES
from ZZTIS00H601PO000 pa1
join HARI_LOOKUP_ITEM a11
on (pa1.CLASS_NBR = a11.CLASS_NBR and
pa1.ITEM_NBR = a11.ITEM_NBR)
join HARI_LOOKUP_STORE a12
on (pa1.STORE_NBR = a12.STORE_NBR)
group by pa1.ITEM_NBR,
pa1.CLASS_NBR,
pa1.STORE_NBR

Table Creation Type= Implicit

select a11.PBTNAME PBTNAME

from HARI_STORE_ITEM_PTMAP a11
select a11.ITEM_NBR ITEM_NBR,
a11.CLASS_NBR CLASS_NBR,
a11.STORE_NBR STORE_NBR,
0 XKYCGT,

1492 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

sum(a11.TOT_SLS_DLR) TOTALSALES
into ZZTIS00H60BPO000
from HARI_STORE_ITEM_93 a11
group by a11.ITEM_NBR,
a11.CLASS_NBR,
a11.STORE_NBR
insert into ZZTIS00H60BPO000
select a11.ITEM_NBR ITEM_NBR,
a11.CLASS_NBR CLASS_NBR,
a11.STORE_NBR STORE_NBR,
1 XKYCGT,
sum(a11.TOT_SLS_DLR) TOTALSALES
from HARI_STORE_ITEM_94 a11
group by a11.ITEM_NBR,
a11.CLASS_NBR,
a11.STORE_NBR
select pa1.ITEM_NBR ITEM_NBR,
pa1.CLASS_NBR CLASS_NBR,
max(a11.ITEM_DESC) ITEM_DESC,
max(a11.CLASS_DESC) CLASS_DESC,
pa1.STORE_NBR STORE_NBR,
max(a12.STORE_DESC) STORE_DESC,
sum(pa1.TOTALSALES) TOTALSALES
from ZTIS00H60BPO000 pa1
join HARI_LOOKUP_ITEM a11
on (pa1.CLASS_NBR = a11.CLASS_NBR and
pa1.ITEM_NBR = a11.ITEM_NBR)
join HARI_LOOKUP_STORE a12
on (pa1.STORE_NBR = a12.STORE_NBR)
group by pa1.ITEM_NBR,
pa1.CLASS_NBR,
pa1.STORE_NBR

In ser t Pr e St at emen t
The Insert Pre Statement property i s used to i nsert your custom SQL
statements after C R EATE but before the fi rst IN SER T IN TO SELEC T
statement for expl i ci t temp tabl e creati on. There are fi ve setti ngs,
numbered 1-5. Each text stri ng entered i n Insert Pre Statement 1
through Insert Pre Statement 4 i s executed separatel y as a si ngl e
statement. To execute more than 5 statements, i nsert mul ti pl e

© 2019, M icr o St r at egy In c. 1493

Syst em Ad m in ist r at io n Gu id e

statements i n Insert Pre Statement 5, separati ng each statement w i th

a ";". The SQL Engi ne then breaks i t i nto i ndi vi dual statements usi ng
";" as the separator and executes the statements separatel y.

Mul ti pl e IN SER T IN TO SELEC T statements to the same tabl e occur i n

reports i nvol vi ng parti ti on tabl es and outer j oi ns. The U N ION Mul ti pl e
Inserts VLD B property does not affect thi s property, but the Tabl e
C reati on Type property does. The Tabl e C reati on Type property i s
appl i cabl e w hen the Intermedi ate Tabl e Type VLD B property i s set to
Permanent or Temporary tabl e.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Exam p l es

In the fol l ow i ng exampl es, the setti ng val ues are:

Insert PreStatement1=/* ??? Insert

PreStatement1 */

Table Creation Type= Explicit

select a11.PBTNAME PBTNAME

from HARI_STORE_ITEM_PTMAP a11
create table ZZTIS00H601PO000 (
ITEM_NBR DECIMAL(10, 0),
CLASS_NBR DECIMAL(10, 0),
STORE_NBR DECIMAL(10, 0),
XKYCGT INTEGER,
TOTALSALES FLOAT)
/* ZZTIS00H601PO000 Insert PreStatement1 */
insert into ZZTIS00H601PO000
select a11.ITEM_NBR ITEM_NBR,
a11.CLASS_NBR CLASS_NBR,
a11.STORE_NBR STORE_NBR,
0 XKYCGT,
sum(a11.TOT_SLS_DLR) TOTALSALES
from HARI_STORE_ITEM_93 a11
group by a11.ITEM_NBR,
a11.CLASS_NBR,

1494 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

a11.STORE_NBR
insert into ZZTIS00H601PO000
select a11.ITEM_NBR ITEM_NBR,
a11.CLASS_NBR CLASS_NBR,
a11.STORE_NBR STORE_NBR,
1 XKYCGT,
sum(a11.TOT_SLS_DLR) TOTALSALES
from HARI_STORE_ITEM_94 a11
group by a11.ITEM_NBR,
a11.CLASS_NBR,
a11.STORE_NBR
select pa1.ITEM_NBR ITEM_NBR,
pa1.CLASS_NBR CLASS_NBR,
max(a11.ITEM_DESC) ITEM_DESC,
max(a11.CLASS_DESC) CLASS_DESC,
pa1.STORE_NBR STORE_NBR,
max(a12.STORE_DESC) STORE_DESC,
sum(pa1.TOTALSALES) TOTALSALES
from ZZTIS00H601PO000 pa1
join HARI_LOOKUP_ITEM a11
on (pa1.CLASS_NBR = a11.CLASS_NBR and
pa1.ITEM_NBR = a11.ITEM_NBR)
join HARI_LOOKUP_STORE a12
on (pa1.STORE_NBR = a12.STORE_NBR)
group by pa1.ITEM_NBR,
pa1.CLASS_NBR,
pa1.STORE_NBR

Table Creation Type= Implicit

select a11.PBTNAME PBTNAME

from HARI_STORE_ITEM_PTMAP a11
select a11.ITEM_NBR ITEM_NBR,
a11.CLASS_NBR CLASS_NBR,
a11.STORE_NBR STORE_NBR,
0 XKYCGT,
sum(a11.TOT_SLS_DLR) TOTALSALES
into ZZTIS00H60BPO000
from HARI_STORE_ITEM_93 a11
group by a11.ITEM_NBR,
a11.CLASS_NBR,
a11.STORE_NBR
insert into ZZTIS00H60BPO000
select a11.ITEM_NBR ITEM_NBR,
a11.CLASS_NBR CLASS_NBR,

© 2019, M icr o St r at egy In c. 1495

Syst em Ad m in ist r at io n Gu id e

a11.STORE_NBR STORE_NBR,
1 XKYCGT,
sum(a11.TOT_SLS_DLR) TOTALSALES
from HARI_STORE_ITEM_94 a11
group by a11.ITEM_NBR,
a11.CLASS_NBR,
a11.STORE_NBR
select pa1.ITEM_NBR ITEM_NBR,
pa1.CLASS_NBR CLASS_NBR,
max(a11.ITEM_DESC) ITEM_DESC,
max(a11.CLASS_DESC) CLASS_DESC,
pa1.STORE_NBR STORE_NBR,
max(a12.STORE_DESC) STORE_DESC,
sum(pa1.TOTALSALES) TOTALSALES
from ZZTIS00H60BPO000 pa1
join HARI_LOOKUP_ITEM a11
on (pa1.CLASS_NBR = a11.CLASS_NBR and
pa1.ITEM_NBR = a11.ITEM_NBR)
join HARI_LOOKUP_STORE a12
on (pa1.STORE_NBR = a12.STORE_NBR)
group by pa1.ITEM_NBR,
pa1.CLASS_NBR,

Rep o r t Po st St at emen t
The R eport Post Statement property i s used to i nsert custom SQL
statements after the fi nal SELEC T statement but before the D R OP
statements. There are fi ve setti ngs, numbered 1-5. Each text stri ng
entered i n R eport Post Statement 1 through R eport Post Statement 4
i s executed separatel y as a si ngl e statement. To execute more than 5
statements, i nsert mul ti pl e statements i n R eport Post Statement 5,
separati ng each statement w i th a ";". The SQL Engi ne then breaks
them i nto i ndi vi dual statements usi ng ";" as the separator and
executes the statements separatel y.

If you do not modi fy the El ement Brow si ng Post Statement VLD B

property, the statements defi ned i n thi s R eport Post Statement VLD B
property are al so used for el ement brow si ng requests. For exampl e,
an el ement brow si ng request occurs w hen a user expands an attri bute

1496 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

to vi ew i ts attri bute el ements. To defi ne statements that appl y onl y to

el ement brow si ng requests, see R eport Post Statement, page 1496.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Exam p l e

In the fol l ow i ng exampl e, the setti ng val ues are:

Create table TABLENAME

(ATTRIBUTE_COL1 VARCHAR(20),
FORM_COL2 CHAR(20),
FACT_COL3 FLOAT)
primary index (ATTRIBUTE_COL1, FORM_COL2)
insert into TABLENAME
select A1.COL1,
A2.COL2,
A3.COL3
from TABLE1 A1,
TABLE2 A2,
TABLE3 A3
where A1.COL1 = A2.COL1 and A2.COL4=A3.COL5
insert into TABLENAME
select A1.COL1,
A2.COL2,
A3.COL3
from TABLE4 A1,
TABLE5 A2,
TABLE6 A3
where A1.COL1 = A2.COL1 and A2.COL4=A3.COL5

create index IDX_TEMP1(STORE_ID, STORE_DESC)

select A1.STORE_NBR,
max(A1.STORE_DESC)
from LOOKUP_STORE
Where A1 A1.STORE_NBR = 1
group by A1.STORE_NBR
/* Report Post Statement 1*/
drop table TABLENAME

© 2019, M icr o St r at egy In c. 1497

Syst em Ad m in ist r at io n Gu id e

Rep o r t Pr e St at emen t
The R eport Pre Statement property i s used to i nsert custom SQL
statements at the begi nni ng of the R eport SQL. There are fi ve
setti ngs, numbered 1-5. Each text stri ng entered i n R eport Pre
Statement 1 through R eport Pre Statement 4 i s executed separatel y
as a si ngl e statement. To execute more than 5 statements, i nsert
mul ti pl e statements i n R eport Pre Statement 5, separati ng each
statement w i th a ";". The SQL Engi ne then breaks them i nto i ndi vi dual
statements usi ng ";" as the separator and executes the statements
separatel y.

If you do not modi fy the El ement Brow si ng Pre Statement VLD B

property, the statements defi ned i n thi s R eport Pre Statement VLD B
property are al so used for el ement brow si ng requests. For exampl e,
an el ement brow si ng request occurs w hen a user expands an attri bute
to vi ew i ts attri bute el ements. To defi ne statements that appl y onl y to
el ement brow si ng requests, see R eport Pre Statement, page 1498.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Exam p l e

In the fol l ow i ng exampl e, the setti ng val ues are:

Report Pre Statement1=/* Report Pre Statement1 */

/* Report Pre Statement 1*/
Create table TABLENAME
(ATTRIBUTE_COL1 VARCHAR(20),
FORM_COL2 CHAR(20),
FACT_COL3 FLOAT)
primary index (ATTRIBUTE_COL1, FORM_COL2)
insert into TABLENAME
select A1.COL1,
A2.COL2,
A3.COL3
from TABLE1 A1,
TABLE2 A2,

1498 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

TABLE3 A3
where A1.COL1 = A2.COL1 and A2.COL4=A3.COL5
insert into TABLENAME
select A1.COL1,
A2.COL2,
A3.COL3
from TABLE4 A1,
TABLE5 A2,
TABLE6 A3
where A1.COL1 = A2.COL1 and A2.COL4=A3.COL5

create index IDX_TEMP1(STORE_ID, STORE_DESC)

select A1.STORE_NBR,
max(A1.STORE_DESC)
from LOOKUP_STORE
Where A1 A1.STORE_NBR = 1
group by A1.STORE_NBR
drop table TABLENAME

Mu lt i-So u r ce Rep o r t Pr e an d Po st St at emen t s

R eport Pre and Post SQL statements can be appl i ed and executed
agai nst mul ti pl e databases used as a data source for reports. Thi s
i ncl udes both i n-memory and connect l i ve Intel l i gent C ubes. The Pre
and Post SQL statements do not have to be pl aced i n a parti cul ar
order i n the overal l query as they operate i ndependentl y from one
another.

The exampl e bel ow show s an i nstance of how pre and post

statements at both the report l evel and database i nstance l evel are
appl i ed and executed agai nst mul ti pl e sources.

© 2019, M icr o St r at egy In c. 1499

Syst em Ad m in ist r at io n Gu id e

For exampl es of the syntax requi red for these statements, see the
R eport Pre Statement and R eport Post Statement secti ons.

Tab le Po st St at emen t
The Tabl e Post Statement property i s used to i nsert custom SQL
statements after the C R EATE TABLE and IN SER T IN TO statements.
There are fi ve setti ngs, numbered 1-5. Each text stri ng entered i n
Tabl e Post Statement 1 through Tabl e Post Statement 4 i s executed
separatel y as a si ngl e statement. To execute more than 5 statements,
i nsert mul ti pl e statements i n Tabl e Post Statement 5, separati ng each
statement w i th a ";". The SQL Engi ne then breaks them i nto i ndi vi dual
statements usi ng ";" as the separator and executes the statements
separatel y. Thi s property i s appl i cabl e w hen the Intermedi ate Tabl e
Type VLD B property i s set to Permanent or Temporary tabl e or Vi ew s.
The custom SQL i s appl i ed to every i ntermedi ate tabl e or vi ew .

15 00 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Exam p l e

In the fol l ow i ng exampl e, the setti ng val ues are:

Table PostStatement1=/* ??? Table PostStatement1 */

select a11.DEPARTMENT_NBR DEPARTMENT_NBR,
a11.STORE_NBR STORE_NBR
into #ZZTIS00H63PMQ000
from HARI_STORE_DEPARTMENT a11
group by a11.DEPARTMENT_NBR,
a11.STORE_NBR
having sum(a11.TOT_SLS_DLR) > 100000
/* #ZZTIS00H63PMQ000 Table PostStatement 1*/
select a11.DEPARTMENT_NBR DEPARTMENT_NBR,
max(a12.DEPARTMENT_DESC) DEPARTMENT_DESC,
a11.STORE_NBR STORE_NBR,
max(a13.STORE_DESC) STORE_DESC,
sum(a11.TOT_SLS_DLR) TOTALSALES
from HARI_STORE_DEPARTMENT a11
join #ZZTIS00H63PMQ000 pa1
on (a11.DEPARTMENT_NBR = pa1.DEPARTMENT_NBR and
a11.STORE_NBR = pa1.STORE_NBR)
join HARI_LOOKUP_DEPARTMENT a12
on (a11.DEPARTMENT_NBR = a12.DEPARTMENT_NBR)
join HARI_LOOKUP_STORE a13
on (a11.STORE_NBR = a13.STORE_NBR)
group by a11.DEPARTMENT_NBR,
a11.STORE_NBR

Tab le Pr e St at emen t
The Tabl e Pre Statement property i s used to i nsert custom SQL
statements before the C R EATE TABLE statement. There are fi ve
setti ngs, numbered 1-5. Each text stri ng entered i n Tabl e Pre
Statement 1 through Tabl e Pre Statement 4 i s executed separatel y as
a si ngl e statement. To execute more than 5 statements, i nsert mul ti pl e
statements i n Tabl e Pre Statement 5, separati ng each statement w i th

© 2019, M icr o St r at egy In c. 15 01

Syst em Ad m in ist r at io n Gu id e

a ";". The SQL Engi ne then breaks them i nto i ndi vi dual statements
usi ng ";" as the separator and executes the statements separatel y.
Thi s property i s appl i cabl e w hen the Intermedi ate Tabl e Type VLD B
property i s set to Permanent or Temporary tabl e or Vi ew s. The custom
SQL i s appl i ed to every i ntermedi ate tabl e or vi ew .

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Exam p l e

In the fol l ow i ng exampl e, the setti ng val ues are:

Table PreStatement1=/* ??? Table

PreStatement1 */
/*Table PreStatement 1*/
create table ZZTIS00H63RMQ000 (
DEPARTMENT_NBR DECIMAL(10, 0),
STORE_NBR DECIMAL(10, 0))
insert into ZZTIS00H63RMQ000
select a11.DEPARTMENT_NBR DEPARTMENT_NBR,
a11.STORE_NBR STORE_NBR
from HARI_STORE_DEPARTMENT a11
group by a11.DEPARTMENT_NBR,
a11.STORE_NBR
having sum(a11.TOT_SLS_DLR) > 100000
select a11.DEPARTMENT_NBR DEPARTMENT_NBR,
max(a12.DEPARTMENT_DESC) DEPARTMENT_DESC,
a11.STORE_NBR STORE_NBR,
max(a13.STORE_DESC) STORE_DESC,
sum(a11.TOT_SLS_DLR) TOTALSALES
from HARI_STORE_DEPARTMENT a11
join ZZTIS00H63RMQ000 pa1
on (a11.DEPARTMENT_NBR = pa1.DEPARTMENT_NBR and
a11.STORE_NBR = pa1.STORE_NBR)
join HARI_LOOKUP_DEPARTMENT a12
on (a11.DEPARTMENT_NBR = a12.DEPARTMENT_NBR)
join HARI_LOOKUP_STORE a13
on (a11.STORE_NBR = a13.STORE_NBR)
group by a11.DEPARTMENT_NBR,
a11.STORE_NBR

15 02 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Optimizing Queries
The tabl e bel ow summari zes the Query Opti mi zati ons VLD B
properti es. Addi ti onal detai l s about each property, i ncl udi ng
exampl es w here necessary, are provi ded i n the secti ons fol l ow i ng the
tabl e.

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

Det ermines • (def ault ) Final pass

whet her t he E ngine CA N do aggregat ion
calculat es an and join lookup Final pass CA N
Additional
aggregat ion t ables in one pass do aggregat ion
Final Pass
f unct ion and a join and join lookup
Option • One addit ional f inal
in a single pass or t ables in one pass
in separat e passes pass only t o join

in t he S QL. lookup t ables

• A pply f ilt er only t o

passes t ouching
warehouse t ables

• A pply f ilt er t o passes

t ouching warehouse
I ndicat es during t ables and last join
A pply f ilt er only t o
Apply Filter which pass t he pass, if it does a
passes t ouching
Options report f ilt er is downward join f rom
warehouse t ables
applied. t he t emp t able level
t o t he t emplat e level

• A pply f ilt er t o passes

t ouching warehouse
t ables and last join
pass

Cont rols how t he • Use Count Use Count

Attribute
t ot al number of (A t t ribut e@I D) t o (A t t ribut e@I D) t o
Element
rows are calculat ed calculat e t ot al calculat e t ot al
N umber C ount
f or increment al element number element number
Method
f et ch. (uses count dist inct (uses count

© 2019, M icr o St r at egy In c. 15 03

Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

dist inct if
necessary)
if necessary)
For Tandem
• Use ODB C cursor t o dat abases,
calculat e t ot al t he def ault
element number is Use
ODB C
Cursor.

• Do not select dist inct

Det ermines how element s f or each
dist inct count s of part it ion Do not select
C ount D is tinc t
values are ret rieved dist inct element s
w ith Partitions • S elect dist inct
f rom part it ioned f or each part it ion
t ables. element s f or each
part it ion

Helps opt imize

cust om group
banding when using
t he Count B anding
• Treat banding as
met hod. Y ou can
normal calculat ion
choose t o use t he
C us tom Group st andard met hod • Use st andard case
Treat banding as
Banding C ount t hat uses t he st at ement synt ax
normal calculat ion
Method A nalyt ical E ngine
• I nsert band range t o
or dat abase-
dat abase and join
specif ic synt ax, or
wit h met ric value
you can choose t o
use case
st at ement s or t emp
t ables.

• Treat banding as
C us tom Group Helps opt imize
normal calculat ion Treat banding as
Banding Points cust om group
banding when using • Use st andard case normal calculat ion
Method
st at ement synt ax

15 04 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

t he P oint s B anding
met hod. Y ou can
choose t o use t he
st andard met hod
t hat uses t he
• I nsert band range t o
A nalyt ical E ngine
dat abase and join
or dat abase-
wit h met ric value
specif ic synt ax, or
you can choose t o
use case
st at ement s or t emp
t ables.

Helps opt imize

cust om group
banding when using
t he S ize B anding
• Treat banding as
met hod. Y ou can
normal calculat ion
choose t o use t he
C us tom Group st andard met hod • Use st andard case
Treat banding as
Banding Size t hat uses t he st at ement synt ax
normal calculat ion
Method A nalyt ical E ngine
• I nsert band range t o
or dat abase-
dat abase and join
specif ic synt ax, or
wit h met ric value
you can choose t o
use case
st at ement s or t emp
t ables.

• Do not normalize
I nt elligent Cube dat a
Def ines if and how Normalize
D ata
I nt elligent Cube • Normalize I nt elligent I nt elligent Cube
Population for
dat a is normalized Cube dat a in dat a in
Intelligent
t o save memory I nt elligence S erver I nt elligence
C ubes
resources. S erver
• Normalize I nt elligent
Cube dat a in

© 2019, M icr o St r at egy In c. 15 05

Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

dat abase using

I nt ermediat e Table
Type

• Normalize I nt elligent
Cube dat a in
dat abase using
Fallback Type

• Normalize I nt elligent
Cube dat a basing on
dimensions wit h
at t ribut e lookup
f ilt ering

• Normalize I nt elligent
Cube dat a basing on
dimensions wit h no
at t ribut e lookup
f ilt ering

• Do not normalize
report dat a

• Normalize report
dat a in I nt elligence
S erver

• Normalize report
Def ines if and how
D ata dat a in dat abase
report dat a is Do not normalize
Population for using I nt ermediat e
normalized t o save report dat a
R eports Table Type
memory resources.
• Normalize report
dat a in dat abase
using Fallback Table
Type

• Normalize report
dat a basing on

15 06 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

dimensions wit h
at t ribut e lookup
f ilt ering

• S ort at t ribut e
Det ermines whet her element s based on
t he sort order of t he at t ribut e I D f orm
D efault Sort f or each at t ribut e S ort at t ribut e
at t ribut e element s
Behav ior for element s based
on report s • S ort at t ribut e
Attribute on t he at t ribut e I D
considers special element s based on
Elements in f orm f or each
sort order t he def ined 'Report
R eports at t ribut e
f ormat t ing def ined S ort ' set t ing of all
f or at t ribut es. at t ribut e f orms f or
each at t ribut e

Det ermines level

(dimension) • Use relat ional model
D imens ionality replacement f or Use relat ional
Model non parent -child • Use dimensional model
relat ed at t ribut es in model

t he same hierarchy.

E nable or disable
t he A nalyt ical • E nable E ngine
E ngine's abilit y t o A t t ribut e Role
Engine t reat at t ribut es f eat ure Disable E ngine
Attribute R ole def ined on t he A t t ribut e Role
Options same column wit h • Disable E ngine f eat ure
t he same A t t ribut e Role

expression as f eat ure

at t ribut e roles.

Det ermines if • E nable Filt er t ree

Filter Tree opt imizat ion f or E nable Filt er t ree
met ric
Optimiz ation met ric qualif icat ions opt imizat ion f or
qualif icat ions t hat
for Metric met ric
are included in • Disable Filt er t ree
Qualific ations qualif icat ions
separat e passes of opt imizat ion f or

© 2019, M icr o St r at egy In c. 15 07

Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

S QL are included in
a single pass of
met ric qualif icat ions
S QL when
possible.

Det ermines whet her

dat a t hat is
t ransf erred bet ween
I nt elligence S erver • E nable I ncrement al
Dat a Transf er Disable
Incremental and a dat abase is
I ncrement al Dat a
D ata Trans fer perf ormed using a • Disable I ncrement al Transf er
single t ransf er of Dat a Transf er
dat a or mult iple,
increment al
t ransf ers of dat a

Det ermines how

Max imum many queries can
Parallel be execut ed in
User-def ined 2
Queries Per parallel as part of
R eport parallel query
execut ion support

A llows you t o • Use count (*) in

MD Partition choose how t o prequery Use count (*) in
Prequery handle prequerying
• Use const ant in prequery
Option t he met adat a
part it ion. prequery

• Use Mult iS ource

Opt ion t o access
Def ines which mult iple dat a Use Mult iS ource
Multiple D ata t echnique t o use t o sources Opt ion t o access
Sourc e support mult iple
• Use dat abase mult iple dat a
Support dat a sources in a
gat eway support t o source
project .
access mult iple dat a
sources

15 08 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

Def ines whet her

OLA P f unct ions • P reserve backwards
support backwards compat ibilit y wit h P reserve
OLAP Func tion compat ibilit y or 8. 1. x and earlier backwards
Support ref lect compat ibilit y wit h
enhancement s t o • Recommended wit h 8. 1. x and earlier
OLA P f unct ion 9. 0 and lat er

logic.

• Disable parallel
Det ermines
query execut ion
whet her
MicroS t rat egy • E nable parallel
at t empt s t o query execut ion f or
Parallel Query execut e mult iple mult iple dat a source Disable parallel
Ex ecution queries in parallel report s only query execut ion
t o ret urn report
• E nable parallel
result s f ast er and
query execut ion f or
publish I nt elligent
all report s t hat
Cubes.
support it

Det ermines whet her • Disable parallel

report s and query execut ion
I nt elligent Cubes improvement
Parallel Query include an est imat e est imat e in S QL Disable parallel
Ex ecution in t he percent of view query execut ion
Improv ement processing t ime improvement
Es timate in t hat would be saved • E nable parallel est imat e in S QL
SQL View if parallel Query query execut ion view
execut ion was used improvement

t o run mult iple est imat e in S QL

queries in parallel. view

• Use ODB C ranking

R ank Method Det ermines how (MS TR 6 met hod) Use ODB C
if D B R anking calculat ion ranking ranking (MS TR 6
N ot U s ed is perf ormed. • A nalyt ical engine met hod).
perf orms rank

© 2019, M icr o St r at egy In c. 15 09

Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

• Remove aggregat ion

Det ermines whet her according t o key of
t o keep or remove FROM clause Remove
R emov e
aggregat ions in aggregat ion
Aggregation • Remove aggregat ion
S QL queries according t o key
Method according t o key of
execut ed f rom of FROM clause
MicroS t rat egy. f act t ables (old
behavior)

• Remove aggregat ion

and Group B y when
Det ermines S elect level is Remove
whet her Group By ident ical t o From aggregat ion and
R emov e Group and aggregat ions level Group B y when
by Option are used f or • Remove aggregat ion S elect level is
at t ribut es wit h t he and Group B y when ident ical t o From
same primary key. S elect level cont ains level
all at t ribut e(s) in
From level

• Disable opt imizat ion

t o remove repeat ed
Det ermines whet her t ables in f ull out er E nable
R emov e an opt imizat ion f or join and lef t out er opt imizat ion t o
R epeated out er join join passes remove repeat ed
Tables for processing is • E nable opt imizat ion t ables in f ull out er
Outer Joins enabled or t o remove repeat ed join and lef t out er
disabled. t ables in f ull out er join passes
join and lef t out er
join passes

A llows you t o use

• Disable S et
set operat ors in sub
Operat or Disable S et
Set Operator queries t o combine
Opt imizat ion Operat or
Optimiz ation mult iple f ilt er
• E nable S et Operat or Opt imizat ion
qualif icat ions. S et
operat ors are only Opt imizat ion (if

15 10 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

support ed by
cert ain dat abase support ed by
plat f orms and wit h dat abase and [ S ub
cert ain sub query Query Type] )
t ypes.

• Level 0: No
opt imizat ion

• Level 1: Remove
Unused and
Duplicat e P asses

• Level 2: Level 1 +
Merge P asses wit h
Det ermines t he Level 4: Level 2 +
Dif f erent S E LE CT
SQL Global level by which S QL Merge A ll P asses
Optimiz ation queries in report s • Level 3: Level 2 + wit h Dif f erent
are opt imized. Merge P asses, which WHE RE
only hit DB Tables,
wit h dif f erent
WHE RE

• Level 4: Level 2 +
Merge A ll P asses
wit h Dif f erent
WHE RE

• WHE RE E X I S TS
(S E LE CT * . . . )

• WHE RE E X I S TS Use Temporary

A llows you t o
(S E LE CT col1, Table, f alling
det ermine t he t ype
Sub Query col2. . . ) back t o E X I S TS
of subquery used in
Type (S E LE CT *. . . ) f or
engine-generat ed • WHE RE COL1 I N
correlat ed
S QL. (S E LE CT
subquery
s1. COL1. . . ) f alling
back t o E X I S TS
(S E LE CT * . . . ) f or

© 2019, M icr o St r at egy In c. 15 11

Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

mult iple columns I N

• WHE RE (COL1,
COL2. . . ) I N
(S E LE CT s1. COL1,
s1. COL2. . . )

• Use Temporary
Table, f alling back
t o E X I S TS
(S E LE CT *. . . ) f or
correlat ed subquery

• WHE RE COL1 I N
(S E LE CT
s1. COL1. . . ) f alling
back t o E X I S TS
(S E LE CT col1, col2
. . . ) f or mult iple
columns I N

• Use Temporary
Table, f alling back
t o I N (S E LE CT COL)
f or correlat ed
subquery

• A lways join wit h

t ransf ormat ion t able Use
Def ines whet her t o t o perf orm t ransf ormat ion
at t empt t o improve t ransf ormat ion
Trans formation f ormula inst ead of
perf ormance of
Formula • Use t ransf ormat ion join wit h
report s t hat use
Optimiz ation f ormula inst ead of t ransf ormat ion
expression-based
join wit h t able when
t ransf ormat ions.
t ransf ormat ion t able possible
when possible

U nrelated Det ermines • Remove unrelat ed Remove unrelat ed

Filter Options whet her t he f ilt er f ilt er

15 12 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

• K eep unrelat ed f ilt er

A nalyt ical E ngine • K eep unrelat ed f ilt er
should keep or and put condit ion
remove t he f rom unrelat ed
unrelat ed f ilt er. at t ribut es in one
subquery group

Det ermines whet her

t he A nalyt ical • Use t he 8. 1. x
U nrelated
E ngine should keep behavior:
Filter Options Use t he 8. 1. x
or remove t he
for N es ted • Use t he 9. 0. x behavior
unrelat ed f ilt ers
Metric s behavior:
when using nest ed
met rics.

Det ermines t he
W H ER E
t able used f or • Use lookup t able
C lause D riv ing Use f act t able
qualif icat ions in t he • Use f act t able
Table
WHE RE clause.

Ad d it io n al Fin al Pass Op t io n
Addi ti onal Fi nal Pass Opti on i s an advanced property that i s hi dden
by defaul t. For i nformati on on how to di spl ay thi s property, see
Vi ew i ng and C hangi ng Advanced VLD B Properti es, page 1330.

The Addi ti onal Fi nal Pass Opti on determi nes w hether the Engi ne
cal cul ates an aggregati on functi on and a j oi n i n a si ngl e pass or i n
separate passes i n the SQL.

Level s at Whi ch You Can Set Thi s

R eport, templ ate, and database i nstance

It is rec ommended that y ou us e this property on reports . You mus t

update the metadata to s ee the property populated in the metadata.

© 2019, M icr o St r at egy In c. 15 13

Syst em Ad m in ist r at io n Gu id e

Exam p l e

The fol l ow i ng SQL exampl e w as created usi ng SQL Server metadata

and w arehouse.

C onsi der the fol l ow i ng structure of l ookup and fact tabl es:

l LU _Emp_Mgr has 4 col umns, namel y: Emp_ID , Emp_D esc, Mgr_ID ,

and Mgr_D esc

In this s truc ture, Emp_ID is the primary k ey of LU_Emp_Mgr table

l LU _D ept has 2 col umns, namel y: D ept_ID and D ept_D esc

In this s truc ture, Dept_ID is the primary k ey of LU_Dept table

l Fact tabl e Emp_D ept_Sal ary has 3 col umns, namel y: Emp_ID ,
D ept_ID , and fact Sal ary

From the above w arehouse structure, defi ne the fol l ow i ng schema

obj ects:

l Attri bute Empl oyee w i th 2 forms: Empl oyee@ID (defi ned on col umn
Emp_ID ) and Empl oyee@D esc (defi ned on col umn Emp_D esc)

l Attri bute Manager w i th 2 forms: Manager@ID (defi ned on col umn

Mgr_ID ) and Manager@D esc (defi ned on col umn Mgr_D esc)

l Attri bute D epartment w i th 2 forms: D epartment@ID (defi ned on

col umn D ept_ID ) and D epartment@D esc (defi ned on col umn D ept_
D esc)

l Fact Fact_Sal ary, w hi ch i s defi ned on Sal ary col umn

The Manager attribute is defined as the parent of the Employ ee

attribute v ia LU_Emp_Mgr table. This is a c ommon prac tic e in a s tar
s c hema.

C reate tw o metri cs that are defi ned as

15 14 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Sal ary_D ept = Sum(Fact_Sal ary)){~+, D epartment+}

l Sal ary = Avg(Sal ary_D ept){~+}

In a report cal l ed Empl oyee_Sal ary, put the Sal ary metri c on a
templ ate w i th the Manager attri bute. In thi s exampl e, the Empl oyee_
Sal ary report generates the fol l ow i ng SQL:

Pass0
select a12.Mgr_Id Mgr_Id,
a11.Dept_Id Dept_Id,
sum(a11.Salary) WJXBFS1
into #ZZTUW0200LXMD000
from dbo.Emp_Dept_Salary a11
join dbo.Emp_Mgr a12
on (a11.Emp_Id = a12.Emp_Id)
group by a12.Mgr_Id,
a11.Dept_Id
Pass1
select pa1.Mgr_Id Mgr_Id,
max(a11.Mgr_Desc) Mgr_Desc,
avg(pa1.WJXBFS1) WJXBFS1
from #ZZTUW0200LXMD000 pa1
join dbo.Emp_Mgr a11
on (pa1.Mgr_Id = a11.Mgr_Id)
group by pa1.Mgr_Id
Pass2
drop table #ZZTUW0200LXMD000

The probl em i n the SQL pass above that appears i n i tal i cs i s that the
j oi n condi ti on and the aggregati on functi on are i n a si ngl e pass. The
SQL j oi ns the Z Z T U W 0 2 00 L X M D 0 0 0 tabl e to the Emp_Mgr tabl e on
col umn Mgr_ID , but Mgr_ID i s not the pri mary key to the LU _Emp_Mgr
tabl e. Therefore, there are many row s on the LU _Emp_Mgr tabl e w i th
the same Mgr_ID . Thi s resul ts i n a repeated data probl em.

C l earl y, i f both the condi ti ons, aggregati on and j oi n, do not exi st on

the same tabl e, thi s probl em does not occur.

To resol ve thi s probl em, sel ect the opti on One additional final pass
only to join lookup tables i n the VLD B Properti es Edi tor. Wi th thi s

© 2019, M icr o St r at egy In c. 15 15

Syst em Ad m in ist r at io n Gu id e

opti on sel ected, the report, w hen executed, generates the fol l ow i ng
SQL:

Pass0
select a12.Mgr_Id Mgr_Id,
a11.Dept_Id Dept_Id,
sum(a11.Salary) WJXBFS1
into #ZZTUW01006IMD000
from dbo.Emp_Dept_Salary a11
join dbo.Emp_Mgr a12
on (a11.Emp_Id = a12.Emp_Id)
group by a12.Mgr_Id,
a11.Dept_Id
Pass1
select pa1.Mgr_Id Mgr_Id,
avg(pa1.WJXBFS1) WJXBFS1
into #ZZTUW01006IEA001
from #ZZTUW01006IMD000 pa1
group by pa1.Mgr_Id
Pass2
select distinct pa2.Mgr_Id Mgr_Id,
a11.Mgr_Desc Mgr_Desc,
pa2.WJXBFS1 WJXBFS1
from #ZZTUW01006IEA001 pa2
join dbo.Emp_Mgr a11
on (pa2.Mgr_Id = a11.Mgr_Id)
Pass3
drop table #ZZTUW01006IMD000
Pass4
drop table #ZZTUW01006IEA001

In thi s SQL, the i tal i ci zed secti ons show that the Engi ne cal cul ates
the aggregati on functi on, w hi ch i s the Average functi on, i n a separate
pass and performs the j oi n operati on i n another pass.

Ap p ly Filt er Op t io n s
The Appl y Fi l ter property has three setti ngs. The common el ement of
al l three setti ngs i s that report fi l ters must be appl i ed w henever a
w arehouse tabl e i s accessed. The setti ngs are

15 16 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l A pply filter only to passes touching warehouse tables (defaul t):

Thi s i s the defaul t opti on. It appl i es the fi l ter to onl y SQL passes
that touch w arehouse tabl es, but not to other passes. Thi s opti on
w orks i n most si tuati ons.

l A pply filter to passes touching warehouse tables and last join

pass, if it does a downward join from the temporary table level
to the template level: The fi l ter i s appl i ed i n the fi nal pass i f i t i s a
dow nw ard j oi n. For exampl e, you have Store, R egi on Sal es, and
R egi on C ost on the report, w i th the fi l ter "store=1." The i ntermedi ate
passes cal cul ate the total sal es and cost for R egi on 1 (to w hi ch
Store 1 bel ongs). In the fi nal pass, a dow nw ard j oi n i s done from
the R egi on l evel to the Store l evel , usi ng the rel ati onshi p tabl e
LOOKU P_STOR E. If the "store = 1" fi l ter i n thi s pass i s not appl i ed,
stores that bel ong to R egi on 1 are i ncl uded on the report. H ow ever,
you usual l y expect to see onl y Store 1 w hen you use the fi l ter
"store=1." So, i n thi s si tuati on, you shoul d choose thi s opti on to
make sure the fi l ter i s appl i ed i n the fi nal pass.

l A pply filter to passes touching warehouse tables and last join

pass: The fi l ter i n the fi nal pass i s al w ays appl i ed, even though i t i s
not a dow nw ard j oi n. Thi s opti on shoul d be used for speci al types
of data model i ng. For exampl e, you have R egi on, Store Sal es, and
Store C ost on the report, w i th the fi l ter "Year=2002." Thi s l ooks l i ke
a normal report and the fi nal pass j oi ns from Store to R egi on l evel .
But the schema i s abnormal : certai n stores do not al w ays bel ong to
the same regi on, perhaps due to rezoni ng. For exampl e, Store 1
bel ongs to R egi on 1 i n 2002, and bel ongs to R egi on 2 i n 2003. To
sol ve thi s probl em, put an addi ti onal col umn Year i n LOOKU P_
STOR E so that you have the fol l ow i ng data.

© 2019, M icr o St r at egy In c. 15 17

Syst em Ad m in ist r at io n Gu id e

Sto re Reg io n Year

1 1 2002

1 2 2003

...

Appl y the fi l ter Year=2002 to your report. Thi s fi l ter must be appl i ed i n
the fi nal pass to fi nd the correct store-regi on rel ati onshi p, even
though the fi nal pass i s a normal j oi n i nstead of a dow nw ard j oi n.

Int er act i on w i t h Ot her VLDB Pr op er t i es

Tw o other VLD B properti es, D ow nw ard Outer Joi n Opti on and

Preserve Al l Lookup Tabl e El ements, have an opti on to appl y the
fi l ter. If you choose those opti ons, then the fi l ter i s appl i ed
accordi ngl y, regardl ess of w hat the val ue of Appl y Fi l ter Opti on i s.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

At t r ib u t e Elemen t Nu mb er Co u n t Met h o d
Attri bute El ement N umber C ount Method i s an advanced property that
i s hi dden by defaul t. For i nformati on on how to di spl ay thi s property,
see Vi ew i ng and C hangi ng Advanced VLD B Properti es, page 1330.

The i ncremental fetch feature uses a SELEC T C OU N T D ISTIN C T

query, i ntroduced i n Mi croStrategy versi on 7.1.6. In some cases, thi s
query can be costl y for the data w arehouse and make the el ement
brow se ti me l onger than necessary for certai n producti on
envi ronments.

15 18 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To al l evi ate thi s probl em, the Attri bute El ement N umber C ount
Method control s how the total number of row s are cal cul ated. You
have the fol l ow i ng opti ons:

l U se C ount(A ttribute@ ID ) to calculate total element number

(uses count distinct if necessary) (defaul t): In thi s case, the
database determi nes the total number of row s.

l U se OD B C cursor to calculate the total element number: Thi s

setti ng causes Intel l i gence Server to determi ne the total number of
row s by l oopi ng through the tabl e after the i ni ti al SELEC T pass.

The di fference betw een the tw o approaches i s w hether the database

or Intel l i gence Server determi nes the total number of records.
Mi croStrategy recommends usi ng the "U se OD BC cursor..." opti on
(havi ng Intel l i gence Server determi ne the total number of records) i f
you have a heavi l y taxed data w arehouse or i f the SELEC T C OU N T
D ISTIN C T query i tsel f i ntroduces contenti on i n the database. H avi ng
Intel l i gence Server determi ne the total number of row s resul ts i n more
traffi c betw een Intel l i gence Server and the database.

For Tandem databas es , the default is Us e ODBC Curs or to c alc ulate the
total element number.

Level s at Whi ch You Can Set Thi s

D atabase i nstance onl y

Co u n t Dist in ct wit h Par t it io n s

C ount D i sti nct w i th Parti ti ons i s an advanced property that i s hi dden
by defaul t. For i nformati on on how to di spl ay thi s property, see
Vi ew i ng and C hangi ng Advanced VLD B Properti es, page 1330.

Thi s property can hel p i mprove the performance of queri es performed

on mul ti pl e parti ti oned tabl es w hi ch return a di sti nct count of val ues.
A di sti nct count of val ues al l ow s you to return i nformati on such as

© 2019, M icr o St r at egy In c. 15 19

Syst em Ad m in ist r at io n Gu id e

how many di sti nct types of i tems w ere sol d on a gi ven day. You have
the fol l ow i ng opti ons:

l D o not select distinct elements for each partition (defaul t): To

return a di sti nct count of val ues from mul ti pl e parti ti on tabl es, the
tabl es are fi rst combi ned together as one l arge resul t tabl e, and
then the count di sti nct cal cul ati on i s performed. Whi l e thi s returns
the proper resul ts, combi ni ng mul ti pl e tabl es i nto one tabl e to
perform the count di sti nct cal cul ati on can be a resource-i ntensi ve
query.

l Select distinct elements for each partition: To return a di sti nct

count of val ues from mul ti pl e parti ti oned tabl es, the si ze of each
parti ti on tabl e i s fi rst reduced by returni ng onl y di sti nct val ues.
These smal l er tabl es are then combi ned and a count di sti nct
cal cul ati on i s performed. Thi s can i mprove performance by reduci ng
the si ze of the parti ti on tabl es before they are combi ned for the fi nal
count di sti nct cal cul ati on.

Level s at Whi ch You Can Set Thi s

Metri c, report, templ ate, and database i nstance

Cu st o m Gr o u p Ban d in g Co u n t Met h o d
C ustom Group Bandi ng C ount Method i s an advanced property that i s
hi dden by defaul t. For i nformati on on how to di spl ay thi s property, see
Vi ew i ng and C hangi ng Advanced VLD B Properti es, page 1330.

The C ustom Group Bandi ng C ount Method hel ps opti mi ze custom

group bandi ng w hen usi ng the C ount Bandi ng method. You have the
fol l ow i ng opti ons:

l Treat banding as normal calculation (defaul t): Sel ect thi s opti on
to al l ow the Mi croStrategy Anal yti cal Engi ne to perform the custom

15 20 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

group bandi ng.

l U se standard case statement syntax: Sel ect thi s opti on to uti l i ze

case statements w i thi n your database to perform the custom group
bandi ng.

l Insert band range to database and join with metric value: Sel ect
thi s opti on to use temporary tabl es to perform the custom group
bandi ng.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Exam p l es

The fol l ow i ng SQL exampl es w ere created i n Mi croStrategy Tutori al .

The report contai ns a C ustom Group "C ustomer Val ue Bandi ng",
w hi ch uses the C ount method and the R evenue metri c. The SQL for
each of the three setti ngs for thi s property i s presented bel ow . Al l
three opti ons start w i th the same SQL passes. In thi s exampl e, the
fi rst si x passes are the same. The remai ni ng SQL passes di ffer
dependi ng on the C ustom Group Bandi ng C ount Method setti ng
sel ected.

create table ZZMD00 (CUSTOMER_ID SHORT, WJXBFS1 DOUBLE)

insert into ZZMD00
select a11.CUSTOMER_ID AS CUSTOMER_ID, a11.TOT_DOLLAR_SALES
as WJXBFS1
from CUSTOMER_SLS a11
create table ZZMD01 (WJXBFS1 DOUBLE)
insert into ZZMD01
select sum(a11.TOT_DOLLAR_SALES) as WJXBFS1
from YR_CATEGORY_SLS a11
select pa1.CUSTOMER_ID AS CUSTOMER_ID,
(pa1.WJXBFS1 / pa2.WJXBFS1) as WJXBFS1
from ZZMD00 pa1, ZZMD01 pa2
create table ZZMQ02 (CUSTOMER_ID SHORT, DA57 LONG)
[Placeholder for an analytical SQL]
insert into ZZMQ02 values (DummyInsertValue)

© 2019, M icr o St r at egy In c. 15 21

Syst em Ad m in ist r at io n Gu id e

Treat banding as normal calculation (defaul t)

select sum(a11.TOT_DOLLAR_SALES) as WJXBFS1

from CUSTOMER_SLS a11, ZZMQ02 a12
where a11.CUSTOMER_ID = a12.CUSTOMER_ID
select a12.DA57 AS DA57, sum(a11.TOT_DOLLAR_SALES)
as WJXBFS1
from CUSTOMER_SLS a11, ZZMQ02 a12
where a11.CUSTOMER_ID = a12.CUSTOMER_ID
group by a12.DA57
drop table ZZMD00
drop table ZZMD01
drop table ZZMQ02

Use standard case statement syntax

create table ZZOP03 (CUSTOMER_ID SHORT, DA57 LONG)

insert into ZZOP03
select pa3.CUSTOMER_ID AS CUSTOMER_ID,
(case
when (pa3.WJXBFS1 >=1 and pa3.WJXBFS1 < 100.9)
then 1
when (pa3.WJXBFS1 >= 100.9 and pa3.WJXBFS1 200.8)
then 2
when (pa3.WJXBFS1 >= 200.8 and pa3.WJXBFS1 300.7)
then 3
when (pa3.WJXBFS1 >= 300.7 and pa3.WJXBFS1 400.6)
then 4
when (pa3.WJXBFS1 >= 400.6 and pa3.WJXBFS1 500.5)
then 5
when (pa3.WJXBFS1 >= 500.5 and pa3.WJXBFS1 600.4)
then 6
when (pa3.WJXBFS1 >= 600.4 and pa3.WJXBFS1 700.3)
then 7
when (pa3.WJXBFS1 >= 700.3 and pa3.WJXBFS1 800.2)
then 8
when (pa3.WJXBFS1 >= 800.2 and pa3.WJXBFS1 900.1)
then 9
when (pa3.WJXBFS1 >= 900.1 and pa3.WJXBFS1 <= 1000
then 10
end) as DA57
from ZZMQ02 pa3
select sum(a11.TOT_DOLLAR_SALES) as WJXBFS1
from CUSTOMER_SLS a11, ZZOP03 a12
where a11.CUSTOMER_ID = a12.CUSTOMER_ID
select a12.DA57 AS DA57, sum(a11.TOT_DOLLAR_SALES)

15 22 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

as WJXBFS1
from CUSTOMER_SLS a11, ZZOP03 a12
where a11.CUSTOMER_ID = a12.CUSTOMER_ID
group by a12.DA57
drop table ZZMD00
drop table ZZMD01
drop table ZZMQ02
drop table ZZOP03

Insert band range to database and join with metric value

create table ZZOP03 (BandNo LONG, BandStart DOUBLE,

BandEnd DOUBLE)
insert into ZZOP03 values (1, 1, 100.9)
[Insertions for other bands]
create table ZZOP04 (CUSTOMER_ID SHORT, DA57 LONG)
insert into ZZOP04
select pa3.CUSTOMER_ID AS CUSTOMER_ID, pa4.BandNo as DA57
from ZZMQ02 pa3, ZZOP03 pa4
where ((pa3.WJXBFS1 >= pa4.BandStart
and pa3.WJXBFS1 < pa4.BandEnd)
or (pa3.WJXBFS1 = pa4.BandEnd
and pa4.BandNo = 10))
select sum(a11.TOT_DOLLAR_SALES) as WJXBFS1
from CUSTOMER_SLS a11, ZZOP04 a12
where a11.CUSTOMER_ID = a12.CUSTOMER_ID
select a12.DA57 AS DA57, sum(a11.TOT_DOLLAR_SALES)
as WJXBFS1
from CUSTOMER_SLS a11, ZZOP04 a12
where a11.CUSTOMER_ID = a12.CUSTOMER_ID
group by a12.DA57
drop table ZZMD00
drop table ZZMD01
drop table ZZMQ02
drop table ZZOP03
drop table ZZOP04

Cu st o m Gr o u p Ban d in g Po in t s Met h o d
C ustom Group Bandi ng Poi nt Method i s an advanced property that i s
hi dden by defaul t. For i nformati on on how to di spl ay thi s property, see
Vi ew i ng and C hangi ng Advanced VLD B Properti es, page 1330.

© 2019, M icr o St r at egy In c. 15 23

Syst em Ad m in ist r at io n Gu id e

The C ustom Group Bandi ng Poi nts Method hel ps opti mi ze custom
group bandi ng w hen usi ng the Poi nts Bandi ng method. You can
choose to use the standard method that uses the Anal yti cal Engi ne or
database-speci fi c syntax, or you can choose to use case statements
or temp tabl es.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Exam p l es

The fol l ow i ng SQL exampl es w ere created i n Mi croStrategy Tutori al .

The report contai ns a C ustom Group "C ustomer Val ue Bandi ng" usi ng
the poi nt method and the R evenue metri c. The SQL for each of the
three setti ngs for thi s property i s presented bel ow . Al l three opti ons
start w i th the same SQL passes. In thi s exampl e, the fi rst si x passes
are the same. The remai ni ng SQL passes di ffer dependi ng on the
C ustom Group Bandi ng C ount Method sel ected.

create table ZZMD00 (CUSTOMER_ID SHORT, WJXBFS1 DOUBLE)

insert into ZZMD00
select a11.CUSTOMER_ID AS CUSTOMER_ID, a11.TOT_DOLLAR_SALES
as WJXBFS1
from CUSTOMER_SLS a11
create table ZZMD01 (WJXBFS1 DOUBLE)
insert into ZZMD01
select sum(a11.TOT_DOLLAR_SALES) as WJXBFS1
from YR_CATEGORY_SLS a11
select pa1.CUSTOMER_ID AS CUSTOMER_ID,
(pa1.WJXBFS1 / pa2.WJXBFS1) as WJXBFS1
from ZZMD00 pa1, ZZMD01 pa2
create table ZZMQ02 (CUSTOMER_ID SHORT, DA57 LONG)
[Placeholder for an analytical SQL]
insert into ZZMQ02 values (DummyInsertValue)

Treat banding as normal calculation (defaul t)

select sum(a11.TOT_DOLLAR_SALES) as WJXBFS1

from CUSTOMER_SLS a11, ZZMQ02 a12
where a11.CUSTOMER_ID = a12.CUSTOMER_ID

15 24 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

select a12.DA57 AS DA57, sum(a11.TOT_DOLLAR_SALES)

as WJXBFS1
from CUSTOMER_SLS a11, ZZMQ02 a12
where a11.CUSTOMER_ID = a12.CUSTOMER_ID
group by a12.DA57
drop table ZZMD00
drop table ZZMD01
drop table ZZMQ02
Use standard case statement syntax
create table ZZOP03 (CUSTOMER_ID SHORT, DA57 LONG)
insert into ZZOP03
select pa3.CUSTOMER_ID AS CUSTOMER_ID,
(case
when (pa3.WJXBFS1 >= 1 and pa3.WJXBFS1 < 2) then 1
when (pa3.WJXBFS1 >= 2 and pa3.WJXBFS1 <= 3)then 2
end) as DA57
from ZZMQ02 pa3
select sum(a11.TOT_DOLLAR_SALES) as WJXBFS1
from CUSTOMER_SLS a11, ZZOP03 a12
where a11.CUSTOMER_ID = a12.CUSTOMER_ID
select a12.DA57 AS DA57, sum(a11.TOT_DOLLAR_SALES)
as WJXBFS1
from CUSTOMER_SLS a11, ZZOP03 a12
where a11.CUSTOMER_ID = a12.CUSTOMER_ID
group by a12.DA57
drop table ZZMD00
drop table ZZMD01
drop table ZZMQ02
drop table ZZOP03

Insert band range to database and join with metric value

create table ZZOP03 (BandNo LONG, BandStart DOUBLE,

BandEnd DOUBLE)
insert into ZZOP03 values (1, 1, 2)
[Insertions for other bands]
create table ZZOP04 (CUSTOMER_ID SHORT, DA57 LONG)
insert into ZZOP04
select pa3.CUSTOMER_ID AS CUSTOMER_ID, pa4.BandNo as DA57
from ZZMQ02 pa3, ZZOP03 pa4
where ((pa3.WJXBFS1 >= pa4.BandStart
and pa3.WJXBFS1 < pa4.BandEnd)
or (pa3.WJXBFS1 = pa4.BandEnd
and pa4.BandNo = 2))
select sum(a11.TOT_DOLLAR_SALES) as WJXBFS1

© 2019, M icr o St r at egy In c. 15 25

Syst em Ad m in ist r at io n Gu id e

from CUSTOMER_SLS a11, ZZOP04 a12

where a11.CUSTOMER_ID = a12.CUSTOMER_ID
select a12.DA57 AS DA57, sum(a11.TOT_DOLLAR_SALES)
as WJXBFS1
from CUSTOMER_SLS a11, ZZOP04 a12
where a11.CUSTOMER_ID = a12.CUSTOMER_ID
group by a12.DA57
drop table ZZMD00
drop table ZZMD01
drop table ZZMQ02
drop table ZZOP03
drop table ZZOP04

Cu st o m Gr o u p Ban d in g Size Met h o d

C ustom Group Bandi ng Si ze Method i s an advanced property that i s
hi dden by defaul t. For i nformati on on how to di spl ay thi s property, see
Vi ew i ng and C hangi ng Advanced VLD B Properti es, page 1330.

The C ustom Group Bandi ng Si ze Method hel ps opti mi ze custom group

bandi ng w hen usi ng the Si ze Bandi ng method. You can choose to use
the standard method that uses the Anal yti cal Engi ne or database-
speci fi c syntax, or you can choose to use case statements or temp
tabl es.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Exam p l es

The fol l ow i ng SQL exampl es w ere created i n Mi croStrategy Tutori al .

The report contai ns a C ustom Group "C ustomer Val ue Bandi ng" that
uses the si ze method and the R evenue metri c. The SQL for each of
the three setti ngs for thi s property i s presented bel ow . Al l three
opti ons start w i th the same SQL passes. In thi s exampl e, the fi rst si x
passes are the same. The remai ni ng SQL passes di ffer dependi ng on
the C ustom Group Bandi ng C ount Method sel ected.

create table ZZMD000 (CUSTOMER_ID SHORT, WJXBFS1 DOUBLE)

15 26 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

insert into ZZMD000

select a11.CUSTOMER_ID AS CUSTOMER_ID, a11.TOT_DOLLAR_SALES
as WJXBFS1
from CUSTOMER_SLS a11
create table ZZMD001 (WJXBFS1 DOUBLE)
insert into ZZMD001
select sum(a11.TOT_DOLLAR_SALES) as WJXBFS1
from YR_CATEGORY_SLS a11
select pa1.CUSTOMER_ID AS CUSTOMER_ID,
(pa1.WJXBFS1 / pa2.WJXBFS1) as WJXBFS1
from ZZMD000 pa1, ZZMD001 pa2
create table ZZMQ002 (CUSTOMER_ID SHORT, WJXBFS1 DOUBLE)
[Placeholder for an Analytical SQL]
insert into ZZMQ02 values (DummyInsertValue)

Treat banding as normal calculation

select sum(a11.TOT_DOLLAR_SALES) as WJXBFS1

from CUSTOMER_SLS a11, ZZMQ002 a12
where a11.CUSTOMER_ID = a12.CUSTOMER_ID
select a12.DA57 AS DA57, sum(a11.TOT_DOLLAR_SALES)
as WJXBFS1
from CUSTOMER_SLS a11, ZZMQ002 a12
where a11.CUSTOMER_ID = a12.CUSTOMER_ID
group by a12.DA57
drop table ZZMD000
drop table ZZMD001
drop table ZZMQ002

Use standard CASE statement syntax

create table ZZOP003 (CUSTOMER_ID SHORT, DA57 LONG)

insert into ZZOP003
select pa3.CUSTOMER_ID AS CUSTOMER_ID,
(case
when (pa3.WJXBFS1 >= 0 and pa3.WJXBFS1 < .2) then 1
when (pa3.WJXBFS1 >= .2 and pa3.WJXBFS1 < .4)then 2
when (pa3.WJXBFS1 >= .4 and pa3.WJXBFS1 < .6)then 3
when (pa3.WJXBFS1 >= .6 and pa3.WJXBFS1 < .8)then 4
when (pa3.WJXBFS1 >= .8 and pa3.WJXBFS1 <= 1)then 5
end) as DA57
from ZZMQ002 pa3
drop table ZZMD000
drop table ZZMD001
drop table ZZMQ002
drop table ZZOP003

© 2019, M icr o St r at egy In c. 15 27

Syst em Ad m in ist r at io n Gu id e

Insert band range to database and join with metric value

create table ZZOP003 (BandNo LONG, BandStart DOUBLE,

BandEnd DOUBLE)
insert into ZZOP003 values (1, 0, .2)
[Insertions for other bands]
create table ZZOP004 (
CUSTOMER_ID SHORT,
DA57 LONG)
insert into ZZOP004
select pa3.CUSTOMER_ID AS CUSTOMER_ID, pa4.BandNo as DA57
from ZZMQ002 pa3, ZZOP003 pa4
where ((pa3.WJXBFS1 >= pa4.BandStart
and pa3.WJXBFS1 < pa4.BandEnd)
or (pa3.WJXBFS1 = pa4.BandEnd
and pa4.BandNo = 5))
select sum(a11.TOT_DOLLAR_SALES) as WJXBFS1
from CUSTOMER_SLS a11, ZZOP004 a12
where a11.CUSTOMER_ID = a12.CUSTOMER_ID
select a12.DA57 AS DA57,sum(a11.TOT_DOLLAR_SALES) as WJXBFS1
from CUSTOMER_SLS a11, ZZOP004 a12
where a11.CUSTOMER_ID = a12.CUSTOMER_ID
group by a12.DA57
drop table ZZMD000
drop table ZZMD001
drop table ZZMQ002
drop table ZZOP003
drop table ZZOP004

Dat a Po p u lat io n f o r In t elligen t Cu b es

The D ata popul ati on for Intel l i gent C ubes VLD B property al l ow s you
to defi ne i f and how Intel l i gent C ube data i s normal i zed to save
memory resources.

When an Intel l i gent C ube i s publ i shed, the descri pti on i nformati on for
the attri butes (al l data mapped to non-ID attri bute forms) i ncl uded on
the Intel l i gent C ube i s repeated for every row . For exampl e, an
Intel l i gent C ube i ncl udes the attri butes R egi on and Store, w i th each
regi on havi ng one or more stores. Wi thout performi ng normal i zati on,
the descri pti on i nformati on for the R egi on attri bute w oul d be repeated

15 28 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

for every store. If the South regi on i ncl uded fi ve stores, then the
i nformati on for South w oul d be repeated fi ve ti mes.

You can avoi d thi s dupl i cati on of data by normal i zi ng the Intel l i gent
C ube data. In thi s scenari o, the South regi on descri pti on i nformati on
w oul d onl y be stored once even though the regi on contai ns fi ve
stores. Whi l e thi s saves memory resources, the act of normal i zati on
requi res some processi ng ti me. Thi s VLD B property provi des the
fol l ow i ng opti ons to determi ne i f and how Intel l i gent C ube data i s
normal i zed:

l D o not normalize Intelligent C ube data: Intel l i gent C ube data i s

not normal i zed. The memory resources requi red for the Intel l i gent
C ube may be far greater than i f one of the other normal i zati on
opti ons i s performed. Thi s opti on i s best sui ted for troubl eshooti ng
purposes onl y.

l N ormalize Intelligent C ube data in Intelligence Server (defaul t):

Intel l i gence Server performs the Intel l i gent C ube data
normal i zati on. Thi s typi cal l y processes the normal i zati on faster
than the other normal i zati on opti ons, but al so requi res memory
resources of Intel l i gence Server.

Thi s i s a good opti on i f you publ i sh your Intel l i gent C ubes at ti mes
w hen Intel l i gence Server use i s l ow . N ormal i zati on can then be
performed w i thout affecti ng your user communi ty. You can use
schedul es to support thi s strategy. For i nformati on on usi ng
schedul es to publ i sh Intel l i gent C ubes, see the In-memory Anal yti cs
Gui de .

l The other opti ons avai l abl e for Intel l i gent C ube normal i zati on al l
perform the normal i zati on w i thi n the database. Therefore, these are
al l good opti ons i f Intel l i gent C ubes are publ i shed w hen
Intel l i gence Server i s i n use by the user communi ty, or any ti me
w hen the memory resources of Intel l i gence Server must be
conserved.

© 2019, M icr o St r at egy In c. 15 29

Syst em Ad m in ist r at io n Gu id e

You can see i mproved performance w i th the database normal i zati on

techni ques i f the Intel l i gent C ube i s retri evi ng a l arge rati o of
repeati ng data. H ow ever, normal i zi ng data w i thi n the database i s
typi cal l y sl ow er than normal i zi ng the data i n Intel l i gence Server.
Each database normal i zati on techni que i s descri bed bel ow :

l N ormalize Intelligent C ube data in database using

Intermediate Table Type: Thi s opti on i s no l onger avai l abl e. If
you upgraded a proj ect from versi on 9.0.0 and thi s opti on w as i n
use, thi s opti on i s sti l l used unti l you manual l y sel ect a di fferent
opti on. Once you sel ect a di fferent opti on, you cannot revert to the
behavi or for thi s opti on.

If you used thi s opti on i n 9.0.0 and have upgraded to the most
recent versi on of Mi croStrategy, i t i s recommended that you use a
di fferent Intel l i gent C ube normal i zati on techni que. If the user
account for the data w arehouse has permi ssi ons to create tabl es,
sw i tch to the opti on N ormalize Intelligent C ube data in the
database. Thi s opti on i s descri bed bel ow . If the user account
does not have permi ssi ons to create tabl es, sw i tch to the opti on
N ormalize Intelligent C ube data in Intelligence Server.

l N ormalize Intelligent C ube data in the database: Thi s database

normal i zati on i s a good opti on i f attri bute data and fact data are
stored i n the same tabl e.

To use thi s opti on, the user account for the database must have
permi ssi ons to create tabl es.

l N ormalize Intelligent C ube data in the database using

relationship tables: Thi s database normal i zati on i s a good opti on
i f attri bute data and fact data are stored i n separate tabl es.

To use thi s opti on, the user account for the database must have
permi ssi ons to create tabl es.

15 30 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l D irect loading of dimensional data and filtered fact data: Thi s

database normal i zati on i s a good opti on i f attri bute data and fact
data are stored i n separate tabl es, and the Intel l i gent C ube
i ncl udes the maj ori ty of the attri bute el ements for each attri bute i t
uses.

This is a res ourc e-intens iv e option, and for v ery large Intelligent
Cubes , enabling this s etting may deplete y our Intelligenc e Serv er's
s y s tem memory .

To use thi s opti on, the user account for the database must have
permi ssi ons to create tabl es. Addi ti onal l y, usi ng thi s opti on can
return di fferent resul ts than the other Intel l i gent C ube
normal i zati on techni ques. For i nformati on on these di fferences,
see D ata D i fferences w hen N ormal i zi ng Intel l i gent C ube D ata
U si ng D i rect Loadi ng, page 1531 bel ow .

Dat a Di f f er ences w hen N or m al i zi ng Int el l i gent Cub e Dat a U si ng Di r ect

Load i ng

The opti on D irect loading of dimensional data and filtered fact

data can return di fferent resul ts than the other Intel l i gent C ube
normal i zati on techni ques i n certai n scenari os. Some of these
scenari os and the effect that they have on usi ng di rect l oadi ng for
Intel l i gent C ube normal i zati on are descri bed bel ow :

l There are extra row s of data i n fact tabl es that are not avai l abl e i n
the attri bute l ookup tabl e. In thi s case the VLD B property Preserve
al l fi nal pass resul t el ements (see R el ati ng C ol umn D ata w i th SQL:
Joi ns, page 1387) determi nes how to process the data. The onl y
di fference betw een di rect l oadi ng and the other normal i zati on
opti ons i s that the opti on Preserve al l fi nal resul t pass el ements and
the opti on Preserve al l el ements of fi nal pass resul t tabl e w i th
respect to l ookup tabl e but not rel ati onshi p tabl e both preserve the

© 2019, M icr o St r at egy In c. 15 31

Syst em Ad m in ist r at io n Gu id e

extra row s by addi ng them to the l ookup tabl e.

l There are extra row s of data i n the attri bute l ookup tabl es that are
not avai l abl e i n the fact tabl es. Wi th di rect l oadi ng, these extra row s
are i ncl uded. For other normal i zati on techni ques, the VLD B
property Preserve al l l ookup tabl e el ements (see R el ati ng C ol umn
D ata w i th SQL: Joi ns, page 1387) determi nes w hether or not to
i ncl ude these row s.

l The Intel l i gent C ube i ncl udes metri cs that use OLAP functi ons. If an
Intel l i gent C ube i ncl udes metri cs that use OLAP functi ons, you
shoul d use an Intel l i gent C ube normal i zati on techni que other than
the di rect l oadi ng techni que to ensure that the data returned i s
accurate.

OLAP functi ons are functi ons such as R u n n i n g S u m, M o v i n g A v g,

and O LA PM a x . For i nformati on about how to use OLAP functi ons,
see the Functi ons R eference.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Dat a Po p u lat io n f o r Rep o r t s

The D ata popul ati on for reports VLD B property al l ow s you to defi ne i f
and how report data i s normal i zed to save memory resources.

When a report i s executed, the descri pti on i nformati on for the

attri butes (al l data mapped to non-ID attri bute forms) i ncl uded on the
report i s repeated for every row . For exampl e, a report i ncl udes the
attri butes R egi on and Store, w i th each regi on havi ng one or more
stores. Wi thout performi ng normal i zati on, the descri pti on i nformati on
for the R egi on attri bute w oul d be repeated for every store. If the South
regi on i ncl uded fi ve stores, then the i nformati on for South w oul d be
repeated fi ve ti mes.

15 32 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

You can avoi d thi s dupl i cati on of data by normal i zi ng the report data.
In thi s scenari o, the South regi on descri pti on i nformati on w oul d onl y
be stored once even though the regi on contai ns fi ve stores. Whi l e thi s
saves memory resources, the act of normal i zati on requi res some
processi ng ti me. Thi s VLD B property provi des the fol l ow i ng opti ons to
determi ne i f and how report data i s normal i zed:

l D o not normalize report data (defaul t): R eport data i s not

normal i zed. Whi l e no extra processi ng i s requi red to normal i ze the
report data, the memory resources requi red for the report are l arger
than i f normal i zati on w as performed. H ow ever, reports commonl y do
not return l arge resul t sets and thus do not suffer from performance
i ssues rel ated to thi s dupl i cati on of data. Therefore, thi s opti on i s
the defaul t for al l reports.

l N ormalize report data in Intelligence Server: Intel l i gence Server

performs the report data normal i zati on. Thi s typi cal l y processes the
normal i zati on faster than the other normal i zati on opti ons, but al so
requi res memory resources of Intel l i gence Server. Thi s i s a good
opti on i f report performance i s the top pri ori ty.

l The other opti ons avai l abl e for report data normal i zati on al l perform
the normal i zati on w i thi n the database. Therefore, these are al l good
opti ons i f the memory resources of Intel l i gence Server must be
conserved.

You can see i mproved performance w i th the database normal i zati on

techni ques i f the report i s retri evi ng a l arge rati o of repeati ng data.
H ow ever, normal i zi ng data w i thi n the database i s typi cal l y sl ow er
than normal i zi ng the data i n Intel l i gence Server. Each database
normal i zati on techni que i s descri bed bel ow :

l N ormalize report data in database using Intermediate Table

Type: Thi s opti on i s no l onger avai l abl e. If you upgraded a proj ect
from versi on 9.0.0 and thi s opti on w as i n use, thi s opti on i s sti l l
used unti l you manual l y sel ect a di fferent opti on. Once you sel ect

© 2019, M icr o St r at egy In c. 15 33

Syst em Ad m in ist r at io n Gu id e

a di fferent opti on, you cannot revert to the behavi or for thi s opti on.

If you used thi s opti on i n 9.0.0 and have upgraded to the most
recent versi on of Mi croStrategy, i t i s recommended that you use a
di fferent report data normal i zati on techni que. If the user account
for the data w arehouse has permi ssi ons to create tabl es, sw i tch to
the opti on N ormalize report data in the database. Thi s opti on i s
descri bed bel ow . If the user account does not have permi ssi ons to
create tabl es, sw i tch to the opti on N ormalize report data in
Intelligence Server.

l N ormalize report data in the database: Thi s database

normal i zati on i s a good opti on i f attri bute data and fact data are
stored i n the same tabl e.

To use thi s opti on, the user account for the database must have
permi ssi ons to create tabl es.

l N ormalize report data in the database using relationship

tables: Thi s database normal i zati on i s a good opti on i f attri bute
data and fact data are stored i n separate tabl es.

To use thi s opti on, the user account for the database must have
permi ssi ons to create tabl es.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Def au lt So r t Beh avio r f o r At t r ib u t e Elemen t s in Rep o r t s

The D efaul t Sort Behavi or for Attri bute El ements i n R eports VLD B
property determi nes w hether the sort order of attri bute el ements on
reports consi ders speci al sort order formatti ng defi ned for attri butes:

15 34 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Sort attribute elements based on the attribute ID form for each

attribute (default): R eports automati cal l y use the attri bute ID form
to sort the resul ts of a report. Thi s i s the defaul t behavi or seen pri or
to defi ni ng any sorti ng opti ons for the report. If you defi ne a report
to use the defaul t advanced sorti ng for an attri bute, any sorti ng
defi ned for the attri bute forms of the attri bute are then appl i ed to the
report. For i nformati on on advanced sorti ng for reports, see the
Advanced R eporti ng Gui de.

l Sort attribute elements based on the defined 'R eport Sort'

setting of all attribute forms for each attribute: R eports
automati cal l y use any sorti ng defi ned for the attri bute forms of the
attri bute. In thi s scenari o, no advanced sorti ng needs to be defi ned
for a report to consi der any attri bute form sorti ng defi ned for the
attri butes on the report.

An exampl e of w here thi s opti on can be hel pful i s w hen an attri bute
has an attri bute form that i s used sol el y for sorti ng the el ements of
an attri bute on a report. An attri bute form l i ke thi s can be requi red i f
the ID val ues do not represent the order i n w hi ch the attri bute
el ements shoul d be di spl ayed by defaul t on the report, and the
speci fi cs of the sort order are not rel evant and therefore shoul d not
be di spl ayed to report anal ysts. Thi s sort order col umn can be
added to the attri bute, defi ned w i th a speci fi c sort order for the
attri bute, and al so defi ned to not be i ncl uded as an avai l abl e report
form. By defi ni ng the attri bute form i n thi s w ay and sel ecti ng thi s
VLD B property opti on, the attri bute form i s not di spl ayed on reports,
but i t i s sti l l used to automati cal l y sort the val ues of the report
w i thout havi ng to defi ne any advanced sorti ng for the report.

Level s at Whi ch You Can Set Thi s

D atabase i nstance onl y

© 2019, M icr o St r at egy In c. 15 35

Syst em Ad m in ist r at io n Gu id e

Dimen sio n alit y Mo d el

D i mensi onal i ty Model i s an advanced property that i s hi dden by
defaul t. For i nformati on on how to di spl ay thi s property, see Vi ew i ng
and C hangi ng Advanced VLD B Properti es, page 1330.

The Dimens ionality Model property is s tric tly for bac k ward c ompatibility
with Mic roStrategy 6.x or earlier.

l U se relational model (defaul t): For al l proj ects, U se rel ati onal
model i s the defaul t val ue. Wi th the U se rel ati onal model setti ng, al l
the di mensi onal i ty (l evel ) resol uti on i s based on the rel ati onshi p
betw een attri butes.

l U se dimensional model: The U se di mensi onal model setti ng i s for

cases w here attri bute rel ati onshi p di mensi onal i ty (l evel ) resol uti on
i s di fferent from di mensi on-based resol uti on. There are very few
cases w hen the setti ng needs to be changed to U se di mensi onal
model . The fol l ow i ng si tuati ons may requi re the U se di mensi onal
model setti ng:

l Metri c C ondi ti onal i ty: You have a report w i th the Year attri bute
and the "Top 3 Stores D ol l ar Sal es" metri c on the templ ate and
the fi l ters Store, R egi on, and Year. Therefore, the metri c has a
metri c condi ti onal i ty of "Top 3 Stores."

If y ou c hange the default of the Remov e related report filter element

option in adv anc ed c onditionality , the Us e dimens ional model
s etting does not mak e a differenc e in the report. For more
information regarding this adv anc ed s etting, s ee the Metri cs
c hapter in the Advanced R eporti ng Gui de .

l Metri c D i mensi onal i ty R esol uti on: Mi croStrategy 7.x and l ater
does not have the concept of di mensi on, but i nstead has the
concept of metri c l evel . For a proj ect upgraded from 6.x to 7.x, the
di mensi on i nformati on i s kept i n the metadata. Attri butes created

15 36 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

i n 7.x do not have thi s i nformati on. For exampl e, you have a
report that contai ns the Year attri bute and the metri c "D ol l ar Sal es
by Geography." The metri c i s defi ned w i th the di mensi onal i ty of
Geography, w hi ch means the metri c i s cal cul ated at the l evel of
w hatever Geography attri bute i s on the templ ate. In Mi croStrategy
7.x and l ater, the metri c di mensi onal i ty i s i gnored and therefore
defaul ts to the report l evel or the l evel that i s defi ned for the
report.

l Anal ysi s l evel cal cul ati on: For the next si tuati on, consi der the
fol l ow i ng spl i t hi erarchy model .

Market and State are both parents of Store. A report has the
attri butes Market and State and a D ol l ar Sal es metri c w i th
report l evel di mensi onal i ty. In Mi croStrategy 7.x and l ater, w i th
the U se rel ati onal model setti ng, the report l evel (metri c
di mensi onal i ty l evel ) i s Market and State. To choose the best
fact tabl e to use to produce thi s report, the Anal yti cal Engi ne
consi ders both of these attri butes. Wi th the U se di mensi onal
model setti ng i n Mi croStrategy 7.x and l ater, Store i s used as
the metri c di mensi onal i ty l evel and for determi ni ng the best fact
tabl e to use. Thi s i s because Store i s the hi ghest common
descendent betw een the tw o attri butes.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

© 2019, M icr o St r at egy In c. 15 37

Syst em Ad m in ist r at io n Gu id e

En gin e At t r ib u t e Ro le Op t io n s
Engi ne Attri bute R ol e Opti ons i s an advanced property that i s hi dden
by defaul t. For i nformati on on how to di spl ay thi s property, see
Vi ew i ng and C hangi ng Advanced VLD B Properti es, page 1330.

The Engi ne Attri bute R ol e Opti ons property al l ow s you to share an

actual physi cal tabl e to defi ne mul ti pl e schema obj ects. There are tw o
approaches for thi s feature:

l The fi rst approach i s a procedure cal l ed tabl e al i asi ng, w here you
can defi ne mul ti pl e l ogi cal tabl es i n the schema that poi nt to the
same physi cal tabl e, and then defi ne di fferent attri butes and facts
on these l ogi cal tabl es. Tabl e al i asi ng provi des you a l i ttl e more
control and i s best w hen upgradi ng or w hen you have a compl ex
schema. Tabl e al i asi ng i s descri bed i n detai l i n the Proj ect D esi gn
Gui de.

l The second approach i s cal l ed Engi ne Attri bute R ol e. Wi th thi s

approach, rather than defi ni ng mul ti pl e l ogi cal tabl es, you onl y
need to defi ne mul ti pl e attri butes and facts on the same tabl e. The
Mi croStrategy Engi ne automati cal l y detects "mul ti pl e rol es" of
certai n attri butes and spl i ts the tabl e i nto mul ti pl e tabl es i nternal l y.
There i s a l i mi t on the number of tabl es i nto w hi ch a tabl e can spl i t.
Thi s l i mi t i s know n as the Attri bute R ol e l i mi t. Thi s l i mi t i s hard
coded to 128 tabl es. If you are a new Mi croStrategy user starti ng
w i th 7i or l ater, i t i s suggested that you use the automati c detecti on
(Engi ne Attri bute R ol e) opti on.

The al gori thm to spl i t the tabl e i s as fol l ow s:

l If tw o attri butes are defi ned on the same col umn from the same
tabl e, have the same expressi on, and are not rel ated, i t i s i mpl i ed
that they are pl ayi ng di fferent rol es and must be i n di fferent tabl es
after the spl i t.

15 38 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l If tw o attri butes are rel ated to each other, they must stay i n the
same tabl e after the spl i t.

l Attri butes shoul d be kept i n as many tabl es as possi bl e as l ong as

al gori thm 1 i s not vi ol ated.

Gi ven the di versi ty of data model i ng i n proj ects, the above al gori thm
cannot be guaranteed to spl i t tabl es correctl y i n al l si tuati ons. Thus,
thi s property i s added i n the VLD B properti es to turn the Engi ne
Attri bute R ol e on or off. When the feature i s turned off, the tabl e
spl i tti ng procedure i s bypassed.

Cor r ect U sage Exam p l e

Fact tabl e FT1 contai ns the col umns "Order_D ay," "Shi p_D ay," and
"Fact_1." Lookup tabl e LU _D AY has col umns "D ay," "Month," and
"Year." Attri butes "Shi p D ay" and "Order D ay" are defi ned on di fferent
col umns i n FT1, but they share the same col umn ("D ay") on LU _D AY.
Al so the attri butes "Shi p Month" and "Order Month" share the same
col umn "month" i n LU _D AY. The "Shi p Year" and "Order Year"
attri butes are the same as w el l . D uri ng the schema l oadi ng, the
Anal yti cal Engi ne detects the dupl i cated defi ni ti ons of attri butes on
col umn "D ay," "Month," and "Year." It automati cal l y spl i ts LU _D AY
i nto tw o i nternal tabl es, LU _D AY(1) and LU _D AY(2), both havi ng the
same physi cal tabl e name LU _D AY. As a resul t, the attri butes "Shi p
D ay," "Shi p Month," and "Shi p Year" are defi ned on LU _D AY(1) and
"Order D ay," "Order Month," and "Order Year" are defi ned on LU _D AY
(2). Such tabl e spl i tti ng al l ow s you to di spl ay Fact_1 that i s ordered
l ast year and shi pped thi s year.

The SQL appears as fol l ow s:

select a1.fact_1
from FT1 a1 join LU_DAY a2 on (a1.order_day=a2.day)
join LU_DAY a3 on (a1.ship_day = a3.day)
where a2.year = 2002 and
a3.year = 2003

© 2019, M icr o St r at egy In c. 15 39

Syst em Ad m in ist r at io n Gu id e

N ote that LU _D AY appears tw i ce i n the SQL, pl ayi ng di fferent "rol es."

Al so, note that i n thi s exampl e, the Anal yti cal Engi ne does not spl i t
tabl e FT1 because "Shi p D ay" and "Order D ay" are defi ned on
di fferent col umns.

Incor r ect U sage Exam p l e

Fact tabl e FT1 contai ns col umns "day" and "fact_1." "Shi p D ay" and
"Order D ay" are defi ned on col umn "day." The Anal yti cal Engi ne
detects that these tw o attri butes are defi ned on the same col umn and
therefore spl i ts FT1 i nto FT1(1) and FT1(2), w i th FT1(1) contai ni ng
"Shi p D ay" and "Fact 1", and FT(2) contai ni ng "Order D ay" and "Fact
1." If you put "Shi p D ay" and "Order D ay" on the templ ate, as w el l as
a metri c cal cul ati ng "Fact 1," the Anal yti cal Engi ne cannot fi nd such a
fact. Al though external l y, FT1 contai ns al l the necessary attri butes
and facts, i nternal l y, "Fact 1" onl y exi sts on ei ther "Shi p D ay" or
"Order D ay," but not both. In thi s case, to make the report w ork
(al though sti l l i ncorrectl y), you shoul d turn OFF the Engi ne Attri bute
R ol e feature.

l Bec aus e of bac k ward c ompatibility and bec aus e the Analy tic al
Engine's automatic s plitting of tables may be wrong for s ome data
models , this property 's default s etting is to turn OFF the Engine
Attribute Role feature.

l If this property is turned ON, and y ou us e this feature inc orrec tly , the
mos t c ommon error mes s age from the Analy tic al Engine is

Fact not found at requested level.

l This feature is turned OFF by default s tarting from 7 i Beta 2. Before

that, this feature was turned OFF for upgraded projec ts and turned ON
by default for new projec ts . So for s ome 7 i beta us ers , if y ou c reate a
new metadata us ing the Beta1 v ers ion of 7 i , this feature may be
turned on in y our metadata.

15 40 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l While updating the s c hema, if the Engine Attribute Role feature is ON,
and if the Attribute Role limit is ex c eeded, y ou may get an error
mes s age from the Engine. You get this error bec aus e there is a limit
on the number of tables into whic h a giv en table c an be s plit internally .
In this c as e, y ou s hould turn the Engine Attribute Role feature OFF
and us e table alias ing ins tead.

Level s at Whi ch You Can Set Thi s

D atabase i nstance onl y

Filt er Tr ee Op t imizat io n f o r Met r ic Qu alif icat io n s

Fi l ter tree opti mi zati on for metri c qual i fi cati ons i s an advanced
property that i s hi dden by defaul t. For i nformati on on how to di spl ay
thi s property, see Vi ew i ng and C hangi ng Advanced VLD B Properti es,
page 1330.

The Fi l ter tree opti mi zati on for metri c qual i fi cati ons property
determi nes w hether metri c qual i fi cati ons that are i ncl uded i n separate
passes of SQL are i ncl uded i n a si ngl e pass of SQL w hen possi bl e.
Metri c qual i fi cati ons can be i ncl uded i n separate passes of SQL i n
scenari os such as w hen the metri c qual i fi cati ons are used i n fi l ter
defi ni ti ons. H avi ng a metri c qual i fi cati on at each l ogi cal l evel of a
fi l ter qual i fi cati on can i ncl ude each metri c qual i fi cati on i n a separate
pass of SQL. For exampl e, consi der a fi l ter qual i fi cati on that i s
structured as fol l ow s:

(AttributeQualfication1 AND MetricQualification1) AND

(AttributeQualification2 AND MetricQualification2)

Si nce M et ri c Q u a l i f i c a t i o n 1 and M e t r i c Q u a l i f i c a t i o n 2 are

at separate l ogi cal l evel s of the fi l ter qual i fi cati on, thi s can cause
each metri c qual i fi cati on to requi re i ts ow n pass of SQL.

You have the fol l ow i ng opti ons for thi s VLD B property:

© 2019, M icr o St r at egy In c. 15 41

Syst em Ad m in ist r at io n Gu id e

l Enable Filter tree optimization for metric qualifications: D efi nes

metri c qual i fi cati ons to be i ncl uded i n the same pass of SQL i f
possi bl e. In the scenari o descri bed above,
Me tr ic Qu a l i f i c a t i o n 1 and M e t r i c Q u a l i f i c a t i o n 2 are
processed i n the same pass of SQL. Thi s can hel p to i mprove
performance by reduci ng the number of SQL passes requi red.

l D isable Filter tree optimization for metric qualifications: D efi nes

metri c qual i fi cati ons to be i ncl uded i n SQL passes based on thei r
l ogi cal l evel i n a fi l ter qual i fi cati on. In the scenari o descri bed
above, Me tr i c Q u a l i f i c a t i o n 1 and M e t r i c Q u a l i f i c a t i o n2
are processed i n di fferent passes of SQL.

Level s at Whi ch You Can Set Thi s

R eport and proj ect

In cr emen t al Dat a Tr an sf er
The Incremental D ata Transfer VLD B property determi nes w hether
data that i s transferred betw een Intel l i gence Server and a data source
i s performed usi ng a si ngl e transfer of data or mul ti pl e, i ncremental
transfers of data. Transferri ng data betw een Intel l i gence Server and a
data source can be requi red for Mi croStrategy features such as
Mi croStrategy Mul ti Source Opti on, data marts, bul k export to export
l arge reports as del i mi ted text fi l es, and other Anal yti cal Engi ne
features.

Thi s VLD B property has the fol l ow i ng opti ons:

l Enable Incremental D ata Transfer: D ata that i s transferred

betw een Intel l i gence Server and a data source i s transferred usi ng
mul ti pl e, i ncremental transfers of data. Thi s can i mprove
performance i n scenari os w here l arge amounts of data from
Intel l i gence Server are w ri tten to a data source. By transferri ng the

15 42 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

data i ncremental l y, some data can be w ri tten to the data source

w hi l e addi ti onal data i s retri eved through Intel l i gence Server.

l D isable Incremental D ata Transfer (defaul t): D ata that i s

transferred betw een Intel l i gence Server and a data source i s
transferred usi ng a si ngl e transfer of data.

Level s at Whi ch You Can Set Thi s

Proj ect and report

Maximu m Par allel Qu er ies Per Rep o r t

Maxi mum Paral l el Queri es Per R eport i s an advanced property that i s
hi dden by defaul t. For i nformati on on how to di spl ay thi s property, see
Vi ew i ng and C hangi ng Advanced VLD B Properti es, page 1330.

The Maxi mum Paral l el Queri es Per R eport property determi nes how
many queri es can be executed i n paral l el as part of paral l el query
executi on support. By defaul t, a maxi mum of tw o queri es can be
executed i n paral l el , and you can i ncrease thi s number to perform
addi ti onal queri es i n paral l el . For data that i s i ntegrated i nto
Mi croStrategy usi ng D ata Import, the defaul t maxi mum number of
queri es that can be executed i n paral l el i s fi ve. When determi ni ng thi s
maxi mum, consi der the fol l ow i ng:

l You must enabl e paral l el Query executi on to perform mul ti pl e

queri es i n paral l el . To enabl e paral l el Query executi on, see
Maxi mum Paral l el Queri es Per R eport, page 1543.

l The number of queri es executed i n paral l el i s al so dependent on

the report or Intel l i gent C ube that i s bei ng executed. For exampl e, i f
the maxi mum i s set to three but a report onl y uses tw o passes of
SQL, then onl y those tw o queri es can be performed i n paral l el .

l When mul ti pl e queri es are executed i n paral l el , thi s means that the
actual processi ng of the mul ti pl e queri es i s performed i n paral l el on

© 2019, M icr o St r at egy In c. 15 43

Syst em Ad m in ist r at io n Gu id e

the database. If a database i s requi red to do too many tasks at the

same ti me thi s can cause the response ti me of the database to sl ow
dow n, and thus degrade the overal l performance. You shoul d take
i nto account the databases used to retri eve data and thei r avai l abl e
resources w hen deci di ng how to restri ct paral l el Query executi on.

Level s at Whi ch You Can Set Thi s

Proj ect onl y

MD Par t it io n Pr eq u er y Op t io n
The purpose of the MD Parti ti on Prequery Opti on i s to fi nd out w hi ch
parti ti on base tabl e i s used. The report fi l ter i s combi ned w i th
parti ti on base tabl e fi l ters. If the i ntersecti on of both fi l ters i s not
empty, then the correspondi ng parti ti on base tabl e shoul d be used. A
SELEC T statement for each parti ti on base tabl e i s generated, and the
query resul t i s checked to see w hether i t i s empty.

There are mul ti pl e w ays to generate a SELEC T statement that checks

for the data, but the performance of the query can di ffer dependi ng on
the pl atform. The defaul t val ue for thi s property i s: "sel ect count(*) …"
for al l database pl atforms, except U D B, w hi ch uses "sel ect di sti nct
1…"

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Mu lt ip le Dat a So u r ce Su p p o r t
The Mul ti pl e data source support VLD B property al l ow s you to choose
w hi ch techni que to use to support mul ti pl e data sources i n a proj ect.
Thi s VLD B property has the fol l ow i ng opti ons:

15 44 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l U se MultiSource Option to access multiple data sources

(defaul t): Mul ti Source Opti on i s used to access mul ti pl e data
sources i n a proj ect.

Mi croStrategy i ncl udes an extensi on to Intel l i gence Server referred

to as Mul ti Source Opti on. Wi th thi s feature, you can connect a
proj ect to mul ti pl e rel ati onal data sources. Thi s al l ow s you to
i ntegrate al l your i nformati on from vari ous databases and other
rel ati onal data sources i nto a si ngl e Mi croStrategy proj ect for
reporti ng and anal ysi s purposes. Al l data sources i ncl uded by usi ng
the Mul ti Source Opti on are i ntegrated as part of the same rel ati onal
schema for a proj ect.

l U se database gateway support to access multiple data sources:

D atabase gatew ays are used to access mul ti pl e data sources i n a
proj ect.

You can speci fy a secondary database i nstance for a tabl e, w hi ch i s

used to support database gatew ays. For exampl e, i n your
envi ronment you mi ght have a gatew ay betw een tw o databases
such as an Oracl e database and a D B2 database. One of them i s
the pri mary database and the other i s the secondary database. The
pri mary database recei ves al l SQL requests and passes them to the
correct database.

For more i nformati on on both techni ques for connecti ng to mul ti pl e

data sources, see the Proj ect D esi gn Gui de.

Level s at Whi ch You Can Set Thi s

D atabase i nstance and proj ect

OLAP Fu n ct io n Su p p o r t
The OLAP functi on support VLD B property defi nes w hether OLAP
functi ons support backw ards compati bi l i ty or refl ect enhancements to

© 2019, M icr o St r at egy In c. 15 45

Syst em Ad m in ist r at io n Gu id e

OLAP functi on l ogi c. Thi s VLD B property has the fol l ow i ng opti ons:

l Preserve backwards compatibility with 8.1.x and earlier (defaul t):

OLAP functi ons refl ect the functi onal i ty of pre-9.0 rel eases to
support backw ards compati bi l i ty.

Thi s behavi or does not correctl y use mul ti pl e passes for nested or
si bl i ng metri cs that use OLAP functi ons. It al so does not correctl y
appl y attri butes i n the SortBy and BreakBy parameters.

l R ecommended with 9.0 and later: OLAP functi ons refl ect the
enhancements i ncl uded i n 9.0 and l ater rel eases.

Thi s recommended behavi or uses mul ti pl e passes for nested or

si bl i ng metri cs that use OLAP functi ons. The functi ons al so i gnore
attri butes i n SortBy or BreakBy parameters w hen the attri butes are
chi l dren of or are unrel ated to the component metri c's l evel .

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Par allel Qu er y Execu t io n

Paral l el Query Executi on i s an advanced property that i s hi dden by
defaul t. See Vi ew i ng and C hangi ng Advanced VLD B Properti es, page
1330 for more i nformati on on how to di spl ay thi s property.

The Paral l el Query Executi on property determi nes w hether

Mi croStrategy attempts to execute mul ti pl e queri es i n paral l el to
return report resul ts faster and publ i sh Intel l i gent C ubes. Thi s VLD B
property has the fol l ow i ng opti ons:

l D isable parallel query execution (defaul t): Al l queri es for

Mi croStrategy reports and Intel l i gent C ubes are processed
sequenti al l y.

15 46 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

D i sabl i ng paral l el query executi on by defaul t al l ow s you to fi rst

veri fy that your reports and Intel l i gent C ubes are executi ng correctl y
pri or to any paral l el query opti mi zati on. If you enabl e paral l el query
executi on and errors are encountered or data i s not bei ng returned
as expected, di sabl i ng paral l el query executi on can hel p to
troubl eshoot the report or Intel l i gent C ube.

l Enable parallel query execution for multiple data source reports

only: Mi croStrategy attempts to execute mul ti pl e queri es i n paral l el
for Mi croStrategy reports and Intel l i gent C ubes that access mul ti pl e
data sources. You can access mul ti pl e data sources usi ng ei ther
Mi croStrategy Mul ti Source Opti on, or database gatew ay support. To
enabl e one of these opti ons, see Mul ti pl e D ata Source Support,
page 1544.

For reports and Intel l i gent C ubes that do not use Mul ti Source
Opti on or database gatew ay support to access mul ti pl e data
sources, al l queri es are processed sequenti al l y.

l Enable parallel query execution for all reports that support it:
Mi croStrategy attempts to execute mul ti pl e queri es i n paral l el for al l
Mi croStrategy reports and Intel l i gent C ubes. Thi s opti on i s
automati cal l y used for data that you i ntegrate i nto Mi croStrategy
usi ng D ata Import.

H ow Par al l el Quer y Execut i on i s Sup p or t ed

To support paral l el query executi on, Mi croStrategy anal yzes the

query l ogi c that w i l l be run for a report or Intel l i gent C ube for potenti al
mul ti pl e queri es. Mul ti pl e queri es are used for tasks that requi re:

l The creati on of tabl es to store i ntermedi ate resul ts, w hi ch are then
used l ater i n the same query.

© 2019, M icr o St r at egy In c. 15 47

Syst em Ad m in ist r at io n Gu id e

These i ntermedi ate resul ts must be stored as permanent tabl es to

be consi dered for paral l el query executi on. These permanent tabl es
are requi red to ensure that the paral l el query executi on resul ts are
avai l abl e for separate database sessi ons and connecti ons. If
database features i ncl udi ng deri ved tabl es or common tabl e
expressi ons are used, paral l el query executi on cannot be used
because these techni ques are consi dered to be a si ngl e query,
w hi ch cannot be di vi ded i nto separate pi eces. Therefore, data
sources that use permanent tabl es to store i ntermedi ate resul ts are
good candi dates for paral l el query executi on.

Mi croStrategy uses deri ved tabl es and common tabl e expressi ons
by defaul t for databases that are w el l -sui ted to use these features to
store i ntermedi ate resul ts. These databases can often perform thei r
ow n query opti mi zati ons usi ng ei ther deri ved tabl es or common
tabl e expressi ons, and therefore may be better sui ted to usi ng these
techni ques rather than usi ng Mi croStrategy's paral l el query
executi on.

l Sel ecti ng i ndependent l ookup, rel ati onshi p, or fact data usi ng SQL
normal i zati on or di rect data l oadi ng methods. For i nformati on on
usi ng these techni ques w i th Intel l i gent C ubes and reports, see D ata
Popul ati on for Intel l i gent C ubes, page 1528 and D ata Popul ati on for
R eports, page 1532 respecti vel y.

l Loadi ng mul ti pl e tabl es i mported usi ng D ata Import, to publ i sh a

dataset. The opti on Enabl e paral l el query executi on for al l reports
that support i t i s automati cal l y used for data that you i ntegrate i nto
Mi croStrategy usi ng D ata Import.

Cand i d at es f or Par al l el Quer y Execut i on

Si mpl e reports i n Mi croStrategy may not requi re mul ti pl e queri es to

return the requi red resul ts, so even i f paral l el query executi on i s
enabl ed, there may be no performance benefi t. H ow ever, there are
vari ous Mi croStrategy features and techni ques that often requi re

15 48 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

mul ti pl e queri es and therefore can benefi t the most from paral l el
query executi on, w hi ch i ncl ude:

l C onsol i dati ons and custom groups.

l Level metri cs and transformati on metri cs.

l Accessi ng mul ti pl e data sources usi ng Mul ti Source Opti on or

database gatew ay support.

l Accessi ng data sources that use temporary tabl es or permanent

tabl es to store i ntermedi ate resul ts.

l Accessi ng data i n mul ti pl e tabl es through the use of D ata Import.

If your report or Intel l i gent C ube uses any of the features l i sted above,
i t may be a good candi date for usi ng paral l el query executi on.
Addi ti onal l y, usi ng paral l el query executi on can be a good opti on for
Intel l i gent C ubes that are publ i shed duri ng off-peak hours w hen the
system i s not i n heavy use by the reporti ng communi ty. U si ng paral l el
query executi on to publ i sh these Intel l i gent C ubes can speed up the
publ i cati on process, w hi l e not affecti ng the reporti ng communi ty for
your system.

There are addi ti onal scenari os i n Mi croStrategy that can requi re

mul ti pl e queri es. To hel p anal yze w hi ch reports and Intel l i gent C ubes
may benefi t from the use of paral l el query executi on, you can use the
paral l el query executi on i mprovement esti mate provi ded i n the SQL
vi ew of a report or Intel l i gent C ube. For more i nformati on on thi s
esti mate and di sabl i ng or enabl i ng the i ncl usi on of thi s esti mate, see
Paral l el Query Executi on Improvement Esti mate i n SQL Vi ew , page
1551.

There are some scenari os w here paral l el query executi on cannot be

used. These are descri bed bel ow :

© 2019, M icr o St r at egy In c. 15 49

Syst em Ad m in ist r at io n Gu id e

l When reports contai n user-defi ned data mart SQL, paral l el query
executi on cannot be used to execute mul ti pl e queri es i n paral l el .
For i nformati on on data mart Pre/Post Statement VLD B properti es,
i ncl udi ng at w hat l evel s these VLD B properti es can be defi ned, see
C ustomi zi ng SQL Statements: Pre/Post Statements, page 1477.

l Both Mul ti Source Opti on and w arehouse parti ti on mappi ng are used
to return resul ts for a report or Intel l i gent C ube from mul ti pl e data
sources. Whi l e the use of Mul ti Source Opti on al one can be a good
candi date for paral l el query executi on, w hen Mul ti Source Opti on i s
combi ned w i th w arehouse parti ti on mappi ng to return resul ts from
mul ti pl e data sources, paral l el query executi on cannot be used to
execute mul ti pl e queri es i n paral l el . For i nformati on on usi ng
w arehouse parti ti on mappi ng for a proj ect, see the Proj ect D esi gn
Gui de.

l Mi crosoft Access databases support paral l el query executi on for

Intel l i gent C ubes. H ow ever, reports and Intel l i gent C ubes that
requi re the creati on of temporary tabl es or i nserti on of val ues as
part of paral l el query executi on are i nstead processed sequenti al l y
for Access databases.

When t o Di sab l e Par al l el Quer y Execut i on

Whi l e performi ng mul ti pl e queri es i n paral l el can i mprove the

performance of query executi on i n Mi croStrategy, i t w i l l not provi de
the best performance or resul ts i n al l scenari os.

Paral l el query executi on i s di sabl ed by defaul t to al l ow you to fi rst

veri fy that your reports and Intel l i gent C ubes are executi ng correctl y
pri or to any paral l el query opti mi zati on. If you enabl e paral l el query
executi on and errors are encountered or data i s not bei ng returned as
expected, di sabl i ng paral l el query executi on can hel p to troubl eshoot
the report or Intel l i gent C ube.

15 5 0 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

When mul ti pl e queri es are performed i n paral l el , the actual

processi ng of the mul ti pl e queri es i s performed i n paral l el on the
database. If a database i s requi red to do too many tasks at the same
ti me thi s can cause the response ti me of the database to sl ow dow n,
and thus degrade the overal l performance. You shoul d take i nto
account the databases used to retri eve data and thei r avai l abl e
resources w hen deci di ng w hether to enabl e paral l el query executi on.

D i sabl i ng paral l el query executi on can be a good opti on for reports

and Intel l i gent C ubes that are not used often or ones that do not have
stri ct performance requi rements. If you can di sabl e paral l el query
executi on for these reports and Intel l i gent C ubes that do not have a
great need for enhanced performance, that can save database
resources to handl e other potenti al l y more i mportant requests.

Addi ti onal l y, you can l i mi t the number of queri es that can be executed
i n paral l el for a gi ven report or Intel l i gent C ube. Thi s can al l ow you to
enabl e paral l el query executi on, but restri ct how much processi ng can
be done i n paral l el on the database. To defi ne the number of passes
of SQL that can be executed i n paral l el , see Maxi mum Paral l el
Queri es Per R eport, page 1543.

Level s at Whi ch You Can Set Thi s

Proj ect, report, and templ ate

Par allel Qu er y Execu t io n Imp r o vemen t Est imat e in SQL View

Paral l el Query Executi on Improvement Esti mate i n SQL Vi ew i s an
advanced property that i s hi dden by defaul t. For i nformati on on how to
di spl ay thi s property, see Vi ew i ng and C hangi ng Advanced VLD B
Properti es, page 1330.

The Paral l el Query Executi on Improvement Esti mate i n SQL Vi ew

property determi nes w hether reports and Intel l i gent C ubes i ncl ude an
esti mate i n the percent of processi ng ti me that w oul d be saved i f

© 2019, M icr o St r at egy In c. 15 5 1

Syst em Ad m in ist r at io n Gu id e

paral l el query executi on w as used to run mul ti pl e queri es i n paral l el .

Thi s VLD B property has the fol l ow i ng opti ons:

l D isable parallel query execution estimate in SQL view: An

esti mate on the percent of processi ng ti me that w oul d be saved i f
paral l el query executi on w as used for the report or Intel l i gent C ube
i s not di spl ayed i n the SQL vi ew of the report. Thi s can si mpl i fy the
SQL vi ew i f you are al ready usi ng paral l el query executi on or you
are not i nterested i n thi s esti mated i mprovement.

l Enable parallel query execution estimate in SQL view: An

esti mate on the percent of processi ng ti me that w oul d be saved i f
paral l el query executi on w as used for the report or Intel l i gent C ube
i s di spl ayed i n the SQL vi ew of the report. Thi s esti mate i s provi ded
as a percentage of ti me that coul d be saved by usi ng paral l el query
executi on.

To cal cul ate thi s esti mate, the report or Intel l i gent C ube i s anal yzed
to determi ne i f there are mul ti pl e queri es. If there are mul ti pl e
queri es, thi s esti mate i s cal cul ated by assumi ng that al l appl i cabl e
queri es are run i n paral l el .

Be aw are that thi s esti mate does not factor i n the capabi l i ti es of the
database you are usi ng, w hi ch can have an effect on the
performance of paral l el query executi on si nce the database i s w hat
processes the mul ti pl e passes i n paral l el . Addi ti onal l y, thi s
esti mate assumes that al l queri es that can be done i n paral l el are i n
fact performed i n paral l el . If paral l el query executi on i s enabl ed, the
number of queri es that can be performed i n paral l el i s control l ed by
the Maxi mum Paral l el SQLs Per R eport VLD B property (see Paral l el
Query Executi on Improvement Esti mate i n SQL Vi ew , page 1551).

Level s at Whi ch You Can Set Thi s

Proj ect onl y

15 5 2 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Ran k Met h o d if DB Ran kin g No t Used

The R ank Method property determi nes w hi ch method to use for
ranki ng cal cul ati ons. There are three methods for ranki ng data, and i n
some cases, thi s property i s i gnored. The l ogi c i s as fol l ow s:

1. If the metri c that i s bei ng ranked has to be cal cul ated i n the
Anal yti cal Engi ne, then the ranki ng i s cal cul ated i n the
Anal yti cal Engi ne as w el l .

2. If the database supports the R ank functi on, then the ranki ng i s
done i n the database.

3. If nei ther of the above cri teri a i s met, then the R ank Method
property setti ng i s used.

The most common form of ranki ng i s referred to as Open D atabase

C onnecti vi ty (OD BC ) ranki ng. Thi s w as the standard method used by
Mi croStrategy 6.x and earl i er. Thi s method makes mul ti pl e queri es
agai nst the w arehouse to determi ne the ranki ng. OD BC ranki ng i s the
defaul t ranki ng techni que, w hen the database does not support nati ve
ranki ng, because i t i s more effi ci ent for l arge datasets.

Anal yti cal Engi ne ranki ng generates the resul t of the ranki ng
operati on i n the Mi croStrategy Anal yti cal Engi ne and then moves the
resul t set back to the w arehouse to perform any further operati ons and
compi l e the fi nal resul t set.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Remo ve Aggr egat io n Met h o d

R emove Aggregati on Method i s an advanced property that i s hi dden
by defaul t. For i nformati on on how to di spl ay thi s property, see
Vi ew i ng and C hangi ng Advanced VLD B Properti es, page 1330.

© 2019, M icr o St r at egy In c. 15 5 3

Syst em Ad m in ist r at io n Gu id e

The R emove Aggregati on Method property determi nes w hether to

keep or remove aggregati ons i n SQL queri es executed from
Mi croStrategy. Thi s VLD B property has the fol l ow i ng opti ons:

l R emove aggregation according to key of FR OM clause (defaul t):

Aggregati ons are kept or removed based on the l evel of data
created by j oi ni ng al l the tabl es i ncl uded i n the query. If the l evel of
the i nformati on returned i n the query (S E L EC T cl ause) i s the same
as the l evel determi ned by j oi ni ng al l requi red tabl es (F R O M cl ause)
then any unnecessary aggregati ons are removed. If these l evel s are
di fferent, then aggregati ons must be kept to ensure that correct data
i s returned. D etermi ni ng w hether aggregati ons are necessary after
j oi ni ng al l rel evant tabl es hel ps to provi de val i d SQL w hen the
attri bute data and the fact data are stored at di fferent l evel s.

For exampl e, the report show n i n the i mage bel ow w as created i n

the Mi croStrategy Tutori al proj ect.

To create thi s report, data must be j oi ned from the tabl es

LU _ M O N T H, L U _C U S T _C I T Y, and C I T Y _M N T H _S L S.
Si nce the attri bute l ookup tabl es combi ne to have a l evel
of C ustomer C i ty and Month, and the C I T Y _M N T H _S L S
tabl e has a l evel of C ustomer C i ty and Month, normal l y
thi s VLD B property w oul d have no effect on the SQL.

15 5 4 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

H ow ever, for the purposes of thi s exampl e the L U _M O N T H

tabl e w as modi fi ed to i ncl ude an extra attri bute named
Exampl e, and i t i s not rel ated to the Month attri bute.
Because of thi s addi ti onal unrel ated attri bute, w hi l e the
report onl y di spl ays Month and C ustomer C i ty, the l evel
of the data i s Month, C ustomer C i ty, and Exampl e. If you
use the other opti on (R emove aggregation according to
key of fact tables) for thi s VLD B property, the fol l ow i ng
SQL i s created:

The SQL statement above uses D I S TI N C T i n the

SE LE C T cl ause to return the Month data. H ow ever, si nce
there i s an addi ti onal attri bute on the L U _M O N T H tabl e,
the correct SQL to use i ncl udes aggregati ons on the data
rather than usi ng D I S T I N C T. Therefore, i f you use thi s
R emove aggregation according to key of FR OM
clause opti on for the VLD B property, the fol l ow i ng SQL
i s created:

© 2019, M icr o St r at egy In c. 15 5 5

Syst em Ad m in ist r at io n Gu id e

Thi s SQL statement correctl y uses aggregati on functi ons

and a G R O U P B Y cl ause to return the attri bute data.

l R emove aggregation according to key of fact tables:

Aggregati ons are kept or removed pri or to determi ni ng the l evel of
data created by j oi ni ng al l of the tabl es requi red for the query. Thi s
opti on can be used for backw ard compati bi l i ty, w hi ch can hel p to
provi de the expected data and SQL statements i n scenari os that
uti l i ze features such as nested aggregati on i n metri cs and custom
groups.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Remo ve Gr o u p b y Op t io n
R emove Group By Opti on i s an advanced property that i s hi dden by
defaul t. For i nformati on on how to di spl ay thi s property, see Vi ew i ng
and C hangi ng Advanced VLD B Properti es, page 1330.

The R emove Group By Opti on property determi nes w hen G r o u p B y

condi ti ons and aggregati ons can be omi tted i n speci fi c SQL
generati on scenari os, dependi ng on w hi ch of the fol l ow i ng opti ons
you sel ect:

15 5 6 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l R emove aggregation and Group B y when Select level is

identical to From level (defaul t): Thi s setti ng provi des the common
behavi or of omi tti ng G r o u p B y condi ti ons and aggregati ons i f the
l evel of the S E L E C T cl ause i s i denti cal to the l evel of the F R O M
cl ause. For exampl e, a SQL statement that onl y i ncl udes the ID
col umn for the Store attri bute i n the S E L E C T cl ause and onl y
i ncl udes the l ookup tabl e for the Store attri bute i n the F R O M cl ause
does not i ncl ude any G r o u p B y condi ti ons.

l R emove aggregation and Group B y when Select level contains

all attribute(s) in From level: You can choose to omi t G r o u p B y
condi ti ons and aggregati ons i n the uni que scenari o of i ncl udi ng
mul ti pl e attri butes on a report, w hi ch are bui l t from col umns of the
same tabl e i n the data w arehouse. For exampl e, you have separate
attri butes for shi ppi ng data such as Shi ppi ng ID , Shi ppi ng Ti me,
and Shi ppi ng Locati on w hi ch are mapped to col umns i n the same
tabl e w hi ch has the pri mary key mapped to Shi ppi ng ID . By
sel ecti ng thi s setti ng, w hen these three attri butes are i ncl uded on a
report, G ro u p B y condi ti ons and aggregati ons for the shi ppi ng
attri butes are omi tted.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Remo ve Rep eat ed Tab les f o r Ou t er Jo in s

R emove R epeated Tabl es For Outer Joi ns i s an advanced property
that i s hi dden by defaul t. For i nformati on on how to di spl ay thi s
property, see Vi ew i ng and C hangi ng Advanced VLD B Properti es,
page 1330.

The R emove R epeated Tabl es For Outer Joi ns property determi nes
w hether an opti mi zati on for outer j oi n processi ng i s enabl ed or
di sabl ed. You have the fol l ow i ng opti ons:

© 2019, M icr o St r at egy In c. 15 5 7

Syst em Ad m in ist r at io n Gu id e

l D isable optimization to remove repeated tables in full outer join

and left outer join passes: The opti mi zati on for outer j oi n
processi ng i s di sabl ed. Thi s can cause outer j oi ns to requi re
addi ti onal processi ng ti me.

l Enable optimization to remove repeated tables in full outer join

and left outer join passes (defaul t): The opti mi zati on for outer j oi n
processi ng i s enabl ed. Thi s can provi de better response ti me for
outer j oi n processi ng.

H ow ever, i f you sort or rank report resul ts and some of the val ues
used for the sort or rank are i denti cal , you may encounter di fferent
sort or rank orders dependi ng on w hether you di sabl e or enabl e
thi s opti mi zati on. To preserve current sorti ng or ranki ng orders on
i denti cal val ues, you may w ant to di sabl e thi s opti mi zati on.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Set Op er at o r Op t imizat io n
Set Operator Opti mi zati on i s an advanced property that i s hi dden by
defaul t. For i nformati on on how to di spl ay thi s property, see Vi ew i ng
and C hangi ng Advanced VLD B Properti es, page 1330.

The Set Operator Opti mi zati on property determi nes w hether to use set
operators, such as E X C EP T and I N T E R S E C T, to combi ne mul ti pl e
fi l ter qual i fi cati ons rather than thei r equi val ent l ogi cal operators such
as AN D NO T and A N D. Set operators can be used to combi ne tw o or
more of the fol l ow i ng types of set qual i fi cati ons:

l R el ati onshi p qual i fi cati ons

l Metri c qual i fi cati ons w hen combi ned w i th other types of set
qual i fi cati ons w i th the l ogi cal operators A N D, N O T, or O R

15 5 8 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l R eport as fi l ter qual i fi cati ons w hen combi ned w i th the l ogi cal
operators AN D, N O T, or O R

l Set operators c an only be us ed to c ombine the filter qualific ations

lis ted abov e if they hav e the s ame output lev el. For ex ample, a
relations hip qualific ation with an output lev el s et to Year and Region
c annot be c ombined with another relations hip qualific ation with an
output lev el of Year.

l Metric qualific ations and report-as -filter qualific ations , when

c ombined with A N D , render as inner joins by default to av oid a
s ubquery in the final res ult pas s . When Set Operator Optimiz ation is
enabled, the inner joins are replac ed by s ubqueries c ombined us ing
IN TE RS E C T .

l Metric qualific ations at the s ame lev el are c ombined into one s et
qualific ation before being applied to the final res ult pas s . This is more
effic ient than us ing a s et operator. Cons ult Mic roStrategy Tec h Note
TN13536 for more details .

l For more information on filters and filter qualific ations , s ee the

Advanced Fi l ters s ec tion of the Mi croStrategy Advanced
R eporti ng Gui de .

Al ong w i th the restri cti ons descri bed above, SQL set operators al so
depend on the subquery type and the database pl atform. For more
i nformati on on sub query type, see Set Operator Opti mi zati on, page
1558. Set Operator Opti mi zati on can be used w i th the fol l ow i ng sub
query types:

l WH ER E C OL1 IN (SELEC T s1.C OL1...) fal l i ng back to EXISTS

(SELEC T * ...) for mul ti pl e col umns IN

l WH ER E (C OL1, C OL2...) IN (SELEC T s1.C OL1, s1.C OL2...)

l WH ER E C OL1 IN (SELEC T s1.C OL1...) fal l i ng back to EXISTS

(SELEC T col 1, col 2 ...) for mul ti pl e col umns IN

© 2019, M icr o St r at egy In c. 15 5 9

Syst em Ad m in ist r at io n Gu id e

l U se Temporary Tabl e, fal l i ng back to IN (SELEC T C OL) for

correl ated sub query

If either of the two s ub query ty pes that us e fallbac k ac tions perform a

fallbac k , Set Operator Optimiz ation is not applied.

The fol l ow i ng database pl atforms support SQL set operators:

In tersect Excep t Un io n
Datab ase In tersect Excep t Un io n
AL L AL L AL L

A NS I 92 Y es Y es Y es Y es Y es Y es

DB 2 UDB Y es Y es Y es Y es Y es Y es

I nf ormix No No No No Y es Y es

Y es
Oracle Y es No No Y es Y es
(Minus)

RedB rick Y es Y es Y es Y es Y es Y es

Y es
Y es (2005 (2005
S QL S erver No No Y es Y es
and lat er) and
lat er)

Tandem No No No No No No

Teradat a Y es Y es Y es Y es Y es Y es

If y ou enable Set Operator Optimiz ation for a databas e platform that

does not s upport operators s uc h as E X C E P T and I N T E R S E C T , the Set
Operator Optimiz ation property is ignored.

The Set Operator Opti mi zati on property provi des you w i th the
fol l ow i ng opti ons:

15 60 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l D isable Set Operator Optimization (defaul t): Operators such as I N

and A ND N O T are used i n SQL sub queri es w i th mul ti pl e fi l ter
qual i fi cati ons.

l Enable Set Operator Optimization (if database support and [Sub

Query Type]): Thi s setti ng can i mprove performance by usi ng SQL
set operators such as E X C E P T, I N T E R S E C T, and M I N U S i n SQL sub
queri es to combi ne mul ti pl e fi l ter qual i fi cati ons that have the same
output l evel . Al l of the dependenci es descri bed above must be met
for SQL set operators to be used. If you enabl e SQL set operators
for a database pl atform that does not support them, thi s setti ng i s
i gnored and fi l ters are combi ned i n the standard w ay w i th operators
such as I N and A N D NO T.

For a further dis c us s ion on the Set Operator Optimiz ation VLDB
property , refer to Mic roStrategy Tec h Note TN13530.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

SQL Glo b al Op t imizat io n

The SQL Gl obal Opti mi zati on property provi des access to l evel
opti ons you can use to determi ne w hether and how SQL queri es are
opti mi zed.

In some cases, the SQL Engi ne generates dupl i cate or redundant

passes, generates SQL passes that can be combi ned i nto one pass,
or creates unnecessary temporary tabl es. Such SQL queri es can have
an adverse effect on performance.

The default option for this VLDB property has c hanged in 9.0.0. For
information on this c hange, s ee SQL Gl obal Opti mi zati on, page
1561 .

© 2019, M icr o St r at egy In c. 15 61

Syst em Ad m in ist r at io n Gu id e

You can set the fol l ow i ng SQL Gl obal Opti mi zati on opti ons to
determi ne the extent to w hi ch SQL queri es are opti mi zed:

l Level 0: N o optimization: SQL queri es are not opti mi zed.

l Level 1: R emove U nused and D uplicate Passes: R edundant,

i denti cal , and equi val ent SQL passes are removed from queri es
duri ng SQL generati on.

l Level 2: Level 1 + Merge Passes with different SELEC T: Level 1

opti mi zati on takes pl ace as descri bed above, and SQL passes from
di fferent SE L E C T statements are consol i dated w hen i t i s appropri ate
to do so.

l Level 3: Level 2 + Merge Passes, which only hit D B Tables, with

different WH ER E: Level 2 opti mi zati on takes pl ace as descri bed
above, and SQL passes w hi ch access database tabl es w i th di fferent
WH ER E cl auses are consol i dated w hen i t i s appropri ate to do so.

l Level 4: Level 2 + Merge A ll Passes with D ifferent WH ER E: Thi s

i s the defaul t l evel . Level 2 opti mi zati on takes pl ace as descri bed
above, and al l SQL passes w i th di fferent WH ER E cl auses are
consol i dated w hen i t i s appropri ate to do so. Whi l e Level 3 onl y
consol i dates SQL statements that access database tabl es, thi s
opti on al so consi ders SQL statements that access temporary tabl es,
deri ved tabl es, and common tabl e expressi ons.

l Level 5: Level 2 + Merge A ll Passes, which hit the same

warehouse fact tables: Level 2 opti mi zati on takes pl ace as
descri bed above, and w hen mul ti pl e passes hi t the same fact tabl e,
a compi l ed tabl e i s created from the l ookup tabl es of the mul ti pl e
passes. Thi s compi l ed tabl e hi ts the w arehouse fact tabl e onl y
once.

Addi ti onal l y, i f you use ei ther Level 3 or Level 4 SQL Gl obal

Opti mi zati on, SQL passes can al so be combi ned for the SQL that i s
generated for separate custom group el ements.

15 62 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

The SQL opti mi zati on avai l abl e w i th Level 3 or Level 4 can be

appl i ed for SQL passes that use the functi ons Pl us (+ ), Mi nus (-),
Ti mes (*), D i vi de (/), U nary mi nus (U -), Sum, C ount, Avg (average),
Mi n, and Max. To ensure that val i d SQL i s returned, i f the SQL passes
that are generated use any other functi ons, the SQL passes are not
combi ned.

Example: Redundant SQL Pass

Thi s exampl e demonstrates how some SQL passes are redundant and
therefore removed w hen the Level 1 or Level 2 SQL Gl obal
Opti mi zati on opti on i s sel ected.

Suppose the fol l ow i ng appear on the report templ ate:

l Year attri bute

l R egi on attri bute

l Sum(Profi t) {~+, C ategory%} metri c (cal cul ates profi t for each
C ategory, i gnori ng any fi l teri ng on C ategory)

The report generates the fol l ow i ng SQL:

l SQL Pass 1: R etri eves the set of categori es that sati sfy the metri c
qual i fi cati on
SELECT a11.CATEGORY_ID CATEGORY_ID
into #ZZTRH02012JMQ000
FROM YR_CATEGORY_SLS a11
GROUP BY a11.CATEGORY_ID
HAVING sum(a11.TOT_DOLLAR_SALES) > 1000000.0

l SQL Pass 2: Fi nal pass that sel ects the rel ated report data, but
does not use the resul ts of the fi rst SQL pass
SELECT a13.YEAR_ID YEAR_ID,
a12.REGION_ID REGION_ID,
max(a14.REGION_NAME) REGION_NAME,
sum((a11.TOT_DOLLAR_SALES - a11.TOT_COST))
WJXBFS1
FROM DAY_CTR_SLS a11

© 2019, M icr o St r at egy In c. 15 63

Syst em Ad m in ist r at io n Gu id e

join LU_CALL_CTR a12

on (a11.CALL_CTR_ID = a12.CALL_CTR_ID)
join LU_DAY a13
on (a11.DAY_DATE = a13.DAY_DATE)
join LU_REGION a14
on (a12.REGION_ID = a14.REGION_ID)
GROUP BY a13.YEAR_ID,a12.REGION_ID

SQL Pass 1 i s redundant because i t creates and popul ates a

temporary tabl e, # Z Z T R H 0 2 0 1 2 J M Q 0 0 0, that i s not accessed agai n
and i s unnecessary to generati ng the i ntended SQL resul t.

If you sel ect ei ther the Level 1: R emove U nused and D uplicate
Passes or Level 2: Level 1 + Merge Passes with different SELEC T
opti on, onl y one SQL pass—the second SQL pass descri bed above—
i s generated because i t i s suffi ci ent to sati sfy the query on i ts ow n. By
sel ecti ng ei ther opti on, you reduce the number of SQL passes from
tw o to one, w hi ch can potenti al l y decrease query ti me.

Exam p l e: Com b i nab l e SQL Passes

Someti mes, tw o or more passes contai n SQL that can be consol i dated
i nto a si ngl e SQL pass, as show n i n the exampl e bel ow . In such
cases, you can sel ect the Level 2: Level 1 + Merge Passes with
different SELEC T opti on to combi ne mul ti pl e passes from di fferent
SELEC T statements.

Suppose the fol l ow i ng appear on the report templ ate:

l R egi on attri bute

l Metri c 1 = Sum(R evenue) {R egi on+} (cal cul ates the total revenue
for each regi on)

l Metri c 2 = C ount<FactID =R evenue>(C al l C enter) {R egi on+}

(cal cul ates the number of cal l centers for each regi on)

l Metri c 3 = Metri c 1/Metri c 2 (Average R evenue = Total

R evenue/N umber of C al l C enters)

The report generates the fol l ow i ng SQL:

15 64 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l SQL Pass 1: C al cul ates Metri c 1 = Sum(R evenue) {R egi on+}

SELECT a12.[REGION_ID] AS REGION_ID,
sum(a11.[TOT_DOLLAR_SALES]) AS WJXBFS1
into [ZZTI10200U2MD000]
FROM [CITY_CTR_SLS] a11,
[LU_CALL_CTR] a12
WHERE a11.[CALL_CTR_ID] = a12.[CALL_CTR_ID]
GROUP BY a12.[REGION_ID]

l SQL Pass 2: C al cul ates Metri c 2 = C ount<FactID =R evenue>(C al l

C enter) {R egi on+}
SELECT a12.[REGION_ID] AS REGION_ID,
count(a11.[CALL_CTR_ID]) AS WJXBFS1
into [ZZTI10200U2MD001]
FROM [CITY_CTR_SLS] a11,
[LU_CALL_CTR] a12
WHERE a11.[CALL_CTR_ID] = a12.[CALL_CTR_ID]
GROUP BY a12.[REGION_ID]

l SQL Pass 3: Fi nal pass that cal cul ates Metri c 3 = Metri c 1/Metri c 2
and di spl ays the resul t

SELECT pa11.[REGION_ID] AS REGION_ID,

a13.[REGION_NAME] AS REGION_NAME,
pa11.[WJXBFS1] AS WJXBFS1,
IIF(ISNULL((pa11.[WJXBFS1] / IIF(pa12.[WJXBFS1]
= 0, NULL,
pa12.[WJXBFS1]))), 0,
(pa11.[WJXBFS1] / IIF(pa12.[WJXBFS1] = 0,
NULL,pa12.[WJXBFS1]))) AS WJXBFS2
FROM [ZZTI10200U2MD000] pa11,
[ZZTI10200U2MD001] pa12,
[LU_REGION] a13
WHERE pa11.[REGION_ID] = pa12.[REGION_ID] and
pa11.[REGION_ID] = a13.[REGION_ID]

Because SQL passes 1 and 2 contai n al most exactl y the same code,
they can be consol i dated i nto one SQL pass. N oti ce the i tal i ci zed
SQL i n Pass 1 and Pass 2. These are the onl y uni que characteri sti cs
of each pass; therefore, Pass 1 and 2 can be combi ned i nto j ust one
pass. Pass 3 remai ns as i t i s.

© 2019, M icr o St r at egy In c. 15 65

Syst em Ad m in ist r at io n Gu id e

You can achi eve thi s type of opti mi zati on by sel ecti ng the Level 2:
Level 1 + Merge Passes with different SELEC T opti on. The SQL
that resul ts from thi s l evel of SQL opti mi zati on i s as fol l ow s:

Pass 1:
SELECT a12.[REGION_ID] AS REGION_ID,
count(a11.[CALL_CTR_ID]) AS WJXBFS1
sum(a11.[TOT_DOLLAR_SALES]) AS WJXBFS1
into [ZZTI10200U2MD001]
FROM [CITY_CTR_SLS] a11,
[LU_CALL_CTR] a12
WHERE a11.[CALL_CTR_ID] = a12.[CALL_CTR_ID]
GROUP BY a12.[REGION_ID]

Pass 2:
SELECT pa11.[REGION_ID] AS REGION_ID,
a13.[REGION_NAME] AS REGION_NAME,
pa11.[WJXBFS1] AS WJXBFS1,
IIF(ISNULL((pa11.[WJXBFS1] / IIF(pa12.[WJXBFS1] = 0, NULL,
pa12.[WJXBFS1]))), 0,
(pa11.[WJXBFS1] / IIF(pa12.[WJXBFS1] = 0, NULL,
pa12.[WJXBFS1]))) AS WJXBFS2
FROM [ZZTI10200U2MD000] pa11,
[ZZTI10200U2MD001] pa12,
[LU_REGION] a13
WHERE pa11.[REGION_ID] = pa12.[REGION_ID] and
pa11.[REGION_ID] = a13.[REGION_ID]

For a further dis c us s ion on the SQL Global Optimiz ation VLDB property ,
refer to Mic roStrategy Tec h Note TN13505.

Exam p l e: Com b i nab l e SQL Passes, w i t h Di f f er ent WH ERE Cl auses

Someti mes, tw o or more passes contai n SQL w i th di fferent w here

cl auses that can be consol i dated i nto a si ngl e SQL pass, as show n i n
the exampl e bel ow . In such cases, you can sel ect the Level 3: Level
2 + Merge Passes, which only hit D B Tables, with different
WH ER E opti on or the Level 4: Level 2 + Merge A ll Passes with

15 66 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

D ifferent WH ER E opti on to combi ne mul ti pl e passes w i th di fferent

WH ER E cl auses.

Suppose the fol l ow i ng appear on the report templ ate:

l Quarter attri bute

l Metri c 1 = Web Sal es (C al cul ates sal es for the w eb cal l center)

l Metri c 2 = N on-Web Sal es (C al cul ates sal es for al l non-w eb cal l

centers)

The report generates the fol l ow i ng SQL

Pass 1:
create table ZZMD00 (
QUARTER_ID SHORT,
WJXBFS1 DOUBLE)

Pass 2:
insert into ZZMD00
select a12.[QUARTER_ID] AS QUARTER_ID,
sum(a11.[TOT_DOLLAR_SALES]) AS WJXBFS1
from [DAY_CTR_SLS] a11,
[LU_DAY] a12
where a11.[DAY_DATE] = a12.[DAY_DATE]
and a11.[CALL_CTR_ID] in (18)
group by a12.[QUARTER_ID]

Pass 3:
create table ZZMD01 (
QUARTER_ID SHORT,
WJXBFS1 DOUBLE)

Pass 4:
insert into ZZMD01
select a12.[QUARTER_ID] AS QUARTER_ID,
sum(a11.[TOT_DOLLAR_SALES]) AS WJXBFS1
from [DAY_CTR_SLS] a11,
[LU_DAY] a12

© 2019, M icr o St r at egy In c. 15 67

Syst em Ad m in ist r at io n Gu id e

where a11.[DAY_DATE] = a12.[DAY_DATE]

and a11.[CALL_CTR_ID] not in (18)
group by a12.[QUARTER_ID]

Pass 5:
select pa11.[QUARTER_ID] AS QUARTER_ID,
a13.[QUARTER_DESC] AS QUARTER_DESC0,
pa11.[WJXBFS1] AS WJXBFS1,
pa12.[WJXBFS1] AS WJXBFS2
from [ZZMD00] pa11,
[ZZMD01] pa12,
[LU_QUARTER] a13
where pa11.[QUARTER_ID] = pa12.[QUARTER_ID] and
pa11.[QUARTER_ID] = a13.[QUARTER_ID]

Pass 2 cal cul ates the Web Sal es and Pass 4 cal cul ates al l non-Web
Sal es. Because SQL passes 2 and 4 contai n al most exactl y the same
SQL, they can be consol i dated i nto one SQL pass. N oti ce the
hi ghl i ghted SQL i n Pass 2 and Pass 4. These are the onl y uni que
characteri sti cs of each pass; therefore, Pass 2 and 4 can be
combi ned i nto j ust one pass.

You can achi eve thi s type of opti mi zati on by sel ecti ng the Level 3:
Level 2 + Merge Passes, which only hit D B Tables, with different
WH ER E opti on or the Level 4: Level 2 + Merge A ll Passes with
D ifferent WH ER E opti on. The SQL that resul ts from thi s l evel of SQL
opti mi zati on i s as fol l ow s:

Pass 1:
create table ZZT6C00009GMD000 (
QUARTER_ID SHORT,
WJXBFS1 DOUBLE,
GODWFLAG1_1 LONG,
WJXBFS2 DOUBLE,
GODWFLAG2_1 LONG)

Pass 2:
insert into ZZT6C00009GMD000
select a12.[QUARTER_ID] AS QUARTER_ID,

15 68 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

sum(iif(a11.[CALL_CTR_ID] in (18),
a11.[TOT_DOLLAR_SALES], NULL))
AS WJXBFS1,
max(iif(a11.[CALL_CTR_ID] in (18), 1, 0))
AS GODWFLAG1_1,
sum(iif(a11.[CALL_CTR_ID] not in (18),
a11.[TOT_DOLLAR_SALES], NULL))
AS WJXBFS2,
max(iif(a11.[CALL_CTR_ID] not in (18), 1, 0))
AS GODWFLAG2_1
from [DAY_CTR_SLS] a11,
[LU_DAY] a12
where a11.[DAY_DATE] = a12.[DAY_DATE]
and (a11.[CALL_CTR_ID] in (18)
or a11.[CALL_CTR_ID] not in (18))
group by a12.[QUARTER_ID]

Pass 3:
select pa12.[QUARTER_ID] AS QUARTER_ID,
a13.[QUARTER_DESC] AS QUARTER_DESC0,
pa12.[WJXBFS1] AS WJXBFS1,
pa12.[WJXBFS2] AS WJXBFS2
from [ZZT6C00009GMD000] pa12,
[LU_QUARTER] a13
where pa12.[QUARTER_ID] = a13.[QUARTER_ID]
and (pa12.[GODWFLAG1_1] = 1
and pa12.[GODWFLAG2_1] = 1)

Up gr ad in g Fr o m Pr e-9 .0 .x Ver sio n s o f Micr o St r at egy

The defaul t opti on for the SQL Gl obal Opti mi zati on VLD B property
changed i n Mi croStrategy 9.0.0. In pre-9.0.x versi ons of
Mi croStrategy, the defaul t opti on for thi s VLD B property w as Level 2:
Level 1 + Merge Passes w i th di fferent SELEC T. Starti ng w i th
Mi croStrategy 9.0.0, the defaul t opti on for thi s VLD B property i s Level
4: Level 2 + Merge Al l Passes w i th D i fferent WH ER E.

When proj ects are upgraded to 9.0.x, i f you have defi ned thi s VLD B
property to use the defaul t setti ng, thi s new defaul t i s appl i ed. Thi s
change i mproves performance for the maj ori ty of reporti ng scenari os.

© 2019, M icr o St r at egy In c. 15 69

Syst em Ad m in ist r at io n Gu id e

H ow ever, the new defaul t can cause certai n reports to become

unresponsi ve or fai l w i th ti me-out errors. For exampl e, reports that
contai n custom groups or a l arge number of condi ti onal metri cs may
encounter performance i ssues w i th thi s new defaul t.

You can use Integri ty Manager to determi ne any changes i n

performance that your reports may encounter due to upgradi ng your
Mi croStrategy proj ects. Thi s al l ow s you to determi ne w hi ch reports
may encounter performance i ssues due to thi s VLD B property
modi fi cati on.

To resol ve thi s i ssue for a report, after compl eti ng an upgrade, modi fy
the SQL Gl obal Opti mi zati on VLD B property for the report to use the
opti on Level 2: Level 1 + Merge Passes w i th di fferent SELEC T.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Su b Qu er y Typ e
Sub Query Type i s an advanced property that i s hi dden by defaul t.
For i nformati on on how to di spl ay thi s property, see Vi ew i ng and
C hangi ng Advanced VLD B Properti es, page 1330.

The Sub Query Type property tel l s the Anal yti cal Engi ne w hat type of
syntax to use w hen generati ng a subquery. A subquery i s a secondary
SELE CT statement i n the W H E R E cl ause of the pri mary SQL statement.

The Sub Query Type property i s database speci fi c, due to the fact that
di fferent databases have di fferent syntax support for subqueri es.
Some databases can have i mproved query bui l di ng and performance
dependi ng on the subquery type used. For exampl e, i t i s more
effi ci ent to use a subquery that onl y sel ects the needed col umns
rather than sel ecti ng every col umn. Subqueri es can al so be more

15 70 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

effi ci ent by usi ng the I N cl ause rather than usi ng the E X I S T S

functi on.

The most opti mal opti on depends on your database capabi l i ti es. In
general the defaul t setti ng i s WH ER E C OL1 IN (SELEC T s1.C OL1...)
falling back to EXISTS (SELEC T *...) for multiple columns IN .
H ow ever, the defaul t setti ng i s based on the most opti mal setti ng for
your database type. See the tabl e bel ow for database pl atform
excepti ons to the defaul t setti ng. To revi ew exampl e SQL syntax for
each VLD B setti ng for Sub Query Type, see H ER E EXISTS (Sel ect
*…), page 1572.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Dat ab ase excep t i ons t o t he d ef aul t set t i ng

Datab ase Defau lt

Use Temporary Table, f alling back t o E X I S TS (S E LE CT *. . . ) f or

DB 2 UDB
correlat ed subquery

DB 2 UDB f or
Where E xist s (S elect *. . . )
OS / 390

Microsof t A ccess Use Temporary Table, f alling back t o E X I S TS (S E LE CT *. . . ) f or

2000/ 2002/ 2003 correlat ed subquery

Microsof t E xcel Use Temporary Table, f alling back t o E X I S TS (S E LE CT *. . . ) f or

2000/ 2003 correlat ed subquery

Net ezza Where (col1, col2. . . ) in (S elect s1. col1, s1. col2. . . )

Oracle Where (col1, col2. . . ) in (S elect s1. col1, s1. col2. . . )

P ost greS QL Where (col1, col2. . . ) in (S elect s1. col1, s1. col2. . . )

Where col1 in (S elect s1. col1. . . ) f alling back t o E xist s (S elect

RedB rick
col1, col2. . . ) f or mult iple column in

© 2019, M icr o St r at egy In c. 15 71

Syst em Ad m in ist r at io n Gu id e

Datab ase Defau lt

Use Temporary Table, f alling back t o in (S elect col) f or

Teradat a
correlat ed subquery

N oti ce that some opti ons have a fal l back acti on. In some scenari os,
the sel ected opti on does not w ork, so the SQL Engi ne must fal l back
to an approach that al w ays w orks. The typi cal scenari o for fal l i ng
back i s w hen mul ti pl e col umns are needed i n the I N l i st, but the
database does not support i t and the correl ated subqueri es.

For a further dis c us s ion of the Sub Query Ty pe VLDB property , refer to
Mic roStrategy Tec h Note TN13870.

HERE EXISTS (Select *…)

select a31.ITEM_NBR ITEM_NBR,

a31.CLASS_NBR CLASS_NBR,
sum(a31.REG_SLS_DLR) REG_SLS_DLR
from REGION_ITEM a31
where (exists (select *
from REGION_ITEM r21,
LOOKUP_DAY r22
where r21.CUR_TRN_DT = r22.CUR_TRN_DT
and r22.SEASON_ID in (199501)
and r21.ITEM_NBR = a31.ITEM_NBR
and r21.CLASS_NBR = a31.CLASS_NBR))
group by a31.ITEM_NBR,
a31.CLASS_NBR

WHERE EXISTS (SELECT col1, col2…)

select a31.ITEM_NBR ITEM_NBR,

a31.CLASS_NBR CLASS_NBR,
sum(a31.REG_SLS_DLR) REG_SLS_DLR
from REGION_ITEM a31
where (exists (select a31.ITEM_NBR ITEM_NBR,
a31.CLASS_NBR CLASS_NBR
from REGION_ITEM r21,
LOOKUP_DAY r22

15 72 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

where r21.CUR_TRN_DT = r22.CUR_TRN_DT

and r22.SEASON_ID in (199501)
and r21.ITEM_NBR = a31.ITEM_NBR
and r21.CLASS_NBR = a31.CLASS_NBR))
group by a31.ITEM_NBR,
a31.CLASS_NBR

WHERE COL1 IN (SELECT s1.COL1...) falling back to EXISTS (SELECT * ...)

for multiple columns IN

select a31.ITEM_NBR ITEM_NBR,

sum(a31.REG_SLS_DLR) REG_SLS_DLR
from REGION_ITEM a31
where ((a31.ITEM_NBR)
in (select r21.ITEM_NBR ITEM_NBR,
from REGION_ITEM r21,
LOOKUP_DAY r22
where r21.CUR_TRN_DT = r22.CUR_TRN_DT
and r22.SEASON_ID in (199501)))
group by a31.ITEM_NBR

WHERE (COL1, COL2...) IN (SELECT s1.COL1, s1.COL2...)

select a31.ITEM_NBR ITEM_NBR,

a31.CLASS_NBR CLASS_NBR,
sum(a31.REG_SLS_DLR) REG_SLS_DLR
from REGION_ITEM a31
where ((a31.ITEM_NBR,
a31.CLASS_NBR)
in (select r21.ITEM_NBR ITEM_NBR,
r21.CLASS_NBR CLASS_NBR
from REGION_ITEM r21,
LOOKUP_DAY r22
where r21.CUR_TRN_DT = r22.CUR_TRN_DT
and r22.SEASON_ID in (199501)))
group by a31.ITEM_NBR,
a31.CLASS_NBR

U se Temporary Table, falling back to EXISTS (SELEC T *...) for

correlated subquery (default)
create table TEMP1 as
select r21.ITEM_NBR ITEM_NBR,
from REGION_ITEM r21,

© 2019, M icr o St r at egy In c. 15 73

Syst em Ad m in ist r at io n Gu id e

LOOKUP_DAY r22
where r21.CUR_TRN_DT = r22.CUR_TRN_DT
and r22.SEASON_ID in 199501
select a31.ITEM_NBR ITEM_NBR,
sum(a31.REG_SLS_DLR) REG_SLS_DLR
from REGION_ITEM a31
join TEMP1 a32
on a31.ITEM_NBR = a32.ITEM_NBR
group by a31.ITEM_NBR

WHERE COL1 IN (SELECT s1.COL1...) falling back to EXISTS (SELECT

col1, col2 ...) for multiple columns IN

select a31.ITEM_NBR ITEM_NBR,

sum(a31.REG_SLS_DLR) REG_SLS_DLR
from REGION_ITEM a31
where ((a31.ITEM_NBR)
in (select r21.ITEM_NBR ITEM_NBR,
from REGION_ITEM r21,
LOOKUP_DAY r22
where r21.CUR_TRN_DT = r22.CUR_TRN_DT
and r22.SEASON_ID in (199501)))
group by a31.ITEM_NBR

Use Temporary Table, falling back to IN (SELECT COL) for correlated

subquery

create table TEMP1 as

select r21.ITEM_NBR ITEM_NBR,
from REGION_ITEM r21,
LOOKUP_DAY r22
where r21.CUR_TRN_DT = r22.CUR_TRN_DT
and r22.SEASON_ID in 199501
select a31.ITEM_NBR ITEM_NBR,
sum(a31.REG_SLS_DLR) REG_SLS_DLR
from REGION_ITEM a31
join TEMP1 a32
on a31.ITEM_NBR = a32.ITEM_NBR
group by a31.ITEM_NBR

15 74 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Tr an sf o r mat io n Fo r mu la Op t imizat io n
Transformati on Formul a Opti mi zati on i s an advanced property that i s
hi dden by defaul t. For i nformati on on how to di spl ay thi s property, see
Vi ew i ng and C hangi ng Advanced VLD B Properti es, page 1330.

The Transformati on Formul a Opti mi zati on VLD B property al l ow s you

to i mprove the performance of expressi on-based transformati ons.
Performance can be i mproved for reports that i ncl ude expressi on-
based transformati ons and meet the fol l ow i ng requi rements:

l N o attri butes on the report gri d or the R eport Obj ects of the report
are rel ated to the transformati on's member attri bute. For exampl e, i f
a transformati on i s defi ned on the attri bute Year of the Ti me
hi erarchy, no attri butes i n the Ti me hi erarchy can be i ncl uded on
the report gri d or R eport Obj ects.

l The fi l ter of the report does contai n attri butes that are rel ated to the
transformati on's member attri bute. For exampl e, i f a transformati on
i s defi ned on the attri bute Year of the Ti me hi erarchy, a fi l ter on
another attri bute i n the Ti me hi erarchy i s i ncl uded on the report.

For i nformati on on expressi on-based transformati ons and how to

create them, see the Proj ect D esi gn Gui de.

If your report i ncl udes an expressi on-based transformati on Thi s VLD B

property has the fol l ow i ng opti ons:

l A lways join with transformation table to perform transformation:

A j oi n w i th the transformati on tabl e i s used to perform the
transformati on. Thi s opti on supports backw ards compati bi l i ty and
al so serves as a fal l back i f opti mi zati on cannot be appl i ed for the
transformati on.

l U se transformation formula instead of join with transformation

table when possible (defaul t): If the transformati on i s an
expressi on-based transformati on and the report meets the
requi rements l i sted above, the expressi on i s used rather than usi ng

© 2019, M icr o St r at egy In c. 15 75

Syst em Ad m in ist r at io n Gu id e

a j oi n w i th the transformati on tabl e.

Thi s can i mprove performance of expressi on-based transformati ons

by el i mi nati ng the requi rement to j oi n w i th the transformati on tabl e.
If the transformati on i s i ncl uded on a report that cannot support thi s
opti mi zati on, then a j oi n w i th the transformati on tabl e i s
automati cal l y used to support the transformati on. An exampl e of thi s
opti mi zati on i s show n bel ow .

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

The SQL s tatements s hown below dis play a SQL s tatement before
(Statement 1) and after (Statement 2) apply ing the trans formation
optimiz ation.

Statement 1

select a14.CATEGORY_ID CATEGORY_ID,

max(a15.CATEGORY_DESC) CATEGORY_DESC,
sum((a11.QTY_SOLD * (a11.UNIT_PRICE - a11.DISCOUNT)))
WJXBFS1
from ORDER_DETAIL a11
join LU_DAY a12
on (a11.ORDER_DATE = a12.DAY_DATE - 1 YEAR)
join LU_ITEM a13
on (a11.ITEM_ID = a13.ITEM_ID)
join LU_SUBCATEG a14
on (a13.SUBCAT_ID = a14.SUBCAT_ID)
join LU_CATEGORY a15
on (a14.CATEGORY_ID = a15.CATEGORY_ID)
where a12.DAY_DATE = '08/31/2001'
group by a14.CATEGORY_ID

Statement 2

select a14.CATEGORY_ID CATEGORY_ID,

max(a15.CATEGORY_DESC) CATEGORY_DESC,
sum((a11.QTY_SOLD * (a11.UNIT_PRICE - a11.DISCOUNT)))
WJXBFS1
from ORDER_DETAIL a11

15 76 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

join LU_ITEM a13

on (a11.ITEM_ID = a13.ITEM_ID)
join LU_SUBCATEG a14
on (a13.SUBCAT_ID = a14.SUBCAT_ID)
join LU_CATEGORY a15
on (a14.CATEGORY_ID = a15.CATEGORY_ID)
where a11.ORDER_DATE = DATE('08/31/2001') - 1 YEAR
group by a14.CATEGORY_ID

Un r elat ed Filt er Op t io n s
U nrel ated Fi l ter Opti ons i s an advanced property that i s hi dden by
defaul t. For i nformati on on how to di spl ay thi s property, see Vi ew i ng
and C hangi ng Advanced VLD B Properti es, page 1330.

Mi croStrategy contai ns the l ogi c to i gnore fi l ter qual i fi cati ons that are
not rel ated to the templ ate attri butes, to avoi d unnecessary C artesi an
j oi ns. H ow ever, i n some cases a rel ati onshi p i s created that shoul d
not be i gnored. The U nrel ated Fi l ter Opti ons property determi nes
w hether to remove or keep unrel ated fi l ter qual i fi cati ons that are
i ncl uded i n the report's fi l ter or through the use of j oi nt el ement l i sts.
Thi s VLD B property has the fol l ow i ng opti ons:

If filter qualific ations are inc luded as part of a report as filter, all filter
qualific ations are k ept on the report regardles s of whether they are
related or unrelated to the attributes on the report. For information on
us ing the report as filter func tionality , s ee the Advanced R eporti ng
Gui de .

l R emove unrelated filter (defaul t): Any fi l ter qual i fi cati on w i th

attri butes that are unrel ated to any of the attri butes on the report are
removed. An exampl e of how thi s opti on can modi fy a report, i n
compari son to the K eep unrelated filter and put condition from
unrelated attributes in one subquery group opti on, i s provi ded
bel ow .

© 2019, M icr o St r at egy In c. 15 77

Syst em Ad m in ist r at io n Gu id e

l K eep unrelated filter: Thi s opti on i s for backw ard compati bi l i ty.
You shoul d sw i tch to usi ng the K eep unrelated filter and put
condition from unrelated attributes in one subquery group
opti on descri bed bel ow .

l K eep unrelated filter and put condition from unrelated attributes

in one subquery group: Fi l ter qual i fi cati ons that i ncl ude attri butes
that are unrel ated to any of the attri butes on the report are kept on
the report i n certai n scenari os. Thi s means that the fi l teri ng i s
appl i ed to the report. H ow ever, not al l unrel ated fi l ter qual i fi cati ons
are kept on a report i f you sel ect thi s opti on.

For exampl e, you have report w i th a fi l ter on the C ountry attri bute,
and the Year attri bute i s on the report templ ate. Thi s exampl e
assumes that no rel ati onshi p betw een C ountry and Year i s defi ned
i n the schema. In thi s case, the fi l ter i s removed regardl ess of thi s
VLD B property setti ng. Thi s i s because the fi l ter qual i fi cati on does
not i ncl ude any attri butes that coul d be rel ated to the attri butes on
the report.

Thi s setti ng does keep fi l ter qual i fi cati ons i n certai n scenari os. For
exampl e, you have a report that i s defi ned as fol l ow s:

l R eport fi l ters:

l Fi l ter 1= (C ountry, Quarter) i n {(Engl and, 2008 Q3), (France,

2008 Q1)}

l R eport templ ate: Incl udes the Year attri bute

Fi l ter 1 descri bed above coul d be from a j oi nt el ement l i st or a

combi nati on of report fi l ter qual i fi cati ons. Si nce thi s fi l ter
qual i fi cati on i ncl udes the Quarter attri bute, w hi ch i s rel ated to the
Year attri bute, sel ecti ng thi s opti on i ncl udes the fi l teri ng i n the
reports. The SQL generated w i th each setti ng i s as fol l ow s:

15 78 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l R emoved unrel ated fi l ter: The fi l ter qual i fi cati ons on C ountry are
removed from the report and the report SQL, as show n bel ow :
select distinct a11.[YEAR_ID] AS YEAR_ID
from [LU_QUARTER] a11
where (a11.[QUARTER_ID] = 20083
or a11.[QUARTER_ID] = 20081)

l Keep unrel ated fi l ter and put condi ti on from unrel ated attri butes i n
one subquery group: The fi l ter qual i fi cati ons on C ountry are
i ncl uded on the report and i n the report SQL, as show n bel ow :

create table ZZSQ00 (

QUARTER_ID SHORT,
GODWFLAG1_1 LONG,
GODWFLAG2_1 LONG)
insert into ZZSQ00
select distinct s22.[QUARTER_ID] AS QUARTER_ID,
iif((s21.[COUNTRY_ID] = 3 and s22.[QUARTER_ID] =
20083), 1, 0) AS GODWFLAG1_1,
iif((s21.[COUNTRY_ID] = 4 and s22.[QUARTER_ID] =
20081), 1, 0) AS GODWFLAG2_1
from [LU_COUNTRY] s21,
[LU_QUARTER] s22
where ((s21.[COUNTRY_ID] = 3
and s22.[QUARTER_ID] = 20083)
or (s21.[COUNTRY_ID] = 4
and s22.[QUARTER_ID] = 20081))
select distinct a13.[YEAR_ID] AS YEAR_ID
from [ZZSQ00] pa11,
[ZZSQ00] pa12,
[LU_QUARTER] a13
where pa11.[QUARTER_ID] = pa12.[QUARTER_ID] and
pa11.[QUARTER_ID] = a13.[QUARTER_ID]
and (pa11.[GODWFLAG1_1] = 1
and pa12.[GODWFLAG2_1] = 1)

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

© 2019, M icr o St r at egy In c. 15 79

Syst em Ad m in ist r at io n Gu id e

Un r elat ed Filt er Op t io n s f o r Nest ed Met r ics

U nrel ated Fi l ter Opti ons for N ested Metri cs i s an advanced property
that i s hi dden by defaul t. For i nformati on on how to di spl ay thi s
property, see Vi ew i ng and C hangi ng Advanced VLD B Properti es,
page 1330.

The U nrel ated Fi l ter Opti ons property determi nes w hether to remove
or keep unrel ated fi l ter qual i fi cati ons w hen usi ng nested metri cs.
N ested metri cs, or nested aggregati on metri cs, are a type of si mpl e
metri c, w here one aggregati on functi on i s encl osed i nsi de another.
For addi ti onal i nformati on on nested metri cs, see the Advanced
R eporti ng Gui de.

To expl ai n how thi s VLD B property determi nes w hether to keep or

remove unrel ated fi l ter qual i fi cati ons w hen usi ng nested metri cs,
consi der the fol l ow i ng exampl e:

l The fol l ow i ng exampl e w as created i n the Mi croStrategy Tutori al

proj ect, w i th i ts data stored i n a Mi crosoft Access database.

l A report i s created that i ncl udes the fol l ow i ng:

l The C ategory attri bute on the row s of the report.

l A metri c on the col umns of the report. TH e metri c i s defi ned as

Su m ( Ap pl y S i m p l e( " I I f( # 0 = 1 , #1 , 0 ) " , R e g i o n @ ID ,
Su m ( Re ve n u e ) { ~ + } ) ) { ~ }. Thi s metri c returns revenue data
for the N ortheast regi on (R e g i o n @ I D = 1 ) or a zero val ue.

l A report fi l ter that i s defi ned as C a t e g o r y I n L i s t ( B o o k s ).

Thi s report fi l ter returns data onl y for the Books category.

For the exampl e expl ai ned above, the metri c i ncl udes the R egi on
attri bute (through the use of R e g i o n @ I D) and the report fi l ter
i ncl udes the C ategory attri bute. Si nce the C ategory attri bute i s
unrel ated to the R egi on attri bute, i t i s consi dered unrel ated to the
nested metri c's i ncl usi on of the R egi on attri bute.

15 80 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Thi s VLD B property has the fol l ow i ng opti ons:

l U se the 8.1.x behavior (defaul t): Sel ect thi s opti on to use the
behavi or i n Mi croStrategy 8.1.x. In the exampl e descri bed above,
thi s returns the fol l ow i ng SQL statement, w hi ch has been
abbrevi ated for cl ari ty:
insert into ZZTTM6REM4ZMD000
select a11.[CATEGORY_ID] AS CATEGORY_ID,
sum(a11.[TOT_DOLLAR_SALES]) AS WJXBFS1
from [YR_CATEGORY_SLS] a11
where a11.[CATEGORY_ID] in (1)
group by a11.[CATEGORY_ID]
select pa11.[CATEGORY_ID] AS CATEGORY_ID,
max(a13.[CATEGORY_DESC]) AS CATEGORY_DESC0,
sum(IIf(a12.[REGION_ID] = 1, pa11.[WJXBFS1], 0))
AS WJXBFS1
from [ZZTTM6REM4ZMD000] pa11,
[LU_REGION] a12,
[LU_CATEGORY] a13
where pa11.[CATEGORY_ID] = a13.[CATEGORY_ID]
group by pa11.[CATEGORY_ID]

Whi l e the unrel ated fi l ter qual i fi cati on i s kept i n the fi rst pass of
SQL, i t i s removed from the second pass of SQL. Thi s means
that the fi l teri ng on C ategory i s appl i ed to the i nner aggregati on
that returns a summati on of revenue for the N ortheast regi on
onl y. H ow ever, the fi l teri ng on category i s not used i n the fi nal
summati on.

Thi s opti on can be benefi ci al for the processi ng of securi ty

fi l ters, w hi ch can create addi ti onal unrel ated fi l ter qual i fi cati ons
on a report based on a user's securi ty fi l ter constrai nts.
Sel ecti ng thi s opti on can remove some of these unrel ated fi l ter
qual i fi cati ons caused by a user's securi ty fi l ter.

l U se the 9.0.x behavior: Sel ect thi s opti on to use the behavi or i n
Mi croStrategy 9.0.x. In the exampl e descri bed above, thi s returns
the fol l ow i ng SQL statement, w hi ch has been abbrevi ated for
cl ari ty:

© 2019, M icr o St r at egy In c. 15 81

Syst em Ad m in ist r at io n Gu id e

insert into ZZTTM6REM4ZMD000

select a11.[CATEGORY_ID] AS CATEGORY_ID,
sum(a11.[TOT_DOLLAR_SALES]) AS WJXBFS1
from [YR_CATEGORY_SLS] a11
where a11.[CATEGORY_ID] in (1)
group by a11.[CATEGORY_ID]
select pa11.[CATEGORY_ID] AS CATEGORY_ID,
max(a13.[CATEGORY_DESC]) AS CATEGORY_DESC0,
sum(IIf(a12.[REGION_ID] = 1, pa11.[WJXBFS1], 0))
AS WJXBFS1
from [ZZTTM6REM4ZMD000] pa11,
[LU_REGION] a12,
[LU_CATEGORY] a13
where pa11.[CATEGORY_ID] = a13.[CATEGORY_ID]
and pa11.[CATEGORY_ID] in (1)
group by pa11.[CATEGORY_ID]

By usi ng the 9.0.x behavi or, the unrel ated fi l ter qual i fi cati on i s kept
i n both SQL passes. Thi s means that the fi l teri ng on category i s
appl i ed to the i nner aggregati on that returns a summati on of
revenue for the N ortheast regi on onl y. The fi l teri ng on category i s
al so used i n the fi nal summati on.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

WHERE Clau se Dr ivin g Tab le

The Where C l ause D ri vi ng Tabl e property tel l s the Anal yti cal Engi ne
w hat type of col umn i s preferred i n a qual i fi cati on of a WH ER E cl ause
w hen generati ng SQL. One SQL pass usual l y j oi ns fact tabl es and
l ookup tabl es on certai n ID col umns. When a qual i fi cati on i s defi ned
on such a col umn, the Anal yti cal Engi ne can use the col umn i n ei ther
the fact tabl e or the l ookup tabl e. In certai n databases, l i ke Teradata
and R edBri ck, a qual i fi cati on on the l ookup tabl e can achi eve better
performance. By setti ng the Where C l ause D ri vi ng Tabl e property to
U se Lookup Tabl e, the Anal yti cal Engi ne al w ays tri es to pi ck the
col umn from the l ookup tabl e.

15 82 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

If Us e look up table is s elec ted, but there is no look up table in the FROM
c laus e for the c olumn being qualified on, the Analy tic al Engine does not
add the look up table to the FROM c laus e. To mak e s ure that a
qualific ation is done on a look up table c olumn, the DSS Star J oin
property s hould be s et to us e Partial s tar join.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Selecting and Inserting Data with SQL: Select/Insert

The fol l ow i ng tabl e summari zes the Sel ect/Insert VLD B properti es.
Addi ti onal detai l s about each property, i ncl udi ng exampl es w here
necessary, are provi ded i n the secti ons fol l ow i ng the tabl e.

Defau lt
Pro p erty Descrip tio n Po ssib le Valu es
Valu e

Attribute A llows you t o choose • S elect I D f orm only

Selec tion and whet her t o select • S elect I D and ot her
Form Selec tion at t ribut e f orms t hat are f orms if t hey are on S elect I D
Option for on t he t emplat e in t he t emplat e and f orm only
Intermediate int ermediat e pass (if available in
Pas ses available). exist ing join t ree

A llows you t o choose • (Def ault ) S elect

whet her t o select only t he at t ribut es
addit ional at t ribut es needed
(usually parent • S elect ot her
Attribute Form
at t ribut es) needed on at t ribut es in current S elect only
Selec tion Option
t he t emplat e as t he join join t ree if t hey are t he at t ribut es
for Intermediate
t ree and t heir child on t emplat e and needed
Pas s
at t ribut es have already t heir child
been select ed in t he at t ribut es have
A ttribute Form already been
Selection option for select ed.

© 2019, M icr o St r at egy In c. 15 83

Syst em Ad m in ist r at io n Gu id e

Defau lt
Pro p erty Descrip tio n Po ssib le Valu es
Valu e

Intermediate Pass .

Det ermines whet her

mult iple insert
Selec ting and
st at ement s are issued in
Inserting D ata
t he ODB C call, and if User-def ined NULL
w ith SQL:
t oget her, t he st ring t o
Selec t/Ins ert
connect t he mult iple
insert st at ement s.

• P ure select , no
group by
A llows you t o choose
whet her t o use a GROUP • Use max, no group
B Y and how t he GROUP by
C ons tant P ure select ,
B Y should be
C olumn Mode • Group by column no group by
const ruct ed when
(expression)
working wit h a column
t hat is a const ant . • Group by alias

• Group by posit ion

• No int eract ion -

st at ic cust om
group

• A pply report f ilt er No

C us tom Group A llows you def ine how a
t o cust om group int eract ion -
Interaction w ith report f ilt er int eract s
st at ic cust om
the R eport Filter wit h a cust om group. • A pply report f ilt er
group
t o cust om group,
but ignore relat ed
element s f rom t he
report f ilt er

Det ermines whet her dat a • Only ODB C

D ata R etrieval
is ret rieved using t hird- Only ODB C
Mode • A llow Nat ive A P I
part y, nat ive A P I s.

15 84 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Pro p erty Descrip tio n Po ssib le Valu es
Valu e

Def ines t he paramet ers

D ata R etrieval used t o ret rieve dat a
User-def ined NULL
Parameters using t hird-part y, nat ive
A P I s.

• Columns creat ed in
order based on Columns
A llows you t o det ermine at t ribut e weight creat ed in
D ata R etrieval t he order in which
• Columns creat ed in order based
Mode dat amart columns are
order in which t hey on at t ribut e
creat ed.
appear on t he weight
t emplat e

S et s t he f ormat f or dat e
Y Y Y Y -MM-
D ate Format in engine-generat ed User-def ined
DD
S QL.

Let s you def ine t he

D ate Pattern synt ax pat t ern f or Dat e User-def ined NULL
dat a.

Use t o change t he • Use " . " as decimal Use " . " as

decimal separat or in separat or (A NS I decimal
D ec imal S QL st at ement s f rom a st andard) separat or
Separator decimal point t o a
• Use " , " as decimal (A NS I
comma, f or int ernat ional
separat or st andard)
dat abase users.

Use t his t o det ermine

how at t ribut es are • Lowest weight
D efault Attribute Highest
t reat ed, f or t hose
W eight • Highest weight weight
at t ribut es t hat are not in
t he at t ribut e weight s list .

D is able Prefix A llows you t o choose • (Def ault ) Use (Def ault ) Use
in W H Partition whet her or not t o use pref ix in bot h pref ix in bot h
Table t he pref ix part it ion warehouse warehouse

© 2019, M icr o St r at egy In c. 15 85

Syst em Ad m in ist r at io n Gu id e

Defau lt
Pro p erty Descrip tio n Po ssib le Valu es
Valu e

part it ion pre-query

and part it ion query
part it ion pre-
queries. The pref ix is • Use pref ix in query and
always used wit h pre- warehouse part it ion
queries. part it ion prequery query
but not in part it ion
query

I f no aggregat ion is
D is tinc t/Group needed and t he at t ribut e • Use DI S TI NCT
by Option (W hen def ined on t he t able is
• No DI S TI NCT, no Use
N o Aggregation not a primary key, t ells
GROUP B Y DI S TI NCT
and N ot Table t he S QL E ngine whet her
Key ) t o use S elect Dist inct , • Use GROUP B Y
Group by, or neit her.

• Group by
Det ermines how t o
expression
group by a select ed I D
GR OU P BY ID Group by
column when an • Group by alias
Attribute expression
expression is perf ormed • Group by column
on t he I D expression.
• Group by posit ion

Det ermines how t o • Use Max

GR OU P BY
handle columns f or non_ Use Max
N on-ID Attribute • Use Group B y
I D at t ribut es.

Det ermines t he st ring

t hat is insert ed at t he
Insert Post
end of insert and implicit User-def ined NULL
String
t able creat ion
st at ement s.

Det ermines t he st ring

Insert Table
insert ed af t er t able User-def ined NULL
Option
name in insert

15 86 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Defau lt
Pro p erty Descrip tio n Po ssib le Valu es
Valu e

st at ement s; analogous
t o t able opt ion.

Det ermines whet her t o

map long int egers of a • Do not use B igI nt
Long Integer cert ain lengt h as B igI nt Do not use
• Up t o 18 digit s
Support dat a t ypes when B igI nt
MicroS t rat egy creat es • Up t o 19 digit s
t ables in a dat abase.

S et s t he maximum
number of digit s in a
Max D igits in
const ant lit eral in an User-def ined No limit
C ons tant
insert values st at ement .
(0 = no limit ).

Merge Same • Merge same met ric

Det ermines how t o expression Merge same
Metric
handle met rics t hat have met ric
Ex pres sion • Do not merge same
t he same def init ion. expression
Option met ric expression

Def ines t he cust om S QL

st ring t o be appended t o
Selec t Post
all SELECT st at ement s, User-def ined NULL
String
f or example, FOR
FE TCH ONLY .

Selec t Def ines t he cust om S QL

Statement Post st ring t o be appended t o User-def ined NULL
String t he f inal SELECT .

This st ring is placed

SQL H int af t er t he S E LE CT User-def ined NULL
st at ement .

SQL Time Det ermines t he f ormat yyyy-mm-dd

User-def ined
Format of t he t ime lit eral hh: nn: ss

© 2019, M icr o St r at egy In c. 15 87

Syst em Ad m in ist r at io n Gu id e

Defau lt
Pro p erty Descrip tio n Po ssib le Valu es
Valu e

accept ed in S QL
st at ement s.

S et s t he f ormat of t he
Timestamp t imest amp lit eral yyyy-nn-dd
User-def ined
Format accept ed in t he Where hh: mm: ss
clause.

A llows t he A nalyt ical

E ngine t o UNI ON • Do not use UNI ON
U N ION Multiple Do not use
mult iple insert
IN SER T • Use UNI ON UNI ON
st at ement s int o t he
same t emporary t able.

Det ermines whet her t he • Disabled

U se C olumn WCHA R dat a t ype is • E nable ODB C
Type H int for used as applicable t o Column Type Disabled
Parameterized ret urn dat a accurat ely B inding Hint f or
Query while using " WCHA R" and
paramet erized queries. " CHA R"

At t r ib u t e Select io n an d Fo r m Select io n Op t io n f o r
In t er med iat e Passes
N ormal l y, the Mi croStrategy SQL Engi ne sel ects the mi ni mum number
of col umns that are needed i n each pass. For an i ntermedi ate pass,
the SQL Engi ne usual l y onl y sel ects attri bute ID forms. The SQL
Engi ne al so sel ects the attri butes necessary to make the j oi n, usual l y
key attri butes. Then i n the fi nal pass, addi ti onal attri butes or attri bute
forms that are necessary for report di spl ay can be j oi ned.

Thi s al gori thm i s opti mal i n most cases, as i t mi ni mi zes the si ze of

i ntermedi ate tabl es. H ow ever, i n certai n schemas, especi al l y
denormal i zed ones, and schemas that use fact tabl es as both l ookup

15 88 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

tabl es and rel ati onshi p tabl es, such an al gori thm may cause
addi ti onal j oi ns i n the fi nal pass.

A report template c ontains the attributes Region and Store, and metric s M1
and M2. M1 us es the fac t table FT1, whic h c ontains Store_ID, Store_Des c ,
Region_ID, Region_Des c , and f1. M2 us es the fac t table FT2, whic h
c ontains Store_ID, Store_Des c , Region_ID, Region_Des c , and F2. With the
normal SQL Engine algorithm, the intermediate pas s that c alc ulates M1
s elec ts Store_ID and F1, the intermediate pas s that c alc ulates M2 s elec ts
Store_ID and F2. Then the final pas s joins thes e two intermediate tables
together. But that is not enough. Sinc e Region is on the template, it s hould
join upward to the region lev el and find the Region_Des c form. This c an be
done by joining either FT1 or FT2 in the final pas s . So with the original
algorithm, either FT1 or FT2 is being ac c es s ed twic e. If thes e tables are
big, and they us ually are, the performanc e c an be v ery s low. On the other
hand, if Store_ID, Store_Des c , Region_ID, and Region_Des c are pic k ed up
in the intermediate pas s es , there is no need to join FT1 or FT2 in the final
pas s , thus boos ting performanc e.

For thi s reason, the fol l ow i ng tw o properti es are avai l abl e i n

Mi croStrategy:

l Attri bute Form Sel ecti on Opti on for Intermedi ate Pass

l Attri bute Sel ecti on Opti on for Intermedi ate Pass

l Thes e properties intend to us e bigger (wider) intermediate tables to

s av e additional joins in the final pas s and ex c hange s pac e for time.

l Thes e two properties work independently . One does not influenc e the
other.

l Eac h property has two v alues . The default behav ior is the original
algorithm.

l When the property is enabled:

© 2019, M icr o St r at egy In c. 15 89

Syst em Ad m in ist r at io n Gu id e

l The SQL Engine s elec ts additional attributes or attribute forms in

the intermediate pas s , when they are direc tly av ailable.

l The SQL Engine does not join additional tables to s elec t more
attributes or forms . So for intermediate pas s es , the number of
tables to be joined is the s ame as when the property is dis abled.

At t r ib u t e Fo r m Select io n Op t io n f o r In t er med iat e Pass

The Attri bute Form Sel ecti on Opti ons for Intermedi ate Pass property
determi nes w hether or not the SQL Engi ne sel ects the needed
attri bute forms i n the i ntermedi ate passes, i f avai l abl e. See the
descri pti on above for more detai l ed i nformati on.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

At t r ib u t e Select io n Op t io n f o r In t er med iat e Pass

The Attri bute Sel ecti on Opti on for Intermedi ate Pass property
determi nes w hether or not the SQL Engi ne sel ects addi ti onal
attri butes (usual l y parent attri butes) needed on the templ ate, other
than the needed j oi n ID col umn i n the i ntermedi ate passes. See the
descri pti on above for more detai l ed i nformati on.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Bu lk In ser t St r in g
Bul k Insert Stri ng i s an advanced property that i s hi dden by defaul t.
For i nformati on on how to di spl ay thi s property, see Vi ew i ng and
C hangi ng Advanced VLD B Properti es, page 1330.

15 90 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

The Bul k Insert Stri ng property appends the stri ng provi ded i n front of
the IN SER T statement. For Teradata, thi s property i s set to ";" to
i ncrease query performance. The stri ng i s appended onl y for the
IN SER T IN TO SELEC T statements and not the IN SER T IN TO
VALU ES statement that i s generated by the Anal yti cal Engi ne. Si nce
the stri ng i s appended for the IN SER T IN TO SELEC T statement, thi s
property takes effect onl y duri ng expl i ci t, permanent, or temporary
tabl e creati on.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Bu lk In se r t S t r i n g = ;

Co n st an t Co lu mn Mo d e
C onstant C ol umn Mode i s an advanced property that i s hi dden by
defaul t. For i nformati on on how to di spl ay thi s property, see Vi ew i ng
and C hangi ng Advanced VLD B Properti es, page 1330.

C onstant C ol umn Mode al l ow s you to choose w hether or not to use a

GR OU P BY and how the GR OU P BY shoul d be constructed w hen
w orki ng w i th a col umn that i s a constant. The GR OU P BY can be
constructed w i th the col umn, al i as, posi ti on numbers, or col umn
expressi on. Most users do not need to change thi s setti ng. It i s
avai l abl e to be used w i th the new Generi c D BMS obj ect and i f you
w ant to use a di fferent GR OU P BY method w hen w orki ng w i th
constant col umns.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Pure select, no GR OU P B Y (default)

© 2019, M icr o St r at egy In c. 15 91

Syst em Ad m in ist r at io n Gu id e

insert into ZZTP00

select a11.QUARTER_ID QUARTER_ID, 0 XKYCGT,
sum(a11.REG_SLS_DLR) WJXBFS1
from SALES_Q1_2002 a11
group by a11.QUARTER_ID
insert into ZZTP00
select a11.QUARTER_ID QUARTER_ID, 1 XKYCGT,
sum(a11.REG_SLS_DLR) WJXBFS1
from SALES_Q2_2002 a11
group by a11.QUARTER_ID

Use max, no GROUP BY

insert into ZZTP00

select a11.QUARTER_ID QUARTER_ID, MAX(0) XKYCGT,
sum(a11.REG_SLS_DLR) WJXBFS1
from SALES_Q1_2002 a11
group by a11.QUARTER_ID
insert into ZZTP00
select a11.QUARTER_ID QUARTER_ID, MAX(1) XKYCGT,
sum(a11.REG_SLS_DLR) WJXBFS1
from SALES_Q2_2002 a11
group by a11.QUARTER_ID

GROUP BY column (expression)

insert into ZZTP00

select a11.QUARTER_ID QUARTER_ID, 0 XKYCGT,
sum(a11.REG_SLS_DLR) WJXBFS1
from SALES_Q1_2002 a11
group by a11.QUARTER_ID, 0
insert into ZZTP00
select a11.QUARTER_ID QUARTER_ID, 1 XKYCGT,
sum(a11.REG_SLS_DLR) WJXBFS1
from SALES_Q2_2002 a11
group by a11.QUARTER_ID, 1

GROUP BY alias

insert into ZZTP00

select a11.QUARTER_ID QUARTER_ID, 0 XKYCGT,
sum(a11.REG_SLS_DLR) WJXBFS1
from SALES_Q1_2002 a11
group by a11.QUARTER_ID, XKYCGT

15 92 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

insert into ZZTP00

select a11.QUARTER_ID QUARTER_ID, 1 XKYCGT,
sum(a11.REG_SLS_DLR) WJXBFS1
from SALES_Q2_2002 a11
group by a11.QUARTER_ID, XKYCGT

GROUP BY position

insert into ZZTP00

select a11.QUARTER_ID QUARTER_ID, 0 XKYCGT,
sum(a11.REG_SLS_DLR) WJXBFS1
from SALES_Q1_2002 a11
group by a11.QUARTER_ID, 2
insert into ZZTP00
select a11.QUARTER_ID QUARTER_ID, 1 XKYCGT,
sum(a11.REG_SLS_DLR) WJXBFS1
from SALES_Q2_2002 a11
group by a11.QUARTER_ID, 2

Cu st o m Gr o u p In t er act io n wit h t h e Rep o r t Filt er

The C ustom Group Interacti on Wi th the R eport Fi l ter VLD B property
al l ow s you defi ne how a report fi l ter i nteracts w i th a custom group.

When a custom group that i s created usi ng attri bute qual i fi cati ons i s
i ncl uded on a report w i th a report fi l ter, the report fi l ter i s appl i ed to
the i ndi vi dual custom group el ements. H ow ever, i f you create a
custom group usi ng metri c qual i fi cati ons or bandi ng qual i fi cati ons,
report fi l ters are not appl i ed by defaul t to the custom group el ements.

Thi s can cause unexpected resul ts to be returned i n some scenari os.

For exampl e, a custom group di spl ays revenue total s for customers i n
col umns that represent the range of revenue that the customer i s i n. A
customer that has contri buted $7,500 i n revenue di spl ays thi s
revenue total i n the col umn for customers that contri buted $5,000 to
$10,000 i n revenue. Thi s custom group i s i ncl uded on a report that
has a report fi l ter that restri cts resul ts to data for the year 2007 onl y.

In thi s scenari o, the report fi l ter i s eval uated after the custom group. If
the same customer that has a total of $7,500 onl y had $2,500 i n 2007,

© 2019, M icr o St r at egy In c. 15 93

Syst em Ad m in ist r at io n Gu id e

then the report w oul d onl y di spl ay $2,500 for that customer. H ow ever,
the customer w oul d sti l l be i n the $5,000 to $10,000 i n revenue range
because the custom group di d not account for the report fi l ter.

You can defi ne report fi l ter and custom group i nteracti on to avoi d thi s
scenari o. Thi s VLD B property has the fol l ow i ng opti ons:

l N o interaction - static custom group (defaul t): R eport fi l ter

qual i fi cati ons are not appl i ed to custom groups that use metri c
qual i fi cati ons or bandi ng qual i fi cati ons. Fi l teri ng i s onl y appl i ed
after the custom group has been eval uated.

l A pply report filter to custom group: R eport fi l ter qual i fi cati ons are
appl i ed to custom groups and are used to determi ne the val ues for
each custom group el ement.

l A pply report filter to custom group, but ignore related elements

from the report filter: R eport fi l ter qual i fi cati ons that do not qual i fy
on attri bute el ements that are used to defi ne the custom group
el ements are appl i ed to custom groups. These fi l ter qual i fi cati ons
are used to determi ne the val ues for each custom group el ement.
For exampl e, a report fi l ter that qual i fi es on the C ustomer attri bute
i s not appl i ed to a custom group that al so uses the C ustomer
attri bute to defi ne i ts custom group el ements.

For i nformati on on custom groups and defi ni ng these opti ons for a
custom group, see the Advanced R eporti ng Gui de.

Level s at Whi ch You Can Set Thi s

D atabase i nstance

Dat a Ret r ieval Mo d e

The D ata R etri eval Mode VLD B property determi nes w hether data i s
retri eved usi ng thi rd-party, nati ve APIs. You have the fol l ow i ng
opti ons:

15 94 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Only OD B C : Standard methods are used to retri eve data. Thi s

opti on must be used i n al l cases, except for connecti ons that are
expected to make use of the Teradata Paral l el Transporter API.

l A llow N ative A PI: Thi rd-party nati ve APIs can be used to retri eve
data. Mi croStrategy supports the use of the Teradata Paral l el
Transporter API. Enabl i ng Teradata Paral l el Transporter can
i mprove performance w hen retri evi ng l arge amounts of data from
Teradata, typi cal l y 1 Gi gabyte and l arger, w hi ch can occur most
commonl y i n Mi croStrategy w hen publ i shi ng Intel l i gent C ubes.

U si ng Mi croStrategy Web, you can create a connecti on to Teradata

and i mport your data. When creati ng thi s connecti on, enabl i ng the
Teradata Paral l el Transporter opti ons automati cal l y defi nes thi s
VLD B property as Al l ow N ati ve API for the connecti on. For steps to
create thi s type of connecti on i n Mi croStrategy Web, see the Web
U ser H el p.

You can al so sel ect thi s VLD B property opti on for the database
i nstance for Teradata connecti ons that are not created through the
use of D ata Import.

Level s at Whi ch You Can Set Thi s

D atabase i nstance and report

Dat a Ret r ieval Par amet er s

The D ata R etri eval Mode VLD B property defi nes the parameters used
to retri eve data usi ng thi rd-party, nati ve APIs.

For thi s VLD B property to take effect, you must defi ned the D ata
R etri eval Mode VLD B property (see D ata R etri eval Parameters, page
1595) as Al l ow N ati ve API. You can then defi ne the requi red
parameters to retri eve data usi ng the thi rd-party, nati ve API. For

© 2019, M icr o St r at egy In c. 15 95

Syst em Ad m in ist r at io n Gu id e

exampl e, you can enabl e Teradata Paral l el Transporter by defi ni ng

the fol l ow i ng parameters:

l TD _ T DP _ ID : The name or IP ad

l dress of the machi ne on w hi ch the Teradata data source resi des.

l TD _ M AX _ SE S S I O N S: The maxi mum number of sessi ons that can be

used to l og on to the Teradata database w hen processi ng queri es i n
paral l el . By defaul t, one sessi on per Access Process Modul e (AMP)
i s used, w hi ch i s al so the maxi mum number of sessi ons that can be
supported. Type a val ue to al l ow few er sessi ons than the number of
avai l abl e AMPs.

l TD _ M IN _ SE S S I O N S: The mi ni mum number of sessi ons requi red for

the export dri ver j ob to compl ete i ts processes. The defaul t i s one
sessi on. Thi s val ue must be l ess than or equal to the T D _M A X _
SE SS IO NS val ue.

l TD _ M AX _ IN S T A N C E S: The maxi mum number of threads that can be

used. Thi s opti on can be defi ned i f the dri ver has been confi gured
as a master and sl ave envi ronment that al l ow s for mul ti pl e threads.
Thi s val ue must be l ess than or equal to the T D _M A X _S E S S I O N S
val ue, as a thread can i ncl ude one or more sessi ons.

l You can i ncl ude any addi ti onal parameters to appl y to the
connecti on. Provi de each parameter w i th the syntax:
Pa ra me te r N a m e= P a ra m e t e r V a l u e.

When provi di ng the parameters and thei r val ues, each parameter must
be of the form:

ParameterName=ParameterValue

Separate each parameter defi ni ti on w i th a semi col on (;). An exampl e

of the ful l defi ni ti on of thi s VLD B property i s provi ded bel ow :

TD_TDP_ID=123.45.67.89;TD_MAX_SESSIONS=3;TD_MIN_
SESSIONS=1;TD_MAX_INSTANCES=3

15 96 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

U si ng Mi croStrategy Web, you can create a connecti on to Teradata

and i mport your data. When creati ng thi s connecti on, enabl i ng the
Teradata Paral l el Transporter opti ons prompts you for thi s i nformati on
and automati cal l y updates the VLD B property as requi red. For steps
to create thi s type of connecti on i n Mi croStrategy Web, see the
Mi croStrategy Web H el p.

You can al so defi ne thi s VLD B property for the database i nstance for
Teradata connecti ons that are not created through the use of D ata
Import.

Level s at Whi ch You Can Set Thi s

D atabase i nstance and report

Dat a Mar t Co lu mn Or d er
Thi s property al l ow s you to determi ne the order i n w hi ch data mart
col umns are created w hen you confi gure a data mart from the
i nformati on i n the col umns and row s of a report.

You can set thi s property to ei ther of the fol l ow i ng opti ons:

l C olumns created in order based on attribute weight (defaul t):

D ata mart col umns are created i n an order based on thei r attri bute
w ei ghts. For more i nformati on about attri bute w ei ghts, see D ata
Mart C ol umn Order, page 1597.

l C olumns created in order in which they appear on the template:

D ata mart col umns are created i n the same order as they appear on
the report templ ate.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

© 2019, M icr o St r at egy In c. 15 97

Syst em Ad m in ist r at io n Gu id e

Dat e Fo r mat
The D ate Format VLD B property speci fi es the format of the date stri ng
l i teral i n the SQL statements w hen date-rel ated qual i fi cati ons are
present i n the report.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Def ault yyyy-mm-dd

Oracle dd-mmm-yy

Teradat a yyyy/mm/dd

Dat e Pat t er n
D ate Pattern i s an advanced VLD B property that i s hi dden by defaul t.
For i nformati on on how to di spl ay thi s property, see Vi ew i ng and
C hangi ng Advanced VLD B Properti es, page 1330.

The D ate Pattern VLD B property i s used to add or al ter a syntax

pattern for handl i ng date col umns.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Def ault No ext ra synt ax pat t ern f or handling dat es

Oracle To_Date ('#0')

Tandem (d'#0')

15 98 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Decimal Sep ar at o r
The D eci mal Separator VLD B property speci fi es w hether a "." or "," i s
used as a deci mal separator. Thi s property i s used for non-Engl i sh
databases that use commas as the deci mal separator.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

" ." as the decimal separator (default)

select a11.DEPARTMENT_NBR DEPARTMENT_NBR,
a11.STORE_NBR STORE_NBR
into #ZZTIS00H5K4MQ000
from HARI_COST_STORE_DEP a11
group by a11.DEPARTMENT_NBR,
a11.STORE_NBR
having sum(a11.COST_AMT) > 654.357

"," as the decimal separator

select a11.DEPARTMENT_NBR DEPARTMENT_NBR,

a11.STORE_NBR STORE_NBR
into #ZZTIS00H5K5MQ000
from HARI_COST_STORE_DEP a11
group by a11.DEPARTMENT_NBR,
a11.STORE_NBR
having sum(a11.COST_AMT) > 654,357

Def au lt At t r ib u t e Weigh t
The D efaul t Attri bute Wei ght i s an advanced property that i s hi dden
by defaul t. For i nformati on on how to di spl ay thi s property, see
Vi ew i ng and C hangi ng Advanced VLD B Properti es, page 1330.

U se the D efaul t Attri bute Wei ght property to determi ne how attri bute
w ei ghts shoul d be treated, for those attri butes that are not i n the
attri bute w ei ghts l i st.

© 2019, M icr o St r at egy In c. 15 99

Syst em Ad m in ist r at io n Gu id e

You c an ac c es s the attribute weights lis t from the Projec t Configuration

Editor. In the Projec t Configuration Editor, ex pand R eport D efinition
and s elec t SQL generation . From the Attribute weights s ec tion, c lic k
Modify to open the attribute weights lis t.

The attri bute w ei ghts l i st al l ow s you to change the order of attri butes
used i n the SELEC T cl ause of a query. For exampl e, suppose the
R egi on attri bute i s pl aced hi gher on the attri bute w ei ghts l i st than the
C ustomer State attri bute. When the SQL for a report contai ni ng both
attri butes i s generated, R egi on i s referenced i n the SQL before
C ustomer State. H ow ever, suppose another attri bute, Quarter, al so
appears on the report templ ate but i s not i ncl uded i n the attri bute
w ei ghts l i st.

In thi s case, you can sel ect ei ther of the fol l ow i ng opti ons w i thi n the
D efaul t Attri bute Wei ght property to determi ne w hether Quarter i s
consi dered hi ghest or l ow est on the attri bute w ei ghts l i st:

l Lowest: When you sel ect thi s opti on, those attri butes not i n the
attri bute w ei ghts l i st are treated as the l i ghtest w ei ght. U si ng the
exampl e above, w i th thi s setti ng sel ected, Quarter i s consi dered to
have a l i ghter attri bute w ei ght than the other tw o attri butes.
Therefore, i t i s referenced after R egi on and C ustomer State i n the
SELEC T statement.

l H ighest (defaul t): When you sel ect thi s opti on, those attri butes not
i n the attri bute w ei ghts l i st are treated as the hi ghest w ei ght. U si ng
the exampl e above, w i th thi s setti ng sel ected, Quarter i s consi dered
to have a hi gher attri bute w ei ght than the other tw o attri butes.
Therefore, i t i s referenced before R egi on and C ustomer State i n the
SELEC T statement.

Level s at Whi ch You Can Set Thi s

D atabase i nstance onl y

1600 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Disab le Pr ef ix in WH Par t it io n Tab le

The D i sabl e Prefi x i n WH Parti ti on Tabl e i s an advanced property that
i s hi dden by defaul t. For i nformati on on how to di spl ay thi s property,
see Vi ew i ng and C hangi ng Advanced VLD B Properti es, page 1330.

Thi s property al l ow s you to provi de better support of w arehouse

parti ti oni ng i n a di stri buted database envi ronment.

In a di stri buted database envi ronment, di fferent tabl es can have

di fferent prefi xes. Thi s i s al so true for parti ti oni ng. On one hand, the
parti ti on-mappi ng tabl e (PMT) may have a di fferent prefi x from the
parti ti on base tabl e (PBT). On the other hand, each PBT may need i ts
ow n prefi x. In Mi croStrategy 6.x and earl i er, thi s i s achi eved by
addi ng one addi ti onal col umn (D D BSOU R C E) i n the PMT to i ndi cate
w hi ch tabl e source (prefi x) to use. Mi croStrategy 7.x and l ater uses
metadata (MD ) parti ti oni ng and w arehouse (WH ) parti ti oni ng. MD
parti ti oni ng can handl e di stri buted databases easi l y, because the
metadata contai ns the PMT as w el l as the PBT. For WH parti ti oni ng, i t
onl y has the PMT i n the metadata, so i t can onl y set prefi xes on the
PMT. C urrentl y, thi s prefi x i s shared by both the PMT and the PBT. In
other w ords, both the parti ti on prequery (usi ng PMT) and the parti ti on
query (usi ng PBT) use the same prefi x.

For those proj ects that need thei r ow n prefi x i n the PBT, the
Mi croStrategy 6.x approach (usi ng the D D BSOU R C E col umn) no
l onger w orks due to archi tectural changes. The sol uti on i s to store the
prefi x al ong w i th the PBT name i n the col umn PBTN AME of the
parti ti on mappi ng tabl e. So i nstead of stori ng PBT1, PBT2, and so on,
you can put i n D B1.PBT1, D B2.PBT2, and so on. Thi s effecti vel y adds
a di fferent prefi x to di fferent PBTs by treati ng the enti re stri ng as the
parti ti on base tabl e name.

The sol uti on above w orks i n most cases but does not w ork i f the PMT
needs i ts ow n prefi x. For exampl e, i f the PMT has the prefi x "D B0.",
the prequery w orks fi ne. H ow ever, i n the parti ti on query, thi s prefi x i s

© 2019, M icr o St r at egy In c. 1601

Syst em Ad m in ist r at io n Gu id e

added to w hat i s stored i n the PBTN AME col umn, so i t gets

D B0.D B1.PBT1, D B0.D B1.PBT2, and so on. Thi s i s not w hat you w ant
to happen. Thi s new VLD B property i s used to di sabl e the prefi x i n
the WH parti ti on tabl e. When thi s property i s turned on, the parti ti on
query no l onger shares the prefi x from the PMT. Instead, the
PBTN AME col umn (D B1.PBT1, D B2.PBT2, and so on) i s used as the
ful l PBT name.

Ev en when this property is turned ON, the partition prequery s till applies
a prefix , if there is one.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Dist in ct / Gr o u p b y Op t io n (Wh en No Aggr egat io n an d No t

Tab le Key)
The D i sti nct/Group by Opti on property control s the generati on of
D ISTIN C T or GR OU P BY i n the SELEC T SQL statement. You can
sel ect from the fol l ow i ng opti ons:

l U se D ISTIN C T (defaul t)

l No DISTINCT, no GROUP BY

l Use GROUP BY

If you are using a Vertica database that includes correlated subqueries, to

support the use of the Use GROUP By option listed above, you must also
define the Sub Query Type VLDB property (see Optimizing Queries, page
1503) to use either of the following options:

Use Temporary Table, falling back to EXISTS (SELECT *...) for correlated
subquery

1602 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Use Temporary Table, falling back to IN (SELECT COL) for correlated

subquery

U pon sel ecti ng an opti on, a sampl e SQL statement show s the effect
that each opti on has.

The SQL Engi ne i gnores the opti on sel ected for thi s property i n the
fol l ow i ng si tuati ons:

l If there i s aggregati on, GR OU P BY i s used w i thout the use of

D ISTIN C T.

l If there i s no attri bute (onl y metri cs), D ISTIN C T i s not used.

l If there i s C OU N T (D ISTIN C T …) and the database does not

support thi s functi onal i ty, a SELEC T D ISTIN C T pass of SQL i s
used, w hi ch i s fol l ow ed by a C OU N T(*) pass of SQL.

l If the database does not al l ow D ISTIN C T or GR OU P BY for certai n

col umn data types, D ISTIN C T and GR OU P BY are not used.

l If the sel ect l evel i s the same as the tabl e key l evel and the tabl e's
true key property i s sel ected, D ISTIN C T i s not used.

When none of the above condi ti ons are met, the opti on sel ected for
thi s property determi nes how D ISTIN C T and GR OU P BY are used i n
the SQL statement.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

GROUP BY ID At t r ib u t e
The GR OU P BY ID Attri bute i s an advanced property that i s hi dden by
defaul t. For i nformati on on how to di spl ay thi s property, see Vi ew i ng
and C hangi ng Advanced VLD B Properti es, page 1330.

© 2019, M icr o St r at egy In c. 1603

Syst em Ad m in ist r at io n Gu id e

Thi s property determi nes how to group by a sel ected ID col umn w hen
an expressi on i s performed on the ID expressi on. Each of the opti ons
i s descri bed bel ow .

The code fragment fol l ow i ng each descri pti on repl aces the secti on
named group by ID i n the fol l ow i ng sampl e SQL statement.

select a22.STORE_NBR STORE_NBR,

a22.MARKET_NBR * 10 MARKET_ID,
sum(a21.REG_SLS_DLR) WJXBFS1
from STORE_DIVISION a21
join LOOKUP_STORE a22
on (a21.STORE_NBR = a22.STORE_NBR)
where a22.STORE_NBR = 1
group by a22.STORE_NBR, group by ID

The opti ons for thi s property are:

l Group by expression (defaul t): Group by the expressi on performed

i n the SE LE C T statement on the ID col umn.

a2 2. MA RK E T _ N B R * 1 0

l Group by alias: Group by the expressi on al i as i n the Sel ect

statement.

MA RK ET _ ID

l Group by column: Group by the col umn ID , i gnori ng the expressi on

performed on the ID col umn.

a2 2. MA RK E T _ N B R

l Group by position: Group by the physi cal tabl e posi ti on of the ID

col umn.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

1604 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

GROUP BY No n -ID At t r ib u t e
The GR OU P BY N on-ID Attri bute property control s w hether or not
non-ID attri bute forms—l i ke descri pti ons—are used i n the GR OU P BY.
If you do not w ant non-ID col umns i n the GR OU P BY, you can choose
to use a MAX w hen the col umn i s sel ected so that i t i s not used i n the
GR OU P BY.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

U se Max (default)
select a11.MARKET_NBR MARKET_NBR,
max(a14.MARKET_DESC) MARKET_DESC,
a11.CLASS_NBR CLASS_NBR,
max(a13.CLASS_DESC) CLASS_DESC,
a12.YEAR_ID YEAR_ID,
max(a15.YEAR_DESC) YEAR_DESC,
sum(a11.TOT_SLS_DLR) TOTALSALES
from MARKET_CLASS a11
join LOOKUP_DAY a12
on (a11.CUR_TRN_DT = a12.CUR_TRN_DT)
join LOOKUP_CLASS a13
on (a11.CLASS_NBR = a13.CLASS_NBR)
join LOOKUP_MARKET a14
on (a11.MARKET_NBR = a14.MARKET_NBR)
join LOOKUP_YEAR a15
on (a12.YEAR_ID = a15.YEAR_ID)
group by a11.MARKET_NBR, a11.CLASS_NBR,
a12.YEAR_ID

Use Group by

select a11.MARKET_NBR MARKET_NBR,

a14.MARKET_DESC MARKET_DESC,
a11.CLASS_NBR CLASS_NBR,
a13.CLASS_DESC CLASS_DESC,
a12.YEAR_ID YEAR_ID,
a15.YEAR_DESC YEAR_DESC,
sum(a11.TOT_SLS_DLR) TOTALSALES

© 2019, M icr o St r at egy In c. 1605

Syst em Ad m in ist r at io n Gu id e

from MARKET_CLASS a11

join LOOKUP_DAY a12
on (a11.CUR_TRN_DT = a12.CUR_TRN_DT)
join LOOKUP_CLASS a13
on (a11.CLASS_NBR = a13.CLASS_NBR)
join LOOKUP_MARKET a14
on (a11.MARKET_NBR = a14.MARKET_NBR)
join LOOKUP_YEAR a15
on (a12.YEAR_ID = a15.YEAR_ID)
group by a11.MARKET_NBR,
a14.MARKET_DESC,
a11.CLASS_NBR,
a13.CLASS_DESC,
a12.YEAR_ID,
a15.YEAR_DESC

In ser t Po st St r in g
The Insert Post Stri ng property al l ow s you to defi ne a custom stri ng to
be i nserted at the end of the IN SER T statements.

The # c harac ter is a s pec ial tok en that is us ed in v arious patterns and is
treated differently than other c harac ters . One s ingle # is abs orbed and
two # are reduc ed to a s ingle #. For ex ample to s how three # c harac ters
in a s tatement, enter s ix # c harac ters in the c ode. You c an get any
des ired s tring with the right number of # c harac ters . Us ing the #
c harac ter is the s ame as us ing the ; c harac ter.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Insert into TABLENAME

select A1.COL1, A2.COL2, A3.COL3
from TABLE1 A1, TABLE2 A2, TABLE3 A3
where A1.COL1=A2.COL1 and A2.COL4=A3.COL5 */Insert
Post String/*

1606 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

In ser t Tab le Op t io n
The Insert Tabl e Opti on property al l ow s you to defi ne a custom stri ng
to be i nserted after the tabl e name i n the i nsert statements. Thi s i s
anal ogous to tabl e opti on.

The # c harac ter is a s pec ial tok en that is us ed in v arious patterns and is
treated differently than other c harac ters . One s ingle # is abs orbed and
two # are reduc ed to a s ingle #. For ex ample to s how three # c harac ters
in a s tatement, enter s ix # c harac ters in the c ode. You c an get any
des ired s tring with the right number of # c harac ters . Us ing the #
c harac ter is the s ame as us ing the ; c harac ter.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Insert into TABLENAME */Insert Table Option/*

select A1.COL1, A2.COL2, A3.COL3
from TABLE1 A1, TABLE2 A2, TABLE3 A3
where A1.COL1 = A2.COL1 and A2.COL4=A3.COL5

Lo n g In t eger Su p p o r t
Long i nteger support i s an advanced property that i s hi dden by
defaul t. For i nformati on on how to di spl ay thi s property, see Vi ew i ng
and C hangi ng Advanced VLD B Properti es, page 1330.

Wi th thi s VLD B property you can determi ne w hether l ong i ntegers are
mapped to a Bi gInt data type w hen Mi croStrategy creates tabl es i n the
database. A data mart i s an exampl e of a Mi croStrategy feature that
requi res Mi croStrategy to create tabl es i n a database.

When l ong i ntegers from databases are i ntegrated i nto Mi croStrategy,

the Bi g D eci mal data type i s used to defi ne the data i n Mi croStrategy.
Long i ntegers can be of vari ous database data types such as N umber,
D eci mal , and Bi gInt.

© 2019, M icr o St r at egy In c. 1607

Syst em Ad m in ist r at io n Gu id e

In the case of Bi gInt, w hen data that uses the Bi gInt data type i s
i ntegrated i nto Mi croStrategy as a Bi g D eci mal , thi s can cause a data
type mi smatch w hen Mi croStrategy creates a tabl e i n the database.
Mi croStrategy does not use the Bi gInt data type by defaul t w hen
creati ng tabl es. Thi s can cause a data type mi smatch betw een the
ori gi nati ng database tabl e that contai ned the Bi gInt and the database
tabl e created by Mi croStrategy.

You can use the fol l ow i ng VLD B setti ngs to support Bi gInt data types:

l D o not use B igInt (defaul t): Long i ntegers are not mapped as Bi gInt
data types w hen Mi croStrategy creates tabl es i n the database. Thi s
i s the defaul t behavi or.

If you use Bi gInt data types, thi s can cause a data type mi smatch
betw een the ori gi nati ng database tabl e that contai ned the Bi gInt
and the database tabl e created by Mi croStrategy.

l U p to 18 digits: Long i ntegers that have up to 18 di gi ts are

converted i nto Bi gInt data types.

Thi s setti ng i s a good opti on i f you can ensure that your Bi gInt data
uses no more than 18 di gi ts. The maxi mum number of di gi ts that a
Bi gInt can use i s 19. Wi th thi s opti on, i f your database contai ns
Bi gInt data that uses al l 19 di gi ts, i t i s not mapped as a Bi gInt data
type w hen Mi croStrategy creates a tabl e i n the database.

H ow ever, usi ng thi s setti ng requi res you to manual l y modi fy the
col umn data type mapped to your Bi gInt data. You can achi eve thi s
by creati ng a col umn al i as for the col umn of data i n the Attri bute
Edi tor or Fact Edi tor i n Mi croStrategy. The col umn al i as must have
a data type of Bi g D eci mal , a preci si on of 18, and a scal e of zero.
For steps to create a col umn al i as to modi fy a col umn data type, see
the Proj ect D esi gn Gui de.

l U p to 19 digits: Long i ntegers that have up to 19 di gi ts are

converted i nto Bi gInt data types.

1608 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

U si ng thi s opti on enabl es Bi gInt data that uses up to 19 di gi ts to be

correctl y mapped as a Bi gInt data types w hen Mi croStrategy creates
tabl es i n the database. Thi s opti on does not requi re you to create a
col umn al i as.

H ow ever, thi s opti on can cause an overfl ow error i f you have l ong
i ntegers that use exactl y 19 di gi ts, and i ts val ue i s greater than the
maxi mum al l ow ed for a Bi gInt (9,223,372,036,854,775,807).

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Max Digit s in Co n st an t
Max D i gi ts i n C onstant i s an advanced property that i s hi dden by
defaul t. For i nformati on on how to di spl ay thi s property, see Vi ew i ng
and C hangi ng Advanced VLD B Properti es, page 1330.

The Max D i gi ts i n C onstant property control s the number of si gni fi cant

di gi ts that get i nserted i nto col umns duri ng Anal yti cal Engi ne i nserts.
Thi s i s onl y appl i cabl e to real numbers and not to i ntegers.

Level s at Whi ch You Can Set Thi s

D atabase i nstance onl y

D atabase-specific setting

S QL S erver 28

Teradat a 18

Max Const Digits = 0

Insert into #ZZTIS00H6WQMD001 values (4, 339515.0792)

Max Const Digits = 2

© 2019, M icr o St r at egy In c. 1609

Syst em Ad m in ist r at io n Gu id e

Insert into #ZZTIS00H6WTMD001 values (4, 33)

Max Const Digits = 7

Insert into #ZZTIS00H6WVMD001 values (4, 339515.0)

Mer ge Same Met r ic Exp r essio n Op t io n

The Merge Same Metri c Expressi on Opti on VLD B property al l ow s you
to determi ne w hether the SQL Engi ne shoul d merge metri cs that have
the same defi ni ti on, or w hether i t shoul d process the metri cs
separatel y. If you do not w ant metri cs w i th i denti cal defi ni ti ons to be
merged, sel ect D o not merge same metric expression.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Select Po st St r in g
The Sel ect Post Stri ng property al l ow s you to defi ne a custom stri ng
to be i nserted at the end of al l S E L E C T statements generated by the
Anal yti cal Engi ne.

To i ncl ude a post stri ng onl y on the fi nal S E L E C T statement you

shoul d use the Sel ect Statement Post Stri ng VLD B property, w hi ch i s
descri bed i n Sel ect Post Stri ng, page 1610.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

The SQL s tatement s hown below dis play s an ex ample of where the Selec t
Pos t String and Selec t Statement Pos t String VLDB properties would
inc lude their SQL s tatements .

with gopa1 as
(select a12.REGION_ID REGION_ID
from CITY_CTR_SLS a11

1610 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

join LU_CALL_CTR a12

on (a11.CALL_CTR_ID = a12.CALL_CTR_ID)
group by a12.REGION_ID
having sum(a11.TOT_UNIT_SALES) = 7.0
/* select post string */)select
a11.REGION_ID REGION_ID,
a14.REGION_NAME REGION_NAME0,
sum(a11.TOT_DOLLAR_SALES) Revenue
from STATE_SUBCATEG_REGION_SLS a11
join gopa1 pa12
on (a11.REGION_ID = pa12.REGION_ID)
join LU_SUBCATEG a13
on (a11.SUBCAT_ID = a13.SUBCAT_ID)
join LU_REGION a14
on (a11.REGION_ID = a14.REGION_ID)
where a13.CATEGORY_ID in (2)
group by a11.REGION_ID,
a14.REGION_NAME/* select post string */
/* select statement post string */

Select St at emen t Po st St r in g
The Sel ect Statement Post Stri ng VLD B property al l ow s you to defi ne
a custom SQL stri ng to be i nserted at the end of the fi nal S E L E C T
statement.

Thi s can be hel pful i f you use common tabl e expressi ons w i th an IBM
D B2 database. These common tabl e expressi ons do not support
certai n custom SQL stri ngs. Thi s VLD B property al l ow s you to appl y
the custom SQL stri ng to onl y the fi nal S E L E C T statement w hi ch does
not use a common tabl e expressi on.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

The SQL s tatement s hown below dis play s an ex ample of where the Selec t
Pos t String and Selec t Statement Pos t String VLDB properties inc lude their

© 2019, M icr o St r at egy In c. 1611

Syst em Ad m in ist r at io n Gu id e

SQL s tatements .

with gopa1 as
(select a12.REGION_ID REGION_ID
from CITY_CTR_SLS a11
join LU_CALL_CTR a12
on (a11.CALL_CTR_ID = a12.CALL_CTR_ID)
group by a12.REGION_ID
having sum(a11.TOT_UNIT_SALES) = 7.0
/* select post string */)select
a11.REGION_ID REGION_ID,
a14.REGION_NAME REGION_NAME0,
sum(a11.TOT_DOLLAR_SALES) Revenue
from STATE_SUBCATEG_REGION_SLS a11
join gopa1 pa12
on (a11.REGION_ID = pa12.REGION_ID)
join LU_SUBCATEG a13
on (a11.SUBCAT_ID = a13.SUBCAT_ID)
join LU_REGION a14
on (a11.REGION_ID = a14.REGION_ID)
where a13.CATEGORY_ID in (2)
group by a11.REGION_ID,
a14.REGION_NAME/* select post string */
/* select statement post string */

SQL Hin t
The SQL H i nt property i s used for the Oracl e SQL H i nt pattern. Thi s
stri ng i s pl aced after the SELEC T w ord i n the Sel ect statement. Thi s
property can be used to i nsert any SQL stri ng that makes sense after
the SELEC T i n a Sel ect statement, but i t i s provi ded speci fi cal l y for
Oracl e SQL H i nts.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

SQL Hint = /* FULL */

Select /* + FULL */ A1.STORE_NBR,
max(A1.STORE_DESC)
From LOOKUP_STORE A1

1612 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Where A1.STORE_NBR = 1
Group by A1.STORE_NBR

SQL Time Fo r mat

The SQL Ti me Format property al l ow s you to determi ne the format of
the ti me l i teral accepted i n SQL statements. Thi s i s a database-
speci fi c property; some exampl es are show n i n the tabl e bel ow .

Exam p l e

Datab ase T yp e T ime F o rmat

Def ault yyyy-mm-dd hh:nn:ss

Microsof t S QL mm/dd/yyyy
hh:nn:ss
S erver

Oracle
mm/dd/yyyy
hh:nn:ss

S ybase I Q hh:nn:ss:lll

Level s at Whi ch You Can Set Thi s

D atabase i nstance, templ ate, and report

Timest amp Fo r mat

The Ti mestamp Format property al l ow s you to determi ne the format of
the ti mestamp l i teral accepted i n the WH ER E cl ause. Thi s i s a
database-speci fi c property; some exampl es are show n i n the tabl e
bel ow .

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

© 2019, M icr o St r at egy In c. 1613

Syst em Ad m in ist r at io n Gu id e

Exam p l e

Def ault yyyy-mm-dd hh:nn:ss

DB 2 yyyy-mm-dd-hh.nn.ss

RedB rick mm/dd/yyyy hh:nn:ss

UNION Mu lt ip le INSERT
The U ni on Mul ti pl e Insert property al l ow s the Anal yti cal Engi ne to
U N ION mul ti pl e IN SER T statements i nto the same temporary tabl e.
Thi s i s a database-speci fi c property. Some databases do not support
the use of U ni ons.

Level s at Whi ch You Can Set Thi s

D atabase i nstance, report, and templ ate

Dat ab ases Aut om at i cal l y Set t o U se U ni on

l D B2 U D B

l SQL Server

l Teradata

Use Co lu mn Typ e Hin t f o r Par amet er ized Qu er y

U se C ol umn Type H i nt for Parameteri zed Query i s an advanced
property that i s hi dden by defaul t. For i nformati on on how to di spl ay
thi s property, see Vi ew i ng and C hangi ng Advanced VLD B Properti es,
page 1330.

The U se C ol umn Type H i nt for Parameteri zed Query VLD B property

determi nes w hether the WC H AR data type i s used w hen appl i cabl e to
return data accuratel y w hi l e usi ng parameteri zed queri es. Thi s VLD B
property has the fol l ow i ng opti ons:

1614 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l D isabled (defaul t): Thi s opti on i s recommended unl ess you are
encounteri ng the data i nconsi stenci es descri bed bel ow .

l Enable OD B C C olumn Type B inding H int for " WC H A R " and

" C H A R " : Thi s opti on shoul d be used onl y i f you have enabl ed
parameteri zed queri es i n Mi croStrategy for your database and data
i s not bei ng correctl y di spl ayed on reports. Thi s can i ncl ude
vi ew i ng questi on marks i n pl ace of other val i d characters. Thi s can
occur for N etezza databases.

By sel ecti ng thi s opti on, the WC H AR data type i s used w hen
appl i cabl e so that the data i s returned correctl y w hi l e usi ng
parameteri zed queri es.

Level s at Whi ch You Can Set Thi s

D atabase i nstance onl y

Creating and Supporting Tables with SQL: Tables

The tabl e bel ow summari zes the Tabl es VLD B properti es that are
avai l abl e. Addi ti onal detai l s about each property, i ncl udi ng exampl es
w here necessary, are provi ded i n the secti ons fol l ow i ng the tabl e.

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

Used t o alt er t he
pat t ern f or aliasing
column names.
Alias Pattern User-def ined AS
A ut omat ically set f or
Microsof t A ccess
users.

Def ines t he column

Attribute ID const raint s (f or
User-def ined NULL
C ons traint example, NULL or NOT
NULL) put on t he I D

© 2019, M icr o St r at egy In c. 1615

Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

f orm of at t ribut es.

C haracter
C olumn Option Def ines how t o support
and N ational mult iple charact er set s User-def ined NULL
C haracter used in Teradat a.
C olumn Option

Used t o alt er t he
C olumn Pattern pat t ern f or column User-def ined #0. [ #1]
names.

• No Commit
Det ermines whet her t o af t er t he f inal
Drop st at ement No Commit af t er
C ommit After issue a COMMI T
t he f inal Drop
Final D rop st at ement af t er t he • Commit af t er st at ement
f inal DROP st at ement t he f inal Drop
st at ement

• No Commit
S et s when t o issue a • P ost DDL
COMMI T st at ement
C ommit Lev el • P ost DML No Commit
af t er creat ing an
int ermediat e t able. • P ost DDL and
DML

• CRE A TE and
Def ines whet her I NS E RT
MicroS t rat egy can st at ement s are CRE A TE and
perf orm CREATE and support ed
C R EATE and I NS E RT
INSERT st at ement s
IN SER T Support • CRE A TE and st at ement s are
against t he dat abase
I NS E RT support ed
f or a dat abase
inst ance. st at ement s are
not support ed

Creat e P ost Def ines t he st ring

User-def ined NULL
S t ring appended af t er t he

1616 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

(see Table
Prefix , Table
Qualifier, Table
CRE A TE TA B LE
Option, Table
st at ement .
D es criptor, Table
Space, & C reate
Pos t String )

• Drop af t er f inal
pass
Det ermines when t o
D rop Temp Table • Do not hing Drop af t er f inal
drop an int ermediat e
Method pass
object . • Truncat e t able
t hen drop af t er
f inal pass

Det ermines t he t ype of

• P ermanent t able
t able t hat is generat ed
Fallbac k Table if t he A nalyt ical • True t emporary
P ermanent t able
Type E ngine cannot t able
generat e a derived
• Fail report
t able or common t able.

• Do not apply
hexadecimal
charact er
A llows st ring t ransf ormat ion
charact ers t o be t o quot ed Do not apply
H ex adecimal convert ed int o specif ic st rings hexadecimal
C haracter charact er encoding • A pply charact er
Trans formation required f or some hexadecimal t ransf ormat ion
Unicode charact er t o quot ed st rings
implement at ions. t ransf ormat ion
t o quot ed
st rings of all
charact er t ypes

© 2019, M icr o St r at egy In c. 1617

Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

• A pply
hexadecimal
charact er
t ransf ormat ion
t o quot ed
st rings of t ype
NChar and
NV arChar

• P ermanent t able

• Derived t able

Det ermines t he t ype of • Common t able

Intermediate
int ermediat e (t emp) expression P ermanent t able
Table Type
t able t o creat e.
• True t emporary
t able

• Temporary view

Det ermines how many

passes are allowed f or
a report t hat uses
int ermediat e t ables. I f
Max imum SQL
a report exceeds t his
Pas ses Before User-def ined No limit
limit , t he t able t ype
FallBac k
def ined by t he
Fallback Table Type
V LDB propert y is used
f or t he report .

Det ermines how many

t ables in a single
Max imum Tables FROM clause are
in FR OM C laus e allowed f or a report User-def ined No limit
Before FallBac k t hat uses int ermediat e
t ables. I f a report
exceeds t his limit , t he

1618 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

t able t ype def ined by

t he Fallback Table
Type V LDB propert y is
used f or t he report .

N ational Def ines how t o support

C haracter mult iple charact er set s User-def ined NULL
C olumn Option used in Teradat a.

• P ermanent
Det ermines t he t ype of Table
Parallel SQL
int ermediat e t able • Derived Table
Ex ecution
creat ed when parallel wit h Fallback P ermanent Table
Intermediate
query execut ion is Table Type as
Table Type
used. P ermanent
Table

Det ermines t he • E xplicit t able

Table C reation
met hod t o creat e an E xplicit t able
Type • I mplicit t able
int ermediat e t able.

Table Descript or

(see Table Def ines t he st ring t o

Prefix , Table be placed af t er t he
Qualifier, Table word TA B LE in t he User-def ined NULL
Option, Table CRE A TE TA B LE
D es criptor, Table st at ement .
Space, & C reate
Pos t String )

Table Opt ion

(see Table Def ines t he st ring t o

Prefix , Table be placed af t er t he
Qualifier, Table t able name in t he User-def ined NULL
Option, Table CRE A TE TA B LE
D es criptor, st at ement .
Table Space, &

© 2019, M icr o St r at egy In c. 1619

Syst em Ad m in ist r at io n Gu id e

Pro p erty Descrip tio n Po ssib le Valu es Defau lt Valu e

C reate Post
String )

Table P ref ix

(see Table Def ines t he st ring t o

Prefix , Table be added t o a t able
Qualifier, Table name, f or example,
User-def ined NULL
Option, Table CRE A TE TA B LE
D es criptor, Table pref ix. Tablename.
Space, & C reate (S ee Not e below. )
Pos t String )

Table Qualif ier

(see Table
Prefix , Table Def ines t he key words
Qualifier, Table placed immediat ely
Option, Table bef ore " t able. " For User-def ined NULL
D es criptor, example, CRE A TE
Table Space, & volat ile Table.
C reate Post
String )

Table S pace
S t ring appended af t er
(see Table t he CRE A TE TA B LE
Prefix , Table S t at ement but bef ore
Qualifier, Table any P rimary User-def ined NULL
Option, Table I ndex/ P art it ion key
D es criptor, Table def init ions. (S ee Not e
Space, & C reate below. )
Pos t String )

To populate dy namic information by the Analy tic al Engine, ins ert the
following s y ntax into Table Prefix and Table Spac e s trings :

!d i nserts the date.

!o i nserts the report name.

1620 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

!u i nserts the user name.

Alias Pat t er n
Al i as Pattern i s an advanced property that i s hi dden by defaul t. For
i nformati on on how to di spl ay thi s property, see Vi ew i ng and
C hangi ng Advanced VLD B Properti es, page 1330.

The Al i as Pattern property al l ow s you to al ter the pattern for al i asi ng

col umn names. Most databases do not need thi s pattern, because
thei r col umn al i ases fol l ow the col umn name w i th onl y a space
betw een them. H ow ever, Mi crosoft Access needs an AS betw een the
col umn name and the gi ven col umn al i as. Thi s pattern i s
automati cal l y set for Mi crosoft Access users. Thi s property i s provi ded
for customers usi ng the Generi c D BMS obj ect because some
databases may need the AS or another pattern for col umn al i asi ng.

Levels at Which You Can Set This

D atabase i nstance onl y

At t r ib u t e ID Co n st r ain t
Thi s property i s avai l abl e at the attri bute l evel . You can access thi s
property by openi ng the Attri bute Edi tor, sel ecti ng the Tools menu,
then choosi ng VLD B Properties.

When creati ng i ntermedi ate tabl es i n the expl i ci t mode, you can
speci fy the N OT N U LL/N U LL constrai nt duri ng the tabl e creati on
phase. Thi s takes effect onl y w hen permanent or temporary tabl es are
created i n the expl i ci t tabl e creati on mode. Furthermore, i t appl i es
onl y to the attri bute col umns i n the i ntermedi ate tabl es.

Levels at Which You Can Set This

D atabase i nstance and attri bute

© 2019, M icr o St r at egy In c. 1621

Syst em Ad m in ist r at io n Gu id e

Example

NOT NULL

create table ZZTIS003HHUMQ000 (

DEPARTMENT_NBR NUMBER(10, 0) NOT NULL,
STORE_NBR NUMBER(10, 0) NOT NULL)

Ch ar act er Co lu mn Op t io n an d Nat io n al Ch ar act er Co lu mn

Op t io n
The C haracter C ol umn Opti on and N ati onal C haracter C ol umn Opti on
VLD B properti es al l ow you to support the character sets used i n
Teradata. Teradata al l ow s character sets to be defi ned on a col umn-
by-col umn basi s. For exampl e, one col umn i n Teradata may use a
U ni code character set, w hi l e another col umn uses a Lati n character
set.

Mi croStrategy uses tw o sets of data types to support mul ti pl e

character sets. The C har and VarC har data types are used to support
a character set. The N C har and N VarC har data types are used to
support a di fferent character set than the one supported by C har and
VarC har. The N C har and N VarC har data types are commonl y used to
support the U ni code character set w hi l e C har and VarC har data types
are used to support another character set.

You can support the character sets i n your Teradata database usi ng
these VLD B properti es:

l The C haracter C ol umn Opti on VLD B property defi nes the character
set used for col umns that use the Mi croStrategy C har or VarC har
data types. If l eft empty, these data types use the defaul t character
set for the Teradata database user.

You can defi ne a speci fi c data type by typi ng C H A R A C T E R S E T

CH AR AC TE R _ S E T _N A ME, w here C H A R A C T E R _S E T _N A M E i s the

1622 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

name of the character set. For exampl e, C H A R A C T E R S E T L A T I N

defi nes Mi croStrategy's C har and VarC har data types to support the
Lati n character set.

Thi s character set defi ni ti on i s i ncl uded i n SQL statements as

show n i n the exampl e bel ow :

CR EA TE TA B L E t e x t _f i e l d s ( T e x t _F i e l d 1 V A R C H A R( 1 0)
CH AR AC TE R S E T L A TI N , T e x t _F i e l d 2 V A R C H A R( 1 0 )
CH AR AC TE R S E T L A TI N , )

l The N ati onal C haracter C ol umn Opti on VLD B property defi nes the
character set used for col umns that use the Mi croStrategy N C har or
N VarC har data types. If l eft empty, these data types use the defaul t
character set for the Teradata database user.

You can defi ne a speci fi c data type by typi ng C H A R A C T E R S E T

CH AR AC TE R _ S E T _N A ME, w here C H A R A C T E R _S E T _N A M E i s the
name of the character set. For exampl e, C H A R A C T E R S E T
UN IC OD E defi nes Mi croStrategy's N C har and N VarC har data types
to support the U ni code character set.

If you use the U ni code character set and i t i s not the defaul t
character set for the Teradata database user, you shoul d defi ne
N C har and N VarC har data types to use the U ni code character set.

Thi s character set defi ni ti on i s i ncl uded i n SQL statements as

show n i n the exampl e bel ow :

CR EA TE TA B L E t e x t _f i e l d s ( T e x t _F i e l d 1 V A R C H A R( 1 0)
CH AR AC TE R S E T U N IC O D E , T e x t _F i e l d 2 V A R C H A R( 1 0 )
CH AR AC TE R S E T U N IC O D E , )

For exampl e, your Teradata database uses the Lati n and U ni code
character sets, and the defaul t character set for your Teradata

© 2019, M icr o St r at egy In c. 1623

Syst em Ad m in ist r at io n Gu id e

database i s Lati n. In thi s scenari o you shoul d l eave C haracter

C ol umn Opti on empty so that i t uses the defaul t of Lati n. You shoul d
al so defi ne N ati onal C haracter C ol umn as C H A R A C T E R S E T
UNIC OD E so that N C har and N VarC har data types support the
U ni code data for your Teradata database.

To extend thi s exampl e, assume that your Teradata database uses the
Lati n and U ni code character sets, but the defaul t character set for
your Teradata database i s U ni code. In thi s scenari o you shoul d l eave
N ati onal C haracter C ol umn Opti on empty so that i t uses the defaul t of
U ni code. You shoul d al so defi ne C haracter C ol umn as C H A R A C T E R
SET L AT IN so that C har and VarC har data types support the Lati n
data for your Teradata database.

The C haracter C ol umn Opti on and N ati onal C haracter C ol umn Opti on
VLD B properti es can al so support the scenari o w here tw o character
sets are used, and U ni code i s not one of these character sets. For thi s
scenari o, you can use these tw o VLD B properti es to defi ne w hi ch
Mi croStrategy data types support the character sets of your Teradata
database.

Levels at Which You Can Set This

D atabase i nstance onl y

Co lu mn Pat t er n
C ol umn Pattern i s an advanced property that i s hi dden by defaul t. For
i nformati on on how to di spl ay thi s property, see Vi ew i ng and
C hangi ng Advanced VLD B Properti es, page 1330.

The C ol umn Pattern property al l ow s you to al ter the pattern for

col umn names. Most databases do not need thi s pattern al tered.
H ow ever, i f you are usi ng a case-sensi ti ve database and need to add
doubl e quotes around the col umn name, thi s property al l ow s you to
do that.

1624 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Levels at Which You Can Set This

D atabase i nstance onl y

Example

The standard col umn pattern i s # 0 . # 1. If doubl e quotes are needed,

the pattern changes to:

"#0.#1"

Co mmit Af t er Fin al Dr o p
The C ommi t After Fi nal D rop property determi nes w hether or not to
i ssue a C OMMIT statement after the fi nal D R OP statement.

Levels at Which You Can Set This

D atabase i nstance and report

Co mmit Level
The C ommi t Level property i s used to i ssue C OMMIT statements after
the D ata D efi ni ti on Language (D D L) and D ata Mani pul ati on Language
(D ML) statements. When thi s property i s used i n conj uncti on w i th the
IN SER T MID Statement, IN SER T PR E Statement, or TABLE POST
Statement VLD B properti es, the C OMMIT i s i ssued before any of the
custom SQL passes speci fi ed i n the statements are executed. The
onl y D D L statement i ssued after the C OMMIT i s i ssued i s the expl i ci t
C R EATE TABLE statement. C ommi t i s i ssued after D R OP TABLE
statements even though i t i s a D D L statement.

The onl y D ML statement i ssued after the C OMMIT i s i ssued i s the

IN SER T IN TO TABLE statement. If the property i s set to Post D ML,
the C OMMIT i s not i ssued after an i ndi vi dual IN SER T IN TO VALU ES

© 2019, M icr o St r at egy In c. 1625

Syst em Ad m in ist r at io n Gu id e

statement; i nstead, i t i s i ssued after al l the IN SER T IN TO VALU ES

statements are executed.

The Post D D L C OMMIT onl y show s up i f the Intermedi ate Tabl e Type
VLD B property i s set to Permanent tabl es or Temporary tabl es and
the Tabl e C reati on Type VLD B property i s set to Expl i ci t mode.

The Post D ML C OMMIT onl y show s up i f the Intermedi ate Tabl e Type
VLD B property i s set to Permanent tabl es, Temporary tabl es, or
Vi ew s.

Not all databas e platforms s upport COMMIT s tatements and s ome need
s pec ial s tatements to be ex ec uted firs t, s o this property mus t be us ed in
projec ts whos e warehous e tables are in databas es that s upport it.

Levels at Which You Can Set This

D atabase i nstance, report, and templ ate

Examples

Table Creation Type is set to Explicit

N o C ommi t (defaul t)

create table ZZTIS00H8L8MQ000 (

DEPARTMENT_NBR NUMBER(10, 0),
STORE_NBR NUMBER(10, 0)) tablespace users
insert into ZZTIS00H8L8MQ000
select a11.DEPARTMENT_NBR DEPARTMENT_NBR,
a11.STORE_NBR STORE_NBR
from HARI_STORE_DEPARTMENT a11
group by a11.DEPARTMENT_NBR,
a11.STORE_NBR
having sum(a11.TOT_SLS_DLR) > 100000
select a11.DEPARTMENT_NBR DEPARTMENT_NBR,
max(a12.DEPARTMENT_DESC) DEPARTMENT_DESC,
a11.STORE_NBR STORE_NBR,
max(a13.STORE_DESC) STORE_DESC,
sum(a11.TOT_SLS_DLR) TOTALSALES
from HARI_STORE_DEPARTMENT a11,

1626 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

ZZTIS00H8L8MQ000 pa1,
HARI_LOOKUP_DEPARTMENT a12,
HARI_LOOKUP_STORE a13
where a11.DEPARTMENT_NBR = pa1.DEPARTMENT_NBR and
a11.STORE_NBR = pa1.STORE_NBR and
a11.DEPARTMENT_NBR = a12.DEPARTMENT_NBR and
a11.STORE_NBR = a13.STORE_NBR
group by a11.DEPARTMENT_NBR,
a11.STORE_NBR

Post DDL Commit

create table ZZTIS00H8LHMQ000 (

DEPARTMENT_NBR NUMBER(10, 0),
STORE_NBR NUMBER(10, 0)) tablespace users
commit
insert into ZZTIS00H8LHMQ000
select a11.DEPARTMENT_NBR DEPARTMENT_NBR,
a11.STORE_NBR STORE_NBR
from HARI_STORE_DEPARTMENT a11
group by a11.DEPARTMENT_NBR,
a11.STORE_NBR
having sum(a11.TOT_SLS_DLR) > 100000
select a11.DEPARTMENT_NBR DEPARTMENT_NBR,
max(a12.DEPARTMENT_DESC) DEPARTMENT_DESC,
a11.STORE_NBR STORE_NBR,
max(a13.STORE_DESC) STORE_DESC,
sum(a11.TOT_SLS_DLR) TOTALSALES
from HARI_STORE_DEPARTMENT a11,
ZZTIS00H8LHMQ000 pa1,
HARI_LOOKUP_DEPARTMENT a12,
HARI_LOOKUP_STORE a13
where a11.DEPARTMENT_NBR = pa1.DEPARTMENT_NBR and
a11.STORE_NBR = pa1.STORE_NBR and
a11.DEPARTMENT_NBR = a12.DEPARTMENT_NBR and
a11.STORE_NBR = a13.STORE_NBR
group by a11.DEPARTMENT_NBR,
a11.STORE_NBR

Post DDL & Post DML Commit

create table ZZTIS00H8LZMQ000 (

DEPARTMENT_NBR NUMBER(10, 0),
STORE_NBR NUMBER(10, 0)) tablespace users
commit
insert into ZZTIS00H8LZMQ000

© 2019, M icr o St r at egy In c. 1627

Syst em Ad m in ist r at io n Gu id e

select a11.DEPARTMENT_NBR DEPARTMENT_NBR,

a11.STORE_NBR STORE_NBR
from HARI_STORE_DEPARTMENT a11
group by a11.DEPARTMENT_NBR,
a11.STORE_NBR
having sum(a11.TOT_SLS_DLR) > 100000
commit
select a11.DEPARTMENT_NBR DEPARTMENT_NBR,
max(a12.DEPARTMENT_DESC) DEPARTMENT_DESC,
a11.STORE_NBR STORE_NBR,
max(a13.STORE_DESC) STORE_DESC,
sum(a11.TOT_SLS_DLR) TOTALSALES
from HARI_STORE_DEPARTMENT a11,
ZZTIS00H8LZMQ000 pa1,
HARI_LOOKUP_DEPARTMENT a12,
HARI_LOOKUP_STORE a13
where a11.DEPARTMENT_NBR = pa1.DEPARTMENT_NBR and
a11.STORE_NBR = pa1.STORE_NBR and
a11.DEPARTMENT_NBR = a12.DEPARTMENT_NBR and
a11.STORE_NBR = a13.STORE_NBR
group by a11.DEPARTMENT_NBR,
a11.STORE_NBR

Table Creation Type is set to Implicit

N o C ommi t (defaul t)

create table ZZTIS00H8LCMQ000 tablespace users as

select a11.DEPARTMENT_NBR DEPARTMENT_NBR,
a11.STORE_NBR STORE_NBR
from HARI_STORE_DEPARTMENT a11
group by a11.DEPARTMENT_NBR,
a11.STORE_NBR
having sum(a11.TOT_SLS_DLR) > 100000
select a11.DEPARTMENT_NBR DEPARTMENT_NBR,
max(a12.DEPARTMENT_DESC) DEPARTMENT_DESC,
a11.STORE_NBR STORE_NBR,
max(a13.STORE_DESC) STORE_DESC,
sum(a11.TOT_SLS_DLR) TOTALSALES
from HARI_STORE_DEPARTMENT a11,
ZZTIS00H8LCMQ000 pa1,
HARI_LOOKUP_DEPARTMENT a12,
HARI_LOOKUP_STORE a13
where a11.DEPARTMENT_NBR = pa1.DEPARTMENT_NBR and
a11.STORE_NBR = pa1.STORE_NBR and
a11.DEPARTMENT_NBR = a12.DEPARTMENT_NBR and

1628 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

a11.STORE_NBR = a13.STORE_NBR
group by a11.DEPARTMENT_NBR,
a11.STORE_NBR

Post DDL Commit

create table ZZTIS00H8LLMQ000 tablespace users as

select a11.DEPARTMENT_NBR DEPARTMENT_NBR,
a11.STORE_NBR STORE_NBR
from HARI_STORE_DEPARTMENT a11
group by a11.DEPARTMENT_NBR,
a11.STORE_NBR
having sum(a11.TOT_SLS_DLR) > 100000
select a11.DEPARTMENT_NBR DEPARTMENT_NBR,
max(a12.DEPARTMENT_DESC) DEPARTMENT_DESC,
a11.STORE_NBR STORE_NBR,
max(a13.STORE_DESC) STORE_DESC,
sum(a11.TOT_SLS_DLR) TOTALSALES
from HARI_STORE_DEPARTMENT a11,
ZZTIS00H8LLMQ000 pa1,
HARI_LOOKUP_DEPARTMENT a12,
HARI_LOOKUP_STORE a13
where a11.DEPARTMENT_NBR = pa1.DEPARTMENT_NBR and
a11.STORE_NBR = pa1.STORE_NBR and
a11.DEPARTMENT_NBR = a12.DEPARTMENT_NBR and
a11.STORE_NBR = a13.STORE_NBR
group by a11.DEPARTMENT_NBR,
a11.STORE_NBR

Post DML Commit

create table ZZTIS00H8LTMQ000 tablespace users as

select a11.DEPARTMENT_NBR DEPARTMENT_NBR,
a11.STORE_NBR STORE_NBR
from HARI_STORE_DEPARTMENT a11
group by a11.DEPARTMENT_NBR,
a11.STORE_NBR
having sum(a11.TOT_SLS_DLR) > 100000
commit
select a11.DEPARTMENT_NBR DEPARTMENT_NBR,
max(a12.DEPARTMENT_DESC) DEPARTMENT_DESC,
a11.STORE_NBR STORE_NBR,
max(a13.STORE_DESC) STORE_DESC,
sum(a11.TOT_SLS_DLR) TOTALSALES
from HARI_STORE_DEPARTMENT a11,
ZZTIS00H8LTMQ000 pa1,

© 2019, M icr o St r at egy In c. 1629

Syst em Ad m in ist r at io n Gu id e

HARI_LOOKUP_DEPARTMENT a12,
HARI_LOOKUP_STORE a13
where a11.DEPARTMENT_NBR = pa1.DEPARTMENT_NBR and
a11.STORE_NBR = pa1.STORE_NBR and
a11.DEPARTMENT_NBR = a12.DEPARTMENT_NBR and
a11.STORE_NBR = a13.STORE_NBR
group by a11.DEPARTMENT_NBR,
a11.STORE_NBR

Post DDL & Post DML Commit

create table ZZTIS00H8M3MQ000 tablespace users as

select a11.DEPARTMENT_NBR DEPARTMENT_NBR,
a11.STORE_NBR STORE_NBR
from HARI_STORE_DEPARTMENT a11
group by a11.DEPARTMENT_NBR,
a11.STORE_NBR
having sum(a11.TOT_SLS_DLR) > 100000
commit
select a11.DEPARTMENT_NBR DEPARTMENT_NBR,
max(a12.DEPARTMENT_DESC) DEPARTMENT_DESC,
a11.STORE_NBR STORE_NBR,
max(a13.STORE_DESC) STORE_DESC,
sum(a11.TOT_SLS_DLR) TOTALSALES
from HARI_STORE_DEPARTMENT a11,
ZZTIS00H8M3MQ000 pa1,
HARI_LOOKUP_DEPARTMENT a12,
HARI_LOOKUP_STORE a13
where a11.DEPARTMENT_NBR = pa1.DEPARTMENT_NBR and
a11.STORE_NBR = pa1.STORE_NBR and
a11.DEPARTMENT_NBR = a12.DEPARTMENT_NBR and
a11.STORE_NBR = a13.STORE_NBR
group by a11.DEPARTMENT_NBR,
a11.STORE_NBR

CREATE an d INSERT Su p p o r t
The C R EATE and IN SER T support VLD B property defi nes w hether
Mi croStrategy can perform C R E A T E and I N S E R T statements agai nst
the database for a database i nstance. Thi s VLD B property has the
fol l ow i ng opti ons:

1630 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l C R EA TE and IN SER T statements are supported (defaul t): Al l ow s

Mi croStrategy to perform C R E A T E and I N S E R T statements agai nst
the database for a database i nstance. These statements are
requi red for vari ous Mi croStrategy features. Thi s setti ng i s requi red
for the pri mary database i nstance and for databases that are
requi red to support data mart reports. For i nformati on on pri mary
database i nstances, see the Instal l ati on and C onfi gurati on Gui de.

Thi s setti ng i s recommended for databases that are used to support

ful l y functi oni ng Mi croStrategy proj ects.

l C R EA TE and IN SER T statements are not supported:

Mi croStrategy i s prohi bi ted from performi ng C R E A T E and I N S E R T
statements agai nst the database for a database i nstance. Thi s
opti on can be used i f the database that you connect to i s meant to
onl y act as a reposi tory of i nformati on that cannot be modi fi ed from
w i thi n Mi croStrategy.

Thi s opti on can al so be used al ong w i th the Mul ti Source Opti on

feature, w hi ch al l ow s you to access mul ti pl e databases i n one
Mi croStrategy proj ect. You can defi ne your secondary database
i nstances to di sal l ow C R E A T E and I N S E R T statements so that al l
i nformati on i s onl y i nserted i nto the pri mary database i nstance. For
i nformati on on the Mul ti Source Opti on feature, see the Proj ect
D esi gn Gui de.

You can al so use thi s opti on to avoi d the creati on of temporary

tabl es on databases for vari ous performance or securi ty purposes.

This option does not c ontrol the SQL that c an be c reated and ex ec uted
agains t a databas e us ing Freeform SQL and Query Builder reports .

Levels at Which You Can Set This

D atabase i nstance onl y

© 2019, M icr o St r at egy In c. 1631

Syst em Ad m in ist r at io n Gu id e

Dr o p Temp Tab le Met h o d

The D rop Temp Tabl e Method property speci fi es w hether the
i ntermedi ate tabl es, permanent tabl es, temporary tabl es, and vi ew s
are to be dropped at the end of report executi on. D roppi ng the tabl es
can l ock catal og tabl es and affect performance, so droppi ng the
tabl es manual l y i n a batch process w hen the database i s l ess acti ve
can resul t i n a performance gai n. The trade-off i s space on the
database server. If tabl es are not dropped, the tabl es remai n on the
database server usi ng space unti l the database admi ni strator drops
them.

Thi s VLD B property al so al l ow s you to truncate i ntermedi ate tabl es,

permanent tabl es, temporary tabl es, and vi ew s pri or to droppi ng them.

Levels at Which You Can Set This

D atabase i nstance, report, and templ ate

Fallb ack Tab le Typ e

Al l reports can be resol ved usi ng permanent or temporary
i ntermedi ate tabl es. Generati ng deri ved tabl es, common tabl e
expressi ons, and vi ew s as a means of resol vi ng reports i s al so
provi ded. D eri ved tabl es, common tabl e expressi ons, and vi ew s
cannot cover al l the scenari os. For exampl e, they cannot be used
w hen the report contai ns Anal yti cal Engi ne SQL, parti ti oni ng, and
certai n cases of outer j oi ns. In such a scenari o, the Mi croStrategy
SQL Engi ne needs a fal l back mechani sm provi ded by the Fal l back
Tabl e Type property. If the Intermedi ate Tabl e Type VLD B property
(descri bed bel ow ) i s set to D eri ved Tabl e or C ommon Tabl e
Expressi on or Vi ew s, and the SQL Engi ne concl udes that the report
cannot be resol ved usi ng that setti ng, i t reads the Fal l back Tabl e
Type VLD B property and resol ves the report by generati ng

1632 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Permanent tables or Temporary tables accordi ng to the opti on that

you set.

H ow ever, there may be scenari os w here you do not w ant to create

permanent tabl es or temporary tabl es to support these types of
reports. To prevent the creati on of permanent or temporary tabl es, you
can set the Fal l back Tabl e Type VLD B property to Fail report. Thi s
causes reports that rel y on the Fal l back Tabl e Type to fai l , so i t
shoul d onl y be used w hen i t i s necessary to prevent the creati on of
permanent or temporary tabl es.

Levels at Which You Can Set This

D atabase i nstance, report, and templ ate

Hexad ecimal Ch ar act er Tr an sf o r mat io n

The H exadeci mal C haracter Transformati on property i s onl y rel evant
w hen you are usi ng a U ni code Teradata database for the data
w arehouse. Most databases do not need thi s property, because the
OD BC dri ver handl es the conversi on automati cal l y. In some U ni code
databases, to process SQL contai ni ng character stri ngs i nsi de
quotati ons, those characters must be converted to hexadeci mal
representati on. Turni ng thi s property on means characters w i thi n
quoted stri ngs are converted i nto hexadeci mal usi ng U TF-8 encodi ng.

Levels at Which You Can Set This

D atabase i nstance onl y

Examples

D o not apply hexadecimal character transformation to quoted

strings (defaul t)

insert into mytable values ('A')

© 2019, M icr o St r at egy In c. 1633

Syst em Ad m in ist r at io n Gu id e

Apply hexadecimal character transformation to quoted strings

insert into mytable values ('4100'XCV)

Where 4100 i s the hexadeci mal representati on of the character "A"

usi ng U TF-8 U ni code encodi ng.

In t er med iat e Tab le Typ e

The Intermedi ate Tabl e Type property speci fi es w hat ki nds of
i ntermedi ate tabl es are used to execute the report. Al l reports can be
executed usi ng permanent and temporary tabl es. There are certai n
scenari os i nvol vi ng parti ti oni ng, outer j oi ns, and anal yti cal functi ons
that the report cannot execute usi ng deri ved tabl es, common tabl e
expressi ons, or vi ew s. If thi s i s the case, the Fal l back Tabl e Type
VLD B property (descri bed above) i s used to execute the report. The
temporary tabl e syntax i s speci fi c to each pl atform.

Thi s property can have a maj or i mpact on the performance of the

report. Permanent tabl es are usual l y l ess opti mal . D eri ved tabl es,
common tabl e expressi ons, and true temporary tabl es usual l y perform
w el l , but they do not w ork i n al l cases and for al l databases. The
defaul t setti ng i s permanent tabl es, because i t w orks for al l databases
i n al l si tuati ons. H ow ever, based on your database type, thi s setti ng
i s automati cal l y changed to w hat i s general l y the most opti mal opti on
for that pl atform, al though other opti ons coul d prove to be more
opti mal on a report-by-report basi s. You can access the VLD B
Properti es Edi tor for the database i nstance for your database (see
Openi ng the VLD B Properti es Edi tor, page 1325), and then sel ect the
U se default inherited value check box to determi ne the defaul t
opti on for your database.

To hel p support the use of common tabl e expressi ons and deri ved
tabl es, you can al so use the Maxi mum SQL Passes Before Fal l Back
and Maxi mum Tabl es i n FR OM C l ause Before Fal l Back VLD B
properti es. These properti es (descri bed i n Maxi mum SQL Passes

1634 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Before Fal l Back, page 1638 and Maxi mum Tabl es i n FR OM C l ause
Before Fal l Back, page 1639) al l ow you to defi ne w hen a report i s too
compl ex to use common tabl e expressi ons and deri ved tabl e
expressi ons and i nstead use a fal l back tabl e type.

In cases w here queri es are performed i n paral l el (through the use of

Opti mi zi ng Queri es, page 1503) the i ntermedi ate tabl e type i s
determi ned by the VLD B property Paral l el SQL Executi on
Intermedi ate Tabl e Type, page 1641.

Levels at Which You Can Set This

D atabase i nstance, report, and templ ate

Examples

The fol l ow i ng i s an output from a D B2 U D B 7.x proj ect.

Permanent Table (defaul t)

create table ZZIS03CT00 (

DEPARTMENT_NBR DECIMAL(10, 0),
STORE_NBR DECIMAL(10, 0))
insert into ZZIS03CT00
select a11.DEPARTMENT_NBR DEPARTMENT_NBR,
a11.STORE_NBR STORE_NBR
from HSTORE_DEPARTMENT a11
group by a11.DEPARTMENT_NBR,
a11.STORE_NBR
having sum(a11.TOT_SLS_DLR) > 100000
select a11.DEPARTMENT_NBR DEPARTMENT_NBR,
max(a12.DEPARTMENT_DESC) DEPARTMENT_DESC,
a11.STORE_NBR STORE_NBR,
max(a13.STORE_DESC) STORE_DESC,
sum(a11.TOT_SLS_DLR) TOTALSALES
from HSTORE_DEPARTMENT a11
join ZZIS03CT00 pa1
on (a11.DEPARTMENT_NBR = pa1.DEPARTMENT_NBR and
a11.STORE_NBR = pa1.STORE_NBR)
join HLOOKUP_DEPARTMENT a12
on (a11.DEPARTMENT_NBR = a12.DEPARTMENT_NBR)

© 2019, M icr o St r at egy In c. 1635

Syst em Ad m in ist r at io n Gu id e

join HLOOKUP_STORE a13

on (a11.STORE_NBR = a13.STORE_NBR)
group by a11.DEPARTMENT_NBR,
a11.STORE_NBR

Derived Table

select a11.DEPARTMENT_NBR DEPARTMENT_NBR,

max(a12.DEPARTMENT_DESC) DEPARTMENT_DESC,
a11.STORE_NBR STORE_NBR,
max(a13.STORE_DESC) STORE_DESC,
sum(a11.TOT_SLS_DLR) TOTALSALES
from HSTORE_DEPARTMENT a11
join (select a11.DEPARTMENT_NBR DEPARTMENT_NBR,
a11.STORE_NBR STORE_NBR
from HSTORE_DEPARTMENT a11
group by a11.DEPARTMENT_NBR,
a11.STORE_NBR
having sum(a11.TOT_SLS_DLR) > 100000
) pa1
on (a11.DEPARTMENT_NBR = pa1.DEPARTMENT_NBR and
a11.STORE_NBR = pa1.STORE_NBR)
join HLOOKUP_DEPARTMENT a12
on (a11.DEPARTMENT_NBR = a12.DEPARTMENT_NBR)
join HLOOKUP_STORE a13
on (a11.STORE_NBR = a13.STORE_NBR)
group by a11.DEPARTMENT_NBR,
a11.STORE_NBR

Common Table Expression

with pa1 as
(select a11.DEPARTMENT_NBR DEPARTMENT_NBR,
a11.STORE_NBR STORE_NBR
from HSTORE_DEPARTMENT a11
group by a11.DEPARTMENT_NBR,
a11.STORE_NBR
having sum(a11.TOT_SLS_DLR) > 100000
)
select a11.DEPARTMENT_NBR DEPARTMENT_NBR,
max(a12.DEPARTMENT_DESC) DEPARTMENT_DESC,
a11.STORE_NBR STORE_NBR,
max(a13.STORE_DESC) STORE_DESC,
sum(a11.TOT_SLS_DLR) TOTALSALES
from HSTORE_DEPARTMENT a11
join pa1

1636 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

on (a11.DEPARTMENT_NBR = pa1.DEPARTMENT_NBR and

a11.STORE_NBR = pa1.STORE_NBR)
join HLOOKUP_DEPARTMENT a12
on (a11.DEPARTMENT_NBR = a12.DEPARTMENT_NBR)
join HLOOKUP_STORE a13
on (a11.STORE_NBR = a13.STORE_NBR)
group by a11.DEPARTMENT_NBR,
a11.STORE_NBR

Temporary Table

declare global temporary table session.ZZIS03CU00(

DEPARTMENT_NBR DECIMAL(10, 0),
STORE_NBR DDECIMAL(10, 0))
on commit preserve rows not logged
insert into session.ZZIS03CU00
select a11.DEPARTMENT_NBR DEPARTMENT_NBR,
a11.STORE_NBR STORE_NBR
from HSTORE_DEPARTMENT a11
group by a11.DEPARTMENT_NBR,
a11.STORE_NBR
having sum(a11.TOT_SLS_DLR) > 100000
select a11.DEPARTMENT_NBR DEPARTMENT_NBR,
max(a12.DEPARTMENT_DESC) DEPARTMENT_DESC,
a11.STORE_NBR STORE_NBR,
max(a13.STORE_DESC) STORE_DESC,
sum(a11.TOT_SLS_DLR) TOTALSALES
from HSTORE_DEPARTMENT a11
join session.ZZIS03CU00 pa1
on (a11.DEPARTMENT_NBR = pa1.DEPARTMENT_NBR and
a11.STORE_NBR = pa1.STORE_NBR)
join HLOOKUP_DEPARTMENT a12
on (a11.DEPARTMENT_NBR = a12.DEPARTMENT_NBR)
join HLOOKUP_STORE a13
on (a11.STORE_NBR = a13.STORE_NBR)
group by a11.DEPARTMENT_NBR,
a11.STORE_NBR

Views

create view ZZIS03CV00 (DEPARTMENT_NBR, STORE_NBR) as

select a11.DEPARTMENT_NBR DEPARTMENT_NBR,
a11.STORE_NBR STORE_NBR
from HSTORE_DEPARTMENT a11
group by a11.DEPARTMENT_NBR,
a11.STORE_NBR

© 2019, M icr o St r at egy In c. 1637

Syst em Ad m in ist r at io n Gu id e

having sum(a11.TOT_SLS_DLR) > 100000

select a11.DEPARTMENT_NBR DEPARTMENT_NBR,
max(a12.DEPARTMENT_DESC) DEPARTMENT_DESC,
a11.STORE_NBR STORE_NBR,
max(a13.STORE_DESC) STORE_DESC,
sum(a11.TOT_SLS_DLR) TOTALSALES
from HSTORE_DEPARTMENT a11
join ZZIS03CV00 pa1
on (a11.DEPARTMENT_NBR = pa1.DEPARTMENT_NBR and
a11.STORE_NBR = pa1.STORE_NBR)
join HLOOKUP_DEPARTMENT a12
on (a11.DEPARTMENT_NBR = a12.DEPARTMENT_NBR)
join HLOOKUP_STORE a13
on (a11.STORE_NBR = a13.STORE_NBR)
group by a11.DEPARTMENT_NBR, a11.STORE_NBR

Maximu m SQL Passes Bef o r e FallBack

The Maxi mum SQL Passes Before Fal l Back VLD B property al l ow s
you to defi ne reports to use common tabl e expressi ons or deri ved
tabl es w hi l e al so usi ng temporary or permanent tabl es for compl ex
reports.

U si ng common tabl e expressi ons or deri ved tabl es can often provi de
good performance for reports. H ow ever, some producti on
envi ronments have show n better performance w hen usi ng temporary
tabl es for reports that requi re mul ti -pass SQL.

To support the use of the best tabl e type for each type of report, you
can use the Maxi mum SQL Passes Before Fal l Back VLD B property to
defi ne how many passes are al l ow ed for a report that uses
i ntermedi ate tabl es. If a report uses more passes than are defi ned i n
thi s VLD B property, the tabl e type defi ned i n the Fal l back Tabl e Type
VLD B property (see Fal l back Tabl e Type, page 1632) i s used rather
than the tabl e type defi ned i n the Intermedi ate Tabl e Type VLD B
property (see Intermedi ate Tabl e Type, page 1634).

For exampl e, you defi ne the Intermedi ate Tabl e Type VLD B property
to use deri ved tabl es for the enti re database i nstance. Thi s defaul t i s

1638 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

then used for al l reports w i thi n that database i nstance. You al so

defi ne the Fal l back Tabl e Type VLD B property to use temporary
tabl es as the fal l back tabl e type. For your producti on envi ronment,
you defi ne the Maxi mum SQL Passes Before Fal l Back VLD B property
to use the fal l back tabl e type for al l reports that use more than fi ve
passes.

A report i s executed. The report requi res si x passes of SQL to return

the requi red report resul ts. U sual l y thi s type of report w oul d use
deri ved tabl es, as defi ned by the Intermedi ate Tabl e Type VLD B
property. H ow ever, si nce i t uses more passes than the l i mi t defi ned i n
the Maxi mum SQL Passes Before Fal l Back VLD B property, i t must
use the fal l back tabl e type. Si nce the Fal l back Tabl e Type VLD B
property i s defi ned as temporary tabl es, the report uses temporary
tabl es to perform the mul ti -pass SQL and return the report resul ts.

Levels at Which You Can Set This

D atabase i nstance, report, and templ ate

Maximu m Tab les in FROM Clau se Bef o r e FallBack

The Maxi mum Tabl es i n FR OM C l ause Before Fal l Back VLD B
property al l ow s you to defi ne more reports to use common tabl e
expressi ons or deri ved tabl es w hi l e al so usi ng temporary or
permanent tabl es for compl ex reports.

U si ng common tabl e expressi ons or deri ved tabl es can often provi de
good performance for reports. H ow ever, some producti on
envi ronments have show n better performance w hen usi ng temporary
tabl es for reports that requi re j oi ni ng a l arge amount of database
tabl es.

To support the use of the best tabl e type for each type of report, you
can use the Maxi mum Tabl es i n FR OM C l ause Before Fal l Back VLD B
property (see Fal l back Tabl e Type, page 1632) to defi ne how many

© 2019, M icr o St r at egy In c. 1639

Syst em Ad m in ist r at io n Gu id e

tabl es are al l ow ed i n a Fr o m cl ause for a report that uses

i ntermedi ate tabl es. If a report uses more tabl es i n a F r o m cl ause
than are defi ned i n thi s VLD B property, the tabl e type defi ned i n the
Fal l back Tabl e Type VLD B property i s used rather than the tabl e type
defi ned i n the Intermedi ate Tabl e Type VLD B property (see
Intermedi ate Tabl e Type, page 1634).

For exampl e, you defi ne the Intermedi ate Tabl e Type VLD B property
to use deri ved tabl es for the enti re database i nstance. Thi s defaul t i s
then used for al l reports w i thi n that database i nstance. You al so
defi ne the Fal l back Tabl e Type VLD B property to use temporary
tabl es as the fal l back tabl e type. For your producti on envi ronment,
you defi ne the Maxi mum Tabl es i n FR OM C l ause Before Fal l Back
VLD B property to use the fal l back tabl e type for al l reports that use
more than seven tabl es i n a F r o m cl ause.

A report i s executed. The report requi res a SQL statement that

i ncl udes ni ne tabl es i n the F r o m cl ause. U sual l y thi s type of report
w oul d use deri ved tabl es, as defi ned by the Intermedi ate Tabl e Type
VLD B property. H ow ever, si nce i t uses more tabl es i n the F r o m
cl ause than the l i mi t defi ned i n the Maxi mum Tabl es i n FR OM C l ause
Before Fal l Back VLD B property, i t must use the fal l back tabl e type.
Si nce the Fal l back Tabl e Type VLD B property i s defi ned as temporary
tabl es, the report uses temporary tabl es to perform the SQL statement
and return the report resul ts.

Levels at Which You Can Set This

D atabase i nstance, report, and templ ate

Nat io n al Ch ar act er Co lu mn Op t io n
For a descri pti on of thi s VLD B property, see C haracter C ol umn Opti on
and N ati onal C haracter C ol umn Opti on, page 1622.

1640 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Levels at Which You Can Set This

D atabase i nstance onl y

Par allel SQL Execu t io n In t er med iat e Tab le Typ e

Paral l el SQL Executi on Intermedi ate Tabl e Type i s an advanced
property that i s hi dden by defaul t. For i nformati on on how to di spl ay
thi s property, see Vi ew i ng and C hangi ng Advanced VLD B Properti es,
page 1330.

The Paral l el SQL Executi on Intermedi ate Tabl e Type property

determi nes the type of i ntermedi ate tabl e that i s used w hen Paral l el
Query Executi on (see Opti mi zi ng Queri es, page 1503) i s empl oyed for
reports and Intel l i gent C ubes. If Paral l el Query Executi on i s not
enabl ed, or the queri es cannot be processed i n paral l el , the
i ntermedi ate tabl e type i s determi ned by the VLD B property
Intermedi ate Tabl e Type, page 1634.

Thi s VLD B property has the fol l ow i ng opti ons:

l Permanent Table: When the queri es for a report or Intel l i gent C ube
are performed i n paral l el , any i ntermedi ate tabl es are created as
permanent tabl es. Thi s provi des broad support as al l databases can
support permanent tabl es.

l D erived Table with Fallback Table Type as Permanent Table:

When the queri es for a report or Intel l i gent C ube are performed i n
paral l el , any i ntermedi ate tabl es are created as deri ved tabl es. Thi s
can i mprove performance for databases that support deri ved tabl es.
H ow ever, not al l databases support deri ved tabl es. R efer to your
thi rd-party database vendor documentati on to determi ne i f your
database supports deri ved tabl es.

If you sel ect thi s opti on and deri ved tabl es cannot be created for
your database, permanent tabl es are created i nstead.

© 2019, M icr o St r at egy In c. 1641

Syst em Ad m in ist r at io n Gu id e

Levels at Which You Can Set This

D atabase i nstance, report, and templ ate

Tab le Cr eat io n Typ e

The Tabl e C reati on Type property tel l s the SQL Engi ne w hether to
create tabl e i mpl i ci tl y or expl i ci tl y. Some databases do not support
i mpl i ci t creati on, so thi s i s a database-speci fi c setti ng.

Levels at Which You Can Set This

D atabase i nstance, report, and templ ate

Examples

Explicit table (defaul t)

create table TEMP1 (

STORE_NBR INTEGER,
TOT_SLS DOUBLE,
PROMO_SLS DOUBLE)
insert into TEMP1
select a21.STORE_NBR STORE_NBR,
(sum(a21.REG_SLS_DLR) + sum(a21.PML_SLS_DLR)) TOT_SLS,
sum(a21.PML_SLS_DLR) PROMO_SLS
from STORE_DIVISION a21
where a21.STORE_NBR = 1
group by a21.STORE_NBR

Implicit table

create table TEMP1 as

select a21.STORE_NBR STORE_NBR,
(sum(a21.REG_SLS_DLR) + sum(a21.PML_SLS_DLR)) TOT_SLS,
sum(a21.PML_SLS_DLR) PROMO_SLS
from STORE_DIVISION a21
where a21.STORE_NBR = 1
group by a21.STORE_NBR

1642 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Tab le Pr ef ix, Tab le Qu alif ier , Tab le Op t io n , Tab le Descr ip t o r ,

Tab le Sp ace, & Cr eat e Po st St r in g
These properti es can be used to customi ze the C R EATE TABLE SQL
syntax for any pl atform. Al l of these properti es are refl ected i n the
SQL statement onl y i f the Intermedi ate Tabl e Type VLD B property i s
set to Permanent Tabl e. C ustomi zi ng a C R EATE TABLE statement i s
onl y possi bl e for a permanent tabl e. For al l other val i d Intermedi ate
Tabl e Type VLD B setti ngs, the SQL does not refl ect the val ues set for
these properti es. The l ocati on of each property i n the C R EATE
TABLE statement i s gi ven bel ow .

create /* Table Qualifier */ table /*Table

Descriptor*//* Table Prefix */ZZTIS003RB6MD000 /*Table
Option*/ (
STORE_NBR NUMBER,
CLEARANCESAL DOUBLE)
/* Table Space */
/* Create PostString */

For pl atforms l i ke Teradata and D B2 U D B 6.x and 7.x versi ons, the
Pri mary Index or the Parti ti on Key SQL syntax i s pl aced betw een the
Tabl e Space and C reate Post Stri ng VLD B property.

Levels at Which You Can Set This

D atabase i nstance, report, and templ ate

Default VLDB Settings for Specific Data Sources

Mi croStrategy certi fi es and supports connecti on and i ntegrati on w i th
many thi rd-party databases, MD X cube sources, and other data
sources.

Thes e inc lude databas es , data s ourc es , and MDX c ube s ourc es from
third-party v endors s uc h as IBM DB2, Orac le, Informix , SAP, Sy bas e,

© 2019, M icr o St r at egy In c. 1643

Syst em Ad m in ist r at io n Gu id e

Mic ros oft, Netez z a, Teradata, and s o on. For c ertific ation information on
thes e data s ourc es , refer to the R eadme .

C ertai n VLD B properti es use di fferent defaul t setti ngs dependi ng on

w hi ch data source you are usi ng. Thi s al l ow s Mi croStrategy to both
properl y support and take advantage of certai n characteri sti cs of each
thi rd-party data source.

You can determi ne the defaul t opti ons for each VLD B property for a
database by performi ng the steps bel ow . Thi s provi des an accurate
l i st of defaul t VLD B properti es for your thi rd-party data source for the
versi on of Mi croStrategy that you are usi ng.

You hav e a us er ac c ount with adminis trativ e priv ileges .

Ens ure that y ou hav e fully upgraded y our Mic roStrategy env ironment and
the av ailable databas e ty pes , as des c ribed in U pgradi ng the VLD B
Opti ons for a Parti cul ar D atabase Type, page 1334 .

To Create a List of Default VLDB Settings for a Data Source

1. In D evel oper, l og i n to a proj ect source usi ng an account w i th

admi ni strati ve pri vi l eges.

2. From the Folder List, expand A dministration, then

C onfiguration Managers, and sel ect D atabase Instances.

3. From the File menu, poi nt to N ew, and sel ect D atabase
Instance.

4. In the D atabase instance name fi el d, type a descri pti ve name

for the database i nstance.

5. From the D atabase connection type drop-dow n l i st, sel ect the
appropri ate opti on for the data source to l i st defaul t VLD B
setti ngs for. For exampl e, you can sel ect Oracl e 11g to determi ne
the defaul t VLD B setti ngs for an Oracl e 11g database.

1644 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To return a l i st of defaul t VLD B properti es for a data source, onl y

an appropri ate database connecti on type needs to be defi ned for
the database i nstance; a connecti on to a data source does not
need to be made. After you create the l i st of defaul t VLD B
setti ngs for the data source, you can del ete the database
i nstance or modi fy i t to connect to your data source.

6. C l i ck OK to exi t the D atabase Instances Edi tor and save the

database i nstance.

7. R i ght-cl i ck the new database i nstance that you created and

sel ect VLD B Properties.

8. From the Tools menu, ensure that Show A dvanced Settings i s

sel ected.

9. From the Tools menu, sel ect C reate VLD B Settings R eport.

A VLDB s ettings report c an be c reated to dis play c urrent VLDB

s ettings for databas e ins tanc es , attributes , metric s , and other
objec ts in y our projec t. For information on c reating a VLDB
s ettings report for other purpos es , s ee C reati ng a VLD B
Setti ngs R eport, page 1327 .

10. Sel ect the Show descriptions of setting values check box. Thi s
di spl ays the descri pti ve i nformati on of each defaul t VLD B
property setti ng i n the VLD B setti ngs report.

11. The VLD B setti ngs report now di spl ays al l the defaul t setti ngs for
the data source. You can copy the content i n the report usi ng the
C trl+C keys on your keyboard, then paste the i nformati on i nto a
text edi tor or w ord processi ng program (such as Mi crosoft Word)
usi ng the C trl+V keys.

12. C l i ck C lose.

© 2019, M icr o St r at egy In c. 1645

Syst em Ad m in ist r at io n Gu id e

13. You can then ei ther del ete the database i nstance that you
created earl i er, or modi fy i t to connect to your data source.

1646 © 2019, M icr o St r at egy In c.

 2
CREATING A
M ULTILINGUAL
ENVIRONM ENT:
I NTERNATIONALIZATION

© 2019, M icr o St r at egy In c. 1647

Syst em Ad m in ist r at io n Gu id e

Thi s secti on show s you how to use Mi croStrategy to i nternati onal i ze a

proj ect i n your Mi croStrategy envi ronment, to make i t avai l abl e to a
mul ti l i ngual audi ence. Thi s i ncl udes i nternati onal i zi ng data i n your
data w arehouse and metadata obj ects i n the Mi croStrategy metadata
reposi tory. Thi s secti on al so show s you how to di spl ay a transl ated
Mi croStrategy i nterface.

Transl ati ng your data and metadata al l ow s your users to vi ew thei r

reports i n a vari ety of l anguages. It al so al l ow s report desi gners and
others to di spl ay report and document edi tors and other obj ects
edi tors i n vari ous l anguages. And because al l transl ati on i nformati on
can be stored i n the same proj ect, proj ect mai ntenance i s easi er and
more effi ci ent for admi ni strators.

The i mage bel ow show s w hi ch parts of a report are transl ated usi ng
data i nternati onal i zati on and w hi ch parts of a report are transl ated
usi ng metadata i nternati onal i zati on:

Thi s secti on assumes you have an understandi ng of standard

Mi croStrategy metadata obj ects, as w el l as how your organi zati on
stores transl ated data i n your data w arehouse system.

Thi s secti on i ncl udes the fol l ow i ng i nformati on:

1648 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l About Internati onal i zati on, page 1650 provi des an i ntroducti on to
i nternati onal i zati on i n Mi croStrategy, w i th exampl es; i t al so
provi des i nformati on on how cachi ng w orks i n an i nternati onal i zed
envi ronment.

l Best Practi ces for Impl ementi ng Internati onal i zati on, page 1653

l Prepari ng a Proj ect to Support Internati onal i zati on, page 1654
provi des steps to take duri ng i nstal l ati on or upgrade to prepare your
proj ects for i nternati onal i zati on.

l Provi di ng Metadata Internati onal i zati on, page 1658 expl ai ns how
the metadata can be i nternati onal i zed.

l Provi di ng D ata Internati onal i zati on, page 1673 provi des steps to
connect to, set up, and store transl ated data w i thi n your data
w arehouse so that i t can be retri eved and di spl ayed i n
Mi croStrategy reports.

l Maki ng Transl ated D ata Avai l abl e to U sers, page 1684 descri bes
the hi erarchy of preferences that a user can have set, and how that
hi erarchy w orks.

l Achi evi ng the C orrect Language D i spl ay, page 1705 provi des a
tabl e of the functi onal i ty that Mi croStrategy users can access to
take advantage of i nternati onal i zati on.

l Mai ntai ni ng Your Internati onal i zed Envi ronment, page 1711
provi des i nformati on on usi ng scri pts w i th C ommand Manager to
automate your i nternati onal i zed envi ronment; movi ng transl ated
obj ects betw een proj ects; addi ng l anguages to be supported by a
proj ect; addi ng a custom l anguage; and appl yi ng securi ty to your
i nternati onal i zed envi ronment, i ncl udi ng creati ng speci al i zed
transl ator user rol es.

© 2019, M icr o St r at egy In c. 1649

Syst em Ad m in ist r at io n Gu id e

About Internationalization
For a ful l y i nternati onal i zed envi ronment, both metadata
i nternati onal i zati on and data i nternati onal i zati on are requi red.
H ow ever, you can i nternati onal i ze onl y your metadata, or onl y your
data, based on your needs. Both are descri bed bel ow .

Thi s secti on al so descri bes transl ati ng the user i nterface and how
i nternati onal i zati on affects report/document cachi ng.

About Metadata Internationalization

Metadata i nternati onal i zati on di spl ays transl ated obj ect stri ngs based
on a user's l ocal e and other l anguage preferences i n Mi croStrategy,
for obj ects that are stored i n the Mi croStrategy metadata, such as
metri c names and report names. For exampl e, you have tw o metri cs
stored i n your metadata reposi tory, named C ost and Profi t. These
metadata obj ects w i l l appear on reports accessed by both Engl i sh
and Ital i an users. You can use metadata i nternati onal i zati on to
confi gure Mi croStrategy to automati cal l y di spl ay C ost and Profi t to the
Engl i sh users and Metri ca costo and Metri c proffi to to the Ital i an
users.

Metadata i nternati onal i zati on (or MD I) i nvol ves exporti ng obj ect
stri ngs to a l ocati on w here they can be transl ated, performi ng the
l i ngui sti c transl ati on, and i mporti ng the new l y transl ated obj ect
stri ngs back i nto the metadata reposi tory. You can al so transl ate
i ndi vi dual obj ects one at a ti me, usi ng the Obj ect Transl ati on Edi tor.

For steps to perform these procedures, see Provi di ng Metadata

Internati onal i zati on, page 1658.

About Data Internationalization

D ata i nternati onal i zati on al l ow s a si ngl e report defi ni ti on to contai n
di fferent attri bute forms for di fferent l anguages avai l abl e to users,

165 0 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

based on a user's l ocal e and other l anguage preferences i n

Mi croStrategy. For exampl e, you w ant to di spl ay a product name
stored i n your data w arehouse to tw o di fferent users, one w ho reads
Engl i sh and one w ho reads French. Both users execute and vi ew the
same product report. You can use data i nternati onal i zati on to
confi gure Mi croStrategy to automati cal l y di spl ay A Tal e of Tw o C i ti es
to the Engl i sh user and U n C onte de D eux Vi l l es to the French user.

D ata i nternati onal i zati on (or D I) i nvol ves confi guri ng your data
w arehouse so that tabl es and other structures al l ow Mi croStrategy to
access data i n the appropri ate l anguage for the user requesti ng the
report. If you use mul ti pl e w arehouses to store transl ated data, D I
i nvol ves connecti ng Mi croStrategy to the appropri ate w arehouses.

Depending on the data internationaliz ation model y ou c hoos e, whic h is

bas ed on the s truc ture of y our trans lation s torage env ironment (as
des c ribed abov e), y ou may only be able to trans late the DESC
(des c ription) form.

See Provi di ng D ata Internati onal i zati on, page 1673 for more
i nformati on.

About Internationalizing the General User Interface

The Mi croStrategy general user i nterface (such as the Fi l e menu, Edi t
menu, and so on) can al so be di spl ayed i n vari ous l anguages. Thi s
transl ati on process i s not part of metadata or data
i nternati onal i zati on, but steps to sel ect a preferred i nterface l anguage
are part of thi s secti on. Mi croStrategy provi des transl ated stri ngs for
the general user i nterface i n several l anguages. You can di spl ay the
Mi croStrategy general user i nterface i n a sel ected l anguage usi ng the
MicroStrategy D eveloper Preferences opti ons i n D evel oper and the
Preferences l i nk i n Mi croStrategy Web:

© 2019, M icr o St r at egy In c. 165 1

Syst em Ad m in ist r at io n Gu id e

l For steps to sel ect the i nterface l anguage i n D evel oper, see
Sel ecti ng the Interface Language Preference, page 1687.

l For steps to sel ect the i nterface l anguage i n Web, cl i ck H elp i n

Mi croStrategy Web.

Caching and Internationalization

For detai l s about cachi ng, see Improvi ng R esponse Ti me: C achi ng

Obj ect cachi ng i s not affected by i nternati onal i zati on.

N ormal report and document cachi ng behavi or i s not affected,

regardl ess of the types of i nternati onal i zati on that you i mpl ement.
Speci fi cal l y, data i nternati onal i zati on methods (SQL-based and
connecti on-based, both descri bed bel ow ) do not affect standard report
and document cachi ng behavi or.

D i fferent caches are created for di fferent D I l anguages, but not for
di fferent MD I l anguages. When a user w hose MD I l anguage and D I
l anguage are French runs a report, a cache i s created contai ni ng
French data and usi ng the report's French name. When a second user
w hose MD I l anguage and D I l anguage are German runs the same
report, a new cache i s created w i th German data and usi ng the
report's German name. If a thi rd user w hose MD I l anguage i s French
and D I l anguage i s German runs the same report, the second user's
cache i s hi t. Tw o users w i th the same D I l anguage preference use the
same cache, regardl ess of MD I preferences.

A report's data i nternati onal i zati on l anguage i s di spl ayed i n a D ata

Language col umn i n the C ache Moni tor. Thi s hel ps the admi ni strator
i denti fy the di fference betw een cached reports, w hen i t i s i mportant to
be abl e to i denti fy these di fferences.

165 2 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Best Practices for Implementing

Internationalization
l Make sure your database supports the character set(s) that are
requi red by the vari ous l anguages you i ntend to support i n your
Mi croStrategy proj ect. Mi croStrategy recommends usi ng a U ni code
database to ensure al l your l anguages are supported. For detai l s,
see Addi ng or R emovi ng a Language i n the System, page 1712.

l If you w i l l be supporti ng doubl e-byte l anguages (such as Japanese

or Korean), make sure that appropri ate fonts are avai l abl e for graph
l abel s, text fi el ds i n documents, and so on. Appropri ate fonts to
support doubl e-byte l anguages are general l y U ni code fonts. An
exampl e of an effecti ve U ni code font for doubl e-byte l anguages i s
Ari al U ni code MS. Most U ni code fonts ensure that al l characters
can be di spl ayed correctl y w hen a report or document i s di spl ayed
i n a doubl e-byte l anguage.

Not all Unic ode fonts c an dis play double-by te languages , for ex ample,
Luc ida Sans Unic ode does not dis play double-by te languages .

l Al l SQL-based qual i fi cati ons contai ned i n a gi ven report shoul d be

i n a si ngl e l anguage. SQL-based qual i fi cati ons i ncl ude such thi ngs
as report fi l ters, metri cs, and prompts.

l If you have ol d proj ects w i th metadata obj ects that have been
previ ousl y transl ated, i t i s recommended that you merge your
transl ated stri ngs from your ol d metadata i nto the new l y upgraded
metadata usi ng Mi croStrategy Proj ect Merge. For steps, see
Transl ati ng Al ready Transl ated Pre-9.x Proj ects, page 1671.

l It i s recommended for D evel oper i nternati onal i zati on that you use a
uni fi ed l ocal e. For exampl e, i f French i s the l anguage sel ected for
the i nterface, the metadata obj ects l anguage preference and report

© 2019, M icr o St r at egy In c. 165 3

Syst em Ad m in ist r at io n Gu id e

data l anguage preference, as w el l as number and date preferences,

shoul d al so be i n French.

l If you are usi ng or pl an to use Mi croStrategy Intel l i gent C ubes, and

you pl an to i mpl ement data i nternati onal i zati on, i t i s recommended
that you use a SQL-based D I model . The SQL-based D I model i s
descri bed i n Provi di ng D ata Internati onal i zati on, page 1673.
Because a si ngl e Intel l i gent C ube cannot connect to more than one
data w arehouse, usi ng a connecti on-based D I model requi res a
separate Intel l i gent C ube to be created for each l anguage, w hi ch
can be resource-i ntensi ve. D etai l s on thi s cost-benefi t anal ysi s as
w el l as background i nformati on on Intel l i gent C ubes are i n the In-
memory Anal yti cs Gui de.

Preparing a Project to Support

Internationalization
The procedures i n thi s secti on w i l l hel p you modi fy exi sti ng
Mi croStrategy proj ects to support both metadata and data
i nternati onal i zati on. These procedures perform several i mportant
modi fi cati ons to your metadata, i ncl udi ng maki ng i t U ni code-
compl i ant, provi di ng some new transl ati ons for system obj ects, and
other proj ect-l evel preparati ons.

Thes e proc edures mus t be performed whether y ou plan to s upport only

metadata internationaliz ation, only data internationaliz ation, or both.

This s ec tion inc ludes s teps to be tak en when ins talling or upgrading to the
lates t v ers ion of Dev eloper. You s hould be prepared to us e the s teps below
during the ins tallation or upgrade proc es s . For s teps to ins tall, s ee the
Instal l ati on and C onfi gurati on Gui de . For s teps to upgrade, s ee the
U pgrade Gui de .

165 4 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Adding Internationalization Tables to the Metadata

Repository
The fi rst step to i nternati onal i zi ng your data and metadata i s to add
the i nternati onal i zati on tabl es to your Mi croStrategy metadata
reposi tory.

This s tep mus t be performed before y ou update y our projec t's metadata
definitions .

Thi s step must be compl eted duri ng your i nstal l ati on or upgrade to the
l atest versi on of D evel oper. For steps to i nstal l , see the Instal l ati on
and C onfi gurati on Gui de. For steps to perform a general
Mi croStrategy upgrade, see the U pgrade Gui de.

To Add Internationalization Tables to the Metadata Repository

1. D uri ng the upgrade or i nstal l ati on process, sel ect U pgrade

existing environment to MicroStrategy Intelligent Enterprise
i n the C onfi gurati on Wi zard, and cl i ck N ext.

2. C onti nue w orki ng through the steps i n the Instal l ati on and
C onfi gurati on Gui de or the U pgrade Gui de to compl ete the
process.

Updating Your Project's Metadata Definitions

After you add i nternati onal i zati on tabl es to your metadata reposi tory
as descri bed above, you must update your proj ect's metadata w i th the
l atest defi ni ti ons.

This proc edure may hav e been c ompleted during y our ins tallation or
upgrade to the lates t v ers ion of Dev eloper. If it was not part of the ins tall
or upgrade, it mus t be performed to s upport metadata and data
internationaliz ation. For s teps to ins tall, s ee the Instal l ati on and
C onfi gurati on Gui de . For s teps to upgrade, s ee the U pgrade Gui de .

© 2019, M icr o St r at egy In c. 165 5

Syst em Ad m in ist r at io n Gu id e

To Update Metadata Definitions

1. In D evel oper, doubl e-cl i ck the name of the proj ect that you w ant
to i nternati onal i ze.

2. Log i nto the proj ect. You are prompted to update your proj ect.
C l i ck Yes.

The metadata i s updated to the l atest versi on of Mi croStrategy.

Updating System Object Translations

Thi s opti onal procedure l ets you "automati cal l y transl ate" system
obj ects such as fol der names, securi ty rol es, and user groups, by
accessi ng transl ati ons that come w i th Mi croStrategy for those obj ects.

If you prefer to provi de your ow n transl ati ons (for exampl e i f you w i l l
be customi zi ng fol der names), you do not need to perform thi s
procedure.

For projec ts c reated before Mic roStrategy v ers ion 8.x , due to c hanges
in folder s truc ture it is pos s ible that s y s tem objec ts c annot be updated if
they hav e been renamed.

To Update System Object Translations

1. R el oad the proj ect before updati ng system obj ect transl ati ons.
To do thi s, i n the Fol der Li st on the l eft, w i thi n the appropri ate
proj ect source, expand A dministration, expand System
A dministration, and sel ect Projects. R i ght-cl i ck the proj ect,
poi nt to A dminister project, and cl i ck U nload. After the proj ect
unl oads, cl i ck Load.

2. R i ght-cl i ck the proj ect you have upgraded, and sel ect Project
C onfiguration.

165 6 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

3. Expand Project D efinition, expand U pdate, then sel ect

Translations.

4. C l i ck U pdate.

Allowing Access to Languages and Language Objects

Internati onal i zati on for l anguages and l anguage obj ects i s control l ed
pri mari l y through access control l i sts (AC Ls). You can al l ow
permi ssi ons to speci fi c users for each obj ect that needs to be
transl ated, or for each l anguage obj ect (an obj ect that represents a
l anguage i n your system).

Access t o Ad d o r Mo d if y a Tr an slat io n
You can create a speci al i zed user account for a transl ator that
restri cts thei r access i n Mi croStrategy to onl y transl ati ng obj ects i nto
a speci fi c l anguage. For steps, see C reati ng Transl ator R ol es, page
1719.

By defaul t, admi ni strators and obj ect ow ners can transl ate an obj ect
or modi fy an exi sti ng transl ati on. U se AC Ls to provi de other users
Wri te access to an obj ect, i f other users need to transl ate that obj ect.
To change AC L permi ssi ons, ri ght-cl i ck the obj ect and sel ect
Properties, then sel ect Security on the l eft. For detai l s on each AC L
and w hat access i t al l ow s, cl i ck H elp.

You can al so provi de a user w i th the U se R eposi tory Transl ati on

Wi zard pri vi l ege. Thi s al l ow s a user to perform the necessary steps to
transl ate or modi fy transl ati ons of stri ngs i n al l l anguages, w i thout
gi vi ng the user the abi l i ty to modi fy an obj ect i n any other w ay. To
change a pri vi l ege, open the user i n the U ser Edi tor and sel ect
Project A ccess on the l eft, then expand the Obj ect Manager set of
pri vi l eges on the ri ght and sel ect the U se R epository Translation
Wizard check box.

© 2019, M icr o St r at egy In c. 165 7

Syst em Ad m in ist r at io n Gu id e

Access t o Select o r En ab le Disp layed Lan gu ages: Lan gu age

Ob ject s
By defaul t, Mi croStrategy users are provi ded w i th appropri ate
pri vi l eges to Brow se and U se l anguage obj ects, such that anal ysts
can sel ect a l anguage as thei r di spl ay preference i f that l anguage has
been enabl ed for a proj ect. Proj ect admi ni strators can enabl e any
l anguages avai l abl e i n the system.

You can modi fy these defaul t pri vi l eges for a speci fi c user rol e or a
speci fi c l anguage obj ect.

To Modify Access to a Language Object

1. In the Fol der Li st on the l eft, w i thi n the appropri ate proj ect
source, expand A dministration.

2. Expand C onfiguration Managers, then sel ect Languages.

3. Al l l anguage obj ects are l i sted on the ri ght. To change AC L

permi ssi ons for a l anguage obj ect, ri ght-cl i ck the obj ect and
sel ect Properties.

4. Sel ect Security on the l eft.

Providing Metadata Internationalization

Metadata i nternati onal i zati on (MD I) di spl ays transl ated obj ect stri ngs
based on a user's l ocal e and other l anguage preferences i n the
softw are, for obj ects that are stored i n the Mi croStrategy metadata,
such as metri c names, report names, the Publ i c Obj ects system
fol der, securi ty rol e names, user group names, and so on. Metadata
transl ati on al so i ncl udes embedded text stri ngs (embedded i n an
obj ect's defi ni ti on), such as prompt i nstructi ons, al i ased names
(w hi ch can be used i n attri butes, metri cs, and custom groups),

165 8 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

consol i dati on el ement names, custom group el ement names, graph

ti tl es, and threshol d text.

Metadata obj ect transl ati on does not i ncl ude confi gurati on obj ects
(such as the user obj ect), functi on names, data mart tabl e names, and
so on.

Begi n metadata transl ati on by enabl i ng l anguages for your proj ect's
metadata obj ects; see Enabl i ng and D i sabl i ng Metadata Languages,
page 1659. Then use the appropri ate set of procedures bel ow ,
dependi ng on w hether transl ati ons al ready exi st for your proj ect or
you w i l l be transl ati ng your proj ect for the fi rst ti me:

l Transl ati ng Your Proj ect for the Fi rst Ti me, page 1663

l Transl ati ng Al ready Transl ated Pre-9.x Proj ects, page 1671

Enabling and Disabling Metadata Languages

To support the di spl ay of transl ati ons for metadata obj ect names and
descri pti ons, you must enabl e l anguages for your proj ect. The
l anguages you enabl e are those l anguages you w ant to support for
that proj ect.

You can al so di sabl e l anguages for a proj ect.

En ab lin g Met ad at a Lan gu ages wh ile Cr eat in g a New Pr o ject

If you pl an to provi de an i nternati onal i zed proj ect, you can enabl e
i nternati onal i zati on w hen creati ng a new proj ect. For i nformati on on
the structure of your data w arehouse to support i nternati onal i zati on
for a new proj ect, and steps to enabl e i nternati onal i zati on w hi l e
creati ng a new proj ect, see the Proj ect D esi gn Gui de.

© 2019, M icr o St r at egy In c. 165 9

Syst em Ad m in ist r at io n Gu id e

En ab lin g Met ad at a Lan gu ages f o r an Exist in g Pr o ject

After the metadata has been updated and your proj ect has been
prepared for i nternati onal i zati on (usual l y performed duri ng the
Mi croStrategy i nstal l ati on or upgrade), you enabl e l anguages so they
w i l l be supported by the proj ect for metadata i nternati onal i zati on.

Gather a lis t of languages us ed by filters and prompts in the projec t. Thes e

languages s hould be enabled for the projec t, otherwis e a report c ontaining a
filter or prompt in a language not enabled for the projec t will not be able to
ex ec ute s uc c es s fully .

To Enable Metadata Languages for a Project

1. Log i nto the proj ect as a user w i th Admi ni strati ve pri vi l eges.

2. R i ght-cl i ck the proj ect and sel ect Project C onfiguration.

3. On the l eft si de of the Proj ect C onfi gurati on Edi tor, expand
Language and sel ect Metadata.

1660 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

4. C l i ck A dd to see a l i st of avai l abl e l anguages.

The l anguages di spl ayed i n bol d bl ue are those l anguages that

the metadata obj ects have been enabl ed to support. Thi s l i st i s
di spl ayed as a starti ng poi nt for the set of l anguages you can
choose to enabl e for supporti ng data i nternati onal i zati on.

To add a new language, c lic k N ew . For s teps to c reate a c us tom

language, s ee A dding or R emoving a Language in the
System, page 1712.

5. Sel ect the check boxes for the l anguages that you w ant to enabl e
for thi s proj ect.

l Enabl ed l anguages w i l l appear i n the R eposi tory Transl ati on

Wi zard for stri ng transl ati on, as w el l as i n D evel oper's My
Preferences and Web's Preferences, for users to sel ect thei r

© 2019, M icr o St r at egy In c. 1661

Syst em Ad m in ist r at io n Gu id e

ow n preferred l anguage for the proj ect.

l R eports that contai n fi l ters or prompts i n a transl ated l anguage

w i l l execute successful l y i f the proj ect has that l anguage
enabl ed.

6. C l i ck OK .

7. Sel ect one of the l anguages on the ri ght si de to be the defaul t

l anguage for thi s proj ect. The defaul t l anguage i s used by the
system to mai ntai n obj ect name uni queness.

This may hav e been s et when the projec t was firs t c reated. If s o, it
will not be av ailable to be s elec ted here.

Onc e the projec t default language is s et, it c annot be c hanged

unles s y ou duplic ate the projec t and c hange the default language of
the duplic ated projec t. Indiv idual objec ts within a projec t c an hav e
their default language c hanged.

If y ou are enabling a language for a projec t that has been upgraded

from 8.x or earlier, the default metadata language mus t be the
language in whic h the projec t was originally c reated (the 8.x
Dev eloper language at the time of projec t c reation). Be s ure to
s elec t the default language that matc hes the language s elec ted
when the projec t was originally c reated. You c an then add other
languages to s upport the projec t. To c hange a projec t's default
language, y ou mus t duplic ate the projec t and c hange the default
language in the duplic ated projec t.

8. C l i ck OK .

9. D i sconnect and reconnect to the proj ect source.

10. U pdate the out-of-the-box Mi croStrategy metadata obj ects. To do

thi s, i n D evel oper, ri ght-cl i ck the proj ect and go to Project
C onfiguration > Project definition > U pdate > Translations >
U pdate.

1662 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Disab lin g Met ad at a Lan gu ages f o r a Pr o ject

You can use the steps bel ow to di sabl e a l anguage for a proj ect.
When a l anguage has been di sabl ed from a proj ect, that l anguage i s
no l onger avai l abl e for users to sel ect as a l anguage preference, and
the l anguage cannot be seen i n any transl ati on-rel ated i nterfaces,
such as an obj ect's Transl ati on di al og box.

If a us er's preferred language is dis abled, the nex t lower priority

language preferenc e will tak e effec t. To s ee the language preferenc e
priority hierarc hy , s ee C onfi guri ng Metadata Obj ect and R eport
D ata Language Preferences, page 1689 .

Any transl ati ons for the di sabl ed l anguage are not removed from the
metadata w i th these steps. R etai ni ng the transl ati ons i n the metadata
al l ow s you to enabl e the l anguage agai n l ater, and the transl ati ons
w i l l sti l l exi st. To remove transl ati ons i n the di sabl ed l anguage from
the metadata, obj ects that contai n these terms must be modi fi ed
i ndi vi dual l y and saved.

To Disable Metadata Languages in a Project

1. Log i n to a proj ect as a user w i th admi ni strati ve pri vi l eges.

2. R i ght-cl i ck the proj ect and sel ect Project C onfiguration.

3. On the l eft si de of the Proj ect C onfi gurati on Edi tor, expand
Language, then sel ect Metadata.

4. On the ri ght si de, under Sel ected Languages, cl ear the check
box for the l anguage that you w ant to di sabl e for the proj ect, and
cl i ck OK .

Translating Your Project for the First Time

Transl ati ng a proj ect i nvol ves provi di ng transl ated stri ngs for
metadata obj ect names and descri pti ons.

© 2019, M icr o St r at egy In c. 1663

Syst em Ad m in ist r at io n Gu id e

If you use transl ator rol es, be sure to assi gn the appropri ate
permi ssi ons and pri vi l eges i n Mi croStrategy to your transl ators before
begi nni ng the transl ati on steps. See C reati ng Transl ator R ol es, page
1719 for detai l s.

There are tw o methods to transl ate metadata obj ects, dependi ng on

w hether you w ant to transl ate a l arge number of obj ects or j ust one or
tw o obj ects:

l Translate a large number of objects: Extract stri ngs i n bul k to a

transl ati on database, transl ate them, and i mport them back i nto
Mi croStrategy. The Mi croStrategy R eposi tory Transl ati on Wi zard i s
the recommended method to i nternati onal i ze your metadata obj ects.
Steps to access thi s tool are bel ow .

l Translate one or more objects in a folder: R i ght-cl i ck the obj ect

and sel ect Translate. Type the transl ated w ord(s) for each
l anguage thi s obj ect supports, and cl i ck OK . To transl ate several
obj ects, sel ect them al l w hi l e hol di ng Shi ft or C trl , then ri ght-cl i ck
and sel ect Translate. For detai l s to use the Obj ect Transl ati on
di al og box, cl i ck H elp.

The rest of thi s secti on descri bes the method to transl ate bul k obj ect
stri ngs, usi ng a separate transl ati on database, w i th the R eposi tory
Transl ati on Wi zard.

The Repos itory Trans lation Wiz ard does not s upport trans lation of
c onfiguration objec ts (s uc h as the us er objec t). It does s upport objec t
des c riptors , inc luding embedded tex t. Thes e are detailed in the
introduc tion to Provi di ng Metadata Internati onal i zati on, page 1658 .

If your proj ect has not yet been transl ated, metadata
i nternati onal i zati on i nvol ves the fol l ow i ng hi gh-l evel steps:

1664 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

All of the proc edures in this s ec tion as s ume that y our projec ts hav e
been prepared for internationaliz ation. Preparation s teps are in
Prepari ng a Proj ect to Support Internati onal i zati on, page 1654 .

1. Enabl e l anguages for the metadata reposi tory (see Enabl i ng and
D i sabl i ng Metadata Languages, page 1659)

2. Export obj ect stri ngs to a l ocati on w here they can be transl ated
(see Extracti ng Metadata Obj ect Stri ngs for Transl ati on, page
1665)

3. Perform the l i ngui sti c transl ati on (see Transl ati ng Metadata
Obj ect Stri ngs i n the Transl ati on D atabase, page 1666)

4. Import the new l y transl ated obj ect stri ngs back i nto the metadata
reposi tory (see Importi ng Transl ated Stri ngs from the Transl ati on
D atabase to the Metadata, page 1670)

Ext r act in g Met ad at a Ob ject St r in gs f o r Tr an slat io n

The Mi croStrategy R eposi tory Transl ati on Wi zard supports Mi crosoft
Access and Mi crosoft SQL Server databases as transl ati on
reposi tori es. The transl ati on reposi tory i s w here stri ngs are extracted
to and w here the actual transl ati on process i s performed.

You cannot extract stri ngs from the proj ect's defaul t metadata
l anguage.

It is rec ommended that objec ts are not modified between the ex trac tion
proc es s and the import proc es s . This is es pec ially important for objec ts
with loc ation-s pec ific s trings : attribute alias es , metric alias es , c us tom
group elements , and doc ument tex t box es .

© 2019, M icr o St r at egy In c. 1665

Syst em Ad m in ist r at io n Gu id e

To Extract a Large Number of Object Strings for Translation

1. Open the R eposi tory Transl ati on Wi zard. To do thi s, from the
Start menu, poi nt to A ll Programs, then MicroStrategy Tools,
then sel ect R epository Translation Wizard.

2. C l i ck N ext to begi n.

3. To extract stri ngs from the metadata, sel ect the Export
Transl ati ons opti on from the Metadata R eposi tory page i n the
w i zard.

Tr an slat in g Met ad at a Ob ject St r in gs in t h e Tr an slat io n

Dat ab ase
The extracti on process performed by the R eposi tory Transl ati on
Wi zard creates a tabl e i n the transl ati on database, w i th the fol l ow i ng
col umns:

l PR OJEC TID : Thi s i s the ID of the proj ect from w hi ch the stri ng i s
extracted.

l OBJEC TID : Thi s i s the ID of the obj ect from w hi ch the stri ng i s
extracted.

l OBJEC TTYPE: Each obj ect i s associ ated w i th a numeri c code. For
exampl e, documents are represented by OBJEC TTYPE code 55.

l EMBED D ED ID : An embedded obj ect i s an obj ect contai ned i nsi de

another obj ect, for exampl e, a metri c obj ect that i s part of a report
obj ect. If the stri ng i s extracted from an embedded obj ect, the ID of
thi s embedded obj ect i s stored i n thi s col umn. The val ue 0 i ndi cates
that the stri ng i s not extracted from an embedded obj ect.

1666 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l EMBED D ED TYPE: Thi s i s a numeri c representati on of the type of

the embedded obj ect. The val ue 0 i ndi cates that the stri ng i s not
extracted from an embedded obj ect.

l U N IQU EKEY: Thi s i s a key assi gned to the extracted stri ng to

i denti fy the stri ng w i thi n the obj ect.

l R EAD ABLEKEY: Thi s i s a descri pti on of the extracted stri ng w i thi n

the obj ect, for exampl e, Prompt Ti tl e, Prompt D escri pti on, Obj ect
N ame, Templ ate Subtotal N ame, and so on. The R EAD ABLEKEY i s
a readabl e form of the U N IQU EKEY.

l LOC ALEID : Thi s i ndi cates the l anguage of the extracted stri ng i n
the TR AN SLATION col umn.

Mi croStrategy uses l ocal e ID s to uni quel y i denti fy l anguages. For

consi stency, Mi croStrategy uses the same l ocal e ID s as Mi crosoft.
The fol l ow i ng tabl e l i sts the l anguage codes for the l anguages that
Mi croStrategy supports out-of-the-box.

L an g u ag e L an g u ag e Co d e

Chinese (S implif ied) 2052

Chinese (Tradit ional) 1028

E nglish (US ) 1033

French (France) 1036

German (Germany) 1031

I t alian (I t aly) 1040

Japanese 1041

K orean 1042

P ort uguese (B razil) 1046

S panish (S pain) 3082

S wedish 1053

© 2019, M icr o St r at egy In c. 1667

Syst em Ad m in ist r at io n Gu id e

For c us tom languages , Mic roStrategy as s igns a unique language ID

bas ed on the bas e language that it is deriv ed from.

l TR AN SLATION : Thi s i s the col umn w here the extracted stri ng i s

stored.

l TR AN SVER SION ID : Thi s i s the versi on ID of the obj ect at the ti me

of export.

l R EFTR AN SLATION : Thi s col umn contai ns the extracted stri ng i n

the transl ati on reference l anguage, w hi ch i s sel ected by the user
from the R eposi tory Transl ati on Wi zard duri ng export.

Thi s stri ng i s used onl y as a reference duri ng the transl ati on

process. For exampl e, i f the transl ator i s comfortabl e w i th the
German l anguage, you can set German as the transl ati on
reference l anguage. The R EFTR AN SLATION col umn w i l l then
contai n al l the extracted stri ngs i n the German l anguage, for the
transl ator to use as a reference w hen they are transl ati ng
extracted stri ngs.

If no referenc e language s tring is av ailable, the s tring from the objec t's
primary language is ex ported s o that this c olumn is not empty for any
s tring.

l STATU S: You can use thi s col umn to enter fl ags i n the tabl e to
control w hi ch stri ngs are i mported back i nto the metadata. A fl ag i s
a character you type, for exampl e, a l etter, a number, or a speci al
character (as l ong as i t i s al l ow ed by your database). When you use
the w i zard to i mport the stri ngs back i nto the metadata, you can
i denti fy thi s character for the system to use duri ng the i mport
process, to determi ne w hi ch stri ngs to i mport.

For exampl e, i f a transl ator has fi ni shed onl y some transl ati ons, you
may w ant to i mport onl y the compl eted ones. Or i f a revi ew er has
compl eted the l anguage revi ew for onl y some of the transl ati ons,

1668 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

you may w i sh to i mport onl y those stri ngs that w ere revi ew ed. You
can fl ag the stri ngs that w ere compl eted and are ready to be
i mported.

l OBJVER SION ID : Thi s i s the versi on ID of obj ects at the ti me of

i mport.

l SYN C H FLAG: Thi s i s a system fl ag and i s automati cal l y generated

duri ng i mport. The fol l ow i ng val ues are used:

l 0: Thi s means that the obj ect has not been modi fi ed betw een
extracti on and i mport.

l 1: Thi s means that the obj ect has been modi fi ed betw een
extracti on and i mport.

l 2: Thi s means that the obj ect that i s bei ng i mported i s no l onger
present i n the metadata.

System fl ags are automati cal l y appl i ed to stri ngs duri ng the i mport
process, so that you can vi ew any stri ng-speci fi c i nformati on i n
the l og fi l e.

l LASTMOD IFIED : Thi s i s the date and ti me w hen the stri ngs w ere
extracted.

Once the extracti on process i s compl ete, the stri ngs i n the transl ati on
database need to be transl ated i n the extracti on tabl e descri bed
above. Thi s i s general l y performed by a dedi cated transl ati on team or
a 3rd party transl ati on vendor.

l If an objec t has an empty trans lation in a us er's c hos en projec t

language preferenc e, the s y s tem defaults to dis play ing the objec t's
default language, s o it is not nec es s ary to add trans lations for objec ts
that are not intended to be trans lated. For details on language
preferenc es , s ee Sel ecti ng Preferred Languages for Interfaces,
R eports, and Obj ects, page 1685 .

© 2019, M icr o St r at egy In c. 1669

Syst em Ad m in ist r at io n Gu id e

l If y ou performed a Searc h for Objec ts in the Repos itory Trans lation

Tool, y ou may notic e that the number of rows in the ex trac tion table
might not matc h the number of rows returned in the s earc h res ults .
This is bec aus e a s earc h returns all objec ts that meet the s earc h
requirements ; the s earc h does not filter for only thos e items that c an
be trans lated. Thus , for ex ample, the s earc h may return a row for the
look up table LU_YEAR, but the ex trac tion proc es s does not ex trac t
the LU_YEAR s tring bec aus e there is no reas on to trans late a look up
table's name. To determine whether an objec t's name c an be
trans lated, right-c lic k the objec t, s elec t Properties , and look for the
International option on the left. If this option is mis s ing, the objec t is
not s upported for trans lation.

To confi rm that your transl ati ons have successful l y been i mported
back i nto the metadata, navi gate to one of the transl ated obj ects i n
D evel oper, ri ght-cl i ck, and sel ect Properti es. On the l eft, sel ect
Internati onal , then cl i ck Transl ate. The tabl e show s al l transl ati ons
currentl y i n the metadata for thi s obj ect.

Imp o r t in g Tr an slat ed St r in gs f r o m t h e Tr an slat io n Dat ab ase

t o t h e Met ad at a
After stri ngs have been transl ated by a l anguage expert i n the
transl ati on database, they must be re-i mported i nto the Mi croStrategy
metadata.

To Import Translated Strings

1. Open the R eposi tory Transl ati on Wi zard. To do thi s, from the
Start menu, poi nt to A ll Programs, then MicroStrategy Tools,
then sel ect R epository Translation Wizard.

2. C l i ck N ext to begi n.

1670 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

3. To i mport stri ngs from the transl ati on database back i nto the
metadata, sel ect the Import Translations opti on from the
Metadata R eposi tory page i n the w i zard.

After the stri ngs are i mported back i nto the proj ect, any obj ects that
w ere modi fi ed w hi l e the transl ati on process w as bei ng performed, are
automati cal l y marked w i th a 1. These transl ati ons shoul d be checked
for correctness, si nce the modi fi cati on may have i ncl uded changi ng
the obj ect's name or descri pti on.

When you are fi ni shed w i th the stri ng transl ati on process, you can
proceed w i th data i nternati onal i zati on i f you pl an to provi de transl ated
report data to your users. For background i nformati on and steps, see
Provi di ng D ata Internati onal i zati on, page 1673. You can al so set user
l anguage preferences for transl ated metadata obj ects and data i n
Enabl i ng or D i sabl i ng Languages i n the Proj ect to Support D I, page
1680.

Translating Already Translated Pre-9.x Projects

You may have your transl ated i nformati on spread out among several
i ndi vi dual , monol i ngual proj ects and you w ant to add mul ti l i ngual
support and combi ne them i nto a si ngl e, al l -i ncl usi ve mul ti l i ngual
proj ect cal l ed a master proj ect.

Even i f you mai ntai n separate producti on proj ects i n separate

l anguages, the i deal scenari o i s to create a si ngl e devel opment
proj ect w here transl ati ons are mai ntai ned for al l l anguages that are
requi red by any regi onal producti on proj ects.

If y ou us e trans lator roles , be s ure to as s ign the appropriate

permis s ions and priv ileges in Mic roStrategy to y our trans lators before
beginning the trans lation s teps . See C reati ng Transl ator R ol es, page
1719 for details .

When transl ated proj ects al ready exi st, metadata i nternati onal i zati on
i nvol ves the fol l ow i ng hi gh-l evel steps:

© 2019, M icr o St r at egy In c. 1671

Syst em Ad m in ist r at io n Gu id e

All of the proc edures in this s ec tion as s ume that y ou hav e c ompleted
any final import of trans lations to y our pre-9.x projec t us ing the old
Repos itory Trans lation Tool, and that y our projec ts hav e been prepared
for internationaliz ation. Preparation s teps are in Prepari ng a Proj ect to
Support Internati onal i zati on, page 1654 .

1. Enabl e l anguages for the metadata reposi tory (see Enabl i ng and
D i sabl i ng Metadata Languages, page 1659). For the master
proj ect, be sure to enabl e al l l anguages that you w i l l be
supporti ng.

2. Back up your exi sti ng transl ated stri ngs by extracti ng al l obj ects
from the ol d transl ated proj ects usi ng the Mi croStrategy
R eposi tory Transl ati on Wi zard (see Extracti ng Metadata Obj ect
Stri ngs for Transl ati on, page 1665).

3. Merge the transl ated proj ects i nto the master proj ect usi ng the
Proj ect Merge Wi zard. D o not merge any transl ati ons.

4. You now have a si ngl e master proj ect that contai ns al l obj ects
that w ere present i n both the ori gi nal master proj ect and i n the
transl ated proj ect.

5. Extract al l obj ects from the master proj ect usi ng the
Mi croStrategy R eposi tory Transl ati on Wi zard (see Extracti ng
Metadata Obj ect Stri ngs for Transl ati on, page 1665).

6. Provi de transl ati ons for al l obj ects i n the transl ated l anguage
(see Transl ati ng Metadata Obj ect Stri ngs i n the Transl ati on
D atabase, page 1666).

7. Import al l transl ati ons back i nto the master proj ect (see Importi ng
Transl ated Stri ngs from the Transl ati on D atabase to the
Metadata, page 1670).

8. After transl ati on veri fi cati on, dupl i cate the master proj ect so that
you have a devel opment proj ect, a testi ng proj ect, and at l east
one producti on proj ect.

1672 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Providing Data Internationalization

D ata i nternati onal i zati on (or D I) al l ow s you to di spl ay transl ated
report and document resul ts to users from your data w arehouse. D ata
i nternati onal i zati on al l ow s a si ngl e report defi ni ti on to contai n
di fferent attri bute el ements for each l anguage avai l abl e to users, w i th
the appropri ate el ement di spl ayed based on the user's l ocal e and
other l anguage preferences i n the softw are.

D ata i nternati onal i zati on i nvol ves the fol l ow i ng hi gh-l evel steps:

All of the proc edures in this s ec tion as s ume that y our projec ts hav e
been prepared for internationaliz ation. Preparation s teps are in
Prepari ng a Proj ect to Support Internati onal i zati on, page 1654 .

1. Store the transl ated data i n a data w arehouse. Transl ated data
stri ngs can be stored ei ther i n thei r ow n col umns and/or tabl es i n
the same w arehouse as the source (untransl ated) data, or i n
di fferent w arehouses separated by l anguage. Some
organi zati ons keep the source l anguage stored i n one
w arehouse, w i th al l other l anguages stored together i n a di fferent
w arehouse. You must confi gure Mi croStrategy w i th a D I model so
i t can connect to one of these storage scenari os: the SQL-based
model and the connecti on-based model . For detai l s on each
model and steps to confi gure Mi croStrategy, see Stori ng
Transl ated D ata: D ata Internati onal i zati on Model s, page 1674).

2. Enabl e the l anguages i n Mi croStrategy that w i l l be supported by

the proj ect and confi gure the system based on w here the
transl ated data i s stored (see Enabl i ng or D i sabl i ng Languages
i n the Proj ect to Support D I, page 1680).

© 2019, M icr o St r at egy In c. 1673

Syst em Ad m in ist r at io n Gu id e

Storing Translated Data: Data Internationalization

Models

This s ec tion as s umes that y ou unders tand the s truc ture of y our
organiz ation's data s torage. Table and c olumn c reation, maintenanc e,
and alteration is bey ond the s c ope of this guide. For information about
data warehous es and how internationaliz ation affec ts the proc es s of
s toring and organiz ing information in the data warehous e, s ee the
Mi croStrategy Proj ect D esi gn Gui de.

You must connect Mi croStrategy to your storage system for transl ated
data. To do thi s, you must i denti fy w hi ch type of storage system you
are usi ng. Transl ated data for a gi ven proj ect i s stored i n one of tw o
w ays:

l In col umns and tabl es w i thi n the same data w arehouse as your
source (untransl ated) data (see SQL-Based D I Model , page 1674)

l Stored i n a di fferent data w arehouse from your source

(untransl ated) data (see C onnecti on-Based D I Model , page 1675)

SQL-Based DI Mo d el
If al l of your transl ati ons are stored i n the same data w arehouse as
the source (untransl ated) data, thi s i s a SQL-based D I model . Thi s
model assumes that your transl ati on storage i s set up for col umn-l evel
data transl ati on (C LD T) and/or tabl e-l evel data transl ati on (TLD T),
w i th standardi zed nami ng conventi ons.

Thi s model i s cal l ed SQL-based because SQL queri es are used to

di rectl y access data i n a si ngl e w arehouse for al l l anguages. You can
provi de transl ated D ESC (descri pti on) forms for attri butes w i th thi s D I
model .

If you are usi ng a SQL-based D I model , you must speci fy the col umn
pattern or tabl e pattern for each l anguage. The pattern depends upon

1674 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

the tabl e and col umn names that contai n transl ated data i n your
w arehouse. Mi croStrategy supports a w i de range of stri ng patterns.
The stri ng pattern i s not l i mi ted to suffi xes onl y. H ow ever, usi ng
prefi xes or other non-suffi x nami ng conventi ons requi res you to use
some functi ons so that the system can recogni ze the l ocati on of
transl ated data. These functi ons are i ncl uded i n the steps to connect
the system to your database.

Regular (non-loc ale-s pec ific ) c onnec tion maps are treated normally by
Mic roStrategy if y ou c hoos e the SQL-bas ed DI model.

Thi s model i s recommended i f usi ng Mi croStrategy Intel l i gent C ubes.

For steps to poi nt Mi croStrategy to the correct col umns or tabl es for
each l anguage, see C onnecti ng the System to a Si ngl e D atabase:
SQL-Based D I Model , page 1677.

Co n n ect io n -Based DI Mo d el
If the transl ated data i s stored i n di fferent data w arehouses for each
l anguage, Mi croStrategy retri eves the transl ati ons usi ng a database
connecti vi ty API, namel y OD BC . Thi s model i s cal l ed connecti on-
based because a connecti on to more than one data w arehouse must
be made to access data i n al l l anguages. Thi s i s commonl y cal l ed
w arehouse-l evel data transl ati on (WLD T).

When usi ng a connecti on-based D I model , you can connect to as

many data w arehouses as necessary, for exampl e, one for each
l anguage. For steps to provi de the appropri ate database connecti on
i nformati on for each data w arehouse, see C onnecti ng the System to
more than one D atabase: C onnecti on-Based D I Model , page 1678.

Ch o o sin g a DI Mo d el
You must eval uate your physi cal data storage for both your source
(untransl ated) l anguage and any transl ated l anguages, and deci de

© 2019, M icr o St r at egy In c. 1675

Syst em Ad m in ist r at io n Gu id e

w hi ch data i nternati onal i zati on model i s appropri ate for your

envi ronment.

Mic roStrategy c an us e either a SQL-bas ed or a c onnec tion-bas ed DI

model, but not both. For ex ample, if y our projec t s upports 10 languages ,
and 5 of thos e languages are s tored in one data warehous e and the other
5 are s tored indiv idually in s eparate data warehous es , Mic roStrategy
does not s upport this s torage s olution.

The fol l ow i ng tabl e descri bes common transl ati on storage scenari os,
and show s you w hi ch D I model and transl ati on access method must
be used.

Data
T ran slatio n Sto rag e T ran slatio n Access
In tern atio n alizatio n
L o catio n Meth o d
Mo d el

Dif f erent t ables f or each

Dif f erent S QL generat ed
language, in one dat a S QL-based
f or each language
warehouse

Dif f erent columns f or each

Dif f erent S QL generat ed
language, in one dat a S QL-based
f or each language
warehouse

Dif f erent t ables and columns

Dif f erent S QL generat ed
f or each language, in one S QL-based
f or each language
dat a warehouse

Dif f erent dat abase

One dat a warehouse f or each
connect ion f or each Connect ion-based
language
language

If y ou are c reating a new data warehous e and plan to implement DI, and
y ou als o us e Intelligent Cubes , it is rec ommended that y ou us e a SQL-
bas ed DI model, with different tables and/or c olumns for eac h language.
Bec aus e a s ingle Intelligent Cube c annot c onnec t to more than one data
warehous e, us ing a c onnec tion-bas ed DI model requires a s eparate

1676 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Intelligent Cube to be c reated for eac h language. This is v ery res ourc e-
intens iv e. For information about Intelligent Cubes in general and details
on des igning Intelligent Cubes for an internationaliz ed env ironment, s ee
the Mic roStrategy In-memory Anal yti cs Gui de .

Connecting the System to the Translation Database

After l anguages have been enabl ed for the proj ect, you must
confi gure the system so that Mi croStrategy can retri eve the transl ated
data. Thi s confi gurati on vari es dependi ng on the data
i nternati onal i zati on (D I) model used:

l C onnection-based D I model: You must speci fy a database

connecti on for each l anguage.

l SQL-based D I model: You must speci fy a col umn pattern or tabl e

pattern for each l anguage.

These model s are descri bed i n detai l i n Stori ng Transl ated D ata:
D ata Internati onal i zati on Model s, page 1674.

Connecting the System to a Single Database: SQL-Based DI Model

For a detai l ed expl anati on of how to set up tabl es and col umns to
support SQL-based data i nternati onal i zati on, see the Proj ect D esi gn
Gui de, Internati onal i zati on through tabl es and col umns or databases
secti on. The Proj ect D esi gn Gui de provi des extensi ve exampl es and
i mages of tabl e and col umn nami ng patterns, expl ai ns the use of onl y
tabl es, onl y col umns, or both tabl es and col umns, the use of l ogi cal
vi ew s, and so on.

Your table s uffix es for languages s hould be c ons is tent and unified
ac ros s the entire warehous e. For ex ample, if y ou hav e Spanis h
trans lations in y our warehous e, the s uffix s hould be _SP for all tables
that inc lude Spanis h trans lations , and not _SP, _ES, _EP, and s o on.

© 2019, M icr o St r at egy In c. 1677

Syst em Ad m in ist r at io n Gu id e

For detai l ed steps to connect the system to your transl ati on database,
see the Proj ect D esi gn Gui de, Enabl i ng data i nternati onal i zati on
through SQL queri es secti on. The Proj ect D esi gn Gui de i ncl udes
detai l s to sel ect your tabl e or col umn nami ng pattern, as w el l as
functi ons to use i f your nami ng pattern does not use suffi xes.

If you are changi ng from one D I model to another, you must rel oad the
proj ect after compl eti ng the steps above. Setti ngs from the ol d D I
model are preserved, i n case you need to change back.

Connecting the System to more than one Database: Connection-Based

DI Model

If you are usi ng a connecti on-based D I model , you must speci fy a

database connecti on for each data w arehouse that stores transl ated
data.

Connec tion mapping c an als o be performed us ing Command Manager.

For a detai l ed expl anati on of how to set up your databases to support

data i nternati onal i zati on, see the Proj ect D esi gn Gui de,
Internati onal i zati on through tabl es and col umns or databases secti on.
The Proj ect D esi gn Gui de provi des extensi ve exampl es and i mages
of transl ati on tabl e structures i n di fferent databases, as w el l as
i mportant restri cti ons on l ogi cal vi ew s and supported character sets.

The database connecti on that you use for each data w arehouse must
be confi gured i n Mi croStrategy before you can provi de transl ated data
to Mi croStrategy users.

The proc edure in the Projec t Des ign Guide as s umes that y ou will enable the
c onnec tion-bas ed DI model. If y ou dec ide to enable the SQL-bas ed model,
y ou c an s till perform the s teps to enable the c onnec tion-bas ed model, but
the language-s pec ific c onnec tion maps y ou c reate in the proc edure will not
be ac tiv e.

1678 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

The phy s ic al s c hemas of all data warehous es to be us ed for data

internationaliz ation s hould be identic al.

You mus t hav e the Configure Connec tion Map priv ilege, at either the us er
lev el or the projec t lev el.

Objec ts dis play ed in the Connec tion Mapping Editor are limited to thos e
objec ts the us er has Brows e and Us e permis s ions for.

For detai l ed steps to connect the system to more than one data
w arehouse, see the Proj ect D esi gn Gui de, Enabl i ng data
i nternati onal i zati on through connecti on mappi ngs secti on.

If you are changi ng from one D I model to another, you must rel oad the
proj ect after compl eti ng the steps i n the Proj ect D esi gn Gui de.
Setti ngs from the ol d D I model are preserved, i n case you need to
change back.

You can del ete a connecti on mappi ng by ri ght-cl i cki ng on the

connecti on map and sel ecti ng D elete.

Supporting Data Internationalization for Attribute

Elements
If you are usi ng the SQL-based D I model , you must perform an
addi ti onal step to support the di spl ay of transl ated attri bute el ements
i n reports and documents.

If the proj ect desi gner has not al ready done so, you must defi ne
attri bute forms i n the proj ect so that they can be di spl ayed i n mul ti pl e
l anguages. D etai l ed i nformati on and steps to defi ne attri bute forms to
support mul ti pl e l anguages are i n the Proj ect D esi gn Gui de,
Supporti ng data i nternati onal i zati on for attri bute el ements secti on.

© 2019, M icr o St r at egy In c. 1679

Syst em Ad m in ist r at io n Gu id e

Enabling or Disabling Languages in the Project to

Support DI
For l anguages that are stored i n your data w arehouse to be avai l abl e
for use i n Mi croStrategy, you must confi gure the proj ect to support
those l anguages.

You can al so add a custom l anguage to the l i st of l anguages

avai l abl e to be enabl ed for data i nternati onal i zati on. For steps to add
a custom l anguage to the proj ect, see Addi ng or R emovi ng a
Language i n the System, page 1712.

En ab lin g Lan gu ages f o r Dat a In t er n at io n alizat io n

After transl ated data has been stored, you must confi gure the proj ect
to establ i sh w hi ch l anguages w i l l be supported for data
i nternati onal i zati on (D I). You must perform thi s procedure w hether
you store transl ated data usi ng a SQL-based D I model or a
connecti on-based D I model .

To Enable Data Internationalization Languages in a Project

1. Log i n to a proj ect as a user w i th admi ni strati ve pri vi l eges.

2. R i ght-cl i ck the proj ect and sel ect Project C onfiguration.

3. On the l eft si de of the Proj ect C onfi gurati on Edi tor, expand
Language, then sel ect D ata.

4. Sel ect the Enable data internationalization check box.

5. Sel ect the D I model that you are usi ng. For detai l s, see Stori ng
Transl ated D ata: D ata Internati onal i zati on Model s, page 1674.

1680 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l For a SQL-based D I model , sel ect SQL based.

l For a connecti on-based D I model , sel ect C onnection mapping

based.

6. C l i ck A dd.

7. Languages di spl ayed i n bol d bl ue are those l anguages that have

been enabl ed for the proj ect to support transl ated metadata
obj ects, i f any. Thi s l i st i s di spl ayed as a starti ng poi nt for the set
of l anguages you can choose to enabl e for supporti ng data
i nternati onal i zati on.

l To di spl ay al l avai l abl e l anguages, or i f no metadata

l anguages are di spl ayed, cl ear the D isplay metadata
languages only check box.

© 2019, M icr o St r at egy In c. 1681

Syst em Ad m in ist r at io n Gu id e

l To add a new l anguage, make sure the D isplay metadata

languages only check box i s cl eared, and then cl i ck N ew. For
steps to create a custom l anguage, see A dding or R emoving
a Language in the System, page 1712.

8. Sel ect the check box next to any l anguage or l anguages that you
w ant to enabl e for thi s proj ect.

If no languages are s elec ted to be enabled to s upport data

internationaliz ation, then data internationaliz ation is treated by the
s y s tem as dis abled.

9. C l i ck OK .

10. In the D efault col umn, sel ect one l anguage to be the defaul t
l anguage for data i nternati onal i zati on i n the proj ect. Thi s
sel ecti on does not have any i mpact on the proj ect or how
l anguages are supported for data i nternati onal i zati on. U nl i ke the
MD I defaul t l anguage, thi s D I defaul t l anguage can be changed
at any ti me.

If no default DI language is s elec ted, data internationaliz ation is

treated by the s y s tem as dis abled.

11. For each l anguage you have enabl ed, defi ne the col umn/tabl e
nami ng pattern or the connecti on-mapped w arehouse, dependi ng
on w hi ch D I model you are usi ng (for i nformati on on D I model s
and on nami ng patterns, see Stori ng Transl ated D ata: D ata
Internati onal i zati on Model s, page 1674):

l SQL-based D I model: If you sel ected the SQL-based D I model

above, cl i ck the C olumn Pattern and Table Pattern col umns
next to one of the l anguages you w i l l support. Type the col umn
or tabl e prefi x or suffi x and cl i ck OK . For exampl es, cl i ck H elp.

1682 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Some languages may hav e the s ame s uffix - for ex ample,

Englis h US and Englis h UK. You c an als o s pec ify a NULL s uffix .

12. C l i ck OK .

13. D i sconnect and reconnect to the proj ect source so that your
changes take effect. To do thi s, ri ght-cl i ck the proj ect source,
sel ect D isconnect from Project Source, then repeat thi s and
sel ect C onnect to Project Source.

Disab lin g a Lan gu age f o r Dat a In t er n at io n alizat io n

You can use the steps bel ow to di sabl e a l anguage for a proj ect.
When a l anguage has been di sabl ed i n a proj ect, that l anguage i s no
l onger avai l abl e for users to sel ect as a l anguage preference, and the
l anguage cannot be seen i n any transl ati on-rel ated i nterfaces such as
an obj ect's defaul t l anguage i n i ts Properti es - Internati onal di al og
box. Any transl ati ons for the di sabl ed l anguage are not removed from
the data w arehouse w i th these steps.

If a us er has s elec ted the language as a language preferenc e, the

preferenc e will no longer be in effec t onc e the language is dis abled. The
projec t's default language will tak e effec t.

If you remove the l anguage currentl y set as the defaul t data

i nternati onal i zati on l anguage, the system automati cal l y sel ects the
fi rst l anguage i n the l i st of remai ni ng enabl ed l anguages to set the
new defaul t l anguage. Thi s new defaul t data i nternati onal i zati on
l anguage shoul d not have any i mpact on your proj ect.

If you di sabl e al l l anguages for data i nternati onal i zati on (D I), the
system treats D I as di sabl ed. Li kew i se, i f you do not have a defaul t
l anguage set for D I, the system treats D I as di sabl ed.

© 2019, M icr o St r at egy In c. 1683

Syst em Ad m in ist r at io n Gu id e

To Disable Data Internationalization Languages in a Project

1. Log i n to a proj ect as a user w i th admi ni strati ve pri vi l eges.

2. R i ght-cl i ck the proj ect and sel ect Project C onfiguration.

3. On the l eft si de of the Proj ect C onfi gurati on Edi tor, expand
Language, then sel ect D ata.

4. On the ri ght si de, under Sel ected Languages, cl ear the check
box for the l anguage that you w ant to di sabl e for the proj ect.

5. C l i ck OK .

6. Perform the fol l ow i ng steps dependi ng on how your proj ect i s

affected:

l Empty any caches or Intel l i gent C ubes contai ni ng content i n

the di sabl ed D I l anguage.

l Language di sabl i ng w i l l onl y affect MD X cubes and regul ar

reports and documents i f an attri bute form descri pti on i n the
di sabl ed l anguage exi sts i n the cube or report. If thi s i s true,
the cube, report, or document cannot be publ i shed or used.
The cube, report, or document desi gner must remove attri bute
forms i n the di sabl ed l anguage before the
cube/report/document can be used agai n.

7. D i sconnect and reconnect to the proj ect source so that your

changes take effect. To do thi s, ri ght-cl i ck the proj ect source,
sel ect D isconnect from Project Source, then repeat thi s and
sel ect C onnect to Project Source.

Making Translated Data Available to Users

After you have performed the necessary steps to confi gure metadata
obj ect transl ati on and/or data transl ati on i n the system, you can

1684 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

speci fy w hi ch l anguage(s) shoul d be di spl ayed for vari ous users i n

the i nterface and i n reports (both report obj ects and report resul ts).
You can speci fy l anguage preferences at the proj ect l evel and at the
al l -proj ects l evel . By sel ecti ng vari ous l evel s of l anguage
preferences, you speci fy w hi ch l anguage i s preferred as a fal l back i f a
fi rst choi ce l anguage i s not avai l abl e.

Thes e language preferenc es are for metadata languages only . All data
internationaliz ation languages fall bac k to the projec t's default language
if a DI preferenc e is not enabled or trans lation of a s pec ific report c ell is
not av ailable.

The fol l ow i ng secti ons show you how to sel ect l anguage preferences
based on vari ous pri ori ty l evel s w i thi n the system, starti ng w i th a
secti on that expl ai ns the pri ori ty l evel s:

l Sel ecti ng Preferred Languages for Interfaces, R eports, and Obj ects,
page 1685

l Sel ecti ng the Interface Language Preference, page 1687

l C onfi guri ng Metadata Obj ect and R eport D ata Language

Preferences, page 1689

l Sel ecti ng the Obj ect D efaul t Language Preference, page 1703

Selecting Preferred Languages for Interfaces, Reports,

and Objects
After transl ated data i s stored i n your data w arehouse and/or
metadata database, and l anguages have been enabl ed for the proj ect,
you must speci fy w hi ch l anguages are the preferred l anguages for the
proj ect and the user. These sel ected l anguages are cal l ed l anguage
preferences.

© 2019, M icr o St r at egy In c. 1685

Syst em Ad m in ist r at io n Gu id e

The fol l ow i ng i mage show s the di fferent parts of the Mi croStrategy

envi ronment that di spl ay transl ated stri ngs based on the l anguage
preferences:

The fol l ow i ng l anguage preferences can be confi gured:

l Interface Language: D etermi ne the l anguage that menu opti ons,

di al og box text, and so on, w i l l di spl ay. For steps to set thi s
preference, see Sel ecti ng the Interface Language Preference, page
1687.

l Metadata objects: D etermi ne the l anguage that w i l l be di spl ayed

for Mi croStrategy obj ects that come from the metadata database,
such as metri c names, report names, system fol der names, and so
on. For steps to set thi s preference, see C onfi guri ng Metadata
Obj ect and R eport D ata Language Preferences, page 1689.

l R eport data: D etermi ne the l anguage that w i l l be di spl ayed for

report resul ts that come from your data w arehouse, such as attri bute
el ement names. For steps to set thi s preference, see C onfi guri ng
Metadata Obj ect and R eport D ata Language Preferences, page
1689.

l Object default language: D etermi ne the fal l back l anguage for

Mi croStrategy obj ects. Thi s l anguage i s used i f a report i s executed

1686 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

i n a l anguage that the obj ect l acks a transl ati on for. For steps to set
or change thi s defaul t preference, see Sel ecti ng the Obj ect D efaul t
Language Preference, page 1703.

Each l anguage preference can be confi gured i ndependentl y of the

others. For exampl e, i t i s possi bl e to have a report that di spl ays al l
metadata obj ect names i n French, w hi l e any data from the data
w arehouse i s di spl ayed i n Engl i sh, and the i nterface i s transl ated i nto
Spani sh. H ow ever, for best performance i t i s recommended that you
use a uni fi ed l anguage di spl ay i n D evel oper. For exampl e, i f you use
French for the i nterface, the metadata obj ects l anguage preference
and the report data l anguage preference, as w el l as number and date
preferences, shoul d al so be i n French.

Select in g t h e In t er f ace Lan gu age Pr ef er en ce

The i nterface l anguage preference determi nes w hat l anguage
D evel oper menus, edi tors, di al og boxes, moni tors and managers, and
other parts of the D evel oper softw are are di spl ayed i n. U se the steps
bel ow to set thi s preference.

Configuring the Interface Language Preference

1. In D evel oper, l og i n to the proj ect.

2. From the Tools menu, sel ect Preferences.

3. On the l eft, expand International and sel ect Language.The

Internati onal : Language di al og box i s di spl ayed, as show n
bel ow :

© 2019, M icr o St r at egy In c. 1687

Syst em Ad m in ist r at io n Gu id e

4. From the Interface Language drop-dow n l i st, sel ect the

l anguage that you w ant to use as the i nterface defaul t l anguage

5. The i nterface l anguage preference can al so be used to

determi ne the l anguage used for the metadata obj ects and report
data, i f the D evel oper l evel l anguage preference i s set to U se
the same language as MicroStrategy D eveloper.For more
i nformati on on the D evel oper l evel l anguage preference, see
Sel ecti ng the D evel oper Level Language Preference, page 1698.

6. Sel ect OK .

7. D i sconnect and reconnect to the proj ect source so that your

changes take effect. To do thi s, ri ght-cl i ck the proj ect source,
sel ect D isconnect from Project Source, then repeat thi s and
sel ect C onnect to Project Source.

1688 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Co n f igu r in g Met ad at a Ob ject an d Rep o r t Dat a Lan gu age

Pr ef er en ces
There are several l evel s at w hi ch metadata and report data l anguages
can be speci fi ed i n Mi croStrategy. Low er l evel l anguages are used by
the system automati cal l y i f a hi gher l evel l anguage i s unavai l abl e.
Thi s ensures that end users see an appropri ate l anguage i n al l
si tuati ons.

Language preferences can be set at si x di fferent l evel s, from hi ghest

pri ori ty to l ow est. The l anguage that i s set at the hi ghest l evel i s the
l anguage that i s al w ays di spl ayed, i f i t i s avai l abl e. If that l anguage
does not exi st or i s not avai l abl e i n the metadata or the data
w arehouse, the next hi ghest l evel l anguage preference i s used.

If a l anguage preference i s not speci fi ed, or i s set to D efaul t,

Mi croStrategy automati cal l y uses the next l ow er pri ori ty l anguage
preference. If none of these l anguage preferences are set, the
i nterface preferred l anguage i s used.

When an obj ect i s created, i ts defaul t obj ect l anguage i s

automati cal l y set to match the creator's metadata l anguage
preference. If the creator has thei r metadata l anguage preference set
to D efaul t, the new obj ect's defaul t l anguage i s deci ded based on the
rul es i n thi s secti on: the system w i l l fi rst try to use a defaul t l anguage
for al l users of the proj ect, then a l anguage preference set for al l
users of D evel oper, then the defaul t l anguage set for the proj ect (as
show n i n the tabl e bel ow ).

The fol l ow i ng tabl e descri bes each l evel , from hi ghest pri ori ty to
l ow est pri ori ty, and poi nts to i nformati on on how to set the l anguage
preference at each l evel .

l End us er preferenc e s ettings ov erride any adminis trator preferenc e

s ettings , if the two s ettings c onflic t.

© 2019, M icr o St r at egy In c. 1689

Syst em Ad m in ist r at io n Gu id e

l Dis tribution Serv ic es deliv eries are one ex c eption to the hierarc hy
below. For details , s ee Sel ecti ng the Machi ne Level Language
Preference, page 1700 .

L an g u ag e
Preferen ce
Settin g L o catio n Settin g L o catio n
L evel (h ig h est Descrip tio n
fo r En d Users fo r Ad min istrato rs
to lo west
p rio rity)

S et in t he User
Web: Preferences Language P ref erence
The language link at t he t op of any Manager. S ee
pref erence f or page. Selecting the U ser-
User-P roject level a user f or a
Developer: From t he Projec t Level
specif ic
Tools menu, select Language
project .
My Preferences . Preferenc e, page
1692 .

Web: Preferences S et in t he User

The language link at t he t op of any E dit or. S ee Selecting
User-A ll P roject s pref erence f or a page. the U ser-All Projects
level user f or all Developer: From t he Level Language
project s. Tools menu, select Preferenc e, page
My Preferences . 1695 .

I n t he P roject
Conf igurat ion E dit or,
expand Languages ,
The language
select U ser
pref erence f or
P roject -A ll Users Preferences . S ee
all users in a Not applicable.
level Selecting the All
specif ic
U sers in Projec t
project .
Level Language
Preferenc e, page
1696 .

Developer level The int erf ace S et in t he Developer S et in t he Developer

1690 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

L an g u ag e
Preferen ce
Settin g L o catio n Settin g L o catio n
L evel (h ig h est Descrip tio n
fo r En d Users fo r Ad min istrato rs
to lo west
p rio rity)

P ref erences dialog

box. For st eps t o P ref erences dialog
language
specif y t his box. For st eps t o
pref erence f or
language, see specif y t his language,
all users of
Selec ting the see Selecting the
Developer on
D ev eloper Lev el D eveloper Level
t hat machine,
Language Language Preference,
f or all project s.
Preferenc e, page page 1698 .
1698 .

On t he user's
machine and wit hin
t he user's browser
The language On t he user's set t ings. For st eps t o
pref erence f or machine and wit hin specif y t his language,
Machine level
all users on a t he user's browser see Selecting the
given machine. set t ings. Machine Level
Language
Preferenc e, page
1700 .

This is t he
S et in t he P roject
project def ault
Conf igurat ion E dit or.
language set
For st eps t o specif y
f or MDI . I t is
P roject Def ault t his language, see
t he language Not applicable.
level C onfiguring the
pref erence f or
Projec t D efault Lev el
all users
Language Preference,
connect ed t o
page 1701 .
t he met adat a.

For exampl e, a user has thei r U ser-Proj ect Level preference for
Proj ect A set to Engl i sh. thei r U ser-Al l Proj ects Level preference i s

© 2019, M icr o St r at egy In c. 1691

Syst em Ad m in ist r at io n Gu id e

set to French. If the user l ogs i n to Proj ect A and runs a report, the
l anguage di spl ayed w i l l be Engl i sh. If the user l ogs i n to Proj ect B,
w hi ch does not have a U ser-Proj ect Level preference speci fi ed, and
runs a report, the proj ect w i l l be di spl ayed i n French. Thi s i s because
there i s no U ser-Proj ect Level preference for Proj ect B, so the system
automati cal l y uses the next, l ow er l anguage preference l evel (U ser-
Al l Proj ects) to determi ne the l anguage to di spl ay.

These l anguage preferences appl y to stri ngs transl ated i n both the
metadata and the data w arehouse. H ow ever, Mi croStrategy handl es
mi ssi ng transl ati ons di fferentl y, dependi ng upon w hether the stri ng i s
transl ated i n the metadata or the data w arehouse:

l Metadata: When a transl ati on for an obj ect i n the metadata i s

mi ssi ng i n the preferred l anguage, the obj ect defaul t l anguage
preference i s used. For more i nformati on about the obj ect defaul t
l anguage preference, see Sel ecti ng the Obj ect D efaul t Language
Preference, page 1703.

l D ata warehouse: When a transl ati on for data i n the data w arehouse
i s mi ssi ng i n the preferred l anguage (the col umn or tabl e i s present
i n the data w arehouse but i s empty), the report returns no data.

The fol l ow i ng secti ons provi de steps to confi gure each preference
l evel , starti ng from the hi ghest pri ori ty and endi ng at the l ow est
pri ori ty.

Selecting the User-Project Level Language Preference

The U ser-Proj ect Level l anguage preference i s the l anguage

preference for a gi ven user for a speci fi ed proj ect. It i s the hi ghest
pri ori ty l anguage setti ng; to see the hi erarchy of l anguage preference
pri ori ti es, see the tabl e i n C onfi guri ng Metadata Obj ect and R eport
D ata Language Preferences, page 1689.

1692 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Thi s preference i s speci fi ed i n the U ser Language Preference

Manager i n D evel oper. U se the steps bel ow to set thi s preference.

If an objec t has an empty trans lation in a us er's c hos en projec t language

preferenc e, the s y s tem defaults to dis play ing the objec t's default
language, s o it is not nec es s ary to add trans lations for objec ts that are
not intended to be trans lated.

Selecting the User-Project Level Language Preference

1. Log i n to D evel oper as a user w i th Admi ni strati ve pri vi l eges.

2. R i ght-cl i ck the proj ect that you w ant to set the l anguage
preference for and sel ect Project C onfiguration.

3. On the l eft si de of the Proj ect C onfi gurati on Edi tor, expand
Languages, and sel ect U ser Preferences.

4. On the ri ght si de, under U ser Language Preference

Manager,cl i ck Modify. The U ser Language Preference Manager
opens, show n bel ow :

© 2019, M icr o St r at egy In c. 1693

Syst em Ad m in ist r at io n Gu id e

5. In the C hoose a project to define user language preferences

drop dow n menu at the top l eft, sel ect the appropri ate proj ect.

6. Sel ect the users from the l i st on the l eft si de of the U ser
Language Preferences Manager that you w ant to change the
U ser-Proj ect l evel l anguage preference for, and cl i ck > to add
them to the l i st on the ri ght. You can narrow the l i st of users
di spl ayed on the l eft by doi ng one of the fol l ow i ng:

l To search for users i n a speci fi c user group, sel ect the group
from the drop-dow n menu that i s under the C hoose a project
to define user language preferences drop-dow n menu.

l To search for users contai ni ng a certai n text stri ng, type the
text stri ng i n the Find fi el d, and cl i ck the fol l ow i ng i con:

Thi s returns a l i st of users matchi ng the text stri ng you typed.

Prev ious s trings y ou hav e ty ped into the Find field c an be

ac c es s ed again by ex panding the Find drop-down menu.

7. On the ri ght si de, sel ect the user(s) that you w ant to change the
U ser-Proj ect l evel preferred l anguage for, and do the fol l ow i ng:

You c an s elec t more than one us er by holding CTRL.

l Sel ect the desi red l anguage to be appl i ed to transl ated

metadata obj ects from the drop-dow n menu i n the Metadata
col umn. Thi s l anguage w i l l be di spl ayed for the sel ected user
(s) w hen connecti ng to the sel ected proj ect.

l Sel ect the desi red l anguage to be appl i ed to report resul ts from
the drop-dow n menu i n the D ata col umn. Thi s l anguage w i l l be

1694 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

di spl ayed for the sel ected user(s) w hen connecti ng to the
sel ected proj ect.

8. C l i ck OK .

Onc e the us er language preferenc es hav e been s av ed, us ers c an

no longer be remov ed from the Selected lis t.

9. C l i ck OK .

10. D i sconnect and reconnect to the proj ect source so that your
changes take effect. To do thi s, ri ght-cl i ck the proj ect source,
sel ect D isconnect from Project Source, then repeat thi s and
sel ect C onnect to Project Source.

Selecting the User-All Projects Level Language Preference

The U ser-Al l Proj ects l evel l anguage preference determi nes w hat
l anguage w i l l be appl i ed to al l proj ects that a speci fi c user sees w hen
connected to a proj ect source, unl ess a hi gher pri ori ty l anguage
preference has been speci fi ed for the user. U se the steps bel ow to set
thi s preference.

If the Us er-Projec t language preferenc e is s pec ified for the us er, the
us er will s ee the Us er-All Projec ts language only if the Us er-Projec t
language is not av ailable. To s ee the hierarc hy of language preferenc e
priorities , s ee the table in C onfi guri ng Metadata Obj ect and R eport
D ata Language Preferences, page 1689 .

Selecting the User-All Projects Level Language Preference

1. Log i n to D evel oper as a user w i th Admi ni strati ve pri vi l eges.

2. In the Fol der Li st on the l eft, w i thi n the appropri ate proj ect
source, expand A dministration, expand U ser Manager, and

© 2019, M icr o St r at egy In c. 1695

Syst em Ad m in ist r at io n Gu id e

navi gate to the user that you w ant to set the l anguage preference
for.

3. D oubl e-cl i ck the user.

4. On the l eft si de of the U ser Edi tor, expand the International

category and sel ect Language.

5. On the ri ght si de of the U ser Edi tor, do the fol l ow i ng, dependi ng
on w hether you have confi gured metadata obj ect transl ati on
(MD I) or data w arehouse transl ati on (D I), or both:

l Sel ect the l anguage that you w ant to be appl i ed to transl ated
metadata stri ngs from the D efault metadata language
preference for this user drop-dow n menu.

l Sel ect the l anguage that you w ant to be appl i ed to transl ated
data w arehouse stri ngs from the D efault data language
preference for this user drop-dow n menu.

6. C l i ck OK .

7. D i sconnect and reconnect to the proj ect source so that your

changes take effect. To do thi s, ri ght-cl i ck the proj ect source,
sel ect D isconnect from Project Source, then repeat thi s and
sel ect C onnect to Project Source.

Selecting the All Users in Project Level Language Preference

The Al l U sers In Proj ect l evel l anguage preference determi nes the
l anguage that w i l l be di spl ayed for al l users that connect to a proj ect,
unl ess a hi gher pri ori ty l anguage i s speci fi ed for the user. U se the
steps bel ow to set thi s preference.

If the Us er-Projec t or Us er-All Projec ts language preferenc es are

s pec ified for the us er, the us er will s ee the All Us ers In Projec t language
only if the other two language preferenc es are not av ailable. To s ee the
hierarc hy of language preferenc e priorities , s ee the table in C onfi guri ng

1696 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Metadata Obj ect and R eport D ata Language Preferences, page

1689 .

Selecting the All Users in Project Level Language Preference

1. Log i n to D evel oper as a user w i th Admi ni strati ve pri vi l eges.

2. In the Fol der Li st on the l eft, sel ect the proj ect. From the
A dministration menu, sel ect Projects, then Project
C onfiguration.

3. On the l eft si de of the Proj ect C onfi gurati on Edi tor, expand
Languages and sel ect U ser Preferences. The Language-U ser
Preferences di al og box i s di spl ayed, as show n bel ow :

4. D o the fol l ow i ng, dependi ng on w hether you have confi gured

metadata obj ect transl ati on (MD I) or data w arehouse transl ati on
(D I), or both:

© 2019, M icr o St r at egy In c. 1697

Syst em Ad m in ist r at io n Gu id e

l From the Metadata language preference for all users in this

project drop-dow n menu, sel ect the l anguage that you w ant to
be di spl ayed for metadata obj ect names i n thi s proj ect.

l From the D ata language preference for all users in this

project drop-dow n menu, sel ect the l anguage that you w ant to
be di spl ayed for report resul ts i n thi s proj ect.

5. C l i ck OK .

6. D i sconnect and reconnect to the proj ect source so that your

changes take effect. To do thi s, ri ght-cl i ck the proj ect source,
sel ect D isconnect from Project Source, then repeat thi s and
sel ect C onnect to Project Source.

Selecting the Developer Level Language Preference

The D evel oper l evel l anguage preference determi nes the defaul t
l anguage for al l obj ects di spl ayed w i thi n D evel oper, unl ess a hi gher
pri ori ty l anguage preference has been speci fi ed. Thi s i s the same as
the i nterface preference.

If the Us er-Projec t, Us er-All Projec ts , or All Us ers In Projec t language

preferenc es are s pec ified, the us er will s ee the Dev eloper language only
if the other three language preferenc es are not av ailable. To s ee the
hierarc hy of language preferenc e priorities , s ee the table in C onfi guri ng
Metadata Obj ect and R eport D ata Language Preferences, page
1689 .

Thi s l anguage preference must be confi gured to match one of tw o

other l anguage preferences: the Interface l anguage preference or the
Machi ne l evel l anguage preference. For i nformati on about the
Interface l anguage preference, see Sel ecti ng the Interface Language
Preference, page 1687. For i nformati on about the Machi ne l evel
l anguage preference, see Sel ecti ng the Machi ne Level Language
Preference, page 1700

1698 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Selecting the Developer Level Language Preference

1. Log i n to D evel oper as a user w i th Admi ni strati ve pri vi l eges.

2. From the Tools menu, sel ect MicroStrategy D eveloper

Preferences.

3. Expand the International category and sel ect Language.The

Internati onal - Language di al og box opens, as show n bel ow :

4. Sel ect one of the fol l ow i ng from the Language for metadata and
warehouse data if user and project level preferences are set
to default drop-dow n menu.

l If you w ant the D evel oper l anguage preference to be the same

as the Interface l anguage preference, sel ect U se the same
language as MicroStrategy D eveloper.For i nformati on about

© 2019, M icr o St r at egy In c. 1699

Syst em Ad m in ist r at io n Gu id e

confi guri ng the Interface l anguage preference, see Selecting

the Interface Language Preference, page 1687.

l If you w ant the D evel oper l anguage preference to be the same

as the Machi ne-l evel l anguage preference, sel ect U se
language from R egional Settings. For i nformati on about
confi guri ng the Machi ne-l evel l anguage preference, see
Selecting the Machine Level Language Preference, page
1700.

5. Sel ect the l anguage that you w ant to use as the defaul t
D evel oper i nterface l anguage from the Interface Language
drop-dow n menu.

6. C l i ck OK .

7. D i sconnect and reconnect to the proj ect source so that your

changes take effect. To do thi s, ri ght-cl i ck the proj ect source,
sel ect D isconnect from Project Source, then repeat thi s and
sel ect C onnect to Project Source.

Selecting the Machine Level Language Preference

Thi s preference determi nes the l anguage that i s used on al l obj ects
on the l ocal machi ne. Mi croStrategy Web uses the l anguage that i s
speci fi ed i n the user's w eb brow ser i f a l anguage i s not speci fi ed at a
l evel hi gher than thi s one.

l If the Us er-Projec t, Us er-All Projec ts , All Us ers In Projec t, or

Dev eloper language preferenc es are s pec ified, the us er will s ee the
Mac hine language only if the other four language preferenc es are not
av ailable. To s ee the hierarc hy of language preferenc e priorities , s ee
the table in C onfi guri ng Metadata Obj ect and R eport D ata
Language Preferences, page 1689 .

1700 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l A Mic roStrategy Dis tribution Serv ic es deliv ery (s uc h as an email, file,

or printer deliv ery ) us es a different language res olution logic : If the
Us er-Projec t, Us er-All Projec ts , All Us ers in Projec t, and Dev eloper
languages are not able to be dis play ed, the deliv ery defaults to the
Projec t Default lev el language preferenc e, followed by the Mac hine
lev el language preferenc e. This is bec aus e Dis tribution Serv ic es runs
without a c lient s es s ion in the Intelligenc e Serv er mac hine; if the
Mac hine lev el language took prec edenc e, all us ers rec eiv ing
deliv ered c ontent would rec eiv e that c ontent us ing the Intelligenc e
Serv er mac hine's language. Ins tead, the projec t's default language is
the fallbac k language for Dis tribution Serv ic es deliv eries .

To sel ect the Machi ne l evel l anguage preference on a Wi ndow s

machi ne, from the Start menu, sel ect C ontrol Panel, then R egional
and Language Options. C onsul t your machi ne's H el p for detai l s on
usi ng the l anguage opti ons.

Configuring the Project Default Level Language Preference

Thi s l anguage preference speci fi es the defaul t l anguage for the

proj ect. Thi s l anguage preference has the l ow est pri ori ty i n
determi ni ng the l anguage di spl ay. U se the steps bel ow to set thi s
preference.

l If the Us er-Projec t, Us er-All Projec ts , All Us ers In Projec t, Dev eloper,

or Mac hine-lev el language preferenc es are s pec ified, the us er will s ee
the Projec t Default language only if the other fiv e language
preferenc es are not av ailable. To s ee the hierarc hy of language
preferenc e priorities , s ee the table in C onfi guri ng Metadata Obj ect
and R eport D ata Language Preferences, page 1689 .

l A Mic roStrategy Dis tribution Serv ic es deliv ery (s uc h as an email, file,

or printer deliv ery ) us es a different language res olution logic : If the
Us er-Projec t, Us er-All Projec ts , All Us ers in Projec t, and Dev eloper
languages are not able to be dis play ed, the deliv ery defaults to the

© 2019, M icr o St r at egy In c. 1701

Syst em Ad m in ist r at io n Gu id e

Projec t Default lev el language preferenc e, followed by the Mac hine

lev el language preferenc e. This is bec aus e Dis tribution Serv ic es runs
without a c lient s es s ion in the Intelligenc e Serv er mac hine; if the
Mac hine lev el language took prec edenc e, all us ers rec eiv ing
deliv ered c ontent would rec eiv e that c ontent us ing the Intelligenc e
Serv er mac hine's language. Ins tead, the projec t's default language is
the fallbac k language for Dis tribution Serv ic es deliv eries .

Selecting the Project Default Language Preference

The projec t default language is s elec ted either when a projec t is firs t
c reated, or the firs t time metadata languages are enabled for the projec t.
It c annot be c hanged after that point. The following s teps as s ume the
projec t default language has not y et been s elec ted.

1. Log i n to the proj ect as a user w i th Admi ni strati ve pri vi l eges.

2. Sel ect the proj ect that you w ant to set the defaul t preferred
l anguage for.

3. From the A dministration menu, sel ect Project, then Project

C onfiguration.

4. On the l eft si de of the Proj ect C onfi gurati on Edi tor, expand
Language. D o one or both of the fol l ow i ng, dependi ng on
w hether you have confi gured metadata obj ect transl ati on (MD I)
or data w arehouse transl ati on (D I), or both:

l To speci fy the defaul t metadata l anguage for the proj ect, sel ect
Metadata from the Language category. Then sel ect D efault for
the desi red l anguage.

l To speci fy the defaul t data l anguage for the proj ect, sel ect
D ata from the Language category. Then sel ect D efault for the
desi red l anguage.

5. Sel ect OK .

1702 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

6. D i sconnect and reconnect to the proj ect source so that your

changes take effect. To do thi s, ri ght-cl i ck the proj ect source,
sel ect D isconnect from Project Source, then repeat thi s and
sel ect C onnect to Project Source.

Select in g t h e Ob ject Def au lt Lan gu age Pr ef er en ce

Each Mi croStrategy obj ect can have i ts ow n defaul t l anguage. The
transl ati on for the obj ect defaul t l anguage i s used w hen the system
cannot fi nd or access a transl ati on for the obj ect i n the l anguage
speci fi ed as the user or proj ect preference.

Thi s preference i s useful especi al l y for personal obj ects, si nce most
personal obj ects are onl y used i n one l anguage, the ow ner's
l anguage. The obj ect defaul t l anguage can be set to any l anguage
supported by the proj ect i n w hi ch the obj ect resi des.

Some obj ects may not have thei r obj ect defaul t l anguage preference
set, for exampl e, i f obj ects are merged from an ol der, non-
i nternati onal i zed Mi croStrategy system i nto an upgraded, ful l y
i nternati onal i zed envi ronment. In thi s case, for those obj ects that do
not have a defaul t l anguage, the system automati cal l y assi gns them
the proj ect's defaul t l anguage.

This is not true for newly c reated objec ts within an internationaliz ed

env ironment. Newly c reated objec ts are automatic ally as s igned the
c reator's metadata language preferenc e. For details on the metadata
language, s ee C onfi guri ng Metadata Obj ect and R eport D ata
Language Preferences, page 1689 .

When dupl i cati ng a proj ect, obj ects i n the source that are set to take
the proj ect defaul t l anguage w i l l take w hatever the desti nati on
proj ect's defaul t l anguage i s.

U se the steps bel ow to confi gure the obj ect defaul t l anguage.

© 2019, M icr o St r at egy In c. 1703

Syst em Ad m in ist r at io n Gu id e

For the hierarc hy of language preferenc es , s ee the table in C onfi guri ng

Metadata Obj ect and R eport D ata Language Preferences, page
1689 .

Configuring the Object Default Language Preference

1. Log i n to the proj ect source that contai ns the obj ect as a user
w i th admi ni strati ve pri vi l eges.

2. R i ght-cl i ck the obj ect and sel ect Properties.

l You can set the defaul t l anguage for mul ti pl e obj ects by
hol di ng the C trl key w hi l e sel ecti ng mul ti pl e obj ects.

3. Sel ect International.The Properti es - Internati onal di al og box i s

di spl ayed, as show n bel ow :

If the International option is mis s ing, the objec t is not s upported for
trans lation. For ex ample, there is no reas on to trans late a table

1704 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

name for a s c hema objec t (s uc h as LU_YEAR), s o this objec t does

not hav e the International option av ailable.

4. From the Select the default language for the object drop-dow n
menu, sel ect the defaul t l anguage for the obj ect(s).

5. C l i ck OK .

Achieving the Correct Language Display

The fol l ow i ng tabl e l i sts many of the l ocati ons w here you mi ght w ant
to di spl ay a gi ven l anguage for users. It tel l s you w here to confi gure
the system so that the l anguage i s di spl ayed or avai l abl e for
sel ecti on. For some l anguage di spl ays, there are di fferent steps i n
D evel oper than i n Mi croStrategy Web.

T ran slatio n o r
L an g u ag e Disp lay th at Wh ere to En ab le It
Yo u Wan t to Ach ieve

I n Developer: Regional set t ings on t he Developer

user's machine.

I n Web: Click t he MicroStrategy > Preferences . Y ou

Number f ormat (decimal, can creat e a dynamic currency f ormat t hat changes

t housands separat or, according t o t he locale's def ault currency symbol. The

currency symbol, weight ) dynamic f ormat applies t o grid report s, graph report s,
and document s displayed in MicroS t rat egy Web,
MicroS t rat egy Mobile, and MicroS t rat egy Of f ice and
export ed t o P DF. For a graph report , t he dynamic
currency is applied t o t he dat a label.

Use a V alue prompt on a met ric. S ee t he Advanced

Currency conversion
Prompts sect ion of t he Adv anced R eporting Guide .

I n Developer: Regional set t ings on t he Developer

Dat e f ormat and separat ors
user's machine.

© 2019, M icr o St r at egy In c. 1705

Syst em Ad m in ist r at io n Gu id e

T ran slatio n o r
L an g u ag e Disp lay th at Wh ere to En ab le It
Yo u Wan t to Ach ieve

I n Web: Go t o MicroStrategy > Preferences >

Languages > Show A dvanced Options .

I n Web, if t he browser is set t o a language

unsupport ed in MicroS t rat egy and t he user's
pref erences are set t o Def ault , t he dat e/ t ime
and number f ormat t ing display in E nglish.

I n Developer, right -click and Format t he at t ribut e or

met ric (column header, value, or subt ot al) using t he
A ut ost yle f ont s t hat support f ont you pref er (on t he Font t ab, specif y t he f ont . )
a given language From t he Grid menu, select Save A utostyle A s and
eit her overwrit e t he exist ing aut ost yle or creat e a new
one.

Font s t hat support all Few f ont s support all languages. One t hat does is
languages A rial Unicode MS , which is licensed f rom Microsof t .

E mbed f ont s when you are designing t he document ;

t his ensures t hat t he f ont s select ed by t he document
designer are used t o display and print t he P DF, even
on machines t hat do not have t he f ont s inst alled.
E mbedding f ont s let s you:

• Use language f ont s ot her t han

P DFs, port able P DFs, S implif ied/ Tradit ional Chinese, E nglish, Japanese,
bookmarks in P DFs, and K orean, and West ern E uropean in P DFs.
language display in a Report
• P rovide a t rue unicode environment , where one
S ervices document
document can cont ain dif f erent languages.

• Creat e port able P DFs t o email and t o publish in

Web.

To embed f ont s, in t he Document E dit or in Developer,

go t o Format > D ocument Properties > Export >
Embed fonts in PD F .

1706 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

T ran slatio n o r
L an g u ag e Disp lay th at Wh ere to En ab le It
Yo u Wan t to Ach ieve

To view embedded f ont s in Developer, t he f ont s must

be inst alled on t he Developer machine and t he
I nt elligence S erver machine.

To view embedded f ont s in Web, t he f ont s must be

inst alled on t he I nt elligence S erver machine.

To display P DF bookmarks wit h t he correct f ont , t he

language pack must be inst alled on t he viewer's
machine. This is t rue f or any language ot her t han
E nglish or West ern E uropean.

The C haracter C olumn Option and N ational

C haracter C olumn Option V LDB propert ies let you
Charact er set s in Teradat a support t he charact er set s used in Teradat a. For
dat abases examples and det ails t o enable t hese propert ies, see
C hapter 1, SQL Generation and D ata Proc essing:
VLD B Properties .

Double-byt e language I n Developer, f rom t he Tools menu, select

support D eveloper Preferences .

I n Web: Click t he MicroStrategy > Preferences .

I n Developer: Go t o Tools > D eveloper

Preferences .
User changing own language
The list of languages t o choose f rom comes f rom t he
languages enabled f or a project ; see Enabling
Metadata Languages for an Exis ting Project, page
1660 .

I n t he User E dit or, expand International , and t hen

select Language .
Def ault language pref erence
f or a part icular user A n administ rat or needs t he Use User E dit or and
Conf igure Language S et t ings privileges, and A CL
permissions t o modif y t he user object .

© 2019, M icr o St r at egy In c. 1707

Syst em Ad m in ist r at io n Gu id e

T ran slatio n o r
L an g u ag e Disp lay th at Wh ere to En ab le It
Yo u Wan t to Ach ieve

Def ault language f or all Right -click a project , select Project C onfiguration >
users in a project Language > U ser Preferences .

Dif f erent def ault language

Right -click a project , select Project C onfiguration >
f or a single user in dif f erent
Language > U ser Preferences .
project s

B y def ault , t he project 's def ault language cannot be

t ranslat ed in t he Object Translat ion E dit or. The f irst
column in t he edit or corresponds t o t he project 's
def ault language.
Translat ing t he project 's
def ault language To t ranslat e t erms in t he def ault language, in t he
Object Translat ion E dit or, click Options at t he t op of
t he E dit or. Move t he def ault language f rom t he
S elect ed V iew Languages box t o t he S elect ed E dit
Languages box.

Funct ion names are not t ranslat ed. The MicroS t rat egy
Funct ion names
syst em expect s f unct ion names t o be in E nglish.

Use t he Object Translat ion E dit or. To access t his,

A n individual object
right -click t he object and select Translat e.

Caches in an
int ernat ionalized S ee C ac hing and Internationalization, page 1652 .
environment

I t is recommended t hat you use a S QL-based DI

model when set t ing up int ernat ionalizat ion, as
described in Prov iding D ata Internationalization,
page 1673 . B ecause a single I nt elligent Cube cannot
I nt elligent Cubes
connect t o more t han one dat a warehouse, using a
connect ion-based DI model requires a separat e
I nt elligent Cube t o be creat ed f or each language,
which can be resource-int ensive.

1708 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

T ran slatio n o r
L an g u ag e Disp lay th at Wh ere to En ab le It
Yo u Wan t to Ach ieve

Det ails on t his cost -benef it analysis, st eps t o enable

a language when publishing an I nt elligent Cube, and
background inf ormat ion on I nt elligent Cubes is in t he
Mic roStrategy In-memory Analytics Guide .

S ubscribed-t o report s and document s behave like

S ubscript ions in an
st andard report s and document s, and are delivered in
int ernat ionalized
t he language select ed in My P ref erences or User
environment
P ref erences.

Reposit ory Translat ion E nable languages t he project support s f or met adat a
Wizard list of available object s (see Enabling Metadata Languages for an
languages Ex is ting Projec t, page 1660 ).

Met adat a object names and

descript ions (such as report For a new project being creat ed, select t hese in
names, met ric names, A rchit ect . Y ou can view t he dat abase t able columns
syst em f older names, used f or int ernat ionalizat ion as you creat e t he project .
embedded descript ors such For an exist ing project , see Enabling Metadata
as at t ribut e aliases, prompt , Languages for an Ex is ting Project, page 1660 .
inst ruct ions, and so on)

Displayed according t o User-P roject level language

Conf igurat ion object s in pref erence. S et t his by right -clicking t he project ,
Developer select ing My Preferences > International , and
set t ing t he Met adat a language f or A ll P roject s.

A t t ribut e element s, f or
First t ranslat e t he element name in your dat a
example, t he P roduct
warehouse. Then enable t he language; see Enabling
at t ribut e has an element
Languages for D ata Internationalization, page 1680 .
called DV D player

I n t he P roject Conf igurat ion E dit or, expand Project

P roject name and D efinition , select General > Modify , >
descript ion International > Translate . Y ou can t ype bot h a
project name and a descript ion in t he Object

© 2019, M icr o St r at egy In c. 1709

Syst em Ad m in ist r at io n Gu id e

T ran slatio n o r
L an g u ag e Disp lay th at Wh ere to En ab le It
Yo u Wan t to Ach ieve

Descript ion f ield.

When designing a project

using A rchit ect , see columns I n A rchit ect , go t o Options > Settings . On t he
in t he Warehouse Tables D isplay Settings t ab, select D isplay columns
area t hat support dat a used for data internationalization .
int ernat ionalizat ion

S ee Enabling Metadata Languages for an Existing

E nable a new language f or a Projec t, page 1660 .
project t o support User adding t he language must have B rowse
permission f or t hat language object 's A CL.

S ee Adding a N ew Language to the System, page

1713 . Then see Enabling Metadata Languages for an
E nable a cust om language Ex is ting Projec t, page 1660 .
f or a project t o support
User adding t he language must have B rowse
permission f or t hat language object 's A CL.

S earches are conduct ed in t he user's pref erred

met adat a language by def ault .
S earching t he project A language-specif ic search can be conduct ed; open a
project , t hen f rom t he Tools menu select Search for
Objects .

Object Manager, P roject Merge, and t he P roject

P roject or object migrat ion, Duplicat ion Wizard cont ain t ranslat ion-specif ic
or duplicat ion conf lict resolut ion opt ions f or migrat ing t ranslat ed
object s bet ween project s.

I n t he Derived E lement E dit or, go t o File >

Derived element s
Properties > International .

MicroS t rat egy Of f ice user This inf ormat ion applies t o MicroS t rat egy
int erf ace and E xcel f ormat Of f ice, t he add-in f or Microsof t Of f ice
languages applicat ions which is no longer act ively

1710 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

T ran slatio n o r
L an g u ag e Disp lay th at Wh ere to En ab le It
Yo u Wan t to Ach ieve

developed.

I t was subst it ut ed wit h a new add-in,

MicroS t rat egy f or Of f ice, which support s Of f ice
365 applicat ions. The init ial version does not yet
have all t he f unct ionalit ies of t he previous
add-in.

For more inf ormat ion, see t he Mic roStrategy for

Offic e page in the 2019 U pdate 1 R eadme and
t he Mic roStrategy for Offic e Online H elp .

I n MicroS t rat egy Of f ice, go t o Options > General >

International .

MicroS t rat egy passes a user's required language as a

MDX (Mult idimensional dat abase connect ion paramet er t o t he MDX cube
E xpressions) dat a sources provider; t he cube provider supplies t he correct
t ranslat ions.

Maintaining Your Internationalized Environment

You can add or remove l anguages from your Mi croStrategy system,
and you can edi t the l anguage obj ects i n the system. You can use
Mi croStrategy C ommand Manager to automate several mai ntenance
tasks. Mi croStrategy Obj ect Manager and Proj ect Merge contai n some
transl ati on-speci fi c opti ons for confl i ct resol uti on rul es.

These mai ntenance processes and tool s are descri bed bel ow . Thi s
secti on al so covers securi ty and speci al i zed transl ator user rol es.

© 2019, M icr o St r at egy In c. 1711

Syst em Ad m in ist r at io n Gu id e

Using Command Manager to Automate Language

Maintenance Tasks
Several C ommand Manager scri pts are desi gned to make l anguage
mai ntenance and user mai ntenance rel ated to i nternati onal i zed
envi ronments easi er and faster. These scri pts i ncl ude:

l Li st al l l anguages (metadata or data) by proj ect, or al l l anguages

contai ned under Admi ni strati on > C onfi gurati on Managers >
Languages i n D evel oper's Fol der Li st.

l Li st avai l abl e l anguages (metadata or data) at a speci fi ed l evel ,

such as by user/proj ect, or by user and proj ect.

l Li st resol ved l anguages, w hi ch are the l anguages that are

di spl ayed to users from among the l i st of possi bl e preferences.

l Al ter l anguages at a speci fi ed l evel , w hi ch changes l anguage

preferences for a set of users or for a proj ect.

For these and al l the other scri pts you can use i n C ommand Manager,
open C ommand Manager and cl i ck H elp.

Moving Translated Objects Between Projects

You can use Obj ect Manager and Proj ect Merge to mi grate transl ated
obj ects betw een proj ects. You appl y the same Mi croStrategy confl i ct
resol uti on rul es as you use w hen mergi ng non-transl ated obj ects, but
you use these rul es speci fi cal l y for the transl ated names and
descri pti ons that are part of each transl ated obj ect. You can al so
merge transl ati ons even i f obj ects are i denti cal . For detai l s on al l the
opti ons for mi grati ng transl ated obj ects usi ng Obj ect Manager or
Proj ect Merge, open Obj ect Manager or Proj ect Merge and cl i ck H elp.

Adding or Removing a Language in the System

You can add or remove l anguages and l anguage vari ants from the
system usi ng the steps bel ow .

1712 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Supporting Character Sets

Languages requi re a w i de range of character sets to represent data.

To support the l anguages you pl an to use i n your Mi croStrategy
proj ects, you must use databases that support the requi red character
sets and that are confi gured accordi ngl y. To determi ne w hether your
database supports the character sets requi red to di spl ay the
l anguages you w ant to support, see your thi rd-party database
documentati on.

Speci fi cal l y, the database that al l ocates the metadata must be set
w i th a code page that supports the l anguages that are i ntended to be
used i n your Mi croStrategy proj ect.

Ad d in g a New Lan gu age t o t h e Syst em

You can add new l anguages to Mi croStrategy. Once they are added,
new l anguages are then avai l abl e to be enabl ed for a proj ect to
support i nternati onal i zati on.

Vari ant l anguages (al so cal l ed custom l anguages) can al so be added.

For exampl e, you can create a new l anguage cal l ed Accounti ng,
based on the Engl i sh l anguage, for al l users i n your Accounti ng
department. The l anguage contai ns i ts ow n w ork-speci fi c termi nol ogy.

You mus t hav e the Brows e permis s ion for the language objec t's ACL
(ac c es s c ontrol lis t).

To Add a New Language to the System

1. Log i n to a proj ect as a user w i th admi ni strati ve pri vi l eges.

2. R i ght-cl i ck the proj ect and sel ect Project C onfiguration.

3. On the l eft si de of the Proj ect C onfi gurati on Edi tor, expand
Language, then sel ect ei ther Metadata or D ata, dependi ng on

© 2019, M icr o St r at egy In c. 1713

Syst em Ad m in ist r at io n Gu id e

w hether you w ant to add the l anguage to support metadata

obj ects or to support data i nternati onal i zati on. For a descri pti on
of the di fferences, see About Internati onal i zati on, page 1650.

4. C l i ck A dd.

5. C l i ck N ew.

6. C l i ck OK .

7. If the l anguage you added to the system i s certi fi ed by

Mi croStrategy, you are prompted to automati cal l y update system
obj ect transl ati ons that come w i th Mi croStrategy. The i nformati on
that i s automati cal l y updated i ncl udes transl ati ons of the
fol l ow i ng:

l System fol ders: The Publ i c Obj ects fol der and the Schema
Obj ects fol der

l Proj ect obj ects: Autostyl es and obj ect templ ates

l System confi gurati on obj ects: Securi ty rol es and user groups

8. C l i ck Yes. You can al so perform thi s update l ater, usi ng the

Proj ect C onfi gurati on Edi tor, and sel ecti ng U pgrade i n the
Proj ect D efi ni ti on category.

9. D i sconnect and reconnect to the proj ect source so that your

changes take effect. To do thi s, ri ght-cl i ck the proj ect source,
sel ect D isconnect from Project Source, then repeat thi s and
sel ect C onnect to Project Source.

Languages can al so be added usi ng the Languages C onfi gurati on

Manager, by goi ng to A dministration > C onfiguration Managers >
Language.

After addi ng a new l anguage, i f you use transl ator rol es, be sure to
create a new user group for transl ators of the new l anguage (see
C reati ng Transl ator R ol es, page 1719).

1714 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To Add a New Interface Language for MicroStrategy Web Users

This proc edure prov ides high-lev el s teps for adding a new language to
the dis play of languages in Mic roStrategy Web. After the new language
is added, Web us ers c an s elec t this language for dis play ing v arious
as pec ts of Web in the new language. For details and bes t prac tic es to
c us tomiz e y our Mic roStrategy Web files , s ee the Mic roStrategy
Dev eloper Library (MSDL), whic h is part of the Mic roStrategy SDK.

1. In the l ocal es.xml fi l e (l ocated by defaul t i n <appl i cati on-root-

path>/WEB-IN F/xml ), add a new l i ne for the l anguage key usi ng
the exampl e bel ow :

2. <l ocal e l ocal e-i d=" 13313" l anguage="H I" country="Ind"

desc="H i ndi " desc-i d="mstrWeb.5097" char-set="U TF-8" char-
set-excel ="U ni codeLi ttl e" codepage="65001" codepage-excel -
"1252"/>

3. C reate resource fi l es for the new l anguage, for generi c

descri ptors, based on exi sti ng resource fi l es. For exampl e:

l For Web messages: Messages_Bundl e_H I.properti es

l For number and date formats i n the i nterface: Format_C onfi g_

H I.xml

4. If you w ant to di spl ay feature-speci fi c descri ptors for the new

l anguage, you can create resource fi l es based on exi sti ng
resource fi l es. For exampl e:

l D ossi erD atesBundl e_13313.xml

l D ossi erVi ew erBundl e_13313.xml

© 2019, M icr o St r at egy In c. 1715

Syst em Ad m in ist r at io n Gu id e

Creating a Language Variant: Multi-Tenancy

A l anguage vari ant i s a l anguage that i s si mi l ar to a standard

l anguage, because the vari ant i s based on the standard l anguage. A
vari ant can be created for a speci fi c purpose i n an organi zati on, for
exampl e, Executi ve Busi ness Engl i sh.

Mul ti -tenancy i s provi di ng numerous groups of users access to the

same Mi croStrategy envi ronment, but changi ng the di spl ay of obj ects
and obj ect names or descri pti ons based on vari ous confi gurati on
setti ngs. For more i nformati on on mul ti -tenancy, see Mul ti -Tenant
Envi ronments: Obj ect N ame Personal i zati on, page 1762.

Remo vin g a Lan gu age f r o m t h e Syst em

A l anguage cannot be removed from the system i f i t i s bei ng used by
a proj ect, that i s, i f i t has been enabl ed to be supported for a proj ect.
To remove a l anguage from a proj ect, that l anguage must fi rst be
di sabl ed from the proj ect, as descri bed i n the steps bel ow .

If a us er has s elec ted the language as a language preferenc e, the

preferenc e will no longer be in effec t onc e the language is dis abled. The
nex t lower priority language preferenc e will tak e effec t. To s ee the
language preferenc e priority hierarc hy , s ee C onfi guri ng Metadata
Obj ect and R eport D ata Language Preferences, page 1689 .

To Remove a Language from the System

1. D i sabl e the l anguage from al l proj ects i n w hi ch i t w as enabl ed:

l To di sabl e a metadata l anguage from a proj ect, see Enabl i ng

and D i sabl i ng Metadata Languages, page 1659.

l To di sabl e a data l anguage from the proj ect, see Enabl i ng

Languages for D ata Internati onal i zati on, page 1680.

1716 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

2. For metadata l anguages, any transl ati ons for the di sabl ed
l anguage are not removed from the metadata w i th these steps.
To remove transl ati ons:

l For i ndi vi dual obj ects: Obj ects that contai n transl ati ons i n the
di sabl ed l anguage must be modi fi ed and saved. You can use
the Search di al og box from the Tools menu i n D evel oper to
l ocate obj ects that have transl ati ons i n a gi ven l anguage.

l For the enti re metadata: D upl i cate the proj ect after the
l anguage has been removed, and do not i ncl ude the transl ated
stri ngs i n the dupl i cated proj ect.

3. For obj ects that had the di sabl ed l anguage as thei r defaul t
l anguage, the fol l ow i ng scenari os occur. The scenari os assume
the proj ect defaul ts to Engl i sh, and the French l anguage i s
di sabl ed for the proj ect:

l If the obj ect's defaul t l anguage i s French, and the obj ect
contai ns both Engl i sh and French transl ati ons, then, after
French i s di sabl ed from the proj ect, the obj ect w i l l onl y di spl ay
the Engl i sh transl ati on. The obj ect's defaul t l anguage
automati cal l y changes to Engl i sh.

l If the obj ect's defaul t l anguage i s French and the obj ect
contai ns onl y French transl ati ons, then, after French i s
di sabl ed from the proj ect, the French transl ati on w i l l be
di spl ayed but w i l l be treated by the system as i f i t w ere
Engl i sh. The obj ect's defaul t l anguage automati cal l y changes
to Engl i sh.

For both scenari os above: If you l ater re-enabl e French for the
proj ect, the obj ect's defaul t l anguage automati cal l y changes
back to French as l ong as no changes w ere made and saved
for the obj ect w hi l e the obj ect had Engl i sh as i ts defaul t
l anguage. If changes w ere made and saved to the obj ect w hi l e
i t had Engl i sh as i ts defaul t l anguage, and you w ant to return

© 2019, M icr o St r at egy In c. 1717

Syst em Ad m in ist r at io n Gu id e

the obj ect's defaul t l anguage back to French, you can do so

manual l y: ri ght-cl i ck the obj ect, sel ect Properties, sel ect
Internationalization on the l eft, and choose a new defaul t
l anguage.

Applying Security and Specialized Translator User Roles

for Languages
Each l anguage i n Mi croStrategy i s represented by a speci fi c
Mi croStrategy obj ect. You can appl y securi ty to a l anguage i n
Mi croStrategy by usi ng the l anguage obj ect's AC Ls, w hi ch permi t or
deny speci fi c use of an obj ect.

You al so use the l anguage obj ect's AC Ls i n combi nati on w i th

Mi croStrategy user pri vi l eges to create a transl ator or l i ngui st rol e.
Thi s type of rol e al l ow s a user to transl ate terms for an obj ect i n a
gi ven l anguage, but keeps that user from maki ng changes to the
obj ect's transl ati ons i n other l anguages or maki ng changes to the
obj ect's name and descri pti on i n the obj ect's defaul t l anguage.

Main t ain in g Lan gu age Ob ject s an d Co n t r o llin g Secu r it y

Each l anguage that i s part of your Mi croStrategy system (w hether out
of the box or l anguages you have added) exi sts as an obj ect that can
be edi ted, can have AC Ls (securi ty) set on i t, can have i ts name
transl ated, and so on.

AC Ls can be used on a l anguage obj ect to control user access to

certai n l anguages. You can take advantage of thi s feature to al l ow
users to serve themsel ves i n terms of choosi ng l anguage preferences,
w hi l e restri cti ng them from l anguages that may not be supported for
areas of the softw are the user commonl y uses.

For exampl e, you can create 2 groups of users and provi de Group 1
w i th brow se and use access to the Engl i sh l anguage obj ect and the
French l anguage obj ect, and provi de Group 2 w i th brow se and use

1718 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

access to Spani sh onl y. In thi s scenari o, users i n Group 2 can onl y

choose Spani sh as thei r l anguage preference, and can onl y access
Spani sh data from your w arehouse. If an obj ect w hi ch i s otherw i se
avai l abl e to Group 2 users does not have a Spani sh transl ati on,
Group 2 users w i l l be abl e to access that obj ect i n the proj ect's
defaul t l anguage (w hi ch may be Engl i sh, French, or any other
l anguage.)

To Access a Language Object

1. In D evel oper, from the Fol der Li st on the l eft, w i thi n the
appropri ate proj ect source, go to A dministration >
C onfiguration Managers.

2. Sel ect Languages.

3. R i ght-cl i ck any l anguage obj ect to edi t or otherw i se mai ntai n that
obj ect.

Cr eat in g Tr an slat o r Ro les

You can set up Mi croStrategy so that certai n users can transl ate
obj ect names and descri pti ons i nto a gi ven l anguage. At the same
ti me, you can restri ct these users from changi ng the obj ect's
transl ati ons i n l anguages other than the one they are transl ati ng, and
from maki ng any other changes to the obj ect.

When an objec t is trans lated or an ex is ting trans lation is edited, the

objec t's v ers ion ID and modific ation times tamp are c hanged. This
allows y ou to eas ily identify the lates t trans lated objec ts when merging
objec ts ac ros s projec ts or env ironments .

C reati ng a transl ator or l i ngui st rol e can be useful i f you have a

transl ator w ho needs access to an obj ect to transl ate i t, but w ho
shoul d not have the abi l i ty to make any other changes to the obj ect.

© 2019, M icr o St r at egy In c. 1719

Syst em Ad m in ist r at io n Gu id e

A common approach to setti ng up the Mi croStrategy envi ronment to

support thi s type of user rol e requi res creati ng a Mi croStrategy user
account speci fi cal l y for each transl ator, al l ow i ng certai n pri vi l eges to
that user, and setti ng AC Ls on one or more l anguage obj ects to al l ow
access to a gi ven l anguage for transl ati on purposes. The steps bel ow
provi de a common approach to setti ng up your system to support
transl ator rol es. The end goal i s to create a l i st of user accounts made
up of transl ators w ho have a l i mi ted set of permi ssi ons i n
Mi croStrategy to transl ate a proj ect's obj ects (schema obj ects,
appl i cati on obj ects, report/document obj ects), w i thout the abi l i ty to
w ri te to any obj ect or make changes to an obj ect.

You can modi fy thi s approach to customi ze your l anguage obj ect
securi ty as i t fi ts your speci fi c needs. Suggesti ons are provi ded after
the steps, to modi fy the transl ator rol e setup for speci fi c si tuati ons.

The fol l ow i ng terms are used:

l Source l anguage: The obj ect's defaul t l anguage

l R eference l anguage: Any l anguage other than the source l anguage

w hi ch the transl ator needs to transl ate from

l Target l anguage: Any l anguage other than the source l anguage

w hi ch the transl ator needs to transl ate to

To Create a Translator Role

Cr eat e a U ser Account f or Each Tr ansl at or

1. C reate a user account for each transl ator.

l Grant each user the U se D evel oper pri vi l ege, i n the Anal yst
pri vi l ege group.

l Grant each user the U se Transl ati on Edi tor pri vi l ege, i n the
C ommon pri vi l ege group.

1720 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Grant each user the U se Transl ati on Edi tor Bypass pri vi l ege,
i n the D evel oper pri vi l ege group.

Thi s pri vi l ege al l ow s the user to use the Transl ati on Edi tor to
change an obj ect's name and/or descri pti on for a gi ven
l anguage, and does not requi re the user to have Wri te access
to the obj ect w hose name/descri pti on i s bei ng changed (the
system bypasses the normal check for Wri te access).

For steps on creati ng a user account and assi gni ng pri vi l eges to a
user account, see the Setti ng U p U ser Securi ty secti on.

Al l ow Each Tr ansl at or U ser t o Ad d / Ed i t Tr ansl at i ons f or a Gi ven

Language

1. Grant the Vi ew permi ssi on on the AC L (access control l i st) for a

l anguage obj ect to the user account that i s al l ow ed to transl ate
obj ects i nto that l anguage. Thi s permi ssi on shoul d be granted to
the target l anguage. The Vi ew permi ssi on al l ow s a user to:

l See an obj ect's name and descri pti on i n the source l anguage
(the obj ect's defaul t l anguage) as w el l as i n al l other
l anguages.

l Transl ate obj ect names and descri pti ons i n the l anguage the
user has Vi ew permi ssi on for.

To grant the Vi ew permi ssi on for a l anguage obj ect, use the
fol l ow i ng substeps:

1. In the Fol der Li st, w i thi n the appropri ate proj ect source,
expand A dministration, then C onfiguration Managers,
and sel ect Languages.

2. R i ght-cl i ck a l anguage from the l i st of l anguage obj ects,

and sel ect Properties.

© 2019, M icr o St r at egy In c. 1721

Syst em Ad m in ist r at io n Gu id e

3. On the l eft, sel ect Security.

4. On the ri ght, cl i ck A dd to add the appropri ate user

account to the securi ty for thi s l anguage. N avi gate to the
appropri ate transl ator user, sel ect the user, and cl i ck OK .

5. C l i ck the fi el d i n the Permi ssi ons col umn next to the

new l y added user and sel ect View.

A us er who has View permis s ions to a language will be able

to add or modify trans lations in that language us ing the
Trans lation Editor. Trans lating an objec t's
name/des c ription in the s ourc e language (the objec t's
default language) is equiv alent to renaming the objec t. This
may not be des irable, es pec ially for s c hema objec ts . To
prev ent this , be s ure that the View permis s ion is not
granted to the s ourc e language (the default language) of the
objec ts that will be trans lated.

Al l ow Tr ansl at or s t o Vi ew Tr ansl at i ons i n Sp eci f i c Ref er ence

Languages

1. Grant read-onl y access to one or more reference l anguages by

granti ng the Brow se and R ead permi ssi ons (AC L permi ssi ons on
the l anguage obj ect) for those l anguages that the transl ator
needs to be abl e to vi ew . Granti ng Brow se and R ead permi ssi on
to a user for a l anguage al l ow s the transl ator to be abl e to see
obj ect names and descri pti ons i n that l anguage, but not to
transl ate or otherw i se make changes to obj ect
names/descri pti ons i n that l anguage. R ead-onl y permi ssi on i s
general l y granted to the source l anguage (the obj ect's defaul t
l anguage), so that the source l anguage can be used as the
reference l anguage duri ng transl ati on.

1722 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Allowing trans lators to s ee trans lations for an objec t in a language

other than jus t the s ourc e language c an prov ide trans lators us eful
c ontex t during trans lation, and is nec es s ary if a trans lator needs to
s ee a referenc e language that is different from the s ourc e
language.

U se the fol l ow i ng substeps:

1. In the Fol der Li st, w i thi n the appropri ate proj ect source, go
to A dministration > C onfiguration Managers >
Languages.

2. R i ght-cl i ck a l anguage from the l i st of l anguage obj ects, and

sel ect Properties.

3. On the l eft, sel ect Security.

4. On the ri ght, cl i ck A dd to add the appropri ate user account

to the securi ty for thi s l anguage. N avi gate to the appropri ate
transl ator user, sel ect the user, and cl i ck C ustom.

5. C l i ck the fi el d i n the Permi ssi ons col umn next to the new l y
added user and sel ect B rowse and R ead.

Be s ure y ou do not grant the Us e permis s ion on any language

objec t that repres ents a language y ou do not want the
trans lator to be able to mak e c hanges to.

2. R epeat these substeps for any other l anguages i n the l i st of

l anguage obj ects that you w ant thi s user to be abl e to see.

To deny a trans lator the ability to s ee an objec t's name and

des c ription in a giv en language, as s ign the us er the Deny All
priv ilege for the language objec t(s ) that the us er s hould not be able
to s ee or add/edit trans lations for.

© 2019, M icr o St r at egy In c. 1723

Syst em Ad m in ist r at io n Gu id e

Minimum Requirements and Additional Options for Creating a

Translator Role

l The fol l ow i ng tabl e show s the mi ni mum pri vi l eges and permi ssi ons
that a user needs to be abl e to vi ew a l anguage and to transl ate
schema obj ects, appl i cati on obj ects, and report/document obj ects i n
a Mi croStrategy proj ect:

T o View an Ob ject's Name an d T o T ran slate an Ob ject's Name an d

Descrip tio n in a Given L an g u ag e Descrip tio n in a Given L an g u ag e

The Use Developer privilege, in t he The Use Developer privilege, in t he

A nalyst privilege group. A nalyst privilege group.

The Use Translat ion E dit or privilege, in

t he Common privilege group.
The Use Translat ion E dit or privilege, in
t he Common privilege group. The Use Translat ion E dit or B ypass
privilege, in t he Developer privilege
group.

The B rowse permission on t he language The B rowse permission on t he language

object t hat t he t ranslat or will be object t hat t he t ranslat or will be
t ranslat ing int o, and on a ref erence t ranslat ing int o, and on a ref erence
language object . language object .

The Read permission on t he language

object t hat t he t ranslat or will be
The Read permission on t he language t ranslat ing int o, and on a ref erence
object t hat t he t ranslat or will be language object .
t ranslat ing int o, and on a ref erence
language object . The Use permission on t he language
object t hat t he t ranslat or will be
t ranslat ing int o.

Be s ure y ou do not grant the Us e permis s ion on any language objec t that
repres ents a language y ou do not want the trans lator to be able to mak e
c hanges to.

1724 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l To provi de a transl ator the greatest possi bl e context for obj ects:

l Al l ow the transl ator user to see an obj ect's name and defi ni ti on i n
the source l anguage and i n any other l anguage that the obj ect
uses, as w el l as the transl ator's target l anguage. To do thi s, grant
the transl ator user the Brow se and R ead permi ssi ons for each
l anguage obj ect l i sted i n A dministration > C onfiguration
Managers > Languages. The Brow se and R ead permi ssi ons
al l ow the user to see transl ati ons i n the Transl ati on Edi tor but not
edi t the transl ati on stri ngs.

l Grant the user pri vi l eges to access the obj ect w i thi n the vari ous
D evel oper obj ect edi tors. These pri vi l eges al l ow the user to
execute the obj ect so that i t opens w i thi n i ts appropri ate edi tor,
thus di spl ayi ng addi ti onal detai l about the obj ect. Access can
al l ow context such as seei ng a stri ng as i t appears w i thi n a
dossi er; a metri c's expressi on/formul a; an attri bute's forms and
the data w arehouse tabl es that the data comes from; and so on.
For exampl e, i n the U ser Edi tor, grant the transl ator the Execute
D ocument and U se R eport Edi tor pri vi l eges from the Anal yst
pri vi l ege group. Al so grant U se C ustom Group Edi tor, U se Metri c
Edi tor, U se Fi l ter Edi tor, and so on, from the D evel oper pri vi l ege
group.

l To deny a transl ator the abi l i ty to see an obj ect's name and
descri pti on i n any l anguage except the source l anguage and the
l anguage that the transl ator has permi ssi on to Brow se, R ead, and
U se, grant the user the D eny Al l pri vi l ege for the l anguage obj ects
that the user shoul d not be abl e to see.

For exampl e, i f you grant a transl ator Brow se, R ead, and U se
permi ssi ons for the French l anguage obj ect, Brow se and R ead
permi ssi ons for the obj ect's defaul t l anguage, and D eny Al l for al l
other l anguages, the transl ator w i l l onl y see the French transl ati ons

© 2019, M icr o St r at egy In c. 1725

Syst em Ad m in ist r at io n Gu id e

col umn and the defaul t l anguage col umn i n the Transl ati ons Edi tor
i n D evel oper.

H ow ever, be aw are that thi s l i mi ts the transl ator to onl y bei ng abl e
to use the obj ect's defaul t l anguage as thei r reference l anguage. If
the transl ator can benefi t from seei ng context i n other l anguages, i t
i s not recommended to D eny Al l for other l anguages.

l You can create a securi ty rol e to support per-proj ect transl ator
access. A securi ty rol e i s a set of proj ect-l evel pri vi l eges. You can
then assi gn the securi ty rol e to i ndi vi dual users or groups. A user
can have di fferent securi ty rol es i n di fferent proj ects. For exampl e,
a user may have a Transl ator securi ty rol e for the proj ect they are
supposed to transl ate, but the normal U ser securi ty rol e i n al l other
proj ects. Securi ty rol es are assi gned to users or groups on a
proj ect-by-proj ect basi s.

Bec aus e s ec urity roles are projec t-lev el roles , s etting up trans lation
bas ed on s ec urity roles does not allow for the trans lation of
c onfiguration objec ts , s uc h as databas e ins tanc es , s c hedules ,
ev ents , and any other objec t that ex is ts at the projec t s ourc e lev el. A
trans lator c an be s et up to trans late c onfiguration objec ts us ing the
information in the nex t bullet.

l To al l ow a transl ator to transl ate confi gurati on obj ects (such as user
and group descri pti ons, database i nstance names and descri pti ons,
schedul e and event names and descri pti ons, and any other obj ects
that can be accessed by al l proj ects i n a proj ect source), grant the
transl ator the U se Transl ati on Edi tor Bypass pri vi l ege at the user
l evel (rather than at the proj ect l evel ). Al so, grant the transl ator user
the fol l ow i ng pri vi l eges i n the U ser Edi tor, w hi ch al l ow the user to
access the vari ous confi gurati on obj ect managers i n the
Admi ni strati on fol der i n D evel oper:

1726 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l C reate and edi t database i nstances

l C reate and edi t database l ogi ns

l C reate and edi t schedul es and events

l C reate and edi t securi ty fi l ters

l C reate and edi t securi ty rol es

l C reate and edi t users and groups

l C reate confi gurati on obj ects

l To al l ow users to transl ate obj ects usi ng Mi croStrategy's bul k

transl ati on tool , the R eposi tory Transl ati on Wi zard, grant the user
the U se R eposi tory Transl ati on Wi zard pri vi l ege.

If this priv ilege is as s igned, be aware that the us er will be able to

ex port s trings and import trans lations for thos e s trings in all
languages that the projec t s upports . This is true no matter what other
language res tric tions are applied.

© 2019, M icr o St r at egy In c. 1727

 3
L IST OF PRIVILEGES

© 2019, M icr o St r at egy In c. 1728

Syst em Ad m in ist r at io n Gu id e

Thi s secti on provi des reference i nformati on for pri vi l eges i n

Mi croStrategy. For general i nformati on about usi ng pri vi l eges and
securi ty rol es, see the Setti ng U p U ser Securi ty secti on.

Pri vi l eges are avai l abl e to be assi gned to users, groups, or securi ty
rol es. A pri vi l ege i s avai l abl e i f i t i s enabl ed i n the U ser Edi tor. If you
have not purchased a l i cense for a product, that product's pri vi l eges
are grayed out i n both the U ser Edi tor and the Securi ty R ol e edi tor.
To determi ne your l i cense i nformati on, use Li cense Manager to check
w hether any of the speci fi ed products are avai l abl e.

A pri vi l ege w i th the note "Server l evel onl y" can be granted onl y at
the proj ect source l evel . It cannot be granted for a speci fi c proj ect.

Thi s secti on i ncl udes the fol l ow i ng:

Privileges for Predefined Security Roles

The Mi croStrategy product sui te contai ns a number of predefi ned
securi ty rol es for admi ni strators. These rol es makes i t easy to
del egate admi ni strati ve tasks.

The predefi ned proj ect admi ni strati on rol es appl y proj ect-l evel
admi ni strati ve pri vi l eges. The defaul t pri vi l eges that are automati cal l y
granted for these out-of-the-box securi ty rol es are l i sted bel ow .

Power U sers have the fol l ow i ng pri vi l eges:

Po wer Users

• S chedule Request (in Common

P rivileges) • Creat e and edit securit y f ilt ers

• A ssign securit y roles • E dit project st at us

• B ypass all object securit y access • Web administ rat ion

checks

1729 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Project B ulk A dministrators have the fol l ow i ng Obj ect Manager

pri vi l eges:

Pro ject Bu lk Ad min istrato rs

• Use Object Manager • Use Reposit ory Translat ion Wizard

Project Operations A dministrators have the fol l ow i ng pri vi l eges:

Pro ject Op eratio n s Ad min istrato rs

• S chedule Request (in Common

• A dminist er S ubscript ions
P rivileges)
• A dminist er User Connect ions
• A dminist er Caches
• I dle A nd Resume P roject
• A dminist er Cubes
• Load A nd Unload P roject
• A dminist er Jobs

Project Operations Monitors have the fol l ow i ng pri vi l eges:

Pro ject Op eratio n s Mo n ito rs

• A dminist er Caches • Monit or Cubes

• A dminist er Jobs • Monit or Hist ory List s

• A dminist er User Connect ions • Monit or Jobs

• A udit Change Journal • Monit or P roject s

• I dle A nd Resume P roject • Monit or S ubscript ions

• Load and Unload project • Monit or User Connect ions

• Monit or Caches • Monit or Quick S earch I ndices

Project R esource Settings A dministrators have the fol l ow i ng

pri vi l eges:

© 2019, M icr o St r at egy In c. 1730

Syst em Ad m in ist r at io n Gu id e

Pro ject Reso u rce Settin g s Ad min istrato rs

• Conf igure Caches

• Conf igure S t at ist ics
• Conf igure Governing
• Conf igure S ubscript ion S et t ings
• Conf igure Language S et t ings
• E dit P roject S t at us
• Conf igure P roject B asic
• Web A dminist rat ion
• Conf igure P roject Dat a S ource

Project Security A dministrators have the fol l ow i ng pri vi l eges:

Pro ject Secu rity Ad min istrato rs

• Creat e A pplicat ion Object s (S erver -

 I nt elligence) • Conf igure Connect ion Map
• A ssign S ecurit y Filt ers • Conf igure S ecurit y S et t ings
• A ssign S ecurit y Roles • Creat e A nd E dit S ecurit y Filt ers
• Conf igure Change Journing

Privileges for Out-Of-The-Box User Groups

The pri vi l eges that are automati cal l y granted for out-of-the-box groups
are l i sted bel ow .

l All us ers are members of the Everyone group and inherit all
priv ileges granted to that group.

l Ins talling the Mic roStrategy Tutorial may c hange the default priv ileges
granted for s ome of thes e groups .

The fol l ow i ng Mi croStrategy user groups have no defaul t pri vi l eges:

1731 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l 3rd Party U sers

l LD AP Publ i c/Guest

l LD AP U sers

l Publ i c/Guest

l Warehouse U sers

The fol l ow i ng are predefi ned Mi croStrategy user groups:

l API

l Archi tect

l C ol l aborati on Server

l D esktop

l D i stri buti on Server

l Mobi l e

l R eporter

l Second Factor Exempt

l System Moni tor

l N arrow case System Admi ni strators

l Server Bul k Admi ni strators

l Server C onfi gurati on Admi ni strators

l Server Operati ons Admi ni strators

l Server Operati on Moni tors

l Server R esource Setti ngs Admi ni strators

l Server Securi ty Admi ni strators

© 2019, M icr o St r at egy In c. 1732

Syst em Ad m in ist r at io n Gu id e

l System Admi ni strators

l U ser Admi ni strators

l Transacti on Server

l Web

The fol l ow i ng are l egacy predefi ned groups:

l Mi croStrategy Archi tect

l Mi croStrategy D esktop Anal yst

l Mi croStrategy D esktop D esi gner

l Mi croStrategy D esktop U sers

l Mi croStrategy Web R eporter

l Mi croStrategy Web Anal yst

l Mi croStrategy Web Professi onal

Privileges for the Everyone Group

By defaul t the Everyone group does not grant any pri vi l eges.

When a projec t is upgraded from Mic roStrategy v ers ion 7.2.x or 7.5.x to
v ers ion 9.0 or later, the Us e Dev eloper priv ilege in the Client-Arc hitec t
priv ilege group is automatic ally granted to the Ev ery one group. This
ens ures that all us ers who were able to ac c es s Dev eloper in prev ious
v ers ions c an c ontinue to do s o.

Client - Architect Privileges

These pri vi l eges correspond to the functi onal i ty avai l abl e to
Mi croStrategy 2019 Archi tect product users, that i s, proj ect desi gners.
The predefi ned Mi croStrategy Archi tect group i s assi gned these
pri vi l eges by defaul t. Li cense Manager counts any user w ho has any
of these pri vi l eges as an Archi tect user.

1733 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

See the drop-dow n bel ow to vi ew the Archi tect pri vi l eges avai l abl e i n
Mi croStrategy 10.x.

Privileg e Allo ws th e u ser to ...

A lias object s Rename object s

Modif y schema object s wit hout having t he necessary

permissions f or each object . For example, users wit h
t his can updat e t he schema or use t he Warehouse
B ypass schema object s Cat alog B rowser wit hout having administ rat or
securit y access checks privileges.

Writ e permission f or t he f older cont aining t he schema

object s may also be required and is not grant ed by t his
privilege.

Change some charact erist ics of page appearance and

Change user pref erence
report result s

Conf igure t oolbars Use, show, and hide t oolbars

Creat e dat aset in

Creat e a dat aset in Workst at ion
Workst at ion

Creat e HTML cont ainer Creat e HTML cont ainer object s in a document

Def ine MDX Cube Report Def ine a new report t hat accesses an MDX cube

Use links t o view relat ed dat a not shown in t he original

Drill and link
report result s

E xecut e Document E xecut e a Report S ervices document s in Developer

Format graph Modif y a graph’s f ormat using a t oolbar or gallery

I mport f unct ion Use t he Funct ion P lug-in E dit or

I mport MDX cube I mport an MDX cube

Modif y Report subt ot als Change or creat e subt ot als on a report

Modif y sort ing Change a report ’s sort ing

Modif y t he list of Report Use t he Object B rowser when viewing a report in V iew

© 2019, M icr o St r at egy In c. 1734

Syst em Ad m in ist r at io n Gu id e

Privileg e Allo ws th e u ser to ...

or Design Mode

This det ermines whet her t he user is a report designer

or a report creat or. A report designer is a user who can
object s (use object build new report s based on any object in t he project . A
browser) report creat or can work only wit hin t he paramet ers of a
predesigned report t hat has been set up by a report
designer. For more inf ormat ion, see t he Adv anced
R eporting Guide .

P ivot Report P ivot inf ormat ion on a report

P ublish Dossier P ublish a Dossier t o ot her users or groups

Re-execut e a report , hit t ing t he warehouse rat her t han

Re-execut e Report against t he server cache
warehouse I f I nt elligence S erver caching is t urned of f and t his is
not grant ed, t he re-execut e but t on is removed

S ave cust om aut ost yle S ave a report ’s st yle as a cust om aut ost yle

S end t o E mail Use t he S end t o E mail opt ion in t he Report E dit or

S et at t ribut e display Choose at t ribut e f orm display

Use t he edit ors in A rchit ect (f or example, t he A t t ribut e,

Use A rchit ect E dit ors Fact , Hierarchy, and Table edit ors)

This privilege is required t o work wit h logical views

Use Consolidat ion E dit or Use t he Consolidat ion E dit or

Use Cust om Group E dit or Use t he Cust om Group E dit or

Use dat a explorer Use t he dat a explorer in t he object browser

Use Dat a Mart E dit or Use t he Dat a Mart E dit or

Use design mode Use Design view in t he Report E dit or

Log in t o a project using Developer

Use Developer
I f a user does not have t his privilege f or a project , t hat

1735 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Privileg e Allo ws th e u ser to ...

project is not shown in Developer. I f a user does not

have t his privilege f or any project s in t he project
source, Developer ret urns an error message

Use Document E dit or, Use

Use t he Document and HTML Document edit or
HTML Document E dit or

Use Drill Map E dit or Creat e or modif y drill maps

Use Filt er E dit or Use t he Filt er E dit or

Use Find and Replace

Use t he Find and Replace dialog box
Dialog

Use t he f ormat t ing edit or f or consolidat ions, cust om

Use Format t ing E dit or
groups, and report s

Use Freef orm S QL E dit or Use t he Freef orm S QL E dit or

Use grid opt ions Use t he Grid Opt ions dialog box

Use Hist ory List Use t he Hist ory List

Use Link E dit or Use t he Link E dit or

Use t he Met ric E dit or. A mong ot her t asks, t his privilege
Use Met ric E dit or allows t he user t o import Dat a Mining S ervices (DMX )
predict ive met rics

Use Object Manager t o migrat e object s bet ween

project s

A user cannot log int o a project source in Object

Use Object Manager Manager unless t hey have t his privilege or Use Object
Manager Read-only on at least one project in t hat
project source. A ddit ionally, a user cannot open a
project in Object Manager unless t hey have t his
privilege on t hat project .

Use Object Manager Read- Use Object Manager t o view object s and creat e updat e
only packages but not make any changes t o any project s

© 2019, M icr o St r at egy In c. 1736

Syst em Ad m in ist r at io n Gu id e

Privileg e Allo ws th e u ser to ...

Use t he project document at ion f eat ure t o print object

Use project document at ion
def init ions

Use P rompt E dit or Use t he P rompt E dit or t o creat e or modif y prompt s

A ccess t he New opt ion in t he Report E dit or, and creat e

new report s
Use report dat a opt ions I f a user has t his privilege but not t he Use design view
privilege, t hey can st ill creat e new report s f rom
t emplat es, but t he B lank report opt ion is not available

Use Report E dit or Use t he Report E dit or

Use S earch E dit or Use t he search f eat ure on all edit ors and Developer

Use S QL st at ement s t ab in
Use t he S QL S t at ement s t ab in t he Dat amart E dit or
Dat amart / B ulk E xport
and t he B ulk E xport edit or
E dit ors

Use S ubt ot al E dit or Use t he S ubt ot al E dit or

Use Templat e E dit or Use t he Templat e E dit or

Use t he Thresholds E dit or. This privilege is required t o

Use Thresholds E dit or
def ine condit ional f ormat t ing.

Use V LDB propert y edit or Use t he V LDB P ropert ies E dit or

V iew S QL V iew a report ’s S QL

Mi croStrategy 10.x Archi tect Pri vi l eges

Privileg e Allo ws th e u ser to ...

A lias object s Rename object s

Modif y schema object s wit hout having t he necessary

B ypass schema object s
permissions f or each object . For example, users wit h
securit y access checks
t his can updat e t he schema or use t he Warehouse

1737 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Privileg e Allo ws th e u ser to ...

Cat alog B rowser wit hout having administ rat or

privileges.

Writ e permission f or t he f older cont aining t he schema

object s may also be required and is not grant ed by t his
privilege.

Change some charact erist ics of page appearance and

Change user pref erence
report result s

Conf igure t oolbars Use, show, and hide t oolbars

Creat e dat aset in

Creat e a dat aset in Workst at ion
Workst at ion

Creat e HTML cont ainer Creat e HTML cont ainer object s in a document

Def ine MDX Cube Report Def ine a new report t hat accesses an MDX cube

Def ine a new Query B uilder report t hat accesses an

Def ine query build Report ext ernal dat a source, and see t he Query B uilder icon in
t he Creat e Report dialog box

Use links t o view relat ed dat a not shown in t he original

Drill and link
report result s

E xecut e Document E xecut e a Report S ervices document s

Format graph Modif y a graph’s f ormat using a t oolbar or gallery

I mport f unct ion Use t he Funct ion P lug-in E dit or

I mport MDX cube I mport an MDX cube

Modif y Report subt ot als Change or creat e subt ot als on a report

Modif y sort ing Change a report ’s sort ing

Use t he Object B rowser when viewing a report in V iew

Modif y t he list of Report or Design Mode
object s (use object
This det ermines whet her t he user is a report designer
browser)
or a report creat or. A report designer is a user who can

© 2019, M icr o St r at egy In c. 1738

Syst em Ad m in ist r at io n Gu id e

Privileg e Allo ws th e u ser to ...

build new report s based on any object in t he project . A

report creat or can work only wit hin t he paramet ers of a
predesigned report t hat has been set up by a report
designer. For more inf ormat ion, see t he Adv anced
R eporting Guide .

P ivot Report P ivot inf ormat ion on a report

P ublish Dossier P ublish a Dossier t o ot her users or groups

Re-execut e a report , hit t ing t he warehouse rat her t han

Re-execut e Report against t he server cache
warehouse I f I nt elligence S erver caching is t urned of f and t his is
not grant ed, t he re-execut e but t on is removed

S ave cust om aut ost yle S ave a report ’s st yle as a cust om aut ost yle

S end t o E mail Use t he S end t o E mail opt ion in t he Report E dit or

S et at t ribut e display Choose at t ribut e f orm display

Use t he edit ors in A rchit ect (f or example, t he A t t ribut e,

Use A rchit ect E dit ors Fact , Hierarchy, and Table edit ors)

This privilege is required t o work wit h logical views

Use Consolidat ion E dit or Use t he Consolidat ion E dit or

Use Cust om Group E dit or Use t he Cust om Group E dit or

Use dat a explorer Use t he dat a explorer in t he object browser

Use Dat a Mart E dit or Use t he Dat a Mart E dit or

Use design mode Use Design view in t he Report E dit or

Log in t o a project using Developer

I f a user does not have t his privilege f or a project , t hat

Use Developer project is not shown in Developer. I f a user does not
have t his privilege f or any project s in t he project
source, Developer ret urns an error message

1739 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Privileg e Allo ws th e u ser to ...

Use Document E dit or Use t he Document E dit or

Use Drill Map E dit or Creat e or modif y drill maps

Use Filt er E dit or Use t he Filt er E dit or

Use Find and Replace

Use t he Find and Replace dialog box
Dialog

Use t he f ormat t ing edit or f or consolidat ions, cust om

Use Format t ing E dit or
groups, and report s

Use Freef orm S QL E dit or Use t he Freef orm S QL E dit or

Use grid opt ions Use t he Grid Opt ions dialog box

Use Hist ory List Use t he Hist ory List

Use HTML Document E dit or Use t he HTML Document E dit or

Use Link E dit or Use t he Link E dit or

Use t he Met ric E dit or. A mong ot her t asks, t his privilege
Use Met ric E dit or allows t he user t o import Dat a Mining S ervices (DMX )
predict ive met rics

Use Object Manager t o migrat e object s bet ween

project s

A user cannot log int o a project source in Object

Use Object Manager Manager unless t hey have t his privilege or Use Object
Manager Read-only on at least one project in t hat
project source. A ddit ionally, a user cannot open a
project in Object Manager unless t hey have t his
privilege on t hat project .

Use Object Manager Read- Use Object Manager t o view object s and creat e updat e
only packages but not make any changes t o any project s

Use t he project document at ion f eat ure t o print object

Use project document at ion
def init ions

© 2019, M icr o St r at egy In c. 1740

Syst em Ad m in ist r at io n Gu id e

Privileg e Allo ws th e u ser to ...

Use P rompt E dit or Use t he P rompt E dit or t o creat e or modif y prompt s

A ccess t he New opt ion in t he Report E dit or, and creat e

new report s
Use report dat a opt ions I f a user has t his privilege but not t he Use design view
privilege, t hey can st ill creat e new report s f rom
t emplat es, but t he B lank report opt ion is not available

Use Report E dit or Use t he Report E dit or

Use S earch E dit or Use t he search f eat ure on all edit ors and Developer

Use S QL st at ement s t ab in
Use t he S QL S t at ement s t ab in t he Dat amart E dit or
Dat amart / B ulk E xport
and t he B ulk E xport edit or
E dit ors

Use S ubt ot al E dit or Use t he S ubt ot al E dit or

Use Templat e E dit or Use t he Templat e E dit or

Use t he Thresholds E dit or. This privilege is required t o

Use Thresholds E dit or
def ine condit ional f ormat t ing.

Use V LDB propert y edit or Use t he V LDB P ropert ies E dit or

V iew E TL inf ormat ion This priv ilege is deprec ated

V iew S QL V iew a report ’s S QL

Developer Privileges
These pri vi l eges correspond to the report desi gn functi onal i ty
avai l abl e i n D evel oper. The predefi ned D evel oper group i s assi gned
these pri vi l eges by defaul t. The D evel oper group al so i nheri ts al l the
pri vi l eges assi gned to the Anal yst group. Li cense Manager counts
any user w ho has any of these pri vi l eges as a D evel oper user.

1741 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Privileg e Allo ws th e u ser to ...

* Def ine I nt elligent Cube Creat e a report t hat uses an I nt elligent Cube as a dat a
report source.

* P ublish I nt elligent Cube P ublish an I nt elligent Cube t o I nt elligence S erver.

S ave st and-alone derived element s, separat e f rom t he

* S ave derived element s
report .

* Use I nt elligent Cube

Creat e I nt elligent Cubes.
E dit or

** Creat e HTML
Creat e HTML cont ainer object s in a document .
cont ainer

** Use Document E dit or Use t he Document E dit or.

*** Use bulk export edit or Use t he B ulk E xport E dit or t o def ine a bulk export report .

**** Def ine t ransact ion Def ine a Transact ion S ervices report using t he Freef orm
report S QL edit or.

Def ine Freef orm S QL Def ine a new report using Freef orm S QL, and see t he
report Freef orm S QL icon in t he Creat e Report dialog box.

Def ine MDX cube report Def ine a new report t hat accesses an MDX cube.

Def ine a new Query B uilder report t hat accesses an

Def ine Query B uilder
ext ernal dat a source, and see t he Query B uilder icon in
report
t he Creat e Report dialog box.

Format graph Modif y a graph's f ormat using a t oolbar or gallery.

A dd object s t o a report , which are not current ly displayed

in t he Report Object s window. This det ermines whet her
t he user is a report designer or a report creat or. A report
Modif y t he list of report designer is a user who can build new report s based on
object s (use Object any object in t he project . A report creat or can work only
B rowser) wit hin t he paramet ers of a predesigned report t hat has
been set up by a report designer. This privilege is
required t o edit t he report f ilt er and t he report limit . For
more inf ormat ion on t hese f eat ures, see t he Advanc ed

© 2019, M icr o St r at egy In c. 1742

Syst em Ad m in ist r at io n Gu id e

Privileg e Allo ws th e u ser to ...

R eporting Guide .

Use Consolidat ion E dit or Use t he Consolidat ion E dit or.

Use Cust om Group

Use t he Cust om Group E dit or.
E dit or

Use Dat a Mart E dit or Use t he Dat a Mart E dit or.

Use design mode Use Design V iew in t he Report E dit or.

Use Drill Map E dit or Creat e or modif y drill maps.

Use Filt er E dit or Use t he Filt er E dit or.

Use Find and Replace

Use t he Find and Replace dialog box.
dialog

Use t he f ormat t ing edit or f or consolidat ions, cust om

Use Format t ing E dit or
groups, and report s.

Use HTML Document

Use t he HTML Document E dit or.
E dit or

Use Link E dit or Use t he Link E dit or.

Use t he Met ric E dit or. A mong ot her t asks, t his privilege
Use Met ric E dit or allows t he user t o import DMX (Dat a Mining S ervices)
predict ive met rics.

Use project Use t he project document at ion f eat ure t o print object
document at ion def init ions.

Use P rompt E dit or Use t he P rompt E dit or.

Use S QL S t at ement s t ab
Use t he S QL S t at ement s t ab in t he Dat amart E dit or and
in Dat amart / B ulk E xport
t he B ulk E xport edit or.
edit ors

Use S ubt ot al E dit or Use t he S ubt ot al E dit or.

Use Templat e E dit or Use t he Templat e E dit or.

1743 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Privileg e Allo ws th e u ser to ...

Use t he Translat ion E dit or. Users wit h t his privilege can
Use Translat ion E dit or
t ranslat e an object wit hout having Writ e access t o t he
bypass
object .

Use V LDB P ropert y

Use t he V LDB P ropert ies E dit or.
E dit or

V iew E TL inf ormat ion This privilege is deprecated.

l P rivileges marked wit h * are included only if you have OLA P S ervices inst alled as
part of I nt elligence S erver.

l P rivileges marked wit h ** are included only if you have Report S ervices inst alled.

l P rivileges marked wit h *** are included only if you have Dist ribut ion S ervices
inst alled.

l P rivileges marked wit h **** are included only if you have Transact ion S ervices
inst alled.

In addi ti on, i t grants the fol l ow i ng pri vi l eges from the C ommon
Pri vi l eges group:

An alyst

l Drill Wit hin I nt elligent Cube l S ave P ersonal A nswer

l A dd Not es l S chedule Request

l Creat e A pplicat ion Object l Use S erver Cache

l Creat e Folder l Use Translat ion E dit or

l Creat e S hort cut l V iew Not es

l E dit Not es l Creat e S chema Object s

Privileges for the MicroStrategy Web Groups

The defaul t pri vi l eges that are automati cal l y granted for the
Mi croStrategy Web groups are l i sted bel ow .

© 2019, M icr o St r at egy In c. 1744

Syst em Ad m in ist r at io n Gu id e

The MicroStrategy Web R eporter group grants the fol l ow i ng

pri vi l eges:

l Al l pri vi l eges i n the Web R eporter pri vi l ege group (see Web
R eporter pri vi l eges).

l Al l pri vi l eges i n the C ommon Pri vi l eges pri vi l ege group, except for
C reate Schema Obj ects and Edi t N otes.

The MicroStrategy Web A nalyst group grants the fol l ow i ng

pri vi l eges:

l Al l pri vi l eges granted to the Mi croStrategy Web R eporter group.

l Al l pri vi l eges i n the Web Anal yst pri vi l ege group (see Web Anal yst
pri vi l eges).

l The fol l ow i ng addi ti onal pri vi l eges:

Micro Strateg y Web An alyst

l Creat e A pplicat ion Object s (in

l Web Drill A nd Link (in Web Report er)
Common P rivileges)
l Web S imult aneous E xecut ion (in Web
l S chedule Request (in Common
Report er)
P rivileges)
l Web V iew Hist ory List (in Web
l Use Dist ribut ion S ervices (in
Report er)
Dist ribut ion S ervices)

Some of thes e priv ileges are als o inherited from the groups that the Web
Analy s t group is a member of.

The MicroStrategy Web Professional group grants the fol l ow i ng

pri vi l eges:

▫ Al l pri vi l eges granted to the Mi croStrategy Web Anal yst group.

1745 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

▫ Al l pri vi l eges i n the Web Professi onal pri vi l ege group (see Web
Professi onal pri vi l eges), except for Web C reate H TML
C ontai ner.

▫ The fol l ow i ng addi ti onal pri vi l eges:

Micro Strateg y Web An alyst

l Creat e A pplicat ion Object s (in

l Web Drill A nd Link (in Web Report er)
Common P rivileges)
l Web S imult aneous E xecut ion (in Web
l S chedule Request (in Common
Report er)
P rivileges)
l Web V iew Hist ory List (in Web
l Use Dist ribut ion S ervices (in
Report er)
Dist ribut ion S ervices)

Some of thes e priv ileges are als o inherited from the groups that the Web
Profes s ional group is a member of.

Privileges for the System Monitors Groups

By defaul t the System Monitors group does not grant any addi ti onal
pri vi l eges. The defaul t pri vi l eges that are automati cal l y granted for
the groups that are members of the System Moni tors group are l i sted
bel ow . U nl ess otherw i se speci fi ed, al l pri vi l eges are from the
Admi ni strati on pri vi l ege group (see Admi ni strati on pri vi l eges).

The N arrowcast System A dministrators group does not grant any

pri vi l eges by defaul t.

The Server B ulk A dministrators group grants the fol l ow i ng

pri vi l eges:

Server Bu lk Ad min istrato rs

l Use Object Manager

l Use Reposit ory Translat ion Wizard
l Use Command Manager

© 2019, M icr o St r at egy In c. 1746

Syst em Ad m in ist r at io n Gu id e

The Server C onfiguration A dministrators group grants the fol l ow i ng

pri vi l eges:

Server Co n fig u ratio n Ad min istrato rs

l Creat e A nd E dit Dat abase I nst ances l Creat e Conf igurat ion Object s
A nd Connect ions
l Creat e A nd E dit Transmit t ers A nd
l Creat e A nd E dit Dat abase Logins Devices (in Dist ribut ion S ervices)

The Server Operations A dministrators group grants the fol l ow i ng

pri vi l eges:

Server Op eratio n s Ad min istrato rs

l S chedule Request (in Common l A dminist er Jobs

P rivileges) l A dminist er S ubscript ions
l A dminist er Caches l A dminist er User Connect ions
l A dminist er Clust er l Fire E vent s
l A dminist er Cubes l I dle A nd Resume P roject
l A dminist er Dat abase Connect ions l Load A nd Unload P roject

The Server Operations Monitors group grants the fol l ow i ng

pri vi l eges:

Server Op eratio n s Mo n ito rs

l A dminist er Caches l Monit or Clust er

l A dminist er Clust er l Monit or Cubes

l A dminist er Dat abase Connect ions l Monit or Dat abase Connect ions

l A dminist er Jobs l Monit or Hist ory List s

l A dminist er User Connect ions l Monit or Jobs

1747 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Server Op eratio n s Mo n ito rs

l A udit Change Journal

l Monit or P roject s
l I dle A nd Resume P roject
l Monit or S ubscript ions
l Load A nd Unload P roject
l Monit or User Connect ions
l Monit or Caches

The Server R esource Settings A dministrators group grants the

fol l ow i ng pri vi l eges:

Server Reso u rce Settin g s Ad min istrato rs

l Conf igure Caches

l Conf igure Governing l Conf igure S t at ist ics

l Conf igure Language S et t ings l Conf igure S ubscript ion S et t ings

l Conf igure P roject B asic l E dit P roject S t at us

l Conf igure P roject Dat a S ource l Web A dminist rat ion

l Conf igure S erver B asic

The Server Security A dministrators group grants the fol l ow i ng

pri vi l eges:

Server Secu rity Ad min istrato rs

l Creat e A pplicat ion Object s (in

Common P rivileges) l Conf igure S ecurit y S et t ings
l A ssign S ecurit y Filt ers l Creat e A nd E dit S ecurit y Filt ers
l A ssign S ecurit y Roles l Grant / Revoke P rivilege
l Conf igure Connect ion Map

© 2019, M icr o St r at egy In c. 1748

Syst em Ad m in ist r at io n Gu id e

The System A dministrators group grants al l Mi croStrategy

pri vi l eges.

The U ser A dministrators group grants the fol l ow i ng pri vi l eges:

User Ad min istrato rs

l Conf igure Cont act s Dat a S ecurit y l Creat e A nd E dit Users A nd Groups
P rof ile (in Dist ribut ion S ervices) l Creat e Conf igurat ion Object s
l A ssign S ecurit y Roles l E nable User
l Conf igure Group Membership l Grant / Revoke P rivilege
l Creat e A nd E dit Cont act s A nd l Link Users A nd Groups To E xt ernal
A ddresses A ccount s
l Creat e A nd E dit S ecurit y Roles l Reset User P assword

List of All Privileges

The dossi er bel ow l i sts al l of the avai l abl e pri vi l eges grouped by thei r
respecti ve l i cense.

The C l i ent - Web and Server - Intel l i gence l i censes have i nheri ted
properti es. So to see al l of the pri vi l eges avai l abl e for a C l i ent - Web
l i cense, i n the dossi er sel ect C lient - Web and C lient - R eporter. To
see al l of the pri vi l eges avai l abl e for a Server - Intel l i gence l i cense,
sel ect Server - Intelligence and Server - R eporter i n the dossi er.

For more i nformati on on the types of pri vi l eges avai l abl e and how
they w ork together, see Pri vi l eges by Li cense Type.

Privileges by License

1749 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

© 2019, M icr o St r at egy In c. 175 0

Syst em Ad m in ist r at io n Gu id e

Removing Privileges
To add or remove a pri vi l ege for a user or group, ri ght-cl i ck that user
or group and sel ect Edit to open i t i n the U ser Edi tor or Group Edi tor.
Sel ect the Project A ccess category, and sel ect or cl ear the check
boxes for the pri vi l ege for any proj ects you w ant the pri vi l ege to appl y
to. For a more i n-depth di scussi on of pri vi l eges, i ncl udi ng i nstructi ons
on usi ng the Project A ccess category to assi gn pri vi l eges, see the
Setti ng U p U ser Securi ty secti on.

Privileges by License Type

There are tw o mai n types of l i censes avai l abl e from the Mi croStrategy
product sui te that come w i th pri vi l eges: C l i ent product and Server
product l i censes. Every l i cense type comes w i th a uni que set of
pri vi l eges, and system admi ni strators are responsi bl e for assi gni ng
these pri vi l eges based on securi ty rol es, user groups, as w el l as the
i ndi vi dual user.

Client product License Types

The fol l ow i ng i s a l i st of the offi ci al l i cense types avai l abl e i n C l i ent
products:

l C lient - H yperIntelligence: A chrome brow ser extensi on that can

embed anal yti cs i nto any w ebsi te or w eb appl i cati on. The
H yperIntel l i gence cl i ent automati cal l y detects predefi ned keyw ords
on a w ebpage or w eb appl i cati on and surfaces contextual i nsi ghts
from enterpri se data sources usi ng cards.

l C lient - R eporter: A consumer l i cense that al l ow s end users to

vi ew , execute, and i nteract w i th dashboards, reports, and
documents vi a Mi croStrategy Web.

175 1 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l C lient - Web: A zero-footpri nt w eb i nterface that al l ow s users to

access anal yti cs on mul ti pl e brow sers and desi gn, i nteract w i th,
and consume i nformati on vi a pi xel -perfect reports, documents, or
dashboards.

l C lient - A pplication: Al l ow s organi zati ons to bui l d a governed,

scal abl e, secure, and hi ghl y-performant envi ronment that can be
used to bui l d and depl oy custom branded appl i cati ons for Web or
Mobi l e.

l C lient - Mobile: Mi croStrategy Mobi l e al l ow s organi zati ons to

depl oy mobi l e anal yti cs and bui l d pow erful producti vi ty apps that
del i ver nati ve, secure, mobi l e-opti mi zed experi ences that take
advantage of the uni que capabi l i ti es of mobi l e devi ces. In addi ti on,
the Mobi l e l i cense i ncl udes the new D ossi er mobi l e app.

l C lient - A rchitect: Li cense that provi des the abi l i ty to create the
proj ect schema, and bui l d a central i zed data model to del i ver a
si ngl e versi on of the truth.

l C lient - B adge: A mobi l e cl i ent appl i cati on that enabl es di gi tal

i denti ty badges to be used to authenti cate users for physi cal
access, l ogi cal access, peer to peer val i dati on, and mul ti factor
authenti cati on. The mobi l e cl i ent can al so be confi gured to capture
i denti ty and tel emetry data to be used for contextual anal yti cs and
w orkfl ow s.

l C lient - C ommunicator: A mobi l e cl i ent appl i cati on that provi des

anal yti cs, i denti ty di scovery, musteri ng, and tw o-w ay
communi cati ons features to conduct compl ex anal yti cs and opti mi ze
producti vi ty for Badge users.

The pri vi l eges i n any l i cense type you have do not rel y on addi ti onal
l i censes to functi on properl y. H ow ever, i t i s possi bl e to i nheri t
pri vi l eges from other l i cense types. The C l i ent - R eporter and - Web
l i censes are l i nked together i n a hi erarchy that al l ow s users to i nheri t

© 2019, M icr o St r at egy In c. 175 2

Syst em Ad m in ist r at io n Gu id e

speci fi c pri vi l ege sets. The hi erarchy i s set up such that the C l i ent -
R eporter l i cense i s a subset of the C l i ent - Web l i cense.

Thi s means that i f you have a C l i ent - Web l i cense, i n addi ti on to the
pri vi l ege set that comes w i th that l i cense, you w i l l automati cal l y
i nheri t the pri vi l eges that come w i th the C l i ent - R eporter l i cense.

H ow ever thi s hi erarchy does not w ork i n reverse, so i f you have the
C l i ent - R eporter l i cense, you w i l l not i nheri t the C l i ent - Web
pri vi l ege set. Keep i n mi nd that you can sti l l use each of the C l i ent
product l i cense types i ndi vi dual l y regardl ess of w hether or not they
are apart of a hi erarchy.

R eference the dossi er bel ow to see the pri vi l ege set that comes w i th
each l i cense type. Li cense types that contai n a subset have al ready
been set up to i ncl ude the pri vi l eges from thei r subset l i cense.

Server Product License Types

The fol l ow i ng i s a l i st of the offi ci al l i cense types avai l abl e i n Server
products:

l Server - R eporter: A subset of the Intel l i gence and Anal yti cs

Server, the R eporter Server i s ai med for data consumers to vi ew
and i nteract w i th data by executi ng and vi ew i ng cards, dossi ers,

175 3 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

reports, and documents – on both Web and Mobi l e appl i cati ons.

l Server - Intelligence: Provi des the core anal yti cal processi ng
pow er and j ob management features for reporti ng, anal ysi s, and
moni tori ng appl i cati ons.

l Server - Telemetry: Provi des real ti me and automated capture and

di stri buti on of tel emetry data for use i n anal yti cs, mobi l e
appl i cati ons, and other w orkfl ow s.

l Server - Identity: Provi des the organi zati on w i th the abi l i ty to,
create, confi gure, di stri bute and manage di gi tal i denti ti es (Badge)
for users.

l Server - A nalytics (add-on): An extensi on to the Intel l i gence

Server that adds i n-memory to the standard R OLAP functi onal i ty of
the Mi croStrategy pl atform. The Anal yti cs Server creates and
manages Intel l i gent C ubes, a mul ti -di mensi onal cache structure that
speeds up access to frequentl y used data.

l Server - C ollaboration (add-on): C ol l aborati on gi ves users the

abi l i ty to communi cate w i th each other by exchangi ng messages,
taggi ng users, and shari ng fi l ter sel ecti ons. Al l i nteracti ons are
handl ed through the Intel l i gence Server and al l users sendi ng or
recei vi ng messages must exi st i n the Intel l i gence Server reposi tory.

l Server - D istribution (add-on): Enabl es a robust, scal abl e, and

effi ci ent rol l out of automated reporti ng to corporate users, external
partners, and customers, and can di stri bute mi l l i ons of reports
w i thi n a speci fi ed ti me frame.

l Server - Transaction (add-on): Al l ow s organi zati ons to l everage

w ri te-back functi onal i ty i n documents, dashboards, and mobi l e apps
i n order to approve requests, submi t orders, change pl ans, and
capture i nformati on i ncl udi ng comments and i mages from a mobi l e
devi ce.

© 2019, M icr o St r at egy In c. 175 4

Syst em Ad m in ist r at io n Gu id e

Si mi l ar to the C l i ent product l i cense types, the Server - Intel l i gence

and Server - R eporter l i cense are organi zed i nto a hi erarchy that
al l ow s users to i nheri t certai n pri vi l eges. In thi s hi erarchy, the Server
- R eporter l i cense i s a subset of the Server - Intel l i gence l i cense.

Thi s means that i f you have the Server - Intel l i gence l i cense, i n
addi ti on to that l i cense's pri vi l ege set you w i l l have access to the
pri vi l ege set avai l abl e i n the Server - R eporter l i cense. H ow ever thi s
does not prevent you from usi ng the pri vi l ege set of ei ther l i cense
i ndi vi dual l y.

Ad d -On s
Server product l i censes al so i ncl ude add-on l i censes that contai n
thei r ow n pri vi l ege sets. Each of these l i cense types can be obtai ned
separatel y and added on top of ei ther the Server - Intel l i gence or
Server - R eporter l i censes. The onl y restri cti on i s that certai n add-ons
can onl y be added to speci fi c l i cense types:

175 5 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Server - A nalytics: can onl y be added on top of the Server -

Intel l i gence l i cense

l Server - C ollaboration: can be added on top of ei ther the Server -

Intel l i gence or Server - R eporter l i cense

l Server - D istribution: can be added on top of ei ther the Server -

Intel l i gence or Server - R eporter l i cense

l Server - Transaction: can be added on top of ei ther the Server -

Intel l i gence or Server - R eporter l i cense

Once an add-on has been obtai ned you w i l l have access to i ts

pri vi l ege set, as w el l as the pri vi l ege set of the l i cense type you
combi ned i t w i th.

R eference the dossi er bel ow to see the pri vi l ege sets that come w i th
each l i cense type. If you are l ooki ng at a l i cense type combi ned w i th
an add-on, you must sel ect both to see the ful l l i st of avai l abl e
pri vi l eges.

Compliance with Privileges

C ompl i ance i s essenti al l y w hether or not your users have been
accessi ng the pri vi l eges avai l abl e to your enterpri se based on the
type and quanti ty of l i cense(s) purchased. You are consi dered i n
compl i ance i f you are usi ng l ess than or equal to the amount of
l i censes avai l abl e. If your users exceed the amount of l i censes
avai l abl e by usi ng more pri vi l eges than there are l i censes avai l abl e,
then you are consi dered out of compl i ance. See the drop-dow ns
bel ow for exampl es of each scenari o.

Once your enterpri se has purchased one or more of the l i cense types
avai l abl e, you w i l l al so get access to Li cense Manager. Thi s product
manages the l i cense types your enterpri se has by audi ti ng them to
keep track of w hi ch ones are i n use, and w hi ch ones are avai l abl e.

In compl i ance exampl e

Let's say an enterpri se has purchased 2 Server - R eporter, 1 Server -

© 2019, M icr o St r at egy In c. 175 6
Syst em Ad m in ist r at io n Gu id e

Intel l i gence, 1 C l i ent - Web, and 2 C l i ent - R eporter l i censes that

contai n the fol l ow i ng pri vi l eges:

l Server - R eporter: Export to PD F, use anal yti cs, vi ew notes

l Server - Intel l i gence: Add notes, fi re events, confi gure caches

l C l i ent - R eporter: Web export, w eb sort

l C l i ent - Web: U se offi ce, document desi gn

N ow l et's say that there are three empl oyees i n the enterpri se that
have been usi ng these l i censes to access the fol l ow i ng pri vi l eges:

l Empl oyee 1: Export to PD F, w eb export

l Empl oyee 2: U se anal yti cs, w eb sort

l Empl oyee 3: Vi ew notes, w eb sort, w eb export

Thi s enterpri se has 2 Server - R eporter and 2 C l i ent - R eporter

l i censes, so i t may i ni ti al l y seem l i ke they are out of compl i ance si nce
al l three empl oyees use both l i cense types. H ow ever because of the
hi erarchi es descri bed above, the Server - Intel l i gence l i cense i nheri ts
the pri vi l ege set of the Server - R eporter l i cense, and the C l i ent - Web
l i cense i nheri ts the pri vi l ege set of the C l i ent - R eporter l i cense. Thi s
means that any pri vi l eges mapped to the Server - R eporter or C l i ent -
R eporter l i censes can al so be mapped to the Server - Intel l i gence or
C l i ent - Web l i censes.

175 7 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

So i n real i ty, thi s enterpri se i s usi ng 2 Server - R eporter, 2 C l i ent -

R eporter, 1 Server - Intel l i gence, and 1 C l i ent - Web l i censes w hi ch
means they are exactl y i n compl i ance.

Out of compl i ance exampl e

Let's say an enterpri se has purchased 2 Server - R eporter, 1 Server -

Intel l i gence, 1 C l i ent - Web, and 2 C l i ent - R eporter l i censes that
contai n the fol l ow i ng pri vi l eges:

l Server - R eporter: Export to PD F, use anal yti cs, vi ew notes

l Server - Intel l i gence: Add notes, fi re events, confi gure caches

l C l i ent - R eporter: Web export, w eb sort

l C l i ent - Web: U se offi ce, document desi gn

N ow l et's say that there are three empl oyees i n the enterpri se that
have been usi ng these l i censes to access the fol l ow i ng pri vi l eges:

l Empl oyee 1: Export to PD F, w eb sort, document desi gn

l Empl oyee 2: Export to PD F, use offi ce, w eb export

l Empl oyee 3: Export to PD F, w eb sort

In total thi s enterpri se i s usi ng 3 Server - R eporter, 3 C l i ent -

R eporter, and 2 C l i ent - Web l i censes. Even by usi ng i nheri ted
pri vi l eges (w hi ch maps the Server - R eporter l i cense to the Server -
Intel l i gence l i cense, and the C l i ent - R eporter l i cense to the C l i ent -
Web l i cense), thi s enterpri se i s sti l l usi ng 2 C l i ent - Web l i censes.

© 2019, M icr o St r at egy In c. 175 8

Syst em Ad m in ist r at io n Gu id e

Because they onl y have 1 C l i ent - Web l i cense avai l abl e, they are out
of compl i ance.

Privileges by License Type Dossier

175 9 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

© 2019, M icr o St r at egy In c. 1760

Syst em Ad m in ist r at io n Gu id e

1761 © 2019, M icr o St r at egy In c.

 4
M ULTI -TENANT
ENVIRONM ENTS: O BJECT
N AM E PERSONALIZATION

© 2019, M icr o St r at egy In c. 1762

Syst em Ad m in ist r at io n Gu id e

In a mul ti -tenant setup, di fferent organi zati ons share a si ngl e

Mi croStrategy envi ronment to accompl i sh thei r reporti ng needs. Thi s
secti on show s you how to use Mi croStrategy to personal i ze obj ect
names i n a proj ect i n your Mi croStrategy envi ronment, to support a
mul ti -tenant setup.

Attri bute and metri c names i n a proj ect's metadata are made rel evant
to each tenant usi ng obj ect name personal i zati on. Every obj ect can
have a di fferent name stored to support each tenant w ho uses that
obj ect i n thei r reporti ng. Each tenant's users see onl y those obj ect
names assi gned to thei r organi zati on. If there i s no speci fi c tenant
name assi gned to an obj ect that i s vi ew abl e by the tenant
organi zati on, i ts users see the base obj ect name.

For exampl e, you have an attri bute stored i n the metadata reposi tory,
w i th a base name of Inventory D ate. Thi s metadata obj ect w i l l appear
on reports accessed by users i n Organi zati on A and Organi zati on B.
You can use obj ect name personal i zati on to confi gure Mi croStrategy
to automati cal l y di spl ay the obj ect to Organi zati on A w i th the name
D ate In Inventory, and di spl ay the same obj ect to Organi zati on B w i th
the name D ate Fi rst Purchased.

Obj ect name personal i zati on i nvol ves exporti ng obj ect stri ngs to a
l ocati on w here they can be updated w i th tenant-speci fi c names, and
i mporti ng the new obj ect stri ngs back i nto the metadata reposi tory.
You can al so provi de new names for i ndi vi dual obj ects one at a ti me,
usi ng the Obj ect Transl ati on Edi tor i n D evel oper.

For steps to perform these procedures, see R enami ng Metadata

Obj ects, page 1766.

1763 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

How a Tenant Language Differs from a Standard

Language
A tenant l anguage i s a set of obj ects that use the names appropri ate
for a gi ven tenant. A tenant l anguage appears i n Mi croStrategy
exactl y l i ke any other l anguage. The tenant l anguage's ID i s the onl y
property that di fferenti ates a tenant l anguage from a standard
l anguage; the system cal cul ates the tenant l anguage's ID based on
the standard l anguage's ID . For exampl e, the l anguage ID for
standard Engl i sh i s 000 0409, w hi l e a tenant l anguage based on
standard Engl i sh mi ght be 0001 0409. Basi ng a tenant l anguage on a
standard l anguage al l ow s the system to provi de the best match for al l
facets of the renamed i nterface, i f one or more parts of the i nterface
are not renamed for the tenant l anguage.

You can create up to 255 tenant l anguages based on a standard

l anguage. For exampl e, usi ng Engl i sh-U S as the base l anguage, you
can create 255 tenant l anguages based on Engl i sh-U S. You can
create another 255 tenant l anguages based on Engl i sh-U K, and so
on.

Granting User Access to Rename Objects and

View Tenant Languages
The procedures i n thi s secti on w i l l hel p you modi fy exi sti ng
Mi croStrategy proj ects to support metadata obj ect renami ng and
tenant l anguages.

Allowing Access to Objects for Renaming

To perform obj ect renami ng, access to speci fi c obj ects i s control l ed
pri mari l y through access control l i sts (AC Ls). You can al l ow
permi ssi ons to speci fi c users for each obj ect that needs to be

© 2019, M icr o St r at egy In c. 1764

Syst em Ad m in ist r at io n Gu id e

renamed, or for each tenant l anguage (a set of obj ects for a gi ven
tenant).

Access t o Ad d o r Mo d if y an Ob ject Name

By defaul t, admi ni strators and obj ect ow ners can rename an obj ect or
modi fy an exi sti ng obj ect name. U se AC Ls to provi de other users
Wri te access to an obj ect, i f other users need to rename that obj ect.
To change AC L permi ssi ons, ri ght-cl i ck the obj ect and sel ect
Properties, then sel ect Security on the l eft. For detai l s on each AC L
and w hat access i t al l ow s, cl i ck H elp.

You can al so provi de a user w i th the U se R eposi tory Transl ati on

Wi zard pri vi l ege, w i thi n the Obj ect Manager set of pri vi l eges. Thi s
al l ow s a user to perform the necessary steps to rename stri ngs i n
bul k, for al l tenants, w i thout gi vi ng the user the abi l i ty to modi fy an
obj ect i n any other w ay. To change a pri vi l ege, open the user i n the
U ser Edi tor and sel ect Project A ccess on the l eft.

Access t o Select o r En ab le a Ten an t 's Ob ject Names

By defaul t, Mi croStrategy users are provi ded w i th appropri ate
pri vi l eges to Brow se and U se a tenant's obj ects, such that anal ysts
can sel ect a tenant l anguage (the set of obj ects that use the tenant's
names) as thei r di spl ay preference i f that tenant l anguage has been
enabl ed for a proj ect. Proj ect admi ni strators can enabl e any tenant
l anguage avai l abl e i n the system.

You can modi fy these defaul t pri vi l eges for a speci fi c user rol e or a
speci fi c tenant l anguage.

1765 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To Modify Access to a Tenant's set of Object Names (Tenant

Language)

1. In the Fol der Li st on the l eft, w i thi n the appropri ate proj ect
source, expand A dministration.

2. Expand C onfiguration Managers, then sel ect Languages.

3. Al l tenant l anguages are l i sted on the ri ght. To change AC L

permi ssi ons for a tenant l anguage, ri ght-cl i ck the obj ect and
sel ect Properties.

4. Sel ect Security on the l eft. For detai l s on each AC L and w hat
access i t al l ow s, cl i ck H elp.

Renaming Metadata Objects

Obj ects that can be renamed are stored i n the Mi croStrategy
metadata. These obj ects i ncl ude metri c names, report names, the
Publ i c Obj ects system fol der, securi ty rol e names, user group names,
and so on. Softw are stri ngs stored i n the metadata i ncl ude embedded
text stri ngs (embedded i n an obj ect's defi ni ti on), such as prompt
i nstructi ons, al i ased names (w hi ch can be used i n attri butes, metri cs,
and custom groups), consol i dati on el ement names, custom group
el ement names, graph ti tl es, and threshol d text.

Metadata obj ects do not i ncl ude confi gurati on obj ects (such as the
user obj ect), functi on names, data mart tabl e names, and so on.

Begi n obj ect renami ng usi ng the fol l ow i ng hi gh-l evel steps:

1. Add tenant l anguages to the system, for each of your tenants. For
steps, see Addi ng a N ew Tenant Language to the System, page
1767.

© 2019, M icr o St r at egy In c. 1766

Syst em Ad m in ist r at io n Gu id e

2. Enabl e tenant l anguages for your proj ect's metadata obj ects. For
steps, see Enabl i ng and D i sabl i ng Tenant Languages, page
1768.

3. Provi de tenant-speci fi c names for obj ects usi ng the steps i n

R enami ng Obj ects i n Your Proj ect, page 1770.

Adding a New Tenant Language to the System

You can add new tenant l anguages to Mi croStrategy. Once they are
added, new tenant l anguages are then avai l abl e to be enabl ed for a
proj ect.

You mus t hav e the Brows e permis s ion for the language objec t's ACL
(ac c es s c ontrol lis t).

To Add a New Tenant Language to the System

1. Log i n to a proj ect as a user w i th admi ni strati ve pri vi l eges.

2. R i ght-cl i ck the proj ect and sel ect Project C onfiguration.

3. On the l eft si de of the Proj ect C onfi gurati on Edi tor, go to

Language > Metadata.

4. C l i ck A dd.

5. C l i ck N ew.

6. C l i ck OK .

7. D i sconnect and reconnect to the proj ect source so that your

changes take effect. To do thi s, ri ght-cl i ck the proj ect source,
sel ect D isconnect from Project Source, then repeat thi s and
sel ect C onnect to Project Source.

Tenant l anguages can al so be added usi ng the Languages

C onfi gurati on Manager, by goi ng to A dministration > C onfiguration
Managers > Language.

1767 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

After addi ng a new tenant l anguage, enabl e the tenant l anguage for
the proj ect. For steps, see Enabl i ng and D i sabl i ng Tenant
Languages, page 1768.

Enabling and Disabling Tenant Languages

To support the di spl ay of a tenant's obj ect names and descri pti ons,
you must enabl e tenant l anguages for your proj ect. The tenant
l anguages you enabl e are those tenant l anguages you w ant to
support for that proj ect.

You can al so di sabl e tenant l anguages for a proj ect.

En ab lin g Ten an t Lan gu ages f o r a Pr o ject

Gather a lis t of tenant languages us ed by filters and prompts in the projec t.

Thes e tenant languages s hould be enabled for the projec t, otherwis e a
report c ontaining a filter or prompt in a tenant language not enabled for the
projec t will not be able to ex ec ute s uc c es s fully .

To Enable Tenant Languages for a Project

1. Log i nto the proj ect as a user w i th Admi ni strati ve pri vi l eges.

2. R i ght-cl i ck the proj ect and sel ect Project C onfiguration.

3. On the l eft, expand Language and sel ect Metadata.

4. C l i ck A dd to see a l i st of avai l abl e tenant l anguages. The l i st

i ncl udes l anguages that have been added to the system.

5. Sel ect the check boxes for the tenant l anguages that you w ant to
enabl e for thi s proj ect.

l Enabl ed tenant l anguages w i l l appear i n the R eposi tory

Transl ati on Wi zard for stri ng and obj ect renami ng, as w el l as

© 2019, M icr o St r at egy In c. 1768

Syst em Ad m in ist r at io n Gu id e

i n D evel oper's My Preferences and Web's Preferences, for

users to sel ect thei r ow n preferred tenant l anguage for the
proj ect.

l R eports that contai n fi l ters or prompts i n a tenant l anguage w i l l

execute successful l y i f the proj ect has that tenant l anguage
enabl ed.

6. C l i ck OK .

7. Sel ect one of the tenant l anguages on the ri ght si de to be the

defaul t tenant l anguage for thi s proj ect. The defaul t tenant
l anguage i s used by the system to mai ntai n obj ect name
uni queness.

This may hav e been s et when the projec t was firs t c reated. If s o, it
will not be av ailable to be s elec ted here.

Onc e the projec t default tenant language is s et, it c annot be

c hanged unles s y ou duplic ate the projec t and c hange the default
tenant language of the duplic ated projec t. Indiv idual objec ts within
a projec t c an hav e their default tenant language c hanged.

8. C l i ck OK .

9. D i sconnect and reconnect to the proj ect source.

10. U pdate the out-of-the-box Mi croStrategy metadata obj ects. To do

thi s, i n D evel oper, ri ght-cl i ck the proj ect and sel ect Project
C onfiguration. Expand Project D efinition, expand U pdate,
sel ect Translations, and cl i ck U pdate.

Disab lin g Ten an t Lan gu ages f o r a Pr o ject

You can use the steps bel ow to di sabl e a tenant l anguage for a
proj ect. When a tenant l anguage has been di sabl ed from a proj ect,
that tenant l anguage i s no l onger avai l abl e for users to sel ect as a

1769 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

tenant l anguage preference, and the tenant l anguage cannot be seen

i n any rel ated i nterfaces, such as an obj ect's Transl ati on di al og box.

Any obj ect names for the di sabl ed tenant l anguage are not removed
from the metadata w i th these steps. R etai ni ng the obj ect names i n the
metadata al l ow s you to enabl e the tenant l anguage agai n l ater, and
the obj ect names w i l l sti l l exi st. To remove obj ect names i n the
di sabl ed tenant l anguage from the metadata, obj ects must be
modi fi ed i ndi vi dual l y and saved.

To Disable Tenant Languages in a Project

1. Log i n to a proj ect as a user w i th admi ni strati ve pri vi l eges.

2. R i ght-cl i ck the proj ect and sel ect Project C onfiguration.

3. On the l eft si de of the Proj ect C onfi gurati on Edi tor, expand
Language, then sel ect Metadata.

4. On the ri ght si de, under Selected Languages, cl ear the check

box for the tenant l anguage that you w ant to di sabl e for the
proj ect, and cl i ck OK .

Renaming Objects in Your Project

R enami ng obj ects i n a proj ect i nvol ves provi di ng new stri ngs for
metadata obj ect names and descri pti ons.

There are tw o methods to rename metadata obj ects, dependi ng on

w hether you w ant to rename a l arge number of obj ects or j ust one or
tw o obj ects:

l R ename a large number of objects: Extract stri ngs i n bul k to a

separate database, rename them, and i mport them back i nto
Mi croStrategy. The Mi croStrategy R eposi tory Transl ati on Wi zard i s
the recommended method to rename your metadata obj ects. Steps
to access thi s tool are bel ow .

© 2019, M icr o St r at egy In c. 1770

Syst em Ad m in ist r at io n Gu id e

l R ename one or more objects in a folder: R i ght-cl i ck the obj ect

and sel ect Translate. Type the new name(s) for each tenant
l anguage thi s obj ect supports, and cl i ck OK . To rename several
obj ects, sel ect them al l w hi l e hol di ng Shi ft or C trl , then ri ght-cl i ck
and sel ect Translate. For detai l s to use the Obj ect Transl ati on
di al og box, cl i ck H elp.

The rest of thi s secti on descri bes the method to rename obj ect stri ngs
i n bul k, usi ng a separate database, w i th the R eposi tory Transl ati on
Wi zard.

The Repos itory Trans lation Wiz ard does not s upport renaming of
c onfiguration objec ts (s uc h as the us er objec t). It does s upport objec t
des c riptors , inc luding embedded tex t. Thes e are detailed in the
introduc tion to R enami ng Metadata Obj ects, page 1766 .

Obj ect renami ng i nvol ves the fol l ow i ng hi gh-l evel steps:

All of the proc edures in this s ec tion as s ume that y our projec ts hav e
been prepared for objec t renaming. Preparation s teps are in Granti ng
U ser Access to R ename Obj ects and Vi ew Tenant Languages,
page 1764 .

1. Add and enabl e tenant l anguages for the metadata reposi tory
(see Addi ng a N ew Tenant Language to the System, page 1767
and Enabl i ng and D i sabl i ng Tenant Languages, page 1768)

2. Export obj ect stri ngs to a l ocati on w here they can be renamed
(see Extracti ng Metadata Obj ect Stri ngs for R enami ng, page
1772)

3. Perform the renami ng (see R enami ng Obj ects i n Your Proj ect,
page 1770)

4. Import the new l y renamed obj ect stri ngs back i nto the metadata
reposi tory (see Importi ng R enamed Stri ngs from the D atabase to
the Metadata, page 1776)

1771 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

To allow us ers to rename objec ts us ing Mic roStrategy 's bulk trans lation
tool, the Repos itory Trans lation Wiz ard, grant the us er the Us e Repos itory
Trans lation Wiz ard priv ilege. If this priv ilege is as s igned, be aware that the
us er will be able to ex port s trings and import new names for thos e s trings in
all languages that the projec t s upports . This is true no matter what other
language res tric tions are applied.

Ext r act in g Met ad at a Ob ject St r in gs f o r Ren amin g

The Mi croStrategy R eposi tory Transl ati on Wi zard supports Mi crosoft
Access and Mi crosoft SQL Server databases as reposi tori es w here
stri ngs can be stored for renami ng. The reposi tory i s w here stri ngs
are extracted to and w here the actual renami ng process i s performed.

You cannot extract stri ngs from the proj ect's defaul t metadata
l anguage.

It is rec ommended that objec ts are not modified between the ex trac tion
proc es s and the import proc es s . This is es pec ially important for objec ts
with loc ation-s pec ific s trings : attribute alias es , metric alias es , c us tom
group elements , and doc ument tex t box es .

To Extract a Large Number of Object Strings for Renaming

1. Open the R eposi tory Transl ati on Wi zard. To do thi s, from the
Start menu, poi nt to A ll Programs, then MicroStrategy Tools,
then sel ect R epository Translation Wizard.

2. C l i ck N ext to begi n.

3. To extract stri ngs from the metadata, sel ect the Export
Translations opti on from the Metadata R eposi tory page i n the
w i zard.

© 2019, M icr o St r at egy In c. 1772

Syst em Ad m in ist r at io n Gu id e

Ren amin g Met ad at a Ob ject St r in gs in t h e Dat ab ase

The extracti on process performed by the R eposi tory Transl ati on
Wi zard creates a tabl e i n the database, w i th the fol l ow i ng col umns:

l PR OJEC TID : Thi s i s the ID of the proj ect from w hi ch the stri ng i s
extracted.

l OBJEC TID : Thi s i s the ID of the obj ect from w hi ch the stri ng i s
extracted.

l OBJEC TTYPE: Each obj ect i s associ ated w i th a numeri c code. For
exampl e, documents are represented by OBJEC TTYPE code 55.

l EMBED D ED ID : An embedded obj ect i s an obj ect contai ned i nsi de

another obj ect, for exampl e, a metri c obj ect that i s part of a report
obj ect. If the stri ng i s extracted from an embedded obj ect, the ID of
thi s embedded obj ect i s stored i n thi s col umn. The val ue 0 i ndi cates
that the stri ng i s not extracted from an embedded obj ect.

l EMBED D ED TYPE: Thi s i s a numeri c representati on of the type of

the embedded obj ect. The val ue 0 i ndi cates that the stri ng i s not
extracted from an embedded obj ect.

l U N IQU EKEY: Thi s i s a key assi gned to the extracted stri ng to

i denti fy the stri ng w i thi n the obj ect.

l R EAD ABLEKEY: Thi s i s a descri pti on of the extracted stri ng w i thi n

the obj ect, for exampl e, Prompt Ti tl e, Prompt D escri pti on, Obj ect
N ame, Templ ate Subtotal N ame, and so on. The R EAD ABLEKEY i s
a readabl e form of the U N IQU EKEY.

l LOC ALEID : Thi s i ndi cates the tenant l anguage of the extracted
stri ng i n the TR AN SLATION col umn.

l Mi croStrategy uses l ocal e ID s to uni quel y i denti fy tenant

l anguages. Mi croStrategy assi gns a uni que tenant l anguage ID

1773 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

based on the base l anguage that the tenant l anguage i s deri ved
from.

l TR AN SLATION : Thi s i s the col umn w here the extracted stri ng i s

stored.

l TR AN SVER SION ID : Thi s i s the versi on ID of the obj ect at the ti me

of export.

l R EFTR AN SLATION : Thi s col umn i s used by transl ators. Thi s

col umn contai ns the extracted stri ng i n the transl ati on reference
l anguage, w hi ch i s sel ected by the user from the R eposi tory
Transl ati on Wi zard duri ng export.

Thi s stri ng i s used onl y as a reference duri ng the transl ati on

process. For exampl e, i f the transl ator i s comfortabl e w i th the
German l anguage, you can set German as the transl ati on reference
l anguage. The R EFTR AN SLATION col umn w i l l then contai n al l the
extracted stri ngs i n the German l anguage.

If no referenc e language s tring is av ailable, the s tring from the

objec t's primary language is ex ported s o that this c olumn is not empty
for any s tring.

l STATU S: You can use thi s col umn to enter fl ags i n the tabl e to
control w hi ch stri ngs are i mported back i nto the metadata. A fl ag i s
a character you type, for exampl e, a l etter, a number, or a speci al
character (as l ong as i t i s al l ow ed by your database). When you use
the w i zard to i mport the stri ngs back i nto the metadata, you can
i denti fy thi s character for the system to use duri ng the i mport
process, to determi ne w hi ch stri ngs to i mport.

For exampl e, i f onl y some obj ects have been renamed, you may
w ant to i mport onl y the compl eted ones. Or you may w i sh to i mport
onl y those stri ngs that w ere revi ew ed. You can fl ag the stri ngs that
w ere compl eted and are ready to be i mported.

© 2019, M icr o St r at egy In c. 1774

Syst em Ad m in ist r at io n Gu id e

l OBJVER SION ID : Thi s i s the versi on ID of obj ects at the ti me of

i mport.

l SYN C H FLAG: Thi s i s a system fl ag and i s automati cal l y generated

duri ng i mport. The fol l ow i ng val ues are used:

l 0: Thi s means that the obj ect has not been modi fi ed betw een
extracti on and i mport.

l 1: Thi s means that the obj ect has been modi fi ed betw een
extracti on and i mport.

l 2: Thi s means that the obj ect that i s bei ng i mported i s no l onger
present i n the metadata.

System fl ags are automati cal l y appl i ed to stri ngs duri ng the i mport
process, so that you can vi ew any stri ng-speci fi c i nformati on i n
the l og fi l e.

l LASTMOD IFIED : Thi s i s the date and ti me w hen the stri ngs w ere
extracted.

Once the extracti on process i s compl ete, the stri ngs i n the database
need to be renamed i n the extracti on tabl e descri bed above.

l If an objec t name is empty in a us er's c hos en projec t language

preferenc e, the s y s tem defaults to dis play ing the objec t's default
name, s o it is not nec es s ary to rename objec ts that are not intended to
be renamed. For details on language preferenc es , s ee Sel ecti ng
Preferred Languages for Interfaces, R eports, and Obj ects, page
1777 .

l If y ou performed a Searc h for Objec ts in the Repos itory Trans lation

Tool, y ou may notic e that the number of rows in the ex trac tion table
might not matc h the number of rows returned in the s earc h res ults .
This is bec aus e a s earc h returns all objec ts that meet the s earc h
requirements ; the s earc h does not filter for only thos e items that c an
be renamed. Thus , for ex ample, the s earc h may return a row for the

1775 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

look up table LU_YEAR, but the ex trac tion proc es s does not ex trac t
the LU_YEAR s tring bec aus e there is no reas on to rename a look up
table's name. To determine whether an objec t's name c an be
renamed, right-c lic k the objec t, s elec t Properties , and look for the
International option on the left. If this option is mis s ing, the objec t is
not s upported for renaming.

To confi rm that your new obj ect names have successful l y been
i mported back i nto the metadata, navi gate to one of the renamed
obj ects i n D evel oper, ri ght-cl i ck, and sel ect Properties. On the l eft,
sel ect International, then cl i ck Translate. The tabl e show s al l names
currentl y i n the metadata for thi s obj ect.

Imp o r t in g Ren amed St r in gs f r o m t h e Dat ab ase t o t h e

Met ad at a
After stri ngs have been renamed i n the database, they must be re-
i mported i nto the Mi croStrategy metadata.

To Import Renamed Strings

1. Open the R eposi tory Transl ati on Wi zard. To do thi s, from the
Start menu, poi nt to A ll Programs, then MicroStrategy Tools,
then sel ect R epository Translation Wizard.

2. C l i ck N ext to begi n.

3. To i mport stri ngs from the database back i nto the metadata,
sel ect the Import Translations opti on from the Metadata
R eposi tory page i n the w i zard.

After the stri ngs are i mported back i nto the proj ect, any obj ects that
w ere modi fi ed w hi l e the renami ng process w as bei ng performed, are
automati cal l y marked w i th a 1. These obj ect names shoul d be
checked for correctness.

© 2019, M icr o St r at egy In c. 1776

Syst em Ad m in ist r at io n Gu id e

Making Tenant-Specific Data Available to Users

After you have performed the necessary steps to confi gure metadata
obj ect renami ng, you can speci fy w hi ch tenant l anguage(s) shoul d be
di spl ayed for vari ous users i n the i nterface and i n reports (both report
obj ects and report resul ts). You can speci fy l anguage preferences at
the proj ect l evel and at the al l -proj ects l evel . By sel ecti ng vari ous
l evel s of l anguage preferences, you speci fy w hi ch l anguage i s
preferred as a fal l back i f a fi rst choi ce l anguage i s not avai l abl e.

The fol l ow i ng secti ons show you how to sel ect l anguage preferences
based on vari ous pri ori ty l evel s w i thi n the system, starti ng w i th a
secti on that expl ai ns the pri ori ty l evel s:

l Sel ecti ng Preferred Languages for Interfaces, R eports, and Obj ects,
page 1777

l Sel ecti ng the Interface Language Preference, page 1779

l C onfi guri ng Metadata Obj ect and R eport D ata Language

Preferences, page 1781

l Sel ecti ng the Obj ect D efaul t Language Preference, page 1794

Selecting Preferred Languages for Interfaces, Reports,

and Objects
After renamed data i s stored i n your data w arehouse and/or metadata
database, and l anguages have been enabl ed for the proj ect, you must
speci fy w hi ch l anguages are the preferred l anguages for the proj ect
and the user. These sel ected l anguages are cal l ed l anguage
preferences.

The fol l ow i ng i mage show s the di fferent parts of the Mi croStrategy

envi ronment that di spl ay renamed stri ngs based on the l anguage
preferences:

1777 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

The fol l ow i ng l anguage preferences can be confi gured:

l Interface Language: D etermi ne the l anguage that menu opti ons,

di al og box text, and so on, w i l l di spl ay. For steps to set thi s
preference, see Sel ecti ng the Interface Language Preference, page
1779.

l Metadata objects: D etermi ne the l anguage that w i l l be di spl ayed

for Mi croStrategy obj ects that come from the metadata database,
such as metri c names, report names, system fol der names, and so
on. For steps to set thi s preference, see C onfi guri ng Metadata
Obj ect and R eport D ata Language Preferences, page 1781.

l R eport data: D etermi ne the l anguage that w i l l be di spl ayed for

report resul ts that come from your data w arehouse, such as attri bute
el ement names. For steps to set thi s preference, see C onfi guri ng
Metadata Obj ect and R eport D ata Language Preferences, page
1781.

l Object default language: D etermi ne the fal l back l anguage for

Mi croStrategy obj ects. Thi s l anguage i s used i f a report i s executed
i n a l anguage that the obj ect l acks a name for. For steps to set or
change thi s defaul t preference, see Sel ecti ng the Obj ect D efaul t
Language Preference, page 1794.

© 2019, M icr o St r at egy In c. 1778

Syst em Ad m in ist r at io n Gu id e

Each l anguage preference can be confi gured i ndependentl y of the

others. H ow ever, for best performance i t i s recommended that you use
a uni fi ed l anguage di spl ay i n D evel oper. For the purposes of mul ti -
tenancy, thi s means that i f the base l anguage for a tenant l anguage i s
Engl i sh - U S, al l of the l anguage sel ecti ons for that tenant shoul d be
Engl i sh - U S w i th the excepti on of the Metadata Obj ect l anguage,
w hi ch shoul d be the tenant l anguage.

Select in g t h e In t er f ace Lan gu age Pr ef er en ce

The i nterface l anguage preference determi nes w hat l anguage
D evel oper menus, edi tors, di al og boxes, moni tors and managers, and
other parts of the D evel oper softw are are di spl ayed i n. U se the steps
bel ow to set thi s preference.

Configuring the Interface Language Preference

1. In D evel oper, l og i n to the proj ect.

2. From the Tools menu, sel ect Preferences.

3. On the l eft, expand International and sel ect Language.The

Internati onal : Language di al og box i s di spl ayed, as show n
bel ow :

1779 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

4. From the Interface Language drop-dow n l i st, sel ect the

l anguage that you w ant to use as the i nterface defaul t l anguage.

The interfac e language preferenc e c an als o be us ed to determine

the language us ed for the metadata objec ts and report data, if the
Dev eloper lev el language preferenc e is s et to U se the same
language as MicroStrategy D eveloper. For more information
on the Dev eloper lev el language preferenc e, s ee Sel ecti ng the
D evel oper Level Language Preference, page 1790 .

5. Sel ect OK .

6. D i sconnect and reconnect to the proj ect source so that your

changes take effect. To do thi s, ri ght-cl i ck the proj ect source,
sel ect D isconnect from Project Source, then repeat thi s and
sel ect C onnect to Project Source.

© 2019, M icr o St r at egy In c. 1780

Syst em Ad m in ist r at io n Gu id e

Co n f igu r in g Met ad at a Ob ject an d Rep o r t Dat a Lan gu age

Pr ef er en ces
There are several l evel s at w hi ch metadata and report data l anguages
can be speci fi ed i n Mi croStrategy. Low er l evel l anguages are used by
the system automati cal l y i f a hi gher l evel l anguage i s unavai l abl e.
Thi s ensures that end users see an appropri ate l anguage i n al l
si tuati ons.

Language preferences can be set at si x di fferent l evel s, from hi ghest

pri ori ty to l ow est. The l anguage that i s set at the hi ghest l evel i s the
l anguage that i s al w ays di spl ayed, i f i t i s avai l abl e. If that l anguage
does not exi st or i s not avai l abl e i n the metadata or the data
w arehouse, the next hi ghest l evel l anguage preference i s used.

If a l anguage preference i s not speci fi ed, or i s set to D efaul t,

Mi croStrategy automati cal l y uses the next l ow er pri ori ty l anguage
preference. If none of these l anguage preferences are set, the
i nterface preferred l anguage i s used.

When an obj ect i s created, i ts defaul t obj ect l anguage i s

automati cal l y set to match the creator's metadata l anguage
preference. If the creator has thei r metadata l anguage preference set
to D efaul t, the new obj ect's defaul t l anguage i s deci ded based on the
rul es i n thi s secti on: the system w i l l fi rst try to use a defaul t l anguage
for al l users of the proj ect, then a l anguage preference set for al l
users of D evel oper, then the defaul t l anguage set for the proj ect (as
show n i n the tabl e bel ow ).

The fol l ow i ng tabl e descri bes each l evel , from hi ghest pri ori ty to
l ow est pri ori ty, and poi nts to i nformati on on how to set the l anguage
preference at each l evel .

l End us er preferenc e s ettings ov erride any adminis trator preferenc e

s ettings , if the two s ettings c onflic t.

1781 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Dis tribution Serv ic es deliv eries are one ex c eption to the hierarc hy
below. For details , s ee Sel ecti ng the Machi ne Level Language
Preference, page 1792 .

L an g u ag e
Preferen ce
Settin g L o catio n Settin g L o catio n
L evel (h ig h est Descrip tio n
fo r En d Users fo r Ad min istrato rs
to lo west
p rio rity)

S et in t he User
Web: From t he Language P ref erence
The language MicroS t rat egy icon, Manager. S ee
pref erence f or select Preferences . Selecting the U ser-
User-P roject level a user f or a
Developer: From t he Projec t Level
specif ic
Tools menu, select Language
project .
My Preferences . Preferenc e, page
1784 .

Web: From t he S et in t he User

The language MicroS t rat egy icon, E dit or. S ee Selecting
User-A ll P roject s pref erence f or a select Preferences . the U ser-All Projects
level user f or all Developer: From t he Level Language
project s. Tools menu, select Preferenc e, page
My Preferences . 1787 .

I n t he P roject
Conf igurat ion E dit or,
expand Languages ,
The language
select U ser
pref erence f or
P roject -A ll Users Preferences . S ee
all users in a Not applicable.
level Selecting the All
specif ic
U sers in Projec t
project .
Level Language
Preferenc e, page
1788 .

Developer level The int erf ace S et in t he Developer S et in t he Developer

© 2019, M icr o St r at egy In c. 1782

Syst em Ad m in ist r at io n Gu id e

L an g u ag e
Preferen ce
Settin g L o catio n Settin g L o catio n
L evel (h ig h est Descrip tio n
fo r En d Users fo r Ad min istrato rs
to lo west
p rio rity)

P ref erences dialog P ref erences dialog

language box. For st eps t o box. For st eps t o
pref erence f or specif y t his language, specif y t his language,
all users of see Selec ting the see Selecting the
Developer on D ev eloper Lev el D eveloper Level
t hat machine, Language Language
f or all project s. Preferenc e, page Preferenc e, page
1790 . 1790 .

On t he user's
machine and wit hin
t he user's browser
The language On t he user's set t ings. For st eps t o
pref erence f or machine and wit hin specif y t his language,
Machine level
all users on a t he user's browser see Selecting the
given machine. set t ings. Machine Level
Language
Preferenc e, page
1792 .

This is t he S et in t he P roject
project def ault Conf igurat ion E dit or.
language set For st eps t o specif y
f or MDI . I t is t his language, see
P roject Def ault
t he language Not applicable. C onfiguring the
level
pref erence f or Projec t D efault Lev el
all users Language
connect ed t o Preferenc e, page
t he met adat a. 1793 .

These l anguage preferences appl y to stri ngs renamed i n both the

metadata and the data w arehouse. H ow ever, Mi croStrategy handl es

1783 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

mi ssi ng l anguages di fferentl y, dependi ng upon w hether the stri ng i s

renamed i n the metadata or the data w arehouse:

l Metadata: When a name for an obj ect i n the metadata i s mi ssi ng i n

the preferred l anguage, the obj ect defaul t l anguage preference i s
used. For more i nformati on about the obj ect defaul t l anguage
preference, see Sel ecti ng the Obj ect D efaul t Language Preference,
page 1794.

l D ata warehouse: When a name for data i n the data w arehouse i s

mi ssi ng i n the preferred l anguage (the col umn or tabl e i s present i n
the data w arehouse but i s empty), the report returns no data.

The fol l ow i ng secti ons provi de steps to confi gure each preference
l evel , starti ng from the hi ghest pri ori ty and endi ng at the l ow est
pri ori ty.

Selecting the User-Project Level Language Preference

The U ser-Proj ect Level l anguage preference i s the l anguage

preference for a gi ven user for a speci fi ed proj ect. It i s the hi ghest
pri ori ty l anguage setti ng; to see the hi erarchy of l anguage preference
pri ori ti es, see the tabl e i n C onfi guri ng Metadata Obj ect and R eport
D ata Language Preferences, page 1781.

Thi s preference i s speci fi ed i n the U ser Language Preference

Manager i n D evel oper. U se the steps bel ow to set thi s preference.

If an objec t has an empty name in a us er's c hos en projec t language

preferenc e, the s y s tem defaults to dis play ing the objec t's default
language, s o it is not nec es s ary to add names for objec ts that are not
intended to be renamed.

© 2019, M icr o St r at egy In c. 1784

Syst em Ad m in ist r at io n Gu id e

Selecting the User-Project Level Language Preference

1. Log i n to D evel oper as a user w i th Admi ni strati ve pri vi l eges.

2. R i ght-cl i ck the proj ect that you w ant to set the l anguage
preference for and sel ect Project C onfiguration.

3. On the l eft si de of the Proj ect C onfi gurati on Edi tor, expand
Languages, and sel ect U ser Preferences.

4. On the ri ght si de, under U ser Language Preference Manager,

cl i ck Modify. The U ser Language Preference Manager opens,
show n bel ow :

5. In the C hoose a project to define user language preferences

drop dow n menu at the top l eft, sel ect the appropri ate proj ect.

6. Sel ect the users from the l i st on the l eft si de of the U ser
Language Preferences Manager that you w ant to change the
U ser-Proj ect l evel l anguage preference for, and cl i ck > to add

1785 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

them to the l i st on the ri ght. You can narrow the l i st of users

di spl ayed on the l eft by doi ng one of the fol l ow i ng:

l To search for users i n a speci fi c user group, sel ect the group
from the drop-dow n menu that i s under the C hoose a project
to define user language preferences drop-dow n menu.

l To search for users contai ni ng a certai n text stri ng, type the
text stri ng i n the Find fi el d, and cl i ck the Filter i con:

Thi s returns a l i st of users matchi ng the text stri ng you typed.

Prev ious s trings y ou hav e ty ped into the Find field c an be

ac c es s ed again by ex panding the Find drop-down menu.

7. On the ri ght si de, sel ect the user(s) that you w ant to change the
U ser-Proj ect l evel preferred l anguage for, and do the fol l ow i ng:

You c an s elec t more than one us er by holding CTRL

l Sel ect the desi red l anguage to be appl i ed to renamed

metadata obj ects from the drop-dow n menu i n the Metadata
col umn. Thi s l anguage w i l l be di spl ayed for the sel ected user
(s) w hen connecti ng to the sel ected proj ect.

l Sel ect the desi red l anguage to be appl i ed to report resul ts from
the drop-dow n menu i n the D ata col umn. Thi s l anguage w i l l be
di spl ayed for the sel ected user(s) w hen connecti ng to the
sel ected proj ect.

8. C l i ck OK .

Onc e the us er language preferenc es hav e been s av ed, us ers c an

no longer be remov ed from the Selected lis t.

9. C l i ck OK .

© 2019, M icr o St r at egy In c. 1786

Syst em Ad m in ist r at io n Gu id e

10. D i sconnect and reconnect to the proj ect source so that your
changes take effect. To do thi s, ri ght-cl i ck the proj ect source,
sel ect D isconnect from Project Source, then repeat thi s and
sel ect C onnect to Project Source.

Selecting the User-All Projects Level Language Preference

The U ser-Al l Proj ects l evel l anguage preference determi nes w hat
l anguage w i l l be appl i ed to al l proj ects that a speci fi c user sees w hen
connected to a proj ect source, unl ess a hi gher pri ori ty l anguage
preference has been speci fi ed for the user. U se the steps bel ow to set
thi s preference.

If the Us er-Projec t language preferenc e is s pec ified for the us er, the
us er will s ee the Us er-All Projec ts language only if the Us er-Projec t
language is not av ailable. To s ee the hierarc hy of language preferenc e
priorities , s ee the table in C onfi guri ng Metadata Obj ect and R eport
D ata Language Preferences, page 1781 .

Selecting the User-All Projects Level Language Preference

1. Log i n to D evel oper as a user w i th Admi ni strati ve pri vi l eges.

2. In the Fol der Li st on the l eft, w i thi n the appropri ate proj ect
source, expand A dministration, expand U ser Manager, and
navi gate to the user that you w ant to set the l anguage preference
for.

3. D oubl e-cl i ck the user.

4. On the l eft si de of the U ser Edi tor, expand the International

category and sel ect Language.

5. On the ri ght si de of the U ser Edi tor, do the fol l ow i ng:

1787 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l Sel ect the l anguage that you w ant to be appl i ed to renamed

metadata stri ngs from the D efault metadata language
preference for this user drop-dow n menu.

l Sel ect the l anguage that you w ant to be appl i ed to renamed

data w arehouse stri ngs from the D efault data language
preference for this user drop-dow n menu.

6. C l i ck OK .

7. D i sconnect and reconnect to the proj ect source so that your

changes take effect. To do thi s, ri ght-cl i ck the proj ect source,
sel ect D isconnect from Project Source, then repeat thi s and
sel ect C onnect to Project Source.

Selecting the All Users in Project Level Language Preference

The Al l U sers In Proj ect l evel l anguage preference determi nes the
l anguage that w i l l be di spl ayed for al l users that connect to a proj ect,
unl ess a hi gher pri ori ty l anguage i s speci fi ed for the user. U se the
steps bel ow to set thi s preference.

If the Us er-Projec t or Us er-All Projec ts language preferenc es are

s pec ified for the us er, the us er will s ee the All Us ers In Projec t language
only if the other two language preferenc es are not av ailable. To s ee the
hierarc hy of language preferenc e priorities , s ee the table in C onfi guri ng
Metadata Obj ect and R eport D ata Language Preferences, page
1781 .

Selecting the All Users in Project Level Language Preference

1. Log i n to D evel oper as a user w i th Admi ni strati ve pri vi l eges.

2. In the Fol der Li st on the l eft, sel ect the proj ect. From the
A dministration menu, sel ect Projects, then Project
C onfiguration.

© 2019, M icr o St r at egy In c. 1788

Syst em Ad m in ist r at io n Gu id e

3. On the l eft si de of the Proj ect C onfi gurati on Edi tor, expand
Language and sel ect U ser Preferences. The Language-U ser
Preferences di al og box i s di spl ayed, as show n bel ow :

4. D o the fol l ow i ng:

l From the Metadata language preference for all users in this

project drop-dow n menu, sel ect the l anguage that you w ant to
be di spl ayed for metadata obj ect names i n thi s proj ect.

l From the D ata language preference for all users in this

project drop-dow n menu, sel ect the l anguage that you w ant to
be di spl ayed for report resul ts i n thi s proj ect.

5. C l i ck OK .

6. D i sconnect and reconnect to the proj ect source so that your

changes take effect. To do thi s, ri ght-cl i ck the proj ect source,

1789 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

sel ect D isconnect from Project Source, then repeat thi s and
sel ect C onnect to Project Source.

Selecting the Developer Level Language Preference

The D evel oper l evel l anguage preference determi nes the defaul t
l anguage for al l obj ects di spl ayed w i thi n D evel oper, unl ess a hi gher
pri ori ty l anguage preference has been speci fi ed. Thi s i s the same as
the i nterface preference.

If the Us er-Projec t, Us er-All Projec ts , or All Us ers In Projec t language

preferenc es are s pec ified, the us er will s ee the Dev eloper language only
if the other three language preferenc es are not av ailable. To s ee the
hierarc hy of language preferenc e priorities , s ee the table in C onfi guri ng
Metadata Obj ect and R eport D ata Language Preferences, page
1781 .

Thi s l anguage preference must be confi gured to match one of tw o

other l anguage preferences: the Interface l anguage preference or the
Machi ne l evel l anguage preference. For i nformati on about the
Interface l anguage preference, see Sel ecti ng the Interface Language
Preference, page 1779. For i nformati on about the Machi ne l evel
l anguage preference, see Sel ecti ng the Machi ne Level Language
Preference, page 1792

Selecting the Developer Level Language Preference

1. Log i n to D evel oper as a user w i th Admi ni strati ve pri vi l eges.

2. From the Tools menu, sel ect Preferences.

3. Expand the International category and sel ect Language.The

Internati onal - Language di al og box opens, as show n bel ow :

© 2019, M icr o St r at egy In c. 1790

Syst em Ad m in ist r at io n Gu id e

4. Sel ect one of the fol l ow i ng from the Language for metadata and
warehouse data if user and project level preferences are set
to default drop-dow n menu.

l If you w ant the D evel oper l anguage preference to be the same

as the Interface l anguage preference, sel ect U se the same
language as MicroStrategy D eveloper.For i nformati on about
confi guri ng the Interface l anguage preference, see Selecting
the Interface Language Preference, page 1779.

l If you w ant the D evel oper l anguage preference to be the same

as the Machi ne-l evel l anguage preference, sel ect U se
language from R egional Settings. For i nformati on about
confi guri ng the Machi ne-l evel l anguage preference, see
Selecting the Machine Level Language Preference, page
1792.

1791 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

5. Sel ect the l anguage that you w ant to use as the defaul t
D evel oper i nterface l anguage from the Interface Language
drop-dow n menu.

6. C l i ck OK .

7. D i sconnect and reconnect to the proj ect source so that your

changes take effect. To do thi s, ri ght-cl i ck the proj ect source,
sel ect D isconnect from Project Source, then repeat thi s and
sel ect C onnect to Project Source.

Selecting the Machine Level Language Preference

Thi s preference determi nes the l anguage that i s used on al l obj ects
on the l ocal machi ne. Mi croStrategy Web uses the l anguage that i s
speci fi ed i n the user's w eb brow ser i f a l anguage i s not speci fi ed at a
l evel hi gher than thi s one.

l If the Us er-Projec t, Us er-All Projec ts , All Us ers In Projec t, or

Dev eloper language preferenc es are s pec ified, the us er will s ee the
Mac hine language only if the other four language preferenc es are not
av ailable. To s ee the hierarc hy of language preferenc e priorities , s ee
the table in C onfi guri ng Metadata Obj ect and R eport D ata
Language Preferences, page 1781 .

l A Mic roStrategy Dis tribution Serv ic es deliv ery (s uc h as an email, file,

or printer deliv ery ) us es a different language res olution logic : If the
Us er-Projec t, Us er-All Projec ts , All Us ers in Projec t, and Dev eloper
languages are not able to be dis play ed, the deliv ery defaults to the
Projec t Default lev el language preferenc e, followed by the Mac hine
lev el language preferenc e. This is bec aus e Dis tribution Serv ic es runs
without a c lient s es s ion in the Intelligenc e Serv er mac hine; if the
Mac hine lev el language took prec edenc e, all us ers rec eiv ing
deliv ered c ontent would rec eiv e that c ontent us ing the Intelligenc e
Serv er mac hine's language. Ins tead, the projec t's default language is
the fallbac k language for Dis tribution Serv ic es deliv eries .

© 2019, M icr o St r at egy In c. 1792

Syst em Ad m in ist r at io n Gu id e

To sel ect the Machi ne l evel l anguage preference on a Wi ndow s

machi ne, from the Start menu, sel ect C ontrol Panel, then R egional
and Language Options. C onsul t your machi ne's H el p for detai l s on
usi ng the l anguage opti ons.

Configuring the Project Default Level Language Preference

Thi s l anguage preference speci fi es the defaul t l anguage for the

proj ect. Thi s l anguage preference has the l ow est pri ori ty i n
determi ni ng the l anguage di spl ay. U se the steps bel ow to set thi s
preference.

l If the Us er-Projec t, Us er-All Projec ts , All Us ers In Projec t, Dev eloper,

or Mac hine-lev el language preferenc es are s pec ified, the us er will s ee
the Projec t Default language only if the other fiv e language
preferenc es are not av ailable. To s ee the hierarc hy of language
preferenc e priorities , s ee the table in C onfi guri ng Metadata Obj ect
and R eport D ata Language Preferences, page 1781 .

l A Mic roStrategy Dis tribution Serv ic es deliv ery (s uc h as an email, file,

or printer deliv ery ) us es a different language res olution logic : If the
Us er-Projec t, Us er-All Projec ts , All Us ers in Projec t, and Dev eloper
languages are not able to be dis play ed, the deliv ery defaults to the
Projec t Default lev el language preferenc e, followed by the Mac hine
lev el language preferenc e. This is bec aus e Dis tribution Serv ic es runs
without a c lient s es s ion in the Intelligenc e Serv er mac hine; if the
Mac hine lev el language took prec edenc e, all us ers rec eiv ing
deliv ered c ontent would rec eiv e that c ontent us ing the Intelligenc e
Serv er mac hine's language. Ins tead, the projec t's default language is
the fallbac k language for Dis tribution Serv ic es deliv eries .

Selecting the Project Default Language Preference

The projec t default language is s elec ted either when a projec t is firs t
c reated, or the firs t time metadata languages are enabled for the projec t.

1793 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

It c annot be c hanged after that point. The following s teps as s ume the
projec t default language has not y et been s elec ted.

1. Log i n to the proj ect as a user w i th Admi ni strati ve pri vi l eges.

2. Sel ect the proj ect for w hi ch you w ant to set the defaul t preferred
l anguage.

3. From the A dministration menu, sel ect Projects, then Project

C onfiguration.

4. On the l eft si de of the Proj ect C onfi gurati on Edi tor, expand
Language. D o one or both of the fol l ow i ng:

l To speci fy the defaul t metadata l anguage for the proj ect, sel ect
Metadata from the Language category. Then sel ect D efault for
the desi red l anguage.

l To speci fy the defaul t data l anguage for the proj ect, sel ect
D ata from the Language category. Then sel ect D efault for the
desi red l anguage.

5. C l i ck OK .

6. D i sconnect and reconnect to the proj ect source so that your

changes take effect. To do thi s, ri ght-cl i ck the proj ect source,
sel ect D isconnect from Project Source, then repeat thi s and
sel ect C onnect to Project Source.

Select in g t h e Ob ject Def au lt Lan gu age Pr ef er en ce

Each Mi croStrategy obj ect can have i ts ow n defaul t l anguage. The
obj ect defaul t l anguage i s used w hen the system cannot fi nd or
access a name for the obj ect i n the l anguage speci fi ed as the user or
proj ect preference.

Thi s preference i s useful especi al l y for personal obj ects, si nce most
personal obj ects are onl y used i n one l anguage, the ow ner's

© 2019, M icr o St r at egy In c. 1794

Syst em Ad m in ist r at io n Gu id e

l anguage. The obj ect defaul t l anguage can be set to any l anguage
supported by the proj ect i n w hi ch the obj ect resi des.

Some obj ects may not have thei r obj ect defaul t l anguage preference
set, for exampl e, i f obj ects are merged from an ol der Mi croStrategy
system that w as not set up for mul ti -tenancy i nto an upgraded system
that i s set up for mul ti -tenancy. In thi s case, for those obj ects that do
not have a defaul t l anguage, the system automati cal l y assi gns them
the proj ect's defaul t l anguage.

This is not true for newly c reated objec ts within an es tablis hed multi-
tenanc y env ironment. Newly c reated objec ts are automatic ally as s igned
the c reator's metadata language preferenc e. For details on the metadata
language, s ee C onfi guri ng Metadata Obj ect and R eport D ata
Language Preferences, page 1781 .

When dupl i cati ng a proj ect, obj ects i n the source that are set to take
the proj ect defaul t l anguage w i l l take w hatever the desti nati on
proj ect's defaul t l anguage i s.

U se the steps bel ow to confi gure the obj ect defaul t l anguage.

For the hierarc hy of language preferenc es , s ee the table in C onfi guri ng

Metadata Obj ect and R eport D ata Language Preferences, page
1781 .

Configuring the Object Default Language Preference

1. Log i n to the proj ect source that contai ns the obj ect as a user
w i th admi ni strati ve pri vi l eges.

2. R i ght-cl i ck the obj ect and sel ect Properties.

l You can set the defaul t l anguage for mul ti pl e obj ects by
hol di ng the C trl key w hi l e sel ecti ng mul ti pl e obj ects.

1795 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

3. Sel ect International.The Properti es - Internati onal di al og box i s

di spl ayed, as show n bel ow :

If the International option is mis s ing, the objec t is not s upported for
renaming. For ex ample, there is no reas on to rename a table name
for a s c hema objec t (s uc h as LU_YEAR), s o this objec t does not
hav e the International option av ailable.

4. From the Select the default language for the object drop-dow n
menu, sel ect the defaul t l anguage for the obj ect(s).

5. C l i ck OK .

Maintaining Your Multi-Tenant Environment

You can add or remove tenant l anguages from your Mi croStrategy
system, and you can edi t the obj ect names i n the system. Thi s secti on
al so covers securi ty and speci al i zed user rol es for obj ect renami ng.

© 2019, M icr o St r at egy In c. 1796

Syst em Ad m in ist r at io n Gu id e

Adding a New Tenant Language to the System

You can add new l anguages to Mi croStrategy. Once they are added,
new l anguages are then avai l abl e to be enabl ed for a proj ect. For
steps to add a new tenant l anguage, see Addi ng a N ew Tenant
Language to the System, page 1767.

Removing a Tenant Language from the System

A l anguage cannot be removed from the system i f i t i s bei ng used by
a proj ect, that i s, i f i t has been enabl ed to be supported for a proj ect.
To remove a tenant l anguage from a proj ect, that l anguage must fi rst
be di sabl ed from the proj ect, as descri bed i n the steps bel ow .

If a us er has s elec ted the language as a language preferenc e, the

preferenc e will no longer be in effec t onc e the language is dis abled. The
nex t lower priority language preferenc e will tak e effec t. To s ee the
language preferenc e priority hierarc hy , s ee C onfi guri ng Metadata
Obj ect and R eport D ata Language Preferences, page 1781 .

To Remove a Tenant Language from the System

1. D i sabl e the tenant l anguage from al l proj ects i n w hi ch i t w as

enabl ed. To di sabl e a metadata l anguage from a proj ect, see
Enabl i ng and D i sabl i ng Tenant Languages, page 1768.

2. For metadata l anguages, any names for the di sabl ed l anguage

are not removed from the metadata w i th these steps. To remove
names:

l For i ndi vi dual obj ects: Obj ects that contai n names for the
di sabl ed tenant l anguage must be modi fi ed and saved. You
can use the Search di al og box from the Tools menu i n
D evel oper to l ocate obj ects that have names for a gi ven tenant.
In the di al og box, on the Internati onal tab, cl i ck H elp for detai l s

1797 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

on setti ng up a search for these obj ects.

l For the enti re metadata: D upl i cate the proj ect after the tenant
l anguage has been removed, and do not i ncl ude the renamed
stri ngs i n the dupl i cated proj ect.

3. For obj ects that had the di sabl ed l anguage as thei r defaul t
l anguage, the fol l ow i ng scenari os occur. The scenari os assume
the proj ect defaul ts to Tenant A's l anguage, and Tenant B's
l anguage i s di sabl ed for the proj ect:

l If the obj ect's defaul t l anguage i s Tenant B's l anguage, and the
obj ect has names for both Tenant A and Tenant B, then, after
Tenant B's l anguage i s di sabl ed from the proj ect, the obj ect
w i l l onl y di spl ay Tenant A's names. The obj ect's defaul t
l anguage automati cal l y changes to Tenant A's l anguage.

l If the obj ect's defaul t l anguage i s Tenant B's l anguage and the
obj ect contai ns onl y Tenant B's names, then, after Tenant B's
l anguage i s di sabl ed from the proj ect, Tenant B's names w i l l
be di spl ayed but w i l l be treated by the system as i f they bel ong
to Tenant A's l anguage. The obj ect's defaul t l anguage
automati cal l y changes to Tenant A's l anguage.

For both scenari os above: If you l ater re-enabl e Tenant B's

l anguage for the proj ect, the obj ect's defaul t l anguage
automati cal l y changes back to Tenant B's l anguage as l ong as
no changes w ere made and saved for the obj ect w hi l e the
obj ect had Tenant A's l anguage as i ts defaul t l anguage. If
changes w ere made and saved to the obj ect w hi l e i t used
Tenant A's l anguage as i ts defaul t l anguage, and you w ant to
return the obj ect's defaul t l anguage back to Tenant B's
l anguage, you can do so manual l y: ri ght-cl i ck the obj ect, sel ect
Properties, sel ect Internationalization on the l eft, and choose
a new defaul t l anguage.

© 2019, M icr o St r at egy In c. 1798

 5
I NTELLIGENCE SERVER
STATISTICS D ATA
D ICTIONARY

© 2019, M icr o St r at egy In c. 1799

Syst em Ad m in ist r at io n Gu id e

Thi s secti on l i sts the stagi ng tabl es i n the stati sti cs reposi tory to
w hi ch Intel l i gence Server l ogs stati sti cs. The detai l ed i nformati on
i ncl udes the tabl e name, i ts functi on, the tabl e to w hi ch the data i s
moved i n the Enterpri se Manager reposi tory, and the tabl e's col umns.
For each col umn w e provi de the descri pti on and datatypes for D B2,
MySQL, SQL Server, Oracl e, Teradata, and Sybase databases. A
B old col umn name i ndi cates that i t i s a pri mary key, and (I) i ndi cates
that the col umn i s used i n an i ndex.

STG_CT_DEVICE_STATS
R ecords stati sti cs rel ated to the mobi l e cl i ent and the mobi l e devi ce.
Thi s tabl e i s used w hen the Mobile C lients opti on i s sel ected i n the
Stati sti cs category of the Proj ect C onfi gurati on Edi tor and the mobi l e
cl i ent i s confi gured to l og stati sti cs. The data l oad process moves thi s
tabl e's i nformati on to the C T_D EVIC E_STATS tabl e, w hi ch has the
same col umns and datatypes.

SQL
T erad Syb a MyS
Serve Oracle DB2
Descrip t ata se QL
Co lu mn r Dataty Dataty
io n Dataty Datat Datat
Datat pe pe
pe yp e yp e
yp e

Day t he
TI ME S
DA Y _I D act ion was DA TE DA TE DA TE DA TE DA TE
TA MP
st art ed.

Hour t he
TI NY I NUMB S MA LL B Y TE I TI NY I TI NY I
HOUR_I D act ion was
NT E R(3) I NT NT NT NT
st art ed.

Minut e
t he act ion S MA L NUMB S MA LL S MA LL S MA L S MA L
MI NUTE _I D
was LI NT E R(5) I NT I NT LI NT LI NT
st art ed.

1800 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serve Oracle DB2
Descrip t ata se QL
Co lu mn r Dataty Dataty
io n Dataty Datat Datat
Datat pe pe
pe yp e yp e
yp e

GUI D of
t he
I nt elligenc
CHA R CHA R CHA R CHA R CHA R CHA R
S E RV E RI D e S erver
(32) (32) (32) (32) (32) (32)
processing
t he
request .

Name of
t he
I nt elligen V A RC V A RC V A RC V A RC V A RC V A RC
S E RV E RMA
ce S erver HA R HA R2 HA R HA R HA R HA R
CHI NE
processin (255) (255) (255) (255) (255) (255)
g t he
request .

Unique
inst allat io
DE V I CE I NS CHA R CHA R CHA R CHA R CHA R CHA R
n I D of t he
TI D (40) (40) (40) (40) (40) (40)
mobile
app.

Type of
device t he
app is
V A RC V A RC V A RC V A RC V A RC V A RC
DE V I CE TY P inst alled
HA R HA R2 HA R HA R HA R HA R
E on, such
(40) (40) (40) (40) (40) (40)
as iP ad,
Droid, or
iP hone.

V A RC V A RCH V A RC V A RC
Operat ing V A RCH V A RCH
OS HA R A R2 HA R HA R
syst em of A R(40) A R(40)
(40) (40) (40) (40)

© 2019, M icr o St r at egy In c. 1801

Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serve Oracle DB2
Descrip t ata se QL
Co lu mn r Dataty Dataty
io n Dataty Datat Datat
Datat pe pe
pe yp e yp e
yp e

t he device
t he app is
inst alled
on, such
as iOS or
A ndroid.

V ersion of
t he
V A RC V A RC V A RC V A RC V A RC V A RC
operat ing
OS V E R HA R HA R2 HA R HA R HA R HA R
syst em,
(40) (40) (40) (40) (40) (40)
such as
5. 2. 1.

V ersion of
V A RC V A RCH V A RC V A RC
t he V A RCH V A RCH
APPVER HA R A R2 HA R HA R
MicroS t rat A R(40) A R(40)
(40) (40) (40) (40)
egy app.

A n int eger
value t hat
increment
s
whenever
t he device
S TA TE COU inf ormat io S MA L NUMB S MA LL S MA LL S MA L S MA L
NTE R n, such as LI NT E R(5) I NT I NT LI NT LI NT
DE V I CE T
Y P E , OS ,
OS V E R,
or
A P P V E R,
changes.

1802 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serve Oracle DB2
Descrip t ata se QL
Co lu mn r Dataty Dataty
io n Dataty Datat Datat
Datat pe pe
pe yp e yp e
yp e

Dat e and
t ime when
S TA TE CHA N S TA TE CO DA TE TI ME S TI ME S TI ME S DA TE DA TE
GE TI ME UNTE R is TI ME TA MP TA MP TA MP TI ME TI ME
increment
ed.

Timest am
p of when
t he record
was
writ t en t o
RE CORDTI t he DA TE TI ME S TI ME S TI ME S DA TE DA TE
ME dat abase, TI ME TA MP TA MP TA MP TI ME TI ME
according
to
dat abase
syst em
t ime.

STG_CT_EXEC_STATS
R ecords stati sti cs rel ated to executi on of reports/documents i n a
mobi l e app. Thi s tabl e i s used w hen the Mobile C lients opti on i s
sel ected i n the Stati sti cs category of the Proj ect C onfi gurati on Edi tor
and the mobi l e cl i ent i s confi gured to l og stati sti cs. The data l oad
process moves thi s tabl e's i nformati on to the C T_EXEC _STATS tabl e,
w hi ch has the same col umns and datatypes.

© 2019, M icr o St r at egy In c. 1803

Syst em Ad m in ist r at io n Gu id e

SQL
Syb a MyS
Serv Oracl T erad
DB2 se QL
Descrip ti er e ata
Co lu mn Data- Dat Dat
on Dat Data- Data-
typ e a- a-
a- typ e typ e
typ e typ e
typ e

Day t he TI ME
DA T DA T DA T
DAY_ID act ion was S TA M DA TE DA TE
E E E
st art ed. P

Hour t he
TI NY I NUMB S MA L B Y TE I TI NY I TI NY I
HOUR_I D act ion was
NT E R(3) LI NT NT NT NT
st art ed.

Minut e t he S MA S MA S MA
NUMB S MA L S MA L
MI NUTE _I D act ion was LLI N LLI N LLI N
E R(5) LI NT LI NT
st art ed. T T T

Unique
DEVICEINSTID inst allat ion CHA R CHA R CHA R CHA R CHA R CHA R
(I) I D of t he (40) (40) (40) (40) (40) (40)
mobile app.

A n int eger
value t hat
increment s
when t he
device
inf ormat io
n, such as S MA S MA S MA
S TA TE COUNT NUMB S MA L S MA L
DE V I CE TY LLI N LLI N LLI N
E R (I ) E R(5) LI NT LI NT
P E , OS , T T T
OS V E R, or
APPVER
(in S TG_
CT_
DE V I CE _
S TA TS ),

1804 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
Syb a MyS
Serv Oracl T erad
DB2 se QL
Descrip ti er e ata
Co lu mn Data- Dat Dat
on Dat Data- Data-
typ e a- a-
a- typ e typ e
typ e typ e
typ e

changes.

GUI D of t he
CHA R CHA R CHA R CHA R CHA R CHA R
US E RI D user making
(32) (32) (32) (32) (32) (32)
t he request .

GUI D of t he
session
t hat
execut ed
t he
request .
This should
be t he CHA CHA R CHA R CHA R CHA CHA
S E S S I ONI D
same as R(32) (32) (32) (32) R(32) R(32)
t he
S E S S I ONI
D f or t his
request in
S TG_I S _
RE P ORT_
S TA TS .

GUI D of t he
MicroS t rat e
gy Mobile
client
I NTE NUMB I NTE G I NTE G I NTE I NTE
CTSESSIONID session I D.
GE R E R(10) ER ER GE R GE R
A new client
session I D
is
generat ed

© 2019, M icr o St r at egy In c. 1805

Syst em Ad m in ist r at io n Gu id e

SQL
Syb a MyS
Serv Oracl T erad
DB2 se QL
Descrip ti er e ata
Co lu mn Data- Dat Dat
on Dat Data- Data-
typ e a- a-
a- typ e typ e
typ e typ e
typ e

every t ime a
user logs in
t o t he
mobile app.

ID
correspondi
ng t o t he
JOB I D (in
S TG_I S _
RE P ORT_ CHA CHA R CHA R CHA R CHA CHA
ME S S A GE I D
S TA TS ) of R(32) (32) (32) (32) R(32) R(32)
t he
message
generat ed
by t he
execut ion.

S imilar t o
JOB I D but
generat ed
by t he client
and cannot
be NULL.
S MA NUMB S MA L S MA L S MA S MA
ACTIONID The JOB I D
LLI NT E R(5) LI NT LI NT LLI NT LLI NT
may be
NULL if t he
user is
of f line
during
execut ion.

1806 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
Syb a MyS
Serv Oracl T erad
DB2 se QL
Descrip ti er e ata
Co lu mn Data- Dat Dat
on Dat Data- Data-
typ e a- a-
a- typ e typ e
typ e typ e
typ e

GUI D of t he
I nt elligence
S erver CHA CHA R CHA R CHA R CHA CHA
S E RV E RI D
processing R(32) (32) (32) (32) R(32) R(32)
t he
request .

Name of t he
machine
host ing t he VAR V A RC V A RC V A RC VAR VAR
S E RV E RMA CHI
I nt elligence CHA R HA R2 HA R HA R CHA R CHA R
NE
S erver (255) (255) (255) (255) (255) (255)
processing
t he request .

GUI D of t he
report used CHA CHA R CHA R CHA R CHA CHA
RE P ORTI D
in t he R(32) (32) (32) (32) R(32) R(32)
request .

GUI D of t he
document CHA R CHA R CHA R CHA R CHA R CHA R
DOCUME NTI D
used in t he (32) (32) (32) (32) (32) (32)
request .

GUI D of t he CHA CHA R CHA R CHA R CHA CHA

P ROJE CTI D
project . R(32) (32) (32) (32) R(32) R(32)

Name of t he
VAR V A RC V A RC V A RC VAR VAR
MS E RV E RMA C load
CHA R HA R2 HA R HA R CHA R CHA R
HI NE balancing
(255) (255) (255) (255) (255) (255)
machine.

© 2019, M icr o St r at egy In c. 1807

Syst em Ad m in ist r at io n Gu id e

SQL
Syb a MyS
Serv Oracl T erad
DB2 se QL
Descrip ti er e ata
Co lu mn Data- Dat Dat
on Dat Data- Data-
typ e a- a-
a- typ e typ e
typ e typ e
typ e

Time when
t he user
DA T TI ME TI ME TI ME DA T DA T
CTRE QUE S TTI submit s a
E TI M S TA M S TA M S TA M E TI M E TI M
ME request t o
E P P P E E
t he mobile
app.

Time when
t he mobile
app begins
CTRE CE I V E DTI receiving DA TE TI ME S TI ME S TI ME S DA TE DA TE
ME dat a f rom TI ME TA MP TA MP TA MP TI ME TI ME
MicroS t rat e
gy Mobile
S erver.

Dif f erence
bet ween
CTRequest
NUMB
CTRE QRE CTI M Time and I NTE I NTE I NTE I NTE I NTE
ER
E CTReceive GE R GE R GE R GE R GE R
(10)
dTime, in
millisecond
s.

Time when
CTRE NDE RS TA t he mobile DA TE TI ME S TI ME S TI ME S DA TE DA TE
RTTI ME app begins TI ME TA MP TA MP TA MP TI ME TI ME
rendering.

CTRE NDE RFI N Time when DA T TI ME TI ME TI ME DA T DA T

I S HTI ME t he mobile E TI M S TA M S TA M S TA M E TI M E TI M

1808 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
Syb a MyS
Serv Oracl T erad
DB2 se QL
Descrip ti er e ata
Co lu mn Data- Dat Dat
on Dat Data- Data-
typ e a- a-
a- typ e typ e
typ e typ e
typ e

app
f inishes E P P P E E
rendering.

Dif f erence
bet ween
CTRenderS
t art Time
CTRE NDE RTI M and I NTE NUMB I NTE G I NTE G I NTE I NTE
E CTRenderFi GE R E R(10) ER ER GE R GE R
nishTime,
in
millisecond
s.

Type of
report / docu
ment
execut ion:

• 1: User
execut io
n
E X E CUTI ONTY TI NY NUMB S MA L B Y TE I TI NY TI NY
PE
• 2: P re-
I NT E R(3) LI NT NT I NT I NT
cached
execut io
n

• 3:
A pplicat
ion
recovery

© 2019, M icr o St r at egy In c. 1809

Syst em Ad m in ist r at io n Gu id e

SQL
Syb a MyS
Serv Oracl T erad
DB2 se QL
Descrip ti er e ata
Co lu mn Data- Dat Dat
on Dat Data- Data-
typ e a- a-
a- typ e typ e
typ e typ e
typ e

execut io
n

• 4:
S ubscrip
t ion
cache
pre-
loading
execut io
n

• 5:
Transact
ion
subsequ
ent
act ion
execut io
n

• 6:
Report
queue
execut io
n

• 7:
Report
queue
recall
execut io
n

1810 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
Syb a MyS
Serv Oracl T erad
DB2 se QL
Descrip ti er e ata
Co lu mn Data- Dat Dat
on Dat Data- Data-
typ e a- a-
a- typ e typ e
typ e typ e
typ e

• 8: B ack
but t on
execut io
n

Whet her a
cache was
hit during
t he
execut ion,
and if so,
what t ype of
cache hit
occurred:

• 0: No
cache hit

• 1: TI NY I NUMB S MA L B Y TE I TI NY I TI NY I
CA CHE I ND
I nt ellige NT E R(3) LI NT NT NT NT
nce
S erver
cache hit

• 2:
Device
cache hit

• 6:
A pplicat i
on
memory
cache hit

© 2019, M icr o St r at egy In c. 1811

Syst em Ad m in ist r at io n Gu id e

SQL
Syb a MyS
Serv Oracl T erad
DB2 se QL
Descrip ti er e ata
Co lu mn Data- Dat Dat
on Dat Data- Data-
typ e a- a-
a- typ e typ e
typ e typ e
typ e

Whet her
t he report
or
document
is
prompt ed: TI NY
NUMB S MA L B Y TE I
P ROMP TI ND BIT BIT I NT
• 0: Not E R(1) LI NT NT
(1)
prompt e
d

• 1:
P rompt e
d

Whet her t he
job is f or a
report or a
document :
TI NY I NUMB S MA L B Y TE I TI NY I TI NY I
CTDA TA TY P E • 3:
NT E R(3) LI NT NT NT NT
Report

• 55:
Docume
nt

The t ype of
net work
used: VAR V A RC V A RC V A RC VAR VAR
CTNE TWORK T
• 3G CHA HA R2 HA R HA R CHA CHA
YPE
R(40) (40) (40) (40) R(40) R(40)
• WiFi

• LTE

1812 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
Syb a MyS
Serv Oracl T erad
DB2 se QL
Descrip ti er e ata
Co lu mn Data- Dat Dat
on Dat Data- Data-
typ e a- a-
a- typ e typ e
typ e typ e
typ e

• 4G

E st imat ed
net work I NTE NUMB I NTE G I NTE G I NTE I NTE
CTB A NDWI DTH
bandwidt h, GE R E R(10) ER ER GE R GE R
in kbps.

Time at
which t he
user eit her
clicks on
anot her DA T TI ME TI ME TI ME DA T DA T
V I E WFI NI S HTI
report / docu E TI M S TA M S TA M S TA M E TI M E TI M
ME
ment , or E P P P E E
navigat es
away f rom
t he mobile
app.

Dif f erence
bet ween
CTRenderFi
nishTime
I NTE NUMB I NTE G I NTE G I NTE I NTE
V I E WTI ME and
GE R E R(10) ER ER GE R GE R
V iewFinish
Time, in
millisecond
s.

A n int eger S MA S MA S MA
MA NI P ULA TI O NUMB S MA L S MA L
value t hat LLI N LLI N LLI N
NS E R(5) LI NT LI NT
T T T

© 2019, M icr o St r at egy In c. 1813

Syst em Ad m in ist r at io n Gu id e

SQL
Syb a MyS
Serv Oracl T erad
DB2 se QL
Descrip ti er e ata
Co lu mn Data- Dat Dat
on Dat Data- Data-
typ e a- a-
a- typ e typ e
typ e typ e
typ e

increases
wit h every
manipulat io
n t he user
makes af t er
t he
report / docu
ment is
rendered,
excluding
t hose t hat
require
f et ching
more dat a
f rom
I nt elligence
S erver
and/ or
result in
anot her
report / docu
ment
execut ion.

A verage
rendering
CTA V GMA NI P R t ime f or I NTE NUMB I NTE G I NTE G I NTE I NTE
E NDE RTI ME each GE R E R(10) ER ER GE R GE R
manipulat io
n.

RE P OS I TORY I GUI D of t he CHA CHA R CHA R CHA R CHA CHA

1814 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
Syb a MyS
Serv Oracl T erad
DB2 se QL
Descrip ti er e ata
Co lu mn Data- Dat Dat
on Dat Data- Data-
typ e a- a-
a- typ e typ e
typ e typ e
typ e

met adat a
D R(32) (32) (32) (32) R(32) R(32)
reposit ory.

Lat it ude of FLOA DOUB FLOA FLOA

CTLA TI TUDE FLOA T FLOA T
t he user. T LE T T

Longit ude FLO FLOA DOUB FLOA FLO FLO

CTLONGI TUDE
of t he user. AT T LE T AT AT

STG_CT_MANIP_STATS
R ecords stati sti cs rel ated to mani pul ati on of reports/documents i n a
mobi l e app. Thi s tabl e i s used w hen the Mobile C lients and Mobile
C lients Manipulations opti ons are sel ected i n the Stati sti cs category
of the Proj ect C onfi gurati on Edi tor and the mobi l e cl i ent i s confi gured
to l og stati sti cs. The data l oad process moves thi s tabl e's i nformati on
to the C T_MAN IP_STATS tabl e, w hi ch has the same col umns and
datatypes.

SQL
Oracl T erad Syb a MyS
Serv DB2
Descrip tio e ata se QL
Co lu mn er Data-
n Data- Data- Data- Data-
Data- typ e
typ e typ e typ e typ e
typ e

Day t he
TI ME S
DAY_ID act ion was DA TE DA TE DA TE DA TE DA TE
TA MP
st art ed.

© 2019, M icr o St r at egy In c. 1815

Syst em Ad m in ist r at io n Gu id e

SQL
Oracl T erad Syb a MyS
Serv DB2
Descrip tio e ata se QL
Co lu mn er Data-
n Data- Data- Data- Data-
Data- typ e
typ e typ e typ e typ e
typ e

Hour t he
TI NY I NUMB S MA LL B Y TE I TI NY I TI NY I
HOUR_I D act ion was
NT E R(3) I NT NT NT NT
st art ed.

Minut e t he S MA S MA
NUMB S MA L S MA L S MA
MI NUTE _I D act ion was LLI N LLI N
E R(5) LI NT LI NT LLI NT
st art ed. T T

Unique
DEVICEINSTI inst allat ion CHA R CHA R CHA R CHA R CHA R CHA R
D (I) I D of t he (40) (40) (40) (40) (40) (40)
mobile app.

A n int eger
value t hat
increment s
when t he
device
inf ormat ion,
such as S MA
S TA TE COU I NTE NUMB S MA L S MA L S MA
DE V I CE TY P LLI N
NTE R (I ) GE R E R(5) LI NT LI NT LLI NT
E , OS , T
OS V E R, or
A P P V E R (in
S TG_CT_
DE V I CE _
S TA TS ),
changes.

GUI D of t he
CHA R CHA R CHA R CHA R CHA R CHA R
US E RI D user making
(32) (32) (32) (32) (32) (32)
t he request .

1816 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
Oracl T erad Syb a MyS
Serv DB2
Descrip tio e ata se QL
Co lu mn er Data-
n Data- Data- Data- Data-
Data- typ e
typ e typ e typ e typ e
typ e

GUI D of t he
session t hat
execut ed t he
request . This
should be t he
same as t he CHA CHA R CHA R CHA R CHA CHA R
S E S S I ONI D
S E S S I ONI D R(32) (32) (32) (32) R(32) (32)
f or t his
request in
S TG_ I S _
RE P ORT_
S TA TS .

GUI D of t he
MicroS t rat eg
y Mobile
client session
I D. A new
CTSESSIONI client session CHA R NUMB I NTE G I NTE G I NTE I NTE
D I D is (32) E R(10) ER ER GE R GE R
generat ed
every t ime a
user logs in
t o t he mobile
app.

S imilar t o
JOB I D but
S MA
generat ed by I NTE NUMB S MA L S MA L S MA
ACTIONID LLI N
t he client GE R E R(5) LI NT LI NT LLI NT
T
and cannot
be NULL.

© 2019, M icr o St r at egy In c. 1817

Syst em Ad m in ist r at io n Gu id e

SQL
Oracl T erad Syb a MyS
Serv DB2
Descrip tio e ata se QL
Co lu mn er Data-
n Data- Data- Data- Data-
Data- typ e
typ e typ e typ e typ e
typ e

The JOB I D
may be NULL
if user is
of f line during
execut ion.

GUI D of t he
I nt elligence
CHA R CHA R CHA R CHA R CHA R CHA R
S E RV E RI D S erver
(32) (32) (32) (32) (32) (32)
processing
t he request .

Name of t he
machine
VAR VAR
host ing t he V A RC V A RC V A RC VAR
S E RV E RMA CHA CHA
I nt elligence HA R2 HA R HA R CHA R
CHI NE R R
S erver (255) (255) (255) (255)
(255) (255)
processing
t he request .

GUI D of t he
CHA R CHA R CHA R CHA R CHA R CHA R
RE P ORTI D report used in
(32) (32) (32) (32) (32) (32)
t he request .

GUI D of t he
DOCUME NT document CHA CHA R CHA R CHA R CHA CHA R
ID used in t he R(32) (32) (32) (32) R(32) (32)
request .

GUI D of t he CHA R CHA R CHA R CHA R CHA R CHA R

P ROJE CTI D
project . (32) (32) (32) (32) (32) (32)

MANIPSEQU The order in S MA NUMB S MA L S MA L S MA S MA

ENCEID which t he LLI N E R(5) LI NT LI NT LLI N LLI NT

1818 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
Oracl T erad Syb a MyS
Serv DB2
Descrip tio e ata se QL
Co lu mn er Data-
n Data- Data- Data- Data-
Data- typ e
typ e typ e typ e typ e
typ e

manipulat ion
s were made.
For each
manipulat io
n, t he mobile
client ret urns T T
a row, and
t he value in
t his column
increment s
f or each row.

Type of
manipulat ion:

• 0:
Unknown

• 1:
S elect or

• 2: P anel
S elect or
MA NI P TY P E S MA L NUMB S MA LL S MA LL S MA L S MA L
• 3: A ct ion
ID LI NT E R(5) I NT I NT LI NT LI NT
S elect or

• 4: Change
Layout

• 5: Change
V iew

• 6: S ort

• 7: P age
By

© 2019, M icr o St r at egy In c. 1819

Syst em Ad m in ist r at io n Gu id e

SQL
Oracl T erad Syb a MyS
Serv DB2
Descrip tio e ata se QL
Co lu mn er Data-
n Data- Data- Data- Data-
Data- typ e
typ e typ e typ e typ e
typ e

Name of t he
it em t hat was
manipulat ed.
VAR VAR
For example, V A RC V A RC V A RC VAR
MA NI P NA M CHA CHA
if a select or HA R2 HA R HA R CHA R
E R R
was clicked, (255) (255) (255) (255)
(255) (255)
t his is t he
name of t he
select or.

V alue of t he
it em t hat was
manipulat ed.
For example,
V A RC V A RC
if a panel V A RC V A RC V A RC V A RC
MA NI P V A LU HA R HA R
select or was HA R2 HA R HA R HA R
E (200 (200
clicked, t his (2000) (2000) (2000) (2000)
0) 0)
is t he name
of t he
select ed
panel.

I f t he value
f or
MA NI P V A LU
E is t oo long
t o f it in a S MA S MA
MANIPVALU NUMB S MA L S MA L S MA
single row, LLI N LLI N
ESEQ E R(5) LI NT LI NT LLI NT
t his T T
manipulat ion
is spread
over mult iple
rows, and

1820 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
Oracl T erad Syb a MyS
Serv DB2
Descrip tio e ata se QL
Co lu mn er Data-
n Data- Data- Data- Data-
Data- typ e
typ e typ e typ e typ e
typ e

t his value is
increment ed.

Time when
CTMA NI P S T t he user DA TE TI ME S TI ME S TI ME S DA TE DA TE
A RTTI ME submit s t he TI ME TA MP TA MP TA MP TI ME TI ME
manipulat ion.

Time when
t he mobile
app f inishes
processing
CTMA NI P FI DA TE TI ME S TI ME S TI ME S DA TE DA TE
t he
NI S HTI ME TI ME TA MP TA MP TA MP TI ME TI ME
manipulat ion
and f orwards
it f or
rendering.

Dif f erence
bet ween
CTMA NI P S T
A RTTI ME
CTMA NI P TI FLOA DOUB FLOA FLOA
and FLOA T FLOA T
ME T LE T T
CTMA NI P FI
NI S HTI ME ,
in
milliseconds.

GUI D of t he
RE P OS I TO CHA CHA R CHA R CHA R CHA CHA R
met adat a
RY I D R(32) (32) (32) (32) R(32) (32)
reposit ory.

A f lexible V A RC V A RC V A RC V A RC V A RC V A RC
DE TA I L1
column t o HA R HA R2 HA R HA R HA R HA R

© 2019, M icr o St r at egy In c. 1821

Syst em Ad m in ist r at io n Gu id e

SQL
Oracl T erad Syb a MyS
Serv DB2
Descrip tio e ata se QL
Co lu mn er Data-
n Data- Data- Data- Data-
Data- typ e
typ e typ e typ e typ e
typ e

capt ure
dif f erent (200 (200
(2000) (2000) (2000) (2000)
st at es of 0) 0)
manipulat ion.

A f lexible
column t o VAR VAR
VAR
capt ure CHA V A RC V A RC V A RC CHA
CHA R
DE TA I L2 dif f erent R HA R2 HA R HA R R
(200
st at es of (200 (2000) (2000) (2000) (200
0)
manipulat io 0) 0)
n.

Dat e and
t ime when
t his
RE CORDTI M inf ormat ion DA TE TI ME S TI ME S TI ME S DA TE DA TE
E was writ t en TI ME TA MP TA MP TA MP TI ME TI ME
t o t he
st at ist ics
dat abase.

STG_IS_CACHE_HIT_STATS
Tracks j ob executi ons that hi t the report cache. Thi s tabl e i s used
w hen the B asic Statistics opti on i s sel ected i n the Stati sti cs category
of the Proj ect C onfi gurati on Edi tor. The data l oad process moves thi s
tabl e's i nformati on to the IS_C AC H E_H IT_STATS tabl e, w hi ch has
the same col umns and datatypes.

1822 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serve Oracle DB2
Descri ata se QL
Co lu mn r Data- Data-
p tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

Day t he
job
execut i
TI ME S
DAY_ID on hit DA TE DA TE DA TE DA TE DA TE
TA MP
t he
report
cache.

Hour
t he job
execut i
TI NY I NUMB E S MA LL B Y TE I TI NY I TI NY I
HOUR_I D on hit
NT R(3) I NT NT NT NT
t he
report
cache.

Minut e
t he job
execut i
S MA L NUMB S MA LL S MA LL S MA L S MA L
MI NUTE _I D on hit
LI NT E R(5) I NT I NT LI NT LI NT
t he
report
cache.

A
sequent
CACHEINDEX ial I NTE NUMB E I NTE G I NTE G I NTE I NTE
(I) number GE R R(10) ER ER GE R GE R
f or t his
t able.

CACHESESSIO GUI D CHA R CHA R CHA R CHA R CHA R CHA R

NID (I) of t he (32) (32) (32) (32) (32) (32)

© 2019, M icr o St r at egy In c. 1823

Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serve Oracle DB2
Descri ata se QL
Co lu mn r Data- Data-
p tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

user
sessio
n.

GUI D of
t he
CHA R CHA R CHA R CHA R CHA R CHA R
S E RV E RI D server
(32) (32) (32) (32) (32) (32)
def init i
on.

Timest
amp
CA CHE HI TTI when DA TE TI ME S TI ME S TI ME S DA TE DA TE
ME (I ) t his TI ME TA MP TA MP TA MP TI ME TI ME
cache
is hit .

Type of
cache
hit :

• 0:
Rep
ort
CA CHE HI TTY cach TI NY I NUMB E S MA LL B Y TE I TI NY I TI NY I
P E (I ) e hit NT R(3) I NT NT NT NT

• 1 or
2:
Docu
ment
cach
e hit

1824 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serve Oracle DB2
Descri ata se QL
Co lu mn r Data- Data-
p tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

Job I D
t hat
CA CHE CRE A T I NTE NUMB I NTE G I NTE G I NTE I NTE
creat ed
ORJOB I D (I ) GE R E R(10) ER ER GE R GE R
t he
cache.

GUI D
f or t he
session
CRE A TORS E S CHA R CHA R CHA R CHA R CHA R CHA R
in which
S I ONI D (I ) (32) (32) (32) (32) (32) (32)
cache
was
creat ed.

Job I D
f or
part ial
cache
hit , or
docume
nt
parent
I NTE NUMB I NTE G I NTE G I NTE I NTE
JOB I D (I ) job I D if
GE R E R(10) ER ER GE R GE R
t he
cache
hit
originat
ed f rom
docume
nt child
report .

S TA RTTI ME Timest a DA TE TI ME S TI ME S TI ME S DA TE DA TE

© 2019, M icr o St r at egy In c. 1825

Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serve Oracle DB2
Descri ata se QL
Co lu mn r Data- Data-
p tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

mp of
when
TI ME TA MP TA MP TA MP TI ME TI ME
t he job
st art ed.

Timest
amp of
when
t he
record
was
writ t en
RE CORDTI ME t o t he DA TE TI ME S TI ME S TI ME S DA TE DA TE
(I ) dat aba TI ME TA MP TA MP TA MP TI ME TI ME
se,
accordi
ng t o
dat aba
se
syst em
t ime.

(S erver
machin
e V A RC V A RCH V A RCH V A RCH V A RC V A RC
S E RV E RMA C
name: p HA R A R2 AR AR HA R HA R
HI NE
ort (255) (255) (255) (255) (255) (255)
number)
pair.

GUI D
P ROJE CTI D CHA R CHA R CHA R CHA R CHA R CHA R
of t he
(I ) (32) (32) (32) (32) (32) (32)
project .

1826 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serve Oracle DB2
Descri ata se QL
Co lu mn r Data- Data-
p tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

GUI D of
t he
RE P OS I TORY I met ada CHA R CHA R CHA R CHA R CHA R CHA R
D ta (32) (32) (32) (32) (32) (32)
reposit o
ry.

The table below lis ts c ombinations of CACHEHITTYPE and J OBID that

c an oc c ur in the STG_IS_CACHE_HIT_STATS table and what thos e
c ombinations mean.

Cach e Hit T yp e Jo b ID Descrip tio n

0 -1 For a normal report , a f ull cache hit

0 Real JobI D For a normal report , a part ial cache hit

For a child report f rom a document , a f ull cache

1 P arent JobI D
hit , so no child report

For a child report f rom a document , a part ial

2 Child JobI D
cache hit , child report has a job

STG_IS_CUBE_REP_STATS
R ecords stati sti cs rel ated to Intel l i gent C ube mani pul ati ons. Thi s
tabl e i s not popul ated unl ess at l east one of the A dvanced Statistics
C ollection Options are sel ected i n the Stati sti cs category of the
Proj ect C onfi gurati on Edi tor. The data l oad process moves thi s tabl e's

© 2019, M icr o St r at egy In c. 1827

Syst em Ad m in ist r at io n Gu id e

i nformati on to the IS_C U BE_R EP_STATS tabl e, w hi ch has the same

col umns and datatypes.

SQL
T erad Syb a MySQ
Serve Oracle DB2
Descrip t ata se L
Co lu mn r Dataty Dataty
io n Dataty Datat Datat
Datat pe pe
pe yp e yp e
yp e

Day t he
act ion TI ME S
DA Y _I D (I ) DA TE DA TE DA TE DA TE DA TE
was TA MP
st art ed.

Hour t he
TI NY I NUMB E S MA LL B Y TE I TI NY I TI NY I
HOUR_I D act ion was
NT R(3) I NT NT NT NT
st art ed.

Minut e
t he act ion S MA L NUMB S MA LL S MA LL S MA L S MA L
MI NUTE _I D
was LI NT E R(5) I NT I NT LI NT LI NT
st art ed.

GUI D of
t he
session
t hat
CHA R CHA R CHA R CHA R CHA R CHA R
S E S S I ONI D execut ed
(32) (32) (32) (32) (32) (32)
t he act ion
on t he
I nt elligent
Cube.

Job I D f or
t he act ion
I NTE NUMB I NTE G I NTE G I NTE I NTE
JOB I D on t he
GE R E R(10) ER ER GE R GE R
I nt elligent
Cube.

P ROJE CTI D GUI D of CHA R CHA R CHA R CHA R CHA R CHA R

1828 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MySQ
Serve Oracle DB2
Descrip t ata se L
Co lu mn r Dataty Dataty
io n Dataty Datat Datat
Datat pe pe
pe yp e yp e
yp e

t he
(32) (32) (32) (32) (32) (32)
project .

Timest am
S TA RTTI M p of when DA TE TI ME S TI ME S TI ME S DA TE DA TE
E t he act ion TI ME TA MP TA MP TA MP TI ME TI ME
st art ed.

Timest am
p of when DA TE TI ME S TI ME S TI ME S DA TE DA TE
FI NI S HTI ME
t he act ion TI ME TA MP TA MP TA MP TI ME TI ME
f inished.

GUI D of
t he
I nt elligent
CUB E RE P O CHA R CHA R CHA R CHA R CHA R CHA R
Cube
RTGUI D (32) (32) (32) (32) (32) (32)
report
t hat was
execut ed.

GUI D of
t he
I nt elligent
CUB E I NS TA CHA R CHA R CHA R CHA R CHA R CHA R
Cube
NCE I D (32) (32) (32) (32) (32) (32)
inst ance
in
memory.

Type of
act ion
CUB E A CTI I NTE NUMB I NTE G I NTE G I NTE I NTE
against
ONI D GE R E R(10) ER ER GE R GE R
t he
I nt elligent

© 2019, M icr o St r at egy In c. 1829

Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MySQ
Serve Oracle DB2
Descrip t ata se L
Co lu mn r Dataty Dataty
io n Dataty Datat Datat
Datat pe pe
pe yp e yp e
yp e

Cube:

• 0:
Reserv
ed f or
MicroS
t rat egy
use

• 1:
Cube
P ublis
h

• 2:
Cube
V iew
Hit

• 3:
Cube
Dynam
ic
S ource
Hit

• 4:
Cube
A ppen
d

• 5:
Cube
Updat e

• 6:

1830 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MySQ
Serve Oracle DB2
Descrip t ata se L
Co lu mn r Dataty Dataty
io n Dataty Datat Datat
Datat pe pe
pe yp e yp e
yp e

Cube
Delet e

• 7:
Cube
Dest ro
y

I f a report
hit t he
I nt elligent
RE P ORTGU CHA R CHA R CHA R CHA R CHA R CHA R
Cube, t he
ID (32) (32) (32) (32) (32) (32)
GUI D of
t hat
report .

I f t he
I nt elligent
Cube is
published
or
CUB E K B S I I NTE NUMB I NTE G I NTE G I NTE I NTE
ref reshed,
ZE GE R E R(10) ER ER GE R GE R
t he size
of t he
I nt elligent
Cube in
KB.

I f t he
I nt elligent
CUB E ROWS I NTE NUMB E I NTE G I NTE G I NTE I NTE G
Cube is
I ZE GE R R(10) ER ER GE R ER
published
or

© 2019, M icr o St r at egy In c. 1831

Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MySQ
Serve Oracle DB2
Descrip t ata se L
Co lu mn r Dataty Dataty
io n Dataty Datat Datat
Datat pe pe
pe yp e yp e
yp e

ref reshed,
t he
number of
rows in
t he
I nt elligent
Cube.

Name of
t he
I nt elligen V A RC V A RCH V A RCH V A RCH V A RC V A RC
S E RV E RMA
ce S erver HA R A R2 AR AR HA R HA R
CHI NE
processin (255) (255) (255) (255) (255) (255)
g t he
request .

GUI D of
t he
RE P OS I TO CHA R CHA R CHA R CHA R CHA R CHA R
met adat a
RY I D (32) (32) (32) (32) (32) (32)
reposit or
y.

Timest am
p of when
t he record
was
writ t en t o
RE CORDTI t he DA TE TI ME S TI ME S TI ME S DA TE DA TE
ME dat abase, TI ME TA MP TA MP TA MP TI ME TI ME
according
to
dat abase
syst em
t ime.

1832 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

STG_IS_DOC_STEP_STATS
Tracks each step i n the document executi on process. Thi s tabl e i s
used w hen the D ocument Job Steps opti on i s sel ected i n the
Stati sti cs category of the Proj ect C onfi gurati on Edi tor. The data l oad
process moves thi s tabl e's i nformati on to the IS_D OC _STEP_STATS
tabl e, w hi ch has the same col umns and datatypes.

SQL
T erad a Syb a MySQ
Serve Oracle DB2
Descrip ta se L
Co lu mn r Data- Data-
tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

Day t he
documen
t was
TI ME S
DAY_ID request e DA TE DA TE DA TE DA TE DA TE
TA MP
d f or
execut io
n.

Hour t he
document
was
TI NY I NUMB E S MA LLI B Y TE I N TI NY I TI NY I
HOUR_I D request ed
NT R(3) NT T NT NT
f or
execut io
n.

Minut e
t he
documen
S MA L NUMB E S MA LL S MA LL S MA L S MA L
MI NUTE _I D t was
LI NT R(5) I NT I NT LI NT LI NT
request e
d f or
execut io

© 2019, M icr o St r at egy In c. 1833

Syst em Ad m in ist r at io n Gu id e

SQL
T erad a Syb a MySQ
Serve Oracle DB2
Descrip ta se L
Co lu mn r Data- Data-
tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

n.

GUI D of
t he I NTE G NUMB E I NTE G I NTE G I NTE G I NTE G
JOBID
document ER R(10) ER ER ER ER
job.

S equenc
e number
STEPSEQU TI NY I NUMB E S MA LL B Y TE I TI NY I TI NY I
f or a
ENCE NT R(3) I NT NT NT NT
job's
st eps.

GUI D of
CHA R CHA R CHA R CHA R CHA R CHA R
SESSIONID t he user
(32) (32) (32) (32) (32) (32)
session.

GUI D of
t he
CHA R CHA R CHA R CHA R CHA R CHA R
S E RV E RI D server
(32) (32) (32) (32) (32) (32)
def init io
n.

Type of
st ep. For
a
descript io
n, see
TI NY I NUMB E S MA LLI B Y TE I N TI NY I TI NY I
S TE P TY P E R eport
NT R(3) NT T NT NT
and
D oc umen
t Steps ,
page
1909 .

1834 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad a Syb a MySQ
Serve Oracle DB2
Descrip ta se L
Co lu mn r Data- Data-
tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

• 1:
Met ad
at a
object
reques
t st ep

• 2:
Close
job

• 3:
S QL
gener
at ion

• 4:
S QL
execut
ion

• 5:
A nalyt
ical
E ngin
e
server
t ask

• 6:
Resol
ut ion
server
t ask

© 2019, M icr o St r at egy In c. 1835

Syst em Ad m in ist r at io n Gu id e

SQL
T erad a Syb a MySQ
Serve Oracle DB2
Descrip ta se L
Co lu mn r Data- Data-
tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

• 7:
Report
net
server
t ask

• 8:
E leme
nt
reques
t st ep

• 9: Get
report
inst an
ce

• 10:
E rror
messa
ge
send
t ask

• 11:
Out put
messa
ge
send
t ask

• 12:
Find
report
cache

1836 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad a Syb a MySQ
Serve Oracle DB2
Descrip ta se L
Co lu mn r Data- Data-
tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

t ask

• 13:
Docu
ment
execut
ion
st ep

• 14:
Docu
ment
send
st ep

• 15:
Updat
e
report
cache
t ask

• 16:
Reque
st
execut
e st ep

• 17:
Dat a
mart
execut
e st ep

• 18:

© 2019, M icr o St r at egy In c. 1837

Syst em Ad m in ist r at io n Gu id e

SQL
T erad a Syb a MySQ
Serve Oracle DB2
Descrip ta se L
Co lu mn r Data- Data-
tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

Docu
ment
dat a
prepar
at ion

• 19:
Docu
ment
f ormat
t ing

• 20:
Docu
ment
manip
ulat ion

• 21:
A pply
view
cont ex
t

• 22:
E xport
engine

• 23:
Find
I nt elli
gent
Cube
t ask

1838 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad a Syb a MySQ
Serve Oracle DB2
Descrip ta se L
Co lu mn r Data- Data-
tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

• 24:
Updat
e
I nt elli
gent
Cube
t ask

• 25:
P ost -
proces
sing
t ask

• 26:
Delive
ry t ask

• 27:
P ersis
t
result
t ask

• 28:
Docu
ment
dat ase
t
execut
ion
t ask

S TA RTTI M DA TE TI ME S TI ME S TI ME S DA TE DA TE
Timest a
E TI ME TA MP TA MP TA MP TI ME TI ME

© 2019, M icr o St r at egy In c. 1839

Syst em Ad m in ist r at io n Gu id e

SQL
T erad a Syb a MySQ
Serve Oracle DB2
Descrip ta se L
Co lu mn r Data- Data-
tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

mp of t he
st ep's
st art
t ime.

Timest a
mp of t he
FI NI S HTI M DA TE TI ME S TI ME S TI ME S DA TE DA TE
st ep's
E TI ME TA MP TA MP TA MP TI ME TI ME
f inish
t ime.

Time
durat ion,
in
milliseco
nds,
QUE UE TI M bet ween I NTE NUMB E I NTE G I NTE G I NTE I NTE
E t he last GE R R(10) ER ER GE R GE R
st ep
f inish
and t he
next st ep
st art .

CP U
t ime, in
milliseco I NTE G NUMB E I NTE G I NTE G I NTE G I NTE G
CP UTI ME
nds, used ER R(10) ER ER ER ER
during
t his st ep.

S TE P DUR FI NI S HT I NTE NUMB E I NTE G I NTE G I NTE I NTE

A TI ON I ME GE R R(10) ER ER GE R GE R

1840 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad a Syb a MySQ
Serve Oracle DB2
Descrip ta se L
Co lu mn r Data- Data-
tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

minus
S TA RTTI
ME , in
milliseco
nds.

Timest a
mp of
when t he
record
was
writ t en t o
RE CORDTI DA TE TI ME S TI ME S TI ME S DA TE DA TE
t he
ME TI ME TA MP TA MP TA MP TI ME TI ME
dat abase,
according
to
dat abase
syst em
t ime.

(S erver
machine V A RC V A RCH V A RCH V A RCH V A RC V A RC
S E RV E RM
name: por HA R A R2 AR AR HA R HA R
A CHI NE
t number) (255) (255) (255) (255) (255) (255)
pair.

GUI D of
P ROJE CTI CHA R CHA R CHA R CHA R CHA R CHA R
t he
D (32) (32) (32) (32) (32) (32)
project .

GUI D of
t he
RE P OS I TO CHA R CHA R CHA R CHA R CHA R CHA R
met adat a
RY I D (32) (32) (32) (32) (32) (32)
reposit or
y.

© 2019, M icr o St r at egy In c. 1841

Syst em Ad m in ist r at io n Gu id e

STG_IS_DOCUMENT_STATS
Tracks document executi ons that the Intel l i gence Server processes.
Thi s tabl e i s used w hen the B asic Statistics opti on i s sel ected i n the
Stati sti cs category of the Proj ect C onfi gurati on Edi tor. The data l oad
process moves thi s tabl e's i nformati on to the IS_D OC U MEN T_STATS
tabl e, w hi ch has the same col umns and datatypes.

SQL
Oracl T erad Syb a MyS
Serv DB2
Descrip t e ata se QL
Co lu mn er Data-
io n Data- Data- Data- Data-
Data- typ e
typ e typ e typ e typ e
typ e

Day t he
document
was
TI ME S
DAY_ID request ed DA TE DA TE DA TE DA TE DA TE
TA MP
f or
execut io
n.

Hour t he
document
was
TI NY I NUMB S MA LL B Y TE I TI NY I TI NY I
HOUR_I D request ed
NT E R(3) I NT NT NT NT
f or
execut io
n.

Minut e
t he
document S MA S MA S MA
NUMB S MA L S MA L
MI NUTE _I D was LLI N LLI N LLI N
E R(5) LI NT LI NT
request ed T T T
f or
execut io

1842 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
Oracl T erad Syb a MyS
Serv DB2
Descrip t e ata se QL
Co lu mn er Data-
io n Data- Data- Data- Data-
Data- typ e
typ e typ e typ e typ e
typ e

n.

I NTE NUMB I NTE G I NTE G I NTE I NTE

JOBID (I) Job I D.
GE R E R(10) ER ER GE R GE R

GUI D of
CHA CHA R CHA R CHA R CHA CHA
SESSIONID (I) t he user
R(32) (32) (32) (32) R(32) R(32)
session.

GUI D of
t he
I nt elligen
ce
S erver's
CHA R CHA R CHA R CHA R CHA R CHA R
S E RV E RI D server
(32) (32) (32) (32) (32) (32)
def init ion
at t he
t ime of
t he
request .

S erver
VAR VAR VAR
machine V A RC V A RC V A RC
S E RV E RMA CHI CHA CHA CHA
name or HA R2 HA R HA R
NE R R R
IP (255) (255) (255)
(255) (255) (255)
address.

GUI D of
CHA R CHA R CHA R CHA R CHA R CHA R
P ROJE CTI D t he
(32) (32) (32) (32) (32) (32)
project .

GUI D of CHA CHA R CHA R CHA R CHA CHA

US E RI D
t heuser. R(32) (32) (32) (32) R(32) R(32)

DOCUME NTI D GUI D of CHA R CHA R CHA R CHA R CHA R CHA R

© 2019, M icr o St r at egy In c. 1843

Syst em Ad m in ist r at io n Gu id e

SQL
Oracl T erad Syb a MyS
Serv DB2
Descrip t e ata se QL
Co lu mn er Data-
io n Data- Data- Data- Data-
Data- typ e
typ e typ e typ e typ e
typ e

t he
(I ) documen (32) (32) (32) (32) (32) (32)
t.

The
t imest am
DA T DA T
RE QUE S TRE CT p at TI ME S TI ME S TI ME S DA TE
E TI M E TI M
I ME which t he TA MP TA MP TA MP TI ME
E E
request is
received.

Tot al
queue
RE QUE S TQUE U t ime of all I NTE NUMB I NTE G I NTE G I NTE I NTE
E TI ME st eps in GE R E R(10) ER ER GE R GE R
t his
request .

Time
durat ion
bet ween
request
receive
t ime and
document I NTE NUMB I NTE G I NTE G I NTE I NTE
S TA RTTI ME
job was GE R E R(10) ER ER GE R GE R

creat ed.

A n of f set
of t he
Request R
ecTime.

FI NI S HTI ME Time I NTE NUMB I NTE G I NTE G I NTE I NTE

1844 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
Oracl T erad Syb a MyS
Serv DB2
Descrip t e ata se QL
Co lu mn er Data-
io n Data- Data- Data- Data-
Data- typ e
typ e typ e typ e typ e
typ e

durat ion
bet ween
request
receive
t ime and
document
job last GE R E R(10) ER ER GE R GE R
st ep was
f inished.

A n of f set
of t he
Request R
ecTime.

E xecut ion
error
E X E CE RRORC code. I f I NTE NUMB I NTE G I NTE G I NTE I NTE
ODE no error, GE R E R(10) ER ER GE R GE R
t he value
is 0.

Number
of report s
included S MA L NUMB S MA LL S MA LL S MA L S MA L
RE P ORTCOUNT
in t he LI NT E R(5) I NT I NT LI NT LI NT
documen
t.

Was t he
document
CA NCE LI NDI CA NUMB S MA L B Y TE I TI NY I
job BIT BIT
TOR E R(1) LI NT NT NT(1)
cancele
d?

© 2019, M icr o St r at egy In c. 1845

Syst em Ad m in ist r at io n Gu id e

SQL
Oracl T erad Syb a MyS
Serv DB2
Descrip t e ata se QL
Co lu mn er Data-
io n Data- Data- Data- Data-
Data- typ e
typ e typ e typ e typ e
typ e

Number
of
P ROMP TI NDI CA S MA L NUMB S MA LL S MA LL S MA L S MA L
prompt s
TOR LI NT E R(5) I NT I NT LI NT LI NT
in t he
report .

Was t he
CA CHE DI NDI CA NUMB S MA L B Y TE I TI NY I
document BIT BIT
TOR E R(1) LI NT NT NT(1)
cached?

Timest am
p of when
t he record
was
writ t en t o
RE CORDTI ME t he DA TE TI ME S TI ME S TI ME S DA TE DA TE
(I ) dat abase, TI ME TA MP TA MP TA MP TI ME TI ME
according
to
dat abase
syst em
t ime.

CP U
t ime, in
milliseco
nds, used I NTE NUMB I NTE G I NTE G I NTE I NTE
CP UTI ME
f or GE R E R(10) ER ER GE R GE R
document
execut io
n.

Tot al TI NY I NUMB S MA LL B Y TE I TI NY I TI NY I
S TE P COUNT
NT E R(3) I NT NT NT NT

1846 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
Oracl T erad Syb a MyS
Serv DB2
Descrip t e ata se QL
Co lu mn er Data-
io n Data- Data- Data- Data-
Data- typ e
typ e typ e typ e typ e
typ e

number of
st eps
involved
in
execut ion
(not just
unique
st eps).

Durat ion
of
E X E CDURA TI O execut io I NTE NUMB I NTE G I NTE G I NTE I NTE
N n, in GE R E R(10) ER ER GE R GE R
milliseco
nds.

E rror
message
displayed V A RC V A RC V A RC
V A RC V A RC V A RC
E RRORME S S A t o t he HA R HA R HA R
HA R2 HA R HA R
GE user when (400 (400 (400
(4000) (4000) (4000)
an error is 0) 0) 0)
encount er
ed.

I nt elligen
ce
S erver-
relat ed I NTE I NTE G I NTE G I NTE G I NTE I NTE
E X E CA CTI ONS
act ions GE R ER ER ER GE R GE R
t hat need
t o t ake
place

© 2019, M icr o St r at egy In c. 1847

Syst em Ad m in ist r at io n Gu id e

SQL
Oracl T erad Syb a MyS
Serv DB2
Descrip t e ata se QL
Co lu mn er Data-
io n Data- Data- Data- Data-
Data- typ e
typ e typ e typ e typ e
typ e

during
document
execut io
n.

I nt elligen
ce S erver-
relat ed
processes
I NTE I NTE G I NTE G I NTE G I NTE I NTE
E X E CFLA GS needed t o
GE R ER ER ER GE R GE R
ref ine t he
document
execut io
n.

Tot al
t ime, in
milliseco
nds, t he
user
P ROMP TA NS TI I NTE NUMB I NTE G I NTE G I NTE I NTE
spent
ME GE R E R(10) ER ER GE R GE R
answerin
g prompt s
on t he
documen
t.

1 if t he
document
was TI NY I NUMB S MA LL B Y TE I TI NY I TI NY I
E X P ORTI NDC
export ed, NT E R(3) I NT NT NT NT
ot herwise
0.

1848 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
Oracl T erad Syb a MyS
Serv DB2
Descrip t e ata se QL
Co lu mn er Data-
io n Data- Data- Data- Data-
Data- typ e
typ e typ e typ e typ e
typ e

I f t he job
hit a
cache,
t he job I D
of t he job
CA CHE CRE A TO t hat I NTE NUMB I NTE G I NTE G I NTE I NTE
RJOB I D creat ed GE R E R(10) ER ER GE R GE R
t he cache
used by
t he
current
job.

I f t he job
hit a
cache,
t he GUI D
CA CHE CRE A TO CHA R CHA R CHA R CHA R CHA R CHA R
f or t he
RS E S S ONI D (32) (32) (32) (32) (32) (32)
session in
which t he
cache was
creat ed.

GUI D of
t he
CHA CHA R CHA R CHA R CHA CHA
RE P OS I TORY I D met adat a
R(32) (32) (32) (32) R(32) R(32)
reposit or
y.

For
CHA R CHA R CHA R CHA R CHA R CHA R
ME S S A GE I D MicroS t ra
(32) (32) (32) (32) (32) (32)
t egy use.

© 2019, M icr o St r at egy In c. 1849

Syst em Ad m in ist r at io n Gu id e

STG_IS_INBOX_ACT_STATS
R ecords stati sti cs rel ated to H i story Li st mani pul ati ons. Thi s tabl e i s
used w hen the Inbox Messages opti on i s sel ected i n the Stati sti cs
category of the Proj ect C onfi gurati on Edi tor. The data l oad process
moves thi s tabl e's i nformati on to the IS_IN BOX_AC T_STATS tabl e,
w hi ch has the same col umns and datatypes.

SQL
T erad Syb a MyS
Serve Oracle DB2
Descrip t ata se QL
Co lu mn r Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

Day t he
manipula TI ME S
DA Y _I D (I ) DA TE DA TE DA TE DA TE DA TE
t ion was TA MP
st art ed.

Hour t he
manipulat TI NY I NUMB S MA LL B Y TE I TI NY I TI NY I
HOUR_I D
ion was NT E R(3) I NT NT NT NT
st art ed.

Minut e
t he
S MA L NUMB S MA LL S MA LL S MA L S MA L
MI NUTE _I D manipula
LI NT E R(5) I NT I NT LI NT LI NT
t ion was
st art ed.

GUI D of
t he
session
S E S S I ONI D t hat CHA R CHA R CHA R CHA R CHA R CHA R
(I ) st art ed (32) (32) (32) (32) (32) (32)
t he
Hist ory
List

185 0 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serve Oracle DB2
Descrip t ata se QL
Co lu mn r Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

manipulat
ion.

GUI D of
t he server
def init ion
of t he
CHA R CHA R CHA R CHA R CHA R CHA R
S E RV E RI D I nt elligen
(32) (32) (32) (32) (32) (32)
ce S erver
being
manipula
t ed.

Name and
port
number of
t he
I nt elligen
V A RC V A RCH V A RCH V A RCH V A RC V A RC
S E RV E RMA C ce S erver
HA R A R2 AR AR HA R HA R
HI NE machine
(255) (255) (255) (255) (255) (255)
where t he
manipulat
ion is
t aking
place.

GUI D of
t he
project
CHA R CHA R CHA R CHA R CHA R CHA R
P ROJE CTI D where t he
(32) (32) (32) (32) (32) (32)
Hist ory
List
message

© 2019, M icr o St r at egy In c. 185 1

Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serve Oracle DB2
Descrip t ata se QL
Co lu mn r Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

is
mapped.

Type of
manipulat
ion:

• 0:
Reserv
ed f or
MicroS
t rat egy
use

• 1:
A dd:
A dd
messa
I NB OX A CTI O TI NY I NUMB S MA LL B Y TE I TI NY I TI NY I
ge t o
N NT E R(3) I NT NT NT NT
Hist ory
List

• 2:
Remov
e:
Remov
e
messa
ge
f rom
Hist ory
List

• 3:

185 2 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serve Oracle DB2
Descrip t ata se QL
Co lu mn r Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

Renam
e:
Renam
e
messa
ge

• 4:
E xecut
e:
E xecut
e
cont en
t s of
messa
ge

• 5:
Chang
e
S t at u
s:
Chang
e
messa
ge
st at us
f rom
Ready
to
Read

• 6:

© 2019, M icr o St r at egy In c. 185 3

Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serve Oracle DB2
Descrip t ata se QL
Co lu mn r Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

Reque
st ed:
Ret rie
ve
messa
ge
cont en
ts

• 7:
B at ch
Remov
e:
I nt ellig
ence
S erver
bulk
operat i
on,
such
as
cache
expirat
ion

I D of t he
user
CHA R CHA R CHA R CHA R CHA R CHA R
US E RI D doing t he
(32) (32) (32) (32) (32) (32)
manipula
t ion.

I D of t he CHA R CHA R CHA R CHA R CHA R CHA R

OWNE RI D
user t hat (32) (32) (32) (32) (32) (32)

185 4 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serve Oracle DB2
Descrip t ata se QL
Co lu mn r Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

creat ed
t he
message.

GUI D of
t he
Hist ory
CHA R CHA R CHA R CHA R CHA R CHA R
ME S S A GE I D List
(32) (32) (32) (32) (32) (32)
message
being
act ed on.

Name of
t he report
or
document V A RC V A RCH V A RCH V A RCH V A RC V A RC
ME S S A GE TI
ref erence HA R A R2 AR AR HA R HA R
TLE
d in t he (255) (255) (255) (255) (255) (255)
Hist ory
List
message.

User-
def ined
name of
t he
Hist ory V A RC V A RC V A RC V A RC V A RC V A RC
ME S S A GE DI
List HA R HA R2 HA R HA R HA R HA R
S P NA ME
message. (255) (255) (255) (255) (255) (255)
B lank
unless
t he user
has

© 2019, M icr o St r at egy In c. 185 5

Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serve Oracle DB2
Descrip t ata se QL
Co lu mn r Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

renamed
t he
Hist ory
List
message.

Dat e and
t ime when
t he
CRE A TI ONTI Hist ory DA TE TI ME S TI ME S TI ME S DA TE DA TE
ME List TI ME TA MP TA MP TA MP TI ME TI ME
message
was
creat ed.

Dat e and
t ime
when t he DA TE TI ME S TI ME S TI ME S DA TE DA TE
S TA RTTI ME
manipula TI ME TA MP TA MP TA MP TI ME TI ME
t ion
st art ed.

Report
job I D f or
t he
Hist ory
List
RE P ORTJOB I NTE NUMB I NTE G I NTE G I NTE I NTE
Message
I D (I ) GE R E R(10) ER ER GE R GE R
Cont ent
Request .
B lank if
no job
was

185 6 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serve Oracle DB2
Descrip t ata se QL
Co lu mn r Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

execut ed
or if a
document
was
execut ed.

Documen
t job I D
f or t he
Hist ory
List
Message
Cont ent
DOCUME NTJ Request . I NTE NUMB I NTE G I NTE G I NTE I NTE
OB I D (I ) B lank if GE R E R(10) ER ER GE R GE R
no job
was
execut ed
or if a
report
was
execut ed.

I D of t he
subscript i
on t hat
S UB S CRI P TI CHA R CHA R CHA R CHA R CHA R CHA R
invoked
ONI D (32) (32) (32) (32) (32) (32)
t he
manipulat
ion.

A CTI ONCOM • I f t he V A RC V A RC V A RC V A RC V A RC V A RC
ME NT HA R HA R2 HA R HA R HA R HA R

© 2019, M icr o St r at egy In c. 185 7

Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serve Oracle DB2
Descrip t ata se QL
Co lu mn r Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

manip
ulat ion
is a
bat ch
delet i
on of
Hist or
y List
messa
ges,
t his
f ield
cont ai
ns t he
condit i
on or
(4000) (4000) (4000) (4000) (4000) (4000)
S QL
st at e
ment
used
to
delet e
t he
messa
ges.

• If
t here
is an
error,
t his
f ield

185 8 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serve Oracle DB2
Descrip t ata se QL
Co lu mn r Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

holds
t he
error
messa
ge.

GUI D of
t he
RE P OS I TOR CHA R CHA R CHA R CHA R CHA R CHA R
met adat a
YID (32) (32) (32) (32) (32) (32)
reposit or
y.

Timest a
mp of
when t he
record
was
writ t en t o
RE CORDTI M DA TE TI ME S TI ME S TI ME S DA TE DA TE
t he
E TI ME TA MP TA MP TA MP TI ME TI ME
dat abase,
according
to
dat abase
syst em
t ime.

STG_IS_MESSAGE_STATS
R ecords stati sti cs rel ated to sendi ng messages through D i stri buti on
Servi ces. Thi s tabl e i s used w hen the Subscriptions opti on i s
sel ected i n the Stati sti cs category of the Proj ect C onfi gurati on Edi tor.

© 2019, M icr o St r at egy In c. 185 9

Syst em Ad m in ist r at io n Gu id e

The data l oad process moves thi s tabl e's i nformati on to the IS_
MESSAGE_STATS tabl e, w hi ch has the same col umns and datatypes.

SQL
Syb a
Serv Oracl T erad MyS
DB2 se
Descrip t er e ata QL
Co lu mn Data- Dat
io n Dat Data- Data- Data-
typ e a-
a- typ e typ e typ e
typ e
typ e

Day t he
job was
TI ME
request ed
DAY_ID DA TE S TA M DA TE DA TE DA TE DA TE
f or
P
execut io
n.

Hour t he
job was
TI NY I NUMB S MA L B Y TE I TI NY I TI NY I
HOUR_I D request ed
NT E R(3) LI NT NT NT NT
f or
execut ion.

Minut e
t he job
was S MA S MA S MA
NUMB S MA L S MA L
MI NUTE _I D request ed LLI N LLI N LLI N
E R(5) LI NT LI NT
f or T T T
execut io
n.

Message
GUI D
I NTE NUMB I NTE G I NTE G I NTE I NTE
MESSAGEINDEX used t o
GE R E R(10) ER ER GE R GE R
ident if y a
message.

GUI D of CHA CHA R CHA R CHA R CHA CHA

SESSIONID
t he user R(32) (32) (32) (32) R(32) R(32)

1860 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
Syb a
Serv Oracl T erad MyS
DB2 se
Descrip t er e ata QL
Co lu mn Data- Dat
io n Dat Data- Data- Data-
typ e a-
a- typ e typ e typ e
typ e
typ e

session
creat ed t o
generat e
t he
message.

Hist ory
List
message
I D. I f
t here is no

Hist ory
List
message
HI S TORY LI S TM associat e CHA R CHA R CHA R CHA R CHA R CHA R
E S S A GE I D d wit h t he (32) (32) (32) (32) (32) (32)
subscript i
on, t his
value is
00000000

00000000

00000000

00000000.

Job I D of
report / do
S CHE DULE JOB cument I NTE NUMB I NTE G I NTE G I NTE I NTE
ID execut ed GE R E R(10) ER ER GE R GE R
t o run t he

© 2019, M icr o St r at egy In c. 1861

Syst em Ad m in ist r at io n Gu id e

SQL
Syb a
Serv Oracl T erad MyS
DB2 se
Descrip t er e ata QL
Co lu mn Data- Dat
io n Dat Data- Data- Data-
typ e a-
a- typ e typ e typ e
typ e
typ e

subscript i
on
inst ance.
I f no job
is
creat ed,
t his value
is -1. I f a
f resh job
A is
creat ed
and it hit s
t he cache
of an old
job B ,
S CHE DU
LE JOB I D
t akes t he
value of
t he f resh
job A .

Type of
subscribe
d object :

• 3: TI NY I NUMB S MA L B Y TE I TI NY I TI NY I
DA TA TY P E
Report NT E R(3) LI NT NT NT NT

• 55:
Docum
ent

1862 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
Syb a
Serv Oracl T erad MyS
DB2 se
Descrip t er e ata QL
Co lu mn Data- Dat
io n Dat Data- Data- Data-
typ e a-
a- typ e typ e typ e
typ e
typ e

GUI D of
RE CI P I E NTCO t he CHA CHA R CHA R CHA R CHA CHA
NTA CTI D message R(32) (32) (32) (32) R(32) R(32)
recipient .

Type of
subscript i
on:

• 1:
E mail

• 2: File

• 4:
P rint er

• 8:
Cust o
m S MA L NUMB S MA L S MA L S MA L S MA L
DE LI V E RY TY P E
• 16: LI NT E R(5) LI NT LI NT LI NT LI NT
Hist ory
List

• 32:
Client

• 40:
Cache
updat e

• 128:
Mobile

• 100:

© 2019, M icr o St r at egy In c. 1863

Syst em Ad m in ist r at io n Gu id e

SQL
Syb a
Serv Oracl T erad MyS
DB2 se
Descrip t er e ata QL
Co lu mn Data- Dat
io n Dat Data- Data- Data-
typ e a-
a- typ e typ e typ e
typ e
typ e

Last
one

• 255:
A ll

S ubscript i
on
inst ance
CHA CHA R CHA R CHA R CHA CHA
S UB S I NS TI D GUI D
R(32) (32) (32) (32) R(32) R(32)
used t o
send t he
message.

S chedule
GUI D. I f
t here is no
schedule
associat e CHA R CHA R CHA R CHA R CHA R CHA R
S CHE DULE I D
d wit h t he (32) (32) (32) (32) (32) (32)
subscript i
on, t his
value is -
1.

Name of VAR VAR VAR

V A RC V A RC V A RC
t he CHA CHA CHA
S UB I NS TNA ME HA R2 HA R HA R
subscript i R R R
(255) (255) (255)
on. (255) (255) (255)

GUI D of
CHA R CHA R CHA R CHA R CHA R CHA R
DA TA I D t he dat a
(32) (32) (32) (32) (32) (32)
cont ent .

1864 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
Syb a
Serv Oracl T erad MyS
DB2 se
Descrip t er e ata QL
Co lu mn Data- Dat
io n Dat Data- Data- Data-
typ e a-
a- typ e typ e typ e
typ e
typ e

The
cont act
t ype f or
t his
TI NY NUMB S MA L B Y TE I TI NY TI NY I
CONTA CTTY P E subscript i
I NT E R(3) LI NT NT I NT NT
on
inst ance's
Recipient
I D.

Recipient '
s group I D
f or group
messages
RE CI P I E NTGRO CHA R CHA R CHA R CHA R CHA R CHA R
sent t o a
UP I D (32) (32) (32) (32) (32) (32)
Cont act
Collect ion
or a User
Group.

Name of
t he
VAR VAR VAR
cont act V A RC V A RC V A RC
RE CI P I E NTCO CHA CHA CHA
who HA R2 HA R HA R
NTA CTNA ME R R R
received (255) (255) (255)
(255) (255) (255)
t he
message.

Whet her
I S DE FA ULTA DD t he NUMB S MA L B Y TE I TI NY I
address BIT BIT
RE S S E R(1) LI NT NT NT(1)
t hat t he

© 2019, M icr o St r at egy In c. 1865

Syst em Ad m in ist r at io n Gu id e

SQL
Syb a
Serv Oracl T erad MyS
DB2 se
Descrip t er e ata QL
Co lu mn Data- Dat
io n Dat Data- Data- Data-
typ e a-
a- typ e typ e typ e
typ e
typ e

message
was sent
t o is t he
def ault
address of
a
MicroS t ra
t egy user:

• 0: No

• 1: Y es

GUI D of
t he
address
CHA CHA R CHA R CHA R CHA CHA
A DDRE S S I D t he
R(32) (32) (32) (32) R(32) R(32)
message
was sent
t o.

I D of t he
device t he
CHA R CHA R CHA R CHA R CHA R CHA R
DE V I CE I D message
(32) (32) (32) (32) (32) (32)
was sent
t o.

Whet her a
not if icat io
I S NOTI FI CA TI O n was NUMB S MA L B Y TE I TI NY I
BIT BIT
NME S S A GE sent : E R(1) LI NT NT NT(1)

• 0: No

1866 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
Syb a
Serv Oracl T erad MyS
DB2 se
Descrip t er e ata QL
Co lu mn Data- Dat
io n Dat Data- Data- Data-
typ e a-
a- typ e typ e typ e
typ e
typ e

• 1: Y es

A ddress
I D t he V A RC V A RC V A RC V A RC V A RC V A RC
NOTI FI CA TI ON
not if icat io HA R HA R2 HA R HA R HA R HA R
A DDR
n is sent (255) (255) (255) (255) (255) (255)
t o.

S erver
def init ion
GUI D
CHA CHA R CHA R CHA R CHA CHA
S E RV E RI D under
R(32) (32) (32) (32) R(32) R(32)
which t he
subscript i
on ran.

S erver
machine
name or
IP
V A RC V A RC V A RC V A RC V A RC V A RC
S E RV E RMA CHI address
HA R HA R2 HA R HA R HA R HA R
NE under
(255) (255) (255) (255) (255) (255)
which t he
report or
document
job ran.

P roject
GUI D
CHA CHA R CHA R CHA R CHA CHA
P ROJE CTI D under
R(32) (32) (32) (32) R(32) R(32)
which t he
dat a

© 2019, M icr o St r at egy In c. 1867

Syst em Ad m in ist r at io n Gu id e

SQL
Syb a
Serv Oracl T erad MyS
DB2 se
Descrip t er e ata QL
Co lu mn Data- Dat
io n Dat Data- Data- Data-
typ e a-
a- typ e typ e typ e
typ e
typ e

cont ent
resides.

Time at
which t he
E X E CS TA RTTI DA TE TI ME S TI ME S TI ME S DA TE DA TE
message
ME TI ME TA MP TA MP TA MP TI ME TI ME
creat ion
st art ed.

Time at
which t he DA T TI ME TI ME TI ME DA T
E X E CFI NI S H DA TE
message E TI M S TA M S TA M S TA M E TI M
TI ME TI ME
delivery E P P P E
f inished.

S t at us of
DE LI V E RY S TA T t he I NTE NUMB I NTE G I NTE G I NTE I NTE
US message GE R E R(10) ER ER GE R GE R
delivery.

E mail
address VAR VAR VAR
V A RC V A RC V A RC
P HY S I CA LA DD t he CHA CHA CHA
HA R2 HA R HA R
RE S S message R R R
(255) (255) (255)
was sent (255) (255) (255)
t o.

CHA R CHA R CHA R CHA R CHA R CHA R

B A TCHI D
(32) (32) (32) (32) (32) (32)

Timest am DA T TI ME TI ME TI ME DA T
DA TE
RE CORDTI ME p of when E TI M S TA M S TA M S TA M E TI M
TI ME
t he record E P P P E

1868 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
Syb a
Serv Oracl T erad MyS
DB2 se
Descrip t er e ata QL
Co lu mn Data- Dat
io n Dat Data- Data- Data-
typ e a-
a- typ e typ e typ e
typ e
typ e

was
writ t en t o
t he t able.

GUI D of
t he
CHA R CHA R CHA R CHA R CHA R CHA R
RE P OS I TORY I D met adat a
(32) (32) (32) (32) (32) (32)
reposit or
y.

STG_IS_PERF_MON_STATS
R ecords stati sti cs rel ated to noti fi cati on, di agnosti cs, and
performance counters l ogged by Intel l i gence Server. Thi s tabl e i s
used w hen the performance counters i n the D i agnosti cs and
Performance Moni tori ng Tool are confi gured to record stati sti cs
i nformati on. The data l oad process moves thi s tabl e's i nformati on to
the IS_PER F_MON _STATS tabl e, w hi ch has the same col umns and
datatypes.

SQL T erad a Syb as MySQ

Oracle DB2
Descrip Server ta e L
Co lu mn Dataty Dataty
tio n Datat Dataty Datat Datat
pe pe
yp e pe yp e yp e

Day t he
DA Y _I D TI ME S T
perf orma DA TE DA TE DA TE DA TE DA TE
(I ) A MP
nce

© 2019, M icr o St r at egy In c. 1869

Syst em Ad m in ist r at io n Gu id e

SQL T erad a Syb as MySQ

Oracle DB2
Descrip Server ta e L
Co lu mn Dataty Dataty
tio n Datat Dataty Datat Datat
pe pe
yp e pe yp e yp e

count er
was
recorde
d.

Hour t he
perf orma
nce TI NY I NUMB E S MA LLI B Y TE I N TI NY I TI NY I N
HOUR_I D
count er NT R(3) NT T NT T
was
recorded.

Minut e
t he
perf orma
MI NUT nce S MA L NUMB E S MA LLI S MA LLI S MA L S MA L
E _I D count er LI NT R(5) NT NT LI NT LI NT
was
recorde
d.

The
server
machine
S E RV E
t hat logs V A RC V A RCH V A RC V A RC
R_ V A RCH V A RCH
t he HA R A R2 HA R HA R
MA CHI N A R(255) A R(255)
not if icat i (255) (255) (255) (255)
E
on
messag
e.

The V A RC V A RCH V A RC V A RC
COUNTE cat egory V A RCH V A RCH
HA R A R2 HA R HA R
R_CA T of t he A R(255) A R(255)
(255) (255) (255) (255)

1870 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL T erad a Syb as MySQ

Oracle DB2
Descrip Server ta e L
Co lu mn Dataty Dataty
tio n Datat Dataty Datat Datat
pe pe
yp e pe yp e yp e

count er,
such as
Memory,
MicroS t r
at egy
S erver
Jobs, or
MicroS t r
at egy
S erver
Users.

COUNTE For
V A RC V A RCH V A RC V A RC
R_ MicroS t r V A RCH V A RCH
HA R A R2 HA R HA R
I NS TA NC at egy A R(255) A R(255)
(255) (255) (255) (255)
E use.

Name of
t he V A RC V A RCH V A RC V A RC
COUNTE V A RCH V A RCH
perf orma HA R A R2 HA R HA R
R_NA ME A R(255) A R(255)
nce (255) (255) (255) (255)
count er.

Timest a
mp of
when t he
event
E V E NT_ DA TE T TI ME S T TI ME S T TI ME S T DA TE T DA TE T
occurred
TI ME I ME A MP A MP A MP I ME I ME
in
I nt elligen
ce
S erver.

COUNTE Count er DOUB L

FLOA T FLOA T FLOA T FLOA T FLOA T
R_ value. E

© 2019, M icr o St r at egy In c. 1871

Syst em Ad m in ist r at io n Gu id e

SQL T erad a Syb as MySQ

Oracle DB2
Descrip Server ta e L
Co lu mn Dataty Dataty
tio n Datat Dataty Datat Datat
pe pe
yp e pe yp e yp e

V A LUE

Count er
CTR_ TI NY I NUMB E S MA LLI B Y TE I N TI NY I TI NY I N
value
V A L_TY P NT R(3) NT T NT T
t ype.

GUI D of
P ROJE C CHA R CHA R CHA R CHA R CHA R CHA R
t he
TI D (32) (32) (32) (32) (32) (32)
project .

Timest a
mp of
when t he
record
was
writ t en t o
RE CORD t he DA TE T TI ME S T TI ME S T TI ME S T DA TE T DA TE T
TI ME dat abas I ME A MP A MP A MP I ME I ME
e,
according
to
dat abase
syst em
t ime.

STG_IS_PR_ANS_STATS
R ecords stati sti cs rel ated to prompts and prompt answ ers. Thi s tabl e
i s used w hen the Prompts opti on i s sel ected i n the Stati sti cs
category of the Proj ect C onfi gurati on Edi tor. The data l oad process
moves thi s tabl e's i nformati on to the IS_PR _AN S_STATS tabl e, w hi ch
has the same col umns and datatypes.

1872 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad a Syb a MySQ
Serve Oracle DB2
Descri ta se L
Co lu mn r Dataty Dataty
p tio n Dataty Datat Datat
Datat pe pe
pe yp e yp e
yp e

Day t he
prompt
TI ME S
DAY_ID was DA TE DA TE DA TE DA TE DA TE
TA MP
answere
d.

Hour t he
prompt
TI NY I NUMB E S MA LLI B Y TE I N TI NY I TI NY I
HOUR_I D was
NT R(3) NT T NT NT
answere
d.

Minut e
t he
prompt S MA L NUMB E S MA LLI S MA LLI S MA L S MA L
MI NUTE _I D
was LI NT R(5) NT NT LI NT LI NT
answere
d.

Job I D
assigned I NTE G NUMB E I NTE GE I NTE GE I NTE G I NTE G
JOBID
by t he ER R(10) R R ER ER
server.

GUI D of
CHA R CHA R CHA R CHA R CHA R CHA R
SESSIONID t he user
(32) (32) (32) (32) (32) (32)
session.

Order in
which
PR_ prompt s S MA L NUMB E S MA LLI S MA LLI S MA L S MA L
ORDER_ID were LI NT R(5) NT NT LI NT LI NT
answere
d.

© 2019, M icr o St r at egy In c. 1873

Syst em Ad m in ist r at io n Gu id e

SQL
T erad a Syb a MySQ
Serve Oracle DB2
Descri ta se L
Co lu mn r Dataty Dataty
p tio n Dataty Datat Datat
Datat pe pe
pe yp e yp e
yp e

P rompt
order is
set in
Develop
er's
P rompt
Ordering
dialog
box.

S equen
ce I D.
ANS_SEQ_ For S MA L NUMB E S MA LLI S MA LLI S MA L S MA L
ID MicroS t r LI NT R(5) NT NT LI NT LI NT
at egy
use.

The
COM
object
t ype of
t he
object
t hat t he
P R_LOC_ prompt TI NY I NUMB E S MA LLI B Y TE I N TI NY I TI NY I
TY P E resides NT R(3) NT T NT NT
in:

• 1:
Filt er

• 2:
Temp
lat e

1874 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad a Syb a MySQ
Serve Oracle DB2
Descri ta se L
Co lu mn r Dataty Dataty
p tio n Dataty Datat Datat
Datat pe pe
pe yp e yp e
yp e

• 12:
A t t rib
ut e

I D of t he
object
P R_LOC_ t hat t he CHA R CHA R CHA R CHA R CHA R CHA R
ID prompt (32) (32) (32) (32) (32) (32)
resides
in.

Object
name of
t he
V A RC V A RCH V A RC V A RC
P R_LOC_ object V A RCH V A RCH
HA R A R2 HA R HA R
DE S C t hat t he A R(255) A R(255)
(255) (255) (255) (255)
prompt
resides
in.

GUI D of
CHA R CHA R CHA R CHA R CHA R CHA R
P R_GUI D t he
(32) (32) (32) (32) (32) (32)
prompt .

Name of V A RC V A RCH V A RC V A RC
V A RCH V A RCH
P R_NA ME t he HA R A R2 HA R HA R
A R(255) A R(255)
prompt . (255) (255) (255) (255)

P rompt
t it le.
V A RC V A RCH V A RCH V A RCH V A RC V A RC
This
P R_TI TLE HA R A R2 AR AR HA R HA R
cannot
(255) (255) (255) (255) (255) (255)
be

© 2019, M icr o St r at egy In c. 1875

Syst em Ad m in ist r at io n Gu id e

SQL
T erad a Syb a MySQ
Serve Oracle DB2
Descri ta se L
Co lu mn r Dataty Dataty
p tio n Dataty Datat Datat
Datat pe pe
pe yp e yp e
yp e

NULL.
This is
t he t ext
t hat is
displaye
d in
Develop
er's
P rompt
Ordering
dialog
box,
under
Tit le.

Type of
prompt .
For
exampl
e,
P R_A NS _ TI NY I NUMB E S MA LLI B Y TE I N TI NY I TI NY I
element ,
TY P E NT R(3) NT T NT NT
expressi
on,
object ,
or
numeric.

V A RCH
P rompt V A RC V A RCH V A RCH V A RC V A RC
P R_ A R2
answer HA R AR AR HA R HA R
A NS WE RS (4000
s. (4000) (4000) (4000) (4000) (4000)
CHA R)

P R_A NS _ For V A RC V A RCH V A RCH V A RCH V A RC V A RC

1876 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad a Syb a MySQ
Serve Oracle DB2
Descri ta se L
Co lu mn r Dataty Dataty
p tio n Dataty Datat Datat
Datat pe pe
pe yp e yp e
yp e

MicroS t r
HA R A R2 AR AR HA R HA R
GUI D at egy
(4000) (4000) (4000) (4000) (4000) (4000)
use.

Y: If a
prompt
answer
is
require
IS_ d. N: I f
CHA R CHA R CHA R CHA R CHA R CHA R
RE QUI RE D a
prompt
answer
is not
require
d.

GUI D of
t he
CHA R CHA R CHA R CHA R CHA R CHA R
S E RV E RI D server
(32) (32) (32) (32) (32) (32)
def init io
n.

GUI D of
P ROJE CTI CHA R CHA R CHA R CHA R CHA R CHA R
t he
D (32) (32) (32) (32) (32) (32)
project .

The
I nt ellige
V A RC V A RCH V A RC V A RC
S E RV E RM nce V A RCH V A RCH
HA R A R2 HA R HA R
A CHI NE S erver A R(255) A R(255)
(255) (255) (255) (255)
machine
name

© 2019, M icr o St r at egy In c. 1877

Syst em Ad m in ist r at io n Gu id e

SQL
T erad a Syb a MySQ
Serve Oracle DB2
Descri ta se L
Co lu mn r Dataty Dataty
p tio n Dataty Datat Datat
Datat pe pe
pe yp e yp e
yp e

and I P
address.

Timest a
mp of
S TA RTTI M DA TE TI ME S TI ME S TI ME S DA TE DA TE
t he job
E TI ME TA MP TA MP TA MP TI ME TI ME
st art
t ime.

Timest a
mp of
when t he
record
was
writ t en
RE CORDTI t o t he DA TE TI ME S T TI ME S T TI ME S T DA TE DA TE
ME dat abas TI ME A MP A MP A MP TI ME TI ME
e,
accordin
g to
dat abas
e syst em
t ime.

GUI D of
t he
RE P OS I TO met adat CHA R CHA R CHA R CHA R CHA R CHA R
RY I D a (32) (32) (32) (32) (32) (32)
reposit o
ry.

1878 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

STG_IS_PROJ_SESS_STATS
R ecords stati sti cs rel ated to proj ect sessi on. Thi s tabl e i s used w hen
the B asic Statistics opti on i s sel ected i n the Stati sti cs category of
the Proj ect C onfi gurati on Edi tor. The data l oad process moves thi s
tabl e's i nformati on to the IS_PR OJ_SESS_STATS tabl e, w hi ch has
the same col umns and datatypes.

SQL
T erad a Syb a MySQ
Serve Oracle DB2
Descri ta se L
Co lu mn r Data- Data-
p tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

Day t he
project
TI ME S
DA Y _I D session DA TE DA TE DA TE DA TE DA TE
TA MP
was
st art ed.

Hour t he
project
TI NY I NUMB E S MA LLI B Y TE I N TI NY I TI NY I
HOUR_I D session
NT R(3) NT T NT NT
was
st art ed.

Minut e
t he
project S MA L NUMB E S MA LLI S MA LLI S MA L S MA L
MI NUTE _I D
session LI NT R(5) NT NT LI NT LI NT
was
st art ed.

S ession
object CHA R CHA R CHA R CHA R CHA R CHA R
S E S S I ONI D GUI D. (32) (32) (32) (32) (32) (32)
This is

© 2019, M icr o St r at egy In c. 1879

Syst em Ad m in ist r at io n Gu id e

SQL
T erad a Syb a MySQ
Serve Oracle DB2
Descri ta se L
Co lu mn r Data- Data-
p tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

t he
same
session
I D used
in S TG_
IS_
SESSIO
N_
S TA TS .

If
yo
u
clo
se
an
d
reo
pe
n
t he
pro
jec
t
co
nn
ect
ion
wit
ho
ut

1880 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad a Syb a MySQ
Serve Oracle DB2
Descri ta se L
Co lu mn r Data- Data-
p tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

log
gin
g
out
f ro
m
I nt
elli
ge
nc
e
Se
rve
r,
t he
se
ssi
on
ID
is
reu
se
d.

S erver
CHA R CHA R CHA R CHA R CHA R CHA R
S E RV E RI D def init io
(32) (32) (32) (32) (32) (32)
n GUI D.

The
I nt ellige V A RC V A RCH V A RC V A RC
S E RV E RMA V A RCH V A RCH
nce HA R A R2 HA R HA R
CHI NE A R(255) A R(255)
S erver (255) (255) (255) (255)
machine

© 2019, M icr o St r at egy In c. 1881

Syst em Ad m in ist r at io n Gu id e

SQL
T erad a Syb a MySQ
Serve Oracle DB2
Descri ta se L
Co lu mn r Data- Data-
p tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

name
and I P
address.

GUI D of
t he user
CHA R CHA R CHA R CHA R CHA R CHA R
US E RI D perf orm
(32) (32) (32) (32) (32) (32)
ing t he
act ion.

P roject CHA R CHA R CHA R CHA R CHA R CHA R

P ROJE CTI D
GUI D. (32) (32) (32) (32) (32) (32)

Timest a
mp of
when
CONNE CTT DA TE TI ME S TI ME S TI ME S DA TE DA TE
t he
I ME TI ME TA MP TA MP TA MP TI ME TI ME
session
was
opened.

Timest a
mp of
when
DI S CONNE DA TE TI ME S T TI ME S T TI ME S T DA TE DA TE
t he
CTTI ME (I ) TI ME A MP A MP A MP TI ME TI ME
session
was
closed.

Timest a
mp of
RE CORDTI DA TE TI ME S TI ME S TI ME S DA TE DA TE
when
ME (I ) TI ME TA MP TA MP TA MP TI ME TI ME
t he
record

1882 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad a Syb a MySQ
Serve Oracle DB2
Descri ta se L
Co lu mn r Data- Data-
p tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

was
writ t en
t o t he
st at ist ic
s
dat abas
e.

GUI D of
t he
RE P OS I TO met adat CHA R CHA R CHA R CHA R CHA R CHA R
RY I D a (32) (32) (32) (32) (32) (32)
reposit o
ry.

STG_IS_REP_COL_STATS
Tracks the col umn-tabl e combi nati ons used i n the SQL duri ng report
executi ons. Thi s tabl e i s used w hen the R eport job tables/columns
accessed opti on i s sel ected i n the Stati sti cs category of the Proj ect
C onfi gurati on Edi tor. The data l oad process moves thi s tabl e's
i nformati on to the IS_R EP_C OL_STATS tabl e, w hi ch has the same
col umns and datatypes.

© 2019, M icr o St r at egy In c. 1883

Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serv Oracle DB2
Descrip ti ata se QL
Co lu mn er Data- Data-
on Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

Day t he
report was
TI ME S
DAY_ID request ed DA TE DA TE DA TE DA TE DA TE
TA MP
f or
execut ion.

Hour t he
report was
TI NY I NUMB S MA LL B Y TE I TI NY I TI NY I
HOUR_I D request ed
NT E R(3) I NT NT NT NT
f or
execut ion.

Minut e t he
report was
MI NUTE _ S MA L NUMB S MA LL S MA LL S MA L S MA L
request ed
ID LI NT E R(5) I NT I NT LI NT LI NT
f or
execut ion.

Report job I NTE NUMB I NTE G I NTE G I NTE I NTE

JOBID
I D. GE R E R(10) ER ER GE R GE R

GUI D of t he
CHA R CHA R CHA R CHA R CHA R CHA R
SESSIONID user
(32) (32) (32) (32) (23) (23)
session.

GUI D of t he
CHA R CHA R CHA R CHA R CHA R CHA R
S E RV E RI D server
(32) (32) (32) (32) (32) (32)
def init ion.

GUI D of t he
dat abase CHA R CHA R CHA R CHA R CHA R CHA R
TABLEID
t ables (32) (32) (32) (32) (32) (32)
used.

COLUMNI D GUI D of t he CHA R CHA R CHA R CHA R CHA R CHA R

1884 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serv Oracle DB2
Descrip ti ata se QL
Co lu mn er Data- Data-
on Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

columns
(32) (32) (32) (32) (32) (32)
used.

Descript ion
V A RC V A RC V A RC V A RC V A RC V A RC
COLUMNN of t he
HA R HA R2 HA R HA R HA R HA R
AME column
(255) (255) (255) (255) (255) (255)
used.

The S QL
clause in
SQLCLAUS TI NY I NUMB S MA LL B Y TE I TI NY I TI NY I
which t he
ETYPEID NT E R(3) I NT NT NT NT
column is
being used.

The number
of t imes a
specif ic
column/ t abl
e/ clause
I NTE NUMB I NTE G I NTE G I NTE I NTE
COUNTE R t ype
GE R E R(10) ER ER GE R GE R
combinat io
n occurs
wit hin a
report
execut ion.

Timest amp
S TA RTTI M DA TE TI ME S TI ME S TI ME S DA TE DA TE
of t he job
E TI ME TA MP TA MP TA MP TI ME TI ME
st art t ime.

Timest amp
RE CORDTI of when t he DA TE TI ME S TI ME S TI ME S DA TE DA TE
ME record was TI ME TA MP TA MP TA MP TI ME TI ME
writ t en t o

© 2019, M icr o St r at egy In c. 1885

Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serv Oracle DB2
Descrip ti ata se QL
Co lu mn er Data- Data-
on Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

t he
dat abase,
according
t o dat abase
syst em
t ime.

(S erver
machine V A RC V A RCH V A RCH V A RCH V A RC V A RC
S E RV E RM
name: port HA R A R2 AR AR HA R HA R
A CHI NE
number) (255) (255) (255) (255) (255) (255)
pair.

P ROJE CTI GUI D of t he CHA R CHA R CHA R CHA R CHA R CHA R

D project . (32) (32) (32) (32) (32) (32)

GUI D of t he
RE P OS I TO CHA R CHA R CHA R CHA R CHA R CHA R
met adat a
RY I D (32) (32) (32) (32) (32) (32)
reposit ory.

STG_IS_REP_SEC_STATS
Tracks executi ons that used securi ty fi l ters. Thi s tabl e i s used w hen
the B asic Statistics opti on i s sel ected i n the Stati sti cs category of
the Proj ect C onfi gurati on Edi tor. The data l oad process moves thi s
tabl e's i nformati on to the IS_R EP_SEC _STATS tabl e, w hi ch has the
same col umns and datatypes.

1886 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MySQ
Serve Oracle DB2
Descri ata se L
Co lu mn r Data- Data-
p tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

Day t he
job was
request TI ME S
DA Y _I D DA TE DA TE DA TE DA TE DA TE
ed f or TA MP
execut i
on.

Hour
t he job
was
TI NY I NUMB E S MA LLI B Y TE I TI NY I TI NY I
HOUR_I D request
NT R(3) NT NT NT NT
ed f or
execut i
on.

Minut e
t he job
was
S MA L NUMB S MA LL S MA LL S MA L S MA L
MI NUTE _I D request
LI NT E R(5) I NT I NT LI NT LI NT
ed f or
execut i
on.

I NTE G NUMB E I NTE G I NTE G I NTE G I NTE G

JOB I D (I ) Job I D.
ER R(10) ER ER ER ER

GUI D
of t he
S E S S I ONI D CHA R CHA R CHA R CHA R CHA R CHA R
user
(I ) (32) (32) (32) (32) (32) (32)
sessio
n.

S E CURI TY FI L S equen S MA L NUMB E S MA LLI S MA LLI S MA L S MA L

TE RS E Q LI NT R(5) NT NT LI NT LI NT

© 2019, M icr o St r at egy In c. 1887

Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MySQ
Serve Oracle DB2
Descri ata se L
Co lu mn r Data- Data-
p tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

ce
number
of t he
securit y
f ilt er,
when
mult iple
securit y
f ilt ers
are
used.

S erver
def init i CHA R CHA R CHA R CHA R CHA R CHA R
S E RV E RI D
on (32) (32) (32) (32) (32) (32)
GUI D.

S ecurit y
S E CURI TY FI L CHA R CHA R CHA R CHA R CHA R CHA R
f ilt er
TE RI D (I ) (32) (32) (32) (32) (32) (32)
GUI D.

Timest
amp of
DA TE TI ME S TI ME S TI ME S DA TE DA TE
S TA RTTI ME when
TI ME TA MP TA MP TA MP TI ME TI ME
t he job
st art ed.

Timest a
mp of
when DA TE TI ME S TI ME S TI ME S DA TE DA TE
RE CORDTI ME t he TI ME TA MP TA MP TA MP TI ME TI ME
record
was

1888 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MySQ
Serve Oracle DB2
Descri ata se L
Co lu mn r Data- Data-
p tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

writ t en
t o t he
dat abas
e,
accordi
ng t o
dat abas
e
syst em
t ime.

(S erver
machin
e V A RC V A RCH V A RCH V A RCH V A RC V A RC
S E RV E RMA C
name: p HA R A R2 AR AR HA R HA R
HI NE
ort (255) (255) (255) (255) (255) (255)
numbe
r) pair.

GUI D of
CHA R CHA R CHA R CHA R CHA R CHA R
P ROJE CTI D t he
(32) (32) (32) (32) (32) (32)
project .

GUI D
of t he
RE P OS I TOR met ada CHA R CHA R CHA R CHA R CHA R CHA R
YID ta (32) (32) (32) (32) (32) (32)
reposit
ory.

© 2019, M icr o St r at egy In c. 1889

Syst em Ad m in ist r at io n Gu id e

STG_IS_REP_SQL_STATS
Enabl es access to the SQL for a report executi on. Thi s tabl e i s used
w hen the R eport Job SQL opti on i s sel ected i n the Stati sti cs
category of the Proj ect C onfi gurati on Edi tor. The data l oad process
moves thi s tabl e's i nformati on to the IS_R EP_SQL_STATS tabl e,
w hi ch has the same col umns and datatypes.

SQL
T erad Syb a MyS
Serv Oracle DB2
Descri ata se QL
Co lu mn er Data- Data-
p tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

Day t he
S QL
TI ME S
DAY_ID pass DA TE DA TE DA TE DA TE DA TE
TA MP
was
st art ed.

Hour t he
S QL
TI NY I NUMB S MA LL B Y TE I TI NY I TI NY I
HOUR_I D pass
NT E R(3) I NT NT NT NT
was
st art ed.

Minut e
t he S QL
S MA L NUMB S MA LL S MA LL S MA L S MA L
MI NUTE _I D pass
LI NT E R(5) I NT I NT LI NT LI NT
was
st art ed.

I NTE NUMB I NTE G I NTE G I NTE I NTE

JOBID Job I D.
GE R E R(10) ER ER GE R GE R

S equen
SQLPASSSEQU S MA L NUMB S MA LL S MA LL S MA L S MA L
ce
ENCE LI NT E R(5) I NT I NT LI NT LI NT
number

1890 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serv Oracle DB2
Descri ata se QL
Co lu mn er Data- Data-
p tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

of t he
S QL
pass.

GUI D of
CHA R CHA R CHA R CHA R CHA R CHA R
SESSIONID t he user
(32) (32) (32) (32) (32) (32)
session.

GUI D of
t he
CHA R CHA R CHA R CHA R CHA R CHA R
S E RV E RI D server
(32) (32) (32) (32) (32) (32)
def init io
n.

S t art
t imest a
DA TE TI ME S TI ME S TI ME S DA TE DA TE
S TA RTTI ME mp of
TI ME TA MP TA MP TA MP TI ME TI ME
t he S QL
pass.

Finish
t imest a
DA TE TI ME S TI ME S TI ME S DA TE DA TE
FI NI S HTI ME mp of
TI ME TA MP TA MP TA MP TI ME TI ME
t he S QL
pass.

E xecut i
on t ime,
in
millisec I NTE NUMB I NTE G I NTE G I NTE I NTE
E X E CTI ME
onds, GE R E R(10) ER ER GE R GE R
f or t he
S QL
pass.

© 2019, M icr o St r at egy In c. 1891

Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serv Oracle DB2
Descri ata se QL
Co lu mn er Data- Data-
p tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

S QL
V A RC V A RC V A RC V A RC V A RC V A RC
S QLS TA TE ME used in
HA R HA R2 HA R HA R HA R HA R
NT t he
(4000) (4000) (4000) (4000) (4000) (4000)
pass.

Type of
S QL
pass:

• 0:
S QL
unkn
own

• 1:
S QL
selec
t

• 2:
S QLP A S S TY P TI NY I NUMB S MA LL B Y TE I TI NY I TI NY I
S QL
E NT E R(3) I NT NT NT NT
insert

• 3:
S QL
creat
e

• 4:
A nal
yt ical

• 5:
S ele
ct
int o

1892 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serv Oracle DB2
Descri ata se QL
Co lu mn er Data- Data-
p tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

• 6:
I nser
t int o
value
s

• 7:
Hom
ogen.
part it
ion
query

• 8:
Het er
ogen.
port e
nd
query

• 9:
Met a
dat a
port e
nd
pre-
query

• 10:
Met a
dat a
port e
nd
list

© 2019, M icr o St r at egy In c. 1893

Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serv Oracle DB2
Descri ata se QL
Co lu mn er Data- Data-
p tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

pre-
query

• 11:
E mpt
y

• 12:
Creat
e
index

• 13:
Met ri
c
qual.
break
by

• 14:
Met ri
c
qual.
t hres
hold

• 15:
Met ri
c
qual.

• 16:
User-
def in
ed

1894 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serv Oracle DB2
Descri ata se QL
Co lu mn er Data- Data-
p tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

• 17:
Hom
ogen.
port e
nd
loop

• 18:
Hom
ogen.
port e
nd
one
t bl

• 19:
Het er
ogen.
port e
nd
loop

• 20:
Het er
ogen.
port e
nd
one
t bl

• 21:
I nser
t
f ixed

© 2019, M icr o St r at egy In c. 1895

Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serv Oracle DB2
Descri ata se QL
Co lu mn er Data- Data-
p tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

value
s int o

• 22:
Dat a
mart
f rom
A nal
yt ical
E ngi
ne

• 23:
Clea
n up
t emp
resou
rces

• 24:
Ret ur
n elm
numb
er

• 25:
I ncre
ment
al
elem
brow
sing

• 26:
MDX

1896 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serv Oracle DB2
Descri ata se QL
Co lu mn er Data- Data-
p tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

query

• 27:
SAP
BI

• 28:
I nt ell
igent
Cube
inst r
uc

• 29:
Het er
ogen.
dat a
acce
ss

• 30:
E xcel
f ile
dat a
impo
rt

• 31:
Text
f ile
dat a
impo
rt

• 32:

© 2019, M icr o St r at egy In c. 1897

Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serv Oracle DB2
Descri ata se QL
Co lu mn er Data- Data-
p tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

Dat a
base
t able
impo
rt

• 33:
S QL
dat a
impo
rt

Number
of
TOTA LTA B LE A t ables S MA L NUMB S MA LL S MA LL S MA L S MA L
CCE S S E D hit by LI NT E R(5) I NT I NT LI NT LI NT
t he S QL
pass.

E rror
messag
e V A RC V A RCH V A RCH V A RCH V A RC V A RC
DB E RRORME S
ret urned HA R A R2 AR AR HA R HA R
S A GE
f rom (4000) (4000) (4000) (4000) (4000) (4000)
dat abas
e.

Timest a
mp of
when DA TE TI ME S TI ME S TI ME S DA TE DA TE
RE CORDTI ME t he TI ME TA MP TA MP TA MP TI ME TI ME
record
was

1898 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serv Oracle DB2
Descri ata se QL
Co lu mn er Data- Data-
p tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

writ t en
t o t he
dat abas
e,
accordi
ng t o
dat abas
e
syst em
t ime.

(S erver
machine
V A RC V A RCH V A RCH V A RCH V A RC V A RC
S E RV E RMA CH name: p
HA R A R2 AR AR HA R HA R
I NE ort
(255) (255) (255) (255) (255) (255)
number)
pair.

GUI D of
CHA R CHA R CHA R CHA R CHA R CHA R
P ROJE CTI D t he
(32) (32) (32) (32) (32) (32)
project .

GUI D of
t he
physical
DB I NS TA NCE I CHA R CHA R CHA R CHA R CHA R CHA R
dat abas
D (32) (32) (32) (32) (32) (32)
e
inst anc
e.

GUI D of
DB CONNE CTI CHA R CHA R CHA R CHA R CHA R CHA R
t he
ONI D (32) (32) (32) (32) (32) (32)
dat abas

© 2019, M icr o St r at egy In c. 1899

Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serv Oracle DB2
Descri ata se QL
Co lu mn er Data- Data-
p tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

e
connect
ion.

GUI D of
t he CHA R CHA R CHA R CHA R CHA R CHA R
DB LOGI NI D
dat abas (32) (32) (32) (32) (32) (32)
e login.

S equen
ce
number
SQLSTATEMEN TI NY I NUMB S MA LL B Y TE I TI NY I TI NY I
of t he
TSEQ NT E R(3) I NT NT NT NT
S QL
st at eme
nt .

GUI D of
t he
RE P OS I TORY I met adat CHA R CHA R CHA R CHA R CHA R CHA R
D a (32) (32) (32) (32) (32) (32)
reposit o
ry.

STG_IS_REP_STEP_STATS
Tracks each step i n the report executi on process. Thi s tabl e i s used
w hen the R eport Job Steps opti on i s sel ected i n the Stati sti cs
category of the Proj ect C onfi gurati on Edi tor. The data l oad process
moves thi s tabl e's i nformati on to the IS_R EP_STEP_STATS tabl e,
w hi ch has the same col umns and datatypes.

1900 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad a Syb a MySQ
Serve Oracle DB2
Descrip ta se L
Co lu mn r Data- Data-
tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

Day t he
report
was
TI ME S
DAY_ID request e DA TE DA TE DA TE DA TE DA TE
TA MP
d f or
execut io
n.

Hour t he
report
was
TI NY I NUMB E S MA LLI B Y TE I N TI NY I TI NY I
HOUR_I D request ed
NT R(3) NT T NT NT
f or
execut io
n.

Minut e
t he
report
was S MA L NUMB E S MA LL S MA LL S MA L S MA L
MI NUTE _I D
request e LI NT R(5) I NT I NT LI NT LI NT
d f or
execut io
n.

I NTE G NUMB E I NTE G I NTE G I NTE G I NTE G

JOBID Job I D.
ER R(10) ER ER ER ER

S equenc
e number
STEPSEQU TI NY I NUMB E S MA LL B Y TE I TI NY I TI NY I
f or a
ENCE NT R(3) I NT NT NT NT
job's
st eps.

© 2019, M icr o St r at egy In c. 1901

Syst em Ad m in ist r at io n Gu id e

SQL
T erad a Syb a MySQ
Serve Oracle DB2
Descrip ta se L
Co lu mn r Data- Data-
tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

GUI D of
CHA R CHA R CHA R CHA R CHA R CHA R
SESSIONID t he user
(32) (32) (32) (32) (32) (32)
session.

GUI D of
t he
I nt elligen
CHA R CHA R CHA R CHA R CHA R CHA R
S E RV E RI D ce S erver
(32) (32) (32) (32) (32) (32)
processin
g t he
request .

Type of
st ep. For
a
descript io
n, see
R eport
and
D oc umen
t Steps ,
page
TI NY I NUMB E S MA LLI B Y TE I N TI NY I TI NY I
S TE P TY P E 1909 .
NT R(3) NT T NT NT
• 1:
Met ad
at a
object
reques
t st ep

• 2:
Close
job

1902 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad a Syb a MySQ
Serve Oracle DB2
Descrip ta se L
Co lu mn r Data- Data-
tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

• 3:
S QL
gener
at ion

• 4:
S QL
execut
ion

• 5:
A nalyt
ical
E ngin
e
server
t ask

• 6:
Resol
ut ion
server
t ask

• 7:
Report
net
server
t ask

• 8:
E leme
nt
reques
t st ep

© 2019, M icr o St r at egy In c. 1903

Syst em Ad m in ist r at io n Gu id e

SQL
T erad a Syb a MySQ
Serve Oracle DB2
Descrip ta se L
Co lu mn r Data- Data-
tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

• 9: Get
report
inst an
ce

• 10:
E rror
messa
ge
send
t ask

• 11:
Out put
messa
ge
send
t ask

• 12:
Find
report
cache
t ask

• 13:
Docu
ment
execut
ion
st ep

• 14:
Docu
ment

1904 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad a Syb a MySQ
Serve Oracle DB2
Descrip ta se L
Co lu mn r Data- Data-
tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

send
st ep

• 15:
Updat
e
report
cache
t ask

• 16:
Reque
st
execut
e st ep

• 17:
Dat a
mart
execut
e st ep

• 18:
Docu
ment
dat a
prepar
at ion

• 19:
Docu
ment
f ormat
t ing

© 2019, M icr o St r at egy In c. 1905

Syst em Ad m in ist r at io n Gu id e

SQL
T erad a Syb a MySQ
Serve Oracle DB2
Descrip ta se L
Co lu mn r Data- Data-
tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

• 20:
Docu
ment
manip
ulat ion

• 21:
A pply
view
cont ex
t

• 22:
E xport
engine

• 23:
Find
I nt elli
gent
Cube
t ask

• 24:
Updat
e
I nt elli
gent
Cube
t ask

• 25:
P ost -
proces
sing

1906 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad a Syb a MySQ
Serve Oracle DB2
Descrip ta se L
Co lu mn r Data- Data-
tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

t ask

• 26:
Delive
ry t ask

• 27:
P ersis
t
result
t ask

• 28:
Docu
ment
dat ase
t
execut
ion
t ask

Timest a
mp of t he
S TA RTTI M DA TE TI ME S TI ME S TI ME S DA TE DA TE
st ep's
E TI ME TA MP TA MP TA MP TI ME TI ME
st art
t ime.

Timest a
mp of t he
FI NI S HTI M DA TE TI ME S TI ME S TI ME S DA TE DA TE
st ep's
E TI ME TA MP TA MP TA MP TI ME TI ME
f inish
t ime.

QUE UE TI M Time I NTE NUMB E I NTE G I NTE G I NTE I NTE

E GE R R(10) ER ER GE R GE R

© 2019, M icr o St r at egy In c. 1907

Syst em Ad m in ist r at io n Gu id e

SQL
T erad a Syb a MySQ
Serve Oracle DB2
Descrip ta se L
Co lu mn r Data- Data-
tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

durat ion
bet ween
last st ep
f inish
and t he
next st ep
st art , in
milliseco
nds.

CP U t ime
used
during
I NTE G NUMB E I NTE G I NTE G I NTE G I NTE G
CP UTI ME t his st ep,
ER R(10) ER ER ER ER
in
milliseco
nds.

FI NI S HT
I ME -
S TE P DUR S TA RTTI I NTE NUMB E I NTE G I NTE G I NTE I NTE
A TI ON ME , in GE R R(10) ER ER GE R GE R
milliseco
nds

Timest a
mp of
when t he
RE CORDTI record DA TE TI ME S TI ME S TI ME S DA TE DA TE
ME was TI ME TA MP TA MP TA MP TI ME TI ME
logged in
t he
dat abase,

1908 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad a Syb a MySQ
Serve Oracle DB2
Descrip ta se L
Co lu mn r Data- Data-
tio n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

according
to
dat abase
syst em
t ime

(S erver
machine V A RC V A RCH V A RCH V A RCH V A RC V A RC
S E RV E RM
name: por HA R A R2 AR AR HA R HA R
A CHI NE
t number) (255) (255) (255) (255) (255) (255)
pair.

GUI D of
P ROJE CTI CHA R CHA R CHA R CHA R CHA R CHA R
t he
D (32) (32) (32) (32) (32) (32)
project .

GUI D of
t he
RE P OS I TO CHA R CHA R CHA R CHA R CHA R CHA R
met adat a
RY I D (32) (32) (32) (32) (32) (32)
reposit or
y.

Report and Document Steps

Thi s IS_R EP_STEP_TYPE tabl e l i sts the Intel l i gence Server tasks
i nvol ved i n executi ng a report or a document. These are the possi bl e
val ues i n the STEPTYPE col umn i n the IS_R EP_STEP_STATS and
IS_D OC _STEP_STATS tabl es.

© 2019, M icr o St r at egy In c. 1909

Syst em Ad m in ist r at io n Gu id e

T ask n ame T ask d escrip tio n

1: MD Object Request Request ing an object def init ion f rom t he project met adat a.

2: Close Job Closing a job and removing it f rom t he list of pending jobs.

Generat ing S QL t hat is required t o ret rieve dat a, based on

3: S QL Generat ion
schema.

4: S QL E xecut ion E xecut ing S QL t hat was generat ed f or t he report .

A pplying analyt ical processing t o t he dat a ret rieved f rom

5: A nalyt ical E ngine
t he dat a source.

6: Resolut ion S erver Loading t he def init ion of an object .

7: Report Net S erver Transmit t ing t he result s of a report .

8: E lement Request B rowsing at t ribut e element s.

9: Get Report I nst ance Ret rieving a report inst ance f rom t he met adat a.

10: E rror Message

S ending an error message.
S end

11: Out put Message

S ending a message ot her t han an error message.
S end

12: Find Report Cache S earching or wait ing f or a report cache.

13: Document
E xecut ing a document
E xecut ion

14: Document S end Transmit t ing a document

15: Updat e Report

Updat ing report caches
Cache

16: Request E xecut e Request ing t he execut ion of a report

17: Dat a Mart E xecut e E xecut ing a dat a mart report

18: Document Dat a Const ruct ing a document st ruct ure using dat a f rom t he
P reparat ion document 's dat aset s

19: Document E xport ing a document t o t he request ed f ormat

1910 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

T ask n ame T ask d escrip tio n

Format t ing

20: Document
A pplying a user's changes t o a document
Manipulat ion

21: A pply V iew Cont ext Reserved f or MicroS t rat egy use

E xport ing a document or report t o P DF, plain t ext , E xcel

22: E xport E ngine
spreadsheet , or X ML

Locat ing t he cube inst ance f rom t he I nt elligent Cube

23: Find I nt elligent
Manager, when a subset report , or a st andard report t hat
Cube
uses dynamic caching, is execut ed.

24: Updat e I nt elligent Updat ing t he cube inst ance f rom t he I nt elligent Cube
Cube Manager, when republishing or ref reshing a cube.

25: P ost -processing Reserved f or MicroS t rat egy use.

Used by Dist ribut ion S ervices, f or email, f ile, or print er

26: Delivery
deliveries of subscribed-t o report s/ document s.

P ersist s execut ion result s, including Hist ory List and ot her
condit ion checks. A ll subscript ions hit t his st ep, alt hough
27: P ersist Result
only subscript ions t hat persist result s (such as Hist ory List )
perf orm act ions in t his st ep.

28: Document Dat aset

Wait ing f or child dat aset report s in a document t o execut e.
E xecut ion

STG_IS_REPORT_STATS
Tracks j ob-l evel stati sti cs i nformati on about every report that
Intel l i gence Server executes to compl eti on. Thi s tabl e i s used w hen
the B asic Statistics opti on i s sel ected i n the Stati sti cs category of
the Proj ect C onfi gurati on Edi tor. The data l oad process moves thi s
tabl e's i nformati on to the IS_R EPOR T_STATS tabl e, w hi ch has the
same col umns and datatypes.

© 2019, M icr o St r at egy In c. 1911

Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serv Oracle DB2
Descrip t ata se QL
Co lu mn er Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

Day t he
report was
TI ME S
DAY_ID request ed DA TE DA TE DA TE DA TE DA TE
TA MP
f or
execut ion.

Hour t he
report was
TI NY I NUMB S MA LL B Y TE I TI NY I TI NY I
HOUR_I D request ed
NT E R(3) I NT NT NT NT
f or
execut ion.

Minut e
t he report
was S MA L NUMB S MA LL S MA LL S MA L S MA L
MI NUTE _I D
request ed LI NT E R(5) I NT I NT LI NT LI NT
f or
execut ion.

I NTE NUMB I NTE G I NTE G I NTE I NTE

JOB ID (I ) Job I D.
GE R E R(10) ER ER GE R GE R

GUI D of
SESSION ID CHA R CHA R CHA R CHA R CHA R CHA R
t he user
(I ) (32) (32) (32) (32) (32) (32)
session.

GUI D of
t he
I nt elligenc
e S erver's CHA R CHA R CHA R CHA R CHA R CHA R
S E RV E RI D
server (32) (32) (32) (32) (32) (32)
def init ion
t hat made
t he

1912 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serv Oracle DB2
Descrip t ata se QL
Co lu mn er Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

request .

S erver
machine
name, or
IP
V A RC V A RC V A RC V A RC V A RC V A RC
S E RV E RMA C address if
HA R HA R2 HA R HA R HA R HA R
HI NE t he
(255) (255) (255) (255) (255) (255)
machine
name is
not
available.

GUI D of
CHA R CHA R CHA R CHA R CHA R CHA R
P ROJE CTI D t he
(32) (32) (32) (32) (32) (32)
project .

GUI D of CHA R CHA R CHA R CHA R CHA R CHA R

US E RI D
t he user. (32) (32) (32) (32) (32) (32)

GUI D of
t he report .

For an ad
hoc
report , t he
Templat e
CHA R CHA R CHA R CHA R CHA R CHA R
RE P ORTI D I D is
(32) (32) (32) (32) (32) (32)
creat ed on
t he f ly and
t here is no
correspon
ding
object

© 2019, M icr o St r at egy In c. 1913

Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serv Oracle DB2
Descrip t ata se QL
Co lu mn er Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

wit h t his
GUI D in
t he object
lookup
t able.

GUI D of CHA R CHA R CHA R CHA R CHA R CHA R

FI LTE RI D
t he f ilt er. (32) (32) (32) (32) (32) (32)

1 if an
embedded
f ilt er was
E MB E DDE DF S MA L NUMB S MA LL S MA LL S MA L S MA L
used in
I LTE R LI NT E R(5) I NT I NT LI NT LI NT
t he report ,
ot herwise
0.

GUI D of
t he
t emplat e.

For an ad
hoc
report ,
t he
CHA R CHA R CHA R CHA R CHA R CHA R
TE MP LA TE I D Templat e
(32) (32) (32) (32) (32) (32)
I D is
creat ed
on t he f ly,
and t here
is no
correspon
ding

1914 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serv Oracle DB2
Descrip t ata se QL
Co lu mn er Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

object
wit h t his
GUI D in
t he object
lookup
t able.

1 if an
embedded
t emplat e
E MB E DDE DT was used S MA L NUMB S MA LL S MA LL S MA L S MA L
E MP LA TE in t he LI NT E R(5) I NT I NT LI NT LI NT
report ,
ot herwise
0.

Job I D of
t he parent
document
job, if t he
current
job is a
document
P A RE NTJOB I job's I NTE NUMB I NTE G I NTE G I NTE I NTE
D (I ) child. GE R E R(10) ER ER GE R GE R
-1 if t he
current
job is not
a
document
job's
child.

© 2019, M icr o St r at egy In c. 1915

Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serv Oracle DB2
Descrip t ata se QL
Co lu mn er Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

GUI D f or
t he
DB I NS TA NCE CHA R CHA R CHA R CHA R CHA R CHA R
physical
ID (32) (32) (32) (32) (32) (32)
dat abase
inst ance.

Dat abase
user I D
f or t he CHA R CHA R CHA R CHA R CHA R CHA R
DB US E RI D
physical (32) (32) (32) (32) (32) (32)
dat abase
inst ance.

1 if t his
job is a
P A RE NTI NDI document NUMB S MA LL B Y TE I TI NY I
BIT BIT
CA TOR job's child, E R(1) I NT NT NT(1)
ot herwise
0.

Timest am
p when
RE QUE S TRE DA TE TI ME S TI ME S TI ME S DA TE DA TE
t he
CTI ME TI ME TA MP TA MP TA MP TI ME TI ME
request is
received.

Tot al
queue
RE QUE S TQU t ime of all I NTE NUMB I NTE G I NTE G I NTE I NTE
E UE TI ME st eps in GE R E R(10) ER ER GE R GE R
t his
request .

E X E CS TA RT Time I NTE NUMB I NTE G I NTE G I NTE I NTE

1916 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serv Oracle DB2
Descrip t ata se QL
Co lu mn er Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

passed
bef ore t he
f irst st ep
st art ed.
TI ME GE R E R(10) ER ER GE R GE R
A n of f set
of t he
Request R
ecTime.

Time
passed
when t he
last st ep
E X E CFI NI S H is I NTE NUMB I NTE G I NTE G I NTE I NTE
TI ME f inished. GE R E R(10) ER ER GE R GE R
A n of f set
of t he
Request R
ecTime.

Number of
S MA L NUMB S MA LL S MA LL S MA L I NTE
S QLP A S S E S S QL
LI NT E R(5) I NT I NT LI NT GE R
passes.

Job error
JOB E RRORC code. I f no I NTE NUMB I NTE G I NTE G I NTE I NTE
ODE error, t he GE R E R(10) ER ER GE R GE R
value is 0.

1 if t he
CA NCE LI NDI job was NUMB S MA LL B Y TE I TI NY I
BIT BIT
CA TOR canceled, E R(1) I NT NT NT(1)
ot herwise

© 2019, M icr o St r at egy In c. 1917

Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serv Oracle DB2
Descrip t ata se QL
Co lu mn er Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

0.

1 if t he
report was
ad hoc,
ot herwise
0. This
includes
any
execut ed
job t hat is
not saved
in t he
project as
A DHOCI NDI C a report NUMB S MA LL B Y TE I TI NY I
BIT BIT
A TOR (f or E R(1) I NT NT NT(1)
example:
drilling
result s,
at t ribut e
element
prompt s,
creat ing
and
running a
report
bef ore
saving it ).

Number of
P ROMP TI NDI prompt s S MA L NUMB S MA LL S MA LL S MA L S MA L
CA TOR in t he LI NT E R(5) I NT I NT LI NT LI NT
report .

1918 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serv Oracle DB2
Descrip t ata se QL
Co lu mn er Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

1 if t he
report
DA TA MA RTI N creat ed a NUMB S MA LL B Y TE I TI NY I
BIT BIT
DI CA TOR dat a mart , E R(1) I NT NT NT(1)
ot herwise
0.

1 if t he
report was
a result of
E LE ME NTLO an NUMB S MA LL B Y TE I TI NY I
BIT BIT
A DI NDI C element E R(1) I NT NT NT(1)
browse,
ot herwise
0.

1 if t he
report was
DRI LLI NDI CA t he result NUMB S MA LL B Y TE I TI NY I
BIT BIT
TOR of a drill, E R(1) I NT NT NT(1)
ot herwise
0.

1 if t he
report was
S CHE DULE I N run f rom a NUMB S MA LL B Y TE I TI NY I
BIT BIT
DI CA TOR schedule, E R(1) I NT NT NT(1)
ot herwise
0.

1 if t he
CA CHE CRE A NUMB S MA LL B Y TE I TI NY I
report BIT BIT
TE I NDI C E R(1) I NT NT NT(1)
creat ed a

© 2019, M icr o St r at egy In c. 1919

Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serv Oracle DB2
Descrip t ata se QL
Co lu mn er Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

cache,
ot herwise
0.

Query
P RI ORI TY NU execut ion S MA L NUMB S MA LL S MA LL S MA L S MA L
MB E R st ep LI NT E R(5) I NT I NT LI NT LI NT
priorit y.

User-
supplied S MA L NUMB S MA LL S MA LL S MA L S MA L
JOB COS T
report LI NT E R(5) I NT I NT LI NT LI NT
cost .

Number of
FI NA LRE S UL rows in I NTE NUMB I NTE G I NTE G I NTE I NTE
TS I ZE t he GE R E R(10) ER ER GE R GE R
report .

Timest am
p of when
t he record
was
logged in
RE CORDTI M t he DA TE TI ME S TI ME S TI ME S DA TE DA TE
E (I ) dat abase, TI ME TA MP TA MP TA MP TI ME TI ME
according
t o t he
dat abase
syst em
t ime.

E RRORME S S The error V A RC V A RC V A RC V A RC V A RC V A RC

A GE message HA R HA R2 HA R HA R HA R HA R

1920 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serv Oracle DB2
Descrip t ata se QL
Co lu mn er Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

displayed
t o t he
user when (400 (400
(4000) (4000) (4000) (4000)
an error is 0) 0)
encount er
ed.

For
MicroS t rat
egy use.
DRI LLTE MP L GUI D of CHA R CHA R CHA R CHA R CHA R CHA R
A TE UNI T t he object (32) (32) (32) (32) (32) (32)
t hat was
drilled
f rom.

For
MicroS t ra
t egy use.
CHA R CHA R CHA R CHA R CHA R CHA R
NE WOB JE CT GUI D of
(32) (32) (32) (32) (32) (32)
t he object
t hat was
drilled t o.

For
MicroS t rat
egy use.
E numerat i
TI NY I NUMB S MA LL B Y TE I TI NY I TI NY I
DRI LLTY P E on of t he
NT E R(3) I NT NT NT NT
t ype of
drilling
act ion
perf orme

© 2019, M icr o St r at egy In c. 1921

Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serv Oracle DB2
Descrip t ata se QL
Co lu mn er Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

d.

Tot al
number of
unique
t ables
TOTA LTA B L S MA L NUMB S MA LL S MA LL S MA L I NTE
accessed
E A CCE S S LI NT E R(5) I NT I NT LI NT GE R
by t he
report
during
execut ion.

Lengt h in
charact ers
of t he
S QL
st at emen
t . For
mult iple I NTE NUMB I NTE G I NTE G I NTE I NTE
S QLLE NGTH
passes, GE R E R(10) ER ER GE R GE R
t his value
is t he sum
of S QL
st at ement
lengt hs of
each pass.

Durat ion
of t he
E X E CDURA T report I NTE NUMB I NTE G I NTE G I NTE I NTE
I ON execut ion, GE R E R(10) ER ER GE R GE R
in
millisecon

1922 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serv Oracle DB2
Descrip t ata se QL
Co lu mn er Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

ds.

CP U t ime
used f or
report
I NTE NUMB I NTE G I NTE G I NTE I NTE
CP UTI ME execut ion,
GE R E R(10) ER ER GE R GE R
in
millisecon
ds.

Tot al
number of
st eps
involved
TI NY I NUMB S MA LL B Y TE I TI NY I TI NY I
S TE P COUNT in
NT E R(3) I NT NT NT NT
execut ion
(not just
unique
st eps).

I nt elligenc
e S erver-
relat ed
act ions
E X E CA CTI ON t hat need I NTE NUMB I NTE G I NTE G I NTE I NTE
S t o t ake GE R E R(10) ER ER GE R GE R
place
during
report
execut ion.

I nt elligen I NTE NUMB I NTE G I NTE G I NTE I NTE

E X E CFLA GS
ce S erver- GE R E R(10) ER ER GE R GE R

© 2019, M icr o St r at egy In c. 1923

Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serv Oracle DB2
Descrip t ata se QL
Co lu mn er Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

relat ed
processes
needed t o
ref ine t he
report
execut ion.

1 if a
dat abase
error
DB E RRORI N occurred NUMB S MA LL B Y TE I TI NY I
BIT BIT
DI C during E R(1) I NT NT NT
execut ion,
ot herwise
0.

Tot al
t ime, in
millisecon
ds, t he
P ROMP TA NS I NTE NUMB I NTE G I NTE G I NTE I NTE
user spent
TI ME GE R E R(10) ER ER GE R GE R
answering
prompt s
on t he
report .

GUI D of
t he
I nt elligent
CUB E I NS TA N CHA R CHA R CHA R CHA R CHA R CHA R
Cube used
CE I D (32) (32) (32) (32) (32) (32)
in a Cube
P ublish or
Cube Hit

1924 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MyS
Serv Oracle DB2
Descrip t ata se QL
Co lu mn er Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

job.

S ize, in
K B , of t he
I nt elligent
Cube in I NTE NUMB I NTE G I NTE G I NTE I NTE
CUB E S I ZE
memory GE R E R(10) ER ER GE R GE R
f or a Cube
P ublish
job.

1 if any
S QL was
execut ed
S QLE X E CI ND against NUMB S MA LL B Y TE I TI NY I
BIT BIT
IC t he E R(1) I NT NT NT
dat abase,
ot herwise
0.

1 if t he
report was
E X P ORTI NDI TI NY I NUMB S MA LL B Y TE I TI NY I TI NY I
export ed,
C NT E R(3) I NT NT NT NT
ot herwise
0.

GUI D of
RE P OS I TOR t he CHA R CHA R CHA R CHA R CHA R CHA R
YID met adat a (32) (32) (32) (32) (32) (32)
reposit ory.

I D of t he CHA R CHA R CHA R CHA R CHA R CHA R

ME S S A GE I D
message. (32) (32) (32) (32) (32) (32)

© 2019, M icr o St r at egy In c. 1925

Syst em Ad m in ist r at io n Gu id e

STG_IS_SCHEDULE_STATS
Tracks w hi ch reports have been run as the resul t of a subscri pti on.
Thi s tabl e i s used w hen the Subscriptions opti on i s sel ected i n the
Stati sti cs category of the Proj ect C onfi gurati on Edi tor. The data l oad
process moves thi s tabl e's i nformati on to the IS_SC H ED U LE_STATS
tabl e, w hi ch has the same col umns and datatypes.

SQL U
T erad a Syb a MySQ
Serve Oracle DB2
Descri ta se L
Co lu mn r Dataty Dataty
p tio n Dataty Datat Datat
Datat pe pe
pe yp e yp e
yp e

Day t he
job was
request TI ME S
DAY_ID (I) DA TE DA TE DA TE DA TE DA TE
ed f or TA MP
execut i
on.

Hour t he
job was
HOUR_I D request TI NY I NUMB E S MA LLI B Y TE I N TI NY I TI NY I
(I ) ed f or NT R(3) NT T NT NT
execut io
n.

Minut e
t he job
was
MI NUTE _I D S MA L NUMB E S MA LLI S MA LLI S MA L S MA L
request
(I ) LI NT R(5) NT NT LI NT LI NT
ed f or
execut i
on.

SCHEDULEI I NTE G NUMB E I NTE GE I NTE GE I NTE G I NTE G

Job I D.
D (I) ER R(10) R R ER ER

1926 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL U
T erad a Syb a MySQ
Serve Oracle DB2
Descri ta se L
Co lu mn r Dataty Dataty
p tio n Dataty Datat Datat
Datat pe pe
pe yp e yp e
yp e

GUI D of
SESSIONID CHA R CHA R CHA R CHA R CHA R CHA R
t he user
(I) (32) (32) (32) (32) (32) (32)
session.

GUI D
f or
CHA R CHA R CHA R CHA R CHA R CHA R
SERVERID server
(32) (32) (32) (32) (32) (32)
def init io
n.

GUI D of
t he
object
TRIGGERID t hat CHA R CHA R CHA R CHA R CHA R CHA R
(I) t riggere (32) (32) (32) (32) (32) (32)
d t he
subscrip
t ion.

Type of
schedul
e: 0 if it
S CHE DULE is a TI NY I NUMB E S MA LLI B Y TE I N TI NY I TI NY I
TY P E (I ) report , 1 NT R(3) NT T NT NT
if it is a
docume
nt

0 if t he
job does
TI NY I NUMB E S MA LLI B Y TE I TI NY I TI NY I
HITCACHE not hit
NT R(3) NT NT NT NT
t he
cache, 1

© 2019, M icr o St r at egy In c. 1927

Syst em Ad m in ist r at io n Gu id e

SQL U
T erad a Syb a MySQ
Serve Oracle DB2
Descri ta se L
Co lu mn r Dataty Dataty
p tio n Dataty Datat Datat
Datat pe pe
pe yp e yp e
yp e

if it
does.

Timest a
mp of
S TA RTTI M t he DA TE TI ME S T TI ME S T TI ME S T DA TE DA TE
E schedul TI ME A MP A MP A MP TI ME TI ME
e st art
t ime.

Timest a
mp of
when
t he
record
was
logged
RE CORDTI in t he DA TE TI ME S TI ME S TI ME S DA TE DA TE
ME (I ) dat abas TI ME TA MP TA MP TA MP TI ME TI ME
e,
accordi
ng t o
dat abas
e
syst em
t ime.

(S erver
machine
V A RC V A RCH V A RC V A RC
S E RV E RM name: p V A RCH V A RCH
HA R A R2 HA R HA R
A CHI NE ort A R(255) A R(255)
(255) (255) (255) (255)
number)
pair.

1928 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL U
T erad a Syb a MySQ
Serve Oracle DB2
Descri ta se L
Co lu mn r Dataty Dataty
p tio n Dataty Datat Datat
Datat pe pe
pe yp e yp e
yp e

GUI D of
P ROJE CTI CHA R CHA R CHA R CHA R CHA R CHA R
t he
D (I ) (32) (32) (32) (32) (32) (32)
project .

GUI D of
t he
RE P OS I TO met adat CHA R CHA R CHA R CHA R CHA R CHA R
RY I D a (32) (32) (32) (32) (32) (32)
reposit o
ry.

STG_IS_SESSION_STATS
Logs every Intel l i gence Server user sessi on. Thi s tabl e i s used w hen
the B asic Statistics opti on i s sel ected i n the Stati sti cs category of
the Proj ect C onfi gurati on Edi tor. The data l oad process moves thi s
tabl e's i nformati on to the IS_SESSION _STATS tabl e, w hi ch has the
same col umns and datatypes.

The STG_IS_SESSION_STATS table does not c ontain projec t-lev el

information and is therefore not affec ted by s tatis tic s purges at the
projec t lev el. For details about s tatis tic s purges , s ee the System
Admi ni strati on Gui de .

© 2019, M icr o St r at egy In c. 1929

Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MySQ
Serve Oracle DB2
Descrip t ata se L
Co lu mn r Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

Day t he
session TI ME S
DA Y _I D DA TE DA TE DA TE DA TE DA TE
was TA MP
st art ed.

Hour t he
session TI NY I NUMB E S MA LLI B Y TE I TI NY I TI NY I
HOUR_I D
was NT R(3) NT NT NT NT
st art ed.

Minut e
t he
S MA L NUMB S MA LL S MA LL S MA L S MA L
MI NUTE _I D session
LI NT E R(5) I NT I NT LI NT LI NT
was
st art ed.

GUI D of
S E S S I ONI D CHA R CHA R CHA R CHA R CHA R CHA R
t he user
(I ) (32) (32) (32) (32) (32) (32)
session.

S erver
CHA R CHA R CHA R CHA R CHA R CHA R
S E RV E RI D def init ion
(32) (32) (32) (32) (32) (32)
GUI D.

(S erver
machine V A RC V A RCH V A RCH V A RCH V A RC V A RC
S E RV E RMA
name: port HA R A R2 AR AR HA R HA R
CHI NE
number) (255) (255) (255) (255) (255) (255)
pair.

GUI D of CHA R CHA R CHA R CHA R CHA R CHA R

US E RI D
t he user. (32) (32) (32) (32) (32) (32)

CLI E NTMA V A RC V A RCH V A RCH V A RCH V A RC V A RC

Client
CHI NE HA R A R2 AR AR HA R HA R

1930 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MySQ
Serve Oracle DB2
Descrip t ata se L
Co lu mn r Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

machine
name, or
I P address
if t he
(255) (255) (255) (255) (255) (255)
machine
name is
not
available.

S ource
f rom
which t he
session
originat e
d:

• 1:
Develo
per

• 2:
E V E NTS OU I nt ellig TI NY I NUMB S MA LL B Y TE I TI NY I TI NY I
RCE ence NT E R(3) I NT NT NT NT
S erver
A dmini
st rat or

• 3: Web
A dmini
st rat or

• 4:
I nt ellig
ence
S erver

© 2019, M icr o St r at egy In c. 1931

Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MySQ
Serve Oracle DB2
Descrip t ata se L
Co lu mn r Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

• 5:
P roject
Upgrad
e

• 6: Web

• 7:
S ched
uler

• 8:
Cust o
m A pp

• 9:
Narrow
cast
S erver

• 10:
Object
Mgr

• 11:
ODB O
P rovid
er

• 12:
ODB O
Cube
Design
er

• 13:

1932 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MySQ
Serve Oracle DB2
Descrip t ata se L
Co lu mn r Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

Comm
and
Mgr

• 14:
E nt erp
rise
Mgr

• 15:
Comm
and
Line
I nt erf a
ce

• 16:
P roject
B uilder

• 17:
Conf ig
Wiz

• 18: MD
S can

• 19:
Cache
Ut ilit y

• 20:
Fire
E vent

• 21:

© 2019, M icr o St r at egy In c. 1933

Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MySQ
Serve Oracle DB2
Descrip t ata se L
Co lu mn r Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

MicroS
t rat egy
Java
admin
client s

• 22:
MicroS
t rat egy
Web
S ervic
es

• 23:
MicroS
t rat egy
Of f ice

• 24:
MicroS
t rat egy
t ools

• 25:
P ort al
S erver

• 26:
I nt egri
t y Mgr

• 27:
Met ad
at a
Updat e

1934 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MySQ
Serve Oracle DB2
Descrip t ata se L
Co lu mn r Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

• 28:
Reserv
ed f or
MicroS
t rat egy
use

• 29:
S ched
uler f or
Mobile

• 30:
Reposi
t ory
Transl
at ion
Tool

• 32:
Cube
A dviso
r

• 33:
Operat
ions
Mgr

Timest am
p of when
RE CORDTI DA TE TI ME S TI ME S TI ME S DA TE DA TE
t he record
ME (I ) TI ME TA MP TA MP TA MP TI ME TI ME
was
logged in

© 2019, M icr o St r at egy In c. 1935

Syst em Ad m in ist r at io n Gu id e

SQL
T erad Syb a MySQ
Serve Oracle DB2
Descrip t ata se L
Co lu mn r Data- Data-
io n Data- Data- Data-
Data- typ e typ e
typ e typ e typ e
typ e

t he
dat abase,
according
to
dat abase
syst em
t ime.

Web
server
machine
f rom V A RC V A RCH V A RCH V A RCH V A RC V A RC
WE B MA CHI
which a HA R A R2 AR AR HA R HA R
NE
web (255) (255) (255) (255) (255) (255)
session
originat e
s.

Timest am
p of when
CONNE CTT DA TE TI ME S TI ME S TI ME S DA TE DA TE
t he
I ME (I ) TI ME TA MP TA MP TA MP TI ME TI ME
session is
opened.

Timest am
p of when
DI S CONNE DA TE TI ME S TI ME S TI ME S DA TE DA TE
t he
CTTI ME TI ME TA MP TA MP TA MP TI ME TI ME
session is
closed.

GUI D of
RE P OS I TO t he CHA R CHA R CHA R CHA R CHA R CHA R
RY I D met adat a (32) (32) (32) (32) (32) (32)
reposit ory.

1936 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

STG_MSI_STATS_PROP
For Mi croStrategy use. Provi des i nformati on about the stati sti cs
database properti es. Intel l i gence Server uses thi s tabl e to i ni ti al i ze
stati sti cs l oggi ng.

Co lu mn Name Co lu mn Descrip tio n

P ropert y name, such as st at ist ics dat abase version, upgrade

P ROP _NA ME
script , and so on.

P ropert y value, such as st at ist ics dat abase version number,

P ROP _V A L
t ime t hat an upgrade script was run, and so on.

© 2019, M icr o St r at egy In c. 1937

 6
ENTERPRISE M ANAGER
D ATA D ICTIONARY

© 2019, M icr o St r at egy In c. 1938

Syst em Ad m in ist r at io n Gu id e

D etai l ed i nformati on about Enterpri se Manager obj ects i s avai l abl e

from w i thi n Mi croStrategy:

l To vi ew detai l s about Enterpri se Manager obj ects, w al k through the

Proj ect D ocumentati on w i zard i n the Enterpri se Manager proj ect. To
access thi s, from Mi croStrategy D evel oper, open the Enterpri se
Manager proj ect, cl i ck the Tools menu and sel ect Project
D ocumentation.

l To vi ew detai l s about Enterpri se Manager schema obj ects, such as

facts, attri butes, and hi erarchi es, open the Enterpri se Manager
proj ect i n Mi croStrategy Archi tect. To access thi s, from
Mi croStrategy D evel oper, open the Enterpri se Manager proj ect,
cl i ck the Schema menu and sel ect A rchitect.

l For i nformati on about confi guri ng Enterpri se Manager and how you
can use i t to hel p tune the Mi croStrategy system and i nformati on
about setti ng up proj ect documentati on so i t i s avai l abl e to
netw orked users, see the Enterpri se Manager Gui de .

Enterprise Manager Data Warehouse Tables

The fol l ow i ng i s a l i st of tabl es i n the Enterpri se Manager data
w arehouse.

Temporary tables are c reated and us ed by the data loading proc es s

when data is migrated from the s tatis tic s tables to the Enterpris e
Manager warehous e. Thes e temporary tables are the following:

l IS_REP_SQL_TMP

l IS_REP_STEP_TMP

l IS_SESSION_TMP1

l IS_PROJ ECT_FACT_1_TMP

1939 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l EM_IS_LAST_UPD_1

l EM_IS_LAST_UPD_2

Fact Tables
l C T_EXEC _FAC T

l C T_MAN IP_FAC T

l IS_C ON FIG_PAR AM_FAC T

l IS_C U BE_AC TION _FAC T

l IS_D OC _FAC T

l IS_D OC _STEP_FAC T

l IS_IN BOX_AC T_FAC T

l IS_MESSAGE_FAC T

l IS_PER F_MON _FAC T

l IS_PR _AN S_FAC T

l IS_PR OJEC T_FAC T_1

l IS_R EP_C OL_FAC T

l IS_R EP_FAC T

l IS_R EP_SEC _FAC T

l IS_R EP_SQL_FAC T

l IS_R EP_STEP_FAC T

l IS_SESSION _FAC T

l IS_SESSION _MON ITOR

© 2019, M icr o St r at egy In c. 1940

Syst em Ad m in ist r at io n Gu id e

CT_EXEC_FACT
C ontai ns i nformati on about Mi croStrategy Mobi l e devi ces and
report/document executi ons and mani pul ati ons. C reated as a vi ew
based on col umns i n the source tabl es l i sted bel ow .

Source Tables

l C T_D EVIC E_STATS: Stati sti cs tabl e contai ni ng i nformati on about

the mobi l e cl i ent and the mobi l e devi ce

l C T_EXEC _STATS: Stati sti cs tabl e contai ni ng i nformati on about

mobi l e report and document executi on

l IS_SER VER : Lookup tabl e that provi des descri pti ve i nformati on
about the server defi ni ti ons bei ng tracked

l IS_R EP: Lookup tabl e that provi des descri pti ve i nformati on about
the reports bei ng tracked

l IS_D OC : Lookup tabl e that provi des descri pti ve i nformati on about
the documents bei ng tracked

l IS_PR OJ: Lookup tabl e that provi des descri pti ve i nformati on about
the proj ects bei ng tracked

l EM_MD : Lookup tabl e for metadata

l EM_U SER : Lookup tabl e for users

List of Table Columns

Co lu mn Name Co lu mn Descrip tio n

CT_DE V I CE _I NS T_
Unique inst allat ion I D of t he mobile app.
ID

CT_S TA TE _ A n int eger value t hat increment s when t he device inf ormat ion,

1941 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Co lu mn Name Co lu mn Descrip tio n

such as DE V I CE TY P E , OS , OS V E R, or A P P V E R (in CT_

COUNTE R
DE V I CE _S TA TS ), changes.

CT_S TA TE _
Dat e and t ime when S TA TE COUNTE R is increment ed.
CHA NGE _TS

Type of device t he app is inst alled on, such as iP ad 2, Droid,

CT_DE V I CE _TY P E
or iP hone 6.

Operat ing syst em t he app is inst alled on, such as iOS or

CT_OS
A ndroid.

CT_OS _V E R V ersion of t he operat ing syst em, such as 5. 2. 1.

CT_A P P _V E R V ersion of t he MicroS t rat egy app.

E M_US E R_I D I D of t he user execut ing t he document .

GUI D of t he session t hat execut ed t he request . This should be

I S _S E S S I ON_I D t he same as t he S E S S I ONI D f or t his request in I S _RE P _
FA CT.

GUI D of t he MicroS t rat egy Mobile client session I D. A new

CT_S E S S I ON_I D client session I D is generat ed every t ime a user logs in t o t he
mobile app.

I D corresponding t o t he JOB I D (in I S _RE P _FA CT) of t he

I S _ME S S A GE _I D
message generat ed by t he execut ion.

S imilar t o JOB I D but generat ed by t he client and cannot be

CT_A CTI ON_I D NULL. JOB I D may be NULL if t he user is of f line during
execut ion.

I S _S E RV E R_I D GUI D of t he I nt elligence S erver processing t he request .

E M_A P P _S RV _ Name and port number of t he I nt elligence S erver machine

MA CHI NE where t he mobile document execut ion is t aking place.

I S _RE P _I D GUI D of t he report used in t he request .

I S _DOC_I D GUI D of t he document used in t he request .

© 2019, M icr o St r at egy In c. 1942

Syst em Ad m in ist r at io n Gu id e

Co lu mn Name Co lu mn Descrip tio n

I S _P ROJ_I D GUI D of t he project .

I S _RE P OS I TORY _
GUI D of t he met adat a reposit ory.
ID

E M_MOB _S RV _ Name and port number of t he Mobile S erver machine where

MA CHI NE t he mobile document execut ion is t aking place.

CT_RE Q_TS Time when t he user submit s a request t o t he mobile app.

Time when t he mobile app begins receiving dat a f rom

CT_RE C_TS
MicroS t rat egy Mobile S erver.

CT_RE Q_RE C_TM_ Dif f erence in milliseconds bet ween CT_RE Q_TS and CT_
MS RE C_TS .

CT_RE NDE R_S T_

Time when t he mobile app begins rendering.
TS

CT_RE NDE R_FN_

Time when t he mobile app f inishes rendering.
TS

CT_RE NDE R_TM_ Dif f erence in milliseconds bet ween CT_RE NDE R_S T_TS and
MS CT_RE NDE R_FN_TS

Type of report or document execut ion:

• 1: User execut ion

• 2: P re-cached execut ion

• 3: S yst em recovery execut ion

CT_E X E C_TY P E _
• 4: S ubscript ion cache pre-loading execut ion
I ND_I D
• 5: Transact ion subsequent act ion execut ion

• 6: Report queue execut ion

• 7: Report queue recall execut ion

• 8: B ack but t on execut ion

CT_CA CHE _HI T_ Whet her a cache was hit during t he execut ion, and if so, what
I ND_I D t ype of cache hit occurred:

1943 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Co lu mn Name Co lu mn Descrip tio n

• 0: No cache hit

• 1: I nt elligence S erver cache hit

• 2: Device cache hit

• 6: A pplicat ion memory cache hit

Whet her t he report or document is prompt ed:

CT_P ROMP T_I ND_
• 0: Not prompt ed
ID
• 1: P rompt ed

Whet her t he job is f or a report or a document :

CT_DA TA TY P E _I D • 3: Report

• 55: Document

The t ype of net work used:

• 3G
CT_NE TWORK _
• WiFi
TY P E
• LTE

• 4G

CT_B A NDWI DTH_

E st imat ed net work bandwidt h, in kbps.
KBPS

Time at which t he user eit her clicks on anot her report or

CT_V I E W_FN_TS
document , or backgrounds t he mobile app.

Dif f erence in milliseconds bet ween CT_RE NDE R_FN_TS and

CT_V I E W_TM_MS
CT_V I E W_FN_TS .

A n int eger value t hat increases wit h every manipulat ion t he

user makes af t er t he report or document is rendered,
CT_NU_OF_MA NI P excluding t hose t hat require f et ching more dat a f rom
I nt elligence S erver or t hat result in anot her report or
document execut ion.

CT_A V G_MA NI P _ A verage rendering t ime f or each manipulat ion.

© 2019, M icr o St r at egy In c. 1944

Syst em Ad m in ist r at io n Gu id e

Co lu mn Name Co lu mn Descrip tio n

RE NDE R_TM_MS

CT_LA TI TUDE Lat it ude of t he user.

CT_LONGI TUDE Longit ude of t he user.

DA Y _I D Day t he act ion was st art ed.

CT_TI ME S TA MP Time t he manipulat ion was st art ed.

HOUR_I D Hour t he act ion was st art ed.

MI NUTE _I D Minut e t he act ion was st art ed.

Dat e and t ime when t his inf ormat ion was writ t en t o t he
E M_RE CORD_TS
st at ist ics dat abase.

CT_RE Q_
Whet her t he manipulat ion request was received.
RE CE I V E D_FLA G

CT_RE Q_
Whet her t he manipulat ion was complet ed.
RE NDE RE D_FLA G

CT_RE Q_HA S _
Whet her t he manipulat ion request was made by a mobile app.
DE V I CE _FLA G

The I D of t he job request ing t he manipulat ion. A combinat ion

CT_JOB _I D of t he I S _S E S S I ON_I D, CT_S E S S I ON_I D, and CT_A CTI ON_
I D.

Name of t he document used in t he request , or if it is a delet ed

I S _DOC_NA ME
document .

Name of t he project used f or t he request or if it is a delet ed

I S _P ROJ_NA ME
project .

Name of t he user who made t he request or if it is a delet ed

E M_US E R_NA ME
user.

E M_LDA P LI NK Name of t he user in t he LDA P syst em or if it is a delet ed user.

E M_NTLI NK Name of t he user in Windows or if it is a delet ed user.

1945 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

CT_MANIP_FACT
C ontai ns i nformati on about Mi croStrategy Mobi l e devi ces and
report/document mani pul ati ons. C reated as a vi ew based on col umns
i n the source tabl es l i sted bel ow .

Source Tables

l C T_MAN IP_STATS: Stati sti cs tabl e contai ni ng i nformati on about

the report or document mani pul ati ons

l EM_MD : Lookup tabl e for metadata

l IS_PR OJ: Lookup tabl e that provi des descri pti ve i nformati on about
the proj ects bei ng tracked

l IS_D OC : Lookup tabl e that provi des descri pti ve i nformati on about
the documents bei ng tracked

l IS_R EP: Lookup tabl e that provi des descri pti ve i nformati on about
the reports bei ng tracked

l EM_U SER : Lookup tabl e for users

List of Table Columns

Co lu mn Name Co lu mn Descrip tio n

The I D of t he job request ing t he manipulat ion. A combinat ion

CT_JOB _I D of t he I S _S E S S I ON_I D, CT_S E S S I ON_I D, and CT_A CTI ON_
I D.

CT_DE V I CE _I NS T_
Unique inst allat ion I D of t he mobile app.
ID

A n int eger value t hat increment s when t he device inf ormat ion,
CT_S TA TE _
such as DE V I CE TY P E , OS , OS V E R, or A P P V E R (in CT_
COUNTE R
MA NI P _S TA TS ), changes.

© 2019, M icr o St r at egy In c. 1946

Syst em Ad m in ist r at io n Gu id e

Co lu mn Name Co lu mn Descrip tio n

E M_US E R_I D I D of t he user making t he request .

I S _S E S S I ON_I D GUI D of t he session t hat execut ed t he request .

GUI D of t he MicroS t rat egy Mobile client session I D. A new

CT_S E S S I ON_I D client session I D is generat ed every t ime a user logs in t o t he
mobile app.

S imilar t o JOB I D but generat ed by t he client and cannot be

CT_A CTI ON_I D NULL. JOB I D may be NULL if t he user is of f line during
execut ion.

E M_A P P _S RV _ Name and port number of t he I nt elligence S erver machine

MA CHI NE where t he manipulat ion is t aking place.

I S _RE P _I D GUI D of t he report used in t he request .

I S _DOC_I D I nt eger I D of t he document t hat was execut ed.

I S _P ROJ_I D I nt eger I D of t he project .

The order in which t he manipulat ions were made in a session.

I S _MA NI P _S E Q_I D For each manipulat ion, t he mobile client ret urns a row, and t he
value in t his column increment s f or each row.

Type of manipulat ion:

• 0: Unknown

• 1: S elect or

• 2: P anel S elect or
I S _MA NI P _TY P E _
• 3: A ct ion S elect or
ID
• 4: Change Layout

• 5: Change V iew

• 6: S ort

• 7: P age B y

Name of t he it em t hat was manipulat ed. For example, if a

I S _MA NI P _NA ME
select or was clicked, t his is t he name of t he select or.

1947 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Co lu mn Name Co lu mn Descrip tio n

V alue of t he it em t hat was manipulat ed. For example, if a

I S _MA NI P _V A LUE panel select or was clicked, t his is t he name of t he select ed
panel.

I f t he value f or I S _MA NI P _V A LUE is t oo long t o f it in one row,

I S _MA NI P _V A LUE _
t his manipulat ion is spread over mult iple rows, and t his value
SEQ
is increment ed.

DE TA I L1 A f lexible column t o capt ure dif f erent st at es of manipulat ion.

DE TA I LS 2 A f lexible column t o capt ure dif f erent st at es of manipulat ion.

CT_MA NI P _S T_TS Time when t he user submit t ed t he manipulat ion.

Time when t he mobile app f inished processing t he

CT_MA NI P _FN_TS
manipulat ion and f orwarded it f or rendering.

CT_MA NI P _TM_ Dif f erence bet ween CT_MA NI P _S T_TS and CT_MA NI P _FN_
MS TS , in milliseconds.

DA Y _I D Day t he manipulat ion was st art ed.

HOUR_I D Hour t he manipulat ion was st art ed.

MI NUTE _I D Minut e t he manipulat ion was st art ed.

Dat e and t ime when t his inf ormat ion was writ t en t o t he
E M_RE CORD_TS
st at ist ics dat abase.

RE P _I D I D of t he report used in t he request .

IS_CONFIG_PARAM_FACT
C ontai ns i nformati on about Intel l i gence Server and proj ect
confi gurati on setti ngs.

Related Lookup Tables

l IS_C ON FIG_PAR AM: Lookup tabl e for confi gurati on setti ngs

l IS_PR OJ: Lookup tabl e for proj ects

© 2019, M icr o St r at egy In c. 1948

Syst em Ad m in ist r at io n Gu id e

l IS_SER VER : Lookup tabl e for Intel l i gence Server defi ni ti ons

List of Table Columns

Co lu mn Name Co lu mn Descrip tio n

I S _CONFI G_TS Timest amp when t he conf igurat ion set t ing was recorded.

I S _MD_I D I nt eger I D of t he met adat a being monit ored.

I D of t he project recording t he conf igurat ion set t ing. I f t he

I S _P ROJ_I D conf igurat ion set t ing is an I nt elligence S erver set t ing, t his
value is 0.

I S _S E RV E R_I D I nt eger I D of t he I nt elligence S erver def init ion.

I S _CONFI G_
I nt eger I D t he conf igurat ion set t ing.
P A RA M_I D

I S _CONFI G_
V alue of t he conf igurat ion set t ing.
P A RA M_V A LUE

IS_CUBE_ACTION_FACT
C ontai ns i nformati on about Intel l i gent C ube mani pul ati ons. C reated
as a vi ew based on col umns i n the source tabl es l i sted bel ow .

Source Tables

l EM_MD : Lookup tabl e for metadata

l IS_C U BE_R EP_STATS: Stati sti cs tabl e contai ni ng i nformati on

about Intel l i gent C ube mani pul ati ons

l IS_C U BE_AC TION _TYPE: Lookup tabl e l i sti ng the mani pul ati ons
that can occur

l IS_PR OJ: Lookup tabl e for proj ects

l IS_R EP: Lookup tabl e for report obj ects

1949 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

List of Table Columns

Co lu mn Name Co lu mn Descrip tio n

DA Y _I D Day t he act ion was st art ed.

HOUR_I D Hour t he act ion was st art ed.

MI NUTE _I D Minut e t he act ion was st art ed.

Dat e and t ime when t his inf ormat ion was writ t en t o t he
E M_RE CORD_TS
st at ist ics dat abase.

GUI D of t he session t hat st art ed t he act ion against t he

I S _S E S S I ON_I D
I nt elligent Cube.

I S _RE P _JOB _I D Job I D f or t he act ion on t he I nt elligent Cube

I S _P ROJ_I D I nt eger I D of t he project where t he I nt elligent Cube is st ored.

I nt eger I D of t he I nt elligent Cube report t hat was published, if

I S _CUB E _RE P _I D
any

I S _CUB E _I NS T_I D GUI D of t he I nt elligent Cube inst ance in memory

Type of act ion against t he I nt elligent Cube:

• 0: Reserved f or MicroS t rat egy use

• 1: Cube P ublish

• 2: Cube V iew Hit

I S _CUB E _A CT_I D • 3: Cube Dynamic S ource Hit

• 4: Cube A ppend

• 5: Cube Updat e

• 6: Cube Delet e

• 7: Cube Dest roy

I S _RE P _I D I nt eger I D of t he report t hat hit t he I nt elligent Cube, if any.

I f t he I nt elligent Cube is published or ref reshed, size of t he

I S _CUB E _S I ZE _K B
I nt elligent Cube in K B .

© 2019, M icr o St r at egy In c. 195 0

Syst em Ad m in ist r at io n Gu id e

Co lu mn Name Co lu mn Descrip tio n

I f t he I nt elligent Cube is published or ref reshed, number of

I S _CUB E _ROWS
rows in t he I nt elligent Cube.

I S _RE P OS I TORY _
I nt eger I D of t he met adat a reposit ory.
ID

IS_DOC_FACT
C ontai ns i nformati on on the executi on of a document j ob.

Pri mary key:

l D AY_ID 2

l IS_SESSION _ID

l IS_D OC _JOB_SES_ID

l IS_D OC _JOB_ID

l IS_D OC _C AC H E_ID X

Source Tables

l IS_D OC U MEN T_STATS: Stati sti cs tabl e contai ni ng i nformati on

about document executi ons

l EM_IS_LAST_U PD _2: C onfi gurati on tabl e that dri ves the l oadi ng
process (for exampl e, data l oadi ng w i ndow )

Related Lookup Tables

l EM_U SER : Lookup tabl e for users

l IS_D OC : Lookup tabl e for documents

l IS_SESSION : Lookup tabl e for sessi on obj ects

195 1 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

List of Table Columns

Co lu mn Name Co lu mn Descrip tio n

Timest amp of when t he inf ormat ion was recorded by

E M_RE CORD_TS
I nt elligence S erver int o t he I S _DOCUME NT_S TA TS t able.

Timest amp of when t he E nt erprise Manager dat a load

E M_LOA D_TS
process began.

I S _S E RV E R_I D I nt eger I D of t he server where t he session was creat ed.

I S _S E S S I ON_I D GUI D of t he current session object .

GUI D of t he session t hat creat ed t he cache if a cache was

I S _DOC_JOB _S E S _
hit in t his execut ion; ot herwise, current session (def ault
ID
behavior).

I S _DOC_JOB _I D I nt eger I D of t he document job execut ion.

A lways 0; not yet available, document s not current ly

I S _DOC_CA CHE _I DX cached. I nt eger I D of t he cache hit index; similar t o Job I D
but only f or cache hit s. -1 if no cache hit .

A lways 0; not yet available, document s not current ly cached.

I S _CA CHE _HI T_I D
I ndicat es whet her t he job hit a cache.

I S _CA CHE _ A lways 0, not yet available. I ndicat es whet her a cache was
CRE A TE _I D creat ed.

I S _P ROJ_I D I nt eger I D of t he project logged int o.

I S _CUB E _E X E C_S T_ Dat e and t ime when cube execut ion was st art ed by
TS I nt elligence S erver.

I S _CUB E _E X E C_FN_ Dat e and t ime when cube execut ion was f inished by
TS I nt elligence S erver.

E M_US E R_I D I nt eger I D of t he user who creat ed t he session.

I S _DOC_I D I nt eger I D of t he document t hat was execut ed.

Timest amp of t he execut ion request ; request of t he current

I S _DOC_RE Q_TS
session.

© 2019, M icr o St r at egy In c. 195 2

Syst em Ad m in ist r at io n Gu id e

Co lu mn Name Co lu mn Descrip tio n

Timest amp of t he execut ion request ; request t ime of t he

I S _DOC_E X E C_
original execut ion request if a cache was hit , ot herwise
RE Q_TS
current session's request t ime.

I S _DOC_E X E C_S T_
Timest amp of t he execut ion st art .
TS

I S _DOC_E X E C_FN_
Timest amp of t he execut ion f inish.
TS

I S _DOC_QU_TM_MS Queue durat ion in milliseconds.

I S _DOC_CP U_TM_
CP U durat ion in milliseconds.
MS

I S _DOC_E X E C_TM_
E xecut ion durat ion in milliseconds.
MS

I S _DOC_NB R_
Number of report s cont ained in t he document job execut ion.
RE P ORTS

I S _DOC_NB R_P U_
Number of st eps processed in t he document job execut ion.
S TP S

I S _DOC_NB R_
Number of prompt s in t he document job execut ion.
P ROMP TS

I S _JOB _E RROR_I D I nt eger I D of t he job's error message, if any.

I S _CA NCE LLE D_I D I ndicat es whet her t he job was cancelled.

DA Y _I D2 I nt eger I D of t he day. Format Y Y Y Y MMDD.

HOUR_I D I nt eger I D of t he hour. Format HH (24 hours).

MI NUTE _I D2 I nt eger I D of t he minut e. Format HHMM (24 hours)

DA Y _I D This c olumn is deprec ated.

MI NUTE _I D This c olumn is deprec ated.

195 3 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

IS_DOC_STEP_FACT
C ontai ns i nformati on on each processi ng step of a document
executi on. C reated as a vi ew based on col umns i n the source tabl es
l i sted bel ow .

Source Tables

l IS_D OC _STEP_STATS: Stati sti cs tabl e contai ni ng i nformati on

about processi ng steps of document executi on

l IS_PR OJ: Lookup tabl e for proj ects

l IS_D OC U MEN T_STATS: Stati sti cs tabl e contai ni ng i nformati on

about document executi ons

l IS_SESSION : Lookup tabl e for sessi on obj ects

List of Table Columns

Co lu mn Name Co lu mn Descrip tio n

Timest amp of when t he inf ormat ion was recorded by

E M_RE CORD_TS
I nt elligence S erver int o t he _S TA TS t ables.

I S _P ROJ_I D I nt eger I D of t he project logged int o.

GUI D of t he session t hat creat ed t he cache if a cache was hit

I S _DOC_JOB _
in t his execut ion; ot herwise, current session (def ault
S E S _I D
behavior).

I S _DOC_JOB _I D I nt eger I D of t he document job execut ion.

I S _DOC_S TE P _
I nt eger I D of t he document job execut ion st ep.
S E Q_I D

I S _DOC_S TE P _
I nt eger I D of t he document job execut ion st ep t ype.
TY P _I D

I S _DOC_E X E C_ Timest amp of t he execut ion st art .

© 2019, M icr o St r at egy In c. 195 4

Syst em Ad m in ist r at io n Gu id e

Co lu mn Name Co lu mn Descrip tio n

S T_TS

I S _DOC_E X E C_
Timest amp of t he execut ion f inish.
FN_TS

I S _DOC_QU_TM_
Queue durat ion in milliseconds.
MS

I S _DOC_CP U_TM_
CP U durat ion in milliseconds.
MS

I S _DOC_E X E C_
E xecut ion durat ion in milliseconds.
TM_MS

DA Y _I D Day t he job was execut ed.

HOUR_I D Hour t he job was execut ed.

MI NUTE _I D Minut e t he job was execut ed.

IS_INBOX_ACT_FACT
C ontai ns i nformati on about H i story Li st mani pul ati ons. C reated as a
vi ew based on col umns i n the source tabl es l i sted bel ow .

Source Tables

l IS_IN BOX_AC T_STATS: Stati sti cs tabl e contai ni ng i nformati on

about H i story Li st mani pul ati ons

l IS_IN BOX_AC TION : Lookup tabl e l i sti ng the mani pul ati ons that can
occur

195 5 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

List of Table Columns

Co lu mn Name Co lu mn Descrip tio n

DA Y _I D Day t he manipulat ion was st art ed.

HOUR_I D Hour t he manipulat ion was st art ed.

MI NUTE _I D Minut e t he manipulat ion was st art ed.

GUI D of t he session t hat st art ed t he Hist ory List

I S _S E S S I ON_I D
manipulat ion.

GUI D of t he server def init ion of t he I nt elligence S erver being

I S _S E RV E R_I D
manipulat ed.

E M_A P P _S RV _ Name and port number of t he I nt elligence S erver machine

MA CHI NE where t he manipulat ion is t aking place.

GUI D of t he project where t he Hist ory List message is

I S _P ROJ_I D
mapped.

Type of manipulat ion:

• 0: Reserved f or MicroS t rat egy use.

• 1: A dd: A dd message t o Hist ory List

• 2: Remove: Remove message f rom Hist ory List

• 3: Rename: Rename message

I S _I NB OX _
A CTI ON_I D • 4: E xecut e: E xecut e cont ent s of message

• 5: Change S t at us: Change message st at us f rom Ready t o

Read

• 6: Request ed: Ret rieve message cont ent s

• 7: B at ch Remove: I nt elligence S erver bulk operat ion, such

as cache expirat ion

E M_US E R_I D I D of t he user doing t he manipulat ion.

I S _HL_ME S S A GE _
GUI D of t he Hist ory List message being act ed on.
ID

© 2019, M icr o St r at egy In c. 195 6

Syst em Ad m in ist r at io n Gu id e

Co lu mn Name Co lu mn Descrip tio n

I S _HL_ME S S A GE _ Name of t he report or document ref erenced in t he Hist ory List

TI TLE message.

I S _HL_ME S S A GE _ User-def ined name of t he Hist ory List message. B lank unless
DI S P t he user has renamed t he Hist ory List message.

I S _CRE A TI ON_TS Dat e and t ime when t he Hist ory List message was creat ed.

I S _A CT_S TA RT_TS Dat e and t ime when t he manipulat ion st art ed.

Report job I D f or t he Hist ory List Message Cont ent Request .

I S _RE P _JOB _I D
B lank if no job was execut ed or if a document was execut ed.

Document job I D f or t he Hist ory List Message Cont ent

I S _DOC_JOB _I D Request . B lank if no job was execut ed or if a report was
execut ed.

IS_
I D of t he subscript ion t hat invoked t he manipulat ion
S UB S CRI P TI ON_I D

• I f t he manipulat ion is a bat ch delet ion of Hist ory List

I S _A CTI ON_ messages, t his f ield cont ains t he condit ion or S QL
COMME NT st at ement used t o delet e t he messages.

• I f t here is an error, t his f ield holds t he error message.

Dat e and t ime when t his inf ormat ion was writ t en t o t he
E M_RE CORD_TS
st at ist ics dat abase.

IS_MESSAGE_FACT
R ecords al l messages sent through D i stri buti on Servi ces.

Source Table

l IS_MESSAGE_STATS: Stati sti cs tabl e contai ni ng i nformati on about

sent messages

195 7 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Related Lookup Tables

l IS_SC H ED : Lookup tabl e for schedul es

l IS_PR OJ: Lookup tabl e for proj ects

l IS_SER VER : Lookup tabl e for Intel l i gence Server defi ni ti ons

l IS_D EVIC E: Lookup tabl e for devi ces

l EM_MD : Lookup tabl e for metadata

List of Table Columns

Co lu mn Name Co lu mn Descrip tio n

Timest amp of when inf ormat ion was recorded by

E M_RE CORD_TS
I nt elligence S erver int o t he I S _ME S S A GE _S TA TS t able.

Timest amp of when t he E nt erprise Manager dat a load

E M_LOA D_TS
process began.

I S _ME S S A GE _I NDE X Reserved f or MicroS t rat egy use.

I S _S E S S I ON_I D GUI D of t he session object .

DA Y _I D I nt eger I D of t he day. Format : Y Y Y Y MMDD.

HOUR_I D I nt eger I D of t he hour. Format HH (24 hours).

MI NUTE _I D I nt eger I D of t he minut e.

I S _HL_ME S S A GE _I D Message I D of t he job creat ed.

I S _S CHE DULE _JOB _I D Job I D f rom I nt elligence S erver f or t he subscript ion job.

Type of dat a generat ed f or t he subscript ion.

I S _DA TA TY P E _I D • 3: Report

• 55: Document

I S _RCP T_CONTA CT_I D GUI D of t he user who is receiving t he dat a.

I S _DE LI V E RY _TY P E _ Type of delivery:

© 2019, M icr o St r at egy In c. 195 8

Syst em Ad m in ist r at io n Gu id e

Co lu mn Name Co lu mn Descrip tio n

• 1: E mail

• 2: File

• 4: P rint er

• 8: Cust om

• 16: Hist ory List

ID
• 20: Client

• 40: Cache

• 100: (Mic roStrategy us e only)

• 128: Mobile

• 255: (Mic roStrategy us e only)

I S _S UB S _I NS T_I D GUI D of t he subscript ion.

I S _S UB S _I NS T_NA ME Name of t he subscript ion.

GUI D of t he schedule t hat t riggered t he subscript ion, or -

I S _S CHE DULE _I D
1 if not applicable.

I S _DA TA _I D GUI D of t he report or document request ed.

Type of cont act delivered t o:

• 1: Cont act

• 2: Cont act group

• 4: MicroS t rat egy user

I S _CONTA CT_TY P E _I D
• 5: Count

• 8: MicroS t rat egy user group

• 10: LDA P user

• 31: (Mic roStrategy us e only)

GUI D of t he group receiving t he subscript ion, or NULL if

I S _RCP T_GROUP _I D
no group.

195 9 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Co lu mn Name Co lu mn Descrip tio n

I S _RCP T_CONTA CT_

Name of t he cont act recipient .
NA ME

I ndicat es whet her t he address where t he cont ent was

I S _DFLT_A DDR
delivered is t he def ault .

I S _A DDRE S S _I D GUI D of t he address delivered t o.

I S _DE V I CE _I D I D of t he Dist ribut ion S ervices device used in t he delivery.

I S _NOTI F_MS G I ndicat es whet her a delivery not if icat ion message is sent .

I S _NOTI F_A DDR GUI D of t he not if icat ion address.

I S _S E RV E R_I D Numeric I D of t he server def init ion.

I S _P ROJ_I D Numeric I D of t he source project .

I S _E X E C_S T_TM_TS S t art t ime f or subscript ion execut ion.

I S _E X E C_FM_TM_TS Finish t ime f or subscript ion execut ion.

I S _DE LI V E RY _S TA TUS I ndicat es whet her t he delivery was successf ul.

I S _P HY S I CA L_A DD P hysical address f or delivery.

I S _B A TCH_I D Reserved f or MicroS t rat egy use.

E M_A P P _S RV _
Name of t he I nt elligence S erver.
MA CHI NE

IS_PERF_MON_FACT
C ontai ns i nformati on about j ob performance .

Source Table

l IS_PER F_MON _STATS: Stati sti cs tabl e contai ni ng i nformati on

about j ob performance

© 2019, M icr o St r at egy In c. 1960

Syst em Ad m in ist r at io n Gu id e

Related Lookup Table

l IS_PR OJ: Lookup tabl e for proj ects

List of Table Columns

Co lu mn Name Co lu mn Descrip tio n

Timest amp of when t he inf ormat ion was recorded by

E M_RE CORD_TS
I nt elligence S erver int o t he _S TA TS t able.

Timest amp of when t he E nt erprise Manager dat a load process

E M_LOA D_TS
began.

E M_A P P _S RV _ The name of t he I nt elligence S erver machine logging t he

MA CHI NE st at ist ics.

I S _COUNTE R_ The cat egory of t he count er, such as Memory, MicroS t rat egy
CA T S erver Jobs, or MicroS t rat egy S erver Users.

I S _COUNTE R_
MicroS t rat egy use.
I NS TA NCE

I S _COUNTE R_
The name of t he perf ormance count er.
NA ME

I S _E V E NT_TI ME Timest amp of when t he event occurred in I nt elligence S erver.

I S _COUNTE R_
The value of t he perf ormance count er.
V A LUE

I S _CTR_V A L_TY P The t ype of perf ormance count er.

I S _P ROJ_I D I nt eger I D of t he project logged int o.

DA Y _I D I nt eger I D of t he day. Format Y Y Y MMDD.

HOUR_I D I nt eger I D of t he hour. Format HH (24 hours).

MI NUTE _I D I nt eger I D of t he minut e.

1961 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

IS_PR_ANS_FACT
C ontai ns i nformati on about prompt answ ers. C reated as a vi ew based
on col umns i n the source tabl es l i sted bel ow .

Source Tables

l EM_MD : Lookup tabl e for metadata

l EM_PR _AN S_TYPE: Lookup tabl e for prompt answ er type

l IS_PR _AN S_STATS: Stati sti cs tabl e contai ni ng i nformati on about

sessi on acti vi ty

l IS_PR OJ: Lookup tabl e for proj ects

l IS_PR OMPT: Lookup tabl e for prompts

l IS_SER VER : Lookup tabl e for Intel l i gence Server defi ni ti ons

l LU _OBJ_TYPE: Lookup tabl e for C OM obj ect type

List of Table Columns

Co lu mn Name Co lu mn Descrip tio n

Timest amp when t he inf ormat ion was recorded by I nt elligence

E M_RE CORD_TS
S erver int o t he _S TA TS t able.

I S _RE P _JOB _I D Job I D assigned by t he server.

I S _S E S S I ON_I D GUI D f or t he user session.

P R_ORDE R_I D Order in which prompt s were answered.

P R_A NS _S E Q S equence I D. For MicroS t rat egy use.

P R_LOC_I D I D of t he object t hat t he prompt resides in.

P R_LOC_TY P E COM object t ype of t he object t hat t he prompt resides in.

© 2019, M icr o St r at egy In c. 1962

Syst em Ad m in ist r at io n Gu id e

Co lu mn Name Co lu mn Descrip tio n

P R_LOC_DE S C Object name of t he object t hat t he prompt resides in.

P R_A NS _GUI D Reserved f or MicroS t rat egy use.

P R_A NS WE RS P rompt answers.

P R_A NS _TY P E P rompt answer t ype.

I S _S E RV E R_I D I nt eger I D of t he server where t he session was creat ed.

P R_I D I nt eger I D of t he prompt .

P R_GUI D GUI D of t he prompt .

P R_TI TLE P rompt t it le.

P R_NA ME P rompt name.

Y if a prompt answer is required, N if a prompt answer is not

I S _RE QUI RE D
required.

I S _P ROJ_I D I nt eger I D of t he project logged int o.

I S _P ROJ_NA ME P roject name.

E M_A P P _S RV _
The I nt elligence S erver machine name and I P address.
MA CHI NE

DA Y _I D Day t he prompt was answered.

HOUR_I D Hour t he prompt was answered.

MI NUTE _I D Minut e t he prompt was answered.

I S _RE P OS I TORY _
I nt eger I D of t he met adat a reposit ory.
ID

IS_PROJECT_FACT_1
R epresents the number of l ogi ns to a proj ect i n a day by user sessi on
and proj ect.

1963 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Source Tables

l IS_PR OJ_SESSION _STATS: Stati sti cs tabl e contai ni ng i nformati on

on sessi on acti vi ty by proj ect

l IS_SESSION _STATS: Stati sti cs tabl e contai ni ng i nformati on about

sessi on acti vi ty on Intel l i gence Server

l IS_SER VER : Lookup tabl e for Intel l i gence Server defi ni ti ons

l EM_U SER : Lookup tabl e for users

l IS_PR OJ: Lookup tabl e for proj ects

List of Table Columns

Co lu mn Name Co lu mn Descrip tio n

I S _S E S S I ON_I D GUI D of t he session object .

I S _P ROJ_I D I nt eger I D of t he project logged int o.

I S _S E RV E R_I D I nt eger I D of t he server where t he session was creat ed.

E M_A P P _S RV _ The name of t he I nt elligence S erver machine logging t he

MA CHI NE st at ist ics.

E M_US E R_I D I nt eger I D of t he user who creat ed t he session.

I S _CONNE CT_TS Timest amp of t he beginning of t he session (login).

Timest amp of t he end of t he session (logout ). NULL if t he

I S _DI S CONNE CT_
session is st ill open at t he t ime of E nt erprise Manager dat a
TS
load.

I S _TMP _DI S CON_ Represent s t emporary end of a session, if t hat session is st ill
TS open. Used t o calculat e t he session t ime.

I S _S E S S I ON_TM_
Durat ion wit hin t he hour, in seconds, of t he session.
SEC

E M_RE CORD_TS Timest amp when t he inf ormat ion was recorded by I nt elligence

© 2019, M icr o St r at egy In c. 1964

Syst em Ad m in ist r at io n Gu id e

Co lu mn Name Co lu mn Descrip tio n

S erver int o t he _S TA TS t able.

Timest amp of when t he E nt erprise Manager dat a load process

E M_LOA D_TS
began.

DA Y _I D I nt eger I D of t he day. Format Y Y Y MMDD.

HOUR_I D Hour t he user logged in.

MI NUTE _I D Minut e t he user logged in.

I S _RE P OS I TORY _
I nt eger I D of t he met adat a reposit ory.
ID

IS_REP_COL_FACT
U sed to anal yze w hi ch data w arehouse tabl es and col umns are
accessed by Mi croStrategy report j obs, by w hi ch SQL cl ause they are
accessed (SELEC T, FR OM, and so on), and how frequentl y they are
accessed. Thi s fact tabl e i s at the l evel of a R eport Job rather than at
the l evel of each SQL pass executed to sati sfy a report j ob request.
The i nformati on avai l abl e i n thi s tabl e can be useful for database
tuni ng. C reated as a vi ew based on col umns i n the source tabl es
l i sted bel ow .

Source Tables

l IS_R EP_C OL_STATS: Stati sti cs tabl e contai ni ng i nformati on about

col umn-tabl e combi nati ons used i n the SQL duri ng report
executi ons

l IS_SESSION : Lookup tabl e for sessi on obj ects

l IS_R EP_FAC T: Fact tabl e for report j ob executi ons

1965 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l IS_D B_TAB: Lookup tabl e for database tabl es

l IS_C OL: Lookup tabl e for col umns

List of Table Columns

Co lu mn Name Co lu mn Descrip tio n

Timest amp when inf ormat ion was recorded by I nt elligence

E M_RE CORD_TS
S erver int o t he _S TA TS t ables.

I S _JOB _I D I nt eger I D of t he report job execut ion.

I S _S E S S I ON_I D GUI D of t he current session object .

I S _COL_GUI D GUI D of t he column object .

I S _TA B LE _I D I nt eger I D of t he physical dat abase t able t hat was used.

I S _COL_NA ME Name of t he column in t he dat abase t able t hat was used.

S QL_CLA US E _ I nt eger I D of t he t ype of S QL clause (S E LE CT, FROM,

TY P E _I D WHE RE , and so on).

The number of t imes a specif ic column/ t able/ clause t ype

COUNTE R
combinat ion occurs wit hin a report execut ion.

DA Y _I D Day t he job was execut ed.

HOUR_I D Hour t he job was execut ed.

MI NUTE _I D Minut e t he job was execut ed.

IS_REP_FACT
C ontai ns i nformati on about report j ob executi ons.

Pri mary key:

l D AY_ID 2

l IS_SESSION _ID

© 2019, M icr o St r at egy In c. 1966

Syst em Ad m in ist r at io n Gu id e

l IS_R EP_JOB_SES_ID

l IS_R EP_JOB_ID

l IS_D OC _JOB_ID

l IS_R EP_C AC H E_ID X

Source Tables

l IS_C AC H E_H IT_STATS: Stati sti cs tabl e contai ni ng i nformati on

about j ob executi ons that hi t a cache

l IS_D OC _FAC T: Fact tabl e contai ni ng i nformati on about document

j ob executi ons

l IS_D OC U MEN T_STATS: Stati sti cs tabl e contai ni ng i nformati on

about document j ob executi ons

l IS_R EP_SEC _STATS: Stati sti cs tabl e contai ni ng i nformati on about

j ob executi ons w i th securi ty fi l ters

l IS_R EPOR T_STATS: Stati sti cs tabl e contai ni ng i nformati on about

report j ob executi ons

l IS_SC H ED U LE_STATS: Stati sti cs tabl e contai ni ng i nformati on

about j ob executi ons run by a schedul e

l EM_IS_LAST_U PD _2: C onfi gurati on tabl e that dri ves the l oadi ng
process (for exampl e, data l oadi ng w i ndow )

Related Lookup Tables

l IS_SESSION : Lookup tabl e for sessi on obj ects

l IS_R EP: Lookup tabl e for report obj ects

l IS_TEMP: Lookup tabl e for templ ate obj ects

l IS_FILT: Lookup tabl e for fi l ter obj ects

1967 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l IS_SC H ED : Lookup tabl e for schedul e obj ects

l IS_D OC : Lookup tabl e for document obj ects

List of Table Columns

Co lu mn Name Co lu mn Descrip tio n

Timest amp when t he inf ormat ion was recorded by

E M_RE CORD_TS
I nt elligence S erver int o t he _S TA TS t able.

Timest amp of when t he E nt erprise Manager dat a load

E M_LOA D_TS
process began.

I S _S E RV E R_I D I nt eger I D of t he server where t he session was creat ed.

I S _S E S S I ON_I D GUI D of t he current session object .

GUI D of t he session t hat creat ed t he cache if a cache was

I S _RE P _JOB _S E S _
hit in t his execut ion; ot herwise, current session (def ault
ID
behavior).

I S _RE P _JOB _I D I nt eger I D of t he report job execut ion.

I nt eger I D of t he cache hit index; similar t o Job I D but only

I S _RE P _CA CHE _I DX
f or cache hit s. -1 if no cache hit .

I S _CA CHE _HI T_I D I ndicat es whet her t he job hit a cache.

I S _CA CHE _
I ndicat es whet her a cache was creat ed.
CRE A TE _I D

E M_US E R_I D I nt eger I D of t he user who creat ed t he session.

E M_DB _US E R_I D DB User used t o log in t o t he warehouse.

I S _DB _I NS T_I D I nt eger I D of t he db inst ance object .

I S _P ROJ_I D I nt eger I D of t he project logged in t o.

I S _RE P _I D I nt eger I D of t he report object .

I S _E MB _FI LT_I ND_

I ndicat es whet her t he report f ilt er is embedded.
ID

© 2019, M icr o St r at egy In c. 1968

Syst em Ad m in ist r at io n Gu id e

Co lu mn Name Co lu mn Descrip tio n

I S _E MB _TE MP _I ND_
I ndicat es whet her t he report t emplat e is embedded.
ID

I S _FI LT_I D I nt eger I D of t he f ilt er object .

I S _TE MP _I D I nt eger I D of t he t emplat e object .

• I nt eger I D of t he parent document execut ion if current

report is a child of a document .

I S _DOC_JOB _I D • I nt eger I D of t he parent document execut ion of t he

original report if a cache was hit .

• Ot herwise, -1.

I nt eger I D of t he parent document object if current report is

I S _DOC_I D
a child of a document . Ot herwise, -1.

Timest amp of t he execut ion request ; request of t he current

I S _RE P _RE Q_TS
session.

Timest amp of t he execut ion request ; request t ime of t he

I S _RE P _E X E C_RE Q_
original execut ion request if a cache was hit , ot herwise
TS
current session's request t ime.

I S _RE P _E X E C_S T_
Timest amp of t he execut ion st art .
TS

I S _RE P _E X E C_FN_
Timest amp of t he execut ion f inish.
TS

I S _RE P _QU_TM_MS Queue durat ion in milliseconds.

I S _RE P _CP U_TM_

CP U durat ion in milliseconds.
MS

I S _RE P _E X E C_TM_
E xecut ion durat ion in milliseconds.
MS

I S _RE P _E LA P S _TM_ Dif f erence bet ween st art t ime and f inish t ime; includes t ime
MS f or prompt responses.

I S _RE P _NB R_S QL_ Number of S QL passes.

1969 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Co lu mn Name Co lu mn Descrip tio n

PAS

I S _RE P _RE S ULT_

Number of rows in t he result set .
S I ZE

I S _RE P _S QL_
Not yet available. Number of charact ers.
LE NGTH

I S _RE P _NB R_
Not yet available. Number of t ables.
TA B LE S

I S _RE P _NB R_P U_

Number of st eps processed in t he execut ion.
S TP S

I S _RE P _NB R_
Number of prompt s in t he report execut ion.
P ROMP TS

I S _JOB _E RROR_I D I nt eger I D of t he job's error message, if any.

I S _E RROR_I ND_I D I ndicat es whet her t he job got an error.

I S _DB _E RROR_I ND_

I ndicat es whet her t he dat abase ret urned an error.
ID

I S _CA NCE LLE D_I D I ndicat es whet her t he job was canceled.

I S _A D_HOC_I D I ndicat es whet her t he job was creat ed ad hoc.

I S _DA TA MA RT_I D I ndicat es whet her t he job creat ed a dat a mart .

I S _E LE M_LOA D_I D I ndicat es whet her t he job was t he result of an element load.

I S _DRI LL_I D I ndicat es whet her t he job was t he result of a drill.

I S _S E C_FI LT_I ND_ I ndicat es whet her t he job had a securit y f ilt er associat ed
ID wit h it .

I S _S E C_FI LT_I D I nt eger I D of t he securit y f ilt er applied.

I S _S CHE D_I D I nt eger I D of t he schedule t hat execut ed t he job.

I S _S CHE D_I ND_I D I ndicat es whet her t he job was execut ed by a schedule.

© 2019, M icr o St r at egy In c. 1970

Syst em Ad m in ist r at io n Gu id e

Co lu mn Name Co lu mn Descrip tio n

I S _RE P _P RI O_NB R P riorit y of t he report execut ion.

I S _RE P _COS T_NB R Cost of t he report execut ion.

DA Y _I D2 I nt eger I D of t he day. Format Y Y Y Y MMDD.

HOUR_I D I nt eger I D of t he hour. Format HH (24 hours).

MI NUTE _I D2 I nt eger I D of t he minut e. Format HHMM (24 hours).

I nt eger I D of an at t ribut e, met ric, or ot her object t hat is

DRI LLFROM
drilled f rom.

I nt eger I D f or t he object t ype of t he object t hat is drilled

DRI LLFROM_OT_I D
f rom.

I nt eger I D of an at t ribut e, t emplat e, or ot her object t hat is

DRI LLTO
drilled t o.

DRI LLTO_OT_I D I nt eger I D f or t he object t ype of t he object t hat is drilled t o.

I nt eger f lag indicat ing t he t ype of drill perf ormed (f or

DRI LLTY P E
example, drill t o t emplat e, drill t o at t ribut e, and so on).

E RRORME S S A GE E rror message ret urned by I nt elligence S erver.

I S _CA CHE _ A lphanumeric I D of t he session t hat creat ed t he cache on

S E S S I ON_I D I nt elligence S erver.

I nt eger I D of t he job t hat creat ed t he cache on I nt elligence

I S _CA CHE _JOB _I D
S erver.

I S _RE P _P MT_A NS _
Dat a and t ime when t he prompt was answered.
TS

I S _S QL_E X E C_I ND_ I nt eger I D indicat ing if t his job hit generat ed S QL and hit a
ID dat abase or not .

I S _E X P ORT_I ND_I D I nt eger I D indicat ing if t his was an export job or not .

I S _CUB E _I NS T_I D GUI D of t he I nt elligent Cube object (if job hit s it ).

I S _CUB E _S I ZE S ize of t he I nt elligent Cube t he job hit s (if applicable).

1971 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Co lu mn Name Co lu mn Descrip tio n

I S _RE P _P R_A NS _ Time in milliseconds of how long t he user t ook t o answer t he

TM_MS prompt .

I S _E X E C_FLA G I nt ernal f lag t hat indicat es t he t ype of job execut ion.

I S _RE P OS I TORY _I D I nt eger I D of t he met adat a reposit ory.

I S _ME S S A GE _I D I nt ernal alphanumeric I D at t ached t o every job.

DA Y _I D This c olumn is deprec ated.

MI NUTE _I D This c olumn is deprec ated.

IS_REP_SEC_FACT
C ontai ns i nformati on about securi ty fi l ters appl i ed to report j obs.
C reated as a vi ew based on col umns i n the source tabl es l i sted
bel ow .

Source Tables

l IS_R EP_FAC T: C ontai ns i nformati on about report j ob executi ons

l IS_R EP_SEC _STATS: Stati sti cs tabl e contai ni ng i nformati on about

j ob executi ons w i th securi ty fi l ters

l IS_SEC _FILT: Provi des descri pti ve i nformati on about the securi ty
fi l ters bei ng tracked

l IS_SF_ATT: R el ati onshi p tabl e betw een securi ty fi l ters and

attri butes

© 2019, M icr o St r at egy In c. 1972

Syst em Ad m in ist r at io n Gu id e

List of Table Columns

Co lu mn Name Co lu mn Descrip tio n

Timest amp when t he inf ormat ion was recorded by I nt elligence

E M_RE CORD_TS
S erver int o t he _S TA TS t able.

Timest amp of when t he E nt erprise Manager dat a load process

E M_LOA D_TS
began.

I S _P ROJ_I D I nt eger I D of t he project logged in t o.

GUI D of t he session t hat creat ed t he cache if a cache was hit

I S _RE P _JOB _S E S _
in t his execut ion; ot herwise, current session (def ault
ID
behavior).

I S _RE P _JOB _I D I nt eger I D of t he report job execut ion.

I S _RE P _S E C_FI LT_

I nt eger I D of t he securit y f ilt er.
ID

I S _A TT_I D I nt eger I D of t he at t ribut e.

DA Y _I D Day t he job was request ed f or execut ion.

HOUR_I D Hour t he job was request ed f or execut ion.

MI NUTE _I D Minut e t he job was request ed f or execut ion.

I S _RE P OS I TORY _
I nt eger I D of t he met adat a reposit ory.
ID

IS_REP_SQL_FACT
C ontai ns the SQL that i s executed on the w arehouse by report j ob
executi ons. C reated as a vi ew based on col umns i n the source tabl es
l i sted bel ow .

1973 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Source Tables

l IS_R EP_FAC T: C ontai ns i nformati on about report j ob executi ons

l IS_PR OJ: Lookup tabl e for proj ects

l IS_R EP_SQL_STATS: Stati sti cs tabl e contai ni ng i nformati on about

SQL statements

List of Table Columns

Co lu mn Name Co lu mn Descrip tio n

Timest amp when t he inf ormat ion was recorded by

E M_RE CORD_TS
I nt elligence S erver int o t he _S TA TS t able.

I S _P ROJ_I D I nt eger I D of t he project logged int o.

I S _P ROJ_NA ME P roject name.

I S _RE P _JOB _S E S _
GUI D of t he current session object .
ID

I S _RE P _JOB _I D I nt eger I D of t he report job execut ion.

I S _P A S S _S E Q_NB R I nt eger I D of t he sequence of t he pass.

I f a S QL st at ement is very long, it is broken int o mult iple

rows. This column represent s t he S equence of a S QL
I S _RE P _S QL_S E Q S t at ement . For example, if a S QL is very long and broken
int o t wo part s, t his t able would cont ain t wo rows f or t hat S QL
wit h t he value of t his column being '1' and '2'.

I S _RE P _E X E C_S T_
Timest amp of t he execut ion st art .
TS

I S _RE P _E X E C_FN_
Timest amp of t he execut ion f inish.
TS

I S _RE P _E X E C_TM_
E xecut ion durat ion in milliseconds.
MS

© 2019, M icr o St r at egy In c. 1974

Syst em Ad m in ist r at io n Gu id e

Co lu mn Name Co lu mn Descrip tio n

I S _RE P _S QL_
S QL st at ement .
S TA TE M

I S _RE P _S QL_
Lengt h of S QL st at ement .
LE NGTH

I S _RE P _NB R_
Number of t ables accessed by S QL st at ement .
TA B LE S

I S _P A S S _TY P E _I D I nt eger I D of t he t ype of S QL pass.

I S _RE P _DB _E RR_

E rror ret urned f rom t he dat abase; NULL if no error.
MS G

DA Y _I D Day t he job was request ed f or execut ion.

HOUR_I D Hour t he job was request ed f or execut ion.

MI NUTE _I D Minut e t he job was request ed f or execut ion.

I S _RE P OS I TORY _
I nt eger I D of t he met adat a reposit ory.
ID

IS_REP_STEP_FACT
C ontai ns i nformati on about the processi ng steps through w hi ch the
report executi on passes. C reated as a vi ew based on col umns i n the
source tabl es l i sted bel ow .

Source Tables

l IS_R EP_STEP_STATS: Stati sti cs tabl e contai ni ng i nformati on

about report j ob processi ng steps

l IS_R EPOR T_STATS: Stati sti cs tabl e contai ni ng i nformati on about

report j ob executi ons

1975 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

l IS_SESSION : Lookup tabl e for sessi on obj ects

l IS_PR OJ: Lookup tabl e for proj ects

List of Table Columns

Co lu mn Name Co lu mn Descrip tio n

Timest amp when t he inf ormat ion was recorded by I nt elligence

E M_RE CORD_TS
S erver int o t he _S TA TS t able.

I S _P ROJ_I D I nt eger I D of t he project logged int o.

I S _P ROJ_NA ME P roject name.

I S _RE P _JOB _S E S _
GUI D of t he current session object .
ID

I S _RE P _JOB _I D I nt eger I D of t he report job execut ion.

I S _RE P _S TE P _
I nt eger I D of t he sequence of t he st ep.
S E Q_I D

I S _RE P _S TE P _
I nt eger I D of t he t ype of st ep.
TY P _I D

I S _RE P _E X E C_S T_
Timest amp of t he execut ion st art .
TS

I S _RE P _E X E C_FN_
Timest amp of t he execut ion f inish.
TS

I S _RE P _QU_TM_
Queue durat ion in milliseconds.
MS

I S _RE P _CP U_TM_

CP U durat ion in milliseconds.
MS

I S _RE P _E X E C_TM_
E xecut ion durat ion in milliseconds.
MS

DA Y _I D Day t he job was request ed f or execut ion.

© 2019, M icr o St r at egy In c. 1976

Syst em Ad m in ist r at io n Gu id e

Co lu mn Name Co lu mn Descrip tio n

HOUR_I D Hour t he job was request ed f or execut ion.

MI NUTE _I D Minut e t he job was request ed f or execut ion.

I S _RE P OS I TORY _
I nt eger I D of t he met adat a reposit ory.
ID

IS_SESSION_FACT
Enabl es sessi on concurrency anal ysi s. Keeps data on each sessi on
for each hour of connecti vi ty.

Related Lookup Tables

l IS_SESSION : Lookup tabl e for sessi on obj ects

l D T_D AY: Lookup tabl e for dates

l TM_H OU R : Lookup tabl e for hours

List of Table Columns

Co lu mn Name Co lu mn Descrip tio n

I S _S E S S I ON_I D GUI D of t he session object .

I S _S E RV E R_I D I nt eger I D of t he server where t he session was creat ed.

E M_US E R_I D I nt eger I D of t he user who creat ed t he session.

I S _CONNE CT_TS Timest amp of t he beginning of t he session (login).

Timest amp of t he end of t he session (logout ). NULL if t he

I S _DI S CONNE CT_TS session is st ill open at t he t ime of E nt erprise Manager dat a
load.

I S _CONNE C_M_I D I nt eger represent at ion of t he day and hour when t he

1977 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Co lu mn Name Co lu mn Descrip tio n

connect ion began. Format : Y Y Y Y MMDDHH (24 hours).

I nt eger represent at ion of t he day and hour when t he

I S _DI S CON_M_I D
connect ion ended. Format : Y Y Y Y MMDDHH (24 hours).

Connect ion source t hrough which t he session was

est ablished:

• 0: Unknown

• 1: MicroS t rat egy Developer

• 2: MicroS t rat egy I nt elligence S erver A dminist rat or

• 3: MicroS t rat egy Web A dminist rat or

• 4: MicroS t rat egy I nt elligence S erver

• 5: MicroS t rat egy P roject Upgrade

• 6: MicroS t rat egy Web

• 7: MicroS t rat egy S cheduler

• 8: Cust om applicat ion

E M_CONNE CT_ • 9: MicroS t rat egy Narrowcast S erver
S OURCE
• 10: MicroS t rat egy Object Manager

• 11: ODB O P rovider

• 12: ODB O Cube Designer

• 13: MicroS t rat egy Command Manager

• 14: MicroS t rat egy E nt erprise Manager

• 15: MicroS t rat egy Command Line I nt erf ace

• 16: MicroS t rat egy P roject B uilder

• 17: MicroS t rat egy Conf igurat ion Wizard

• 18: MicroS t rat egy MD S can

• 19: MicroS t rat egy Cache Ut ilit y

• 20: MicroS t rat egy Fire E vent

© 2019, M icr o St r at egy In c. 1978

Syst em Ad m in ist r at io n Gu id e

Co lu mn Name Co lu mn Descrip tio n

• 21: MicroS t rat egy Java A dmin Client s

• 22: MicroS t rat egy Web S ervices

• 23: MicroS t rat egy Of f ice

• 24: MicroS t rat egy Tools

• 25: MicroS t rat egy P ort al S erver

• 26: MicroS t rat egy I nt egrit y Manager

• 27: Met adat a Updat e

• 28: COM B rowser

• 29: MicroS t rat egy Mobile

• 30: Reposit ory Translat ion Wizard

• 32: MicroS t rat egy Cube A dvisor

DA Y _I D I nt eger I D of t he day. Format : Y Y Y Y MMDD.

HOUR_I D I nt eger I D of t he hour. Format HH (24 hours).

MI NUTE _I D Minut e t he job was execut ed.

IS_SESSION_MONITOR
For Mi croStrategy use. A vi ew tabl e that provi des an overvi ew of
recent sessi on acti vi ty.

Lookup Tables

T ab le Name F u n ctio n

Lookup t able f or mobile client execut ion t ype.

CT_E X E C_TY P E • 0: Unknown

• 1: User

1979 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

T ab le Name F u n ctio n

• 2: P re-cached

• 3: A pplicat ion recovery

• 4: S ubscript ion cache pre-loading

• 5: Transact ion subsequent act ion

• 6: Report queue

• 7: Report queue recall

• 8: B ack but t on

Lookup t able f or mobile client manipulat ion t ype:

• 0: Unknown

• 1: S elect or

• 2: P anel S elect or

• 3: A ct ion S elect or

• 4: Change Layout

• 5: Change V iew

• 6: S ort
CT_MA NI P _TY P E
• 7: P age B y

• 8: I nf ormat ion Window

• 9: A nnot at ions

• 10: E -mail S creenshot s

• 11: Widget : V ideo-P lay

• 12: Widget : V ideo-P ause

• 20: Widget : Mult iple-Download

• 21: Widget : Mult iple-Open

DT_DA Y Lookup t able f or Days in t he Dat e hierarchy.

DT_MONTH Lookup t able f or Mont hs in t he Dat e hierarchy.

© 2019, M icr o St r at egy In c. 1980

Syst em Ad m in ist r at io n Gu id e

T ab le Name F u n ctio n

DT_MONTH_OF_Y R Lookup t able f or Mont hs of t he Y ear in t he Dat e hierarchy.

DT_QUA RTE R Lookup t able f or Quart ers in t he Dat e hierarchy.

DT_QUA RTE R_OF_ Lookup t able f or t he Quart ers of t he Y ear in t he Dat e

YR hierarchy.

DT_WE E K DA Y Lookup t able f or t he Days of t he Week in t he Dat e hierarchy.

DT_WE E K OFY E A R Lookup t able f or Weeks of t he Y ear in t he Dat e hierarchy.

DT_Y E A R Lookup t able f or Y ears in t he Dat e hierarchy.

E M_A P P _S RV _ Lookup t able f or I nt elligence S erver machines used in

MA CHI NE st at ist ics.

E M_CLI E NT_
Lookup t able f or Client Machines used in t he st at ist ics.
MA CHI NE

E M_CONNE CT_ Lookup t able f or t he connect ion source of a session on

S OURCE I nt elligence S erver.

E M_DB _US E R Lookup t able f or t he dat abase users used in t he st at ist ics.

E M_E X I S TS _I ND Lookup t able f or t he exist ence st at us of object s.

E M_HI DDE N_I ND Lookup t able f or t he hidden st at us of object s.

Lookup t able f or t he job st at us of job execut ions on

I nt elligence S erver:

• 0: Ready

• 1: E xecut ing

• 2: Wait ing
E M_JOB _S TA TUS
(Deprecat ed) • 3: Complet ed

• 4: E rror

• 5: Cancelled

• 6: S t opped

• 7: Wait ing f or governor

1981 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

T ab le Name F u n ctio n

• 8: Wait ing f or prompt

• 9: Wait ing f or project

• 10: Wait ing f or cache

• 11: Wait ing f or children

• 12: Wait ing f or f et ching result s

E M_MONI TORE D_ P rovides inf ormat ion about t he project s being monit ored
P ROJE CTS and when t he f irst and last dat a loads occurred.

P rovides descript ive inf ormat ion about t he owners being

E M_OWNE R t racked. This t able is a view based on columns f rom t he
E M_US E R t able.

P rovides descript ive inf ormat ion about t he users being

E M_US E R
t racked.

P rovides descript ive inf ormat ion about t he user groups

E M_US R_GP
being t racked.

E M_WE B _S RV _ Lookup t able f or t he Web S erver Machines used in t he

MA CHI NE st at ist ics.

I S _A D_HOC_I ND Lookup t able f or t he A d Hoc indicat or.

P rovides descript ive inf ormat ion about t he at t ribut es being

I S _A TT
t racked.

P rovides descript ive inf ormat ion about t he at t ribut e f orms

I S _A TT_FORM
being t racked.

I S _CA CHE _
Lookup t able f or t he Cache Creat ion indicat or.
CRE A TI ON_I ND

Lookup t able f or t he Cache Hit indicat or:

I S _CA CHE _HI T_ • 0: No cache hit

TY P E • 1: S erver cache

• 2: Device cache

© 2019, M icr o St r at egy In c. 1982

Syst em Ad m in ist r at io n Gu id e

T ab le Name F u n ctio n

• 6: A pplicat ion cache

I S _CA NCE LLE D_I ND Lookup t able f or t he Canceled indicat or.

I S _CHI LD_JOB _I ND Lookup t able f or t he Child Job indicat or.

P rovides descript ive inf ormat ion about t he columns being

I S _COL
t racked.

Lookup t able f or I nt elligence S erver and project -level

I S _CONFI G_P A RA M
conf igurat ion set t ings.

P rovides descript ive inf ormat ion about t he consolidat ions

I S _CONS
being t racked.

Lookup t able f or t he t ype of cont act delivered t o t hrough

I S _CONTA CT_TY P E
Dist ribut ion S ervices.

I S _CUB E _A CTI ON_ Lookup t able f or t he manipulat ions t hat can be perf ormed on
TY P E an I nt elligent Cube.

I S _CUB E _HI T_I ND Lookup t able f or t he Cube Hit indicat or.

P rovides descript ive inf ormat ion about t he I nt elligent Cubes

I S _CUB E _V I E W being t racked. This t able is a view based on columns f rom
t he I S _RE P t able.

P rovides descript ive inf ormat ion about t he cust om groups

I S _CUS T_GP
being t racked.

Lookup t able f or t he job t ype:

I S _DA TA _TY P E • 3: Report

• 55: Document

I S _DA TA MA RT_I ND Lookup t able f or t he Dat a Mart indicat or.

I S _DB _E RROR_I ND Lookup t able f or t he Dat abase E rror indicat or.

P rovides descript ive inf ormat ion about t he dat abase

I S _DB _I NS T
inst ances in t he monit ored I nt elligence S ervers.

1983 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

T ab le Name F u n ctio n

I S _DB _TA B Lookup t able f or t he dat abase t ables being monit ored.

I S _DE LI V E RY _
Lookup t able f or t he Delivery S t at us indicat or.
S TA TUS _I ND

I S _DE LI V E RY _TY P E Lookup t able f or t he Dist ribut ion S ervices delivery t ype.

P rovides descript ive inf ormat ion about t he devices being

I S _DE V I CE
t racked.

P rovides descript ive inf ormat ion about t he document

I S _DOC
object s being t racked.

Lookup t able f or t he st ep t ypes in document execut ion. For

I S _DOC_S TE P _TY P E a list and explanat ion of values, see Look up Tables, page
1979 .

I ndicat or lookup t able f or document or dossier t ype. Types

include:

• -1: Unknown
I S _DOCTY P E _I ND
• 0: HTML document

• 1: Report S ervices document

• 2: V isual I nsight dossier

I S _DRI LL_I ND Lookup t able f or t he Drill indicat or.

I S _E LE M_LOA D_I ND Lookup t able f or t he E lement Load indicat or.

I S _E RROR_I ND Lookup t able f or t he E rror indicat or.

P rovides descript ive inf ormat ion about t he event s being

I S _E V E NT
t racked.

I S _E X P ORT_I ND Lookup t able f or t he E xport indicat or.

P rovides descript ive inf ormat ion about t he f act s being

I S _FA CT
t racked.

P rovide descript ive inf ormat ion about t he f ilt ers being
I S _FI LT
t racked.

© 2019, M icr o St r at egy In c. 1984

Syst em Ad m in ist r at io n Gu id e

T ab le Name F u n ctio n

P rovides descript ive inf ormat ion about t he hierarchies being

I S _HI E R
t racked.

I S _HI E R_DRI LL_I ND Lookup t able f or t he Drillable Hierarchy indicat or.

P rovides a list of t he dif f erent manipulat ions t hat can be

I S _I NB OX _A CTI ON
perf ormed on a Hist ory List message.

I S _JOB _P RI ORI TY _
Lookup t able f or t he Job P riorit y t ype.
TY P E

P rovides descript ive inf ormat ion about t he met rics being
I S _ME T
t racked.

P rovides descript ive inf ormat ion about t he I nt elligent Cubes

I S _OLA P _CUB E
being t racked.

I S _P RI ORI TY _MA P I ndicat or lookup t able f or priorit y maps.

P rovides descript ive inf ormat ion about t he project s being

I S _P ROJ
t racked.

P rovides descript ive inf ormat ion about t he prompt s being

I S _P ROMP T
t racked.

I S _P ROMP T_I ND Lookup t able f or t he P rompt indicat or.

P rovides descript ive inf ormat ion about t he report s being

I S _RE P
t racked.

I S _RE P _S QL_P A S S _
Lookup t able f or t he S QL pass t ypes of report execut ion.
TY P E

Lookup t able f or t he st ep t ypes of report execut ion. For a

I S _RE P _S TE P _TY P E list and explanat ion of values, see Lookup Tables, page
1979 .

Lookup t able f or t he Report Cube Type indicat or:

I S _RE P CTY P E _I ND • 0: Reserved

• 1: B ase Report

1985 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

T ab le Name F u n ctio n

• 2: Working S et Report

• 3: P rivat e B ase Report

• 5: Report S ervices B ase Report

• 6: CS QL P re-E xecut ion Report

• 7: OLA P Cube Report

• 8: OLA P V iew Report

• 9: I ncrement al Ref resh Report

I ndicat or lookup t able f or report t ype. Report t ypes include:

• -1: Unknown: The server is unable t o ret rieve t he report

t ype.

• 0: Reserved: A d hoc report s. May include ot her report s

t hat are not persist ed in t he met adat a at t he point of
execut ion.

• 1: Relat ional: A ll regular project report s.

I S _RE P TY P E _I ND • 2: MDX : Report s built f rom S A P B W, E ssbase, A nalysis
S ervices, and ot her cube sources.

• 3: Cust om S QL Freef orm: MicroS t rat egy Freef orm S QL

report s, in which t he S QL is ent ered direct ly int o t he
int erf ace.

• 4: Cust om S QL Wizard: MicroS t rat egy Query B uilder

report s.

• 5: Flat File: Reserved f or MicroS t rat egy use.

P rovides descript ive inf ormat ion about t he schedules being

I S _S CHE D
t racked.

I S _S CHE DULE _I ND Lookup t able f or t he S chedule indicat or.

P rovides descript ive inf ormat ion about t he securit y f ilt ers
I S _S E C_FI LT
being t racked.

© 2019, M icr o St r at egy In c. 1986

Syst em Ad m in ist r at io n Gu id e

T ab le Name F u n ctio n

I S _S E C_FI LT_I ND Lookup t able f or t he S ecurit y Filt er indicat or.

P rovides descript ive inf ormat ion about t he server

I S _S E RV E R
def init ions being t racked.

Lookup t able f or t he session st at ist ics logged by I nt elligence

I S _S E S S I ON S ervers.

P rimary key: DA Y _I D, I S _S E S S I ON_I D

Lookup t able f or S QL clause t ypes; used t o det ermine which

S QL clause (S E LE CT, WHE RE , GROUP B Y , and so on) a
part icular column was used in during a report execut ion.

S QL Clause Type at t ribut es:

• 1: S elect : Column was used in t he S E LE CT clause but

was not aggregat ed, nor does it appear in a GROUP B Y
clause. For example, a11. Report column in " S elect
a11. Report f rom LU_RE P ORT a11" .

I S _S QL_CLA US E _ • 2: S elect Group B y: Column was used in t he GROUP B Y

TY P E clause. For example, a11. Report Column in " select
a11. Report , sum(a11. P rof it ) f rom LU_RE P ORT group by
a11. Report " .

• 4: S elect A ggregat e: Column was used f or aggregat ion.

For example, a11. Report column in " select count
(a11. Report ) f rom LU_RE P ORT" .

• 8: From: Column was used in a FROM clause

• 16: Where: Column was used in a WHE RE clause

• 17: Order B y: Column was used in an ORDE R B Y clause.

I S _S QL_E X E C_I ND Lookup t able f or t he S QL E xecut ion indicat or.

P rovides descript ive inf ormat ion about t he logical t ables

I S _TA B LE
being monit ored.

P rovides descript ive inf ormat ion about t he t emplat es being

I S _TE MP
monit ored.

1987 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

T ab le Name F u n ctio n

P rovides descript ive inf ormat ion about t he t ransf ormat ions
I S _TRA NS
being monit ored.

I S _TRA NS _MA P Lookup t able f or t he t ransf ormat ion mapping t ypes.

P rovides descript ive inf ormat ion about t he inf ormat ion
I S _TRA NS MI T
t ransmit t ers being monit ored.

TM_HOUR Lookup t able f or Hour in t he Time hierarchy.

TM_MI NUTE Lookup t able f or Minut e in t he Time hierarchy.

Transformation Tables

T ab le Name F u n ctio n

Transf ormat ion t able t o calculat e t he Y ear t o Dat e values f or

DT_MONTH_Y TD
Mont h.

DT_QUA RTE R_ Transf ormat ion t able t o calculat e t he Y ear t o Dat e values f or
Y TD Quart er.

Transf ormat ion t able t o calculat e t he Hour t o Day values f or

TM_HOUR_DTH
Hour.

Rep o r t an d Do cu men t St ep s
Thi s IS_R EP_STEP_TYPE tabl e l i sts the Intel l i gence Server tasks
i nvol ved i n executi ng a report or a document. These are the possi bl e
val ues for the IS_R EP_STEP_TYP_ID col umn i n the IS_R EP_STEP_
STATS tabl e and the IS_D OC _STEP_TYP_ID col umn i n the IS_D OC _
STEP_STATS tabl e.

Not all s teps are applic able to all ty pes of reports . For ex ample, if y ou
are not us ing Intelligent Cubes , thos e s teps are s k ipped.

© 2019, M icr o St r at egy In c. 1988

Syst em Ad m in ist r at io n Gu id e

T ask n ame T ask d escrip tio n

0: Unknown Reserved f or MicroS t rat egy use.

The Object S erver component in I nt elligence S erver

1: MD Object Request
request s t he object s necessary f or t he report .

2: Close Job I nt elligence S erver closes t he report execut ion job.

The S QL E ngine generat es t he S QL t o be execut ed

3: S QL Generat ion
against t he dat a warehouse.

The Query E ngine submit s t he generat ed S QL t o t he dat a

4: S QL E xecut ion
warehouse, and receives t he result .

The A nalyt ical E ngine applies addit ional processing st eps

5: A nalyt ical E ngine
t o t he dat a ret rieved f rom t he warehouse.

The Resolut ion S erver uses t he report def init ion t o

6: Resolut ion S erver
ret rieve object s f rom t he Object S erver.

The Report Net S erver processes report request s and

7: Report Net S erver
sends t hem t o t he Report S erver.

The Resolut ion S erver works wit h t he Object S erver and

8: E lement Request
E lement S erver t o resolve prompt s f or report request s.

I nt elligence S erver receives t he report inst ance f rom t he

9: Get Report I nst ance
Report S erver.

I f an error occurs, I nt elligence S erver sends a message t o

10: E rror Message S end
t he user, and logs t he error.

11: Out put Message When t he report f inishes execut ing, t he out put dat a is
S end sent t o t he client .

The Report S erver searches t he cache f or a previously

12: Find Report Cache
run report .

I nt elligence S erver execut es t he dat aset s needed f or t he

13: Document E xecut ion
document , and creat es t he document st ruct ure.

Once a document is execut ed, I nt elligence S erver sends

14: Document S end
t he out put t o t he client (such as MicroS t rat egy Developer

1989 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

T ask n ame T ask d escrip tio n

or Web).

Once a report is execut ed, t he Report S erver writ es t he

15: Updat e Report Cache
dat a t o t he report cache.

The client (such as MicroS t rat egy Developer or Web)

16: Request E xecut e
request s t he execut ion of a report or document .

The Query E ngine execut es t he S QL t o creat e t he dat a

17: Dat a Mart E xecut e
mart t able.

18: Document Dat a I nt elligence S erver prepares t he document dat a,

P reparat ion perf orming t asks such as dat aset joins, where applicable.

19: Document I nt elligence S erver combines t he dat a f or t he document

Format t ing wit h t he st ruct ure, and f ormat s t he out put .

20: Document I nt elligence S erver applies t he user's manipulat ions t o a

Manipulat ion document .

I nt elligence S erver execut es a view report against an

21: A pply V iew Cont ext
I nt elligent Cube.

The E xport E ngine f ormat s a report or document f or

22: E xport E ngine
export as a P DF, E xcel workbook, or X ML.

The S QL E ngine mat ches a view report , or a report t hat

23: Find I nt elligent Cube uses dynamic sourcing, wit h t he corresponding I nt elligent
Cube.

24: Updat e I nt elligent The Query E ngine runs t he S QL required t o ref resh t he
Cube dat a in t he I nt elligent Cube.

25: P ost -processing Task Reserved f or MicroS t rat egy use.

Dist ribut ion S ervices delivers t he report t o email, f iles,

26: Delivery
print ers, or mobile.

I nt elligence S erver checks if t he condit ions f or alert -

based subscript ions are met . I f so, t he subscribed report
27: P ersist Result
is execut ed and delivered. I f t he condit ion is not met , t he
job is cancelled.

© 2019, M icr o St r at egy In c. 1990

Syst em Ad m in ist r at io n Gu id e

T ask n ame T ask d escrip tio n

28: Document Dat aset The document is wait ing f or it s dat aset report jobs t o
E xecut ion f inish execut ing.

Relationship Tables

T ab le Name F u n ctio n

I S _A TT_A TT_FORM Relat ionship t able bet ween A t t ribut e and A t t ribut e Form.

I S _A TT_HI E R Relat ionship t able bet ween A t t ribut e and Hierarchy.

I S _COL_TA B LE Relat ionship t able bet ween Column and Table.

I S _ME T_TE MP Relat ionship t able bet ween Met ric and Templat e.

I S _RE P _A TT Relat ionship t able f or report s and component at t ribut es.

I S _RE P _CONS Relat ionship t able bet ween Consolidat ion and Report .

I S _RE P _DOC Relat ionship t able bet ween Report and Document .

I S _RE P _FI LT Relat ionship t able bet ween Filt er and Report .

I S _RE P _ME T Relat ionship t able f or report s and component met rics.

I S _RE P _P ROMP T Relat ionship t able bet ween P rompt and Report .

I S _RE P _TE MP LA TE Relat ionship t able bet ween Templat e and Report .

I S _S CHE D_RE L_
Relat ionship t able f or schedules and associat ed document s.
DOC

I S _S CHE D_RE LA TE Relat ionship t able f or schedules and associat ed report s.

I S _TA B LE _FA CT Relat ionship t able bet ween Table and Fact .

I S _TE MP _A TT Relat ionship t able bet ween Templat e and A t t ribut e.

I S _US E R_P ROJ_S F Relat ionship t able f or users and associat ed securit y f ilt ers.

I S _US R_GP _US E R Relat ionship t able bet ween User and User Group.

1991 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

T ab le Name F u n ctio n

I S _US R_GP _US R_ Relat ionship t able bet ween User Group and User Group
GP (P arent ).

Enterprise Manager Metadata Tables

The fol l ow i ng i s a descri pti on of Enterpri se Manager metadata tabl es.

T ab le Name F u n ctio n

Def ines all MicroS t rat egy component s being monit ored. The
abbreviat ion specif ies t he pref ix used on t ables relevant t o t he
component . When a new component is added t o t he
E M_COMP MicroS t rat egy product line, it can be ent ered in t his t able f or
monit oring.

Examples : I nt elligence S erver, Narrowcast S erver

P rovides t he Dat a Loading process wit h a working window t hat

E M_I S _LA S T_
ident if ies t he period during which dat a should be moved int o
UP DA TE
product ion area t ables.

Def ines all it ems in each component of t he MicroS t rat egy

product line being monit ored. When a new it em is added t o a
component , it can be ent ered in t his t able f or monit oring,
E M_I TE M wit hout any change t o t he migrat ion code. This t able also
specif ies t he it em's object t ype according t o server and t he
abbreviat ion used in t he lookup t able name.

Examples : Report , S erver Def init ion, User

I dent if ies propert ies being t racked on a given it em f or a given

component . The S QL f or t he it em is a concat enat ion of t he
general S QL in t he E M_I TE M_S QL t able and t he column
E M_I TE M_P ROP S names and values st ored in t his t able.

Examples : A t t ribut e Number of P arent s, Hierarchy Drill

E nabled

© 2019, M icr o St r at egy In c. 1992

Syst em Ad m in ist r at io n Gu id e

T ab le Name F u n ctio n

P rimary key: E M_COMP _I D, E M_I TE M_I D, E M_P ROP _I D

S t ores logging inf ormat ion f or E nt erprise Manager dat a loads.

The logging opt ion is enabled f rom t he E nt erprise Manager
E M_LOG console, Tools menu, Options select ion.

Dat a warehouse purges are not logged in t his t able.

S hows propert ies of t he E nt erprise Manager applicat ion (f or

E M_P ROP S
example: which project s and servers are being t racked).

E M_RE LA TE _ Cont ains a list of many-t o-many relat ionship t ables and t he
I TE M MicroS t rat egy it ems t hey relat e.

P rovides t he S QL necessary t o insert , updat e, and delet e a row

f rom t he lookup it em t able once t he necessary inf ormat ion f rom
t he component A P I is available. I f t he S QL must be changed,
make t he change in t his t able (no changes in t he code are
E M_S QL necessary). This t able also provides t he S QL used t o t ransf orm
t he logged st at ist ics int o t he lookup t ables.

Example : S QL st at ement s t o insert an at t ribut e int o t he

lookup at t ribut e t able in S QL S erver

Relationship Tables

T ab le Name F u n ctio n

I S _A TT_A TT_FORM Relat ionship t able bet ween A t t ribut e and A t t ribut e Form.

I S _A TT_HI E R Relat ionship t able bet ween A t t ribut e and Hierarchy.

I S _COL_TA B LE Relat ionship t able bet ween Column and Table.

I S _ME T_TE MP Relat ionship t able bet ween Met ric and Templat e.

I S _RE P _A TT Relat ionship t able f or report s and component at t ribut es.

1993 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

T ab le Name F u n ctio n

I S _RE P _CONS Relat ionship t able bet ween Consolidat ion and Report .

I S _RE P _DOC Relat ionship t able bet ween Report and Document .

I S _RE P _FI LT Relat ionship t able bet ween Filt er and Report .

I S _RE P _ME T Relat ionship t able f or report s and component met rics.

I S _RE P _P ROMP T Relat ionship t able bet ween P rompt and Report .

I S _RE P _TE MP LA TE Relat ionship t able bet ween Templat e and Report .

I S _S CHE D_RE L_
Relat ionship t able f or schedules and associat ed document s.
DOC

I S _S CHE D_RE LA TE Relat ionship t able f or schedules and associat ed report s.

I S _TA B LE _FA CT Relat ionship t able bet ween Table and Fact .

I S _TE MP _A TT Relat ionship t able bet ween Templat e and A t t ribut e.

I S _US E R_P ROJ_S F Relat ionship t able f or users and associat ed securit y f ilt ers.

I S _US R_GP _US E R Relat ionship t able bet ween User and User Group.

I S _US R_GP _US R_ Relat ionship t able bet ween User Group and User Group
GP (P arent ).

Enterprise Manager Metadata Tables

The fol l ow i ng i s a descri pti on of Enterpri se Manager metadata tabl es.

T ab le Name F u n ctio n

Def ines all MicroS t rat egy component s being monit ored. The
abbreviat ion specif ies t he pref ix used on t ables relevant t o t he
E M_COMP component . When a new component is added t o t he
MicroS t rat egy product line, it can be ent ered in t his t able f or
monit oring.

© 2019, M icr o St r at egy In c. 1994

Syst em Ad m in ist r at io n Gu id e

T ab le Name F u n ctio n

Examples : I nt elligence S erver, Narrowcast S erver

P rovides t he Dat a Loading process wit h a working window t hat

E M_I S _LA S T_
ident if ies t he period during which dat a should be moved int o
UP DA TE
product ion area t ables.

Def ines all it ems in each component of t he MicroS t rat egy

product line being monit ored. When a new it em is added t o a
component , it can be ent ered in t his t able f or monit oring,
E M_I TE M wit hout any change t o t he migrat ion code. This t able also
specif ies t he it em's object t ype according t o server and t he
abbreviat ion used in t he lookup t able name.

Examples : Report , S erver Def init ion, User

I dent if ies propert ies being t racked on a given it em f or a given

component . The S QL f or t he it em is a concat enat ion of t he
general S QL in t he E M_I TE M_S QL t able and t he column
names and values st ored in t his t able.
E M_I TE M_P ROP S
Examples : A t t ribut e Number of P arent s, Hierarchy Drill
E nabled

P rimary key: E M_COMP _I D, E M_I TE M_I D, E M_P ROP _I D

S t ores logging inf ormat ion f or E nt erprise Manager dat a loads.

The logging opt ion is enabled f rom t he E nt erprise Manager
E M_LOG console, Tools menu, Options select ion.

Dat a warehouse purges are not logged in t his t able.

S hows propert ies of t he E nt erprise Manager applicat ion (f or

E M_P ROP S
example: which project s and servers are being t racked).

E M_RE LA TE _ Cont ains a list of many-t o-many relat ionship t ables and t he
I TE M MicroS t rat egy it ems t hey relat e.

P rovides t he S QL necessary t o insert , updat e, and delet e a row

f rom t he lookup it em t able once t he necessary inf ormat ion f rom
E M_S QL
t he component A P I is available. I f t he S QL must be changed,
make t he change in t his t able (no changes in t he code are

1995 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

T ab le Name F u n ctio n

necessary). This t able also provides t he S QL used t o t ransf orm

t he logged st at ist ics int o t he lookup t ables.

Example : S QL st at ement s t o insert an at t ribut e int o t he

lookup at t ribut e t able in S QL S erver

Enterprise Manager Attributes and Metrics

The fol l ow i ng secti ons l i st the contents of the Enterpri se Manager
attri butes fol ders. These i ncl ude attri butes and shortcuts to metri cs
that are useful i n creati ng reports i n the Enterpri se Manager proj ect.
The i tems i n the fol ders are grouped by the type of reporti ng you can
do w i th them.

All Indicators and Flags Attributes

Attrib u te n ame F u n ctio n

A d Hoc I ndicat or I ndicat es whet her an execut ion is ad hoc.

Cache Creat ion

I ndicat es whet her an execut ion has creat ed a cache.
I ndicat or

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Cancelled I ndicat or I ndicat es whet her an execut ion has been cancelled.

I ndicat es whet her a job was a document dat aset or a st and-

Child Job I ndicat or
alone report .

Conf igurat ion Object

I ndicat es whet her a conf igurat ion object exist s.
E xist s S t at us

Conf igurat ion

List s all conf igurat ion paramet er t ypes.
P aramet er V alue Type

© 2019, M icr o St r at egy In c. 1996

Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

Connect ion S ource List s all connect ion sources t o I nt elligence S erver.

Cont act Type List s t he execut ed cont act t ypes.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

Dat abase E rror I ndicat es whet her a report request f ailed because of a
I ndicat or dat abase error.

Dat amart I ndicat or I ndicat es whet her an execut ion creat ed a dat a mart .

I ndicat es whet her an execut ion encount ered a dat abase

DB E rror I ndicat or
error.

Delivery S t at us
I ndicat es whet her a delivery was successf ul.
I ndicat or

Delivery Type List s t he t ype of delivery.

Document Job S t at us
List s t he st at uses of document execut ions.
(Deprecat ed)

Document Job S t ep
List s all possible st eps of document job execut ion.
Type

I ndicat es t he t ype of a document or dossier, such as HTML

Document Type
document , Report S ervices document , or a dossier.

List s t he object f rom which a user drilled when a new report

Drill f rom Object
was run because of a drilling act ion.

Drill I ndicat or I ndicat es whet her an execut ion is a result of a drill.

List s t he object t o which a user drilled when a new report

Drill t o Object
was run because of a drilling act ion.

I ndicat es whet her an execut ion is a result of an element

E lement Load I ndicat or
load.

E rror I ndicat or I ndicat es whet her an execut ion encount ered an error.

E xecut ion Type I ndicat es how t he cont ent was request ed, such as User

1997 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

I ndicat or E xecut ion, P re-Cached, A pplicat ion Recovery, and so on.

I ndicat es whet her a report was export ed and, if so,

E xport I ndicat or
indicat es it s f ormat .

Hierarchy Drilling I ndicat es whet her a hierarchy is used as a drill hierarchy.

List t he t ypes of manipulat ions t hat can be perf ormed on a

I nbox A ct ion Type
Hist ory List message.

I nt elligent Cube A ct ion

List s act ions perf ormed on or against int elligent cubes.
Type

I nt elligent Cube Type List s all int elligent cube t ypes.

List s all t he possible errors t hat can be ret urned during job
Job E rrorCode
execut ions.

Job P riorit y Map List s t he priorit ies of job execut ions.

E numerat es t he upper limit of t he priorit y ranges f or high,

Job P riorit y Number medium, and low priorit y jobs. Def ault values are 332, 666,
and 999.

Object Creat ion Dat e I ndicat es t he dat e on which an object was creat ed.

Object Creat ion I ndicat es t he week of t he year in which an object was

Week of year creat ed.

Object E xist s S t at us I ndicat es whet her an object exist s.

Object Hidden S t at us I ndicat es whet her an object is hidden.

Object Modif icat ion

I ndicat es t he dat e on which an object was last modif ied.
Dat e

Object Modif icat ion I ndicat es t he week of t he year in which an object was last
Week of year modif ied.

P rompt A nswer I ndicat es whet her a prompt answer was required f or t he job
Required execut ion.

© 2019, M icr o St r at egy In c. 1998

Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

P rompt I ndicat or I ndicat es whet her a job execut ion was prompt ed.

Report Job S QL P ass List s t he t ypes of S QL passes t hat t he I nt elligence S erver

Type generat es.

Report Job S t at us
List s t he st at uses of report execut ions.
(Deprecat ed)

Report Job S t ep Type List s all possible st eps of report job execut ion.

I ndicat es t he t ype of a report , such as X DA , relat ional, and

Report Type
so on.

Report / Document I ndicat es whet her t he execut ion was a report or a

I ndicat or document .

S chedule I ndicat or I ndicat es whet her a job execut ion was scheduled.

S ecurit y Filt er I ndicat es whet her a securit y f ilt er was used in t he job
I ndicat or execut ion.

S QL Clause Type List s t he various S QL clause t ypes used by t he S QL E ngine.

S QL E xecut ion
I ndicat es whet her S QL was execut ed in t he job execut ion.
I ndicat or

Application Objects Attributes

Attrib u te
F u n ctio n
n ame

List s all consolidat ions in project s t hat are set up t o be monit ored
Consolidat ion
by E nt erprise Manager.

List s all cust om groups in project s t hat are set up t o be monit ored
Cust om Group
by E nt erprise Manager.

List s all document s in project s t hat are set up t o be monit ored by

Document
E nt erprise Manager.

1999 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s all f ilt ers in project s t hat are set up t o be monit ored by
Filt er
E nt erprise Manager.

I nt elligent List s all int elligent cubes in project s t hat are set up t o be
Cube monit ored by E nt erprise Manager.

List s all met rics in project s t hat are set up t o be monit ored by
Met ric
E nt erprise Manager.

List s all prompt s in project s t hat are set up t o be monit ored by

P rompt
E nt erprise Manager.

List s all report s in project s t hat are set up t o be monit ored by

Report
E nt erprise Manager.

List s all securit y f ilt ers in project s t hat are set up t o be monit ored
S ecurit y Filt er
by E nt erprise Manager.

List s all t emplat es in project s t hat are set up t o be monit ored by

Templat e
E nt erprise Manager.

Configuration Objects Attributes

Attrib u te n ame F u n ctio n

A ddress List s all addresses t o which deliveries have been sent .

Conf igurat ion Object

List s t he owners of conf igurat ion object s.
Owner

Conf igurat ion

List s all conf igurat ion paramet ers.
P aramet er

Cont act List s all cont act s t o whom deliveries have been sent .

DB Connect ion List s all dat abase connect ions.

DB I nst ance List s all dat abase inst ances.

© 2019, M icr o St r at egy In c. 2000

Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

Device List s all devices t o which deliveries have been sent .

E vent List s all event s being t racked.

Folder List s all f olders wit hin project s.

I nt elligence S erver
List s all I nt elligence S erver def init ions.
Def init ion

Met adat a List s all monit ored met adat a.

Owner List s t he owners of all object s.

P roject List s all project s.

S chedule List s all schedules.

S ubscript ion List s all execut ed t ransmissions.

Transmit t er List s all t ransmit t ers.

User List s all users being t racked.

User Group List s all user groups.

User Group (P arent ) List s all user groups t hat are parent s of ot her user groups.

Date and Time Attributes

Attrib u te
F u n ctio n
n ame

Calendar List s every calendar week, beginning wit h 2000-01-01, as an

Week int eger.

Day List s all days, beginning in 1990.

List s t he hours in a day. For example, 09 A M - 10 A M, 10 A M - 11

Hour
A M, and so on.

Minut e List s all t he minut es in an hour. For example, if t he hour specif ied is

2001 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

10 A M - 11 A M, list s minut es as 10. 30 A M - 10. 31 A M, 10. 32 A M -

10. 33 A M, and so on.

Mont h List s all mont hs, beginning wit h 2000.

Mont h of Y ear List s all mont hs in a specif ied year.

Quart er List s all quart ers.

Quart er of
List s all quart ers of t he year.
Y ear

List s all weeks in all years, beginning in 2000. Weeks in 2000 are
represent ed as a number ranging f rom 200001 t o 200053, weeks in
Week of Y ear
2001 are represent ed as a number ranging f rom 200101 t o 200153,
and so on.

Weekday List s all days of t he week.

Y ear List s all years.

Delivery Services Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

A ddress I ndicat es t he address t o which a delivery was sent .

A vg number of recipient s per Met ric of t he average number of recipient s in

subscript ion subscript ions.

A vg S ubscript ion E xecut ion Met ric of t he average amount of t ime subscript ions
Durat ion (hh: mm: ss) t ake t o execut e.

A vg S ubscript ion E xecut ion Met ric of t he average amount of t ime, in seconds,
Durat ion (secs) subscript ions t ake t o execut e.

Cont act I ndicat es all cont act s t o whom a delivery was sent .

© 2019, M icr o St r at egy In c. 2002

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Cont act Type I ndicat es t he execut ed cont act t ypes.

Day I ndicat es t he day on which t he delivery was sent .

Delivery S t at us I ndicat or I ndicat es whet her t he delivery was successf ul.

Delivery Type I ndicat es t he t ype of delivery.

I ndicat es t he t ype of device t o which t he delivery

Device
was sent .

Document I ndicat es t he document t hat was delivered.

Hour I ndicat es t he hour on which t he delivery was sent .

I ndicat es t he I nt elligence S erver machine t hat

I nt elligence S erver Machine
execut ed t he job.

Met adat a I ndicat es t he monit ored met adat a.

I ndicat es t he minut e on which t he delivery was

Minut e
sent .

Number of Dist inct Document Met ric of t he number of report services document
S ubscript ions subscript ions.

Met ric of t he number of recipient s t hat received

Number of Dist inct Recipient s
cont ent f rom a subscript ion.

Number of Dist inct Report

Met ric of t he number of report subscript ions.
S ubscript ions

Met ric of t he number of execut ed subscript ions.

Number of Dist inct
This does not ref lect t he number of subscript ions
S ubscript ions
in t he met adat a.

Met ric of t he number of subscript ions t hat

Number of E -mail S ubscript ions
delivered cont ent via e-mail.

Number of E rrored
Met ric of t he number of subscript ions t hat f ailed.
S ubscript ions

Number of E xecut ions Met ric of t he number of execut ions of a

2003 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

subscript ion.

Met ric of t he number of subscript ions t hat

Number of File S ubscript ions
delivered cont ent via f ile locat ion.

Number of Hist ory List Met ric of t he number of subscript ions t hat
S ubscript ions delivered cont ent via t he hist ory list .

Met ric of t he number of subscript ions t hat

Number of Mobile S ubscript ions
delivered cont ent via mobile.

Met ric of t he number of subscript ions t hat

Number of P rint S ubscript ions
delivered cont ent via a print er.

P roject List s t he project s.

Report List s t he report s in project s.

Report Job List s an execut ion of a report .

I ndicat es whet her t he execut ion was a report or a

Report / Document I ndicat or
document .

S chedule I ndicat es t he schedule t hat t riggered t he delivery.

I ndicat es t he subscript ion t hat t riggered t he

S ubscript ion
delivery.

S ubscript ion E xecut ion Met ric of t he sum of all execut ion t imes of a
Durat ion (hh: mm: ss) subscript ion.

S ubscript ion E xecut ion Durat ion Met ric of t he sum of all execut ion t imes of a
(secs) subscript ion (in seconds).

Document Job Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

Day I ndicat es t he day on which t he document job

© 2019, M icr o St r at egy In c. 2004

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

execut ed.

Document I ndicat es which document was execut ed.

Document Job I ndicat es an execut ion of a document .

Met ric of t he average dif f erence bet ween st art t ime

DP A verage E lapsed Durat ion
and f inish t ime (including t ime f or prompt
per Job (hh: mm: ss)
responses) of all document job execut ions.

Met ric of t he average dif f erence, in seconds,

DP A verage E lapsed Durat ion bet ween st art t ime and f inish t ime (including t ime
per Job (secs) f or prompt responses) of all document job
execut ions.

DP A verage E xecut ion Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions.

DP A verage E xecut ion Met ric of t he average durat ion of all document job
Durat ion per Job (hh: mm: ss) execut ions.

DP A verage Queue Durat ion Met ric of t he average durat ion of all document job
per Job (hh: mm: ss) execut ions wait ing in t he queue.

DP A verage Queue Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions wait ing in t he queue.

Met ric of t he dif f erence bet ween st art t ime and

DP E lapsed Durat ion
f inish t ime (including t ime f or prompt responses) of
(hh: mm: ss)
a document job.

Met ric of t he average dif f erence, in seconds,

DP E lapsed Durat ion (secs) bet ween st art t ime and f inish t ime (including t ime
f or prompt responses) of a document job.

DP E xecut ion Durat ion Met ric of t he durat ion of a document job's
(hh: mm: ss) execut ion.

Met ric of t he durat ion, in seconds, of a document

DP E xecut ion Durat ion (secs)
job's execut ion.

DP Number of Jobs (I S _DOC_ Met ric of t he number of document jobs t hat were

2005 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

FA CT) execut ed.

DP Number of Jobs wit h Cache Met ric of t he number of document jobs t hat hit a
Hit cache.

DP Number of Jobs wit h E rror Met ric of t he number of document jobs t hat f ailed.

DP Number of Users who ran Met ric of t he number of users who ran document
Document s jobs.

DP P ercent age of Jobs wit h Met ric of t he percent age of document jobs t hat hit
Cache Hit a cache.

DP P ercent age of Jobs wit h Met ric of t he percent age of document jobs t hat
E rror f ailed.

Met ric of t he durat ion of all document job

DP Queue Durat ion (hh: mm: ss)
execut ions wait ing in t he queue.

Met ric of t he durat ion, in seconds, of all document

DP Queue Durat ion (secs)
job execut ions wait ing in t he queue.

Hour I ndicat es t he hour t he document job was execut ed.

I ndicat es t he I nt elligence S erver machine t hat

I nt elligence S erver Machine
execut ed t he document job.

Met adat a I ndicat es t he met adat a st oring t he document .

I ndicat es t he minut e t he document job was

Minut e
execut ed.

P roject I ndicat es t he project st oring t he document .

Report I ndicat es t he report s in t he document .

User I ndicat es t he user who ran t he document job.

© 2019, M icr o St r at egy In c. 2006

Syst em Ad m in ist r at io n Gu id e

Document Job Step Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

I ndicat es t he day on which t he document job

Day
execut ed.

Document I ndicat es which document was execut ed.

I ndicat es t he sequence number f or st eps in a

Document Job S t ep S equence
document job.

Document Job S t ep Type I ndicat es t he t ype of st ep f or a document job.

Met ric of t he average dif f erence bet ween st art t ime

DP A verage E lapsed Durat ion
and f inish t ime (including t ime f or prompt
per Job (hh: mm: ss)
responses) of all document job execut ions.

Met ric of t he average dif f erence, in seconds,

DP A verage E lapsed Durat ion bet ween st art t ime and f inish t ime (including t ime
per Job (secs) f or prompt responses) of all document job
execut ions.

DP A verage E xecut ion Met ric of t he average durat ion of all document job
Durat ion per Job (hh: mm: ss) execut ions.

DP A verage E xecut ion Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions.

DP A verage Queue Durat ion Met ric of t he average durat ion of all document job
per Job (hh: mm: ss) execut ions wait ing in t he queue.

DP A verage Queue Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions wait ing in t he queue.

Met ric of t he dif f erence bet ween st art t ime and

DP E lapsed Durat ion
f inish t ime (including t ime f or prompt responses) of
(hh: mm: ss)
a document job.

Met ric of t he average dif f erence, in seconds,

DP E lapsed Durat ion (secs) bet ween st art t ime and f inish t ime (including t ime
f or prompt responses) of a document job.

2007 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

DP E xecut ion Durat ion Met ric of t he durat ion of a document job's
(hh: mm: ss) execut ion.

Met ric of t he durat ion, in seconds, of a document

DP E xecut ion Durat ion (secs)
job's execut ion.

Met ric of t he durat ion of all document job

DP Queue Durat ion (hh: mm: ss)
execut ions wait ing in t he queue.

Met ric of t he durat ion, in seconds, of all document

DP Queue Durat ion (secs)
job execut ions wait ing in t he queue.

Hour I ndicat es t he hour t he document job was execut ed.

Met adat a I ndicat es t he met adat a st oring t he document .

I ndicat es t he minut e t he document job was

Minut e
execut ed.

P roject I ndicat es t he project st oring t he document .

Enterprise Manager Data Load Attributes

Attrib u te n ame F u n ctio n

Dat a Load Finish Displays t he t imest amp of t he end of t he dat a load process
Time f or t he project s t hat are being monit ored.

Dat a Load P roject List s all project s t hat are being monit ored.

List s t he t imest amp of t he st art of t he dat a load process f or

Dat a Load S t art Time
t he project s t hat are being monit ored.

A value of -1 indicat es t hat it is t he summary row in t he E M_

I S _LA S T_UP DA TE t able f or all project s in a dat a load. That
I t em I D summary row has inf ormat ion about how long t he dat a load
t ook. A value of 0 indicat es it is a row wit h project dat a load
det ails.

© 2019, M icr o St r at egy In c. 2008

Syst em Ad m in ist r at io n Gu id e

Inbox Message Actions Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Day I ndicat es t he day t he manipulat ion was st art ed

Document I ndicat es t he document included in t he message.

I ndicat es t he document job t hat request ed t he Hist ory

Document Job
List message manipulat ion.

HL Days S ince Last Met ric of t he number of days since any act ion was
A ct ion: A ny act ion perf ormed.

HL Days S ince Last Met ric of t he number of days since t he last request was
A ct ion: Request made f or t he cont ent s of a message.

Met ric of t he dat e and t ime of t he last act ion perf ormed
HL Last A ct ion Dat e: A ny
on a message such as read, delet ed, marked as read, and
A ct ion
so on.

HL Last A ct ion Dat e: Met ric of t he dat e and t ime of t he last request made f or
Request t he cont ent s of a message.

HL Number of A ct ions Met ric of t he number of act ions perf ormed on a message.

HL Number of A ct ions by Met ric of t he number of act ions by user perf ormed on a
User message.

HL Number of A ct ions Met ric of t he number of act ions on a message t hat

wit h E rrors result ed in an error.

HL Number of Document Met ric of t he number of document jobs t hat result wit h
Jobs messages.

HL Number of Messages Met ric of t he number of messages.

HL Number of Messages Met ric of t he number of messages t hat result ed in an

wit h E rrors error.

HL Number of Messages Met ric of t he number of request s f or t he cont ent s of a

Request ed message.

2009 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

HL Number of Report Met ric of t he number of report jobs t hat result f rom
Jobs messages.

I ndicat es t he hour t he manipulat ion was st art ed on a

Hour
Hist ory List message.

I ndicat es t he manipulat ion t hat was perf ormed on a

I nbox A ct ion
Hist ory List message.

I ndicat es t he t ype of manipulat ion t hat was perf ormed on

I nbox A ct ion Type
a Hist ory List message.

I nbox Message I ndicat es t he message in t he Hist ory List .

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he message.

Met adat a I ndicat es t he met adat a st oring t he message.

Minut e I ndicat es t he minut e t he manipulat ion was st art ed.

P roject I ndicat es t he project st oring t he message.

Report I ndicat es t he report included in t he message.

I ndicat es t he job I D of t he report included in t he

Report Job
message.

I ndicat es t he user who manipulat ed t he Hist ory List

User
message.

Mobile Client Attributes

Attrib u te n ame F u n ctio n

I ndicat es whet her a cache was hit during t he execut ion

Cache Hit I ndicat or
and, if so, what t ype of cache hit .

© 2019, M icr o St r at egy In c. 2010

Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

Day I ndicat es t he day t he act ion st art ed.

Document I dent if ies t he document used in t he request .

I ndicat es t he t ype of report or document t hat init iat ed t he

E xecut ion Type I ndicat or
execut ion.

I ndicat es t he locat ion, in lat it ude and longit ude f orm, of

Geocode
t he user.

Hour I ndicat es t he hour t he act ion st art ed.

I nt elligence S erver
I ndicat es t he I nt elligence S erver processing t he request .
Machine

I ndicat es t he met adat a reposit ory st oring t he report or

Met adat a
document .

Minut e I ndicat es t he minut e t he act ion st art ed.

Mobile Device
I ndicat es t he unique I nst allat ion I D of t he mobile app.
I nst allat ion I D

I ndicat es t he t ype of mobile device t he app is inst alled

Mobile Device Type
on, such as I P A D2, DROI D, and so on.

I ndicat es t he version of t he MicroS t rat egy app making t he

MS TR A pp V ersion
request .

I ndicat es t he t ype of net work used, such as 3G, WI FI ,

Net work Type
LTE , and so on.

I ndicat es t he operat ing syst em of t he mobile device

Operat ing S yst em
making t he request .

Operat ing S yst em I ndicat es t he operat ing syst em version of t he mobile

V ersion device making t he request .

P roject I ndicat es t he project used t o init iat e t he request .

User I ndicat es t he user t hat init iat ed t he request .

2011 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

OLAP Services Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Day I ndicat es t he day t he act ion was st art ed.

Hour I ndicat es t he hour t he act ion was st art ed.

I nt elligent Cube I ndicat es t he I nt elligent Cube t hat was used.

I nt elligent Cube A ct ion Met ric of t he durat ion, in seconds, f or an act ion t hat was
Durat ion (secs) perf ormed on t he I nt ellgent Cube.

I nt elligent Cube A ct ion I ndicat es t he t ype of act ion t aken on t he I nt elligent Cube
Type such as cube publish, cube view hit , and so on.

I ndicat es t he I nt elligent Cube inst ance in memory t hat

I nt elligent Cube I nst ance
was used f or t he act ion.

I nt elligent Cube S ize I f t he I nt elligent Cube is published or ref reshed, indicat es

(K B ) t he size, in K B , of t he I nt elligent Cube.

I ndicat es t he t ype of I nt elligent Cube used, such as

I nt elligent Cube Type working set report , Report S ervices B ase report , OLA P
Cube report , and so on.

Minut e I ndicat es t he minut e on which t he act ion was st art ed.

Met ric of how many jobs f rom report s not based on

Number of Dynamically
I nt elligent Cubes but select ed by t he engine t o go against
S ourced Report Jobs
an I nt elligent Cube because t he object s on t he report
against I nt elligent Cubes
mat ched what is on t he I nt elligent Cube.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube P ublishes published.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube Ref reshes ref reshed.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube Republishes republished.

© 2019, M icr o St r at egy In c. 2012

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Number of Jobs wit h Met ric of how many job execut ions used an I nt elligent
I nt elligent Cube Hit Cube.

Met ric of how many users execut ed a report or document

Number of Users hit t ing
t hat used an I nt elligent Cube. That is, t he number of
I nt elligent Cubes
users using OLA P S ervices.

Number of V iew Report Met ric of how many act ions were t he result of a V iew
Jobs Report .

Report I ndicat es t he report t hat hit t he I nt elligent Cube.

Performance Monitoring Attributes

Attrib u te n ame F u n ctio n

I ndicat es cat egory of t he count er, such as memory,

Count er Cat egory
MicroS t rat egy server jobs, or MicroS t rat egy server users.

I ndicat es t he inst ance I D of t he count er, f or MicroS t rat egy

Count er I nst ance
use.

Day I ndicat es t he day t he act ion was st art ed.

Hour I ndicat es t he hour t he act ion was st art ed.

Minut e I ndicat es t he minut e t he act ion was st art ed.

P erf ormance Monit or I ndicat es t he name of t he perf ormance count er and it s value
Count er t ype.

2013 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Prompt Answers Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Connect ion S ource Indicates the connection source to Intelligence Server.

Count of P rompt
Metric of how many prompts were answered.
A nswers

Day I ndicat es t he day t he prompt was answered.

Document I ndicat es t he document t hat used t he prompt .

Hour I ndicat es t he hour t he prompt was answered.

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he job.

Met adat a I ndicat es t he met adat a reposit ory st oring t he prompt .

Minut e I ndicat es t he minut e t he prompt was answered.

P roject I ndicat es t he project st oring t he prompt .

P rompt I ndicat es t he prompt t hat was used.

P rompt A nswer I ndicat es t he answers f or t he prompt in various inst ances.

P rompt A nswer Required I ndicat es whet her an answer t o t he prompt was required.

I ndicat es t he answer of an inst ance of a prompt in a

P rompt I nst ance A nswer
report job.

P rompt Locat ion Indicates the ID of the location in which a prompt is stored.

Indicates the type of the object in which the prompt is stored, such
P rompt Locat ion Type
as filter, template, attribute, and so on.

I ndicat es t he t it le of t he prompt (t he t it le t he user sees

P rompt Tit le
when present ed during job execut ion).

I ndicat es what t ype of prompt was used, such as dat e,

P rompt Type
double, element s, and so on.

© 2019, M icr o St r at egy In c. 2014

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Report I ndicat es t he report t hat used t he prompt .

Report Job I ndicat es t he report job t hat used t he prompt .

RP Number of Jobs (I S _
Met ric of how many jobs involved a prompt .
P R_A NS _FA CT)

RP Number of Jobs
Met ric of how many report jobs had a specif ied prompt
Cont aining P rompt
answer value.
A nswer V alue

RP Number of Jobs Not

Met ric of how many report jobs did not have a specif ied
Cont aining P rompt
prompt answer value.
A nswer V alue

RP Number of Jobs wit h Met ric of how many report jobs had a prompt t hat was not
Unanswered P rompt s answered.

Report Job Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion is ad hoc.

Cache Creat ion I ndicat or I ndicat es whet her an execut ion has creat ed a cache.

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Cancelled I ndicat or I ndicat es whet her an execut ion has been canceled.

I ndicat es whet her a job was a document dat aset or a

Child Job I ndicat or
st andalone report .

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

2015 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

I ndicat es whet her a report request f ailed because of a

Dat abase E rror I ndicat or
dat abase error.

Dat amart I ndicat or I ndicat es whet her an execut ion creat ed a dat a mart .

Day I ndicat es t he day on which t he report was execut ed.

I ndicat es t he dat abase inst ance on which t he report was

DB I nst ance
execut ed.

Drill I ndicat or I ndicat es whet her an execut ion is a result of a drill.

I ndicat es whet her an execut ion is a result of an element

E lement Load I ndicat or
load.

E rror I ndicat or I ndicat es whet her an execut ion encount ered an error.

I ndicat es whet her a report was export ed and, if so,

E xport I ndicat or
indicat es it s f ormat .

Filt er I ndicat es t he f ilt er used on t he report .

Hour I ndicat es t he hour on which t he report was execut ed.

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he report .

Met adat a I ndicat es t he met adat a reposit ory t hat st ores t he report .

I ndicat es t he minut e on which t he report execut ion was

Minut e
st art ed.

Number of Jobs wit h Met ric of how many job execut ions used an I nt elligent
I nt elligent Cube Hit Cube.

P roject I ndicat es t he met adat a reposit ory t hat st ores t he report .

P rompt I ndicat or I ndicat es whet her t he report execut ion was prompt ed.

Report I ndicat es t he I D of t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

© 2019, M icr o St r at egy In c. 2016

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP A verage E lapsed
Met ric of t he average dif f erence bet ween st art t ime and
Durat ion per Job
f inish t ime (including t ime f or prompt responses) of all
(hh: mm: ss) (I S _RE P _
report job execut ions.
FA CT)

RP A verage E lapsed Met ric of t he average dif f erence bet ween st art t ime and
Durat ion per Job (secs) f inish t ime (including t ime f or prompt responses) of all
(I S _RE P _FA CT) report job execut ions.

RP A verage E xecut ion

Durat ion per Job Met ric of t he average durat ion of all report job execut ions.
(hh: mm: ss) (I S _RE P _ I ncludes t ime in queue and execut ion f or a report job.
FA CT)

RP A verage E xecut ion Met ric of t he average durat ion, in seconds, of all report
Durat ion per Job (secs) job execut ions. I ncludes t ime in queue and execut ion f or
(I S _RE P _FA CT) a report job.

RP A verage P rompt
Met ric of t he average t ime users t ake t o answer t he set of
A nswer Time per Job
prompt s in all report jobs.
(hh: mm: ss)

RP A verage P rompt
Met ric of t he average t ime, in seconds, users t ake t o
A nswer Time per Job
answer t he set of prompt s in all report jobs.
(secs)

RP A verage Queue
Met ric of t he average t ime report jobs wait ed in t he
Durat ion per Job
I nt elligence S erver's queue bef ore t he report job was
(hh: mm: ss) (I S _RE P _
execut ed.
FA CT)

RP A verage Queue Met ric of t he average t ime, in seconds, report jobs wait ed
Durat ion per Job (secs) in t he I nt elligence S erver's queue bef ore t he report job
(I S _RE P _FA CT) was execut ed.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E lapsed Durat ion
of a report job. I ncludes t ime f or prompt responses, in
(hh: mm: ss)
queue, and execut ion.

2017 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E lapsed Durat ion
and f inish t ime of a report job. I ncludes t ime f or prompt
(secs)
responses, in queue, and execut ion.

RP E xecut ion Durat ion Met ric of t he durat ion of a report job's execut ion. I ncludes
(hh: mm: ss) dat abase execut ion t ime.

RP E xecut ion Durat ion Met ric of t he durat ion, in seconds, of a report job's
(secs) execut ion. I ncludes dat abase execut ion t ime.

RP Number of A d Hoc Met ric of how many report jobs result ed f rom an ad hoc
Jobs report creat ion.

RP Number of Cancelled
Met ric of how many job execut ions were canceled.
Jobs

Met ric of how many job execut ions result ed f rom a drill
RP Number of Drill Jobs
act ion.

RP Number of Jobs (I S _
Met ric of how many report jobs were execut ed.
RE P _FA CT)

RP Number of Jobs Met ric of how many report jobs were execut ed against t he
hit t ing Dat abase dat abase.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
Cache Creat ion result in creat ing a server cache.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
Cache Hit hit a server cache.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
E lement Loading result f rom loading addit ional at t ribut e element s.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
Cache Creat ion result ed in a server cache being creat ed.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat hit a
Cache Hit server cache.

© 2019, M icr o St r at egy In c. 2018

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
Dat amart Creat ion result ed in a dat a mart being creat ed.

RP Number of Jobs wit h Met ric of how many report jobs f ailed because of a
DB E rror dat abase error.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
E lement Loading result ed f rom loading addit ional at t ribut e element s.

RP Number of Jobs wit h

Met ric of how many report jobs f ailed because of an error.
E rror

RP Number of Jobs wit h Met ric of how many report job execut ions used an
I nt elligent Cube Hit I nt elligent Cube.

RP Number of Jobs wit h Met ric of how many report job execut ions used a securit y
S ecurit y Filt er f ilt er.

RP Number of Jobs wit h

Met ric of how many report jobs execut ed S QL st at ement s.
S QL E xecut ion

RP number of Met ric of how many report job execut ions were run
Narrowcast S erver jobs t hrough MicroS t rat egy Narrowcast S erver.

RP Number of P rompt ed Met ric of how many report job execut ions included a
Jobs prompt .

RP Number of Report
Met ric of how many report jobs execut ed as a result of a
Jobs f rom Document
document execut ion.
E xecut ion

RP Number of Result Met ric of how many result rows were ret urned f rom a
Rows report execut ion.

RP Number of
Met ric of how many report jobs were scheduled.
S cheduled Jobs

RP Number of Users who

Met ric of how many dist inct users ran report jobs.
ran report s

2019 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP P rompt A nswer Met ric of t he how long users t ake t o answer t he set of
Durat ion (hh: mm: ss) prompt s in report jobs.

RP P rompt A nswer Met ric of t he how long, in seconds, users t ake t o answer
Durat ion (secs) t he set of prompt s in report jobs.

RP Queue Durat ion Met ric of how long a report job wait ed in t he I nt elligence
(hh: mm: ss) S erver's queue bef ore t he report job was execut ed.

Met ric of how long, in seconds, a report job wait ed in t he

RP Queue Durat ion
I nt elligence S erver's queue bef ore t he report job was
(secs)
execut ed.

S chedule I ndicat es t he schedule t hat began t he report execut ion.

S chedule I ndicat or I ndicat es whet her t he report execut ion was scheduled.

S ecurit y Filt er I ndicat es t he securit y f ilt er used in t he report execut ion.

I ndicat es whet her a securit y f ilt er was used in t he report

S ecurit y Filt er I ndicat or
execut ion.

S QL E xecut ion I ndicat or I ndicat es t hat S QL was execut ed during report execut ion.

Templat e I ndicat es t he report t emplat e t hat was used.

User I ndicat es t he user t hat ran t he report .

Report Job SQL Pass Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her t he execut ion was ad hoc.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

Day I ndicat es t he day in which t he job was execut ed.

© 2019, M icr o St r at egy In c. 2020

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Hour I ndicat es t he hour in which t he report job was execut ed.

I ndicat es t he met adat a reposit ory st oring t he report or

Met adat a
document .

Minut e I ndicat es t he minut e in which t he report job was st art ed.

P roject I ndicat es t he project st oring t he report or document .

Report I ndicat es t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

I ndicat es t he S QL st at ement t hat was execut ed during t he

Report Job S QL P ass
S QL pass.

I ndicat es t he t ype of S QL st at ement t hat was execut ed in

Report Job S QL P ass
t his S QL pass. E xamples are S QL select , S QL insert ,
Type
S QL creat e and such.

RP E xecut ion Durat ion Met ric of t he durat ion of a report job's execut ion. I ncludes
(hh: mm: ss) dat abase execut ion t ime.

RP E xecut ion Durat ion Met ric of t he durat ion, in seconds, of a report job's
(secs) execut ion. I ncludes dat abase execut ion t ime.

RP Last E xecut ion Finish Met ric of t he f inish t imest amp when t he report job was
Timest amp last execut ed.

RP Last E xecut ion S t art Met ric of t he st art t imest amp when t he report job was last
Timest amp execut ed.

RP Number of DB Tables Met ric of how many dat abase t ables were accessed in a
A ccessed report job execut ion.

Met ric of how large, in byt es, t he S QL was f or a report

RP S QL S ize
job.

2021 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Report Job Steps Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion was ad hoc.

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

Day I ndicat es t he day in which t he job was execut ed.

Hour I ndicat es t he hour in which t he report job was execut ed.

Minut e I ndicat es t he minut e in which t he report job was st art ed.

Report I ndicat es t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

I ndicat es t he sequence number in t he series of execut ion

Report Job S t ep
st eps a report job passes t hrough in t he I nt elligence
S equence
S erver.

I ndicat es t he t ype of st ep f or a report job. E xamples are

S QL generat ion, S QL execut ion, A nalyt ical E ngine,
Report Job S t ep Type
Resolut ion S erver, element request , updat e I nt elligent
Cube, and so on.

RP A verage CP U
E xecut ion Durat ion per Met ric of t he average durat ion, in milliseconds, a report
Job (msecs) (I S _RE P _ job execut ion t akes in t he I nt elligence S erver CP U.
S TE P _FA CT)

RP A verage E lapsed Met ric of t he average dif f erence, in seconds, bet ween
Durat ion per Job (secs) st art t ime and f inish t ime of report job execut ions.
(I S _RE P _S TE P _FA CT) I ncludes t ime f or prompt responses.

RP A verage E xecut ion Met ric of t he average dif f erence, in seconds, bet ween

© 2019, M icr o St r at egy In c. 2022

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Durat ion per Job (secs) st art t ime and f inish t ime of report job execut ions.
(I S _RE P _S TE P _FA CT) I ncludes t ime f or prompt responses.

RP A verage Query
E ngine E xecut ion Met ric of t he average t ime, in seconds, t he Query E ngine
Durat ion per Job (secs) t akes t o process a report job.
(I S _RE P _S TE P _FA CT)

RP A verage Queue Met ric of t he average t ime report jobs wait ed in t he

Durat ion per Job (secs) I nt elligence S erver's queue bef ore t he report job was
(I S _RE P _S TE P _FA CT) execut ed.

Met ric of how long, in milliseconds, a report job execut ion

RP CP U Durat ion (msec)
t akes in t he I nt elligence S erver CP U.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E lapsed Durat ion
of report job execut ions. I ncludes t ime f or prompt
(hh: mm: ss)
responses.

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E lapsed Durat ion
and f inish t ime of report job execut ions. I ncludes t ime f or
(secs)
prompt responses.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E xecut ion Durat ion
of report job execut ions. I ncludes dat abase execut ion
(hh: mm: ss)
t ime.

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E xecut ion Durat ion
and f inish t ime of report job execut ions. I ncludes
(secs)
dat abase execut ion t ime.

RP Last E xecut ion Finish Met ric of t he f inish t imest amp when t he report job was
Timest amp last execut ed.

RP Last E xecut ion S t art Met ric of t he st art t imest amp when t he report job was last
Timest amp execut ed.

RP Number of Jobs (I S _
Met ric of how many report jobs were execut ed.
RE P _S TE P _FA CT)

2023 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP Query E ngine
Met ric of how long t he Query E ngine t ook t o execut e S QL
Durat ion (hh: mm: ss)
f or a report job.
(I S _RE P _S TE P _FA CT)

RP Query E ngine
Met ric of t he t ime, in seconds, t he Query E ngine t akes t o
Durat ion (secs) (I S _
execut e S QL f or a report job.
RE P _S TE P _FA CT)

RP Queue Durat ion Met ric of how long a report job wait ed in t he I nt elligence
(hh: mm: ss) S erver's queue bef ore t he report job was execut ed.

Met ric of how long, in seconds, a report job wait ed in t he

RP Queue Durat ion
I nt elligence S erver's queue bef ore t he report job was
(secs)
execut ed.

RP S QL E ngine Durat ion

Met ric of how long t he S QL E ngine t ook t o generat e S QL
(hh: mm: ss) (I S _RE P _
f or a report job.
S TE P _FA CT)

Report Job Tables/Columns Accessed Attributes and

Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion was ad hoc.

Column I ndicat es t he column t hat was accessed.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es t he day on which t he t able column was

Day
accessed.

I ndicat es t he t able in t he dat abase st oring t he column

DB Table
t hat was accessed.

© 2019, M icr o St r at egy In c. 2024

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

I ndicat es t he hour on which t he t able column was

Hour
accessed.

I ndicat es t he minut e on which t he t able column was

Minut e
accessed.

Report I ndicat es t he report t hat accessed t he t able column.

I ndicat es which execut ion of a report accessed t he t able

Report Job
column.

Met ric of how many report jobs accessed t he dat abase

RP Number of Jobs (I S _
column or t able. The Warehouse Tables A ccessed report
RE P _COL_FA CT)
uses t his met ric.

I ndicat es which t ype of S QL clause was used t o access

S QL Clause Type
t he t able column.

Schema Objects Attributes

Attrib u te
F u n ctio n
n ame

List s all at t ribut es in project s t hat are set up t o be monit ored by

A t t ribut e
E nt erprise Manager.

List s all at t ribut e f orms in project s t hat are set up t o be monit ored
A t t ribut e Form
by E nt erprise Manager.

List s all columns in project s t hat are set up t o be monit ored by

Column
E nt erprise Manager.

List s all physical t ables in t he dat a warehouse t hat are set up t o be

DB Table
monit ored by E nt erprise Manager.

List s all f act s in project s t hat are set up t o be monit ored by

Fact
E nt erprise Manager.

2025 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s all hierarchies in project s t hat are set up t o be monit ored by

Hierarchy
E nt erprise Manager

List s all logical t ables in project s t hat are set up t o be monit ored by
Table
E nt erprise Manager.

List s all t ransf ormat ions in project s t hat are set up t o be monit ored
Transf ormat ion
by E nt erprise Manager.

Server Machines Attributes

Attrib u te n ame F u n ctio n

List s all machines t hat have had users connect t o t he

Client Machine
I nt elligence S erver.

I nt elligence S erver
List s t he clust er of I nt elligence S ervers.
Clust er

I nt elligence S erver List s all machines t hat have logged st at ist ics as an
Machine I nt elligence S erver.

Web S erver Machine List s all machines used as web servers.

Session Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A vg. Connect ion Met ric of t he average t ime connect ions t o an I nt elligence
Durat ion (hh: mm: ss) S erver last .

A vg. Connect ion Met ric of t he average t ime, in seconds, connect ions t o an
Durat ion (secs) I nt elligence S erver last .

© 2019, M icr o St r at egy In c. 2026

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Connect ion Durat ion Met ric of t he t ime a connect ion t o an I nt elligence S erver
(hh: mm: ss) last s.

Connect ion Durat ion Met ric of t he t ime, in seconds, a connect ion t o an
(secs) I nt elligence S erver last s.

Connect ion S ource List s all connect ion sources t o I nt elligence S erver.

Met ric of how many sessions were connect ed t o an

Number of S essions
I nt elligence S erver. Usually report ed wit h a dat e and t ime
(Report Level)
at t ribut e.

Met ric of how many dist inct users were connect ed t o an

Number of Users Logged
I nt elligence S erver. Usually report ed wit h a dat e and t ime
I n (Report Level)
at t ribut e.

S ession I ndicat es a user connect ion t o an I nt elligence S erver.

All Indicators and Flags Attributes

Attrib u te n ame F u n ctio n

A d Hoc I ndicat or I ndicat es whet her an execut ion is ad hoc.

Cache Creat ion

I ndicat es whet her an execut ion has creat ed a cache.
I ndicat or

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Cancelled I ndicat or I ndicat es whet her an execut ion has been cancelled.

I ndicat es whet her a job was a document dat aset or a st and-

Child Job I ndicat or
alone report .

Conf igurat ion Object

I ndicat es whet her a conf igurat ion object exist s.
E xist s S t at us

Conf igurat ion List s all conf igurat ion paramet er t ypes.

2027 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

P aramet er V alue Type

Connect ion S ource List s all connect ion sources t o I nt elligence S erver.

Cont act Type List s t he execut ed cont act t ypes.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

Dat abase E rror I ndicat es whet her a report request f ailed because of a
I ndicat or dat abase error.

Dat amart I ndicat or I ndicat es whet her an execut ion creat ed a dat a mart .

I ndicat es whet her an execut ion encount ered a dat abase

DB E rror I ndicat or
error.

Delivery S t at us
I ndicat es whet her a delivery was successf ul.
I ndicat or

Delivery Type List s t he t ype of delivery.

Document Job S t at us
List s t he st at uses of document execut ions.
(Deprecat ed)

Document Job S t ep
List s all possible st eps of document job execut ion.
Type

I ndicat es t he t ype of a document or dossier, such as HTML

Document Type
document , Report S ervices document , or a dossier.

List s t he object f rom which a user drilled when a new report

Drill f rom Object
was run because of a drilling act ion.

Drill I ndicat or I ndicat es whet her an execut ion is a result of a drill.

List s t he object t o which a user drilled when a new report

Drill t o Object
was run because of a drilling act ion.

I ndicat es whet her an execut ion is a result of an element

E lement Load I ndicat or
load.

© 2019, M icr o St r at egy In c. 2028

Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

E rror I ndicat or I ndicat es whet her an execut ion encount ered an error.

E xecut ion Type I ndicat es how t he cont ent was request ed, such as User
I ndicat or E xecut ion, P re-Cached, A pplicat ion Recovery, and so on.

I ndicat es whet her a report was export ed and, if so,

E xport I ndicat or
indicat es it s f ormat .

Hierarchy Drilling I ndicat es whet her a hierarchy is used as a drill hierarchy.

List t he t ypes of manipulat ions t hat can be perf ormed on a

I nbox A ct ion Type
Hist ory List message.

I nt elligent Cube A ct ion

List s act ions perf ormed on or against int elligent cubes.
Type

I nt elligent Cube Type List s all int elligent cube t ypes.

List s all t he possible errors t hat can be ret urned during job
Job E rrorCode
execut ions.

Job P riorit y Map List s t he priorit ies of job execut ions.

E numerat es t he upper limit of t he priorit y ranges f or high,

Job P riorit y Number medium, and low priorit y jobs. Def ault values are 332, 666,
and 999.

Object Creat ion Dat e I ndicat es t he dat e on which an object was creat ed.

Object Creat ion I ndicat es t he week of t he year in which an object was

Week of year creat ed.

Object E xist s S t at us I ndicat es whet her an object exist s.

Object Hidden S t at us I ndicat es whet her an object is hidden.

Object Modif icat ion

I ndicat es t he dat e on which an object was last modif ied.
Dat e

Object Modif icat ion I ndicat es t he week of t he year in which an object was last
Week of year modif ied.

P rompt A nswer I ndicat es whet her a prompt answer was required f or t he job

2029 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

Required execut ion.

P rompt I ndicat or I ndicat es whet her a job execut ion was prompt ed.

Report Job S QL P ass List s t he t ypes of S QL passes t hat t he I nt elligence S erver

Type generat es.

Report Job S t at us
List s t he st at uses of report execut ions.
(Deprecat ed)

Report Job S t ep Type List s all possible st eps of report job execut ion.

I ndicat es t he t ype of a report , such as X DA , relat ional, and

Report Type
so on.

Report / Document I ndicat es whet her t he execut ion was a report or a

I ndicat or document .

S chedule I ndicat or I ndicat es whet her a job execut ion was scheduled.

S ecurit y Filt er I ndicat es whet her a securit y f ilt er was used in t he job
I ndicat or execut ion.

S QL Clause Type List s t he various S QL clause t ypes used by t he S QL E ngine.

S QL E xecut ion
I ndicat es whet her S QL was execut ed in t he job execut ion.
I ndicat or

Application Objects Attributes

Attrib u te
F u n ctio n
n ame

List s all consolidat ions in project s t hat are set up t o be monit ored
Consolidat ion
by E nt erprise Manager.

List s all cust om groups in project s t hat are set up t o be monit ored
Cust om Group
by E nt erprise Manager.

© 2019, M icr o St r at egy In c. 2030

Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s all document s in project s t hat are set up t o be monit ored by

Document
E nt erprise Manager.

List s all f ilt ers in project s t hat are set up t o be monit ored by
Filt er
E nt erprise Manager.

I nt elligent List s all int elligent cubes in project s t hat are set up t o be
Cube monit ored by E nt erprise Manager.

List s all met rics in project s t hat are set up t o be monit ored by
Met ric
E nt erprise Manager.

List s all prompt s in project s t hat are set up t o be monit ored by

P rompt
E nt erprise Manager.

List s all report s in project s t hat are set up t o be monit ored by

Report
E nt erprise Manager.

List s all securit y f ilt ers in project s t hat are set up t o be monit ored
S ecurit y Filt er
by E nt erprise Manager.

List s all t emplat es in project s t hat are set up t o be monit ored by

Templat e
E nt erprise Manager.

Configuration Objects Attributes

Attrib u te n ame F u n ctio n

A ddress List s all addresses t o which deliveries have been sent .

Conf igurat ion Object

List s t he owners of conf igurat ion object s.
Owner

Conf igurat ion

List s all conf igurat ion paramet ers.
P aramet er

Cont act List s all cont act s t o whom deliveries have been sent .

2031 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

DB Connect ion List s all dat abase connect ions.

DB I nst ance List s all dat abase inst ances.

Device List s all devices t o which deliveries have been sent .

E vent List s all event s being t racked.

Folder List s all f olders wit hin project s.

I nt elligence S erver
List s all I nt elligence S erver def init ions.
Def init ion

Met adat a List s all monit ored met adat a.

Owner List s t he owners of all object s.

P roject List s all project s.

S chedule List s all schedules.

S ubscript ion List s all execut ed t ransmissions.

Transmit t er List s all t ransmit t ers.

User List s all users being t racked.

User Group List s all user groups.

User Group (P arent ) List s all user groups t hat are parent s of ot her user groups.

Date and Time Attributes

Attrib u te
F u n ctio n
n ame

Calendar List s every calendar week, beginning wit h 2000-01-01, as an

Week int eger.

Day List s all days, beginning in 1990.

© 2019, M icr o St r at egy In c. 2032

Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s t he hours in a day. For example, 09 A M - 10 A M, 10 A M - 11

Hour
A M, and so on.

List s all t he minut es in an hour. For example, if t he hour specif ied is

Minut e 10 A M - 11 A M, list s minut es as 10. 30 A M - 10. 31 A M, 10. 32 A M -
10. 33 A M, and so on.

Mont h List s all mont hs, beginning wit h 2000.

Mont h of Y ear List s all mont hs in a specif ied year.

Quart er List s all quart ers.

Quart er of
List s all quart ers of t he year.
Y ear

List s all weeks in all years, beginning in 2000. Weeks in 2000 are
represent ed as a number ranging f rom 200001 t o 200053, weeks in
Week of Y ear
2001 are represent ed as a number ranging f rom 200101 t o 200153,
and so on.

Weekday List s all days of t he week.

Y ear List s all years.

Delivery Services Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

A ddress I ndicat es t he address t o which a delivery was sent .

A vg number of recipient s per Met ric of t he average number of recipient s in

subscript ion subscript ions.

A vg S ubscript ion E xecut ion Met ric of t he average amount of t ime subscript ions
Durat ion (hh: mm: ss) t ake t o execut e.

A vg S ubscript ion E xecut ion Met ric of t he average amount of t ime, in seconds,

2033 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Durat ion (secs) subscript ions t ake t o execut e.

Cont act I ndicat es all cont act s t o whom a delivery was sent .

Cont act Type I ndicat es t he execut ed cont act t ypes.

Day I ndicat es t he day on which t he delivery was sent .

Delivery S t at us I ndicat or I ndicat es whet her t he delivery was successf ul.

Delivery Type I ndicat es t he t ype of delivery.

I ndicat es t he t ype of device t o which t he delivery

Device
was sent .

Document I ndicat es t he document t hat was delivered.

Hour I ndicat es t he hour on which t he delivery was sent .

I ndicat es t he I nt elligence S erver machine t hat

I nt elligence S erver Machine
execut ed t he job.

Met adat a I ndicat es t he monit ored met adat a.

I ndicat es t he minut e on which t he delivery was

Minut e
sent .

Number of Dist inct Document Met ric of t he number of report services document
S ubscript ions subscript ions.

Met ric of t he number of recipient s t hat received

Number of Dist inct Recipient s
cont ent f rom a subscript ion.

Number of Dist inct Report

Met ric of t he number of report subscript ions.
S ubscript ions

Met ric of t he number of execut ed subscript ions.

Number of Dist inct
This does not ref lect t he number of subscript ions
S ubscript ions
in t he met adat a.

Met ric of t he number of subscript ions t hat

Number of E -mail S ubscript ions
delivered cont ent via e-mail.

© 2019, M icr o St r at egy In c. 2034

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Number of E rrored
Met ric of t he number of subscript ions t hat f ailed.
S ubscript ions

Met ric of t he number of execut ions of a

Number of E xecut ions
subscript ion.

Met ric of t he number of subscript ions t hat

Number of File S ubscript ions
delivered cont ent via f ile locat ion.

Number of Hist ory List Met ric of t he number of subscript ions t hat
S ubscript ions delivered cont ent via t he hist ory list .

Met ric of t he number of subscript ions t hat

Number of Mobile S ubscript ions
delivered cont ent via mobile.

Met ric of t he number of subscript ions t hat

Number of P rint S ubscript ions
delivered cont ent via a print er.

P roject List s t he project s.

Report List s t he report s in project s.

Report Job List s an execut ion of a report .

I ndicat es whet her t he execut ion was a report or a

Report / Document I ndicat or
document .

S chedule I ndicat es t he schedule t hat t riggered t he delivery.

I ndicat es t he subscript ion t hat t riggered t he

S ubscript ion
delivery.

S ubscript ion E xecut ion Met ric of t he sum of all execut ion t imes of a
Durat ion (hh: mm: ss) subscript ion.

S ubscript ion E xecut ion Durat ion Met ric of t he sum of all execut ion t imes of a
(secs) subscript ion (in seconds).

2035 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Document Job Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

I ndicat es t he day on which t he document job

Day
execut ed.

Document I ndicat es which document was execut ed.

Document Job I ndicat es an execut ion of a document .

Met ric of t he average dif f erence bet ween st art t ime

DP A verage E lapsed Durat ion
and f inish t ime (including t ime f or prompt
per Job (hh: mm: ss)
responses) of all document job execut ions.

Met ric of t he average dif f erence, in seconds,

DP A verage E lapsed Durat ion bet ween st art t ime and f inish t ime (including t ime
per Job (secs) f or prompt responses) of all document job
execut ions.

DP A verage E xecut ion Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions.

DP A verage E xecut ion Met ric of t he average durat ion of all document job
Durat ion per Job (hh: mm: ss) execut ions.

DP A verage Queue Durat ion Met ric of t he average durat ion of all document job
per Job (hh: mm: ss) execut ions wait ing in t he queue.

DP A verage Queue Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions wait ing in t he queue.

Met ric of t he dif f erence bet ween st art t ime and

DP E lapsed Durat ion
f inish t ime (including t ime f or prompt responses) of
(hh: mm: ss)
a document job.

Met ric of t he average dif f erence, in seconds,

DP E lapsed Durat ion (secs) bet ween st art t ime and f inish t ime (including t ime
f or prompt responses) of a document job.

DP E xecut ion Durat ion Met ric of t he durat ion of a document job's
(hh: mm: ss) execut ion.

© 2019, M icr o St r at egy In c. 2036

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Met ric of t he durat ion, in seconds, of a document

DP E xecut ion Durat ion (secs)
job's execut ion.

DP Number of Jobs (I S _DOC_ Met ric of t he number of document jobs t hat were
FA CT) execut ed.

DP Number of Jobs wit h Cache Met ric of t he number of document jobs t hat hit a
Hit cache.

DP Number of Jobs wit h E rror Met ric of t he number of document jobs t hat f ailed.

DP Number of Users who ran Met ric of t he number of users who ran document
Document s jobs.

DP P ercent age of Jobs wit h Met ric of t he percent age of document jobs t hat hit
Cache Hit a cache.

DP P ercent age of Jobs wit h Met ric of t he percent age of document jobs t hat
E rror f ailed.

Met ric of t he durat ion of all document job

DP Queue Durat ion (hh: mm: ss)
execut ions wait ing in t he queue.

Met ric of t he durat ion, in seconds, of all document

DP Queue Durat ion (secs)
job execut ions wait ing in t he queue.

Hour I ndicat es t he hour t he document job was execut ed.

I ndicat es t he I nt elligence S erver machine t hat

I nt elligence S erver Machine
execut ed t he document job.

Met adat a I ndicat es t he met adat a st oring t he document .

I ndicat es t he minut e t he document job was

Minut e
execut ed.

P roject I ndicat es t he project st oring t he document .

Report I ndicat es t he report s in t he document .

User I ndicat es t he user who ran t he document job.

2037 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Document Job Step Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

I ndicat es t he day on which t he document job

Day
execut ed.

Document I ndicat es which document was execut ed.

I ndicat es t he sequence number f or st eps in a

Document Job S t ep S equence
document job.

Document Job S t ep Type I ndicat es t he t ype of st ep f or a document job.

Met ric of t he average dif f erence bet ween st art t ime

DP A verage E lapsed Durat ion
and f inish t ime (including t ime f or prompt
per Job (hh: mm: ss)
responses) of all document job execut ions.

Met ric of t he average dif f erence, in seconds,

DP A verage E lapsed Durat ion bet ween st art t ime and f inish t ime (including t ime
per Job (secs) f or prompt responses) of all document job
execut ions.

DP A verage E xecut ion Met ric of t he average durat ion of all document job
Durat ion per Job (hh: mm: ss) execut ions.

DP A verage E xecut ion Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions.

DP A verage Queue Durat ion Met ric of t he average durat ion of all document job
per Job (hh: mm: ss) execut ions wait ing in t he queue.

DP A verage Queue Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions wait ing in t he queue.

Met ric of t he dif f erence bet ween st art t ime and

DP E lapsed Durat ion
f inish t ime (including t ime f or prompt responses) of
(hh: mm: ss)
a document job.

Met ric of t he average dif f erence, in seconds,

DP E lapsed Durat ion (secs) bet ween st art t ime and f inish t ime (including t ime
f or prompt responses) of a document job.

© 2019, M icr o St r at egy In c. 2038

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

DP E xecut ion Durat ion Met ric of t he durat ion of a document job's
(hh: mm: ss) execut ion.

Met ric of t he durat ion, in seconds, of a document

DP E xecut ion Durat ion (secs)
job's execut ion.

Met ric of t he durat ion of all document job

DP Queue Durat ion (hh: mm: ss)
execut ions wait ing in t he queue.

Met ric of t he durat ion, in seconds, of all document

DP Queue Durat ion (secs)
job execut ions wait ing in t he queue.

Hour I ndicat es t he hour t he document job was execut ed.

Met adat a I ndicat es t he met adat a st oring t he document .

I ndicat es t he minut e t he document job was

Minut e
execut ed.

P roject I ndicat es t he project st oring t he document .

Enterprise Manager Data Load Attributes

Attrib u te n ame F u n ctio n

Dat a Load Finish Displays t he t imest amp of t he end of t he dat a load process
Time f or t he project s t hat are being monit ored.

Dat a Load P roject List s all project s t hat are being monit ored.

List s t he t imest amp of t he st art of t he dat a load process f or

Dat a Load S t art Time
t he project s t hat are being monit ored.

A value of -1 indicat es t hat it is t he summary row in t he E M_

I S _LA S T_UP DA TE t able f or all project s in a dat a load. That
I t em I D summary row has inf ormat ion about how long t he dat a load
t ook. A value of 0 indicat es it is a row wit h project dat a load
det ails.

2039 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Inbox Message Actions Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Day I ndicat es t he day t he manipulat ion was st art ed

Document I ndicat es t he document included in t he message.

I ndicat es t he document job t hat request ed t he Hist ory

Document Job
List message manipulat ion.

HL Days S ince Last Met ric of t he number of days since any act ion was
A ct ion: A ny act ion perf ormed.

HL Days S ince Last Met ric of t he number of days since t he last request was
A ct ion: Request made f or t he cont ent s of a message.

Met ric of t he dat e and t ime of t he last act ion perf ormed
HL Last A ct ion Dat e: A ny
on a message such as read, delet ed, marked as read, and
A ct ion
so on.

HL Last A ct ion Dat e: Met ric of t he dat e and t ime of t he last request made f or
Request t he cont ent s of a message.

HL Number of A ct ions Met ric of t he number of act ions perf ormed on a message.

HL Number of A ct ions by Met ric of t he number of act ions by user perf ormed on a
User message.

HL Number of A ct ions Met ric of t he number of act ions on a message t hat

wit h E rrors result ed in an error.

HL Number of Document Met ric of t he number of document jobs t hat result wit h
Jobs messages.

HL Number of Messages Met ric of t he number of messages.

HL Number of Messages Met ric of t he number of messages t hat result ed in an

wit h E rrors error.

HL Number of Messages Met ric of t he number of request s f or t he cont ent s of a

Request ed message.

© 2019, M icr o St r at egy In c. 2040

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

HL Number of Report Met ric of t he number of report jobs t hat result f rom
Jobs messages.

I ndicat es t he hour t he manipulat ion was st art ed on a

Hour
Hist ory List message.

I ndicat es t he manipulat ion t hat was perf ormed on a

I nbox A ct ion
Hist ory List message.

I ndicat es t he t ype of manipulat ion t hat was perf ormed on

I nbox A ct ion Type
a Hist ory List message.

I nbox Message I ndicat es t he message in t he Hist ory List .

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he message.

Met adat a I ndicat es t he met adat a st oring t he message.

Minut e I ndicat es t he minut e t he manipulat ion was st art ed.

P roject I ndicat es t he project st oring t he message.

Report I ndicat es t he report included in t he message.

I ndicat es t he job I D of t he report included in t he

Report Job
message.

I ndicat es t he user who manipulat ed t he Hist ory List

User
message.

Mobile Client Attributes

Attrib u te n ame F u n ctio n

I ndicat es whet her a cache was hit during t he execut ion

Cache Hit I ndicat or
and, if so, what t ype of cache hit .

2041 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

Day I ndicat es t he day t he act ion st art ed.

Document I dent if ies t he document used in t he request .

I ndicat es t he t ype of report or document t hat init iat ed t he

E xecut ion Type I ndicat or
execut ion.

I ndicat es t he locat ion, in lat it ude and longit ude f orm, of

Geocode
t he user.

Hour I ndicat es t he hour t he act ion st art ed.

I nt elligence S erver
I ndicat es t he I nt elligence S erver processing t he request .
Machine

I ndicat es t he met adat a reposit ory st oring t he report or

Met adat a
document .

Minut e I ndicat es t he minut e t he act ion st art ed.

Mobile Device
I ndicat es t he unique I nst allat ion I D of t he mobile app.
I nst allat ion I D

I ndicat es t he t ype of mobile device t he app is inst alled

Mobile Device Type
on, such as I P A D2, DROI D, and so on.

I ndicat es t he version of t he MicroS t rat egy app making t he

MS TR A pp V ersion
request .

I ndicat es t he t ype of net work used, such as 3G, WI FI ,

Net work Type
LTE , and so on.

I ndicat es t he operat ing syst em of t he mobile device

Operat ing S yst em
making t he request .

Operat ing S yst em I ndicat es t he operat ing syst em version of t he mobile

V ersion device making t he request .

P roject I ndicat es t he project used t o init iat e t he request .

User I ndicat es t he user t hat init iat ed t he request .

© 2019, M icr o St r at egy In c. 2042

Syst em Ad m in ist r at io n Gu id e

OLAP Services Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Day I ndicat es t he day t he act ion was st art ed.

Hour I ndicat es t he hour t he act ion was st art ed.

I nt elligent Cube I ndicat es t he I nt elligent Cube t hat was used.

I nt elligent Cube A ct ion Met ric of t he durat ion, in seconds, f or an act ion t hat was
Durat ion (secs) perf ormed on t he I nt ellgent Cube.

I nt elligent Cube A ct ion I ndicat es t he t ype of act ion t aken on t he I nt elligent Cube
Type such as cube publish, cube view hit , and so on.

I ndicat es t he I nt elligent Cube inst ance in memory t hat

I nt elligent Cube I nst ance
was used f or t he act ion.

I nt elligent Cube S ize I f t he I nt elligent Cube is published or ref reshed, indicat es

(K B ) t he size, in K B , of t he I nt elligent Cube.

I ndicat es t he t ype of I nt elligent Cube used, such as

I nt elligent Cube Type working set report , Report S ervices B ase report , OLA P
Cube report , and so on.

Minut e I ndicat es t he minut e on which t he act ion was st art ed.

Met ric of how many jobs f rom report s not based on

Number of Dynamically
I nt elligent Cubes but select ed by t he engine t o go against
S ourced Report Jobs
an I nt elligent Cube because t he object s on t he report
against I nt elligent Cubes
mat ched what is on t he I nt elligent Cube.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube P ublishes published.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube Ref reshes ref reshed.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube Republishes republished.

2043 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Number of Jobs wit h Met ric of how many job execut ions used an I nt elligent
I nt elligent Cube Hit Cube.

Met ric of how many users execut ed a report or document

Number of Users hit t ing
t hat used an I nt elligent Cube. That is, t he number of
I nt elligent Cubes
users using OLA P S ervices.

Number of V iew Report Met ric of how many act ions were t he result of a V iew
Jobs Report .

Report I ndicat es t he report t hat hit t he I nt elligent Cube.

Performance Monitoring Attributes

Attrib u te n ame F u n ctio n

I ndicat es cat egory of t he count er, such as memory,

Count er Cat egory
MicroS t rat egy server jobs, or MicroS t rat egy server users.

I ndicat es t he inst ance I D of t he count er, f or MicroS t rat egy

Count er I nst ance
use.

Day I ndicat es t he day t he act ion was st art ed.

Hour I ndicat es t he hour t he act ion was st art ed.

Minut e I ndicat es t he minut e t he act ion was st art ed.

P erf ormance Monit or I ndicat es t he name of t he perf ormance count er and it s value
Count er t ype.

© 2019, M icr o St r at egy In c. 2044

Syst em Ad m in ist r at io n Gu id e

Prompt Answers Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Connect ion S ource Indicates the connection source to Intelligence Server.

Count of P rompt
Metric of how many prompts were answered.
A nswers

Day I ndicat es t he day t he prompt was answered.

Document I ndicat es t he document t hat used t he prompt .

Hour I ndicat es t he hour t he prompt was answered.

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he job.

Met adat a I ndicat es t he met adat a reposit ory st oring t he prompt .

Minut e I ndicat es t he minut e t he prompt was answered.

P roject I ndicat es t he project st oring t he prompt .

P rompt I ndicat es t he prompt t hat was used.

P rompt A nswer I ndicat es t he answers f or t he prompt in various inst ances.

P rompt A nswer Required I ndicat es whet her an answer t o t he prompt was required.

I ndicat es t he answer of an inst ance of a prompt in a

P rompt I nst ance A nswer
report job.

P rompt Locat ion Indicates the ID of the location in which a prompt is stored.

Indicates the type of the object in which the prompt is stored, such
P rompt Locat ion Type
as filter, template, attribute, and so on.

I ndicat es t he t it le of t he prompt (t he t it le t he user sees

P rompt Tit le
when present ed during job execut ion).

I ndicat es what t ype of prompt was used, such as dat e,

P rompt Type
double, element s, and so on.

2045 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Report I ndicat es t he report t hat used t he prompt .

Report Job I ndicat es t he report job t hat used t he prompt .

RP Number of Jobs (I S _
Met ric of how many jobs involved a prompt .
P R_A NS _FA CT)

RP Number of Jobs
Met ric of how many report jobs had a specif ied prompt
Cont aining P rompt
answer value.
A nswer V alue

RP Number of Jobs Not

Met ric of how many report jobs did not have a specif ied
Cont aining P rompt
prompt answer value.
A nswer V alue

RP Number of Jobs wit h Met ric of how many report jobs had a prompt t hat was not
Unanswered P rompt s answered.

Report Job Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion is ad hoc.

Cache Creat ion I ndicat or I ndicat es whet her an execut ion has creat ed a cache.

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Cancelled I ndicat or I ndicat es whet her an execut ion has been canceled.

I ndicat es whet her a job was a document dat aset or a

Child Job I ndicat or
st andalone report .

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

© 2019, M icr o St r at egy In c. 2046

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

I ndicat es whet her a report request f ailed because of a

Dat abase E rror I ndicat or
dat abase error.

Dat amart I ndicat or I ndicat es whet her an execut ion creat ed a dat a mart .

Day I ndicat es t he day on which t he report was execut ed.

I ndicat es t he dat abase inst ance on which t he report was

DB I nst ance
execut ed.

Drill I ndicat or I ndicat es whet her an execut ion is a result of a drill.

I ndicat es whet her an execut ion is a result of an element

E lement Load I ndicat or
load.

E rror I ndicat or I ndicat es whet her an execut ion encount ered an error.

I ndicat es whet her a report was export ed and, if so,

E xport I ndicat or
indicat es it s f ormat .

Filt er I ndicat es t he f ilt er used on t he report .

Hour I ndicat es t he hour on which t he report was execut ed.

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he report .

Met adat a I ndicat es t he met adat a reposit ory t hat st ores t he report .

I ndicat es t he minut e on which t he report execut ion was

Minut e
st art ed.

Number of Jobs wit h Met ric of how many job execut ions used an I nt elligent
I nt elligent Cube Hit Cube.

P roject I ndicat es t he met adat a reposit ory t hat st ores t he report .

P rompt I ndicat or I ndicat es whet her t he report execut ion was prompt ed.

Report I ndicat es t he I D of t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

2047 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP A verage E lapsed
Met ric of t he average dif f erence bet ween st art t ime and
Durat ion per Job
f inish t ime (including t ime f or prompt responses) of all
(hh: mm: ss) (I S _RE P _
report job execut ions.
FA CT)

RP A verage E lapsed Met ric of t he average dif f erence bet ween st art t ime and
Durat ion per Job (secs) f inish t ime (including t ime f or prompt responses) of all
(I S _RE P _FA CT) report job execut ions.

RP A verage E xecut ion

Durat ion per Job Met ric of t he average durat ion of all report job execut ions.
(hh: mm: ss) (I S _RE P _ I ncludes t ime in queue and execut ion f or a report job.
FA CT)

RP A verage E xecut ion Met ric of t he average durat ion, in seconds, of all report
Durat ion per Job (secs) job execut ions. I ncludes t ime in queue and execut ion f or
(I S _RE P _FA CT) a report job.

RP A verage P rompt
Met ric of t he average t ime users t ake t o answer t he set of
A nswer Time per Job
prompt s in all report jobs.
(hh: mm: ss)

RP A verage P rompt
Met ric of t he average t ime, in seconds, users t ake t o
A nswer Time per Job
answer t he set of prompt s in all report jobs.
(secs)

RP A verage Queue
Met ric of t he average t ime report jobs wait ed in t he
Durat ion per Job
I nt elligence S erver's queue bef ore t he report job was
(hh: mm: ss) (I S _RE P _
execut ed.
FA CT)

RP A verage Queue Met ric of t he average t ime, in seconds, report jobs wait ed
Durat ion per Job (secs) in t he I nt elligence S erver's queue bef ore t he report job
(I S _RE P _FA CT) was execut ed.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E lapsed Durat ion
of a report job. I ncludes t ime f or prompt responses, in
(hh: mm: ss)
queue, and execut ion.

© 2019, M icr o St r at egy In c. 2048

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E lapsed Durat ion
and f inish t ime of a report job. I ncludes t ime f or prompt
(secs)
responses, in queue, and execut ion.

RP E xecut ion Durat ion Met ric of t he durat ion of a report job's execut ion. I ncludes
(hh: mm: ss) dat abase execut ion t ime.

RP E xecut ion Durat ion Met ric of t he durat ion, in seconds, of a report job's
(secs) execut ion. I ncludes dat abase execut ion t ime.

RP Number of A d Hoc Met ric of how many report jobs result ed f rom an ad hoc
Jobs report creat ion.

RP Number of Cancelled
Met ric of how many job execut ions were canceled.
Jobs

Met ric of how many job execut ions result ed f rom a drill
RP Number of Drill Jobs
act ion.

RP Number of Jobs (I S _
Met ric of how many report jobs were execut ed.
RE P _FA CT)

RP Number of Jobs Met ric of how many report jobs were execut ed against t he
hit t ing Dat abase dat abase.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
Cache Creat ion result in creat ing a server cache.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
Cache Hit hit a server cache.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
E lement Loading result f rom loading addit ional at t ribut e element s.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
Cache Creat ion result ed in a server cache being creat ed.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat hit a
Cache Hit server cache.

2049 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
Dat amart Creat ion result ed in a dat a mart being creat ed.

RP Number of Jobs wit h Met ric of how many report jobs f ailed because of a
DB E rror dat abase error.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
E lement Loading result ed f rom loading addit ional at t ribut e element s.

RP Number of Jobs wit h

Met ric of how many report jobs f ailed because of an error.
E rror

RP Number of Jobs wit h Met ric of how many report job execut ions used an
I nt elligent Cube Hit I nt elligent Cube.

RP Number of Jobs wit h Met ric of how many report job execut ions used a securit y
S ecurit y Filt er f ilt er.

RP Number of Jobs wit h

Met ric of how many report jobs execut ed S QL st at ement s.
S QL E xecut ion

RP number of Met ric of how many report job execut ions were run
Narrowcast S erver jobs t hrough MicroS t rat egy Narrowcast S erver.

RP Number of P rompt ed Met ric of how many report job execut ions included a
Jobs prompt .

RP Number of Report
Met ric of how many report jobs execut ed as a result of a
Jobs f rom Document
document execut ion.
E xecut ion

RP Number of Result Met ric of how many result rows were ret urned f rom a
Rows report execut ion.

RP Number of
Met ric of how many report jobs were scheduled.
S cheduled Jobs

RP Number of Users who

Met ric of how many dist inct users ran report jobs.
ran report s

© 2019, M icr o St r at egy In c. 205 0

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP P rompt A nswer Met ric of t he how long users t ake t o answer t he set of
Durat ion (hh: mm: ss) prompt s in report jobs.

RP P rompt A nswer Met ric of t he how long, in seconds, users t ake t o answer
Durat ion (secs) t he set of prompt s in report jobs.

RP Queue Durat ion Met ric of how long a report job wait ed in t he I nt elligence
(hh: mm: ss) S erver's queue bef ore t he report job was execut ed.

Met ric of how long, in seconds, a report job wait ed in t he

RP Queue Durat ion
I nt elligence S erver's queue bef ore t he report job was
(secs)
execut ed.

S chedule I ndicat es t he schedule t hat began t he report execut ion.

S chedule I ndicat or I ndicat es whet her t he report execut ion was scheduled.

S ecurit y Filt er I ndicat es t he securit y f ilt er used in t he report execut ion.

I ndicat es whet her a securit y f ilt er was used in t he report

S ecurit y Filt er I ndicat or
execut ion.

S QL E xecut ion I ndicat or I ndicat es t hat S QL was execut ed during report execut ion.

Templat e I ndicat es t he report t emplat e t hat was used.

User I ndicat es t he user t hat ran t he report .

Report Job SQL Pass Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her t he execut ion was ad hoc.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

Day I ndicat es t he day in which t he job was execut ed.

205 1 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Hour I ndicat es t he hour in which t he report job was execut ed.

I ndicat es t he met adat a reposit ory st oring t he report or

Met adat a
document .

Minut e I ndicat es t he minut e in which t he report job was st art ed.

P roject I ndicat es t he project st oring t he report or document .

Report I ndicat es t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

I ndicat es t he S QL st at ement t hat was execut ed during t he

Report Job S QL P ass
S QL pass.

I ndicat es t he t ype of S QL st at ement t hat was execut ed in

Report Job S QL P ass
t his S QL pass. E xamples are S QL select , S QL insert ,
Type
S QL creat e and such.

RP E xecut ion Durat ion Met ric of t he durat ion of a report job's execut ion. I ncludes
(hh: mm: ss) dat abase execut ion t ime.

RP E xecut ion Durat ion Met ric of t he durat ion, in seconds, of a report job's
(secs) execut ion. I ncludes dat abase execut ion t ime.

RP Last E xecut ion Finish Met ric of t he f inish t imest amp when t he report job was
Timest amp last execut ed.

RP Last E xecut ion S t art Met ric of t he st art t imest amp when t he report job was last
Timest amp execut ed.

RP Number of DB Tables Met ric of how many dat abase t ables were accessed in a
A ccessed report job execut ion.

Met ric of how large, in byt es, t he S QL was f or a report

RP S QL S ize
job.

© 2019, M icr o St r at egy In c. 205 2

Syst em Ad m in ist r at io n Gu id e

Report Job Steps Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion was ad hoc.

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

Day I ndicat es t he day in which t he job was execut ed.

Hour I ndicat es t he hour in which t he report job was execut ed.

Minut e I ndicat es t he minut e in which t he report job was st art ed.

Report I ndicat es t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

I ndicat es t he sequence number in t he series of execut ion

Report Job S t ep
st eps a report job passes t hrough in t he I nt elligence
S equence
S erver.

I ndicat es t he t ype of st ep f or a report job. E xamples are

S QL generat ion, S QL execut ion, A nalyt ical E ngine,
Report Job S t ep Type
Resolut ion S erver, element request , updat e I nt elligent
Cube, and so on.

RP A verage CP U
E xecut ion Durat ion per Met ric of t he average durat ion, in milliseconds, a report
Job (msecs) (I S _RE P _ job execut ion t akes in t he I nt elligence S erver CP U.
S TE P _FA CT)

RP A verage E lapsed Met ric of t he average dif f erence, in seconds, bet ween
Durat ion per Job (secs) st art t ime and f inish t ime of report job execut ions.
(I S _RE P _S TE P _FA CT) I ncludes t ime f or prompt responses.

RP A verage E xecut ion Met ric of t he average dif f erence, in seconds, bet ween

205 3 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Durat ion per Job (secs) st art t ime and f inish t ime of report job execut ions.
(I S _RE P _S TE P _FA CT) I ncludes t ime f or prompt responses.

RP A verage Query
E ngine E xecut ion Met ric of t he average t ime, in seconds, t he Query E ngine
Durat ion per Job (secs) t akes t o process a report job.
(I S _RE P _S TE P _FA CT)

RP A verage Queue Met ric of t he average t ime report jobs wait ed in t he

Durat ion per Job (secs) I nt elligence S erver's queue bef ore t he report job was
(I S _RE P _S TE P _FA CT) execut ed.

Met ric of how long, in milliseconds, a report job execut ion

RP CP U Durat ion (msec)
t akes in t he I nt elligence S erver CP U.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E lapsed Durat ion
of report job execut ions. I ncludes t ime f or prompt
(hh: mm: ss)
responses.

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E lapsed Durat ion
and f inish t ime of report job execut ions. I ncludes t ime f or
(secs)
prompt responses.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E xecut ion Durat ion
of report job execut ions. I ncludes dat abase execut ion
(hh: mm: ss)
t ime.

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E xecut ion Durat ion
and f inish t ime of report job execut ions. I ncludes
(secs)
dat abase execut ion t ime.

RP Last E xecut ion Finish Met ric of t he f inish t imest amp when t he report job was
Timest amp last execut ed.

RP Last E xecut ion S t art Met ric of t he st art t imest amp when t he report job was last
Timest amp execut ed.

RP Number of Jobs (I S _
Met ric of how many report jobs were execut ed.
RE P _S TE P _FA CT)

© 2019, M icr o St r at egy In c. 205 4

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP Query E ngine
Met ric of how long t he Query E ngine t ook t o execut e S QL
Durat ion (hh: mm: ss)
f or a report job.
(I S _RE P _S TE P _FA CT)

RP Query E ngine
Met ric of t he t ime, in seconds, t he Query E ngine t akes t o
Durat ion (secs) (I S _
execut e S QL f or a report job.
RE P _S TE P _FA CT)

RP Queue Durat ion Met ric of how long a report job wait ed in t he I nt elligence
(hh: mm: ss) S erver's queue bef ore t he report job was execut ed.

Met ric of how long, in seconds, a report job wait ed in t he

RP Queue Durat ion
I nt elligence S erver's queue bef ore t he report job was
(secs)
execut ed.

RP S QL E ngine Durat ion

Met ric of how long t he S QL E ngine t ook t o generat e S QL
(hh: mm: ss) (I S _RE P _
f or a report job.
S TE P _FA CT)

Report Job Tables/Columns Accessed Attributes and

Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion was ad hoc.

Column I ndicat es t he column t hat was accessed.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es t he day on which t he t able column was

Day
accessed.

I ndicat es t he t able in t he dat abase st oring t he column

DB Table
t hat was accessed.

205 5 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

I ndicat es t he hour on which t he t able column was

Hour
accessed.

I ndicat es t he minut e on which t he t able column was

Minut e
accessed.

Report I ndicat es t he report t hat accessed t he t able column.

I ndicat es which execut ion of a report accessed t he t able

Report Job
column.

Met ric of how many report jobs accessed t he dat abase

RP Number of Jobs (I S _
column or t able. The Warehouse Tables A ccessed report
RE P _COL_FA CT)
uses t his met ric.

I ndicat es which t ype of S QL clause was used t o access

S QL Clause Type
t he t able column.

Schema Objects Attributes

Attrib u te
F u n ctio n
n ame

List s all at t ribut es in project s t hat are set up t o be monit ored by

A t t ribut e
E nt erprise Manager.

List s all at t ribut e f orms in project s t hat are set up t o be monit ored
A t t ribut e Form
by E nt erprise Manager.

List s all columns in project s t hat are set up t o be monit ored by

Column
E nt erprise Manager.

List s all physical t ables in t he dat a warehouse t hat are set up t o be

DB Table
monit ored by E nt erprise Manager.

List s all f act s in project s t hat are set up t o be monit ored by

Fact
E nt erprise Manager.

© 2019, M icr o St r at egy In c. 205 6

Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s all hierarchies in project s t hat are set up t o be monit ored by

Hierarchy
E nt erprise Manager

List s all logical t ables in project s t hat are set up t o be monit ored by
Table
E nt erprise Manager.

List s all t ransf ormat ions in project s t hat are set up t o be monit ored
Transf ormat ion
by E nt erprise Manager.

Server Machines Attributes

Attrib u te n ame F u n ctio n

List s all machines t hat have had users connect t o t he

Client Machine
I nt elligence S erver.

I nt elligence S erver
List s t he clust er of I nt elligence S ervers.
Clust er

I nt elligence S erver List s all machines t hat have logged st at ist ics as an
Machine I nt elligence S erver.

Web S erver Machine List s all machines used as web servers.

Session Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A vg. Connect ion Met ric of t he average t ime connect ions t o an I nt elligence
Durat ion (hh: mm: ss) S erver last .

A vg. Connect ion Met ric of t he average t ime, in seconds, connect ions t o an
Durat ion (secs) I nt elligence S erver last .

205 7 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Connect ion Durat ion Met ric of t he t ime a connect ion t o an I nt elligence S erver
(hh: mm: ss) last s.

Connect ion Durat ion Met ric of t he t ime, in seconds, a connect ion t o an
(secs) I nt elligence S erver last s.

Connect ion S ource List s all connect ion sources t o I nt elligence S erver.

Met ric of how many sessions were connect ed t o an

Number of S essions
I nt elligence S erver. Usually report ed wit h a dat e and t ime
(Report Level)
at t ribut e.

Met ric of how many dist inct users were connect ed t o an

Number of Users Logged
I nt elligence S erver. Usually report ed wit h a dat e and t ime
I n (Report Level)
at t ribut e.

S ession I ndicat es a user connect ion t o an I nt elligence S erver.

All Indicators and Flags Attributes

Attrib u te n ame F u n ctio n

A d Hoc I ndicat or I ndicat es whet her an execut ion is ad hoc.

Cache Creat ion

I ndicat es whet her an execut ion has creat ed a cache.
I ndicat or

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Cancelled I ndicat or I ndicat es whet her an execut ion has been cancelled.

I ndicat es whet her a job was a document dat aset or a st and-

Child Job I ndicat or
alone report .

Conf igurat ion Object

I ndicat es whet her a conf igurat ion object exist s.
E xist s S t at us

Conf igurat ion List s all conf igurat ion paramet er t ypes.

© 2019, M icr o St r at egy In c. 205 8

Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

P aramet er V alue Type

Connect ion S ource List s all connect ion sources t o I nt elligence S erver.

Cont act Type List s t he execut ed cont act t ypes.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

Dat abase E rror I ndicat es whet her a report request f ailed because of a
I ndicat or dat abase error.

Dat amart I ndicat or I ndicat es whet her an execut ion creat ed a dat a mart .

I ndicat es whet her an execut ion encount ered a dat abase

DB E rror I ndicat or
error.

Delivery S t at us
I ndicat es whet her a delivery was successf ul.
I ndicat or

Delivery Type List s t he t ype of delivery.

Document Job S t at us
List s t he st at uses of document execut ions.
(Deprecat ed)

Document Job S t ep
List s all possible st eps of document job execut ion.
Type

I ndicat es t he t ype of a document or dossier, such as HTML

Document Type
document , Report S ervices document , or a dossier.

List s t he object f rom which a user drilled when a new report

Drill f rom Object
was run because of a drilling act ion.

Drill I ndicat or I ndicat es whet her an execut ion is a result of a drill.

List s t he object t o which a user drilled when a new report

Drill t o Object
was run because of a drilling act ion.

I ndicat es whet her an execut ion is a result of an element

E lement Load I ndicat or
load.

205 9 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

E rror I ndicat or I ndicat es whet her an execut ion encount ered an error.

E xecut ion Type I ndicat es how t he cont ent was request ed, such as User
I ndicat or E xecut ion, P re-Cached, A pplicat ion Recovery, and so on.

I ndicat es whet her a report was export ed and, if so,

E xport I ndicat or
indicat es it s f ormat .

Hierarchy Drilling I ndicat es whet her a hierarchy is used as a drill hierarchy.

List t he t ypes of manipulat ions t hat can be perf ormed on a

I nbox A ct ion Type
Hist ory List message.

I nt elligent Cube A ct ion

List s act ions perf ormed on or against int elligent cubes.
Type

I nt elligent Cube Type List s all int elligent cube t ypes.

List s all t he possible errors t hat can be ret urned during job
Job E rrorCode
execut ions.

Job P riorit y Map List s t he priorit ies of job execut ions.

E numerat es t he upper limit of t he priorit y ranges f or high,

Job P riorit y Number medium, and low priorit y jobs. Def ault values are 332, 666,
and 999.

Object Creat ion Dat e I ndicat es t he dat e on which an object was creat ed.

Object Creat ion I ndicat es t he week of t he year in which an object was

Week of year creat ed.

Object E xist s S t at us I ndicat es whet her an object exist s.

Object Hidden S t at us I ndicat es whet her an object is hidden.

Object Modif icat ion

I ndicat es t he dat e on which an object was last modif ied.
Dat e

Object Modif icat ion I ndicat es t he week of t he year in which an object was last
Week of year modif ied.

P rompt A nswer I ndicat es whet her a prompt answer was required f or t he job

© 2019, M icr o St r at egy In c. 2060

Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

Required execut ion.

P rompt I ndicat or I ndicat es whet her a job execut ion was prompt ed.

Report Job S QL P ass List s t he t ypes of S QL passes t hat t he I nt elligence S erver

Type generat es.

Report Job S t at us
List s t he st at uses of report execut ions.
(Deprecat ed)

Report Job S t ep Type List s all possible st eps of report job execut ion.

I ndicat es t he t ype of a report , such as X DA , relat ional, and

Report Type
so on.

Report / Document I ndicat es whet her t he execut ion was a report or a

I ndicat or document .

S chedule I ndicat or I ndicat es whet her a job execut ion was scheduled.

S ecurit y Filt er I ndicat es whet her a securit y f ilt er was used in t he job
I ndicat or execut ion.

S QL Clause Type List s t he various S QL clause t ypes used by t he S QL E ngine.

S QL E xecut ion
I ndicat es whet her S QL was execut ed in t he job execut ion.
I ndicat or

Application Objects Attributes

Attrib u te
F u n ctio n
n ame

List s all consolidat ions in project s t hat are set up t o be monit ored
Consolidat ion
by E nt erprise Manager.

List s all cust om groups in project s t hat are set up t o be monit ored
Cust om Group
by E nt erprise Manager.

2061 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s all document s in project s t hat are set up t o be monit ored by

Document
E nt erprise Manager.

List s all f ilt ers in project s t hat are set up t o be monit ored by
Filt er
E nt erprise Manager.

I nt elligent List s all int elligent cubes in project s t hat are set up t o be
Cube monit ored by E nt erprise Manager.

List s all met rics in project s t hat are set up t o be monit ored by
Met ric
E nt erprise Manager.

List s all prompt s in project s t hat are set up t o be monit ored by

P rompt
E nt erprise Manager.

List s all report s in project s t hat are set up t o be monit ored by

Report
E nt erprise Manager.

List s all securit y f ilt ers in project s t hat are set up t o be monit ored
S ecurit y Filt er
by E nt erprise Manager.

List s all t emplat es in project s t hat are set up t o be monit ored by

Templat e
E nt erprise Manager.

Configuration Objects Attributes

Attrib u te n ame F u n ctio n

A ddress List s all addresses t o which deliveries have been sent .

Conf igurat ion Object

List s t he owners of conf igurat ion object s.
Owner

Conf igurat ion

List s all conf igurat ion paramet ers.
P aramet er

Cont act List s all cont act s t o whom deliveries have been sent .

© 2019, M icr o St r at egy In c. 2062

Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

DB Connect ion List s all dat abase connect ions.

DB I nst ance List s all dat abase inst ances.

Device List s all devices t o which deliveries have been sent .

E vent List s all event s being t racked.

Folder List s all f olders wit hin project s.

I nt elligence S erver
List s all I nt elligence S erver def init ions.
Def init ion

Met adat a List s all monit ored met adat a.

Owner List s t he owners of all object s.

P roject List s all project s.

S chedule List s all schedules.

S ubscript ion List s all execut ed t ransmissions.

Transmit t er List s all t ransmit t ers.

User List s all users being t racked.

User Group List s all user groups.

User Group (P arent ) List s all user groups t hat are parent s of ot her user groups.

Date and Time Attributes

Attrib u te
F u n ctio n
n ame

Calendar List s every calendar week, beginning wit h 2000-01-01, as an

Week int eger.

Day List s all days, beginning in 1990.

2063 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s t he hours in a day. For example, 09 A M - 10 A M, 10 A M - 11

Hour
A M, and so on.

List s all t he minut es in an hour. For example, if t he hour specif ied is

Minut e 10 A M - 11 A M, list s minut es as 10. 30 A M - 10. 31 A M, 10. 32 A M -
10. 33 A M, and so on.

Mont h List s all mont hs, beginning wit h 2000.

Mont h of Y ear List s all mont hs in a specif ied year.

Quart er List s all quart ers.

Quart er of
List s all quart ers of t he year.
Y ear

List s all weeks in all years, beginning in 2000. Weeks in 2000 are
represent ed as a number ranging f rom 200001 t o 200053, weeks in
Week of Y ear
2001 are represent ed as a number ranging f rom 200101 t o 200153,
and so on.

Weekday List s all days of t he week.

Y ear List s all years.

Delivery Services Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

A ddress I ndicat es t he address t o which a delivery was sent .

A vg number of recipient s per Met ric of t he average number of recipient s in

subscript ion subscript ions.

A vg S ubscript ion E xecut ion Met ric of t he average amount of t ime subscript ions
Durat ion (hh: mm: ss) t ake t o execut e.

A vg S ubscript ion E xecut ion Met ric of t he average amount of t ime, in seconds,

© 2019, M icr o St r at egy In c. 2064

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Durat ion (secs) subscript ions t ake t o execut e.

Cont act I ndicat es all cont act s t o whom a delivery was sent .

Cont act Type I ndicat es t he execut ed cont act t ypes.

Day I ndicat es t he day on which t he delivery was sent .

Delivery S t at us I ndicat or I ndicat es whet her t he delivery was successf ul.

Delivery Type I ndicat es t he t ype of delivery.

I ndicat es t he t ype of device t o which t he delivery

Device
was sent .

Document I ndicat es t he document t hat was delivered.

Hour I ndicat es t he hour on which t he delivery was sent .

I ndicat es t he I nt elligence S erver machine t hat

I nt elligence S erver Machine
execut ed t he job.

Met adat a I ndicat es t he monit ored met adat a.

I ndicat es t he minut e on which t he delivery was

Minut e
sent .

Number of Dist inct Document Met ric of t he number of report services document
S ubscript ions subscript ions.

Met ric of t he number of recipient s t hat received

Number of Dist inct Recipient s
cont ent f rom a subscript ion.

Number of Dist inct Report

Met ric of t he number of report subscript ions.
S ubscript ions

Met ric of t he number of execut ed subscript ions.

Number of Dist inct
This does not ref lect t he number of subscript ions
S ubscript ions
in t he met adat a.

Met ric of t he number of subscript ions t hat

Number of E -mail S ubscript ions
delivered cont ent via e-mail.

2065 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Number of E rrored
Met ric of t he number of subscript ions t hat f ailed.
S ubscript ions

Met ric of t he number of execut ions of a

Number of E xecut ions
subscript ion.

Met ric of t he number of subscript ions t hat

Number of File S ubscript ions
delivered cont ent via f ile locat ion.

Number of Hist ory List Met ric of t he number of subscript ions t hat
S ubscript ions delivered cont ent via t he hist ory list .

Met ric of t he number of subscript ions t hat

Number of Mobile S ubscript ions
delivered cont ent via mobile.

Met ric of t he number of subscript ions t hat

Number of P rint S ubscript ions
delivered cont ent via a print er.

P roject List s t he project s.

Report List s t he report s in project s.

Report Job List s an execut ion of a report .

I ndicat es whet her t he execut ion was a report or a

Report / Document I ndicat or
document .

S chedule I ndicat es t he schedule t hat t riggered t he delivery.

I ndicat es t he subscript ion t hat t riggered t he

S ubscript ion
delivery.

S ubscript ion E xecut ion Met ric of t he sum of all execut ion t imes of a
Durat ion (hh: mm: ss) subscript ion.

S ubscript ion E xecut ion Durat ion Met ric of t he sum of all execut ion t imes of a
(secs) subscript ion (in seconds).

© 2019, M icr o St r at egy In c. 2066

Syst em Ad m in ist r at io n Gu id e

Document Job Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

I ndicat es t he day on which t he document job

Day
execut ed.

Document I ndicat es which document was execut ed.

Document Job I ndicat es an execut ion of a document .

Met ric of t he average dif f erence bet ween st art t ime

DP A verage E lapsed Durat ion
and f inish t ime (including t ime f or prompt
per Job (hh: mm: ss)
responses) of all document job execut ions.

Met ric of t he average dif f erence, in seconds,

DP A verage E lapsed Durat ion bet ween st art t ime and f inish t ime (including t ime
per Job (secs) f or prompt responses) of all document job
execut ions.

DP A verage E xecut ion Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions.

DP A verage E xecut ion Met ric of t he average durat ion of all document job
Durat ion per Job (hh: mm: ss) execut ions.

DP A verage Queue Durat ion Met ric of t he average durat ion of all document job
per Job (hh: mm: ss) execut ions wait ing in t he queue.

DP A verage Queue Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions wait ing in t he queue.

Met ric of t he dif f erence bet ween st art t ime and

DP E lapsed Durat ion
f inish t ime (including t ime f or prompt responses) of
(hh: mm: ss)
a document job.

Met ric of t he average dif f erence, in seconds,

DP E lapsed Durat ion (secs) bet ween st art t ime and f inish t ime (including t ime
f or prompt responses) of a document job.

DP E xecut ion Durat ion Met ric of t he durat ion of a document job's
(hh: mm: ss) execut ion.

2067 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Met ric of t he durat ion, in seconds, of a document

DP E xecut ion Durat ion (secs)
job's execut ion.

DP Number of Jobs (I S _DOC_ Met ric of t he number of document jobs t hat were
FA CT) execut ed.

DP Number of Jobs wit h Cache Met ric of t he number of document jobs t hat hit a
Hit cache.

DP Number of Jobs wit h E rror Met ric of t he number of document jobs t hat f ailed.

DP Number of Users who ran Met ric of t he number of users who ran document
Document s jobs.

DP P ercent age of Jobs wit h Met ric of t he percent age of document jobs t hat hit
Cache Hit a cache.

DP P ercent age of Jobs wit h Met ric of t he percent age of document jobs t hat
E rror f ailed.

Met ric of t he durat ion of all document job

DP Queue Durat ion (hh: mm: ss)
execut ions wait ing in t he queue.

Met ric of t he durat ion, in seconds, of all document

DP Queue Durat ion (secs)
job execut ions wait ing in t he queue.

Hour I ndicat es t he hour t he document job was execut ed.

I ndicat es t he I nt elligence S erver machine t hat

I nt elligence S erver Machine
execut ed t he document job.

Met adat a I ndicat es t he met adat a st oring t he document .

I ndicat es t he minut e t he document job was

Minut e
execut ed.

P roject I ndicat es t he project st oring t he document .

Report I ndicat es t he report s in t he document .

User I ndicat es t he user who ran t he document job.

© 2019, M icr o St r at egy In c. 2068

Syst em Ad m in ist r at io n Gu id e

Document Job Step Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

I ndicat es t he day on which t he document job

Day
execut ed.

Document I ndicat es which document was execut ed.

I ndicat es t he sequence number f or st eps in a

Document Job S t ep S equence
document job.

Document Job S t ep Type I ndicat es t he t ype of st ep f or a document job.

Met ric of t he average dif f erence bet ween st art t ime

DP A verage E lapsed Durat ion
and f inish t ime (including t ime f or prompt
per Job (hh: mm: ss)
responses) of all document job execut ions.

Met ric of t he average dif f erence, in seconds,

DP A verage E lapsed Durat ion bet ween st art t ime and f inish t ime (including t ime
per Job (secs) f or prompt responses) of all document job
execut ions.

DP A verage E xecut ion Met ric of t he average durat ion of all document job
Durat ion per Job (hh: mm: ss) execut ions.

DP A verage E xecut ion Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions.

DP A verage Queue Durat ion Met ric of t he average durat ion of all document job
per Job (hh: mm: ss) execut ions wait ing in t he queue.

DP A verage Queue Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions wait ing in t he queue.

Met ric of t he dif f erence bet ween st art t ime and

DP E lapsed Durat ion
f inish t ime (including t ime f or prompt responses) of
(hh: mm: ss)
a document job.

Met ric of t he average dif f erence, in seconds,

DP E lapsed Durat ion (secs) bet ween st art t ime and f inish t ime (including t ime
f or prompt responses) of a document job.

2069 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

DP E xecut ion Durat ion Met ric of t he durat ion of a document job's
(hh: mm: ss) execut ion.

Met ric of t he durat ion, in seconds, of a document

DP E xecut ion Durat ion (secs)
job's execut ion.

Met ric of t he durat ion of all document job

DP Queue Durat ion (hh: mm: ss)
execut ions wait ing in t he queue.

Met ric of t he durat ion, in seconds, of all document

DP Queue Durat ion (secs)
job execut ions wait ing in t he queue.

Hour I ndicat es t he hour t he document job was execut ed.

Met adat a I ndicat es t he met adat a st oring t he document .

I ndicat es t he minut e t he document job was

Minut e
execut ed.

P roject I ndicat es t he project st oring t he document .

Enterprise Manager Data Load Attributes

Attrib u te n ame F u n ctio n

Dat a Load Finish Displays t he t imest amp of t he end of t he dat a load process
Time f or t he project s t hat are being monit ored.

Dat a Load P roject List s all project s t hat are being monit ored.

List s t he t imest amp of t he st art of t he dat a load process f or

Dat a Load S t art Time
t he project s t hat are being monit ored.

A value of -1 indicat es t hat it is t he summary row in t he E M_

I S _LA S T_UP DA TE t able f or all project s in a dat a load. That
I t em I D summary row has inf ormat ion about how long t he dat a load
t ook. A value of 0 indicat es it is a row wit h project dat a load
det ails.

© 2019, M icr o St r at egy In c. 2070

Syst em Ad m in ist r at io n Gu id e

Inbox Message Actions Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Day I ndicat es t he day t he manipulat ion was st art ed

Document I ndicat es t he document included in t he message.

I ndicat es t he document job t hat request ed t he Hist ory

Document Job
List message manipulat ion.

HL Days S ince Last Met ric of t he number of days since any act ion was
A ct ion: A ny act ion perf ormed.

HL Days S ince Last Met ric of t he number of days since t he last request was
A ct ion: Request made f or t he cont ent s of a message.

Met ric of t he dat e and t ime of t he last act ion perf ormed
HL Last A ct ion Dat e: A ny
on a message such as read, delet ed, marked as read, and
A ct ion
so on.

HL Last A ct ion Dat e: Met ric of t he dat e and t ime of t he last request made f or
Request t he cont ent s of a message.

HL Number of A ct ions Met ric of t he number of act ions perf ormed on a message.

HL Number of A ct ions by Met ric of t he number of act ions by user perf ormed on a
User message.

HL Number of A ct ions Met ric of t he number of act ions on a message t hat

wit h E rrors result ed in an error.

HL Number of Document Met ric of t he number of document jobs t hat result wit h
Jobs messages.

HL Number of Messages Met ric of t he number of messages.

HL Number of Messages Met ric of t he number of messages t hat result ed in an

wit h E rrors error.

HL Number of Messages Met ric of t he number of request s f or t he cont ent s of a

Request ed message.

2071 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

HL Number of Report Met ric of t he number of report jobs t hat result f rom
Jobs messages.

I ndicat es t he hour t he manipulat ion was st art ed on a

Hour
Hist ory List message.

I ndicat es t he manipulat ion t hat was perf ormed on a

I nbox A ct ion
Hist ory List message.

I ndicat es t he t ype of manipulat ion t hat was perf ormed on

I nbox A ct ion Type
a Hist ory List message.

I nbox Message I ndicat es t he message in t he Hist ory List .

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he message.

Met adat a I ndicat es t he met adat a st oring t he message.

Minut e I ndicat es t he minut e t he manipulat ion was st art ed.

P roject I ndicat es t he project st oring t he message.

Report I ndicat es t he report included in t he message.

I ndicat es t he job I D of t he report included in t he

Report Job
message.

I ndicat es t he user who manipulat ed t he Hist ory List

User
message.

Mobile Client Attributes

Attrib u te n ame F u n ctio n

I ndicat es whet her a cache was hit during t he execut ion

Cache Hit I ndicat or
and, if so, what t ype of cache hit .

© 2019, M icr o St r at egy In c. 2072

Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

Day I ndicat es t he day t he act ion st art ed.

Document I dent if ies t he document used in t he request .

I ndicat es t he t ype of report or document t hat init iat ed t he

E xecut ion Type I ndicat or
execut ion.

I ndicat es t he locat ion, in lat it ude and longit ude f orm, of

Geocode
t he user.

Hour I ndicat es t he hour t he act ion st art ed.

I nt elligence S erver
I ndicat es t he I nt elligence S erver processing t he request .
Machine

I ndicat es t he met adat a reposit ory st oring t he report or

Met adat a
document .

Minut e I ndicat es t he minut e t he act ion st art ed.

Mobile Device
I ndicat es t he unique I nst allat ion I D of t he mobile app.
I nst allat ion I D

I ndicat es t he t ype of mobile device t he app is inst alled

Mobile Device Type
on, such as I P A D2, DROI D, and so on.

I ndicat es t he version of t he MicroS t rat egy app making t he

MS TR A pp V ersion
request .

I ndicat es t he t ype of net work used, such as 3G, WI FI ,

Net work Type
LTE , and so on.

I ndicat es t he operat ing syst em of t he mobile device

Operat ing S yst em
making t he request .

Operat ing S yst em I ndicat es t he operat ing syst em version of t he mobile

V ersion device making t he request .

P roject I ndicat es t he project used t o init iat e t he request .

User I ndicat es t he user t hat init iat ed t he request .

2073 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

OLAP Services Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Day I ndicat es t he day t he act ion was st art ed.

Hour I ndicat es t he hour t he act ion was st art ed.

I nt elligent Cube I ndicat es t he I nt elligent Cube t hat was used.

I nt elligent Cube A ct ion Met ric of t he durat ion, in seconds, f or an act ion t hat was
Durat ion (secs) perf ormed on t he I nt ellgent Cube.

I nt elligent Cube A ct ion I ndicat es t he t ype of act ion t aken on t he I nt elligent Cube
Type such as cube publish, cube view hit , and so on.

I ndicat es t he I nt elligent Cube inst ance in memory t hat

I nt elligent Cube I nst ance
was used f or t he act ion.

I nt elligent Cube S ize I f t he I nt elligent Cube is published or ref reshed, indicat es

(K B ) t he size, in K B , of t he I nt elligent Cube.

I ndicat es t he t ype of I nt elligent Cube used, such as

I nt elligent Cube Type working set report , Report S ervices B ase report , OLA P
Cube report , and so on.

Minut e I ndicat es t he minut e on which t he act ion was st art ed.

Met ric of how many jobs f rom report s not based on

Number of Dynamically
I nt elligent Cubes but select ed by t he engine t o go against
S ourced Report Jobs
an I nt elligent Cube because t he object s on t he report
against I nt elligent Cubes
mat ched what is on t he I nt elligent Cube.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube P ublishes published.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube Ref reshes ref reshed.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube Republishes republished.

© 2019, M icr o St r at egy In c. 2074

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Number of Jobs wit h Met ric of how many job execut ions used an I nt elligent
I nt elligent Cube Hit Cube.

Met ric of how many users execut ed a report or document

Number of Users hit t ing
t hat used an I nt elligent Cube. That is, t he number of
I nt elligent Cubes
users using OLA P S ervices.

Number of V iew Report Met ric of how many act ions were t he result of a V iew
Jobs Report .

Report I ndicat es t he report t hat hit t he I nt elligent Cube.

Performance Monitoring Attributes

Attrib u te n ame F u n ctio n

I ndicat es cat egory of t he count er, such as memory,

Count er Cat egory
MicroS t rat egy server jobs, or MicroS t rat egy server users.

I ndicat es t he inst ance I D of t he count er, f or MicroS t rat egy

Count er I nst ance
use.

Day I ndicat es t he day t he act ion was st art ed.

Hour I ndicat es t he hour t he act ion was st art ed.

Minut e I ndicat es t he minut e t he act ion was st art ed.

P erf ormance Monit or I ndicat es t he name of t he perf ormance count er and it s value
Count er t ype.

2075 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Prompt Answers Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Connect ion S ource Indicates the connection source to Intelligence Server.

Count of P rompt
Metric of how many prompts were answered.
A nswers

Day I ndicat es t he day t he prompt was answered.

Document I ndicat es t he document t hat used t he prompt .

Hour I ndicat es t he hour t he prompt was answered.

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he job.

Met adat a I ndicat es t he met adat a reposit ory st oring t he prompt .

Minut e I ndicat es t he minut e t he prompt was answered.

P roject I ndicat es t he project st oring t he prompt .

P rompt I ndicat es t he prompt t hat was used.

P rompt A nswer I ndicat es t he answers f or t he prompt in various inst ances.

P rompt A nswer Required I ndicat es whet her an answer t o t he prompt was required.

I ndicat es t he answer of an inst ance of a prompt in a

P rompt I nst ance A nswer
report job.

P rompt Locat ion Indicates the ID of the location in which a prompt is stored.

Indicates the type of the object in which the prompt is stored, such
P rompt Locat ion Type
as filter, template, attribute, and so on.

I ndicat es t he t it le of t he prompt (t he t it le t he user sees

P rompt Tit le
when present ed during job execut ion).

I ndicat es what t ype of prompt was used, such as dat e,

P rompt Type
double, element s, and so on.

© 2019, M icr o St r at egy In c. 2076

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Report I ndicat es t he report t hat used t he prompt .

Report Job I ndicat es t he report job t hat used t he prompt .

RP Number of Jobs (I S _
Met ric of how many jobs involved a prompt .
P R_A NS _FA CT)

RP Number of Jobs
Met ric of how many report jobs had a specif ied prompt
Cont aining P rompt
answer value.
A nswer V alue

RP Number of Jobs Not

Met ric of how many report jobs did not have a specif ied
Cont aining P rompt
prompt answer value.
A nswer V alue

RP Number of Jobs wit h Met ric of how many report jobs had a prompt t hat was not
Unanswered P rompt s answered.

Report Job Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion is ad hoc.

Cache Creat ion I ndicat or I ndicat es whet her an execut ion has creat ed a cache.

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Cancelled I ndicat or I ndicat es whet her an execut ion has been canceled.

I ndicat es whet her a job was a document dat aset or a

Child Job I ndicat or
st andalone report .

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

2077 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

I ndicat es whet her a report request f ailed because of a

Dat abase E rror I ndicat or
dat abase error.

Dat amart I ndicat or I ndicat es whet her an execut ion creat ed a dat a mart .

Day I ndicat es t he day on which t he report was execut ed.

I ndicat es t he dat abase inst ance on which t he report was

DB I nst ance
execut ed.

Drill I ndicat or I ndicat es whet her an execut ion is a result of a drill.

I ndicat es whet her an execut ion is a result of an element

E lement Load I ndicat or
load.

E rror I ndicat or I ndicat es whet her an execut ion encount ered an error.

I ndicat es whet her a report was export ed and, if so,

E xport I ndicat or
indicat es it s f ormat .

Filt er I ndicat es t he f ilt er used on t he report .

Hour I ndicat es t he hour on which t he report was execut ed.

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he report .

Met adat a I ndicat es t he met adat a reposit ory t hat st ores t he report .

I ndicat es t he minut e on which t he report execut ion was

Minut e
st art ed.

Number of Jobs wit h Met ric of how many job execut ions used an I nt elligent
I nt elligent Cube Hit Cube.

P roject I ndicat es t he met adat a reposit ory t hat st ores t he report .

P rompt I ndicat or I ndicat es whet her t he report execut ion was prompt ed.

Report I ndicat es t he I D of t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

© 2019, M icr o St r at egy In c. 2078

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP A verage E lapsed
Met ric of t he average dif f erence bet ween st art t ime and
Durat ion per Job
f inish t ime (including t ime f or prompt responses) of all
(hh: mm: ss) (I S _RE P _
report job execut ions.
FA CT)

RP A verage E lapsed Met ric of t he average dif f erence bet ween st art t ime and
Durat ion per Job (secs) f inish t ime (including t ime f or prompt responses) of all
(I S _RE P _FA CT) report job execut ions.

RP A verage E xecut ion

Durat ion per Job Met ric of t he average durat ion of all report job execut ions.
(hh: mm: ss) (I S _RE P _ I ncludes t ime in queue and execut ion f or a report job.
FA CT)

RP A verage E xecut ion Met ric of t he average durat ion, in seconds, of all report
Durat ion per Job (secs) job execut ions. I ncludes t ime in queue and execut ion f or
(I S _RE P _FA CT) a report job.

RP A verage P rompt
Met ric of t he average t ime users t ake t o answer t he set of
A nswer Time per Job
prompt s in all report jobs.
(hh: mm: ss)

RP A verage P rompt
Met ric of t he average t ime, in seconds, users t ake t o
A nswer Time per Job
answer t he set of prompt s in all report jobs.
(secs)

RP A verage Queue
Met ric of t he average t ime report jobs wait ed in t he
Durat ion per Job
I nt elligence S erver's queue bef ore t he report job was
(hh: mm: ss) (I S _RE P _
execut ed.
FA CT)

RP A verage Queue Met ric of t he average t ime, in seconds, report jobs wait ed
Durat ion per Job (secs) in t he I nt elligence S erver's queue bef ore t he report job
(I S _RE P _FA CT) was execut ed.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E lapsed Durat ion
of a report job. I ncludes t ime f or prompt responses, in
(hh: mm: ss)
queue, and execut ion.

2079 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E lapsed Durat ion
and f inish t ime of a report job. I ncludes t ime f or prompt
(secs)
responses, in queue, and execut ion.

RP E xecut ion Durat ion Met ric of t he durat ion of a report job's execut ion. I ncludes
(hh: mm: ss) dat abase execut ion t ime.

RP E xecut ion Durat ion Met ric of t he durat ion, in seconds, of a report job's
(secs) execut ion. I ncludes dat abase execut ion t ime.

RP Number of A d Hoc Met ric of how many report jobs result ed f rom an ad hoc
Jobs report creat ion.

RP Number of Cancelled
Met ric of how many job execut ions were canceled.
Jobs

Met ric of how many job execut ions result ed f rom a drill
RP Number of Drill Jobs
act ion.

RP Number of Jobs (I S _
Met ric of how many report jobs were execut ed.
RE P _FA CT)

RP Number of Jobs Met ric of how many report jobs were execut ed against t he
hit t ing Dat abase dat abase.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
Cache Creat ion result in creat ing a server cache.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
Cache Hit hit a server cache.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
E lement Loading result f rom loading addit ional at t ribut e element s.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
Cache Creat ion result ed in a server cache being creat ed.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat hit a
Cache Hit server cache.

© 2019, M icr o St r at egy In c. 2080

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
Dat amart Creat ion result ed in a dat a mart being creat ed.

RP Number of Jobs wit h Met ric of how many report jobs f ailed because of a
DB E rror dat abase error.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
E lement Loading result ed f rom loading addit ional at t ribut e element s.

RP Number of Jobs wit h

Met ric of how many report jobs f ailed because of an error.
E rror

RP Number of Jobs wit h Met ric of how many report job execut ions used an
I nt elligent Cube Hit I nt elligent Cube.

RP Number of Jobs wit h Met ric of how many report job execut ions used a securit y
S ecurit y Filt er f ilt er.

RP Number of Jobs wit h

Met ric of how many report jobs execut ed S QL st at ement s.
S QL E xecut ion

RP number of Met ric of how many report job execut ions were run
Narrowcast S erver jobs t hrough MicroS t rat egy Narrowcast S erver.

RP Number of P rompt ed Met ric of how many report job execut ions included a
Jobs prompt .

RP Number of Report
Met ric of how many report jobs execut ed as a result of a
Jobs f rom Document
document execut ion.
E xecut ion

RP Number of Result Met ric of how many result rows were ret urned f rom a
Rows report execut ion.

RP Number of
Met ric of how many report jobs were scheduled.
S cheduled Jobs

RP Number of Users who

Met ric of how many dist inct users ran report jobs.
ran report s

2081 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP P rompt A nswer Met ric of t he how long users t ake t o answer t he set of
Durat ion (hh: mm: ss) prompt s in report jobs.

RP P rompt A nswer Met ric of t he how long, in seconds, users t ake t o answer
Durat ion (secs) t he set of prompt s in report jobs.

RP Queue Durat ion Met ric of how long a report job wait ed in t he I nt elligence
(hh: mm: ss) S erver's queue bef ore t he report job was execut ed.

Met ric of how long, in seconds, a report job wait ed in t he

RP Queue Durat ion
I nt elligence S erver's queue bef ore t he report job was
(secs)
execut ed.

S chedule I ndicat es t he schedule t hat began t he report execut ion.

S chedule I ndicat or I ndicat es whet her t he report execut ion was scheduled.

S ecurit y Filt er I ndicat es t he securit y f ilt er used in t he report execut ion.

I ndicat es whet her a securit y f ilt er was used in t he report

S ecurit y Filt er I ndicat or
execut ion.

S QL E xecut ion I ndicat or I ndicat es t hat S QL was execut ed during report execut ion.

Templat e I ndicat es t he report t emplat e t hat was used.

User I ndicat es t he user t hat ran t he report .

Report Job SQL Pass Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her t he execut ion was ad hoc.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

Day I ndicat es t he day in which t he job was execut ed.

© 2019, M icr o St r at egy In c. 2082

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Hour I ndicat es t he hour in which t he report job was execut ed.

I ndicat es t he met adat a reposit ory st oring t he report or

Met adat a
document .

Minut e I ndicat es t he minut e in which t he report job was st art ed.

P roject I ndicat es t he project st oring t he report or document .

Report I ndicat es t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

I ndicat es t he S QL st at ement t hat was execut ed during t he

Report Job S QL P ass
S QL pass.

I ndicat es t he t ype of S QL st at ement t hat was execut ed in

Report Job S QL P ass
t his S QL pass. E xamples are S QL select , S QL insert ,
Type
S QL creat e and such.

RP E xecut ion Durat ion Met ric of t he durat ion of a report job's execut ion. I ncludes
(hh: mm: ss) dat abase execut ion t ime.

RP E xecut ion Durat ion Met ric of t he durat ion, in seconds, of a report job's
(secs) execut ion. I ncludes dat abase execut ion t ime.

RP Last E xecut ion Finish Met ric of t he f inish t imest amp when t he report job was
Timest amp last execut ed.

RP Last E xecut ion S t art Met ric of t he st art t imest amp when t he report job was last
Timest amp execut ed.

RP Number of DB Tables Met ric of how many dat abase t ables were accessed in a
A ccessed report job execut ion.

Met ric of how large, in byt es, t he S QL was f or a report

RP S QL S ize
job.

2083 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Report Job Steps Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion was ad hoc.

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

Day I ndicat es t he day in which t he job was execut ed.

Hour I ndicat es t he hour in which t he report job was execut ed.

Minut e I ndicat es t he minut e in which t he report job was st art ed.

Report I ndicat es t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

I ndicat es t he sequence number in t he series of execut ion

Report Job S t ep
st eps a report job passes t hrough in t he I nt elligence
S equence
S erver.

I ndicat es t he t ype of st ep f or a report job. E xamples are

S QL generat ion, S QL execut ion, A nalyt ical E ngine,
Report Job S t ep Type
Resolut ion S erver, element request , updat e I nt elligent
Cube, and so on.

RP A verage CP U
E xecut ion Durat ion per Met ric of t he average durat ion, in milliseconds, a report
Job (msecs) (I S _RE P _ job execut ion t akes in t he I nt elligence S erver CP U.
S TE P _FA CT)

RP A verage E lapsed Met ric of t he average dif f erence, in seconds, bet ween
Durat ion per Job (secs) st art t ime and f inish t ime of report job execut ions.
(I S _RE P _S TE P _FA CT) I ncludes t ime f or prompt responses.

RP A verage E xecut ion Met ric of t he average dif f erence, in seconds, bet ween

© 2019, M icr o St r at egy In c. 2084

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Durat ion per Job (secs) st art t ime and f inish t ime of report job execut ions.
(I S _RE P _S TE P _FA CT) I ncludes t ime f or prompt responses.

RP A verage Query
E ngine E xecut ion Met ric of t he average t ime, in seconds, t he Query E ngine
Durat ion per Job (secs) t akes t o process a report job.
(I S _RE P _S TE P _FA CT)

RP A verage Queue Met ric of t he average t ime report jobs wait ed in t he

Durat ion per Job (secs) I nt elligence S erver's queue bef ore t he report job was
(I S _RE P _S TE P _FA CT) execut ed.

Met ric of how long, in milliseconds, a report job execut ion

RP CP U Durat ion (msec)
t akes in t he I nt elligence S erver CP U.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E lapsed Durat ion
of report job execut ions. I ncludes t ime f or prompt
(hh: mm: ss)
responses.

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E lapsed Durat ion
and f inish t ime of report job execut ions. I ncludes t ime f or
(secs)
prompt responses.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E xecut ion Durat ion
of report job execut ions. I ncludes dat abase execut ion
(hh: mm: ss)
t ime.

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E xecut ion Durat ion
and f inish t ime of report job execut ions. I ncludes
(secs)
dat abase execut ion t ime.

RP Last E xecut ion Finish Met ric of t he f inish t imest amp when t he report job was
Timest amp last execut ed.

RP Last E xecut ion S t art Met ric of t he st art t imest amp when t he report job was last
Timest amp execut ed.

RP Number of Jobs (I S _
Met ric of how many report jobs were execut ed.
RE P _S TE P _FA CT)

2085 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP Query E ngine
Met ric of how long t he Query E ngine t ook t o execut e S QL
Durat ion (hh: mm: ss)
f or a report job.
(I S _RE P _S TE P _FA CT)

RP Query E ngine
Met ric of t he t ime, in seconds, t he Query E ngine t akes t o
Durat ion (secs) (I S _
execut e S QL f or a report job.
RE P _S TE P _FA CT)

RP Queue Durat ion Met ric of how long a report job wait ed in t he I nt elligence
(hh: mm: ss) S erver's queue bef ore t he report job was execut ed.

Met ric of how long, in seconds, a report job wait ed in t he

RP Queue Durat ion
I nt elligence S erver's queue bef ore t he report job was
(secs)
execut ed.

RP S QL E ngine Durat ion

Met ric of how long t he S QL E ngine t ook t o generat e S QL
(hh: mm: ss) (I S _RE P _
f or a report job.
S TE P _FA CT)

Report Job Tables/Columns Accessed Attributes and

Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion was ad hoc.

Column I ndicat es t he column t hat was accessed.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es t he day on which t he t able column was

Day
accessed.

I ndicat es t he t able in t he dat abase st oring t he column

DB Table
t hat was accessed.

© 2019, M icr o St r at egy In c. 2086

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

I ndicat es t he hour on which t he t able column was

Hour
accessed.

I ndicat es t he minut e on which t he t able column was

Minut e
accessed.

Report I ndicat es t he report t hat accessed t he t able column.

I ndicat es which execut ion of a report accessed t he t able

Report Job
column.

Met ric of how many report jobs accessed t he dat abase

RP Number of Jobs (I S _
column or t able. The Warehouse Tables A ccessed report
RE P _COL_FA CT)
uses t his met ric.

I ndicat es which t ype of S QL clause was used t o access

S QL Clause Type
t he t able column.

Schema Objects Attributes

Attrib u te
F u n ctio n
n ame

List s all at t ribut es in project s t hat are set up t o be monit ored by

A t t ribut e
E nt erprise Manager.

List s all at t ribut e f orms in project s t hat are set up t o be monit ored
A t t ribut e Form
by E nt erprise Manager.

List s all columns in project s t hat are set up t o be monit ored by

Column
E nt erprise Manager.

List s all physical t ables in t he dat a warehouse t hat are set up t o be

DB Table
monit ored by E nt erprise Manager.

List s all f act s in project s t hat are set up t o be monit ored by

Fact
E nt erprise Manager.

2087 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s all hierarchies in project s t hat are set up t o be monit ored by

Hierarchy
E nt erprise Manager

List s all logical t ables in project s t hat are set up t o be monit ored by
Table
E nt erprise Manager.

List s all t ransf ormat ions in project s t hat are set up t o be monit ored
Transf ormat ion
by E nt erprise Manager.

Server Machines Attributes

Attrib u te n ame F u n ctio n

List s all machines t hat have had users connect t o t he

Client Machine
I nt elligence S erver.

I nt elligence S erver
List s t he clust er of I nt elligence S ervers.
Clust er

I nt elligence S erver List s all machines t hat have logged st at ist ics as an
Machine I nt elligence S erver.

Web S erver Machine List s all machines used as web servers.

Session Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A vg. Connect ion Met ric of t he average t ime connect ions t o an I nt elligence
Durat ion (hh: mm: ss) S erver last .

A vg. Connect ion Met ric of t he average t ime, in seconds, connect ions t o an
Durat ion (secs) I nt elligence S erver last .

© 2019, M icr o St r at egy In c. 2088

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Connect ion Durat ion Met ric of t he t ime a connect ion t o an I nt elligence S erver
(hh: mm: ss) last s.

Connect ion Durat ion Met ric of t he t ime, in seconds, a connect ion t o an
(secs) I nt elligence S erver last s.

Connect ion S ource List s all connect ion sources t o I nt elligence S erver.

Met ric of how many sessions were connect ed t o an

Number of S essions
I nt elligence S erver. Usually report ed wit h a dat e and t ime
(Report Level)
at t ribut e.

Met ric of how many dist inct users were connect ed t o an

Number of Users Logged
I nt elligence S erver. Usually report ed wit h a dat e and t ime
I n (Report Level)
at t ribut e.

S ession I ndicat es a user connect ion t o an I nt elligence S erver.

All Indicators and Flags Attributes

Attrib u te n ame F u n ctio n

A d Hoc I ndicat or I ndicat es whet her an execut ion is ad hoc.

Cache Creat ion

I ndicat es whet her an execut ion has creat ed a cache.
I ndicat or

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Cancelled I ndicat or I ndicat es whet her an execut ion has been cancelled.

I ndicat es whet her a job was a document dat aset or a st and-

Child Job I ndicat or
alone report .

Conf igurat ion Object

I ndicat es whet her a conf igurat ion object exist s.
E xist s S t at us

Conf igurat ion List s all conf igurat ion paramet er t ypes.

2089 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

P aramet er V alue Type

Connect ion S ource List s all connect ion sources t o I nt elligence S erver.

Cont act Type List s t he execut ed cont act t ypes.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

Dat abase E rror I ndicat es whet her a report request f ailed because of a
I ndicat or dat abase error.

Dat amart I ndicat or I ndicat es whet her an execut ion creat ed a dat a mart .

I ndicat es whet her an execut ion encount ered a dat abase

DB E rror I ndicat or
error.

Delivery S t at us
I ndicat es whet her a delivery was successf ul.
I ndicat or

Delivery Type List s t he t ype of delivery.

Document Job S t at us
List s t he st at uses of document execut ions.
(Deprecat ed)

Document Job S t ep
List s all possible st eps of document job execut ion.
Type

I ndicat es t he t ype of a document or dossier, such as HTML

Document Type
document , Report S ervices document , or a dossier.

List s t he object f rom which a user drilled when a new report

Drill f rom Object
was run because of a drilling act ion.

Drill I ndicat or I ndicat es whet her an execut ion is a result of a drill.

List s t he object t o which a user drilled when a new report

Drill t o Object
was run because of a drilling act ion.

I ndicat es whet her an execut ion is a result of an element

E lement Load I ndicat or
load.

© 2019, M icr o St r at egy In c. 2090

Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

E rror I ndicat or I ndicat es whet her an execut ion encount ered an error.

E xecut ion Type I ndicat es how t he cont ent was request ed, such as User
I ndicat or E xecut ion, P re-Cached, A pplicat ion Recovery, and so on.

I ndicat es whet her a report was export ed and, if so,

E xport I ndicat or
indicat es it s f ormat .

Hierarchy Drilling I ndicat es whet her a hierarchy is used as a drill hierarchy.

List t he t ypes of manipulat ions t hat can be perf ormed on a

I nbox A ct ion Type
Hist ory List message.

I nt elligent Cube A ct ion

List s act ions perf ormed on or against int elligent cubes.
Type

I nt elligent Cube Type List s all int elligent cube t ypes.

List s all t he possible errors t hat can be ret urned during job
Job E rrorCode
execut ions.

Job P riorit y Map List s t he priorit ies of job execut ions.

E numerat es t he upper limit of t he priorit y ranges f or high,

Job P riorit y Number medium, and low priorit y jobs. Def ault values are 332, 666,
and 999.

Object Creat ion Dat e I ndicat es t he dat e on which an object was creat ed.

Object Creat ion I ndicat es t he week of t he year in which an object was

Week of year creat ed.

Object E xist s S t at us I ndicat es whet her an object exist s.

Object Hidden S t at us I ndicat es whet her an object is hidden.

Object Modif icat ion

I ndicat es t he dat e on which an object was last modif ied.
Dat e

Object Modif icat ion I ndicat es t he week of t he year in which an object was last
Week of year modif ied.

P rompt A nswer I ndicat es whet her a prompt answer was required f or t he job

2091 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

Required execut ion.

P rompt I ndicat or I ndicat es whet her a job execut ion was prompt ed.

Report Job S QL P ass List s t he t ypes of S QL passes t hat t he I nt elligence S erver

Type generat es.

Report Job S t at us
List s t he st at uses of report execut ions.
(Deprecat ed)

Report Job S t ep Type List s all possible st eps of report job execut ion.

I ndicat es t he t ype of a report , such as X DA , relat ional, and

Report Type
so on.

Report / Document I ndicat es whet her t he execut ion was a report or a

I ndicat or document .

S chedule I ndicat or I ndicat es whet her a job execut ion was scheduled.

S ecurit y Filt er I ndicat es whet her a securit y f ilt er was used in t he job
I ndicat or execut ion.

S QL Clause Type List s t he various S QL clause t ypes used by t he S QL E ngine.

S QL E xecut ion
I ndicat es whet her S QL was execut ed in t he job execut ion.
I ndicat or

Application Objects Attributes

Attrib u te
F u n ctio n
n ame

List s all consolidat ions in project s t hat are set up t o be monit ored
Consolidat ion
by E nt erprise Manager.

List s all cust om groups in project s t hat are set up t o be monit ored
Cust om Group
by E nt erprise Manager.

© 2019, M icr o St r at egy In c. 2092

Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s all document s in project s t hat are set up t o be monit ored by

Document
E nt erprise Manager.

List s all f ilt ers in project s t hat are set up t o be monit ored by
Filt er
E nt erprise Manager.

I nt elligent List s all int elligent cubes in project s t hat are set up t o be
Cube monit ored by E nt erprise Manager.

List s all met rics in project s t hat are set up t o be monit ored by
Met ric
E nt erprise Manager.

List s all prompt s in project s t hat are set up t o be monit ored by

P rompt
E nt erprise Manager.

List s all report s in project s t hat are set up t o be monit ored by

Report
E nt erprise Manager.

List s all securit y f ilt ers in project s t hat are set up t o be monit ored
S ecurit y Filt er
by E nt erprise Manager.

List s all t emplat es in project s t hat are set up t o be monit ored by

Templat e
E nt erprise Manager.

Configuration Objects Attributes

Attrib u te n ame F u n ctio n

A ddress List s all addresses t o which deliveries have been sent .

Conf igurat ion Object

List s t he owners of conf igurat ion object s.
Owner

Conf igurat ion

List s all conf igurat ion paramet ers.
P aramet er

Cont act List s all cont act s t o whom deliveries have been sent .

2093 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

DB Connect ion List s all dat abase connect ions.

DB I nst ance List s all dat abase inst ances.

Device List s all devices t o which deliveries have been sent .

E vent List s all event s being t racked.

Folder List s all f olders wit hin project s.

I nt elligence S erver
List s all I nt elligence S erver def init ions.
Def init ion

Met adat a List s all monit ored met adat a.

Owner List s t he owners of all object s.

P roject List s all project s.

S chedule List s all schedules.

S ubscript ion List s all execut ed t ransmissions.

Transmit t er List s all t ransmit t ers.

User List s all users being t racked.

User Group List s all user groups.

User Group (P arent ) List s all user groups t hat are parent s of ot her user groups.

Date and Time Attributes

Attrib u te
F u n ctio n
n ame

Calendar List s every calendar week, beginning wit h 2000-01-01, as an

Week int eger.

Day List s all days, beginning in 1990.

© 2019, M icr o St r at egy In c. 2094

Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s t he hours in a day. For example, 09 A M - 10 A M, 10 A M - 11

Hour
A M, and so on.

List s all t he minut es in an hour. For example, if t he hour specif ied is

Minut e 10 A M - 11 A M, list s minut es as 10. 30 A M - 10. 31 A M, 10. 32 A M -
10. 33 A M, and so on.

Mont h List s all mont hs, beginning wit h 2000.

Mont h of Y ear List s all mont hs in a specif ied year.

Quart er List s all quart ers.

Quart er of
List s all quart ers of t he year.
Y ear

List s all weeks in all years, beginning in 2000. Weeks in 2000 are
represent ed as a number ranging f rom 200001 t o 200053, weeks in
Week of Y ear
2001 are represent ed as a number ranging f rom 200101 t o 200153,
and so on.

Weekday List s all days of t he week.

Y ear List s all years.

Delivery Services Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

A ddress I ndicat es t he address t o which a delivery was sent .

A vg number of recipient s per Met ric of t he average number of recipient s in

subscript ion subscript ions.

A vg S ubscript ion E xecut ion Met ric of t he average amount of t ime subscript ions
Durat ion (hh: mm: ss) t ake t o execut e.

A vg S ubscript ion E xecut ion Met ric of t he average amount of t ime, in seconds,

2095 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Durat ion (secs) subscript ions t ake t o execut e.

Cont act I ndicat es all cont act s t o whom a delivery was sent .

Cont act Type I ndicat es t he execut ed cont act t ypes.

Day I ndicat es t he day on which t he delivery was sent .

Delivery S t at us I ndicat or I ndicat es whet her t he delivery was successf ul.

Delivery Type I ndicat es t he t ype of delivery.

I ndicat es t he t ype of device t o which t he delivery

Device
was sent .

Document I ndicat es t he document t hat was delivered.

Hour I ndicat es t he hour on which t he delivery was sent .

I ndicat es t he I nt elligence S erver machine t hat

I nt elligence S erver Machine
execut ed t he job.

Met adat a I ndicat es t he monit ored met adat a.

I ndicat es t he minut e on which t he delivery was

Minut e
sent .

Number of Dist inct Document Met ric of t he number of report services document
S ubscript ions subscript ions.

Met ric of t he number of recipient s t hat received

Number of Dist inct Recipient s
cont ent f rom a subscript ion.

Number of Dist inct Report

Met ric of t he number of report subscript ions.
S ubscript ions

Met ric of t he number of execut ed subscript ions.

Number of Dist inct
This does not ref lect t he number of subscript ions
S ubscript ions
in t he met adat a.

Met ric of t he number of subscript ions t hat

Number of E -mail S ubscript ions
delivered cont ent via e-mail.

© 2019, M icr o St r at egy In c. 2096

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Number of E rrored
Met ric of t he number of subscript ions t hat f ailed.
S ubscript ions

Met ric of t he number of execut ions of a

Number of E xecut ions
subscript ion.

Met ric of t he number of subscript ions t hat

Number of File S ubscript ions
delivered cont ent via f ile locat ion.

Number of Hist ory List Met ric of t he number of subscript ions t hat
S ubscript ions delivered cont ent via t he hist ory list .

Met ric of t he number of subscript ions t hat

Number of Mobile S ubscript ions
delivered cont ent via mobile.

Met ric of t he number of subscript ions t hat

Number of P rint S ubscript ions
delivered cont ent via a print er.

P roject List s t he project s.

Report List s t he report s in project s.

Report Job List s an execut ion of a report .

I ndicat es whet her t he execut ion was a report or a

Report / Document I ndicat or
document .

S chedule I ndicat es t he schedule t hat t riggered t he delivery.

I ndicat es t he subscript ion t hat t riggered t he

S ubscript ion
delivery.

S ubscript ion E xecut ion Met ric of t he sum of all execut ion t imes of a
Durat ion (hh: mm: ss) subscript ion.

S ubscript ion E xecut ion Durat ion Met ric of t he sum of all execut ion t imes of a
(secs) subscript ion (in seconds).

2097 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Document Job Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

I ndicat es t he day on which t he document job

Day
execut ed.

Document I ndicat es which document was execut ed.

Document Job I ndicat es an execut ion of a document .

Met ric of t he average dif f erence bet ween st art t ime

DP A verage E lapsed Durat ion
and f inish t ime (including t ime f or prompt
per Job (hh: mm: ss)
responses) of all document job execut ions.

Met ric of t he average dif f erence, in seconds,

DP A verage E lapsed Durat ion bet ween st art t ime and f inish t ime (including t ime
per Job (secs) f or prompt responses) of all document job
execut ions.

DP A verage E xecut ion Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions.

DP A verage E xecut ion Met ric of t he average durat ion of all document job
Durat ion per Job (hh: mm: ss) execut ions.

DP A verage Queue Durat ion Met ric of t he average durat ion of all document job
per Job (hh: mm: ss) execut ions wait ing in t he queue.

DP A verage Queue Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions wait ing in t he queue.

Met ric of t he dif f erence bet ween st art t ime and

DP E lapsed Durat ion
f inish t ime (including t ime f or prompt responses) of
(hh: mm: ss)
a document job.

Met ric of t he average dif f erence, in seconds,

DP E lapsed Durat ion (secs) bet ween st art t ime and f inish t ime (including t ime
f or prompt responses) of a document job.

DP E xecut ion Durat ion Met ric of t he durat ion of a document job's
(hh: mm: ss) execut ion.

© 2019, M icr o St r at egy In c. 2098

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Met ric of t he durat ion, in seconds, of a document

DP E xecut ion Durat ion (secs)
job's execut ion.

DP Number of Jobs (I S _DOC_ Met ric of t he number of document jobs t hat were
FA CT) execut ed.

DP Number of Jobs wit h Cache Met ric of t he number of document jobs t hat hit a
Hit cache.

DP Number of Jobs wit h E rror Met ric of t he number of document jobs t hat f ailed.

DP Number of Users who ran Met ric of t he number of users who ran document
Document s jobs.

DP P ercent age of Jobs wit h Met ric of t he percent age of document jobs t hat hit
Cache Hit a cache.

DP P ercent age of Jobs wit h Met ric of t he percent age of document jobs t hat
E rror f ailed.

Met ric of t he durat ion of all document job

DP Queue Durat ion (hh: mm: ss)
execut ions wait ing in t he queue.

Met ric of t he durat ion, in seconds, of all document

DP Queue Durat ion (secs)
job execut ions wait ing in t he queue.

Hour I ndicat es t he hour t he document job was execut ed.

I ndicat es t he I nt elligence S erver machine t hat

I nt elligence S erver Machine
execut ed t he document job.

Met adat a I ndicat es t he met adat a st oring t he document .

I ndicat es t he minut e t he document job was

Minut e
execut ed.

P roject I ndicat es t he project st oring t he document .

Report I ndicat es t he report s in t he document .

User I ndicat es t he user who ran t he document job.

2099 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Document Job Step Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

I ndicat es t he day on which t he document job

Day
execut ed.

Document I ndicat es which document was execut ed.

I ndicat es t he sequence number f or st eps in a

Document Job S t ep S equence
document job.

Document Job S t ep Type I ndicat es t he t ype of st ep f or a document job.

Met ric of t he average dif f erence bet ween st art t ime

DP A verage E lapsed Durat ion
and f inish t ime (including t ime f or prompt
per Job (hh: mm: ss)
responses) of all document job execut ions.

Met ric of t he average dif f erence, in seconds,

DP A verage E lapsed Durat ion bet ween st art t ime and f inish t ime (including t ime
per Job (secs) f or prompt responses) of all document job
execut ions.

DP A verage E xecut ion Met ric of t he average durat ion of all document job
Durat ion per Job (hh: mm: ss) execut ions.

DP A verage E xecut ion Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions.

DP A verage Queue Durat ion Met ric of t he average durat ion of all document job
per Job (hh: mm: ss) execut ions wait ing in t he queue.

DP A verage Queue Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions wait ing in t he queue.

Met ric of t he dif f erence bet ween st art t ime and

DP E lapsed Durat ion
f inish t ime (including t ime f or prompt responses) of
(hh: mm: ss)
a document job.

Met ric of t he average dif f erence, in seconds,

DP E lapsed Durat ion (secs) bet ween st art t ime and f inish t ime (including t ime
f or prompt responses) of a document job.

© 2019, M icr o St r at egy In c. 2100

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

DP E xecut ion Durat ion Met ric of t he durat ion of a document job's
(hh: mm: ss) execut ion.

Met ric of t he durat ion, in seconds, of a document

DP E xecut ion Durat ion (secs)
job's execut ion.

Met ric of t he durat ion of all document job

DP Queue Durat ion (hh: mm: ss)
execut ions wait ing in t he queue.

Met ric of t he durat ion, in seconds, of all document

DP Queue Durat ion (secs)
job execut ions wait ing in t he queue.

Hour I ndicat es t he hour t he document job was execut ed.

Met adat a I ndicat es t he met adat a st oring t he document .

I ndicat es t he minut e t he document job was

Minut e
execut ed.

P roject I ndicat es t he project st oring t he document .

Enterprise Manager Data Load Attributes

Attrib u te n ame F u n ctio n

Dat a Load Finish Displays t he t imest amp of t he end of t he dat a load process
Time f or t he project s t hat are being monit ored.

Dat a Load P roject List s all project s t hat are being monit ored.

List s t he t imest amp of t he st art of t he dat a load process f or

Dat a Load S t art Time
t he project s t hat are being monit ored.

A value of -1 indicat es t hat it is t he summary row in t he E M_

I S _LA S T_UP DA TE t able f or all project s in a dat a load. That
I t em I D summary row has inf ormat ion about how long t he dat a load
t ook. A value of 0 indicat es it is a row wit h project dat a load
det ails.

2101 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Inbox Message Actions Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Day I ndicat es t he day t he manipulat ion was st art ed

Document I ndicat es t he document included in t he message.

I ndicat es t he document job t hat request ed t he Hist ory

Document Job
List message manipulat ion.

HL Days S ince Last Met ric of t he number of days since any act ion was
A ct ion: A ny act ion perf ormed.

HL Days S ince Last Met ric of t he number of days since t he last request was
A ct ion: Request made f or t he cont ent s of a message.

Met ric of t he dat e and t ime of t he last act ion perf ormed
HL Last A ct ion Dat e: A ny
on a message such as read, delet ed, marked as read, and
A ct ion
so on.

HL Last A ct ion Dat e: Met ric of t he dat e and t ime of t he last request made f or
Request t he cont ent s of a message.

HL Number of A ct ions Met ric of t he number of act ions perf ormed on a message.

HL Number of A ct ions by Met ric of t he number of act ions by user perf ormed on a
User message.

HL Number of A ct ions Met ric of t he number of act ions on a message t hat

wit h E rrors result ed in an error.

HL Number of Document Met ric of t he number of document jobs t hat result wit h
Jobs messages.

HL Number of Messages Met ric of t he number of messages.

HL Number of Messages Met ric of t he number of messages t hat result ed in an

wit h E rrors error.

HL Number of Messages Met ric of t he number of request s f or t he cont ent s of a

Request ed message.

© 2019, M icr o St r at egy In c. 2102

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

HL Number of Report Met ric of t he number of report jobs t hat result f rom
Jobs messages.

I ndicat es t he hour t he manipulat ion was st art ed on a

Hour
Hist ory List message.

I ndicat es t he manipulat ion t hat was perf ormed on a

I nbox A ct ion
Hist ory List message.

I ndicat es t he t ype of manipulat ion t hat was perf ormed on

I nbox A ct ion Type
a Hist ory List message.

I nbox Message I ndicat es t he message in t he Hist ory List .

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he message.

Met adat a I ndicat es t he met adat a st oring t he message.

Minut e I ndicat es t he minut e t he manipulat ion was st art ed.

P roject I ndicat es t he project st oring t he message.

Report I ndicat es t he report included in t he message.

I ndicat es t he job I D of t he report included in t he

Report Job
message.

I ndicat es t he user who manipulat ed t he Hist ory List

User
message.

Mobile Client Attributes

Attrib u te n ame F u n ctio n

I ndicat es whet her a cache was hit during t he execut ion

Cache Hit I ndicat or
and, if so, what t ype of cache hit .

2103 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

Day I ndicat es t he day t he act ion st art ed.

Document I dent if ies t he document used in t he request .

I ndicat es t he t ype of report or document t hat init iat ed t he

E xecut ion Type I ndicat or
execut ion.

I ndicat es t he locat ion, in lat it ude and longit ude f orm, of

Geocode
t he user.

Hour I ndicat es t he hour t he act ion st art ed.

I nt elligence S erver
I ndicat es t he I nt elligence S erver processing t he request .
Machine

I ndicat es t he met adat a reposit ory st oring t he report or

Met adat a
document .

Minut e I ndicat es t he minut e t he act ion st art ed.

Mobile Device
I ndicat es t he unique I nst allat ion I D of t he mobile app.
I nst allat ion I D

I ndicat es t he t ype of mobile device t he app is inst alled

Mobile Device Type
on, such as I P A D2, DROI D, and so on.

I ndicat es t he version of t he MicroS t rat egy app making t he

MS TR A pp V ersion
request .

I ndicat es t he t ype of net work used, such as 3G, WI FI ,

Net work Type
LTE , and so on.

I ndicat es t he operat ing syst em of t he mobile device

Operat ing S yst em
making t he request .

Operat ing S yst em I ndicat es t he operat ing syst em version of t he mobile

V ersion device making t he request .

P roject I ndicat es t he project used t o init iat e t he request .

User I ndicat es t he user t hat init iat ed t he request .

© 2019, M icr o St r at egy In c. 2104

Syst em Ad m in ist r at io n Gu id e

OLAP Services Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Day I ndicat es t he day t he act ion was st art ed.

Hour I ndicat es t he hour t he act ion was st art ed.

I nt elligent Cube I ndicat es t he I nt elligent Cube t hat was used.

I nt elligent Cube A ct ion Met ric of t he durat ion, in seconds, f or an act ion t hat was
Durat ion (secs) perf ormed on t he I nt ellgent Cube.

I nt elligent Cube A ct ion I ndicat es t he t ype of act ion t aken on t he I nt elligent Cube
Type such as cube publish, cube view hit , and so on.

I ndicat es t he I nt elligent Cube inst ance in memory t hat

I nt elligent Cube I nst ance
was used f or t he act ion.

I nt elligent Cube S ize I f t he I nt elligent Cube is published or ref reshed, indicat es

(K B ) t he size, in K B , of t he I nt elligent Cube.

I ndicat es t he t ype of I nt elligent Cube used, such as

I nt elligent Cube Type working set report , Report S ervices B ase report , OLA P
Cube report , and so on.

Minut e I ndicat es t he minut e on which t he act ion was st art ed.

Met ric of how many jobs f rom report s not based on

Number of Dynamically
I nt elligent Cubes but select ed by t he engine t o go against
S ourced Report Jobs
an I nt elligent Cube because t he object s on t he report
against I nt elligent Cubes
mat ched what is on t he I nt elligent Cube.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube P ublishes published.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube Ref reshes ref reshed.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube Republishes republished.

2105 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Number of Jobs wit h Met ric of how many job execut ions used an I nt elligent
I nt elligent Cube Hit Cube.

Met ric of how many users execut ed a report or document

Number of Users hit t ing
t hat used an I nt elligent Cube. That is, t he number of
I nt elligent Cubes
users using OLA P S ervices.

Number of V iew Report Met ric of how many act ions were t he result of a V iew
Jobs Report .

Report I ndicat es t he report t hat hit t he I nt elligent Cube.

Performance Monitoring Attributes

Attrib u te n ame F u n ctio n

I ndicat es cat egory of t he count er, such as memory,

Count er Cat egory
MicroS t rat egy server jobs, or MicroS t rat egy server users.

I ndicat es t he inst ance I D of t he count er, f or MicroS t rat egy

Count er I nst ance
use.

Day I ndicat es t he day t he act ion was st art ed.

Hour I ndicat es t he hour t he act ion was st art ed.

Minut e I ndicat es t he minut e t he act ion was st art ed.

P erf ormance Monit or I ndicat es t he name of t he perf ormance count er and it s value
Count er t ype.

© 2019, M icr o St r at egy In c. 2106

Syst em Ad m in ist r at io n Gu id e

Prompt Answers Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Connect ion S ource Indicates the connection source to Intelligence Server.

Count of P rompt
Metric of how many prompts were answered.
A nswers

Day I ndicat es t he day t he prompt was answered.

Document I ndicat es t he document t hat used t he prompt .

Hour I ndicat es t he hour t he prompt was answered.

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he job.

Met adat a I ndicat es t he met adat a reposit ory st oring t he prompt .

Minut e I ndicat es t he minut e t he prompt was answered.

P roject I ndicat es t he project st oring t he prompt .

P rompt I ndicat es t he prompt t hat was used.

P rompt A nswer I ndicat es t he answers f or t he prompt in various inst ances.

P rompt A nswer Required I ndicat es whet her an answer t o t he prompt was required.

I ndicat es t he answer of an inst ance of a prompt in a

P rompt I nst ance A nswer
report job.

P rompt Locat ion Indicates the ID of the location in which a prompt is stored.

Indicates the type of the object in which the prompt is stored, such
P rompt Locat ion Type
as filter, template, attribute, and so on.

I ndicat es t he t it le of t he prompt (t he t it le t he user sees

P rompt Tit le
when present ed during job execut ion).

I ndicat es what t ype of prompt was used, such as dat e,

P rompt Type
double, element s, and so on.

2107 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Report I ndicat es t he report t hat used t he prompt .

Report Job I ndicat es t he report job t hat used t he prompt .

RP Number of Jobs (I S _
Met ric of how many jobs involved a prompt .
P R_A NS _FA CT)

RP Number of Jobs
Met ric of how many report jobs had a specif ied prompt
Cont aining P rompt
answer value.
A nswer V alue

RP Number of Jobs Not

Met ric of how many report jobs did not have a specif ied
Cont aining P rompt
prompt answer value.
A nswer V alue

RP Number of Jobs wit h Met ric of how many report jobs had a prompt t hat was not
Unanswered P rompt s answered.

Report Job Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion is ad hoc.

Cache Creat ion I ndicat or I ndicat es whet her an execut ion has creat ed a cache.

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Cancelled I ndicat or I ndicat es whet her an execut ion has been canceled.

I ndicat es whet her a job was a document dat aset or a

Child Job I ndicat or
st andalone report .

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

© 2019, M icr o St r at egy In c. 2108

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

I ndicat es whet her a report request f ailed because of a

Dat abase E rror I ndicat or
dat abase error.

Dat amart I ndicat or I ndicat es whet her an execut ion creat ed a dat a mart .

Day I ndicat es t he day on which t he report was execut ed.

I ndicat es t he dat abase inst ance on which t he report was

DB I nst ance
execut ed.

Drill I ndicat or I ndicat es whet her an execut ion is a result of a drill.

I ndicat es whet her an execut ion is a result of an element

E lement Load I ndicat or
load.

E rror I ndicat or I ndicat es whet her an execut ion encount ered an error.

I ndicat es whet her a report was export ed and, if so,

E xport I ndicat or
indicat es it s f ormat .

Filt er I ndicat es t he f ilt er used on t he report .

Hour I ndicat es t he hour on which t he report was execut ed.

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he report .

Met adat a I ndicat es t he met adat a reposit ory t hat st ores t he report .

I ndicat es t he minut e on which t he report execut ion was

Minut e
st art ed.

Number of Jobs wit h Met ric of how many job execut ions used an I nt elligent
I nt elligent Cube Hit Cube.

P roject I ndicat es t he met adat a reposit ory t hat st ores t he report .

P rompt I ndicat or I ndicat es whet her t he report execut ion was prompt ed.

Report I ndicat es t he I D of t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

2109 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP A verage E lapsed
Met ric of t he average dif f erence bet ween st art t ime and
Durat ion per Job
f inish t ime (including t ime f or prompt responses) of all
(hh: mm: ss) (I S _RE P _
report job execut ions.
FA CT)

RP A verage E lapsed Met ric of t he average dif f erence bet ween st art t ime and
Durat ion per Job (secs) f inish t ime (including t ime f or prompt responses) of all
(I S _RE P _FA CT) report job execut ions.

RP A verage E xecut ion

Durat ion per Job Met ric of t he average durat ion of all report job execut ions.
(hh: mm: ss) (I S _RE P _ I ncludes t ime in queue and execut ion f or a report job.
FA CT)

RP A verage E xecut ion Met ric of t he average durat ion, in seconds, of all report
Durat ion per Job (secs) job execut ions. I ncludes t ime in queue and execut ion f or
(I S _RE P _FA CT) a report job.

RP A verage P rompt
Met ric of t he average t ime users t ake t o answer t he set of
A nswer Time per Job
prompt s in all report jobs.
(hh: mm: ss)

RP A verage P rompt
Met ric of t he average t ime, in seconds, users t ake t o
A nswer Time per Job
answer t he set of prompt s in all report jobs.
(secs)

RP A verage Queue
Met ric of t he average t ime report jobs wait ed in t he
Durat ion per Job
I nt elligence S erver's queue bef ore t he report job was
(hh: mm: ss) (I S _RE P _
execut ed.
FA CT)

RP A verage Queue Met ric of t he average t ime, in seconds, report jobs wait ed
Durat ion per Job (secs) in t he I nt elligence S erver's queue bef ore t he report job
(I S _RE P _FA CT) was execut ed.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E lapsed Durat ion
of a report job. I ncludes t ime f or prompt responses, in
(hh: mm: ss)
queue, and execut ion.

© 2019, M icr o St r at egy In c. 2110

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E lapsed Durat ion
and f inish t ime of a report job. I ncludes t ime f or prompt
(secs)
responses, in queue, and execut ion.

RP E xecut ion Durat ion Met ric of t he durat ion of a report job's execut ion. I ncludes
(hh: mm: ss) dat abase execut ion t ime.

RP E xecut ion Durat ion Met ric of t he durat ion, in seconds, of a report job's
(secs) execut ion. I ncludes dat abase execut ion t ime.

RP Number of A d Hoc Met ric of how many report jobs result ed f rom an ad hoc
Jobs report creat ion.

RP Number of Cancelled
Met ric of how many job execut ions were canceled.
Jobs

Met ric of how many job execut ions result ed f rom a drill
RP Number of Drill Jobs
act ion.

RP Number of Jobs (I S _
Met ric of how many report jobs were execut ed.
RE P _FA CT)

RP Number of Jobs Met ric of how many report jobs were execut ed against t he
hit t ing Dat abase dat abase.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
Cache Creat ion result in creat ing a server cache.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
Cache Hit hit a server cache.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
E lement Loading result f rom loading addit ional at t ribut e element s.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
Cache Creat ion result ed in a server cache being creat ed.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat hit a
Cache Hit server cache.

2111 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
Dat amart Creat ion result ed in a dat a mart being creat ed.

RP Number of Jobs wit h Met ric of how many report jobs f ailed because of a
DB E rror dat abase error.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
E lement Loading result ed f rom loading addit ional at t ribut e element s.

RP Number of Jobs wit h

Met ric of how many report jobs f ailed because of an error.
E rror

RP Number of Jobs wit h Met ric of how many report job execut ions used an
I nt elligent Cube Hit I nt elligent Cube.

RP Number of Jobs wit h Met ric of how many report job execut ions used a securit y
S ecurit y Filt er f ilt er.

RP Number of Jobs wit h

Met ric of how many report jobs execut ed S QL st at ement s.
S QL E xecut ion

RP number of Met ric of how many report job execut ions were run
Narrowcast S erver jobs t hrough MicroS t rat egy Narrowcast S erver.

RP Number of P rompt ed Met ric of how many report job execut ions included a
Jobs prompt .

RP Number of Report
Met ric of how many report jobs execut ed as a result of a
Jobs f rom Document
document execut ion.
E xecut ion

RP Number of Result Met ric of how many result rows were ret urned f rom a
Rows report execut ion.

RP Number of
Met ric of how many report jobs were scheduled.
S cheduled Jobs

RP Number of Users who

Met ric of how many dist inct users ran report jobs.
ran report s

© 2019, M icr o St r at egy In c. 2112

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP P rompt A nswer Met ric of t he how long users t ake t o answer t he set of
Durat ion (hh: mm: ss) prompt s in report jobs.

RP P rompt A nswer Met ric of t he how long, in seconds, users t ake t o answer
Durat ion (secs) t he set of prompt s in report jobs.

RP Queue Durat ion Met ric of how long a report job wait ed in t he I nt elligence
(hh: mm: ss) S erver's queue bef ore t he report job was execut ed.

Met ric of how long, in seconds, a report job wait ed in t he

RP Queue Durat ion
I nt elligence S erver's queue bef ore t he report job was
(secs)
execut ed.

S chedule I ndicat es t he schedule t hat began t he report execut ion.

S chedule I ndicat or I ndicat es whet her t he report execut ion was scheduled.

S ecurit y Filt er I ndicat es t he securit y f ilt er used in t he report execut ion.

I ndicat es whet her a securit y f ilt er was used in t he report

S ecurit y Filt er I ndicat or
execut ion.

S QL E xecut ion I ndicat or I ndicat es t hat S QL was execut ed during report execut ion.

Templat e I ndicat es t he report t emplat e t hat was used.

User I ndicat es t he user t hat ran t he report .

Report Job SQL Pass Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her t he execut ion was ad hoc.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

Day I ndicat es t he day in which t he job was execut ed.

2113 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Hour I ndicat es t he hour in which t he report job was execut ed.

I ndicat es t he met adat a reposit ory st oring t he report or

Met adat a
document .

Minut e I ndicat es t he minut e in which t he report job was st art ed.

P roject I ndicat es t he project st oring t he report or document .

Report I ndicat es t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

I ndicat es t he S QL st at ement t hat was execut ed during t he

Report Job S QL P ass
S QL pass.

I ndicat es t he t ype of S QL st at ement t hat was execut ed in

Report Job S QL P ass
t his S QL pass. E xamples are S QL select , S QL insert ,
Type
S QL creat e and such.

RP E xecut ion Durat ion Met ric of t he durat ion of a report job's execut ion. I ncludes
(hh: mm: ss) dat abase execut ion t ime.

RP E xecut ion Durat ion Met ric of t he durat ion, in seconds, of a report job's
(secs) execut ion. I ncludes dat abase execut ion t ime.

RP Last E xecut ion Finish Met ric of t he f inish t imest amp when t he report job was
Timest amp last execut ed.

RP Last E xecut ion S t art Met ric of t he st art t imest amp when t he report job was last
Timest amp execut ed.

RP Number of DB Tables Met ric of how many dat abase t ables were accessed in a
A ccessed report job execut ion.

Met ric of how large, in byt es, t he S QL was f or a report

RP S QL S ize
job.

© 2019, M icr o St r at egy In c. 2114

Syst em Ad m in ist r at io n Gu id e

Report Job Steps Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion was ad hoc.

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

Day I ndicat es t he day in which t he job was execut ed.

Hour I ndicat es t he hour in which t he report job was execut ed.

Minut e I ndicat es t he minut e in which t he report job was st art ed.

Report I ndicat es t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

I ndicat es t he sequence number in t he series of execut ion

Report Job S t ep
st eps a report job passes t hrough in t he I nt elligence
S equence
S erver.

I ndicat es t he t ype of st ep f or a report job. E xamples are

S QL generat ion, S QL execut ion, A nalyt ical E ngine,
Report Job S t ep Type
Resolut ion S erver, element request , updat e I nt elligent
Cube, and so on.

RP A verage CP U
E xecut ion Durat ion per Met ric of t he average durat ion, in milliseconds, a report
Job (msecs) (I S _RE P _ job execut ion t akes in t he I nt elligence S erver CP U.
S TE P _FA CT)

RP A verage E lapsed Met ric of t he average dif f erence, in seconds, bet ween
Durat ion per Job (secs) st art t ime and f inish t ime of report job execut ions.
(I S _RE P _S TE P _FA CT) I ncludes t ime f or prompt responses.

RP A verage E xecut ion Met ric of t he average dif f erence, in seconds, bet ween

2115 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Durat ion per Job (secs) st art t ime and f inish t ime of report job execut ions.
(I S _RE P _S TE P _FA CT) I ncludes t ime f or prompt responses.

RP A verage Query
E ngine E xecut ion Met ric of t he average t ime, in seconds, t he Query E ngine
Durat ion per Job (secs) t akes t o process a report job.
(I S _RE P _S TE P _FA CT)

RP A verage Queue Met ric of t he average t ime report jobs wait ed in t he

Durat ion per Job (secs) I nt elligence S erver's queue bef ore t he report job was
(I S _RE P _S TE P _FA CT) execut ed.

Met ric of how long, in milliseconds, a report job execut ion

RP CP U Durat ion (msec)
t akes in t he I nt elligence S erver CP U.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E lapsed Durat ion
of report job execut ions. I ncludes t ime f or prompt
(hh: mm: ss)
responses.

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E lapsed Durat ion
and f inish t ime of report job execut ions. I ncludes t ime f or
(secs)
prompt responses.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E xecut ion Durat ion
of report job execut ions. I ncludes dat abase execut ion
(hh: mm: ss)
t ime.

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E xecut ion Durat ion
and f inish t ime of report job execut ions. I ncludes
(secs)
dat abase execut ion t ime.

RP Last E xecut ion Finish Met ric of t he f inish t imest amp when t he report job was
Timest amp last execut ed.

RP Last E xecut ion S t art Met ric of t he st art t imest amp when t he report job was last
Timest amp execut ed.

RP Number of Jobs (I S _
Met ric of how many report jobs were execut ed.
RE P _S TE P _FA CT)

© 2019, M icr o St r at egy In c. 2116

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP Query E ngine
Met ric of how long t he Query E ngine t ook t o execut e S QL
Durat ion (hh: mm: ss)
f or a report job.
(I S _RE P _S TE P _FA CT)

RP Query E ngine
Met ric of t he t ime, in seconds, t he Query E ngine t akes t o
Durat ion (secs) (I S _
execut e S QL f or a report job.
RE P _S TE P _FA CT)

RP Queue Durat ion Met ric of how long a report job wait ed in t he I nt elligence
(hh: mm: ss) S erver's queue bef ore t he report job was execut ed.

Met ric of how long, in seconds, a report job wait ed in t he

RP Queue Durat ion
I nt elligence S erver's queue bef ore t he report job was
(secs)
execut ed.

RP S QL E ngine Durat ion

Met ric of how long t he S QL E ngine t ook t o generat e S QL
(hh: mm: ss) (I S _RE P _
f or a report job.
S TE P _FA CT)

Report Job Tables/Columns Accessed Attributes and

Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion was ad hoc.

Column I ndicat es t he column t hat was accessed.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es t he day on which t he t able column was

Day
accessed.

I ndicat es t he t able in t he dat abase st oring t he column

DB Table
t hat was accessed.

2117 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

I ndicat es t he hour on which t he t able column was

Hour
accessed.

I ndicat es t he minut e on which t he t able column was

Minut e
accessed.

Report I ndicat es t he report t hat accessed t he t able column.

I ndicat es which execut ion of a report accessed t he t able

Report Job
column.

Met ric of how many report jobs accessed t he dat abase

RP Number of Jobs (I S _
column or t able. The Warehouse Tables A ccessed report
RE P _COL_FA CT)
uses t his met ric.

I ndicat es which t ype of S QL clause was used t o access

S QL Clause Type
t he t able column.

Schema Objects Attributes

Attrib u te
F u n ctio n
n ame

List s all at t ribut es in project s t hat are set up t o be monit ored by

A t t ribut e
E nt erprise Manager.

List s all at t ribut e f orms in project s t hat are set up t o be monit ored
A t t ribut e Form
by E nt erprise Manager.

List s all columns in project s t hat are set up t o be monit ored by

Column
E nt erprise Manager.

List s all physical t ables in t he dat a warehouse t hat are set up t o be

DB Table
monit ored by E nt erprise Manager.

List s all f act s in project s t hat are set up t o be monit ored by

Fact
E nt erprise Manager.

© 2019, M icr o St r at egy In c. 2118

Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s all hierarchies in project s t hat are set up t o be monit ored by

Hierarchy
E nt erprise Manager

List s all logical t ables in project s t hat are set up t o be monit ored by
Table
E nt erprise Manager.

List s all t ransf ormat ions in project s t hat are set up t o be monit ored
Transf ormat ion
by E nt erprise Manager.

Server Machines Attributes

Attrib u te n ame F u n ctio n

List s all machines t hat have had users connect t o t he

Client Machine
I nt elligence S erver.

I nt elligence S erver
List s t he clust er of I nt elligence S ervers.
Clust er

I nt elligence S erver List s all machines t hat have logged st at ist ics as an
Machine I nt elligence S erver.

Web S erver Machine List s all machines used as web servers.

Session Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A vg. Connect ion Met ric of t he average t ime connect ions t o an I nt elligence
Durat ion (hh: mm: ss) S erver last .

A vg. Connect ion Met ric of t he average t ime, in seconds, connect ions t o an
Durat ion (secs) I nt elligence S erver last .

2119 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Connect ion Durat ion Met ric of t he t ime a connect ion t o an I nt elligence S erver
(hh: mm: ss) last s.

Connect ion Durat ion Met ric of t he t ime, in seconds, a connect ion t o an
(secs) I nt elligence S erver last s.

Connect ion S ource List s all connect ion sources t o I nt elligence S erver.

Met ric of how many sessions were connect ed t o an

Number of S essions
I nt elligence S erver. Usually report ed wit h a dat e and t ime
(Report Level)
at t ribut e.

Met ric of how many dist inct users were connect ed t o an

Number of Users Logged
I nt elligence S erver. Usually report ed wit h a dat e and t ime
I n (Report Level)
at t ribut e.

S ession I ndicat es a user connect ion t o an I nt elligence S erver.

All Indicators and Flags Attributes

Attrib u te n ame F u n ctio n

A d Hoc I ndicat or I ndicat es whet her an execut ion is ad hoc.

Cache Creat ion

I ndicat es whet her an execut ion has creat ed a cache.
I ndicat or

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Cancelled I ndicat or I ndicat es whet her an execut ion has been cancelled.

I ndicat es whet her a job was a document dat aset or a st and-

Child Job I ndicat or
alone report .

Conf igurat ion Object

I ndicat es whet her a conf igurat ion object exist s.
E xist s S t at us

Conf igurat ion List s all conf igurat ion paramet er t ypes.

© 2019, M icr o St r at egy In c. 2120

Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

P aramet er V alue Type

Connect ion S ource List s all connect ion sources t o I nt elligence S erver.

Cont act Type List s t he execut ed cont act t ypes.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

Dat abase E rror I ndicat es whet her a report request f ailed because of a
I ndicat or dat abase error.

Dat amart I ndicat or I ndicat es whet her an execut ion creat ed a dat a mart .

I ndicat es whet her an execut ion encount ered a dat abase

DB E rror I ndicat or
error.

Delivery S t at us
I ndicat es whet her a delivery was successf ul.
I ndicat or

Delivery Type List s t he t ype of delivery.

Document Job S t at us
List s t he st at uses of document execut ions.
(Deprecat ed)

Document Job S t ep
List s all possible st eps of document job execut ion.
Type

I ndicat es t he t ype of a document or dossier, such as HTML

Document Type
document , Report S ervices document , or a dossier.

List s t he object f rom which a user drilled when a new report

Drill f rom Object
was run because of a drilling act ion.

Drill I ndicat or I ndicat es whet her an execut ion is a result of a drill.

List s t he object t o which a user drilled when a new report

Drill t o Object
was run because of a drilling act ion.

I ndicat es whet her an execut ion is a result of an element

E lement Load I ndicat or
load.

2121 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

E rror I ndicat or I ndicat es whet her an execut ion encount ered an error.

E xecut ion Type I ndicat es how t he cont ent was request ed, such as User
I ndicat or E xecut ion, P re-Cached, A pplicat ion Recovery, and so on.

I ndicat es whet her a report was export ed and, if so,

E xport I ndicat or
indicat es it s f ormat .

Hierarchy Drilling I ndicat es whet her a hierarchy is used as a drill hierarchy.

List t he t ypes of manipulat ions t hat can be perf ormed on a

I nbox A ct ion Type
Hist ory List message.

I nt elligent Cube A ct ion

List s act ions perf ormed on or against int elligent cubes.
Type

I nt elligent Cube Type List s all int elligent cube t ypes.

List s all t he possible errors t hat can be ret urned during job
Job E rrorCode
execut ions.

Job P riorit y Map List s t he priorit ies of job execut ions.

E numerat es t he upper limit of t he priorit y ranges f or high,

Job P riorit y Number medium, and low priorit y jobs. Def ault values are 332, 666,
and 999.

Object Creat ion Dat e I ndicat es t he dat e on which an object was creat ed.

Object Creat ion I ndicat es t he week of t he year in which an object was

Week of year creat ed.

Object E xist s S t at us I ndicat es whet her an object exist s.

Object Hidden S t at us I ndicat es whet her an object is hidden.

Object Modif icat ion

I ndicat es t he dat e on which an object was last modif ied.
Dat e

Object Modif icat ion I ndicat es t he week of t he year in which an object was last
Week of year modif ied.

P rompt A nswer I ndicat es whet her a prompt answer was required f or t he job

© 2019, M icr o St r at egy In c. 2122

Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

Required execut ion.

P rompt I ndicat or I ndicat es whet her a job execut ion was prompt ed.

Report Job S QL P ass List s t he t ypes of S QL passes t hat t he I nt elligence S erver

Type generat es.

Report Job S t at us
List s t he st at uses of report execut ions.
(Deprecat ed)

Report Job S t ep Type List s all possible st eps of report job execut ion.

I ndicat es t he t ype of a report , such as X DA , relat ional, and

Report Type
so on.

Report / Document I ndicat es whet her t he execut ion was a report or a

I ndicat or document .

S chedule I ndicat or I ndicat es whet her a job execut ion was scheduled.

S ecurit y Filt er I ndicat es whet her a securit y f ilt er was used in t he job
I ndicat or execut ion.

S QL Clause Type List s t he various S QL clause t ypes used by t he S QL E ngine.

S QL E xecut ion
I ndicat es whet her S QL was execut ed in t he job execut ion.
I ndicat or

Application Objects Attributes

Attrib u te
F u n ctio n
n ame

List s all consolidat ions in project s t hat are set up t o be monit ored
Consolidat ion
by E nt erprise Manager.

List s all cust om groups in project s t hat are set up t o be monit ored
Cust om Group
by E nt erprise Manager.

2123 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s all document s in project s t hat are set up t o be monit ored by

Document
E nt erprise Manager.

List s all f ilt ers in project s t hat are set up t o be monit ored by
Filt er
E nt erprise Manager.

I nt elligent List s all int elligent cubes in project s t hat are set up t o be
Cube monit ored by E nt erprise Manager.

List s all met rics in project s t hat are set up t o be monit ored by
Met ric
E nt erprise Manager.

List s all prompt s in project s t hat are set up t o be monit ored by

P rompt
E nt erprise Manager.

List s all report s in project s t hat are set up t o be monit ored by

Report
E nt erprise Manager.

List s all securit y f ilt ers in project s t hat are set up t o be monit ored
S ecurit y Filt er
by E nt erprise Manager.

List s all t emplat es in project s t hat are set up t o be monit ored by

Templat e
E nt erprise Manager.

Configuration Objects Attributes

Attrib u te n ame F u n ctio n

A ddress List s all addresses t o which deliveries have been sent .

Conf igurat ion Object

List s t he owners of conf igurat ion object s.
Owner

Conf igurat ion

List s all conf igurat ion paramet ers.
P aramet er

Cont act List s all cont act s t o whom deliveries have been sent .

© 2019, M icr o St r at egy In c. 2124

Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

DB Connect ion List s all dat abase connect ions.

DB I nst ance List s all dat abase inst ances.

Device List s all devices t o which deliveries have been sent .

E vent List s all event s being t racked.

Folder List s all f olders wit hin project s.

I nt elligence S erver
List s all I nt elligence S erver def init ions.
Def init ion

Met adat a List s all monit ored met adat a.

Owner List s t he owners of all object s.

P roject List s all project s.

S chedule List s all schedules.

S ubscript ion List s all execut ed t ransmissions.

Transmit t er List s all t ransmit t ers.

User List s all users being t racked.

User Group List s all user groups.

User Group (P arent ) List s all user groups t hat are parent s of ot her user groups.

Date and Time Attributes

Attrib u te
F u n ctio n
n ame

Calendar List s every calendar week, beginning wit h 2000-01-01, as an

Week int eger.

Day List s all days, beginning in 1990.

2125 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s t he hours in a day. For example, 09 A M - 10 A M, 10 A M - 11

Hour
A M, and so on.

List s all t he minut es in an hour. For example, if t he hour specif ied is

Minut e 10 A M - 11 A M, list s minut es as 10. 30 A M - 10. 31 A M, 10. 32 A M -
10. 33 A M, and so on.

Mont h List s all mont hs, beginning wit h 2000.

Mont h of Y ear List s all mont hs in a specif ied year.

Quart er List s all quart ers.

Quart er of
List s all quart ers of t he year.
Y ear

List s all weeks in all years, beginning in 2000. Weeks in 2000 are
represent ed as a number ranging f rom 200001 t o 200053, weeks in
Week of Y ear
2001 are represent ed as a number ranging f rom 200101 t o 200153,
and so on.

Weekday List s all days of t he week.

Y ear List s all years.

Delivery Services Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

A ddress I ndicat es t he address t o which a delivery was sent .

A vg number of recipient s per Met ric of t he average number of recipient s in

subscript ion subscript ions.

A vg S ubscript ion E xecut ion Met ric of t he average amount of t ime subscript ions
Durat ion (hh: mm: ss) t ake t o execut e.

A vg S ubscript ion E xecut ion Met ric of t he average amount of t ime, in seconds,

© 2019, M icr o St r at egy In c. 2126

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Durat ion (secs) subscript ions t ake t o execut e.

Cont act I ndicat es all cont act s t o whom a delivery was sent .

Cont act Type I ndicat es t he execut ed cont act t ypes.

Day I ndicat es t he day on which t he delivery was sent .

Delivery S t at us I ndicat or I ndicat es whet her t he delivery was successf ul.

Delivery Type I ndicat es t he t ype of delivery.

I ndicat es t he t ype of device t o which t he delivery

Device
was sent .

Document I ndicat es t he document t hat was delivered.

Hour I ndicat es t he hour on which t he delivery was sent .

I ndicat es t he I nt elligence S erver machine t hat

I nt elligence S erver Machine
execut ed t he job.

Met adat a I ndicat es t he monit ored met adat a.

I ndicat es t he minut e on which t he delivery was

Minut e
sent .

Number of Dist inct Document Met ric of t he number of report services document
S ubscript ions subscript ions.

Met ric of t he number of recipient s t hat received

Number of Dist inct Recipient s
cont ent f rom a subscript ion.

Number of Dist inct Report

Met ric of t he number of report subscript ions.
S ubscript ions

Met ric of t he number of execut ed subscript ions.

Number of Dist inct
This does not ref lect t he number of subscript ions
S ubscript ions
in t he met adat a.

Met ric of t he number of subscript ions t hat

Number of E -mail S ubscript ions
delivered cont ent via e-mail.

2127 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Number of E rrored
Met ric of t he number of subscript ions t hat f ailed.
S ubscript ions

Met ric of t he number of execut ions of a

Number of E xecut ions
subscript ion.

Met ric of t he number of subscript ions t hat

Number of File S ubscript ions
delivered cont ent via f ile locat ion.

Number of Hist ory List Met ric of t he number of subscript ions t hat
S ubscript ions delivered cont ent via t he hist ory list .

Met ric of t he number of subscript ions t hat

Number of Mobile S ubscript ions
delivered cont ent via mobile.

Met ric of t he number of subscript ions t hat

Number of P rint S ubscript ions
delivered cont ent via a print er.

P roject List s t he project s.

Report List s t he report s in project s.

Report Job List s an execut ion of a report .

I ndicat es whet her t he execut ion was a report or a

Report / Document I ndicat or
document .

S chedule I ndicat es t he schedule t hat t riggered t he delivery.

I ndicat es t he subscript ion t hat t riggered t he

S ubscript ion
delivery.

S ubscript ion E xecut ion Met ric of t he sum of all execut ion t imes of a
Durat ion (hh: mm: ss) subscript ion.

S ubscript ion E xecut ion Durat ion Met ric of t he sum of all execut ion t imes of a
(secs) subscript ion (in seconds).

© 2019, M icr o St r at egy In c. 2128

Syst em Ad m in ist r at io n Gu id e

Document Job Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

I ndicat es t he day on which t he document job

Day
execut ed.

Document I ndicat es which document was execut ed.

Document Job I ndicat es an execut ion of a document .

Met ric of t he average dif f erence bet ween st art t ime

DP A verage E lapsed Durat ion
and f inish t ime (including t ime f or prompt
per Job (hh: mm: ss)
responses) of all document job execut ions.

Met ric of t he average dif f erence, in seconds,

DP A verage E lapsed Durat ion bet ween st art t ime and f inish t ime (including t ime
per Job (secs) f or prompt responses) of all document job
execut ions.

DP A verage E xecut ion Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions.

DP A verage E xecut ion Met ric of t he average durat ion of all document job
Durat ion per Job (hh: mm: ss) execut ions.

DP A verage Queue Durat ion Met ric of t he average durat ion of all document job
per Job (hh: mm: ss) execut ions wait ing in t he queue.

DP A verage Queue Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions wait ing in t he queue.

Met ric of t he dif f erence bet ween st art t ime and

DP E lapsed Durat ion
f inish t ime (including t ime f or prompt responses) of
(hh: mm: ss)
a document job.

Met ric of t he average dif f erence, in seconds,

DP E lapsed Durat ion (secs) bet ween st art t ime and f inish t ime (including t ime
f or prompt responses) of a document job.

DP E xecut ion Durat ion Met ric of t he durat ion of a document job's
(hh: mm: ss) execut ion.

2129 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Met ric of t he durat ion, in seconds, of a document

DP E xecut ion Durat ion (secs)
job's execut ion.

DP Number of Jobs (I S _DOC_ Met ric of t he number of document jobs t hat were
FA CT) execut ed.

DP Number of Jobs wit h Cache Met ric of t he number of document jobs t hat hit a
Hit cache.

DP Number of Jobs wit h E rror Met ric of t he number of document jobs t hat f ailed.

DP Number of Users who ran Met ric of t he number of users who ran document
Document s jobs.

DP P ercent age of Jobs wit h Met ric of t he percent age of document jobs t hat hit
Cache Hit a cache.

DP P ercent age of Jobs wit h Met ric of t he percent age of document jobs t hat
E rror f ailed.

Met ric of t he durat ion of all document job

DP Queue Durat ion (hh: mm: ss)
execut ions wait ing in t he queue.

Met ric of t he durat ion, in seconds, of all document

DP Queue Durat ion (secs)
job execut ions wait ing in t he queue.

Hour I ndicat es t he hour t he document job was execut ed.

I ndicat es t he I nt elligence S erver machine t hat

I nt elligence S erver Machine
execut ed t he document job.

Met adat a I ndicat es t he met adat a st oring t he document .

I ndicat es t he minut e t he document job was

Minut e
execut ed.

P roject I ndicat es t he project st oring t he document .

Report I ndicat es t he report s in t he document .

User I ndicat es t he user who ran t he document job.

© 2019, M icr o St r at egy In c. 2130

Syst em Ad m in ist r at io n Gu id e

Document Job Step Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

I ndicat es t he day on which t he document job

Day
execut ed.

Document I ndicat es which document was execut ed.

I ndicat es t he sequence number f or st eps in a

Document Job S t ep S equence
document job.

Document Job S t ep Type I ndicat es t he t ype of st ep f or a document job.

Met ric of t he average dif f erence bet ween st art t ime

DP A verage E lapsed Durat ion
and f inish t ime (including t ime f or prompt
per Job (hh: mm: ss)
responses) of all document job execut ions.

Met ric of t he average dif f erence, in seconds,

DP A verage E lapsed Durat ion bet ween st art t ime and f inish t ime (including t ime
per Job (secs) f or prompt responses) of all document job
execut ions.

DP A verage E xecut ion Met ric of t he average durat ion of all document job
Durat ion per Job (hh: mm: ss) execut ions.

DP A verage E xecut ion Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions.

DP A verage Queue Durat ion Met ric of t he average durat ion of all document job
per Job (hh: mm: ss) execut ions wait ing in t he queue.

DP A verage Queue Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions wait ing in t he queue.

Met ric of t he dif f erence bet ween st art t ime and

DP E lapsed Durat ion
f inish t ime (including t ime f or prompt responses) of
(hh: mm: ss)
a document job.

Met ric of t he average dif f erence, in seconds,

DP E lapsed Durat ion (secs) bet ween st art t ime and f inish t ime (including t ime
f or prompt responses) of a document job.

2131 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

DP E xecut ion Durat ion Met ric of t he durat ion of a document job's
(hh: mm: ss) execut ion.

Met ric of t he durat ion, in seconds, of a document

DP E xecut ion Durat ion (secs)
job's execut ion.

Met ric of t he durat ion of all document job

DP Queue Durat ion (hh: mm: ss)
execut ions wait ing in t he queue.

Met ric of t he durat ion, in seconds, of all document

DP Queue Durat ion (secs)
job execut ions wait ing in t he queue.

Hour I ndicat es t he hour t he document job was execut ed.

Met adat a I ndicat es t he met adat a st oring t he document .

I ndicat es t he minut e t he document job was

Minut e
execut ed.

P roject I ndicat es t he project st oring t he document .

Enterprise Manager Data Load Attributes

Attrib u te n ame F u n ctio n

Dat a Load Finish Displays t he t imest amp of t he end of t he dat a load process
Time f or t he project s t hat are being monit ored.

Dat a Load P roject List s all project s t hat are being monit ored.

List s t he t imest amp of t he st art of t he dat a load process f or

Dat a Load S t art Time
t he project s t hat are being monit ored.

A value of -1 indicat es t hat it is t he summary row in t he E M_

I S _LA S T_UP DA TE t able f or all project s in a dat a load. That
I t em I D summary row has inf ormat ion about how long t he dat a load
t ook. A value of 0 indicat es it is a row wit h project dat a load
det ails.

© 2019, M icr o St r at egy In c. 2132

Syst em Ad m in ist r at io n Gu id e

Inbox Message Actions Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Day I ndicat es t he day t he manipulat ion was st art ed

Document I ndicat es t he document included in t he message.

I ndicat es t he document job t hat request ed t he Hist ory

Document Job
List message manipulat ion.

HL Days S ince Last Met ric of t he number of days since any act ion was
A ct ion: A ny act ion perf ormed.

HL Days S ince Last Met ric of t he number of days since t he last request was
A ct ion: Request made f or t he cont ent s of a message.

Met ric of t he dat e and t ime of t he last act ion perf ormed
HL Last A ct ion Dat e: A ny
on a message such as read, delet ed, marked as read, and
A ct ion
so on.

HL Last A ct ion Dat e: Met ric of t he dat e and t ime of t he last request made f or
Request t he cont ent s of a message.

HL Number of A ct ions Met ric of t he number of act ions perf ormed on a message.

HL Number of A ct ions by Met ric of t he number of act ions by user perf ormed on a
User message.

HL Number of A ct ions Met ric of t he number of act ions on a message t hat

wit h E rrors result ed in an error.

HL Number of Document Met ric of t he number of document jobs t hat result wit h
Jobs messages.

HL Number of Messages Met ric of t he number of messages.

HL Number of Messages Met ric of t he number of messages t hat result ed in an

wit h E rrors error.

HL Number of Messages Met ric of t he number of request s f or t he cont ent s of a

Request ed message.

2133 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

HL Number of Report Met ric of t he number of report jobs t hat result f rom
Jobs messages.

I ndicat es t he hour t he manipulat ion was st art ed on a

Hour
Hist ory List message.

I ndicat es t he manipulat ion t hat was perf ormed on a

I nbox A ct ion
Hist ory List message.

I ndicat es t he t ype of manipulat ion t hat was perf ormed on

I nbox A ct ion Type
a Hist ory List message.

I nbox Message I ndicat es t he message in t he Hist ory List .

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he message.

Met adat a I ndicat es t he met adat a st oring t he message.

Minut e I ndicat es t he minut e t he manipulat ion was st art ed.

P roject I ndicat es t he project st oring t he message.

Report I ndicat es t he report included in t he message.

I ndicat es t he job I D of t he report included in t he

Report Job
message.

I ndicat es t he user who manipulat ed t he Hist ory List

User
message.

Mobile Client Attributes

Attrib u te n ame F u n ctio n

I ndicat es whet her a cache was hit during t he execut ion

Cache Hit I ndicat or
and, if so, what t ype of cache hit .

© 2019, M icr o St r at egy In c. 2134

Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

Day I ndicat es t he day t he act ion st art ed.

Document I dent if ies t he document used in t he request .

I ndicat es t he t ype of report or document t hat init iat ed t he

E xecut ion Type I ndicat or
execut ion.

I ndicat es t he locat ion, in lat it ude and longit ude f orm, of

Geocode
t he user.

Hour I ndicat es t he hour t he act ion st art ed.

I nt elligence S erver
I ndicat es t he I nt elligence S erver processing t he request .
Machine

I ndicat es t he met adat a reposit ory st oring t he report or

Met adat a
document .

Minut e I ndicat es t he minut e t he act ion st art ed.

Mobile Device
I ndicat es t he unique I nst allat ion I D of t he mobile app.
I nst allat ion I D

I ndicat es t he t ype of mobile device t he app is inst alled

Mobile Device Type
on, such as I P A D2, DROI D, and so on.

I ndicat es t he version of t he MicroS t rat egy app making t he

MS TR A pp V ersion
request .

I ndicat es t he t ype of net work used, such as 3G, WI FI ,

Net work Type
LTE , and so on.

I ndicat es t he operat ing syst em of t he mobile device

Operat ing S yst em
making t he request .

Operat ing S yst em I ndicat es t he operat ing syst em version of t he mobile

V ersion device making t he request .

P roject I ndicat es t he project used t o init iat e t he request .

User I ndicat es t he user t hat init iat ed t he request .

2135 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

OLAP Services Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Day I ndicat es t he day t he act ion was st art ed.

Hour I ndicat es t he hour t he act ion was st art ed.

I nt elligent Cube I ndicat es t he I nt elligent Cube t hat was used.

I nt elligent Cube A ct ion Met ric of t he durat ion, in seconds, f or an act ion t hat was
Durat ion (secs) perf ormed on t he I nt ellgent Cube.

I nt elligent Cube A ct ion I ndicat es t he t ype of act ion t aken on t he I nt elligent Cube
Type such as cube publish, cube view hit , and so on.

I ndicat es t he I nt elligent Cube inst ance in memory t hat

I nt elligent Cube I nst ance
was used f or t he act ion.

I nt elligent Cube S ize I f t he I nt elligent Cube is published or ref reshed, indicat es

(K B ) t he size, in K B , of t he I nt elligent Cube.

I ndicat es t he t ype of I nt elligent Cube used, such as

I nt elligent Cube Type working set report , Report S ervices B ase report , OLA P
Cube report , and so on.

Minut e I ndicat es t he minut e on which t he act ion was st art ed.

Met ric of how many jobs f rom report s not based on

Number of Dynamically
I nt elligent Cubes but select ed by t he engine t o go against
S ourced Report Jobs
an I nt elligent Cube because t he object s on t he report
against I nt elligent Cubes
mat ched what is on t he I nt elligent Cube.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube P ublishes published.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube Ref reshes ref reshed.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube Republishes republished.

© 2019, M icr o St r at egy In c. 2136

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Number of Jobs wit h Met ric of how many job execut ions used an I nt elligent
I nt elligent Cube Hit Cube.

Met ric of how many users execut ed a report or document

Number of Users hit t ing
t hat used an I nt elligent Cube. That is, t he number of
I nt elligent Cubes
users using OLA P S ervices.

Number of V iew Report Met ric of how many act ions were t he result of a V iew
Jobs Report .

Report I ndicat es t he report t hat hit t he I nt elligent Cube.

Performance Monitoring Attributes

Attrib u te n ame F u n ctio n

I ndicat es cat egory of t he count er, such as memory,

Count er Cat egory
MicroS t rat egy server jobs, or MicroS t rat egy server users.

I ndicat es t he inst ance I D of t he count er, f or MicroS t rat egy

Count er I nst ance
use.

Day I ndicat es t he day t he act ion was st art ed.

Hour I ndicat es t he hour t he act ion was st art ed.

Minut e I ndicat es t he minut e t he act ion was st art ed.

P erf ormance Monit or I ndicat es t he name of t he perf ormance count er and it s value
Count er t ype.

2137 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Prompt Answers Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Connect ion S ource Indicates the connection source to Intelligence Server.

Count of P rompt
Metric of how many prompts were answered.
A nswers

Day I ndicat es t he day t he prompt was answered.

Document I ndicat es t he document t hat used t he prompt .

Hour I ndicat es t he hour t he prompt was answered.

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he job.

Met adat a I ndicat es t he met adat a reposit ory st oring t he prompt .

Minut e I ndicat es t he minut e t he prompt was answered.

P roject I ndicat es t he project st oring t he prompt .

P rompt I ndicat es t he prompt t hat was used.

P rompt A nswer I ndicat es t he answers f or t he prompt in various inst ances.

P rompt A nswer Required I ndicat es whet her an answer t o t he prompt was required.

I ndicat es t he answer of an inst ance of a prompt in a

P rompt I nst ance A nswer
report job.

P rompt Locat ion Indicates the ID of the location in which a prompt is stored.

Indicates the type of the object in which the prompt is stored, such
P rompt Locat ion Type
as filter, template, attribute, and so on.

I ndicat es t he t it le of t he prompt (t he t it le t he user sees

P rompt Tit le
when present ed during job execut ion).

I ndicat es what t ype of prompt was used, such as dat e,

P rompt Type
double, element s, and so on.

© 2019, M icr o St r at egy In c. 2138

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Report I ndicat es t he report t hat used t he prompt .

Report Job I ndicat es t he report job t hat used t he prompt .

RP Number of Jobs (I S _
Met ric of how many jobs involved a prompt .
P R_A NS _FA CT)

RP Number of Jobs
Met ric of how many report jobs had a specif ied prompt
Cont aining P rompt
answer value.
A nswer V alue

RP Number of Jobs Not

Met ric of how many report jobs did not have a specif ied
Cont aining P rompt
prompt answer value.
A nswer V alue

RP Number of Jobs wit h Met ric of how many report jobs had a prompt t hat was not
Unanswered P rompt s answered.

Report Job Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion is ad hoc.

Cache Creat ion I ndicat or I ndicat es whet her an execut ion has creat ed a cache.

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Cancelled I ndicat or I ndicat es whet her an execut ion has been canceled.

I ndicat es whet her a job was a document dat aset or a

Child Job I ndicat or
st andalone report .

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

2139 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

I ndicat es whet her a report request f ailed because of a

Dat abase E rror I ndicat or
dat abase error.

Dat amart I ndicat or I ndicat es whet her an execut ion creat ed a dat a mart .

Day I ndicat es t he day on which t he report was execut ed.

I ndicat es t he dat abase inst ance on which t he report was

DB I nst ance
execut ed.

Drill I ndicat or I ndicat es whet her an execut ion is a result of a drill.

I ndicat es whet her an execut ion is a result of an element

E lement Load I ndicat or
load.

E rror I ndicat or I ndicat es whet her an execut ion encount ered an error.

I ndicat es whet her a report was export ed and, if so,

E xport I ndicat or
indicat es it s f ormat .

Filt er I ndicat es t he f ilt er used on t he report .

Hour I ndicat es t he hour on which t he report was execut ed.

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he report .

Met adat a I ndicat es t he met adat a reposit ory t hat st ores t he report .

I ndicat es t he minut e on which t he report execut ion was

Minut e
st art ed.

Number of Jobs wit h Met ric of how many job execut ions used an I nt elligent
I nt elligent Cube Hit Cube.

P roject I ndicat es t he met adat a reposit ory t hat st ores t he report .

P rompt I ndicat or I ndicat es whet her t he report execut ion was prompt ed.

Report I ndicat es t he I D of t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

© 2019, M icr o St r at egy In c. 2140

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP A verage E lapsed
Met ric of t he average dif f erence bet ween st art t ime and
Durat ion per Job
f inish t ime (including t ime f or prompt responses) of all
(hh: mm: ss) (I S _RE P _
report job execut ions.
FA CT)

RP A verage E lapsed Met ric of t he average dif f erence bet ween st art t ime and
Durat ion per Job (secs) f inish t ime (including t ime f or prompt responses) of all
(I S _RE P _FA CT) report job execut ions.

RP A verage E xecut ion

Durat ion per Job Met ric of t he average durat ion of all report job execut ions.
(hh: mm: ss) (I S _RE P _ I ncludes t ime in queue and execut ion f or a report job.
FA CT)

RP A verage E xecut ion Met ric of t he average durat ion, in seconds, of all report
Durat ion per Job (secs) job execut ions. I ncludes t ime in queue and execut ion f or
(I S _RE P _FA CT) a report job.

RP A verage P rompt
Met ric of t he average t ime users t ake t o answer t he set of
A nswer Time per Job
prompt s in all report jobs.
(hh: mm: ss)

RP A verage P rompt
Met ric of t he average t ime, in seconds, users t ake t o
A nswer Time per Job
answer t he set of prompt s in all report jobs.
(secs)

RP A verage Queue
Met ric of t he average t ime report jobs wait ed in t he
Durat ion per Job
I nt elligence S erver's queue bef ore t he report job was
(hh: mm: ss) (I S _RE P _
execut ed.
FA CT)

RP A verage Queue Met ric of t he average t ime, in seconds, report jobs wait ed
Durat ion per Job (secs) in t he I nt elligence S erver's queue bef ore t he report job
(I S _RE P _FA CT) was execut ed.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E lapsed Durat ion
of a report job. I ncludes t ime f or prompt responses, in
(hh: mm: ss)
queue, and execut ion.

2141 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E lapsed Durat ion
and f inish t ime of a report job. I ncludes t ime f or prompt
(secs)
responses, in queue, and execut ion.

RP E xecut ion Durat ion Met ric of t he durat ion of a report job's execut ion. I ncludes
(hh: mm: ss) dat abase execut ion t ime.

RP E xecut ion Durat ion Met ric of t he durat ion, in seconds, of a report job's
(secs) execut ion. I ncludes dat abase execut ion t ime.

RP Number of A d Hoc Met ric of how many report jobs result ed f rom an ad hoc
Jobs report creat ion.

RP Number of Cancelled
Met ric of how many job execut ions were canceled.
Jobs

Met ric of how many job execut ions result ed f rom a drill
RP Number of Drill Jobs
act ion.

RP Number of Jobs (I S _
Met ric of how many report jobs were execut ed.
RE P _FA CT)

RP Number of Jobs Met ric of how many report jobs were execut ed against t he
hit t ing Dat abase dat abase.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
Cache Creat ion result in creat ing a server cache.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
Cache Hit hit a server cache.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
E lement Loading result f rom loading addit ional at t ribut e element s.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
Cache Creat ion result ed in a server cache being creat ed.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat hit a
Cache Hit server cache.

© 2019, M icr o St r at egy In c. 2142

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
Dat amart Creat ion result ed in a dat a mart being creat ed.

RP Number of Jobs wit h Met ric of how many report jobs f ailed because of a
DB E rror dat abase error.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
E lement Loading result ed f rom loading addit ional at t ribut e element s.

RP Number of Jobs wit h

Met ric of how many report jobs f ailed because of an error.
E rror

RP Number of Jobs wit h Met ric of how many report job execut ions used an
I nt elligent Cube Hit I nt elligent Cube.

RP Number of Jobs wit h Met ric of how many report job execut ions used a securit y
S ecurit y Filt er f ilt er.

RP Number of Jobs wit h

Met ric of how many report jobs execut ed S QL st at ement s.
S QL E xecut ion

RP number of Met ric of how many report job execut ions were run
Narrowcast S erver jobs t hrough MicroS t rat egy Narrowcast S erver.

RP Number of P rompt ed Met ric of how many report job execut ions included a
Jobs prompt .

RP Number of Report
Met ric of how many report jobs execut ed as a result of a
Jobs f rom Document
document execut ion.
E xecut ion

RP Number of Result Met ric of how many result rows were ret urned f rom a
Rows report execut ion.

RP Number of
Met ric of how many report jobs were scheduled.
S cheduled Jobs

RP Number of Users who

Met ric of how many dist inct users ran report jobs.
ran report s

2143 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP P rompt A nswer Met ric of t he how long users t ake t o answer t he set of
Durat ion (hh: mm: ss) prompt s in report jobs.

RP P rompt A nswer Met ric of t he how long, in seconds, users t ake t o answer
Durat ion (secs) t he set of prompt s in report jobs.

RP Queue Durat ion Met ric of how long a report job wait ed in t he I nt elligence
(hh: mm: ss) S erver's queue bef ore t he report job was execut ed.

Met ric of how long, in seconds, a report job wait ed in t he

RP Queue Durat ion
I nt elligence S erver's queue bef ore t he report job was
(secs)
execut ed.

S chedule I ndicat es t he schedule t hat began t he report execut ion.

S chedule I ndicat or I ndicat es whet her t he report execut ion was scheduled.

S ecurit y Filt er I ndicat es t he securit y f ilt er used in t he report execut ion.

I ndicat es whet her a securit y f ilt er was used in t he report

S ecurit y Filt er I ndicat or
execut ion.

S QL E xecut ion I ndicat or I ndicat es t hat S QL was execut ed during report execut ion.

Templat e I ndicat es t he report t emplat e t hat was used.

User I ndicat es t he user t hat ran t he report .

Report Job SQL Pass Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her t he execut ion was ad hoc.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

Day I ndicat es t he day in which t he job was execut ed.

© 2019, M icr o St r at egy In c. 2144

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Hour I ndicat es t he hour in which t he report job was execut ed.

I ndicat es t he met adat a reposit ory st oring t he report or

Met adat a
document .

Minut e I ndicat es t he minut e in which t he report job was st art ed.

P roject I ndicat es t he project st oring t he report or document .

Report I ndicat es t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

I ndicat es t he S QL st at ement t hat was execut ed during t he

Report Job S QL P ass
S QL pass.

I ndicat es t he t ype of S QL st at ement t hat was execut ed in

Report Job S QL P ass
t his S QL pass. E xamples are S QL select , S QL insert ,
Type
S QL creat e and such.

RP E xecut ion Durat ion Met ric of t he durat ion of a report job's execut ion. I ncludes
(hh: mm: ss) dat abase execut ion t ime.

RP E xecut ion Durat ion Met ric of t he durat ion, in seconds, of a report job's
(secs) execut ion. I ncludes dat abase execut ion t ime.

RP Last E xecut ion Finish Met ric of t he f inish t imest amp when t he report job was
Timest amp last execut ed.

RP Last E xecut ion S t art Met ric of t he st art t imest amp when t he report job was last
Timest amp execut ed.

RP Number of DB Tables Met ric of how many dat abase t ables were accessed in a
A ccessed report job execut ion.

Met ric of how large, in byt es, t he S QL was f or a report

RP S QL S ize
job.

2145 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Report Job Steps Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion was ad hoc.

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

Day I ndicat es t he day in which t he job was execut ed.

Hour I ndicat es t he hour in which t he report job was execut ed.

Minut e I ndicat es t he minut e in which t he report job was st art ed.

Report I ndicat es t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

I ndicat es t he sequence number in t he series of execut ion

Report Job S t ep
st eps a report job passes t hrough in t he I nt elligence
S equence
S erver.

I ndicat es t he t ype of st ep f or a report job. E xamples are

S QL generat ion, S QL execut ion, A nalyt ical E ngine,
Report Job S t ep Type
Resolut ion S erver, element request , updat e I nt elligent
Cube, and so on.

RP A verage CP U
E xecut ion Durat ion per Met ric of t he average durat ion, in milliseconds, a report
Job (msecs) (I S _RE P _ job execut ion t akes in t he I nt elligence S erver CP U.
S TE P _FA CT)

RP A verage E lapsed Met ric of t he average dif f erence, in seconds, bet ween
Durat ion per Job (secs) st art t ime and f inish t ime of report job execut ions.
(I S _RE P _S TE P _FA CT) I ncludes t ime f or prompt responses.

RP A verage E xecut ion Met ric of t he average dif f erence, in seconds, bet ween

© 2019, M icr o St r at egy In c. 2146

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Durat ion per Job (secs) st art t ime and f inish t ime of report job execut ions.
(I S _RE P _S TE P _FA CT) I ncludes t ime f or prompt responses.

RP A verage Query
E ngine E xecut ion Met ric of t he average t ime, in seconds, t he Query E ngine
Durat ion per Job (secs) t akes t o process a report job.
(I S _RE P _S TE P _FA CT)

RP A verage Queue Met ric of t he average t ime report jobs wait ed in t he

Durat ion per Job (secs) I nt elligence S erver's queue bef ore t he report job was
(I S _RE P _S TE P _FA CT) execut ed.

Met ric of how long, in milliseconds, a report job execut ion

RP CP U Durat ion (msec)
t akes in t he I nt elligence S erver CP U.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E lapsed Durat ion
of report job execut ions. I ncludes t ime f or prompt
(hh: mm: ss)
responses.

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E lapsed Durat ion
and f inish t ime of report job execut ions. I ncludes t ime f or
(secs)
prompt responses.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E xecut ion Durat ion
of report job execut ions. I ncludes dat abase execut ion
(hh: mm: ss)
t ime.

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E xecut ion Durat ion
and f inish t ime of report job execut ions. I ncludes
(secs)
dat abase execut ion t ime.

RP Last E xecut ion Finish Met ric of t he f inish t imest amp when t he report job was
Timest amp last execut ed.

RP Last E xecut ion S t art Met ric of t he st art t imest amp when t he report job was last
Timest amp execut ed.

RP Number of Jobs (I S _
Met ric of how many report jobs were execut ed.
RE P _S TE P _FA CT)

2147 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP Query E ngine
Met ric of how long t he Query E ngine t ook t o execut e S QL
Durat ion (hh: mm: ss)
f or a report job.
(I S _RE P _S TE P _FA CT)

RP Query E ngine
Met ric of t he t ime, in seconds, t he Query E ngine t akes t o
Durat ion (secs) (I S _
execut e S QL f or a report job.
RE P _S TE P _FA CT)

RP Queue Durat ion Met ric of how long a report job wait ed in t he I nt elligence
(hh: mm: ss) S erver's queue bef ore t he report job was execut ed.

Met ric of how long, in seconds, a report job wait ed in t he

RP Queue Durat ion
I nt elligence S erver's queue bef ore t he report job was
(secs)
execut ed.

RP S QL E ngine Durat ion

Met ric of how long t he S QL E ngine t ook t o generat e S QL
(hh: mm: ss) (I S _RE P _
f or a report job.
S TE P _FA CT)

Report Job Tables/Columns Accessed Attributes and

Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion was ad hoc.

Column I ndicat es t he column t hat was accessed.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es t he day on which t he t able column was

Day
accessed.

I ndicat es t he t able in t he dat abase st oring t he column

DB Table
t hat was accessed.

© 2019, M icr o St r at egy In c. 2148

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

I ndicat es t he hour on which t he t able column was

Hour
accessed.

I ndicat es t he minut e on which t he t able column was

Minut e
accessed.

Report I ndicat es t he report t hat accessed t he t able column.

I ndicat es which execut ion of a report accessed t he t able

Report Job
column.

Met ric of how many report jobs accessed t he dat abase

RP Number of Jobs (I S _
column or t able. The Warehouse Tables A ccessed report
RE P _COL_FA CT)
uses t his met ric.

I ndicat es which t ype of S QL clause was used t o access

S QL Clause Type
t he t able column.

Schema Objects Attributes

Attrib u te
F u n ctio n
n ame

List s all at t ribut es in project s t hat are set up t o be monit ored by

A t t ribut e
E nt erprise Manager.

List s all at t ribut e f orms in project s t hat are set up t o be monit ored
A t t ribut e Form
by E nt erprise Manager.

List s all columns in project s t hat are set up t o be monit ored by

Column
E nt erprise Manager.

List s all physical t ables in t he dat a warehouse t hat are set up t o be

DB Table
monit ored by E nt erprise Manager.

List s all f act s in project s t hat are set up t o be monit ored by

Fact
E nt erprise Manager.

2149 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s all hierarchies in project s t hat are set up t o be monit ored by

Hierarchy
E nt erprise Manager

List s all logical t ables in project s t hat are set up t o be monit ored by
Table
E nt erprise Manager.

List s all t ransf ormat ions in project s t hat are set up t o be monit ored
Transf ormat ion
by E nt erprise Manager.

Server Machines Attributes

Attrib u te n ame F u n ctio n

List s all machines t hat have had users connect t o t he

Client Machine
I nt elligence S erver.

I nt elligence S erver
List s t he clust er of I nt elligence S ervers.
Clust er

I nt elligence S erver List s all machines t hat have logged st at ist ics as an
Machine I nt elligence S erver.

Web S erver Machine List s all machines used as web servers.

Session Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A vg. Connect ion Met ric of t he average t ime connect ions t o an I nt elligence
Durat ion (hh: mm: ss) S erver last .

A vg. Connect ion Met ric of t he average t ime, in seconds, connect ions t o an
Durat ion (secs) I nt elligence S erver last .

© 2019, M icr o St r at egy In c. 215 0

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Connect ion Durat ion Met ric of t he t ime a connect ion t o an I nt elligence S erver
(hh: mm: ss) last s.

Connect ion Durat ion Met ric of t he t ime, in seconds, a connect ion t o an
(secs) I nt elligence S erver last s.

Connect ion S ource List s all connect ion sources t o I nt elligence S erver.

Met ric of how many sessions were connect ed t o an

Number of S essions
I nt elligence S erver. Usually report ed wit h a dat e and t ime
(Report Level)
at t ribut e.

Met ric of how many dist inct users were connect ed t o an

Number of Users Logged
I nt elligence S erver. Usually report ed wit h a dat e and t ime
I n (Report Level)
at t ribut e.

S ession I ndicat es a user connect ion t o an I nt elligence S erver.

All Indicators and Flags Attributes

Attrib u te n ame F u n ctio n

A d Hoc I ndicat or I ndicat es whet her an execut ion is ad hoc.

Cache Creat ion

I ndicat es whet her an execut ion has creat ed a cache.
I ndicat or

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Cancelled I ndicat or I ndicat es whet her an execut ion has been cancelled.

I ndicat es whet her a job was a document dat aset or a st and-

Child Job I ndicat or
alone report .

Conf igurat ion Object

I ndicat es whet her a conf igurat ion object exist s.
E xist s S t at us

Conf igurat ion List s all conf igurat ion paramet er t ypes.

215 1 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

P aramet er V alue Type

Connect ion S ource List s all connect ion sources t o I nt elligence S erver.

Cont act Type List s t he execut ed cont act t ypes.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

Dat abase E rror I ndicat es whet her a report request f ailed because of a
I ndicat or dat abase error.

Dat amart I ndicat or I ndicat es whet her an execut ion creat ed a dat a mart .

I ndicat es whet her an execut ion encount ered a dat abase

DB E rror I ndicat or
error.

Delivery S t at us
I ndicat es whet her a delivery was successf ul.
I ndicat or

Delivery Type List s t he t ype of delivery.

Document Job S t at us
List s t he st at uses of document execut ions.
(Deprecat ed)

Document Job S t ep
List s all possible st eps of document job execut ion.
Type

I ndicat es t he t ype of a document or dossier, such as HTML

Document Type
document , Report S ervices document , or a dossier.

List s t he object f rom which a user drilled when a new report

Drill f rom Object
was run because of a drilling act ion.

Drill I ndicat or I ndicat es whet her an execut ion is a result of a drill.

List s t he object t o which a user drilled when a new report

Drill t o Object
was run because of a drilling act ion.

I ndicat es whet her an execut ion is a result of an element

E lement Load I ndicat or
load.

© 2019, M icr o St r at egy In c. 215 2

Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

E rror I ndicat or I ndicat es whet her an execut ion encount ered an error.

E xecut ion Type I ndicat es how t he cont ent was request ed, such as User
I ndicat or E xecut ion, P re-Cached, A pplicat ion Recovery, and so on.

I ndicat es whet her a report was export ed and, if so,

E xport I ndicat or
indicat es it s f ormat .

Hierarchy Drilling I ndicat es whet her a hierarchy is used as a drill hierarchy.

List t he t ypes of manipulat ions t hat can be perf ormed on a

I nbox A ct ion Type
Hist ory List message.

I nt elligent Cube A ct ion

List s act ions perf ormed on or against int elligent cubes.
Type

I nt elligent Cube Type List s all int elligent cube t ypes.

List s all t he possible errors t hat can be ret urned during job
Job E rrorCode
execut ions.

Job P riorit y Map List s t he priorit ies of job execut ions.

E numerat es t he upper limit of t he priorit y ranges f or high,

Job P riorit y Number medium, and low priorit y jobs. Def ault values are 332, 666,
and 999.

Object Creat ion Dat e I ndicat es t he dat e on which an object was creat ed.

Object Creat ion I ndicat es t he week of t he year in which an object was

Week of year creat ed.

Object E xist s S t at us I ndicat es whet her an object exist s.

Object Hidden S t at us I ndicat es whet her an object is hidden.

Object Modif icat ion

I ndicat es t he dat e on which an object was last modif ied.
Dat e

Object Modif icat ion I ndicat es t he week of t he year in which an object was last
Week of year modif ied.

P rompt A nswer I ndicat es whet her a prompt answer was required f or t he job

215 3 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

Required execut ion.

P rompt I ndicat or I ndicat es whet her a job execut ion was prompt ed.

Report Job S QL P ass List s t he t ypes of S QL passes t hat t he I nt elligence S erver

Type generat es.

Report Job S t at us
List s t he st at uses of report execut ions.
(Deprecat ed)

Report Job S t ep Type List s all possible st eps of report job execut ion.

I ndicat es t he t ype of a report , such as X DA , relat ional, and

Report Type
so on.

Report / Document I ndicat es whet her t he execut ion was a report or a

I ndicat or document .

S chedule I ndicat or I ndicat es whet her a job execut ion was scheduled.

S ecurit y Filt er I ndicat es whet her a securit y f ilt er was used in t he job
I ndicat or execut ion.

S QL Clause Type List s t he various S QL clause t ypes used by t he S QL E ngine.

S QL E xecut ion
I ndicat es whet her S QL was execut ed in t he job execut ion.
I ndicat or

Application Objects Attributes

Attrib u te
F u n ctio n
n ame

List s all consolidat ions in project s t hat are set up t o be monit ored
Consolidat ion
by E nt erprise Manager.

List s all cust om groups in project s t hat are set up t o be monit ored
Cust om Group
by E nt erprise Manager.

© 2019, M icr o St r at egy In c. 215 4

Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s all document s in project s t hat are set up t o be monit ored by

Document
E nt erprise Manager.

List s all f ilt ers in project s t hat are set up t o be monit ored by
Filt er
E nt erprise Manager.

I nt elligent List s all int elligent cubes in project s t hat are set up t o be
Cube monit ored by E nt erprise Manager.

List s all met rics in project s t hat are set up t o be monit ored by
Met ric
E nt erprise Manager.

List s all prompt s in project s t hat are set up t o be monit ored by

P rompt
E nt erprise Manager.

List s all report s in project s t hat are set up t o be monit ored by

Report
E nt erprise Manager.

List s all securit y f ilt ers in project s t hat are set up t o be monit ored
S ecurit y Filt er
by E nt erprise Manager.

List s all t emplat es in project s t hat are set up t o be monit ored by

Templat e
E nt erprise Manager.

Configuration Objects Attributes

Attrib u te n ame F u n ctio n

A ddress List s all addresses t o which deliveries have been sent .

Conf igurat ion Object

List s t he owners of conf igurat ion object s.
Owner

Conf igurat ion

List s all conf igurat ion paramet ers.
P aramet er

Cont act List s all cont act s t o whom deliveries have been sent .

215 5 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

DB Connect ion List s all dat abase connect ions.

DB I nst ance List s all dat abase inst ances.

Device List s all devices t o which deliveries have been sent .

E vent List s all event s being t racked.

Folder List s all f olders wit hin project s.

I nt elligence S erver
List s all I nt elligence S erver def init ions.
Def init ion

Met adat a List s all monit ored met adat a.

Owner List s t he owners of all object s.

P roject List s all project s.

S chedule List s all schedules.

S ubscript ion List s all execut ed t ransmissions.

Transmit t er List s all t ransmit t ers.

User List s all users being t racked.

User Group List s all user groups.

User Group (P arent ) List s all user groups t hat are parent s of ot her user groups.

Date and Time Attributes

Attrib u te
F u n ctio n
n ame

Calendar List s every calendar week, beginning wit h 2000-01-01, as an

Week int eger.

Day List s all days, beginning in 1990.

© 2019, M icr o St r at egy In c. 215 6

Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s t he hours in a day. For example, 09 A M - 10 A M, 10 A M - 11

Hour
A M, and so on.

List s all t he minut es in an hour. For example, if t he hour specif ied is

Minut e 10 A M - 11 A M, list s minut es as 10. 30 A M - 10. 31 A M, 10. 32 A M -
10. 33 A M, and so on.

Mont h List s all mont hs, beginning wit h 2000.

Mont h of Y ear List s all mont hs in a specif ied year.

Quart er List s all quart ers.

Quart er of
List s all quart ers of t he year.
Y ear

List s all weeks in all years, beginning in 2000. Weeks in 2000 are
represent ed as a number ranging f rom 200001 t o 200053, weeks in
Week of Y ear
2001 are represent ed as a number ranging f rom 200101 t o 200153,
and so on.

Weekday List s all days of t he week.

Y ear List s all years.

Delivery Services Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

A ddress I ndicat es t he address t o which a delivery was sent .

A vg number of recipient s per Met ric of t he average number of recipient s in

subscript ion subscript ions.

A vg S ubscript ion E xecut ion Met ric of t he average amount of t ime subscript ions
Durat ion (hh: mm: ss) t ake t o execut e.

A vg S ubscript ion E xecut ion Met ric of t he average amount of t ime, in seconds,

215 7 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Durat ion (secs) subscript ions t ake t o execut e.

Cont act I ndicat es all cont act s t o whom a delivery was sent .

Cont act Type I ndicat es t he execut ed cont act t ypes.

Day I ndicat es t he day on which t he delivery was sent .

Delivery S t at us I ndicat or I ndicat es whet her t he delivery was successf ul.

Delivery Type I ndicat es t he t ype of delivery.

I ndicat es t he t ype of device t o which t he delivery

Device
was sent .

Document I ndicat es t he document t hat was delivered.

Hour I ndicat es t he hour on which t he delivery was sent .

I ndicat es t he I nt elligence S erver machine t hat

I nt elligence S erver Machine
execut ed t he job.

Met adat a I ndicat es t he monit ored met adat a.

I ndicat es t he minut e on which t he delivery was

Minut e
sent .

Number of Dist inct Document Met ric of t he number of report services document
S ubscript ions subscript ions.

Met ric of t he number of recipient s t hat received

Number of Dist inct Recipient s
cont ent f rom a subscript ion.

Number of Dist inct Report

Met ric of t he number of report subscript ions.
S ubscript ions

Met ric of t he number of execut ed subscript ions.

Number of Dist inct
This does not ref lect t he number of subscript ions
S ubscript ions
in t he met adat a.

Met ric of t he number of subscript ions t hat

Number of E -mail S ubscript ions
delivered cont ent via e-mail.

© 2019, M icr o St r at egy In c. 215 8

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Number of E rrored
Met ric of t he number of subscript ions t hat f ailed.
S ubscript ions

Met ric of t he number of execut ions of a

Number of E xecut ions
subscript ion.

Met ric of t he number of subscript ions t hat

Number of File S ubscript ions
delivered cont ent via f ile locat ion.

Number of Hist ory List Met ric of t he number of subscript ions t hat
S ubscript ions delivered cont ent via t he hist ory list .

Met ric of t he number of subscript ions t hat

Number of Mobile S ubscript ions
delivered cont ent via mobile.

Met ric of t he number of subscript ions t hat

Number of P rint S ubscript ions
delivered cont ent via a print er.

P roject List s t he project s.

Report List s t he report s in project s.

Report Job List s an execut ion of a report .

I ndicat es whet her t he execut ion was a report or a

Report / Document I ndicat or
document .

S chedule I ndicat es t he schedule t hat t riggered t he delivery.

I ndicat es t he subscript ion t hat t riggered t he

S ubscript ion
delivery.

S ubscript ion E xecut ion Met ric of t he sum of all execut ion t imes of a
Durat ion (hh: mm: ss) subscript ion.

S ubscript ion E xecut ion Durat ion Met ric of t he sum of all execut ion t imes of a
(secs) subscript ion (in seconds).

215 9 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Document Job Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

I ndicat es t he day on which t he document job

Day
execut ed.

Document I ndicat es which document was execut ed.

Document Job I ndicat es an execut ion of a document .

Met ric of t he average dif f erence bet ween st art t ime

DP A verage E lapsed Durat ion
and f inish t ime (including t ime f or prompt
per Job (hh: mm: ss)
responses) of all document job execut ions.

Met ric of t he average dif f erence, in seconds,

DP A verage E lapsed Durat ion bet ween st art t ime and f inish t ime (including t ime
per Job (secs) f or prompt responses) of all document job
execut ions.

DP A verage E xecut ion Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions.

DP A verage E xecut ion Met ric of t he average durat ion of all document job
Durat ion per Job (hh: mm: ss) execut ions.

DP A verage Queue Durat ion Met ric of t he average durat ion of all document job
per Job (hh: mm: ss) execut ions wait ing in t he queue.

DP A verage Queue Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions wait ing in t he queue.

Met ric of t he dif f erence bet ween st art t ime and

DP E lapsed Durat ion
f inish t ime (including t ime f or prompt responses) of
(hh: mm: ss)
a document job.

Met ric of t he average dif f erence, in seconds,

DP E lapsed Durat ion (secs) bet ween st art t ime and f inish t ime (including t ime
f or prompt responses) of a document job.

DP E xecut ion Durat ion Met ric of t he durat ion of a document job's
(hh: mm: ss) execut ion.

© 2019, M icr o St r at egy In c. 2160

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Met ric of t he durat ion, in seconds, of a document

DP E xecut ion Durat ion (secs)
job's execut ion.

DP Number of Jobs (I S _DOC_ Met ric of t he number of document jobs t hat were
FA CT) execut ed.

DP Number of Jobs wit h Cache Met ric of t he number of document jobs t hat hit a
Hit cache.

DP Number of Jobs wit h E rror Met ric of t he number of document jobs t hat f ailed.

DP Number of Users who ran Met ric of t he number of users who ran document
Document s jobs.

DP P ercent age of Jobs wit h Met ric of t he percent age of document jobs t hat hit
Cache Hit a cache.

DP P ercent age of Jobs wit h Met ric of t he percent age of document jobs t hat
E rror f ailed.

Met ric of t he durat ion of all document job

DP Queue Durat ion (hh: mm: ss)
execut ions wait ing in t he queue.

Met ric of t he durat ion, in seconds, of all document

DP Queue Durat ion (secs)
job execut ions wait ing in t he queue.

Hour I ndicat es t he hour t he document job was execut ed.

I ndicat es t he I nt elligence S erver machine t hat

I nt elligence S erver Machine
execut ed t he document job.

Met adat a I ndicat es t he met adat a st oring t he document .

I ndicat es t he minut e t he document job was

Minut e
execut ed.

P roject I ndicat es t he project st oring t he document .

Report I ndicat es t he report s in t he document .

User I ndicat es t he user who ran t he document job.

2161 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Document Job Step Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

I ndicat es t he day on which t he document job

Day
execut ed.

Document I ndicat es which document was execut ed.

I ndicat es t he sequence number f or st eps in a

Document Job S t ep S equence
document job.

Document Job S t ep Type I ndicat es t he t ype of st ep f or a document job.

Met ric of t he average dif f erence bet ween st art t ime

DP A verage E lapsed Durat ion
and f inish t ime (including t ime f or prompt
per Job (hh: mm: ss)
responses) of all document job execut ions.

Met ric of t he average dif f erence, in seconds,

DP A verage E lapsed Durat ion bet ween st art t ime and f inish t ime (including t ime
per Job (secs) f or prompt responses) of all document job
execut ions.

DP A verage E xecut ion Met ric of t he average durat ion of all document job
Durat ion per Job (hh: mm: ss) execut ions.

DP A verage E xecut ion Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions.

DP A verage Queue Durat ion Met ric of t he average durat ion of all document job
per Job (hh: mm: ss) execut ions wait ing in t he queue.

DP A verage Queue Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions wait ing in t he queue.

Met ric of t he dif f erence bet ween st art t ime and

DP E lapsed Durat ion
f inish t ime (including t ime f or prompt responses) of
(hh: mm: ss)
a document job.

Met ric of t he average dif f erence, in seconds,

DP E lapsed Durat ion (secs) bet ween st art t ime and f inish t ime (including t ime
f or prompt responses) of a document job.

© 2019, M icr o St r at egy In c. 2162

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

DP E xecut ion Durat ion Met ric of t he durat ion of a document job's
(hh: mm: ss) execut ion.

Met ric of t he durat ion, in seconds, of a document

DP E xecut ion Durat ion (secs)
job's execut ion.

Met ric of t he durat ion of all document job

DP Queue Durat ion (hh: mm: ss)
execut ions wait ing in t he queue.

Met ric of t he durat ion, in seconds, of all document

DP Queue Durat ion (secs)
job execut ions wait ing in t he queue.

Hour I ndicat es t he hour t he document job was execut ed.

Met adat a I ndicat es t he met adat a st oring t he document .

I ndicat es t he minut e t he document job was

Minut e
execut ed.

P roject I ndicat es t he project st oring t he document .

Enterprise Manager Data Load Attributes

Attrib u te n ame F u n ctio n

Dat a Load Finish Displays t he t imest amp of t he end of t he dat a load process
Time f or t he project s t hat are being monit ored.

Dat a Load P roject List s all project s t hat are being monit ored.

List s t he t imest amp of t he st art of t he dat a load process f or

Dat a Load S t art Time
t he project s t hat are being monit ored.

A value of -1 indicat es t hat it is t he summary row in t he E M_

I S _LA S T_UP DA TE t able f or all project s in a dat a load. That
I t em I D summary row has inf ormat ion about how long t he dat a load
t ook. A value of 0 indicat es it is a row wit h project dat a load
det ails.

2163 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Inbox Message Actions Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Day I ndicat es t he day t he manipulat ion was st art ed

Document I ndicat es t he document included in t he message.

I ndicat es t he document job t hat request ed t he Hist ory

Document Job
List message manipulat ion.

HL Days S ince Last Met ric of t he number of days since any act ion was
A ct ion: A ny act ion perf ormed.

HL Days S ince Last Met ric of t he number of days since t he last request was
A ct ion: Request made f or t he cont ent s of a message.

Met ric of t he dat e and t ime of t he last act ion perf ormed
HL Last A ct ion Dat e: A ny
on a message such as read, delet ed, marked as read, and
A ct ion
so on.

HL Last A ct ion Dat e: Met ric of t he dat e and t ime of t he last request made f or
Request t he cont ent s of a message.

HL Number of A ct ions Met ric of t he number of act ions perf ormed on a message.

HL Number of A ct ions by Met ric of t he number of act ions by user perf ormed on a
User message.

HL Number of A ct ions Met ric of t he number of act ions on a message t hat

wit h E rrors result ed in an error.

HL Number of Document Met ric of t he number of document jobs t hat result wit h
Jobs messages.

HL Number of Messages Met ric of t he number of messages.

HL Number of Messages Met ric of t he number of messages t hat result ed in an

wit h E rrors error.

HL Number of Messages Met ric of t he number of request s f or t he cont ent s of a

Request ed message.

© 2019, M icr o St r at egy In c. 2164

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

HL Number of Report Met ric of t he number of report jobs t hat result f rom
Jobs messages.

I ndicat es t he hour t he manipulat ion was st art ed on a

Hour
Hist ory List message.

I ndicat es t he manipulat ion t hat was perf ormed on a

I nbox A ct ion
Hist ory List message.

I ndicat es t he t ype of manipulat ion t hat was perf ormed on

I nbox A ct ion Type
a Hist ory List message.

I nbox Message I ndicat es t he message in t he Hist ory List .

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he message.

Met adat a I ndicat es t he met adat a st oring t he message.

Minut e I ndicat es t he minut e t he manipulat ion was st art ed.

P roject I ndicat es t he project st oring t he message.

Report I ndicat es t he report included in t he message.

I ndicat es t he job I D of t he report included in t he

Report Job
message.

I ndicat es t he user who manipulat ed t he Hist ory List

User
message.

Mobile Client Attributes

Attrib u te n ame F u n ctio n

I ndicat es whet her a cache was hit during t he execut ion

Cache Hit I ndicat or
and, if so, what t ype of cache hit .

2165 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

Day I ndicat es t he day t he act ion st art ed.

Document I dent if ies t he document used in t he request .

I ndicat es t he t ype of report or document t hat init iat ed t he

E xecut ion Type I ndicat or
execut ion.

I ndicat es t he locat ion, in lat it ude and longit ude f orm, of

Geocode
t he user.

Hour I ndicat es t he hour t he act ion st art ed.

I nt elligence S erver
I ndicat es t he I nt elligence S erver processing t he request .
Machine

I ndicat es t he met adat a reposit ory st oring t he report or

Met adat a
document .

Minut e I ndicat es t he minut e t he act ion st art ed.

Mobile Device
I ndicat es t he unique I nst allat ion I D of t he mobile app.
I nst allat ion I D

I ndicat es t he t ype of mobile device t he app is inst alled

Mobile Device Type
on, such as I P A D2, DROI D, and so on.

I ndicat es t he version of t he MicroS t rat egy app making t he

MS TR A pp V ersion
request .

I ndicat es t he t ype of net work used, such as 3G, WI FI ,

Net work Type
LTE , and so on.

I ndicat es t he operat ing syst em of t he mobile device

Operat ing S yst em
making t he request .

Operat ing S yst em I ndicat es t he operat ing syst em version of t he mobile

V ersion device making t he request .

P roject I ndicat es t he project used t o init iat e t he request .

User I ndicat es t he user t hat init iat ed t he request .

© 2019, M icr o St r at egy In c. 2166

Syst em Ad m in ist r at io n Gu id e

OLAP Services Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Day I ndicat es t he day t he act ion was st art ed.

Hour I ndicat es t he hour t he act ion was st art ed.

I nt elligent Cube I ndicat es t he I nt elligent Cube t hat was used.

I nt elligent Cube A ct ion Met ric of t he durat ion, in seconds, f or an act ion t hat was
Durat ion (secs) perf ormed on t he I nt ellgent Cube.

I nt elligent Cube A ct ion I ndicat es t he t ype of act ion t aken on t he I nt elligent Cube
Type such as cube publish, cube view hit , and so on.

I ndicat es t he I nt elligent Cube inst ance in memory t hat

I nt elligent Cube I nst ance
was used f or t he act ion.

I nt elligent Cube S ize I f t he I nt elligent Cube is published or ref reshed, indicat es

(K B ) t he size, in K B , of t he I nt elligent Cube.

I ndicat es t he t ype of I nt elligent Cube used, such as

I nt elligent Cube Type working set report , Report S ervices B ase report , OLA P
Cube report , and so on.

Minut e I ndicat es t he minut e on which t he act ion was st art ed.

Met ric of how many jobs f rom report s not based on

Number of Dynamically
I nt elligent Cubes but select ed by t he engine t o go against
S ourced Report Jobs
an I nt elligent Cube because t he object s on t he report
against I nt elligent Cubes
mat ched what is on t he I nt elligent Cube.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube P ublishes published.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube Ref reshes ref reshed.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube Republishes republished.

2167 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Number of Jobs wit h Met ric of how many job execut ions used an I nt elligent
I nt elligent Cube Hit Cube.

Met ric of how many users execut ed a report or document

Number of Users hit t ing
t hat used an I nt elligent Cube. That is, t he number of
I nt elligent Cubes
users using OLA P S ervices.

Number of V iew Report Met ric of how many act ions were t he result of a V iew
Jobs Report .

Report I ndicat es t he report t hat hit t he I nt elligent Cube.

Performance Monitoring Attributes

Attrib u te n ame F u n ctio n

I ndicat es cat egory of t he count er, such as memory,

Count er Cat egory
MicroS t rat egy server jobs, or MicroS t rat egy server users.

I ndicat es t he inst ance I D of t he count er, f or MicroS t rat egy

Count er I nst ance
use.

Day I ndicat es t he day t he act ion was st art ed.

Hour I ndicat es t he hour t he act ion was st art ed.

Minut e I ndicat es t he minut e t he act ion was st art ed.

P erf ormance Monit or I ndicat es t he name of t he perf ormance count er and it s value
Count er t ype.

© 2019, M icr o St r at egy In c. 2168

Syst em Ad m in ist r at io n Gu id e

Prompt Answers Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Connect ion S ource Indicates the connection source to Intelligence Server.

Count of P rompt
Metric of how many prompts were answered.
A nswers

Day I ndicat es t he day t he prompt was answered.

Document I ndicat es t he document t hat used t he prompt .

Hour I ndicat es t he hour t he prompt was answered.

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he job.

Met adat a I ndicat es t he met adat a reposit ory st oring t he prompt .

Minut e I ndicat es t he minut e t he prompt was answered.

P roject I ndicat es t he project st oring t he prompt .

P rompt I ndicat es t he prompt t hat was used.

P rompt A nswer I ndicat es t he answers f or t he prompt in various inst ances.

P rompt A nswer Required I ndicat es whet her an answer t o t he prompt was required.

I ndicat es t he answer of an inst ance of a prompt in a

P rompt I nst ance A nswer
report job.

P rompt Locat ion Indicates the ID of the location in which a prompt is stored.

Indicates the type of the object in which the prompt is stored, such
P rompt Locat ion Type
as filter, template, attribute, and so on.

I ndicat es t he t it le of t he prompt (t he t it le t he user sees

P rompt Tit le
when present ed during job execut ion).

I ndicat es what t ype of prompt was used, such as dat e,

P rompt Type
double, element s, and so on.

2169 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Report I ndicat es t he report t hat used t he prompt .

Report Job I ndicat es t he report job t hat used t he prompt .

RP Number of Jobs (I S _
Met ric of how many jobs involved a prompt .
P R_A NS _FA CT)

RP Number of Jobs
Met ric of how many report jobs had a specif ied prompt
Cont aining P rompt
answer value.
A nswer V alue

RP Number of Jobs Not

Met ric of how many report jobs did not have a specif ied
Cont aining P rompt
prompt answer value.
A nswer V alue

RP Number of Jobs wit h Met ric of how many report jobs had a prompt t hat was not
Unanswered P rompt s answered.

Report Job Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion is ad hoc.

Cache Creat ion I ndicat or I ndicat es whet her an execut ion has creat ed a cache.

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Cancelled I ndicat or I ndicat es whet her an execut ion has been canceled.

I ndicat es whet her a job was a document dat aset or a

Child Job I ndicat or
st andalone report .

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

© 2019, M icr o St r at egy In c. 2170

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

I ndicat es whet her a report request f ailed because of a

Dat abase E rror I ndicat or
dat abase error.

Dat amart I ndicat or I ndicat es whet her an execut ion creat ed a dat a mart .

Day I ndicat es t he day on which t he report was execut ed.

I ndicat es t he dat abase inst ance on which t he report was

DB I nst ance
execut ed.

Drill I ndicat or I ndicat es whet her an execut ion is a result of a drill.

I ndicat es whet her an execut ion is a result of an element

E lement Load I ndicat or
load.

E rror I ndicat or I ndicat es whet her an execut ion encount ered an error.

I ndicat es whet her a report was export ed and, if so,

E xport I ndicat or
indicat es it s f ormat .

Filt er I ndicat es t he f ilt er used on t he report .

Hour I ndicat es t he hour on which t he report was execut ed.

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he report .

Met adat a I ndicat es t he met adat a reposit ory t hat st ores t he report .

I ndicat es t he minut e on which t he report execut ion was

Minut e
st art ed.

Number of Jobs wit h Met ric of how many job execut ions used an I nt elligent
I nt elligent Cube Hit Cube.

P roject I ndicat es t he met adat a reposit ory t hat st ores t he report .

P rompt I ndicat or I ndicat es whet her t he report execut ion was prompt ed.

Report I ndicat es t he I D of t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

2171 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP A verage E lapsed
Met ric of t he average dif f erence bet ween st art t ime and
Durat ion per Job
f inish t ime (including t ime f or prompt responses) of all
(hh: mm: ss) (I S _RE P _
report job execut ions.
FA CT)

RP A verage E lapsed Met ric of t he average dif f erence bet ween st art t ime and
Durat ion per Job (secs) f inish t ime (including t ime f or prompt responses) of all
(I S _RE P _FA CT) report job execut ions.

RP A verage E xecut ion

Durat ion per Job Met ric of t he average durat ion of all report job execut ions.
(hh: mm: ss) (I S _RE P _ I ncludes t ime in queue and execut ion f or a report job.
FA CT)

RP A verage E xecut ion Met ric of t he average durat ion, in seconds, of all report
Durat ion per Job (secs) job execut ions. I ncludes t ime in queue and execut ion f or
(I S _RE P _FA CT) a report job.

RP A verage P rompt
Met ric of t he average t ime users t ake t o answer t he set of
A nswer Time per Job
prompt s in all report jobs.
(hh: mm: ss)

RP A verage P rompt
Met ric of t he average t ime, in seconds, users t ake t o
A nswer Time per Job
answer t he set of prompt s in all report jobs.
(secs)

RP A verage Queue
Met ric of t he average t ime report jobs wait ed in t he
Durat ion per Job
I nt elligence S erver's queue bef ore t he report job was
(hh: mm: ss) (I S _RE P _
execut ed.
FA CT)

RP A verage Queue Met ric of t he average t ime, in seconds, report jobs wait ed
Durat ion per Job (secs) in t he I nt elligence S erver's queue bef ore t he report job
(I S _RE P _FA CT) was execut ed.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E lapsed Durat ion
of a report job. I ncludes t ime f or prompt responses, in
(hh: mm: ss)
queue, and execut ion.

© 2019, M icr o St r at egy In c. 2172

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E lapsed Durat ion
and f inish t ime of a report job. I ncludes t ime f or prompt
(secs)
responses, in queue, and execut ion.

RP E xecut ion Durat ion Met ric of t he durat ion of a report job's execut ion. I ncludes
(hh: mm: ss) dat abase execut ion t ime.

RP E xecut ion Durat ion Met ric of t he durat ion, in seconds, of a report job's
(secs) execut ion. I ncludes dat abase execut ion t ime.

RP Number of A d Hoc Met ric of how many report jobs result ed f rom an ad hoc
Jobs report creat ion.

RP Number of Cancelled
Met ric of how many job execut ions were canceled.
Jobs

Met ric of how many job execut ions result ed f rom a drill
RP Number of Drill Jobs
act ion.

RP Number of Jobs (I S _
Met ric of how many report jobs were execut ed.
RE P _FA CT)

RP Number of Jobs Met ric of how many report jobs were execut ed against t he
hit t ing Dat abase dat abase.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
Cache Creat ion result in creat ing a server cache.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
Cache Hit hit a server cache.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
E lement Loading result f rom loading addit ional at t ribut e element s.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
Cache Creat ion result ed in a server cache being creat ed.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat hit a
Cache Hit server cache.

2173 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
Dat amart Creat ion result ed in a dat a mart being creat ed.

RP Number of Jobs wit h Met ric of how many report jobs f ailed because of a
DB E rror dat abase error.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
E lement Loading result ed f rom loading addit ional at t ribut e element s.

RP Number of Jobs wit h

Met ric of how many report jobs f ailed because of an error.
E rror

RP Number of Jobs wit h Met ric of how many report job execut ions used an
I nt elligent Cube Hit I nt elligent Cube.

RP Number of Jobs wit h Met ric of how many report job execut ions used a securit y
S ecurit y Filt er f ilt er.

RP Number of Jobs wit h

Met ric of how many report jobs execut ed S QL st at ement s.
S QL E xecut ion

RP number of Met ric of how many report job execut ions were run
Narrowcast S erver jobs t hrough MicroS t rat egy Narrowcast S erver.

RP Number of P rompt ed Met ric of how many report job execut ions included a
Jobs prompt .

RP Number of Report
Met ric of how many report jobs execut ed as a result of a
Jobs f rom Document
document execut ion.
E xecut ion

RP Number of Result Met ric of how many result rows were ret urned f rom a
Rows report execut ion.

RP Number of
Met ric of how many report jobs were scheduled.
S cheduled Jobs

RP Number of Users who

Met ric of how many dist inct users ran report jobs.
ran report s

© 2019, M icr o St r at egy In c. 2174

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP P rompt A nswer Met ric of t he how long users t ake t o answer t he set of
Durat ion (hh: mm: ss) prompt s in report jobs.

RP P rompt A nswer Met ric of t he how long, in seconds, users t ake t o answer
Durat ion (secs) t he set of prompt s in report jobs.

RP Queue Durat ion Met ric of how long a report job wait ed in t he I nt elligence
(hh: mm: ss) S erver's queue bef ore t he report job was execut ed.

Met ric of how long, in seconds, a report job wait ed in t he

RP Queue Durat ion
I nt elligence S erver's queue bef ore t he report job was
(secs)
execut ed.

S chedule I ndicat es t he schedule t hat began t he report execut ion.

S chedule I ndicat or I ndicat es whet her t he report execut ion was scheduled.

S ecurit y Filt er I ndicat es t he securit y f ilt er used in t he report execut ion.

I ndicat es whet her a securit y f ilt er was used in t he report

S ecurit y Filt er I ndicat or
execut ion.

S QL E xecut ion I ndicat or I ndicat es t hat S QL was execut ed during report execut ion.

Templat e I ndicat es t he report t emplat e t hat was used.

User I ndicat es t he user t hat ran t he report .

Report Job SQL Pass Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her t he execut ion was ad hoc.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

Day I ndicat es t he day in which t he job was execut ed.

2175 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Hour I ndicat es t he hour in which t he report job was execut ed.

I ndicat es t he met adat a reposit ory st oring t he report or

Met adat a
document .

Minut e I ndicat es t he minut e in which t he report job was st art ed.

P roject I ndicat es t he project st oring t he report or document .

Report I ndicat es t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

I ndicat es t he S QL st at ement t hat was execut ed during t he

Report Job S QL P ass
S QL pass.

I ndicat es t he t ype of S QL st at ement t hat was execut ed in

Report Job S QL P ass
t his S QL pass. E xamples are S QL select , S QL insert ,
Type
S QL creat e and such.

RP E xecut ion Durat ion Met ric of t he durat ion of a report job's execut ion. I ncludes
(hh: mm: ss) dat abase execut ion t ime.

RP E xecut ion Durat ion Met ric of t he durat ion, in seconds, of a report job's
(secs) execut ion. I ncludes dat abase execut ion t ime.

RP Last E xecut ion Finish Met ric of t he f inish t imest amp when t he report job was
Timest amp last execut ed.

RP Last E xecut ion S t art Met ric of t he st art t imest amp when t he report job was last
Timest amp execut ed.

RP Number of DB Tables Met ric of how many dat abase t ables were accessed in a
A ccessed report job execut ion.

Met ric of how large, in byt es, t he S QL was f or a report

RP S QL S ize
job.

© 2019, M icr o St r at egy In c. 2176

Syst em Ad m in ist r at io n Gu id e

Report Job Steps Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion was ad hoc.

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

Day I ndicat es t he day in which t he job was execut ed.

Hour I ndicat es t he hour in which t he report job was execut ed.

Minut e I ndicat es t he minut e in which t he report job was st art ed.

Report I ndicat es t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

I ndicat es t he sequence number in t he series of execut ion

Report Job S t ep
st eps a report job passes t hrough in t he I nt elligence
S equence
S erver.

I ndicat es t he t ype of st ep f or a report job. E xamples are

S QL generat ion, S QL execut ion, A nalyt ical E ngine,
Report Job S t ep Type
Resolut ion S erver, element request , updat e I nt elligent
Cube, and so on.

RP A verage CP U
E xecut ion Durat ion per Met ric of t he average durat ion, in milliseconds, a report
Job (msecs) (I S _RE P _ job execut ion t akes in t he I nt elligence S erver CP U.
S TE P _FA CT)

RP A verage E lapsed Met ric of t he average dif f erence, in seconds, bet ween
Durat ion per Job (secs) st art t ime and f inish t ime of report job execut ions.
(I S _RE P _S TE P _FA CT) I ncludes t ime f or prompt responses.

RP A verage E xecut ion Met ric of t he average dif f erence, in seconds, bet ween

2177 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Durat ion per Job (secs) st art t ime and f inish t ime of report job execut ions.
(I S _RE P _S TE P _FA CT) I ncludes t ime f or prompt responses.

RP A verage Query
E ngine E xecut ion Met ric of t he average t ime, in seconds, t he Query E ngine
Durat ion per Job (secs) t akes t o process a report job.
(I S _RE P _S TE P _FA CT)

RP A verage Queue Met ric of t he average t ime report jobs wait ed in t he

Durat ion per Job (secs) I nt elligence S erver's queue bef ore t he report job was
(I S _RE P _S TE P _FA CT) execut ed.

Met ric of how long, in milliseconds, a report job execut ion

RP CP U Durat ion (msec)
t akes in t he I nt elligence S erver CP U.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E lapsed Durat ion
of report job execut ions. I ncludes t ime f or prompt
(hh: mm: ss)
responses.

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E lapsed Durat ion
and f inish t ime of report job execut ions. I ncludes t ime f or
(secs)
prompt responses.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E xecut ion Durat ion
of report job execut ions. I ncludes dat abase execut ion
(hh: mm: ss)
t ime.

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E xecut ion Durat ion
and f inish t ime of report job execut ions. I ncludes
(secs)
dat abase execut ion t ime.

RP Last E xecut ion Finish Met ric of t he f inish t imest amp when t he report job was
Timest amp last execut ed.

RP Last E xecut ion S t art Met ric of t he st art t imest amp when t he report job was last
Timest amp execut ed.

RP Number of Jobs (I S _
Met ric of how many report jobs were execut ed.
RE P _S TE P _FA CT)

© 2019, M icr o St r at egy In c. 2178

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP Query E ngine
Met ric of how long t he Query E ngine t ook t o execut e S QL
Durat ion (hh: mm: ss)
f or a report job.
(I S _RE P _S TE P _FA CT)

RP Query E ngine
Met ric of t he t ime, in seconds, t he Query E ngine t akes t o
Durat ion (secs) (I S _
execut e S QL f or a report job.
RE P _S TE P _FA CT)

RP Queue Durat ion Met ric of how long a report job wait ed in t he I nt elligence
(hh: mm: ss) S erver's queue bef ore t he report job was execut ed.

Met ric of how long, in seconds, a report job wait ed in t he

RP Queue Durat ion
I nt elligence S erver's queue bef ore t he report job was
(secs)
execut ed.

RP S QL E ngine Durat ion

Met ric of how long t he S QL E ngine t ook t o generat e S QL
(hh: mm: ss) (I S _RE P _
f or a report job.
S TE P _FA CT)

Report Job Tables/Columns Accessed Attributes and

Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion was ad hoc.

Column I ndicat es t he column t hat was accessed.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es t he day on which t he t able column was

Day
accessed.

I ndicat es t he t able in t he dat abase st oring t he column

DB Table
t hat was accessed.

2179 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

I ndicat es t he hour on which t he t able column was

Hour
accessed.

I ndicat es t he minut e on which t he t able column was

Minut e
accessed.

Report I ndicat es t he report t hat accessed t he t able column.

I ndicat es which execut ion of a report accessed t he t able

Report Job
column.

Met ric of how many report jobs accessed t he dat abase

RP Number of Jobs (I S _
column or t able. The Warehouse Tables A ccessed report
RE P _COL_FA CT)
uses t his met ric.

I ndicat es which t ype of S QL clause was used t o access

S QL Clause Type
t he t able column.

Schema Objects Attributes

Attrib u te
F u n ctio n
n ame

List s all at t ribut es in project s t hat are set up t o be monit ored by

A t t ribut e
E nt erprise Manager.

List s all at t ribut e f orms in project s t hat are set up t o be monit ored
A t t ribut e Form
by E nt erprise Manager.

List s all columns in project s t hat are set up t o be monit ored by

Column
E nt erprise Manager.

List s all physical t ables in t he dat a warehouse t hat are set up t o be

DB Table
monit ored by E nt erprise Manager.

List s all f act s in project s t hat are set up t o be monit ored by

Fact
E nt erprise Manager.

© 2019, M icr o St r at egy In c. 2180

Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s all hierarchies in project s t hat are set up t o be monit ored by

Hierarchy
E nt erprise Manager

List s all logical t ables in project s t hat are set up t o be monit ored by
Table
E nt erprise Manager.

List s all t ransf ormat ions in project s t hat are set up t o be monit ored
Transf ormat ion
by E nt erprise Manager.

Server Machines Attributes

Attrib u te n ame F u n ctio n

List s all machines t hat have had users connect t o t he

Client Machine
I nt elligence S erver.

I nt elligence S erver
List s t he clust er of I nt elligence S ervers.
Clust er

I nt elligence S erver List s all machines t hat have logged st at ist ics as an
Machine I nt elligence S erver.

Web S erver Machine List s all machines used as web servers.

Session Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A vg. Connect ion Met ric of t he average t ime connect ions t o an I nt elligence
Durat ion (hh: mm: ss) S erver last .

A vg. Connect ion Met ric of t he average t ime, in seconds, connect ions t o an
Durat ion (secs) I nt elligence S erver last .

2181 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Connect ion Durat ion Met ric of t he t ime a connect ion t o an I nt elligence S erver
(hh: mm: ss) last s.

Connect ion Durat ion Met ric of t he t ime, in seconds, a connect ion t o an
(secs) I nt elligence S erver last s.

Connect ion S ource List s all connect ion sources t o I nt elligence S erver.

Met ric of how many sessions were connect ed t o an

Number of S essions
I nt elligence S erver. Usually report ed wit h a dat e and t ime
(Report Level)
at t ribut e.

Met ric of how many dist inct users were connect ed t o an

Number of Users Logged
I nt elligence S erver. Usually report ed wit h a dat e and t ime
I n (Report Level)
at t ribut e.

S ession I ndicat es a user connect ion t o an I nt elligence S erver.

All Indicators and Flags Attributes

Attrib u te n ame F u n ctio n

A d Hoc I ndicat or I ndicat es whet her an execut ion is ad hoc.

Cache Creat ion

I ndicat es whet her an execut ion has creat ed a cache.
I ndicat or

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Cancelled I ndicat or I ndicat es whet her an execut ion has been cancelled.

I ndicat es whet her a job was a document dat aset or a st and-

Child Job I ndicat or
alone report .

Conf igurat ion Object

I ndicat es whet her a conf igurat ion object exist s.
E xist s S t at us

Conf igurat ion List s all conf igurat ion paramet er t ypes.

© 2019, M icr o St r at egy In c. 2182

Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

P aramet er V alue Type

Connect ion S ource List s all connect ion sources t o I nt elligence S erver.

Cont act Type List s t he execut ed cont act t ypes.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

Dat abase E rror I ndicat es whet her a report request f ailed because of a
I ndicat or dat abase error.

Dat amart I ndicat or I ndicat es whet her an execut ion creat ed a dat a mart .

I ndicat es whet her an execut ion encount ered a dat abase

DB E rror I ndicat or
error.

Delivery S t at us
I ndicat es whet her a delivery was successf ul.
I ndicat or

Delivery Type List s t he t ype of delivery.

Document Job S t at us
List s t he st at uses of document execut ions.
(Deprecat ed)

Document Job S t ep
List s all possible st eps of document job execut ion.
Type

I ndicat es t he t ype of a document or dossier, such as HTML

Document Type
document , Report S ervices document , or a dossier.

List s t he object f rom which a user drilled when a new report

Drill f rom Object
was run because of a drilling act ion.

Drill I ndicat or I ndicat es whet her an execut ion is a result of a drill.

List s t he object t o which a user drilled when a new report

Drill t o Object
was run because of a drilling act ion.

I ndicat es whet her an execut ion is a result of an element

E lement Load I ndicat or
load.

2183 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

E rror I ndicat or I ndicat es whet her an execut ion encount ered an error.

E xecut ion Type I ndicat es how t he cont ent was request ed, such as User
I ndicat or E xecut ion, P re-Cached, A pplicat ion Recovery, and so on.

I ndicat es whet her a report was export ed and, if so,

E xport I ndicat or
indicat es it s f ormat .

Hierarchy Drilling I ndicat es whet her a hierarchy is used as a drill hierarchy.

List t he t ypes of manipulat ions t hat can be perf ormed on a

I nbox A ct ion Type
Hist ory List message.

I nt elligent Cube A ct ion

List s act ions perf ormed on or against int elligent cubes.
Type

I nt elligent Cube Type List s all int elligent cube t ypes.

List s all t he possible errors t hat can be ret urned during job
Job E rrorCode
execut ions.

Job P riorit y Map List s t he priorit ies of job execut ions.

E numerat es t he upper limit of t he priorit y ranges f or high,

Job P riorit y Number medium, and low priorit y jobs. Def ault values are 332, 666,
and 999.

Object Creat ion Dat e I ndicat es t he dat e on which an object was creat ed.

Object Creat ion I ndicat es t he week of t he year in which an object was

Week of year creat ed.

Object E xist s S t at us I ndicat es whet her an object exist s.

Object Hidden S t at us I ndicat es whet her an object is hidden.

Object Modif icat ion

I ndicat es t he dat e on which an object was last modif ied.
Dat e

Object Modif icat ion I ndicat es t he week of t he year in which an object was last
Week of year modif ied.

P rompt A nswer I ndicat es whet her a prompt answer was required f or t he job

© 2019, M icr o St r at egy In c. 2184

Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

Required execut ion.

P rompt I ndicat or I ndicat es whet her a job execut ion was prompt ed.

Report Job S QL P ass List s t he t ypes of S QL passes t hat t he I nt elligence S erver

Type generat es.

Report Job S t at us
List s t he st at uses of report execut ions.
(Deprecat ed)

Report Job S t ep Type List s all possible st eps of report job execut ion.

I ndicat es t he t ype of a report , such as X DA , relat ional, and

Report Type
so on.

Report / Document I ndicat es whet her t he execut ion was a report or a

I ndicat or document .

S chedule I ndicat or I ndicat es whet her a job execut ion was scheduled.

S ecurit y Filt er I ndicat es whet her a securit y f ilt er was used in t he job
I ndicat or execut ion.

S QL Clause Type List s t he various S QL clause t ypes used by t he S QL E ngine.

S QL E xecut ion
I ndicat es whet her S QL was execut ed in t he job execut ion.
I ndicat or

Application Objects Attributes

Attrib u te
F u n ctio n
n ame

List s all consolidat ions in project s t hat are set up t o be monit ored
Consolidat ion
by E nt erprise Manager.

List s all cust om groups in project s t hat are set up t o be monit ored
Cust om Group
by E nt erprise Manager.

2185 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s all document s in project s t hat are set up t o be monit ored by

Document
E nt erprise Manager.

List s all f ilt ers in project s t hat are set up t o be monit ored by
Filt er
E nt erprise Manager.

I nt elligent List s all int elligent cubes in project s t hat are set up t o be
Cube monit ored by E nt erprise Manager.

List s all met rics in project s t hat are set up t o be monit ored by
Met ric
E nt erprise Manager.

List s all prompt s in project s t hat are set up t o be monit ored by

P rompt
E nt erprise Manager.

List s all report s in project s t hat are set up t o be monit ored by

Report
E nt erprise Manager.

List s all securit y f ilt ers in project s t hat are set up t o be monit ored
S ecurit y Filt er
by E nt erprise Manager.

List s all t emplat es in project s t hat are set up t o be monit ored by

Templat e
E nt erprise Manager.

Configuration Objects Attributes

Attrib u te n ame F u n ctio n

A ddress List s all addresses t o which deliveries have been sent .

Conf igurat ion Object

List s t he owners of conf igurat ion object s.
Owner

Conf igurat ion

List s all conf igurat ion paramet ers.
P aramet er

Cont act List s all cont act s t o whom deliveries have been sent .

© 2019, M icr o St r at egy In c. 2186

Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

DB Connect ion List s all dat abase connect ions.

DB I nst ance List s all dat abase inst ances.

Device List s all devices t o which deliveries have been sent .

E vent List s all event s being t racked.

Folder List s all f olders wit hin project s.

I nt elligence S erver
List s all I nt elligence S erver def init ions.
Def init ion

Met adat a List s all monit ored met adat a.

Owner List s t he owners of all object s.

P roject List s all project s.

S chedule List s all schedules.

S ubscript ion List s all execut ed t ransmissions.

Transmit t er List s all t ransmit t ers.

User List s all users being t racked.

User Group List s all user groups.

User Group (P arent ) List s all user groups t hat are parent s of ot her user groups.

Date and Time Attributes

Attrib u te
F u n ctio n
n ame

Calendar List s every calendar week, beginning wit h 2000-01-01, as an

Week int eger.

Day List s all days, beginning in 1990.

2187 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s t he hours in a day. For example, 09 A M - 10 A M, 10 A M - 11

Hour
A M, and so on.

List s all t he minut es in an hour. For example, if t he hour specif ied is

Minut e 10 A M - 11 A M, list s minut es as 10. 30 A M - 10. 31 A M, 10. 32 A M -
10. 33 A M, and so on.

Mont h List s all mont hs, beginning wit h 2000.

Mont h of Y ear List s all mont hs in a specif ied year.

Quart er List s all quart ers.

Quart er of
List s all quart ers of t he year.
Y ear

List s all weeks in all years, beginning in 2000. Weeks in 2000 are
represent ed as a number ranging f rom 200001 t o 200053, weeks in
Week of Y ear
2001 are represent ed as a number ranging f rom 200101 t o 200153,
and so on.

Weekday List s all days of t he week.

Y ear List s all years.

Delivery Services Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

A ddress I ndicat es t he address t o which a delivery was sent .

A vg number of recipient s per Met ric of t he average number of recipient s in

subscript ion subscript ions.

A vg S ubscript ion E xecut ion Met ric of t he average amount of t ime subscript ions
Durat ion (hh: mm: ss) t ake t o execut e.

A vg S ubscript ion E xecut ion Met ric of t he average amount of t ime, in seconds,

© 2019, M icr o St r at egy In c. 2188

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Durat ion (secs) subscript ions t ake t o execut e.

Cont act I ndicat es all cont act s t o whom a delivery was sent .

Cont act Type I ndicat es t he execut ed cont act t ypes.

Day I ndicat es t he day on which t he delivery was sent .

Delivery S t at us I ndicat or I ndicat es whet her t he delivery was successf ul.

Delivery Type I ndicat es t he t ype of delivery.

I ndicat es t he t ype of device t o which t he delivery

Device
was sent .

Document I ndicat es t he document t hat was delivered.

Hour I ndicat es t he hour on which t he delivery was sent .

I ndicat es t he I nt elligence S erver machine t hat

I nt elligence S erver Machine
execut ed t he job.

Met adat a I ndicat es t he monit ored met adat a.

I ndicat es t he minut e on which t he delivery was

Minut e
sent .

Number of Dist inct Document Met ric of t he number of report services document
S ubscript ions subscript ions.

Met ric of t he number of recipient s t hat received

Number of Dist inct Recipient s
cont ent f rom a subscript ion.

Number of Dist inct Report

Met ric of t he number of report subscript ions.
S ubscript ions

Met ric of t he number of execut ed subscript ions.

Number of Dist inct
This does not ref lect t he number of subscript ions
S ubscript ions
in t he met adat a.

Met ric of t he number of subscript ions t hat

Number of E -mail S ubscript ions
delivered cont ent via e-mail.

2189 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Number of E rrored
Met ric of t he number of subscript ions t hat f ailed.
S ubscript ions

Met ric of t he number of execut ions of a

Number of E xecut ions
subscript ion.

Met ric of t he number of subscript ions t hat

Number of File S ubscript ions
delivered cont ent via f ile locat ion.

Number of Hist ory List Met ric of t he number of subscript ions t hat
S ubscript ions delivered cont ent via t he hist ory list .

Met ric of t he number of subscript ions t hat

Number of Mobile S ubscript ions
delivered cont ent via mobile.

Met ric of t he number of subscript ions t hat

Number of P rint S ubscript ions
delivered cont ent via a print er.

P roject List s t he project s.

Report List s t he report s in project s.

Report Job List s an execut ion of a report .

I ndicat es whet her t he execut ion was a report or a

Report / Document I ndicat or
document .

S chedule I ndicat es t he schedule t hat t riggered t he delivery.

I ndicat es t he subscript ion t hat t riggered t he

S ubscript ion
delivery.

S ubscript ion E xecut ion Met ric of t he sum of all execut ion t imes of a
Durat ion (hh: mm: ss) subscript ion.

S ubscript ion E xecut ion Durat ion Met ric of t he sum of all execut ion t imes of a
(secs) subscript ion (in seconds).

© 2019, M icr o St r at egy In c. 2190

Syst em Ad m in ist r at io n Gu id e

Document Job Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

I ndicat es t he day on which t he document job

Day
execut ed.

Document I ndicat es which document was execut ed.

Document Job I ndicat es an execut ion of a document .

Met ric of t he average dif f erence bet ween st art t ime

DP A verage E lapsed Durat ion
and f inish t ime (including t ime f or prompt
per Job (hh: mm: ss)
responses) of all document job execut ions.

Met ric of t he average dif f erence, in seconds,

DP A verage E lapsed Durat ion bet ween st art t ime and f inish t ime (including t ime
per Job (secs) f or prompt responses) of all document job
execut ions.

DP A verage E xecut ion Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions.

DP A verage E xecut ion Met ric of t he average durat ion of all document job
Durat ion per Job (hh: mm: ss) execut ions.

DP A verage Queue Durat ion Met ric of t he average durat ion of all document job
per Job (hh: mm: ss) execut ions wait ing in t he queue.

DP A verage Queue Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions wait ing in t he queue.

Met ric of t he dif f erence bet ween st art t ime and

DP E lapsed Durat ion
f inish t ime (including t ime f or prompt responses) of
(hh: mm: ss)
a document job.

Met ric of t he average dif f erence, in seconds,

DP E lapsed Durat ion (secs) bet ween st art t ime and f inish t ime (including t ime
f or prompt responses) of a document job.

DP E xecut ion Durat ion Met ric of t he durat ion of a document job's
(hh: mm: ss) execut ion.

2191 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Met ric of t he durat ion, in seconds, of a document

DP E xecut ion Durat ion (secs)
job's execut ion.

DP Number of Jobs (I S _DOC_ Met ric of t he number of document jobs t hat were
FA CT) execut ed.

DP Number of Jobs wit h Cache Met ric of t he number of document jobs t hat hit a
Hit cache.

DP Number of Jobs wit h E rror Met ric of t he number of document jobs t hat f ailed.

DP Number of Users who ran Met ric of t he number of users who ran document
Document s jobs.

DP P ercent age of Jobs wit h Met ric of t he percent age of document jobs t hat hit
Cache Hit a cache.

DP P ercent age of Jobs wit h Met ric of t he percent age of document jobs t hat
E rror f ailed.

Met ric of t he durat ion of all document job

DP Queue Durat ion (hh: mm: ss)
execut ions wait ing in t he queue.

Met ric of t he durat ion, in seconds, of all document

DP Queue Durat ion (secs)
job execut ions wait ing in t he queue.

Hour I ndicat es t he hour t he document job was execut ed.

I ndicat es t he I nt elligence S erver machine t hat

I nt elligence S erver Machine
execut ed t he document job.

Met adat a I ndicat es t he met adat a st oring t he document .

I ndicat es t he minut e t he document job was

Minut e
execut ed.

P roject I ndicat es t he project st oring t he document .

Report I ndicat es t he report s in t he document .

User I ndicat es t he user who ran t he document job.

© 2019, M icr o St r at egy In c. 2192

Syst em Ad m in ist r at io n Gu id e

Document Job Step Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

I ndicat es t he day on which t he document job

Day
execut ed.

Document I ndicat es which document was execut ed.

I ndicat es t he sequence number f or st eps in a

Document Job S t ep S equence
document job.

Document Job S t ep Type I ndicat es t he t ype of st ep f or a document job.

Met ric of t he average dif f erence bet ween st art t ime

DP A verage E lapsed Durat ion
and f inish t ime (including t ime f or prompt
per Job (hh: mm: ss)
responses) of all document job execut ions.

Met ric of t he average dif f erence, in seconds,

DP A verage E lapsed Durat ion bet ween st art t ime and f inish t ime (including t ime
per Job (secs) f or prompt responses) of all document job
execut ions.

DP A verage E xecut ion Met ric of t he average durat ion of all document job
Durat ion per Job (hh: mm: ss) execut ions.

DP A verage E xecut ion Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions.

DP A verage Queue Durat ion Met ric of t he average durat ion of all document job
per Job (hh: mm: ss) execut ions wait ing in t he queue.

DP A verage Queue Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions wait ing in t he queue.

Met ric of t he dif f erence bet ween st art t ime and

DP E lapsed Durat ion
f inish t ime (including t ime f or prompt responses) of
(hh: mm: ss)
a document job.

Met ric of t he average dif f erence, in seconds,

DP E lapsed Durat ion (secs) bet ween st art t ime and f inish t ime (including t ime
f or prompt responses) of a document job.

2193 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

DP E xecut ion Durat ion Met ric of t he durat ion of a document job's
(hh: mm: ss) execut ion.

Met ric of t he durat ion, in seconds, of a document

DP E xecut ion Durat ion (secs)
job's execut ion.

Met ric of t he durat ion of all document job

DP Queue Durat ion (hh: mm: ss)
execut ions wait ing in t he queue.

Met ric of t he durat ion, in seconds, of all document

DP Queue Durat ion (secs)
job execut ions wait ing in t he queue.

Hour I ndicat es t he hour t he document job was execut ed.

Met adat a I ndicat es t he met adat a st oring t he document .

I ndicat es t he minut e t he document job was

Minut e
execut ed.

P roject I ndicat es t he project st oring t he document .

Enterprise Manager Data Load Attributes

Attrib u te n ame F u n ctio n

Dat a Load Finish Displays t he t imest amp of t he end of t he dat a load process
Time f or t he project s t hat are being monit ored.

Dat a Load P roject List s all project s t hat are being monit ored.

List s t he t imest amp of t he st art of t he dat a load process f or

Dat a Load S t art Time
t he project s t hat are being monit ored.

A value of -1 indicat es t hat it is t he summary row in t he E M_

I S _LA S T_UP DA TE t able f or all project s in a dat a load. That
I t em I D summary row has inf ormat ion about how long t he dat a load
t ook. A value of 0 indicat es it is a row wit h project dat a load
det ails.

© 2019, M icr o St r at egy In c. 2194

Syst em Ad m in ist r at io n Gu id e

Inbox Message Actions Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Day I ndicat es t he day t he manipulat ion was st art ed

Document I ndicat es t he document included in t he message.

I ndicat es t he document job t hat request ed t he Hist ory

Document Job
List message manipulat ion.

HL Days S ince Last Met ric of t he number of days since any act ion was
A ct ion: A ny act ion perf ormed.

HL Days S ince Last Met ric of t he number of days since t he last request was
A ct ion: Request made f or t he cont ent s of a message.

Met ric of t he dat e and t ime of t he last act ion perf ormed
HL Last A ct ion Dat e: A ny
on a message such as read, delet ed, marked as read, and
A ct ion
so on.

HL Last A ct ion Dat e: Met ric of t he dat e and t ime of t he last request made f or
Request t he cont ent s of a message.

HL Number of A ct ions Met ric of t he number of act ions perf ormed on a message.

HL Number of A ct ions by Met ric of t he number of act ions by user perf ormed on a
User message.

HL Number of A ct ions Met ric of t he number of act ions on a message t hat

wit h E rrors result ed in an error.

HL Number of Document Met ric of t he number of document jobs t hat result wit h
Jobs messages.

HL Number of Messages Met ric of t he number of messages.

HL Number of Messages Met ric of t he number of messages t hat result ed in an

wit h E rrors error.

HL Number of Messages Met ric of t he number of request s f or t he cont ent s of a

Request ed message.

2195 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

HL Number of Report Met ric of t he number of report jobs t hat result f rom
Jobs messages.

I ndicat es t he hour t he manipulat ion was st art ed on a

Hour
Hist ory List message.

I ndicat es t he manipulat ion t hat was perf ormed on a

I nbox A ct ion
Hist ory List message.

I ndicat es t he t ype of manipulat ion t hat was perf ormed on

I nbox A ct ion Type
a Hist ory List message.

I nbox Message I ndicat es t he message in t he Hist ory List .

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he message.

Met adat a I ndicat es t he met adat a st oring t he message.

Minut e I ndicat es t he minut e t he manipulat ion was st art ed.

P roject I ndicat es t he project st oring t he message.

Report I ndicat es t he report included in t he message.

I ndicat es t he job I D of t he report included in t he

Report Job
message.

I ndicat es t he user who manipulat ed t he Hist ory List

User
message.

Mobile Client Attributes

Attrib u te n ame F u n ctio n

I ndicat es whet her a cache was hit during t he execut ion

Cache Hit I ndicat or
and, if so, what t ype of cache hit .

© 2019, M icr o St r at egy In c. 2196

Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

Day I ndicat es t he day t he act ion st art ed.

Document I dent if ies t he document used in t he request .

I ndicat es t he t ype of report or document t hat init iat ed t he

E xecut ion Type I ndicat or
execut ion.

I ndicat es t he locat ion, in lat it ude and longit ude f orm, of

Geocode
t he user.

Hour I ndicat es t he hour t he act ion st art ed.

I nt elligence S erver
I ndicat es t he I nt elligence S erver processing t he request .
Machine

I ndicat es t he met adat a reposit ory st oring t he report or

Met adat a
document .

Minut e I ndicat es t he minut e t he act ion st art ed.

Mobile Device
I ndicat es t he unique I nst allat ion I D of t he mobile app.
I nst allat ion I D

I ndicat es t he t ype of mobile device t he app is inst alled

Mobile Device Type
on, such as I P A D2, DROI D, and so on.

I ndicat es t he version of t he MicroS t rat egy app making t he

MS TR A pp V ersion
request .

I ndicat es t he t ype of net work used, such as 3G, WI FI ,

Net work Type
LTE , and so on.

I ndicat es t he operat ing syst em of t he mobile device

Operat ing S yst em
making t he request .

Operat ing S yst em I ndicat es t he operat ing syst em version of t he mobile

V ersion device making t he request .

P roject I ndicat es t he project used t o init iat e t he request .

User I ndicat es t he user t hat init iat ed t he request .

2197 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

OLAP Services Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Day I ndicat es t he day t he act ion was st art ed.

Hour I ndicat es t he hour t he act ion was st art ed.

I nt elligent Cube I ndicat es t he I nt elligent Cube t hat was used.

I nt elligent Cube A ct ion Met ric of t he durat ion, in seconds, f or an act ion t hat was
Durat ion (secs) perf ormed on t he I nt ellgent Cube.

I nt elligent Cube A ct ion I ndicat es t he t ype of act ion t aken on t he I nt elligent Cube
Type such as cube publish, cube view hit , and so on.

I ndicat es t he I nt elligent Cube inst ance in memory t hat

I nt elligent Cube I nst ance
was used f or t he act ion.

I nt elligent Cube S ize I f t he I nt elligent Cube is published or ref reshed, indicat es

(K B ) t he size, in K B , of t he I nt elligent Cube.

I ndicat es t he t ype of I nt elligent Cube used, such as

I nt elligent Cube Type working set report , Report S ervices B ase report , OLA P
Cube report , and so on.

Minut e I ndicat es t he minut e on which t he act ion was st art ed.

Met ric of how many jobs f rom report s not based on

Number of Dynamically
I nt elligent Cubes but select ed by t he engine t o go against
S ourced Report Jobs
an I nt elligent Cube because t he object s on t he report
against I nt elligent Cubes
mat ched what is on t he I nt elligent Cube.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube P ublishes published.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube Ref reshes ref reshed.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube Republishes republished.

© 2019, M icr o St r at egy In c. 2198

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Number of Jobs wit h Met ric of how many job execut ions used an I nt elligent
I nt elligent Cube Hit Cube.

Met ric of how many users execut ed a report or document

Number of Users hit t ing
t hat used an I nt elligent Cube. That is, t he number of
I nt elligent Cubes
users using OLA P S ervices.

Number of V iew Report Met ric of how many act ions were t he result of a V iew
Jobs Report .

Report I ndicat es t he report t hat hit t he I nt elligent Cube.

Performance Monitoring Attributes

Attrib u te n ame F u n ctio n

I ndicat es cat egory of t he count er, such as memory,

Count er Cat egory
MicroS t rat egy server jobs, or MicroS t rat egy server users.

I ndicat es t he inst ance I D of t he count er, f or MicroS t rat egy

Count er I nst ance
use.

Day I ndicat es t he day t he act ion was st art ed.

Hour I ndicat es t he hour t he act ion was st art ed.

Minut e I ndicat es t he minut e t he act ion was st art ed.

P erf ormance Monit or I ndicat es t he name of t he perf ormance count er and it s value
Count er t ype.

2199 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Prompt Answers Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Connect ion S ource Indicates the connection source to Intelligence Server.

Count of P rompt
Metric of how many prompts were answered.
A nswers

Day I ndicat es t he day t he prompt was answered.

Document I ndicat es t he document t hat used t he prompt .

Hour I ndicat es t he hour t he prompt was answered.

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he job.

Met adat a I ndicat es t he met adat a reposit ory st oring t he prompt .

Minut e I ndicat es t he minut e t he prompt was answered.

P roject I ndicat es t he project st oring t he prompt .

P rompt I ndicat es t he prompt t hat was used.

P rompt A nswer I ndicat es t he answers f or t he prompt in various inst ances.

P rompt A nswer Required I ndicat es whet her an answer t o t he prompt was required.

I ndicat es t he answer of an inst ance of a prompt in a

P rompt I nst ance A nswer
report job.

P rompt Locat ion Indicates the ID of the location in which a prompt is stored.

Indicates the type of the object in which the prompt is stored, such
P rompt Locat ion Type
as filter, template, attribute, and so on.

I ndicat es t he t it le of t he prompt (t he t it le t he user sees

P rompt Tit le
when present ed during job execut ion).

I ndicat es what t ype of prompt was used, such as dat e,

P rompt Type
double, element s, and so on.

© 2019, M icr o St r at egy In c. 2200

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Report I ndicat es t he report t hat used t he prompt .

Report Job I ndicat es t he report job t hat used t he prompt .

RP Number of Jobs (I S _
Met ric of how many jobs involved a prompt .
P R_A NS _FA CT)

RP Number of Jobs
Met ric of how many report jobs had a specif ied prompt
Cont aining P rompt
answer value.
A nswer V alue

RP Number of Jobs Not

Met ric of how many report jobs did not have a specif ied
Cont aining P rompt
prompt answer value.
A nswer V alue

RP Number of Jobs wit h Met ric of how many report jobs had a prompt t hat was not
Unanswered P rompt s answered.

Report Job Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion is ad hoc.

Cache Creat ion I ndicat or I ndicat es whet her an execut ion has creat ed a cache.

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Cancelled I ndicat or I ndicat es whet her an execut ion has been canceled.

I ndicat es whet her a job was a document dat aset or a

Child Job I ndicat or
st andalone report .

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

2201 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

I ndicat es whet her a report request f ailed because of a

Dat abase E rror I ndicat or
dat abase error.

Dat amart I ndicat or I ndicat es whet her an execut ion creat ed a dat a mart .

Day I ndicat es t he day on which t he report was execut ed.

I ndicat es t he dat abase inst ance on which t he report was

DB I nst ance
execut ed.

Drill I ndicat or I ndicat es whet her an execut ion is a result of a drill.

I ndicat es whet her an execut ion is a result of an element

E lement Load I ndicat or
load.

E rror I ndicat or I ndicat es whet her an execut ion encount ered an error.

I ndicat es whet her a report was export ed and, if so,

E xport I ndicat or
indicat es it s f ormat .

Filt er I ndicat es t he f ilt er used on t he report .

Hour I ndicat es t he hour on which t he report was execut ed.

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he report .

Met adat a I ndicat es t he met adat a reposit ory t hat st ores t he report .

I ndicat es t he minut e on which t he report execut ion was

Minut e
st art ed.

Number of Jobs wit h Met ric of how many job execut ions used an I nt elligent
I nt elligent Cube Hit Cube.

P roject I ndicat es t he met adat a reposit ory t hat st ores t he report .

P rompt I ndicat or I ndicat es whet her t he report execut ion was prompt ed.

Report I ndicat es t he I D of t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

© 2019, M icr o St r at egy In c. 2202

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP A verage E lapsed
Met ric of t he average dif f erence bet ween st art t ime and
Durat ion per Job
f inish t ime (including t ime f or prompt responses) of all
(hh: mm: ss) (I S _RE P _
report job execut ions.
FA CT)

RP A verage E lapsed Met ric of t he average dif f erence bet ween st art t ime and
Durat ion per Job (secs) f inish t ime (including t ime f or prompt responses) of all
(I S _RE P _FA CT) report job execut ions.

RP A verage E xecut ion

Durat ion per Job Met ric of t he average durat ion of all report job execut ions.
(hh: mm: ss) (I S _RE P _ I ncludes t ime in queue and execut ion f or a report job.
FA CT)

RP A verage E xecut ion Met ric of t he average durat ion, in seconds, of all report
Durat ion per Job (secs) job execut ions. I ncludes t ime in queue and execut ion f or
(I S _RE P _FA CT) a report job.

RP A verage P rompt
Met ric of t he average t ime users t ake t o answer t he set of
A nswer Time per Job
prompt s in all report jobs.
(hh: mm: ss)

RP A verage P rompt
Met ric of t he average t ime, in seconds, users t ake t o
A nswer Time per Job
answer t he set of prompt s in all report jobs.
(secs)

RP A verage Queue
Met ric of t he average t ime report jobs wait ed in t he
Durat ion per Job
I nt elligence S erver's queue bef ore t he report job was
(hh: mm: ss) (I S _RE P _
execut ed.
FA CT)

RP A verage Queue Met ric of t he average t ime, in seconds, report jobs wait ed
Durat ion per Job (secs) in t he I nt elligence S erver's queue bef ore t he report job
(I S _RE P _FA CT) was execut ed.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E lapsed Durat ion
of a report job. I ncludes t ime f or prompt responses, in
(hh: mm: ss)
queue, and execut ion.

2203 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E lapsed Durat ion
and f inish t ime of a report job. I ncludes t ime f or prompt
(secs)
responses, in queue, and execut ion.

RP E xecut ion Durat ion Met ric of t he durat ion of a report job's execut ion. I ncludes
(hh: mm: ss) dat abase execut ion t ime.

RP E xecut ion Durat ion Met ric of t he durat ion, in seconds, of a report job's
(secs) execut ion. I ncludes dat abase execut ion t ime.

RP Number of A d Hoc Met ric of how many report jobs result ed f rom an ad hoc
Jobs report creat ion.

RP Number of Cancelled
Met ric of how many job execut ions were canceled.
Jobs

Met ric of how many job execut ions result ed f rom a drill
RP Number of Drill Jobs
act ion.

RP Number of Jobs (I S _
Met ric of how many report jobs were execut ed.
RE P _FA CT)

RP Number of Jobs Met ric of how many report jobs were execut ed against t he
hit t ing Dat abase dat abase.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
Cache Creat ion result in creat ing a server cache.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
Cache Hit hit a server cache.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
E lement Loading result f rom loading addit ional at t ribut e element s.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
Cache Creat ion result ed in a server cache being creat ed.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat hit a
Cache Hit server cache.

© 2019, M icr o St r at egy In c. 2204

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
Dat amart Creat ion result ed in a dat a mart being creat ed.

RP Number of Jobs wit h Met ric of how many report jobs f ailed because of a
DB E rror dat abase error.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
E lement Loading result ed f rom loading addit ional at t ribut e element s.

RP Number of Jobs wit h

Met ric of how many report jobs f ailed because of an error.
E rror

RP Number of Jobs wit h Met ric of how many report job execut ions used an
I nt elligent Cube Hit I nt elligent Cube.

RP Number of Jobs wit h Met ric of how many report job execut ions used a securit y
S ecurit y Filt er f ilt er.

RP Number of Jobs wit h

Met ric of how many report jobs execut ed S QL st at ement s.
S QL E xecut ion

RP number of Met ric of how many report job execut ions were run
Narrowcast S erver jobs t hrough MicroS t rat egy Narrowcast S erver.

RP Number of P rompt ed Met ric of how many report job execut ions included a
Jobs prompt .

RP Number of Report
Met ric of how many report jobs execut ed as a result of a
Jobs f rom Document
document execut ion.
E xecut ion

RP Number of Result Met ric of how many result rows were ret urned f rom a
Rows report execut ion.

RP Number of
Met ric of how many report jobs were scheduled.
S cheduled Jobs

RP Number of Users who

Met ric of how many dist inct users ran report jobs.
ran report s

2205 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP P rompt A nswer Met ric of t he how long users t ake t o answer t he set of
Durat ion (hh: mm: ss) prompt s in report jobs.

RP P rompt A nswer Met ric of t he how long, in seconds, users t ake t o answer
Durat ion (secs) t he set of prompt s in report jobs.

RP Queue Durat ion Met ric of how long a report job wait ed in t he I nt elligence
(hh: mm: ss) S erver's queue bef ore t he report job was execut ed.

Met ric of how long, in seconds, a report job wait ed in t he

RP Queue Durat ion
I nt elligence S erver's queue bef ore t he report job was
(secs)
execut ed.

S chedule I ndicat es t he schedule t hat began t he report execut ion.

S chedule I ndicat or I ndicat es whet her t he report execut ion was scheduled.

S ecurit y Filt er I ndicat es t he securit y f ilt er used in t he report execut ion.

I ndicat es whet her a securit y f ilt er was used in t he report

S ecurit y Filt er I ndicat or
execut ion.

S QL E xecut ion I ndicat or I ndicat es t hat S QL was execut ed during report execut ion.

Templat e I ndicat es t he report t emplat e t hat was used.

User I ndicat es t he user t hat ran t he report .

Report Job SQL Pass Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her t he execut ion was ad hoc.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

Day I ndicat es t he day in which t he job was execut ed.

© 2019, M icr o St r at egy In c. 2206

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Hour I ndicat es t he hour in which t he report job was execut ed.

I ndicat es t he met adat a reposit ory st oring t he report or

Met adat a
document .

Minut e I ndicat es t he minut e in which t he report job was st art ed.

P roject I ndicat es t he project st oring t he report or document .

Report I ndicat es t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

I ndicat es t he S QL st at ement t hat was execut ed during t he

Report Job S QL P ass
S QL pass.

I ndicat es t he t ype of S QL st at ement t hat was execut ed in

Report Job S QL P ass
t his S QL pass. E xamples are S QL select , S QL insert ,
Type
S QL creat e and such.

RP E xecut ion Durat ion Met ric of t he durat ion of a report job's execut ion. I ncludes
(hh: mm: ss) dat abase execut ion t ime.

RP E xecut ion Durat ion Met ric of t he durat ion, in seconds, of a report job's
(secs) execut ion. I ncludes dat abase execut ion t ime.

RP Last E xecut ion Finish Met ric of t he f inish t imest amp when t he report job was
Timest amp last execut ed.

RP Last E xecut ion S t art Met ric of t he st art t imest amp when t he report job was last
Timest amp execut ed.

RP Number of DB Tables Met ric of how many dat abase t ables were accessed in a
A ccessed report job execut ion.

Met ric of how large, in byt es, t he S QL was f or a report

RP S QL S ize
job.

2207 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Report Job Steps Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion was ad hoc.

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

Day I ndicat es t he day in which t he job was execut ed.

Hour I ndicat es t he hour in which t he report job was execut ed.

Minut e I ndicat es t he minut e in which t he report job was st art ed.

Report I ndicat es t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

I ndicat es t he sequence number in t he series of execut ion

Report Job S t ep
st eps a report job passes t hrough in t he I nt elligence
S equence
S erver.

I ndicat es t he t ype of st ep f or a report job. E xamples are

S QL generat ion, S QL execut ion, A nalyt ical E ngine,
Report Job S t ep Type
Resolut ion S erver, element request , updat e I nt elligent
Cube, and so on.

RP A verage CP U
E xecut ion Durat ion per Met ric of t he average durat ion, in milliseconds, a report
Job (msecs) (I S _RE P _ job execut ion t akes in t he I nt elligence S erver CP U.
S TE P _FA CT)

RP A verage E lapsed Met ric of t he average dif f erence, in seconds, bet ween
Durat ion per Job (secs) st art t ime and f inish t ime of report job execut ions.
(I S _RE P _S TE P _FA CT) I ncludes t ime f or prompt responses.

RP A verage E xecut ion Met ric of t he average dif f erence, in seconds, bet ween

© 2019, M icr o St r at egy In c. 2208

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Durat ion per Job (secs) st art t ime and f inish t ime of report job execut ions.
(I S _RE P _S TE P _FA CT) I ncludes t ime f or prompt responses.

RP A verage Query
E ngine E xecut ion Met ric of t he average t ime, in seconds, t he Query E ngine
Durat ion per Job (secs) t akes t o process a report job.
(I S _RE P _S TE P _FA CT)

RP A verage Queue Met ric of t he average t ime report jobs wait ed in t he

Durat ion per Job (secs) I nt elligence S erver's queue bef ore t he report job was
(I S _RE P _S TE P _FA CT) execut ed.

Met ric of how long, in milliseconds, a report job execut ion

RP CP U Durat ion (msec)
t akes in t he I nt elligence S erver CP U.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E lapsed Durat ion
of report job execut ions. I ncludes t ime f or prompt
(hh: mm: ss)
responses.

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E lapsed Durat ion
and f inish t ime of report job execut ions. I ncludes t ime f or
(secs)
prompt responses.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E xecut ion Durat ion
of report job execut ions. I ncludes dat abase execut ion
(hh: mm: ss)
t ime.

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E xecut ion Durat ion
and f inish t ime of report job execut ions. I ncludes
(secs)
dat abase execut ion t ime.

RP Last E xecut ion Finish Met ric of t he f inish t imest amp when t he report job was
Timest amp last execut ed.

RP Last E xecut ion S t art Met ric of t he st art t imest amp when t he report job was last
Timest amp execut ed.

RP Number of Jobs (I S _
Met ric of how many report jobs were execut ed.
RE P _S TE P _FA CT)

2209 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP Query E ngine
Met ric of how long t he Query E ngine t ook t o execut e S QL
Durat ion (hh: mm: ss)
f or a report job.
(I S _RE P _S TE P _FA CT)

RP Query E ngine
Met ric of t he t ime, in seconds, t he Query E ngine t akes t o
Durat ion (secs) (I S _
execut e S QL f or a report job.
RE P _S TE P _FA CT)

RP Queue Durat ion Met ric of how long a report job wait ed in t he I nt elligence
(hh: mm: ss) S erver's queue bef ore t he report job was execut ed.

Met ric of how long, in seconds, a report job wait ed in t he

RP Queue Durat ion
I nt elligence S erver's queue bef ore t he report job was
(secs)
execut ed.

RP S QL E ngine Durat ion

Met ric of how long t he S QL E ngine t ook t o generat e S QL
(hh: mm: ss) (I S _RE P _
f or a report job.
S TE P _FA CT)

Report Job Tables/Columns Accessed Attributes and

Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion was ad hoc.

Column I ndicat es t he column t hat was accessed.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es t he day on which t he t able column was

Day
accessed.

I ndicat es t he t able in t he dat abase st oring t he column

DB Table
t hat was accessed.

© 2019, M icr o St r at egy In c. 2210

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

I ndicat es t he hour on which t he t able column was

Hour
accessed.

I ndicat es t he minut e on which t he t able column was

Minut e
accessed.

Report I ndicat es t he report t hat accessed t he t able column.

I ndicat es which execut ion of a report accessed t he t able

Report Job
column.

Met ric of how many report jobs accessed t he dat abase

RP Number of Jobs (I S _
column or t able. The Warehouse Tables A ccessed report
RE P _COL_FA CT)
uses t his met ric.

I ndicat es which t ype of S QL clause was used t o access

S QL Clause Type
t he t able column.

Schema Objects Attributes

Attrib u te
F u n ctio n
n ame

List s all at t ribut es in project s t hat are set up t o be monit ored by

A t t ribut e
E nt erprise Manager.

List s all at t ribut e f orms in project s t hat are set up t o be monit ored
A t t ribut e Form
by E nt erprise Manager.

List s all columns in project s t hat are set up t o be monit ored by

Column
E nt erprise Manager.

List s all physical t ables in t he dat a warehouse t hat are set up t o be

DB Table
monit ored by E nt erprise Manager.

List s all f act s in project s t hat are set up t o be monit ored by

Fact
E nt erprise Manager.

2211 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s all hierarchies in project s t hat are set up t o be monit ored by

Hierarchy
E nt erprise Manager

List s all logical t ables in project s t hat are set up t o be monit ored by
Table
E nt erprise Manager.

List s all t ransf ormat ions in project s t hat are set up t o be monit ored
Transf ormat ion
by E nt erprise Manager.

Server Machines Attributes

Attrib u te n ame F u n ctio n

List s all machines t hat have had users connect t o t he

Client Machine
I nt elligence S erver.

I nt elligence S erver
List s t he clust er of I nt elligence S ervers.
Clust er

I nt elligence S erver List s all machines t hat have logged st at ist ics as an
Machine I nt elligence S erver.

Web S erver Machine List s all machines used as web servers.

Session Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A vg. Connect ion Met ric of t he average t ime connect ions t o an I nt elligence
Durat ion (hh: mm: ss) S erver last .

A vg. Connect ion Met ric of t he average t ime, in seconds, connect ions t o an
Durat ion (secs) I nt elligence S erver last .

© 2019, M icr o St r at egy In c. 2212

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Connect ion Durat ion Met ric of t he t ime a connect ion t o an I nt elligence S erver
(hh: mm: ss) last s.

Connect ion Durat ion Met ric of t he t ime, in seconds, a connect ion t o an
(secs) I nt elligence S erver last s.

Connect ion S ource List s all connect ion sources t o I nt elligence S erver.

Met ric of how many sessions were connect ed t o an

Number of S essions
I nt elligence S erver. Usually report ed wit h a dat e and t ime
(Report Level)
at t ribut e.

Met ric of how many dist inct users were connect ed t o an

Number of Users Logged
I nt elligence S erver. Usually report ed wit h a dat e and t ime
I n (Report Level)
at t ribut e.

S ession I ndicat es a user connect ion t o an I nt elligence S erver.

All Indicators and Flags Attributes

Attrib u te n ame F u n ctio n

A d Hoc I ndicat or I ndicat es whet her an execut ion is ad hoc.

Cache Creat ion

I ndicat es whet her an execut ion has creat ed a cache.
I ndicat or

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Cancelled I ndicat or I ndicat es whet her an execut ion has been cancelled.

I ndicat es whet her a job was a document dat aset or a st and-

Child Job I ndicat or
alone report .

Conf igurat ion Object

I ndicat es whet her a conf igurat ion object exist s.
E xist s S t at us

Conf igurat ion List s all conf igurat ion paramet er t ypes.

2213 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

P aramet er V alue Type

Connect ion S ource List s all connect ion sources t o I nt elligence S erver.

Cont act Type List s t he execut ed cont act t ypes.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

Dat abase E rror I ndicat es whet her a report request f ailed because of a
I ndicat or dat abase error.

Dat amart I ndicat or I ndicat es whet her an execut ion creat ed a dat a mart .

I ndicat es whet her an execut ion encount ered a dat abase

DB E rror I ndicat or
error.

Delivery S t at us
I ndicat es whet her a delivery was successf ul.
I ndicat or

Delivery Type List s t he t ype of delivery.

Document Job S t at us
List s t he st at uses of document execut ions.
(Deprecat ed)

Document Job S t ep
List s all possible st eps of document job execut ion.
Type

I ndicat es t he t ype of a document or dossier, such as HTML

Document Type
document , Report S ervices document , or a dossier.

List s t he object f rom which a user drilled when a new report

Drill f rom Object
was run because of a drilling act ion.

Drill I ndicat or I ndicat es whet her an execut ion is a result of a drill.

List s t he object t o which a user drilled when a new report

Drill t o Object
was run because of a drilling act ion.

I ndicat es whet her an execut ion is a result of an element

E lement Load I ndicat or
load.

© 2019, M icr o St r at egy In c. 2214

Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

E rror I ndicat or I ndicat es whet her an execut ion encount ered an error.

E xecut ion Type I ndicat es how t he cont ent was request ed, such as User
I ndicat or E xecut ion, P re-Cached, A pplicat ion Recovery, and so on.

I ndicat es whet her a report was export ed and, if so,

E xport I ndicat or
indicat es it s f ormat .

Hierarchy Drilling I ndicat es whet her a hierarchy is used as a drill hierarchy.

List t he t ypes of manipulat ions t hat can be perf ormed on a

I nbox A ct ion Type
Hist ory List message.

I nt elligent Cube A ct ion

List s act ions perf ormed on or against int elligent cubes.
Type

I nt elligent Cube Type List s all int elligent cube t ypes.

List s all t he possible errors t hat can be ret urned during job
Job E rrorCode
execut ions.

Job P riorit y Map List s t he priorit ies of job execut ions.

E numerat es t he upper limit of t he priorit y ranges f or high,

Job P riorit y Number medium, and low priorit y jobs. Def ault values are 332, 666,
and 999.

Object Creat ion Dat e I ndicat es t he dat e on which an object was creat ed.

Object Creat ion I ndicat es t he week of t he year in which an object was

Week of year creat ed.

Object E xist s S t at us I ndicat es whet her an object exist s.

Object Hidden S t at us I ndicat es whet her an object is hidden.

Object Modif icat ion

I ndicat es t he dat e on which an object was last modif ied.
Dat e

Object Modif icat ion I ndicat es t he week of t he year in which an object was last
Week of year modif ied.

P rompt A nswer I ndicat es whet her a prompt answer was required f or t he job

2215 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

Required execut ion.

P rompt I ndicat or I ndicat es whet her a job execut ion was prompt ed.

Report Job S QL P ass List s t he t ypes of S QL passes t hat t he I nt elligence S erver

Type generat es.

Report Job S t at us
List s t he st at uses of report execut ions.
(Deprecat ed)

Report Job S t ep Type List s all possible st eps of report job execut ion.

I ndicat es t he t ype of a report , such as X DA , relat ional, and

Report Type
so on.

Report / Document I ndicat es whet her t he execut ion was a report or a

I ndicat or document .

S chedule I ndicat or I ndicat es whet her a job execut ion was scheduled.

S ecurit y Filt er I ndicat es whet her a securit y f ilt er was used in t he job
I ndicat or execut ion.

S QL Clause Type List s t he various S QL clause t ypes used by t he S QL E ngine.

S QL E xecut ion
I ndicat es whet her S QL was execut ed in t he job execut ion.
I ndicat or

Application Objects Attributes

Attrib u te
F u n ctio n
n ame

List s all consolidat ions in project s t hat are set up t o be monit ored
Consolidat ion
by E nt erprise Manager.

List s all cust om groups in project s t hat are set up t o be monit ored
Cust om Group
by E nt erprise Manager.

© 2019, M icr o St r at egy In c. 2216

Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s all document s in project s t hat are set up t o be monit ored by

Document
E nt erprise Manager.

List s all f ilt ers in project s t hat are set up t o be monit ored by
Filt er
E nt erprise Manager.

I nt elligent List s all int elligent cubes in project s t hat are set up t o be
Cube monit ored by E nt erprise Manager.

List s all met rics in project s t hat are set up t o be monit ored by
Met ric
E nt erprise Manager.

List s all prompt s in project s t hat are set up t o be monit ored by

P rompt
E nt erprise Manager.

List s all report s in project s t hat are set up t o be monit ored by

Report
E nt erprise Manager.

List s all securit y f ilt ers in project s t hat are set up t o be monit ored
S ecurit y Filt er
by E nt erprise Manager.

List s all t emplat es in project s t hat are set up t o be monit ored by

Templat e
E nt erprise Manager.

Configuration Objects Attributes

Attrib u te n ame F u n ctio n

A ddress List s all addresses t o which deliveries have been sent .

Conf igurat ion Object

List s t he owners of conf igurat ion object s.
Owner

Conf igurat ion

List s all conf igurat ion paramet ers.
P aramet er

Cont act List s all cont act s t o whom deliveries have been sent .

2217 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

DB Connect ion List s all dat abase connect ions.

DB I nst ance List s all dat abase inst ances.

Device List s all devices t o which deliveries have been sent .

E vent List s all event s being t racked.

Folder List s all f olders wit hin project s.

I nt elligence S erver
List s all I nt elligence S erver def init ions.
Def init ion

Met adat a List s all monit ored met adat a.

Owner List s t he owners of all object s.

P roject List s all project s.

S chedule List s all schedules.

S ubscript ion List s all execut ed t ransmissions.

Transmit t er List s all t ransmit t ers.

User List s all users being t racked.

User Group List s all user groups.

User Group (P arent ) List s all user groups t hat are parent s of ot her user groups.

Date and Time Attributes

Attrib u te
F u n ctio n
n ame

Calendar List s every calendar week, beginning wit h 2000-01-01, as an

Week int eger.

Day List s all days, beginning in 1990.

© 2019, M icr o St r at egy In c. 2218

Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s t he hours in a day. For example, 09 A M - 10 A M, 10 A M - 11

Hour
A M, and so on.

List s all t he minut es in an hour. For example, if t he hour specif ied is

Minut e 10 A M - 11 A M, list s minut es as 10. 30 A M - 10. 31 A M, 10. 32 A M -
10. 33 A M, and so on.

Mont h List s all mont hs, beginning wit h 2000.

Mont h of Y ear List s all mont hs in a specif ied year.

Quart er List s all quart ers.

Quart er of
List s all quart ers of t he year.
Y ear

List s all weeks in all years, beginning in 2000. Weeks in 2000 are
represent ed as a number ranging f rom 200001 t o 200053, weeks in
Week of Y ear
2001 are represent ed as a number ranging f rom 200101 t o 200153,
and so on.

Weekday List s all days of t he week.

Y ear List s all years.

Delivery Services Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

A ddress I ndicat es t he address t o which a delivery was sent .

A vg number of recipient s per Met ric of t he average number of recipient s in

subscript ion subscript ions.

A vg S ubscript ion E xecut ion Met ric of t he average amount of t ime subscript ions
Durat ion (hh: mm: ss) t ake t o execut e.

A vg S ubscript ion E xecut ion Met ric of t he average amount of t ime, in seconds,

2219 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Durat ion (secs) subscript ions t ake t o execut e.

Cont act I ndicat es all cont act s t o whom a delivery was sent .

Cont act Type I ndicat es t he execut ed cont act t ypes.

Day I ndicat es t he day on which t he delivery was sent .

Delivery S t at us I ndicat or I ndicat es whet her t he delivery was successf ul.

Delivery Type I ndicat es t he t ype of delivery.

I ndicat es t he t ype of device t o which t he delivery

Device
was sent .

Document I ndicat es t he document t hat was delivered.

Hour I ndicat es t he hour on which t he delivery was sent .

I ndicat es t he I nt elligence S erver machine t hat

I nt elligence S erver Machine
execut ed t he job.

Met adat a I ndicat es t he monit ored met adat a.

I ndicat es t he minut e on which t he delivery was

Minut e
sent .

Number of Dist inct Document Met ric of t he number of report services document
S ubscript ions subscript ions.

Met ric of t he number of recipient s t hat received

Number of Dist inct Recipient s
cont ent f rom a subscript ion.

Number of Dist inct Report

Met ric of t he number of report subscript ions.
S ubscript ions

Met ric of t he number of execut ed subscript ions.

Number of Dist inct
This does not ref lect t he number of subscript ions
S ubscript ions
in t he met adat a.

Met ric of t he number of subscript ions t hat

Number of E -mail S ubscript ions
delivered cont ent via e-mail.

© 2019, M icr o St r at egy In c. 2220

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Number of E rrored
Met ric of t he number of subscript ions t hat f ailed.
S ubscript ions

Met ric of t he number of execut ions of a

Number of E xecut ions
subscript ion.

Met ric of t he number of subscript ions t hat

Number of File S ubscript ions
delivered cont ent via f ile locat ion.

Number of Hist ory List Met ric of t he number of subscript ions t hat
S ubscript ions delivered cont ent via t he hist ory list .

Met ric of t he number of subscript ions t hat

Number of Mobile S ubscript ions
delivered cont ent via mobile.

Met ric of t he number of subscript ions t hat

Number of P rint S ubscript ions
delivered cont ent via a print er.

P roject List s t he project s.

Report List s t he report s in project s.

Report Job List s an execut ion of a report .

I ndicat es whet her t he execut ion was a report or a

Report / Document I ndicat or
document .

S chedule I ndicat es t he schedule t hat t riggered t he delivery.

I ndicat es t he subscript ion t hat t riggered t he

S ubscript ion
delivery.

S ubscript ion E xecut ion Met ric of t he sum of all execut ion t imes of a
Durat ion (hh: mm: ss) subscript ion.

S ubscript ion E xecut ion Durat ion Met ric of t he sum of all execut ion t imes of a
(secs) subscript ion (in seconds).

2221 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Document Job Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

I ndicat es t he day on which t he document job

Day
execut ed.

Document I ndicat es which document was execut ed.

Document Job I ndicat es an execut ion of a document .

Met ric of t he average dif f erence bet ween st art t ime

DP A verage E lapsed Durat ion
and f inish t ime (including t ime f or prompt
per Job (hh: mm: ss)
responses) of all document job execut ions.

Met ric of t he average dif f erence, in seconds,

DP A verage E lapsed Durat ion bet ween st art t ime and f inish t ime (including t ime
per Job (secs) f or prompt responses) of all document job
execut ions.

DP A verage E xecut ion Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions.

DP A verage E xecut ion Met ric of t he average durat ion of all document job
Durat ion per Job (hh: mm: ss) execut ions.

DP A verage Queue Durat ion Met ric of t he average durat ion of all document job
per Job (hh: mm: ss) execut ions wait ing in t he queue.

DP A verage Queue Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions wait ing in t he queue.

Met ric of t he dif f erence bet ween st art t ime and

DP E lapsed Durat ion
f inish t ime (including t ime f or prompt responses) of
(hh: mm: ss)
a document job.

Met ric of t he average dif f erence, in seconds,

DP E lapsed Durat ion (secs) bet ween st art t ime and f inish t ime (including t ime
f or prompt responses) of a document job.

DP E xecut ion Durat ion Met ric of t he durat ion of a document job's
(hh: mm: ss) execut ion.

© 2019, M icr o St r at egy In c. 2222

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Met ric of t he durat ion, in seconds, of a document

DP E xecut ion Durat ion (secs)
job's execut ion.

DP Number of Jobs (I S _DOC_ Met ric of t he number of document jobs t hat were
FA CT) execut ed.

DP Number of Jobs wit h Cache Met ric of t he number of document jobs t hat hit a
Hit cache.

DP Number of Jobs wit h E rror Met ric of t he number of document jobs t hat f ailed.

DP Number of Users who ran Met ric of t he number of users who ran document
Document s jobs.

DP P ercent age of Jobs wit h Met ric of t he percent age of document jobs t hat hit
Cache Hit a cache.

DP P ercent age of Jobs wit h Met ric of t he percent age of document jobs t hat
E rror f ailed.

Met ric of t he durat ion of all document job

DP Queue Durat ion (hh: mm: ss)
execut ions wait ing in t he queue.

Met ric of t he durat ion, in seconds, of all document

DP Queue Durat ion (secs)
job execut ions wait ing in t he queue.

Hour I ndicat es t he hour t he document job was execut ed.

I ndicat es t he I nt elligence S erver machine t hat

I nt elligence S erver Machine
execut ed t he document job.

Met adat a I ndicat es t he met adat a st oring t he document .

I ndicat es t he minut e t he document job was

Minut e
execut ed.

P roject I ndicat es t he project st oring t he document .

Report I ndicat es t he report s in t he document .

User I ndicat es t he user who ran t he document job.

2223 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Document Job Step Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

I ndicat es t he day on which t he document job

Day
execut ed.

Document I ndicat es which document was execut ed.

I ndicat es t he sequence number f or st eps in a

Document Job S t ep S equence
document job.

Document Job S t ep Type I ndicat es t he t ype of st ep f or a document job.

Met ric of t he average dif f erence bet ween st art t ime

DP A verage E lapsed Durat ion
and f inish t ime (including t ime f or prompt
per Job (hh: mm: ss)
responses) of all document job execut ions.

Met ric of t he average dif f erence, in seconds,

DP A verage E lapsed Durat ion bet ween st art t ime and f inish t ime (including t ime
per Job (secs) f or prompt responses) of all document job
execut ions.

DP A verage E xecut ion Met ric of t he average durat ion of all document job
Durat ion per Job (hh: mm: ss) execut ions.

DP A verage E xecut ion Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions.

DP A verage Queue Durat ion Met ric of t he average durat ion of all document job
per Job (hh: mm: ss) execut ions wait ing in t he queue.

DP A verage Queue Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions wait ing in t he queue.

Met ric of t he dif f erence bet ween st art t ime and

DP E lapsed Durat ion
f inish t ime (including t ime f or prompt responses) of
(hh: mm: ss)
a document job.

Met ric of t he average dif f erence, in seconds,

DP E lapsed Durat ion (secs) bet ween st art t ime and f inish t ime (including t ime
f or prompt responses) of a document job.

© 2019, M icr o St r at egy In c. 2224

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

DP E xecut ion Durat ion Met ric of t he durat ion of a document job's
(hh: mm: ss) execut ion.

Met ric of t he durat ion, in seconds, of a document

DP E xecut ion Durat ion (secs)
job's execut ion.

Met ric of t he durat ion of all document job

DP Queue Durat ion (hh: mm: ss)
execut ions wait ing in t he queue.

Met ric of t he durat ion, in seconds, of all document

DP Queue Durat ion (secs)
job execut ions wait ing in t he queue.

Hour I ndicat es t he hour t he document job was execut ed.

Met adat a I ndicat es t he met adat a st oring t he document .

I ndicat es t he minut e t he document job was

Minut e
execut ed.

P roject I ndicat es t he project st oring t he document .

Enterprise Manager Data Load Attributes

Attrib u te n ame F u n ctio n

Dat a Load Finish Displays t he t imest amp of t he end of t he dat a load process
Time f or t he project s t hat are being monit ored.

Dat a Load P roject List s all project s t hat are being monit ored.

List s t he t imest amp of t he st art of t he dat a load process f or

Dat a Load S t art Time
t he project s t hat are being monit ored.

A value of -1 indicat es t hat it is t he summary row in t he E M_

I S _LA S T_UP DA TE t able f or all project s in a dat a load. That
I t em I D summary row has inf ormat ion about how long t he dat a load
t ook. A value of 0 indicat es it is a row wit h project dat a load
det ails.

2225 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Inbox Message Actions Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Day I ndicat es t he day t he manipulat ion was st art ed

Document I ndicat es t he document included in t he message.

I ndicat es t he document job t hat request ed t he Hist ory

Document Job
List message manipulat ion.

HL Days S ince Last Met ric of t he number of days since any act ion was
A ct ion: A ny act ion perf ormed.

HL Days S ince Last Met ric of t he number of days since t he last request was
A ct ion: Request made f or t he cont ent s of a message.

Met ric of t he dat e and t ime of t he last act ion perf ormed
HL Last A ct ion Dat e: A ny
on a message such as read, delet ed, marked as read, and
A ct ion
so on.

HL Last A ct ion Dat e: Met ric of t he dat e and t ime of t he last request made f or
Request t he cont ent s of a message.

HL Number of A ct ions Met ric of t he number of act ions perf ormed on a message.

HL Number of A ct ions by Met ric of t he number of act ions by user perf ormed on a
User message.

HL Number of A ct ions Met ric of t he number of act ions on a message t hat

wit h E rrors result ed in an error.

HL Number of Document Met ric of t he number of document jobs t hat result wit h
Jobs messages.

HL Number of Messages Met ric of t he number of messages.

HL Number of Messages Met ric of t he number of messages t hat result ed in an

wit h E rrors error.

HL Number of Messages Met ric of t he number of request s f or t he cont ent s of a

Request ed message.

© 2019, M icr o St r at egy In c. 2226

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

HL Number of Report Met ric of t he number of report jobs t hat result f rom
Jobs messages.

I ndicat es t he hour t he manipulat ion was st art ed on a

Hour
Hist ory List message.

I ndicat es t he manipulat ion t hat was perf ormed on a

I nbox A ct ion
Hist ory List message.

I ndicat es t he t ype of manipulat ion t hat was perf ormed on

I nbox A ct ion Type
a Hist ory List message.

I nbox Message I ndicat es t he message in t he Hist ory List .

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he message.

Met adat a I ndicat es t he met adat a st oring t he message.

Minut e I ndicat es t he minut e t he manipulat ion was st art ed.

P roject I ndicat es t he project st oring t he message.

Report I ndicat es t he report included in t he message.

I ndicat es t he job I D of t he report included in t he

Report Job
message.

I ndicat es t he user who manipulat ed t he Hist ory List

User
message.

Mobile Client Attributes

Attrib u te n ame F u n ctio n

I ndicat es whet her a cache was hit during t he execut ion

Cache Hit I ndicat or
and, if so, what t ype of cache hit .

2227 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

Day I ndicat es t he day t he act ion st art ed.

Document I dent if ies t he document used in t he request .

I ndicat es t he t ype of report or document t hat init iat ed t he

E xecut ion Type I ndicat or
execut ion.

I ndicat es t he locat ion, in lat it ude and longit ude f orm, of

Geocode
t he user.

Hour I ndicat es t he hour t he act ion st art ed.

I nt elligence S erver
I ndicat es t he I nt elligence S erver processing t he request .
Machine

I ndicat es t he met adat a reposit ory st oring t he report or

Met adat a
document .

Minut e I ndicat es t he minut e t he act ion st art ed.

Mobile Device
I ndicat es t he unique I nst allat ion I D of t he mobile app.
I nst allat ion I D

I ndicat es t he t ype of mobile device t he app is inst alled

Mobile Device Type
on, such as I P A D2, DROI D, and so on.

I ndicat es t he version of t he MicroS t rat egy app making t he

MS TR A pp V ersion
request .

I ndicat es t he t ype of net work used, such as 3G, WI FI ,

Net work Type
LTE , and so on.

I ndicat es t he operat ing syst em of t he mobile device

Operat ing S yst em
making t he request .

Operat ing S yst em I ndicat es t he operat ing syst em version of t he mobile

V ersion device making t he request .

P roject I ndicat es t he project used t o init iat e t he request .

User I ndicat es t he user t hat init iat ed t he request .

© 2019, M icr o St r at egy In c. 2228

Syst em Ad m in ist r at io n Gu id e

OLAP Services Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Day I ndicat es t he day t he act ion was st art ed.

Hour I ndicat es t he hour t he act ion was st art ed.

I nt elligent Cube I ndicat es t he I nt elligent Cube t hat was used.

I nt elligent Cube A ct ion Met ric of t he durat ion, in seconds, f or an act ion t hat was
Durat ion (secs) perf ormed on t he I nt ellgent Cube.

I nt elligent Cube A ct ion I ndicat es t he t ype of act ion t aken on t he I nt elligent Cube
Type such as cube publish, cube view hit , and so on.

I ndicat es t he I nt elligent Cube inst ance in memory t hat

I nt elligent Cube I nst ance
was used f or t he act ion.

I nt elligent Cube S ize I f t he I nt elligent Cube is published or ref reshed, indicat es

(K B ) t he size, in K B , of t he I nt elligent Cube.

I ndicat es t he t ype of I nt elligent Cube used, such as

I nt elligent Cube Type working set report , Report S ervices B ase report , OLA P
Cube report , and so on.

Minut e I ndicat es t he minut e on which t he act ion was st art ed.

Met ric of how many jobs f rom report s not based on

Number of Dynamically
I nt elligent Cubes but select ed by t he engine t o go against
S ourced Report Jobs
an I nt elligent Cube because t he object s on t he report
against I nt elligent Cubes
mat ched what is on t he I nt elligent Cube.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube P ublishes published.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube Ref reshes ref reshed.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube Republishes republished.

2229 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Number of Jobs wit h Met ric of how many job execut ions used an I nt elligent
I nt elligent Cube Hit Cube.

Met ric of how many users execut ed a report or document

Number of Users hit t ing
t hat used an I nt elligent Cube. That is, t he number of
I nt elligent Cubes
users using OLA P S ervices.

Number of V iew Report Met ric of how many act ions were t he result of a V iew
Jobs Report .

Report I ndicat es t he report t hat hit t he I nt elligent Cube.

Performance Monitoring Attributes

Attrib u te n ame F u n ctio n

I ndicat es cat egory of t he count er, such as memory,

Count er Cat egory
MicroS t rat egy server jobs, or MicroS t rat egy server users.

I ndicat es t he inst ance I D of t he count er, f or MicroS t rat egy

Count er I nst ance
use.

Day I ndicat es t he day t he act ion was st art ed.

Hour I ndicat es t he hour t he act ion was st art ed.

Minut e I ndicat es t he minut e t he act ion was st art ed.

P erf ormance Monit or I ndicat es t he name of t he perf ormance count er and it s value
Count er t ype.

© 2019, M icr o St r at egy In c. 2230

Syst em Ad m in ist r at io n Gu id e

Prompt Answers Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Connect ion S ource Indicates the connection source to Intelligence Server.

Count of P rompt
Metric of how many prompts were answered.
A nswers

Day I ndicat es t he day t he prompt was answered.

Document I ndicat es t he document t hat used t he prompt .

Hour I ndicat es t he hour t he prompt was answered.

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he job.

Met adat a I ndicat es t he met adat a reposit ory st oring t he prompt .

Minut e I ndicat es t he minut e t he prompt was answered.

P roject I ndicat es t he project st oring t he prompt .

P rompt I ndicat es t he prompt t hat was used.

P rompt A nswer I ndicat es t he answers f or t he prompt in various inst ances.

P rompt A nswer Required I ndicat es whet her an answer t o t he prompt was required.

I ndicat es t he answer of an inst ance of a prompt in a

P rompt I nst ance A nswer
report job.

P rompt Locat ion Indicates the ID of the location in which a prompt is stored.

Indicates the type of the object in which the prompt is stored, such
P rompt Locat ion Type
as filter, template, attribute, and so on.

I ndicat es t he t it le of t he prompt (t he t it le t he user sees

P rompt Tit le
when present ed during job execut ion).

I ndicat es what t ype of prompt was used, such as dat e,

P rompt Type
double, element s, and so on.

2231 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Report I ndicat es t he report t hat used t he prompt .

Report Job I ndicat es t he report job t hat used t he prompt .

RP Number of Jobs (I S _
Met ric of how many jobs involved a prompt .
P R_A NS _FA CT)

RP Number of Jobs
Met ric of how many report jobs had a specif ied prompt
Cont aining P rompt
answer value.
A nswer V alue

RP Number of Jobs Not

Met ric of how many report jobs did not have a specif ied
Cont aining P rompt
prompt answer value.
A nswer V alue

RP Number of Jobs wit h Met ric of how many report jobs had a prompt t hat was not
Unanswered P rompt s answered.

Report Job Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion is ad hoc.

Cache Creat ion I ndicat or I ndicat es whet her an execut ion has creat ed a cache.

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Cancelled I ndicat or I ndicat es whet her an execut ion has been canceled.

I ndicat es whet her a job was a document dat aset or a

Child Job I ndicat or
st andalone report .

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

© 2019, M icr o St r at egy In c. 2232

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

I ndicat es whet her a report request f ailed because of a

Dat abase E rror I ndicat or
dat abase error.

Dat amart I ndicat or I ndicat es whet her an execut ion creat ed a dat a mart .

Day I ndicat es t he day on which t he report was execut ed.

I ndicat es t he dat abase inst ance on which t he report was

DB I nst ance
execut ed.

Drill I ndicat or I ndicat es whet her an execut ion is a result of a drill.

I ndicat es whet her an execut ion is a result of an element

E lement Load I ndicat or
load.

E rror I ndicat or I ndicat es whet her an execut ion encount ered an error.

I ndicat es whet her a report was export ed and, if so,

E xport I ndicat or
indicat es it s f ormat .

Filt er I ndicat es t he f ilt er used on t he report .

Hour I ndicat es t he hour on which t he report was execut ed.

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he report .

Met adat a I ndicat es t he met adat a reposit ory t hat st ores t he report .

I ndicat es t he minut e on which t he report execut ion was

Minut e
st art ed.

Number of Jobs wit h Met ric of how many job execut ions used an I nt elligent
I nt elligent Cube Hit Cube.

P roject I ndicat es t he met adat a reposit ory t hat st ores t he report .

P rompt I ndicat or I ndicat es whet her t he report execut ion was prompt ed.

Report I ndicat es t he I D of t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

2233 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP A verage E lapsed
Met ric of t he average dif f erence bet ween st art t ime and
Durat ion per Job
f inish t ime (including t ime f or prompt responses) of all
(hh: mm: ss) (I S _RE P _
report job execut ions.
FA CT)

RP A verage E lapsed Met ric of t he average dif f erence bet ween st art t ime and
Durat ion per Job (secs) f inish t ime (including t ime f or prompt responses) of all
(I S _RE P _FA CT) report job execut ions.

RP A verage E xecut ion

Durat ion per Job Met ric of t he average durat ion of all report job execut ions.
(hh: mm: ss) (I S _RE P _ I ncludes t ime in queue and execut ion f or a report job.
FA CT)

RP A verage E xecut ion Met ric of t he average durat ion, in seconds, of all report
Durat ion per Job (secs) job execut ions. I ncludes t ime in queue and execut ion f or
(I S _RE P _FA CT) a report job.

RP A verage P rompt
Met ric of t he average t ime users t ake t o answer t he set of
A nswer Time per Job
prompt s in all report jobs.
(hh: mm: ss)

RP A verage P rompt
Met ric of t he average t ime, in seconds, users t ake t o
A nswer Time per Job
answer t he set of prompt s in all report jobs.
(secs)

RP A verage Queue
Met ric of t he average t ime report jobs wait ed in t he
Durat ion per Job
I nt elligence S erver's queue bef ore t he report job was
(hh: mm: ss) (I S _RE P _
execut ed.
FA CT)

RP A verage Queue Met ric of t he average t ime, in seconds, report jobs wait ed
Durat ion per Job (secs) in t he I nt elligence S erver's queue bef ore t he report job
(I S _RE P _FA CT) was execut ed.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E lapsed Durat ion
of a report job. I ncludes t ime f or prompt responses, in
(hh: mm: ss)
queue, and execut ion.

© 2019, M icr o St r at egy In c. 2234

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E lapsed Durat ion
and f inish t ime of a report job. I ncludes t ime f or prompt
(secs)
responses, in queue, and execut ion.

RP E xecut ion Durat ion Met ric of t he durat ion of a report job's execut ion. I ncludes
(hh: mm: ss) dat abase execut ion t ime.

RP E xecut ion Durat ion Met ric of t he durat ion, in seconds, of a report job's
(secs) execut ion. I ncludes dat abase execut ion t ime.

RP Number of A d Hoc Met ric of how many report jobs result ed f rom an ad hoc
Jobs report creat ion.

RP Number of Cancelled
Met ric of how many job execut ions were canceled.
Jobs

Met ric of how many job execut ions result ed f rom a drill
RP Number of Drill Jobs
act ion.

RP Number of Jobs (I S _
Met ric of how many report jobs were execut ed.
RE P _FA CT)

RP Number of Jobs Met ric of how many report jobs were execut ed against t he
hit t ing Dat abase dat abase.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
Cache Creat ion result in creat ing a server cache.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
Cache Hit hit a server cache.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
E lement Loading result f rom loading addit ional at t ribut e element s.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
Cache Creat ion result ed in a server cache being creat ed.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat hit a
Cache Hit server cache.

2235 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
Dat amart Creat ion result ed in a dat a mart being creat ed.

RP Number of Jobs wit h Met ric of how many report jobs f ailed because of a
DB E rror dat abase error.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
E lement Loading result ed f rom loading addit ional at t ribut e element s.

RP Number of Jobs wit h

Met ric of how many report jobs f ailed because of an error.
E rror

RP Number of Jobs wit h Met ric of how many report job execut ions used an
I nt elligent Cube Hit I nt elligent Cube.

RP Number of Jobs wit h Met ric of how many report job execut ions used a securit y
S ecurit y Filt er f ilt er.

RP Number of Jobs wit h

Met ric of how many report jobs execut ed S QL st at ement s.
S QL E xecut ion

RP number of Met ric of how many report job execut ions were run
Narrowcast S erver jobs t hrough MicroS t rat egy Narrowcast S erver.

RP Number of P rompt ed Met ric of how many report job execut ions included a
Jobs prompt .

RP Number of Report
Met ric of how many report jobs execut ed as a result of a
Jobs f rom Document
document execut ion.
E xecut ion

RP Number of Result Met ric of how many result rows were ret urned f rom a
Rows report execut ion.

RP Number of
Met ric of how many report jobs were scheduled.
S cheduled Jobs

RP Number of Users who

Met ric of how many dist inct users ran report jobs.
ran report s

© 2019, M icr o St r at egy In c. 2236

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP P rompt A nswer Met ric of t he how long users t ake t o answer t he set of
Durat ion (hh: mm: ss) prompt s in report jobs.

RP P rompt A nswer Met ric of t he how long, in seconds, users t ake t o answer
Durat ion (secs) t he set of prompt s in report jobs.

RP Queue Durat ion Met ric of how long a report job wait ed in t he I nt elligence
(hh: mm: ss) S erver's queue bef ore t he report job was execut ed.

Met ric of how long, in seconds, a report job wait ed in t he

RP Queue Durat ion
I nt elligence S erver's queue bef ore t he report job was
(secs)
execut ed.

S chedule I ndicat es t he schedule t hat began t he report execut ion.

S chedule I ndicat or I ndicat es whet her t he report execut ion was scheduled.

S ecurit y Filt er I ndicat es t he securit y f ilt er used in t he report execut ion.

I ndicat es whet her a securit y f ilt er was used in t he report

S ecurit y Filt er I ndicat or
execut ion.

S QL E xecut ion I ndicat or I ndicat es t hat S QL was execut ed during report execut ion.

Templat e I ndicat es t he report t emplat e t hat was used.

User I ndicat es t he user t hat ran t he report .

Report Job SQL Pass Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her t he execut ion was ad hoc.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

Day I ndicat es t he day in which t he job was execut ed.

2237 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Hour I ndicat es t he hour in which t he report job was execut ed.

I ndicat es t he met adat a reposit ory st oring t he report or

Met adat a
document .

Minut e I ndicat es t he minut e in which t he report job was st art ed.

P roject I ndicat es t he project st oring t he report or document .

Report I ndicat es t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

I ndicat es t he S QL st at ement t hat was execut ed during t he

Report Job S QL P ass
S QL pass.

I ndicat es t he t ype of S QL st at ement t hat was execut ed in

Report Job S QL P ass
t his S QL pass. E xamples are S QL select , S QL insert ,
Type
S QL creat e and such.

RP E xecut ion Durat ion Met ric of t he durat ion of a report job's execut ion. I ncludes
(hh: mm: ss) dat abase execut ion t ime.

RP E xecut ion Durat ion Met ric of t he durat ion, in seconds, of a report job's
(secs) execut ion. I ncludes dat abase execut ion t ime.

RP Last E xecut ion Finish Met ric of t he f inish t imest amp when t he report job was
Timest amp last execut ed.

RP Last E xecut ion S t art Met ric of t he st art t imest amp when t he report job was last
Timest amp execut ed.

RP Number of DB Tables Met ric of how many dat abase t ables were accessed in a
A ccessed report job execut ion.

Met ric of how large, in byt es, t he S QL was f or a report

RP S QL S ize
job.

© 2019, M icr o St r at egy In c. 2238

Syst em Ad m in ist r at io n Gu id e

Report Job Steps Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion was ad hoc.

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

Day I ndicat es t he day in which t he job was execut ed.

Hour I ndicat es t he hour in which t he report job was execut ed.

Minut e I ndicat es t he minut e in which t he report job was st art ed.

Report I ndicat es t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

I ndicat es t he sequence number in t he series of execut ion

Report Job S t ep
st eps a report job passes t hrough in t he I nt elligence
S equence
S erver.

I ndicat es t he t ype of st ep f or a report job. E xamples are

S QL generat ion, S QL execut ion, A nalyt ical E ngine,
Report Job S t ep Type
Resolut ion S erver, element request , updat e I nt elligent
Cube, and so on.

RP A verage CP U
E xecut ion Durat ion per Met ric of t he average durat ion, in milliseconds, a report
Job (msecs) (I S _RE P _ job execut ion t akes in t he I nt elligence S erver CP U.
S TE P _FA CT)

RP A verage E lapsed Met ric of t he average dif f erence, in seconds, bet ween
Durat ion per Job (secs) st art t ime and f inish t ime of report job execut ions.
(I S _RE P _S TE P _FA CT) I ncludes t ime f or prompt responses.

RP A verage E xecut ion Met ric of t he average dif f erence, in seconds, bet ween

2239 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Durat ion per Job (secs) st art t ime and f inish t ime of report job execut ions.
(I S _RE P _S TE P _FA CT) I ncludes t ime f or prompt responses.

RP A verage Query
E ngine E xecut ion Met ric of t he average t ime, in seconds, t he Query E ngine
Durat ion per Job (secs) t akes t o process a report job.
(I S _RE P _S TE P _FA CT)

RP A verage Queue Met ric of t he average t ime report jobs wait ed in t he

Durat ion per Job (secs) I nt elligence S erver's queue bef ore t he report job was
(I S _RE P _S TE P _FA CT) execut ed.

Met ric of how long, in milliseconds, a report job execut ion

RP CP U Durat ion (msec)
t akes in t he I nt elligence S erver CP U.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E lapsed Durat ion
of report job execut ions. I ncludes t ime f or prompt
(hh: mm: ss)
responses.

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E lapsed Durat ion
and f inish t ime of report job execut ions. I ncludes t ime f or
(secs)
prompt responses.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E xecut ion Durat ion
of report job execut ions. I ncludes dat abase execut ion
(hh: mm: ss)
t ime.

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E xecut ion Durat ion
and f inish t ime of report job execut ions. I ncludes
(secs)
dat abase execut ion t ime.

RP Last E xecut ion Finish Met ric of t he f inish t imest amp when t he report job was
Timest amp last execut ed.

RP Last E xecut ion S t art Met ric of t he st art t imest amp when t he report job was last
Timest amp execut ed.

RP Number of Jobs (I S _
Met ric of how many report jobs were execut ed.
RE P _S TE P _FA CT)

© 2019, M icr o St r at egy In c. 2240

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP Query E ngine
Met ric of how long t he Query E ngine t ook t o execut e S QL
Durat ion (hh: mm: ss)
f or a report job.
(I S _RE P _S TE P _FA CT)

RP Query E ngine
Met ric of t he t ime, in seconds, t he Query E ngine t akes t o
Durat ion (secs) (I S _
execut e S QL f or a report job.
RE P _S TE P _FA CT)

RP Queue Durat ion Met ric of how long a report job wait ed in t he I nt elligence
(hh: mm: ss) S erver's queue bef ore t he report job was execut ed.

Met ric of how long, in seconds, a report job wait ed in t he

RP Queue Durat ion
I nt elligence S erver's queue bef ore t he report job was
(secs)
execut ed.

RP S QL E ngine Durat ion

Met ric of how long t he S QL E ngine t ook t o generat e S QL
(hh: mm: ss) (I S _RE P _
f or a report job.
S TE P _FA CT)

Report Job Tables/Columns Accessed Attributes and

Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion was ad hoc.

Column I ndicat es t he column t hat was accessed.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es t he day on which t he t able column was

Day
accessed.

I ndicat es t he t able in t he dat abase st oring t he column

DB Table
t hat was accessed.

2241 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

I ndicat es t he hour on which t he t able column was

Hour
accessed.

I ndicat es t he minut e on which t he t able column was

Minut e
accessed.

Report I ndicat es t he report t hat accessed t he t able column.

I ndicat es which execut ion of a report accessed t he t able

Report Job
column.

Met ric of how many report jobs accessed t he dat abase

RP Number of Jobs (I S _
column or t able. The Warehouse Tables A ccessed report
RE P _COL_FA CT)
uses t his met ric.

I ndicat es which t ype of S QL clause was used t o access

S QL Clause Type
t he t able column.

Schema Objects Attributes

Attrib u te
F u n ctio n
n ame

List s all at t ribut es in project s t hat are set up t o be monit ored by

A t t ribut e
E nt erprise Manager.

List s all at t ribut e f orms in project s t hat are set up t o be monit ored
A t t ribut e Form
by E nt erprise Manager.

List s all columns in project s t hat are set up t o be monit ored by

Column
E nt erprise Manager.

List s all physical t ables in t he dat a warehouse t hat are set up t o be

DB Table
monit ored by E nt erprise Manager.

List s all f act s in project s t hat are set up t o be monit ored by

Fact
E nt erprise Manager.

© 2019, M icr o St r at egy In c. 2242

Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s all hierarchies in project s t hat are set up t o be monit ored by

Hierarchy
E nt erprise Manager

List s all logical t ables in project s t hat are set up t o be monit ored by
Table
E nt erprise Manager.

List s all t ransf ormat ions in project s t hat are set up t o be monit ored
Transf ormat ion
by E nt erprise Manager.

Server Machines Attributes

Attrib u te n ame F u n ctio n

List s all machines t hat have had users connect t o t he

Client Machine
I nt elligence S erver.

I nt elligence S erver
List s t he clust er of I nt elligence S ervers.
Clust er

I nt elligence S erver List s all machines t hat have logged st at ist ics as an
Machine I nt elligence S erver.

Web S erver Machine List s all machines used as web servers.

Session Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A vg. Connect ion Met ric of t he average t ime connect ions t o an I nt elligence
Durat ion (hh: mm: ss) S erver last .

A vg. Connect ion Met ric of t he average t ime, in seconds, connect ions t o an
Durat ion (secs) I nt elligence S erver last .

2243 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Connect ion Durat ion Met ric of t he t ime a connect ion t o an I nt elligence S erver
(hh: mm: ss) last s.

Connect ion Durat ion Met ric of t he t ime, in seconds, a connect ion t o an
(secs) I nt elligence S erver last s.

Connect ion S ource List s all connect ion sources t o I nt elligence S erver.

Met ric of how many sessions were connect ed t o an

Number of S essions
I nt elligence S erver. Usually report ed wit h a dat e and t ime
(Report Level)
at t ribut e.

Met ric of how many dist inct users were connect ed t o an

Number of Users Logged
I nt elligence S erver. Usually report ed wit h a dat e and t ime
I n (Report Level)
at t ribut e.

S ession I ndicat es a user connect ion t o an I nt elligence S erver.

All Indicators and Flags Attributes

Attrib u te n ame F u n ctio n

A d Hoc I ndicat or I ndicat es whet her an execut ion is ad hoc.

Cache Creat ion

I ndicat es whet her an execut ion has creat ed a cache.
I ndicat or

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Cancelled I ndicat or I ndicat es whet her an execut ion has been cancelled.

I ndicat es whet her a job was a document dat aset or a st and-

Child Job I ndicat or
alone report .

Conf igurat ion Object

I ndicat es whet her a conf igurat ion object exist s.
E xist s S t at us

Conf igurat ion List s all conf igurat ion paramet er t ypes.

© 2019, M icr o St r at egy In c. 2244

Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

P aramet er V alue Type

Connect ion S ource List s all connect ion sources t o I nt elligence S erver.

Cont act Type List s t he execut ed cont act t ypes.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

Dat abase E rror I ndicat es whet her a report request f ailed because of a
I ndicat or dat abase error.

Dat amart I ndicat or I ndicat es whet her an execut ion creat ed a dat a mart .

I ndicat es whet her an execut ion encount ered a dat abase

DB E rror I ndicat or
error.

Delivery S t at us
I ndicat es whet her a delivery was successf ul.
I ndicat or

Delivery Type List s t he t ype of delivery.

Document Job S t at us
List s t he st at uses of document execut ions.
(Deprecat ed)

Document Job S t ep
List s all possible st eps of document job execut ion.
Type

I ndicat es t he t ype of a document or dossier, such as HTML

Document Type
document , Report S ervices document , or a dossier.

List s t he object f rom which a user drilled when a new report

Drill f rom Object
was run because of a drilling act ion.

Drill I ndicat or I ndicat es whet her an execut ion is a result of a drill.

List s t he object t o which a user drilled when a new report

Drill t o Object
was run because of a drilling act ion.

I ndicat es whet her an execut ion is a result of an element

E lement Load I ndicat or
load.

2245 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

E rror I ndicat or I ndicat es whet her an execut ion encount ered an error.

E xecut ion Type I ndicat es how t he cont ent was request ed, such as User
I ndicat or E xecut ion, P re-Cached, A pplicat ion Recovery, and so on.

I ndicat es whet her a report was export ed and, if so,

E xport I ndicat or
indicat es it s f ormat .

Hierarchy Drilling I ndicat es whet her a hierarchy is used as a drill hierarchy.

List t he t ypes of manipulat ions t hat can be perf ormed on a

I nbox A ct ion Type
Hist ory List message.

I nt elligent Cube A ct ion

List s act ions perf ormed on or against int elligent cubes.
Type

I nt elligent Cube Type List s all int elligent cube t ypes.

List s all t he possible errors t hat can be ret urned during job
Job E rrorCode
execut ions.

Job P riorit y Map List s t he priorit ies of job execut ions.

E numerat es t he upper limit of t he priorit y ranges f or high,

Job P riorit y Number medium, and low priorit y jobs. Def ault values are 332, 666,
and 999.

Object Creat ion Dat e I ndicat es t he dat e on which an object was creat ed.

Object Creat ion I ndicat es t he week of t he year in which an object was

Week of year creat ed.

Object E xist s S t at us I ndicat es whet her an object exist s.

Object Hidden S t at us I ndicat es whet her an object is hidden.

Object Modif icat ion

I ndicat es t he dat e on which an object was last modif ied.
Dat e

Object Modif icat ion I ndicat es t he week of t he year in which an object was last
Week of year modif ied.

P rompt A nswer I ndicat es whet her a prompt answer was required f or t he job

© 2019, M icr o St r at egy In c. 2246

Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

Required execut ion.

P rompt I ndicat or I ndicat es whet her a job execut ion was prompt ed.

Report Job S QL P ass List s t he t ypes of S QL passes t hat t he I nt elligence S erver

Type generat es.

Report Job S t at us
List s t he st at uses of report execut ions.
(Deprecat ed)

Report Job S t ep Type List s all possible st eps of report job execut ion.

I ndicat es t he t ype of a report , such as X DA , relat ional, and

Report Type
so on.

Report / Document I ndicat es whet her t he execut ion was a report or a

I ndicat or document .

S chedule I ndicat or I ndicat es whet her a job execut ion was scheduled.

S ecurit y Filt er I ndicat es whet her a securit y f ilt er was used in t he job
I ndicat or execut ion.

S QL Clause Type List s t he various S QL clause t ypes used by t he S QL E ngine.

S QL E xecut ion
I ndicat es whet her S QL was execut ed in t he job execut ion.
I ndicat or

Application Objects Attributes

Attrib u te
F u n ctio n
n ame

List s all consolidat ions in project s t hat are set up t o be monit ored
Consolidat ion
by E nt erprise Manager.

List s all cust om groups in project s t hat are set up t o be monit ored
Cust om Group
by E nt erprise Manager.

2247 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s all document s in project s t hat are set up t o be monit ored by

Document
E nt erprise Manager.

List s all f ilt ers in project s t hat are set up t o be monit ored by
Filt er
E nt erprise Manager.

I nt elligent List s all int elligent cubes in project s t hat are set up t o be
Cube monit ored by E nt erprise Manager.

List s all met rics in project s t hat are set up t o be monit ored by
Met ric
E nt erprise Manager.

List s all prompt s in project s t hat are set up t o be monit ored by

P rompt
E nt erprise Manager.

List s all report s in project s t hat are set up t o be monit ored by

Report
E nt erprise Manager.

List s all securit y f ilt ers in project s t hat are set up t o be monit ored
S ecurit y Filt er
by E nt erprise Manager.

List s all t emplat es in project s t hat are set up t o be monit ored by

Templat e
E nt erprise Manager.

Configuration Objects Attributes

Attrib u te n ame F u n ctio n

A ddress List s all addresses t o which deliveries have been sent .

Conf igurat ion Object

List s t he owners of conf igurat ion object s.
Owner

Conf igurat ion

List s all conf igurat ion paramet ers.
P aramet er

Cont act List s all cont act s t o whom deliveries have been sent .

© 2019, M icr o St r at egy In c. 2248

Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

DB Connect ion List s all dat abase connect ions.

DB I nst ance List s all dat abase inst ances.

Device List s all devices t o which deliveries have been sent .

E vent List s all event s being t racked.

Folder List s all f olders wit hin project s.

I nt elligence S erver
List s all I nt elligence S erver def init ions.
Def init ion

Met adat a List s all monit ored met adat a.

Owner List s t he owners of all object s.

P roject List s all project s.

S chedule List s all schedules.

S ubscript ion List s all execut ed t ransmissions.

Transmit t er List s all t ransmit t ers.

User List s all users being t racked.

User Group List s all user groups.

User Group (P arent ) List s all user groups t hat are parent s of ot her user groups.

Date and Time Attributes

Attrib u te
F u n ctio n
n ame

Calendar List s every calendar week, beginning wit h 2000-01-01, as an

Week int eger.

Day List s all days, beginning in 1990.

2249 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s t he hours in a day. For example, 09 A M - 10 A M, 10 A M - 11

Hour
A M, and so on.

List s all t he minut es in an hour. For example, if t he hour specif ied is

Minut e 10 A M - 11 A M, list s minut es as 10. 30 A M - 10. 31 A M, 10. 32 A M -
10. 33 A M, and so on.

Mont h List s all mont hs, beginning wit h 2000.

Mont h of Y ear List s all mont hs in a specif ied year.

Quart er List s all quart ers.

Quart er of
List s all quart ers of t he year.
Y ear

List s all weeks in all years, beginning in 2000. Weeks in 2000 are
represent ed as a number ranging f rom 200001 t o 200053, weeks in
Week of Y ear
2001 are represent ed as a number ranging f rom 200101 t o 200153,
and so on.

Weekday List s all days of t he week.

Y ear List s all years.

Delivery Services Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

A ddress I ndicat es t he address t o which a delivery was sent .

A vg number of recipient s per Met ric of t he average number of recipient s in

subscript ion subscript ions.

A vg S ubscript ion E xecut ion Met ric of t he average amount of t ime subscript ions
Durat ion (hh: mm: ss) t ake t o execut e.

A vg S ubscript ion E xecut ion Met ric of t he average amount of t ime, in seconds,

© 2019, M icr o St r at egy In c. 225 0

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Durat ion (secs) subscript ions t ake t o execut e.

Cont act I ndicat es all cont act s t o whom a delivery was sent .

Cont act Type I ndicat es t he execut ed cont act t ypes.

Day I ndicat es t he day on which t he delivery was sent .

Delivery S t at us I ndicat or I ndicat es whet her t he delivery was successf ul.

Delivery Type I ndicat es t he t ype of delivery.

I ndicat es t he t ype of device t o which t he delivery

Device
was sent .

Document I ndicat es t he document t hat was delivered.

Hour I ndicat es t he hour on which t he delivery was sent .

I ndicat es t he I nt elligence S erver machine t hat

I nt elligence S erver Machine
execut ed t he job.

Met adat a I ndicat es t he monit ored met adat a.

I ndicat es t he minut e on which t he delivery was

Minut e
sent .

Number of Dist inct Document Met ric of t he number of report services document
S ubscript ions subscript ions.

Met ric of t he number of recipient s t hat received

Number of Dist inct Recipient s
cont ent f rom a subscript ion.

Number of Dist inct Report

Met ric of t he number of report subscript ions.
S ubscript ions

Met ric of t he number of execut ed subscript ions.

Number of Dist inct
This does not ref lect t he number of subscript ions
S ubscript ions
in t he met adat a.

Met ric of t he number of subscript ions t hat

Number of E -mail S ubscript ions
delivered cont ent via e-mail.

225 1 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Number of E rrored
Met ric of t he number of subscript ions t hat f ailed.
S ubscript ions

Met ric of t he number of execut ions of a

Number of E xecut ions
subscript ion.

Met ric of t he number of subscript ions t hat

Number of File S ubscript ions
delivered cont ent via f ile locat ion.

Number of Hist ory List Met ric of t he number of subscript ions t hat
S ubscript ions delivered cont ent via t he hist ory list .

Met ric of t he number of subscript ions t hat

Number of Mobile S ubscript ions
delivered cont ent via mobile.

Met ric of t he number of subscript ions t hat

Number of P rint S ubscript ions
delivered cont ent via a print er.

P roject List s t he project s.

Report List s t he report s in project s.

Report Job List s an execut ion of a report .

I ndicat es whet her t he execut ion was a report or a

Report / Document I ndicat or
document .

S chedule I ndicat es t he schedule t hat t riggered t he delivery.

I ndicat es t he subscript ion t hat t riggered t he

S ubscript ion
delivery.

S ubscript ion E xecut ion Met ric of t he sum of all execut ion t imes of a
Durat ion (hh: mm: ss) subscript ion.

S ubscript ion E xecut ion Durat ion Met ric of t he sum of all execut ion t imes of a
(secs) subscript ion (in seconds).

© 2019, M icr o St r at egy In c. 225 2

Syst em Ad m in ist r at io n Gu id e

Document Job Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

I ndicat es t he day on which t he document job

Day
execut ed.

Document I ndicat es which document was execut ed.

Document Job I ndicat es an execut ion of a document .

Met ric of t he average dif f erence bet ween st art t ime

DP A verage E lapsed Durat ion
and f inish t ime (including t ime f or prompt
per Job (hh: mm: ss)
responses) of all document job execut ions.

Met ric of t he average dif f erence, in seconds,

DP A verage E lapsed Durat ion bet ween st art t ime and f inish t ime (including t ime
per Job (secs) f or prompt responses) of all document job
execut ions.

DP A verage E xecut ion Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions.

DP A verage E xecut ion Met ric of t he average durat ion of all document job
Durat ion per Job (hh: mm: ss) execut ions.

DP A verage Queue Durat ion Met ric of t he average durat ion of all document job
per Job (hh: mm: ss) execut ions wait ing in t he queue.

DP A verage Queue Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions wait ing in t he queue.

Met ric of t he dif f erence bet ween st art t ime and

DP E lapsed Durat ion
f inish t ime (including t ime f or prompt responses) of
(hh: mm: ss)
a document job.

Met ric of t he average dif f erence, in seconds,

DP E lapsed Durat ion (secs) bet ween st art t ime and f inish t ime (including t ime
f or prompt responses) of a document job.

DP E xecut ion Durat ion Met ric of t he durat ion of a document job's
(hh: mm: ss) execut ion.

225 3 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Met ric of t he durat ion, in seconds, of a document

DP E xecut ion Durat ion (secs)
job's execut ion.

DP Number of Jobs (I S _DOC_ Met ric of t he number of document jobs t hat were
FA CT) execut ed.

DP Number of Jobs wit h Cache Met ric of t he number of document jobs t hat hit a
Hit cache.

DP Number of Jobs wit h E rror Met ric of t he number of document jobs t hat f ailed.

DP Number of Users who ran Met ric of t he number of users who ran document
Document s jobs.

DP P ercent age of Jobs wit h Met ric of t he percent age of document jobs t hat hit
Cache Hit a cache.

DP P ercent age of Jobs wit h Met ric of t he percent age of document jobs t hat
E rror f ailed.

Met ric of t he durat ion of all document job

DP Queue Durat ion (hh: mm: ss)
execut ions wait ing in t he queue.

Met ric of t he durat ion, in seconds, of all document

DP Queue Durat ion (secs)
job execut ions wait ing in t he queue.

Hour I ndicat es t he hour t he document job was execut ed.

I ndicat es t he I nt elligence S erver machine t hat

I nt elligence S erver Machine
execut ed t he document job.

Met adat a I ndicat es t he met adat a st oring t he document .

I ndicat es t he minut e t he document job was

Minut e
execut ed.

P roject I ndicat es t he project st oring t he document .

Report I ndicat es t he report s in t he document .

User I ndicat es t he user who ran t he document job.

© 2019, M icr o St r at egy In c. 225 4

Syst em Ad m in ist r at io n Gu id e

Document Job Step Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

I ndicat es t he day on which t he document job

Day
execut ed.

Document I ndicat es which document was execut ed.

I ndicat es t he sequence number f or st eps in a

Document Job S t ep S equence
document job.

Document Job S t ep Type I ndicat es t he t ype of st ep f or a document job.

Met ric of t he average dif f erence bet ween st art t ime

DP A verage E lapsed Durat ion
and f inish t ime (including t ime f or prompt
per Job (hh: mm: ss)
responses) of all document job execut ions.

Met ric of t he average dif f erence, in seconds,

DP A verage E lapsed Durat ion bet ween st art t ime and f inish t ime (including t ime
per Job (secs) f or prompt responses) of all document job
execut ions.

DP A verage E xecut ion Met ric of t he average durat ion of all document job
Durat ion per Job (hh: mm: ss) execut ions.

DP A verage E xecut ion Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions.

DP A verage Queue Durat ion Met ric of t he average durat ion of all document job
per Job (hh: mm: ss) execut ions wait ing in t he queue.

DP A verage Queue Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions wait ing in t he queue.

Met ric of t he dif f erence bet ween st art t ime and

DP E lapsed Durat ion
f inish t ime (including t ime f or prompt responses) of
(hh: mm: ss)
a document job.

Met ric of t he average dif f erence, in seconds,

DP E lapsed Durat ion (secs) bet ween st art t ime and f inish t ime (including t ime
f or prompt responses) of a document job.

225 5 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

DP E xecut ion Durat ion Met ric of t he durat ion of a document job's
(hh: mm: ss) execut ion.

Met ric of t he durat ion, in seconds, of a document

DP E xecut ion Durat ion (secs)
job's execut ion.

Met ric of t he durat ion of all document job

DP Queue Durat ion (hh: mm: ss)
execut ions wait ing in t he queue.

Met ric of t he durat ion, in seconds, of all document

DP Queue Durat ion (secs)
job execut ions wait ing in t he queue.

Hour I ndicat es t he hour t he document job was execut ed.

Met adat a I ndicat es t he met adat a st oring t he document .

I ndicat es t he minut e t he document job was

Minut e
execut ed.

P roject I ndicat es t he project st oring t he document .

Enterprise Manager Data Load Attributes

Attrib u te n ame F u n ctio n

Dat a Load Finish Displays t he t imest amp of t he end of t he dat a load process
Time f or t he project s t hat are being monit ored.

Dat a Load P roject List s all project s t hat are being monit ored.

List s t he t imest amp of t he st art of t he dat a load process f or

Dat a Load S t art Time
t he project s t hat are being monit ored.

A value of -1 indicat es t hat it is t he summary row in t he E M_

I S _LA S T_UP DA TE t able f or all project s in a dat a load. That
I t em I D summary row has inf ormat ion about how long t he dat a load
t ook. A value of 0 indicat es it is a row wit h project dat a load
det ails.

© 2019, M icr o St r at egy In c. 225 6

Syst em Ad m in ist r at io n Gu id e

Inbox Message Actions Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Day I ndicat es t he day t he manipulat ion was st art ed

Document I ndicat es t he document included in t he message.

I ndicat es t he document job t hat request ed t he Hist ory

Document Job
List message manipulat ion.

HL Days S ince Last Met ric of t he number of days since any act ion was
A ct ion: A ny act ion perf ormed.

HL Days S ince Last Met ric of t he number of days since t he last request was
A ct ion: Request made f or t he cont ent s of a message.

Met ric of t he dat e and t ime of t he last act ion perf ormed
HL Last A ct ion Dat e: A ny
on a message such as read, delet ed, marked as read, and
A ct ion
so on.

HL Last A ct ion Dat e: Met ric of t he dat e and t ime of t he last request made f or
Request t he cont ent s of a message.

HL Number of A ct ions Met ric of t he number of act ions perf ormed on a message.

HL Number of A ct ions by Met ric of t he number of act ions by user perf ormed on a
User message.

HL Number of A ct ions Met ric of t he number of act ions on a message t hat

wit h E rrors result ed in an error.

HL Number of Document Met ric of t he number of document jobs t hat result wit h
Jobs messages.

HL Number of Messages Met ric of t he number of messages.

HL Number of Messages Met ric of t he number of messages t hat result ed in an

wit h E rrors error.

HL Number of Messages Met ric of t he number of request s f or t he cont ent s of a

Request ed message.

225 7 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

HL Number of Report Met ric of t he number of report jobs t hat result f rom
Jobs messages.

I ndicat es t he hour t he manipulat ion was st art ed on a

Hour
Hist ory List message.

I ndicat es t he manipulat ion t hat was perf ormed on a

I nbox A ct ion
Hist ory List message.

I ndicat es t he t ype of manipulat ion t hat was perf ormed on

I nbox A ct ion Type
a Hist ory List message.

I nbox Message I ndicat es t he message in t he Hist ory List .

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he message.

Met adat a I ndicat es t he met adat a st oring t he message.

Minut e I ndicat es t he minut e t he manipulat ion was st art ed.

P roject I ndicat es t he project st oring t he message.

Report I ndicat es t he report included in t he message.

I ndicat es t he job I D of t he report included in t he

Report Job
message.

I ndicat es t he user who manipulat ed t he Hist ory List

User
message.

Mobile Client Attributes

Attrib u te n ame F u n ctio n

I ndicat es whet her a cache was hit during t he execut ion

Cache Hit I ndicat or
and, if so, what t ype of cache hit .

© 2019, M icr o St r at egy In c. 225 8

Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

Day I ndicat es t he day t he act ion st art ed.

Document I dent if ies t he document used in t he request .

I ndicat es t he t ype of report or document t hat init iat ed t he

E xecut ion Type I ndicat or
execut ion.

I ndicat es t he locat ion, in lat it ude and longit ude f orm, of

Geocode
t he user.

Hour I ndicat es t he hour t he act ion st art ed.

I nt elligence S erver
I ndicat es t he I nt elligence S erver processing t he request .
Machine

I ndicat es t he met adat a reposit ory st oring t he report or

Met adat a
document .

Minut e I ndicat es t he minut e t he act ion st art ed.

Mobile Device
I ndicat es t he unique I nst allat ion I D of t he mobile app.
I nst allat ion I D

I ndicat es t he t ype of mobile device t he app is inst alled

Mobile Device Type
on, such as I P A D2, DROI D, and so on.

I ndicat es t he version of t he MicroS t rat egy app making t he

MS TR A pp V ersion
request .

I ndicat es t he t ype of net work used, such as 3G, WI FI ,

Net work Type
LTE , and so on.

I ndicat es t he operat ing syst em of t he mobile device

Operat ing S yst em
making t he request .

Operat ing S yst em I ndicat es t he operat ing syst em version of t he mobile

V ersion device making t he request .

P roject I ndicat es t he project used t o init iat e t he request .

User I ndicat es t he user t hat init iat ed t he request .

225 9 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

OLAP Services Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Day I ndicat es t he day t he act ion was st art ed.

Hour I ndicat es t he hour t he act ion was st art ed.

I nt elligent Cube I ndicat es t he I nt elligent Cube t hat was used.

I nt elligent Cube A ct ion Met ric of t he durat ion, in seconds, f or an act ion t hat was
Durat ion (secs) perf ormed on t he I nt ellgent Cube.

I nt elligent Cube A ct ion I ndicat es t he t ype of act ion t aken on t he I nt elligent Cube
Type such as cube publish, cube view hit , and so on.

I ndicat es t he I nt elligent Cube inst ance in memory t hat

I nt elligent Cube I nst ance
was used f or t he act ion.

I nt elligent Cube S ize I f t he I nt elligent Cube is published or ref reshed, indicat es

(K B ) t he size, in K B , of t he I nt elligent Cube.

I ndicat es t he t ype of I nt elligent Cube used, such as

I nt elligent Cube Type working set report , Report S ervices B ase report , OLA P
Cube report , and so on.

Minut e I ndicat es t he minut e on which t he act ion was st art ed.

Met ric of how many jobs f rom report s not based on

Number of Dynamically
I nt elligent Cubes but select ed by t he engine t o go against
S ourced Report Jobs
an I nt elligent Cube because t he object s on t he report
against I nt elligent Cubes
mat ched what is on t he I nt elligent Cube.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube P ublishes published.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube Ref reshes ref reshed.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube Republishes republished.

© 2019, M icr o St r at egy In c. 2260

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Number of Jobs wit h Met ric of how many job execut ions used an I nt elligent
I nt elligent Cube Hit Cube.

Met ric of how many users execut ed a report or document

Number of Users hit t ing
t hat used an I nt elligent Cube. That is, t he number of
I nt elligent Cubes
users using OLA P S ervices.

Number of V iew Report Met ric of how many act ions were t he result of a V iew
Jobs Report .

Report I ndicat es t he report t hat hit t he I nt elligent Cube.

Performance Monitoring Attributes

Attrib u te n ame F u n ctio n

I ndicat es cat egory of t he count er, such as memory,

Count er Cat egory
MicroS t rat egy server jobs, or MicroS t rat egy server users.

I ndicat es t he inst ance I D of t he count er, f or MicroS t rat egy

Count er I nst ance
use.

Day I ndicat es t he day t he act ion was st art ed.

Hour I ndicat es t he hour t he act ion was st art ed.

Minut e I ndicat es t he minut e t he act ion was st art ed.

P erf ormance Monit or I ndicat es t he name of t he perf ormance count er and it s value
Count er t ype.

2261 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Prompt Answers Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Connect ion S ource Indicates the connection source to Intelligence Server.

Count of P rompt
Metric of how many prompts were answered.
A nswers

Day I ndicat es t he day t he prompt was answered.

Document I ndicat es t he document t hat used t he prompt .

Hour I ndicat es t he hour t he prompt was answered.

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he job.

Met adat a I ndicat es t he met adat a reposit ory st oring t he prompt .

Minut e I ndicat es t he minut e t he prompt was answered.

P roject I ndicat es t he project st oring t he prompt .

P rompt I ndicat es t he prompt t hat was used.

P rompt A nswer I ndicat es t he answers f or t he prompt in various inst ances.

P rompt A nswer Required I ndicat es whet her an answer t o t he prompt was required.

I ndicat es t he answer of an inst ance of a prompt in a

P rompt I nst ance A nswer
report job.

P rompt Locat ion Indicates the ID of the location in which a prompt is stored.

Indicates the type of the object in which the prompt is stored, such
P rompt Locat ion Type
as filter, template, attribute, and so on.

I ndicat es t he t it le of t he prompt (t he t it le t he user sees

P rompt Tit le
when present ed during job execut ion).

I ndicat es what t ype of prompt was used, such as dat e,

P rompt Type
double, element s, and so on.

© 2019, M icr o St r at egy In c. 2262

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Report I ndicat es t he report t hat used t he prompt .

Report Job I ndicat es t he report job t hat used t he prompt .

RP Number of Jobs (I S _
Met ric of how many jobs involved a prompt .
P R_A NS _FA CT)

RP Number of Jobs
Met ric of how many report jobs had a specif ied prompt
Cont aining P rompt
answer value.
A nswer V alue

RP Number of Jobs Not

Met ric of how many report jobs did not have a specif ied
Cont aining P rompt
prompt answer value.
A nswer V alue

RP Number of Jobs wit h Met ric of how many report jobs had a prompt t hat was not
Unanswered P rompt s answered.

Report Job Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion is ad hoc.

Cache Creat ion I ndicat or I ndicat es whet her an execut ion has creat ed a cache.

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Cancelled I ndicat or I ndicat es whet her an execut ion has been canceled.

I ndicat es whet her a job was a document dat aset or a

Child Job I ndicat or
st andalone report .

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

2263 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

I ndicat es whet her a report request f ailed because of a

Dat abase E rror I ndicat or
dat abase error.

Dat amart I ndicat or I ndicat es whet her an execut ion creat ed a dat a mart .

Day I ndicat es t he day on which t he report was execut ed.

I ndicat es t he dat abase inst ance on which t he report was

DB I nst ance
execut ed.

Drill I ndicat or I ndicat es whet her an execut ion is a result of a drill.

I ndicat es whet her an execut ion is a result of an element

E lement Load I ndicat or
load.

E rror I ndicat or I ndicat es whet her an execut ion encount ered an error.

I ndicat es whet her a report was export ed and, if so,

E xport I ndicat or
indicat es it s f ormat .

Filt er I ndicat es t he f ilt er used on t he report .

Hour I ndicat es t he hour on which t he report was execut ed.

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he report .

Met adat a I ndicat es t he met adat a reposit ory t hat st ores t he report .

I ndicat es t he minut e on which t he report execut ion was

Minut e
st art ed.

Number of Jobs wit h Met ric of how many job execut ions used an I nt elligent
I nt elligent Cube Hit Cube.

P roject I ndicat es t he met adat a reposit ory t hat st ores t he report .

P rompt I ndicat or I ndicat es whet her t he report execut ion was prompt ed.

Report I ndicat es t he I D of t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

© 2019, M icr o St r at egy In c. 2264

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP A verage E lapsed
Met ric of t he average dif f erence bet ween st art t ime and
Durat ion per Job
f inish t ime (including t ime f or prompt responses) of all
(hh: mm: ss) (I S _RE P _
report job execut ions.
FA CT)

RP A verage E lapsed Met ric of t he average dif f erence bet ween st art t ime and
Durat ion per Job (secs) f inish t ime (including t ime f or prompt responses) of all
(I S _RE P _FA CT) report job execut ions.

RP A verage E xecut ion

Durat ion per Job Met ric of t he average durat ion of all report job execut ions.
(hh: mm: ss) (I S _RE P _ I ncludes t ime in queue and execut ion f or a report job.
FA CT)

RP A verage E xecut ion Met ric of t he average durat ion, in seconds, of all report
Durat ion per Job (secs) job execut ions. I ncludes t ime in queue and execut ion f or
(I S _RE P _FA CT) a report job.

RP A verage P rompt
Met ric of t he average t ime users t ake t o answer t he set of
A nswer Time per Job
prompt s in all report jobs.
(hh: mm: ss)

RP A verage P rompt
Met ric of t he average t ime, in seconds, users t ake t o
A nswer Time per Job
answer t he set of prompt s in all report jobs.
(secs)

RP A verage Queue
Met ric of t he average t ime report jobs wait ed in t he
Durat ion per Job
I nt elligence S erver's queue bef ore t he report job was
(hh: mm: ss) (I S _RE P _
execut ed.
FA CT)

RP A verage Queue Met ric of t he average t ime, in seconds, report jobs wait ed
Durat ion per Job (secs) in t he I nt elligence S erver's queue bef ore t he report job
(I S _RE P _FA CT) was execut ed.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E lapsed Durat ion
of a report job. I ncludes t ime f or prompt responses, in
(hh: mm: ss)
queue, and execut ion.

2265 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E lapsed Durat ion
and f inish t ime of a report job. I ncludes t ime f or prompt
(secs)
responses, in queue, and execut ion.

RP E xecut ion Durat ion Met ric of t he durat ion of a report job's execut ion. I ncludes
(hh: mm: ss) dat abase execut ion t ime.

RP E xecut ion Durat ion Met ric of t he durat ion, in seconds, of a report job's
(secs) execut ion. I ncludes dat abase execut ion t ime.

RP Number of A d Hoc Met ric of how many report jobs result ed f rom an ad hoc
Jobs report creat ion.

RP Number of Cancelled
Met ric of how many job execut ions were canceled.
Jobs

Met ric of how many job execut ions result ed f rom a drill
RP Number of Drill Jobs
act ion.

RP Number of Jobs (I S _
Met ric of how many report jobs were execut ed.
RE P _FA CT)

RP Number of Jobs Met ric of how many report jobs were execut ed against t he
hit t ing Dat abase dat abase.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
Cache Creat ion result in creat ing a server cache.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
Cache Hit hit a server cache.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
E lement Loading result f rom loading addit ional at t ribut e element s.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
Cache Creat ion result ed in a server cache being creat ed.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat hit a
Cache Hit server cache.

© 2019, M icr o St r at egy In c. 2266

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
Dat amart Creat ion result ed in a dat a mart being creat ed.

RP Number of Jobs wit h Met ric of how many report jobs f ailed because of a
DB E rror dat abase error.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
E lement Loading result ed f rom loading addit ional at t ribut e element s.

RP Number of Jobs wit h

Met ric of how many report jobs f ailed because of an error.
E rror

RP Number of Jobs wit h Met ric of how many report job execut ions used an
I nt elligent Cube Hit I nt elligent Cube.

RP Number of Jobs wit h Met ric of how many report job execut ions used a securit y
S ecurit y Filt er f ilt er.

RP Number of Jobs wit h

Met ric of how many report jobs execut ed S QL st at ement s.
S QL E xecut ion

RP number of Met ric of how many report job execut ions were run
Narrowcast S erver jobs t hrough MicroS t rat egy Narrowcast S erver.

RP Number of P rompt ed Met ric of how many report job execut ions included a
Jobs prompt .

RP Number of Report
Met ric of how many report jobs execut ed as a result of a
Jobs f rom Document
document execut ion.
E xecut ion

RP Number of Result Met ric of how many result rows were ret urned f rom a
Rows report execut ion.

RP Number of
Met ric of how many report jobs were scheduled.
S cheduled Jobs

RP Number of Users who

Met ric of how many dist inct users ran report jobs.
ran report s

2267 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP P rompt A nswer Met ric of t he how long users t ake t o answer t he set of
Durat ion (hh: mm: ss) prompt s in report jobs.

RP P rompt A nswer Met ric of t he how long, in seconds, users t ake t o answer
Durat ion (secs) t he set of prompt s in report jobs.

RP Queue Durat ion Met ric of how long a report job wait ed in t he I nt elligence
(hh: mm: ss) S erver's queue bef ore t he report job was execut ed.

Met ric of how long, in seconds, a report job wait ed in t he

RP Queue Durat ion
I nt elligence S erver's queue bef ore t he report job was
(secs)
execut ed.

S chedule I ndicat es t he schedule t hat began t he report execut ion.

S chedule I ndicat or I ndicat es whet her t he report execut ion was scheduled.

S ecurit y Filt er I ndicat es t he securit y f ilt er used in t he report execut ion.

I ndicat es whet her a securit y f ilt er was used in t he report

S ecurit y Filt er I ndicat or
execut ion.

S QL E xecut ion I ndicat or I ndicat es t hat S QL was execut ed during report execut ion.

Templat e I ndicat es t he report t emplat e t hat was used.

User I ndicat es t he user t hat ran t he report .

Report Job SQL Pass Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her t he execut ion was ad hoc.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

Day I ndicat es t he day in which t he job was execut ed.

© 2019, M icr o St r at egy In c. 2268

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Hour I ndicat es t he hour in which t he report job was execut ed.

I ndicat es t he met adat a reposit ory st oring t he report or

Met adat a
document .

Minut e I ndicat es t he minut e in which t he report job was st art ed.

P roject I ndicat es t he project st oring t he report or document .

Report I ndicat es t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

I ndicat es t he S QL st at ement t hat was execut ed during t he

Report Job S QL P ass
S QL pass.

I ndicat es t he t ype of S QL st at ement t hat was execut ed in

Report Job S QL P ass
t his S QL pass. E xamples are S QL select , S QL insert ,
Type
S QL creat e and such.

RP E xecut ion Durat ion Met ric of t he durat ion of a report job's execut ion. I ncludes
(hh: mm: ss) dat abase execut ion t ime.

RP E xecut ion Durat ion Met ric of t he durat ion, in seconds, of a report job's
(secs) execut ion. I ncludes dat abase execut ion t ime.

RP Last E xecut ion Finish Met ric of t he f inish t imest amp when t he report job was
Timest amp last execut ed.

RP Last E xecut ion S t art Met ric of t he st art t imest amp when t he report job was last
Timest amp execut ed.

RP Number of DB Tables Met ric of how many dat abase t ables were accessed in a
A ccessed report job execut ion.

Met ric of how large, in byt es, t he S QL was f or a report

RP S QL S ize
job.

2269 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Report Job Steps Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion was ad hoc.

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

Day I ndicat es t he day in which t he job was execut ed.

Hour I ndicat es t he hour in which t he report job was execut ed.

Minut e I ndicat es t he minut e in which t he report job was st art ed.

Report I ndicat es t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

I ndicat es t he sequence number in t he series of execut ion

Report Job S t ep
st eps a report job passes t hrough in t he I nt elligence
S equence
S erver.

I ndicat es t he t ype of st ep f or a report job. E xamples are

S QL generat ion, S QL execut ion, A nalyt ical E ngine,
Report Job S t ep Type
Resolut ion S erver, element request , updat e I nt elligent
Cube, and so on.

RP A verage CP U
E xecut ion Durat ion per Met ric of t he average durat ion, in milliseconds, a report
Job (msecs) (I S _RE P _ job execut ion t akes in t he I nt elligence S erver CP U.
S TE P _FA CT)

RP A verage E lapsed Met ric of t he average dif f erence, in seconds, bet ween
Durat ion per Job (secs) st art t ime and f inish t ime of report job execut ions.
(I S _RE P _S TE P _FA CT) I ncludes t ime f or prompt responses.

RP A verage E xecut ion Met ric of t he average dif f erence, in seconds, bet ween

© 2019, M icr o St r at egy In c. 2270

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Durat ion per Job (secs) st art t ime and f inish t ime of report job execut ions.
(I S _RE P _S TE P _FA CT) I ncludes t ime f or prompt responses.

RP A verage Query
E ngine E xecut ion Met ric of t he average t ime, in seconds, t he Query E ngine
Durat ion per Job (secs) t akes t o process a report job.
(I S _RE P _S TE P _FA CT)

RP A verage Queue Met ric of t he average t ime report jobs wait ed in t he

Durat ion per Job (secs) I nt elligence S erver's queue bef ore t he report job was
(I S _RE P _S TE P _FA CT) execut ed.

Met ric of how long, in milliseconds, a report job execut ion

RP CP U Durat ion (msec)
t akes in t he I nt elligence S erver CP U.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E lapsed Durat ion
of report job execut ions. I ncludes t ime f or prompt
(hh: mm: ss)
responses.

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E lapsed Durat ion
and f inish t ime of report job execut ions. I ncludes t ime f or
(secs)
prompt responses.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E xecut ion Durat ion
of report job execut ions. I ncludes dat abase execut ion
(hh: mm: ss)
t ime.

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E xecut ion Durat ion
and f inish t ime of report job execut ions. I ncludes
(secs)
dat abase execut ion t ime.

RP Last E xecut ion Finish Met ric of t he f inish t imest amp when t he report job was
Timest amp last execut ed.

RP Last E xecut ion S t art Met ric of t he st art t imest amp when t he report job was last
Timest amp execut ed.

RP Number of Jobs (I S _
Met ric of how many report jobs were execut ed.
RE P _S TE P _FA CT)

2271 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP Query E ngine
Met ric of how long t he Query E ngine t ook t o execut e S QL
Durat ion (hh: mm: ss)
f or a report job.
(I S _RE P _S TE P _FA CT)

RP Query E ngine
Met ric of t he t ime, in seconds, t he Query E ngine t akes t o
Durat ion (secs) (I S _
execut e S QL f or a report job.
RE P _S TE P _FA CT)

RP Queue Durat ion Met ric of how long a report job wait ed in t he I nt elligence
(hh: mm: ss) S erver's queue bef ore t he report job was execut ed.

Met ric of how long, in seconds, a report job wait ed in t he

RP Queue Durat ion
I nt elligence S erver's queue bef ore t he report job was
(secs)
execut ed.

RP S QL E ngine Durat ion

Met ric of how long t he S QL E ngine t ook t o generat e S QL
(hh: mm: ss) (I S _RE P _
f or a report job.
S TE P _FA CT)

Report Job Tables/Columns Accessed Attributes and

Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion was ad hoc.

Column I ndicat es t he column t hat was accessed.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es t he day on which t he t able column was

Day
accessed.

I ndicat es t he t able in t he dat abase st oring t he column

DB Table
t hat was accessed.

© 2019, M icr o St r at egy In c. 2272

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

I ndicat es t he hour on which t he t able column was

Hour
accessed.

I ndicat es t he minut e on which t he t able column was

Minut e
accessed.

Report I ndicat es t he report t hat accessed t he t able column.

I ndicat es which execut ion of a report accessed t he t able

Report Job
column.

Met ric of how many report jobs accessed t he dat abase

RP Number of Jobs (I S _
column or t able. The Warehouse Tables A ccessed report
RE P _COL_FA CT)
uses t his met ric.

I ndicat es which t ype of S QL clause was used t o access

S QL Clause Type
t he t able column.

Schema Objects Attributes

Attrib u te
F u n ctio n
n ame

List s all at t ribut es in project s t hat are set up t o be monit ored by

A t t ribut e
E nt erprise Manager.

List s all at t ribut e f orms in project s t hat are set up t o be monit ored
A t t ribut e Form
by E nt erprise Manager.

List s all columns in project s t hat are set up t o be monit ored by

Column
E nt erprise Manager.

List s all physical t ables in t he dat a warehouse t hat are set up t o be

DB Table
monit ored by E nt erprise Manager.

List s all f act s in project s t hat are set up t o be monit ored by

Fact
E nt erprise Manager.

2273 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s all hierarchies in project s t hat are set up t o be monit ored by

Hierarchy
E nt erprise Manager

List s all logical t ables in project s t hat are set up t o be monit ored by
Table
E nt erprise Manager.

List s all t ransf ormat ions in project s t hat are set up t o be monit ored
Transf ormat ion
by E nt erprise Manager.

Server Machines Attributes

Attrib u te n ame F u n ctio n

List s all machines t hat have had users connect t o t he

Client Machine
I nt elligence S erver.

I nt elligence S erver
List s t he clust er of I nt elligence S ervers.
Clust er

I nt elligence S erver List s all machines t hat have logged st at ist ics as an
Machine I nt elligence S erver.

Web S erver Machine List s all machines used as web servers.

Session Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A vg. Connect ion Met ric of t he average t ime connect ions t o an I nt elligence
Durat ion (hh: mm: ss) S erver last .

A vg. Connect ion Met ric of t he average t ime, in seconds, connect ions t o an
Durat ion (secs) I nt elligence S erver last .

© 2019, M icr o St r at egy In c. 2274

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Connect ion Durat ion Met ric of t he t ime a connect ion t o an I nt elligence S erver
(hh: mm: ss) last s.

Connect ion Durat ion Met ric of t he t ime, in seconds, a connect ion t o an
(secs) I nt elligence S erver last s.

Connect ion S ource List s all connect ion sources t o I nt elligence S erver.

Met ric of how many sessions were connect ed t o an

Number of S essions
I nt elligence S erver. Usually report ed wit h a dat e and t ime
(Report Level)
at t ribut e.

Met ric of how many dist inct users were connect ed t o an

Number of Users Logged
I nt elligence S erver. Usually report ed wit h a dat e and t ime
I n (Report Level)
at t ribut e.

S ession I ndicat es a user connect ion t o an I nt elligence S erver.

All Indicators and Flags Attributes

Attrib u te n ame F u n ctio n

A d Hoc I ndicat or I ndicat es whet her an execut ion is ad hoc.

Cache Creat ion

I ndicat es whet her an execut ion has creat ed a cache.
I ndicat or

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Cancelled I ndicat or I ndicat es whet her an execut ion has been cancelled.

I ndicat es whet her a job was a document dat aset or a st and-

Child Job I ndicat or
alone report .

Conf igurat ion Object

I ndicat es whet her a conf igurat ion object exist s.
E xist s S t at us

Conf igurat ion List s all conf igurat ion paramet er t ypes.

2275 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

P aramet er V alue Type

Connect ion S ource List s all connect ion sources t o I nt elligence S erver.

Cont act Type List s t he execut ed cont act t ypes.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

Dat abase E rror I ndicat es whet her a report request f ailed because of a
I ndicat or dat abase error.

Dat amart I ndicat or I ndicat es whet her an execut ion creat ed a dat a mart .

I ndicat es whet her an execut ion encount ered a dat abase

DB E rror I ndicat or
error.

Delivery S t at us
I ndicat es whet her a delivery was successf ul.
I ndicat or

Delivery Type List s t he t ype of delivery.

Document Job S t at us
List s t he st at uses of document execut ions.
(Deprecat ed)

Document Job S t ep
List s all possible st eps of document job execut ion.
Type

I ndicat es t he t ype of a document or dossier, such as HTML

Document Type
document , Report S ervices document , or a dossier.

List s t he object f rom which a user drilled when a new report

Drill f rom Object
was run because of a drilling act ion.

Drill I ndicat or I ndicat es whet her an execut ion is a result of a drill.

List s t he object t o which a user drilled when a new report

Drill t o Object
was run because of a drilling act ion.

I ndicat es whet her an execut ion is a result of an element

E lement Load I ndicat or
load.

© 2019, M icr o St r at egy In c. 2276

Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

E rror I ndicat or I ndicat es whet her an execut ion encount ered an error.

E xecut ion Type I ndicat es how t he cont ent was request ed, such as User
I ndicat or E xecut ion, P re-Cached, A pplicat ion Recovery, and so on.

I ndicat es whet her a report was export ed and, if so,

E xport I ndicat or
indicat es it s f ormat .

Hierarchy Drilling I ndicat es whet her a hierarchy is used as a drill hierarchy.

List t he t ypes of manipulat ions t hat can be perf ormed on a

I nbox A ct ion Type
Hist ory List message.

I nt elligent Cube A ct ion

List s act ions perf ormed on or against int elligent cubes.
Type

I nt elligent Cube Type List s all int elligent cube t ypes.

List s all t he possible errors t hat can be ret urned during job
Job E rrorCode
execut ions.

Job P riorit y Map List s t he priorit ies of job execut ions.

E numerat es t he upper limit of t he priorit y ranges f or high,

Job P riorit y Number medium, and low priorit y jobs. Def ault values are 332, 666,
and 999.

Object Creat ion Dat e I ndicat es t he dat e on which an object was creat ed.

Object Creat ion I ndicat es t he week of t he year in which an object was

Week of year creat ed.

Object E xist s S t at us I ndicat es whet her an object exist s.

Object Hidden S t at us I ndicat es whet her an object is hidden.

Object Modif icat ion

I ndicat es t he dat e on which an object was last modif ied.
Dat e

Object Modif icat ion I ndicat es t he week of t he year in which an object was last
Week of year modif ied.

P rompt A nswer I ndicat es whet her a prompt answer was required f or t he job

2277 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

Required execut ion.

P rompt I ndicat or I ndicat es whet her a job execut ion was prompt ed.

Report Job S QL P ass List s t he t ypes of S QL passes t hat t he I nt elligence S erver

Type generat es.

Report Job S t at us
List s t he st at uses of report execut ions.
(Deprecat ed)

Report Job S t ep Type List s all possible st eps of report job execut ion.

I ndicat es t he t ype of a report , such as X DA , relat ional, and

Report Type
so on.

Report / Document I ndicat es whet her t he execut ion was a report or a

I ndicat or document .

S chedule I ndicat or I ndicat es whet her a job execut ion was scheduled.

S ecurit y Filt er I ndicat es whet her a securit y f ilt er was used in t he job
I ndicat or execut ion.

S QL Clause Type List s t he various S QL clause t ypes used by t he S QL E ngine.

S QL E xecut ion
I ndicat es whet her S QL was execut ed in t he job execut ion.
I ndicat or

Application Objects Attributes

Attrib u te
F u n ctio n
n ame

List s all consolidat ions in project s t hat are set up t o be monit ored
Consolidat ion
by E nt erprise Manager.

List s all cust om groups in project s t hat are set up t o be monit ored
Cust om Group
by E nt erprise Manager.

© 2019, M icr o St r at egy In c. 2278

Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s all document s in project s t hat are set up t o be monit ored by

Document
E nt erprise Manager.

List s all f ilt ers in project s t hat are set up t o be monit ored by
Filt er
E nt erprise Manager.

I nt elligent List s all int elligent cubes in project s t hat are set up t o be
Cube monit ored by E nt erprise Manager.

List s all met rics in project s t hat are set up t o be monit ored by
Met ric
E nt erprise Manager.

List s all prompt s in project s t hat are set up t o be monit ored by

P rompt
E nt erprise Manager.

List s all report s in project s t hat are set up t o be monit ored by

Report
E nt erprise Manager.

List s all securit y f ilt ers in project s t hat are set up t o be monit ored
S ecurit y Filt er
by E nt erprise Manager.

List s all t emplat es in project s t hat are set up t o be monit ored by

Templat e
E nt erprise Manager.

Configuration Objects Attributes

Attrib u te n ame F u n ctio n

A ddress List s all addresses t o which deliveries have been sent .

Conf igurat ion Object

List s t he owners of conf igurat ion object s.
Owner

Conf igurat ion

List s all conf igurat ion paramet ers.
P aramet er

Cont act List s all cont act s t o whom deliveries have been sent .

2279 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

DB Connect ion List s all dat abase connect ions.

DB I nst ance List s all dat abase inst ances.

Device List s all devices t o which deliveries have been sent .

E vent List s all event s being t racked.

Folder List s all f olders wit hin project s.

I nt elligence S erver
List s all I nt elligence S erver def init ions.
Def init ion

Met adat a List s all monit ored met adat a.

Owner List s t he owners of all object s.

P roject List s all project s.

S chedule List s all schedules.

S ubscript ion List s all execut ed t ransmissions.

Transmit t er List s all t ransmit t ers.

User List s all users being t racked.

User Group List s all user groups.

User Group (P arent ) List s all user groups t hat are parent s of ot her user groups.

Date and Time Attributes

Attrib u te
F u n ctio n
n ame

Calendar List s every calendar week, beginning wit h 2000-01-01, as an

Week int eger.

Day List s all days, beginning in 1990.

© 2019, M icr o St r at egy In c. 2280

Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s t he hours in a day. For example, 09 A M - 10 A M, 10 A M - 11

Hour
A M, and so on.

List s all t he minut es in an hour. For example, if t he hour specif ied is

Minut e 10 A M - 11 A M, list s minut es as 10. 30 A M - 10. 31 A M, 10. 32 A M -
10. 33 A M, and so on.

Mont h List s all mont hs, beginning wit h 2000.

Mont h of Y ear List s all mont hs in a specif ied year.

Quart er List s all quart ers.

Quart er of
List s all quart ers of t he year.
Y ear

List s all weeks in all years, beginning in 2000. Weeks in 2000 are
represent ed as a number ranging f rom 200001 t o 200053, weeks in
Week of Y ear
2001 are represent ed as a number ranging f rom 200101 t o 200153,
and so on.

Weekday List s all days of t he week.

Y ear List s all years.

Delivery Services Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

A ddress I ndicat es t he address t o which a delivery was sent .

A vg number of recipient s per Met ric of t he average number of recipient s in

subscript ion subscript ions.

A vg S ubscript ion E xecut ion Met ric of t he average amount of t ime subscript ions
Durat ion (hh: mm: ss) t ake t o execut e.

A vg S ubscript ion E xecut ion Met ric of t he average amount of t ime, in seconds,

2281 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Durat ion (secs) subscript ions t ake t o execut e.

Cont act I ndicat es all cont act s t o whom a delivery was sent .

Cont act Type I ndicat es t he execut ed cont act t ypes.

Day I ndicat es t he day on which t he delivery was sent .

Delivery S t at us I ndicat or I ndicat es whet her t he delivery was successf ul.

Delivery Type I ndicat es t he t ype of delivery.

I ndicat es t he t ype of device t o which t he delivery

Device
was sent .

Document I ndicat es t he document t hat was delivered.

Hour I ndicat es t he hour on which t he delivery was sent .

I ndicat es t he I nt elligence S erver machine t hat

I nt elligence S erver Machine
execut ed t he job.

Met adat a I ndicat es t he monit ored met adat a.

I ndicat es t he minut e on which t he delivery was

Minut e
sent .

Number of Dist inct Document Met ric of t he number of report services document
S ubscript ions subscript ions.

Met ric of t he number of recipient s t hat received

Number of Dist inct Recipient s
cont ent f rom a subscript ion.

Number of Dist inct Report

Met ric of t he number of report subscript ions.
S ubscript ions

Met ric of t he number of execut ed subscript ions.

Number of Dist inct
This does not ref lect t he number of subscript ions
S ubscript ions
in t he met adat a.

Met ric of t he number of subscript ions t hat

Number of E -mail S ubscript ions
delivered cont ent via e-mail.

© 2019, M icr o St r at egy In c. 2282

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Number of E rrored
Met ric of t he number of subscript ions t hat f ailed.
S ubscript ions

Met ric of t he number of execut ions of a

Number of E xecut ions
subscript ion.

Met ric of t he number of subscript ions t hat

Number of File S ubscript ions
delivered cont ent via f ile locat ion.

Number of Hist ory List Met ric of t he number of subscript ions t hat
S ubscript ions delivered cont ent via t he hist ory list .

Met ric of t he number of subscript ions t hat

Number of Mobile S ubscript ions
delivered cont ent via mobile.

Met ric of t he number of subscript ions t hat

Number of P rint S ubscript ions
delivered cont ent via a print er.

P roject List s t he project s.

Report List s t he report s in project s.

Report Job List s an execut ion of a report .

I ndicat es whet her t he execut ion was a report or a

Report / Document I ndicat or
document .

S chedule I ndicat es t he schedule t hat t riggered t he delivery.

I ndicat es t he subscript ion t hat t riggered t he

S ubscript ion
delivery.

S ubscript ion E xecut ion Met ric of t he sum of all execut ion t imes of a
Durat ion (hh: mm: ss) subscript ion.

S ubscript ion E xecut ion Durat ion Met ric of t he sum of all execut ion t imes of a
(secs) subscript ion (in seconds).

2283 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Document Job Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

I ndicat es t he day on which t he document job

Day
execut ed.

Document I ndicat es which document was execut ed.

Document Job I ndicat es an execut ion of a document .

Met ric of t he average dif f erence bet ween st art t ime

DP A verage E lapsed Durat ion
and f inish t ime (including t ime f or prompt
per Job (hh: mm: ss)
responses) of all document job execut ions.

Met ric of t he average dif f erence, in seconds,

DP A verage E lapsed Durat ion bet ween st art t ime and f inish t ime (including t ime
per Job (secs) f or prompt responses) of all document job
execut ions.

DP A verage E xecut ion Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions.

DP A verage E xecut ion Met ric of t he average durat ion of all document job
Durat ion per Job (hh: mm: ss) execut ions.

DP A verage Queue Durat ion Met ric of t he average durat ion of all document job
per Job (hh: mm: ss) execut ions wait ing in t he queue.

DP A verage Queue Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions wait ing in t he queue.

Met ric of t he dif f erence bet ween st art t ime and

DP E lapsed Durat ion
f inish t ime (including t ime f or prompt responses) of
(hh: mm: ss)
a document job.

Met ric of t he average dif f erence, in seconds,

DP E lapsed Durat ion (secs) bet ween st art t ime and f inish t ime (including t ime
f or prompt responses) of a document job.

DP E xecut ion Durat ion Met ric of t he durat ion of a document job's
(hh: mm: ss) execut ion.

© 2019, M icr o St r at egy In c. 2284

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Met ric of t he durat ion, in seconds, of a document

DP E xecut ion Durat ion (secs)
job's execut ion.

DP Number of Jobs (I S _DOC_ Met ric of t he number of document jobs t hat were
FA CT) execut ed.

DP Number of Jobs wit h Cache Met ric of t he number of document jobs t hat hit a
Hit cache.

DP Number of Jobs wit h E rror Met ric of t he number of document jobs t hat f ailed.

DP Number of Users who ran Met ric of t he number of users who ran document
Document s jobs.

DP P ercent age of Jobs wit h Met ric of t he percent age of document jobs t hat hit
Cache Hit a cache.

DP P ercent age of Jobs wit h Met ric of t he percent age of document jobs t hat
E rror f ailed.

Met ric of t he durat ion of all document job

DP Queue Durat ion (hh: mm: ss)
execut ions wait ing in t he queue.

Met ric of t he durat ion, in seconds, of all document

DP Queue Durat ion (secs)
job execut ions wait ing in t he queue.

Hour I ndicat es t he hour t he document job was execut ed.

I ndicat es t he I nt elligence S erver machine t hat

I nt elligence S erver Machine
execut ed t he document job.

Met adat a I ndicat es t he met adat a st oring t he document .

I ndicat es t he minut e t he document job was

Minut e
execut ed.

P roject I ndicat es t he project st oring t he document .

Report I ndicat es t he report s in t he document .

User I ndicat es t he user who ran t he document job.

2285 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Document Job Step Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

I ndicat es t he day on which t he document job

Day
execut ed.

Document I ndicat es which document was execut ed.

I ndicat es t he sequence number f or st eps in a

Document Job S t ep S equence
document job.

Document Job S t ep Type I ndicat es t he t ype of st ep f or a document job.

Met ric of t he average dif f erence bet ween st art t ime

DP A verage E lapsed Durat ion
and f inish t ime (including t ime f or prompt
per Job (hh: mm: ss)
responses) of all document job execut ions.

Met ric of t he average dif f erence, in seconds,

DP A verage E lapsed Durat ion bet ween st art t ime and f inish t ime (including t ime
per Job (secs) f or prompt responses) of all document job
execut ions.

DP A verage E xecut ion Met ric of t he average durat ion of all document job
Durat ion per Job (hh: mm: ss) execut ions.

DP A verage E xecut ion Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions.

DP A verage Queue Durat ion Met ric of t he average durat ion of all document job
per Job (hh: mm: ss) execut ions wait ing in t he queue.

DP A verage Queue Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions wait ing in t he queue.

Met ric of t he dif f erence bet ween st art t ime and

DP E lapsed Durat ion
f inish t ime (including t ime f or prompt responses) of
(hh: mm: ss)
a document job.

Met ric of t he average dif f erence, in seconds,

DP E lapsed Durat ion (secs) bet ween st art t ime and f inish t ime (including t ime
f or prompt responses) of a document job.

© 2019, M icr o St r at egy In c. 2286

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

DP E xecut ion Durat ion Met ric of t he durat ion of a document job's
(hh: mm: ss) execut ion.

Met ric of t he durat ion, in seconds, of a document

DP E xecut ion Durat ion (secs)
job's execut ion.

Met ric of t he durat ion of all document job

DP Queue Durat ion (hh: mm: ss)
execut ions wait ing in t he queue.

Met ric of t he durat ion, in seconds, of all document

DP Queue Durat ion (secs)
job execut ions wait ing in t he queue.

Hour I ndicat es t he hour t he document job was execut ed.

Met adat a I ndicat es t he met adat a st oring t he document .

I ndicat es t he minut e t he document job was

Minut e
execut ed.

P roject I ndicat es t he project st oring t he document .

Enterprise Manager Data Load Attributes

Attrib u te n ame F u n ctio n

Dat a Load Finish Displays t he t imest amp of t he end of t he dat a load process
Time f or t he project s t hat are being monit ored.

Dat a Load P roject List s all project s t hat are being monit ored.

List s t he t imest amp of t he st art of t he dat a load process f or

Dat a Load S t art Time
t he project s t hat are being monit ored.

A value of -1 indicat es t hat it is t he summary row in t he E M_

I S _LA S T_UP DA TE t able f or all project s in a dat a load. That
I t em I D summary row has inf ormat ion about how long t he dat a load
t ook. A value of 0 indicat es it is a row wit h project dat a load
det ails.

2287 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Inbox Message Actions Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Day I ndicat es t he day t he manipulat ion was st art ed

Document I ndicat es t he document included in t he message.

I ndicat es t he document job t hat request ed t he Hist ory

Document Job
List message manipulat ion.

HL Days S ince Last Met ric of t he number of days since any act ion was
A ct ion: A ny act ion perf ormed.

HL Days S ince Last Met ric of t he number of days since t he last request was
A ct ion: Request made f or t he cont ent s of a message.

Met ric of t he dat e and t ime of t he last act ion perf ormed
HL Last A ct ion Dat e: A ny
on a message such as read, delet ed, marked as read, and
A ct ion
so on.

HL Last A ct ion Dat e: Met ric of t he dat e and t ime of t he last request made f or
Request t he cont ent s of a message.

HL Number of A ct ions Met ric of t he number of act ions perf ormed on a message.

HL Number of A ct ions by Met ric of t he number of act ions by user perf ormed on a
User message.

HL Number of A ct ions Met ric of t he number of act ions on a message t hat

wit h E rrors result ed in an error.

HL Number of Document Met ric of t he number of document jobs t hat result wit h
Jobs messages.

HL Number of Messages Met ric of t he number of messages.

HL Number of Messages Met ric of t he number of messages t hat result ed in an

wit h E rrors error.

HL Number of Messages Met ric of t he number of request s f or t he cont ent s of a

Request ed message.

© 2019, M icr o St r at egy In c. 2288

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

HL Number of Report Met ric of t he number of report jobs t hat result f rom
Jobs messages.

I ndicat es t he hour t he manipulat ion was st art ed on a

Hour
Hist ory List message.

I ndicat es t he manipulat ion t hat was perf ormed on a

I nbox A ct ion
Hist ory List message.

I ndicat es t he t ype of manipulat ion t hat was perf ormed on

I nbox A ct ion Type
a Hist ory List message.

I nbox Message I ndicat es t he message in t he Hist ory List .

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he message.

Met adat a I ndicat es t he met adat a st oring t he message.

Minut e I ndicat es t he minut e t he manipulat ion was st art ed.

P roject I ndicat es t he project st oring t he message.

Report I ndicat es t he report included in t he message.

I ndicat es t he job I D of t he report included in t he

Report Job
message.

I ndicat es t he user who manipulat ed t he Hist ory List

User
message.

Mobile Client Attributes

Attrib u te n ame F u n ctio n

I ndicat es whet her a cache was hit during t he execut ion

Cache Hit I ndicat or
and, if so, what t ype of cache hit .

2289 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

Day I ndicat es t he day t he act ion st art ed.

Document I dent if ies t he document used in t he request .

I ndicat es t he t ype of report or document t hat init iat ed t he

E xecut ion Type I ndicat or
execut ion.

I ndicat es t he locat ion, in lat it ude and longit ude f orm, of

Geocode
t he user.

Hour I ndicat es t he hour t he act ion st art ed.

I nt elligence S erver
I ndicat es t he I nt elligence S erver processing t he request .
Machine

I ndicat es t he met adat a reposit ory st oring t he report or

Met adat a
document .

Minut e I ndicat es t he minut e t he act ion st art ed.

Mobile Device
I ndicat es t he unique I nst allat ion I D of t he mobile app.
I nst allat ion I D

I ndicat es t he t ype of mobile device t he app is inst alled

Mobile Device Type
on, such as I P A D2, DROI D, and so on.

I ndicat es t he version of t he MicroS t rat egy app making t he

MS TR A pp V ersion
request .

I ndicat es t he t ype of net work used, such as 3G, WI FI ,

Net work Type
LTE , and so on.

I ndicat es t he operat ing syst em of t he mobile device

Operat ing S yst em
making t he request .

Operat ing S yst em I ndicat es t he operat ing syst em version of t he mobile

V ersion device making t he request .

P roject I ndicat es t he project used t o init iat e t he request .

User I ndicat es t he user t hat init iat ed t he request .

© 2019, M icr o St r at egy In c. 2290

Syst em Ad m in ist r at io n Gu id e

OLAP Services Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Day I ndicat es t he day t he act ion was st art ed.

Hour I ndicat es t he hour t he act ion was st art ed.

I nt elligent Cube I ndicat es t he I nt elligent Cube t hat was used.

I nt elligent Cube A ct ion Met ric of t he durat ion, in seconds, f or an act ion t hat was
Durat ion (secs) perf ormed on t he I nt ellgent Cube.

I nt elligent Cube A ct ion I ndicat es t he t ype of act ion t aken on t he I nt elligent Cube
Type such as cube publish, cube view hit , and so on.

I ndicat es t he I nt elligent Cube inst ance in memory t hat

I nt elligent Cube I nst ance
was used f or t he act ion.

I nt elligent Cube S ize I f t he I nt elligent Cube is published or ref reshed, indicat es

(K B ) t he size, in K B , of t he I nt elligent Cube.

I ndicat es t he t ype of I nt elligent Cube used, such as

I nt elligent Cube Type working set report , Report S ervices B ase report , OLA P
Cube report , and so on.

Minut e I ndicat es t he minut e on which t he act ion was st art ed.

Met ric of how many jobs f rom report s not based on

Number of Dynamically
I nt elligent Cubes but select ed by t he engine t o go against
S ourced Report Jobs
an I nt elligent Cube because t he object s on t he report
against I nt elligent Cubes
mat ched what is on t he I nt elligent Cube.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube P ublishes published.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube Ref reshes ref reshed.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube Republishes republished.

2291 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Number of Jobs wit h Met ric of how many job execut ions used an I nt elligent
I nt elligent Cube Hit Cube.

Met ric of how many users execut ed a report or document

Number of Users hit t ing
t hat used an I nt elligent Cube. That is, t he number of
I nt elligent Cubes
users using OLA P S ervices.

Number of V iew Report Met ric of how many act ions were t he result of a V iew
Jobs Report .

Report I ndicat es t he report t hat hit t he I nt elligent Cube.

Performance Monitoring Attributes

Attrib u te n ame F u n ctio n

I ndicat es cat egory of t he count er, such as memory,

Count er Cat egory
MicroS t rat egy server jobs, or MicroS t rat egy server users.

I ndicat es t he inst ance I D of t he count er, f or MicroS t rat egy

Count er I nst ance
use.

Day I ndicat es t he day t he act ion was st art ed.

Hour I ndicat es t he hour t he act ion was st art ed.

Minut e I ndicat es t he minut e t he act ion was st art ed.

P erf ormance Monit or I ndicat es t he name of t he perf ormance count er and it s value
Count er t ype.

© 2019, M icr o St r at egy In c. 2292

Syst em Ad m in ist r at io n Gu id e

Prompt Answers Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Connect ion S ource Indicates the connection source to Intelligence Server.

Count of P rompt
Metric of how many prompts were answered.
A nswers

Day I ndicat es t he day t he prompt was answered.

Document I ndicat es t he document t hat used t he prompt .

Hour I ndicat es t he hour t he prompt was answered.

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he job.

Met adat a I ndicat es t he met adat a reposit ory st oring t he prompt .

Minut e I ndicat es t he minut e t he prompt was answered.

P roject I ndicat es t he project st oring t he prompt .

P rompt I ndicat es t he prompt t hat was used.

P rompt A nswer I ndicat es t he answers f or t he prompt in various inst ances.

P rompt A nswer Required I ndicat es whet her an answer t o t he prompt was required.

I ndicat es t he answer of an inst ance of a prompt in a

P rompt I nst ance A nswer
report job.

P rompt Locat ion Indicates the ID of the location in which a prompt is stored.

Indicates the type of the object in which the prompt is stored, such
P rompt Locat ion Type
as filter, template, attribute, and so on.

I ndicat es t he t it le of t he prompt (t he t it le t he user sees

P rompt Tit le
when present ed during job execut ion).

I ndicat es what t ype of prompt was used, such as dat e,

P rompt Type
double, element s, and so on.

2293 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Report I ndicat es t he report t hat used t he prompt .

Report Job I ndicat es t he report job t hat used t he prompt .

RP Number of Jobs (I S _
Met ric of how many jobs involved a prompt .
P R_A NS _FA CT)

RP Number of Jobs
Met ric of how many report jobs had a specif ied prompt
Cont aining P rompt
answer value.
A nswer V alue

RP Number of Jobs Not

Met ric of how many report jobs did not have a specif ied
Cont aining P rompt
prompt answer value.
A nswer V alue

RP Number of Jobs wit h Met ric of how many report jobs had a prompt t hat was not
Unanswered P rompt s answered.

Report Job Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion is ad hoc.

Cache Creat ion I ndicat or I ndicat es whet her an execut ion has creat ed a cache.

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Cancelled I ndicat or I ndicat es whet her an execut ion has been canceled.

I ndicat es whet her a job was a document dat aset or a

Child Job I ndicat or
st andalone report .

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

© 2019, M icr o St r at egy In c. 2294

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

I ndicat es whet her a report request f ailed because of a

Dat abase E rror I ndicat or
dat abase error.

Dat amart I ndicat or I ndicat es whet her an execut ion creat ed a dat a mart .

Day I ndicat es t he day on which t he report was execut ed.

I ndicat es t he dat abase inst ance on which t he report was

DB I nst ance
execut ed.

Drill I ndicat or I ndicat es whet her an execut ion is a result of a drill.

I ndicat es whet her an execut ion is a result of an element

E lement Load I ndicat or
load.

E rror I ndicat or I ndicat es whet her an execut ion encount ered an error.

I ndicat es whet her a report was export ed and, if so,

E xport I ndicat or
indicat es it s f ormat .

Filt er I ndicat es t he f ilt er used on t he report .

Hour I ndicat es t he hour on which t he report was execut ed.

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he report .

Met adat a I ndicat es t he met adat a reposit ory t hat st ores t he report .

I ndicat es t he minut e on which t he report execut ion was

Minut e
st art ed.

Number of Jobs wit h Met ric of how many job execut ions used an I nt elligent
I nt elligent Cube Hit Cube.

P roject I ndicat es t he met adat a reposit ory t hat st ores t he report .

P rompt I ndicat or I ndicat es whet her t he report execut ion was prompt ed.

Report I ndicat es t he I D of t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

2295 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP A verage E lapsed
Met ric of t he average dif f erence bet ween st art t ime and
Durat ion per Job
f inish t ime (including t ime f or prompt responses) of all
(hh: mm: ss) (I S _RE P _
report job execut ions.
FA CT)

RP A verage E lapsed Met ric of t he average dif f erence bet ween st art t ime and
Durat ion per Job (secs) f inish t ime (including t ime f or prompt responses) of all
(I S _RE P _FA CT) report job execut ions.

RP A verage E xecut ion

Durat ion per Job Met ric of t he average durat ion of all report job execut ions.
(hh: mm: ss) (I S _RE P _ I ncludes t ime in queue and execut ion f or a report job.
FA CT)

RP A verage E xecut ion Met ric of t he average durat ion, in seconds, of all report
Durat ion per Job (secs) job execut ions. I ncludes t ime in queue and execut ion f or
(I S _RE P _FA CT) a report job.

RP A verage P rompt
Met ric of t he average t ime users t ake t o answer t he set of
A nswer Time per Job
prompt s in all report jobs.
(hh: mm: ss)

RP A verage P rompt
Met ric of t he average t ime, in seconds, users t ake t o
A nswer Time per Job
answer t he set of prompt s in all report jobs.
(secs)

RP A verage Queue
Met ric of t he average t ime report jobs wait ed in t he
Durat ion per Job
I nt elligence S erver's queue bef ore t he report job was
(hh: mm: ss) (I S _RE P _
execut ed.
FA CT)

RP A verage Queue Met ric of t he average t ime, in seconds, report jobs wait ed
Durat ion per Job (secs) in t he I nt elligence S erver's queue bef ore t he report job
(I S _RE P _FA CT) was execut ed.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E lapsed Durat ion
of a report job. I ncludes t ime f or prompt responses, in
(hh: mm: ss)
queue, and execut ion.

© 2019, M icr o St r at egy In c. 2296

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E lapsed Durat ion
and f inish t ime of a report job. I ncludes t ime f or prompt
(secs)
responses, in queue, and execut ion.

RP E xecut ion Durat ion Met ric of t he durat ion of a report job's execut ion. I ncludes
(hh: mm: ss) dat abase execut ion t ime.

RP E xecut ion Durat ion Met ric of t he durat ion, in seconds, of a report job's
(secs) execut ion. I ncludes dat abase execut ion t ime.

RP Number of A d Hoc Met ric of how many report jobs result ed f rom an ad hoc
Jobs report creat ion.

RP Number of Cancelled
Met ric of how many job execut ions were canceled.
Jobs

Met ric of how many job execut ions result ed f rom a drill
RP Number of Drill Jobs
act ion.

RP Number of Jobs (I S _
Met ric of how many report jobs were execut ed.
RE P _FA CT)

RP Number of Jobs Met ric of how many report jobs were execut ed against t he
hit t ing Dat abase dat abase.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
Cache Creat ion result in creat ing a server cache.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
Cache Hit hit a server cache.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
E lement Loading result f rom loading addit ional at t ribut e element s.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
Cache Creat ion result ed in a server cache being creat ed.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat hit a
Cache Hit server cache.

2297 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
Dat amart Creat ion result ed in a dat a mart being creat ed.

RP Number of Jobs wit h Met ric of how many report jobs f ailed because of a
DB E rror dat abase error.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
E lement Loading result ed f rom loading addit ional at t ribut e element s.

RP Number of Jobs wit h

Met ric of how many report jobs f ailed because of an error.
E rror

RP Number of Jobs wit h Met ric of how many report job execut ions used an
I nt elligent Cube Hit I nt elligent Cube.

RP Number of Jobs wit h Met ric of how many report job execut ions used a securit y
S ecurit y Filt er f ilt er.

RP Number of Jobs wit h

Met ric of how many report jobs execut ed S QL st at ement s.
S QL E xecut ion

RP number of Met ric of how many report job execut ions were run
Narrowcast S erver jobs t hrough MicroS t rat egy Narrowcast S erver.

RP Number of P rompt ed Met ric of how many report job execut ions included a
Jobs prompt .

RP Number of Report
Met ric of how many report jobs execut ed as a result of a
Jobs f rom Document
document execut ion.
E xecut ion

RP Number of Result Met ric of how many result rows were ret urned f rom a
Rows report execut ion.

RP Number of
Met ric of how many report jobs were scheduled.
S cheduled Jobs

RP Number of Users who

Met ric of how many dist inct users ran report jobs.
ran report s

© 2019, M icr o St r at egy In c. 2298

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP P rompt A nswer Met ric of t he how long users t ake t o answer t he set of
Durat ion (hh: mm: ss) prompt s in report jobs.

RP P rompt A nswer Met ric of t he how long, in seconds, users t ake t o answer
Durat ion (secs) t he set of prompt s in report jobs.

RP Queue Durat ion Met ric of how long a report job wait ed in t he I nt elligence
(hh: mm: ss) S erver's queue bef ore t he report job was execut ed.

Met ric of how long, in seconds, a report job wait ed in t he

RP Queue Durat ion
I nt elligence S erver's queue bef ore t he report job was
(secs)
execut ed.

S chedule I ndicat es t he schedule t hat began t he report execut ion.

S chedule I ndicat or I ndicat es whet her t he report execut ion was scheduled.

S ecurit y Filt er I ndicat es t he securit y f ilt er used in t he report execut ion.

I ndicat es whet her a securit y f ilt er was used in t he report

S ecurit y Filt er I ndicat or
execut ion.

S QL E xecut ion I ndicat or I ndicat es t hat S QL was execut ed during report execut ion.

Templat e I ndicat es t he report t emplat e t hat was used.

User I ndicat es t he user t hat ran t he report .

Report Job SQL Pass Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her t he execut ion was ad hoc.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

Day I ndicat es t he day in which t he job was execut ed.

2299 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Hour I ndicat es t he hour in which t he report job was execut ed.

I ndicat es t he met adat a reposit ory st oring t he report or

Met adat a
document .

Minut e I ndicat es t he minut e in which t he report job was st art ed.

P roject I ndicat es t he project st oring t he report or document .

Report I ndicat es t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

I ndicat es t he S QL st at ement t hat was execut ed during t he

Report Job S QL P ass
S QL pass.

I ndicat es t he t ype of S QL st at ement t hat was execut ed in

Report Job S QL P ass
t his S QL pass. E xamples are S QL select , S QL insert ,
Type
S QL creat e and such.

RP E xecut ion Durat ion Met ric of t he durat ion of a report job's execut ion. I ncludes
(hh: mm: ss) dat abase execut ion t ime.

RP E xecut ion Durat ion Met ric of t he durat ion, in seconds, of a report job's
(secs) execut ion. I ncludes dat abase execut ion t ime.

RP Last E xecut ion Finish Met ric of t he f inish t imest amp when t he report job was
Timest amp last execut ed.

RP Last E xecut ion S t art Met ric of t he st art t imest amp when t he report job was last
Timest amp execut ed.

RP Number of DB Tables Met ric of how many dat abase t ables were accessed in a
A ccessed report job execut ion.

Met ric of how large, in byt es, t he S QL was f or a report

RP S QL S ize
job.

© 2019, M icr o St r at egy In c. 2300

Syst em Ad m in ist r at io n Gu id e

Report Job Steps Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion was ad hoc.

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

Day I ndicat es t he day in which t he job was execut ed.

Hour I ndicat es t he hour in which t he report job was execut ed.

Minut e I ndicat es t he minut e in which t he report job was st art ed.

Report I ndicat es t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

I ndicat es t he sequence number in t he series of execut ion

Report Job S t ep
st eps a report job passes t hrough in t he I nt elligence
S equence
S erver.

I ndicat es t he t ype of st ep f or a report job. E xamples are

S QL generat ion, S QL execut ion, A nalyt ical E ngine,
Report Job S t ep Type
Resolut ion S erver, element request , updat e I nt elligent
Cube, and so on.

RP A verage CP U
E xecut ion Durat ion per Met ric of t he average durat ion, in milliseconds, a report
Job (msecs) (I S _RE P _ job execut ion t akes in t he I nt elligence S erver CP U.
S TE P _FA CT)

RP A verage E lapsed Met ric of t he average dif f erence, in seconds, bet ween
Durat ion per Job (secs) st art t ime and f inish t ime of report job execut ions.
(I S _RE P _S TE P _FA CT) I ncludes t ime f or prompt responses.

RP A verage E xecut ion Met ric of t he average dif f erence, in seconds, bet ween

2301 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Durat ion per Job (secs) st art t ime and f inish t ime of report job execut ions.
(I S _RE P _S TE P _FA CT) I ncludes t ime f or prompt responses.

RP A verage Query
E ngine E xecut ion Met ric of t he average t ime, in seconds, t he Query E ngine
Durat ion per Job (secs) t akes t o process a report job.
(I S _RE P _S TE P _FA CT)

RP A verage Queue Met ric of t he average t ime report jobs wait ed in t he

Durat ion per Job (secs) I nt elligence S erver's queue bef ore t he report job was
(I S _RE P _S TE P _FA CT) execut ed.

Met ric of how long, in milliseconds, a report job execut ion

RP CP U Durat ion (msec)
t akes in t he I nt elligence S erver CP U.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E lapsed Durat ion
of report job execut ions. I ncludes t ime f or prompt
(hh: mm: ss)
responses.

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E lapsed Durat ion
and f inish t ime of report job execut ions. I ncludes t ime f or
(secs)
prompt responses.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E xecut ion Durat ion
of report job execut ions. I ncludes dat abase execut ion
(hh: mm: ss)
t ime.

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E xecut ion Durat ion
and f inish t ime of report job execut ions. I ncludes
(secs)
dat abase execut ion t ime.

RP Last E xecut ion Finish Met ric of t he f inish t imest amp when t he report job was
Timest amp last execut ed.

RP Last E xecut ion S t art Met ric of t he st art t imest amp when t he report job was last
Timest amp execut ed.

RP Number of Jobs (I S _
Met ric of how many report jobs were execut ed.
RE P _S TE P _FA CT)

© 2019, M icr o St r at egy In c. 2302

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP Query E ngine
Met ric of how long t he Query E ngine t ook t o execut e S QL
Durat ion (hh: mm: ss)
f or a report job.
(I S _RE P _S TE P _FA CT)

RP Query E ngine
Met ric of t he t ime, in seconds, t he Query E ngine t akes t o
Durat ion (secs) (I S _
execut e S QL f or a report job.
RE P _S TE P _FA CT)

RP Queue Durat ion Met ric of how long a report job wait ed in t he I nt elligence
(hh: mm: ss) S erver's queue bef ore t he report job was execut ed.

Met ric of how long, in seconds, a report job wait ed in t he

RP Queue Durat ion
I nt elligence S erver's queue bef ore t he report job was
(secs)
execut ed.

RP S QL E ngine Durat ion

Met ric of how long t he S QL E ngine t ook t o generat e S QL
(hh: mm: ss) (I S _RE P _
f or a report job.
S TE P _FA CT)

Report Job Tables/Columns Accessed Attributes and

Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion was ad hoc.

Column I ndicat es t he column t hat was accessed.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es t he day on which t he t able column was

Day
accessed.

I ndicat es t he t able in t he dat abase st oring t he column

DB Table
t hat was accessed.

2303 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

I ndicat es t he hour on which t he t able column was

Hour
accessed.

I ndicat es t he minut e on which t he t able column was

Minut e
accessed.

Report I ndicat es t he report t hat accessed t he t able column.

I ndicat es which execut ion of a report accessed t he t able

Report Job
column.

Met ric of how many report jobs accessed t he dat abase

RP Number of Jobs (I S _
column or t able. The Warehouse Tables A ccessed report
RE P _COL_FA CT)
uses t his met ric.

I ndicat es which t ype of S QL clause was used t o access

S QL Clause Type
t he t able column.

Schema Objects Attributes

Attrib u te
F u n ctio n
n ame

List s all at t ribut es in project s t hat are set up t o be monit ored by

A t t ribut e
E nt erprise Manager.

List s all at t ribut e f orms in project s t hat are set up t o be monit ored
A t t ribut e Form
by E nt erprise Manager.

List s all columns in project s t hat are set up t o be monit ored by

Column
E nt erprise Manager.

List s all physical t ables in t he dat a warehouse t hat are set up t o be

DB Table
monit ored by E nt erprise Manager.

List s all f act s in project s t hat are set up t o be monit ored by

Fact
E nt erprise Manager.

© 2019, M icr o St r at egy In c. 2304

Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s all hierarchies in project s t hat are set up t o be monit ored by

Hierarchy
E nt erprise Manager

List s all logical t ables in project s t hat are set up t o be monit ored by
Table
E nt erprise Manager.

List s all t ransf ormat ions in project s t hat are set up t o be monit ored
Transf ormat ion
by E nt erprise Manager.

Server Machines Attributes

Attrib u te n ame F u n ctio n

List s all machines t hat have had users connect t o t he

Client Machine
I nt elligence S erver.

I nt elligence S erver
List s t he clust er of I nt elligence S ervers.
Clust er

I nt elligence S erver List s all machines t hat have logged st at ist ics as an
Machine I nt elligence S erver.

Web S erver Machine List s all machines used as web servers.

Session Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A vg. Connect ion Met ric of t he average t ime connect ions t o an I nt elligence
Durat ion (hh: mm: ss) S erver last .

A vg. Connect ion Met ric of t he average t ime, in seconds, connect ions t o an
Durat ion (secs) I nt elligence S erver last .

2305 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Connect ion Durat ion Met ric of t he t ime a connect ion t o an I nt elligence S erver
(hh: mm: ss) last s.

Connect ion Durat ion Met ric of t he t ime, in seconds, a connect ion t o an
(secs) I nt elligence S erver last s.

Connect ion S ource List s all connect ion sources t o I nt elligence S erver.

Met ric of how many sessions were connect ed t o an

Number of S essions
I nt elligence S erver. Usually report ed wit h a dat e and t ime
(Report Level)
at t ribut e.

Met ric of how many dist inct users were connect ed t o an

Number of Users Logged
I nt elligence S erver. Usually report ed wit h a dat e and t ime
I n (Report Level)
at t ribut e.

S ession I ndicat es a user connect ion t o an I nt elligence S erver.

All Indicators and Flags Attributes

Attrib u te n ame F u n ctio n

A d Hoc I ndicat or I ndicat es whet her an execut ion is ad hoc.

Cache Creat ion

I ndicat es whet her an execut ion has creat ed a cache.
I ndicat or

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Cancelled I ndicat or I ndicat es whet her an execut ion has been cancelled.

I ndicat es whet her a job was a document dat aset or a st and-

Child Job I ndicat or
alone report .

Conf igurat ion Object

I ndicat es whet her a conf igurat ion object exist s.
E xist s S t at us

Conf igurat ion List s all conf igurat ion paramet er t ypes.

© 2019, M icr o St r at egy In c. 2306

Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

P aramet er V alue Type

Connect ion S ource List s all connect ion sources t o I nt elligence S erver.

Cont act Type List s t he execut ed cont act t ypes.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

Dat abase E rror I ndicat es whet her a report request f ailed because of a
I ndicat or dat abase error.

Dat amart I ndicat or I ndicat es whet her an execut ion creat ed a dat a mart .

I ndicat es whet her an execut ion encount ered a dat abase

DB E rror I ndicat or
error.

Delivery S t at us
I ndicat es whet her a delivery was successf ul.
I ndicat or

Delivery Type List s t he t ype of delivery.

Document Job S t at us
List s t he st at uses of document execut ions.
(Deprecat ed)

Document Job S t ep
List s all possible st eps of document job execut ion.
Type

I ndicat es t he t ype of a document or dossier, such as HTML

Document Type
document , Report S ervices document , or a dossier.

List s t he object f rom which a user drilled when a new report

Drill f rom Object
was run because of a drilling act ion.

Drill I ndicat or I ndicat es whet her an execut ion is a result of a drill.

List s t he object t o which a user drilled when a new report

Drill t o Object
was run because of a drilling act ion.

I ndicat es whet her an execut ion is a result of an element

E lement Load I ndicat or
load.

2307 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

E rror I ndicat or I ndicat es whet her an execut ion encount ered an error.

E xecut ion Type I ndicat es how t he cont ent was request ed, such as User
I ndicat or E xecut ion, P re-Cached, A pplicat ion Recovery, and so on.

I ndicat es whet her a report was export ed and, if so,

E xport I ndicat or
indicat es it s f ormat .

Hierarchy Drilling I ndicat es whet her a hierarchy is used as a drill hierarchy.

List t he t ypes of manipulat ions t hat can be perf ormed on a

I nbox A ct ion Type
Hist ory List message.

I nt elligent Cube A ct ion

List s act ions perf ormed on or against int elligent cubes.
Type

I nt elligent Cube Type List s all int elligent cube t ypes.

List s all t he possible errors t hat can be ret urned during job
Job E rrorCode
execut ions.

Job P riorit y Map List s t he priorit ies of job execut ions.

E numerat es t he upper limit of t he priorit y ranges f or high,

Job P riorit y Number medium, and low priorit y jobs. Def ault values are 332, 666,
and 999.

Object Creat ion Dat e I ndicat es t he dat e on which an object was creat ed.

Object Creat ion I ndicat es t he week of t he year in which an object was

Week of year creat ed.

Object E xist s S t at us I ndicat es whet her an object exist s.

Object Hidden S t at us I ndicat es whet her an object is hidden.

Object Modif icat ion

I ndicat es t he dat e on which an object was last modif ied.
Dat e

Object Modif icat ion I ndicat es t he week of t he year in which an object was last
Week of year modif ied.

P rompt A nswer I ndicat es whet her a prompt answer was required f or t he job

© 2019, M icr o St r at egy In c. 2308

Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

Required execut ion.

P rompt I ndicat or I ndicat es whet her a job execut ion was prompt ed.

Report Job S QL P ass List s t he t ypes of S QL passes t hat t he I nt elligence S erver

Type generat es.

Report Job S t at us
List s t he st at uses of report execut ions.
(Deprecat ed)

Report Job S t ep Type List s all possible st eps of report job execut ion.

I ndicat es t he t ype of a report , such as X DA , relat ional, and

Report Type
so on.

Report / Document I ndicat es whet her t he execut ion was a report or a

I ndicat or document .

S chedule I ndicat or I ndicat es whet her a job execut ion was scheduled.

S ecurit y Filt er I ndicat es whet her a securit y f ilt er was used in t he job
I ndicat or execut ion.

S QL Clause Type List s t he various S QL clause t ypes used by t he S QL E ngine.

S QL E xecut ion
I ndicat es whet her S QL was execut ed in t he job execut ion.
I ndicat or

Application Objects Attributes

Attrib u te
F u n ctio n
n ame

List s all consolidat ions in project s t hat are set up t o be monit ored
Consolidat ion
by E nt erprise Manager.

List s all cust om groups in project s t hat are set up t o be monit ored
Cust om Group
by E nt erprise Manager.

2309 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s all document s in project s t hat are set up t o be monit ored by

Document
E nt erprise Manager.

List s all f ilt ers in project s t hat are set up t o be monit ored by
Filt er
E nt erprise Manager.

I nt elligent List s all int elligent cubes in project s t hat are set up t o be
Cube monit ored by E nt erprise Manager.

List s all met rics in project s t hat are set up t o be monit ored by
Met ric
E nt erprise Manager.

List s all prompt s in project s t hat are set up t o be monit ored by

P rompt
E nt erprise Manager.

List s all report s in project s t hat are set up t o be monit ored by

Report
E nt erprise Manager.

List s all securit y f ilt ers in project s t hat are set up t o be monit ored
S ecurit y Filt er
by E nt erprise Manager.

List s all t emplat es in project s t hat are set up t o be monit ored by

Templat e
E nt erprise Manager.

Configuration Objects Attributes

Attrib u te n ame F u n ctio n

A ddress List s all addresses t o which deliveries have been sent .

Conf igurat ion Object

List s t he owners of conf igurat ion object s.
Owner

Conf igurat ion

List s all conf igurat ion paramet ers.
P aramet er

Cont act List s all cont act s t o whom deliveries have been sent .

© 2019, M icr o St r at egy In c. 2310

Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

DB Connect ion List s all dat abase connect ions.

DB I nst ance List s all dat abase inst ances.

Device List s all devices t o which deliveries have been sent .

E vent List s all event s being t racked.

Folder List s all f olders wit hin project s.

I nt elligence S erver
List s all I nt elligence S erver def init ions.
Def init ion

Met adat a List s all monit ored met adat a.

Owner List s t he owners of all object s.

P roject List s all project s.

S chedule List s all schedules.

S ubscript ion List s all execut ed t ransmissions.

Transmit t er List s all t ransmit t ers.

User List s all users being t racked.

User Group List s all user groups.

User Group (P arent ) List s all user groups t hat are parent s of ot her user groups.

Date and Time Attributes

Attrib u te
F u n ctio n
n ame

Calendar List s every calendar week, beginning wit h 2000-01-01, as an

Week int eger.

Day List s all days, beginning in 1990.

2311 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s t he hours in a day. For example, 09 A M - 10 A M, 10 A M - 11

Hour
A M, and so on.

List s all t he minut es in an hour. For example, if t he hour specif ied is

Minut e 10 A M - 11 A M, list s minut es as 10. 30 A M - 10. 31 A M, 10. 32 A M -
10. 33 A M, and so on.

Mont h List s all mont hs, beginning wit h 2000.

Mont h of Y ear List s all mont hs in a specif ied year.

Quart er List s all quart ers.

Quart er of
List s all quart ers of t he year.
Y ear

List s all weeks in all years, beginning in 2000. Weeks in 2000 are
represent ed as a number ranging f rom 200001 t o 200053, weeks in
Week of Y ear
2001 are represent ed as a number ranging f rom 200101 t o 200153,
and so on.

Weekday List s all days of t he week.

Y ear List s all years.

Delivery Services Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

A ddress I ndicat es t he address t o which a delivery was sent .

A vg number of recipient s per Met ric of t he average number of recipient s in

subscript ion subscript ions.

A vg S ubscript ion E xecut ion Met ric of t he average amount of t ime subscript ions
Durat ion (hh: mm: ss) t ake t o execut e.

A vg S ubscript ion E xecut ion Met ric of t he average amount of t ime, in seconds,

© 2019, M icr o St r at egy In c. 2312

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Durat ion (secs) subscript ions t ake t o execut e.

Cont act I ndicat es all cont act s t o whom a delivery was sent .

Cont act Type I ndicat es t he execut ed cont act t ypes.

Day I ndicat es t he day on which t he delivery was sent .

Delivery S t at us I ndicat or I ndicat es whet her t he delivery was successf ul.

Delivery Type I ndicat es t he t ype of delivery.

I ndicat es t he t ype of device t o which t he delivery

Device
was sent .

Document I ndicat es t he document t hat was delivered.

Hour I ndicat es t he hour on which t he delivery was sent .

I ndicat es t he I nt elligence S erver machine t hat

I nt elligence S erver Machine
execut ed t he job.

Met adat a I ndicat es t he monit ored met adat a.

I ndicat es t he minut e on which t he delivery was

Minut e
sent .

Number of Dist inct Document Met ric of t he number of report services document
S ubscript ions subscript ions.

Met ric of t he number of recipient s t hat received

Number of Dist inct Recipient s
cont ent f rom a subscript ion.

Number of Dist inct Report

Met ric of t he number of report subscript ions.
S ubscript ions

Met ric of t he number of execut ed subscript ions.

Number of Dist inct
This does not ref lect t he number of subscript ions
S ubscript ions
in t he met adat a.

Met ric of t he number of subscript ions t hat

Number of E -mail S ubscript ions
delivered cont ent via e-mail.

2313 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Number of E rrored
Met ric of t he number of subscript ions t hat f ailed.
S ubscript ions

Met ric of t he number of execut ions of a

Number of E xecut ions
subscript ion.

Met ric of t he number of subscript ions t hat

Number of File S ubscript ions
delivered cont ent via f ile locat ion.

Number of Hist ory List Met ric of t he number of subscript ions t hat
S ubscript ions delivered cont ent via t he hist ory list .

Met ric of t he number of subscript ions t hat

Number of Mobile S ubscript ions
delivered cont ent via mobile.

Met ric of t he number of subscript ions t hat

Number of P rint S ubscript ions
delivered cont ent via a print er.

P roject List s t he project s.

Report List s t he report s in project s.

Report Job List s an execut ion of a report .

I ndicat es whet her t he execut ion was a report or a

Report / Document I ndicat or
document .

S chedule I ndicat es t he schedule t hat t riggered t he delivery.

I ndicat es t he subscript ion t hat t riggered t he

S ubscript ion
delivery.

S ubscript ion E xecut ion Met ric of t he sum of all execut ion t imes of a
Durat ion (hh: mm: ss) subscript ion.

S ubscript ion E xecut ion Durat ion Met ric of t he sum of all execut ion t imes of a
(secs) subscript ion (in seconds).

© 2019, M icr o St r at egy In c. 2314

Syst em Ad m in ist r at io n Gu id e

Document Job Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

I ndicat es t he day on which t he document job

Day
execut ed.

Document I ndicat es which document was execut ed.

Document Job I ndicat es an execut ion of a document .

Met ric of t he average dif f erence bet ween st art t ime

DP A verage E lapsed Durat ion
and f inish t ime (including t ime f or prompt
per Job (hh: mm: ss)
responses) of all document job execut ions.

Met ric of t he average dif f erence, in seconds,

DP A verage E lapsed Durat ion bet ween st art t ime and f inish t ime (including t ime
per Job (secs) f or prompt responses) of all document job
execut ions.

DP A verage E xecut ion Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions.

DP A verage E xecut ion Met ric of t he average durat ion of all document job
Durat ion per Job (hh: mm: ss) execut ions.

DP A verage Queue Durat ion Met ric of t he average durat ion of all document job
per Job (hh: mm: ss) execut ions wait ing in t he queue.

DP A verage Queue Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions wait ing in t he queue.

Met ric of t he dif f erence bet ween st art t ime and

DP E lapsed Durat ion
f inish t ime (including t ime f or prompt responses) of
(hh: mm: ss)
a document job.

Met ric of t he average dif f erence, in seconds,

DP E lapsed Durat ion (secs) bet ween st art t ime and f inish t ime (including t ime
f or prompt responses) of a document job.

DP E xecut ion Durat ion Met ric of t he durat ion of a document job's
(hh: mm: ss) execut ion.

2315 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Met ric of t he durat ion, in seconds, of a document

DP E xecut ion Durat ion (secs)
job's execut ion.

DP Number of Jobs (I S _DOC_ Met ric of t he number of document jobs t hat were
FA CT) execut ed.

DP Number of Jobs wit h Cache Met ric of t he number of document jobs t hat hit a
Hit cache.

DP Number of Jobs wit h E rror Met ric of t he number of document jobs t hat f ailed.

DP Number of Users who ran Met ric of t he number of users who ran document
Document s jobs.

DP P ercent age of Jobs wit h Met ric of t he percent age of document jobs t hat hit
Cache Hit a cache.

DP P ercent age of Jobs wit h Met ric of t he percent age of document jobs t hat
E rror f ailed.

Met ric of t he durat ion of all document job

DP Queue Durat ion (hh: mm: ss)
execut ions wait ing in t he queue.

Met ric of t he durat ion, in seconds, of all document

DP Queue Durat ion (secs)
job execut ions wait ing in t he queue.

Hour I ndicat es t he hour t he document job was execut ed.

I ndicat es t he I nt elligence S erver machine t hat

I nt elligence S erver Machine
execut ed t he document job.

Met adat a I ndicat es t he met adat a st oring t he document .

I ndicat es t he minut e t he document job was

Minut e
execut ed.

P roject I ndicat es t he project st oring t he document .

Report I ndicat es t he report s in t he document .

User I ndicat es t he user who ran t he document job.

© 2019, M icr o St r at egy In c. 2316

Syst em Ad m in ist r at io n Gu id e

Document Job Step Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

I ndicat es t he day on which t he document job

Day
execut ed.

Document I ndicat es which document was execut ed.

I ndicat es t he sequence number f or st eps in a

Document Job S t ep S equence
document job.

Document Job S t ep Type I ndicat es t he t ype of st ep f or a document job.

Met ric of t he average dif f erence bet ween st art t ime

DP A verage E lapsed Durat ion
and f inish t ime (including t ime f or prompt
per Job (hh: mm: ss)
responses) of all document job execut ions.

Met ric of t he average dif f erence, in seconds,

DP A verage E lapsed Durat ion bet ween st art t ime and f inish t ime (including t ime
per Job (secs) f or prompt responses) of all document job
execut ions.

DP A verage E xecut ion Met ric of t he average durat ion of all document job
Durat ion per Job (hh: mm: ss) execut ions.

DP A verage E xecut ion Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions.

DP A verage Queue Durat ion Met ric of t he average durat ion of all document job
per Job (hh: mm: ss) execut ions wait ing in t he queue.

DP A verage Queue Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions wait ing in t he queue.

Met ric of t he dif f erence bet ween st art t ime and

DP E lapsed Durat ion
f inish t ime (including t ime f or prompt responses) of
(hh: mm: ss)
a document job.

Met ric of t he average dif f erence, in seconds,

DP E lapsed Durat ion (secs) bet ween st art t ime and f inish t ime (including t ime
f or prompt responses) of a document job.

2317 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

DP E xecut ion Durat ion Met ric of t he durat ion of a document job's
(hh: mm: ss) execut ion.

Met ric of t he durat ion, in seconds, of a document

DP E xecut ion Durat ion (secs)
job's execut ion.

Met ric of t he durat ion of all document job

DP Queue Durat ion (hh: mm: ss)
execut ions wait ing in t he queue.

Met ric of t he durat ion, in seconds, of all document

DP Queue Durat ion (secs)
job execut ions wait ing in t he queue.

Hour I ndicat es t he hour t he document job was execut ed.

Met adat a I ndicat es t he met adat a st oring t he document .

I ndicat es t he minut e t he document job was

Minut e
execut ed.

P roject I ndicat es t he project st oring t he document .

Enterprise Manager Data Load Attributes

Attrib u te n ame F u n ctio n

Dat a Load Finish Displays t he t imest amp of t he end of t he dat a load process
Time f or t he project s t hat are being monit ored.

Dat a Load P roject List s all project s t hat are being monit ored.

List s t he t imest amp of t he st art of t he dat a load process f or

Dat a Load S t art Time
t he project s t hat are being monit ored.

A value of -1 indicat es t hat it is t he summary row in t he E M_

I S _LA S T_UP DA TE t able f or all project s in a dat a load. That
I t em I D summary row has inf ormat ion about how long t he dat a load
t ook. A value of 0 indicat es it is a row wit h project dat a load
det ails.

© 2019, M icr o St r at egy In c. 2318

Syst em Ad m in ist r at io n Gu id e

Inbox Message Actions Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Day I ndicat es t he day t he manipulat ion was st art ed

Document I ndicat es t he document included in t he message.

I ndicat es t he document job t hat request ed t he Hist ory

Document Job
List message manipulat ion.

HL Days S ince Last Met ric of t he number of days since any act ion was
A ct ion: A ny act ion perf ormed.

HL Days S ince Last Met ric of t he number of days since t he last request was
A ct ion: Request made f or t he cont ent s of a message.

Met ric of t he dat e and t ime of t he last act ion perf ormed
HL Last A ct ion Dat e: A ny
on a message such as read, delet ed, marked as read, and
A ct ion
so on.

HL Last A ct ion Dat e: Met ric of t he dat e and t ime of t he last request made f or
Request t he cont ent s of a message.

HL Number of A ct ions Met ric of t he number of act ions perf ormed on a message.

HL Number of A ct ions by Met ric of t he number of act ions by user perf ormed on a
User message.

HL Number of A ct ions Met ric of t he number of act ions on a message t hat

wit h E rrors result ed in an error.

HL Number of Document Met ric of t he number of document jobs t hat result wit h
Jobs messages.

HL Number of Messages Met ric of t he number of messages.

HL Number of Messages Met ric of t he number of messages t hat result ed in an

wit h E rrors error.

HL Number of Messages Met ric of t he number of request s f or t he cont ent s of a

Request ed message.

2319 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

HL Number of Report Met ric of t he number of report jobs t hat result f rom
Jobs messages.

I ndicat es t he hour t he manipulat ion was st art ed on a

Hour
Hist ory List message.

I ndicat es t he manipulat ion t hat was perf ormed on a

I nbox A ct ion
Hist ory List message.

I ndicat es t he t ype of manipulat ion t hat was perf ormed on

I nbox A ct ion Type
a Hist ory List message.

I nbox Message I ndicat es t he message in t he Hist ory List .

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he message.

Met adat a I ndicat es t he met adat a st oring t he message.

Minut e I ndicat es t he minut e t he manipulat ion was st art ed.

P roject I ndicat es t he project st oring t he message.

Report I ndicat es t he report included in t he message.

I ndicat es t he job I D of t he report included in t he

Report Job
message.

I ndicat es t he user who manipulat ed t he Hist ory List

User
message.

Mobile Client Attributes

Attrib u te n ame F u n ctio n

I ndicat es whet her a cache was hit during t he execut ion

Cache Hit I ndicat or
and, if so, what t ype of cache hit .

© 2019, M icr o St r at egy In c. 2320

Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

Day I ndicat es t he day t he act ion st art ed.

Document I dent if ies t he document used in t he request .

I ndicat es t he t ype of report or document t hat init iat ed t he

E xecut ion Type I ndicat or
execut ion.

I ndicat es t he locat ion, in lat it ude and longit ude f orm, of

Geocode
t he user.

Hour I ndicat es t he hour t he act ion st art ed.

I nt elligence S erver
I ndicat es t he I nt elligence S erver processing t he request .
Machine

I ndicat es t he met adat a reposit ory st oring t he report or

Met adat a
document .

Minut e I ndicat es t he minut e t he act ion st art ed.

Mobile Device
I ndicat es t he unique I nst allat ion I D of t he mobile app.
I nst allat ion I D

I ndicat es t he t ype of mobile device t he app is inst alled

Mobile Device Type
on, such as I P A D2, DROI D, and so on.

I ndicat es t he version of t he MicroS t rat egy app making t he

MS TR A pp V ersion
request .

I ndicat es t he t ype of net work used, such as 3G, WI FI ,

Net work Type
LTE , and so on.

I ndicat es t he operat ing syst em of t he mobile device

Operat ing S yst em
making t he request .

Operat ing S yst em I ndicat es t he operat ing syst em version of t he mobile

V ersion device making t he request .

P roject I ndicat es t he project used t o init iat e t he request .

User I ndicat es t he user t hat init iat ed t he request .

2321 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

OLAP Services Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Day I ndicat es t he day t he act ion was st art ed.

Hour I ndicat es t he hour t he act ion was st art ed.

I nt elligent Cube I ndicat es t he I nt elligent Cube t hat was used.

I nt elligent Cube A ct ion Met ric of t he durat ion, in seconds, f or an act ion t hat was
Durat ion (secs) perf ormed on t he I nt ellgent Cube.

I nt elligent Cube A ct ion I ndicat es t he t ype of act ion t aken on t he I nt elligent Cube
Type such as cube publish, cube view hit , and so on.

I ndicat es t he I nt elligent Cube inst ance in memory t hat

I nt elligent Cube I nst ance
was used f or t he act ion.

I nt elligent Cube S ize I f t he I nt elligent Cube is published or ref reshed, indicat es

(K B ) t he size, in K B , of t he I nt elligent Cube.

I ndicat es t he t ype of I nt elligent Cube used, such as

I nt elligent Cube Type working set report , Report S ervices B ase report , OLA P
Cube report , and so on.

Minut e I ndicat es t he minut e on which t he act ion was st art ed.

Met ric of how many jobs f rom report s not based on

Number of Dynamically
I nt elligent Cubes but select ed by t he engine t o go against
S ourced Report Jobs
an I nt elligent Cube because t he object s on t he report
against I nt elligent Cubes
mat ched what is on t he I nt elligent Cube.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube P ublishes published.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube Ref reshes ref reshed.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube Republishes republished.

© 2019, M icr o St r at egy In c. 2322

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Number of Jobs wit h Met ric of how many job execut ions used an I nt elligent
I nt elligent Cube Hit Cube.

Met ric of how many users execut ed a report or document

Number of Users hit t ing
t hat used an I nt elligent Cube. That is, t he number of
I nt elligent Cubes
users using OLA P S ervices.

Number of V iew Report Met ric of how many act ions were t he result of a V iew
Jobs Report .

Report I ndicat es t he report t hat hit t he I nt elligent Cube.

Performance Monitoring Attributes

Attrib u te n ame F u n ctio n

I ndicat es cat egory of t he count er, such as memory,

Count er Cat egory
MicroS t rat egy server jobs, or MicroS t rat egy server users.

I ndicat es t he inst ance I D of t he count er, f or MicroS t rat egy

Count er I nst ance
use.

Day I ndicat es t he day t he act ion was st art ed.

Hour I ndicat es t he hour t he act ion was st art ed.

Minut e I ndicat es t he minut e t he act ion was st art ed.

P erf ormance Monit or I ndicat es t he name of t he perf ormance count er and it s value
Count er t ype.

2323 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Prompt Answers Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Connect ion S ource Indicates the connection source to Intelligence Server.

Count of P rompt
Metric of how many prompts were answered.
A nswers

Day I ndicat es t he day t he prompt was answered.

Document I ndicat es t he document t hat used t he prompt .

Hour I ndicat es t he hour t he prompt was answered.

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he job.

Met adat a I ndicat es t he met adat a reposit ory st oring t he prompt .

Minut e I ndicat es t he minut e t he prompt was answered.

P roject I ndicat es t he project st oring t he prompt .

P rompt I ndicat es t he prompt t hat was used.

P rompt A nswer I ndicat es t he answers f or t he prompt in various inst ances.

P rompt A nswer Required I ndicat es whet her an answer t o t he prompt was required.

I ndicat es t he answer of an inst ance of a prompt in a

P rompt I nst ance A nswer
report job.

P rompt Locat ion Indicates the ID of the location in which a prompt is stored.

Indicates the type of the object in which the prompt is stored, such
P rompt Locat ion Type
as filter, template, attribute, and so on.

I ndicat es t he t it le of t he prompt (t he t it le t he user sees

P rompt Tit le
when present ed during job execut ion).

I ndicat es what t ype of prompt was used, such as dat e,

P rompt Type
double, element s, and so on.

© 2019, M icr o St r at egy In c. 2324

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Report I ndicat es t he report t hat used t he prompt .

Report Job I ndicat es t he report job t hat used t he prompt .

RP Number of Jobs (I S _
Met ric of how many jobs involved a prompt .
P R_A NS _FA CT)

RP Number of Jobs
Met ric of how many report jobs had a specif ied prompt
Cont aining P rompt
answer value.
A nswer V alue

RP Number of Jobs Not

Met ric of how many report jobs did not have a specif ied
Cont aining P rompt
prompt answer value.
A nswer V alue

RP Number of Jobs wit h Met ric of how many report jobs had a prompt t hat was not
Unanswered P rompt s answered.

Report Job Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion is ad hoc.

Cache Creat ion I ndicat or I ndicat es whet her an execut ion has creat ed a cache.

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Cancelled I ndicat or I ndicat es whet her an execut ion has been canceled.

I ndicat es whet her a job was a document dat aset or a

Child Job I ndicat or
st andalone report .

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

2325 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

I ndicat es whet her a report request f ailed because of a

Dat abase E rror I ndicat or
dat abase error.

Dat amart I ndicat or I ndicat es whet her an execut ion creat ed a dat a mart .

Day I ndicat es t he day on which t he report was execut ed.

I ndicat es t he dat abase inst ance on which t he report was

DB I nst ance
execut ed.

Drill I ndicat or I ndicat es whet her an execut ion is a result of a drill.

I ndicat es whet her an execut ion is a result of an element

E lement Load I ndicat or
load.

E rror I ndicat or I ndicat es whet her an execut ion encount ered an error.

I ndicat es whet her a report was export ed and, if so,

E xport I ndicat or
indicat es it s f ormat .

Filt er I ndicat es t he f ilt er used on t he report .

Hour I ndicat es t he hour on which t he report was execut ed.

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he report .

Met adat a I ndicat es t he met adat a reposit ory t hat st ores t he report .

I ndicat es t he minut e on which t he report execut ion was

Minut e
st art ed.

Number of Jobs wit h Met ric of how many job execut ions used an I nt elligent
I nt elligent Cube Hit Cube.

P roject I ndicat es t he met adat a reposit ory t hat st ores t he report .

P rompt I ndicat or I ndicat es whet her t he report execut ion was prompt ed.

Report I ndicat es t he I D of t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

© 2019, M icr o St r at egy In c. 2326

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP A verage E lapsed
Met ric of t he average dif f erence bet ween st art t ime and
Durat ion per Job
f inish t ime (including t ime f or prompt responses) of all
(hh: mm: ss) (I S _RE P _
report job execut ions.
FA CT)

RP A verage E lapsed Met ric of t he average dif f erence bet ween st art t ime and
Durat ion per Job (secs) f inish t ime (including t ime f or prompt responses) of all
(I S _RE P _FA CT) report job execut ions.

RP A verage E xecut ion

Durat ion per Job Met ric of t he average durat ion of all report job execut ions.
(hh: mm: ss) (I S _RE P _ I ncludes t ime in queue and execut ion f or a report job.
FA CT)

RP A verage E xecut ion Met ric of t he average durat ion, in seconds, of all report
Durat ion per Job (secs) job execut ions. I ncludes t ime in queue and execut ion f or
(I S _RE P _FA CT) a report job.

RP A verage P rompt
Met ric of t he average t ime users t ake t o answer t he set of
A nswer Time per Job
prompt s in all report jobs.
(hh: mm: ss)

RP A verage P rompt
Met ric of t he average t ime, in seconds, users t ake t o
A nswer Time per Job
answer t he set of prompt s in all report jobs.
(secs)

RP A verage Queue
Met ric of t he average t ime report jobs wait ed in t he
Durat ion per Job
I nt elligence S erver's queue bef ore t he report job was
(hh: mm: ss) (I S _RE P _
execut ed.
FA CT)

RP A verage Queue Met ric of t he average t ime, in seconds, report jobs wait ed
Durat ion per Job (secs) in t he I nt elligence S erver's queue bef ore t he report job
(I S _RE P _FA CT) was execut ed.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E lapsed Durat ion
of a report job. I ncludes t ime f or prompt responses, in
(hh: mm: ss)
queue, and execut ion.

2327 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E lapsed Durat ion
and f inish t ime of a report job. I ncludes t ime f or prompt
(secs)
responses, in queue, and execut ion.

RP E xecut ion Durat ion Met ric of t he durat ion of a report job's execut ion. I ncludes
(hh: mm: ss) dat abase execut ion t ime.

RP E xecut ion Durat ion Met ric of t he durat ion, in seconds, of a report job's
(secs) execut ion. I ncludes dat abase execut ion t ime.

RP Number of A d Hoc Met ric of how many report jobs result ed f rom an ad hoc
Jobs report creat ion.

RP Number of Cancelled
Met ric of how many job execut ions were canceled.
Jobs

Met ric of how many job execut ions result ed f rom a drill
RP Number of Drill Jobs
act ion.

RP Number of Jobs (I S _
Met ric of how many report jobs were execut ed.
RE P _FA CT)

RP Number of Jobs Met ric of how many report jobs were execut ed against t he
hit t ing Dat abase dat abase.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
Cache Creat ion result in creat ing a server cache.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
Cache Hit hit a server cache.

RP Number of Jobs w/ o Met ric of how many report jobs were execut ed t hat did not
E lement Loading result f rom loading addit ional at t ribut e element s.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
Cache Creat ion result ed in a server cache being creat ed.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat hit a
Cache Hit server cache.

© 2019, M icr o St r at egy In c. 2328

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
Dat amart Creat ion result ed in a dat a mart being creat ed.

RP Number of Jobs wit h Met ric of how many report jobs f ailed because of a
DB E rror dat abase error.

RP Number of Jobs wit h Met ric of how many report jobs were execut ed t hat
E lement Loading result ed f rom loading addit ional at t ribut e element s.

RP Number of Jobs wit h

Met ric of how many report jobs f ailed because of an error.
E rror

RP Number of Jobs wit h Met ric of how many report job execut ions used an
I nt elligent Cube Hit I nt elligent Cube.

RP Number of Jobs wit h Met ric of how many report job execut ions used a securit y
S ecurit y Filt er f ilt er.

RP Number of Jobs wit h

Met ric of how many report jobs execut ed S QL st at ement s.
S QL E xecut ion

RP number of Met ric of how many report job execut ions were run
Narrowcast S erver jobs t hrough MicroS t rat egy Narrowcast S erver.

RP Number of P rompt ed Met ric of how many report job execut ions included a
Jobs prompt .

RP Number of Report
Met ric of how many report jobs execut ed as a result of a
Jobs f rom Document
document execut ion.
E xecut ion

RP Number of Result Met ric of how many result rows were ret urned f rom a
Rows report execut ion.

RP Number of
Met ric of how many report jobs were scheduled.
S cheduled Jobs

RP Number of Users who

Met ric of how many dist inct users ran report jobs.
ran report s

2329 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP P rompt A nswer Met ric of t he how long users t ake t o answer t he set of
Durat ion (hh: mm: ss) prompt s in report jobs.

RP P rompt A nswer Met ric of t he how long, in seconds, users t ake t o answer
Durat ion (secs) t he set of prompt s in report jobs.

RP Queue Durat ion Met ric of how long a report job wait ed in t he I nt elligence
(hh: mm: ss) S erver's queue bef ore t he report job was execut ed.

Met ric of how long, in seconds, a report job wait ed in t he

RP Queue Durat ion
I nt elligence S erver's queue bef ore t he report job was
(secs)
execut ed.

S chedule I ndicat es t he schedule t hat began t he report execut ion.

S chedule I ndicat or I ndicat es whet her t he report execut ion was scheduled.

S ecurit y Filt er I ndicat es t he securit y f ilt er used in t he report execut ion.

I ndicat es whet her a securit y f ilt er was used in t he report

S ecurit y Filt er I ndicat or
execut ion.

S QL E xecut ion I ndicat or I ndicat es t hat S QL was execut ed during report execut ion.

Templat e I ndicat es t he report t emplat e t hat was used.

User I ndicat es t he user t hat ran t he report .

Report Job SQL Pass Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her t he execut ion was ad hoc.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

Day I ndicat es t he day in which t he job was execut ed.

© 2019, M icr o St r at egy In c. 2330

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Hour I ndicat es t he hour in which t he report job was execut ed.

I ndicat es t he met adat a reposit ory st oring t he report or

Met adat a
document .

Minut e I ndicat es t he minut e in which t he report job was st art ed.

P roject I ndicat es t he project st oring t he report or document .

Report I ndicat es t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

I ndicat es t he S QL st at ement t hat was execut ed during t he

Report Job S QL P ass
S QL pass.

I ndicat es t he t ype of S QL st at ement t hat was execut ed in

Report Job S QL P ass
t his S QL pass. E xamples are S QL select , S QL insert ,
Type
S QL creat e and such.

RP E xecut ion Durat ion Met ric of t he durat ion of a report job's execut ion. I ncludes
(hh: mm: ss) dat abase execut ion t ime.

RP E xecut ion Durat ion Met ric of t he durat ion, in seconds, of a report job's
(secs) execut ion. I ncludes dat abase execut ion t ime.

RP Last E xecut ion Finish Met ric of t he f inish t imest amp when t he report job was
Timest amp last execut ed.

RP Last E xecut ion S t art Met ric of t he st art t imest amp when t he report job was last
Timest amp execut ed.

RP Number of DB Tables Met ric of how many dat abase t ables were accessed in a
A ccessed report job execut ion.

Met ric of how large, in byt es, t he S QL was f or a report

RP S QL S ize
job.

2331 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Report Job Steps Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion was ad hoc.

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

Day I ndicat es t he day in which t he job was execut ed.

Hour I ndicat es t he hour in which t he report job was execut ed.

Minut e I ndicat es t he minut e in which t he report job was st art ed.

Report I ndicat es t he report t hat was execut ed.

Report Job I ndicat es an execut ion of a report .

I ndicat es t he sequence number in t he series of execut ion

Report Job S t ep
st eps a report job passes t hrough in t he I nt elligence
S equence
S erver.

I ndicat es t he t ype of st ep f or a report job. E xamples are

S QL generat ion, S QL execut ion, A nalyt ical E ngine,
Report Job S t ep Type
Resolut ion S erver, element request , updat e I nt elligent
Cube, and so on.

RP A verage CP U
E xecut ion Durat ion per Met ric of t he average durat ion, in milliseconds, a report
Job (msecs) (I S _RE P _ job execut ion t akes in t he I nt elligence S erver CP U.
S TE P _FA CT)

RP A verage E lapsed Met ric of t he average dif f erence, in seconds, bet ween
Durat ion per Job (secs) st art t ime and f inish t ime of report job execut ions.
(I S _RE P _S TE P _FA CT) I ncludes t ime f or prompt responses.

RP A verage E xecut ion Met ric of t he average dif f erence, in seconds, bet ween

© 2019, M icr o St r at egy In c. 2332

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Durat ion per Job (secs) st art t ime and f inish t ime of report job execut ions.
(I S _RE P _S TE P _FA CT) I ncludes t ime f or prompt responses.

RP A verage Query
E ngine E xecut ion Met ric of t he average t ime, in seconds, t he Query E ngine
Durat ion per Job (secs) t akes t o process a report job.
(I S _RE P _S TE P _FA CT)

RP A verage Queue Met ric of t he average t ime report jobs wait ed in t he

Durat ion per Job (secs) I nt elligence S erver's queue bef ore t he report job was
(I S _RE P _S TE P _FA CT) execut ed.

Met ric of how long, in milliseconds, a report job execut ion

RP CP U Durat ion (msec)
t akes in t he I nt elligence S erver CP U.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E lapsed Durat ion
of report job execut ions. I ncludes t ime f or prompt
(hh: mm: ss)
responses.

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E lapsed Durat ion
and f inish t ime of report job execut ions. I ncludes t ime f or
(secs)
prompt responses.

Met ric of t he dif f erence bet ween st art t ime and f inish t ime
RP E xecut ion Durat ion
of report job execut ions. I ncludes dat abase execut ion
(hh: mm: ss)
t ime.

Met ric of t he dif f erence, in seconds, bet ween st art t ime

RP E xecut ion Durat ion
and f inish t ime of report job execut ions. I ncludes
(secs)
dat abase execut ion t ime.

RP Last E xecut ion Finish Met ric of t he f inish t imest amp when t he report job was
Timest amp last execut ed.

RP Last E xecut ion S t art Met ric of t he st art t imest amp when t he report job was last
Timest amp execut ed.

RP Number of Jobs (I S _
Met ric of how many report jobs were execut ed.
RE P _S TE P _FA CT)

2333 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

RP Query E ngine
Met ric of how long t he Query E ngine t ook t o execut e S QL
Durat ion (hh: mm: ss)
f or a report job.
(I S _RE P _S TE P _FA CT)

RP Query E ngine
Met ric of t he t ime, in seconds, t he Query E ngine t akes t o
Durat ion (secs) (I S _
execut e S QL f or a report job.
RE P _S TE P _FA CT)

RP Queue Durat ion Met ric of how long a report job wait ed in t he I nt elligence
(hh: mm: ss) S erver's queue bef ore t he report job was execut ed.

Met ric of how long, in seconds, a report job wait ed in t he

RP Queue Durat ion
I nt elligence S erver's queue bef ore t he report job was
(secs)
execut ed.

RP S QL E ngine Durat ion

Met ric of how long t he S QL E ngine t ook t o generat e S QL
(hh: mm: ss) (I S _RE P _
f or a report job.
S TE P _FA CT)

Report Job Tables/Columns Accessed Attributes and

Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion was ad hoc.

Column I ndicat es t he column t hat was accessed.

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es t he day on which t he t able column was

Day
accessed.

I ndicat es t he t able in t he dat abase st oring t he column

DB Table
t hat was accessed.

© 2019, M icr o St r at egy In c. 2334

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

I ndicat es t he hour on which t he t able column was

Hour
accessed.

I ndicat es t he minut e on which t he t able column was

Minut e
accessed.

Report I ndicat es t he report t hat accessed t he t able column.

I ndicat es which execut ion of a report accessed t he t able

Report Job
column.

Met ric of how many report jobs accessed t he dat abase

RP Number of Jobs (I S _
column or t able. The Warehouse Tables A ccessed report
RE P _COL_FA CT)
uses t his met ric.

I ndicat es which t ype of S QL clause was used t o access

S QL Clause Type
t he t able column.

Schema Objects Attributes

Attrib u te
F u n ctio n
n ame

List s all at t ribut es in project s t hat are set up t o be monit ored by

A t t ribut e
E nt erprise Manager.

List s all at t ribut e f orms in project s t hat are set up t o be monit ored
A t t ribut e Form
by E nt erprise Manager.

List s all columns in project s t hat are set up t o be monit ored by

Column
E nt erprise Manager.

List s all physical t ables in t he dat a warehouse t hat are set up t o be

DB Table
monit ored by E nt erprise Manager.

List s all f act s in project s t hat are set up t o be monit ored by

Fact
E nt erprise Manager.

2335 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s all hierarchies in project s t hat are set up t o be monit ored by

Hierarchy
E nt erprise Manager

List s all logical t ables in project s t hat are set up t o be monit ored by
Table
E nt erprise Manager.

List s all t ransf ormat ions in project s t hat are set up t o be monit ored
Transf ormat ion
by E nt erprise Manager.

Server Machines Attributes

Attrib u te n ame F u n ctio n

List s all machines t hat have had users connect t o t he

Client Machine
I nt elligence S erver.

I nt elligence S erver
List s t he clust er of I nt elligence S ervers.
Clust er

I nt elligence S erver List s all machines t hat have logged st at ist ics as an
Machine I nt elligence S erver.

Web S erver Machine List s all machines used as web servers.

Session Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A vg. Connect ion Met ric of t he average t ime connect ions t o an I nt elligence
Durat ion (hh: mm: ss) S erver last .

A vg. Connect ion Met ric of t he average t ime, in seconds, connect ions t o an
Durat ion (secs) I nt elligence S erver last .

© 2019, M icr o St r at egy In c. 2336

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Connect ion Durat ion Met ric of t he t ime a connect ion t o an I nt elligence S erver
(hh: mm: ss) last s.

Connect ion Durat ion Met ric of t he t ime, in seconds, a connect ion t o an
(secs) I nt elligence S erver last s.

Connect ion S ource List s all connect ion sources t o I nt elligence S erver.

Met ric of how many sessions were connect ed t o an

Number of S essions
I nt elligence S erver. Usually report ed wit h a dat e and t ime
(Report Level)
at t ribut e.

Met ric of how many dist inct users were connect ed t o an

Number of Users Logged
I nt elligence S erver. Usually report ed wit h a dat e and t ime
I n (Report Level)
at t ribut e.

S ession I ndicat es a user connect ion t o an I nt elligence S erver.

All Indicators and Flags Attributes

Attrib u te n ame F u n ctio n

A d Hoc I ndicat or I ndicat es whet her an execut ion is ad hoc.

Cache Creat ion

I ndicat es whet her an execut ion has creat ed a cache.
I ndicat or

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Cancelled I ndicat or I ndicat es whet her an execut ion has been cancelled.

I ndicat es whet her a job was a document dat aset or a st and-

Child Job I ndicat or
alone report .

Conf igurat ion Object

I ndicat es whet her a conf igurat ion object exist s.
E xist s S t at us

Conf igurat ion List s all conf igurat ion paramet er t ypes.

2337 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

P aramet er V alue Type

Connect ion S ource List s all connect ion sources t o I nt elligence S erver.

Cont act Type List s t he execut ed cont act t ypes.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

Dat abase E rror I ndicat es whet her a report request f ailed because of a
I ndicat or dat abase error.

Dat amart I ndicat or I ndicat es whet her an execut ion creat ed a dat a mart .

I ndicat es whet her an execut ion encount ered a dat abase

DB E rror I ndicat or
error.

Delivery S t at us
I ndicat es whet her a delivery was successf ul.
I ndicat or

Delivery Type List s t he t ype of delivery.

Document Job S t at us
List s t he st at uses of document execut ions.
(Deprecat ed)

Document Job S t ep
List s all possible st eps of document job execut ion.
Type

I ndicat es t he t ype of a document or dossier, such as HTML

Document Type
document , Report S ervices document , or a dossier.

List s t he object f rom which a user drilled when a new report

Drill f rom Object
was run because of a drilling act ion.

Drill I ndicat or I ndicat es whet her an execut ion is a result of a drill.

List s t he object t o which a user drilled when a new report

Drill t o Object
was run because of a drilling act ion.

I ndicat es whet her an execut ion is a result of an element

E lement Load I ndicat or
load.

© 2019, M icr o St r at egy In c. 2338

Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

E rror I ndicat or I ndicat es whet her an execut ion encount ered an error.

E xecut ion Type I ndicat es how t he cont ent was request ed, such as User
I ndicat or E xecut ion, P re-Cached, A pplicat ion Recovery, and so on.

I ndicat es whet her a report was export ed and, if so,

E xport I ndicat or
indicat es it s f ormat .

Hierarchy Drilling I ndicat es whet her a hierarchy is used as a drill hierarchy.

List t he t ypes of manipulat ions t hat can be perf ormed on a

I nbox A ct ion Type
Hist ory List message.

I nt elligent Cube A ct ion

List s act ions perf ormed on or against int elligent cubes.
Type

I nt elligent Cube Type List s all int elligent cube t ypes.

List s all t he possible errors t hat can be ret urned during job
Job E rrorCode
execut ions.

Job P riorit y Map List s t he priorit ies of job execut ions.

E numerat es t he upper limit of t he priorit y ranges f or high,

Job P riorit y Number medium, and low priorit y jobs. Def ault values are 332, 666,
and 999.

Object Creat ion Dat e I ndicat es t he dat e on which an object was creat ed.

Object Creat ion I ndicat es t he week of t he year in which an object was

Week of year creat ed.

Object E xist s S t at us I ndicat es whet her an object exist s.

Object Hidden S t at us I ndicat es whet her an object is hidden.

Object Modif icat ion

I ndicat es t he dat e on which an object was last modif ied.
Dat e

Object Modif icat ion I ndicat es t he week of t he year in which an object was last
Week of year modif ied.

P rompt A nswer I ndicat es whet her a prompt answer was required f or t he job

2339 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

Required execut ion.

P rompt I ndicat or I ndicat es whet her a job execut ion was prompt ed.

Report Job S QL P ass List s t he t ypes of S QL passes t hat t he I nt elligence S erver

Type generat es.

Report Job S t at us
List s t he st at uses of report execut ions.
(Deprecat ed)

Report Job S t ep Type List s all possible st eps of report job execut ion.

I ndicat es t he t ype of a report , such as X DA , relat ional, and

Report Type
so on.

Report / Document I ndicat es whet her t he execut ion was a report or a

I ndicat or document .

S chedule I ndicat or I ndicat es whet her a job execut ion was scheduled.

S ecurit y Filt er I ndicat es whet her a securit y f ilt er was used in t he job
I ndicat or execut ion.

S QL Clause Type List s t he various S QL clause t ypes used by t he S QL E ngine.

S QL E xecut ion
I ndicat es whet her S QL was execut ed in t he job execut ion.
I ndicat or

Application Objects Attributes

Attrib u te
F u n ctio n
n ame

List s all consolidat ions in project s t hat are set up t o be monit ored
Consolidat ion
by E nt erprise Manager.

List s all cust om groups in project s t hat are set up t o be monit ored
Cust om Group
by E nt erprise Manager.

© 2019, M icr o St r at egy In c. 2340

Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s all document s in project s t hat are set up t o be monit ored by

Document
E nt erprise Manager.

List s all f ilt ers in project s t hat are set up t o be monit ored by
Filt er
E nt erprise Manager.

I nt elligent List s all int elligent cubes in project s t hat are set up t o be
Cube monit ored by E nt erprise Manager.

List s all met rics in project s t hat are set up t o be monit ored by
Met ric
E nt erprise Manager.

List s all prompt s in project s t hat are set up t o be monit ored by

P rompt
E nt erprise Manager.

List s all report s in project s t hat are set up t o be monit ored by

Report
E nt erprise Manager.

List s all securit y f ilt ers in project s t hat are set up t o be monit ored
S ecurit y Filt er
by E nt erprise Manager.

List s all t emplat es in project s t hat are set up t o be monit ored by

Templat e
E nt erprise Manager.

Configuration Objects Attributes

Attrib u te n ame F u n ctio n

A ddress List s all addresses t o which deliveries have been sent .

Conf igurat ion Object

List s t he owners of conf igurat ion object s.
Owner

Conf igurat ion

List s all conf igurat ion paramet ers.
P aramet er

Cont act List s all cont act s t o whom deliveries have been sent .

2341 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

DB Connect ion List s all dat abase connect ions.

DB I nst ance List s all dat abase inst ances.

Device List s all devices t o which deliveries have been sent .

E vent List s all event s being t racked.

Folder List s all f olders wit hin project s.

I nt elligence S erver
List s all I nt elligence S erver def init ions.
Def init ion

Met adat a List s all monit ored met adat a.

Owner List s t he owners of all object s.

P roject List s all project s.

S chedule List s all schedules.

S ubscript ion List s all execut ed t ransmissions.

Transmit t er List s all t ransmit t ers.

User List s all users being t racked.

User Group List s all user groups.

User Group (P arent ) List s all user groups t hat are parent s of ot her user groups.

Date and Time Attributes

Attrib u te
F u n ctio n
n ame

Calendar List s every calendar week, beginning wit h 2000-01-01, as an

Week int eger.

Day List s all days, beginning in 1990.

© 2019, M icr o St r at egy In c. 2342

Syst em Ad m in ist r at io n Gu id e

Attrib u te
F u n ctio n
n ame

List s t he hours in a day. For example, 09 A M - 10 A M, 10 A M - 11

Hour
A M, and so on.

List s all t he minut es in an hour. For example, if t he hour specif ied is

Minut e 10 A M - 11 A M, list s minut es as 10. 30 A M - 10. 31 A M, 10. 32 A M -
10. 33 A M, and so on.

Mont h List s all mont hs, beginning wit h 2000.

Mont h of Y ear List s all mont hs in a specif ied year.

Quart er List s all quart ers.

Quart er of
List s all quart ers of t he year.
Y ear

List s all weeks in all years, beginning in 2000. Weeks in 2000 are
represent ed as a number ranging f rom 200001 t o 200053, weeks in
Week of Y ear
2001 are represent ed as a number ranging f rom 200101 t o 200153,
and so on.

Weekday List s all days of t he week.

Y ear List s all years.

Delivery Services Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

A ddress I ndicat es t he address t o which a delivery was sent .

A vg number of recipient s per Met ric of t he average number of recipient s in

subscript ion subscript ions.

A vg S ubscript ion E xecut ion Met ric of t he average amount of t ime subscript ions
Durat ion (hh: mm: ss) t ake t o execut e.

A vg S ubscript ion E xecut ion Met ric of t he average amount of t ime, in seconds,

2343 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Durat ion (secs) subscript ions t ake t o execut e.

Cont act I ndicat es all cont act s t o whom a delivery was sent .

Cont act Type I ndicat es t he execut ed cont act t ypes.

Day I ndicat es t he day on which t he delivery was sent .

Delivery S t at us I ndicat or I ndicat es whet her t he delivery was successf ul.

Delivery Type I ndicat es t he t ype of delivery.

I ndicat es t he t ype of device t o which t he delivery

Device
was sent .

Document I ndicat es t he document t hat was delivered.

Hour I ndicat es t he hour on which t he delivery was sent .

I ndicat es t he I nt elligence S erver machine t hat

I nt elligence S erver Machine
execut ed t he job.

Met adat a I ndicat es t he monit ored met adat a.

I ndicat es t he minut e on which t he delivery was

Minut e
sent .

Number of Dist inct Document Met ric of t he number of report services document
S ubscript ions subscript ions.

Met ric of t he number of recipient s t hat received

Number of Dist inct Recipient s
cont ent f rom a subscript ion.

Number of Dist inct Report

Met ric of t he number of report subscript ions.
S ubscript ions

Met ric of t he number of execut ed subscript ions.

Number of Dist inct
This does not ref lect t he number of subscript ions
S ubscript ions
in t he met adat a.

Met ric of t he number of subscript ions t hat

Number of E -mail S ubscript ions
delivered cont ent via e-mail.

© 2019, M icr o St r at egy In c. 2344

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Number of E rrored
Met ric of t he number of subscript ions t hat f ailed.
S ubscript ions

Met ric of t he number of execut ions of a

Number of E xecut ions
subscript ion.

Met ric of t he number of subscript ions t hat

Number of File S ubscript ions
delivered cont ent via f ile locat ion.

Number of Hist ory List Met ric of t he number of subscript ions t hat
S ubscript ions delivered cont ent via t he hist ory list .

Met ric of t he number of subscript ions t hat

Number of Mobile S ubscript ions
delivered cont ent via mobile.

Met ric of t he number of subscript ions t hat

Number of P rint S ubscript ions
delivered cont ent via a print er.

P roject List s t he project s.

Report List s t he report s in project s.

Report Job List s an execut ion of a report .

I ndicat es whet her t he execut ion was a report or a

Report / Document I ndicat or
document .

S chedule I ndicat es t he schedule t hat t riggered t he delivery.

I ndicat es t he subscript ion t hat t riggered t he

S ubscript ion
delivery.

S ubscript ion E xecut ion Met ric of t he sum of all execut ion t imes of a
Durat ion (hh: mm: ss) subscript ion.

S ubscript ion E xecut ion Durat ion Met ric of t he sum of all execut ion t imes of a
(secs) subscript ion (in seconds).

2345 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Document Job Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

I ndicat es t he day on which t he document job

Day
execut ed.

Document I ndicat es which document was execut ed.

Document Job I ndicat es an execut ion of a document .

Met ric of t he average dif f erence bet ween st art t ime

DP A verage E lapsed Durat ion
and f inish t ime (including t ime f or prompt
per Job (hh: mm: ss)
responses) of all document job execut ions.

Met ric of t he average dif f erence, in seconds,

DP A verage E lapsed Durat ion bet ween st art t ime and f inish t ime (including t ime
per Job (secs) f or prompt responses) of all document job
execut ions.

DP A verage E xecut ion Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions.

DP A verage E xecut ion Met ric of t he average durat ion of all document job
Durat ion per Job (hh: mm: ss) execut ions.

DP A verage Queue Durat ion Met ric of t he average durat ion of all document job
per Job (hh: mm: ss) execut ions wait ing in t he queue.

DP A verage Queue Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions wait ing in t he queue.

Met ric of t he dif f erence bet ween st art t ime and

DP E lapsed Durat ion
f inish t ime (including t ime f or prompt responses) of
(hh: mm: ss)
a document job.

Met ric of t he average dif f erence, in seconds,

DP E lapsed Durat ion (secs) bet ween st art t ime and f inish t ime (including t ime
f or prompt responses) of a document job.

DP E xecut ion Durat ion Met ric of t he durat ion of a document job's
(hh: mm: ss) execut ion.

© 2019, M icr o St r at egy In c. 2346

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

Met ric of t he durat ion, in seconds, of a document

DP E xecut ion Durat ion (secs)
job's execut ion.

DP Number of Jobs (I S _DOC_ Met ric of t he number of document jobs t hat were
FA CT) execut ed.

DP Number of Jobs wit h Cache Met ric of t he number of document jobs t hat hit a
Hit cache.

DP Number of Jobs wit h E rror Met ric of t he number of document jobs t hat f ailed.

DP Number of Users who ran Met ric of t he number of users who ran document
Document s jobs.

DP P ercent age of Jobs wit h Met ric of t he percent age of document jobs t hat hit
Cache Hit a cache.

DP P ercent age of Jobs wit h Met ric of t he percent age of document jobs t hat
E rror f ailed.

Met ric of t he durat ion of all document job

DP Queue Durat ion (hh: mm: ss)
execut ions wait ing in t he queue.

Met ric of t he durat ion, in seconds, of all document

DP Queue Durat ion (secs)
job execut ions wait ing in t he queue.

Hour I ndicat es t he hour t he document job was execut ed.

I ndicat es t he I nt elligence S erver machine t hat

I nt elligence S erver Machine
execut ed t he document job.

Met adat a I ndicat es t he met adat a st oring t he document .

I ndicat es t he minut e t he document job was

Minut e
execut ed.

P roject I ndicat es t he project st oring t he document .

Report I ndicat es t he report s in t he document .

User I ndicat es t he user who ran t he document job.

2347 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Document Job Step Attributes and Metrics

Attrib u te o r metric n ame F u n ctio n

I ndicat es t he day on which t he document job

Day
execut ed.

Document I ndicat es which document was execut ed.

I ndicat es t he sequence number f or st eps in a

Document Job S t ep S equence
document job.

Document Job S t ep Type I ndicat es t he t ype of st ep f or a document job.

Met ric of t he average dif f erence bet ween st art t ime

DP A verage E lapsed Durat ion
and f inish t ime (including t ime f or prompt
per Job (hh: mm: ss)
responses) of all document job execut ions.

Met ric of t he average dif f erence, in seconds,

DP A verage E lapsed Durat ion bet ween st art t ime and f inish t ime (including t ime
per Job (secs) f or prompt responses) of all document job
execut ions.

DP A verage E xecut ion Met ric of t he average durat ion of all document job
Durat ion per Job (hh: mm: ss) execut ions.

DP A verage E xecut ion Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions.

DP A verage Queue Durat ion Met ric of t he average durat ion of all document job
per Job (hh: mm: ss) execut ions wait ing in t he queue.

DP A verage Queue Durat ion Met ric of t he average durat ion, in seconds, of all
per Job (secs) document job execut ions wait ing in t he queue.

Met ric of t he dif f erence bet ween st art t ime and

DP E lapsed Durat ion
f inish t ime (including t ime f or prompt responses) of
(hh: mm: ss)
a document job.

Met ric of t he average dif f erence, in seconds,

DP E lapsed Durat ion (secs) bet ween st art t ime and f inish t ime (including t ime
f or prompt responses) of a document job.

© 2019, M icr o St r at egy In c. 2348

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric n ame F u n ctio n

DP E xecut ion Durat ion Met ric of t he durat ion of a document job's
(hh: mm: ss) execut ion.

Met ric of t he durat ion, in seconds, of a document

DP E xecut ion Durat ion (secs)
job's execut ion.

Met ric of t he durat ion of all document job

DP Queue Durat ion (hh: mm: ss)
execut ions wait ing in t he queue.

Met ric of t he durat ion, in seconds, of all document

DP Queue Durat ion (secs)
job execut ions wait ing in t he queue.

Hour I ndicat es t he hour t he document job was execut ed.

Met adat a I ndicat es t he met adat a st oring t he document .

I ndicat es t he minut e t he document job was

Minut e
execut ed.

P roject I ndicat es t he project st oring t he document .

Enterprise Manager Data Load Attributes

Attrib u te n ame F u n ctio n

Dat a Load Finish Displays t he t imest amp of t he end of t he dat a load process
Time f or t he project s t hat are being monit ored.

Dat a Load P roject List s all project s t hat are being monit ored.

List s t he t imest amp of t he st art of t he dat a load process f or

Dat a Load S t art Time
t he project s t hat are being monit ored.

A value of -1 indicat es t hat it is t he summary row in t he E M_

I S _LA S T_UP DA TE t able f or all project s in a dat a load. That
I t em I D summary row has inf ormat ion about how long t he dat a load
t ook. A value of 0 indicat es it is a row wit h project dat a load
det ails.

2349 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Inbox Message Actions Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Day I ndicat es t he day t he manipulat ion was st art ed

Document I ndicat es t he document included in t he message.

I ndicat es t he document job t hat request ed t he Hist ory

Document Job
List message manipulat ion.

HL Days S ince Last Met ric of t he number of days since any act ion was
A ct ion: A ny act ion perf ormed.

HL Days S ince Last Met ric of t he number of days since t he last request was
A ct ion: Request made f or t he cont ent s of a message.

Met ric of t he dat e and t ime of t he last act ion perf ormed
HL Last A ct ion Dat e: A ny
on a message such as read, delet ed, marked as read, and
A ct ion
so on.

HL Last A ct ion Dat e: Met ric of t he dat e and t ime of t he last request made f or
Request t he cont ent s of a message.

HL Number of A ct ions Met ric of t he number of act ions perf ormed on a message.

HL Number of A ct ions by Met ric of t he number of act ions by user perf ormed on a
User message.

HL Number of A ct ions Met ric of t he number of act ions on a message t hat

wit h E rrors result ed in an error.

HL Number of Document Met ric of t he number of document jobs t hat result wit h
Jobs messages.

HL Number of Messages Met ric of t he number of messages.

HL Number of Messages Met ric of t he number of messages t hat result ed in an

wit h E rrors error.

HL Number of Messages Met ric of t he number of request s f or t he cont ent s of a

Request ed message.

© 2019, M icr o St r at egy In c. 235 0

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

HL Number of Report Met ric of t he number of report jobs t hat result f rom
Jobs messages.

I ndicat es t he hour t he manipulat ion was st art ed on a

Hour
Hist ory List message.

I ndicat es t he manipulat ion t hat was perf ormed on a

I nbox A ct ion
Hist ory List message.

I ndicat es t he t ype of manipulat ion t hat was perf ormed on

I nbox A ct ion Type
a Hist ory List message.

I nbox Message I ndicat es t he message in t he Hist ory List .

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he message.

Met adat a I ndicat es t he met adat a st oring t he message.

Minut e I ndicat es t he minut e t he manipulat ion was st art ed.

P roject I ndicat es t he project st oring t he message.

Report I ndicat es t he report included in t he message.

I ndicat es t he job I D of t he report included in t he

Report Job
message.

I ndicat es t he user who manipulat ed t he Hist ory List

User
message.

Mobile Client Attributes

Attrib u te n ame F u n ctio n

I ndicat es whet her a cache was hit during t he execut ion

Cache Hit I ndicat or
and, if so, what t ype of cache hit .

235 1 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te n ame F u n ctio n

Day I ndicat es t he day t he act ion st art ed.

Document I dent if ies t he document used in t he request .

I ndicat es t he t ype of report or document t hat init iat ed t he

E xecut ion Type I ndicat or
execut ion.

I ndicat es t he locat ion, in lat it ude and longit ude f orm, of

Geocode
t he user.

Hour I ndicat es t he hour t he act ion st art ed.

I nt elligence S erver
I ndicat es t he I nt elligence S erver processing t he request .
Machine

I ndicat es t he met adat a reposit ory st oring t he report or

Met adat a
document .

Minut e I ndicat es t he minut e t he act ion st art ed.

Mobile Device
I ndicat es t he unique I nst allat ion I D of t he mobile app.
I nst allat ion I D

I ndicat es t he t ype of mobile device t he app is inst alled

Mobile Device Type
on, such as I P A D2, DROI D, and so on.

I ndicat es t he version of t he MicroS t rat egy app making t he

MS TR A pp V ersion
request .

I ndicat es t he t ype of net work used, such as 3G, WI FI ,

Net work Type
LTE , and so on.

I ndicat es t he operat ing syst em of t he mobile device

Operat ing S yst em
making t he request .

Operat ing S yst em I ndicat es t he operat ing syst em version of t he mobile

V ersion device making t he request .

P roject I ndicat es t he project used t o init iat e t he request .

User I ndicat es t he user t hat init iat ed t he request .

© 2019, M icr o St r at egy In c. 235 2

Syst em Ad m in ist r at io n Gu id e

OLAP Services Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Day I ndicat es t he day t he act ion was st art ed.

Hour I ndicat es t he hour t he act ion was st art ed.

I nt elligent Cube I ndicat es t he I nt elligent Cube t hat was used.

I nt elligent Cube A ct ion Met ric of t he durat ion, in seconds, f or an act ion t hat was
Durat ion (secs) perf ormed on t he I nt ellgent Cube.

I nt elligent Cube A ct ion I ndicat es t he t ype of act ion t aken on t he I nt elligent Cube
Type such as cube publish, cube view hit , and so on.

I ndicat es t he I nt elligent Cube inst ance in memory t hat

I nt elligent Cube I nst ance
was used f or t he act ion.

I nt elligent Cube S ize I f t he I nt elligent Cube is published or ref reshed, indicat es

(K B ) t he size, in K B , of t he I nt elligent Cube.

I ndicat es t he t ype of I nt elligent Cube used, such as

I nt elligent Cube Type working set report , Report S ervices B ase report , OLA P
Cube report , and so on.

Minut e I ndicat es t he minut e on which t he act ion was st art ed.

Met ric of how many jobs f rom report s not based on

Number of Dynamically
I nt elligent Cubes but select ed by t he engine t o go against
S ourced Report Jobs
an I nt elligent Cube because t he object s on t he report
against I nt elligent Cubes
mat ched what is on t he I nt elligent Cube.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube P ublishes published.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube Ref reshes ref reshed.

Number of I nt elligent Met ric of how many t imes an I nt elligent Cube was
Cube Republishes republished.

235 3 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Number of Jobs wit h Met ric of how many job execut ions used an I nt elligent
I nt elligent Cube Hit Cube.

Met ric of how many users execut ed a report or document

Number of Users hit t ing
t hat used an I nt elligent Cube. That is, t he number of
I nt elligent Cubes
users using OLA P S ervices.

Number of V iew Report Met ric of how many act ions were t he result of a V iew
Jobs Report .

Report I ndicat es t he report t hat hit t he I nt elligent Cube.

Performance Monitoring Attributes

Attrib u te n ame F u n ctio n

I ndicat es cat egory of t he count er, such as memory,

Count er Cat egory
MicroS t rat egy server jobs, or MicroS t rat egy server users.

I ndicat es t he inst ance I D of t he count er, f or MicroS t rat egy

Count er I nst ance
use.

Day I ndicat es t he day t he act ion was st art ed.

Hour I ndicat es t he hour t he act ion was st art ed.

Minut e I ndicat es t he minut e t he act ion was st art ed.

P erf ormance Monit or I ndicat es t he name of t he perf ormance count er and it s value
Count er t ype.

© 2019, M icr o St r at egy In c. 235 4

Syst em Ad m in ist r at io n Gu id e

Prompt Answers Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

Connect ion S ource Indicates the connection source to Intelligence Server.

Count of P rompt
Metric of how many prompts were answered.
A nswers

Day I ndicat es t he day t he prompt was answered.

Document I ndicat es t he document t hat used t he prompt .

Hour I ndicat es t he hour t he prompt was answered.

I nt elligence S erver I ndicat es t he I nt elligence S erver machine t hat execut ed

Machine t he job.

Met adat a I ndicat es t he met adat a reposit ory st oring t he prompt .

Minut e I ndicat es t he minut e t he prompt was answered.

P roject I ndicat es t he project st oring t he prompt .

P rompt I ndicat es t he prompt t hat was used.

P rompt A nswer I ndicat es t he answers f or t he prompt in various inst ances.

P rompt A nswer Required I ndicat es whet her an answer t o t he prompt was required.

I ndicat es t he answer of an inst ance of a prompt in a

P rompt I nst ance A nswer
report job.

P rompt Locat ion Indicates the ID of the location in which a prompt is stored.

Indicates the type of the object in which the prompt is stored, such
P rompt Locat ion Type
as filter, template, attribute, and so on.

I ndicat es t he t it le of t he prompt (t he t it le t he user sees

P rompt Tit le
when present ed during job execut ion).

I ndicat es what t ype of prompt was used, such as dat e,

P rompt Type
double, element s, and so on.

235 5 © 2019, M icr o St r at egy In c.

 Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

Report I ndicat es t he report t hat used t he prompt .

Report Job I ndicat es t he report job t hat used t he prompt .

RP Number of Jobs (I S _
Met ric of how many jobs involved a prompt .
P R_A NS _FA CT)

RP Number of Jobs
Met ric of how many report jobs had a specif ied prompt
Cont aining P rompt
answer value.
A nswer V alue

RP Number of Jobs Not

Met ric of how many report jobs did not have a specif ied
Cont aining P rompt
prompt answer value.
A nswer V alue

RP Number of Jobs wit h Met ric of how many report jobs had a prompt t hat was not
Unanswered P rompt s answered.

Report Job Attributes and Metrics

Attrib u te o r metric
F u n ctio n
n ame

A d Hoc I ndicat or I ndicat es whet her an execut ion is ad hoc.

Cache Creat ion I ndicat or I ndicat es whet her an execut ion has creat ed a cache.

Cache Hit I ndicat or I ndicat es whet her an execut ion has hit a cache.

Cancelled I ndicat or I ndicat es whet her an execut ion has been canceled.

I ndicat es whet her a job was a document dat aset or a

Child Job I ndicat or
st andalone report .

Connect ion S ource I ndicat es t he connect ion source t o I nt elligence S erver.

I ndicat es whet her an execut ion hit an int elligent cube or

Cube Hit I ndicat or
dat abase.

© 2019, M icr o St r at egy In c. 235 6

Syst em Ad m in ist r at io n Gu id e

Attrib u te o r metric
F u n ctio n
n ame

I ndicat es whet her a report request f ailed because of a

Dat abase E rror I ndicat or
dat abase error.

Dat amart I ndicat or I ndicat es whet her an execut ion creat ed a dat a mart .

Day I ndicat es t he day on which t he report was execut ed.

I ndicat es t he dat abase inst ance on which t he report was

DB I nst ance
execut ed.

Drill I ndicat or I ndicat es whet her an execut ion is a result of a drill.

I ndicat es whet her an execut ion is a result of an element

E lement Load I ndicat or
load.

E rror I ndicat or I ndicat es whet her an execut ion encount ered an error.

I ndicat es whet her a report was expo