Overview
This feature allows you to automate your product imports and/or exports, and is available only for our Enterprise Edition or Growth Edition users. You will be able to:
- Connect your product imports/exports to remote storages (Amazon S3, Microsoft Azure, Google Cloud Storage or any SFTP server).
- Automate them by scheduling their executions.
Connect your import/export profile to a remote storage
To connect your product import/export to a remote storage:
- Go to Imports or Exports
- Select the profile you would like to automate
- Click Edit in the top right corner
- Click Properties
- Under "Connection", select any choice from the dropdown list. For instance: SFTP
- Fill in all mandatory fields: Filepath, Host, Port, Login and Password
- Click Save in the top right corner of the screen
- If you want to automate your product exports, we support the patterns %job_label% & %datetime%. You can combine them to create a filepath like: "/myfolder1/mysubfolder2/export_%job_label%_%datetime%.xlsx".
- Both relative (ex. “mysubfolder/myexport.xlsx”) and absolute filepaths (ex. "/myfolder/mysubfolder/export.xlsx") are supported
- You can use the Test connection settings button to check your settings and ensure your connection is valid.
- If you want to authenticate your SFTP server, paste its fingerprint in the optional field Host fingerprint. The accepted format of the fingerprint depends on the server's public key format: MD5 for ssh-rsa signatures, SHA-512 for others.
- You can only import media files with a .ZIP archive. Your spreadsheet should contain a filepath column.
- If you export media files to a remote server, it will create a folder with the spreadsheet and the related media files. This folder won't be compressed (no .ZIP archive).
Please note that if you're importing from a remote server, your configured host will be displayed.
Connect to an SFTP remote server
To connect your product import/export to an SFTP remote storage:
- Go to Imports or Exports
- Select the profile you would like to automate
- Click Edit in the top right corner
- Click Properties
- Under "Type", select SFTP
- Fill in all mandatory fields: Filepath, Host & Port
- Select the authentication method Login & Password or Private key
* If you're using Login & Password, enter a login and a password, then proceed to step
* If you're using Private key, the PIM will provide you a public key that you need to install on your SFTP server. In that case, ask your PIM administrator. Then proceed to step 8.
- Click Save in the top right corner of the screen
If you want to authenticate your SFTP server, you can paste its fingerprint in the optional field Host fingerprint.
The accepted format of the fingerprint depends on the format of the server's public key: MD5 for ssh-rsa signatures, SHA-512 for others.
Connect to Amazon S3
To connect your product import/export to Amazon S3:
- Go to Imports or Exports
- Select the profile you would like to automate
- Click Edit in the top right corner
- Click Properties
- Under "Type", select Amazon S3
- Fill in all mandatory fields: Filepath, Region, Bucket name, Key, and Secret
- Click Save in the top right corner of the screen
The following permissions need to be enabled for your Amazon S3 bucket:
- s3:PutObject
- s3:GetObject
- s3:GetObjectAcl
- s3:DeleteObject
Connect to Microsoft Azure
To connect your product import/export to Microsoft Azure:
- Go to Imports or Exports
- Select the profile you would like to automate
- Click Edit in the top right corner
- Click Properties
- Under "Type", select Microsoft Azure
- Fill in all mandatory fields: Filepath, Connection string, and Container name
- Click Save in the top right corner of the screen
The following permissions need to be enabled for your Azure SAS (Shared Access Signature):
- Allowed services
- Blob
- Allowed resource types
- Service
- Container
- Object
- Allowed permissions
- Read
- Write
- Delete
- List
- Add
- Create
Connect to Google Cloud Storage
To connect your product import/export to Google Cloud Storage:
- Go to Imports or Exports
- Select the profile you would like to automate
- Click Edit in the top right corner
- Click Properties
- Under "Type", select Google Cloud Storage
- Fill in all mandatory fields: Filepath, Project ID, Service account, and Bucket
The Service account is JSON information needed for the service account field that can only be retrieved at the key creation in the Google Cloud Console interface. Please paste the whole JSON key.
Note that once created, it cannot be downloaded afterward. If lost, a new key must be created directly in the Google Cloud Console. - Click Save in the top right corner of the screen
- To be able to export to GCS, make sure that both roles Storage Legacy Bucket Writer and Storage Obect Creator are enabled.
- If you want to test the connection settings for GCS, make sure that the role storageBucketRead is enabled.
Schedule and automate your import/export profile
To automatically execute an import/export profile:
- Go to Imports or Exports
- Select the profile you would like to automate
- Click Edit in the top right corner
- Click Properties
- Under "Automation", switch "Enable scheduling" button to Yes
- Under "Scheduling", select your preferred frequency of execution
- Then, select the user group to apply the related permissions to this automated job can apply (EE only)
- Finally, select the user groups and/or users to be notified when a job is completed with success, has failed, or can't even be launched. One e-mail and one in-app notification will be sent for each job status.
- Click Save in the top right corner of the screen
- To ensure the best performances, the minimum frequency execution is set to every 4 hours.
- Frequencies executed multiple times a day start at midnight (UTC).
- Frequencies are displayed in UTC.
- A system user will execute automated jobs, so if you want to see the job in the Process Tracker, please check the permission View all jobs in process tracker under the user roles' permissions.
- To automate a job, you need to configure a remote storage.
Manually execute an import/export profile connected to a remote storage
Once you have connected your import/export profile to a remote server, go back to the root of your profile by clicking on its name in the breadcrumb, and click on Import now to import from a remote server or Export now to export to a remote server.