Integrating with Scene7

Adobe Scene7 is a hosted solution for managing, enhancing, publishing, and delivering rich media assets to Web, mobile, email, and Internet-connected displays and print.

In order to use Scene7, you need to configure the cloud configuration so that Scene7 and AEM Assets can interact with one another. This document describes how to configure AEM and Scene7.

For information on using all the Scene7 components on a page and working with video, see Using Scene7. 

Nota

Scene7's DHTML viewer platform will officially end-of-life on January 31, 2014. For more information see the DHTML viewer end-of-life FAQ.

Nota

Before configuring Scene7 to work with AEM, see Best Practices for integrating Scene7 with AEM.

AEM/Scene7 integration versus Dynamic Media

AEM users have a choice between two solutions to work with dynamic media: Either integrating their instance of AEM with Scene7 or using the Dynamic Media solution that is integrated into AEM.

Use the following criteria to determine which solution to choose:

  • If you are an existing Scene7 customer whose rich media assets reside in S7 for publishing and delivery, but you want to integrate those assets with Sites (WCM) authoring and/or AEM Assets  for management, then use the AEM/Scene7 point-to-point integration described in this document.
  • If you are a new AEM customer who has rich media delivery needs, select the Dynamic Media option. This option makes the most sense if you do not have an existing S7 account and many assets stored in that system.

AEM/Scene7 point-to-point integration

The AEM/Scene7 integration has the following enhancements for AEM 6.0 (from AEM 5.6.1):

  • Updated to new HTML5 viewers
  • Viewers are now responsive
When you work with assets in this solution, you do one of the following:
  • Upload assets directly to Scene7 and then access via the Scene7 content browser for page authoring or
  • Upload to AEM Assets and then enable automatic publishing to S7; you access via Assets content browser for page authoring
The components you use for this integration are found in the Scene7 component area in Design mode.

AEM Dynamic Media

This solution is new for 6.0 and is the unification of S7 features directly within the AEM platform.

When you work with assets in this solution, you follow this workflow:

  1. Upload single image and video assets directly to AEM
  2. Encode videos directly within AEM
  3. Build image-based sets directly within AEM

The components you use for Dynamic Media are found in the Dynamic Media component area in Design mode. They include the following:

  • Image - The Image component is smart – supports image presets, and any image-based viewer (image set, spin set, mixed media set) based on what you drag onto the component
  • Video - The Video component uses the universal HTML5 player.

The viewers are responsive.

Best Practices for Integrating Scene7 with AEM

When integrating Scene7 with AEM, there are some important best practices that need to be observed in the following areas:

  • Polling importer
  • Test-driving your integration
  • Uploading assets directly from Scene7 recommended for certain scenarios

In addition, please see known limitations.

Polling importer

The polling importer should only be turned on if you want to use AEM/Scene7 integration for video. It helps bring encoded video renditions and thumbnails that Scene7 created automatically back into AEM Assets.

In addition, see Known limitations for the polling importer.

Test-driving your integration

Adobe recommends that you test-drive your integration by having your root folder pointing to a subfolder only rather than an entire company. 

Precaución

Importing assets from an existing Scene7 company account may take a long time to show in AEM. Ensure that you designate a folder in Scene7 that does not have too many assets (for example, the root folder will often have too many assets and may crash your system).

Uploading assets from AEM Assets versus from Scene7

You can upload assets either by using the Assets (digital asset management) functionality or by accessing Scene7 directly in AEM via the S7 content browser. Which one you choose depends on the following factors:

  • S7 asset types that AEM Assets does not yet support have to be added to an AEM website from Scene7 directly, via the S7 content browser, for example, image templates.
  • For asset types that are supported by both AEM Assets and Scene7, deciding how to upload them depends on the following:
    • Where the assets are today AND
    • How important managing them in a common repository is 

If the assets are already in Scene7 and managing them in a common repository is not as important, then exporting them to AEM Assets only to sync them back to Scene7 for delivery would be an unnecessary roundtrip. Otherwise, keeping assets in a single repository and syncing to Scene7 only for delivery may be preferable.

Configuring Scene7 integration

You can configure Scene7 and AEM for two-way synchronization of assets. Assets from a CQ target folder can be uploaded (automatically or manually) from AEM to a Scene7 company account. Conversely, assets from the Scene7 company account are polled on a specific interval and imported into the CQ target folder.

Nota

Adobe recommends that you use only the designated target folder for importing Scene7 assets. Digital assets that reside outside of the target folder can only be used in Scene7 components on pages where the Scene7 configuration has been enabled. In addition, they are placed in an ad hoc folder in Scene7. The adhoc folder is not synchronized with AEM (but assets are discoverable in the Scene7 content browser).

To configure Scene7 to integrate with AEM, you need to complete the following steps:

  1. Define a cloud configuration, which defines the mapping between a Scene7 folder and an Assets folder. You need to complete this step even if you only want one-way (AEM Assets to Scene7) synchronization.
  2. If you want to configure AEM Assets to import assets from Scene7, you configure the polling importer. This is an automated process. AEM polls Scene7 according to the interval you specify. The minimum interval is 300 seconds (5 minutes). 
  3. If you want AEM assets to automatically upload to Scene7, you need to turn that option on and add Scene7 to the DAM update asset workflow. You can also manually upload assets.
  4. Adding Scene7 components to the sidekick. This allows the users to use Scene7 components on their AEM pages.
  5. Map the configuration to the page in AEM. This step is required to view any video presets that you have created in Scene7. It is also required if you need to perform a publish an asset from outside the CQ target folder to Scene7.

This section covers how to perform all of these steps and lists important limitations.

How synchronization between Scene7 and AEM Assets works

When setting up AEM Assets and Scene7 synchronization, it is important to understand the following:

Uploading to Scene7 from AEM Assets

  • There is a designated synchronization folder in AEM for Scene7 uploads. 
  • Uploads to Scene7 can be automated if the digital assets are placed in the designated synchronization folder.
  • The folder and subfolder structure in AEM is replicated in Scene7.

Nota

AEM embeds all the metadata as XMP before uploading it to Scene7, so all properties on the metadata node are available in Scene7 as XMP.

Importing to AEM Assets from Scene7 (polling importer)

  • There is a designated synchronization folder in AEM for Scene7 downloads (it is the same folder for uploads).
  • Uploads to AEM Assets are automated with the polling interval setting. Manual uploads from Scene7 to AEM Assets are currently not supported.
  • The folder structure in Scene7 is replicated in AEM.
  • Proxy renditions all the display of some unsupported asset types in AEM.

There is a 1-to-1 relationship between the CQ target (synchronization) folder and the Scene7 company account. The following illustrates the relationship visually:

file

Known limitations and design implications

With the synchronization between AEM Assets and Scene7, there are currently the following limitations/design implications:

Limitation/design implication Description
1 designated synchronization (target) folder You can only have one designated folder per company in AEM for Scene7 uploads. You can create multiple configurations if you need to have access to more than one company account in Scene7.
Folder structure After assets are uploaded to AEM, creating new folders and moving assets in AEM are not reflected in Scene7. In addition, if you delete folders in AEM, this is not reflected in Scene7.
Deleting assets If you delete assets in AEM, they are not reflected in Scene7.
Ad-hoc folder Assets that reside outside the target folder that are manually uploaded to Scene7 in WCM are automatically placed in a separate ad-hoc folder on Scene7. You configure this in the cloud configuration in AEM.
Mixed media Mixed media sets appear in AEM although they are not supported in AEM.
PDFs Generated PDFs from eCatalogs in Scene7 will get imported into the CQ target folder.
Upload time Importing assets from an existing Scene7 company account may take a long time to show in AEM. Ensure that you designate a folder in Scene7 that does not have too many assets (for example, the root folder will often have too many assets).
UI refreshing When synchronizing between AEM and Scene7, be sure to refresh the user interface to view changes. 
Video thumbnails If uploading a video to AEM Assets for encoding via Scene7, the video thumbnails and encoded videos may take some time to be available in AEM Assets, depending on video processing time.
Target subfolders

If you are using subfolders within the target folder, ensure that you either use unique names for each asset (regardless of location) or you configure Scene7 (in the Setup area) to not overwrite assets regardless of location.

Otherwise, assets with the same name that are uploaded to a Scene7 target subfolder are uploaded, but the same-named asset in the target folder is deleted. 

Polling importer Only turn on the polling importer if you want to use the AEM/Scene7 integration for video. It helps bring encoded video renditions and thumbnails that Scene7 created automatically back to AEM Assets.
Too many assets

Importing assets from an existing Scene7 company account may take a long time to show in AEM. Ensure that you designate a folder in Scene7 that does not have too many assets (for example, the root folder will often have too many assets).

If you would like to test drive the integration, you may want to have the root folder point to a subfolder only, instead of the entire company.

Configuring Scene7 servers

If you run AEM behind a proxy or have special firewall settings, you may need to explicitly enable the hosts of the different regions. Servers are managed in content in /etc/cloudservices/scene7/endpoints and can be customized as required. Click a URL and then edit to change the URL, if necessary. In previous versions of AEM/CQ, these values were hard-coded.

If you navigate to /etc/cloudservices/scene7/endpoints.html, you see the servers listed (and can edit them by clicking on the URL):

file

Creating a cloud configuration for Scene7

A cloud configuration defines the mapping between a Scene7 folder and an AEM Assets folder. It needs to be configured to synchronize AEM Assets with Scene7. See How Synchronization Works for more information.

Precaución

Importing assets from an existing Scene7 company account may take a long time to show in AEM. Ensure that you designate a folder in Scene7 that does not have too many assets (for example, the root folder will often have too many assets).

If you would like to test drive the integration, you may want to have the root folder point to a subfolder only, instead of the entire company.

Nota

You can have multiple configurations: one cloud configuration represents one user at a Scene7 company. If you want to access other Scene7 companies or users, you need to create multiple configurations.

To configure AEM to be able to publish assets to Scene7, perform the following steps:

  1. In AEM, click Cloud Services to access Adobe Scene7.

  2. Click Configure Now.

    file
  3. In the Title field, and optionally in the Name field, enter the appropriate information. Click Create.

    Nota

    When creating additional configurations, the parent configuration field displays. 

    Do not change the parent configuration. Changing the parent configuration can break the integration.

  4. Enter the email address, password, and region of your Scene7 account and click Connect to Scene7. You are connected to the Scene7 server and the dialog expands with more options.

  5. Enter the Company name and Root Path (this is the published server name together with any path you want to specify; if you do not know the published server name, in Scene7, go to Setup, then Application Setup.)

    Nota

    The Scene7 root path is the Scene7 folder AEM connects to. It can be narrowed down to a specific folder. 

    Precaución

    Depending on the size of the Scene7 folder, importing a root folder can take a long time. In addition, Scene7 data could exceed the AEM storage. Ensure you are importing the correct folder. Importing too much data can stop your system.

    file
  6. Click OK. AEM saves your configuration.

Nota

If you are reconnecting:

  • When reconnecting to Scene7 on publish, you may need to reset the password on publish or reconnecting will not work. This is not an issue on the author instance.
  • If you modify values such as your region, company name, you must reconnect to Scene7. If configuration options have been modified but not saved, AEM erroneously still indicates that the configuration is valid. Be sure to reconnect.

Configuring Scene7 to AEM Assets synchronization

You can make assets from Scene7 available directly in the Adobe Digital Asset Manager. AEM uses a polling importer that you need to configure to make Scene7 assets available.

Each Scene7 cloud configuration has a set of properties used to configure the associated polling importer. After you configure the polling importer, AEM automatically pulls assets from Scene7 on the specified delay interval.

Nota

The Scene7 polling importer leverages Sling job events to perform the actual import process. For this, each Scene7 configuration creates its own Sling job queue. The name and the topic of the associated queue can be viewed on the Scene7 configuration detail page. The status of each job queue can be managed using the Sling Eventing console.

Known Limitations for the Polling Importer

The following are known limitations for the polling importer (synchronization from Scene7 to AEM Assets):

Assets from Scene7 cannot be imported into AEM Assets if:

  • The Scene7 asset is located in the ad-hoc folder for that configuration.
  • The asset type is Fxg or MbrSet.
  • The asset type is image sets, spin sets, swatch sets, mixed media sets, eCatalogs, and vignettes.
  • The asset is an associated asset for a Template (image layers) or a Video (rendition). 
    • For video, the original video file is imported with the various renditions generated in Scene7 made avalaible as proxy renditions. The various renditions of that video generated in Scene7 are not imported (and not visible in AEM Assets), but are available as proxy renditions for the original video used during playback.
    • For Scene7 Template type assets, only the original template file is imported into AEM Assets. The associated extracted layers are not imported.

Nota

The import process is incremental. An asset will be imported from Scene7 only if:

  • The asset does not exist in AEM Assets.
  • The asset was already imported into AEM Assets on a previous run, but the version in Scene7 is newer.

 

The import process can take a very long time to complete, depending on the size and number of assets that need to be imported from Scene7. See Canceling a Running Import if you need to stop the import.

Configuring Assets to import from Scene7

To configure AEM Assets to import from Scene7:

  1. Click Cloud Services and navigate to the Scene7 configuration and click Edit.

  2. Click the Advanced tab.

  3. Click enabled to enable the polling importer. Enter a Polling interval. The minum is 300 seconds (5 minutes). In CQ DAM Target Folder, navigate to the AEM Assets folder where the Scene7 assets are imported.

    file

    Nota

    The CQ DAM Target folder is where assets are uploaded and downloaded from Scene7. If assets are not put in this folder, they will not be synchronized with AEM Assets.

  4. Click OK. At the interval you specified, assets from Scene7 are downloaded to AEM.

Canceling a Running Import

If, for any reason, a running import process from Scene7 needs to be aborted, do the following:

  1. In Cloud Configuration, select Scene7 and navigate to the configuration you want to stop importing for and click Edit.

  2. Click the Advanced tab. Select Disable for the polling importer and select the Cancel importer check box. This ensures that the current running import for that configuration is completely stopped.

    The assets that were imported up to this point are kept and are not downloaded again from Scene7 on subsequent import runs (unless they are changed in the meantime on the Scene7 server).

    file

    Nota

    The Scene7 Polling importer uses a Sling job queue to perform the import jobs, the name and topic for it are visible on the Scene7 cofiguration page (the queue and current jobs can also be viewed using the Sling Eventing console). Canceling the importer will also suspend the associated Sling job queue to make sure all job processing is terminated.

Configuring Autouploading from AEM Assets

You can configure AEM Assets so that any digital assets that you upload to the digital asset manager are automatically updated to Scene7 if the assets are in a CQ target folder.

If properly configured, when an asset is added into AEM Assets, it will automatically be uploaded and published to Scene7.

To configure autouploading from AEM Assets:

  1. In AEM, navigate to Cloud Services, click Scene7, and select your configuration in Scene7.

  2. Click the Advanced tab and select the Enable Automatic Upload check box and click OK. You now need to configure the DAM Asset workflow to include uploading to Scene7.

    Nota

    See Configuring the state (published/unpublished) of assets pushed to Scene7 for information on pushing assets to Scene7 in an unpublished state.

    file
  3. Navigate back to the AEM welcome page and click Workflows. Double-click the DAM Update Asset workflow to open it.

  4. In the sidekick, navigate to the Workflow components, and select Scene7. Drag Scene7 to the workflow and click Save. Assets added to AEM Assets in the target folder will automatically be uploaded to Scene7.

    file

    Nota

    • When adding assets after automating, if they are not placed in the CQ target folder, they are not uploaded to Scene7.
    • AEM embeds all the metadata as XMP before uploading it to Scene7, so all properties on the metadata node are available in Scene7 as XMP.

Configuring the state (published/unpublished) of assets pushed to Scene7

If you are pushing assets from AEM Assets to Scene7, you can either publish them automatically (default behavior) or push them to Scene7 in an unpublished state.

You may not want to publish assets immediately on Scene7 if you want to test them in a staging environment before going live. You can use AEM with Scene7's Secure Test environment to push assets directly from Assets into Scene7 in an unpublished state.

S7 assets remain available via secure preview. Only when assets are published within AEM do the S7 assets also go live in production.

If you want to publish assets immediately when pushing them to Scene7, you do not need to configure any options. This is the default behavior.

However, if you do not want assets pushed to Scene7 to publish automatically, this section describes how to configure AEM and Scene7 to do this. 

Prerequisites to push assets to Scene7 unpublished

Before you can push assets to Scene7 without publishing them, you must set up the following:

  1. Contact Scene7 Customer Care (s7support@adobe.com) to enable secure preview for your Scene7 account. 
  2. Follow directions to setup secure preview for your Scene7 account.

These are the same steps you would follow to create any secure test setup in Scene7.

Nota

If your installation environment is a Unix 64-bit operating system, see http://helpx.adobe.com/experience-manager/kb/enable-xmp-write-back-64-bit-redhat.html regarding additional configuration options you need to set.

Known Limitations for pushing assets in unpublished state

If you use this feature, please note the following limitations:

  • There is no support for version control.
  • If an asset is already published in AEM and a subsequent version is created, that new version will be immediately published live to production. Publish upon activation only works with the initial publish of an asset.

Nota

If you want to publish assets instantly, best practice is to turn off Enable Secure Preview and use the Enable Automatic Upload feature. 

Setting the state of assets pushed to Scene7 as unpublished

Nota

If a user publishes the asset in AEM, it automatically triggers the S7 asset to the production/live asset (the asset will no longer be in secure preview/unpublished).

To set the state of assets pushed to Scene7 as unpublished:

  1. In AEM, navigate to Cloud Services, click Scene7, and select your configuration in Scene7.

  2. Click the Advanced tab. Select the Enable Secure View check box and enter the Secure Preview Server URL.

    file
  3. Click OK.

Enabling Secure View means that your assets are pushed to the secure preview server unpublished.

You can check this by navigating to a Scene7 component on a page in AEM and clicking Edit. The asset will have the secure preview server listed in the URL. After publishing in AEM, the server domain in the file reference gets updated from the preview URL to the production URL.

Enabling Scene7 for WCM

Enabling Scene7 for WCM is required for two reasons:

  • To enable the drop-down list of universal video profiles for page authoring. Without this, the Universal Video Preset drop-down is empty and cannot be set.
  • If a digital asset is not in the target folder, you can upload the asset to Scene7 if you enable Scene7 for that page in the page properties and drag and drop the asset on a Scene7 component. Normal inheritance rules apply (meaning that child pages will inherit the configuration from the parent page).

When enabling Scene7 for the WCM, note that as with other configurations, inheritance rules apply.

To enable Scene7 for WCM:

  1. In AEM, click Websites and navigate to the root page of your web site (not language specific).

  2. In the sidekick, click the Page icon and click Page Properties.

  3. Click Cloud Services and click Add services and select Scene7.

  4. In the Adobe Scene7 drop-down list, select the desired configuration and click OK.

    file

    Video presets from that configuration of Scene7 are available for use in AEM with the Scene7 video component on that page and child pages.

Configuring a default configuration

If you have multiple Scene7 configurations, you can specify one of them as the default for the Scene7 content browser.

Only one Scene7 configuration can be marked as default at a given moment. The default configuration is the company assets that display by default in the Scene7 Content Browser.

To configure the default configuration:

  1. In AEM, navigate to Cloud Services, click Scene7, and select your configuration in Scene7.

  2. Click Edit to open the configuration.

  3. In the General tab, select the Default Configuration check box to make this the default company and root path that appears in the Scene7 Content Browser.

    file

    Nota

    If there is only one configuration, selecting the Default Configuration check box has no effect.

Configuring the Ad-hoc folder

You can configure the folder that assets are uploaded to in Scene7 when the asset is not located in the CQ target folder. See Publishing assets from outside the CQ target folder.

To configure the adhoc folder:

  1. In AEM, navigate to Cloud Services, click Scene7, and select your configuration in Scene7.

  2. Click Edit to open the configuration.

  3. Click the Advanced tab. In the Ad-hoc Folder field, you can modify the Ad-hoc folder. By default, it is the name_of_the_company/CQ5_adhoc.

    file

    Nota

    Assets from the ad_hoc folder are not imported by the Scene7 polling importer.

Configuring universal presets

To configure Universal Presets for the video component, see Video.

Enabling MIME type-based Assets/Scene7 upload job parameter support

You can enable configurable Scene7 upload jobs parameters that are triggered by the synchronization of Digital Asset Manager/Scene7 assets.

Specifically, you configure the accepted file format by MIME type in the OSGi (Open Service Gateway initiative) area of the AEM Web Console Configuration panel. Then, you can customize the individual upload job parameters that are used for each MIME type in the JCR (Java Content Repository).

  1. In AEM, in the left rail, tap Tools > Operations > Packaging > Package Share.
  2. Use your Adobe ID to sign in to the CRX Package Share page.
  3. On the Adobe CRX Package Share page, search for hotfix package 5575.
  4. Download and install the package.
  5. Log out of the page.
  6. Return to AEM and in the left rail, tap Tools > Web Console.
  7. In the Adobe Experience Manager Web Console Configuration panel, on the OSGi menu, tap Configuration.
  8. Under the Name column, find and tap Adobe CQ Scene7 Asset MIME type Service to edit the configuration.
  9. In the Mime Type Mapping area, tap any plus sign (+) to add a MIME type.
    See Supported MIME types.
  10. In the text field, type the new MIME type name.
    For example, you woiuld type a <file_extension>=<mime_type> as in EPS=application/postscript
  11. In the lower-right corner of the configuration window, tap Save.
  12. Return to AEM and in the left rail, tap CRXDE Lite.
  13. On the CRXDE Lite page, in the left rail, navigate to /etc/cloudservices/scene7/<environment> (substitute <environment> for the actual name).
  14. Expand <environment> (substitute <environment> for the actual name) to reveal the mimeTypes node.
  15. Tap the mimeType that you just added.
    For example, mimeTypes > application_postscript.
  16. On the right side of the CRXDE Lite page, tap the Properties tab.
  17. Specify a Scene7 upload job parameter in the jobParam value field.
    For example, psprocess="rasterize"&psresolution=120 .
    See the Adobe Scene7 Image Production System API for additional upload job parameters you can use.
  18. In the upper-left corner of the CRXDE Lite page, tap Save All.
  19. Upload an EPS asset to the synchronized DAM/Scene7 folder by going to http://localhost:4502/assets.html/content/dam.
    For example, upload an EPS asset to a test folder such as <Test_MyCompanyName/>. The asset gets uploaded to the company named Test_MyCompanyName.
  20. In the Scene7 platform, validate that the uploaded asset has the correct job parameter input values.

Troubleshooting Scene7 and AEM integration

If you are having trouble integrating AEM with Scene7, see the following scenarios for solutions.

If your digital asset publishing to Scene7 fails:

  • Check that the the asset you are trying to upload is in the CQ target folder (you specify this folder in the Scene7 cloud configuration). 
  • If it is not, you need to configure the cloud configuration in Page Properties for that page to allow uploading to the CQ adhoc folder.
  • Check the logs for any information.

If your video presets do not appear:

  • Ensure that you have configured the cloud configuration of that page through Page Properties (in the sidekick). Video presets are avaialble in the Scene7 video component.

If your assets from Scene7 do not appear in the Scene7 browser:

  • Ensure that you have configured the polling importer.
  • Refresh the panel to update the results.

If your video assets do not play in AEM:

If the polling importer is taking too long:

  • Depending on the size of the Scene7 folder, importing a root folder can take a long time. In addition, Scene7 data could exceed the AEM storage. Ensure you are importing the correct folder.
  • If you need to configure multiple folders, consider creating multiple configurations.

If new or modified assets in AEM do not automatically upload to Scene7:

  • Ensure that the assets are in the CQ target folder. Only assets that are in the CQ target folder are automatically updated (provided you configured AEM Assets to automatically upload assets).
  • Ensure that you have configured the Cloud Services configuration to Enable Automatic Uploading and that you have updated and saved the DAM Asset workflow to include Scene7 uploading.
  • When uploading an image into a subfolder of the Scene7 target folder, ensure you do one of the following:
    • Make sure that the names of all assets regardless of location are unique. Otherwise the asset in the main target folder is deleted and only the asset in the subfolder remains.
    • Change how Scene7 overwrites assets in the Setup area of the Scene7 account. Do not set Scene7 to overwrite assets regardless of location if you use assets with the same name in subfolders.

If your deleted assets or folders are not synchronized between Scene7 and AEM:

  • Assets and folders deleted in AEM Assets still show up in the synchronized folder in Scene7. You must delete them manually.

Precaución

Importing assets from an existing Scene7 company account may take a long time to show in AEM. Ensure that you designate a folder in Scene7 that does not have too many assets (for example, the root folder will often have too many assets).

If you would like to test drive the integration, you may want to have the root folder point to a subfolder only, instead of the entire company.

​