Les exemples et les échantillons de ce document sont réservés à l’environnement AEM Forms sur JEE.
Il est possible dʼassembler un document PDF qui contient des signets. Prenons lʼexemple suivant : vous disposez dʼun document PDF qui ne contient pas de signets et vous souhaitez le modifier en fournissant des signets. À l’aide du service Assembler, vous pouvez lui transmettre un document PDF qui ne contient pas de signets et récupérer un document PDF contenant des signets.
Les signets contiennent les propriétés suivantes :
Dans le cadre de cette discussion, supposons que le document DDX suivant soit utilisé.
<?xml version="1.0" encoding="UTF-8"?>
<DDX xmlns="https://ns.adobe.com/DDX/1.0/">
<PDF result="FinalDoc.pdf">
<PDF source="Loan.pdf">
<Bookmarks source="doc2" />
</PDF>
</PDF>
</DDX>
Dans ce document DDX, notez que la valeur Loan.pdf
est affectée à l’attribut source. Ce document DDX indique qu’un seul document PDF est transmis au service Assembler. Lors de l’assemblage d’un document PDF avec des signets, vous devez spécifier un document XML de signet qui décrit les signets dans le document obtenu. Pour spécifier un document XML de signet, assurez-vous que l’élément Bookmarks
est spécifié dans votre document DDX.
Dans lʼexemple suivant de document DDX, l’élément Bookmarks
indique doc2
comme valeur. Cette valeur indique que la carte d’entrée transmise au service Assembler contient une clé nommée doc2
. La valeur de la clé doc2
est une valeur com.adobe.idp.Document
qui représente le document XML du signet. (Consultez la rubrique « Langage des signets » dans la section Guide de référence du service Assembler et de DDX).
Cette rubrique utilise le langage de signets XML suivant pour assembler un document PDF contenant des signets.
<?xml version="1.0" encoding="UTF-8"?>
<Bookmarks xmlns="https://ns.adobe.com/pdf/bookmarks" version="1.0">
<Bookmark>
<Action>
<Launch NewWindow="true">
<File Name="C:\Adobe\LoanDetails.pdf" />
</Launch>
</Action>
<Title>Open the Loan document</Title>
</Bookmark>
<Bookmark>
<Action>
<Launch>
<Win Name="C:\WINDOWS\notepad.exe" />
</Launch>
</Action>
<Title>Launch NotePad</Title>
</Bookmark>
</Bookmarks>
Dans ce document XML de signet, notez la présence de l’élément Action, qui définit l’action effectuée lorsqu’un utilisateur clique sur le signet. Sous l’élément Action se trouve l’élément Launch qui permet de lancer des applications, comme le Bloc-notes, et dʼouvrir des fichiers, comme les fichiers PDF. Pour ouvrir un fichier PDF, vous devez utiliser l’élément File qui spécifie le fichier à ouvrir. Par exemple, dans le fichier XML du signet spécifié dans cette section, le nom du fichier ouvert est LoanDetails.pdf.
Pour plus d’informations sur les actions prises en charge, consultez la section « Élement Action
» dans le Guide de référence du service Assembler et de DDX.
Compte tenu du document DDX spécifié dans cette section et du fichier XML du signet en entrée, le service Assembler assemble un document PDF contenant les signets suivants.
Lorsqu’un utilisateur clique sur le signet Ouvrir les détails du prêt, le fichier LoanDetails.pdf est ouvert. De même, lorsque l’utilisateur clique sur le signet Lancer le Bloc-notes, le Bloc-notes est démarré.
Avant dʼentamer cette section, il est recommandé de se familiariser avec l’assemblage de documents PDF à l’aide du service Assembler. Cette section nʼaborde pas les concepts tels que la création dʼun objet de collection contenant des documents dʼentrée, ou lʼapprentissage de lʼextraction des résultats de lʼobjet de collection retourné. (Consultez la section Assembler par programmation des documents PDF).
Pour plus d’informations sur le service Assembler, consultez la section Guide de référence des services pour AEM Forms.
Pour plus d’informations sur les documents DDX, consultez la section Guide de référence du service Assembler et de DDX.
Pour assembler un document PDF contenant des signets, procédez comme suit :
Inclure des fichiers de projet
Incluez les fichiers nécessaires dans votre projet de développement. Si vous créez une application cliente à l’aide de Java, incluez les fichiers JAR nécessaires. Si vous utilisez des services Web, veillez à inclure les fichiers proxy.
Les fichiers JAR suivants doivent être ajoutés au chemin d’accès aux classes de votre projet :
Si AEM Forms est déployé sur un serveur d’applications J2EE pris en charge et différent de JBoss, vous devez remplacer les fichiers adobe-utilities.jar et jbossall-client.jar par des fichiers JAR spécifiques au serveur d’applications J2EE sur lequel AEM Forms est déployé. Pour plus d’informations sur l’emplacement de ces fichiers, consultez la section Inclure des fichiers de bibliothèque Java AEM Forms.
Créer un client Assembler PDF
Avant de pouvoir effectuer une opération Assembler de manière programmée, vous devez créer un client de service Assembler.
Référencer un document DDX existant
Un document DDX doit être référencé pour assembler un document PDF. Ce document DDX doit contenir l’élément Bookmarks
, qui demande au service Assembler d’assembler un PDF contenant des signets. (Pour obtenir un exemple, reportez-vous au document DDX présenté précédemment dans cette section).
Référencer un document PDF auquel sont ajoutés des signets
Référence un document PDF auquel des signets sont ajoutés. Peu importe que le document PDF référencé contienne déjà des signets. Si l’élément Bookmarks
est un enfant de l’élément source du PDF, alors les signets remplaceront ceux qui existent déjà dans la source du PDF. Toutefois, si vous souhaitez conserver les signets existants, assurez-vous que Bookmarks
est apparenté à l’élément source du PDF. Prenons l’exemple suivant :
<PDF result="foo">
<PDF source="inDoc"/>
<Bookmarks source="doc2"/>
</PDF>
Référencer le document XML du signet
Pour assembler un PDF contenant de nouveaux signets, vous devez référencer un document XML de signet. Le document XML du signet est transmis au service Assembler dans l’objet de collection Map. (Pour consulter un exemple, reportez-vous au document XML de signet illustré précédemment dans cette section).
Consultez la rubrique « Langage des signets » dans la section Guide de référence du service Assembler et de DDX.
Ajouter le document PDF et le document XML de signet à une collection Map
Vous devez ajouter le document PDF auquel les signets sont ajoutés et le document XML du signet à la collection Map. En toute logique, l’objet de collection Map contient deux éléments : un document PDF et le document XML de signet.
Définir les options d’exécution
Vous pouvez définir des options d’exécution qui contrôlent le comportement du service Assembler lors de l’exécution d’une tâche. Par exemple, vous pouvez définir une option qui indique au service Assembler de continuer à traiter une tâche même en cas d’erreur. Pour plus d’informations sur les options d’exécution que vous pouvez définir, consultez la référence de classe AssemblerOptionSpec
dans la section Référence de l’API AEM Forms.
Assembler le document PDF
Pour assembler un document PDF contenant de nouveaux signets, utilisez l’opération invokeDDX
du service Assembler. La raison pour laquelle vous devez utiliser l’opération invokeDDX
plutôt que dʼautres opérations du service Assembler telles que invokeOneDocument
est que le service Assembler requiert un document XML de signet qui est transmis dans l’objet de collection Map. Cet objet est un paramètre de l’opération invokeDDX
.
Enregistrer le document PDF contenant des signets
Vous devez extraire les résultats de l’objet map renvoyé et enregistrer le document PDF correspondant. (Reportez-vous à « Extraire les résultats » dans Assembler des documents PDF par programmation.)
Voir également
Inclusion des fichiers de bibliothèque Java d’AEM Forms
Réglage des propriétés de la connexion
Assembler les documents PDF par programmation
Pour assembler un document PDF avec des signets à l’aide de l’API du service Assembler (Java), procédez comme suit :
Incluez les fichiers de projet.
Incluez les fichiers JAR clients, tels que adobe-assembler-client.jar, dans le chemin d’accès aux classes de votre projet Java.
Créez un client Assembler PDF.
ServiceClientFactory
qui contient des propriétés de connexion. (Voir Réglage des propriétés de la connexion.)AssemblerServiceClient
en utilisant son constructeur et en transmettant l’objet ServiceClientFactory
.Référencez un document DX existant.
java.io.FileInputStream
qui représente le document DDX en utilisant son constructeur et en transmettant une valeur de chaîne qui spécifie l’emplacement du fichier DDX.com.adobe.idp.Document
en utilisant son constructeur et en transmettant l’objet java.io.FileInputStream
.Référencez un document PDF auquel des signets sont ajoutés.
java.io.FileInputStream
en utilisant son constructeur et en transmettant l’emplacement du document PDF.com.adobe.idp.Document
en utilisant son constructeur et en transmettant l’objet java.io.FileInputStream
contenant le document PDF.Référencez le document XML du signet.
java.io.FileInputStream
en utilisant son constructeur et en transmettant l’emplacement du fichier XML qui représente le document XML du signet.com.adobe.idp.Document
et transmettez l’objet java.io.FileInputStream
contenant le document PDF.Ajoutez le document PDF et le document XML du signet à une collection Map.
Créez un objet java.util.Map
qui permet de stocker le document PDF d’entrée et le document XML de signet.
Ajoutez le document PDF d’entrée en appelant la méthode put
de l’objet java.util.Map
et en transmettant les arguments suivants :
com.adobe.idp.Document
contenant le document PDF d’entrée.Ajoutez le document XML de signet en appelant la méthode put
de l’objet java.util.Map
et en transmettant les arguments suivants :
com.adobe.idp.Document
contenant le document XML de signet.Définissez les options d’exécution.
AssemblerOptionSpec
qui stocke les options d’exécution en utilisant son constructeur.AssemblerOptionSpec
. Par exemple, pour demander au service Assembler de continuer à traiter une tâche en cas d’erreur, appelez la méthode setFailOnError
de l’objet AssemblerOptionSpec
et transmettez false
.Assemblez le document PDF.
Appelez la méthode invokeDDX
de l’objet AssemblerServiceClient
et transmettez les valeurs requises suivantes :
com.adobe.idp.Document
représentant le document DDX à utiliser.java.util.Map
contenant le document PDF d’entrée et le document XML de signet.com.adobe.livecycle.assembler.client.AssemblerOptionSpec
spécifiant les options d’exécution, y compris la police par défaut et le niveau du log de traitement.La méthode invokeDDX
renvoie un objet com.adobe.livecycle.assembler.client.AssemblerResult
contenant les résultats de la tâche et les exceptions survenues.
Enregistrez le document PDF qui contient des signets.
Pour obtenir le document PDF nouvellement créé, procédez comme suit :
getDocuments
de l’objet AssemblerResult
. Cette méthode renvoie un objet java.util.Map
.java.util.Map
jusqu’à ce que vous trouviez l’objet com.adobe.idp.Document
résultant. (Vous pouvez utiliser l’élément de résultat PDF spécifié dans le document DDX pour obtenir le document).copyToFile
de l’objet com.adobe.idp.Document
pour extraire le document PDF.Voir également
Démarrage rapide (mode SOAP) : assembler des documents PDF avec des signets à l’aide de l’API Java.
Inclusion des fichiers de bibliothèque Java d’AEM Forms
Réglage des propriétés de la connexion
Assemblez un document PDF avec des signets à l’aide de l’API du service Assembler (service web) :
Incluez les fichiers de projet.
Créez un projet Microsoft .NET qui utilise MTOM. Veillez à utiliser la définition WSDL suivante : http://localhost:8080/soap/services/AssemblerService?WSDL&lc_version=9.0.1
.
Remplacez localhost
par l’adresse IP du serveur hébergeant AEM Forms.
Créez un client Assembler PDF.
Créez un objet AssemblerServiceClient
en utilisant son constructeur par défaut.
Créez un objet AssemblerServiceClient.Endpoint.Address
en utilisant le constructeur System.ServiceModel.EndpointAddress
. Transmettez une valeur de chaîne qui spécifie le WSDL au service AEM Forms (par exemple, http://localhost:8080/soap/services/AssemblerService?blob=mtom
). Vous n’avez pas besoin d’utiliser l’attribut lc_version
. Cet attribut est utilisé lorsque vous créez une référence de service.
Créez un objet System.ServiceModel.BasicHttpBinding
en récupérant la valeur du champ AssemblerServiceClient.Endpoint.Binding
. Convertissez la valeur de retour en BasicHttpBinding
.
Définissez le champ MessageEncoding
de l’objet System.ServiceModel.BasicHttpBinding
sur WSMessageEncoding.Mtom
. Cette valeur garantit l’utilisation de MTOM.
Activez l’authentification HTTP de base en effectuant les tâches suivantes :
AssemblerServiceClient.ClientCredentials.UserName.UserName
.AssemblerServiceClient.ClientCredentials.UserName.Password
.HttpClientCredentialType.Basic
au champ BasicHttpBindingSecurity.Transport.ClientCredentialType
.BasicHttpSecurityMode.TransportCredentialOnly
au champ BasicHttpBindingSecurity.Security.Mode
.Référencez un document DX existant.
BLOB
en utilisant son constructeur. L’objet BLOB
est utilisé pour stocker le document DDX.System.IO.FileStream
en appelant son constructeur et en transmettant une valeur de chaîne qui représente l’emplacement du document DDX et son mode d’ouverture.System.IO.FileStream
. Vous pouvez déterminer la taille du tableau d’octets en obtenant la propriété Length
de l’objet System.IO.FileStream
.Read
de l’objet System.IO.FileStream
et en transmettant le tableau d’octets, la position de départ et la longueur du flux à lire.BLOB
en attribuant à son champ MTOM
le contenu du tableau d’octets.Référencez un document PDF auquel des signets sont ajoutés.
BLOB
en utilisant son constructeur. L’objet BLOB
sert à stocker le PDF d’entrée.System.IO.FileStream
en appelant son constructeur et en transmettant une valeur de chaîne qui représente l’emplacement du document PDF d’entrée et son mode d’ouverture.System.IO.FileStream
. Vous pouvez déterminer la taille du tableau d’octets en obtenant la propriété Length
de l’objet System.IO.FileStream
.Read
de l’objet System.IO.FileStream
et en transmettant le tableau d’octets, la position de départ et la longueur du flux à lire.BLOB
en attribuant à son champ MTOM
le contenu du tableau d’octets.Référencez le document XML du signet.
BLOB
en utilisant son constructeur. L’objet BLOB
sert à stocker le document XML du signet.System.IO.FileStream
en appelant son constructeur et en transmettant une valeur de chaîne qui représente l’emplacement du document PDF d’entrée et son mode d’ouverture.System.IO.FileStream
. Vous pouvez déterminer la taille du tableau d’octets en obtenant la propriété Length
de l’objet System.IO.FileStream
.Read
de l’objet System.IO.FileStream
et en transmettant le tableau d’octets, la position de départ et la longueur du flux à lire.BLOB
en attribuant à son champ MTOM
le contenu du tableau d’octets.Ajoutez le document PDF et le document XML du signet à une collection Map.
MyMapOf_xsd_string_To_xsd_anyType
. Cet objet de collection est utilisé pour stocker les documents PDF d’entrée et le document XML du signet.MyMapOf_xsd_string_To_xsd_anyType_Item
.key
de l’objet MyMapOf_xsd_string_To_xsd_anyType_Item
. Cette valeur doit correspondre à celle de l’élément source PDF spécifié dans le document DDX.BLOB
qui stocke le document PDF au champ value
de l’objet MyMapOf_xsd_string_To_xsd_anyType_Item
.MyMapOf_xsd_string_To_xsd_anyType_Item
à l’objet MyMapOf_xsd_string_To_xsd_anyType
. Appelez la méthode Add
de l’objet MyMapOf_xsd_string_To_xsd_anyType
et transmettez l’objet MyMapOf_xsd_string_To_xsd_anyType
. (Effectuez cette tâche pour chaque document PDF d’entrée et le document XML de signet).Définissez les options d’exécution.
AssemblerOptionSpec
qui stocke les options d’exécution en utilisant son constructeur.AssemblerOptionSpec
. Par exemple, pour demander au service Assembler de poursuivre le traitement dʼune tâche en cas d’erreur, affectez false
au membre de données failOnError
de l’objet AssemblerOptionSpec
.Assemblez le document PDF.
Appelez la méthode invokeDDX
de l’objet AssemblerServiceClient
et transmettez les valeurs suivantes :
BLOB
qui représente le document DDX.MyMapOf_xsd_string_To_xsd_anyType
qui contient les documents d’entrée.AssemblerOptionSpec
qui spécifie les options d’exécution.La méthode invokeDDX
renvoie un objet AssemblerResult
qui contient les résultats de la tâche et les exceptions survenues.
Enregistrez le document PDF qui contient des signets.
Pour obtenir le document PDF nouvellement créé, procédez comme suit :
documents
de l’objet AssemblerResult
, qui est un objet Map
contenant les documents PDF résultants.Map
jusqu’à ce que vous trouviez la clé correspondant au nom du document généré. Convertissez ensuite la value
de ce membre du tableau en un objet BLOB
.MTOM
de son objet BLOB
. Cette opération renvoie un tableau d’octets que vous pouvez enregistrer dans un fichier PDF.Voir également
Appeler AEM Forms en utilisant MTOM