Freigeben über

Xrm.Page.data.process (clientseitige Referenz)

  • Artikel

 

Veröffentlicht: November 2016

Gilt für: Dynamics CRM 2015

In Microsoft Dynamics CRM 2015 und Microsoft Dynamics CRM Online 2015-Update stellt der Xrm.Page.data.process-Namespace Ereignisse, Objekte und Methoden zum Interagieren mit den Geschäftsprozessflussdaten in einem Formular bereit.

Siehe Xrm.Page.ui.process (clientseitige Referenz) für Methoden, um mit der Geschäftsprozessflusssteuerung im Formular zu interagieren.

Xrm.Page.data.process-Methoden

  • ActiveProcess-Methoden
    Verwenden SiegetActiveProcess, um Informationen zu dem aktiven Prozess abzurufen, und setActiveProcess, um einen anderen Prozess als aktiven Prozess festzulegen.

  • ActiveStage-Methoden
    Verwenden Sie getActiveStage, um Informationen zur aktiven Phase abzurufen, und setActiveStage, um eine abgeschlossene Phase als aktive Phase festzulegen.

    Mit Microsoft Dynamics CRM Online 2015-Update 1 können Sie setActiveStage für eine Phase in einer anderen Entität verwenden.

  • getActivePath
    Verwenden Sie diese Methode, um eine Sammlung von Phasen zu erhalten, die derzeit im aktiven Pfad sind, mit Methoden, um mit den Phasen zu interagieren, die in der Geschäftsprozessflusssteuerung angezeigt werden.

    Der aktive Pfad stellt die Phasen dar, die aktuell in der Prozesssteuerung anhand der Verzweigungsregeln und den aktuellen Daten im Datensatz gerendert werden.

  • getEnabledProcesses
    Verwenden Sie diese Methode, um die aktivierten Geschäftsprozessflüsse asynchron abzurufen, zu denen der Benutzer für eine Entität wechseln kann.

  • getSelectedStage
    Verwenden Sie diese Methode, die zu Microsoft Dynamics CRM Online 2015-Update 1 hinzugefügt wurde, um auf die derzeit ausgewählten Phase zugreifen.

  • Möglichkeiten zum Verwalten von Ereignishandlern
    Verwenden Sie die addOnStageChange-, removeOnStageChange-, addOnStageSelected- und removeOnStageSelected-Methoden, um Ereignishandler für die Geschäftsprozessflusssteuerung hinzufügen oder zu entfernen.

  • Navigationsmethoden
    Verwenden Sie moveNext, um in die nächste Phase überzugehen, und movePrevious, um zur vorherigen Phase zu überzugehen.

    Mit Microsoft Dynamics CRM Online 2015-Update 1 können Sie movePrevious für eine vorherige Phase in einer anderen Entität verwenden.

  • Prozessmethoden
    Verwenden Sie Prozessmethoden, um auf Eigenschaften des Prozesses zuzugreifen.

  • Stage methods
    Verwenden Sie Phasenmethoden, um auf Eigenschaften der Phase in einem Geschäftsprozessfluss zuzugreifen.

  • Schrittmethoden
    Verwenden Sie Schrittmethoden, um auf Eigenschaften des Schritts in einer Phase in einem Geschäftsprozessfluss zuzugreifen.

ActiveProcess-Methoden

Verwenden SiegetActiveProcess, um Informationen zu dem aktiven Prozess abzurufen, und setActiveProcess, um einen anderen Prozess als aktiven Prozess festzulegen.

getActiveProcess

Gibt ein Process-Objekt zurück, das den aktiven Prozess darstellt.

var activeProcess = Xrm.Page.data.process.getActiveProcess();

  • Rückgabewert
    Typ: Process

    Anmerkungen: Die Methoden, um auf die Eigenschaften des zurückgegebenen Prozesses zuzugreifen finden Sie unter Prozessmethoden.

setActiveProcess

Legen Sie ein Process als aktiven Prozess fest.

Xrm.Page.data.process.setActiveProcess(processId, callbackFunction);

Parameter:

  • processId
    Typ:String

    Anmerkungen: Die ID des Prozesses, der zum aktiven Prozess gemacht werden soll.

  • callbackFunction
    Typ:Function

    Anmerkungen: Eine Funktion, die aufgerufen wird, wenn der Vorgang abgeschlossen ist. Dieser Rückruffunktion wird einer der folgenden Zeichenfolgenwerte übergeben, um anzuzeigen, ob der Vorgang erfolgreich war.

    Wert

    Beschreibung

    Erfolgreich.

    Der Vorgang war erfolgreich.

    Ungültig

    processId ist nicht gültig oder der Prozess ist nicht aktiviert.

ActiveStage-Methoden

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

getActiveStage

Gibt ein Stage-Objekt zurück, das die aktiven Phase darstellt.

var activeStage = Xrm.Page.data.process.getActiveStage();

  • Rückgabewert
    Typ: Phase

    Anmerkungen: Die Methoden, um auf die Eigenschaften der zurückgegebenen Phase zuzugreifen, finden Sie unter Stage methods.

setActiveStage

Legen Sie eine abgeschlossene Phase als aktive Phase fest.

Hinweis

Mit Microsoft Dynamics CRM Online 2015-Update 1 können Sie diese Methode für eine Phase in einer anderen Entität verwenden.

Nur eine abgeschlossene Phase für die Entität kann mithilfe dieser Methode festgelegt werden.

Xrm.Page.data.process.setActiveStage(stageId, callbackFunction);

Parameter:

  • stageId
    Typ:String

    Anmerkungen: Die ID der abgeschlossenen Phase für die Entität, die zur aktiven Phase gemacht werden soll.

  • callbackFunction
    Typ:Function

    Anmerkungen: Eine optionale Funktion, die aufgerufen wird, wenn der Vorgang abgeschlossen ist.

    Der Rückruffunktion wird ein Zeichenfolgenwert "success" übergeben, wenn der Vorgang erfolgreich abgeschlossen ist.

    Wenn stageId eine Phase darstellt, die nicht gültig ist, wird die Phase nicht aktiviert, und der Rückruffunktion wird ein Zeichenfolgenwert, der den Grund angibt, übergeben. Die Werte, die in der folgenden Tabelle aufgeführt sind, können zurückgegebenen werden.

    Wert

    Grund

    crossEntity

    Die Phase muss eine für die aktuelle Entität sein.

    invalid

    Es gibt drei Gründe, weshalb dieser Wert zurückgegeben werden kann:

    • Der Parameter stageId ist ein nicht-bestehender Phasen-ID-Wert.

    • Die aktive Phase ist nicht die ausgewählte Phase

    • Der Datensatz ist noch nicht gespeichert.

    unreachable

    Die Phase befindet sich in einem anderen Pfad.

    dirtyForm

    Dieser Wert wird zurückgegeben, wenn die Daten auf der Seite nicht gespeichert werden.

    Wichtig

    Diese Methode kann nur verwendet werden, wenn die ausgewählte Phase und die aktive Phase identisch sind. Wenn Ihr Code von OnStageChange-Ereignis initiiert wird, wird die aktuelle Phase ausgewählt. Wenn Ihr Code von OnStageSelected-Ereignis initiiert wird, sollten Sie Xrm.Page.data.process.getActiveStage verwenden, um zu überprüfen, ob die ausgewählten Phase auch die aktive Phase ist. Für ein anderes Formularereignis ist es nicht möglich, zu ermitteln, welche Phase derzeit ausgewählt ist. Zur Erzielung optimaler Ergebnisse sollte diese Methode nur in Code verwendet werden, der in Funktionen verwendet wird, die von OnStageChange und OnStageSelected initiiert werden.

getActivePath

Verwenden Sie diese Methode, um eine Sammlung von Phasen zu erhalten, die derzeit im aktiven Pfad sind, mit Methoden, um mit den Phasen zu interagieren, die in der Geschäftsprozessflusssteuerung angezeigt werden.

Der aktive Pfad stellt die Phasen dar, die aktuell in der Prozesssteuerung anhand der Verzweigungsregeln und den aktuellen Daten im Datensatz gerendert werden.

var stageCollection = Xrm.Page.data.process.getActivePath();

Beispiel:

Siehe Beispiel: Xrm.Page.data.process.getActivePath für ein Beispiel mit dieser Methode.

  • Rückgabewert
    Typ: Sammlung

    Remarks: Eine Sammlung aller abgeschlossenen Phasen, die derzeit aktive Phase und der vorausgesagte Satz der zukünftigen Phasen anhand der erfüllten Bedingungen in der Verzweigungsregel. Dies ist kann eine Teilmenge der Phasen sein, die mit Xrm.Page.data.process. getActiveProcess zurückgegeben werden, da es nur die Phasen enthält, die einen gültigen Übergang von der aktuellen Phase darstellt, basierend auf der Verzweigung, die im Prozess aufgetreten ist.

getEnabledProcesses

Verwenden Sie diese Methode, um die aktivierten Geschäftsprozessflüsse asynchron abzurufen, zu denen der Benutzer für eine Entität wechseln kann.

Xrm.Page.data.process.getEnabledProcesses(callbackFunction(enabledProcesses));

  • Parameter
    Typ:Function

    Anmerkungen: Die Rückruffunktion muss einen Parameter akzeptieren, der ein Objekt mit Wörterbucheigenschaften enthält, in denen der Name der Eigenschaft die ID des Geschäftsprozessflusses ist und der Wert der Eigenschaft der Name des Geschäftsprozessflusses ist.

    Die aktivierten Prozesse werden in Übereinstimmung mit den Rechten des Benutzers gefiltert. Die Liste der aktivierten Prozesse ist die gleiche, die ein Benutzer in der Ui sehen kann, wenn er den Prozess manuell ändern möchte.

    Beispiel:

    Siehe Beispiel: Xrm.Page.data.process.getEnabledProcesses für ein Beispiel mit dieser Methode.

getSelectedStage

Verwenden Sie diese Methode, um die derzeit ausgewählte Phase abzurufen.

Xrm.Page.data.process.getSelectedStage()

  • Rückgabewert
    Typ: Phase

    Die aktuell ausgewählte Phase.

  • Anmerkungen
    Diese Methode wurde für Microsoft Dynamics CRM Online 2015-Update 1 hinzugefügt

    Siehe Stage methods für die Methoden, um auf die Eigenschaften der zurückgegebenen Phase zuzugreifen.

Möglichkeiten zum Verwalten von Ereignishandlern

Verwenden Sie diese Methoden, um Ereignishandler für die Geschäftsprozessflusssteuerung hinzufügen oder zu entfernen.

addOnStageChange

Verwenden Sie dies, um eine Funktion als Ereignishandler für als OnStageChange-Ereignis hinzuzufügen, damit es aufgerufen wird, wenn die Geschäftsprozessflussphase sich ändert.

Xrm.Page.data.process.addOnStageChange(handler);

  • Parameter
    Typ: -Funktionsverweis

    Remarks: Die Funktion wird unten auf der Ereignishandlerpipeline hinzugefügt. Der Ausführungskontext wird automatisch festgelegt als der erste Parameter, der an den Ereignishandler übergeben wird. Weitere Informationen finden Sie unter Ausführungskontext (clientseitige Referenz).

    Sie sollten einen Verweis auf eine benante Funktion anstelle einer anonymen Funktion verwenden, wenn Sie später den Ereignishandler entfernen möchten.

removeOnStageChange

Verwenden Sie dies, um eine Funktion als Ereignishandler für als OnStageChange-Ereignis zu entfernen.

Xrm.Page.data.process.removeOnStageChange(handler);

  • Parameter
    Typ: -Funktionsverweis

    Remarks: Wenn eine anonyme Funktion mithilfe der addOnStageChange-Methode festgelegt wurde, kann sie nicht mithilfe dieser Methode entfernt werden.

addOnStageSelected

Verwenden Sie dies, um eine Funktion als Ereignishandler für als OnStageSelected-Ereignis hinzuzufügen, damit es aufgerufen wird, wenn die Geschäftsprozessflussphase ausgewählt wird.

Xrm.Page.data.process.addOnStageSelected(handler);

  • Parameter
    Typ: -Funktionsverweis

    Remarks: Die Funktion wird unten auf der Ereignishandlerpipeline hinzugefügt. Der Ausführungskontext wird automatisch festgelegt als der erste Parameter, der an den Ereignishandler übergeben wird. Weitere Informationen finden Sie unter Ausführungskontext (clientseitige Referenz).

    Sie sollten einen Verweis auf eine benante Funktion anstelle einer anonymen Funktion verwenden, wenn Sie später den Ereignishandler entfernen möchten.

removeOnStageSelected

Verwenden Sie dies, um eine Funktion als Ereignishandler für als OnStageSelected-Ereignis zu entfernen.

Xrm.Page.data.process.removeOnStageSelected(function reference);

  • Parameter
    Typ: -Funktionsverweis

    Remarks: Wenn eine anonyme Funktion mithilfe der addOnStageSelected-Methode festgelegt wurde, kann sie nicht mithilfe dieser Methode entfernt werden.

Verwenden Sie moveNext, um in die nächste Phase überzugehen, und movePrevious, um zur vorherigen Phase zu überzugehen. Beide Methoden verursachen, dass ein OnStageChange-Ereignis auftritt.

moveNext

Geht zur nächsten Phase weiter.

Xrm.Page.data.process.moveNext(callbackFunction);

  • Parameter
    Typ: Funktion

    Anmerkungen: Eine optionale Funktion, die aufgerufen wird, wenn der Vorgang abgeschlossen ist. Dieser Rückruffunktion wird einer der folgenden Zeichenfolgenwerte übergeben, um anzuzeigen, ob der Vorgang erfolgreich war.

    Wert

    Beschreibung

    Erfolgreich.

    Der Vorgang war erfolgreich.

    crossEntity

    Die nächste Phase ist für eine andere Entität.

    Ende

    Die aktive Phase ist die letzte Phase des aktiven Pfads.

    Ungültig

    Der Vorgang ist fehlgeschlagen, da die ausgewählte Phase nicht dieselbe ist wie die aktive Phase.

    dirtyForm

    Dieser Wert wird zurückgegeben, wenn die Daten auf der Seite nicht gespeichert werden.

Wichtig

Diese Methode kann nur verwendet werden, wenn die ausgewählte Phase und die aktive Phase identisch sind. Wenn Ihr Code von OnStageChange-Ereignis initiiert wird, wird die aktuelle Phase ausgewählt. Wenn Ihr Code von OnStageSelected-Ereignis initiiert wird, sollten Sie Xrm.Page.data.process.getActiveStage verwenden, um zu überprüfen, ob die ausgewählten Phase auch die aktive Phase ist. Für ein anderes Formularereignis ist es nicht möglich, zu ermitteln, welche Phase derzeit ausgewählt ist. Zur Erzielung optimaler Ergebnisse sollte diese Methode nur in Code verwendet werden, der in Funktionen verwendet wird, die von OnStageChange und OnStageSelected initiiert werden.

movePrevious

Geht zur vorigen Phase zurück. Mit Microsoft Dynamics CRM Online 2015-Update 1 können Sie movePrevious für eine vorherige Phase in einer anderen Entität verwenden.

Xrm.Page.data.process.movePrevious(callbackFunction);

  • Parameter
    Typ: Funktion

    Anmerkungen: Eine optionale Funktion, die aufgerufen wird, wenn der Vorgang abgeschlossen ist. Dieser Rückruffunktion wird einer der folgenden Zeichenfolgenwerte übergeben, um anzuzeigen, ob der Vorgang erfolgreich war.

    Wert

    Beschreibung

    Erfolgreich.

    Der Vorgang war erfolgreich.

    crossEntity

    Die vorherige Phase ist für eine andere Entität.

    Beginnend

    Die aktive Phase ist die erste Phase des aktiven Pfads.

    Ungültig

    Der Vorgang ist fehlgeschlagen, da die ausgewählte Phase nicht dieselbe ist wie die aktive Phase.

    dirtyForm

    Dieser Wert wird zurückgegeben, wenn die Daten auf der Seite nicht gespeichert werden.

Wichtig

Diese Methode kann nur verwendet werden, wenn die ausgewählte Phase und die aktive Phase identisch sind. Wenn Ihr Code von OnStageChange-Ereignis initiiert wird, wird die aktuelle Phase ausgewählt. Wenn Ihr Code von OnStageSelected-Ereignis initiiert wird, sollten Sie Xrm.Page.data.process.getActiveStage verwenden, um zu überprüfen, ob die ausgewählten Phase auch die aktive Phase ist. Für ein anderes Formularereignis ist es nicht möglich, zu ermitteln, welche Phase derzeit ausgewählt ist. Zur Erzielung optimaler Ergebnisse sollte diese Methode nur in Code verwendet werden, der in Funktionen verwendet wird, die von OnStageChange und OnStageSelected initiiert werden.

Hinweis

Mit Microsoft Dynamics CRM Online 2015-Update 1 können Sie diese Methode zum Zurückkehren zu einer Phase für eine andere Entität verwenden.

Prozessmethoden

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

getId

Gibt den eindeutigen Bezeichner des Prozesses zurück.

var processId = procObj.getId();

  • Rückgabewert
    Typ:String

    Anmerkungen: Wert, der die Zeichenfolgendarstellung eines GUID-Werts darstellt.

getName

Gibt den Namen des Prozesses zurück.

var processName = procObj.getName();
  • Rückgabewert
    Typ:String

getStages

Gibt eine Sammlung von Phasen des Prozesses zurück.

var stageCollection = procObj.getStages();

  • Rückgabewert
    Typ: Sammlung

    Siehe Stage methods für die Methoden, um auf die Eigenschaften der zurückgegebenen Phasen zuzugreifen.

isRendered

Gibt true zurück, wenn der Vorgang gerendert wird, false, wenn nicht.

var processRendered = procObj.isRendered();

Stage methods

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

getCategory

Gibt ein Objekt mit einer getValue-Methode zurück, die den ganzzahligen Wert der Geschäftsprozessflusskategorie zurückgibt.

var stageCategoryNumber = stageObj.getCategory().getValue();

getEntityName

Gibt den logischen Name der Entität zurück, die dieser Phase zugeordnet ist.

var stageEntityName = stageObj.getEntityName();
  • Rückgabewert
    Typ:String

getId

Gibt den eindeutigen Bezeichner der Phase zurück.

var stageId = stageObj.getId();
  • Rückgabewert
    Typ:String

getName

Gibt den Namen der Phase zurück.

var stageName = stageObj.getName();
  • Rückgabewert
    Typ:String

getStatus

Gibt den Status der Phase zurück.

var stageStatus = stageObj.getStatus();

  • Rückgabewert
    Typ:String

    Anmerkungen: Diese Methode gibt entweder active oder inactive zurück.

getSteps

Gibt eine Sammlung von Schritten der Phase zurück.

var stepsCollection = stageObj.getSteps();

  • Rückgabewert
    Typ:Array

    Siehe Schrittmethoden für Methoden, um auf die Eigenschaftswerte Methoden des Schritts zuzugreifen.

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.

getAttribute

Gibt den logischen Name des Attributs zurück, die dem Schritt zugeordnet ist.

var stepAttributeName = stepObj.getAttribute();

  • Rückgabewert
    Typ:String

    Anmerkungen: Einige Schritte enthalten keinen Attributwert.

getName

Gibt den Namen des Workflowschritts zurück.

var stepName = stepObj.getName();
  • Rückgabewert
    Typ:String

isRequired

Gibt zurück, ob der Schritt im Geschäftsprozessfluss erforderlich ist.

var stepIsRequired = stepObj.isRequired();

  • Rückgabewert
    Typ:Boolean

    Anmerkungen: Gibt true zurück, wenn der Schritt im Geschäftsprozessflusseditor als erforderlich markiert ist; andernfalls false. Es gibt keine Verbindung zwischen diesem Wert und den Werten, die Sie in den RequiredLevel-Attribut Xrm.Page.data.entity-Methoden ändern können.

Siehe auch

Schreiben von Skripts für Geschäftsprozessflüsse
Xrm.Page.ui.process (clientseitige Referenz)
Cclientseitige Programmierreferenz
Kurzübersicht zum Formularskripting
Schreiben von Code für Microsoft Dynamics CRM 2015-Formulare
Verwenden des Xrm.Page-Objektmodells
Beispiel: Xrm.Page.data.process.getEnabledProcesses
Beispiel: Xrm.Page.data.process.getActivePath

© 2017 Microsoft. Alle Rechte vorbehalten. Copyright