getActivePath (Klienta API atsauce)

Iegūst aktīvā ceļā esošo posmu kolekciju ar metodēm, lai mijiedarbotos ar biznesa procesa plūsmas vadīklā parādītajiem posmiem.

Aktīvais ceļš attēlo posmus, kas pašlaik tiek atveidoti procesa vadīklā, pamatojoties uz zarošanas kārtulām un pašreizējiem ieraksta datiem.

Sintakse

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

Atgrieztā vērtība

Veids: Kolekcija.

Apraksts: visu pabeigto posmu, pašlaik aktīvā posma un prognozētās nākotnes posmu kopas kolekcija, pamatojoties uz izpildītajiem nosacījumiem sazarošanas kārtulā. Tā var būt to posmu apakškopa, kas tiek atgriezti kopā ar formContext.data.process. getActiveProcess , jo tajā būs iekļauti tikai tie posmi, kas atspoguļo derīgu pāreju no pašreizējā posma, pamatojoties uz procesā notikušo zarošanu.

Piemērs

Funkcija Sdk.formOnLoad izmanto metodi formContext.data.process.getActivePath , lai izgūtu posmu kolekciju. Pēc tam parauga kods izmanto kolekcijas forEach metodi, lai izietu cauri katram posmam. Pēc tam kods ieraksta posma galvenos rekvizītus konsolē, izmantojot šajā bibliotēkā definēto funkciju Sdk.writeToConsole . Pēc tam kods piekļūst katra posma soļu kolekcijai, izmantojot getSteps metodi. Visbeidzot, paraugā tiek izmantota soļu kolekcijas forEach metode, lai piekļūtu katram solim un rakstītu darbības galvenos rekvizītus konsolē.

Piezīmes

Funkcijai Sdk.formOnLoad JavaScript bibliotēkas paraugā jābūt iestatītai kā veidlapas notikumu apdarinātājam OnLoad, un dialoglodziņā Apdarinātāja rekvizīti ir jāatzīmē izvēles rūtiņa Nodot izpildes kontekstu kā pirmo parametru.
Arī šis paraugs tikai ilustrē dažu metožu izmantošanu formContext.data.process API. Tas nenozīmē, ka šī API tiek izmantota, lai izpildītu biznesa prasības; tas ir paredzēts tikai tam, lai parādītu, kā kodā var piekļūt galvenajām rekvizītu vērtībām.

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

Kad paraugs darbojas pārlūkprogrammā, varat izmantot pārlūkprogrammas izstrādātāja rīkus, lai apskatītu konsolē rakstīto tekstu. Piemēram, ja šis paraugs tiek izpildīts iespējas veidlapā ar iespēju pārdošanas procesu, konsolē tiek rakstīts šāds ziņojums:

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

Saistītie raksti

formContext.data.process