Applications
All devices and workflows belong to a single application. Users can have multiple applications as needed. Dashboards do not belong to an application since a single dashboard can contain graphs and blocks for several different applications.
Creating Applications
There are a few places within the platform from which an application can be created; or, applications can be created at any time using the main Applications
menu.
When creating an application, you will be asked for three pieces of information:
- Application Name: You are required to name your new application. The name can be changed at any time.
- Description: Optionally, you may also provide a more detailed description of the application.
- Owner: The application must be scoped to your personal Sandbox or to an organization for which you have the Editor role. The owner can be changed at a later date only if you have Administrator permissions for the parent organization (or Sandbox).
Deleting Applications
Applications can be deleted on the settings page. Deleting an application cannot be undone. All devices, device data, workflows, and device recipes owned by this application will be permanently removed.
Cloning an Application
You may clone an application - and the majority of the resources that fall beneath it - by visiting the “Clone” tab under the “Application Info” link in your application menu.
First, choose an owner for the new application. By default this is the organization or sandbox that currently owns the source application, but this can be changed to any other organization where you have administrator access (or your own sandbox).
Cloned applications are still subject to account resource limits, and you will be unable to clone an application if the result of the operation will cause any of your resources to go over their allowed limits.
The following will not be cloned into the new application:
- Access keys
- API tokens
- Events
- Device state data
- Experience domains and slugs
- Edge workflow deployments
The following will be cloned but in a disabled state:
All other application resources, archive configuration settings, and global values are cloned into the new application.
Depending on the size of your cloned application, it may take some time for the process to complete, in which case you will receive an email at the address of your choosing, configured in the dialog, when your new application is ready.
Application Log
The Application Log is a real-time log that displays information about various aspects of your WEGnology application. It’s most used for debugging purposes.
As a real-time tool, the Application Log always begins in an empty state. Logs appear as actions on your application take place. Logs show for the following events:
MQTT
- MQTT Authentication —When an MQTT client successfully connects or fails to connect to the WEGnology MQTT broker.
- Raw MQTT Messages —When MQTT Messages sent or received by the WEGnology MQTT broker will appear in the log.
Device
- Device State - When devices report state, a log will appear.
- Device Commands - When WEGnology sends a device command, a log will appear.
- Device Connection Status - When devices successfully connect or disconnect from WEGnology via the MQTT broker or the REST API, a log will appear.
Webhooks
- Webhooks - When a Webhook is triggered, a log will appear.
- Webhook Replies - When WEGnology replies to a Webhook, a log will appear.
Endpoints
- Endpoint - When a request is made to a WEGnology Experience Endpoint, a log will appear.
- Endpoint Reply - When WEGnology replies to an Experience Endpoint, a log will appear.
Integrations
- Integration Messages - When WEGnology receives a message from an Integration, a log will appear.
Application Search
To find resources quickly, you can search using one of two search bars. Your search results vary slightly depending on which search bar you choose. Clicking a result navigates you to its corresponding page.
Application Overview Search
The application overview search can be accessed on the application overview page. Click Overview in the application subnavigation on the left of any page. On clicking in the search bar, a dropdown menu appears with your search results.
In an empty state, the dropdown displays a list of quick links. Once you enter a search term, the dropdown updates and populates a list of all items in your application that match your search.
Subnavigation Search
The subnavigation search panel can be accessed from anywhere in an application on the left navigation panel.
In an empty state, the panel displays a list of the devices and workflows in that application that you have looked at most recently, as well as a list of quick links. Once you enter a search term, the panel populates a list of all items in your application that match your search.
Tip: The subnavigation search panel can be accessed by the keyboard shortcut Option (⌥) + L (if you’re using a Mac) or Alt + L (on Windows).
Application README
Every application includes a README, which is a tool to communicate implementation details between team members. Think of an application README as a concise synopsis of how your application works. The content of every application’s README differs depending on the application, however, every new application includes a default README with tips to get your writing started. READMEs are written in Markdown, which allows you to format the appearance of your file.
Application Globals
Application globals are a set of key/value pairs that are accessible inside of any workflow in the current application. This is a place to store application-wide configuration that is used across multiple workflows, like phone numbers or API keys. To view or manage your application globals:
- Navigate to the Settings section of your application.
- Click the Globals link.
You can add a new global by clicking the Add Global button. This creates a new global variable for which you must enter the following properties:
- Key—The property name under which the global can be accessed. Keys are required, and they may only contain uppercase and lowercase letters, numbers, underscores, and hyphens (-). Keys must also be unique across your other application globals.
- Type—Type of data stored within this global: String (default), Number, or JSON.
- Value—Value to return when this application global is invoked within a workflow. This field is required and the input must validate against the global’s chosen type.
- Description—Optional. Description for this global that informs other collaborators how the global functions.
- Do not send to edge / embedded workflows—By default, application global values are sent down to your edge compute devices through your edge workflows. They are also sent down to your embedded devices through your embedded workflows. If the global contains sensitive information that you would rather not deploy to a device in the field, check this box to disable this behavior.
Any values configured here are accessible under the globals
object in:
- The configuration for Integrations
- The configuration for Notebooks
- The configuration for Application Archiving
- The payload in a workflow run
- The default render context for an experience view
Application globals can be overridden in a workflow by defining a different value at the same key in the workflow globals for that specific workflow.