AEM Translation Framework Bootstrap Connector

The Bootstrap connector is built using the Translation Framework API. The purpose of the connector is to

• Provide sample code to Translation partners and Service providers to start building their connector
• Provide best practices for building/packaging the connector
• Highlight the coding standards for the Connector certification process
• Serve as a reference implementation of the Translation API

Modules

The main parts of the template are:

• core: Java bundle containing all core functionality like OSGi service as well as component-related Java code.
• ui.apps: contains the /apps (immutable content) parts of the project, components, templates, configurations.
• ui.content: contains the /content (mutable content) parts of the project.

Accessing the AEM Cloud Service SDK

The Java Jar/Maven Dependency that exposes all allowed Java APIs that can be used to develop against AEM as as Cloud Service.

<dependency>
  <groupId>com.adobe.aem</groupId>
  <artifactId>aem-sdk-api</artifactId>
  <version>2020.7.3902.20200716T022312Z-200604</version>
  <scope>provided</scope>
</dependency>

It is recommended that the version entry for the SDK should match the version of AEM as a Cloud Service. You can see what version you are using by logging in to AEM, then going to the question mark in the top right corner of the screen and selecting About Adobe Experience Manager

Please have a look on the document to see when is it recommended to refresh the project with a new SDK.

https://docs.adobe.com/content/help/en/experience-manager-cloud-service/implementing/developing/aem-as-a-cloud-service-sdk.html

How to build

Switch to the designated branch based on the AEM version. For instance, checkout the "aem650" branch for AEM 6.5 and for AEM as a Cloud Service, opt for the "master" branch.

To build all the modules run in the project root directory the following command with Maven 3:

mvn clean install

If you have a running AEM instance you can build and package the whole project and deploy into AEM with

mvn clean install -PautoInstallPackage

Or to deploy it to a publish instance, run

mvn clean install -PautoInstallPackagePublish

Or alternatively

mvn clean install -PautoInstallPackage -Daem.port=4503

Or to deploy only the bundle to the author, run

mvn clean install -PautoInstallBundle

Additional Details

For detailed information visit:

Overview of Translation Framework

Bootstrap connector Installation steps

State diagram showing different states of translation as noted in the API