Xrm.Page.data.process (klientsidereference)

 

Udgivet: januar 2017

Gælder for: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Xrm.Page.data.process-navneområdet indeholder hændelser, metoder og objekter til at interagere med forretningsprocesforløbdataene i en formular.

Se Xrm.Page.ui.process (klientsidereference) for metoder, du kan bruge til at interagere med styringen af forretningsprocesforløbet i formen.

Xrm.Page.data.process-metoder

• ActiveProcess-metoder
  Brug getActiveProcess til at hente oplysninger om den aktive proces og setActiveProcess til at angive en anden proces, som den aktive proces.

• ProcessInstance-metoder
  Brug getProcessInstances til at hente oplysninger om alle procesforekomster for en objektpost og setActiveProcessInstance til at angive en procesforekomst som den aktive forekomst.

• ActiveStage-metoder
  Brug getActiveStage til at hente oplysninger om den aktive fase og setActiveStage til at angive en fuldført fase som den aktive fase.

  Du kan bruge setActiveStage til en fase i et andet objekt.

• getActivePath
  Brug denne metode til at hente en samling faser, som i øjeblikket er i den aktive sti, med metoder til at interagere med de faser, der vises i styringen af forretningsprocesforløbet.

  Den aktive sti repræsenterer faser, der i øjeblikket er gengivet i processtyringen baseret på forgreningsregler og aktuelle data i posten.

• getEnabledProcesses
  Brug denne metode til at hente det aktiverede forretningsprocesforløb, som brugeren kan skifte til for et objekt, asynkront.

• getSelectedStage
  Brug denne metode til at få adgang til den aktuelt valgte fase.

• Metoder til at administrere hændelseshandlere
  Brug metoderne addOnStageChange, removeOnStageChange, addOnStageSelected, removeOnStageSelected, addOnProcessStatusChange og removeOnProcessStatusChange til at tilføje eller fjerne hændelseshandlere for styringen af forretningsprocesforløbet.

• Navigationsmetoder
  Brug moveNext til at flytte til næste fase og movePrevious til at flytte til den forrige fase.

  Du kan bruge movePrevious til en tidligere fase i et andet objekt.

• Procesmetoder
  Brug procesmetoder til at få adgang til egenskaberne for processen.

• Forekomstmetoder
  Brug procesforekomstmetoder til at få adgang til egenskaber for den aktuelle procesforekomst.

• Fasemetoder
  Brug fasemetoder til at få adgang til egenskaberne for fasen i et forretningsprocesforløb.

• Trinmetoder
  Brug trinmetoder til at få adgang til egenskaberne for trinnet i en fase i et forretningsprocesforløb.

ActiveProcess-metoder

Brug getActiveProcess til at hente oplysninger om den aktive proces og setActiveProcess til at angive en anden proces, som den aktive proces.

getActiveProcess

Returnerer et Process-objekt, der repræsenterer den aktive proces.

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

• Returværdi
  Type: Proces

  Bemærkninger: Se under Procesmetoder, hvilke metoder der kan få adgang til egenskaberne for processen, der returneres.

setActiveProcess

Indstil en Process som den aktive proces.

Hvis der findes en aktiv forekomst af processen, indlæses objektposten med forekomst-id'et. Hvis der er ingen aktiv forekomst af den aktuelle proces findes, oprettes der en ny procesforekomst, og objektposten indlæses med forekomst-id'et. Hvis der er flere forekomster af den aktuelle proces, indlæses posten med første forekomst af den aktive proces ifølge standardlogikken, der er den senest anvendte procesforekomst pr. bruger.

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

Parametre:

• processId
  Skriv:String

  Bemærkninger: Id for processen, der bruges til at oprette den aktive proces.

• callbackFunction
  Type:Function

  Bemærkninger: En funktion, der kan kaldes, når handlingen er fuldført. Denne tilbagekaldsfunktion sendes en af følgende strengværdier for at angive, om handlingen lykkedes.

  Værdi	Beskrivelse
  fuldført	Handlingen er fuldført.
  ugyldig	Den processId er ikke gyldigt, eller processen blev ikke aktiveret.

ProcessInstance-metoder

Brug getProcessInstances til at hente oplysninger om alle procesforekomster for en objektpost og setActiveProcessInstance til at angive en procesforekomst som den aktive forekomst.

Bemærk

Disse metoder blev introduceret i December 2016 – opdatering til Dynamics 365 (online og det lokale miljø).

getProcessInstances

Returnerer alle procesforekomster for den objektpost, som den kaldende bruger har adgang til.

Xrm.Page.data.process.getProcessInstances(callbackFunction(object));

• Parameter
  Skriv:Function

  Bemærkninger: Tilbagekaldsfunktionen får overført et objekt med følgende attributter og deres tilsvarende værdier som nøglen: værdipar.

  • CreatedOn

  • ProcessDefinitionID

  • ProcessDefinitionName

  • ProcessInstanceID

  • ProcessInstanceName

  • StatusCodeName

  Procesforekomsterne filtreres ifølge brugerens rettigheder.

setActiveProcessInstance

Angiver en procesforekomst som den aktive forekomst.

Xrm.Page.data.process.setActiveProcessInstance(processInstanceId, callbackFunction);

Parametre:

• processInstanceId
  Skriv:String

  Bemærkninger: Det id for procesforekomsten, som skal indstilles som den aktive forekomst.

• callbackFunction
  Skriv:Function

  Bemærkninger: En funktion, der kan kaldes, når handlingen er fuldført. Denne tilbagekaldsfunktion sendes en af følgende strengværdier for at angive, om handlingen lykkedes.

  Værdi	Beskrivelse
  fuldført	Handlingen er fuldført.
  ugyldig	Den processInstanceId er ikke gyldigt, eller processen blev ikke aktiveret.

ActiveStage-metoder

Brug getActiveStage til at hente oplysninger om den aktive fase og setActiveStage til at angive en anden fase som den aktive fase.

getActiveStage

Returnerer et Stage-objekt, der repræsenterer den aktive fase

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

• Returværdi
  Type: Fase

  Bemærkninger: Se under Fasemetoder, hvilke metoder der kan få adgang til egenskaberne for fasen, der returneres.

setActiveStage

Indstil en fuldført fase som den aktive fase.

Bemærk

Efter Opdatering 1 til Microsoft Dynamics CRM Online 2015 kan du bruge denne metode til at angive en fase i et andet objekt.

Kun en fuldført fase for det objekt kan defineres ved hjælp af denne metode.

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

Parametre:

• stageId
  Type:String

  Bemærkninger: Id'et for den fuldførte fase for det objekt, der skal udgøre den aktive fase.

• callbackFunction
  Type:Function

  Bemærkninger: En valgfri funktion, der kan kaldes, når handlingen er fuldført.

  Tilbagekaldsfunktionen sendes strengværdien "success", hvis handlingen fuldføres.

  Hvis stageId repræsenterer en fase, der ikke er gyldig, gøres fasen ikke aktiv, og tilbagekaldsfunktionen sendes en strengværdi, der angiver årsagen. De værdier, der er angivet i følgende tabel, kan blive returneret.

  Værdi	Årsag
  invalid	Der er tre grunde til, at denne værdi kan blive returneret: Parameteren stageId er en ikke-eksisterende værdi for fase-id. Den aktive fase er ikke den valgte fase Posten er endnu ikke blevet gemt.
  unreachable	Fasen findes på en anden sti.
  dirtyForm	Denne værdi returneres, hvis dataene på siden ikke er gemt.

  Vigtigt

  Denne metode kan kun bruges, når den valgte fase og aktive fase er den samme. Når koden startes fra d88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnStageChange, vælges den aktuelle fase. Når koden startes fra d88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnStageSelected, skal du bruge Xrm.Page.data.process.getActiveStage til at kontrollere, at den valgte fase også er den aktive fase. Ved enhver anden formularhændelse er det ikke muligt at afgøre, hvilken fase der aktuelt er valgt. For at opnå de bedste resultater bør denne metode kun bruges i kode, der kaldes i funktioner, der er startet af hændelserne OnStageChange og OnStageSelected.

getActivePath

Brug denne metode til at hente en samling faser, som i øjeblikket er i den aktive sti, med metoder til at interagere med de faser, der vises i styringen af forretningsprocesforløbet.

Den aktive sti repræsenterer faser, der i øjeblikket er gengivet i processtyringen baseret på forgreningsregler og aktuelle data i posten.

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

Eksempel:

Se Eksempel: Xrm.Page.data.process.getActivePath for et eksempel på brug af denne metode.

• Returværdi
  Type: Samling

  Remarks: En samling af alle udfyldte faser, den aktive fase og det forudberegnede sæt af fremtidige faser baseret på opfyldte betingelser i forgreningsreglen. Dette kan være en delmængde af de faser, der returneres i Xrm.Page.data.process.getActiveProcess, fordi den kun indeholder de faser, som repræsenterer en gyldig overgang fra den aktuelle fase baseret på den forgrening, der er opstået i processen.

getEnabledProcesses

Brug denne metode til at hente det aktiverede forretningsprocesforløb, som brugeren kan skifte til for et objekt, asynkront.

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

• Parameter
  Type:Function

  Bemærkninger: Tilbagekaldsfunktionen skal acceptere en parameter, der indeholder et objekt med ordbogsegenskaber, hvor navnet på egenskaben er id'et for forretningsprocesforløbet, og værdien af egenskaben er navnet på forretningsprocesforløbet.

  De aktiverede processer filtreres efter brugerens rettigheder. Listen over aktiverede processer er den samme, som en bruger kan se i brugergrænsefladen, hvis han eller hun ønsker at ændre processen manuelt.

  Eksempel:

  Se Eksempel: Xrm.Page.data.process.getEnabledProcesses for et eksempel på brug af denne metode.

getSelectedStage

Brug denne metode til at åbne den aktuelt valgte fase.

Xrm.Page.data.process.getSelectedStage()

• Returværdi
  Type: Fase

  Den aktuelt valgte fase.

• Bemærkninger
  Se under Fasemetoder, hvilke metoder der kan få adgang til egenskaberne for den fase, der returneres.

Metoder til at administrere hændelseshandlere

Brug disse metoder til at tilføje eller fjerne hændelseshandlere for styringen af forretningsprocesforløbet.

addOnStageChange

Bruges til at tilføje en funktion som en hændelseshandler for d88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnStageChange, så den bliver kaldt, når fasen i forretningsprocesforløbet ændres.

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

• Parameter
  Type: funktionsreference

  Remarks: Funktionen føjes til nederst i hændelseshandlerens pipeline. Kørselskonteksten er automatisk angivet til at være den første parameter, der sendes til hændelseshandleren. Du kan finde flere oplysninger under Kontekst for udførelse (klientsidereference).

  Du skal bruge en reference til en navngivet funktion i stedet for en anonym funktion, hvis du senere evt. vil fjerne hændelseshandleren.

removeOnStageChange

Brug denne indstilling til at fjerne en funktion som en hændelseshandler for d88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnStageChange.

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

• Parameter
  Type: funktionsreference

  Remarks: Hvis en anonym funktion indstilles ved hjælp af metoden addOnStageChange, kan den ikke fjernes ved hjælp af denne metode.

addOnStageSelected

Bruges til at tilføje en funktion som en hændelseshandler for d88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnStageSelected, så den bliver kaldt, når der vælges en fase i forretningsprocesforløbet.

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

• Parameter
  Type: funktionsreference

  Remarks: Funktionen føjes til nederst i hændelseshandlerens pipeline. Kørselskonteksten er automatisk angivet til at være den første parameter, der sendes til hændelseshandleren. Du kan finde flere oplysninger under Kontekst for udførelse (klientsidereference).

  Du skal bruge en reference til en navngivet funktion i stedet for en anonym funktion, hvis du senere evt. vil fjerne hændelseshandleren.

removeOnStageSelected

Brug denne indstilling til at fjerne en funktion som en hændelseshandler for d88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnStageSelected.

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

• Parameter
  Type: funktionsreference

  Remarks: Hvis en anonym funktion indstilles ved hjælp af metoden addOnStageSelected, kan den ikke fjernes ved hjælp af denne metode.

addOnProcessStatusChange

Bruges til at tilføje en funktion som en hændelseshandler for hændelsen d88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnProcessStatusChange, så den bliver kaldt, når statussen for forretningsprocesforløbet ændres.

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

• Parameter
  Type: funktionsreference

  Remarks: Funktionen føjes til nederst i hændelseshandlerens pipeline. Kørselskonteksten er automatisk angivet til at være den første parameter, der sendes til hændelseshandleren. Du kan finde flere oplysninger under Kontekst for udførelse (klientsidereference).

  Du skal bruge en reference til en navngivet funktion i stedet for en anonym funktion, hvis du senere evt. vil fjerne hændelseshandleren.

  Denne metode blev introduceret i December 2016 – opdatering til Dynamics 365 (online og det lokale miljø).

removeOnProcessStatusChange

Brug denne indstilling til at fjerne en funktion som en hændelseshandler for hændelsen d88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnProcessStatusChange.

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

• Parameter
  Type: funktionsreference

  Remarks: Hvis en anonym funktion indstilles ved hjælp af metoden addOnProcessStatusChange, kan den ikke fjernes ved hjælp af denne metode.

  Denne metode blev introduceret i December 2016 – opdatering til Dynamics 365 (online og det lokale miljø).

Navigationsmetoder

Brug moveNext til at flytte til næste fase og movePrevious til at flytte til den forrige fase. Begge disse metoder medfører, at d88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnStageChange finder sted.

moveNext

Går videre til næste fase.

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

• Parameter
  Type: Funktion

  Bemærkninger: En valgfri funktion, der kan kaldes, når handlingen er fuldført. Denne tilbagekaldsfunktion sendes en af følgende strengværdier for at angive, om handlingen lykkedes.

  Værdi	Beskrivelse
  fuldført	Handlingen er fuldført.
  crossEntity	Næste fase er for et andet objekt.
  slut	Den aktive fase er den sidste fase i den aktive sti.
  ugyldig	Handlingen mislykkedes, fordi den valgte fase er ikke den samme som den aktive fase.
  dirtyForm	Denne værdi returneres, hvis dataene på siden ikke er gemt.

Vigtigt

Denne metode kan kun bruges, når den valgte fase og aktive fase er den samme. Når koden startes fra d88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnStageChange, vælges den aktuelle fase. Når koden startes fra d88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnStageSelected, skal du bruge Xrm.Page.data.process.getActiveStage til at kontrollere, at den valgte fase også er den aktive fase. Ved enhver anden formularhændelse er det ikke muligt at afgøre, hvilken fase der aktuelt er valgt. For at opnå de bedste resultater bør denne metode kun bruges i kode, der kaldes i funktioner, der er startet af hændelserne OnStageChange og OnStageSelected.

movePrevious

Går til forrige fase. Du kan bruge movePrevious til en tidligere fase i et andet objekt.

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

• Parameter
  Type: Funktion

  Bemærkninger: En valgfri funktion, der kan kaldes, når handlingen er fuldført. Denne tilbagekaldsfunktion sendes en af følgende strengværdier for at angive, om handlingen lykkedes.

  Værdi	Beskrivelse
  fuldført	Handlingen er fuldført.
  crossEntity	Den forrige fase er for et andet objekt.
  begyndelse	Den aktive fase er den første fase i den aktive sti.
  ugyldig	Handlingen mislykkedes, fordi den valgte fase er ikke den samme som den aktive fase.
  dirtyForm	Denne værdi returneres, hvis dataene på siden ikke er gemt.

Vigtigt

Denne metode kan kun bruges, når den valgte fase og aktive fase er den samme. Når koden startes fra d88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnStageChange, vælges den aktuelle fase. Når koden startes fra d88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnStageSelected, skal du bruge Xrm.Page.data.process.getActiveStage til at kontrollere, at den valgte fase også er den aktive fase. Ved enhver anden formularhændelse er det ikke muligt at afgøre, hvilken fase der aktuelt er valgt. For at opnå de bedste resultater bør denne metode kun bruges i kode, der kaldes i funktioner, der er startet af hændelserne OnStageChange og OnStageSelected.

Bemærk

Du kan bruge denne metode til at returnere til en fase for et andet objekt.

Procesmetoder

En proces indeholder dataene til et forretningsprocesforløb. Brug metoderne til at få adgang til egenskaberne for processen.

getId

Returnerer det entydige id for processen.

var processId = procObj.getId();

• Returværdi
  Type:String

  Bemærkninger: Værdi repræsenterer strengrepræsentationen af en GUID-værdi.

getName

Returnerer navnet på processen

var processName = procObj.getName();

• Returværdi
  Type:String

getStages

Returnerer en samling faser i processen

var stageCollection = procObj.getStages();

• Returværdi
  Type: Samling

  Se under Fasemetoder, hvilke metoder der kan få adgang til egenskaberne for de faser, der returneres.

isRendered

Returnerer true, hvis processen gengives, og false, hvis ikke

var processRendered = procObj.isRendered();

• Returværdi
  Type:Boolean

  Bemærkninger: Hvis formularen er blevet opgraderet fra en tidligere version af Microsoft Dynamics 365 og ikke er blevet opgraderet til at bruge nye formularer, kan styringen af forretningsprocesforløbet ikke gengives.Flere oplysninger:TechNet: Opdater dine formularer til Microsoft Dynamics CRM 2013 eller Microsoft Dynamics CRM Online efterår '13

Forekomstmetoder

En procesforekomst indeholder dataene for en forekomst i forretningsprocesforløbet. Brug metoderne til at få adgang til egenskaberne for procesforekomsten.

Bemærk

Disse forekomstmetoder blev introduceret i December 2016 – opdatering til Dynamics 365 (online og det lokale miljø).

getInstanceId

Returnerer det entydige id for procesforekomsten.

Xrm.Page.data.process.getInstanceId();

• Returværdi
  Skriv:String

  Bemærkninger: Værdi repræsenterer strengrepræsentationen af en GUID-værdi.

getInstanceName

Returnerer navnet på procesforekomsten

Xrm.Page.data.process.getInstanceName();

• Returværdi
  Skriv:String

getStatus

Returnerer den aktuelle status for procesforekomsten.

Xrm.Page.data.process.getStatus();

• Returværdi
  Skriv:String

  Bemærkninger: Denne metode returnerer en af følgende værdier: active, aborted eller finished.

setStatus

Angiver den aktuelle status for den aktive procesforekomst.

Xrm.Page.data.process.setStatus(status, callbackFunction);

Parametre:

• status
  Skriv:String

  Bemærkninger: Værdierne kan være active, aborted eller finished.

• callbackFunction
  Skriv:Function

  Bemærkninger: En valgfri funktion, der kan kaldes, når handlingen er fuldført. Denne tilbagekaldsfunktion overfører den nye status som en strengværdi.

Fasemetoder

En fase indeholder dataene for en fase i et forretningsprocesforløb. Brug metoderne til at få adgang til egenskaberne for fasen.

getCategory

Returnerer et objekt med en getValue-metode, der returnerer heltalsværdien for kategorien af forretningsprocesforløbet.

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

• Returværdi
  Type:Number

  Bemærkninger: Se afe17a4a-fdca-44b4-8c14-a19ba327662e#BKMK_StageCategory for listen over mulige værdier.

getEntityName

Returnerer det logiske navn på det objekt, der er knyttet til fasen.

var stageEntityName = stageObj.getEntityName();

• Returværdi
  Type:String

getId

Returnerer det entydige id for fasen.

var stageId = stageObj.getId();

• Returværdi
  Type:String

getName

Returnerer navnet på fasen

var stageName = stageObj.getName();

• Returværdi
  Type:String

getStatus

Returnerer status for fasen

var stageStatus = stageObj.getStatus();

• Returværdi
  Type:String

  Bemærkninger: Denne metode returnerer enten active eller inactive.

getSteps

Returnerer en samling trin i fasen.

var stepsCollection = stageObj.getSteps();

• Returværdi
  Type:Array

  Se Trinmetoder for metoder til at få adgang til egenskabsværdierne for trinnet.

Trinmetoder

Et trin indeholder dataene for et trin i et forretningsprocesforløb. Brug metoderne til at få adgang til egenskaberne for trinnet.

getAttribute

Returnerer det logiske navn på den attribut, der er knyttet til trinnet.

var stepAttributeName = stepObj.getAttribute();

• Returværdi
  Type:String

  Bemærkninger: Nogle trin indeholder ikke en værdi for attributten.

getName

Returnerer navnet på trinnet.

var stepName = stepObj.getName();

• Returværdi
  Type:String

isRequired

Returnerer, om trinnet kræves i forretningsprocesforløb.

var stepIsRequired = stepObj.isRequired();

• Returværdi
  Type:Boolean

  Bemærkninger: Returnerer true, hvis trinnet er markeret som krævet i editoren for forretningsprocesforløbet, og ellers false. Der er ingen forbindelse mellem denne værdi og de værdier, du kan ændre i 6881e99b-45e4-4552-8355-2eef296f2cd8#BKMK_RequiredLevel-metoderne for attributten Xrm.Page.data.entity.

Se også

Skrive scripts til forretningsprocesforløb
Xrm.Page.ui.process (klientsidereference)
Programmeringsreference på klientsiden
Formularscripter - hurtig henvisning
Skriv kode til Microsoft Dynamics 365-formularer
Bruge Xrm.Page-objektmodel
Eksempel: Xrm.Page.data.process.getEnabledProcesses
Eksempel: Xrm.Page.data.process.getActivePath

Microsoft Dynamics 365

© 2017 Microsoft. Alle rettigheder forbeholdes. Ophavsret