Workflow Sub-actions - Documentation topics on: subactions,workflow,workflow subactions,.

Workflow Sub-actions

A variety of workflow sub-actions can be triggered when a workflow action is selected. When the workflow action is selected by the content publisher, all of the sub-actions assigned to that workflow action are triggered, in the order the sub-actions are listed in the workflow action.

Built-In Workflow Sub-Actions

dotCMS includes all of the following built-in sub-actions. You may select any number of these sub-actions, and execute them in whatever order you wish, for each workflow action.

Many sub-actions have additional parameters; depending on the sub-action, some or all of these parameters may be required for the sub-action to function properly. In the list below, all parameters listed are required, unless they are explicitly marked as (Optional).

Sub-ActionParametersDescription
Archive contentNoneArchives the content item.
Comment on WorkflowWorkflow Comment (Optional)Adds a comment to the content item workflow.
If no Workflow Comment parameter is specified, the user will be prompted to enter a comment.
Delete contentNoneDeletes the content item.
Link CheckerList of fields to checkUses the Link Checker to check the specified fields for links, and verify that any links found are valid.
Lock contentNoneLocks the content item.
Notify AssigneeEmail Subject (Optional),
Email Message (Optional),
Is Html (Optional)
Notifies all assigned users that the Workflow Action was taken.
If the assignee is a single user, that user will be notified; if the assignee is a Role, all users assigned that Role will be notified simultaneously.
Any parameters which are not specified will be filled in with automatically assigned default values.
Notify UsersUsers, Emails and Roles,
Email Subject (Optional),
Email Message (Optional),
Is Html? (Optional)
Notifies the specified users
Publish contentNoneChanges the state of the content item to Published.
Push NowNonePush publishes the content item to the default Push Publishing Environment.
Push PublishNoneDisplays the Push publishing pop-up to the user who initiated the workflow action, allowing them to select both the push method and the Push Publishing Environment to push to.
Require Multiple ApproversUser IDs or Emails,
Email Subject (Optional),
Email Message (Optional)
Sends email to the specified users or email addresses requiring approval from all of them.
Reset WorkflowNoneResets the content item back to the initial Workflow step.
Send an EmailFrom Email,
From Name,
To Email,
To Name,
Cc Email (Optional),
Bcc Email (Optional),
Email Subject,
Email Body,
Condition (Optional),
Attachments (Optional)
Sends an email with specified content to a specified list of users.
Note: Unlike the Notify Assignee sub-action, if any of this sub-action's parameters are not filled in they will be left blank in the email sent (they will not be filled in with default values).
Set ValuevelocityVar Name,
Value to set
Sets the value of the specified Velocity variable to the specified value.
Translate ContentTranslate to,
Translate Field Types,
Ignore Fields (Optional),
Service API Key
Automatically translates all specified fields types of the content item to the specified languages using Google Translate.
Twitter Status UpdateConsumer Key,
Consumer Secret,
Access Token,
Access Token Secret,
Field to Post (Optional)
Post a Twitter update to a specific Twitter account.
Unarchive contentNoneUnarchives the content item (changing it from the Archived state to the Unpublished state).
Unlock contentNoneUnlocks the content item.
Unpublish contentNoneUpublishes the content item (changing the content object from the Published state to the Unpublished state).

Custom Sub-Actions

You may create your own custom sub-actions by using an OSGI plugin to create a custom workflow actionlet.

As an alternative (or in addition to) an OSGI plugin, you may also implement various kinds of functionality using Velocity code, by entering Velocity code into the Custom Code field on the Workflow Action.