Ajouter un bouton d’action personnalisé dans l’interface utilisateur de création de correspondance add-custom-action-button-in-create-correspondence-ui
Présentation overview
La solution Correspondence Management vous permet d’ajouter des actions personnalisées à l’interface utilisateur de création de correspondance.
Le scénario présenté dans ce document explique comment créer un bouton dans l’interface utilisateur de création de correspondance pour partager une lettre sous la forme d’un PDF de révision joint à un e-mail.
Prérequis prerequisites
Pour terminer ce scénario, vous devez disposer des éléments suivants :
- Connaissance de CRX et JavaScript
- LiveCycle Server
Scénario : Création du bouton dans l’interface utilisateur de création de correspondance pour envoyer une lettre à réviser scenario-create-the-button-in-the-create-correspondence-user-interface-to-send-a-letter-for-review
L’ajout d’un bouton avec une action (ici, envoyer une lettre pour révision) à l’interface utilisateur de création de correspondance comprend :
- Ajout du bouton à l’interface utilisateur de création de correspondance
- Ajout d’une gestion des actions au bouton
- Ajout du processus de LiveCycle pour activer l’action "gestion"
Ajout du bouton à l’interface utilisateur de création de correspondance add-the-button-to-the-create-correspondence-user-interface
-
Accédez à
https://[server]:[port]/[ContextPath]/crx/de
et connectez-vous en tant qu’administrateur. -
Dans le dossier des applications, créez un dossier appelé
defaultApp
avec un chemin d’accès / structure similaire au dossier defaultApp (situé dans le dossier de configuration). Procédez comme suit pour créer le dossier :-
Faites un clic droit sur le dossier defaultApp à l’emplacement suivant et sélectionnez Nœud de recouvrement :
/libs/fd/cm/config/defaultApp/
-
Assurez-vous que la boîte de dialogue du nœud de recouvrement possède les valeurs suivantes :
Chemin d’accès : /libs/fd/cm/config/defaultApp/
Emplacement du recouvrement : /apps/
Correspondance des types de nœuds : activé.
-
Cliquez sur OK.
-
Cliquez sur Enregistrer tout.
-
-
Effectuez une copie du fichier acmExtensionsConfig.xml (branche /libs) sous la branche /apps.
-
Accédez à « /libs/fd/cm/config/defaultApp/acmExtensionsConfig.xml ».
-
Faites un clic droit sur le fichier acmExtensionsConfig.xml et sélectionnez Copier.
-
Cliquez avec le bouton droit de la souris sur le defaultApp dossier à l’emplacement "/apps/fd/cm/config/defaultApp/", puis sélectionnez Coller.
-
Cliquez sur Enregistrer tout.
-
-
Double-cliquez sur la copie du fichier acmExtentionsConfig.xml que vous venez de créer dans le dossier des applications. Le fichier s’ouvre pour modification.
-
Recherchez le code suivant :
code language-xml <?xml version="1.0" encoding="utf-8"?> <extensionsConfig> <modelExtensions> <modelExtension type="LetterInstance"> <customAction name="Preview" label="loc.letterInstance.preview.label" tooltip="loc.letterInstance.preview.tooltip" styleName="previewButton"/> <customAction name="Submit" label="loc.letterInstance.submit.label" tooltip="loc.letterInstance.submit.tooltip" styleName="submitButton" permissionName="forms-users"/> <customAction name="SaveAsDraft" label="loc.letterInstance.saveAsDraft.label" tooltip="loc.letterInstance.saveAsDraft.tooltip" styleName="submitButton" permissionName="forms-users"/> <customAction name="Close" label="loc.letterInstance.close.label" tooltip="loc.letterInstance.close.tooltip" styleName="closeButton"/> </modelExtension> </modelExtensions> </extensionsConfig>
-
Pour envoyer la lettre par courrier électronique, vous pouvez utiliser le flux de travail LiveCycle Forms. Pour ajouter une balise customAction sous la balise modelExtension dans le fichier acmExtensionsConfig.xml, procédez comme suit :
code language-xml <customAction name="Letter Review" label="Letter Review" tooltip="Letter Review" styleName="" permissionName="forms-users" actionHandler="CM.domain.CCRCustomActionHandler"> <serviceName>Forms Workflow -> SendLetterForReview/SendLetterForReviewProcess</serviceName> </customAction>
La balise modelExtension comporte un ensemble de balises enfants customAction configurant l’action, les autorisations et l’aspect du bouton d’action. Voici la liste des balises de configuration customAction :
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 Nom Description name Le nom alphanumérique de l’action à exécuter. La valeur de cette balise est obligatoire, doit être unique (dans la balise modelExtension) et doit commencer par une lettre de l’alphabet. label Libellé à afficher sur le bouton d’action tooltip Texte de l’info-bulle du bouton, qui s’affiche lorsque l’utilisateur passe la souris sur le bouton. styleName Nom du style personnalisé appliqué au bouton d’action. permissionName L’action correspondante s’affiche uniquement si l’utilisateur dispose de l’autorisation spécifiée par la valeur permissionName. Lorsque vous spécifiez la valeur permissionName en tant que forms-users
, tous les utilisateurs ont accès à cette option.actionHandler Nom complet de la classe ActionHandler appelée lorsque l’utilisateur clique sur le bouton. Outre les paramètres ci-dessus, des configurations supplémentaires associées à une action personnalisée customAction peuvent exister. Ces configurations supplémentaires sont accessibles au gestionnaire via l’objet CustomAction.
table 0-row-2 1-row-2 2-row-2 3-row-2 Nom Description serviceName Si une action personnalisée customAction comprend une balise enfant nommée serviceName, le fait de cliquer sur le bouton/lien correspondant appelle un processus dont le nom est représenté par la balise serviceName. Vérifiez que ce processus présente la même signature que le post-processus de lettre. Ajoutez le préfixe « Flux de travail Forms - > » au nom du service. Paramètres contenant le préfixe cm_ dans le nom de balise Si une action personnalisée (customAction) contient une balise enfant dont le nom commence par cm_, au cours du post-processus (qu’il s’agisse d’un post-processus de lettre ou d’un processus spécifique représenté par la balise serviceName), ces paramètres sont disponibles dans le code XML d’entrée, sous la balise correspondante et sans le préfixe cm_. actionName Lorsqu’un post-processus est généré par un clic, les données XML soumises présentent une balise spéciale dont le nom contient le nom de l’action utilisateur. -
Cliquez sur Enregistrer tout.
Création d’un dossier de paramètres régionaux avec le fichier de propriétés dans la branche /apps create-a-locale-folder-with-properties-file-in-the-apps-branch
Le fichier ACMExtensionsMessages.properties comprend des libellés et des messages d’info-bulles correspondant à plusieurs champs de l’interface utilisateur de création de correspondance. Effectuez une copie de ce fichier dans la branche /apps afin que les actions/boutons personnalisé(e)s fonctionnent.
-
Faites un clic droit sur le dossier Paramètres régionaux au chemin d’accès suivant et sélectionnez Nœud de recouvrement :
/libs/fd/cm/config/defaultApp/locale
-
Assurez-vous que la boîte de dialogue du nœud de recouvrement possède les valeurs suivantes :
Chemin d’accès : /libs/fd/cm/config/defaultApp/locale
Emplacement du recouvrement : /apps/
Respect des types de nœud : activé
-
Cliquez sur OK.
-
Cliquez sur Enregistrer tout.
-
Faites un clic droit sur le fichier suivant et sélectionnez Copier :
/libs/fd/cm/config/defaultApp/locale/ACMExtensionsMessages.properties
-
Faites un clic droit sur le dossier Paramètres régionaux à l’emplacement suivant et sélectionnez Coller :
/apps/fd/cm/config/defaultApp/locale/
Le fichier ACMExtensionsMessages.properties est copié dans le dossier de paramètres régionaux.
-
Pour localiser les libellés de l’action/du bouton personnalisé(e) nouvellement ajouté(e), créez le fichier ACMExtensionsMessages.properties correspondant au paramètre régional approprié dans
/apps/fd/cm/config/defaultApp/locale/
.Par exemple, pour localiser l’action/le bouton personnalisé(e) créé(e) dans cet article, créez un fichier nommé ACMExtensionsMessages_fr.properties avec l’entrée suivante :
loc.letterInstance.letterreview.label=Revue De Lettre
De même, vous pouvez ajouter des propriétés supplémentaires (par rapport à l’info-bulle et au style, par exemple) dans ce fichier.
-
Cliquez sur Enregistrer tout.
Redémarrez le lot du bloc de création Adobe Asset Composer restart-the-adobe-asset-composer-building-block-bundle
Après avoir effectué chaque modification côté serveur, redémarrez le lot du bloc de création Asset Composer Adobe. Dans ce scénario, les fichiers acmExtensionsConfig.xml et ACMExtensionsMessages.properties côté serveur sont modifiés et, par conséquent, le lot du bloc de création Adobe Asset Composer nécessite un redémarrage.
-
Accédez à
https://[host]:[port]/system/console/bundles
. Le cas échéant, connectez-vous en tant qu’administrateur. -
Recherchez le lot du bloc de création Adobe Asset Composer. Redémarrez le lot : cliquez sur Arrêter, puis sur Démarrer.
Après le redémarrage du lot du bloc de création Adobe Asset Composer, le bouton personnalisé s’affiche dans l’interface utilisateur de création de correspondance. Vous pouvez ouvrir une lettre dans l’interface utilisateur de création de correspondance pour prévisualiser le bouton personnalisé.
Ajout de la gestion des actions au bouton add-action-handling-to-the-button
Par défaut, l’interface utilisateur de création de correspondance dispose de l’implémentation d’ActionHandler dans le fichier cm.domain.js à l’emplacement suivant :
/libs/fd/cm/ccr/gui/components/admin/clientlibs/ccr/js/cm.domain.js
Concernant le traitement de l’action personnalisée, créez un recouvrement du fichier cm.domain.js dans la branche /apps de CRX.
Le traitement de l’action/du bouton lors d’un clic sur l’action/le bouton comprend la logique pour :
- Rendre l’action ajoutée visible/invisible : via le remplacement de la fonction actionVisible().
- Activer/désactiver l’action ajoutée : via le remplacement de la fonction actionEnabled().
- Traiter réellement l’action lorsque l’utilisateur clique sur le bouton : via le remplacement de l’implémentation de la fonction handleAction().
-
Accédez à
https://[server]:[port]/[ContextPath]/crx/de
. Le cas échéant, connectez-vous en tant qu’administrateur. -
Dans le dossier d’applications, créez un dossier nommé
js
dans la branche /apps de CRX, dont la structure est semblable au dossier suivant :/libs/fd/cm/ccr/gui/components/admin/clientlibs/ccrui/js
Procédez comme suit pour créer le dossier :
-
Cliquez avec le bouton droit sur le dossier js à l’emplacement suivant et sélectionnez Nœud de recouvrement :
/libs/fd/cm/ccr/gui/components/admin/clientlibs/ccrui/js
-
Assurez-vous que la boîte de dialogue du nœud de recouvrement possède les valeurs suivantes :
Chemin : /libs/fd/cm/ccr/gui/components/admin/clientlibs/ccrui/js
Emplacement du recouvrement : /apps/
Respect des types de nœud : activé
-
Cliquez sur OK.
-
Cliquez sur Enregistrer tout.
-
-
Dans le dossier js, procédez comme suit pour créer un fichier nommé ccrcustomization.js avec le code de traitement d’action du bouton :
-
Cliquez avec le bouton droit sur le dossier js au chemin suivant, puis sélectionnez Créer > Créer un fichier :
/apps/fd/cm/ccr/gui/components/admin/clientlibs/ccrui/js
Nommez le fichier ccrcustomization.js.
-
Double-cliquez sur le fichier ccrcustomization.js pour l’ouvrir dans CRX.
-
Dans le fichier , collez le code suivant, puis cliquez sur Enregistrer tout:
code language-none /* for adding and handling custom actions in Extensible Toolbar. * One instance of handler will be created for each action. * CM.domain.CCRCustomActionHandler is actionHandler class. */ var CCRCustomActionHandler; CCRCustomActionHandler = CM.domain.CCRCustomActionHandler = new Class({ className: 'CCRCustomActionHandler', extend: CCRDefaultActionHandler, construct : function(action,model){ } }); /** * Called when user user click an action * @param extraParams additional arguments that may be passed to handler (For future use) */ CCRCustomActionHandler.prototype.handleAction = function(extraParams){ if (this.action.name == CCRCustomActionHandler.SEND_FOR_REVIEW) { var sendForReview = function(){ var serviceName = this.action.actionConfig["serviceName"]; var inputParams = {}; inputParams["dataXML"] = this.model.iccData.data; inputParams["letterId"] = this.letterVO.id; inputParams["letterName"] = this.letterVO.name; inputParams["mailId"] = $('#email').val(); /*function to invoke the LivecyleService */ ServiceDelegate.callJSONService(this,"lc.icc.renderlib.serviceInvoker.json","invokeProcess",[serviceName,inputParams],this.onProcessInvokeComplete,this.onProcessInvokeFail); $('#ccraction').modal("hide"); } if($('#ccraction').length == 0){ /*For first click adding popup & setting letterName.*/ $("body").append(popUp); $("input[id*='letterName']").val(this.letterVO.name); $(document).on('click',"#submitLetter",$.proxy( sendForReview, this )); } $('#ccraction').modal("show"); } }; /** * Should the action be enabled in toolbar * @param extraParams additional arguements that may be passed to handler (For future use) * @return flag indicating whether the action should be enabled */ CCRCustomActionHandler.prototype.actionEnabled = function(extraParams){ /*can be customized as per user requirement*/ return true; }; /** * Should the action be visible in toolbar * @param extraParams additional arguments that may be passed to handler (For future use) * @return flag indicating whether the action should be enabled */ CCRCustomActionHandler.prototype.actionVisible = function(extraParams){ /*Check can be enabled for Non-Preview Mode.*/ return true; }; /*SuccessHandler*/ CCRCustomActionHandler.prototype.onProcessInvokeComplete = function(response) { ErrorHandler.showSuccess("Letter Sent for Review"); }; /*FaultHandler*/ CCRCustomActionHandler.prototype.onProcessInvokeFail = function(event) { ErrorHandler.showError(event.message); }; CCRCustomActionHandler.SEND_FOR_REVIEW = "Letter Review"; /*For PopUp*/ var popUp = '<div class="modal fade" id="ccraction" tabindex="-1" role="dialog" aria-hidden="true">'+ '<div class="modal-dialog modal-sm">'+ '<div class="modal-content">' + '<div class="modal-header">'+ '<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>'+ '<h4 class="modal-title"> Send Review </h4>'+ '</div>'+ '<div class="modal-body">'+ '<form>'+ '<div class="form-group">'+ '<label class="control-label">Email Id</label>'+ '<input type="text" class="form-control" id="email">'+ '</div>'+ '<div class="form-group">'+ '<label class="control-label">Letter Name</label>'+ '<input id="letterName" type="text" class="form-control" readonly>'+ '</div>'+ '<div class="form-group">'+ '<input id="letterData" type="text" class="form-control hide" readonly>'+ '</div>'+ '</form>'+ '</div>'+ '<div class="modal-footer">'+ '<button type="button" class="btn btn-default" data-dismiss="modal"> Cancel </button>'+ '<button type="button" class="btn btn-primary" id="submitLetter"> Submit </button>'+ '</div>'+ '</div>'+ '</div>'+ '</div>';
-
Ajouter le processus de LiveCycle pour activer l’action gestion add-the-livecycle-process-to-enable-action-span-class-acrolinxcursormarker-span-handling
Dans ce scénario, activez les composants suivants, qui font partie du fichier joint components.zip :
- Fichier jar du composant DSC (
DSCSample.jar
) - Envoi d’une lettre au processus de révision LCA (
SendLetterForReview.lca
)
Téléchargez et décompressez le fichier components.zip
fichier à obtenir DSCSample.jar
et SendLetterForReview.lca
fichiers . Utilisez ces fichiers comme indiqué dans les procédures suivantes.
Configuration du serveur LiveCycle pour exécuter le processus LCA configure-the-livecycle-server-to-run-the-lca-process
Le processus LCA s’exécute sur le serveur LiveCycle et requiert l’adresse du serveur et les informations d’identification.
-
Accédez à
https://[server]:[port]/system/console/configMgr
et connectez-vous en tant qu’administrateur. -
Localisez la configuration du SDK client d’Adobe LiveCycle et cliquez sur Modifier (icône de modification). Le panneau de configuration s’ouvre.
-
Saisissez les informations suivantes, puis cliquez sur Enregistrer :
- URL du serveur : URL du serveur LC dont dépend le service Envoi pour révision utilisé par le code du gestionnaire d’action.
- Nom d’utilisateur : nom d’utilisateur de l’administrateur du serveur LC.
- Mot de passe : mot de passe du nom d’utilisateur de l’administrateur.
Installation de LiveCycle Archive (LCA) install-livecycle-archive-lca
Processus LiveCycle requis permettant l’exécution du processus de service de courrier électronique.
-
Connectez-vous en tant qu’administrateur à l’interface administrateur du serveur LiveCycle à l’adresse
https:/[lc server]/:[lc port]/adminui
. -
Accédez à Accueil > Services > Applications et services > Gestion des applications.
-
Si l’application SendLetterForReview est déjà présente, ignorez les étapes restantes de cette procédure. Dans le cas contraire, effectuez les étapes suivantes.
-
Cliquez sur Importer.
-
Cliquez sur Choisir un fichier et sélectionnez SendLetterForReview.lca.
-
Cliquez sur Aperçu.
-
Sélectionnez Déployer les ressources à l’exécution à la fin de l’importation.
-
Cliquez sur Importer.
Ajout de ServiceName à la liste de services Placés sur la liste autorisée adding-servicename-to-the-allowlisted-service-list
Indiquez dans le serveur AEM les services de LiveCycle auxquels vous souhaitez accéder au serveur AEM.
-
Connectez-vous en tant qu’administrateur à
https:/[host]/:[port]/system/console/configMgr
. -
Recherchez et cliquez sur Configuration du SDK client d’Adobe LiveCycle. Le panneau Configuration du SDK client d’Adobe LiveCycle s’affiche.
-
Dans la liste Nom du service, cliquez sur l’icône + et ajoutez un nom de service SendLetterForReview/SendLetterForReviewProcess.
-
Cliquez sur Enregistrer.
Configuration du service de messagerie configure-the-email-service
Dans ce scénario, pour que Correspondence Management puisse envoyer un email, configurez le service de messagerie dans le serveur LiveCycle.
-
Connectez-vous avec les informations d’identification d’administrateur à l’interface utilisateur du serveur LiveCycle à l’adresse
https:/[lc server]:[lc port]/adminui
. -
Accédez à Accueil > Services > Applications et services > Gestion des services.
-
Recherchez et cliquez sur EmailService.
-
Dans Hôte SMTP, configurez le service de messagerie.
-
Cliquez sur Enregistrer.
Configuration du service DSC configure-the-dsc-service
Pour utiliser l’API Correspondence Management, téléchargez la DSCSample.jar
(joint à ce document en tant que partie intégrante de components.zip
) et chargez-le sur le serveur LiveCycle. Après la DSCSample.jar
est chargé sur le serveur LiveCycle, le serveur AEM utilise la variable DSCSample.jar
pour accéder à l’API renderLetter.
Pour plus d’informations, voir Connexion d’AEM Forms à Adobe LiveCycle.
-
Mettez à jour l’URL du serveur AEM dans cmsa.properties dans
DSCSample.jar
, qui se trouve à l’emplacement suivant :DSCSample.jar\com\adobe\livecycle\cmsa.properties
-
Indiquez les paramètres suivants dans le fichier de configuration :
- crx.serverUrl=https:/[hôte]/:[port]/[chemin du contexte]/[URL AEM]
- crx.username= AEM nom d’utilisateur
- crx.password= AEM mot de passe
- crx.appRoot=/content/apps/cm
note note NOTE À chaque modification apportée au côté serveur, redémarrez le serveur Le
DSCSample.jar
utilise la variablerenderLetter
API. Pour plus d’informations sur l’API renderLetter, voir Interface LetterRenderService.
Importation de DSC dans AEM Forms on JEE import-dsc-to-livecyle
DSCSample.jar
utilise la variable renderLetter
API pour effectuer le rendu d’une lettre en tant qu’octets PDF à partir des données XML que C donne en entrée. Pour plus d’informations sur renderLetter et les autres API, voir Service de rendu de lettre.
-
Démarrez Workbench et connectez-vous.
-
Sélectionnez Fenêtre > Afficher les vues > Composants. La vue Composants est ajoutée à Workbench ES2.
-
Faites un clic droit sur Composants et sélectionnez Installer un composant.
-
Sélectionnez le fichier
DSCSample.jar
via l’explorateur de fichiers et cliquez sur Ouvrir. -
Faites un clic droit sur RenderWrapper et sélectionnez Démarrer le composant. Si le composant démarre, une flèche verte apparaît en regard du nom du composant.
Envoyer une lettre pour révision send-letter-for-review
Après avoir configuré l’action et le bouton permettant d’envoyer la lettre pour révision :
-
Videz la mémoire cache du navigateur.
-
Dans l’interface utilisateur de création de correspondance, cliquez sur Révision de lettre et indiquez l’ID de messagerie du réviseur.
-
Cliquez sur Envoyer.
Le réviseur reçoit un courrier électronique du système contenant la lettre en tant que pièce jointe.