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:
- 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 monitoring-the-status-of-workflow-instances
-
Using Navigation select Tools, then Workflow.
-
Select Instances to display the list of workflow instances currently in progress.
-
Select a specific item, then Open History to see more details:
Suspending, Resuming, and Terminating a Workflow Instance suspending-resuming-and-terminating-a-workflow-instance
-
Using Navigation select Tools, then Workflow.
-
Select Instances to display the list of workflow instances currently in progress.
-
Select a specific item, then use Terminate, Suspend, or Resume, as appropriate; confirmation, and/or further details are required:
Viewing Archived Workflows viewing-archived-workflows
-
Using Navigation select Tools, then Workflow.
-
Select Archive to display the list of workflow instances that completed successfully.
note note 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
-
Select a specific item, then Open History to see more details:
Fixing Workflow Instance Failures 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:
-
Using Navigation select Tools, then Workflow.
-
Select Failures to display the list of workflow instances that did not complete successfully.
-
Select a specific item, then the appropriate action:
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 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.
com.adobe.granite.workflow.purge.Schedulersling:OsgiConfig node requires an identifier suffix, for example:com.adobe.granite.workflow.purge.Scheduler-myidentifierSetting 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.
com.adobe.granite.workflow.core.WorkflowSessionFactory.