Skip to content

MiaRec Documentation | User Guide

Overview

Initializing search

All documentation
Go MiaRec Web-site

MiaRec Documentation

User Guide
User Guide
- Introduction
- Getting started
  Getting started
  - Logging in
  - At a glance
- Dashboard
  Dashboard
  - Overview
  - Dashboard metrics
    Dashboard metrics
    
    Call metrics
    
    Sentiment metrics
    
    Topic metrics
  - Filter data
  - Compare to previous period
  - Drill-down capabilities
- Recordings
  Recordings
- Search
  Search
- Reports
  Reports
  - Overview
- My Profile
  My Profile
- Download PDF
Reporting User Guide
Reporting User Guide
- Overview
- Prerequisites
- Report Templates
  Report Templates
- Reports
  Reports
- Report Types
  Report Types
- List of Columns Available
  List of Columns Available
- Download PDF
Agent Evaluation User Guide
Agent Evaluation User Guide
- Overview
- Prerequisites
- Form Designer
  Form Designer
  - Create Evaluation Forms
  - Score Calculation Logic
- Manual scoring
  Manual scoring
  - Evaluate Interaction
- Auto scoring
  Auto scoring
  - Review Automatic Scores
- Reporting and Dashboard
  Reporting and Dashboard
  - QA Dashboard
- Download PDF
Speech Analytics User Guide
Speech Analytics User Guide
- Introduction
- Getting started
  Getting started
  - At a Glance
- Transcription
  Transcription
  - Transcription
- Call Summary
  Call Summary
  - Call Summary
- Sentiment analysis
  Sentiment analysis
  - Sentiment Analysis
- Topics analysis
  Topics analysis
- AI Insights
  AI Insights
  - AI Insights
- Download PDF
Data Redaction User Guide
Data Redaction User Guide
- About Data Redaction
- Configure Data Redaction
  Configure Data Redaction
- Download PDF
Moments Query Language Reference Guide
Moments Query Language Reference Guide
- Introduction
- MQL Syntax
  MQL Syntax
- Download PDF
Admin Guide
Admin Guide
- Introduction
- Single Sign-On
  Single Sign-On
- Two-step Verification
  Two-step Verification
  - Overview
  - Setup two-step verification
    Setup two-step verification
    
    Overview
    
    SMS-based verification
    
    Email-based verification
    
    Authy app-based verification
  - Enforce two-step verification
- User Management
  User Management
  - Understanding user roles and permissions
  - Roles
  - Groups
  - Users
  - Associating call with users
  - Configuring LDAP integration
  - Multi-tenancy
    Multi-tenancy
    
    Understanding multi-tenancy
    
    Enable multi-tenancy in MiaRec
    
    Add tenant
- Storage Management
  Storage Management
  - Audio file encryption
    Audio file encryption
    
    File encryption overview
    
    Configuration check-list
    
    Create new encryption key
    
    Import encryption key
    
    Export encryption key
    
    Grant access to encryption key
    
    Enable file encryption
    
    Export of the encrypted files
  - Audio settings
  - Backup and restore
    Backup and restore
    
    Backup call recordings
    
    Restore call recordings
  - Location for audio files
    Location for audio files
    
    Overview
    
    File name format
    
    Time formatting inside file name
  - Replication
    Replication
    
    MiaRec multi-master asynchronous replication
    
    Use cases for replication
    
    Configuring target server (recipient)
    
    Configuring replication server (sender)
  - Retention policy
- Customization
  Customization
- Security
  Security
- High availability
  High availability
- Maintenance
  Maintenance
  - Troubleshooting
    Troubleshooting
    
    Log files
    
    MiaRec recorder trace
  - Increase/expand an EXT4 filesystem in RHEL 6 / CentOS 6
  - Increase/expand an XFS filesystem in RHEL 7 / CentOS 7
  - License
- Download PDF
Screen Recording Admin Guide
Screen Recording Admin Guide
- Introduction
- How It Works
- Installation
  Installation
- Troubleshooting
  Troubleshooting
  - Troubleshooting on Client Side
  - Troubleshooting on Server Side
- Deploy Screen Capture Client with Windows Group Policy
  Deploy Screen Capture Client with Windows Group Policy
- Download PDF
Installation Guide
Installation Guide
- Overview
- Hardware Requirements
  Hardware Requirements
- MiaRec Architecture
- Installation
  Installation
  - Ansible-based installation on Linux
    Ansible-based installation on Linux
    
    Overview
    
    1. Prepare controller host
    
    2. Prepare target hosts
    
    3. Configure deployment
    
    4. Run playbooks
    
    5. Verify MiaRec operation
  - VMWare OVA template-based installation
  - Deploying MiaRec on Amazon AWS (up to 2,000 users)
    Deploying MiaRec on Amazon AWS (up to 2,000 users)
    
    1. Network architecture
    
    2. Create VPC
    
    3. Create EC2 instances
    
    4. Configure Elastic IP address
    
    5. Install MiaRec software on EC2 instance
    
    6. Configure Route 53 DNS Failover for web traffic
    
    7. Configure DNS SRV for SIPREC traffic
    
    8. Configure SIPREC recording
    
    9. Configure automatic file relocation to Amazon S3
    
    10. Configure MiaRec replication
    
    11. Configure HTTPS for web server
    
    12. Configure CloudWatch monitoring
    
    13. Disaster recovery plan
  - Installation on Windows
- Update
  Update
- Post-installation tasks
  Post-installation tasks
  - Firewall configuration
  - Enable https for miarec web portal
    Enable https for miarec web portal
    
    Setup free SSL certificate for MiaRec using Let's Encrypt (Centos 6/7)
    
    Setup free SSL certificate for MiaRec using Let's Encrypt (Ubuntu 14.04)
    
    Setup SSL certificate for MiaRec Web portal on Centos
- Download PDF
MiaRec Data Backup Guide
MiaRec Data Backup Guide
- Overview
- Requirements
- Backup Database
  Backup Database
- Restore Database
  Restore Database
- Relocate Audio Files
  Relocate Audio Files
  - Prerequisites
  - Configure File Relocation Job
- Download PDF
REST API v2 Developer Guide
REST API v2 Developer Guide
- Overview
- Introduction
  Introduction
- Resources
  Resources
  - Calls
    Calls
    
    Call object fields
    
    File object fields
    
    Participant object fields
    
    List and search calls
    List and search calls
    
    List and search calls
    
    Basic search
    
    Advanced search
    
    View one call
    
    Set custom field values
    
    Delete one call
    
    Retrieve file for playback
    
    Pause and resume recording
  - Clients
    Clients
    
    Client object fields
    
    List and search clients
    
    View a client
    
    Create a client
    
    Update a client
    
    Delete a client
  - Custom fields
    Custom fields
    
    Custom field attributes
    
    List and search custom_fields
    
    View a custom field
    
    Create a custom field
    
    Update a custom field
    
    Delete a custom field
  - Encryption keys
    Encryption keys
    
    List and search encryption keys
    
    View encrypt key
    
    Create encrypt key (generate or import)
    
    Update encrypt key
    
    Delete encrypt key
    
    Grant access to encrypt key
    
    Revoke access to encrypt key
    
    List authorized users
  - Evaluation forms
    Evaluation forms
    
    Oveview
    
    List Evaluation Forms
    
    View Evaluation Form
  - Evaluation reports
    Evaluation reports
    
    Oveview
    
    List Evaluation Reports
    
    View Evaluation Report
  - Groups
    Groups
    
    Group object fields
    
    List and search groups
    
    View one group
    
    Create group
    
    Update group
    
    Delete group
  - Report runs
    Report runs
    
    Oveview
    
    List Return Runs
    
    View Report Run
    
    View Report Run Data
  - Reports
    Reports
    
    Oveview
    
    Report Template attributes
    
    List Report Templates
    
    View Report Template
  - Roles
    Roles
    
    Role object fields
    
    List and search roles
    
    View one role
    
    Create role
    
    Update role
    
    Delete role
  - Tenants
    Tenants
    
    Tenant object fields
    
    List and search tenants
    
    View one tenant
    
    Create tenant
    
    Update tenant
    
    Delete tenant
    
    View one tenant
  - Users
    Users
    
    User object fields
    
    List and search users
    
    View one user
    
    Create user
    
    Update user
    
    Delete user
    
    Pause and resume recording for user
- Examples
  Examples
  - Create tenant with roles, groups and users
- History of changes
- Download PDF
Avaya Aura Recording Integration Guide
Avaya Aura Recording Integration Guide
- Overview
- Avaya TSAPI DMCC Recording
  Avaya TSAPI DMCC Recording
- Avaya TSAPI Passive Recording
  Avaya TSAPI Passive Recording
- Download PDF
Avaya SBCE Recording Integration Guide
Avaya SBCE Recording Integration Guide
Broadworks Recording Integration Guide
Broadworks Recording Integration Guide
- Overview
- BroadWorks Configuration
- MiaRec Configuration
  MiaRec Configuration
- Download PDF
Cisco UCM Recording Integration Guide
Cisco UCM Recording Integration Guide
Cisco UCM Recording Announcement Integration Guide
Cisco UCM Recording Announcement Integration Guide
- Overview
- Installation Instructions
  Installation Instructions
- Download PDF
Cisco CUBE Network-based Recording Integration Guide
Cisco CUBE Network-based Recording Integration Guide
Cisco CUBE SIPREC Recording Integration Guide
Cisco CUBE SIPREC Recording Integration Guide
Five9 Integration Guide
Five9 Integration Guide
Metaswitch CFS Recording Integration Guide
Metaswitch CFS Recording Integration Guide
- Overview
- Metaswitch SIPREC configuration
- MiaRec configuration for Metaswitch call recording
- Ignore Metaswitch internal redirect numbers
- Automatic user provisioning
- High availability configuration
  High availability configuration
  - Siprec auto failover configuration
    Siprec auto failover configuration
    
    Overview
    
    Configure SIPREC auto-failover for a CFS-Perimeta-MiaRec connection
    
    Configure SIPREC auto-failover for a direct CFS-MiaRec connection
- Softkey integration with Polycom VVX (Metaswitch platform)
- Softkey integration with Yealink phones (Metaswitch platform)
- User authentication using Metaswitch CommPortal
- Download PDF
Microsoft Teams Integration Guide
Microsoft Teams Integration Guide
Twilio Flex Integration Guide
Twilio Flex Integration Guide
Soft Key Integration Guide
Soft Key Integration Guide
- Overview
- Configure MiaRec phone services
- Integration with Cisco SPA and 3PCC series phones
- Integration with Mitel/Aastra phones
- Integration with Polycom VVX series phones
- Integration with Yealink phones
- Softkey integration with Cisco 7900, 7800 and 8800 series phones
  Softkey integration with Cisco 7900, 7800 and 8800 series phones
- Download PDF
Release Notes
Release Notes

Overview

For details on reporting, check the Reporting User Guide.

Copyright © 2024 MiaRec, Inc.