Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Version#

Date

Modified By

Description of Modification

1.006/20/2017Sovann HuynhConverted from a design document into a full user manual
1.11/4/2018Tabassum JafriAdded Exchange Manager GUI
2.002/01/2018Sovann HuynhAdded Certificate Manager and Test Data Loader, deprecated Connection Manager
2.110/22/2018Tabassum JafriAdded Internal Endpoints properties section.
2.211/02/2018Tabassum JafriUpdated User Accounts and Cross-Gateway Query Client section.
2.304/09/2019Eric McDonaldText corrections on Import Wizard.

...

Account Management - User Accounts

Certificate Management

Certificate Management interface is for to simplify the process of creating new certificate and managing self-signed certificates, CA-issued SSL certificates within KeyStore and TrustStore. It is divided into three tabs - Manage KeyStore, Manage TrustStore and Import Wizard

Manage KeyStore

Selecting the default Manage KeyStore tab under Certificate Management displays the Manage KeyStore page that shows list of available Keystores from CONNECT configuration. For security purposes, users can only view certificates from KeyStore list.

...

Info
titleImport Wizard

While replacing the self-sign certificates with the CA certificates imported using Import Wizard, user must exercise caution and verify, before replacing, if they have imported the root, intermediate(s) and leaf certificates.  

Import Wizard interface partly automated the process of creating new certificate and importing CA certs into CONNECT configuration. It is divided into five tabs - Start, Create Certificate, Certificate Signing Request,CA Providers, Import SSL Certificate. Import Wizard functions as below:

  • Allow user to create new certificate 
  • Allow user to create Certificate Signing Request (CSR/PKCS10)
  • User must manually submit the CSR to their Certificate Authority (CA) to get a trusted certificate for their server
  • Allow user to import server Certificate (CSR Reply) and CA certificates (chain of trust)
  • Creates a backup of KeyStore and TrustStore under CONNECT configuration //importWizard/temp
  • Creates a new KeyStore and TrustStore for replacement under CONNECT configuration //importWizard/new
  • After successful Import Wizard process completion, the user must manually:
    • Replace CONNECT server configuration KeyStore and TrustStore  with the files under //importWizard/new
    • Restart the Server
    • Verify the AdminGUI functionality works and Manage KeyStore, Manage TrustStore list new certificate

...

Code Block
titleKeytool export and import certificate
#import ca certificate into admingui-truststore (only if the ca certificate need to be replace)
$ keytool -import -file caIntermediate.pem -keystore admingui-truststore.jks -alias gateway_intermediate 
$ keytool -import -file caRoot.pem -keystore admingui-truststore.jks -alias gateway_root

#if you are replacing the self-sign certificate it must be trusted by the gateway and admingui
$ keytool -v -export -rfc -keystore admingui-keystore.jks -alias gateway -file adminguiCert.pem
$ keytool -import -file adminguiCert.pem -keystore gateway-truststore.jks -alias admingui_gateway
$ keytool -import -file adminguiCert.pem -keystore admingui-truststore.jks -alias admingui_gateway

Anchor
Test Data LoaderTest Data LoaderTestDataLoader
TestDataLoader
Test Data Loader

Creating and managing test data for use with the CONNECT reference implementation can be handled directly through the Admin GUI. This feature manipulates data in the CONNECT database tables that were created as part of the initial CONNECT setup and deployment process. Future enhancements for converting and exporting the data for use in other test systems are under consideration.

...

Direct Configuration - Edit Domain -> Domain Name screen


Addresses

Edit the email addresses associated with the domain.

Direct Configuration - Edit Domain -> Addresses screen


Anchors

Anchors stored in the configuration service are added and maintained in the Anchors tab of the configuration service Edit Domain page.

...

FIELD

DESCRIPTION

General Settings
Refresh IntervalDuration used for scheduling the next run of Refresh Exchange process. Expressed in minutes.
Maximum No Of BackupsNumber of Backups, that the exchange refresh process is allowed to keep at a given time.
Default ExchangeA drop down that lists all the available exchanges for user. When selected, it will be used to look up services with a given HCID. If not defined, then the service are looked based on organization HCID only.
Exchanges
NameName of the Exchange
TypeExchange type is a mandatory element and can have three values only, LOCAL, UDDI, FHIR
URLUsed for downloading the web services endpoints.
Last UpdatedLast Updated displays the timestamp when the exchange was last refreshed
Refresh ExchangeA button that Enable/Disable an exchange for refresh.
Organizations
ExchangeSingle select drop-down that's lists all the exchanges configured in the Exchange Manager configuration file.

Organization

Single select drop-down that lists all the remote organizations or business entities, for a selected Exchange, configured in the Exchange Manager configuration file.

Selecting any business entity updates the business entity fields and the business service fields below to reflect the parameter values for the organization

Name

Organization Name as defined in the Exchange Manager configuration file for the selected Organization

Description

Organization description as configured in the Exchange Manager configuration file for the selected Organization

Contact

Contact name as configured in the Exchange Manager configuration file for the selected Organization

HCID

Home Community ID as defined in the Exchange Manager configuration file for the selected Organization

Service Information
Service NameBusiness service Name for the selected Organization
URLEndpoint for the web service
VersionVersion of the service provided
Ping Status

Default is --. Once ping initiated, values are Pass or Fail

If ping successful - Pass.

If ping is not successful - Fail

Last PingTimestamp for last ping for the web service

OPTION

DESCRIPTION

Ping Service

Selecting this option after selecting a particular service pings the service.

If the ping passed, Ping Status displays Pass

If the ping fails, Ping Status displays Fail. A fail could be indicative of some firewall issue, certificate set up issue or some other issue where in the remote service is down

Note

During the ping, a "Loading" status window is displayed as the service ping can take some time.  Do not try to alter anything on the page during this period or navigate to another page


Ping All ServicesClicking on Ping All Services, pings all services for a selected Exchange and Organization.

...