Dynamic Staging

StageNow 5.14

Overview

StageNow 4.1 (and later) supports Dynamic Staging, which allows compatible data-entry fields in a StageNow Profile to be populated with values from a file when staging barcodes (or .bin files) are generated. This permits the Staging Administrator to create many barcodes from a single Profile, each of which can configure devices differently depending on variations of how and/or where the devices are to be used. Dynamic Staging also supports .bin files, which are used to stage devices from USB or SD card storage.

Dynamic Staging simplifies staging based on...

  • Locale
  • Language
  • Input method
  • Wi-Fi setting
  • User credentials
  • Other customer variations

NOTES:

  • Only StageNow 4.1.1 (or later) can enable/disable Dynamic Staging. Disabled by default; enable in Global Settings.
  • Upgrades to StageNow 4.1.1 are possible only from:
    • StageNow 4.1.0 (replaced by v4.1.1 on the Zebra support portal)
    • StageNow 4.0.1
    • StageNow 3.4.0
  • The "Host the Deployment Package Outside of StageNow FTP Server" option is not available when using Dynamic Staging.

Requirements

  • StageNow 4.1 (or later) installed
  • Knowledge of which fields to populate dynamically and their corresponding variable names
  • A .csv file containing variable names and matching data for all dynamic fields (can be created during staging setup)

Variable Creation

Dynamic Staging variables are created in two primary ways:

  • Exporting Variables from a Database - Companies that maintain user data (locale, network settings, etc.) in databases or spreadsheets can export the relevant data to a .csv file and use the file to generate staging Profiles accordingly. When a StageNow Profile is created for pre-existing variables, the variable names entered in the Profile must exactly match those of the database.

  • Generating Variables "On the Fly" - For companies that DO NOT maintain user databases (or that do not wish to use them for this purpose), variable names can be made up as the Dynamic Profile is being created. Once the Profile is finished, StageNow can generate a .csv template file that contains all the newly created variables that the administrator can then populate with the required data. This is the Zebra-recommended method of creating a .csv file because of the inherent accuracy of automatic output of variable names.

Both of these scenarios are fully supported by StageNow and documented in the Using Dynamic Staging section.

There are many possible ways that Dynamic Staging could help save time. For example, a company that configures devices at a central location and deploys them to branch locations throughout the United States might maintain one .csv file for each store, each of which might contain device data for that store's departments and the requisite device settings. To illustrate, if "Store 1" had 10 departments, the Store_1.csv file would contain 11 rows. The first row must contain the variable names. The next 10 rows are for the departments, and each contains the settings for that department's variables. Variable names common to all departments might include:

  • %dept_name%
  • %ssid%
  • %wifi_passphrase%
  • %default_scanner%
  • %app_1%
  • %app_2%
  • %app_3%

Using Dynamic Staging

Variable Usage Rules

  • To avoid possible errors, the .csv source file must NOT be open when Dynamic Staging is performed.
  • Variable names used in a StageNow Profile must match exactly with those in the source file.
  • Variables can be used alone or in combination with static values and/or other variables in the same field.
  • Only %variables% and/or textual data are permitted as values in the source file (no JSON or XML).
  • If outputting XML barcodes: Dynamic Staging supports plain text only as input or in variables.
  • Each row in the .csv file represents one set of data for a Dynamic Profile.
  • Row numbers within the .csv file are used to label barcode printouts for identification purposes.
  • Each variable MUST be separated by a semi-colon (;) and each line must end with a semi-colon.
  • Dynamic Variables are supported ONLY for device settings and Staging Operator instruction fields.
  • The Staging Operator instruction field accepts ONE variable only.
  • If a percentage sign is to be part of the variable data, the percentage sign must first be declared as a variable. See example below.

* Useful for automating device enrollment into an EMM system, for example.

Using '%' as variable data

StageNow accepts all characters (including the semi-colon) as entries in Dynamic Variable fields except the percent sign (%), which requires special handling to avoid a "Malformed variable" error. To use a percent sign as data in an entry field (for example in an SSID name like Store_01_SS%ID), the percent sign must first be declared as a variable.

To include a percent sign (%) in a data entry field:

  1. In the .csv file to be used, add a variable named "%percent%" with "%;" as its only value.
  2. In the SSID field in StageNow, enter "Store_01_SS%percent%ID" as the value (for example).
  3. Generate the barcode(s) as desired. When the barcode is generated, StageNow will replace "%percent%" with the "%" character, as in the "Store_01_SS%ID" name above.

To Use Dynamic Staging:

Before beginning, enable Dynamic Staging in the Global Settings panel:

image Click image to enlarge; ESC to exit.

Next, open a Profile to which to add or enable dynamically staged fields and follow the steps below.
  1. Identify data-entry fields accompanied by a percent-sign icon:
    image Click image to enlarge; ESC to exit.

  2. Enter static text (i.e. "GMT") and/or variables (i.e. %zone%) in any combination as desired:
    image Click image to enlarge; ESC to exit.

    A warning appears until variables are entered using the correct syntax:
    image Click image to enlarge; ESC to exit.

  3. Enter remaining static text and/or variables as desired for all fields and click the "Continue" button:
    image Click image to enlarge; ESC to exit.

  4. To test a Dynamic Profile, select a barcode type and click the "Test" button:
    image Click image to enlarge; ESC to exit.

  5. A prompt appears for selecting (or creating) the .csv file similar to the image below:
    image To select an existing .csv file skip to Step 6.
    To create a .csv file "on the fly" from variables created in the Profile:
        a. Click "Save a CSV Template" in the dialog shown below, name and save the file as prompted.
        b. In the same dialog (as below), click "Open a CSV file for editing, navigate to and open the file saved in Step a.
        c. Enter data for all variables (separated by semi-colons), save and close the file.
    IMPORTANT: Use semi-colons to separate variable names and data, and at the end of each line (see Notepad image, below).
    image The image below shows a correctly formatted .csv file:
    image Click image to enlarge; ESC to exit.
  6. Select the .csv file that contains variable data for the Dynamic Profile:
    image Click image to enlarge; ESC to exit.

    On success, a barcode sheet is produced for each row of the .csv file similar to the image below.
    The Profile name is appended with the row number on the printout for identification.
    image Click image to enlarge; ESC to exit.

  7. If errors occur, refer to the Troubleshooting section below for instructions.
  8. When testing is completed, click Publish. A prompt appears for entering Staging Operator instructions.
    Combine a variable and static text as desired. An example is shown below.
    NOTE: This field accepts ONE variable only.
    image Click image to enlarge; ESC to exit.

  9. Click "Publish Now" to complete the process; distribute staging materials as normal.

Dynamic Staging is complete

Troubleshooting

Dynamic Staging errors occur when StageNow is unable to acquire data from a .csv file for generating staging media.

Typical causes:

  • The .csv file is missing data for one or more variables
  • One or more variables were entered incorrectly in StageNow
  • The .csv file is not present on the host workstation
  • The .csv file is open or otherwise locked on the host workstation

NOTE: The "Host the Deployment Package Outside of StageNow FTP Server" option is not available when using Dynamic Staging.

Error Diagnosis:

  1. If StageNow displays a "CSV Issues" message like the one below, click "Save the log" to generate a list of issues. image Click image to enlarge; ESC to exit.

  2. Name and save the file in the desired location: image Click image to enlarge; ESC to exit.

  3. Click the "Open a log file for viewing" button, navigate to and open the log file saved in the previous step.
    A sample log file is shown below: image Click image to enlarge; ESC to exit.

  4. Open the log in a text editor, make corrections to the .csv file as needed.
    Then return to StageNow and click "Start Over" button:
    image Click image to enlarge; ESC to exit.

  5. Return to Step 6 in the previous section and try Dynamic Staging again.