Veritas™ Surveillance User Guide

Last Published:
Product(s): Veritas Alta Surveillance (1.0)
  1. Introducing Veritas Surveillance
    1.  
      About Veritas Surveillance
    2.  
      Key features of Veritas Surveillance
    3.  
      Feature comparison: Compliance Accelerator desktop client Vs Veritas Surveillance web client
    4.  
      Sampling support for content sources
    5.  
      About Veritas Surveillance system security
    6.  
      Veritas Surveillance multi-tier architecture
    7.  
      System requirements
  2. Getting started
    1.  
      Signing in to Veritas Surveillance
    2.  
      Signing out from Veritas Surveillance
  3. Working with dashboard widgets
    1.  
      Understanding the Dashboard page
    2.  
      Viewing status summary of recently reviewed departments
    3.  
      Pinning and unpinning departments to view review status
    4.  
      Changing the order of pinned departments
    5.  
      Viewing the review status summary of escalated items
    6.  
      Viewing a summary of searches and exports
  4. Managing employees and employee groups
    1.  
      About employees and employee groups
    2.  
      Creating employee profiles
    3.  
      Editing employee profile details
    4.  
      Creating employee groups
    5.  
      Editing employee group details
  5. Managing departments
    1.  
      About departments
    2.  
      Understanding the Departments page
    3.  
      Searching departments
    4.  
      Creating departments
    5.  
      Moving existing departments under other departments
    6.  
      Adding monitored employees and employee groups to departments
    7.  
      Editing monitoring policies
    8.  
      Editing department details and monitoring policy
    9.  
      Managing exception employees
    10.  
      Designating employees as exception employee
    11.  
      Assigning further exception reviewers to an exception employee
    12.  
      Removing exception status
    13.  
      Removing exception reviewers
    14.  
      Closing or opening the departments for monitoring
    15.  
      Deleting departments
  6. Managing department users
    1.  
      Assigning users to departments
    2.  
      Removing users from departments
    3.  
      Adding new roles for users
    4.  
      Removing roles
    5. Managing role assignment for a user in departments
      1.  
        Assigning departments and exceptions to specific users
      2.  
        Removing a specific role to users in one or more departments and exceptions
  7. Managing department-level archives
    1.  
      About department-level archives
    2.  
      Including or excluding enterprise vault archives at department-level
  8. Managing department-level searches
    1.  
      About department-level searches
    2.  
      Guidelines for effective searches
    3.  
      Creating and running department-level searches
    4.  
      Pausing and resuming searches
    5.  
      Downloading search details for archives
    6.  
      Disabling scheduled searches
    7.  
      Previewing search results
    8.  
      Accepting search results
    9.  
      Rejecting a search result
    10.  
      Resubmitting a search
  9. Managing department-specific hotword sets
    1.  
      Overview
    2.  
      Creating department-specific hotword sets
    3.  
      Editing department-specific hotwords and hotword sets
    4.  
      Deleting department-specific hotword sets
  10. Managing department-specific labels
    1.  
      Searching department-specific labels, label groups, and single choice groups
    2.  
      Managing department-specific labels
    3.  
      Managing department-specific label groups
    4.  
      Managing department-specific single choice label groups
  11. Managing department-specific review comments
    1.  
      About department-level review comments
    2.  
      Adding department-level review comments
    3.  
      Editing department-level review comments
    4.  
      Deleting department-level review comments
    5.  
      Updating order of department-level review comments
  12. Viewing employees associated with departments
    1.  
      Viewing employee association history
  13. Managing users, roles, and permissions
    1.  
      Overview
    2.  
      Predefined user roles and permissions
    3.  
      Adding new roles for users (employees) and employee groups
    4.  
      Editing user roles and permissions
    5.  
      Deleting user roles
    6.  
      Assigning Veritas Surveillances to users (employees) and employee groups
    7.  
      Restricting users to use hotwords in searches
    8.  
      Removing a user role
  14. Managing application-level archives
    1.  
      About application-level archives
    2.  
      Including or excluding enterprise vault archives at application-level
  15. Managing application-level searches
    1.  
      About application-level searches
    2.  
      Viewing existing application-level searches
    3.  
      Creating and running application-level searches
    4.  
      Editing application-level searches
    5.  
      Excluding departments from application searches
    6.  
      Reinstating the excluded department for application searches
  16. Managing application-specific hotword sets
    1.  
      Overview
    2.  
      Creating application-specific hotword sets
    3.  
      Editing application-specific hotwords and hotword sets
    4.  
      Deleting application-specific hotword sets
  17. Managing application-specific labels
    1.  
      Searching application-specific labels, label groups, and single choice groups
    2.  
      Managing application-specific labels
    3.  
      Managing application-specific label groups
    4.  
      Managing application-specific single choice label groups
  18. Managing application-specific review comments
    1.  
      About application-level review comments
    2.  
      Adding application-level review comments
    3.  
      Editing application-level review comments
    4.  
      Deleting application-level review comments
    5.  
      Updating order of application-level review comments
  19. Managing search schedules
    1.  
      Overview
    2.  
      Setting up new search schedules
    3.  
      Setting up one-time search schedules
    4.  
      Example of a one-time search schedule
    5.  
      Setting up recurring search schedules
    6.  
      Example of a recurring search schedule
    7.  
      Editing search schedules
    8.  
      Deleting search schedules
  20. Managing export operations
    1.  
      About exporting items
    2.  
      Performing export runs
  21. Managing reviews
    1.  
      About reviewing with Veritas Surveillance
    2.  
      Understanding the Review page
    3.  
      Rearranging columns in the item list pane
    4.  
      Changing the Preview pane position
    5.  
      Filtering the items in the Review pane
    6.  
      Reviewing the Audio-Video Transcript type items
    7.  
      Reviewing searched items
    8.  
      Viewing Intelligent Review Details
    9.  
      Adding or removing text for machine learning
    10.  
      Assigning review status to items
    11.  
      Viewing hotwords highlighting
    12.  
      Viewing hotwords in collaboration message
    13.  
      Viewing tags highlighting
    14.  
      Viewing tags in collaboration message
    15.  
      Viewing the full content in a new window
    16.  
      Adding comments to items
    17.  
      Escalating the review items
    18.  
      Viewing history of items
    19.  
      Printing and downloading the items and attachments
  22. Working with reports
    1.  
      About Veritas Surveillance 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. ReviewerMapping API
        1.  
          ReviewerMapping - List
      9. MonitoredEmployees API
        1.  
          MonitoredEmployees - List
      10.  
        Evidence Of Review Async API
      11. Evidence of Review API
        1.  
          EvidenceOfReview - List by filter
      12.  
        Report Status API
      13.  
        Supported OData query options
      14.  
        Supported reporting endpoint API filters and their values
      15.  
        Responses
    4. Managing Power BI templates for reporting APIs
      1.  
        Configuring Microsoft Power BI Templates for Reporting APIs
      2.  
        Accessing Veritas Surveillance reports and datasets through the OData web service
      3.  
        Guidelines for using Veritas Surveillance templates with Microsoft Power BI Desktop
      4.  
        TEMPLATE - Item Metrics
      5.  
        TEMPLATE - Reviewer Mapping
      6.  
        TEMPLATE- Evidence Of Review - Submit report request
      7.  
        TEMPLATE- Evidence Of Review - View report data
      8.  
        Saving, editing, and refreshing the Power BI reports
  23. Managing Audit Settings
    1.  
      Audit Settings Overview
    2.  
      Editing the Audit Settings
  24. Working with Audit viewer
    1.  
      About Audit viewer
    2.  
      Performing a search for audit records

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 can 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.