Description

Use the Device Engines page to view information on the device engines set up in your system. You can also use this page to create new device engines or edit existing ones.

Access

 AdminCenter > Device Engine Setup > Device Engines

You must have the necessary security permissions to access the Device Engines page.



Technical Manual

Device Engine List

The Device Engines list page contains a list of all the device engines in your system. The device engines that appear in the list are based on any filtering criteria specified at the top of the page. 

Device Engine Filter
Device Engine

Select or begin typing in the search-as-you-type field to search for and select a device engine to filter the list by. Use the following options to further filter device engines:

  • Show active only: Select to have the list display only active device engines.
  • Show Connected/Disconnected Only: Select the checkbox to filter the device engines by connected or disconnected status. From the drop-down list, select Connected to have the list display only device engines that are connected to the system. Select Disconnected to have the list display only device engines that are not connected to the system. Disconnected is the default option. Device engines set to the PRSQRL Interface Type are not included in the filtering.
  • Device engine version older than: Select the checkbox to filter the device engines by age. Enter a date in the fields or use the calendar icon to select a date. The list will display only device engines that are older than the date you selected. Device engines set to the PRSQRL Interface Type are not included in the filtering.
Testing Facility

Select or begin typing in the search-as-you-type field to search for and select one or more testing facilities to filter the list by. The testing facilities you select appear in a list below the search field; to remove a testing facility from the filter, clear its Select checkbox.

Interface Type

Select or begin typing in the search-as-you-type field to search for and select one or more interface types to filter the list by. The interface types available in the search will be a distinct list of interface types that have at least one associated interface in the system. The search results display a Show Active Only checkbox that's selected by default; however, clear the checkbox to display inactive interface types.

The interface types you select appear in a list below the search field; to remove an interface type from the filter, clear its Select checkbox.

Device engines set to the PRSQRL Interface Type are not included in the search results because they do not have associated interface type records.

Device Engine Version

Select or begin typing in the search-as-you-type field to search for and select one or more device engine versions to filter the list by. The versions available in the search will be a distinct list of version numbers currently in the system. The search results display a Count column next to each version indicating how many device engines are running that version number.

The device engine versions you select appear in a list below the search field; to remove a device engine version from the filter, clear its Select checkbox.

Device engines set to the PRSQRL Interface Type are not included in the search results because they do not capture version numbers on that interface type.

Device Engine Functions Used

Use the following options to further filter device engines by functions:

  • Instruments and Middleware: Select to have the list display device engines for instruments and middleware.
  • Label Printing: Select to have the list display device engines for label printing.
  • Document Printing: Select to have the list display device engines for document printing.
  • Faxing: Select to have the list display device engines for faxing.
  • File Transfer: Select to have the list display device engines for file transfers.

Device engines set to the PRSQRL Interface Type are not included in these search results since PRSQRL-type device engines do not have interfaces that use these interface types.

Add

Select to add a new device engine using the Device Engines details page.

RefreshSelect to update the list based on the filters you set. The list will reflect any device engine changes.
Event NotificationsSelect the button to go to the Critical Event Notifications page, where you can set up new or review and/or modify existing device engine notifications. The button text will be green and italic when there are existing device engine notifications. Access to the Critical Event Notifications page requires the role right System Rights > View/Edit Event Notifications (AdminCenter > System Setup > System Defaults).
Device Engine List
Show ___ entriesThe list displays up to 10 device engines. If the list is longer than one page, use the field to specify the number of device engines that appear on the page, or select the left or right arrows located above or below the list to navigate through the list.
ID

Displays the device engine ID (name). Select a device engine in the column to display the device engine's details page with more information, such as the ID, active status, configured interface types, and supported interface types for the selected device engine.

Version

Displays the version date received while a device engine initially connects. Updates when the device engine or Orchard Enterprise Lab system is restarted.

Status

Displays the connection status of the device engine. The text "Connected" in green text displays here if a heartbeat from the device engine has occurred within its Consider disconnected after configuration (see the "Adding or Editing Device Engine Details" section below). The text "Disconnected" in red text displays otherwise.

Testing Facilities

Displays the list of testing facilities that use the device engine. This is configured in the device engine's details page; see "Adding or Editing Device Engine Details" below. 

Last Connected Time

Displays the timestamp of the most recent activity heartbeat or the last time the device engine performed a handshake.

Last Result Time

Displays the timestamp of the last table record received from the device engine. 

Is Active

Displays Yes or No depending on whether the Active checkbox is selected on the device engine's details page.


Adding or Editing Device Engine Details

Use the Device Engines details page to add or edit device engine information.

ID

Enter or edit the device engine's ID. This is a required field.

Type

Select a type of device engine from the drop-down list. 

  • Orchard Device Engine
  • PRSQRL: Only available with a toxicology license, select this option to designate the device engine as a PRSQRL type, which will alter how it sends orders and receives results. 
Testing FacilitiesSelect or begin typing in the search-as-you-type field to search for and select one or more testing facilities that will use the device engine. This is a required field. 
Set Host Password

Select to set a password for the device engine on the Set Host Password pop-up. Each device engine must be assigned a password to continue functioning. This password must be the password entered during the installation of the device engine.

Add text in the Password and Confirm Password fields followed by selecting Save to set the password. Passwords must be at least eight characters and include at least one letter, one number, and one special character. Select Cancel to close the pop-up without setting a new password.

When a password is set, the Set Host Password button turns green and italicized.

ActiveSelect the checkbox to designate that the device engine is active in the system.
Consider disconnected after ___ minutes/hoursEnter the number of minutes or hours of device engine inactivity that the system will consider the device engine disconnected. After the set number of minutes or hours has occurred, the device engine is counted in the Offline tally in the Device Engine section of the Dashboard. The default is 5 minutes of inactivity. 
Device Engine DetailsSelect to open the Device Engine Details pop-up, which provides status update information provided by the Orchard Device Engine.
Request & View Logs

Select to open a Logs pop-up, where you can request log exports from the Orchard Device Engine and view them. The pop-up includes a table displaying previously exported logs. Logs are displayed starting with the newest entries and include a timestamp of when the log was generated, the name of the file, a download link, and a delete button.

Request New Logs: Select this button to request device engine–level logs, which include queues, settings, thread health, and system information. If an outbound log request was already generated in the last 5 minutes, the system will prompt you to confirm your request for an additional log file. Requesting new logs will generate an outbound Device Engine command on AdminCenter > Monitor > Outbound Queue that the Device Engine will read at its next polling interval. New log files may take several minutes to parse, compile, and return depending on the entity and size of the log file being compressed. Device Engines check for new commands approximately every 30 seconds.

Delete old logs: Select this button to purge log files older than 30 days. 

Download: In the Download column, select the Get Link button to generate the archived zip file. The Get Link button will be replaced with a Download hyperlink to save the exported log file.

Refresh: Select to regenerate the displayed rows of previous exports.

Note that this Request & View Logs button is specific to the device engine–level logs. If you need to work with logs from a specific instrument interface, navigate to the desired interface accordion and select the Request & View Logs button there.

Supported Interface Types

Select to open a pop-up that displays all interface types that are supported by the device engine. The list of supported interface types are organized in alphabetical order. Select the letter accordion representing the first letter of the interface type you're looking for; all interface types starting with that letter appear in a list. Select or begin typing in the search-as-you-type Search field to narrow the list of letter accordions.

Example interface types:

  • ACCU-CHEK Inform II(COBAS_ACCU_CHEK_INFORM_TWO)
  • AVOXimeter 4000(AVOX_4000)
  • Afinion Data Connectivity Converter(ALERE_AFINION_DCC)
  • Alere i(ALERE_I)
  • Bd Veritor(BD_VERITOR)
  • CLINITEK Advantus(CLINITEK_ADVANTUS)
  • CLINITEK Status+(CLINITEK_STATUS_PLUS)
  • COULTER AcT diff2(COULTER_ACT_DIFF2)
  • Cell-Dyn Emerald(CELL_DYN_EMERALD)
  • Cholestech LDX(CHOLESTECH_LDX)
  • CoaguChek XS Pro(ROCHE_COAGUCHECK_XS_PRO)
  • Cobas IT 1000(ROCHE_COBAS_IT_1000)
  • DCA 2000+(DCA_2000_PLUS)
  • DCA Vantage(SIEMENS_DCA_VANTAGE)
  • Hemochron Signature Elite(HEMOCHRON_SIGNATURE_ELITE)
  • Nova Net(NOVA_NET)
  • Nova StatStrip(NOVA_STAT_STRIP)
  • Piccolo Xpress(PICCOLO_XPRESS)
  • Sofia(SOFIA)
  • Triage Census Advanced Test Management System(TRIAGE_CENSUS_CONNECT)
  • Triage MeterPro(TRIAGE_METER)
  • Vitros 3600(VITROS_3600)
  • epoc Enterprise Data Manager(EPOC_EDM)
  • pocH-100i(SYSMEX_POCH_100I)
Version NumberDisplays the version number for the instrument.
Last ConnectedDisplays the date and time of when the device engine was last connected to the server.
Last Result Received

Displays the date and time the last result was received by the device engine.

Current Logging Categories

Displays a list of the current logging categories enabled for the device engine as reported by the Orchard Device Engine.

External URL

This field is available after selecting PRSQRL as the device engine type. 

Enter the URL for the PRSQRL device engine so your Orchard enterprise system can initiate transmissions to the PRSQRL device engine.

External Password

This field is available after selecting PRSQRL as the device engine type.

Enter the password for the PRSQRL device engine.

Transmit Messages

This option is available after selecting PRSQRL as the device engine type. 

Select the checkbox for the device engine to proactively send order messages to PRSQRL. Leave the checkbox clear for the device engine to place order messages in the Outbound Queue and await PRSQRL to collect them.

Allow Auto-Approval

This option is available after selecting PRSQRL as the device engine type. 

Select the checkbox for the system to auto-approve results received from PRSQRL. 

Alerts & CommentsSelect to view any alerts or comments that have been defined for the device engine.
< Back to ListSelect to return to the Device Engines list page without saving any changes. 
SaveSelect to record changes and return to the Device Engines list page. 


Configured Interfaces

Each configured interface associated with the device engine is listed and has its own accordion with more information. Each interface accordion lists the interface name and the status of the interface: Standby in yellow, Unstable in red, Inactive, Running, or No Active Instruments.

Select the interface accordion to expand it, which displays the database name, interface type, the currently reported status of that interface from the device engine, and a list of instruments for the interface.

Request & View Logs

Select to open a Logs pop-up, where you can request log exports from the specific instrument interface and view them. The pop-up includes a table displaying previously exported logs. Logs are displayed starting with the newest entries and include a timestamp of when the log was generated, the name of the file, a download link, and a delete button.

Request New Logs: Select this button to request instrument interface–level logs, which include parameters, queues, settings, thread health, and system information. If an outbound log request was already generated in the last 5 minutes, the system will prompt you to confirm your request for an additional log file. Requesting new logs will generate an outbound Device Engine command on AdminCenter > Monitor > Outbound Queue that the Device Engine will read at its next polling interval. New log files may take several minutes to parse, compile, and return depending on the entity and size of the log file being compressed. Device Engines check for new commands approximately every 30 seconds.

Delete old logs: Select this button to purge log files older than 30 days. 

Download: In the Download column, select the Get Link button to generate the archived zip file. The Get Link button will be replaced with a Download hyperlink to save the exported log file.

Refresh: Select to regenerate the displayed rows of previous exports.

Note that this Request & View Logs button is specific to the instrument interface–level logs. If you need to work with logs from the device engine level, navigate to the top of the Device Engines details page and select the Request & View Logs button there.

Associated InstrumentsSelect to open a pop-up that includes all associated instruments for this interface. Select the search button to search for associated instruments. 
Restart InterfaceSelect the button to manually restart the interface. 
Interface TypeDisplays the instrument-related interface.
DatabaseDisplays the database that the Orchard Device Engine is using.
StatusDisplays the state of the interface such as Running or Not Running.
Start TimeDisplays the date and time that the interface was started. An interface may have one or more instruments, but this date/time is for the interface.
Troubleshooting Mode

Select the toggle on to enable troubleshooting mode. You must then select Save on the Device Engines page to turn on troubleshooting mode.

Turning on Troubleshooting Mode alerts the Orchard Device Engine to gather all the logs needed for troubleshooting purposes. When Troubleshooting Mode is enabled, you'll see the red text "Troubleshooting Mode Enabled" with a wrench icon next to the interface name.

Current Logging CategoriesDisplays the current logging categories enabled for the device engine, as reported by the Orchard Device Engine.
Orders Queue

This section lists information regarding orders and the interface.

  • Order Queue Size: Displays the number of orders queued in the interface.
  • Orders waiting to be sent to this interface: Displays the number of orders in the queue for the interface that have not been sent. 
  • Orders sent to this interface: This is an existing field that displays the number of orders sent to the interface.
  • Most recent time an order was received from the server for this interface: Displays the last time the device engine received an order for the interface.
  • Longest time an order has been waiting to be transmitted to this interface (milliseconds): Displays the maximum amount of time an order has waited to be transmitted to the interface.
Results Queue

This section lists information regarding results and the interface.

  • Results Queue Size: Displays the number of order results from the interface.
  • Results waiting to be sent to server: Displays the number of results waiting to be sent to the server from the interface.
  • Results sent to server: Displays the number of results sent to the server.
  • Most recent time a result was received from an instrument via this interface: Displays the last time the device engine received a result for the interface.
  • Longest time a result has been waiting to be transmitted from this device engine (milliseconds): Displays the maximum amount of time a result has waited to be transmitted to the server.

If an instrument is configured to use a Direct interface, the interface name and name of the instrument will be the same. If an instrument is configured to use a Middleware interface, there could be more than one instrument assigned to that interface.

For example:

Status:
Is Running: true
Start Time: 07/25/2017 09:54
Orders Queue:
Order Queue Size: 33
Orders waiting to be sent to this interface: 0 (Max Unprocessed Allowed: 1000)
Orders sent to this interface: 33 (Max Processed Allowed: 1000)
Most recent time an order was received from the server for this interface: 07/25/2017 09:55
Longest time an order has been waiting to be transmitted to this interface (milliseconds): None waiting to be transmitted
Results Queue:
Result Queue Size: 33
Results waiting to be sent to server: 0 (Max Unprocessed Allowed: 1000)
Results sent to server: 33 (Max Processed Allowed: 1000)
Most recent time a result was received from an instrument via this interface: 07/25/2017 09:55
Longest time a result has been waiting to be transmitted from this device engine (milliseconds): None waiting to be transmitted
Current Logging Categories: ERROR, HOST_COMMUNICATION, INFO, WARNING, COMMUNICATION, DEVICE_COMMUNICATION
Instrument(s):