Creating Summary templates

This article gives information on how you can create your own template file which FunnelWeb Analyzer uses to create the summary page of your HTML format reports. This is quite a powerful feature, allowing you to fully customize the summary report to your specific needs. This template is located in different places depending on which version or mode of operation you are using. The default locations are as follows:

Version 4.5:
C://Program Files/Quest Software/Funnel Web (Enterprise) 4.5/summary_template.html

Version 5.0:

Web Mode:
C:/Program Files/Quest Software/Funnel Web (Enterprise) 5.0/Templates/Web/default_summary.html
Web Mode Compact Style template
C:/Program Files/Quest Software/Funnel Web (Enterprise) 5.0/Templates/Web/summary_template_compact.html

Streaming Mode:
C:\Program Files\Quest Software\Funnel Web (Enterprise) 5.0\Templates\Streaming\default_summary.html
Streaming Mode WebCast summary template
C:\Program Files\Quest Software\Funnel Web (Enterprise) 5.0\Templates\Streaming\default_webcast_summary.html

If you open any of the summary template files in a web browser or html editor, you will notice there are a large amount of commands in the file which generate links to reports. These commands could be grouped into the following types:

Group Commands	Commands that turn on groups of reports if they are created
Statistic Commands	Commands that turn on individual Statistics if they are created
Field Commands	Commands used to display specific report values are created
Link to Report Commands	Commands used to link to reports that are created
HTML controls	Performs status queries and defines how links and thumbnail picture links will appear
Top X Commands	Commands used for displaying stats on highest values such as Page with the Most hits
Lowest X Commands	Commands used for displaying stats on lowest values such as Page with the Least hits
Total X Commands	Command used to display total values such as Total Visitors on the Site
Basic Commands	Commands for displaying information on the product and various statistics
Look and Feel	Commands for controlling the look and feel such as colour and font commands
Streaming Media commands	Commands related to Streaming media mode of reporting

 

Following below are detailed desciptions of all these command types and how to use them

 

Group Commands

Back to Top

These commands essentially turn on groups of reports if they are created. For instance if a group of reports such as Advertising reports are not created, the links to Advertising reports will not be seen if enclosed between the #if groupON tag and the #endgroup tag. The following commands will act on if each group or reports if they are turned on in the FunnelWeb settings:

<!-- #if groupOn=GROUPNAME -->
<!-- #endgroup -->

The following commands will act on if each group that is actually reported

<!-- #if groupReported=GROUPNAME --><br>
<!-- #endgroup --><br>

For Example, the following shows how you might specify the Advertising group of Reports in the summary_template.html file code:

<!-- #if groupReported=ADVERTISING -->
<p>[$link3_campaigns]<br>
[$thumblink2_campaigns]<br>
<h2>Advertising Reports</h2>
[$LINK2_campaigns]
[$LINK2_advert]
[$LINK2_campaignshistory]
[$LINK2_adverthistory]
<!-- #endgroup -->

This Advertising group would appear in the summary report as follows if the group was reported on:

Advertising Reports

Campaigns
Impressions
Campaigns History
Impressions History

The GROUPNAME can be any of the following (without quotes). Each groupname specifies one of the Report groups created by FunnelWeb Analyzer

"Advertising"
"Clusters"
"Server"
"Demographic"
"Diagnostic"
"Marketing"
"Billing" (in version 5.0 only)
"Traffic"
"Referrals"
"Systems"
"Server"
"MultiMedia" (in version 5 web mode only. "Streaming Media" in 4.5 version)
"Clip Access Information" (in version 5.0 streaming mode only)
"Live Clip Access Information" (in version 5.0 streaming mode only)

 

Statistic Commands

Back to Top

These commands essentially turn on individual Statistics reports if they are created. These are basically the individual reports contained within a group such as Advertising.

The following commands will act on if each statistic if it is turned on in the settings:

<!-- #if statOn=STATNAME -->
<!-- #endstat -->

The following will act on if each statistic if it is actually reported:

<!-- #if statReported=STATNAME -->
<!-- #endstat -->

For Example, the following shows how you might specify the Advertising group of Reports if produced in the summary_template.html file code:

<!-- #if statReported=CAMPAIGNS -->
<p>[$link3_campaigns]<br>
[$thumblink2_campaigns]<br>
<h2>Advertising Campaigns</h2>
<!-- #endstat -->

This Advertising group would appear in the summary report as follows if the group was reported on:

Advertising Campaigns

Campaigns

The following is a list of REPORT stat names, these are also used for the if logic and also for a lot of commands that have an underscore _ in them:

Advertising Group	Report Name
CAMPAIGNS	Campaigns
CAMPAIGNSHISTORY	Campaigns History
ADVERT	Impressions
ADVERTHISTORY	Impressions History
Clusters Group
CLUSTERS	Load Balancing
CLUSTERSHISTORY	Load Balancing History
Server Group
PAGES	Pages
PAGESHISTORY	Pages History
PAGESFIRST	Entry Pages
PAGESFIRSTHISTORY	Entry Pages History
PAGESLAST	Exit Pages
PAGESLASTHISTORY	Exit Pages History
PAGESLEAST	Pages Least Visited
MEANPATH	Mean Path
FILETYPE	File Types
FILE	URL's
DOWNLOAD	Downloads
DOWNLOADHISTORY	Downloads History
TOPDIR	Top Level Directories
TOPDIRHISTORY	Top Level Directories History
KEYPAGEROUTE	Routes to Key Pages
KEYPAGEROUTEFROM	Routes From Key Pages
GROUPS	Content Groups
GROUPSHISTORY	Content Groups History
DIR	Directories
Demographics Reports
CLIENT	Visitors
CLIENTHISTORY	Visitors History
CLIENTSTREAM	Visitors Click Stream
USERS	Authenticated Users
USERSHISTORY	Authenticated Users History
USERSSTREAM	Authenticated Users Click Stream
SESSIONDIST	Session Distribution
KEYVISITORS	Key Visitors
COUNTRY	Countries
REGION	World Region
SECONDDOMAIN	Domains
ORGS	Organisations
Diagnostic Reports
ERRORS	Server Errors
ERRORSHISTORY	Server Errors History
BROKENLINKS	Pages Containing Broken Links
INTBROKENLINKS	Internal Pages Containing Broken Links
EXTBROKENLINKS	External Pages Containing Broken Links
ERRORURL	Failed URLs
CLIPSERRORS	Top Error Codes Per Clip (5.0 Streaming Mode only)
BROKENCLIPS	Pages Referencing Invalid Clips (5.0 Streaming Mode only)
CLIPSPACKETLOSS	Average Packet Loss (5.0 Streaming Mode only)
CLIPSLOSSVSRATE	Packet Loss vs Transfer Rate (5.0 Streaming Mode only)
CLIPSSECSBUFFERED	Average Second Buffered (5.0 Streaming Mode only)
CLIPSHIGHQUALITY	Highest Quality Clips (5.0 Streaming Mode only)
CLIPSLOWQUALITY	Lowest Quality Clips (5.0 Streaming Mode only)
ERRORURLHISTORY	Failed URLs History
Marketing Reports
TIMEONLINE	Time Online
CIRCULATION	Circulation
LOYALTY	Loyalty
Traffic Reports
HOURLY	Hourly
HOURLYHISTORY	Hourly History
DAILY	Daily
WEEKLY	Weekly
MONTHLY	Monthly
RECENTDAILY	Recent Daily
TIMESLOT	Timeslot (Version 5.0 Only)
Referrals Reports
REFER	Referral URLs
REFERSITE	Referral Sites
REFERSITEHISTORY	Referral Sites History
SEARCHENGINE	Search Engines
SEARCHENGINEHISTORY	Search Engines History
SEARCH	Search Terms
SEARCHHISTORY	Search Terms History
Systems Reports
BROWSER	Browsers
BROWSERHISTORY	Browsers History
OPERSYS	Operating Systems
OPERSYSHISTORY	Operating Systems History
BROWSERSVSOS	Browsers/Operating Systems
ROBOTS	Spiders/Robots
ROBOTSHISTORY	Spiders/Robots History
UNRECOGNIZEDAGENTS	Unrecognized Agents
MPLAYERS	Media Players (5.0 Streaming Mode only)
MPLAYERSHISTORY	Media Players History(5.0 Streaming Mode only)
MPLAYERSVSOS	Media Players vs Operating Systems (5.0 Streaming Mode only)
CPUS	Most Popular CPU Types (5.0 Streaming Mode only)
LANGS	Most Popular Languages (5.0 Streaming Mode only)
PROTOCOLS	Protocols Used to Transfer Clips (5.0 Streaming Mode only)
VIDEOCODECS	Most Utilized Video Codecs (5.0 Streaming Mode only)
AUDIOCODECS	Most Utilized Audio Codecs (5.0 Streaming Mode only)
Streaming Media Reports
MPLAYERS	Media Players
MPLAYERSHISTORY	Media Players History
MEDIATYPES	Media Types
AUDIOSTREAMS	Audio Content
AUDIOSTREAMSHISTORY	Audio Content History
VIDEOSTREAMS	Video Content
VIDEOSTREAMSHISTORY	Video Content History
Clip Access Information (5.0 Streaming Mode only)
CLIPSVIDEO	Most Popular Video Clips(5.0 Streaming Mode only)
CLIPSVIDEOHISTORY	Most Popular Video Clips History(5.0 Streaming Mode only)
CLIPSVIDEOVIEWING	Video Clip Viewing Times(5.0 Streaming Mode only)
CLIPSVIDEORATES	Video Clip Transfer Rates(5.0 Streaming Mode only)
CLIPSAUDIO	Most Popular Audio Clips(5.0 Streaming Mode only)
CLIPSAUDIOHISTORY	Most Popular Audio Clips History(5.0 Streaming Mode only)
CLIPSAUDIOVIEWING	Audio Clip Viewing Times(5.0 Streaming Mode only)
CLIPSAUDIORATES	Audio Clip Transfer Rates(5.0 Streaming Mode only)
CLIPSMAXCONCURRENT	Max Concurrent Connections Per Clip(5.0 Streaming Mode only)
CLIPSPERCENT	Percentage Streamed Per Clip(5.0 Streaming Mode only)
CLIPS	Most Popular Clips(5.0 Streaming Mode only)
CLIPSHISTORY	Most Popular Clips History(5.0 Streaming Mode only)
CLIPSLEAST	Least Played Clips(5.0 Streaming Mode only)
CLIPSFIRST	First Entry Clips(5.0 Streaming Mode only)
CLIPSFIRSTHISTORY	First Entry Clips History(5.0 Streaming Mode only)
CLIPSFORWARDS	Average Forwards Per Clip(5.0 Streaming Mode only)
CLIPSREWINDS	Average Rewinds Per Clip(5.0 Streaming Mode only)
CLIPSCOMPLETED	Uninterrupted Played Clips(5.0 Streaming Mode only)
MEDIATYPES	Media Types(5.0 Streaming Mode only)
Streaming Media Reports
MPLAYERS	Media Players
MPLAYERSHISTORY	Media Players History
MEDIATYPES	Media Types
AUDIOSTREAMS	Audio Content
AUDIOSTREAMSHISTORY	Audio Content History
VIDEOSTREAMS	Video Content
VIDEOSTREAMSHISTORY	Video Content History
Live Clip Access Information (5.0 Streaming Mode only)
LIVEVIDEO	Most Popular Live Video Clips(5.0 Streaming Mode only)
LIVEVIDEOHISTORY	Most Popular Live Video Clips History(5.0 Streaming Mode only)
LIVEVIDEOVIEWING	Live Video Clip Viewing Times(5.0 Streaming Mode only)
LIVEVIDEORATES	Live Video Clip Transfer Rates(5.0 Streaming Mode only)
LIVEAUDIO	Most Popular Live Audio Clips(5.0 Streaming Mode only)
LIVEAUDIOHISTORY	Most Popular Live Audio Clips History(5.0 Streaming Mode only)
LIVEAUDIOVIEWING	Live Audio Clip Viewing Times(5.0 Streaming Mode only)
LIVEAUDIORATES	Live Audio Clip Transfer Rates(5.0 Streaming Mode only)
LIVEMAXCONCURRENT	Max Concurrent Connections Per Live Clip(5.0 Streaming Mode only)
Billing (5.0 Version only)
BILLING	Customer Billing Statement(5.0 Version only)

Field Commands

Back to Top

The following commands are used in conjuction with Top X commands, Lowest X commands and Total X commands where FIELD is mentioned in the commands. In these cases, you can substitute the field for any of the following fields. (Note: This feature is only available in version 5.0)

 

 

Link to Report Commands

Back to Top

The following commands are used in conjuction with the Report stat names listed in the table above. In all of these commands, subsitute STATNAME for the Report name from the table above.

[$report_STATNAME] This command will resolve into a report file name that can be used for URL links or titles. This command will just display the report file name in the report output For instance [$report_PAGES] would appear as pages.html in the report. For example, if you wanted to link to the pages report and give the link to the Pages report the name of "My Site Pages", you could enter the following in the HTML code of the summary template:

<a href="[$report_PAGES]">My Site Pages</a>

This would resolve as a link to the Pages report called My Site Pages

[$reportname_STATNAME] This command will appear as is the reports title name. In the report output, the Title of the report will appear. For instance
[$reportname_PAGESFIRST] would appear as Entry Pages. This text would not link to the report

[$reportfile_STATNAME] This is the reports file name without extensions. For instance
[$reportfile_PAGESFIRST] would appear as PageF (the filename is PageF.html)

[$link2_STATNAME] This command will appear in the report as a file link including the name of the report. This will also be conditional, so if the report wasn't generated it won't appear in the report at all. If the report wasn't generated , this will search for the next tag which it will then override and remove. For instance:
[$link2_PAGESFIRST] would appear as Entry Pages in the report with a link to PageF.html

[$thumb_STATNAME] This will generate a 1/3rd sized thumbnail of the report specified and also return the filename of that image, (Daily.jpg)
For instance, [$thumb_CAMPAIGNS] would appear as thumb_AdvertCamp.jpg in the report output

[$thumblink_STATNAME] This will generate a 1/3rd sized thumbnail of the report specified and create the actual IMG SRC link too all in one.
For instance, [$thumblink_CAMPAIGNS] would appear as

Campaigns Report

If you want the image above to also link to the Campaigns report you would enter the following in the HTML code of the summary template:
[$link3_CAMPAIGNS][$thumblink2_CAMPAIGNS]

[$image_STATNAME] This command will return the name of the report graph to be used in an IMG tag. For example, if you wanted to have a full sized graph from one of the reports you could link to this in an image tag, as in the following example:

<img src="[$image_PAGESFIRST]" > This would display the Entry Pages graph on the summary report

[$MULTILINK2_STATNAME] (version 5.0 only) This command will cause links to be displayed for all the reports in the group of the STATNAME entered, following the default order of the group of reports. This command is typically used when creating a HTML framed report.

For example, entering the command [$MULTILINK2_ERRORS] would appear in the report output as follows:

Server Errors
Server Errors History
Failed URLs
Failed URLs History
Pages Containing Broken Links

Each of the above report names would provide a link to the corresponding report in the report output. Entering the command [$MULTILINK2_ERRORURL] would appear in the report output as follows:

Failed URLs
Failed URLs History
Pages Containing Broken Links

This shows that only links after the starting report specified will be displayed. For an example of usage of this command, view the HTML framed report template file in version 5.0 in the following location for Web mode:
C:\Program Files\Quest Software\Funnel Web (Enterprise) 5.0\Templates\Web\default_framelist.html
or the HTML framed template file for Streaming mode....
C:\Program Files\Quest Software\Funnel Web (Enterprise) 5.0\Templates\Streaming\default_framelist.html

[$MULTITHUMBLINK_STATNAME] (version 5.0 only) This command will cause thumbnails to be displayed for all the reports in the group of the STATNAME entered, following the default order of the group of reports. This will follow the same order as the MULTILINK2 command above. For an example, entering the following command [$MULTITHUMBLINK_ERRORURL] would appear in the report as:

 

Note that the Thumbnails above do not link to the reports, but only display the thumbnail pictures of the report graphs.

HTML Controls

Back to Top

The following commands define the look and feel of reports, as well as display statistics such as total hits, etc.

[$include_FILENAME] Just like the C# code include, this will include/read a file into the html file in this position, just like SSI (Server Side Includes). You will need to enter the full Path name of the file to include. For instcance, if you wanted to include a HTML file called mylinks.html contained within the Program root folder, you would enter the following:
[$include_C:\Program Files\Quest Software\Funnel Web (Enterprise) 4.5\mylinks.html]
This will include the mylinks.html file in the summary template where you enter this command

DYNAMIC REASIGNMENT: You can also redefine how LINK2_ and THUMBLINK_ look visually, using the #define feature, remember that there are always two parameters there , the link followed by the name. Eg.

<!-- #define link2=<H3>(*) <a href="%s.html"> %s </a></H3> -->
<!-- #define thumblink2=<img src="thumb_%s.jpg"><br><center><font size="1" face="Arial, Helvetica, sans-serif">%s Report</font></center><br> -->

You may use link1 to link9 and thumblink1 to thumblink9. These 1-9 parameters are not pre-defined and must be defined by the user. Using eg. [$link_STATNAME] without a number uses the internal default style. The default style appears as follows:

Default Style

If you also use a link template that doesn't exist (eg. [$link54_campaigns]) it will default back to the internal default.

STATUS QUERY: [$STATUSREPORT_STATNAME] This will return either a string as "true" or "false" depending if the report was made or not. This is useful if using in java script code.
eg. [$STATUSREPORT_CLUSTERS] :if this command would entered, would return false in code if Load Balancing report not produced. If it is produced, will return true. This string will not be displayed in a browser

[$STATUSTHUMB_STATNAME] This will return either a string as "true" or "false" depending if the thumbnail was made or not. This is useful in using in java script code. This command functions in the same way as the STATUSREPORT command

[$ADDHOSTHEADER] (Version 5.0 only) This powerful command is used in conjunction with Virtual Host processing. For instance, if you host multiple web sites on the one server and you want a different html header for each Virtual Host report produced. This command will insert the html header of each virtual host. For this to work, you must start the application directly from the AnalyzerEnt.exe file and not via shortcut. If you have virtual hosts named sitea.com and siteb.com, then this command will search for a html header for these sites in the location the application was launched from (typically C:\Program Files\Quest Software\Funnel Web (Enterprise) 5.0) in the case of sitea.com and siteb.com, it will look for the following files and insert them in the report where the command is:

C:\Program Files\Quest Software\Funnel Web (Enterprise) 5.0\sitea.com..html
C:\Program Files\Quest Software\Funnel Web (Enterprise) 5.0\siteb.com..html

Note that the filename needs to contain two dots after the filename before the html extension

[$HTMLHEADER] - (Version 5.0 only) This command inserts the Header information from the Settings/Report/Style tab within the application.

[$HTMLFOOTER] - (Version 5.0 only) This command inserts the Footer information from the Settings/Report/Style tab within the application.

[$LANGUAGE] - (Version 5.0 only) This command displays the name of the output language used for the report

[$EXTENSION] - (Version 5.0 only) Displays the file extension used for all reports. By default this will appear as .html unless the file extension is changed in the report output location in the settings

[$SUMMARYFILENAME] - (Version 5.0 only) Displays just the filename component of the output path (for example index.html)

Top X Commands

Back to Top

This group of commands will return the top value for the specified statistic. If there is no value at all, it will report, "N/A", if the report hasn't been made it will report "No entry"

[$TOPHITS_STATNAME] This command will return the item with the highest hits/requests in the specified report. For instance, [$TOPHITS_PAGES] would return the name of the page with the most hits in the Pages report.

[$TOPBYTES_STATNAME] This command will return the item with the highest Bytes in the specified report. For instance, [$TOPBYTES_PAGES] would return the name of the page with the most Bytes in the Pages report.

[$TOPSESSIONS_STATNAME] This command will return the item with the highest Sessions in the specified report. For instance, [$TOPHITS_CLIENT] would return the name of the Visitor with the most Sessions in the Visitors report.

[$TOPVISITORS_STATNAME] This command will return the item with the most Visitors in the specified report. For instance, [$TOPVISITORS_FILE] would return the name of the URL with the most Visitors in the URL report.

[$TOPPAGES_STATNAME] This command will return the item with the most Pages in the specified report. For instance, [$TOPPAGES_CLIENT] would return the name of the Visitor who visited the most Pages in the Visitors report.

[$TOPERRORS_STATNAME] Highest Error Count.

[$HIGHESTVALUE(FIELD,STAT)] (Version 5.0 only) Displays the highest value from STAT, sorted by FIELD

[$HIGHESTPERCENT(FIELD,STAT)] (Version 5.0 only) Displays the highest value's percent from STAT, by FIELD

[$HIGHESTITEM(FIELD,STAT)] (Version 5.0 only) Displays the highest item in STAT, sorted by FIELD

[$ITEMXNAME(pos,FIELD,STAT)] (Version 5.0 only) Displays the name of the top stat for the chosen field, sorted by 'field'. For instance, entering the following would return the name of the Visitor with the most hits: [$ITEMXNAME(pos,HITS,CLIENT)]

[$ITEMXVALUE(pos,FIELD,STAT)] (Version 5.0 only) Displays the value of the top stat for the chosen field sorted by 'field'. For instance, entering the following would return the number of hits caused by the Visitor with the most hits: [$ITEMXVLUE(pos,HITS,CLIENT)]

Lowest X Commands

Back to Top

This command will return the top value for the specified statistic. If there is no value at all, it will report, "N/A", if the report hasn't been made it will report "No entry"

[$LOWEST_STATNAME] This command will return the item with the lowest hits/requests in the specified report. For instance, [$LOWEST_PAGES] would return the name of the page with the lowest hits in the Pages report.

[$LOWESTVALUE(FIELD,STAT)] (Version 5.0 only) - Finds the lowest value from STAT, sorted by FIELD

[$LOWESTITEM(FIELD,STAT)] (Version 5.0 only) - Finds the lowest item in STAT, sorted by FIELD

Total X Commands

Back to Top

This group of commands will return the total value for the specified statistic. If there is no value at all, it will report, "N/A", if the report hasn't been made it will report "No entry"

[$TOTALHITS_STATNAME] This command will return the total hits/requests in the specified report. For instance, [$TOTALHITS_PAGES] would return the total of all the hits in the Pages report.

[$TOTALBYTES_STATNAME] This command will return the total Bytes in the specified report. For instance, [$TOTALBYTES_PAGES] would return the total Bytes in the Pages report.

[$TOTALSESSIONS_STATNAME] This command will return the total Sessions in the specified report. For instance, [$TOTALSESSIONS_PAGES] would return the total of all the Sessions in the Pages report.

[$TOTALVISITORS_STATNAME] This command will return the total Visitors in the specified report. For instance, [$TOTALVISITORS_FILE] would return the total of all the Visitors in the URLs report.

[$TOTALPAGES_STATNAME] This command will return the total Pages in the specified report. For instance, [$TOTALPAGES_CLIENT] would return the total of all the Pages in the Visitors report.

[$TOTALERRORS_STATNAME] This command will return the total Errors in the specified report. For instance, [$TOTALERRORS_FILE] would return the total of all the Errors in the URLs report.

[$TOTAL_STATNAME] This command will return the total items in the specified report. For instance, [$TOTAL_PAGES] would return the total of all Pages in the Pages report.

[$ERRORITEMS_STATNAME] This command will return the total amount of items that have errors at all in the specified report. For instance, [$ERRORITEMS_PAGES] would return the total of all the items in the Pages report with any type of error

[$CLIENTPERCENT_x] This command displays the % of hits that indiviual Visitors make on a site, For Instance [$CLIENTPERCENT_196.23.44.1] would display the percentage value of traffic (eg.45%) the visitor 196.23.44.1 represents on your site. This is useful for example, if you want to display what percentage of the Traffic on your site is generated by a certain internal IP, or what percentage comes from a specific company with a unique IP address.

[$TOTALTIME] This command displays the total time duration of the log file/s reported on in the following format eg. 22:14:18

[$TOTALDAYS] This command displays the total Days in the log file/s reported on in the following format eg. (21 Days)

[$TOTALHITS] This command displays the total global hits for the whole report.

[$TOTALCACHE] This command displays the total Cached hits for the whole report.

[$TOTALFAILED] This command displays the total Failed hits and hits containing errors for the whole report.

[$TOTALINVALID] This command displays total invalid lines in the log files processed Invalid log lines are ignored because they are in an unexpected format compared to the rest of the log.

[$TOTALSESSIONS] This command displays the Total amount of sessions in the log file/s

[$TOTALVISITORS] This command displays the Total unique visitors to the web site.

[$TOTALPAGES] This command displays the Total unique pages served.

[$TOTALPAGEHITSPERDAY] This command displays the Average Pages served per day.

[$TOTALPAGEBYTES] This command displays the Total bytes served by pages.

[$TOTALPAGEMB] This command displays the Total MB served by pages.

[$TOTALPAGEHITS] This command displays the Total hits on all Pages

[$TOTALPAGEERRORS] This command displays the Total pages with errors.

[$TOTALDLOADS] This command displays the Total number of unique downloads served.

[$TOTALDLOADHITSPERDAY] This command displays the Average Downloads served per day.

[$TOTALDLOADBYTES] This command displays the Total bytes served by downloads.

[$TOTALDLOADMB] This command displays the Total MB served by downloads.

[$TOTALDLOADHITS] This command displays the Total amount of downloads hits.

[$TOTALDLOADERRORS] This command displays the Total downloads with errors. This is displayed in Bytes Served:

[$TOTALFILTEREDHITS] - (Version 5.0 only) Displays the total number of hits filtered out from the report as a result of filters applied in the settings used to process the log file.

[$TOTALHITSPERDAY] - (Version 5.0 only) Displays the average Total Hits per day get total hits per day , for x statlist

[$TOTALMB_(STAT)] - (Version 5.0 only) total MB for stat

[$TOTALGB_(STAT)] - (Version 5.0 only)total GB for stat

[$TOTALVALUE(FIELD,STAT)] - (Version 5.0 only)find the total value for FIELD from STAT

[$TOTALVALUEPERDAY(FIELD,STAT)] - (Version 5.0 only) find the total value for FIELD from STAT averaged per day

Basic Commands

Back to Top

The following commands perform a variety of basic functions for displaying various values in the summary report.

[$TITLE] This command displays the report title string. This command works in conjuction with the Report Title textbox in the FunnelWeb Settings in the Settings/Report/Page tab. When Text is entered in this field, this text will be displayed. Where text is not entered in the settings, the words "Access Statistics" will be displayed.

[$CURRENTTIME] This command displays the current date and time when the report was produced. This will appear in the format: Aug 19 2002 16:22:34

[$PROCESSTIME] This command displays the time Funnelweb takes to Process the log file. This is displayed in the following format:
Log Processing Time: 00:00:04.2, 763933 lines/min, 148.00 MB/min
Note that the "Log Processing Time" string is displayed automatically when using this command

[$VERSION] This command displays the Funnel Web full Product name and version. eg. Funnel Web Analyzer Enterprise 4.5

[$BUILDDETAILS] This command displays the Funnel Web full Product name and version as well as Build number details
eg. Funnel Web Analyzer Enterprise 4.5 (Build 512 - Built on May 27 2002 13:14:27)

[$STARTDATE] This command displays the start date and time of the log file/s reported on in the following format
eg. Feb 06 2002 00:47:15

[$ENDDATE] This command displays the start date and time of the log file/s reported on in the following format
eg. Feb 13 2002 21:47:15

[$DOMAINNAME] This command Displays the current domain name of the log file/s analyzed. This will default to the log file name unless one of the Virtual Host options is turned on to identify Individual hosts. eg. www.quest.com

[$AVGDAILYHITS] This command displays the Average amount of hits per day.

[$AVGHOURLYHITS] This command displays the Average hits per hour

[$VISITORSPERHOUR] This command displays the Average amount of visitors that visited per hour.

[$REPEATVISITORS] This command displays the Amount of visitors that visited more than once.

[$ONCEVISITORS] This command displays the Visitors that only appeared once or had 1 session.

[$DAILYSESSIONS] This command displays the Average Amount of sessions per day.

[$AVGVISITLEN] This command displays the Average session length of visitors

[$AVGPAGESVISIT] This command displays the Average amount of pages per session visit.

[$AVGHITSVISIT] This command displays the Average amount of hits per session visit.

[$AVERAGEVALUE(FIELD,STAT)] (Version 5.0 only) For a given FIELD in STAT, returns the average value, ie TOTAL/STAT->num

[$BYTES_TOTAL] This command displays the Total bytes served in full

[$BYTES_TOTALKB] This command displays the Total kilobytes served

[$BYTES_TOTALMB] This command displays the Total MegaBytes served

[$BYTES_TOTALCOST] This command displays the Total cost of traffic in $ terms if specified. This needs to be specified in the Settings/Statistics/Global tab. A numeric value must be entered in the Bandwidth Cost/MB text field.

[$BYTES_DAILY] This command displays the Total traffic per day automatically in Kb or Mb

[$BYTES_BPS] This command displays the Total traffic in byes per second.

[$BYTES_PERCENT] This command displays the Total traffic as a % of the base line speed. (auto)

[$BYTES_SPEED] This command displays the This displays the base line speed (auto) This is displayed in Bytes Recieved:

[$BYTESIN_TOTAL] This command displays the Total bytes in full served

[$BYTESIN_TOTALKB] This command displays the Total kilo bytes served

[$BYTESIN_TOTALMB] This command displays the Total MegaBytes served

[$BYTESIN_TOTALCOST] This command displays the Total cost of traffic in $ terms if specified.This needs to be specified in the Settings/Statistics/Global tab. A numeric value must be entered in the Bandwidth Cost/MB text field.

[$BYTESIN_DAILY] This command displays the Total traffic per day automaticly in Kb or Mb

[$BYTESIN_BPS] This command displays the Total traffic in bytes per second.

[$BYTESIN_PERCENT] This command displays the Total traffic as a % of the base line speed. (auto)

[$BYTESIN_SPEED] This command displays the the base line speed (auto)

Look and Feel

Back to Top

The following commands are used to control the look and feel of the Summary Template. These function in the same way as the Settings/Report/Style tab in FunnelWeb.

These commands return as RGB Colors in ascii HEX, e.g. "0x223344"

[$RGB_DEFAULT] This command displays the Default RGB color for this version, either red or blue. For instance, the Funnel Web Enterprise version would return the value 0099cc

[$RGB_TITLE] [$RGB_HEADERS] [$RGB_ITEMS] [$RGB_OTHERS] [$RGB_AVG] [$RGB_TOTALS] These commands return the RGB value for the colours specified in the settings in Settings/Report/Page tab. For Instance, if you selected the tmeme of Wild in the Settings and entered the command [$RGB_TITLE] the value of ff0030 (the ascii code denoting the colour Red) would be returned in the report output . This would be useful if you wanted to use the same colours defined in your settings to define other elements, such as table row colours.

[$HTMLFONT] This command displays the html font as specified in the settings file. By default, this command will display arial,helvetica. There is currently no GUI functionality to change the font, however you can change the default font by editing the .fwp settings file in a text editor. Entering the html_font X command anywhere in the file in a text editor will make the chosen font the default when using that settings file. The command is as follows: html_font arial
This will set the default font to arial.
The [$HTMLFONT] command would be useful if you wanted to use the same font defined in your settings to apply to other text, such as text within table rows

[$HTMLFONTSIZE] This command displays the html font size as specified in the settings file. By default, this command will display 2 There is currently no GUI functionality to change the fontsize, however you can change the default fontsize by editing the .fwp settings file in a text editor. Entering the html_fontsize X command anywhere in the file in a text editor will make the chosen fontsize the default size when using that settings file. The command is as follows: html_fontsize 3
This will set the default fontsize to 3l.
The [$HTMLFONTSIZE] command would be useful if you wanted to use the same fontsize defined in your settings to apply to other text, such as text within table rows

[$HTMLHEADER] This command displays the html header as specified in the settings file in Settings/Report/Style. If you want to apply the Header set up in the Settings to your summary_template.html file, simply insert this command. This command will use all the information specified in the Header in the settings file such as bgcolour, links,banner imag source and any other HTML code you wish to add.

[$HTMLFOOTER] This command displays the html footer as specified in the settings file in Settings/Report/Style.If you want to apply the Footer set up in the Settings to your summary_template.html file, simply insert this command. This command will use all the information specified in the Footer in the settings file such as Contact information, HTML body close commands and any other HTML code you wish to add.

Streaming Media Commands

Back to Top

The following commands are used when operating Funnel Web in streaming media mode in version 5.0 of the product.

[$WEBCAST_NAME] -The name of the webcast as entered in Settings/Tracking/Webcast Analysis tab in Streaming settings

[$WEBCAST_TOTAL] - Returns the number of webcasts as entered in the settings

[$WEBCAST_STARTTIME] - Displays the webcast start date/time as entered in the settings

[$WEBCAST_ENDTIME] - Displays the webcast end date/time as entered in the settings

[$WEBCAST_EXPECTEDVISITORS] - Displays the expected visitors to the webcast as entered in the Webcast settings

[$WEBCAST_URL] - Displays the URL of the Webcast as specified in the settings.

[$WEBCAST_SUCCESSRATING] - This retruns the ratio of webcast actual visitors to expected visitors entered in the settings.

Conclusion

Back to Top

We hope you find the features in this Article useful. The summary_template.html file offers you a powerful tool for customizing the summary report to your individual needs. Using the commands, you can create an 'at a glance' summary of your website that gives you all the vital statistics you are foccussed on in a convenient location

Greg Stehle
Funnel Web Analyzer

This site looks best using Safari or FireFox.

Links

• Home
• FAQ's
• Articles
• Forums
• Downloads