Syntaxe des instructions

Toutes les instructions de flux des achats WebSphere Commerce présentent la syntaxe de base suivante :

    http://host_name/path/Command?parameter1=value&parameter2=value&parameter3=value

En voici un exemple :

Pour lire ces diagrammes de syntaxe de style chemin de fer, commencez dans l'angle supérieur gauche et suivez la ligne (imaginez une voie de chemin de fer).  N'oubliez pas les conventions suivantes :

  • host_name et path sont déterminés par la manière dont le produit a été installé.
  • Le délimiteur qui suit le nom de l'instruction est ?.  Celui qui sépare les paramètres successifs est &.  Il n'est pas nécessaire d'utiliser le délimiteur & avant le premier paramètre. 
  • La valeur du paramètre est généralement indiquée dans les diagrammes de syntaxe par c, pour chaîne. Si un paramètre nécessite des codes prédéfinis ou s'il applique des restrictions non évidentes sur le type de données, une explication sera ajoutée dans la description. 
  • En suivant la ligne de la gauche vers la droite, s'il n'est pas possible d'éviter un paramètre se trouvant sur la ligne principale, comme une URL, cela veut dire que ce paramètre est obligatoire.
  • Si un paramètre ne se trouve pas sur la ligne principale, comme langId, et peut être évité, cela veut dire qu'il est facultatif. 
  • Si un paramètre a une ligne retournant vers le site de gauche, comme listId, cela veut dire qu'il peut être utilisé plusieurs fois, comme ceci :
  • &listId=1&listId=2&listId=3

    Le nouveau diagramme de syntaxe donne d'autres exemples d'ensembles de paramètres obligatoires. Vous pouvez utiliser soit :

    &logonId=s&challengeAnswer=s 

    soit :

    &logonPassword=s&logonPasswordOld=s&logonPasswordVerify=s
    

    Les diagrammes de syntaxe suivants présente le paramètre memberId, qui est parfois obligatoire.  Ceci est indiqué par une ligne discontinue. Dans la description de OrgEntityAdd, vous allez savoir à quel moment le paramètre est obligatoire et à quel moment il ne l'est pas. 

    Paramètres

    La quasi totalité des instructions disposent de paramètres communs qui sont les suivants :

    storeId
    Ce paramètre associe l'instruction à un magasin déterminé.  Ce paramètre est particulièrement utile pour des instructions de niveau centre commercial, car il oblige l'instruction à ne traiter que l'environnement du magasin.
    langId
    Indique la langue qui sera utilisée au cours du déroulement de l'instruction. Les valeurs du paramètre sont enregistrées dans la table LANGUAGE.  La langue indiquée remplace la langue par défaut de l'utilisateur, si elle est prise en charge. Dans le cas où la langue indiquée n'est pas prise en charge, la langue par défaut du magasin ou du site est utilisée.
    forUser
    Indique l'ID de connexion d'un utilisateur pour qui un autre utilisateur entreprend des actions. Ce paramètre ne peut être utilisé que par une personne ayant le droit de traiter les commandes, tel que le Représentant de Service Clientèle, le Responsable du service clientèle, le Gestionnaire des opérations, le Responsable de la logistique, le Commerçant, ou le Vendeur.  Le paramètre est utile dans le contexte d'un centre d'appels téléphoniques si un client demande une assistance pour terminer ses achats. L'opérateur du centre d'appels téléphoniques se connecte alors et termine la commande en utilisant l'identité du client. 
    forUserId
    Identique à forUser, mais identifie l'utilisateur par l'ID d'utilisateur interne, tel qu'il est indiqué dans la table USERS.
    URL
    L'adresse Web appelée lorsque l'instruction aboutit.  La valeur de ce paramètre est obtenue de la manière suivante : indiquez d'abord les paramètres d'entrée de l'instruction, à l'exception de l'URL. Ajoutez les paires nom-valeur produites par cette instruction (remplacez-les en cas de conflit dans les noms). En dernier lieu, ajoutez en cas de conflit sur le nom, les paires trouvées dans l'URL.

    Exemples
    Les exemples d'URL remplissent souvent plusieurs lignes. Pour une meilleure lisibilité, elles sont présentées comme suit :
         http://myhostname/webapp/wcs/stores/servlet/AddressUpdate?addressId=128
         &firstName=Jeffery&URL=/webapp/wcs/stores/servlet/


    Notez qu'une instruction de type URL tient généralement sur une seule ligne.

    Références connexes

    IBM copyright