Configuration des points d’entrée des dossiers de contrôle configuring-watched-folder-endpoints

Un administrateur peut configurer un dossier réseau, appelé dossier de contrôle, de sorte que lorsqu’un utilisateur place un fichier (un fichier de PDF, par exemple) dans le dossier de contrôle, une opération de service configurée est appelée et manipule le fichier. Après que le service a effectué l’opération spécifiée, il enregistre le fichier modifié dans un dossier de sortie spécifié.

Configuration du service Watched Folder configuring-the-watched-folder-service

Avant de configurer un point de fin Watched Folder, configurez le service Watched Folder. Les paramètres de configuration du service Watched Folder ont deux objectifs :

Après avoir configuré le service Watched Folder, vous ajoutez un point de fin Watched Folder au service cible. Lors de l’ajout du point de fin, vous définissez des valeurs, telles que le nom du service et le nom de l’opération, à appeler lorsque des fichiers ou des dossiers sont placés dans le dossier input du service Watched Folder configuré. Pour plus d’informations sur la configuration du service Watched Folder, voir Paramètres du service Watched Folder.

Création d’un dossier de contrôle creating-a-watched-folder

Vous pouvez créer un dossier de contrôle de deux manières :

Dans un environnement organisé en grappe, le dossier qui sera utilisé comme dossier de contrôle doit être accessible, modifiable et partagé sur le système de fichiers ou le réseau. Dans ce scénario, chaque instance de serveur d’applications de la grappe doit avoir accès au même dossier partagé.

Sous Windows, si le serveur d’applications s’exécute en tant que service, il doit être démarré avec un accès approprié au dossier partagé de l’une des manières suivantes :

Association des dossiers de contrôle chaining-together-watched-folders

Les dossiers de contrôle peuvent être assemblés en chaîne de sorte qu’un document de résultat d’un dossier de contrôle soit le document d’entrée du dossier de contrôle suivant. Chaque dossier de contrôle peut appeler un service différent. En configurant les dossiers de contrôle de cette manière, plusieurs services peuvent être appelés. Par exemple, un dossier de contrôle peut convertir des fichiers de PDF au format Adobe PostScript® et un autre dossier de contrôle, des fichiers PostScript au format PDF/A. Pour ce faire, définissez simplement la variable result du dossier de contrôle défini par votre premier point de fin pour pointer vers le input dossier du dossier de contrôle défini par votre second point de fin.

La sortie de la première conversion serait placée dans le dossier \path\result. Et le dossier d’entrée de la seconde conversion serait \chemin\result et le dossier de sortie de la seconde conversion serait \chemin\result\result (ou le dossier défini dans la zone du dossier de résultats pour la seconde conversion).

Comment les utilisateurs interagissent avec les dossiers de contrôle how-users-interact-with-watched-folders

Pour un point de fin Watched Folder, les utilisateurs peuvent appeler en copiant ou en faisant glisser des fichiers ou des dossiers d’entrée depuis leur bureau vers un dossier de contrôle. Les fichiers seront traités dans l’ordre dans lequel ils arrivent.

Pour les points de fin Watched Folder, si la tâche ne nécessite qu’un seul fichier d’entrée, l’utilisateur peut le copier à la racine du dossier de contrôle.

Si la tâche contient plusieurs fichiers d’entrée, l’utilisateur doit créer, en dehors de la hiérarchie des dossiers de contrôle, un dossier contenant tous les fichiers requis. Ce nouveau dossier doit inclure les fichiers d’entrée (et éventuellement un fichier DDX s’il est requis par le processus). Une fois le dossier de tâche créé, l’utilisateur le copie dans le dossier input du dossier de contrôle.

Sortie du dossier de contrôle watched-folder-output

Lorsque l’entrée est un dossier et que la sortie est composée de plusieurs fichiers, AEM forms crée un dossier de sortie portant le même nom que le dossier input et copie les fichiers de sortie dans ce dossier. Lorsque la sortie est composée d’un document map contenant une paire clé-valeur, telle que la sortie d’un processus Output, la clé est utilisée comme nom de fichier de sortie.

Les noms de fichiers de sortie issus d’un processus de point de fin ne peuvent pas contenir de caractères autres que des lettres, des chiffres et un point (.) avant l’extension de fichier. AEM forms convertit les autres caractères en valeurs hexadécimales.

Les applications clientes récupèrent les documents de résultat dans le dossier result du dossier de contrôle. Les erreurs de traitement sont consignées dans le dossier des échecs du dossier de contrôle.

Fonctionnement de Watched Folder how-watched-folder-works

Le module Watched Folder contient les services suivants :

Outre les services répertoriés ci-dessus, Watched Folder dépend également d’autres services, notamment le service Planificateur pour la planification des tâches et le service Job Manager pour la prise en charge de l’appel asynchrone des services cibles.

Traitement d’une demande d’appel par Watched Folder how-watched-folder-processes-an-invocation-request

Le service Watched Folder gère la création, la mise à jour et la suppression des points de fin. Une fois les points de fin créés par l’administrateur, ils sont programmés pour être déclenchés par le service de programmation en fonction de l’intervalle de répétition spécifié ou de l’expression cron.

Ce diagramme illustre comment Watched Folder traite une demande d’appel.

Le processus d’appel d’un service à l’aide de dossiers de contrôle est le suivant :

Paramètres des points d’entrée d’un dossier de contrôle watched-folder-endpoint-settings

Utilisez les paramètres suivants pour configurer un point de fin Watched Folder.

Nom :(obligatoire) identifie le point d’entrée. N’incluez pas de caractère « < », car le nom affiché dans Workspace serait tronqué. Si vous saisissez une URL en tant que nom de point d’entrée, assurez-vous que celle-ci est conforme aux normes syntaxiques en la matière précisées dans le document RFC1738.

Description : fournit une description du point d’entrée. N’incluez pas de caractère « < », car la description affichée dans Workspace serait tronquée.

Chemin d’accès : (obligatoire) indique l’emplacement du dossier de contrôle. Dans un environnement organisé en grappe, ce paramètre doit pointer vers un dossier réseau partagé accessible à tous les ordinateurs de la grappe.

Asynchrone : identifie le type d’appel comme étant asynchrone ou synchrone. La valeur par défaut est asynchrone. Le mode asynchrone est recommandé pour les processus de longue durée, tandis que le mode synchrone est recommandé pour les processus transitoires ou de courte durée.

Expression Cron : saisissez une expression cron si le dossier de contrôle doit être programmé en utilisant une expression de ce type. Si ce paramètre est configuré, l’intervalle de répétition est ignoré.

Intervalle de répétition : intervalle (en secondes) entre les analyses du dossier de contrôle d’entrée. À moins que le paramètre Ralentissement ne soit activé, l’intervalle de répétition doit être supérieur au temps nécessaire au traitement d’une tâche moyenne. sinon, le système risque d’être surchargé. La valeur par défaut est 5. Pour plus d’informations, voir la description de la taille du lot .

Nombre de répétitions : nombre d’analyses du dossier ou du répertoire par le dossier de contrôle. La valeur -1 indique une analyse indéfinie. La valeur par défaut est -1.

Ralentissement : lorsque cette option est sélectionnée, elle permet de limiter le nombre de tâches du dossier de contrôle quʼAEM Forms peut traiter à un moment donné. La valeur Taille du lot détermine le nombre maximal de tâches. Voir A propos du ralentissement .

Nom d’utilisateur : (obligatoire) nom d’utilisateur utilisé lors de l’appel d’un service cible à partir du dossier de contrôle. La valeur par défaut est SuperAdmin.

Nom de domaine : (obligatoire) domaine de l’utilisateur. La valeur par défaut est DefaultDom.

Taille du lot : le nombre de fichiers ou de dossiers à sélectionner par analyse. utiliser pour éviter une surcharge du système ; l’analyse simultanée d’un trop grand nombre de fichiers peut entraîner un blocage. La valeur par défaut est 2.

Les paramètres Intervalle de répétition et Taille du lot déterminent le nombre de fichiers sélectionnés par Watched Folder à chaque analyse. Watched Folder utilise un pool de threads Quartz pour analyser le dossier input. Le pool de threads est partagé avec d’autres services. Si l’intervalle d’analyse est court, les threads analysent souvent le dossier input. Si des fichiers sont déposés fréquemment dans le dossier de contrôle, vous devez limiter l’intervalle d’analyse. Si les fichiers sont déposés peu fréquemment, utilisez un intervalle d’analyse plus long afin que les autres services puissent utiliser les threads.

Si un volume important de fichiers est déposé, définissez une grande taille de lot. Par exemple, si le service appelé par le point de fin Watched Folder peut traiter 700 fichiers par minute et que les utilisateurs déposent les fichiers dans le dossier input au même rythme, la définition de la taille du lot sur 350 et de l’intervalle de répétition sur 30 secondes permettra d’améliorer les performances de Watched Folder sans avoir à analyser trop souvent le dossier de contrôle.

Lorsque des fichiers sont déposés dans le dossier de contrôle, il les répertorie dans l’entrée, ce qui peut réduire les performances si l’analyse est effectuée toutes les secondes. L’allongement de l’intervalle d’analyse permet d’améliorer les performances. Si le volume de fichiers déposés est faible, ajustez la taille du lot et l’intervalle de répétition en conséquence. Par exemple, si 10 fichiers sont déposés toutes les secondes, essayez de définir l’intervalle de répétition sur 1 seconde et la taille du lot sur 10.

Durée d’attente : durée d’attente (en millisecondes) entre la création d’un dossier ou d’un fichier et son analyse. Par exemple, si la durée d’attente est de 3 600 000 millisecondes (une heure) et que le fichier a été créé il y a une minute, ce dernier sera sélectionné à l’issue d’un laps de temps de 59 minutes ou plus. La valeur par défaut est 0.

Ce paramètre est utile pour garantir qu’un fichier ou un dossier est entièrement copié dans le dossier input. Par exemple, si vous devez traiter un fichier volumineux dont le téléchargement dure dix minutes, définissez une durée d’attente de 10*60 *1000 millisecondes. ce qui évite que le dossier de contrôle analyse le fichier tant que ce dernier a une existence inférieure à dix minutes.

Exclure le modèle de fichier : liste délimitée par des points-virgules ; des modèles utilisés par un dossier de contrôle pour déterminer les fichiers et les dossiers à analyser et à sélectionner. Aucun fichier ou dossier avec ce modèle ne sera analysé en vue du traitement.

Ce paramètre est utile lorsque l’entrée est un dossier contenant plusieurs fichiers. Le contenu du dossier peut être copié dans un dossier dont le nom sera choisi par le dossier de contrôle. Cela empêche le dossier de contrôle de sélectionner un dossier à traiter avant que le dossier ne soit complètement copié dans le dossier input.

Vous pouvez utiliser des modèles de fichiers pour exclure les types de fichiers suivants :

Pour plus d’informations sur les modèles de fichiers, voir A propos des modèles de fichier.

Inclure le modèle de fichier  : liste délimitée par des points-virgules ; des modèles utilisés par le dossier de contrôle pour déterminer les dossiers et les fichiers à analyser et à sélectionner. Ainsi, si le paramètre Inclure le modèle de fichier a pour valeur input*, tous les fichiers et dossiers correspondant à input* sont sélectionnés. Cela concerne les fichiers et les dossiers nommés input1, input2, etc.

La valeur par défaut est * et renvoie à tous les fichiers et dossiers.

Vous pouvez utiliser des modèles de fichiers pour inclure les types de fichiers suivants :

Pour plus d’informations sur les modèles de fichiers, voir A propos des modèles de fichier.

Dossier result : dossier dans lequel les résultats enregistrés sont stockés. Si les résultats ne s’affichent pas dans ce dossier, vérifiez le dossier des échecs. Les fichiers en lecture seule ne sont pas traités et ils sont enregistrés dans le dossier des échecs. Cette valeur peut être un chemin d’accès absolu ou relatif avec les modèles de fichiers suivants :

Par exemple, si nous sommes le 17 juillet 2009 à 20 h et que vous définissez C:/Test/WF0/failure/%Y/%M/%D/%H/, le dossier de résultat est alors C:/Test/WF0/failure/2009/07/17/20.

Si le chemin d’accès n’est pas absolu mais relatif, le dossier est créé dans le dossier de contrôle. La valeur par défaut est result/%Y/%M/%D/, qui correspond au dossier Result dans le dossier de contrôle. Pour plus d’informations sur les modèles de fichiers, voir À propos des modèles de fichier.

Dossier preserve : dossier dans lequel les fichiers sont stockés après avoir été analysés et sélectionnés. Le chemin d’accès peut être absolu, relatif ou nul. Vous pouvez utiliser des modèles de fichiers, comme indiqué pour le dossier result. La valeur par défaut est preserve/%Y/%M/%D/.

Dossier failure : dossier dans lequel les fichiers en échec sont enregistrés. Cet emplacement dépend toujours du dossier de contrôle. Vous pouvez utiliser des modèles de fichiers, comme indiqué pour le dossier Résultat.

Les fichiers en lecture seule ne sont pas traités et ils sont enregistrés dans le dossier des échecs.

La valeur par défaut est failure/%Y/%M/%D/.

Conserver en cas d’échec : conservation des fichiers d’entrée en cas d’échec de l’exécution de l’opération dans un service. La valeur par défaut est true.

Remplacer les noms de fichier en double : lorsque cet attribut est défini sur « true », les fichiers du dossier obtenu et du dossier conservé sont remplacés. Lorsque la valeur est False, les fichiers et les dossiers comportant un suffixe d’index numérique sont utilisés pour le nom. La valeur par défaut est False.

Durée de la purge : (obligatoire) les fichiers et les sous-dossiers du dossier result sont vidés lorsqu’ils sont plus anciens que cette valeur. Cette valeur est mesurée en jours. Ce paramètre s’avère utile pour s’assurer que le dossier de résultats n’est pas plein.

Une valeur de -1 jour indique de ne jamais supprimer le dossier de résultats. La valeur par défaut est -1.

Nom de l’opération : (obligatoire) liste des opérations pouvant être attribuées au point d’entrée Watched Folder.

Mappages des paramètres d’entrée : permet de configurer l’entrée requise pour traiter le service et l’opération. Les paramètres disponibles dépendent du service qui utilise le point de fin Watched Folder. Voici les deux types d’entrées :

Littéral : le dossier de contrôle utilise la valeur saisie dans le champ telle qu’elle est affichée. Tous les types Java de base sont pris en charge. Par exemple, si une interface API utilise une entrée de type chaîne, long, nombre entier ou valeur booléenne, cette entrée est convertie en type approprié, puis le service est appelé.

Variable : la valeur saisie est un modèle de fichier que le dossier de contrôle utilise pour sélectionner l’entrée. Par exemple, dans le cas du service de mot de passe chiffré où le document d’entrée doit être un fichier PDF, l’utilisateur peut utiliser *.pdf comme modèle de fichier. Le dossier de contrôle récupère tous les fichiers du dossier de contrôle correspondant à ce modèle et appelle le service pour chaque fichier. Lorsqu’une variable est utilisée, tous les fichiers d’entrée sont convertis en documents. Seules les API qui utilisent le type d’entrée Document sont prises en charge.

Mappages des paramètres de sortie : permet de configurer les sorties du service et de l’opération. Les paramètres disponibles dépendent du service qui utilise le point de fin Watched Folder.

La sortie Watched Folder peut être un document unique, une liste de documents ou une carte de documents. Ces documents de sortie sont ensuite enregistrés dans le dossier result, à l’aide du modèle spécifié dans le mappage des paramètres de sortie.

A propos des modèles de fichier about-file-patterns

Les administrateurs peuvent indiquer le type du fichier servant à appeler un service. Plusieurs modèles de fichiers peuvent être définis pour chaque dossier de contrôle. Un modèle de fichier peut être l’une des propriétés de fichier suivantes :

L’administrateur peut définir le modèle de fichier du dossier de sortie dans lequel stocker les résultats. Pour les dossiers de sortie (result, preserve et failure), l’administrateur peut spécifier l’un de ces modèles de fichiers :

Par exemple, le chemin d’accès au dossier de résultats peut être C:\Adobe\Adobe_Experience_Manager_forms\BarcodedForms\%y\%m\%d.

Les mappages des paramètres de sortie peuvent également spécifier des modèles supplémentaires, tels que :

Si le modèle de mappage des paramètres de sortie se termine par "File.separator" (qui est le séparateur de chemin), un dossier est créé et le contenu est copié dans ce dossier. Si le modèle ne se termine pas par « File.separator », le contenu (fichier ou dossier des résultats) est créé et utilise ce nom. Pour plus d’informations sur les mappages des paramètres de sortie, voir Conseils et astuces pour les dossiers de contrôle.

A propos du ralentissement about-throttling

Lorsque le ralentissement est activé pour un point de fin de dossier de contrôle, il limite le nombre de tâches du dossier de contrôle pouvant être traitées à un moment donné. Le nombre maximal de tâches est déterminé par la valeur Taille du lot, également configurable dans le point de fin Watched Folder. Les documents entrants dans le répertoire d’entrée du dossier de contrôle ne seront pas interrogés lorsque la limite de ralentissement aura été atteinte. Les documents resteront également dans le répertoire des entrées jusqu’à ce que d’autres tâches du dossier de contrôle soient terminées et qu’une autre tentative d’interrogation soit effectuée. Dans le cas d’un traitement synchrone, toutes les tâches traitées dans un seul sondage sont comptabilisées dans la limite de ralentissement, même si les tâches sont traitées consécutivement dans un seul thread.

Fonctionnement du ralentissement how-throttling-works

Watched Folder analyse le dossier input à chaque intervalle de répétition, sélectionne le nombre de fichiers spécifié dans la taille du lot et appelle le service cible pour chacun de ces fichiers. Par exemple, si la taille du lot est de quatre, Watched Folder sélectionnera quatre fichiers à chaque analyse, créera quatre demandes d’appel et appellera le service cible. Avant que ces requêtes ne soient terminées, si Watched Folder est appelé, il démarrera à nouveau quatre tâches, que les quatre tâches précédentes soient terminées ou non.

L’option de ralentissement empêche le dossier de contrôle d’appeler de nouvelles tâches avant que les tâches précédentes ne soient terminées. Watched Folder détectera les tâches en cours et traitera les nouvelles tâches en fonction de la taille du lot moins les tâches en cours. Par exemple, dans le second appel, si le nombre de tâches terminées est de trois seulement et qu’une tâche est toujours en cours, Watched Folder appelle uniquement trois autres tâches.

Performances et évolutivité performance-and-scalability

Watched Folder peut traiter 100 dossiers au total sur un seul noeud. Les performances de Watched Folder dépendent des performances du serveur Forms. Pour les appels asynchrones, les performances dépendent davantage de la charge du système et des tâches qui se trouvent dans la file d’attente de Job Manager.

Les performances de Watched Folder peuvent être améliorées en ajoutant des noeuds à la grappe. Les tâches de Watched Folder sont distribuées sur les noeuds de la grappe en vertu du planificateur Quartz et, dans le cas de requêtes asynchrones, par le service Job Manager. Toutes les tâches sont conservées dans la base de données.

Watched Folder dépend du service Planificateur pour la planification, la déplanification et la replanification des tâches. D’autres services, tels que le service de gestion des événements, le service User Manager et le service Email Provider, sont disponibles et partagent le pool de threads du service de programmation. Cela peut avoir une incidence sur les performances de Watched Folder. Le réglage du pool de threads du service de programmation sera nécessaire lorsque tous les services commenceront à l’utiliser.

Dossiers de contrôle dans une grappe watched-folders-in-a-cluster

Dans une grappe, Watched Folder dépend du planificateur Quartz et du service Job Manager pour l’équilibrage de charge et le basculement. Pour plus d’informations sur le comportement de la grappe Quartz, voir Documentation Quartz.

Watched Folder effectue les trois tâches principales suivantes à chaque sondage :

Le comportement de l’équilibrage de charge et du basculement varie selon que le dossier de contrôle est configuré pour un appel synchrone ou asynchrone.

Dossier de contrôle synchrone dans une grappe synchronous-watched-folder-in-a-cluster

Pour les appels synchrones, l’équilibreur de charge Quartz décide quel noeud va obtenir l’événement d’interrogation. Le noeud qui reçoit l’événement d’interrogation effectue toutes les tâches : analysez le dossier, appelez le service cible et gérez les résultats.

Pour les appels synchrones, lorsqu’un noeud échoue, le planificateur Quartz envoie de nouveaux événements d’interrogation aux autres noeuds. Les appels démarrés sur le noeud en échec seront perdus. Pour plus d’informations sur la manière de récupérer les fichiers associés à la tâche en échec, voir Points d’échec et récupération.

Dossier de contrôle asynchrone dans une grappe asynchronous-watched-folder-in-a-cluster

Pour les appels asynchrones, l’équilibreur de charge Quartz décide quel noeud recevra l’événement d’interrogation. Le noeud qui obtient l’événement d’interrogation analyse le dossier input et appelle le service cible en plaçant la demande dans la file d’attente du service Job Manager. L’équilibreur de charge du service Job Manager est quant à lui chargé de décider quel noeud traitera la demande d’appel. Il est possible que même si le noeud A a créé la demande d’appel, le noeud B termine le traitement de la demande. Ou le noeud qui a démarré la demande d’appel peut également terminer le traitement de la demande.

Pour les appels asynchrones, lorsqu’un noeud échoue, le planificateur Quartz envoie de nouveaux événements d’interrogation aux autres noeuds. Les demandes d’appel créées sur le noeud en échec se trouvent dans la file d’attente du service Job Manager et sont envoyées à d’autres noeuds en vue du traitement. Les fichiers pour lesquels des demandes d’appel ne sont pas créées resteront dans le dossier stage. Pour plus d’informations sur la manière de récupérer les fichiers associés à la tâche en échec, voir Points d’échec et récupération.

Points d’échec et récupération failure-points-and-recovery

À chaque événement d’interrogation, Watched Folder verrouille le dossier input, déplace dans le dossier stage les fichiers correspondant au modèle de fichier d’inclusion, puis déverrouille le dossier input. Le verrouillage est nécessaire afin que deux threads ne sélectionnent pas le même ensemble de fichiers et ne les traitent pas deux fois. Les chances que cela se produise augmentent avec un petit intervalle de répétition et une grande taille de lot. Une fois les fichiers déplacés dans le dossier stage, le dossier input est déverrouillé afin que d’autres threads puissent analyser le dossier. Cette étape permet d’obtenir un débit élevé car d’autres threads peuvent analyser pendant qu’un thread traite les fichiers.

Une fois les fichiers déplacés dans le dossier stage, les demandes d’appel sont créées pour chaque fichier et le service cible est appelé. Dans certains cas, Watched Folder ne peut pas récupérer les fichiers du dossier stage :

Synchrone : Si Watched Folder est configuré pour appeler le service de manière synchrone, tous les fichiers du dossier stage restent dans ce dossier sans être traités.

Asynchrone : Dans ce cas, Watched Folder s’appuie sur le service Job Manager. Si le service Job Manager rappelle Watched Folder, les fichiers du dossier stage sont déplacés vers le dossier preserve ou le dossier failure en fonction des résultats de l’appel. Si le service Job Manager ne rappelle pas Watched Folder, les fichiers ne seront pas traités dans le dossier stage. Cette situation se produit lorsque Watched Folder ne s’exécute pas lorsque Job Manager rappelle.

Récupération des fichiers source non traités dans le dossier stage recovering-unprocessed-source-files-in-the-stage-folder

Lorsque Watched Folder ne peut pas traiter les fichiers source dans le dossier stage, vous pouvez récupérer les fichiers non traités.

Considérations relatives à la sécurité des dossiers de contrôle security-considerations-for-watched-folders

Chaque dossier de contrôle est configuré avec un nom d’utilisateur et un mot de passe. Ces informations d’identification sont utilisées lors de l’appel des services. Watched Folder s’appuie sur le fait que le dossier partagé est protégé par le système de fichiers de sécurité sous-jacent afin que seul le propriétaire du dossier de contrôle puisse accéder au dossier partagé.

Conseils et astuces pour les dossiers de contrôle tips-and-tricks-for-watched-folders

Voici quelques conseils et astuces concernant la configuration du point de fin Watched Folder :

Recommandations spécifiques au service pour les dossiers de contrôle service-specific-recommendations-for-watched-folders

Pour tous les services, vous devez ajuster la taille du lot et l’intervalle de répétition du dossier de contrôle de sorte que le rythme auquel Watched Folder sélectionne de nouveaux fichiers et dossiers en vue du traitement ne dépasse pas le nombre de tâches pouvant être traitées par le serveur d’AEM forms. Les paramètres réels à utiliser peuvent varier en fonction du nombre de dossiers de contrôle configurés, des services utilisant des dossiers de contrôle et de l’intensité des tâches sur le processeur.

Recommandations relatives au service Generate PDF generate-pdf-service-recommendations

recommandations relatives au service barcoded forms barcoded-forms-service-recommendations