Interfaces

An interface is a standing message route. Find them under Interface Server → Interfaces.

The list

Each row is one route, with its running totals:

ColumnMeaning
StatusWhether the route is currently running
Source TypeWhere messages arrive from
ReceivedMessages that arrived
AcceptedMessages that parsed and validated successfully
RejectedMessages that could not be accepted — malformed, or failed validation
ProcessedMessages where every destination completed
Errored / FailedMessages where delivery did not complete

Accepted and Processed are different questions. Accepted means the message was understood;
Processed means it reached every destination. A route can accept everything and still fail to
deliver.

The Received and Failed figures are links — selecting one opens Messages filtered to
exactly those messages, which is the quickest route from "something is wrong" to the specific
messages involved.

Toggle Show Disabled and Show Deleted to include routes not currently in service.

Configuring an interface

Identity

FieldNotes
Interface InstanceThe engine process this route runs on. Instances are provisioned by Intely; you select from those available to you.
Interface NameHow the route appears in lists, messages and logs. Worth naming for the traffic, not the technology.
OrganizationThe organization the route belongs to.

Source

Every interface has exactly one source.

FieldNotes
Source NameA label for this source.
Source Typeintely File System to watch a directory, or TCP/IP to receive messages over a network connection.
Message FormatThe message standard — for example HL7 2.x.
HL7 VersionThe version to parse against, such as 2.5.
Disable Field Value ValidationTurns off checking of data types, formats and lengths. Useful when a partner sends technically non-conformant messages you still need to accept — but it means malformed values pass through rather than being rejected.
Normalize Line Endings (LF → CR)Converts line feeds to carriage returns. HL7 v2 expects CR segment terminators, and messages produced on Unix-like systems frequently arrive with LF. If a whole feed is rejected as unparseable, check this first.

When the source is the file system, you also set:

FieldNotes
Directory to ReadThe folder watched for incoming files.
File Name PatternWhich files to pick up, so unrelated files in the same folder are ignored.
After Processing ActionWhat happens to a file once handled — for example Move.
Move To DirectoryWhere handled files go.
Moved File Name PrefixAn optional prefix applied on the way.
On Error ActionWhat to do with a file that cannot be processed. Set this deliberately: it determines whether a bad file is retained for investigation or discarded.

Moving processed files out of the watched directory is what stops the same message being picked
up twice.

Destinations

An interface can have more than one destination, each listed with its Type, whether it is
Enabled, and when it was last changed. A destination of type intely Integration hands the
message to an integration, which is how a message becomes a transformation and an outbound API
call.

Each destination records its own outcome per message. Disabling one stops delivery to it without
affecting the others or the route itself.

Starting and stopping

An interface's status governs whether it is processing. Stopping a route leaves its
configuration and history intact — the usual move when a downstream system is unavailable and
you would rather hold messages at the source than accumulate failures.


Did this page help you?