Ältere Plattform

Assistenten erstellen

Sie können einen Assistenten erstellen, indem Sie die Assistentendefinition in der Datei additionalwizards.xml angeben und das Benutzerschnittstellenwidget des Assistenten erstellen.

Vorbemerkungen

Es wird vorausgesetzt, dass Sie wissen, wie angepasste Anzeigen erstellt werden.

Vorgehensweise

  1. Erstellen Sie eine Assistentendefinition in der Datei additionalwizards.xml . Stellen Sie sicher, dass die Assistenten-ID das Präfix extnhat.
    Beispiel: <wizard id=extn.wizards.CustomWizard>.
  2. <INSTALL_DIR>/extensions/Kopiere die additionalwizards.xml Datei in den Ordner „wsc/webpages/wizardxmls/ “.
  3. Erstellen Sie ein Assistentenwidget für die entsprechende Assistenten-ID.
    Wenn die Assistenten-ID beispielsweise extn.wizards.CustomWizardlautet, erstellen Sie das Widget CustomWizard.js mit der deklarierten Klasse extn.wizards.CustomWizard. <INSTALL_DIR>/extensions//webpages/wizards/<INSTALL_DIR>/extensions/ Kopieren Sie die CustomWizard.js Datei in den Ordner „wsc“ und die entsprechenden Vorlagen für die Assistenten-Widgets ebenfalls in den Ordner „wsc/wizards/templates/ “.
  4. Öffnen Sie den Assistenten durch Aufrufen des Dienstprogramms WizardUtils.openWizardInEditor . Übergeben Sie die folgenden Parameter im Dienstprogramm WizardUtils.openWizardInEditor , um den Assistenten zu öffnen:
    • wizardId -ID des Assistenten.
    • wizardInput -Anfangseingabe des Assistenten.
    • editorId -ID des Editors.
    • editorConfig -Konfiguration für den Editor. Die Attribute, die für diesen Parameter bereitgestellt werden, werden dem Editor hinzugefügt.
    Mit den Dienstprogrammmethoden des Assistenten können Benutzer im Assistenten navigieren. In der folgenden Tabelle werden einige Assistentendienstprogrammmethoden der Datei WizardUtils.js (sc.plat.dojo.utils.WizardUtils) beschrieben. Weitere Informationen zu Assistentendienstprogrammmethoden finden Sie in der JavaScript -Dokumentation.
    Tabelle 1. Wizard-Hilfsmethoden

    Die folgende Tabelle enthält eine Liste der Dienstprogrammmethoden des Assistenten.

    Dienstprogrammmethoden des Assistenten Beschreibung
    getCurrentPage Berücksichtigt eine Assistenteninstanz und gibt die Seite zurück, die im Stack-Container des Assistenten angezeigt wird.
    isCurrentPageFirstEntity Wenn die angezeigte oder anzuzeigende Seite die erste Entität im Stack-Container eines Assistenten ist, gibt diese Methode den Wert truezurück.
    isCurrentPageLastEntity Wenn die angezeigte oder anzuzeigende Seite die letzte Entität im Stack-Container eines Assistenten ist, gibt diese Methode den Wert truezurück.
    nextScreen Ruft die nächste Anzeige eines Assistenten ab, die angezeigt werden soll
    previousScreen Zeigt die vorherige Anzeige eines Assistentenablaufs an
    confirmWizard Bestätigt eine Assistenteninstanz.
    openWizardInEditor Öffnet eine Assistenteninstanz für eine wizardId mit wizardInput.
    closeWizard Löst das Ereignis beforeClose aus und schließt den Assistenten.
    getCurrentPageByUId Ruft die UID der aktuellen Seite ab.
    isCurrentPageLeaf Wenn die in einem Assistenten geöffnete Seite ein Blattknoten ist, gibt diese Methode den Wert truezurück.

    Die XML-Dateien zur Definition des Assistenten befinden sich im Verzeichnis <INSTALL_DIR>/repository/eardata/wsc/war/wizardxmls . Die UI-Dateien befinden sich im Verzeichnis <INSTALL_DIR>/repository/eardata/wsc/war/wsc/<module>/wizards . Hier bezieht sich <module> auf den Versand oder andere. Die Assistentendefinitionsdatei CustomerPickWizardFlow.xml befindet sich zum Beispiel im Verzeichnis <INSTALL_DIR>/repository/eardata/wsc/war/wizardxmls . Die CustomerPickWizard XML UI-Dateien hingegen befinden sich im Verzeichnis <INSTALL_DIR>/repository/eardata/wsc/war/wsc/shipment/wizards .

    Stellen Sie sicher, dass Sie einen Assistenten mit Navigationsschaltflächen wie 'Weiter', 'Zurück', 'Bestätigen' und 'Abbrechen ' erstellen. Beim Klicken auf "Weiter" wird das Ereignis saveCurrentPage ausgelöst, damit die aktuelle Assistentenseite Daten speichert. Nach dem Speichern der Daten wird das Ereignis onSaveSuccess ausgelöst und die nächste Seite im Assistenten angezeigt. Ebenso wird beim Klicken auf "Zurück" eine Warnung angezeigt, die den Benutzer auffordert, Daten auf der aktuellen Assistentenseite zu speichern, bevor er zur vorherigen Seite geht. Wenn Sie auf 'Ja' klicken, wird das Ereignis saveCurrentPage ausgelöst. Nachdem die Daten gespeichert wurden, wird das Ereignis onSaveSuccess von der Seite an den Assistenten ausgegeben und die vorherige Assistentenseite angezeigt. Die Ereignisinteraktion zwischen dem Assistenten und den Seiten 'Bestätigen' und 'Abbrechen 'ähnelt der Interaktion zwischen' Weiter 'und 'Zurück'.

    Für angepasste Assistenten werden die folgenden Ereignisse ausgelöst:
    • setScreenTitle -Dieses Ereignis tritt auf, um den Untertitel im Editor festzulegen. Im Assistenten 'Auftrag erstellen' lautet der Titel beispielsweise 'Auftrag erstellen' und der Untertitel lautet 'Kundensuche'. Dies ist die erste Anzeige auf der Assistentenseite.
    • handleTabClose -Dieses Ereignis tritt auf, wenn ein Editor geschlossen wird Vor dem Schließen des Assistenten wird eine Warnung angezeigt, in der der Benutzer aufgefordert wird, alle nicht gespeicherten Daten auf der Seite zu speichern. Stellen Sie sicher, dass der handleTabClose -Ereignissubskribent für neue Assistenten definiert wird, damit der Benutzer beim Schließen des Editors aufgefordert wird, Daten zu speichern.
    • setWizardInput -Dieses Ereignis wird von einem Editor ausgelöst, wenn die Editoreingabe in einer Benutzerschnittstellenaktion geändert wird. Wenn beispielsweise die Editoreingabe bei der Identifizierung eines Kunden für die Bestellung geändert wird, wird die Editoreingabe aktualisiert und das Ereignis setWizardInput wird ausgelöst, um die Assistenteneingabe zu aktualisieren.