- Welcome to the Knowledge Base
- Supported browsers
- Landing Pages
- Workbooks on Mobiles and Tablets
- Introduction to Cases
- Displaying & Adding Cases
- Managing Cases
- Custom Fields
- Case Portal Configuration
- Case Portal Additional Features
- Using the Case Portal
- Forecasts & Quotas
- Introduction to Importing
- Preparing your Import Data
- Workbooks Import Wizard
- Managing your Imports
- Introduction to Marketing
- Marketing Campaigns
- Mailing Lists
- Upload Library
- Using HubSpot with Workbooks
- Introduction to Event Management
- Enabling the Event Management Module
- Using Event Records
- The Event Management Portal
- On The Day Registration App
- Setup On the Day Registration App
- Compliance Records
- What is Spotler?
- Navigating your Spotler homepage
- Introduction to GatorMail
- Managing your GatorMail Account
- GatorMail Configuration
- Creating Emails in GatorMail
- Sending Emails in GatorMail
- Advanced Features
GatorLeads / Web Insights
- Tracking Code
- 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?
Electronic Signing Tools
- DocuSign Functionality
- Setting up the DocuSign Integration
- DocuSign - Worked Examples
- DocuSign - Reporting
- Adobe Sign Integration
- Docusign Integration
- Creditsafe Integration
- 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
- Survey Monkey responses to Tasks
- Multistep Zaps
- Email Dropbox
Workbooks Exchange Server Sync
- Supported email clients
- Set Up
- What gets synchronised?
- WESS Troubleshooting
Workbooks Outlook Connector
- Introduction to the Outlook Connector
- Before downloading the Outlook Connector
- Download/update the Outlook Connector
- Installing the Outlook Connector
- Using the Outlook Connector
- Outlook Connector Troubleshooting
Event & Webinar Integration Tools
- Create/Update & Cancel Webinars from Events
- Event Attendees as Webinar Registrants
- Event Speakers as Webinar Panelists
- Retrieve Webinar Data
- Authentication with ON24
- Create Webcasts from Events
- Event Attendees as Webcast Registrants
- Retrieve Webcast Data
- Retrieve Survey Data
- Engagement Hub Interactions
- Azure Active Directory
- Power BI
- Outreach Authentication
- Sync People to Outreach Prospects
- Sync Organisations to Outreach Accounts
- Sync Workbooks Opportunities to Outreach
- Sync Tasks/Activities from Workbooks to Outreach
- 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
People & Organisations
- Introduction to People & Organisations
- De-duplication and Merge
- Using Postcode Lookup
- Data Enrichment
- Introduction to Reporting
- Adding Targets, Conditional Formatting and CSS Styling
- Reporting with multiple currencies
- Drilling into Summary Views
- Improving Report Performance & Run Time
- Displaying reports within Record Views
- Displaying Reports
- Adding a Report view to a Dashboard
- Reporting Explained
- Exporting Reports
- Types of Split Columns
- Using Calculated Columns
- Audit Reporting
- Okta Authentication
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
- Supplier Orders
- Contract Management
- Introduction to Transaction Documents
- Introduction to System Administration
Users & Security
- User Groups
- Account Settings
- Licences & Modules
- Email & Integration
- Creating & Modifying Picklists
- Desktop Preferences
- Creating Custom Fields
- Report-based Custom Fields
- Linked Fields & Reference Fields
- Record Templates
- Form Layouts
- Customising relationships between parties
- Opportunity Stages
- Custom Records
- Workbooks Scripts
- API Data
- Triggers and Webhooks
- PDF Configuration
- Contact Support
Releases & Roadmap
- September 2022 Release
- June 2022 Release
- March 2022 Release
- October 2021 Release
- June 2021 Release
- March 2021 Release
- 2020 Releases
- 2019 Releases
- 2018 Releases
- 2017 Releases
- 2016 Releases
- Workbooks Glossary
Set up and configuration of the Workbooks Exchange Server Sync (WESS)
NOTE: Basic Authentication for Microsoft Exchange is no longer supported, if you are using Direct Logon method or Microsoft Exchange Impersonation Method of authorisation, you must switch to either Office 365 Oauth or Microsoft 365 Oauth (EWS Api) - Impersonated Logon. Please see here how to switch.
- Purchasing the Exchange Sync licence
- Activating the WESS module
- Setting up the Exchange Sync
- Instructions for IT
- User preferences
The WESS licence must be purchased as an add-on module per user – more information on the pricing of this can be found on our website here, or you can contact our sales team.
Once the licence has been purchased, the corresponding module must be enabled in Workbooks. Go to Start > Configuration > Account Settings > Licences and Modules and navigate to the Modules tab. Tick the checkbox next to ‘Exchange Sync’ and click Save & Close.
After enabling the module on your database, access the Exchange Sync admin panel by going to Start > Configuration > Email & Integration > Exchange Sync. Here you will be presented with a screen asking you if you would like to connect your database to the Exchange Sync Service - click 'Yes' to continue:
The next page will confirm that the connection has been successful, click continue to move on. You will then be presented with your Users tab, which will be empty for now.
You will notice three tabs across the top of the page:
- Users - here you can add, remove, and amend Users' WESS access, and see at a glance what their sync status is.
- Configuration - this is where you control how your Users log into the WESS, set up an Impersonation User, and view your Users' sync statuses.
- Databases - this tab details what databases you have that are configured to access the WESS - having more than one database connected to the WESS is not recommended.
The Users tab displays a list of all Users with an Exchange Sync License, and details whether or not their sync is enabled or disabled, along with a sync status column allowing you to monitor any errors that may occur.
Your first step will be to add Users by clicking on the 'Add Users' button in the top left, which will open a new window showing all of the Users on your database - you can select multiple Users at once in order to assign Exchange Sync licenses en masse.
Once a User has been selected, they will appear in the list on the Users tab and will be greyed out if their sync is disabled. You can remove Users from the WESS by scrolling across to the right of the Users tab and clicking the X button.
Upon loading the Configuration tab, you will be prompted to select your Default Organisation; you will then be presented with a number of sections as shown below:
- Users - this section contains much more detailed information than the aforementioned Users tab, including details of any errors that may have occurred, and if they are initialised or not. We recommend using this section for information only, and making any changes to Users via the main Users tab as previously detailed.
- Statistics - here you can find further information on your WESS Users; how many items were last synced,
- Activity - this contains logs of every change made via the WESS Admin Panel, such as changing how Users access the Exchange Sync.
- Email Configuration - this section is where you will determine how your Users will access the Exchange Sync; the WESS supports four authorisation types, Microsoft Exchange Direct Logon (as of October 22 is depracated), Microsoft Exchange Impersonation (as of October 22 is deprecated) , Office365 OAuth, and Microsoft 365 OAuth Impersonation. More detail on each of these can be found here.
- Customisations - this is the home of your WESS Add-in profiles, where you can create and update existing profiles and apply them to the entire business.
This tab lists the databases you have configured to access the WESS, we recommend only having one database - your Main database - set up to communicate with the Exchange Sync; having multiple databases configured to use the WESS is not recommended.
Here is a summarised checklist of actions/information that are required of your IT Partner/Team in order to setup the WESS. Further details about the contents of this checklist can be found later on within this Knowledge Base page if required:
Exchange Server Details
If you are using either of the Microsoft Exchange login methods, you must obtain your Exchange server details. When using the 'Microsoft Exchange Impersonation' method, you can use your Impersonation User's login details to autodiscover your Exchange Web Services URL. If the autodiscover does not work, you will need to manually obtain your Exchange Web Services URL. If you are running Office365 this is most likely to be: https://outlook.office365.com/EWS/Exchange.asmx.
You must decide if you will go via the Impersonation Route. This may be easier for your organisation as it will reduce users' need to authenticate their accounts.
If you choose to use Impersonation, the Impersonation user needs to be setup by your IT Team, and Users' mailboxes need to be setup to authenticate via the Impersonation User. You will need the Impersonation User Email and Password.
Configure your Exchange Server
If you are running on premise Exchange you will also need to whitelist the following IP address range(s) from any intervening firewalls, mentioned in the ‘Configuring your Exchange Server’ section of this guide:
Multi Factor Authentication
The WESS does support MFA so long as you are using either of the Office365 OAuth methods of login. If you encounter any problems, then anywhere where ‘Password’ is mentioned, use a Microsoft generated ‘App Password’ instead.
Please configure your Exchange Server and any intervening firewalls to accept connections over HTTPS (TCP port 443) from these IP addresses:
- 18.104.22.168 (The sync service, wess.cloudapp.net)
- 22.214.171.124 through 126.96.36.199 (The provisioning system)
New (from January 2021)
- 188.8.131.52/30 (Primary, North Europe location - Ireland)
- 184.108.40.206/30 (Fallback, West Europe location - Netherlands)
- 'Office 365 OAuth' allows users to authenticate themselves directly with Microsoft Office 365 from Workbooks Preferences. This is the preferred method.
- 'Microsoft 365 OAuth (EWS API) - Impersonated logon' enables the Administrator to use Office 365 authentication to configure impersonation for all of the users in the Organization. Users do not need to authenticate themselves via Workbooks Preferences.
NOTE: When using "Domain\Username" format please ensure to use a back-slash, as shown, a forward-slash will not be recognised and will result in a failure to communicate with the Exchange provider.
NOTE: When using either of the OAuth methods, you will not need to locate or enter your EWS URL as this is done automatically through Office365.
Method 1: Automatic detection
Workbooks has the capability of running an automatic detection of the EWS URL built in when using the 'Microsoft Exchange Impersonation' method of auth:
Go to Start > Configuration > Email & Integration > Exchange Sync, on the Configuration tab, select the Email Configuration section and on the dropdown menu, select 'Microsoft Exchange Impersonation'. Enter your Impersonation User's details, and click the magic wand icon in the EWS URL field.
If the Automatic detection was successful then this means that the Exchange credentials entered were valid for Exchange validation. If not, you may see one of the following errors;
- AutoDiscoverFailed - The autodiscover service did not manage to obtain Exchange Web Service URL. If this occurs we recommend using Method 2 (Manual Configuration) as opposed to autodiscovery.
- Unauthorized - Either the Username or Password is invalid.
- ErrorNonExistentMailbox - The email address provided is invalid.
Method 2: Manual Configuration
Go to Start > Configuration > Email & Integration > Exchange Sync, on the Configuration tab, select the Email Configuration section and on the dropdown menu, select 'Microsoft Exchange Direct Logon'.
You will then be prompted to input your company specific ‘Exchange Web Services URL’. This will only need to be entered once and should only be changed under special circumstances. If the value presented is not the correct format an error will appear.
The IT department at your company should know this information. If this is not the case, and you have auto-discovery set up then you can go to https://testconnectivity.microsoft.com/ and select ‘Outlook Autodiscover’. You should look for the value “EwsUrl” in the results you are provided with.
The URL you need will look similar to https://your.domain.name/EWS/Exchange.asmx.
Microsoft have a support article containing detailed information on Impersonation and how to configure this. The basic premise behind it is that an Impersonation user will control all of your User’s emails yet send them as if they have been sent from the mailbox owner. This is ideal for applications that connect to Exchange such as Workbooks as this one Impersonation User handles all emails, with the recipient completely unaware and the need for only one username and password.
If you do have an Impersonation User set up, then you should input your information into the corresponding field on the Email Configuration section. This will now work for all users who enable their synchronisation
If you do not have an Impersonation User for your Microsoft Exchange then each user must enter their own password. This should be done by the individual User themselves.
Go to Start > Preferences > Integration > Exchange Sync. Scroll down until you see the cog icon within the 'Microsoft Exchange Connection Status' section, and click on the cog.
Depending on what method of login you have chosen for your Users, they will then be presented with a screen prompting them to login - if you have selected the 'Any' option, they will be given a choice between the available options:
Users' Exchange Sync login information can also be viewed and changed by a System Administrator, however, the password will be encrypted to protect your Users.