Configure Experience Manager Assets with Brand Portal

Last update: 2023-11-17
  • Created for:
  • Admin
Version Article link
AEM 6.5 Click here
AEM as a Cloud Service This article

Configuring Adobe Experience Manager Assets Brand Portal lets you publish approved brand assets from Adobe Experience Manager Assets as a Cloud Service instance to Brand Portal and distribute them to the Brand Portal users.

Activate Brand Portal using Cloud Manager

The Cloud Manager user activates Brand Portal for an Experience Manager Assets as a Cloud Service instance. The activation workflow creates the required configurations (authorization token, IMS configuration, and Brand Portal cloud service) at the backend and reflects the status of the Brand Portal tenant in Cloud Manager. Activating Brand Portal enables the Experience Manager Assets users to publish assets to Brand Portal and distribute them to the Brand Portal users.

Prerequisites

You require the following to activate Brand Portal on your Experience Manager Assets as a Cloud Service instance:

  • An up and running Experience Manager Assets as a Cloud Service instance.
  • A user having access to Cloud Manager, assigned to Profiles of the Cloud Manager Product. See accessing Cloud Manager for more information.
NOTE

A configured production environment is required to an Experience Manager Assets as a Cloud Service instance to connect with Brand Portal tenant.

Steps to activate Brand Portal

You can activate Brand Portal while creating the production environments for your Experience Manager Assets as a Cloud Service instance, or separately. Let us assume that the environment was already created, and you are now required to activate Brand Portal.

  1. Login to Adobe Cloud Manager and navigate to Environments.

    The Environments page displays the list of all the existing environments.

  2. Select the environments (one by one) from the list to view the environment details.

    Brand Portal is entitled to one of the available environments and is reflected under the Environment Information.

    Once you find the environment associated with Brand Portal, click the Activate Brand Portal button to begin the activation workflow.

    Activate Brand Portal

  3. It takes few mins to activate the Brand Portal tenant as the activation workflow creates the required configurations at the backend. Once the Brand Portal tenant is activated, the status changes to Activated.

    View Status

NOTE

Brand Portal must be activated on the same IMS org as of the Experience Manager Assets as a Cloud Service instance.

If you have an existing Brand Portal cloud configuration (manually configured using Adobe Developer Console) for an IMS org (org1-existing) and your Experience Manager Assets as a Cloud Service instance is configured for another IMS org (org2-new), activating Brand Portal from the Cloud Manager resets the Brand Portal IMS org to org2-new. Although the manually configured cloud configuration on org1-existing is visible in the Experience Manager Assets author instance but will no longer be in use after activating Brand Portal from the Cloud Manager.

If the existing Brand Portal cloud configuration and Experience Manager Assets as a Cloud Service instance are using the same IMS org (org1), you only have to activate Brand Portal from the Cloud Manager.

Do not modify any autogenerated settings.

See also:

Login to your Brand Portal tenant:

After activation of your Brand Portal tenant in Cloud Manager, you can login to Brand Portal from Admin Console or by directly using the tenant URL.

The default URL of your Brand Portal tenant is: https://<tenant-id>.brand-portal.adobe.com/.

Wherein, the Tenant id is the IMS org.

Perform the following steps if you are not sure of the Brand Portal URL:

  1. Login to Admin Console and navigate to Products.

  2. From the left panel, select Adobe Experience Manager Brand Portal – Brand Portal.

  3. Click Go to Brand Portal to directly open Brand Portal in the browser.

    Or copy the Brand Portal tenant URL from the Go to Brand Portal link and paste it in your browser to open the Brand Portal interface.

    Access Brand Portal

Test connection

Perform the following steps to validate the connection between your Experience Manager Assets as a Cloud Service instance and Brand Portal tenant:

  1. Login to Experience Manager Assets.

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

    Navigate to the distribution option

    A Brand Portal distribution agent (bpdistributionagent0) is created under Publish to Brand Portal.

    Create distribution agent

  3. Click Publish to Brand Portal to open the distribution agent.

    You can see the distribution queues under the Status tab.

    A distribution agent contains two queues:

    • processing-queue: for the distribution of assets to Brand Portal.

    • error-queue: for the assets where distribution has failed.

    NOTE

    It is recommended to review the failures and clear the error-queue periodically.

    Processing queue for the distribution of assets

  4. To verify the connection between Experience Manager Assets as a Cloud Service and Brand Portal, click the Test Connection icon.

    Verify connection between AEM and Brand Portal

    A message appears that your test package is successfully delivered.

    NOTE

    Avoid disabling the distribution agent, as it can cause the distribution of the assets (running-in-queue) to fail.

To verify the connection between your Experience Manager Assets as a Cloud Service instance and Brand Portal tenant, publish an asset from Experience Manager Assets to Brand Portal. If the connection is successful, the published asset is visible in the Brand Portal interface.

You can now:

See Brand Portal documentation for more information.

Distribution logs

You can monitor the distribution agent logs for the asset publishing workflow.

Let us now publish an asset from Experience Manager Assets to Brand Portal and see the logs.

  1. Follow the steps (from 1 to 4) as shown in the Test connection section and navigate to the distribution agent page.

  2. Click Logs to view the processing and error logs.

    Processing and error logs

The distribution agent has generated the following logs:

  • INFO: It is a system-generated log that triggers on successful configuration of the distribution agent.
  • DSTRQ1 (Request 1): Triggers on test connection.

On publishing the asset, the following request and response logs are generated:

Distribution agent request:

  • DSTRQ2 (Request 2): The asset publishing request is triggered.
  • DSTRQ3 (Request 3): The system triggers another request to publish the Experience Manager Assets folder (in which the asset exists) and replicates the folder in Brand Portal.

Distribution agent response:

  • queue-bpdistributionagent0 (DSTRQ2): The asset is published to Brand Portal.
  • queue-bpdistributionagent0 (DSTRQ3): The system replicates the Experience Manager Assets folder (containing the asset) in Brand Portal.

In the above example, an additional request and response are triggered. The system could not find the parent folder (Add Path) in Brand Portal because the asset was published for the first time, therefore, it triggered an additional request to create a parent folder with the same name in Brand Portal where the asset is published.

NOTE

Additional request is generated in case the parent folder does not exist in Brand Portal or has been modified in Experience Manager Assets.

Along with the automation workflow to activate Brand Portal on Experience Manager Assets as a Cloud Service, there exists another method to manually configure Experience Manager Assets as a Cloud Service with Brand Portal using Adobe Developer Console which is not recommended anymore.

NOTE

Contact Customer Support if you are facing any problem while activating your Brand Portal tenant.

Manual configuration using Adobe Developer Console

The following section describes how to manually configure Experience Manager Assets as a Cloud Service with Brand Portal using Adobe Developer Console.

Earlier, Experience Manager Assets as a Cloud Service was manually 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. It requires configurations in both, Experience Manager Assets and Adobe Developer Console.

  1. In Experience Manager Assets, create an IMS account and generate a public key (certificate).
  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 connection.
  4. Get the service account credentials and JSON Web Token (JWT) payload information.
  5. In Experience Manager Assets, configure the IMS account using the service account credentials and JWT payload.
  6. In Experience Manager 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 Experience Manager Assets to Brand Portal.
NOTE

An Experience Manager Assets as a Cloud Service instance shall only be configured with one Brand Portal tenant.

Prerequisites

You require the following to configure Experience Manager Assets with Brand Portal:

  • An up and running Experience Manager Assets as a Cloud Service instance
  • A Brand Portal tenant URL
  • A user with system administrator privileges on the IMS organization of the Brand Portal tenant

Create configuration

Perform the following steps in the specified sequence to configure Experience Manager Assets with Brand Portal.

  1. Obtain public certificate
  2. Create service account (JWT) connection
  3. Configure IMS account
  4. Configure cloud service

Create IMS configuration

The IMS configuration authenticates your Experience Manager Assets as a Cloud Service instance with the Brand Portal tenant.

IMS configuration includes two steps:

Obtain public certificate

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

  1. Login to Experience Manager Assets.

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

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

  4. Select Adobe Brand Portal in the Cloud Solution drop-down list.

  5. Select the Create new certificate check box and specify an alias for the public key. The alias serves as 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 API for your Brand Portal tenant and generate service account credentials in Adobe Developer Console.

    Download Certificate

  8. Click Next.

    In the Account tab, 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 to get the credentials and JWT payload for configuring the IMS account.

Create service account (JWT) connection

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

Perform the following steps to generate the service account credentials and JWT payload:

  1. Login 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

    Ensure that you have selected the correct IMS organization (Brand Portal tenant) from the drop-down (organization) list located at 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 to 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 Experience Manager 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

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

  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 Experience Manager Assets.

Configure IMS account

Ensure that you have performed the following steps:

Perform 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.

    Adobe IMS Configurations Check Health.

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. You must delete it and create another valid configuration.

Configure cloud service

Perform the following steps to configure the Brand Portal cloud service:

  1. Login to Experience Manager Assets.

  2. From the 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 created while configuring the IMS account.

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

    Brand Portal Configuration dialog box.

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

    Your Experience Manager Assets as a Cloud Service instance is now configured with the Brand Portal tenant.

You can now test the configuration by checking the distribution agent and publishing assets to Brand Portal.

Allowlist Egress IPs in SPS if secure preview enabled
If using Dynamic Media-Scene7 with secure preview enabled for a company), then it is advised that Scene7 company administrator allowlist the public egress IPs for respective regions using SPS (Scene7 Publishing System) flash UI.
The egress IPs are as follows:

Region Egress IP
NA 130.248.160.68, 20.94.203.130
EMEA 51.132.146.75, 130.248.244.202, 130.248.244.203, 130.248.244.204, 130.248.244.210, 130.248.244.211, 130.248.244.212
APAC 63.140.44.54

See also

On this page