On this page:

14.6App Management Console

 

A private internal website for platform administrators to approve, suspend or revoke access to applications.

14.6.1Management Console: UI Description

 

Allow cookies

Below is a description of the UI for the App Management Console:

  1. Status Filters- Start here to register your first of many Apps or new App versions, using the App registration wizard.
  2. Version- Denotes whether an App is new (1) or has been denied registration before and is being resubmitted (2).
  3. Status- Displays the current state of the App on the system. Statuses range from:
    • In Review- Waiting for a decision from reviewers on registration.
    • Live- App is registered and approved to be on the app gallery and to access required scopes.
    • Rejected- An App is rejected when it does not meet the necessary requirements for approval. A rejection reason would be sent to the developer in this event.
    • Suspended- An App can be suspended by Admin if it is found to be in violation of the Terms and Conditions or Privacy Policy.
    • Retired- An App is automatically labeled as “Retired” after a new version is promoted to “Live” status.
  4. Attestation- Denotes whether or not a Developer accepted or declined attestation for their App.
  5. Line options- Shows the options for managing an App on the list.
  6. Modified- Shows the date of the last change made to the status of an App.

14.6.2Permissions

 

Assuming that users have already added the App Management Tools module to their node, users can select drop-down edit permissions for different features and tasks in the system.

  • 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, select “Config” from the header’s navigation menu
  • Select “User Manager” from the drop down list.

Landing page

On the "User Manager" page, you can manually add users or modify existing user permissions. To review and modify permissions:

  • Select "Modify" in the user line.

User Manager page

After selecting "Modify", the "Edit User" page opens which allows users to modify Demographics, Notes, Two Factor Authentication, Security, Default Launch Contexts, and Roles and Permissions. Permissions are to grant an individual the right to perform some functions. Roles are to grant a group of permissions associated with a logical role. In the Roles and Permissions section, more information about a given role or permission can be accessed by selecting the relevant ID.

Modify Roles and Permissions

  • Select "Save" at the top of the page after the required modifications are made. A confirmation message would be displayed for the newly made changes on the "User Manager" page.

14.6.3App review and management

 

Audit Log

The audit log tracks and displays all changes to the status of an App and any messages associated with the App.

To view the audit log of an App:

  • Select the options icon for the App.
  • Select audit log from the displayed drop down list or by clicking on the date under the Modified column

Audit Log

View Audit Log

Review

When a developer has registered an App, it appears in the Management Console as “In Review”. After the reviewer has vetted the App, they can make the decision to either “Reject” the App or allow the App to “Promote to Live”.

** IMPORTANT NOTE **

This release of App Management Tools does not validate developer contact information such as the email address and phone number. The app reviewer must contact the app developer via email or phone to verify that the contact information is accurate in the event legal actions need to be taken.

Reviewing an app

Changes to status are updated instantly. In the event an App is rejected, the reviewer is required to include the reason on the confirmation page. This reason will be relayed to the developer in the Developer Portal “Message’ section and the Management Console “Audit log”.

Rejecting an app registration

Management

It is recommended that Apps and their associated developers that have been promoted to live should be evaluated periodically to ensure they remain compliant with the Terms and Conditions, and Privacy Policy.

  • In the event that action needs to be taken on an App, the Admin can "Suspend" the App.

Suspend menu

  • When an Admin decides to "Suspend" an App, they are required to include a reason in the confirmation page for use in the review.

Suspending an app registration

  • An Admin can either “Reinstate” a "Suspended" App or change the status back to “In Review”.

Reinstate app

Managing Attestation Documents

Admin can manage attestation documents easily from the Management console in just a few steps.

  • Navigate to the "Settings" icon and select “Attestation Settings” from the dropdown.

Attestation Settings

Here an Admin can either create a new attestation document or select a version from the existing list to edit. When one of these options are selected, the Admin is taken to the Attestation text editor page from where the new document can be published.

Attestation Settings page

The attestation editor page is separated into 2 sections. The Legal Attestation section is displayed to developers in the Developer Portal during App registration. Whereas the Plain Language Explanation section is shown to end users of an App hosted on the App Gallery or when signing into the App for use.

Legal Attestation

Plain Language Explanation

** IMPORTANT NOTE **

When a change or new attestation is published the update can be instantly observed in the App Registration wizard on the Developer Portal.

14.6.4Additional Considerations

 

** IMPORTANT NOTE **

Google Chrome blocks third-party apps from sending cookies back to the server when using incognito window mode, which can have some unintended effects on the performance of Smile’s App Management Tools application.

To avoid this, please enable cookies manually by following the instructions below.

Step 1: Select the eye icon in the URL bar and the “site not working” link.

Google Chrome Incognito

Step 2: Select “Allow cookies".

Allow cookies