Red Hat help


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.

Tip: For a view of what this looks like in action, see any of the advanced installation scenarios under Install TeamForge the advanced way.
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. This is the master configuration file that controls your TeamForge site.
    • vi /opt/collabnet/teamforge-installer/6.1.1.0/conf/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:
    HOST_localhost=app database subversion cvs etl datamart
    Note: The app attribute is the only one that must be present for this variable. The other attributes may be assigned to other HOST variables, if those services are running on different machines. See Install TeamForge the advanced way for a detailed view of how this works.
  3. Add these variables (or uncomment them, if they are already present) and give them the appropriate values:
    • REPORTS_DATABASE_NAME=ctfrptdb
    • REPORTS_DATABASE_PASSWORD=ctfrptpwd
    • REPORTS_DATABASE_USERNAME=ctfrptuser
    • REPORTS_DATABASE_READ_ONLY_USER=ctfrptreadonly
    • REPORTS_DATABASE_READ_ONLY_PASSWORD=rptropwd
  4. If you want your datamart to use a different port than your site database, you can also add the REPORTS_DATABASE_PORT variable:
    • REPORTS_DATABASE_PORT=5632
  5. To enable Web services access to your datamart, add these variables:
    • ETL_SOAP_SHARED_SECRET=<arbitrary_string>
    • SOAP_ANONYMOUS_SHARED_SECRET=<arbitrary_string>
  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've changed, then save the site-options.conf file.