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

UserRoles - List by filters

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

Request body

Specify the following filters to obtain refined and selective results from this report.

Note:

Either Departments or Users is a mandatory parameter. The Scope is an optional parameter.

Name

Type

Description

Departments

Mandatory (if the Users parameter is not provided)

Optional (if the Users parameter is provided)

Specifies IDs of the departments to which users and their roles belongs to.

Limitations:

The Users roles API can pass a maximum of 100 Departments IDs as input.

Data Type: JSON array of integers 'id'(identifier fields) that is Departments.

Scopes

Optional

Specifies the scope of the users roles. Possible values are: 160 for application-level roles and 161 for department-level roles.

Data Type: JSON array of integers 'id'(identifier fields) that is Scopes.

Users

Mandatory (if the Departments parameter is not provided)

Optional (if the Departments parameter is provided)

Specifies IDs of the users.

Limitations

The Users roles API can pass a maximum of 100 User IDs as input.

Data Type: JSON array of integers 'id'(identifier fields) that is Users.

Scenario 1

To get the item counts only for Users when the Users are mentioned, but the Departments and the Scopes are not mentioned.

Sample request

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

{

"Departments": [],

"Scopes" :[]

"Users" :[3821]

}

Scenario 2

To get the item counts only for users when Departments are mentioned, but the Scopes and Users are mentioned.

Sample request

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

{

"Departments": [23],

"Scopes" :[]

"Users" :[]

}

Scenario 3

To get the item counts only for users when Departments and Scopes are mentioned, but Users are not mentioned.

Sample request

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

{

"Departments": [23],

"Scopes" :[161]

"Users" :[]

}

Scenario 4

To get the item counts only for users when Departments are not mentioned, but the Scopes and Users are mentioned.

Sample request

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

{

"Departments": []

"Scopes" :[160]

"Users" :[3821]

}

Scenario 5

To get the item counts only for users when the Departments, Scopes, and Users are mentioned.

Sample request

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

{

"Departments": [23],

"Scopes" :[160,161]

"Users" :[55,67]

}

Sample response

(For scenario 1 to 5) Status code: 200 OK

Scenario 6

Invalid Inputs. Either the Department or the User parameter must be specified as input.

Sample request

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

{

"Departments": [],

"Scopes" :[160]

"Users" :[]

}

Sample response

Status code: 400 Bad Request Error Code: InvalidOdataQuery

Supported OData Filters

See Supported OData query options.

Responses

See Responses.