getActivePath (asiakkaan ohjelmointirajapinnan viittaus)

Hakee aktiivisessa polussa tällä hetkellä olevien vaiheiden kokoelman ja menetelmät, joilla voit käsitellä liiketoimintaprosessin työnkulun ohjausobjektissa näkyviä vaiheita.

Aktiivinen polku edustaa prosessin ohjausobjektissa tällä hetkellä hahmonnettuja vaiheita haarautuvien sääntöjen ja tietueen nykyisten tietojen perusteella.

Syntaksi

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

Palautusarvo

Tyyppi: Kokoelma.

Kuvaus: Kokoelma kaikista suoritetuista vaiheista, tällä hetkellä aktiivisesta vaiheesta ja tulevien vaiheiden ennustetustajoukosta haarasäännön ehtojen perusteella. Tämä voi olla formContext.data.process-funktion palauttamien vaiheiden alijoukko. getActiveProcess , koska se sisältää vain ne vaiheet, jotka edustavat kelvollista siirtymää nykyisestä vaiheesta prosessissa tapahtuneen haarautumisen perusteella.

Esimerkki

Sdk.formOnLoad-funktio käyttää formContext.data.process.getActivePath-menetelmää vaihekokoelman noutamiseen. Tämän jälkeen mallikoodi käyttää kokoelman forEach-menetelmää kunkin vaiheen läpi käymiseen. Koodi kirjoittaa sitten vaiheen avainominaisuudet konsoliin käyttämällä tässä kirjastossa määritettyä Sdk.writeToConsole-funktiota . Tämän jälkeen koodi käyttää kokoelmaa kunkin vaiheen osavaiheita getSteps-menetelmällä . Lopuksi malli käyttää vaihekokoelman forEach-menetelmää kunkin vaiheen käyttämiseen ja vaiheen avainominaisuuksien kirjoittamiseen konsoliin.

Note

JavaScript-mallikirjaston Sdk.formOnLoad-funktio on määritettävä lomakkeen OnLoad-tapahtumakäsittelijäksi, ja Välitä suorituskonteksti ensimmäisenä parametrina -valintaruutu on valittava Käsittelijän ominaisuudet -valintaikkunassa.
Lisäksi tämä malli havainnollistaa vain joidenkin menetelmien käyttöä formContext.data.process-ohjelmointirajapinnassa . Se ei edusta tämän ohjelmointirajapinnan käyttämistä liiketoiminnan tarpeiden täyttämiseen. Se on tarkoitettu vain osoittamaan, miten avainominaisuusarvoja voidaan käyttää koodissa.

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

Kun malli suoritetaan selaimessa, voit tarkastella konsoliin kirjoitettua tekstiä selaimen kehittäjätyökaluilla. Jos esimerkiksi tämä malli suoritetaan Mahdollisuus-lomakkeessa Myyntimahdollisuusprosessi-funktiolla, konsoliin kirjoitetaan seuraavat asiat:

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

Liittyvät artikkelit

formContext.data.process