Search <book_title>...

Arctera™ Insight Surveillance Web Client User Guide

Last Published: 2025-07-07

Product(s): Veritas Alta Surveillance (1.0)

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
Getting started
1. Signing in to Insight Surveillance
2. Signing out from Insight Surveillance
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 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
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
18. Managing research folders
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
Managing department-level archives
1. About department-level archives
2. Including or excluding enterprise vault archives at department-level
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
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 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 archives
1. About application-level archives
2. Including or excluding enterprise vault archives at application-level
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 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 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. 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
Working with reports
1. About Insight Surveillance reports
2. Accessing data through the Microsoft SQL Server Reporting Services (SSRS)
3. Enhanced reporting
4. Managing Power BI templates for reporting APIs
Managing application wide 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
Managing application wide review setting
1. Overview
2. Editing application-level review setting

Item Details Async API

ItemDetailsAsync

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

This report displays items that have been archived and discovered within the Insight Surveillance application. It includes metadata such as subject and author, as well as a history of actions performed on the item, including label assignment, marking, escalation, appraisal, and commenting.

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

Note:

If the number of records in the report exceeds 400,000 records, the result will be truncated. The extra records beyond the limit (400,000) are not included in the report.

If the result is truncated, refine the filter criteria to narrow down the number of records and retrieve more specific data.

To use the ItemDetailsAsync API, follow the steps below:

Call the ItemDetailsAsync API to submit a 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/ ItemDetailsAsync?ReportName=<Name of the report>&StartDate=<YYYY-MM-DD>& EndDate=<YYYY-MM-DD>
POST https://<Reporting endpoint base URL>/OData/ ItemDetailsAsync

Sample Input

GET https://<Reporting endpoint Base URL>/odata/ ItemDetailsAsync?ReportName=<Name of the report>&StartDate= <YYYY-MM-DD>& EndDate=<YYYY-MM-DD>&DateType=CaptureDate or ItemHistoryDate& Departments=[<DeptID1>,<DeptID2>,...]&MessageTypes=[<MessageType ID1>,< MessageType ID2>,...]&IncludeItemHistory=[True or False]& ItemHistoryEventType=[1, 2, 3, 4, and/or 5]
POST https://<Reporting endpoint base URL>/OData/ItemDetailsAsync

ItemDetailsAsyncAPI - URL Parameter/Filters

The following parameters/filters can be used with the ItemDetailsAsync 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.

ReportName	Mandatory	Specify the name of the report you want to generate. Limitations The report name can be up to a maximum of 256 characters long. Special characters are not allowed; only alphanumeric values are permitted.
StartDate	Mandatory	StartDate refers to the beginning of the date range used to filter items in Insight Surveillance. The interpretation of this filter depends on the selected DateType: If DateType = CaptureDate, StartDate refers to the date the items were captured or ingested into Insight Surveillance. If DateType = ItemHistoryDate, StartDate refer to the dates when specific actions - such as commenting, labeling, or escalation - were initially performed on the items. Data Type Date in the YYYY-MM-DD format that is StartDate.
EndDate	Mandatory	EndDate refers to the end of the date range used to filter items in Insight Surveillance. The interpretation of this filter depends on the selected DateType: If DateType = CaptureDate, EndDate refers to the date the items were captured or ingested into Insight Surveillance. If DateType = ItemHistoryDate, EndDate refer to the date when specific actions - such as commenting, labeling, or escalation - were finally initially performed on the items. Data Type Date in the YYYY-MM-DD format that is EndDate.
DateType	Optional	Specify the date type to return the count of item IDs based on their capture date or the item history date. Select any of the following options as required: CaptureDate This option is selected by default. It is the specific date on which the item is captured into the Insight Surveillance application. If you select this option, the result includes items captured within the specified date range inside surveillance, along with the metadata and complete history of those items. ItemHistoryDate Select this option if you want to get item count by the item history date. It is a specific date, falling within the range of the StartDate and EndDate, on which the item's historical event occurred. If you select this option, the result includes items captured within the specified date range inside surveillance, along with the metadata and complete history of those items. Data Type String.
Departments	Optional	Specifies the departments to which the 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. To include results for all departments of a specified customer in a report, do not specify any department IDs in a query. To include results for specific departments of a specified customer in a report, specify department IDs in the query. Note: To get the Department IDs, See Departments API. Refer to the departmentId field only.
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 MessageTypes IDs. Limitation: As an input, the ItemDetails API can pass maximum 100 MessageTypes IDs on a single page.

IncludeItemHistory	Optional	Determines whether the history of items is included or excluded in the output. Set this value as False to exclude history of items from the output. By default this value is set to False. Set this value as True to include history of items in the output.
ItemHistoryEventType	Optional	Includes or excludes the item history event type in the output based on the value set for the IncludeItemHistory field.
		If the DateType = CapturedDate (default) and IncludeItemHistory = False, then, the report compares dates with the item's CaptureDate and does not include item history in the results. Refer to the sample scenario below. If the DateType = CapturedDate (default) and ItemHistoryEventType is set to 1 (Appraisal), 2 (Comment), or 4 (Action Status - Mark)), then, the report returns: Items are captured within a specified date range. From the captured items, results are further filtered based on event type (e.g., Appraisal, Comment, Mark). For the filtered items, full metadata and history are returned. Refer to the sample scenario below. If the DateType = ItemHistoryDate and ItemHistoryEventType is set to 2 (Comment), 3 (Escalation), or 5 (Action Status - Label), the report returns: Items with comment, escalation, or label actions performed between the specified start and end dates are retrieved. From these results, full metadata and history are returned for each item. Refer to the sample scenario below. Items that have comment, escalation, or label actions performed between the specified start and end dates. From that result, full metadata and history is returned for those items.
		Possible values of item history event type are: 1 - Appraisal 2 - Comment 3 - Escalation 4 - Action Status - Mark 5 - Action Status - Label 6 - Action Status - Preview Data Type: Integer ID of the item. Limitation As an input, this API can pass maximum of 10 ItemHistoryEventType IDs.

Scenario 1: A new request to submit the report when DateType = CaptureDate

Sample input:

Sample response:

Scenario 2: A new request to submit the report when DateType = ItemHistoryDate

Sample input

Sample response:

Scenario 3: A new request to submit the report when IncludeItemHistory = False. ItemHistoryEventType is ignored/excluded from the report.

Sample request:

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 Item Details.
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 whether 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.

Call the ReportStatus API to get the status of the ItemDetailsAsync API report. See Report Status API.
Once the report is ready, call the ItemDetails API to retrieve the report data from the asynchronous API. See Item Details API.