Megosztás:


getActivePath (ügyfél API-referencia)

Lekéri az aktív elérési úton lévő fázisok gyűjteményét az üzleti folyamatok vezérlésében megjelenő fázisokkal való interakció módszereivel.

Az aktív elérési út a folyamatvezérlőben jelenleg megjelenített fázisokat jelöli az elágaztatási szabályok és a rekord aktuális adatai alapján.

Szemantika

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

Visszaadott érték

Típus: Gyűjtemény.

Leírás: Az összes befejezett szakasz, az aktuálisan aktív szakasz és a jövőbeli szakaszok előrejelzett készlete az elágaztatási szabályban szereplő teljesült feltételek alapján. Ez lehet a formContext.data.process által visszaadott szakaszok részhalmaza. getActiveProcess , mert csak azokat a fázisokat tartalmazza, amelyek a folyamatban bekövetkezett elágaztatás alapján az aktuális fázisból való érvényes átmenetet jelölik.

Example

Az Sdk.formOnLoad függvény a formContext.data.process.getActivePath metódust használja a szakaszok gyűjteményének lekéréséhez. Ezután a mintakód a gyűjtemény forEach metódusával végighalad az egyes fázisokon. A kód ezután a kódtárban definiált Sdk.writeToConsole függvény használatával írja a szakasz kulcstulajdonságait a konzolra. A kód ezután a getSteps metódus használatával hozzáfér az egyes fázisok lépéseinek gyűjteményéhez. Végül a minta a lépésgyűjtemény forEach metódusával fér hozzá az egyes lépésekhez, és a lépés kulcstulajdonságait a konzolra írja.

Megjegyzés:

A Minta JavaScript-kódtár Sdk.formOnLoad függvényét be kell állítani egy űrlap OnLoad eseménykezelőjeként, és a Kezelő tulajdonságai párbeszédpanelen be kell jelölni az első paraméterként megadott végrehajtási környezetet.
Ez a minta a formContext.data.process API néhány metódusának használatát is szemlélteti. Ez nem azt jelenti, hogy az API-t üzleti követelmények teljesítéséhez használja; Csak a kulcstulajdonságok kódban való elérésének bemutatására szolgál.

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

Amikor a minta a böngészőben fut, a böngésző fejlesztői eszközeivel megtekintheti a konzolra írt szöveget. Ha például ezt a mintát a Lehetőség űrlapon futtatja a Lehetőség értékesítési folyamattal, a rendszer a következőt írja a konzolra:

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