The Synthesis - Vantagepoint API integration supports both cloud and on-premises Vantagepoint installations.
However, on-premises Vantagepoint environments may have firewalls that prevent the Vantagepoint API from being accessed outside of the firewall. We are only able to support on-premises environments that are available outside the firewall.
Setup Process
A Vantagepoint administrator will complete Prepare for the Synthesis - Vantagepoint API Integration steps outlined below and then send the following information to [email protected]:
The Synthesis integration's Consumer Key, Secret, and Database Name, found in Vantagepoint's Integration Manager Utility
The Synthesis user account’s username and password
Knowledge Architecture will set up your Synthesis - Vantagepoint API integration
Your Knowledge Architecture Client Success Manager will help you adjust the integration to best support your firm's needs
Questions
Please reach out to us at [email protected] if you have questions or concerns about setting up this integration.
Prepare for the Synthesis - Vantagepoint API Integration
Add a New Integration
In this step you will create an entry for the Synthesis integration in the Vantagepoint Integration Manager utility.
In Vantagepoint’s Utilities section, click Integration Manager
Add a new integration
Configure the new integration with these parameters:
In the Name field, enter 'Synthesis Integration' (or something similar)
Click the Scopes field dropdown, select Match Role Access from the dropdown
Check the box for Allow Password Grant Type
Leave the Callback URL field blank
Click Save
Create a Security Role
In this step you will create a Vantagepoint security role for the Synthesis application.
Follow these directions to create the security role:
In the Vantagepoint Navigation pane, click Settings > Security > Roles
Add a new role and give it a name, e.g. 'Synthesis API Access'
On the Overview tab, select the following menu items:
Hubs > Contacts
Hubs > Employees
Hubs > Firms > Firms
Hubs > Projects > Project
Navigate to the Record Access tab. Provide Read Only access to the following hubs:
Contacts
Employees
Firms
Projects
Create a Synthesis User Account
In this step you will create a user account for the Synthesis application and assign it the security role you created.
In the Navigation pane, select Settings > Security > Users
Add a new user. Give it a name, e.g. Synthesis User
The user will not be associated with an employee
Set Status to Active
Populate the Password field with a unique password, which you will share with Knowledge Architecture
Uncheck Single Sign-on
Uncheck Force User to Reset Password at Next Login
Under Role, select the role you created above
Grant Access
In this step you will define the Vantagepoint tabs, fields, and grids to which this security role will have read only access.
Regardless of your selections, Knowledge Architecture programmatically excludes a selection of fields containing sensitive information such as SSNs and Citizenship Status from the integration. You can find that list here: Fields Excluded from the Vantagepoint API - Synthesis Integration
In the Navigation pane, select Settings > Security > Roles
On the Roles form, select the role you created
On the Access Rights tab, set the Functional Area option to Application Tabs
Under Tabs check the box for Add All Application Tabs