Online Help - Region 1: [CORE HL7 API Basic] |
Object: COREAPILicense
NOTE: No public entry point. Created only through a Controller object.
The COREAPILicense object is your access window into querying your CORE API License. This class also has many Static properties and methods for you to use without having to create an instance.
Most Common Programming Scenarios for the COREAPILicense object:
1) Using the Static methods to activate or retrieve a CORE HL7 API license. See the source code examples in Getting Started or the example program Activating a License for examples on how to do this.
2) Accessing the License property of a Controller object to verify that the actual license is valid. See the example code in the Getting Started - Testing Your License for examples on how to do this.
Static Properties and Methods:
Property Name |
Data Type |
ActivationRequest() |
string - Returns encoded information about the computer used by our web services to create CORE HL7 API Licenses. IMPORTANT: You will need to have this value to do a "Manual" activation of a Non-Demo (Commercial) API License using the License Manager software. Example (C#): string aReq = CoreAPILicense.ActivationRequest(CoreLicenseType.APIRuntime); |
ActivateAPILicense() |
COREExceptionEX - See example project Activating a License. |
ActivateAPIDemoLicense() |
COREExceptionEX - See example project Activating a License. |
GetMyAPIProducts() |
COREExceptionEX - See example project Activating a License. Retrieve a System.Data.DataTable account summary of your licenses. |
RetrieveAPIDemoLicense() |
COREExceptionEX - See example project Activating a License. |
SuggestedDemoLicenseFileTitle |
string (read only) Will be our suggestion of what you should name a CORE HL7 DEMO License file |
SuggestedLicenseFileTitle |
string (read only) Will be our suggestion of what you should name a CORE HL7 License file |
Public Properties:
Property Name |
Data Type |
ExceptionHandling |
Uses the Standard Exceptions Interface |
AllowTCPIPInbound |
bool (read only) |
AllowTCPIPOutbound |
bool (read only) |
CompanyName |
string (read only) - HermeTech Account Information for the license owner. |
Created |
datetime (read only) - When the license was created. |
CustomerID |
string (read only) - HermeTech Account Information for the license owner. |
CustomerAccount |
string (read only) - HermeTech Account Information for the license owner. |
CustomerContact |
string (read only) - HermeTech Account Information for the license owner. |
DemoKey |
string (read only) - For our internal use. |
Duration |
int (read only) Number of days a short term license is good for. |
Expired |
bool (read only) The license is flagged as expired see LicenseExpires. |
InboundPortCount |
int (read only) For our internal use. |
InstallationID |
string (read only) - For our internal use. |
IsDefaultLicense |
bool (read only) - If a license is created with an empty or invalid value we (internally) create what we call the "Default" license. IsValid will be false and Expired will be true. |
IsDemo |
bool (read only) |
OutboundPortCount |
int (read only) For our internal use. |
Your MAIN Validation Properties |
|
IsRunnable |
bool (read only) If true it means - IsValid == true, and Expired == false. |
IsRunnableForTCPIPInbound |
bool (read only) If true it means - IsRunnable == true, and the license can be used to receive inbound HL7 messages over TCP/IP |
IsRunnableForTCPIPOutbound |
bool (read only) If true it means - IsRunnable == true, and the license can be used to send HL7 messages over TCP/IP |
IsValid |
bool (read only) The license has been loaded with a syntactically correct CORE HL7 API license XML. CAVEAT: It will be false IF syntactically correct BUT LicensedMachineName is different from the Computer Name (Environment.MachineName). |
End MAIN Validation Properties |
|
LicensedMachineName |
string (read only) The name of the computer the license was created for. |
LicenseExpires |
datetime (read only) When a short term (IE DEMO) license will expire. |
LicenseID |
string (read only) - For our internal use. |
LicenseType |
Enum CORELicenseType |
LicenseTypeDescription |
string (read only) The string description of LicenseType |
ShortTermLicense |
bool (read only) The license was activated with a fixed term (IE DEMO licenses) |
ProductCode |
string (read only) Our product code associated with the license (See Architecture and Namespaces) |
ProductFamily |
string (read only) Our product family code. NOTE: Will be "API" |
ProductName |
string (read only) Our product name associated with the license. |
Public Methods:
Method |
Data Type |
ExceptionHandling |
Uses the Standard Exceptions Interface |
Refresh() |
bool takes a string parameter FileNameOrValue |
Report() |
string - Returns a Text license report |
SaveAs() |
bool takes a string parameter FileName |
XMLValue() |
string - the xml contents of your license. NOTE: will return "" if there is an exception (See LastException) |
