getActivePath (Rujukan API Klien)

Mendapat koleksi peringkat yang kini berada dalam laluan aktif dengan kaedah untuk berinteraksi dengan peringkat yang dipaparkan dalam kawalan aliran proses perniagaan.

Laluan aktif mewakili peringkat yang sedang dipaparkan dalam kawalan proses berdasarkan peraturan cawangan dan data semasa dalam rekod.

Sintaks

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

Nilai Pulangan

Jenis: Koleksi.

Penerangan: Koleksi semua peringkat yang telah selesai, peringkat aktif pada masa ini, dan set peringkat masa depan yang diramalkan berdasarkan syarat yang dipenuhi dalam peraturan cawangan. Ini mungkin subset peringkat yang dikembalikan dengan formContext.data.process. getActiveProcess kerana ia hanya akan merangkumi peringkat yang mewakili peralihan yang sah daripada peringkat semasa berdasarkan percabangan yang telah berlaku dalam proses tersebut.

Contoh

Fungsi Sdk.formOnLoad menggunakan kaedah formContext.data.process.getActivePath untuk mendapatkan semula koleksi peringkat. Kemudian, kod sampel menggunakan kaedah forEach koleksi untuk menggelung setiap peringkat. Kod kemudian menulis sifat utama peringkat ke konsol menggunakan fungsi Sdk.writeToConsole yang ditakrifkan dalam pustaka ini. Kod kemudian mengakses koleksi langkah untuk setiap peringkat menggunakan kaedah getSteps . Akhir sekali, sampel menggunakan kaedah forEach koleksi langkah untuk mengakses setiap langkah dan menulis sifat utama langkah ke konsol.

Nota

Fungsi Sdk.formOnLoad dalam pustaka JavaScript sampel mesti disetkan sebagai pengendali peristiwa OnLoad untuk borang, dan kotak semak Lulus konteks pelaksanaan sebagai parameter pertama mesti dipilih dalam dialog Sifat Pengendali.
Selain itu, sampel ini hanya menggambarkan penggunaan beberapa kaedah dalam API formContext.data.process . Ia tidak mewakili penggunaan API ini untuk memenuhi keperluan perniagaan; Ia hanya bertujuan untuk menunjukkan cara nilai sifat utama boleh diakses dalam kod.

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

Apabila sampel dijalankan dalam penyemak imbas, anda boleh menggunakan alat pembangun penyemak imbas untuk melihat teks yang ditulis ke konsol. Contohnya, apabila sampel ini dijalankan dalam borang Peluang dengan Proses Jualan Peluang, perkara berikut 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 berkaitan

formContext.data.process