Ch. 036 InDesign Plug-in for eDocBuilder

EDOCBUILDER > eDocBuilder Documentation Manual & Videos

InDesign Plug-In for eDocBuilder

eDocBuilder subscriptions include a convenient InDesign plug-in. 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. This plug-in enables you to configure many of your eDocBuilder template's settings directly in InDesign. After creating 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.
 
The current version of the plugin for most operating systems is 1.2.0, and it was released on 3 March, 2017.  
The current version of the plugin for Mac CC, CC 2014 and CC 2015 is 1.2.3, and it was released on 21 April, 2017.  
If you experience any problems with the InDesign plugin, please report the problem to us by opening a support ticket. 
 
1.2.0 and 1.2.3 are compatible with InDesign CC 2014, 2015 and 2017, which are new versions of the application that have been recently released. Please make sure you download the correct version of the plugin to match your version of InDesign.
 
Important: the configuration screen for the plugin has been simplified, and now also displays what version of the plugin you are using. See "Configuring the Plugin" below.
 
 
See a brief video about using the plug-in: eDocBuilder InDesign Plugin Instructions.
Note: this video is somewhat out of date. There is no longer a need to manually edit the .cfg file. See "Configuring the plugin" below.
 
Select the appropriate plug-in version based on your operating system to access installation instructions and download the plug-in:
 

 Mac Installation Instructions

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.
 
  1. Make sure InDesign is not running.
  2. Download the plug-in file (above).
  3. Move the plug-in into the InDesign plug-ins folder. The plug-ins folder is most likely "Macintosh HD\Applications\Adobe InDesign CS6\Plug-Ins"; however, it may be different on your computer. Double-click the DMG file to mount it on your system. A window will open. Then drag the content from this window into the InDesign plug-ins folder.
  4. See "Configuring the plugin" section below.

Windows Installation Instructions

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.
  1. Make sure InDesign is not running.

     
  2. Unzip the plug-in into the InDesign plug-ins folder. The plug-ins folder depends on your version:
    Version folder name
    CS6 C:\Program Files (x86)\Adobe\Adobe InDesign CS6\Plug-Ins
    CC (32 bit) C:\Program Files (x86)\Adobe\Adobe InDesign CC\Plug-Ins
    CC (64 bit) C:\Program Files\Adobe\Adobe InDesign CC\Plug-Ins
    CC 2014 (32 bit) C:\Program Files (x86)\Adobe\Adobe InDesign CC 2014\Plug-Ins
    CC 2014 (64 bit) C:\Program Files\Adobe\Adobe InDesign CC 2014\Plug-Ins
    CC 2015 (32 bit) C:\Program Files (x86)\Adobe\Adobe InDesign CC 2015\Plug-Ins
    CC 2015 (64 bit) C:\Program Files\Adobe\Adobe InDesign CC 2015\Plug-Ins
    CC 2017 (32 bit) C:\Program Files (x86)\Adobe\Adobe InDesign CC 2017\Plug-Ins
    CC 2017 (64 bit) C:\Program Files\Adobe\Adobe InDesign CC 2017\Plug-Ins
    However, it may be different on your computer. Unzipping the plug-in should result in a new eDocBuilder folder being created.

     
  3. When the plugin is first loaded and InDesign is launched, the plugin will try to create a file EDOCBUILDER.cfg in the directory containing the pluging. If the permissions for the Windows user account assigned to InDesign do not allow it to modify or create a file in that directory, you may see an error when InDesign starts up or when attempting to use the plugin, it will also not save the plugin preference configuration details. To correct this, find InDesign.exe in the installation directory for the application, right-click for context menu, go to Properties, then to Compatibility, check Run as Administrator and Apply the settings.


     
  4. See "Configuring the plugin" section below.
 

Configuring the Plugin

  1. Start InDesign and begin a document.
  2. Next, we need to configure the plug-in by adding some connection information (Mac screenshot for illustration only). To do this, go to the InDesign > Preferences > eDocBuilder menu, and the eDocBuilder Preferences should be presented.
        
  3. In Preferences you will enter your eDocBuilder Admin connection information:. 
     - For Server, the server address will depend upon the url that you use to log into eDoc admin.  If you log into eDoc admin at:
    creator.edocbuilder.com then use http://engine.edocbuilder.com
    creator-sg.edocbuilder.com then use http://engine-sg.edocbuilder.com

    - For User, enter either the email address or username you use to login to eDocBuilder.  **Please note that this MUST be the credentials for your master eDocBuilder account that was provided in your welcome email when you signed up for the eDocBuilder system.

    - For Pass enter your eDocBuilder password.  **Please note that this MUST be the credentials for your master eDocBuilder account that was provided in your welcome email when you signed up for the eDocBuilder system.
    - Note that the version of the plugin that you are using is displayed on this Preferences page.
    .

Using the Plug-In

 We strongly recommend creating and testing a single page document with one text field as a test before progressing to a more involved template. Creating something more involved could be frustrating if you later discover you are doing it wrong and it all needs to be corrected.  Please note - do NOT set a bleed in your InDesign file.  This will cause issues with the field placement after importing into eDocBuilder.  Please use the bleed setting in eDocBuilder instead. It is also 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 it supports. 
  1. Let's make sure that the eDocBuilder window is showing within your tool bars by going to the "Window" menu and adding a check mark next to "eDocBuilder", after that is done you should see this.
        
  2. To prepare the document for eDocBuilder, you will be tagging the text and image areas your customer will be able to change. With the eDocBuilder window open (as above) select a text or image area frame using the arrow Selection tool. The controls on the eDocBuilder palette will activate.


     
  3. This frame area will become a field on the resulting eDocBuilder Master PDF. Select the Type of field (See Chapter 12, 13, and 14) Enter the Name and Prompt you want for this field.
    Remember, just like Chapter 4 says, 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
    The Prompt is whatever label you want the user to see for this field input. For example, "Name", or "Title", or "Phone", or "Your Photo", etc. (See Chapter 11)

     
  4. After tagging text or image frames in your new InDesign document, send the template to the eDocBuilder admin server. Use the eDocBuilder tab menu drop down to name your template, choose a Template Type and click OK to upload. Use the Knowledge Base for details on Stacking Groups.
        
       
  5. Once InDesign has finished uploading your template, you should see:
        
  6. Now you can log into eDocBuilder admin at http://creator.edocbuilder.com and continue editing and testing your template online.
 
 If you experience any problems with the InDesign plugin, please report the problem to us by opening a support ticket.