getEnabledProcesses (חומר עזר עבור API של לקוח)

אסינכרוני מאחזר את זרימות התהליכים העסקיים המותאמות לטבלה שהמשתמש הנוכחי יכול לעבור אליה.

תחביר

formContext.data.process.getEnabledProcesses(callbackFunction(enabledProcesses));

פרמטר

שם	Type	נדרש	תיאור
callbackFunction	פונקציה	כן	הפונקציה callback חייבת לקבל פרמטר המכיל אובייקט עם מאפייני מילון כאשר שם המאפיין הוא המזהה של זרימת התהליך העסקי וערך המאפיין הוא השם של זרימת התהליך העסקי. התהליכים המותאמים מסוננים בהתאם להרשאות המשתמש. רשימת התהליכים המותאמים היא אותם תהליכים שמשתמש יכול לראות בממשק המשתמש אם הם רוצים לשנות את התהליך באופן ידני.

דוגמה

הפונקציה Sdk.formOnLoad בדוגמה משתמשת בפעולת השירות formContext.data.process.getEnabledProcesses כדי לאחזר באופן אסינכרוני מידע אודות זרימות תהליכים עסקיים המותאמות לטבלה. הדוגמה מעבירה פונקציה אנונימית בתור הפרמטר הראשון. פונקציה זו מבוצעת באופן אסינכרוני כאשר הנתונים מוחזרים והנתונים מועברים כפרמטר לפונקציה האנונימית.

המידע אודות זרימת תהליך עסקי זמין מסופק אובייקט מילון שבו מזהה התהליך הוא שם המאפיין, ושם זרימת התהליך העסקי הוא ערך המאפיין. הקוד לדוגמה מעבד מידע זה ומגדיר את הערכים במערך Sdk.enabledProcesses כללי לגישה באמצעות לוגיקה שמבצעת מאוחר יותר. המדגם גם עובר בלולאה בין הערכים במערך Sdk.enabledProcesses ומשתמש בפונקציה Sdk.writeToConsole כדי לכתוב מידע אודות זרימות התהליכים העסקיים המאוחזרים למסוף.

הערה

יש להגדיר את הפונקציה Sdk.formOnLoad בספריית JavaScript לדוגמה כמטפל באירועים OnLoad עבור טופס, ותיבת הסימון Pass execution as the first parameter must be selected in the Handler Properties .
כמו כן, מדגם זה פשוט מדגים את השימוש בחלק מהשיטות ב- 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 global variable to store information about enabled business processes after they are retrieved asynchronously
    this.enabledProcesses = [];

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

        // Retrieve Enabled processes
        formContext.data.process.getEnabledProcesses(function (processes) {
            //Move processes to the global Sdk.enabledProcesses array;
            for (var processId in processes) {
                Sdk.enabledProcesses.push({ id: processId, name: processes[processId] })
            }
            Sdk.writeToConsole("Enabled business processes flows retrieved and added to Sdk.enabledProcesses array.");

            //Write the values of the Sdk.enabledProcesses array to the console
            if (Sdk.enabledProcesses.length < 0) {
                Sdk.writeToConsole("There are no enabled business process flows for this table.");
            }
            else {
                Sdk.writeToConsole("These are the enabled business process flows for this table:");
                for (var i = 0; i < Sdk.enabledProcesses.length; i++) {
                    var enabledProcess = Sdk.enabledProcesses[i];
                    Sdk.writeToConsole("id: " + enabledProcess.id + " name: " + enabledProcess.name)
                }
            }

            //Any code that depends on the Sdk.enabledProcesses array needs to be initiated here

        });
    };

}).call(Sdk);

בעת הפעלת מדגם זה כאשר כלי הפיתוח של הדפדפן פתוחים, להלן דוגמה של הפלט שנכתב לקונסולה עבור טבלה עם זרימות תהליכים עסקיים מרובים זמינות.

Enabled business processes flows retrieved and added to Sdk.enabledProcesses array.
These are the enabled business process flows for this table:
id: 7994be68-899e-4a40-8d18-f5c3b6940188 name: Sample Lead Process
id: 919e14d1-6489-4852-abd0-a63a6ecaac5d name: Lead to Opportunity Sales Process

מאמרים קשורים

setActiveProcessInstance
formContext.data.process