Arctera™ Insight Surveillance User Guide
- Introducing Arctera Insight Surveillance
- Getting started
- Working with dashboard widgets
- Managing employee groups
- Managing departments
- About departments
- Understanding the Departments page
- Searching departments
- Creating departments
- Moving existing departments under other departments
- Adding monitored employees and employee groups to departments
- Editing monitoring policies
- Editing department details and monitoring policy
- Managing exception employees
- Designating employees as exception employee
- Assigning further exception reviewers to an exception employee
- Removing exception status
- Removing exception reviewers
- Managing department users
- Managing department-level searches
- Managing department-specific hotword sets
- Managing department-specific labels
- Managing department-specific trash rules
- Managing department-specific allowlist rules
- Managing department-specific review comments
- Viewing employees associated with departments
- Managing users, roles, and permissions
- Overview
- Predefined user roles and permissions
- Adding new roles for users (employees) and employee groups
- Editing user roles and permissions
- Deleting user roles
- Assigning Insight Surveillances to users (employees) and employee groups
- Restricting users to use hotwords in searches
- Removing a user role
- Managing application-level searches
- Managing application-specific hotword sets
- Managing application-specific labels
- Managing application-specific trash rules
- Managing application-specific allowlist rules
- Managing application-specific review comments
- Managing data requests
- Managing search schedules
- Managing export operations
- Managing reviews
- About reviewing with Insight Surveillance
- Limitations on reviewing certain types of Skype for Business content
- Understanding the Review page
- Changing the Preview pane position
- Rearranging columns in the item list pane
- Customizing item navigation in Review grid
- Filtering the items in the Review pane
- Viewing dynamic review item counts on the calendar
- Reviewing the Audio-Video Transcript type items
- Reviewing searched items
- Translating email and attachment content for review
- Translating collaboration message for review
- Adding or removing text for machine learning
- Assigning review status to items
- Viewing hotwords highlighting
- Viewing hotwords in collaboration message
- Viewing tags highlighting
- Viewing predicted labels of review items
- Viewing the full content in a new window
- Adding comments to items
- Escalating the review items
- Applying labels to items
- Viewing history of items
- Printing and downloading the items and attachments
- Viewing Intelligent Review Details
- Working with reports
- About Insight Surveillance reports
- Predefined reports
- Enhanced reporting
- Configuring a reporting endpoint
- Authentication
- Departments API
- Users API
- Roles API
- User Roles Async API
- User Roles API
- Classification Tags API
- Labels API
- Searches API
- ItemMetrics API
- Reviewer Mapping Async API
- Reviewer Mapping API
- MonitoredEmployees API
- Evidence Of Review Async API
- Evidence of Review API
- Item Classification Metrics Async API
- Item Classification Metrics API
- Item Label Metrics Async API
- Item Label Metrics API
- Item Archived Metrics Async API
- Item Archived Metrics API
- Item Hotword Metrics Async API
- Item Hotword Metrics API
- Item Details Async API
- Item Details API
- Reviewer Assessment Metrics Async API
- Reviewer Assessment Metrics API
- Report Status API
- Supported OData query options
- Supported reporting endpoint API filters and their values
- Responses
- Managing Power BI templates for reporting APIs
- Accessing Insight Surveillance reports and datasets through the OData web service
- Guidelines for using Insight Surveillance templates with Microsoft Power BI Desktop
- TEMPLATE - Departments, Users, Roles, Labels
- TEMPLATE - User Roles - Submit Report Request
- TEMPLATE - User Roles - View Report Data
- TEMPLATE - Item Metrics
- TEMPLATE - Reviewer Mapping - Submit Report Request
- TEMPLATE - Reviewer Mapping - View Report Data
- TEMPLATE - Searches
- TEMPLATE- Item Classification Metrics - Submit Report Request
- TEMPLATE- Item Classification Metrics - View Report Data
- TEMPLATE- Item Archived Metrics - Submit Report Request
- TEMPLATE- Item Archived Metrics - View Report Data
- TEMPLATE- Item Label Metrics - Submit Report Request
- TEMPLATE- Item Label Metrics By Employee - View Report Data
- TEMPLATE- Item Label Metrics By Department - View Report Data
- TEMPLATE- Item Hotword Metrics - Submit Report Request
- TEMPLATE- Item Hotword Metrics - View Report Data
- TEMPLATE- Item Details - Submit Report Request
- TEMPLATE- Item Details - View Report Data
- TEMPLATE- Reviewer Assessment Metrics - Submit Report Request
- TEMPLATE- Reviewer Assessment Metrics - View Report Data
- TEMPLATE- Evidence Of Review - Submit Report Request
- TEMPLATE- Evidence Of Review By Monitored Employee - View Report Data
- TEMPLATE- Evidence Of Review By Department - View Report Data
- TEMPLATE- Evidence Of Review With Item Archived Metrics - Submit Report Request
- TEMPLATE- Evidence Of Review With Item Archived Metrics - View Report Data
- Saving, editing, and refreshing the Power BI reports
- Managing Audit Settings
- Working with Audit viewer
Configuring a reporting endpoint
To configure a reporting endpoint, you must have a System Admin role or the Configure Reporting API Endpoint permission to your role. If you do not have this permission, contact your system administrator.
In this release, only one reporting endpoint configuration can be created. After the endpoint is configured, you can change the configuration, regenerate API keys, and activate or suspend the endpoint as needed.
To configure a reporting endpoint
- In the left navigation pane, select Configuration > Reporting Endpoint tab.
- Click Add.
- On the Add New Endpoint Configuration page, specify the following details and click Save.
Name
Specify a unique name for the reporting endpoint configuration.
Description
Provide a brief description of the reporting endpoint configuration.
Scope
Decides which APIs are accessible via current configuration.
By default, it is set to All API.
IP Address
Specify individual IP Addresses that are allowed to access APIs via current configuration.
Note:
Only IPv4 addresses are supported in this release.
IP Address range
Specify the range of sequential IP Addresses that are allowed to access APIs via current configuration.
IP addresses outside of that range are not permitted to access the API.
Note:
Only IPv4 addresses are supported in this release.
Select at least one of the checkboxes (IP Address or IP Address Range) and provide valid IP values for the same.
If neither IP Address nor IP Address Range is selected, IP address validation is disabled, allowing unrestricted API access. In such cases, a confirmation message is displayed before saving the configuration.
Primary and Secondary API Key
After saving the reporting endpoint configuration, the application automatically generates primary and secondary API keys and saves them to the reporting endpoint configuration.
API callers need to specify any of these API keys to access these APIs.
Note:
The primary and secondary API keys are provided so that if you want to replace any of the keys, you can use another one without experiencing any downtime.
Endpoint Base URL
After saving the reporting endpoint configuration, the application generates the Endpoint Base URL automatically. API callers must use this URL as the starting point for accessing API.
Ensure that the configured reporting endpoint is listed on the Reporting Endpoint tab. If required, click the Refresh icon. The application masks primary and secondary keys for security reasons.
- Click the kebab icon (three vertical dots) in the same row to perform the following actions:
To view or hide the keys, select Show/hide keys.
To copy the base URL, primary key, and secondary key, click the Copy icon in the respective column, or click the reporting endpoint name and copy the required information.
To edit the reporting endpoint configuration, select Edit. Modify the configuration as needed and click Save.
To regenerate the API keys, click Regenerate adjacent to the primary and secondary API key fields.
Note:
API keys can be regenerated for the active reporting endpoints only.
To suspend the active reporting endpoint, select Suspend to block access to the Reporting APIs. Specify the reason for suspending the reporting endpoint and click Suspend.
To activate the suspended reporting endpoint and regenerate primary and secondary keys, select Activate.
Select the primary and secondary API key generation check boxes as needed. Specify the reason for activating the reporting endpoint and click Activate. The application displays the date of expiry for these API keys.