Téléchargement et suppression de documents

Pour télécharger l'exemple complet de code, consultez notre site de partage de code .

Ce sujet comprend les éléments suivants :

• Comment télécharger un document

• Comment remplacer un document existant

• Comment mettre à jour les métadonnées dans un document

• Comment supprimer un document après avoir créé un paquet

Téléchargement des documents

Pour ajouter un document à un package existant, vous devez d'abord créer l'objet Document . Le code suivant créera un objet Document :

Document document = DocumentBuilder.newDocumentWithName("Example Document")
            .fromFile("DOC_FILE_PATH")
            //.fromStream( documentStream, DocumentType.PDF );
            .withId("document1")
            .withDescription("Sample Document Description")
            .build();

Une fois l'objet Document créé, trouvez le PackageId auquel vous souhaitez ajouter le document, puis utilisez le client OneSpan Sign pour téléverser ce document. Le code suivant le fera ainsi :

eslClient.uploadDocument(document, packageId);

Vous pouvez également télécharger plusieurs documents en un seul appel. Pour cela, construisez plusieurs objets Document localement et passez-les comme arguments variables ou en liste dans le code suivant :

eslClient.uploadDocuments(packageId, doc1, doc2, doc3);
            eslClient.uploadDocuments(packageId, Arrays.asList(doc1, doc2, doc3));

OneSpan Sign prend en charge les types de documents suivants :

• Le format de document portable d'Adobe (*.pdf) — Les PDF sur lesquels OneSpan Sign peut agir ont généralement au moins ces permissions activées : (1) Modification du document ; (2) Signature ; (3) Remplissage des champs de formulaire.

• Microsoft Word (*.Doc ou *. docx)

• Open Office (*.odt)

• Texte (*.txt)

• Format de texte enrichi (*.RTF)

De plus, le pilote d'impression OneSpan Sign prend en charge tout document pouvant être imprimé depuis une application Windows (par exemple, Microsoft Word, Microsoft Excel, Microsoft PowerPoint).

Contraintes de taille de fichier

• La taille maximale d'un seul document est de 16 Mo. Les documents plus petits offrent de meilleures performances — nous recommandons moins de 5 Mo par document.

• La taille totale maximale de tous les documents d'une transaction est de 39 Mo. Cependant, la taille maximale peut varier en fonction de la taille totale de votre charge utile. Si vous recevez un message d'erreur lorsque la taille totale de votre document est de 39 Mo, essayez de réduire la taille totale à entre 35 Mo et 39 Mo.

• Si votre organisation utilise des connecteurs Salesforce ou Microsoft SharePoint, la taille maximale du fichier est de 5 Mo par document.

• Si votre organisation utilise des connecteurs Salesforce, le nombre maximal de documents pouvant être ajoutés à une transaction est de dix (10).

• Si vous activez la livraison d'e-mail tout en configurant un destinataire, les pièces jointes supérieures à 5 Mo ne sont pas prises en charge.

Contraintes de noms de fichiers

• Les noms de fichiers des documents ne doivent pas contenir les caractères suivants séparés par des virgules : *, /, \, :, <, >, |, ?, ".

Contraintes générales des fichiers

• Nous vous recommandons de ne pas utiliser de documents PDF qui utilisent XML Forms Architecture. Pour plus d'informations, voir Soutien XFA.

• Ne téléchargez pas les documents protégés par mot de passe ou corrompus. Celles-ci génèrent une erreur.

• OneSpan recommande vivement de scanner un PDF pour détecter des erreurs de syntaxe (par exemple, en utilisant l'outil Preflight d'Adobe) et de résoudre les erreurs avant d'ajouter le document à une transaction.

• Les PDF avec le drapeau NeedAppearances réglé sur true ne sont pas actuellement pris en charge.

Remplacement d'un document existant

Le remplacement d'un document existant dans une transaction peut également se faire via la fonction Upload. C'est utile, par exemple, si vous souhaitez remplacer le document tout en conservant la disposition des champs et des signatures.

Pour cela, construisez un objet Document qui porte le même ID de document que le document que vous souhaitez remplacer, puis utilisez le client OneSpan Sign pour le télécharger. Le code suivant le fera ainsi :

Document document = DocumentBuilder.newDocumentWithName("Document1")
            .fromFile("path_to_your_file")
            .withId("keep_the_same_document_id")
            .build();
            eslClient.uploadDocument(document, new PackageId("the_package_id"));

De même, vous pouvez remplacer plusieurs documents lors d'un appel.

Document document = DocumentBuilder.newDocumentWithName("Updated Document1")
            .fromFile("path_to_your_file ")
            .withId("1dda69f88b10f2e0e6bd846aae9fca0a961aba793bf655b0")
            .build();
            Document document2 = DocumentBuilder.newDocumentWithName("Updated Document2")
            .fromFile("path_to_your_file ")
            .withId("c4a6128b646f50c650779d652e5951097663a1de16c4ce72")
            .build();
            eslClient.uploadDocuments(new PackageId("package_id"),Arrays.asList(document,document2)); 

Mise à jour des métadonnées du document

Pour mettre à jour les métadonnées d'un document, il suffit de créer un objet Document avec les mises à jour que vous souhaitez effectuer. Par exemple :

Document document = DocumentBuilder.newDocumentWithName("Example Document")
            .withName("Updated document name")
            .withDescription("Updated document description")
            .build();

Ensuite, prenez le DocumentPackage dans lequel vous souhaitez modifier ce document et utilisez le client OneSpan Sign pour mettre à jour les métadonnées du document. Le code suivant le fera ainsi :

eslClient.getPackageService().updateDocumentMetadata(documentPackage, document);

Suppression d'un document

Pour supprimer un document, appelez la fonction deleteDocument avec la chaîne packageId et documentId :

eslClient.getPackageService().deleteDocument(packageId, document.getId().toString());

Résultats

Après avoir exécuté votre code, si vous vous connectez à OneSpan Sign et naviguez vers votre transaction, vous pourrez vous connecter à votre compte OneSpan Sign et consulter les documents que vous venez d'ajouter.

Pour télécharger l'exemple complet de code, consultez notre site de partage de code .

Ce sujet comprend les éléments suivants :

• Comment télécharger un document

• Comment remplacer un document existant

• Comment mettre à jour les métadonnées dans un document

• Comment supprimer un document après avoir créé un paquet

Téléchargement des documents

Pour ajouter un document à un package existant, vous devez d'abord créer l'objet Document . Le code suivant créera un objet Document :

Document document = DocumentBuilder.NewDocumentNamed("Example Document")
            .FromFile("DOC_FILE_PATH")
            //.fromStream( documentStream, DocumentType.PDF );
            .WithId("document1")
            .WithDescription("Sample Document Description")
            .Build();

Une fois l'objet Document créé, trouvez le PackageId auquel vous souhaitez ajouter le document, puis utilisez le client OneSpan Sign pour téléverser ce document. Le code suivant le fera ainsi :

eslClient.UploadDocument(document, packageId);

Vous pouvez également télécharger plusieurs documents en un seul appel. Pour cela, construisez plusieurs objets Document localement et passez-les comme arguments variables ou en liste dans le code suivant :

eslClient.UploadDocuments(packageId, doc1, doc2, doc3);
            eslClient.UploadDocuments(packageId, new List<Document>(){doc1,doc2,doc3}); 

OneSpan Sign prend en charge les types de documents suivants :

• Le format de document portable d'Adobe (*.pdf) — Les PDF sur lesquels OneSpan Sign peut agir ont généralement au moins ces permissions activées : (1) Modification du document ; (2) Signature ; (3) Remplissage des champs de formulaire.

• Microsoft Word (*.Doc ou *. docx)

• Open Office (*.odt)

• Texte (*.txt)

• Format de texte enrichi (*.RTF)

De plus, le pilote d'impression OneSpan Sign prend en charge tout document pouvant être imprimé depuis une application Windows (par exemple, Microsoft Word, Microsoft Excel, Microsoft PowerPoint).

Contraintes de taille de fichier

• La taille maximale d'un seul document est de 16 Mo. Les documents plus petits offrent de meilleures performances — nous recommandons moins de 5 Mo par document.

• La taille totale maximale de tous les documents d'une transaction est de 39 Mo. Cependant, la taille maximale peut varier en fonction de la taille totale de votre charge utile. Si vous recevez un message d'erreur lorsque la taille totale de votre document est de 39 Mo, essayez de réduire la taille totale à entre 35 Mo et 39 Mo.

• Si votre organisation utilise des connecteurs Salesforce ou Microsoft SharePoint, la taille maximale du fichier est de 5 Mo par document.

• Si votre organisation utilise des connecteurs Salesforce, le nombre maximal de documents pouvant être ajoutés à une transaction est de dix (10).

• Si vous activez la livraison d'e-mail tout en configurant un destinataire, les pièces jointes supérieures à 5 Mo ne sont pas prises en charge.

Contraintes de noms de fichiers

• Les noms de fichiers des documents ne doivent pas contenir les caractères suivants séparés par des virgules : *, /, \, :, <, >, |, ?, ".

Contraintes générales des fichiers

• Nous vous recommandons de ne pas utiliser de documents PDF qui utilisent XML Forms Architecture. Pour plus d'informations, voir Soutien XFA.

• Ne téléchargez pas les documents protégés par mot de passe ou corrompus. Celles-ci génèrent une erreur.

• OneSpan recommande vivement de scanner un PDF pour détecter des erreurs de syntaxe (par exemple, en utilisant l'outil Preflight d'Adobe) et de résoudre les erreurs avant d'ajouter le document à une transaction.

• Les PDF avec le drapeau NeedAppearances réglé sur true ne sont pas actuellement pris en charge.

Remplacement d'un document existant

Le remplacement d'un document existant dans une transaction peut également se faire via la fonction Upload. C'est utile, par exemple, si vous souhaitez remplacer le document tout en conservant la disposition des champs et des signatures.

Pour cela, construisez un objet Document qui porte le même ID de document que le document que vous souhaitez remplacer, puis utilisez le client OneSpan Sign pour le télécharger. Le code suivant le fera ainsi :

Document document = DocumentBuilder.NewDocumentWithName("Document1")
            .FromFile("path_to_your_file")
            .WithId("keep_the_same_document_id")
            .Build();
            eslClient.UploadDocument(document, new PackageId("the_package_id"));

De même, vous pouvez remplacer plusieurs documents lors d'un appel.

Document document = DocumentBuilder.NewDocumentWithName("Updated Document1")
            .FromFile("path_to_your_file ")
            .WithId("1dda69f88b10f2e0e6bd846aae9fca0a961aba793bf655b0")
            .Build();
            Document document2 = DocumentBuilder.NewDocumentWithName("Updated Document2")
            .FromFile("path_to_your_file ")
            .WithId("c4a6128b646f50c650779d652e5951097663a1de16c4ce72")
            .Build();
            eslClient.UploadDocuments(new PackageId("package_id"), new List<Document>(){document,document2}); 

Mise à jour des métadonnées du document

Pour mettre à jour les métadonnées d'un document, il suffit de créer un objet Document avec les mises à jour que vous souhaitez effectuer. Par exemple :

Document document = DocumentBuilder.NewDocumentNamed("Example Document")
            .WithName("Updated document name")
            .WithDescription("Updated document description")
            .Build();

Ensuite, prenez le DocumentPackage dans lequel vous souhaitez modifier ce document et utilisez le client OneSpan Sign pour mettre à jour les métadonnées du document. Le code suivant le fera ainsi :

eslClient.PackageService.UpdateDocumentMetadata(documentPackage, document);

Suppression d'un document

Pour supprimer un document, appelez la fonction deleteDocument avec la chaîne packageId et documentId :

eslClient.PackageService.DeleteDocument(packageId, document.Id.ToString());

Résultats

Après avoir exécuté votre code, si vous vous connectez à OneSpan Sign et naviguez vers votre transaction, vous pourrez vous connecter à votre compte OneSpan Sign et consulter les documents que vous venez d'ajouter.

Pour télécharger l'exemple complet de code, consultez notre site de partage de code .

Ce sujet comprend les éléments suivants :

• Comment télécharger un document

• Comment remplacer un document existant

• Comment mettre à jour les métadonnées dans un document

• Comment supprimer un document après avoir créé un paquet

Téléchargement des documents

Pour ajouter un document à un package existant, vous devez d'abord créer l'objet Document . Le code suivant créera un objet Document :

 StaticResource sr = [SELECT Id, Body FROM StaticResource WHERE Name = 'testdoc1' LIMIT 1];
            Map<String,Blob> doc = new Map<String,Blob>();
            doc.put('Sample Document', sr.Body);

            ESignLiveAPIObjects.Document document = new ESignLiveAPIObjects.Document();
            document.name = 'Sample Contract';
            document.id = 'document1';

Une fois l'objet Document créé, trouvez le PackageId auquel vous souhaitez ajouter le document, puis utilisez le client OneSpan Sign pour téléverser ce document. Le code suivant le fera ainsi :

 String documentResponse = sdk.createDocuments(packageId, document, doc);
            document = (ESignLiveAPIObjects.Document)JSON.deserialize(documentResponse, ESignLiveAPIObjects.Document.class);

OneSpan Sign prend en charge les types de documents suivants :

• Le format de document portable d'Adobe (*.pdf) — Les PDF sur lesquels OneSpan Sign peut agir ont généralement au moins ces permissions activées : (1) Modification du document ; (2) Signature ; (3) Remplissage des champs de formulaire.

• Microsoft Word (*.Doc ou *. docx)

• Open Office (*.odt)

• Texte (*.txt)

• Format de texte enrichi (*.RTF)

De plus, le pilote d'impression OneSpan Sign prend en charge tout document pouvant être imprimé depuis une application Windows (par exemple, Microsoft Word, Microsoft Excel, Microsoft PowerPoint).

Contraintes de taille de fichier

• La taille maximale d'un seul document est de 16 Mo. Les documents plus petits offrent de meilleures performances — nous recommandons moins de 5 Mo par document.

• La taille totale maximale de tous les documents d'une transaction est de 39 Mo. Cependant, la taille maximale peut varier en fonction de la taille totale de votre charge utile. Si vous recevez un message d'erreur lorsque la taille totale de votre document est de 39 Mo, essayez de réduire la taille totale à entre 35 Mo et 39 Mo.

• Si votre organisation utilise des connecteurs Salesforce ou Microsoft SharePoint, la taille maximale du fichier est de 5 Mo par document.

• Si votre organisation utilise des connecteurs Salesforce, le nombre maximal de documents pouvant être ajoutés à une transaction est de dix (10).

• Si vous activez la livraison d'e-mail tout en configurant un destinataire, les pièces jointes supérieures à 5 Mo ne sont pas prises en charge.

Contraintes de noms de fichiers

• Les noms de fichiers des documents ne doivent pas contenir les caractères suivants séparés par des virgules : *, /, \, :, <, >, |, ?, ".

Contraintes générales des fichiers

• Nous vous recommandons de ne pas utiliser de documents PDF qui utilisent XML Forms Architecture. Pour plus d'informations, voir Soutien XFA.

• Ne téléchargez pas les documents protégés par mot de passe ou corrompus. Celles-ci génèrent une erreur.

• OneSpan recommande vivement de scanner un PDF pour détecter des erreurs de syntaxe (par exemple, en utilisant l'outil Preflight d'Adobe) et de résoudre les erreurs avant d'ajouter le document à une transaction.

• Les PDF avec le drapeau NeedAppearances réglé sur true ne sont pas actuellement pris en charge.

Remplacement d'un document existant

Le remplacement d'un document existant dans une transaction peut également se faire via la fonction Upload. C'est utile, par exemple, si vous souhaitez remplacer le document tout en conservant la disposition des champs et des signatures.

Pour cela, construisez un objet Document qui porte le même ID de document que le document que vous souhaitez remplacer, puis utilisez le client OneSpan Sign pour le télécharger. Le code suivant le fera ainsi :

StaticResource sr = [SELECT Id, Body FROM StaticResource WHERE Name = 'testdoc1' LIMIT 1];
            Map<String,Blob> doc = new Map<String,Blob>();
            doc.put('Sample Document', sr.Body);

            ESignLiveAPIObjects.Document document = new ESignLiveAPIObjects.Document();
            document.name = 'Updated Document';
            document.id = ‘keep_the_document_id_same’;
            String documentResponse = sdk.createDocuments(packageId, document, doc); 

Mise à jour des métadonnées du document

Pour mettre à jour les métadonnées d'un document, il suffit de créer un objet Document avec les mises à jour que vous souhaitez effectuer. Par exemple :

 ESignLiveAPIObjects.Document document_updated = new ESignLiveAPIObjects.Document();
            document_updated.name = 'updated document name';
            document_updated.description = 'updated document description';

Ensuite, utilisez la fonction ci-dessous pour mettre à jour les métadonnées du document en passant l' ID du paquet, l'ID du document et l'objet Document mis à jour.

 sdk.updateDocument(packageId, document.id, document_updated);

Suppression d'un document

Pour supprimer un document, appelez la fonction deleteDocument avec la chaîne packageId et documentId :

 sdk.deleteDocument(packageId, document.id);

Résultats

Après avoir exécuté votre code, si vous vous connectez à OneSpan Sign et naviguez vers votre transaction, vous pourrez vous connecter à votre compte OneSpan Sign et consulter les documents que vous venez d'ajouter.