For the complete documentation index, see llms.txt. This page is also available as Markdown.

Developer - My plugins

Aranet Cloud Plugin functionality

Aranet Cloud provides plugin functionality to integrate external data and functionality into the Aranet Cloud product. Plugin development for Aranet Cloud allows users to extend functionality and integrate custom solutions tailored to their specific needs. Developers can create seamless integrations to enhance system capabilities.

Plugin availability:

Plugins are available only in Workspaces that use an active Basic or Pro license. As the Trial workspaces (30-day evaluation) include Pro-tier access, the Plugins are also supported by the Trial version.

Developer menu

Plugins can be created and managed via the Developer menu in the Aranet Cloud UI sidebar:

The developer menu is visible only to Workspace administrators, and it can be enabled/disabled from the Workspace configuration screen.

In the Developer menu following options are available:

  1. See plugin statuses (In Development, Published or Archived) as well as their versions.

  2. Delete the plugin

  3. Add the plugin to a dashboard

  4. Edit an existing plugin (only if the version is still in development)

  5. Create a new plugin

Each plugin is marked with a label that indicates whether it is a Workspace type plugin or Cloud type plugin.

Plugin creation and editing process

When you want to start creating a plugin, you should press the "NEW PLUGIN" button, and you will see this window pop-up:

Information entered in the creation form (e.g., Plugin ID, type) cannot be changed later and is carried forward into all plugin versions.

Cloud Plugins can exist in two different scopes: Workspace (private to one workspace) and Cloud Public (available to all workspaces). These scopes affect how plugins are managed, reviewed, and made accessible across the platform. Workspace plugins allow internal testing, rapid iteration, and custom functionality within a single workspace, while Cloud Public plugins are intended for broader reuse and must meet higher quality and consistency requirements.

Plugin development begins within the Developer menu, where Workspace administrators can create new plugins using a structured plugin creation and editing form. This form collects essential metadata, configuration options, and plugin files (including index.html and setup.html) and includes the following fields:

1. Plugin name.

2. Description.

3. Versions - Once a plugin version is created, it cannot be deleted, regardless of its status (In Development, Archived, or Published). A plugin version is created when the developer clicks "New Version", the new version is a copy of the previous one, including metadata and files. Each version has its own status: In Development, Published or Archived.

4. Support person's e-mail - Used in case the plugin stops working

5. Developer - Who is developing the plugin

6. Pictures - The background image of the widget can be added here.

7. Tagline - Tagline of the widget's image

8. Plugin file - Here, you can download or upload the plugin file with the written code.

9. Version notes.

Enabling the “Active” toggle makes the plugin available in the Dashboard tile picker under the “Plugins” tab. Disabling this toggle removes the plugin from the tile picker - users will no longer be able to add it to new dashboard tiles. However, tiles that were already added remain in the dashboard, even if the plugin becomes inactive. In such cases, the content area will show an error like “Plugin configuration is either invalid or missing”.

Cloud Public plugin publication flow is as follows:

  1. The plugin is submitted as Cloud Public via the Developer UI and is marked internally as pending review.

  2. If approved within 7 days, the status is set to "Ready for Publish".

  3. A support confirmation email is sent to the developer.

  4. Plugin is locked (read-only) and can only be published or discarded

  5. Published plugins are visible to all workspace users.

  6. Version locking applies throughout the entire review and approval process.

Once a version is submitted for review, no further edits can be made to the plugin’s content, files, or metadata. If the plugin is approved, it still remains locked – the only action is to publish or discard it. If the plugin is rejected or needs changes, the developer must create a new version, which will inherit all data from the locked one.

Once published, the plugin is listed for other workspaces to activate. It appears in the Workspace → Plugins section of each workspace, where admins can review and activate the plugin. In this view, plugins can be distinguished by the "Owner" label for Cloud Public plugins. Cloud Public plugin creation includes a field in the plugin edit form to specify the developer's name. This label is only visible in the Workspace → Plugins section; it is not shown in the Dashboard tile view.

Plugins in the Dashboard

Once a plugin has been activated in the workspace, it becomes available to users who are configuring dashboard tiles.

A new "Plugins" tab is available when choosing a dashboard widget. Here you can choose from the available widgets. Then you can do some editing, like choosing the version of the plugin and the timezone/location:

User Roles & Permissions

User roles in the Developer module affect access to plugin features and tiles. Below is an overview of each permission level:

Role
Description
Can see Developer menu
Can create/edit plugins
Can view plugin tiles
Additional Notes

Developer-W Write access

Yes

Yes

Yes

Full control

Developer-R Read-only access

Yes

No

Yes

Can view but not edit

Developer-XNo access

No

No

Yes

Can see plugin tiles only if published by others; cannot access Developer UI

Last updated