getEnabledProcesses (klient-API-reference)

Asynkront henter de forretningsprocesforløb, der er aktiveret for en tabel, som den aktuelle bruger kan skifte til.

Syntaks

formContext.data.process.getEnabledProcesses(callbackFunction(enabledProcesses));

Parameter

Navn	Type	Påkrævet	Beskrivelse
callbackFunction	Funktion	Ja	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 i henhold til brugerens rettigheder. Listen over aktiverede processer er de samme, som en bruger kan se i brugergrænsefladen, hvis vedkommende vil ændre processen manuelt.

Eksempel

Funktionen Sdk.formOnLoad i eksemplet bruger metoden formContext.data.process.getEnabledProcesses til asynkront at hente oplysninger om forretningsprocesforløb, der er aktiveret for tabellen. Eksemplet overfører en anonym funktion som den første parameter. Denne funktion udføres asynkront, når dataene returneres, og dataene overføres som parameteren til den anonyme funktion.

Oplysningerne om aktiverede forretningsprocesforløb leveres som et ordbogsobjekt, hvor id'et for processen er navnet på egenskaben, og navnet på forretningsprocesforløbet er værdien af egenskaben. Eksempelkoden behandler disse oplysninger og angiver værdierne i en global SDK.enabledProcesses-matrix , der skal tilgås af logik, der udføres senere. Eksemplet gennemgår også værdierne i matrixen Sdk.enabledProcesses og bruger funktionen Sdk.writeToConsole til at skrive oplysninger om de hentede forretningsprocesforløb til konsollen.

Notat

Funktionen Sdk.formOnLoad i JavaScript-eksempelbiblioteket skal angives som OnLoad-hændelseshandleren for en formular, og afkrydsningsfeltet Overfør udførelseskontekst som den første parameter skal være markeret i dialogboksen Egenskaber for handler.
Dette eksempel illustrerer også blot brugen af nogle af metoderne i API'en formContext.data.process . Den repræsenterer ikke brug af denne API til at opfylde et forretningskrav. Det er kun beregnet til at vise, hvordan nøgleegenskabsværdierne kan tilgås i kode.

//A namespace defined for SDK sample code
//You should define a unique namespace for your libraries
var Sdk = window.Sdk || {};
(function () {
    //A global variable to store information about enabled business processes after they are retrieved asynchronously
    this.enabledProcesses = [];

    // A function to log messages while debugging only
    this.writeToConsole = function (message) {
        if (typeof console != 'undefined')
        { console.log(message); }
    };

    // Code to run in the OnLoad event 
    this.formOnLoad = function (executionContext) {
        // Retrieve the formContext
        var formContext = executionContext.getFormContext();

        // Retrieve Enabled processes
        formContext.data.process.getEnabledProcesses(function (processes) {
            //Move processes to the global Sdk.enabledProcesses array;
            for (var processId in processes) {
                Sdk.enabledProcesses.push({ id: processId, name: processes[processId] })
            }
            Sdk.writeToConsole("Enabled business processes flows retrieved and added to Sdk.enabledProcesses array.");

            //Write the values of the Sdk.enabledProcesses array to the console
            if (Sdk.enabledProcesses.length < 0) {
                Sdk.writeToConsole("There are no enabled business process flows for this table.");
            }
            else {
                Sdk.writeToConsole("These are the enabled business process flows for this table:");
                for (var i = 0; i < Sdk.enabledProcesses.length; i++) {
                    var enabledProcess = Sdk.enabledProcesses[i];
                    Sdk.writeToConsole("id: " + enabledProcess.id + " name: " + enabledProcess.name)
                }
            }

            //Any code that depends on the Sdk.enabledProcesses array needs to be initiated here

        });
    };

}).call(Sdk);

Når du kører dette eksempel med browserudviklerværktøjerne åbne, er følgende et eksempel på outputtet, der er skrevet til konsollen for en tabel med flere forretningsprocesforløb aktiveret.

Enabled business processes flows retrieved and added to Sdk.enabledProcesses array.
These are the enabled business process flows for this table:
id: 7994be68-899e-4a40-8d18-f5c3b6940188 name: Sample Lead Process
id: 919e14d1-6489-4852-abd0-a63a6ecaac5d name: Lead to Opportunity Sales Process

Relaterede artikler

setActiveProcessInstance
formContext.data.process