What Is a Module?
Estimated Reading Time: 4 minutes
Overview
Modules are the building blocks of your application. Unqork modules serve as a container for the rapid creation and management of business application data. In modules, Creators Also known as Unqork Users, or Designer Users; is anyone who is inside the Unqork platform. can add components to create the functionality needed for an application.
Here are some examples of what a module can do:
-
Display forms, questionnaires, dashboards, and more for 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..
-
Connect to APIs APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. to move data between software services and applications.
-
Perform complex mathematical calculations based on end-user input.
-
Update and manage stored data using SQL SQL (Structured Query Language) is language used in programming and designed for managing data contained in a relational database system.-like operators.
-
Set up triggers to automate application and submission processes.
Understanding Module Types
Unqork separates modules into three types: API, Front End, and Other-type modules. Each module type makes it easier to design them for a specific purpose.
Below is a description of each module type and the module settings enabled or disabled on creation:
| Module Type | Description | Default Settings |
|---|---|---|
|
API API |
An API-type module includes preconfigured components that meet Unqork API APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. specifications for server-side/remote execution. An API tag is also added by default to ensure your module displays in the API Docs Dashboard tool. When creating a module in a Workflow Task node positioned in the Automated swimlane, the API-type is selected by default. |
When creating an API module, the Server-Side Execution setting is set to (ON) by default, and disabled. Disabling this setting promotes security best practices. |
|
FE Front-End |
A Front-End-type module is a module element built for user interfaces. When creating a module in a workflow Task node positioned in an Authenticated swimlane, the Front-End-type is selected by default. |
When creating a Front-End module, the Server-Side Execution setting is set to (OFF) by default, and disabled. Disabling this setting ensures this module type is always accessible in Express View |
|
O Other |
An Other-type module is for module elements that are not considered Front-End or API modules. This module type includes modules used for storing data, rerouting data, and so on. |
When creating an Other-type module, the Server-Side Execution setting is set to (OFF) by default. With Other-type modules, you can choose to set the Server-Side Execution setting to (ON). |
Accessing a Module
UDesigner
Modules exist inside Applications, which are inside Workspaces. You can access a module from your UDesigner homepage or the All Workspaces page by clicking Workspaces at the top of the Unqork Designer Platform.
UDesigner Homepage
To access an existing module from your UDesigner homepage:
| 1. | Locate the module in your My Recents or Starred elements |
| 2. | Click View. |
Your module now opens in the Module Builder.
All Workspaces
To access an existing module from the All Workspaces page:
| 1. | At the top of your UDesigner homepage, click Workspaces. |
| 2. | From the Workspaces list, find and click the workspace name where the module exists, or click View Workspace. |
| 3. | From the Applications list, click the application name where the module exists, or click View App. |
| 4. | From the Application Elements list, click the module name, or click View. The module opens on a new page in the Module Builder. |
You can now select components to drag and drop onto the Module Builder canvas and configure them to create applications.
Previewing Your Module
You can easily preview Front-End modules as you build them. The Preview button opens your module 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.. Express View displays your application as your end-user 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. sees it. Ensure you save your module first, as unsaved changes don't display in the preview.
NOTE Your module must have at least one component to preview it.
To preview your module in Express View:
| 1. | Open your module in the Module Builder. |
| 2. | At the top right, click Preview. |
NOTE You might be asked to log into your environment again to view your module in Express View.
You can now use Express View to preview how your end-users views your applications and test and troubleshoot it.
TIP To learn how to create and edit a module, view our How to: Create a Module article.
You’ll also notice that your application's Express View URL is different than the Module Builder URL. In Express View, the URL includes an appended x. For example, while training-staging.unqork.io displays as the Module Builder URL, training-stagingx.unqork.io displays in Express View.
Module Builder:
Express View:
NOTE To learn more about previewing your application, visit the Application Introduction article.
Resources
