Enabling a Logout Module
On the Environment Administration 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 drop-down. |
|
| 2.
|
Select Administration. |
|
| 3.
|
Under Environment, select Environment Administration. |
|
| 4.
|
Navigate to the General Settings section of Environment Administration. |
|
| 5.
|
Set Enable Custom Login/Logout Modules to  (checked). |
|
| 6.
|
At the bottom of the page, click Save Changes. |
Logout modules do not display in when you disable this setting. Disabling the custom logout module setting reverts all affected applications back to the default logout screen for the environment.
Creating a Logout Module
Create and connect a logout module during the application creation process. This method names the logout module and connects it to the new application for you.
To create and connect a logout module when creating a new application:
|
| 1.
|
Navigate to your workspace and click + Create App. |
|
| 2.
|
In the Create App pop-up , complete the required application information. |
|
| 3.
|
From the Logout Module drop-down, select FENew Logout Module. |
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.
From here, open the module and customize your logout screen. Here are a few ideas of components you can add to begin:
The Unqork Marketplace offers a Logout Moduletemplate if you need ideas for your logout page.
Connecting a Logout Module to an Application
On an existing application's App Settings page, you can connect a logout module.
To connect a logout module to your application:
|
| 1.
|
Navigate to your workspace and locate your application tile. |
|
| 2.
|
Click the ellipsis (···) menu. |
|
| 3.
|
Select  Settings. |
|
| 4.
|
From the Logout Module drop-down, enter or select a logout module. |
Creating a Logout Module Library Element
You can also create a logout module as a Library Element before connecting it to your application. By adding your module to the Library, you can share it to all your applications.
To create a logout module Library Element for your application:
|
| 1.
|
At the top right of the Unqork Designer Platform, click the drop-down. |
|
| 2.
|
Select Library Elements. |
|
| 4.
|
In the Module Name field, enter a name for your module. |
To easily locate your login module later, begin the module name with Login. For example, Login: Acme Corp.
Previewing a Logout Module
It's important to note that all modules you plan to have 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 must manipulate the browser URL to consider any redirects. The URL looks like the following: https://www.{your-environment}.io/app/{appPath}#/display/{moduleId}/{submissionId}/{moduleId}.
Disconnecting 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.
|
Select Settings. |
|
| 4.
|
From the Logout Module drop-down, click the X next to the logout module’s name. |
Columns
Button
