DocumentationAEM 6.5User Guide

Configure AEM Assets with Brand Portal configure-integration-65

Last update: Thu Mar 14 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Admin
Version
Article link
AEM as a Cloud Service
Click here
AEM 6.5
This article

Adobe Experience Manager Assets Brand Portal lets you publish approved brand assets from Adobe Experience Manager Assets to Brand Portal and distribute them to the Brand Portal users.

AEM Assets is configured with Brand Portal via Adobe Developer Console, which procures an Adobe Identity Management Services (IMS) account token for authorization of the Brand Portal tenant.

NOTE
Configuring AEM Assets with Brand Portal via Adobe Developer Console is supported on AEM 6.5.4.0 and above.
Earlier, Brand Portal was configured via legacy OAuth Gateway, which uses the JSON Web Token (JWT) exchange to obtain an IMS Access token for authorization.
Configuration via legacy OAuth Gateway is no longer supported from April 6, 2020, and is changed to Adobe Developer Console.
TIP
For existing customers only
Adobe recommends that you continue to use the existing legacy OAuth Gateway configuration. If you encounter problems with legacy OAuth Gateway configuration, delete the existing configuration and create a configuration by way of the Adobe Developer Console.

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 a configuration by way of the Adobe Developer Console.
  • Upgrade configuration: If you are an existing Brand Portal user having configuration on legacy OAuth Gateway, delete the existing configuration and create a configuration by way of Adobe Developer Console.

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 the latest Service Pack
  • A Brand Portal tenant URL
  • A user with system administrator privileges on the IMS organization of the Brand Portal tenant

Download and install AEM 6.5

Download and install the latest AEM Service Pack

Download and install AEM 6.5 aemquickstart

It is recommended to have AEM 6.5 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 the current AEM 6.5 Service Pack Release Notes.

Contact Adobe Customer Support if you cannot find the latest AEM package or Service Pack.

Create configuration configure-new-integration-65

Configuring AEM Assets with Brand Portal requires configurations in both AEM Assets Author instance and the Adobe Developer Console.

  1. In AEM Assets, create an IMS account and generate a public certificate (public key).
  2. In Adobe Developer Console, create a project for your Brand Portal tenant (organization).
  3. Under the project, configure an API using the public key to create a service account (JWT) connection.
  4. Get the service account credentials and JWT payload information.
  5. In AEM Assets, configure the IMS account using the service account credentials and JWT payload.
  6. In AEM Assets, configure the Brand Portal cloud service using the IMS account and Brand Portal endpoint (organization URL).
  7. Test your configuration by publishing an asset from AEM Assets to Brand Portal.
NOTE
An AEM Assets Author instance shall only be configured with one Brand Portal tenant.

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

  1. Obtain a public certificate
  2. Create service account (JWT) connection
  3. Configure an IMS account
  4. Configure cloud service
  5. Test configuration

Create IMS configuration create-ims-configuration

The IMS configuration authenticates your AEM Assets Author instance with the Brand Portal tenant.

IMS configuration includes two steps:

Obtain public certificate public-certificate

The public key (certificate) authenticates your profile on Adobe Developer Console.

  1. Log in to your AEM Assets Author instance. The default URL is http://localhost:4502/aem/start.html.

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

  3. In the Adobe IMS Configurations page, click Create. It redirects to the Adobe IMS Technical Account Configuration page. By default, the Certificate tab opens.

  4. Select Adobe Brand Portal in the Cloud Solution dropdown list.

  5. Select the Create new certificate check box and specify an alias for the public key. The alias serves as the name of the public key.

  6. Click Create certificate. Then, click OK to generate the public key.

    Create Certificate

  7. Click the Download Public Key icon and save the public key (.crt) file on your machine.

    The public key is used later to configure the API for your Brand Portal tenant and generate service account credentials in Adobe Developer Console.

    Download Certificate

  8. Click Next.

    In the Account tab, an Adobe IMS account is created which requires the service account credentials that are generated in Adobe Developer Console. Keep this page open for now.

    Open a new tab and create a service account (JWT) connection in Adobe Developer Console so you can get the credentials and JWT payload for configuring the IMS account.

Create the service account (JWT) connection createnewintegration

In Adobe Developer Console, projects and APIs are configured at the Brand Portal tenant (organization) level. Configuring an API creates a service account (JWT) connection. There are two methods to configure the API, by generating a key pair (private and public keys) or by uploading a public key. To configure AEM Assets with Brand Portal, you must generate a public key (certificate) in AEM Assets and create credentials in Adobe Developer Console by uploading the public key. These credentials are required to configure the IMS account in AEM Assets. Once the IMS account is configured, you can configure the Brand Portal cloud service in AEM Assets.

To create the service account credentials and JWT payload, do the following:

  1. Log in to Adobe Developer Console with system administrator privileges on the IMS organization (Brand Portal tenant). The default URL is https://www.adobe.com/go/devs_console_ui.

    note note
    NOTE
    Ensure that you have selected the correct IMS organization (Brand Portal tenant) from the drop-down (organization) list in the upper-right corner.

  2. Click Create new project. A blank project with a system-generated name is created for your organization.

    Click Edit project so you can update the Project Title and Description, and click Save.

  3. In the Project overview tab, click Add API.

  4. In the Add an API window, select AEM Brand Portal and click Next.

    Ensure that you have access to the AEM Brand Portal service.

  5. In the Configure API window, click Upload your public key. Then, click Select a File and upload the public key (.crt file) that you have downloaded in the obtain public certificate section.

    Click Next.

    Upload Public Key

  6. Verify the public key and click Next.

  7. Select Assets Brand Portal as the default product profile and click Save configured API.

    Select Product Profile

  8. Once the API is configured, you are redirected to the API overview page. From the left navigation under Credentials, click the Service Account (JWT) option.

    note note
    NOTE
    You can view the credentials and perform actions such as generate JWT tokens, copy credential details, and retrieve client secret.

  9. From the Client Credentials tab, copy the client ID.

    Click Retrieve Client Secret and copy the client secret.

    Service Account Credentials

  10. Navigate to the Generate JWT tab and copy the JWT Payload information.

You can now use the client ID (API key), client secret, and JWT payload to configure the IMS account in AEM Assets.

Configure the IMS account create-ims-account-configuration

Ensure that you have already performed the following steps:

To configure the IMS account:

  1. Open the IMS Configuration and navigate to the Account tab. You kept the page open while obtaining the public certificate.

  2. Specify a Title for the IMS account.

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

    Specify client ID in the API key field, Client Secret, and Payload (JWT payload) that you have copied while creating the service account (JWT) connection.

    Click Create.

    The IMS account is configured.

    IMS Account configuration

  3. Select the IMS account configuration and click Check Health.

    Click Check in the dialog box. On successful configuration, a message appears that the Token is retrieved successfully.

    Healthy Configuration confirmation dialog

CAUTION
You must have only one IMS configuration.
Ensure that the IMS configuration passes the health check. If the configuration does not pass the health check, it is invalid. Delete it and create another valid configuration.

Configure the Brand Portal cloud service configure-the-cloud-service

  1. Log in to your AEM Assets Author instance.

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

  3. In the Brand Portal Configurations page, click Create.

  4. Specify a Title for the configuration.

    Select the IMS configuration that you have created while configuring the IMS account.

    In the Service URL field, specify your Brand Portal tenant (organization) URL.

    Brand Portal Configuration window

  5. Click Save & Close. The cloud configuration is created.

    Your AEM Assets Author instance is now configured with the Brand Portal tenant.

Test and validate the configuration test-integration

  1. Log in to your AEM Assets cloud instance.

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

    The Tools panel

  3. In the Replication page, click Agents on Author.

    Replication page

    You can see the four replication agents created for your Brand Portal tenant.

    Locate the replication agents of your Brand Portal tenant and click the replication agent URL.

    Assets replication configuration

    note note
    NOTE
    The replication agents work in parallel and share the job distribution equally, so that it increases 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.

  4. To verify the connection between AEM Assets and Brand Portal, click the Test Connection icon.

    Verifying the assets replication settings

    A message appears that your test package is successfully delivered.

    Test confirmation output

  5. Verify the test results on all four replication agents.

    note note
    NOTE
    Avoid disabling any of the replication agents, as it can cause the replication of the assets (running-in-queue) to fail.
    Ensure that all the four replication agents are configured to avoid timeout error. See troubleshoot issues in parallel publishing to Brand Portal.
    Do not modify any autogenerated settings.

You can now:

See the Brand Portal documentation for more information.

Upgrade configuration upgrade-integration-65

To upgrade your existing configurations to Adobe Developer Console, do the following steps, in the listed sequence :

  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 edits. For that, you can verify the status of active jobs on all the four replication agents and ensure that the queues are idle.

  1. Log in to your AEM Assets Author instance.

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

  3. In the Replication page, click Agents on Author.

    Replication agents for assets

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

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

    Replication queue settings

Delete existing configurations delete-existing-configuration

Run the following checklist while deleting the existing configurations:

  • Delete all four replication agents
  • Delete Brand Portal cloud service
  • Delete Mac user

  1. Log in to your AEM Assets Author instance and open CRX Lite as an administrator. The default URL is 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.

    Replication agent in CRXDE

  3. Navigate to /etc/cloudservices/mediaportal and delete the Brand Portal cloud service configuration.

    Detail of replication agent in CRXDE

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

    More detail of replication agent in CRXDE

You can now create a configuration by way of the Adobe Developer Console on your AEM 6.5 Author instance.

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2