Bagikan melalui

getEnabledProcesses (Referensi API Klien)

Secara asinkron mengambil alur proses bisnis yang diaktifkan untuk tabel yang dapat dialihkan pengguna saat ini.

Syntax

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

Pengaturan

Nama Tipe Diperlukan Description
callbackFunction Function Yes Fungsi panggilan balik harus menerima parameter yang berisi objek dengan properti kamus di mana nama properti adalah Id alur proses bisnis dan nilai properti adalah nama alur proses bisnis.

Proses yang diaktifkan difilter sesuai dengan hak istimewa pengguna. Daftar proses yang diaktifkan adalah proses yang sama yang dapat dilihat pengguna di UI jika mereka ingin mengubah proses secara manual.

Example

Fungsi Sdk.formOnLoad dalam contoh menggunakan metode formContext.data.process.getEnabledProcesses untuk mengambil informasi secara asinkron tentang alur proses bisnis yang diaktifkan untuk tabel. Sampel meneruskan fungsi anonim sebagai parameter pertama. Fungsi ini dijalankan secara asinkron ketika data dikembalikan dan data diteruskan sebagai parameter ke fungsi anonim.

Informasi tentang alur proses bisnis yang diaktifkan disediakan sebagai objek kamus di mana Id proses adalah nama properti dan nama alur proses bisnis adalah nilai properti. Kode sampel memproses informasi ini dan mengatur nilai dalam array Sdk.enabledProcesses global untuk diakses oleh logika yang dijalankan nanti. Sampel juga mengulangi nilai dalam array Sdk.enabledProcesses , dan menggunakan fungsi Sdk.writeToConsole untuk menulis informasi tentang alur proses bisnis yang diambil ke konsol.

Nota

Fungsi Sdk.formOnLoad dalam contoh pustaka JavaScript harus diatur sebagai penanganan aktivitas OnLoad untuk formulir, dan konteks Eksekusi pass sebagai kotak centang parameter pertama harus dipilih dalam dialog Properti Handler .
Selain itu, sampel ini hanya menggambarkan penggunaan beberapa metode dalam API formContext.data.process . Ini tidak mewakili penggunaan API ini untuk memenuhi persyaratan bisnis; ini hanya dimaksudkan untuk menunjukkan bagaimana nilai properti kunci dapat diakses dalam 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);

Saat Anda menjalankan sampel ini dengan alat pengembang browser terbuka, berikut ini adalah contoh output yang ditulis ke konsol untuk tabel dengan beberapa alur proses bisnis diaktifkan.

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

setActiveProcessInstance
formContext.data.process

  • Last updated on