Report types have functional names to describe their content,
for example, Capacity and Build. For each report type, this topic
describes the report purpose, the report fields, and report examples.
- Analytic
- Description: Use the analytic report type to report on
job performance at the step level using step duration and step execution
order.
- Report Examples:
- Create a table report to show step duration and step sequence
for each step included in a job. Group the jobs by project name.
- Create a line chart report to show the step duration for each
build tag. Group the build tags by step name.
- Field Descriptions:
Field Name |
Description |
Build Tag |
The job tag is a unique identifier based on the project tag
format. |
Project Name |
The user-assigned project name. |
Step Duration |
The total run time in seconds for the step and any steps
it inlined. |
Step Name |
The user-assigned step name. |
Step Sequence |
A number that identifies the step run order. |
- Build
- Description: Use the build report type to report on job
performance at the project level.
- Report Examples:
- Create a table report to show the build results, start time, and
duration for each build tag. Group the build tags by project.
- Create a bar chart report to show the build count for each project.
Group by project.
- Field Descriptions:
Field Name |
Description |
Build Count (aggregate field) |
The total job count, including completed and failed jobs. |
Build Duration |
The total job run time in seconds. |
Build Result |
The job result: passed, passed with warnings, or failed. |
Build Start Time |
The job start time. |
Build State |
The build state: running, complete, archived, or locked. |
Build Tag |
The job tag is a unique identifier based on the project tag
format. |
Project Name |
The user-assigned project name. |
Selector Name |
The user-assigned selector name. |
User Login |
The Build Forge login or user name of the user who started
the job. |
User Name |
The name of the user who started the job. |
- Capacity
- Description: Use the capacity report type to report on
job performance by project.
- Report Examples:
- Create a table report to show the build start, build duration,
build average duration, and build results for each build tag. Group
the build tags by project.
- Create a chart report to show the average build time for each
project. Group the projects by selector.
- Field Descriptions:
Field Name |
Description |
Build Average Duration (aggregate field) |
The average job run time based on the total number of jobs,
both completed and failed. |
Build Duration |
The total job run time in seconds. |
Build Result |
The job result: passed, passed with warnings, or failed. |
Build Start Time |
The job start time. |
Build Tag |
The job tag is a unique identifier based on the project tag
format. |
Last Build Duration (aggregate field) |
The run time for the last job. The total time (in seconds)
to complete the last job. |
Project Name |
The user-assigned project name. |
Selector Name |
The user-assigned selector name. |
- Project
- Description: Use the project report to report on server,
environment, and step usage by project and to report on step performance
by project.
- Report Examples:
- Create a table report to show the project, class name, and project
environment. Group projects by server.
- Create a table report to show the step, step result, step sequence,
step environment, and server. Group steps by project and sort by step
sequence.
- Create a bar chart report to show the step count for each step.
Group the steps by step result.
- Field Descriptions:
Field Name |
Description |
Class Name |
The user-assigned class for the project, for example, production
or test. |
Failed Step Count (aggregate field) |
The number of steps that failed for the group field that
you select; for example, project or server or other field name. |
Passed Step Count (aggregate field) |
The number of steps that passed for the group field that
you select; for example, project or server or other field name. |
Project Environment Name |
The name of the project environment used to define project
environment variables. |
Project Level |
The user-assigned access group for the project. |
Project Name |
The user-assigned project name. |
Server Name |
The user-assigned server name. |
Step Count (aggregate field) |
The total number of steps for the group field that you select,
for example, project or server. |
Step Environment Name |
The name of the step environment used to define environment
variables for the step. |
Step Level |
The user-assigned access group for the step. |
Step Name |
The user-assigned step name. |
Step Result |
The step result: passed, passed with warnings, or failed. |
Step Sequence |
A number that identifies the step run order. |
- Step Metrics
- Description: Use the step metrics report to report on step
success and failure statistics by project.
- Report Examples:
- Create a table report to show the step name, step count, and the
percentage of steps that passed and failed. Group the steps by project.
- Create a line chart report to show the step duration by build
tag. Group build tags by step name.
- Field Descriptions:
Field Name |
Description |
Build Tag |
The job tag is a unique identifier based on the project tag
format. |
Percent Steps Failed (aggregate field) |
The percentage of failed steps out of the total step count.
The total step count is for the group field you select, for example,
projects. |
Percent Steps Passed (aggregate field) |
The percentage of passed steps out of the total step count.
The total step count is for the group field you select, for example,
projects. |
Project Name |
The user-assigned project name. |
Server Name |
The user-assigned server name. |
Step Average Duration (aggregate field) |
The average step run time based on the total number of steps,
both completed and failed. |
Step Count (aggregate field) |
The total step count, including completed and failed steps.
The total step count is for the group field you select, for example,
projects. |
Step Duration |
The total run time in seconds for the step and any steps
it inlined. |
Step Name |
The user-assigned step name. |
Step Result |
The step result: passed, passed with warnings, or failed. |
Step Sequence |
A number that identifies the step run order. |
Step Start Time |
The step start time. |
- Quality
- Description: Use the quality report to report on job success
and failure statistics by project.
- Report Examples:
- Create a table report to show the build results by build tag.
Group the build tags by project.
- Create a table report to show the percentage of all builds that
passed and failed by project. Group by project.
- Create a bar chart report to show the build count by project.
Group the projects by build result.
- Field Descriptions:
Field Name |
Description |
Build Count (aggregate field) |
The total job count, including completed and failed jobs. |
Build Result |
The job result or status: passed, passed with warnings, or
failed. |
Build Start Time |
The job start time. |
Build Tag |
The job tag is a unique identifier based on the project tag
format. |
Percent Builds Failed (aggregate field) |
The percentage of failed builds out of the total build count.
The total build count is for the group field you select, for example,
projects. |
Percent Builds Passed (aggregate field) |
The percentage of passed builds out of the total build count.
The total build count is for the group field you select, for example,
projects. |
Project Name |
The user-assigned project name. |
- Resource
- Description: Use the resource report to report on step
and job performance by projects and servers.
- Report Examples:
- Create a table report to show step run times by server. Select
the step sequence, step name, server name, step start time, and step
duration. Sort by step sequence and start time.
- Create a table report to show the job run times by server. Select
the build tag, server name, build start time, build duration, and
build result. Group the build tags by project and sort by build start
time.
- Field Descriptions:
Field Name |
Description |
Build Duration |
The total job run time in seconds. |
Build Result |
The job result: passed, passed with warnings, or failed. |
Build Start Time |
The job start time. |
Build Tag |
The job tag is a unique identifier based on the project tag
format. |
Project Name |
The user-assigned project name. |
Selector Name |
The user-assigned selector name. |
Server Name |
The user-assigned server name. |
Step Duration |
The total run time in seconds for the step and any steps
it inlined. |
Step Sequence |
A number that identifies the step run order. |
Step Start Time |
The step start time. |
- BOM
- Description:
- Use the BOM report to create a report using information in the
job BOM. The BOM report can run against any of the following data
sets:
- all projects in the database (the default)
- a single project
- one or more builds in a single project
The report fields that you can select vary by data set. Report
fields might include step manifest properties, output from the .scan
command, output logged by adaptors, and user-defined columns specified
using the .bom command.
- Report Examples:
- Create a table report to show the output of the .scan command
across multiple projects. Select the build tag, BOM data, BOM path,
and BOM type fields. Group the build tags by project.
- Create a table report to show the number of times that a filter
action is invoked across multiple projects. Select the step name,
filter event count type, and filter count. Group the steps by project.
- Field Descriptions:
Field Name |
Description |
BOM Data |
If you include the .scan checkpoint command
in a project, for the files scanned, the BOM Data field displays MD5
values. |
BOM Path |
If you include the .scan checkpoint command
in a project, for the files scanned, the BOM Path field displays the
file path. |
BOM Type |
If you include the .scan checkpoint command
in a project, for the files scanned, the BOM Type field indicates
whether the path is D (a directory), F (a file), or S (a symbolic
link). |
Build Tag |
The job tag is a unique identifier based on the project tag
format. |
Filter Event Count |
The number of times that the filter action was invoked by
the filter as a result of finding a pattern match in step output. |
Filter Event Count Type |
The filter action that was invoked by the filter when a pattern
match in step output was found. |
Project Name |
The user-assigned project name. |
Result Description |
The description field in the result record, which typically
contains a copy of the step name. |
Step Name |
The user-assigned step name. |
Selector Name |
The user-assigned selector name. |
Server Name |
The user-assigned server name. |
Step Duration |
The total run time in seconds for the step and any steps
it inlined. |
Step Result |
The step result: passed, passed with warnings, or failed. |