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

Supported OData query options

The currently supported OData query options that can be used for query composition to customize responses are mentioned below.

  • $select

    : Use the $select query parameter to return a set of properties that are different than the default set for an individual resource or a collection of resources. With $select, you can specify a subset of the default properties.

    Example: In the example below, the query returns only two properties, Department name and Department status in the result.

    https://<Reporting endpoint base URL>/odata/departments?$select=DepartmentName,Status

  • $count

    Use the $count query parameter to retrieve the total count of matching resources.

    In the example below, the query returns a total count of roles in the system irrespective of any other filters.

    https://<Reporting endpoint Base URL>/odata/roles?$count=true

  • $top

    Use the $top query parameter to limits the number of records returned.

    In the example below, the query returns the top 10 records in the result.

    https://<Reporting endpoint Base URL>/odata/departments?$top=10

  • $skip

    Use the $skip query parameter to skips a specified number of records before returning results.

    In the example below, the query returns the records skipping the first 60 records in the result.

    https://<Reporting endpoint Base URL>/odata/departments?$skip=60

  • $skipToken

    Use the $skipToken query parameter to retrieve the next page of results from result sets that span multiple pages.

    Some requests return multiple pages of data due to server-side paging to limit the page size of the response. Reporting APIs use the $skipToken query parameter to reference subsequent pages of the result. The $skipToken parameter contains an opaque token that references the next page of results and is returned in the URL provided in the @odata.nextLink property in the response.

    For example, if you call the Roles API that have more than 1000 records in the result, then the response will return only 1000 records with @odata.nextLink property as shown below.

    "@odata.nextLink": "https://<Reporting endpoint Base URL>/odata/roles?$skipToken=29310"

    To fetch the next page of records, the value of the @odata.nextLink can be used as the endpoint URL which has a skipToken value.