Logout Module

Estimated Reading Time:  5 minutes

Overview

The logout module is the last 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 after logging out of your application. On this screen, you might add a redirect back to the login page, a call to action button, or HTML links to other pages. You create this page in its own module during the application creation process. Or, connect it to your application later. The logout module is optional and not required for use with a login module.

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 logout setting and create, connect, and preview logout modules.

Enable or Disable the Logout Module Setting

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

To enable or disable the logout module setting:

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  Logout 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 logout module setting reverts all affected applications back to the default logout screen for the environment.

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

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

Create and Connect a Logout Module to a New Application

You can create and connect a logout module during the application creation process. This method names the logout module and connects it to your application.

To create and connect a logout 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 Logout Module.

A static image displaying the Create App modal, the Logout Module setting is selected and the New Logout Module option is highlighted.

4. Click Create.

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

Create and Connect a Logout Module to an Existing Application

You can create and connect a logout module to an existing application. This method names the logout module and connects it to your application.

To create and connect a logout 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 Logout Module drop-down, select FE New Logout Module.
5. Click Save.

Create a Logout Module

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

To create a logout 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 logout module later, start the module name with Logout. For example, Logout: Acme Corp.

5. Click Create.

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

NOTE  The Unqork Marketplace offers a Logout Module template if you need ideas for your logout page.

Previewing a Logout Module

It's important to note that all modules that you plan to navigate to using your logout 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 logout 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 Logout Module to Your Application

Now that you have a logout module, it's time to connect it to your application.

To connect a logout 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 Logout Module drop-down, select your Logout Module.

A static image displaying the Appl Details modal, the Logout Module drop-down is displayed and an existing logout module is highlighted.

5. Click Save.

Disconnect a Logout Module

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

To remove a logout 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 Logout Module drop-down, click the X next to the Logout Module’s name.

A static image displaying the App Details modal. The Logout Module field disconnect button is highlighted.

5. Click Save.

Resources