Generate a report to get a snapshot of what is going on in a
project. You
can generate reports on data stored in both TeamForge's
production (operational) database or datamart. Datamart, also known as the Reporting
database, is built by extracting, transforming and loading (ETL) TeamForge's
production data to a separate database (datamart) at regular
intervals.
Important:
Unless otherwise stated, you must have datamart enabled on your site to create
reports in TeamForge.
Note that a few Distribution
reports use data from TeamForge's
operational database and a few Activity
Reports use data from the EventQ's event data store.
You can specify the time at which the
reporting data is refreshed from the production database. By default, the extraction
takes place daily at 2:30 a.m. in the TeamForge application server's time zone. See
Schedule data extraction for reporting.
Configure a collection of variables in the site-options.conf
file to use site-wide reporting functionality. See Turn on site-wide reporting and the TeamForge
Administration Guide for more details.
You can use reports to display data and group relevant information appropriately
and specify intervals at which the datamart extracts TeamForge
data from the datamart. For advanced reporting options and datamart information,
see Advanced reporting and datamart access.
You can also use external reporting tools to connect to the datamart and generate
customized reports. See Datamart access using external tools.
Reporting framework
Here's a list of some of the advantages of the new reporting framework:
- Reporting under one umbrella with a central dashboard of reports.
- Cross-project reporting capability.
- Tracker custom defined fields are in data-mart and can be used to
filter.
- All events are captured via EventQ event data-store.
- You can query and write custom reports.
- All data, including event, associations, and traceability data, can be
queried through an elegant API for custom reporting and data
extraction.
- High charts-based interactive data visualization charts. You can hover over
the charts to see data points, click legends in the chart to toggle specific
data point in and out of the chart and so on.
- You can drill one level down on some of the activity
reports using column charts to get more clarity on the data points of your
interest.
- Categorization of reports.
- Improved usability: Hassle free report creation with new widgets for
selecting report criteria such as planning folders, trackers and
repositories.
- Ability to save 'Public' and 'Private' reports: While 'Public' reports are
visible to all project members with view reports permission, 'Private'
reports are only for your consumption. You cannot publish 'Private' reports
in project pages.
Reports: Role based access
control
In general,
TeamForge
site and project administrators, and users with tracker and task view permissions
can see the
REPORTS button on the project navigation bar.
- Object-based access permissions: If you are a
TeamForge
user, your ability to create, edit, preview or view reports depends on
whether you have permission to access specific objects such as trackers and
repositories in TeamForge.
For example, to generate a report on the number of SCM commits in a
repository, you must have permission to access the repository. Otherwise, a
message such as You do not have sufficient permission to
perform this operation is displayed.
- Task and Tracker reports (Table reports): Task and Tracker
View permission is required to generate task and tracker
reports. You must have View Activity permission or
object-level permission to view Activity reports such as SCM Commits, Build
Activity, Build and Test Activity, Artifact Created and Artifact Closed
reports.
- Context-sensitive access permission: Reports are shown or hidden from
users based on the context. For example, a user must have View
Project Page permission to view reports published on a
project home page.
- Deleting reports: Site and project administrators can delete reports.
In addition, you can delete your own reports.