ZEBRA-LOGO

ZEBRA Voice Client 9. x Workcloud Communication Software

ZEBRA-Voice-Client-9.-x-Workcloud-Communication-Software-PRODUCT

Product Information

Specifications

  • Product Name: Voice Client 9. x
  • Brand: Zebra Technologies
  • Communication: Workcloud Communication
  • Configuration Guide: Rauland MN-003603-03EN Rev A
  • Publication Date: April 26, 2024

Product Usage Instructions

Configuring the Zebra Voice Client

  1. Touch > Settings.
  2. Enter the settings password. The default password is Zamboni.
  3. Touch Connection Parameters.
  4. Select a PBX configuration. The typical configuration for RB/R5 is PBX#2 Configuration.
  5. Touch the PBX Type field and select Rauland.
  6. Enter the User ID.
  7. Enter the Password.
  8. Enter the SIP transport.
  9. Enter the Server address.
  10. Enter the Server port number.
  11. Touch the back button three times to return to the Zebra Voice home screen. A confirmation that the Configuration has been saved to WFConnect.xml displays.

Assign a Distinctive Ringtone

  1. From the Zebra Voice, touch the Menu button.
  2. Touch Settings > Advanced Settings > Ringtones > Rauland Alerts.
  3. Touch an alert priority to select it.
  4. Select a ringtone.
  5. Select OK.
  6. Touch the back button three times to return to the Zebra Voice home screen.

Configuring Client from Extension Manager

  • When configuring a Rauland PBX as a second extension configure for each extension from the Extensions tab.
  • The Second PBX Params field needs to be in JSON format. Below is an example JSON with the required fields populated: { profile2_type: Rauland, sip2_remhost: 18.211.19.155, sip2_sipid: 1000, sip2_userpass: password }

FAQ

Q: What is the default settings password for Zebra Voice Client?

A: The default settings password is Zamboni.

Q: How can I assign a distinctive ringtone in Zebra Voice Client?

A: To assign a distinctive ringtone, navigate to Menu > Settings > Advanced Settings > Ringtones > Rauland Alerts and follow the instructions provided in the manual.

Terms of Use Proprietary Statement

  • This manual contains proprietary information of Zebra Technologies Corporation and its subsidiaries (“Zebra Technologies”).
  • It is intended solely for the information and use of parties operating and maintaining the equipment described herein.
  • Such proprietary information may not be used, reproduced, or disclosed to any other parties for any other purpose without the express, written permission of Zebra Technologies.

Product Improvements

  • Continuous improvement of products is a policy of Zebra Technologies. All specifications and designs are subject to change without notice.

Liability Disclaimer

  • Zebra Technologies takes steps to ensure that its published Engineering specifications and manuals are correct; however, errors do occur. Zebra Technologies reserves the right to correct any such errors and disclaims liability resulting therefrom.

Limitation of Liability

In no event shall Zebra Technologies or anyone else involved in the creation, production, or delivery of the accompanying product (including hardware and software) be liable for any damages whatsoever (including, without limitation, consequential damages including loss of business profits, business interruption, or loss of business information) arising out of the use of, the results of use of, or inability to use such product, even if Zebra Technologies has been advised of the possibility of such damages. Some jurisdictions do not allow the exclusion or limitation of incidental or consequential damages, so the above limitation or exclusion may not apply to you.

Publication Date

April 26, 2024

Revision History

Change Date Revision
MN-003603-01 Rev A 05/2019 First version
MN-003603-02EN Rev A 03/2023 Updated with Extension Manager configuration.
MN-003603-03EN Rev A 04/2024 Rebranded to Workcloud Communication

Introduction

  • The Workcloud Communication Voice Client (Zebra Voice) version 9.x supports a Distinctive Ringtone feature that works with Rauland Borg Responder 5 (RB/R5) ringtone identifiers in the SIP INVITE message From header.
  • The RB/R5 PBX provides a way to set specific ringtone types in response to event inputs. An event input is interpreted within the RB/R5 PBX, which then sends a SIP INVITE to appropriate client targets. The header of the invite contains specific identifiers of the ringtone or urgency.
  • The Distinctive Ringtone feature is configured in the Zebra Voice by assigning a ringtone to an event from RB/R5. The Zebra Voice interprets the From header in an incoming SIP call and plays the assigned ringtone. When there are multiple incoming calls, the Zebra Voice interprets urgency and prioritizes the calls.
  • The Zebra Voice configuration must exactly match the RB/R5 configuration to function correctly. If the From header of the incoming SIP INVITE does not match the Zebra Voice identifier, the Zebra Voice plays a configurable default ringtone.
  • Zebra Voice supports Rauland PBX configuration as a secondary configuration only. Administrator is required to configure primary PBX configuration to support SIP calling features. Rauland configuration shall not be used for SIP calling features.

Requirements

  • Zebra Voice version 9.x installed and activated. Refer to the Zebra Voice Client 9.x Administration Guide for any PBX.
  • RB/R5 PBX properly configured. For information, contact Rauland-Borg customer support.

Configure the Workcloud Communication Voice Client

Obtain the following information from the RB/R5 PBX before configuring the Zebra Voice:

  • Server IP address
  • Server port
  • Server Transport (TCP/UDP)
  • User ID
  • Password.

To configure the Zebra Voice:

  1. TouchZEBRA-Voice-Client-9.-x-Workcloud-Communication-Software-FIG-1> Settings.
  2. Enter the settings password. The default password is: zamboni.
  3. Touch Connection Parameters.
  4. Select a PBX configuration. The typical configuration for RB/R5 is: PBX#2 Configuration.
  5. Touch the PBX Type field and select Rauland.
  6. Enter the User ID.
  7. Enter the Password.
  8. Enter the SIP transport.
  9. Enter the Server address.
  10. Enter the Server port number.
    • Figure 1 Enter ParametersZEBRA-Voice-Client-9.-x-Workcloud-Communication-Software-FIG-2
  11. Touch the back button three times to return to Zebra Voice home screen.
    • A confirmation that the Configuration has been saved to WFConnect.xml displays.

Assign a Distinctive Ringtone

To assign a distinctive ringtone:

  1. From the Zebra Voice, touch the Menu button.
  2. Touch Settings > Advanced Settings > Ringtones > Rauland Alerts.ZEBRA-Voice-Client-9.-x-Workcloud-Communication-Software-FIG-3
  3. Touch an alert priority to select it.
  4. Select a ringtone.ZEBRA-Voice-Client-9.-x-Workcloud-Communication-Software-FIG-4
  5. Select OK.
  6. Touch the back button three times to return to Zebra Voice home screen.

Configuring Client from Extension Manager

When configuring a Rauland PBX as a second extension configure for each individual extension from the Extensions tab.ZEBRA-Voice-Client-9.-x-Workcloud-Communication-Software-FIG-5The Second PBX Params field needs to be in JSON format. Below is an example JSON with the required fields populated.ZEBRA-Voice-Client-9.-x-Workcloud-Communication-Software-FIG-6

Table 1

Field Name Description
profile2_type This is the type of PBX being configured and is set to Rauland.
sip2_remhost <IP Address/FQDN of the PBX>
sip2_sipid The SIP user ID (as configured within pbx)
sip2_userpass The SIP user password (as configured within pbx).

SIP INVITE Messages

This section contains examples of RB/R5 SIP INVITE messages.

Example OneZEBRA-Voice-Client-9.-x-Workcloud-Communication-Software-FIG-7

Example TwoZEBRA-Voice-Client-9.-x-Workcloud-Communication-Software-FIG-8

Zebra Voice Configuration File

  • Using the Distinctive Ringtone feature requires storing the following key and value pairs in the Zebra Voice configuration file.
  • Each key and value pair contains the following, a Rauland ringtone and a Rauland ringtone pattern identifier:

Rauland ringtones for the different alert priorities are:

  • <rauland_low>
  • <rauland_medium>
  • <rauland_high>
  • <rauland_code>
  • Rauland ringtone pattern identifier used to identify the correct alert priority:
  • <rauland_low_pattern>
  • <rauland_medium_pattern>
  • <rauland_high_pattern>
  • <rauland_code_pattern>
  • Ringtone identifiers must exactly match the content of the SIP INVITE message from header.
  • The format is <ringtone_priority>From Header</ringtone_priority>

Configuration File Example

  • In the example below, the ringtone priority parameters contain headers from the SIP INVITE Messages on.
  • The parameter <rauland_low_pattern> contains the From header Patient, highlighted in Example One.
  • The parameter <rauland_high_pattern> contains the From header WFC_ALERT_TONE_12, highlighted in Example Two.ZEBRA-Voice-Client-9.-x-Workcloud-Communication-Software-FIG-9
  • ZEBRA and the stylized Zebra head are trademarks of Zebra Technologies Corporation, registered in many jurisdictions worldwide. All other trademarks are the property of their respective owners.
    © 2024 Zebra Technologies Corporation and/or its affiliates. All rights reserved.
  • Information in this document is subject to change without notice. The software described in this document is furnished under a license agreement or nondisclosure agreement.
  • The software may be used or copied only in accordance with the terms of those agreements.
  • For further information regarding legal and proprietary statements, please go to:
  • SOFTWARE: zebra.com/informationpolicy
  • COPYRIGHTS: zebra.com/copyright
  • PATENTS: zebra.com/patents
  • WARRANTY: zebra.com/warranty
  • END USER LICENSE AGREEMENT: zebra.com/eula
  • zebra.com

Documents / Resources

ZEBRA Voice Client 9.x Workcloud Communication Software [pdf] User Guide
Voice Client 9.x Workcloud Communication Software, Client 9.x Workcloud Communication Software, Workcloud Communication Software, Communication Software, Software

References

Leave a comment

Your email address will not be published. Required fields are marked *