Démarrage du Transaction server Docker container via l'extraction des paramètres à partir de Vault

Découvrez comment démarrer le Transaction server Docker container en spécifiant CONFIGURE_MODE=Vault.

Variables d'environnement obligatoires

Il s'agit des variables d'environnement obligatoires que vous devez spécifier pour configurer le Transaction server Docker container afin de récupérer des paramètres supplémentaires de Vault.

Note:
  • Vous pouvez également spécifier les données d'identification de la source de données via la commande de démarrage si vous ne souhaitez pas récupérer les valeurs de la source de données à partir de Vault.
  • Le script /SETUP/bin/vaultConfigure.sh récupère les valeurs de Vault.
Nom de variable d'environnement Description Commentaires
TENANT Nom du groupe contenant votre ensemble d'environnements. Par exemple, MonEntreprise. Variable d'environnement du conteneur. Elle peut être spécifiée dans le fichier de configuration values.yaml sous common.tenant.
ENVIRONMENT Nom de l'environnement. Par exemple, Non-production. Variable d'environnement du conteneur. Elle peut être spécifiée dans le fichier de configuration values.yaml sous common.environmentName.
ENVTYPE Le type d'environnement. Les valeurs acceptées sont auth et live. Variable d'environnement du conteneur. Elle peut être spécifiée dans le fichier de configuration values.yaml sous common.environmentType.
VAULT_TOKEN Jeton Vault à utiliser pour se connecter à Vault et demander une certification à partir de l'infrastructure à clé publique Vault. Variable d'environnement du conteneur. Elle peut être spécifiée dans le fichier de configuration values.yaml sous common.vaultToken.
VAULT_URL URL de Vault à utiliser pour se connecter à Vault et demander la certification à Vault PKI. Variable d'environnement du conteneur. Elle peut être spécifiée dans le fichier de configuration values.yaml sous common.vaultUrl.
CONFIGURE_MODE Mode configuration.
Les valeurs acceptées sont :
  • Vault pour la configuration de Vault.
  • EnvVariables pour la configuration des variables d'environnement.
Définissez cette valeur sur Vault pour utiliser la configuration Vault et les configurations présentes dans cette référence.
 Variable d'environnement du conteneur. Elle peut être spécifiée dans le fichier de configuration values.yaml sous common.configureMode.
ELASTICSEARCH_ENABLED Spécifiez si la solution de recherche basée sur Elasticsearch est utilisée pour l'environnement déployé.
Les valeurs admises sont :
  • true pour la solution de recherche basée sur Elasticsearch.
  • false pour la solution de recherche basée sur Solr.
La valeur par défaut est true.
 Variable d'environnement du conteneur. Elle peut être spécifiée dans le fichier values.yaml sous common.searchEngine.
Note:
  • Lorsque la valeur de searchEngine est définie sur elastic, la variable d'environnement ELASTICSEARCH_ENABLED est définie sur true.
  • Lorsque la valeur de searchEngine est définie sur solr, la variable d'environnement ELASTICSEARCH_ENABLED est définie sur false.
La valeur par défaut est elastic.

Variables d'environnement facultatives

Il s'agit des variables d'environnement facultatives que vous pouvez spécifier pour configurer le Transaction server Docker container.

Tous les paramètres que vous spécifiez en tant que variables d'environnement de conteneur ont la priorité par rapport aux valeurs stockées dans Vault.

Nom de variable d'environnement Description Commentaires
EXPOSE_METRICS Spécifiez si vous souhaitez activer les métriques pour l'environnement.
Les valeurs acceptées sont :
  • true pour activé.
  • false pour désactivé.
La valeur par défaut est définie sur true.
 Variable d'environnement du conteneur. Elle peut être spécifiée dans le fichier de configuration values.yaml sous metrics.enabled.
HCL Commerce Version 9.1.9.0 or laterLDAP_ENABLE Spécifiez si vous souhaitez activer LDAP pour l'environnement.
Les valeurs acceptées sont :
  • true pour activé.
  • false pour désactivé.
La valeur par défaut est définie sur false.
 Variable d'environnement du conteneur. Elle peut être spécifiée dans le fichier de configuration values.yaml sous :
  • ldap.auth.enabled
  • ldap.live.enabled
HCL Commerce Version 9.1.9.0 or laterLDAP_USE_VMM_PROPERTIES_FILE Spécifiez que s'il est activé, le protocole LDAP doit être configuré à l'aide du fichier vmm.properties.
Pour plus d'informations, selon votre type de déploiement, voir :
 Variable d'environnement du conteneur. Elle peut être spécifiée dans le fichier de configuration values.yaml sous :
  • ldap.auth.useVmmPropertiesFile
  • ldap.live.useVmmPropertiesFile
.
LOCALSTOREWEB Nom d'hôte du serveur Web d'un magasin local si vous avez procédé à une migration depuis IBM Websphere Commerce Version 7 ou IBM Websphere Commerce Version 8.
Note: Il est obligatoire si vous utilisez un magasin local migré.
 Variable d'environnement du conteneur.

Elle peut être spécifiée dans le fichier de configuration values.yaml sous : common.localStoreEnabled.
HCL Commerce Version 9.1.13.0 or laterTX_QUICK_START Une méthode pour améliorer la vitesse de démarrage du Transaction server. Cette option vous permet d'exécuter toutes les commandes Run Engine d'administration de WebSphere Application Server en parallèle, plutôt que séquentiellement.
Les options disponibles sont :
  • true pour activer le traitement parallèle des commandes Run Engine.
  • false pour désactiver le traitement parallèle des commandes Run Engine.
La valeur par défaut est false.
 Variable d'environnement du conteneur. Elle peut être spécifiée dans values.yaml sous tsApp.quickStart.enabled. La valeur par défaut est false.

Variables de configuration Vault obligatoires

Il s'agit des valeurs de clé Vault obligatoires que vous devez spécifier dans Vault pour configurer le Transaction server Docker container de manière à utiliser le mode de configuration Vault.

Chemin Vault Description Variable d'environnement de référence
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/merchantKeyEncrypted Clé de commerçant chiffrée à l'aide de la clé de chiffrement de clé. Clé de marchand créée lorsque vous ou un administrateur avez chargé le schéma de base de données HCL Commerce.
Pour plus d'informations, voir :
Important: Vous devez spécifier vos propres valeurs de clé de commerçant et de clé de chiffrement de clé pour la sécurité de votre installation HCL Commerce. N'utilisez pas les valeurs par défaut contenues dans les exemples de fichier de configuration et les exemples de documentation fournis.
 MERCHANTKEY_ENCRYPT
HCL Commerce Version 9.1.9.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/keyEncryptionKey La clé en texte brut utilisée pour chiffrer la clé de commerçant. La clé de chiffrement de clé doit comporter 32 caractères. KEY_ENCRYPTION_KEY
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/sessionKeyEncrypt
HCL Commerce Version 9.1.12.0 or laterNote: Désormais obligatoire, cette valeur était facultative avant HCL Commerce 9.1.12.0.
 Clé de session chiffrée à l'aide de la clé de chiffrement de clé. Clé de session créée lorsque vous ou un administrateur avez chargé le schéma de base de données HCL Commerce.
Important: Vous devez spécifier vos propres valeurs de clé de commerçant et de clé de chiffrement de clé pour la sécurité de votre installation HCL Commerce. N'utilisez pas les valeurs par défaut contenues dans les exemples de fichier de configuration et les exemples de documentation fournis.
 SESSION_KEY_ENCRYPT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/authJWKS Spécifiez une valeur pour définir le jeu de clés Web JSON (JWKS) et la clé ID sur le Transaction server. Elle est utilisée pour signer et valider le jeton Web JSON (JWT).

Pour générer un JWKS, voir Utilitaire generateJWKS.

 JWKS
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/spiUserName
HCL Commerce Version 9.1.7.0 or laterNote: Cette valeur est facultative à partir de HCL Commerce 9.1.7.0.
 Nom d'utilisateur de spiuser.

HCL Commerce Version 9.1.7.0 or laterSi la valeur n'est pas définie, alors spiuser est utilisé.

 SPIUSER_NAME
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/spiUserPwd Mot de passe de l'utilisateur spiuser chiffré ASCII.

Pour définir le mot de passe dans vos conteneurs Docker personnalisés, voir Définition du mot de passe spiuser dans vos images Docker.

 SPIUSER_PWD
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbHost Nom d'hôte de la base de données pour l'environnement.
Note: Cette valeur n'est obligatoire que dans l'environnement d'authentification pour WCPublishDataSource.
 DBHOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbPort Numéro de port de la base de données.
Note: Cette valeur n'est obligatoire que dans l'environnement d'authentification pour WCPublishDataSource.
 DBPORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbName Nom de la base de données.
Note: Cette valeur n'est obligatoire que dans l'environnement d'authentification pour WCPublishDataSource.
 DBNAME
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbUser Nom d'utilisateur de la base de données HCL Commerce.
Note: Cette valeur n'est obligatoire que dans l'environnement d'authentification pour WCPublishDataSource.
 DBUSER
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbPassword Mot de passe utilisateur de la base de données de HCL Commerce.
Note: Cette valeur n'est obligatoire que dans l'environnement d'authentification pour WCPublishDataSource.
 DBPASS
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbaUser Nom d'utilisateur administrateur de base de données. DBAUSER
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbaPassEncrypt Mot de passe de l'administrateur de base de données chiffré. DBAPASSENCRYPT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/elasticSearchEnabled Spécifiez si l'environnement utilise la recherche basée sur Elasticsearch ou la recherche basée sur Solr.
Valeurs admises :
  • true pour la recherche basée sur Elasticsearch.
  • false pour la recherche basée sur Solr.
 ELASTICSEARCH_ENABLED

Variables de configuration Vault facultatives

Il s'agit des valeurs de clé Vault facultatives que vous pouvez spécifier dans Vault pour configurer le Transaction server Docker container lors d'une utilisation avec le mode de configuration Vault.

Chemin Vault Description Variable d'environnement de référence
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbSSLEnable Indiquez si la connexion de base de données utilise SSL.
Valeurs admises :
  • true pour une connexion SSL.
  • false pour une connexion non chiffrée.
La valeur par défaut est false.
Note: Vous pouvez également spécifier les données d'identification de la source de données via la commande de démarrage si vous ne souhaitez pas récupérer les valeurs de la source de données à partir de Vault.
 DB_SSLENABLE
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbXA Spécifiez si la fonction XA est activée pour la base de données.
Valeurs admises :
  • true pour activé.
  • false pour désactivé.
La valeur par défaut est false.
Note: Vous pouvez également spécifier les données d'identification de la source de données via la commande de démarrage si vous ne souhaitez pas récupérer les valeurs de la source de données à partir de Vault.
 DB_XA
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbType Type de base de données.
Les valeurs admises sont :
  • db2 pour IBM Db2 Database.
  • oracle pour Oracle Database.
La valeur par défaut est db2.
 DBTYPE
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/kafkaServers Spécifiez une valeur si vous souhaitez activer ZooKeeper et Kafka.
Le format de cette paire clé-valeur est :
"kafkaServers": server1:port1,server1:port2
 KAFKA_SERVERS
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/kafkaTopicPrefix Spécifiez une valeur si vous souhaitez configurer ZooKeeper et Kafka. Si aucune valeur n'est spécifiée, la valeur par défaut suivante est appliquée :

${TENANT}${ENVIRONMENT}${ENVTYPE}

 KAFKA_TOPIC_PREFIX
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/kafkaAuthenticationUserId ID utilisateur pour l'authentification Kafka. KAFKA_AUTHENTICATION_USERID
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/kafkaAuthenticationPassword Mot de passe de l'utilisateur pour l'authentification Kafka. KAFKA_AUTHENTICATION_PASSWORD
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/traceSpecification/ts-app Si vous souhaitez modifier la spécification de trace pour Transaction server, spécifiez une valeur. TRACE_SPEC
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/healthCenterEnable/ts-app Indiquez une valeur si vous souhaitez activer le Centre de santé.
Valeurs admises :
  • true pour activer le Centre de santé.
  • false pour ne pas activer le Centre De centre.
La valeur par défaut est false.
 HEALTH_CENTER_ENABLED
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/zooKeeperServers Spécifiez une valeur si vous souhaitez activer ZooKeeper et Kafka.
Le format de cette paire clé-valeur est :
"zooKeeperServers": server1:port1,server2:port2
 ZOOKEEPER_SERVERS
HCL Commerce Version 9.1.6.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/enableJsonLogging Activez la journalisation JSON.
Les valeurs acceptées sont
  • true pour activer la journalisation JSON.
  • false pour désactiver la journalisation JSON.

La valeur par défaut est false.

 ENABLE_JSON_LOGGING
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/jdbcMonitorEnable/ts-app Spécifiez s'il faut ou non activer le moniteur JDBC.
Valeurs admises :
  • true pour activer le moniteur JDBC.
  • false pour désactiver le moniteur JDBC.

La valeur par défaut est false.

 JDBC_MONITOR_ENABLED
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/domainName Spécifiez le nom de domaine du service interne. Si l'environnement déployé se trouve sur un espace de noms spécial sur Kubernetes, alors le nom de domaine doit être .svc.cluster.local. Si aucune valeur n'est spécifiée, la valeur par défaut est utilisée.

default.svc.cluster.local

 DOMAIN_NAME
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/externalDomainName Cette valeur spécifie le nom de domaine externe Web du magasin, qui peut être reconnu par votre navigateur.

Par exemple, dans le nom d'hôte store.demo4qaauth.hcl.com, hcl.com est le nom de domaine externe.

 EXTERNAL_DOMAIN_NAME
HCL Commerce Version 9.1.13.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/storeDomainMapping Cette valeur spécifie le mappage du nom de magasin vers le nom de domaine. L'utilisation de cette valeur permet de mapper un magasin vers plusieurs noms de domaine.

Le format utilisé est : sitename=domainname;sitename=domainname; ...

Par exemple, AuroraESite=www.mycompany.com;AuroraESite=www.mycompany1.com;AuroraB2BESite=www.mycompany.b2b.com;

 STORE_DOMAIN_MAPPING
HCL Commerce Version 9.1.13.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/autoOrderCommentEventListenerEnabled Activez ou désactivez le programme d'écoute d'événement de commentaire de commande automatique.

Par défaut, cette valeur est définie sur false.

 AUTO_ORDER_COMMENT_EVENT_LISTENER_ENABLED
HCL Commerce Version 9.1.13.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/useSemiColonForMarketplaceCSVDelimiter Activez ou désactivez l'utilisation d'un point-virgule ";" comme délimiteur de fichier CSV de la place de marché.

Par défaut, cette valeur est définie sur false.

 USE_SEMICOLON_FOR_MARKETPLACE_CSV_DELIMITER
HCL Commerce Version 9.1.13.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/inventoryShowActualQuantity Dans un système de stock non-ATP avec le paramètre noCheck défini pour un stock catentry (valeur de 2 dans la base de données), l'API renvoie 1.0 comme quantité.

Pour afficher la quantité réelle, définissez cette valeur sur true.

Par défaut, cette valeur est définie sur false.

 INVENTORY_SHOW_ACTUAL_QUANTITY
HCL Commerce Version 9.1.13.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/allowedHost Indiquez des noms d'hôte sur liste blanche pour un nom de module associé. Les noms d'hôte sont délimités par une virgule, tandis que les modules sont délimités par un point-virgule.

Stores:host1.domain.com,host2.domain.com;LoBTools:host3.domain2.com,host4.domain2.com

 ALLOWED_HOST
HCL Commerce Version 9.1.13.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/allowedDomain Indiquez des noms de domaine sur liste blanche pour un nom de module associé. Les noms de domaine sont délimités par une virgule, tandis que les modules sont délimités par un point-virgule.

Stores:domain1.com,domain2.com;LoBTools:domain3.com,domain4.com

 ALLOWED_DOMAIN
HCL Commerce Version 9.1.12.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/approvalBaseUrl URL de base de Approval server utilisée par le Tooling Web Docker container.

Format de l'URL de base d'approbation https://cmc-domain:port

Par exemple, https://cmc.mycompanyauth.com:443.

Si cette valeur n'est pas spécifiée, l'URL de base de Approval server est obtenue à partir de la racine de Tooling, c'est-à-dire tous les caractères avant la première barre oblique.

 APPROVAL_BASE_URL
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/toolingBaseUrl Cette valeur est utilisée par Management Center pour charger l'application d'outils à page unique (SPA) à partir du serveur Web d'outils.

https://tooling-web-host:port/path-to-tooling-spa

HCL Commerce Version 9.1.3.0 or laterNote: Si vous utilisez le magasin sans tête Sapphire B2B et que vous devez lancer les outils en magasin pour approbation, il est nécessaire de configurer l'entrée afin que le serveur Web d'outils puisse être atteint via le domaine du magasin. Par exemple, www.mycompany.com/tooling.

Une fois l'entrée activée, vous devez configurer toolingBaseUrl pour utiliser le domaine de magasin.

 TOOLING_BASE_URL
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/xcHost Spécifiez une valeur si vous souhaitez définir un nom d'hôte pour le Customization server, au lieu d'utiliser la valeur par défaut. XC_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/xcPort Spécifiez une valeur si vous souhaitez définir un numéro de port pour le Customization server, au lieu d'utiliser la valeur par défaut. XC_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/previewPort Spécifiez une valeur si vous souhaitez définir previewPort, au lieu d'utiliser la valeur par défaut.

La valeur par défaut est 443.

 PREVIEW_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/storeHost Spécifiez une valeur si vous souhaitez en définir une pour l'hôte de magasin Store server Commerce Remote Store (CRS), au lieu d'utiliser la valeur par défaut.

La valeur par défaut est le nom du service crs-app.

 STORE_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/storePort Spécifiez une valeur si vous souhaitez en définir une pour le port de magasin Store server Commerce Remote Store (CRS), au lieu d'utiliser la valeur par défaut.

La valeur par défaut est 8443.

 STORE_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/storeWebHost Spécifiez une valeur si vous souhaitez définir storeWebHost, au lieu d'utiliser la valeur par défaut.

La valeur par défaut est store.${TENANT}${ENVIRONMENT}${ENVTYPE}${EXTERNAL_DOMAIN_NAME}.

 STOREWEB_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/storeWebPort Spécifiez une valeur si vous souhaitez définir storeWebPort, au lieu d'utiliser la valeur par défaut.

La valeur par défaut est 443.

 STOREWEB_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/reactStoreWebHost Spécifiez une valeur si vous souhaitez définir reactStoreHost, au lieu d'utiliser la valeur par défaut.

La valeur par défaut est www.${TENANT}${ENVIRONMENT}${ENVTYPE}${EXTERNAL_DOMAIN_NAME}.

 REACT_STORE_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/reactStoreWebPort Spécifiez une valeur si vous souhaitez définir reactStorePort, au lieu d'utiliser la valeur par défaut.

La valeur par défaut est 443.

 REACT_STORE_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/reactStorePreviewHost Spécifiez une valeur si vous souhaitez définir reactStorePreviewHost, au lieu d'utiliser la valeur par défaut.

La valeur par défaut est store-preview.${TENANT}${ENVIRONMENT}${ENVTYPE}${EXTERNAL_DOMAIN_NAME.

 REACT_STORE_PREVIEW_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/reactStorePreviewPort Spécifiez une valeur si vous souhaitez définir reactStorePreviewPort, au lieu d'utiliser la valeur par défaut.

La valeur par défaut est 443.

 REACT_STORE_PREVIEW_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/reactStoreServiceHost Spécifiez une valeur si vous souhaitez définir reactStoreServiceHost, au lieu d'utiliser la valeur par défaut. REACT_STORE_SERVICE_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/reactStoreServicePort Spécifiez une valeur si vous souhaitez définir reactStoreServicePort, au lieu d'utiliser la valeur par défaut.

La valeur par défaut est 443.

 REACT_STORE_SERVICE_PORT
HCL Commerce Version 9.1.4.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dxHost Les noms d'hôte pour les instances auth ou live de HCL Digital Experience (DX). Ils sont requis pour l'intégration de HCL Commerce à DX.
Note:
  • Cette intégration n'est prise en charge que sur un déploiement Kubernetes.
  • Si vous avez suivi les instructions de passage dans le nom de domaine du magasin HCL Commerce pour la valeur de remplacement d'hôte lors du déploiement de DX, HCL Digital Experience partagera alors le même nom de domaine que le magasin HCL Commerce. Pour plus d'informations, voir Intégration de HCL Digital Experience avec HCL Commerce.
 DX_HOST
HCL Commerce Version 9.1.4.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dxPort Numéro de port de l'instance HCL Digital Experience (DX) auth ou live. La valeur par défaut est définie sur 443 si le nom d'hôte DX a été spécifié et si aucune valeur personnalisée n'est spécifiée. DX_PORT
HCL Commerce Version 9.1.4.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dxScheme Schéma pour l'instance HCL Digital Experience (DX) auth ou live. La valeur par défaut est définie sur https si le nom d'hôte DX a été spécifié et si aucune valeur personnalisée n'est spécifiée. DX_SCHEME
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/marketingEventListenerEnabled Activez le programme d'écoute d’événements marketing.
Valeurs admises :
  • true pour activer le programme d'écoute.
  • false pour désactiver le programme d'écoute.

La valeur par défaut est false.

 MARKETING_EVENT_LISTENER_ENABLED
HCL Commerce Version 9.1.12.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/ssoEnable Indiquez si la connexion unique (SSO) doit être activée ou désactivée.
Valeurs admises :
  • true pour l'activation de la connexion unique (SSO).
  • false pour la désactivation de la connexion unique.

La valeur par défaut est false.

Pour plus d'informations, voir Activation de la connexion unique.

 SSO_ENABLE
HCL Commerce Version 9.1.12.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/ssoDomain Indiquez le nom de domaine qui contient un ensemble d'hôtes auquel s'applique la connexion unique.
Valeurs admises :
  • true pour l'activation de la connexion unique (SSO).
  • false pour la désactivation de la connexion unique.

La valeur par défaut est false.

Cette valeur de clé doit être définie si ssoEnable est défini sur true.

Pour plus d'informations, voir Activation de la connexion unique.

 SSO_DOMAIN_NAME
HCL Commerce Version 9.1.12.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/ssoSSL Indiquez si une connexion SSL est utilisée pour les requêtes de connexion unique.
Valeurs admises :
  • true pour activer SSL pour les requêtes de connexion unique.
  • false pour désactiver SSL pour les requêtes de connexion unique.

Cette valeur de clé doit être définie si ssoEnable est défini sur true.

Pour plus d'informations, voir Activation de la connexion unique.

 SSO_SSL
HCL Commerce Version 9.1.12.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/ssoKeepAliveSession Indiquez si vous souhaitez activer ou désactiver la fonction de connexion unique (SSO) keepAliveSession sur le Transaction server.
Valeurs admises :
  • true pour activer le paramètre keepAliveSession.
  • false pour désactiver le paramètre keepAliveSession.

La valeur par défaut est false.

Pour plus d'informations, voir Activation de la connexion unique.

 SSO_KEEP_ALIVE_SESSION
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/searchMasterHost
Note: Obligatoire lors de l'utilisation de la solution de recherche basée sur Solr (ELASTICSEARCH_ENABLED est défini sur false).
 Nom d'hôte du Search server.
Note: Ce paramètre n'est requis qu'avec l'environnement d'authentification de la solution de recherche basée sur Solr. La valeur par défaut correspond au nom du service principal de recherche solr.
 SEARCH_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/searchSlaveHost
Note: Obligatoire lors de l'utilisation de la solution de recherche basée sur Solr (ELASTICSEARCH_ENABLED est défini sur false).
 Nom d'hôte du Search server.
Note: Ce paramètre doit uniquement être défini dans l’environnement opérationnel. La valeur par défaut correspond au nom du service esclave de recherche solr.
 SEARCH_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/searchSlaveRepeater
Note: Obligatoire lors de l'utilisation de la solution de recherche basée sur Solr (ELASTICSEARCH_ENABLED est défini sur false).
 Nom d'hôte du Search server.
Note: Ce paramètre doit uniquement être défini dans l’environnement opérationnel. La valeur par défaut correspond au nom du service de répéteur de recherche Solr.
 SEARCH_REPEATER_HOST
HCL Commerce Version 9.1.12.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/queryHost Nom d'hôte du Search server pour la solution de recherche basée sur Elasticsearch. Spécifiez une valeur si vous souhaitez définir queryHost, au lieu d'utiliser la valeur par défaut. SEARCH_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/queryHost
Deprecated featureNote: Obsolète dans HCL Commerce 9.1.12.0. Use ${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/queryHost.
 Spécifiez une valeur si vous souhaitez définir une valeur queryHost, au lieu d'utiliser la valeur par défaut.
Note: Cette paire de clés a été remplacée par queryHost à partir de HCL Commerce 9.1.12.0 et dans toutes les versions ultérieures.
 SEARCH_HOST
HCL Commerce Version 9.1.12.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/queryPort Numéro de port du Search server pour la solution de recherche basée sur Elasticsearch. Spécifiez une valeur si vous souhaitez définir queryPort, au lieu d'utiliser la valeur par défaut.

La valeur par défaut est 30901.

 SEARCH_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/queryPort
Deprecated featureNote: Obsolète dans HCL Commerce 9.1.12.0. Utilisez ${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/queryPort.
 Spécifiez une valeur si vous souhaitez définir une valeur queryPort, au lieu d'utiliser la valeur par défaut.
Note: Cette paire de clés a été remplacée par queryPort à partir de HCL Commerce 9.1.12.0 et dans toutes les versions ultérieures.
 SEARCH_PORT
HCL Commerce Version 9.1.12.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/queryScheme Système du Search server pour la solution de recherche basée sur Elasticsearch. Spécifiez une valeur si vous souhaitez définir queryScheme, au lieu d'utiliser la valeur par défaut.

La valeur par défaut est https.

 SEARCH_SCHEME
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/queryScheme
Deprecated featureNote: Obsolète dans HCL Commerce 9.1.12.0. Utilisez ${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/querySchema.
 Spécifiez une valeur si vous souhaitez définir une valeur queryScheme, au lieu d'utiliser la valeur par défaut. SEARCH_SCHEME
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/ingestHost Spécifiez une valeur si vous souhaitez définir une valeur ingestHost, au lieu d'utiliser la valeur par défaut. INGEST_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/ingestPort Spécifiez une valeur si vous souhaitez définir une valeur ingestPort, au lieu d'utiliser la valeur par défaut. INGEST_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/ingestScheme Spécifiez une valeur si vous souhaitez définir une valeur ingestScheme, au lieu d'utiliser la valeur par défaut. INGEST_SCHEME
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/elasticSearchHost
Note: Obligatoire lors de l'utilisation de la solution de recherche basée sur Elasticsearch (ELASTICSEARCH_ENABLED est défini sur true).
 Spécifiez une valeur elasticSearchHost. ELASTICSEARCH_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/elasticSearchPort Spécifiez une valeur si vous souhaitez définir une valeur elasticSearchPort, au lieu d'utiliser la valeur par défaut. ELASTICSEARCH_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/elasticSearchScheme Spécifiez une valeur si vous souhaitez définir une valeur elasticSearchScheme, au lieu d'utiliser la valeur par défaut. ELASTICSEARCH_SCHEME
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/searchQueryBaseUrl
Note: Obligatoire lors de l'utilisation de la solution de recherche basée sur Elasticsearch (ELASTICSEARCH_ENABLED est défini sur true).
 Spécifiez le serveur Search Query à utiliser par Tooling.

Le format de l'URL de base Search Query est https://query-domain:port.

 SEARCH_QUERY_BASE_URL
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/searchDataQueryBaseUrl
Note: Obligatoire lors de l'utilisation de la solution de recherche basée sur Elasticsearch (ELASTICSEARCH_ENABLED est défini sur true).
 Spécifiez le serveur Search Data Query à utiliser par Tooling.

Le format de l'URL de base Search Data Query est https://data-query-domain:port.

 SEARCH_DATA_QUERY_BASE_URL
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/elasticSearchShardCount
Note: Obligatoire lors de l'utilisation de la solution de recherche basée sur Elasticsearch (ELASTICSEARCH_ENABLED est défini sur true).
 Spécifiez le nombre de partitions aux fins du stockage des index de cet environnement, au sein du service Elasticsearch. La valeur par défaut est 1.
  • AUTH_ELASTICSEARCH_SHARD_COUNT
  • LIVE_ELASTICSEARCH_SHARD_COUNT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/elasticSearchReplicaCount
Note: Obligatoire lors de l'utilisation de la solution de recherche basée sur Elasticsearch (ELASTICSEARCH_ENABLED est défini sur true).
 Spécifiez le nombre de réplicas pour les index de cet environnement, au sein du service Elasticsearch. La valeur par défaut est 0.
  • AUTH_ELASTICSEARCH_REPLICA_COUNT
  • LIVE_ELASTICSEARCH_REPLICA_COUNT
HCL Commerce Version 9.1.9.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/ldapType
Note: Obligatoire lors de l'utilisation de LDAP (LDAP_ENABLED définie sur true).
 Type de serveur LDAP.
Valeurs admises :
  • IDS pour IBM Directory Server
  • DOMINO pour IBM Lotus Domino
  • SUNONE pour Sun Java System Directory Server
  • AD pour Microsoft Windows Active Directory
  • NDS pour Novell Directory Services
  • CUSTOM pour un serveur d'annuaire personnalisé
 LDAP_TYPE
HCL Commerce Version 9.1.9.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/ldapHost
Note: Obligatoire lors de l'utilisation de LDAP (LDAP_ENABLED définie sur true).
 Nom d'hôte qualifié complet du serveur LDAP LDAP_HOST
HCL Commerce Version 9.1.9.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/ldapPort
Note: Obligatoire lors de l'utilisation de LDAP (LDAP_ENABLED définie sur true).
 Numéro de port du serveur LDAP. LDAP_PORT
HCL Commerce Version 9.1.9.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/ldapSSL Indiquez si le serveur LDAP requiert une connexion SSL.
Valeurs admises :
  • true pour SSL.
  • false pour aucun SSL.
 LDAP_SSL
HCL Commerce Version 9.1.9.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/ldapBindPassword
Note: Obligatoire lors de l'utilisation de LDAP (LDAP_ENABLED définie sur true).
 Mot de passe de liaison LDAP XOR codé par l'utilitaire WebSphere Application Server V8.5.5 LibertysecurityUtility.
Par exemple :
securityUtility encode --encoding=xor passw0rd

Pour plus d'informations sur l'utilitaire securityUtility, voir commande securityUtility dans la documentation WebSphere Application Server V8.5.5 Liberty.

 LDAP_BIND_PASSWD
HCL Commerce Version 9.1.9.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/ldapBindDN
Note: Obligatoire lors de l'utilisation de LDAP (LDAP_ENABLED définie sur true).
 Nom distinctif (DN) de liaison LDAP. La valeur doit être en minuscules. LDAP_BIND_DN
HCL Commerce Version 9.1.9.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/ldapBaseDN
Note: Obligatoire lors de l'utilisation de LDAP (LDAP_ENABLED définie sur true).
 Nom distinctif (DN) de la base de recherche LDAP. La valeur doit être en minuscules. LDAP_BASE_DN
HCL Commerce Version 9.1.9.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/ldapRootOrgDN
Note: Obligatoire lors de l'utilisation de LDAP (LDAP_ENABLED définie sur true).
 Nom distinctif (DN) complet qui mappe marque à l'organisation racine HCL Commerce. La valeur doit être en minuscules. LDAP_ROOT_ORG_DN
HCL Commerce Version 9.1.9.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/ldapDefaultOrgDN
Note: Obligatoire lors de l'utilisation de LDAP (LDAP_ENABLED définie sur true).
 Nom distinctif (DN) complet qui mappe marque à l'organisation par défaut HCL Commerce. La valeur doit être en minuscules. LDAP_DEFAULT_ORG_DN
HCL Commerce Version 9.1.9.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/ldapLoginProp
Note: Obligatoire lors de l'utilisation de LDAP (LDAP_ENABLED définie sur true).
 Noms des propriétés LDAP utilisées pour se connecter au serveur d'applications. LDAP_LOGIN_PROP
HCL Commerce Version 9.1.9.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/ldapRealmName
Note: Obligatoire lors de l'utilisation de LDAP (LDAP_ENABLED définie sur true).
 Spécifiez une valeur pour le nom de domaine, au lieu d'utiliser la valeur par défaut.

La valeur par défaut est myrealm.

Note: Si vous intégrez à HCL Digital Experience, vous devez utiliser le même nom de domaine pour les deux.
 LDAP_REALM_NAME
HCL Commerce Version 9.1.9.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/ldapUserPrefix
Note: Obligatoire lors de l'utilisation de LDAP (LDAP_ENABLED définie sur true).
 Préfixe de l'utilisateur LDAP. LDAP_USER_PREFIX
HCL Commerce Version 9.1.9.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/ldapUserFilter
Note: Obligatoire lors de l'utilisation de LDAP (LDAP_ENABLED définie sur true).
 Filtre de recherche d'utilisateur LDAP. Utilisé uniquement pour le type LDAP personnalisé. LDAP_USER_FILTER
HCL Commerce Version 9.1.12.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/ldapDefaultOrgDN
Note: Obligatoire lors de l'utilisation de LDAP (LDAP_ENABLED définie sur true).
 Nom distinctif (DN) complet qui mappe marque à l'organisation par défaut HCL Commerce. La valeur doit être en minuscules. LDAP_DEFAULT_ORG_DN
HCL Commerce Version 9.1.10.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/mqEnable Indiquez si l'intégration IBM MQ doit être activée.
Valeurs admises :
  • true pour l'intégration IBM MQ.
  • false pour aucune intégration IBM MQ.
La valeur par défaut est false.
 MQ_ENABLE
HCL Commerce Version 9.1.10.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/mqHost
Note: Obligatoire lors de l'utilisation d'IBM MQ ( mqEnable est true ).
 Nom d'hôte du serveur IBM MQ. MQ_HOST
HCL Commerce Version 9.1.10.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/mqPort
Note: Obligatoire lors de l'utilisation d'IBM MQ ( mqEnable est true ).
 Numéro de port du serveur IBM MQ. MQ_PORT
HCL Commerce Version 9.1.10.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/mqQueueManagerName
Note: Obligatoire lors de l'utilisation d'IBM MQ ( mqEnable est true ).
 Gestionnaire de files d'attente IBM MQ utilisé par HCL Commerce pour se connecter au serveur IBM MQ. MQ_QUEUE_MANAGER_NAME
HCL Commerce Version 9.1.10.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/mqErrorQueueName
Note: Obligatoire lors de l'utilisation d'IBM MQ ( mqEnable est true ).
 Nom de la file d'attente d'erreurs IBM MQ. MQ_ERROR_QUEUE_NAME
HCL Commerce Version 9.1.10.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/mqInboundQueueName
Note: Obligatoire lors de l'utilisation d'IBM MQ ( mqEnable est true ).
 Nom de la file d'attente IBM MQ. MQ_QUEUE_MANAGER_NAME
HCL Commerce Version 9.1.10.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/mqSerialInboundQueueName
Note: Obligatoire lors de l'utilisation d'IBM MQ ( mqEnable est true ).
 Nom de la file d'attente IBM MQ pour traiter les messages en série. MQ_SERIAL_INBOUND_QUEUE_NAME
HCL Commerce Version 9.1.10.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/mqParallelInboundQueueName
Note: Obligatoire lors de l'utilisation d'IBM MQ ( mqEnable est true ).
 Nom de la file d'attente IBM MQ pour traiter les messages en parallèle. MQ_PARALLEL_INBOUND_QUEUE_NAME
HCL Commerce Version 9.1.10.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/mqOutboundQueueName
Note: Obligatoire lors de l'utilisation d'IBM MQ ( mqEnable est true ).
 Nom de la file d'attente sortante IBM MQ. MQ_OUTBOUND_QUEUE_NAME
HCL Commerce Version 9.1.10.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/mqEnableActivitySessionTimoutPeriod
Note: Obligatoire lors de l'utilisation d'IBM MQ ( mqEnable est true ).
 Valeur du délai d'expiration de la session MQ_ENABLE_ACTIVITY_SESSION_TIMEOUT_PERIOD
HCL Commerce Version 9.1.10.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/mqMaxConnection
Note: Obligatoire lors de l'utilisation d'IBM MQ ( mqEnable est true ).
 Nombre maximum de connexions autorisées avec IBM MQ. MQ_MAX_CONNECTION