Turn on site-wide reporting

To use the site-wide reporting functionality, you have to configure a collection of variables in the site-options.conf file.

Note: Site administrators can view the status of the ETL server in System Tools > Server Status. The status displays the following values:
  • "OK" if enabled and running
  • "N/A" when disabled
  • "Could not connect" when enabled and not running
  1. Open the site-options.conf file, the master configuration file that controls your TeamForge site.
    • vi /opt/collabnet/teamforge/etc/site-options.conf
    Note: vi is an example. Any *nix text editor will work.
  2. Comment out the default HOST_localhost=app database subversion cvs variable, then add (or uncomment) the variable that has the reporting services enabled:
  3. Add these variables (or uncomment them, if they are already present) and give them the appropriate values:
  4. If you want your datamart to use a different port than your site database, we recommend the following:
    • For small dataset customers: use the same instance as that of ctfdb; leave REPORTS_DATABASE_PORT commented.
    • For medium to large dataset customers: use a separate instance by setting REPORTS_DATABASE_PORT=5632.
  5. For ETL to function, add these variables:
    • ETL_SOAP_SHARED_SECRET=<arbitrary_string>
    • SOAP_ANONYMOUS_SHARED_SECRET=<arbitrary_string>
    Tip: For more information about configuring variables, see site-options.conf.
  6. Set the time you want the reporting data to be collected, if different from the default 2:30 a.m. (local time).
    • ETL_JOB_TRIGGER_TIME=<cron expression>
    Tip: This value is a cron expression, not a time value. See ETL_JOB_TRIGGER_TIME for more.
  7. Review the variables you have changed, then save the site-options.conf file.