Administering Workflow Instances
- Topics:
- Administering
CREATED FOR:
- Admin
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
-
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
-
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
-
Using Navigation select Tools, then Workflow.
-
Select Archive to display the list of workflow instances that completed successfully.
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
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
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.Scheduler
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:
|
Models To Purge | scheduledpurge.modelIds |
The ID of the workflow models to purge. The ID is the path to the model node, for example: 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.
com.adobe.granite.workflow.core.WorkflowSessionFactory
.Property Name (Web Console) | OSGi Property Name |
---|---|
Max Inbox Query Size | granite.workflow.inboxQuerySize |
Experience Manager
- Administering User Guide overview
- Sites Features
- Website Administration
- Reusing Content: Multi Site Manager and Live Copy
- Live Copy Overview Console
- Configuring Live Copy Synchronization
- Creating and Synchronizing Live Copies
- MSM Rollout Conflicts
- MSM Best Practices
- Translating Content for Multilingual Sites
- Managing Translation Projects
- Identifying Content to Translate
- Preparing Content for Translation
- Creating a Language Root Using the Classic UI
- Connecting to Microsoft Translator
- Configuring the Translation Integration Framework
- Language Copy Wizard
- Translation Enhancements
- Translation Best Practices
- Configurations and the Configuration Browser
- AEM FAQs
- Operations
- Dashboards
- Operations Dashboard
- Backup and Restore
- Data Store Garbage Collection
- Monitoring Server Resources Using the JMX Console
- Working with Logs
- Configure the Rich Text Editor
- Configure the Video component
- The Bulk Editor
- Configuring Email Notification
- Configuring RTE for Producing Accessible Sites
- The Link Checker
- Troubleshooting AEM
- Audit Log Maintenance in AEM 6
- Editor
- Managing Access to Workflows
- Using cURL with AEM
- Configuring Undo for Page Editing
- Proxy Server Tool (proxy.jar)
- Configuring for AEM Apps
- Administering Workflows
- Configuring Search Forms
- Tools Consoles
- Reporting
- Administering Workflow Instances
- Configuring Layout Container and Layout Mode
- Enabling Access to Classic UI
- Starting Workflows
- Configure the Rich Text Editor plug-ins
- Admin Consoles
- Security
- User Administration and Security
- User, Group and Access Rights Administration
- Security Checklist
- OWASP Top 10
- Running AEM in Production Ready Mode
- Identity Management
- Adobe IMS Authentication and Admin Console Support for AEM Managed Services
- Creating a Closed User Group
- Mitigating serialization issues in AEM
- User Synchronization
- Encapsulated Token Support
- Single Sign On
- How to Audit User Management Operations in AEM
- SSL By Default
- SAML 2.0 Authentication Handler
- Closed User Groups in AEM
- Granite Operations - User and Group Administration
- Enabling CRXDE Lite in AEM
- Configuring LDAP with AEM 6
- Configure the Admin Password on Installation
- Service Users in AEM
- Encryption Support for Configuration Properties
- Handling GDPR Requests for the AEM Foundation
- Content Disposition Filter
- Personalization
- eCommerce
- Integration
- Integrating with Third-Party Services
- Integrating with Salesforce
- Integrating with Adobe Target
- Integrating with Adobe Analytics
- Connecting to Adobe Analytics and Creating Frameworks
- Configuring Link Tracking for Adobe Analytics
- Mapping Component Data with Adobe Analytics Properties
- Configuring Video Tracking for Adobe Analytics
- HTTP2 Delivery of Content FAQ
- Troubleshooting your Adobe Campaign Integration
- SharePoint Connector Licenses, Copyright Notices, and Disclaimers
- SharePoint Connector
- DHTML Viewer End-of-Life FAQs
- Integrating with Adobe Campaign Classic
- Related Community Articles
- Integrating with Adobe Campaign Standard
- Flash Viewers End-of-Life Notice
- Integrating with Adobe Creative Cloud
- Integrating with Adobe Dynamic Tag Management
- Opting Into Adobe Analytics and Adobe Target
- AEM Portals and Portlets
- Integrating with Dynamic Media Classic
- Troubleshooting Integration Issues
- Integrating with BrightEdge Content Optimizer
- Best Practices for Email Templates
- Catalog Producer
- Integrating with Silverpop Engage
- Integrating with Adobe Campaign
- Integrating with ExactTarget
- Analytics with External Providers
- Integrating with the Adobe Marketing Cloud
- Manually Configuring the Integration with Adobe Target
- Prerequisites for Integrating with Adobe Target
- Adobe Classifications
- Solutions Integration
- Target Integration with Experience Fragments
- Best Practices
- Content Management