OpenGate UX

OpenGate UX

Login

Exploring OpenGate UX Web Console

Discover the powerful and user-friendly OpenGate UX Web Console, a critical aspect of the OpenGate IoT Platform developed by amplía))) soluciones. Our UX team designs this web console to offer seamless interaction with the OpenGate API, providing an extensive range of features and tools to enhance your IoT experience. The console covers every aspect of IoT management and analysis from the initial Login to complex Analytics and Device Emulation.

Explore diverse Workspaces with customizable Dashboards featuring a variety of Widgets from advanced BIM/IFC Widgets to insightful Charts and Maps. Delve into detailed Entity Details, manage multiple entities through comprehensive Listings, and harness the power of Wizards for simplified administration and operations. The console also includes a robust Administration section for efficiently managing entities, organizations, and user settings. With the Devices Emulator, simulate real-world scenarios and utilize Analytics for advanced data analysis and predictive modelling. Lastly, ensure optimal system functionality with Operation System Support, keeping track of entities, notices, and incidents.

The OpenGate UX Web Console is your gateway to mastering IoT operations, offering an intuitive and comprehensive environment for managing the full spectrum of IoT tasks and challenges.


Index

Subsections of OpenGate UX

Login

Login

From the login window, you have the option to enter the website, for which you will need to provide a username and a password.

Login

Within the login window, you can choose which area of the portal you wish to access, among the following:

  • Workspaces and Dashboards
  • OpenGate Web Administration
  • Operations Support System
  • Device Simulator

URL Immutability

You can access the web by copying a URL that identifies a dashboard or section of the website.

If you don’t have an active session at that moment, you will be directed to the login screen to start your session.

Once your session is initiated, the web won’t redirect you to the home page; instead, it will take you to the dashboard or website section indicated in the URL.

Two Factor

Should the user have two-factor authentication enabled, a second step will appear where you will need to enter the validation digits.

TwoFactor

Lost Password

The website offers two mechanisms for password recovery in case it is forgotten or has expired.

Forgotten/Recovery of Password

By clicking on the Have you forgotten your password? link on the login page, you will be directed to a form where you will be asked to provide an email address to which a password recovery email will be sent.

Request password

The received email will contain a link directing you to a page where you can reset your password:

Response password

Change Due to Expired Password

If the validity of the password has expired, instead of allowing you to enter the website, the login process will direct you to a form where you can reset the password.

Expire session

Workspaces

The first thing we encounter when entering the web platform is the workspaces landing page. A workspace is used to group our dashboards.

Workspace

In the workspaces landing page you will see the sections below:

  • favourite dashboards groups all dashboards marked as favourite. Only will be displayed if favourites found. Favourite dashboards

  • workspaces displays workspaces marked to show in home and others shared with user/organization. Collaborative workspace shows dashboards shared with user/organization.

All dashboards
  • all dashboards were you can search any dashboard and access to it directly All dashboards

Workspaces can be displayed in 3 different modes:

  • grid where the user can organize the dashboards Workspace grid

  • carousel dashboards will be displayed in a carousel (no user configuration required) Workspace carousel

  • list dashboards will appears in a list showing its metadata on mouse over (no user configuration required) Workspace list

Creating a Workspace

There are two ways to create a workspace:

  • Click on the ‘NEW WORKSPACE’ button.
  • Access the workspaces and dashboards menu, and click on the ‘+ New workspace’ button. Workspace menu

Configuration

You can:

  • Give it a name and description and choose an identifying icon. Also you can assign a banner image and select if you want to hide workspace in home. Workspace configuration general
  • Enable/disable different actions that can be performed within the context of the workspace. This will determine which wizards are accessible from the various workspace menus and their dashboards. Workspace configuration actions
  • Redirect actions to a specific wizard, as long as more than one wizard can perform that action. Workspace configuration action-routing
  • Manage the templates that will be used within the workspace’s context. Workspace configuration templates

Once you have created your workspace, you can start creating your panels with their various widgets.

Actions

Workspace options
  • + New Dashboard: Create a new dashboard
  • Menú actions:
    • Share: Share the workspace with another user or with the entire organization. From here, you can also stop sharing the workspace if it is already shared with another person or organization Share
    • Export workspace: Export the workspace in zip format. It will contain a JSON file with the workspace configurations that you can later import. You can also configure which elements to export from the workspace. Export
    • Import dashboard: Import a dashboard into the workspace Import dashboard
    • Delete dashboards: Delete the selected dashboards Delete dashboard
    • Delete: Delete the workspace.
    • Information: Information about the workspace Information
  • Reload: Reload the workspace
  • Reorganize: Reorganize the view of dashboards Reorganize
  • Edit: Open the workspace editing wizard

From the home view, you can also perform various actions such as exporting and importing workspaces, configuring certain data related to your user and organization, viewing notifications, and accessing various sections of the web: Opengate Web Management, Operations Support System, Devices emulator, and Analytics.

The following details these actions.

Export/Import Workspaces

The web has the capability to export and import workspaces.

Export

  1. From the actions menu of the home, select the Export workspaces option.
  2. A panel will appear that allows you to export the workspaces in zip format. It will contain a JSON file with the workspace configurations that you can later import. You can also configure which elements to export from the workspace. Export workspace

Import

  1. From the actions menu of the home, select the Import workspaces option.
  2. A panel will appear that allows you to import workspaces. You can also configure which elements to import from the workspaces to import. Import workspace

Web Preferences

User Data

From the actions menu, clicking on the user’s icon will allow you to access a panel that allows you to modify your user’s data:

Home actions
  • Edit: Displays information related to our user User data
  • Password: from here, you can modify your password User password

Actions to Perform on Workspaces in the Home

Organize View

You can organize the order of workspaces:

Organize view

Quick Access to Workspaces

Select workspace

Notifications

You can view notifications related to operations executed in your organization, as well as the progress of bulk operations and their CSV downloads. You can also view (and copy) requests made against the platform. These notifications can be activated to notify you as soon as any changes occur in any of the sections.

Notifications

Operations

Operations

You can view operations executed in your organization or only those performed by you. You can also view information about the executions performed in each of the operations.

Bulk

Bulk

You can view the progress of the bulk operations executed in your organization. You can also access the list of bulk operations and download the response of the bulk operation.

CSV

CSV

You can view the progress of CSV downloads performed on the web.

Requests

Requests

You can view the different requests made to the Opengate platform. You can also copy these requests in CURL format.


Subsections of Workspaces

Dashboards

Dashboards are spaces where we group and organize the widgets we need for our work.

Dashboard

Creating a Dashboard

Similar to workspaces, there are two ways to create a dashboard:

  • In the menu of our workspace, click on the ‘+ New Dashboard’ button.
  • Access the workspace and dashboard menu, select your workspace, and click on the ‘New Dashboard’ button. Workspace menu

Dashboard Configuration

You can:

  • Give it a name and description and configure the card that will be displayed in the workspace.
  • Choose an identifying icon, either from our icon catalog or by uploading one from your computer.
  • Add an image for better identification in workspaces and/or banner image. Dashboard configuration general
  • Configure the behavior of your widgets within the dashboard:
    • Set the refresh interval that will be applied to all widgets. By default, the value is “MANUAL,” and it will only refresh through user interaction with the dashboard.
    • Set the minimum dimensions for widgets contained in the dashboard. Dashboard configuration advanced

Once the website is created, it will display a blank dashboard where you can add all the widgets you need.

It also contains a side menu from which you can access the various wizards you added when creating the workspace (under the “ACTIONS” tab) as well as the dashboard’s own actions:

Dashboard actions

Some of the actions you can perform include:

  • Add widget: Puts the dashboard in editing mode and opens the widget selection panel.
  • Actions:
    • Fullscreen: Displays the dashboard in full-screen mode.
    • Capture screen: Takes a screenshot of the dashboard.
    • Delete: Deletes the dashboard.
  • Reload: Refreshes all widgets contained in the dashboard.
  • Edit: Edit the dashboard to add widgets.
  • Configuration: Opens the dashboard editing wizard.
  • Favourite: Sets de favourite flag in dashboard in order to show in the favourite dashboards section.

The rest of the actions, such as Share, Clone, Move, Information, are explained below.

The “Save as template” action is explained in the “Templates” section.

Export/Import a Dashboard

The website has the capability to export and import dashboards.

Export

  1. In the dashboard’s actions menu, select the “Export dashboard” option.
  2. A panel will appear that allows you to export a dashboard in zip format. It will contain a JSON file with the dashboard’s configuration that you can later import into a workspace. Import dashboard

Import

  1. In the options menu of the workspace where you want to load the dashboard, select the “Import dashboard” option.
  2. A panel will appear that allows you to import a dashboard. Import dashboard

Share a Dashboard

You can share your dashboards with other users within your own organization.

  1. In the dashboard’s actions menu, select the “Share” option.
  2. Choose whom you want to share the dashboard with: a single person within your organization or with your entire organization. From here, you can also stop sharing the dashboard if it is already shared with another person or organization. Dashboard share

Move Dashboard

You can move dashboards between different workspaces.

  1. In the dashboard’s actions menu, select the “Move” option.
  2. Select the workspace to which you want to move the dashboard. Dashboard move

Clone Dashboard

You can clone a dashboard into another workspace.

  1. In the dashboard’s actions menu, select the “Clone” option.
  2. Select the workspace to which you want to move the dashboard. Dashboard move

Information

For quick access to dashboard information.

  1. In the dashboard’s actions menu, select the “Information” option. Dashboard move

Subsections of Dashboards

Widgets

Widgets are the elements of our dashboard that allow us to work and interact with the OpenGate platform.

Create Widgets

Once we have our dashboard created, we can start adding the widgets we will use for work.

By clicking the “ADD WIDGET” button, a panel will appear from which we can add the chosen widget.

Dashboard add widget Dashboard add widget

If the chosen widget requires configuration, a widget configuration wizard will be displayed.

Once all the necessary widgets have been configured and added, we will save the dashboard by pressing the SAVE button.

List of Widgets


Subsections of Widgets

Subsections of Advanced

BIM/IFC Widget

The BIM/IFC widget allows you to configure a 3D model under the BIM/IFC standard and add sensors to the desired elements of the model.

How it Works

BIM/IFC Widget

The widget displays the selected model, covering the widget area. To the left of the widget is a panel with available actions, and to the right are listed the selected and monitored elements.

Actions Panel

BIM/IFC Actions Panel

With the Actions Panel, you can:

  • All elements displays a list of all elements in the model, allowing you to search and select an element quickly
BIM/IFC All Elements
  • Show/Hide list allows you to show/hide the right panel of elements
  • Highlight elements will select all preconfigured elements from the right panel in the model
  • Capture an image downloads a snapshot of only the model in its current state
  • Create clipping plane enables the option to select an element in the model to create a cutting layer that allows you to cut the model and see elements inside
  • Remove clipping plane removes the selected cutting layer
  • Enable/disable clipping planes activates/deactivates the cutting layers without needing to remove and add
  • Clear cache and reload clears the cache and reloads the image to return it to its initial state

Elements Panel

BIM/IFC Elements Panel

With the Elements Panel, you can select an element to highlight it in the model for more precise location.

States are also represented here as established by the configured code.

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

BIM/IFC General Configuration
  • Organization files allows you to select a file to add to our widget

  • Preview here, you can see the loaded model and preselect those elements you want to highlight/monitor

In the preview panel, the following actions are found:

[…The actions are similar to the Actions Panel section…]

Items Tab

From here, you can alter the values of the elements selected in the model preview:

  • Express ID allows you to modify the ID of the selected element if it has changed in the model
  • Alias you can assign an alternative display name
BIM/IFC Items Configuration

Code Tab

Here, you configure the logic needed for the identification of different values and to display them on the elements of the model.

BIM/IFC Code Configuration

IMPORTANT NOTE: Whenever code is modified, it must be evaluated to save the changes

Function

Depending of the configuration receives the following parameters:

  • entityData contains the data of the opened entity NOTE: only available when the user opens an entity dashboard template

Example:

{
  "provision.administration.identifier": {
    "_value": {
      "_current": {
        "value": "device_1"
      }
    }
  },
  "provision.administration.organization": {
    "_value": {
      "_current": {
        "value": "organization_name"
      }
    }
  },
  "provision.administration.channel": {
    "_value": {
      "_current": {
        "value": "channel_name"
      }
    }
  },
  "provision.administration.serviceGroup": {
    "_value": {
      "_current": {
        "value": "service_group_name"
      }
    }
  }
}
  • relatedEntities contains an array of entities related to the entity selected. NOTE: only available when the user opens an entity dashboard template

Example:

[{
  "provision.administration.identifier": {
    "_value": {
      "_current": {
        "value": "related_1"
      }
    }
  },
  "provision.administration.organization": {
    "_value": {
      "_current": {
        "value": "organization_name"
      }
    }
  },
  "provision.administration.channel": {
    "_value": {
      "_current": {
        "value": "channel_name"
      }
    }
  },
  "provision.administration.serviceGroup": {
    "_value": {
      "_current": {
        "value": "service_group_name"
      }
    }
  }
}]
  • timeserieData contains info about the timeserie opened by the user
    • config timeserie configuration
    • data timeserie row selected

NOTE: only available when the user opens an entity dashboard template from timeserie table widget

An example:

{
  "config": {
    "identifier": "69281dc43545e97df66c42a1",
    "name": "Battery charge history",
    "timeBucket": 3600,
    "bucketColumn": "bucketEnd",
    "bucketInitColumn": "bucketInit",
    "identifierColumn": "EntityID",
    "retention": 2592000,
    "origin": "2025-11-26T23:00:00Z",
    "context": [
      {
        "path": "provision.device.administrativeState",
        "name": "Administrative state",
        "sort": "true",
        "filter": "YES",
        "type": "string"
      }
    ],
    "columns": [
      {
        "path": "device.powersupply.battery.charge._current.value",
        "name": "Powersupply battery charge Current Value",
        "filter": "NO",
        "type": "number",
        "sort": false,
        "aggregationFunction": "FIRST"
      }
    ]
  },
  "data": {
    "bucketEnd": "2025-12-11T13:00:00+01:00",
    "bucketInit": "2025-12-11T12:00:00+01:00",
    "EntityID": "entity_1",
    "Powersupply battery charge Current Value": 34
  }
}
  • alarmData contains the data of the alarm opened in template
{
  "identifier": "270dd9f9-1396-4660-bb5f-8d8b471e1dcd",
  "name": "activityForbidden",
  "rule": "activityForbidden",
  "description": "Activity detected for an entity with administrative state disabled",
  "severity": "INFORMATIVE",
  "priority": "LOW",
  "organization": "organization_name",
  "channel": "default_channel",
  "entityIdentifier": "A_WORKER_1",
  "subEntityIdentifier": "A_WORKER_1",
  "resourceType": "ENTITY_ASSET",
  "status": "CLOSED",
  "openingDate": "2019-06-27T08:57:36+02:00",
  "closureDate": "2019-06-27T08:57:51+02:00"
}
  • callback (optional) function used to send data to the widget (only when the api/http petitions are promised, use return instead)
callback();

or

return;

Available utils

$api -> use it to create http petitions to OpenGate Api Rest doc

$user -> Logged user

Example:

{
    "email": "email@amplia.es",
    "workgroup": "workgroup",
    "domain": "domain",
    "profile": "profile",
    "countryCode": "ES",
    "langCode": "en",
    "timezone": "Europe/Madrid"
}

$moment -> use it to format date doc

console -> display messages in navigator console

Promise -> allows easy execution of multiple promises

http -> javascript encapsulation of useFetch (Nuxt 4) library doc

alert -> alert navigator method

setValueToItem -> Sets a value to the selected item

setValueToItem(itemID, alias, value [,style, datetime, deviceId, datastreamId])

setItemStatus -> Sets an special status

setItemStatus(itemID, [rgbColor(string format)|null])

Final code structure build by the application

async function main(entityData, relatedEntitiesData, timeserieData, alarmData,callback) {
  // YOUR CODE HERE WITH RETURN OR CALLBACK
}

Examples


Subsections of BIM/IFC Widget

Change Item Status by Battery Charge

Code

/**
 * Logic:
 * 1. Queries a sample of maximum 50 entities.
 * 2. Calculates the average of the `device.powersupply.battery.charge` values.
 * 3. Update "VentanaPrincipal" value with the average.
 * 4. If the floor of average is even, changes "VentanaPrincipal" status to Red (#FF0000).
 * 5. If the floor of average is odd, changes "VentanaPrincipal" status to Green (#00FF00).
 */

// 1. Create the builder to search for entities, limiting to 50
var builder = $api.entitiesSearchBuilder()
    .limit(50)
    .flattened();

// 2. Execute the query
var response = await builder.build().execute();

var totalCharge = 0;
var count = 0;

// 3. Iterate through the results and sum the battery charge
if (response && response.data && response.data.entities) {
    response.data.entities.forEach(function(entity) {
        // Access the battery charge field
        // Field: device.powersupply.battery.charge
        var batteryField = entity['device.powersupply.battery.charge'];
        
        if (batteryField && batteryField._value && batteryField._value._current && batteryField._value._current.value) {
            var val = parseFloat(batteryField._value._current.value);
            if (!isNaN(val)) {
                totalCharge += val;
                count++;
            }
        }
    });
}

// 4. Calculate Average
var average = count > 0 ? totalCharge / count : 0;

// 5. Determine color based on parity of the floor of the average
// Even -> Red "#FF0000"
// Odd -> Green "#00FF00"
var floorAvg = Math.floor(average);
var isEven = floorAvg % 2 === 0;
var color = isEven ? "#FF0000" : "#00FF00";

// 6. Set the item status and value
// setItemStatus(itemID, [rgbColor(string format)|null])
setItemStatus("VentanaPrincipal", color);

// setValueToItem(itemID, alias, value)
setValueToItem("VentanaPrincipal", "Battery Avg", average.toFixed(2));

// Use return as the function is async
return;

All Entities Average Battery

Code

/**
 * Logic:
 * 1. Iterates through ALL entities in the platform using `executeWithAsyncPaging` (efficient pagination).
 * 2. Calculates the average of the `device.powersupply.battery.charge` values across all entities.
 * 3. Update "VentanaPrincipal" value with the global average.
 * 4. If the floor of average is even, changes "VentanaPrincipal" status to Red (#FF0000).
 * 5. If the floor of average is odd, changes "VentanaPrincipal" status to Green (#00FF00).
 */

var totalCharge = 0;
var count = 0;

// 1. Create the builder
var builder = $api.entitiesSearchBuilder()
    .limit(2000) // Max limit per page
    .flattened();

// 2. Execute with async paging
// executeWithAsyncPaging(resourceName) returns a Promise
return builder.build().executeWithAsyncPaging('entities').then(
    // Success Callback (called when all pages are processed)
    function() {
        // 4. Calculate Average
        var average = count > 0 ? totalCharge / count : 0;

        // 5. Determine color based on parity of the floor of the average
        var floorAvg = Math.floor(average);
        var isEven = floorAvg % 2 === 0;
        var color = isEven ? "#FF0000" : "#00FF00";

        // 6. Set the item status and value
        setItemStatus("VentanaPrincipal", color);
        setValueToItem("VentanaPrincipal", "Battery Avg", average.toFixed(2));
    },
    // Error Callback
    function(err) {
        console.error("Error in paging:", err);
    },
    // Notify Callback (called for each page of results)
    function(pageData) {
        if (pageData && pageData.length > 0) {
            pageData.forEach(function(entity) {
                // Access the battery charge field
                var batteryField = entity['device.powersupply.battery.charge'];
                
                if (batteryField && batteryField._value && batteryField._value._current && batteryField._value._current.value) {
                    var val = parseFloat(batteryField._value._current.value);
                    if (!isNaN(val)) {
                        totalCharge += val;
                        count++;
                    }
                }
            });
        }
    }
);

Custom Action

Custom action widgets allow you to code an action to be performed, which will be triggered by a button or a form.

How it Works

Custom action widget

This widget will display a form or button that will execute the user-coded action.

In the case of using a form, the action will receive the form values and any desired logic can be applied to them.

Additionally, this widget can be configured so that the action executes within a dialog box as an independent form.

Custom action execution result

Once the execution is initiated, a progress box will appear displaying the result of the action.

The execution will be successful as long as no exception is thrown in the source code.

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

  • Description here you will write what action will be executed when the corresponding button is pressed
  • Icon determines the type of desired visualization: a button with an icon, an image, or a custom form. In the case of a form, it can also be specified if you want to display it as a dialog box.
Custom action general configuration

If it’s a form, you must enter a JSON schema that determines what will be drawn.

Custom action schema configuration

Expert

Custom action expert configuration

Here you can configure source code that will run before the widget is loaded, allowing for the dynamic construction of the JSON schema of the form to be displayed, thereby facilitating the construction of dynamic forms based on platform data.

Available utils

$api -> use it to create http petitions to OpenGate Api Rest doc

$user -> Logged user

Example:

{
    "email": "email@amplia.es",
    "workgroup": "workgroup",
    "domain": "domain",
    "profile": "profile",
    "countryCode": "ES",
    "langCode": "en",
    "timezone": "Europe/Madrid"
}

$moment -> use it to format date doc

console -> display messages in navigator console

Promise -> allows easy execution of multiple promises

http -> javascript encapsulation of useFetch (Nuxt 4) library doc

Function

Depending of the configuration receives the following parameters:

  • entityData contains the data of the opened entity NOTE: only available when the user opens an entity dashboard template

Example:

{
  "provision.administration.identifier": {
    "_value": {
      "_current": {
        "value": "device_1"
      }
    }
  },
  "provision.administration.organization": {
    "_value": {
      "_current": {
        "value": "organization_name"
      }
    }
  },
  "provision.administration.channel": {
    "_value": {
      "_current": {
        "value": "channel_name"
      }
    }
  },
  "provision.administration.serviceGroup": {
    "_value": {
      "_current": {
        "value": "service_group_name"
      }
    }
  }
}
  • relatedEntities contains an array of entities related to the entity selected. NOTE: only available when the user opens an entity dashboard template

Example:

[{
  "provision.administration.identifier": {
    "_value": {
      "_current": {
        "value": "related_1"
      }
    }
  },
  "provision.administration.organization": {
    "_value": {
      "_current": {
        "value": "organization_name"
      }
    }
  },
  "provision.administration.channel": {
    "_value": {
      "_current": {
        "value": "channel_name"
      }
    }
  },
  "provision.administration.serviceGroup": {
    "_value": {
      "_current": {
        "value": "service_group_name"
      }
    }
  }
}]
  • timeserieData contains info about the timeserie opened by the user
    • config timeserie configuration
    • data timeserie row selected

NOTE: only available when the user opens an entity dashboard template from timeserie table widget

An example:

{
  "config": {
    "identifier": "69281dc43545e97df66c42a1",
    "name": "Battery charge history",
    "timeBucket": 3600,
    "bucketColumn": "bucketEnd",
    "bucketInitColumn": "bucketInit",
    "identifierColumn": "EntityID",
    "retention": 2592000,
    "origin": "2025-11-26T23:00:00Z",
    "context": [
      {
        "path": "provision.device.administrativeState",
        "name": "Administrative state",
        "sort": "true",
        "filter": "YES",
        "type": "string"
      }
    ],
    "columns": [
      {
        "path": "device.powersupply.battery.charge._current.value",
        "name": "Powersupply battery charge Current Value",
        "filter": "NO",
        "type": "number",
        "sort": false,
        "aggregationFunction": "FIRST"
      }
    ]
  },
  "data": {
    "bucketEnd": "2025-12-11T13:00:00+01:00",
    "bucketInit": "2025-12-11T12:00:00+01:00",
    "EntityID": "entity_1",
    "Powersupply battery charge Current Value": 34
  }
}
  • alarmData contains the data of the alarm opened in template
{
  "identifier": "270dd9f9-1396-4660-bb5f-8d8b471e1dcd",
  "name": "activityForbidden",
  "rule": "activityForbidden",
  "description": "Activity detected for an entity with administrative state disabled",
  "severity": "INFORMATIVE",
  "priority": "LOW",
  "organization": "organization_name",
  "channel": "default_channel",
  "entityIdentifier": "A_WORKER_1",
  "subEntityIdentifier": "A_WORKER_1",
  "resourceType": "ENTITY_ASSET",
  "status": "CLOSED",
  "openingDate": "2019-06-27T08:57:36+02:00",
  "closureDate": "2019-06-27T08:57:51+02:00"
}

Action code specific parameters

  • value is the value, in string format, entered in value field when enabled

  • model contains the custom form values data

Example:

{
    "your.datastream.name": "datastreamvalue",
    "field1": "value1",
    "field2": "value2"
}
Final code structure build by the application
async function main(entityData,alarmData,relatedEntities,timeserieData,value, model) {
  // YOUR CODE HERE WITH RETURN OR CALLBACK
}

Expert code specific parameters

  • config receives the configuration object of the widget in order to modify it
  • callback function used to send the new configuration to the widget

Example:

callback(newConfig);

or

return newConfig;
Final code structure build by the application
async function main(entityData,alarmData,relatedEntities,timeserieData,config,callback) {
  // YOUR CODE HERE WITH RETURN OR CALLBACK
}

Examples


Subsections of Custom Action

Custom Action Example

Code

// Check if a value is provided
if (!value) {
  console.warn("No value provided for search.");
  return;
}

// Define the API endpoint (JSONPlaceholder)
// We'll filter todos by userId based on the input value
var apiUrl = "https://jsonplaceholder.typicode.com/todos?userId=" + value;

console.log("Fetching data from: " + apiUrl);

try {
  // Perform the request using the platform's http utility (encapsulation of Nuxt 4 useFetch)
  // useFetch typically parses JSON automatically.
  // We await the result. 
  // Note: useFetch in Nuxt returns { data, error, ... }
  const { data, error } = await http(apiUrl);

  if (error && error.value) {
    throw new Error("Generic Error: " + error.value);
  }

  // Access the data (Ref value if it's a ref, or direct if the utility un-refs it)
  // Assuming standard Nuxt composition API behavior where top level properties are Refs
  const results = data.value || data;

  console.log("--- Search Results (User ID: " + value + ") ---");
  // Check if we got any results
  if (results && results.length > 0) {
    console.table(results); // Display as a table for better readability
    console.log("Total records found: " + results.length);
  } else {
    console.log("No records found for User ID: " + value);
  }

} catch (err) {
  console.error("Fetch error:", err);
}

Custom Action Entity Search Example

Code

// Check if model is provided
if (!model) {
  console.warn("No form data (model) provided.");
  return;
}

const { name, specificType } = model;
console.log("Searching entities with Name:", name, "and Specific Type:", specificType);

// Create the builder
var builder = $api.entitiesSearchBuilder().flattened();

// Define filters based on model values
var filter = {
  and: [
    {
      eq: {
        'resourceType': 'entity.device'
      }
    }
  ]
};

if (name) {
  filter.and.push({
    like: {
      'provision.administration.identifier': name // Assuming 'name' maps to identifier for this example, or use 'provision.device.name' if appropriate
    }
  });
}

if (specificType) {
  filter.and.push({
    eq: {
      'provision.device.specificType': specificType
    }
  });
}

// Apply filter if any conditions were added
if (filter.and.length > 0) {
  builder.filter(filter);
}

try {
  // Execute the search
  // await is supported in this context
  const response = await builder.build().execute();

  if (response.statusCode === 200) {
    console.log("--- Entity Search Results ---");
    const entities = response.data.entities;
    if (entities && entities.length > 0) {
      console.table(entities.map(e => ({
        id: e['provision.administration.identifier']._value._current.value,
        specificType: e['provision.device.specificType'] ? e['provision.device.specificType']._value._current.value : 'N/A'
      })));
      console.log("Total entities found:", entities.length);
    } else {
      console.log("No entities match the criteria.");
    }
  } else {
    console.error("Search failed with status:", response.statusCode);
  }

} catch (err) {
  console.error("Error executing entity search:", err);
}

Custom Chart

Custom charts allow for the display of data in graphical format based on user-defined logic.

How it Works

Custom chart widget

Once the logic for data retrieval is entered, the data will be displayed on the widget.

What sets the custom chart apart from others is that the data source can be external, internal, both, or even fabricated. Moreover, multiple charts can be combined within the same widget.

This widget is compatible with eCharts library version 5. Multiple examples can be accessed via the following link: eCharts

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

  • Show widget filters instructs the widget to display its filters. These filters will be passed as an additional parameter to the data retrieval function.
Custom chart code configuration

Here, you input the necessary code to obtain the information to be displayed.

Depending on the selected options, the parameters received by the function will be displayed.

The function must always return a JSON object that is compatible with eCharts’ chart configuration.

Every time the code is updated, it must be evaluated where a preview of the result can be seen.

Custom chart code preview

Function

Depending of the configuration receives the following parameters:

  • entityData contains the data of the opened entity NOTE: only available when the user opens an entity dashboard template

Example:

{
  "provision.administration.identifier": {
    "_value": {
      "_current": {
        "value": "device_1"
      }
    }
  },
  "provision.administration.organization": {
    "_value": {
      "_current": {
        "value": "organization_name"
      }
    }
  },
  "provision.administration.channel": {
    "_value": {
      "_current": {
        "value": "channel_name"
      }
    }
  },
  "provision.administration.serviceGroup": {
    "_value": {
      "_current": {
        "value": "service_group_name"
      }
    }
  }
}
  • relatedEntities contains an array of entities related to the entity selected. NOTE: only available when the user opens an entity dashboard template

Example:

[{
  "provision.administration.identifier": {
    "_value": {
      "_current": {
        "value": "related_1"
      }
    }
  },
  "provision.administration.organization": {
    "_value": {
      "_current": {
        "value": "organization_name"
      }
    }
  },
  "provision.administration.channel": {
    "_value": {
      "_current": {
        "value": "channel_name"
      }
    }
  },
  "provision.administration.serviceGroup": {
    "_value": {
      "_current": {
        "value": "service_group_name"
      }
    }
  }
}]
  • timeserieData contains info about the timeserie opened by the user
    • config timeserie configuration
    • data timeserie row selected

NOTE: only available when the user opens an entity dashboard template from timeserie table widget

An example:

{
  "config": {
    "identifier": "69281dc43545e97df66c42a1",
    "name": "Battery charge history",
    "timeBucket": 3600,
    "bucketColumn": "bucketEnd",
    "bucketInitColumn": "bucketInit",
    "identifierColumn": "EntityID",
    "retention": 2592000,
    "origin": "2025-11-26T23:00:00Z",
    "context": [
      {
        "path": "provision.device.administrativeState",
        "name": "Administrative state",
        "sort": "true",
        "filter": "YES",
        "type": "string"
      }
    ],
    "columns": [
      {
        "path": "device.powersupply.battery.charge._current.value",
        "name": "Powersupply battery charge Current Value",
        "filter": "NO",
        "type": "number",
        "sort": false,
        "aggregationFunction": "FIRST"
      }
    ]
  },
  "data": {
    "bucketEnd": "2025-12-11T13:00:00+01:00",
    "bucketInit": "2025-12-11T12:00:00+01:00",
    "EntityID": "entity_1",
    "Powersupply battery charge Current Value": 34
  }
}
  • alarmData contains the data of the alarm opened in template
{
  "identifier": "270dd9f9-1396-4660-bb5f-8d8b471e1dcd",
  "name": "activityForbidden",
  "rule": "activityForbidden",
  "description": "Activity detected for an entity with administrative state disabled",
  "severity": "INFORMATIVE",
  "priority": "LOW",
  "organization": "organization_name",
  "channel": "default_channel",
  "entityIdentifier": "A_WORKER_1",
  "subEntityIdentifier": "A_WORKER_1",
  "resourceType": "ENTITY_ASSET",
  "status": "CLOSED",
  "openingDate": "2019-06-27T08:57:36+02:00",
  "closureDate": "2019-06-27T08:57:51+02:00"
}
  • filters introduced by the user. These filters are:
    • generic widget generic filter
    • period widget date period filter
    • inherit json object with inherited filter if ‘shared filter’ is enabled. This filter is composed by ‘and’ filter that contains standar filter, private/template filter and headers filters from the source widget.

An example:

{
    "filters": {
        "generic": "filter introduced by the user",
        "period": {"from":"2023-03-27T10:59:27+02:00","to":null},
        "inherit": {
            "and": [
              { "eq": {"field.identifier._current.value": "value"}},
              { "eq": {"field2.identifier._current.value": "value2"}}
            ]
        }
    }
}
  • callback (optional) function used to send chart data (only when the api/http petitions are promised, use return instead)
callback(chartConfig);

or

callback({
  title: {
    text: 'Referer of a Website',
    subtext: 'Fake Data',
    left: 'center'
  },
  tooltip: {
    trigger: 'item'
  },
  legend: {
    orient: 'vertical',
    left: 'left'
  },
  series: [
    {
      name: 'Access From',
      type: 'pie',
      radius: '50%',
      data: [
        { value: 1048, name: 'Search Engine' },
        { value: 735, name: 'Direct' },
        { value: 580, name: 'Email' },
        { value: 484, name: 'Union Ads' },
        { value: 300, name: 'Video Ads' }
      ]
    }
  ]
});

or

return chartConfig;

Available utils

$api -> use it to create http petitions to OpenGate Api Rest doc

$user -> Logged user

Example:

{
    "email": "email@amplia.es",
    "workgroup": "workgroup",
    "domain": "domain",
    "profile": "profile",
    "countryCode": "ES",
    "langCode": "en",
    "timezone": "Europe/Madrid"
}

$moment -> use it to format date doc

console -> display messages in navigator console

Promise -> allows easy execution of multiple promises

http -> javascript encapsulation of useFetch (Nuxt 4) library doc

echarts -> echarts core library

ecStat -> echarts stats library

addChartEvent -> (event, handler[(event, chartInstance) => {}] [, query]) - adds an event handler doc

Final code structure build by the application

async function main(entityData,timeserieData,filters,page,pageElements,callback) {
  // YOUR CODE HERE WITH RETURN OR CALLBACK
}

Examples


Subsections of Custom Chart

Custom Chart Examples

Code

return {
  title: {
    text: 'Referer of a Website',
    subtext: 'Fake Data',
    left: 'center'
  },
  tooltip: {
    trigger: 'item'
  },
  legend: {
    orient: 'vertical',
    left: 'left'
  },
  series: [
    {
      name: 'Access From',
      type: 'pie',
      radius: '50%',
      data: [
        { value: 1048, name: 'Search Engine' },
        { value: 735, name: 'Direct' },
        { value: 580, name: 'Email' },
        { value: 484, name: 'Union Ads' },
        { value: 300, name: 'Video Ads' }
      ],
      emphasis: {
        itemStyle: {
          shadowBlur: 10,
          shadowOffsetX: 0,
          shadowColor: 'rgba(0, 0, 0, 0.5)'
        }
      }
    }
  ]
};

Custom HeatMap Chart Example

Code

const getDaysArray = function (start, end) {
  const arr = [];
  var curMonth;
  var monthData = {};
  var days = [];
  for (const dt = new Date(start); dt <= new Date(end); dt.setDate(dt.getDate() + 1)) {
    var curDate = new Date(dt);

    var newMonth = (curDate.getMonth() + 1) + '/' + curDate.getFullYear();

    if (curMonth && curMonth !== newMonth) {
      monthData = {
        value: curMonth,
        children: days
      };
      arr.push(monthData);
      days = [];
    }

    days.push(curDate.getDate() + '/' + (curDate.getMonth() + 1) + '/' + curDate.getFullYear());


    curMonth = newMonth;
  }

  if (days.length) {
    monthData = {
      value: curMonth,
      children: days
    };
    arr.push(monthData);
  }
  return arr;
};

const chartConfig = {
  visualMap: {
    type: 'continuous',
    min: 0,
    max: 1,
    dimension: 2,
    calculable: true,
    orient: 'horizontal',
    top: 5,
    left: 'center',
    color: ['#0f0', '#f00']
  },
  legend: {
    show: true,
    bottom: 10
  },
  matrix: {
    x: {
      data: [],
      levelSize: 40,
    },
    y: {
      label: {
        show: true,
        width: 150
      },
      levelSize: 150,
      data: []
    },
    top: 70,
    bottom: 40,
    left: 2,
    right: 2
  },
  series: {
    type: 'heatmap',
    coordinateSystem: 'matrix',
    data: [],
    label: {
      show: false
    }
  },
  tooltip: {
    show: true
  }
};

// busqueda de todas las entidades
var entitiesBuilder = $api.entitiesSearchBuilder().limit(1000, 1);
var entitiesFilter = {
  and: [{
    eq: {
      'provision.device.specificType': 'METER'
    }
  }]
};
if (filters && filters.generic) {
  entitiesFilter.and.push({
    eq: {
      'provision.administration.identifier': filters.generic
    }
  });
}

entitiesBuilder.filter(entitiesFilter);

const tempData = {};

var initDate = new Date(new Date().getDate() - 30);
var endDate = new Date();

var filter = {
  and: [{
    eq: {
      "datapoints.datastreamId": "volTot"
    }
  }]
};


if (filters && filters.period) {
  if (filters.period.from) {
    initDate = new Date(filters.period.from);
    filter.and.push({
      gte: {
        'datapoints._current.at': filters.period.from
      }
    });
  }

  if (filters.period.to) {
    endDate = new Date(filters.period.to);
    filter.and.push({
      lt: {
        'datapoints._current.at': filters.period.to
      }
    });
  }
}

chartConfig.matrix.x.data = getDaysArray(initDate, endDate);

var response = await entitiesBuilder.flattened().build().execute();

if (response && response.data && response.data.entities && response.data.entities.length > 0) {
  response.data.entities.forEach((entityDataTmp) => {
    const entityIdentifier = entityDataTmp['provision.administration.identifier']._value._current.value;

    if (!tempData[entityIdentifier]) {
      tempData[entityIdentifier] = [];

      chartConfig.matrix.x.data.forEach((monthData) => {
        monthData.children.forEach((dayData) => {
          tempData[entityIdentifier].push([dayData, entityIdentifier, 0]);
        });
      });
    }
  });
}


var builder = $api.datapointsSearchBuilder().limit(2000, 1).addSortBy('datapoints._current.at', 'DESCENDING');


builder.filter(filter).build().executeWithAsyncPaging('datapoints').then(
  function endFunction() {
    //drawChart(datapointsBuffer, true)
    chartConfig.matrix.y.data = Object.keys(tempData);

    let finalData = [];
    chartConfig.matrix.y.data.forEach((deviceId) => {
      finalData = finalData.concat(tempData[deviceId]);
    });
    chartConfig.series.data = finalData;
    callback(chartConfig);
  },
  function cancelado(err) {
    console.error(err);
    //drawChart(datapointsBuffer, true)
    callback(chartConfig);
  },
  function notify(notifyData) {
    if (notifyData && notifyData.length > 0) {
      notifyData.forEach((datapoint) => {
        if (!tempData[datapoint.entityIdentifier]) {
          tempData[datapoint.entityIdentifier] = [];

          chartConfig.matrix.x.data.forEach((monthData) => {
            monthData.children.forEach((dayData) => {
              tempData[datapoint.entityIdentifier].push([dayData, datapoint.entityIdentifier, 0]);
            });
          });
        }

        const currentAt = new Date(datapoint._current.at);
        const currentAtTxt = currentAt.getDate() + '/' + (currentAt.getMonth() + 1) + '/' + currentAt.getFullYear();
        const atIndex = tempData[datapoint.entityIdentifier].findIndex((element) => element[0] === currentAtTxt);
        tempData[datapoint.entityIdentifier][atIndex][2] = 1;
      });
    }
  }
).catch(function (err) {
  console.error(err);
});

Custom Table

Custom tables allow you to display data in a list format based on logic encoded by the user.

How it Works

Custom table widget

Once the logic for data retrieval is entered, the data will be displayed in the table.

What sets the custom table apart is that the data source can be external, internal, both, or even fabricated. Moreover, custom charts can be mixed in, and additional information can be included in the expandable panel.

Custom table expanded row

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

  • Pagination type allows you to specify the kind of pagination you want. There may be no pagination, pagination handled by the table component (local), or server-side pagination.

If server-side pagination is chosen, the script will receive parameters like the number of elements and the page, allowing the user to decide.

  • Page elements specifies the number of elements to show per page.
  • Allow data grouping enables the table to group items by elements in a column.
  • Show widget filters instructs the widget to display its filters. These filters will be passed as an additional parameter to the data retrieval function.
  • Compact the size of the table rows will make the table rows more compact to save vertical space.
  • Expandable rows enables an information button for expanded data on each row. The code must fill this information, or an empty space will be displayed.
Custom table general configuration

Column Configuration

Custom table column configuration

The data that will be displayed in table. In order to finish the configuration for this you must add one column at least and select a primary key. For every column you can define the next data:

  • Name to show in headers
  • JSON field is the field to read in data returned by the function. Primary key use that field
  • Sortable permits sorting for this column
  • Groupable allow group by this field in table
  • Filterable allow filter by this field in table
  • Data type of the filter (only when filterable)
  • Divisor draws a separator between this column and the next
  • Show entity actions enables context menu for the column allowing to perform some actions depending of the item value.

Columns supports drag&drop in order to determine the position in the table.

Code Tab

This is where you input the necessary code to retrieve the data to be displayed.

Custom table code configuration

Depending on the options selected in the general tab, the parameters received by the function will be displayed.

The function must always return an array of JSON objects compatible with the specified configuration for the component to be able to render them.

Each time the code is updated, it must be evaluated where a preview of the result can be seen. Finally you MUST return an array with a json that matches the columns configuration.

Custom table code preview

Function

Depending of the configuration receives the following parameters:

  • entityData contains the data of the opened entity NOTE: only available when the user opens an entity dashboard template

Example:

{
  "provision.administration.identifier": {
    "_value": {
      "_current": {
        "value": "device_1"
      }
    }
  },
  "provision.administration.organization": {
    "_value": {
      "_current": {
        "value": "organization_name"
      }
    }
  },
  "provision.administration.channel": {
    "_value": {
      "_current": {
        "value": "channel_name"
      }
    }
  },
  "provision.administration.serviceGroup": {
    "_value": {
      "_current": {
        "value": "service_group_name"
      }
    }
  }
}
  • relatedEntities contains an array of entities related to the entity selected. NOTE: only available when the user opens an entity dashboard template

Example:

[{
  "provision.administration.identifier": {
    "_value": {
      "_current": {
        "value": "related_1"
      }
    }
  },
  "provision.administration.organization": {
    "_value": {
      "_current": {
        "value": "organization_name"
      }
    }
  },
  "provision.administration.channel": {
    "_value": {
      "_current": {
        "value": "channel_name"
      }
    }
  },
  "provision.administration.serviceGroup": {
    "_value": {
      "_current": {
        "value": "service_group_name"
      }
    }
  }
}]
  • timeserieData contains info about the timeserie opened by the user
    • config timeserie configuration
    • data timeserie row selected

NOTE: only available when the user opens an entity dashboard template from timeserie table widget

An example:

{
  "config": {
    "identifier": "69281dc43545e97df66c42a1",
    "name": "Battery charge history",
    "timeBucket": 3600,
    "bucketColumn": "bucketEnd",
    "bucketInitColumn": "bucketInit",
    "identifierColumn": "EntityID",
    "retention": 2592000,
    "origin": "2025-11-26T23:00:00Z",
    "context": [
      {
        "path": "provision.device.administrativeState",
        "name": "Administrative state",
        "sort": "true",
        "filter": "YES",
        "type": "string"
      }
    ],
    "columns": [
      {
        "path": "device.powersupply.battery.charge._current.value",
        "name": "Powersupply battery charge Current Value",
        "filter": "NO",
        "type": "number",
        "sort": false,
        "aggregationFunction": "FIRST"
      }
    ]
  },
  "data": {
    "bucketEnd": "2025-12-11T13:00:00+01:00",
    "bucketInit": "2025-12-11T12:00:00+01:00",
    "EntityID": "entity_1",
    "Powersupply battery charge Current Value": 34
  }
}
  • alarmData contains the data of the alarm opened in template
{
  "identifier": "270dd9f9-1396-4660-bb5f-8d8b471e1dcd",
  "name": "activityForbidden",
  "rule": "activityForbidden",
  "description": "Activity detected for an entity with administrative state disabled",
  "severity": "INFORMATIVE",
  "priority": "LOW",
  "organization": "organization_name",
  "channel": "default_channel",
  "entityIdentifier": "A_WORKER_1",
  "subEntityIdentifier": "A_WORKER_1",
  "resourceType": "ENTITY_ASSET",
  "status": "CLOSED",
  "openingDate": "2019-06-27T08:57:36+02:00",
  "closureDate": "2019-06-27T08:57:51+02:00"
}
  • filters introduced by the user. These filters are:
    • generic widget generic filter
    • period widget date period filter
    • column json object with each column filter
    • sort an array containing every sorted column with its direction sorted by user preferences
    • inherit json object with inherited filter if ‘shared filter’ is enabled. This filter is composed by ‘and’ filter that contains standar filter, private/template filter and headers filters from the source widget.

An example:

{
    "filters": {
        "generic": "filter introduced by the user",
        "period": {"from":"2023-03-27T10:59:27+02:00","to":null},
        "column": {
            [column value field]: {
                operator: "eq",
                value: "filter introduced by the user in colum"
            },
            [column value field]: {
                operator: "gt",
                value: "filter introduced by the user in colum"
            }
        },
        "sort": [
            {
                column: "column value field",
                direction: "asc" or "desc"
            },
            {
                column: "column value field",
                direction: "asc" or "desc"
            }
        ],
        "inherit": {
            "and": [
              { "eq": {"field.identifier._current.value": "value"}},
              { "eq": {"field2.identifier._current.value": "value2"}}
            ]
        }
    }
}
  • pageElements and page that determines the current page to display. Only enabled when server pagination enabled in table parameters. Disabling server pagination quits this parameters and function must be evaluated again.

  • callback function used to send table data only when the api/http petitions are promised

callback(data);

or

callback([{
  "field1": "value1",
  "field2": "value2"
}]);

Available utils

$api -> use it to create http petitions to OpenGate Api Rest doc

$user -> Logged user

Example:

{
    "email": "email@amplia.es",
    "workgroup": "workgroup",
    "domain": "domain",
    "profile": "profile",
    "countryCode": "ES",
    "langCode": "en",
    "timezone": "Europe/Madrid"
}

$moment -> use it to format date doc

console -> display messages in navigator console

Promise -> allows easy execution of multiple promises

http -> javascript encapsulation of useFetch (Nuxt 4) library doc

openDashboard -> (workspaceId, dashboardId, newPage) -> Opens the selected dashboard in selected workspace

openEntityDashboard -> (entityIdentifier[, organization[user if empty], resourceType[’entity.device’ if empty] , newPage]) -> Opens the entity’s temporary dashboard

Data format

Returned data must have one of the following formats (per item):

  • simple json data
{
    "jsonfield": "value to display. It can be HTML."
}
  • ‘complex’ json data
{
    "jsonfield": {
        "value": "value to display. It can be HTML",
        "_style": "cell custom style",
        "_chart": "displays an echarts chart. Overrides others in this item",
        "_extension": "jsonfield like (value, _style, _chart)  plus _table. Only enabled when expandable rows enabled"
    }
}

NOTE _extension field can combine _chart and _table elements in the same item

  • Element _chart Must have an echarts config json.

  • Element _table Displays a table inside the column and overrides others in this item.

{
    columns: ['each', 'item', 'is', 'a', 'column],
    data: [
        ['data 1', 'in', 'columns', 'order', { jsonfield (without _extension is supported) }],
        ['data 2', 'in', 'columns', 'order', { jsonfield (without _extension is supported) }]
    ]

}

Examples


Subsections of Custom Table

Custom Table Example

Code

function baState(value) {
  if (value) {
    var newValor;
    var style;
    var title;
    switch (value) {
      case "0":
        newValor = "(OK)🟢";
        style = 'color:green;';
        title = "Bateria OK";
        break;
      case "1":
        newValor = "(BAJA)🟡";
        style = 'color:yellow;';
        title = "Bateria BAJA";
        break;
      case "2":
        newValor = "(MUY BAJA)🟠";
        style = 'color:orange;';
        title = "Bateria MUY BAJA";
        break;
      case "3":
        newValor = "(AGOTADA)🔴";
        style = 'color:red;';
        title = "Bateria AGOTADA";
        break;
      default:
        newValor = "Error en el campo";
        break;
    }
    return {
      _style: style,
      value: "<div title='" + title + ">" + newValor + "</div>"
    };
  } else {
    return 'N/A';
  }
}

function bpaState(value) {
  var newValor;
  var title;
  var style;
  if (value) {
    switch (value) {
      case "0":
        newValor = "(OK)🟢";
        title = "Protección no activa";
        style = 'color:green;';
        break;
      case "1":
        newValor = "(ACTIVADA)🔴";
        title = "Protección activada";
        style = 'color:red;';

        break;
      default:
        newValor = "Error en el campo";
        break;
    }
    return {
      value: "<div title='" + title + "'>" + newValor + "</div>",
      _style: style
    };
  }
}

function boolState(value) {
  var newValor;
  var title;
  var style;
  if (value === true || value === false) {
    if (value) {
      newValor = "🔴";
      title = "TRUE";
      style = 'color:red;';
    } else {
      newValor = "🟢";
      title = "FALSE";
      style = 'color:green;';
    }
    return {
      value: "<div title='" + title + "'>" + newValor + "</div>",
      _style: style
    };
  }
}


console.log("--------------------------------------------");
var builder = $api.entitiesSearchBuilder().limit(1000).flattened();

var filter = {
  and: [
    {
      neq: {
        'provision.device.specificType': 'CONCENTRATOR'
      }
    }
  ]
};

if (entityData && entityData['provision.administration.identifier']) {
  var entityKey = entityData['provision.administration.identifier']._value._current.value;
  filter.and.push({
    eq: {
      'provision.Sector': entityKey
    }
  });
}

builder.filter(filter);

const response = await builder.build().execute();

var entities = [];
if (response.statusCode === 200) {
  response.data.entities.forEach(function (entityTmp) {
    var finalData;
    if (entityTmp['ba']) {
      finalData = {
        identifier: {
          value: entityTmp['provision.administration.identifier']._value._current.value,
          _style: 'margin-left: 4px;'
        }
      };
      finalData.tipo_alerta = 'Batería';
      finalData.estado = baState(entityTmp['ba']._value._current.value);
      finalData.fecha = new Date(entityTmp['ba']._value._current.at).toLocaleString();
      entities.push(finalData);
    }

    if (entityTmp['bpA']) {
      finalData = {
        identifier: {
          value: entityTmp['provision.administration.identifier']._value._current.value,
          _style: 'margin-left: 4px;'
        }
      };
      finalData.tipo_alerta = 'Protección Batería';
      finalData.estado = bpaState(entityTmp['bpA']._value._current.value);
      finalData.fecha =  new Date(entityTmp['bpA']._value._current.at).toLocaleString();
      entities.push(finalData);
    }

    if (entityTmp['ta']) {
      finalData = {
        identifier: {
          value: entityTmp['provision.administration.identifier']._value._current.value,
          _style: 'margin-left: 4px;'
        }
      };
      finalData.tipo_alerta = 'Tampering';
      finalData.estado = boolState(entityTmp['ta']._value._current.value);
      finalData.fecha = new Date( entityTmp['ta']._value._current.at).toLocaleString();
      entities.push(finalData);
    }

    if (entityTmp['fa']) {
      finalData = {
        identifier: {
          value: entityTmp['provision.administration.identifier']._value._current.value,
          _style: 'margin-left: 4px;'
        }
      };
      finalData.tipo_alerta = 'Fuga';
      finalData.estado = boolState(entityTmp['fa']._value._current.value);
      finalData.fecha =  new Date(entityTmp['fa']._value._current.at).toLocaleString();
      entities.push(finalData);
    }

  });
}

return entities;

External API (USGS Earthquakes)

Static content

This example demonstrates how to fetch data from the USGS Earthquake Hazards Program API. This service supports server-side date filtering, which aligns perfectly with the widget’s Period Filter.

Function Explanation

  1. Date Filtering: The code checks the filters.period object.
    • If from and to are present, they are formatted to ISO 8601 strings (YYYY-MM-DD) and sent as starttime and endtime parameters.
    • If no period is selected, it defaults to the last 24 hours.
  2. Name/Text Filtering: The filters.generic (search text) is used to filter the results client-side (searching within the place field), as the API does not support a direct “text search” parameter for this endpoint.

Code

// Main function executed by the Custom Table widget
// parameters: entityData, filters, page, pageElements, callback

// Base URL for USGS Earthquake API (GeoJSON format)
let url = 'https://earthquake.usgs.gov/fdsnws/event/1/query?format=geojson&limit=200';

// 1. Handle Date Filters (Server-Side)
if (filters && filters.period && filters.period.from && filters.period.to) {
  // Helper to format date as YYYY-MM-DD
  const formatDate = (dateStr) => new Date(dateStr).toISOString().split('T')[0];
  
  const start = formatDate(filters.period.from);
  const end = formatDate(filters.period.to);
  
  url += `&starttime=${start}&endtime=${end}`;
} else {
  // Default to 'now' if no filter (API defaults to last 30 days usually, let's limit to recent)
  // Actually, let's explicitely ask for last 2 days to keep data manageable if no filter
  // But for simplicity, we rely on the API defaults or a 'limit' param already added above.
}

try {
  // 2. Fetch Data
  const response = await http(url);
  
  let features = [];
  if (response && response.features) {
      features = response.features;
  } else if (response && response.json) {
      const json = await response.json();
      features = json.features || [];
  }

  // 3. Handle Name/Text Filter (Client-Side)
  // filtering by 'place' property
  if (filters && filters.generic && filters.generic.length > 0) {
    const search = filters.generic.toLowerCase();
    features = features.filter(f => 
      f.properties.place && f.properties.place.toLowerCase().includes(search)
    );
  }

  // 4. Map to Table Columns
  // Configured Columns hint: 'place', 'magnitude', 'time', 'status'
  const tableData = features.map(f => {
    const props = f.properties;
    const dateObj = new Date(props.time);
    
    // Determine color based on magnitude
    let magColor = 'green';
    if (props.mag >= 5) magColor = 'red';
    else if (props.mag >= 3) magColor = 'orange';

    return {
      place: props.place,
      magnitude: {
          value: props.mag ? props.mag.toFixed(1) : '0.0',
          _style: `font-weight:bold; color: ${magColor};`
      },
      time: dateObj.toLocaleString(),
      status: `<a href="${props.url}" target="_blank">Ver Detalles</a>`
    };
  });

  callback(tableData);

} catch (error) {
  console.error("Error fetching earthquake data:", error);
  callback([]);
}

Filtered Entity Retrieval

Description

This example shows how to retrieve entities filtering by a parameter and sorting by name.

Code

/**
 * Main function to retrieve and display entities
 * @param {Object} entityData - Context entity data
 * @param {Object} filters - Filters passed from the widget
 */

var builder = $api.entitiesSearchBuilder().limit(100).flattened();

// 1. Filter by parameter (assuming it comes in filters.generic or a specific field)
// Here we assume filters.generic contains a string to filter by name
if (filters && filters.generic) {
    builder.filter({
        like: {
            'provision.asset.name': filters.generic // Adjust field as needed (e.g., provision.device.name)
        }
    });
}

// 2. Sort by name
builder.sort([
    {
        column: 'provision.asset.name',
        direction: 'asc'
    }
]);

// 3. Execute query
var response = await builder.build().execute();

// 4. Transform results
var results = [];
if (response && response.data && response.data.entities) {
    response.data.entities.forEach(function(entity) {
            // Extract identifier (using bracket notation for flattened keys)
        var id = entity['provision.administration.identifier'] ? entity['provision.administration.identifier']._value._current.value : "Unknown";
        
        // Extract name (handle if it doesn't exist)
        var name = "N/A";
        if (entity['provision.asset.name']) {
            name = entity['provision.asset.name']._value._current.value;
        }

        results.push({
            identifier: id,
            name: name
        });
    });
}

return results;

Server Pagination Example (Reqres)

Static content

This example demonstrates how to implement server-side pagination using an external API (reqres.in). When “Server Pagination” is enabled in the widget configuration, the script receives page and pageElements parameters.

Function Explanation

  1. Page Parameters: The page and pageElements arguments act as the current page number and the page size (limit), respectively.
  2. API Request: The code constructs a request to reqres.in passing page and per_page query parameters.
  3. Callback: The function processes the response and sends the array of users to the widget via the callback.

Code

// Main function executed by the Custom Table widget
// parameters: entityData, filters, page, pageElements, callback

// 1. Prepare Pagination Parameters
// Ensure we have defaults if arguments are missing (safeguard)
const currentPage = page || 1;
const perPage = pageElements || 5;

// 2. Construct URL with pagination params
// reqres.in uses 'page' (1-based) and 'per_page'
const url = `https://reqres.in/api/users?page=${currentPage}&per_page=${perPage}`;

try {
  // 3. Fetch Data
  const response = await http(url);
  
  // 4. Extract Data
  // reqres.in returns: { page: 1, per_page: 6, total: 12, total_pages: 2, data: [...] }
  let users = [];
  
  // Check various response wrappers as 'http' might auto-parse JSON
  if (response && response.data && Array.isArray(response.data)) {
      users = response.data;
  } else if (response && response.json) {
      const json = await response.json();
      users = json.data || [];
  } else if (response && Array.isArray(response)) {
      users = response;
  }

  // 5. Format for Table
  // Configured Columns hint: 'id', 'avatar', 'first_name', 'last_name'
  const tableData = users.map(user => {
    return {
      id: user.id,
      avatar: `<img src="${user.avatar}" style="width: 30px; border-radius: 50%;">`,
      first_name: user.first_name,
      last_name: user.last_name,
      email: user.email
    };
  });

  // 6. Return Data
  // We return the array of items for the current page.
  callback(tableData);

} catch (error) {
  console.error("Error fetching paged data:", error);
  callback([]);
}

Battery Level Pie Chart

Description

This example shows how to retrieve entities and display their battery level as a Pie Chart within the table row.

Code

var builder = $api.entitiesSearchBuilder().limit(100).flattened();

// Handle generic filter if present
if (filters && filters.generic) {
    builder.filter({
        like: {
            'provision.administration.identifier': filters.generic
        }
    });
}

var response = await builder.build().execute();

var results = [];
if (response && response.data && response.data.entities) {
    response.data.entities.forEach(function(entity) {
        // Get identifier
        var id = entity['provision.administration.identifier'] ? entity['provision.administration.identifier']._value._current.value : "Unknown";
        
        // Get battery charge (default to 0 if not present)
        var charge = 0;
        if (entity['device.powersupply.battery.charge']) {
            charge = entity['device.powersupply.battery.charge']._value._current.value;
        }

        // Create the chart configuration
        var pieOption = {
            color: ['#91c7ae', '#c23531'],
            series: [
                {
                    type: 'pie',
                    radius: ['50%', '70%'],
                    avoidLabelOverlap: false,
                    label: {
                        show: false,
                        position: 'center'
                    },
                    emphasis: {
                        label: {
                            show: true,
                            fontSize: '10',
                            fontWeight: 'bold'
                        }
                    },
                    labelLine: {
                        show: false
                    },
                    data: [
                        { value: charge, name: 'Charge' },
                        { value: 100 - charge, name: 'Empty' }
                    ]
                }
            ]
        };

        results.push({
            identifier: id,
            battery: {
                "_chart": pieOption,
                "_style": "height: 50px; width: 50px;" // Optional styling for the cell
            }
        });
    });
}

return results;

Open HMI/Custom Image

Programmable HMIs allow for the construction and modification of the interface.

How it Works

Open HMI widget

Once the logic for data retrieval and SVG painting/modification has been entered, it will be displayed on the widget.

What distinguishes this widget from the original HMI is that data sources can be external, and the widget’s content is built/modified through coding.

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

  • SVG Content allows you to input the source code of an SVG as a starting point. The SVG content can be manipulated with the svgDom object of the editor. Content can either be entered directly or by selecting a file.
  • CSS Content allows you to apply styles to the SVG. Content can be entered directly or by selecting a file.
  • Preview shows a live preview resulting from the combination of the previously entered values, without running any code.
Open HMI general configuration

Code Tab

This is where you enter the code required for SVG manipulation. It is not necessary to enter code, but you must at least return the svgDom object for it to be able to render.

Open HMI code configuration

For SVG manipulation, standard HTML manipulation libraries will be used. Interactions can also be added to the SVG itself to integrate it with the platform’s data, linking it to device data and providing access to it.

Every time the code is updated, it must be evaluated, where a preview of the result will be shown. For this preview, the entered code is indeed evaluated, so the outcome will vary based on its execution.

Open HMI code preview

Available utils

$api -> use it to create http petitions to OpenGate Api Rest doc

$user -> Logged user

Example:

{
    "email": "email@amplia.es",
    "workgroup": "workgroup",
    "domain": "domain",
    "profile": "profile",
    "countryCode": "ES",
    "langCode": "en",
    "timezone": "Europe/Madrid"
}

$moment -> use it to format date doc

console -> display messages in navigator console

Promise -> allows easy execution of multiple promises

http -> javascript encapsulation of useFetch (Nuxt 4) library doc

alert -> javascript alert function

document -> javascript document object

domParser -> javascript DOMParser object

showPopup -> shows options for the selected entity: showPopup(entityId[,datastreamId])

Function

Depending of the configuration receives the following parameters:

  • entityData contains the data of the opened entity NOTE: only available when the user opens an entity dashboard template

Example:

{
  "provision.administration.identifier": {
    "_value": {
      "_current": {
        "value": "device_1"
      }
    }
  },
  "provision.administration.organization": {
    "_value": {
      "_current": {
        "value": "organization_name"
      }
    }
  },
  "provision.administration.channel": {
    "_value": {
      "_current": {
        "value": "channel_name"
      }
    }
  },
  "provision.administration.serviceGroup": {
    "_value": {
      "_current": {
        "value": "service_group_name"
      }
    }
  }
}
  • relatedEntities contains an array of entities related to the entity selected. NOTE: only available when the user opens an entity dashboard template

Example:

[{
  "provision.administration.identifier": {
    "_value": {
      "_current": {
        "value": "related_1"
      }
    }
  },
  "provision.administration.organization": {
    "_value": {
      "_current": {
        "value": "organization_name"
      }
    }
  },
  "provision.administration.channel": {
    "_value": {
      "_current": {
        "value": "channel_name"
      }
    }
  },
  "provision.administration.serviceGroup": {
    "_value": {
      "_current": {
        "value": "service_group_name"
      }
    }
  }
}]
  • timeserieData contains info about the timeserie opened by the user
    • config timeserie configuration
    • data timeserie row selected

NOTE: only available when the user opens an entity dashboard template from timeserie table widget

An example:

{
  "config": {
    "identifier": "69281dc43545e97df66c42a1",
    "name": "Battery charge history",
    "timeBucket": 3600,
    "bucketColumn": "bucketEnd",
    "bucketInitColumn": "bucketInit",
    "identifierColumn": "EntityID",
    "retention": 2592000,
    "origin": "2025-11-26T23:00:00Z",
    "context": [
      {
        "path": "provision.device.administrativeState",
        "name": "Administrative state",
        "sort": "true",
        "filter": "YES",
        "type": "string"
      }
    ],
    "columns": [
      {
        "path": "device.powersupply.battery.charge._current.value",
        "name": "Powersupply battery charge Current Value",
        "filter": "NO",
        "type": "number",
        "sort": false,
        "aggregationFunction": "FIRST"
      }
    ]
  },
  "data": {
    "bucketEnd": "2025-12-11T13:00:00+01:00",
    "bucketInit": "2025-12-11T12:00:00+01:00",
    "EntityID": "entity_1",
    "Powersupply battery charge Current Value": 34
  }
}
  • alarmData contains the data of the alarm opened in template
{
  "identifier": "270dd9f9-1396-4660-bb5f-8d8b471e1dcd",
  "name": "activityForbidden",
  "rule": "activityForbidden",
  "description": "Activity detected for an entity with administrative state disabled",
  "severity": "INFORMATIVE",
  "priority": "LOW",
  "organization": "organization_name",
  "channel": "default_channel",
  "entityIdentifier": "A_WORKER_1",
  "subEntityIdentifier": "A_WORKER_1",
  "resourceType": "ENTITY_ASSET",
  "status": "CLOSED",
  "openingDate": "2019-06-27T08:57:36+02:00",
  "closureDate": "2019-06-27T08:57:51+02:00"
}
  • svgDom DOMElement object that contains the root element of the SVG (this object always will be a clean svg element)

If SVG content not filled in configuration you may consider that default viewPort for svg will be: 0 0 100 100 (upgradable)

Every svg will be setted with width and height to 100% and auto respectively

  • callback function used to return data when the api/http petitions are promised. Use “return” if not using promises.

Example:

callback(svgDom);

or

return svgDom;
Final code structure build by the application
async function main(entityData,alarmData,relatedEntities,timeserieData,svgDom,callback) {
  // YOUR CODE HERE WITH RETURN OR CALLBACK
}

Examples


Subsections of Open HMI/Custom Image

Time-based SVG

Code

// Determine shape and color based on current milliseconds
const now = new Date();
const milliseconds = now.getMilliseconds();

// If milliseconds is even, draw a green circle. Else, a crimson rectangle.
const isEven = milliseconds % 2 === 0;
const color = isEven ? 'green' : 'crimson';
const shapeType = isEven ? 'circle' : 'rect';

console.log(`Milliseconds: ${milliseconds}. Drawing ${color} ${shapeType}.`);

try {
    // 1. Clear existing SVG content
    while (svgDom.firstChild) {
        svgDom.removeChild(svgDom.firstChild);
    }

    // 2. Create the new geometric shape
    const shape = document.createElementNS("http://www.w3.org/2000/svg", shapeType);

    if (shapeType === 'circle') {
        shape.setAttribute('cx', '50');
        shape.setAttribute('cy', '50');
        shape.setAttribute('r', '40');
    } else {
        shape.setAttribute('x', '10');
        shape.setAttribute('y', '10');
        shape.setAttribute('width', '80');
        shape.setAttribute('height', '80');
    }

    shape.setAttribute('fill', color);
    shape.setAttribute('stroke', 'black');
    shape.setAttribute('stroke-width', '2');

    // 3. Add text label
    const text = document.createElementNS("http://www.w3.org/2000/svg", "text");
    text.setAttribute('x', '50');
    text.setAttribute('y', '50');
    text.setAttribute('dominant-baseline', 'middle');
    text.setAttribute('text-anchor', 'middle');
    text.setAttribute('fill', 'white');
    text.setAttribute('font-family', 'Arial');
    text.setAttribute('font-size', '12');
    text.textContent = `ms: ${milliseconds}`;

    // 4. Append elements to SVG
    svgDom.appendChild(shape);
    svgDom.appendChild(text);

} catch (err) {
    console.error("Error in Open HMI script:", err);
    
    // Fallback display in SVG
    const text = document.createElementNS("http://www.w3.org/2000/svg", "text");
    text.setAttribute('x', '10');
    text.setAttribute('y', '20');
    text.setAttribute('fill', 'red');
    text.textContent = "Error executing script";
    svgDom.appendChild(text);
}

// Return the modified DOM
return svgDom;

Browsers

Subsections of Browsers

Certificates Browser

The certificate browser allows you to view/manage the different certificates available to my organization.

How it works

From the browser, you can view the certificates provided by Opengate as well as those managed directly by my organization.

Certificates Browser

Widget Menu

Certificates Browser Actions

From the action menu of the widget, you can perform the following:

  • New certificate: launches the certificate configuration wizard as long as you have the necessary permissions.
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Certificate Details

Certificate Details

To view the details of a certificate, clicking on the arrow located to the right of each will enable the details panel.

Actions per Certificate

Certificate Actions

The following are the possible actions to perform for each of the organization’s own certificates.

  • Download allows you to download the selected certificate
  • Edit enables the editing of a certificate, including uploading an updated version of it
  • Delete deletes the selected certificate

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters


Configured Operations Navigator

The Operation Types browser allows you to view and manage the operations that have been configured for your organization.

How it Works

Each of the configured operations will be displayed in the browser along with some details about them, such as the type of operation and the types of entities to which they apply.

Operation Types Browser

Widget Menu

Operation Types Browser Actions

From the action menu of the widget, it will be possible to do the following:

  • Operations wizard: allows you to run the creation wizard for a new type of operation (provided you have the necessary permissions).
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Actions by Operation Type

Operation Type Actions

The following are the possible actions that can be performed for each of the configured operations:

  • Edit: Opens the operation configurator to change various parameters.
  • Remove: Deletes the selected operation.

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters


Connector functions browser

In this widget, you will find the connector functions configured for your organization.

How it works

Connector Functions Browser

In the browser, you will find a list of connector functions along with the actions available for each one, depending on the permissions you have.

Next to the name, you can find the type of connector function as well as its operational status.

By pressing expand button you can see criteria selectors for each item.

Widget Menu

Connector Functions Browser Actions

From the action menu of the widget, it will be possible to do the following:

  • New connector function: allows you to run the creation wizard for connector functions (provided you have the necessary permissions).
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Channel Selector

A user can manage connector functions for those channels that are dependent on the user’s organization. To switch between channels, you can use the selector available at the top of the widget.

Actions on Connector Functions

Connector Functions Browser Connector Functions Actions

For each connector function, you can perform the following actions:

  • Logger: opens a new window showing execution logs for the connector function.
  • Edit: opens the editing wizard to change the parameters of the element.
  • Clone: opens the creation wizard with a copy of the element’s data.
  • Delete: removes the element.
  • Expand: toggle criteria selectors display.

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters


Data models Browser

From the data models browser, you can view/modify the data models of your organization, allowing for customization of entity data on the platform.

How it Works

Data Models Browser

Widget Menu

Data Models Browser Actions

The following actions can be performed directly from the widget:

  • New Datamodel: Launches the data models configuration wizard, provided the necessary permissions are available.
  • Editable/All: Toggles between displaying all data models (both inherited from catalog and own) or only the editable ones (those owned by you, which can be deleted).
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Data Model Details

Data Model Tree

To view the data streams of a data model, click on the arrow located to the right of each one to enable the navigation panel. The first level will display the categories followed by the data streams assigned to each of them.

Actions per Data Model

Data Model Actions

The following are the possible actions that can be performed for each of the organization’s own data models:

  • Download: Allows downloading of the selected data model.
  • Edit: Enables editing of a data model.
  • Remove: Deletes the selected data model (only those that are not inherited).

Configuration

Data Model Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

  • Items Per Page: Indicates the number of data models that will be displayed per page while navigating.
  • Search by All Organizations: When enabled, the widget will display all data models from all my organizations.

Data sets Browser

In this widget, you will find the data sets configured for your organization.

How it Works

Data Sets Browser

In the browser, you will find a list of data sets along with the available actions for each, based on the permissions you have.

Widget Menu

Data Sets Browser Actions

From the action menu of the widget, you can perform the following:

  • New Data Set: This allows you to run the data set creation wizard (provided you have the necessary permissions).
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Organization Selector

A user can manage the data sets for those organizations that are dependent on the user’s own organization. To switch between organizations, you must select it from the selector available at the top of the widget.

Actions on Data Set

Data Sets Browser Data Set Actions

For each data set, you can perform the following actions:

  • View Data: This will open a list widget where you can view the data of the selected data set.
  • Edit: Allows you to initiate a data set update wizard with the configuration data of the current one.
  • Clone: Allows you to initiate a data set creation wizard with the configuration data of the current one.
  • Columns: Displays, within the widget itself, the columns configured for the data set.
  • Delete: Removes the selected data set and all its associated data.

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters


Device Plans Browser

In this widget, you can navigate through different device plans within your organization. Actions can be performed on each of the identifying elements within each organization.

How it Works

By selecting an organization, the plans belonging to it will be displayed in the browser, showing some details about them.

Device Plans Browser

Widget Menu

Device Plans Actions

From the widget’s action menu, you can perform the following:

  • New Device Plan: Allows the execution of the wizard for creating a new plan (provided the necessary permissions are available).
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Device Plans Actions

Device Plans Actions

The following are the actions that can be performed on each plan:

  • Edit: Opens device plans wizard in order to edit the selected plan.
  • Clone: Opens device plans wizard in order to clone the selected plan.
  • Remove: Removes the selected plan.

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters


Entities Software Browser

Here, you can consult and/or manage the software of your organizations.

How it Works

Organization Software Widget

Widget Menu

Organization Software Actions

From the action menu of the widget, it will be possible to do the following:

  • New software: allows you to run the creation wizard for organization software (provided you have the necessary permissions).
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Actions by Software

Organization Software item Actions

The following are the possible actions to be taken for each software:

  • Edit: Opens the organization software wizard where you can change the software details.
  • Remove: Deletes the selected software. This action allows you to delete references in devices by selecting “Delete all”. Another confirmation popup will be opened.

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

  • Items per Page: Configures the number of software items to be displayed per page.
Organization Software Configuration

Image Execution Scheduler Browser

The Image Execution Scheduler Browser allows you to view/manage the image execution schedulers configured in your organization.

How it Works

Each image execution scheduler will be displayed in the browser, showing some details about them such as the type of image execution scheduler and the configuration mode used.

Image Execution Scheduler Browser

Widget Menu

Image Execution Scheduler Actions

From the widget’s action menu, you can perform the following:

  • Executions history: Shows the executions history for all image execution scheduled.
  • Image Execution Scheduler wizard: Allows the execution of the wizard for creating a new image execution scheduler (provided the necessary permissions are available).
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Actions per Image Execution Scheduler

Image Execution Scheduler Actions

The following are the possible actions to be performed for each of the schedulers:

  • History opens image execution executions history in a modal.
  • Clone will open the image execution scheduler wizard for creating a new image execution scheduler that will contain the configuration of the selected one.
  • Remove deletes the selected scheduler.

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters


Manufacturers and Models Browser

Here, you can consult and/or manage the manufacturers and models on the platform.

How it Works

Manufacturers and Models Widget

Widget Menu

Manufacturers and Models Actions

From the action menu of the widget, it will be possible to do the following:

  • New manufacturer: allows you to run the creation wizard for manufacturer (provided you have the necessary permissions).
  • New model: allows you to run the creation wizard for manufacturer model (provided you have the necessary permissions).
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Any changes made will affect all organizations; therefore, maintenance is restricted to platform administrators.

Actions by Manufacturer

Manufacturers and Models Actions

The following are the possible actions to be taken for each manufacturer:

  • Images: If the manufacturer has attached images, this option will be displayed to view them in full screen.
  • New Model: Opens the model creation wizard with the selected manufacturer pre-filled.
  • Edit: Opens the manufacturer wizard where you can change the manufacturer’s details.
  • Remove: Deletes the selected manufacturer as well as all the models associated with it.

By clicking the expand button, you can see the manufacturer’s details as well as a list of all available models, if any exist.

Actions by Model

Manufacturers and Models Model Actions

The following are the possible actions for each of the available models for the manufacturer:

  • Change Manufacturer: Allows you to directly move the model to another manufacturer.
  • Edit: Opens the model configuration wizard to change its parameters.
  • Remove: Deletes the selected item.

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

  • Items per Page: Configures the number of manufacturers to be displayed per page.
Manufacturers and Models Code Configuration

Notebooks scheduler

The notebooks scheduler allows you to execute and manage schedulers for datalab notebooks

How it works

From the browser, you can view the notebooks created in Opengate Data lab

Notebooks Scheduler

Widget Menu

Notebooks Scheduler Actions

From the action menu of the widget, it will be possible to do the following:

  • New notebook scheduler: allows you to run the notebook scheduler wizard
  • Open Opengate Datalab: allows you to open the Opengate Datalab tool if available
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Notebook actions

Notebooks Scheduler Actions

The following are the possible actions to perform for each of the organization’s own certificates.

  • Execute allows you to execute once the selected notebook (same as scheduler but without time settings)
  • Open in datalab opens notebook in the Opengate Datalab tool
  • Schedule opens notebook scheduler wizard in order to create a new schedule
  • Schedulers lists available schedulers for the selected notebook

For each scheduler you can do the following

  • Scheduler identifier for scheduler
  • Report shows if execution generates report
  • Report retention days days to expire report
  • Parameters list of configured parameters
  • Last execution date last time scheduler runs
  • Next execution date date for the next execution
  • Cron pattern

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters


Organization Plans Browser

In this widget, you can navigate through different plans within your organization. Actions can be performed on each of the identifying elements within each organization.

How it Works

By selecting an organization, the plans belonging to it will be displayed in the browser, showing some details about them.

Organization Plans Browser

Widget Menu

Organization Plans Actions

From the widget’s action menu, you can perform the following:

  • New Organization Plan: Allows the execution of the wizard for creating a new plan (provided the necessary permissions are available).
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Organization Plans Actions

Organization Plans Actions

The following are the actions that can be performed on each plan:

  • Edit: Opens organization plans wizard in order to edit the selected plan.
  • Clone: Opens organization plans wizard in order to clone the selected plan.
  • Remove: Removes the selected plan.

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters


Organizations Browser

In this widget, you can navigate through different organizations within your own. Actions can be performed on each of the identifying elements within each organization.

How it Works

Organization Actions

Organization Actions

The following are the actions that can be performed on the selected organization:

  • Edit: Allows management of the organization data.
  • New Suborganization: Creates a new organization under the current organization.
  • New Workgroup: Opens the workgroup wizard filtered by the selected organization.
  • New Channel: Opens the channels wizard filtered by the selected organization.
  • Open Users List: Opens a user list widget in a popup, filtered by the selected organization.
  • Open Entities List: Opens an entities list widget in a popup, filtered by the selected organization.
  • Remove: Deletes the current organization.

Channels

From the Channels tab, you can see which channels exist for that organization and perform actions on them.

Organization Channels

The following are the actions that can be performed:

Organization Channels Actions
  • Edit: Allows management of the channel data.
  • New Entity: Opens the entity wizard to create a new one in this channel.
  • New Asset: Opens the asset wizard to create a new one in this channel.
  • Remove: Deletes the current channel.

Workgroups

From the Workgroups tab, you can see which workgroups exist for that organization and perform actions on them.

Organization Workgroups

The following are the actions that can be performed:

Organization Workgroups Actions
  • Edit: Allows management of the workgroup data.
  • Open Users List: Opens a user list widget in a popup, filtered by the selected organization.
  • New User: Opens the users wizard to create a new one in this workgroup.
  • Remove: Deletes the current workgroup.

You can navigate directly to the desired organization in the organizations tree.

Organization Tree

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters


Periodic Operations Browser

In this widget, you can view/manage the periodic operations configured within the organization.

How it Works

Periodic Operations Browser

The browser will display the name assigned to the periodic operation as well as its current status and the type of operation it performs.

Widget Menu

Periodic Operations Browser Actions

From the action menu of the widget, the following activities can be performed:

  • Download: Allows you to download the list of available periodic operations.
  • Download Page: Enables you to download the list of periodic operations that are visible at that moment.
  • Execute Operation: Opens the wizard to execute a new operation, provided the necessary permissions are available.
  • Toggle Selection: Allows you to toggle the selection of tasks using checkboxes. This enables you to view in other compatible widgets the content filtered by this information.
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

At the top of the widget, the following options are available:

  • Selection Edit: Displays the elements selected by the user and allows for their quick removal.
  • Show Active (Toggle): Instructs the widget to display only those operations that are currently active, rather than all of them.

Actions on Periodic Operations

Periodic Operations Actions

For each periodic operation, you can perform the following actions:

  • Active Switch: Enables you to activate/deactivate the periodic operation (required for changing its parameters).
  • Summary: Displays a panel containing details of the periodic operation.
  • Operations List: Opens a widget that lists operations executed by the selected periodic operation.
  • Cancel: Cancels the periodic operation so that it will not be executed again. This requires it to be deactivated.

Configuration

Periodic Operations Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

  • Items per Page: Specifies the number of elements to be displayed per page.

Periodic operations calendar

In this widget, you can view the executions of periodic operations in a calendar format.

How it Works

Periodic Operations Calendar

The calendar for periodic operations will display the operations that correspond to the selected periodicities.

Widget Menu

Periodic Operations Calendar Actions

From the widget’s action menu, it will be possible to perform the following:

  • Execute Operation: Opens the wizard to execute a new operation, provided the necessary permissions are available.
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

In the widget’s toolbar, we find the following options (in order of appearance):

Periodic Operations Calendar Actions
  • Today (Button): Allows quick navigation to the current day on the calendar.
  • Previous/Next Arrows (Buttons): Navigate to the previous/next item in the current calendar depending on its type.
  • Current Month: Displays the month and year of the calendar being viewed.
  • Selected Tasks List: A list of tasks selected for display on the calendar.
  • Tasks List: Opens a widget with a list of configured periodic operations. This is used to select what to display on the calendar.
  • Zoom In/Out (Buttons): Controls the zoom level of the displayed data.
  • Period Selector: Allows the selection of the period to be displayed.
Periodic Operations Calendar Actions

The different periods to be displayed are:

  • Day: Displays all planned and executed operations for the selected periodic operations.
  • Day/Operation: Displays all planned and executed operations for the selected periodic operations, allocating a column for each periodicity.
  • Week: Displays all operations planned for the selected week.
  • Month: Displays all operations planned for the selected month.

Actions on Periodic Operations

Periodic Operations Calendar Actions

By clicking on an operation, you can view its configuration data.

The displayed information is categorized as follows:

  • Execution Details: Here the summary of the selected operation is shown.
  • Parameters: Displays the operation’s parameters.
  • Configured Times: Details the times set for the operation.
  • Scheduled: Displays the periodicity settings for the operation.

If the selected item has already been executed, the following additional data will be displayed:

  • Execution Details: Here the summary of the executed operation is shown.
  • Parameters: Displays the operation’s parameters.
  • Timing: Details the timing of the operation.
  • Result: Provides a summary of how the operation has transpired.

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters


Pipeline Scheduler Browser

The Pipeline Scheduler Browser allows you to view/manage the pipeline schedulers configured in your organization.

How it Works

Each pipeline scheduler will be displayed in the browser, showing some details about them such as the type of pipeline scheduler and the configuration mode used.

Pipeline Scheduler Browser

Widget Menu

Pipeline Scheduler Actions

From the widget’s action menu, you can perform the following:

  • Executions history: Shows the executions history for all pipeline scheduled.
  • Pipeline Scheduler wizard: Allows the execution of the wizard for creating a new pipeline scheduler (provided the necessary permissions are available).
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Actions per Pipeline Scheduler

Pipeline Scheduler Actions

The following are the possible actions to be performed for each of the schedulers:

  • History opens pipeline executions history in a modal.
  • Clone will open the pipeline scheduler wizard for creating a new pipeline scheduler that will contain the configuration of the selected one.
  • Remove deletes the selected scheduler.

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters


Provisioning Functions Navigator

In this widget, you will find the provisioning functions configured for your organization.

How it Works

Provision Processors Browser

In the browser, you will find a list of provisioning functions along with the available actions for each, depending on the permissions you hold.

Widget Menu

Provision Processors Browser Actions

From the widget’s action menu, you can perform the following:

  • New provision function: Allows the execution of the wizard for creating provisioning functions (provided the necessary permissions are available).
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Organization Selector

A user can manage the provisioning functions for organizations that are dependent on the user’s own organization. To switch between organizations, you must use the selector available at the top of the widget.

Actions on Time Series

Provision Processors Browser Provision Processors Actions

For each time series, you can perform the following actions:

  • Edit: Opens the editing wizard to modify the parameters of the provisioning function.
  • Summary: Displays information on the configuration of the provisioning function within the widget itself.
  • Delete: Removes the selected item.

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters


Rest Request Scheduler Browser

The Rest Request Scheduler Browser allows you to view/manage the rest request schedulers configured in your organization.

How it Works

Each rest request scheduler will be displayed in the browser, showing some details about them such as the type of rest request scheduler and the configuration mode used.

Rest Request Scheduler Browser

Widget Menu

Rest Request Scheduler Actions

From the widget’s action menu, you can perform the following:

  • Executions history: Shows the executions history for all rest request scheduled.
  • Rest Request Scheduler wizard: Allows the execution of the wizard for creating a new rest request scheduler (provided the necessary permissions are available).
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Actions per RestRequest

Rest Request Scheduler Actions

The following are the possible actions to be performed for each of the schedulers:

  • History opens rest request executions history in a modal.
  • Clone will open the rest request scheduler wizard for creating a new rest request scheduler that will contain the configuration of the selected one.
  • Remove deletes the selected scheduler.

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters


Rules Configuration Browser

The Rules Browser allows you to view/manage the rules configured in your organization.

How it Works

Each rule will be displayed in the browser, showing some details about them such as the type of rule and the configuration mode used.

Rules Browser

Widget Menu

Rules Browser Actions

From the widget’s action menu, you can perform the following:

  • Rules wizard: Allows the execution of the wizard for creating a new rule (provided the necessary permissions are available).
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Additionally, you can toggle between active and inactive rules to facilitate sampling according to needs.

Channel Selector

A user can manage the connector functions for those channels that depend on the user’s organization. To switch between channels, you must use the selector available at the top of the widget.

Actions per Rule

Rule Actions

The following are the possible actions to be performed for each of the rules:

  • Activation toggle allows the immediate activation and deactivation of the rule.
  • Edit opens the rules configurator to modify the parameters of the rule.
  • Clone will open the rules configurator for creating a new rule that will contain the configuration of the selected one.
  • Remove deletes the selected rule.

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters


Specific types Browser

In this widget, you will find the Specific types configured for your organization.

How it Works

In the browser, you will find a list of Specific types along with the available actions for each, based on the permissions you have.

Browser allows to view the data in 2 different modes:

  • Grid: shows the complete list of specific types with the resource types supported in a grid of checkboxes (default view) Specific types Browser Grid

  • List: shows a list with the different resource types and their supported specific types. Specific types Browser List

Widget Menu

Specific types Browser Actions

From the action menu of the widget, you can perform the following:

  • Capture screen: Takes a screenshot of the widget.

  • Duplicate widget: Creates a duplicate of the widget on the dashboard.

  • Copy widget: Copies the widget to another dashboard.

  • Change widget location: Moves the widget to another dashboard.

  • Edit opens Specific Type manager modal.

Organization Selector

A user can manage the Specific types for those organizations that are dependent on the user’s own organization. To switch between organizations, you must select it from the selector available at the top of the widget.

Actions on Specific types

Specific types Browser Edit

A user with privileges can add new Specific Types and edit and/or delete existing ones. Every Specific Type must have one resource type selected and cannot be duplicated.

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters


Time Series Browser

In this widget, you will find the time series configured for your organization.

How it Works

Time Series Browser

In the browser, you will find a list of time series along with the available actions for each, depending on the permissions you hold.

Widget Menu

Time Series Browser Actions

From the widget’s action menu, you can perform the following:

  • New time series: Allows the execution of the wizard for creating new time series (provided the necessary permissions are available).
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Organization Selector

A user can manage the time series for organizations that are dependent on the user’s own organization. To switch between organizations, you must use the selector available at the top of the widget.

Actions on Time Series

Time Series Browser Time Series Actions

For each time series, you can perform the following actions:

  • View data: Opens a time series listing widget where you can view the data of the selected time series.
  • Edit: Initiates a wizard for editing the time series using the configuration data of the current one.
  • Clone: Initiates a wizard for creating a new time series using the configuration data of the current one.
  • Columns: Displays within the widget itself information on the time series configuration as well as the configured columns.
  • Delete: Removes the selected time series and all its data.

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters


Time series function Browser

In this widget, you will find the time series functions configured for your organization.

How it Works

Time Series function Browser

In the browser, you will find a list of time series functions along with the available actions for each, based on the permissions you have.

You can see this information for each function:

  • Name: function name
  • Origin: who provides the function. It can be PLATFORM (product preconfigured) and ORGANIZATION (user created).
  • Value Types: input value types allowed by the function
  • Description: the function algorithm description

Widget Menu

Time Series function Browser Actions

From the action menu of the widget, you can perform the following:

  • New Time Series Function: This allows you to run the time series function creation wizard (provided you have the necessary permissions).
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Organization Selector

A user can manage the time series functions for those organizations that are dependent on the user’s own organization. To switch between organizations, you must select it from the selector available at the top of the widget.

Actions on Time Series Function

Time Series function Browser time series function Actions

For each time series function, you can perform the following actions:

  • Clone: Allows you to initiate a time series function creation wizard with the configuration data of the current one.
  • Edit: Allows you to initiate a time series function update wizard with the configuration data of the current one. Only ORGANIZATION functions.
  • Delete: Removes the selected time series function and all its associated data. Only ORGANIZATION functions.

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters


Subsections of Charts

Data Stream history

Graphical representation of data stream information

How it works

Data Streams History widget

Widget Menu

Data Streams History Actions

From here, the following actions can be performed:

  • Open device information allows for the opening of a temporary dashboard associated with the selected entity
  • Edit allows the editing of the selected entity
  • Historical data displays the chart data in a list format (requires selecting a grouping parameter)
  • Download downloads the data displayed in the chart in CSV format
  • Visualization toggles between different data visualization options on the chart
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

  • Resource Type + EntityKey(s) specifies the resource type and identifier of the entities to be queried (not required)

Columns from which to extract data to display on the graph must be configured. A graph will be generated for each column.

For each piece of data, the following can be configured:

  • Alias a representative name for the column data on the chart
  • Color to distinguish it on the graph
  • Intensity allows for the graph to change shades depending on the value
  • Unit indicates the measurement being displayed on the corresponding axis
  • Chart Type toggles between different data visualization possibilities. Can also be configured globally for all metrics.
  • Axis editor enables the configuration of the Y-axis on the chart to assign discrete values to specific values
  • Formatter tool is a utility that processes each data point, allowing for its modification and/or calculation before it is displayed on the graph. For instance, it can convert discrete data into numerical data for representation.
  • Reduce tool allows code-based reformulation of series data by grouping and similar operations.
  • Remove removes the data stream from the chart
Datastreams History General Configuration

Advanced

From here, you can configure the widget’s behavior while plotting the graph as well as when it is opened within a temporary dashboard.

Datastreams History Advanced Configuration
  • Prevent interpolation allows the avoidance of data interpolation where possible
  • Statistical data graph displays a panel with basic statistical values
  • Data Stream template activates the override of the EntityKey in the widget when the dashboard is opened in a device template, taking a data stream from the entity itself at the time of loading

Visualization

Datastreams History Visualization

From here, you can change some visual aspects of the widget.

  • Background color allows setting a distinctive color for the widget
  • Hide details header panel hides the upper information panel of the widget, freeing up that space
  • Show basic stats in chart displays basic statistics on the chart data as long as only one series is being represented

Data Stream timeline

Graphical representation of the timeline of historical data from a data stream

How it works

Data Stream Timeline widget

This widget facilitates the visualization of value changes in a field over time.

Each timeline will display the name of the data stream along with the represented value, arranged as follows:

  • field
  • value

Grouping

Data Stream Timeline grouped information

By enabling the grouping of timelines, one can view all represented states on a single timeline (without separation).

When data are grouped, the representation of the timeline will change, displaying the value on the same timeline, and each bar will contain the following:

  • field

Summary

Data Stream Timeline information summary

The summary panel allows you to observe the total time each value has been maintained.

Widget Menu

Data Stream Timeline Actions

From here, the following actions can be performed:

  • Open device information opens the corresponding temporary panel with the selected entity
  • Edit opens the wizard corresponding to the selected entity
  • Generate QR generates a QR code that will return basic information about the asset
  • Execute operation opens the pre-configured operation launcher for the selected entity
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

  • Entity key of the desired entity to obtain the data
Data Stream Timeline General Configuration

Finally, those columns from which to extract data to display on the graph must be configured. A timeline will be generated for each of them.

For each piece of data, the following can be configured:

  • Alias a representative name for the column data on the graph
  • Color to distinguish it within the graph
  • Formatter tool is a tool that will process each piece of data, allowing for its modification and/or any calculation to ultimately display it on the graph. For example, it can convert numerical data into discrete data for representation.
  • Remove will remove the column from the configuration

Visualization

Data Stream Timeline Visualization

From here, some visual aspects of the widget can be changed.

  • Background color allows you to set a distinctive color for the widget
  • Hide details header panel hides the upper information panel of the widget, freeing up that space

Devices data stream history

Graphical representation of data from a data stream for multiple devices simultaneously

How it works

Data Streams Devices widget

Widget Menu

Data Streams Devices Actions

From here, the following actions can be executed:

  • Download allows for downloading the data displayed on the chart in CSV format
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

  • Data Stream Id is the data stream you wish to represent on the chart for various entities

  • Axis formatter allows for the representation of discrete values on the Y-axis of the chart Data Streams Devices Axis Formatter

  • Values formatter enables alteration of the obtained values for the chart. This allows for the representation of discrete values by assigning them a numerical value. Data Streams Devices Values Formatter

  • Chart type is the kind of charts to display

  • EntityKey(s) type of resource and identifier of the entities you wish to consult (not required)

For each entity, the following options are available:

  • Color an identifying color on the chart
  • Remove deletes the configuration of the entity from the widget
Data Streams Devices General Configuration

Advanced

From here, you can configure how the widget behaves when rendering the chart.

Data Streams Devices Advanced Configuration
  • Prevent interpolation allows for avoiding data interpolation when possible
  • Statistical data graph displays a panel with basic statistical values

Visualization

Data Streams Devices Visualization

From this point, some visual aspects of the widget can be changed.

  • Background color allows for setting a distinctive color for the widget
  • Hide details header panel hides the top information panel of the widget, freeing up that space

Multiple Time Series history

Graphical representation of data from multiple time series.

How it works

Multiple Time Series History widget

Widget Menu

Multiple Time Series History Actions

From this section, the following actions can be performed:

  • Open device information allows opening the temporary dashboard of the selected entity

  • Edit enables the editing of the selected entity

  • Historical data displays the graph data in list format

  • Visualization allows toggling between different data visualization options in the graph.

  • Capture screen: Takes a screenshot of the widget.

  • Duplicate widget: Creates a duplicate of the widget on the dashboard.

  • Copy widget: Copies the widget to another dashboard.

  • Change widget location: Moves the widget to another dashboard.

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

  • Resource Type + EntityKey(s) specifies the resource type and identifiers for the entities to be queried.
  • Chart type (outside of time series) forces same chart type to all series
  • Tooltip type determines how chart tooltip values will be displayed on mouse over
  • New timeserie allows user the addition of a new time serie configuration with its values.

For each time series you must configure the next:

  • Preferred organization allows user to configure how the time series organization will be selected
    • Selected organization selected by the user is the valid
    • User user organization will be used for the timeserie (important for shared dashboards)
    • Entity the organization of the opened entity in templates will be used for the timeserie, user’s otherwise
  • Organization + Time Series provides data of the time series to be queried
  • Identifier field tells the widget which column to use for data grouping
  • Date field specifies which column will serve as the temporal indicator for the data.

Lastly, columns must be configured to extract data to display on the graph. For each of these and the identifier, a graph will be generated.

For each piece of data, the following can be configured:

  • Alias specifies a representative name for the column data on the graph.
  • Color provides a way to distinguish data within the graph.
  • Intensity allows the graph to change shades depending on the value.
  • Unit indicates the measurement being displayed on the corresponding axis.
  • Chart type switches between different data visualization options. This can also be set globally for all measurements.
  • Axis editor allows configuring the Y-axis to assign discrete values to specific data points.
  • Formatter tool is a tool that treats each piece of data individually, allowing modifications and/or calculations to be performed before displaying it on the graph.
  • Reduce tool permits data reshaping through code, allowing for grouping and similar operations.
Time Series History General Configuration

Advanced

From this section, the widget’s behavior when rendering the graph as well as when it is opened within a temporary dashboard can be configured.

Time Series History Advanced Configuration
  • Prevent interpolation avoids data interpolation when possible.
  • Statistical data graph displays a panel with basic statistical values.
  • Datastream template enables the overriding of the EntityKey in the widget when the dashboard is opened in a device template, using a datastream from the entity at the time of loading.

Visualization

Time Series History Visualization

From this section, some visual aspects of the widget can be modified.

  • Background color allows setting a distinctive color for the widget.
  • Hide details header panel hides the top information panel of the widget, freeing up that space.

Summary Chart

This widget displays graphs of summaries provided by the platform.

How it works

Summary Chart widget

This widget facilitates the graphical visualization of summarized data.

Data can be displayed graphically, in table form, or both simultaneously.

Widget Menu

Summary Chart Actions

From this section, the following actions can be performed:

  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Widget Filter

Summary Chart Filters

With the filter, one can narrow down the number of results and obtain new metrics.

There are three types of filters: basic, advanced, or linked.

  • Basic allows the entry of any text and will filter by predetermined fields.
  • Advanced allows configuring a custom filter based on the displayed graph.
  • Linked ties the filter with that of another compatible widget, inheriting its query and refreshing both simultaneously.

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

  • Summary type allows selection among different types of summaries.
  • Summary format specifies the type of representation: graphical, table, or mixed (both simultaneously).
  • Table position allows specifying the table’s position in mixed mode.
  • Legend enables or disables the display of graph legends and their position.
  • Columns number tells the widget into how many columns the graphs should be distributed.
  • Style pie chart instructs the widget whether to display pie charts in donut format or regular (no format).
Summary Chart General Configuration

Finally, one must configure the data streams to summarize. The following must be indicated for each:

  • Column 1 specifies the type of graph to represent for the selected data stream.
  • Column 2, field allows choosing a field within a complex data stream.
  • Column 3, alias allows specifying the name of the data stream on the graph.
  • Formatter tool is a tool that allows formatting and altering the information returned by the platform to meet specific needs.
  • Remove will remove the column from the configuration.

When the summary type is “Entities Values,” additional configuration parameters will be activated. This is because this option calculates graph data based on a sample of the overall entities.

Summary Chart Entities Values summary

The global chart type field will be activated, and a new panel appears where the following will be configured:

  • Generated summary title is the name to display on the generated graph.
  • Statistics: count strategy specifies the operation to perform on the read data: total, median, mean, maximum, minimum, variance, and standard deviation.
  • Statistics: max samples specifies the number of samples to take for generating the graph.

The list of data streams will indicate on which data the indicated count strategy will act.

Advanced

From here, internal filters that would always apply regardless of user actions can be configured.

Summary Chart Advanced
  • Private filter will always execute unless there is a template filter.
  • Template filter allows configuring a filter that will overwrite the private one when the dashboard opens in a temporary template.
  • Share filter tells the widget to share the private/template filter when this widget is selected in another widget via linked filter.

Time Series data timeline

Graphical representation of a time series data timeline.

How it works

Time Series Timeline widget

This widget facilitates the visualization of value changes in a field over time within a time series.

Each timeline will display the group, the field, and the represented value, arranged as follows:

  • Group
  • Field
  • Value

Grouping

Time Series Timeline grouped information

By enabling the grouping of timelines, you can view all represented states on a single timeline (without separation).

When the data is grouped, the representation of the timeline changes, displaying the value on the same timeline, and each bar will contain the following:

  • Group
  • Field

Resume

Time Series Timeline information resume

With the summary panel, you can observe the total time each value has been maintained.

Widget Menu

Time Series Timeline Actions

From here, the following actions can be performed:

  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

  • Organization + Time Series provides data of the time series to be queried.
  • Start date field specifies which date-type column should be used to indicate the beginning of the period (*).
  • End date field specifies which date-type column should be used to indicate the end of the period (*).
  • Identifier field tells the widget which column to use for data grouping.

(*) If both dates use the same field, the start of the next state will be used to calculate the period.

Time Series Timeline General Configuration

Lastly, columns must be configured to extract data to display on the graph. For each of these and the group/identifier, a graph will be generated.

For each piece of data, the following can be configured:

  • Alias specifies a representative name for the column data on the graph.
  • Color provides a way to distinguish data within the graph.
  • Formatter tool is a tool that treats each piece of data individually, allowing for modifications and/or calculations before displaying it on the graph. For example, you can convert numerical data into discrete data for representation.
  • Remove will remove the column from the configuration.

Advanced

In this section, various filters that will be applied to queries will be configured, regardless of what the user may wish to filter subsequently.

Time Series Timeline Advanced Configuration

Visualization

Time Series Timeline Visualization

From here, some visual aspects of the widget can be modified.

  • Background color allows setting a distinctive color for the widget.
  • Hide details header panel hides the top information panel of the widget, freeing up that space.

Time Series history

Graphical representation of data from a time series.

How it works

Time Series History widget

Widget Menu

Time Series History Actions

From this section, the following actions can be performed:

  • Open device information allows opening the temporary dashboard associated with the selected entity (only available when entities have been preselected).

  • Edit enables the editing of the selected entity (only available when entities have been preselected).

  • Historical data displays the graph data in list format (requires selecting a grouping field).

  • Visualization allows toggling between different data visualization options in the graph.

  • Capture screen: Takes a screenshot of the widget.

  • Duplicate widget: Creates a duplicate of the widget on the dashboard.

  • Copy widget: Copies the widget to another dashboard.

  • Change widget location: Moves the widget to another dashboard.

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

  • Chart type (outside of series) forces same chart type to all series
  • Tooltip type determines how chart tooltip values will be displayed on mouse over
  • Preferred organization allows user to configure how the time series organization will be selected
    • Selected organization selected by the user is the valid
    • User user organization will be used for the timeserie (important for shared dashboards)
    • Entity the organization of the opened entity in templates will be used for the timeserie, user’s otherwise
  • Organization + Time Series provides data of the time series to be queried.
  • Resource Type + EntityKey(s) specifies the resource type and identifiers for the entities to be queried (not required).
  • Grouping/Identifier field tells the widget which column to use for data grouping. If none is selected, all data will be grouped as one.
  • Date field specifies which column will serve as the temporal indicator for the data.

Lastly, columns must be configured to extract data to display on the graph. For each of these and the grouping/identifier, a graph will be generated.

For each piece of data, the following can be configured:

  • Alias specifies a representative name for the column data on the graph.
  • Color provides a way to distinguish data within the graph.
  • Intensity allows the graph to change shades depending on the value.
  • Unit indicates the measurement being displayed on the corresponding axis.
  • Chart type switches between different data visualization options. This can also be set globally for all measurements.
  • Axis editor allows configuring the Y-axis to assign discrete values to specific data points.
  • Formatter tool is a tool that treats each piece of data individually, allowing modifications and/or calculations to be performed before displaying it on the graph.
  • Reduce tool permits data reshaping through code, allowing for grouping and similar operations.
Time Series History General Configuration

Advanced

From this section, the widget’s behavior when rendering the graph as well as when it is opened within a temporary dashboard can be configured.

Time Series History Advanced Configuration
  • Prevent interpolation avoids data interpolation when possible.
  • Statistical data graph displays a panel with basic statistical values.
  • Datastream template enables the overriding of the EntityKey in the widget when the dashboard is opened in a device template, using a datastream from the entity at the time of loading.

Visualization

Time Series History Visualization

From this section, some visual aspects of the widget can be modified.

  • Background color allows setting a distinctive color for the widget.
  • Hide details header panel hides the top information panel of the widget, freeing up that space.
  • Show basic stats in chart displays basic statistics on the graph itself when only one series is represented.

Subsections of Entity Details

Asset Related

In this widget, you will be able to see the devices related to an asset.

How it works

Asset Related

Widget Menu

Menu Action List

The following actions can be performed:

  • Open entity information: Opens a temporary dashboard with information about the asset.
  • Edit: Opens the asset wizard.
  • Generate QR: Generates a QR code that will provide basic information about the asset.
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Configuration

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

Asset Select

Selection of the asset to display.

Visualization

Asset Select

Settings that can be configured:

  • Background color: Sets the background color of the widget.
  • Hide details header panel: Hides the title with the asset identifier.

Data stream Last Value

Widget that displays the last value obtained for a data stream.

How it works

Entity last value

The information can be displayed in various formats: graphically, symbolically, and textually.

We can also check its history and statistics: trend, maximum and minimum, percentile, mean, and median.

Widget Menu

Menu action list

The following actions can be performed:

  • Open device information: opens a temporary dashboard with device information
  • Edit: opens the device wizard
  • Open device details: opens the device information wizard
  • Generate QR: generates a QR code that will return basic information about the device
  • Historical data: “Data Points” widget in table format, showing the data stream’s history
  • View Chart: “Data Stream history” widget that displays the evolution of the data stream
  • Execute operation: opens the operation execution wizard to perform an operation on the device
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Configuration

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

General
  • Entity key: Device to display

  • DatastreamId: Data stream whose last value (and its statistics) will be displayed

    • Name: Alias for the selected field to display
    • Test Value: If this data is filled in, a preview of how the widget will look with the value given to the datastream will be displayed in the configuration.
    • Symbol: Unit for the value
    • View mode: Type of data visualization
    Conf chart
    • Value: Value in text format (default mode).

    • Icon: Display an icon (Symbol field) along with the value in text mode.

    • Battery (Percent): Display the value within a battery. Reference values will be configured in the “Chart colors” panel.

    • Bar (Percent/Range): Display the value in a bar. Reference values will be configured in the “Chart colors” panel.

    • Gauge (Percent/Range): Display the value in a gauge-type graph. Reference values will be configured in the “Chart colors” panel.

    • Choose an icon: Icon to display (for Icon mode).

    • Choose color: Icon color.

    • Alignment: Alignment of the value (Value and Icon modes) in the widget.

    • Size: Value size.

    • Extra information: Extra information to display in the widget along with the value.

    • FORMATTER: Opens a panel where you can format the value. Formatter

Advanced

General
  • Historical data graph: Display a graph showing the value’s evolution over time
  • Statistical data graph: Display statistical data
  • Choose a period: Time frame for sampling the statistical data and its visualization in the value evolution graph
  • Trend: Assign a color based on the value’s trend

Visualization

Visualization

We can configure certain elements of the graphs displayed in the widget:

  • Background color
  • Hide details header panel: Removes the menu allowing for the modification of the type of visualization as well as the type of value to display.

Device Hierarchy Graph

In this widget, you will be able to graphically view the hierarchy of a device within the organization.

How it works

Asset related

You will be able to view its communication modules, related assets, and its topology.

You can choose between displaying:

  • provisioned values
  • collected values
  • both types of values

Communications Module

Communications module

In this view, you will be able to see the communication modules available on the device.

By clicking on the device card, you can:

  • view pre-configured information in the widget
  • perform actions on the device
Communications module

In this view, you can see the assets related to the device.

By clicking on either the device card or the asset cards, you can:

  • view pre-configured information in the widget
  • perform actions on the device or asset

Topology

Topology

In this view, you can see the topology of the device.

A panel will be available to indicate the relationships between different entities.

Widget Menu

Menu action list

The following actions can be performed:

  • Open device information: Opens a temporary dashboard with the device information
  • Edit: Opens the device wizard
  • Generate QR: Generates a QR code that will provide basic information about the device
  • Execute operation: Opens an operation execution wizard to perform an operation on the device
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Configuration

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

General
  • Entity key: Device to display
  • View: Default view to display
  • Relations type: Type of values to display: collected, provisioned, or both
Popup

You can configure the information to display in the popup that appears when clicking on the cards displayed in the widget, selecting values from the available data streams.

Visualization

Visualization

You can configure certain elements of the graphs displayed in the widget:

  • Background color
  • Hide details header panel: Removes the menu that allows changing the type of visualization as well as the type of value to display.
  • Provision elements color
  • Collection elements color

Entity Information Details

A widget that displays information about each of the data streams that make up the entity in a card format.

How it works

Asset related

On each card, you will be able to see:

  • the current value
  • the date when the value was taken
  • the source of the information
  • the type of provisioning (for provisioned data)
  • identifying icon

Target menu

Target menu

From each of the cards, you can open various widgets (varying depending on the type of data stream value):

  • Stream status: “Last Value” widget displaying datastream information, such as the last value and trends.
  • Historical data: “Data Points” widget in table format, showing the data stream’s historical data.
  • View Chart: “Data Stream history” widget displaying the data stream’s evolution in chart form.
  • View tracking data: “Tracking” widget showing the entity’s location on a map (only applicable if it’s a location-type data stream).
  • Change value (provision datastreams only): Allows the user to change the value of the datastream without having to open the corresponding wizard.

Grouping

Grouping

Choice of type of grouping.

Depending on its configuration, it can be by:

  • data model
  • categories of a data model
  • tags
  • whether the value is provisioned or collected

Performance

Performance

Graph showing the performance of the data stream.

Widget Menu

Menu action list

The following actions can be performed:

  • Open device information: Opens a temporary dashboard with device information
  • Edit: Opens the device wizard
  • Execute operation: Opens an operation execution wizard to perform an operation on the device
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Configuration

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

General
  • Entity key: Device to display
  • Extra information: Choice of data to display within the card
  • Grouping: Choice of type of grouping:
    • data model
    • categories of a data model
    • tags
    • whether the value is provisioned or collected
  • DatastreamId: Choice and format of the displayed data streams ConfDatastreamId
    • Choose whether to only view the selected data streams
    • Format the selected data streams
      • Alias
      • Category: a new category can be created for grouping the data streams
      • Position: position of the value on the card
      • Icon: representative icon that will be displayed on the card
      • Format: format the value of the displayed data stream

Advanced

General

Visualization

Visualization

Certain elements of the graphs displayed in the widget can be configured:

  • Background color
  • Hide details header panel: Removes the menu that allows modifying the type of visualization and the type of value to display.
  • Default alignment: position of the value on the cards

Image Widget

The widget allows you to upload and configure an image with data icons overlaid on it.

How it works

Image

Once the widget is configured, an image will be displayed with the configured data.

Icon Menu

Data can be viewed as icons positioned over the image, which we can interact with to view information about them:

  • Stream status: “Last Value” widget displaying datastream information, such as the last value and trends.
  • Historical data: “Data Points” widget in table format, showing the data stream’s historical data.
  • View Chart: “Data Stream history” widget displaying the data stream’s evolution in chart form.
  • View tracking data: “Tracking” widget showing the entity’s location on a map (only applicable if it’s a location-type data stream).
  • Change value (provision datastreams only): Allows the user to change the value of the datastream without having to open the corresponding wizard.

Widget Menu

Image menu action

The following actions can be performed:

  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Configuration

Configuration

Image Upload

General

From here, we can upload the image to display and its format.

Icon Configuration

Icon

Using the + button, we can add icons to the image.

Existing icons can also be edited by clicking on them.

We can configure:

  • General:

    Icon general
    • Entity key: Device from which we will obtain the data
    • DatastreamId: Data stream whose value will be displayed on the icon
  • View:

    Icon view
    • Name: Alias for the selected field to display
    • Test Value: If this data is filled in, a preview of how the widget will look with the value given to the datastream will be displayed in the configuration.
    • Symbol: Unit for the value
    • View mode: Type of data visualization
    View mode
    • Value: Value in text format (default mode).

    • Icon: Display an icon (Symbol field) along with the value in text mode.

    • Battery (Percent): Display the value within a battery. Reference values will be configured in the “Chart colors” panel.

    • Bar (Percent/Range): Display the value in a bar. Reference values will be configured in the “Chart colors” panel.

    • Gauge (Percent/Range): Display the value in a gauge-type graph. Reference values will be configured in the “Chart colors” panel.

    • Choose an icon: Icon to display (for Icon mode).

    • Choose color: Icon color.

    • Alignment: Alignment of the value (Value and Icon modes) in the widget.

    • Size: Value size.

    • Extra information: Extra information to display in the widget along with the value.

    • FORMATTER: Opens a panel where you can format the value. Formatter

  • Advanced: View mode

    • Prevent override entity identifier in templates

Ticket Data stream Last value

Widget that displays the last value obtained for a data stream.

How it works

Ticket last value

The information can be displayed in various ways: graphical, symbolic, and text-based.

We can also review its history and statistics: trend, maximum and minimum, percentile, mean, and median.

Widget Menu

Menu action list

The following actions can be performed:

  • Open ticket information: opens a temporary dashboard with information on the ticket.
  • Edit: opens the ticket wizard.
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Configuration

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

General
  • Ticket: The ticket to display.

  • DatastreamId: Data stream whose last value (and its statistics) will be displayed.

    • Name: Alias for the selected field to display
    • Test Value: If this data is filled in, a preview of how the widget will look with the value given to the datastream will be displayed in the configuration.
    • Symbol: Unit for the value
    • View mode: Type of data visualization
    View mode
    • Value: Value in text format (default mode).

    • Icon: Display an icon (Symbol field) along with the value in text mode.

    • Battery (Percent): Display the value within a battery. Reference values will be configured in the “Chart colors” panel.

    • Bar (Percent/Range): Display the value in a bar. Reference values will be configured in the “Chart colors” panel.

    • Gauge (Percent/Range): Display the value in a gauge-type graph. Reference values will be configured in the “Chart colors” panel.

    • Choose an icon: Icon to display (for Icon mode).

    • Choose color: Icon color.

    • Alignment: Alignment of the value (Value and Icon modes) in the widget.

    • Size: Value size.

    • Extra information: Extra information to display in the widget along with the value.

    • FORMATTER: Opens a panel where you can format the value. Formatter

Advanced

General
  • Historical data graph: Display a graph showing the value’s evolution over time.
  • Statistical data graph: Display statistical data.

Visualization

Visualization

We can configure certain elements of the graphs displayed in the widget:

  • Background color
  • Hide details header panel: Removes the menu allowing for the modification of the type of visualization as well as the type of value to display.

Ticket Information Details

Widget that displays the information for each of the data streams that make up the ticket in card format.

How it works

Ticket details

On each card, we can see:

  • the current value
  • the date the value was taken
  • the source of the information
  • the type of provision (for provisioned data)
  • identifying icon

Target Menu

Target menu

From each card, we can open various widgets (varying depending on the type of value of the data stream):

  • Stream status: “Last Value” widget displaying datastream information, such as the last value and trends.
  • Historical data: “Data Points” widget in table format, showing the data stream’s historical data.
  • View Chart: “Data Stream history” widget displaying the data stream’s evolution in chart form.
  • View tracking data: “Tracking” widget showing the entity’s location on a map (only applicable if it’s a location-type data stream).
  • Change value (provision datastreams only): Allows the user to change the value of the datastream without having to open the corresponding wizard.

Grouping

Grouping

Selection of the type of grouping.

Depending on its configuration, it could be by:

  • data model
  • categories of a data model
  • tags
  • whether the value is provisioned or collected

Widget Menu

Menu action list

The following actions can be performed:

  • Open ticket information: opens a temporary dashboard with ticket information
  • Edit: opens the ticket wizard
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Configuration

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

General
  • Ticket: Ticket to display
  • Extra Information: Selection of data to be displayed within the card
  • Grouping: Selection of the type of grouping:
    • data model
    • categories of a data model
    • tags
    • whether the value is provisioned or collected
  • DatastreamId: Selection and format of displayed data streams ConfDatastreamId
    • Choose whether to view only the selected data streams
    • Format the selected data streams
      • Alias
      • Category: a new category can be created to group the data streams
      • Position: placement of the value on the card
      • Icon: representative icon to be displayed on the card
      • Format: formatting the value of the data stream to be displayed

Advanced

General

Visualization

Visualization

We can configure certain elements of the graphs displayed in the widget:

  • Background color
  • Hide details header panel: Removes the menu allowing the modification of the type of visualization as well as the type of value to display.
  • Default alignment: placement of the value on the cards

Time series last value

Widget that displays the last value obtained in a time series.

How it works

Time Series last value

The information can be displayed in various formats: graphically, symbolically, and textually.

We can also check its history and statistics: trend, maximum and minimum, percentile, mean, and median.

Widget Menu

Menu action list

The following actions can be performed:

  • Open device information: opens a temporary dashboard with device information
  • Edit: opens the device wizard
  • Open device details: opens the device information wizard
  • Generate QR: generates a QR code that will return basic information about the device
  • Historical data: “Time Series data list” widget in table format, showing the time series’ history
  • View Chart: “Time Series history” widget that displays the evolution of the time series
  • Execute operation: opens the operation execution wizard to perform an operation on the device
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

  • Organization: Organization of the desired time series
  • Time Series: Time Series source
  • Value column: Column to read the value
  • Date column: Column to read the date of the value and for stats
  • Entity key: Device to display
  • DatastreamId: Data stream whose last value (and its statistics) will be displayed
Configuration General
  • Name: Alias for the selected field to display
  • Test Value: If this data is filled in, a preview of how the widget will look with the value given to the datastream will be displayed in the configuration.
  • Symbol: Unit for the value
  • View mode: Type of data visualization
Conf chart
  • Value: Value in text format (default mode).

  • Icon: Display an icon (Symbol field) along with the value in text mode.

  • Battery (Percent): Display the value within a battery. Reference values will be configured in the “Chart colors” panel.

  • Bar (Percent/Range): Display the value in a bar. Reference values will be configured in the “Chart colors” panel.

  • Gauge (Percent/Range): Display the value in a gauge-type graph. Reference values will be configured in the “Chart colors” panel.

  • Choose an icon: Icon to display (for Icon mode).

  • Choose color: Icon color.

  • Alignment: Alignment of the value (Value and Icon modes) in the widget.

  • Size: Value size.

  • Extra information: Extra information to display in the widget along with the value.

  • FORMATTER: Opens a panel where you can format the value. Formatter

Advanced

Configuration Advanced
  • Historical data graph: Display a graph showing the value’s evolution over time
  • Statistical data graph: Display statistical data
  • Choose a period: Time frame for sampling the statistical data and its visualization in the value evolution graph
  • Trend: Assign a color based on the value’s trend

Visualization

Configuration Visualization

We can configure certain elements of the graphs displayed in the widget:

  • Background color background color for the widget
  • Hide details header panel: Removes the menu allowing for the modification of the type of visualization as well as the type of value to display.

Listings

The website features listings, widgets that will display information in a table format.

Columns to display and the format of the data can be configured. One can filter by content, dates, and perform various actions such as executing operations on the displayed entities.

Widgets


Subsections of Listings

Areas List

The listing of areas allows you to view/manage the areas within the organization.

How it works

Below are the actions that can be performed both within the widget and on the displayed data.

Entity List

Filter by Columns

Column filter

Basic Filter

Basic filter

Perform a basic search by entering text that will filter by predefined fields.

Advanced Filter

Advanced filter

Perform a search by selecting the fields to filter by and how to filter by them.

Save and Restore Filters

Basic and Advanced filters can be saved in order to preconfigure a list of filters and restore them at any time. This feature is only available in own dashboards but can be shared with other users.

You can save a filter by fullfilling the filter name in the field at the bottom of the filter panel and clicking on the save button. When a filter is saved, it is stored in the widget’s filter list and can be restored at any time by selecting it from the saved filters list located at the top of the filter panel.

Filters can be saved only when a new filter is created.

This can be useful when you want to save a list of filters that you use frequently and restore them at any time.

Widget Menu

Menu action list

The following actions can be performed:

  • New area: Opens the area creation wizard
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Temporarily Sort and Hide Column

Sort menu

Actions Per Entity

Row actions

The following actions can be performed:

  • Edit: Opens the area editing wizard
  • Delete: Deletes the user

Configuration

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

Cell Configuration

Column configuration
  • Alias: Modify the column name. If nothing is added, it will use the default configured name.

  • Show entity actions: Allow displaying the actions menu when selecting its value in the cell. If the column is an identifier, this field will be enabled.

  • Hidden column: Enabling this option will hide the column from the user. This is useful when you need the data for formatting purposes, as only the data required in the list will be available.

  • Options:

    • Modify the cell’s width and horizontal alignment of its content. Column width
    • Format the cell’s value. Column formatter
  • Pagination: Configure the number of rows to display per page. Table pagination

Virtual columns

Also you can add virtual columns to lists.

Virtual Column config

These columns do not have their own values ​​and must be configured in the column formatter once added.

Virtual Column Formatter

Please note that the contents of this column will never be output to CSV, as it is calculated on the fly and does not rely on any native platform resources.

Virtual Column

Button columns

Also you can add button columns to lists in order to execute some custom action related with the row data.

Button Column config

Button label can be setted in normal or virtual columns. Label will be the value.

Button action code receives the complete rowData and you can open other dashboards, entities dashboards or execute wizards.

Button Column Formatter

You can find all available functions and methods in Extra parameters

Advanced

In this section, you will configure various filters that will be applied to queries regardless of the user’s specific filtering preferences.

Advanced Configuration

Widget Filters Configuration

Here you can define how widget filters should behave when sharing the dashboard with other users/organizations. This means that when sharing, a user opens these dashboards and won’t see the filters applied to the original dashboard in the specified widgets, preventing the information displayed from changing after a dashboard refresh.

The three possible options are:

  • Don’t share the widget’s general filter
  • Don’t share header filters in lists
  • Don’t share sorting in lists

Bulk List

The listing of bulks allows you to view the executed bulks within the organization and their outcomes.

How it works

Below are the actions that can be performed both within the widget and on the displayed data.

Entity List

Widget Menu

Menu action list

The following actions can be undertaken:

  • Upload Bulk File: Opens the bulk upload wizard
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Download Result

Row actions

From here, you can download the result of the bulk operation.

Configuration

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

Cell Configuration

Column configuration
  • Alias: Modify the column name. If nothing is added, it will use the default configured name.

  • Show entity actions: Allow displaying the actions menu when selecting its value in the cell. If the column is an identifier, this field will be enabled.

  • Hidden column: Enabling this option will hide the column from the user. This is useful when you need the data for formatting purposes, as only the data required in the list will be available.

  • Options:

    • Modify the cell’s width and horizontal alignment of its content. Column width
    • Format the cell’s value. Column formatter
  • Pagination: Configure the number of rows to display per page. Table pagination

Virtual columns

Also you can add virtual columns to lists.

Virtual Column config

These columns do not have their own values ​​and must be configured in the column formatter once added.

Virtual Column Formatter

Please note that the contents of this column will never be output to CSV, as it is calculated on the fly and does not rely on any native platform resources.

Virtual Column

Button columns

Also you can add button columns to lists in order to execute some custom action related with the row data.

Button Column config

Button label can be setted in normal or virtual columns. Label will be the value.

Button action code receives the complete rowData and you can open other dashboards, entities dashboards or execute wizards.

Button Column Formatter

You can find all available functions and methods in Extra parameters

Advanced

In this section, you will configure various filters that will be applied to queries regardless of the user’s specific filtering preferences.

Advanced Configuration

Widget Filters Configuration

Here you can define how widget filters should behave when sharing the dashboard with other users/organizations. This means that when sharing, a user opens these dashboards and won’t see the filters applied to the original dashboard in the specified widgets, preventing the information displayed from changing after a dashboard refresh.

The three possible options are:

  • Don’t share the widget’s general filter
  • Don’t share header filters in lists
  • Don’t share sorting in lists

Bulk List (Advanced)

The listing of advanced bulks allows you to view executed bulks, using provisioning features, within the organization and their outcomes.

How it works

Below are the actions that can be performed both within the widget and on the displayed data.

Entity List

Widget Menu

Menu action list

The following actions can be taken:

  • Upload Bulk File (Advanced): Opens the advanced bulk upload wizard, utilizing provisioning features.
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Download Result

Row actions

From here, you can download the result of the bulk operation.

Configuration

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

Cell Configuration

Column configuration
  • Alias: Modify the column name. If nothing is added, it will use the default configured name.

  • Show entity actions: Allow displaying the actions menu when selecting its value in the cell. If the column is an identifier, this field will be enabled.

  • Hidden column: Enabling this option will hide the column from the user. This is useful when you need the data for formatting purposes, as only the data required in the list will be available.

  • Options:

    • Modify the cell’s width and horizontal alignment of its content. Column width
    • Format the cell’s value. Column formatter
  • Pagination: Configure the number of rows to display per page. Table pagination

Virtual columns

Also you can add virtual columns to lists.

Virtual Column config

These columns do not have their own values ​​and must be configured in the column formatter once added.

Virtual Column Formatter

Please note that the contents of this column will never be output to CSV, as it is calculated on the fly and does not rely on any native platform resources.

Virtual Column

Button columns

Also you can add button columns to lists in order to execute some custom action related with the row data.

Button Column config

Button label can be setted in normal or virtual columns. Label will be the value.

Button action code receives the complete rowData and you can open other dashboards, entities dashboards or execute wizards.

Button Column Formatter

You can find all available functions and methods in Extra parameters

Advanced

In this section, you will configure various filters that will be applied to queries regardless of the user’s specific filtering preferences.

Advanced Configuration

Widget Filters Configuration

Here you can define how widget filters should behave when sharing the dashboard with other users/organizations. This means that when sharing, a user opens these dashboards and won’t see the filters applied to the original dashboard in the specified widgets, preventing the information displayed from changing after a dashboard refresh.

The three possible options are:

  • Don’t share the widget’s general filter
  • Don’t share header filters in lists
  • Don’t share sorting in lists

Bundles List

The listing of bundles allows you to view/manage the bundles within an organization.

How it works

Below are the actions that can be performed both within the widget and on the displayed data.

Entity List

Filter by Columns

column filter

Basic Filter

Basic filter

Perform a basic search by entering text that will filter by predefined fields.

Advanced Filter

Advanced filter

Perform a search by selecting the fields to filter by and how to filter by them.

Save and Restore Filters

Basic and Advanced filters can be saved in order to preconfigure a list of filters and restore them at any time. This feature is only available in own dashboards but can be shared with other users.

You can save a filter by fullfilling the filter name in the field at the bottom of the filter panel and clicking on the save button. When a filter is saved, it is stored in the widget’s filter list and can be restored at any time by selecting it from the saved filters list located at the top of the filter panel.

Filters can be saved only when a new filter is created.

This can be useful when you want to save a list of filters that you use frequently and restore them at any time.

Widget Menu

Menu action list

The following actions can be performed:

  • New bundle: Opens the bundle creation wizard.
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Sort and Temporarily Hide Columns

Sort menu

Entity Actions

Row actions

The following actions can be performed:

  • Edit: Opens the bundle editing wizard. Only if the bundle is deactivated.
  • Activate/Deactivate: Activates or deactivates the bundle.
  • Delete: Deletes the bundle.

Configuration

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

Cell Configuration

Column configuration
  • Alias: Modify the column name. If nothing is added, it will use the default configured name.

  • Show entity actions: Allow displaying the actions menu when selecting its value in the cell. If the column is an identifier, this field will be enabled.

  • Hidden column: Enabling this option will hide the column from the user. This is useful when you need the data for formatting purposes, as only the data required in the list will be available.

  • Options:

    • Modify the cell’s width and horizontal alignment of its content. Column width
    • Format the cell’s value. Column formatter
  • Pagination: Configure the number of rows to display per page. Table pagination

Virtual columns

Also you can add virtual columns to lists.

Virtual Column config

These columns do not have their own values ​​and must be configured in the column formatter once added.

Virtual Column Formatter

Please note that the contents of this column will never be output to CSV, as it is calculated on the fly and does not rely on any native platform resources.

Virtual Column

Button columns

Also you can add button columns to lists in order to execute some custom action related with the row data.

Button Column config

Button label can be setted in normal or virtual columns. Label will be the value.

Button action code receives the complete rowData and you can open other dashboards, entities dashboards or execute wizards.

Button Column Formatter

You can find all available functions and methods in Extra parameters

Advanced

In this section, you will configure various filters that will be applied to queries regardless of the user’s specific filtering preferences.

Advanced Configuration

Widget Filters Configuration

Here you can define how widget filters should behave when sharing the dashboard with other users/organizations. This means that when sharing, a user opens these dashboards and won’t see the filters applied to the original dashboard in the specified widgets, preventing the information displayed from changing after a dashboard refresh.

The three possible options are:

  • Don’t share the widget’s general filter
  • Don’t share header filters in lists
  • Don’t share sorting in lists

Data Points List

The listing of data points allows you to view the data of various entities within an organization.

How it works

Below are the actions that can be performed both within the widget and on the displayed data.

Entity List

Filter by Columns

column filter

Basic Filter

Basic filter

Perform a basic search by entering text that will filter by predefined fields.

Advanced Filter

Advanced filter

Perform a search by selecting the fields to filter by and how to filter by them.

Save and Restore Filters

Basic and Advanced filters can be saved in order to preconfigure a list of filters and restore them at any time. This feature is only available in own dashboards but can be shared with other users.

You can save a filter by fullfilling the filter name in the field at the bottom of the filter panel and clicking on the save button. When a filter is saved, it is stored in the widget’s filter list and can be restored at any time by selecting it from the saved filters list located at the top of the filter panel.

Filters can be saved only when a new filter is created.

This can be useful when you want to save a list of filters that you use frequently and restore them at any time.

Widget Menu

Menu action list

The following actions can be performed:

  • Download: Download data in CSV format.
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Sort and Temporarily Hide Columns

Sort menu

Configuration

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

Cell Configuration

Column configuration
  • Alias: Modify the column name. If nothing is added, it will use the default configured name.

  • Show entity actions: Allow displaying the actions menu when selecting its value in the cell. If the column is an identifier, this field will be enabled.

  • Hidden column: Enabling this option will hide the column from the user. This is useful when you need the data for formatting purposes, as only the data required in the list will be available.

  • Options:

    • Modify the cell’s width and horizontal alignment of its content. Column width
    • Format the cell’s value. Column formatter
  • Pagination: Configure the number of rows to display per page. Table pagination

Virtual columns

Also you can add virtual columns to lists.

Virtual Column config

These columns do not have their own values ​​and must be configured in the column formatter once added.

Virtual Column Formatter

Please note that the contents of this column will never be output to CSV, as it is calculated on the fly and does not rely on any native platform resources.

Virtual Column

Button columns

Also you can add button columns to lists in order to execute some custom action related with the row data.

Button Column config

Button label can be setted in normal or virtual columns. Label will be the value.

Button action code receives the complete rowData and you can open other dashboards, entities dashboards or execute wizards.

Button Column Formatter

You can find all available functions and methods in Extra parameters

Advanced

In this section, you will configure various filters that will be applied to queries regardless of the user’s specific filtering preferences.

Advanced Configuration

Widget Filters Configuration

Here you can define how widget filters should behave when sharing the dashboard with other users/organizations. This means that when sharing, a user opens these dashboards and won’t see the filters applied to the original dashboard in the specified widgets, preventing the information displayed from changing after a dashboard refresh.

The three possible options are:

  • Don’t share the widget’s general filter
  • Don’t share header filters in lists
  • Don’t share sorting in lists

Data Set data List

The listing allows us to view the values provided by a data set and manage the entities related to it.

How it works

Below are the actions that can be performed both within the widget and on the displayed data.

Entity List

Filter by Columns

column filter

Advanced Filter

Advanced filter

Perform a search by selecting the fields to filter by and how to filter by them.

Save and Restore Filters

Basic and Advanced filters can be saved in order to preconfigure a list of filters and restore them at any time. This feature is only available in own dashboards but can be shared with other users.

You can save a filter by fullfilling the filter name in the field at the bottom of the filter panel and clicking on the save button. When a filter is saved, it is stored in the widget’s filter list and can be restored at any time by selecting it from the saved filters list located at the top of the filter panel.

Filters can be saved only when a new filter is created.

This can be useful when you want to save a list of filters that you use frequently and restore them at any time.

Widget Menu

Menu action list

The following actions can be performed:

  • Download: Download data in CSV format
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Sort

Sort menu

If data set has sorting columns configured, the sort menu will display the configured sorting columns.

You can apply the sorting configuration by clicking on the sorting configuration desired and remove with the clean button.

Entity Actions

Row actions

The actions to be performed will depend on the type of entity configured as the identifying column:

  • Edit: Edit the entity by opening the corresponding wizard for that entity type
  • Execute operation: Perform an operation on the displayed entity
  • Collect: Simulate data collection on an entity (if the entity type supports this action)
  • Open device/asset/subscriber/subscription information: Opens a temporary dashboard that will display information related to the entity
  • Open device/asset/subscriber/subscription details: Opens the information widget of an entity with the data of the entity
  • View hierarchy of the entity: Opens the hierarchy widget to display the hierarchy of the entity (if the entity type supports this action)
  • Delete: Delete the entity

Configuration

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

Data Set and Column Selection

Data set select
  • Organization: Select the organization to which the data set belongs
  • Data set: Select the data set
  • Columns: Select columns configured in the data set

Column Identifier Selection

Data set row identifier

Selection of the identifying column. Based on the value of this column, the table will display different actions to perform on each of its rows.

Cell Configuration

Column configuration
  • Alias: Modify the column name. If nothing is added, it will use the default configured name.

  • Show entity actions: Allow displaying the actions menu when selecting its value in the cell. If the column is an identifier, this field will be enabled.

  • Hidden column: Enabling this option will hide the column from the user. This is useful when you need the data for formatting purposes, as only the data required in the list will be available.

  • Options:

    • Modify the cell’s width and horizontal alignment of its content. Column width
    • Format the cell’s value. Column formatter
  • Pagination: Configure the number of rows to display per page. Table pagination

Virtual columns

Also you can add virtual columns to lists.

Virtual Column config

These columns do not have their own values ​​and must be configured in the column formatter once added.

Virtual Column Formatter

Please note that the contents of this column will never be output to CSV, as it is calculated on the fly and does not rely on any native platform resources.

Virtual Column

Button columns

Also you can add button columns to lists in order to execute some custom action related with the row data.

Button Column config

Button label can be setted in normal or virtual columns. Label will be the value.

Button action code receives the complete rowData and you can open other dashboards, entities dashboards or execute wizards.

Button Column Formatter

You can find all available functions and methods in Extra parameters

Advanced

In this section, you will configure various filters that will be applied to queries regardless of the user’s specific filtering preferences.

Advanced Configuration

Widget Filters Configuration

Here you can define how widget filters should behave when sharing the dashboard with other users/organizations. This means that when sharing, a user opens these dashboards and won’t see the filters applied to the original dashboard in the specified widgets, preventing the information displayed from changing after a dashboard refresh.

The three possible options are:

  • Don’t share the widget’s general filter
  • Don’t share header filters in lists
  • Don’t share sorting in lists

Entities Alarms List

The alarm list allows you to view/manage alarms generated by the system in your organization.

How it works

Below are the actions that can be performed both within the widget and on the displayed data.

Entity List

Filter by Columns

Column filter

Basic Filter

Basic filter

Perform a basic search by entering text that will filter by predefined fields.

Advanced Filter

Advanced filter

Perform a search by selecting the fields to filter by and how to filter by them.

Save and Restore Filters

Basic and Advanced filters can be saved in order to preconfigure a list of filters and restore them at any time. This feature is only available in own dashboards but can be shared with other users.

You can save a filter by fullfilling the filter name in the field at the bottom of the filter panel and clicking on the save button. When a filter is saved, it is stored in the widget’s filter list and can be restored at any time by selecting it from the saved filters list located at the top of the filter panel.

Filters can be saved only when a new filter is created.

This can be useful when you want to save a list of filters that you use frequently and restore them at any time.

Widget Menu

Menu action list

The following actions can be performed:

  • Download: Data download in CSV format
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Selection and Operations on Entities

Selection

The following actions can be performed on the selected alarm entities:

  • Filter: Data will be displayed after filtering on the selected alarm entities
  • Execute Operations: Perform an operation on the selected alarm entities

Temporarily Sort and Hide Column

Sort menu

Actions Per Entity

Row actions

The following actions can be performed:

  • Alarm detail: Opens the information widget for an alarm
  • Execute operation: Perform an operation on the selected alarm entity
  • Close: Opens the alarm wizard to close the selected alarm
  • Attend: Opens the alarm wizard to address the selected alarm
  • Open alarm information: Opens a temporary dashboard that will display information related to the alarm
  • Open device details: Opens the information widget for an entity with the entity’s data
  • Edit entity: Edits the entity by opening the corresponding wizard for the type of alarm entity selected
  • Open device information: Opens a temporary dashboard that will display information related to the alarm entity

Configuration

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

Cell Configuration

Column configuration
  • Alias: Modify the column name. If nothing is added, it will use the default configured name.

  • Show entity actions: Allow displaying the actions menu when selecting its value in the cell. If the column is an identifier, this field will be enabled.

  • Hidden column: Enabling this option will hide the column from the user. This is useful when you need the data for formatting purposes, as only the data required in the list will be available.

  • Options:

    • Modify the cell’s width and horizontal alignment of its content. Column width
    • Format the cell’s value. Column formatter
  • Pagination: Configure the number of rows to display per page. Table pagination

Virtual columns

Also you can add virtual columns to lists.

Virtual Column config

These columns do not have their own values ​​and must be configured in the column formatter once added.

Virtual Column Formatter

Please note that the contents of this column will never be output to CSV, as it is calculated on the fly and does not rely on any native platform resources.

Virtual Column

Button columns

Also you can add button columns to lists in order to execute some custom action related with the row data.

Button Column config

Button label can be setted in normal or virtual columns. Label will be the value.

Button action code receives the complete rowData and you can open other dashboards, entities dashboards or execute wizards.

Button Column Formatter

You can find all available functions and methods in Extra parameters

Advanced

In this section, you will configure various filters that will be applied to queries regardless of the user’s specific filtering preferences.

Advanced Configuration

Widget Filters Configuration

Here you can define how widget filters should behave when sharing the dashboard with other users/organizations. This means that when sharing, a user opens these dashboards and won’t see the filters applied to the original dashboard in the specified widgets, preventing the information displayed from changing after a dashboard refresh.

The three possible options are:

  • Don’t share the widget’s general filter
  • Don’t share header filters in lists
  • Don’t share sorting in lists

Entities List

The list of entities allows you to view and manage various types of entities: asset, device, subscriber, subscription; created within your organization.

How it works

Below are the actions that can be performed both within the widget and on the displayed data.

Entity List

Filter by Columns

column filter

Basic Filter

Basic filter

Perform a basic search by entering text that will filter by predefined fields.

Advanced Filter

Advanced filter

Perform a search by selecting the fields to filter by and how to filter by them.

Save and Restore Filters

Basic and Advanced filters can be saved in order to preconfigure a list of filters and restore them at any time. This feature is only available in own dashboards but can be shared with other users.

You can save a filter by fullfilling the filter name in the field at the bottom of the filter panel and clicking on the save button. When a filter is saved, it is stored in the widget’s filter list and can be restored at any time by selecting it from the saved filters list located at the top of the filter panel.

Filters can be saved only when a new filter is created.

This can be useful when you want to save a list of filters that you use frequently and restore them at any time.

Widget Menu

Menu action list

The following actions can be performed:

  • Download: Download data in CSV format
  • Create Device: Opens the device creation wizard
  • Create Asset: Opens the asset creation wizard
  • Create Subscription: Opens the subscription creation wizard
  • Create Subscriber: Opens the subscriber creation wizard
  • View in map: Opens the Maps widget, displaying the location of the entities shown in the table
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Selection and Operations on Entities

Selection

The following actions can be performed on the selected entities:

  • Filter: Will display data filtered based on the selected entities
  • Execute operations: Execute an operation on the selected entities
  • Delete: Delete all selected entities and entities related to them

Sort and Temporarily Hide Columns

Sort menu

Actions per Entity

Row actions

The following actions can be performed:

  • Edit: Edit the entity by opening the corresponding wizard for the type of entity
  • Execute operation: Execute an operation on the displayed entity
  • Collect: Simulate data collection on an entity
  • Open device information: Opens a temporary dashboard displaying information related to the entity
  • Open device details: Opens the information widget of an entity with the entity’s data
  • View hierarchy of the entity: Opens the hierarchy widget to display the hierarchy of the entity
  • Delete: Deletes the entity

Configuration

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

Column Selection

Data Stream select

Steps to select and configure the value of a datastream in a column:

  • Select one or more data streams.
  • Choose which values from these data streams to display; these will become different columns.
  • Once selected, click the + button.

Cell Configuration

Column configuration
  • Alias: Modify the column name. If nothing is added, it will use the default configured name.

  • Show entity actions: Allow displaying the actions menu when selecting its value in the cell. If the column is an identifier, this field will be enabled.

  • Hidden column: Enabling this option will hide the column from the user. This is useful when you need the data for formatting purposes, as only the data required in the list will be available.

  • Options:

    • Modify the cell’s width and horizontal alignment of its content. Column width
    • Format the cell’s value. Column formatter
  • Pagination: Configure the number of rows to display per page. Table pagination

Virtual columns

Also you can add virtual columns to lists.

Virtual Column config

These columns do not have their own values ​​and must be configured in the column formatter once added.

Virtual Column Formatter

Please note that the contents of this column will never be output to CSV, as it is calculated on the fly and does not rely on any native platform resources.

Virtual Column

Button columns

Also you can add button columns to lists in order to execute some custom action related with the row data.

Button Column config

Button label can be setted in normal or virtual columns. Label will be the value.

Button action code receives the complete rowData and you can open other dashboards, entities dashboards or execute wizards.

Button Column Formatter

You can find all available functions and methods in Extra parameters

Advanced

In this section, you will configure various filters that will be applied to queries regardless of the user’s specific filtering preferences.

Advanced Configuration

Widget Filters Configuration

Here you can define how widget filters should behave when sharing the dashboard with other users/organizations. This means that when sharing, a user opens these dashboards and won’t see the filters applied to the original dashboard in the specified widgets, preventing the information displayed from changing after a dashboard refresh.

The three possible options are:

  • Don’t share the widget’s general filter
  • Don’t share header filters in lists
  • Don’t share sorting in lists

Executions List

The list of operation executions allows you to view and manage the operation executions performed on various types of OpenGate entities: devices, subscribers, and subscriptions.

How it works

Below are the actions that can be performed both within the widget and on the displayed data.

Entity List

Filter by Columns

column filter

Basic Filter

Basic filter

Perform a basic search by entering text that will filter by predefined fields.

Advanced Filter

Advanced filter

Perform a search by selecting the fields to filter by and how to filter by them.

Save and Restore Filters

Basic and Advanced filters can be saved in order to preconfigure a list of filters and restore them at any time. This feature is only available in own dashboards but can be shared with other users.

You can save a filter by fullfilling the filter name in the field at the bottom of the filter panel and clicking on the save button. When a filter is saved, it is stored in the widget’s filter list and can be restored at any time by selecting it from the saved filters list located at the top of the filter panel.

Filters can be saved only when a new filter is created.

This can be useful when you want to save a list of filters that you use frequently and restore them at any time.

Widget Menu

Menu action list

The following actions can be performed:

  • Download: Download data in CSV format
  • Execute operation: Opens the operation execution wizard
  • Show history operation: A switch that allows viewing either in-progress or completed executions.
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Selection and Operations on Entities

Selection

The following actions can be performed on the selected entities of the executions:

  • Filter: Data will be displayed filtered based on the selected entities
  • Execute operations: Execute an operation on the entities

Sort and Temporarily Hide Columns

Sort menu

Actions per Entity

Row actions

The following actions can be performed:

  • Execute operation: Execute an operation on the execution’s entity
  • Open device information: Opens a temporary dashboard displaying information related to the execution’s entity
  • Open device details: Opens the information widget of an entity with the execution entity’s data
  • Execution details: Opens the execution information widget
  • Edit entity: Edit the entity by opening the corresponding wizard for the type of the execution’s entity

Configuration

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

Cell Configuration

Column configuration
  • Alias: Modify the column name. If nothing is added, it will use the default configured name.

  • Show entity actions: Allow displaying the actions menu when selecting its value in the cell. If the column is an identifier, this field will be enabled.

  • Hidden column: Enabling this option will hide the column from the user. This is useful when you need the data for formatting purposes, as only the data required in the list will be available.

  • Options:

    • Modify the cell’s width and horizontal alignment of its content. Column width
    • Format the cell’s value. Column formatter
  • Pagination: Configure the number of rows to display per page. Table pagination

Virtual columns

Also you can add virtual columns to lists.

Virtual Column config

These columns do not have their own values ​​and must be configured in the column formatter once added.

Virtual Column Formatter

Please note that the contents of this column will never be output to CSV, as it is calculated on the fly and does not rely on any native platform resources.

Virtual Column

Button columns

Also you can add button columns to lists in order to execute some custom action related with the row data.

Button Column config

Button label can be setted in normal or virtual columns. Label will be the value.

Button action code receives the complete rowData and you can open other dashboards, entities dashboards or execute wizards.

Button Column Formatter

You can find all available functions and methods in Extra parameters

Resource Configuration

Resource

Execution listings will be displayed for only one type of entity.

By default, entities of the type Device will be displayed.

Advanced

In this section, you will configure various filters that will be applied to queries regardless of the user’s specific filtering preferences.

Advanced Configuration

Widget Filters Configuration

Here you can define how widget filters should behave when sharing the dashboard with other users/organizations. This means that when sharing, a user opens these dashboards and won’t see the filters applied to the original dashboard in the specified widgets, preventing the information displayed from changing after a dashboard refresh.

The three possible options are:

  • Don’t share the widget’s general filter
  • Don’t share header filters in lists
  • Don’t share sorting in lists

Operations List

The list of operations allows you to view/manage operations performed on various types of entities: device, subscriber, and subscription.

How it works

Below are the actions that can be performed both within the widget and on the displayed data.

Entity List

Filter by Columns

column filter

Basic Filter

Basic filter

Perform a basic search by entering text that will filter by predefined fields.

Advanced Filter

Advanced filter

Perform a search by selecting the fields to filter by and how to filter by them.

Save and Restore Filters

Basic and Advanced filters can be saved in order to preconfigure a list of filters and restore them at any time. This feature is only available in own dashboards but can be shared with other users.

You can save a filter by fullfilling the filter name in the field at the bottom of the filter panel and clicking on the save button. When a filter is saved, it is stored in the widget’s filter list and can be restored at any time by selecting it from the saved filters list located at the top of the filter panel.

Filters can be saved only when a new filter is created.

This can be useful when you want to save a list of filters that you use frequently and restore them at any time.

Widget Menu

Menu action list

The following actions can be performed:

  • Download: Download data in CSV format

  • Execute operation: Opens the operation execution wizard

  • Toggle selection: Allows toggling the selection of operations via check. This enables viewing in other compatible widgets the content filtered by this information.

  • Capture screen: Takes a screenshot of the widget.

  • Duplicate widget: Creates a duplicate of the widget on the dashboard.

  • Copy widget: Copies the widget to another dashboard.

  • Change widget location: Moves the widget to another dashboard.

Sort and Temporarily Hide Columns

Sort menu

Actions per Entity

Row actions

The following actions can be performed:

  • Device execution list: Opens the execution listing widget, filtering by the operation and selecting the entity type ‘device’
  • Subscription execution list: Opens the execution listing widget, filtering by the operation and selecting the entity type ‘subscription’
  • Subscriber execution list: Opens the execution listing widget, filtering by the operation and selecting the entity type ‘subscriber’

Configuration

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

Cell Configuration

Column configuration
  • Alias: Modify the column name. If nothing is added, it will use the default configured name.

  • Show entity actions: Allow displaying the actions menu when selecting its value in the cell. If the column is an identifier, this field will be enabled.

  • Hidden column: Enabling this option will hide the column from the user. This is useful when you need the data for formatting purposes, as only the data required in the list will be available.

  • Options:

    • Modify the cell’s width and horizontal alignment of its content. Column width
    • Format the cell’s value. Column formatter
  • Pagination: Configure the number of rows to display per page. Table pagination

Virtual columns

Also you can add virtual columns to lists.

Virtual Column config

These columns do not have their own values ​​and must be configured in the column formatter once added.

Virtual Column Formatter

Please note that the contents of this column will never be output to CSV, as it is calculated on the fly and does not rely on any native platform resources.

Virtual Column

Button columns

Also you can add button columns to lists in order to execute some custom action related with the row data.

Button Column config

Button label can be setted in normal or virtual columns. Label will be the value.

Button action code receives the complete rowData and you can open other dashboards, entities dashboards or execute wizards.

Button Column Formatter

You can find all available functions and methods in Extra parameters

Advanced

In this section, you will configure various filters that will be applied to queries regardless of the user’s specific filtering preferences.

Advanced Configuration

Widget Filters Configuration

Here you can define how widget filters should behave when sharing the dashboard with other users/organizations. This means that when sharing, a user opens these dashboards and won’t see the filters applied to the original dashboard in the specified widgets, preventing the information displayed from changing after a dashboard refresh.

The three possible options are:

  • Don’t share the widget’s general filter
  • Don’t share header filters in lists
  • Don’t share sorting in lists

Schedulers History List

The schedulers history list allows you to view the execution history of the schedulers configured in your organization.

How it works

Below are the actions that can be performed both within the widget and on the displayed data.

Schedulers History List

Filter by Columns

Column filter

Basic Filter

Basic filter

Perform a basic search by entering text that will filter by predefined fields.

Widget Menu

Menu action list

The following actions can be performed:

  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Configuration

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

Cell Configuration

Column configuration
  • Alias: Modify the column name. If nothing is added, it will use the default configured name.

  • Show entity actions: Allow displaying the actions menu when selecting its value in the cell. If the column is an identifier, this field will be enabled.

  • Hidden column: Enabling this option will hide the column from the user. This is useful when you need the data for formatting purposes, as only the data required in the list will be available.

  • Options:

    • Modify the cell’s width and horizontal alignment of its content. Column width
    • Format the cell’s value. Column formatter
  • Pagination: Configure the number of rows to display per page. Table pagination

Virtual columns

Also you can add virtual columns to lists.

Virtual Column config

These columns do not have their own values ​​and must be configured in the column formatter once added.

Virtual Column Formatter

Please note that the contents of this column will never be output to CSV, as it is calculated on the fly and does not rely on any native platform resources.

Virtual Column

Button columns

Also you can add button columns to lists in order to execute some custom action related with the row data.

Button Column config

Button label can be setted in normal or virtual columns. Label will be the value.

Button action code receives the complete rowData and you can open other dashboards, entities dashboards or execute wizards.

Button Column Formatter

You can find all available functions and methods in Extra parameters

Advanced

In this section, you will configure various filters that will be applied to queries regardless of the user’s specific filtering preferences.

Advanced Configuration

Widget Filters Configuration

Here you can define how widget filters should behave when sharing the dashboard with other users/organizations. This means that when sharing, a user opens these dashboards and won’t see the filters applied to the original dashboard in the specified widgets, preventing the information displayed from changing after a dashboard refresh.

The three possible options are:

  • Don’t share the widget’s general filter
  • Don’t share header filters in lists
  • Don’t share sorting in lists

Tickets List

The list of tickets allows you to view/manage the tickets created within your organization.

How it works

Below are the actions that can be performed both within the widget and on the displayed data.

Entity List

Filter by Columns

column filter

Basic Filter

Basic filter

Perform a basic search by entering text that will filter by predefined fields.

Advanced Filter

Advanced filter

Perform a search by selecting the fields to filter by and how to filter by them.

Save and Restore Filters

Basic and Advanced filters can be saved in order to preconfigure a list of filters and restore them at any time. This feature is only available in own dashboards but can be shared with other users.

You can save a filter by fullfilling the filter name in the field at the bottom of the filter panel and clicking on the save button. When a filter is saved, it is stored in the widget’s filter list and can be restored at any time by selecting it from the saved filters list located at the top of the filter panel.

Filters can be saved only when a new filter is created.

This can be useful when you want to save a list of filters that you use frequently and restore them at any time.

Widget Menu

Menu action list

The following actions can be performed:

  • Download: Download data in CSV format
  • Create Ticket: Opens the ticket creation wizard
  • View in map: Opens the Maps widget, displaying the locations of the entities shown in the table
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Sort and Temporarily Hide Columns

Sort menu

Actions per Entity

Row actions

The following actions can be performed:

  • Open ticket information: Opens a temporary dashboard displaying information related to the ticket
  • Open ticket details: Opens the widget with ticket information and details
  • Edit ticket: Opens the ticket wizard to edit the ticket
  • Open device information: Opens a temporary dashboard displaying information related to the device associated with the ticket
  • Open device details: Opens the widget with information about the entity and details of the device associated with the ticket
  • Edit device: Opens the device wizard to edit the device associated with the entity
  • Execute operation: Executes an operation on the device associated with the ticket
  • Delete: Deletes the ticket

Configuration

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

Column Selection

Data Stream select

Steps to select and configure the value of a datastream in a column:

  • Select one or more data streams.
  • Choose which values from these data streams to display; these will become different columns.
  • Once selected, click the + button.

Cell Configuration

Column configuration
  • Alias: Modify the column name. If nothing is added, it will use the default configured name.

  • Show entity actions: Allow displaying the actions menu when selecting its value in the cell. If the column is an identifier, this field will be enabled.

  • Hidden column: Enabling this option will hide the column from the user. This is useful when you need the data for formatting purposes, as only the data required in the list will be available.

  • Options:

    • Modify the cell’s width and horizontal alignment of its content. Column width
    • Format the cell’s value. Column formatter
  • Pagination: Configure the number of rows to display per page. Table pagination

Virtual columns

Also you can add virtual columns to lists.

Virtual Column config

These columns do not have their own values ​​and must be configured in the column formatter once added.

Virtual Column Formatter

Please note that the contents of this column will never be output to CSV, as it is calculated on the fly and does not rely on any native platform resources.

Virtual Column

Button columns

Also you can add button columns to lists in order to execute some custom action related with the row data.

Button Column config

Button label can be setted in normal or virtual columns. Label will be the value.

Button action code receives the complete rowData and you can open other dashboards, entities dashboards or execute wizards.

Button Column Formatter

You can find all available functions and methods in Extra parameters

Advanced

In this section, you will configure various filters that will be applied to queries regardless of the user’s specific filtering preferences.

Advanced Configuration

Widget Filters Configuration

Here you can define how widget filters should behave when sharing the dashboard with other users/organizations. This means that when sharing, a user opens these dashboards and won’t see the filters applied to the original dashboard in the specified widgets, preventing the information displayed from changing after a dashboard refresh.

The three possible options are:

  • Don’t share the widget’s general filter
  • Don’t share header filters in lists
  • Don’t share sorting in lists

Time Series data List

The listing allows us to see the values provided by a time series and manage the entities related to it.

How it works

Below are the actions that can be performed both within the widget and on the displayed data.

Entity List

Filter by Columns

column filter

Advanced Filter

Advanced filter

Perform a search by selecting the fields to filter by and how to filter by them.

Save and Restore Filters

Basic and Advanced filters can be saved in order to preconfigure a list of filters and restore them at any time. This feature is only available in own dashboards but can be shared with other users.

You can save a filter by fullfilling the filter name in the field at the bottom of the filter panel and clicking on the save button. When a filter is saved, it is stored in the widget’s filter list and can be restored at any time by selecting it from the saved filters list located at the top of the filter panel.

Filters can be saved only when a new filter is created.

This can be useful when you want to save a list of filters that you use frequently and restore them at any time.

Widget Menu

Menu action list

The following actions can be performed:

  • Download: Data download in CSV format
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Sorting

Sort menu

If time series has sorting columns configured, the sort menu will display the configured sorting columns.

You can apply the sorting configuration by clicking on the sorting configuration desired and remove with the clean button.

Actions by Entity

Row actions

The actions to be performed will depend on the type of entity that is set as the identifying column:

  • Edit: Edit the entity by opening the corresponding wizard for that entity type
  • Execute operation: Perform an operation on the displayed entity
  • Collect: Simulate data collection on an entity (if the entity type supports this action)
  • Open device/asset/subscriber/subscription information: Open a temporary dashboard that will display information related to the entity
  • Open device/asset/subscriber/subscription details: Open the information widget for an entity with the entity’s details
  • View hierarchy of the entity: Open the hierarchy widget to display the hierarchy of the entity (if the entity type supports this action)
  • Delete: Delete the entity

Configuration

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

Dataset and Column Selection

Data set select
  • Organization: Select the organization to which the dataset belongs
  • Data set: Select the dataset
  • Columns: Select the configured columns in the dataset

Column Identifier Selection

Data set row identifier

Select the identifying column. Based on the value of this column, the table will display different actions to be performed on each of its rows.

Cell Configuration

Column configuration
  • Alias: Modify the column name. If nothing is added, it will use the default configured name.

  • Show entity actions: Allow displaying the actions menu when selecting its value in the cell. If the column is an identifier, this field will be enabled.

  • Hidden column: Enabling this option will hide the column from the user. This is useful when you need the data for formatting purposes, as only the data required in the list will be available.

  • Options:

    • Modify the cell’s width and horizontal alignment of its content. Column width
    • Format the cell’s value. Column formatter
  • Pagination: Configure the number of rows to display per page. Table pagination

Virtual columns

Also you can add virtual columns to lists.

Virtual Column config

These columns do not have their own values ​​and must be configured in the column formatter once added.

Virtual Column Formatter

Please note that the contents of this column will never be output to CSV, as it is calculated on the fly and does not rely on any native platform resources.

Virtual Column

Button columns

Also you can add button columns to lists in order to execute some custom action related with the row data.

Button Column config

Button label can be setted in normal or virtual columns. Label will be the value.

Button action code receives the complete rowData and you can open other dashboards, entities dashboards or execute wizards.

Button Column Formatter

You can find all available functions and methods in Extra parameters

Advanced

In this section, you will configure various filters that will be applied to queries regardless of the user’s specific filtering preferences.

Advanced Configuration

Widget Filters Configuration

Here you can define how widget filters should behave when sharing the dashboard with other users/organizations. This means that when sharing, a user opens these dashboards and won’t see the filters applied to the original dashboard in the specified widgets, preventing the information displayed from changing after a dashboard refresh.

The three possible options are:

  • Don’t share the widget’s general filter
  • Don’t share header filters in lists
  • Don’t share sorting in lists

Users List

The user listing allows for viewing/managing the users of the organization.

How it works

Below are the actions that can be performed both within the widget and on the displayed data.

Entity List

Filter by Columns

column filter

Basic Filter

Basic filter

Perform a basic search by entering text that will filter by predefined fields.

Advanced Filter

Advanced filter

Perform a search by selecting the fields to filter by and how to filter by them.

Save and Restore Filters

Basic and Advanced filters can be saved in order to preconfigure a list of filters and restore them at any time. This feature is only available in own dashboards but can be shared with other users.

You can save a filter by fullfilling the filter name in the field at the bottom of the filter panel and clicking on the save button. When a filter is saved, it is stored in the widget’s filter list and can be restored at any time by selecting it from the saved filters list located at the top of the filter panel.

Filters can be saved only when a new filter is created.

This can be useful when you want to save a list of filters that you use frequently and restore them at any time.

Widget Menu

Menu action list

The following actions can be performed:

  • New user: Opens the user creation wizard
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Sort and Temporarily Hide Columns

Sort menu

Actions by Entity

Row actions

The following actions can be performed:

  • Edit: Opens the user editing wizard
  • Delete: Deletes the user

Configuration

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

Cell Configuration

Column configuration
  • Alias: Modify the column name. If nothing is added, it will use the default configured name.

  • Show entity actions: Allow displaying the actions menu when selecting its value in the cell. If the column is an identifier, this field will be enabled.

  • Hidden column: Enabling this option will hide the column from the user. This is useful when you need the data for formatting purposes, as only the data required in the list will be available.

  • Options:

    • Modify the cell’s width and horizontal alignment of its content. Column width
    • Format the cell’s value. Column formatter
  • Pagination: Configure the number of rows to display per page. Table pagination

Virtual columns

Also you can add virtual columns to lists.

Virtual Column config

These columns do not have their own values ​​and must be configured in the column formatter once added.

Virtual Column Formatter

Please note that the contents of this column will never be output to CSV, as it is calculated on the fly and does not rely on any native platform resources.

Virtual Column

Button columns

Also you can add button columns to lists in order to execute some custom action related with the row data.

Button Column config

Button label can be setted in normal or virtual columns. Label will be the value.

Button action code receives the complete rowData and you can open other dashboards, entities dashboards or execute wizards.

Button Column Formatter

You can find all available functions and methods in Extra parameters

Advanced

In this section, you will configure various filters that will be applied to queries regardless of the user’s specific filtering preferences.

Advanced Configuration

Widget Filters Configuration

Here you can define how widget filters should behave when sharing the dashboard with other users/organizations. This means that when sharing, a user opens these dashboards and won’t see the filters applied to the original dashboard in the specified widgets, preventing the information displayed from changing after a dashboard refresh.

The three possible options are:

  • Don’t share the widget’s general filter
  • Don’t share header filters in lists
  • Don’t share sorting in lists

Subsections of Maps

Areas Map

Widget that displays the areas provisioned for an organization.

How it works

Map

The popup will display relevant information about the area as well as certain actions:

  • edit area
  • delete area

Basic Filter

Basic filter

Perform a basic search by entering text that will filter by predefined fields.

Advanced Filter

Advanced filter

Perform a search by selecting the fields to filter by and how to filter by them.

Save and Restore Filters

Basic and Advanced filters can be saved in order to preconfigure a list of filters and restore them at any time. This feature is only available in own dashboards but can be shared with other users.

You can save a filter by fullfilling the filter name in the field at the bottom of the filter panel and clicking on the save button. When a filter is saved, it is stored in the widget’s filter list and can be restored at any time by selecting it from the saved filters list located at the top of the filter panel.

Filters can be saved only when a new filter is created.

This can be useful when you want to save a list of filters that you use frequently and restore them at any time.

Widget Menu

Menu action list

The following actions can be performed:

  • New area: will open the area wizard to create a new area
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Configuration

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters


Maps

Widget that displays entities with location, both provisioned and collected.

How it works

Map

Basic Filter

Basic filter

Perform a basic search by entering text that will filter by predefined fields.

Advanced Filter

Advanced filter

Perform a search by selecting the fields to filter by and how to filter by them.

Save and Restore Filters

Basic and Advanced filters can be saved in order to preconfigure a list of filters and restore them at any time. This feature is only available in own dashboards but can be shared with other users.

You can save a filter by fullfilling the filter name in the field at the bottom of the filter panel and clicking on the save button. When a filter is saved, it is stored in the widget’s filter list and can be restored at any time by selecting it from the saved filters list located at the top of the filter panel.

Filters can be saved only when a new filter is created.

This can be useful when you want to save a list of filters that you use frequently and restore them at any time.

Advanced filter

The popup will display relevant information about the device as well as certain actions:

  • edit entity
  • view entity details
  • open a temporary dashboard with information about the entity

Widget Menu

Menu action list

The following actions can be performed:

  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Configuration

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

General
  • View Devices
  • Show Heat Map
  • Override colors with qRating performance
  • Override colors with entity alarms
  • Trackers: each of the points to display can be configured based on the data streams from which the location is retrieved. It is selected from the Datastream Id combo Trackers - alias: modification of the popup title for the pin - icon: pin icon - color: pin color - formatter: pin formatter

Areas

Areas

Configuration of area display and management.

Popup

Configuration of the data to be displayed in the popup.

External resources

External resources

Advanced

Advanced

Editing of clusters and configuring various filters that will be applied to queries regardless of what the user may wish to filter later on.


Tracking

Widget for tracking an entity on the map.

How it works

Map

Trackers

Trackers

Allows us to select a tracker from the list of configured trackers.

Basic Filter

Basic filter

Searches can be conducted by date.

Widget Menu

Menu action list

The following actions can be performed:

  • Open device information: opens the temporary panel corresponding to the selected entity
  • Edit: opens the wizard corresponding to the selected entity
  • Execute operation: opens the pre-configured operation launcher for the selected entity
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Configuration

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

General
  • Entity key: entity to be displayed on the map
  • Trackers: configuration of each of the data streams from which we retrieve the collected and/or provisioned location information Trackers - alias: modification of the title of the pin’s popup - color: color of the tracker - route simulation: route simulation

Areas

Areas

Configuration of the area display and management.


Subsections of Miscellaneous

Clock

Allows viewing the time and day on the website.

How it works

Clock

Widget Menu

Menu action list
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Configuration

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

  • Time format: Time format, following the format of the tool momentjs
  • Date format: Date format, following the format of the tool momentjs

Iframe

Widget that allows embedding a page within the website.

How it works

Iframe
Content from file

From the file manager, you can copy the URL of a file that you can insert into this widget.

Widget Menu

Menu action list
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Configuration

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

  • URL: URL of the page or file to load

Markdown

Displays text in markdown format.

How it works

Markdown

Widget Menu

Menu action list
  • Capture screen: Takes a screenshot of the widget.
  • Duplicate widget: Creates a duplicate of the widget on the dashboard.
  • Copy widget: Copies the widget to another dashboard.
  • Change widget location: Moves the widget to another dashboard.

Configuration

Configuration

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

  • Markdown: Text in markdown format. A preview of the entered text is displayed.

Wizards

Subsections of Wizards

Administration

Subsections of Administration

Create Manufacturer

Allows the creation of hardware manufacturers, used for associating entities and for being able to attach files to models, such as images or logos.

Steps

Manufacturer Wizard

Essential data for the registration and identification of a manufacturer on the platform.

Creation

NOTE: There is the possibility to configure the manufacturer by organization by selecting the equivalent wizard

Create manufacturer model

Allows for the creation of hardware models and the ability to associate files with these models, such as images or logos.

Steps

Creating a Model

Essential data for the registration and identification of a model on the platform.

Creation

Create new Area

This wizard allows us to create areas.

Steps

Administration Info

Information for the registration and identification for the creation of a new area.

AdministrationInfo

Area Design

In this step, you can build or import the area itself.

Allowed actions:

  • Import GeoJSON file - Imports a file from the computer
  • Paste GeoJSON file - Opens the paste tool where you can paste the content of a GeoJSON file from your favorite editor.

In the map, you can see the following tools:

  • Polyline tool: You can draw a line on the map without an area
  • Polygon tool: Allows you to create a free form that contains an area on the map
  • Rectangle tool: Allows you to create a rectangle that contains an area on the map
  • Circle tool: This tool draws circles that contain an area on the map
AdministrationInfo

Import/Export Configuration

Allows you to import and export the wizard’s configuration via JSON.

btnJson

When accessing the import and export functionality, it displays a window with various actions. Additionally, it presents the configuration of the wizard in JSON format.

The available actions are as follows:

  • Upload Json: Uploads a JSON file and replaces the previous JSON configuration.
  • Paste from clipboard: Pastes JSON data from the clipboard and replaces the previous JSON configuration.
  • Download Json: Downloads the JSON configuration as a file with the wizard’s name.
  • Copy to clipboard: Copies the JSON configuration to the clipboard.
items

Create new Channel

This wizard allows us to create channels to group devices within the same organization.

Steps

Channel Creation

Essential data for the registration and identification of a channel on the platform.

Creation

Import/Export Configuration

Allows you to import and export the wizard’s configuration via JSON.

btnJson

When accessing the import and export functionality, it displays a window with various actions. Additionally, it presents the configuration of the wizard in JSON format.

The available actions are as follows:

  • Upload Json: Uploads a JSON file and replaces the previous JSON configuration.
  • Paste from clipboard: Pastes JSON data from the clipboard and replaces the previous JSON configuration.
  • Download Json: Downloads the JSON configuration as a file with the wizard’s name.
  • Copy to clipboard: Copies the JSON configuration to the clipboard.
items

Create new Data Model

This wizard allows us to create data models for customizing data within the platform’s entities.

Steps

Data Model

Data for registration and identification for creating a data model on the platform.

Creation

Category

Data for the data model. We will add a category by clicking the + button. We will enter an identifier and optionally a name. Then we click the add button.

Category

General

  • Boxed: widget will be displayed with background in dahsboard.
  • About: widget description in Markdown format.
  • Title: widget title. It can be configured to remain fixed in the widget or only be displayed when it receives focus.
  • Toolbar: configures the behavior of the widget bar on the dashboard, allowing you to hide it, hide it when not in use, or leave it always visible.
  • Refresh Frequency: allows configuring the data refresh frequency displayed in the list.
  • Extra actions: allows user to add new specific actions to the widget with your own code.

Extra action config

You can add a new one by pressing the New button.

Once you added a custom action it can be modified later by pressing the name in the list.

In order to remove the custom action click the delete icon button on the right.

In extra actions you can write your own code were you can open other dashboards, entities dashboards or execute wizards.

Extra action code

You can find all available functions and methods in Extra parameters

We can add a data stream, and the data stream creation wizard will open. We will select the type of data stream we are going to create, either collection or provision.

AddDatastream

Qrating

If a version number is entered, a series of fields for filling out the Qrating will appear.

Qrating

Storage

By default, the storage period will appear in DAYS, but it can be changed to SECONDS, MINUTES, or NEVER.

Storage

Import/Export Configuration

Allows you to import and export the wizard’s configuration via JSON.

btnJson

When accessing the import and export functionality, it displays a window with various actions. Additionally, it presents the configuration of the wizard in JSON format.

The available actions are as follows:

  • Upload Json: Uploads a JSON file and replaces the previous JSON configuration.
  • Paste from clipboard: Pastes JSON data from the clipboard and replaces the previous JSON configuration.
  • Download Json: Downloads the JSON configuration as a file with the wizard’s name.
  • Copy to clipboard: Copies the JSON configuration to the clipboard.
items

Create new Device Plan

This wizard allows us to manage device plans.

Steps

Device Plan Creation

Essential data for the registration and identification of a device plan on the platform.

Creation

Import/Export Configuration

Allows you to import and export the wizard’s configuration via JSON.

btnJson

When accessing the import and export functionality, it displays a window with various actions. Additionally, it presents the configuration of the wizard in JSON format.

The available actions are as follows:

  • Upload Json: Uploads a JSON file and replaces the previous JSON configuration.
  • Paste from clipboard: Pastes JSON data from the clipboard and replaces the previous JSON configuration.
  • Download Json: Downloads the JSON configuration as a file with the wizard’s name.
  • Copy to clipboard: Copies the JSON configuration to the clipboard.
items

Create new notebook scheduler

This wizard allows us to create schedulers for the previously created Opengate data lab notebooks

Steps

Configuration

Essential data for the scheduler

Notebooks Scheduler Wizard

You need the next in order to schedule the execution of a notebook:

  • Notebook: notebook to be executed periodically
  • Report: enables saving for report generated by the notebook execution
  • Report retention days: days to be stored report in Opengate data lab
  • Cron pattern: pattern to configure when the notebook will be executed
  • Params: list of a pair of names and values to be passed to the notebook execution

Create new Organization

Allows for the creation of organizations.

Steps

Administrative Data

Data for registration and identification for data collection on the platform.

Administration

Location

Information about the organization’s location.

Location

Security

Configuration of passwords, policies, and authentication through external servers.

It allows the following configurations:

Default Authentication Method: Default authentication. LDAP: Authentication via LDAP.

Security Security Security

Advanced

Enables the copying of data models, channels, actions, views, data sets, and time series from the parent organization if they have been created previously.

Advanced

Import/Export Configuration

Allows you to import and export the wizard’s configuration via JSON.

btnJson

When accessing the import and export functionality, it displays a window with various actions. Additionally, it presents the configuration of the wizard in JSON format.

The available actions are as follows:

  • Upload Json: Uploads a JSON file and replaces the previous JSON configuration.
  • Paste from clipboard: Pastes JSON data from the clipboard and replaces the previous JSON configuration.
  • Download Json: Downloads the JSON configuration as a file with the wizard’s name.
  • Copy to clipboard: Copies the JSON configuration to the clipboard.
items

Create new Organization Plan

This wizard allows us to manage organization plans.

Steps

Organization Plan Creation

Essential data for the registration and identification of an organization plan on the platform.

Creation

Import/Export Configuration

Allows you to import and export the wizard’s configuration via JSON.

btnJson

When accessing the import and export functionality, it displays a window with various actions. Additionally, it presents the configuration of the wizard in JSON format.

The available actions are as follows:

  • Upload Json: Uploads a JSON file and replaces the previous JSON configuration.
  • Paste from clipboard: Pastes JSON data from the clipboard and replaces the previous JSON configuration.
  • Download Json: Downloads the JSON configuration as a file with the wizard’s name.
  • Copy to clipboard: Copies the JSON configuration to the clipboard.
items

Create new pipeline processor

This wizard allows us to create pipeline processors.

Steps

Administrative Data

Essential data for registration and identification of a pipeline in the platform.

Administration Data

Transformer and AI Model Configuration

Select transformers or models to execute.

Transformer and AI Model Configuration

Create new Provision Function

A Provision function will have JavaScript code that takes inbound data and calculates the actions to be performed for correct provisioning of entities (Assets, Devices, Subscriptions, and Subscribers).

Steps

Administrative Data

Essential data for the registration and identification of a provisioning function in the platform.

Creation

Definition

Processor configuration parameters and JavaScript processor specification.

Additionally, the definition of provisioning functions has a menu on the left side that allows for different actions:

- FullScreen
- Add Function
- Validate Code

FullScreen

Expands to occupy the entire screen, making it easier for visualization.

Creation

Add Function

Provides the option to add different functions.

Creation

Let’s add the “New entity” function.

Creation

Validate Code

Checks the JavaScript code; if it’s correct, it enables the Next button.

Creation

Summary

Summary of the data entered previously.

Creation

Create new WorkGroup

Allows the creation of work groups to group different channels and grant administration permissions to different user roles.

Steps

Data

Essential data for the registration and identification of a work group on the platform.

Creation

Import/Export Configuration

Allows you to import and export the wizard’s configuration via JSON.

btnJson

When accessing the import and export functionality, it displays a window with various actions. Additionally, it presents the configuration of the wizard in JSON format.

The available actions are as follows:

  • Upload Json: Uploads a JSON file and replaces the previous JSON configuration.
  • Paste from clipboard: Pastes JSON data from the clipboard and replaces the previous JSON configuration.
  • Download Json: Downloads the JSON configuration as a file with the wizard’s name.
  • Copy to clipboard: Copies the JSON configuration to the clipboard.
items

Dataset creation wizard

Allows for the creation of data sets.

Steps

Configuration

Data for the registration and identification for the creation of a new data set on the platform.

Configuration

Definition Columns

You need to select one or more data streams for the configuration of columns. Identifier Column is the name of the identification column. Once the data stream is selected, we will press the add button.

DefinitionColumns

The following data will then appear:

Path: if the data stream value field is selected and its type is not a basic type, then a data path must be selected until you reach a field with a basic type. Alias: Alias of the dataset. Apply Filter:

  • Always: Will always have to be filtered.
  • Yes: It can be filtered or not.
  • No: It will not be possible to filter.

Additionally, we can delete or close the dataset to improve visualization.

ColumnDataset

Here you can see a dataset in collapse format, with options for editing and deleting the dataset.

collapseDataset

Finally, we have a summary of the data set, where the following data will appear:

Name: name of the organization Organization: name of the organization Columns: columns with configured settings

collapseDataset

Sorting Columns

In this step you can define the columns that will be used to sort the time series. You can have multiple sorting configurations, each one with multiple columns.

Sorting Columns
  • Alias: Identifier for the sorting configuration.
  • Description: Description of the sorting configuration.
  • Columns: List of columns to be used for sorting.
    • Column: Column from the time series to be used for sorting.
    • Order: Order to be used for sorting.
      • Ascending: Ascending order.
      • Descending: Descending order.

Clone Data Set Configuration

In addition to creating a new data set, we can also clone an existing one and configure it.

collapseDataset

Clone Data Set Definition Columns

Having cloned the data set from a previously existing one, the previously configured columns will appear by default.

collapseDataset

Import/Export Configuration

Allows you to import and export the wizard’s configuration via JSON.

btnJson

When accessing the import and export functionality, it displays a window with various actions. Additionally, it presents the configuration of the wizard in JSON format.

The available actions are as follows:

  • Upload Json: Uploads a JSON file and replaces the previous JSON configuration.
  • Paste from clipboard: Pastes JSON data from the clipboard and replaces the previous JSON configuration.
  • Download Json: Downloads the JSON configuration as a file with the wizard’s name.
  • Copy to clipboard: Copies the JSON configuration to the clipboard.
items

Entities software wizard

Allows the management of the entities software, used for associating entities and for being able to configure in them.

Steps

Entitites Software Wizard

Essential data for the registration and identification of a software in your organization.

Creation

Here you can configure the following:

Organization: Organization were the software will be configured

Name: Visible name for the software

Version: Version of software

Type: The purpose of this piece of software. This can be SOFTWARE or FIRMWARE

Model: Models where this software can be selectable

Update related entities: by checking this allows the user to update related entities with the new information introduced (only available in edit mode)

Operations Management

Allows for the creation of new or cloned operations on the platform.

Steps

Administration

Essential data for the registration and identification of an operation on the platform.

Operations can either be new or cloned. However, existing operations will predominantly be used for cloning and subsequent modification.

New Operation

Creates a customized operation, and in this case, there is the option to import and export JSON. In a cloned operation, the JSON option will not be available.

NewOperation

Clone Operation

In this case, we will clone an operation to change the state of administration.

CloneOperation

Configuration

Parameters that define the operation’s configuration. By default, for a cloned operation, the JSON Schema field is already filled. You can view the field’s configuration.

Schema

In the Preview section, the result of the JSON Schema configuration will be displayed.

Schema

Import/Export Configuration

Allows you to import and export the wizard’s configuration via JSON. Clone operations do not allow the use of json import and export.

btnJson

When accessing the import and export functionality, it displays a window with various actions. Additionally, it presents the configuration of the wizard in JSON format.

The available actions are as follows:

  • Upload Json: Uploads a JSON file and replaces the previous JSON configuration.
  • Paste from clipboard: Pastes JSON data from the clipboard and replaces the previous JSON configuration.
  • Download Json: Downloads the JSON configuration as a file with the wizard’s name.
  • Copy to clipboard: Copies the JSON configuration to the clipboard.
items

Provision Wizards

This wizard allows us to create provision wizards.

Steps

Provision Wizard

Allows you to view and edit a created wizard view. From this wizard, you can create a new one, which will open the Wizard: New window.

NewProvision

Administrative Data

Essential data for the registration and identification of a provision wizard in the platform.

AdministrativeData

Set Your Fields

Add the customized steps that the wizard will have.

AddStep ListStep

In this case, select the steps admin and security.

For example, for the Admin step, select administrative state and operational status.

AdminStep

And for the Security step, select certificates.

Certificates

Set Your Default Values

See how the wizard would look graphically with the new steps added, and select default values if needed.

setDefaultValues

Previous Validations

Create validations that will be executed before the main action.

PreviousValidations

Post Actions

Create validations that will be executed after the main action.

PostActions

Import/Export Configuration

Allows you to import and export the wizard’s configuration via JSON.

btnJson

When accessing the import and export functionality, it displays a window with various actions. Additionally, it presents the configuration of the wizard in JSON format.

The available actions are as follows:

  • Upload Json: Uploads a JSON file and replaces the previous JSON configuration.
  • Paste from clipboard: Pastes JSON data from the clipboard and replaces the previous JSON configuration.
  • Download Json: Downloads the JSON configuration as a file with the wizard’s name.
  • Copy to clipboard: Copies the JSON configuration to the clipboard.
items

Rules

This wizard allows us to create rules.

Steps

Administration

Essential data for registration and identification for creating a rule in the platform.

Rules consist of Easy rules and Advanced rules, which are created differently in the second step.

We can configure a rule with the following options:

New rules: Create a new rule from scratch. From catalog: Create a rule from the catalog. Clone existing rule: Create a rule from a previously created one.

Easy rule

Build a rule using basic concepts for evaluation. You must select the rule type depending on whether you want a data stream collection, the operation result, or an event. When selecting Data Stream collection, the Data Stream button above will be enabled.

Administration

Clicking the Data Stream button will open a menu where you can search for and add the data stream, along with adding an alias.

Menu

However, if you select Operation result or Event as the rule type, the Data Stream button will not be visible.

For all three rule types, you need to select a parameter, which consists of an identifier, type, and value.

Parameters

Within the parameter menu, you will enter an identifier, type (string, integer, number, or boolean), and value.

Parameters

Rule Definition (Easy)

Build a rule using basic concepts for evaluation.

Rule Conditions

This will trigger the rule when the rule meets the filter conditions.

Select a data stream to compose the filter.

Condition

You can also add a group to add another condition to the filter.

Add Resource

Perform the following actions

Actions will be executed when the configured conditions are met.

There are different options within the New Action menu:

Actions

You can delay the action by a specified number of milliseconds, creating a wait threshold before executing the actions. In this case, creating a new alarm has been selected.

RuleCondition

Advanced rule

Build a rule using basic concepts for evaluation.

AdvancedRule

Just like easy rules, the same options exist. You need to select the rule type depending on whether you want a data stream collection, the operation result, or an event. When selecting Data Stream collection, the Data Stream button above will be enabled.

MenuDatastream

Rule Definition (Advanced)

Allows you to write the JavaScript code of the rule for evaluation. It also allows you to delay the execution of actions with a wait threshold.

DefinitionRule

Time Series

Allows you to create time series for collecting data from a device. It stores rows with columns and maintains aggregated values by column, grouped by configurable time periods.

Steps

Configuration

Essential data for registration and identification of a time series in the platform.

Configuration

Time Bucket

In time series, the data is grouped by time buckets (time intervals), and all received data columns in each bucket are updated using the selected aggregated function. To understand which bucket each row represents, you will have an additional column to view the end/init date of the selected bucket.

  • Retention: Column to view the end date of the selected bucket.
  • Time Bucket: Time interval taken as a reference for data grouping.
  • Bucket Column: Column to view the end date of the selected bucket (disabled if the time bucket is 0).
  • Bucket Init Column: Column to view the init date of the selected bucket (disabled if the time bucket is 0).
  • Origin: Date from which the time series starts.
Bucket

Data Columns

You need to select one or more data streams for the configuration of columns.

Identifier Column: Name for the column representing provision.administration.identifier._current.value path with filter=YES.

AddDatastreamData

Columns: These can be expanded or collapsed depending on the desired view.

  • Alias: Alias for the selected column.
  • Aggregation Field: Aggregation function applied to the current column.
  • Apply Filter: The dataset filter:
    • Always: Will always have to be filtered.
    • Yes: It can be filtered or not.
    • No: It will not be possible to filter.
Expand Collapse

Context Columns

You can add some columns as context information, and these columns will be added to the time series to be used in searching resources.

AddDatastreamContext
  • Columns:
    • Input Name: Name of the dataset.
    • Apply Filter: The dataset filter:
      • Always: Will always have to be filtered.
      • Yes: It can be filtered or not.
      • No: It will not be possible to filter.
    • Path: If a data stream value field is selected and its type is not a basic type, then the data path must be selected until you reach a field with a basic type.

Sorting Columns

In this step you can define the columns that will be used to sort the time series. You can have multiple sorting configurations, each one with multiple columns.

Sorting Columns
  • Alias: Identifier for the sorting configuration.
  • Description: Description of the sorting configuration.
  • Columns: List of columns to be used for sorting.
    • Column: Column from the time series to be used for sorting.
    • Order: Order to be used for sorting.
      • Ascending: Ascending order.
      • Descending: Descending order.

Summary

This step contains the summary of the time series to be created:

  • New Time series Data: Configuration data.
  • Bucket Info: Bucket configuration data.
  • Columns: Configured columns.
  • Context: Configured context columns.
Summary

Clone

In addition to creating a new dataset, you can clone a dataset from an existing one that has default data.

Clone

Import/Export Configuration

Allows you to import and export the wizard’s configuration using JSON.

btnJson

When accessing import and export, it shows a window with different actions. It also displays the wizard’s configuration in JSON format.

The available actions are as follows:

Upload JSON: Uploads a JSON file and replaces the previous JSON. Paste from clipboard: Pastes JSON from the clipboard and replaces the previous JSON. Download JSON: Downloads the JSON in a file with the name of the wizard. Copy to clipboard: Copies the JSON to the clipboard.

Items

Time series functions wizard

Allows for the creation of time series functions.

Steps

Administration

Data for the registration and identification of the time series function on the platform.

Administration

Here you can select the organization, name, description and value types allowed by the function.

Definition

This is the code of the time series function.

Definition

Here you can modify the code and test it simulating the input data using the receivedValues, extra and currentValue simulated params.

Received values Extra Current value

Summary

Finally you can review changes (except the code) in order to proceed.

Summary

Once you finish you may be able to select the function in a time series column.


Upload new data transformer

Allows you to upload files for the execution of a transformer.

Steps

Administration data

In this step, you must enter the administrative information for the transformer. The form contains the following fields: Organization - organizational location (required)

AdministrationData

Files

Here, you can upload the necessary Python files for the execution of the transformation. The first file will be the main execution file. Additional files can be Python library files necessary for the correct execution.

Files

Upload new predictive model

Allows you to upload files for the execution of a model.

Steps

Administration data

In this step, you must enter the administrative information for the predictive model. The form contains the following fields: Organization - organizational location (required)

Creation

Files

Here, you can upload the necessary Python files for the execution of the transformation. It’s necessary to use files with extensions PMML or ONNX.

Creation

User

Allows the creation of users on the platform.

Steps

User Data

Essential information for the registration and identification of a user on the platform.

All fields are mandatory.

Email: The email address must be valid. Password: The “Password” and “Password Repeat” fields must match. Profile: User profile to be assigned to the user. Organization: Administrative organization associated with the user. Workgroup: Workgroup indicating the management scope assigned to this user. This means the list of entities that the user can manage through the web and API interfaces.

Creation

Import/Export Configuration

Allows you to import and export the wizard’s configuration via JSON.

btnJson

When accessing the import and export functionality, it displays a window with various actions. Additionally, it presents the configuration of the wizard in JSON format.

The available actions are as follows:

  • Upload Json: Uploads a JSON file and replaces the previous JSON configuration.
  • Paste from clipboard: Pastes JSON data from the clipboard and replaces the previous JSON configuration.
  • Download Json: Downloads the JSON configuration as a file with the wizard’s name.
  • Copy to clipboard: Copies the JSON configuration to the clipboard.
items

Subsections of Operations

Create new Operation

With this wizard, you can execute an operation on devices.

Steps

Target and Type

Add the entities over which the operation is performed. You could already finish setting up the operation.

Target

Targets type:

  • Entities: Add identified entities by their entity-key separated by commas.
  • Tag: Add a single label containing entities. See Tags and entity tagging.
  • Filter: The operation will run on entities resulting from applying the current filter of the web (quick/advanced filter). This one requires an extra confirmation by the user before execution.
  • Choose an entity: Select the type of entity to recover by the filter executed. For example: Run the operation on all entities of type gateway result of applying the filter. See Job Request: Target List attributes and Creating a job, sorry, I meant execute a job (Using filters).

Choose Operation

Select the operation to execute. If the operation has specific parameters, they will be shown in the next step.

See Available Operation Types.

Parameters

Here you can set specific parameters of the selected operation in the previous step.

Parameters

See Available Operation Types.

The helper option allows you to add previously created packages and datastreams, in addition to enabling or disabling the Loading entity/operation information.

Helper HelperModal

Scheduled

Set when the operation will be executed.

Planning

The following sections show the different options available.

Now

The operation will be executed immediately.

Later

Set the time to pass (in minutes) before executing the operation.

Each option:

Set the frequency with which the operation will be executed.

Fields:

  • Number of minutes: Set the number of minutes to pass until the next execution.

For example: I want to run the operation every 3 minutes.

Periodically

Configure the periodic execution.

Fields:

  • Name of periodicity: Give a name to the execution.
  • Date when the operation will be executed: Set the date on which the execution will start.
  • Date when the operation will be executed:
  • Date: Set the date on which the execution will start.
  • Hour: Set the time at which each execution will start.
  • By repetitions: Set the number of repetitions of execution. If left empty, the execution will be repeated indefinitely.

Advanced Options

Here you can manage advanced features for execution like timers, scattering, and others.

Advanced

Timers

In this step, you can set different timers for the operation.

You could already finish setting up the operation.

  • Execution timeout: In seconds. Timeout for the execution of the operation on a single entity configured in step “Select target”. If the timeout is exceeded, the operation will be canceled for that entity.
  • Timeout in minutes: Timeout for the execution of the operation on the set of all entities set in step “Select target”. If the timeout is exceeded, the operation will be canceled for the entire group of entities.
  • Retries: Number of retries before canceling the operation of a single entity when it has expired the timeout operation.
  • Retries delay in seconds: Waiting time between retries.
  • Ack timeout in seconds: Timeout for a single entity to accept the execution of the operation. If the operation has not been accepted by the entity at the end of the timeout, it will be canceled.

Other options

In this step, you can set other options of the operation.

  • Response types: Response types that will trigger a retry of the operation.

  • Callback: URI format defined in RFC 3986. Only HTTP transport supported. Allows enabling Notifications to be sent to an application. The platform will add to this URI the name of the specific callback.

  • User notes: Space to write anything about the operation.

  • Max spread: represents a percentage of the timeout job, will be a value between 0 and 90, where 0 is the minimum time, i.e., operations run as fast as possible and 90 is the maximum time i.e., operations will spread throughout the time available to run the job, the job time out, the default value is 0. NOTE: This option is only available when a operation is executed using a filter.

Summary

Here you can review the configuration of the execution before the launch.

Advanced

Import/Export Configuration

Allows you to import and export the wizard’s configuration via JSON.

btnJson

When accessing the import and export functionality, it displays a window with various actions. Additionally, it presents the configuration of the wizard in JSON format.

The available actions are as follows:

  • Upload Json: Uploads a JSON file and replaces the previous JSON configuration.
  • Paste from clipboard: Pastes JSON data from the clipboard and replaces the previous JSON configuration.
  • Download Json: Downloads the JSON configuration as a file with the wizard’s name.
  • Copy to clipboard: Copies the JSON configuration to the clipboard.
items

Data collection

Allows collecting data from data points.

Steps

Collection Form

Essential data for registering and identifying data collection in the platform.

In the Unique identifier field, you can select an entity.device. In addition, it opens a menu when you click on the three dots.

Menu

The menu allows you to perform the following actions:

Exact search: Enables an exact search for the identifier. Case sensitive: The search is case-sensitive. New: Opens the device wizard and allows its creation. Execute operation: Opens the wizard for creating a new operation. You need to have selected a unique identifier for this to be available.

Options

You can fill out the wizard with the following fields, which are not mandatory:

  • Feed: Used to label a data point.
  • Data Stream id: Select one or more data streams for data collection. Depending on the selected data stream, different fields will appear for filling out and collecting data.
Creation

Image Execution Scheduler

Allows scheduling the execution of an image.

Steps

Image Execution Form

Essential data for registering and identifying an image execution in the platform.

Not all fields are mandatory.

Identifier: The email address must be valid.

Name: The name of the image.

Tag: The tag of the image.

Max time for execution: The maximum time to wait for the execution to complete.

Max wait for callback: The maximum time to wait for the callback to complete. This value must be greater than the max time for execution.

Environment variables: Environment variables to be used for the execution.

Planification

There is two options for planification:

Cron Expression

Cron expression: The cron expression to be followed.

Timezone: The timezone to be used for the cron expression.

Interval

Interval (minutes): The interval in minutes to be followed.

Both options are mutually exclusive. Also you can define a start and end date for the schedule.

From Date: The date when the schedule should start.

To Date: The date when the schedule should end.

Finally you can mark the Execute now checkbox to execute the request immediately after creation apart from the schedule.

Creation

Import/Export Configuration

Allows you to import and export the wizard’s configuration via JSON.

btnJson

When accessing the import and export functionality, it displays a window with various actions. Additionally, it presents the configuration of the wizard in JSON format.

The available actions are as follows:

  • Upload Json: Uploads a JSON file and replaces the previous JSON configuration.
  • Paste from clipboard: Pastes JSON data from the clipboard and replaces the previous JSON configuration.
  • Download Json: Downloads the JSON configuration as a file with the wizard’s name.
  • Copy to clipboard: Copies the JSON configuration to the clipboard.
items

Pipeline Processor Scheduler

Allows scheduling a Pipeline Processor. With a pipeline processor you can execute multiple pipelines and rest requests in a scheduled way.

Steps

Pipeline Processor Form

Essential data for registering and identifying a pipeline processor in the platform.

Identifier: The identifier of the pipeline processor.

Image Executions: The images to be executed.

Rest Requests: The rest requests to be executed.

Each one will be executed in sequence. You can reorder the sequence by dragging and dropping the items. It requires at least 2 items in pipeline.

Planification

There is two options for planification:

Cron Expression

Cron expression: The cron expression to be followed.

Timezone: The timezone to be used for the cron expression.

Interval

Interval (minutes): The interval in minutes to be followed.

Both options are mutually exclusive. Also you can define a start and end date for the schedule.

From Date: The date when the schedule should start.

To Date: The date when the schedule should end.

Finally you can mark the Execute now checkbox to execute the request immediately after creation apart from the schedule.

Creation

Import/Export Configuration

Allows you to import and export the wizard’s configuration via JSON.

btnJson

When accessing the import and export functionality, it displays a window with various actions. Additionally, it presents the configuration of the wizard in JSON format.

The available actions are as follows:

  • Upload Json: Uploads a JSON file and replaces the previous JSON configuration.
  • Paste from clipboard: Pastes JSON data from the clipboard and replaces the previous JSON configuration.
  • Download Json: Downloads the JSON configuration as a file with the wizard’s name.
  • Copy to clipboard: Copies the JSON configuration to the clipboard.
items

Rest Request Scheduler

Allows scheduling a Rest Request.

Steps

Rest Request Form

Essential data for registering and identifying a rest request in the platform.

Not all fields are mandatory.

Identifier: The email address must be valid.

Url: The url to be called.

Method: The method to be called.

Max wait for request: The maximum time to wait for the request to complete (excludes the time to wait for the callback).

Max wait for callback: The maximum time to wait for the callback to complete (excludes the time to wait for the request).

Headers: Headers to be sent with the request.

Body: Body to be sent with the request.

Planification

There is two options for planification:

Cron Expression

Cron expression: The cron expression to be followed.

Timezone: The timezone to be used for the cron expression.

Interval

Interval (minutes): The interval in minutes to be followed.

Both options are mutually exclusive. Also you can define a start and end date for the schedule.

From Date: The date when the schedule should start.

To Date: The date when the schedule should end.

Finally you can mark the Execute now checkbox to execute the request immediately after creation apart from the schedule.

Creation

Import/Export Configuration

Allows you to import and export the wizard’s configuration via JSON.

btnJson

When accessing the import and export functionality, it displays a window with various actions. Additionally, it presents the configuration of the wizard in JSON format.

The available actions are as follows:

  • Upload Json: Uploads a JSON file and replaces the previous JSON configuration.
  • Paste from clipboard: Pastes JSON data from the clipboard and replaces the previous JSON configuration.
  • Download Json: Downloads the JSON configuration as a file with the wizard’s name.
  • Copy to clipboard: Copies the JSON configuration to the clipboard.
items

Subsections of Resources

Connector Functions

This wizard allows us to create connector functions.

Steps

Administration

Essential data for registration and identification of a connector function in the platform.

Administration

Criteria

Criteria selector

CnfCriteria Criteria

Definition

Allows you to write the connector function code using JavaScript to be evaluated.

In Payload type, there are the following options:

  • TEXT
  • JSON
  • BINARY
ListPayload

The action menu provides different options:

  • Maximize: Full screen for better viewing of the step.
  • Basic functions: Default basic functions.
  • Validate Code: Validates the function code.
ListActionsButtons

Summary

Summary of the complete connector function information.

It allows the options of Disabled, Test, and Production.

BasicFunctions Summary

Import/Export configuration

Allows you to import and export the wizard’s configuration using JSON.

btnJson

When you access import and export, it displays a window with different actions. It also displays the wizard’s configuration in JSON format.

The available actions are as follows:

  • Upload JSON: Uploads a JSON file and replaces the previous JSON.
  • Paste from clipboard: Pastes JSON from the clipboard and replaces the previous JSON.
  • Download JSON: Downloads the JSON in a file with the wizard’s name.
  • Copy to clipboard: Copies the JSON to the clipboard.
items

Create new Asset

This wizard allows us to create entities of type entity.asset. All the data entered will be provisioning data.

Steps

Administration

Essential data for the registration and identification of the asset in the platform.

Administration

Location

Initial location of the device. Location

Customization

Custom data based on the data models created for the user’s organization. Data from the default platform data models are not included. Inventory

Import/Export Configuration

Allows you to import and export the wizard’s configuration via JSON.

btnJson

When accessing the import and export functionality, it displays a window with various actions. Additionally, it presents the configuration of the wizard in JSON format.

The available actions are as follows:

  • Upload Json: Uploads a JSON file and replaces the previous JSON configuration.
  • Paste from clipboard: Pastes JSON data from the clipboard and replaces the previous JSON configuration.
  • Download Json: Downloads the JSON configuration as a file with the wizard’s name.
  • Copy to clipboard: Copies the JSON configuration to the clipboard.
items

Create new Bundle

This wizard allows us to create bundles, which can update software, firmware, or configuration files on your remote devices.

Steps

Pre-actions

You can choose to include pre-actions or not to perform before executing the bundle operation.

Pre-actions

Configuration

Data for bundle configuration.

Configuration

Deployment Elements

If needed, you can add a deployment element to attach to the bundle.

DeploymentElement

If you add the deployment element, a modal window will appear with different types of operations:

  • INSTALL
  • UNINSTALL
  • UPGRADE

This allows you to install, uninstall, or upgrade an implementation on a device.

There are two options:

  • MANDATORY
  • OPTIONAL

A bundle can contain four types of files, as seen in the type selector:

  • SOFTWARE
  • CONFIGURATION
  • PARAMETERS
  • FIRMWARE
DeployElementConfiguration

Additionally, you can add validators if desired:

AddNewValidator AddValidator

After adding deployment elements, you will return to the previous “Deployment Elements” step, where you can see the deployment element you just added. You will also notice that the “Active Bundle” checkbox is now enabled, allowing you to activate or deactivate the bundle.

DeployElement

Post-actions

In the final step, you can choose to include post-actions or not to perform after the bundle operation has executed.

DeployElement

Create new Certificate

This wizard allows you to create certificates for your organization.

Steps

Configuration

Essential data for registration and identification.

Configuration

Previously to create new certificates it is neccesary to know the next tips:

  • An user can upload in the platform a certificate in her organization and in the organizations with low hierarchy managed by the user

  • A certificate can only be signed by a certificate uploaded in the platform with usage CERT_SIGN and this certificate must be in the same organization or in a organization with visible upper hierarchy

  • You can upload the same certificate to the platform a lot of times but always with different identificator

  • If you change the organization of a certificate, the trust chain will be updated keeping in this, only those certificates belonging to visible organizations for the new organization.

Fields

Name : Certificate Name. Description : This field contain the certificate description Administrative State : This field will contain the Name Administrative State, valid values are [ NOT_ACTIVE, ACTIVE, REVOKED, EXPIRED]. Usages : This field will contain the usages, valid values are [FILE_VALIDATION, DEVICE_COMMUNICATIONS, DEVICE_ACCESS, CERT_SIGN]. Tags : This field will contain the tags. Organizations : This field will contain the organizations, Organizations inside list must exist.

Upload

Upload the certification file.

Upload

Only administrative information can be updated. If you need to change the certificate file, you have to delete the existing and add a new one.

Import/Export Configuration

Allows you to import and export the wizard’s configuration via JSON.

btnJson

When accessing the import and export functionality, it displays a window with various actions. Additionally, it presents the configuration of the wizard in JSON format.

The available actions are as follows:

  • Upload Json: Uploads a JSON file and replaces the previous JSON configuration.
  • Paste from clipboard: Pastes JSON data from the clipboard and replaces the previous JSON configuration.
  • Download Json: Downloads the JSON configuration as a file with the wizard’s name.
  • Copy to clipboard: Copies the JSON configuration to the clipboard.
items

Create new Entity

This wizard allows us to create entities of type entity.device. All the data entered will be provisioning data.

More detailed information about entities

Steps

Administration

Essential data for the registration and identification of the device on the platform.

Administration

You could already finish setting up the device.

Fields

Unique identifier of entity Each entity have a unique identifier all over the platform.

Organization The entity will associate with one of the organizations selected from the list of organizations that have access.

Channel The entity will associate with one of the channels selected from the list of channels that have access. This list depends on the selected organization.

Default feed The entity will store data related to this when no other supplied on collection

Plan Defines the usage limits for the entity (More info)

Service group Determines how OpenGate behaves when managing the entity (More info)

Administrative state

  • Requested - Entity requested to the supplier
  • Ready - Entity ready for installation
  • Repair - Entity under repair
  • Testing - Entity in tests
  • Active - Field deployed entity
  • Suspended - Suspended its operation
  • Deleted - Entity removed from available stock
  • Retired - Field entity withdrawal
  • Banned - Entity banned, It means that received information of this entity is not going to be collected

Operational status

  • Unknown - Not known
  • Normal- Normal Operation
  • Alarm - The device has active alarms
  • Down - The device is not operative. Could be running but it is not performing its operation
  • Safe mode - The device is in Safe Mode (Sleeping, etc.)
  • Tamper - The device was tampered
  • Test - The device is working in test mode

Related entity Datastreams collected by this device will be copied to the related entity

Inventory

Data with inventory information. Inventory

Fields

You could already finish setting up the device.

Name of entity Each M2M entity have a unique identifier all over the platform.

Description of entity Using the name attribute and the description attribute, you can set up an alias for your favourite entity and you can write down any detail you want about an entity or its state.

Serial number An identification number of device.

Hardware Choose, from the list of hardware allowed by the platform, the hardware of the device.

Software Choose, from the list of software allowed by the platform, the software of the device.

Location

Initial location of the device. Location

You could already finish setting up the device.

Fields

Latitude, longitude To set latitude and longitude of the device, click show map to open map and drag the point to the desired position.

Address, Postal code, Province, Region and Town extra information for the location.

Security

From here, you can associate a certificate with the device. Security

You could already finish setting up the device.

Fields

Trusted boot Secure boot configuration When you create a device with a trusted boot field, this action has consequence in the collection actions, that is, when collect an event from device with the “trusted boot” field, if the event has secure boot the platform will compare the collected value with the provisioned value and can define an alarm rule for automatically change the administrative status to banned if both values are different.

Certificate Used for secure communication between device and platform. Can select multiple certificates from the list.

Interfaces

Creation of different types of communication interfaces associated with the device. Interfaces

From here, you can configure several types of communication interfaces: Generic Interfaces

Customization

Custom data based on the data models created for the user’s organization. Default platform data model is not included. Inventory

Import/Export Configuration

Allows you to import and export the wizard’s configuration via JSON.

btnJson

When accessing the import and export functionality, it displays a window with various actions. Additionally, it presents the configuration of the wizard in JSON format.

The available actions are as follows:

  • Upload Json: Uploads a JSON file and replaces the previous JSON configuration.
  • Paste from clipboard: Pastes JSON data from the clipboard and replaces the previous JSON configuration.
  • Download Json: Downloads the JSON configuration as a file with the wizard’s name.
  • Copy to clipboard: Copies the JSON configuration to the clipboard.
items

Create new Subscriber

This wizard allows us to create subscribers.

Steps

Type

Select the type of subscriber to manage.

Type

Admin

Data for registration and identification for creating a subscriber on the platform.

Admin

Inventory

Define inventory information.

Inventory

Custom

Allows the selection of a custom data model.

Custom

Import/Export Configuration

Allows you to import and export the wizard’s configuration via JSON.

btnJson

When accessing the import and export functionality, it displays a window with various actions. Additionally, it presents the configuration of the wizard in JSON format.

The available actions are as follows:

  • Upload Json: Uploads a JSON file and replaces the previous JSON configuration.
  • Paste from clipboard: Pastes JSON data from the clipboard and replaces the previous JSON configuration.
  • Download Json: Downloads the JSON configuration as a file with the wizard’s name.
  • Copy to clipboard: Copies the JSON configuration to the clipboard.
items

Create new Subscription

This wizard allows us to create subscriptions.

Steps

Type

Select the type of subscription to manage.

Type

Admin

Data for registration and identification for creating a subscription on the platform.

Admin

Inventory

Define inventory information.

Inventory

Custom

Allows the selection of a custom data model.

Custom

Import/Export Configuration

Allows you to import and export the wizard’s configuration via JSON.

btnJson

When accessing the import and export functionality, it displays a window with various actions. Additionally, it presents the configuration of the wizard in JSON format.

The available actions are as follows:

  • Upload Json: Uploads a JSON file and replaces the previous JSON configuration.
  • Paste from clipboard: Pastes JSON data from the clipboard and replaces the previous JSON configuration.
  • Download Json: Downloads the JSON configuration as a file with the wizard’s name.
  • Copy to clipboard: Copies the JSON configuration to the clipboard.
items

Create new Ticket

Here you can initiate a new ticket on the platform.

Steps

Administration

Essential data for the registration and identification of the ticket on the platform.

Administration

Inventory

Inventory

Location

Information about the ticket’s location.

Location

Custom

Custom data based on data models created for the user’s organization. Default platform data model information is not included.

Custom

Import/Export Configuration

Allows you to import and export the wizard’s configuration via JSON.

btnJson

When accessing the import and export functionality, it displays a window with various actions. Additionally, it presents the configuration of the wizard in JSON format.

The available actions are as follows:

  • Upload Json: Uploads a JSON file and replaces the previous JSON configuration.
  • Paste from clipboard: Pastes JSON data from the clipboard and replaces the previous JSON configuration.
  • Download Json: Downloads the JSON configuration as a file with the wizard’s name.
  • Copy to clipboard: Copies the JSON configuration to the clipboard.
items

Upload Bulk File

You can attach a file to create new entities.

Here, the user can create, update, and delete entities. To do this, the user must choose the type of action to execute and the type of file to upload.

Steps

Bulk Wizard

Available actions:

  • Create
  • Delete: This option allows deleting the device. If the device subscriptions or subscribers exist, this entity will not be deleted.
  • Delete All: This option allows deleting the complete device with subscriptions and subscribers.
  • Update

Resource: We will have the options of Entities or Tickets.

Creation

Type of file:

It allows the selection of a file with the following types:

  • Csv
  • Json
  • Flattened: A data file format that simplifies the structure, presenting information in a flat list, which can be beneficial in some data analysis and processing situations.

CSV

In the CSV section, we will add the different options: Escape Char, Line separator, Null Value, and Quote Char. Once this is done, we will add the CSV file, and the simulation button will be enabled. This button is only available for the CSV file type.

Creation

When you press the simulation button, a window will open where you can see the attached CSV file.

ModalSimulate

JSON

Attach a JSON file.

Json

JSON Flattened

Attach a JSON Flattened file.

JsonFlattened

Import/Export Configuration

Allows you to import and export the wizard’s configuration via JSON.

btnJson

When accessing the import and export functionality, it displays a window with various actions. Additionally, it presents the configuration of the wizard in JSON format.

The available actions are as follows:

  • Upload Json: Uploads a JSON file and replaces the previous JSON configuration.
  • Paste from clipboard: Pastes JSON data from the clipboard and replaces the previous JSON configuration.
  • Download Json: Downloads the JSON configuration as a file with the wizard’s name.
  • Copy to clipboard: Copies the JSON configuration to the clipboard.
items

Upload bulk file (Advanced)

This wizard allows us to create, delete, or update entities in bulk using an Excel file and a provisioning function previously created in the provisioning function wizard.

Steps

Provision functions

  • Provision Function: Name of the provisioning function. A provisioning function will have JavaScript code that takes inbound data and calculates the actions to be performed for correct provisioning of entities (Assets, Devices, Subscriptions, and Subscribers).
  • Sheet Name: Name of the selected sheet when creating the provisioning function.
  • Header row: The row where the header is located in the file.
  • Column result name: The column where it will return the results obtained when executing this wizard.
Provision Functions

Select and upload file

Bulk files allow you to upload and transform their content data through provisioning functions. Only xlsx and xls files are allowed. It is necessary that the file contains the name of the sheet to be able to visualize it. The preview will only be made of the first 5 rows.

Input upload file Select upload file

Preview

Result of the execution of the selected provisioning function with the uploaded file. This preview takes the first 5 rows.

PreviewRow Preview

Clicking on “view details” will open a modal window showing all the details along with their values.

View details row Modal Details

Summary and Execute

Displays a brief summary of:

Selected file: The file selected in the first step.

Provision function: The data of the provisioning function selected in the first step.

Summary of results: Result of the selected rows, executed rows, and rows that will be skipped.

Summary

Since this is a potentially irreversible operation, it is necessary to check the checkbox in order to execute the bulk wizard advanced.

Summary Execute

Templates

Templates are preconfigured dashboards designed to display relevant information about an entity: device, asset, subscriber, subscription, and tickets.

Creating a Template

In the dashboard actions menu, select the “Save as template” option.

Dashboard actions

You’ll be presented with a wizard to configure your template:

Template wizard
  • Dashboard: Choose the dashboard for the template.
  • Workspace: Choose the workspace or workspaces where the template will be saved.
  • Name: Choose the name for the template.
  • Priority: Choose the priority for displaying different templates if you configure more than one for the same conditions.

Conditions

  • Allowed resource type: Choose the type of resource it will open.
  • Specific type: Choose the specific type or specific types of resource.
  • Datastreams: (optional) Choose datastreams witch preferred values.

Template Management

You can manage templates within a workspace from the Workspaces wizard:

Workspace template

Also you can manage it in the Templates configuration section:

Templates configuration section

You can delete and modify the templates configured for a workspace.

Templates configuration filters

Open Templates

From most widgets displaying information about an entity, you can access these templates to view the information of that device on a dashboard referred to as a “temporary” dashboard.

Template Menu

Once you click on the link, you’ll be shown the “temporary/template” dashboard with the information from the entity you opened it from. There, you can choose which template you want to use to view the information for that entity:

Dashboard template

These dashboards can’t be managed, and any changes to filters won’t be saved. They can only be cloned within a workspace. A cloned dashboard will then function like any other dashboard.


Administration

The Administration website contains pre-configured panels with which you can perform provisioning tasks on the platform elements.

Administration Section Home

The home screen will display the most commonly used panels, making it easier to access the various configurations.

The menu can be collapsed to gain screen space by clicking on the bottom navigation menu.

Administration Section Collapsed menu

Panels

Each panel has one or more widgets already available in dashboards, so you can configure and use them in a unified way.

You can access the equivalent documentation from each page that will take you to the corresponding widgets.

Sections

Within the configurations, you can distinguish three main sections:

  • Entities here, you can browse the different types of entities.
  • Organizations contains those items that you can can provision related to your organizations.
  • Workspaces & Dashboards allows you to manage everything related to the use of the web tool.

Configurations

Subsections of Administration

Subsections of Entities

Assets Administration

You can view and manage your organization’s assets from this location.

How it Works

Assets Administration

This panel is comprised of the following widgets:

The navigation bar contains the actions that can be performed:

  • Filter allows you to apply a filter to the list.
  • Refresh refreshes the content of the list.
  • Asset Creation provides quick access to the asset creation wizard.
  • Actions Menu displays all available actions (the same as those in the widget).
Assets Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Devices Administration

From this location, you can view and manage the devices within your organization.

How it Works

Devices Administration

This panel is comprised of the following widget:

The navigation bar contains the actions that can be performed:

  • Filter allows you to apply a filter to the list.
  • Refresh refreshes the content of the list.
  • Create Device provides quick access to the device creation wizard.
  • Actions Menu displays all available actions (the same as those in the widget).
Devices Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Specific Types Administration

From this location, you can view and manage the specific types within your organization.

How it Works

Specific Types Administration

This panel is comprised of the following widget:

The navigation bar contains the actions that can be performed:

  • Refresh refreshes the content of the list.
  • Actions Menu displays all available actions (the same as those in the widget).
  • Edit opens Specific Type manager modal.
Specific Types Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Subscribers Administration

From this location, you can view and manage the subscribers within your organization.

How it Works

Subscribers Administration

This panel is comprised of the following widget:

The navigation bar contains the actions that can be performed:

  • Filter allows you to apply a filter to the list.
  • Refresh refreshes the content of the list.
  • Create Subscriber provides quick access to the subscriber creation wizard.
  • Actions Menu displays all available actions (the same as those in the widget).
Subscribers Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Subscriptions Administration

From this location, you can view and manage the subscriptions within your organization.

How it Works

Subscriptions Administration

This panel is comprised of the following widget:

The navigation bar contains the actions that can be performed:

  • Filter allows you to apply a filter to the list.
  • Refresh refreshes the content of the list.
  • Create Subscription provides quick access to the subscription creation wizard.
  • Actions Menu displays all available actions (the same as those in the widget).
Subscriptions Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Organization

Subsections of Organization

Advanced bulks administration

From this location, you can view and manage the advanced bulks within your organization.

How it Works

Bulks Advanced Administration

This panel is comprised of the following widget:

The navigation bar contains the actions that can be performed:

  • Refresh refreshes the content of the list.
  • Actions Menu displays all available actions (the same as those in the widget).
Bulks Advanced Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Areas Administration

From this location, you can view and manage the map areas within your organization.

How it Works

Areas Administration

This panel is comprised of the following widgets:

The navigation bar contains the actions that can be performed:

  • Filter allows you to apply a filter to the list.
  • Refresh refreshes the content of the list.
  • Actions Menu displays all available actions (the same as those in the widget).
Areas Administration Actions

By toggling Map/List, you can switch between the list view and the map view.

Areas Administration Map

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Bulk Administration

From this location, you can view and manage the bulks within your organization.

How it Works

Bulks Administration

This panel is comprised of the following widget:

The navigation bar contains the actions that can be performed:

  • Refresh refreshes the content of the list.
  • Actions Menu displays all available actions (the same as those in the widget).
Bulks Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Bundles Administration

From this location, you can view and manage the bundles within your organization.

How it Works

Bundles Administration

This panel is comprised of the following widget:

The navigation bar contains the actions that can be performed:

  • Filter allows you to apply a filter to the list.
  • Refresh refreshes the content of the list.
  • Actions Menu displays all available actions (the same as those in the widget).
Bundles Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Certificates Administration

From this location, you can view and manage your organization’s certificates.

How it Works

Certificates Administration

This panel is comprised of the following widget:

The navigation bar contains the actions that can be performed:

  • Filter allows you to apply a filter to the list.
  • Refresh refreshes the content of the list.
  • Actions Menu displays all available actions (the same as those in the widget).
Certificates Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Connector Functions Administration

From this location, you can view and manage the connector functions of your organization.

How it Works

Connector Functions Administration

This panel is comprised of the following widget:

The navigation bar contains the actions that can be performed:

  • Refresh updates the content of the list.
  • Actions Menu displays all available actions (the same as those in the widget).
Connector Functions Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Data models Administration

From this location, you can view and manage the data models of your organization.

How it Works

Data models Administration

This panel is comprised of the following widget:

The navigation bar contains the actions that can be performed:

  • Filter allows you to apply a filter on the list.
  • Refresh updates the content of the list.
  • Actions Menu displays all available actions (the same as those in the widget).
Data models Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Data Sets Administration

From here, you can view and manage the datasets of your organization.

How it Works

Data Sets Administration

This panel is made up of the following widget:

The navigation bar provides a range of actions that can be performed:

  • Filter allows for the application of a filter on the data set list.
  • Refresh updates the content of the list.
  • Actions Menu displays all available actions (identical to those found in the widget).
Data Sets Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Manufacturers Administration

Here you can view and manage the manufacturers and models within your organization.

How it Works

Manufacturers Administration

This panel consists of the following widget:

NOTE: There is the possibility to view manufacturers by organization by selecting the equivalent widget

The navigation bar includes several actions that can be executed:

  • Filter allows you to apply a filter to the list.
  • Refresh updates the content of the list.
  • Actions Menu displays all available actions (the same as those in the widget).
Manufacturers Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Operation Types Administration

From here, you can view and manage the operation types within your organization.

How it Works

Operation Types Administration

This panel consists of the following widget:

Every operation type includes its custom view if exists. An operation type cannot be deleted while custom views are configured for it.

The navigation bar contains various actions that can be performed:

  • Refresh updates the content of the list.
  • Actions Menu displays all available actions (the same as those in the widget).
Operation Types Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Organizations Administration

From here, you can view and manage the elements of our organization.

How it Works

Organizations Administration

This panel is comprised of the following widget:

The navigation bar outlines the actions that can be performed:

  • Refresh updates the content of the list.
  • Actions Menu displays all the available actions.
Organizations Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Provision Functions Administration

From this panel, you can view and manage the provision functions of our organization.

How it Works

Provision Functions Administration

This panel is comprised of the following widget:

Within the navigation bar are the actions that can be performed:

  • Refresh updates the content of the listing.
  • Actions Menu displays all available actions (identical to those available in the widget).
Provision Functions Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Rules Administration

From this panel, you can view and manage the rules of our organization.

How it Works

Rules Administration

This panel is comprised of the following widget:

Within the navigation bar are the actions that can be performed:

  • Refresh updates the content of the listing.
  • Actions Menu displays all available actions (identical to those available in the widget).
Rules Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Time series Administration

From this panel, you can view and manage the time series data of our organization.

How it Works

Timeseries Administration

This panel is composed of the following widget:

The navigation bar contains the following actionable items:

  • Filter allows you to apply a filter to the list.
  • Refresh updates the content of the list.
  • Actions Menu displays all the available actions (the same as those in the widget).
Timeseries Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Time series functions Administration

From this panel, you can view and manage the time series functions of our organization.

How it Works

Timeseries Functions Administration

This panel is composed of the following widget:

The navigation bar contains the following actionable items:

  • Filter allows you to apply a filter to the list.
  • Refresh updates the content of the list.
  • Actions Menu displays all the available actions (the same as those in the widget).
Timeseries Functions Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

User Administration

From here, you can view and manage the users of your organization.

How it Works

User Administration

This panel consists of the following widget:

The navigation bar contains the actions that can be performed:

  • Filter allows you to apply a filter to the list
  • Refresh refreshes the content of the list
  • Action Menu displays all available actions (the same as those in the widget)
User Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Subsections of Workspaces & Dashboards

Custom Operations Views

This wizard allows us to manage custom operation views for the existing operation types.

Section

Below you can see the list of the configured views.

Custom Operations Views

Every operation view has his own actions in order to manage independently:

Views actions

You can edit, launch and remove the custom view.

Operations Views Wizards

In this section you can create, edit and delete custom operation views. By pressing Create Operation View wizard wizard will be opened.

Steps

Administrative Data

Principal and administrative data for the Custom Operation View. Title and icon will be the visible parts in menus.

AdministrativeData

Set Your Default Values

Here you can configure default values for the operation that will be executed within this custom view.

Default values

Set Your Fields

Here you can configure visible steps and fields for the operation execution wizard.

Steps and Fields

Previous Validations

Create validations that will be executed before the execution of the operation.

Previous Validations

Callback must be called in order to validate the introduced data:

callback(boolean result, array messages)

  • result must be true or false in order to determine if continue the execution
  • messages contains strings to be shown to the execution log

Custom Organization Labels

In this section you can customize labels for your organization. This labels can be used for table headers, datastreams, custom sections and as title for widgets, dashboards and workspaces.

Section

Below you can see the list of the configured labels.

Organization Labels

Configuration

You can add a new custom label by clicking in the + New button:

Organization Labels Edit/New

Custom labels have 3 fields and all of them are required:

  • Key is the unique identifier for your label
  • Spanish is the desired translation for this language
  • English is the desired translation for this language

If you type an existing internal label during the creation Spanish and English fields will be fulfilled with the internal translations. This changes only applies to your organization until you remove the custom label.

Labels actions

Organization Labels actions
  • Edit You can update translation for your custom labels and changes will be applied immediately

  • Delete Also you can remove your custom labels but a browser restart is required. A warning is shown in order to remind you to restart.


Widgets Defaults

In this configuration section you can configure widgets behaviour when opened from others.

Section

Below you can see the list of the available configurable widgets. List can be filtered by category and/or widget name

Widgets defaults

You can add, edit and remove the configuration for every available widget in this list.

These configurations will be available for the user organization.

Widget defaults actions

Every listed widget has actions shown below:

New action is shown while no previous configuration saved and allows to configure new defaults for the selected widget

Widgets default new configuration

When widget is configured an actions menu will be available with these options:

Edit that allows change previously configured defaults

Delete quits the current configurations once you confirm the operation

Widgets default actions

Preview and configuration

A preview window will be opened were you can see how is opened the selected widget.

From this you can configure as you consider using own widget configuration panel.

Widgets default preview

Workspaces templates

Templates are preconfigured dashboards designed to display relevant information about an entity: device, asset, subscriber, subscription, and tickets. Here you can find all the preconfigured templates for your account in every workspaces.

Templates configuration section

Creating a Template

By clicking in the Actions Menu -> Create new template template wizard will be opened to configure your template:

Template wizard
  • Dashboard: Choose the dashboard for the template.
  • Workspace: Choose the workspace or workspaces where the template will be saved.
  • Name: Choose the name for the template.
  • Priority: Choose the priority for displaying different templates if you configure more than one for the same conditions.

Conditions

  • Allowed resource type: Choose the type of resource it will open.
  • Specific type: Choose the specific type or specific types of resource.
  • Datastreams: (optional) Choose datastreams witch preferred values.

Template Management

You can filter, delete and modify the templates configured for a workspace.

Templates configuration filters

Collection Wizard

Here you can view/configure new collection wizards for your organization’s website.

How it works

Configure Collection Wizard

The collection wizard listing displays the created wizards along with their Title, Wizard type, and Specific Type.

Actions on the wizard

Actions Menu

You can perform the following actions for each item in the listing:

  • Edit opens the collection wizard’s configuration for modification.
  • Delete removes the selected wizard.

Collection Wizard

Collection wizard Collection wizard

When editing an item from the listing, you will see the collection wizard with its previously entered data.


Organization Files

From here, you can manage the files uploaded to the private storage of the organization.

How it Works

Organization Files

The file listing displays information for each of the stored files.

Files are grouped into 4 categories, which help the user identify the type of files and where they can be used. These categories are as follows:

  • BIM/IFC files in this category contain 3D models compatible with the BIM/IFC standard and are ready to be used in the corresponding widget.
  • SVG vector files that can be used in image widgets or any configuration that allows image import.
  • Image image files that can be used in image widgets or in any configuration that allows image import.
  • Documents any type of documentation files can be placed here, especially to be used in iframe widgets and to be displayed.

The following information is shown in the listing:

  • Unique Identifier the unique identifier of the file.
  • Name the name of the file.
  • Owner the organization where this file is located.
  • Category indicates the category where the file is placed.
  • Size (KB) the size of the file in kilobytes.
  • Updated date and time of the last file update.
  • Shared displays the number of users and organizations the file is shared with.

File Actions

Organization Files Actions

For each item in the listing, the following actions can be performed:

  • Download opens the file for downloading.
  • Copy to Clipboard copies the unique URL of the file for use on the platform.
  • Share allows viewing and sharing the script for other users to use.
Organization Files Share
  • Choose File to Upload allows updating the uploaded file with another. This does not affect the generated link, so the change will be reflected wherever it was being used.

  • Delete removes the selected file.

In the navigation bar, the following actions can be performed:

  • Category Selector allows selecting a category to filter the listing.
  • Search allows applying a filter on the listing.
  • New File opens the file selection dialog. IMPORTANT NOTE: To add a new file, it is necessary to select a category first.

Provision Wizard

Here you can view/configure new provision wizards for your organization’s website.

How it works

Config Provision Wizard

The provision wizard listing displays the created wizards along with their Title, Wizard type, and Specific Type.

Actions on the wizard

Actions Menu

For each item in the listing, you can perform the following actions:

  • Edit opens the provision wizard’s configuration for modification.
  • Delete removes the selected wizard.

Provision Wizard

Wizard provision

When editing an item from the listing, you will see the wizard with its previously entered data.


Scripts Formatters

From here, you can manage the formatting scripts saved by the widgets.

How it Works

Scripts Formatters

The list of scripts displays the necessary information to locate where it is used and for what purpose. The following information is detailed:

  • Name identifier of the script
  • Version a number identifying the versioning
  • Description descriptive text of what the script does
  • Widget type of widget compatible with this script

Expanding the row reveals in which dashboards, and by which users, the said script is being used.

Scripts Formatters Expanded

Actions on Scripts

Scripts Formatters Actions

For each item on the list, the following actions can be performed:

  • Share allows viewing and sharing the script for use by other users on their dashboards
Scripts Formatters Share
  • Edit opens the script’s editing form for modification
Scripts Formatters Edit
  • Delete removes the selected script

In the navigation bar, the following actions can be performed:

  • Search allows applying a filter to the list
  • Refresh refreshes the content of the list

Web Areas & Sections

From here, you can add new areas and sections to your left panel sections menu for the organization.

How it Works

Web Sections

Web Sections list displays information of custom configured areas in domain.

The following information is shown in the list:

  • Icon representative icon for the area in menu.
  • Name the name displayed in menu.
  • Description the description for the area.
  • Priority the display priority for the area when displayed in menu.
  • Categories show total categories availables area.

Web Section Actions

For each item in the list, the following actions can be performed:

  • Edit opens the Areas & Sections wizard in order to manage selected option.
  • Delete removes the selected area and all its contents.

In the navigation bar, the following actions can be performed:

  • Filter allows filtering of areas by name.
  • Create new area opens Areas & Sections wizard in order to create a new one.

Configuring a section

When you opened the section wizard you can see the area information step.

Area Information Step

Web Section Definition

Here you can configure the next information about the area:

  • Identifier unique identifier for the area (autogenerated but modifiable).
  • Title the name displayed in menu.
  • Description the description for the area.
  • Priority the display priority for the area when displayed in menu.
  • Web profile manages who can view this area in menu. If no one is seleted everyone can see it.
  • Icon representative icon for the area in menu.
  • Image background image for the area in the its home page.

Categories and Sections Step

Once you complete the required fields in previous step you can continue to this step.

Categories and Sections

Here you can see current provisioned categories and sections for the area and manage categories order.

Also you can add new categories by pressing New Category or new sections for each category by pressing the conventient New section button.

Categories can be created, edited or deleted. Also you can manage sections from this panel.

Category modal

A category is the sections grouper in left menu once you opened Area menu. Every category has their own sections.

Category modal

You can configure the next in a category:

  • Identifier unique identifier for the category (autogenerated but modifiable).
  • Name the name displayed in menu.

If sections available in category you can manage the display order by dragging then.

Section modal

Section represents the final menu leaf and the opened window.

Section modal

You can configure the next in a section:

  • Identifier unique identifier for the section (autogenerated but modifiable).
  • Name the name displayed in menu.
  • Icon the icon that identify the section.
  • Show in home makes the sections appear at area’s home.
  • Web profile manages who can view this section in menu. If no one is seleted everyone can see it.
  • Widget is the preconfigured widget to be shown in section.

Web Permissions

Here you can view/configure new roles for your organization’s web based on OpenGate’s original profiles.

How it Works

Web Permissions

The list of roles shows the name of the role and the OpenGate profile on which it is based. This means that a user will have the OpenGate profile as a base, but some functionalities will be limited on the web.

Actions on Roles

Web Permissions Actions

For each item on the list, the following actions can be performed:

  • Clone allows creating a new role based on the current one
  • Edit opens the role’s configuration for modification
  • Delete removes the selected role

In the navigation bar, the following actions can be performed:

  • Search allows applying a filter to the list
  • Refresh refreshes the content of the list
  • New opens the form for creating a new role

New Role Form

Web Permissions New Role

The form for the creation/modification of roles contains the following information:

  • Name unique identifying value of the role
  • Original Profile indicates which OpenGate profile is taken as a base for this role

Lastly, there are various layers of role customization. There are 4 groups:

  • Visibility allows hiding/showing common elements of the menu, widgets, workspaces, and dashboards
  • Management groups everything related to wizards and action forms for elements on the platform
  • Sections from here you can manage which web sections you want to enable for the role
  • Views allows selecting which provisioning/collection wizards should be displayed/hidden for the role. This option will only be visible if any of these elements are configured
Web Permissions Visibility

IMPORTANT NOTE: To make use of this new role, it will be necessary to log out and log back into the platform.

Common Elements

At the top of the form, we can find the following elements:

  • Search With this, you can filter the permissions to be selected, facilitating their identification
  • Import/Export Configuration Allows importing and exporting the wizard configuration via JSON.

Import/Export Configuration

Web Permissions Import Export JSON

When accessing the import and export functionality, it displays a window with various actions. Additionally, it presents the configuration of the wizard in JSON format.

The available actions are as follows:

  • Upload Json: Uploads a JSON file and replaces the previous JSON configuration.
  • Paste from clipboard: Pastes JSON data from the clipboard and replaces the previous JSON configuration.
  • Download Json: Downloads the JSON configuration as a file with the wizard’s name.
  • Copy to clipboard: Copies the JSON configuration to the clipboard.

Web Preferences

Here you can configure everything related to the web for your organization.

How it Works

Web Preferences

Within the configuration, we can distinguish three parts:

  • Organization Logo where an identifying image can be uploaded that will always be displayed on the navigation bar of the website.

  • Themes allows the selection of the color and overall appearance of the website.

  • Other Configs here, specific parameters can be configured that will affect the content displayed across the website. Their use is detailed below:

    • Google Key enables the use of Google’s localization tools. For example, in the tracking widget, it enables route calculations for device location points.
    • Weather Key allows activation of weather layers in the map widget. A free key can be created at OpenWeatherMaps.
    • Date Formatting this allows setting the desired format for the dates displayed across the website (to the extent possible). This relies on Moment.js.
    • Storage Limit indicates the maximum storage available for uploading files to the organization. With sufficient permissions, this can be modified.

In the navigation bar, the following actions can be performed:

  • Refresh refreshes the content of the listing.
  • Cancel cancel changes.
  • Save saves the current changes so they are not lost.

Devices Emulator

The Devices Emulator website emulates data on devices that can be used with platform elements. It is necessary to create a device from the Devices Wizard beforehand. Once created, we will select the device in the Entity Key combo.

Entity key

In the actions menu, the following actions can be performed:

  • Exact search
  • Case sensitive
  • New: Opens the device wizard
  • Execute operation: Opens the new operation wizard. To make this available, it is necessary to have previously selected an Entity key.
Select actions Menu actions

Finally, you can view the logs of the different actions performed from the icon.

Clean log

Subsections of Devices Emulator

Map

In the Map tab, a location will be selected.

Tab Map

Once you know the location, you click on the map.

Tab Map Pin

Operation

The Operation tab allows you to simulate the response that the device would send to the OpenGate platform when receiving an operation, by selecting a previously created operation.

Tab Sensors

The help opens a modal window that provides information on the data structure for input and output operation variables

Tab Sensors Help

If you click on the copy template button, it will copy the response template.

Tab Sensors

Inside the function, you can create an input and output operation. Using the delete or save buttons, you can delete or save the emulation of that operation.

Tab Sensors Delete Tab Sensors Save

Sensors

In the Sensors tab, you can choose the device datastreams that you want to send to the OpenGate Platform, simulating the transmission that the device would perform. This message will go through the entire workflow in OpenGate.

Tab Sensors

You can delete the previously data.

Tab Sensors clear

System

The System tab allows you to send values from the product datastreams of the selected device to the OpenGate Platform, simulating the transmission that the device would perform. This message will go through the entire workflow in OpenGate.

You can fill in the various fields to emulate device data. If you have filled in data, you can send it using the SEND DATA button.

Tab System

Analytics

On the analytics web page, you have access to the Artificial Intelligence settings of the platform along with complementary tools.

Analytics Section Home

The home screen will display panels that are most commonly used, facilitating access to various settings.

The menu can be collapsed to save screen space by clicking on the bottom part of the navigation menu.

Analytics Section Collapsed menu

Panels

Each panel contains an embedded widget similar to those used in Workspaces & Dashboards, making the configuration and usage unified.

From each of them, you will have access to the corresponding widget’s documentation.

Sections

Within the settings, three major sections can be distinguished:


Subsections of Analytics

Subsections of Analytics related

Data models Administration

From here you can view and/or manage the data models of our organization.

How it Works

Datamodels Administration

This panel is composed of the following widget:

In the navigation bar, the following actions can be performed:

  • Filter allows you to apply a filter to the list
  • Refresh refreshes the content of the list
  • Actions Menu displays all available actions (the same as those of the widget)
Data models Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Rules Administration

From here, you can view and/or manage the rules of our organization.

How it Works

Rules Administration

This panel is composed of the following widget:

In the navigation bar, the following actions can be performed:

  • Refresh refreshes the content of the list
  • Actions Menu displays all available actions (the same as those of the widget)
Rules Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Operation System Support

The OSS (Operation System Support) website contains pre-configured panels that can be used for operational tasks on the platform’s entities, as well as for identifying issues within them.

OSS Section Home

On the home screen, commonly used panels will be displayed, facilitating access to various configurations. Additionally, there will be two charts summarizing alarms and operations in the last 24 hours.

The menu can be collapsed to maximize screen space by clicking on the bottom part of the navigation menu.

OSS Section Collapsed menu

Panels

Each panel embeds one or more widgets that are also used in Workspaces & Dashboards, thus ensuring a unified configuration and user experience.

Each page provides access to corresponding documentation, which will direct the user to the relevant widgets.

Sections

Within the configurations, three major sections can be distinguished:

  • Operations: This section contains information related to operations executed and planned on the platform.
  • Alerts and Incidents: This section holds information about platform alarms and tickets.
  • Entities: In this section, one can navigate through various types of entities.

Configurations


Subsections of Operation System Support

Subsections of Entities

Assets Administration

From here, you can view and/or manage the assets of our organization.

How it works

Assets Administration

This panel is composed of the following widget:

The navigation bar contains the actions that can be performed:

  • Filter allows applying a filter on the list.
  • Refresh refreshes the content of the list.
  • Create asset provides quick access to the asset creation wizard.
  • Action menu displays all available actions (the same as those on the widget).
Assets Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Devices Administration

From here, you can view and/or manage the devices of our organization.

How it works

Devices Administration

This panel is composed of the following widget:

In the navigation bar are the actions that can be performed:

  • Filter allows you to apply a filter on the list.
  • Refresh refreshes the content of the list.
  • Create device provides quick access to the device creation wizard.
  • Action menu displays all the available actions (the same as those on the widget).
Devices Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Maps

From here, you can view the devices of our organization on the map.

How it works

Maps Administration

This panel is composed of the following widget:

In the navigation bar are the actions that can be performed:

  • Filter allows you to apply a filter to the list.
  • Refresh refreshes the content of the list.
  • Action menu displays all the available actions (the same as those on the widget).
Maps Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Subscribers Administration

From here, you can view and/or manage the subscribers of our organization.

How it works

Subscribers Administration

This panel is composed of the following widget:

In the navigation bar are the actions that can be performed:

  • Filter allows you to apply a filter to the list.
  • Refresh refreshes the content of the list.
  • Create Subscriber provides quick access to the subscriber creation wizard.
  • Action Menu displays all the available actions (the same as those on the widget).
Subscribers Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Subscriptions Administration

From this interface, you can view and/or manage the subscriptions of our organization.

How it works

Subscriptions Administration

This panel consists of the following widget:

In the navigation bar, you will find the actions that can be executed:

  • Filter allows you to apply a filter to the list.
  • Refresh refreshes the content of the list.
  • Create Subscription provides quick access to the subscription creation wizard.
  • Action Menu displays all available actions (the same as those in the widget).
Subscriptions Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Subsections of Notices and incidents

Alarms

Here you can consult the alarms of the platform.

How it works

Alarms Administration

This panel is composed of the following widget:

In the navigation bar, the following actions can be performed:

  • Filter allows you to apply a filter to the list
  • Refresh updates the content of the list
  • Action Menu displays all available actions (the same as those of the widget)
Alarms Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Alarms Summary

Here you can consult the alarms of the platform in graphical form.

How it works

Alarms Summary Administration

This panel is composed of the following widget:

In the navigation bar, the following actions can be performed:

  • Filter allows you to apply a filter to the graphs
  • Refresh updates the content of the graphs
  • Action Menu displays all available actions (the same as those of the widget)
Alarms Summary Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Tickets

Here you can consult the tickets of the platform.

How it works

Tickets Administration

This panel is composed of the following widget:

In the navigation bar, the following actions can be performed:

  • Filter allows you to apply a filter to the list
  • Refresh updates the content of the list
  • Create Ticket quick access to the new ticket creation form
  • Action Menu displays all available actions (the same as those of the widget)
Tickets Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Tickets Summary

Here you can graphically consult the tickets of the platform.

How it works

Tickets Summary Administration

This panel is composed of the following widget:

In the navigation bar, the following actions are available:

  • Filter allows you to apply a filter to the charts
  • Refresh updates the content of the charts
  • Action Menu displays all available actions (the same as those of the widget)
Tickets Summary Administration Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Subsections of Operations

Operations List

From this interface, you can view and execute operations on devices.

How it works

Operations Administration

This panel is composed of the following widgets:

Both panels are linked, so if we select an operation in the upper list, the results in the executions list will be filtered for the selected operations.

Operations Navigation Bar

In the navigation bar are the actions that can be performed:

  • Filter allows you to apply a filter to the list.
  • Refresh refreshes the content of the list.
  • Action Menu displays all available actions (the same as those in the widget).
Operations List Actions

Executions Navigation Bar

In the navigation bar are the actions that can be performed:

  • In Progress/History indicates whether to list ongoing operations or those that have been completed.
  • Resource Type in the case of displaying ongoing executions, you must specify whether you want them for devices, subscribers, or subscriptions.
  • Filter allows you to apply a filter to the list.
  • Refresh refreshes the content of the list.
  • Action Menu displays all available actions (the same as those in the widget).
Executions List Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Operations Summary

From this interface, you can view a summary of the operations on devices.

How it works

Operations Summary Administration

This panel is composed of the following widgets:

Both panels are linked, so if we select an operation in the upper list, the results in the summary will be filtered for the selected operations.

Operations Navigation Bar

In the navigation bar, you can find the actions that can be performed:

  • Filter allows you to apply a filter to the list.
  • Refresh updates the content of the list.
  • Action Menu displays all available actions (the same as those in the widget).
Operations Summary List Actions

Summary Navigation Bar

In the navigation bar, you can find the actions that can be performed:

  • In Progress/History indicates whether to display ongoing operations or those that have been completed.
  • Resource Type in the case of displaying ongoing executions, you must specify whether you want them for devices, subscribers, or subscriptions.
  • Filter allows you to apply a filter.
  • Refresh updates the content.
  • Execute Operation opens the operation launcher.
  • Action Menu displays all available actions (the same as those in the widget).
Operations Summary Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.

Periodic Operations

From this interface, you can view a summary of the configured periodic operations as well as the scheduling of the next executions.

How it Works

Tasks Administration

This panel is composed of the following widgets:

IMPORTANT NOTE: To view the calendar data, at least one periodic operation must be selected from the list.

Periodic Operations Navigation Bar

In the navigation bar, you can find the actions that can be performed:

  • Filter allows you to apply a filter to the list.
  • Refresh updates the content of the list.
  • Action Menu displays all available actions (the same as those in the widget).
Tasks List Actions

Summary Navigation Bar

In the navigation bar, you can find the actions that can be performed:

  • Refresh updates the content.
  • Action Menu displays all available actions (the same as those in the widget).
Tasks Actions

Section Configuration

From the Action Menu, you can access the configuration of the widget corresponding to the section.

  • Configuration opens the widget’s configuration.
  • Default allows resetting the configuration to its initial state.