Skip to main content

XTM Connect – Adobe Experience Manager 2.7

Configuring the pom.xml project file (AEMaaCS)

Note

If you are using Adobe Experience Manager 6.5 (AEM 6.5), see Installation (AEM 6.5).

In the AEM as a Cloud Service system, the pom.xml configuration file contains the settings for integrating XTM Connect – AEM. This file configures the development project that contains the Client's instance of XTM Connect – AEM, which runs on the AEM as a Cloud Service system.

Important

The procedure below only refers to projects generated based on the official AEM Project Archetype. For details, see AEM Project Archetype (Adobe Inc. online help).

To configure the pom.xml configuration file in AEM as a Cloud Service:
  1. Ensure that all prerequisites have been met. For details, see the Prerequisites section.

  2. In your AEM as a Cloud Service project, open the root pom.xml file.

  3. In the <properties> section, add a new Maven property that specifies the XTM Connect – AEM version that you want to include in the package. Example:

    ...
    <properties>
      ...
      <xtm.connector.version>X.Y.Z</xtm.connector.version>
      ...
    </properties>
    ...

    Important

    Replace with the correct version of XTM Connect – AEM.

    The naming convention for XTM Connect – AEM versions is: <xtm-version>-CLOUD-<aem-sdk-version> (Example: 2.6.0-CLOUD-2023.8.13323), where:

    • <xtm-version> stands for the XTM Connect – AEM version.

    • <aem-sdk-version> indicates the minimal AEM SDK version that the connector is compatible with.

    To see a list of all released XTM Connect – AEM versions and information about the XTM Cloud and AEM as a Cloud Service versions that they are compatible with, see XTM Connect – Adobe Experience Manager Release Notes.

  4. In the <repositories> section, add an XTM Cloud code repository:

    ...
    <repositories>XTM Connect – AEM<repository>
        <id>xtm-artifactory</id>
          <name>XTM Artifactory</name>
          <url>https://jfrog.aem.xtm-intl.com/artifactory/aem-maven-repository</url>
      </repository>
    </repositories>
    ...
  5. In the <dependencies> section, in a pom.xml file which is located in the "all" submodule project (typically to be found in all/pom.xml, which aggregates all the bundles and sub-packages into one package), set the dependency to XTM Connect – AEM so that Maven downloads it during the build:

    ...
    <dependencies>
      <dependency>
        <groupId>com.xtm.translation.connector</groupId>
        <artifactId>xtm-for-aem.all</artifactId>
        <version>${xtm.connector.version}</version>
        <type>zip</type>
      </dependency>
    </dependencies>
    ...

    Important

    Enter the same property (version value) as you entered in step 3. You might need to adjust it according to your needs.

  6. In the <plugin> section of the same pom.xml file as mentioned in step 5, the content-package-maven-plugin setting is used when a CRX package is assembled. In the same pom.xml file, change this setting so that the package with the XTM Connect – AEM connector is also included in the build:

    ...
    <plugin>
      <groupId>com.day.jcr.vault</groupId>
      <artifactId>content-package-maven-plugin</artifactId>
      <configuration>
        <embeddeds>
          <embedded>
            <groupId>com.xtm.translation.connector</groupId>
            <artifactId>xtm-for-aem.all</artifactId>
            <target>/apps/<APP_NAME>/install</target>
          </embedded>
          ...   
        </embeddeds>
      </configuration>
    </plugin>
    ...

    Important

    Adjust the "target" for your application. Whichever package you add here will be automatically installed in the AEM as a Cloud Service system as well.

    Replace <APP_NAME> with the name of your application. This name is neither "xtm" nor "xtm connect". The target defines where the package with the connector is to be stored in the AEM as a Cloud Service instance. Please note that the same path should be included in the JCR filters so that it is part of your application package. For details, see https://jackrabbit.apache.org/filevault/filter.html.

  7. Now, test the build. For details, see Testing the build (AEMaaCS).