Ch. 036 InDesign Plug-in for eDocBuilder

EDOCBUILDER > eDocBuilder Documentation Manual & Videos

All eDocBuilder subscriptions include a convenient InDesign plug-in to help you set up your templates. This plug-in focuses on the basics of field positioning, default field formatting, and the collection of assets such as fonts to make creating a template faster and easier, as opposed to uploading all the images, fonts and PDF files manually.

After you create your template in InDesign you will need to log into eDocBuilder to complete some settings before the template is usable. In the same way that some eDocBuilder capabilities are not available in InDesign, not all capabilities in InDesign will be available in eDocBuilder. Please review the article Tips, Tricks and Warnings for using the InDesign Plug-in for more information on considerations and limitations.

Installation

Downloads for Windows and Macintosh, for all supported versions of InDesign, are listed under Downloads on this page. Download the version of the plug-in for your version of InDesign and operating system, then review and follow the steps under Configuration below, to make sure the plug-in is installed and working as expected.

Important Update: There is a known issue with macOS Catalina and Adobe products. Access this link for a workaround that describes a similar issue with another Adobe product while we work with the publisher of this plug-in to correct the issue. 

Downloads

Windows Downloads

Windows InDesign CC 2019 (64-bit systems)
  Click here to download the InDesign plug-in for eDocBuilder. Requires InDesign Creative Cloud 2019 on Windows 64 bit systems.
 
Windows InDesign CC 2019 (32-bit systems)
  Click here to download the InDesign plug-in for eDocBuilder. Requires InDesign Creative Cloud 2019 on Windows 32-bit systems.
 
Windows InDesign CC 2018 (64-bit systems)
  Click here to download the InDesign plug-in for eDocBuilder. Requires InDesign Creative Cloud 2018 on Windows 64 bit systems.
 
Windows InDesign CC 2018 (32-bit systems)
  Click here to download the InDesign plug-in for eDocBuilder. Requires InDesign Creative Cloud 2018 on Windows 32-bit systems.
 
Windows InDesign CC 2017 (64-bit systems)
  Click here to download the InDesign plug-in for eDocBuilder. Requires InDesign Creative Cloud 2017 on Windows 64 bit systems.
 
Windows InDesign CC 2017 (32-bit systems)
  Click here to download the InDesign plug-in for eDocBuilder. Requires InDesign Creative Cloud 2017 on Windows 32-bit systems.
 
Windows InDesign CC 2015 (64-bit systems)
 Click here to download the InDesign plug-in for eDocBuilder. Requires InDesign Creative Cloud 2015 on Windows 64 bit systems.
 
Windows InDesign CC 2015 (32-bit systems)
  Click here to download the InDesign plug-in for eDocBuilder. Requires InDesign Creative Cloud 2015 on Windows 32-bit systems.
 
Windows InDesign CC 2014 (64-bit systems)
  Click here to download the InDesign plug-in for eDocBuilder. Requires InDesign Creative Cloud 2014 on Windows 64 bit systems.
 
Windows InDesign CC 2014 (32-bit systems)
  Click here to download the InDesign plug-in for eDocBuilder. Requires InDesign Creative Cloud 2014 on Windows 32-bit systems.
 
Windows InDesign CC (64-bit systems)
  Click here to download the InDesign plug-in for eDocBuilder. Requires InDesign Creative Cloud on Windows 64 bit systems.
 
Windows InDesign CC (32-bit systems)
  Click here to download the InDesign plug-in for eDocBuilder. Requires InDesign Creative Cloud on Windows 32-bit systems.
 
Windows InDesign CS6  Version (all Windows systems)
  Click here to download the InDesign plug-in for eDocBuilder. Requires InDesign CS6 on all Windows systems.
 
See the Configuration section below after downloading the version of the plugin for your version of InDesign.
 
 
Macintosh Downloads
 
Mac InDesign CC 2019 Version
  Click here to download the InDesign CC 2019 plug-in for eDocBuilder. Requires OSX (Mac) systems and InDesign CC 2019.
 
Mac InDesign CC 2018 Version
  Click here to download the InDesign CC 2018 plug-in for eDocBuilder. Requires OSX (Mac) systems and InDesign CC 2018.
 
Mac InDesign CC 2017 Version
  Click here to download the InDesign CC 2017 plug-in for eDocBuilder. Requires OSX (Mac) systems and InDesign CC 2015.
 
Mac InDesign CC 2015 Version
  Click here to download the InDesign CC 2015 plug-in for eDocBuilder. Requires OSX (Mac) systems and InDesign CC 2015.
 
Mac InDesign CC 2014 Version
  Click here to download the InDesign CC 2014 plug-in for eDocBuilder. Requires OSX (Mac) systems and InDesign CC 2014.
 
Mac InDesign CC Version
  Click here to download the InDesign CC plug-in for eDocBuilder. Requires OSX (Mac) systems and InDesign CC.
 
Mac InDesign CS6 Version
  Click here to download the InDesign CS6 plug-in for eDocBuilder. Requires OSX (Mac) systems and InDesign CS6.
 
See the Configuration section below after downloading the version of the plugin for your version of InDesign.
 
 
Configuration
 

The eDocBuilder Plug-in for Adobe InDesign can be installed by getting the download for your version of InDesign, and installing the files from the download into your InDesign Plug-ins folder. Some common issues involving installing the files from the download, if InDesign is saving preferences and settings, and generally working as expected, are detailed below.

1) Make sure InDesign is not running, and have the download for your installation of InDesign available before continuing with the steps below. Unzip or extract the downloaded file, which should create a new folder. The new folder can be placed into the /Plug-ins folder for your version of InDesign. The location of the plug-ins folder depends on your version of InDesign and could be different for any computer or operating system.

2) The eDocBuilder plug-in for InDesign does require all of its associated files and folders to be installed completely. This includes the plug-in files for eDocBuilder and BasicPersistentInterface, and their respective folders and contents, from the downloaded archive file. All of the folders and files in the download, as shown below, comprise the eDocBuilder plug-in.


 
3) The plug-ins need to be installed into the /Plug-Ins directory for your version of InDesign. This location could be different on any computer depending on the operating system and version of InDesign installed.

 
4) The plug-in can be installed in a subfolder in the /Plug-Ins folder. You can create an eDocBuilder folder in /Plug-Ins and copy all the files and folders from the download archive and paste into that folder.

 
5) When the plug-in is first loaded and InDesign is launched, the plug-in will try to create the file EDOCBUILDER.cfg in the directory containing the plug-in. If the permissions for the user account running InDesign do not allow that account to modify or create a file in that directory, you may see an error when InDesign starts up or when attempting to use the plug-in; it will also not save the plug-in preferences details.

6) Preferences for the eDocBuilder plug-in are available from menu commands Edit > Preferences > eDocBuilder once the plug-in is loaded in InDesign.
 
7) You should be able to load the plug-in into the directory folders, start InDesign, go to menu commands Edit > Preferences > eDocBuilder, and enter your eDocBuilder master account credentials. Note that these MUST be the credentials for your master eDocBuilder account that were provided in your welcome email when you signed up for the eDocBuilder service. It has to be the master eDocBuilder account credentials; it cannot be a user you created in your eDocBuilder account.
 
8) For the Server setting, the server address will depend upon the web address that you use to log into eDocBuilder.
If you login at creator.edocbuilder.com then use: http://engine.edocbuilder.com
If you login at creator-sg.edocbuilder.com then use: http://engine-sg.edocbuilder.com
If you login at creator-ams.edocbuilder.com then use: http://engine-ams.edocbuilder.com
 
9) If you restart InDesign after entering your account credentials, your preference settings should be saved and will be available after you restart InDesign. Try restarting InDesign and re-opening the preferences window to make sure it is saving your preferences as expected. Note that the preferences window does display the version of the plug-in that you have loaded, as well as the version of InDesign you are running.

 
10) If it is not saving the preferences that you entered when InDesign restarts, and you are on Windows, you can try enabling InDesign to run as an administrator. Go to the application program icon and use the right-click context menu to access Properties for InDesign.exe. Set Run as Administrator and try launching the application again.

 
 
11) On a Mac, the plug-in expects to be placed in a folder named eDocBuilder inside of the InDesign Plug-Ins folder. For example, a folder such as /Applications/Adobe InDesign CC 2019/Plug-Ins/eDocBuilder/, depending on the version of InDesign installed. If the plug-in does not have adequate permissions to read and write to the configuration file, then your preference settings from Preferences > eDocBuilder may not be getting saved when testing the plug-in and restarting InDesign. You may need to make some manual adjustments to the folders in Plug-Ins, in your InDesign application folder. Quit out of the InDesign application when making these folder changes, or restart InDesign once these changes are made.
 
You can manually create an eDocBuilder folder in the Plug-Ins folder, and manually create a text file called EDOCBUILDER.cfg in that same folder if these folders and file are not being created when running the eDocBuilder plug-in in your copy of InDesign. Then right-click on the /Plug-Ins/eDocBuilder folder, choose Get Info, and look at the Permissions settings. Add your user and set permissions to Read & Write, so that your user has access to the /Plug-Ins/eDocBuilder/ to Read and Write to the EDOCBUILDER.cfg file.
 
12) It is important to understand that features in InDesign that do not also exist in eDocBuilder will not work. As an example, you can not create tables in an eDocBuilder template so if you have a table in your InDesign file, it will not be able to import and you will receive an error. Make sure your InDesign file is set up considering eDocBuilder and the features that eDocBuilder supports. For some considerations when preparing documents for use with eDocBuilder, please see the article Tips, Tricks and Warnings for using the InDesign Plugin.
 
13) Once the plug-in is installed and saving your preferences, try creating a new, blank document with one text field. Open the palette from menu command Window > eDocBuilder, select the text field with the item tool and give that field name and prompt values.

 
14) The area of the selected text box on the InDesign document will become a field in the eDocBuilder template when uploaded. Remember that field names must be alphabetical characters only (A-Z or a-z). Numbers or special characters cannot be used. Names may not contain spaces. No duplicate names are allowed; all field names must be unique.
 
15) Once you have your test document created, you can upload that to eDocBuilder by going to the flyout menu at the upper-right corner of the palette and choosing Upload Template.
 
16) Give the new template a name and choose the Template Type the uploaded document will become.
 
17) If the plug-in is working as expected, you will see a progress bar and messages relating to uploading the template, and then it will confirm if the template has been created successfully.
18) Now you can log into eDocBuilder admin and continue editing and testing your template online. Once a document has been uploaded to eDocBuilder, it will require some adjustments to the field settings. For example, the Force-Fit option will be enabled for new fields on the Format tab under Field Setup. You may wish to disable that on the fields if you do not want to see the text inside of those fields changing in font size and spacing.
 
19) Once a document has been uploaded to an eDocBuilder template, that document contains information that relates it to that specific eDocBuilder template in your account. That relationship will be saved when the InDesign document is saved. That relationship can only be broken by using the Upload as New command from the eDocBuilder palette flyout menu. You may wish to save a version of any of your live documents, prior to uploading a document to eDocBuilder.
 
20) To make good use of your time using the eDocBuilder Plug-in for InDesign, please review all of the points on the tips and tricks article. eDocBuilder and InDesign are very different environments, with very different capabilities, so there are differences and considerations. To understand some basic considerations, review the points on the following article Tips, Tricks and Warnings for using the InDesign Plugin.
 
Support
 
If you are having any trouble with installation or operation of the eDocBuilder plug-in for Adobe InDesign, please open a new ticket to us at support.aleyant.com.