TIE Installation Notes
TIE Installation Notes
1. What's in this package?
This package includes 2 main components, the TIE Service, and the TIE Development Environment.
The TIE Service Component includes the actual TIE Service, along with supporting documentation and a Database and Service Management Utility. The TIE Service can be installed on a cluster - see note #10 below.
The TIE Development Environment is a suite of tools to assist an interface developer or analyst. It allows you to collect, browse and validate HL7 messages and CDA documents, and to develop scripts for TIE.
You can install either component or both. Although there is no direct dependence between the packages, the Development Environment will require access to a TIE database when run and some functionality requires a TIE service to be available. The database, and the TIE Service Components that maintain it can be located on different systems.
In addition, this package includes a mobile device client component. This package includes programs that can be installed on your mobile phone to monitor and control TIE from anywhere as long as you have access to the TIE web interface. The following mobile phone clients are included:
Dot Net (use on any phone with mobile dot net installed)
iPhone (*** not yet released ***)
From the mobile phone client, you can do the following things:
view the status of interfaces
start and stop interfaces
enable users and fix their passwords
2. Known Issues with Data Execution Prevention
The Scripting and Web services implementations used in TIE generate dynamic machine code. This technique causes "data" to be executed, which is disallowed by Windows Data Execution Prevention.
If DEP applies to TIE, then any use of web services will cause an access violation, and any use of scripting will fail with an unpredictable error.
Because of this, the installation program will register TIE in the DEP exception list. A restart will be required to make this addition to the list effective, but the installation program will not prompt a restart at the end of the installation.
The DEP exception list is ignored if the system DEP policy is "Always on". The installation program will not check or change the System DEP policy - the system administrator will need to change this manually
3. System Requirements
a. TIE Certificate
During the installation, you will require a TIE Certificate. You can a get 30-day limited license (evaluation) Certificate or you can purchase a full license from http://www.tie.com. At the end of the 30 day, trial period TIE will cease to function until a Full Licence Certificate is purchased.
b. TIE Service
Installing the TIE Service will require the following resources:
Windows 7/10/Server 2003/Server 2008 through 2016 (32 or 64 bit)
Administrator Access to the System
A database server. See below for further information
Microsoft Script Engine (see below)
MSXML v4+ is required for schema validation (see below)
Interacting with the TIE service requires a web browser. This browser does not need to be installed on the same computer as the service.
TIE generally acts as a TCP server. If your windows system has a firewall (most do), you will have to add exemptions for any active ports (including the web and/or telnet servers built into TIE) you wish to use across the network - or you can let the install For some features (i.e. OID lookup), the TIE service requires HTTP access to the internet. If this access is not available, the service will still run, but these specific operations will fail. This web access does not use wininet, does not cache files or run scripts, and offers no other features capable of creating security holes.
c. TIE Development Environment
Microsoft Script Engine (see below)
MSXML v4+ is required for schema validation (see below)
The HL7Connect Development Environment will require read-only access to a TIE database when it runs.
d. Hardware Requirements
The hardware requirements for TIE will vary greatly depending on the throughput of messages, and the interface configuration. Disk storage depends on how many messages are received, and how long messages are stored in the database.
The minimum requirements for a small installation of TIE, with few interfaces and low message traffic, would be 512MB of RAM. As the scale on which TIE is being used increases, correspondingly so do it's hardware requirements. If TIE is being installed as an Enterprise HL7 Interface Engine, then the system should include the following specifications:
500MHz + CPU (at least two cpu's or dual core)
at least 2 GB RAM
There are a variety of factors which may influence how much hardware you may require. For example:
Expected message throughput? The busier TIE is, the more resources will be used
Number of interfaces
Will you be doing much scripting? If so, how complex are the scripts?
Does the database backend reside on the same server as TIE or a separate server? If it's on the same server, then the database resources need to be considered in addition to TIE resources.
A standard hospital with information flow rates of around 1 message or document per second should be able to run TIE on a standard entry-level server.
4. HL7 Software
TIE requires a source of HL7 v2 message definitions ("The HL7 Dictionary" in order to function. By default, TIE is based on the definitions as found in the HL7 Access Database.
If you want to replace these definitions with your own definitions (for instance, to introduce support for specific country localizations of HL7), you must purchase a copy of the access database directly from HL7 Inc. (http://www.hl7.org), make your modifications, and then configure TIE to use that modified database. Note that since TIE automatically supports unexpected messages, segments, fields, repeats, etc, such a modified dictionary is only useful for validation, or if scripts need to refer to modified definitions.
This installation package also installs the HL7 v2 schemas for use in validation, and for reference. These are the schemas as published by HL7. Issues with the content of the schemas should be referred to HL7.
5. Supported RDBMS platforms
TIE requires a database of its own. Currently, the following RDBMS Systems are supported as:
Microsoft SQL Server 2008r2 or better
MySQL v5.1 or better
There are no plans to add other database support at this time. Most databases - including all that have ODBC support - can be used from scripts.
Specific Platform Notes:
You must install SQL server drivers that correspond to your version of Microsoft SQL Server.
TIE can be configured to use Windows Authentication with Microsoft SQL Server. You need to pay attention to what account the service runs under if you set it up like this, and ensure that this account has access to the appropriate database. The installation program will always configure the service to run under the system default service account; you can change this through the Windows Services Applet.
Only version 5.1 is supported at this time. You can use the Community or Enterprise Edition.
We recommend the choice of "Multifunctional Database" mode and "Online Transaction Processing (OLTP)".
Note that the TIE database can grow rapidly when storing CDA documents and HL7 messages. When the messages store gets over 4 million records or so, performance starts to deteriorate quickly. This can be resolved by deleting or archiving messages. The impact of the total database size on backup and server load during backup also needs to be monitored. Note that archiving messages does not decrease the overall size of the database. System administrators should pay attention to messages archive and deletion policies, and carefully monitor the overall performance of the database using the RDBMS management facilities.
6. Database Access & Permission Requirements
TIE will require access to the database both during installation and whenever the software is running. All three software components (TIE, the TIE Manager, and the Development Environment) require database access. A database must be created by the administrator prior to installing TIE using the appropriate tools for either Microsoft SQL Server or MySQL.
When you connect to the database, you must provide a username and password that TIE will use during normal operation. This account must provide select/insert/update/delete access to the TIE database. dbo/sa/administrator type access is not required for this account. This password will be stored encrypted in the TIE Configuration files.
During the installation, TIE will connect to the specified database and create the required tables and indexes. During installation, a different username and password may be supplied. If none is supplied, the normal account described above will be used. The account used for installation must have administrator access, with DBO alias. The alternative account, if provided, is not stored by TIE.
Although the database should be entirely for the use of TIE, TIE can share databases with other applications. All TIE table names begin with the character sequence "gw..", "kk.." or "lex.."
TIE will not apply any permission settings to the databases created. If permission control is sought, this should be reviewed after installation (consult the TIE documentation for assistance with this process).
7. Web Browser Requirements
Interacting with TIE requires a Web Browser with full HTML 4 & DOM support. The following browsers have been tested and are believed to work:
Microsoft Internet Explorer and Microsoft Edge (all versions)
Browsers based on Mozilla/5.0 with Gecko/20031007+ such as Firefox
Browsers based on WebKit, inluding Chrome and Safari including on iPhone)
8. Microsoft Script Engine
The scripting engine used in TIE requires the Microsoft Scripting Engine to be installed. This is usually installed on most Windows systems.
If it is not installed, TIE will still run, but any attempt to run scripts will fail.
NOTE: Scripting has been known to behave bizarrely if a scripting version older than 5.6 is installed. It appears to be impossible to determine what version of Windows Script Host is installed. You may find the information here helpful: http://www.microsoft.com/downloads/details.aspx?displaylang=en&FamilyID=c717d943-7e4b-4622-86eb-95a22b832caa
9. Microsoft XML Core Services
TIE uses the Microsoft Core XML Services for XML Schema validation. If you use XML schema validation then you will require MSXML v4. If it is not installed, TIE will still run, but any attempt to use CDA documents, transforms, or schema validation will fail. You can download and install the Microsoft Core XML Services from http://msdn.microsoft.com/xml
Note: most computers have MSXML 4+ installed.
10. Windows Cluster Support
TIE can be installed on a Windows 2008 cluster. Before installing TIE, ensure that the cluster is fully installed and set up, and set up the database that TIE will use. TIE can use a database server either on the same cluster, or another server somewhere else that may also be (would usually be) a cluster.
In addition to the database, TIE requires a cluster storage. This storage is used for
LOINC and Snomed-CT caches
Temporary storage for file processing
In TIE, the location of logs and scripts is configurable; on a cluster, you must choose to store these on the cluster storage assigned to TIE when you are configuring it.
The base storage requirement - excluding logs and file processing requirements - is around 150MB. The overall size depends on configuration, how many log files and what their sizes are, and how many file interfaces, and how much information flows through them. Given the cost of setting up a cluster, and the importance of keeping TIE running, we recommend allocating at least 1GB more than the highest expected requirement.
b. Installing TIE
TIE must be installed on each node in the cluster. The first install is special: this "initial install" is responsible for creating or upgrading the TIE database and populating the TIE storage. All the following installs simply install the program files to each node and configure TIE to use the cluster storage. You must select the initial task in the installer ("Perform Initial Cluster Install" on the tasks page), or only a add-node install will be performed.
Note: if the task "Perform Initial Cluster Install" does not appear on the tasks page even though you are installing on a cluster, please consult TIE.com support.
The TIE Storage must be on line on the node where the install is happening for the initial install. For the add-node installs, the storage does not need to be on line. As additional nodes are added to the cluster, TIE must be installed on the node.
During the install, TIE will create a cluster application definition for TIE. This may fail for reasons related to network configuration. If it does, creating the TIE application definition is very straight forward. It is a Generic Service with the following properties:
The service "TIE"
The storage selected during the install
a virtual name and address.
The installation program will not bring TIE online at the end of the install. The cluster administrator will need to at least configure the details of the IP address assigned to TIE.
If you are installing TIE to run on the same Cluster as Microsoft SQL Server:
The installation configures the TIE service to run under the default account. On Windows Server, this is "Local System" or some equivalent. This local system account will be able to login to the SQL Server databases when both TIE and SQLServer are running on the same node, but not when they are on different nodes (assuming SQL Server is configured Active/Passive). If you want to be able to run TIE in a different node to SQLServer on the cluster, you will either need to configure SQL Server to used mixed-mode authentication, and give TIE a native SQL Server login when configuring the database connection, or configure the service to run under a different account using the Windows Services Applet.
c. Uninstalling TIE
Because of the way the installation process works, the node from which the first install was done must be the last to be uninstalled, as it will remove the contents of the TIE storage. If you need to uninstall TIE from this node before removing it from the cluster, do the uninstall while the storage is off-line.
d. Development Environment
The Development Environment is cluster aware - you can only use it on the node that is active for TIE. Be sure to store any files you work with on the TIE storage to avoid confusing the Development Environment as it moves between nodes.
e. Fail Over Notes
TIE starts and stops fairly quickly - generally within a few seconds. SQL Server tends to be a lot slower. If a node fails, and both SQL Server and TIE are transferred to a backup node,TIE must wait for the database. The standard approach to handling this - with service dependencies - isn't applicable. And cluster dependencies have additional side effects that mean that these might not be an appropriate solution to this problem. As a consequence, when the TIE service is starting on a cluster, it will wait up to 90 seconds for a database to be available, instead of 30 seconds like normal. Consult the TIE log too see why start up is slow.