Edit

Install BizTalk Accelerator for HL7

  • Article

Hardware and software requirements

The minimum hardware and software requirements are the same as BizTalk Server.

BizTalk Server version BizTalk requirements SQL and OS requirements
BizTalk Server 2020 Hardware and Software Requirements for BizTalk Server 2020

SSDT for Visual Studio 2015 is a prerequisite for the HL7 Starter Project. During SSDT install, choose SQL Server Database and SQL Server Integration Services		 SQL Server hardware and software requirements:
SQL Server 2019
SQL Server 2016

Windows Server hardware requirements:
Windows Server 2019
Windows Server 2016
BizTalk Server 2016 Hardware and Software Requirements for BizTalk Server 2016 SQL Server hardware and software requirements:
SQL Server 2016
SQL Server 2014

Windows Server hardware requirements:
Windows Server 2016
Windows Server 2012
BizTalk Server 2013 R2

BizTalk Server 2013		 Hardware and Software Requirements for BizTalk Server 2013 and 2013 R2 SQL Server hardware and software requirements:
SQL Server 2014
SQL Server 2012
SQL Server 2008 R2

Windows Server hardware requirements:
Windows Server 2012
Windows Server 2008 R2

Tip

The hardware requirements listed are the minimum. Every environment is different and there's a very good chance that your environment may need more. See Recommendations for Installing, Sizing, Deploying, and Maintaining a BizTalk Server Solution

Install HL7

Before you begin

  • The HL7 accelerator install files are in BizTalk Server <version>\BizTalk Accelerators on the BizTalk Server ISO, download location, network share, or wherever you downloaded the BizTalk Server program.

  • The user installing and configuring BTAHL7 must be a member of the BizTalk Administrators group, and a member of the Administrators group on the SQL Server where the BTAHL7 data is stored.

  • The computer and signed-in user must have access to the primary domain controller (PDC). If the setup fails to access the PDC, then the installation fails, and won’t continue.

  • BizTalk Server should have the basic components installed and configured, including a 32-bit BizTalkServerApplication host with standard out of the box adapters, Enterprise Single Sign-on (SSO), the Group, and Runtime.

  • The default host should be configured as a FILE receive handler.

  • Read the installation known issues.

  • BTAHL7 is available in Enterprise and Standard Editions. The following table shows the compatibility between the different editions of BTAHL7 and BizTalk Server.

    BizTalk Server edition Compatible edition of BizTalk Accelerator for HL7
    Enterprise Edition Enterprise Edition
    Standard Edition Enterprise or Standard Edition
    Developer Edition Enterprise Edition

Default installation

  1. Run the BizTalk Accelerator for HL7 (A4HL7) setup.exe as Administrator.

    Tip

    Starting with BizTalk Server 2013 R2 and newer versions, the BTAHL7 installation includes a 32-bit installation package and a 64-bit installation package.

    On a 32-bit computer, install only the 32-bit package. On a 64-bit computer, install the 32-bit or 64-bit package. The 64-bit package enables the adapter and pipelines to run in both 32-bit and 64-bit mode.

  2. On the welcome page, select Next.

  3. Accept the License Agreement, and then select Next.

  4. Enter your user name and organization, and then select Next.

  5. Select the Typical setup, and then select Next.

  6. In the Logging Service Account page, update the textbox with correct groups that need logging permissions. Use domain\groupname format in a multi-server environment. The textbox is pre-populated with the following groups by default:

    • BizTalk Server Administrators
    • BizTalk Application Users
    • BizTalk Server B2B Operators
    • BizTalk Server Operators

    Select Next.

  7. Review the summary, and select Next.

  8. For the Destination Folder, select Next to use the default folder. Or, select Change to choose a different installation folder.

  9. In Logging Database Information, enter the following, and then select Next.

    Use this To do this
    Database Server Name The default value is the server name.

    Note The server name defaults to the name of the computer that the BizTalkMgmtDb database resides. You cannot change this value.
    HL7 Database name Enter the name of the database that contains the data for your BTAHL7 solution, or accept the default setting, which is BTAHL7.

    Note You must use the ANSI-ASCII character set per database requirements; BTAHL7 does not support other character sets.
    Test connection Select to confirm you have SQL Server connectivity.

    Note

    If the database selected already exists, then a message box appears. Select OK to continue.

  10. Select Install.

  11. Select Finish when completed.

    Tip

    Select Launch Tutorial to install the End-To-End Tutorial.

Custom installation

  1. Run the BizTalk Accelerator for HL7 (A4HL7) setup.exe as Administrator.

    Tip

    Starting with BizTalk Server 2013 R2 and newer versions, the BTAHL7 installation includes a 32-bit installation package and a 64-bit installation package.

    On a 32-bit computer, install only the 32-bit package. On a 64-bit computer, install the 32-bit or 64-bit package. The 64-bit package enables the adapter and pipelines to run in both 32-bit and 64-bit mode.

  2. On the welcome page, select Next.

  3. Accept the License Agreement, and then select Next.

  4. Enter your user name and password, and then select Next.

  5. Select Custom, and then select Next.

  6. Select the features that you want to install, and then select Next.

    Feature Sub-feature Description Typical Install Custom Install
    Engine Validates, processes, and routes messages.

    You must be a member of the BizTalk Server Administrators group to install this feature.    		 ✓ ✓
    Engine Engine Components Processes BTAHL7 flat file and XML-encoded messages. ✓ ✓
    Engine Outbound Batching Creates and routes BTAHL7 batch format documents. ✓ ✓
    Engine Pipelines Sample pipelines for building your BTAHL7 solution. ✓ ✓
    Adapter Utilities to enable end-point connections. ✓ ✓
    Adapter MLLP MLLP adapter to enable TCP/IP-based connections using BTAHL7 MLLP protocol. ✓ ✓
    Adapter MLLP Test Tool Test tool that emulates MLLP-based sending and receiving client applications over TCP/IP-based connections.
    Schemas Selection of HL7 V2.X flat file based XSD schemas. ✓ ✓
    Artifacts Tools for working with BizTalk Server artifacts. ✓
    Artifacts Orchestration A sample orchestration you can use to build your BTAHL7 solution. ✓
    Other Components Test Instances Sample/test data you can use as a starting point for your BTAHL7 solution.
    Other Components - Other components in BTAHL7. ✓ ✓
    Other Components Configuration Explorer Application you use to define your logging for data stores, configure party-specific validation, header mapping, batching, and acknowledgment requirements. ✓ ✓
    Other Components SDK Contains utilities for HL7 2.XML schemas, such as the components and artifacts needed for the End-to-End Tutorial and the MLLP utilities. ✓ ✓
    Other Components Logging Framework Components that support logging of BTAHL7 events. ✓ ✓
    Other Components Starter project Plug-in for Visual Studio that enables BTAHL7 project development. ✓ ✓

  7. In Logging Service Account, enter the following, and then select Next.

    Use this To do this
    Account name Enter the account name you want to use to start the Logging Service.
    Password Enter the password for this account.
    Domain Enter the domain name for this account.

  8. When prompted The account name has been granted logon as a service right, select OK.

  9. Review the summary, and select Next.

  10. For the Destination Folder, select Next to use the default folder. Or, select Change to choose a different installation folder.

  11. In Logging Database Information page, enter the following, and then select Next.

    Use this To do this
    Database Server name The default value is the server name.

    Note The server name defaults to the name of the computer that the BizTalkMgmtDb database resides. You cannot change this value.
    HL7 Database name Enter the name of the database that contains the data for your BTAHL7 solution, or accept the default setting; which is BTAHL7.

    Note You must use the ANSI-ASCII character set per database requirements; BTAHL7 does not support other character sets.

  12. Select Install.

  13. Select Finish when completed.

    Tip

    Select Launch Tutorial to install the End-To-End Tutorial.

Next steps

Step through some tutorials at Get started with the BizTalk Accelerator for HL7.