Updated on 2023-07-11 GMT+08:00

Importing and Exporting Products

Overview

ROMA Connect supports product import and export. You can export products as a file to the local host or import a local product file to ROMA Connect to migrate product information in batches.

Prerequisites

  • Before importing a product, ensure that the integration application to which the product belongs has been created. Otherwise, create the integration application in advance.
  • Before importing a product, check whether duplicate product names exist in the instance to which the product is to be imported. If duplicate product names exist, the product fails to be imported.
  • Ensure that the quota of products meets the requirements before importing the products.
  • The files to be imported must be in CSV format and have been encoded using UTF-8 BOM.
  • When you use an exported file to import products:
    • Create an import file and add the information about the new products to the file.

      Do not change the name and sequence of table headers in the template. For details about the table header names, see Description of Product Import Files.

    • Open the import file and check whether any field value starting with Base64: exists. If there is no field value starting with Base64:, the file is exported from the instance of an earlier version.

      In this case, rename the file by adding -none-base64-prefix to the end of the file name. For example, if the original file name is import.csv, change it to import-none-base64-prefix.csv.

  • If you use Excel to edit the file to be imported, perform the following operations to save the file:
    1. Save the Excel file as a CSV file by selecting Comma Delimited files (*.csv).
    2. Use a text editor to open the CSV file saved in 1. Save the file in UTF-8 with BOM.

Importing Products

  1. Log in to the ROMA Connect console. On the Instances page, click View Console next to a specific instance.
  2. In the navigation pane on the left, choose LINK > Product Management. On the Products tab page, click Import.
  3. In the dialog box displayed, select a local product file and import it.
  4. After the import is successful, you can view the imported products in the product list.

If product import fails, wait for 5 minutes before re-import.

Exporting Products

  1. Log in to the ROMA Connect console. On the Instances page, click View Console next to a specific instance.
  2. In the navigation pane on the left, choose LINK > Product Management.
  3. Export specified or all products.
    • Exporting specified products: Select the products to be exported and click Export to export the product file to the local PC.
    • Exporting all products: Click Export All to export all the products to the local PC.

Description of Product Import Files

Table 1 describes the requirements of a product import file.
Table 1 Product import file requirements

Column

Description

Remarks

ProductName

Product name.

Mandatory. The complexity requirements are the same as those for product creation on the console.

ProductSerial

Product SN.

Mandatory.

ManufacturerId

Manufacturer ID.

Mandatory. The complexity requirements are the same as those for product creation on the console.

ManufactureName

Manufacturer name.

Mandatory. The complexity requirements are the same as those for product creation on the console.

Model

Product model.

Mandatory. The complexity requirements are the same as those for product creation on the console.

ProductType

Product type.

Mandatory. The options are 0 (common product) and 1 (gateway product).

ProtocolType

Protocol type.

Mandatory. The options are MQTT, MODBUS, and OPCUA.

Username

Username.

Optional.

Password

Password.

Optional.

appName

Application name.

Mandatory. The application name should already exist.

DeviceType

Device type.

Mandatory. The default value is Default.

DataFormat

Data format.

Mandatory. The default value is JSON.

Services

Thing model.

Optional. You are advised to create thing models on the console.