handle to a HL7Connect Interface

Properties


Methods

string Name();
   Read-Only: Name of interface as shown in HL7Connect Status Page

string UniqueName();
   Read-Only: Unique Name of interface as shown in HL7Connect logs etc

int DBKey();
   ReadOnly: Name of

bool Started();
   ReadOnly: true if the interface is started. This means that the interface is trying to be operational but that it is waiting for the remote system

bool Connected();
   ReadOnly: true if the interface is fully operational

bool Sender();
   ReadOnly: true if the interface is a sender. alse if it is a receiver. (Cannot be both)

string CarrierType();
   ReadOnly: string description of the Transport layer. can be one of:
   TCP/IP
   File
   DLL
   HTTP
   Email

string StatusDesc();
   ReadOnly: The status description returned by the transport layer

void Start();
   Start the interface. There is no way to find whether the interface has started (this problem is under consideration)

void Stop(bool AllowRestart, string Code, string Description);
   Stop the interface. All scripts associated with the interface will need to stop before the interface actually stops. Do not wait for the interface to be stopped (i.e. Started = false) if you are in an interface script.

Some information about the stop must be provided. Is it ok for HL7Connect to restart the interface after the configured auto restart period? How should the stop reason be recorded? For Code, you can use one of these values: 'Script-Error', 'Kernel-Stop', 'Drop-Interface', 'Start-Failed', 'Synchronization-Failed', 'Unhandled-Error', 'Auto-Restart', 'Licence-Issue', or the reason is interpreted as 'Script-Request'

void Restart(string Code, string Description);
   Restart the interface. All scripts associated with the interface will need to stop before the interface actually stops. Do not wait for the interface this if you are in a interface script.

Some information about the restart must be provided. How should the restart reason be recorded? For Code, you can use one of these values: 'Script-Error', 'Kernel-Stop', 'Drop-Interface', 'Start-Failed', 'Synchronization-Failed', 'Unhandled-Error', 'Auto-Restart', 'Licence-Issue', or the reason is interpreted as 'Script-Request'

int SendFromQueue(string Name, string Partition, bool bLike);
   Take all the messages or documents currently waiting in the Virtual Queue "Name", with an optional partition, and send them to the interface. A blank partition means any messages. If partition is not blank, bLike specifies whether an exact match or an SQL like match is used. If bLike is true, the partition needs to contain the appropriate SQL wild cards (* or %)

The interface must be an outgoing interface with the same type as the queue. The messages or documents will be added to the sender interface queue, in the order they were added to the virtual queue. If a message/ocument is in the virtual queue more than once, it will be sent more than once. The messages/documents will be marked as handled in the Virtual Queue

Return the number of messages sent

Equivalent to IHL7ConnectVirtualQueue.SendToInterface

int MsgCount();
   ReadOnly: the number of messages processed OK by the interface

int ErrCount();
   ReadOnly: the number of AE's for the interface

int RejCount();
   ReadOnly: the number of AR's for the interface

int IntErrCount();
   ReadOnly: the number of internal transport errors for the interface

System.DateTime LastUse();
   ReadOnly: Date of last message

void LogError(string Error);
   Write an error to the interface. The error will appear in the intenral error section of the interface


© Kestral Computing P/L 2000 - 2003. HL7Connect v2.00-063 generated on 30-Nov 2015.
Keywords: Start, Sender, Interface, Name, Connected, CarrierType, DBKey, ErrCount, IntErrCount, LastUse, LogError, MsgCount, RejCount, Restart, SendFromQueue, Started, StatusDesc, Stop, UniqueName, HL7Connect.Kernel.Interface