You're viewing help content for version:

Learn how to configure AEM Assets with Brand Portal for publishing assets and collections to Brand Portal.

Adobe Experience Manager (AEM) 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.3.3.8 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.

Configuration via Legacy OAuth is no longer supported from April 6, 2020, and is changed to configuring via Adobe I/O.

 

Note:

(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 configuration 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

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

It is recommended to have AEM 6.3 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 6.3 latest Service Pack

For detailed instructions see,

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

Create configuration

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

  1. Create cloud service
  2. Create Adobe I/O integration
  3. Configure cloud service
  4. Test configuration

Create 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 panel, navigate to Deployment >> Cloud Services.

  3. Find Assets Brand Portal configuration section and click Configure now.

  4. Specify Title and Name for the new configuration, and click Create.

    Create Cloud Service
  5. AEM Assets Brand Portal Replication window opens.

    In Tenant URL, enter the tenant URL of your organization.

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

    Click OK.

    Replication window
  6. Cloud configuration is created and a public key is generated for your configuration.

    Download Public key. This Public key is required for token authorization.

    Cloud Service settings

The next step is to create Adobe I/O integration and then you can continue to configure the Brand Portal cloud service.

Create Adobe I/O integration

The integration generates API Key, Technical Account Id, Organization Id, and Client Secret key which is required in configuring Brand Portal cloud service.

  1. Login to Adobe 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 new integration
  5. pecify a name and description for the integration. Click Select a File from your computer and upload the AEM-Adobe-IMS.crt certificate file.

  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 API KeyTechnical Account IdOrg Id, and Client Secret key.

    Create new integration

The API Key, Technical Account Id, Organization Id, and Client Secret key information will be used to configure the Brand Portal cloud service.

Configure cloud service

You can configure the Brand Portal cloud service to update the configuration. Continue with the last step where you left in create cloud service.

  1. Login to your AEM Assets author instance

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

  2. From Tools panel, navigate to Deployment >> Cloud Services.

  3. Find Assets Brand Portal configuration section and click Show Configurations.

  4. Click on the newly created cloud service and click Edit to update the configurations.

  5. Paste the API Key, Technical Account IdOrg Id, and Client Secret key that you have copied at the end of create Adobe I/O integration.

    configure cloud service
  6. Click OK to update the configurations.

Note:

Create only one, valid configuration. 

Make sure to test the configuration. In case, the configuration fails, delete it and create a new configuration.

Test configuration

  1. Login to your AEM Assets author instance

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

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

    Replication
  3. Replication page opens.

    Click Agents on author.

    Replication 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:

    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.

    Note:

    Avoid disabling any of the replication agents, as it can cause the replication of some of the assets to fail.

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

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

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

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

Upgrade configuration

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

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

Verify running 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 panel, navigate to Deployment >> Replication.

  3. Replication page opens.

    Click Agents on author.

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

    Replication window

Delete existing configurations

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.

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

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

    delete mac user

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

Publish assets to Brand Portal

After replication succeeds, you can publish assets, folders, and collections to Brand Portal. To publish a folder to Brand Portal, follow these steps:

Note:

Adobe recommends installing AEM 6.2 SP1-CFP5, AEM CFP 6.3.0.2, and later releases to utilize multiple replication agents for high-speed parallel publishing.

Note:

Adobe recommends staggered publishing, preferably during non-peak hours, so that the AEM author does not occupy excess resources.

  1. From the Assets console, hover over the desired folder and select Publish option from the quick actions.

    Alternatively, select the folder you want to publish to Brand Portal.

    Publish2BP
  2. To publish the selected assets to Brand Portal, do either of the following:

    • From the toolbar, select Quick Publish. Then from the menu, select Publish to Brand Portal.
    • From the toolbar, select Manage Publication. Then from the Actions, select Publish to Brand Portal and select Next.
      Once on Manage Publication page, confirm your selection and tap/ click Publish to Brand Portal.

    A confirmation message appears when the folder is successfully published on the Brand Portal Interface.

  3. Log in to Brand Portal. The published folder is available at the Brand Portal interface.

    bp_631_landing_page