Aracılığıyla paylaş


getActivePath (İstemci API başvurusu)

İş süreci akış denetiminde görüntülenen aşamalarla etkileşime geçmek için yöntemlerle şu anda etkin yolda olan aşamalardan oluşan bir koleksiyon alır.

Etkin yol, şu anda işlem denetiminde işlenen aşamaları, kayıttaki dallanma kurallarına ve geçerli verilere göre temsil eder.

Sözdizimi

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

Dönüş Değeri

Tür: Koleksiyon.

Açıklama: Tüm tamamlanmış aşamalardan, şu anda etkin olan aşamadan ve dallanma kuralındaki uygun koşullara göre tahmin edilen gelecek aşamalardan oluşan bir koleksiyon. Bu, formContext.data.process ile döndürülen aşamaların bir alt kümesi olabilir. getActiveProcess , yalnızca işlemde gerçekleşen dallanma temelinde geçerli aşamadan geçerli bir geçişi temsil eden aşamaları içerecektir.

Example

Sdk.formOnLoad işlevi, aşama koleksiyonunu almak için formContext.data.process.getActivePath yöntemini kullanır. Ardından örnek kod, her aşamada döngü yapmak için koleksiyonun forEach yöntemini kullanır. Kod daha sonra bu kitaplıkta tanımlanan Sdk.writeToConsole işlevini kullanarak aşamanın temel özelliklerini konsola yazar. Kod daha sonra getSteps yöntemini kullanarak her aşama için bir adım koleksiyonuna erişir. Son olarak, örnek her adıma erişmek ve adımın anahtar özelliklerini konsola yazmak için adım koleksiyonunun forEach yöntemini kullanır.

Uyarı

Örnek JavaScript kitaplığındaki Sdk.formOnLoad işlevi bir form için OnLoad olay işleyicisi olarak ayarlanmalıdır ve İşleyici Özellikleri iletişim kutusunda yürütme bağlamını ilk parametre olarak geçir onay kutusu seçilmelidir.
Ayrıca bu örnekte formContext.data.process API'sindeki bazı yöntemlerin kullanımı gösterilmektedir. İş gereksinimini karşılamak için bu API'nin kullanılmasını temsil etmez; yalnızca anahtar özellik değerlerine kodda nasıl erişilebileceğini göstermek için tasarlanmıştır.

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

Örnek tarayıcıda çalıştığında, konsola yazılan metni görüntülemek için tarayıcının geliştirici araçlarını kullanabilirsiniz. Örneğin, bu örnek Fırsat Satış Süreci ile Fırsat formunda çalıştırıldığında konsola aşağıdakiler yazılır:

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