Grundlegende Befehlssyntax

Alle WebSphere Commerce-Befehle zum Einkaufsfluss weisen folgende grundlegende Syntax auf:

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

Beispiel: 

Beginnen Sie zum Lesen dieser Syntaxdiagramme in der linken oberen Ecke und folgen Sie der Zeile.  Berücksichtigen Sie die folgenden Konventionen: 

  • Der host_name und der path werden durch die Art und Weise bestimmt, in der das Produkt installiert wurde.
  • Der Begrenzer nach dem Befehlsnamen ist ?.  Der Begrenzer zwischen aufeinander folgenden Parametern ist &.  Vor dem ersten Parameter muss der Begrenzer & nicht verwendet werden. 
  • Der Wert des Parameters wird in den Syntaxdiagrammen normalerweise als s für 'string' angegeben.  Erfordert ein Parameter vordefinierte Codes oder gibt er nicht offensichtliche Einschränkungen zum Datentyp vor, wird dies in der Beschreibung erklärt. 
  • Befindet sich beim Verfolgen der Zeile von links nach rechts in der Hauptzeile ein Parameter, der nicht umgangen werden kann (z. B. URL), ist dieser Parameter erforderlich.
  • Wenn sich ein Parameter nicht in der Hauptzeile befindet und vermieden werden kann, z. B. langId, ist dieser Parameter optional. 
  • Enthält ein Parameter eine Zeilenwiederholung zur linken Site, z. B. listId, kann der Parameter wiederholt verwendet werden. Beispiel: 
  • &listId=1&listId=2&listId=3

    Das nächste Syntaxdiagramm stellt alternative Sets erforderlicher Parameter dar. Sie verwenden entweder:

    &logonId=s&challengeAnswer=s 

    oder Sie verwenden

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

    Das nächste Syntaxdiagramm zeigt memberId, ein in manchen Fällen erforderlicher Parameter.  Dies wird anhand einer gestrichelten Linie dargestellt.  In der Beschreibung von OrgEntityAdd befindet sich eine Erklärung dazu, wann der Parameter erforderlich und wann er optional ist. 

    Parameter

    Einige allgemeine Parameter stehen für die meisten Befehle zur Verfügung:

    storeId
    Dieser Parameter ordnet den Befehl einem bestimmten Geschäft zu.  Dies ist besonders bei Befehlen sinnvoll, die auf der Ebene der Einkaufszentren ausgeführt werden, weil der Befehl so ausschließlich innerhalb des Bereichs des Geschäfts verarbeitet werden muss.
    langId
    Gibt die Sprache an, die für die Zeitdauer der Befehlsausführung verwendet wird. Die Werte für den Parameter werden in der Tabelle LANGUAGE gespeichert.  Die angegebene Sprache setzt die Standardsprache außer Kraft, falls sie unterstützt wird. Wird die angegebene Sprache nicht unterstützt, wird die Standardsprache des Geschäfts oder der Site verwendet. 
    forUser
    Dieser Parameter gibt die Anmelde-ID eines Benutzers an, für den Aktionen durch einen anderen Benutzer ausgeführt werden. Der Parameter kann nur von einer Person verwendet werden, die über die Berechtigung zum Verarbeiten von Bestellungen verfügt - beispielsweise Kundendienstmitarbeiters, Kundendienst-Supervisor, Betriebsmanager, Logistikmanager, Händler oder Verkäufer. Der Parameter ist besonders für ein Telefonservicecenter sinnvoll, wenn ein Kunde Unterstützung beim Abschluss eines Kaufs anfordert. Der Bediener des Telefonservicecenters meldet sich daraufhin an und schließt die Bestellung anhand der Identität des anrufenden Kunden ab. 
    forUserId
    Identisch mit "forUser"; hier wird jedoch der Benutzer mit einer internen Benutzer-ID identifiziert, wie in der Tabelle USERS angegeben.
    URL
    Die Web-Adresse, die aufgerufen wird, wenn der Befehl erfolgreich ausgeführt wird.  Der Wert für diesen Parameter wird folgendermaßen festgestellt: Starten Sie mit den Eingabeparametern für den Befehl mit Ausnahme der URL-Adresse. Dann werden alle von diesem Befehl erzeugten Name/Wert-Paare hinzugefügt. Sie werden ersetzt, wenn ein Namenskonflikt auftritt. Abschließend werden alle Name/Wert-Paare hinzugefügt, die im Parameter URL gefunden wurden. Sie werden ersetzt, wenn ein Namenskonflikt auftritt.

    Beispiele
    Beim Anzeigen von Beispielen umfasst die URL häufig mehrere Zeilen. Zur besseren Lesbarkeit werden sie folgendermaßen dargestellt:
         http://myhostname/webapp/wcs/stores/servlet/AddressUpdate?addressId=128
         &firstName=Jeffery&URL=/webapp/wcs/stores/servlet/


    Beachten Sie, dass ein URL-Befehl normalerweise in einer einzelnen Zeile angezeigt wird.

    Verwandte Referenzen

    IBM Copyright