v7

JavaScript 指令碼和範本

上次更新: 2023-05-24
  • 主題:
  • Workflows
    檢視有關此主題的更多資訊

指令碼可以計算值、在流程中不同工作之間交換資料,以及使用SOAP呼叫執行特定作業。

指令碼在工作流程圖表中無處不在:

  • 所有活動都有初始化指令碼。 初始化指令碼會在活動啟動時執行,並可用於初始化變數和修改屬性。

  • 「JavaScript程式碼」活動僅用於執行指令碼。

  • 「測試」活動會評估JavaScript運算式,以啟動適當的轉變。

  • 大部分的文字欄位都是JavaScript範本:JavaScript運算式可包含在<%=和%>之間。 這些欄位提供可開啟下拉式清單的按鈕,以幫助您輸入運算式。

物件已公開

在工作流程內容中執行的JavaScripts會存取一系列其他全域物件。

  • 例項:代表正在執行的工作流程。 此物件的結構描述是 xtk:workflow.
  • 任務:代表正在執行的任務。 此物件的結構描述是 xtk:workflowTask.
  • 事件:代表啟動正在執行之任務的事件。 此物件的結構描述是 xtk:workflowEvent. 此物件未初始化 合併連結 輸入已從多個轉變啟動的活動。
  • 事件:代表啟動目前任務的事件清單。 此物件的結構描述是 xtk:workflowEvent. 此表格通常包含一個元素,但可能包含多個 合併連結 根據數個轉變型別已啟動的活動。
  • 活動:代表正在執行的工作模型。 此物件的結構描述取決於活動型別。 此物件可由初始化指令碼修改,而在其他指令碼中,修改會產生無法確定的效果。

您可以按一下指令碼工具列右側的按鈕,在下拉式清單中檢視這些物件可用的屬性。

注意

這些物件的屬性是唯讀的,但vars屬性的子屬性除外。

這些屬性大多只會在執行基礎任務或執行個體被鈍化後更新。 讀取的值不一定符合目前狀態,但符合先前狀態。

範例

在此範例及以下範例中,建立的工作流程包括 JavaScript代碼 活動和 結束 活動,如下圖所示。

連按兩下 JavaScript代碼 活動並插入以下指令碼:

logInfo("Label: " + instance.label)
logInfo("Start date: " + task.creationDate)

logInfo(message) 函式在記錄中插入訊息。

按一下 OK 若要關閉建立精靈,請使用位於工作流程清單右上角的動作按鈕來啟動工作流程。 在執行結束時,請查閱記錄。 您應該會看到兩個與指令碼對應的訊息:一個顯示工作流程的標籤,另一個顯示啟動指令碼的日期。

變數

變數是 instancetaskevent 物件。 為這些變數授權的JavaScript型別包括 stringnumberDate.

實例變數

執行個體變數(instance.vars.xxx)與全域變數具有可比性。 所有活動都會共用這些區段。

任務變數

任務變數(task.vars.xxx)與本機變數具有可比性。 它們僅供目前任務使用。 持續性活動會使用這些變數來保留資料,有時也用於相同活動的不同指令碼之間交換資料。

事件變數

事件變數(vars.xxx)可在工作流程的基本任務之間交換資料。 這些變數會由啟動進行中任務的工作傳遞。 您可以修改它們並定義新的變數。 然後會傳遞至下列活動。

注意

若為 合併連結 輸入活動,變數會合併,但如果相同的變數定義兩次,則會發生衝突,且值仍未決定。

事件是最常使用的變數,應優先於例項變數來使用它們。

特定事件變數會由不同活動修改或讀取。 這些都是字串型別變數。 例如,匯出會設定 vars.filename 變數加上剛匯出的檔案全名。 這些已讀取或已修改的變數全都記錄在 關於活動,在區段中 輸入引數輸出引數 活動。

使用案例

注意

其他工作流程使用案例位於 本節.

範例1

在此範例中,例項變數可用來動態計算要套用至母體的分割百分比。

  1. 建立工作流程並新增開始活動。

  2. 新增和設定JavaScript程式碼活動以定義執行個體變數。

    例如: instance.vars.segmentpercent = 10;

  3. 新增查詢活動,並根據您的需求鎖定收件者。

  4. 新增分割活動,並將其設定為執行傳入母體的隨機抽樣。 抽樣百分比可以是您選擇的任何值。 在此範例中,它被設定為50%。

    此百分比會根據先前定義的例項變數,以動態方式更新。

  5. 在「分割」活動的「進階」標籤的「初始化指令碼」區段內,定義JS條件。 JS條件會選取從「分割」活動出來的第一個轉變的隨機取樣百分比,並將其更新為先前建立的執行個體變數所設定的值。

    activity.transitions.extractOutput[0].limiter.percent = instance.vars.segmentpercent;
    

  6. 請確定補碼是在「分割」活動的個別轉變中產生,並在每個出站轉變後新增「結束」活動。

  7. 儲存並執行工作流程。 動態取樣會根據執行個體變數套用。

範例2

  1. 從上一個範例取得工作流程,並取代 JavaScript代碼 活動,並使用下列指令碼:

    instance.vars.foo = "bar1"
    vars.foo = "bar2"
    task.vars.foo = "bar3"
    
  2. 將下列指令碼新增至 結束 活動:

    logInfo("instance.vars.foo = " + instance.vars.foo)
    logInfo("vars.foo = " + vars.foo)
    logInfo("task.vars.foo = " + task.vars.foo)
    
  3. 啟動工作流程,然後檢視記錄。

    Workflow finished
    task.vars.foo = undefined
    vars.foo = bar2
    instance.vars.foo = bar1
    Starting workflow (operator 'admin')
    

此範例顯示下列活動 JavaScript代碼 可存取執行個體變數和事件變數,但無法從外部存取任務變數(「未定義」)。

調用查詢中的執行個體變數

在活動中指定執行個體變數後,您可以在工作流程查詢中重複使用它。

因此,若要呼叫變數 instance.vars.xxx = "yyyy" 在篩選器中,輸入 $(instance/vars/xxx).

例如:

  1. 建立執行個體變數,透過定義傳送的內部名稱 JavaScript codeinstance.vars.deliveryIN = "DM42".

  2. 建立其定位和篩選維度為收件者的查詢。 在條件中,指定您希望尋找透過變數指定之傳遞傳送的所有收件者。

    提醒一下,此資訊會儲存在傳送記錄檔中。

    若要參照中的例項變數 Value 欄,輸入 $(instance/vars/@deliveryIN).

    工作流程將傳回DM42傳遞的收件者。

進階函式

除了標準JavaScript函式外,還有特殊函式可用於操控檔案、讀取或修改資料庫中的資料,或將訊息新增至記錄檔。

日誌

logInfo(message) 詳細說明。 此函式將資訊訊息新增至日誌。

logError(message) 新增錯誤訊息至記錄檔。 指令碼會中斷其執行,而工作流程會變更為錯誤狀態(依預設,執行個體將暫停)。

初始化指令碼

在某些情況下,您可以在活動執行時修改其屬性。

大部分的活動屬性都可使用JavaScript範本動態計算,或是因為工作流程屬性明確允許指令碼計算值。

不過,對於其他屬性,您必須使用初始化指令碼。 在執行工作之前會評估此指令碼。 此 activity 變數會參考與任務對應的活動。 此活動的屬性可以修改,並且只會影響此工作。

相關主題
工作流程中的JavaScript程式碼範例

此頁面上的