Accueil
Documentation
HCL Commerce est une plateforme de commerce électronique haute disponibilité, hautement évolutive et personnalisable. Capable de prendre en charge des centaines de milliers de transactions par jour, HCL Commerce vous permet de faire des affaires avec les consommateurs (B2C) ou directement avec les entreprises (B2B). HCL Commerce utilise une technologie conviviale pour faciliter et rendre le déploiement et le fonctionnement à la fois faciles et efficaces. Il fournit des outils faciles à utiliser permettant aux professionnels de créer et gérer des campagnes marketing de précision, des promotions, des catalogues et du marchandisage sur tous les canaux de vente, Les professionnels peuvent créer et gérer des campagnes de marketing de précision, des promotions, des catalogues et du merchandising à travers tous les canaux de distribution. Les professionnels peuvent également utiliser des fonctionnalités de gestion de contenu activées par intelligence artificielle (IA).
Référence
Les rubriques de la section Référence contiennent toute la documentation de référence HCL Commerce.
Référence de l'API HCL Commerce
HCL Commerce expose deux API de programmation principales. La première API et l'API la plus récente est une interface REST, et la plupart des nouvelles classes sont exposées ici. L'API Java existante contient également de nouvelles classes qui ne conviennent pas à REST et peuvent être parcourues au format Javadoc.
HCL Commerce API REST
La documentation de L'API REST HCL Commerce contient une liste des ressources fournies par l'API REST HCL Commerce. Chaque ressource REST contient des informations, telles que des URL, des descriptions et des exemples de données d'entrée et de données de sortie.
Annotations de service REST
HCL Commerce Les services REST et services REST de recherche sont annotés afin que vous puissiez visualiser et tester les API avec Swagger, une interface de service REST interactive. L'API Discovery REST génère une liste de ressources REST et d'API en analysant les annotations sur un gestionnaire de ressources. En documentant vos gestionnaires de ressources REST personnalisés avec les mêmes normes d'annotation que les services REST HCL Commerce, vos services REST personnalisés peuvent être consultés et testés avec Swagger.
Activation et désactivation de l'API Discovery REST
Vous pouvez empêcher Swagger d'afficher votre API RESTful dans un navigateur Web, en particulier dans un environnement en production qui sert le trafic en direct. En désactivant l'API Discovery REST, vous pouvez empêcher la récupération et l'affichage de vos services REST dans Swagger. Vous pouvez également activer l'API Discovery REST pour afficher et tester vos services REST avec Swagger.

Documentation
HCL Commerce est une plateforme de commerce électronique haute disponibilité, hautement évolutive et personnalisable. Capable de prendre en charge des centaines de milliers de transactions par jour, HCL Commerce vous permet de faire des affaires avec les consommateurs (B2C) ou directement avec les entreprises (B2B). HCL Commerce utilise une technologie conviviale pour faciliter et rendre le déploiement et le fonctionnement à la fois faciles et efficaces. Il fournit des outils faciles à utiliser permettant aux professionnels de créer et gérer des campagnes marketing de précision, des promotions, des catalogues et du marchandisage sur tous les canaux de vente, Les professionnels peuvent créer et gérer des campagnes de marketing de précision, des promotions, des catalogues et du merchandising à travers tous les canaux de distribution. Les professionnels peuvent également utiliser des fonctionnalités de gestion de contenu activées par intelligence artificielle (IA).
- Mise en route
  HCL Commerce possède différents avantages pour les utilisateurs professionnels, les administrateurs et les développeurs. HCL Commerce cible chacun de ces rôles avec un ensemble personnalisé d'offres, afin que chaque utilisateur puisse en tirer le meilleur parti.
- Installation et déploiement
  Découvrez comment installer et déployer des environnements de production HCL Commerce development environment et HCL Commerce.
- Migration
  Avant d'effectuer une migration vers HCL Commerce Version 9.1, consultez les informations ci-après pour vous aider à planifier et exécuter votre migration.
- Exploitation
  Les sujets de la catégorie Exploitation mettent en évidence les tâches généralement effectuées par les utilisateurs professionnels et les représentants du support client pour effectuer leurs tâches quotidiennes dans le cadre de l'exploitation du site HCL Commerce.
- Intégration
  Les rubriques de la catégorie Intégration mettent en évidence les tâches couramment effectuées pour l'utilisation de HCL Commerce en association avec d'autres produits.
- Administration
  Les rubriques de la catégorie Administration traitent des tâches généralement effectuées par l'administrateur de site pour prendre en charge les opérations quotidiennes du site HCL Commerce.
- Personnalisation
  Les rubriques de la section Personnalisation décrivent les tâches réalisées par un développeur d'applications pour personnaliser HCL Commerce.
- Tutoriels
  HCL Commerce fournit de nombreux tutoriels pour vous aider à personnaliser et à comprendre votre instance et vos magasins HCL Commerce.
- Exemples
  Les sujets de la catégorie Exemples illustrent différents exemples fournis avec HCL Commerce.
- Conformité
  La section suivante décrit comment vous pouvez tirer parti des fonctions et fonctionnalités d'HCL Commerce pour que votre site soit conforme aux différentes normes de sécurité et de protection de la vie privée.
- Sécurisation
  Ces rubriques décrivent les fonctions de sécurité de HCL Commerce et leur mode de configuration.
- Performances
  Les rubriques de la section Performances décrivent les moyens par lesquels vous pouvez planifier, implémenter, tester et revoir l'optimisation des performances du site HCL Commerce.
- Identification des incidents
  Les rubriques de la section Résolution des problèmes mettent en évidence les problèmes courants rencontrés HCL Commerce et comment ils peuvent être traités ou atténués.
- Référence
  Les rubriques de la section Référence contiennent toute la documentation de référence HCL Commerce.
  - Référence de l'API HCL Commerce
    HCL Commerce expose deux API de programmation principales. La première API et l'API la plus récente est une interface REST, et la plupart des nouvelles classes sont exposées ici. L'API Java existante contient également de nouvelles classes qui ne conviennent pas à REST et peuvent être parcourues au format Javadoc.
    - HCL Commerce API REST
      La documentation de L'API REST HCL Commerce contient une liste des ressources fournies par l'API REST HCL Commerce. Chaque ressource REST contient des informations, telles que des URL, des descriptions et des exemples de données d'entrée et de données de sortie.
      - Interface utilisateur swagger
        Une version en direct de l'API REST HCL Commerce est disponible dans un navigateur Web sur votre HCL Commerce Test Server à l'aide de l'interface utilisateur Swagger. Elle est composée d'un ensemble de code HTML, CSS et JavaScript statique qui documente dynamiquement l'API REST disponible sur HCL Commerce Test Server.
      - Affichage de l'API REST à l'aide de Swagger dans les versions antérieures à la version 9.1.6
        Si vous utilisez une version antérieure à la version 9.1.6, vous pouvez accéder à l'interface utilisateur Swagger pour afficher et tester toutes les API RESTful annotées avec les annotations prises en charge.
      - Configuration d'une instance Swagger locale
        Vous pouvez utiliser une instance Swagger locale pour examiner et tester de nouvelles API REST.
      - Test des API REST
        A partir de la version 9.1.6.0, HCL Commerce prend en charge la spécification OpenAPI 3.0. Vous pouvez utiliser la spécification Swagger pour tester les API RESTful documentées dans les fichiers OAS.
      - API REST d'administration
        Vous pouvez utiliser l'API administratif HCL Commerce pour effectuer des tâches administratives afin de gérer votre site. L'API administrative contient une liste de ressources fournies pour la création, la récupération, la modification et la suppression de données pour administrer les fonctions de mondialisation de votre site, les organisations et plus encore.
      - API REST administrative de tarification
        Ces API peuvent être utilisées pour créer et administrer des fonctions de tarification pour un magasin, telles que pour la création et l'administration d'offres, de listes de prix, de règles de tarification, et plus encore.
      - Search - API REST administrative
        Ces API peuvent être utilisées pour créer et administrer des fonctionnalités et des fonctions de recherche, telles que la création de facettes, la définition de zones de recherche, les propriétés des zones, etc.
      - API REST administrative de place de marché
        Ces API peuvent être utilisées pour créer et administrer des ressources de place de marché, y compris des commandes de place de marché et des articles de commande.
      - API REST administrative de magasin
        Ces API peuvent être utilisées pour créer et administrer des magasins, notamment pour définir les langues et les devises des magasins prises en charge, définir les configurations des magasins, activer les fonctions des magasins, etc.
      - API REST administrative système
        Ces API peuvent être utilisées pour créer et administrer des fonctions du système, telles que l'administration des travaux programmés, des transports, des types de messages, des registres, des formats de périphériques, des audits métier, etc.
      - API REST administrative de l'utilisateur et de l'organisation
        Ces API peuvent être utilisées pour créer et administrer des utilisateurs et des organisations pour votre site, vos groupes de membres, vos rôles, vos affectations de rôles, vos stratégies de mot de passe, vos stratégies de contrôle d'accès, et plus encore.
      - API REST de vitrine
        La documentation de l'API REST de vitrine HCL Commerce contient une liste des ressources fournies par l'API REST HCL Commerce pour la récupération, la modification et la suppression de données relatives à un magasin. Chaque ressource REST contient des informations, telles que des URL, des descriptions et des exemples de données d'entrée et de données de sortie.
      - Points d'extension xC
        Vous pouvez utiliser l'API REST pour vous aider à créer votre logique métier personnalisée pour étendre les processus HCL Commerce existants ou pour appeler vos propres processus personnalisés.
      - Mappage des services REST aux services BOD
        Les sections suivantes détaillent comment les noms des méthodes de ressource REST se rapportent à des services BOD spécifiques.
      - Mappage des services REST aux actions de paiement en vitrine
        Le magasin type Aurora utilise les services REST dans le processus de règlement des achats. Les actions pour chaque page correspondent à un service REST.
      - Annotations de service REST
        HCL Commerce Les services REST et services REST de recherche sont annotés afin que vous puissiez visualiser et tester les API avec Swagger, une interface de service REST interactive. L'API Discovery REST génère une liste de ressources REST et d'API en analysant les annotations sur un gestionnaire de ressources. En documentant vos gestionnaires de ressources REST personnalisés avec les mêmes normes d'annotation que les services REST HCL Commerce, vos services REST personnalisés peuvent être consultés et testés avec Swagger.
        Activation et désactivation de l'API Discovery REST
        Vous pouvez empêcher Swagger d'afficher votre API RESTful dans un navigateur Web, en particulier dans un environnement en production qui sert le trafic en direct. En désactivant l'API Discovery REST, vous pouvez empêcher la récupération et l'affichage de vos services REST dans Swagger. Vous pouvez également activer l'API Discovery REST pour afficher et tester vos services REST avec Swagger.
    - API GraphQL HCL Commerce
      GraphQL facilite la construction des API. Le langage de marquage GraphQL est disponible pour n'importe quelle API. Il s'agit d'un interpréteur côté serveur pour le traitement des requêtes à l'aide d'un système de type de données que vous concevez. Avec GraphQL, vos données et votre code sont indépendants de toute base de données ou de tout système de stockage.
    - Java API classes
      You can browse the HCL Commerce Java APIs in Javadoc format.
  - Référence croisée des beans et des tables de données
    Les beans de données sont regroupés en plusieurs groupes de composants.
  - Référence croisée des commandes, des tâches et des tables
    Les commandes d'URL, les commandes de contrôleur, les instructions de tâches, les instructions de visualisation et les tables sont liées les unes aux autres.
  - Référence croisée : Commandes de beans aux tables de base de données
    Utilisez ces informations lorsque vous personnalisez une commande et souhaitez savoir quelles tables sont affectées. Vous devez également utiliser cette rubrique si vous modifiez une table et souhaitez savoir quelles commandes et beans sont affectés.
  - Commandes Run Engine
    Les commandes Run Engine suivantes sont disponibles par défaut pour vous permettre de configurer les applications qui s'exécutent dans les conteneurs.
  - Saisie des conteneurs Docker.
    Pour entrer dans un conteneur Docker, vous pouvez effectuer les étapes suivantes.
  - Logique de démarrage du conteneur Docker pour HCL Commerce Version 9.1
    Lorsque vous déployez un conteneur à partir d'une image fournie par HCL, un script d'assistance Entrypoint.sh détermine les configurations à utiliser lors du démarrage du conteneur. Examinez les informations suivantes pour connaître ce que fait le script d'aide et comment vous pouvez personnaliser les configurations.
  - HCL Commerce schéma de base de données
    Le modèle de base de données HCL Commerce a été conçu pour l'intégrité des données et des performances optimales. HCL Commerce fournit plusieurs centaines de tableaux qui stockent les données d'instance HCL Commerce. Pour maintenir l'intégrité des données et faciliter l'intégrité référentielle de la maintenance, les contraintes sont largement utilisées dans le modèle de base de données. Les index sont utilisés avec soin sur les tableaux pour éviter la surindexation et pour fournir un bon équilibre entre la récupération des données et les activités de manipulation des données (insertion et mise à jour). Les règles métier sont implémentées au niveau de l'application plutôt qu'à l'aide du déclencheur de base de données. Les déclencheurs, cependant, sont utilisés pour faciliter le système de transfert des données et le verrouillage optimiste. Un nombre limité de procédures stockées dans les bases de données SQL sont utilisées pour des activités intensives en données.
  - Sous-système de paiements
    Dans HCL Commerce, le traitement des paiements utilise le sous-système Paiements.
  - Mise en mémoire cache dynamique
    En général, la mise en cache améliore le temps de réponse et réduit la charge du système. Les techniques de mise en cache sont utilisées pour améliorer les performances des applications Internet. La plupart des techniques sont basées sur la mise en cache du contenu statique (contenu qui varie rarement) tel que les fichiers graphique et texte. Cependant, de nombreux sites Web dispensent du contenu dynamique, contenant des informations personnalisées ou des données qui changent plus fréquemment. La mise en mémoire cache du contenu dynamique nécessite des techniques de mise en cache plus sophistiquées, telles que celles fournies par la mémoire cache dynamique WebSphere Application Server, un service intégré pour la mise en cache et la dispense du contenu dynamique.
  - Propriétés des pages de magasin HCL Commerce
  - Eléments d'entrée de cache
    L'élément racine du fichier cachespec.xml, <cache>, contient des éléments <cache-entry>. Le service de cache dynamique WebSphere analyse le fichier cachespec.xml au démarrage et extrait un jeu de paramètres de configuration de chaque élément <cache-entry>.
  - Schéma de fichier de configuration de l'utilitaire de chargement de données
    L'utilitaire de chargement de données contient plusieurs fichiers de configuration. Vous pouvez utiliser le schéma de fichier de configuration pour comprendre et personnaliser les fichiers de configuration de chargement de données.
  - HCL Commerce services web
    HCL Commerce fournit de nombreux services Web.
  - Utilitaires
    Les utilitaires HCL Commerce sont des scripts qui exécutent des opérations telles que le chargement de stratégies de contrôle d'accès, le chargement de données de magasin et le nettoyage de la base de données d'objets obsolètes. Dans les environnements d'exécution, exécutez les utilitaires à partir de Utility server Docker container. Dans l'environnement de développement, exécutez les utilitaires à partir du répertoire bin.
  - Adresse URL de flux d'achats
    HCL Commerce les URL de flux d'achat sont organisées par sous-système.
  - URL du système de messagerie
    Les URL suivantes concernent le système de messagerie.
  - URL du planificateur
    Le sous-système de serveur se compose de fonctions associées aux URL qui sont exécutées par le planificateur.
  - API jQuery Enhancements
    Le magasin type Aurora dans HCL Commerce est entièrement écrit dans jQuery, l'une des bibliothèques JavaScript les plus utilisées dans les sites Web dynamiques. L'API jQuery AJAX et d'événements fournit une infrastructure facile à utiliser qui répond à la plupart des exigences AJAX pour le développement de la vitrine.
  - HCL Commerce bibliothèque de balise constitutive
    La bibliothèque de balises constitutives JSTL HCL Commerce est une collection de balises personnalisées qui vous sont fournies pour prendre en charge la création de fichiers JSP HCL Commerce. Les magasins HCL Commerce utilisent la bibliothèque de balises standard JavaServer Pages (JSTL) pour effectuer la logique, au lieu du code Java. Dans le même temps, la logique d'entreprise est déplacée dans des beans de données. La combinaison de ces étapes permet moins de code Java dans une page JSP.

Activation et désactivation de l'API Discovery REST

Vous pouvez empêcher Swagger d'afficher votre API RESTful dans un navigateur Web, en particulier dans un environnement en production qui sert le trafic en direct. En désactivant l'API Discovery REST, vous pouvez empêcher la récupération et l'affichage de vos services REST dans Swagger. Vous pouvez également activer l'API Discovery REST pour afficher et tester vos services REST avec Swagger.

Pourquoi et quand exécuter cette tâche

La disponibilité de l'API Discovery REST est contrôlée par la propriété ApiDiscoveryEnabled. Vous pouvez modifier cette propriété dans le fichier wc-component.xml du composant foundation. Pour plus d'informations sur la mise à jour des fichiers wc-component.xml, voir Modification des propriétés de configuration REST dans le fichier de configuration du composant (wc-component.xml).

Notes :

L'élément ApiDiscoveryEnabled est défini sur true (activé) dans les environnements HCL Commerce Developer par défaut.
Dans les environnements d'exécution, l'élément ApiDiscoveryEnabled est défini sur false (désactivé) par défaut.

Lorsque vous mettez à jour votre version du fichier wc-component.xml, assurez-vous d'inclure la propriété ApiDiscoveryEnabled et définissez la valeur sur true ou false. Par exemple, le fragment de code suivant définit la valeur de la propriété sur false, ce qui désactive l'API Discovery REST :

<!-- Determines if the REST API Discovery should be enabled. -->
    <_config:property name="ApiDiscoveryEnabled" value="false"/>

Lorsque l'API Discovery est définie sur false, un utilisateur peut toujours accéder à Swagger dans un navigateur Web, mais aucune API REST n'est affichée.

Que faire ensuite

Affichage de l'API REST à l'aide de Swagger dans les versions antérieures à la version 9.1.6.