Starting Workflows
- Topics:
- Administering
CREATED FOR:
- Admin
When administering workflows you can start them using a variety of methods:
-
Manually:
- From a Workflow Model.
- Using a workflow package for batch processing.
-
Automatically:
- In response to node changes; using a Launcher.
Workflow Models
You can start a workflow based on one of the models listed on the Workflow Models console. The only mandatory information is the payload, though a title and/or comment can be added as well.
Workflows Launchers
The Workflow Launcher monitors changes in the content repository to launch workflows dependent on the location and resource type of the changed node.
Using the Launcher you can:
- See the workflows already launched for specific nodes.
- Select a workflow to be launched when a certain node/node-type has been created/modified/removed.
- Remove an existing workflow-to-node relationship.
A launcher can be created for any node. However, changes to certain nodes do not launch workflows. Changes to nodes below the following paths do not cause workflows to launch:
-
/var/workflow/instances
-
Any workflow-inbox node located anywhere in the
/home/users
branch -
/tmp
-
/var/audit
-
/var/classes
-
/var/eventing
-
/var/linkchecker
-
/var/mobile
-
/var/statistics
- Exception: Changes to nodes below
/var/statistics/tracking
do cause workflows to launch.
- Exception: Changes to nodes below
Various definitions are included with the standard installation. These are used for digital asset management and social collaboration tasks:
Workflow Packages for Batch Processing
Workflow packages are packages that can be passed to a workflow as payload for processing, allowing multiple resources to be processed.
A workflow package:
- contains links to a set of resources (such as pages, assets).
- holds package information such as the creation date, the user that created the package and a short description.
- is defined using a specialized page template; such pages allow the user to specify the resources in the package.
- can be used multiple times.
- can be changed by the user (add or remove resources) while the workflow instance is actually running.
Starting a Workflow from the Models Console
-
Navigate to the Models console using Tools, Workflow, then Models.
-
Select the workflow (according to the console view); you can also use Search (top left) if required:
NOTE
The Transient indicator shows workflows for which the workflow history will not be persisted. -
Select Start Workflow from the toolbar.
-
The Run Workflow dialog will open, allowing you to specify:
-
Payload
This can be a page, node, asset, package, amongst other resources.
-
Title
An optional title to help identify this instance.
-
Comment
An optional comment to help indicate details of this instance.
-
Creating a Launcher Configuration
-
Navigate to the Workflow Launchers console using Tools, Workflow, then Launchers.
-
Select Create, then Add Launcher to open the dialog:
-
Event Type
The event type that will launch the workflow:
- Created
- Modified
- Removed
-
Notetype
The type of node that the workflow launcher applies to.
-
Path
The path that the workflow launcher applies to.
-
Run Mode(s)
The type of server that the workflow launcher applies to. Select Author, Publish, or Author & Publish.
-
Conditions
A list of conditions for node values that, when evaluated, determine whether the workflow is launched. For example, the following condition causes the workflow to launch when the node has a property name with the value User:
name==User
-
Features
A list of features to be enabled. Select the required feature(s) using the drop down selector.
-
Disabled Features
A list of features to be disabled. Select the required feature(s) using the drop down selector.
-
Workflow Model
The workflow to launch when the Event Type occurs on the Nodetype and/or Path under the defined Condition.
-
Description
Your own text to describe and identify the launcher configuration.
-
Activate
Controls whether the workflow launcher is activated:
- Select Enable to launch workflows when the configuration properties are satisfied.
- Select Disable when the workflow should not execute (not even when the configuration properties are satisfied).
-
Exclude List
This specifies any JCR events to exclude (i.e. ignore) when determining whether a workflow should be triggered.
This launcher property is a comma separated list of items: ``
property-name
ignore anyjcr
event which triggered on the specified property name. ``event-user-data:<*someValue*>
ignores any event that contains the*<someValue*
>user-data
set through the [ObservationManager
API](https://www.adobe.io/experience-manager/reference-materials/spec/jsr170/javadocs/jcr-2.0/javax/jcr/observation/ObservationManager.html#setUserData(java.lang.String.
For example:
jcr:lastModified,dc:modified,dc:format,jcr:lastModifiedBy,imageMap,event-user-data:changedByWorkflowProcess
This feature can be used to ignore any changes triggered by another workflow process by adding the exclude item:
event-user-data:changedByWorkflowProcess
-
-
Select Create, to create the launcher and return to the console.
Once the appropriate event occurs the launcher will be triggered and the workflow started.
Managing a Launcher Configuration
After you have created your launcher configuration you can use the same console to select the instance, then View Properties (and edit them) or Delete.
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