Configure AEM Assets with Brand Portal
Adobe Experience Manager (AEM) Assets is configured with Brand Portal via Adobe Developer Console, which procures an IMS token for authorization of your Brand Portal tenant.
How configuration works?
Configuring the AEM Assets cloud instance with a Brand Portal tenant (organization) requires configurations in both, AEM Assets cloud instance as well as in Adobe Developer Console.
- In AEM Assets cloud instance, create an IMS account and generate a public certificate (public key).
- In Adobe Developer Console, create a project for your Brand Portal tenant (organization).
- Under the project, configure an API using the public key to create a service account (JWT) connection.
- Get the service account credentials and JWT payload information.
- In AEM Assets cloud instance, configure the IMS account using the service account credentials and JWT payload.
- In AEM Assets cloud instance, configure the Brand Portal cloud service using the IMS account and Brand Portal endpoint (organization URL).
- Test the configuration by publishing an asset from AEM Assets cloud instance to Brand Portal.
A Brand Portal tenant shall only be configured with one AEM Assets cloud instance.
Do not configure a Brand Portal tenant with multiple AEM Assets cloud instances.
You require the following to configure AEM Assets with Brand Portal:
- An up and running AEM Assets cloud instance.
- Brand Portal tenant URL.
- A user with system administrator privileges on the IMS organization of the Brand Portal tenant.
Contact Customer Care for further queries.
Perform the following steps in the specified sequence to configure AEM Assets cloud instance with Brand Portal.
Obtain public certificate
Public certificate allows you to authenticate your profile on Adobe Developer Console.
- Log in to your AEM Assets cloud instance.
- From the Tools panel, navigate to Security > Adobe IMS Configurations .
- In Adobe IMS Configurations page, click Create .
- You are redirected to the Adobe IMS Technical Account Configuration page. By default, the Certificate tab opens.Select the cloud solution Adobe Brand Portal .
- Mark the check box Create new certificate and specify an alias for the certificate. The alias serves as name of the dialog.
- Click Create certificate . Then, click OK in the dialog box to generate the public certificate.
- Click Download Public Key and save the certificate (.crt) file on your machine.The certificate file will be used in further steps to configure API for your Brand Portal tenant and generate service account credentials in Adobe Developer Console.
- Click Next .In the Account tab, you create the Adobe IMS account but for that you will need 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 organization (Brand Portal tenant) level. Configuring an API creates a service account (JWT) connection in Adobe Developer Console. There are two methods to configure API, by generating a key pair (private and public keys) or by uploading a public key. To configure AEM Assets cloud instance with Brand Portal, you must generate a public certificate (public key) in AEM Assets cloud instance and create credentials in Adobe Developer Console by uploading the public key. This public key is used to configure API for the selected Brand Portal organization and generates the credentials and JWT payload for the service account. These credentials are further used to configure the IMS account in AEM Assets cloud instance. Once the IMS account is configured, you can configure the Brand Portal cloud service in AEM Assets cloud instance.
Perform the following steps to generate the service account credentials and JWT payload:
- Log in to Adobe Developer Console with system administrator privileges on the IMS organization (Brand Portal tenant). The default URL isEnsure that you have selected the correct IMS organization (Brand Portal tenant) from the dropdown (organization list) located at the upper-right corner.
- Click Create new project . A blank project is created for your organization.Click Edit project to update the Project Title and Description , and click Save .
- In the Project overview tab, click Add API .
- In the Add an API window, select AEM Brand Portal and click Next .Ensure that you have access to the AEM Brand Portal service.
- In the Configure API window, click Upload your public key . Then, click Select a File and upload the public certificate (.crt file) that you have downloaded in the obtain public certificate section.Click Next .
- Verify the public certificate and click Next .
- Select the default product profile Assets Brand Portal and click Save configuration .
- With the API configured, you are redirected to the API overview. From the left navigation under Credentials , click Service Account (JWT) .You can view the credentials and perform other actions (generate JWT tokens, copy credential details, retrieve client secret, and so on) as needed.
- From the Client Credentials tab, copy the client ID .Click Retrieve Client Secret and copy the client secret .
- Navigate to the Generate JWT tab and copy the JWT Payload .
You can now use the client ID (API key), client secret, and JWT payload to configure the IMS account in AEM Assets cloud instance.
Configure IMS account
Ensure that you have performed the following steps:
Perform the following steps to configure the IMS account that you have created in obtain public certificate .
- Open the IMS Configuration and navigate to the Accounts tab. You kept the page open while obtaintaing the public certificate .
- Specify a Title for the IMS account.In Authorization Server , enter the URL: https://ims-na1.adobelogin.com/Paste the client ID in API key, client secret, and JWT payload that you have copied while creating the service account (JWT) connection .Click Create .The IMS account is configured.
- 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 .
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
Perform the following steps to configure the Brand Portal cloud service:
- Log in to your AEM Assets cloud instance.
- From the Tools panel, navigate to Cloud Services > AEM Brand Portal .
- In the Brand Portal Configurations page, click Create .
- Specify a Title for the configuration.Select the IMS configuration that you have created while configuring the IMS account .In the Service URL , enter your Brand Portal tenant (organization URL).
- Click Save and Close . The cloud configuration is created. Your AEM Assets cloud instance is now configured with the Brand Portal tenant.
Perform the following steps to validate the configuration:
- Log in to your AEM Assets cloud instance.
- From the Tools panel, navigate to Deployment > Distribution .
- In the Distribution page, you can see that a Brand Portal distribution agent bpdistributionagent0 is created for Publish to Brand Portal .Click Publish to Brand Portal .By default, one distribution agent is created for a Brand Portal tenant.
- In the distribution agent page, you can see the distribution queues under the Status tab.A distribution agent contains two queues:
It is recommended to review the failures and clear the error-queue periodically.
- processing-queue : for the distribution of assets to Brand Portal.
- error-queue : for the assets where distribution has failed.
- To verify the connection between AEM Assets and Brand Portal, click Test Connection .A message appears at the bottom of page that your test package is successfully delivered.Avoid disabling the distribution agent, as it can cause the distribution of the assets (running-in-queue) to fail.
Your AEM Assets cloud instance is successfully configured with Brand Portal, you can now:
In addition to the above, you can also publish metadata schemas, image presets, search facets, and tags from AEM Assets to Brand Portal.
See, Brand Portal documentation for more information.
You can check the logs for detailed information on the actions performed by the distribution agent.
For example, we have published an asset from AEM Assets to Brand Portal to validate the configuration.
- Follow the steps (from 1 to 4) as shown in the Test Configuration section and navigate to the distribution agent page.
- Click Logs to view the distribution logs. You can see the processing and error logs here.
The distribution agent generates the following logs:
- INFO: This is a system generated log that triggers on successful configuration that enables 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 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 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 (a.k.a Add Path) in Brand Portal because the asset was published for the first time, therefore, triggers an additional request to create a parent folder with the same name in Brand Portal where the asset is published.
Additional request is generated in case the parent folder does not exist in Brand Portal (in the above example), or the parent folder has been modified in AEM Assets.