DocumentationAEMAEM TutorialsAEM as a Cloud Service Tutorials

Deploy an extension

Last update: Tue May 14 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Beginner
  • Developer

For use on AEM as a Cloud Service environments, the extension App Builder app must be deployed and approved.

There are several considerations to be aware of when deploying extension App Builder apps:

  • Extensions are deployed to the Adobe Developer Console project workspace. The default workspaces are:

    • Production workspace contains extension deployments that are available in all AEM as a Cloud Service.
    • Stage workspace acts as a developer workspace. Extensions deployed to the Stage workspace are not available in AEM as a Cloud Service.
      Adobe Developer Console workspaces do not have any direct correlation with AEM as a Cloud Service environment types.

  • An extension deployed to the Production workspace displays in all AEM as a Cloud Service environments in the Adobe Org that the extension exists in.
    An extension cannot be limited to the environments it’s registered with by adding conditional logic that checks the AEM as a Cloud Service host name.

  • Multiple extensions can be used on AEM as a Cloud Service. Adobe recommends each extension App Builder app is used to solve a single business objective. That said, a single extension App Builder app can implement multiple extension points that support a common business objective.

Initial deployment

For an extension to be available on AEM as a Cloud Service environments, it must be deployed to Adobe Developer Console.

The deployment process split into two logical steps:

  1. Deployment of the extension App Builder app to Adobe Developer Console by a developer.
  2. Approval of the extension by a deployment manager or business owner.

Deploy the extension

Deploy the extension to the Production workspace. Extensions deployed to the Production workspace are automatically added to all AEM as a Cloud Service Author services in Adobe Org that the extension is deployed to.

  1. Open a command line to the root of the updated extension App Builder app.

  2. Ensure that the Production workspace is active

    code language-shell 
    $ aio app use -w Production

    Merge any changes to .env and .aio.

  3. Deploy the updated extension App Builder app.

    code language-shell 
    $ aio app deploy

Request deployment approval

Submit extension for approval {align="center"}

  1. Log in to Adobe Developer Console
  2. Select Console
  3. Navigate to Projects
  4. Select the project associated with the extension
  5. Select the Production workspace
  6. Select Submit for approval
  7. Complete and submit the form, updating the fields as needed.

Deployment approval

Extension approval {align="center"}

  1. Log in to Adobe Exchange
  2. Navigate to Manage > Apps pending review
  3. Review the extension App Builder app
  4. If the extension changes are acceptable Accept the review. This immediately injects the extension on all AEM as a Cloud Service Author services within the Adobe Org.

Once the extension request is approved, the extension immediately becomes active in the AEM as a Cloud Service Author services.

Update an extension

Updating and extension App Builder app follows the same process as the initial deployment, with the deviation that the existing extension deployment must first be revoked.

Revoke the extension

To deploy a new version of an extension, it must first be revoked (or removed). While the extension is Revoked, it is not available in AEM consoles.

  1. Log in to Adobe Exchange
  2. Navigate to Manage > App Builder Apps
  3. Revoke the Extension to update

Deploy the extension

Deploy the extension to the Production workspace. Extensions deployed to the Production workspace are automatically added to all AEM as a Cloud Service Author services in Adobe Org that the extension is deployed to.

  1. Open a command line to the root of the updated extension App Builder app.

  2. Ensure that the Production workspace is active

    code language-shell 
    $ aio app use -w Production

    Merge any changes to .env and .aio.

  3. Deploy the updated extension App Builder app.

    code language-shell 
    $ aio app deploy

Request deployment approval

Submit extension for approval {align="center"}

  1. Log in to Adobe Developer Console
  2. Select Console
  3. Navigate to Projects
  4. Select the project associated with the extension
  5. Select the Production workspace
  6. Select Submit for approval
  7. Complete and submit the form, updating the fields as needed.

Approve the deployment request

Extension approval {align="center"}

  1. Log in to Adobe Exchange
  2. Navigate to Manage > Apps pending review
  3. Review the extension App Builder app
  4. If the extension changes are acceptable Accept the review. This immediately injects the extension on all AEM as a Cloud Service Author services within the Adobe Org.

Once the extension request is approved, the extension immediately becomes active in the AEM as a Cloud Service Author services.

Remove an extension

Remove an extension

To remove an extension, revoke (or remove) it from Adobe Exchange. When the extension is revoked, it is removed from all AEM as a Cloud Service Author services.

  1. Log in to Adobe Exchange
  2. Navigate to Manage > App Builder Apps
  3. Revoke the Extension to remove
recommendation-more-help
4859a77c-7971-4ac9-8f5c-4260823c6f69