Skip to main content

InterSystems Health Connect Cloud Reference Information

This section describes how to perform various activities that are part of the day-to-day operations of Health Connect Cloud, organized by page. Use the links in the Deployments section of the main menu in the Cloud Services Portal to navigate from page to page.

For a high-level overview of setting up Health Connect Cloud, see Introducing InterSystems Health Connect Cloud.

See Cloud Services Portal Reference InformationOpens in a new tab to read about common Cloud Services Portal functionality that is not specific to Health Connect Cloud:

Note:

Some of the functionality described in this section may not be available to all users, depending on their role on the development team. For more information, see Tenants PageOpens in a new tab.

Overview Page

The Overview page contains two sections, Deployment Details and Health Connect® Details (appears for High Availability configurations only).

View Deployment Details

In the Deployment Details section of the Overview page for your deployment, you can view the details of your deployment, including:

  • Deployment size

  • Number of cores

  • Amount of RAM

  • Deployment ID

  • Underlying InterSystems IRIS platform and version

  • Cloud provider and region

  • Creation and expiration dates

  • High Availability Status

  • Service Level and Service Level Urgency

View Health Connect® Details

The Health Connect® Details section of the Overview page displays the CIDR block for the private network used for this deployment. This may be useful for network configuration purposes.

If this is a High Availability configurations, you can also find the directory name to be used to share files across your High Availability mirror set. Interoperability Productions Opens in a new tab that need to store files on the file system should use this directory in order for them to be copied automatically to the backup server.

System Management Page

From the System Management page for your deployment, you can launch the Health Connect System Management Portal, which allows you to create and manage Interoperability Productions Opens in a new tab to connect systems that use different communication protocols and message formats. Use a username and password that you or a team member has created on the Connect Users page.

If you deployed a Message Bank server while deploying Health Connect Cloud, you can also launch its Management Portal using the same username and password.

If you do not see a production or Message Bank you recently created, you might need to log out of the Management Portal and log back in.

For complete information on using the System Management Portal, see the Health Connect documentation setOpens in a new tab. For information on the Message Bank feature, see Message Bank OverviewOpens in a new tab. Note that some Health Connect and Message Bank functionality is not available to Health Connect Cloud users, as these aspects of the service are managed for you by InterSystems.

Connect Users Page

You should create user accounts on the Connect Users page for anyone who needs to log into the System Management Portal. A list of existing users appears at the top of the page. The same username and password also can be used to access the Message Bank Management Portal, if you have deployed one. The System Management Portal and the Message Bank Management Portal can be launched from the System Management page.

To create a user :

  1. On the Connect Users page for your deployment, click Create User.

  2. On the Create User dialog, type a Username and Email, and click Create.

    The user now appears in the list of users. However the user must create a permanent password to be able to log in to the System Management Portal or the Message Bank Management Portal, as described in the following steps.

  3. Have the user check their email account for a temporary password. (The trailing period is not part of the password.)

  4. Have the user click the Password Management Page link, and log in with the usermane and temporary password.

  5. When prompted to change their password, the user should type a permanent password, confirm the password, and click Send.

    The user is redirected to the System Management Portal.

  6. Make sure the user can log in to the System Management Portal with their username and permanent password.

If you ever need to reset a user’s password, click the Password Management Page link, and then click Forgot Your Password? A reset password message will be sent to the user’s email address.

To remove a user’s access at any point, click the Delete User icon in the Actions column for that user.

Productions Page

The Productions page allows you to see all of the Interoperability ProductionsOpens in a new tab you have created and their current Production State (for example, Stopped or Running). In general terms, a production accepts messages from one or more external systems, transforms or processes the messages as required, and then sends them to one or more other external systems.

You can also use the Productions page to:

Create a Production

When you create an interoperability production, the Cloud Services Portal also creates a namespaceOpens in a new tab for the production, which includes a database for the code and data for that production. After creating a production, you can configure and manageOpens in a new tab it using the Management Portal. For information on launching the Management Portal, see System Management.

A Health Connect Cloud deployment also includes a namespace called REPO, which can be used to store code that is shared between all of your productions. If you need to create custom code and make it automatically available to all productions, add the code to the HCC packageOpens in a new tab in the REPO namespace. In InterSystems terminology, the code in the REPO namespace is mapped to each production namespaceOpens in a new tab by means of a concept known as a %ALL namespace. Custom code is not necessarily required to develop a production. For more information on developing productions, see the Health Connect documentation setOpens in a new tab.

If your Health Connect Cloud deployment was created with the High Availability configuration, the databases for your interoperability productions (as well as the REPO database) are automatically mirrored to the backup server.

If your Health Connect Cloud deployment was created with a Message Bank, all of the messages processed by each production, as well as any event log entries, are stored in the Default Message Bank. For details on creating additional Message Banks, see Create a Message Bank.

To create a production:

  1. On the Productions page, under Create Interoperability Production, type the desired name of your production.

  2. Click Create Production.

After you create a production, it shows up in the Productions list at the top of the page with a Production State of Stopped. When the creation process is finished, the Production State changes to Running. The Production Started column shows the time the production was started, in GMT. You may need to click Refresh to update the status.

Delete a Production

To delete an interoperability production:

  1. On the Productions page, click the Delete Production icon in the Actions column for that production.

  2. In the Delete Production dialog box, type Permanently Delete, and click Delete.

The production is removed from the Productions list at the top of the page.

SSL/TLS Configurations Page

Transport Layer Security (TLS) provides strong protection for communication between pairs of entities. It allows you to perform authentication, data integrity protection, and data encryption. TLS is the successor to the secure sockets layer (SSL).

Health Connect Cloud supports the ability to store an SSL/TLS configuration and specify an associated name. When you need a an SSL/TLS connection (for example, to connect to Health Connect Cloud via a TCP connection or a client application), you provide the applicable configuration name, and Health Connect Cloud automatically handles the connection.

The SSL/TLS Configurations page allows you to see all of the SSL/TLS Configurations you have created, whether they are enabled or not, and the type of each connection (Client or Server).

You can also use the SSL/TLS Configurations Page page to:

Create a SSL/TLS Configuration

To create a new SSL/TLS Configuration:

  1. On the SSL/TLS Configurations page, under Create SSL/TLS Configuration, type the desired name of your SSL/TLS Configuration.

    Only alphanumeric characters are allowed. No spaces or special characters.

  2. Type an optional Description.

  3. If desired, check Enabled to enable the configuration after creating it.

    You can enable or disable it later by editing the configuration.

  4. Choose a Type for the configuration.

    Client means that this configuration is for a client to connect to Health Connect Cloud.

    Server means that this configuration is for a server to which Health Connect Cloud will initiate a connection.

  5. Choose the desired Certificate Verification for this configuration.

    If this is a Client configuration:

    • None means that the server does not need to provide a certificate and the client performs no verification.

    • Required means that the server must provide a certificate and the client verifies the certificate with the Certificate Authority that issued the certificate.

    If this is a Server configuration:

    • None means that the client neither requires or requests a certificate.

    • Request means that the client may or may not provide a certificate and the server verifies the certificate only if provided.

    • Required means that the client must provide a certificate and the server verifies the certificate with the Certificate Authority that issued the certificate.

  6. Upload the file containing the trusted Certificate Authority certificate(s).

  7. Upload the file containing configuration certificate.

  8. Upload the file containing associated private key.

  9. Select the Private Key Type.

  10. Type the Private Key Password.

  11. Select the Minimum Protocol Version supported by this configuration.

  12. Select the Maximum Protocol Version supported by this configuration.

  13. If desired, edit the Enabled Cipherlist.

    The default set of cipher suites is:

    • ALL — Includes all cipher suites except the eNULL ciphers

    • !aNULL — Excludes ciphers that do not offer authentication

    • !eNULL — Excludes ciphers that do not offer encryption

    • !EXP — Excludes export-approved algorithms (both 40- and 56-bit)

    • !SSLv2 — Excludes SSL v2.0 cipher suites

  14. For Server configurations only, select the size of Diffie-Hellman key (if using).

  15. For Server configurations only, optionally enable and configure OSCP Stapling.

    OCSP (Online Certificate Status Protocol) is an internet protocol that checks the validity status of a certificate in real-time.

  16. Click Create Configuration.

For more information on the fields on this page, see About ConfigurationsOpens in a new tab.

After you create a configuration, it shows up in the SSL/TLS Configurations list at the top of the page.

Edit a SSL/TLS Configuration

To edit a SSL/TLS Configuration:

  1. On the SSL/TLS Configurations page, click the Edit Configuration icon in the Actions column for that SSL/TLS Configuration.

  2. In the dialog box, edit any of the fields, and click Submit.

See Create a SSL/TLS Configuration for information on each field.

Delete a SSL/TLS Configuration

To delete a SSL/TLS Configuration:

  1. On the SSL/TLS Configurations page, click the Delete Configuration icon in the Actions column for that SSL/TLS Configuration.

  2. In the Delete Configuration dialog box, type Permanently Delete, and click Delete.

The configuration is removed from the SSL/TLS Configurations list at the top of the page.

Message Banks Page

The Message Banks page allows you to see all of the Message BanksOpens in a new tab you have created and their current Production State (for example, Stopped or Running). In general terms, a Message Bank is a specialized kind of productionOpens in a new tab that archives messages, event log entries, and search table entries from multiple client productions.

You can also use the Message Banks page to:

Note:

The Message Banks link appears in the Deployments section of the main menu in the Cloud Services Portal only if your Health Connect Cloud deployment was created with the Message Bank option

Create a Message Bank

If your Health Connect Cloud deployment was created with the Message Bank option, all messages and other data processed by the connected productions are stored in the default Message Bank. This Message Bank has a namespaceOpens in a new tab of BANK.

To create a new Message Bank:

  1. On the Message Banks page, under Create Message Bank, type the desired name of your Message Bank.

  2. Click Create Message Bank.

After you create a production, it shows up in the Message Banks list at the top of the page with a Production State of Stopped. When the creation process is finished, the Production State changes to Running. The Production Started column shows the time the production was started, in GMT. You may need to click Refresh to update the status.

You can then launch the Management Portal for the Message Bank from the System Management page and connect your productions to the new Message Bank. For more details, see Configuring the Enterprise Message BankOpens in a new tab.

Delete a Message Bank

To delete a message bank:

  1. On the Message Banks page, click the Delete Message Bank icon in the Actions column for that Message Bank.

  2. In the Delete Message Bank dialog box, type Permanently Delete, and click Delete.

The Message Bank is removed from the Message Banks list at the top of the page.

Documentation

If you have any questions on how to use Health Connect Cloud, on the main menu, click Documentation.

For documentation on all of the InterSystems cloud services, click your name at the top right of the Cloud Services Portal, and then click Documentation.

If you would like to submit any feedback to help InterSystems improve any of the InterSystems cloud services, click your name at the top right of the Cloud Services Portal, and then click Submit Feedback. While we cannot respond to all feedback we receive, we welcome your opinion and will take it into consideration when determining future directions and enhancements.

FeedbackOpens in a new tab