getActivePath (klient-API-reference)

Henter en samling faser i den aktive sti med metoder til at interagere med de faser, der vises i kontrolelementet for forretningsprocesforløbet.

Den aktive sti repræsenterer faser, der i øjeblikket gengives i proceskontrolelementet baseret på forgreningsreglerne og de aktuelle data i posten.

Syntaks

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

Returværdi

Type: Samling.

Beskrivelse: En samling af alle fuldførte faser, den aktuelt aktive fase og det forudsagte sæt af fremtidige faser baseret på opfyldte betingelser i forgreningsreglen. Dette kan være et undersæt af de faser, der returneres med formContext.data.process. getActiveProcess , fordi den kun indeholder de faser, der repræsenterer en gyldig overgang fra den aktuelle fase baseret på forgreninger, der er opstået i processen.

Eksempel

Funktionen Sdk.formOnLoad bruger metoden formContext.data.process.getActivePath til at hente en samling faser. Eksempelkoden bruger derefter metoden forEach for samlingen til at gå gennem hver fase. Koden skriver derefter nøgleegenskaberne for fasen til konsollen ved hjælp af funktionen Sdk.writeToConsole, der er defineret i dette bibliotek. Koden får derefter adgang til en samling trin for hver fase ved hjælp af metoden getSteps . Til sidst bruger eksemplet metoden forEach for trinsamlingen til at få adgang til hvert trin og skrive nøgleegenskaber for trinnet til konsollen.

Notat

Funktionen Sdk.formOnLoad i JavaScript-eksempelbiblioteket skal angives som OnLoad-hændelseshandleren for en formular, og afkrydsningsfeltet Overfør udførelseskontekst som den første parameter skal være markeret i dialogboksen Egenskaber for handler.
Dette eksempel illustrerer også blot brugen af nogle af metoderne i API'en formContext.data.process . Den repræsenterer ikke brug af denne API til at opfylde et forretningskrav. Det er kun beregnet til at vise, hvordan nøgleegenskabsværdierne kan tilgås i kode.

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

Når eksemplet kører i browseren, kan du bruge udviklerværktøjerne i browseren til at få vist den tekst, der er skrevet til konsollen. Når dette eksempel f.eks. køres i formularen Salgsmulighed med Salgsproces for salgsmulighed, skrives følgende til konsollen:

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

Relaterede artikler

formContext.data.process