Configure asset tagging using the Smart Content Service

Last update: May 3, 2023

CREATED FOR:

  • Admin
CAUTION
AEM 6.4 has reached the end of extended support and this documentation is no longer updated. For further details, see our technical support periods. Find the supported versions here.

You can integrate Adobe Experience Manager with the Smart Content Service using Adobe Developer Console. Use this configuration to access the Smart Content Service from within Experience Manager.

NOTE
  • Smart Content Services is no longer available to new Experience Manager Assets On-Premise customers. Existing On-Premise customers, who already have this capability enabled, can continue using Smart Content Services.
  • Smart Content Services is available for existing Experience Manager Assets Managed Services customers, who already have this capability enabled.
  • New Experience Manager Assets Managed Services customers can follow the instructions mentioned in this article to set up Smart Content Services.

The article details out the following key tasks that are required to configure the Smart Content Service. At the back end, the Experience Manager server authenticates your service credentials with the Adobe Developer Console gateway before forwarding your request to the Smart Content Service.

  1. Create a Smart Content Service configuration in Experience Manager to generate a public key. Obtain public certificate for OAuth integration.

  2. Create an integration in Adobe Developer Console and upload the generated public key.

  3. Configure your deployment using the API key and other credentials from Adobe Developer Console.

  4. Test the configuration.

  5. Optionally, enable auto-tagging on asset upload.

Prerequisites

Before you use the Smart Content Service, ensure the following to create an integration on Adobe Developer Console:

  • An Adobe ID account that has administrator privileges for the organization.

  • The Smart Content Service is enabled for your organization.

To enable Enhanced Smart Tags, in addition to the above, also install the latest Experience Manager service pack.

Create Smart Content Service configuration to obtain public certificate

A public certificate allows you to authenticate your profile on Adobe Developer Console.

  1. In the Experience Manager user interface, access Tools > Cloud Services > Legacy Cloud Services.

  2. In the Cloud Services page, click Configure Now under Assets Smart Tags.

  3. In the Create Configuration dialog, specify a title and name for the Smart Tags configuration. Click Create.

  4. In the AEM Smart Content Service dialog, use the following values:

    Service URL: https://smartcontent.adobe.io/<region where your Experience Manager author instance is hosted>

    For example, https://smartcontent.adobe.io/apac. You can specify na, emea, or, apac as the regions where your Experience Manager author instance is hosted.

    NOTE
    If the Experience Manager Managed Service is provisioned before September 01, 2022, use the following Service URL:
    https://mc.adobe.io/marketingcloud/smartcontent

    Authorization Server: https://ims-na1.adobelogin.com

    Leave the other fields blank for now (to be provided later). Click OK.

    Experience Manager Smart Content Service dialog to provide content service URL

    Figure: Smart Content Service dialog to provide content service URL

    NOTE
    The URL provided as Service URL is not accessible via browser and generates a 404 error. The configuration works OK with the same value of the Service URL parameter. For the overall service status and maintenance schedule, see https://status.adobe.com.

  5. Click Download Public Certificate for OAuth Integration, and download the public certificate file AEM-SmartTags.crt.

    A representation of the settings created for the smart tagging service

    Figure: Settings for smart tagging service

Reconfigure when a certificate expires

After a certificate expires, it is no longer trusted. You cannot renew an expired certificate. To add a new certificate, follow these steps.

  1. Log in your Experience Manager deployment as an administrator. Click Tools > Security > Users.

  2. Locate and click dam-update-service user. Click Keystore tab.

  3. Delete the existing similaritysearch keystore with the expired certificate. Click Save & Close.

    Delete the existing similaritysearch entry in Keystore to add a new security certificate

    Figure: Delete the existing similaritysearch entry in Keystore to add a new security certificate.

  4. Navigate to Tools > Cloud Services > Legacy Cloud Services. Click Asset Smart Tags > Show Configuration > Available Configurations. Click the required configuration.

  5. To download a public certificate, click Download Public Certificate for OAuth Integration.

  6. Access https://console.adobe.io and navigate to the existing Smart Content Services on the Integrations page. Upload the new certificate. For more information, see the instructions in Create Adobe Developer Console integration.

Create Adobe Developer Console integration

To use Smart Content Service APIs, create an integration in Adobe Developer Console to obtain API Key (generated in CLIENT ID field of Adobe Developer Console integration), TECHNICAL ACCOUNT ID, ORGANIZATION ID, and CLIENT SECRET for Assets Smart Tagging Service Settings of cloud configuration in Experience Manager.

  1. Access https://console.adobe.io in a browser. Select the appropriate account and verify that the associated organization role is system administrator.

  2. Create a project with any desired name. Click Add API.

  3. On the Add an API page, select Experience Cloud and then select Smart Content. Click Next.

  4. Select Upload your public key. Provide the certificate file downloaded from Experience Manager. A message Public key(s) uploaded successfully is displayed. Click Next.

    Create a new Service Account (JWT) credential page displays the public key for the service account just configured.

  5. Click Next.

  6. On the Select product profiles page, select Smart Content Services. Click Save configured API.

    A page displays more information about the configuration. Keep this page open to copy and add these values in Assets Smart Tagging Service Settings of cloud configuration in Experience Manager to configure smart tags.

    In the Overview tab, you can review the information provided for integration.

    Figure: Details of integration in Adobe Developer Console

Configure Smart Content Service

To configure the integration, use the values of TECHNICAL ACCOUNT ID, ORGANIZATION ID, CLIENT SECRET, and CLIENT ID fields from the Adobe Developer Console integration. Creating a Smart Tags cloud configuration allows authentication of API requests from the Experience Manager deployment.

  1. In Experience Manager, navigate to Tools > Cloud Service > Legacy Cloud Services to open the Cloud Services console.

  2. Under the Assets Smart Tags, open the configuration created above. On the service settings page, click Edit.

  3. In the AEM Smart Content Service dialog, use the pre-populated values for the Service URL and Authorization Server fields.

  4. For the fields Api Key, Technical Account ID, Organization ID, and Client Secret, copy and use the following values generated in Adobe Developer Console integration.

    Assets Smart Tagging Service SettingsAdobe Developer Console integration fields
    Api KeyCLIENT ID
    Technical Account IDTECHNICAL ACCOUNT ID
    Organization IDORGANIZATION ID
    Client SecretCLIENT SECRET

Validate the configuration

After you have completed the configuration, use a JMX MBean to validate the configuration. To validate, follow these steps.

  1. Access your Experience Manager server at https://[aem_server]:[port].

  2. Go to Tools > Operations > Web Console to open the OSGi console. Click Main > JMX.

  3. Click com.day.cq.dam.similaritysearch.internal.impl. It opens SimilaritySearch Miscellaneous Tasks.

  4. Click validateConfigs(). In the Validate Configurations dialog, click Invoke.

    The validation results are displayed in the same dialog.

Enable smart tagging in the DAM Update Asset workflow (Optional)

  1. In Experience Manager, go to Tools > Workflow > Models.

  2. On Workflow Models page, select the DAM Update Asset workflow model.

  3. Click Edit from the toolbar.

  4. Expand the Side Panel to display the steps. Drag Smart Tag Asset step that is available in the DAM Workflow section and place it after the Process Thumbnails step.

    Add smart tag asset step after the process thumbnail step in the DAM Update Asset workflow

    Figure: Add smart tag asset step after the process thumbnail step in the DAM Update Asset workflow.

  5. Open the step in edit mode. Under Advanced Settings, ensure that the Handler Advance option is selected.

    Configure DAM Update Asset workflow and add smart tag step

    Figure: Configure DAM Update Asset workflow and add smart tag step

  6. In the Arguments tab, select Ignore Errors if you want the workflow to complete even if the automatic tagging step fails.

    Configure DAM Update Asset workflow to add smart tag step and select handler advance

    Figure: Configure DAM Update Asset workflow to add smart tag step and select handler advance

    To tag assets when they are uploaded irrespective of whether smart tagging is enabled on folders, select Ignore Smart Tag Flag.

    Configure DAM Update Asset workflow to add smart tag step and select ignore Smart Tag flag

    Figure: Configure DAM Update Asset workflow to add smart tag step and select ignore Smart Tag flag

  7. Click OK to close the process step, and then save the workflow.

Related Articles
Previous page
Next page

Experience Manager