Modèle de chaîne : Lancer l'exportation de documents

Le modèle Initiate Document Export vous permet d'exporter des documents Workiva au format HTTP, qui peuvent ensuite être convertis en fichiers PDF ou DOCX. Cette fonction est couramment utilisée pour sauvegarder des documents, permettre une édition hors ligne ou partager des documents Workiva avec des utilisateurs en dehors de l'espace de travail.

Exigences

Vous devez avoir accès à l'identifiant et au secret du client via votre subvention OAuth2.
Les connecteurs suivants doivent être configurés dans votre espace de travail :
- HTTP
- Handlebars

Créez votre modèle

Le modèle Initiate Document Export se trouve dans la section Workiva Chains de l'écran Templates (Modèles).

Voici comment le trouver :

Dans Chain Builder, allez dans l'onglet Templates dynamic_feed .
Sélectionnez Workiva Chains dans le menu du haut.
Recherchez Lancer l'exportation du document en haut à droite et ouvrez le modèle.

Après avoir localisé votre modèle, configurez-le pour votre espace de travail à l'aide des variables et des entrées d'exécution énumérées ci-dessous.

Note : Pour des instructions détaillées sur la création d'une chaîne à partir d'un modèle, voir l'article Créer et gérer des chaînes.

Variables

Type de variable	Nom de la variable	Description	Nécessaire ?
Chaîne dynamique	dcv-exportStatus	Utilisé pour capturer le statut d'exportation du document.	Oui
Chaîne dynamique	dcv-resourceURL	Le nom ou l'ID du document.	Oui
Espace de travail	wsv-ClientID	ID généré par la subvention OAuth2 pour votre connecteur Workiva.	Oui
Espace de travail	wsv-Secret	Jeton secret généré à partir de la subvention OAuth2 pour votre connecteur Workiva.	Oui
Espace de travail	wsv-IAMURL	L'URL de remplacement de l'hôte IAM.	Oui
Espace de travail	wsv-PlatformURL	L'URL de remplacement de l'hôte de l'API de la plate-forme.	Oui

Considérations

Entrée de durée d’exécution	Description	Options	Nécessaire ?
Format d'exportation	Indique le format de l'exportation.	.pdf ou .docx	Oui
ExportID	L'identifiant du document.		Oui
Nom du fichier d'exportation	Peut être utilisé lors du téléchargement ou de l'envoi par courrier électronique pour remplacer le nom par défaut du fichier.		Pas de
Sections	Les ID des sections du document à exporter. Peut être laissé vide si l'on exporte le document entier.		Pas de
Docx - Options d'exportation	Lors de l'exportation vers .docx, ceci fournit des spécifications sur l'objet exporté.	includeLeaderDots showTableCellShading	Pas de
Options d'exportation PDF	Lors de l'exportation vers le format .pdf, ceci fournit des spécifications sur l'objet exporté.	includeAlternateRowFill includeAttachmentLabels inclureCommentaires includeHyperlinks tagForWebAccessibility useCmykColorspace includeTrackChanges includeLeaderDots includeDraftWatermark	Pas de

Note: Si les champs facultatifs sont laissés vides, l'objet entier sera exporté sans aucune spécification.

Configuration de la notification par courrier électronique

Pour recevoir le fichier exporté, vous devez en outre configurer la commande Get (Final Resource) avec une notification par courrier électronique :

Lors de la modification de la chaîne Lancer l'exportation du document, sélectionnez la commande Obtenir (Ressource finale) et cliquez sur le crayon de création.
Cliquez sur l'icône de l'enveloppe pour ouvrir l'écran Notifications.
Cliquez sur le bouton Nouvelle notification.
Ouvrez le menu déroulant "Condition" et sélectionnez Succès.
Ouvrez le menu déroulant "Destinataires" et sélectionnez l'adresse électronique de tous les utilisateurs qui doivent recevoir l'objet exporté.
Ouvrez le menu "Attachments" et sélectionnez le fichier issu de la commande Get (Final Resource).

Ce processus enverra au destinataire du courriel un fichier HTTP. Le destinataire doit ensuite renommer manuellement l'extension du fichier au format souhaité :

File_name.txt. => file_name.pdf
File_name.txt => file_name.docx

Dépannage

Si votre chaîne a déclenché une erreur ou n'a pas réussi à mettre à jour les données correctes, vérifiez les points suivants :

Toutes les variables de l'espace de travail sont correctes. Si vous utilisez un espace de travail en bac à sable, utilisez la version bac à sable des URL IAM/Platform.
Vous avez inclus toutes les données d'exécution nécessaires, telles que la présentation et l'ID d'exportation.
Vous avez configuré un paramètre de notification par courrier électronique pour la commande Get (Final Result).

Support

Communauté

Portail de support Workiva