Tags are used in Unqork to organize and group modules or components based on their function. There are two types of tags you can use when building in Unqork: module tags and field tags. The tags you use and how you use them enable you to take advantage of Unqork tools or target multiple components at once using logic components.
Module Tags
Module tags highlight the function of a specific module. Using module tags lets everyone with access to an application view which modules are used for APIs, schemas, or other functions. Even if a team member is unfamiliar with that module, tags can provide them with context and help improve application maintenance.
In addition to following application maintenance best practices, module tags are also used to add modules to certain UDLC Tools. Adding the api tag to a module connects it to the API Docs Dashboard tool, while the schema tag makes that module available to view in the Schema Docs Dashboard tool.
Accessing Module Tags in the Module Builder
To add a tag to a module, enter the desired tag in the Tag field when creating a module. If you select the API Module Type, the api tag is added automatically. Module tags can be viewed or edited from either the Module or Application page.
To view and edit a module tag from the Module Builder:
Open your module in the Module Builder.
At the top right of the Module Builder, click the
(ellipsis).Select Module Settings.
In the Tags field, view or edit the available tags.
Click Save & Close.
Accessing Module Tags in an Application
To access module tags from the Application page:
On the application page, locate your module.
At the top right of the page, click the
(ellipsis).Select Settings.
In the Tags field, view or edit the available tags.
Click Save & Close.
Extension Tags
Modules can also be converted into an extension module using the extension tag. Extension modules display in the Extensions drawer for all Creators in the environment.
RBAC for Extensions is not supported at this time.
The size of an Extension’s modal can be controlled by adding a size tag to the module. For example, to create a medium-sized Extension modal, you can assign the module the extension and size:-medium tags.
The available size options include:
size:-smallsize:-mediumsize:-largesize:-xlarge
Component Field Tags
Every Unqork component has a Field Tags setting. Field tags are commonly used in API modules to organize Hidden components containing parameters by data type. In addition to organizing and grouping components, field tags let you target grouped fields using logic components.
Using Field Tags in API Modules
When building an API module, it’s a best practice to set the data type for each parameter using field tags. The component comes preset with all available tags. Delete all tags that you do not want to apply.
The available tags are:
type:string: If the data type is an alphanumeric string.type:number: If the data type is an integer or a floating-point number.type:boolean: If the data type is Boolean (true or false).type:array-string: If the data structure is an array containing a string data type.type:array-boolean: If the data structure is an array containing a Boolean (true or false) data type.type:array-number: If the data structure is an array containing an integer or a floating-point number data type.type:object: If the data structure is an object.type:ObjectId: If the data is a MongoDB unique identifier.The
type:arraytag is the same as thetype:array-stringtag.
Using Field Tags in Logic Components
Field tags can be added to logic components to affect all components with that tag simultaneously. Doing so lets you apply logic to several components without listing each one individually in the logic component.
To use field tags with logic components, add the desired field tag to each component. In your logic component, add the field tag to the Property ID column of the Outputs table. The logic function set in the component now outputs to all components with that tag.