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

ItemMetrics - List by filter

POST https://<Reporting endpoint Base URL>/odata/ItemMetrics

Request body

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

Name

Type

Description

Departments

Optional

Specifies the department to which the captured item belongs and returns item counts for items within that department.

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

Limitation: As an input, the ItemMetrics API can pass maximum of 1000 Departments IDs.

CaptureType

Optional

Specifies the mode/technique used to capture the item in Compliance Accelerator and returns item counts for items with the specified capture type.

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

Limitation: As an input, the ItemMetrics API can pass maximum 10 CaptureType IDs.

CaptureDateStart

Mandatory

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

Returns item counts whose CaptureDate is greater than or equal to the specified CaptureDateStart.

Date format: yyyy-mm-dd

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

CaptureDateEnd

Mandatory

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

Returns item counts whose CaptureDate is less than or equal to the specified CaptureDateEnd.

Date format: yyyy-mm-dd

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

MessageDirections

Optional

Specifies whether the item was sent/received from within the organization or from an external source and returns item counts for items that have the specified message direction.

Data Type: JSON array of integers 'id'(identifier fields) that is MessageDirections IDs

Limitation: As an input, the ItemMetrics API can pass maximum 5 MessageDirections IDs.

MessageType

Optional

Specifies the type of captured items and returns item counts for items that have the specified message type.

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

Limitation: As an input, the ItemMetrics API can pass maximum 100 MessageType IDs on a single page.

Scenario 1:

To get the item counts for Departments IDs 7622, between CaptureDates 2023-11-24 and 2023-12-24 and having CaptureType as 1 or 3.

Sample Requests

POST https://<Reporting endpoint Base URL>/odata/ItemMetrics

{

{"CaptureDateStart": "2023-11-24",

"CaptureDateEnd": "2023-12-24",

"Departments": [7622],

"CaptureType": [1,3]

}

Sample response

Status code: 200 OK

Scenario 2

To get item counts for Department IDs 9 and 5, between CaptureDates 2023-06-01 and 2023-08-02 and having MessageType IDs as 7 or 8.

Sample request

POST https://<Reporting endpoint Base URL>/odata/ItemMetrics

{

"CaptureDateStart": "2023-06-01",

"CaptureDateEnd": "2023-08-02",

"Departments": [9,5],

"MessageType": [7,8]

}

Scenario 3:

To get item counts for Departments IDs 9 and 5 , between CaptureDates 2023-06-01 and 2023-08-02 and having MessageDirections as 1 or 2.

POST https://<Reporting endpoint Base URL>/odata/ItemMetrics

{

"CaptureDateStart": "2023-06-01",

"CaptureDateEnd": "2023-08-02",

"Departments": [9,5],

"MessageDirections": [1,2]

}

Scenario 4:

To get item counts for Departments IDs 9 and 5 , between CaptureDates 2023-06-01 and 2023-08-02 and having MessageType IDs as 7 or 8.

POST https://<Reporting endpoint Base URL>/odata/ItemMetrics

{

"CaptureDateStart": "2023-06-01",

"CaptureDateEnd": "2023-06-02",

"Departments": [9,5],

"MessageType": [7,8]

}

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.