管理工作流程例項 administering-workflow-instances

工作流程主控台提供了幾個用於管理工作流程執行個體的工具,以確保它們按預期執行。

有一系列的主控台可用來管理工作流程。 使用 全域導覽 以開啟 工具 窗格,然後選取 工作流程

  • 模型:管理工作流程定義
  • 例項:檢視及管理執行中的工作流程例項
  • 啟動器:管理如何啟動工作流程
  • 封存:檢視成功完成的工作流程歷史記錄
  • 失敗:檢視已完成但發生錯誤的工作流程歷史記錄
  • 自動指派:設定範本的自動指派工作流程

監控工作流程例項狀態 monitoring-the-status-of-workflow-instances

  1. 使用導覽選取 工具,然後 工作流程.

  2. 選取 例項 以顯示目前進行中的執行中工作流程例項清單。

  3. 在頂端欄的右角,工作流程例項顯示 執行中的工作流程狀態、和 詳細資料.

  4. 執行中的工作流程 顯示執行中的工作流程數目及其狀態。 例如,在指定的影像中,顯示的數字為 執行中的工作流程狀態 的AEM執行個體:

    • 狀態:狀況良好

      status-health

    • 狀態:狀況不良

      status-unhealth

  5. 狀態詳細資料 在工作流程例項中,按一下 詳細資料,以顯示 執行中的工作流程例項數目已完成的工作流程例項中止的工作流程例項失敗的工作流程例項,以此類推。 例如,底下是顯示的指定影像 狀態詳細資料 替換為:

    • 狀態詳細資料:狀況良好

      status-details-healthy

    • 狀態詳細資料:狀況不良

      status-details-unhealthy

    note note
    NOTE
    若要維持工作流程例項正常運作,請遵循以下最佳實務 定期清除工作流程例項工作流程最佳實務.

搜尋工作流程例項 search-workflow-instances

  1. 使用導覽選取 工具,然後 工作流程.

  2. 選取 例項 顯示目前進行中的工作流程例項清單。 在頂端欄的左角,選取 篩選器. 或者,您也可以使用alt+1鍵。 下列對話方塊隨即顯示:

    wf-99-1

  3. 在「篩選」對話方塊中,選取工作流程搜尋條件。 您可以根據下列輸入進行搜尋:

    • 裝載路徑:選取特定路徑
    • 工作流程模型:選取工作流程模型
    • 受指派人:選取工作流程受指派人
    • 型別:工作、工作流程專案或工作流程失敗
    • 工作狀態:作用中、完成或已終止
    • 我的角色:擁有者與受指派人、僅限擁有者、僅限受指派人
    • 開始日期:指定日期之前或之後的開始日期
    • 結束日期:指定日期之前或之後的結束日期
    • 到期日:指定日期之前或之後的到期日
    • 更新日期:指定日期之前或之後的更新日期

暫停、恢復和終止工作流程例項 suspending-resuming-and-terminating-a-workflow-instance

  1. 使用導覽選取 工具,然後 工作流程.

  2. 選取 例項 顯示目前進行中的工作流程例項清單。

    wf-96-1

  3. 選取特定專案,然後使用 終止暫停,或 繼續,視情況而定;需要確認和/或進一步詳細資訊:

    wf-97-1

    note note
    NOTE
    若要終止或中止工作流程,工作流程必須處於等待使用者介入的狀態,例如「參與者步驟」。 嘗試中止目前正在執行工作的工作流程(執行中的作用中執行緒)可能不會產生預期的結果。

檢視已封存的工作流程 viewing-archived-workflows

  1. 使用導覽選取 工具,然後 工作流程.

  2. 選取 封存 顯示已成功完成的工作流程例項清單。

    archived-instances

    note note
    NOTE
    中止狀態會被視為成功終止,因為它是使用者動作的結果;例如:
    • 使用 終止 動作
    • 當受工作流程約束的頁面被(強制)刪除時,工作流程就會終止。
  3. 選取特定專案,然後 開啟歷史記錄 若要檢視更多詳細資料:

    wf-99

修正工作流程例項失敗 fixing-workflow-instance-failures

當工作流程失敗時,AEM會提供 失敗 主控台,可讓您在處理原始原因後進行調查並採取適當的動作:

  • 失敗詳細資料
    開啟視窗以顯示 失敗訊息步驟和 ​ 失敗棧疊**.

  • 開啟歷史記錄
    顯示工作流程記錄的詳細資料。

  • 重試步驟 再次執行指令碼步驟元件例項。 修復原始錯誤的原因後,使用「重試步驟」指令。 例如,修正程式步驟所執行指令碼中的錯誤後,請重試該步驟。

  • 終止 如果錯誤導致工作流程出現無法調解的情況,則終止工作流程。 例如,工作流程可以仰賴環境條件,例如存放庫中對工作流程例項不再有效的資訊。

  • 終止並重試 類似於 終止 但新工作流程例項是使用原始裝載、標題和說明啟動。

若要調查失敗,然後恢復或終止工作流程,請使用下列步驟:

  1. 使用導覽選取 工具,然後 工作流程.

  2. 選取 失敗 以顯示未成功完成的工作流程例項清單。

  3. 選取特定專案,然後選取適當的動作:

工作流程失敗

定期清除工作流程執行個體 regular-purging-of-workflow-instances

將工作流程例項的數目降至最低會提升工作流程引擎的效能,因此您可以定期從儲存庫中清除已完成或執行中的工作流程例項。

設定 AdobeGranite工作流程清除設定 根據工作流程例項的年齡和狀態來永久刪除工作流程例項。 您也可以清除所有模型或特定模型的工作流程例項。

您也可以建立多個服務組態,以永久刪除滿足不同條件的工作流程例項。 例如,建立一個設定,當特定工作流程模型的執行個體執行的時間遠超過預期時間時,該設定會清除這些執行個體。 建立另一個設定,該設定會在幾天後清除所有已完成的工作流程,以將存放庫的大小降至最低。

若要設定服務,您可以設定OSGi設定檔案,請參閱 OSGi設定檔案. 下表說明任一方法所需的特性。

NOTE
若要將設定新增至存放庫,服務PID為:
com.adobe.granite.workflow.purge.Scheduler
因為服務是工廠服務,所以此服務的名稱 sling:OsgiConfig 節點需要識別碼尾碼,例如:
com.adobe.granite.workflow.purge.Scheduler-myidentifier
屬性名稱(Web主控台)
OSGi屬性名稱
說明
工作名稱
scheduledpurge.name
排定永久刪除的描述性名稱。
工作流程狀態
scheduledpurge.workflowStatus

要清除的工作流程執行處理的狀態。 下列值有效:

  • 已完成:已永久刪除已完成的工作流程執行個體。
  • 執行中:清除執行中的工作流程執行個體。
要永久刪除的模型
scheduledpurge.modelIds

要清除的工作流程模型識別碼。 ID是模型節點的路徑,例如:
/conf/global/settings/workflow/models/dam/update_asset/jcr:content/model
不指定任何值以清除所有工作流程模型的執行個體。

若要指定多個模型,請按一下Web主控台中的+按鈕。

工作流程期限
scheduledpurge.daysold
要清除的工作流程例項期限(以天為單位)。

設定收件匣大小上限 setting-the-maximum-size-of-the-inbox

您可以透過設定 AdobeGranite工作流程服務,請參閱 將OSGi設定新增到存放庫. 下表說明您設定的屬性。

NOTE
若要將設定新增至存放庫,服務PID為:
com.adobe.granite.workflow.core.WorkflowSessionFactory.
屬性名稱(Web主控台)
OSGi屬性名稱
最大收件匣查詢大小
granite.workflow.inboxQuerySize

對客戶擁有的資料存放區使用工作流程變數 using-workflow-variables-customer-datastore

工作流程處理的資料儲存在Adobe提供的儲存空間(JCR)。 此資料本質上可能是敏感資料。 您可能希望將所有使用者定義的中繼資料/資料儲存在您自己的受管理儲存空間中,而非Adobe提供的儲存空間。 以下各節說明如何為外部儲存設定這些變數。

設定模型以使用中繼資料的外部儲存 set-model-for-external-storage

在工作流程模型的層級,會提供旗標,指出模型(及其執行階段執行個體)具有中繼資料的外部儲存。 對於標籤為外部儲存的模型的工作流程例項,工作流程變數將不會儲存在JCR中。

屬性 userMetadataPersistenceEnable 儲存在 jcr:content節點 的工作流程模型的。 此旗標會持續保留在工作流程中繼資料中,做為 cq:userMetaDataCustomPersistenceEnabled.

下圖說明如何在工作流程上設定標幟。

workflow-externalize-config

外部儲存空間中中繼資料的API apis-for-metadata-external-storage

若要在外部儲存變數,您必須實作工作流程公開的API。

UserMetaDataPersistenceContext

以下範例說明如何使用API。

@ProviderType
public interface UserMetaDataPersistenceContext {

    /**
     * Gets the workflow for persistence
     * @return workflow
     */
    Workflow getWorkflow();

    /**
     * Gets the workflow id for persistence
     * @return workflowId
     */
    String getWorkflowId();

    /**
     * Gets the user metadata persistence id
     * @return userDataId
     */
    String getUserDataId();
}

UserMetaDataPersistenceProvider

/**
 * This provider can be implemented to store the user defined workflow-data metadata in a custom storage location
 */
@ConsumerType
public interface UserMetaDataPersistenceProvider {

   /**
    * Retrieves the metadata using a unique identifier
    * @param userMetaDataPersistenceContext
    * @param metaDataMap of user defined workflow data metaData
    * @throws WorkflowException
    */
   void get(UserMetaDataPersistenceContext userMetaDataPersistenceContext, MetaDataMap metaDataMap) throws WorkflowException;

   /**
    * Stores the given metadata to the custom storage location
    * @param userMetaDataPersistenceContext
    * @param metaDataMap metadata map
    * @return the unique identifier that can be used to retrieve metadata. If null is returned, then workflowId is used.
    * @throws WorkflowException
    */
   String put(UserMetaDataPersistenceContext userMetaDataPersistenceContext, MetaDataMap metaDataMap) throws WorkflowException;

}
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab