Console UI Overview

The Console provides an easy-to-use, lightweight interface that allows end Users of the OS1 Platform to access Apps and Solutions developed by multiple developers. The User Interface (UI) of the Console (also known as the Console UI) features an App launcher that consolidates authorized Apps and Solutions in a single view and a persistent header that allows them to navigate between each App. This provides a simplified and consistent experience as Users onboard and access their Apps. Using the Console UI library, you can seamlessly integrate this experience with your application and eliminate the need for custom implementation of login, logout, and user navigation functionality.

For a quick start guide on integrating with the console, see Integrating with the Console.

Console UI Features

The Console provides a single sign-in where users are routed directly into their workspace from a URL that’s been created for their organization.

14401440

Console sign-in screen.

After sign-in, the Console provides a landing page that exposes the App Launch feature of the Console UI. Users are able to see all of their authorized Apps in a single view, grouped by solution.

14421442

Console UI App Launch that shows the apps to which the User has access.

From there, they are able to launch and navigate through each of their Apps. The Console’s header persists after the selected App opens. They can use the navigation menu accessible from the header to switch Apps. When the User switches Apps using the Console UI header, they don’t need to re-authenticate to access the new App.

19031903

Solution details screen in the Console.

The Console UI library also provides developers with the ability to customize the Console UI header by inserting App specific functionality in the form of a ‘widget.’ This could be a heading or text label, dropdown, search, button, or text edit. For information about choosing and populating the widget, see How to: Add a dropdown to the Console UI Header.

22642264

Dropdown widget example.

Integrating with the Console

To integrate an App with Console UI, you use the Console UI library. This is a Javascript library that is middleware designed to enable the features of the Console UI such as Authentication+Authorization, User metadata, and Deep linking to other Apps in your App.

For information on the steps necessary to integrate your App with the Console UI, see How to: Integrate your existing application with the Console UI library. After following the steps in the guide, your App will be compatible with the Console UI and it will provide you with a feel of how the App will look as your end-users start using it.


Did this page help you?