Usage Reports

Usage Reports is the modern way to gather information and gain oversight across your instance instead of using Relativity scripts, such as Billing Statistics – RelativityOne Case Rollup. Typically, metrics presented in Usage Reports are used for end-client billing, tracking adoption, and general usage metrics. System and Client Domain Administrators can create custom reports at the instance level to report on their workspace utilization and Processing consumption metrics for billing and usage tracking.

Some Usage Reports fields contain data that is also present in the Billing Statistics – RelativityOne Case Rollup script, although these fields have been renamed in Usage Reports to ensure they accurately describe what they contain. See Field mapping between Usage Reports and Billing Statistics Script for more information on the mapping between the two report outputs.

For a complete list of fields available in the Usage Reports, see the Community article.

Permissions

System Administrators and Client Domain Administrators need the following minimum Instance-level security permissions to access and generate Usage Reports. Users must belong to a group that is added at the instance level and has access to the tabs. For more information on how to set the right permissions, see Setting instance permissions.

Tab Visibility Admin Operations
Management Console and Usage Reports
  • View Admin Repository
  • View Usage Reports

Note: When generating a report, a Client Domain Administrator’s report only contains usage information for the workspaces in their client domain. Additionally, the Usage Reports List also only contains reports that are from their client domain and not from other client domains.

Creating Usage Reports

To create a new Usage Report:

  1. Navigate to the Usage Reports tab in Management Console.
  2. Click New Report.
  3. Enter or select values for the following fields:

Report Settings tab of Usage Reports

  • Report Name—enter a unique name to identify the report.
  • Year—select the year you wish to report on.
  • Month—select the month you wish to report on.
  1. Click Next.
  2. On the Select Data tab, choose the desired metrics under the Workspace Utilization, Product Utilization, and Processing Statistics sections that you want to include in the report. You must choose at least one field in any of the sections. To select all metrics in a section, click the checkbox next to the Metric Name column heading.

Select Data tab of Usage Reports

Every report will contain these fields by default:

  • Instance Name—the RelativityOne Instance from which the report was generated.
  • Workspace Name—the name of the Workspace.
  • Client Name—the name of the Client associated to the workspace. If the workspace is deleted, no value is shown.
  • Matter Name—the name of the Matter associated to the workspace. If the workspace is deleted, no value is shown.
  • Workspace Utilization Capture Date-Time—the date and time that all the Workspace Utilization metrics were captured from the Instance. This value is shown in UTC.
  • Processing Metrics Date-Time—the date and time that all the Processing metrics were captured from the Instance. This value is shown in UTC.
  1. Review the information on the Report Summary tab to confirm the report criteria is correct. To make changes, click the Back button or click any of the side tabs to go to those sections.

Report Summary tab of Usage Reports

  1. Click Generate Report to create the report. The newly created report appears on the Usage Reports List. Reports are retained on the list for 30 days from their creation date.

Note: Usage Reports data is updated on a daily basis.

Run report list

  1. Click the report name link to view its details in the report viewer. For a complete list of fields available in the Usage Reports, see the Community article.

Report viewer

    Notes:
  • All “Peak” references pertain to the individual peak value per workspace in the reported date range.
  • Processing metric fields show the total size/values for the given date range.
  • Depending on your security configurations within RelativityOne, you may find that Client Name, Matter Name, Client Number, and Matter Number fields display hashed values. For more information, see Hash value instance settings for billing metrics.

Exporting Usage Reports

You can export a report to an Excel file from the following areas:

  • From the Usage Reports List: Click the download icon in the Actions column corresponding to the desired report.
  • From the report viewer page: Click the Export button.

Field mapping between Usage Reports and Billing Statistics Script

We’ve simplified the names of some key metric fields in Usage Reports. Refer to the following table for the equivalent Billing Statistics Script field names. Although the fields are named differently, they show the exact same data.

Usage Report Field Name Billing Statistic Script Field Name Description
Report Period Year Month The month and year for which the workspace utilization metrics covers. The format is MM/YYYY.
Current Workspace Hosted Size Current Billable File Size GB The total size of all Natives, Images, and Produced Images in the workspace at the date and time the workspace utilization metrics were captured.
Peak File Count File Count The largest count reached of all files (including but not limited to Natives, Images, and Produced Images) in storage for the workspace in the given month.
Peak File Size GB File Size The largest total size reached of all files (including but not limited to Natives, Images and Produced Images) in the workspace in the given month.
Peak Document Count Document Count The largest total document count reached in the workspace in the given month.
Peak Document Count Text Only Document Count Text Only The largest total number of documents reached that do not have any associated Natives, Images, or Produced Images in the workspace in the given month.
Peak Workspace Hosted Size Total Billable File Size The largest summed size reached of all Natives, Images, and Produced Images in the workspace in the given month.
Peak Image File Size Image File Size The largest summed size reached of all Image files. This value is taken from the same day as the Peak Workspace Hosted Size.
Peak Native File Size Native File Size The largest total size reached of all Native files. This value is taken from the same day as the Peak Workspace Hosted Size.
Peak Production File Size Production File Size The largest total size of all Production Files. This value is taken from the same day as the Peak Workspace Hosted Size.
Linked Total File Size GB Linked Total Billable File Size The total file size of data linked to another workspace. This value is taken from the same day as the Peak Workspace Hosted Size. Workspace data is linked using Integration Points.