Jagamisviis:


getActivePath (kliendi API viide)

Hangib aktiivse tee etappide kogumi koos meetoditega äriprotsessi voo juhtelemendis kuvatavate etappidega suhtlemiseks.

Aktiivne tee tähistab praegu protsessi juhtelemendis renderdatud etappe kirje harudereeglite ja praeguste andmete põhjal.

Süntaks

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

Tagastatav väärtus

Tüüp: kogum.

Kirjeldus: kõigi lõpuleviidud etappide, praegu aktiivse etapi ja prognoositud tulevaste etappide kogum, mis põhineb hargnemisreegli täidetud tingimustel. See võib olla vormiContext.data.process tagastatud etappide alamhulk. getActiveProcess , kuna see sisaldab ainult neid etappe, mis tähistavad protsessis toimunud harude põhjal kehtivat üleminekut praegusest etapist.

Näide

Funktsioon Sdk.formOnLoad kasutab etappide kogumi toomiseks meetodit formContext.data.process.getActivePath . Seejärel kasutab näidiskood iga etapi läbimiseks kogumi meetodit forEach . Kood kirjutab etapi võtmeatribuudid konsooli selles teegis määratletud funktsiooni Sdk.writeToConsole abil. Kood pääseb seejärel juurde iga etapi etappide kogumile, kasutades meetodit getSteps . Lõpuks kasutab näidis etapikogumi meetodit forEach , et pääseda juurde igale etapile ja kirjutada etapi võtmeatribuudid konsooli.

Märkus.

JavaScripti näidisteegis olev funktsioon Sdk.formOnLoad tuleb seada vormi sündmuseohjuriks OnLoad ja dialoogiboksis Ohjuri atribuudid peab olema märgitud ruut Pass execution as the first parameter (Pass execution context as the first parameter).
Samuti illustreerib see näide mõne meetodi kasutamist formContext.data.process API-s. See ei tähista selle API kasutamist ärinõude täitmiseks; see on mõeldud ainult selleks, et näidata, kuidas võtmeatribuudiväärtustele koodiga juurde pääseb.

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

Kui näidis töötab brauseris, saate konsoolile kirjutatud teksti vaatamiseks kasutada brauseri arendusriistu. Näiteks kui see näidis käivitatakse võimalusevormil koos võimaluse müügiprotsessiga, kirjutatakse konsooli järgmine tekst:

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

formContext.data.process