TEKSPEECH PRO
Device Operator Manager
Installation Guide
for Version 1.3.14
MN002092A03
Copyright
© 2017 ZIH Corp. and/or its affiliates. All rights reserved. ZEBRA and the stylized Zebra head are trademarks of
ZIH Corp., registered in many jurisdictions worldwide. All other trademarks are the property of their respective
owners.
COPYRIGHTS & TRADEMARKS: For complete copyright and trademark information, go to www.zebra.com/
copyright.
WARRANTY: For complete warranty information, go to www.zebra.com/warranty.
END USER LICENSE AGREEMENT: For complete EULA information, go to www.zebra.com/eula.
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.
Revision History
Changes to the original guide are listed below:
Change Date Description
Rev A 07/16 Initial Release
-03 07/17 Updates to:
Instructions for handling HTTPS protocol.
Downloading and deploying DB Server specific java connector components.
Update versions and requirements.
2
Table of Contents
Copyright ........................................................................................................................................... 2
Terms of Use .................................................................................................................................... 2
Revision History ................................................................................................................................ 2
About This Guide
Introduction ....................................................................................................................................... 7
Notational Conventions ..................................................................................................................... 7
Icon Conventions .............................................................................................................................. 8
Related Documents and Software .................................................................................................... 8
Service Information ........................................................................................................................... 8
Provide Documentation Feedback .................................................................................................... 9
Introduction
Overview ......................................................................................................................................... 10
TekSpeech Pro DOM System Architecture ............................................................................... 10
Hardware Components ............................................................................................................. 11
Software Solution Stack ............................................................................................................ 11
Machine Size Recommendations .............................................................................................. 11
System Architecture Scenarios ................................................................................................. 12
Administrator Access ................................................................................................................ 13
System Architecture Scenarios ................................................................................................. 13
Single Instance Application Server with Local DB and Data ............................................... 13
Single Instance Application Server with Remote DB and NAS ........................................... 14
Multiple Application Server Instance ................................................................................... 15
Multiple Application Server and Web Server Instance ........................................................ 16
Configuration Topology ............................................................................................................. 17
File Storage Setup
Introduction to File Storage Setup .................................................................................................. 18
Remote File Share .................................................................................................................... 18
Migrating to a Remote File Share ............................................................................................. 18
Database Server Setup
Introduction to Database Server Setup ........................................................................................... 19
3
Table of Contents
Requirements ............................................................................................................................ 19
MySQL Database Server Configuration .................................................................................... 19
PostgreSQL Database Server Configuration ............................................................................ 20
Migration ................................................................................................................................... 20
Replication or Backup (optional) ............................................................................................... 20
Application Server Setup
Introduction to Application Server Setup ......................................................................................... 21
Requirements ............................................................................................................................ 21
Java Runtime Environment Install ............................................................................................. 21
Apache Tomcat Install ............................................................................................................... 22
Tomcat Log Configurations ................................................................................................. 22
Tomcat Connection Limits ................................................................................................... 24
Install Java JDBC Driver ........................................................................................................... 24
MySQL ................................................................................................................................ 24
PostgreSQL ......................................................................................................................... 24
Install the tsm and tsmapi Applications ..................................................................................... 24
Install Applications .............................................................................................................. 24
Configure User Data Location ............................................................................................. 24
Configure Database Connection ......................................................................................... 25
Start Tomcat Service and Log In ............................................................................................... 25
Enable tsm and tsmapi Log4j Logs ..................................................................................... 25
Configure Webservice Domain ................................................................................................. 26
Activate License ........................................................................................................................ 26
Firewall Setting .......................................................................................................................... 26
Clustering .................................................................................................................................. 26
Web Server Setup
Introduction to Web Server Setup ................................................................................................... 27
Activate IIS ................................................................................................................................ 27
Install Application Request Routing (ARR) ............................................................................... 27
Configure Server Farms ...................................................................................................... 27
Add Virtual Directory to File Storage ......................................................................................... 29
Configure URL Rewrite for HTTP .............................................................................................. 29
URL Redirect for tsm and tsmapi ........................................................................................ 29
URL Rewrite for Files .......................................................................................................... 30
Configure URL Rewrite for HTTPS ........................................................................................... 31
IIS Web Server Role and Features ..................................................................................... 31
Disable URL Rewrite Rules ................................................................................................. 31
URL Rewrite for Files .......................................................................................................... 31
Reverse Proxy URL Rewrite Rule ....................................................................................... 32
Edit Outbound Rule ReverseProxyOutboundRule1 .......................................
Edit Inbound Rule ReverseProxyInboundRule1 .................................................................. 32
Add MIME Types ....................................................................................................................... 33
Dashboard URL Reference ....................................................................................................... 33
Network Load Balancing Setup
Introduction to Network Load Balancing Setup ............................................................................... 34
..................... 32
4
Table of Contents
First Instance ............................................................................................................................. 34
Second or Later Instance .......................................................................................................... 34
DOM Upgrade
Introduction to DOM Upgrade ......................................................................................................... 36
Upgrade from V.1.3.12 .............................................................................................................. 36
Upgrade from V.1.3.6 ................................................................................................................ 36
Preserve the previous configurations .................................................................................. 36
Update tsm and tsmapi Application ..................................................................................... 37
Upgrade from Version earlier than V1.3.6 ................................................................................. 37
Tomcat Application Update ................................................................................................. 37
IIS Reconfiguration .............................................................................................................. 38
Data Backup and Restore
Introduction to Data Backup and Restore ....................................................................................... 39
Database Backup ...................................................................................................................... 39
MySQL Backup ................................................................................................................... 39
PostgreSQL Backup ............................................................................................................ 39
User Data Backup ..................................................................................................................... 40
Contain Symbolic Links ....................................................................................................... 40
No Symbolic Link ................................................................................................................ 40
Database Restore ..................................................................................................................... 40
MySQL Restore ................................................................................................................... 40
PostgreSQL Restore ........................................................................................................... 41
User Data Restore .................................................................................................................... 41
Restore from Zip ................................................................................................................. 41
Restore from VHD ............................................................................................................... 41
Rollback to Previous Version
Introduction to Rollback to Previous Version .................................................................................. 42
Install the Older Version ............................................................................................................ 42
Restore the Database and User Data Folder ............................................................................ 42
Setup Verification
Introduction to Verifying Your Setup ............................................................................................... 43
Troubleshooting ........................................................................................................................ 43
“Connection Error" or Deployment Failure .......................................................................... 43
Unable to Login - Keeps Showing Me the Logon Page ...................................................... 43
500 level Error ..................................................................................................................... 43
Not Responding or Page Not Found after Clicking on the Account icon at Admin Page .... 43
Version Information
TekSpeech Pro DOM Version Information ...................................................................................... 44
Version 1.3.14 ........................................................................................................................... 44
Version 1.3.12 ........................................................................................................................... 44
Version 1.3.6
............................................................................................................................. 44
5
Table of Contents
Version 1.3.2 ............................................................................................................................. 45
Version 1.2.7 ............................................................................................................................. 45
Version 1.2.6 ............................................................................................................................. 45
6
About This Guide
Introduction
This installation guide describes how to install TekSpeech Pro Device and Operator Manager (DOM).
Topics covered in this guide are as follows:
• Introduction
• File Storage Setup
• Database Server Setup
• Application Server Setup
• Web Server Setup
• Network Load Balancing Setup
• DOM Upgrade
• Data Backup and Restore
• Rollback to Previous Version
• Setup Verification
• Version Information
Notational Conventions
The following conventions are used in this document:
• Bold text is used to highlight the following:
• Dialog box, window and screen names
• Drop-down list and list box names
• Check box and radio button names
• Icons on a screen
• Key names on a keypad
• Button names on a screen.
7
• Bullets (•) indicate:
• Action items
• Lists of alternatives
• Lists of required steps that are not necessarily sequential.
• Sequential lists (e.g., those that describe step-by-step procedures) appear as numbered lists.
Icon Conventions
The documentation set is designed to give the reader more visual clues. The following graphic icons are used
throughout the documentation set. These icons and their associated meanings are described below.
WARNING! The word WARNING with the associated safety icon implies information that, if disregarded,
could result in death or serious injury, or serious product damage.
CAUTION The word CAUTION with the associated safety icon implies information that, if disregarded, may result
in minor or moderate injury, or serious product damage.
About This Guide
IMPORTANT text text text text text text text text text text text text text text text text text text text text text text
text text text text text text text text text text text text text text text text text text text text text text
text text text text text text text text text text text text text text text text text text text text text text
text text text text text text text text text
NOTE NOTE contains information more important than the surrounding text, such as exceptions or
preconditions. They also refer the reader elsewhere for additional information, remind the reader how to
complete an action (when it is not part of the current procedure, for instance), or tell the reader where
something is located on the screen. There is no warning level associated with a note.
Related Documents and Software
For the latest version of this guide and all related documentation, go to: zebra.com/support.
Service Information
If you have a problem with your equipment, contact Zebra Global Customer Support for your region. Contact
information is available at: zebra.com/support
When contacting support, please have the following information available:
• Serial number of the unit
.
• Model number or product name
• Software type and version number.
Zebra responds to calls by email, telephone or fax within the time limits set forth in support agreements.
If your problem cannot be solved by Zebra Customer Support, you may need to return your equipment for servicing
and will be given specific directions. Zebra is not responsible for any damages incurred during shipment if the
approved shipping container is not used. Shipping the units improperly can possibly void the warranty.
8
About This Guide
If you purchased your Zebra business product from a Zebra business partner, contact that business partner for
support.
Provide Documentation Feedback
If you have comments, questions, or suggestions about this guide, send an email to EVM-Techdocs@zebra.com.
9
Introduction
Overview
TekSpeech Pro Device and Operator Manager (DOM) consists of four main components:
• Web server
• Application server
• Database server
• Data server.
This guide is presented in order of installation steps. All of the servers can be installed on one machine (see Single
Instance Application Server with Local DB and Data on page 13), be installed as clusters (see Multiple Application
Server Instance on page 15), or installed on multiple machines (see Multiple Application Server and Web Server
Instance on page 16). This guide also presents one example of load balancing in the clustered setup.
For an understanding of the solution stack, see Software Solution Stack on page 11.
TekSpeech Pro DOM System Architecture
Figure 1 TekSpeech Pro DOM in Relation to Other Components in the Complete System
10
Introduction
Hardware Components
Table 1 Hardware Components
Component Description/Purpose
Database
Server
Application
Server
Web Server Provide the web frontend to the Application Server. Includes browser access for administrators
Data Storage Provide unstructured data access to the application. Includes PDK files, firmware files, operator
Provide structured data access to the application.
Provide the execution of the TekSpeech Pro DOM application.
and web service access for device clients.
profiles, configurations, and extra resources. This can be provided locally on the same machine
as the Application server or provided remotely (For example, using NAS technology).
Software Solution Stack
Table 2 Required Software components
Stack
Component
Operating
System
Windows Server 2008 R2, 64-bit or
Windows Server 2012, 64-bit or
Windows Server 2012 R2, 64-bit or
Windows Server 2016, 64-bit
Version
Database
Server
Java Runtime Java SE Runtime Environment 8uXX, 64-bit (version 1.8.0_131-b11 verified)
Java Server Apache Tomcat 7.0.xx, 64-bit (version 7.0.78 verified)
Application TekSpeech Pro Device and Operator Manager (DOM)
Web Server Microsoft IIS (as included with Operating System)
MySQL Server, 64-bit (5.6 or 5.7) or
PostgreSQL, 64-bit (9.4.x or 9.6.x) and supporting Java DB connector library
Machine Size Recommendations
Table 3 Recommended Hardware (or virtual) Resource Requirements
Server Cores RAM Disk Storage
Application Server
Small (< 100 operators) 2 4 GB 5 GB
Medium (100 - 500 operators) 4 8 GB 20 GB
11
Introduction
Table 3 Recommended Hardware (or virtual) Resource Requirements (Continued)
Server Cores RAM Disk Storage
Large (> 500 operators) 8 16 GB 50 GB
Database Server
Small (< 100 operators) 2 2 GB 5 GB*
Medium (100 - 500 operators) 4 4 GB 20 GB*
Large (> 500 operators) 8 8 GB 50 GB*
* Database Size: 1 GB + 10 MB per device
Network Storage Server 5 GB + 60 MB per
operator
System Architecture Scenarios
Consider the information in the following table when planning a TekSpeech Pro DOM system installation. The
information provided should help determine the correct architecture based on an organization's goals for size,
performance and reliability.
.
Table 4 System Architecture Scenarios
Scenario Features
Single Instance Application Server
• Single local application server instance
• Single local web server instance
• Single local (or remote) database server
• Single local (or remote) data storage (NAS)
• Intended for small systems with less than 250
operators.
• The web server, application server, database
server, and storage could be provided on the
same machine.
• The database and/or data storage could be
provided on separate machines for improved
performance and reliability.
Multiple Instance Application Servers
• Multiple application server instances.
• Single or multiple, local or remote web server
instances.
• Remote database server
• Remote data storage (NAS)
• Provides for best performance.
• Provides for best redundancy and availability.
• Load balancing and application server affinity is
provided by the web server.
• Further redundancy can be provided with a
frontend load balancing technology.
12
Administrator Access
Table 5 Administrator Access
Introduction
Browser
Parameter
Target Screen
Resolution
Name and
Version
1280 x 1024 pixels
Google Chrome 34
Safari 7
Firefox 27
Internet Explorer 10
Minimum Requirement
System Architecture Scenarios
Single Instance Application Server with Local DB and Data
In this scenario, all of the software stack components are installed on one machine. This scenario should only be
used for small systems.
Figure 2 Single Instance Application Server with Local DB and Data
13
Introduction
Single Instance Application Server with Remote DB and NAS
In this scenario, the web server and application server are installed on one machine. The database server and
NAS are installed on separate machines. This scenario can be used in small to medium sized systems where
performance is important but redundancy is not important.
Figure 3 Single Instance Application Server with Remote DB and NAS
14
Loading...