Version# | Date | Modified By | Description of Modification |
|---|---|---|---|
| 1.0 | 06/20/2017 | Sovann Huynh | Converted from a design document into a full user manual |
| 1.1 | 1/4/2018 | Tabassum Jafri | Added Exchange Manager GUI |
| 2.0 | 02/01/2018 | Sovann Huynh | Added Certificate Manager and Test Data Loader, deprecated Connection Manager |
| 2.1 | 10/22/2018 | Tabassum Jafri | Added Internal Endpoints properties section. |
| 2.2 | 11/02/2018 | Tabassum Jafri | Updated User Accounts and Cross-Gateway Query Client section. |
| 2.3 | 04/09/2019 | Eric McDonald | Text 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 | ||
|---|---|---|
| ||
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
...
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.
...
Exchange Management provides a way for user to view/edit Exchange information, refresh/download Exchange information and to view and manage connections to remote partners/gateways. The View Exchange Servcies Services screen as shown below is a view of the exchange information that are configured in the exchangeInfo file organized by the general exchange information and Organizations i.e., the remote gateway organization. This screen allows users to configure exchange refresh process, initiate Refresh Exchange, add/delete an Exchange, enable/disable Exchange and to provides a ping utility that pings a particular service/or all services to determine if the service(s) is up and running. This will help system administrators test service endpoints and troubleshoot firewall issues, certification validation issues and other connectivity both before functional testing with remote gateways and organizations and to investigate any issues that may arise in production due to changes in the local or exchange partner's gateway.
...
FIELD | DESCRIPTION | ||
|---|---|---|---|
| General Settings | |||
| Refresh Interval | Duration used for scheduling the next run of Refresh Exchange process. Expressed in minutes. | ||
| Maximum No Of Backups | Number of Backups, that the exchange refresh process is allowed to keep at a given time. | ||
| Default Exchange | A 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 | |||
| Name | Name of the Exchange | ||
| Type | Exchange type is a mandatory element and can have three values only, LOCAL, UDDI, FHIR | ||
| URL | Used for downloading the web services endpoints. | ||
| Last Updated | Last Updated displays the timestamp when the exchange was last refreshed | ||
| Refresh Exchange | A button that Enable/Disable an exchange for refresh. | ||
| Organizations | |||
| Exchange | Single 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 Name | Business service Name for the selected Organization | ||
| URL | Endpoint for the web service | ||
| Version | Version 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 Ping | Timestamp 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
| ||
| Ping All Services | Clicking on Ping All Services, pings all services for a selected Exchange and Organization. | ||
...