RelativityOne Usage Reports

Only Available for RelativityOne Connections

Relativity only offers its usage report feature for RelativityOne instances. As such, the features discussed in this article do not apply to Relativity Server connections. If you are connecting to a Relativity Server instance, refer to the Agility Blue Services: A Relativity Application documentation for details on collecting daily statistical data from that instance.

Introduction

In RelativityOne, system administrators and client domain administrators with the appropriate permissions are able to generate usage reports within the management console at the instance level. These reports can be configured to deliver a variety of metrics that are typically used for tracking billing data, trend analysis, and feature adoption for all workspaces in a given month.

Agility Blue can be configured to automatically create, collect, and report on these usage metrics for Relativity workspaces linked to Agility Blue matters on a daily schedule. A range of features in Agility Blue help streamline your connection to RelativityOne for usage reports, including:

• Metrics Settings

  You can select specific metrics to report on, matching all available metrics in RelativityOne. Agility Blue automatically detects and offers new metrics added by Relativity, ensuring seamless updates with no additional configuration required.

• Layout and Presentation

  Control the order and display of metrics within a linked Relativity workspace panel using a simple drag-and-drop layout builder. Emphasize important metrics by choosing between large stat boxes, displayed in a grid layout or traditional stat rows, displayed in a stacked list format.

• Visualize Data

  View collected metrics for any month within a linked Relativity workspace panel in the matter details page. Focus in on a specific metric to view a data grid with all monthly collected data, which can be filtered or exported and view a chart that visualizes trends over any time period for number-based metrics.

• Download Reports

  The same CSV report file that can be exported from RelativityOne is available for direct download in Agility Blue for the last 30 days of collected reports.

• Extensibility

  Extend the usability of collected Relativity usage report metrics for custom billing workflows or applying metric data elsewhere in Agility Blue. Leverage Agility Blue’s REST API, scripting, or custom reports to integrate metrics into your workflows as needed.

Configuration

Within your Agility Blue workspace, click on the settings dropdown cog icon and choose the Settings option. On the left, click on the integrations section tab.

Click on the RelativityOne Metrics Settings button to launch a window that provides configuration option tabs related to what metrics to collect, the layout, data, and miscellaneous settings.

When configuring the metrics settings, you should move left to right through the tabs. If a tab has a Save button, be sure to save your changes on that tab before moving to another tab or closing the window.

Metrics Tab

The metrics tab lists out all of the available metrics that RelativityOne provides for setting up a Relativity usage report.

Select the metrics that you would like Agility Blue to collect on. You will see metrics with a Default label — these metrics are collected automatically and cannot be unselected. In order for Agility Blue to begin collecting usage report metrics from Relativity, you must select at least one or more non-default metric. After selecting metrics you would like to collect, click on the Save button. Agility Blue will begin collecting the metrics by instructing Relativity to create a new usage report during the next scheduled collection cycle. The collection cycle happens in the morning and will create a new usage report in Relativity each day to collect from. To initiate a manual collection or to view more details of a collection, see the Data tab.

Layout Tab

The layout tab provides a layout builder you can use to change how metrics are displayed and how they are ordered.

Areas of the layout tab:

1. Preview button
   Click on this button to see a preview of how the metrics will look at any point while building your layout prior to saving.

2. Stat Boxes layout section

   A Stat Box is a visual component that displays a metric in a larger, box-like container next to other boxes in the same layout useful for placing emphasis or draw attention to a metric. Metrics in this category show above stat row metrics and are placed within a grid layout that shows up to 4 boxes per row. For positioning in the layout builder, each metric will be displayed left to right in each grid row. Click on the Preview button at any point to see exactly how the system will display the metrics at any time.

3. Stat Rows layout section

   A Stat Row is a visual component that displays a single metric stacked with other metrics in the same layout. Metrics in this category show below stat box metrics and are placed within a stacked list layout that shows up to 1 metric per row. Click on the Preview button at any point to see exactly how the system will display the metrics at any time.

4. Metric item

   You can drag and drop the metric to position it anywhere within either the stat boxes list or the stat rows list.

5. Positioning controls

   These icon buttons are useful If you need to move a metric to the top or bottom of the current list where clicking and dragging would likely be more cumbersome in a large list of metrics.

6. Selection controls

   You can move multiple selected metrics between the stat rows list or stat boxes list.

The preview window:

After you are satisfied with changes you’ve made to the layout, click on the Save button.

Heads up!

If you make any changes to the selected metrics in the Metrics tab, the layout will reset and need to be reconfigured.

Data Tab

The data tab allows you to create a manual usage report request, view/filter/export all of the usage report requests that Agility Blue has created with Relativity, and download CSV files of the usage reports that are still available in Relativity.

Understanding Relativity Usage Report Requests vs Stored Monthly Metrics

When Agility Blue generates a new Relativity usage report and collects the metrics data from that report, it is referred to as a Relativity Usage Report Request in Agility Blue. After collecting the data, Agility Blue will add the data to monthly metrics storage — which is what Agility Blue ultimately displays and reports on throughout the application. Monthly metrics will always show the most recent metrics for any given month that Agility Blue collected data from and reflect the same year and month that Relativity determines the metric falls within. The metrics that are collected from the Relativity usage report requests that Agility Blue generates each day are retained for up to 30 days and then archived, meaning the record of collection is still available for auditing purposes, but the daily metrics are removed to keep the system free from bloat over time. Archiving usage report requests do not affect the data retained in the monthly metrics storage, which are stored indefinitely.

The Relativity usage report requests data grid

Each record in the data grid will provide options that are available for that usage report request by clicking on the record context menu (three horizontal lines icon) near the first column.

The options include:

• Download Report (CSV)

  A CSV file representation of the usage report will be available for download if it has not been archived by Relativity. This CSV is the same file that Relativity provides if you were to download the usage report directly within Relativity. Relativity maintains reports for up to 30 days.

• Clear Collected Metrics

  Removes the collected metrics from Agility Blue for a report request. Monthly data will remain intact. You will have the option to re-initiate the collection after the metrics have been cleared. This option exists for troubleshooting failed collections.

• Archive Data

  Archiving the usage report request clears the collected metrics from Agility Blue. Monthly data will remain intact. Agility Blue will automatically archive usage report requests after 30 days, so doing this manually is generally unnecessary and exists for situations where you want to archive a collection earlier.

• Delete

  Deletes the usage report request and all metrics it collected entirely from Agility Blue. Monthly data will remain intact.

Clearing or Deleting Usage Report Data

When you clear, archive, or delete usage report data within Agility Blue, the report still exists within Relativity. Relativity does not allow for reports to be removed manually, but they will automatically be removed after 30 days.

Creating a new Relativity usage report request

The Create button will initiate a new usage report request by creating a usage report in Relativity, collecting the metrics from the report, and adding the metrics to the monthly metrics storage. Agility Blue will collect usage report data each day, so creating new usage reports manually is generally unnecessary unless you want to collect data immediately after setting up a new Relativity connection or if an automated collection was missed due to an unexpected issue or Relativity maintenance window. Also, keep in mind that the metrics that Relativity provides are never in real-time and generally reflect the state of data from the day before, so initiating new usage report requests more than once a day is just duplicating existing data. Check out the Workspace Utilization Capture Date-Time metric to determine exactly when Relativity captured the metric.

Results of initiating a new Relativity usage report request:

You can also see the reports that Agility Blue made directly within Relativity:

Relativity Usage Report Status

Relativity reports on the status of each usage report and you may come across the status CompletedWithErrors in Agility Blue. This typically means that the report was successful at generating some data, but you may have selected metrics that you don’t have data sources configured for or access to. For example, you may not have configured data sources or have access to some of the metrics under the Product Utilization metrics category such as aiR , data breach, or PI detection. If you don’t utilize these products in Relativity, there is no need to collect metrics on them.

Miscellaneous Settings Tab

The miscellaneous settings tab shows additional settings.

The following settings are available:

• Show Legacy Statistics switch

  If you are migrating from the previous method of collecting statistics through the Agility Blue services connector, you may opt to flip this switch on so you can continue to see the existing legacy statistics that were previously collected side-by-side with the usage report metrics. Eventually, those legacy statistics will become stale, so flip this switch off to no longer display them. The statistics will always be available for Relativity workspaces that are archived or no longer exist in Relativity (such that there are no usage report metrics available for them).

Viewing Metrics

After configuring Agility Blue to collect Relativity usage report metrics and after a successful Relativity usage report request collection, monthly metrics for linked Relativity workspaces can be seen on the matter details page.

The monthly usage report metrics area of a linked Relativity workspace card include:

1. Stat Boxes grid

   The stat boxes grid shows metrics that were configured to be displayed as a Stat Box where additional emphasis is given to the metric in a grid view layout.

2. Stat Rows list

   The stat rows list shows metrics that were configured to be displayed as a Stat Row in a stacked list layout.

3. Month selector

   Clicking on the calendar reveals a dropdown selector that allows you to change the current month to another. Metrics will be shown with the most recent collection of the selected month.

Clicking on a specific metric will bring up a window that allows you to see all monthly data for that metric in a data grid view that can be filtered, sorted, and exported.

For number-based metrics, a Chart tab is available so you can visualize the change in data over time for that metric:

Use the beginning and ending month selectors to change the date range.