getActivePath (Referensi API Klien)

Mendapatkan kumpulan tahapan yang saat ini berada di jalur aktif dengan metode untuk berinteraksi dengan tahapan yang ditampilkan dalam kontrol alur proses bisnis.

Jalur aktif mewakili tahapan yang saat ini dirender dalam kontrol proses berdasarkan aturan percabangan dan data saat ini dalam rekaman.

Syntax

var stageCollection = formContext.data.process.getActivePath();

Mengembalikan Nilai

Jenis: Koleksi.

Deskripsi: Kumpulan semua tahapan yang telah selesai, tahap aktif saat ini, dan rangkaian tahap masa depan yang diprediksi berdasarkan kondisi yang puas dalam aturan percabangan. Ini mungkin merupakan subset tahapan yang dikembalikan dengan formContext.data.process. getActiveProcess karena hanya akan mencakup tahapan yang mewakili transisi yang valid dari tahap saat ini berdasarkan percabangan yang telah terjadi dalam proses.

Example

Fungsi Sdk.formOnLoad menggunakan metode formContext.data.process.getActivePath untuk mengambil kumpulan tahapan. Kemudian, kode sampel menggunakan metode forEach koleksi untuk mengulangi setiap tahap. Kode kemudian menulis properti kunci tahap ke konsol menggunakan fungsi Sdk.writeToConsole yang ditentukan dalam pustaka ini. Kode kemudian mengakses kumpulan langkah-langkah untuk setiap tahap menggunakan metode getSteps . Terakhir, sampel menggunakan metode forEach dari pengumpulan langkah untuk mengakses setiap langkah dan menulis properti kunci langkah 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 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();

        // Enumerate the stages and steps in the active path
        var activePathCollection = formContext.data.process.getActivePath();
        activePathCollection.forEach(function (stage, n) {
            Sdk.writeToConsole("Stage Index: " + n);
            Sdk.writeToConsole("Table: " + stage.getEntityName());
            Sdk.writeToConsole("StageId: " + stage.getId());
            Sdk.writeToConsole("Status: " + stage.getStatus());
            var stageSteps = stage.getSteps();
            stageSteps.forEach(function (step, i) {
                Sdk.writeToConsole("    Step Name: " + step.getName());
                Sdk.writeToConsole("    Step Column: " + step.getAttribute());
                Sdk.writeToConsole("    Step Required: " + step.isRequired());
                Sdk.writeToConsole("    ---------------------------------------")
            })
            Sdk.writeToConsole("---------------------------------------")
        });
    };
}).call(Sdk);

Saat sampel berjalan di browser, Anda dapat menggunakan alat pengembang browser untuk melihat teks yang ditulis ke konsol. Misalnya, ketika sampel ini dijalankan dalam formulir Peluang dengan Proses Penjualan Peluang, berikut ini ditulis ke konsol:

Stage Index: 0
Table: opportunity
StageId: 6b9ce798-221a-4260-90b2-2a95ed51a5bc
Status: active
    Step Name: Identify Contact
    Step Column: parentcontactid
    Step Required: false
    ---------------------------------------
    Step Name: Identify Account
    Step Column: parentaccountid
    Step Required: false
    ---------------------------------------
    Step Name: Purchase Timeframe
    Step Column: purchasetimeframe
    Step Required: false
    ---------------------------------------
    Step Name: Estimated Budget
    Step Column: budgetamount
    Step Required: false
    ---------------------------------------
    Step Name: Purchase Process
    Step Column: purchaseprocess
    Step Required: false
    ---------------------------------------
    Step Name: Identify Decision Maker
    Step Column: decisionmaker
    Step Required: false
    ---------------------------------------
    Step Name: Capture Summary
    Step Column: description
    Step Required: false
    ---------------------------------------
---------------------------------------
Stage Index: 1
Table: opportunity
StageId: 650e06b4-789b-46c1-822b-0da76bedb1ed
Status: inactive
    Step Name: Customer Need
    Step Column: customerneed
    Step Required: false
    ---------------------------------------
    Step Name: Proposed Solution
    Step Column: proposedsolution
    Step Required: false
    ---------------------------------------
    Step Name: Identify Stakeholders
    Step Column: identifycustomercontacts
    Step Required: false
    ---------------------------------------
    Step Name: Identify Competitors
    Step Column: identifycompetitors
    Step Required: false
    ---------------------------------------
---------------------------------------
Stage Index: 2
Table: opportunity
StageId: d3ca8878-8d7b-47b9-852d-fcd838790cfd
Status: inactive
    Step Name: Identify Sales Team
    Step Column: identifypursuitteam
    Step Required: false
    ---------------------------------------
    Step Name: Develop Proposal
    Step Column: developproposal
    Step Required: false
    ---------------------------------------
    Step Name: Complete Internal Review
    Step Column: completeinternalreview
    Step Required: false
    ---------------------------------------
    Step Name: Present Proposal
    Step Column: presentproposal
    Step Required: false
    ---------------------------------------
---------------------------------------
Stage Index: 3
Table: opportunity
StageId: bb7e830a-61bd-441b-b1fd-6bb104ffa027
Status: inactive
    Step Name: Complete Final Proposal
    Step Column: completefinalproposal
    Step Required: false
    ---------------------------------------
    Step Name: Present Final Proposal
    Step Column: presentfinalproposal
    Step Required: false
    ---------------------------------------
    Step Name: Confirm Decision Date
    Step Column: finaldecisiondate
    Step Required: false
    ---------------------------------------
    Step Name: Send Thank You
    Step Column: sendthankyounote
    Step Required: false
    ---------------------------------------
    Step Name: File De-brief
    Step Column: filedebrief
    Step Required: false
    ---------------------------------------
---------------------------------------

Artikel terkait

formContext.data.process