Installation and Configuration

Overview

The Scanner Management Solution (SMS) for Linux enables the management of Zebra Scanners connected to the host computer. SMS does following operations by executing as an application.

  1. Provide reports/logs with scanner’s asset information.
  2. Provide scanner statistics information.
  3. Configuration push.
  4. Firmware update.
  5. Diagnostics logging for scanner management operations.

SMS can be executed as an application or crone job. User intervention can be minimized by setting a Cron-Job in the system.

Prerequisites

  1. CoreScanner driver for Linux version 4.0.0 or above should be installed in the system.
  2. Package manager commands for the system (rpm or dpkg).

  3. Minimum hardware requirements,

    1. Pentium Dual-Core E214 1.6GHz or Pentium Mobile Dual-Core T2060 or Pentium Celeron E1200 1.6GHz
    2. 2GB RAM 1.2 GB free hard drive space.
    3. USB port, 1.1 or higher, for the connection of USB Scanners.

Installation and Package Types

RPM packages can be installed using "rpm" command (e.g. rpm -i <package name>).

Debian packages can be installed using “dpkg” command (e.g. dpkg -i <package name>).

Please refer the supported distributions matrix for the latest updates.

Provide External Configurations for SMS Execution

SMS has introduced a way to introduce some settings for the tool using an external configuration file. Configuration will be introduced by developers considering the user requests. Configuration file is an XML file and will be installed into /usr/share/zebra-scanner/sms/config/sms-configuration.xml.

Initially, following configuration is available to provide.


<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <tool-configuration>
        <unzip-program-path>/usr/bin/unzip</unzip-program-path>
    </tool-configuration>
</configuration>

Launch SMS as an Application

CoreScanner daemon should be started before launching the SMS as an application. Following steps help to launch the SMS as an application. All commands should be run as the supper user. Example commands are given for Ubuntu 12.04.

  1. Verify whether the cscore (daemon for CoreScanner driver) is already running in the system and "service" terminal command can be used.

    
$ service cscored status

    If cscore is not started, start it using below command.

    
$ sudo service cscored start

  2. Copy relevant configuration/management SMS package generated by 123Scan into the download directory of the SMS.

    
$ sudo cp <SMS_Package>.smspkg /usr/share/zebra-scanner/sms/download/

  3. Now the system is ready to launch SMS as an application. SMS installation is facilitated to execute it as a terminal command. Execute below command to start SMS as an application.

    
$ sudo gnusms

SMS Logs

End User Logs

End user log is saved to /usr/share/zebra-scanner/sms/log directory, currently this directory is not accessible for all users and administrator can change the privileges using "chmod". This log contains the summary report of the execution. End user log contains scanner asset information and configuration update information in remote management operation execution order.

  1. Scanner asset information when starting the SMS for the all connected scanners.
  2. Remote management operation information at the operation start and the after.
  3. Scanner asset information after completing the remote management.

End User Logs Sample


11-09-2018_16:02:50     SMS v1.2 started as an application. 
11-09-2018_16:03:08     Scanner Assets ID:2; Model:CR8178-SC100F4WW; SN:17305010508442;  DoM:04NOV17; Firmware:PAACYS00-001-R09; Config name:C2_001-R07_IBMHH; Protocol:IBMHID
11-09-2018_16:03:08     Scanner Assets ID:3; Model:DS8178-SR0F007ZZWW; SN:17181010502100; DoM:01JUL17; Firmware:PAACXS00-001-R07; Config name:C2_001-R07_IBMHH; Protocol:IBMHID
11-09-2018_16:03:08     Scanner Assets ID:4; Model:DS8108-SR00006ZZWW; SN:17342010504059; DoM:10DEC17; Firmware:PAACZS00-002-R01; Config name:MS_A003; Protocol:SNAPI
11-09-2018_16:03:08     Executing device group "Device Group 1" ID:4; Model:DS8108-SR00006ZZWW; SN:17342010504059  ; DoM:10DEC17; Firmware:PAACZS00-002-R01; Config name:MS_A003; Protocol:SNAPI
11-09-2018_16:03:15     Initialized firmware update: ID:4; Model:DS8108-SR00006ZZWW; SN:17342010504059; DoM:10DEC17; Firmware:PAACZS00-002-R01; Config name:MS_A003; Protocol:IBMHID
11-09-2018_16:03:18     Executing device group "Device Group 1" ID:2; Model:CR8178-SC100F4WW; SN:17305010508442; DoM:04NOV17; Firmware:PAACYS00-001-R09; Config name:C2_001-R07_IBMHH; Protocol:IBMHID
11-09-2018_16:03:18     Device not compatible with: "Device Group 1" ID:2; Model:CR8178-SC100F4WW; SN:17305010508442; DoM:04NOV17; Firmware:PAACYS00-001-R09; Config name:C2_001-R07_IBMHH; Protocol:IBMHID
11-09-2018_16:03:19     Executing device group "Device Group 1" ID:3; Model:DS8178-SR0F007ZZWW; SN:17181010502100; DoM:01JUL17; Firmware:PAACXS00-001-R07; Config name:C2_001-R07_IBMHH; Protocol:IBMHID
11-09-2018_16:03:19     Device not compatible with: "Device Group 1" ID:3; Model:DS8178-SR0F007ZZWW; SN:17181010502100; DoM:01JUL17; Firmware:PAACXS00-001-R07; Config name:C2_001-R07_IBMHH; Protocol:IBMHID
11-09-2018_16:03:19     Completed device group execution: "Device Group 1" ID:3; Model:DS8178-SR0F007ZZWW; SN:17181010502100; DoM:01JUL17; Firmware:PAACXS00-001-R07; Config name:C2_001R07_IBMHH; Protocol:IBMHID
11-09-2018_16:03:24     Completed device group execution"Device Group 1" ID:2; Model:CR8178-SC100F4WW; SN:17305010508442; DoM:04NOV17; Firmware:PAACYS00-001-R09; Config name:C2_001R07_IBMHH; Protocol:IBMHID
11-09-2018_16:25:34     Firmware update succeeded: ID:4; Model:DS8108-SR00006ZZWW; SN:17342010504059; DoM:10DEC17; Firmware:PAACZS00-002-R02; Config name:MS_A003; Protocol:IBMHID
11-09-2018_16:25:34     Initialized configuration push: ID:4; Model:DS8108-SR00006ZZWW; SN:17342010504059; DoM:10DEC17; Firmware:PAACZS00-002-R02; Config name:MS_A003; Protocol:IBMHID
11-09-2018_16:25:52     Configuration push succeeded: ID:4; Model:DS8108-SR00006ZZWW; SN:17342010504059; DoM:10DEC17; Firmware:PAACZS00-002-R02; Config name:MS_A003; Protocol:IBMHID
11-09-2018_16:26:04     Completed device group execution"Device Group 1" ID:4; Model:DS8108-SR00006ZZWW; SN:17342010504059; DoM:10DEC17; Firmware:PAACZS00-002-R02; Config name:MS_A003; Protocol:SNAPI
11-09-2018_16:26:07     Scanner Assets ID:2; Model:CR8178-SC100F4WW; SN:17305010508442; DoM:04NOV17; Firmware:PAACYS00-001-R09; Config name:C2_001-R07_IBMHH; Protocol:IBMHID
11-09-2018_16:26:07     Scanner Assets ID:3; Model:DS8178-SR0F007ZZWW; SN:17181010502100; DoM:01JUL17; Firmware:PAACXS00-001-R07; Config name:C2_001-R07_IBMHH; Protocol:IBMHID
11-09-2018_16:26:07     Scanner Assets ID:4; Model:DS8108-SR00006ZZWW; SN:17342010504059; DoM:10DEC17; Firmware:PAACZS00-002-R02; Config name:MS_A003; Protocol:SNAPI
11-09-2018_16:26:07     SMS successfully completed

Debug Logs

Engineering log contains entire execution information which is use full to diagnose the failures. This log will be saved to /var/log/gnusms directory.

Asset Package Support

Asset package (startup package) can be used to get asset info of the connected scanners. When SMS is executed with asset package assert information of all connected scanners will be printed on console. Also, a log file with the same output will be created in "/usr/share/zebra-scanner/sms/log/" directory.

Steps to Enable Assets

  1. Copy asset package (Sms_Application_Startup_Package.smspkg) to sms download folder (/usr/share/zebra-scanner/sms/download).
  2. Execute SMS as super user.

Sample Logs


03-12-2020_15:26:07     SMS v1.3 started as an application.
03-12-2020_15:26:49     Scanner Assets ID:1; Model:DS9908-SR00004ZZWW; SN:18282523080961  ; DoM:09OCT18; Firmware:PAAECS00-002-R03; Config name:Factory Default; Protocol:SNAPI
03-12-2020_15:26:49     Scanner Assets ID:2; Model:CR8178-SC100F4WW  ; SN:17305010508458  ; DoM:04NOV17; Firmware:PAACYS00-002-R02; Config name:ParaBarDisbl_HKB; Protocol:HIDKB
03-12-2020_15:26:49     Scanner Assets ID:3; Model:DS8178-SR0F006ZMWW; SN:17320010502508  ; DoM:17NOV17; Firmware:PAACXS00-004-R01; Config name:Factory Default; Protocol:HIDKB
03-12-2020_15:26:49     SMS successfully completed

How to Create a cronjob for SMS

SMS can be executed as a scheduled task by adding a Cronjob in the system. Administrator can add the cronjob by doing following steps.

  1. Create/open a file using vim editor and put below content. Use “cronjobsms” for the file name. 0 5 * * 1 gnusms # 0-minutes, 5-hours(24h), *-all days in a month, *-all months, 1-Monday(0Sunday). This will schedule to execute SMS on every Monday 05:00AM
  2. Save the file. Then the file is available on your current directory which is having the content for a cronjob. Execute below command to add it to CronTab.

NOTE: Administrator can use his own way to add the cronjob.

"How To" Videos

Creating a SMS package using 123Scan.

Introduction to SMS.