Logging options for an interface allow for configuration of logs that can be used to diagnose problems with interfaces.

Accessing Interface Logging

New Interfaces

  1. Click on Administration in the HL7Connect navigation bar
  2. Choose the Interfaces tab
  3. Create a new interface
  4. Click on the Logging tab whilst editing the Interface configuration

Changing Interface Logging

  1. Click on Administration in the HL7Connect navigation bar
  2. Choose the Interfaces tab
  3. Select the interface for which you would like to change the logging configuration
  4. Click on the Configure button.
  5. Choose the Logging tab whilst editing the Interface configuration

Error Logging

HL7Connect tracks errors associated with interfaces. The error counts are shown on the status page for the interface until the service or interface, but the full details can only be seen in the error log.

Performance Tracking

If this is selected, HL7Connect will store a detailed log of how long it takes to process the message, with each step listed in ms. This is really only useful when benchmarking script execution, or troubleshooting message acknowledgement problems. The performance data is available when looking at in the Message/Document Browser.

Message Logging

Every interface created in HL7Connect will either send and receive HL7 messages/acknowledgements or send or receive CDA documents. These messages and acknowledgements can be logged to assist with troubleshooting and developing HL7Connect interfaces.

Depending on the interface mode (incoming or outgoing) and content type (v2 messages of CDA documents), you can specify what to capture during the receive/send process.

Local and Remote Document, Message and Response Logging

Incoming interface

Type    Description
Remote Message/Document Logging    Captures messages & documents received from a remote system by an incoming HL7Connect interface
Local Response Logging    Captures replies (HL7 acknowledgements) sent to the remote system by the incoming HL7Connect interface, acknowledging the message received (HL7 v2 messages only)

Outgoing Interface

Type    Description
Database    By default, HL7Connect discards responses from destination systems (they are usually very boring ACK messages). They can be logged using the Remote Response logging below, but this isn't always convenient. If this option is selected, HL7Connect will store the response messages received along with the message in the database, and they can be viewed through the Message/Document Browser
Local Message/Document Logging    Captures messages & documents sent to the remote system by the HL7Connect outgoing interface
Remote Response Logging    Captures replies (HL7 acknowledgements) received back to the HL7Connect outgoing interface by the remote receiving system, that acknowledge receipt of the messages sent by HL7Connect

Logging options

Type    Description
Logging Policy    Determines the type of logging policy applied to messages.
The following values are defined:
No Logging    No messages are logged (documents and messages)
Raw Message Log    Messages will be saved exactly as received, separated by standard Minimal Lower Layer Protocol (MLLP) delimiters. This format is widely supported by HL7 compliant programs. (messages only)
Cleaned Message Log    Messages presented in a format suitable for viewing in a text editor or a browser. (messages only)
Structured Message View
Verbose Message View
   For both formats, a structured analysis of the message is saved, with each message storing over 100k of text. Neither format can be recommended, unless unusual debugging is required. (messages only)
As Is    Documents logged as received (documents only)
Pretty    Documents formatted for viewing in a text viewer(documents only)
As Is    Documents with any extraneous white space removed (documents only)

Log File name    If a logging policy is chosen, a valid filename must be used. The file must reside on the server which contains HL7Connect. The log file name can include calculated Log file names
File Size Limit    in MB. Limits the size of the log file.

NOTE: Putting a value in this box is recommended to stop logs filling the available server disk space.

When File is Full   
Stop Logging Logging will stop once the file reaches the maximum size
Start Again The log will be cleared to start again
Rolling Log Oldest messages are deleted from the front of the logs to allow more logging (default)
Rename Old File The file will be renamed and a new one started. The new name will have a hexadecimal 4 digit number appended to the end of the name portion.


© Kestral Computing P/L 2000-2015. HL7Connect v2.00-063 generated on 30-Nov 2015