Total Synergy Connector
- 05 Nov 2024
- 4 Minutes to read
- Print
- PDF
Total Synergy Connector
- Updated on 05 Nov 2024
- 4 Minutes to read
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Admin Content
1. Prerequisite for Total Synergy API Configuration
Click the Login
link and log in with your Total Synergy login credentials.Click the Add Application
button.
The Create a New Application form is displayed.Enter the following details.
Detail
Description
Name
Enter a name for the API you are configuring.
Description
Enter a description for the configuration.
Company Name
Enter your company’s name as displayed when you login to the website of Total Synergy, https://app.totalsynergy.com/Organisation/<YOUR COMPANY NAME HERE>/Home.
Company Website
Enter your company’s website
Application Logo
Insert your company’s logo
Callback URL
Enter “https://desktop”.
Is Active check box
Select this check box.
Click the Create New Application
button.
A new application is created.Click the View Details button to view the Public and Private keys needed to complete the configuration.
link and log in with your Total Synergy login credentials.
button.
2. Total Synergy Connector Configuration in 12d Synergy
Setting | Value/Value Source | Additional Information |
|---|---|---|
Base URL | https://api.totalsynergy.com/api/v2/ | Applied by default |
Authentication URL | https://app.totalsynergy.com/OAuth2/Authorize | Applied by default |
Token URL | https://api.totalsynergy.com/api/v2/OAuth2/GetAccessToken | Applied by default |
Refresh Token URL | https://api.totalsynergy.com/api/v2/OAuth2/RefreshAccessToken | Applied by default |
Application Public Key | Obtained from the Total Synergy API | Custom Field |
Application Private Key | Obtained from the Total Synergy API | Custom Field |
Callback URL for Request Token Code | https://desktop | Once the authentication is successful, the request token is sent to this URL. |
Organization Name | Insert the company name as mentioned in the API configuration | Custom Field |
Only import jobs created/updated after the last connector run | Yes/No | Select whether or not you want to import jobs created or updated after the last run. |
Import inactive contacts | Yes/No | Import the inactive contacts and project notes created by inactive contacts |
Enter the above details in the 12d Synergy Administration application > Connectors tab > Total Synergy Connector > Configuration tab in the right panel of the window.
Click the Save button.
Click the Authorize button.
The Total Synergy Connector login page is displayed.Continue to login to the Total Synergy application.
3. Total Synergy Connector Data Mappings in 12d Synergy
3.1. Mandatory Job Mappings in 12d Synergy
Source Field | Target Attribute | Type | *Recommended Attribute Name | *Recommended Attribute Display Name |
|---|---|---|---|---|
Total Synergy Project ID | TotalSynergyID | Text | TotalSynergyID | Total Synergy ID |
Total Synergy Project # | Job Number | Text | ||
Total Synergy Project Name | Job Name | Text |
*Attributes defined in these tables are a recommendation only. Please consider your existing 12d Synergy environment and any currently utilised attributes prior to creation.
Total Synergy Project # and Total Synergy Project Name will be used in your Job Name only if Job Name and Job Number attributes are part of your naming rule.
3.2. Optional Job Mappings in 12d Synergy
Source Field | Target Attribute | Type | *Recommended Attribute Name | *Recommended Attribute Display Name | Additional Information |
|---|---|---|---|---|---|
Project Status Name | Job Status Name | Text | JobStatusName | Job Status Name | |
Project Start Date | Job Start Date | Date/Time | JobStartDate | Job Start Date | |
Project End Date | Job End Date | Date/Time | JobEndDate | Job End Date | |
Project Created Date in Total Synergy | Job Created Date In Total Synergy | Date/Time | JobCreatedDateInTotalSynergy | Job Created Date In Total Synergy | |
Project Updated Date in Total Synergy | Job Updated Date In Total Synergy | Date/Time | JobUpdatedDateInTotalSynergy | Job Updated Date In Total Synergy | |
Project Address | Job Address | Address | Job Address | ||
Is the Project active | Is the job active | Yes/No | Is the job active | Isthejobactive | |
Is Office Project | Is Office Job | Yes/No | IsOfficeJob | Is Office Job | |
Is Default | Is Default | Yes/No | IsDefault | Is Default | |
Total Synergy Project Number Prefix | Job Number Prefix | Text | JobNumberPrefix | Job Number Prefix | |
Total Synergy Project Number Suffix | Job Number Suffix | Text | JobNumberSuffix | Job Number Suffix | |
Total Synergy Project Number | Job Number Part | Text | JobNumberPart | Job Number Part | |
Total Synergy Project Type | Job Type | List | Job Type | Job type | A list attribute will need to be created in 12d Synergy to match the values listed in the Project Type field in Total Synergy. |
Total Synergy Project Status | Job Status | List | A list attribute will need to be created in 12d Synergy that matches the values listed in the Status field in Total Synergy. | ||
Total Synergy Project Manager | Project Manager | Contact | ProjectManager | Project Manager | |
Total Synergy Primary Contact | Primary Contact | Contact | PrimaryContact | Primary Contact | |
Total Synergy Project Primary Contact Company | Primary Contact Company | Company | PrimaryContactCompany | Primary Contact Company |
*Attributes defined in these tables are a recommendation only. Please consider your existing 12d Synergy environment and any currently utilised attributes prior to creation.
3.3. Mandatory Contact Mappings in 12d Synergy
Source Field | Target Attribute | Type | *Recommended Attribute Name | *Recommended Attribute Display Name |
|---|---|---|---|---|
Total Synergy Contact ID | TotalSynergyContactID | Text | TotalSynergyContactID | Total Synergy Contact ID |
*Attributes defined in these tables are a recommendation only. Please consider your existing 12d Synergy environment and any currently utilised attributes prior to creation.
3.4. Optional Contact Mappings in 12d Synergy
Source Field | Target Attribute | Type | *Recommended Attribute Name | *Recommended Attribute Display Name |
|---|---|---|---|---|
Contact Unique ID (Modifiable) | ContactUniqueID(Modifiable) | Text | ContactUniqueID(Modifiable) | Contact Unique ID (Modifiable) |
Contact Is Staff | IsStaff | Yes/No | IsStaff | Is Staff |
Contact Staff Type Name | ContactStaffTypeName | Text | ContactStaffTypeName | Contact Staff Type Name |
Contact Role | ContactRole | Text | ContactRole | Contact Role |
Contact Job Title | ContactJobTitle | Text | ContactJobTitle | Contact Job Title |
Contact Home Address | ContactHomeAddress | Address | ContactHomeAddress | Contact Home Address |
Contact Work Address | ContactWorkAddress | Address | ContactWorkAddress | Contact Work Address |
Contact Other Address | ContactOtherAddress | Address | ContactOtherAddress | Contact Other Address |
Contact Web Site | ContactWebSite | Text | ContactWebSite | Contact Web Site |
Contact Type | ContactType | Text | ContactType | Contact Type |
Contact Profile Image URL | ContactProfileImageURL | Text | ContactProfileImageURL | Contact Profile Image URL |
Contact Mobile | ContactMobile | Text | ContactMobile | Contact Mobile |
Contact Phone | ContactPhone | Text | ContactPhone | Contact Phone |
Contact Work Phone | ContactWorkPhone | Text | ContactWorkPhone | Contact Work Phone |
Contact Other Phone | ContactOtherPhone | Text | ContactOtherPhone | Contact Other Phone |
Contact Twitter | ContactTwitter | Text | ContactTwitter | Contact Twitter |
Contact LinkedIn | ContactLinkedIn | Text | ContactLinkedIn | Contact Linked In |
Contact Skype | ContactSkype | Text | ContactSkype | Contact Skype |
Contact Salutation | ContactSalutation | Text | ContactSalutation | Contact Salutation |
Contact Email2 | ContactEmail2 | Text | ContactEmail2 | Contact Email2 |
Contact Email3 | ContactEmail3 | Text | ContactEmail3 | Contact Email3 |
Contact Email4 | ContactEmail4 | Text | ContactEmail4 | Contact Email4 |
*Attributes defined in these tables are a recommendation only. Please consider your existing 12d Synergy environment and any currently utilised attributes prior to creation.
3.5. Mandatory Company Mappings in 12d Synergy
Source Field | Target Attribute | Type | *Recommended Attribute Name | *Recommended Attribute Display Name |
|---|---|---|---|---|
Total Synergy Company ID | TotalSynergyCompanyID | New | Total Synergy Company ID | Total Synergy Company ID |
*Attributes defined in these tables are a recommendation only. Please consider your existing 12d Synergy environment and any currently utilised attributes prior to creation.
3.6. Optional Company Mappings in 12d Synergy
Source Field | Target Attribute | Type | *Recommended Attribute Name | *Recommended Attribute Display Name |
|---|---|---|---|---|
Company Role | CompanyRoll | Text | CompanyRoll | Company Roll |
Company Email Domain | CompanyEmailDomain | Text | CompanyEmailDomain | Company Email Domain |
Company Street Address | CompanyStreetAddress | Address | CompanyStreetAddress | Company Street Address |
Company Billing Address | CompanyBillingAddress | Address | CompanyBillingAddress | Company Billing Address |
Company Other Address | CompanyOtherAddress | Address | CompanyOtherAddress | Company Other Address |
Company Postal Address | CompanyPostalAddress | Address | CompanyPostalAddress | Company Postal Address |
Company Website | CompanyWebsite | Text | CompanyWebsite | Company Website |
Company Profile Image URL | CompanyProfileImageURL | Text | CompanyProfileImageURL | Company Profile Image URL |
Company Mobile | CompanyMobile | Text | CompanyMobile | Company Mobile |
Company Phone | CompanyPhone | Text | CompanyPhone | Company Phone |
Company Work Phone | CompanyWorkPhone | Text | CompanyWorkPhone | Company Work Phone |
Company Other Phone | CompanyOtherPhone | Text | CompanyOtherPhone | Company Other Phone |
Company Twitter | CompanyTwitter | Text | CompanyTwitter | Company Twitter |
Company LinkedIn | CompanyLinkedIn | Text | CompanyLinkedIn | Company LinkedIn |
Company Skype | CompanySkype | Text | CompanySkype | Company Skype |
Company Email2 | CompanyEmail2 | Text | CompanyEmail2 | Company Email2 |
Company Email3 | CompanyEmail3 | Text | CompanyEmail3 | Company Email3 |
Company Email4 | CompanyEmail4 | Text | CompanyEmail4 | Company Email4 |
Company ABN | CompanyABN | Text | CompanyABN | Company ABN |
Company ACN | CompanyACN | Text | CompanyACN | Company CAN |
*Attributes defined in these tables are a recommendation only. Please consider your existing 12d Synergy environment and any currently utilised attributes prior to creation.
Was this article helpful?