Develop AEM Commerce for AEM as a Cloud Service

Developing AEM Commerce projects based on Commerce Integration Framework (CIF) for AEM as a Cloud Service follows the same rules and best practices like other AEM projects on AEM as a Cloud Service as well. Please review these first:

Local Development with AEM as a Cloud Service SDK

A local development environment is recommended to work with CIF projects. The CIF Add-On provided for AEM as a Cloud Service is available for local development as well. It can be downloaded from the Software Distribution portal.

The CIF Add-On is provided as a Sling Feature archive. The zip file available on the Software Distribution portal includes two Sling Feature archive files, one for AEM author and one for AEM publish instances.

New to AEM as a Cloud Service? Check out a more detailed guide to setting up a local development environment using the AEM as a Cloud Service SDK.

Required Software

The following should be installed locally:

Accessing the CIF add-on

The CIF add-on can be downloaded as a zip file from the Software Distribution portal. The zip file contains the CIF add-on as Sling Feature archive, it is not an AEM package. Note that access to the SDK listings is limited to those with AEM as a Cloud Service license.

TIP

Make sure you always use the latest CIF Add-On version.

Local Setup

For local CIF Add-on development using the AEM as a Cloud Service SDK following steps:

  1. Get the latest AEM as a Cloud Service SDK

  2. Unpack the AEM .jar to create the crx-quickstart folder, run:

    java -jar <jar name> -unpack
    
  3. Create a crx-quickstart/install folder

  4. Copy the correct Sling Feature archive file of the CIF add-on into the crx-quickstart/install folder.

    The CIF add-on zip file contains two Sling Feature archive .far files. Make sure to use the correct one for AEM Author or AEM Publish, depending on how you plan to run the local AEM as a Cloud Service SDK.

  5. Create a local OS environment variable named COMMERCE_ENDPOINT holding the Magento GraphQL endpoint.

    Example Mac OSX:

    export COMMERCE_ENDPOINT=https://<yourmagentosystem>/graphql
    

    Example Windows:

    set COMMERCE_ENDPOINT=https://<yourmagentosystem>/graphql
    

    This variable is used by AEM to connect to your commerce system. Also, the CIF add-on includes a local reverse proxy make the Commerce GraphQL endpoint available locally. This is used by the CIF authoring tools (product console and pickers) and for the CIF client-side components doing direct GraphQL calls.

    This variable must be set up for the AEM as a Cloud Service environment as well. For more information on variables, see Configuring OSGi for AEM as a Cloud Service.

  6. (Optional) To enable staged catalog features, you must create an integration token for your Magento instance. Please follow the steps at Getting Started to create the token.

    Set an OSGi secret with the name COMMERCE_AUTH_HEADER to the following value:

    Authorization: Bearer <Access Token>
    

    For more information on secrets, see Configuring OSGi for AEM as a Cloud Service.

  7. Start the AEM as a Cloud Service SDK

NOTE

Make sure you start AEM as a Cloud Service SDK in the same terminal window the environment variable was set in step 5. If you start it in a separate terminal window or by double-click the .jar file make sure that the environment variable is visible.

Verify the setup via OSGI console: http://localhost:4502/system/console/osgi-installer. The list should include the CIF add-on related bundles, content-package, and OSGI configurations as defined in the feature model file.

Project Setup

There are two ways to bootstrap your CIF project for AEM as a Cloud Service.

Use AEM Project Archetype

The AEM Project Archetype is the main tool to bootstrap a preconfigured project to get started with CIF. CIF Core Components and all the required configurations can be included in a generated project with one additional option.

TIP

Use AEM Project Archetype 24 or later to generate the project.

See AEM Project Archetype usage instructions on how to generate an AEM project. To include CIF into the project use the includeCommerce option.

For example:

mvn -B archetype:generate \
 -D archetypeGroupId=com.adobe.granite.archetypes \
 -D archetypeArtifactId=aem-project-archetype \
 -D archetypeVersion=24 \
 -D aemVersion=cloud \
 -D appTitle="My Site" \
 -D appId="mysite" \
 -D groupId="com.mysite" \
 -D frontendModule=general \
 -D includeExamples=n \
 -D includeCommerce=y

CIF Core Components can be used in any project by either including the provided all package or individually using the CIF content package and related OSGI bundles. To manually add CIF Core Components to a project use the following dependencies:

<dependency>
    <groupId>com.adobe.commerce.cif</groupId>
    <artifactId>core-cif-components-apps</artifactId>
    <type>zip</type>
    <version>x.y.z</version>
</dependency>
<dependency>
    <groupId>com.adobe.commerce.cif</groupId>
    <artifactId>core-cif-components-config</artifactId>
    <type>zip</type>
    <version>x.y.z</version>
</dependency>
<dependency>
    <groupId>com.adobe.commerce.cif</groupId>
    <artifactId>core-cif-components-core</artifactId>
    <version>x.y.z</version>
</dependency>
<dependency>
    <groupId>com.adobe.commerce.cif</groupId>
    <artifactId>graphql-client</artifactId>
    <version>x.y.z</version>
</dependency>
<dependency>
    <groupId>com.adobe.commerce.cif</groupId>
    <artifactId>magento-graphql</artifactId>
    <version>x.y.z</version>
</dependency>

Use AEM Venia Reference Store

A second option to start a CIF project is to clone and use the AEM Venia Reference Store. The AEM Venia Reference Store is a sample reference storefront application that demonstrates the usage of CIF Core Components for AEM. It is intended as a best-practice set of examples and a potential starting point to develop your own functionality.

To get started with the Venia Reference Store simply clone the Git repository and start customizing the project according to your needs.

NOTE

The Venia Reference Store project contains two build profiles for AEM as a Cloud Service and AEM 6.5. Check the project readme.md to see how they are used.

Additional Resources

On this page