Skip to main content

Workbooks
  • Knowledge Base
  • Customer Forum
  • Training
  • Support Portal
  • Support Processes
Login
  1. Home
  2. Support
  3. Knowledge Base
  4. Knowledge base
  5. Integrations
  6. Electronic Signing Tools
  7. Docusign Integration
  8. Setting up the DocuSign Integration
  9. Form Layout Configuration
Support

Knowledge Base

Browse our knowledge base articles to quickly solve your issue.

  1. Home
  2. Support
  3. Knowledge Base
  4. Knowledge base
  5. Integrations
  6. Electronic Signing Tools
  7. Docusign Integration
  8. Setting up the DocuSign Integration
  9. Form Layout Configuration
  • Welcome to the Knowledge Base
  • Introduction
    • Using the Knowledge Base
    • Editions & Licensing
      • Renewing Licences
    • Workflow
      • Queues
    • Logging In
      • Configuring Security Policies
      • Google Authentication
      • Login Protection
      • Microsoft Azure Active Directory
        • Link Workbooks to Microsoft Azure
        • Setting up User Templates
        • Locking down your Workbooks
    • Support Processes
  • Training
    • Training Videos
    • Training Courses
  • Getting Started
    • Supported browsers
    • Introduction
    • Desktop
      • Tips & Tricks on the Desktop
      • Welcome Messages & Bulletins
    • Records
      • External Links to Workbooks records
      • Tabs
        • Default Tab Views
        • Summary Timeline View
        • Overview Tab
      • Watching Records
      • Notes
    • Landing Pages
      • Bulk Actions
        • Scheduled Bulk Actions
      • Customising Views
        • Customising Columns
        • Filtering
          • Custom Filters
        • Calendar Views
        • Card View
          • Report Card View
          • Worked Examples of Card Views
      • Deleted Items
      • Edit Grids
      • Exporting Data
      • Exporting to MS Excel
    • Workbooks on Mobiles and Tablets
  • Preferences
    • Introduction to Preferences
    • Setting your Preferences
      • Email Accounts
      • Notifications & Reminders
  • Activities
    • Introduction to Activities
    • Using Activities
      • Meetings
        • Integrating Workbooks and Google Calendar
          • Installing and Managing Workbooks and Google Calendar Integration
          • Synchronising your Google Calendar with Workbooks
      • Follow-on Activities
  • Cases
    • Introduction to Cases
    • Displaying & Adding Cases
    • Managing Cases
    • Case Portal
      • Installation
        • Custom Fields
        • Case Portal Configuration
          • Company Details
          • General
            • Case Portal Reports
          • New Case
          • Help Text
          • Emails
          • Advanced Features
          • Field Mappings
          • Help Dialog
          • Product Area Questions
        • Case Portal Additional Features
          • Setting up Public/Private Activity creation
          • Setup Registration Emails from a Person
          • Automatic Emails on Case Status Change
      • Using the Case Portal
        • Case Updates - Public & Private Activities
        • Inviting a Person to the Case Portal
  • Email
    • Introduction to Email
    • Working With Emails
    • Email Signatures
    • Sending Bulk Email
    • Common Email Errors
    • Email Integrations
    • Mailing Lists
  • Forecasts & Quotas
    • Introduction to Forecasts & Quotas
    • Sales Forecasts
      • Adjusting Forecasts
      • Included Forecasts
    • Sales Quotas
  • Importing Data
    • Introduction to Importing
    • Preparing your Import Data
      • Import Templates
      • Compulsory fields for Import
    • Workbooks Import Wizard
      • Uploading your data
      • Defining Field Mappings
      • Extending your Import to other Record types
      • Checking for Duplicates
      • Running and Reviewing your Import
    • Managing your Imports
      • Undoing an Import
  • Leads
    • Introduction to Leads
    • Displaying & Adding Leads
    • Converting Leads
  • Marketing
    • Introduction to Marketing
    • Marketing Campaigns
      • Displaying & Adding Campaigns
      • Campaign Management
      • Campaign Membership
      • Tracking URLs on Campaigns
      • Integrating DotDigital and Workbooks
        • Configuring Workbooks and Dotmailer
      • Integrating MailChimp and Workbooks
        • Configuring Workbooks and MailChimp
    • Mailing Lists
      • Creating Mailing Lists
    • Products
      • Pricing Schemes
      • Supply Scheme
      • Product Bundles
    • Mailshots
      • Creating a Mailshot
    • Upload Library
      • Using the Upload Library
    • Templates
      • Creating Templates
      • Creating a Template to show multiple lines
      • Extra Template Placeholders
    • Using HubSpot with Workbooks
    • Event Management
      • Introduction to Event Management
      • Enabling the Event Management Module
      • Using Event Records
        • Event Records
        • Event Sessions
        • Event Speakers
        • Event Sponsors
        • Event Products
        • Event Tickets
        • Event Attendees
      • The Event Management Portal
        • Introduction to the Event Management Portal
        • Prerequisites for installation
        • Accessing the Plugin
        • Installing the Event Management Portal
        • Amending Event Portal Parameters
        • Adding Custom CSS to the Event Portal
      • On The Day Registration App
      • Setup On the Day Registration App
    • Compliance Records
      • Introduction to Compliance Records
      • Enabling Compliance Records
      • Creating Compliance Records
      • Using Compliance Records
    • Spotler Integration
      • What is Spotler?
      • Navigating your Spotler homepage
      • GatorMail
        • Introduction to GatorMail
        • Managing your GatorMail Account
          • Domain Setup
        • GatorMail Configuration
          • GatorMail Field Mappings
            • GatorMail Hard Bounces
          • Preference Centres & Landing Pages
            • Preference Centre Setup
        • Creating Emails in GatorMail
          • Imbedding Images and Videos
        • Sending Emails in GatorMail
          • Sending GatorMail Campaigns
            • Campaign Action Types
            • Ramp-up
            • Testing Campaigns and Emails
          • Using SendForensics
          • Understanding your Campaign results
        • Advanced Features
          • Gator Smart Forms
          • GatorMail - Dynamic Content
      • GatorLeads / Web Insights
        • Tracking Code
          • Restricting Page Tracking
        • Setting up the Plugin
        • Viewing Web Insights Data on your Form Layouts
        • Domain Names and Online Activities
        • Reporting incorrect Leads created through Web Insights
        • Reporting on Web Insights data
        • Using UTM Values
        • Why aren’t Online Activities being created in the database?
        • Why is GatorLeads recording online activities in a foreign language?
      • GatorSurvey
      • GatorWorkflow
        • Spotler Data Sync
        • Triggered Mailshots
      • GatorPopup
  • Opportunities
    • Introduction to Opportunities
    • Displaying & Adding Opportunities
    • Opportunity Line Items
    • Opportunity Relationships
  • Integrations
    • Mapping
      • Introduction to the Mapping Module
      • Using the Mapping Module
      • Using Mapping in Reports
        • Changing the size/colour of Map Pins
    • Electronic Signing Tools
      • Docusign Integration
        • DocuSign Functionality
          • Copy Document on Signature
          • Update Related Records
          • Sending Multiple Documents
          • People, Organisations & Cases with DocuSign
          • Invoice Payments with DocuSign
          • Managing DocuSign Documents
        • Setting up the DocuSign Integration
          • Authentication with DocuSign
          • Production vs Sandbox
          • Creating a Document with a DocuSign Template
          • Creating a Document with a Workbooks PDF
          • DocuSign Fields
          • DocuSign Settings
          • Form Layout Configuration
        • DocuSign - Worked Examples
          • Taking Payments
          • Updating Related Records
          • Multiple Document Sends
          • Creating a Template for Cases
          • Creating a Template for Organisations
          • Creating a Template for People
          • Unified PDF for Transaction Documents
        • DocuSign - Reporting
          • Multiple Send Report Grid
          • Document Review Report
          • Monitoring Integration Errors
      • Adobe Sign Integration
        • Introduction to Adobe Sign
        • Authentication with Adobe Sign
        • Installing the Integration
        • Integration Monitoring & Error Handling
        • Setup of Adobe Sign
        • Adobe Sign Fields & Form Layout Configuration
        • Optional Custom Fields for Adobe Sign
        • Adobe Sign Button Process
        • Using the Adobe Sign Integration
    • Creditsafe Integration
      • Installing the Creditsafe Plugin
      • Configuring Organisations to use the Creditsafe Integration
      • An example of how to use the Creditsafe Integration
    • Zapier
      • Introduction to Zapier
      • Available Triggers and Actions
      • Linking your Workbooks Account to Zapier
      • Setting up Zaps
        • Posted Invoices to Xero Invoices
        • Xero payments to Workbooks Tasks
        • New Case to Google Drive folder
        • New Case to Basecamp Project
        • New Workbooks Case to JIRA Ticket
        • Jira Issue to new Case
        • 123FormBuilder Form Entry to Case
        • Eventbrite Attendee to Sales Lead and Task
        • Facebook Ad Leads to Sales Leads
        • Wufoo Form Entry to Sales Lead
        • Posted Credit Note to Task
        • QuickBooks Online
          • Initial Setup
            • Authentication with QuickBooks Online
          • People & Organisations to QuickBooks Customers
          • POSTED Workbooks Invoice to QuickBooks Online
          • QuickBooks Online Payment to Workbooks Invoice & Task
          • QuickBooks Sales Tax Code Lookup
        • Survey Monkey responses to Tasks
      • Multistep Zaps
    • Email Integrations
      • Email Dropbox
        • Setting up your Dropbox
        • Using your Dropbox
      • Workbooks Exchange Server Sync
        • Supported email clients
        • Set Up
          • Setting up the WESS
          • Setting up the Outlook Add-In
          • Customising the WESS Add-In
          • How to change Authentication setup for WESS
            • O365 Exchange authentication Troubleshooting
        • What gets synchronised?
          • Synchronising with the WESS
          • Synchronising with the WESS Add-in
          • How to force a sync
          • Best practice
        • WESS Troubleshooting
      • Workbooks Outlook Connector
        • Introduction to the Outlook Connector
        • Before downloading the Outlook Connector
          • System Requirements
          • Enabling the Outlook Connector
        • Download/update the Outlook Connector
        • Installing the Outlook Connector
          • Uninstalling the Outlook Connector
        • Using the Outlook Connector
          • Configuring the Outlook Connector's Settings
          • Identifying Records in Workbooks created in Outlook
        • Outlook Connector Troubleshooting
    • Event & Webinar Integration Tools
      • GoToWebinar
        • Installation
          • GoToWebinar Fields & Processes
          • Setting up Process Buttons for GoToWebinar
        • Authentication
          • Multiple GoToWebinar Accounts
          • Removing GoToWebinar Accounts
        • Create/Update & Cancel Webinars from Events
        • Event Attendees as Webinar Registrants
        • Event Speakers as Webinar Panelists
        • Retrieve Webinar Data
      • ON24
        • Installation
          • ON24 Fields & Processes
          • Setting Up Process Buttons for ON24
        • Authentication with ON24
          • Removing ON24 Accounts
        • Create Webcasts from Events
        • Event Attendees as Webcast Registrants
        • Retrieve Webcast Data
          • Reporting: Survey Responses
          • Reporting: Poll Responses
        • Retrieve Survey Data
        • Engagement Hub Interactions
    • Microsoft Office
      • Azure Active Directory
      • Excel
      • Outlook
      • Power BI
      • SharePoint
        • Authentication
        • Installation
          • Custom Fields & Processes
          • SharePoint Integration Settings
        • Using the SharePoint Integration
      • Word
        • Introduction to the Word Add-in
        • Deploying the Word Add-in
        • Creating Word Add-in Templates
          • Example Word Add-in Templates
        • Using Word Add-in Templates
        • Word Add-in Tips and Tricks
    • Outreach
      • Installation
        • Outreach Fields & Processes
        • Create Outreach Custom Field Mappings
          • Configure Outreach Field Dynamic Picklist
        • Sync Outreach Mappings
      • Outreach Authentication
        • Remove Outreach Account
      • Sync People to Outreach Prospects
        • People Field Mappings
      • Sync Organisations to Outreach Accounts
        • Organisation Field Mappings
      • Sync Workbooks Opportunities to Outreach
        • Opportunity Field Mappings
      • Sync Tasks/Activities from Workbooks to Outreach
        • Follow-Up Activities created via Scheduled Process
      • Sync Outreach Sequences to Workbooks
      • Sync Outreach Sequence States to Workbooks
      • Sync Outreach Sequence Step Numbers to Workbooks
      • Sync Prospects/Accounts/Opportunities from Outreach to Workbooks
      • Sync Outreach Tasks/Calls/Meetings to Workbooks
    • Scribe/Workbooks Connector
      • Connection Setup
        • Microsoft SQL Server Connection Requirements
      • Connector Control Blocks
      • Worked Example - Create, Read, Update & Delete
    • RingCentral
      • Installation
        • RingCentral Integration Fields and Processes
      • RingCentral Authentication
        • Remove RingCentral Account
      • Creating Phone Call Activities
      • Click to Dial
  • People & Organisations
    • Introduction to People & Organisations
    • Organisations
      • Displaying & Adding Organisations
      • Customers & Suppliers
    • People
      • Displaying & Adding People
      • Adding People to Outlook
    • Relationships
      • Change Employer Wizard
      • Direct Relationships
      • Third Party Relationships
    • De-duplication and Merge
      • Workbooks Merging
      • Workbooks DQ
      • Data Quality
    • Using Postcode Lookup
    • Data Enrichment
      • Introduction to Data Enrichment
      • Setting up Data Enrichment
  • Snippets
  • Reporting
    • Introduction to Reporting
      • Creating Reports
        • Standard Workbooks Reports
        • Creating a Pre-populated Report
        • Creating a Report from a Template
          • Report Templates
        • Creating a Blank Report
        • Auto-refreshing Report Views
      • Sharing Reports
    • Using Reports
      • Reporting Explained
        • Adding Targets, Conditional Formatting and CSS Styling
          • Calculated Targets
          • Target Sets
            • Creating a Target set for Closed Cases per Customer Support Agent
            • Creating a Target set for Closed Sales amount per Sales Person by quarter
        • Reporting with multiple currencies
        • Drilling into Summary Views
        • Improving Report Performance & Run Time
      • Displaying reports within Record Views
      • Displaying Reports
        • Reporting Views (Reports on Landing Pages)
      • Adding a Report view to a Dashboard
    • Charts
      • Creating & Using Charts
        • Bar Charts
          • Targets on Bar Charts
        • Line Charts
        • Pie Charts
        • Dial Charts
    • Exporting Reports
      • Emailing Scheduled Reports
    • Advanced Reporting
      • Types of Split Columns
      • Using Calculated Columns
        • Introduction to the IF Statement
        • Introduction to the CASE Statement
        • Applying Search filters in Calculated Columns
        • Comments in Calculated Columns
        • Financial Year Reporting
        • Introduction to Date Functions in Reports
        • Using Calculated Criteria
        • Reporting on empty fields
      • Audit Reporting
  • Dashboards
    • Adding Elements to Dashboards
      • Configuring Dashboard Elements
    • Dashboard Views
    • Dashboard Fields
    • Creating a Sales Dashboard
    • Springboard
    • Adding a Dashboard as a Record Tab
  • Okta Authentication
  • Transaction Documents
    • Introduction to Transaction Documents
      • Displaying & Adding Transaction Documents
      • Copying Transaction Documents
      • Transaction Documents Fields Help
      • Transaction Documents Line Items Help
      • Printing & Sending Transaction Documents
      • Managing Transaction Document Currencies
      • Managing Transaction Document Statuses
      • Setting a Blank Default Currency on Transaction Documents
    • Credit Notes
    • Customer Orders
    • Invoices
    • Quotations
    • Supplier Orders
    • Contract Management
      • Displaying & Adding Contracts
      • Using Contracts with Cases
    • Sagelink
  • Auditing
    • Auditing
  • Configuration
    • Introduction to System Administration
      • Quick Start Wizard
    • Users & Security
      • Users
        • Setting up your Users
        • Disabling Users
        • Profile Pictures
      • User Groups
        • Capabilities
        • Creating & Modifying User Groups
      • Permissions
        • Sharing Policies & Mandatory Permissions
          • Configuring the Advanced Security Module
            • Configuring the Advanced Security Module: Segmenting Users by function
            • Configuring the Advanced Security Module: Segmenting Users by location
      • Account Settings
      • Licences & Modules
        • Multi Language
    • Database
      • Databases
      • Storage Usage
      • Prefixes & Numbering
        • Modifying Object References
      • Export Database
      • Database Settings
    • Accounting
      • Accounting Periods
      • Exchange Rates
        • Setting Exchange Rates
      • Tax Regimes
        • Setting Tax Rates
        • Sales Tax Rulesets
          • Using Sales Tax Rulesets
      • Own Organisations
        • Setting up your Own Organisation
    • Email & Integration
      • Email Settings
        • Setting up your Email Server
        • Using Workbooks Server to send Emails
      • API Keys
      • Web to Case and Web to Lead
        • Setting up a Web2Case Form
        • Setting up a Web2Lead Form
        • Using Web Forms in Workbooks
        • Editing a Web Key Form
      • Preference Centre
      • MailChimp & dotMailer
      • Loqate
      • Bank Account Validation
    • Customisation
      • Creating & Modifying Picklists
      • Desktop Preferences
      • Theme
      • Record Types
        • Creating Custom Fields
          • Dynamic Linked Items & Picklists
          • Constrained Dynamic Linked Items (DLI) & Picklists
          • Creating relationships with Dynamic Linked Items (DLIs)
          • Linking Custom Field Values
          • Showing Linked Records in Tabs
        • Report-based Custom Fields
          • Improving the Performance of Report Cells/Grids
        • Linked Fields & Reference Fields
        • Record Templates
        • Form Layouts
          • Customising an Organisation form
          • Displaying a Tab as a Side Panel
          • Card View
          • Read-only Assigned to Fields
        • Customising relationships between parties
          • Configuring Custom Party Relationships
        • Opportunity Stages
      • Custom Records
        • Enabling Custom Records
        • Creating Custom Record Types
          • Editing Custom Record Types
        • Using Custom Records
    • Automation
      • Plugins
        • Field Updater Plugin
        • File Storage Plugin
          • Using File Storage
          • Using SharePoint File Storage
        • Cognism Enrich Plugin
          • Using Cognism Enrich
        • Email to Case Plugin and Process
      • Processes
        • Process Logging
      • Workbooks Scripts
        • Script Library
        • How Workbooks Runs Scripts
        • Workbooks Script External Access
      • API Data
      • Triggers and Webhooks
        • Configuring Triggers and Webhooks
    • PDF Configuration
      • Modifying Document Templates
        • Adding Terms & Conditions to your Documents
        • Multi-line Value Tags
      • Modifying Default Colours & Images
      • Creating Custom Document Templates
  • Contact Support
    • Contacting Workbooks Support
    • Workbooks CRM Advisory Packs
    • Introduction to the Administrator Service
  • Releases & Roadmap
    • Roadmap
    • September 2022 Release
    • June 2022 Release
    • March 2022 Release
    • October 2021 Release
    • June 2021 Release
    • March 2021 Release
    • 2020 Releases
      • December 2020 Release
      • September 2020 Release
      • April 2020 Release
      • January 2020 Release
    • 2019 Releases
      • September 2019 Release
      • February 2019 - Event Management Release
      • January 2019 Release
    • 2018 Releases
      • October 2018 Release
      • May 2018 Release
      • February 2018 Release
      • January 2018 Release
    • 2017 Releases
      • November 2017 Release
      • September 2017 Release
      • June 2017 Release
      • March 2017 Release
    • 2016 Releases
      • December 2016 Release
      • August 2016 Release
      • January 2016 Release
  • Workbooks Glossary

Configuring Form Layouts for DocuSign

Once you have configured the DocuSign Plugin, the integration will create the required Custom Fields on the selected record type if they do not already exist. These should be configured on a Form Layout as outlined below, to show the required information for that document. Additionally, the plugin provides you with the Parameters required in order to set up a Button Process used to generate an envelope.

This page guides you through how to setup and configure the Custom Fields and the DocuSign Button Process.

Configuring the Custom Fields

Once a document has been configured, you will be able to access the Custom Fields for each record type from Start > Configuration > Customisation > Record Types, select the appropriate record and then go to the Fields tab. All of the Field Labels will start with  DocuSign so you can apply a filter to find the Fields that were created during installation. All of these Fields are created in the background and are hidden by default, as to not affect your existing Form Layouts.

A complete list of all of the Fields created by the Integration and their purpose for each Record can be found on our here.

dsfl1.png

Navigate to the Form Layout tab and choose which of the Form Layouts you would like to apply these Fields to. You find that you want to create a new Section on the Form Layout called DocuSign so that they can be easily found on the Form.

2018-12-20_19-22-00.jpg

Some fields should be made Read Only as they are integration system fields, this will prevent Users from accidentally overwriting any of the data that is pulled in from DocuSign. We’d advise the following fields are made read-only:

  • DocuSign Status
  • DocuSign Last Action
  • DocuSign Signed Document

Note: Custom Fields should only be made Read Only on the Form Layout, and not on the Custom Field itself. If Custom Fields are set to Read Only at the field level, the integration will be unable to update them, causing a failure.

The DocuSign Envelope ID and DocuSign Envelope URL fields should be left hidden. These fields are again only used to ensure the integration functions correctly and the user does not need visibility of them. If you decide to show these, make them read-only - if a user changes these values, the integration may behave unexpectedly. 

Our recommended layout is shown below:

Once you have configured your Form Layout, ensure that both the DocuSign and Files tab are enabled too.

  • The DocuSign tab is required in order to generate the Envelope in Workbooks before it is sent out to your specified recipient.
  • The Files tab is not required, but recommended as any additional Files created by the DocuSign integration after the signed document, such as the Certificate of Completion or additional supporting documentation, will be added to the Files tab automatically. For example, if you request a copy of personal ID during the signature workflow - this file will be available for viewing on the Files tab once the document is signed.

dsfl3.png

Once configured you will be able to see all necessary DocuSign related information.

Setting up a DocuSign Button Process

Regardless of the integration type that you have chosen, you will need to manually configure a Button Process for each document that you set up in order to generate a DocuSign Envelope for the record and request a signature.

On the final page of the configuration, once the setup is complete, you will see a summary of the document that you have configured including the document name you set, plus some additional parameters that you need to set on your Process Button.

Note: We would recommend not closing this screen as you will need to refer back to this information when setting up the Button Process.

dsfl4.png

This Process will need to be placed separately on each Form Layout that requires it. For example, if you have two Form Layouts, you will need to follow the below process twice, once for each Form Layout. 

From Start > Configuration > Customisation > Record Types select the appropriate Record type and select the Form Layouts tab.

dsfl5.png

Once you have opened the required Form Layout select the Automation tab:

dsfl6.png

On this tab you will see any existing automation that is already configured for this Form Layout. Click New Process Button, which will show a new dialogue box and allow you to configure the new Process.

dsfl7.png

Set the following information on the new Button Process:

  • Button Text: This is what users will see when selecting the Button Process
  • Script Location: Select Script Library in order to use the correct version of the script
  • Script: This should always be set to DocuSign Integration
  • Enable: Check this in order for the Button Process to appear on your form layout
  • Run as: Set this to the Current User so that you can see who sent the document in Audit. However, this User will also require access to the API Data so you will need to ensure that your Permissions are set up accordingly. 
  • Position: Where the Process appears in the list of available Button Processes when the user clicks Run Process from the record
  • Show Confirmation Message: Will inform you when the Process has successfully ran. We’d recommend ticking this box so the user is notified of next steps after they have pressed the button

Once the Process has been named and configured press the Save button. This will show two new tabs, Parameters and Logs. On the Parameter tab, amend the document_name and mode parameters as per the plugin success screen. In addition to this, you may wish to change whether the button should be set to a Production or Sandbox environment by configuring the "sandbox_mode" parameter as well. See here for further information.

Note: Without these Parameters set the DocuSign Process will fail!

dsfl8.png

dsfl9.png

Once all parameters have been set, Save & Close the Button Process, and the Form Layout. You can now access the Button Process from any document’s Main tab that is using the specified Form Layout.

dsfl10.png

  • DocuSign Settings
  • DocuSign - Worked Examples

© 2023 Workbooks.com - privacy & terms
  • Linkedin
  • Twitter
  • Youtube
  • Facebook