Funnel Web Command Line options

The following are the current valid commands for use with the 5.0 Commandline versions of Funnelweb Analyzer Enterprise 5.0. This is available on Linux,Solaris and Mac OSX. You can also use these commands in the Windows commandline.

-h Help
-l file Use logfile(s) , you can use wildcards but enclose in quotes. ie "*.log"
-l FTP://URL You can also source your logs from an ftp server using a standard URL (ftp://username:password@site/file.log)
-l HTTP://URL You can also source your logs from an http server using a standard URL (http://myserver.com/logs/access_log)
-r file Use report config [file] or
-settingsfile file
-includesettings X Append (or include) a subset of a settings file
-saveprefs X Save internal settings to a prefs file (for testing) where X is the file
-q Quiet no output at all
-q1 Normal status on
-ver Display Current Version Information
-reg Perform registration procedure
-convert_to_w3c X Convert processed log files into one W3C format log file X
eg. '-l /test.log -convert_to_w3c new.log' creates converted file called new.log
-convert_to_streaming X Convert current settings to streaming mode settings, please preceed with -settingsfile X to read one to be converted
-stat_style X Start in web or streaming mode where X = web or streaming
-debugarg Debug arguments passed
-debug Log debug messages to log file '~/.debug_log.txt'
-debugprint Log debug messages and print to console
-searchfor X Search for pattern in URL and...
-replacewith X Replace it with this value/string (both these have to be used together)
-checkschedule Check the internal schedule list to decide processing times (schedule file is ~/.schedule.txt)
-runschedule X Run schedule X in the schedule config settings
NOTE: when using a * or other wildcards, supply it inside a quotes to prevent the shell from interpreting it.

--------- General Report Style Options
-d or -o or -out Destination directory/filename.html
-summary_template Filename of summary template used for html reports
-reportformat X Choose a new output format, (html,pdf,rtf,comma,excel) or (1..5)
-imageformat X Define the image format, (gif,jpeg,png,bmp,none or 0,1,2,3 )
-language X Language output type (1=German,2=Italian,3=French,4=Spanish,5=Swedish,6=Norw,7=Danish,8=Dutch,9=Japan)
,t (or you can pass the name of the language)
-footer_label Enable header to also appear at bottom of the table
-report_title Define the title of the report
-theme X Use color theme X (0=random,1=default,2=basic,3=grey,4=blue,5=wild,6=blan,7=ice)
-shadow Use shadows on graphs or '-noshadow' to switch off shadows
-headingonleft Place main column name on left side
-headingonright Place main column name on right side
-style [2d/3d] Use graph style [3d/2d] on bar graphs
-webpalette Use 256 netscape colors in all images
-wider Draw wider format graphs
-corporate_look Make all graphs look corporate style
-allimagesoff Turn off ALL Images for all reports
-allhistoriesoff Turn off ALL history reports for all reports
-graphtypecolor X Define the color combos for each graph style
Parameters are : num label grid base borderhi borderlo border
num is defined as 1=V-bars,2=H-Bars,3=Line,4=Pie-Charts,5=3D-History,6=3D-VBar,7=Scatter-Chart
eg. 'graphtypecolor 3 000000 141478 f0f0f0 ffffff 555555 000000'
-graphcolor X Define graph colors for individual reports.
Parameters are : REPORTNAME BarColors-light BarColors-mid BarColors-shadow background graph-style(1=V-bars,2=H-Bars,3=Line,4=Pie-Charts,5=3D-History,6=3D-VBar)
eg. 'graphcolor hourly 000000 ff0000 ffff00 8c8cf0 2'

--------- Database Options
-database_active Activate saving reports to a binary database
-database_extended Database is an extended format (V5) database
-database_file File to use or create
-database_no_report Do not produce a report once data has been added to the database
-database_excluded Exclude database from report (report on new logs only)

--------- HTML Options
-html_font X Specify html fonts to use in reports (default=original, none=dont write font info)
-html_fontsize n Specify html font size to use with above
-html_frames Enable html reports to be reported in framed mode
-html_quickindex Enable report index in every report page
-head File to use for HTML header
-foot File to use for HTML footer

--------- Analysis Options
-sdate X Set start date [MM/DD/YY]
-edate X Set end date [MM/DD/YY] (if start date not entered, defaults to current date)
-start_date X Set start date YYYY/MM/DD absolute dates
-end_date X Set end date YYYY/MM/DD absolute dates
-alldates process all dates
-time_adjust X Adjust a time offset to all times (seconds or hh:mm:ss)
-forcedateformat X Overide default dateformat and use specified (DD/YY, MM/DD, YY/MM)
-ignorezerobyte Filter out zero byte files
-ignorerobots Ignore all hits comming from robots
-ignoreself Ignore referrals pointing back to your server (must specify -siteurl and -indexfile)
-ignorecase Ignore case for all urls/files
-ignoreusernames Dont use authenticated usernames for visitors, but only the ip or domain name.
-ignorebookmark Ignore bookmark referrals or file:// referrals
-ignoreipvhosts Ignore virtualhosts IPs
-siteurl Specify the name of the host that is localhost to the log file eg: http://www.home.com
-indexfile X Specify the default server index file (ie index.html)
-page.ext X Supply a list of extensions in the format .abc,.zxc to define pages
-download.ext X Supply a list of extensions in the format .abc,.zxc to define downloads
-audio.ext X Supply a list of extensions in the format .abc,.zxc to define audio files
-video.ext X Supply a list of extensions in the format .abc,.zxc to define video files
-usecgi Accept cgi parameters in all urls
-retain_variable Retain the group variables in all cgi parameters listed with -retain_varlist X
-retain_varlist X Retain these groups of variables (comma seperated)
-flushclients Active stream flushing mode where least common clients are flushed (only use if short on ram)
-filterIn TYPE KEY Add an include data input filter;
TYPE can be any of ... URL, Visitor, Agent, Referral, Stat, VHost, Cookie, Username, Method, SessionReferral
KEY is your data that your are filtering, wildcards accepted
-filterexIn TYPE KEY Add an exclude data input filter
-sort X Sort all by [name | byte | hits | page]
-sessiontime [mins] Specify the length in minutes of non activity that defines a new session
-sessionLimit X Limits the number of pages appearing on each visitor session listing to X (default is 5000)
-dollar X Define the cost per MB in dollars, ie 0.05
-cookievar X Accept cookie parameters for user tracking
-urlsessionvar X Accept URL session variable for user tracking
-allhistoriesoff Turn OFF all History reports to save ram and speed up processing on large logs
-sessionhistoryoff Turn OFF all Click Streams Session to speed up processing, (you will loose dependant reports)
-timeslot X Define a timeslot interval for the timeslot report, (ranges are in minutes , only 1...60 makes sense )
-useplayerGUID In streaming mode only, use the media players GUID to define a unique user instead of their IP/Name.

--------- Group Mapping Options
-orgmap X=Y Add an organization map (*.com.*=Commercial)
-groups X=Y Add a url/content group map (/images/*=ServerImages)
-referralmap X=Y Add a referral url group map (*.yahoo.com=Yahoo Corp)
-advert X Define an advertising url based on adds served served locally
where X= Description,Filename,Click String
eg. MyProduct,/images/prodx.gif,/prodxpage.html
-advertcampaign X Define an advertising campaign based referral hits
where X= Description,Referral,Cost/Month ($)
eg. ProdX campaign,http://www.adhost.com/ProdXAd.html,1.50
-internalnetwork X Add an internet network IP filter (router only) where X=your local ip wildcard

--------- Tracking Options
-kvisitormap X Add a Key Visitor where X=visitor ip or name
-kpagetomap X Add a Key Pages To: where X=page url
-kpageto_depth X Define the number of pages to trace back
-kpageto_maxrows X Defines the maximum number of alternate routes to key pages
-kpagefrommap X Add a Key Pages From: where X=page url
-kpagefrom_depth X Define the depth of pages to trace forward
-kpagefrom_maxrows X Defines the maximum number of alternate routes from a key page

--------- Streaming Web Cast Options
-webcast_summary_template FILENAME
Enter the filename of the summary template to be used for the Streaming report. Typically, this will reside in the Funnel Web root folder under /Templates/Streaming/default_webcast_summary.html
eg. -webcast_summary_template /Applications/FW Analyzer Enterprise/5.0 /Templates/Streaming/default_webcast_summary.html

-webcast NAME STARTDATE,STARTTIME ENDATA,ENDTIME URL EXPECTEDVISISITORS
NAME .............. The name to be used as the title of the Webcast report
STARTDATE ......... The start date of the Webcast in your systems default date format eg. YYYY/DD/MM
STARTTIME ......... The start time of the Webcast in 24 hour format eg. HH:MM:SS
ENDDATE ........... The end date of the Webcast in your systems default date format eg. YYYY/DD/MM
ENDTIME ........... The end time of the Webcast in 24 hour format eg. HH:MM:SS
URL ............... The URL to be webcast. This can be either an individual file or a directory with a wildcard eg. /Webcast/*
EXPECTED VISITORS . Expected number of visitors for the webcast period. Used to determin success rating on the Webcast summary report

The following is an example of a Webcast for a certain URL:
eg. webcast "My webcast" 2002/08/18,12:00:00 2002/08/18,14:00:00 "mms://www.quest.com/Webcast/conference.asf" 200

--------- Billing Options
-billingsetup_outputformat (0,1) Where 0 is the default format of the rest of the report and 1 produces a separate Excel report
-billingsetup_outputfile FILE The output location of the Billing report if produced in Excel format eg. billingsetup_outputfile /Applications/FW Analyzer Enterprise/5.0 /Report/Billing.xls
-billingsetup_title "TITLE" Where TITLE is the name which will appear on the report produced
-billingsetup_currency "X" Where X is the currency symbol to be used on the report eg. $
-billingsetup_header_name (0,1) Turns on or off the Customer Name column of the Billing Report. (0 turns the column off and 1 turns it on)
-billingsetup_header_id (0,1) Turns on or off the Customer ID column of the Billing Report. (0 turns the column off and 1 turns it on)
-billingsetup_header_mbtrans (0,1) Turns on or off the MB Transferred column of the Billing Report. (0 turns the column off and 1 turns it on)
-billingsetup_header_mballow (0,1) Turns on or off the MB Allowance (0 turns the column off and 1 turns it on)
-billingsetup_header_maxconn (0,1) Turns on or off the Max Connections (0 turns the column off and 1 turns it on)
-billingsetup_header_xscharge (0,1) Turns on or off the Excess Charges (0 turns the column off and 1 turns it on)
-billingsetup_header_totalcharge (0,1) Turns on or off the Total Charges (0 turns the column off and 1 turns it on)
-billingcharges CUSTOMERNAME CUSTOMERID CUSTOMERDIRECTORY FIXEDRATE PERIOD TIMEUNIT PERIOD FIXEDUNIT SIZEUNIT EXCESS EXCESSCHARGE EXCESSUNIT SIZEUNIT
CUSTOMERNAME : Name of the customer being billed (Enclose in Quotes if spaces included)
CUSTOMER ID :ID Number of customer
CUSTOMERDIRECTORY The directory which the customer uses and is being charged for eg: http://customerone/
FIXEDRATE : The numeric amount of the fixed rate for the customer over the defined period eg. 0.005
PERIOD The numeric amount of the fixed rate period that the Customer is being charged for eg. for 7 days, enter 7
TIMEUNIT The unit of time the customer is being charged for (0,1,2,or 3) Enter 0 for Day(s), 1 for Week(s), 2 for Month(s) and 3 for Financial Quarters(3)
FIXEDUNIT The numeric amount of the fixed allowable amount of transferred data for the customer over the defined period eg. If the customer is allowed 10 Megabytes for the Fixed charge then enter 10
SIZEUNIT The unit of size the customer is being charged for (0,1,2,or 3) Enter 0 for Kilobyte(s), 1 for Megabyte(s), 2 for Gigabyte(s) and 3 for Terabyte(s)
EXCESS Defines if there are Excess charges beyond the fixed charges (0,1) Where 0 turns off Excess charges and 1 turns on Excess charges
EXCESSCHARGE The numeric amount of the excess rate size that the Customer is being charged for eg. for 10 MB, enter 10
EXCESSUNIT The numeric amount of the excess amount of transferred data the customer is charged for eg. If the customer is charged for every 11 MB over the Fixed rate, then Enter 11
SIZEUNIT The Excess unit of size the customer is being charged for (0,1,2,or 3) Enter 0 for Kilobyte(s), 1 for Megabyte(s), 2 for Gigabyte(s) and 3 for Terabyte(s)

The following is an example of a complete Billing setup for two customers who each have Fixed and
Excess charges. They Have Fixed charges of 0.55 cents for 2 Weeks at 200 Megabytes with Excess charges of $1.50 per 100 Megabytes

-billingsetup_outputformat 0 -billingsetup_outputfile /Applications/FW Analyzer Enterprise/5.0 /Report/Billing.xls
-billingsetup_title "Customer Billing" -billingsetup_currency "$"
-billingsetup_header_name 1
-billingsetup_header_id 1
-billingsetup_header_mbtrans 1
-billingsetup_header_mballow 1
-billingsetup_header_maxconn 1
-billingsetup_header_xscharge 1
-billingsetup_header_totalcharge 1
-billingcharges "Customer One" ID21 mms://www.questradio.com/ 0.55 2 1 200 1 1 1.50 100 1
-billingcharges "Customer Two" ID22 http://www.customertwo.com/directory/ 0.55 2 1 200 1 1 1.50 100 1

--------- Virtual Host Options
-multimonths Process a log file and generate a report for every month
-multiweeks Process a log file and generate a report for every week
-multivhosts Process a log file and extact virtual host info to create a host-by-host report
-multidomains Process multiple log files as multiple domains and not a combined report
-multitopdirs Process a log file and generate a report for every top level directory
-multitop2dirs Process a log file and generate a report for every second level directory
-multiclients Process a log file and generate a report for every visitor
-multicustomdirs Process a log file with a custom directory root path as the virtual host root for all next dirs
-multireport_path X Use this as the root path, Where X = Custom directory eg. /images/,/about/,/etc../
-sequencedir For all virtual hosts, use a squential numbered directory instead of its name
-vdsortby Sort the virtual host list in order of [name | byte | hits | page | date] or (0..5)
-editpath {site}={dir} : add a virtual host mapping dir, so {site} goes into {dir}
-vhostmap pattern newhostname : remap a patterned vhost into a new vhost name or identity
-weekstartday X Define which day the week starts on (0 ... 6) (sun/mon/tue/wed/thu/fri/sat)

--------- Cluster Options
-clustering_enabled Clustering is enabled
-clusters X Define the number of clusters in use
-defineCluster X Define a cluster member where X = 'name,ip,path'


--------- Network Options
+dns or -dnson Perform dns on visitor IPs
-dnsCache Perform dns on visitor IPs from cache
-dnsAmount X Number of max lookups (2...1000)
-dnr_ttl X Number of seconds for unresolved IPs to timeout
-dnr_expire X Number of days the resolved IP will be kept in cache
-dnrfile X Use file X as the cache for DNR queries
-dns_server X Specify a different dns server to use for lookups
-dns_timeout X Timeout for lookups
-dns_retries X Amount of retries for lookups
-ftp_passive Enable all ftp operations to be passive (best for firewalls)
-remotetitle Enable remote page titles in pages reports, ie to resolve urls. Note: This feature requires a direct internet connection

--------- Old Report Summary Options
-timestat Include time processing information in report
-notimestat Don't include time processing information in report
-bandwidth Include bandwidth information in report
-nobandwidth Don't include bandwidth information in report
-headtitle Include log name in report header
-noheadtitle Do not place the log name in the report header
-server_bandwidth X Define the server bandwidth for report reference (x=bps)

--------- Pre and Post Processing Options
-post_zipreport Archive the report into a zip file
-postproc_deletereport Delete report after zipping
-post_compresslog Compress the processed log into a gziped log
-postproc_deletelog Delete above original log after compressing

--------- Email Options
-post_emailon Activate email notification
-post_email X Recipient email address
-post_emailfrom X Senders email address
-post_emailsub X Subject of email content (if spaces in text, must enclose in "quotes")
-post_emailsmtp X Address of your outgoing mail server, ie SMTP host.
-post_emailattachreport Attach the zipped report to the email, NOTE: may become large
-post_emailmsg X Content of email, (if spaces in text, must enclose in "quotes")

NOTE: if you have many parameters to use, then place them in a settings
file with the first line being '#Funnelweb' or use the -saveprefs FILENAME command when processing to save all settings to the specified filename

Greg Stehle
Funnel Web Analyzer

This site looks best using Safari or FireFox.

Get Firefox!