Introduction

Aurora's Amplience integration enables you to import your Amplience asset manifest, and then render Amplience images and videos (using sets) within your templates.

In order for you to start using the Aurora Amplience integration, you will need to coordinate with Amplience to set up your account and request your manifest details, that must then be entered into the Aurora Amplience integration settings section.

Integration Settings

The Aurora Amplience integration settings can be found under Store > Settings > Feeds > Amplience

This section will explain some of the options available when configuring Amplience.

Import Full and Incremental Manifests

Once configured, you can begin by initiating a full manifest import from within the Aurora backend UI using the following import buttons:

When initiated, the import process will be scheduled and the button will be updated to reflect the current process status.

Aurora expects your manifest to use the following format:

<manifest>
  <asset type="Image" key="PRODUCT123_FV" modified="2019-02-01 08:46:31" published="true" publishDate="2019-02-01 08:46:31" width="3000" height="4500" format="JPEG"/>
  <asset type="Image" key="PRODUCT456_FV" modified="2019-02-01 08:46:31" published="true" publishDate="2019-02-01 08:46:31" width="3000" height="4500" format="JPEG"/>
  <asset type="Image" key="PRODUCT123_BV" modified="2019-02-01 08:46:31" published="true" publishDate="2019-02-01 08:46:31" width="3000" height="4500" format="JPEG"/>
</manifest>

🚧

Aurora will only import image assets from your manifest. All other assets, such as videos, can be utilised using the Amplience Viewer Kit.

Import a Product Set Manifest

You can also import image assets on a per product basis by editing a product and navigating to the Amplience section of the Media tab i.e

When refreshing Amplience images, Aurora will add and delete Amplience assets stored within Aurora based on assets that appear within the Amplience product set manifest.

Amplience product set manifests can be seen by constructing a URL based on the following:

[AMPLIENCE_SET_URL_PREFIX][AURORA_PRODUCT_REFERENCE][AMPLIENCE_SET_URL_SUFFIX]

or 

[AMPLIENCE_SET_URL_PREFIX][AURORA_PRODUCT_FIELD_VALUE][AMPLIENCE_SET_URL_SUFFIX]

Which should look something like this:

http://i1.adis.ws/s/brand/PROD123456_set.xml

Example:

<set name="PRODUCT1_SET">
 <list count="2">
  <item type="img">
   <name>PRODUCT1_A</name>
   <src>http://i1.adis.ws/i/brand/PRODUCT1_A</src>
   <width>2000</width>
   <height>2000</height>
   <format>JPEG</format>
   <opaque>true</opaque>
  </item>
  <item type="img">
   <name>PRODUCT1_B</name>
   <src>http://i1.adis.ws/i/brand/PRODUCT1_B</src>
   <width>2462</width>
   <height>2462</height>
   <format>JPEG</format>
   <opaque>true</opaque>
  </item>
 </list>
</set>

👍

You may need to refresh the edit product page in order to see changes made to Aurora product images following an Amplience refresh.

Amplience Image Asset Key Format

The Aurora Amplience integration relies on your image asset keys using the following format:

PRODUCTIDENTIFIER_IMAGEORDER

or as follows when a Group Asset Identifier is defined:

GROUPIDENTIFIER_PRODUCTIDENTIFIER_IMAGEORDER

Where the PRODUCTIDENTIFIER is the product reference or product field value (when configured to user a product field) within Aurora associated with product that the image belongs to, and the IMAGEORDER is the order of the image within the product image set.

The IMAGEORDER can represent any value, as long as the value is unique to the image position within your set of product images.

For example:

The Asset Key IMAGEORDER references will then need to be included within the Image Order Alphabet, to indicate their relative image order/position i.e.

FV, RV, SV, CU

🚧

If your image asset keys do not match this format, they will not be imported.

🚧

If the product identifier within your image asset key does not match to a valid product, the asset will not be imported.

Amplience Video Asset Key Format

The Aurora Amplience integration relies on your video asset keys matching exactly to the product identifier, whether it be the product reference or based on a product field value.

Aurora does not currently support more than one video asset per product and therefore there is no video ordering pattern in place.

Image Order Alphabet

The Image Order Alphabet is a simple comma separated value, used to determine the image order assigned to each asset within your Amplience manifest, based on the second part of the asset key, for example:

Using an Image Order Alphabet of:

A, B, C, E, D

Would result in the following image order assignments:

Automatically Create Aurora Product Images

When the Amplience integration is configured to Automatically create Aurora product images, it will first attempt to find an existing product image with the correct image order as identified from the Amplience asset key and Image Order Alphabet.

If no existing product image can be found, it will automatically create a new image with the correct image order.

In both cases, the Amplience image asset is then associated with the Aurora product image, which is then used to return the correct Amplience asset URL when rendering product images using the following template function:

{product_image_uri image_id="283226" width="640" height="480"}

Please see product_image_uri for more details.

🚧

The Amplience asset URL will only be used when the Amplience integration is enabled.

If the Amplience integration is disabled, Aurora will return a URL to the local Aurora image cache.

❗️

Avoid manually changing the Aurora product image order when using the Amplience integration to create and delete product images.

If you change the order of your Aurora product images, which includes removing an image that would cause the order to change, the Amplience import manifest process will match assets to the the new image order, which could result in your product image settings being lost i.e. variation, integration and label settings.

Automatically Delete Aurora Product Images

When the Amplience integration is configured to automatically delete Aurora product images, Aurora will remove images that could not be matched to Amplience image assets within the full manifest.

📘

The incremental manifest import process will not delete images.

Amplience View Kit

In order to utilise non-image based Amplience assets, such as video assets, please use the Amplience Viewer Kit that can be found here:

https://github.com/amplience/viewer-kit

To retrieve the asset set URL for a given product from with your Aurora templates, you can use the following template function:

{product_amplience_set_uri product_id=270098}

This will render a URL that can be used with the Amplience Viewer Key, based on your Aurora Amplience integration settings and product identifier i.e.

[AMPLIENCE_SET_URL_PREFIX][AURORA_PRODUCT_REFERENCE][AMPLIENCE_SET_URL_SUFFIX]

or

[AMPLIENCE_SET_URL_PREFIX][AURORA_PRODUCT_FIELD_VALUE][AMPLIENCE_SET_URL_SUFFIX]

Why have my images not imported?

Every night Aurora will run an import from the Amplience full manifest. You can see this under Store > Settings > Feeds > Amplience > Full manifest URL. You can open the URL in your own browser and see the full manifest.

If the images are not presented to Aurora in the correct format, it will not import it. The correct format is explained above.

If the images are not present within the feed, Aurora will delete all the existing images. A common issue is the Full manifest not including images, but if you click the "Refresh" button under Products > Edit Product > Media > Amplience it then does import. This is because Amplience provides a different endpoint to extract images for the provided Product Reference. However this is not the same as the endpoint for the Full Manifest, meaning once the Full Manifest runs again it will wipe the images as they are not present.