getEnabledProcesses (Informazioni di riferimento sulle API client)

Recupera in modo asincrono i flussi di processo aziendale abilitati per una tabella a cui l'utente corrente può passare.

Sintassi

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

Parametro

Nome	TIPO	Obbligatorio	Description
callbackFunction	Funzione	Yes	La funzione di callback deve accettare un parametro che contiene un oggetto con proprietà del dizionario in cui il nome della proprietà è l'ID del flusso del processo aziendale e il valore della proprietà è il nome del processo aziendale. I processi abilitati vengono filtrati in base ai privilegi dell'utente. L'elenco dei processi abilitati è lo stesso che un utente può vedere nell'interfaccia utente se vuole modificare manualmente il processo.

Example

La funzione Sdk.formOnLoad nell'esempio usa il metodo formContext.data.process.getEnabledProcesses per recuperare in modo asincrono le informazioni sui flussi di processo aziendale abilitati per la tabella. L'esempio passa una funzione anonima come primo parametro. Questa funzione viene eseguita in modo asincrono quando vengono restituiti i dati e i dati vengono passati come parametro alla funzione anonima.

Le informazioni sul flusso di processo aziendale abilitato vengono fornite come oggetto dizionario in cui l'ID del processo è il nome della proprietà e il nome del processo aziendale è il valore della proprietà. Il codice di esempio elabora queste informazioni e imposta i valori in una matrice sdk.enabledProcesses globale a cui accede la logica che viene eseguita in un secondo momento. L'esempio esegue anche un ciclo tra i valori nella matrice Sdk.enabledProcesses e usa la funzione Sdk.writeToConsole per scrivere informazioni sui flussi di processo aziendale recuperati nella console.

Annotazioni

La funzione Sdk.formOnLoad nella libreria JavaScript di esempio deve essere impostata come gestore eventi OnLoad per un modulo e il contesto di esecuzione Pass come primo parametro casella di controllo deve essere selezionato nella finestra di dialogo Proprietà gestore .
Inoltre, questo esempio illustra solo l'uso di alcuni dei metodi nell'API formContext.data.process . Non rappresenta l'uso di questa API per soddisfare un requisito aziendale; è destinato solo a dimostrare come è possibile accedere ai valori delle proprietà chiave nel codice.

//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);

Quando si esegue questo esempio con gli strumenti di sviluppo del browser aperti, di seguito è riportato un esempio dell'output scritto nella console per una tabella con più processi aziendali abilitati.

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

Articoli correlati

setActiveProcessInstance
formContext.data.process