getActivePath (sklic na API odjemalca)

Dobi zbirko stopenj, ki so trenutno na aktivni poti, z metodami za interakcijo s stopnjami, prikazanimi v kontrolniku poteka poslovnega procesa.

Aktivna pot predstavlja stopnje, ki so trenutno upodobljene v kontrolniku procesa na podlagi pravil razvejenja in trenutnih podatkov v zapisu.

Sintaksa

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

Vrednost vračila

Vrsta: zbirka.

Opis: Zbirka vseh dokončanih stopenj, trenutno aktivne stopnje in predvidenega nabora prihodnjih stopenj na podlagi pogojev za dovoljstvo v pravilu razvejanja. To je lahko podnabor stopenj, vrnjenih z formContext.data.process. getActiveProcess , ker bodo vključevale le tiste stopnje, ki predstavljajo veljaven prehod s trenutne stopnje, ki temelji na razvejenju, ki je prišlo v postopku.

Primer

Funkcija Sdk.formOnLoad uporablja metodo formContext.data.process.getActivePath za pridobivanje zbirke stopenj. Nato vzorčna koda uporabi metodo forEach zbirke za zanko skozi posamezno stopnjo. Koda nato zapiše ključne lastnosti stopnje v konzolo s funkcijo Sdk.writeToConsole , določeno v tej knjižnici. Koda nato dostopa do zbirke korakov za vsako stopnjo z metodo getSteps . Na koncu vzorec uporabi metodo forEach zbirke korakov za dostop do posameznega koraka in pisanje lastnosti ključa koraka v konzolo.

opomba,

Funkcija Sdk.formOnLoad v vzorčni knjižnici JavaScript mora biti nastavljena kot rutina za obravnavo dogodkov OnLoad za obrazec in potrditveno polje Pass execution context as the first parameter check box must be selected in the Handler Properties dialog.
Ta vzorec le ponazarja uporabo nekaterih metod v API-jih formContext.data.process . Ne predstavlja uporabe tega API-ja za izpolnjevanje poslovne zahteve; namenjeno je le prikazu, kako je mogoče do vrednosti ključnih lastnosti dostopati v kodi.

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

Ko se vzorec izvaja v brskalniku, si lahko z orodji za razvijalce brskalnika ogledate besedilo, napisano v konzoli. Če na primer ta vzorec zaženete v obrazcu »Priložnost« s prodajnim procesom priložnosti, se v konzoli zapišete to:

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

Povezani članki

formContext.data.process