Veritas Alta™ Surveillance User Guide

Last Published:
Product(s): Veritas Alta Surveillance (1.0)
  1. Introducing Veritas Alta Surveillance
    1.  
      About Alta Surveillance
    2.  
      Alta Surveillance multi-tier architecture
    3.  
      System requirements
    4.  
      Sampling support for content sources
    5.  
      AI-based label predictions support for efficient review process
    6.  
      About Alta Surveillance system security
  2. Getting started
    1.  
      Signing in to Alta Surveillance
    2.  
      Signing out from Alta Surveillance
    3.  
      Launching Veritas Alta Archiving applications
    4.  
      Resetting a forgotten password
  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 employee groups
    1.  
      Managing employee groups
  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
  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 searches
    1.  
      About department-level searches
    2.  
      Guidelines for effective searches
    3.  
      Creating and running department-level searches
    4.  
      Disabling scheduled searches
    5.  
      Using proximity searches
    6.  
      Using fuzzy searches
    7.  
      Previewing search results
    8.  
      Accepting search results
    9.  
      Rejecting a search result
    10.  
      Resubmitting a search
  8. 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
  9. 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
  10. Managing department-specific trash rules
    1.  
      Overview
    2.  
      Creating department-specific trash rules
    3.  
      Activating department-specific trash rules
    4.  
      Deactivating department-specific trash rules
    5.  
      Propagating department-specific trash rules
    6.  
      Unpropagating department-specific trash rules
  11. Managing department-specific allowlist rules
    1.  
      Overview
    2.  
      Creating department-specific allowlist rules
    3.  
      Editing department-specific allowlist rules
  12. 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
  13. Viewing employees associated with departments
    1.  
      Viewing employee association history
  14. 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 Alta Surveillances to users (employees) and employee groups
    7.  
      Restricting users to use hotwords in searches
    8.  
      Removing a user role
  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 trash rules
    1.  
      Overview
    2.  
      Creating application-specific trash rules
    3.  
      Activating application-specific trash rules
    4.  
      Deactivating application-specific trash rules
    5.  
      Propagating application-specific trash rules
    6.  
      Unpropagating application-specific trash rules
  19. Managing application-specific allowlist rules
    1.  
      Overview
    2.  
      Creating application-specific allowlist rules
    3.  
      Editing application-specific allowlist rules
  20. 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
  21. Managing data requests
    1.  
      About data request
    2.  
      Creating a new data request
  22. 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
  23. Managing export operations
    1.  
      About exporting items
    2.  
      Performing export runs
  24. Managing reviews
    1.  
      About reviewing with Alta Surveillance
    2.  
      Limitations on reviewing certain types of Skype for Business content
    3.  
      Understanding the Review page
    4.  
      Changing the Preview pane position
    5.  
      Rearranging columns in the item list pane
    6.  
      Filtering the items in the Review pane
    7.  
      Viewing dynamic review item counts on the calendar
    8.  
      Reviewing searched items
    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 predicted labels of review items
    15.  
      Viewing the full content in a new window
    16.  
      Adding comments to items
    17.  
      Escalating the review items
    18.  
      Applying labels to items
    19.  
      Viewing history of items
    20.  
      Printing and downloading the items and attachments
    21.  
      Viewing Intelligent Review Details
  25. Working with reports
    1.  
      About Alta Surveillance reports
    2.  
      Predefined reports
    3. Enhanced reporting
      1.  
        Configuring a reporting endpoint
      2.  
        Authentication
      3. Departments API
        1.  
          Departments - List
      4. Users API
        1.  
          Users - List
      5. UserRoles API
        1.  
          UserRoles - List by filters
      6. Roles API
        1.  
          Roles - List
        2.  
          Roles - 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 By Dept Async API
      11.  
        Report Status API
      12. Evidence of Review by Department API
        1.  
          EvidenceOfReviewByDept - List by filter
      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.  
        Guidelines for using Alta Surveillance templates with Microsoft Power BI Desktop
      2.  
        Configuring Microsoft Power BI Templates for Reporting APIs
      3.  
        TEMPLATE - Item Metrics
      4.  
        TEMPLATE - Reviewer Mapping
      5.  
        TEMPLATE- Evidence Of Review By Department - Submit report request
      6.  
        TEMPLATE- Evidence Of Review By Department - View report data
      7.  
        Saving, editing, and refreshing the Power BI reports
  26. Managing Audit Settings
    1.  
      Audit Settings Overview
    2.  
      Editing the Audit Settings
  27. Working with Audit viewer
    1.  
      About Audit viewer
    2.  
      Performing a search for audit records

Evidence Of Review By Dept Async API

EvidenceOfReviewByDeptAsync

This API submits the report generation request which executes asynchronously. Result of this API contains identifier for report, status and location for retreiving the report data.

Thje report identifier and locations in the result can be used to track the report ogeneration operation.

To use the EvidenceOfReviewByDeptAsync API, follow the steps below:

  1. Call the EvidenceOfReviewByDeptAsync API to submit report generation request.

    This asynchronous API supports GET and POST query methods. Use any of the following as needed:

    GET https://<Reporting endpoint Base URL>/odata/EvidenceOfReviewByDeptAsync

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

    Sample input

    • GET https://<Reporting endpoint Base URL>/odata/EvidenceOfReviewByDeptAsync?ReportName=<name of report>&StartDate=<YYYY-MM-DD>&EndDate=<YYYY-MM-DD>&Departments=[<DeptID1>,<DeptID2>,...]&MessageTypes=[<MessageTypeID1>,<MessageTypeID2>,...]&MessageDirections=[<MessageDirectionID1>, <MessageDirectionID2>, ...]&CaptureTypes=[<CaptureTypeID1>, <CaptureTypeID2>,...]

    • GET https://<Reporting endpoint Base URL>/odata/EvidenceOfReviewByDeptAsync?ReportName=TestReport1&StartDate=2024-01-01&EndDate=2024-06-30&Departments=[101, 102]&MessageTypes=[1,7]&MessageDirections=[1,2]&CaptureTypes=[1,6,99]

    • POST https://<Reporting endpoint Base URL>/odata/EvidenceOfReviewByDeptAsync

    Parameter/Filters

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

    Name

    Type

    Description

    ReportName

    Mandatory

    Specify a name of the report.

    StartDate

    Mandatory

    StartDate is the date on which items are captured or ingested in Alta Surveillance is recorded as the CaptureDate for that item.

    This filter specifies the start date for returning count of items whose CaptureDate is greater than or equal to this start date.

    Data Type: Date in the YYYY-MM-DD format that is StartDate.

    EndDate

    Mandatory

    This filter specifies the end date for returning count of items whose CaptureDate is greater than or equal to this date.

    Data Type: Date in the YYYY-MM-DD format that is EndDate.

    MessageTypes

    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 Veritas Alta Archivingids that is MessageType IDs.

    Limitation: As an input, this API can pass maximum 100 MessageType IDs.

    Departments

    Optional

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

    Data Type: JSON array of integers Veritas Alta Archivingids that is Department IDs.

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

    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 Veritas Alta Archivingids that is MessageDirection IDs.

    Limitation: As an input, this API can pass maximum 5 MessageDirection IDs.

    CaptureTypes

    Optional

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

    Data Type: JSON array of integers Veritas Alta Archivingids that is CaptureType IDs.

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

    Scenario 1: New request to submit a report.

    Sample input

    Sample response

    Name

    Description

    reportId

    Displays report ID. It is generated upon successful execution of API.

    reportName

    Displays report name. It is generated upon successful execution of API.

    reportType

    Displays the report type as Evidence Of Review By Department.

    reportDate

    Displays the date of report generation after successful execution of API.

    reportStatus

    Displays report status. For more information on statuses, See Report Status API.

    info

    Displays a message if the report request has queued successfully or not.

    newReportInstanceQueued

    Specifies weather a new report generation request has been submitted or not. The Rate Limiting feature restricts submission of multiple requests with identical input parameters if attempted within one minute.

    It returns the following values:

    True: The value is shown as True, if the new report request has been queued successfully.

    False: The value is shown as False, if the input parameters of the current request are identical to the parameters of the already submitted request within one minute, a new report will not be queued. As a result, the details of the existing report request are returned.

    reportStatusLocation

    Displays a URL with report ID.

    To view the status of this report, use the same URL.

    reportDataLocation

    Displays a URL for the location of report data.

    To access the report data, use the same URL.

    Scenario 2: The same request has been submitted again within one minute.

    Sample response

  2. Call the ReportStatus API to get the status of asynchronous API report.

    See Report Status API.

  3. Call the EvidenceOfReviewByDept API to get the report data of the asynchronous API.

    See Evidence of Review by Department API.