Generate the release audit report

You can generate an audit report for all the releases executed through Release, detailing full traceability and auditability to deliver to the auditors. You can generate an audit report for all of the releases that are in progress, completed, or archived. For more details about the structure of the audit report, see Release audit report.

Generate release audit report

To generate an audit report for a release:

  1. In the top bar, click Releases.
  2. Open a release and select Release flow from the Show menu.
  3. On the right side, click the Export drop-down.
  4. Select Release audit report (Excel) and save the file on your machine.

Generate audit report for multiple releases

You can generate a zip package that contains multiple audit reports. The package contains one audit report (Excel file) for each release.

To generate the audit report for multiple release:

  1. In the top bar, go to Reports.
  2. Click the Release audit report tab.
  3. Click Filter report data.
  4. Under Filter report data on the right, select the time period for the releases.
  5. Add or remove filters from the list.
  6. Click Preview results to view a list of release audit reports that match the criteria you provided.
  7. Click Generate report. When the report is finished you will receive an email with a link to download the report.

    • Note While reports are in the process of being generated, the Generated reports list will also show the progress of the reports.

Note: You can generate a maximum number of two reports at the same time.

Generated reports

Filters

You can filter the releases that you want to be part of the audit report .zip package. Under Filter report data, click Add filter and select one of the available filter criteria:

  • Parent folder
  • Release tags
  • Release title
  • Change number
  • Application
  • Environment

To remove a filter, click delete.

Generate the audit report through the API

A generic API endpoint allows you to generate an audit report. This endpoint is /api/v1/reports/download/{reportType}/{releaseId:.*Release[^/]*}

For example

GET /api/v1/reports/download/xlrelease.ReleaseAuditExcelReport/Applications/Release162151faba694d03aa3065665cf26f21

The API uses the following parameters:

Name Description
reportType Synthetic type of the release port; for example, xlrelease.ReleaseAuditExcelReport
releaseId Full identifier of the attachment; for example, Applications/Folder1/Release1

APIs for contributing data

In addition, public APIs are available, enabling you to contribute data to the Release Audit Report when using certain custom or community plugins (integrations). This is limited to the tools in the area of:

  • Plan (e.g. Jira, ServiceNow, Rally, etc.)
  • Build (Jenkins, Circle CI, etc.)
  • Security & Compliance (Sonar, Fortify, Sonatype, Blackduck, etc.),
  • ITSM (ServiceNow, BMC Remedy, etc.)
  • Deployments (Deploy, Ansible, uDeploy, etc.)

For more information, see task reporting records.

User Management Audit Report

To generate the user management audit report:

  1. In the top bar, go to Reports.
  2. Click the User Management Audit Report tab.
  3. Select the option All Folders or Select Specific Folder from the dropdown.

    Note: To generate global level report, select All Folders or to generate for a project specific, select Select Specific Folder.

  4. Click Generate report.

Note: The audit report generates an Excel(.xsl) file format and you can save the file on your machine.