Skip to main content

Add the Image Exporter export

Add the Productsup Image Exporter export.

Introduction

The Image Exporter lets you send the images from your feeds to Amazon S3, Microsoft Azure Blob Storage, or an FTP/SFTP server. You can export them as individual image files or as a .zip file.

The Image Exporter sends only image updates to your destination rather than the entire data feed.

  • The Image Exporter only exports images with new and modified data. If you delete an image from your feed, the export doesn't remove it from the destination. However, if you add a new image to your feed with the same filename as the deleted image used to have, the Image Exporter overwrites the old deleted image in your destination with the new one.

  • The Image Exporter uses the same logic whether or not you export your images as a .zip file.

Requirements

  • To upload your images to Amazon S3, you must log in or create an Amazon Web Service (AWS) account. See AWS.

  • To upload your images to Azure Blob Storage, you must log in or create a Microsoft Azure account. See Azure.

  • To upload your images to an FTP/SFTP, you must provide FTP/SFTP credentials that allow write access.

Add the Image Exporter export to your site

  1. Go to Exports from your site's main menu and select ADD EXPORT.

  2. Choose Image Exporter and select Add. Select Add again to confirm your selection.

add_image_exporter.png

Set up the dataflow

You can export several images per product. Each image needs a URL and a filename for saving on the S3 bucket. The required columns are:

  • id - Your unique product identifier. This ID is critical for sending delta files.

  • img_url_{ascending_number} - The image source URL.

  • img_name_{ascending_number} - The image file name, including the file extension. You must add an image extension to each image file. For example, add .jpg to the image file short_front to produce short_front.jpg.

    You can use the Append/Prepend Value rule box. See Append/Prepend Value.

If you want to export only one image per product, go to Dataflow and map the id, image_name_1, and image_url_1 columns as appropriate.

If your items have more than one image you want to upload, map the id column and as many image_name and image_url columns as necessary.

Important

To prevent you from overwriting your images, make sure not to use duplicate image names within your feed.

dataflow.jpg

Configuring destinations

All destinations share the following four (4) standard settings:

  1. Concurrency

    In Concurrency, enter how many images the export should simultaneously download and send to your server. The expected input format is a digit.

    If you have a lot of products in your site, the number in this field shouldn't be high.

    Important

    For best results, set your concurrency between 10-20 if you have more than 1,000 items.

  2. Download Progress Notification Interval

    In Download Progress Notification Interval, enter how many images the platform should send to the server before notifying you of the export's progress. The expected input format is a digit.

  3. Zipfile (optional)

    The destination sends your images to the server as separate image files. To let the destination send your images to the server in a .zip file, give that file a desired name in Zipfile (optional).

    The platform uses the input you provide in this field and adds _0001 as a postfix to create the full name of the .zip file. For example, the full name of your exported file can be name-example_0001.zip.

    Caution

    The field Zipfile (optional) takes care of the export file's extension. You shouldn't change the extension of the export file or the delta files from .csv to .zip in the Files and Delta Files sections on the export setup page. This causes the export to fail.

    Don't change the extensions of the export file and the delta files from CSV to ZIP as it breaks the export

  4. Zip Size Limit

    If you provide a desired name for your .zip file in Zipfile (optional), you can also use the Zip Size Limit field to specify your maximum file size in bytes. The expected input format is a digit.

    If the size of the .zip file with all your exported images exceeds this limit, the destination sends the images to the server in multiple .zip files. Each .zip file then has its number specified in a postfix that the platform adds to its name. For example, if the platform splits up all your images into three (3) files, their names can be name-example_0001.zip, name-example_0002.zip, and name-example_0003.zip.

    Note

    If you enter 0 in this field, the destination sends all images to one .zip file on your server without restricting its size or amending its name with a postfix.

Configure the Image Exporter (AWS S3) / subprocesses destination

  1. Return to Exports and select the Setup icon from the Image Exporter export. Select Add Destination, choose Image Exporter (AWS S3) / subprocess, and identify your destination in Name.

    destination_amazon.png

  2. Enter your AWS credentials in Access Key ID and Secret Access Key, then choose your S3 location in Region.

  3. Lastly, enter the bucket name for your image uploads in Bucket, and define the image path in Base Path.

    image_exporter_aws.png

Configure the Image Exporter (Microsoft Azure) destination

  1. Return to Exports and select the Setup icon from the Image Exporter export. Select Add Destination, choose Image Exporter (Microsoft Azure), and identify your destination in Name.

    destination_azure.png

  2. Enter your Microsoft Azure credentials in Account Name and Access Key.

  3. Lastly, enter the container name for your image uploads in Blob Container, and define the image path in Base Path.

    image_exporter_azure.png

Configure the Image Exporter (FTP or SFTP) destination

  1. Return to Exports and select the Setup icon from the Image Exporter export. Select Add Destination, choose Image Exporter (FTP or SFTP), and identify your destination in Name.

    destination_ftp.png

  2. Enter your FTP server address in FTP Hostname. Then, enter the credentials in FTP Username and FTP Password.

  3. Define the image path in Base Path.

    image_exporter_ftp.png
In this section: