工作流模型由各種類型的一系列步驟組成。 根據類型,這些步驟可以設定並擴充為參數和指令碼,以提供您所需的功能和控制。
每個步驟元件都有一個步驟屬性對話框,允許您定義和編輯所需的屬性。
屬性對話框的Common頁簽上提供了以下屬性組合,可用於大多數工作流步驟元件:
標題步驟的標題。
說明步驟的說明。
工作流程分段
將Stage套用至步驟的下拉式選取器。
逾時
此步驟之後將「逾時」的時段。
您可以選取:Off,Immediate,1h,6h,12h,24h。
逾時處理常式
步驟逾時時控制工作流程的處理常式;例如:
Auto Advancer
處理常式前進
選取此選項,即可在執行後自動將工作流程推進至下一個步驟。 如果未選取,實施指令碼必須處理工作流程進階。
以下屬性可用於屬性對話框的用戶/組頁簽上的許多工作流步驟元件:
通過電子郵件通知用戶
使用者/群組
AND Split會在工作流程中建立分割,之後兩個分支都會生效。 您可以視需要將工作流程步驟新增至每個分支。 此步驟可讓您將多個處理路徑引入工作流程中。 例如,您可以允許同時執行某些審核步驟,以節省時間。
配置拆分:
編輯AND拆分屬性:
視需要將工作流程步驟新增至分支。
容器步驟將啟動另一個作為子工作流執行的工作流模型。
此容器可讓您重複使用工作流模型,以實作常見的步驟順序。 例如,翻譯工作流程模型可用於多個編輯工作流程。
若要設定此步驟,請編輯並使用下列標籤:
容器
轉至步驟允許您指定在工作流模型中執行的下一步。 您可以指定規則定義、外部指令碼或ECMA指令碼作為路由表達式,以評估工作流模型的下一步。
轉至步驟允許您在工作流模型中實施高級路由結構。 例如,要實現循環,可以定義轉到步驟以執行工作流中的前一步驟,其中路由表達式評估循環條件。
若要設定此步驟,請編輯並使用下列標籤:
程序
目標步驟:選擇在評估路由表達式的條件後要執行的步驟。
路由表達式:選取「規則定義」、「外部指令碼」或ECMA指令碼,以判斷是否要執行 目標步驟。
模擬for循環需要保持已發生循環迭代次數的計數:
例如,若要實作在數個JCR節點上執行動作的工作流程,您可以使用循環計數器作為節點的索引。 若要保留計數,請將integer
值儲存在工作流程例項的資料映射中。 使用轉至步驟的指令碼來增加計數,並比較計數與退出條件。
function check(){
var count=0;
var keyname="loopcount"
try{
if (workflowData.getMetaDataMap().containsKey(keyname)){
log.info("goto script: found loopcount key");
count= parseInt(workflowData.getMetaDataMap().get(keyname))+1;
}
workflowData.getMetaDataMap().put(keyname,count);
}catch(err) {
log.info(err.message);
return false;
}
if (parseInt(count) <7){
return true;
} else {
return false;
}
}
您也可以使用「規則定義」(Rule Definition)作為路由表達式來模擬for循環。 建立Long 資料類型的countvariable。在設定變數步驟中,使用運算式作為映射模式,將count變數的值設定為count + 1,以執行設定變數步驟。
在轉至步驟中,使用設定變數作為目標步驟,使用計數<5作為路由表達式。
設定變數步驟會在每次執行時重複執行,將count變數的值增加1,直到值達到5。
OR Split會在工作流中建立分割,之後只會有一個分支生效。 此步驟可讓您將條件式處理路徑引入工作流程中。 您可以視需要將工作流程步驟新增至每個分支。
配置拆分:
編輯OR拆分屬性:
常見
分支(x)
請參閱定義OR分割的規則。
視需要將工作流程步驟新增至分支。
參與者步驟允許您為特定操作分配所有權。 只有當使用者手動確認步驟時,工作流程才會繼續。 當您希望某人對工作流程採取動作時,就會使用此功能;例如,檢閱步驟。
雖然與用戶授權不直接相關,但在分配操作時必須考慮用戶授權;使用者必須擁有工作流程裝載之頁面的存取權。
若要設定此步驟,請編輯並使用下列標籤:
當發生下列情況時,一律會通知工作流發起程式:
您需要設定某些屬性,才能啟用電子郵件通知。 您也可以自訂電子郵件範本,或為新語言新增電子郵件範本。 請參閱設定電子郵件通知以在AEM中設定電子郵件通知。
使用對話參與者步驟從分配了工作項的用戶收集資訊。 此步驟對於收集稍後用於工作流程的少量資料非常有用。
完成此步驟後,完成工作項對話框包含您在對話框中定義的欄位。 在欄位中收集的資料會儲存在工作流程裝載的節點中。 之後的工作流程步驟便可從存放庫讀取值。
要配置步驟,請指定要為其分配工作項的組或用戶以及對話框的路徑。
若要設定此步驟,請編輯並使用下列標籤:
要建立對話框,需要建立對話框:
您可以在工作流程裝載或工作項元資料中儲存介面工具集資料。 介面工具集節點的name
屬性格式決定資料的儲存位置。
使用裝載儲存資料
若要將Widget資料儲存為工作流程裝載的屬性,請對Widget節點的name屬性值使用以下格式:
./jcr:content/nodename
資料儲存在有效負載節點的nodename
屬性中。 如果節點不包含該屬性,則會建立屬性。
與裝載一併儲存時,具有相同裝載之對話方塊的後續使用會覆寫屬性的值。
將資料與工作項一起儲存
要將Widget資料儲存為工作項元資料的屬性,請對name屬性的值使用以下格式:
nodename
資料儲存在工作項metadata
的nodename
屬性中。 如果對話方塊後續與相同裝載搭配使用,則會保留資料。
對話框結構
對話框參與者步驟對話框與為創作元件建立的對話框類似。 它們儲存在:
/apps/myapp/workflow/dialogs
標準觸控式UI的對話方塊具有下列節點結構:
newComponent (cq:Component)
|- cq:dialog (nt:unstructured)
|- content
|- layout
|- items
|- column
|- items
|- component0
|- component1
|- ...
有關詳細資訊,請參閱建立和配置對話框。
對話框路徑屬性
對話參與者步驟具有對話路徑屬性(連同參與者步驟的屬性)。 Dialog Path屬性的值是對話框dialog
節點的路徑。
例如,該對話框包含在儲存在節點中名為EmailWatch
的元件中:
/apps/myapp/workflows/dialogs
對於觸控式UI,對話方塊路徑屬性會使用下列值:
/apps/myapp/workflow/dialogs/EmailWatch/cq:dialog
示例對話框定義
以下XML代碼片段表示一個對話框,該對話框將String
值儲存在裝載內容的watchEmail
節點中。 標題節點表示TextField元件:
jcr:primaryType="nt:unstructured"
jcr:title="Watcher Email Address Dialog"
sling:resourceType="cq/gui/components/authoring/dialog">
<content jcr:primaryType="nt:unstructured"
sling:resourceType="granite/ui/components/foundation/container">
<layout jcr:primaryType="nt:unstructured"
margin="false"
sling:resourceType="granite/ui/components/foundation/layouts/fixedcolumns"
/>
<items jcr:primaryType="nt:unstructured">
<column jcr:primaryType="nt:unstructured"
sling:resourceType="granite/ui/components/foundation/container">
<items jcr:primaryType="nt:unstructured">
<title jcr:primaryType="nt:unstructured"
fieldLabel="Notification Email Address"
name="./jcr:content/watchEmails"
sling:resourceType="granite/ui/components/foundation/form/textfield"
/>
</items>
</column>
</items>
</content>
</cq:dialog>
此範例在觸控式UI的案例中,會產生下列對話方塊:
動態參與者步驟元件與參與者步驟類似,其差異是參與者在運行時自動選擇。
要配置步驟,請選擇參與者選擇器,該選擇器標識要將工作項目分配給的參與者,並選擇對話框。
若要設定此步驟,請編輯並使用下列標籤:
參與者選擇器
對話方塊
建立參與者選擇器。 因此,您可以使用任何選擇邏輯或條件。 例如,您的參與者選擇器可以選擇工作項目最少的用戶(在組內)。 您可以建立任意數量的參與者選擇器,以用於工作流模型中動態參與者步驟元件的不同實例。
建立OSGi服務或ECMAScript,以選擇用戶將工作項指派給它。
ECMAscript
指令碼必須包含名為getParticipant的函式,該函式將用戶ID返回為String
值。 將自訂指令碼儲存在中,例如/apps/myapp/workflow/scripts
資料夾或子資料夾。
標準AEM例項中包含範例指令碼:
/libs/workflow/scripts/initiator-participant-chooser.ecma
您必須不要變更/libs
路徑中的任何項目。
這是因為下次升級執行個體時會覆寫/libs
的內容(當您套用Hotfix或Feature Pack時,則會覆寫)。
此指令碼選擇工作流啟動器作為參與者:
function getParticipant() {
return workItem.getWorkflow().getInitiator();
}
工作流啟動器參與者選擇器元件擴展了動態參與者步驟並將此指令碼用作步驟實施。
OSGi服務
服務必須實施com.day.cq.workflow.exec.ParticipantStepChooser介面。 介面定義以下成員:
SERVICE_PROPERTY_LABEL
欄位:使用此欄位指定參與者選擇器的名稱。該名稱顯示在動態參與者步驟屬性中的可用參與者選擇器清單中。
getParticipant
方法:將動態解析的主體ID返回 String
值。
getParticipant
方法返回動態解析的主體ID。 這可以是群組id或使用者id。
但是,當返回參與者清單時,組ID只能用於參與者步驟。 對於動態參與者步驟 ,返回一個空清單,該清單不能用於委派。
若要讓您的實施可供動態參與者步驟元件使用,請將您的Java類添加到導出服務的OSGi捆綁包中,並將捆綁包部署到AEM伺服器。
隨機參與 者選擇是選取隨機使用者( com.day.cq.workflow.impl.process.RandomParticipantChooser
)的範例服務。隨機參與者選擇 r步驟元件示例擴展了動態參與者步驟,並將此服務用作步驟實施。
以下Java類實現ParticipantStepChooser
介面。 類返回啟動工作流的參與者的名稱。 程式碼使用的邏輯與範例指令碼(initiator-participant-chooser.ecma
)所使用的邏輯相同。
@Property
注釋將SERVICE_PROPERTY_LABEL
欄位的值設定為Workflow Initiator Participant Chooser
。
package com.adobe.example;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Properties;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Service;
import org.osgi.framework.Constants;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.adobe.granite.workflow.WorkflowException;
import com.adobe.granite.workflow.WorkflowSession;
import com.adobe.granite.workflow.exec.ParticipantStepChooser;
import com.adobe.granite.workflow.exec.WorkItem;
import com.adobe.granite.workflow.metadata.MetaDataMap;
@Component
@Service
@Properties({
@Property(name = Constants.SERVICE_DESCRIPTION, value = "An example implementation of a dynamic participant chooser."),
@Property(name = ParticipantStepChooser.SERVICE_PROPERTY_LABEL, value = "Workflow Initiator Participant Chooser (service)") })
public class InitiatorParticipantChooser implements ParticipantStepChooser {
private Logger logger = LoggerFactory.getLogger(this.getClass());
public String getParticipant(WorkItem arg0, WorkflowSession arg1,
MetaDataMap arg2) throws WorkflowException {
String initiator = arg0.getWorkflow().getInitiator();
logger.info("Assigning Dynamic Participant Step work item to {}",initiator);
return initiator;
}
}
在動態參與者步驟屬性對話框中,參與者選擇器清單包含代表此服務的項Workflow Initiator Participant Chooser (script)
。
啟動工作流模型時,日誌指示啟動工作流的用戶的ID以及為其分配了工作項的用戶。 在此示例中,admin
用戶啟動了工作流。
13.09.2015 15:48:53.037 *INFO* [10.176.129.223 [1347565733037] POST /etc/workflow/instances HTTP/1.1] com.adobe.example.InitiatorParticipantChooser Assigning Dynamic Participant Step work item to admin
表單參與者步驟在開啟工作項時顯示表單。 當用戶填寫並提交表單時,欄位資料儲存在工作流裝載的節點中。
要配置步驟,請指定要為其分配工作項的組或用戶以及表單的路徑。
本節內容為頁面編寫的Foundation元件🔗的Forms區段。
若要設定此步驟,請編輯並使用下列標籤:
建立表單,以便與表單參與者步驟一如常使用。 但是,表單參與者步驟的表單必須有下列配置:
Start of Form元件必須將Action Type屬性設定為Edit Workflow Controlled Resource(s)
。
表單的開頭元件必須具有Form Identifier
屬性的值。
表單元件必須將元素名稱屬性設定為儲存欄位資料的節點路徑。 路徑必須在工作流程裝載內容中找到節點。 值使用下列格式:
./jcr:content/path_to_node
表單必須包含工作流程提交按鈕元件。 不配置元件的任何屬性。
工作流程的需求決定您應將欄位資料儲存於何處。 例如,欄位資料可用來設定頁面內容的屬性。 元素名稱屬性的以下值將欄位資料儲存為jcr:content
節點的redirectTarget
屬性的值:
./jcr:content/redirectTarget
在以下範例中,欄位資料會作為裝載頁面上Text元件的內容:
./jcr:content/par/text_3/text
第一個範例可用於cq:Page
元件轉譯的任何頁面。 唯有有效負載頁面包含ID為text_3
的Text元件時,才能使用第二個範例。
表單可以位於儲存庫中的任意位置,但工作流用戶必須獲得讀取表單的授權。
隨機參與者選擇器步驟是參與者選擇器,它將生成的工作項分配給從清單中隨機選擇的用戶。
若要設定此步驟,請編輯並使用下列標籤:
引數
工作流啟動器參與者選擇器步驟是參與者選擇器,它將生成的工作項分配給啟動工作流的用戶。 除了Common屬性以外,沒有其他屬性可配置。
若要設定此步驟,請使用下列標籤進行編輯:
Process Step執行ECMAScript或調用OSGi服務以執行自動處理。
若要設定此步驟,請編輯並使用下列標籤:
程序
程式:要執行的程式實作。使用下拉菜單選擇ECMAScript或OSGi服務。 關於後述資訊::
處理常式進階:選取此選項,即可在執行後自動將工作流程推進至下一個步驟。如果未選取,實施指令碼必須處理工作流程進階。
引數:要傳遞至此進程的參數。
「設定變數」步驟可讓您設定變數的值,並定義值的設定順序。 變數的設定順序為變數對應在「設定變數」步驟中列出的順序。
若要設定此步驟,請編輯並使用下列標籤:
映射
選取變數: 使用此選項來選取要設定其值的變數。
選取對應模式: 選取對應模式以設定變數的值。根據變數的資料類型,您可以使用下列選項來設定變數的值:
指定值: 指定要對應至變數的值。您在此欄位中指定的值取決於對應模式。
新增對應: 使用此選項來新增更多對應以設定變數的值。