getEnabledProcesses (Referencia da API do cliente)

Recupera de forma asíncrona os fluxos de proceso de negocio habilitados para unha táboa á que o usuario actual pode cambiar.

Sintaxe

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

Parámetro

Nome	Tipo	Obrigatorio	Descripción
callbackFunction	Función	Si	A función de devolución de chamada debe aceptar un parámetro que conteña un obxecto con propiedades de dicionario onde o nome da propiedade é o Id do fluxo do proceso de negocio e o valor da propiedade é o nome do fluxo do proceso de negocio. Os procesos habilitados son filtrados segundo os privilexios do usuario. A lista de procesos habilitados é a mesma que un usuario pode ver na interface de usuario se quere cambiar o proceso manualmente.

Exemplo

A función Sdk.formOnLoad no exemplo usa o método formContext.data.process.getEnabledProcesses para recuperar de forma asíncrona información sobre os fluxos de procesos de negocio que están habilitados para a táboa. A mostra pasa unha función anónima como primeiro parámetro. Esta función execútase de forma asíncrona cando se devolven os datos e os datos pasan como parámetro á función anónima.

A información sobre o fluxo do proceso de negocio habilitado fornécese como un obxecto de dicionario onde o ID do proceso é o nome da propiedade e o nome do fluxo do proceso de negocio é o valor da propiedade. O código de exemplo procesa esta información e establece os valores nunha matriz global Sdk.enabledProcesses á que se accede mediante a lóxica que se executa máis tarde. A mostra tamén percorre os valores da matriz Sdk.enabledProcesses e usa a función Sdk.writeToConsole para escribir información sobre os fluxos de procesos de negocio recuperados na consola.

Nota

A función Sdk.formOnLoad na biblioteca JavaScript de exemplo debe establecerse como o xestor de eventos OnLoad para un formulario, e a caixa de verificación Pasar o contexto de execución como primeiro parámetro debe ser seleccionada no diálogo Propiedades do xestador .
Ademais, esta mostra só ilustra o uso dalgúns dos métodos na API formContext.data.process . Non representa o uso desta API para cumprir un requisito empresarial; Só se pretende demostrar como se pode acceder aos valores das propiedades clave no código.

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

Cando executas esta mostra coas ferramentas de desenvolvemento do navegador abertas, o seguinte é un exemplo da saída escrita na consola para unha táboa con varios fluxos de procesos de negocio habilitados.

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

Artigos relacionados

setActiveProcessInstance
formContext.data.process