Generating documents using the web app

Generating documents using the Inkit web app is a good way of generating a single document or testing a template that you created.

Generating a document from a template

To generate a document from a template using the Inkit web app, do the following:

1. In the Inkit web app, select Documents in the left sidebar. Then click + Create and select Document from the dropdown list.

   

2. In the Create Document page, select a template that you want to use to generate the document and click Continue.

   

3. In the New Document panel, enter a Name of the document and an optional Description and click Continue.

   

4. In the Fill Out Destinations panel, enter the data that you will inject into your document in Your Data.

   

5. Click the Inkit Storage tab.

   Select the folder where you want to generate the documents from the Folder dropdown box. The default is the root folder.

   To have documents expire after certain amount of time, turn the switch beside Expire Document after on and specify the Amount of Time and the Unit of time. You can choose from the following units:

   • Minutes
   • Hours
   • Days
   • Years

   To have documents expire after specific number of views, turn the switch beside Expire after an Amount of Views on and enter the number of Views before the document expires.

   

   Note: You can apply both expiration options at the same time. Whichever option that happens first will trigger the expiration.

6. Optionally add additional destinations to the document.

7. Optionally preview the document by clicking Preview.

   

   The Preview window will display.

   

   To close the Preview window, click Close at the bottom of it.

   

8. Click Generate Document.

   

   The document job will then enter the Inkit queue. Wait a few seconds for it to complete and refresh the page.

9. To view your generated document, double-click on it.

   

10. Your generated document will display in the document viewer.

    

Adding additional destinations to a document

To add document destinations in addition to Inkit Storage, click + Add under Fill Out Destinations.

In the Add Destination dialog box, select a destination and click Continue.

This will create a tab for the destination that you added. You will then need to fill out settings for the destination.

Setting Salesforce as a document destination

To set Salesforce as a destination of the document, do the following:

In the Salesforce tab, select the Salesforce delivery method from the following options:

• Send Inkit Storage link (sends only a link to the generated document back to Salesforce)
• Send file (sends the entire generated document back to Salesforce)

In the Salesforce Environment dropdown box, select from the following options:

• Production
• Sandbox

Note: You can only select the sandbox environment if you connected it when setting up the Salesforce app.

Enter the File Name of the generated document (without a file extenstion), an optional Description and the Salesforce Record ID.

Setting Magic Link as a document destination

To set Magic Link as a destination of the document, do the following:

In the Magic Link tab, select the Authentication Type from the following options:

• Email (users complete authentication through an email address)
• Social (users complete authentication through a social login provider such as Google)

Enter the email address of the Magic Link's recepient in Recipient’s Email Address and Authorization Email Address.

To have documents expire after certain amount of time, select Expire after and specify the Amount of Time and the Unit of time. You can choose from the following units:

• Minutes
• Hours
• Days

Then select when to start the expiration timer from the following options:

• Start expiration timer when link is sent
• Start expiration timer when link is opened

To have documents expire after specific number of views, select Expire after an Amount of Views and enter the maximum number of Views before the document expires.

Note: If you select Expire after an Amount of Views, the link will expire in 10 days even if there are views remaining.

Setting DocuSign as a document destination

To set DocuSign as a destination of the document, do the following:

In the DocuSign tab, select signer delivery order from the following:

• In order (default)
• All at once
• Custom (set the order at the time of document generation)

Under Signers, enter a Full Name and Email for each DocuSign field embedded in the template.

Optionally, under Recipients, you can add recipients by clicking Add Recipient and entering a Full Name and Email for each.

Setting Amazon S3 as a document destination

To set Amazon S3 as a destination of the document, do the following:

In the Amazon S3 tab, enter the Bucket Name of the generated document and the File Name of the document (without a file extenstion).

Setting Google Drive as a document destination

To set Google Drive as a destination of the document, do the following:

In the Google Drive tab, enter the Folder ID where the document will be generated and the File Name of the document (without a file extenstion).

Note: You cannot generate documents in the root folder of your Google Drive.

Note: You can find the ID of Google Drive folder by opening the folder and checking the URL. If, for example, the URL is https://drive.google.com/drive/folders/12HCqdH7SEJT7USqIpmxqcyn0m3gDTu8b, the ID is 12HCqdH7SEJT7USqIpmxqcyn0m3gDTu8b.

Setting Dropbox as a document destination

To set Dropbox as a destination of the document, do the following:

In the Dropbox tab, enter the Path and the File Name of the generated document (without a file extenstion).

Note: Enter a Path of / if you want to place the generated document in the root folder.

Setting Box as a document destination

To set Box as a destination of the document, do the following:

In the Box tab, enter the Parent ID and the File Name of the generated document (without a file extenstion).

Note: Enter a Path of 0 if you want to place the generated document in the root folder.

Setting Sepire as a document destination

To set Sepire as a destination of the document, do the following:

In the Sepire tab, under Recipient Address, enter the following fields:

• First Name
• Last Name
• Address Line 1
• Address Line 2
• City
• State/Province/Region
• Country
• ZIP

Under Mail Product, select the Type from the dropdown box. you can select one of the following options:

• Letter
• Postcard

If you select a Type of Letter, do the following:

Select one of the following Postage options:

• Standard
• First class

Select one of the following Color options:

• Black & white
• Color

If you want to verify the address of the recipient, click on Address verification.

If you select a Type of Postcard, do the following:

Select one of the following Postage options:

• Standard
• First class

Select one of the following Size options:

• 4x6
• 6x9

If you want to verify the address of the recipient, click on Address verification.