You're viewing help content for version:

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.

Touch-Optimized UI

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.

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

    chlImage_1

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.

    chlImage_1
  3. Select a specific item, then use Terminate, Suspend, or Resume, as appropriate:

    chlImage_1

Viewing Archived Workflows

  1. Using Navigation select Tools, then Workflow

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

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

    chlImage_1

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:

    chlImage_1

Classic UI

Open the workflow console using the Workflows link on the AEM Welcome page (Classic UI), and the Tools section of the touch-optimized UI.

Within the console are several tabs:

chlImage_1
  • Models
    Lists the workflow models currently available. Here you can start, create, edit or delete workflow models.
  • Instances
    Shows you details of workflow instances which are currently active. These instances are also version dependent.
  • Archive
    Enables you to access details of workflow instances which have terminated, for whatever reason.
  • Launcher
    Allows you to define a workflow to be launched if a specific node has been updated.
  • Failures
    Enables you to monitor and manage failed worklow instances.

Monitoring the Status of Workflow Instances - Classic UI

To monitor the status of workflow instances, you can use the Instances or Archive tabs.

  • Instances: Shows all running instances.
  • Archive: Shows terminated workflow instances. 

From the Instances tab you can see the status of a Workflow in progress. A list of the active Models is shown; in this case RUNNING:

chlImage_1

Select an instance and click Open History to show the actions executed to date on the workflow instance:

chlImage_1

You can also use the JMX console to see a list of running and completed workflows.

Suspending, Resuming, and Terminating a Workflow Instance - Classic UI

Perform actions on running workflow instances when you need to intervene in the normal progression of a workflow instance:

  1. Select the Instances tab. You will see a list of active (neither finished, nor terminated) workflow instances.

    chlImage_1
  2. Select an entry.

  3. In the navigation bar, click Suspend, Resume, or Terminate.

The Instances tab is not only useful for taking action on running workflows, you can also use it to monitor workflow instances, without necessarily modifying them.

Fixing Workflow Instance Failures - Classic UI

Workflow instances appear on the Failures tab of the Workflows console when the execution of a Process Step component results in errors. The Failures tab enables you to investigate the cause of the errors, and provides options for resuming execution when the causes are fixed:

  • Failure Details

    Provides information about the execution error, including the name of the step that failed, the error message, and the stack trace for the error.

    chlImage_1
  • 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 Workflow

    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 Start New Workflow

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

You can use the JMX console to terminate and retry workflows as a bulk operation.

  1. Select the Failures tab and select a workflow intance.

  2. Click Failure Details, Retry Step, Terminate Workflow, or Terminate and Start New Workflow.

Viewing Archived Workflows - Classic UI

After a Workflow instance has finished, for example after being terminated or after successful completion, it can (only) be seen in the Archive tab:

chlImage_1

As the workflow has already completed, no further action can be taken on these instances. However, if you need further details of a completed workflow you can use Open History.

You can use the JMX console to purge the repository of completed workflows or schedule regular purging. If the list of archived workflows grows too large, purge those that are of a certain age to speed page loading.

Configuration (OSGi)

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 /etc/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

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy