Controlling the Summary Template
Introduction
You can customize the look of the Summary report by editing the styles defined in the Summary template (summary_template.html). For example, you could change the template to reflect your corporate style and substitute the graphics used at the top of the report for your company's logo. Alternatively, you could create a new Summary report using the summary template as a guide. Attempt this only after you are familiar with the code in summary_template.html.
The Summary template uses tokens to link to each report. You can change the links and thumbnail graphics displayed in the Summary report by editing the tokens in the template. For example, you could customize the thumbnail graphics displayed for each reporting category.
It is recommended that customization of the Summary template is performed only if you are familiar with HTML. Before customizing the Summary template, be aware of the following limitations:
- Any spelling errors in an "if" statement crashes Funnel Web Analyzer. An example of
an "if" statement used in the Summary template follows.
<--!#if groupReported=Advertising-->
- Only two "%s" variables can be used on the one line. More than two crashes Funnel
Web Analyzer. An example of correct usage follows:
<--! #define link2= %s -->
Customizing the look of the Summary template
The Summary template uses an embedded style sheet to control the look of the report. To customize the look of the Summary template:
- Make a backup copy of the summary_template.html file. The summary_template.html file is located in the root of your Funnel Web Analyzer directory.
- Open summary_template.html in any HTML editor.
- Edit the attributes for each of the styles you want to change.
- After you have made your changes, save the template.
- Process a log file and view the report.
Customizing links and graphics in the Summary template
Customizing the links and graphics in the Summary template involves changing the tokens used to link to each report. Whether the link points to a report or thumbnail graphic, you can substitute it with one of the tokens listed later in this chapter. Each section of the report categories is sandwiched between comments that indicate the start and end of the section. You can delete a section if you want to customize the information displayed in the summary report.
To customize the links or thumbnail graphics
- Make a backup copy of the summary_template.html file. The summary_template.html file is located in your Funnel Web Analyzer directory.
- Open summary_template.html in any HTML editor.
- Use the section comments to navigate to the link or thumbnail graphic you want to
change. Examples of links follow.
[$LINK2_PAGES]
Link to Pages report
[$THUMBLINK2_PAGES]
Thumbnail graphic with an associated link
Use the list of tokens below to find the corresponding token for each report.
For example, to change the thumbnail displayed in the Server category from Pages to Pages History, navigate to the start of the Server snapshot section, locate the reference to the graphic, [$THUMBLINK2_PAGES], change "PAGES" to "PAGESHISTORY". - After you have made your changes, save the template.
- Process a log file and view the report.
Tokens
The following is a complete list of available reports and the associated tokens to be inserted into the summary_template.html file.
Report |
Token |
| Advertising | |
| Advertising Campaigns | CAMPAIGNS |
| Advertising Impressions | ADVERT |
| Advertising Campaigns History | CAMPAIGNSHISTORY |
| Advertising Impressions History | ADVERTHISTORY |
| Clustering | |
| Load Balancing | CLUSTERS |
| Load Balancing History | CLUSTERSHISTORY |
| Demographic | |
| Pages | PAGES |
| Pages History | PAGESHISTORY |
| Pages Least Visited | PAGESLEAST |
| Entry Pages | PAGESFIRST |
| Entry Pages History | PAGESFIRSTHISTORY |
| Exit Pages | PAGESLAST |
| Exit Pages History | PAGESLASTHISTORY |
| Mean Paths | MEANPATH |
| URLs | FILE |
| File Types | FILETYPE |
| File Downloads | DOWNLOAD |
| Top Level Directories | TOPDIR |
| Top Level Directories History | TOPDIRHISTORY |
| Routes To Key Pages | KEYPAGEROUTE |
| Routes From Key Pages | KEYPAGEROUTEFROM |
| Content Groups | GROUPS |
| Content Groups History | GROUPSHISTORY |
| Directories | DIR |
| Diagnostic | |
| Server Errors | ERRORS |
| Server Errors History | ERRORSHISTORY |
| Pages Containing Broken Links | BROKENLINKS |
| Internal Pages Containing Broken Links | INTBROKENLINKS |
| External Pages Containing Broken Links | EXTBROKENLINKS |
| Failed URLs | ERRORURL |
| Failed URLs History | INTBROKENLINKS |
| Internal Pages Containing Broken Links | ERRORURLHISTORY |
Variable List for Statistics
| [$report_STATNAME] | This will resolve into a report file name that can be used for URL links or titles (its just the name) |
| [$reportname_STATNAME] | This is the reports title name. |
| [$reportfile_STATNAME] | This is the reports file name without extensions. |
| [$link2_STATNAME] | This will resolve into a report file link including
the name of the report. This will also be conditional, so if the report
wasn't generated it wont resolve to anything. If the report wasn't
generated , this will search for the next tag which it will then override and remove. |
| [$thumb_STATNAME] | This will generate a 1/3rd sized thumbnail of X report specified and also return the filename of that image, (Daily.jpg) |
| [$thumblink_STATNAME] | As above but creates the actual IMG SRC link too all in one. |
| [$image_STATNAME] | This will return the name of the report graph to be used in an IMG tag. |
| [$include_FILENAME] | Just like C #include, this will include/read a file into the html file in this position, just like SSI. |
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. Using it without
a number uses the internal default style. If you also use a link template
that doesn't exist 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 in using in java script code. |
| [$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 |
Top Commands
The following commands return top values from reports. 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 will return the item with the highest hits/requests in specified report. |
| [$TOPBYTES_STATNAME] | Highest Bytes Out. |
| [$TOPSESSIONS_STATNAME] | Highest Sessions. |
| [$TOPVISITORS_STATNAME] | Highest Visitors. |
| [$TOPPAGES_STATNAME] | Highest Page Count. |
| [$TOPERRORS_STATNAME] | Highest Error Count. |
Lowest Commands
| [$LOWEST_STATNAME] | This will return the item with the lowest hits/requests in specified report. |
Total Commands
The following command show Total figures of reports:
| [$TOTALHITS_STATNAME] | Show total hits achieve by this report. |
| [$TOTALBYTES_STATNAME] | Show total bytes achieve by this report. |
| [$TOTALSESSIONS_STATNAME] | Show total sessions achieve by this report. |
| [$TOTALVISITORS_STATNAME] | Show total visitors achieve by this report. |
| [$TOTALPAGES_STATNAME] | Show total pages achieve by this report. |
| [$TOTALERRORS_STATNAME] | Show total errors achieve by this report. |
| [$TOTAL_STATNAME] | Show total items in this report. |
| [$ERRORITEMS_STATNAME] | Show total amount of items that have errors at all. |
| [$CLIENTPERCENT_x] | Show the amount of % of hits that clients make, wildcard matched to the parameter of x. eg. [$CLIENTPERCENT_*.com] |
Basic Commands:
| [$TITLE] | Show the report title string |
| [$CURRENTTIME] | Show current time when report was made |
| [$PROCESSTIME] | Display processing time stats. |
| [$VERSION] | Full Product name and version |
| [$BUILDDETAILS] | Full build number and date. |
| [$TOTALTIME] | Display total duration in report. |
| [$TOTALDAYS] | Display total days in report. |
| [$STARTDATE] | Show start date of report. |
| [$ENDDATE] | Show the last date/time of report. |
| [$DOMAINNAME] | Display current domain name or server name. |
| [$TOTALHITS] | Display total global hits for whole report. |
| [$TOTALCACHE] | Total cached hits. |
| [$TOTALFAILED] | Total failed or errored hits. |
| [$TOTALINVALID] | Total invalid lines of log files processed |
| [$AVGDAILYHITS] |
Average amount of hits per day. |
| [$AVGHOURLYHITS] | Average hits per hour. |
| [$TOTALSESSIONS] | Total amount of sessions. |
| [$TOTALVISITORS] | Total unique visitors to web site. |
| [$VISITORSPERHOUR] | Amount of visitors that visited per hour. |
| [$REPEATVISITORS] | Amount of visitors that visited more than once |
| [$ONCEVISITORS] | Visitors that only appeared once or had 1 session. |
| [$DAILYSESSIONS] | Average Amount of sessions per day. |
| [$AVGVISITLEN] | Average session length |
| [$AVGPAGESVISIT] | Average amount of pages per session visit. |
| [$AVGHITSVISIT] | Average amount of hits per session visit. |
| [$TOTALPAGES] | Total unique pages served. |
| [$TOTALPAGEHITSPERDAY] | Average Pages served per day. |
| [$TOTALPAGEBYTES] | Total bytes servered by pages. |
| [$TOTALPAGEMB] | Total MB servered by pages. |
| [$TOTALPAGEHITS] | Total page hits. |
| [$TOTALPAGEERRORS] | Total pages with errors. |
| [$TOTALDLOADS] | Total unique downloads served. |
| [$TOTALDLOADHITSPERDAY] | Average Downloads served per day. |
| [$TOTALDLOADBYTES] | Total bytes servered by downloads. |
| [$TOTALDLOADMB] | Total MB servered by downloads. |
| [$TOTALDLOADHITS] | Total downloads hits. |
| [$TOTALDLOADERRORS] | Total downloads with errors. |
Bytes Served
| [$BYTES_TOTAL] | Total bytes in full served |
| [$BYTES_TOTALKB] | Total kilo bytes served |
| [$BYTES_TOTALMB] | Total Mega Bytes served |
| [$BYTES_TOTALCOST] | Total cost of traffic in $ terms if specified |
| [$BYTES_DAILY] | Total traffic per day automaticly in Kb or Mb |
| [$BYTES_BPS] | Total traffic in bites per second. |
| [$BYTES_PERCENT] | Total traffic in % of base line speed. (auto) |
| [$BYTES_SPEED] | This displays the base line speed (auto) |
Bytes Recieved
| [$BYTESIN_TOTAL] | Total bytes in full served |
| [$BYTESIN_TOTALKB] | Total kilo bytes served |
| [$BYTESIN_TOTALMB] | Total Mega Bytes served |
| [$BYTESIN_TOTALCOST] | Total cost of traffic in $ terms if specified |
| [$BYTESIN_DAILY] | Total traffic per day automaticly in Kb or Mb |
| [$BYTESIN_BPS] | Total traffic in bites per second. |
| [$BYTESIN_PERCENT] | Total traffic in % of base line speed. (auto) |
| [$BYTESIN_SPEED] | This displays the base line speed (auto) |
HTML Control
These return as RGB Colors in ascii HEX, e.g. "0x223344"
| [$RGB_DEFAULT] | Default RGB color for this version, either red or blue. |
| [$RGB_TITLE] | Following are from the settings options. |
| [$RGB_HEADERS] | |
| [$RGB_ITEMS] | |
| [$RGB_OTHERS] | |
| [$RGB_AVG] | |
| [$RGB_TOTALS] | |
| [$HTMLFONT] | The html font as specified in the settings file. |
| [$HTMLFONTSIZE] | The html font size as specified in the settings file. |
| [$HTMLHEADER] | The html header as specified in the settings file. |
| [$HTMLFOOTER] | The html footer as specified in the settings file. |
This site looks best using Safari or FireFox.
