Enterprise Vault™ Compliance Accelerator Administrator's Guide

Last Published:
Product(s): Enterprise Vault (15.1)
  1. Overview and latest updates
    1.  
      About Compliance Accelerator desktop application-specific updates
  2. Understanding 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 application Vs Veritas Surveillance web application
  3. Configuring Compliance Accelerator Desktop Client
    1.  
      Customizing the reviewing action statuses
    2. Importing configuration data from an XML file
      1.  
        About importing configuration data
      2.  
        Sample XML files
      3.  
        Format of the Dataload.xml file
      4.  
        Importing the configuration data
    3.  
      Specifying the Windows domains with which to synchronize employee details
    4.  
      Mapping employee properties to Active Directory or Domino directory attributes
    5. Grouping departments into partitions
      1.  
        Creating department partitions
      2.  
        Editing department partitions
      3.  
        Deleting department partitions
    6.  
      Setting up department attributes
    7.  
      Setting up custom message types
    8. Setting Compliance Accelerator system configuration options
      1.  
        Ad Hoc Searches configuration options
      2.  
        Diagnostics configuration options
      3.  
        Document Conversion configuration options
      4.  
        Export/production configuration options
      5.  
        General configuration options
      6.  
        Home Page configuration options
      7.  
        Hotword Analysis configuration options
      8.  
        Item Prefetch Cache configuration options
      9.  
        Item Prefetch Cache (Advanced) configuration options
      10.  
        Policy Integration configuration options
      11.  
        Profile Synchronization configuration options
      12.  
        Random Capture configuration options
      13.  
        Reviewing configuration options
      14.  
        Search configuration options
      15.  
        Security configuration options
      16.  
        System configuration options
      17.  
        Vault Directory Synchronization configuration options
  4. 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
  5. 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

Supported OData query options

The currently supported OData query options that can be used for query composition to customize responses are mentioned below.

  • $select

    : Use the $select query parameter to return a set of properties that are different than the default set for an individual resource or a collection of resources. With $select, you can specify a subset of the default properties.

    Example: In the example below, the query returns only two properties, Department name and Department status in the result.

    https://<Reporting endpoint base URL>/odata/departments?$select=DepartmentName,Status

  • $count

    Use the $count query parameter to retrieve the total count of matching resources.

    In the example below, the query returns a total count of roles in the system irrespective of any other filters.

    https://<Reporting endpoint Base URL>/odata/roles?$count=true

  • $top

    Use the $top query parameter to limits the number of records returned.

    In the example below, the query returns the top 10 records in the result.

    https://<Reporting endpoint Base URL>/odata/departments?$top=10

  • $skip

    Use the $skip query parameter to skips a specified number of records before returning results.

    In the example below, the query returns the records skipping the first 60 records in the result.

    https://<Reporting endpoint Base URL>/odata/departments?$skip=60

  • $skipToken

    Use the $skipToken query parameter to retrieve the next page of results from result sets that span multiple pages.

    Some requests return multiple pages of data due to server-side paging to limit the page size of the response. Reporting APIs use the $skipToken query parameter to reference subsequent pages of the result. The $skipToken parameter contains an opaque token that references the next page of results and is returned in the URL provided in the @odata.nextLink property in the response.

    For example, if you call the Roles API that have more than 1000 records in the result, then the response will return only 1000 records with @odata.nextLink property as shown below.

    "@odata.nextLink": "https://<Reporting endpoint Base URL>/odata/roles?$skipToken=29310"

    To fetch the next page of records, the value of the @odata.nextLink can be used as the endpoint URL which has a skipToken value.