Additional Resources

Console UI Overview

15min

About Console UI

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 a persistent and customizable header that allows them to navigate between each App, raise support requests, and manage user preferences. This provides a simplified and consistent experience as Users onboard and accesses their Apps.

OS1 Developers can provide this seamless experience to their end-users by integrating their apps and solutions with the Console UI, eliminating the need for custom implementation of login, logout, user navigation functionality, and preference management. Learn more on how developers can integrate their apps with the Console using Integrating with Console How-to Guide.

Console UI Features

Login

The Console provides a single sign-in where users are routed directly into their solution from a URL that’s been created for their organization. Users do not have to sign in again when navigating between apps.

Social Login

OS1 platform has the social login enabled that allows users to access OS1 applications seamlessly using your existing Google or Microsoft accounts. This feature simplifies the login process by removing the need for multiple passwords or OTPs, enhancing overall login experience for your tenants/customers. 

Key features include:

  • Enabled by Default: Social login options are available for all tenants without any additional setup.
  • Works with Email and Mobile Logins: Your customers can continue to use login with Google or Microsoft  along with email and mobile OTP-based logins.
  • Same Login Experience Everywhere: You have a consistent and simple login process across all OS1 applications, including DispatchOne, which improves your workflow and efficiency.
  • Customize Login Settings: As an admin, you can easily enable or disable social login options to fit your business needs.

Using Social Login

Social login is enabled by default for all tenants, allowing you to access OS1 applications using your existing Google or Microsoft accounts.

Default login

  1. Navigate to the OS1 sign-in page via <https:www.tenant/orgname.getos1.com>
Document image


2. Both Sign in with Google and Sign in with Microsoft options are available by default.

3. Upon selecting a social login option, you are redirected to the respective authentication page.

4. You enter your credentials on the chosen provider's page.

5. You’ll be redirected to your OS1 dashboard after logging in if you are an authorized user.

Note: If you are not an authorized user, an error message stating “not a registered user” appears, along with options to retry or return to the login page.

Configure default login options

You can enable or disable the default login options in the Console UI settings if you have admin access. To customize the settings, follow the below steps:

  1. Sign in to the OS1 platform.
Document image


2. Go to the Console navigation bar and click Settings.

Document image


3. Find Sign-In Settings under the System Apps section. Note that you’ll need business owner privileges to make changes.

Document image


4. Click Edit Settings to modify the login page settings.

Document image


5. Uncheck any sign-in options you want to disable, and make sure at least one method remains active. 

Document image


6. Review your selections and click Save Changes to apply the updates.

7. After saving, look for a confirmation message. Log out and return to the sign-in screen to ensure the login options reflect your changes.

Limitation

Administrative Privileges Required: Only admins with business owner privileges can modify login settings.

App Navigation

Customers can leverage the side navigation menu from the Console header to switch between apps. They also have the option to choose if the app should open in a new tab or the same window.

Document image


Customizing App Navigation

End users can choose what happens when they click on an app in the Console side navigation menu. When they open an app for the first time, they will be asked if they would like to open it in a new tab or the current window. This setting can be saved and changed in App Navigation Preference under User Preferences in their profile drop-down.

Document image


Customizable Header

Developers can customize the Console UI header by adding different types of controls including a textbox, search box, auto-complete, and more. This allows developers to tailor the header controls to suit the specific needs of their application. For detailed instructions on customizing your header, refer to the Integration with Console UI guide.

Document image


Contact US page

We provide a text area for users to describe their issues in detail and an option to upload screenshots to help clarify their concerns. Upon submission, a ticket is automatically created to track the support request.

  • A text area describing the user's issues in detail
  • An option to upload a screenshot that may help clarify a user's issue.

This will then create a ticket to track the support request.

Document image


Timezone Settings

Initially, the time zone is set to the end user’s preferences and they can personalize it as needed. The updated timezone is stored in the browser’s local storage for future sessions.

Document image


Integrating with Console

Developers can use the Console UI SDK to integrate Console UI into their applications.

The integration facilitates authentication, authorization, and seamless navigation for app users. For step-by-step instructions on integrating with the Console UI, refer to the How to: Integrate your application with the Console UI.