Connector Remote Sync

Introduction

The Remote Data Synchronization feature enables two distinct deployments of the West Connectivity to exchange data securely and efficiently through the Connectivity Hub service. The communication between two Connectors is a Source and a Target configured in two West Connectivity deployments through a pairing process.

Paring Process

For Source Connector, To enable Remote Data Synchronization, firstly you need to go to “REMOTE-SYNC” tab of the “Settings” page on Connector user interface (UI), and click the ENABLE REMOTE-SYNC to start the pairing countdown.

The pairing process needs to be finished before the countdown. If the process is expired, you need to click the ENABLE REMOTE-SYNC again.

Once the pairing process is enabled, go to Target site to create a Target Connector with remote setting enabled (Create a Connector -> Fill in the Connector infomation -> Enable Remote-Sync Target toggle) on user interface (UI). Enter all information from the Source, including Site Name, Connector ID, to finish the pairing process.

Once the Target connector is created, it should be listed with a Target icon.

Note

Once the pairing is finished, you CANNOT disable the pairing or delete the Source Connector.

Device Information Lookup and Update

Users can perform real-time lookups for device list, tags, and permission information from the device page using the Source or Target Connector user interface (UI). They also have the ability to manage a device and its configurations across both Source and target connectors, ensuring any modifications are simultaneously synchronized between the pair.

Note

For Target connector, the Connectivity APIs are NOT allowed to request.
User should reuqest the Connectivity APIs to Source connector directly.

Enable resource Data Synchronize

To start resource data synchronization, go to the Source Connector resource setting page for setup. Enable the Remote-Sync toggle to start the data synchronization. Then create the same resource with same data format on the Target Connector to start receiving data.

Limitation

The Source Connector allows to be pairing with one Target Connector only.

The data synchronization resuming is up to 30 days, Once the connection breaks for a while then reconnect back, the data may be lost if the data is generated over 30 days ago.

Content Synchronization - Source to Target Connector

The Connectivity Platform facilitates content file synchronization through proper configuration. For details on Content Service settings, please refer to the File Management section.

For Content Synchronization, set the Content storage options of the Source connector to "Mix". Once a content file is uploaded to the Source connector, it will be stored in Primary storage and then synced to Secondary storage. After synchronization, users can view the file on the Target connector user interface (UI) by switching the tab to "SYNCED" on the Content page.

IMPORTANT

Regarding the Content bucket infrastructure configuration for the Target connector, ensure the Primary storage bucket is configured with the same settings as the Secondary storage of the Source connector. Otherwise, files uploaded to the Source connector CANNOT be viewed and accessed from the Target connector.
Please consult your infrastructure team or directly contact us.

Monitoring

Monitoring Metrics

The Connectivity Platform offers monitoring metrics that provide a historical view of the status of the remote sync feature. These metrics should be monitored to ensure good performance and to perform proactive maintenance tasks.

Here is the metrics table:

Metric Name	Description
solution_sync_count	The count of Source connectors paired with a Target Connector.
remote_call_failed	The count of failed network requests from Source connector to Target Connector.
resource_sync_failed	The count of failed data sends from Source connectors to the Target Connector.
cloud_receive_edge_message_latency_seconds	The data latency between Source connector and Target Connector.

Note

Metrics are managed by the infrastructure system, which should provide navigation for the described metrics. The relevant data namespace for the deployment may need to be selected to retrieve the metrics.
Please consult your infrastructure team or directly contact us.

Data Count API

Users can request the Service API to retrieve the total count of a specific signal or resource for a specified period for a specific device.

The total count of a specific signal or resource from the **Source** connector to the **Target** Connector can be used to verify if the synced data is correct.

You can refer to the example Lua code here.