Create and edit instances
Learn how to create and edit Connector instances in the Edge Portal and understand the available instance parameters.
An instance is a configured connection that uses a Connector. For example, an instance can represent a PLC, an MQTT broker, a database, a cloud service, or a serial device. This guide explains how to create an instance, edit it later, manage several instances, and understand the parameters in the instance form.
OPC UA Server uses a separate server setup page and is not created with the generic instance form described in this guide.
Before you start
Have the connection details required by the target device or service ready. Depending on the Connector, these details can include an IP address, hostname, port, credentials, serial settings, security options, or certificates.
The Connector must be installed before the instance can be saved. If an available Connector is not installed, you can install it from the Connector selector while creating the instance.
Create an instance
- In the sidebar, expand Instances.
- Select All instances. You can also open Industrial, Cloud & APIs, or Databases when you want to work within one category.
- Select Add instance.
- In Connector, verify or select the Connector that the instance will use. Installed Connectors are shown first.
- If the required Connector is listed under Not installed connectors, select Install. Wait for the installation to complete and for the Connector setup fields to load.
- Complete the fields under General Info and Setup.
- Complete the fields in the Connector-specific setup section.
- Select Save instance.
You can also create an instance from Configuration > Connectors. Find an installed Connector and select its Add instance action. The Connector is selected automatically when the form opens.
After a successful save, the Edge Portal displays Instance created successfully. The instance appears in the relevant Instances view. Its connection status depends on whether it is enabled and whether its connection parameters are valid.
Edit an instance
- Open the relevant Instances page.
- Find the instance.
- Open its more-actions menu and select Edit. You can also use the edit action available from the instance details.
- Change the required common or Connector-specific settings.
- Save the changes.
If you try to close the editor after changing a field, the Edge Portal asks whether you want to save or discard the unsaved changes.
Select and manage multiple instances
You can select instances in both tile and table view. The bulk-action bar appears as soon as at least one instance is selected.
- Select the checkbox on each instance you want to manage.
- Use Select all to select every instance currently listed, or use Deselect to clear the selection.
- Select Disable or Delete.
- Review the confirmation dialog.
- Confirm the action.
In table view, the checkbox in the table header selects or clears every listed instance. In tile view, after selection mode is active, selecting another tile toggles that instance in the selection.
Disable selected instances
Disable stops the selected enabled instances until they are enabled again. Instances that are already disabled are skipped. If every selected instance is already disabled, the Edge Portal displays Selected instances are already disabled.
After processing, the portal reports how many instances were disabled and how many failed. A failure for one instance does not prevent the other selected instances from being processed.
Delete selected instances
Bulk deletion cannot be undone. It permanently removes the selected instance configurations.
After processing, the portal reports how many instances were deleted and how many failed. Review failed instances individually before retrying.
General Info parameters
| Parameter | Availability | What it does |
|---|---|---|
| Connector | Required | Selects the protocol or service used by the instance. You can select or install a Connector while creating the instance. The Connector is read-only when editing an existing instance. |
| Name | Required | Sets the visible instance name. The value can be referenced from other fields with %.NAME%. |
| Address | Depends on the Connector | Identifies the target. The expected format is Connector-specific. Examples include a PLC IP address, an MQTT broker hostname, or a slave ID for a serial device. The value can be referenced with %.ADDRESS%. |
| UID | Depends on the Connector | Sets a unique identifier that can be referenced with %.UID%. The field is disabled when the selected Connector does not allow a user-defined UID. |
| Description | Optional | Adds context about the instance. The value can be referenced with %.DESCRIPTION%. |
| Enabled | All instances | Controls whether the instance is active. New instances are enabled by default. |
Setup parameters
| Parameter | Available values | What it does |
|---|---|---|
| Mode | Gateway or Logging | Controls how item data is handled. Gateway mode keeps the latest value and can buffer failed mapping transmissions when buffering is enabled in the mapping. Logging mode stores all data values and makes the logging retention fields available. |
| Read interval | Device default, milliseconds, seconds, minutes, or hours | Sets the default cyclic polling interval for items in the instance. An individual item can use its own read interval. Select device default to use the Connector or device default instead of entering a value. |
| Store Time | Days, hours, minutes, or forever | Appears in Logging mode. Sets how long item data is retained. Select forever when the data must not be removed based on age. |
| Max Samples To Store | Zero or a positive number | Appears in Logging mode. Sets the default maximum number of samples retained for items in the instance. Stored samples work as a first-in, first-out buffer when a limit is used. |
| Status Report Interval | Device default, milliseconds, seconds, minutes, or hours | Sets the minimum heartbeat interval for reporting that the instance is available or unavailable when its state has not changed. A mapping is required to send the status. A status change executes the mapping without waiting for the heartbeat interval. |
Initial values for a new instance
The generic form starts with Gateway mode, Enabled turned on, a read interval of 2 seconds, a Store Time of 14 days, and a Status Report Interval of 1 hour. The selected Connector can provide different defaults for these fields. Always review the values shown after selecting the Connector.
Understand Gateway and Logging mode
Gateway mode
Use Gateway when the instance mainly transfers current data between devices and services. SIA Connect keeps the latest item value. A mapping can also retain a buffer of failed transmissions when that feature is enabled in the mapping.
Logging mode
Use Logging when SIA Connect must retain every collected data value. This mode displays Store Time and Max Samples To Store, which control retention by age and by sample count.
Connector-specific parameters
The last section of the form is named after the selected Connector, for example MQTT setup. Its fields come from that Connector and therefore differ between protocols and services.
The Edge Portal displays Connector fields according to their data type:
- A list of supported values is displayed as a selector.
- A true or false setting is displayed as a switch.
- A numeric setting is displayed as a number field.
- Text and multiline settings use a text editor that can also accept supported SIA Connect variable references.
Select the help control beside a field label when it is available. It displays the helper text supplied by the Connector.
Troubleshoot instance configuration
Name is required
Enter an instance name before saving.
Install the selected Connector before creating an instance
The selected Connector is not installed. Select Install in the Connector selector, wait for the installation to finish, and then save the instance.
Connector metadata is still loading
Wait for the Connector setup section to finish loading and try again. If loading fails, select Retry.
The edit form cannot load the instance settings
Select Retry. If the problem continues, verify that the gateway is reachable and reload the page.
The instance cannot be created or updated
The Edge Portal displays the error returned by the gateway or Failed to create the instance or Failed to update the instance. Review the common and Connector-specific values, verify that the target is reachable, and try again.
A bulk action reports failures
The portal processes the selected instances individually. Review the failed count, refresh the list, then retry or troubleshoot each failed instance separately.