1. Resonate RFID Reader Management 2.1 User Guide
  2. Migrating from MotionWorks RFID Reader Management
  3. Device Migration Utility
  • Resonate RFID Reader Management 2.1 User Guide
Device Migration Utility
View content for :
Platform:

Device Migration Utility

The Device Migration utility takes a spreadsheet that lists all the readers currently managed by a MotionWorks RFID Reader Management (1.0) instance, and adds them in a not-fully-migrated state to
Resonate RFID Reader Management
. The spreadsheet must specify specific information about each reader, including their corresponding site information. Use the
Resonate Device Initializer
 utility to fully adopt them.

Command Syntax

rm-device-migrator-<VERSION>.exe [options]
Note: Replace <VERSION> with the version of the initializer.

Options

Option
Description
--path <XLSXfilename>
-p <XLSXfilename>
Specifies the spreadsheet's file name. The spreadsheet should be a standard XLSX spreadsheet.
Default: N/A
Required: Yes
--sheet "<sheetname>"
-s "<sheetname>"
Specifies the sheet name in the spreadsheet. Specify the name in quotes.
Default: "Master"
Required: No
--url https://<RESONATE SERVER FQDN>/
-u https://<RESONATE SERVER FQDN>/
Specifies the base URL of the
Resonate server
. For example: 
--url https://my.resonate.server.com/
Default: N/A
Required: Yes
--skip-tls
Specifies to ignore HTTP and HTTPS errors.
Default: N/A
Required: No

Additional Information

  • Migration is a two-stage process: run the Device Migration utility and then run
    Resonate Device Initializer
     utility in adoption mode. The Device Migration utility adds the readers listed in the spreadsheet to
    Resonate RFID Reader Management
     in a not-fully-migrated state; those successfully added are displayed on the
    Infrastructure
    Discovered
     page. After running this utility, run the
    Resonate Device Initializer
     utility in adoption mode to transfer their management from MotionWorks RFID Reader Management to
    Resonate
    .
  • The spreadsheet must include all columns listed as required below; these columns must be filled in. Include optional columns as needed. Use the specified column names.
    Column Name
    Description
    Site Number
    The name1 of the reader's site, as assigned to the site in
    Resonate
    . If a site with the specified name does not currently exist in
    Resonate
    , the Device Migration utility will add it. If it does exist but the specified address is not the same, the address is updated in
    Resonate
    .
    This column must be first; otherwise, the import fails.
    Required: Yes.
    Address
    The site's street address (number and street name).
    Required: Only required if the site does not currently exist in
    Resonate
    .
    City
    The site's city.
    Required: Only required if the site does not currently exist in
    Resonate
    .
    State
    The site's state, province, or region.
    Required: Only required if the site does not currently exist in
    Resonate
    .
    Zip Code
    The site's postal or ZIP code.
    Required: Only required if the site does not currently exist in
    Resonate
    .
    Device Name
    The reader's friendly name. All readers should have a unique device name.
    Required: Yes.
    MAC Address
    The reader's MAC address.
    Required: No.
    Resonate
     can automatically determine this information from the reader. Add this column only if you need it for your own tracking purposes.
    IP Address
    The reader's IP address.
    Required: Yes, if you do not pass the reader's hostname (FQDN).
    Hostname
    The reader's fully qualified domain name (FQDN).
    Required: Yes, if you do not pass the reader's IP address.
    Added as Hostname (YES) or IP Address (NO)
    Specifies whether you provided the FQDN or the IP address of the reader. Resonate can establish reader's IP address from the reader's FQDN, and vice versa.
    Required: Yes.
    SNTP Server
    The NTP server that the reader's SNTP client uses. Ensure this server is the same one used by the Resonate server's NTP client to maintain consistent system time. If it is not the same, you can either specify the appropriate NTP server in this column;
    Resonate
     will update the reader once migrated; alternatively, you can configure the reader in
    Resonate
    , after the reader is migrated.
    Required: Yes.
    Serial Number
    The reader's serial number.
    Required: Yes.
    Model Number
    The model ID. Specify one of the following:
    • FX7500-2-US
    • FX7500-4-US
    • FX7500-8-US
    • FX7500-2-WR
    • FX7500-4-WR
    • FX7500-8-WR
    • FX9600-4-US
    • FX9600-8-US
    • FX9600-4-WR
    • FX9600-8-WR
    • ATR7000-P2100A0-US
    • ATR7000-P2100A0-WR
    • ATR7000-P1100A0-US
    • ATR7000-P1100A0-WR
    For FX7500 and FX9600, the middle number corresponds to the number of antenna ports; use US or WR depending on whether your reader is a US or World reader.
    For ATR7000, the model ID corresponds to the part number printed on the label at the back of the RFID reader 2.
    Required: Yes.
    Configuration
    Any additional custom information that you need to upload to
    Resonate
    . Pass it in valid JSON format. Only pass information to this column under the guidance of Zebra Product Support.
    Required: No.
  • The spreadsheet must include a record (row) for each reader, with all required columns filled in. You must provide either the reader's IP address or its hostname; use the
    Added as Hostname (YES/NO)
     column to specify which you have provided. You must specify the name of the reader's site; if the site does not currently exist in
    Resonate
    , specify the site's name and its full address. An example spreadsheet with the minimum number of columns and one with all possible columns used by
    Resonate
     are shown below. The column names must match those of the columns in the examples.
    Example Spreadsheet with the Minimum Required Columns for
    Resonate
    Screenshot of an example spreadsheet with the minimum required columns for Resonate .
    Example Spreadsheet with All Possible Columns Used by
    Resonate
    Screenshot of an example spreadsheet with all possible columns used by Resonate .
    You can find the required reader information in the MotionWorks RFID Reader Management screens or in your external reader install records.
  • As the utility runs, it works through the spreadsheet and adds that information into the
    Resonate RFID Reader Management
     instance databases. If it sees a new site, it adds it. If the site already exists but with a different address, it updates the site's address. It adds each reader to its specified site. The migration script automatically skips duplicate entries and entries with incorrect or misformatted information.
  • During operation, the utility shows its status in the Command Prompt or PowerShell console, noting records (rows) skipped and showing total aggregated statistics at the end; it also includes the number of attempts made before reporting invalid or skipped. The utility also writes to a log file,
    device-migrator.log
    , detailed information about each reader added and about each spreadsheet row skipped or declared invalid. The log file is in the same folder as the one from which you ran the utility.
  • You can run Device Migrator again; it skips existing migrated devices or sites. In general, the Device Migrator utility migrates all devices to build a database that is as complete as possible.
  • Additional columns in the spreadsheet are ignored.
  • Run the Device Migration utility from any Windows machine with network access to the RFID readers.
  • The Device Migration utility is a self-contained executable (
    rm-device-migrator-<VERSION>.exe
    ) without an installer. It is distributed in the
    resonate-<VERSION>.tar.gz
     file that you received from Zebra.
1 Note that although the column name must be Site Number, you must specify the site's name. This is a known
Resonate
 2.1 bug.
2 The part number reported in the reader's web interface (and by the firmware) does not match the part number on the label of the device.