Workspaces: Working With Module-Type Apps
Estimated Reading Time: 3 minutes
Overview
When you access your application, this is the Application Level. This level is where you manage your modules in Workspaces. Modules are the building blocks for your applications. Let's take a look at how to work with your modules in Workspaces.
What You'll Learn
In this article, you’ll learn how to:
- Create a module.
- Navigate the module element's ellipsis menu.
- Share modules to workflow workspaces.
- Duplicate a module.
- Preview a module.
- Move a module.
- Delete a module.
NOTE To learn how to share modules, search Unqork Library: Elements in our In-Platform Help.
NOTE To learn how to promote apps and app elements, search Promoting Apps in our In-Platform Help.
Creating a Module
You can create modules in both module and workflow-type apps. To add a new module to your app, you need to open your app.
To create a module in your app:
1. | Click the + Create New button in the top-right corner of the page. The Create Module modal opens. |
2. | Enter a unique Module Name. |
3. | Select any Tags you want to add. This is optional. |
4. | Click Create. |
Navigating the Module Element's Ellipsis Menu
Most module management takes place within the app. When you click the ellipsis (...) on your module’s app element tile, a menu displays. Here are descriptions of the ellipsis menu options:
Option |
Description |
---|---|
Settings |
Lets you update the module's name, path, ID, and tags. |
Preview |
Lets you preview your module in Express View. |
Duplicate |
Creates a copy of the module. |
Move |
Moves the module to another application in your chosen workspace. |
Share to Library |
Lets you share your module with other workspaces or the entire environment. |
Delete |
Deletes the module. |
NOTE If this is a shared module, its ellipsis menu looks a little different. To learn more, search Unqork Library: Elements in our In-Platform Help.
Sharing Modules to a Workflow's Application
Typically you configure workflows to reference modules. For example, referencing modules with a Signal Start or Screen/Task node. To reference your module, it needs to exist in your workflow's application.
What if you want to reference a module that exists in a completely different app? You can share that module to your workflow 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:
1. | Find and open the application that contains your referenced module. |
2. | From the module element tile's ellipsis (...) menu, select Share to Library. |
3. | Select your workflow's workspace from the Share To column of the pop-up window. |
NOTE By default, the element automatically shares to the workspace in which it already exists. You can't clear this selection. You can only select other workspaces to which you want to share the element.
4. | Click Share. |
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. | Find the workflow-type application whose workflow references your shared module element. |
2. | To the left of the page, select the Modules tab. |
3. | Click the Library button in the top-right corner of the page. |
4. | Find your shared module element. |
5. | 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 starting point if you want your new module to have the same configuration as your existing module.
NOTE 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:
1. | Navigate to your app. |
2. | Click the ellipsis (...) on the element tile of the module you want to duplicate. |
3. | Click Duplicate. |
Previewing a Module
Previewing your modules as you build them can give you a glimpse of what your end-user sees.
To preview a module in Express View:
1. | Navigate to your app. |
2. | Click the ellipsis (...) on the element tile of the module you want to preview. |
3. | Click 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 app. To manage your moved module, navigate to the destination app. Click the Modules tab, and you'll find your module in its new home.
To move a module:
1. | Navigate to your app. |
2. | Click the ellipsis (...) on the element tile of the module you want to move. |
3. | Click Move. |
4. | Select the destination workspace from the Set Destination Workspace drop-down menu. |
5. | Select the destination app from the Set Destination App drop-down menu. |
6. | Click Move. |
NOTE Since entrypoint modules are tied to an application, they must stay in their original module-type app.
Deleting a Module
When a module is out-of-date or isn't needed any longer, you can delete it.
To delete a module:
1. | Navigate to your app. |
2. | Click the ellipsis (...) on the element tile of the module you want to delete. |
3. | Click Yes, Delete. |
NOTE 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 app.