For AI agents: the docs index is at https://guide.ximasoftware.com/llms.txt. Append .md to any documentation page URL to get its markdown version.
Jump to Content
ChronicallGuidesChangelogDownloads
GuidesChangelog
GuidesChangelogDownloadsGet HelpLog InChronicall
Guides
Get HelpLog In
Tips and Tricks Videos

Getting Started

  • Chronicall Guide Home
  • Xima Care - Overview
  • Contacting The Xima Support Team
  • Product Overview
  • How to Find My Chronicall or Avaya Call Reporting Serial Key
  • Training Videos
  • Tips and Tricks Videos
  • Active Directory Integration
  • Best Practices
    • Agent Dashboards
    • Contact Center
    • Cradle to Grave
    • Custom Reports
    • Realtime
    • Recording Library
    • Reporting
    • Software Administration
  • Teamviewer Download

Reports

  • Reports Overview
  • List of Standard Reports
  • Cradle to Grave
    • Cradle to Grave - Quick Start Guide
    • Cradle to Grave Filter Definitions
    • Cradle to Grave Terminology
    • How to Adjust Column Layouts
    • Hidden Fields in Cradle to Grave
    • Cradle to Grave - Saving Filters
    • Extension Override Feature
    • Search for a Specific Phone Number
  • Run Reports - Java
  • Run Report - HTML
    • 911 Calls
    • Abandoned Call Count
    • Account Code Summary
    • Advanced Timeframe
    • Agent Call and Chat Performance Summary
    • Agent Call Cost
    • Agent Call Cost Summary
    • Agent Calls
    • Agent Call Summary
    • Agent Call Volume
    • Agent Chat Summary
    • Agent Event Summary
    • Agent Inbound Calls
    • Agent Inbound Summary
    • Agent Outbound Calls
    • Agent Outbound Summary
    • Agent Performance Summary
    • Agent Realtime Feature Trace
    • Agent Reason Code Report
    • Agent Scorecard Summary - {Campaign}
    • Agent Summary by Group
    • Agent Talking Summary
    • Agent Time Card
    • Agent Transfer Summary
    • Audit Events
    • Base System Totals
    • Calls by Account Code
    • Callback Details
    • Call Details
    • Call Details (Basic)
    • Call Direction Summary
    • Calls by Call Direction
    • Calls by Caller ID
    • Calls by Campaign - {Campaign}
    • Calls by External Party
    • Campaign Summary - {Campaign}
    • Chat Volume
    • Conference Calls
    • Contact Center Agent Performance Summary
    • Contact Center Agent Reason Code Trace
    • Emergency Calls
    • Event Sequence Call List
    • Event Sequence Calls by Agent
    • Event Sequence Calls by User
    • Excessive (Event Type) by Agent
    • Excessive (Event Type) by Group
    • Excessive (Event Type) by User
    • External Number Summary
    • Group Abandoned Call Count
    • Group Chat Queue Summary
    • Group Chat Summary
    • Group Event Summary
    • Group Presented Calls
    • Group Scorecard Summary - {Campaign}
    • Group Summary
    • Group Summary by Agent
    • Group Summary by User
    • Inbound Caller ID Summary
    • Inbound Call Performance
    • Inbound Calls by Local Number
    • Inbound Call Service Level
    • Inbound Call Summary
    • Inbound Group Summary
    • Local Number Inbound Summary
    • Lost Call Summary
    • Outbound Calls by External Party
    • Outbound Call Summary
    • Queued Calls by Group
    • Queued Call Volume
    • Queued Summary by Group
    • Reason Code Report
    • Roles Call Cost
    • Roles Call Cost Summary
    • Scores by Agent - {Campaign}
    • Scores by Group - {Campaign}
    • Skill Queue Callback Summary
    • Skill Queue Call Volume
    • User Call Cost
    • User Call Cost Summary
    • User Calls
    • User Call Summary
    • User Call Volume
    • User Event Summary
    • User Inbound Calls
    • User Inbound Summary
    • User Outbound Calls
    • User Outbound Summary
    • User Performance Summary
    • User Summary by Group
    • User Talking Summary
    • User Transfer Summary
    • Tag Summary
    • Transferred Inbound Calls Report
    • Trunk Usage by Time
    • Trunk Usage Summary
    • Agent Reason Code Trace
  • Agent vs. User
  • Agent / User vs. Group Values
  • Schedule Report - HTML Version
  • Schedule Report - Java Version
  • The Event Sequence Editor
  • How to Import/Export Reports
  • How to Import/Export Reports (Java Version)
    • How to Export a Report
    • How to Import a Report
  • Manage Call Cost Profiles
  • Abandoned Calls vs. Missed Calls
  • Avaya Communication Manager Reports
    • Call Detail View
    • CDR Reports
    • CM Reports
    • Group Summary by Station and Agent
    • Inbound Calls by VDN
    • Station and Agent Calls Report
    • Station and Agent Call Summary
    • Station and Agent Call Volume
    • Station and Agent Event Summary
    • Station and Agent Inbound Calls
    • Station and Agent Inbound Summary
    • Station and Agent Outbound Calls
    • Station and Agent Outbound Summary
    • Station and Agent Performance Summary
    • Station and Agent Realtime Feature Trace
    • Station and Agent Reason Code Trace
    • Station and Agent Summary by Group
    • Station and Agent Talking Summary
    • Station and Agent Time Card
    • Station and Agent Transfer Summary
    • System Inbound Call Performance
    • VDN Inbound Summary
  • Verifying Data Using Cradle to Grave
  • Why Don't Call Count Totals in the Column Match the Summary?

Custom Reports

  • Report Styles
  • Creating a Report in Java
  • Creating a Report in HTML
  • Editing Reports in Java
  • Editing an Existing Report in HTML
  • Creating Custom Formulas
  • Advanced Criteria Editor
  • Creating a Parameter
  • Creating a Post-Call Survey (Java Version)
  • Creating a Custom Report Skin
  • Schedule a Month to Date Report
  • Regular Expressions

Custom Report Metrics

  • Report Filter Criteria
  • Agent Report Metric Definitions
  • Account Code Report Metric Definitions
  • Call Direction Report Metric Definitions
  • Call Report Metric Definitions
  • Caller ID Report Metric Definitions
  • Event Report Metric Definitions
  • External Number Report Metric Definitions
  • Feature Report Metric Definitions
  • Group Report Metric Definitions
  • Skill Report Metric Definitions
  • Local Number Report Metric Definitions
  • None Report Metric Definitions
  • Reason Code Report Metric Definitions
  • Role Report Metric Definitions
  • Scorecard Campaign Report Metric Definitions
  • System Report Metric Definitions
  • Tag Report Metric Definitions
  • Time Report Metric Definitions
  • Trunk Report Metric Definitions
  • Understanding and Using Interval Credit Modes

Recording

  • Recording Library Overview
  • Listen to Recordings
  • Additional Recording Functions
  • View Active Recordings
  • Manage Pause Permissions
  • Manage Recording Rules
  • Creating a Scorecard Campaign
  • Scoring a Call with Scorecards
  • Configuring Recording Library
  • Configuring Storage Pools
  • VRTX Configuration
  • Recording Monitor Live Listen
  • Configuration of SFTP for Windows
  • Recording Encryption
  • Setting Up Caller Consent
  • Exporting and Importing Audio Files for the Recording Library
  • Port Mirror Configuration Within Chronicall
  • Configure SFTP for VM Pro Recordings (Linux to Linux) ## Overview
  • Ignoring SIP Extensions for Recording

Realtime Displays

  • Realtime Overview
  • Agent Timeline
  • Group Timeline
  • Building a Wallboard - HTML
  • Building a Wallboard - Java
  • Using Pre-Built Wallboards - HTML
  • Realtime Count Definitions
  • Using Pre-Built Wallboards - Java
  • Realtime Alerts and Triggers
  • Using Supervisor View
  • Creating a Wallboard Loop
  • Creating Custom Formulas - Java
  • Creating Custom Formulas - HTML
  • Exporting / Importing a Wallboard (HTML)

Installation

  • Chronicall on Avaya IP Office - Server Installation
  • Avaya IP Office - Server Requirements
  • Contact Center (Multimedia) Installation Guide - Avaya IP Office
  • Updating Chronicall
  • Stopping and Starting Chronicall Services
  • Single/Stacked SIP Extension
  • Routing by Short Code and Tag Identifiers
  • Salesforce Integration Plugin for Contact Center Agent Client
  • Linux Fresh Installation Guide
  • Setting Up Auto Answer for Agents on IP Office
  • OVA Q&A Sheet - Avaya Version
  • OVA Q&A Sheet
  • Avaya CM Server Requirements
  • Avaya CM - Server Installation
  • Cisco Server Requirements
  • Microsoft Teams Integration - IP Office
  • Cisco Server Requirements OLD and HIDDEN
  • Cisco Installation FAQs
  • Anti-Virus/Firewall Exclusions
  • Ports used by Chronicall
  • Chronicall/ACR Migration
  • Configuration Requirements (Avaya IP Office)
  • Chronicall Desktop Installation on Mac
  • CTI Link Pro and DevLink 3: Varieties and Which to Use
  • Chronicall/ACR Network Database Migration
  • Configuring SIP Devices On Avaya CM
  • Avaya Communicator / IX Workplace FAQ
  • Configuring DevLink3
  • How to Run Apps Installer (Linux)
  • Updating to 4.2.10 / 4.4 Checklist
  • WebSocket DevLink3 Configuration

Realtime Metrics

  • HTML Chronicall Realtime Metric Definitions
  • Java Chronicall Realtime Metric Definitions
  • Realtime Filter Criteria Definitions
  • Realtime Wallboard Widgets - Java
  • Realtime Wallboard Widgets - HTML
  • Realtime Duration Definitions
  • Realtime Miscellaneous Definitions

Agent Dashboards

  • Dashboard Values
  • Account Codes
    • Adding Notes to Calls
  • Reason Codes
    • Busy Codes
    • Group Logout Reason Codes
    • Extension Logout Reason Codes
  • Desktop Presence Tool
  • Agent Dashboards Overview
  • How to Dock to the Non-Primary Screen with Agent Desktop

Contact Center (Multimedia)

  • Contact Center (Multimedia) Overview
  • Create a Contact Center (Multimedia) Skill
  • Queue Callbacks Ports - How They Work
    • Queue Callback - Quick Start Guide
    • Queue Callback Events
    • Queue Callback Realtime Definitions
  • Contact Center (Multimedia) Realtime Definitions
  • Best Practices for Service Restarts for Contact Center (Multimedia) Agents
  • Licensed Skills-Based Agents
  • Web Chat Overview
  • Setting Up and Using Web Chat
  • Set Up and Use Contact Center Agent Client (CCAC)
  • Setting Up Chronicall to Use WebRTC
  • Setting Up a Queue Callback
  • Accessing Wallboard in Contact Center Agent Client
  • Using WebRTC
  • Busy on Held for Agents (Java Version)
  • Configuring After Call Work and Missed Call Work
  • Creating a Language Pack (Java Version)
  • Language Pack Scripts
  • Contact Center (Multimedia) Routing Algorithms
  • Changing an Agent's Chat Nickname in Web Chat
  • Contact Center (Multimedia) Reason Codes
  • Contact Center Agent Values in HTML Wallboards
  • Warm Transfer on WebRTC
  • Availability Tiers
  • IP Office Single Sign-On
  • Configuring Random Queue Music
  • Creating Default Skill Group
  • How Does Chronicall Multimedia Calculate Estimated Wait Time?
  • Add Call Tags with Multimedia/Contact Center Routing
  • Click to Dial with the Salesforce Plugin
  • How To Allow Access to CCAgent from a Public IP
  • Test Your Multimedia SIP Extensions
  • Sending Skill Group Calls to Voicemail
  • Decoupled Dashboards for Contact Center Agents
  • Contact Center (Multimedia) Fail-Over in IP Office Manager

Agent Management

  • User Accounts
  • Agent Roles
  • Agent Licenses
  • Licensed Realtime Agents
  • Licensed Desktop Agents
  • Refresh Agents and Groups
  • Licensing Agents (Java Version)
  • Licensing Users in HTML

Administration

  • System Settings (Avaya IP Office)
  • Alerts and Triggers
  • Manage Backups
  • Creating and Resetting Desktop Password
  • Refresh Agents and Groups
  • Manage Call Cost Profiles
  • Changing Standard Report/Realtime Language
  • Restricted View
  • Swapping Out Serial Keys
  • Implementing the Privacy Blacklist to Hide Specific Callers Within Cradle to Grave
  • GDPR Privacy Tool Retention Policy
  • Disabling Username Suggestions
  • Caller Name Override
  • Report on Hunt Group Login/Logout (Avaya IX Workplace)
  • Restore a Backup
  • Perform an Unscheduled Backup
  • Scheduled Service Restarts via Task Scheduler - How To
  • Adding Newly Purchased Licenses
  • Setting Chronicall Timezone
  • BlueDB - Merging Two Databases
  • How Do I Decommission the 3.12 Services After Updating to BlueDB?
  • SMTP Setup
  • Best Practices After Server Reboots
  • Special Characters for Users and Groups

VRTX

  • VRTX Overview
  • VRTX Configuration
  • Manually find the Channel Range for a VRTX Device
  • Mapping a USB Device (VRTX) for a Virtual Machine

Chronicall Desktop

  • Chronicall Desktop - Overview
  • Chronicall Desktop Application Windows Installation
  • Chronicall Desktop for Mac - Installation/Configuration
  • Emergency Notifications
  • Function of Chronicall Browserless
  • Functions of the Chronicall Desktop
  • Chronicall Desktop Command Line Switches
  • Change The IP Address of Chronicall Desktop for Mac

Security

  • User Accounts
  • How to Encrypt Recordings
  • Xima Software GDPR Compliance
  • Privacy Configuration (GDPR)
  • Configuring SSL/TLS
  • Using Your Own SSL Certificate with Chronicall/ACR

APIs

  • Click to Dial
  • Recording Data
  • Historical Call Data
  • Recording Pause/Resume
  • Realtime Data
  • Realtime Data over WebSocket
  • Screen Pop Profile
  • WebService Integration
  • Web Chat Javascript API
  • Web Chat Cloud Service Integration
  • Glossary
  • API Overview
  • Obtaining a Recording/Call Key
  • Accessing an Authentication Key
  • Configuring a Service User
  • Licensing Requirements
  • API Article Summary

Using APIs

  • Testing API Functionality
    • Realtime Data Example
    • Click To Dial Example
    • Recording Data Example
    • Historical Call Data Example
    • Obtaining a Recording/Call Key Example
    • Agent Recording Pause/Resume Example
    • Websocket Realtime Data Example

TROUBLESHOOTING

  • Basic Installation or Update Errors
  • VRTX Troubleshooting
  • Orient DB Service Won't Stay Connected
  • Troubleshooting Active Recording
  • VMPRO Troubleshooting
  • Contact Center Agent Client Logs Out Automatically
  • Increase Java Memory for Chronicall Desktop
  • Increasing Java Memory Limits (Chronicall/ACR)
  • Troubleshooting SSL/TLS (HTTPS) Connection
  • Unable to Open Chronicall
  • ACR (Avaya Call Reporting) Tomcat Logs Not Populating
  • Recording Library Storage Limit Causes Out Of Pools Error
  • Chronicall Cannot Find The Audio Recording
  • Missing Users
  • System Monitor Tracing for Active Recording
  • VMPRO Windows to Windows Network Share for Recording Library
  • Log Aggregator Tool
  • Can I Delete Chronicall Logs to Clear Up Space on My Hard Drive?
  • VMPro Recording - Files in VRL Folder are .opus Format
  • Unregistered Serial Key
  • Realtime is Currently Waiting for a PBX Connection
  • How to Display Unassociated/Pending Recordings
  • Does Chronicall Support Collective Call Ringing?
  • Working From Home Using Chronicall/ACR
  • Forced Login Fix - Realtime
  • Clean Wipe - Full Uninstall of Chronicall Desktop / Agent Dashboard
  • Queued Callback (QCB) Issues - Cannot Be Scheduled
  • How to Process Stuck Recordings from Purgatory
  • Chronicall Fails to Launch, But the Chronicall Services Are Running on the Server
  • How to Access Different Instances of Chronicall from One Chronicall Desktop
  • Error Processing Backup/Restore Request
  • Port Mirror/SIP Missed Packets
  • IP Addresses to Check Post Migration or Server IP Address Change
  • Queue Callback Strategies | Reserve Agent & Wait in Queue
  • Queued Callback (QCB) Issues - Scheduled Callbacks Are Not Reaching Customers
  • How to Adjust CDR Time for Chronicall (Avaya Aura)
  • Troubleshooting Missing Calls in Cradle to Grave/Call Detail View
  • Queued Callback | Outbound Dial Code | Long-Distance vs. Local
  • Special Characters in Licensing
  • Avaya CM/Aura Not Logging
  • Multimedia Web Chat Box Not Appearing
  • Calls Cannot Be Parked When Coming from Skill Group
  • Multimedia SIP Registration - 403 Unauthorized
  • Where Do I Find Agent Dashboard/Desktop Logs?
  • How To Turn On "Always Stay Logged In" For Realtime Users ## Question
  • Troubleshoot a Slow Chronicall Login
  • Proxy on the Chronicall & Multimedia Servers for Internal Traffic
  • Webchat - Error Message for Required Fields
  • Certification Issues with HTTPS and SSL
  • VRTX Testing
  • # Documentbase Update
  • SMS Test on Avaya CM
  • Multimedia SIP Registration - 503 Service Unavailable
  • Report Is Missing Data
  • Avaya IPO - Conflicting Recording Solutions
  • No Sound Card
  • Avaya CM Recordings Not Associating
  • Multimedia Skills or Agents Not Receiving Calls
  • Restarting CDR in Avaya Communications Manager
  • How to Enable Voicemail Groups for Avaya Communications Manager (CM)
  • Chronicall Cannot Detect The Recording Library
  • WebChat - Troubleshooting
  • Port Mirror Recording Failure
  • Log4j Zero-Day Vulnerabilities (CVE-2021-44228, CVE-2021-45046, CVE-2021-45105)

Tips and Tricks Videos

This has a compilation of videos that provide tips and tricks on how to use different features in Chronicall.

Alerts and Triggers

Drill Down Reporting

Emergency Notifications

Updated 6 months ago


Training Videos
Active Directory Integration