Skip to main content

Installing Health Connect

To install Health Connect, follow the instructions below, depending on your situation:

Important:

InterSystems strongly recommends that you review the pre-installation steps relevant for your operating system. See either Windows Pre-Installation or UNIX®, Linux, and macOS Pre-Installation.

Performing an Attended Installation

Running the Installer on Windows

To install a new instance of Health Connect on Windows, run the installer executable as an administrator.

Before installing make sure you have enabled Microsoft IIS or a different supported web server.

For detailed information on the options below, see the Windows Installation Guide.

The installation process will prompt you for some information:

  1. Choose an instance name for your installation (multiple instances can run on the same machine).

  2. Choose the folder for the installation.

  3. For the setup type, Development will be appropriate for most situations, especially if you are installing Health Connect for the first time.

  4. If you are automatically configuring IIS (InterSystems recommends this method), you will be prompted with “Local IIS web server detected.” Choose Configure local IIS web server for this instance.

  5. For Unicode support, select Unicode.

  6. For security type, InterSystems recommends that you select Normal for a development environment or Locked Down for a production environment.

  7. The InterSystems IRIS Service upon which Health Connect relies can run under a default SYSTEM (Windows Local System) account or under an existing Windows account. You will be prompted to choose a common password for the Health Connect administrator accounts (_SYSTEM, Admin, SuperUser, and the Windows account you chose, if any) on the next screen.

  8. You will be prompted to enter a password for the CSPSystem account.

  9. In the Ready to Install the Program dialog box, you have the option to enter your license key: click License to do so and follow the prompts. You can obtain a license key from your sales engineer.

  10. After that, click Install to complete the installation.

Running the Installer on Linux or macOS

To install a new instance of Health Connect on Linux or macOS, follow the instructions below.

Before installing make sure you have enabled Apache or a different supported web server.

For detailed information on the options below, see the UNIX®, Linux, and macOS Installation Guide.

  1. Extract the installation components from the provided tarball.

  2. Navigate to the directory where you extracted the components and run the command irisinstall with elevated privileges.

  3. Choose an instance name for your installation (multiple instances can run on the same machine).

  4. Enter the name of the directory where the installation will reside. If the directory does not exist yet, it will be created.

  5. For the installation type, Development will be appropriate for most situations, especially if you are installing Health Connect for the first time.

  6. For security settings, InterSystems recommends that you select Normal for a development environment or Locked Down for a production environment.

  7. At the prompt What user should be the owner of this instance?, enter the name of an existing user account.

  8. You will then be prompted to choose a password for the Health Connect administrator accounts upon which Health Connect relies (_SYSTEM, Admin, SuperUser, CSPSystem, and the user account you chose for owner).

  9. At the prompt What group should be allowed to start and stop this instance? enter the name of an existing group.

  10. Choose to install Unicode support.

  11. If you are automatically configuring the Apache web server, you will be asked if you would like to use the detected web server to connect to your installation. Enter y to allow automatic configuration.

  12. You can then choose to supply the full pathname for your license key, which you can obtain from your sales engineer.

  13. After that, your chosen options are displayed on the screen. You can confirm the installation simply by pressing Enter.

Performing an Unattended Installation

Health Connect can be installed in unattended mode.

Running an Unattended Installation on Windows

If you will run Health Connect on Windows, follow the instructions in Windows Unattended Installation. During that process, keep in mind the following considerations that are specific to Health Connect.

The minimum required set of parameters includes: instance name, a fully resolved physical pathname for the location of the installation, and the password for the SYSTEM (superadmin) account. The /qb switch is essential to running the installer in unattended mode.

The command line syntax for the minimum required set of parameters is: C:\> installation_executable.exe /instance instance_name /qb INSTALLDIR="install_directory" IRISUSERPASSWORD="password"

Important:

The unattended installer differs from the Health Connect unattended installer in that a few parameters work differently. See the table below.

Parameter or Switch Supported by Health Connect Notes
ADDLOCAL Y Optional. The default installation does not include the Web Gateway libraries for external web servers, such as IIS. To install those libraries within the Health Connect installation along with all other server components, add ADDLOCAL=ALL to the command line.
INITIALSECURITY N Defaults to “Normal”.
CLIENTINSTALL N  
ISCSTARTCACHE N/A  
UNICODE N Do not use this option. The installer will default to Unicode support as needed by Health Connect.
REPAIR N  
REINSTALL N  
REMOVE N  

Examples: Microsoft Windows Unattended Installation

C:\> installation_executable.exe /instance HSHCsilent /qb INSTALLDIR="D:\InterSystems\HSHCsilent" IRISUSERPASSWORD="password"

Installs all available components for Health Connect.

C:\> installation_executable.exe /instance HSHCclient /qb INSTALLDIR="D:\InterSystems\HSHCclient" CLIENTINSTALL=1

Installs only the client components listed in the table above. Some graphical progress indicators will be displayed.

Running an Unattended Installation on Linux or macOS

If you are running Health Connect on Linux or macOS, follow the instructions in UNIX®, Linux, and macOS Unattended Installation. During that process, keep in mind the following considerations that are specific to Health Connect.

The minimum required set of parameters includes: instance name, a fully resolved physical pathname for the location of the installation, the password for the _system (superadmin) account, and “normal” security settings.

The command line syntax for the minimum required set of parameters is: $ sudo ISC_PACKAGE_INSTANCENAME="instance_name" ISC_PACKAGE_INSTALLDIR="install_directory" ISC_PACKAGE_USER_PASSWORD="password" ISC_PACKAGE_INITIAL_SECURITY="Normal" ./irisinstall_silent.

Important:

The Health Connect unattended installer differs from the InterSystems IRIS unattended installer in that a few parameters work differently. See the table below.

Parameter or Switch Supported by Health Connect Notes
ISC_PACKAGE_INITIAL_SECURITY N Defaults to “Normal”.
ISC_PACKAGE_CLIENT_COMPONENTS N For a client-only installation, which includes components such as language bindings and SDKs and the InterSystems engine link libraries, use the irisinstall_client script.

For more information on installing client components only, see UNIX®, Linux, and macOS Client-only Installation

ISC_PACKAGE_STARTCACHE N/A  
ISC_PACKAGE_UNICODE N Do not use this option. The installer will default to Unicode support as needed by Health Connect.

Examples: Linux or macOS Unattended Installation

$ sudo ISC_PACKAGE_INSTANCENAME="HSHCsilent" ISC_PACKAGE_INSTALLDIR="/hs/HSHCsilent" ISC_PACKAGE_USER_PASSWORD="password" ISC_PACKAGE_SUPERSERVER_PORT="59992" ISC_PACKAGE_INITIAL_SECURITY="Normal" ./irisinstall_silent

Installs Health Connect in “normal” security mode with Superserver port 59992.

$ sudo ISC_PACKAGE_INSTANCENAME="HSHCsilent" ISC_PACKAGE_INSTALLDIR="/hs/HSHCsilent" ISC_PACKAGE_USER_PASSWORD="password" ISC_PACKAGE_INITIAL_SECURITY="Normal" ISC_PACKAGE_MGRUSER="hshcadmin1" ISC_PACKAGE_MGRGROUP="hshcadmin" ISC_PACKAGE_WEB_CONFIGURE="Y" ISC_PACKAGE_WEB_SERVERTYPE="Apache" ./irisinstall_silent

Installs all Health Connect modules; specifies the user and group who own the instance; configures the Web Gateway to work with an existing instance of Apache on the same host (installs Web Gateway libraries in /opt/gateway and adds Web Gateway configuration information to httpd.conf). Note that this configuration is appropriate only for a development instance of Health Connect, not for a production installation.

FeedbackOpens in a new tab