getActivePath (kliento API nuoroda)

Gauna šiuo metu aktyviame kelyje esančių etapų rinkinį su metodais, taikomais sąveikauti su etapais, rodomais verslo proceso srauto valdiklyje.

Aktyvus kelias nurodo etapus, šiuo metu generuojamus proceso valdiklyje pagal šakojimo taisykles ir dabartinius įrašo duomenis.

Sintaksė

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

Grąžinimo reikšmė

Tipas: Rinkinys.

Aprašas: visų užbaigtų etapų, šiuo metu aktyvaus etapo ir numatomo būsimų etapų rinkinio, pagrįsto patenkinamomis šakojimo taisyklės sąlygomis, rinkinys. Tai gali būti etapų, grąžintų naudojant formContext.data.process, antrinis rinkinys. getActiveProcess , nes jis apims tik tuos etapus, kurie atitinka galiojantį perėjimą iš dabartinio etapo pagal šakojimo procesą.

Pavyzdžiui

Sdk.formOnLoad funkcija naudoja formContext.data.process.getActivePath metodą etapų rinkiniui nuskaityti. Tada pavyzdyje kodo pavyzdys naudoja rinkinio "forEach " metodą, kad ciklu pereitų per kiekvieną etapą. Kodas įrašo pagrindines etapo ypatybes į konsolę, naudodamas funkciją Sdk.writeToConsole , apibrėžtą šioje bibliotekoje. Tada kodas pasiekia kiekvieno etapo veiksmų rinkinį naudodamas metodą getSteps . Galiausiai, pavyzdyje naudojamas veiksmų rinkinio "forEach " metodas, kad būtų galima pasiekti kiekvieną veiksmą ir rašyti pagrindines veiksmo ypatybes konsolėje.

Pastaba.

"JavaScript" bibliotekos pavyzdžio sdk.formOnLoad funkcija turi būti nustatyta kaip formos įvykio OnLoad apdorojimo programa, o žymės langelis Perduoti vykdymo kontekstą kaip pirmąjį parametrą turi būti pažymėtas dialogo lange Apdorojimo programos ypatybės .
Be to, šis pavyzdys tiesiog iliustruoja kai kurių metodų naudojimą formContext.data.process API. Jis nereiškia šios API naudojimo verslo reikalavimui patenkinti; jis skirtas tik parodyti, kaip pagrindines ypatybės reikšmes galima pasiekti 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);

Kai pavyzdys paleidžiamas naršyklėje, galite naudoti naršyklės kūrėjo įrankius, kad peržiūrėtumėte į konsolę parašytą tekstą. Pavyzdžiui, kai šis pavyzdys vykdomas galimybės formoje su galimybės pardavimo procesu, konsolėje įrašoma:

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
    ---------------------------------------
---------------------------------------

Susiję straipsniai

formContext.data.process