JavaScript-API für Entwicklung clientseitiger Benutzerservices

Verwenden Sie die folgenden Referenzinformationen, um mehr über die clientseitigen JavaScript -Systemvariablen zu erfahren, die in Designer für die Entwicklung clientseitiger Benutzerservices verfügbar sind.

Diese Variablen werden bei der Ausführung des clientseitigen Benutzerservice mit Werten gefüllt und geben den Status des Systems zu diesem Zeitpunkt wieder. Diese Variablen sind nicht dazu vorgesehen, innerhalb des clientseitigen Benutzerservice aktualisiert zu werden.

Zusätzliche Systemdaten sind durch Aufrufen eines Service verfügbar, der die Systemvariablen, an denen Sie interessiert sind, abruft und an den clientseitigen Benutzerservice zurückgibt.

Einschränkung: Beachten Sie, dass alle tw.* Variablen, die in der folgenden Tabelle aufgelistet sind, nur für JavaScript-Scripts für clientseitige Benutzerservices gelten und nicht in Scripts für Coaches und Ansichten verwendet werden können, wie z. B. integrierte JavaScript-Ansichten, eingeschlossene Scripts für Ansichten, Scripts für benutzerdefinierte Ansichtsereignisse, Sichtbarkeit nach Script, Instanzereignisse anzeigen usw. Der Coach-bezogene JavaScript-Code wird im Laufzeitkontext des Coachs ausgeführt, der nicht mit dem Kontext des clientseitigen Benutzerservice identisch ist, und kann daher nicht auf das Objekt tw zugreifen, das nur im Kontext des clientseitigen Benutzerservice verfügbar ist.

Tabelle 1. JavaScript -Systemvariablen, die in Designer für die Entwicklung clientseitiger Benutzerservices verfügbar sind
Variabel	Beschreibung
tw.constants.`ECMServerNames`	Servernamen, die in Inhaltsintegrationsschritten verwendet werden können.
tw.constants.`ECMServerNames`.IBM_BPM_CONTENT_STORE	Der Servername für den Content Store.
tw.constants.`ECMServerNames`.IBM_BPM_DOCUMENT_STORE	Der Servername für den Dokumentspeicher.
tw.`Umgebung`	Der Namensbereich für den Zugriff auf die Werte von Umgebungsvariablen in dem Kontext, unter dem der clientseitige Benutzerservice aufgerufen wurde. Die Variable muss mit dem clientseitigen Benutzerservice verknüpft werden.
tw.`env`.toolkit	Der Namensbereich für den Zugriff auf die Werte von Umgebungsvariablen im Kontext des angegebenen Toolkits. Die Umgebungsvariable, die im Toolkit definiert ist, muss mit dem clientseitigen Benutzerservice verknüpft werden.
tw.`epv`	Der Namensbereich für den Zugriff auf die Werte von EPV-Variablen in dem Kontext, unter dem der clientseitige Benutzerservice aufgerufen wurde. Die EPV-Variable muss mit dem clientseitigen Benutzerservice verknüpft werden.
tw.`epv`.toolkit	Der Namensbereich für den Zugriff auf die Werte von EPV-Variablen im Kontext des angegebenen Toolkits. Der EPV-Wert, der im Toolkit definiert ist, muss mit dem clientseitigen Benutzerservice verknüpft werden.
tw.`Fehler`	Der Namensbereich, der Informationen zu dem zuletzt abgefangenen Fehler bereitstellt.
tw.`Fehler`.code	Der Code des zuletzt abgefangenen Fehlers.
tw.`Fehler`.data	Daten zu dem zuletzt abgefangenen Fehler, die einer lokalen Variablen zugeordnet werden können.
tw.`error`.message	Eine Nachricht zu dem aufgetretenen Fehler, die die App oder der clientseitige Benutzerservice dem Endbenutzer von einem Coach anzeigen kann.
Eigenschafttw.resource.`lrname`.	Der Namensbereich für den Zugriff auf Lokalisierungsressourcen in JavaScript-Scripts für clientseitige Benutzerservices. In der Syntax steht `name_der_lokalisierungsressource` für den Namen einer Lokalisierungsressource und `eigenschaft` für einen Eigenschaftsnamen. Beispielsweise erzeugt `tw.resource.LR1.ant` die Übersetzung der Eigenschaft `ant` in der Lokalisierungsressource `LR1`.
tw.system.coachUtils.getLocallyChangedVars()	Gibt ein Array von Variablennamen zurück, die seit dem Ausführungsbeginn des Coachs geändert wurden. Diese Methode kann nur in einem Handler für Datenänderungsereignisse verwendet werden.
tw.system.coachUtils.hasLocallyChangedInputVars()	Gibt `true` zurück, wenn die Eingabevariablenwerte im Coach seit Beginn der Ausführung geändert wurden. Diese Methode kann nur in einem Handler für Datenänderungsereignisse verwendet werden.
tw.system.coachUtils.hasLocallyChangedOutputVars()	Gibt `true` zurück, wenn die Ausgabevariablenwerte im Coach seit Beginn der Ausführung geändert wurden. Diese Methode kann nur in einem Handler für Datenänderungsereignisse verwendet werden.
tw.system.coachUtils.hasLocallyChangedPrivateVars()	Gibt `true` zurück, wenn die privaten Variablenwerte im Coach seit Beginn der Ausführung geändert wurden. Diese Methode kann nur in einem Handler für Datenänderungsereignisse verwendet werden.
tw.system.coachValidation	Die Prüfungsergebnisse für Variablen, die an Ansichten in einem Coach dieses clientseitigen Benutzerservice gebunden sind.
tw.system.coachValidation.addValidationError(`variablenname`, errorMessage)	Fügt eine Fehlernachricht für eine gebundene Variable zu der Liste der Gültigkeitsfehler hinzu. Wenn die Liste bereits eine Nachricht für den `Variablenname`enthält, wird die Nachricht ersetzt. Der `Variablenname` ist die vollständig qualifizierte Variable (z. B. `tw.local.variable1`). Die `Fehlernachricht` ist die Nachricht, die von der Coach-Ansicht verwendet wird, um den Gültigkeitsfehler im Coach anzuzeigen.
tw.system.coachValidation.clearValidationErrors()	Entfernt alle Gültigkeitsfehler in der Liste.
tw.system.coachValidation.populateFromBOSaveFailedError(boSaveFailedError)	Extrahiert die Fehlernachrichten für die einzelnen Eigenschaften im angegebenen Fehler `BOSaveFailedError` und fügt diese zur Liste der Gültigkeitsfehler hinzu. Wenn für eine bestimmte Eigenschaft mehrere Nachrichten über Gültigkeitsprüfungen vorhanden sind, wird die in der Liste zuletzt aufgeführte Nachricht verwendet.
tw.system.coachValidation.removeValidationError(`variablenname`)	Entfernt den Gültigkeitsfehler für den angegebenen Variablennamen, wenn ein Gültigkeitsfehler vorliegt.
tw.system.coachValidation.updateValidationErrorMessage(`variablenname`, errorMessage)	Aktualisiert den Gültigkeitsfehler für den Variablennamen, der mit der neuen Fehlernachricht geliefert wird. Gibt `true` zurück, wenn ein Gültigkeitsfehler aktualisiert wurde. Gibt `false` zurück, wenn kein Gültigkeitsfehler für den Variablennamen vorliegt.
tw.system.coachValidation.validationErrors	Die Liste der Gültigkeitsfehler für gebundene Variablen. Zum Aktualisieren der Liste müssen die Funktionen von `tw.system.coachValidation` verwendet werden.
tw.system.dataChangeUtils	Dienstprogrammfunktionen, die Sie für die Verarbeitung von Datenaktualisierungen vom Server verwenden. Diese Methode kann nur in einem Handler für Datenänderungsereignisse verwendet werden.
tw.system.dataChangeUtils.applyAllIncomingVars()	Wendet die Werte aller auf dem Server aktualisierten Variablen auf den Client an. Diese Methode kann nur in einem Handler für Datenänderungsereignisse verwendet werden.
tw.system.dataChangeUtils.applyIncomingVar(`variableName`)	Wendet den Wert der auf dem Server aktualisierten Variablen auf den Client an. Diese Methode kann nur in einem Handler für Datenänderungsereignisse verwendet werden.
tw.system.dataChangeUtils.getIncomingVars()	Gibt ein Objekt zurück, das die Variablen mit auf dem Server aktualisierten Werten enthält, die noch nicht auf den Client angewendet wurden. Diese Methode kann nur in einem Handler für Datenänderungsereignisse verwendet werden.
tw.system`.processApp`	Die Workflowautomation oder das Toolkit, das den clientseitigen Benutzerservice enthält.
tw.system.processApp.`Akronym`	Das Akronym der Workflowautomatisierung oder des Toolkits, das den clientseitigen Benutzerservice enthält
tw.system.processApp.`ID`	Die ID der Workflowautomatisierung oder des Toolkits mit dem clientseitigen Benutzerservice.
tw.system.processApp.`Name`	Der Name der Workflowautomatisierung oder des Toolkits mit dem clientseitigen Benutzerservice.
tw.system.processApp.`Momentaufnahme`	Die Version der Workflowautomatisierung oder des Toolkits mit dem clientseitigen Benutzerservice.
tw.system.processApp.`Momentaufnahme`.`ID`	Die ID der Version der Workflowautomatisierung oder des Toolkits mit dem clientseitigen Benutzerservice.
tw.system.processApp.`Momentaufnahme`.`Name`	Der Name der Version der Workflowautomatisierung oder des Toolkits mit dem clientseitigen Benutzerservice. Diese Variable gilt nur, wenn die Version eine benannte Versionist.
tw.system`.processInstance`	Die Prozessinstanz, in der dieser clientseitige Benutzerservice ausgeführt wird. Diese Variable wird nur angewendet, wenn der clientseitige Benutzerservice in einer Prozessinstanz ausgeführt wird.
tw.system`.processInstance.atRiskDate`	Das Datum, an dem diese Prozessinstanz überfällig werden könnte. Diese Angabe wird als JavaScript-Datumsobjekt bereitgestellt.
tw.system`.processInstance.caseFolderId` (veraltet)	Veraltet. Verwenden Sie stattdessen `processInstanceFolderId`. Die Kennung des Ordners, der der Prozessinstanz zugeordnet ist, in der dieser clientseitige Benutzerservice ausgeführt wird. Diese Variable wird nur angewendet, wenn der clientseitige Benutzerservice in einer Prozessinstanz ausgeführt wird.
tw.system`.processInstance.caseFolderServerName` (veraltet)	Veraltet. Verwenden Sie stattdessen `processInstanceFolderServerName` . Der Name des Servers, der der Instanz zugeordnet ist, in der dieser clientseitige Benutzerservice ausgeführt wird.
tw.system`.processInstance.dueDate`	Das Datum, an dem diese Prozessinstanz abgeschlossen sein sollte. Diese Angabe wird als JavaScript-Datumsobjekt bereitgestellt.
tw.system`.processInstance.processInstanceFolderId`	Die ID des Fallordners, der der Prozessinstanz zugeordnet ist. Er ersetzt das nicht weiter unterstützte `caseFolderId`.
tw.system`.processInstance.processInstanceFolderServerName`	Der Name des Servers, der dem Fallordner für die Prozessinstanz zugeordnet ist. Er ersetzt das nicht weiter unterstützte `caseFolderServerName`.
tw.system`.prozessInstanz.id`	Die ID der Prozessinstanz, in der dieser clientseitige Benutzerservice ausgeführt wird.
tw.system`.processInstance.name`	Der Name der Prozessinstanz, in der dieser clientseitige Benutzerservice ausgeführt wird.
tw.system`.processInstance.parentCase.caseId`	Die ID des übergeordneten Falls, der der Prozessinstanz zugeordnet ist.
tw.system`.processInstance.parentCase.caseServerId`	Die ID des Servers, der der übergeordneten Fallinstanz zugeordnet ist. Nicht zur Anzeige für Endbenutzer vorgesehen.
tw.system`.processInstance.parentCase.parentActivityId`	Die ID der übergeordneten Aktivität, die der Prozessinstanz zugeordnet ist.
tw.system`.processInstance.process`	Der Prozess für die Prozessinstanz, in der dieser clientseitige Benutzerservice ausgeführt wird.
tw.system`.processInstance`.process`.description`	Die Beschreibung des Prozesses für die Prozessinstanz, in der dieser clientseitige Benutzerservice ausgeführt wird.
tw.system`.processInstance`.process`.name`	Der Name des Prozesses für die Prozessinstanz, in der dieser clientseitige Benutzerservice ausgeführt wird.
tw.system`.processInstance.processApp`	Die Workflowautomatisierung oder das Toolkit, das die Prozessinstanz enthält, in der dieser clientseitige Benutzerservice ausgeführt wird.
tw.system`.processInstance.processApp.acronym`	Das Akronym der Workflowautomatisierung oder des Toolkits mit der Prozessinstanz, in der dieser clientseitige Benutzerservice ausgeführt wird.
tw.system`.processInstance.processApp.id`	Die ID der Workflowautomatisierung oder des Toolkits mit der Prozessinstanz, in der dieser clientseitige Benutzerservice ausgeführt wird.
tw.system`.processInstance.processApp.name`	Der Name der Workflowautomatisierung oder des Toolkits, das die Prozessinstanz enthält, in der dieser clientseitige Benutzerservice ausgeführt wird.
tw.system`.processInstance.processApp.snapshot`	Die Version der Workflowautomatisierung oder des Toolkits mit der Prozessinstanz, in der dieser clientseitige Benutzerservice ausgeführt wird.
tw.system`.processInstance.processApp`.snapshot`.id`	Die ID der Version der Workflowautomatisierung oder des Toolkits, die die Prozessinstanz enthält, in der dieser clientseitige Benutzerservice ausgeführt wird.
tw.system`.processInstance.processApp`.snapshot`.name`	Der Name der Version der Workflowautomatisierung oder des Toolkits, die die Prozessinstanz enthält, in der dieser clientseitige Benutzerservice ausgeführt wird. Diese Variable gilt nur, wenn die Version eine benannte Versionist.
tw.system`.processInstance.startDate`	Das Datum, an dem diese Prozessinstanz gestartet wurde. Diese Angabe wird als JavaScript-Datumsobjekt bereitgestellt.
tw.system`.processInstance.startingDocumentId`	Die ID des Dokuments, das die Prozessinstanz gestartet hat, in der dieser clientseitige Benutzerservice ausgeführt wird.
tw.system`.processInstance.startingDocumentServerName`	Der Name des Servers, der das Dokument enthält, das die Prozessinstanz gestartet hat, in der dieser clientseitige Benutzerservice ausgeführt wird.
tw.system`.processInstance.task`	Die Task in der Prozessinstanz, in der dieser clientseitige Benutzerservice ausgeführt wird.
tw.system`.processInstance`.task`.atRiskDate`	Das Datum, an dem diese Task überfällig werden könnte. Diese Angabe wird als JavaScript-Datumsobjekt bereitgestellt.
tw.system`.processInstance`.task`.dueDate`	Das Datum, an dem diese Task abgeschlossen sein sollte. Diese Angabe wird als JavaScript-Datumsobjekt bereitgestellt.
tw.system`.processInstance`.task`.enablingDocumentId`	Die ID des Dokuments, das die Prozessinstanz aktiviert hat, in der dieser clientseitige Benutzerservice ausgeführt wird.
tw.system`.processInstance`.task`.enablingDocumentServerName`	Der Name des Servers, der das Dokument enthält, das die Benutzertaskaktivität in dem Prozess aktiviert hat, den dieser clientseitige Benutzerservice implementiert.
tw.system`.processInstance`.task`.id`	Die ID der Task in der Prozessinstanz, in der dieser clientseitige Benutzerservice ausgeführt wird.
tw.system`.processInstance`.task`.narrative`	Die Beschreibung für die Task in der Prozessinstanz, in der dieser clientseitige Benutzerservice ausgeführt wird. Die Beschreibung ist in Workplacesichtbar.
tw.system`.processInstance`.task`.originator`	Der Name des Benutzers, von dem diese Task stammt. Dabei handelt es sich entweder um den vorherigen Eigner der Task oder den Benutzer, der die Prozessinstanz gestartet hat.
tw.system`.processInstance`.task`.owner`	Der Name des Benutzers, der dieser Task zugeordnet ist.
tw.system`.processInstance`.task`.priority`	Die Priorität der Task in Form eines Zeichenfolgewerts. Mögliche Werte: Lowest (Sehr niedrig), Low (Niedrig), Normal (Normal), High (Hoch), Highest (Höchste).
tw.system`.processInstance`.task`.priorityValue`	Die Priorität der Task in Form eines ganzzahligen Werts. Mögliche Werte: 50, 40, 30, 20, 10.
tw.system.`processInstance`.task.`processActivityDescription`	Die Beschreibung der Prozessaktivität, die der Task zugeordnet ist.
tw.system.`processInstance`.task.`processActivityRichDescription`	Die Rich-Text-Beschreibung der Prozessaktivität, die mit der Aufgabe verbunden ist.
tw.system.`processInstance`.task.`processActivityName`	Der Name der Prozessaktivität, die der Task zugeordnet ist.
tw.system`.processInstance`.task`.startDate`	Das Datum, an dem die Task gestartet wurde. Diese Angabe wird als JavaScript-Datumsobjekt bereitgestellt.
tw.system`.processInstance`.task`.startingDocumentId`	Die ID des Dokuments, das die Prozessinstanz gestartet hat, in der dieser clientseitige Benutzerservice ausgeführt wird.
tw.system`.processInstance`.task`.status`	Der Status der Task in Form eines Zeichenfolgewerts.
tw.system`.processInstance`.task`.subject`	Der beschreibende Betreff für die Task in der Prozessinstanz, in der dieser clientseitige Benutzerservice ausgeführt wird. Das Thema ist in Workplacesichtbar.
tw.system.url.`bpmDataEndpoint`	Der REST-Endpunkt, der zum Abrufen von Daten zu Tasks, Dashboards, Prozessen und startbaren Services verwendet wird.
tw.system.url.`userInfoEndpunkt`	Der REST-Endpunkt, der zum Bereitstellen von Benutzerprofilinformationen wie Avatar, Jobbezeichnung usw. verwendet wird. Siehe Das Kontextobjekt.
tw.system.`Benutzer`	Der Eigner der Task in dem Prozess, den dieser clientseitige Benutzerservice implementiert. Andernfalls der Benutzer, von dem der clientseitige Benutzerservice eingeleitet wurde.
tw.system`.user.baseTextDirection`	Eine Variable, die die Textrichtung steuert. Sie wird zur Unterstützung bidirektionaler Sprachen verwendet.
tw.system`.user.fullName`	Der vollständige Name des Taskeigners, wenn dieser clientseitige Benutzerservice in einer Prozessinstanz ausgeführt wird. Andernfalls der vollständige Name des Benutzers, von dem der clientseitige Benutzerservice eingeleitet wurde.
tw.system.`benutzer`.`id`	Die ID des Taskeigners, wenn dieser clientseitige Benutzerservice in einer Prozessinstanz ausgeführt wird. Andernfalls die ID des Benutzers, von dem der clientseitige Benutzerservice gestartet wurde.
tw.system.`Benutzer`.`Ländereinstellung`	Die Ländereinstellung des Benutzers wie in den Benutzervorgaben angegeben. Der Wert wird als Zeichenfolge bereitgestellt.
tw.system`.user.localeDescription`	Ein Text zur Beschreibung der Ländereinstellung des Benutzers.
tw.system.`Benutzer`.`verwaltet`	Ein Array der Teams, die von diesem Benutzer verwaltet werden.
tw.system.`benutzer`.verwaltet [i].`id`	Die ID eines Teams, das von diesem Benutzer verwaltet wird.
tw.system.`benutzer`.verwaltet [i].`name`	Der Name eines Teams, das von diesem Benutzer verwaltet wird.
tw.system`.user`.manages[i]`.tkShortName`	Das Toolkit-Akronym eines Teams, das von diesem Benutzer verwaltet wird.
tw.system.`Benutzer`.`Name`	Der Name des Taskeigners, wenn dieser clientseitige Benutzerservice in einer Prozessinstanz ausgeführt wird. Andernfalls der Name des Benutzers, von dem der clientseitige Benutzerservice gestartet wurde.
tw.system.`Benutzer`.`Teams`	Ein Array der Teams, denen der Benutzer angehört.
tw.system.`benutzer`.teams [i].`id`	Die ID eines Teams, dem der Benutzer angehört.
tw.system.`Benutzer`.teams [i].`Name`	Der Name eines Teams, dem der Benutzer angehört.
tw.system`.user`.teams[i]`.tkKurzname`	Das Toolkit-Akronym für ein Team, dem der Benutzer angehört.