ZEBRA SCANNER MANAGEMENT SERVICE (SMS)
USER GUIDE
ZEBRA SCANNER
MANAGEMENT SERVICE (SMS)
USER GUIDE
72E-156774-04
Revision A
November 2019
ii ZEBRA SCANNER MANAGEMENT SERVICE USER GUIDE
No part of this publication may be reproduced or used in any form, or by any electrical or mechanical means,
without permission in writing from Zebra. This includes electronic or mechanical means, such as photo copying,
recording, or information storage and retrieval systems. The material in this manual is subject to change
without notice.
The software is provided strictly on an “as is” basis. All software, including firmware, furnished to the user is on
a licensed basis. Zebra grants to the user a non-transferable and non-exclusive license to use each software
or firmware program delivered hereunder (licensed program) . Except as n oted below, such licen se may not b e
assigned, sublicensed, or otherwise tran sfe rr e d by th e user without prior written consent of Zebra. No right to
copy a licensed program in whole or in part is granted, except as permitted under copyright law. The user shall
not modify , merge, or incorporate any for m or portion of a licensed program with other pro gram material, create
a derivative work from a licensed program , or us e a li censed program in a network without written permission
from Zebra. The user agrees to maintain Zebra’s copyright notice on the licensed programs delivered
hereunder , and to include the same on any au thorized copies it m akes, in whole or in part. The user agrees not
to decompile, disassemble, decode, or reverse engineer any licensed program delivered to the user or any
portion thereof.
Zebra reserves the right to make changes to any software or product to improve reliability, function, or design.
Zebra does not assume any product liability arising out of, or in connection with, the application or use of any
product, circuit, or application described herein.
No license is granted, either expressly or by implication, estoppel, or otherwise under any Zebra Technologies
Corporation, intellectual property rights. An implied license only exists for equipment, circuits, and su bsystems
contained in Zebra products.
Warranty
For the complete Zebra hardware product warranty statement, go to:
www.zebra.com/warranty.
Revision History
Changes to the original guide are listed below:
Change Date Description
-01 Rev. A 10/2012 Initial Release
-02 Rev. A 07/2013 Updated screen shots.
-03 Rev. A 04/2015 Zebra Rebranding.
-04 Rev. A 11/2019 Updates:
iii
- Branding
- Screen shots
- Functionality
- 123Scan2 > 123Scan, where applicable
iv ZEBRA SCANNER MANAGEMENT SERVICE USER GUIDE
TABLE OF CONTENTS
Warranty ......................................................................................................................................... ii
Revision History.............................................................................................................................. iii
About This Guide
Introduction..................................................................................................................................... vii
Chapter Descriptions ...................................................................................................................... vii
Notational Conventions................................................................................................................... viii
Related Documents ........................................................................................................................ ix
Service Information......................................................................................................................... ix
Chapter 1: SMS INTRODUCTION
Overview ........................................................................................................................................ 1-1
Reducing Your Total Cost of Ownership .................................................................................. 1-1
Helpful Links ....................................................................................................................... 1-1
Manage Asset Information Fleet Wide ..................................................................................... 1-2
Configuration at the Point-of-Use ............................................................................................. 1-2
Zero Effort Configuration .......................................................................................................... 1-2
Solution Architecture - Three Steps to Success ............................................................................ 1-3
Chapter 2: QUICK STARTUP GUIDE
Quick Startup ................................................................................................................................. 2-1
Helpful Links ............................................................................................................................ 2-1
Quick Startup Guide ................................................................................................................. 2-1
Chapter 3: INSTALLATION OF THE SMS
Introduction .................................................................................................................................... 3-1
Helpful Links ....................................................................................................................... 3-1
Download the SMS Solution from the Web .................................................................................... 3-2
System Requirements .................................................................................................................... 3-2
123Scan Requirements ........................................................................................................... 3-2
Hardware Requirements .............................................................................................. 3-2
Software and Operating System Requirements ........................................................... 3-2
SMS Solution Requirements .................................................................................................... 3-2
Supported Operating Systems ........................................................................................... 3-2
SMS Solution Size ............................................................................................................. 3-2
vi ZEBRA SCANNER MANAGEMENT SERVICE USER GUIDE
Installing the Solution ..................................................................................................................... 3-3
Install 123Scan (v5.0 or newer) ............................................................................................... 3-3
Install SMS ............................................................................................................................... 3-6
Silent Unattended Installation of the Zebra Scanner Management Service ............................ 3-11
Silent Install Command Line Options ................................................................................. 3-11
Command Line Switch Description .............................................................................. 3-11
Components and Folder Paths ...................................................................................................... 3-12
SMS Components .................................................................................................................... 3-12
123Scan Components ............................................................................................................. 3-13
Chapter 4: GENERATING AN SMS PACKAGE USING 123SCAN
Introduction .................................................................................................................................... 4-1
Helpful Links ....................................................................................................................... 4-1
Creating an SMS Package ............................................................................................................. 4-2
Steps to Create the SMS Package .......................................................................................... 4-2
Sample Log File ................................................................................................................. 4-8
Opening an Existing SMS Package ............................................................................................... 4-14
Opening an SMS Package from a Windows Folder ................................................................. 4-14
Opening an SMS Package within 123Scan ............................................................................. 4-15
Chapter 5: DEPLOYING THE SMS PACKAGE
Introduction .................................................................................................................................... 5-1
Helpful Links ....................................................................................................................... 5-1
Customer Supplied Third Party File Distribution Tool .................................................................... 5-2
SMS Package Download Destination ............................................................................................ 5-2
Download Folder Structure ...................................................................................................... 5-2
The 123Scan Deployment Checklist ........................................................................................ 5-2
Chapter 6: SMS CONFIGURES SCANNER AT POS
Configuration at the Point-Of-Use (POS) ....................................................................................... 6-1
Helpful Links ....................................................................................................................... 6-1
Scanner LEDs Indicating SMS Load Status .................................................................................. 6-2
Default SMS Agent Operation Mode .............................................................................................. 6-2
Querying Asset Tracking Information ............................................................................................. 6-2
Querying Asset Information Real Time .................................................................................... 6-3
Sample Application to Query Assets Using WMI ............................................................... 6-3
Sample WMI Visual Basic Script to Query Asset Tracking Information ............................. 6-4
Tracking SMS Operations .............................................................................................................. 6-5
Chapter 7: TROUBLESHOOTING
Helpful Links .................................................................................................................................. 7-1
Troubleshooting Actions ................................................................................................................ 7-1
Verification of Proper Operation ............................................................................................... 7-1
Folder Security Check for the Download Folder ...................................................................... 7-1
Firewall Considerations ............................................................................................................ 7-2
Finding Last Load Details in Log File ....................................................................................... 7-2
Error Copying Files Running the SMS Agent as an
Application on a Windows XP SP2 Host PC ...................................................................... 7-2
Updates to Scanner Devices Connected Via a USB Hub Do Not Complete ........................... 7-2
Index
ABOUT THIS GUIDE
Introduction
The Zebra Scanner Management Service User Guide provides the information necessary to install the SMS and
123Scan, create SMS Packages to remotely manage scanners, execute the actions specified in the SMS, and
troubleshoot the setup and processes.
Chapter Descriptions
Topics covered in this guide are as follows:
•
Chapter 1, SMS INTRODUCTION provides a broad overview of the Zebra SMS.
•
Chapter 2, QUICK STARTUP GUIDE provides quick links to important topics in the guide.
•
Chapter 3, INSTALLATION OF THE SMS describes how to install the Zebra SMS and 123Scan on
recommended platforms.
•
Chapter 4, GENERATING AN SMS PACKAGE USING 123SCAN provides information to create SMS
Packages to remotely manage scanners.
•
Chapter 5, DEPLOYING THE SMS PACKAGE provides infor mation to execute the actions specified in the
SMS Package.
•
Chapter 6, SMS CONFIGURES SCANNER AT POS provides information to perform the actions specified in
the active package.
•
Chapter 7, TROUBLESHOOTING provides information problem solving.
viii ZEBRA SCANNER MANAGEMENT SERVICE USER GUIDE
Notational Conventions
The following conventions are used in this document:
•
Courier New font is used for code segments.
•
Italics are used to highlight:
• Chapters and sections in this and related documents
• Fields on a window
• Names of windows
• File names
•
Bold text is used to highlight buttons and keys.
•
bullets (•) indicate:
• Action items
• Lists of alternatives
• Lists of required steps that are not necessarily seq ue nt ial
•
Sequential lists (e.g., those that describe step-by-step procedures) appear as numbered lists.
•
Throughout the programming bar code menus, asterisks (*) are used to denote default parameter
settings.
NOTE This symbol indicates something of special interest or importance to the reader. Failure to read the note
will not result in physical harm to the reader, equipment or data.
CAUTION This symbol indicates that if this information is ignored, the possibility of data or material damage may
occur.
WARNING! This symbol indicates that if this information is ignored the possibility that serious personal
injury may occur.
Related Documents
•
Zebra Scanner Windows Management Instrumentation (WMI) Driver Developer’s Guide, p/n
72E-149785-xx.
•
Zebra Scanner SDK For Windows Developer’s Guide, p/n 72E-149784-xx.
About This Guide ix
The latest version of this guide and all guides, are available at: www.zebra.com/support
Service Information
If you have a problem with your equipment, contact Zebra Technologies Support for your region. Contact
information is available at: www.zebra.com/support
When contacting Zebra, 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 E-mail, telephone or fax within the time limits set forth in support agreements.
If your problem cannot be solved by Zebra Technologies 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.
If you purchased your business product from a Zebra business partner, contact that business partner for
support.
.
.
x ZEBRA SCANNER MANAGEMENT SERVICE USER GUIDE
CHAPTER 1 SMS INTRODUCTION
Overview
Figure 1-1
Steps in the SMS Process
Reducing Your Total Cost of Ownership
Lowering your total cost of ownership, the SMS Solution en ables an enterprise to remotely manage their Zebra
scanners. In addition to accessing asset tracking information, the SMS Solution can remotely set parameters
and update firmware. Providing your enterprise maximum flexibility, the SMS Solution operates in an
automated, unattended manne r, no operator intervention is requir ed .
Helpful Links
•
To simplify navigation of this document and find links to commonly asked questions, see Chapter 2,
QUICK STARTUP GUIDE.
•
To download the SMS agent, visit www.zebra.com/sms.
•
To view a one minute video tour of the SMS in action, visit www.zebra.com/sms.
•
To view all the SMS how-to videos, visit: www.zebra.com/ScannerHowToVideos.
1 - 2 ZEBRA SCANNER MANAGEMENT SERVICE USER GUIDE
Manage Asset Information Fleet Wide
The SMS also provides a conduit for any third party enterprise console to query and report fleet wide asset
tracking information such as model numbe r, serial number, date of manufacture, firmware version,
configuration file name and parameter values. Providing additional flexibility, the SMS ca n operate as a service
- always running and available, or as an application that can be invoked by a third party console command.
Configuration at the Point-of-Use
The SMS automates the process of loading a 123Scan generated SMS Package to a scanner. The SMS
Package contains 123Scan generated scanner configuration file(s ) loaded with parameters , scanner plug-in(s)
containing the scanner's firmware and a load directive file with loading details such as date and time. Best of
all, the SMS enables an enterprise to purchase off-the-shelf Zebra scanners and fully customize them to their
needs at the point-of-use, no depot staging or operator intervention or bar code scanning required.
Zero Effort Configuration
SMS automatically establishes communication between the scanner and your host app licati on hence oper ator
intervention, pre-staging at a depot, scanning a bar code to establish communication, or console interaction is
not required.
Replacing a scanner during store hours just before the holidays is not a problem. Just plu g in the sca nne r an d
walk away. If the SMS is run as a Service, it automatically establishes communication with the scanner and
downloads the appropriate content from the SMS Package to the scanner. No operator intervention is required.
Solution Architecture - Three Steps to Success
The SMS enables an enterprise to remotely update scanner firmware, configure scanner parameters, and
gather asset tracking information. The SMS automates the process of loading firmware, and configuration files
(parameter settings) to Zebra scanners. It also provides a conduit for third party network tools to query and
report fleet wide asset tracking information, such as model number, serial number, date of manufacture,
firmware version, configuration file name, and parameter values.
SMS INTRODUCTION 1 - 3
Figure 1-2
Remotely managing your scanner using the SMS is a three step process:
Step 1. Generate an SMS Package using 123Scan v5.0 (or newer).
Step 2. Deploy the SMS Package to your target (production) PC to the specified download folder on the
Step 3. On the target PC, the SMS agent loads the SMS Package to your scanner.
SMS solutions are available at no cost and require no licensing fees.
Steps in the SMS Process
scanner's terminal using your third party network tools. The network ma nagement console can also be
used to query asset information from the SMS agent.
1 - 4 ZEBRA SCANNER MANAGEMENT SERVICE USER GUIDE
CHAPTER 2 QUICK STARTUP GUIDE
Quick Startup
Use this Quick Startup Guide to simplify navigation of this document. The Quick Startup Guide contains links to all the key topics within this document.
Helpful Links
•
To download the Zebra Scanner Management Service (SMS) agent, visit www.zebra.com/sms.
•
To view a one minute video tour of the SMS in action, visit www.zebra.com/sms.
•
To view all the SMS how-to videos, visit www.zebra.com/ScannerHowToVideos.
Quick Startup Guide
SMS Overview .................................................................................................................................. 1-1, 1-3, 6-2
- Zero effort configuration......... ... .... ... ... ... ... .... ... ... ... .............................................. ................... 1-2, 6-1
- SMS operation mode: Service vs. Application......................................................................... 4-12, 6-2
Solution Architecture......................................................................................................................... 1-3
- Supported Operating Systems (OSs)......................... ... ... ... .... ... ............................................. 3-2
- SMS Solution Size................................................................................................................... 3-2
- Scanner LED States................................................................................................................ 6-2
- Trigger Events (What causes SMS Package to be loaded?).................. ................................ 4-11
- Licensing Fees............. .... ... ... ... .............................................. ................................................ 1-3
- Programming (Management) Communication Protocols ..................................... ... ... ... ... ....... 4-4
- Default SMS agent operation mode (Run as a Service)......................................................... 6-2
o Switching to Run as an Application mode for the first time................................................ 6-2
Installation of SMS............................................................................................................................ 3-3
2 - 2 ZEBRA SCANNER MANAGEMENT SERVICE USER GUIDE
- Downloading 123Scan and SMS agent...................................................................................3-2
- Silent Unattended Installation of the Zebra Scanner Management Service ............................3-11
- Components and folder paths.......... .... ............................................. ... ... ... .... ... ... ... .... ... ... .......3-12
SMS Package
- What is an SMS Package........................................................................................................4-1
- Generation of an SMS Package ..............................................................................................4-2
- Opening an existing SMS Package .........................................................................................4-14
Deploying an SMS Package................................ ... ... .... ............................................. ... ... .... ... ..........5-1
- Using the Deployment Checklist..............................................................................................5-2
- SMS Package Distribution Tools..............................................................................................5-2
- Accessing an SMS Package on your PC within the 123Scan folder structure ........................4-14
- Download folder destination on production PC ........................................................................5-2
Querying Asset Information ...............................................................................................................6-2
- Real Time asset Tracking (SMS Operation Mode = Service) ................................................. .6-3
o Zebra WMI Namespace......................................................................................................6-2
o Sample application to query asset information using WMI .................................................6-3
o WMI VB Script to query asset tracking information..............................................................6-4
- Non-Real Time Asset Tracking (SMS Operation Mode = Application).....................................6-2
- Tracking SMS operation (Activity Status) .. ... ... .... ... ... ................................................. ... ... .......6-5
Log File..............................................................................................................................................4-6, 7-2
- Log file example.......................................................................................................................4-8
- Details of last loaded SMS Package........................................................................................7-2
Firewall / Folder Security considerations...........................................................................................7-1, 7-2
CHAPTER 3 INSTALLATION OF THE SMS
Introduction
This chapter describes how to install the Zebra SMS and 123Scan on recommended platforms.
Helpful Links
•
To simplify navigation of this document and find links to commonly asked questions, see Chapter 2,
QUICK STARTUP GUIDE.
•
To download the SMS agent, visit www.zebra.com/sms.
•
To view a one minute video tour of the SMS in action, visit www.zebra.com/sms.
•
To view all the SMS how-to videos, visit www.zebra.com/ScannerHowToVideos.
3 - 2 ZEBRA SCANNER MANAGEMENT SERVICE USER GUIDE
Download the SMS Solution from the Web
Both the SMS Solution and 123Scan must be downloaded to utilize the SMS Solution. Both utilities can be
downloaded from www.zebra.com/sms
, or download 123Scan from www.zebra.com/123Scan.)
System Requirements
123Scan Requirements
Hardware Requirements
•
Pentium Dual-Core E214 1.6GHz or Pentium Mobile Dual-Core T2060 or Pentium Celeron E1200
1.6GHz
•
2GB RAM and 1.2 GB free hard drive space
•
USB port, 1.1 or higher, for the connection of USB Scanners
Software and Operating System Requirements
•
Microsoft Windows 7 or 10 (32 bit/64 bit)
•
If not present, Microsoft .NET Framework 3.5 SP1 loaded at time of initial 123Scan installation
•
Minimum display resolution = 1024 by 768 pixels
SMS Solution Requirements
Supported Operating Systems
The Zebra SMS supports the following Operating Systems:
•
Windows 7 SP1 (32- and 64-bit)
•
Windows 10 (32- and 64-bit)
•
Windows POS Ready 2009
SMS Solution Size
The Zebra SMS 32-bit installation package is approximately 20 MB in size. The Zebra SMS 64-bit installation
package is approximately 30 MB in size.
Once installed in a production environment, the SMS solution size decreases.
Table 3-1
Installed SMS Solution Sizes
Typical Installed Solution Size 32-bit 64-bit
SMS agent 4 MB 9 MB
SMS Package for one model scanner 3 MB 3 MB
Total require d sp ace 7 MB 12 MB
Installing the Solution
The following steps show the process to install 123Scan and the SMS Solution.
Install 123Scan (v5.0 or newer)
To install 123Scan:
1. Go to www.zebra.com/us/en/support-downloads/software/utilities/123scan-utility.html.
2. Scroll down to the Software section and select and run the relevant OS download for your PC (123Scan 32
bit or 123Scan 64 bit).
3. The Zebra CoreScanner Driver is a prerequisite for both the 32- and 64-bit setup programs. The
installation process checks for the CoreScanner driver on the target PC. If the CoreScanner driver is not
present, or is outdated, clicking Install (Figure 3-1) adds updated drivers before installing the Zebra
123Scan package.
INSTALLATION OF THE SMS 3 - 3
Figure 3-1
The Microsoft .NET Framework is also a prerequisite for Zebra 123Scan. If .NET is not available in the
system, the installer lists it as a requirement and installs it as part of the setup process.
Installation of Zebra CoreScanner Driver Window
3 - 4 ZEBRA SCANNER MANAGEMENT SERVICE USER GUIDE
4. Click Next in the Welcome window.
Figure 3-2
5. Review the license agreement and click Yes to accept.
Welcome Window
Figure 3-3
License Agreement Window
6. Click Install to install 123Scan.
INSTALLATION OF THE SMS 3 - 5
Figure 3-4
7. As the installation proceeds, the status displays.
Ready to Install Window
Figure 3-5
Installation Status Window
3 - 6 ZEBRA SCANNER MANAGEMENT SERVICE USER GUIDE
8. When the installation is complete, the following window displays. Click Finish.
Figure 3-6
Installation Complete Window
Install SMS
To install SMS:
1. Go to
www.zebra.com/us/en/support-downloads/software/utilities/scanner-management-service-for-windows.html.
2. Scroll down to the Software section and select and run the relevant OS download for your PC (SMS 32 Bit,
or SMS 64 Bit).
3. If you previously installed 123Scan on the same PC, the Zebra CoreScanner Driver (a prerequisite for both
the 32- and 64-bit setup programs) was already installed. If you are installing the SMS Solution first, or on
a different PC than 123Scan, the CoreScanner driver automatically installs before the SMS Solution
installation. See Step 3 on page 3-3 for more information about the CoreScanner driver installation.
4. Click Next in the Welcome window.
INSTALLATION OF THE SMS 3 - 7
Figure 3-7
Welcome Window
3 - 8 ZEBRA SCANNER MANAGEMENT SERVICE USER GUIDE
5. Review the license agreement and click Yes to accept.
Figure 3-8
6. Click the appropriate radio button (Figure 3-9) for the type of setup to install.
a. Complete setup installs all Zebra SMS components.
b. Custom setup allows the user to de-select Start menu shortcuts for Developer Utilities.
License Agreement Window
Figure 3-9
Setup Type Window
7. Click Next to continue with the installation.
INSTALLATION OF THE SMS 3 - 9
Figure 3-10
Custom Setup Selection Windows
3 - 10 ZEBRA SCANNER MANAGEMENT SERVICE USER GUIDE
8. Click Install to continue.
Figure 3-11
9. When the installation is complete, the following window displays. Click Finish.
Ready to Install Window
Figure 3-12
Installation Complete Window
INSTALLATION OF THE SMS 3 - 11
Silent Unattended Installation of the Zebra Scanner Management Service
The CoreScanner driver and the Scanner Management Service (SMS) require the Microsoft 2017 C++
Redistributable Package which automatically installs if it is does not already exist on the host PC. For an
unattended installation, a complication arises if the 2017 C++ Redistributable is no t pre-installed. By default,
Microsoft triggers a reboot of the PC after the C++ Redistributable installation. In this case, a reboot is injected
into the overall silent install process (which ma y th en also req uir e a log in) .
To avoid the interruption, the 2017 C++ Redistributable can be downloaded from Microsoft (see links below)
and pre-installed silently while suppressing the reboot using the command line switches /install /quiet
/norestart. This delays the required reboot and allows custom silent CoreScanner and SMS installs to be
performed using subsequent commands.
The Visual C++ Redistributable for Visual Studio 2017 can be downloaded from the Microsoft website (see
links below). The appropriate file vcredist_x86.exe (32-bit version) or vcredist_x64.exe (64-bit version) mu st be
selected and downloaded. The command line to perform its install silently without reboot is:
vcredist_x86.exe /install /quiet /norestart
or
vcredist_x64.exe /install /quiet /norestart
The required reboot must be performed at the end of the overall installation process to ensure correct
operation.
The Zebra Scanner Management Service and prerequisite CoreScanner driver are packaged using the
Flexera InstallShield installer program. Options can be selectively installed using the Custom Installation
option. In conjunction with this custom install option, the installer program supports command line switches to
record custom responses that can be used to create a silent install response file. The se respon se files, ending
in the file extension .iss, may then be used to perform a silent installation of the CoreScanner driver and SMS
components on production PCs.
Silent Install Command Line Options
Command Line Switch Description
-s Silent mode. The -s switch runs the installation in silent mode using the responses contained in a
recorded response file.
-r Record mode. The -r switch displays all the setup dialogs and records the chosen responses in the file
specified with the -f1 switch described below.
-f1 Specify custom response file name and path. The -f1 switch specifies where the response file is
located for the -s switch, or where it should be crea te d when using th e -r switch. Spe cify a n a bsolute path ;
using a relative path yields unpredictable results.
-f2 Specify alternative log file name and path. When running an installation in silent mode (using the -s
switch), the log file is created by default in the same directory and with the same name (except for the
extension) as the response file. The -f2 switch en ables you to sp ecify an alternative log file location and file
name. Specify an absolute path; using a relative path yields unpredictable results.
When executed from a command prompt, the example below uses the -r and -f1 switches to record your
responses to the setup prompts into a custom response file:
“Zebra_CoreScanner_Driver_(64bit)_v3.04.0004.exe" -r -f1"c:\path\CSsetup.iss"
The responses chosen using the command above are saved in the specified resp onse file and can then be
used as input to silently install the Corescanner with those chosen responses on production PCs.
3 - 12 ZEBRA SCANNER MANAGEMENT SERVICE USER GUIDE
The next example shows how the -s switch uses the response file created with the previous command to
perform the silent install:
"Zebra_CoreScanner_Driver_(64bit)_v3.04.0004.exe" -s -f1"c:\path\CSsetup.iss"
Note that there is no space between the -f1 switch and first quotation mark for the custom response file.
Additionally, you would perform the above steps for the silent installation of the SMS. Record the SMS
response file using the -r switch on a PC that does not yet have SMS installed:
“Zebra_Scanner_Management_Service_(64bit)_v4.02.0003.exe" -r -f1"c:\path\SMSsetup.iss"
Then use that resulting response file with the -s switch to install silently on other PCs:
“Zebra_Scanner_Management_Service_(64bit)_v4.02.0003.exe" -s -f1"c:\path\SMSsetup.iss"
If necessary, the -r switch option can also be used to record a custom response file for a silent removal of a
program by running the command on a PC that has that program already installed.
2017 C++ Redistributables 14.16.27012 Download links:
x64:
download.visualstudio.microsoft.com/download/pr/9fbed7c7-7012-4cc0-a0a3-a541f51981b5/e7eec15278b44
73e26d7e32cef53a34c/vc_redist.x64.exe.
x86:
download.visualstudio.microsoft.com/download/pr/d0b808a8-aa78-4250-8e54-49b8c23f7328/9c5e653205578
6367ee61aafb3313c95/vc_redist.x86.exe.
Components and Folder Paths
SMS Components
Table 3-2
SMS agent folder SMS installation folder. User
SMS Package
download folder
SMS default log
folder
SMS Components
Component Description Installation Path
%ProgramFiles%\Zebra Technologies\Barcode Scanners\SMS
cannot customize this
location.
Folder on PC host in which
SMS Packages are placed
for processing.
Default log file folder. User
can change the logging
location in the package at
creation time.
%ProgramFiles%\Zebra Technologies\Barcode
Scanners\SMS\Download
%ProgramFiles%\Zebra Technologies\Barcode
Scanners\SMS\Download\Logs
Launch SMS as an
Application
Executable file to launch
SMS as an application.
%ProgramFiles%\Zebra Technologies\Barcode
Scanners\SMS\SmsService.exe
INSTALLATION OF THE SMS 3 - 13
Table 3-2
Start SMS agent Script file to start the SMS
Stop SMS agent Script file to stop the SMS
Release notes Release notes. %ProgramFiles%\Zebra Technologies\Barcode Scanners\SMS
SMS Components (Continued)
Component Description Installation Path
%ProgramFiles%\Zebra Technologies\Barcode
agent.
agent.
Scanners\SMS\Start SMS Agent.bat
%ProgramFiles%\Zebra Technologies\Barcode
Scanners\SMS\Stop SMS Agent.bat
Release Notes.htm
123Scan Components
Table 3-3
Application Application EXE and the
Configuration files Default location of
Activity reports Default location of Activity
123Scan Components
Component Description Installation Path
%ProgramFiles%\Zebra Technologies\Barcode
supporting DLLs of the
program
Configuration Files
Reports
Scanners\123Scan2
Users\Public\Documents\123Scan2\Configuration Files
Users\Public\Documents\123Scan2\Activity Report Database
Data view reports Default location of Data View
Reports
Saved images Default location of Saved
Images
SMS Packages Default location of SMS
Packages
Scanner plug-Ins Scanner Plug- Ins ProgramData\123Scan2\Plug-ins
Application help
document
Application Help Document Program Files\Zebra Technologies\Barcode
Users\Public\Documents\123Scan2\Data View Reports
Users\Public\Documents\123Scan2\Images
Users\Public\Documents\123Scan2\ SMS Packages
Scanners\123Scan2\Languages\en-us
3 - 14 ZEBRA SCANNER MANAGEMENT SERVICE USER GUIDE
CHAPTER 4 GENERATING AN SMS
PACKAGE USING 123SCAN
Introduction
An SMS Package is a single file which, when used with the SMS agent, can be used to remotely manage
scanners by programming parameters and updating firmware. 123Scan is used to generate an SMS Package.
An SMS Package can be programmed to support up to five (5) unique scanners models/plug-ins.
For example:
Model/Plug-in #1. DS6878 SR (Standard Range)
Model/Plug-in #2. DS6878 HC (Health Care)
Model/Plug-in #3. DS4208 SR
Model/Plug-in #4. LS4208 SR
Model/Plug-in #5. DS9808 SR
An SMS Package is comprised of three components:
Component #1. 123Scan configuration file containing parameters.
Component #2. 123Scan plug-in file containing the scanner's firmware.
Component #3. A single Load Directive File (LDF) containing the rule set including details such as trigger
events, programming date and logging settings.
Once the SMS Package is placed on the target PC, if the SMS agent is in its default state - Run as a Service, it
will review the SMS Package's content and automatically program the scanner as described in the SMS
Package.
Helpful Links
•
To simplify navigation of this document and find links to commonly asked questions, see Chapter 2,
QUICK STARTUP GUIDE.
•
To download the SMS agent, visit www.zebra.com/sms.
•
To view a one minute video tour of the SMS in action, visit www.zebra.com/sms.
•
To view all the SMS how-to videos, visit www.zebra.com/scannersoftwarevideos.
4 - 2 ZEBRA SCANNER MANAGEMENT SERVICE USER GUIDE
Creating an SMS Package
123Scan v5.0 (or newer) can be used to create an SMS Package. 123Scan utilizes a wizard to guide users
through the SMS Package generation process.
Steps to Create the SMS Package
1. Launch the 123Scan utility.
2. In the Start tab, click the Actions drop-down menu (Figure 4-1) and select Create Scanner Management
Service (SMS) Package.
Figure 4-1
3. In the SMS Package name and notes window (Figure 4-2), enter an SMS Package name, and any
Package notes you may want to add to describe the package. Click Next >.
Figure 4-2
Start Tab - Create Scanner Management Service (SMS) Package
SMS Untitled1 Tab - SMS package name and notes Window
GENERATING AN SMS PACKAGE USING 123SCAN 4 - 3
4. In the Select your scanner family from the options below window (Figur e 4-3), select the family of scanne rs
that you want to configure. Click Next >.
Figure 4-3
5. In the Select your scanner model from the options below window (Figure 4-4), click the scanner model you
SMS Untitled1 Tab - Select your scanner family Window
want to configure. Click Next >.
Figure 4-4
SMS Untitled1 Tab - Select your scanner model Window
4 - 4 ZEBRA SCANNER MANAGEMENT SERVICE USER GUIDE
6. In the Supported scanner models window (Figure 4-5), click Next > if your scanne r model is in the list of
supported scanners.
Figure 4-5
7. In the Cable connection window (Figure 4-6 on page 4-5), click the Management Communication Protocol
SMS Untitled1 Tab - Supported scanner models Window
IMPORTANT If your scanner model is not in the list, click Change scanner model to return to the Select your
scanner family window (Figure 4-3 on page 4-3) and choose another scanner family.
drop-down arrow to select the communication method you want to use to manage your device.
This protocol is the communication mode used by SMS to manage your scanner. The fastest supported
management communication protocol (programming mode) is shown at the top of the list by default. Note
that this management protocol can be different than the communication protocol used by the device during
normal operations such as scanning and tran sm ittin g dat a to the ho st ap p licat ion .
The SMS for Windows supports the following communication protocols.
•
USB SNAPI
•
USB OPOS (IBM Hand-held USB with Full Scan Disable)
For example, the management communication protocol for a DS9808 scanner could be SNAPI while the
scanning communication protocol could be OPOS.
GENERATING AN SMS PACKAGE USING 123SCAN 4 - 5
Figure 4-6
8. In the Load parameters to your scanner window (Figure 4-7 on page 4-5), you may check the Load
SMS Untitled1 Tab - Cable connection Window
parameters to scanner box if you have a configuration file containing attributes that you want to load onto
the scanner. This option requires that you have already created an appropriate configuration file for your
scanner using the 123Scan utility. After checking the box, click the Browse for file and select the
configuration file you want to load onto the scanner. Click Next >.
Figure 4-7
9. In the Load firmware to your scanner window (Figure 4-8 on page 4-6), you may check the Update scanner
SMS Untitled1 Tab - Load parameters to your scanner Window
firmware box to load updated firmware on the scanner. When you check the box, the available versions of
firmware actively display. The most recent firmware is recommended and selected by default but previous
versions may be chosen, if necessary. Click Next >.
4 - 6 ZEBRA SCANNER MANAGEMENT SERVICE USER GUIDE
Figure 4-8
10. On the Add another device group window (Figure 4-9), you may configure additional device groups (up to
SMS Untitled1 Tab - Load firmware to your scanner Window
a total of five) within the SMS Package. If applicable, click Add Device Group and repeat Step 4 on page
4-3 through Step 9 on page 4-5. When all device groups are added within the SMS Package, click Next>.
Figure 4-9
SMS Untitled1 Tab - Add another device group Window
11. In Track events with a log file window (Figure 4-10 on page 4-7), you may select the mode for logging SMS
events.
NOTE The information that follows includes log file field descriptions and sample log files. To continue with
the next step in the SMS Package Generator (Step 12), go to page 4-10. Click Next > on the window
above to continue with the generator.
GENERATING AN SMS PACKAGE USING 123SCAN 4 - 7
Figure 4-10
Table 4-1 lists the fields available in this window, and their descriptions.
Table 4-1
Generate a log file Select this box to create a log file; deselect this box to disregard logging.
Target location This is the directory path to which the log file is saved on your target (production) PC. Note the
Track events with a log file Window Fields
Field Description
Track events with a log file Window
Logging for all devices: Select this radio button to log events for all managed devices defined in
the SMS Package.
Enable / disable logging
by device group: Select this radio button to choose particular managed devices for which
to log events.
target location excludes the name of the log file.
For a Windows machine, by default, the target path would be:
C:\Program Files\Zebra Technologies\Barcode Scanners\SMS\Download\Logs
For advanced users, this same path can also be entered as:
%ProgramFiles%\Zebra Technologies\Barcode Scanners\\SMS\Download\Logs
4 - 8 ZEBRA SCANNER MANAGEMENT SERVICE USER GUIDE
IMPORTANT This log file option results in only two log files in the
Windows folder, which never exceeds the Log File Size
set within the SMS Package.
IMPORTANT This log file option results in multiple log files
accumulating within the log file target folder.
Table 4-1
Track events with a log file Window Fields (Continued)
Field Description
Log method There are two log method options available: Circular log file, or Accumulating log files.
Circular Log File (default): All events are alternately written between two log files. All
information is written to one log file until it reaches its maximum size,
then new information is written to a second log file. Once the second
file reaches its maximum size, new information is again written to the
first log file, over-writing its original content. The combined size of
both log files equals the Log File Size set within the SMS Package.
Accumulating Log Files: All events for a given SMS Package are logged into one file that
continues to grow until it reaches its maximum size, the Log File Size
set within the SMS Package. Upon log file one reaching the maximum
size, another new log file is created. The process of generating new
log files will continue over time. If a new SMS Package is placed
within the SMS download folder, a new log file is started.
Note
: All log files are time date stamped. A sample name would be
"SMS_2019.10.11_11-58-13.log". The naming convention is
SMS_YYYY.MM.DD_HH-MM-SS with hours (HH) in 24 hour format.
Log file size Maximum log file size.
Sample Log File
SMS log message format is as follows <log-time-stamp> <device-group-and-name> :: <log-messageinformation>::<configuration-or-firmware-file-name>: <unique-identifier-for-scanner> :<scanner-model> :
<scanner-serial-number> : < DOM> :< firmware-version> :< program-date>
Table 4-2 lists the log file fields, and their descriptions.
Table 4-2
Log-time-stamp Date and time of the log message in the format: yyyy-mm-dd, hh:mm:ss.
device-group-and-name Device group and the name of the device by which this scanner is managed.
log-message- information Details of the action that the corresponding device executed on this scanner.
configuration-or-firmware-file-name File name and the path of firmware or configuration file below %program
unique-identifier-for-scanner Unique identifier assigned by SMS for each scanner managed by the SMS service or
scanner-model Model of the scanner.
scanner-serial-number Serial number of the scanner.
DOM Date of manufacture of the scanner in the format: ddmmyy. If the scanner does not
firmware-version Version of the current firmware in the scanner.
program-date Date on which the scanner's last electronically programmed date in the format:
Log File Fields
Field Description
files%/Download.
application.
have this information, SMS writes "DDMMYY" to the log file.
ddmmyy. If the scanner does not have this information, SMS writes "DDMMYY" to
the log file.
GENERATING AN SMS PACKAGE USING 123SCAN 4 - 9
When the SMS agent begins execution of a package, either from cold-start or auto-reboot, an appro priate log
file entry is made (if logging is enabled) explaining the last loaded package details as follows:
[2012-07-27, 14:17:37] INFO: A Valid Package 'SMS
Package_ScannerUpgrade_OnAttach_DS6878_Presentation.smspkg' has been dropped into the DOWNLOAD
folder. SMS will be re-started when current device execution completes
[2012-07-27, 14:17:40] INFO: SMS Device Engine Requested a Service Restart
[2012-07-27, 14:17:43] INFO: SMS Service is Stopping... [2012-07-27, 14:17:48] INFO: SMS has Started
Executing as a Service From Download Folder. Package Details: 'SMS
Package_ScannerUpgrade_OnAttach_DS6878_Presentation_modified.smspkg'
The following is part of the log file content while SMS loaded the configuration on a DS6878 scanner with a
standard cradle connected to host PC:
[2012-06-27, 12:48:49] Device Group 1_on_scanner_attached :: Initializing configuration file push ::
config_files\Config_File_DS6878_UC_A2_MOD_2012.05.17.scncfg : 1 : STB4278-C0001WW : MXA0BP47
: 15Dec06 : NBCACAAM : DDMMMYY
[2012-06-27, 12:48:54] Device Group 1_on_scanner_attached :: Configuration file push failed ::
config_files\Config_File_DS6878_UC_A2_MOD_2012.05.17.scncfg : 1 : STB4278-C0001WW : MXA0BP47
: 15Dec06 : NBCACAAM : DDMMYY
[2012-06-27, 12:49:32] Device Group 1_on_scanner_attached :: Initializing configuration file push ::
config_files\Config_File_DS6878_UC_A2_MOD_2012.05.17.scncfg : 2 : DS6878-SR20007WR : M1M87R37J
: 07OCT10 : PAAAJS00-003-R01 : DDMMYY
[2012-06-27, 12:49:50] Device Group 1_on_scanner_attached :: Configuration file push succeeded ::
config_files\Config_File_DS6878_UC_A2_MOD_2012.05.17.scncfg : 2 : DS6878-SR20007WR : M1M87R37J
: 07OCT10 : PAAAJS00-003-R01 : DDMMYY
The following log entries were created while SMS loa ded firmware and th e configuration on a DS687 8 scanner
with a presentation cradle when SMS was started as a service:
[2012-06-22, 21:15:29] INFO: SMS has Started Executing as a Service From Work Folder. Package Details:
'SMS Package_DS6878_SR_StandardCradle_ScannerUpgrade_2012.06.22.smspkg'
[2012-06-22, 21:15:54] Device Group 1_on_service_start :: Initializing firmware update ::
plug-in_files\DS6878-STANDARD_SR_MODELS-S-014.SCNPLG : 2 : CR0078-SC10007WR :
1020800512980 : 28JUL10 : NBCACAAM : DDMMYY
[2012-06-22, 21:16:24] Device Group 1_on_service_start :: Firmware update succeeded ::
plug-in_files\DS6878-STANDARD_SR_MODELS-S-014.SCNPLG : 2 : : : : :
[2012-06-22, 21:16:41] Device Group 1_on_service_start :: Initializing configuration file push ::
config_files\Config_File_DS6878_BeeperHigh_2012.06.22.scncfg : 2 : CR0078-SC10007WR :
1020800512980 : 28JUL10 : NBCACAAM : DDMMYY
[2012-06-22, 21:16:47] Device Group 1_on_service_start :: Configuration file push succeeded ::
config_files\Config_File_DS6878_BeeperHigh_2012.06.22.scncfg : 2 : CR0078-SC10007WR :
1020800512980 : 28JUL10 : NBCACAAM : DDMMYY
[2012-06-22, 21:17:05] Device Group 1_on_service_start :: Initializing configuration file push ::
config_files\Config_File_DS6878_BeeperHigh_2012.06.22.scncfg : 3 : DS6878-SR20007WR : M1M87R37F
: 08OCT10 : PAAAJS00-004-R01 : DDMMYY
[2012-06-22, 21:17:22] Device Group 1_on_service_start :: Configuration file push succeeded ::
config_files\Config_File_DS6878_BeeperHigh_2012.06.22.scncfg : 3 : DS6878-SR20007WR : M1M87R37F
: 08OCT10 : PAAAJS00-004-R01 : DDMMMY
4 - 10 ZEBRA SCANNER MANAGEMENT SERVICE USER GUIDE
12. In Activation trigger window (Figure 4-11), you may select the operation mode of the SMS agent, and
which events trigger the SMS Package to be loaded to a scanner.
Figure 4-11
Table 4-3 lists the fields available in this window, and their descriptions.
Table 4-3
SMS Operation Mode The SMS operation mode setting determines if the SMS operates as a service, or an
Activation trigger Window Fields
Field Description
Activation trigger Window
application. Use the drop-down arrow to make a selection.
•
Run as Service: The SMS runs continuously as a Windows background service. It
monitors scanners and the download folder on the target PC for any activity that triggers
a package load. In this mode, the SMS agent automates the process of loading an SMS
Package to your scanner. Once the SMS Package is on the target PC in the download
folder, the SMS agent reviews the SMS Package content and automatically programs
the scanner appropriately. Using your SMS Package, the SMS agent programs your
scanner without any console/application initiating command. Asset info r ma tio n ca n be
accessed real time using Windows Management Instrumentation (WMI).
GENERATING AN SMS PACKAGE USING 123SCAN 4 - 11
Table 4-3
SMS Operation Mode
(continued)
Activation trigger Window Fields (Continued)
Field Description
•
Run as Application: The SMS is only available and running when it is manually
launched. The SMS agent can be launched by a third party application, or console
initiated command. When invoked, the SMS agent checks the download folder on the
target PC for the existence of a new SMS Package, and processes that package.
Typically, a customer uses their third party network management tool first to copy an
SMS Package into the target PC download folder and then invokes the SMS agent to
process that package. Upon completion of the task(s) outlined in the SMS Package, the
SMS agent terminates operation and releases the USB scanner device. Asset
information can be accessed non-real time from the log file (which must be enabled in
the SMS Package), and compiled through parsing . In Application mode, the SMS agent
can be used in conjunction with but not simultaneously with a third party application, or
driver (such as a non-Zebra OPOS scanner driver). To configure SMS to initially run in
Application mode, first download an SMS Package with its SMS operation mode set to
Run as an Application (programmable in the 123Scan Activation trigger Window on
page 4-10). Then, launch the SMS agent using the script, Start SMS Agent.vbs (located
in <%ProgramFiles%>\Zebra Technologies\Barcode Scanners\SMS). Alternatively , from
a command line, type net start "Zebra SMS".Note 1: If you select Run as Application,
certain trigger events start of SMS, initial download of SMS Package, and date and time)
are not available for selection.
Note 2
: To switch the SMS agent to operate in Application mode, load an SMS Package with
SMS Operation Mode set to Run as an Application.
Note 3
: Be aware that when SMS is running in Service mode, an unexpected plug and play
event such as a cable reconnection may trigger SMS processing. In this instance, SMS
will temporarily gain control of the scanner to perform any specified SMS package
directives and interrupt normal scanner operation until SMS has finished executing. If
this scenario is a concern, set SMS to 'Run as Application' and launch SMS manually
when an interruption will not impact normal scanner usage.
Apply settings to all
device groups
Each device group has
its own settings
Trigger events (Event triggering load)
Start of Scanner
Management Service
(SMS)
Power up and/or cable
connection of scanner
Run immediately (at
download of package to
SMS)
This trigger event to load your SMS Package applies trigger events to all managed devices in
your SMS Package.
This trigger event to load your SMS Package applies different trigger events to different
managed devices in your SMS Package.
Triggers package loading when the SMS agent starts. This trigger includes the following
scenarios:
•
When the SMS agent is executed, and Run as an Application is set.
•
When the SMS is set to run as a service, and the host PC is rebooted.
•
When the SMS is set to run as a service, and the SMS service is restarted.
Triggers package loading when a scanner becomes attached to the host PC, or the PC is
rebooted.
Triggers package loading immediately upon arrival and detection of an SMS Package in the
download folder . If this trigger is not selected, package loading takes place a t the next host PC
reboot or restart of the SMS service. This trigger applies only to Run as service.
4 - 12 ZEBRA SCANNER MANAGEMENT SERVICE USER GUIDE
Table 4-3
Date and time Triggers a package load at the specified date and time, and time interval. This trigger applies
Table 4-4
SMS Functionality
Activation trigger Window Fields (Continued)
Field Description
only to Run as Service mode.
Select Reoccurrence to set up a reoccurring event to load an SMS Package. For example, to
reload the same SMS Package every two weeks, set this field to Every 2 weeks. In this
example, the SMS Package loads on the same day of the week and time specified in the Date
and Time trigger event boxes. The SMS Package continues to reload every two weeks. This
trigger applies only to Run as Service mode.
Table 4-4 shows the differences between the SMS operation modes.
SMS Operation Modes: Service vs Application
Run as Service Run as Application
Parameter Configuration Supported Supported
Firmware Update Supported Supported
Asset Tracking Supported Non-real Time Support
SMS Operation
SMS always running and accessible Supported Not Supported
SMS launched by a command from a third party console or
application
Upon completion of tasks define in the SMS Package, the SMS
terminates operation and releases the USB scanner
Not Supported Supported
Not Supported Supported
GENERATING AN SMS PACKAGE USING 123SCAN 4 - 13
13. Click Next > in Figure 4-11 on page 4-10 to display the Load and print window. In this window choose one
of the SMS Package output options (see Table 4-5).
Figure 4-12
Table 4-5
Load and print Window Buttons
Load and print Window
Button Description
Save SMS package to PC Prompts with a window to select a location to save the completed SMS Package.
Print SMS report Opens a window with the option to print the SMS report, or save it to a Word
document.
Email SMS package Opens an e-mail window with the SMS Package attached.
Deploying an SMS Package Opens a window with instructions on deploying an SMS Package on a production
host PC.
4 - 14 ZEBRA SCANNER MANAGEMENT SERVICE USER GUIDE
Opening an Existing SMS Package
You can open an existing SMS Package from a Windows folder, or within the 123Scan utility.
Opening an SMS Package from a Windows Folder
1. Locate the SMS Package on the PC. The folde r path for an SMS Package within 123Scan folde r structure
is C:\ProgramData\Documents\123Scan\SMS Packages.
2. Double-click the package.
3. The 123Scan utility launches and the SMS package summary window (Figure 4-13) displays.
Figure 4-13
4. Click Start SMS package wizard to modify the package content.
SMS package summary Window
GENERATING AN SMS PACKAGE USING 123SCAN 4 - 15
Opening an SMS Package within 123Scan
1. Launch the 123Scan utility.
2. On the Start tab, click the Actions drop-down menu (see Figure 4-1 on page 4- 2) and select Open Scanne r
Management Service (SMS) Package.
Select the SMS Package from the file dialog
or
Select an existing package from the recent files list. Click the Recent files arrow to expand the list of the
recently accessed files (Figure 4-14).
Figure 4-14
3. Once expanded, click any of the recent files in the list to open SMS package summary window for that file
(Figure 4-13).
4. Click Start SMS package wizard to modify the package content.
Open SMS package Window
4 - 16 ZEBRA SCANNER MANAGEMENT SERVICE USER GUIDE
CHAPTER 5 DEPLOYING THE SMS
PACKAGE
Introduction
Deployment of an SMS Package involves placing the package into the SMS download folder on the sca nn er' s
host PC. Whether the SMS agent is running as a service or as an app l ic at ion , the SMS ag e nt m on ito rs th e
download folder for a deposited SMS Package. If a package exists, the SMS agent executes the actions
specified in the SMS Package.
For additional details see the Deployment Checklist in section 6.3.3.
Helpful Links
•
To simplify navigation of this document and find links to commonly asked questions, see Chapter 2,
QUICK STARTUP GUIDE.
•
To download the SMS agent, visit www.zebra.com/sms.
•
To view a one minute video tour of the SMS in action, visit www.zebra.com/sms.
•
To view all the SMS how-to videos, visit www.zebra.com/scannersoftwarevideos.
5 - 2 ZEBRA SCANNER MANAGEMENT SERVICE USER GUIDE
Customer Supplied Third Party File Distribution Tool
The SMS solution relies on the customer to provide a method to install the SMS agent on managed host PCs
and to deliver SMS Packages to those host PCs. The typical method is using a 3rd party network tool such as
IBM Director or HP OpenView to push the SMS software and packages to terminals that have scanners to be
configured.
SMS Package Download Destination
The directory path for the SMS' download folder, which the SMS agent monitors for new packages, is shown
below.
%ProgramFiles%\Zebra T echnologies\Barcode Scanners\SMS\Download
Once an SMS Package is placed into the download folder, it is acted upon by the SMS agent. In this process,
the SMS Package is automatically moved from the download folder to a work sub-folder. The new SMS
Package replaces the previous content of the work sub-folder.
An SMS Package placed into the download folder takes priority and is acted on instead of any prior package
that exists in the work folder. For example, if a package exists in the work folder and then another package is
placed into the download folder, the work folder package will no longer be acted upon. Instead, the newly
arrived download folder package replaces the work folder package and is loaded to the scanner.
NOTE Download only one SMS Package at a time to the download folder for processing. Downloading multiple
packages simultaneously into the download folder will yield unexpected results.
Download Folder Structure
The Download folder structure for Windows consists of:
•
%ProgramFiles%\Zebra Technologies\Barcode Scanners\SMS\Download
•
%ProgramFiles%\Zebra Technologies\Barcode Scanners\SMS\Download\Work
•
%ProgramFiles%\Zebra Technologies\Barcode Scanners\SMS\Download\Temp
•
%ProgramFiles%\Zebra Technologies\Barcode Scanners\SMS\Download\Logs
The 123Scan Deployment Checklist
The 123Scan Deployment Checklist is a document detailing the activities involved in deploying an SMS
Package. The document also lists key folder locations:
•
Where to access your SMS Package from the PC running 123Scan.
•
Where to push the SMS Package on your production PCs.
The Deployment Checklist can be accessed and printing from within 123Scan v5.0 on the SMS Wizard's name
and notes window. Use the how-to-video URL in Helpful Links on page 5-1 for more on this topic.
CHAPTER 6 SMS CONFIGURES SCANNER
AT POS
Configuration at the Point-Of-Use (POS)
Once the SMS agent running on a host PC detects a trigger event, it will perform the actions specified in the
active package. For example, when the SMS agent is running in Service mode, the arriva l of a package in the
download folder causes the agent to process the new package, check the rule set conditions specified and
then perform the appropriate actions. If the connection of a scanner device is defined as a trigger e vent, the
SMS agent will check the rule set conditions specified in the active package and perform the actions
associated with that connection event.
When the SMS agent runs in Application mode, the execution of the SMS agent is the trigger event. Upon
execution, the agent will check for and process a new package. Then it checks the rule set conditions in the
active package and performs the specified actions.
Helpful Links
•
To simplify navigation of this document and find links to commonly asked questions, see Chapter 2,
QUICK STARTUP GUIDE.
•
To download the SMS agent, visit www.zebra.com/sms.
•
To view a one minute video tour of the SMS in action, visit www.zebra.com/sms.
•
To view all the SMS how-to videos, visit www.zebra.com/ScannerHowToVideos.
6 - 2 ZEBRA SCANNER MANAGEMENT SERVICE USER GUIDE
Scanner LEDs Indicating SMS Load Status
The SMS agent instructs the scanner to display a red blinking LED to indicate that an SMS Package is
currently loading to the scanner.
Table 6-1
LED Blinking Red Loading SMS Package to scanner.
Other LED states (when not controlled by an application) vary by
product. For LED state details, refer to your product's Product
Reference Guide available at:
www.zebra.com/us/en/support-downloads/scanners.html
LEDs
LED State Description
SMS agent not communicating with scanner.
.
Default SMS Agent Operation Mode
By default, the SMS is configured to start as a service when first ins ta lle d on a prod uction host PC.
To configure SMS to initially run in Application mode, first download an SMS Package with its SMS operation
mode set to Run as Application. (This is programmable on the 123Scan Activation trigger Wi ndow on page
4-10.) Then, launch the SMS agent using the script, Start SMS Agent.vbs (located in
<%ProgramFiles%>\Zebra Technologies\Barcode Scanners\SMS). Alternatively, from a command line type the
following: net start "Zebra SMS".
Querying Asset Tracking Information
The SMS solution enables the query of asset tracking information from Zebra scanners. The following is an
example of asset information to query:
•
Model Number
•
Serial Number
•
Date of Manufacture
•
Firmware Version
•
Configuration File Name
•
Date of first Electronic Programming
Asset information can be queried in either real time or non-real time based on the SMS operation mode. For
more details on SMS operation mode see SMS Operation Mode on page 4-10.
•
If the SMS operation mode is set to Service, asset information can be accessed real time using WMI.
•
If SMS operation mode is set to Application, asset information can be accessed non-real time from the
log file and compiled through parsing. For mo r e in fo r mat ion on t he SMS log file see Generate a log file
on page 4-7 and Sample Log File on page 4-8.
In this scenario a script can be written to parse the required information.
SMS CONFIGURES SCANNER AT POS 6 - 3
Querying Asset Information Real Time
SMS provides a conduit for an enterprise console application to query and report fleet wide asset tracking
information using Windows WMI. Note that because of network security implications, WMI remote
management is typically an IT/SysAdmin function that requires configur ation and access rights to allow remo te
functionality depending on a customer's particular network environment.
The Zebra WMI namespace is Symbol_BarcodeScanner which allows WMI to access properties, methods and
events for Zebra scanners. The SMS installation loads the WMI Provider Service for Zebra Scanners named
ScnSrvc.
If multiple RSM-enabled scanners are connected to an SMS ho st PC, asse t trackin g inf or m ation for all
connected scanners can be reported back to the querying source (enterprise console application) over the
standard WMI interface. For a list of parameter values that can be queried, download the Product Reference
Guide for your scanner model at www.zebra.com/us/en/support-downloads/scanners.html
Sample Application to Query Assets Using WMI
A basic application that demonstrates this capability is the Sca nner WMI Test sample application provided with
Zebra's Scanner SDK for Windows. Figure 6-1 shows this sample application's ability to display the asset
information of a scanner connected to the same host PC on which the sample application is running. For
access to the WMI sample application and its source code, download the Scanner SDK for Windows from
www.zebra.com/scannersdkforwindows. The Scanner WMI test sample application is capable of accessing
scanners on remote PCs if a systems administrator configured WMI for remote access.
.
Figure 6-1
Asset Tracking Information Displayed in the WMI Sample Application from the Scanner SDK
6 - 4 ZEBRA SCANNER MANAGEMENT SERVICE USER GUIDE
Sample WMI Visual Basic Script to Query Asset Tracking Information
The following Visual Basic script shows an example of a WMI script used to query the asset information of
scanner devices in IBM HandHeld mode connected to a host PC running the SMS agent.
' FILENAME: ScannerInfo.vbs
'
On Error Resume Next
Const wbemFlagReturnImmediately = &h10
Const wbemFlagForwardOnly = &h20
arrComputers = Array("127.0.0.1")
For Each strComputer In arrComputers
WScript.Echo " Script Start: " & Time
Set objWMIService = GetObject("winmgmts:\\" & strComputer & "\root\CIMV2")
Set colScanners = objWMIService.ExecQuery("SELECT * FROM Symbol_BarcodeScanner", _
"WQL", wbemFlagReturnImmediately + wbemFlagForwardOnly)
For Each objScanner in colScanners
WScript.Echo
Wscript.Echo "-----------------------------------------------------"
WScript.Echo " Part Number : " & objScanner.PartNumber
WScript.Echo " Serial Number : " & objScanner.SerialNumber
WScript.Echo " Firmware Ver : " & objScanner.FirmwareVersion
WScript.Echo " Date of Manuf : " & objScanner.DateofManufacture
Wscript.Echo "-----------------------------------------------------"
Next
Next
WScript.Echo " Script End: " & Time
Figure 6-2
Sample WMI Visual Basic Script Screen Output
Tracking SMS Operations
SMS enables a customer's management console to query the ActivityStatus flag of the
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\ZebraSMS registry key (Figure 6-3) to
determine if scanners are being controlled by the SMS.
SMS CONFIGURES SCANNER AT POS 6 - 5
Figure 6-3
The ActivityStatus value indicates whether SMS agent is busy currently executing any rules that cannot be
interrupted.
ActivityStatus = 1 indicates that the SMS agent is busy executing some rules and cannot be interrupted at
this point in time without compromising device state. Any new packag e dropped into the download folder is
only acted upon after these critical rules finish execution.
ActivityStatus = 0 indicates that the SMS agent has completed rule execution and any package can be
safely dropped into the download folder at this point in time and is immediately acted upon.
In addition, the SMS log file tracks all the actions performed on all connecte d scanners as specified in the SMS
Package.
Zebra SMS Registry Key
6 - 6 ZEBRA SCANNER MANAGEMENT SERVICE USER GUIDE
CHAPTER 7 TROUBLESHOOTING
Helpful Links
•
To simplify navigation of this document and find links to commonly asked questions, see Chapter 2,
QUICK STARTUP GUIDE.
•
To download the SMS agent, visit www.zebra.com/sms.
•
To view a one minute video tour of the SMS in action, visit www.zebra.com/sms.
•
To view all the SMS how-to videos, visit www.zebra.com/scannersoftwarevideos.
Troubleshooting Actions
Verification of Proper Operation
After installing SMS, copy any SMS Package to the download folder. If the installation is successful, the
package shall disappear from the download folder after few seconds. If SMS loggin g is enabled in the package,
the SMS log file will have an entry indicating that SMS has executed the package successfully:
[<date-time-stamp>] INFO: SMS has Started Exe cu tin g as a <L au nc h Mo d e> From the do wn loa d folder,
Package Details: <package-name>
Folder Security Check for the Download Folder
The Windows user account logged into the host PC requires administrative rights including full access rights to
the download folder and its sub-folders. These access rights are granted by the SMS installation utility by
default and modifying these by any other means would lead to improper exe cution of the SMS agent. Add ing or
removing any files inside these folders while the SMS agent is running is prohibited. The download folder is
constantly monitored and managed by the SMS agent for either instrumented or manually initiated SMS
Package drops in real time. Do not introduce any file except valid SMS Packages into the download folder.
The log folder by default is located inside the download folder. However there can be usage scenarios where
the log folder might have to be located in a network share. In these situations, the SMS agent will impersonate
the currently logged-on interactive user to gain access to this network shared folder. It is therefore essential to
ensure that the logged-on user has sufficient security privileges to gain access to this network shared folder.
7 - 2 ZEBRA SCANNER MANAGEMENT SERVICE USER GUIDE
Firewall Considerations
Firewall permissions must allow the customer's third part y console application to copy an SMS Package to the
download folder.
Finding Last Load Details in Log File
When the SMS agent begins execution of a package either from cold-start or auto-reboot, an ap propriate log
file entry is made (If logging is enabled) documenting the details of the last loaded package.
Error Copying Files Running the SMS Agent as an Application on a Windows XP SP2 Host PC
If an error copying files occurs on a Windows XP SP2 host PC when running the SMS agent as an Application,
the Windows Temp folder may have reached its capacity. If so, this error may be overcome by deleting the
contents of the folder C:\Windows\Temp.
Updates to Scanner Devices Connected Via a USB Hub Do Not Complete
If updates to multiple scanners connected to a host PC through a USB hub fail to complete, ensure that ea ch
port of the USB hub provides 500mA of current. A self-pow ered USB hub with a power supply capable of
providing 500mA per port may be required.
INDEX
Numerics
123Scan
download . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2, 3-3
installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
A
activation trigger window . . . . . . . . . . . . . . . . . . . . . 4-10
activation trigger window fields . . . . . . . . . . . . . . . . 4-10
activity reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13
add another device group window . . . . . . . . . . . . . . 4-6
agent download . . . . . . . . . . . . . . . . . . 1-1, 2-1, 3-1, 3-2,
. . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6, 4-1, 5-1, 6-1, 7-1
agent folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-12
application, 123scan . . . . . . . . . . . . . . . . . . . . . . . . 3-13
asset tracking
querying . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
real time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
sample VB script . . . . . . . . . . . . . . . . . . . . . . . . . 6-4
asset tracking info in WMI
sample app window . . . . . . . . . . . . . . . . . . . . . . 6-3
B
bullets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii
C
cable connection window . . . . . . . . . . . . . . . . . . . . . 4-5
components
123scan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13
SMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-12
configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13
conventions
notational . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii
CoreScanner driver installation . . . . . . . . . . . . . . 3-3, 3-6
create SMS package window . . . . . . . . . . . . . . . . . . . 4-2
custom setup window (SMS) . . . . . . . . . . . . . . . . . . . 3-9
D
data view reports . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13
default log folder . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-12
download 123Scan . . . . . . . . . . . . . . . . . . . . . . 3-2, 3-3
download scanner software . . . . . . . . . . . . . . . . . . . . 6-2
download SMS . . . . . . . . . . . . . . . . . . . 1-1, 2-1, 3-1,3-2,
. . . . . . . . . . . . . . . . . . . . . . . . 3-3, 3-6, 4-1, 5-1, 6-1, 7-1
I
images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13
information, service . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
installation complete window . . . . . . . . . . . . . . 3-6, 3-10
installation ready window . . . . . . . . . . . . . . . . . 3-5, 3-10
installation status window . . . . . . . . . . . . . . . . . . . . . 3-5
installing 123Scan . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
installing SMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6
L
launch SMS as an application . . . . . . . . . . . . . . . . . 3-12
launch SMS package generator . . . . . . . . . . . . . . . . . 4-2
leds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
license agreement window . . . . . . . . . . . . . . . . . 3-4, 3-8
load and print window . . . . . . . . . . . . . . . . . . . . . . . 4-13
load and print window buttons . . . . . . . . . . . . . . . . . 4-13
load firmware to scanner window . . . . . . . . . . . . . . . . 4-6
load params to scanner window . . . . . . . . . . . . . . . . 4-5
load to scanner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
log file . . . . . . . . . . . . . . . . . . . . . . . .3-12, 4-6, 4-7, 4-8,
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-11, 6-2, 6-5, 7-2
log file fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8
Index - 2 ZEBRA SCANNER MANAGEMENT SERVICE USER GUIDE
log folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-12
M
management comm protocols . . . . . . . . . . . . . . . . . . 4-4
N
notational conventions . . . . . . . . . . . . . . . . . . . . . . . . .viii
O
operation mode
asset information . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10
selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10
service vs application . . . . . . . . . . . . . . . . . . . . 4-12
supported functions . . . . . . . . . . . . . . . . . . . . . . 4-12
OSs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
overview . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1, 1-3, 6-2
P
package
communication protocols for
generating packages . . . . . . . . . . . . . . . 4-4
create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
download folder . . . . . . . . . . . . . . . . . . . . . . . . . 3-12
installation path . . . . . . . . . . . . . . . . . . . . . . . . . 3-13
launch generator . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
load to scanner . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
name/notes window . . . . . . . . . . . . . . . . . . . . . . 4-2
sizes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
package summary window . . . . . . . . . . . . . . . . . . . 4-14
plug-ins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13
process steps . . . . . . . . . . . . . . . . . . . . . . . . . . .1-1, 1-3
R
recent files window . . . . . . . . . . . . . . . . . . . . . . . . . 4-15
release notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13
reports
activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13
data view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13
requirements
123Scan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
SMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
requirements, system . . . . . . . . . . . . . . . . . . . . . . . . 3-2
S
select scanner family window . . . . . . . . . . . . . . . . . . .4-3
select scanner model window . . . . . . . . . . . . . . . . . .4-3
service information . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
setup type window (SMS) . . . . . . . . . . . . . . . . . . . . . .3-8
size, SMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-2
SMS name and notes window . . . . . . . . . . . . . . . . . . 4-2
SMS package name/notes window . . . . . . . . . . . . . .4-2
SMS registry key window . . . . . . . . . . . . . . . . . . . . . . 6-5
start SMS agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13
stop SMS agent . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-13
supported OS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-2
supported scanner models window . . . . . . . . . . . . . .4-4
T
track events with log file window . . . . . . . . . . . . . . . .4-7
track events with log file window fields . . . . . . . . . . . .4-7
trigger events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-11
V
VB script sample window . . . . . . . . . . . . . . . . . . . . . .6-4
videos . . . . . . . . . . . . . . . . . . . . . . . . . .1-1, 2-1, 3-1, 4-1,
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-1, 6-1, 7-1
W
welcome installation window . . . . . . . . . . . . . . . 3-4, 3-7
windows
activation trigger . . . . . . . . . . . . . . . . . . . . . . . . .4-10
add another device group . . . . . . . . . . . . . . . . . .4-6
asset tracking info in WMI sample app . . . . . . . . 6-3
cable connection . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
CoreScanner driver install . . . . . . . . . . . . . . . . . .3-3
create SMS package . . . . . . . . . . . . . . . . . . . . . .4-2
installation complete . . . . . . . . . . . . . . . . . 3-6, 3-10
installation ready . . . . . . . . . . . . . . . . . . . . 3-5, 3-10
installation status . . . . . . . . . . . . . . . . . . . . . . . . .3-5
license agreement . . . . . . . . . . . . . . . . . . . . 3-4, 3-8
load and print . . . . . . . . . . . . . . . . . . . . . . . . . . .4-13
load firmware to scanner . . . . . . . . . . . . . . . . . . .4-6
load params to scanner . . . . . . . . . . . . . . . . . . . . 4-5
package summary . . . . . . . . . . . . . . . . . . . . . . .4-14
recent files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15
select scanner family . . . . . . . . . . . . . . . . . . . . . . 4-3
select scanner model . . . . . . . . . . . . . . . . . . . . . . 4-3
SMS custom setup . . . . . . . . . . . . . . . . . . . . . . . .3-9
SMS name and notes . . . . . . . . . . . . . . . . . . . . . 4-2
SMS package name/notes . . . . . . . . . . . . . . . . . . 4-2
SMS package name/notes window . . . . . . . . . . .4-2
SMS registry key . . . . . . . . . . . . . . . . . . . . . . . . .6-5
SMS setup type . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8
supported scanner models . . . . . . . . . . . . . . . . . 4-4
track events with log file . . . . . . . . . . . . . . . . . . . 4-7
VB script sample . . . . . . . . . . . . . . . . . . . . . . . . . 6-4
welcome installation window . . . . . . . . . . . . 3-4, 3-7
Windows Management
Instrumentation (WMI) . . . . . . . . . . . . 4-10, 6-2, 6-3
Index - 3
Index - 4 ZEBRA SCANNER MANAGEMENT SERVICE USER GUIDE
Zebra Technologies Corporation
Lincolnshire, IL U.S.A.
www.zebra.com
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. ©2019
Zebra Technologies Corporation and/or its affiliates. All rights reserved.
72E-156774-04 Revision A - November 2019
Loading...