formContext.data.process (klient-API-referens)

Tillhandahåller händelser, metoder och objekt för att interagera med affärsprocessflödesdata i ett formulär. Se formContext.ui.process (klient-API-referens) för metoder för att interagera med affärsprocessflödeskontrollen i formuläret.

Processhändelser och händelsehanterarmetoder

Använd följande metoder för händelser och händelsehanterare för att skriva skript för affärsprocessflöden.

Event Händelsehanterarmetoder
OnPreProcessStatusChange addOnPreProcessStatusChange
removeOnPreProcessStatusChange
OnProcessStatusChange addOnProcessStatusChange
removeOnProcessStatusChange
OnPreStageChange addOnPreStageChange
removeOnPreStageChange
OnStageChange addOnStageChange
removeOnStageChange
OnStageSelected addOnStageSelected
removeOnStageSelected

Aktiva processmetoder

Använd dessa metoder för att hämta information om den aktiva processen och ange en annan process som den aktiva processen.

Namn Description
getActiveProcess Returnerar ett processobjekt som representerar den aktiva processen.
setActiveProcess Anger en process som aktiv process.

Processmetoder

En process innehåller data för ett affärsprocessflöde. Använd metoderna för att komma åt processens egenskaper.

Namn Description
getId Returnerar den unika identifieraren för processen.
getName Returnerar namnet på processen.
getStages Returnerar en samling faser i processen.
isRendered Returnerar ett booleskt värde som anger om processen återges.

ProcessInstance-metoder

Använd dessa metoder för att hämta information om alla processinstanser för en post och för att ange en processinstans som den aktiva instansen.

Namn Description
getProcessInstances Returnerar alla processinstanser för tabellposten som anropande användare har åtkomst till.
setActiveProcessInstance Anger en processinstans som den aktiva instansen.

Instansmetoder

En processinstans innehåller data för en instans av affärsprocessflödet. Använd metoderna för att komma åt egenskaperna för processinstansen.

Namn Description
getInstanceId Returnerar den unika identifieraren för processinstansen.
getInstanceName Returnerar namnet på processinstansen.
getStatus Returnerar den aktuella statusen för processinstansen.
setStatus Anger aktuell status för den aktiva processinstansen.

Aktiva stegmetoder

Använd dessa metoder för att hämta information om den aktiva fasen och ange en annan fas som den aktiva fasen.

Namn Description
getActiveStage Returnerar ett stage-objekt som representerar den aktiva fasen.
setActiveStage Anger en slutförd fas som den aktiva fasen.

Stegmetoder

En fas innehåller data för en fas i ett affärsprocessflöde. Använd metoderna för att komma åt egenskaperna för fasen.

Namn Description
getCategory Returnerar ett objekt med en getValue-metod som returnerar heltalsvärdet för affärsprocessflödeskategorin.
getEntityName Returnerar det logiska namnet på tabellen som är associerad med fasen.
getId Returnerar den unika identifieraren för fasen.
getName Returnerar namnet på fasen.
getNavigationBehavior Returnerar ett navigeringsbeteendeobjekt för en fas som kan användas för att definiera om knappen Skapa är tillgänglig för användare att skapa andra tabellposter i ett navigeringsscenario för affärsprocessflöde mellan tabeller.
getStatus Returnerar status för fasen.
getSteps Returnerar en samling steg i fasen.

Stegmetoder

Ett steg innehåller data för ett steg i ett steg i ett affärsprocessflöde. Använd metoderna för att komma åt egenskaperna för steget.

Namn Description
getAttribute Returnerar det logiska namnet på kolumnen som är associerad med steget.
getName Returnerar namnet på steget.
getProgress Returnerar förloppet för åtgärdssteget.
isRequired Returnerar ett booleskt värde som anger om steget krävs i affärsprocessflödet.
setProgress Uppdaterar förloppet för åtgärdssteget.

Använd dessa metoder för att gå vidare till nästa och föregående steg. Båda dessa metoder gör att händelsen OnStageChange inträffar.

Namn Description
moveNext Går vidare till nästa steg.
movePrevious Flyttar till föregående fas.

Andra användbara metoder

Använd dessa metoder för att hitta information om stegen i den aktiva sökvägen, aktiverade processer och valda steg.

Namn Description
getActivePath Hämtar en samling faser som för närvarande finns i den aktiva sökvägen med metoder för att interagera med de faser som visas i affärsprocessflödeskontrollen.
getEnabledProcesses Hämtar asynkront de affärsprocessflöden som är aktiverade för en tabell som den aktuella användaren kan växla till.
getSelectedStage Hämtar den markerade fasen.

formContext.ui.process (klient-API-referens)
Förstå Xrm-objektmodell
Kontroller (klient-API-referens)