Dina data
I det här scenariot skickas information för att hjälpa till att generera dokumentet och informera om vissa avsnitt ska inkluderas eller inte:
{
"customer": {
"name": "Home Services Company",
"street": "123 Any Street",
"city": "Anywhere",
"state": "CA",
"zip": "12345",
"country":"USA",
"signer": {
"email": "johnnyechostone@gmail.com",
"firstName": "John",
"lastName": "Echostone"
}
},
"company": {
"name": "Projected Consultants",
"signer": {
"email": "maryburostone@gmail.com",
"firstName": "Mary",
"lastName": "Burostone"
}
},
"conditions": {
"includeGeneralTerms": true,
"includeConsumerDiscloure": true
}
}
I informationen finns information om kunden, namnet, vem som undertecknar, i vilket tillstånd kunden befinner sig och så vidare. Dessutom finns avsnitt med information om det företag som genererar avtalet och villkorsflaggor som används för att inkludera vissa avsnitt i avtalet.
Lägg till grundläggande taggar i dokumentet
Det här scenariot använder ett villkorsdokument som kan hämtas här.
-
Öppna exempeldokumentet TermsAndConditions.docx i Microsoft Word.
-
Om plugin-programmet Dokumentgenerering är installerat väljer du Dokumentgenerering i menyfliksområdet. Om du inte ser Dokumentgenerering i menyfliksområdet följer du dessa instruktioner.
-
Välj Kom igång.
-
Kopiera JSON-exempeldata som skrivits ovan till JSON-datafältet.
Gå till panelen Dokumentgenereringstagg för att placera taggar i dokumentet.
Infoga företagsnamnet
-
Markera den text som du vill ersätta. I det här scenariot ersätter du FÖRETAGET i dokumentets första avsnitt.
-
Sök efter "name" i Dokumentgenereringstagg.
-
Välj namn under Företag.
-
Välj Infoga text.
En tagg med namnet {{company.name}}
placeras då eftersom taggen finns under den sökvägen i JSON.
{
"company": {
"name": "Projected Consultants",
...
}
...
}
Upprepa sedan detta steg i avsnittet som öppnar för TEXTEN CUSTOMER. Upprepa steg 1-4 och ersätt CUSTOMER med "name" under customer. Utdata ska vara {{customer.name}}
, vilket återspeglar att texten kommer från kundobjektet under.
Med Adobe dokumentgenererings-API:t kan du också inkludera taggar i sidhuvuden och sidfötter och i precis den ände där rubrikerna för signaturerna ska gå.
Upprepa processen igen med steg 1-4 för texten FÖRETAG och KUND i sidfoten.
Slutligen måste du upprepa steg 1-4 för att ersätta FÖRNAMN och EFTERNAMN under avsnittet Kund på signatursidan med taggarna för {{customer.signer.firstName}}
respektive {{customer.signer.lastName}}
. Oroa dig inte om taggen är lång och flödar om till nästa rad eftersom taggen ersätts när dokumentet skapas.
Början av dokumentet och sidfoten ska se ut ungefär så här:
- Avsnittet Början:
- Sidfot:
- Signatursida:
Nu när dina taggar är placerade i dokumentet är du redo att förhandsgranska det genererade avtalet.
Förhandsvisa det genererade dokumentet
Direkt i Microsoft Word kan du förhandsgranska ditt genererade dokument utifrån JSON-exempeldata.
-
Välj Generera dokument i Dokumentgenereringstagg.
-
Första gången kan du uppmanas att logga in med ditt Adobe ID. Välj Logga in och slutför uppmaningarna för att logga in med dina inloggningsuppgifter.
-
Välj Visa dokument.
-
Ett webbläsarfönster öppnas där du kan förhandsgranska dokumentresultaten.
Lägg till villkorliga villkor för varje läge
I nästa område definierar du bara vissa områden som ska infogas baserat på vissa inmatningsvillkor. I exempeldokumentet gäller avsnitten 4 och 5 endast ett visst läge. I detta scenario ska endast de statsspecifika villkoren inkluderas när en kund är bosatt i det läget. Dessutom bör inte numreringen i Microsoft Word inkludera det avsnittet om det tas bort. Använd funktionen Villkorligt innehåll i dokumentgenererings-API:t för att tagga detta.
-
I dokumentet väljer du avsnittet California Disclosure (Kalifornien) och alla underpunkter.
-
I Dokumentgenereringstaggen väljer du Avancerat.
-
Expandera Villkorligt innehåll.
-
I fältet Välj poster söker du efter och väljer customer.state.
-
I fältet Välj operator väljer du =.
-
Skriv CA i fältet Värde.
-
Välj Infoga villkor.
Avsnittet omsluts nu med en del taggar som kallas villkorstaggar. När du lade till märkorden kan de ha lagt till märkordet conditional-section som en numrerad linje. Du kan ta bort det genom att hoppa över mellanrum före märkordet, annars numreras objekten som om märkordet inte fanns där när dokumentet skapades. Det villkorliga avsnittet avslutas med taggen {% end-section %}
.
Upprepa steg 1-7 för avsnittet Washington Disclosure och ersätt värdet CA med WA för att visa att avsnittet endast visas om kundens tillstånd är Washington.
Testning med villkorliga sektioner
När de villkorliga avsnitten är på plats kan du förhandsgranska dokumentet genom att välja Generera dokument.
När du genererar ett dokument ser du att det avsnitt som ingår bara är det som uppfyller datakriterierna. I exemplet nedan, eftersom delstaten var lika med CA, är endast avsnittet Kalifornien inkluderat.
En annan anmärkningsvärd förändring är att numreringen för det efterföljande avsnittet, Användning av Tjänster och Programvara, har nummer 5. Detta innebär att när Washingtonavsnittet utelämnas fortsätter numreringen.
Ändra exempeldata för mallen för att testa om mallen fungerar korrekt när kunden är i delstaten Washington och inte i Kalifornien:
-
I Dokumentgenereringstaggen väljer du Redigera indata.
-
Välj Redigera.
-
I JSON-data ändrar du CA till WA.
-
Välj Generera taggar.
-
Välj Generera dokument för att generera om dokumentet.
Observera att dokumentet bara innehåller delstatssektionen i Washington.
Lägga till en villkorlig mening
Precis som villkorliga avsnitt kan du också ha specifika meningar som ingår när vissa villkor är uppfyllda. I det här exemplet skiljer sig politiken för återvändande mellan Kalifornien och Washington.
- I avsnitt 3.1 väljer du den första meningen "Vid köp i delstaten Washington måste en returneras via MAIL inom 30 dagar efter den ursprungliga transaktionen för en full återbetalning."
- I Dokumentgenereringstaggen väljer du Avancerat.
- Expandera Villkorligt innehåll.
- Välj Fras under Innehållstyp.
- I fältet Välj poster söker du efter och väljer customer.state.
- I fältet Välj operator väljer du =.
- Skriv CA i fältet Värde.
- Välj Infoga villkor.
Även om namnet på taggen är detsamma, är den största skillnaden mellan fras och avsnitt att en fras har avsnittet inte innehålla nya rader. Villkorsmärkordet och -end-section-märkordet måste finnas i samma stycke.
Lägga till taggar för Acrobat Sign
Med Acrobat Sign kan du skicka avtal för signering eller bädda in dem på webben så att någon enkelt kan visa och signera dem. Med taggen Adobe-dokumentgenerering i Microsoft Word kan du enkelt förtagga dokument innan de skickas med Acrobat Sign, så att signaturer alltid placeras på rätt plats. I det här scenariot finns det två signerare som behöver en plats för att signera och datera dokumentet.
-
Navigera till den plats där kunden måste signera.
-
Placera markören där signaturen ska placeras.
-
I Dokumentgenereringstaggen väljer du Adobe Sign.
-
Ange antalet mottagare i fältet Ange antalet mottagare (i det här exemplet används 2).
-
I fältet Mottagare väljer du Signerare-1.
-
Välj Signatur i typen Fält.
-
Markera Infoga Adobe Sign-texttagg.
Detta placerar ett signaturfält där den första signeraren måste signera.
Placera sedan ett datafält för den signerare som automatiskt fylls i vid signering.
-
Flytta markören till det ställe där datumet ska placeras.
-
Ställ in Fälttyp på Datum.
-
Markera Infoga Adobe Sign-texttagg.
Den placerade datumtaggen är ganska lång: {{Date 3_es_:signer1:date:format(mm/dd/yyyy):font(size=Auto)}}
. Acrobat Sign-texttaggen måste finnas på samma rad, vilket skiljer sig från taggarna för dokumentgenerering. Parametrarna :format()
och font()
är valfria, så i det här scenariot kan vi förkorta taggen till {{Date 3_es_:signer1:date}}
.
Upprepa stegen ovanför avsnittet Företagssignatur. När du gör det måste du ändra fältet Mottagare till Signerare-2. Annars tilldelas alla signaturfält samma person.
Generera ett avtal
Du har nu taggat dokumentet och är klar att använda. I det här nästa avsnitt får du lära dig hur du genererar ett dokument med API-exempel för dokumentgenerering för Node.js. Dessa exempel fungerar på alla språk.
Öppna filen pdfservices-node-sdk-samples-master som du hämtade när du registrerade dina inloggningsuppgifter. Bland dessa filer finns filerna pdfservices-api-credentials.json och private.key.
-
Öppna terminalen om du vill installera beroenden med
npm install
. -
Kopiera exemplet data.json till mappen resources.
-
Kopiera Word-mallen som du skapade till mappen resurser.
-
Skapa en ny fil i rotkatalogen i exempelmappen med namnet generate-salesOrder.js.
const PDFServicesSdk = require('@adobe/pdfservices-node-sdk'). const fs = require('fs'); const path = require('path'); var dataFileName = path.join('resources', '<INSERT JSON FILE'); var outputFileName = path.join('output', 'salesOrder_'+Date.now()+".pdf"); var inputFileName = path.join('resources', '<INSERT DOCX>'); //Loads credentials from the file that you created. const credentials = PDFServicesSdk.Credentials .serviceAccountCredentialsBuilder() .fromFile("pdfservices-api-credentials.json") .build(); // Setup input data for the document merge process const jsonString = fs.readFileSync(dataFileName), jsonDataForMerge = JSON.parse(jsonString); // Create an ExecutionContext using credentials const executionContext = PDFServicesSdk.ExecutionContext.create(credentials); // Create a new DocumentMerge options instance const documentMerge = PDFServicesSdk.DocumentMerge, documentMergeOptions = documentMerge.options, options = new documentMergeOptions.DocumentMergeOptions(jsonDataForMerge, documentMergeOptions.OutputFormat.PDF); // Create a new operation instance using the options instance const documentMergeOperation = documentMerge.Operation.createNew(options) // Set operation input document template from a source file. const input = PDFServicesSdk.FileRef.createFromLocalFile(inputFileName); documentMergeOperation.setInput(input); // Execute the operation and Save the result to the specified location. documentMergeOperation.execute(executionContext) .then(result => result.saveAsFile(outputFileName)) .catch(err => { if(err instanceof PDFServicesSdk.Error.ServiceApiError || err instanceof PDFServicesSdk.Error.ServiceUsageError) { console.log('Exception encountered while executing operation', err); } else { console.log('Exception encountered while executing operation', err); } });
-
Ersätt
<JSON FILE>
med namnet på JSON-filen i /resources. -
Ersätt
<INSERT DOCX>
med namnet på DOCX-filen. -
Använd Terminal för att köra noden
generate-salesOrder.js
.
Utdatafilen finns i mappen /output och dokumentet har genererats på rätt sätt.
Du kan ändra formatet genom att ändra raden nedan. DOCX-format är användbart om dokumentet ska skickas för redigering i Word eller för granskning av kontrakt.
PDF:
options = new documentMergeOptions.DocumentMergeOptions(jsonDataForMerge,
documentMergeOptions.OutputFormat.PDF);
Ord:
options = new documentMergeOptions.DocumentMergeOptions(jsonDataForMerge, documentMergeOptions.OutputFormat.DOCX);
Du måste också ändra namnet på utdatafilen till .pdf eller .docx för utdataformatet PDF eller DOCX:
var outputFileName = path.join('output', 'salesOrder_'+Date.now()+".docx");
Skicka avtal för signering
Med Adobe Acrobat Sign kan du skicka avtal till en eller flera mottagare så att de kan visa och signera dokument. Tillsammans med en lättanvänd användarupplevelse att skicka ett dokument för signering, finns REST API:er tillgängliga som låter dig ta Word, PDF, HTML och andra format och skicka dem för signering.
Exemplet nedan visar hur du använder REST API-dokumentationssidan för att ta det tidigare genererade dokumentet och skicka det för signering. Börja med att lära dig hur du gör det via webbgränssnittet i Acrobat Sign och sedan hur du gör det med REST API.
Skaffa ett Acrobat Sign-konto
Om du inte har något Acrobat Sign-konto registrerar du dig för ett utvecklarkonto och granskar dokumentationen här och väljer Registrera dig för utvecklarkonto. Du uppmanas att fylla i ett formulär och få en bekräftelse via e-post. När du har gjort det dirigeras du till en webbplats där du kan ange ditt lösenord och konto och sedan logga in på Acrobat Sign.
Skicka ett avtal från webbgränssnittet
-
Välj Skicka i navigeringsfältet.
-
Ange två e-postadresser i fältet Mottagare. Det är bästa praxis att använda en e-postadress som inte är kopplad till ditt Acrobat Sign-konto.
-
Ange ett Avtalsnamn och Meddelande.
-
Välj Lägg till filer och överför den genererade filen från datorn.
-
Välj Förhandsvisa och lägg till signaturfält.
-
Välj Nästa.
-
När du bläddrar nedåt till signatursidan kan du se de placerade signaturfälten utifrån taggarna.
-
Välj Skicka.
-
I ditt e-postmeddelande visas ett meddelande med en länk för att visa och signera.
-
Välj Granska och signera.
-
Välj Fortsätt för att godkänna användningsvillkoren.
-
Välj Start för att gå till den plats där du måste signera.
-
Välj Klicka här för att signera.
-
Skriv din signatur.
-
Välj Använd.
-
Välj Klicka för att signera.
Ett e-postmeddelande skickas till nästa signerare. Upprepa steg 9-16 för att visa och signera för den andra signeraren.
När avtalet har slutförts skickas en signerad kopia av avtalet via e-post till var och en av parterna. Dessutom kan ett signerat avtal hämtas från webbgränssnittet i Acrobat Sign på sidan Hantera.
Lär dig sedan hur du gör samma scenario via REST API-dokumentation.
Hämta autentiseringsuppgifter
-
Gå till Acrobat Sign REST-dokumentation.
-
Expandera transientDocuments och POSTEN /transientDocuments.
-
Välj OAUTH ACCESS-TOKEN.
-
Kontrollera OAUTH-behörigheterna för agreement_write, agreement_sign, widget_write och library_write.
-
Välj Auktorisera.
-
Du uppmanas att logga in med ditt Acrobat Sign-konto via ett popup-fönster. Logga in användare Administratörens användarnamn och lösenord.
-
Du uppmanas att tillåta åtkomst till REST-dokumentationen. Välj Tillåt åtkomst.
En ägartoken läggs sedan till i fältet Auktorisering.
Om du vill läsa mer om hur du skapar en auktoriseringstoken för Acrobat Sign kan du följa stegen som beskrivs här.
Ladda upp ett tillfälligt dokument
Eftersom auktoriseringstoken läggs till från föregående steg måste du överföra ett dokument för att göra API-anropet:
-
I fältet Fil överför du PDF-dokumentet som skapades i tidigare steg.
-
Välj Prova!.
-
Kopiera värdet transientDocumentId i svarstexten.
transientDocumentId används för att referera till ett dokument som tillfälligt lagras i Acrobat Sign så att det kan refereras i efterföljande API-anrop.