ワークフローインスタンスの管理 administering-workflow-instances

ワークフローコンソールには、ワークフローインスタンスを管理し、それらが想定どおりに実行されていることを確認するための複数のツールが用意されています。

ワークフローの管理用に、次の各種コンソールが用意されています。グローバルナビゲーションを使用して​ ツール ​パネルを開き、その後「ワークフロー」を選択します。

ワークフローインスタンスのステータスの監視 monitoring-the-status-of-workflow-instances

ワークフローインスタンスの休止、再開および終了 suspending-resuming-and-terminating-a-workflow-instance

アーカイブされたワークフローの表示 viewing-archived-workflows

ワークフローインスタンスのエラーの修正 fixing-workflow-instance-failures

ワークフローが失敗した場合、AEM の​ エラー ​コンソールを使用してエラーの原因を調べ、特定された原因に応じて適切なアクションを取ることができます。

エラーを調査し、その後ワークフローを再開または停止するには、次のステップに従います。

ワークフローインスタンスの定期的なパージ regular-purging-of-workflow-instances

ワークフローインスタンスの数を最小限に抑えるとワークフローエンジンのパフォーマンスが向上します。このため、完了したまたは実行中のワークフローインスタンスをリポジトリーから定期的に削除できます。

有効期間とステータスに応じてワークフローインスタンスをパージするように Adobe Granite のワークフローのパージ設定 ​を設定します。また、すべてのモデルまたは特定のモデルのワークフローインスタンスをパージすることもできます。

また、様々な条件を満たすワークフローインスタンスをパージするために、サービスの設定を複数作成することもできます。例えば、予想よりも実行時間が長い特定のワークフローモデルのインスタンスをパージする設定を作成します。さらに、リポジトリのサイズを最小限に抑えるために、特定の日数が経過した後に完了したワークフローをすべてパージするもう 1 つの設定を作成します。

サービスを設定するには、web コンソールを使用するか、リポジトリに OSGi 設定を追加することができます。次の表では、どちらの方法でも必要になるプロパティについて説明しています。

インボックスの最大サイズの設定 setting-the-maximum-size-of-the-inbox

インボックスの最大サイズは、Web コンソールを使用して Adobe Granite Workflow Service を設定する、またはリポジトリに OSGi 設定を追加することで設定できます。次の表では、どちらの方法でも設定するプロパティについて説明しています。

顧客所有のデータストアに対するワークフロー変数の使用 using-workflow-variables-customer-datastore

ワークフローで処理されたデータは、アドビ提供のストレージ（JCR）に保存されます。このデータは、本来、機密性が高い可能性があります。ユーザー定義のメタデータ／データをすべて、アドビ提供のストレージではなく、ユーザー管理のストレージに保存することができます。以下の節では、これらの変数を外部ストレージ用に設定する方法について説明します。

メタデータの外部ストレージを使用するようにモデルの設定 set-model-for-external-storage

ワークフローモデルのレベルでは、モデル（およびそのランタイムインスタンス）にメタデータの外部ストレージが含まれていることを示すフラグが用意されています。外部ストレージ用にマークされたモデルのワークフローインスタンスに対するワークフロー変数は JCR に保持されません。

userMetadataPersistenceEnabled プロパティがワークフローモデルの jcr:content ノードに格納されます。このフラグは、ワークフローメタデータに cq:userMetaDataCustomPersistenceEnabled として保持されます。

以下の図は、ワークフローにフラグを設定する方法を示しています。

外部ストレージ内のメタデータの 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;
}