Bonnes pratiques en matière de workflow workflow-best-practices

Les workflows vous permettent d’automatiser les activités d’Adobe Experience Manager (AEM).

Ils représentent souvent une grande partie du traitement effectué dans un environnement AEM. Ainsi, lorsque les étapes de workflow personnalisées ne sont pas écrites conformément aux bonnes pratiques ou que les workflows prêts à l’emploi ne sont pas configurés pour s’exécuter aussi efficacement que possible, cela peut nuire au système.

Il est donc vivement conseillé de planifier soigneusement vos implémentations de workflow.

Configuration configuration

Lors de la configuration de processus de workflows (personnalisés et/ou prêts à l’emploi), il convient de garder quelques éléments à l’esprit.

Workflows transitoires transient-workflows

Pour optimiser les charges d’ingestion élevées, vous pouvez définir un workflow comme transitoire.

Lorsqu’un workflow est transitoire, les données d’exécution liées aux étapes de travail intermédiaires ne sont pas conservées dans JCR lors de leur exécution (les rendus de sortie sont conservés).

Les avantages sont notamment :

Optimiser les workflows DAM tuning-dam-workflows

Pour obtenir des instructions sur l’optimisation des performances des workflows DAM, consultez le guide sur l’optimisation des performances des ressources AEM.

Configurer le nombre maximum de workflows simultanés configure-the-maximum-number-of-concurrent-workflows

AEM peut permettre à plusieurs threads de workflows de s’exécuter simultanément. Par défaut, le nombre de threads est configuré pour correspondre à la moitié du nombre de cœurs de processeur du système.

Dans les cas où les workflows en cours d’exécution sont gourmands en ressources système, cela peut signifier qu’AEM ne peut plus utiliser grand-chose pour d’autres tâches, telles que le rendu de l’interface utilisateur de création. Par conséquent, le système peut être lent lors d’activités telles que le chargement massif d’images.

Pour résoudre ce problème, Adobe recommande de configurer le Nombre maximal de tâches parallèles pour qu’il soit compris entre la moitié et les trois quarts du nombre de cœurs de processeur du système. Cela devrait laisser suffisamment de capacité de réaction au système lors du traitement de ces workflows.

Pour configurer la valeur Nombre maximal de tâches en parallèle, vous pouvez effectuer l’une des opérations suivantes :

Il existe, en outre, une configuration distincte pour la File d’attente des tâches de processus externes du workflow Granite. Cela est utilisé pour les processus de workflow qui lancent des binaires externes, tels qu’InDesign Server ou Image Magick.

Configurer des files d’attente de tâches individuelles configure-individual-job-queues

Dans certains cas, il est utile de configurer des files d’attente de tâches individuelles pour contrôler les threads simultanés ou d’autres options de file d’attente, sur une base de tâches individuelles. Vous pouvez ajouter et configurer une file d’attente individuelle depuis la console web via la fabrique de configuration de la file d’attente de tâches Apache Sling. Pour localiser la rubrique à répertorier, exécutez le modèle du workflow et recherchez-le dans la console Tâches Sling  ; par exemple, à l’adresse http://localhost:4502/system/console/slingevent.

Des files d’attente individuelles peuvent également être ajoutées pour les workflows transitoires.

Configurer la purge de workflow configure-workflow-purging

Dans une installation standard, AEM fournit une console de maintenance où vous pouvez planifier et configurer les activités de maintenance quotidiennes et hebdomadaires ; par exemple, à :

http://localhost:4502/libs/granite/operations/content/maintenance.html

Par défaut, la Fenêtre de maintenance hebdomadaire a une tâche de Purge de workflow, mais celle-ci doit être configurée avant son exécution. Pour configurer les purges de workflow, vous devez ajoutez une nouvelle Configuration de la purge de workflow Adobe Granite dans la console web.

Pour plus de détails sur les tâches de maintenance dans AEM, consultez le Tableau de bord des opérations.

Personnalisation customization

Lors de l’écriture de processus de workflows personnalisés, vous devez prendre en compte un certain nombre d’éléments.

Emplacements locations

Les définitions de modèles de workflow, lanceurs, scripts et notifications sont conservées dans le référentiel en fonction de leur type ; par exemple, prêt à l’emploi, personnalisé, etc.

Emplacements - Modèles de workflow locations-workflow-models

Les modèles de workflow sont stockés dans le référentiel selon leur type :

Emplacements - Lanceurs de workflow locations-workflow-launchers

Les définitions de lanceur de workflow sont également stockées dans le référentiel selon leur type :

Emplacements - Scripts de workflow locations-workflow-scripts

Les scripts de workflow sont également stockés dans le référentiel selon leur type :

Emplacements - Notifications de workflow locations-workflow-notifications

Les notifications de workflow sont également stockées dans le référentiel selon leur type :

Traiter les sessions process-sessions

Comme dans tout développement personnalisé, il est toujours recommandé d’utiliser la session d’un utilisateur ou d’une utilisatrice lorsque cela est possible :

Lors de la mise en œuvre d’un processus de workflow :

public void execute(WorkItem item, WorkflowSession workflowSession, MetaDataMap args) throws WorkflowException {
        // to obtain a jcr session:
        javax.jcr.Session jcrSession = workflowSession.adaptTo(javax.jcr.Session.class);

        // to obtain a sling resource resolver:
        org.apache.sling.api.resource.ResourceResolver slingResourceResolver = workflowSession.adaptTo(org.apache.sling.api.resource.ResourceResolver.class);

Enregistrer une session :

Minimiser le nombre/la portée des lanceurs minimize-the-number-scope-of-launchers

Il existe un écouteur responsable de tous les lanceurs de workflow enregistrés :

Créer trop de lanceurs ralentira le processus d’évaluation.

La création d'un chemin glob à la racine du référentiel sur un seul lanceur obligerait le moteur de workflow à écouter et à évaluer les événements de création/modification sur chaque nœud du référentiel. Pour cette raison, il est recommandé de créer uniquement les lanceurs nécessaires et de faire en sorte que le chemin glob soit aussi spécifique que possible.

En raison de l’impact de ces lanceurs sur le comportement du workflow, il peut également être utile de désactiver tous les lanceurs prêts à l’emploi qui ne sont pas utilisés.

Améliorations de la configuration pour les lanceurs configuration-enhancements-for-launchers

La configuration de lanceur personnalisée a été améliorée afin de prendre en charge les éléments suivants :

Ne démarrez pas de workflows à partir d’autres workflows do-not-start-workflows-from-other-workflows

Les workflows peuvent entraîner une surcharge importante, à la fois en termes d’objets créés en mémoire et de nœuds suivis dans le référentiel. Pour cette raison, il est préférable qu’un workflow effectue son traitement lui-même plutôt que de démarrer des workflows supplémentaires.

Par exemple, un workflow qui implémente un processus d’entreprise sur un ensemble de contenu, puis active ce contenu. Il est préférable de créer un processus de workflow personnalisé qui active chacun de ces nœuds, plutôt que de démarrer un modèle  Activer le contenu pour chacun des nœuds de contenu qui doivent être publiés. Cette approche nécessitera un travail de développement supplémentaire, mais est plus efficace une fois exécutée que le démarrage d’une instance de workflow séparée pour chaque activation.

Un autre exemple serait un workflow qui traite plusieurs nœuds, crée un package de workflow, puis active ce package. Plutôt que de créer le package, puis de démarrer un workflow séparé avec le package défini comme charge utile, vous pouvez modifier la charge utile de votre workflow lors de l’étape de création du package, et appeler ensuite l’étape pour activer le package dans le même modèle de workflow.

Avance du gestionnaire handler-advance

Lors de la conception d’un modèle de workflow, vous avez la possibilité d’activer l’avance du gestionnaire dans les étapes de votre workflow. Vous pouvez également ajouter du code à votre étape de workflow pour déterminer la prochaine étape à exécuter, puis l’exécuter.

Il est recommandé d’utiliser l’avance du gestionnaire, car elle offre de meilleures performances.

Phases de workflow workflow-stages

Vous pouvez définir des phases de workflow, puis affecter des tâches/étapes à une phase spécifique du workflow.

Ces informations sont utilisées pour afficher la progression d’un workflow lorsque vous cliquez sur l’onglet Informations sur le workflow d’un élément de travail dans la Boîte de réception. Les modèles de workflow existants peuvent être modifiés pour ajouter des phases.

Étape Activer le processus des pages activate-page-process-step

L’étape Activer le processus des pages activera les pages pour vous, mais elle ne trouvera pas automatiquement les ressources DAM référencées et ne les activera pas non plus.

Tenez compte de ce point si vous envisagez d’utiliser cette étape dans le cadre d’un modèle de workflow.

Considérations relatives à la mise à niveau upgrade-considerations

Lors de la mise à niveau de votre instance :

Outils système system-tools

De nombreux outils système sont disponibles pour faciliter la surveillance, la maintenance et le dépannage des workflows. Tous les exemples d’URL ci-dessous utilisent localhost:4502. Cependant, ces URL doivent être disponibles sur toute instance de création (<hostname>:<port>).

Console de gestion des tâches Sling sling-job-handling-console

http://localhost:4502/system/console/slingevent

La console de gestion des tâches Sling affichera :

Outil de création de rapports de workflows workflow-report-tool

L’outil de création de rapports de workflows est supprimé dans la version 6.3 pour éviter une dégradation des performances.

MBean des opérations de maintenance des workflows workflow-maintenance-operations-mbean

http://localhost:4502/system/console/jmx/com.adobe.granite.workflow:type=Maintenance

Le MBean de maintenance des workflows expose plusieurs routines de maintenance bien utiles, telles que la purge des workflows terminés et la récupération de statistiques sur les workflows.

Informations supplémentaires further-information

Pour plus d’informations, consultez :