Exchange student information between [College] and CollegeVine through SFTP
Setup
Log into the CollegeVine Agent Platform at platform.collegevine.com/agents.
You should be brought to this page.
Select Integrations -> New
Name your integration, select Constituent Sync, and input your SSH public key and IP Address (see below how to generate the SSH key)
Set up the Import and Export query on your system. You will see the exact import and export paths in the UI
For uploads: This query should include a CSV file with, at a minimum, the constituent's First Name, Last Name and Email address at a minimum.
If you want to share additional data columns, please include them in the csv file
💡Tip: You can name your data fields whatever suits you and your team, and can insert the field values directly in the cells.
After sending the csv file via the query - in the CollegeVine Platform, select "Refresh" on the constituent sync. This will pull the file from the SFTP
Before mapping your properties in the integration screen, any custom properties you want to map must first be created under Constituents > Properties. Properties that have not been created in advance will not be available to map to your import's columns.
To create a custom property:
Navigate to the Constituents tab in your left side navigation.
Click the Properties tab at the top.
Click +New and fill in the following fields:
Property name — the field label as it will appear across the platform
Property description — optional, but useful for clarifying what the field contains
Property type — select Text, Number, or another available type. Note: property type cannot be changed after the property is created.
Contains sensitive data — check this if the field contains information that should be protected. When checked, constituent authentication is required before agents can access this property.
Workflow permissions — controls how agents can interact with this property:
None — if this property contains sensitive data, agents may only use the retrieve_sensitive_properties tool to read it
Read — agents may view the property but not modify it
Set when missing — agents may read the property and set its initial value for constituents, but not overwrite an existing value
Modify — agents may read or modify this property freely
Click Save.
💡 You can always go back and edit a property's name or description. However, you can't edit the property type once it's been set.
Important: Custom properties must be created in Constituents > Properties before you reach the mapping step. If a property does not exist yet, it will not appear as an option when mapping columns. Follow this resource to learn how to create properties.
You will then define the import schedule and map your properties to the existing CollegeVine properties.
Following this, you are all set up for the Constituent Sync!
How to generate the SSH key
Create an OpenSSH formatted public/private key pair:
An OpenSSH key pair is used to authenticate and secure the connection from Slate to CollegeVine.
To generate the key pair, follow these instructions:
For Windows
For Windows
Download PuTTyGen or ensure you have the most up-to-date version.
Go to this website and click the installation option best suited for your machine.
The 64-bit x86 or 32-bit x86 options are most common. For Windows devices, to determine if your system is 32- or 64-bit, go to Start > Settings > System >About. Under Device specifications, you can see the System type (64- or 32-bit.)
2. Download PuTTyGen or ensure you have the most up-to-date version.
Go to this website and click the installation option best suited for your machine.
The 64-bit x86 or 32-bit x86 options are most common. For Windows devices, to determine if your system is 32- or 64-bit, go to Start > Settings > System >About. Under Device specifications, you can see the System type (64- or 32-bit.)
Go to your downloads folder (or the downloads button in your browser) and open the installer you just downloaded.
Click 'Next' on the next two screens