formContext.data.process (Client-API-Referenz)

  • Artikel

Stellt Ereignisse, Objekte und Methoden zum Interagieren mit den Geschäftsprozessfluss-Daten in einem Formular bereit. Informationen zu Methoden, um mit der Geschäftsprozessflusssteuerung des Formulars zu interagieren finden Sie unter formContext.ui.process (Client-API-Referenz) .

Prozessereignisse und Ereignishandlermethoden

Verwenden Sie die folgenden Ereignisse und Ereignishandlermethoden, um Skripts für Geschäftsprozessflüsse zu schreiben.

Ereignis Ereignishandlermethoden
OnPreProcessStatusChange addOnPreProcessStatusChange
removeOnPreProcessStatusChange
OnProcessStatusChange addOnProcessStatusChange
removeOnProcessStatusChange
OnPreStageChange-Ereignis addOnPreStageChange
removeOnPreStageChange
OnStageChange addOnStageChange
removeOnStageChange
OnStageSelected addOnStageSelected
removeOnStageSelected

Active Process-Methoden

Verwenden Sie diese Methoden, um Informationen zu dem aktiven Prozess abzurufen, und , um einen anderen Prozess als aktiven Prozess festzulegen.

Name Beschreibung
getActiveProcess Gibt ein Prozess-Objekt zurück, das den aktiven Prozess darstellt.
setActiveProcess Legt einen Prozess als aktiven Prozess fest.

Prozessmethoden

Ein Prozess enthält die Daten eines Geschäftsprozessfluss. Verwenden Sie die Methoden, um auf Eigenschaften des Prozesses zuzugreifen.

Name Beschreibung
getId Gibt den eindeutigen Bezeichner des Prozesses zurück.
getName Gibt den Namen des Prozesses zurück.
getStages Gibt eine Sammlung von Phasen des Prozesses zurück.
isRendered Gibt eine Wert zurück, der angibt, ob der Prozess gerendert wird.

ProcessInstance-Methoden

Verwenden Sie diese Methoden, um Informationen über alle Prozessinstanzen für einen Datensatz abzurufen und um eine Prozessinstanz als aktive Instanz festzulegen.

Name Beschreibung
getProcessInstances Gibt sämtliche Prozessinstanzen für den Tabellendatensatz zurück auf den der anrufende Benutzer Zugriff hat.
setActiveProcessInstance Legt eine Prozessinstanz als aktive Instanz fest.

Instanzmethoden

Eine Prozessinstanz enthält die Daten für eine Instanz des Geschäftsprozessflusses. Verwenden Sie die Methoden, um auf Eigenschaften der Prozessinstanz zuzugreifen.

Name Beschreibung
getInstanceId Gibt den eindeutigen Bezeichner der Prozessinstanz zurück.
getInstanceName Gibt den Namen der Prozessinstanz zurück.
getStatus Gibt den aktuellen Status der Prozessinstanz zurück.
setStatus Legt den aktuellen Status der aktiven Prozessinstanz fest.

Aktive Phasenmethoden

Verwenden Sie diese Methoden, um Informationen zur aktiven Phase abzurufen, und , um eine andere Phase als aktive Phase Entität festzulegen.

Name Beschreibung
getActiveStage Gibt ein Phasen-Objekt zurück, das die aktive Phase darstellt.
setActiveStage Legt eine abgeschlossene Phase als aktive Phase fest.

Phasenmethoden

Eine Phase enthält die Daten einer Phase in einem Geschäftsprozessfluss. Verwenden Sie die Methoden, um auf Eigenschaften der Phase zuzugreifen.

Name Beschreibung
getCategory Gibt ein Objekt mit einer getValue-Methode zurück, die den ganzzahligen Wert der Geschäftsprozessflusskategorie zurückgibt.
getEntityName Gibt den logischen Namen der Tabelle zurück, die der Phase zugeordnet ist.
getId Gibt den eindeutigen Bezeichner der Phase zurück.
getName Gibt den Namen der Phase zurück.
getNavigationBehavior Gibt ein Navigationsverhaltensobjekt für eine Stufe zurück, mit dem definiert werden kann, ob die Schaltfläche Erstellen für Benutzer verfügbar ist, um andere Tabellendatensätze in einem tabellenübergreifenden Navigationsszenario Geschäftsprozessfluss erstellen.
getStatus Gibt den Status der Phase zurück.
getSteps Gibt eine Sammlung von Schritten der Phase zurück.

Schrittmethoden

Ein Schritt enthält die Daten für einen Schritt in einem Geschäftsprozessfluss. Verwenden Sie die Methoden, um auf Eigenschaften des Schritts zuzugreifen.

Name Beschreibung
getAttribute Gibt den logischen Namen der Spalte, die dem Schritt zugeordnet ist, zurück.
getName Gibt den Namen des Schritts zurück.
getProgress Gibt den Fortschritt der Funktionsstufe zurück.
isRequired Gibt einen booleschen Wert zurück, der anzeigt, ob der Schritt im Geschäftsprozessfluss erforderlich ist.
setProgress Aktualisiert den Fortschritt der Funktionsstufe.

Verwenden Sie diese Methoden, um die zu den nächsten und vorherigen Phasen zu gelangen. Diese beiden Methoden verursachen ein OnStageChange-Ereignis.

Name Beschreibung
moveNext Geht zur nächsten Phase weiter.
movePrevious Geht zur vorherigen Phase zurück.

Weitere hilfreiche Methoden

Mithilfe dieser Methoden, um Informationen zu Phasen im aktiven Pfad, zu aktivierten Prozessen und zur ausgewählten Phase zu suchen.

Name Beschreibung
getActivePath Ruft eine Sammlung von Phasen ab, die derzeit im aktiven Pfad sind und Methoden zur Interaktion mit den Phasen enthalten, die im Steuerelement für Geschäftsprozessflüsse angezeigt werden.
getEnabledProcesses Ruft asynchrom den Geschäftsprozessfluss ab, der für eine Tabelle aktiviert ist, zu der der aktuelle Benutzer wechseln kann.
getSelectedStage Ruft die aktuell ausgewählte Phase ab.

formContext.ui.process (Client-API-Referenz)
Verständnis des Xrm-Objektmodells
Steuerelemente (Client-API-Referenz)

Hinweis

Können Sie uns Ihre Präferenzen für die Dokumentationssprache mitteilen? Nehmen Sie an einer kurzen Umfrage teil. (Beachten Sie, dass diese Umfrage auf Englisch ist.)

Die Umfrage dauert etwa sieben Minuten. Es werden keine personenbezogenen Daten erhoben. (Datenschutzbestimmungen).