getActivePath (การอ้างอิง API ไคลเอ็นต์)

รับคอลเลกชันของลําดับขั้นที่อยู่ในเส้นทางที่ใช้งานอยู่ด้วยวิธีการเพื่อโต้ตอบกับลําดับขั้นที่แสดงในตัวควบคุมโฟลว์กระบวนการทางธุรกิจ

เส้นทางที่ใช้งานอยู่แสดงถึงลําดับขั้นที่แสดงอยู่ในตัวควบคุมกระบวนการที่ยึดตามกฎการโยงหัวข้อและข้อมูลปัจจุบันในเรกคอร์ด

ไวยากรณ์

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

ค่าส่งกลับ

ชนิด: คอลเลกชัน

คําอธิบาย: คอลเลกชันของลําดับขั้นที่เสร็จสมบูรณ์ทั้งหมด ลําดับขั้นที่ใช้งานอยู่ในปัจจุบัน และชุดที่ทํานายของขั้นตอนในอนาคตตามเงื่อนไขที่พึงพอใจในกฎการแบ่งสาขา ซึ่งอาจเป็นชุดย่อยของลําดับขั้นที่ส่งกลับด้วย formContext.data.processgetActiveProcess เนื่องจากจะรวมเฉพาะลําดับขั้นเหล่านั้นที่แสดงถึงการเปลี่ยนที่ถูกต้องจากลําดับขั้นปัจจุบันตามการโยงหัวข้อที่เกิดขึ้นในกระบวนการ

ตัวอย่าง

ฟังก์ชัน Sdk.formOnLoad ใช้เมธอด formContext.data.process.getActivePath เพื่อเรียกใช้คอลเลกชันของลําดับขั้น จากนั้นรหัสตัวอย่างจะใช้เมธอด forEach ของคอลเลกชันเพื่อวนรอบในแต่ละขั้นตอน จากนั้นโค้ดจะเขียนคุณสมบัติหลักของลําดับขั้นไปยังคอนโซลโดยใช้ฟังก์ชัน Sdk.writeToConsole ที่กําหนดไว้ในไลบรารีนี้ จากนั้นโค้ดจะเข้าถึงคอลเลกชันของขั้นตอนสําหรับแต่ละขั้นตอนโดยใช้วิธีการ getSteps สุดท้าย ตัวอย่างจะใช้เมธอด forEach ของคอลเลกชันขั้นตอนเพื่อเข้าถึงแต่ละขั้นตอนและเขียนคุณสมบัติหลักของขั้นตอนไปยังคอนโซล

Note

ฟังก์ชัน Sdk.formOnLoad ในไลบรารี JavaScript ตัวอย่างต้องได้รับการตั้งค่าเป็นตัวจัดการเหตุการณ์ OnLoad สําหรับฟอร์ม และต้องเลือกกล่องกาเครื่องหมาย ส่งผ่านบริบทการดําเนินการเป็นพารามิเตอร์แรก ในกล่องโต้ตอบ คุณสมบัติตัวจัดการ
นอกจากนี้ ตัวอย่างนี้แสดงให้เห็นถึงการใช้บางวิธีใน formContext.data.process API ซึ่งไม่แสดงโดยใช้ 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