Met de sjabloon Initiate Document Export kunt u Workiva-documenten exporteren in HTTP-formaat, dat vervolgens kan worden geconverteerd naar een PDF- of DOCX-bestand. Deze functie wordt vaak gebruikt om back-ups te maken van documenten, offline bewerken mogelijk te maken of om Workiva-documenten te delen met gebruikers buiten de werkruimte.
Vereisten
- U moet toegang hebben tot de Client ID en Client Secret via uw OAuth2-subsidie.
- De volgende connectoren moeten in uw werkruimte worden geconfigureerd:
Uw sjabloon samenstellen
De sjabloon Initiate Document Export vindt u in het Workiva Chains gedeelte van het scherm Templates.
Zo vindt u het:
- Ga in Chain Builder naar het tabblad Templates .
- Selecteer Workiva Ketens in het menu bovenaan.
- Zoek rechtsboven naar Initiate Document Export en open de sjabloon.
Nadat u uw sjabloon hebt gevonden, configureert u deze voor uw werkruimte met behulp van de hieronder vermelde variabelen en runtime-invoer.
Opmerking: Zie het artikel Ketens maken en beheren voor gedetailleerde instructies over het maken van een ketting vanuit een sjabloon.
Variabelen
| Variabel type | Naam variabele | Beschrijving | Vereist? |
| Dynamische Keten | dcv-exportStatus | Wordt gebruikt om de exportstatus van het document vast te leggen. | Ja |
| Dynamische Keten | dcv-resourceURL | De documentnaam of ID Waarde. | Ja |
| Werkruimte | wsv-ClientID | ID gegenereerd uit de OAuth2 Grant voor uw Workiva-connector. | Ja |
| Werkruimte | wsv-geheim | Geheim token gegenereerd uit de OAuth2 Grant voor uw Workiva connector. | Ja |
| Werkruimte | wsv-IAMURL | De IAM Host Override URL. | Ja |
| Werkruimte | wsv-PlatformURL | De Platform API Host Override URL. | Ja |
Overwegingen
| Runtime invoer | Beschrijving | Opties | Vereist? |
| ExportFormat | Geeft het formaat van de export aan. | .pdf of .docx | Ja |
| ExportID | De ID van het document. | Ja | |
| Exportbestandsnaam | Kan gebruikt worden bij het uploaden of e-mailen om de standaardnaam van het bestand te vervangen. | Geen | |
| Secties | De ID's van de secties in het te exporteren document. Kan leeg gelaten worden als het hele document geëxporteerd wordt. | Geen | |
| Docx - Exportopties | Bij exporteren naar .docx geeft dit specificaties over het geëxporteerde object. |
|
Geen |
| PDF-exportopties | Bij het exporteren naar .pdf geeft dit specificaties over het geëxporteerde object. |
|
Geen |
Opmerking: Als de optionele velden leeg worden gelaten, wordt het gehele object geëxporteerd zonder dat er specificaties worden toegepast.
E-mail afleveringsnotificatie instellen
Om het geëxporteerde bestand te ontvangen, moet u bovendien de opdracht Get (Final Resource) configureren met een e-mailmelding:
- Selecteer tijdens het bewerken van de Initiate Document Export-keten de opdracht Get (Final Resource) en klik op het potlood Edit
- Klik op het enveloppictogram om het scherm Meldingen te openen.
- Klik op de knop + Nieuwe melding.
- Open het vervolgkeuzemenu "Voorwaarde" en selecteer Succes.
- Open het vervolgkeuzemenu "Ontvangers" en selecteer de e-mailadressen van alle gebruikers die het geëxporteerde object moeten ontvangen.
- Open het menu "Bijlagen" en selecteer de bestandsuitvoer van de opdracht Get (Final Resource).
Dit proces stuurt de ontvanger van de e-mail een HTTP-bestand. De ontvanger moet dan handmatig de extensie van het bestand hernoemen naar het gewenste formaat:
- File_name.txt. => file_name.pdf
- File_name.txt => file_name.docx
Probleemoplossing
Als uw ketting een fout heeft veroorzaakt of de juiste gegevens niet heeft bijgewerkt, controleer dan of het volgende waar is:
-
Alle werkruimtevariabelen zijn correct. Als u een sandbox-workspace gebruikt, gebruik dan de sandbox-versie van de IAM/Platform URL's.
-
U hebt alle noodzakelijke runtime-ingangen opgenomen, zoals de presentatie- en export-ID.
-
U hebt een instelling voor e-mailnotificatie geconfigureerd voor de opdracht Get (Final Result).