Share via

Xrm.Page.data.process (clientreferentie)

  • Artikel

 

Gepubliceerd: november 2016

Is van toepassing op: Dynamics CRM 2015

Met Microsoft Dynamics CRM 2015 en Microsoft Dynamics CRM Online 2015 Update, biedt de Xrm.Page.data.process-naamruimte gebeurtenissen, methoden en objecten voor interactie met de bedrijfsprocesstroomgegevens in een formulier.

Zie Xrm.Page.ui.process (clientreferentie) voor methoden voor interactie met de bedrijfsprocesstroombesturing in het formulier.

Methoden van Xrm.Page.data.process

  • ActiveProcess-methoden
    Gebruik getActiveProcess om informatie over het actieve proces op te halen en setActiveProcess om een ander proces in te stellen als actief proces.

  • ActiveStage-methoden
    Gebruik getActiveStage om informatie over de actieve fase op te halen en setActiveStage om een voltooide fase in te stellen als actieve fase.

    Met Update 1 voor Microsoft Dynamics CRM Online 2015 kunt u setActiveStage gebruiken voor een fase in een andere entiteit.

  • getActivePath
    Gebruik deze methode om een verzameling van fasen in het actieve pad op te halen met methoden voor interacties met de fasen die worden weergegeven in de bedrijfsprocesstroombesturing.

    Het actieve pad vertegenwoordigt fasen die momenteel worden weergegeven in de procesbesturing op basis van de vertakkingsregels en actuele gegevens in de record.

  • getEnabledProcesses
    Gebruik deze methode om op asynchrone wijze de ingeschakelde bedrijfsprocesstromen op te halen waarnaar de gebruiker kan overschakelen voor een entiteit.

  • getSelectedStage
    Toegevoegd met Update 1 voor Microsoft Dynamics CRM Online 2015, gebruik deze methode om toegang te krijgen tot de huidige geselecteerde fase.

  • Methoden om gebeurtenishandlers te beheren
    Gebruik de methoden addOnStageChange, removeOnStageChange, addOnStageSelected en removeOnStageSelected om gebeurtenishandlers voor de bedrijfsprocesstroombesturing toe te voegen of te verwijderen.

  • Navigatiemethoden
    Gebruik moveNext om naar de volgende fase te gaan en movePrevious om naar de vorige fase te gaan.

    Met Update 1 voor Microsoft Dynamics CRM Online 2015 kunt u movePrevious gebruiken voor een vorige fase in een andere entiteit.

  • Procesmethoden
    Gebruik procesmethoden om toegang te krijgen tot eigenschappen van het proces.

  • Fasemethoden
    Gebruik fasemethoden aan toegang te krijgen tot eigenschappen van de fase in een bedrijfsprocesstroom.

  • Stapmethoden
    Gebruik stapmethoden aan toegang te krijgen tot eigenschappen van de stap in een fase van een bedrijfsprocesstroom.

ActiveProcess-methoden

Gebruik getActiveProcess om informatie over het actieve proces op te halen en setActiveProcess om een ander proces in te stellen als actief proces.

getActiveProcess

Retourneert een Process-object dat het actieve proces vertegenwoordigt.

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

  • Retourwaarde
    Type: Proces

    Opmerkingen: Zie Procesmethoden voor de methoden om toegang te krijgen tot de eigenschappen van het geretourneerde proces.

setActiveProcess

Stel een Process in als actief proces.

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

Parameters:

  • processId
    Type:String

    Opmerkingen: De id van het proces om het actieve proces te maken.

  • callbackFunction
    Type:Function

    Opmerkingen: Een functie die moet worden aangeroepen als de bewerking is voltooid. Aan deze terugbelfunctie wordt een van de volgende tekenreekswaarden doorgegeven om aan te geven of de bewerking is geslaagd.

    Waarde

    Beschrijving

    geslaagd

    De bewerking is geslaagd.

    ongeldig

    De processId is niet geldig of het proces is niet ingeschakeld.

ActiveStage-methoden

Gebruik getActiveStage om informatie over de actieve fase op te halen en setActiveStage om een andere fase in te stellen als actieve fase.

getActiveStage

Retourneert een Stage-object dat de actieve fase vertegenwoordigt.

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

  • Retourwaarde
    Type: Fase

    Opmerkingen: Zie Fasemethoden voor de methoden om toegang te krijgen tot de eigenschappen van de geretourneerde fase.

setActiveStage

Stel een voltooide fase in als actieve fase.

Notitie

Met Update 1 voor Microsoft Dynamics CRM Online 2015 kunt u deze methode gebruiken voor een vorige fase in een andere entiteit.

Alleen een voltooide fase voor de entiteit kan worden ingesteld met deze methode.

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

Parameters:

  • stageId
    Type:String

    Opmerkingen: De id van de voltooide fase voor de entiteit waarvan de actieve fase moet worden gemaakt.

  • callbackFunction
    Type:Function

    Opmerkingen: Een optionele functie die moet worden aangeroepen als de bewerking is voltooid.

    Aan de terugbelfunctie wordt een tekenreekswaarde van "success" doorgegeven als de bewerking met succes is voltooid.

    Als de stageId een fase vertegenwoordigt die niet geldig is, wordt de fase niet actief gemaakt en geeft de callbackfunctie een tekenreekswaarde door die de reden aangeeft. De waarden uit de volgende tabel kunnen worden geretourneerd.

    Waarde

    Reden

    crossEntity

    De fase moet voor de huidige entiteit zijn.

    invalid

    Er zijn drie redenen waarom deze waarde kan worden geretourneerd:

    • De parameter stageId is een niet-bestaande fase-id.

    • De actieve fase is niet de geselecteerde fase

    • De record is nog niet opgeslagen.

    unreachable

    De fase bestaat op een ander pad.

    dirtyForm

    Deze waarde wordt geretourneerd als de gegevens op de pagina niet worden opgeslagen.

    Belangrijk

    Deze methode kan alleen worden gebruikt wanneer de geselecteerde fase en de actieve fase hetzelfde zijn. Wanneer de code wordt geïnitieerd vanuit Gebeurtenis OnStageChange, wordt de huidige fase geselecteerd. Wanneer de code wordt geïnitieerd vanuit Gebeurtenis OnStageSelected, moet u Xrm.Page.data.process.getActiveStage gebruiken om te controleren of de geselecteerde fase ook de actieve fase is. Voor elke andere formuliergebeurtenis is het niet mogelijk te bepalen welke fase op het moment is geselecteerd. Voor de beste resultaten moet deze methode alleen worden gebruikt in code die wordt aangeroepen in functies die worden geïnitieerd door de gebeurtenissen OnStageChange en OnStageSelected.

getActivePath

Gebruik deze methode om een verzameling van fasen in het actieve pad op te halen met methoden voor interacties met de fasen die worden weergegeven in de bedrijfsprocesstroombesturing.

Het actieve pad vertegenwoordigt fasen die momenteel worden weergegeven in de procesbesturing op basis van de vertakkingsregels en actuele gegevens in de record.

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

Voorbeeld:

Zie Voorbeeld: Xrm.Page.data.process.getActivePath voor een voorbeeld van het gebruik van deze methode.

  • Retourwaarde
    Type: Verzameling

    Remarks: Een verzameling van alle voltooide fasen, de momenteel actieve fase en de voorspelde reeks toekomstige fasen op basis van voorwaarden waaraan wordt voldaan in de vertakkingsregel. Dit kan een subset van de fasen zijn die worden geretourneerd met **Xrm.Page.data.process.**getActiveProcess omdat alleen die fasen worden opgenomen die een geldige overgang van de huidige fase vertegenwoordigen op basis van vertakking die heeft plaatsgevonden in het proces.

getEnabledProcesses

Gebruik deze methode om op asynchrone wijze de ingeschakelde bedrijfsprocesstromen op te halen waarnaar de gebruiker kan overschakelen voor een entiteit.

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

  • Parameter
    Type:Function

    Opmerkingen: De callbackfunctie moet een parameter accepteren die een object met woordenlijsteigenschappen bevat waarbij de naam van de eigenschap de id van de bedrijfsprocesstroom is en de waarde van de eigenschap de naam van de bedrijfsprocesstroom.

    De ingeschakelde processen worden gefilterd op basis van de bevoegdheden van de gebruiker. De lijst met ingeschakelde processen is dezelfde als een gebruiker kan zien in de gebruikersinterface als deze het proces handmatig wil wijzigen.

    Voorbeeld:

    Zie Voorbeeld: Xrm.Page.data.process.getEnabledProcesses voor een voorbeeld van het gebruik van deze methode.

getSelectedStage

Gebruik deze methode om de huidige geselecteerde fase op te halen.

Xrm.Page.data.process.getSelectedStage()

  • Retourwaarde
    Type: Fase

    De huidige geselecteerde fase.

  • Opmerkingen
    Deze methode werd toegevoegd voor Update 1 voor Microsoft Dynamics CRM Online 2015.

    Zie Fasemethoden voor de methoden om toegang te krijgen tot de eigenschappen van de geretourneerde fase.

Methoden om gebeurtenishandlers te beheren

Gebruik deze methoden om gebeurtenishandlers voor de bedrijfsprocesstroombesturing toe te voegen of te verwijderen.

addOnStageChange

Gebruik deze om een functie toe te voegen als gebeurtenishandler voor de Gebeurtenis OnStageChange zodat deze wordt aangeroepen wanneer de bedrijfsprocesstroomfase verandert.

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

  • Parameter
    Type: functiereferentie

    Remarks: De functie wordt aan de onderkant van de pipeline van de gebeurtenishandler toegevoegd. De uitvoeringscontext wordt automatisch ingesteld als die eerste parameter die aan de gebeurtenishandler wordt doorgegeven. Zie Uitvoeringscontext (clientreferentie) voor meer informatie.

    U moet een verwijzing naar een benoemde functie gebruiken in plaats van een anonieme functies als u de gebeurtenishandler later wellicht wilt verwijderen.

removeOnStageChange

Gebruik deze om een functie als gebeurtenismanager voor de Gebeurtenis OnStageChange te verwijderen.

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

  • Parameter
    Type: functiereferentie

    Remarks: Als een anonieme functie is ingesteld met de methode addOnStageChange, kan deze niet worden verwijderd met deze methode.

addOnStageSelected

Gebruik deze om een functie toe te voegen als gebeurtenishandler voor de Gebeurtenis OnStageSelected zodat deze wordt aangeroepen wanneer een bedrijfsprocesstroomfase wordt geselecteerd.

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

  • Parameter
    Type: functiereferentie

    Remarks: De functie wordt aan de onderkant van de pipeline van de gebeurtenishandler toegevoegd. De uitvoeringscontext wordt automatisch ingesteld als die eerste parameter die aan de gebeurtenishandler wordt doorgegeven. Zie Uitvoeringscontext (clientreferentie) voor meer informatie.

    U moet een verwijzing naar een benoemde functie gebruiken in plaats van een anonieme functies als u de gebeurtenishandler later wellicht wilt verwijderen.

removeOnStageSelected

Gebruik deze om een functie als gebeurtenismanager voor de Gebeurtenis OnStageSelected te verwijderen.

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

  • Parameter
    Type: functiereferentie

    Remarks: Als een anonieme functie is ingesteld met de methode addOnStageSelected, kan deze niet worden verwijderd met deze methode.

Gebruik moveNext om naar de volgende fase te gaan en movePrevious om naar de vorige fase te gaan. Beide methoden leiden tot de Gebeurtenis OnStageChange.

moveNext

Gaat verder naar de volgende fase.

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

  • Parameter
    Type: Functie

    Opmerkingen: Een optionele functie die moet worden aangeroepen als de bewerking is voltooid. Aan deze terugbelfunctie wordt een van de volgende tekenreekswaarden doorgegeven om aan te geven of de bewerking is geslaagd.

    Waarde

    Beschrijving

    geslaagd

    De bewerking is geslaagd.

    crossEntity

    De volgende fase is voor een andere entiteit.

    einde

    De actieve fase is de laatste fase van het actieve pad.

    ongeldig

    De bewerking is mislukt omdat de geselecteerde fase niet hetzelfde is als de actieve fase.

    dirtyForm

    Deze waarde wordt geretourneerd als de gegevens op de pagina niet worden opgeslagen.

Belangrijk

Deze methode kan alleen worden gebruikt wanneer de geselecteerde fase en de actieve fase hetzelfde zijn. Wanneer de code wordt geïnitieerd vanuit Gebeurtenis OnStageChange, wordt de huidige fase geselecteerd. Wanneer de code wordt geïnitieerd vanuit Gebeurtenis OnStageSelected, moet u Xrm.Page.data.process.getActiveStage gebruiken om te controleren of de geselecteerde fase ook de actieve fase is. Voor elke andere formuliergebeurtenis is het niet mogelijk te bepalen welke fase op het moment is geselecteerd. Voor de beste resultaten moet deze methode alleen worden gebruikt in code die wordt aangeroepen in functies die worden geïnitieerd door de gebeurtenissen OnStageChange en OnStageSelected.

movePrevious

Gaat naar de vorige fase. Met Update 1 voor Microsoft Dynamics CRM Online 2015 kunt u movePrevious gebruiken voor een vorige fase in een andere entiteit.

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

  • Parameter
    Type: Functie

    Opmerkingen: Een optionele functie die moet worden aangeroepen als de bewerking is voltooid. Aan deze terugbelfunctie wordt een van de volgende tekenreekswaarden doorgegeven om aan te geven of de bewerking is geslaagd.

    Waarde

    Beschrijving

    geslaagd

    De bewerking is geslaagd.

    crossEntity

    De vorige fase is voor een andere entiteit.

    begin

    De actieve fase is de eerste fase van het actieve pad.

    ongeldig

    De bewerking is mislukt omdat de geselecteerde fase niet hetzelfde is als de actieve fase.

    dirtyForm

    Deze waarde wordt geretourneerd als de gegevens op de pagina niet worden opgeslagen.

Belangrijk

Deze methode kan alleen worden gebruikt wanneer de geselecteerde fase en de actieve fase hetzelfde zijn. Wanneer de code wordt geïnitieerd vanuit Gebeurtenis OnStageChange, wordt de huidige fase geselecteerd. Wanneer de code wordt geïnitieerd vanuit Gebeurtenis OnStageSelected, moet u Xrm.Page.data.process.getActiveStage gebruiken om te controleren of de geselecteerde fase ook de actieve fase is. Voor elke andere formuliergebeurtenis is het niet mogelijk te bepalen welke fase op het moment is geselecteerd. Voor de beste resultaten moet deze methode alleen worden gebruikt in code die wordt aangeroepen in functies die worden geïnitieerd door de gebeurtenissen OnStageChange en OnStageSelected.

Notitie

Met Update 1 voor Microsoft Dynamics CRM Online 2015 kunt u deze methode gebruiken om terug te gaan naar een fase voor een andere entiteit.

Procesmethoden

Een proces bevat de gegevens voor een bedrijfsprocesstroom. Gebruik de methoden om toegang te krijgen tot eigenschappen van het proces.

getId

Retourneert de unieke id van het proces.

var processId = procObj.getId();

  • Retourwaarde
    Type:String

    Opmerkingen: De waarde vertegenwoordigt de tekenreeksweergave van een GUID-waarde.

getName

Retourneert de naam van het proces.

var processName = procObj.getName();
  • Retourwaarde
    Type:String

getStages

Retourneert een verzameling fasen in het proces

var stageCollection = procObj.getStages();

  • Retourwaarde
    Type: Verzameling

    Zie Fasemethoden voor de methoden om toegang te krijgen tot de eigenschappen van de geretourneerde fasen.

isRendered

Retourneert waar als het proces wordt weergegeven, onwaar als dat niet het geval is

var processRendered = procObj.isRendered();

Fasemethoden

Een fase bevat de gegevens voor een fase in een bedrijfsprocesstroom. Gebruik de methoden om toegang te krijgen tot eigenschappen van de fase.

getCategory

Retourneert een object met een methode getValue die de geheel-getalwaarde van de bedrijfsprocesstroomcategorie retourneert.

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

getEntityName

Retouneert de logische naam van de entiteit die aan de fase is gekoppeld.

var stageEntityName = stageObj.getEntityName();
  • Retourwaarde
    Type:String

getId

Retourneert de unieke id van de fase

var stageId = stageObj.getId();
  • Retourwaarde
    Type:String

getName

Retourneert de naam van de fase

var stageName = stageObj.getName();
  • Retourwaarde
    Type:String

getStatus

Retourneert de status van de fase

var stageStatus = stageObj.getStatus();

  • Retourwaarde
    Type:String

    Opmerkingen: Deze methode retournteert active of inactive.

getSteps

Retourneert een verzameling stappen in de fase.

var stepsCollection = stageObj.getSteps();

  • Retourwaarde
    Type:Array

    Zie Stapmethoden voor methoden om toegang te krijgen tot de eigenschapswaarden van de stap.

Stapmethoden

Een stap bevat de gegevens voor een stap in een fase van een bedrijfsprocesstroom. Gebruik de methoden om toegang te krijgen tot eigenschappen van de stap.

getAttribute

Retouneert de logische naam van het kenmerk dat aan de stap is gekoppeld.

var stepAttributeName = stepObj.getAttribute();

  • Retourwaarde
    Type:String

    Opmerkingen: Sommige stappen bevatten geen kenmerkwaarde.

getName

Retourneert de naam van de stap.

var stepName = stepObj.getName();
  • Retourwaarde
    Type:String

isRequired

Retourneert of de stap is vereist in de bedrijfsprocesstroom.

var stepIsRequired = stepObj.isRequired();

  • Retourwaarde
    Type:Boolean

    Opmerkingen: Retourneert true als de stap is gemarkeerd als vereist in de bedrijfsprocesstroomeditor, anders false. Er is geen verbinding tussen deze waarde en de waarden die u kunt wijzigen in de Xrm.Page.data.entity kenmerkRequiredLevel-methoden.

Zie ook

Scripts schrijven voor bedrijfsprocesstromen
Xrm.Page.ui.process (clientreferentie)
Programmeerreferentie op de client
Beknopte naslag voor het opstellen van formulierscripts
Code schrijven voor Microsoft Dynamics CRM 2015-formulieren
Het objectmodel Xrm.Page gebruiken
Voorbeeld: Xrm.Page.data.process.getEnabledProcesses
Voorbeeld: Xrm.Page.data.process.getActivePath

© 2017 Microsoft. Alle rechten voorbehouden. Auteursrecht