Summary
Network printing configurations are made possible through the use of a .properties file that the ClinSpark Agent reads from. When a list of printers are displayed to users in ClinSpark, the Agent will provide networked printers based on the configuration in the properties file.
Depending on the version of the ClinSpark Agent being used, the location and management of this properties file will vary across workstations. Customers are encouraged to first read this help guide to gain an understanding about the properties file before proceeding with modification for network printing use cases.
Prerequisites
Network printing capabilities are supported using Agent version 1.2.2, or, 1.4.1 or greater. Customers using Agent version 1.3 will need to update to 1.4.1 or greater to utilize this feature.
The network printing strategy via the Agent supports connections via the printer IP address and/or host name. Printer IP address and/or host name should be known prior to continuing.
Networked printers must be discoverable & accessible by the Windows PC to be used in ClinSpark. Sites can explore the use of Zebra printer setup utilities to help ensure that network-enabled printers are properly installed and ‘accessible’ by a PC. Customers should work with their site IT/technology services teams to ensure proper installation. Foundry Health cannot assist in this setup.
Network printing works best when using a direct network (RJ45) connection to a Zebra printer with a built-in network card. Other methods of network printing such as Windows based ‘print servers’, printer sharing, LPD, SMB, CUPS and others are not currently supported.
Setup
The ClinSpark Agent will use printers that are configured in the Agent properties file.
The properties file can be opened by a standard text editor (such as Notepad).
Inline documentation exists within the file to help guide users, with an example line of a configuration that can be used for a networked printer.
#allows for specifying networked printers; name must contain ‘ClinSpark’ and name and IP / host name must be separated with a ‘-’ (default port is 9100); separate printer configurations to be separated with a ‘,’
#CLINSPARK_NETWORKED_ZEBRA_PRINTERS=ClinSpark PK Lab - 192.168.100.102, ClinSpark Checkin - 192.168.100.107:9101, ClinSpark Recruitment - PrinterHostName
Using the CLINSPARK_NETWORKED_ZEBRA_PRINTERS property will allow for defining a networked printer.
The requirements for defining a networked printer using this property are:
The defined printer must contain ‘ClinSpark’ in the name
The printer name and IP address/host name must be separated with a hyphen-minus “-” symbol
If the printer is available on a port other than default, it can be specified as part of the IP address
Multiple printer configurations can be defined, if separated via ‘,’
These are acceptable examples for use:
ClinSpark PK Lab - 192.168.100.102
ClinSpark PK Lab - 192.168.100.102:9100
ClinSpark PK Lab - PKLabPrinter
When naming printers, it’s recommended to keep the naming convention simple and clear so users understand which printer to select in the ClinSpark user interface. If possible, avoid use of any special characters (such as hyphens, symbols, or other non alphanumeric characters).
Additionally, a hyphen-minus (Unicode Character “-” (U+002D)) must be used to separate the name of the printer and the IP address. A dash character is not supported for use in the property.
Once the properties file has been updated, users must stop and then restart the Agent in order for the changes to take affect. The simplest way to accomplish this is to right click the Agent tray icon, close the Agent, and then re-open the agent by using the ClinSparkAgent.exe executable file in the installation directory. Alternately, users can restart their PC.
Example
Here is an example of a properties file with a single networked printer, configured via IP address:
Within ClinSpark, this is how that printer would appear in dropdowns:
In a configuration where multiple networked printers are defined…
…this is how the dropdown in ClinSpark would look:
The name of the printer is what is displayed to users in the ClinSpark user interface. The IP address will not show. For example, if a printer defined as ClinSpark PK Lab - 192.168.100.102 in the properties file, in ClinSpark, it will show to users as ClinSpark PK Lab.
Demonstration
Sharing configurations across PCs
Customers that use Agent version 1.5.0 or greater across their workstations can utilize certain environment variables to establish a location where a ‘shared’ properties file is read from. For example, an environment variable could point to a shared/network drive that could be referenced across one or more PCs configured with the same variable. This will allow site IT groups to need only manage a single properties file with all available network configurations that all workstations can reference for ClinSpark use. For more details about this is possible, see this help guide.
Notes
When editing the properties file with Notepad, changes must be done by a user with Administrative privileges. User may see a message like this on save if they do not have proper permissions:
To address this, it’s best to open Notepad first as an administrator, then open the properties file for edits.
Within the properties file, when a line contains a ‘#’ symbol, it means the property is not in use. The ‘#’ symbol is commonly used for documentation purposes. Removing the ‘#’ symbol on a line will enable that particular setting.