Fichier XML PaymentSystemPluginMapping

Utilisez le fichier PaymentSystemPluginMapping.xml pour mapper les systèmes de paiement aux plug-ins de paiement.

Ce fichier se trouve dans le répertoire suivant :

workspace_dir/WC/xml/config/payments/ppc/plugins
workspace_dir/wc/xml/config/payments/plugins

Exemple

<?xml version="1.0" encoding="UTF-8"?>
<Mapper xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="PaymentSystemPluginMapper.xsd">

  <RetainKeywords>
       <Keyword name="billing_address_id"/>
  </RetainKeywords>     
  <PaymentSystemName 
          name="SimpleOffline" >
          <Mapping paymentConfigurationId="default" PluginName="SimpleOffline" >
              <Keyword name="cc_cvc" mask="-" plain="0" removeAfterApproval="true" neverPersist="true"/>
              <Keyword name="cc_nameoncard" mask="*" plain="0" removeAfterApproval="true" neverPersist="true" />
              <Keyword name="account" mask="*" plain="-5" searchable="true"/>
          </Mapping> 
  </PaymentSystemName>

  <PaymentSystemName 
          name="VisaNet" >
          <Mapping paymentConfigurationId="VisaNet" PluginName="WCPaymentsPlugin" >
              <Property name="ProfileName" value="WCPPlugin_VisaNet"/>
              <Keyword name="cc_cvc" mask="-" plain="0" removeAfterApproval="true" neverPersist="true"/>
              <Keyword name="cc_nameoncard" mask="*" plain="0" removeAfterApproval="true" neverPersist="true"/>
              <Keyword name="account" mask="*" plain="-5" searchable="true"/>
          </Mapping>
  </PaymentSystemName>

  
</Mapper>

Remarque : Si vous supprimez les paramètres des données étendues dans une instruction de paiement, vous ne pouvez pas réutiliser ces paramètres dans les transactions ultérieures, par exemple, dans le flux de retour.

Paramètres

RetainKeywords

Facultatif : Spécifiez les mots clés à conserver dans la base de données HCL Commerce. Il s'agit d'un paramètre global qui s'applique à toutes les instructions de paiement pour tous les plug-ins nommés dans ce fichier. Dans l'exemple illustré, l'ID de l'adresse de facturation est conservé dans la base de données pour tous les plug-ins utilisés dans ce fichier.

Une autre façon de spécifier la conservation des mots clés est l'utilisation des éléments <ProtocolProperties> et <ProtocolProperty> dans le descripteur de déploiement de plug-ins. Lorsque vous conservez des mots clés dans le descripteur de déploiement de plug-ins, la conservation se fait au niveau du plug-in seulement (il ne s'agit pas d'une conservation globale pour tous les plug-ins).

Cet élément peut être utilisé pour déterminer quelles données importantes doivent être conservées afin d'améliorer les performances de l'application HCL Commerce et de votre magasin en ligne.

PaymentSystemName

nom

Le nom du système dorsal de paiement

Le nom d'un système de paiement est une chaîne indépendante du nom du plug-in. Le nom du système de paiement est mappé au plug-in de paiement utilisé pour traiter les transactions. Le nom du système de paiement doit correspondre entre les fichiers PaymentMethodConfigurations.xml (ou RefundMethodConfigurations.xml) et PaymentSystemPluginMapping.xml.

La table suivante répertorie les noms des systèmes de paiement fournis dans HCL Commerce pour les modes de paiement (et de remboursement) pris en charge. Les associations présentées ci-dessous sont des exemples. Vous pouvez, par exemple, configurer une marque de carte de crédit particulière pour qu'elle utilise un nom de système de paiement ou un plug-in de paiement différent.


Nom du système de paiement	Nom du plug-in	Méthode
LOCSystem	LOCPlugin	LOC
OfflineACHSystem	SimpleOfflinePlugin	Vérification
OfflineCreditCardSystem	SimpleOfflinePlugin	AMEX
OfflineCreditCardSystem	SimpleOfflinePlugin	Master Card
OfflineCreditCardSystem	SimpleOfflinePlugin	VISA
OfflineSystem	SimpleOfflinePlugin	BillMeLater
OfflineSystem	SimpleOfflinePlugin	Contre remboursement
OfflineSystem	SimpleOfflinePlugin	PayLater

Mappage

paiementConfigurationId

L'ID de la configuration de paiement pour le mode de paiement. La combinaison du nom du système de paiement et de paymentconfigurationId détermine quel plug-in est utilisé. Pour plus d'informations, voir Groupe de configuration de paiement.

PluginName

Le nom du plug-in de paiement.

Propriété

Facultatif : nom Le nom de la propriété de plug-in qui doit être utilisée dans les transactions pour ce mode de paiement particulier. Un plug-in peut nécessiter des paramètres supplémentaires, ou une configuration de paiement peut avoir des besoins uniques.

valeur La valeur de la propriété de plug-in nommée.

Mot clé

Facultatif : Tous les mots clés définis sous l'élément <Mapping> sont enregistrés dans la base de données HCL Commerce.

nom

Le nom du mot clé associé aux données du protocole de paiement et à ses attributs. Les attributs peuvent être utilisés pour déterminer si les données peuvent être utilisées dans une recherche de commande, quelle partie des données est visible dans les résultats de recherche, si une partie des données doit être masquée lors de l'affichage des données de protocole dans l'interface utilisateur, et si les données doivent être supprimées de la base de données après l'approbation du montant total de l'instruction de paiement.

masque

Le caractère utilisé pour masquer la partie des données qui ne doit pas être visible. Le caractère peut être un signe moins, un astérisque, ou un autre caractère. Cet attribut est utilisé en combinaison avec "brut" lorsque des données sensibles s'affichent dans HCL Commerce Accelerator.

normal

La longueur du texte brut (partie visible). Cet attribut est utilisé en combinaison avec "masque" lorsque des données sensibles s'affichent dans HCL Commerce Accelerator. La valeur brute est un entier avec ou sans signe moins. Le signe moins est utilisé pour définir l'emplacement de la partie brute du texte dans la chaîne par rapport à la fin de la chaîne. Par exemple, plain="2" désigne les deux premiers caractères de la chaîne. plain="-5" désigne les cinq derniers caractères de la chaîne (Par exemple, le numéro de carte de crédit 4111111111111111, est affiché comme *********11111). plain="0" signifie qu'il n'y a pas de caractères bruts.

Cet attribut s'applique au masque et aux attributs consultables. Si la valeur brute est omise, elle est traitée comme plain="0" pour le masquage (pas de caractères masqués) et plain="total_text_length" pour la recherche (tous les caractères qui sont utilisés dans la recherche). La valeur brute est utilisée uniquement lorsque le masque est spécifié ou lorsqu'un attribut consultable est spécifié.

Exemple : Supposons qu'une configuration affiche <keyword name="billto_address" searchable="true">. Aucune valeur de masque n'est spécifiée. La chaîne entière de l'adresse de facturation s'affiche donc dans l'interface utilisateur. Etant donné que searchable="true" est défini sans valeur brute, la chaîne d'adresse de facturation entière est utilisée pour rechercher des commandes.

NeverPersist

Facultatif : Indique si le mot clé est stocké dans la table PPCEXTDATA. La table PPCEXTDATA stocke des données étendues pour les instructions de paiement.

true: Ne conservez pas le mot clé.
false: Valeur par défaut. Le mot clé est stocké dans la table PPCEXTDATA lorsqu'une instruction de paiement est ajoutée.

searchable

Indique si le mot clé peut être recherché dans HCL Commerce Accelerator dans la page Rechercher des commandes.

true: Activez la recherche des données.
Remarque : Le mot clé est stocké dans la colonne SEARCHVALUE de la table PPCEXTDATA. L'augmentation du nombre de mots clés consultables augmente la quantité d'espace utilisé et ralentit la vitesse de traitement.
false: Valeur par défaut. Les données ne peuvent pas être recherchées.

removeAfterApproval

Indique si le mot clé sera supprimé des données étendues de l'instruction de paiement après l'approbation du montant total de l'instruction de paiement. Certains protocoles financiers exigent que les données sensibles (telles que la valeur de vérification de la carte et le nom sur la carte) ne soient pas stockées.

true: Supprimez le mot clé . Les données sensibles sont supprimées des données étendues après l'approbation du montant total du paiement.
false: Valeur par défaut. Conservez le mot clé.

La table suivante résume la signification des diverses combinaisons de configurations pour les mots clés (certaines combinaisons possibles ne sont pas affichées). Les cellules vides de la table indiquent que l'attribut correspondant n'est pas spécifié dans le fichier de configuration.


masque	normal	searchable	Description de la configuration.
un caractère (*, -, ou un autre)	Un entier avec ou sans signe moins	true/false	La valeur du mot clé est masquée par le caractère de masquage avec une partie brute dans l'interface utilisateur. L'entier de l'élément brut définit la longueur de la partie brute. Le signe moins définit l'emplacement de la partie brute à partir de la fin de la chaîne. Si l'attribut consultable est défini sur true, seule la partie brute peut être recherchée. Si l'attribut consultable est défini sur false, la recherche sur ce mot clé n'est pas prise en charge. Ici, la partie brute est la même que la partie consultable. Si la longueur de la partie brute est 0, searchable="true" est égal à searchable="false".
	Un entier avec ou sans signe moins	true/false	La valeur du mot clé n'est pas masquée dans l'interface utilisateur. La chaîne entière de la valeur s'affiche sous forme brute. Si la recherche est true, la partie consultable est définie sous forme brute. L'entier définit la longueur de la partie consultable et le signe moins définit l'emplacement de la partie consultable. Si l'attribut consultable est défini sur false, la recherche sur ce mot clé n'est pas prise en charge.
un caractère (*, -, ou un autre)	Un entier avec ou sans signe moins		La valeur de ce mot clé est masquée par le caractère de masquage avec une partie brute dans l'interface utilisateur. L'entier de l'élément brut définit la longueur de la partie brute et le caractère moins définit l'emplacement de la partie brute dans la chaîne entière. Lorsque l'attribut consultable n'est pas spécifié, le mot clé n'est pas consultable.
		true	La valeur du mot clé n'est pas masquée dans l'interface utilisateur. La chaîne entière est affichée sous forme brute. Etant donné que la recherche est définie sur true sans format brut spécifié, la valeur de chaîne entière peut être consultée.
		false	La valeur du mot clé n'est pas masquée dans l'interface utilisateur. La chaîne entière est affichée sous forme brute. Puisque l'attribut consultable est défini sur fausse, la valeur ne peut pas être consultée.
un caractère (*, -, ou un autre)		true/false	La valeur du mot clé est masquée par le caractère masque sans aucune partie brute visible dans l'interface utilisateur. Si l'attribut consultable est défini sur true, la chaîne entière peut être consultée. Si l'attribut consultable est défini sur false, la recherche sur ce mot clé n'est pas prise en charge. Ici, la partie brute n'est pas la même que la partie consultable.
un caractère (*, -, ou un autre)			La valeur du mot clé est masquée par le caractère masque sans aucune partie brute visible dans l'interface utilisateur. Etant donné que la recherche n'est pas spécifiée, ce mot clé n'est pas consultable.
			Rien pour le masque, le format ou l'attribut consultable n'est spécifié. La valeur du mot clé n'est pas masquée dans l'interface utilisateur. La chaîne entière est affichée sous forme brute. Puisque l'attribut consultable n'est pas spécifié, la valeur ne peut pas être consultée.

Explication de l'exemple

Dans l'exemple précédent, deux plug-ins sont utilisés, SimpleOffline et WCPayments :

Le plug-in SimpleOffline traite les transactions pour le système de paiement nommé SimpleOffline. Le système de paiement SimpleOffline est une approche de paiement hors ligne qui n'implique pas de communication directe avec un système dorsal de paiement.
Le plug-in WCPayments traite les transactions avec un autre système de paiement nommé VisaNet. Le plug-in utilise une cassette appelée VisaNet pour traiter les transactions du système de paiement VisaNet.

Le système de paiement SimpleOffline, les configurations qui déterminent quelles données de protocole sont consultables dans HCL Commerce Accelerator au moment où une recherche de commandes est effectuée. Si des données de protocole spécifiques dovenit être consultables sur la page Rechercher des commandes dans HCL Commerce Accelerator, le mot clé de ces données doit être répertorié avec les attributs de recherche nécessaires.
Le "compte" de paiement contient les seules données de protocole de paiement qui peuvent être utilisées dans la recherche de commandes. Dans la page Rechercher des commandes dans HCL Commerce Accelerator, une zone pour que l'utilisateur entre les cinq derniers chiffres du numéro de compte de paiement (par exemple, le numéro d'une carte de crédit) existe. L'interface utilisateur n'affiche pas les zones du code de vérification de la carte (CVC) ou du nom du titulaire de la carte sur la carte.
L'interface utilisateur peut être modifiée pour utiliser d'autres données de protocole de paiement pour la recherche de commandes. Seule la zone "compte" est initialement mise à disposition pour la recherche de commandes. Toutes les données du protocole de paiement peuvent être mises à disposition pour la recherche. Si vous souhaitez effectuer une recherche sur autre chose que les cinq derniers chiffres du numéro de compte de paiement, vous pouvez personnaliser la page de recherche de commandes. Par exemple, pour rechercher "bankname" au lieu de "account", modifiez la page JSP de recherche de commandes ou de liste de commandes pour remplacer le nom des données de protocole par "bankname".

Pour utiliser deux types de données de protocole afin de rechercher une commande, tels que cc_brand et account (par exemple, cc_brand="CardBrandX" et compte = "12345"), modifiez les fichiers JSP pour collecter ces deux valeurs. Pour plus d'informations, voir Utilisation d'autres données de protocole de paiement pour rechercher des commandes.
Les chiffres qui précèdent les cinq derniers chiffres du numéro de compte de paiement sont masqués dans les résultats de recherche avec des astérisques (*). Par exemple, si le numéro de compte est 123456789012345, il est affiché comme ********12345 dans HCL Commerce Accelerator et seulement 12345 est enregistré en interne pour la recherche de commandes.
Le mot clé cc_cvc est masqué avec des tirets dans l'interface utilisateur sans que les chiffres ne soient clairement visibles.
Les valeurs pour cc_cvc et cc_name sur la carte sont supprimées après l'approbation du montant total de l'instruction de paiement. Le numéro de compte n'est pas supprimé (l'absence de l'attribut signifie emoveAfterApproval="false").
Les valeurs pour cc_cvc et cc_nameoncard ne sont pas conservées dans la table PPCEXTDATA. Pour utiliser les données de protocole lors de l'autorisation de paiement, envoyer la valeur de cc_cvc et de cc_nameoncard vers la commande OrderProcess.