Administering Workflow Instances

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

NOTE

The JMX console provides additional workflow maintenance operations.

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

  • Models: Manage workflow definitions
  • Instances: View and manage running workflow instances
  • Launchers: Manage how workflows are to be launched
  • Archive: View history of workflows that completed successfully
  • Failures: View history of workflows that completed with errors

Monitoring the Status of Workflow Instances

  1. Using Navigation select Tools, then Workflow.

  2. Select Instances to display the list of workflow instances currently in progress.

    wf-96

  3. Select a specific item, then Open History to see more details:

    wf-97

Suspending, Resuming, and Terminating a Workflow Instance

  1. Using Navigation select Tools, then Workflow.

  2. Select Instances to display the list of workflow instances currently in progress.

    wf-96-1

  3. Select a specific item, then use Terminate, Suspend, or Resume, as appropriate; confirmation, and/or further details are required:

    wf-97-1

Viewing Archived Workflows

  1. Using Navigation select Tools, then Workflow.

  2. Select Archive to display the list of workflow instances that completed successfully.

    wf-98

    NOTE

    The abort status is considered as a successful termination as it occurs as a result of user action; for example:

    • use of the Terminate action
    • when a page, that is subject to a workflow, is (force) deleted, then the workflow will be terminated

  3. Select a specific item, then Open History to see more details:

    wf-99

Fixing Workflow Instance Failures

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

  • Failure Details
    Opens a window to show the Failure Message, Step and Failure Stack.

  • Open History
    Shows details of the workflow history.

  • Retry Step Executes the Script Step component instance again. Use the Retry Step command after you have fixed the cause of the original errror. For example, retry the step after you fix a bug in the script that the Process Step executes.

  • Terminate Terminate the workflow if the error has caused an irreconsilable situation for the workflow. For example, the workflow can rely on environmental conditions such as information in the respository that are no longer valid for the workflow intance.

  • Terminate and Retry Similar to Terminate except that a new workflow instance is started using the original payload, title, and description.

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

  1. Using Navigation select Tools, then Workflow.

  2. Select Failures to display the list of workflow instances that did not complete successfully.

  3. Select a specific item, then the appropriate action:

    wf-47

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 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 much 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 desribes the properties that you need for either method.

NOTE

For adding the configuration to the repository, the service PID is:

com.adobe.granite.workflow.purge.Scheduler

Because the service is a factory service, the name of the sling:OsgiConfig node requires an identifier suffix, for example:

com.adobe.granite.workflow.purge.Scheduler-myidentifier

Property Name (Web Console) OSGi Property Name Description
Job Name scheduledpurge.name A descriptive name for the scheduled purge.
Workflow Status scheduledpurge.workflowStatus

The status of the workflow instances to purge. The following values are valid:

  • COMPLETED: Completed workflow instances are purged.
  • RUNNING: Running workflow instances are purged.
Models To Purge scheduledpurge.modelIds

The ID of the workflow models to purge. The ID is the path to the model node, for example:
/conf/global/settings/workflow/models/dam/update_asset/jcr:content/model
Specify no value to purge instances of all workflow models.

To specify multiple models, click the + button in the Web Console.

Workflow Age scheduledpurge.daysold The age of the workflow instances to purge, in days.

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.

NOTE

For adding the configuration to the repository, the service PID is:

com.adobe.granite.workflow.core.WorkflowSessionFactory.

Property Name (Web Console) OSGi Property Name
Max Inbox Query Size granite.workflow.inboxQuerySize

Business.Adobe.com resources

Docs links
Automated Onboarding Style System Personalized Experiences Content Intelligence Personalized Communications Digital Asset Management

On this page