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

Configuring a reporting endpoint

To configure a reporting endpoint, you must have a Compliance System Administrator role or the Configure Reporting API Endpoint permission to your role. If you do not have this permission, contact your system administrator.

In this release, only one reporting endpoint configuration can be created. After the endpoint is configured, you can change the configuration, regenerate API keys, and activate or suspend the endpoint as needed.

To configure a reporting endpoint

  1. In the left navigation pane, select Configuration > Reporting Endpoint tab.

  2. Click Add.
  3. On the Add New Endpoint Configuration page, specify the following details and click Save.

    Name

    Specify a unique name for the reporting endpoint configuration.

    Description

    Provide a brief description of the reporting endpoint configuration.

    Scope

    Decides which APIs are accessible via current configuration.

    By default, it is set to All API.

    IP Address

    Specify individual IP Addresses that are allowed to access APIs via current configuration.

    Note:

    Only IPv4 addresses are supported in this release.

    IP Address range

    Specify the range of sequential IP Addresses that are allowed to access APIs via current configuration.

    IP addresses outside of that range are not permitted to access the API.

    Note:

    Only IPv4 addresses are supported in this release.

    Primary and Secondary API Key

    After saving the reporting endpoint configuration, the application automatically generates primary and secondary API keys and saves them to the reporting endpoint configuration.

    API callers need to specify any of these API keys to access these APIs.

    Note:

    The primary and secondary API keys are provided so that if you want to replace any of the keys, you can use another one without experiencing any downtime.

    Endpoint Base URL

    After saving the reporting endpoint configuration, the application generates the Endpoint Base URL automatically. API callers must use this URL as the starting point for accessing API.

    Ensure that the configured reporting endpoint is listed on the Reporting Endpoint tab. If required, click the Refresh icon. The application masks primary and secondary keys for security reasons.

  4. Click the kebab icon (three vertical dots) in the same row to perform the following actions:

    • To view or hide the keys, select Show/hide keys.

    • To copy the base URL, primary key, and secondary key, click the Copy icon in the respective column, or click the reporting endpoint name and copy the required information.

    • To edit the reporting endpoint configuration, select Edit. Modify the configuration as needed and click Save.

    • To regenerate the API keys, click Regenerate adjacent to the primary and secondary API key fields.

      Note:

      API keys can be regenerated for the active reporting endpoints only.

    • To suspend the active reporting endpoint, select Suspend to block access to the Reporting APIs. Specify the reason for suspending the reporting endpoint and click Suspend.

    • To activate the suspended reporting endpoint and regenerate primary and secondary keys, select Activate.

      Select the primary and secondary API key generation check boxes as needed. Specify the reason for activating the reporting endpoint and click Activate. The application displays the date of expiry for these API keys.