Search <book_title>...

Veritas Surveillance User Guide

Last Published: 2025-04-01

Product(s): Veritas Alta Surveillance (1.0)

Introducing Veritas Surveillance
1. About Veritas Surveillance
2. Key features of Veritas Surveillance
3. Feature comparison: Compliance Accelerator desktop client Vs Veritas Surveillance web client
4. Sampling support for content sources
5. About Veritas Surveillance system security
6. Veritas Surveillance multi-tier architecture
7. System requirements
Getting started
1. Signing in to Veritas Surveillance
2. Signing out from Veritas 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 Veritas 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 Veritas 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. Viewing history of items
21. Printing and downloading the items and attachments
Working with reports
1. About Veritas 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 Classification Metrics Async API

ItemClassificationMetricsAsync

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.

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

To use the ItemClassificationMetricsAsync API, follow the steps below:

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

Sample Input

GET https://<Reporting endpoint Base URL>/odata/ ItemClassificationMetricsAsync?ReportName=<Name of the report>&StartDate= <YYYY-MM-DD>&EndDate=<YYYY-MM-DD>&Departments=[<DeptID1>,<DeptID2>,...] &Tags=[<tagId1>,<tagId2>...]
POST https://<Reporting endpoint base URL>/OData/ItemClassificationMetricsAsync

ItemClassificationMetricsAsync - URL Parameter/Filters

The following parameters/filters can be used with the ItemClassificationMetricsAsync 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 date items are captured or ingested in Veritas Surveillance and recorded as their CaptureDate. Specify the start date to return the count of items with a CaptureDate on or after this date. Data Type Date in the YYYY-MM-DD format that is StartDate.
EndDate	Mandatory	Specify the end date to return the count of items with a CaptureDate on or before this date. Data Type Date in the YYYY-MM-DD format that is StartDate.
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. 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.
Tags	Optional	Specifies the classification tags of the captured items and returns item counts for those tags. Data Type JSON array of integers 'id'(identifier fields) that is Tag IDs. Limitation As an input, this API can pass maximum of 1000 Tag IDs. To include results for all the classification tags of a specified customer in a report, do not specify any classification tag ID in a query. To include results for specific classification tag IDs of a specified customer in a report, specify classification tag IDs in the query. Note: To get the Tag IDs, See Classification Tags API. Refer to the tagID field only.

Scenario 1: New request to submit a report.

Sample input:

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

Scenario 2: The same request has been submitted again within one minute.

Sample response:

Call the ReportStatus API to get the status of the ItemClassificationMetricsAsync API report. See Report Status API.
Once the report is ready, call the ItemClassificationMetrics API to retrieve the report data from the asynchronous API. See Item Classification Metrics API.