Step 1: Package Install

If you’re the System Administrator setting up the Outlook integration for the first time, the first thing you’ll need to do is install the Outlook Plugin in your SuiteCRM instance. If you are a user of the Plugin, go to the User Guide instead. Follow these steps to install the Outlook Plugin on your SuiteCRM instance:

1. Navigate to the “Module Loader” section within the Admin panel.

2. Choose the Outlook zip file you downloaded and upload it using the Upload Button.

3. Click Install next to the newly uploaded package and accept the Terms & Conditions if asked.

4. Run a Quick Repair and Rebuild on the instance.

Step 2: Validate Licence

1. Navigate to the newly added “SuiteCRM Outlook Add-in” within the “Admin” panel

2. Populate your Licence Key and click on “Validate”.

Step 3: Prepare API

The plugin makes extensive use of the SuiteCRM V8 API. In some cases this must be configured on your SuiteCRM server before the plugin will operate.

Before continuing with this step, please ensure your V8 API has been configured correctly. API Setup Instructions

1. Navigate to the Admin Panel, then the “OAuth2 Clients and Tokens” panel.

2. Click New Password Client. Give the key a Name such as “Outlook Password Client” and enter a memorable Secret/password in the Change secret field.

3. Keep note of the generated ID and memorable Secret/password, as this will be required later when configuring the outlook add-in.

Step 4: Installing Outlook Add-in

Continue following the Outlook Installation Instructions