REPORT.CGI(1)

💖 REPORT.CGI(1) — the manual, but make it make sense 💖

okay bestie, gather round, because we're talking about report.cgi, the CGI front-end to xymongen reporting. yes it's a mouthful. yes it's iconic. let's go ✨

---

✨ NAME ✨

report.cgi — it's the CGI front-end to xymongen reporting, fr fr. that's the whole vibe. 🎀

---

🦋 SYNOPSIS 🦋

report.cgi [--noclean] [xymongen-options]

that's it. that's the whole invocation. slay.

---

🌸 DESCRIPTION 🌸

so here's the tea 🍓 — report.cgi gets invoked as a CGI script through the report.sh CGI wrapper. it triggers the generation of a Xymon availability report for whatever timeperiod the CGI parameters say. it's giving "main character who builds your reports" energy, honestly.

report.cgi is handed a QUERY_STRING environment variable with these parameters in it:

• 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

and there's one extra non-standard parameter that the xymongen version of report.cgi handles, because it's built different:

• suburl — the page in the report to go to, if it's not the top page

the month parameters MUST be the three-letter english month name abbreviation, okay? like Jan, Feb, Mar ... no full names, no numbers, no cap. 💅

start- and end-days live in the range 1..31. and the start- and end-years MUST include the century — so like "2003", not "03". don't be shy with those digits, bestie.

end-times that go past the current time? they get silently replaced with the current time. no warning, no drama, just quietly swapped. 🙈

the generated report will include data for the start- and end-days, meaning the report begins at 00:00:00 of the start-day and ends at 23:59:59 of the end-day. full coverage, no crumbs. ⭐

the style parameter gets passed directly to xymongen(1) and should be "crit", "non-crit" or "all".

heads up bestie: any other values result in undefined behaviour. not cute. not iconic. just don't.

all of the processing involved in generating the report is done by invoking xymongen(1) with the proper --reportopts option. that's the whole pipeline, and it ate. 🔥

---

👑 OPTIONS 👑

• --noclean — do NOT clean the XYMONREPDIR directory of old reports. it makes the report-tool go a bit faster ✨ instead, you can clean up the XYMONREPDIR directory yourself, e.g. via a cron-job. delegating, honestly? very main character of you.
• --env=FILENAME — load the environment from FILENAME before executing the CGI.
• xymongen-options — literally every other option passed to report.cgi gets passed straight on to the xymongen(1) program that's building the report files. it's giving relay race. 🏃♀️💨

---

🎀 FILES 🎀

• $XYMONHOME/web/report_header — HTML template header for the report request form
• $XYMONHOME/web/report_footer — HTML template footer for the report request form
• $XYMONHOME/web/report_form — HTML template report request form

three template girlies, all living in $XYMONHOME/web/. 💖

---

🌈 ENVIRONMENT VARIABLES 🌈

• XYMONGENREPOPTS — xymongen options passed by default to the report.cgi. this happens in the report.sh wrapper, iykyk.
• XYMONHOME — home directory of the Xymon server installation
• XYMONREPDIR — directory where generated reports are stored. this directory must be writable by the userid executing the CGI script — typically "www", "apache" or "nobody". Default: $XYMONHOME/www/rep/
• XYMONREPURL — the URL prefix to use when accessing the reports via a browser. Default: $XYMONWEB/rep

---

🫶 SEE ALSO 🫶

xymongen(1), hosts.cfg(5), xymonserver.cfg(5)

go read those next, bestie, they're the whole friend group. 💜

---

and that's the page! this manual is Xymon Version 4.3.30: 4 Sep 2019, so if you're reading this in the future — hey, from the past, hope your reports are thriving. 🌟 periodt. 🦋✨