Enterprise Vault™ Insight Surveillance Reviewer's Guide

Last Published:
Product(s): Enterprise Vault (15.2)
  1. Introducing Insight Surveillance
    1.  
      About Insight Surveillance web application
    2.  
      Routine operations executed with Arctera Insight Surveillance
    3.  
      About Arctera Insight Surveillance system security
    4.  
      Feature comparison: Arctera Insight Surveillance desktop application Vs Arctera Insight Surveillance web application
    5. Product documentation
      1.  
        White papers on the Arctera Support website
      2.  
        "How To" articles on the Arctera Support website
  2. Searching for items
    1. Creating and running Insight Surveillance searches
      1.  
        Limitations on searching certain types of Skype for Business content
    2.  
      About the search criteria options
    3.  
      Guidelines on conducting effective searches
  3. Manually reviewing items
    1. About reviewing with Insight Surveillance
      1.  
        Limitations on reviewing certain types of Skype for Business content
    2.  
      About the Review pane
    3.  
      Viewing the hotword statistics for an item in review
    4.  
      Filtering the items in the Review pane
    5.  
      Assigning review marks to items
    6.  
      Adding comments to items
    7.  
      Viewing the history of items
    8.  
      Displaying printable versions of items
    9.  
      Downloading the original versions of items
    10.  
      Copying the item list to the Clipboard
    11. Escalating items
      1.  
        Assigning escalated items to other escalation reviewers
      2.  
        Closing escalated items
    12.  
      Changing how the Review pane looks
    13.  
      Setting your Review pane preferences
  4. Working with research folders
    1.  
      About research folders
    2.  
      Creating research folders
    3.  
      Editing the properties of research folders
    4.  
      Copying items to research folders
    5.  
      Reviewing the items in research folders
    6.  
      Exporting items from research folders
    7.  
      Giving other users access to your research folders
    8.  
      Committing research folder items to the department review set
    9.  
      Removing items from research folders
    10.  
      Deleting folders
  5. Exporting items
    1. About exporting items
      1.  
        Limitations on exporting certain types of content
    2.  
      Performing an export run
    3.  
      About the limits on the number of simultaneous export runs
    4.  
      Exporting items from the review set of an exception employee
    5.  
      Making the export IDs visible in Microsoft Outlook
  6. Creating and viewing reports
    1.  
      About the 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. 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 Insight Surveillance datasets
      2.  
        Accessing the Insight Surveillance datasets
      3.  
        Using the OData service with Microsoft Excel
      4.  
        Using the OData service with Microsoft SQL Server Reporting Services (SSRS)
      5.  
        Troubleshooting OData errors
    5.  
      Configuring a Power BI template for reporting

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