Développement d’AEM Commerce pour AEM as a Cloud Service

Le développement de projets AEM Commerce basés sur Commerce Integration Framework (CIF) pour AEM as a Cloud Service suit les mêmes règles et bonnes pratiques que les autres projets AEM dans AEM as a Cloud Service. Veuillez d’abord examiner les éléments suivants :

Développement local avec le SDK AEM as a Cloud Service

Un environnement de développement local est recommandé pour travailler avec des projets CIF. Le module complémentaire CIF fourni pour AEM as a Cloud Service est également disponible pour le développement local. Il peut être téléchargé à partir du portail de distribution de logiciels.

Le module complémentaire est fourni sous la forme d’une archive de fonctionnalités Sling. Le fichier zip disponible sur le portail de distribution de logiciels comprend deux fichiers archivés de fonctionnalités Sling, l’un pour l’auteur AEM et l’autre pour les instances de publication AEM.

Vous découvrez AEM as a Cloud Service ? Consultez un guide plus détaillé de configuration d’environnement de développement local à l’aide du SDK AEM as a Cloud Service.

Logiciels requis

Les logiciels suivants doivent être installés localement :

Accès au module complémentaire CIF

Il est possible de télécharger le module complémentaire CIF en tant que fichier zip à partir du portail de distribution de logiciels. Le fichier zip contient le module complémentaire CIF sous la forme d’une archive de fonctionnalités Sling ; il ne s’agit pas d’un module AEM. Notez que l’accès aux listes de SDK est limité aux environnements disposant d’une licence AEM as a Cloud Service.

CONSEIL

Veillez à toujours utiliser la dernière version du module complémentaire CIF.

Configuration locale

Pour le développement local du module complémentaire CIF avec le SDK AEM as a Cloud Service, procédez comme suit :

  1. Procurez-vous le dernier SDK AEM as a Cloud Service.

  2. Décompressez le fichier AEM .jar pour créer le dossier crx-quickstart et exécutez :

    java -jar <jar name> -unpack
    
  3. Créez un dossier crx-quickstart/install.

  4. Copiez le fichier archivé de fonctionnalités Sling correct du module complémentaire CIF dans le dossier crx-quickstart/install.

    Le fichier zip du module complémentaire CIF contient deux fichiers .far archivés de fonctionnalités Sling. Assurez-vous d’utiliser le fichier correspondant à AEM Author ou à AEM Publish, selon la manière dont vous envisagez d’exécuter le SDK AEM as a Cloud Service local.

  5. Créez une variable d’environnement de système d’exploitation locale nommée COMMERCE_ENDPOINT et contenant le point d’entrée Magento GraphQL.

    Exemple pour Mac OSX :

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

    Exemple pour Windows :

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

    Cette variable est utilisée par AEM pour se connecter à votre système commercial. De plus, le module complémentaire CIF inclut un proxy inverse local pour rendre le point d’entrée GraphQL Commerce disponible localement. Il est utilisé par les outils de création CIF (console de produit et sélecteurs) et pour les composants CIF côté client effectuant des appels GraphQL directs.

    Cette variable doit également être configurée pour l’environnement AEM as a Cloud Service. Pour plus d’informations sur les variables, voir Configuration d’OSGi pour AEM as a Cloud Service.

  6. (Facultatif) Pour activer les fonctionnalités de catalogue par étapes, vous devez créer un jeton d’intégration pour votre instance de Magento. Suivez les étapes décrites dans Prise en main pour créer le jeton.

    Définissez un secret OSGi portant le nom COMMERCE_AUTH_HEADER sur la valeur suivante :

    Authorization: Bearer <Access Token>
    

    Pour plus d’informations sur les secrets, voir Configuration d’OSGi pour AEM as a Cloud Service.

  7. Démarrez le SDK AEM as a Cloud Service.

REMARQUE

Veillez à démarrer le SDK AEM as a Cloud Service dans la même fenêtre de terminal selon la variable d’environnement définie à l’étape 5. Si vous le lancez dans une fenêtre de terminal distincte ou que vous double-cliquez sur le fichier .jar, assurez-vous que la variable d’environnement est visible.

Vérifiez la configuration via la console OSGI : http://localhost:4502/system/console/osgi-installer. La liste doit inclure les bundles liés au module complémentaire CIF, le module de contenu et les configurations OSGI, comme défini dans le fichier de modèle de fonctionnalité.

Configuration du projet

Il existe deux manières de démarrer votre projet CIF pour AEM as a Cloud Service.

Utilisation de l’archétype de projet AEM

L’archétype de projet AEM est le principal outil utilisé pour démarrer un projet préconfiguré afin de démarrer avec CIF. Les composants principaux CIF et toutes les configurations requises peuvent être inclus dans un projet généré avec une option supplémentaire.

CONSEIL

Utilisez la version 24 ou ultérieure de l’archétype de projet AEM pour générer le projet.

Reportez-vous aux instructions d’utilisation de l’archétype de projet AEM pour savoir comment générer un projet AEM. Pour inclure CIF dans le projet, utilisez l’option includeCommerce.

Par exemple :

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

Les composants principaux CIF peuvent être utilisés dans n’importe quel projet en incluant le module all fourni ou individuellement en utilisant le module de contenu CIF et les bundles OSGI associés. Pour ajouter manuellement des composants principaux CIF à un projet, utilisez les dépendances suivantes :

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

Utilisation du magasin de référence Venia AEM

Une deuxième manière de démarrer un projet CIF consiste à cloner et à utiliser le magasin de référence Venia AEM. Le magasin de référence Venia AEM est un exemple d’application storefront de référence qui illustre l’utilisation des composants principaux CIF pour AEM. Cette application offre des exemples de bonnes pratiques, ainsi qu’un point de départ potentiel pour développer vos propres fonctionnalités.

Pour commencer à utiliser le magasin de référence Venia AEM, il vous suffit de cloner le référentiel Git et de personnaliser le projet en fonction de vos besoins.

REMARQUE

Le projet de magasin de référence Venia contient deux profils de version pour AEM as a Cloud Service et AEM 6.5. Reportez-vous au fichier readme.md du projet pour savoir comment ces profils sont utilisés.

Ressources supplémentaires

Sur cette page