On this page:

14.1Getting Started

 

Assuming that users have already installed SmileCDR, the following steps describe how a customer can begin to use the App Management Tools.

  • Log in to the Smile CDR Web Admin Console (the administration UI for configuring the system)
  • Enter username and password

Login Page

On the landing page, "Config" will be visible on the header's navigation menu. The "Config" page enables users to configure storage modules, endpoints, security and other features as SmileCDR is divided into modules that are individually configured according to the needs of the deployment. The following steps describe how to add and configure the App Management Tools module:

  • Select "Config" from the landing page

Landing Page

  • On the “Config” page, under “Manage Node Modules”, select “App Management Tools” from the “Add Module of Type” drop-down list
  • Click “Add” at the right end corner of the selection bar

Afterward, you should see the App Management Tools module added to the list of modules in the Master node.

Config Page

The following page will open after clicking "Add" which allows the user to enter additional configurations under “App Management Tools” and “Dependencies” for authenticating and authorizing users of the module using OpenID Connect Authentication.

Create Module Page

The configurable fields include Logo URL for the location of the logo you’d like to show on the Admin Console. Smile CDR’s logo is a placeholder by default. Appropriate domain and context path should be used to configure the URLs. There are examples of the URLs for each field.

IMPORTANT NOTE:

The AUTH URL, FHIR URL, and JSON URL must match those used in the respective modules. Similarly, the Client ID name used in this section must match the name of the OpenID Connect Client that needs to be created, which is described later in this user guide. The names of each of the components can also be changed to suit your preferences. In addition, the parent page for the link provided for the PHI Warning URL can be found here.

In the Initial App Management Tools Seedingfield, the Attestation Title and HTML file for both the legal and plain version are already added by default for the first version.

In the Email Server Configs field, ensure the following configurations are made (detailed steps are available here) to enable developers to get notified if the status of their app changes, or if a new attestation version is created that requires them to re-attest:

  • Email From Address: (e.g., noreply@unknown.com)
  • Email SMTP Hostname: (e.g., localhost)
  • Email SMTP Port: (e.g., 25)
  • Email SMTP Username
  • Email SMTP Password
  • Use STARTTLS for connection security

Ensure that the necessary details are provided for the following fields as described below:

  • In the Listener Port field, enter an appropriate port number (e.g., 19300).
  • In the Context Path field, enter a name you’d like to use for the URL path (e.g., /app-gallery/).
  • Toggle Respect Forward Headers and CORS Enabled to Yes
  • Under the Dependencies section, select a SMART Outbound Security module, e.g., smart_auth (SMART Outbound Security), from the dropdown.

Module Dependencies

After entering the necessary details, click “Save” and the following page will appear with a confirmation for the module added. On the same page, you should see App Management Tools added to the list of modules in the Master node, under the Administrative Modules section in the menu pane on the left. It is recommended to “Restart” the module if any changes are made. A green checkmark icon indicates a correctly functioning module.

Module Created

The App Management Tools module can then be selected from the list of modules listed under “Manage Node Module” on the "Config" page to make changes in the configurations, save the changes made, and archive them.

Manage Node Modules

Module Controls

On the landing page of Smile CDR Web Admin Console, the “Config Diagnostics” page is also available in the drop-down list under “Config” on the header's navigation menu.

Config Diagnostics

The “Config Diagnostics” page provides a summary of warnings and errors in relation to the configurations made to set up the App Management Tools. A warning is meant to show configurations that would lead to an issue. An error shows issues caused as a result of incorrect configurations. The issue column provides recommendations on how the warnings or errors should be addressed (more information can be found here).

Errors and Warnings