Version 8.2.1
Administrator's Guide Administrator'
Copyright
Copyright Unica 2010. Unica, an IBM Company Reservoir Place North 170 Tracer Lane Waltham, MA 02451-1379
Table of Contents
Preface Contacting Unica technical support............................................................................................ 28 1 Introduction to Unica NetInsight .................................................................................. 30 ..................................................................................30
About Unica NetInsight ....................................................................................................................... 30 About data collection methods............................................................................................................ 30 The stages of Web site tracking ......................................................................................................... 32 About Unica NetInsight reports........................................................................................................... 32 About profiles ...................................................................................................................................... 35
To change your default view and reporting mode for a profile ......................................................49
To define a custom log file format................................................................................................... 73 About fields in custom log format definitions ..................................................................................73 About dates in custom log format definitions ..................................................................................76 About tab-delimited fields in custom log format definitions.............................................................78 About log files on FTP servers ........................................................................................................... 78 To specify the date format of your log files.........................................................................................79 To process only data for the configured site.......................................................................................79 To select a time zone for a new profile............................................................................................... 79 To stop conversion of dates and times in W3C log files ....................................................................80
Version 8.2.1
About using custom dimensions ..................................................................................................... 95 Constructing the dimension name-value pair..............................................................................95 Passing multiple values............................................................................................................... 95 Planning your custom dimensions .............................................................................................. 96 Adding a dimension to a tag ........................................................................................................... 96 Including cookie data in page tag requests ........................................................................................98 About including cookie data in page tag requests ..........................................................................98 About visitor identification cookies .................................................................................................. 98 To capture data from additional cookies......................................................................................... 98 Tagging events ................................................................................................................................... 99 What is an event? ........................................................................................................................... 99 About event tagging ...................................................................................................................... 100 Tracking an event as a page view ................................................................................................ 100 Ensuring link and submit page tag requests are submitted before the page unloads..................101 To tag JavaScript or AJAX events ................................................................................................102 To tag events in Flash 8 or greater............................................................................................... 102 Flash page tagging examples ....................................................................................................... 103 Marking link tags as links to an external site ................................................................................105 Sending visit-level data when an event occurs.............................................................................105 Tagging retail activity ........................................................................................................................ 105 About retail activity........................................................................................................................ 105 Tagging product views .................................................................................................................. 106 Tagging additions to a shopping cart............................................................................................107 Tagging removals from a shopping cart .......................................................................................108 Tagging the checkout process ...................................................................................................... 108 Retail page tag parameters summary........................................................................................... 109 Retail metrics ................................................................................................................................ 109 Differences between Product Revenue and Revenue ..............................................................111 Tagging applications and widgets..................................................................................................... 111 About tagging applications and widgets .......................................................................................111 Anatomy of a direct tag................................................................................................................. 112 Best practices for direct tags ........................................................................................................ 112 About the lc parameter.................................................................................................................. 112 When NOT to pass the lc parameter ............................................................................................ 113
Where to place your direct tags .................................................................................................... 113 Minimizing the number of tags...................................................................................................... 113 Reference ......................................................................................................................................... 114 Introduction ................................................................................................................................... 114 Required variables ........................................................................................................................ 114 About required variables ........................................................................................................... 114 NTPT_IMGSRC......................................................................................................................... 114 NTPT_SET_SESSION_COOKIE............................................................................................... 115 NTPT_FIELDS .......................................................................................................................... 115 NTPT_MAXTAGWAIT ............................................................................................................... 116 Optional global variables............................................................................................................... 116 About optional global variables ................................................................................................. 117 NTPT_HTTPSIMGSRC ............................................................................................................. 117 NTPT_GLBLEXTRA .................................................................................................................. 117 NTPT_GLBLREFTOP ............................................................................................................... 117 NTPT_GLBLCOOKIES ............................................................................................................. 118 NTPT_SET_IDCOOKIE............................................................................................................. 118 NTPT_IDCOOKIE_NAME ......................................................................................................... 118 NTPT_IDCOOKIE_EXPIRE ...................................................................................................... 118 NTPT_IDCOOKIE_DOMAIN .................................................................................................... 119 NTPT_SESSION_COOKIE_NAME ........................................................................................... 119 NTPT_SET_SESSION_COOKIE............................................................................................... 120 Page-specific variables ................................................................................................................. 120 About page-specific variables ................................................................................................... 120 Where to put page-specific variables........................................................................................120 NTPT_PGEXTRA ...................................................................................................................... 120 NTPT_PGREFTOP ................................................................................................................... 121 NTPT_NOINITIALTAG .............................................................................................................. 121 NTPT_PGCOOKIES ................................................................................................................. 121 Event tagging functions................................................................................................................. 122 ntptAddPair ............................................................................................................................... 122 ntptDropPair .............................................................................................................................. 122 ntptEventTag............................................................................................................................. 123 ntptLinkTag ............................................................................................................................... 123
Version 8.2.1
Specifying the date range of pre-generated reports .........................................................................142 About report generation options.................................................................................................... 142 About aggregate data ................................................................................................................... 143 To edit dates for which reports are pre-calculated .......................................................................143 To edit dates for which aggregate data is generated ...................................................................144 Specifying reportability of dimensions .............................................................................................. 144 About reportable dimensions ........................................................................................................ 144 To change reportable dimensions................................................................................................. 144 Specifying the sample size ............................................................................................................... 145 About data samples ...................................................................................................................... 145 To specify the sample size ........................................................................................................... 146 Permissions for sampling features................................................................................................ 147
Version 8.2.1
To specify a fixed time frame using the calendar .........................................................................166 To specify a relative or fixed time frame using a date filter ..........................................................167 Specifying dimensions ...................................................................................................................... 168 About dimensions ......................................................................................................................... 168 To specify dimensions for a report in the Custom Report Wizard ................................................168 Specifying metrics............................................................................................................................. 169 About metrics ................................................................................................................................ 169 To specify metrics for a report in the Custom Report Wizard.......................................................169 To add a metric through the Discovery Panel ..............................................................................170 Creating an A/B report ...................................................................................................................... 171 About A/B reports.......................................................................................................................... 171 To create an A/B report through the Discovery Panel ..................................................................173 To create an A/B report using the Custom Report Wizard ...........................................................174 Creating a comparative report .......................................................................................................... 175 About comparative reports............................................................................................................ 175 To create a comparative report..................................................................................................... 176 To save a customized report ............................................................................................................ 176 Changing the content of a report ...................................................................................................... 177 To edit a report using the Report Summary page ........................................................................178 To display axis labels for dashboard reports ................................................................................178
10
To delete an email task............................................................................................................. 186 To execute an email task.............................................................................................................. 186 To execute an email task .......................................................................................................... 186 To execute an email task from the command line ....................................................................186 To execute all email tasks from the command line...................................................................187 To create an email alert ................................................................................................................ 188 To create an email alert ............................................................................................................ 188 To modify filters for an email alert.............................................................................................189 To test an email alert ................................................................................................................ 190 To edit an email alert ................................................................................................................ 190 To delete an email alert ............................................................................................................ 190 To execute an email alert ............................................................................................................. 191 To execute an email alert.......................................................................................................... 191 To execute an email alert from the command line....................................................................191 To execute all email alerts from the command line ..................................................................191 About scheduling email tasks and email alerts.............................................................................192 To export a report as a file................................................................................................................ 193 Working with portlets......................................................................................................................... 194 About portlets ................................................................................................................................ 194 To export a report as a portlet ...................................................................................................... 195 Working with group selections .......................................................................................................... 196 About group selections ................................................................................................................. 196 To open or close the Selected Groups panel ...............................................................................197 To add groups to a group selection .............................................................................................. 198 To modify a group selection.......................................................................................................... 198 To save a group selection............................................................................................................. 199 To use a group selection in Unica Campaign...............................................................................200
Version 8.2.1
11
Analyzing content groups ................................................................................................................. 205 About analyzing content groups.................................................................................................... 205 To create a content group............................................................................................................. 206 About determining the content group for files that fit multiple groups ..........................................206 Analyzing indexes ............................................................................................................................. 206 About specifying directory indexes ............................................................................................... 207 To add a directory index ............................................................................................................... 207 Analyzing links .................................................................................................................................. 208 About analyzing links .................................................................................................................... 208 About analyzing links using a redirect program ............................................................................208 About moving ntlinktrack to a CGI-accessible directory ...............................................................208 To redirect all external links .......................................................................................................... 209 About analyzing links using page tags.......................................................................................... 209 About enabling the link summary.................................................................................................. 210 To configure link options ............................................................................................................... 210 Analyzing keywords .......................................................................................................................... 211 About analyzing local keywords.................................................................................................... 211 To configure local keyword options .............................................................................................. 211 To include specific redirection scripts in the reports.........................................................................212
12
About parameters ......................................................................................................................... 219 About parameter types.................................................................................................................. 220 To define a parameter................................................................................................................... 223 To delete a parameter................................................................................................................... 225 To edit a parameter....................................................................................................................... 226 Replacing or deleting characters in URLs ........................................................................................226 About replacing or deleting characters in URLs ...........................................................................226 To replace or delete characters in the URLs in your reports........................................................229 To delete a search and replace rule .............................................................................................230 To edit a search and replace rule ................................................................................................. 230 Examples ...................................................................................................................................... 231
Version 8.2.1
13
To specify referrers for a rule........................................................................................................ 249 To specify an excluded URL for a keyword rule ...........................................................................249 To specify a character set parameter for the keyword rule ..........................................................250 Keyword parsing example............................................................................................................. 251 Analyzing referrers............................................................................................................................ 251 About analyzing referrers.............................................................................................................. 251 To create a referrer group............................................................................................................. 252 To add referrers to a referrer group .............................................................................................. 252 Determining the group for referrers that fit multiple groups ..........................................................253 Analyzing visits from indexing agents............................................................................................... 253 About analyzing visits from indexing agents.................................................................................253 To classify a host, user agent, or referrer as a robot or spider ....................................................253 To add visitors to a robot/spider group .........................................................................................254 Determining the group for visitors that fit multiple groups ............................................................254 Analyzing visit cost ........................................................................................................................... 254 About visit cost.............................................................................................................................. 255 About collecting visit cost data...................................................................................................... 255 About including visit cost data in Unica NetInsight reports...........................................................255
14
What retail data Unica NetInsight can gather ...................................................................................262 Retail reports..................................................................................................................................... 263 About retail reports........................................................................................................................ 263 About enabling retail reports ......................................................................................................... 263
Version 8.2.1
15
16
Configuring security .......................................................................................................................... 291 To specify the internal database as the authentication method ...................................................291 To specify the Unica Marketing Platform as the authentication method ......................................292 To specify LDAP as the authentication method............................................................................292 To specify the Web Server as the authentication method ............................................................293 Configuring roles and users.............................................................................................................. 294 To create a role............................................................................................................................. 294 To copy a role ............................................................................................................................... 295 To assign or edit privileges for a role............................................................................................295 To edit a role ................................................................................................................................. 296 To delete a role ............................................................................................................................. 296 To create a user manager ............................................................................................................ 297 To create a user............................................................................................................................ 297 To modify a user ........................................................................................................................... 298 To specify a user's profile settings................................................................................................299 To delete a user ............................................................................................................................ 300 About customizing the NetInsight interface ......................................................................................300 About profile views........................................................................................................................ 300 About dimension lists .................................................................................................................... 301 About filter lists.............................................................................................................................. 301 About metric lists........................................................................................................................... 301 About the profile default role, view, and reporting mode ..............................................................302 About role default view settings .................................................................................................... 302 Working with views ........................................................................................................................... 302 To create a profile view................................................................................................................. 302 To edit a profile view..................................................................................................................... 303 To copy a profile view ................................................................................................................... 304 To delete a profile view................................................................................................................. 304 To change to another profile view................................................................................................. 304 About accessing a profile view through a URL.............................................................................305 Working with roles and views ........................................................................................................... 305 To set the default role, view, and reporting mode for a profile ....................................................305 To set a new role default view ...................................................................................................... 306 To edit a role default view setting ................................................................................................. 306
Version 8.2.1
17
To delete a role default view setting .............................................................................................307 Working with report lists.................................................................................................................... 307 To create a report list.................................................................................................................... 307 To edit a report list ........................................................................................................................ 308 To copy a report list ...................................................................................................................... 308 To manage folders for a report list................................................................................................ 309 To delete a report list .................................................................................................................... 310 Working with dimension lists............................................................................................................. 310 To create a dimension list............................................................................................................. 310 To edit a dimension list ................................................................................................................. 311 To copy a dimension list ............................................................................................................... 311 To manage groups for a dimension list......................................................................................... 312 To delete a dimension list ............................................................................................................. 312 Working with filter lists ...................................................................................................................... 313 To create a filter list ...................................................................................................................... 313 To edit a filter list........................................................................................................................... 313 To copy a filter list......................................................................................................................... 314 To manage groups for a filter list .................................................................................................. 314 To delete a filter list....................................................................................................................... 315 Working with metric lists ................................................................................................................... 315 To create a metric list ................................................................................................................... 316 To edit a metric list........................................................................................................................ 316 To copy a metric list...................................................................................................................... 316 To manage groups for a metric list ............................................................................................... 317 To delete a metric list.................................................................................................................... 318 About default profile options ............................................................................................................. 318 Data and license administration........................................................................................................ 318 To set profile defaults.................................................................................................................... 318 To upgrade your license ............................................................................................................... 319 To back up and restore Unica NetInsight data .............................................................................319 To move Unica NetInsight to another computer ...........................................................................320 To move Unica NetInsight to another computer without reimporting log file data ........................320 Troubleshooting NetInsight ............................................................................................................... 321 About Unica NetInsight system logs .............................................................................................321
18
To configure Unica NetInsight system logs ..................................................................................322 About the Unica NetInsight process log........................................................................................ 323
About user-defined processes .......................................................................................................... 354 How Unica NetInsight runs user-defined processes.........................................................................355 To configure Unica NetInsight to run a user-defined process ..........................................................355 About the <userdefinedprocesses> and <process> elements .........................................................356 Creating generic processes for multiple profiles...............................................................................357 User-defined process examples ....................................................................................................... 357 User-defined processes and database permissions.........................................................................359
20
-module ......................................................................................................................................... 375 -quiet ............................................................................................................................................. 376 -reaggregate.................................................................................................................................. 376 -reanalyze ..................................................................................................................................... 377 -recalc ........................................................................................................................................... 377 -recipients list ................................................................................................................................ 378 -regen............................................................................................................................................ 379 -reindex ......................................................................................................................................... 379 -reindex-missing............................................................................................................................ 379 -remove YYYYMM or YYYYMMDD .............................................................................................. 379 -remove YYYYMM,YYYYMM........................................................................................................ 380 -reports.......................................................................................................................................... 380 -reprofile ........................................................................................................................................ 381 -resample ..................................................................................................................................... 381 -reseed seed_number ................................................................................................................... 381 -resolvetitles .................................................................................................................................. 382 -samplecalc entity number ............................................................................................................ 382 -update .......................................................................................................................................... 382 Administrative command-line options ............................................................................................... 383 -add ............................................................................................................................................... 383 -addlang pathname_for_language_pack .......................................................................................385 -adduser user_name [-email emailaddress] [-fullname fullname] [-password password] [-role role] [-reportingmode reportingmode] ................................................................................................... 386 -assignuser user_name short_profile_name {[-role role_name] | [-view view_name]} ..................387 -changeuser user_name [-email emailaddress] [-fullname fullname] [-password password] [-role role] [-reportingmode reportingmode] ........................................................................................... 388 -clear ............................................................................................................................................. 389 -dbpasswd..................................................................................................................................... 389 -delete short_profile_name............................................................................................................ 390 -deleteuser user_name ................................................................................................................. 390 -dir dir............................................................................................................................................ 390 -list or -list %regex ........................................................................................................................ 391 -listroles......................................................................................................................................... 391 -listusers short_profile_name [-explicit] .........................................................................................391 -quiet ............................................................................................................................................. 392 Version 8.2.1 21
22
logformats ..................................................................................................................................... 405 loginexpiration ............................................................................................................................... 405 mailfrom ........................................................................................................................................ 406 mailserver...................................................................................................................................... 406 maxcache...................................................................................................................................... 406 maxcompletedperuser................................................................................................................... 407 maxdnsrequests............................................................................................................................ 407 maxqueuedlines ............................................................................................................................ 408 maxrunningglobal.......................................................................................................................... 408 maxrunningperuser ....................................................................................................................... 408 method .......................................................................................................................................... 409 network.......................................................................................................................................... 409 pagesize........................................................................................................................................ 409 passiveftp ...................................................................................................................................... 410 pathsep ......................................................................................................................................... 410 platform ......................................................................................................................................... 410 plugin............................................................................................................................................. 411 processlog element....................................................................................................................... 411 progdir ........................................................................................................................................... 411 reportinbox .................................................................................................................................... 411 reportlimits..................................................................................................................................... 412 reportsduringimport ....................................................................................................................... 412 reportsduringupdate ...................................................................................................................... 413 restrictprofilemanager ................................................................................................................... 413 resultsetretention........................................................................................................................... 413 runreportscheduler ........................................................................................................................ 414 secure ........................................................................................................................................... 414 serialnumber ................................................................................................................................. 414 source ........................................................................................................................................... 415 syncmode...................................................................................................................................... 415 tempstore ...................................................................................................................................... 415 tempstoredir .................................................................................................................................. 416 titleresolutiontimeout ..................................................................................................................... 416 Web.cfg : Global Profile Configuration File ......................................................................................416
Version 8.2.1
23
About the global profile configuration file......................................................................................419 aggdeffile....................................................................................................................................... 419 aggsrequired ................................................................................................................................. 420 bannerads ..................................................................................................................................... 420 browsers........................................................................................................................................ 420 campaigns..................................................................................................................................... 421 casesensitivepages....................................................................................................................... 422 casesensitiveusernames............................................................................................................... 422 connection..................................................................................................................................... 422 contentgroups ............................................................................................................................... 423 converttimes.................................................................................................................................. 423 cookielookup ................................................................................................................................. 424 custommetrics ............................................................................................................................... 424 dashboardsize............................................................................................................................... 426 daterange ...................................................................................................................................... 426 defaults.......................................................................................................................................... 426 departments .................................................................................................................................. 427 dimensionlists................................................................................................................................ 428 dimensionsfile ............................................................................................................................... 429 dirindexes...................................................................................................................................... 429 dmpackages.................................................................................................................................. 429 donotconverttimes......................................................................................................................... 430 dynamicpages ............................................................................................................................... 430 element ......................................................................................................................................... 431 emailalerts..................................................................................................................................... 431 emailtasks ..................................................................................................................................... 433 entity.............................................................................................................................................. 435 excludedagents ............................................................................................................................. 435 excludedhosts ............................................................................................................................... 436 excludedpages .............................................................................................................................. 436 excludedparametervalues ............................................................................................................. 437 excludedusers ............................................................................................................................... 437 filtergroups .................................................................................................................................... 437 filterinstances ................................................................................................................................ 438
24
filterlists ......................................................................................................................................... 444 ftpdebug ........................................................................................................................................ 446 hidelinks ........................................................................................................................................ 446 hostgroups .................................................................................................................................... 446 hostlookup..................................................................................................................................... 447 ignoredfields.................................................................................................................................. 447 includedagents .............................................................................................................................. 448 includedhosts ................................................................................................................................ 448 includedpages ............................................................................................................................... 449 includedparametervalues .............................................................................................................. 449 includedusers ................................................................................................................................ 449 keywordrules ................................................................................................................................. 450 levels ............................................................................................................................................. 451 linklength ....................................................................................................................................... 451 locale............................................................................................................................................. 452 localkeywords................................................................................................................................ 452 logs................................................................................................................................................ 453 maildebug...................................................................................................................................... 454 maxpathlength............................................................................................................................... 454 member ......................................................................................................................................... 454 metriclists ...................................................................................................................................... 455 metricsfile ...................................................................................................................................... 456 module .......................................................................................................................................... 456 modules......................................................................................................................................... 457 nodefaultautoupdate ..................................................................................................................... 458 nodefaultautoupdatefull................................................................................................................. 458 nodefaultautoupdatesample.......................................................................................................... 459 noimportreindex ............................................................................................................................ 459 nonreportabledimensions.............................................................................................................. 459 notableanalysis ............................................................................................................................. 460 ntadtrack ....................................................................................................................................... 460 ntdi ................................................................................................................................................ 460 ntlinktrack ...................................................................................................................................... 461 outdefext ....................................................................................................................................... 461
Version 8.2.1
25
parameters .................................................................................................................................... 461 password....................................................................................................................................... 463 platforms ....................................................................................................................................... 463 precalcdates.................................................................................................................................. 464 redirectscripts................................................................................................................................ 465 referrergroups ............................................................................................................................... 465 reportlists....................................................................................................................................... 466 resolvehosts .................................................................................................................................. 467 referrergroups ............................................................................................................................... 467 resolvetitles ................................................................................................................................... 468 retrievebatchsize ........................................................................................................................... 468 roledefaults.................................................................................................................................... 468 rows............................................................................................................................................... 468 sampling........................................................................................................................................ 469 schemafile ..................................................................................................................................... 469 securityrealms ............................................................................................................................... 469 seed .............................................................................................................................................. 470 segment ........................................................................................................................................ 470 servers .......................................................................................................................................... 471 sessionization................................................................................................................................ 472 siteurl............................................................................................................................................. 473 spiders........................................................................................................................................... 473 summarysize ................................................................................................................................. 474 tagimages...................................................................................................................................... 474 title................................................................................................................................................. 474 titlelength....................................................................................................................................... 475 titles............................................................................................................................................... 475 unexcludedpages .......................................................................................................................... 476 unresolvedtitles ............................................................................................................................. 476 url .................................................................................................................................................. 476 urlsearchrules................................................................................................................................ 477 user ............................................................................................................................................... 478 userlookup..................................................................................................................................... 478 variablesfile ................................................................................................................................... 478
26
viewlist........................................................................................................................................... 478 virtual............................................................................................................................................. 480 visitorlookup .................................................................................................................................. 480 visitorprofiles ................................................................................................................................. 481 visitthreshold ................................................................................................................................. 481 writebatchsize ............................................................................................................................... 482
Version 8.2.1
27
N10010
Preface
N40001
System information
When you call Unica technical support, you might be asked to provide information about your environment. If your problem does not prevent you from logging in, much of this information is available on the About page, which provides information about your installed Unica applications.
28
You can access the About page by selecting Help > About Unica If the About page is Unica. not accessible, you can obtain the version number of any Unica application by viewing the version.txt file located under each applications installation directory.
Version 8.2.1
29
N10018
About Unica NetInsight About data collection methods The stages of Web site tracking About Unica NetInsight reports About profiles
30
Information captured
Page Tagging Log Files Measure events in Web 2.0 rich Internet applications built with Ajax or Flash Default Web Server Log Files Monitor paths and drop-off points of search engine robots that index your site to help you with search engine optimization Capture click fraud activity that does not execute JavaScript and remains invisible to page tags Monitor page delivery performance, abandoned page views, and incomplete downloads Securely capture http user names
Measure behavior within Web pages, such as scrolling down or changing form fields Measure shopping cart activity
Measure client side information, such as the browser's screen size, etc. Capture additional information items such as user login names or form field data that are passed through customized tags
Convenience
Page Tagging Log Files Reduce Web server log file management Default Web Server Log Files Load historical information from before page tagging Avoid the effort of modifying your Web pages and scripted pages for inserting tags and then acceptance testing the modifications
Measure traffic on portions of your site embedded Avoid the effort of monitoring your site for pages in other Web sites where you don't have access to that are missing page tags logs
Accuracy
Page Tagging Log Files Track page views even if they were cached in ISP proxy servers Default Web Server Log Files Measure views, for example, of your PDF documents that were directly found and clicked from Google Measure sessions of mobile browsers which may not fire JavaScript page tags
Version 8.2.1
31
Default Web Server Log Files Measure page views even if the viewer clicked on to the next page before the page tag fired
N70001
Unica NetInsight reports contain drilldown capabilities that let you dynamically link to additional relevant information. You can maintain this feature in reports you email to others. Report data can be exported for use in popular software packages such as Microsoft Excel, Access, and Word, as well as other Unica applications. Unica NetInsight comes with these built-in reports: 3-digit Zip Code Summary 5-digit Zip Code Summary Area Code Summary Banner Ad Summary Browser Breakdown Browser Summary Campaign Channel Summary Campaign Channel Type Summary Campaign Segment Summary Campaign Summary Cart Activity Trend City Summary Clickthrough Breakdown Connection Type Summary Content Dashboard Content Summary Continent Summary Cookie Summary Country Summary Date Summary Day of the Week Summary Department Summary Directory Summary DMA Summary Domain Summary Entry Page Breakdown Entry Page Summary Error Breakdown
Version 8.2.1 33
Error Summary Executive Dashboard Exit Page Breakdown Exit Page Summary Geographic Dashboard Host Summary Impression Breakdown Initial Referrer Breakdown Initial Referrer Summary Keyword Summary Link Breakdown Link Summary Local Keyword Summary Marketing Dashboard Organization Summary Page Breakdown Page Delivery Summary Page Summary Page View Summary Paid Keyword Summary Paid Search Campaign Channel Summary Paid Search Campaign Channel Types Summary Paid Search Campaign Segment Summary Paid Search Campaign Summary Paid Search Paid Keywords Summary Path Summary Platform Summary Product Abandonment Summary Product Action Summary Product Conversion Summary Referrer Breakdown Referrer Summary Repeat Visitor Summary
34 Unica NetInsight - Administrator's Guide
About profiles
Retail Dashboard Revenue Trend Robot/Spider Breakdown Robot/Spider Summary Robot/Spider View Breakdown Robot/Spider Visit Breakdown Screen Resolution Summary Server Performance Summary Server Summary Spider Executive Dashboard State/Province Summary Technical Dashboard Time Summary Time Zone Summary Traffic Dashboard Traffic Summary User Summary View Breakdown Visit Breakdown Visit Duration Summary Visitor Dashboard Visitor Profile Summary Visitor Retention Summary Visitor Summary
N90001
About profiles
A profile is a collection of reports that analyze the same Web site. You can create a single profile to analyze an entire Web site. Or, if you have a large Web site with several different areas, you can create different profiles for different sections of the site.
Version 8.2.1
35
N10036
About Unica NetInsight logons To log on to NetInsight To connect to other Unica applications from Unica NetInsight To change your user password in NetInsight To change your user password in Unica Marketing Platform Viewing profiles and reports Using the NetInsight Homepage
36
To log on to NetInsight
To log on to NetInsight
1. In your Web browser, enter the Unica NetInsight URL. The Unica NetInsight User Logon page appears. 2. In the User name box, enter your user name. (The user name is case-insensitive.) 3. In the Password box, enter your Unica NetInsight password. 4. Click Log on on.
NC0001
Version 8.2.1
37
About the Unica NetInsight interface About the Profile Manager screen About the Profile screen To set the default profile About the geographic report interface
Options tab
Homepage icon
Help link
N120001
Version 8.2.1
39
Once you select a profile and click View Profile, you leave the Profile Manager and enter the profile screen (pictured above set to the Options tab). The Profile screen contains these controls:
Control Name Reports tab Description Use the Reports tab to view the reports that contain this profiles data. Use the Inbox tab to view reports you requested. Use the Custom tab to create new reports. Use the Archive tab to view archived reports. Use the Options tab to set the options for the profile, remove data from the profile, and remove archived reports. Use the Reporting Mode drop-down to specify whether reports should include all data generated during the last profile update or a sampled subset of that data.
40
Viewing profiles and reports Control Name Unica NetInsight Options drop-down list Description When you select the Options tab, the Unica NetInsight Options drop-down list displays. Use items from this list to edit your profile options, remove archived reports, or remove data from the profile.
Version 8.2.1
41
2 - Connecting to and Using the NetInsight Interface Panel Section Calendar Description You can use the calendar to specify the time period whose data you want to see in a report. By default, the data from the latest month for which the profile has data is used. Available reports are listed and grouped by category (for example, Marketing Analysis, Content Analysis). To expand a category, click the plus (+) sign next to its name. If the profile contains multiple views, the Change View icon appears in the report list title bar. Clicking it displays a list of all the views available for the profile. Click the Close button to close the list of views.
Report List
42
Viewing profiles and reports Icon Graph Type icons Description The graph type icons are to the upper right of the graph, in the graph title bar. Use these icons to choose the type of graph you want. Basic options include Bar Chart, Pie Chart, and Line Chart. A Funnel Chart option is also available. For scenario reports, and some report types may have an additional graph type. Not all the options are available for all reports. Below the report data are six icons for Search, First, Previous, Next, Last, and Rows. Use the Search icon to enter criteria for the report items you want to find. You can only search the data in the left-most column (not counting the row number). Use the Rows icon to change the number of rows that display on each page of the report.
Version 8.2.1
43
2 - Connecting to and Using the NetInsight Interface Name Update Description Use the Update command to update the profile with any new data in your log files and to regenerate the reports. Use the Calendar command to toggle display of the calendar on and off. Use the Selected Groups command to toggle display of the group selection box on and off. Use the Discovery Panel command to display or hide the Discovery panel. The Discovery panel lets you narrow the results displayed in the current report to a subset of the data or add metrics or dimensions to the current report. This command is only available on the Reports tab. Use the Sticky Filters command to turn sticky filters on or off. When filters are sticky, any currently-applied filters are kept and re-applied when you switch to a new report. When filters are not sticky, filters from one report do not carry over to another report. This command is only available on the Reports tab. Use the Comparative Reports command to display a second calendar so you can specify two time periods and view the data for both time periods side-by-side in one report. This command is only available on the Reports tab. Use the A/B Testing command to display two filter areas on the report so you can use drag-and-drop to create two sets of filters and view the report data using each set of filters side-by-side in one report. This command is only available on the Reports tab. Use the Report Designer command to display the Report Summary page, where you can edit the report. This command is only available on the Reports tab.
Calendar
Selected Groups
Discovery Panel
Sticky Filters
Comparative Reports
A/B Testing
Report Designer
44
Viewing profiles and reports Name Export Description Use the Export command to display the Export options dialog box so you can export the report data to a spreadsheet, database, or word processor. This command is only available on the Reports and Archive tabs. Use the Email command to display the Email options screen so you can specify a recipient and report format and email the current report. This command is only available on the Reports tab. Use the Print command to print the current report. This command is only available on the Reports and Archive tabs. Use the Default Report command to display an authenticated users default report (if one has been set) or to display the first report in the first folder of the current report list (if a default report has not been set). This command will not appear for unauthenticated users. Use the Homepage command to close the profile and display your customized list of profiles (for logged in users) or the login page (if you are not logged in). This command will not appear if it has been disabled in the administrative options. Use the Administration command to close the profile and open the Profile Manager. This command will not appear if it has been disabled in the administrative options.
Default Report
Homepage
Administration
N130002
2. To: a. Set your default profile, click the star icon next to the profile you want as your default. The icon lights, indicating it is now the default. b. Change your default profile, click the star icon of the profile you want as your new default. c. Clear the setting so that you have no default profile, click the star icon of your current default. The icon unlights.
N140001
46
Using the NetInsight Homepage Action Panning Description To pan the map, click and drag while holding down the Ctrl key.
Changing the Controls for changing the metric range displayed by a map are located at the map's metric range bottom of each map. To change the metric range, enter values for lower and upper bounds in the range text fields OR click and drag either end of the range bar towards the center OR click the center of the range bar and drag it left or right. After changing the range values, click the Apply Metric Range link to apply the new values to the map. Viewing city details City reports include city bubbles." The size of a citys bubble is proportional to the number of visitors from that city. To view the name of a city, hover your pointer over its bubble.
N100001
About using the Unica NetInsight Homepage To view a profile as an authenticated user About using Unica NetInsight documentation as an authenticated user About the Unica NetInsight Homepage To change your default view and reporting mode for a profile
Version 8.2.1
47
N170001
Viewing profiles Changing the number of profiles displayed Displaying additional profiles
Logging out
Changing your password, default If your Unica NetInsight administrator has given you permission to view or reporting mode, or Inbox change your password, your default views or reporting mode for preferences profiles, or your Inbox preferences, an Options tab will appear next to the Profiles tab in the upper-left corner of the screen. 48 Unica NetInsight - Administrator's Guide
Version 8.2.1
49
N10090
About profiles Configuring Database Connections Updating data in a profile To create a profile Restricting access to profiles Filtering profiles
About profiles
A profile is the basic unit of organization within NetInsight. In it's simplest sense, a profile is a collection of reports that examine a particular web site. You can further shape a profile by the filters, views, permissions, and other customizations you define for it. There is no limit to the number of profiles you can create. While it is common to create a single profile for each web site you want to report on, you can also create multiple profiles for a single site. For example, if your site contains subdomains, you may want to create a separate profile for each.
N1A0002
About database connections To configure a database connection Example database connection XML
50
DB2
<connections> <connection name="_default" type="db2"> <user>username</user> <password>encrypted_password</password> <driver>{IBM DB2 ODBC DRIVER}</driver> <dbalias>dbalias</dbalias> </connection> </connections>
Version 8.2.1
51
Oracle
<connections> <connection name="_default" type="oci"> <user>username</user> <password>encrypted_password</password> <service>service</service> </connection> </connections>
N1B0001
About deleting profile data To delete profile's data To update a profile's data
52
Version 8.2.1
53
To create a profile
When you create a profile, you must specify at least a profile name and title, and a log file location and format. The procedure below is only for single servers. 1. Display the list of profiles at the Profile Manager. 2. Click Create Profile Profile. 3. In the Short profile name (one word) box, enter the name that will be used for files associated with this profile. 4. In the Database connection box, select the database connection you want to use for this profile. 5. Click Continue Continue. 6. Enter the profile title (which will appear at the top of all the reports) and the URL of the site you want to analyze. Click Continue Continue. 7. In the Location of log file(s) list, select an option. If your logs are located on the computer that is running Unica NetInsight, or are available on the local network, select Local/network file system system. If your logs are available via FTP and you want Unica NetInsight to retrieve them for you, select FTP server server. 8. In the Format of log file(s) list, select the format of the log file. Select Auto Detect to have Unica NetInsight determine your log format automatically. If your log files are in a nonstandard format, you must first manually specify the log file format. Unica NetInsight can process log files that have been compressed using gzip. 9. Do one of the following: a. If you selected Local/network file system enter the log file path and file name in system, the Full path to log file(s) box.
54 Unica NetInsight - Administrator's Guide
To create a profile
You may use the wildcard character "*" to specify multiple files. You may also click Browse to find the file. The Browse button does not appear if it has been disabled in the administrative options. b. If you selected FTP server click Browse and enter the following information server, about the FTP server from which you will be downloading the log files. Host name The name of the server (yourdomain.com not name: yourdomain.com, ftp://yourdomain.com ) User name Your user name for the FTP server. If you access the server name: anonymously, leave this blank. Password Your password for the FTP server. If you access the server Password: anonymously, leave this blank. Password (again) The same password you entered above. (again): Initial path The directory in which the log file can be found on the server. path: When you have entered the information about the FTP server, click Browse to select the log file.
10. Click Add Add. 11. If you have other log files you want to analyze, click Continue If you have entered Continue. all of your log files, click View Profile Profile. 12. After clicking View Profile click the Update icon, which is the left-most icon in the Profile, icon group, to generate the reports for this profile.
N230001
7. Now you need to specify the clustered log files. 8. When you are finished specifying the log files, click the Update icon to generate the reports for the profile.
N240002
From the Profile Manager, select the profile and click Edit Profile or... Profile, While viewing the profile's reports, on the toolbar, click Administration Administration.
Unica NetInsight - Administrator's Guide
To create a profile
N260001
To delete a profile
You cannot undo a delete. If you think you might need a profile again, back up its files prior to deleting it. To delete a profile: 1. Open the Profile Manager. 2. Select the profile you want to remove and click Remove Profile Profile.
N270002
Version 8.2.1
57
3 - Creating and Configuring Profiles Option Rows per summary Description By default, each report page displays ten rows. You can change the default, and/or customize the number of rows initially displayed in any given report. Users can also change the number of rows displayed when working with a report. By default, each dashboard report graph displays five values. (The exception is graphs for dated summaries which display all available values in the underlying summary). Changes to this default will affect to all graphs on all pre-defined dashboards. You can specify the maximum number of consecutive pages (2 to 10) that can be in a path. This number is used to calculate the paths that appear in your Path Summary.
Page title and page name length You can specify a maximum display length for page titles and page names. Limiting the length makes reports easier to read and print. The default length is 41 characters. Host name resolution Most servers can resolve the host names of clients requesting files (that is, look up the host names for their corresponding IP addresses). However, some servers are not configured to perform this function. You can have NetInsight resolve host names that are not resolved by the server. By default, Unica NetInsight calculates metric percentages using the total count for the time period as the denominator. You can choose to hide metric percentages on reports or to calculate them using page or report totals instead.
N280002
Profile title URL of the site being analyzed Case sensitive pages Case sensitive user names Number of rows per summary Number of values per dashboard graph
Unica NetInsight - Administrator's Guide
To create a profile
Maximum length of a path Page title display length Page name length Resolve host names Metric percentages based on Anonymous FTP root directory
5. Click Save Options . If you changed one of the case-sensitivity options, the Resolve host names option, or the Anonymous FTP root directory option, you must delete your profile data and reimport your log files to apply those changes to existing data. Otherwise, the changes are applied to subsequently imported data when the profile is next updated. Be aware that if you do not still have all previously imported log files then deleting profile data will result in permanent data loss.
N290001
Version 8.2.1
Administrators can also set the default locale options to apply to each new profile users create.
N2A0001
The character sets of your profiles must match the database's character set. If they do not, you may end up with junk characters in your database. In most database applications, the character set is specified at the application level, so for the profile character set and the database character set to match, all of your profiles must use the same character set. Likewise, if the profile's character set is different than the Profile Manager character set, the profile title may not display properly in the Profile Manager. Unica strongly recommends that all of your settings use the same character set.
60
To create a profile
This setting assumes that you are using AL32UTF8 (the Oracle UTF-8 character set supported by Unica NetInsight) as the database and client character set.
N2B0002
Version 8.2.1
61
c. In the Display time as list, you can select 12 hour clock (the default) or 24 hour clock clock. d. In the Display date as list, you can select mm/dd/yyyy (the default), dd/mm/yyyy dd/mm/yyyy, or yyyy/mm/dd yyyy/mm/dd. e. In the Character set list, you can select the character set to use. You should not change the character set after creating the profile. f. In the Language drop-down list, select the language to use.
g. If you are using Microsoft log files, in the Log file date format list, you can select mm/dd/yy (the default), dd/mm/yy or yy/mm/dd dd/mm/yy, yy/mm/dd. h. In the Currency list, select the currency to use for the profile. 4. Click Save Options then click Continue Options, Continue. If you change the language, you must update the profile for the complete translated interface to appear.
N2C0001
62
To create a profile
Requests for the page tag image will count as hits. They will not count as page views. Augmenting log files with data collected by page tags enables you to capture additional client-side information such as screen resolution, or to track events such as visitors adding or removing items from shopping carts. Used instead of log files to collect data for a single site Requests for the page tag image will count as page views. Non-page tag requests will not be counted. This mode is the typical page-tagging mode. In this mode, you will only load traffic that is recorded from page tags placed in your HTML pages. Ensure that you tag every page you want to track. You can tag non-HTML views (such as file downloads) by tagging the link to the file. In addition, you can use event tags to track on-page events (such as adding a product to a shopping cart). For this mode, pages are expected to be logged in the format http://www.host.com/page.html. Unica NetInsight will parse the host (for example, www.host.com) and compare it (without respect to case) to the URL of the site being analyzed option in the General options, or the server URL if your log files are clustered for multiple sites. If they match, Unica NetInsight will remove the host from the URL and count the request as a page view. If they do not match, the request will not be counted. Used instead of log files to collect data for multiple sites Requests for page tag images will count as page views. Non-page tag requests will not be counted. Pages will appear in Unica NetInsight reports as full URLs (as they would if Unica NetInsight were configured to process log files that are clustered for multiple sites). If you are using page tags instead of log files, you will need to use this mode so that you can distinguish a page tag generated for a page on one site from a page tag generated for a page with the same name on another site (such as index.html). Used in addition to log files to collect data for multiple sites Requests for page tag images will count as page views. Non-page tag requests will also be counted as page views. (Non-page tag requests will be prefixed with the URL in the General options, or the server URL if the log files are clustered for multiple sites.) Use this mode if you want to use log files in conjunction with event tags for your main site, or have remote site portions that are hosted within other Web sites for which you do not have access to the log files. In this case, you would place the page tags in the pages on those remote sites. Page tags generated from the remote sites will count as page views. The pages from each site will be prefixed with the sites name (for example, http://www.ourpartner.com/remotepage.html). Both regular log records and page tag records will count as page views. Therefore, do not add page tags to your main site for which you are using log files, as traffic will be counted twice. Using event tags only will not result in traffic being counted twice.
N2D0001
Version 8.2.1
63
64
Restrict access to a pro- Set the profile's default file (by roles) role access to No Access and do not assign users specific roles to that profile
Version 8.2.1
65
3 - Creating and Configuring Profiles To Restrict access to the Profile Manager Do This Create and assign users to roles which do not have access to the Administration : Profile Manager privilege Description Restricting access to the Profile Manager prevents users from creating and deleting profiles. It also prevents them from accessing system-level administration options (which includes default profile options). By itself this type of security does not prevent users from accessing an individual profile's administration options. Restrict access to one or more of a profile's options Create and assign users You can prevent users from accessing a profile's to roles which do not administrative options by assigning them to a role have the one or more of that does not have privileges to Options. the Options : privileges By itself this type of security does not prevent users from accessing the Profile Manager or system-level administration options (which includes default profile options). You can use a profile's Passwords settings to password protect the ability to perform these actions in a profile: updating or deleting profile data, saving or deleting reports, specifying which web server log files the profile uses, and modifying the password protection of these options itself. By itself this type of security does not prevent users from accessing the Profile Manager or system-level administration options (which includes default profile options). Restrict access to specific features within a profile Create and assign users to roles which do not have the one or more of the Interface : and/or Removal : privileges By assigning users to a role which you the selectively assign Interface and Removal privileges, you can control just about any access or action a user can person within a profile.
Restrict access to Use the Passwords setsaves, deletes, and log tings in profile options file specification within a profile (by password)
66
Filtering profiles
Profiles : Override No Access This privilege gives a user the ability to access a Access: profile even when the profile's default role is set to No Access It should be reserved Access. for users you want to have access to all profiles.
N2E0002
Filtering profiles
N1E000A
Version 8.2.1
67
To filter profiles
To filter a profile: 1. View the profile you want to filter. 2. Click the Options tab. 3. In the Options panel, select the filter option you want. See the About Profile Filtering Options topic for information on using specific filter types. 4. Click Add Add. If you are creating a date filter, select the date range and click Save Options Options. Otherwise proceed to the next step. 5. Enter a filter that describes the data you want to include or exclude and click Add Add. 6. The filter will be applied to data you import from now on. If this is what you want, or if you have additional filters to enter, click Continue Continue.
68
Filtering profiles
If you want to apply this filter to already imported data, you will need to delete all the data in your profile and reimport your log files. If you do not still have all the log files you have imported into this profile, you will lose data permanently by choosing this option. To delete your profile data, click Delete Profile Data Data.
N300002
Pages
Parameter values
Version 8.2.1
69
N10123
To add log files to a profile To add clustered log files to a profile Manually specifying a log file format About log files on FTP servers To specify the date format of your log files To process only data for the configured site To select a time zone for a new profile To stop conversion of dates and times in W3C log files
7. Specify the path to the log file(s). If the files are available on the local network, enter the path and file name. Or, if it is available, click Browse to find the file. If the files are available from an FTP server, click Browse and enter the connection information for the server. On some UNIX FTP servers, the initial path is the complete system path to directory containing the log files. On Windows FTP servers the initial path is usually relative to the FTP root directory. You can use pattern matching to specify which log files to use at the given path location. For example, to use all log files at the specified path, modify the file name portion of the path to *.*. Or, to specify that only log files that match the pattern mydomain.com-MMM-YYYY.gz be used (for example, mydomain.comJan-2010.gz) enter mydomain.com-???-20[0-9][0-9].gz.
Version 8.2.1
71
Clustered for multiple sites Multiple servers that are part of the same domain. sites: Each site serves different content. For example, in the yoursite.com domain the domain, server home.yoursite.com serves the home page and general content, and the server catalog.yoursite.com serves the catalog pages. Within each site in the cluster, you can also have multiple load-balanced servers. For example, the catalog pages could be served by any of three servers clustered as catalog.yoursite.com catalog.yoursite.com. The servers should usually be part of the same domain. If you need to cluster servers from different domains, contact Unica technical support.
5. Click Save Options > Continue Continue. 6. Click Server 1 > Edit Edit. 7. Enter a unique name and a URL for the server. If the servers are clustered for multiple sites, you must enter a different URL for each site. In the example earlier, you would use http://home.yoursite.com for the first server and http://catalog.yoursite.com for the second. (Load-balanced servers within a site should all use the same URL. For example, all three servers clustered as catalog.yoursite.com would use http://catalog.yoursite.com http://catalog.yoursite.com.) If you are analyzing log files from servers clustered for multiple sites, the URL you enter here overrides the URL of the site being analyzed setting in your profile's General options. 8. Click Add to add additional servers. You must create a server entry for each server in the cluster. When you are through adding all of the servers, you need to specify the location of each servers log files. 9. To specify the location of a servers log files, select the server, and click Add/Edit Log Files Files. 10. Click Add Add. 11. Specify whether the files are available on the local network or via an FTP server. 12. Specify the format of the log file(s) or select Auto Detect to have Unica NetInsight determine the format. If your log files are in a non-standard format, you must first create a custom log format definition in Unica NetInsight. See the instructions for defining a custom log file format. 13. Specify the path to the log file(s). If the files are available on the local network, enter the path and file name. Or, if it is available, click Browse to find the file. If the files are available from an FTP server, click Browse and enter the connection information for the server. On some UNIX FTP servers, the initial path is the complete system path to directory containing the log files. On Windows FTP servers the initial path is usually relative to the FTP root directory.
Unica NetInsight - Administrator's Guide
72
You can use pattern matching to specify which log files to use at the given path location. For example, to use all log files at the specified path, modify the file name portion of the path to *.*. Or, to specify that only log files that match the pattern mydomain.com-MMM-YYYY.gz be used (for example, mydomain.comJan-2010.gz) enter mydomain.com-???-20[0-9][0-9].gz.
14. Click Add > Continue Continue. 15. Repeat 10 through 14 until you have specified all of the log files for this server. 16. When you have finished adding log files for one server, click Back to Servers and repeat 9 through 15 for the remaining servers.
N330001
To define a custom log file format About fields in custom log format definitions About dates in custom log format definitions About tab-delimited fields in custom log format definitions
Version 8.2.1
73
Matching literal characters appearing immediately before and after a field identifier are treated as field delimiters indicating that any value between them should be considered the field value. The most common field delimiter is a quotation mark. A field value cannot contain a field delimiter. A field that does will cause the log file line to be parsed incorrectly and subsequently ignored. Unique field identifiers can be used only once per custom log format. A custom log format must contain the mandatory field identifiers listed below.
Additional information is parsed automatically from the log file if any of the following field identifiers are present.
74
Manually specifying a log file format Field Identifier %FILESIZE% %REFERRER% %QUALITY% %QUERYSTRING% Field Value Size of the requested file* Referrer, as sent by the browser* Quality of the connection* Query string supplied with the request (can be used only with %PAGE%)* Cookie as supplied by the Unica Web Server Plugin* Connection status as supplied by the Unica Web Server Plug-in Host name or IP address of the site to which the request is made (can be used only with %PAGE%) Status of the request (HTTP status code). If this field identifier is not present in the custom log format, the status code of the request will be considered 200. %TIMETAKEN% %USERAGENT% Time taken to serve the request, in seconds Browser and platform information, as sent by the browser* Remote user name* Virtual host name*
%SANECOOKIE%
%SANESTOP%
%SITE%
%STATUS%
%USERNAME% %VHOST%
* Dashes and null strings are acceptable values for these fields. They are interpreted to mean that no value for the given field is available. Unica NetInsight skips any field identifier not listed in the tables above unless it is named as a field from which parameter data should be parsed. If your log file contains a field not listed in the table above, you must enter an "arbitrary" field identifier for it in the custom log format. The arbitrary field identifier serves as a placeholder that tells Unica NetInsight to skip the field. Some custom log formats may contain place-holders such as %SKIP1%, %SKIP2%, etc.
Version 8.2.1
75
Examples
NCSA Common Log Format The following log format (one line) defines the standard NCSA Common Log Format:
HOST% %IDENT% %USERNAME% [%DATETIME%] "%REQUEST%" %STATUS% %BYTES%
Note that literal characters (in this example, the brackets and quotes are literal characters) must appear in the log file exactly as they are specified in the custom format. NCSA Combined Log Format with Unica Web Server Plug-in The following log format (one line) defines an extension of the NCSA Combined Log Format that includes the information generated by the Unica Web Server Plug-in:
%HOST% %IDENT% %USERNAME% [%DATETIME%] "%REQUEST%" %STATUS% %BYTES% "%REFERRER%" "%USERAGENT%" "%SANECOOKIE%" %SANESTOP% %TIMETAKEN%
N3A0001
Y YY YYYY H MI S TZ
Examples
Custom Date Formats The following field identifiers define a timestamp format that can be used to parse dates such as 2010-10-01 12:34:56:
%CUSTOMDATE Y-M-D H:MI:S%
The following field identifiers define a timestamp format that can be used to parse dates such as 10/01/2010 12:34:56:
%CUSTOMDATE M/D/Y H:MI:S%
Version 8.2.1
77
Examples
Tab-Delimited Fields The following log format defines a variation of the standard NCSA Common Log Format where fields are tab delimited and the request method and protocol are stored separately from the URL requested (all one line):
%HOST%\t%IDENT%\t%USERNAME%\t[%DATETIME%]\t %METHOD%\t"%URL%"\t%PROTOCOL%\t%STATUS%\t %BYTES%
The following field identifiers define a timestamp format that can be used to parse dates such as 2010-04-01<tab>12:34:56:
%CUSTOMDATE Y-M-D\tH:MI:S%
%CUSTOMDATE_GMT Y-M-D\tH:MI:S%
N340001
N350001
78
This option is only available for logs in NCSA, Netscape Flexible, or a custom format. W3C Extended logs record time using Greenwich Mean Time. By default, Unica NetInsight converts the times in W3C Extended logs to the local time of the Unica NetInsight installation. It is strongly recommended that the time zone not be changed after production data has been imported into the profile. 1. View the profile in which you want to select a time zone. 2. Click the Options tab. 3. In Options panel, select Main > Advanced Advanced. 4. Check Convert dates and times to local time zone zone. 5. Select the time zone to use from the drop-down list. The values in the list are the time zones that apply to the current date. For example, in December the list contains standard time zones, not daylight saving time zones. The value you select is stored in the profile's configuration file in the <converttimes> element. If the local time zone you select observes daylight saving time, the profile will display the correct times and dates all year. If the local time zone you select does not observe daylight saving time, you must manually modify the profile's configuration file so the value of the <converttimes> element is a time zone identification that is valid all year. For example, for most locations in Arizona, <converttimes>America/Phoenix</converttimes> ensures the correct times and dates all year. If you do not modify the configuration file, you will need to change the value in the profile options after each time change but before you import any post-change data into the profile. 6. Click Save Options Options.
N380001
80
The change will be applied to all new log file data you import. If you want this change to be applied to log file data you have already imported, you must delete your profile data and reimport the log files.
Version 8.2.1
81
N10166
What is page tagging? Introduction to page tagging Setting up basic page tagging Adding dimensions to tags Including cookie data in page tag requests Tagging events Tagging retail activity Tagging applications and widgets Reference
When to use page tagging How page tagging works Basic page tagging data, dimensions, and metrics
Unica NetInsight - Administrator's Guide
N3D0007
About the page tag image query string Page tagging options settings in Unica NetInsight Planning your tags
N450002
Version 8.2.1
Referring URL Screen resolution Screen color depth Browser language Browser Java support User agent Cookie information
This information appears in your reports through the default dimensions and metrics. These are the default dimensions: Page Entry Page Exit Page Referrer Browser Platform Geographic Data (Country, City, Time Zone, Organization, etc.) Date Time Day of the Week
These are the default metrics: Number of visitors Number of views Number of visits Number of new visitors Number of repeat visitors Total time online Average viewing time Average visit duration Views per visit
You can customize page tagging to track and report on a range of other visitor activities such as shopping cart activity, form interaction, clicks on links to external sites, interaction with a Rich Internet Applications (RIA) like Flash, or any other event. Page tags can be customized on a page-by-page basis using optional page-specific variables.
N470002
84
Used instead of log files to collect data for multiple sites Requests for page tag sites: images count as page views. Non-page tag requests are not counted. Pages appear in NetInsight reports as full URLs (as they do when NetInsight is configured to process log files clustered for multiple sites). If you are using page tags to collect data for multiple sites, you must use this mode so that NetInsight can differentiate between page tags generated for identically named pages from different sites . Used in addition to log files to collect data for multiple sites Requests for page tag sites: images and non-page tag requests both count count as page views. (Non-page tag requests are prefixed with the URL in the General options or the server URL if the options, log files are clustered for multiple sites.) Use this mode if you want to use log files in conjunction with page tags for your main site, or if portions of your site come from other web sites whose logs you cannot access. In that case you would tag the pages on those remote sites. Page tags generated from the remote sites count as page views. The pages from each site re prefixed with the sites name (for example, http://www.ourpartner.com/remotepage.html). Both regular log records and page tag records will count as page views. Therefore, do not add page tags to your main site for which you are using log files, as traffic will be counted twice. Using event tags only will not result in traffic being counted twice. If a page tag request includes pv= or ev= those values will override the Page ev=, Tagging options default behavior for page views.
N490002
Basic page tagging deployment checklist About the page tags package To deploy the page tag image To edit and deploy the page tag script To tag your site pages Verifying that the page tags are working To enable page tags
Unica NetInsight - Administrator's Guide
N3E0008
What to do when JavaScript is disabled Using page tagging with secure pages To normalize query string parameter values
To download the Page Tags package go to http://customers.unica.com/home.cfm > Software Downloads > Unica Web Analytics Page Tagging Script.
N4B0002
Log format requirements for the page tag image web server It is important to understand that it is from the page tag image's web server logs that NetInsight gets its page tag data. So you must be able to access these logs, and they must be in a format Unica NetInsight can read. Supported formats include: Microsoft IIS Standard and Extended NCSA Common and Combined Netscape Flexible W3C Extended
If you need more information, see the topics on importing log data. Once you have deployed the page tag image you are ready to edit and deploy the page tag script.
N4C0002
Setting up basic page tagging </noscript> <!-- END: Unica Page Tag -->
2. If necessary, change the script elements src attribute to match the location of the page tag script (ntpagetag.js). If the page tag script is on the same server as your Web site content, you can use a relative path. Otherwise, use an absolute path. 3. If necessary, change the img elements src attribute to match the location of the page tagging image (ntpagetag.gif). 4. Copy and paste the page tag into each page on your site you want to track with Unica NetInsight. If you want to track the entire site, paste the page tag into the master template or a global include file, such as a footer. 5. Copy your tagged web pages or the updated master template or include file to the Web server. If you don't need to make more advanced customizations (such as modifying tags on a page-by-page basis or using tags to track events or retail activity) you are finished configuring your web site to use page tags. Next you should verify that your page tags are working. For instructions on viewing the data you are collecting in Unica NetInsight reports see the Unica NetInsight Reports User's Guide.
N4E0001
5. Click Save Options and then click Continue Continue. If you selected Not used you do not need to continue with the remaining steps. used, 6. Specify the images used to collect page tag data: a. To add an image, click Add enter a filter that describes the image, and click Add again. b. To edit a filter, select the filter in the list, click Edit, make your changes and click Save Changes. c. To delete an image, select the image and click Delete. When you import data into Unica NetInsight from now on, Unica NetInsight will analyze the data collected by the page tag images that match the current filters. 7. If this is what you want or if you have additional changes to make to the list of filters, click Continue Continue. If you want Unica NetInsight to use the current image list on data you have already imported, you need to delete all the data in your profile and reimport your log files. If you do not still have all the log files you have imported into this profile, you will lose data permanently by choosing this option. To delete your profile data, click Delete Profile Data Data.
N4F0002
90
If you will be tagging pages that are all secure or all not secure, use the appropriate protocol for the page tag script. If you will be tagging a mix of pages that are secure and pages that are not secure place the page tag script on the same server as your Web site content and in your page tags use a relative path to the script location.
N510002
1. Open the administration home page by clicking on the Administration icon ( 2. Click the Options tab. 3. In the Options panel, select Main > Advanced Advanced. The Advanced options screen opens. 4. Select Normalize lc query-string parameters to convert all query string parameter values to lowercase.
N3F0002
).
About adding dimensions to tags Default dimensions Standard dimensions Unica NetInsight recognizes automatically About using custom dimensions Adding a dimension to a tag
Version 8.2.1
91
Direct tags do not have default dimensions because they do not call the page tag script.
N520002
Default dimensions
For basic page tags and event tags, the default dimensions are determined by the page tag script (ntpagetag.js). You can edit the script to disable some of the default dimensions, although Unica does not recommend it. For details, see documentation on the NTPT_FIELDS variable. Direct tags do not have default dimensions because they do not call the page tag script.
N530002
ev lk
Code that tells Unica NetInsight to count the 1 page tag request as a link to an external site. lk=1 Code that determines whether or not Unica NetInsight counts the page tag request as a page view. A value of 0 does not count the request as a view. A value of 1 counts the request as a view. Use pv=0 when using a page tag to send visit-level data. When using page tagging to augment log files with additional data, use pv=1 to count the request as a view. When using page tagging instead of log files, you do not need to specify pv=1 because counting the page tag image request as a page view is the default behavior in this mode. 0, 1
pv
rta
92
Adding dimensions to tags Name rtc Description Products purchased Value / Example List of product SKUs, quantities, and values separated by semi-colons String List of product SKUs, quantities, and values separated by semi-colons Number List of product SKUs separated by semicolons Number sc=404 String
rti rtr
Order ID associated with the current page Products removed from the shopping cart on the current page Revenue associated with the current page Products viewed on the current page
rtt rtv
sc
Status of the request (HTTP status code). Unica NetInsight uses this dimension to determine which requests are errors. Name of the site (used to filter data into profiles) Unique floating point identifier used by your visitors' browsers to help avoid cached page tag requests. The page tag script sets the value for this dimension automatically. Populates values for Unica NetInsight's user dimension. Visit cost (the amount of money spent to drive a visitor to your site for this visit). The value must be a float value and cannot include a currency sign or commas.
site
ts
Number
un
String
vc
Number
Version 8.2.1
93
5 - Working with Page Tags Name ck Description Cookies and values. The list of cookie namevalue pairs must be delimited using semicolons and the entire list must be URL encoded. Value / Example String ck=UnicaNIODID%3Dti05RwsKyD6V50cKhL %BSessionID%3D9816106-8172
lc
Requested page (including query string). The Any URL value must be in the form of a URL and must lc=http%3A%2F%2Fblog.company.com%2Fp be URL encoded. age.html Language of the visitor's web browser String ln=en
ln
rf
rs
Screen resolutions of the visitor's web brows- NumberxNumber er, expressed in width times height. rs=1280x800 Time zone of the visitor's web browser URL-encoded time zone value tz=GMT%20-04%3AOO
tz
N570002
If you want to analyze multiple sites in a combined profile, use a common prefix in the site dimension values for those sites (for example, the name of your organization for production servers or test for test servers). This enables you to write a simple filter for the combined profile.
N540002
94
The custom dimension parameter value must be URL encoded using the encodeURIComponent() JavaScript function. You can either define the appropriate value for the dimension each time you add the dimension's parameter to a tag, or you can set the dimension parameter to the value of an existing variable on your page. (Setting the dimension to a variable may not be possible for all sites or applications. The exact method to use depends on the scripting language used by the site or application.)
N590002
Example:
<script language="Javascript"> var NTPT_PGEXTRA='ads=abchotel,discounttheater,acmecar'; </script>
N5A0002
Version 8.2.1
95
N550002
96
Event tags
In the JavaScript event handler or Flash ActionScript for the event being tagged, do one of the following: Use ntptAddPair to define the dimension before the ntptEventTag, ntptLinkTag, or ntptSubmitTag function is called. Use the querymod argument of the ntptEventTag, ntptLinkTag, or ntptSubmitTag function to define the dimension.
Example: In this example, the onclick JavaScript event handler calls the ntptEventTag function and uses the querymod argument to add the ev standard dimension and the evdetail custom dimension.
<a href="go.asp" onclick="ntptEventTag('ev=buttonclick&evdetail=go');">
Direct tags
Include the name-value pair for the dimension in the list of name-value pairs after the question mark (?) in each direct tag to which the dimension applies. Example:
Version 8.2.1
97
This example adds the site dimension and the visitor identification cookie.
http://pt001.unica.com/ntpagetag.gif?lc=http%3A%2F%2Fapplication%2Fsta rt&site=application&ck=UnicaNIODID%3DcookieValue
N400002
About including cookie data in page tag requests About visitor identification cookies To capture data from additional cookies
Stop setting visitor identification cookies Change the visitor identification cookie name (not recommended if you are already collecting data) Change the expiration period for the visitor identification cookie Declare a domain visitor identification cookie to track visitors across subdomains
Tagging events
1. In the page tagging script (ntpagetag.js), set NTPT_FLDS.ck to true. This enables collection of cookie data. Ensure that no variables used in your page tags at either the global or page level have their value set to ck as this would prevent collection of cookie data (for example, NTPT_GLBLEXTRA="ck=somevalue"). For the same reason, do not use tagging functions (for example, ntptAddPair, ntptEventTag) to add a ck parameter or modify the existing ck parameter. 2. Declare the cookie name variable. Specify the names of the cookies you want to capture as an array. a. To capture cookies globally, declare the NTPT_GLBLCOOKIES variable in the page tagging script. b. To capture cookies on specific pages, declare the NTPT_PGCOOKIES variable on those pages where you want to capture cookie data. Examples:
NTPT_GLBLCOOKIES= ["cookie1", "cookie2"]; NTPT_PGCOOKIES= ["cookie1", "cookie2"];
N410001
Tagging events
N410007
What is an event? About event tagging Tracking an event as a page view Ensuring link and submit page tag requests are submitted before the page unloads To tag JavaScript or AJAX events To tag events in Flash 8 or greater Flash page tagging examples Marking link tags as links to an external site Sending visit-level data when an event occurs
What is an event?
An event is any on-page action other than loading a page on your site. Events include but are not limited to the following: Changing a field on a form Selecting an option in a drop-down list box Submitting a form Clicking a link to display a page on another site Starting a video
99
Version 8.2.1
Events are plentiful in RIAs such as Flash or AJAX applications. The Unica page tag script includes special functions to use when tagging events.
N5D0002
Every event you want to track must call one of these functions in its JavaScript event handler or Flash ActionScript. Events may also call ntptAddPair and ntptDropPair in conjunction with one of the main functions.
Tagging events
Example
<a href="article1.pdf" onclick="ntptEventTag('lc=' + encodeURIComponent(this.href) );" target="_blank">
N5F0001
Ensuring link and submit page tag requests are submitted before the page unloads
Following a link or submitting a form ultimately leads to the unloading of the page that contains the link or the form. To ensure that the request is sent before the page is unloaded, the page tag script introduces a small delay when tagging links and submissions. This delay is the maximum amount of time that will elapse before the page is unloaded; if the request returns before the specified time has elapsed, the page will be unloaded immediately, without waiting for the rest of the time. You can configure this delay globally by setting the NTPT_MAXTAGWAIT variable. You can adjust the wait for an individual link or submission by using the maxtagwait argument for ntptLinkTag or ntptSubmitTag. The NTPT_MAXTAGWAIT variable does not introduce a delay for tags created using ntptEventTag. If you need a delay, use ntptLinkTag or ntptSubmitTag. The default wait is one second, which is usually indiscernible to the user and is usually sufficient to effectively capture all tagged links and form submissions.
N600001
Version 8.2.1
101
<form> <input type="checkbox" name="mybox" onchange="ntptEventTag();"> <input type="text" name="mytext" onchange="ntptEventTag('ev=myevent&mytext=' + encodeURIComponent( this.value ) );"> <script language="JavaScript"> function MyEventHandler() { ntptAddPair( "color", "red" ); ntptEventTag( "ev=myevent" ); } </script> </form>
N610001
Tagging events
if (command == "ntptEventTag") { (0 == tmpargs[0].length) ? ntptEventTag() : ntptEventTag(tmpargs[0]); } else if (command == "ntptAddPair") { if ( 2 != tmpargs.length ) { return; } else { ntptAddPair(tmpargs[0], tmpargs[1]); } } else if (command == "ntptDropPair") { if ( 1 != tmpargs.length ) { return; } else { ntptDropPair(tmpargs[0]); } } }
2. On the page whose Flash you want to track, add this function to your Flash ActionScript. It serves as a bridge to ExternalInterface.call which calls unicaFunctions. You can name the function anything.
function FlashTracking(func, args) { ExternalInterface.call("unicaFunctions", func, args); }
3. In the page's ActionScript, use the function you just added to specify name/value pairs to pass to ntptEventTag. See the next section for examples.
N620001
5 - Working with Page Tags this.FlashTracking( "ntptAddPair", "sunroof,true" ); this.FlashTracking( "ntptEventTag", "ev=PersonalizeCar" );
The "color=red" pair came from the original calls. The "sunroof=true" is no longer there because it was dropped by the ntptDropPair call. The "ABS=true" pair comes from the most recent ntptAddPair.
104
The first condition keeps Unica NetInsight from registering the tag as an event. The second keeps Unica NetInsight from registering it as a page view.
N420001
About retail activity Tagging product views Tagging additions to a shopping cart Tagging removals from a shopping cart Tagging the checkout process Retail page tag parameters summary Retail metrics
Version 8.2.1
105
You can tag or not tag individual retail activities, depending on your reporting needs. For example, if you require checkout data only, or if your site does not use a shopping cart, you can implement checkout tags without tagging cart adds, cart removes, or product views. Similarly, if your site is a product review site and not a retail site, you can use product view tags without tagging cart adds, cart removes, or checkouts.
N650002
106
However, typically NTPT_PGEXTRA passes additional information, such as authenticated user names, that you do not want to clear. In these cases, use the ntptDropPair function to clear the rtv parameter value without clearing the other parameters passed in NTPT_PGEXTRA. Call ntptDropPair before the event tagging function.
ntptDropPair(rtv);ntptEventTa('ev=cartadd&rta='sProduct + ';' + iQuantity + ';' + fPrice);
Another method of ensuring product views are not counted twice is to store the original NTPT_PGEXTRA variable prior to calling the page tagging script (ntpagetag.js) and then reset the variable after the page tag image request is sent. This is particularly useful in situations where there might be multiple events on the product view page (and therefore multiple places where you would need to add ntptDropPair). The following example assumes that NTPT_PGEXTRA is already passing the authUser variable as the un parameter value (see the first line of the script):
<script language="JavaScript"> var NTPT_PGEXTRA = "un=" + authUser; var NTPT_PGEXTRA_ORIGINAL = NTPT_PGEXTRA; NTPT_PGEXTRA +="rtv=prod1234;prod3456;prod5678"; </script> <!--BEGIN: Unica Page Tag--> <script language="JavaScript src="/scripts/ntpagetag.js"></script> <!--END: Unica Page Tag--> <script language="JavaScript"> NTPT_PGEXTRA=NTPT_PGEXTRA_ORIGINAL; </script>
N660001
The product identifier, quantity, and price are all required in order for Unica NetInsight to track the cart addition. Example: In this example, the values for a single product are passed:
ntptEventTag('ev=cartadd&rta='prod1234 + ';' + 1 + ';' + 10.00 );
The unit price must be a float value. It must not include a currency sign or commas. Including a currency sign will result in a unit price of zero within Unica NetInsight.
Version 8.2.1
107
Information for multiple products can be passed in a single call. The first three values must represent the identifier, quantity, and unit price of the first product, the next three values the ID, quantity, and unit price of the second product, and so on. Example: This example passes values for two products:
ntptEventTag('ev=cartadd&rta='prod1234 + ';' + 1 + ';' + 10.00 + ';' + 'prod5678 + ';' + 5 + ';' + 5.00 );
N670001
As with adds, information for multiple products can be passed in a single call. The unit price must be a float value. It must not include a currency sign or commas.
N680001
Syntax Syntax:
var NTPT_PGEXTRA = "rti=sOrderID&rtt=fTotalRevenue&rtc=sProduct;iQuantity;fPrice" ;
Example This example shows an order ABC1234 that totals $199.99 and consists of Example: two products costing $150 and $49.99 respectively.
108
rtv=sProduct NTPT_PGEXTRA="rtv=product1;product2;product3";
rta
rtr
rtc
retail (cart) check- rtc=sProduct1;iQuantity1;fPrice1;sProduct2;iQuantity2;fPrice2 out NTPT_PGEXTRA="rtc=prod1234;1;5.00;prod3456;3;19.95"; retail total revenue rtt=float rtt=210.54
rtt
rti
rti=string rti=8318
vc
visit cost
vc=float vc=20.00
N6A0002
Retail metrics
This table lists the retail metrics that are available in Unica NetInsight reports and provides the corresponding parameter and a description for each one.
Metric Abandoned Carts Parameter rta Description The number of visits that have shopping carts that did not complete the checkout process.
Version 8.2.1
109
5 - Working with Page Tags Metric Abandoned Revenue Parameter rta Description The total value of all shopping carts that did not complete the checkout process. The amount of money (on average) spent on each order. The percentage of visits that have shopping carts that did not complete the checkout process. The number of times visitors placed a product in their shopping carts. The number of times visitors deleted a product from their shopping carts. The percentage of visits with shopping cart activity that completed the checkout process. The number of times the checkout process was completed. The total value of the cart contents at checkout time. This is independent of the rtt parameter. The number of times visitors viewed a product. The total number of units in abandoned carts. The total number of units added to a cart. The total number of units purchased. The total number of units removed from a cart. The total order revenue, used to populate the standard revenue metric. It may include revenue (such as shipping charges and taxes) not associated with a product. The Revenue metric includes only revenue from completed web site sessions, as determined by the Number of minutes between visits setting in the Visitor > Sessionization section on the Profile Options screen. If Unica NetInsight identifies that a session may not be complete, it does not include revenue from the session in the Revenue metric.
rtt
rta
rta
Cart Removes
rtr
Checkout Rate
rtc/rtt
Checkouts
rtc/rtt
Product Revenue
rtc
Product Views Quantity Abandoned Quantity Added Quantity Purchased Quantity Removed Revenue
N6B0002
110
About tagging applications and widgets Anatomy of a direct tag Best practices for direct tags About the lc parameter When NOT to pass the lc parameter Where to place your direct tags Minimizing the number of tags
If you cannot use basic page tags, you can use direct tags to send usage data from the application or widget to Unica NetInsight. Direct tags and page tags are built using the same set of page tag parameters. Like page tags, direct tags can contain data for custom dimensions. Direct tags (sometimes called web beacons) bypass the page tag script (ntpagetag.js) and request the page tag image directly from the server. Because direct tags bypass the script, there is no default direct tag. You must define in the direct tag each item of information you want Unica NetInsight to receive. Unlike page tags, direct tags work in situations where JavaScript rendering is not possible.
N6C0002
Version 8.2.1
111
Simple Example
This direct tag requests pt001.unica.com/ntpagetag.gif and passes information using the lc, site, and ck parameters:
http://pt001.unica.com/ntpagetag.gif?lc=http%3A%2F%2Fapplication%2Fsta rt&site=application&ck=UnicaNIODID%3DcookieValue
The request shows up in Unica NetInsight as a page view of http://application/start, and the page view is included in any profile that contains site=application.
N6E0002
112
The lc parameter should include a descriptive page name, including as much detail as possible about what is going on within the application at the time the page tag image is requested. Typically, content categorization can be derived directly from the value of the lc parameter. For example, the following image request tells us that the visitor was in the products section of the application because the lc parameter value uses a directory structure to indication content hierarchy:
http://pt001.unica.com/ntpagetag.gif?lc=http%3A%2F%2Fapplication%2Fpro ducts%2F&site=application
N6F0002
When the lc parameter is missing, Unica NetInsight reads the referring URL from the headers of the request and treats the referring URL as the page being viewed. If you must track events or interactions within the application, pass the lc parameter and parse the referring URL as a parameter. Direct tags sent from applications that are not web-based must contain an lc parameter.
N700002
Version 8.2.1
113
Reference
N44000A
Introduction Required variables Optional global variables Page-specific variables Event tagging functions
Introduction
This section provides reference information on the functions, variables, and fields available through page tags.
N720001
Required variables
N72000A
NTPT_IMGSRC
A string variable that contains the URL of the page tag image. If the page tag image and the page tag script are on the same Web server as the pages you are tagging, you can omit the protocol and server. However, if the page tag script is on a different server than the Web pages you are tracking, you must specify the fully qualified URL to the page tag image, even if the page tag image and page tag script are located on the same server. Syntax
var NTPT_IMGSRC = URL;
114
NTPT_SET_SESSION_COOKIE
Checks for the session cookie and sets it if it does not exist. The default session cookie name is NetInsightSessionID. You can specify a different cookie name using the NTPT_SESSION_COOKIE_NAME variable. If you do not set this variable, it defaults to false. Syntax
var NTPT_SET_SESSION_COOKIE = [true,false];
Example
NTPT_FIELDS
An object variable that specifies the fields that will be included in the default page tag. Fields set to true will be included in the page tag. Fields set to false will not be included. In most cases, you should use the default field settings. Every page tag should include the lc field. Syntax
var NTPT_FLDS = new Object(); NTPT_FLDS.lc = [true,false]; // NTPT_FLDS.rf = [true,false]; // NTPT_FLDS.rs = [true,false]; // NTPT_FLDS.cd = [true,false]; // NTPT_FLDS.ln = [true,false]; // NTPT_FLDS.tz = [true,false]; // NTPT_FLDS.jv = [true,false]; // NTPT_FLDS.iv = [true,false]; // NTPT_FLDS.ck = [true,false]; //
Document location Document referrer User's screen resolution User's color depth Browser language User's timezone Browser's Java support Initial view Allow capture of cookie values
Example
var NTPT_FLDS = new Object(); NTPT_FLDS.lc = true; // Document location NTPT_FLDS.rf = true; // Document referrer NTPT_FLDS.rs = true; // User's screen resolution NTPT_FLDS.cd = true; // User's color depth NTPT_FLDS.ln = true; // Browser language Version 8.2.1 115
= = = =
true; // User's timezone true; // Browser's Java support false; // Initial view true; // Allow capture of cookie values
NTPT_MAXTAGWAIT
The maximum number of seconds that a call to ntptLinkTag() or ntptSubmitTag() will wait before following the link or submitting the form. The delay is intended to ensure that the page tag request is sent before the tagged page is unloaded. The event will be executed when the page tag request is returned or the specified number of seconds has elapsed, whichever happens first. Syntax
var NTPT_MAXTAGWAIT = number;
Possible values
Value Any number greater than 0 Description The number of seconds to wait before following the link or form submission Execute the event immediately, without waiting
-1
Examples
var var var var
N730001
= = = =
1; // one second 2.5; // two and a half seconds 0.1; // a tenth of a second -1; // no delay
About optional global variables NTPT_HTTPSIMGSRC NTPT_GLBLEXTRA NTPT_GLBLREFTOP NTPT_GLBLCOOKIES NTPT_SET_IDCOOKIE NTPT_IDCOOKIE_NAME NTPT_IDCOOKIE_EXPIRE NTPT_IDCOOKIE_DOMAIN NTPT_SESSION_COOKIE_NAME NTPT_SET_SESSION_COOKIE
Unica NetInsight - Administrator's Guide
116
Reference
NTPT_HTTPSIMGSRC
The URL of the page tag image to use when the tagged page is accessed using the https: protocol. Syntax
var NTPT_HTTPSIMGSRC = 'image';
Example
var NTPT_HTTPSIMGSRC = 'https://mysite.com/images/ntpagetag.gif';
N7A0001
NTPT_GLBLEXTRA
A query modifier that will be applied to every page tag and event tag. The query modifier should contain the key-value pairs you want to add to or delete from the query string for your tags. Syntax
var NTPT_GLBLEXTRA = 'key=value';
Example
// Append the 'sitetheme=blue' pair to every page tag. var NTPT_GLBLEXTRA = 'sitetheme=blue';
N7B0001
NTPT_GLBLREFTOP
Retrieve the referrer (the value for the rf field) from the top (that is, the most containing) frame of the current page. Otherwise, the referrer is retrieved from the current page. If you do not set this variable, it defaults to false. Syntax
var NTPT_GLBLREFTOP = [true,false];
Example
var NTPT_GLBLREFTOP = true;
N7C0001
Version 8.2.1
117
NTPT_GLBLCOOKIES
An array of customer-set cookies set globally to be captured by the page tagging script. Syntax
var NTPT_GLBLCOOKIES = [ ];
Example
var NTPT_GLBLCOOKIES = ["cookie1", "cookie2"];
N7D0001
NTPT_SET_IDCOOKIE
Tells the page tagging script to set the visitor identification cookie. Syntax
var NTPT_SET_IDCOOKIE = [true, false];
Example
var NTPT_SET_IDCOOKIE = true;
N7E0001
NTPT_IDCOOKIE_NAME
Sets the name of the visitor identification cookie. Syntax
var NTPT_IDCOOKIE_NAME = "";
Example
var NTPT_IDCOOKIE_NAME = "unique_visitor";
N7F0001
NTPT_IDCOOKIE_EXPIRE
The expiration time (in seconds) of the visitor identification cookie. If not specified the value defaults to 155520000 (60 months). Syntax
var NTPT_IDCOOKIE_EXPIRE = number;
Possible values
118
Reference Value Any number Description The number of seconds until the cookie expires
Examples
var NTPT_IDCOOKIE_EXPIRE = 315360000; // 10 years
N800001
NTPT_IDCOOKIE_DOMAIN
Specifies the domain suffix for the visitor identification cookie. This allows customers with more than one site within the same domain to use a single version of the visitor identifaction cookie, allowing you to track cross-site visits/visitors. For example, if your site uses the subdomains www.mydomain.com, info.mydomain.com, and support.mydomain.com, you can ensure they use the same identification cookie by specifying an NTPT_IDCOOKIE_DOMAIN value of ".mydomain.com" Syntax
var NTPT_IDCOOKIE_DOMAIN = "";
The domain suffix specified as the value must include at least two periods (see example). The domain suffix must be the same domain that sends the cookie. For example, you may not set a cookie for abc.com if your server's domain is mydomain.com.
Example
var NTPT_IDCOOKIE_DOMAIN = ".mydomain.com";
N810002
NTPT_SESSION_COOKIE_NAME
Sets the name of the session cookie. If this variable is not set, the name of the cookie defaults to NetInsightSessionID. Syntax
var NTPT_SESSION_COOKIE_NAME = " ";
Example
Version 8.2.1
119
NTPT_SET_SESSION_COOKIE
Checks for the session cookie and sets it if it does not exist. The default session cookie name is NetInsightSessionID. You can specify a different cookie name using the NTPT_SESSION_COOKIE_NAME variable. If you do not set this variable, it defaults to false. Syntax
var NTPT_SET_SESSION_COOKIE = [true,false];
Example
Page-specific variables
N74000A
About page-specific variables Where to put page-specific variables NTPT_PGEXTRA NTPT_PGREFTOP NTPT_NOINITIALTAG NTPT_PGCOOKIES
NTPT_PGEXTRA
A list of field-value pairs that will be applied to the page tag for the current page. To delete a field from the page tag, set it to an empty value. Although you can add any field-value pair, some fields are recognized automatically by Unica NetInsight and do not require you to create a parameter in order for them to appear in Unica NetInsight reports. Syntax
120
Example
// Append the 'pagetheme=red' pair. Drop the 'rf' field. var NTPT_PGEXTRA = 'pagetheme=blue&rf='; // Treat this page as a 404 (Not Found) error. var NTPT_PGEXTRA = 'sc=404';
N840001
NTPT_PGREFTOP
Retrieve the referrer (the value for the rf field) from the top (that is, the most containing) frame of the current page. Otherwise, the referrer is retrieved from the current page. Syntax
var NTPT_PGREFTOP = [true,false];
Example
var NTPT_PGREFTOP = true;
N850001
NTPT_NOINITIALTAG
This variable can be set at both the global and page level. Its default is false. When set to true at the global level, it stops the page tag script from collecting initial page load data for all pages. When set to true at the page level, it stops the page tag script from collecting initial page load data for the current page. For On Premise deployments, preventing the page tag script from collecting initial page load data is useful in augment mode (where data is collected from both page tags and logs) as it prevents duplicate data from being collected. Event tags for pages will still be sent. Syntax
var NTPT_NOINITIALTAG = [true,false];
Example
var NTPT_NOINITIALTAG = false;
N860001
NTPT_PGCOOKIES
An array of customer-set cookies for a specific page to be captured by the page tagging script. Syntax
Version 8.2.1
121
Example
var NTPT_PGCOOKIES = ["cookie1", "cookie2"];
N750001
ntptAddPair
Add the specified key-value pair to the query string of the next event tag to fire. If the key already exists in the query string, the value will be replaced. If the value is empty (), the key will be dropped. Syntax
ntptAddPair( key, value ) Argument key value Description The name of a name-value pair to add to the next event tag to fire. The value of a name-value pair to add to the next event tag to fire.
Example
ntptAddPair( "color", "red" );
N870001
ntptDropPair
Drop the specified key-value pair from the query string of the next event tag to fire. Syntax
ntptDropPair ( key )
Argument key
Description The name of a name-value pair to drop from the next event tag to fire.
122
Reference
Example
ntptDropPair( tmpargs[0] );
N880001
ntptEventTag
Fires an event tag using the working query string. This function should be called from a document elements event handler. Syntax
ntptEventTag ( [querymod] )
Argument querymod
Description A query modifier for the event tag. It modifies the working query string for the page tag.
Example
ntptEventTag( "ev=pickcolor" );
N890001
ntptLinkTag
Tags a link that would otherwise not be accessible to page tagging. These links include downloads, non-HTML pages, and pages on other Web sites. This function must be called from the onclick attribute of a link and should return the value of the function to the onclick handler. Link tags are not modified by the NTPT_PGEXTRA variable. Syntax
ntptLinkTag ( linkobj [, querymod [, maxtagwait]] )
Argument linkobj
Description A link object. The keyword "this" tells the function to follow the link after tagging it. A query modifier for the link tag. It modifies the working query string for the page tag. The maximum number of seconds that the call will wait before following the link. This overrides the global wait time specified by NTPT_MAXTAGWAIT.
querymod
maxtagwait
Example
Version 8.2.1 123
ntptSubmitTag
Tags form submissions. This function must be called from the onsubmit attribute of a form and must return the value of the function to the onsubmit handler. Syntax
ntptSubmitTag( formobj [, querymod [, maxtagwait]] )
Argument formobj
Description A form object. The keyword this tells the function to submit the form after tagging it. A query modifier for the submit tag. It modifies the working query string for the page tag. The maximum number of seconds that the call will wait before submitting the form. This overrides the global wait time specified by NTPT_MAXTAGWAIT.
querymod
maxtagwait
Example
return ntptSubmitTag( document.myform );
124
N10370
About reporting options Specifying auto-updated reports Creating custom metrics Extending the data model Creating filter groups Accessing geographic data Configuring integration models Specifying the date range of pre-generated reports Specifying reportability of dimensions Specifying the sample size
Version 8.2.1
125
About auto-updating
Auto-updating reports are generated every time the profile is updated. In general, you want a report to update automatically if all of the following are true: You are frequently importing data for the report's time frame into the profile. You need to see the report on a regular basis. You would like the report to be available instantly.
Reports with relative time frames (for example, yesterday or current month) should generally be set to update automatically. You can save time by not auto-updating the report if either of the following are true: The report is for a fixed time frame in the past for which all the data has been imported. You need to see the report infrequently and can run it ad-hoc.
All of the reports that appear in the Available Reports list on the Reports tab by default are set to update automatically. Reports you create only update automatically if you select one of the auto-update check boxes when you save the report. You can manage which reports are auto-updated at the Auto-Updated Reports option screen. (This screen is only available at the profile options. You cannot access it from the default profile options.)
5. If sampling is enabled for the profile, the initial set of lists controls auto-updating for Full reporting mode. To specify auto-updating for reports running in Sampled mode, click Edit Sample Reports Reports.
N8D0001
About custom metrics To create a custom filtered metric To create a multiple input custom metric To edit a custom filtered metric To edit a multiple input custom metric To delete a custom metric
N960001
The title appears in lists of metrics. It is also the basis for the title of the column containing the metric data. 8. In the Description field, enter a description for the metric. The description is the explanation of the metric's column that appears in the page help for the report. 9. From the Base metric list, select the metric that provides the data to be filtered for the current metric. 10. Check the Graphable field to have the data from this metric to be available for graphing in the report graph. 11. Check the Display percentage of total field to have a percentage to display in the column as well as a number. 12. From the Alignment list, select how the values are aligned in the report column. The options are Center, Left, and Right. 13. In the Minimum twips field, enter the minimum number of twips for the metric's column in reports. A twip equals 1/1440 of an inch. This option affects only those reports that are exported in RTF format (usually for use in Microsoft Word). 14. In the Recommended twips field, enter the recommended number of twips for the metric's column in reports. Unica NetInsight tries to make the column the recommended width. 15. Click Continue Continue. The Filters for . . screen opens. 16. Add one or more filters or filter groups to the custom metric. a. Click Add Add. The Available filters screen opens. b. Select a dimension, or to add a defined filter group, select Filter Group Group. c. Click Continue Continue. If you select a dimension, the Filter description screen opens. If you select Filter Group a list of defined filter groups open. Group, d. Complete the screen as required: If you selected a string dimension, select that or that do not from the first list. Then select a matching type from the second list. Then enter a string in the field, or select a value from the Or select from this menu list.
128
If you selected a numeric dimension, select a value from the list. If you selected Filter Group select the filter group to use. Group,
Unica NetInsight - Administrator's Guide
Click Add as Group to add the complete filter group, so you are not able to remove individual filters from the custom metric. Or click Add as Filters to add all filters from the group individually, so you can delete filters from the custom metric. e. Click Continue Continue. f. Repeat steps a through e until you have added all required filters.
g. Click Continue Continue. The custom metric is now available on the Metrics page of the Custom Report Wizard Wizard. To make the custom metric available on the Discovery Panel you must add it to a Panel, group in one or more metrics lists.
N970001
Version 8.2.1
129
11. From the Operation list, select the operation you want to use to combine the two metrics. 12. If you selected a floating point operation, select the number of decimal places to use from the Precision list. 13. Check the Graphable field to have the data from this metric to be available for graphing in the report graph. 14. Check the Display percentage of total field to have a percentage to display in the column as well as a number. 15. From the Alignment list, select how the values are aligned in the report column. The options are Center Left and Right Center, Left, Right. 16. In the Minimum twips field, enter the minimum number of twips for the metric's column in reports. A twip equals 1/1440 of an inch. This option only affects reports that are exported in RTF format (usually for use in Microsoft Word). 17. In the Recommended twips field, enter the recommended number of twips for the metric's column in reports. Unica NetInsight tries to make the column the recommended width. 18. Click Continue Continue. The custom metric is now available on the Metrics page of the Custom Report Wizard Wizard. To make the custom metric available on the Discovery Panel you must add it to a Panel, group in one or more metrics lists.
N980001
130
The description is the explanation of the metrics column that appears in the page help for the report. 7. From the Base metric list, select the metric that provides the data to be filtered for the current metric. 8. Check the Graphable field to have the data from this metric to be available for graphing in the report graph. 9. Check the Display percentage of total field to have a percentage to display in the column as well as a number. 10. From the Alignment list, select how the values are aligned in the report column. The options are Center, Left, and Right. 11. In the Minimum twips field, enter the minimum number of twips for the metric's column in reports. A twip equals 1/1440 of an inch. This option affects only reports that are exported in RTF format (usually for use in Microsoft Word). 12. In the Recommended twips field, enter the recommended number of twips for the metric's column in reports. Unica NetInsight tries to make the column the recommended width. 13. Click Continue Continue. The Filters for . . screen opens. 14. Add one or more filters or filter groups to the custom metric as necessary. a. Click Add Add. The Available filters screen opens. b. Select a dimension, or to add a defined filter group, select Filter Group Group. c. Click Continue Continue. If you select a dimension, the Filter description screen opens. If you select Filter Group a list of defined filter groups open. Group, d. Complete the screen as required: If you selected a string dimension, select that or that do not from the first list. Then select a matching type from the second list. Then enter a string in the field, or select a value from the Or select from this menu list. If you selected a numeric dimension, select a value from the list. If you selected Filter Group select the filter group to use. Group, Click Add as Group to add the complete filter group, so you are not able to remove individual filters from the custom metric. Or click Add as Filters to add all filters from the group individually, so you can delete filters from the custom metric.
Version 8.2.1 131
e. Click Continue Continue. f. Repeat steps a through e until you have added all required filters.
g. Click Continue Continue. 15. Edit filters or filter groups as necessary. a. Select the filter or filter group to edit. b. Click Edit Edit. If you select a dimension, the Filter description screen opens. If you select Filter Group a list of defined filter groups open. Group, c. Complete the screen as required: If you selected a string dimension, select that or that do not from the first list. Then select a matching type from the second list. Then enter a string in the field, or select a value from the Or select from this menu list. If you selected a numeric dimension, select a value from the list. If you selected Filter Group select the filter group to use. Group, Click Add as Group to add the complete filter group, so you are not able to remove individual filters from the custom metric. Or click Add as Filters to add all filters from the group individually, so you can delete filters from the custom metric. d. Click Continue Continue. e. Repeat steps a through e until you have edited all required filters. f. Click Continue Continue.
16. Delete filters or filter groups as necessary. a. Select the filter or filter group to delete. b. Click Delete Delete. 17. Click Continue Continue. The updated custom metric is now available on the Metrics page of the Custom Report Wizard Wizard. To make the custom metric available on the Discovery Panel you must add it to a Panel, group in one or more metrics lists.
N990001
3. Select the multiple input custom metric to edit. 4. Click Edit Edit. The Custom metric definition screen opens. 5. In the Title field, edit a title for the metric. The title appears in lists of metrics. It is also the basis for the title of the column containing the metric data. 6. In the Description field, edit the description for the metric. The description is the explanation of the metrics column that appears in the page help for the report. 7. From the Metric 1 list, select the first metric to combine. If you are dividing metric values, Metric 1 is the number that is divided. 8. From the Metric 2 list, select the second metric to combine. If you are dividing metric values, Metric 2 is the number that is divided by 9. From the Operation list, select the operation you want to use to combine the two metrics. 10. If you selected a floating point operation, select the number of decimal places to use from the Precision list. 11. Check the Graphable field to have the data from this metric to be available for graphing in the report graph. 12. Check the Display percentage of total field to have a percentage to display in the column as well as a number. 13. From the Alignment list, select how the values are aligned in the report column. The options are Center Left and Right Center, Left, Right. 14. In the Minimum twips field, enter the minimum number of twips for the metric's column in reports. A twip equals 1/1440 of an inch. This option only affects reports that are exported in RTF format (usually for use in Microsoft Word). 15. In the Recommended twips field, enter the recommended number of twips for the metric's column in reports. Unica NetInsight tries to make the column the recommended width. 16. Click Continue Continue. The custom metric is now available on the Metrics page of the Custom Report Wizard Wizard. To make the custom metric available on the Discovery Panel you must add it to a Panel, group in one or more metrics lists.
N9A0001
Version 8.2.1
133
About the data model About extending the data model To add a data model extension package About deleting or editing data model extension packages
134
About filter groups To create a filter group To edit a filter group To edit filters for a filter group To delete a filter group
136
g. Click Save Filters Filters. 8. Click Continue Continue. You must now apply the filter group to a report.
N9F0001
If you selected a string dimension, select that or that do not from the first list.
137
Then select a matching type from the second list. Then enter a string in the field, or select a value from the Or select from this menu list. If you selected a numeric dimension, select a value from the list. If you selected Filter Group select the filter group to use. Group, Click Add as Group to add the complete filter group, so you are not able to remove individual filters from the custom metric. Or click Add as Filters to add all filters from the group individually, so you can delete filters from the custom metric. e. Click Continue Continue. f. Repeat steps a through e until you have added all required filters.
g. Click Continue Continue. 6. Edit filters or filter groups as necessary. a. Select the filter or filter group to edit. b. Click Edit Filter Filter. If you select a dimension, the Filter description screen opens. If you select Filter Group a list of defined filter groups opens. Group, c. Complete the screen as required: If you selected a string dimension, select that or that do not from the first list. Then select a matching type from the second list. Then enter a string in the field, or select a value from the Or select from this menu list. If you selected a numeric dimension, select a value from the list. If you selected Filter Group select the filter group to use. Group, Click Add as Group to add the complete filter group, so you are not able to remove individual filters from the custom metric. Or click Add as Filters to add all filters from the group individually, so you can delete filters from the custom metric. d. Click Continue Continue. e. Repeat steps a through e until you have edited all required filters. f. Click Continue Continue.
7. Delete filters or filter groups as necessary. a. Select the filter or filter group to delete. b. Click Delete Filter Filter. 8. Click Back to Filter Groups Groups.
NA10001
138
About the NetInsight geographic database To configure a profile to use the geographic database
After you update your profile, select Reports > Geographic Analysis to access the geographic reports. If you do not have the correct version of the geographic database for your version of NetInsight, you will receive an error when you attempt to update the profile. See the NetInsight Geographic Database page on Unica Customer Central for the latest version.
N910001
About integrations To configure a profile to use an integration module To edit an integration module To delete an integration module Paid search integration fields Privileges for integrations
About integrations
Integration modules enable you to incorporate data from another source into NetInsight using a commercially available module (as opposed to a lookup or rewrite data conduit, which you must create). Your Unica NetInsight license must be enabled for an integration module before you can use it. An integration module must be configured in each profile in which you want to use it.
NA30001
7. Click Save Options Options. If you have entered connection information, Unica NetInsight contacts the appropriate server to validate your information.
NA40001
Username
Version 8.2.1
141
6 - Configuring Reporting Options Field Password Description Password for your company's Unica paid search integration account Password for your company's Unica paid search integration account
Re-enter password
NA70001
About report generation options About aggregate data To edit dates for which reports are pre-calculated To edit dates for which aggregate data is generated
142
Or, to set defaults for all new profiles, select the Administration icon ( )> Options tab, then from the Unica NetInsight options drop-down menu, select Edit Default Web Server Options Options. 2. For Generate reports for select one or more of the following in any combination: To pre-calculate reports for all months, check All Months Months. To pre-calculate reports for a specific time period (for example years, months, weeks) check its box and enter a value.
Latest is relative to the last date for which the profile contains data, not the current date.
NAA0002
Version 8.2.1
143
Or, to set defaults for all new profiles, select the Administration icon ( )> Options tab, then from the Unica NetInsight options drop-down menu, select Edit Default Web Server Options Options. 2. For Generate aggregates for select None All Data or specify a time period. None, Data, Unless you have a specific performance reason to do otherwise, a general rule is to generate aggregates for the same time frame that you pre-generate reports. Latest is relative to the last date for which the profile contains data, not the current date.
N930001
144
Making a non-reportable dimension reportable again will automatically enable any reports that did not previously display in a report list, if that report now contains only reportable dimensions. You can make some, but not all, dimensions in a dimension hierarchy nonreportable, as doing so can cause errors when users view reports for the dimension hierarchy. 1. While working with the profile, click Options Options. 2. In the Options panel, under Reporting click Reportable Dimensions Reporting, Dimensions. The Dimensions to be reported screen opens. 3. To make a currently reportable dimension non-reportable, in the Reportable Dimensions list, select the dimension and click Add dimension (the left-pointing arrow). The dimension moves to the Available dimensions list. 4. To make a currently non-reportable dimension reportable, in the Available Dimensions list, select the dimension and click Add dimension (the right-pointing arrow). The dimension moves to the Reportable dimensions list. 5. Click Save Options then Continue Options, Continue.
N940001
About data samples To specify the sample size Permissions for sampling features
Version 8.2.1
Looks for any new visits by visitors already in the sample and adds information about those visits to the sample tables.
Spider and robot visitors also are sampled at the specified percentage. After you specify a profile's visitor sample percentage for the first time, update the profile to make sample reports available. If you are changing an existing non-zero sample percentage, run the - resample command-line option followed by the recalc -sampleonly command-line option to update the sample tables and reports.
146
You can specify up to three decimal places to the right of the decimal point. Use a value of zero to disable sampling (not generate any sample tables or reports). 5. Click Save Options Options. If this is the first time a sample size has been entered for the profile, you must update the profile before users can select a reporting mode. If you have changed an existing sample value, you must run the -resample command-line option followed by the recalc -sampleonly option to use the new sample size. Any previous sample data is used until the profile is resampled.
NAD0001
Interface: Custom Report Wizard: Auto Update Sample Report Interface: Custom Report Wizard: Auto Update Full Report
Version 8.2.1
147
N1044C
About creating reports To create a standard report Creating a crosstab report To create a trend report Creating a custom dashboard Creating a path summary Creating a scenario report Specifying a time frame Specifying dimensions Specifying metrics Creating an A/B report Creating a comparative report To save a customized report Changing the content of a report
Standard reports (including crosstab reports and Path Summaries to, from, and between specific pages) Custom dashboards Scenario reports
Unica NetInsight - Administrator's Guide
Trend reports
You can create reports using one of several methods: Customizing an existing report Defining a new report
The instructions for creating the reports vary depending on the method you are using and the type of report you are creating. However, regardless of type, Unica NetInsight displays the Report Summary page where you can edit, filter, run, save, export, and archive the report.
NAF0001
a. Click the Report Designer icon ( The Report Summary opens. b. Click Edit Edit. c. Continue with the steps below. At step 5, enter a new Report title title.
).
2. If you want to create a report for a fixed time frame, click the Calendar icon to display the calendar and specify the time frame whose data you want included in the report. a. To keep the results grouped by the specified time period even when the time period of the calendar changes, check Retain grouping when calendar changes changes. 3. Select the dimensions you want included in the report, then click Continue Continue. To create a crosstab report, select two or more dimensions. 4. Select the metrics you want included in the report, then click Continue Continue. You must have at least one metric.
Version 8.2.1
149
7 - Creating Reports
5. Enter the general report information, then click Continue Continue. The Filters screen opens. 6. Specify any filters you want applied to the report, then click Continue Continue. If you want to create a report for a relative time frame, create a date filter that specifies the time frame. The A/B Groups screen opens. 7. If you want to apply two sets of filters and compare the results, enter the two groups of filters, then click Continue Continue. The Report Summary page opens. You may now Run this report.
NB00002
150
When you create a crosstab report, you can view path charts, 3-D bar charts, and stacked bar charts that display the primary and secondary dimensions and one metric. By default, the left-most metric in the report is displayed but you can choose any metric in the report to graph.
NBC0002
> Edit
2. If you want to create a report for a fixed time frame, click the Calendar icon and use the calendar to specify the time frame. 3. Select the dimensions you want then click Continue You can add up to five Continue. dimensions. The dimension at the top of the list is the primary dimension for the report. 4. Select the metrics you want then click Continue You must select at least one Continue. metric. 5. Select the method by which you want to group the results in the report.
Version 8.2.1
151
7 - Creating Reports
Select All Dimensions with Totals to rank entries by the primary dimension value. (Secondary dimensions are ranked within each primary dimension value.) For each metric, a value is displayed for each secondary dimension; a total is shown for each primary dimension. Select All Dimensions to rank entries by the primary dimension value. (Seconday dimensions are ranked within each primary dimension value.) For each metric, a value is displayed for secondary dimensions but not for the primary. Select No Grouping to rank entries by each primary/secondary value combination. (Different secondary values for the same primary value may not appear next to each other on the report.)
The remaining options depend on whether you chose to group results. If you selected one of the grouping options, select the number of primary values per report page and secondary values per primary value. If you selected No Grouping select the number of rows you want per report Grouping, page.
6. Click Continue Continue. 7. Specify any filters you want on the report. If you want to create a report for a relative time frame, create an appropriate date filter. Click Continue Continue. 8. If you want to apply two sets of filters and compare the resulting reports, enter the two groups of filters, then click Continue Continue. The Report Summary page opens. You can now run or save the report.
NB10001
In the Group results by list, select the time period to group results by. To keep the results grouped by the specified time period even when the time period of the calendar changes, check Retain grouping when calendar changes changes.
Unica NetInsight - Administrator's Guide
8. Click Continue Continue. The Filters screen opens. 9. Specify any filters you want applied to the report, then click Continue Continue. If you want to create a report for a relative time frame, create a date filter that specifies the time frame. The A/B Groups screen opens. 10. If you want to apply two sets of filters and compare the resulting reports, enter the two groups of filters, then click Continue Continue. The Report Summary page opens. You can now Run this trend report.
NB20001
About dashboards To create a dashboard To create a graph dashboard section To create a text dashboard section To create a table dashboard section
About dashboards
Dashboards allow you to collect together relevant, key charts and textual data that can help you better monitor and understand your business on an ongoing basis. You can create an unlimited number of focused, subject-area reports displaying your key performance indicators (KPIs). You can create separate dashboards for different individuals or roles within your organization. You can filter dashboards to report only on the data that is relevant for the viewer. You can create and manage dashboards, which are collections of charts and data from reports within your profile. Profiles containing the dashboards can then be scheduled to update on a regular, periodic basis to consistently deliver up-to-date information. You can set up email tasks to automatically email dashboard reports to interested parties. You can also configure email alerts to send email to the appropriate people when a KPI exceeds some threshold.
7 - Creating Reports
Data fields in text sections can be one of the following types: AverageDisplays the average value for the specified metric for the specified time period. TotalDisplays the sum of all values for the specified metric. TopDisplays the dimension value from the specified dimension with the highest value for the specified metric. BottomDisplays the dimension value from the specified dimension with the lowest value for the specified metric.
Table sections contain an entire report in tabular format, consisting of one dimension and one metric. You can use any report, including a crosstab report, as the data source for the table section; however, only the primary dimension of a crosstab report will be displayed in the table section.
NBD0001
To create a dashboard
You can create a dashboard within the profile you are viewing. 1. Click the Custom tab. The Managing Reports screen opens. 2. Click Create Report Report. 3. Select Define a new report then Dashboard report, Dashboard. 4. Click Continue Continue. 5. If you want to create a report for a fixed time frame, click the Calendar icon and use the calendar to specify the time frame. You can specify a relative time frame using date filters later in the process. 6. Specify each section in the dashboard by doing one of the following: You can edit a section by selecting it and clicking Edit You can delete a section by Edit. selecting it and clicking Delete Delete. a. Create a graph dashboard section b. Create a text dashboard section c. Create a table dashboard section d. Use a dashboard section from an existing dashboard 7. Arrange the sections the way you want them to appear in the dashboard, then click Continue Continue. Select a section and use the up and down arrow keys to move it up and down in the current column, and use the left and right arrows to move the section from one column to another. 8. Enter a report title, then click Continue Continue.
154
9. Specify any filters you want applied to the report, then click Continue Continue. If you want to create a report for a relative time frame, create a date filter that specifies the time frame. The A/B Groups screen opens. 10. If you want to apply two sets of filters and compare the resulting reports, enter the two groups of filters, then click Continue Continue. By default, the two groups are named Group A and Group B. You can change the names. The Report Summary page opens. You can now Run Save Email Archive or Export this dashboard report. Run, Save, Email, Archive,
NBE0001
7 - Creating Reports
The Adding a Section screen opens. 2. In the Section title field, enter the text you want to label this section in the dashboard. If you leave this field blank, Unica NetInsight will use the name of the report entered in the Section links field as the section title. 3. In the Section type list, select Text Text. The remaining options on the page change. 4. In the Section links field, select the report to display when users click the section heading on the dashboard. Now you need to add the fields you want in the section. 5. Click Add Add. The Adding a Field screen appears. 6. In the Field title box, enter a title for the field. If you leave this field blank, Unica NetInsight uses the name of the report entered in the Report link field as the name of the field title. 7. In the Field type box, select a field type. The remaining options on the page may change depending on the field type you select. 8. Specify how to determine the value for the field using the options below that are appropriate for the field type: a. Time period (Average fields)the time period to use to determine the average. b. Metric (Total, Average and Top fields)the metric to supply the value for the field. c. Dimension (Top and Bottom fields)the dimension to supply the value. d. Order by (Top and Bottom fields)the metric to use to determine the top or bottom value for the specified dimension. 9. In the Report link box, select the report to display when users click the fields value in the dashboard. 10. Click Continue to add the field to the section. 11. Continue creating fields until you have created all the fields you want for this section. Fields appear in the dashboard section in the order they appear in the Fields list. You can use the Move Up and Move Down arrows to arrange the fields in the desired order. You can edit or delete a field by selecting it in the Fields list and clicking Edit or Delete Delete. 12. When the Fields list is complete, click Continue Continue.
NC00002
156
To create a Path Summary between two specific pages To create a Path Summary from a specific page To create a Path Summary to a specific page
Version 8.2.1
157
7 - Creating Reports
16. In the Graph data set list, select the type of data you want to display in the graph. 17. In the Page help box, enter the text you want to use as the introduction paragraph to the page help for the report. 18. Click Continue The Filters page appears. Continue. 19. Specify any filters you want applied to the report. 20. If you are creating a report for a relative time period, specify a date filter that defines the time period. 21. Click Continue Continue. The A/B Groups page appears. 22. If you want to see the report data for two sets of filters, specify the filter sets. 23. Click Continue Continue. The Report Summary page appears.
NC20001
7 - Creating Reports
10. In the Style of report list, select an option. Select Linear view to create a report that lists each path away from the origination page from start to finish. Paths are sorted according to the metric values for the path as a whole. Select Tree view to create a report that lists the first page in each path away from the origination page. You can expand each row to show the most popular second pages in paths that started on the origination page and went through the first-level page listed in the row. It is called a tree view because the origination page can be pictured as a tree trunk with the first-level pages as primary branches and the second-level pages as secondary branches.
11. In the Number of rows per page list, select the number of rows you want per page of the report. 12. In the Number of pages per row list, select the number of second-level pages that will be listed for each first-level page listed in the report. This option is not available if the Style of report option is set to Linear View View. 13. In the Maximum length of path list, select the maximum number of pages that can be in the paths you track. Paths will be truncated to fit this maximum. (This option is not available if the Style of report option is set to Tree view view.) 14. In the Column to sort by list, select the name of the column by which you want to rank items in the report. 15. In the Sort order list, select either Ascending or Descending Descending. 16. In the Type of graph list, select the graph format you want to use. If the Style of report option is set to Tree view the Type of graph list will contain the view, additional graph type Path chart chart. 17. In the Graph data set list, select the type of data you want to display in the graph. 18. In the Page help box, enter the text you want to use as the introduction paragraph to the page help for the report. 19. Click Continue Continue. The Filters page appears. 20. Specify any filters you want applied to the report. 21. If you are creating a report for a relative time period, specify a date filter that defines the time period. 22. Click Continue Continue. The A/B Groups page appears. 23. If you want to see the report data for two sets of filters, specify the filter sets. 24. Click Continue Continue. The Report Summary page appears.
160 Unica NetInsight - Administrator's Guide
12. In the Number of rows per page list, select the number of rows you want per page of the report. 13. In the Number of pages per row list, select the number of second-to-last pages to be listed for each next-to-last page listed in the report. This option is not available if the Style of report option is set to Linear View View. 14. In the Maximum length of path list, select the maximum number of pages that can be in the paths you track.
Version 8.2.1 161
7 - Creating Reports
Paths will be truncated to fit this maximum. (This option is not available if the Style of report option is set to Tree view view.) 15. In the Column to sort by list, select the name of the column by which you want to rank items in the report. 16. In the Sort order list, select either Ascending or Descending Descending. 17. In the Type of graph list, select the graph format you want to use. If the Style of report option is set to Tree view the Type of graph list will contain the view, additional graph format Path chart chart. 18. In the Graph data set list, select the type of data you want to display in the graph. 19. In the Page help box, enter the text you want to use as the introduction paragraph to the page help for the report. 20. Click Continue The Filters page appears. Continue. 21. Specify any filters you want applied to the report. 22. If you are creating a report for a relative time period, specify a date filter that defines the time period. 23. Click Continue Continue. The A/B Groups page appears. 24. If you want to see the report data for two sets of filters, specify the filter sets. 25. Click Continue Continue. The Report Summary page appears.
NB40002
4. For each step in the report, add either a single visitor profile or one or more pages or page filters. To add a visitor profile to a step: a. Click the Visitor Profiles tab. b. Click the visitor profile you want to add. c. Click a step to select it. d. Click Click Add to Selected Step Step. To add a single page to a step: a. Click the Search Pages tab. b. Enter search criteria for the page you want to apply and click Search Search. c. From the Results list, select the page you want. d. Click a step to select it. e. Click Add to Selected Step Step. To add a page filter to a step: a. Click the Page tab. b. Select a matching criteria (for example, that starts with, that do not contain). c. Enter a matching string or make a selection from the Select a Page list. d. Click a step to select it. e. Click Add to Selected Step Step. When you add multiple page filters to a step, those with identical settings for both that/that do not AND match type are logically ORed together. If their settings are not identical they are logically ANDed. For example, the filters that match mypage.htm and that match yourpage.htm will be logically ORed. The filters that start with mypage and that contain yourpage will be logically ANDed. Pages added using the Search Pages tab function as positive exact matches and therefore are logically ORed. 5. If necessary, you can reorganize your steps as follows: To re-order a step, click its Arrow button and drag it to a new position. To delete a step, click its X button. To reset all steps to their value as of the last save, click Reset Steps Steps. To clear all steps of values, click Clear Clear.
6. Optionally, you can require that each step in the report must be completed in a single visit. 7. Click Continue Continue.
Version 8.2.1 163
7 - Creating Reports
8. In Report description description: Enter a unique title for the report. Select the type of graph you want (funnel is a common format for scenario reports). Select which report metric you want the graph to display. The list contains all of the report's "graphable" metrics. To use All Columns the graph type must be a bar or line chart. Optionally, In Page help enter explanatory text. It will display below the report help, when it is viewed.
9. Click Continue At this point you can save, run, email, or perform other actions on Continue. the report. You can also add filters, metrics, apply A/B filters, or change any of the options you selected in previous steps.
NC40002
164
Note that scenario reports do not track the actual order in which visitors perform steps. For each step, they simply report how many visitors performed both that step and all preceding steps within the report's date range. So a visitor who performs a third step before a second will still be counted in the scenario report as long as the step was performed in the correct time frame.
Version 8.2.1
7 - Creating Reports
If you see unexpected results It is possible to have a report with visit counts that increase from step to step rather than decrease as expected. This can occur when a higher percentage of visits match the filters for the later steps (something especially likely with view-based filters). It is also possible for visitor counts to change based on the current calendar setting. For example, suppose your scenario has two steps and you use the calendar to display the data for July, then August. Joe completes step one in July and step two in August. Joe will be included in the July report because he completed step one in that time frame. But he but will not be included in the August report because he only completed step two in that time period, not both as required. If you were to restore the calendar view to View All you would see Joe included in the report for both steps.
NB50001
About time frames To specify a fixed time frame using the calendar To specify a relative or fixed time frame using a date filter
166
Data for a range of days in the month, click the first date in the range, press the Shift key and hold it down while you click the last date in the range. (If a month is not displayed in the calendar, first click View Month Month.) Data for an entire week, click the arrow to the right of the week. (If a month is not displayed in the calendar, first click View Month Month.) Data for a range of days that includes dates in multiple months, click View Custom enter a From and a To date, and click Apply Calendar (Note: You must Custom, Calendar. Note: enter dates in the form mm/dd/yyyy. The year must have four digits.) Data for all dates on the currently visible calendar that fall on a certain day of the week (for example, all the Mondays), click the column header for that day of the week. (If a month is not displayed in the calendar, first click View Month Month.) Data for multiple days of the week (for example, all the Sundays and all the Saturdays in the currently visible calendar), hold down the Ctrl key (Option key Option on a Macintosh) while clicking the column headers for the days of the week you want. (If a month is not displayed in the calendar, click View Month Month.) Data for the entire month, click View Month Month. Data for the quarter, click View Quarter Quarter. Data for the year, click View Year Year. All the data, click View All All. A different month in the calendar, click the arrows to either side of the month name. (If a month is not displayed in the calendar, first click View Month Or, Month.) click the name of the month to display a list of months. A different quarter, click View Quarter and then click the arrows to either side of the quarter name. Or, click the name of the quarter to display a list of quarters. A different year, click View Year and use the arrows to either side of the year. Or, click the year to display a list of years.
2. Click Apply Calendar Calendar. If you have unapplied report changes in the queue, your report changes are applied when you click Apply Calendar Calendar.
NC60001
7 - Creating Reports
To include todays date, select Today Today. To include yesterdays day, select Yesterday Yesterday. To include data from a specified number of the specified time period units, starting with the current unit and counting back, select Current 2 days enter the days, desired number of units in the first box, and select a time period unit (days, weeks, months, quarters, or years) from the drop-down list. Current 2 days will include data from today and yesterday. To include data from a specified number of the specified time period units, starting with the previous unit and counting back, select Previous 2 days enter days, the desired number of units in the first box, and select a time period unit (days, weeks, months, quarters, or years) from the drop-down list. Previous 2 days will include data from yesterday and the day before yesterday. To include data from the current specified time period unit (other than day), select Current week and then select the desired time period unit (week, month, quarter, or year) from the drop-down list. To include data from the previous specified time period unit (other than day), select Previous week and then select the desired time period unit (week, month, quarter, or year) from the drop-down list. To include data from a fixed time frame, select Dates from and then select the start and end dates of the desired time frame from the drop-down lists.
5. When you have specified the time period you want, click Continue Continue.
NB60001
Specifying dimensions
NB6000A
About dimensions To specify dimensions for a report in the Custom Report Wizard
About dimensions
A dimension is a component that displays data from the log file without performing an operation on it first. In all reports except crosstab reports, only one column displays a dimension. For example, in the Browser Summary, the Browser column displays a dimension. In reports, the dimension is in the column next to the row number.
NC70001
Specifying metrics
b. Display the Report Summaries page for a report and click Dimensions Dimensions. 2. To add a dimension: a. Select a dimension in the Available dimensions list. b. Click Add dimension (the arrow button that points to the right). The dimension appears in the Selected dimensions list. 3. To remove a dimension: a. Select the dimension in the Selected dimensions list. b. Click Remove dimension (the arrow button pointing to the left). The dimension disappears from the Selected dimensions list and appears in the Available dimensions list. 4. To reorder dimensions, select one or more dimensions and click Move Up or Move Down Down. The first dimension in the report is the primary dimension.
NB70001
Specifying metrics
NB7000A
About metrics To specify metrics for a report in the Custom Report Wizard To add a metric through the Discovery Panel
About metrics
A metric is a numeric or date variable in which a mathematical operation has been performed. Most of the data on a Unica NetInsight report are supplied by metrics. You can add metrics to a report at the Metrics page in the Custom Report Wizard or by using the Discovery Panel. By default, Unica NetInsight has many metrics. You can also create metrics in the profile options for use on any report in the profile or in the Custom Report Wizard for use on the current report only.
NC80001
7 - Creating Reports
b. Display the Report Summaries page for a report and click Metrics Metrics. 2. To add an existing metric: a. Select a metric in the Available metrics list. b. Click Add metric (the arrow button that points to the right). The metric appears in the Selected metrics list. 3. To create and add a metric, click Add custom metric metric. 4. To edit a metric: a. Select the metric in the Selected metrics list. b. Click Edit metric metric. The Customizing a metric screen appears. When you are finished editing the metric, click Continue to save your changes and return to the Metrics page. 5. To remove a metric: a. Select the metric in the Selected metrics list. b. Click Remove metric (the arrow button pointing to the left). The metric disappears from the Selected metrics list . If the metric was not created in the Custom Report Wizard, it appears in the Available metrics list. If the metric was created in the Custom Report Wizard, it is deleted. 6. To reorder metrics, select one or more metrics and click Move Up or Move Down Down. Metrics appear in the report from left to right in the order they are listed in the Selected metrics list.
NC90002
170
About A/B reports To create an A/B report through the Discovery Panel To create an A/B report using the Custom Report Wizard
When the first group's value is greater than the second, the percentage change is negative (displayed in parentheses) and shown with a red down arrow. When the second group's value is greater than the first, the percentage change is positive and shown with a green up arrow. You can create an A/B report using the Discovery Panel or the Custom Report Wizard Wizard. You can choose which metric to display in the graph of an A/B report. For each metric in the report, you can graph the value for Group A, Group B, the Delta, or the Comparison. The Comparison is shown by default. The only chart types available for the comparison graph are bar and line charts.
Version 8.2.1
171
7 - Creating Reports
172
NCA0001
Version 8.2.1
173
7 - Creating Reports
).
If Multi-Edit mode is off, the Go button displays in the middle of the panel:
The A/B Testing icon remains selected to indicate that A/B testing is activated. The A/B Testing panel remains open until you close it. However, if you change reports, all currently defined filters for the two groups are lost. 3. Optionally, rename the two groups by clicking Group A and Group B and entering new titles. 4. In the Discovery Panel drag the filter you want onto the appropriate filter area for Panel, Group A or Group B. 5. Repeat step 4 for every filter you want to add to either filter set. 6. When you are through defining Group A and Group B, click the Go icon ( ) located in-between the two group definitions (if Multi-Edit mode is off) or click Run Report (if Multi-Edit mode is on). The A/B testing report is computed for the two group definitions. By default, the dimension values in the report are sorted in descending order, by the value for group A, and the data for both group A and group B appear in the chart. You can change the sort order of the report by clicking on the desired metric's or primary dimension's column label in the report title bar. To turn off A/B testing, click the A/B testing icon in the report toolbar again.
NCB0001
174
b. Display the Report Summary page for a report and click A/B Groups Groups. 2. In the text box on the left side of the page, enter the title you want to appear in the report for the first group. 3. Click Add and specify a filter for this group. 4. When you are through defining the filter, the A/B Groups page displays again with the filter listed in the list box. Click Add to add another filter. 5. When you have added all the filters for this group, repeat step 2 through step 4 on the right side of the page for the second filter group. 6. Click Continue Continue. 7. At the Report Summary page, click Sort order to display the General page. 8. In the Group to sort by list, select the group by which the report should be sorted. a. To order the dimension values in the report by the value for group A, select the title of group A. b. To order the dimension values in the report by the value for group B, select the title of group B. c. To order the dimension values in the report according to how much difference there is between the value for group A and the value for group B, select Delta. 9. In the Group to graph list, select the group whose data should appear in the report graph. a. To display the data for group A, select the title of group A. b. To display the data for group B, select the title of group B. c. To display the difference between the data for group A and the data for group B, select Delta. d. To display the data for both group A and B, select Comparison. 10. Click Continue to return to the Report Summary page. 11. Click Run to see the report.
NB90001
7 - Creating Reports
The dimension value The metric values and percentages for the first time period The metric values for the second time period The percentage change, which is calculated as:
When the first time period's value is greater than the second, the percentage change is negative (displayed in parentheses) and shown with a red down arrow. When the second time period's value is greater than the first, the percentage change is positive and shown with a green up arrow.
You create reports using the Comparative Reports icon ( ), which is available on the toolbar on the Reports tab. You then filter the report by date, once for each time period. After you click the Comparative Reports icon and specify the two time periods, every report you subsequently view is a comparative report until you click the icon again to turn comparative reports off.
NCC0001
When you customize a report, either by using the Custom Report Wizard or by modifying an existing report using the Report Designer, you can save your new or modified report from the Report Summary screen. If Multi-Edit mode is on and you have unapplied report changes in the queue, the saved report reflects the report as it will look after you click Run Report Report. 1. Click Save Save. 2. Provide a name for your report in the Report title field. If you are editing an existing report from the Custom tab, you can overwrite the report with your changes. If you are editing a pre-existing report from the Report Designer, you must specify a new name to save your modified report. 3. If you have custom help written for this report, you can specify the URL of the web page to display in the Help topic URL field. 4. Enable Save as new report report. As a best practice, you should save all reports as new reports. If you overwrite pre-generated reports, your changes will be lost when the profile is updated. 5. Enable Display filters on report to display any applied filters at the top of the report. 6. Enable Automatically update full report to automatically update the report for Full reporting mode when the profile is updated. 7. Enable Automatically update sample report to automatically update the report for Sample reporting mode when the profile is updated. 8. Enable Automatically archive report to preserve a copy of the report each time the profile is updated, instead of having newer versions saved on top of older ones. This option is only available if the report has a relative date filter (Yesterday Today Yesterday, Today, Previous week etc.). week, You cannot drill down into archived reports. Archived reports have no links. 9. Choose a folder from the Save report to folder drop-down list. 10. Click Continue Continue. Your custom report has been saved. You may need to refresh your report list for the report to be visible in the list.
NBB0001
To edit a report using the Report Summary page To display axis labels for dashboard reports
Version 8.2.1
177
7 - Creating Reports
1. With the desired dashboard displayed, click the Report Designer icon ( The Report Summary page opens. 2. In the Report description dialog, click the Left column or Right column link. 3. In the Dashboard sections dialog, select the desired report and click Edit Edit. 4. In the Section description dialog, uncheck Hide axis titles titles. 5. Save the report. Axis labels for the report are displayed the next time the profile is updated.
).
178
N10510
About archiving reports To archive a report To view archived reports To remove archived reports Emailing reports To export a report as a file Working with portlets Working with group selections
To archive a report
1. View the Profile that contains the report you want to archive.
Version 8.2.1 179
2. Display the Report Summary page for the report you want to archive. You can open the Report Summary page by clicking the Report Designer icon ( ), or by selecting the report in the Custom tab and clicking Edit Report Report.
3. Click Archive Archive. 4. In the Report title field, modify the name of the report as needed. 5. If you want the filters to be listed on the report, select the Display filters on report check box. 6. Click Continue Continue. The report is archived.
ND00001
180
Emailing reports
Emailing reports
ND20008
About emailing reports To email a report To create an email task To execute an email task To create an email alert To execute an email alert About scheduling email tasks and email alerts
To email a report
Before you can email a report, an email server must be configured for use with Unica NetInsight. You can email any report while viewing it. 1. Display the report you want to email.
).
3. In the From address field, enter the email address from which this report is to be mailed. Any email messages returned as undeliverable are returned to this address.
Version 8.2.1 181
4. In the To address field, enter the email address to which you want to send the report. Separate multiple email addresses with commas or semicolons. 5. In the Subject of email field, enter the subject of this email message. 6. In the Format of report list, select the report format you want to use. 7. In the Reporting mode list, select the reporting mode in which you want to export the report. The Reporting mode option only appears if sampling is enabled and you have the privilege for changing the export reporting mode. 8. If you are emailing a report in .csv format, select one of the options from the Data to e-mail drop-down list. To email only the data currently displayed on the report page, select Just this report If the report is not currently displayed, the email will contain only the first report. page of data, up to the number of rows per page specified in the Report Designer. To email the maximum amount of data returned in the report up to the limit defined for your system, select Maximum data allowed allowed.
9. In the Additional text field, enter the text you want to include in the body of the email message that contains the report and chart. 10. Click Continue Continue.
ND70001
To create an email task To add or edit reports for an email task To add or edit recipients for an email task To test an email task To edit an email task To delete an email task
Emailing reports
5. In the From address field, enter the email address from which the reports in this email task will be mailed to users. Any email messages returned as undeliverable, as well as any replies sent by recipients, are sent to this address. If you do not enter an address, Unica NetInsight uses the email address specified for the From address option in the administrative options. 6. In the Subject of email field, enter the text you want to appear in the subject line of the email the recipients receive. 7. In the Format of reports list, select the report format you want to use. 8. If you are emailing a report in .csv format, select one of the options from the Data to e-mail drop-down list. To email only the first page of data, up to the number of rows per page specified in the Report Designer, select Just this report report. To email the maximum amount of data returned in the report up to the limit defined for your system, select Maximum data allowed allowed.
9. In the Time period list select the time period for which the metric will be calculated. list, 10. If you have scheduled the -email command-line option to automatically execute all the email tasks for this profile but you do not want this email task executed with the group, select the Exclude from batch execution check box. This email task is then executed only when you use the -emailtask command-line option or select the task in the Available email tasks list and click Execute Execute. This option is especially useful when most of your email tasks are executed daily and you want to create a task that executes weekly, monthly, or quarterly. 11. In the Additional text field, enter the text you want to include in the body of the email message that contains the reports and graphs. For example, you could include descriptions of the data contained in each report. 12. Click Save Options and then click Continue Continue. Before the email task is functional, you must:
NDC0001
Add one or more reports to the email task Add one or more recipients to the email task
1. While working with the profile, click Options Options. 2. In the Options panel, under Email click Email Tasks Email, Tasks. The Available email tasks screen opens. 3. Select the email task to add reports to. 4. Click Reports Reports. The Reports to be sent for profile screen opens. 5. Select reports in the Available reports list and use the right arrow button to move reports you want to send to the Selected reports list. You can use the left arrow button to remove any reports you do not want to send. 6. Select reports in the Selected reports list and use the up and down buttons to adjust the order of reports to be included. 7. When all the reports you want to include are in the Selected reports list and in the desired order, click Save Options and then click Continue Continue.
NDD0001
184
Emailing reports
Version 8.2.1
185
To execute an email task To execute an email task from the command line To execute all email tasks from the command line
When you execute an email task, Unica NetInsight includes all the reports in the email task in one email message and sends it to the specified recipients. 1. While working with the profile, click Options Options. 2. In the left panel, under Email click Email Tasks Email, Tasks. The Available email tasks screen opens. 3. Select the email task to execute. 4. Click Execute Execute.
NE10002
Create the email task Add reports to an email task Add recipients to an email task
Unica NetInsight - Administrator's Guide
Emailing reports
When you execute an email task, Unica NetInsight includes all the reports in the email task in one email message. You can specify the order in which you want the reports to appear when you add reports to the email task. Executing an email task from the command line allows you to easily automate delivery of reports by scheduling email task execution using a scheduler. Executing an email task from the command line also enables you to see any errors encountered while executing the task. 1. Open a command prompt or terminal. 2. Change to the Unica NetInsight program directory. (The default program directory on UNIX is /usr/local/netinsight. The default Unica NetInsight program directory on Windows is C:\Program Files\NetInsight. 3. Run the following command: where short_profile_name is the short name of the profile containing the email task you want to execute and taskname is the name of the email task. Short profile names appear in parentheses in the Profile Manager. You can also run the command Nettracker admin -list to see a list of all the short profile names. You can also use the -recipients command-line option to specify recipients other than those specified in the email task. nettracker short_profile_name -emailtask taskname
NE20002
When you execute an email task, Unica NetInsight includes all the reports in the email task in one email message. You can specify the order in which you want the reports to appear when you add reports to the email task. You can use one command to execute all of the email tasks in any profile. However, any tasks that have the Exclude from batch execution check box selected are not executed. 1. Open a command prompt or terminal. 2. Change to the Unica NetInsight program directory. (The default program directory on UNIX is /usr/local/netinsight. The default Unica NetInsight program directory on Windows is C:\Program Files\NetInsight.) 3. Run the following command:
Version 8.2.1 187
where short_profile_name is the short name of the profile containing the email tasks you want to execute. Short profile names appear in parentheses in the Profile Manager. You can also run the command Nettracker admin -list to see a list of all the short profile names. You can also use the -recipients command-line option to specify recipients other than those specified in the email task. nettracker short_profile_name -email
ND90001
To create an email alert To modify filters for an email alert To test an email alert To edit an email alert To delete an email alert
188
Emailing reports
To include data from a specified number of the specified time period units, starting with the previous unit and counting back, select Previous enter the Previous, desired number of units in the first box, and select a time period unit from the drop-down list. For example, specifying Previous 2 days includes data from yesterday and the day before yesterday.
7. In the Metric list, select the metric for which you want to calculate a value. 8. In the Execute if calculated value is list, select the comparison type to use to compare the calculated value to the threshold value. 9. Enter a number for the threshold value in the next field to the right. 10. Click Save Options then click Continue Options, Continue. You can now add filters to the alert.
NE30001
8. Repeat steps 5 through 7 until the filter list is complete. 9. Click Save Filters Filters.
NE40001
190
Emailing reports
To execute an email alert To execute an email alert from the command line To execute all email alerts from the command line
1. While working with the profile, click Options Options. 2. In the left panel, under Email click Email Alerts Email, Alerts. The Available email alerts screen opens. 3. Select the email alert to execute. 4. Click Execute Execute.
NE70001
1. Open a command prompt or terminal. 2. Change to the Unica NetInsight program directory. (The default program directory on UNIX is /usr/local/ Unica NetInsight. The default Unica NetInsight program directory on Windows is C:\Program Files\Unica NetInsight.) 3. Run the following command: where profile_name is the short name of the profile containing the email alert you want to execute and alertname is the name of the email alert. Short profile names appear in parentheses in the Profile Manager. You can also run the command Nettracker admin -list to see a list of all the short profile names. nettracker profile_name -alerttask alertname
NE80001
Version 8.2.1
1. Open a command prompt or terminal. 2. Change to the Unica NetInsight program directory. (The default program directory on UNIX is /usr/local/Unica NetInsight. The default Unica NetInsight program directory on Windows is C:\Program Files\Unica NetInsight.) 3. Run the following command: where profile_name is the short name of the profile containing the email alert you want to execute. Short profile names appear in parentheses in the Profile Manager. You can also run the command Nettracker admin -list to see a list of all the short profile names. nettracker profile_name -alert
NDB0001
Assuming that Unica NetInsight is installed in C:\Program Files\Unica NetInsight, this command updates your profiles, emails summaries to your users, and executes any email alerts that have been specified every night; the process starts at 11:05 PM. The -dir option specifies the Unica NetInsight program directory so the nettracker executable can find the profile files.
0 0 * * * /usr/local/Unica NetInsight/nettracker all -quiet -update -email alert -dir /usr/local/Unica NetInsight
Assuming that Unica NetInsight is installed in /usr/local/Unica NetInsight, this command runs an update on Unica NetInsight at midnight every night, emails reports to your users, and executes any email alerts that have been specified. The -dir option specifies the Unica NetInsight program directory so the nettracker executable can find the profile files.
ND30001
The Export options window opens. 3. From Report Type select File Type, File. 4. Select the appropriate option from the Format of report drop-down list. Select Spreadsheet (.csv) to create a text file that can be saved or imported into most spreadsheet and database applications. (For example, Microsoft Excel can open .csv files.) You can then manipulate, format, and analyze the data using the tools provided in the spreadsheet or database application. The chart is not exported as part of this format, though once you import data into a spreadsheet application, you can create a chart from the data. Select Web browser (.html) to create an HTML file that you can save or post on your Web site for viewing by others.
Version 8.2.1
193
Select Word Processor (.rtf) to create a Rich Text File that can be saved or imported directly by Microsoft Word and many other word processors. You can open the file in a word processor, edit it, and then print it for distribution.
5. From the Data to export drop-down list, select one of the options. To export just the data that appears in the current page of the report, select Just this screen screen. To export all the data in the report, select Maximum data allowed allowed.
6. From the Reporting mode drop-down list, select one of the options. The Reporting mode option only appears if sampling is enabled and you have the privilege for changing the export reporting mode. 7. Click Export Export. Depending on the Web browser you are using and the export format that you selected, either a Save As window opens or the exported report opens in a new window or tab. If it appears as though nothing has happened, ensure that your browser settings allow pop-up windows. 8. If a Save As window opens, select the drive and directory where the file is to be saved, enter a filename, and click Save Save. The report is saved in the format you selected.
ND40001
About portlets
You can export any report that auto-updates as a portlet, a pluggable user interface component that can be displayed in web pages, web-based applications, or other applications that can render HTML or parse XML data. Uses for portlets include: Display the report as a web page, or within an inline frame on a web page or web application. Convert the portlet to a widget using a vehicle like Google Gadgets. Parse the XML for rendering in a table or other format, or pass the data to another application for use.
Subsequent changes to the report in Unica NetInsight (for example, updates, new filters applied) are reflected in the portlet the next time it is accessed by a user. Users viewing a portlet can change the graph type just as they can in Unica NetInsight. Clicking a portlet rendered in HTML launches the report in Unica NetInsight.
194
NE90001
The Export options window opens. 3. From Export Type select Portlet URL. Type, 4. From Format of Report select Web Browser or XML. 5. If you selected Web Browser, specify: a. The number of values to include in the report. b. The width of the report graphic, in pixels. Note that Path reports self-adjust their size, regardless of the width you specify. Stacked bar reports will automatically increase the width you specify by 30%.
Version 8.2.1 195
c. Optionally, you can choose to hide the report header. 6. Click Export Export. 7. Copy the URL for the report.
ND50001
About group selections To open or close the Selected Groups panel To add groups to a group selection To modify a group selection To save a group selection To use a group selection in Unica Campaign
196
A visitor identification string. For example, in the case of a URL request, the string would be an IP address and user agent such as 93.158.148.31:Yandex/1.01.001 (compatible; Win16; I).
SELECT DISTINCT myprofile_VisitorID.VisitorID, myprofile_VisitorID.Visitor FROM myprofile_VisitorID WHERE (( myprofile_VisitorID.VisitorID IN (SELECT VisitorID FROM myprofile_Visits WHERE (myprofile_Visits.FirstViewDate >= 2454833 AND myprofile_Visits.FirstViewDate <= 2455197) ) AND myprofile_VisitorID.VisitorID IN ( SELECT VisitorID FROM myprofile_Visits WHERE (FirstViewDate >= 2454833 AND FirstViewDate <= 2455197) AND PlatformID IN (SELECT PlatformID FROM myprofile_PlatformID WHERE myprofile_PlatformID.Platform = 'Windows XP' ) ) ) )
NEA0001
).
You can now begin making and saving selections. To hide the Selected Groups panel, click on the Selected Groups icon again.
NEB0001
Version 8.2.1
197
2. Drag and drop the selection into the Selected Groups panel, or in the Highlighted row, click Add as Group Group. All of the count metric cells you highlighted are added to the selection as a single group.
3. As desired, repeat the previous steps to add more groups to the selection. Multiple groups added to the Selected Groups panel are logically OR-ed together. While a group selection can consist of different dimensions, it cannot consist of different metrics (for example views and visits).
NEC0001
198
Working with group selections To View the report from which any single group in a group was selected Remove a single group from a selection Remove all groups from a selection In the Selected Groups Panel Right-click the group and select View Group Report Use Notes
Right-click the group and select Delete Delete. Click the Clear icon ( ). All selections are permanently removed from the group. Click on its name and edit the displayed text
By default, the name of a group is the sum of its members and the name of its metric. ) The Estimated Count displayed in the Selected Groups panel gives the total visitors across all groups in a selection. Because of the potential overlap between members in different groups, this may not accurately reflect the number of unique members in a selection. Use Actual Count to calculate the number of unique members. You can view a bulleted list of the dimension criteria from which a group's members were selected.
NED0001
).
You can also export a group by selecting the desired metric in a report, rightclicking, and selecting Export Export. The Save Selection dialog box opens. 2. Click the download selection link.
NEE0001
Version 8.2.1
199
This option only appears if the Select process is a top-level process; it cannot have an input cell from a previous process. 2. Select Unica NetInsight Selection Selection. The Unica NetInsight Selections window opens, listing the selections you have saved in Unica NetInsight. You can sort any column by clicking on the column header. To view all selections, including those made by other users, check Show selections from all users users. 3. Select the row for the selection you want and click OK OK. The selection is listed in the Input drop-down list.
200
When you use an Unica NetInsight selection as input, you cannot refine the selection by adding additional SQL statements. You can, however, use a Select or Segment process following the top-level Select process. For example, you can configure the Segment process to segment the input IDs by query, to treat segments of the Unica NetInsight selection differently . 4. Complete the flowchart as required. For more information about using flowcharts, see the Unica Campaign User's Guide.
Version 8.2.1
201
N105DE
About analyzing content Analyzing banner ads Analyzing content groups Analyzing indexes Analyzing links Analyzing keywords To include specific redirection scripts in the reports
About analyzing banner ads About moving ntadtrack.cgi or ntadtrack.exe to a CGI-accessible directory To redirect all banner ads To configure banner ad options
202
<img src="/ads/NetInsight.gif"></a>
NF80001
If you are using Windows with IIS, you need to allow the anonymous Web user Read and Execute permission through NTFS for the directory containing ntadtrack and for the file itself and Execute permission for Scripts and Executables through the IIS management console. 5. Click Save Options and then click Continue Continue. 6. Click Add Add. 7. In the Name of banner ad box, enter the name you want to use for the ad in the Unica NetInsight reports. 8. In the Full path of graphic box, enter the path to the banner ad graphic. This will be the path from the document root of your Web site, not the full path on the system you are using. This will be the same path used for the image file in the HTML document. For example, if the HTML document contains:
img src="/ads/NetInsight.gif"
204
9. In the URL to link to box, enter the destination that users will go to when they click the ad.
<a href="/cgi-bin/ntadtrack.cgi?http:// www.unica.com/products/">
10. Click Save Options Options. Your banner ad statistics will be tracked for all new data you import from now on. 11. If this is what you want or if you have other banner ads to enter at this time, click Continue Continue. If you happen to have already imported data that contains banner ads that have been redirected through ntadtrack, you can analyze banner ad statistics in data you have already imported by deleting all the data in your profile and reimporting your log files. If you do not still have all the log files you have imported into this profile, you will lose data permanently by choosing this option. To delete your profile data, click Delete Profile Data Data.
NF10001
About analyzing content groups To create a content group About determining the content group for files that fit multiple groups
Version 8.2.1
205
9 - Analyzing Content
About determining the content group for files that fit multiple groups
A file can only belong to one content group. If you have a file that meets the criteria for more than one group, Unica NetInsight will include the file in the first content group to which it can belong. You can use the Move Up and Move Down buttons to change the order of the content groups in the Content groups to be analyzed list.
NF20001
Analyzing indexes
NF2000A
206
Analyzing indexes
Version 8.2.1
207
9 - Analyzing Content
Analyzing links
NF3000A
About analyzing links About analyzing links using a redirect program About moving ntlinktrack to a CGI-accessible directory To redirect all external links About analyzing links using page tags About enabling the link summary To configure link options
208
Analyzing links
If the Web server whose log files you are analyzing is on a different platform than the computer on which you have Unica NetInsight installed, you will need to contact technical support to get the correct version of ntlinktrack.cgi or ntlinktrack.exe for your Web servers platform.
NFE0001
Version 8.2.1
209
9 - Analyzing Content
If you are using Windows with IIS, you need to allow the anonymous Web user Read and Execute permission through NTFS for the directory containing ntlinktrack.exe and for the file itself and Execute permission for Scripts and Executables through the IIS management console. 5. In the Link display length list, select the maximum number of characters to be displayed for a link on the Link Summary. You can select a number from 10 to 100, or you can select Unlimited Unlimited. 6. Click Save Options Options. Your link statistics will be tracked for all new data you import from now on. 7. If this is what you want, click Continue Continue. If you happen to have already imported data that contains link entries that have been redirected through ntlinktrack, you can analyze link statistics in data you have already imported by deleting all the data in your profile and reimporting your log files.
210 Unica NetInsight - Administrator's Guide
Analyzing keywords
If you do not still have all the log files you have imported into this profile, you will lose data permanently by choosing this option. To delete your profile data, click Delete Profile Data Data.
NF40001
Analyzing keywords
NF4000A
Version 8.2.1
211
9 - Analyzing Content
9. If this is what you want or if you have other pages or scripts to enter at this time, click Continue Continue. If you want to analyze local keywords from this page or script in data you have already imported, you will need to delete all the data in your profile and reimport your log files. If you do not still have all the log files you have imported into this profile, you will lose data permanently by choosing this option. To delete your profile data, click Delete Profile Data Data.
NF50001
212
N1065B
About data conduits To configure Unica NetInsight to use a data conduit Adding dynamic pages Analyzing events Analyzing parameters Replacing or deleting characters in URLs
Once the data conduit is installed and configured, you need to configure Unica NetInsight to use the data conduit.
Version 8.2.1
213
Conduit tasks
Data conduits can perform a variety of tasks. When you configure Unica NetInsight to use the data conduit, you must specify which tasks the data conduit performs. The available data conduit tasks are: Cookie Lookup Replaces each visitor's unique cookie ID on reports with data (such as the visitor's name and phone number) retrieved from an external database. Department Lookup Determines department groupings using an external database (such as a corporate directory). The value that Unica NetInsight provides to the data conduit is determined by the value selected for the Department defined primarily by option in the profile options. Retrieves file data (such as a version number) from an external database, and replaces the file name stored in the Unica NetInsight database with the data retrieved from the external database. The file data stored in the Unica NetInsight database appears on the reports. Host Lookup Replaces each host name on reports with host data retrieved from an external database. Page Rewrite Retrieves the titles of pages from an external database, and replaces the directory paths and file names stored in the Unica NetInsight database with the titles retrieved from the external database. The titles stored in the Unica NetInsight database appear on the reports. Page Title Lookup Replaces the directory paths and file names of the pages on reports with the titles of pages retrieved from an external database. Page Value Rewrite (parameter name) Retrieves parameter value data (such as product names from an online catalog) from an external database, and replaces the parameter values stored in the Unica NetInsight database with the data retrieved from the external database. The data stored in the Unica NetInsight database appears on the reports. Product Lookup Replaces product SKUs on reports with product names retrieved from an external database. Product Rewrite Retrieves product names from an external database, and replaces the product SKUs stored in the NetInsight database with the names retrieved from the external database. The names stored in the Unica NetInsight database appear on the reports.
214 Unica NetInsight - Administrator's Guide
User Lookup Replaces user names on reports with user data retrieved from an external database.
Visitor Lookup Replaces visitor names on reports with visitor data retrieved from an external database.
N1040001
d. If the data conduit task affects the Unica NetInsight database and you want to pull data from an external database for data you have already imported, you need to delete all the data in your profile and reimport your log files. (Note: If you Note: do not have all the log files you have imported into this profile, you lose data permanently by choosing this option.) To delete your profile data, click Delete Profile Data Data. Unica NetInsight begins using the data conduit as soon as the profile is updated.
N1050001
About dynamic pages To add dynamic pages To delete a dynamic page To edit a dynamic page filter
216
Analyzing events
If you do not still have all the log files you have imported into this profile, you will lose data permanently by choosing this option. To delete your profile data, click Delete Profile Data Data.
N10A0001
Analyzing events
N1060007
About events Configuring Unica NetInsight to track events To define an event title To edit an event title To delete an event title
About events
An event is any action on your Web site other than loading a page. Events include, but are not limited to, the following: Changing a field on a form Selecting an option in a drop-down list box Submitting a form
Events are plentiful in Rich Internet Applications (RIAs) such as Flash or AJAX presentations.
N10C0001
Version 8.2.1
217
218
Analyzing parameters
Filtered metrics based on events cannot be deleted from the Events option pages. You must delete the custom metrics from the Custom Metrics option pages. 1. View the profile that contains the event whose title you want to delete. 2. Click the Options tab. 3. In the Options panel, select Dynamic Content > Events Events. 4. Select the event title you want to delete and click Delete Delete.
N1070001
Analyzing parameters
N1070007
About parameters About parameter types To define a parameter To delete a parameter To edit a parameter
About parameters
A parameter is an item of information that is passed to a server by a user or another program. One example of a parameter is the visitor identifier in a cookie. Another example of a parameter is a product name that is passed in a query string to dynamically generate a page in a catalog. Unica NetInsight enables you to track the values that are being passed in query strings cookies pages page tags referrers any field in a log file
You can configure the parameter to track multiple values. You can also combine previously defined parameters of different types (such as page and query string) into a meta parameter. Parameter value statistics appear in a Parameter Summary. You create separate Parameter Summaries for each parameter whose values you want to track.
Version 8.2.1
219
If you want to use the parameter to determine sessionization or as a source parameter for a meta parameter, associate it with a view. You cannot use event or visit parameters for sessionization or as sources for meta parameters.
The query string is everything after and including the question mark (?) in a URL.
220
Analyzing parameters
For example, if you had the following URL (all one line)
http://www.yoursite.com/catalog/products/show.cgi?product=product_name
the query string field would contain ?product=product_name and you could track the product_name values. If you want to track parameters in query strings, make sure your server is logging the query strings. Use GET requests, not POST requests, when executing your scripts.
Cookie parameters
Cookie parameters are parameters in the cookie field in the log file. For example, if you set cookies in the form
name=xxxx;age=yy
where xxxx is the user's login to your site and yy is the user's age in years, you could track the values passed to the name parameter, the age parameter, or both. You can parse parameters from cookies that contain multiple name/value pairs separated by ampersands (for example, YourID=First=John&Last=Doe&Number=123). You can set up a cookie parameter for just one of the cookie fragments (for example, just the ID number). Follow the steps for creating a regular cookie parameter, with one change. In the Parameter text box, enter the name of the cookie, an equal sign, and the name of the cookie fragment (for example, YourID=Number).
Field parameters
Field parameters are parameters in an arbitrary field in the log file. Use a field parameter to parse a parameter in a field for which there is not a designated parameter type. You can parse parameters from any field in a log file as long as the log file is in one of the following formats: Netscape Flexible W3C Any format defined in the Custom Log Formats section of the administrative options. You can describe NCSA log files with a custom log format in order to parse parameters from a field. For example, if you had a Netscape Flexible log file (in which each cookie has its own field) that contained the cookie field %Req->vars.cookie%, you could parse the cookie and have NetInsight sessionize based on that parameter.
Version 8.2.1
221
The value of parameters parsed from arbitrary fields is the entire value of the given field. If you want to manipulate the value, use the URL Search and Replace feature. The field must appear in either the log file's format header or the custom log format specification. If it does not, NetInsight can not parse or store the parameter values.
Page parameters
Page parameters are parameters in the URLs of Web pages the page portion of the lc parameter in page tag requests.
For example, if the URLs of your catalog of items are in the format
/catalog/item_name.html
you could track the values passed to item_name. Clip parameters are parameters associated with clips that visitors download from your streaming media server. For example, if the URLs of your catalog of clips are in the format
/catalog/artist_name.rm
you could track the values passed to artist_name. You need to use a regular expression to define a page parameter. Instead of entering the name of the log file field from which the parameter should be parsed, you use the regular expression to describe the parameter in the page. The section of the parameter in parentheses will be retained by NetInsight and used as the parameter value.
222
Analyzing parameters
To track MyParameter values, configure MyParameter as a query string parameter because MyParameter is part of the query string portion of the lc field. However, to track values for the jv parameter, configure jv as a page tag parameter.
Referrer parameters
Referrer parameters are parameters in either of the following: referrer field in the log file rf portion of the page tag request
You could track the value of the ie parameter to find out the character set of the search string. To track a parameter that appears in the referrer URL, you will need to use a regular expression. Instead of entering the name of the log file field from which the parameter should be parsed, you use the regular expression to describe the parameter in the referrer. The section of the parameter in parentheses will be retained by NetInsight and used as the parameter value.
Meta parameters
Meta parameters are parameters whose value is the value of the first parameter in an ordered group of parameters that has a value for an individual view. You can use this type of parameter to combine previously defined parameters of different types (such as page and query string) into a single parameter based on the availability of the parameters in the group. One use for this type of parameter is sessionization by the session ID used by Java application servers, which store the session ID value in the cookie when possible but otherwise store it in the page itself. You define a meta parameter by specifying a comma-delimited list of the names of other, previously defined parameters from which the value of the meta parameter will be taken. Only parameters associated with views can be source parameters for a meta parameter. Parameters associated with events or visits can not be used.
N1110001
To define a parameter
If you are creating a meta parameter, you must first create all the parameters that you want to be part of the meta parameter. 1. View the profile in which you want to track parameters. 2. Click the Options tab.
Version 8.2.1 223
3. In the Options panel, select Dynamic Content > Parameters Parameters. 4. Click Add Add. 5. In the Name box, enter the name you want to use for this parameter in the Parameter Summary. Use only alphanumeric characters. Do not use any spaces. 6. In the Type of parameter list, select the parameter type. 7. In the Parameter box, enter the parameter you want to track. For page and referrer parameters, you must use a regular expression to identify the parameter. For field parameters, enter the name of the field exactly as it appears in the log file's format header, excluding any field delimiters or literal formatting characters. For meta parameters, enter a comma-delimited list of the names of other, previously defined parameters from which the value of the meta parameter comes. Unica NetInsight ignores the case of the names, any spaces before or after the commas, and any parameter that has not been previously defined in the profile options. You can not use parameters associated with visits as source parameters for a meta parameter. 8. Specify how you want to handle the case of parameter values by selecting an option from the Parameter value casing drop-down list. The options are As parsed (mixed-cased), uppercase, or lowercase. 9. If you want to specify a column title for the column containing the parameter values for this parameter (for example, in the Parameter Summary), enter the title you want in the Column title box. If you do not specify a title, Unica NetInsight uses the parameter name as the column name. 10. If you want to specify a graph title to be used when the parameter data is ranked in ascending order, enter the title you want in the Graph title (Ascending) box. If you do not specify a title, Unica NetInsight uses the title Least Popular Parameter Values for parameter. 11. If you want to specify a graph title to be used when the parameter data is ranked in descending order, enter the title you want in the Graph title (Descending) box. If you do not specify a title, Unica NetInsight uses the title Most Popular Parameter Values for parameter. 12. If you want to link the parameter values with other data in another database, specify a CGI script in the Parameter lookup URL box. When users click a parameter value in the Parameter Summary, the value is appended to the URL and the script is executed. 13. In the Associate parameter value with list, select with what the parameter values are associated.
224
Analyzing parameters
14. Select the Store parsed parameter value check box if you want Unica NetInsight to store the values in the NetInsight database. 15. Select the Allow multiple values check box If you want to track multiple values for this parameter. The default value separator is a comma. You can change the separator to a pipe, semicolon, or colon by editing the parameter after it is saved. 16. Select the Create report check box if you would like Unica NetInsight to automatically create a Parameter Summary for this parameter the next time the profile is updated. The summary is listed under Parameter Analysis on the Reports tab. 17. Select the Create dimension check box if you would like the parameter value to be available as a dimension on the Discovery Panel and in the Custom Report Wizard. The parameter is listed under Parameter Analysis. 18. Select the Create filter check box if you would like the parameter value to be available as a filter on the Discovery Panel and in the Custom Report Wizard. The parameter is listed under Parameter Analysis. 19. In the Page Help box, enter the text that should appear in the report's page help for the column containing the parameter values for this parameter. 20. Click Save Options and then click Continue Continue. 21. Select the parameter and click Requests Requests. 22. Click Add Add. 23. Enter a filter that describes the request that Unica NetInsight should check for this parameter. 24. Click Add Add. The requests described by this filter will be searched for this parameter in all new data you import from now on. 25. If this is what you want or if you have additional filters to enter at this time, click Continue Continue. If you want to search the requests described by this filter in the data you have already imported, you need to delete all the data in your profile and reimport your log files. If you do not still have all the log files you have imported into this profile, you will lose data permanently by choosing this option. To delete your profile data, click Delete Profile Data Data.
N1120001
To delete a parameter
1. View the profile that contains the parameter you want to delete.
Version 8.2.1 225
2. Click the Options tab. 3. In the Options panel, select Dynamic Content > Parameters Parameters. 4. Select the parameter you want to delete and click Delete Delete.
N1130001
To edit a parameter
1. View the profile that contains the parameter you want to edit. 2. Click the Options tab. 3. In the Options panel, select Dynamic Content > Parameters Parameters. 4. Select the parameter you want to edit. 5. To change the parameter properties, click Edit Edit. 6. If you configured the parameter to allow multiple values, you can change the default separator from a comma to a pipe, semicolon, or colon. To change the separator, select the separator you want from the Value separator drop-down list. 7. To change the requests that Unica NetInsight checks for the parameter, do the following: a. Click Requests Requests. Unica NetInsight displays the list of filters that define the requests, pages, files or clips that Unica NetInsight checks for the parameter. b. To delete a filter, select it and click Delete Delete. c. To edit a filter, select it and click Edit Edit.
N1080002
About replacing or deleting characters in URLs To replace or delete characters in the URLs in your reports To delete a search and replace rule To edit a search and replace rule Examples
226
Version 8.2.1
Use tokens to indicate which portion of the text you want to use.
The text enclosed by the nth set of parentheses in the search rule The text enclosed by the nth set of parentheses in the search rule, converted to lowercase The text enclosed by the nth set of parentheses in the search rule, converted to uppercase
%VALUEn%
%LOWERn%
%UPPERn%
Rule types
The rule type indicates the part of the URL that Unica NetInsight should search. The following types are possible: Entire Request The page plus the query string. Page The part of a URL that appears in the Page Summary when you do not resolve page titles. For non-clustered log files and log files that are clustered for a single site, this is everything after the domain name but before the "?" marking the beginning of parameters passed to a script. For log files clustered for multiple sites, this is everything before the "?" marking the beginning of parameters passed to a script. Query String The part of the URL after and including the "?" marking the beginning of parameters that are passed to a script on your Web site. Referrer Any URL that appears as a referrer for a view. Parameter Value for (parameter name) The value of the specified parameter. Event Event name. You can use regular expressions to replace event text; changes are shown in the Event Summary report.
N1140001
228
Version 8.2.1
229
Unica NetInsight will use the search and replace rule on all new data that you import from now on. 16. If this is what you want, or if you have additional filters to add at this time, click Continue Continue. If you want the search and replace rule to be used on data you have already imported, you will need to delete all of the profile data and reimport your log files. If you do not still have every log file you have imported into this profile, you will lose data by choosing this option. To delete profile data, click Delete Profile Data Data.
N1150001
230
Examples
Example 1: Deleting Session IDs
If the URLs on your site consistently have a session ID embedded in them, you can use a URL search and replace rule to delete the session IDs. If the session ID is the last part of the URL, the URLs might have the following format:
/directory_one/page_name.html-sessionid
To delete the session ID, enter the following regular expression in the Search rule box:
\ .html(-.*)$
The part of the URL that is described by the part of the regular expression in parentheses is the part that will be replaced. Leave the Replacement value box blank and select Page as the rule type. Because this session ID appears on every page of your site, when you are creating the filter for the pages that Unica NetInsight should attempt to match the regular expression against, enter the following:
That contains /
You will then need to create a second search and replace rule, identical to the first except with Referrer as the rule type. (Without this second rule, the session IDs will continue to appear in Referrer Breakdowns.)
If the product ID for a bicycle is 7654, the URL for the bicycle page would be as follows:
/directory_one/7654.html
To replace the product ID with the word bicycle, you would enter the following regular expression in the Search rule box:
/.*/(7654)\.html
Version 8.2.1
231
You would enter bicycle in the Replacement value box. Because this product ID appears only in pages that start with /directory_one, when you specify the pages that Unica NetInsight should attempt to match the regular expression against, you would use the following filter:
That starts with /directory_one/
To cause the category to show up as shoes every time (so it is counted as one category in the reports), enter the following in the Search rule box for a parameter URL search and replace rule:
(.*)
To get the result product=red-shoes in the report, enter the following in the Search rule box for a query string URL search and replace rule:
232 Unica NetInsight - Administrator's Guide
product=((.*)&color=(.*))
When you specify the pages that Unica NetInsight should attempt to match the regular expression against, use the following filter:
That match /directory_one/catalog.html
Version 8.2.1
233
N106DC
About analyzing marketing efforts Analyzing campaigns Analyzing keywords Analyzing referrers Analyzing visits from indexing agents Analyzing visit cost
Analyze the performance of various campaigns Analyze visit cost and paid search ROI See which sites are referring the most visitors to your site Track which search engines and directories are indexing your site
Analyzing campaigns
234
About campaigns About dynamic and static campaigns About campaign channels About campaign segments About entry pages for campaign segments
Unica NetInsight - Administrator's Guide
Analyzing campaigns
N119000A
To create a campaign in NetInsight To specify campaign channels To specify campaign segments To specify entry pages Configuring paid search campaigns
About campaigns
A campaign is messaging created by a marketing department to drive traffic to your Web site. A campaign is typically run through multiple channels (banner ads, email, Internet search, print ads, etc.) and a channel may contain multiple segments (the ad variation within a channel). Optionally, a campaign can include specific entry pages on your Web site that associate a visit with that campaign. In Unica NetInsight, campaign statistics are listed in the Campaign Summary report. The following diagram shows the relationships between campaigns, channels, segments, and paid keywords in two sample static campaigns.
N11E0001
Version 8.2.1
235
N11E0007
The first two visits will both be attributed to the Clearance campaign, different channels, but to the same SpecialOffer segment. The third visit will be attributed to the SpringSale campaign, Email channel, and SaleAlert segment. If any of these campaigns, channels, or segments do not already exist in Unica NetInsight they will be created automatically.
236
Analyzing campaigns
In Unica NetInsight reports, in addition to comparing the traffic generated by the two campaigns, you can also compare traffic generated across campaigns by different channels (Email versus Twitter) and segments (SpecialOffer versus SaleAlert).
Every visit whose entry page is www.site.com/ExtremeWidgetAd1 will be associated with the Ad1 segment of the Extreme Widget campaign.
Version 8.2.1
237
It is important to consider the order in which you want visits attributed and then order your campaigns accordingly. As a rule of thumb, you should position campaigns with the most-specific matching criteria at the top. A static campaign with static channels and segments and no entry page definition will match all visits. If such a campaign were positioned at the top of the list no other campaigns would receive attribution. Use the up and down buttons to the right of the list to change the order of the campaigns. These ordering considerations and guidelines apply to channels and segments as well.
N11F0001
238
Analyzing campaigns
Newsletter Printed or online report that provides news or information of interest to a special group. Paid listing Guarantee of a ranking in a search listing for the terms of your choice; can be placed on a site other than a search engine. Print media Medium that distributes printed matter, such as a newspaper, magazine, or book. Rich media ad Advertisement that usually includes richer graphics than a banner ad and includes audio or video within the advertisement. Search engine (PPC/CPM) Pay-per-click or cost per thousand views advertising (or both) on a search engine. (Other) A channel type not listed above.
Campaign channel type statistics appear on the Campaign Channel Type Summary. For search engine (PPC/CPM) channels, you can analyze the performance of the various paid keywords. Paid keyword statistics appear on the Paid Keyword Summary.
N1200001
If campaign segments in separate channels share a name, you can analyze the combined traffic for the segments in the Campaign Segment Summary. In the Campaign Segment Summary unfiltered by a channel, there is one row per unique segment name that shows the combined traffic for all segments with that name. In the Campaign Segment Summary filtered by a channel, the row with the shared segment name shows only traffic for the segment in the specified channel.
N1210001
Version 8.2.1
239
Do not use your home page as the entry page unless you are using query strings to define the entry page. If you are not using query strings and you use your home page as the entry page for the campaign, all traffic to your home page appears in the campaign analysis. To figure out what percentage of the traffic to your home page resulted from your campaign, you must drill repeatedly into the Campaign Summary. Query strings can contain other parameters besides the ones used to identify the campaign segment. These parameters can be analyzed in Unica NetInsight as well.
Following are some examples of entry page rules and the pages that will and will not match the rule.
240 Unica NetInsight - Administrator's Guide
Analyzing campaigns
Example 1
If the entry pages of a campaign segment are defined by the filter that contain ad? %referrer=google.* visitors entering the Web site through the following pages would be %referrer=google.*, attributed to the given campaign, channel, and segment:/ad.cgi?referrer=google /ad.cgi?thereferrer=google /ad.cgi?keywords=red&referrer=google /scripts/ad.cgi?referrer=google&keywords=red /googlead.cgi?referrer=googlegroups&keywords=red Visitors entering through these entry pages would not be attributed to the given campaign, channel, and segment:/ad.cgi?referrer=yahoo /referral.cgi?referrer=google
Example 2
If the entry pages of a campaign are defined by the filter that match /ad.cgi?referrer=google visitors entering the Web site through the following pages /ad.cgi?referrer=google, would be attributed to the given campaign, channel, and segment:/ad.cgi?referrer=google /ad.cgi?referrer=google&keywords=red /ad.cgi?keywords=red&referrer=google Visitors entering through these pages would not be attributed to the given campaign, channel, and segment:/ad.cgi?referrer=google-groups /ad.cgi?thereferrer=google
Example 3
If the entry pages of a campaign are defined by the filter that end with ad.cgi?google ad.cgi?google, visitors entering the Web site through the following page would be attributed to the given campaign, channel, and segment:/ad.cgi?google Visitors entering through these pages would not be attributed to the given campaign, channel, and segment:/ad.cgi?google-groups /scripts/ad.cgi?referrer=google
N1220001
Version 8.2.1
241
Next you must specify the channels through which you are running this campaign.
N1230001
Analyzing campaigns
In static segments, this is the name that will appear in reports. In dynamic segments, the segment name in reports is the value returned by the segment parameter. 7. Specify whether this channel is static or dynamic. For dynamic channels: a. Enter the parameter whose value will be used to define segments in this channel. The parameter ID is case-insensitive. b. Specify whether to assign a visit to the default segment "None" if the parameter identifier is not found in a parameter string. If left unchecked, Unica NetInsight will search other channels and attempt to make a match for attribution. 8. Click Save Options > Continue Continue. Next, you can optionally specify entry pages associated with this campaign segment. If you choose not to specify entry pages for a dynamic campaign, Unica NetInsight will use parameter values alone to attribute visits to the campaign. Note if you choose not to specify entry pages for a static campaign, all visits will be attributed to the segment's campaign.
N1250001
Version 8.2.1
243
Statistics for this campaign will now be tracked in all subsequently imported data. To track this campaign in data that has already been imported you must delete your profile data and re-import the log files. Note that if you no longer have all previously imported log files, deleting profile data will result in data loss.
N1260001
About paid search data To analyze paid search data without the integration module Creating paid search campaigns to analyze in Unica NetInsight Creating a paid search campaign in Unica NetInsight
Less data than with the integration module Greater chance of error during manual campaign creation
244
Analyzing campaigns
Every paid search campaign you create in a search engine must be associated with a campaign in your profile in order for you to analyze the data in your profiles. The Unica NetInsight campaign must be created before the paid search data is imported into your profile. To simplify your profile configuration and ensure the campaign is always created before the data arrives, Unica recommends using one dynamic campaign in Unica NetInsight to analyze all of your paid search campaigns. In order for your paid search campaign data to be automatically associated with the dynamic campaign, you must define the destination URL using exactly the same parameters and format for all your paid search campaigns.
Destination URL
Use parameters in the query string of the destination URL to indicate the campaign, search engine, search term, and ad group. Use exactly the same parameters in all campaigns in all search engines. Unica recommends the following parameters:
Parameter nicam nichn nipkw niseg Value Campaign name Search engine name Search term Ad group name
You can use additional query string parameters to enable Unica NetInsight to analyze other information about your paid search campaigns. For example, this URL uses the variation parameter to track the ad variation:
http://www.unicaware.com?nicam=Copiers&nichn=Google&nipkw=search%20ter m&niseg=colorcopiers&variation=2
If you use additional parameters, you must define them in Unica NetInsight in order to analyze the data.
Version 8.2.1
245
Name of campaign
Campaign identifier parameter Parameter in the destination URL for the campaign name (for example, nicam). This option is available only in dynamic campaigns. Name of campaign channel Name of the search engine, (for example, Google, Yahoo, or MSN). Parameter in the destination URL for the channel name (for example, nichn). This option is available only in dynamic campaigns. Search engine (PPC/CPM). Keyword parameter you specified in the search (for example, nipkw). engine Name of the ad group in the search engine. Parameter in the destination URL for the ad group (for example, niseg). This option is available only in dynamic campaigns. Destination URL for the ad the in the search engine. (This is required for static campaigns and optional for dynamic campaigns.)
N11A0001
Analyzing keywords
246
Analyzing keywords
N11A000A
About character sets and keywords To create a keywords parsing rule To specify keyword parameters for a keyword rule To specify referrers for a rule To specify an excluded URL for a keyword rule To specify a character set parameter for the keyword rule Keyword parsing example
3. In the Options panel, select Marketing > Keywords Keywords. 4. Click Add Add. 5. In the Description box, enter a description of the rule. 6. In the Type of rule list, select an option. To parse keywords from the query string of the referring page, select Query String String. To parse keywords from the referring page itself, select Page Page.
7. In the Default character set box, select the character set Unica NetInsight should assume the search engine used to encode the keyword in the query string or page. This option only applies to profiles whose character set is UTF-8. 8. Click Save Options and then click Continue Continue. If you selected a keyword parsing rule of type "query string," you now need to specify the keyword parameters that should belong to this keyword rule. If you selected a keyword parsing rule of type "page," the text that appears after the last slash in the page will be used as the keywords. If you want to limit the pages that are parsed for keywords by more than just the referrer, you can configure Unica NetInsight to only parse pages that contain at least one of a set of text strings you specify.
N12C0001
248
Analyzing keywords
If this is what you want or if you want to add more parameters at this time, click Continue If you want the parameter to be used to look for keywords in data you Continue. have already imported, you will need to delete all the data in your profile and reimport your log files. If you do not still have all the log files you have imported into this profile, you will lose data permanently by choosing this option. To delete your profile data, click Delete Profile Data Data. Now you need to specify which referrers should be searched using the keyword rule.
N12D0001
3. In the Options panel, select Marketing > Keywords Keywords. 4. Select the keyword rule and click Excluded URLs URLs. 5. Click Add Add. 6. Enter a filter that describes a URL that should not be searched using the keyword rule and click Add Add. This URL will not be searched using the keyword rule in all new data you import from now on. 7. If this is what you want or if you have more URLs to add at this time, click Continue. If you want this URL to not be searched using the keyword rule in data you have already imported, you will need to delete all the data in your profile and reimport your log files. If you do not still have all the log files you have imported into this profile, you will lose data permanently by choosing this option. To delete your profile data, click Delete Profile Data Data.
N12F0001
250
Analyzing referrers
Analyzing referrers
N11B000A
About analyzing referrers To create a referrer group To add referrers to a referrer group Determining the group for referrers that fit multiple groups
Version 8.2.1
251
252
About analyzing visits from indexing agents To classify a host, user agent, or referrer as a robot or spider To add visitors to a robot/spider group Determining the group for visitors that fit multiple groups
Version 8.2.1
253
About visit cost About collecting visit cost data About including visit cost data in Unica NetInsight reports
254
N1380001
Version 8.2.1
255
N107A8
About analyzing page titles Resolving page titles To edit page title mappings To limit the pages whose titles Unica NetInsight should resolve To add pages whose titles Unica NetInsight should not resolve Security realms
About resolving page titles To resolve page titles To resolve page titles through a proxy server
256
If you do not still have every log file you have imported into this profile, you will lose data by choosing this option. To delete your profile data, click Delete Profile Data Data.
N1400001
1. Click the Administration icon ( 2. Click the Options tab. The Email page appears.
3. In the Options panel, select Network > Proxies Proxies. 4. In the HTTP proxy server box, enter the host name or IP address of your proxy server. 5. In the HTTP proxy server port box, enter the port on which the proxy server is accessible. 6. Click Save Options and then click Continue Continue.
N13B0001
7. Click Save Options and then click Continue Continue. The changes take effect the next time the profile is updated.
N13C0001
Version 8.2.1
259
Unica NetInsight is initially configured to not attempt to resolve the titles of pages that contain /cgibin/ or /scripts/ or that end with .cgi or .exe. You can specify additional pages whose titles Unica NetInsight should not resolve. 1. View the profile in which you want to add pages. 2. Click the Options tab. 3. In the Options panel, select Page Titles > Unresolved Page Titles Titles. 4. Click Add Add. 5. Enter a filter that describes a page or pages whose titles Unica NetInsight should not resolve. 6. Click Add Add. Unica NetInsight does not resolve page titles for pages that match these filters in data you import from now on. 7. If this is what you want, or if you have additional filters you want to add at this time, click Continue Continue. If you want Unica NetInsight to not resolve page titles for pages that match these filters in data you have already imported, you must delete your profile data and reimport your log files. If you do not still have every log file that you have imported into this profile, you will lose data by choosing this option. To delete profile data, click Delete Profile Data Data.
N13E0001
Security realms
N13E000A
About adding security realms To create a security realm About determining the security realm for pages that fit multiple realms
260
Security realms
About determining the security realm for pages that fit multiple realms
A page can belong to only one security realm. If you have a page that meets the criteria for more than one realm, NetInsight includes the page in the first realm to which it can belong. You can use the Move Up and Move Down buttons to change the order of the security realms in the Security realms for page title resolution list.
Version 8.2.1
261
N107E6
About retail activity How Unica NetInsight gathers retail data What retail data Unica NetInsight can gather Retail reports
Viewing products Adding products to a shopping cart Removing products from a shopping cart Completing the checkout process
Retail reports
N1460001
Products added to a shopping cart (SKU, quantity, and unit price) Products removed from a shopping cart (SKU, quantity, and unit price) Revenue associated with a shopping cart Order number Products purchased (SKU, quantity, and unit price) Pay-per-click revenue
Retail reports
N1460007
In addition, retail metrics, dimensions, and filters can be added to other NetInsight summaries.
N1470001
Version 8.2.1
263
N10805
About analyzing visitors Analyzing visitors or users by browser Analyzing visitors or users by department Analyzing visitors by host Analyzing visitors or users by platform To change the number of minutes between visits To specify an opt-out cookie value To use the sessionization parameter value for visitor identification To change how Unica NetInsight sessionizes traffic About using visitor identification cookies Analyzing visitor profiles
About analyzing visitors by browser To create a browser To add user agents to a browser About determining the browser for user agents that fit multiple browsers
Unica NetInsight - Administrator's Guide
To create a browser
1. View the profile in which you want to create the browser. 2. Click the Options tab. 3. In the Options panel, select Visitors > Browsers Browsers. 4. Click Add Add. 5. In the Name of browser box, enter the name you want to have displayed for the browser. 6. If you want each major version of the browser to be reported separately, select the Append the version number check box. You will have to use the regular expression (\d+\.) in the definition of the user agents of the browser so Unica NetInsight will retain the version information when it imports your log. 7. Click Save Options and then click Continue Continue. Now you need to specify which user agents you want to be part of this browser.
N1540001
4. Select the browser and click User Agents Agents. 5. Click Add Add. 6. Enter a filter that describes the user agent you want to add to this browser and click Add Add. The user agent you entered will be part of this browser in all new data you import from now on. 7. If this is what you want or if you have more user agents to add at this time, click Continue Continue. If you want the user agent to belong to the browser in data you have already imported, you will need to delete all the data in your profile and reimport your log files. If you do not still have all the log files you have imported into this profile, you will lose data permanently by choosing this option. To delete your profile data, click Delete Profile Data Data.
N1550001
About determining the browser for user agents that fit multiple browsers
A user agent can only belong to one browser. If you have a user agent that meets the criteria for more than one browser, Unica NetInsight includes the user agent in the first browser it can belong to in the list of browsers. You can use the Move Up and Move Down buttons to change the order of the browsers in the list.
N14A0001
About analyzing visitors by department To create a department To add hosts and users to a department About determining the department for hosts and users that fit multiple departments
266
You can configure Unica NetInsight to determine department groupings using an external database (such as a corporate directory).
N1560001
To create a department
1. View the profile in which you want to create the department. 2. Click the Options tab. 3. In the Options panel, select Visitors > Departments Departments. 4. Specify what Unica NetInsight should display when you click the department name in the Department Summary. To display the host names/IP addresses, click Hosts Hosts. To display the user names, click Users Users.
5. Click Save Options and then click Continue Continue. 6. Click Add Add. 7. Enter the name you want displayed for this department. 8. Click Save Options and then click Continue Continue. Now you need to specify which hosts and users you want to be part of this department.
N1570001
If you do not still have all the log files you have imported into this profile, you will lose data permanently by choosing this option.To delete your profile data, click Delete Profile Data Data.
N1580001
About determining the department for hosts and users that fit multiple departments
A host or user can only belong to one department. If you have a host or user that meets the criteria for more than one department, Unica NetInsight includes the host or user in the first department it can belong to in the list of departments. You can use the Move Up and Move Down buttons to change the order of the departments in the list.
N14B0001
About analyzing visitors by host To create a host group To add hosts to a host group About determining the host group for hosts that fit multiple groups
268
5. In the Name of host group box, enter the name you want to have displayed for the host group. 6. In the Domain of host group box, enter the domain in which you want to have the group included in the Domain Summary. For example, to have the host group included in Commercial (.com) enter Commercial (.com) (.com). 7. If you do not want to have cookies used when sessionizing for hosts in this host group, select the Ignore cookies from this host group check box. For example, some online services do not consistently pass the same cookie for each view in a visit. This can reduce the accuracy of results if cookies are utilized in the visit calculations. In this case, you should select the check box. 8. If you do not want Unica NetInsight to consider the host group a single unit when sessionizing, clear the Use modified host for sessionization check box. 9. Click Save Options and then click Continue Continue. Now you need to specify which hosts you want to be part of this host group.
N15A0001
Version 8.2.1
269
About determining the host group for hosts that fit multiple groups
A host can only belong to one host group. If you have a host that meets the criteria for more than one group, Unica NetInsight includes the host in the first host group it can belong to in the list of host groups. You can use the Move Up and Move Down buttons to change the order of the host groups in the list.
N14C0001
About analyzing visitors by platform To create a platform To add user agents to a platform About determining the platform for user agents that fit multiple platforms
To create a platform
1. View the profile in which you want to group platforms. 2. Click the Options tab. 3. In the Options panel, select Visitors > Plaftorms Plaftorms. 4. Click Add Add. 5. In the Name of platform box, enter the name you want to have displayed for the platform. 6. If you want each major version of the platform to be reported separately, select the Append the version number check box.
270
You will have to use the regular expression (\d+\.) in the definition of the user agents of the platform so Unica NetInsight will retain the version information when it imports your log. 7. Click Save Options and then click Continue Continue. Now you need to specify which user agents you want to be part of this platform.
N15D0001
About determining the platform for user agents that fit multiple platforms
A user agent can only belong to one platform. If you have a user agent that meets the criteria for more than one platform, Unica NetInsight includes the user agent in the first platform it can belong to in the list of platforms. You can use the Move Up and Move Down buttons to change the order of the platforms in the list.
N14D0001
Version 8.2.1
271
272
You can configure Unica NetInsight to recognize an opt-out cookie value. A cookie whose value matches the value you specify is not used for sessionization and is not assigned a cookie ID. The cookie value for the corresponding visits and views will appear as None in reports. 1. View the profile in which you want to specify an opt-out cookie value. 2. Click the Options tab. 3. In the Options panel, select Visitors > Sessionization Sessionization. 4. In the Opt-out cookie value box, enter the opt-out cookie value. This value is casesensitive. 5. Click Save Options Options. Unica NetInsight will use the opt-out cookie value in all new data that you import from now on. 6. If this is what you want, click Continue Continue. If you want Unica NetInsight to use the opt-out cookie value in data you have already imported, you will need to delete your profile data and reimport your log files. If you do not still have every log file that you have imported into this profile, you will lose profile data by choosing this option. To delete profile data, click Delete Profile Data Data.
N14F0001
Version 8.2.1
273
Unica NetInsight uses this parameter value for visitor identification in all new data that you import from now on. 6. If this is what you want, click Continue Continue. If you want Unica NetInsight to use this parameter value for visitor identification in data you have already imported, you will need to delete your profile data and reimport your log files. If you do not still have every log file that you have imported into this profile, you will lose profile data by choosing this option. To delete profile data, click Delete Profile Data Data.
N1500001
Parameters whose values are not being stored in the Unica NetInsight database do not appear in the list of parameters.
274
5. If you want Unica NetInsight to use the authenticated user name to determine sessionization, select the Authenticated user name check box. 6. If you want Unica NetInsight to use a visitor identification cookie to determine sessionization, select the Visitor identification cookie check box. Then enter the name of the cookie. If you are using the Unica Web Server Plug-in, leave the cookie name set to the default. 7. If your Unica NetInsight installation is configured to use page tagging, select an option in the Cookie Source field to determine which page tags will be used for sessionization. AUTO Use this option if you want to include cookies from both the ck AUTOM parameter in the page tag request and the cookie field in the log file. FIELD Use this option if you want to include only cookies from the cookie field FIELDM in the log file. PAGETAG Use this option if you want to include only the cookie(s) specified PAGETAGM by the ck parameter of the page tag request. The cookie source options are available only if you have set page tagging options for the profile to Used instead of log files to collect data for a single site or Used instead of log files to collect data for multiple sites sites. 8. Click Save Options Options. Unica NetInsight will sessionize traffic according to your specifications for all new data that you import into this profile. 9. If this is what you want, click Continue Continue. If you want Unica NetInsight to use your specifications to sessionize log file data you have already imported, you will need to delete your profile data and reimport your log files. If you do not still have every log file that you have imported into this profile, you will lose profile data by choosing this option. To delete profile data, click Delete Profile Data Data.
N1510001
Version 8.2.1
275
If your cookie contains multiple name/value pairs separated by ampersands (for example, YourID=First=John&Last=Doe&Number=123), enter the cookie name, an equal sign, and the name of the cookie fragment that contains the information on which you want to sessionize. (In the example above, you would enter YourID=Number if you want to sessionize by the Number parameter.) For the data that Unica NetInsight generates to be accurate using your own cookie rather than the default SaneID, you also need to be setting cookies in the same manner as the Unica Web Server Plug-in. On a visitor's first request for a page from the Web site, you must set a cookie in the visitor's browser (if the visitor does not already have one). For each subsequent request to the Web site during this first visit and any other visits made to the Web site, the server must read this cookie and record it in the Web log in its cookie field. To prevent visitors who have cookies turned off from getting a new cookie for every new page view, ensure you are logging the cookie received by the Web server and not the cookie sent by the Web server.
N1520001
About analyzing visitor profiles To create a visitor profile About changing the order of visitor profiles
6. Click Save Options and then click Continue Continue. 7. Select the visitor profile and click Visitors Visitors. 8. Click Add Filter Filter. 9. Select a filter type from the list and click Continue Continue. 10. Enter the values for the filter. 11. Click Continue Continue. 12. Repeat 8 through 11 until you have entered all the filters you want for the visitor profile. 13. Click Save Filters and then click Continue Continue. You cannot add a filter group that contains a visitor profile to a visitor profile. Your visitor profiles will be in effect the next time you run an update.
N1600001
Version 8.2.1
277
N108A0
About database sessions Administering the Inbox About NetInsight options Configuring main options Configuring network options Configuring security Configuring roles and users About customizing the NetInsight interface Working with views Working with roles and views Working with report lists Working with dimension lists Working with filter lists Working with metric lists About default profile options Data and license administration Troubleshooting NetInsight
About database sessions About custom log file formats About environment variables About Unica NetInsight email options About locale options About Unica options About DNS options About proxy servers About authentication options About Unica Marketing Platform authentication About restricting access to the Profile Manager About roles About user managers About user configuration
Version 8.2.1
279
N1740001
Display time as You select whether you want NetInsight to display times using the as. 12-hour clock or the 24-hour clock. Display date as You select the date format you want NetInsight to use. The date as. and time settings primarily affect the footer on the Profile Manager pages. Character set You select the character set that NetInsight uses to display text in the set. Profile Manager. Language You select the language that NetInsight uses to display text. The Language. languages available depend on which Language Packs you have installed.
280
Version 8.2.1
281
While using LDAP or Web server authentication directly is available, it is recommended that you integrate your LDAP or Web server users through the Unica Marketing Platform, and select Unica Marketing Platform authentication. Regardless of the authentication method you select, you must create users in the internal user database with the same user names as assigned in the Unica Marketing Platform, LDAP, or the Web server, so that you can associate them with roles and views for particular profiles.
N1790001
282
About roles
A role is a collection of privileges. Roles control which icons and options appear to users. For example, if the role does not include the Interface : Icon : Export privilege, the Export icon is not displayed in the toolbar. You do not need to use roles. However, roles are useful in restricting access to certain features. While roles hide certain features by not including links to those pages in the interface, a motivated user can still access those pages through a Web browser by directly typing in the appropriate URL. To prevent access to such pages, use your Web server's security features. Several roles are defined by default. You can modify these as well as create new roles.
N17C0001
Version 8.2.1
283
About using the Administrator only setting with user manager roles
When you create a user manager role, you have the option of whether or not to select the Administrator only setting for that role. If the Administrator only setting:
Is selected, the user managers can create other user managers. They can also change the role assigned for their own accounts.
Typically, you would want to enable this setting for all roles with administration privileges. You may also want to enable it for certain non-administration roles. For example, if your company has site-specific roles (for example, "Boston Average User," "Paris Average User") you may want to create user managers that can only create and edit users for a specific site.
N17D0001
Is not selected, the user managers cannot create other user managers or change the role assigned for their own accounts.
To specify database sessions To define a custom log file format To add an environment variable To edit an environment variable To delete an environment variable To change the time format To change the date format To change the character set To change the language used Inbox options
284
1. Open the administration home page by clicking on the Administration icon ( 2. Click the Options tab. 3. In the Options panel, select Main > Advanced Advanced. The Advanced options screen opens.
).
4. In the Database session options field, enter the parameters that should use when connecting to the database. For example, if you are using Oracle, you can enter the follow code to produce a trace file for each report, to aid in troubleshooting problems:
SQL_TRACE=TRUE
Version 8.2.1
285
4. Click Add Add. The Environment variables definition screen opens. 5. Enter a value in the Name of variable field. 6. Enter a value in the Value of variable field. 7. Click Save Options then click Continue Options, Continue. The environment variables is now available for use.
N17F0001
).
).
1. Open the administration home page by clicking on the Administration icon ( 2. Click the Options tab. 3. In the Options panel, select Main > Locale Locale. The Locale Options screen opens. 4. In the Display time as drop-down list, select the format to use. You can select: 12 hour clock 24 hour clock
).
5. Click Save Options then click Continue Options, Continue. Changes to the time format are saved and take effect immediately.
N1820001
5. Click Save Options then click Continue Options, Continue. Changes to the date format are saved and take effect immediately.
N1830001
Version 8.2.1
287
1. Open the administration home page by clicking on the Administration icon ( 2. Click the Options tab. 3. In the Options panel, select Main > Locale Locale. The Locale Options screen opens. 4. In the Character drop-down list, select the character set to use. 5. Click Save Options then click Continue Options, Continue.
N1840001
).
1. Open the administration home page by clicking on the Administration icon ( 2. Click the Options tab. 3. In the Options panel, select Main > Locale Locale. The Locale Options screen opens. 4. In the Language drop-down list, select the language to use. 5. Click Save Options then click Continue Options, Continue.
).
If you change the language, for the complete translated interface to appear, you must use the command line option admin -regen.
N1850002
Inbox options
Use the following options to configure the Inbox for your Unica NetInsight installation.
Option Max Running Reports Per User Global Max Running Description The maximum number of reports with the status Running that a user can have. The default is 5. A value of 0 means there is no limit. The maximum number of reports with the status Running that can be in the system, regardless of which user requested them. The default is 200. A value of 0 means there is no limit.
288
Completed Reports The maximum number of reports with a status of Canceled by Admin, Completed, Stored per User or Failed that a user is allowed to retain in the Inbox. The default is 100. When this limit is reached, Unica NetInsight deletes reports. Run Queued Reports Clearing this checkbox turns off report generation. Any reports waiting to be generated and any new report requests will stay in the queue until this option is enabled. Typically you would clear this checkbox only if you were performing maintenance on your system.
N1640001
To modify Unica options To specify DNS options To modify Unica NetInsight email options
1. Open the administration home page by clicking on the Administration icon ( 2. Click the Options tab. 3. In the Options panel, under Network click Unica Network, Unica. The Unica Options screen opens. 4. Edit the Unica Marketing Platform URL as needed.
).
If you enter the incorrect Unica Marketing Platform URL users are not able to URL, log in. The error message states that the login failed, but does not specify that Unica Marketing Platform was not reachable. 5. Click Save Options then click Continue Options, Continue. Changes to the Unica options are saved.
N1860001
).
3. In the Options panel, select Network > DNS DNS. The DNS Options screen opens. 4. In the DNS server address field, enter the host name or IP address of a DNS server. 5. In the Maximum simultaneous DNS requests field, enter the number of IP addresses Unica NetInsight should attempt to resolve at once. The default is 2000. 6. In the Reverse DNS timeout field, enter the number of seconds you want Unica NetInsight to wait before stopping a DNS lookup (to resolve host names). The slower your connection, the larger your timeout setting should be. Enter a number from 2 to 120. The default is 3. 7. In the Reverse DNS retries field, enter the number of times that Unica NetInsight should try to resolve a given IP address. Enter a number from 0 to 100. The default is 4. 8. Click Save Options and then click Continue Continue.
N1870001
1. Open the administration home page by clicking on the Administration icon ( 2. Click the Options tab. 3. In the Options panel, select Network > Email Email. The Email Options screen opens. 4. Edit the email options as needed.
).
a. In the Mail server (SMTP) field, enter the name of a valid SMTP email server to deliver emailed reports. b. Enter a valid port number in the Mail Server Port field (the default port for SMTP is port 25). c. Enter a valid email address in the From address field. Any undeliverable reports are returned here by default. This address can be overridden in configured email tasks. d. Enter a valid email address in the Administrator's address field. Any errors are reported to this address. 5. Click Save Options then click Continue Options, Continue.
290 Unica NetInsight - Administrator's Guide
Configuring security
Changes to the email options are saved and take effect immediately.
N1650001
Configuring security
N165000A
To specify the internal database as the authentication method To specify the Unica Marketing Platform as the authentication method To specify LDAP as the authentication method To specify the Web Server as the authentication method
1. Open the administration home page by clicking on the Administration icon ( 2. Click the Options tab. 3. In the Options panel, select Users > Authentication Authentication. The Authentication options screen opens. 4. In the Authenticate using list, select Internal database database. 5. In the Logins expire list, select how you want users to be logged out.
).
To have authenticated users stay logged on until they manually log out, select Never Never. To have users' logins expire when their browsers close, select When the browser is closed closed.
6. Set password requirements as needed. Enter the Minimum length for user's passwords. Enter the Minimum number of numeric characters for user's passwords. Enter the Minimum number of uppercase or special characters for user's passwords.
7. Optionally, to prevent users not based on a role with the Administrator: Administration: Profile Manager privilege from access the Profile Manager, check Restrict Access to Profile Manager Manager. For security reasons, it is highly recommended that you check this option. 8. Click Save Options then click Continue Options, Continue.
N1880001
Version 8.2.1
291
6. Optionally, to prevent users not based on a role with the Administrator: Administration: Profile Manager privilege from accessing the Profile Manager, check Restrict Access to Profile Manager Manager. If you do not restrict access to the Profile Manager, it is available to both authenticated and unauthenticated users. For security reasons, Unica highly recommends that you restrict access to the profile manager. 7. Click Save Options then click Continue Options, Continue. You can now create users in Unica NetInsight and Unica Marketing Platform.
N1890001
1. Open the administration home page by clicking on the Administration icon ( 2. Click the Options tab. 3. In the Options panel, select Users > Authentication Authentication. The Authentication options screen opens. 4. In the Authenticate using list, select External database database. Fields in which to identify the data conduit appear on the screen.
292
).
Configuring security
5. In the Logins expire list, select how you want users to be logged out. To have authenticated users stay logged in until they manually log out, select Never Never. To have users' logins expire when their browsers close, select When the browser is closed This is the more secure option and is highly recommended. closed.
6. In the Full path to conduit field, enter the full path (including the filename) to the .dll (Windows) or .so (UNIX) file for the conduit. 7. In the Full path to conduit config field, enter the full path (including the filename) to the configuration file for the conduit. 8. Optionally, to prevent users not based on a role with the Administrator: Administration: Profile Manager privilege from access the Profile Manager, check Restrict Access to Profile Manager Manager. For security reasons, it is highly recommended that you check this option. 9. Click Save Options then click Continue Options, Continue.
N18A0001
1. Open the administration home page by clicking on the Administration icon ( 2. Click the Options tab. 3. In the Options panel, select Users > Authentication Authentication. The Authentication options screen opens. 4. In the Authenticate using list, select Web server server. Fields in which to identify the data conduit appear on the screen. 5. In the Full path to conduit field, enter the full path (including the filename) to the .dll (Windows) or .so (UNIX) file for the conduit.
).
6. In the Full path to conduit config field, enter the full path (including the filename) to the configuration file for the conduit. 7. Optionally, to prevent users not based on a role with the Administrator: Administration: Profile Manager privilege from access the Profile Manager, check Restrict Access to Profile Manager Manager. For security reasons, it is highly recommended that you check this option.
Version 8.2.1
293
To create a role To copy a role To assign or edit privileges for a role To edit a role To delete a role To create a user manager To create a user To modify a user To specify a user's profile settings To delete a user
To create a role
When you first create a role, that role has no privileges associated with it. If you want to create a role that shares many of the same privileges as an existing role, you can copy the existing role. You can then change only those privileges for the new role that must be different.
1. Open the administration home page by clicking on the Administration icon ( 2. Click the Options tab. 3. In the Options panel, under Users click Roles Users, Roles. The Role definitions screen opens. 4. Click Add Add. The Role description screen opens. 5. Enter the name and title of the role.
).
6. Optionally, check the Administrator only box to prevent user managers from adding or editing user accounts associated with this role. 7. Click Save Options then click Continue Options, Continue. After you create a new role, you must assign it privileges.
N18B0001
294
To copy a role
When you copy a role, its defined privileges are copied into the new role. Therefore, when you want to create a new role that is to have most, but not all, of the same privileges, you can copy a role and makes changes to its assigned privileges.
1. Open the administration home page by clicking on the Administration icon ( 2. Click the Options tab. 3. In the Options panel, select Users > Roles Roles. The Role definitions screen opens. 4. Select the role that you want to copy. 5. Click Copy Copy. The Role description screen opens. 6. Enter a new, unique name in the Role name field. 7. Edit the value in the Title of role field. 8. Click Save Options then click Continue Options, Continue.
N18C0001
).
1. Open the administration home page by clicking on the Administration icon ( 2. Click the Options tab. 3. In the Options panel, select Users > Roles Roles. The Role definitions screen opens. 4. Select the role for which you want to assign or edit privileges. 5. Click Privileges Privileges. The Privileges granted to role screen opens. 6. Modify privileges as needed. Privileges already associated with the role are in the Granted privileges list. Privileges in the system that are not associated with the role are in the Available privileges list.
).
Select list items and use the arrow keys to move them between lists as necessary. 7. Click Save Options then click Continue Options, Continue.
N18D0001
Version 8.2.1
295
To edit a role
You can change the title of an existing role and the Administrator only setting. You cannot change the name of an existing role. The title of the role appears in the list of roles. The name of the role is used internally.
1. Open the administration home page by clicking on the Administration icon ( 2. Click the Options tab. 3. In the Options panel, under Users click Roles Users, Roles. The Role definitions screen opens. 4. Select the role that you want to edit. 5. Click Edit Edit. The Role description screen opens. 6. Edit the value in the Title of role field.
).
7. Optionally, check or clear the Administrator only box to prevent user managers from adding or editing user accounts associated with this role. 8. Click Save Options then click Continue Options, Continue.
N18E0001
To delete a role
When you delete a role that is associated with users, those users are then not associated with any role. When you delete a role, there is no confirmation step before the role is removed. Be sure that you want to delete the role before proceeding.
1. Open the administration home page by clicking on the Administration icon ( 2. Click the Options tab. 3. In the Options panel, under Users click Roles Users, Roles. The Role definitions screen opens. 4. Select the role that you want to delete. 5. Click Delete Delete. The role is deleted. 6. Click Continue Continue.
N18F0001
).
296
3. For each role that should not be editable by user managers, ensure that the Administrator only setting is selected. This makes the role (and its associated user accounts) exempt from editing by user managers. Typically you would want to enable this setting for all roles with administration privileges. You may also want to enable it for certain non-administration roles. For example, if your company has site-specific roles (for example, "Boston Average User," "Paris Average User") you may want to create user managers that can only create and edit users for a specific site. 4. Assign users to the user manager role as desired.
N1900001
To create a user
When you create a user, you base the user's privileges on a role. You can use the roles delivered with Unica NetInsight or create custom roles. If you are using the Unica Marketing Platform for authentication, the User name you enter must match the user name created in the Unica Marketing Platform
1. Open the administration home page by clicking on the Administration icon ( 2. Click the Options tab. 3. Under Options select Users > Users Options, Users. The NetInsight users screen opens. 4. Click Add Add. The User description screen opens. 5. Fill in the user information.
).
Version 8.2.1
297
Note the following: The User name value is case-insensitive. The Full name value appears in the welcome message located in the upper-right corner of the Unica NetInsight home page. The Full name Email address and Password fields only appear if Unica name, address, NetInsight is configured to authenticate users through its internal database. If Unica NetInsight is configured to authenticate users through the Unica Marketing Platform, an external database or a Web server, you do not enter this information. The Default role list contains all the defined roles. The default role you specify controls the interface for all profiles except those in which a specific role has been specified for this user or the default role for the profile is (No Access). It also controls whether the user has the right to change the password or the default view for each profile, among other privileges. The Default reporting mode list contains two options: Full and Sample The Sample. default mode you specify controls the reporting mode for all profiles except those in which a specific default reporting mode has been specified for this user.
6. Click Save Options then click Continue Options, Continue. If you are using the Unica Marketing Platform for authentication, you must now create users in the Unica Marketing Platform with the same user names you entered in Unica NetInsight. When users first log into Unica NetInsight and are authenticated against the Unica Marketing Platform, they must change their passwords. Users cannot change their passwords through Unica NetInsight; they must open the Unica Marketing Platform, log in, and change their passwords. After you create a user account, instruct the user to log on to his or her Unica NetInsight home page at http://NetInsight_URL/index.html.
N1910001
To modify a user
Follow these instructions to modify a user's full name, email address, password, default role, and default reporting mode.
1. Open the administration home page by clicking on the Administration icon ( 2. Click the Options tab. 3. Under Options select Users > Users Options, Users. The NetInsight users screen opens. 4. Select the user to edit. 5. Click Edit Edit.
).
298
The User description screen opens. 6. Fill in the user information. Note the following: The Full name value appears in the welcome message located in the upper-right corner of the Unica NetInsight home page. The Full name Email address and Password fields appear only if Unica name, address, NetInsight is configured to authenticate users through its internal database. If Unica NetInsight is configured to authenticate users through Unica Marketing Platform, an external database or a Web server, you do not enter this information. The Default role list contains all the defined roles. The default role you specify controls the interface for all profiles except those in which a specific role has been specified for this user or the default role for the profile is (No Access). It also controls whether the user has the right to change the password or the default view for each profile, among other privileges. The Default reporting mode list contains two options: Full and Sample The Sample. default mode you specify controls the reporting mode for all profiles except those in which a specific default reporting mode has been specified for this user.
Version 8.2.1
299
This does not prevent the user from changing to another view or restrict access to any view. The default view makes it easier for users to see a relevant view of the data when they first access the profile. It is not a means of enforcement to prevent a user from accessing specific reports, dimensions, filters, or metrics. For default reporting mode, select the mode you want to be the default for this user in this profile. This does not prevent the user from changing to a different reporting mode. It determines the reporting mode when the user first accesses the profile.
To delete a user
1. Open the administration home page by clicking on the Administration icon ( 2. Click the Options tab. 3. Under Options select Users > Users Options, Users. The NetInsight users screen opens. 4. Select the user to delete. 5. Click Delete Delete. The user is permanently deleted from the internal database and that user can no longer access Unica NetInsight, even if the user account still exists within Unica Marketing Platform.
N1670001
).
About profile views About dimension lists About filter lists About metric lists About the profile default role, view, and reporting mode About role default view settings
Report list
You can create profile views to make it more convenient for users who want to view only a subset of, or to provide convenient access to, customized dimensions, filters, metrics, and reports. Views also allow you to group the dimensions, filters, metrics, and reports into folders that may be more intuitive or convenient for your users. You can combine profile views with user authentication to block some users from viewing some reports. A default profile view is automatically generated when a profile is created and initially contains all available dimensions, filters, metrics, and reports. Before you create a profile view, you need to create the dimension list, filter list, metric list, and report list you want to use in the profile and populate those lists with the desired dimensions, filters, metrics, and reports.
N1940001
Version 8.2.1
301
To create a profile view To edit a profile view To copy a profile view To delete a profile view To change to another profile view About accessing a profile view through a URL
2. In the left panel, under Interface click Views Interface, Views. The View definitions screen opens. 3. Click Add Add. The View description screen opens. 4. In the Name of view (one word) field, enter a name for the view. The name is used both internally and as a shortcut to access the view directly from a browser. You may use only alphanumeric characters and hyphens, and the first character must be a letter. Once the view is created, you cannot change the name. 5. In the Title of view field, enter a title for the view. The title appears in the list of views. 6. From the Time period list, select the time period to be used by the calendar when you first open Unica NetInsight . 7. From the Report list list, select the report list to use for the view. 8. From the Dimension list list, select the dimension list to use for the view. 9. From the Filter list list, select the filter list to use for the view. 10. From the Metric list list, select the metric list to use for the view. 11. Click Save Options then click Continue Options, Continue.
N1990001
304
1. While working with the profile, click the Reports Reportstab. 2. In the Available Reports panel title bar, click the Change View icon. A list of available views appears. 3. Click the view to change to. To return to the current view from the list of available views, click Close in the heading of the list. The list of available views closes and the current view does not change.
N19D0001
To set the default role, view, and reporting mode for a profile To set a new role default view To edit a role default view setting To delete a role default view setting
To set the default role, view, and reporting mode for a profile
You must create the role and view to use as the default for a profile before completing the instructions below. If you want to use Sample as the default reporting mode, specify a sample size and generate the sample tables and reports. 1. While working with the profile, click Options Options. Or, if you are an administrator setting defaults for all new profiles users create, click the Administration icon ( ). Select the Options tab, then from the Unica NetInsight options drop-down menu, select Edit Default Web Server Options Options. 2. In the left panel, under Interface click profile Defaults Interface, Defaults.
Version 8.2.1
305
The profile defaults screen opens. 3. From the Default role list, select the role you want to be the default for the profile. The list contains all roles defined in the administrative options. Select (None) if there is no default role for the profile. If there is no default role, users who do not have a default role specified in the administrative options or who have not logged on before accessing the profile have all privileges for this profile. 4. From the Default view list, select the view you want to be the default view for this profile. The list contains all views defined in the profile. 5. From the Default reporting mode list, select the reporting mode you want to be the default for the profile. 6. Click Save Options then click Continue Options, Continue.
N19E0001
5. From the Default view list, select the view you want to be this role's default view for this profile. The list contains all the views that have been defined for this profile. 6. Click Save Options then click Continue Options, Continue.
N1A00001
To create a report list To edit a report list To copy a report list To manage folders for a report list To delete a report list
308
Then select a report from the Report source list, and optionally change the Report title field. Click Save Options then click Continue Options, Continue. f. Click Save Options then click Continue Options, Continue.
To create a dimension list To edit a dimension list To copy a dimension list To manage groups for a dimension list To delete a dimension list
6. Click Save Options then click Continue Options, Continue. You can now create groups for the dimension list.
N1A50001
To create a filter list To edit a filter list To copy a filter list To manage groups for a filter list To delete a filter list
The title appears in the list of filter lists. The title also appears as the heading of the filter list in the Discovery Panel. 6. Click Save Options then click Continue Options, Continue. You can now create groups for the filter list.
N1AA0001
The Group definitions screen opens. 5. Add, edit, and delete groups as necessary. 6. To manage filters in the group: a. Select the group. b. Click Filters Filters. c. Click Add to add a filter. Then select a filter from the Filter source list, and optionally change the Filter title field. Click Save Options then click Continue Options, Continue. d. Select a filter and click Delete to remove a filter from the group. Then click Continue Continue. e. Select a Filter and click Edit to modify the filter. Then select a filter from the Filter source list, and optionally change the Filter title field. Click Save Options then click Continue Options, Continue. f. Click Save Options then click Continue Options, Continue.
To create a metric list To edit a metric list To copy a metric list To manage groups for a metric list To delete a metric list
Version 8.2.1
315
2. In the left panel, under Interface click Metric Lists Interface, Lists. The Metric list definition screen opens. 3. Select the metric list to copy. 4. Click Copy Copy. The Metric list description screen opens. 5. In the Name of metric list field, enter the one-word name for the metric. The name is used internally. You may use only alphanumeric characters and hyphens, and the first character must be a letter. Once you have created the metric list, you cannot change the name. 6. In the Title of metric list field, modify a title for the list as needed. The title appears in the list of metric lists. The title also appears as the heading of the metric list in the Discovery Panel. 7. Click Save Options then click Continue Options, Continue. You can now modify groups for the metric list.
N1AF0001
e. Select a metric and click Edit to modify the metric. Then select a metric from the Metric source list, and optionally change the Metric title field. Click Save Options then click Continue Options, Continue. f. Click Save Options then click Continue Options, Continue.
To set profile defaults To upgrade your license To back up and restore Unica NetInsight data To move Unica NetInsight to another computer To move Unica NetInsight to another computer without reimporting log file data
1. Open the Profile Manager. 2. Click the Options tab. 3. In the Unica NetInsight Options list at the top of the page, select Edit Default Web Server Options Options. 4. Make changes as needed. Be sure to click Save Options before leaving a page that has changes you want to keep. The next profile that you create will use these new defaults.
N1B10001
e. Go to the command line and change to the Unica NetInsight program directory. f. Restore the database.
g. Run the following command to regenerate appropriate HTML for all profiles:
nettracker all -regen
N1B30001
To move Unica NetInsight to another computer without reimporting log file data
Provided the database type is the same, you can copy the database files between two installations of Unica NetInsight even if the installations are running on different architectures (for example, Windows and Linux). 1. Install Unica NetInsight on the second computer. 2. Create empty profiles with the same names as the profiles on the first computer. This is the name that appears in parentheses in the list of profiles in the Profile Manager. You do not need to set any of the configuration options for these profiles. 3. Copy the data directory from the first computer to the second computer.
320
Troubleshooting NetInsight
The data directory is located in the Unica NetInsight program directory. (On Windows the default program directory is C:\Program Files\Unica NetInsight. On UNIX the default program directory is /usr/local/Unica NetInsight.) 4. Copy the database tables from the first computer to the second. 5. Run nettracker all -regen (from the program directory) on the second compute to regenerate the associated HTML files. 6. Remove Unica NetInsight from the first computer. For information about moving users, roles, and profiles, please contact Technical Support.
N1700002
Troubleshooting NetInsight
N1700008
About Unica NetInsight system logs To configure Unica NetInsight system logs About the Unica NetInsight process log
Version 8.2.1
321
15 - NetInsight System Administration Log ADS ANALYSIS CACHEMEM CHKPOINT CHKPTSTAGES IMPORTSTATS Stores Data On Execution plan for report generation. Time taken for table analysis on the database. ID cache memory used by checkpoint. Basic statistics on checkpoint execution. Checkpoint data broken out by phases. Summary statistics on imports broken out by individual Web log file. How long indexes take to generate. Paid search integration data import. Start and stop times of events associated with major processes. SQL query execution. ID reconciliation. Sampling statistics and timing. Translating temporary IDs to permanent.
322
Troubleshooting NetInsight
3. To enable or disable a particular log, or to set its logging level, select the log from the list and click Edit Edit. The range of available logging levels for system logs includes the industry-standard FATAL, ERROR, WARNING, INFO, DEBUG and TRACE with FATAL logging only fatal error messages and TRACE logging all available application messages.
N1B60002
Note that when an update is performed it also spawns import, sample, report generation processes. Process logs are stored in netinsight_root\data\profile_name\logging\. The file name convention is process_datetimestamp_process_id.log. For example, process_200903201419_3128.log.
Version 8.2.1
323
The username of the logged-in system user. The event name The event type. Either 0 (instant), 1 (start of a process), or 2 (end of a process). Descriptive text of the event. In the case of an error condition, this includes the Unica NetInsight error text, if any. For example, [2009-03-20 14:19:32] [TRACE] a_user,Checkpoint Phase,1,Spider Retail
324
N10AB3
About the NetInsight data conduit About deploying a data conduit About lookups versus rewrites To install the data conduit on Windows To install the data conduit on UNIX To set environment variables About the data conduit configuration file Using the APITest utility Using the data conduit Data conduit directives
For user authentication and user information (the user's full name and email address), you specify the data conduit and configuration file on the Authentication page in the administrative options. For all other data, you specify the data conduit and configuration file on the Data Conduits page of the profile options for the NetInsight profile in which you want to use the data. You must set up these data conduits on a profile-by-profile basis. You can use different data conduits with different profiles.
N1B80001
Cookie data Department data Host data Information about parameter values Page title data
Unica NetInsight - Administrator's Guide
Rewrites can be applied to page and parameter data based on data stored in a database or directory. Information resulting from rewrites replace the values originally imported from log files in the Unica NetInsight database.
N1BA0001
Version 8.2.1
327
For ODBC: For UNIX, if you are using the iODBC driver, you must set ODBCINI. You may also need to set environment variables if you are using other third-party drivers. For Oracle, if you are not using the Oracle Instant Client, you must set ORACLE_HOME and NLS_LANG (Note that if you are using the Oracle data NLS_LANG. conduit with NetInsight for Oracle these values are pre-set.) If you are using the Oracle Instant Client, you must set the environment variable for your operating system. On Windows systems, also ensure the Oracle Instant Client is in your path. Solaris = LD_LIBRARY_PATH HP-UX = SHLIB_PATH Linux = LD_LIBRARY_PATH
To set environment variables: 1. Open the Unica NetInsight Profile Manager Manager. 2. Click the Options tab. 3. In the left panel, select Main > Environment Variables Variables. 4. Click Add Add. 5. Enter the name of the environment variable you want to set. 6. Enter the value to which the environment variable should be set. DB2 examples:
LC_CTYPE = C
DB2INSTANCE = db2inst1
Oracle examples
ORACLE_HOME = /home/oracle/u01/app/oracle/product/10.1.0
NLS_LANG = AMERICAN_AMERICA.WE8ISO8859P1
328
For example, suppose you want the data conduit to return a product name from a database based on a URL parameter value. In that case you would configure a parameter value lookup directive. In that directive you would specify the name of the URL parameter (as previously defined it in NetInsight), the database table that contains the product name, the column containing the product name, and the column containing the product ID to be matched against the URL parameter value. The configuration file is located in the same directory where you installed the data conduit. It is named ntdidatabase.conf. Each line in the configuration file is composed of a case-sensitive directive followed by the value to be associated with the directive. Note that:
N1BE0001
Lines preceeded by a pound sign (#) are comments. You do not need to use quotation marks to group values that contain spaces. Anything after the directive and before the end of the line is considered the value for the directive.
For a parameter lookup on a UNIX system using the MySQL data conduit enter: ./apitest ntdimysql.so ntdimysql.conf lookupparam parameter_name test_value When entering the argument note that: The syntax for specifying the APITest program file, the data conduit program and configuration file, and the operation name is constant. The number of test values you must provide vary depending on the operation you are testing. For more information see the examples in the next section. You do not need to specify the extension of the APITest program file.
4. Specify the operation (lookup, rewrite, or user authentication) to be performed by the data conduit, and the values necessary to perform that operation: For a lookup, specify the lookup type and value. The lookup type is the type of data to be retrieved by the data conduit. Following are the possible types and the value to be provided to the data conduit. (The lookup value is the value to be resolved by the data conduit.) The following list shows the lookup types and values: clip: Clip filename as read from the log files cookie: Cookie as read from the log files department: User name or host name as read from the log files host: Host name or IP address as read from the log files email: NetInsight user name lookupparam: Parameter value as read from the log files title: Page as read from the log files user: User name as read from the log files visitor: Visitor name as read from the log files
If the lookup type is lookupparam, you must also supply the name of the parameter. Note that the parameter name must be lowercase to be properly recognized. For a rewrite, specify the rewrite type and value. The rewrite type is the type of data to be rewritten by the data conduit. Following are the possible types and the value to be replaced. rwpage: Page, file, or clip name rwparam: Parameter value
If the rewrite type is rwparam, you must also supply the name of the parameter. Note that the parameter name must be lowercase to be properly recognized. The rewrite value is the value to be rewritten by the data conduit.
330
For user authentication, specify auth followed by the user name and password to be verified.
Your command line syntax is correct and includes correct file names, casesensitivity, and operation values. The operation you are testing is correctly configured in the data conduit configuration file. The database information you entered in the data conduit configuration file is correct and the database is running.
Cookie lookup
Testing a cookie lookup for a cookie whose name-value pair is 24.123.154.115999914303691:
apitest ntdimysql.dll ntdimysql.conf cookie 24.123.154.115-999914303691
Department lookup
Testing a department lookup for a user whose user name is "jane":
apitest ntdimysql.dll ntdimysql.conf department jane
Host lookup
Testing a host name lookup for a host whose domain name is "junica.com":
apitest ntdimysql.dll ntdimysql.conf host unica.com
Page rewrite
Testing a page rewrite for a page whose path/file name is "/site/store/products/aq101.html":
apitest ntdimysql.dll ntdimysql.conf rwpage /site/store/products/aq101.html
Parameter lookup
Testing a parameter lookup for a parameter named "product" passing the value 123:
apitest ntdimysql.dll ntdimysql.conf lookupparam product 123
Parameter rewrite
Testing a parameter rewrite a parameter named "product" passing the value 123:
apitest ntdimysql.dll ntdimysql.conf rwparam product 123
User lookup
Testing a user lookup for a user named "jane":
apitest ntdimysql.dll ntdimysql.conf user jane
User authentication
Testing authentication for a user named "janedoe" whose password is "a0s9d8":
apitest ntdimysql.dll ntdimysql.conf auth janedoe a0s9d8
N1BF0001
To configure NetInsight to use a data conduit for rewrites and lookups To configure Unica NetInsight to use a data conduit for user authentication
Unica NetInsight - Administrator's Guide
N1BF000A
To configure NetInsight to use a data conduit for user information Example: How to configure a parameter lookup To regenerate summaries for a profile Example: How to configure a cookie lookup
5. Enter the full path (including the filename) to the data conduit program file. Do not place paths that include spaces in parentheses. 6. Enter the full path (including the filename) to the data conduit configuration file. 7. Click Save Options Options.
N1C30001
334
The following figure shows how a portion of the data would appear on the summary after the data conduit is configured. Note that the parameter values in the first column have been replaced with the content type name, class, and format pulled from an external database.
1. Create a database that contains the content type name, class, and format items entered into a lookup table. The table must contain a key column with the same ContentTyp IDs that occur in the URLs of the Web site. For help with creating a database, contact your database administrator. 2. Install the data conduit appropriate for your external database. 3. In NetInsight, view the profile in which you want to look up the product name for the ProductID parameter value. 4. Click the Options tab. 5. In the left panel select Dynamic Content > Parameters Parameters. 6. Click Add Add. 7. Configure the parameter as follows: For the parameter name, enter the parameter name (case-sensitive) exactly as you will later specify it in the data conduit configuration file. The data conduit name does not need to match the parameter name as it appears in your web site URLs. For the parameter value, enter a regular expression that will match the parameter name you entered in the previous step. This field forces your entry to lower case. A case-sensitivity match with the parameter name is not required, but it must match otherwise.
Version 8.2.1
335
8. Click Save Options Options. 9. In the Parameters to be analyzed list, select ContentTyp and then click Requests Requests. 10. Click Add Add. 11. Enter a filter that describes the page(s) whose query strings you want NetInsight to check for this parameter. In this example, you could enter the filter as shown:
12. Click Add Add. 13. Indicate whether you want the query strings that are passed to this page to be searched for the contenttypeid parameter in all new data you import from now on.
336 Unica NetInsight - Administrator's Guide
If this is what you want, or if you have other pages to enter at this time, click Continue Continue. If you want to search the query strings in this page for the ContentTyp parameter in data you have already imported, you must delete all the data in your profile and re-import your log files. Note If you do not still have all the log files you Note: have imported into this profile, you will lose data permanently by choosing this option.
14. In the Options panel, under Dynamic Content click Data Conduits Content, Conduits. 15. Click Add Add. 16. Configure the data conduit options as shown:
17. Click Save Options then click Continue Options, Continue. 18. Click Update (the left-most icon in the group). 19. If necessary, set environment variables in Unica NetInsight. For example:
20. In a text editor, open ntdi>db_type<.conf. 21. Configure the ConnectString connection directive the data conduit needs to connect to the database. For example:
DBUsername jane DBPassword a0s9d8 DBServiceName testdb1
The example below is wrapped for readability; each directive should appear in the data conduits configuration file on a single line.
ParamDataSource_ContentTyp ContentType, ContentClass, reports_ContentTypeID WHERE ParamDataFormatHTML_ContentTyp %FIELD2%<br>Content class: %FIELD4% ParamDataFormatRTF_ContentTypContent type: class: %FIELD4% ParamDataFormatCSV_ContentTypContent type: ContentTypeID = '%VALUE%' Content type: %FIELD1%, %FIELD3% <br>Content format: %FIELD1%, %FIELD2%\line Content %FIELD3% \line Content format: %FIELD1%, %FIELD2% SELECT ContentTypeID, ContentFormat FROM
ContentTyp the parameter name for the ParamDataSource_paramname directive exactly matches the entry in the Name text box in the profile options for the parameter in Unica NetInsight, including the case. 23. Save your changes to the file. 24. Test the data conduit's configuration. To test the configuration, open a command-line prompt and enter the correct usage. For example, on a Windows system where the data conduit and its configuration file are both in the current directory and you are connecting to an Oracle database enter:
apitest.exe .\ntdiorcl.conf lookupparam ContentTyp 103
If the parameter lookup is successful, the content type name, class, and format will appear. (If the parameter lookup is unsuccessful, an error message will appear. To resolve the error, check your settings for the connection directive and parameter lookup directives in ntdi>db_type<.conf.) 25. For the data from the data conduit to appear on the Parameter Summary you must Summary, regenerate the profile. 26. Do one of the following:
N1C50001
Click the Custom tab and then select the Parameter Summary for ContentTyp report in the list of available reports. To display the summary, click Run Report Report. Click the Reports tab, click Custom Analysis and then select the Parameter Analysis, Summary for ContentTyp report.
2. Change directories to the NetInsight program directory. 3. To regenerate the summaries for a specific profile, execute nettracker short_profile_name -regen The term short_profile_name refers to the profile name that appears in parentheses in the Available profiles list in the Profile Manager. You can also display a list of the short profile names by executing:
N1C60001
1. Install the data conduit appropriate for your external database. 2. In Unica NetInsight, view the profile in which you want to look up cookie data.
Version 8.2.1 339
3. Enable cookies as a reportable dimension as follows: a. Click the Options tab. b. In the left panel select Reporting > Reportable Dimensions Dimensions. c. Add Cookie to the list of reportable dimensions. d. Click Save Options Options. e. On the toolbar, click Update Update. 4. Configure Unica NetInsight to use the data conduit for Cookie Lookup. 5. On the toolbar, click Update Update. 6. If you are using the data conduit for DB2, ODBC, or Oracle, ensure that any required environment variables have been set. See the Unica NetInsight Installation Guide for more information. 7. Open the data conduit configuration file in the text editor. If the database connection information has not previously been entered, uncomment those rows and enter the connection information now. 8. Configure the cookie lookup directives. An example is shown below. This example includes lines wrapped for readability. In the actual configuration file each directive must be written as a single line.
#Cookie Lookups: CookieDataSource Customers WHERE CookieDataFormatHTML SELECT FirstName, LastName, Email, CustomerID FROM Cookie = '%VALUE%'
%FIELD2%, %FIELD2%<br /> <a class="dataTableRows" href="mailto:%FIELD3%">%FIELD3%</a><br /> ID: %FIELD4% CookieDataFormatRTF CookieDataFormatCSV \sa0\sb120{%FIELD1%\par}\sa0\sb0{%FIELD2%\par} \sa0\sb0{%FIELD3%\par}\sa0\sb0{%FIELD4%\par} %FIELD1% %FIELD2% %FIELD3% %FIELD4%
9. Save the configuration file. 10. Use the APITest utility to test the data conduit configuration. 11. Regenerate the profile to bring the data from the data conduit into the Cookie Summary report. 12. To view the Cookie Summary report in Unica NetInsight, on the Reports tab, select Visitor Analysis > Cookie Summary Summary.
N1C00001
340
About data conduit directives Database and directory server connection string directives About the clip, cookie, host, user, and visitor lookup directives About parameter lookup directives About department lookup directives About page title lookup directives About product directives About rewrite directives User information directive User authentication directives Debug directive Unloadme directive
DB2
ConnectString The connect string necessary to connect to the DB2 database. For example: DRIVER={IBM DB2 ODBC DRIVER}; UID=username;PWD=password;MODE=SHARE; DBALIAS=dbalias;
LDAP
BindDN The Distinguished Name necessary to authenticate with the directory server from which the user desires to retrieve data.
Version 8.2.1
341
BindPassword
The Password necessary to authenticate with the directory server from which the user desires to retrieve data.
Example
BindDN CN=username,OU=people,DC=example,DC=com
To bind anonymously, ensure that the directory server connection directives are commented out.
MySQL
DBUsername The user name to use when connecting to the database. The password for DBUsername. The hostname of the server on which the database resides. The name of the database to which the data conduit should connect. The port on the server through which the database connection should be established.
Password DBHost
DBDatabase
DBPort
ODBC
To connect to a data source using a previously defined Data Source Name:
ConnectString DSN=DSNName;
Example: Windows To connect to a SQL Server database without using a previously defined DSN:
ConnectString DRIVER={SQL Server};UID=db_user;PWD=password;SERVER=server_name;DATABASE=db_name;
DriverPrompt (for ODBC on Windows only) Use the DriverPrompt directive to specify how you would like to be prompted for database connection information. Valid values are: 1 Prompt for database connection information if no DSN or DRIVER keyword is found in the ConnectString directive. 2 or 3 Prompt for database connection information, using the value of the ConnectString directive for default values. Any other value No prompt, even if the connection fails (default).
Enabling the Debug directive provides a simple way to connect to a database and retrieve the resulting connect string. DriverPrompt. When Debug enabled the data conduit prints the connection string to the console before and after it attempts to connect to the database, thus supplying a value for DriverPrompt. The connect string can in turn be used as the value for the ConnectString directive.
Oracle
DBUsername The user name to use when connecting to the database. The password for DBUsername. The service name to which the data conduit should connect. The service name must have been previously defined using the Oracle client configuration tools.
Password DBServiceNameHost
PostgreSQL
DBUsername The user name to use when connecting to the database. The password for DBUsername.
Password
Version 8.2.1
343
DBHost
The hostname of the server on which the database resides. The name of the database to which the data conduit should connect. The port on the server through which the database connection should be established.
DBDatabase
DBPort
N1C80001
About the clip, cookie, host, user, and visitor lookup directives
In the names of the lookup directives described below, replace {Type} with the lookup type. The possible values for {Type} are: Clip Cookie Host User Visitor Lookup types are case sensitive.
HostDataSource SELECT Contact, Name, Phone, EMail FROM HostLookup WHERE Host = '%VALUE%'
In this example, %VALUE% will be replaced with the host name or IP address from the log files.
ldap[s]://hostname:port?base_dn?attributes?scope?filter
344
For details about LDAP URLs, refer to your LDAP server documentation. The filter should contain the token %VALUE%, which will be replaced by the data conduit during each lookup with the value to be replaced. For example:
This example will search for a user with the user ID passed from NetInsight and return the corresponding name, title, telephone number, and address. If an object has two values for an attribute, NetInsight uses the first value. If two objects have the same value for an attribute, NetInsight uses the first object.
{Type}DataFormatHTML
The string to be used to format the values retrieved from the database or LDAP directory when generating reports in HTML. The supplied value should contain the following: Any necessary HTML format strings. The tokens %FIELD1%, %FIELD2%, ..., %FIELDn%, which will be replaced by the data conduit during each lookup with the value of column N contained in the result set retrieved from the database or directory. %FIELDn% tokens may appear in any order, and multiple tokens for a single field may be used multiple times within the same format string. Any links should use the CSS class dataTableRows (see the example below). Otherwise, the links will not be visible in the reports.
Example result:
J. Doe from doe.com<br> <a class="dataTableRows" href "mailto:jane@doe.com">jane@doe.com</a> or 1(800)123-4567
{Type}DataFormatRTF
The string to be used to format the values retrieved from the database or LDAP directory when generating reports in RTF. The supplied value should contain the following: Any necessary RTF format strings.
345
Version 8.2.1
The tokens %FIELD1%, %FIELD2%, ..., %FIELDn%, which will be replaced by the data conduit during each lookup with the value of column N contained in the result set retrieved from the database or directory. %FIELDn% tokens may appear in any order, and multiple tokens for a single field may be used multiple times within the same format string.
Example result:
\ sa0\sb120{J. Doe\par}\sa0\sb0{doe.com\par} \sa0\sb0{jane@doe.com\par}\sa120\sb0{1(800)123-4567}7
{Type}DataFormatCSV
The string to be used to format the values retrieved from the database or LDAP directory when generating reports requiring plain text this includes not only reports exported in CSV format, but also graph labels within NetInsight reports. The supplied value should contain the tokens %FIELD1%, %FIELD2%, ..., %FIELDn%, which will be replaced by the data conduit during each lookup with the value of column N contained in the result set retrieved from the database or directory. You do not need to supply enclosing quotes in the CSV format; NetInsight will supply these when the CSV data file is created. %FIELDn% tokens may appear in any order, and multiple tokens for a single field may be used multiple times within the same format string. Example value value:
HostDataFormatCSV %FIELD1% from %FIELD2%
Example result:
J. Doe from doe.com
N1C90001
346
To differentiate between directives for different parameters, the identifiers for parameter lookups should end with an underscore, followed by the name of the parameter exactly as it has been entered in the Name text box on the Parameters page in the NetInsight profile options, including the case. (Do not use the entry in the Parameter text box on the Parameters page.) For example, to configure lookups for the parameter product you would configure the product, following directives: ParamDataSource_product ParamDataFormatHTML_product ParamDataFormatRTF_product ParamDataFormatCSV_product
For example, to configure lookups for the parameter category you would configure the category, following directives: ParamDataSource_category ParamDataFormatHTML_category ParamDataFormatRTF_category ParamDataFormatCSV_category
The directives for looking up data for parameters function the same as the directives for looking up clips, cookies, hosts, users, and visitors.
N1CA0001
DepartmentDataSource
The SQL query or LDAP URL to be executed to determine the department grouping to which a user or host belongs. The supplied value should contain the token %VALUE%, which will be replaced by the data conduit during each lookup with the user name or host name from the log files. If the Departments defined primarily by option in the Departments profile options is set to Hosts NetInsight provides the host name to the data conduit. If the option is Hosts, set to Users NetInsight provides the user name to the data conduit. Users, Examples (DB2, MySQL, ODBC, Oracle, and PostgreSQL) PostgreSQL):
DepartmentDataSource SELECT Department FROM DepartmentLookup WHERE UserName = %VALUE%
Version 8.2.1
347
DepartmentFallBack
When the DepartmentFallBack directive is set to 1 (the default), NetInsight falls back to the list of departments specified for the Departments profile option to determine a department if the query or URL specified by DepartmentDataSource does not return data. Set DepartmentFallBack to 0 to prevent NetInsight from using the internal list if the query URL or LDAP URL does not return data.
N1CB0001
PageTitleDataSource
The SQL query LDAP URL to be executed to retrieve the desired page title. The supplied value should contain the token %VALUE%, which will be replaced by the data conduit during each lookup with the page for which a title is needed. NetInsight will replace %VALUE% with the page that it reads from the log files. Examples Examples:
PageTitleDataSource SELECT PageTitle FROM TitleLookup WHERE PageLocation = %VALUE%okup WHERE UserName = %VALUE%
348
PageTitleFallBack
When the PageTitleFallBack directive is set to 1 (the default), NetInsight falls back to HTTP to resolve page titles if the query URL specified by PageTitleDataSource does not return data. If NetInsight cannot resolve a page title through the data conduit, it will attempt to retrieve the page title from the actual page. Set PageTitleFallBack to 0 to prevent page title resolution via HTTP if the query LDAP URL does not return data.
N1CC0001
ProductLookup
The SQL query or LDAP URL to be executed to lookup an SKU and display information in reports. Example (DB2, MySQL, ODBC, Oracle, and PostgreSQL) PostgreSQL):
ProductLookup SELECT ProductName FROM Products WHERE SKU = %VALUE%
ProductRewrite
The SQL query or LDAP URL to be executed to lookup a SKU and store information in the database. Example (DB2, MySQL, ODBC, Oracle, and PostgreSQL) PostgreSQL):
ProductLookup SELECT ProductName FROM Products WHERE SKU = %VALUE%
N1CD0001
Version 8.2.1
349
RewritePageDataSource
The SQL query or LDAP URL to be executed to retrieve the desired page, file, or clip value. The supplied value should contain the token %VALUE%, which will be replaced by the data conduit during each lookup with the page, file, or clip value to be replaced. NetInsight will replace %VALUE% with the page, file, or clip that it reads from the log files. Example (DB2, MySQL, ODBC, Oracle, and PostgreSQL) PostgreSQL):
RewritePageDataSource SELECT NewPageLocation FROM PageRewrite WHERE PageLocation = '%VALUE%'
If the %VALUE2% token is present, it will be replaced with the query string associated with the request (if one exists). Example Example:
RewritePageDataSource SELECT NewPageLocation FROM PageRewrite WHERE PageLocation = %VALUE% AND PageQueryString = %VALUE2%
RewriteParamDataSource_paramname
The SQL query or LDAP URL to be executed to rewrite the desired parameter value. To facilitate directives for multiple parameters, parameter rewrite directives are defined on a parameter-by-parameter basis. Rewrite directives for parameters begin with the keyword RewriteParam. To differentiate between directives for different parameters, the identifiers for parameter rewrites should end with an underscore, followed by the name of the parameter exactly as it has been entered in the Name text box on the Parameters page in the NetInsight profile options, including the case. (Do not use the td in the Parameter text box on the Parameters page.) For example, to configure rewrites for two parameters named product and category you category, would configure the following directives: For the product parameter, RewriteParamDataSource_product For the category parameter, RewriteParamDataSource_category
350
The supplied value should contain the token %VALUE%, which will be replaced by the data conduit during each rewrite with the value to be replaced. Example (DB2, MySQL, ODBC, Oracle, and PostgreSQL) PostgreSQL):
RewriteParamDataSource_paramname SELECT NewParamValue FROM ParamLookup WHERE ParamValue = %VALUE%
EmailDataSource
The SQL query or LDAP URL to be executed to retrieve a user's full name and email address. The supplied value should contain the token %VALUE%, which is replaced by the data conduit during each lookup with the user's user name. To look up email addresses in Microsoft Active Directory Server, you should use a filter similar to "userPrincipalName=%VALUE%@example.com" # instead of "uid=%VALUE%".
Version 8.2.1
351
Example (LDAP)
EmailDataSource ldap://ldapserver.example.com/ CN=Users,DC=example,DC=com?mail,displayName?one?uid=%VALUE%
N1CF0001
You can also authenticate against a Microsoft Active Directory server. Example Example:
AuthenticateUserSource ldap://<domainserver address>/
352
where <domain server address> is the URL or IP of your domain controller (such as, domaincontroller.unica.com).
where <domain name> is the name of your domain (such as, unica.com). For this directive, the CN and DC fields are not necessary to authenticate against a Microsoft Active Directory.
N1D00001
Debug directive
When the Debug directive is set to 1, the data conduit outputs debugging information. Note that this may be problematic when NetInsight is run through a Web browser. Therefore, this option should be turned on only when you are performing tests through the command-line interface. The Debug directive may be commented out in the data conduit's configuration file. If you want to change the directive's default setting and the directive is commented out, remove the pound sign (#) from the line and change the value if necessary.
N1D10001
Unloadme directive
When the UnloadMe directive is set to 1, NetInsight attempts to unload the data conduit when it is no longer needed. Unloading a dynamically loaded library may cause problems on some systems. If this is the case, set this directive to 0 to instruct NetInsight not to unload the data conduit, leaving it to be unloaded by the system when the process exits. The UnloadMe directive may be commented out in the data conduit's configuration file. If you want to change the directive's default setting and the directive is commented out, remove the pound sign (#) from the line and change the value if necessary.
Version 8.2.1
353
N10B55
About user-defined processes How Unica NetInsight runs user-defined processes To configure Unica NetInsight to run a user-defined process About the <userdefinedprocesses> and <process> elements Creating generic processes for multiple profiles User-defined process examples User-defined processes and database permissions
354
2. Save the file to a location Unica NetInsight can access, such as the Unica NetInsight program directory. 3. For each profile against which you want the process to run, open its configuration file and use the <userdefinedprocesses> and <process> elements to specify when userdefinedprocesses> process> the process should run and the path to its text file. For example:
<userdefinedprocesses> <process phase="postimport" type="sql">postimport.sql</process> <process phase="postupdate" type="sql">postupdate.sql</process> </userdefinedprocesses>
For the value for <process>, specify the path and name of the process's text file. If process> the file is located in the Unica NetInsight program directory you do not need to specify the path.
N1D50002
When to execute this process postaggregate: After aggregate reports are generated. postimport: After an -import command runs or Update is run from the NetInsight interface. postsamplinglevel: After the import phase of sampling completes but while NetInsight is still in sampling mode. postupdate: After an -update command runs or Update is run from the NetInsight interface.
type
N1D60001
Type of process
sql
356
With SQL Server To use this user-defined process with SQL Server, you first need to create the ProfileUpdates table using the following specifications:
CREATE TABLE ProfileUpdates ( DateOfUpdate DATETIME NOT NULL, ProfileRoot VARCHAR(255) NOT NULL, VisitorID BIGINT NOT NULL, VisitID BIGINT NOT NULL, ViewID BIGINT NOT NULL, EventID BIGINT NOT NULL );
Next, create a file named UDP_SQL_Server.txt in the Unica NetInsight directory. Place the following text in this file:
BEGIN TRANSACTION; INSERT INTO ProfileUpdates( DateOfUpdate, ProfileRoot, VisitorID, VisitID, ViewID, EventID) SELECT GETDATE(), '%PROFILE_ROOT%', (SELECT ISNULL(MAX(VisitorID), 0) FROM %PROFILE_ROOT%_VisitorID), (SELECT ISNULL(MAX(VisitID), 0) FROM %PROFILE_ROOT%_Visits), (SELECT ISNULL(MAX(ViewID), 0) FROM %PROFILE_ROOT%_Views), (SELECT ISNULL(MAX(EventID), 0) FROM %PROFILE_ROOT%_Events);
Version 8.2.1
357
Now, add the UDP_SQL_Server.txt file to the profile's configuration file, and Unica NetInsight will start logging information about each update.
With Oracle
To use this user-defined process with Oracle, you first need to create the ProfileUpdates table under the Unica NetInsight user's schema using the following specifications:
CREATE TABLE ProfileUpdates ( DateOfUpdate DATE NOT NULL, ProfileRoot VARCHAR(255) NOT NULL, VisitorID NUMBER NOT NULL, VisitID NUMBER NOT NULL, ViewID NUMBER NOT NULL, EventID NUMBER NOT NULL );
Next, create the following stored procedure under the Unica NetInsight user's schema:
CREATE OR REPLACE PROCEDURE Log_Profile_Update (Profile VARCHAR) IS BEGIN COMMIT; SET TRANSACTION NAME 'ProfileUpdate'; INSERT INTO ProfileUpdates SELECT CURRENT_DATE, 'unica', (SELECT NVL(MAX(VisitorID), 0) FROM unica_VisitorID), (SELECT NVL(MAX(VisitID), 0) FROM unica_Visits), (SELECT NVL(MAX(ViewID), 0) FROM unica_Views), (SELECT NVL(MAX(EventID), 0) FROM unica_Events) FROM DUAL; COMMIT; END;
Finally, create a file named UDP_Oracle.txt in the Unica NetInsight directory. Place the following text in this file:
BEGIN Log_Profile_Update( '%PROFILE_ROOT%' );END;;
Now, add the UDP_Oracle.txt file to the profile's configuration file, and Unica NetInsight will start logging information about each update.
358
Version 8.2.1
359
N10B7A
About regular expressions Basics of regular expressions Metacharacters Metacharacter examples Special characters Special character examples Combining metacharacters Using regular expressions
360
Metacharacters
The real power of regular expressions is in the use of metacharacters. Metacharacters allow you to construct expressions that match specific text patterns in an extremely flexible way. The following table lists and describes the metacharacters.
Metacharacter . (period) ? Meaning Matches any one character no matter what the character is Matches the character immediately before it either zero times or one time Matches the character immediately before it any number of times including zero (the character may not be in the string at all) Matches the character immediately before it one or more times (the character must be in the string at least once) Indicates that the characters which follow are at the start of the string only Indicates that the characters which precede it are at the end of the string Matches any single decimal digit (0-9)
\d
Version 8.2.1
361
18 - Using Regular Expressions with NetInsight Metacharacter \D \s \S \w \W Meaning Matches any character that is not a decimal digit Matches a tab or space character Matches any character that is not a tab or a space Matches any letter, any digit, or the underscore character Matches any character which is not a letter, a digit, or the underscore Escape character allowing the use of any of the metacharacters with their regular keyboard meaning. For example, \. matches a period (.) in a regular expression. (A period (.) without a preceding escape character matches any one character no matter what the character is.)
N1DC0002
Metacharacter examples
The following table shows examples that illustrate the use of metacharacters.
Regular Expression up.own Matches uptown updown up own .exe aexe 123exe 1exejfg \.exe .exe prog.exe Backslash (\) tells the rules matching engine you are looking for a period, not using the period as a metacharacter. Question mark (?) matches both zero instances of b and one instance of b. Period (.) matches any character, even a space. Reason Period (.) matches any character, even a space.
ab?cdef
362
Special characters Regular Expression ntcgi\?johnswift Matches ntcgi?johnswift Reason Backslash (\) tells the rules matching engine you are looking for a question mark, not using the question mark as a metacharacter. Asterisk (*) matches the c zero or more times.
abc*defg
abc+defg
free
^free
free freedom
Caret (^) only matches the beginning of the text string. Dollar sign ($) only matches at the end of the text string.
free$
free innisfree
N1DD0002
Special characters
In addition to metacharacters, you can use four other characters to indicate the relationships between various parts of the regular expression.
Character | Meaning Tells the rules matching engine to match the text to the left of the pipe or the text to the right of the pipe Contains a set of characters and tells the rules matching engine to match any character within that set Indicates that the part of the expression that is within the parentheses is to be considered as one unit
[]
()
Version 8.2.1
363
18 - Using Regular Expressions with NetInsight Character ^ [abc] Meaning Negates the set of characters in brackets so that text must contain a character at that point in the expression but it cannot be any of the characters inside the brackets
N1DE0002
they would they should they should have they would have
Parentheses and pipe indicate text must contain at least one instance of either would or should
[cz]one
cone zone
one
Brackets indicate either a c or a z must be present for a match Brackets indicate there must be a character at that point in the expression, but the caret indicates that character cannot be a, b, or c
[^abc]xyz
dxyz mxyz
N1DF0002
Combining metacharacters
You can combine several metacharacters in one regular expression. One of the most common combinations is the period and asterisk (.*) which matches a string of any length including the null string.
Regular Expression .*\.cgi$ Matches any string ending in .cgi Reason The period and asterisk (.*) combination matches any string. The backslash (\) tells the matching rules engine to look for a period, not use the period as a metacharacter.
364
Using regular expressions Regular Expression .*.cgi$ Matches acgi thomcgi file.cgi Reason The second period is not preceded by a backslash (\), so it is being used as a metacharacter to match any one character no matter what the character is. A more compact form of writing the same pattern would be .+cgi.
N1E00002
To see this regular expression: 1) display a profile; 2) click the Options tab; 3) in the Options panel, select Visitors or Users > Browsers > Microsoft Internet Explorer > User Agents Agents. If a user agent in your log file matches the regular expression above, then the browser used by that user will be listed as Microsoft Internet Explorer in your Browser Summary. By breaking down the regular expression, you can see exactly what it is looking for.
Expression ^ Mozilla/ .* MSIE Meaning The string must start with the characters that follow (Mozilla/) The characters that must be at the beginning of the string The string must start with the characters that follow (Mozilla/) The next string of characters that must be present (including a space after the E) The contents of the parentheses are considered a single unit Matches any decimal digit
() \d
Version 8.2.1
365
18 - Using Regular Expressions with NetInsight Expression \. Meaning Modifies the \d so the rules matching engine looks for one or more digits
Because the regular expression includes information about the browser version (\d+\.), if you have selected the Append the version number check box for the browser, the first two strings above appear as Microsoft Internet Explorer 4 and the last string will appear as Microsoft Internet Explorer 5. Depending on your database type you can also use the That match the regular expression filter with a regular expression when filtering a report. For example, you could use the Custom Report Wizard to create a custom Page Summary that only contains data for visitors who were using NetBSD, FreeBSD, or OpenBSD, but not BSDI. You would need to enter That match the regular expression .*BSD$ as the complete platform filter. The period and asterisk (.*) allows a match on any characters that precede BSD in the string, but because of the dollar sign ($), the string must end in BSD. If you are interested in examining your server's performance when it calls CGI programs, you can use the Custom Report Wizard to create a custom Server Performance Summary with the filter That match the regular expression.*\.cgi$ (provided your CGI programs end with that extension). When you run the report, you will see only statistics on how your server performs when a CGI program is called.
366
N10BAA
About command-line options About regular expressions with command-line options Profile command-line options Administrative command-line options
The all option performs the requested operation on all profiles. Otherwise, the operation is performed only on the specified profile. All parameters used with the command-line options are case-sensitive.
N1E20001
Version 8.2.1
367
or:
nettracker admin -list "%regex"
where regex is a regular expression that identifies the profiles you want. If the percent sign (%) is not included, regex is not treated as a regular expression. When you use a regular expression, the actions indicated by the command-line options are carried out on all profiles whose names match the regular expression. It is important to test a regular expression for accuracy before you use it in an operation that affects data. Using the command nettracker admin -list "%regex" is a good way to test the regular expression to ensure that it matches only those profiles you want it to match. For example, before executing the first command below, run the second command to verify that the profiles matching the regular expression are correct:
nettracker "%customer.*" -update
-abort -addreport filename [-title newtitle] [-rptlist listname] [-rptfolder foldername] -alert -alerttask alertname -archive YYYYMM -archive YYYYMM,YYYYMM -checkdb -clear -compactdb filename -email -emailtask taskname -expiretitles
Unica NetInsight - Administrator's Guide
N1E30007
-forget log_filename -import -module -quiet -reaggregate -reanalyze -recalc -recipients list -regen -reindex -reindex-missing -remove YYYYMM or YYYYMMDD -remove YYYYMM,YYYYMM -reports -reprofile -resample -reseed seed_number -resolvetitles -samplecalc entity number -update
-abort
Aborts the profile. This kills the associated Unica NetInsight process and resets the profile. For all operations other than abort, a profilename.lck file is created in the profile data directory (install_directory/data/profilename/) and the contents of that file are the PID of the current process. When abort is run on a certain profile, it opens the profilename.lck file, if it exists, and attempts to kill the process with the PID found in the lock file. Importing of data is rolled back to the last checkpoint. If there is no Unica NetInsight process associated with this profile (in other words, there is no short_profile_name.lck file), this option has no effect. Example:
nettracker short_profile_name -abort
N1E50001
Version 8.2.1
369
-alert
Instructs Unica NetInsight to execute all email alerts that have been configured in the options for the profile specified. The Email option in the administrative options, and the Email Tasks and Email Alerts options in the profile options, must be configured correctly for email alerts to successfully execute. You can combine this option with the -email, -recalc, -recipients, -regen, and -update options. Reports are emailed at the conclusion of the -recalc, regen, or -update, assuming that the email alert threshold is met. Example:
nettracker short_profile_name -alert -update
N1E70001
-alerttask alertname
Instructs Unica NetInsight to execute the specified email alert. The Email option in the administrative options, and the Email Tasks and Email Alerts options in the profile options, must be configured correctly for the email alert to successfully execute.
370
If the alert name contains spaces, you must put the alert name in quotation marks. Example:
nettracker short_profile_name -alerttask SomeEmailAlert
N1E80001
-archive YYYYMM
Removes the given month from the database and archives the reports for that month. You cannot drill into reports for archived months. Removing the last month from your profile is equivalent to clearing all data from the profile. This includes removing all information concerning unique visitors, which influences the identification of new and repeat visitors when importing new data. Example:
nettracker short_profile_name -archive 200901
N1E90001
-archive YYYYMM,YYYYMM
Removes multiple months from the Unica NetInsight database and archives the reports for each listed month. (There should be no space after the comma that separates the months.) You cannot drill into reports for archived months. Removing all months from your profile is equivalent to clearing all data from the profile. This includes removing all information concerning unique visitors, which will influence the identification of new and repeat visitors when importing new data. Example:
nettracker short_profile_name --archive 200901,200902
N1EA0001
-checkdb
Checks the Unica NetInsight database to ensure that all necessary tables and indices exist. This command also outputs the disk usage of each table and index. If an index is missing, you can run the command nettracker short_ profile_name -reindex -missing to rebuild it.
Version 8.2.1
371
For DB2, MySQL, and Oracle, this command also checks the last analysis date for the statistics on each table and index. If the statistics on these tables and indices are out of date, you can run the command nettracker short_ profile_name -reanalyze to update them. If the user running the -checkdb option has the Select Catalog role for the Oracle database, Unica NetInsight also examines the HASH_AREA_SIZE and SORT_AREA_SIZE parameters of your database to ensure they are set appropriately. For SQL Server, this command also outputs the collation name for the tempdb and the database. This information appears at the end of the output. For example:
Verifying important database settings Collation for ntdb: Latin1_General_BIN Collation for tempdb: SQL_Latin1_General_CP1_CI_AS
Note that the output of this command is designed to be interpreted by a trained database administrator. Before making any changes to your database configuration or running any of the commands mentioned above, you should consult with your database administrator or Unica technical support. Example:
nettracker short_ profile_name -checkdb
N1EB0001
-clear
Removes all data from the Unica NetInsight database tables for the profile. After using this command, you must update the profile before you can use it again. Example:
nettracker short_profile_name -clear
N1EC0001
-compactdb filename
In Unica NetInsight for SQLite, reclaims available space within the given database file, or within all of the profile's database files if no file is specified. For <file> you should file> enter the full path and file name of the database file. Example (Windows):
nettracker short_profile_name -compactdb "C:\Program Files\ Unica NetInsight\data\short_profile_name\ nettracker.dat"
372
Example (UNIX):
nettracker short_profile_name -compactdb /usr/local/ Unica NetInsight/data/short_profile_name/ nettracker.dat
N1ED0001
-email
Instructs Unica NetInsight to perform all email tasks that have been configured in the options for the profile specified. (Tasks that have the Exclude from batch execution check box selected are not executed.) You must configure correctly both the Email Tasks option in the profile options and the Email options in the administrative options for email tasks to be executed successfully. You can combine this option with the -recalc, -recipients, -regen, and update options. Reports are emailed at the conclusion of the -recalc, -regen, or -update, assuming that task completes successfully. Example:
nettracker short_profile_name -email
N1EE0001
-emailtask taskname
Instructs Unica NetInsight to perform the specified email task. You must configure correctly both the Email Tasks option in the profile options and the Email options in the administrative options for email tasks to be executed successfully. If the task name contains spaces, you must put the task name in quotation marks. You can use the -recipients option to specify a list of recipients to use instead of the recipients specified in the task. Example:
nettracker short_profile_name -emailtask SomeEmailTask
N1EF0001
-expiretitles
Instructs Unica NetInsight to mark all page titles as expired. Page titles for any pages processed during subsequent updates are resolved the next time requests for them are processed, as if they had expired normally. Example:
Version 8.2.1 373
-forget log_filename
Whenever Unica NetInsight processes a log file, it remembers that file by storing the first 900 bytes of the file, the file size, and the location that it left off in the file. As a result, if the file grows, Unica NetInsight processes only the new data. The -forget command tells Unica NetInsight to forget that it has already processed the log file. If you tell Unica NetInsight to forget a log file, it reprocesses the whole log file instead of picking up from where it left off. For <logfile> you should enter the full path and file name of the log file. Example (Windows):
nettracker short_profile_name -forget c:\logs\access.log
Example (UNIX):
nettracker short_profile_name -forget /logs/access.log
You can tell Unica NetInsight to forget multiple log files with a single command by using wildcards. The -forget option accepts a file specification, as long as it is a valid file specification according to the wildcard rules of the operating system on which Unica NetInsight is installed. Example (Windows):
nettracker short_profile_name -forget "c:\logs\ex0001*"
Example (UNIX):
nettracker short_profile_name -forget "/usr/local/apache/logs/access_log200001*"
N1F10001
-import
Imports new data for both Full and Sample modes without generating reports. You can use the sub-command-line option -nosample with -import. Example:
374
-nosample
Skips the sample phase of importing. The sample tables are not modified. Example:
nettracker short_profile_name -import -nosample
N1F20001
-module
Causes Unica NetInsight to forget or remove paid search integration module data for a profile. Use the module command with forget if you want to re-import previously imported paid search data (for example, if the data has changed subsequent to import). Data for the specified dates will not be removed from the Unica NetInsight database. It will be reimported at the next update. Use the module command with remove if you want to permanently remove paid search from the Unica NetInsight database (for example, to reduce the size of the database). The data will be removed and will not be re-imported during subsequent updates. You target data for the command by specifying a date or month. Multiple dates or months can be separated by commas. Do not use spaces between commas. You cannot target an entire year (other than by listing each of its months). You cannot target a date range (other than by listing each date in the range). Format for dates is YYYYMMDD. Format for months is YYYYMM. If you remove data that you later want to get back, use the module command with forget. Then run an update. Example: Forgetting data for specific dates This example will cause Unica NetInsight to forget paid search data for September 4, 5, and 6, 2009. Paid search data for these dates will be re-imported at the next update.
nettracker short_profile_name -module PSI -forget 20090904,20090905,20090906
Example: Forgetting data for specific months This example will cause Unica NetInsight to forget paid search data for September and October 2009. Paid search data for these months will be re-imported at the next update.
nettracker short_profile_name -module PSI -forget 200909,200910
Version 8.2.1
375
Example: Removing data for specific dates This example will remove paid search data from Unica NetInsight for September 4, 5, and 6, 2009. Paid search data for these dates will not be re-imported during subsequent updates.
nettracker short_profile_name -module PSI -remove 20090904,20090905,20090906
Example: Removing data for specific months This example will remove paid search data from Unica NetInsight for September and October. Paid search data for these dates will not be re-imported during subsequent updates.
nettracker short_profile_name -module PSI -remove 200909,200910
N1F30001
-quiet
Instructs Unica NetInsight not to print anything to standard output when performing command-line operations. Example:
nettracker short_profile_name -update -quiet
N1F40002
-reaggregate
Drops and recalculates the aggregate tables for both Full and Sample modes in the database. You can use the sub-command-line options -nosample, and -sampleonly. You can also specify an table name to target a specific aggregate table. This command does not re-import log files . Example:
nettracker short_ profile_name -reaggregate
-nosample
Skips the tables used for Sample mode. The sample tables are not modified. Example:
nettracker short_profile_name -reaggregate -nosample 376 Unica NetInsight - Administrator's Guide
-sampleonly
Drops and recalculates only those tables used for Sample mode. Non-sample tables are not modified. Example:
nettracker short_profile_name -reaggregate -sampleonly
You can verify aggregate table name values by examining your installation's webaggdef.xml file located at netinsight_root/data .
N1F50001
-reanalyze
Forces an update of the analysis statistics on the Unica NetInsight tables and indices in an Oracle, MySQL, or DB2 database. Unica NetInsight automatically updates these statistics every 15 updates. Running the -reanalyze command does not reset this counter. This command has no effect if you are running Unica NetInsight with Microsoft SQL Server. SQL Server automatically updates the statistics it keeps on tables and indices in a database. Example:
nettracker short_profile_name -reanalyze
N1F60001
-recalc
Drops and recalculates the aggregate tables, report tables, and results tables for both Full and Sample modes in the database and then regenerates the corresponding report files for the defined pregenerated report range. You can use the sub-command-line options -nosample, -sampleonly and reportkey. This command does not re-import log files. Example:
nettracker short_profile_name -recalc Version 8.2.1 377
-nosample
Skips the tables used for Sample mode. The sample tables are not modified. Example:
nettracker short_profile_name -recalc -nosample
-sampleonly
Drops and recalculates only those tables used for Sample mode. Non-sample tables are not modified. Example:
nettracker short_profile_name -recalc -sampleonly
reportkey
Drops and recalculates only those tables used for a specific report. Can be used in conjunction with the -nosample and -sampleonly parameters. Example:
nettracker short_profile_name -recalc reportkey -sampleonly
You can verify report key values by examining your profiles rpttimes.log.
N1F70001
-recipients list
Specifies the email addresses that should receive the reports in one or more email tasks. For list, you should enter a comma-delimited list of email addresses, enclosed in quotation marks. (Spaces before or after the commas are ignored.) This list of addresses is used instead of the recipients specified in the email tasks. This option makes it easier to test email tasks and to send reports to different people at different times. Example (-email):
nettracker short_profile_name -email -recipients "bob@ Unica.com, joe@ Unica.com"
Example (-emailtask):
nettracker short_profile_name -emailtask SomeEmailTask recipients "bob@unica.com, joe@ unica.com"
N1F80001
378
-regen
Regenerates the associated HTML files for the profile or the administrative HTML pages if used with the -admin option. You can use this command to re-create the contents of the HTML directory for a profile if they were accidentally deleted. You can use the subcommand-line option -nosample with -regen. With the -admin option, this command is the same as the administrative command -clear. Example (profile):
nettracker short_profile_name -regen
Example (administrative):
nettracker -admin -regen
-nosample
Skips the HTML files used for Sample mode reports. Only reports for Full reporting mode are generated. Example:
nettracker short_profile_name -regen -nosample
N1F90001
-reindex
Rebuilds the Unica NetInsight database indexes, including any that are missing. Example:
nettracker short_profile_name -reindex
N1FA0001
-reindex-missing
Rebuilds only the missing Unica NetInsight database indexes. Example:
nettracker short_profile_name -reindex-missing
N1FB0001
This option permanently deletes data from your database. If you think you might need the data again at some point in the future, you should ensure that you have copies of all of your log files before you remove the data. If your profile contains data for only one month, removing that month from your profile is equivalent to clearing all data from the profile. This includes removing all information concerning unique visitors, which will influence the identification of new and repeat visitors when importing new data. Examples:
nettracker short_profile_name -remove 20090625
-remove YYYYMM,YYYYMM
Removes multiple months from the database. (There should be no space after the comma that separates the months.) This option permanently deletes data from your database. If you think you might need the data again at some point in the future, you should ensure that you have copies of all of your log files before you remove the data. Removing all months from your profile is equivalent to clearing all data from the profile. This includes removing all information concerning unique visitors, which will influence the identification of new and repeat visitors when importing new data. Example:
nettracker short_profile_name -remove 200901,200902
N1FD0001
-reports
Selectively generates reports for which new data exists or whose content has changed since the last time report generation was run (for example, due to a change in the report's definition) . Both the query and HTML creation phases of report generation are run. You can use the -sampleonly or -nosample sub-command-line options to target only sampled or non-sampled reports. Based on your reporting needs, this can allow you to reduce the time spent on report generation. For example, if you import data every day but rely primarily on sampled reports throughout the week, you could generate sampled reports daily and non-sampled reports once a week. You can replace short_profile_name with all to update all the profiles.
380
Example:
nettracker short_profile_name -reports
-nosample
Sampled reports are not generated. Example:
nettracker short_profile_name -reports -nosample
-sampleonly
Non-sample reports are not generated. Example:
nettracker short_profile_name -reports -sampleonly
N1FE0001
-reprofile
Instructs Unica NetInsight to reapply the visitor profile definitions to the visitor data. The results of -reprofile do not appear on the reports until the profile is updated. Example:
nettracker short_profile_name -reprofile
N1FF0001
-resample
Clears the sample tables in the profile's database and repopulates the tables. Data in non-sample tables is not affected. After you run -resample, you should usually run the -recalc -sampleonly option to keep the sample reports in sync with the underlying sample data. Example:
nettracker short_profile_name -resample
N2000001
-reseed seed_number
Changes the sample seed value in the profile's configuration file. The seed value determines the random number generator algorithm that generates the data sample. The new seed value does not take affect until the profile is sampled.
Version 8.2.1 381
Example:
nettracker short_profile_name -reseed seed_number
N2010001
-resolvetitles
Instructs Unica NetInsight to immediately resolve page titles for all known pages. Example:
nettracker short_profile_name -resolvetitles
N2020001
-update
Updates the profile. This imports any new log file data, updates the sample tables, and then generates all aggregates, dimension levels and bins, metrics and reports associated with the profile for both Full and Sample modes. You can use the subcommand-line options -nosample and -sampleonly with -update. You can replace short_profile_name with all to update all the profiles. Example:
nettracker short_profile_name -update
-nosample
Skips the sample phases of the update. Sample tables are not modified and the sample reports are not generated. Example:
382 Unica NetInsight - Administrator's Guide
-sampleonly
Processes only the sample phase of the report generation during the update. Nonsample reports are not generated. Example:
nettracker short_profile_name -update -sampleonly
N1E40001
-add -addlang pathname_for_language_pack -adduser user_name [-email emailaddress] [-fullname fullname] [-password password] [-role role] [-reportingmode reportingmode] -assignuser user_name short_profile_name {[-role role_name] | [-view view_name]} -changeuser user_name [-email emailaddress] [-fullname fullname] [password password] [-role role] [-reportingmode reportingmode] -clear -dbpasswd -delete short_profile_name -deleteuser user_name -dir dir -list or -list %regex -listroles -listusers short_profile_name [-explicit] -quiet -roleinfo role_name -userinfo user_name [-explicit]
-add
Adds a new profile. This command is similar in functionality to clicking Create Profile at the Profile Manager. You can use sub-command-line options with the -add option, but they are not required. Only the short profile name is required. Example: nettracker admin -add short_profile_name [sub-command-line options]
Version 8.2.1
383
-include<includepath> -include<includepath>
Includes only pages that start with <includepath>. This command-line option corresponds to the Included Pages option in the profile options. When you use this command-line option, you can only filter for pages that start with with.
-logpath<logpath> -logpath<logpath>
Specifies the full path to the log file and the file name or wildcard.
-logtype<logtype> -logtype<logtype>
Specifies the type of log file. 0=Auto detect (default) 1=Netscape Flexible 2=NCSA Common/Combined 3=W3C Extended 4=IIS Standard/Extended 5=Microsoft Proxy 6=WebSite 7=Gauntlet 8=IBM Firewall 9=Raptor Eagle 10=Open Market Extended 11=wu-ftpd 12=NcFTPd 13=CERFNet 14=Squid 15=Sidewinder 16=WatchGuard 17=RealSystem Server, Helix Universal Server 18=Cisco PIX
-name<name> -name<name>
Specifies the name of the profile. This is the same as the Profile title option that can be specified in General Options Options.
384
-password<password> -password<password>
This option will set the password, but does not enable password protection for any of the profile options. You can use the default template to enable password protection.
-template<template> -template<template>
Specifies the full path to the template file. If you do not specify the -template option, the default template file is used. The default location for the template file on UNIX is /usr/local/ Unica NetInsight/data/admin. The default location on Windows is C:\Program Files\ Unica NetInsight\data\admin. You can edit the default template file in the Profile Manager.
Example (Windows):
NetTracker.exe admin -add test1 -dir "c:\Program Files\ Unica NetInsight" -logpath c:\WinNT\System32\logfiles\W3CSV1\ex020531.log -logtype 1 -template "C:\Program Files\Unica NetInsight\templates\template1.cfg"
N2040001
-addlang pathname_for_language_pack
Adds the specified Unica NetInsight language pack, to support display of the user interface in multiple languages; each profile can be displayed in a different language if desired.
Version 8.2.1 385
Example:
nettracker admin -addlang c:\n73_fr.gz
N2050001
-adduser user_name [-email emailaddress] [-fullname fullname] [-password password] [-role role] [reportingmode reportingmode]
Adds the user with the specified name. This command is identical in functionality to creating a user in the administrative options. You can use one or more sub-commandline options, listed below, with the -adduser option, but they are not required. Only the user name is required. Example:
nettracker admin -adduser "Bob Smith"
-password password
Adds the user with the specified password (the default password is blank). If a password is specified and Unica NetInsight is configured to authenticate users using an external database or the Web server, a warning message appears when you run the command. (A password is applicable for internal database authentication only.) Example:
nettracker admin -adduser "Bob Smith" -password a0s9d8
386
-reportingmode reportingmode
Specifies the default reporting mode for the user. The two possible values are full and sample. Example:
nettracker admin -adduser "Bob Smith" -reportingmode sample
-role role_name
Specifies the default role for the user. Example:
nettracker admin -adduser "Bob Smith" -role _pwruser
For this option, use the name of the role (for example, nettracker admin adduser "Bob Smith" -role _pwruser) and not the title of the role (for example, do not use nettracker admin -adduser "Bob Smith" -role Power User). You can display a list of role names by using the command nettracker admin -listroles.
N2060001
-role role_name
Assigns the role to the specified user in the specified profile. Example:
nettracker admin -assignuser "Bob Smith" short_profile_name -role pwruser
For this option, use the name of the role (for example, nettracker admin assignuser "Bob Smith" short_profile_name -role _pwruser) and not the title of the role (for example, do not use nettracker admin -assignuser "Bob Smith" short_profile_name -role Power User). You can display a list of role names by using the command nettracker admin -listroles.
Version 8.2.1
387
-view view_name
Assigns the view to the specified user in the specified profile.
N2070001
-changeuser user_name [-email emailaddress] [fullname fullname] [-password password] [-role role] [reportingmode reportingmode]
Changes the specified user's password, default role, or default reporting mode (or any combination of these). This command is identical in functionality to changing a user's password, default role, or default reporting mode in the administrative options. If a password is specified and Unica NetInsight is configured to authenticate users using an external database or the Web server, a warning message appears when you run the command. (A password is applicable for internal database authentication only.) You must use at least one sub-command-line option with the -changeuser option. Example:
nettracker admin -changeuser "Bob Smith"
-password password
Changes the specified user's password. Example:
nettracker admin -changeuser "Bob Smith" -password a0s9d8
388
-reportingmode reportingmode
Changes the specified user's default reporting mode. The two possible values are full and sample. Example:
nettracker admin -changeuser "Bob Smith" -reportingmode sample
-role role_name
Changes the specified user's default role. Example:
nettracker admin -changeuser "Bob Smith" -role _pwruser
For this option, use the name of the role (for example, nettracker admin changeuser "Bob Smith" -role _pwruser) and not the title of the role (for example, do not use nettracker admin -changeuser "Bob Smith" -role Power User). You can display a list of role names by using the command nettracker admin -listroles.
N2080001
-clear
Regenerates the top frame of the Profile Manager and the Unica NetInsight Homepage. This command is the same as the -admin -regen command Example:
nettracker admin -clear
N2090001
-dbpasswd
Changes the password used to connect to the Oracle, SQL Server, MySQL, or DB2 database. This command does not change the password on the database. It only changes the password that Unica NetInsight uses to connect to the database. When running this command you are prompted first to enter your old password and then to enter your new password. Example:
nettracker admin -dbpasswd Unica Unica NetInsight 8.0 - Copyright(c) 2009 Unica Corporation Changing the password for the database connection. Version 8.2.1 389
19 - NetInsight Command-Line Options Enter old password: old_password Enter new password: new_password Database password successfully changed.
N20A0001
-deleteuser user_name
Deletes the specified user. Example:
nettracker admin -deleteuser "Bob Smith"
N20C0001
-dir dir
Specifies the Unica NetInsight program directory. The -dir option must be specified when executing Unica NetInsight from the command line outside of the Unica NetInsight program directory. The default program directory on UNIX is /usr/local/Unica NetInsight. The default program directory on Windows is C:\Program Files\ Unica NetInsight. If there are spaces in the program directory path, you must enclose the directory parameter in quotation marks. Example (Windows):
C:\Program Files\ Unica NetInsight\nettracker.exe all -update -dir "C:\Program Files\ Unica NetInsight"
Example (UNIX):
/usr/local/ Unica NetInsight/nettracker.exe all -update -dir usr/local/
390
-listroles
Lists the title and name of each role. This command is similar in functionality to viewing the title and name of a role in the administrative options. The role title can consist of one or more words. It appears in the list of roles in the administrative options and can be edited after it has been saved. The role name is one word and cannot be edited after it has been saved. Example:
nettracker admin -listroles
N20F0001
-explicit
Includes only users with a role or default view explicitly assigned for the specified profile name. Example:
nettracker admin -listusers short_profile_name -explicit
Version 8.2.1
391
-quiet
Instructs Unica NetInsight not to print anything to standard output when performing administrative command-line operations.
N2110001
-roleinfo role_name
Lists: 1. All profiles with the specified role as the default role 2. All users with the specified role as their default role 3. All users with the specified role explicitly assigned in a profile, along with the profile in which it is assigned For this option, use the name of the role (for example, nettracker admin roleinfo _pwruser) and not the title of the role (for example, do not use nettracker admin -roleinfo Power User). You can display a list of role names by using the command nettracker admin -listroles. Example:
nettracker admin -roleinfo _pwruser
N2120001
-explicit
Includes only profiles in which the user has been explicitly assigned a role or default view. Example:
nettracker admin -userinfo "Bob Smith" -explicit
392
N10CD8
About Unica NetInsight configuration files NetTracker.cfg: NetInsight Program Configuration File Web.cfg : Global Profile Configuration File
N2140001
Version 8.2.1
394
adminemail authentication backgrounddrilldowns cachesize cgidir cgiextension cgiurl checkpointmegs database datastoredir dbconnect dbpassword dbsessionoptions dnsserver disablehtmlwithlinks email envvars helpurl homepagebutton htmldir htmlurl httpproxy indextablespace license locale logbrowsing logformats loginexpiration mailfrom mailserver maxcache maxcompletedperuser maxdnsrequests maxqueuedlines maxrunningglobal maxrunningperuser method network pagesize passiveftp
Unica NetInsight - Administrator's Guide
N2140007
pathsep platform plugin processlog element progdir reportinbox reportlimits reportsduringimport reportsduringupdate restrictprofilemanager resultsetretention runreportscheduler secure serialnumber source syncmode tempstore tempstoredir titleresolutiontimeout
N2160001
ebd = Unica NetInsight for DB2 ebm = Unica NetInsight for MySQL ebo = Unica NetInsight for Oracle
Version 8.2.1
395
activationkey
The <activationkey> element specifies the activation key for your license. This element activationkey> has no attributes and no child elements. This element must be contained by the <license> element. license>
Example
<activationkey>eval</activationkey>
N2170001
adminbutton
The <adminbutton> element sets the Enable Administration button option on the adminbutton> Advanced options page of the administrative options. If the element is present, the option is selected. If it is absent, the option is not selected. This element has no attributes, no child elements, and no value.
Example
<adminbutton/>
N2180001
adminemail
The <adminemail> element sets the Administrator's address option on the Email options adminemail> page of the administrative options. This element has no attributes and no child elements. It must be contained by the <email> element. email>
Example
<adminemail>bsmith@ Unica.com</adminemail>
N2190001
authentication
The <authentication> element is a container element for the user authentication child authentication> elements <loginexpiration>, <method>, <password>, <plugin>, <restrictprofilemanager>, loginexpiration> method> password> plugin> restrictprofilemanager> and <source>. The <authentication> element has no attributes and no value. source> authentication> The <password> element is only used when the authentication method is set to password> internal.
Example
<authentication> <loginexpiration>never</loginexpiration> 396 Unica NetInsight - Administrator's Guide
NetTracker.cfg: NetInsight Program Configuration File <method>internal</method> <password length="1" numerics="0" special="0"/> </authentication>
N21A0001
<restrictprofilemanager/>
backgrounddrilldowns
The <backgrounddrilldowns> element sets the Run drilldowns in background option on backgrounddrilldowns> the Advanced options page of the administrative options. If the element is present, the option is selected. If it is absent, the option is not selected. This element has no attributes, no child elements, and no value.
Example
<backgrounddrilldowns/>
N21B0001
cachesize
The <cachesize> element specifies the cache size, in number of database pages, to be cachesize> used by SQLite. The <cachesize> element has no attributes and no child elements. It cachesize> must be contained by the <database> element. The value of the <cachesize> element database> cachesize> is the size of the cache in terms of a number of database pages. The default is 2000. This element applies only to Unica NetInsight for SQLite.
Example
<cachesize>2500</cachesize>
N21C0001
cgidir
The <cgidir> element specifies the path for the Unica NetInsight CGI-BIN directory. The cgidir> directory must be set up as a CGI-BIN directory within your Web server software. The <cgidir> element has no attributes and no child elements. This element must be cgidir> contained by the <platform> element. platform>
Example
<cgidir>c:\inetpub\scripts\ Unica NetInsight\</cgidir>
N21D0001
Version 8.2.1
397
cgiextension
The <cgiextension> element specifies the file extension used for CGI files. For cgiextension> Windows, the extension is .exe. For UNIX, the extension is .cgi. The <cgiextension> cgiextension> element has no attributes and no child elements. This element must be contained by the <platform> element. platform>
Example
<cgiextension>exe</cgiextension>
N21E0001
cgiurl
The <cgiurl> element specifies the URL that corresponds to the CGI-BIN directory. The cgiurl> <cgiurl> element has no attributes and no child elements. This element must be cgiurl> contained by the <platform> element. platform>
Example
<cgiurl>http://www.unica.com/scripts/ Unica NetInsight/</cgiurl>
N21F0001
checkpointmegs
The <checkpointmegs> element specifies the interval at which Unica NetInsight stores checkpointmegs> all processed data in the database. The interval must be specified in megabytes of data processed. The default is 125, meaning Unica NetInsight stores data in the database each time it has processed 125 MB of data. This element has no attributes and no child elements. It must be contained by the <database> element. database>
Example
<checkpointmegs>150</checkpointmegs>
N2200001
database
The <database> element is a container element for the database settings elements database> <maxcache>, <dbconnect>, <dbpassword>, <checkpointmegs>, <indextablespace>, maxcache> dbconnect> dbpassword> checkpointmegs> indextablespace> <dbsessions>, <datastoredir>, <pagesize>, <cachesize>, <syncmode>, <tempstore>, dbsessions> datastoredir> pagesize> cachesize> syncmode> tempstore> and <tempstoredir>. The <database> element has no attributes and no value. tempstoredir> database>
398
Example
<database> <maxcache visits="512" views="4096" errors="1000" ids="503"/> <ctmemory>300</ctmemory> <ctsectors>64</ctsectors> </database>
N2210001
datastoredir
The <datastoredir> element specifies the directory in which to store temporary data files datastoredir> during import. The default value is the profile's data directory. The default data directory is , where Unica CustomerInsightUnica NetInsight is the Unica NetInsight program directory and short_profile_name is the profile name that appears in parentheses in the Available profile list. Do not modify this element without contacting technical support. This element is not present in the program configuration file unless you explicitly add it. Note that no corresponding option is available in the Unica NetInsight administrative options interface. This element has no attributes and no child elements. It must be contained by the <database> element. database>
Example
<datastoredir>Unica NetInsight/data/mywebprofile</datastoredir>
N2220001
dbconnect
The <dbconnect> element specifies the database connection string. This string is built dbconnect> during installation. Do not modify this element without contacting technical support. This element has no attributes and no child elements. It must be contained by the <database> element. database> This element does not apply to Unica NetInsight for SQLite.
Example
<dbconnect>DRIVER={SQL Server};UID=Unica NetInsight;PWD=%s; DATABASE=Unica NetInsight;SERVER=Unica NetInsight\ </dbconnect>
N2230001
Version 8.2.1
399
dbpassword
The <dbpassword> element specifies the password Unica NetInsight uses to connect to dbpassword> the database. You can change this element using the administrative commandline option -dbpasswd. This element has no attributes and no child elements. It must be contained by the <database> element. database>
Example
<dbpassword>c9b8MpJipwUU7M</dbpassword>
N2240001
dbsessionoptions
The <dbsessionoptions> element sets the Database session options option on the dbsessionoptions> Advanced options page of the administrative options. In general, you should not change the value for this element without contacting technical support. This element has no attributes and no child elements. It must be contained by the <database> element. database>
Example
<dbsessionoptions>sort_area_size = 1048576</dbsessionoptions>
N2250001
dnsserver
The <dnsserver> element sets the DNS server address option on the DNS page of the dnsserver> administrative options. This element has two attributes.
Attribute timeout Corresponding option Reverse DNS timeout Possible values Any numeric value from 2 to 7200 Any numeric value from 0 to 100 Default 3
retries
The <dnsserver> element has no child elements. It must be contained by the <network> dnsserver> network> element.
Example
<dnsserver timeout="10" retries="10"> 172.16.45.2 </dnsserver>
N2260001
400
disablehtmlwithlinks
The <disablehtmlwithlinks> element specifies that the Web Browser, with links (.html) disablehtmlwithlinks> format is not available in the list of formats for reports sent via email. This element has no attributes, no value, and no child elements. This element is not present in the Unica NetInsight program configuration file unless you explicitly add it. Note that no corresponding option is available in the Unica NetInsight administrative options interface. When the <disablehtmlwithlinks> element is present in the Unica NetInsight program disablehtmlwithlinks> configuration file: The Web Browser, with links (.html) option will not appear in the Format of reports drop-down list. This list is located on these windows and pages: Email option pop-up window (this window appears when you click the Email icon in the main interface) Email Tasks Email task description page (this page appears when you edit an email task) Custom Report Wizard Emailing the Report page (this page appears when you click Email on the Custom Report Wizard Report Summary page)
The default option in the Format of reports drop-down list is Web Browser, without links (.html) (.html). An email task that was previously configured to use the Web Browser, with links format will continue to use that format; however, when you edit the email task, the default value of the Format of reports drop-down list is Web Browser, without links (.html) (.html).
Example
<disablehtmlwithlinks/>
N2270001
email
The <email> element is a container element for the email settings elements: email> <mailserver>, <mailfrom>, and <adminemail>. The <email> element has no attributes mailserver> mailfrom> adminemail> email> and no value.
Example
<email> <mailserver port="25">mail.unica.com</mailserver> <mailfrom>Unica NetInsight @unica.com</mailfrom> </email>
Version 8.2.1
401
envvars
The <envvars> element specifies the environment variables that should be set when envvars> Unica NetInsight starts. This list appears on the Environment Variables page. The <envvars> element has no attributes and no value. Specify the environment variables envvars> using the child element <envvar>. The <envvar> element has one attribute. envvar> envvar>
Attribute name Corresponding option Name of variable Possible values Any environment variable name Default
Example
<envvars> <envvar name="ORACLE_HOME"> /home/oracle/u01/app/oracle/product/8.1.5 </envvar> <envvar name="NLS_LANG"> AMERICAN_AMERICA.WE8ISO8859P1 </envvar> </envvars>
N2290002
helpurl
The <helpurl> element directs the links in the Help menu to a server of your choosing. If helpurl> it is missing (the default), the links in the Help menu automatically point to Unica's hosted documentation server. Typically you would only add this element if your network does not have internet access and as a result you need to install the Unica NetInsight documentation on your corporate intranet.
Example
<helpurl>http://somedocserver.mydomain.com</helpurl>
N22A0001
homepagebutton
The <homepagebutton> element sets the Enable InsightNetInsightHomepage button homepagebutton> option on the Advanced options page of the administrative options. If the element is present, the option is selected. If it is absent, the option is not selected. This element has no attributes, no child elements, and no value.
Example
<homepagebutton/> 402 Unica NetInsight - Administrator's Guide
htmldir
The <htmldir> element specifies the path for the Unica NetInsight HTML directory. The htmldir> directory must be under the document root for your Web server. The <htmldir> element htmldir> has no attributes and no child elements. This element must be contained by the <platform> element. platform>
Example
<htmldir>c:\inetpub\wwwroot\Unica NetInsight \</htmldir>
N22C0001
htmlurl
The <htmlurl> element specifies the URL that corresponds to the HTML directory. The htmlurl> <htmlurl> element has no attributes and no child elements. This element must be htmlurl> contained by the <platform> element. platform>
Example
<htmlurl>http://www.unica.com/Unica NetInsight/</htmlurl>
N22D0001
httpproxy
The <httpproxy> element sets the HTTP proxy server option on the Proxies page of the httpproxy> administrative options. This element has one attribute.
Attribute port Corresponding option HTTP proxy server port Possible values Any number Default
The <httpproxy> element has no child elements. It must be contained by the <network> httpproxy> network> element.
Example
<httpproxy port="80">172.16.96.7</httpproxy>
N22E0001
indextablespace
The <indextablespace> element specifies the name of the tablespace (filegroup in SQL indextablespace> Server) where the indices are stored. Do not modify the value of this element without contacting technical support. This element has no attributes and no child elements. It must be contained by the <database> element. database>
Version 8.2.1 403
Example
<indextablespace>INDX</indextablespace>
N22F0001
license
The <license> element is a container element for the license settings elements: license> <serialnumber> and <activationkey>. The <license> element has no attributes and no serialnumber> activationkey> license> value.
Example
<license> <serialnumber>eval</serialnumber> <activationkey>eval</activationkey> </license>
N2300001
locale
The <locale> element customizes the administrative interface for your locale. If the locale> element is missing, the defaults are used. This element has four attributes; each one corresponds to an option on the Locale options page in the administrative options.
Attribute timeformat dateformat charset Corresponding option Display time as Display date as Character set Possible values 12hr, 24hr mdy, dmy, ymd latin1, latin2, sjis, big5, gb2312, euckr, user Default 12hr mdy latin1
language
Language
Example
<locale timeformat="12hr" dateformat="mdy" charset="latin1" language="en"/>
N2310001
404
logbrowsing
The <logbrowsing> element sets the Enable log file browsing option on the Advanced logbrowsing> options page of the administrative options. If the element is present, the option is set. If it is missing, the option is not set. This element has no attributes, no child elements, and no value.
Example
<logbrowsing/>
N2320001
logformats
The <logformats> element contains a list of custom log formats. This list displays on the logformats> Custom Log Formats page of the administrative options. The <logformats> element has logformats> no attributes and no value. Use the child element <logformat> to specify the actual logformat> formats. The value of the <logformat> element is the name of the format. This element logformat> has one attribute.
Attribute format Corresponding option Log format Possible values Any valid log format* Default
* For details on valid log formats, including mandatory field identifiers, see the Unica NetInsight User's Guide or online help.
Example
<logformats> <logformat format="%HOST% %IDENT% %USERNAME% [%DATETIME%] "%REQUEST%" %STATUS% %BYTES% "%REFERRER%" "%USERAGENT%" "%SANECOOKIE%" %SANESTOP% %TIMETAKEN%"> NCSA Combined plus plug-in </logformat> </logformats>
N2330001
loginexpiration
The <loginexpiration> element sets the Logins expire option on the Authentication page loginexpiration> of the administrative options. The possible values are never and session. The default is never. This element has no attributes and no child elements. It must be contained by the <authentication> element. authentication>
Version 8.2.1
405
Example
<loginexpiration>never</loginexpiration>
N2340001
mailfrom
The <mailfrom> element sets the From address option on the Email page of the mailfrom> administrative options. This element has no attributes and no child elements. It must be contained by the <email> element. email>
Example
<mailfrom> Unica NetInsight@unica.com</mailfrom>
N2350001
mailserver
The <mailserver> element sets the Mail server (SMTP) option on the Email page of the mailserver> administrative options. This element has one attribute.
Attribute port Corresponding option Mail server port Possible values Any number up to 65,535 Default 25
Example
<mailserver port="25">mail.unica.com</mailserver>
N2360001
maxcache
The <maxcache> element specifies how database items will be cached on the client. maxcache> This element has five attributes.
Attribute visits Corresponding option Possible values Default 61440
Number of hash buckets Any number equal to or used when caching vis- greater than 2 its Number of views to store before forcing a checkpoint Any number equal to or greater than 0
views
406
NetTracker.cfg: NetInsight Program Configuration File Attribute errors Corresponding option Number of errors to store before forcing a checkpoint Possible values Any number equal to or greater than 2* Default 0
ids
Number of hash buckets Any number equal to or used when caching IDs greater than 2* The amount of memory (in MB) to be used for cached elements Any number equal to or greater than 10
15013
maxdb
* This value should be a prime number for optimal performance. The <maxcache> element has no value and no child elements. It must be contained by maxcache> the <database> element. database>
Example
<maxcache visits="512" views="0" errors="0" ids="503"/>
N2370002
maxcompletedperuser
The <maxcompletedperuser> element specifies the maximum number of reports with maxcompletedperuser> the status of Canceled by Admin, Completed, or Failed that a user is allowed to retain in the Inbox. This element has no attributes and no child elements. It must be contained by the <reportinbox> element. The value of the <maxcompletedperuser> element is the reportinbox> maxcompletedperuser> number of reports. The default value is 100.
Example
<maxcompletedperuser>50</maxcompletedperuser>
N2380001
maxdnsrequests
The <maxdnsrequests> element sets the Maximum simultaneous DNS requests option maxdnsrequests> on the DNS page of the administrative options. The default is 2000. This element has no attributes and no child elements.
Example
<maxdnsrequests>1000</maxdnsrequests>
N2390001
Version 8.2.1
407
maxqueuedlines
The <maxqueuedlines> element specifies how many log file lines are queued for the maxqueuedlines> import process. The import process is comprised of two separate threads: the parser and the loader. The <maxqueuedlines> element has two attributes. maxqueuedlines>
Attribute parser Corresponding option Number of log file lines queued for the parser Possible values Any number Default 0 (single CPU) 2000 (multiple CPUs) 10000
sorter*
Number of log file lines Any number sorted into chronological order
* This attribute only applies to logs in Netscape Flexible format, NCSA Common/Combined format, or a custom format. Setting an attribute to 0 turns off the corresponding thread. The <maxqueuedlines> element has no value and no child elements. maxqueuedlines>
Example
<maxqueuedlines parser="2000" sorter="10000"/>
N23A0002
maxrunningglobal
The <maxrunningglobal> element specifies the maximum number of reports with the maxrunningglobal> status of Running allowed in the system, regardless of who requested them. This element has no attributes and no child elements. It must be contained by the <reportinbox> element. The value of the <maxrunningglobal> element is the number of reportinbox> maxrunningglobal> reports. The default value is 200. A value of 0 means there is no limit.
Example
<maxrunningglobal>10</maxrunningglobal>
N23B0002
maxrunningperuser
The <maxrunningperuser> element specifies the maximum number of reports with the maxrunningperuser> status of Running allowed per user. This element has no attributes and no child elements. It must be contained by the <reportinbox> element. The value of the reportinbox> <maxrunningperuser> element is the number of reports. The default value is 5. A value maxrunningperuser> of 0 means there is no limit.
408
Example
<maxrunningperuser>5</maxrunningperuser>
N23C0001
method
The <method> element sets the Authenticate using option on the Authentication page of method> the administrative options. The possible values are external, internal, webserver, and Unica. The default is internal. This element has no attributes and no child elements. It must be contained by the <authentication> element. authentication>
Example
<method>external</method>
N23D0001
network
The <network> element is a container element for the network settings elements: network> <httpproxy>, <dnsserver>, and <passiveftp>. The <network> element has no attributes httpproxy> dnsserver> passiveftp> network> and no value.
Example
<network> <httpproxy port="80">172.16.96.7</httpproxy> <dnsserver>172.16.45.2</dnsserver> </network>
N23E0001
pagesize
The <pagesize> element specifies the page size to be used for newly created SQLite pagesize> profile data files. This page size will not apply to miscellaneous SQLite data file used elsewhere within Unica NetInsight. The <pagesize> element has no attributes and no pagesize> child elements. It must be contained by the <database> element. The value of the database> <pagesize> element is the size of the page in number of bytes. (The number must be a pagesize> power of two.) The default is 1024. This element applies only to Unica NetInsight for SQLite.
Example
<pagesize>512</pagesize>
N23F0001
Version 8.2.1
409
passiveftp
The <passiveftp> element sets the Use passive mode FTP option on the Proxies passiveftp> Settings page of the administrative options. If the element is present, the option is set. If it is missing, the option is not set. This element has no attributes, no child elements, and no value. It must be contained by the <network> element. network>
Example
<passiveftp/>
N2400001
pathsep
The <pathsep> element specifies the character used to separate directories in file pathsep> paths. For Windows, the character is a backward slash (\). For UNIX, the character is a forward slash (/). The <pathsep> element has no attributes and no child elements. This pathsep> element must be contained by the <platform> element. platform>
Example
<pathsep>\</pathsep>
N2410001
platform
The <platform> element is a container element for the platform settings elements: platform> <progdir>, <htmldir>, <htmlurl>, <cgidir>, <cgiurl>, <pathsep>, <cgiextension>, and progdir> htmldir> htmlurl> cgidir> cgiurl> pathsep> cgiextension> <linefeeds>. The <platform> element has no attributes and no value. linefeeds> platform>
Example
<platform> <progdir>c:\Program Files\Unica NetInsight\</progdir> <htmldir>c:\inetpub\wwwroot\Unica NetInsight\</htmldir> <htmlurl>http://www.unica.com/Unica NetInsight/</htmlurl> <cgidir>c:\inetpub\scripts\Unica NetInsight\</cgidir> <cgiurl>http://www.unica.com/scripts/Unica NetInsight/</cgiurl> <pathsep>\</pathsep> <cgiextension>exe</cgiextension> <linefeeds>lf</linefeeds> </platform>
N2420001
410
plugin
The <plugin> element specifies the plug-in to be used to perform external authentication plugin> and/or retrieve a user's full name and email address. The value must be a path and file name for an NTDI API plug-in capable of performing external authentication. This element has one attribute.
Attribute conf Corresponding option Possible values Default
Full path to conduit con- Path and file name of fig the configuration file to be passed to the plug-in
This attribute has no child elements. It must be contained by the <authentication> authentication> element.
Example
<plugin conf="./ldapauth.conf">./ldapauth.so</plugin>
N2430002
processlog element
The <processlog> element enables Unica NetInsight process logging. It is present processlog> (process logging enabled) by default.
Example
<processlog/>
N2440001
progdir
The <progdir> element specifies the path for the Unica NetInsight program directory. The <progdir> element has no attributes and no child elements. This element must be progdir> contained by the <platform> element. platform>
Example
<progdir>c:\Program Files\Unica NetInsight\</progdir>
N2450002
reportinbox
The <reportinbox> element is a container element for the <maxrunningperuser>, reportinbox> maxrunningperuser> <maxrunningglobal>, <maxcompletedperuser>, and <runreportscheduler> element. The maxrunningglobal> maxcompletedperuser> runreportscheduler> <reportinbox> element has no attributes and no value. reportinbox>
Version 8.2.1 411
Example
<reportinbox> <maxrunningperuser>5</maxrunningperuser> <maxrunningglobal>10</maxrunningglobal> <maxcompletedperuser>50</maxcompletedperuser> <runreportscheduler>true</runreportscheduler> </reportinbox>
N2460002
reportlimits
The <reportlimits> element is a container element for the sub-elements <reports> and reportlimits> reports> <rows>. It has no attributes or value of its own. rows> The <reports> element defines the maximum number of reports NetInsight will return in reports> a single calendar month in response to GetReportData requests received through its XML API. The default is one thousand. Once the specified limit is reached, subsequent requests will return an error. The <rows> element defines the maximum number of report rows NetInsight will return rows> in a single calendar month in response to GetReportData requests received through its XML API. The default is two million. Once the specified limit is reached, subsequent requests will return an error. Note that the number represents the sum total of rows returned from the database and therefore is not limited to actual report rows. For any month NetInsight recognizes whichever limit is reached first, <reports> or reports> <rows>. rows> Note that these limits are only enforced if the ondemand flag is set, meaning they do not pertain to Unica NetInsight Enterprise installations.
Example
<reportlimits> <requests>1000</requests> <rows>2000000</rows> </reportlimits>
N2470001
reportsduringimport
The <reportsduringimport> element sets the Enable reports during data import option on reportsduringimport> the Advanced options page. If this element is present, the option is selected. If it is absent, the option is not selected. This element has no attributes, no child elements, and no value. This element only applies to Unica NetInsight for Oracle and Unica NetInsight for Netezza.
412
Example
<reportsduringimport/>
N2480001
reportsduringupdate
The <reportsduringupdate> element sets the Enable reports during report generation reportsduringupdate> option on the Advanced options page. If this element is present, the option is selected. If it is absent, the option is not selected. This element has no attributes, no child elements, and no value. This element does not apply to Unica NetInsight for SQLite.
Example
<reportsduringupdate/>
N2490001
restrictprofilemanager
The <restrictprofilemanager> element sets the Restrict access to Profile Manager option restrictprofilemanager> on the Authentication options page. If this element is present, the option is selected. If it is absent, the option is not selected. This element has no attributes, no child elements, and no value. This element must be contained by the <authentication> element. authentication>
Example
<restrictprofilemanager/>
N24A0001
resultsetretention
The <resultsetretention> element specifies the length of time that a temporary data resultsetretention> table is to be retained. (Temporary data tables are generated when a user requests a custom report.) The length of time must be specified in seconds. The default value for Unica NetInsight is 900 seconds. A value of 0 specifies that the temporary data tables should not be retained and should be deleted immediately after they are first used. This element has no attributes and no child elements.
Example
<resultsetretention>800</resultsetretention>
N24B0002
Version 8.2.1
413
runreportscheduler
The <runreportscheduler> element sets the Run Queued Reports option on the runreportscheduler> Advanced options page of the Administrative options. This element has no attributes and no child elements. It must be contained by the <reportinbox> element. When the reportinbox> <runreportscheduler> element is set to true, the option is selected and the report runreportscheduler> scheduler runs. When the element is set to false, the option is cleared and no reports are generated.
Example
<runreportscheduler>true</runreportscheduler>
N24C0001
secure
This element applies only to installations on UNIX computers. It has no effect on Windows computers. The <secure> element causes any new profile-related directories to be created with secure> permissions of 755 (readable, writeable, and accessible by the owner and readable and accessible by anyone else) and any new profile-related data files to be created with permissions of 644 (readable and writeable by the owner and readable by anyone else). If this element is not present, new directories are created with permissions of 777 (readable, writeable, and accessible by any user) and new data files are created with permissions of 666 (readable and writeable by any user). This element has no attributes, no child elements, and no value.
Example
<secure/>
N24D0001
serialnumber
The <serialnumber> element specifies the serial number for your license of Unica serialnumber> NetInsight. This element has no attributes and no child elements. It must be contained by the <license> element. license>
Example
<serialnumber>eval</serialnumber>
N24E0001
414
source
The <source> element specifies the environment variable that supplies the user names source> for Web server authentication. This element has no attributes and no child element. The value of the element is the name of the environment variable that supplies the user names. If the <source> element is absent, the user names will come from the source> REMOTE_USER environment variable. This element must be contained by the <authentication> element. authentication>
Example
<source>HTTP_IV_USER</source>
N24F0001
syncmode
The <syncmode> element specifies how hard SQLite should try to ensure that data is syncmode> safely written to disk. This element has no attributes and no child elements. It must be contained by the <database> element. The value of the <syncmode> element is an database> syncmode> integer (0, 1, or 2) corresponding to a setting for the synchronous parameter in SQLite. The default value is 2. This element applies only to Unica NetInsight for SQLite. This element is present in the Unica NetInsight configuration file only if it has been manually set to a value other than the default.
Example
<syncmode>1</syncmode>
N2500001
tempstore
The <tempstore> element specifies where SQLite should store temporary tables and tempstore> indices. This element has no attributes and no child elements. It must be contained by the <database> element. The value of the <tempstore> element is an integer (0, 1, or database> tempstore> 2) corresponding to a setting for the temp_store parameter in SQLite. The default value is 0. This element applies only to Unica NetInsight for SQLite. This element is present in the Unica NetInsight configuration file only if it has been manually set to a value other than the default.
Version 8.2.1
415
Example
<tempstore>1</tempstore>
N2510001
tempstoredir
The <tempstoredir> element specifies the name of the directory in which SQLite will tempstoredir> create temporary tables and indexes. (Temporary files created by SQLite are unlinked immediately after they are created, so they will normally not be visible in the given directory.) If this element is not present, Unica NetInsight determines a location for the temporary files on its own. This element has no attributes and no child elements. It must be contained by the <database> element. The value of the <tempstoredir> element is a database> tempstoredir> directory path. This element applies only to Unica NetInsight for SQLite. This element is present in the Unica NetInsight configuration file only if it has been manually set to a value other than the default.
Example
<tempstoredir>C:\Temp\sqlite_temp</tempstoredir>
N2520001
titleresolutiontimeout
The <titleresolutiontimeout> element specifies how long Unica NetInsight waits for a titleresolutiontimeout> response from the Web server when resolving page titles. This element has no attributes and no child elements. The value of this element is the number of seconds Unica NetInsight should wait for a response from the Web server; the default is 4 seconds.
Example
<titleresolutiontimeout>6</<titleresolutiontimeout>
N2150002
About the global profile configuration file aggdeffile aggsrequired bannerads browsers
Unica NetInsight - Administrator's Guide
campaigns casesensitivepages casesensitiveusernames connection contentgroups converttimes cookielookup custommetrics dashboardsize daterange defaults departments dimensionlists dimensionsfile dirindexes dmpackages donotconverttimes dynamicpages element emailalerts emailtasks entity excludedagents excludedhosts excludedpages excludedparametervalues excludedusers filtergroups filterinstances filterlists ftpdebug hidelinks hostgroups hostlookup ignoredfields includedagents includedhosts includedpages includedparametervalues includedusers
417
Version 8.2.1
418
keywordrules levels linklength locale localkeywords logs maildebug maxpathlength member metriclists metricsfile module modules nodefaultautoupdate nodefaultautoupdatefull nodefaultautoupdatesample noimportreindex nonreportabledimensions notableanalysis ntadtrack ntdi ntlinktrack outdefext parameters password platforms precalcdates redirectscripts referrergroups reportlists resolvehosts referrergroups resolvetitles retrievebatchsize roledefaults rows sampling schemafile securityrealms seed
Unica NetInsight - Administrator's Guide
N215000B
segment servers sessionization siteurl spiders summarysize tagimages title titlelength titles unexcludedpages unresolvedtitles url urlsearchrules user userlookup variablesfile viewlist virtual visitorlookup visitorprofiles visitthreshold writebatchsize
aggdeffile
The <aggdeffile> element specifies the file from which Unica NetInsight should read aggdeffile> aggregate definitions. This element has no attributes and no child elements. The value of the element is the filename of the aggregate definition file to use. The file must be located in the Unica NetInsight/data/directory. If this element is missing, Unica NetInsight uses the default aggregate definition file for the profile.
Example
<aggdeffile>myaggdefs.xml</aggdeffile> Version 8.2.1 419
aggsrequired
The <aggsrequired> element specifies that an aggregate definition file must be loaded aggsrequired> successfully or an error will be generated. This element has no attributes, no child elements, and no value. If the element is present, an aggregate definition file must be loaded successfully. If the element is missing, no error will be generated if the aggregate definition file is missing.
Example
<aggsrequired/>
N2550001
bannerads
The <bannerads> element contains a list of banner ads you want to track. This list bannerads> appears on the Banner Ads page. The <bannerads> element has no attributes and no bannerads> value. Each banner ad is specified using the child element <bannerad>. The value of bannerad> the <bannerad> element is the name of the banner ad. The <bannerad> element has bannerad> bannerad> two attributes.
Attribute file url Corresponding option Full path of graphic URL to link to Possible values Any path Any URL Default
Example
<bannerads> <bannerad file="/graphics/bannerad1.jpg" url="http://www. Unica.com"> ACME banner ad </bannerad> </bannerads>
N2560001
browsers
The <browsers> element contains a list of the browser names that will appear in browsers> reports. This list appears on the Browsers page. The <browsers> element has no browsers> attributes and no value. Each browser is specified using the child element <browser>. browser> The <browser> element has two attributes and no value. browser>
420
Web.cfg : Global Profile Configuration File Attribute appendversion Corresponding option Append the version number Name of browser Possible values true, false Default false
name
The individual members of each browser group are specified using the child element <member>. The value of the <member> element is the text used to determine if a member> member> browser is to be included in the group.
Example
<browsers> <browser name="America Online"> <member method="match_pattern"> ^Mozilla/.*AOLIWENG </member> <member method="starts_with">aolbrowser/</member> <member method="starts_with">IWENG/</member> </browser> <browser appendversion="true" name="Netscape Navigator"> <member method="match_pattern">^Mozilla/([01234]\.)</member> <member method="match_pattern"> ^Mozilla/[56789]\..*Netscape\d */(\d+.) </member> </browser> </browsers>
N2570001
campaigns
The <campaigns> element contains a list of all the campaigns you want Unica campaigns> NetInsight to track. This list appears on the Campaigns page. The <campaigns> campaigns> element has no attributes and no value. Each campaign is specified using the child element <campaign>. The <campaign> element has one attribute and no value. campaign> campaign>
Attribute name Corresponding option Name of campaign Possible values Any alphanumeric characters Default
Example
<campaigns> <campaign name="Offer"> <channel name="checkdomain" type="bannerad"> <segment name="Ad Segment 1"> <member method="equals">promo</member> Version 8.2.1 421
20 - NetInsight Configuration Files </segment> <segment name="Ad Segment 2"> <member method="equals">demo</member> </segment> </channel> </campaign> </campaigns>
N2580001
casesensitivepages
The <casesensitivepages> element sets the Case sensitive pages option on the casesensitivepages> General options page. If the element is present, the option is selected. If it is absent, the option is not selected. This element has no attributes, no child elements, and no value.
Example
<casesensitivepages/>
N2590001
casesensitiveusernames
The <casesensitiveusernames/> element sets the Case sensitive user names option on casesensitiveusernames/> the General options page. If the element is present, the option is selected. If it is absent, the option is not selected. This element has no attributes, no child elements, and no value.
Example
<casesensitiveusernames/>
N25A0001
connection
The <connection> element is a container element for the information Unica NetInsight connection> needs to connect to an external module. This element must be contained by a <module> element. The <connection> element has no attributes and no value. Use the module> connection> child elements <url>, <user>, and <password> to specify the connection information. url> user> password>
Example
<connection>
<url>http://www.paidsearchintegrationserver.coml</url>
<user>Unica</user>
422
</connection>
N25B0001
contentgroups
The <contentgroups> element contains a list of content groups that categorize the clips contentgroups> on your streaming media server. This list appears on the Content Groups page. The <contentgroups> element has no attributes and no value. Each content group is contentgroups> specified using the child element <contentgroup>. The <contentgroup> element has one contentgroup> contentgroup> attribute and no value.
Attribute name Corresponding option Name of content group Possible values Any alphanumeric characters Default
Use the child element <member> to specify the individual clips that are part of the member> content group. The value of the <member> element is the text used to determine which member> clips are in the group.
Example
<contentgroups> <contentgroup name="Concerts"> <member method="starts_with">/concerts</member> </contentgroup> <contentgroup name="Lectures"> <member method="starts_with">/lectures</member> </contentgroup> </contentgroups>
N25C0001
converttimes
The <converttimes> element sets the Convert dates and times to local timezone option converttimes> on the Advanced options page. If the element is present, the option is selected. If it is absent, the option is not selected. This element has no attributes, no child elements, and no value.
Example
<converttimes/>
N25D0001
Version 8.2.1
423
cookielookup
The <cookielookup> element sets the Cookie lookup URL option on the Lookup Scripts cookielookup> page. The value of the element is the script you want executed when the user clicks a cookie in the Cookie Summary If the element is missing, the option will be blank. This Summary. element has no attributes and no child elements.
Example
<cookielookup> http://host.domainname.com/scripts/weblookup.exe?cookie= </cookielookup>
N25E0001
custommetrics
The <custommetrics> element contains the list of custom metrics for the profile. This list custommetrics> appears on the Custom Metrics options page. This element has no attributes and no value. Specify each custom emtric using the child element <custommetric>. The custommetric> <custommetric> element has eight attributes. custommetric>
Attribute Corresponding Option Possible values Default
name
Name
type
Select custom metric type Alignment Minimum twips Recommended twips Graphable Display percentage of total Precision
left, right, center Any numeric value Any numeric value true, false true, false false false
precision
The <custommetric> element can contain the child elements <displayname>, custommetric> displayname> <description>, <basemetric>, <filterinstances>, <metric1>, <metric2>, and <operation>. description> basemetric> filterinstances> metric1> metric2> operation> The <displayname> element specifies the title for the metric. This element has no displayname> attributes and no child elements. The value of the element is the metric title.
424
The <description> element specifies the description for the metric. The description description> appears as the text for the metric's column in the reports page help. This element has no attributes and no child elements. The value of the element is the metric description. The <basemetric> element specifies the metric that will provide the data to be basemetric> filtered for the current metric. This element only applies to <custommetric> elements custommetric> whose type attribute has a value of filtered. The <basemetric> element has no basemetric> attributes and no child elements. The value is the name of the base metric. The <filterinstances> element specifies the filters for the metric. This element only filterinstances> applies to <custommetric> elements whose type attribute has a value of filtered. For custommetric> details on the <filterinstances> element, see the document "Unica NetInsight filterinstances> Dimension and Metric Filters." The <metric1> element specifies the metric that you want to divide. This element metric1> only applies to <custommetric> elements whose type attribute has a value of custommetric> multiinput. The <metric1> element has no attributes and no child elements. The metric1> value of the element is the metric name. The <metric2> element specifies the metric by which you want to divide. This metric2> element only applies to <custommetric> elements whose type attribute has a value custommetric> of multiinput. The <metric1> element has no attributes and no child elements. The metric1> value of the element is the metric name. The <operation> element specifies the mathematical operation you want to apply to operation> the metrics specified by the <metric1> and <metric2> elements. The <operation> metric1> metric2> operation> element only applies to <custommetric> elements whose type attribute has a value custommetric> of multiinput.
Example
<custommetrics> <custommetric name="downloadspersession" type="multiinput" alignment="right" mintwips="2000" recommendedtwips="2000" graphable="true" precision="8"> <displayname>Downloads per Session</displayname> <metric1>downloads</metric1> <metric2>sessions</metric2> <operation>div_float</operation> </custommetric> <custommetric name="wdsessions" type="filtered" alignment="right" mintwips="775" recommendedtwips="1775" graphable="true" percentage="true"> <displayname>WeekDay Sessions</displayname> <description>The number of sessions during weekdays</description> <basemetric>sessions</basemetric> <filterinstances> <filterinstance type="dow"> <values> <value>2</value> <value>3</value> <value>4</value> <value>5</value> <value>6</value> </values> Version 8.2.1 425
dashboardsize
The <dashboardsize> element sets the Number of values per dashboard graph option dashboardsize> on the General options page. The default value is 5. This element has no attributes and no child elements.
Example
<dashboardsize>10</dashboardsize>
N2600001
daterange
The <daterange/> element restricts Unica NetInsight to a specified date range of log daterange/> files. Unica NetInsightwill not analyze any log file data outside of the date range. If the element is missing, Unica NetInsight will analyze all of the log file data. This element has two possible attributes. Each attribute corresponds to an option on the Included Dates page.
Attribute start end Corresponding option Starting date Ending date Possible values Any Julian date Any Julian date Default
Example
<daterange start="2449719" end="2451545"/>
N2610001
defaults
The <defaults> element specifies the default role and default view for a profile. This defaults> element is present only when a value other than (None) has been selected for the default role, the default view, or both. The <defaults> element has two possible attributes, each of which has a corresponding defaults> option on the profile Defaults page. Each attribute appears only if the corresponding option is set to a value other than (None) (None).
426
Web.cfg : Global Profile Configuration File Attribute role view Corresponding option Default role Default view Possible values Default
role_name/_noaccess)
view_name
Example
<defaults role="limited" view="marketing"/>
N2620001
departments
The <departments> element contains a list of departments that group the traffic on departments> server. This list appears on the Departments options page. The <departments> element departments> has one attribute and no value.
Attribute click Corresponding option Departments defined primarily by Possible values hosts, users Default hosts
Each department is specified using the child element <department>. The <department> department> department> element has one attribute and no value.
Attribute name Corresponding option Name of department Possible values Any alphanumeric characters Default
The individual members of each department are specified using the child element <member>. The <member> element uses both the method and type attributes inside member> member> the <department> element. The type attribute has two possible values: host and user. department> The default value is host. The value of the <member> element is the host or user name. member>
Example
<departments> <department name="Sales"> <member type="host" method="ends_with">.sales.company.com</member> </department> </departments>
N2630001
Version 8.2.1
427
dimensionlists
The <dimensionlists> element contains a list of dimension list definitions. The list dimensionlists> appears on the Dimension Lists options page. This element has no attributes and no value. Use the <dimensionlist> element to define each dimension list. The dimensionlist> <dimensionlist> element has two attributes. dimensionlist>
Attribute name Corresponding option Title of dimension list Possible values Any character string less than 120 characters Any character string of less than 30 characters that starts with a letter, uses only alphanumeric characters, hyphens, or underscores, and does not match the name of a subdirectory in the profile's HTML directory Default
id
The <dimensionlist> element has no value. Use the child element <group> to specify dimensionlist> group> each group in the list. The <group> element has one attribute. group>
Attribute name* Corresponding option Title of group Possible values Any character string less than 120 characters Default
* Unica NetInsight will create an ID for the group by replacing any spaces and nonalphanumeric characters in the name with underscores. Each group's ID must be unique within the dimension list. The <group> element has no value. Use the child element <dimension> to specify each group> dimension> dimension in the group. The <dimension> element has two attributes. dimension>
Attribute name* Corresponding option Dimension title Possible values Any character string less than 120 characters Any dimension key Default
target
Dimension source
* Unica NetInsight will create an ID for the dimension by replacing any spaces and non-alphanumeric characters in the name with underscores. Each dimension's ID must be unique within the dimension list. The <dimension> element has no child elements and no value. dimension>
428
Example
<dimensionlists> <dimensionlist name="My Dimension List" id="mylist"> <group name="Visitor Dimensions"> <dimension name="Host" target="host"/> </group> </dimensionlist> </dimensionlists>
N2640001
dimensionsfile
The <dimensionsfile> element specifies a dimensions file to use with this profile. This dimensionsfile> element has no attributes and no child elements. The value of the element is the filename of the dimensions file to be used. The file must be located in the Unica NetInsight/data/directory. If this element is missing, Unica NetInsight uses the default dimensions file for the profile type.
Example
<dimensionsfile>mydimensionsfile.xml</dimensionsfile>
N2650001
dirindexes
The <dirindexes> element contains a list of directory indexes. The <dirindexes> element dirindexes> dirindexes> has no attributes and no value. Use the child element <member> to specify the indexes. member> Inside the <dirindexes> element, Unica NetInsight ignores the method attribute of the dirindexes> <member> element. All entries are matched using ends_with The value of the member> ends_with. <member> element is the name of the index. member>
Example
<dirindexes> <member>/index.html</member> </dirindexes>
N2660001
dmpackages
The <dmpackages> element contains a list of all the data model extensions configured dmpackages> for the profile. This list appears on the Available data model extensions page. The <dmpackages> element has no attributes and no value. Each data model extension is dmpackages> specified using the child element <dmpackage>. The <dmpackage> element has one dmpackage> dmpackage> attribute and no value.
Version 8.2.1
429
20 - NetInsight Configuration Files Attribute name Corresponding option Name of the datamodel extension Possible values Any alphanumeric characters Default
The <dmpackage> element contains two elements: dmpackage> <dmext>, the value of which is the path and filename of the data model extensions dmext> file <formatdbext>, the value of which is the path and filename of the output formatting formatdbext> extension file
You can specify the file locations using absolute or relative paths. Paths are relative to the Unica NetInsight/data/ directory. The <dmext> and <formatdbext> elements have no attributes. dmext> formatdbext> If <dmpackages> this element is missing, Unica NetInsight uses the default dimensions dmpackages> file for the profile.
Example
<dmpackages> <dmpackage name="Extension"> <dmext> C:\Program Files\Unica NetInsight\data\myextensionsfile.xml </dmext> <formatdbext> C:\Program Files\Unica NetInsight\data\myeoutputfile.xml </formatdbext> </dmpackage > </dmpackages>
N2670001
donotconverttimes
The <donotconverttimes/> element sets the Do not convert dates and times to local time donotconverttimes/> zone option on the Advanced options page. If the element is present, the option is selected. If it is absent, the option is not selected. This element has no attributes, no child elements, and no value.
Example
<donotconverttimes/>
N2680001
dynamicpages
The <dynamicpages> element contains a list of the dynamic pages for which the query dynamicpages> string will be treated as part of the page. This list appears on the Dynamic Pages page.
430 Unica NetInsight - Administrator's Guide
The <dynamicpages> element has no attributes and no value. Use the child element dynamicpages> <member> to specify each dynamic page. The value of the <member> element is the member> member> text that identifies a dynamic page.
Example
<dynamicpages> <member method="contains">/cgi-bin/</member> <member method="ends_with">.exe</member> </dynamicpages>
N2690001
element
The <element> element specifies the database column on which the data is sampled. element> The <element> element has no attributes and no child elements. The value of the element> element is the name of the database column. Currently, VisitorID is the only supported sampling element. The <element> element must be contained by the <sampling> element> sampling> element.
Example
<element>VisitorID</element>
N26A0001
emailalerts
The <emailalerts> element contains a list of email alerts. An email alert enables you to emailalerts> notify one or more individuals via email when certain user-defined criteria are met at the completion of each update. The list of email alerts appears on the Email Alerts page. The <emailalerts> element has no attributes and no value. Each individual email alert is emailalerts> specified using the child element <emailalert>. The <emailalert> element has six emailalert> emailalert> attributes.
Version 8.2.1
431
20 - NetInsight Configuration Files Attribute timeperiod Corresponding option Time period Possible values Default
all, latest, today, yester- latest day, currentdays-<num< ber>, currentweeksber> <number>, currentnumber> months-<number>, cur<number> rentquarters-<number>, <number> currentyears-<number>, <number> previousdays-<num< ber>, previousweeksber> <number>, previousnumber> months-<number>, pre<number> viousquarters-<num< ber>, previousyearsber> <number>, currentweek, number> currentmonth, currentquarter, currentyear, previousweek, previousmonth, previousquarter, previousyear Any alphanumeric characters Any email task name Any valid metric name equalto, greaterthan, equalto greaterthanequalto, lessthan, lessthanequalto, notequalto Any numeric characters
name
Name of alert
threshold
The <emailalert> element has no value. Use the child element <filterinstances> to emailalert> filterinstances> specify the filters that define the email alert.
Example
<emailalerts> <emailalert timeperiod="previousweek" name="AnEmailAlert" task="AnEmailTask" metric="views" compare="equalto" threshold="5"> <filterinstances> <filterinstance type="host" comparison="equals"> Acme </filterinstance> </filterinstances> </emailalert>
432
emailtasks
The <emailtasks> element contains a list of email tasks. An email task links reports with emailtasks> recipients so that you can send the reports to the recipients via email. The list of email tasks appears on the Email Tasks page. The <emailtasks> element has no attributes and no value. Each individual email task is emailtasks> specified using the child element <emailtask>. The <emailtask> element has six emailtask> emailtask> attributes.
Attribute exclude Corresponding option Possible values Default false
Specifies whether to ex- true, false clude from batch execution Time period
timeperiod
all, latest, today, yester- latest day, currentdays-<num< ber>, currentweeksber> <number>, currentnumber> months-<number>, cur<number> rentquarters-<number>, <number> currentyears-<number>, <number> previousdays-<num< ber>, previousweeksber> <number>, previousnumber> months-<number>, pre<number> viousquarters-<num< ber>, previousyearsber> <number>, currentweek, number> currentmonth, currentquarter, currentyear, previousweek, previousmonth, previousquarter, previousyear csv, rtf, htmlnolinks, html Any alphanumeric characters Any alphanumeric characters Any alphanumeric characters Value for the From address option on the Email page in the administrative options html
format
Format of reports
subject
Subject of email
name
Name of task
from*
From address
Version 8.2.1
433
* The from attribute is present in the configuration file only when the value specified on the Email task description page in the profile options differs from the value specified for the From address option in the administrative options. The value of the <emailtask> element is the additional text. emailtask> You can include summaries, dashboards, and saved custom reports in an email task. The child element <summaries> contains the reports to send. The <summaries> summaries> summaries> element has no attributes and no value. Use the child element <summary> to specify summary> each report. The value of the <summary> element is as follows: summary>
Dashboard Content Executive Technical Traffic Visitor Dashboard Content Executive Technical Traffic Visitor
For summaries, the value is the abbreviated summary name. For a list of abbreviated summary names, see the <summaries> element. summaries> For dashboards, the value is the abbreviated dashboard name.
Abbreviation contentdash executive techdash trafficdash visdash Abbreviation contentdash executive techdash trafficdash visdash
For saved custom reports, the value is the ID of the custom report. To find the ID: 1. View the profile that contains the custom report. 2. Click the Custom tab. The Managing Reports page opens. 3. View the HTML source code for this screen and then search for the list of HTML <option> tags. An <option> tag for the saved custom report should option> option> appear in the list. For example:
434
In this example, the ID is custom003. The reports are included in the email message in the order in which they are listed in the <summaries> element. summaries> Use the child element <recipients> to specify the recipients of the recipients> reports. The <recipients> element has no attributes and no value. Use recipients> the child element <member> to specify each recipient. (See the member> <member> element.) The value of the <member> element is an email member> member> address.
Example
<emailtasks> <emailtask exclude="false" timeperiod="latest" format="html" subject="New Reports" name="Latest Monthly Reports" from="bob@unica.com"> Description of reports. <summaries> <summary>date</summary> <summary>file</summary> <summary>techdash</summary> <summary>custom003</summary> </summaries> <recipients> <member>abc@unica.com</member> </recipients> </emailtask> </emailtasks>
N26C0001
entity
The <entity> element specifies the database table that contains the sampled element. entity> The <entity> element has no attributes and no child elements. The value of the element entity> is the name of the database table. Currently, Visitor is the only supported sampling entity.
Example
<entity>Visitor</entity>
N26D0001
excludedagents
The <excludedagents> element contains a list of user agents you do not want included excludedagents> in the traffic analysis. This list appears on the Excluded Agents page. If the <excludedagents> element is missing, traffic from all user agents will be included in the excludedagents> analysis. The <excludedagents> element has no attributes and no value. Use the child excludedagents> element <member> to specify the user agents. The value of the <member> element is member> member> the text that determines which user agents are excluded.
Version 8.2.1 435
Example
<excludedagents> <member method="starts_with">Microsoft-WebDAVMiniRedir</member> </excludedagents>
N26E0001
excludedhosts
The <excludedhosts> element contains a list of hosts that you do not want to include in excludedhosts> the traffic analysis. This list appears on the Excluded Hosts page. If the <excludedhosts> element is missing, traffic from all hosts will be included in the excludedhosts> analysis. The <excludedhosts> element has no attributes and no value. Use the child element excludedhosts> <member> to specify the hosts. The value of the <member> element is the text that member> member> determines which hosts are excluded.
Example
<excludedhosts> <member method="ends_with">unica.com</member> </excludedhosts>
N26F0001
excludedpages
The <excludedpages> element contains a list of pages you do not want included in the excludedpages> traffic analysis. This list appears on the Excluded Pages page. If the <excludedpages> excludedpages> element is missing, traffic to all pages will be included in the analysis. The <excludedpages> element has no attributes and no value. Use the child element excludedpages> <member> to specify the pages. The value of the <member> element is the text that member> member> determines which pages are excluded.
Example
<excludedpages> <member method="ends_with">.gif</member> <member method="ends_with">.GIF</member> <member method="ends_with">.jpg</member> <member method="ends_with">.JPG</member> <member method="ends_with">.class</member> </excludedpages>
N2700001
436
excludedparametervalues
The <excludedparametervalues> element contains a list of parameter values. This list excludedparametervalues> appears on the Excluded Parameter Values page. If the <excludedparametervalues> excludedparametervalues> element is missing, all parameter values will be included in the analysis. The <excludedparametervalues> element has no attributes and no value. Use the child excludedparametervalues> element <member> to specify the excluded parameter value rules. The value of each member> <member> element is the text that determines which parameter values are excluded. member>
Example
<excludedparametervalues> <member type="param1" method="equals">images</member> <member type="param2" method="equals">base</member> </excludedparametervalues>
N2710001
excludedusers
The <excludedusers> element contains a list of users that you do not want to include in excludedusers> the traffic analysis. This list appears on the Excluded Users page. If the <excludedusers> element is missing, traffic from all users will be included in the excludedusers> analysis. The <excludedusers> element has no attributes and no value. Use the child element excludedusers> <member> to specify the users. The value of the <member> element is the text that member> member> determines which users are excluded.
Example
<excludedusers> <member method="equals">Bob</member> </excludedusers>
N2720001
filtergroups
The <filtergroups> element contains a list of filter groups. This list appears on the Filter filtergroups> Groups page. If the <filtergroups> element is missing, no filter groups will be available in filtergroups> the profile. The <filtergroups> element has no attributes and no value. Use the child element filtergroups> <filtergroup> to specify the filter groups. The <filtergroup> element has two attributes. filtergroup> filtergroup>
Attribute name Corresponding option Name of filter group Possible values Any alphanumeric characters Default
Version 8.2.1
437
20 - NetInsight Configuration Files Attribute filters Corresponding option Filters that belong to filter group Possible values Filter string for filters you entered for this group Default
The value of the <filtergroup> element is the title of the filter group. filtergroup>
Example
<filtergroups> <filtergroup name="test" filters="brow_0=Netscape&_brow_0=0&_browtype_0=1"> Test Group </filtergroup> </filtergroups>
N2730001
filterinstances
The <filterinstances> element contains all the filters being applied to the element that filterinstances> contains the <filterinstances> element. The <filterinstances> element must be contained filterinstances> filterinstances> by a <dimension> or <metric> element or by a <filter>, <visitorprofile>, or <emailalert> dimension> metric> filter> visitorprofile> emailalert> element in a configuration file. Each <dimension>, <metric>, <filter>, <visitorprofile>, or dimension> metric> filter> visitorprofile> <emailalert> element can contain only one <filterinstances> element. The emailalert> filterinstances> <filterinstances> element has no value and no attributes. filterinstances> Use the child element <filterinstance> to define each filter that is being applied to the filterinstance> dimension, metric, or visitor profile. There are ten types of filters: string, group, numeric, list, range, date, path, retail action, visit type, and filter group. The attributes of the <filterinstance> element vary depending on the type of filter being defined. filterinstance>
string filters
The <filterinstance> element used to define a string filter has three attributes. filterinstance>
Attribute type Definition Type of filter being definedmust match the name attribute of a <dimension> element To evaluate dimension or metric values against the filterinstance value Possible values Any alphanumeric characters Default
comparison
equals
negate*
false
438
* This attribute is optional. The value of the <filterinstance> element is the string value of the filter. The filterinstance> <filterinstance> element for a string filter has no child elements. filterinstance>
Example
<filterinstance type="browser" comparison="equals" negate="true"> Microsoft </filterinstance>
numeric filters
The <filterinstance> element used to define a numeric filter has one attribute. filterinstance>
Attribute type Definition Type of filter being definedmust match the name attribute of a <dimension> element Possible values Any alphanumeric characters Default
The value of the <filterinstance> element is the numeric value. The <filterinstance> filterinstance> filterinstance> element for a numeric filter has no child elements.
Example
<filterinstance type="cost">7</filterinstance>
list filters
List filters store multiple numeric values. The <filterinstance> element used to define a filterinstance> list filter has one attribute.
Attribute type Definition Possible values Default
Type of filter being defi- Any alphanumeric charnedmust match the acters name attribute of a <dimension> element of filtertype list
The <filterinstance> element has no value. Use the child element <values> to specify filterinstance> values> the numeric values in the list. The <values> element has no attributes and no value. values> Use the child element <value> to specify each numeric value. value> The <value> element has no attributes and no child element. The value of a <value> value> value> element is a numeric value.
Version 8.2.1
439
Example
<filterinstance type="dayofweek"> <values> <value>1</target> <value>2</target> <value>5</target> </values> </filterinstance>
range filters
Range filters define a numeric range. The <filterinstance> element used to define a filterinstance> range filter has one attribute.
Attribute type Definition Possible values Default
Type of filter being defi- Any alphanumeric charnedmust match the acters name attribute of a <dimension> element of filtertype range
The <filterinstance> element has no value. Use the child element <range> to specify the filterinstance> range> numeric range. The <range> element has no attributes and no value. Use the child range> elements <start> and <end> to specify the start and end of the range. start> end> The <start> element has no attributes and no child elements. The value of the <start> start> start> element is the start value of the range. The <end> element has no attributes and no child elements. The value of the <end> end> end> element is the end value of the range.
Example
<filterinstance type="numviews"> <range> <start>1</start> <end>4</end> </range> </filterinstance>
date filters
The <filterinstance> element used to define a date filter has two attributes. filterinstance>
Attribute type Definition Type of filter being definedmust match the name attribute of a <dimension> element Possible values Any alphanumeric characters Default
440
Web.cfg : Global Profile Configuration File Attribute comparison Definition To evaluate dimension or metric values against the filterinstance value Possible values equals, between Default equals
If the <filterinstance> element has a comparison attribute of type equals, the value of filterinstance> the element is the value used in the comparison. This value can be either a specific date in the format YYYY-MM-DD or one of two keywords (today, yesterday). If the <filterinstance> element has a comparison attribute of type between, the element filterinstance> will have no value. Use the child element <range> or <values> to specify the values to range> values> use in the comparison. The <range> element has no attributes and no value. Use the child elements <start> range> start> and <end> to specify the start and end dates of the range. end> The <start> element has no attributes and no child element. The value of the element is start> the start date of the range, entered in the format YYYY-MM-DD. The <end> element has no attributes and no child element. The value of the element is end> the end date of the range, entered in the format YYYY-MM-DD. The <values> element has no attributes and no value. Use the child element <duration> values> duration> to specify the date duration to use in the comparison. The <duration> element has two duration> attributes.
Attribute type Definition Type of date duration Possible values days, weeks, months, quarters, years Default
direction
The value of the <duration> element is the number of the specified date duration units duration> defining the date range.
Example
<filterinstance type="date" comparison="equals">yesterday</filterinstance> <filterinstance type="date" comparison="equals">1997-04-01</filterinstance> <filterinstance type="date" comparison="between"> <range> <start>2001-01-01</start> <end>2001-02-02</end> </range> </filterinstance> <filterinstance type="date" comparison="between"> <values> <duration type="week" direction="previous">2</duration> </values> </filterinstance>
Version 8.2.1
441
path filters
The <filterinstance> element that defines a path filter has three attributes. filterinstance>
Attribute type Definition Type of filter being definedmust match the name attribute of a <dimension> element To evaluate dimension or metric values against the filterinstance value Whether to negate the comparison Possible values Any alphanumeric characters Default
comparison
negate*
* This attribute is option. The <filterinstance> element has no value. Use the child element <values> to specify filterinstance> values> the pages of the path filter. The <values> element has no attributes and no value. Use values> the child element <value> to specify each page of the path filter. value> The <value> element has no attributes and no child elements. The value of the <value> value> value> element is a path. The value of the <duration> element is the number of the specified date duration units duration> defining the date range.
Example
<filterinstance type="path" comparison="starts_with" negate="true"> <values> <value>/support/NTR/faq.html</value> <value>/products/NTR/</value> </values> </filterinstance>
The <filterinstance> element has no value. Use the child element <values> to specify filterinstance> values> the list of retail actions. The <values> element has no attributes and no value. Use the values> child element <value> to specify each retail action. value>
442 Unica NetInsight - Administrator's Guide
The <value> element has no attributes and no child element. The value of a <value> value> value> element is a numeric value.
Value 1 2 3 4 5 Definition Abandoned Added Purchased Removed Viewed
Example
<filterinstance type="actiontype"> <values> <value>4</value> </values> </filterinstance>
The <filterinstance> element has no value. Use the child element <values> to specify filterinstance> values> the visit type. The <values> element has no attributes and no value. Use the child values> element <value> to specify the numeric value that corresponds to the type of visit. value> The <value> element has no attributes and no child element. The value of a <value> value> value> element is a numeric value.
Value 1 2 Definition New Repeat
Example
<filterinstance type="visittype"> <values> <value>2</value> Version 8.2.1 443
filter groups
A filter group is a list of multiple filters that are applied together. The <filterinstance> filterinstance> element that specifies a filter group has one attribute.
Attribute type Definition Type of filter being defined Possible values group Default
The <filterinstance> element that specifies a filter group has no child elements. The filterinstance> value of the <filterinstance> element is the name of the filter group. (Filter groups are filterinstance> defined in the profile's configuration file.)
Example
<filterinstance type="group"> _errorgroup </filterinstance>
N2740001
filterlists
The <filterlists> element contains a list of filter list definitions. The list appears on the filterlists> Filter Lists option page. This element has no attributes and no value. Use the <filterlist> filterlist> element to define each filter list. This element has two attributes.
Attribute name Corresponding option Title of filter list Possible values Any character string less than 120 characters Any character string of less than 30 characters that starts with a letter, uses only alphanumeric characters, hyphens, or underscores, and does not match the name of a subdirector in the profile's HTML directory Default
id
The <filterlist> element has no value. Use the child element <group> to specify each filterlist> group> folder in the list. The <group> element has one attribute. group>
444
Web.cfg : Global Profile Configuration File Attribute name* Corresponding option Title of group Possible values Any character string less than 120 characters Default
* Unica NetInsight will create an ID for the group by replacing any spaces and nonalphanumeric characters in the name with underscores. Each group's ID must be unique within the filter list. The <group> element has no value. Use the child element <filter> to specify each filter group> filter> in the group. The <filter> element has two possible attributes. filter>
Attribute name Corresponding option Filter title Possible values Any character string less than 120 characters Any filter type Default
target**
Filter source
* Unica NetInsight will create an ID for the filter by replacing any spaces and nonalphanumeric characters in the name with underscores. Each filter's ID must be unique within the filter list. ** This attribute should only be used if the <filter> element does not contain a filter> <filterinstances> element. filterinstances> The <filter> element has no value. If the end user is to be prompted for the specific filter filter> value when the filter is applied, the <filter> element should have no child elements. If filter> the specific filter value is to be predefined in the filter list, use the child element <filterinstances> to specify the value. For details on the <filterinstances> element, see filterinstances> filterinstances> the document Unica NetInsight Filter XML.
Example
<filterlists> <filterlist name="My Filters" id="flistname"> <group name="Content Filters"> <filter name="Document Downloads"> <filterinstances> <filterinstance type="group">_Documents</filterinstance> </filterinstances> </filter> <filter name="File" target="file"/> </group> </filterlist> </filterlists>
N2750001
Version 8.2.1
445
ftpdebug
The <ftpdebug/> element enables the logging of debug information when you use FTP ftpdebug/> to access your log files. If the element is present, debug logging is enabled. If it is absent, debug logging is not enabled. This element has no attributes, no child elements, and no value. Do not modify this element without contacting technical support.
Example
<ftpdebug/>
N2760001
hidelinks
The <hidelinks> element prevents the report entries for files from being hyperlinks to the hidelinks> actual files. Normally, when reports reference a specific file, that reference is a hyperlink to the file. For example, you can click on any file listed in the File Summary to download the actual file. The <hidelinks> element prevents Unica NetInsight Unica NetInsight from hidelinks> creating the hyperlinks. If the element is absent (the default), the hyperlinks are created. The <hidelinks> element has no attributes, no child elements, and no value. hidelinks>
Example
<hidelinks/>
N2770001
hostgroups
The <hostgroups> element contains a list of host groups, each of which can contain hostgroups> multiple hosts. The names of the host groups will appear in Unica NetInsight reports. This list appears on the Host Groups page. The <hostgroups> element has no attributes hostgroups> and no value. Each host group is specified using the child element <hostgroup>. The hostgroup> <hostgroups> element has three attributes and no value. hostgroups>
Attribute domain Corresponding option Domain of host group Possible values Any alphanumeric characters Any alphanumeric characters true, false Default
name
sessionize
Use the child element <member> to specify the individual members of each host group. member> (See the <member> element.) The value of the <member> entry is a domain name. member> member>
446
Example
<hostgroups> <hostgroup domain="Online Services" name="America Online" sessionize="true"> <member method="ends_with">.aol.com</member> </hostgroup> <hostgroup domain="Online Services" name="CompuServe" sessionize="true"> <member method="ends_with">.compuserve.com</member> </hostgroup> </hostgroups>
N2780001
hostlookup
The <hostlookup> element sets the Host lookup URL option on the Lookup Scripts hostlookup> page. The value of the element is the script to execute when a user clicks a host in the Host Summary If the element is missing, the option will be blank. This element has no Summary. attributes and no child elements.
Example
<hostlookup> http://host.domainname.com/scripts/weblookup.exe?host= </hostlookup>
N2790001
ignoredfields
The <ignoredfields> element contains a list of fields whose values Unica NetInsight ignoredfields> should not store in the database. Do not modify this element without contacting technical support. The <ignoredfields> element has no attributes and no value. Each ignoredfields> individual field is specified using the child element <ignoredfield>. The <ignoredfield> ignoredfield> ignoredfield> element has no attributes and no child elements. Its value is the name of the field that should be ignored. There are two fields that can be ignored in FTP server profiles.
Optional Field Browser BrowserBreakdown Cookie Domain Keywords PageBreakdown Version 8.2.1 Value When Disabled Unknown Unknown None Unresolved KeywordsID 0 PageBrkdwnID 0 447
20 - NetInsight Configuration Files Optional Field Platform Referrer ReferrerBreakdown User Value When Disabled Unknown None None UserID 0
Example
<ignoredfields> <ignoredfield>Browser</ignoredfield> </ignoredfields>
N27A0001
includedagents
The <includedagents> element contains a list of the user agents you want included in includedagents> the traffic analysis. This list appears on the Included Agents page. Traffic from user agents not on this list will not be analyzed. If the <includedagents> element is missing, includedagents> traffic from all user agents will be included. The <includedagents> element has no includedagents> attributes and no value. Use the child element <member> to specify the hosts. The member> value of the <member> element is the text that determines which hosts are included. member>
Example
<includedagents> <member method="starts_with"> Microsoft-WebDAVMiniRedir </member> </includedagents>
N27B0001
includedhosts
The <includedhosts> element contains a list of the hosts you want included in the traffic includedhosts> analysis. This list appears on the Included Hosts page. Traffic from hosts not on this list will not be analyzed. If the <includedhosts> element is missing, traffic from all hosts will includedhosts> be included. The <includedhosts> element has no attributes and no value. Use the child includedhosts> element <member> to specify the hosts. The value of the <member> element is the text member> member> that determines which hosts are included.
Example
<includedhosts> <member method="ends_with">.edu</member> 448 Unica NetInsight - Administrator's Guide
includedpages
The <includedpages> element contains a list of the pages you want included in the includedpages> traffic analysis. This list appears on the Included Pages page. Traffic to pages not on this list will not be analyzed. If the <includedpages> element is missing, traffic from all includedpages> pages will be included in the analysis. The <includedpages> element has no attributes includedpages> and no value. Use the child element <member> to specify the pages. The value of the member> <member> element is the text that determines which pages are included. member>
Example
<includedpages> <member method="contains">NetInsight</member> </includedpages>
N27D0001
includedparametervalues
The <includedparametervalues> element contains a list of included parameter values. includedparametervalues> This list appears on the Included Parameter Values page. If the <includedparametervalues> element is missing, all parameter values will be included in includedparametervalues> the analysis. The <includedparametervalues> element has no attributes and no value. includedparametervalues> Use the child element <member> to specify the included parameter value rules. The member> value of each <member> element is the text that determines which parameter values member> are included.
Example
<includedparametervalues> <member type="param1" method="equals">graphs</member> <member type="param2" method="equals">bars</member> </includedparametervalues>
N27E0001
includedusers
The <includedusers> element contains a list of the users you want included in the traffic includedusers> analysis. This list appears on the Included Users page. Traffic from users not on this list will not be analyzed. If the <includedusers> element is missing, traffic from all users will includedusers> be included in the analysis. The <includedusers> element has no attributes and no includedusers> value. Use the child element <member> to specify the users. The value of the member> <member> element is the text that determines which users are included. member>
Version 8.2.1
449
Example
<includedusers> <member method="equals">jsmith</member> <member method="equals">bjones</member> </includedusers>
N27F0001
keywordrules
The <keywordrules> element contains a list of the keyword parsing rules for the profile. keywordrules> This list appears on the Keywords page. The <keywordrules> element has no attributes keywordrules> and no value. Each keyword parsing rule is specified using the child element <keywordrule>. The <keywordrule> element has no value and two attributes. keywordrule> keywordrule>
Attribute name Corresponding option Name of keyword rule Possible values Any alphanumeric characters page, querystring querystring Default
type
Type of rule
The <keywordrule> element contains the child elements <includedsites>, keywordrule> includedsites> <excludedurls>, and <parameters>. excludedurls> parameters> The <includedsites> element contains the list of sites that should be searched using includedsites> the keyword parsing rule. This list appears on the Only sites to be searched using the keyword rule page. The <includedsites> element has no attributes and no value. includedsites> Use the child element <member> to specify each site. The value of the <member> member> member> element is the text that determines which sites are included. The <excludedurls> element contains the list of URLs within the included sites that excludedurls> you do not want to be searched using the keyword parsing rule. This list appears on the URLs that will not be searched using the keyword rule page. The <excludedurls> element has no attributes and no value. Use the child element excludedurls> <member> to specify each excluded URL. The value of the <member> element is member> member> the text that determines which URLs are excluded. The <parameters> element contains the list of parameters that belong to this parameters> keyword rule. This list appears on the Parameters that belong to the keyword rule page. The <parameters> element has no attributes and no value. Use the child parameters> element <member> to specify each parameter. The <member> element will have no member> member> attributes when it is contained in the <parameters> element. The value of the parameters> <member>element is the parameter name. member>
Example
<keywordrules> <keywordrule name="A9" type="page"> <includedreferrers> <member method="equals">A9</member> </includedreferrers> 450 Unica NetInsight - Administrator's Guide
Web.cfg : Global Profile Configuration File </keywordrule> <keywordrule name="Google" type="querystring"> <includedsites> <member method="equals">Yahoo</member> </includedsites> <excludedurls> <member method="contains">/url?</member> <member method="contains">images.yahoo.</member> </excludedurls> <parameters> <member>q</member> <member>query</member> </parameters> </keywordrule> </keywordrules>
N2800001
levels
The <levels> element contains a list of each sampling level specified for the profile. The levels> <levels> element has no attributes and no value. Use the child element <level> to levels> level> specify each level. The first <level> element specifies the Full reporting mode sample level> level. The second <level> element specifies the Sample reporting mode sample level. level> The <levels> element must be contained by the <sampling> element. levels> sampling> The <level> element specifies a sampling level. The <level> element has no attributes level> level> and no child element. The value of the <level> element is the sampling percentage. level>
Example
<levels> <level>100.000000</level> <level>0.050000</level> <levels>
N2810001
linklength
The <linklength> element sets the Link display length option on the Links options page. linklength> The possible values are numbers from 10 through 100 or Unlimited (represented in the configuration file as a 0). If the element is missing, Unica NetInsight uses the default, which is 41. This element has no attributes and no child elements.
Example
<linklength>25</linklength>
N2820001
Version 8.2.1
451
locale
The <locale> element customizes the profile for your locale. If the element is missing, locale> Unica NetInsight uses the defaults. This element has seven possible attributes. Each attribute corresponds to an option on the Locale page.
Attribute timeformat dateformat charset Corresponding option Display time as Display date as Character set Possible values 12hr, 24hr mdy, dmy, ymd latin1, latin2, sjis, big5, gb2312, euckr, user, UTF-8 sunday, monday saturday, friday Default 12hr mdy latin1
sunday saturday
Two-character language en identifier Generic, Dollar, Pound, Euro, Yen mdy, dmy, ymd Dollar
currency
Currency
altdate*
mdy
* The altdate attribute applies only to Microsoft IIS log files in the IIS Standard/Extended log file format. This element has no child elements and no value.
Example
<locale timeformat="12hr" dateformat="mdy" altdate="mdy" charset="latin1" weekbegins="Sunday" weekendbegins="saturday" language="en"/>
N2830001
localkeywords
The <localkeywords> element contains a list of pages on your site that allow users to localkeywords> enter keywords. The list appears on the Local Keywords page. If the <localkeywords> localkeywords> element is missing, Unica NetInsight does not generate a report of the keywords used on your site. The <localkeywords> element has one optional attribute. localkeywords>
452
Web.cfg : Global Profile Configuration File Attribute parameter Corresponding option Local keyword parameter Possible values Any parameter that contains search words Default
Example
<localkeywords> <member method="ends_with">search.cgi</member> </localkeywords>
N2840001
logs
The <logs> element contains a list of the log files you want to analyze. This list appears logs> on the Log Files page. The <logs> element has no attributes and no value. logs> Use the child element <logfile> to specify the full path of each log file. The <logfile> logfile> logfile> element has one attribute.
Attribute format Corresponding option Format of log file(s) Possible values Default
auto, netscape, ncsa, auto w3c, iis, msproxy, website, gauntlet, ibm, raptor, openmarket, wuftpd, ncftpd, cerfnet, squid, sidewinder, watchguard, real, (User defined valueCustom Log Formats)
Example
<logs> <logfile format="auto">/logs/access.log</logfile> <logfile format="auto">/logs/old/access.*</logfile> <logfile format="auto"> ftp://ftp.unica.com/logs/access.log </logfile> </logs>
N2850001
Version 8.2.1
453
maildebug
The <maildebug> element logs the SMTP conversation between Unica NetInsight and maildebug> the mail server when you email reports through the Email icon or by executing an email task. If this element is present in the profile configuration file, the conversation and other relevant information is logged in Unica NetInsight /data/short_name/maildebug.log, where Unica NetInsight is the Unica NetInsight program directory, and short_name is the name that appears in parentheses in the Available profiles list in the Profile Manager. This element has no attributes, no child elements, and no value. If this element is absent, email debug logging is not enabled. Do not modify this element without contacting technical support. If you use the email command-line option to execute multiple email tasks, only the last email task will be logged in maildebug.log when this element is present in the profile configuration file.
Example
<maildebug/>
N2860001
maxpathlength
The <maxpathlength> element sets the Maximum length of path option on the General maxpathlength> options page. The possible values are numbers 2 through 10. If the element is missing, Unica NetInsight uses the default value, which is 5. This element has no attributes and no child elements.
Example
<maxpathlength>5</maxpathlength>
N2870001
member
The <member> element specifies an item in a list. This element must be included inside member> a container element. The <member> element has one attribute. member>
Attribute method Corresponding option Possible values Default equals
How you determine if an equals, starts_with, item should be included ends_with, contains, in the list match_pattern*
454
metriclists
The <metriclists> element contains a list of metric list definitions. The list appears on the metriclists> Metric Lists options page. This element has no attributes and no value. Use the <metriclist> element to define each metric list. The <metriclist> element has two metriclist> metriclist> attributes.
Attribute name Corresponding option Title of metric list Possible values Any character string less than 120 characters Any character string of less than 30 characters that starts with a letter, uses only alphanumeric characters, hyphens, or underscores, and does not match the name of a subdirectory in the profile's HTML directory Default
id
The <metriclist> element has no value. Use the child element <group> to specify each metriclist> group> group in the list. The <group> element has one attribute. group>
Attribute name* Corresponding option Title of group Possible values Any character string less than 120 characters Default
* Unica NetInsight creates an ID for the group by replacing any spaces and nonalphanumeric characters in the name with underscores. Each group's ID must be unique within the metric list. The <group> element has no value. Use the child element <metric> to specify each group> metric> metric in the group. The <metric> element has two attributes. metric>
Attribute name* Corresponding option Metric title Possible values Any character string less than 120 characters Any metric key Default
target
Metric source
* Unica NetInsight creates an ID for the metric by replacing any spaces and nonalphanumeric characters in the name with underscores. Each metric's ID must be unique within the metric list.
Version 8.2.1
455
Example
<metriclists> <metriclist name="My Metric List" id="mylist"> <group name="Traffic Metrics"> <metric name="Number of Sessions" target="sessions"/> </group> </metriclist> </metriclists>
N2890001
metricsfile
The <metricsfile> element specifies a metrics file to use with this profile. This element metricsfile> has no attributes and no child elements. The value of the element is the filename of the metrics file to be used. The file must be located in the Unica NetInsight/data/ directory. If this element is missing, Unica NetInsight uses the default metrics file for the profile type.
Example
<metricsfile>mymetricsfile.xml</metricsfile>
N28A0001
module
The <module> element defines an external module to use in this profile. This element module> must be contained by the <modules> element. The <module> element has the following modules> module> attributes:
Attribute Description/Correspondi Possible values ng Option A unique, case-sensitive psi text string identifying a particular implementation of the module type Enable import check box Enable reporting check box true, false false Default
name
importenabled
reportingenabled
true, false
false
The <module> element has no value. Use the <connection> child element to specify module> connection> connection information for the module. Use the <retrievebatchsize> and retrievebatchsize> <writebatchsize> child elements to control batch sizes for this module. writebatchsize>
456
Example
<module name="psi" importenabled="true" reportingenabled="true">
<connection>
<url>http://www.paidsearchintegrationserver.com</url>
<user>Unica</user>
<password>encryptedpassword</password>
</connection>
<retrievebatchsize>10000</retrievebatchsize>
<writebatchsize>50000</writebatchsize>
</module>
N28B0001
modules
The <modules> element is a container element for external modules that are used in modules> this profile. The <modules> element has no attributes and no value. Use the child modules> element <module> to specify each module. module>
Example
<modules>
<connection>
<url>http://www.paidsearchintegrationserver.com</url>
<user>Unica</user>
<password>encryptedpassword</password>
Version 8.2.1
457
<retrievebatchsize>10000</retrievebatchsize>
<writebatchsize>50000</writebatchsize>
</module>
</modules>
N28C0001
nodefaultautoupdate
The <nodefaultautoupdate/> element disables the Automatically update report option on nodefaultautoupdate/> the Saving the Report options page for a custom report. If this element is present, the Automatically update report option is not selected for any new custom reports. If this element is absent, the option is selected for any new custom reports. This element has no attributes, no child elements, and no value. This element has been replaced with the <nodefaultautoupdatefull/> and nodefaultautoupdatefull/> <nodefaultautoupdatesample/> elements in new profiles. nodefaultautoupdatesample/>
Example
<nodefaultautoupdate/>
N28D0001
nodefaultautoupdatefull
The <nodefaultautoupdatefull/> element disables the Automatically update full report nodefaultautoupdatefull/> option on the Saving the Report options page for a custom report. If this element is present, the Automatically update full report option is not selected for any new custom reports. If this element is absent, the option is selected for any new custom reports. This element has no attributes, no child elements, and no value.
Example
<nodefaultautoupdatefull/>
N28E0001
458
nodefaultautoupdatesample
The <nodefaultautoupdatesample/> element disables the Automatically update sample nodefaultautoupdatesample/> report option on the Saving the Report options page for a custom report. If this element is present, the Automatically update sample report option is not selected for any new custom reports. If this element is absent, the option is selected for any new custom reports. This element has no attributes, no child elements, and no value.
Example
<nodefaultautoupdatesample/>
N28F0001
noimportreindex
The <noimportreindex> element disables the dropping and recreating of database noimportreindex> indexes during import. If you are using Unica NetInsight as an ETL tool, you should consider using this element. If the element is absent (which it is by default), the indexes are dropped and recreated during import. This element has no attributes, no child elements, and no value. The <noimportreindex> element will not prevent reindexing if the Misc table says noimportreindex> reindexing needs to be done. This element does not apply to Unica NetInsight for SQLite.
Example
<noimportreindex/>
N2900001
nonreportabledimensions
The <nonreportabledimensions> element contains the list of non-reportable dimensions. nonreportabledimensions> (A non-reportable dimension will not appear on the Discovery Panel or in reports even if the log file data and profile options support it.) This list appears in the Available Dimensions list on the Reportable Dimensions page. The <nonreportabledimensions> element has no attributes and no value. Use the child nonreportabledimensions> element <nonreportabledimension> to specify each non-reportable dimension. The nonreportabledimension> <nonreportabledimension> element has no attributes and no child elements. The value nonreportabledimension> of the element is the dimension name.
Example
<nonreportabledimensions> <nonreportabledimension>content<nonreportabledimension> <nonreportabledimension>domain<nonreportabledimension> Version 8.2.1 459
notableanalysis
The <notableanalysis/> element disables periodic table analysis. If the element is notableanalysis/> absent (which it is by default), periodic table analysis is enabled. This element has no attributes, no child elements, and no value. This element applies only to Unica NetInsight for Oracle, MySQL, and DB2.
Example
<notableanalysis/>
N2920001
ntadtrack
The <ntadtrack> element sets the Full path of ntadtrack.cgi (or ntadtrack.exe option on ntadtrack> ntadtrack.exe) the Banner Ads page. If the element is missing, the option will be blank. This element has no attributes and no child elements.
Example
<ntadtrack>/cgi-bin/ntadtrack.exe</ntadtrack>
N2930001
ntdi
The <ntdi> element contains a list of data conduits. This list appears on the Data ntdi> Conduits page. If the <ntdi> element is missing, Unica NetInsight will not use data ntdi> conduits. The <ntdi> element has no attributes and no value. Use the child element ntdi> <plugin> to specify each plug-in. The <plugin> element has three attributes. plugin> plugin>
Attribute type Corresponding option Conduit tasks Possible values cookie, department, email, host, pagetitle, param_ param-name param-name, rwpage, rwparam_ param-name user, visitor e am-name, Default
conf
Full path to conduit con- Any path and filename fig Name of data conduit Any alphanumeric characters
name
460
The value of the <plugin> element is the plug-in library. The <plugin> element has no plugin> plugin> child elements.
Example
<ntdi> <plugin type="host" conf="ntdiodbc.conf" name="host info"> ntdiodbc.dll </plugin> <plugin type="visitor" conf="ntdiodbc.conf" name="visitor info"> ntdiodbc.dll </plugin> </ntdi>
N2940001
ntlinktrack
The <ntlinktrack> element sets the Full path of ntlinktrack.cgi (or ntlinktrack.exe option ntlinktrack> ntlinktrack.exe) on the Links page. If the element is missing, the option will be blank. This element has no attributes and no child elements.
Example
<ntlinktrack>/cgi-bin/ntlinktrack.exe</ntlinktrack>
N2950001
outdefext
The <outdefext> element specifies the output formatting extensions file to use with this outdefext> profile. The <outdefext> element has no attributes and no child elements. The value is outdefext> the full path and file name of the output formatting extensions file.
Example
<outdefext> C:\Program Files\NetInsight\OutputFiles\output1.xml </outdefext>
N2960001
parameters
The <parameters> element contains a list of parameters you want to track. This list parameters> appears on the Parameters page. The <parameters> element has no attributes and no parameters> value. Each parameter is specified using the child element <parameter>. The parameter> <parameter> element has ten attributes and no value. parameter>
Version 8.2.1
461
20 - NetInsight Configuration Files Attribute type coltitle Corresponding option Type of parameter Column title Possible values file, field, meta Any alphanumeric characters Any alphanumeric characters Default
grtitleasc
grtitledsc
Graph title (Descending) Any alphanumeric characters Parameter lookup URL Parameter Any URL Any alphanumeric characters true, false false
lookupurl parameter
displayonbr
name
store
associatewith
view, visit
view
The individual pages that you want Unica NetInsight to search for the parameters must be specified using the child element <member>. The value of the <member> member> member> element is the text that determines which pages should be searched.
Example
<parameters> <parameter type="file" coltitle="Product Code" grtitleasc="Most Popular Products" grtitledsc="Least Popular Products" lookupurl="http://host.domainname.com/scripts/weblookup.exe?parameter=" parameter="pc" displayonbr="true" name="ProductID" store="true" associatewith="view"> <member method="contains">catalog</member> </parameter> </parameters>
N2970001
462
password
The <password> element specifies a password. When the element is contained only by password> the overall container element for the file, it is used to set password protection for the profile. When it is contained by the <connection> element, it specifies the password connection> Unica NetInsight uses to connect to an external module. If the <password> element is password> missing, there is no password. When used to set the connection password, this element has no attributes. When used to set the profile protection options, the element has five possible attributes and you must include at least one attribute or the password has no effect.
Attribute options Corresponding option Protect all of the profile options Protect only the log file and password options Protect the Remove Data from Profile page Protect the updating of this profile Possible values true, false Default false
logoptions
true, false
false
remove
true, false
false
update
true, false
false
savecustom
false
This element has no child elements. The value of the element is the encrypted password.
Example
<password options="true" logoptions="true" remove="true" update="true" savecustom="true">encryptedpassword</password>
N2980001
platforms
The <platforms> element contains a list of the platform names that will appear in platforms> reports. This list appears on the Platforms page. The <platforms> element has no platforms> attributes and no value. Use the child element <platform> to specify each platform. The platform> <platform> element has two attributes and no value. platform>
Attribute appendversion Corresponding option Append the version number Possible values true, false Default false
Version 8.2.1
463
20 - NetInsight Configuration Files Attribute name Corresponding option Name of platform Possible values Any alphanumeric characters Default
Use the child element <member> to specify the individual members of each platform member> group. The value of the <member> element is the text that identifies a platform you member> want included in the group.
Example
<platforms> <platform name="Windows 95"> <member method="starts_with">Win95_</member> <member method="match_pattern">^WMP\ (.*os=Windows_95.*\)</member> <member method="match_pattern">^QTS \(.*os=Windows_95.*\)</member> </platform> <platform name="Windows Me"> <member method="starts_with">Win98_4.9</member> <member method="match_pattern">^WMP \(.*os=Windows_ME.*\)</member> <member method="match_pattern">^WMP \(.*os=Windows_98;osver=4\.9.*\)</member> <member method="match_pattern">^QTS \(.*os=Windows_Me.*\)</member> </platform> </platforms>
N2990001
precalcdates
The <precalcdates> element sets the report generation options for the profile. This precalcdates> element has six possible attributes. Each attribute corresponds with an option on the Report Generation options page. If an attribute is missing, reports for the corresponding date range is not pre-calculated. For the years, quarters, months, weeks, and days attributes, the value of the attribute is the number of the corresponding time frames for which reports will be pre-calculated.
Attribute all years months weeks days Corresponding option All Months Latest ___ Years Latest ___ Quarters Latest ___ Weeks Latest ___ Days Possible values true, false Any numeic value Any numeic value Any numeic value Any numeic value Default false
464
Example
<precalcdates all="false" quarters="1" months="3" days="2"/>
N29A0001
redirectscripts
The <redirectscripts> element contains a list of pages that you want to include in the redirectscripts> analysis even though they return a redirection code. This list appears on the Redirection Scripts page. If the <redirectscripts> element is missing, Unica NetInsight excludes all redirectscripts> hits resulting in an HTTP redirection status code codes 301 and 302. The <redirectscripts> element has no attributes and no value. Use the child element redirectscripts> <member> to specify the pages.The value of the <member> element is the text that member> member> determines which pages are included.
Example
<redirectscripts> <member method="equals">/cgi-bin/redirect.cgi</member> </redirectscripts>
N29B0001
referrergroups
The <referrergroups> element contains a list of referrer groups, each of which can referrergroups> contain multiple referrers. This list appears on the Referrer Groups page. The <referrergroups> element has no attributes and no value. Each referrer group is referrergroups> specified using the child element <referrergroup>. The <referrergroup> element has one referrergroup> referrergroup> attribute.
Attribute name Corresponding option Name of referrer group Possible values Any alphanumeric characters Default
Example
<referrergroups> <referrergroup name="AltaVista"> <member method="contains">altavista.</member> </referrergroup> <referrergroup name="AOL NetFind"> <member method="ends_with">netfind.aol.com</member> </referrergroup> </referrergroups>
N29C0001
Version 8.2.1
465
reportlists
The <reportlists> element contains a list of report list definitions. The list appears on the reportlists> Report Lists options page. This element has no attributes and no value. Use the <reportlist> element to define each report list. The <reportlist> element has two reportlist> reportlist> attributes.
Attribute name Corresponding option Title of report list Possible values Any character string less than 120 characters Any character string of less than 30 characters that starts with a letter, uses only alphanumeric characters, hyphens, or underscores, and does not match the name of a subdirectory in the profile's HTML directory. Default
id
The <reportlist> element has no value. Use the child element <folder> to specify each reportlist> folder> folder in the list. The <folder> element has one attribute. folder>
Attribute name* Corresponding option Title of folder Possible values Any character string less than 120 characters Default
* Unica NetInsight creates an ID for the folder by replacing any spaces and nonalphanumeric characters in the name with underscores. Each folder's ID must be unique within the report list. The <folder> element has no value. Use the child element <report> to specify each folder> report> report in the folder. The <report> element has two attributes. report>
Attribute name* Corresponding option Report title Possible values Any character string less than 120 characters Any report key Default
target
Report source
* Unica NetInsight creates an ID for the report by replacing any spaces and nonalphanumeric characters in the name with underscores. Each report's ID must be unique within the report list. The <report> element has no child elements and no value. report>
466
Example
<reportlists> <reportlist name="My Report List" id="mylist"> <folder name="Visitor Reports"> <report name="Host Summary" target="host"/> </folder> </reportlist> </reportlists>
N29D0001
resolvehosts
The <resolvehosts> element sets the Resolve host names option on the General resolvehosts> options page. If the element is present, the option is selected. If it is absent, the option is not selected. This element has no attributes, no child elements, and no value.
Example
<resolvehosts/>
N29B0001
referrergroups
The <referrergroups> element contains a list of referrer groups, each of which can referrergroups> contain multiple referrers. This list appears on the Referrer Groups page. The <referrergroups> element has no attributes and no value. Each referrer group is referrergroups> specified using the child element <referrergroup>. The <referrergroup> element has one referrergroup> referrergroup> attribute.
Attribute name Corresponding option Name of referrer group Possible values Any alphanumeric characters Default
Example
<referrergroups> <referrergroup name="AltaVista"> <member method="contains">altavista.</member> </referrergroup> <referrergroup name="AOL NetFind"> <member method="ends_with">netfind.aol.com</member> </referrergroup> </referrergroups>
N29E0001
Version 8.2.1
467
resolvetitles
The <resolvetitles> element sets the Resolve page titles option on the General options resolvetitles> page. If the element is present, the option is selected. If it is absent, the option is not selected. This element has no attributes, no child elements, and no value.
Example
<resolvetitles/>
N29F0001
retrievebatchsize
The <retrievebatchsize> element defines the number of rows Unica NetInsight requests retrievebatchsize> from the external module server at a time. This element must be contained by the <module> element. The <retrievebatchsize> element has no attributes and no child module> retrievebatchsize> elements. The value of the <retrievebatchsize> element is the number of rows. If this retrievebatchsize> element is missing, Unica NetInsight uses the default value, which is 10000.
Example
<retrievebatchsize>10000</retrievebatchsize>
N2A00001
roledefaults
The <roledefaults> element stores the list of role default views specified for the profile. roledefaults> This element has no attributes and no value. Specify each role default view using the child element <roledefault>. The <roledefault> element has one attribute. roledefault> roledefault>
Attribute view Corresponding option Default view Possible values Name of any view defined for the profile Default
Example
<roledefaults> <roledefault view="techview">techrole</roledefault> </roledefaults>
N2A10001
rows
The <rows> element is not currently supported. rows>
N2A20001
468
sampling
The <sampling> element is a container element for the sampling settings elements sampling> <entity>, <element>, <seed>, <rows>, and <levels>. The <sampling> element has no entity> element> seed> rows> levels> sampling> attributes and no value.
Example
<sampling> <entity>Visitor</entity> <element>VisitorID</element> <seed>0</seed> <rows>0</rows> <levels> <level>100.000000</level> <level>0.050000</level> </levels> </sampling>
N2A30001
schemafile
The <schemafile> element specifies the schema definition file to be used to create SQL schemafile> Server, Oracle, or DB2 database tables for this profile. This element has no attributes and no child elements. The value of the element is the filename of the schema definition file to be used. The file must be located in the Unica NetInsight/data/ directory. If this element is missing, Unica NetInsight uses the default schema definition file for the profile.
Example
<schemafile>myschema.xml</schemafile>
N2A40001
securityrealms
The <securityrealms> element contains a list of security realms that categorize pages securityrealms> on a Web site in order to resolve the titles of pages on Web servers that require authentication. This list appears on the Security Realms page. Use the child element <securityrealm> to specify each security realm. This element has securityrealm> three attributes.
Attribute name Corresponding option Realm name Possible values Any alphanumeric characters Any alphanumeric characters 469 Default
username
User name
Version 8.2.1
20 - NetInsight Configuration Files Attribute password Corresponding option Password Possible values Encrypted password Default
The <securityrealm> element has no value. Use the child element <member> to specify securityrealm> member> the individual pages that are part of the security realm. The value of each <member> member> element is the text that determines which pages belong to the security realm.
Example
<securityrealms> <securityrealm name="Realm1" username="Bob Smith" password="a1nc82"> <member method="contains">NetInsight</member> <member method="starts_with">/eval</member> </securityrealm> <securityrealm name="Realm2" username="Susan Wright" password="gn3x"> <member method="contains">Microsoft</member> <member method="ends_with">.net</member> <securityrealm> </securityrealms>
N2A50001
seed
The <seed> element specifies the sample seed value. The seed value is used by the seed> random number generator to produce a repeatable sequence of element IDs used to populate the sample tables. The <seed> element has no attributes and no child seed> elements. The value of the element is used as the seed. The <seed> element must be seed> contained by the <sampling> element. sampling>
Example
<seed>0</seed>
N2A60001
segment
The <segment> element contains the name of a campaign segment, which is the ad segment> variation or group within a campaign channel. The <segment> element must be segment> contained by the <channel> element. The <segment> element has no value and one channel> segment> attribute.
Attribute name Corresponding option Name of campaign segment Possible values Any alphanumeric characters Default
470
Each campaign segment has a unique identifier in entry pages affiliated with that segment. The individual entry pages associated with a campaign segment are specified using the child element <member>. The value of the <member> element is the text member> member> used to determine which entry pages are in the campaign segment.
Example
<campaigns> <campaign name="Offer"> <channel name="checkdomain" type="bannerad"> <segment name="Ad Segment 1"> <member method="equals">promo</member> </segment> <segment name="Ad Segment 2"> <member method="equals">demo</member> </segment> </channel> </campaign> </campaigns>
N2A70001
servers
The <servers> element contains a list of the clustered log files you want to analyze. (If servers> your log files are not clustered, do not use this element. Use the <logs> element logs> instead. You should not use the <servers> element and the <logs> element in the same servers> logs> configuration file.) This list appears on the Log Files page. The <servers> element has servers> one attribute.
Attribute type Corresponding option Log files are Possible values single Default single
The <servers> element has no value. The server that contains the log files is specified servers> using the child element <server>. The <server> element has one attribute. server> server>
Attribute name Corresponding option Name of server Possible values Any alphanumeric characters Default
The <server> element has no value. The full path of each log file is specified using the server> child element <logfile>. The <logfile> element has one attribute. logfile> logfile>
Version 8.2.1
471
20 - NetInsight Configuration Files Attribute format Corresponding option Format of log file(s) Possible values Default
auto, netscape, ncsa, auto w3c, iis, msproxy, website, gauntlet, ibm, raptor, openmarket, wuftpd, ncftpd, cerfnet, squid, sidewinder, watchguard, real, (User defined value Custom Log Formats)
Example
<servers type="single"> <server name="Server 1"> <logfile format="auto">/logs/server1/*.log</logfile> </server> <server name="Server 2"> <logfile format="auto">/logs/server2/*.log</logfile> </server> </servers>
N2A80001
sessionization
The <sessionization> element sets the sessionization methods on the Sessionization sessionization> page. The <sessionization> element has two attributes. sessionization>
Attribute parameter username Corresponding option Parameter value for Authenticated user name Possible values Any parameter name true, false false Default
For Web server profiles, Unica NetInsight will sessionize using whatever attributes are present. If the parameter or cookie attribute is not present, Unica NetInsight will not sessionize using parameters or cookies. The <sessionization> element has no child elements and no value. sessionization>
<sessionization parameter="SessionID" username="true"/>
Example
For Web server profiles:
<sessionization parameter="SessionID" optoutcookievalue="OPT_OUT" parameterforvisitor="true" 472 Unica NetInsight - Administrator's Guide
siteurl
The <siteurl> element sets the URL of the site being analyzed option on the General siteurl> options page. If the element is missing, the option will be blank. This element has no attributes and no child elements.
Example
<siteurl>Protocol://URL</siteurl>
N2AA0001
spiders
The <spiders> element contains a list of hosts and user agents that should be classified spiders> as robots and spiders. This list appears on the Robots/Spiders page. The <spiders> spiders> element has no attributes and no value. Each robot or spider is specified using the child element <spider>. The <spider> element has one attribute. spider> spider>
Attribute name Corresponding option Name of spider Possible values Any alphanumeric characters Default
The <spider> element has no value. The individual members of each spider or robot are spider> specified using the child element <member>. The <member> element uses both the member> member> method and type attributes inside the <spider> element. The type attribute has three spider> possible values: host, referrer, and useragent. The default value is host. The value of the <member> element is the text that determines which hosts and user agents should member> be included in the robot or spider.
Example
<spiders> <spider name="Acoon"> <member type="useragent" method="starts_with"> Acoon Robot </member> </spider> <spider name="Internap Performance Crawler"> <member type="referrer"method="equals"> http://www.internap.com/measurements/readme.html </member> </spider> </spiders>
N2AB0001
Version 8.2.1
473
summarysize
The <summarysize> element sets the Number of rows per summary option on the summarysize> General options page. The possible values are 5, 10, 15, 20, 25, 50, 75, or 100. If the element is missing, Unica NetInsight uses the default value, which is 10. This element has no attributes and no child elements.
Example
<summarysize>10</summarysize>
N2AC0001
tagimages
The <tagimages> element contains a list of page tag images. This list appears on the tagimages> Page Tagging page. This element has no value and one attribute.
Attribute type Corresponding option Page tags are Possible values off, augment, single, multiple*, hybrid** Default off
* Applies to the Used instead of log files to collect data for multiple sites page tagging option. ** Applies to the Used in addition to log files to collect data for multiple sites page tagging option. Use the child element <member> to specify the page tag images. The value of each member> <member> element is the text that determines the image that will be used to collect member> data from page tags.
Example
<tagimages type="hybrid"> <member method="equals">ntptnojs.gif</member> </tagimages>
N2AD0001
title
The <title> element sets the profile title option on the General options page. If the title> element is missing, the option is blank. This element has no attributes and no child elements.
Example
<title>Unica Corporation</title>
474
titlelength
The <titlelength> element sets the Page title display length option on the General titlelength> options page. The possible values are numbers from 10 through 100 or unlimited (represented in the configuration file as a 0). If the element is missing, the default, 41, is used. This element has no attributes and no child elements.
Example
<titlelength>50</titlelength>
N2AF0001
titles
The <titles> element contains a list of page title mappings. A page title mapping titles> specifies a page title for Unica NetInsight to use for a given page instead of the title that results from resolving the page title. This list appears on the Page Title Mappings page. If the <titles> element is missing, Unica NetInsight will use the resolved page titles for titles> the pages. The <titles> element has no attributes and now value. Each page title titles> mapping is specified using the child element <title>. The <title> element has one title> title> attribute.
Attribute Corresponding option Possible values Default
page
Page
The value of the <title> element is the page title that Unica NetInsight uses. title>
Example
<titles> <title page ="/Unica NetInsight/whitepapers/analyzing.html"> Analyzing Your Web Traffic </title> <title page ="/Unica NetInsight/whitepapers/parameters.html"> Using Parameter Summaries </title> </titles>
N2B00001
Version 8.2.1
475
unexcludedpages
The <unexcludedpages> element contains a list of pages from the excluded page types unexcludedpages> that should be included in the traffic analysis. For example, if you had previously excluded all .gif files, you could use the <unexcludedpages> element to include a unexcludedpages> specified .gif file in the analysis. This list appears on the Unexcluded Pages page. If the <unexcludedpages> element is missing, traffic from all pages of the types specified in unexcludedpages> the excluded pages list will be excluded. The <unexcludedpages> element has no attributes and no value. Use the child element unexcludedpages> <member> to specify the pages. The <member> element value is the text that identifies member> member> the pages to include.
Example
<unexcludedpages> <member method="equals">map.jpg</member> </unexcludedpages>
N2B10001
unresolvedtitles
The <unresolvedtitles> element contains a list of pages whose titles should not be unresolvedtitles> resolved. This list appears on the Unresolved Page Titles page. If the <unresolvedtitles> unresolvedtitles> element is missing, Unica NetInsight tries to resolve titles on all pages if the Resolve page titles check box is selected on the General options page. You should at least include executable files in your list, since Unica NetInsight should not attempt to resolve these page titles. The <unresolvedtitles> element has no attributes and no value. Use the child element unresolvedtitles> <member> to specify the pages.The value of the <member> element is the text that member> member> determines which pages should be included in the list.
Example
<unresolvedtitles> <member method="contains">/cgi-bin/</member> <member method="contains">/scripts/</member> <member method="ends_with">.cgi</member> <member method="ends_with">.exe</member> </unresolvedtitles>
N2B20001
url
The <url> element specifies the location of the external module. This element must be url> contained by a <connection> element. The <url> element has no attributes and no child connection> url> elements. The value of the <url> element is the URL for the external module. url>
476
Example
<url>http://www.paidsearchintegrationserver.com</url>
N2B30001
urlsearchrules
The <urlsearchrules> element contains a list of URL search and replace rules. This list urlsearchrules> appears on the URL Search and Replace page. The <urlsearchrules> element has no urlsearchrules> attributes and no value. Each URL search and replace rule is specified using the child element <urlsearchrule>. The <urlsearchrule> element has five attributes. urlsearchrule> urlsearchrule>
Attribute type global search Corresponding option Type of rule Replacement scope Search rule Possible values page, param_xyz * true, false** Any regular expression that describes the part of the URL you want to replace Any text you want to replace the text described by the search rule. To delete it, leave this attribute empty. Any alphanumeric characters Default page false
replace
Replacement value
name
Description
* In param_xyz, xyz is the parameter name. ** The value true corresponds to the option All matches and false corresponds to Only first match.The <urlsearchrule> element has no value. Use the child urlsearchrule> element <member> to specify the individual files that Unica NetInsight should scan member> for the search rule. The value of the <member> element is the text that identifies member> which files should be scanned.
Example
<urlsearchrules> <urlsearchrule type="page" global="false" search="\/(channel1)\.rm" replace="News" name="Rename news channel"> <member method="starts_with">/channel</member> </urlsearchrule> </urlsearchrules>K> Version 8.2.1 477
user
The <user> element specifies the user name Unica NetInsight uses to connect to the user> external module. This element must be contained by the <connections> element. The connections> <user> element has no attributes and no child elements. The value of the <user> user> user> element is the user name.
Example
<user>Unica</user>
N2B50001
userlookup
The <userlookup> element sets the User lookup URL option on the Lookup Scripts userlookup> page. If the element is missing, the option will be blank. This element has no attributes and no child elements.
Example
<userlookup> http://host.domainname.com/scripts/weblookup.exe?user= </userlookup>
N2B60001
variablesfile
The <variablesfile> element specifies a variables file to use with this profile. This variablesfile> element has no attributes and no child elements. The value of the element is the filename of the variables file to be used. The file must be located in theUnica NetInsight/data/directory. If this element is missing, Unica NetInsight uses the default variables file for the profile type.
Example
<variablesfile>myvariablesfile.xml</variablesfile>
N2B70001
viewlist
The <viewlist> element contains a list of views. The list appears on the Views options viewlist> page. This element has no attributes and no value. Specify each view using the child element <view>. The <view> element has two attributes. view> view>
478
Web.cfg : Global Profile Configuration File Attribute name Corresponding option Title of view Possible values Any unique character string less than 120 characters Any unique character string of less than 30 characters that starts with a letter, uses only alphanumeric characters, hyphens, or underscores, and does not match the name of a subdirectory in the profile's HTML directory Default
id*
* One view must be specified as the default view by having an ID value of _default. The <view> element has no value. Use the required child elements <timeperiod> and view> timeperiod> <reportlist> to specify the default calendar state and the list of reports for the view. Use reportlist> the optional child elements <dimensionlist>, <filterlist>, and <metriclist> to specify the dimensionlist> filterlist> metriclist> dimension, filter, and metric lists for the view. The <timeperiod> element sets the Time period option on the Views options page. This timeperiod> element has three attributes.
Attribute type Corresponding option Time period Possible values all, latestday, latestweek, latestmonth, latestquarter, latestyear, prevday, prevweek, prevmonth, prevquarter, prevyear, range Any date in the form YYYYMMDD Any date in the form YYYYMMDD Default all
start*
Dates from
end*
Dates to
* This attribute is only valid if the type attribute has the value range. The <timeperiod> element has no value and no child elements. timeperiod> The <reportlist> element has no attributes and no child elements. The value of the reportlist> <reportlist> element is the ID of a defined report list. For details on defining a report list, reportlist> see the <reportlists> element. reportlists>
Version 8.2.1
479
The <dimensionlist> element has no attributes and no child elements. The value of the dimensionlist> <dimensionlist> element is the ID of a defined dimension list. For details on defining a dimensionlist> dimension list, see the <dimensionlists> element. dimensionlists> The <filterlist> element has no attributes and no child elements. The value of the filterlist> <filterlist> element is the ID of a defined filter list. For details on defining a filter list, see filterlist> the <filterlists> element. filterlists> The <metriclist> element has no attributes and no child elements. The value of the metriclist> <metriclist> element is the ID of a defined metric list. For details on defining a metric list, metriclist> see the <metriclists> element. metriclists>
Example
<viewlist> <view name="Sales View" id="sales"> <reportlist>salesreports</reportlist> <dimensionlist>salesdimensions</dimensionlist> <filterlist>salesfilters</filterlist> <metriclist>salesmetrics</metriclist> <timeperiod type="latestmonth"/> </view> <viewlist>
N2B80001
virtual
The <virtual> element sets the Only process traffic to the configured site option on the virtual> Advanced options page. If the element is present, the option is selected. If it is absent, the option is not selected. This element has no attributes, no child elements, and no value.
Example
<virtual>
N2B90001
visitorlookup
The <visitorlookup> element sets the Visitor lookup URL option on the Lookup Scripts visitorlookup> page. If the element is missing, the option will be blank. This element has no attributes and no child elements.
Example
<visitorlookup> http://host.domainname.com/scripts/weblookup.exe?visitor= </visitorlookup>
N2BA0001
480
visitorprofiles
The <visitorprofiles> element contains a list of visitor groups. (You can sort visitors into visitorprofiles> groups based on any of a large number of filters.) This list appears on the Visitor Profiles page. The <visitorprofiles> element has no attributes and no value. Each visitor visitorprofiles> group is specified using the child element <visitorprofile>. The <visitorprofile> element visitorprofile> visitorprofile> has one attribute.
Attribute name Corresponding option Name of profile Possible values Any alphanumeric characters Default
Use the child element <filterinstances> to specify the filters that define the visitor profile. filterinstances> For details on the <filterinstances> element, see the document Unica NetInsight filterinstances> Dimension and Metric Filters." Even if you want to create a visitor profile that contains all visits, the <visitorprofile> visitorprofile> element must contain the <filterinstances> element. (The <filterinstances> element filterinstances> filterinstances> can then be empty.) If the <visitorprofile> element does not contain the visitorprofile> <filterinstances> element, the visitor profile will be ignored. filterinstances>
Example
<visitorprofiles> <visitorprofile name="Downloaded"> <filterinstances> <filterinstance type="page" comparison="ends_with"> .exe </filterinstance> </filterinstances> </visitorprofile> </visitorprofiles>
N2BB0001
visitthreshold
The <visitthreshold> element sets the Number of minutes between visits option on the visitthreshold> Sessionization page. The possible values are numbers from 1 through 999. If the element is missing, the default value of 30 is used. This element has no attributes and no child elements.
Example
<visitthreshold>40</visitthreshold>
N2BC0001
Version 8.2.1
481
writebatchsize
The <writebatchsize> element defines the number of rows of data from the external writebatchsize> module Unica NetInsight writes to the database at a time. This element must be contained by the <module> element. The <writebatchsize> element has no attributes module> writebatchsize> and no child elements. The value of the <writebatchsize> element is the number of writebatchsize> rows. If this element is missing, Unica NetInsight uses the default value, which is 50,000.
Example
<writebatchsize>50000</writebatchsize>
482