getActivePath (odkaz na klientske rozhranie API)

Získa kolekciu fáz, ktoré sú aktuálne v aktívnej ceste s metódami na interakciu s fázami zobrazenými v ovládaní postupu obchodného procesu.

Aktívna cesta predstavuje aktuálne vykreslené fázy v ovládacom prvku procesu na základe pravidiel vetvenia a aktuálnych údajov v zázname.

Syntax

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

Vrátená hodnota

Typ: Kolekcia.

Popis: Kolekcia všetkých dokončených fáz, aktuálne aktívnej etapy a predpovedanej množiny budúcich fáz na základe splnených podmienok v pravidle vetvenia. Môže to byť podmnožina fáz vrátených s formContext.data.process. getActiveProcess, pretože bude zahŕňať iba tie fázy, ktoré predstavujú platný prechod z aktuálnej etapy na základe vetvenia, ku ktorému v procese došlo.

Príklad

Funkcia Sdk.formOnLoad používa metódu formContext.data.process.getActivePath na načítanie kolekcie fáz. Vzorový kód potom používa metódu forEach kolekcie na opakovanie každej fázy. Kód potom zapíše kľúčové vlastnosti fázy do konzoly pomocou funkcie Sdk.writeToConsole definovanej v tejto knižnici. Kód potom pristupuje k kolekcii krokov pre každú fázu pomocou metódy getSteps . Nakoniec vzorka používa metódu forEach kolekcie krokov na prístup ku každému kroku a zapisovanie kľúčových vlastností kroku do konzoly.

Poznámka

Funkcia Sdk.formOnLoad v ukážkovej knižnici JavaScript musí byť pre formulár nastavená ako obsluha udalostí OnLoad a kontext Odovzdať vykonanie ako prvé začiarkavacie políčko parametra musí byť začiarknuté v dialógovom okne Obslužný program – vlastnosti .
Táto ukážka tiež len ilustruje použitie niektorých metód v rozhraní formContext.data.process API. Nereprezentuje použitie tohto rozhrania API na splnenie obchodných požiadaviek. Jeho cieľom je len ukázať, ako možno pristupovať k hodnotám kľúčových vlastností v kóde.

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

Keď je ukážka spustená v prehliadači, môžete pomocou vývojárskych nástrojov prehliadača zobraziť text napísaný v konzole. Ak sa napríklad táto ukážka spustí vo formulári Príležitosť s procesom predaja príležitostí, do konzoly sa zapíše toto:

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

Súvisiace články

formContext.data.process