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.

NOTE: There is the possibility to configure the manufacturer by organization by selecting the equivalent wizard

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.

This wizard allows us to create areas.

Steps

Administration Info

Information for the registration and identification for the creation of a new area.

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

Import/Export Configuration

Allows you to import and export the wizard’s configuration via 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.

---

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.

Import/Export Configuration

Allows you to import and export the wizard’s configuration via 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.

---

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.

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.

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.

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.

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.

Qrating

If a version number is entered, a series of fields for filling out the Qrating will appear.

Storage

By default, the storage period will appear in DAYS, but it can be changed to SECONDS, MINUTES, or NEVER.

Import/Export Configuration

Allows you to import and export the wizard’s configuration via 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.

---

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.

Import/Export Configuration

Allows you to import and export the wizard’s configuration via 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.

---

This wizard allows us to create schedulers for the previously created Opengate data lab notebooks

Steps

Configuration

Essential data for the scheduler

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

---

Allows for the creation of organizations.

Steps

Administrative Data

Data for registration and identification for data collection on the platform.

Location

Information about the organization’s 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.

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.

Import/Export Configuration

Allows you to import and export the wizard’s configuration via 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.

---

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.

Import/Export Configuration

Allows you to import and export the wizard’s configuration via 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.

---

This wizard allows us to create pipeline processors.

Steps

Administrative Data

Essential data for registration and identification of a pipeline in the platform.

Transformer and AI Model Configuration

Select transformers or models to execute.

---

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.

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.

Add Function

Provides the option to add different functions.

Let’s add the “New entity” function.

Validate Code

Checks the JavaScript code; if it’s correct, it enables the Next button.

Summary

Summary of the data entered previously.

---

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.

Import/Export Configuration

Allows you to import and export the wizard’s configuration via 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.

---

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.

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.

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.

Here you can see a dataset in collapse format, with options for editing and deleting the dataset.

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

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.

• 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.

Clone Data Set Definition Columns

Having cloned the data set from a previously existing one, the previously configured columns will appear by default.

Import/Export Configuration

Allows you to import and export the wizard’s configuration via 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.

---

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.

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)

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.

Clone Operation

In this case, we will clone an operation to change the state of administration.

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.

In the Preview section, the result of the JSON Schema configuration will be displayed.

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.

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.

---

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.

Administrative Data

Essential data for the registration and identification of a provision wizard in the platform.

Set Your Fields

Add the customized steps that the wizard will have.

In this case, select the steps admin and security.

For example, for the Admin step, select administrative state and operational status.

And for the Security step, select certificates.

Set Your Default Values

See how the wizard would look graphically with the new steps added, and select default values if needed.

Previous Validations

Create validations that will be executed before the main action.

Post Actions

Create validations that will be executed after the main action.

Import/Export Configuration

Allows you to import and export the wizard’s configuration via 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.

---

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.

Clicking the Data Stream button will open a menu where you can search for and add the data stream, along with adding an alias.

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.

Within the parameter menu, you will enter an identifier, type (string, integer, number, or boolean), and value.

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.

You can also add a group to add another condition to the filter.

Perform the following actions

Actions will be executed when the configured conditions are met.

There are different options within the New Action menu:

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.

Advanced rule

Build a rule using basic concepts for evaluation.

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.

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.

---

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.

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.

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.

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.

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.

• 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.

• 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.

Clone

In addition to creating a new dataset, you can clone a dataset from an existing one that has default data.

Import/Export Configuration

Allows you to import and export the wizard’s configuration using JSON.

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.

---

Allows for the creation of time series functions.

Steps

Administration

Data for the registration and identification of the time series function on the platform.

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.

Here you can modify the code and test it simulating the input data using the receivedValues, extra and currentValue simulated params.

Summary

Finally you can review changes (except the code) in order to proceed.

Once you finish you may be able to select the function in a time series column.

---

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)

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.

---

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)

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.

---

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.

Import/Export Configuration

Allows you to import and export the wizard’s configuration via 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.

---

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.

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.

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.

Scheduled

Set when the operation will be executed.

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.

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.

Import/Export Configuration

Allows you to import and export the wizard’s configuration via 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.

---

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.

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.

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.

---

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.

Import/Export Configuration

Allows you to import and export the wizard’s configuration via 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.

---

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.

Import/Export Configuration

Allows you to import and export the wizard’s configuration via 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.

---

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.

Import/Export Configuration

Allows you to import and export the wizard’s configuration via 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.

---

This wizard allows us to create connector functions.

Steps

Administration

Essential data for registration and identification of a connector function in the platform.

Criteria

Criteria selector

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

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.

Summary

Summary of the complete connector function information.

It allows the options of Disabled, Test, and Production.

Import/Export configuration

Allows you to import and export the wizard’s configuration using JSON.

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.

---

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.

Location

Initial location of the device.

Customization

Custom data based on the data models created for the user’s organization. Data from the default platform data models are not included.

Import/Export Configuration

Allows you to import and export the wizard’s configuration via 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.

---

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.

Configuration

Data for bundle configuration.

Deployment Elements

If needed, you can add a deployment element to attach to the bundle.

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

Additionally, you can add validators if desired:

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.

Post-actions

In the final step, you can choose to include post-actions or not to perform after the bundle operation has executed.

This wizard allows you to create certificates for your organization.

Steps

Configuration

Essential data for registration and identification.

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.

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.

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.

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.

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.

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.

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.

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.

From here, you can configure several types of communication interfaces:

Customization

Custom data based on the data models created for the user’s organization. Default platform data model is not included.

Import/Export Configuration

Allows you to import and export the wizard’s configuration via 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.

---

This wizard allows us to create subscribers.

Steps

Type

Select the type of subscriber to manage.

Admin

Data for registration and identification for creating a subscriber on the platform.

Inventory

Define inventory information.

Custom

Allows the selection of a custom data model.

Import/Export Configuration

Allows you to import and export the wizard’s configuration via 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.

---

This wizard allows us to create subscriptions.

Steps

Type

Select the type of subscription to manage.

Admin

Data for registration and identification for creating a subscription on the platform.

Inventory

Define inventory information.

Custom

Allows the selection of a custom data model.

Import/Export Configuration

Allows you to import and export the wizard’s configuration via 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.

---

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.

Inventory

Location

Information about the ticket’s location.

Custom

Custom data based on data models created for the user’s organization. Default platform data model information is not included.

Import/Export Configuration

Allows you to import and export the wizard’s configuration via 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.

---

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.

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.

When you press the simulation button, a window will open where you can see the attached CSV file.

JSON

Attach a JSON file.

JSON Flattened

Attach a JSON Flattened file.

Import/Export Configuration

Allows you to import and export the wizard’s configuration via 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.

---

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.

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.

Preview

Result of the execution of the selected provisioning function with the uploaded file. This preview takes the first 5 rows.

Clicking on “view details” will open a modal window showing all the details along with their values.

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.

Since this is a potentially irreversible operation, it is necessary to check the checkbox in order to execute the bulk wizard advanced.

---