Vocera Analytics

Release Notes - Version 1.2.4

Updated: April 19, 2021

Documentation Announcements for Vocera Analytics Release 1.2.0

Beginning this release, the upgrade and install sections are documented in a separate guide—Vocera Analytics Installation Guide. This new guide provides an installation workflow, a step-by-step installation procedure, and the corresponding configuration information for different scenarios based on your setup.

You can access the Vocera Analytics Installation Guide here: Vocera Analytics Installation Guide.

Note: The Vocera Analytics Administration Guide will no longer include the upgrade and installation sections.

About Vocera Analytics

Vocera Analytics provides a comprehensive view of all interruptions encountered by caregivers. Interruptions include voice calls, text messages, and alarms and alerts from clinical and operational systems. Vocera Analytics enables clinical leaders to review performance metrics, conduct comparisons, measure success rates, and identify areas for improvement. Based on this information, dashboards and reports can be constructed to monitor and drive continuous improvement.

Vocera Analytics comprises the following functionalities:

You can find documentation for this version of the product by clicking the question mark (?) in the header pane on all the pages of the Analytics console.

You can also access the following Vocera Analytics documentation directly from a web browser without being logged in:

Prerequisites

Before you install Vocera Analytics, your environment must contain the necessary prerequisites. The size of your server normally depends on the number of users that reference it and the number of beds at your site.

Vocera Analytics hardware prerequisites:

The details on the hardware requirements for the Vocera Analytics Server database are as follows:

Note: The requirements are different for small, medium, and large servers.

Small Medium Large
Memory 32 GB 64 GB 128 GB
CPU Octa-core Octa-core 12 Core
Disk Space 500 GB HDD (per year) with SSD Cache 1 TB HDD (per year) with SSD Cache 2 TB HDD (per year) with SSD Cache
Operating System
  • Windows Server 2019
  • Windows Server 2016
  • Windows Server 2012
  • Windows Server 2019
  • Windows Server 2016
  • Windows Server 2012
  • Windows Server 2019
  • Windows Server 2016
  • Windows Server 2012
Browser Support Internet Explorer 11, Firefox version 45.0.1.0 or later, Safari 11.1.2 or later, Google Chrome version 70 or later (JavaScript must be enabled).
Database (provided) MariaDB (MySQL) MariaDB (MySQL) MariaDB (MySQL)
Note: To run properly, the Vocera Analytics Agent running on a Vocera Voice Server (VS) / Vocera Platform 6.x will require 2 GB of RAM when interacting with a small or medium Vocera Analytics Server database and 4 GB of RAM when interacting with a large Vocera Analytics Server database. If the VS does not have sufficient memory to meet the mandated minimum memory for the VS plus the needs of the Vocera Analytics Agent, memory will need to be added to the VS. For example, a VS running version 5.2.3 requires a minimum of 8 GB of RAM. If the Vocera Analytics Agent will be interacting with a large Vocera Analytics Server database requiring 4 GB of RAM, the server running the VS and the Vocera Analytics Agent must have a minimum of 8 + 4 or 12 GB of RAM installed. If it does not, sufficient RAM to meet or exceed the 12 GB requirement should be added. If the VS is running in a virtual environment, Memory Over Subscription is not supported and the Host Server should have sufficient physical RAM to support the memory allocated to the Guest Servers plus the Hypervisor.

Validation Metrics: Performance Expectations

Data Inputs Small Medium Large
Vocera Voice Server Users 450 2000 5000-20000
VMP Users 200 3000 10000
Beds 293 500 1000
Engage users 450 (225 per shift) 1000 (500 per shift) 2000 (1000 per shift)
Clinical Alarms 2200 5000 9500
Nurse Call Alerts 3200 11000 22000
Orders 400 1200 2400
Lab Alerts 24 75 150
VMI Messages 2000 messages/day 10000 messages/day 60000 messages/day
Calls Per Day 2000 calls/day 10000 calls/day 60000 calls/day
VCS Messages 9000 messages/day 40000 messages/day 400,000 messages/day

Vocera Analytics software prerequisites:

To use the Vocera Analytics Server database, you must have the necessary software version available:

Other Considerations

To use Vocera Analytics, you must consider the following product requirements:

Vocera Analytics is the upgrade path for both Vocera Reporting Services and Engage Reporting. It is available for all Vocera systems (Standard or Enterprise License) and includes data migration for both VRS and Engage.

Infrastructure Considerations

To use Vocera Analytics, you must consider the following infrastructure requirements:

New and Enhanced Features

This section summarizes the new features and enhancements in this release.

New and Enhanced Features in Vocera Analytics 1.2.4

This release includes the following features:

New Features

Enhancements

New and Enhanced Features in Vocera Analytics 1.2.3

Vocera Analytics 1.2.3 is a maintenance release only. It contains no new features.

New and Enhanced Features in Vocera Analytics 1.2.0

This release includes the following features:

New Features

Enhancements

New and Enhanced Features in Vocera Analytics 1.1.0

This release includes the following features:

New Features

Enhancements

New and Enhanced Features in Vocera Analytics 1.0.0

Version 1.0.0 is the initial release of Vocera Analytics. This release includes the following features:

Install Vocera Analytics Remote Agent 1.2.4 HF on the Voice Server

Before you begin, ensure the following:

Note: VA 1.2.4 installer is applicable only for Windows machines. VA 1.2.4 installer is not applicable for custom installation.

To install the remote agent on the Vocera Voice Server, perform the following tasks:

Note: The Vocera Analytics Suite installs both the remote agent for Voice Server and Vocera Analytics.

  1. Login to Service Monitor using the link https://<Vocera Analytics IP>:9445/.

  2. On the configuration page, click Stop All Services.

  3. Copy the iso file/installer to the install drive on the Voice Server machine and extract the file.

    Note: Ensure that you perform on both Active and Passive Voice Servers.

  4. Right-click VoceraAnalyticsInstaller.exe> Run as administrator to launch the installer.

    The installer Welcome to the InstallShield Wizard for Vocera Analytics Suite 1.2.4 screen appears.

  5. Click Next.

    The Initialize a Configuration Backup screen appears.

  6. Click Backup Cfg.

    The installer takes a backup and displays the Ready to Install screen.

    Note: Do not close any installer windows that appear during backup.

  7. Click Install.

    The Installation Progress window appears. Do not close any installer windows that appear during installation.

  8. Click Finish.

    The InstallShield Wizard Completed screen appears.

    To validate that the remote agent is upgraded successfully and to check if the service monitor is installed and running, use the services.msc. The service monitor installed here is used to interact with the supervisor service monitor of the Vocera Analytics server.

    Note: In case of Voice Server cluster, you must upgrade the flume agent on both nodes (active and standby) in the Voice Server cluster. Perform the above steps to upgrade the flume agent on each node of the cluster.

Install Vocera Analytics 1.2.4 HF on the Analytics Server

Note: If Vocera Analytics 1.2.4 or 1.2.4 HF1 is already installed, skip steps from 1 to 11, proceed to step 12 and follow the steps. Ensure that all services are stopped before you begin installing the Vocera Analytics 1.2.4.2 patch. To verify the version installed on your machine, go to <Vocera Analytics Install Drive>\VoceraAnaytics and validate the VA Suite version. For VA 1.2.4 the version should be 1.2.40181 and the version for VA 1.2.4 HF1 should be 1.2.40181.1 in the version.txt file.
Note: Vocera Analytics 1.2.4 installer is applicable only for Windows machines. Vocera Analytics 1.2.4 installer is not applicable for custom installation.

To install the Vocera Analytics Suite on the Vocera Analytics Server, perform the following tasks:

  1. Login to Service Monitor using the link https://<Vocera Analytics IP>:9445/.

  2. On the configuration page, click Stop All Services.

  3. Right-click VoceraAnalyticsInstaller.exe> Run as administrator to launch the installer.

    The installer Welcome to the InstallShield Wizard for Vocera Analytics Suite 1.2.4 screen appears.

  4. Click Next.

    • If VMP pipeline is configured
      • The Select the VMP versions to backup screen appears.
        Note: The VMP version to backup is a local configuration backup and not the VMP SQL backup.
      • Select the installed VMP version.
        Note: Always choose the latest version from the dropdown, if the version of VMP installed is higher than what is displayed in the dropdown or if the installed version is not available in the dropdown.
      • Click Next.
    • If VMP pipeline is not configured
      • The Database Backup Option screen appears.

    Note: This screen appears only on systems that have VMP configured.

  5. Click Next.

    The Database Backup Option screen appears.

  6. Select an option:

    • Backup the database and configuration files—Select this option to backup both the database and configuration files.
    • Backup configuration files only—Select this option to backup only the configuration files.

  7. Click Next.

    The Verifying Disk Space screen appears. The verification may take several minutes depending on the size of your database.

    Note: The installer requires 3 times the space of VoceraAnalytics folder to be available on the installation drive to proceed with the installation.

    This screen appears only when you select Backup the database and configuration files option.

  8. Click Next.

    The Initialize a Database Backup screen appears.

  9. Click Backup DB.

    The installer takes a backup and displays the Ready to Install screen.

    Note: Do not close any installer windows that appear during backup.

  10. Click Install.

    The Installation Progress window appears. Do not close any installer windows that appear during installation.

  11. Click Finish.

    The InstallShield Wizard Completed screen appears.

    Upon successful installation, the ServiceMonitor service automatically restarts and launches the Service Monitor Dashboard page.

  12. From the downloaded media extract, right-click VA_1.2.4_HF2_27.exe > Run as administrator to launch the patch.

    The patch is launched and Vocera Analytics Server 1.2.4 HF2 screen appears.

  13. Click Yes to install the patch.

    A command window appears and executes the patch.

    Note: Do not click or close the command prompt window until you see Patch complete message.

  14. Type Y to view the logs and press Enter.

  15. In the log file, scroll to the end and verify that the following messages are displayed: The servicemonitor service was started successfully and Logging ended.

    Note: If the Program Compatibilty Assistant screen pops up, select the option This program installed correctly.

  16. Verify the patch is successfully applied. To verify, go to <Vocera Analytics Install Drive>\VoceraAnaytics and validate the VA Suite version is 1.2.40181.2 in the version.txt file.

  17. Create a Data Extraction User (reportuser). For more information, see Creating a Data Extraction User.

    Note: This is an additional step for Data Extraction user (reportuser). This step is applicable only for Data Extraction User (reportuser) as upgrading to Vocera Analytics 1.2.4 removes the Data Extraction user (reportuser). Hence, it should be recreated.

  18. Optimize Data Processing Configuration Settings for Vocera Analytics 1.2.4. For more information, see Updating Flume and Spark Configuration Settings for Vocera Analytics 1.2.4 to Optimize Data Processing.

  19. Upon completion, go to Service Monitor on Vocera Analytics server and click Start All Services after Vocera Analytics server and Voice Server/Platform Server are upgraded to Vocera Analytics 1.2.4 version.

Upgrade Recommendations for Vocera Platform 6.3

Ensure that you adhere to the following upgrade recommendations:

Install Vocera Analytics 1.2.4 HF on Vocera Platform

Before you begin, ensure that both Flume and Spark services are stopped.

Ensure that you are using the following RPMs:

Note: For information on RPMs required for the respective Vocera Platform version, see Supported RPMs.

Note:

Using the Vocera Analytics 1.2.4 RPM, you can perform a fresh install. Hence you no longer are required to install Vocera Analytics 1.2.0.

To upgrade Analytics Data Sync Service, Service Monitor, and Flume Agent from the RPM you must:

To upgrade Analytics Data Sync Service, Service Monitor, and Flume Agent on the Vocera Platform 6.x system, perform the following steps:

  1. Execute the following command to clean all cached information:

    sudo yum clean all

  2. Execute the following command to check for the latest RPM:

    sudo yum check-updates

  3. Search for the required RPM name by executing the command:

    sudo yum search vocera-analytics
    where vocera-analytics-data-sync-service is the RPM name.

  4. To upgrade, execute the command:

    sudo yum update vocera-analytics-data-sync-service.x86_64
    where vocera-analytics-data-sync-service.x86_64 is the RPM name.

    After you execute the command, the system displays the package details and prompts for a confirmation to install.

  5. Press y and subsequently press Enter to upgrade.

    The system upgrades the Analytics Data Sync Adapter and displays Complete! upon upgrade.

  6. Verify that the Analytics Data Sync Adapter is installed successfully.

    On Vocera Platform 6.x Web console, go to Status > Adapter Services and check the list of adapter services displayed.

    The AnalyticsDataSync service should be listed in the list of available services and display its status as ACTIVE.

  7. Verify that the version displayed in the Adapter Services screen is the same as that you have installed.

  8. To upgrade the Flume, search for the required RPM name by executing the command:

    sudo yum search va-flume
    where va-flume is the RPM name.

  9. To upgrade Flume, execute the command:

    sudo yum update va-flume.x86_64
    where va-flume.x86_64 is the RPM name.

    After you execute the command, the system displays the package details and prompts for a confirmation to install.

  10. Press y and subsequently press Enter to upgrade.

    The system upgrades the flume package and displays Complete! upon upgrade.

  11. To verify Flume version, execute the command:

    sudo yum info va-flume.x86_64

    The Flume version should be the same as that you have installed.

  12. To verify Flume status, execute the command:

    sudo systemctl status vs-flume-agent.service

    Flume should be in Inactive (Failed) state.

  13. To upgrade the Service Monitor, search for the required RPM name by executing the command:

    sudo yum search va-monitoring
    where va-monitoring is the RPM name.

  14. To upgrade Service Monitor, execute the command:

    sudo yum update va-monitoring.x86_64
    where va-monitoring.x86_64 is the RPM name.

    After you execute the command, the system displays the package details and prompts for a confirmation to install.

  15. Press y and subsequently press Enter to upgrade.

    The system upgrades the service monitor and displays Complete! upon upgrade.

    After the upgrade is complete, the service monitor starts automatically.

  16. To verify Service Monitor version, execute the command:

    sudo yum info va-monitoring.x86_64

    The Service Monitor version should be the same as that you have installed.

  17. Verify that service monitor is running by executing the command:

    sudo systemctl status va-monitoring.service

    The output should display the va-monitoring-service as active (running).

  18. Login to Service Monitor application and start Flume and Spark services.

Downgrade Vocera Analytics 1.2.4 HF on Vocera Platform 6.3 and Applying 1.2.0 HF1

Before you begin, login to Vocera Analytics service monitor and ensure that both Flume and Spark services are stopped.

Note: Ensure that Vocera Platform 6.1 and Vocera Platform 6.3 repos are enabled.
Note: For information on RPMs required for the respective Vocera Platform version, see Supported RPMs.

To downgrade Flume Agent and Service Monitor on the Vocera Platform 6.3 system, perform the following steps:

  1. Execute the command:

    sudo yum downgrade va-flume-1.2.0-98_398.x86_64

    After you execute the command, the system displays the package details and prompts for a confirmation to downgrade.

  2. Press y and subsequently press Enter to downgrade.

    The system downgrades the flume package and displays Complete! upon downgrade.

  3. To downgrade Service Monitor, execute the command:

    sudo yum downgrade va-monitoring-1.2.0-426_398.x86_64 where va-monitoring-1.2.0-426_398.x86_64 is the RPM name.

    After you execute the command, the system displays the package details and prompts for a confirmation to downgrade.

  4. Press y and subsequently press Enter to downgrade.

    The system downgrades the service monitor and displays Complete! upon downgrade.

    After the downgrade is complete, the service monitor starts automatically.

  5. Apply the 1.2.1 hotfix provided in KA-7984.

    KA-7984 provides the required steps to apply the 1.2.1 hotfix.

Fixed Issues

The following list contains fixes and improvements made to the Vocera Analytics in this release.

Fixed Issues in Vocera Analytics 1.2.4

The following issues are fixed in Vocera Analytics 1.2.4.2 patch:

The following issues are fixed in Vocera Analytics 1.2.4:

Fixed Issues in Vocera Analytics 1.2.3

The following issues are fixed in Vocera Analytics 1.2.3:

Fixed Issues in Vocera Analytics 1.2.0

The following issues are fixed in Vocera Analytics 1.2.0:

Fixed Issues in Vocera Analytics 1.1.0

The following issues are fixed in Vocera Analytics 1.1.0:

Known Issues

This release includes the following known issues:

Vocera Analytics Release 1.2.4

The following list is specific to Vocera Analytics 1.2.4.2 patch:

The following list is specific to Vocera Analytics 1.2.4:

Vocera Analytics Release 1.2.3

The following list is specific to Vocera Analytics 1.2.3:

Vocera Analytics Release 1.2.0

The following list is specific to Vocera Analytics 1.2.0

Vocera Analytics Release 1.1.0

The following list of known issues are existing from Vocera Analytics 1.1.0

Vocera Analytics Release 1.0.0

The following list of known issues are existing from Vocera Analytics release 1.0.0

Vocera Analytics has a few limitations. For more information, refer to Vocera Analytics Limitations.

Database Schema Changes in Vocera Analytics 1.2.4

The following table lists the database schema changes for Vocera Analytics 1.2.4 release:

Table Column Added Description
fctcalls DroppedAt Displays the time when the call was dropped.
fctcalls DropReason Displays the reason for call drop.
fctrecresults Location Displays the location of access point.
fctrecresults LocationId Displays the location id for the access point.
fctrecresults LocationSite Specifies the Vocera site with which the location is associated.