Administering Workflow Instances administering-workflow-instances

The workflow console provides several tools for administering workflow instances to ensure that they are executing as expected.

A range of consoles are available for administering your workflows. Use the global navigation to open the Tools pane, then select Workflow:

Monitoring the Status of Workflow Instances monitoring-the-status-of-workflow-instances

Suspending, Resuming, and Terminating a Workflow Instance suspending-resuming-and-terminating-a-workflow-instance

Viewing Archived Workflows viewing-archived-workflows

Fixing Workflow Instance Failures fixing-workflow-instance-failures

When a workflow fails, AEM provides the Failures console to let you investigate and take appropriate action once the original cause has been handled:

To investigate failures, then resume or terminate the workflow afterwards, use the following steps:

Regular Purging of Workflow Instances regular-purging-of-workflow-instances

Minimizing the number of workflow instances increases the performance of the workflow engine, so you can regularly purge completed or running workflow instances from the repository.

Configure Adobe Granite Workflow Purge Configuration to purge workflow instances according to their age and status. You can also purge workflow instances of all models or of a specific model.

You can also create multiple configurations of the service to purge workflow instances that satisfy different criteria. For example, create a configuration that purges the instances of a particular workflow model when they are running for longer than the expected time. Create another configuration that purges all completed workflows after a certain number of days to minimize the size of the repository.

To configure the service, you can use the Web Console or add an OSGi configuration to the repository. The following table describes the properties that you need for either method.

Setting the Maximum Size of the Inbox setting-the-maximum-size-of-the-inbox

You can set the maximum size of the inbox by configuring the Adobe Granite Workflow Service, using the Web Console or add an OSGi configuration to the repository. The following table describes the property that you configure for either method.

Using Workflow variables for customer-owned datastores using-workflow-variables-customer-datastore

Data processed by workflows is stored in the Adobe provided storage (JCR). This data can be sensitive in nature. You may want to save all the user-defined metadata/data in your own managed storage instead of Adobe provided storage. These sections describe how to set up these variables for external storage.

Set the model to use external storage of metadata set-model-for-external-storage

At the level of workflow model, a flag is provided to indicate that the model (and its runtime instances) has external storage of metadata. Workflow variables are not persisted in JCR for the workflow instances of the models marked for external storage.

The property userMetadataPersistenceEnabled is stored on the jcr:content node of the workflow model. This flag is persisted in workflow metadata as cq:userMetaDataCustomPersistenceEnabled.

The illustration below shows how to set the flag on a workflow.

APIs for metadata in external storage apis-for-metadata-external-storage

To store the variables externally, implement the APIs that the workflow exposes.

UserMetaDataPersistenceContext

The following samples show you how to use the 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;
}