Login Module

Estimated Reading Time:  5 minutes

Overview

The login module is the first page end-users End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product. see when logging in to your application. You can set up your login page to verify end-user credentials or use an SSO (single sign-on) authentication service. You can create this page in its own module during the application creation process. Or, you can connect it to your application later. The login module is optional and not required to build your application in the Unqork Designer Platform.

WARNING  Login and Logout modules are only available when viewing at the Application level.

What You’ll Learn

In this article, you'll learn how to enable the login setting and create, connect, and preview login modules.

Enable or Disable the Login Module Setting

On the Environment Administrations page, you can enable custom login modules based on application needs. Enable the setting to connect or disconnect login modules to applications. Disable the setting to prevent login modules from being connected or disconnected from applications.

To enable an existing login module:

1. At the top right of the Unqork Designer Platform, click the Settings ▾ drop-down.
2. Click Administration.
3. Under Environment, select Environment Administration.
4. Navigate to the General settings section of Environment Administration.
5. Select the Enable Custom Login/Logout Modules checkbox.
6. At the bottom of the page, click Save Changes.

NOTE  Login modules do not display in Express View Express View is how your end-user views you application. Express View also lets you preview your applications to test your configuration and view the styling. This is also the view your end-users will see when interacting with your application. After configuring a module, click Preview in the Module Builder to interact with the module in Express View. when you disable this setting. Disabling the custom login module setting reverts all affected applications back to the default login screen for the environment.

Create and Connect a Login Module to a New or Existing Application

In your application's workspace, you can create and connect a new login module to a new or existing application.

Create and Connect a Login Module to a New Application

Create and connect a login module during the application creation process. This method names the login module and connects it to the new application for you.

To create and connect a login module when creating a new application:

1. Navigate to your workspace and click the + Create App button.
2. In the Create App pop-up modal A modal is a window that appears on top of the content you are currently viewing., complete the required application information.
3. From the Login Module drop-down, select FE New Login Module.

A static image displaying the Create App modal. The Login Module drop-down is displayed and the New Login Module is highlighted.

4. Click Create.

NOTE  Login modules created in the Create App pop-up modal are named after the application and end with the text "Login". For example, Acme Corp Login.

Create and Connect a Login Module to an Existing Application

On an existing application's App Settings page, you can create and connect a login module. This method names the login module and connects it to your application.

To create and connect a login module to your application:

1. Navigate to your workspace and locate your application tile.
2. Click the ellipsis (···) menu.
3. Click Settings Icon Settings.
4. From the Login Module drop-down, select FE New Login Module.
5. Click Save.

Create a Login Module

You'll need to create a login module before connecting it to your application. The best way to do this is to add your login module to the Library. By adding your module to the library, you can share it throughout your applications in the environment.

To create a login module for your application:

1. At the top right of the Unqork Designer Platform, click the Settings ▾ menu button,
2. Select Library Elements.
3. Click + Create New.
4. In the Module Name field, enter a name for your module.

NOTE  To easily find your login module later, start the module name with Login. For example, Login: Acme Corp.

5. Click Create.

From here, you can open the module and customize your login screen. Here are a few components you can add to get started:

NOTE  The Unqork Marketplace offers a Login Module template containing everything you need to set up a login page.

Previewing a Login Module

It's important to note that all modules that you plan to navigate to using your login module must exist in the same application. Otherwise, you'll receive a 403 error. The following image shows you how to preview a module at the application level:

To successfully preview your login module, you must preview it at the application level. Otherwise, you need to manipulate the browser URL to consider any redirects. The URL looks something like the following: https://www.{your-environment}.io/app/{appPath}#/display/{moduleId}/{submissionId}/{moduleId}.

Connect an Existing Login Module to Your Application

Now that you have a login module, connect it to your application.

To connect a login module to your application:

1. Navigate to your workspace and locate your application tile.
2. Click the ellipsis (···) menu.
3. Click Settings Icon Settings.
4. From the Login Module drop-down, select your Login Module.

A static image displaying the App Details modal. The Login Module drop-down is displayed and the existing login module is highlighted.

5. Click Save.

Disconnect a Login Module

If you decide you don’t want a login module in your application anymore, you can remove it.

To remove a login module from an application:

1. Navigate to your workspace and locate your application.
2. Click the ellipsis (···) menu.
3. Click Settings Icon Settings.
4. From the Login Module drop-down, click the X next to the Login Module’s name.

A static image displaying the App Details modal, the Login Module field disconnect button is highlighted.

5. Click Save.

Resources