getActivePath (referenční dokumentace k rozhraní API klienta)

Získá kolekci fází aktuálně v aktivní cestě s metodami pro interakci s fázemi zobrazenými v řízení toku obchodního procesu.

Aktivní cesta představuje fáze aktuálně vykreslené v ovládacím prvku procesu na základě pravidel větvení a aktuálních dat v záznamu.

Syntaxe

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

Návratová hodnota

Typ: Kolekce.

Popis: Kolekce všech dokončených fází, aktuálně aktivní fáze a predikovaná sada budoucích fází na základě splněných podmínek v pravidle větvení. Může se jednat o podmnožinu fází vrácených pomocí formContext.data.process. getActiveProcess , protože bude obsahovat pouze ty fáze, které představují platný přechod z aktuální fáze na základě větvení, ke kterým došlo v procesu.

Example

Funkce Sdk.formOnLoad používá metodu formContext.data.process.getActivePath k načtení kolekce fází. Pak vzorový kód používá metodu forEach kolekce k procházení jednotlivých fází. Kód pak zapíše vlastnosti klíče fáze do konzoly pomocí funkce Sdk.writeToConsole definované v této knihovně. Kód pak přistupuje k kolekci kroků pro každou fázi pomocí metody getSteps . Nakonec ukázka používá metodu forEach kolekce kroků pro přístup ke každému kroku a zápis vlastností klíče kroku do konzoly.

Poznámka:

Funkce Sdk.formOnLoad v ukázkové javascriptové knihovně musí být nastavena jako obslužná rutina události OnLoad pro formulář a kontext předat spuštění jako první parametr zaškrtávací políčko musí být zaškrtnuté v dialogovém okně Vlastnosti obslužné rutiny .
Tato ukázka také ukazuje použití některých metod v rozhraní FORMContext.data.process API. Nepředstavuje použití tohoto rozhraní API ke splnění obchodních požadavků; Účelem je pouze předvést, jak se k hodnotám klíčových vlastností dá přistupovat v kódu.

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

Když se ukázka spustí v prohlížeči, můžete pomocí vývojářských nástrojů prohlížeče zobrazit text napsaný do konzoly. Pokud je například tato ukázka spuštěna ve formuláři Příležitost s prodejním procesem příležitosti, do konzoly se zapíše následující:

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

Související články

formContext.data.process