DocumentationAEM 6.4Authoring Guide

Participating in Workflows participating-in-workflows

Last update: Wed May 03 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • User
CAUTION
AEM 6.4 has reached the end of extended support and this documentation is no longer updated. For further details, see our technical support periods. Find the supported versions here.

Workflows typically include steps that require a person to perform an activity on a page or asset. The workflow selects a user or group to perform the activity and assigns a work item to that person or group. The user receives notification and can then take the appropriate action:

Notifications of Available Workflow Actions notifications-of-available-workflow-actions

When you are assigned a work item (for example, Approve Content) various alerts and/or notifications appear:

  • Your notification indicator (toolbar) will be incremented:

  • The item will be listed in your notification Inbox:

    wf-58

  • When you are using the page editor the status bar will show:

    • The name of the workflow(s) being applied to the page; for example Request for Activation.

    • Any actions available to the current user for the current step of the workflow; for example, Complete, Delegate, View details.

    • The number of workflows that the page is subject to. You can:

      • use the left/right arrows to navigate through the status information of the various workflows.
      • click/tap on the actual number to open a drop down list of all applicable workflows, then select the workflow you want displayed in the status bar.

    wf-59

    note note
    NOTE
    The status bar is only visible to users with workflow privileges; for example, members of the workflow-users group.
    Actions are shown when the current user is directly involved in the current step of the workflow.

  • When Timeline is open for the resource, the workflow step will be shown. When you click/tap on the alert banner, the available actions will also be shown:

    wf-64

Completing a Participant Step completing-a-participant-step

You can complete an item to allow the workflow to progress to the next step.

On this action you can indicate:

  • Next Step: the next step to be taken; you can select from a list provided
  • Comment: if required

You can complete a participant step from either:

Completing a Participant Step - Inbox completing-a-participant-step-inbox

Use the following procedure to complete the work item:

  1. Open the AEM Inbox.
  2. Select the workflow item you want to take action on (tap/click on the thumbnail).
  3. Select Complete from the toolbar.
  4. The Complete Work Item dialog will open. Select the Next Step from the drop down selector and add a Comment if required.
  5. Use OK to complete the step (or the Cancel to abort the action).

Completing a Participant Step - Page Editor completing-a-participant-step-page-editor

Use the following procedure to complete the work item:

  1. Open the page for editing.
  2. Select Complete from the status bar at the top.
  3. The Complete Work Item dialog will open. Select the Next Step from the drop down selector and add a Comment if required.
  4. Use OK to complete the step (or the Cancel to abort the action).

Completing a Participant Step - Timeline completing-a-participant-step-timeline

You can also use timeline to complete and advance a step:

  1. Select the required page and open Timeline (or open Timeline and select the page):

    wf-65

  2. Click/tap on the alert banner to show available actions. Select Advance:

    wf-66

  3. Depending on the workflow, you can select the next step:

    wf-67

  4. Select Advance to confirm the action.

Delegating a Participant Step delegating-a-participant-step

If a step has been assigned to you, but for any reason you are unable to take action, you can delegate the step to another user or group.

The users who are available for delegation depend on who was assigned the work item:

  • If the work item was assigned to a group, the group members are available.
  • If the work item was assigned to a group and then delegated to a user, the group members and the group are available.
  • If the work item was assigned to a single user, the work item cannot be delegated.

On this action you can indicate:

  • User: the user you want to delegate to; you can select from a list provided
  • Comment: if required

You can delegate a participant step from either:

Delegating a Participant Step - Inbox delegating-a-participant-step-inbox

Use the following procedure to delegate a work item:

  1. Open the AEM Inbox.
  2. Select the workflow item you want to take action on (tap/click on the thumbnail).
  3. Select Delegate from the toolbar.
  4. The dialog will open. Specify the User from the drop down selector (this can also be a group) and add a Comment if required.
  5. Use OK to complete the step (or the Cancel to abort the action).

Delegating a Participant Step - Page Editor delegating-a-participant-step-page-editor

Use the following procedure to delegate a work item:

  1. Open the page for editing.
  2. Select Delegate from the status bar at the top.
  3. The dialog will open. Specify the User from the drop down selector (this can also be a group) and add a Comment if required.
  4. Use OK to complete the step (or the Cancel to abort the action).

Delegating a Participant Step - Timeline delegating-a-participant-step-timeline

You can also use timeline to delegate and/or assign a step:

  1. Select the required page and open Timeline (or open Timeline and select the page).

  2. Click/tap on the alert banner to show available actions. Select Change Assignee:

    wf-69

  3. Specify a new assignee:

    wf-68

  4. Select Assign to confirm the action.

Performing Step Back on a Participant Step performing-step-back-on-a-participant-step

If you discover that a step, or series of steps, needs to be repeated you can step back. This allows you to select a step, that occurred earlier in the workflow, for reprocessing. The workflow returns to the step you specify, then proceeds from there.

On this action you can indicate:

  • Previous Step: the step to be returned to; you can select from a list provided
  • Comment: if required

You can perform step back on a participant step from either:

Performing Step Back on a Participant Step - Inbox performing-step-back-on-a-participant-step-inbox

Use the following procedure to step back:

  1. Open the AEM Inbox.

  2. Select the workflow item you want to take action on (tap/click on the thumbnail).

  3. Select Step Back to open the dialog.

  4. Specify the Previous Step and add a Comment if required.

  5. Use OK to complete the step (or the Cancel to abort the action).

Performing Step Back on a Participant Step - Page Editor performing-step-back-on-a-participant-step-page-editor

Use the following procedure to step back:

  1. Open the page for editing.
  2. Select Step Back from the status bar at the top.
  3. Specify the Previous Step and add a Comment if required.
  4. Use OK to complete the step (or the Cancel to abort the action).

Performing Step Back on a Participant Step - Timeline performing-step-back-on-a-participant-step-timeline

You can also use timeline to roll (step) back to a previous step:

  1. Select the required page and open Timeline (or open Timeline and select the page).

  2. Click/tap on the alert banner to show available actions. Select Roll back:

    wf-69-1

  3. Specify the step the workflow should return to:

    wf-70

  4. Select Roll back to confirm the action.

Opening a Workflow Item to View Details (and Take Actions) opening-a-workflow-item-to-view-details-and-take-actions

View details of the workflow work item and take appropriate actions.

The workflow details are shown in tabs and appropriate actions are available in the toolbar:

  • WORKITEM tab:

    wf-72

  • WORKFLOW INFO

    wf-73

    If Workflow Stages have been configured for the model, you can view the progress according to these:

    wf-107

  • COMMENTS

    wf-75

You can open the work item details from either:

Opening Workflow Details - Inbox opening-workflow-details-inbox

To open a workflow item and view the details:

  1. Open the AEM Inbox.

  2. Select the workflow item you want to take action on (tap/click on the thumbnail).

  3. Select Open to open the information tabs.

  4. If required, select the appropriate action, supply any details and confirm with OK (or Cancel).

  5. Use Save or Cancel to exit.

Opening Workflow Details - Page Editor opening-workflow-details-page-editor

To open a workflow item and view the details:

  1. Open the page for editing.

  2. Select View Details from the status bar to open the information tabs.

  3. If required, select the appropriate action, supply any details and confirm with OK (or Cancel).

  4. Use Save or Cancel to exit.

Viewing the Workflow Payload (Multiple Resources) viewing-the-workflow-payload-multiple-resources

You can view details of the payload associated with the workflow instance. Initially the resources in the package are shown, then you can drill down to show the individual pages.

To view the payload, and resources, of the workflow instance:

  1. Open the AEM Inbox.

  2. Select the workflow item you want to take action on (tap/click on the thumbnail).

  3. Select View Payload from the toolbar to open the dialog.

    As a workflow package is simply a collection of pointers to paths within the repository, you can add/remove/modify the entries here to adjust what is referenced by the workflow package. Use the Resource Definition component to add new entries.

    wf-78

  4. The links can be used to open the individual pages.

recommendation-more-help
5f6f1f67-8db1-40cb-84e9-024e65b9fc4c