API Connections of DeviceHub

A single DeviceHub application can create multiple API connections to the MYOB Acumatica instance while performing print jobs, scan jobs, and measurements with scales. This topic provides information about the entities and settings of DeviceHub that can create API connections.

API Connections for Printers

The DeviceHub application creates one dedicated API connection which is used for the following tasks:
  • Login to the instance
  • Receipt of the printer list
  • Update of the printer list
  • Receipt of print jobs
  • Update of print jobs
  • Logout of the instance
When DeviceHub receives files for printing, the application creates at least one more temporary API connection to upload the files to be printed. The maximum number of such connections depends on the following setting of the application:
  • If the Use parallel processing check box is selected on the Processing tab of the application settings, the number of the temporary API connections to receive files for printing can be equal to the value in the Max loading threads box. If the Use parallel processing check box is cleared, DeviceHub can create only one API connection to receive files for printing.
  • If a printer in the list of printers on the Printers tab has the Use parallel processing check box selected, the application can create additional API connections for this printer. The number of these connections is defined by the value in Max loading threads box specified for the printer on the Printers tab.
  • If a printer in the list of printers on the Printers tab has the Raw mode (for use with compatible label printers) check box selected, the application can create an additional API connection for this printer.

API Connections for Scanners

If the use of scanners is configured for DeviceHub, the application opens one API connection which is used for the following tasks:

  • Login to the instance
  • Receipt of the scanner list
  • Update of the scanner list
  • Receipt of scan jobs
  • Update of scan jobs
  • Logout of the instance

API Connections for Scales

If the use of scales is configured for DeviceHub, the application opens one API connection which is used for the following tasks:

  • Login to the instance
  • Receipt of the scale list
  • Update of the scale list
  • Receipt of measurement results
  • Logout of the instance

Calculation of API Connections

Suppose that your company has the following office devices managed via DeviceHub:

  • 2 printers for general printing tasks
  • 1 printer for printing thermal labels
  • 1 printer for the CTO
  • 3 scanners
  • 2 scales

The entities and devices as well as the settings of each device affecting the number of connections are described in the following table:

Table 1. API connections created by the DeviceHub application
Entity or device Settings Maximum number of connections
The DeviceHub printer module for all printers N/A 1
2 printers for general printing tasks The Use parallel processing check box is selected on the Processing tab of the application settings. The Max loading threads box on the same tab has 4 specified. 4
1 printer for printing thermal labels The Raw mode (for use with compatible label printers) check box is selected in the printer settings on the Printers tab. 1
1 printer for the CTO The Use parallel processing check box is selected in the printer settings on the Printers tab. The Max loading threads box in the printer settings has 2 specified. 2
The DeviceHub scanner module for 3 scanners N/A 1
The DeviceHub scales module for 2 scales N/A 1
Total: 10

Tracking of API connections

You can track the number of active API connections created by the DeviceHub application on the System Monitor (SM201530) form. For more details, see Monitoring System Health.

Note: When you open the configuration settings of the DeviceHub application by clicking File > Configure in the application menu or pause the application by clicking Actions > Pause in the application menu, the application temporarily closes all active API connections. The connections are resumed when you close the application settings or click File > Start in the application menu.