DocumentationAEM 6.4Assets Guide

Configure AEM Assets with Brand Portal configure-integration-64

Last update: Wed May 03 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

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.

Adobe Experience Manager Assets is configured with Brand Portal through Adobe I/O, which procures an IMS token for authorization of your Brand Portal tenant.

NOTE
Configuring AEM Assets with Brand Portal via Adobe I/O is supported on AEM 6.4.8.0 and above.
Earlier, Brand Portal was configured in Classic UI via Legacy OAuth Gateway, which uses the JWT token exchange to obtain an IMS Access token for authorization.
TIP
For existing customers only
It is recommended to continue using existing legacy OAuth Gateway configuration. In case, you encounter problems with legacy OAuth Gateway configuration, delete the existing configuration and create new configuration via Adobe I/O.

This help describes the following two use-cases:

  • New configuration: If you are a new Brand Portal user and want to configure your AEM Assets author instance with Brand Portal, you can create new configuration on Adobe I/O.
  • Upgrade configuration: If you are an existing Brand Portal user with your AEM Assets author instance configured with Brand Portal on legacy OAuth Gateway, it is recommended to delete the existing configurations and create new configuration on Adobe I/O.

The information provided is based on the assumption that anyone reading this Help is familiar with the following technologies:

  • Installing, configuring, and administering Adobe Experience Manager and AEM packages

  • Using Linux and Microsoft Windows operating systems

Prerequisites prerequisites

You require the following to configure AEM Assets with Brand Portal:

  • An up and running AEM Assets author instance with latest Service Pack.
  • Brand Portal tenant URL.
  • A user with system administrator privileges on the IMS organization of the Brand Portal tenant.

Download and install AEM 6.4

Download and install latest AEM Service Pack

Download and install AEM 6.4 aemquickstart

It is recommended to have AEM 6.4 to set up an AEM author instance. If you do not have AEM up and running, download it from the following locations:

After you download AEM, for instructions to set up an AEM author instance, see deploying and maintaining.

Download and install AEM latest Service Pack servicepack

For detailed instructions see,

Contact Customer Support if you are unable to find the latest AEM package or Service Pack.

Create configuration configure-new-integration-64

Perform the following steps in the listed sequence if you are configuring AEM Assets with Brand Portal for the first-time:

  1. Obtain public certificate
  2. Create Adobe I/O integration
  3. Create IMS Account configuration
  4. Configure cloud service
  5. Test configuration
NOTE
An AEM Assets author instance shall only be configured with one Brand Portal tenant.

Create IMS configuration create-ims-configuration

IMS configuration authenticates your Brand Portal tenant with AEM Assets author instance.

IMS configuration includes two steps:

Obtain public certificate public-certificate

Public certificate allows you to authenticate your profile on Adobe I/O.

  1. Login to your AEM Assets author instance
    Default URL: http:// localhost:4502/aem/start.html

  2. From Tools Tools panel, navigate to Security >> Adobe IMS Configurations.

    Adobe IMS Account Configuration UI

  3. Adobe IMS Configurations page opens.

    Click Create.

    This will take you to the Adobe IMS Technical Account Configuration page.

  4. By default, Certificate tab opens.

    In Cloud Solution, select Adobe Brand Portal.

  5. Mark the checkbox Create new certificate and specify an alias for the certificate. The alias serves as name of the dialog.

  6. Click Create certificate. A dialog appears. Click OK to generate the public certificate.

    Create Certificate

  7. Click Download Public Key and save the AEM-Adobe-IMS.crt certificate file on your machine. The certificate file is used to create Adobe I/O integration.

    Download Certificate

  8. Click Next.

    In the Account tab, you create the Adobe IMS Account but for that you will need the integration details. Keep this page open for now.

    Open a new tab and Create Adobe I/O integration to get the integration details for IMS Account configurations.

Create Adobe I/O integration createnewintegration

Adobe I/O integration generates API Key, Client Secret, and Payload (JWT) which is required in setting up the IMS Account configurations.

  1. Login to Adobe I/O Console with system administrator privileges on the IMS organization of the Brand Portal tenant.

    Default URL: https://console.adobe.io/

  2. Click Create Integration.

  3. Select Access an API, and click Continue.

    Create New Integration

  4. Create a new integration page opens.

    Select your organization from the drop-down list.

    In Experience Cloud, Select AEM Brand Portal and click Continue.

    If the Brand Portal option is disabled for you, ensure that you have selected correct organization from the drop-down box above the Adobe Services option. If you do not know your organization, contact your administrator.

    Create Integration

  5. Specify a name and description for the integration. Click Select a File from your computer and upload the AEM-Adobe-IMS.crt file downloaded in the obtain public certificates section.

  6. Select the profile of your organization.

    Or, select the default profile Assets Brand Portal and click Create Integration. The integration is created.

  7. Click Continue to integration details to view the integration information.

    Copy the API Key

    Click Retrieve Client Secret and copy the Client Secret key.

    API Key, Client Secret, and payload information of an integration

  8. Navigate to JWT tab, and copy the JWT payload.

    The API Key, Client Secret key, and JWT payload information will be used to create IMS account configuration.

Create IMS Account configuration create-ims-account-configuration

Ensure that you have performed the following steps:

Steps to create IMS account configuration:

  1. Open the IMS Configuration page, Accounts tab. You kept the page open at the end of section, Obtain public certificate.

  2. Specify a Title for the IMS account.

    In Authorization Server, enter the URL: https://ims-na1.adobelogin.com/

    Paste the API Key, Client Secret, and JWT payload that you have copied in the end of Create Adobe I/O integration.

    Click Create.

    The Integration is created.

    IMS Account configuration

  3. Select the IMS configuration and click Check Health. A dialog box appears.

    Click Check. On successful connection, the Token retrieved successfully message appears.

CAUTION
You must have only one IMS configuration. Do not create multiple IMS configurations.
Ensure that the IMS configuration passes the health check. If the configuration does not pass the health check, it is invalid. You must delete it and create a new, valid configuration.

Configure cloud service configure-the-cloud-service

Perform the following steps to create Brand Portal cloud service configuration:

  1. Login to your AEM Assets author instance

    Default URL: http:// localhost:4502/aem/start.html

  2. From Tools Tools panel, navigate to Cloud Services >> AEM Brand Portal.

    Brand Portal Configurations page opens.

  3. Click Create.

  4. Specify a Title for the configuration.

    Select the IMS Configuration that you have created in the step, create IMS Account configuration.

    In Service URL, enter your Brand Portal tenant URL.

  5. Click Save and Close. The cloud configuration is created. Your AEM Assets author instance is now integrted with the Brand Portal tenant.

Test configuration test-integration

  1. Login to your AEM Assets author instance

    Default URL: http:// localhost:4502/aem/start.html

  2. From Tools Tools panel, navigate to Deployment >> Replication.

  3. Replication page opens.

    Click Agents on author.

  4. Four replication agents are created for each tenant.

    Locate the replication agents of your Brand Portal tenant.

    Click the replication agent URL.

    note note
    NOTE
    The replication agents work in parallel and share the job distribution equally, thereby increasing the publishing speed by four times the original speed. After the cloud service is configured, additional configuration is not required to enable the replication agents that are activated by default to enable parallel publishing of multiple assets.

  5. To verify the connection between AEM Assets author and Brand Portal, click Test Connection.

  6. Look at the bottom of the test results to verify that the replication succeeded.

  7. Verify the test results on all four replication agents one-by-one.

    note note
    NOTE
    Avoid disabling any of the replication agents, as it can cause the replication of some of the assets to fail.
    Ensure that all the four replication agents are configured to avoid timeout error. See troubleshoot issues in parallel publishing to Brand Portal.

Brand Portal is successfully configured with your AEM Assets author instance. You can now:

Upgrade configuration upgrade-integration-64

Perform the following steps in the listed sequence to upgrade existing configurations:

  1. Verify running jobs
  2. Delete existing configurations
  3. Create configuration

Verify running jobs verify-jobs

Ensure that no publishing job is running on your AEM Assets author instance before you make any modifications. For that, you can verify all four replication agents and ensure that the queue is ideal/empty.

  1. Login to your AEM Assets author instance

    Default URL: http:// localhost:4502/aem/start.html

  2. From Tools Tools panel, navigate to Deployment >> Replication.

  3. Replication page opens.

    Click Agents on author.

  4. Locate the replication agents of your Brand Portal tenant.

    Ensure that the Queue is Idle for all the replication agents, no publishing job is active.

Delete existing configurations delete-existing-configuration

You must run the following check-list while deleting the existing configuration.

  • Delete all four replication agents
  • Delete cloud service
  • Delete MAC user

Perform the following steps to delete the existing configuration:

  1. Login to your AEM Assets author instance and open CRX Lite as an administrator.

    Default URL: http:// localhost:4502/crx/de/index.jsp

  2. Navigate to /etc/replications/agents.author and delete all the four replication agents of your Brand Portal tenant.

  3. Navigate to /etc/cloudservices/mediaportal and delete the Cloud Service configuration.

  4. Navigate to /home/users/mac and delete the MAC user of your Brand Portal tenant.

You can now create configuration on your AEM 6.4 author instance on Adobe I/O.

After replication succeeds, you can publish assets, folders, and Collections to Brand Portal. For details, see:

recommendation-more-help
4452738f-2bdf-4cd4-9b45-905a69d607ad