Beispiel: Coach in clientseitigem Benutzerservice validieren

Das vorliegende Beispiel zeigt, wie Sie die Datenänderungseigenschaften eines Coach in einem clientseitigen Benutzerservice zum Validieren der Coach-Daten verwenden, ohne den Coach zu verlassen.

Informationen zu diesem Vorgang

Das folgende Beispiel veranschaulicht, wie die Daten, die ein Benutzer in den Coach eingibt, validiert werden, damit im Coach eine Fehlernachricht angezeigt wird, falls die Daten nicht gültig sind. Das Beispiel zeigt außerdem, wie verhindert werden kann, dass der Benutzer mit dem nächsten Schritt fortfährt, wenn die Daten nicht gültig sind.

Das Beispiel enthält einen Coach mit einer Eingabeaufforderung für Start- und Enddaten. Dieser Coach besteht aus einem Feld Startdatum, einem Feld Enddatum und einer Schaltfläche OK. Das Anfangsdatum liegt vor dem Enddatum. Für die Validierung der Coachdaten geben Sie ein clientseitiges JavaScript im Coach an, das die Validierung durchführt.
Anmerkung: In diesem Beispiel wird gezeigt, wie ein Coach in einem clientseitigen Benutzerservice in IBM® Process Designer validiert wird. Informationen zum Validieren eines Coach in einem Heritage-Benutzerservice finden Sie unter Beispiel: Coach-Daten in einem Heritage-Benutzerservice im Desktop-Process Designer prüfen (veraltet).

Vorgehensweise

  1. Erstellen Sie den clientseitigen Benutzerservice, der den zu validierenden Coach enthalten soll. Siehe Clientseitigen Benutzerservice erstellen.
  2. Erstellen Sie auf Registerkarte Variablen des Benutzerservice die zwei privaten Variablen startDate und endDate und legen Sie für jede dieser Variablen den Typ Date fest.
    Auf der Registerkarte Variablen des Benutzerservice werden die beiden privaten Variablen startDate und endDate angezeigt. Der Typ jeder Variablen wird auf Date gesetzt.
  3. Benennen Sie im Diagramm für den clientseitigen Benutzerservice den Coach in Eingabeaufforderung für Start- und Enddaten um.
  4. Legen Sie auf der Registerkarte Coaches im Abschnitt Variablen der Palette die Parameter startDate und endDate auf dem Coach ab. Lassen Sie die Schaltfläche OK unverändert.
  5. Wählen Sie im Coach den Parameter Startdatum aus und stellen Sie sicher, dass er an die Variable startDate im Abschnitt Verhalten der Registerkarte Allgemein gebunden ist.
    Für den Parameter Startdatum müssen die Daten ordnungsgemäß an die Variable startDate gebunden sein.
  6. Wiederholen Sie Schritt 5 für den Parameter Enddatum, um zu prüfen, dass er ordnungsgemäß an die Variable endDate gebunden ist, und speichern Sie dann die Coach-Konfiguration.
  7. Klicken Sie in der Diagrammansicht für den Coach auf die Registerkarte Datenänderung und geben Sie das folgende JavaScript-Konstrukt in die Eigenschaften für Script ein:
    if (tw.local.startDate.getTime() > tw.local.endDate.getTime())
    	tw.system.coachValidation.addValidationError("tw.local.startDate", "Das Startdatum muss vor dem Enddatum liegen. Legen Sie ein Startdatum fest, das vor dem Enddatum liegt, und versuchen Sie es erneut.");
    Im Objekt coachValidation enthält die erste Zeichenfolge den vollständigen Variablenpfad zu den Elementen, deren Daten zu validieren sind. Die zweite Zeichenfolge stellt die Nachricht für den Benutzer dar, in der angegeben wird, wo der Fehler in den Daten liegt und wie das Problem behoben werden kann.
    Anmerkung:
    • Wenn das validierte Datenelement nicht an eine Coach-Ansicht gebunden ist, kann ein eventuell auftretender Gültigkeitsfehler nirgends angezeigt werden.
    • Wenn eine Coach-Ansicht, die validiert wird, Rich Text enthält, dann muss das Prüfscript die Formatierung entfernen, bevor der Inhalt validiert wird.
    • Wenn Sie eine Liste validieren und möchten, dass sich der Fehler auf die gesamte Liste bezieht, muss der Parameter variableName ein Suffix [] enthalten. Dies stimmt mit der Bindung der Coach-Ansicht überein, bei der [] angibt, dass es sich bei dem Objekt um eine Liste handelt. Wenn eine Coach-Ansicht beispielsweise an tw.local.var3[] gebunden ist, wobei es sich um eine Liste handelt, brauchen Sie Code wie den folgenden:
      tw.system.coachValidation.addValidationError("tw.local.var3[]", "Var3 hat Gültigkeitsfehler");
  8. Optional: Führen Sie die folgenden Schritte aus, um zu verhindern, dass der Benutzer mit dem nächsten Schritt fortfährt, wenn die Daten nicht gültig sind:
    1. Fügen Sie auf der Registerkarte Variablen für den Benutzerservice eine weitere private Variable mit dem Namen readyToSubmit hinzu und legen Sie für die Variable den Typ Boolean fest.
    2. Hängen Sie in den Eigenschaften für Script des ausgewählten Coach den folgenden JavaScript-Code an das vorhandene Script an:
      tw.local.readyToSubmit = tw.system.coachValidation.validationErrors.length==0;
    3. Konfigurieren Sie auf der Registerkarte Coaches die Schaltfläche OK so, dass sie schreibgeschützt ist, wenn Fehler vorhanden sind, wie nachfolgend gezeigt:
  9. Klicken Sie auf Speichern oder auf Bearbeitung beenden.
  10. Klicken Sie auf Ausführen Ausführen, um den Benutzerservice auszuführen.
  11. Führen Sie folgende Schritte aus, um in dem Browser, in dem der Coach angezeigt wird, die Validierung zu testen:
    1. Setzen Sie das Enddatum auf ein Datum, das vor dem Startdatum liegt. Klicken Sie auf OK. Der Browser hebt das Feld Startdatum hervor und zeigt ein Warnsymbol an. Wenn Sie den Mauszeiger auf das Warnsymbol setzen, wird eine Nachricht angezeigt, die besagt, dass das Startdatum vor dem Enddatum liegen muss.
      The result of the coach validation.
    2. Setzen Sie das Enddatum auf ein Datum, das nach dem Startdatum liegt. Klicken Sie auf OK. Der Benutzerservice wird erfolgreich beendet, weil beide Daten jetzt gültig sind.