This method allows the application to specify the configuration settings for the toolkit.

Namespace: Mergecom.HL7
Assembly: Mergecom.HL7 (in Mergecom.HL7.dll) Version: 4.3.0.0

Syntax

C#
public static NameValueCollection Properties { get; set; }
Visual Basic
Public Shared Property Properties As NameValueCollection
	Get
	Set
Visual C++
public:
static property NameValueCollection^ Properties {
	NameValueCollection^ get ();
	void set (NameValueCollection^ value);
}

Field Value

The NameValueCollection object that holds the settings for the toolkit.

Remarks

The toolkit does not keep a local cache of the settings so changes to the values of the properties object after a call to this method may affect the toolkit's functionality.

If the application does not set the properties, the toolkit will try to load them from the HL7Toolkit.properties file located in the class path. If the HL7Toolkit.properties file can not be found or read the toolkit will use the default configuration values.

Additionally to the following list of settings any settings defined in HL7SocketConfiguration, HL7TransmitterConfiguration and HL7ReceiverConfiguration are recognized by the toolkit.

SettingDefault valueDescription
LAZY_SEGMENT_PARSINGyesControls whether the content of a segment is parsed when set (no) or only when required (yes)
LICENSE_KEYContains the toolkit's license key
DEFAULT_HL7_VERSIONControls the default version of segments and fields returned by the toolkit (231, 240, 250, 260)Contains the toolkit's license key
FILL_REQUIRED_COMPONENTSnoControls whether the toolkit adds missing required components in a field when encoding (yes/no)
ENCODE_EMPTY_FIELDSnoControls whether trailing empty fields are encoded in a segment (yes/no)
TRIM_FIELDS_ON_ENCODEyesControls whether trailing whitespace characters are removed from field values before encoding (yes/no)
LOG_DESTINATIONmergehl7.logSpecifies the log destination. The value is either the location of the log file or the word "CONSOLE" in which case the log destination is the system output (console).
LOG_ERRORSyesControls whether errors are logged by the toolkit. (yes/no)
LOG_WARNINGSnoControls whether warnings are logged by the toolkit. (yes/no)
TRACE_MAPPINGnoControls whether segment mapping trace messages are logged by the toolkit. (yes/no)
TRACE_SENDnoControls whether information about sent messages is logged by the toolkit. (yes/no)
TRACE_RECEIVEnoControls whether information about received messages is logged by the toolkit. (yes/no)
TRACE_CONNECTIONSnoControls whether information about network connections is logged by the toolkit. (yes/no)
TRACE_RAW_DATAnoControls whether the binary data sent or received is logged by the toolkit. (yes/no)
SEGMENT_[segmentName]Defines the private segment type [segmentName]. The value should be in the following format:

[fieldType1]:[fieldType2]:...:[fieldTypen]

where fieldTypeX is the HL7 data type of the field with sequence number X.

E.g. "SEGMENT_ZMY = SI:CX:CX:XAD:ST:ST:IS:CE" defines a segment named ZMY that has 8 fields of the specified type.

See Also