xdb Configuration Guide

Transcription

1 Sitecre 7.5 xdb Cnfiguratin Guide Rev: 9 April 2015 Sitecre 7.5 xdb Cnfiguratin Guide Cnfiguratin guide fr Sitecre administratrs and develpers

2 Sitecre 7.5 Table f Cntents Chapter 1 Intrductin Architecture Optins On-Premise Server Slutins Hybrid Server Slutins Clud Server Slutins... 5 Chapter 2 Standard Cnfiguratin Hardware Guidelines Hardware Cnfiguratin Example frm Sitecre.net Sftware Recmmendatins Installatin Install Sitecre CMS Install Micrsft SQL Server Install MngDB Cnfiguring Cnnectin Strings Verifying a Cnnectin t the Cllectin Database Server Cnfiguratin Server Features Server Cnfiguratin Examples Sessin State In Prcess Out f Prcess Sessin State Cnfiguratin Scenaris Cnfiguring Private Sessin State Cnfiguring the MngDB Sessin State Prvider Cnfiguring the SQL Server Sessin State Prvider Cnfiguring Shared Sessin State Cnfiguring the MngDB Sessin State Prvider Cnfiguring the SQL Server Sessin State Prvider Clustered Envirnment Overview Chapter 3 Clud Cnfiguratin Optins Clud Server Slutins Chapter 4 Custmizatin Creating a Custm Aggregatin Fact and Dimensin Tables Creating Fact Tables Creating Dimensin Tables Implementing Mdel Classes Implementing the Aggregatin Prcessr Example Custm Aggregatin Overview Create a Rate Page Event Create a Fact Table Create Fact and Dimensin Mdel Classes Implementing the Aggregatin Prcessr Registering yur Custm Aggregatin Page 2 f 57

3 xdb Cnfiguratin Guide Chapter 1 Intrductin The Sitecre Experience Database (xdb ) cllects all nline and ffline custmer interactins frm all channel surces in a real-time big data repsitry. It cnnects interactin data t create a cmprehensive, unified view f each individual custmer, and makes the data available t marketers t manage the custmer experience in real time. This dcument prvides guidance n cmmn cnfiguratin tasks fr administratrs r develpers when setting up the xdb fr the first time. This guide cntains the fllwing chapters: Intrductin Standard Cnfiguratin Clud Cnfiguratin Optins Custmizatin Page 3 f 57

4 Sitecre Architecture Optins When yu install the Sitecre Experience Platfrm (Sitecre XP) with the xdb fr the first time there are several different architecture ptins that yu can chse frm. The mst cmmn scenaris are utlined belw: On-Premise Server Slutins All xdb cmpnents, such as Sitecre applicatin servers and MngDB are installed n the custmer s wn servers. There are tw ways in which yu can install an n-premise Sitecre slutin: Single server standalne envirnment (nt scalable). All cmpnents installed n a single server cmputer. Multi-server scalable envirnment (fully scalable). A multi-server envirnment cnsists f dedicated servers fr each Sitecre cmpnent. Fr example, cntent delivery, cntent management, cllectin database, sessin state, reprting service, reprting database and prcessing servers. Yu als have the ptin f expanding this t handle big data by implementing vertical and hrizntal scaling. Only install a standalne envirnment fr develpment r testing purpses. Fr a prductin envirnment we d nt recmmend that yu install all xdb cmpnents tgether n a single server. Advantages and disadvantages f n-premise Sitecre server slutins: Advantages Mre cntrl Unlimited cnfiguratin ptins. Ptentially unlimited hard disk space depending n budget. Easier t chse whether t use SSD r HDD drives. Disadvantages Cmplicated hardware setup. Cstly t create and maintain. Time cnsuming t administer. Cstly and time cnsuming t expand/upgrade and scale strage. Requires multiple data centers fr gegraphically distributed failure znes. This is much easier and cheaper t achieve with the public clud. Whether yu chse t run Sitecre in the clud, as an n-premise slutin r a hybrid slutin depends n the type and size f rganizatin. Fr example, a small rganizatin may nly need a few servers and therefre can use a public clud slutin whereas a larger enterprise rganizatin may have its wn data center. Public clud prviders can als ffer unlimited disk space. The limitatin in bth cases is the budget. It is much easier and faster t scale strage in the public clud than within yur wn premises. Page 4 f 57

5 xdb Cnfiguratin Guide Hybrid Server Slutins In a hybrid slutin sme cmpnents are installed as part f an n-premise slutin while thers are installed in the clud. Fr example: Multi-server scalable Sitecre envirnment installed as an n-premise slutin (see the previus sectin fr mre details). This can include cntent delivery, cntent management, prcessing, reprting service and reprting database servers installed as an n-premise slutin at an rganizatin s wn data center. MngDB server installed in the clud using Sitecre xdb Clud Editin (see the next sectin fr details). Advantages and disadvantages f hybrid slutins: Advantages Hsting MngDB in the clud remves the need fr specialist MngDB knwledge and expertise. Therefre n new staff r training is required. Ease f maintenance and upgrade. Disadvantages Yu have less cntrl ver scaling the cllectin database t handle large numbers f cntacts and visits. There may be limitatins when using MngDB with sme private clud slutins. Fr example, a limited amunt f data strage Clud Server Slutins In a full-scale clud slutin all Sitecre cmpnents are installed in the clud. Fr example: Fully scalable clud envirnment this includes all Sitecre xdb cmpnents, such as cntent delivery, cntent management, prcessing, reprting service, reprting database, sessin state and MngDB (cllectin database). Advantages and disadvantages f clud slutins: Advantages Simplifies installatin and cnfiguratin. Less specialist knwledge is needed. Data centers can be distributed in remte lcatins arund the glbe ensuring high availability. Backup is dne fr yu. Yu dn t need t manage scalability. Disadvantages Cst. Less cntrl - Yu have less cntrl ver the hardware yu use and hw yu handle scalability. It may nt suit very large rganizatins which have their wn data centers t have all their servers hsted in the clud. Then a hybrid slutin may be a gd ptin. Security. Yu can spread data acrss multiple lcatins. Fr mre infrmatin n architecture see the xdb Overview and Architecture dcument. Fr mre infrmatin n Clud ptins, see xdb Clud Quick Start Guide n SDN r cntact yur lcal Sitecre ffice. Page 5 f 57

6 Sitecre 7.5 Chapter 2 Standard Cnfiguratin This chapter cvers all the basic steps and guidance yu need when setting up the Sitecre Experience Platfrm as an n-premise slutin fr the first time. This chapter cntains the fllwing sectins: Hardware Guidelines Sftware Recmmendatins Installatin Cnfiguring Cnnectin Strings Server Cnfiguratin Sessin State Page 6 f 57

7 xdb Cnfiguratin Guide 2.1 Hardware Guidelines When yu install Sitecre xdb as an entirely n-premise slutin yu need t cnsider the minimum hardware requirements fr each instance in yur envirnment depending n the rles yu have allcated t each server. Cntent Management and Cntent Delivery Servers The requirements fr the cntent management and cntent delivery servers have nt changed. Fr mre infrmatin n specific requirements, see the Sitecre CMS 7.5 Installatin Guide n SDN. Sessin State Server The hardware requirements fr the sessin state server depend n which sessin state service yu chse t use. If yu chse t install a sessin state server with the xdb, yu can cnfigure this t use a MngDB database. We recmmend yu use a fast netwrk, slid-state drive (SSD) n yur sessin state server and plenty f RAM. Fr mre infrmatin n these requirements, see the MngDB installatin guide n the MngDB website: MngDB installatin guides Cllectin Database Server Using MngDB as yur cllectin database, we recmmend that yu install plenty f RAM and use SSD drives. Sharding can als imprve perfrmance significantly. Fr mre infrmatin n MngDB architecture, replicatin and cnfiguratin ptins, see the MngDB dcumentatin n the MngDB website, the xdb Cnfiguratin Guide and the xdb Overview and Architecture dcument. Prcessing and Aggregatin Server Prcessing and aggregatin servers can use RAM fr caching and fr establishing a fast cnnectin t the databases. The mre cres the CPU has, the mre agents yu can cnfigure t run in parallel. Reprting Server The reprting server has the same requirements that the analytics database server had in previus versins f Sitecre. There are n significant changes cmpared t Sitecre CMS and DMS 7.1. Better ptimizatin f the reprting database means it nw uses memry mre efficiently. Hwever, install fast hard drives and plenty f RAM t achieve the best perfrmance. Fr mre detailed infrmatin, see Micrsft SQL Server dcumentatin n MSDN Hardware Cnfiguratin Example frm Sitecre.net The fllwing hardware example setup described in this sectin was implemented n the Sitecre.net website when setting up the xdb fr the first time. There are many alternative ways f installing and cnfiguring Sitecre xdb and this is just ne example. Imprtant The hardware details utlined in this sectin are an example. They are nt a set f recmmendatins t fllw. Yu can use the infrmatin in this sectin t get an idea f what yu might need t cnsider when setting up the xdb fr the first time. Page 7 f 57

8 Sitecre 7.5 Example Hardware Cnfiguratin (Sitecre.net): Server type CPU RAM Disk Cntent delivery 4 x CPU E v2 prcessrs with the mre cres the better. 16 GB (including the perating system). HDD 40 GB per instance. Prcessing 4 x CPU E v2 prcessrs with the mre cres the better. 16 GB (including the perating system). HDD 40 GB per instance. Cntent management 4 x CPU E v2 prcessrs with the mre cres the better. 16 GB (including the perating system). HDD 40 GB per instance. Sessin state (MngDB) 4 x CPU E v2 prcessrs. 4 GB The mre the better. SSD shares hard disk with the cllectin database, ideally the hard disk capacity shuld nt be mre than the RAM which is 4GB in this example. 2 x cllectin (MngDB) servers 4 x CPU E v2 prcessrs. 16 GB The mre the better. 100 GB + SSD The mre disk space yu have, the mre data yu can stre. Reprting database server (SQL Server) 4 x CPU E v2 prcessrs. 16 GB The mre the better. 100 GB + SSD The mre the better. HDD = hard disk drive SSD = slid state drive RAM Operating System Include the Windws perating system (OS) in the RAM usage because it is difficult t predict accurately hw much RAM the Windws OS will cnsume. Sessin The mre RAM yu have, the mre sessins yu can track simultaneusly withut using extra disk space. Actual perfrmance thugh depends n the specific cnfiguratin yu have. Disk I/O n reads shuld be avided. Sessin database The sessin database shuld ideally fit 100% int RAM, therwise it gets t slw. Cllectin database (MngDB) RAM serves as disk cache. Yu need at least enugh RAM t stre wrking set size (MngDB has instructins n hw t estimate these, Micrsft SQL Server als prvides this infrmatin). Page 8 f 57

9 xdb Cnfiguratin Guide Hard Disk In general, the mre disk space yu have, the mre data yu can stre. These example recmmendatins aim fr achieving the best perfrmance pssible but have nt been tested fr every pssible scenari. Where we say, the mre the better, this means that yu need t perfrm tests t find ut what suits yur system best. Page 9 f 57

10 Sitecre Sftware Recmmendatins Fr each xdb server instance that yu install yu need the fllwing minimum sftware prerequisites: Micrsft.NET Framewrk 4.5. Windws Server 2012 R2 recmmended fr mst Sitecre instances, especially prcessing/aggregatin servers. MngDB r later fr the cllectin database, sessin strage and tracking databases. Install MngDB n Micrsft Windws Server as a Windws service. Micrsft SQL Server 2008 R2 SP1 r higher fr the reprting database. Fr mre detailed infrmatin n the specific sftware requirements fr standard Sitecre CMS instances, see the Sitecre CMS 7.5 Installatin Guide n the Sitecre Develper Netwrk (SDN). Page 10 f 57

11 xdb Cnfiguratin Guide 2.3 Installatin This sectin prvides general guidance fr administratrs n installing the Sitecre Experience Database (xdb) with MngDB fr the first time. Fr a cmplete set f steps and mre infrmatin, see the Sitecre 7.5 Installatin Guide n SDN Install Sitecre CMS Yu can install Sitecre CMS using the Sitecre installatin prgram r install it manually frm a.zip archive. The installatin prgram autmatically installs a Sitecre client and databases. It des nt install the MngDB cllectin database as part f the installatin. When yu pen Sitecre fr the first time yu may get an errr if yu have nt updated the CnnectinStrings.cnfig file t pint t the cllectin database (MngDB). In the cnnectin strings cnfiguratin file the cllectin database has the name analytics. Fr mre infrmatin n cnfiguring cnnectin strings, see the sectin Cnfiguring Cnnectin Strings. Fr cmplete instructins n installing Sitecre CMS, see the Sitecre 7.5 Installatin Guide n SDN Install Micrsft SQL Server Install Micrsft SQL Server 2008 R2 SP1 r higher and SQL Server Management Studi. Fr mre detailed infrmatin n installing SQL Server, see the Sitecre 7.5 Installatin Guide n SDN and Micrsft SQL Server installatin instructins n MSDN Install MngDB Install MngDB as yur NSQL database server. MngDB Cnsideratins Befre yu start installing a MngDB database yu shuld cnsider the fllwing: Decide whether yu want a public clud-based slutin such as Windws Azure r ne within yur wn data center n either physical r virtual hsts. Ensure that the MngDB wrking set fits in memry fr ptimal perfrmance. This is usually the mst imprtant perfrmance scale up factr, fllwed by disk and CPU. Selecting hard disks use slid-state drives (SSD) fr fast reads and writes r hard disk drives (HDD) fr larger capacities at lwer cst. SSDs are recmmended as they ffer significantly higher perfrmance. If HDDs are used, we recmmend 15k RPM SAS disks in a RAID10 cnfiguratin fr a balance f perfrmance and fault tlerance. Decide hw many MngDB servers yu need: Standalne server fr testing and develpment. Single replica set The minimum recmmended cnfiguratin fr prductin, which shuld have at least 2.5 servers: tw full capacity data servers fr failver and ne lw Page 11 f 57

12 Sitecre 7.5 capacity server fr the arbiter. We recmmend three data servers fr a rbust and resilient deplyment, especially during maintenance. Sharded cluster When and hw t implement this depends n the data size and perfrmance requirements. There will be multiple shards, with each being a replica set. Fr mre infrmatin, see the Perfrmance Cnsideratins fr MngDB and MngDB Operatins Best Practices whitepapers n the MngDB website. We recmmend that yu nly use single server installatins fr develpment and testing. MngDB Installatin Install an empty MngDB database fllwing the installatin instructins prvided n the MngDB website: When yu have cmpleted the installatin f Sitecre and MngDB yu will nt see any cllectins r dcuments in MngDB straight away. MngDB nly creates the required database cllectins and dcuments yu need when there have been visits t yur website. In MngDB yu carry ut mst administratin tasks using the cmmand line tl mng shell. If yu prefer t use a GUI administrative interface, yu culd use a GUI client such as MngVUE but nte that this tl is nt written r supprted by MngDB, Inc. Cnfiguring MngDB as a Service When yu install MngDB, cnfigure it as a Windws service s that the Mng service starts autmatically every time yu start yur cmputer. If yu wish, yu can change this setting in Services t start the Mng service manually. See the MngDB dcumentatin fr steps n hw t d this using the cmmand line: Cnnecting t MngDB Yu can nly cnnect t MngDB if yu have first cnfigured the cnnectin strings crrectly in the CnnectinStrings.cnfig file in yur site rt. Fr mre infrmatin n cnfiguring cnnectin strings see the sectin Sitecre Experience Platfrm Cnnectin Strings. After yu have cnfigured yur cnnectin strings, test MngDB by pening the MngDB client and cnnect t the MngDB database that yu created. T cnnect t MngDB using MngVUE: 1. In the MngVUE client, click Cnnect t create a cnnectin t yur MngDB installatin. Page 12 f 57

13 xdb Cnfiguratin Guide 2. In the Cnnect windw, click the + symbl t pen the Create new Cnnectin dialg bx. 3. Enter a name fr yur MngDB instance, a server name, and a prt number. 4. Click Test t test the cnnectin and click Save t save yur cnnectin settings. Once yu have created a cnnectin, yu shuld be able t see the databases with the names that yu specified in the CnnectinStrings.cnfig file. MngDB databases: analytics anayticshistry analyticslive lcal Yu need t start Sitecre and visit yur website befre these databases appear in MngDB. Fr an example MngDB replica set architecture, see the xdb Overview and Architecture dcument. Page 13 f 57

14 Sitecre Cnfiguring Cnnectin Strings This sectin cntains infrmatin abut the cnnectin strings yu need t cnfigure in Sitecre XP. Fr mre detailed infrmatin n cnfiguring cnnectin strings fr dedicated servers, see the sectin Server Cnfiguratin. Fr mre infrmatin n cnfiguring cnnectin strings when installing Sitecre XP, see the Sitecre CMS 7.5 Installatin Guide n SDN. Sitecre Experience Platfrm Cnnectin Strings After yu have installed Sitecre CMS, cnfigure the CMS cnnectin strings and any ther cnnectin strings yu need. Hw yu cnfigure cnnectin strings can vary depending n the rle/s yu have assigned t yur servers, fr example, whether yu have dedicated servers fr cntent management, cntent delivery r fr prcessing. This sectin describes the general settings yu need fr a minimal envirnment and nt the specific parameters yu need t cnfigure each rle. T cnfigure Sitecre cnnectin strings pen the CnnectinStrings.cnfig file: 1. In yur website rt flder navigate t the App_Cnfig flder: <sitename>\website\app_cnfig 2. Open the CnnectinStrings.cnfig file in Visual Studi. 3. Cnfigure CMS cnnectin strings fr the Cre, Master, and Web databases, MngDB fr the cllectin database and SQL Server fr reprting. 4. See the table belw fr example cnnectin strings and instructins n hw t d this. 5. Save all changes t the CnnectinStrings.cnfig file. Database Name Cre Master Web Descriptin Cnfigure the Sitecre CMS, SQL Server cnnectin strings fr the Cre, Master, and Web databases. See the example cnnectin strings belw: <add name="cre" cnnectinstring="user id=_sql_server_user_;passwrd=_user_passwrd_;data Surce=_sqlserver_;Database=_cre_database_name_" /> <add name="master" cnnectinstring="user id=_sql_server_user_;passwrd=_user_passwrd_;data Surce=_sqlserver_;Database=_master_database_name_" /> <add name="web" cnnectinstring="user id=_sql_server_user_;passwrd=_user_passwrd_;data Surce=_sqlserver_;Database=_web_database_name_" /> Page 14 f 57

15 xdb Cnfiguratin Guide Database Name Cllectin Descriptin This is a NSQL MngDB database. Mng DB cllectin databases include: analytics tracking.live tracking.histry Cnfigure these cnnectin strings t cnnect t MngDB: <add name="analytics" cnnectinstring="mngdb://_mng_server_name_:_prt_number_/_ cllectin_db_name_" /> <add name="tracking.live" cnnectinstring="mngdb://_mng_server_name_:_prt_ /_tracking_live_db_name_" /> <add name="tracking.histry" cnnectinstring="mngdb://_mng_server_name_:_prt_ /_tracking.histry_db_name_" /> Sessin If yu chse t use a sessin state server, then cnfigure ne f the fllwing cnnectin strings (this is an ptinal step). MngDB: <add name="sessin" cnnectinstring="mngdb://_mng_server_name_:_prt_ /_sessin_db_name_" /> SQL Server: <add name="sessin-mssql" cnnectinstring="user id=_sql_server_user_;passwrd=_user_passwrd_;data Surce=_sqlserver_;Database=_sessin_db_name_" />. Reprting This is a SQL Server database. The reprting database cntains Fact and Dimensin tables fr string all aggregated data used by Sitecre reprting applicatins. <add name="reprting" cnnectinstring="user id=_sql_server_user_;passwrd=_user_passwrd_;data Surce=_sqlserver_;Database=Sitecre_Reprting" /> Page 15 f 57

16 Sitecre 7.5 Database Name Reprting secndary Descriptin This is a SQL Server database. Use the reprting secndary database if yu want t perfrm a rebuild f the reprting database. Reasns fr perfrming a rebuild f the reprting database: If yu have re-classified a search key wrd r traffic type, aggregated reprt data is nt updated autmatically. T keep the cllectin (MngDB) and reprting databases (SQL) synchrnized with each ther. <add name="reprting.secndary" cnnectinstring="user id=_sql_server_user_;passwrd=_user_passwrd_;data Surce=_sqlserver_;Database=Sitecre_Reprting_Secndary" /> : Yu nly need t cnnect the reprting secndary database if yu want t perfrm rebuild f reprting database. 6. Once yu have cnfigured all yur cnnectin strings and added the cnfiguratin files, test yur Sitecre installatin by launching yur website and yu shuld see a blank Sitecre hme page. 7. T verify that yu have cnnected t the reprting database pen SQL Server Management Studi and expand the Tables nde t see all the Fact and Dimensin tables cntained in the reprting database. 8. Test the MngDB installatin by checking that all yur xdb databases, such as analytics and tracking_live appear in yur MngDB client. After cnfiguring cnnectin strings fr MngDB yu may need t generate sme data n yur website befre yu see any cllectins r dcuments. MngDB creates the databases dynamically, s if yur website has n cntact r interactin data then yu d nt see any cllectins r dcuments. Fr mre infrmatin n testing yur cnfiguratin, see Verifying a Cnnectin t the Cllectin Database. Page 16 f 57

17 xdb Cnfiguratin Guide Verifying a Cnnectin t the Cllectin Database Fllw the steps in this sectin t verify that yu have cnfigured yur standalne Sitecre envirnment crrectly. T test that yu have cnfigured yur Sitecre CMS cnnectin strings crrectly pen yur website in a web brwser and check that yu can lg in t the Sitecre Desktp. When yu install the xdb fr the first time there is n pre-defined website. T test yur cnnectin t MngDB, generate sme lcal visits t yur empty website. Any visits yu make t yur website appear as new interactins in the cllectin database. Verify the MngDB Cllectin Database T check that the interactin appears crrectly in the cllectin database: 1. Open yur NSQL database, pen the MngDB client and cnnect t the apprpriate database. 2. In MngVUE, yu can see that befre any cntacts visit yur website, nly sme cllectins are visible. In the fllwing screensht, the Analytics database appears but it des nt yet cntain any cllectins. The Cntacts and Interactins cllectins are missing until yur website has visits. Page 17 f 57

18 Sitecre 7.5 Make a visit t yur website test page then refresh MngDB. Expand the analytics database and then expand the Cllectins nde. Yu can see fur new cllectins relating t brwser and system infrmatin but n interactin r cntact cllectins appear yet. Sessin End Default Timeut Setting After making a test visit, yu may need t wait 20 minutes befre MngDB updates with the latest changes. Fr testing purpses yu may wish t make data appear mre quickly. T change the default timeut setting: 1. Open the web.cnfig file. 2. Navigate t the <sessinstate nde. 3. Change the sessin end default timeut setting frm 20 t 1 minute. <sessinstate mde="inprc" ckieless="false" timeut="1">. 4. Make a visit t yur website test page then refresh MngDB. Data shuld nw appear in MngDB after ne minute. It is highly recmmended that yu change the default timeut setting fr testing purpses nly. The default setting shuld be restred as sn as pssible. Page 18 f 57

19 xdb Cnfiguratin Guide 5. Refresh the MngDB database again. After a shrt time yu shuld see the Cntacts, Devices, and Interactins cllectins added t MngDB. 6. Right click Interactins and then click View t see all the interactins made with yur website. 7. In this example, five interactins are stred in this cllectin. Expand ne f these interactins and view data relating t the pages visited. The visit in the fllwing screensht cnsists f Page 19 f 57

20 Sitecre 7.5 tw page views. Page 20 f 57

21 xdb Cnfiguratin Guide Verifying SQL Server Fact and Dimensin tables Befre yu can verify that Fact and Dimensin tables cntain pre-aggregated data, ensure that yu have data in the cllectin database and have cnfigured prcessing crrectly. Fr mre infrmatin n cnfiguring a standalne prcessing server, see sectin Errr! Reference surce nt fund.. Query ne f the SQL Server Fact tables, such as Fact_PageViews and view all rws t see if it cntains any data. If the table cntains analytics data then the prcessing layer is wrking crrectly. If yu cannt see any data in the Fact_ tables check that the CnnectinStrings.cnfig n the prcessing server t see if the analytics cnnectin string t MngDB is cnfigured crrectly and that yu have data in the cllectin database. Page 21 f 57

22 Sitecre Server Cnfiguratin Just like its predecessr, the xdb supprts a standalne all-in-ne cnfiguratin, retaining the ability t run n a single server. This allws fr easy deplyment f a develpment envirnment r a small, lw-traffic prductin instance. Hwever, yu nly see the real benefits and flexibility f the xdb architecture when yu start trying t imprve the perfrmance f yur applicatin. T achieve better perfrmance and scalability yu can cnfigure dedicated servers fr different purpses such as fr cntent delivery r data prcessing. Yu can chse frm a list f server features that yu can cnfigure n single r multiple dedicated servers. In practical terms, t assign features t a dedicated server yu simply cnfigure a reduced set f cmpnents n a server. Yu can d this by disabling r enabling cnfiguratin files in yur Sitecre installatin. This gives yu flexibility and fine-grained cntrl ver the tasks and activities that yu assign t each f yur Sitecre instances. By dividing yur Sitecre applicatin up int multiple servers perfrming different activities, yu increase yur scaling ptins. Fr imprved applicatin perfrmance, yu can scale bth vertically (by scaling up the hardware n each server) and hrizntally (by adding mre servers t perfrm each activity). Fr imprved availability and reliability, yu can create clusters, such as fr cntent delivery r data prcessing. Fr additinal flexibility, yu can als cnfigure a single server t perfrm multiple server tasks. Fr example, yu culd enable cntent management, cntent delivery, and reprting n a single server but mve the MngDB cllectin database t anther server Server Features T cnfigure a server t use the fllwing server features, yu may need t make changes t the default cnfiguratin f yur Sitecre slutin. Page 22 f 57

23 xdb Cnfiguratin Guide The fllwing table describes the server features that yu can enable r disable n dedicated servers alng with the required cnnectin strings and cnfiguratin files that yu need t enable r disable. All cnnectin strings are stred in the CnnectinStrings.cnfig file which is lcated in the /App_Cnfig/ flder and all cnfiguratin files are stred in the /App_Cnfig/Include flder. Server Feature and Descriptin Tracking T track nline visits, cntacts (visitrs), persnalizatin, gals, campaigns, prfiles, pattern cards and multivariate tests. All tracking data is saved by default in the MngDB cllectin database. Cnnectin strings Cnfigure the fllwing database cnnectin strings: analytics tracking.live Cnfiguratin files Required cnfiguratin files: Sitecre.Analytics.Tra cking.cnfig Sitecre.Analytics.Tra cking.database.cnfig Sitecre.Analytics.Tra cking.aggregatin.cnf ig Sitecre.Analytics.Tra cking.rbtdetectin.c nfig If yu want t enable all tracking subsystem features but dn t want tracking data t be saved t the cllectin database, yu must disable the fllwing cnfiguratin files: Sitecre.Analytics.Tra cking.database.cnfig Sitecre.Analytics.Tra cking.aggregatin.cnf ig Sitecre.Analytics.Tra cking.rbtdetectin.c nfig Reprting Can use data frm the cllectin and reprting databases. Data is used in applicatins such as Engagement Analytics reprts and the Executive Insight Dashbard. Cnfigure the fllwing database cnnectin strings: analytics reprting Required cnfiguratin file: Sitecre.Analytics.Rep rting.cnfig Prcessing Prcessing can rebuild the entire reprting database n request if data in the cllectin database has changed and has becme ut f sync. Fr example, classificatin f cntact r lcatins. Cnfigure the fllwing database cnnectin strings: tracking.live tracking.histry analytics reprting.secndary Required cnfiguratin file: Sitecre.Analytics.Pr cessing.cnfig Sitecre.Analytics.Pr cessing.services.cnfi g Page 23 f 57

24 Sitecre 7.5 Server Feature and Descriptin Aggregatin Respnsible fr extracting data frm the cllectin database, gruping it and reducing it and then string it in the reprting database fr use by Sitecre reprting applicatins. Aggregatin keeps the reprting database synchrnized with the cllectin database. Cnnectin strings Cnfigure the fllwing database cnnectin strings: tracking.live reprting Cnfiguratin files Required cnfiguratin files: Sitecre.Analytics.Pr cessing.aggregatin.c nfig Sitecre.Analytics.Pr cessing.aggregatin.pr cessingpls.cnfig Sitecre.Analytics.Pr cessing.aggregatin.se rvices.cnfig Reprting Service Can query different data surces fr Sitecre reprting applicatins: it queries the reprting database fr gruped data, aggregated data and trends and the cllectin database fr individual cntact r interactin data. Cnfigure the fllwing database cnnectin strings: reprting analytics Required cnfiguratin files: Sitecre.Analytics.Rep rting.cnfig Sitecre.Analytics.R eprting.remteclien t.cnfig Sitecre.Analytics.R eprting.remteserve r.cnfig EAS Prcessing Prcessing f engagement autmatin state timeuts This feature is respnsible fr setting up the autmatin wrkers t prcess EAS timeut cnditins. Cnfigure the fllwing database cnnectin strings: analytics Required cnfiguratin file: Sitecre.Analytics.Aut matin.timeutprcess ing.cnfig The fllwing cnfiguratin files are necessary fr all the server features and shuld therefre nt be disabled: Sitecre.Analytics.cnfig Sitecre.Analytics.Mdel.cnfig Sitecre.Analytics.Mngdb.cnfig All cnfiguratin files are enabled by default with the exceptin f Sitecre.Analytics.Reprting.RemteClient.cnfig and Sitecre.Analytics.Reprting.RemteServer.cnfig file, which are disabled by default Server Cnfiguratin Examples This sectin includes step by step instructins n setting up dedicated servers t implement different server features. These steps may require yu t make change t the default Sitecre xdb installatin. Page 24 f 57

25 xdb Cnfiguratin Guide The examples in this sectin are standard server examples prvided by Sitecre. This type f server cnfiguratin is mst suitable fr installatins where yu want t scale vertically. Yu can use these as examples as a guide r yu can mdify them by cmbining servers and features in a way that best suits yur wn Sitecre slutin. When yu install Sitecre, sme cnfiguratin files are enabled by default. Yu may need t manually disable cnfiguratin files depending n the purpse f yur server. Cntent Delivery Server A cntent delivery server requires the Tracking server feature. T cnfigure a single server fr cntent delivery: 1. Install and cnfigure yur cntent delivery Sitecre envirnment accrding t the instructins in the Sitecre Installatin Guide. 2. Remve r restrict access t the client. Yu d nt need the Sitecre client n a cntent delivery server. Fr mre infrmatin n hw t d this, see chapter 4 in the Sitecre CMS 7.0 Scaling Guide n SDN. 3. Navigate t the /App_Cnfig/Include flder and disable the fllwing cnfiguratin files. T disable a cnfiguratin file change the extensin frm.cnfig t.disabled. Sitecre.Analytics.Autmatin.TimeutPrcessing.cnfig Sitecre.Analytics.Prcessing.Aggregatin.Services.cnfig Sitecre.Analytics.Prcessing.Services.cnfig Sitecre.Analytics.Reprting.cnfig When yu install Sitecre, sme cnfiguratin files used fr cntent delivery are enabled by default. 4. Ensure that the fllwing cnfiguratin files remain disabled: Sitecre.Analytics.Reprting.RemteClient.cnfig.disabled Sitecre.Analytics.Reprting.RemteServer.cnfig.disabled 5. Cntent delivery servers d nt require all cnnectin strings t be active. Fr example, there are sme security benefits in remving the reprting cnnectin string. Either remve these strings cmpletely r add cmment tags t hide them. In the /App_Cnfig/CnnectinStrings.cnfig file remve the fllwing cnnectin strings: <add name="reprting" cnnectinstring=".."/> <add name="tracking.histry" cnnectinstring="mngdb:.."/> 6. In the /App_Cnfig/CnnectinStrings.cnfig file, cnfigure the Sitecre CMS web applicatin t cnnect t the Cre and Web databases frm the database server, but nt the Master database. T disable the master database, yu cmment ut the cnnectin string. 7. Assign a name fr each cntent delivery server. This is especially imprtant if yu are creating a cluster f cntent delivery servers. Add the name t the Sitecre.Analytics.Tracking.cnfig file. Page 25 f 57

26 Sitecre 7.5 T assign a name, pen the Sitecre.Analytics.Tracking.cnfig file and add a name t the value parameter in the fllwing setting: <setting name="analytics.clustername" value="" /> The name shuld be identical fr all cntent delivery servers that are in the same cluster. Fr example: <setting name="analytics.hstname" value=" /> <setting name="analytics.clustername" value="cluster1.dmain.cm" /> Additinal steps necessary t cnfigure Sitecre.Search functinality: 1. Ensure that the Sitecre.CntentSearch.Lucene.Index.Master.cnfig file is disabled. 2. Lcate the Sitecre.CntentSearch.DefaultCnfiguratins.cnfig file and cmment ut all strategies where the master database is used. 3. Lcate the Sitecre.ItemBuckets.cnfig and cmment ut the fllwing sectin: <database id="master">. 4. At Sitecre.CntentSearch.cnfig disable the fllwing sectin by cmmenting it ut: <scheduling> <!-- An agent t ptimize the specified indexes peridically. --> <agent type="sitecre.cntentsearch.tasks.optimize" methd="run" interval="01:00:00"> <indexes hint="list"> <index>sitecre_master_index</index> </indexes> </agent> </scheduling> In this type f cnfiguratin, the cntent delivery server is used fr tracking. We recmmend that tracking is the nly analytics feature yu enable n a dedicated cntent delivery server. If yu nly have a single cluster then the cluster cnfiguratin described in this sectin is nt applicable. Fr mre infrmatin n enabling ther features n a server, see Server Features. T use Sitecre MVC with the xdb, navigate t /App_Cnfig/Include/Sitecre.MvcAnalytics.cnfig.disabled. Rename the Sitecre.MvcAnalytics.cnfig.disabled file t Sitecre.MvcAnalytics.cnfig. If yu experience cntact lcking while running the Experience Manager (EXM) in a scaled envirnment, then see the ECM Administratr s and Develper s Guide fr further tips and guidance. Cntent Management Server A cntent management server requires the Reprting server feature. T cnfigure a single server fr cntent management: 1. Install and cnfigure yur cntent management Sitecre envirnment accrding t the instructins in the Sitecre Installatin Guide and the Sitecre Scaling Guide. 2. Navigate t the /App_Cnfig/Include flder and disable the fllwing cnfiguratin files. T disable a cnfiguratin file change the extensin frm.cnfig t.disabled: Page 26 f 57

27 xdb Cnfiguratin Guide Sitecre.Analytics.Autmatin.TimeutPrcessing.cnfig Sitecre.Analytics.Prcessing.Aggregatin.Services.cnfig Sitecre.Analytics.Prcessing.Services.cnfig Sitecre.Analytics.Tracking.Database.cnfig Sitecre.Analytics.Tracking.Aggregatin.cnfig 3. Ensure that the fllwing cnfiguratin file remains disabled: Sitecre.Analytics.Reprting.RemteClient.cnfig.disabled Sitecre.Analytics.Reprting.RemteServer.cnfig.disabled 4. Open the /App_Cnfig/CnnectinStrings.cnfig file and cnfigure cnnectin strings fr the fllwing databases: SQL Server: cre master web reprting MngDB: analytics tracking.live Yu shuld always cnfigure the sessins cnnectin string unless yu use the InPrc mde fr sessin state. It is k t cnfigure a cntent management server with the InPrc sessin prvider because it des nt perfrm the same tasks as a cntent delivery server. This als means a cntent management server shuld never be a part f a cntent delivery cluster. In this type f cnfiguratin, the cntent management server is used fr tracking but des nt save any changes t the cllectin database. Befre running histry prcessing using the RebuildReprtingDb.aspx page, make sure yu add a reprting.secndary cnnectin string t the CnnectinStrings.cnfig file. Example reprting.secndary cnnectin string: <add name="reprting.secndary" cnnectinstring="."/> If yu are cnfiguring a pure cntent management server rle, the Tracking.Database.cnfig file must be disabled. Hwever, if yu want the cntent management server rle t be mixed, r if there is a chance that ther mdules may depend n the tracking data access API, then the Tracking.Database.cnfig file must be enabled. Fr mre infrmatin n enabling ther features n a server, see Server Features. T use Sitecre MVC with the xdb, navigate t /App_Cnfig/Include/Sitecre.MvcAnalytics.cnfig.disabled. Rename the Sitecre.MvcAnalytics.cnfig.disabled file t Sitecre.MvcAnalytics.cnfig. Page 27 f 57

28 Sitecre 7.5 Prcessing Server Cnfigure a prcessing server in the same way as yu cnfigure a cntent delivery server. Yu can create ne r multiple prcessing servers that can be cnfigured fr aggregatin r ther kinds f prcessing. As a general rule, the mre aggregatin server instances yu create, the faster aggregatin prcessing will be. A prcessing server can use ne r mre f the fllwing server features: Prcessing Aggregatin EAS Prcessing Yu can cnfigure separate servers t perfrm each f these tasks independently n dedicated servers. T cnfigure a prcessing server rle: 1. Install a standard Sitecre CMS instance n the server yu want t use fr prcessing. 2. Remve r restrict access t the client. Yu d nt need the Sitecre client n a prcessing server. Fr mre infrmatin and steps n hw t d this, see the Sitecre CMS 7.0 Scaling Guide n SDN. 3. Navigate t the /App_Cnfig/Include flder and disable the fllwing cnfiguratin files. T disable a cnfiguratin file change the extensin frm.cnfig t.disabled: Sitecre.Analytics.Tracking.Database.cnfig Sitecre.Analytics.Tracking.cnfig Sitecre.Analytics.Reprting.cnfig Sitecre.Analytics.Tracking.RbtDetectin.cnfig Sitecre.CntentSearch.Lucene.Index.Web.cnfig Ensure that the fllwing cnfiguratin files remain disabled: Sitecre.Analytics.Reprting.RemteClient.cnfig.disabled Sitecre.Analytics.Reprting.RemteServer.cnfig.disabled 4. In the /App_Cnfig/CnnectinStrings.cnfig file cmment ut r remve the Web and Sessin cnnectin strings: <add name="web" cnnectinstring="user id=_sql_server_user_;passwrd=_user_passwrd_;data Surce=_sqlserver_;Database=Sitecre_web" /> <add name="sessin" cnnectinstring="mngdb://_mng_server_name:_prt_number/_sessin_database_name" /> In the Sitecre.Buckets.cnfig file, cmment ut the fllwing sectin: <database id="web" singleinstance="true" type="sitecre.data.database, Sitecre.Kernel"> </database> 5. Lcate the Sitecre.CntentSearch.DefaultCnfiguratins.cnfig file and cmment ut all the strategies where the Web database is used. Page 28 f 57

29 xdb Cnfiguratin Guide 6. In the web.cnfig file, cmment ut the Sitecre.Tasks.PublishAgent sectin. 7. In the Sitecre.WebDAV.cnfig file, cmment ut the fllwing sectin: Sitecre.Tasks.CleanupFDAObsleteMediaData 8. In the web.cnfig file, cmment ut the fllwing sectin: <database id="web" singleinstance="true" type="sitecre.data.database, Sitecre.Kernel"> <database> Als, cmment ut any websites that use the Web database: <site name="mdules_website > <site name="website"> T cnfigure aggregatin agents r threads n a prcessing server: 1. Open the Sitecre.Analytics.Prcessing.Aggregatin.cnfig file in an XML editr. Yu can specify hw many aggregatin agents yu want t run at the same time. Start by using the default settings. 2. Edit the <MaxThreads> setting t specify the number f aggregatin agents (threads) that yu want t run n the server. Yu can als specify hw many cleanup and recvery threads that yu need. Adjust these settings depending n yur available hardware and business requirements. <!-- Aggregatin Mdule: --> <mdule type="sitecre.analytics.aggregatin.aggregatinmdule" singleinstance="true"> <BackgrundServices hint="list:add"> <aggregatr type="sitecre.analytics.aggregatin.backgrundservice"> <param desc="agentname">aggregatin/aggregatr</param> <Interval>0.00:00:15</Interval> <MaxThreads>16</MaxThreads> </aggregatr> <cleanup type="sitecre.analytics.aggregatin.backgrundservice"> <param desc="agentname">aggregatin/cleanup</param> <Interval>0.00:00:15</Interval> <MaxThreads>16</MaxThreads> </cleanup> <recvery type="sitecre.analytics.aggregatin.backgrundservice"> <param desc="agentname">aggregatin/recvery</param> <Interval>0.00:00:15</Interval> <MaxThreads>16</MaxThreads> </recvery> <histry type="sitecre.analytics.aggregatin.backgrundservice"> <param desc="agentname">aggregatin/histrywrker</param> <Interval>0.00:00:15</Interval> <MaxThreads>16</MaxThreads> </histry> <histrycmpletincheck type="sitecre.analytics.aggregatin.backgrundservice"> <param desc="agentname">aggregatin/histrycmpletincheck</param> <Interval>0.00:00:15</Interval> <MaxThreads>1</MaxThreads> </histrycmpletincheck> </BackgrundServices> </mdule> Start by using the default values and then ver time adjust these settings t ptimize yur aggregatin server r servers. In this type f cnfiguratin, the prcessing server perfrms tw functins: aggregatin and prcessing. These are the tw main rles fr a prcessing server. Aggregatin Perfrmance Tip If yu rebuild the entire MngDB analytics database, then yu might experience sme perfrmance issues during aggregatin prcessing. Page 29 f 57

30 Sitecre 7.5 T ptimize perfrmance during aggregatin, edit the Lucene and SOLR analytics cnfiguratin files and adjust the minimum and maximum queue size values. T adjust the minimum and maximum queue size settings, pen ne f the fllwing cnfiguratin files in the Website\App_Cnfig flder: Sitecre.CntentSearch.Lucene.Index.Analytics.cnfig Sitecre.CntentSearch.Slr.Indexes.Analytics.cnfig The Slr indexing cnfiguratin file is nly present here if yu have installed Slr. Increase the MinimumQueueSize value if yur thrughput is extremely high. <crawler type="sitecre.cntentsearch.analytics.crawlers.analyticsvisitpagecrawler, Sitecre.CntentSearch.Analytics"> <CrawlerName>Lucene Visit Page Crawler</CrawlerName> <ObservableName>VisitPageObservable</ObservableName> <NumberOfSecndsTQueue>60</NumberOfSecndsTQueue> <MinimumQueueSize>500</MinimumQueueSize> <MaximumQueueSize>50000</MaximumQueueSize> </crawler> Befre running histry prcessing using the RebuildReprtingDb.aspx page, make sure yu add a reprting.secndary cnnectin string t the CnnectinStrings.cnfig file. Fr mre infrmatin n enabling ther features n a server, see Server Features. Reprting Service Server A Reprting Service server requires the Reprting Service server feature. T cnfigure a dedicated Reprting Service server: 1. Install Sitecre instance frm Sitecre distributive. 2. Navigate t the /App_Cnfig/Include flder and disable the fllwing cnfiguratin files. T disable a cnfiguratin file change the extensin frm.cnfig t.disabled: Sitecre.Analytics.Tracking.Database.cnfig Sitecre.Analytics.Tracking.cnfig Sitecre.Analytics.Tracking.Aggregatin.cnfig Sitecre.Analytics.Prcessing.Aggregatin.Services.cnfig Sitecre.Analytics.Prcessing.Services.cnfig Sitecre.Analytics.Autmatin.TimeutPrcessing.cnfig Sitecre.Analytics.Tracking.RbtDetectin.cnfig 3. Navigate t the /App_Cnfig/Include flder and enable the fllwing cnfiguratin file: Sitecre.Analytics.Reprting.RemteServer.cnfig 4. In the /App_Cnfig/CnnectinStrings.cnfig file cmment ut r remve the tracking.live and tracking.histry cnnectin strings: <add name="tracking.live " cnnectinstring="mngdb:.."/> <add name="tracking.histry" cnnectinstring="mngdb:.."/> In this type f cnfiguratin, the dedicated server perfrms a single functin as the Reprting Service which can query multiple data surces such as the cllectin r reprting databases t gather data fr Page 30 f 57

31 xdb Cnfiguratin Guide dashbards and reprts. We recmmend that yu nly cnfigure ne and nt multiple dedicated Reprting Service servers. Fr mre infrmatin n enabling ther features n a server, see Server Features. T enable cmmunicatin between the cntent management server (client) and the Remte Reprting Service, yu must make the fllwing cnfiguratin changes: 1. On yur cntent management server client, in the Website/App_Cnfig flder, pen the Sitecre.Analytics.Reprting.RemteClient.cnfig file and enable it by remving.disabled frm the file name. 2. Under the <httptransprtfactry> nde, change the default value f the desc parameter t the hstname f yur Reprting Service server instance. See the fllwing example: <httptransprtfactry type="sitecre.analytics.cmmns.cnfiguratinbasedhttptransprtfactry, Sitecre.Analytics" singleinstance="true"> <param desc="serviceurl"> </httptransprtfactry> 3. In the Website/App_Cnfig flder, pen the CnnectinStrings.cnfig file and cmment ut r remve the fllwing reprting, tracking.live and tracking.histry cnnectin strings: <add name="reprting" cnnectinstring=".."/> <add name="tracking.live " cnnectinstring="mngdb:.."/> <add name="tracking.histry" cnnectinstring="mngdb:.."/> Cllectin Database Server (xdb) T cnfigure a dedicated cllectin database server. 1. Install a blank MngDB database by fllwing the instructins n the MngDB website. Fr hardware and sftware guidelines see, Hardware Guidelines and Sftware Recmmendatins. The xdb MngDB analytics database is used as the xdb cllectin database. S when yu create a dedicated cllectin database server there is n need t install a Sitecre instance. 2. Install the Windws versin f MngDB and ensure that it is running as a service. 3. Cnfigure a MngDB three-server replica set T see an example f a standard MngDB replica set architecture that cnsists f three MngDB instances (primary, secndary and arbiter), see the xdb Overview and Architecture dcument. Fr prductin envirnments, we d nt recmmend that yu cnfigure a standalne MngDB instance instead yu shuld cnfigure a replica set t ensure autmatic failver and data safety. 4. Once yu have cnfigured the cllectin database n a dedicated server then all ther servers that have an analytics cnnectin string r need t cnnect t the MngDB cllectin database shuld be cnfigured t pint t this server and t use the crrect prt number. Page 31 f 57

32 Sitecre 7.5 Sessin Database Server Yu can install a sessin database n either a MngDB r SQL Server dedicated server. A dedicated Sitecre instance is nt required when cnfiguring a dedicated sessin state database server. T use MngDB r SQL Server as dedicated sessin servers yu als need t install the apprpriate sessin state prvider: Sitecre ASP.NET Sessin State Prvider fr MngDB Sitecre ASP.NET Sessin State Stre Prvider fr Micrsft SQL Server Ensure that yu cnfigure cnnectin strings n any ther servers that need t cnnect t the sessin state database server. Fr mre infrmatin n cnfiguring sessin state servers, see the sectin n Sessin State. Reprting Database Server A reprting database server des nt need t be installed r run n a Sitecre instance. Yu can install a reprting database as a dedicated SQL Server instance. T cnfigure a Micrsft SQL Server instance as a dedicated reprting server: 1. Install SQL Server 2008 R2 SP1 r later. 2. On yur cntent management and prcessing instances, pen the CnnectinStrings.cnfig file, mdify the cnnectin strings t pint t the dedicated reprting database server. 3. Ensure that yu cnfigure cnnectin strings fr any ther servers that need t cnnect t the reprting database server. 4. Ensure that yur SQL Server instance is cnfigured and running crrectly. 5. Test yur cnnectins. Fr mre infrmatin n cnfiguring cnnectin strings fr the reprting database, see sectin 2.4 Cnfiguring Cnnectin Strings. A SQL Server reprting can nly be scaled vertically. Page 32 f 57

33 xdb Cnfiguratin Guide 2.6 Sessin State A sessin state server stres infrmatin relevant t current cntact sessins. The Sitecre xdb cmes with tw sessin state services: Private sessin state hlds infrmatin private t sessins. This is cntact visit infrmatin, such as pages viewed, gals cnverted, r campaigns triggered. Shared sessin state hlds infrmatin that may be shared by multiple visits n the same cluster, such as cntacts and devices. Yu can cnfigure sessin state in tw different ways; as either in prcess (InPrc) r ut f prcess. Imprtant Sitecre requires that yu must cnfigure bth private and shared sessin state. Yu can chse t use the same database fr bth private and shared sessins but t ensure that the system can distinguish between the private and shared sessin entries yu must remember t cnfigure the sessintype attribute in the web.cnfig file crrectly In Prcess In prcess (InPrc) is the default sessin state prvider that cmes with the Micrsft.NET Framewrk. It uses internal memry t track interactins and visits. In prcess is the mst suitable way f handling private sessin state fr all data related t a specific interactin (single visitr sessin r visit). It is the recmmended mde t use fr cntent management servers. Yu cannt use InPrc in a lad balanced envirnment unless yu cnfigure the lad balancer t use sticky sessins Out f Prcess Out f prcess means that yu use an external ASP.NET sessin state prvider such as MngDB r SQL Server. This is suitable fr handling shared sessin state if yu have multiple cntent delivery servers. It is als suitable if yu have multiple cntent management servers and yu d nt wish t use sticky sessins. Sitecre cmes with the fllwing tw sessin state prviders fr cnfiguring ut f prcess sessin state: Sitecre ASP.NET Sessin State Prvider fr MngDB Sitecre ASP.NET Sessin State Stre Prvider fr Micrsft SQL Server Sessin State Cnfiguratin Scenaris The fllwing example scenaris prvide guidance n hw t cnfigure sessin state n several different types f Sitecre server cnfiguratins. Single Sitecre Server On a single standalne Sitecre instance bth sessin prviders shuld use the in prcess (InPrc) sessin state mde. Page 33 f 57

34 Sitecre 7.5 Single Cntent Delivery Server and a Separate Cntent Management Server On the cntent delivery server yu shuld cnfigure bth sessin prviders t use the in prcess (InPrc) sessin state mde. Imprtant When cnfiguring sessin state n cntent management servers yu shuld always cnfigure sessin state prviders t use the in prcess (InPrc) mde. Sitecre xdb des nt supprt sharing sessin state amng a grup f cntent management servers r between cntent management and cntent delivery servers. Cntent Delivery Cluster with a Sticky Lad Balancer On all cntent delivery instances yu shuld cnfigure the ASP.NET sessin state prvider t use the in prcess (InPrc) mde. Yu shuld cnfigure the shared sessin state prvider t use ne f the ut f prcess mdes cnnected t a database shared amng all the cntent delivery instances. Cntent Delivery Cluster with a Nn-Sticky Lad Balancer On all cntent delivery instances yu shuld cnfigure bth sessin state prviders t use ne f the ut f prcess mdes cnnected t a database (r databases) shared amng the cntent delivery instances. Fr an verview f sessin state, see the xdb Overview and Architecture dcument. Fr mre infrmatin n scalability settings and installing a dedicated cntent delivery server, see the Sitecre Scaling Guide. Page 34 f 57

35 xdb Cnfiguratin Guide 2.7 Cnfiguring Private Sessin State Private sessin state hlds visit infrmatin private t cntact sessins such as pages viewed, gals cnverted, campaigns triggered r engagement pints accumulated. Yu can use either MngDB r SQL Server as yur private sessin state stre. If yu are running an n-premise slutin with a MngDB database as yur cllectin database then we recmmend that yu use MngDB as yur sessin stre. The Sitecre ASP.NET Sessin State Prvider fr MngDB allws yu t use MngDB as yur sessin state stre. This prvider supprts the SessinEnd event, which the xdb needs t track website visits. Private sessin state is nt required t supprt the Sessin_End event n cntent management servers. Private sessin state must supprt the Sessin_End event n cntent delivery servers. Fllw the steps in this sectin t cnfigure a MngDB r SQL Server sessin state prvider. If yu are using a MngDB sessin prvider then all cntent delivery servers shuld use the same prvider pinting t the same database Cnfiguring the MngDB Sessin State Prvider Fllw the steps in this sectin t use a MngDB database as yur private sessin state stre using the Sitecre ASP.NET Sessin State Prvider fr MngDB. MngDB Hardware Cnsideratins Fr each web request the cntent delivery server accesses the sessin state stre database multiple times. This can have a significant impact n the perfrmance f yur web site, s we recmmend that yu use slid-state drives fr the database and install enugh memry t avid frequent disk reads. Each visit requires abut 30 kilbytes f strage capacity in the sessin database (by default) but space requirements may change depending n custmizatins. Yu can calculate the disk space requirements expressed in kilbytes using the fllwing frmula: Maximum number f cncurrent visits * 30 This includes active visits and thse which are inactive but which have nt yet timed ut. Yu can als use the same frmula t calculate memry requirements. See the fllwing MngDB dcuments fr mre details: Fr mre infrmatin n hw t install and cnfigure a MngDB database, see the steps utlined earlier in sectin Install MngDB and the MngDB website. Deplying the MngDB Sessin Database T cnfigure the Sitecre ASP.NET Sessin State Prvider fr MngDB: 1. Install MngDB database server versin 2.6 r later. We recmmend that yu install this n a dedicated server. 2. Cnfigure Sitecre t use the Sitecre ASP.NET Sessin State Prvider fr MngDB (see the instructins in this sectin). Page 35 f 57

36 Sitecre 7.5 Cnfiguring Sitecre Cnfigure the ASP.NET sessin state prvider fr MngDB in the same way as any ther custm sessin state stre prvider. T cnnect the MngDB sessin prvider: 1. Open the CnnectinStrings.cnfig file lcated here <sitename>\website\app_cnfig and add the fllwing cnnectin string: <add name="sessin" cnnectinstring="mngdb://_mng_server_name_:_prt_number_/_sessin_database_name_" /> 2. Open the web.cnfig file in yur site rt flder <sitename>\website and lcate the sessinstate sectin: <sessinstate mde="inprc" ckieless="false" timeut="20"> 3. Update the sessinstate sectin t use the MngDB prvider instead f InPrc as shwn in the fllwing example. Als, change the name attribute value t mng: <sessinstate mde="custm" custmprvider="mng" ckieless="false" timeut="20"> <prviders> <add name="mng" type="sitecre.sessinprvider.mngdb.mngsessinstateprvider, Sitecre.SessinPrvider.MngDB" cnnectinstringname="sessin" pllinginterval="2" cmpressin="true" sessintype="private"/> </prviders> </sessinstate> Cnfiguratin ptins: Setting cnnectinstringname Fr example: cnnectinstringname="sessin" Plling interval Fr example: pllinginterval="2" Cmpressin Fr example: cmpressin="true" /> sessintype Descriptin Edit the cnnectin string s that the sessin prvider cnnects t the SQL Server database that yu want t use. In the xdb this database is called sessin. This is the time interval in secnds that the sessin stre prvider uses t check if any sessins have expired. This setting is a Blean flag that indicates whether t cmpress sessin state data r nt. The default value is true. Cmpressing sessin state data reduces the amunt f data that yu need t transfer between the database and the Sitecre instance. This may cause sme additinal CPU verhead. This value must be set either t private r shared. Fr example: sessintype="private" If yu have cnfigured everything crrectly, a sessin database shuld appear in yur list f MngDB databases after the first web request. Page 36 f 57

37 xdb Cnfiguratin Guide Cnfiguring the SQL Server Sessin State Prvider Fllw the steps in this sectin t use a SQL Server database as yur private sessin state stre using the Sitecre ASP.NET Sessin State Prvider fr SQL Server. This might be an apprpriate ptin if yu are running the cllectin database (MngDB) in the clud as a service r if yu prefer nt t run an n-premise MngDB server instance. This prvider supprts the sessin end event which is required by the xdb in rder t track website visits. T cnfigure Private Sessin State Prvider fr Micrsft SQL Server: In Micrsft SQL Server, deply the Sessin database Cnfigure Sitecre t use the SQL Server sessin prvider. Deplying the SQL Server Sessin Database Fr each web request the sessin state stre database is accessed multiple times. This can have a significant impact n the perfrmance f yur web site. Therefre we recmmend that yu install enugh RAM t allw Micrsft SQL Server t keep the sessin state database in memry. We als recmmended that yu put the database files n an SSD drive. T deply the Sessin database: 1. Start Micrsft SQL Server Management Studi 2012 r later. 2. Cnnect t the server nde that yu want t install the Sessin database n. 3. Expand the server nde, right-click Databases, and then click Attach. 4. In the Attach Databases dialg bx, click Add. 5. Brwse t the Databases flder in yur website rt flder, select the Sitecre.Sessins.mdf database and click OK. 6. In the Attach Databases dialg bx, click OK. The sessin database nw appears in yur list f attached databases. 7. Add the fllwing cnnectin string t the CnnectinStrings.cnfig file: <add name="sharedsessin" cnnectinstring="user id=_sql_server_user_;passwrd=_user_passwrd_;data Surce=_sqlserver_;Database = _sharedsessin_database_name_"/> The add name value can be sessin r sharedsessin depending n whether yu are cnfiguring private r shared sessin state. Perfrmance Optimizatins T achieve ptimal perfrmance yu can install an extensin t the Sessins database. T install the perfrmance enhancements start Micrsft SQL Server Management Studi 2012: 1. Open the Perfrmance Bst.sql file. 2. In the first line f the Perfrmance Bst.sql file replace USE [Sitecre_Sessin] with the name f yur sessin database. 3. After yu have updated the USE statement t pint t yur sessin database hit F5 key t execute the file. The perfrmance enhancements are nt supprted n Windws Azure. Page 37 f 57

38 Sitecre 7.5 Cnfiguring Sitecre Yu cnfigure the ASP.NET sessin state stre prvider fr Micrsft SQL Server in the same way as any ther custm sessin state stre prvider. T cnnect t the SQL Server sessin prvider: 1. Open the CnnectinStrings.cnfig file lcated here <sitename>\website\app_cnfig and add the fllwing cnnectin string: <add name="sessin" cnnectinstring="user id=_sql_server_user_;passwrd=_user_passwrd_;data Surce=_sqlserver_;Database=_sessin_database_name_" /> 2. Open the web.cnfig file in yur site rt flder <sitename>\website and lcate the sessinstate sectin: <sessinstate mde="custm" custmprvider="mssql" ckieless="false" timeut="20"> 3. Update the sessinstate sectin by adding the SQL Server prvider as shwn in the fllwing example. Als, change the name attribute value t mssql: <sessinstate mde="custm" custmprvider="mssql" ckieless="false" timeut="20"> <prviders> <add name="mssql" type=" Sitecre.SessinPrvider.Sql.SqlSessinStatePrvider, Sitecre.SessinPrvider.Sql" cnnectinstringname="sessin" pllinginterval="2" cmpressin="true" sessintype="private"/> </prviders> </sessinstate> Cnfiguratin ptins: Setting cnnectinstringname Fr example: cnnectinstringname="sessin" Plling interval Fr example: pllinginterval="2" Cmpressin Fr example: cmpressin="true" /> sessintype Descriptin Edit the cnnectin string s that the sessin prvider cnnects t the SQL Server database that yu want t use. In the xdb this database is called sessin. This is the time interval in secnds that the sessin stre prvider uses t check if any sessins have expired. This setting is a Blean flag that indicates whether t cmpress sessin state data r nt. The default value is true Cmpressing sessin state data reduces the amunt f data that yu need t transfer between the database and the Sitecre instance. This may cause sme additinal CPU verhead. This value must be set either t private r shared. Fr example: sessintype="private" Page 38 f 57

39 xdb Cnfiguratin Guide 2.8 Cnfiguring Shared Sessin State The shared sessin state stre hlds data that can be shared by multiple sessins, such as data related t cntacts and devices. Yu must always cnfigure shared sessin state whatever yur server cnfiguratin. Fr example, yu culd have a single standalne cntent delivery server, multiple cntent delivery servers, r a clustered envirnment but yu always need t cnfigure sessin state. Shared sessin state is nt supprted n cntent management servers. On cntent delivery servers shared sessin state must supprt the SessinEnd event. A cntact can make multiple parallel visits t a web site in which case each visit will have its wn private sessin state. Hwever, sme data may be shared between visits such as device and cntact related infrmatin. Infrmatin that may be shared between parallel visits f the same cntact is stred in shared sessin state. This data is still private t the cntact but it is accessible frm all current sessins made by the same cntact. Yu can use either the Sitecre MngDB r Sitecre SQL Server prviders t cnfigure yur shared sessin state stre. Bth these prviders supprt the SessinEnd event, which the xdb needs t track website visits. The standard SQL Server sessin state prvider that is shipped with ASP.NET des nt supprt the SessinEnd event s cannt be used with the xdb. Yu can cnfigure shared sessin state t use any sessin state stre prvider that extends the abstract class SessinStateStrePrviderBase (shipped with ASP.NET). The nly additinal requirement is that the sessin state stre prvider can invke the SessinEnd event via SessinStateItemExpireCallback Cnfiguring the MngDB Sessin State Prvider Fllw the steps in this sectin t use a MngDB database as yur shared sessin state stre using the Sitecre ASP.NET Sessin State Prvider fr MngDB. Deplying the MngDB Sessin Database T cnfigure the Sitecre ASP.NET Sessin State Prvider fr MngDB: 1. Install MngDB database server versin 2.6 r later. We recmmend that yu install this n a dedicated server. 2. Cnfigure Sitecre t use the Sitecre ASP.NET Sessin State Prvider fr MngDB (see the instructins in this sectin). Cnfiguring Sitecre T cnfigure the Shared Sessin State Prvider fr MngDB: 1. Open the CnnectinStrings.cnfig file lcated here <sitename>\website\app_cnfig and add the fllwing cnnectin string: <add name="sharedsessin" cnnectinstring="mngdb://_mng_server_name:_prt_number/_sessin_database_name" /> 2. In yur website rt flder, navigate t: Website\App_Cnfig\Include Page 39 f 57

40 Sitecre Open the Sitecre.Analytics.Tracking.cnfig file. 4. Lcate the line where yu have defined the default shared sessin state prvider. Navigate t the fllwing path: sitecre/tracking/sharedsessinstate. 5. The default shared sessin stre uses inprc prvider (string data in memry and implemented in the internal ASP.NET class InPrcSessinStateStre): <sharedsessinstate defaultprvider="inprc"> <prviders> <clear/> <add name="inprc" type="system.web.sessinstate.inprcsessinstatestre" /> </prviders> Fr clustered envirnments, Sitecre ships with a MngDB sessin state stre prvider. 6. In Sitecre.Analytics.Tracking.cnfig file, update the sessinstate sectin as fllws T cnfigure MngDB as yur shared sessin state stre prvider change the defaultprvider frm inprc t mng. Als, change the name attribute value t mng. <sharedsessinstate defaultprvider="mng"> <prviders> <clear/> <add name="mng" type="sitecre.sessinprvider.mngdb.mngsessinstateprvider, Sitecre.SessinPrvider.MngDB" cnnectinstringname="sharedsessin" pllinginterval="2" cmpressin="true" sessintype="shared"/> </prviders> Cnfiguratin ptins: Setting cnnectinstringname Fr example: cnnectinstringname="sharedsessin" Plling interval Fr example: pllinginterval="2" Cmpressin Fr example: cmpressin="true" /> sessintype Fr example: sessintype="shared" Descriptin Edit the cnnectin string s that the sessin prvider cnnects t the MngDB database that yu want t use. In the xdb this database is called sessin. This is the time interval in secnds that the sessin stre prvider uses t check if any sessins have expired. This setting is a Blean flag that indicates whether t cmpress sessin state data r nt. The default value is true. Cmpressing sessin state data reduces the amunt f data that yu need t transfer between the database and the Sitecre instance. This may cause sme additinal CPU verhead. This value must be set either t private r shared. Page 40 f 57

41 xdb Cnfiguratin Guide Cnfiguring the SQL Server Sessin State Prvider Fllw the steps in this sectin t use a SQL Server database as yur shared sessin state stre using the Sitecre ASP.NET Sessin State Prvider fr SQL Server. Deplying the SQL Server Sessin Database 1. Use Micrsft SQL Server Management Studi 2012 r later t deply yur shared sessin stre database. Fr mre detailed instructins, see Deplying the SQL Server Sessin Database. 2. Prvide an apprpriate name fr yur sessin database. Fr example, sharedsessin. Cnfiguring Sitecre T cnfigure the shared sessin state prvider fr SQL Server: 1. Add the fllwing cnnectin string t CnnectinStrings.cnfig: <add name="sharedsessin" cnnectinstring="user id=_sql_server_user_;passwrd=_user_passwrd_;data Surce=_sqlserver_;Database = _sharedsessin_database_name_"/> 2. In yur website rt flder, navigate t: Website\App_Cnfig\Include 3. Open the Sitecre.Analytics.Tracking.cnfig file. 4. Lcate the line where yu have defined the default shared sessin state prvider. Navigate t the fllwing path: sitecre/tracking/sharedsessinstate. 5. T cnfigure SQL Server as yur shared sessin state stre prvider change the defaultprvider frm inprc t mssql. Als, change the name attribute value t mssql. <sharedsessinstate defaultprvider="mssql"> <prviders> <clear/> <add name="mssql" type="sitecre.sessinprvider.sql.sqlsessinstateprvider,sitecre.sessinprv ider.sql" cnnectinstringname="sharedsessin" pllinginterval="2" cmpressin="true" sessintype="shared"/> </prviders> Cnfiguratin ptins: Setting cnnectinstringname Fr example: cnnectinstringname="sharedsessin" Plling interval Fr example: pllinginterval="2" Descriptin Edit the cnnectin string s that the sessin prvider cnnects t the SQL Server database that yu want t use. In the xdb this database is called sharedsessin. This is the time interval in secnds that the sessin stre prvider uses t check if any sessins have expired. Page 41 f 57

42 Sitecre 7.5 Setting Cmpressin Fr example: cmpressin="true" /> sessintype Fr example: sessintype="shared" Descriptin This setting is a Blean flag that indicates whether t cmpress sessin state data r nt. The default value is true Cmpressing sessin state data reduces the amunt f data that yu need t transfer between the database and the Sitecre instance. This may cause sme additinal CPU verhead. This value must be set either t private r shared. Fr mre infrmatin n sessin state, see the xdb Overview and Architecture dcument. Page 42 f 57

43 xdb Cnfiguratin Guide 2.9 Clustered Envirnment Overview A clustered envirnment cnsists f a cllectin f dedicated servers gruped tgether t imprve scalability. Fr example, yu culd create multiple cntent delivery clusters t enable hrizntal scaling with the aim f increasing strage capacity and imprving perfrmance. Each cluster culd cntain tw r mre cntent delivery instances, each with its wn dedicated sessin state server. Yu culd als grup clusters tgether in the same lcatin r spread them acrss different gegraphical lcatins. In a clustered envirnment, the same cluster f web servers shuld serve all the visits fr a single cntact. This ensures that all visits have fast access t the current state f the cntact. If a single cntact pens multiple cncurrent sessins frm different brwsers r devices then the xdb ensures that each sessin sticks t the same cluster. A cntact can nly mve t anther cluster nce they end all their current pen sessins and start a new ne r when the sessin expires. T ensure that cntacts stick t the same cluster (as mentined abve) each cluster shuld have a shared sessin state server, as shwn in the fllwing diagram. In this diagram, Device 1 is the first device the cntact uses t cnnect t the website. This sessin is still active when the same cntact begins a secnd parallel visit using Device 2. When a cntact recrd is laded int the shared sessin state f a cluster, the cllectin database lcks it and allcates it t the current cluster. This ensures that a cntact recrd is nt laded int tw clusters at the same time. Fr mre detailed infrmatin n creating clustered envirnments, see the Sitecre scaling dcumentatin n SDN. Page 43 f 57

44 Sitecre 7.5 Chapter 3 Clud Cnfiguratin Optins Yu can deply Sitecre partly r entirely in the clud. This chapter utlines sme f the advantages and disadvantages f using the clud and hw yu shuld apprach making yur first clud deplyment. This chapter cntains the fllwing sectins: Clud Server Slutins Page 44 f 57

45 xdb Cnfiguratin Guide 3.1 Clud Server Slutins Yu can chse t install Sitecre xdb as an entirely n-premise slutin, a partly n-premise slutin, partly in the clud (hybrid) r entirely in the clud. Sitecre xdb Clud Editin is a service that enables yu t run Sitecre xdb entirely in the clud. This includes the fllwing: Sitecre applicatin servers fr prcessing, aggregatin and reprting. Micrsft SQL Server reprting database MngDB cllectin database The fllwing table summarizes the n-premise and clud slutin ptins fr Sitecre xdb and hw they can be cmbined: Available xdb n-premises xdb Clud Editin Sitecre CEP 7.2 (n-premises) N N Sitecre XP 7.5 (n-premises) Yes Yes Sitecre XP 7.5 (deplyed using Sitecre Azure 7.5) N Yes There are several ther clud fferings currently available t chse frm, each with their wn set f advantages and disadvantages. Think carefully befre chsing a clud platfrm ther than Sitecre. Other current fferings include Rackspace, and Amazn Web Services (AWS) that bth ffer public clud cmputing services fr a fee. Benefits f using Sitecre xdb Clud Editin: Pwerful, scalable, and fully managed saves the cst f acquiring, cnfiguring, and maintaining the infrastructure t supprt xdb n the premises. Easy t cnnect t, simple t set up and use. Lw cst. Highly available and backed by SLA guarantees. Glbally available. Easy t increase the number f servers. Available fr prductin and nn-prductin usage. Nn-prductin instances are prvided fr develpment and testing. Fr mre infrmatin n using the Sitecre xdb Clud Editin, see xdb Clud Quick Start Guide n SDN r cntact yur lcal Sitecre ffice. Page 45 f 57

46 Sitecre 7.5 Chapter 4 Custmizatin This chapter explains the steps yu need t fllw t create and implement a custm aggregatin pipeline. This chapter includes the fllwing sectins: Creating a Custm Aggregatin Fact and Dimensin Tables Creating Dimensin Tables Implementing Mdel Classes Implementing the Aggregatin Prcessr Example Custm Aggregatin Page 46 f 57

47 xdb Cnfiguratin Guide 4.1 Creating a Custm Aggregatin In the xdb, aggregatin describes a type f prcessing that reduces and adapts data frm the cllectin database (MngDB) s that it can be stred in the reprting database (SQL Server). Aggregated cllectin data is then made available t reprting applicatins such as the Executive Insight Dashbard and Engagement Analytics reprts. Ideally, the aggregatin server shuld be a dedicated Sitecre CMS server with the client remved. Yu can create yur wn custm aggregatins by extending the aggregatin pipeline, fr example yu culd create a custm aggregatin fr website visitrs t rate blg psts by adding their wn star ratings. This example is described in Sectin 4.5 Example Custm Aggregatin. The purpse f this dcument is t describe the general steps required t implement a new aggregatin prcessr. Summary f steps: Create the required database tables Create the stred prcedures (ptinal) Implement the mdel classes Implement and cnfigure the pipeline Implement a script builder (ptinal) Page 47 f 57

48 Sitecre Fact and Dimensin Tables Fact tables cntain the measurements and metrics f the prcess yu are mnitring. Metrics culd be the engagement value accumulated during a visit r the number f events generated during a page request. When creating reprts, it is ften necessary t investigate and cmpare facts with different attributes. Fr example, cmpare the perfrmance f a campaign ver the last few mnths with its current perfrmance. The attributes used in this example are the mnths and the campaign. These allw us t filter ut the tw sets f facts we want t cmpare with each ther. If the strage requirements f an attribute are large r it is repeated fr many visits, we may chse t put it int a separate table. These separate tables are referred t as dimensins. There is a fact table fr each reprt, and each fact table can have zer r mre dimensin tables cnnected t it. This means that if yu create a new reprt, yu typically need t create a new fact table t supprt it. See the sectin Creating Fact Tables fr the script yu need t create fact tables. Dimensin tables can be shared amng fact tables. This means that if tw fact tables include the same Item ID attribute, they can bth refer t the same Items dimensin. Decide if yu need t create any new dimensin tables and if s, first check whether they are already present. The mst cmmn dimensin tables are already defined in the reprting database alng with the fact tables. The stred prcedures and the mdel classes fr these may als be present already. The mst cmmn dimensin tables are: Site Names Device Names Languages Campaigns Items Keywrds Referring Sites When yu have decided which fact and dimensin tables yu need fr yur custm aggregatins, then create a script fr each fact and dimensin table which shuld be placed in its wn.sql file Creating Fact Tables The fllwing SQL script shws hw t define a fact table: CREATE TABLE [Fact_Name] ( [K1] DATATYPE NOT NULL, [K2] DATATYPE NOT NULL, [Kn] DATATYPE NOT NULL, [V1] DATATYPE NOT NULL, [V2] DATATYPE NOT NULL, [Vn] DATATYPE NOT NULL, CONSTRAINT [PK_Fact_Name] PRIMARY KEY CLUSTERED ([K1], [K2], [Kn]), CONSTRAINT [FK_Fact_Name_K1] FOREIGN KEY ([K1]) REFERENCES [DimensinName] ([K1]), CONSTRAINT [FK_Fact_Name_Kn] FOREIGN KEY ([Kn]) REFERENCES [DimensinName] ([K2]) ); ALTER TABLE [Fact_TableName] NOCHECK CONSTRAINT [FK_Fact_Name_K1]; ALTER TABLE [Fact_TableName] NOCHECK CONSTRAINT [FK_Fact_Name_Kn]; CREATE NONCLUSTERED INDEX [IX_ByK1] ON [Fact_TableName]( [K1] ); Page 48 f 57

49 xdb Cnfiguratin Guide We recmmend that yu create all freign key cnstraints t make dependencies between tables visible, but we als recmmend that yu disable them t imprve perfrmance. Micrsft SQL Server has a limitatin f 900 bytes fr indices, s if the strage requirements f the data in the key clumns exceeds 900 bytes, n primary key can be defined n the table. This is nt a serius prblem fr fact tables, but it can affect perfrmance under certain cnditins. A pssible slutin is t extract parts f the key int dimensin tables. A primary key may be clustered r nn-clustered. A clustered index defines the physical rder f rws in the table. If n physical rder is defined, the table is referred t as a heap. The rder in which the clumns are listed in the cnstraint des matter. As a rule f thumb, put the clumn with the highest selectivity first and the ne with the lwest selectivity last Creating Dimensin Tables Dimensin tables are usually simpler than fact tables. Use the fllwing template fr creating dimensin tables: CREATE TABLE [DimensinName] ( [K1] DATATYPE NOT NULL, [Kn] DATATYPE NOT NULL, [A1] DATATYPE NOT NULL, [An] DATATYPE NOT NULL, CONSTRAINT [PK_DimensinName] PRIMARY KEY CLUSTERED ( [K1], [Kn] ) ); Dimensin tables mst ften cntain simple key-value pairs with a single key clumn and a single attribute clumn. Page 49 f 57

50 Sitecre Implementing Mdel Classes Bth fact and dimensin tables cnsist f ne r mre key values and ne r mre aggregated values. The diagram belw shws the classes alng with the base classes that represent the in memry mdel fr the Traffic fact and the Items dimensin. Implementing a Dimensin Mdel Class T implement a mdel class fr a new dimensin: 1. Create a new class that inherits frm the Sitecre.Analytics.Aggregatin.Data.Mdel.DictinaryKey class (Sitecre.Analytics.Aggregatin.dll). 2. Expse all key fields as public prperties (get and set). 3. Create a new class that inherits frm the Sitecre.Analytics.Aggregatin.Data.Mdel.DictinaryValue class (Sitecre.Analytics.Aggregatin.dll). 4. Add the required prperties. 5. Bth the key and the value class must have a public default cnstructr. 6. Create a new class that inherits frm the Sitecre.Analytics.Aggregatin.Data.Mdel.Dimensin<TKey, TValue> class (Sitecre.Analytics.Aggregatin.dll), with a public default cnstructr. Implementing a Fact Mdel Class Implementing the class mdel fr a fact is very similar t implementing the class mdel fr a dimensin. T implement a mdel class fr a new fact: 1. Create a new class that inherits frm the DictinaryKey class. 2. Expse all key fields as public prperties (get and set). 3. Create a new class that inherits frm the DictinaryValue class. 4. Add the required prperties. 5. Bth the key and the value class must have a public default cnstructr. Page 50 f 57

51 xdb Cnfiguratin Guide 6. Create a new class that inherits frm the Sitecre.Analytics.Aggregatin.Data.Mdel.Fact<TKey, TValue> class (Sitecre.Analytics.Aggregatin.dll), with a public default cnstructr. The cnstructr f the base class takes a delegate as the ne and nly argument. This methd is called whenever tw values need t be aggregated. Sample implementatin: internal static TrafficValue Reduce(TrafficValue left, TrafficValue right) { TrafficValue result = new TrafficValue(); result.visits = (left.visits + right.visits); result.value = (left.value + right.value); return result; } All prperty types expsed by the key class r the value class need t be serializable. If they are nt then yu need t verride the GetHashCde() and Equals() methds. Page 51 f 57

52 Sitecre Implementing the Aggregatin Prcessr Fllw these steps t implement the aggregatin prcessr: 1. Create a class that inherits frm the Sitecre.Analytics.Aggregatin.Pipeline.AggregatinPrcessr base class (Sitecre.Analytics.Aggregatin.dll). 2. Override the Prcess(AggregatinPipelineArgs args) methd. The args parameter prvides access t the interactin t be prcessed and t all dimensins and all facts. The interactin can be accessed via the Cntext prperty. Dimensins and facts can be accessed via the fllwing methds: MyFact fact = args.getfact<myfact>(); MyDimensin dimensin = args.getdimensin<mydimensin>(); 3. Implement the lgic that extracts the infrmatin frm the aggregatin cntext (the visit in the example abve) and ppulate the fact and dimensins. 4. Register yur prcessr in the Sitecre.Analytics.Prcessing.Aggregatin.cnfig file. The fllwing example shws where yu add yur wn prcessr in the aggregatin cnfiguratin file: <cnfiguratin xmlns:patch=" <sitecre> <pipelines> <grup grupname="analytics.aggregatin"> <pipelines> <interactins> <prcessr type="mynamespace.myprcessr, MyAssembly" /> </interactins> </pipelines> </grup> </pipelines> </sitecre> </cnfiguratin> Page 52 f 57

53 xdb Cnfiguratin Guide 4.5 Example Custm Aggregatin There are several aggregatins that cme with Sitecre and that wrk ut f the bx. These are used by the Executive Insight Dashbard and ther cmpnents in Sitecre. If yu add new functinality t yur website which requires yu t extract and present data frm the xdb in a different way, then yu can write yur wn custm aggregatin. We recmmend that yu fllw this apprach if the data that yu want t extract is frm a high number f interactins r if the extractin prcess is relatively resurce intensive Overview In this chapter yu will learn hw t create a custm aggregatin using an example develped fr the sitecre.net website. On the sitecre.net website, visitrs can rate blg psts by adding their wn star ratings. Rating data can then be used t srt and search thrugh psts. After yu have implemented this custm aggregatin yu can add the additinal ptin t search blgs by ppularity. Page 53 f 57