Search <book_title>...

Arctera™ Insight Surveillance User Guide

Last Published: 2025-01-27

Product(s): Veritas Alta Surveillance (1.0)

Introducing Arctera Insight Surveillance
1. About Insight Surveillance
2. Insight Surveillance multi-tier architecture
3. System requirements
4. Sampling support for content sources
5. AI-based label predictions support for efficient review process
6. Date format support in Insight Surveillance
7. About Insight Surveillance system security
Getting started
1. Signing in to Insight Surveillance
2. Signing out from Insight Surveillance
3. Launching Arctera Insight Archiving applications
4. Resetting a forgotten password
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
Managing employee groups
1. Managing employee groups
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
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
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. Previewing search results
7. Accepting search results
8. Rejecting a search result
9. Resubmitting a search
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
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
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
Managing department-specific allowlist rules
1. Overview
2. Creating department-specific allowlist rules
3. Editing department-specific allowlist rules
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
Viewing employees associated with departments
1. Viewing employee association history
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
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
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
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
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
Managing application-specific allowlist rules
1. Overview
2. Creating application-specific allowlist rules
3. Editing application-specific allowlist rules
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
Managing data requests
1. About data request
2. Creating a new data request
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
Managing export operations
1. About exporting items
2. Performing export runs
Managing reviews
1. About reviewing with Insight 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. Translating email and attachment content for review
10. Adding or removing text for machine learning
11. Assigning review status to items
12. Viewing hotwords highlighting
13. Viewing hotwords in collaboration message
14. Viewing tags highlighting
15. Viewing predicted labels of review items
16. Viewing the full content in a new window
17. Adding comments to items
18. Escalating the review items
19. Applying labels to items
20. Viewing history of items
21. Printing and downloading the items and attachments
22. Viewing Intelligent Review Details
Working with reports
1. About Insight Surveillance reports
2. Predefined reports
3. Enhanced reporting
4. Managing Power BI templates for reporting APIs
Managing Audit Settings
1. Audit Settings Overview
2. Editing the Audit Settings
Working with Audit viewer
1. About Audit viewer
2. Performing a search for audit records

Evidence Of Review Async API

EvidenceOfReviewAsync

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

The report identifier and locations in the result can be used to track the report generation operation.

Note: This note is intended to those who have used earlier versions of this API.

There were two separate reporting endpoint APIs: EvidenceOfReviewByDept and EvidenceOfReviewByUsers. However, from this release, these two APIs have been merged into one API called EvidenceOfReview. This unified API offers the same detailed reports which is conveniently accessible in one place.
The users field is changed to monitoredemployees.
A new filter Searches is added.
ReturnByDepartment: This parameter has been added to get the records grouped by departments and is set to False by default. When set to False, the monitoredEmployeeId, monitoredEmployee, and totalMessagesForSampling parameters are applicable, thus, returned the searched values in the response.
Conversely, if set to True, the monitoredEmployeeId, monitoredEmployee, and totalMessagesForSampling parameters are not applicable, thus, returned the -1 value in the response.
ReturnZeroCaptureRecords: This parameter has been added and is set to False by default. When set to False, parameters with a result count of zero will not be displayed in the output. Conversely, if set to True, parameters with a result count of zero will be included in the output.
The Reviewed output parameter has been removed and replaced with the ReviewedRelevant and ReviewedIrrelevant parameters.
However, the Unreviewed output parameter has been retained. In addition, the UnreviewedRelevant and UnreviewedIrrelevant parameters are added.
In the response, the -1 value for searchHits signifies Not Applicable.

To use the EvidenceOfReviewAsync API, follow the steps below:

Call the EvidenceOfReviewAsync 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/EvidenceOfReviewAsync

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

Sample input

GET https://<Reporting endpoint Base URL>/odata/EvidenceOfReviewAsync?ReportName= <name of report>& StartDate=<YYYY-MM-DD>&EndDate=<YYYY-MM-DD> &Departments= [<DeptID1>,<DeptID2>,...]&MessageTypes=[<MessageTypeID1>,<MessageTypeID2>,...] &MessageDirections =[<MessageDirectionID1>,<MessageDirectionID2>, ...] & CaptureTypes= [<CaptureTypeID1>, <CaptureTypeID2>,...]&ReturnByDepartment=True&ReturnZeroCaptureRecords=False
GET https://<Reporting endpoint Base URL>/odata/ EvidenceOfReviewAsync?ReportName=TestReport1&StartDate=2024-01-01&EndDate=2024-06-30 &Departments=[101, 102] &MessageTypes=[1,7]&MessageDirections=[1,2] &CaptureTypes=[6,99] &ReturnByDepartment=True&ReturnZeroCaptureRecords=False
POST https://<Reporting endpoint Base URL>/odata/EvidenceOfReviewAsync

EvidenceOfReviewAsync - URL Parameter/Filters

The following filters can be used with the EvidenceOfReviewAsync 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 Insight 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 less 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 'id'(identifier fields) 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 'id'(identifier fields) that is Department IDs. Limitation As an input, this API can pass maximum of 1000 Departments IDs. Note To include results for all departments of a specified tenant/customer in a report, do not specify any department IDs in a query. To include results for specific departments of a specified tenant/customer in a report, specify department IDs in the query.
MonitoredEmployees	Optional	This field specifies the monitored employee IDs for which the report has to be generated. For example, if a department has 10 monitored employees but only 2 are specified in this filter, the report will include item counts for only those 2 monitored employees. Note: To include all monitored employees in a report, do not specify any monitored employee IDs in a query. To include results for specific monitored employees of a specified tenant/customer in a report, specify monitored employee IDs in the query The valid values of monitored employees are the IDs of any monitored employee from the Insight Surveillance MonitoredEmployee ID list. This ID list can be fetched from the MonitoredEmployee API endpoint. See MonitoredEmployees API. Refer to the MonitoredEmployeeId field only. Data Type: Integer ID of the user.
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 'id'(identifier fields) 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 Arctera and returns item counts for items with the specified capture type. Data Type: JSON array of integers 'id'(identifier fields) that is CaptureType IDs. Limitation: As an input, this API can pass maximum 10 CaptureTypes IDs. Only CaptureTypes IDs 2, 6, and 99 are supported.
ReturnByDepartment	Mandatory to get department wise report	This parameter value is set to *False* by default. When set to *False, it returns the count at monitored employee level (that is grouping by monitored employees). The monitoredEmployeeId, monitoredEmployee, and totalMessagesForSampling* parameters are applicable, and return the corresponding values in the response. When set to *True, it returns the evidence of review count at department level (that is grouping by departments). The monitoredEmployeeId, monitoredEmployee, and totalMessagesForSampling* parameters are not applicable, and return the -1 value in the response.
ReturnZeroCaptureRecords:	Mandatory to get monitoredemployees wise report	This parameter value is set to *False* by default. When set to *False, parameters with a result count of zero will not be displayed in the output. When set to True*, parameters with a result count of zero will be included in the output.
Searches	Optional	Specifies IDs of the searches. Note: If the IDs of the parent searches are specified, the generated report includes result for corresponding child searches. In the response, the -1 value for *searchHits* signifies *Not Applicable. The searchHits* are applicable to Evidence Of Review By Department only and not applicable for Evidence Of Review By Monitored Employee.

Scenario 1: New request to submit a report.

Sample input for Return By Monitored Employee

Sample input for Return By Department

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

Call the ReportStatus API to get the status of asynchronous API report. See Report Status API.
Once the report is ready, call the EvidenceOfReview API to retrieve the report data from the asynchronous API. See Evidence of Review API.