Creating a Module
You can create modules in both module and workflow-type applications.
To create a module at the Application level:
| 1.
|
Navigation to your application. |
| 1.
|
To the left of the Application page, select the Modules tab. |
| 2.
|
At the top right of the page, click + Create New. The Create Module displays. |
| 3.
|
In the Module Name* field, enter a unique name for your module. The Module Path* field populates using the Module Name value. |
| 4.
|
From the Module Type* drop-down, select API API, FE Front-End, or O Other. |
| 5.
|
(Optional) In the Module Description field, describe the purpose of the module. |
| 6.
|
(Optional) From the Tags drop-down, select any tags you want to add. |
Sharing a Module
Typically you configure workflows to reference modules. For example, referencing modules with a Signal Start or Task node. To reference your module, it needs to exist in a workflow-type application.
What if you want to reference a module that exists in a completely different application? You can share that module to your workflow-type application. To share a module to your workflow's workspace, you need to add it to the Library.
To add a module to the Library at the Application level:
| 1.
|
Locate and open the application that contains your referenced module. |
| 2.
|
On the module element tile, click the ··· (ellipsis) button. The Module's options menu displays. |
| 3.
|
Select Share to Library. |
| 4.
|
From the Set Element Access & Usage drop-down, select either Share to Select Workspaces or Share to Environment. |
Selecting Share to Environment will share the module to every workspace at that environment level.
| 5.
|
With Share to Select Workspaces selected, select your workflow's workspace from the Share To column. |
By default, the element automatically shares to the workspace in which it already exists. You cannot clear this selection. You can only select other workspaces to which you want to share the element.
Your module element is now shared to your workflow's workspace. Next, let's add it to the workflow's application.
To add a shared element to your workflow-type application:
| 1.
|
Locate the workflow-type application whose workflow references your shared module element. |
| 2.
|
To the left of the page, select the Modules tab. |
| 3.
|
At the top right, click (Library). |
| 4.
|
Locate your shared module element and click Add. |
The module that your workflow references is not a part of its application.
Duplicating a Module
At some point, you might want to make a copy of the current version of your module. This action is a great when you want your new module to have the same configuration as an existing module.
You can only duplicate unshared modules.
Module IDs and module paths are always unique. When duplicating a module, the new module’s ID and path are different from the original. Be mindful of any other configurations referencing the original module's ID or path. If you want to reference the duplicate module, you must update the configuration.
To duplicate a module at the Application level:
| 1.
|
Navigate to your application. |
| 2.
|
On the module element tile, click the ··· (ellipsis) button. The Module's options menu displays. |
| 3.
|
Select Duplicate. |
A new module element tile displays with a new module name and path.
Previewing a Module
Previewing your modules as you configure them gives you a glimpse of how your will view it.
To preview a module in at the Application level:
| 1.
|
Navigate to your application. |
| 2.
|
On the module element tile, click the ··· (ellipsis) button. The Module's options menu displays. |
| 3.
|
Select Preview. |
Moving a Module
You can move modules to other applications in your workspace. You can also move modules to applications in other workspaces shared with you. Once you move a module to an application, it becomes a part of that application. To manage your moved module, navigate to the destination application and select the. Click the
Modules tab. Then, locate your module in its new location.
To move a module at the Application level:
| 1.
|
Navigate to your application. |
| 2.
|
On the module element tile, click the ··· (ellipsis) button. The Module's options menu displays. |
| 3.
|
Select Move. The Move Element modal displays. |
| 4.
|
From the Set Destination Workspace* drop-down, select a destination workspace. |
| 5.
|
From the Set Destination App* drop-down, select a destination application. |
Entrypoint modules are tied to an application, so they must stay in their original module-type application.
Deleting a Module
When a module is out-of-date or is no longer needed, delete it.
To delete a module at the Application level:
| 1.
|
Navigate to your application. |
| 2.
|
On the module element tile, click the ··· (ellipsis) button. The Module's options menu displays. |
| 3.
|
Select Delete. |
If you try to delete an entrypoint module, you’ll receive an error message. To delete an entrypoint module, you must delete the entire module-type application.