getActivePath (препратка към API на клиент)

Получава колекция от етапи, които в момента са в активния път, с методи за взаимодействие с етапите, показани в контролата на потока на бизнес процеса.

Активният път представя етапите, които в момента са рендирани в контролата на процеса въз основа на правилата за разклонение и текущите данни в записа.

Синтаксис

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

Връщана стойност

Тип: Колекция.

Описание: Колекция от всички завършени етапи, текущия активен етап и прогнозирания набор от бъдещи етапи въз основа на изпълнените условия в правилото за разклонение. Това може да е подмножество на етапите, върнати с formContext.data.process. getActiveProcess , тъй като ще включва само тези етапи, които представляват валиден преход от текущия етап въз основа на разклонение, което е възникнало в процеса.

Пример

Функцията Sdk.formOnLoad използва метода formContext.data.process.getActivePath за извличане на колекция от етапи. След това примерният код използва метода forEach на колекцията, за да премине циклично през всеки етап. След това кодът записва ключовите свойства на етапа в конзолата с помощта на функцията Sdk.writeToConsole, дефинирана в тази библиотека. След това кодът получава достъп до колекция от стъпки за всеки етап с помощта на метода getSteps . И накрая, извадката използва метода forEach на колекцията стъпки за достъп до всяка стъпка и писане на ключови свойства на стъпката на конзолата.

Бележка

Функцията Sdk.formOnLoad в примерната библиотека на JavaScript трябва да бъде зададена като манипулатор на събития OnLoad за формуляр и контекстът за изпълнение на Pass като първи параметър трябва да бъде отметнат в диалоговия прозорец Свойства на Handler .
Освен това тази извадка просто илюстрира използването на някои от методите в API formContext.data.process . Той не представя използването на този API, за да отговори на бизнес изискване; то има за цел само да покаже как стойностите на свойството на ключа могат да бъдат отваряни в код.

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

Когато примерът се изпълнява в браузъра, можете да използвате инструментите за разработчици на браузъра, за да видите текста, написан на конзолата. Например когато тази извадка се изпълнява във формуляра за възможност с процес за продажби на възможности, следното се записва на конзолата:

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

Свързани статии

formContext.data.process