bb-datepage.cgi(1) [debian man page]

BB-DATEPAGE.CGI(1)					      General Commands Manual						BB-DATEPAGE.CGI(1)

NAME

       bb-datepage.cgi - Xymon CGI script to view pre-built reports by date

SYNOPSIS

       bb-datepage.cgi?type={day,week,month} --url=URLPREFIX [options]

DESCRIPTION

       bb-datepage.cgi is invoked as a CGI script via the bb-datepage.sh CGI wrapper.

       bb-datepage.cgi	is  passed  a  QUERY_STRING  environment variable with the type of time-selection that is desired: Either "day", "week" or
       "month" can be requested. It will then generate a web form with appropriate day/week/month selection boxes, and based on the users'  selec-
       tion a resulting url is built from the URLPREFIX and the time selection.  The browser is then redirected to this URL.

       The  URL  is  constructed from the URLPREFIX, the type-parameter, the value of the "pagepath" or "host" cookie, and the users' selection as
       follows:

       type=day
	      The final URL is URLPREFIX/daily/YEAR/MONTH/DAY/PAGEPATH.

       type=week
	      The final URL is URLPREFIX/weekly/YEAR/WEEK/PAGEPATH.

       type=month
	      The final URL is URLPREFIX/monthly/YEAR/MONTH/PAGEPATH.

	      YEAR is the full year (4 digits, including century). MONTH is the two-digit number of the month (01..12). DAY is the number  of  the
	      day in the month (01..31). WEEK is the ISO 8601:1988 week-number (01..53). PAGEPATH is the current value of the "pagepath" cookie if
	      set; if it is not set but the "host" cookie is set, then this host is looked up in the bb-hosts file and the page where this host is
	      found is used for PAGEPATH. These two cookies are set by the default web-header templates supplied with Xymon.

OPTIONS

       --url=URLPREFIX
	      This specifies the initial part of the final URL. This option is required.

       --hffile=FILENAME
	      Specifies the template files (from $BBHOME/web/) to use. The default is "--hffile=report".

       --color=COLOR
	      Sets the background color of the generated webpage. The default is blue.

       --env=FILENAME
	      Loads the environment defined in FILENAME before executing the CGI script.

       --debug
	      Enables debugging output.

       $BBHOME/web/report_form_daily
	      HTML form template for the date selection form when type=daily.

       $BBHOME/web/report_form_weekly
	      HTML form template for the date selection form when type=weekly.

       $BBHOME/web/report_form_monthly
	      HTML form template for the date selection form when type=monthly.

       $BBHOME/web/report_header
	      HTML header file for the generated web page

       $BBHOME/web/report_footer
	      HTML footer file for the generated web page

ENVIRONMENT VARIABLES

       BBHOME Used to locate the template files for the generated web pages.

       QUERY_STRING
	      Contains the parameters for the CGI script.

SEE ALSO

       bbgen(1), bb-hosts(5), hobbitserver.cfg(5)

Xymon							    Version 4.2.3:  4 Feb 2009						BB-DATEPAGE.CGI(1)

BB-REP.CGI(1)						      General Commands Manual						     BB-REP.CGI(1)

NAME

       bb-rep.cgi - CGI front-end to bbgen reporting

SYNOPSIS

       bb-rep.cgi [--noclean] [bbgen-options]

DESCRIPTION

       bb-rep.cgi  is  invoked	as  a CGI script via the bb-rep.sh CGI wrapper.  It triggers the generation of a Xymon availability report for the
       timeperiod specified by the CGI paramaters.

       bb-rep.cgi is passed a QUERY_STRING environment variable with the following parameters:

	  start-mon (Start month of the report)
	  start-day (Start day-of-month of the report)
	  start-yr  (Start year of the report)
	  end-mon   (End month of the report)
	  end-day   (End day-of-month of the report)
	  end-yr    (End year of the report)
	  style     (Report style)

       The following non-standard parameters are handled by the bbgen version of bb-rep.cgi:

	  suburl    (Page in report to go to, if not the top page)

       The "month" parameters must be specified as the three-letter english month name abbreviation: Jan, Feb, Mar ...

       Start- and end-days are in the range 1..31; the start- and end-year must be specified including century (e.g. "2003").

       End-times beyond the current time are silently replaced with the current time.

       The generated report will include data for the start- and end-days, i.e. the report will begin at 00:00:00 of the  start-day,  and  end	at
       23:59:59 of the end-day.

       The "style" parameter is passed directly to bbgen(1) and should be "crit", "non-crit" or "all". Other values result in undefined behaviour.

       All of the processing involved in generating the report is done by invoking bbgen(1) with the proper "--reportopts" option.

OPTIONS

       --noclean
	      Do  not clean the BBREP directory of old reports. Makes the report-tool go a bit faster - instead, you can clean up the BBREP direc-
	      tory e.g. via a cron-job.

       --env=FILENAME
	      Load the environment from FILENAME before executing the CGI.

       bbgen-options
	      All other options passed to bb-rep.cgi are passed on to the bbgen(1) program building the report files.

FILES

       $BBHOME/web/report_header
	      HTML template header for the report request form

       $BBHOME/web/report_footer
	      HTML template footer for the report request form

       $BBHOME/web/report_form
	      HTML template report request form

ENVIRONMENT VARIABLES

       BBGENREPOPTS
	      bbgen options passed by default to the bb-rep.cgi. This happens in the bb-rep.sh wrapper.

       BBHOME Home directory of the Xymon server installation

       BBREP  Directory where generated reports are stored. This directory must be writable by the userid  executing  the  CGI	script,  typically
	      "www", "apache" or "nobody". Default: $BBHOME/www/rep/

       BBREPURL
	      The URL prefix to use when accessing the reports via a browser.  Default: $BBWEB/rep

SEE ALSO

       bbgen(1), bb-hosts(5), hobbitserver.cfg(5)

Xymon							    Version 4.2.3:  4 Feb 2009						     BB-REP.CGI(1)