Enterprise Vault™ Compliance Accelerator Administrator's Guide

Last Published:
Product(s): Enterprise Vault (15.0)
  1. Introducing Compliance Accelerator
    1.  
      Key features of Compliance Accelerator
    2.  
      About the Compliance Accelerator components
    3.  
      The Compliance Accelerator process
    4. Product documentation
      1.  
        White papers on the Veritas Support website
  2. Introducing Veritas Surveillance
    1.  
      About Veritas Surveillance
    2.  
      Routine operations executed with Veritas Surveillance
    3.  
      About Veritas Surveillance system security
    4.  
      Feature comparison: Compliance Accelerator desktop client Vs Veritas Surveillance web client
  3. Creating and viewing reports
    1.  
      About the Compliance Accelerator reports
    2.  
      Accessing data through the Microsoft SQL Server Reporting Services (SSRS)
    3. Enhanced reporting
      1.  
        Configuring a reporting endpoint
      2.  
        Authentication
      3. Departments API
        1.  
          Departments - List
      4. Roles API
        1.  
          Roles - List
        2.  
          Roles - List by filters
      5. Users API
        1.  
          Users - List
      6. UserRoles API
        1.  
          UserRoles - List by filters
      7. ItemMetrics API
        1.  
          ItemMetrics - List
        2.  
          ItemMetrics - List by filter
      8. Evidence of Review by Department API
        1.  
          EvidenceOfReviewByDept - List by filter
      9. Evidence of Review by User API
        1.  
          EvidenceOfReviewByUser - List by filter
      10.  
        Supported OData query options
      11.  
        Supported reporting endpoint API filters and their values
      12.  
        Responses
    4. Accessing reports through the OData web service
      1.  
        Available Compliance Accelerator datasets
      2.  
        Accessing the Compliance Accelerator datasets
      3.  
        Using the OData service with Microsoft Excel
      4.  
        Using the OData service with Microsoft SQL Server Reporting Services (SSRS)
    5.  
      Configuring a Power BI template for reporting
  4. Appendix A. Troubleshooting
    1.  
      Veritas Surveillance user interface user interface is not displayed properly in non-English environment
    2.  
      Issues with the random sampling of items
    3.  
      Display issues when you open a Compliance Accelerator website in Internet Explorer 10 or later
    4.  
      Vault stores not displayed in the Veritas Surveillance web client
    5.  
      TNEF-encoded attachments to Internet Mail (.eml) messages may not be readable after you export the messages from a review set
    6.  
      Synchronization errors after you rename the SQL Server computer
    7.  
      Performance counter errors when the Accelerator Manager service starts
    8.  
      SQL Service Broker warning when restoring a customer database to a different server
    9.  
      Error messages when the Intelligent Review (IR) API authentication and authorization fails
    10.  
      Known issues after enabling FIPS

ItemMetrics - List

GET https://<Reporting endpoint Base URL>/odata/ItemMetrics?CaptureDateStart=<YYYY-MM-DD>&CaptureDateEnd=<YYYY-MM-DD>

ItemMetrics - URL Parameter/Filters

The following filters can be used with the ItemMetrics API when invoked using the GET method. The system uses the AND operator between the filters to return the result based on the specified filters.

Name

Type

Description

CaptureDateStart

Mandatory

CaptureDate is the date on which items are captured or ingested in Compliance Accelerator is recorded as the CaptureDate for that item.

This filter specifies the start date for returning count of items whose CaptureDate is greater than or equal to this start date.

Date format: YYYY-MM-DD

Data Type: JSON array of integers 'id'(identifier fields) that is CaptureDateStart.

CaptureDateEnd

Mandatory

This filter specifies the end date for returning count of items whose CaptureDate is greater than or equal to this date.

Date format: YYYY-MM-DD

Data Type: JSON array of integers 'id'(identifier fields) that is CaptureDateEnd.

Sample requests

To get count of all items captured between 2023-01-01 and 2023-12-31, the sample query will be as below.

GET https://<Reporting endpoint Base URL>/odata/ItemMetrics?CaptureDateStart=2023-01-01&CaptureDateEnd=2023-12-31

Supported OData Filters

See Supported OData query options.

Supported reporting endpoint API filters and their values

See Supported reporting endpoint API filters and their values.

Responses

See Responses.