"Import to Catalog" node

This node initiates the import of data to a catalog created in Data Management > Catalogs.

Import modes

When importing data into your catalog, you can choose how to handle existing and new records. You can use the following options:

1. Create or overwrite records
   How it works:

   • If an item does not exist in the catalog, it will be created as a new record.
   • If the item already exists, the entire record will be fully updated, replacing all existing parameters with the new data.

   When to use it:
   You want to discard some or all items in the catalog and replace them with their new versions, without keeping any of their old data.
   Example:

   Before import	Imported data	Results after import
   Item A: { "Name": "Widget", "Price": 10, "Color": "Red" }	Item A: { "Name": "Widget", "Price": 12 }	Item A: { "Name": "Widget", "Price": 12 } (Color removed)
   Item B does not exist	Item B: { "Name": "Gadget", "Price": 25 }	Item B: { "Name": "Gadget", "Price": 25 }

2. Create or partial update
   How it works:

   • If an item does not exist, it will be created as a new record.
   • If the item already exists, only the parameters included in the import will be updated or added; existing parameters not mentioned remain unchanged.

   When to use it:
   You want to update specific parts of existing records without losing any other data, allowing incremental or additive changes.
   Example:

   Before import	Imported data	Results after import
   Item A: { "Name": "Widget", "Price": 10, "Color": "Red" }	Item A: { "Price": 12 }	Item A: { "Name": "Widget", "Price": 12, "Color": "Red" }
   Item B does not exist	Item B: { "Name": "Gadget", "Price": 25 }	Item B: { "Name": "Gadget", "Price": 25 }

Summary

Requirements

• Create a catalog. The catalog can be empty.
• This node must be preceded by one of the following nodes:
  • Local File
  • SFTP
  • HTTPS
  • Amazon S3
  • Azure
  • Google Cloud Storage

Node configuration

1. To configure the node, click it.
   Result:

   

2. From Select catalog dropdown list, select the catalog to which the data from the file will be imported.
3. In Primary key, enter the name of the column which contains the unique identifiers of the items.
   This field accepts snippets or inserts.
4. In the Import modes section, select how data will be updated in the catalog:
   • Create or overwrite records - if an item from the file exists in the catalog, the entire record in the catalog is overwritten with data from the file;
   • Create or partial update - if an item from the file exists in the catalog, the record is modified - new parameters are added, matching parameters are updated. If a parameter doesn’t exist in the file, it’s not modified in the catalog.
     You can learn more about import modes in Import modes section.
5. Confirm by clicking Apply.
   
   Important: Importing data to the catalog is an asynchronous process, which means your data is added to a queue and will become available after processing.

Example of use

You can initiate a single import of a file with the list of stores.

1. Start the workflow with the Scheduled Run node.
2. In the configuration of the node:
   1. Set the Run trigger to one time.
   2. Select the Immediately tab.
   3. Click Apply.
3. Add the Local File node.
4. In the configuration of the node:
   1. Upload the file with the list of stores.
   2. Click Apply.
5. Add the Import to Catalog node.
6. In the configuration of the node:
   1. Select the catalog to which the file will be imported.
   2. As the primary key, enter the name of the column which contains the unique identifiers of the items.
   3. Click Apply.
7. Add the End node.