DeviceHub: User Interface Reference

In this topic, you will find user interface reference information for the DeviceHub application.

Main Menu

On the main menu, you can invoke a variety of commands that give you the ability to configure the application and start or pause the application's activity.

Table 1. File MenuBy using the commands on this menu, you can configure or close the application.
Command Description
Configure

Opens the Configuration window, in which you specify the application settings and define the devices connected to MYOB Acumatica via the application.

Exit

Closes the application.

Table 2. Actions MenuYou use the commands on this menu to pause or start the application.
Element Description
Pause

Pauses the application's activity.

Start

Runs the application.

Log Tab

This tab contains a toolbar with the following button and the log area, which displays a chronological list of events related to the application, each with a date and time.

Table 3. ToolbarThe toolbar of this tab contains only one button, which you use to clear the existing lines of the log.
Element Description
Clear

Clears the log area.

Scales Tab

This tab contains the list of digital scales that are connected to MYOB Acumatica via the application. The tab is displayed if the Enable scale support check box is selected on the General tab of the Configuration window.

Table 4. Scale ListThis table lists the digital scales that are connected to MYOB Acumatica via the application.
Column Description
Scale ID

The identifier of the digital scale.

Weight

The last weight received from this digital scale.

Diagnostics Tab

This tab contains a toolbar and the log area, which displays a chronological list of diagnostic details about all devices connected to MYOB Acumatica via the application, each with a date and time. The tab is displayed if the Collect diagnostics check box is selected on the Log tab of the Configuration window.

Table 5. ToolbarThe toolbar of this tab contains only one button, which you use to clear the existing lines of the log.
Element Description
Clear

Clears the log area.

Resources Tab

This tab contains the information about the resources that are currently being used for the loading and printing processes. The tab is displayed if the Collect diagnostics check box is selected on the Log tab of the Configuration window.

Table 6. File Loading PaneThis pane displays information about the threads that are currently being used for parallel processing of the file-loading tasks.
Element Description
In Progress An informational element that shows the number of file-loading threads that are currently being processed.
Pending An informational element that shows the number of file-loading threads that are currently waiting for processing.
Task list The list of the file-loading tasks, organized in a tree-like structure. These tasks are grouped by threads if parallel processing has been configured and is being used.
Table 7. Printing PaneThis pane displays information about the threads that are currently being used for parallel processing of the printing tasks.
Element Description
In Progress An informational element that shows the number of printing threads that are currently being processed.
Pending An informational element that shows the number of printing threads that are currently waiting for processing.
Task list The list of the printing tasks, organized in a tree-like structure. These tasks are grouped by threads if parallel processing has been configured and is being used.

Configuration Window

You use this window to specify the basic settings of the DeviceHub application. You can open this window by clicking File > Configure in the main menu of the application.

Table 8. General TabThis tab contains the general settings of this DeviceHub instance.
Element Description
DeviceHub ID The unique identifier to be used for this DeviceHub instance.
Enable scale support A check box that indicates (if selected) that digital scales can be configured and connected to MYOB Acumatica via the application.
Enable scanner support A check box that indicates (if selected) that scanners can be configured and connected to MYOB Acumatica via the application.
The Methods of retrieving print jobs section includes the following elements.
Use push notifications

A check box that indicates (if selected) that the application receives print jobs via push notifications that are sent when a user clicks the Print or Reprint button on any of the applicable MYOB Acumatica forms.

If this check box is selected, the Regular check box becomes available for selection.

Poll on start or reconnection A check box that indicates (if selected) that DeviceHub receives print jobs that are awaiting processing each time it runs or restarts.
Poll regularly

A check box that indicates (if selected) that the print jobs that are awaiting processing are automatically received regularly at the specified periods of time.

Note:
The regular polling starts only after the first push notification is received after the application start.

This check box is available for selection only if the Use push notifications check box is selected.

If you select this check box, the following boxes become available: Do not poll last x sec and Poll every x sec.

Do not poll last x sec

The minimum time interval before a print job can be started during the regular polling. If the time since creation of the job is less than the value in this box, DeviceHub will not add the job to the printing or scanning queue.

This box is available for selection only if the Poll regularly check box is selected.

Poll every x sec

The interval in seconds at which the application receives any print jobs awaiting processing.

This box is available for selection only if the Poll regularly check box is selected.

Table 9. Connection TabOn this tab, you specify the settings for connecting the application to the MYOB Acumatica instance.
Element Description
URL The URL of the configured MYOB Acumatica instance for which DeviceHub is configured (for example, http://localhost/AcumaticaDB).
Login The user login (that is, the username) that DeviceHub will use to connect to the MYOB Acumatica instance.
Password The password that DeviceHub will use to connect to the MYOB Acumatica instance.
Tenant The login name of the tenant to which DeviceHub will connect. (If you have only one tenant in your MYOB Acumatica instance, leave the box empty.)
The Connection timeout section includes the following elements.
Send for x sec The number of seconds the application is sending the connection request.
Receive for x sec The number of seconds the application will wait for the connection response.
The Reconnection settings section includes the following elements.
Limit attempts to The maximum number of times DeviceHub will attempt to reconnect to the MYOB Acumatica instance if it has been disconnected.
Interval The interval between attempts to reconnect to MYOB Acumatica.
Table 10. Processing TabOn this tab, you specify settings that optimize the processing of documents.
Element Description
Combine every x documents when printing

A check box that indicates (if selected) that the application will combine the specified number of documents of the same type (that is, the same MYOB Acumatica reports printed on the same printer) into a single PDF file to be printed.

If this check box is cleared, each document to be printed is received in a separate PDF.

Use parallel processing

A check box that indicates (if selected) that the application will use parallel processing to process print jobs for all connected printers. If this check box is selected, the Max loading threads and Max printing threads boxes become available.

If the check box is cleared, all print jobs are processed in the global printing queue (except the print jobs for the printers that have individual settings to use parallel processing configured on the Printers tab). In this case, the Max loading threads and Max printing threads boxes are unavailable.

Max loading threads

The maximum number of threads that may be used for loading print jobs.

This box is available only if the Use parallel processing check box is selected on this tab.

Max printing threads

The maximum number of threads that may be used for printing.

This box is available only if the Use parallel processing check box is selected on this tab.

Create print task when x documents received or every y sec The rules of processing print tasks kept in the application's buffer. In the first box, you specify the maximum number of documents kept in the buffer before the application processes them; in the second box, you specify the interval (in seconds) when a print task is created, regardless of the number of the documents in the buffer.
Table 11. Log TabOn this tab, you specify which information the application collects and displays in the log.
Element Description
Collect diagnostics A check box that indicates (if selected) that extended diagnostic information is collected and shown on the Diagnostics and Resources tabs of the application.
Save log to file A check box that indicates (if selected) that the log must be saved to a file when the application is running. If this check box is selected, the Log folder and Keep log files for x days boxes become available.
Log folder The folder where the log file will be saved. You can leave the default folder that is filled in or specify another folder.
Keep log files for x days The number of days for which the log is kept. The default value is 30.

This value is applicable and the box is available if the Save log to file check box is selected.

The tab has the following buttons next to the Log folder box.
Browse For Folder A button that opens the dialog box that you can use to look for the folder in which the application will store the log file.
Open folder A button that opens the folder in which the log file is stored.
Table 12. Printers TabThis tab consists of a list of printers (on the left side of the tab) and a variety of buttons and elements. You can add a printer and specify its settings. You can also select any printer in the list and then remove the printer or specify its settings.
Element Description
Printer list A list of the printers that have been configured in DeviceHub. You can select any printer in this list to remove it or to specify or edit its settings.
Add A button that you click to add a new printer to the list. You click this button and then specify the settings of the new printer on the right side of the tab.
Remove A button that you click to remove the selected printer from the list.
Name The unique identifier of the selected or newly added printer. Only digits and uppercase letters may be used for printer names.
Printer The hardware device to be defined as a DeviceHub-operated printer. You select the hardware device from the printers that are already configured in your operating system.
Raw mode (for use with compatible label printers) A check box that indicates (if selected) that the selected printer works in raw mode. A raw mode printer is frequently used for printing carrier labels.
Paper size

The paper size to be used by default when the documents are printed on the selected printer. The default value is <Printer Default>, which means that the default settings of the specific printer will be used.

The other possible options in this box depend on the printer's printing settings.

This box is unavailable for editing if the Raw mode (for use with compatible label printers) check box is selected.

Paper bin

The paper bin to be used by default when the documents are printed on the selected printer. The default value is <Printer Default>, which means that the default settings of the specific printer will be used.

The other possible options in this box depend on the printer's printing settings.

This box is unavailable for editing if the Raw mode (for use with compatible label printers) check box is selected.

Scaling

The scaling options that will be used when you print a document. You can select one of the following options:

  • No Scaling: The scaling options for printing the document are not defined.
  • Shrink to Page: The document's content is scaled down to fit onto a single page.
  • Fit to Margins: The document's content is scaled down to fit the printable area that is defined by the printer.

This box is unavailable for editing if the Raw mode (for use with compatible label printers) check box is selected.

Orientation

The paper orientation to be used by default for printing the documents on the selected printer. One of the following option buttons should be selected:

  • Automatic: The default setting of the printer will be used for printing the documents on the selected printer.
  • Portrait: Portrait orientation will be used for printing the documents on the selected printer.
  • Landscape: Landscape orientation will be used for printing the documents on the selected printer.

This box is unavailable for editing if the Raw mode (for use with compatible label printers) check box is selected.

Use parallel processing

A check box that indicates (if selected) that the application uses parallel processing for print jobs sent to this printer. If this check box is selected, the Max loading threads and Max printing threads boxes on this tab become available.

If the check box is cleared, the application uses the global processing settings specified on the Processing tab. In this case, the Max loading threads and Max printing threads boxes on this tab are unavailable.

Note:
Print jobs for a printer that have the Raw mode check box selected are always processed in a separate thread.
Max loading threads

The maximum number of threads that may be used for loading print jobs.

This box is available only if the Use parallel processing check box is selected on this tab.

Max printing threads

The maximum number of threads that may be used for printing.

This box is available only if the Use parallel processing check box is selected on this tab.

Table 13. Digital Scales TabThis tab consists of a list of digital scales (on the left side of the tab) and a variety of buttons and elements. You can add a digital scale and specify its settings, and you can select any digital scale in the list and then remove it or specify its settings.

This tab is shown only if the Enable scale support check box is selected on the General tab.

Element Description
Scale list A list of the digital scale devices that have been configured and connected to MYOB Acumatica via the application. You can select any scale in this list to remove it or to specify or edit its settings.
Add A button that you click to add a new digital scale to the list. You click this button and then specify the settings of the new digital scale on the right side of the tab.
Remove A button that you click to remove the selected digital scale from the list.
Scale ID The unique identifier of the selected digital scale (or the digital scale you are adding). Only digits and uppercase letters can be used for scale names.
Device The hardware device to be defined for use as a scale.
Show all devices A check box that indicates (if selected) that all devices connected to the computer will be displayed in the Device box and will be available for selection. You select this check box to be able to select the digital scale that you are configuring if it is not detected as a scale device.
Table 14. Scanners TabThis tab consists of a list of printers (on the left side of the tab) and a variety of buttons and elements. You can add a scanner and specify its settings. You can also select any scanner in the list and then remove the scanner or specify its settings.
Important:
Due to limitations of some manufacturers' scanner drivers, in some cases, only one scanner can be managed by each workstation. That is, if DeviceHub is used for scanning, it must be installed on each workstation that is connected to a scanner for proper functionality.

This tab is shown only if the Enable scanner support check box is selected on the General tab.

Element Description
Scanner list A list of the scanners that have been configured and connected to MYOB Acumatica via the application. You can select any scanner in this list to remove it or to specify or edit its settings.
Add A button you click to add a new scanner to the list. You click this button and then specify the settings of the new scanner on the right side of the tab.
Remove A button that you click to remove the selected scanner from the list.
Name The unique identifier of the scanner. Only digits and uppercase letters may be used for the names of scanners.
Scanner The hardware device to be defined as the selected DeviceHub-operated scanner. You select the hardware device from the scanners already configured in your operating system.
Paper source The paper source to be used by default when the document is being scanned on the selected scanner.
Color mode The color mode to be used by default when a document is being scanned on the selected scanner.
Resolution The output resolution to be used by default when a document is being scanned on the selected scanner.
File type

The type of the file to which the scanning result will be saved. You can select one of the following options:

  • Image (default): If the scanned document has multiple pages, each page will be saved as a separate image.
  • Pdf: If the scanned document has multiple pages, all pages will be saved as a single document with the PDF extension.
  • Image/Pdf (Multiple pages): If the scanned document has only one page, it will be saved as an image. If the scanned document has multiple pages, all pages will be saved as a single document with the PDF extension.
Table 15. Footer AreaYou use the buttons in the footer area to open the configuration file, and to apply or cancel your changes to the configuration settings.
Button Description
Open configuration file Opens the application's configuration file (user.config) which can be used as the supporting information.
OK Applies the specified settings and closes the Configuration window.
Cancel Discards the changes and closes the Configuration window.