Arctera™ Insight Surveillance Web Client User Guide

Last Published:
Product(s): Veritas Alta Surveillance (1.0)
  1. Introducing Arctera Insight Surveillance
    1.  
      About Insight Surveillance
    2.  
      Key features of Insight Surveillance
    3.  
      Feature comparison: Enterprise Vault Compliance Accelerator Desktop Client Vs Insight Surveillance web client
    4.  
      About Insight Surveillance system security
    5.  
      Insight Surveillance multi-tier architecture
    6.  
      System requirements
  2. Getting started
    1.  
      Signing in to Insight Surveillance
    2.  
      Signing out from Insight 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.  
      Reviewing department items
    16.  
      Deleting departments
    17. Managing reviewer assignment
      1.  
        About reviewer assignment
      2.  
        Configuring application-level review setting
      3.  
        Configuring department-level reviewer assignment setting
      4.  
        Enabling and disabling department settings to configure review assignment
      5.  
        Configuring a percentage of review items to reviewers within the department
      6.  
        Reassigning a fixed number of review items from one reviewer to other reviewers within the department
      7.  
        Custom assignment scenarios
      8.  
        Removing assigned review items from reviewers
      9.  
        Reassigning items of a removed department reviewer to other reviewers within the department
    18. Managing research folders
      1.  
        About research folders
      2.  
        Creating research folders
      3.  
        Editing research folders
      4.  
        Deleting research folders
  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
    6.  
      Allocating review items to reviewers
  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 Insight 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 Insight 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.  
      Reviewing research folder items
    9.  
      Reviewing department items
    10.  
      Viewing Intelligent Review Details
    11.  
      Adding or removing text for machine learning
    12.  
      Assigning review status to items
    13.  
      Viewing hotwords highlighting
    14.  
      Viewing hotwords in collaboration message
    15.  
      Viewing tags highlighting
    16.  
      Viewing tags in collaboration message
    17.  
      Viewing the full content in a new window
    18.  
      Adding comments to items
    19.  
      Escalating the review items
    20.  
      Applying labels to items
    21.  
      Viewing history of items
    22.  
      Printing the original versions of items
    23.  
      Printing and downloading the items and attachments
  22. Working with reports
    1.  
      About Insight 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. Users API
        1.  
          Users - List
      5. Roles API
        1.  
          Roles - List
        2.  
          Roles - List by filters
      6.  
        User Roles Async API
      7. User Roles API
        1.  
          UserRoles - List
      8. Classification Tags API
        1.  
          Classification Tags - List
      9. Labels API
        1.  
          Labels - List
      10. Searches API
        1.  
          Searches - List
      11. ItemMetrics API
        1.  
          ItemMetrics - List
        2.  
          ItemMetrics - List by filter
      12.  
        Reviewer Mapping Async API
      13. Reviewer Mapping API
        1.  
          ReviewersMapping - List
      14. MonitoredEmployees API
        1.  
          MonitoredEmployees - List
      15.  
        Evidence Of Review Async API
      16. Evidence of Review API
        1.  
          EvidenceOfReview - List by filter
      17.  
        Item Classification Metrics Async API
      18. Item Classification Metrics API
        1.  
          ItemClassificationMetrics - List by filter
      19.  
        Item Label Metrics Async API
      20. Item Label Metrics API
        1.  
          ItemLabelMetrics - List by filter
      21.  
        Item Hotword Metrics Async API
      22. Item Hotword Metrics API
        1.  
          ItemHotwordMetrics - List by filter
      23.  
        Item Details Async API
      24. Item Details API
        1.  
          ItemDetails - List by filter
      25.  
        Report Status API
      26.  
        Supported OData query options
      27.  
        Supported reporting endpoint API filters and their values
      28.  
        Responses
    4. Managing Power BI templates for reporting APIs
      1.  
        Configuring Microsoft Power BI Templates for Reporting APIs
      2.  
        Guidelines for using Insight Surveillance templates with Microsoft Power BI Desktop
      3.  
        TEMPLATE - Departments, Users, Roles, Labels
      4.  
        TEMPLATE - User Roles - Submit Report Request
      5.  
        TEMPLATE - User Roles - View Report Data
      6.  
        TEMPLATE - Item Metrics
      7.  
        TEMPLATE - Reviewer Mapping - Submit Report Request
      8.  
        TEMPLATE - Reviewer Mapping - View Report Data
      9.  
        TEMPLATE - Searches
      10.  
        TEMPLATE- Evidence Of Review - Submit Report Request
      11.  
        TEMPLATE- Evidence Of Review By Monitored Employee - View Report Data
      12.  
        TEMPLATE- Evidence Of Review By Department - View Report Data
      13.  
        TEMPLATE- Item Classification Metrics - Submit Report Request
      14.  
        TEMPLATE- Item Classification Metrics - View Report Data
      15.  
        TEMPLATE- Item Label Metrics - Submit Report Request
      16.  
        TEMPLATE- Item Label Metrics By Employee - View Report Data
      17.  
        TEMPLATE- Item Label Metrics By Department - View Report Data
      18.  
        TEMPLATE- Item Hotword Metrics - Submit Report Request
      19.  
        TEMPLATE- Item Hotword Metrics - View Report Data
      20.  
        TEMPLATE- Item Details - Submit Report Request
      21.  
        TEMPLATE- Item Details - View Report Data
      22.  
        Saving, editing, and refreshing the Power BI reports
  23. Managing application wide 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
  25. Managing application wide review setting
    1.  
      Overview
    2.  
      Editing application-level review setting

Configuring a reporting endpoint

To configure a reporting endpoint, you must have a System Admin 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.

    Select at least one of the checkboxes (IP Address or IP Address Range) and provide valid IP values for the same.

    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.