getEnabledProcesses (referència de l'API del client)

Recupera de manera asíncrona els fluxos del procés de negoci habilitats per a una taula a la qual l'usuari actual pot canviar.

Sintaxi

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

Paràmetre

Nom	Type	Necessari	Descripció
callbackFunction	Function	Sí	La funció de devolució de trucada ha d'acceptar un paràmetre que contingui un objecte amb propietats de diccionari on el nom de la propietat és l'identificador del flux del procés de negoci i el valor de la propietat és el nom del flux del procés de negoci. Els processos habilitats es filtren segons els privilegis de l'usuari. La llista de processos habilitats és la mateixa que un usuari pot veure a la interfície d'usuari si vol canviar el procés manualment.

Exemple

La funció Sdk.formOnLoad de l'exemple utilitza el mètode formContext.data.process.getEnabledProcesses per recuperar de manera asíncrona informació sobre els fluxos del procés de negoci habilitats per a la taula. L'exemple passa una funció anònima com a primer paràmetre. Aquesta funció s'executa de manera asíncrona quan es retornen les dades i les dades es passen com a paràmetre a la funció anònima.

La informació sobre el flux del procés de negoci habilitat es proporciona com un objecte de diccionari on l'identificador del procés és el nom de la propietat i el nom del flux del procés de negoci és el valor de la propietat. El codi d'exemple processa aquesta informació i defineix els valors d'una matriu global Sdk.enabledProcesses a la qual accedeix la lògica que s'executa més endavant. L'exemple també recorre els valors de la matriu Sdk.enabledProcesses i utilitza la funció Sdk.writeToConsole per escriure informació sobre els fluxos del procés de negoci recuperats a la consola.

Nota

La funció Sdk.formOnLoad de la biblioteca JavaScript d'exemple s'ha d'establir com a controlador d'incidències OnLoad per a un formulari i s'ha de seleccionar la casella de selecció Passar el context d'execució com a primer paràmetre al diàleg Propietats del gestor .
A més, aquest exemple només il·lustra l'ús d'alguns dels mètodes de l'API formContext.data.process . No representa utilitzar aquesta API per complir un requisit empresarial; només pretén demostrar com es pot accedir als valors de les propietats clau en el codi.

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

Quan executeu aquest exemple amb les eines de desenvolupament del navegador obertes, a continuació es mostra un exemple de la sortida escrita a la consola per a una taula amb diversos fluxos de processos de negoci habilitats.

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

Articles relacionats

setActiveProcessInstance
formContext.data.process