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

Authentication

To ensure the security and integrity of data access, the Reporting API requires authentication. Authentication is used to verify the identity of the requesting client or application and determine whether it has the necessary permissions to access the API resources. There are two primary authentication methods supported for this API:

API Key authentication

Upon configuring the reporting endpoint API, a Base URL, a primary and secondary API Keys are generated. Include either primary or secondary API key in the X-API-Key header of your API requests.

For example,

X-API-Key:<Primary or Secondary API Key>

Basic authentication

Basic Authentication is a method where API clients provide a username and password with each request. Users use an encoded string in the Authorization header for this method. The recipient of the request uses this string to verify the users' identity and their access rights to a resource.

For example,

Authorization: Basic <Base64 encoded credentials>

To generate a Base64 encoded credentials:

  1. Combine the credentials (username and password) with a colon (:).

    Note:

    The username must be ReportingApiUser. The password must be either a primary or a secondary API Key provided after configuring the reporting endpoint. Use either one as your password.

    For example, ReportingApiUser:32adasdf3asdcvzxcweasd

  2. After specifying the credentials as mentioned in the step above, generate a Base64 encoded credentials. It is required while setting authorization header.

    For example, dGVuYW50OmtleQ==

Therefore, requests made by this user would be sent with the following header:

Authorization: Basic dGVuYW50OmtleQ==

When a server receives this request, it can access the Authorization header, decode the credentials, and look up the user to determine whether access to the requested resource should be allowed.