Skip to main content

Migrating printers from the legacy framework

Use this guide to migrate printers in your store from the legacy framework to the new framework in Associate App.

Migration options​

To migrate printers to the new framework, use one of these 2 methods:

note

  • To use only AirPrint printers, use the Update app configuration method and set capabilities > printer_management > air_print to true.

  • To use Star printers, set the correct star_print_resolution, otherwise the resolution defaults to 200DPI. Use the Update app configuration method and set capabilities > printer_management > star_print_resolution to a printer resolution of your choice.

Migrating printers using the printers API​

Depending on the type of printer you want to migrate, you must set up certain configuration properties. Verify the existing configuration properties for your business using the legacy printers API before you continue.

You have to provide specific data during the printer migration process, such as a networkName for AirPrint printers, or an identifier and interfaceType for Star printers. As the new printer framework supports more documentTypes, ensure that you define printers and their output documents before starting the migration.

This table describes the configuration properties required for a successful printing framework migration based on the printer type. You can learn more about configuration properties from the printers API schema.

AirPrint PrintersStar PrintersZebra Printers
  • manufacturer: The only valid option for AirPrint Printers is airPrint.
  • documentTypes: At least one has to be set. See printers API schema for the complete list.
  • model: Model name of the AirPrint Printer.
  • networkName: Name of the network the AirPrint Printer is connected to.
  • url: Either ipps://{DEVICE_NAME}.local.:443/ipp/print or ipp://{DEVICE_NAME}.local.:631/ipp/print. DEVICE_NAME is the network device name.
  • manufacturer: The only valid option for Star Printers is star.
  • documentTypes: At least one has to be set. See printers API schema for the complete list.
  • model: Model name of the Star Printer.
  • interfaceType: Lan is the only valid option and capitalization matters.
  • identifier: MAC address of the Star Printer.
  • paperWidth: Paper width of the Star Printer.
  • manufacturer: The only valid option for Zebra Printers is zebra.
  • documentTypes: At least one has to be set. See printers API schema for the complete list.
  • model: Model name of the Zebra Printer.
  • ipAddress: IP Address of the Zebra Printer.
  • offsetTop: Top offset when printing with a Zebra Printer.
  • offsetLeft: Left offset when printing with a Zebra Printer.

After you have retrieved the required configuration properties, use the printers API to migrate your printers.

Important

Repeat the previous step for each printer you need to migrate in the store.

When the printers have been successfully migrated, they are displayed in Associate App and function as intended.