Installation and Configuration Details

Installation and Configuration Details

How to Install


To install this app, go to Freshdesk > Admin > Support Operations > Apps > Search for “Freshdesk to SimPRO” and install the application.

You will have to ensure the following custom fields are created in Freshdesk and SimPRO. It is critical for these fields to be created for the app to function as intended and for the visibility of SimPRO URLs on the extension pane. SimPRO 1) To create the custom field in SimPRO, go to Setup > Custom Fields > Leads, Quotes, Jobs & Recurring Custom Fields > Create Custom Field. 2) Field Name: Ticket Id (please ensure small "d" in Id), Field Type: Text, Show For: Quotes and Jobs Freshdesk 1) The extension should automatically create these two fields for you: simPRO Quote Number, simPRO Job Number. 2) In the event that these fields are not created, go to Admin > Workflows > Ticket Fields > create the above two fields as a "Number" data type with the exact naming.


After installation, the settings page will appear.




Configuration Details

 


Admin Email


Enter the email address of the administrator user. Alternatively, you can also enter the email of anyone in your organization. This will help us to communicate with you.


Freshdesk subdomain


This is used to connect your Freshdesk account with your simPRO build URL.


For example, https://syncezy-help.freshdesk.com/a/tickets/. In this example, we choose “syncezy-help” as the value to enter.


Freshdesk Api Key


To generate the SimPRO API key, go to Profile Settings >Your API.


You will see an “Access Token” at the bottom of your created key. This value should be copied and pasted into the Freshdesk API Key section of this configuration.




Default Site ID


Here you need to set the Default Site ID to create a Quote or a Job. A Site and a Customer are mandatory fields for creating a Quote or Job. In the event the Customer does not have a Site, the Default Site configured will be linked to the Quote/Job instead.


You will need to create a default site in simPRO, retrieve the Site ID and then add the ID in this field. You can also choose another Site if you wish, simply add that Site’s ID in this field.


Note: In the event you have a Multi-company setup, you will need to enter multiple site IDs separated by a comma. For example, in Company A the default site ID is 1234 and in Company B the default site ID is 9876. So the value here will be 1234,9876.


SimPRO Domain Prefix


This is used to connect your Freshdesk account with your simPRO build URL.


For example, www.syncezy.simprosuite.com. In this example, we choose “syncezy” as the value to enter.


Multi Company


This field is used to enable Multi Company syncing. Only “Yes” or “No” are acceptable values. Type Yes if you want to configure simPRO Multi Company, Type No if you don’t or if you have a single company.


SimPRO Companies


If you don’t have a multi-company setup, enter 0 - company name here (eg. 0 - SyncEzy). If you wish to link only one company, you will need to enter the company ID - company name (eg. 4 - SyncEzy).


If you have a multi-company setup in simPRO, enter in this format: company ID - company name (eg. 6 - SyncEzy). For more companies, add the same with a comma separator (eg. 6 - SyncEzy, 7 - Zoho,..., etc). 


simPRO Company IDs can be found by going to simPRO > Setup > Company


Note: Avoid using commas and dashes in the company name as these are specifically used as delimiters.


SimPRO API Key


To generate the SimPRO API key, go to Setup > API > Applications > Create Application. The values will be as follows:

Company: <Your Company Name>

Name: SimPRO Integration by SyncEzy

Redirect URI: /oauth2/accessCode (leave it as it is)

Email Address: <Your Email>

Description: SimPRO Integration by SyncEzy API Key

Notes: <blank>

Authentication Method: API Key


Click Create. You will see an “Access Token” at the bottom of your created key. This value should be copied and pasted into the SimPRO API Key section of this configuration.


Default Customer Type [Companies/Individuals]:


In this option, you have to set the value as Companies or Individuals. This defines the customer type to be created from the extension, Company Customer or Individual Customer.


Default Project Type [Service/Project]:


In this option, you have to set the value as Service or Project. This defines the Quote/Job type to be created from the extension, a Service Quote/Job or Project Quote/Job.




Final Touches

Your configuration page should look something like this after it is done. It may vary depending on your inputs.




Once the setup is complete, the extension will appear as below, on the side of the ticket. Click the logo if you can’t see it.



Handy Tips


  1. The extension will give you an error if something is wrongly entered in the configuration.

  2. In case of any changes in the configuration, press Ctrl + Shift + R (Windows) or Command + Shift + R (Mac).

  3. If you are adding/removing the ticket number manually from the SimPRO Quote Number field or SimPRO Job Number field, press update and please refresh the ticket page to see the changes.


    • Related Articles

    • Zendesk to SimPRO Installation and Overview Guide

      Summary This is a user guide to walk you through some of the basic functionalities of the SimPRO by SyncEzy extension for Zendesk. The functionality of the app, the configuration details, settings and support information is listed below. Functions ...
    • Zoho Desk to SimPRO (Standalone) Overview and Setup Guide

      Summary This is a user guide to walk you through some of the basic functionalities of the Zoho Desk to simPRO extension, an overview on how to install and setup the extension and to detail functionalities of the extension. Note: This extension is ...
    • Zoho Desk to SimPRO (CRM Integration Users) Overview and Setup Guide

      Summary This is a user guide to walk you through some of the basic functionalities of the Zoho Desk to simPRO extension, an overview on how to install and setup the extension and to detail functionalities of the extension. Note: This extension is ...
    • Summary

      Summary This is a user guide to walk you through some of the basic functionalities of the SimPRO Integration by SyncEzy extension.  The functionality of the app, the configuration details, settings and support information is listed below. Functions ...
    • Shopify to simPRO (One-way) Integration FAQs

      This document addresses the variety of questions we encounter while helping clients. If you have a question that’s not addressed here please write to us at support@syncezy.com How does the integration between Shopify and simPRO work? The integration ...