getActivePath (client-API-verwijzing)

Hiermee haalt u een verzameling fasen op die zich momenteel in het actieve pad bevinden met methoden om te communiceren met de fasen die worden weergegeven in het beheer van de bedrijfsprocesstroom.

Het actieve pad vertegenwoordigt fasen die momenteel worden weergegeven in het procesbeheer op basis van de vertakkingsregels en de huidige gegevens in de record.

Syntaxis

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

Retourwaarde

Type: Verzameling.

Beschrijving: Een verzameling van alle voltooide fasen, de momenteel actieve fase en de voorspelde set toekomstige fasen op basis van de voorwaarden in de vertakkingsregel. Dit kan een subset zijn van de fasen die worden geretourneerd met formContext.data.process. getActiveProcess omdat het alleen de fasen bevat die een geldige overgang van de huidige fase vertegenwoordigen op basis van vertakkingen die in het proces zijn opgetreden.

Example

De functie Sdk.formOnLoad maakt gebruik van de methode formContext.data.process.getActivePath om een verzameling fasen op te halen. Vervolgens gebruikt de voorbeeldcode de forEach-methode van de verzameling om elke fase te doorlopen. De code schrijft vervolgens belangrijke eigenschappen van de fase naar de console met behulp van de sdk.writeToConsole-functie die in deze bibliotheek is gedefinieerd. De code opent vervolgens een verzameling stappen voor elke fase met behulp van de methode getSteps . Ten slotte gebruikt het voorbeeld de forEach-methode van de stappenverzameling om elke stap te openen en sleuteleigenschappen van de stap naar de console te schrijven.

Opmerking

De functie Sdk.formOnLoad in de JavaScript-voorbeeldbibliotheek moet worden ingesteld als de Gebeurtenis-handler OnLoad voor een formulier en de uitvoeringscontext Pass als het eerste selectievakje voor parameters moet zijn ingeschakeld in het dialoogvenster Handler-eigenschappen .
Dit voorbeeld illustreert ook alleen het gebruik van enkele methoden in de formContext.data.process-API . Het vertegenwoordigt het gebruik van deze API niet om te voldoen aan een bedrijfsvereiste; Het is alleen bedoeld om te laten zien hoe de sleuteleigenschapswaarden kunnen worden geopend in code.

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

Wanneer het voorbeeld wordt uitgevoerd in de browser, kunt u de ontwikkelhulpprogramma's van de browser gebruiken om de tekst weer te geven die naar de console is geschreven. Wanneer dit voorbeeld bijvoorbeeld wordt uitgevoerd in het verkoopkansformulier met het verkoopproces verkoopkans, wordt het volgende naar de console geschreven:

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

Verwante artikelen

formContext.data.process