Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added section about Content Fragments workflows #73

Merged
merged 4 commits into from
Feb 28, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions gatsby-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,10 @@ module.exports = {
{
title: "Export Content Fragments to Adobe Target",
path: "/extension-manager/extension-developed-by-adobe/exporting-content-fragment-to-adobe-target"
},
{
title: "Content Fragments Workflows",
path: "/extension-manager/extension-developed-by-adobe/content-fragments-workflows"
}
]
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
title: Content Fragments workflows
description: Explore enhanced functionality in the Content Fragments Console and AEM Content Fragment Editor, simplifying workflow initiation.
contributors:
- AdobeDocs/uix
---

# Content Fragments workflows

This extension provides UI extensibility, allowing customers to initiate an AEM workflow for selected content fragments.
naydav marked this conversation as resolved.
Show resolved Hide resolved

## Extension overview

The extension enhances two AEM services: [AEM Content Fragments Console](../../../services/aem-cf-console-admin/) and [AEM Content Fragment Editor](../../../services/aem-cf-editor/). It adds a button to the `Action Bar` for the Content Fragments Console and a button to the `Header Menu` for the AEM Content Fragment Editor.
naydav marked this conversation as resolved.
Show resolved Hide resolved

AEM Content Fragments Console:

![AEM Content Fragments Console](workflow-extension-cf-admin.png)

naydav marked this conversation as resolved.
Show resolved Hide resolved
AEM Content Fragment Editor:

![AEM Content Fragment Editor](workflow-extension-cf-editor.png)

When clicked, it opens a modal dialog through which you can initiate a workflow.

## Workflows modal and workflow launching

![Workflows Modal and Workflow launching](workflow-extension-popup.png)

The modal dialog consists of several elements through which you can initiate a workflow:

- `Workflow Model` - a dropdown menu containing the workflows available to you within the organization.
- `Workflow Title` - a title input field of the workflow process, which will be displayed on the result page of launched workflows in AEM.
- `Content Fragments Grid` - a grid displaying a list of content fragments for which the workflow will be launched.
- `Start Workflow button` - when clicked, initiates the workflow initialization process. The workflow starts asynchronously in the background of the application.

To launch a workflow, you need to fill in all the required fields and click the "Start Workflow" button. This will initiate the workflow for each content fragment asynchronously. Each content fragment will have its own workflow process.

## Working with references

Within the grid listing the content fragments, there are two additional columns: `References` and `References By` along with the ability to mark these options for each content fragment in the list using checkboxes.

- `References` - by selecting this checkbox, you indicate that a separate workflow process should be created for all children fragments (references) up to the maximum allowed depth. If no children fragments (references) exist for this content fragment, the checkbox will not be displayed.
- `References By` - by selecting this checkbox, you indicate that a process will be created for its **direct** parent reference as well (not all parents in the "tree"). If the parent fragment's reference does not exist for this content fragment, the checkbox will not be displayed.

**Notice:** when selecting multiple content fragments and combining the selected options of `References` and `References By`, workflows will be launched only once for each content fragment (the one selected and its children or parent reference, depending on the specified options).

For example, when selecting both parent and children content fragments and enabling the options `References` and `References By` for them, only one workflow will be created for each content fragment, avoiding duplication of workflows and cyclic dependencies during workflows launching.

[Learn about using references in Content Fragments](https://experienceleague.adobe.com/docs/experience-manager-cloud-service/content/headless/journeys/author/references.html?lang=en)

## Result of running

After clicking the `Start Workflow` button, the initialization of starting the workflow with the selected parameters will begin. You will then see the result of the workflow process start and several links to AEM pages, where you can view the execution result of the launched workflow.

![Result of running](workflow-extension-result.png)

**Notice:** the status of the workflow start will be displayed, but not the result of its completion, which occurs asynchronously in the background. To find out the final result of the workflow execution, you need to follow the links that will be displayed below the result grid.

## Limitations

- `List of Workflows` - currently, by default, the dropdown displays a list of all workflows available for the organization. Limiting this list can be achieved through appropriate ACL configurations for the user.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,14 @@ contributors:

Welcome to the Extensions Developed By Adobe! Explore user guides here to learn how to configure your environment for utilizing extensions from the Extension Manager, along with the supported user flows.

[Exporting Content Fragment to Adobe Target](exporting-content-fragment-to-adobe-target)
<DiscoverBlock slots="link, text"/>

[Exporting Content Fragment to Adobe Target](exporting-content-fragment-to-adobe-target)

Explore Exporting Content Fragments to Adobe Target

<DiscoverBlock slots="link, text"/>

[Content Fragments workflows](content-fragments-workflows)

Explore enhanced functionality in the Content Fragments Console and AEM Content Fragment Editor, simplifying workflow initiation
Loading