Online Help - Region 1: [CORE HL7 API Basic] |
The Master Controlling Class
Object: HL7Controller
Derived Sub-Classes
In your code you will create the HL7Controller object (or any of the derived sub-classes) and pass it a single string parameter LicenseFilePathOrValue. This parameter can be either the full path/file name of a file containing a CORE API License OR it can be the actual string (xml) value that makes up a CORE API License. This means that you can store your CORE API License(s) in a database and retrieve them from there if you wish and use them to activate your HL7Controller objects. You can review Getting Started for how to create a CORE API License for your computer / server. If you need to purchase CORE API Licenses you can do so through our website or contact customer service.
Public Properties and Methods (related to the License):
Property Name |
Data Type |
ExceptionHandling |
Uses the Standard Exceptions Interface |
License |
COREAPILicense (read only) |
LicenseIsExpired |
bool (read only) |
LicenseIsValid |
bool (read only) |
LicenseIsRunnable |
bool (read only) |
LicenseIsRunnableForTCPIPInbound |
bool (read only) Can the license be used to receive messages over TCP/IP |
LicenseIsRunnableForTCPIPOutbound |
bool (read only) Can the license be used to send messages over TCP/IP |
LicenseReport() |
string - Returns a Text license report |
RefreshLicense() |
bool takes a string parameter (see the example code above) |
Public Properties:
Property Name |
Data Type |
ExceptionHandling |
Uses the Standard Exceptions Interface |
BOM |
|
ComponentDelimiter |
|
EOM |
|
EncodingCharacters |
string (read only) returns the 4 primary encoding characters |
EscapeDelimiter |
|
FieldDelimiter |
|
RepeatDelimiter |
|
SOM |
|
SubComponentDelimiter |
|
License |
COREAPILicense (read only) |
Tag |
|
Utilities |
COREUtilities (read only) |
Method |
Return Value |
ExceptionHandling |
Uses the Standard Exceptions Interface |
GetLicenseReader() |
COREAPILicense - Loads a CORE HL7 API license object outside of the controllers License property |
NewFileAnalyzer() |
|
NewHL7Message() |
|
NewMessageControlID() |
string See Message Control ID |
NewStringAnalyzer() |
|
NewVendorDefinition() |
|
HL7Encoder() |