This article outlines Finalsite Open (FS Open) Integration in Constituent Manager, including the export requirements for syncing data from an SIS, MIS, or database and the three methods for delivering files to Finalsite.
💡 Quick answers
- What is Finalsite Open Integration? A way to sync constituent data from any SIS, MIS, or database outside the list of direct Finalsite integrations. Automated datasheet exports are processed by Finalsite and mapped into Constituent Manager.
- Which systems use Finalsite Open? Systems that are outside the list of direct Finalsite integrations, schedule their own spreadsheet-style exports, and use one of the Finalsite delivery methods.
- What data types sync? Constituent data, group data, and roster data. The standard datasheet upload templates list the supported fields.
- How does the sync run automatically? When the source system schedules its exports and one of the three delivery methods fits the school, the entire process runs automatically.
- How does setup start? Work through Steps 1 to 5, then submit a request to Finalsite Support. Finalsite configures the mapping, reviews the results with the school, and deploys to the live site.
In this article
- Step 1: Check the list of Finalsite integrations
- Step 2: Understand Finalsite Open and confirm the fit
- Step 3: Choose how files get to Finalsite
- Step 4: Prepare the export
- Step 5: Submit a request to Finalsite Support
Step 1: Check the list of Finalsite integrations
Check the Integrations offered at Finalsite article to find out whether our district or school's system has a direct integration.
- On the list? Use the direct integration. Finalsite Open is not needed.
- Outside the list? Continue to Step 2.
Step 2: Understand Finalsite Open and confirm the fit
Review how Finalsite Open works
Finalsite Open syncs data through scheduled datasheet exports from the source system, such as an SIS or MIS.
- The source system exports datasheets on a schedule.
- The files reach Finalsite through a secure delivery method (see Step 3).
- Finalsite maps the data into Constituent Manager. The integration can process data hourly.
- The source system controls the export and delivery. Finalsite configures the mapping.
Review the Upload Utility
The Upload Utility is one of the three delivery methods. It is a simple Java-based tool, provided by Finalsite, that sends files to Finalsite over HTTPS.
- Where it runs. On the system where the exports are generated, in a directory with a subdirectory that holds the export files.
- How it is used. Run it manually first to verify it works as expected. To fully automate the integration, schedule it to run on the system that generates the exports. Scheduling steps vary by operating system, and guides are typically available online.
- How it affects sync timing. Files are delivered when the utility runs, so the schedule matches how often the export is generated. Each hourly integration run processes the most recently updated datasheet.
- Best fit. Systems that can run a scheduled program use this method easily. SFTP suits other setups.
Check the fit requirements
Finalsite Open automates the data sync when the source system meets all three requirements below.
| Requirement | What to look for |
|---|---|
| Automatic exports | The system schedules recurring exports, such as a nightly export of users, parents, or rosters, without someone running them manually. |
| Spreadsheet-style files | An export or report option produces a .csv (recommended), .tsv, or .xlsx file with one row per person and one column per field. .txt and .xls files also work with extra care (see Step 4). |
| A delivery method | The school can run the scheduled Upload Utility, host an SFTP location that Finalsite can access, or push files to Finalsite over SFTP (see Step 3). |
- All three requirements met? Continue to Step 3.
- Other situations? Datasheets load manually with the templates in Upload constituent data to Constituent Manager in bulk.
Step 3: Choose how files get to Finalsite
Choose one of these secure delivery methods.
Compare delivery methods
| Method | How it works | How often it runs |
|---|---|---|
| Upload Utility | A Java utility provided by Finalsite sends the files to Finalsite over HTTPS. The school schedules it on the system where the exports are generated. | Matches the schedule set for the utility. |
| SFTP pull | The school hosts the files on an SFTP location that Finalsite has access to. Finalsite retrieves ("pulls") the data on a scheduled basis. | Finalsite retrieves the files once an hour. Retrieval is not tied to the integration processing the data. |
| SFTP push | The school's system delivers ("pushes") the files to Finalsite via SFTP. | When datasheets are updated and delivered to Finalsite’s servers, with the capability to run hourly. |
How often does the data sync? The integration can run hourly in Finalsite. The true frequency is determined by how often the datasheets are updated and delivered to Finalsite's servers.
Set up the Upload Utility
- Receive the utility from Finalsite Support during integration setup.
- Place the utility in a directory that contains a subdirectory for the export files.
- Name the subdirectory for the integration's service type, such as
finalsiteopen. Finalsite Support confirms the correct name when configuring the integration. - Run the utility manually to verify it works as expected.
- Schedule the utility to run on the system where the exports are generated.
Step 4: Prepare the export
Exports meet the requirements below. Review them with whoever manages the school's SIS or database.
The standard datasheet templates list the supported fields: Faculty, Students and parents, and Alumni. The Upload constituent data to Constituent Manager in bulk article covers the full upload process.
Choose a file format
Each datasheet keeps a consistent file name.
| Format | Status | What to watch for |
|---|---|---|
.csv
|
Recommended | Saved as UTF-8 without BOM. |
.tsv
|
Supported | Saved as UTF-8 without BOM. |
.xlsx
|
Supported | A plain table on one sheet, with no rich formatting (see below). |
.txt
|
Supported, with extra care | Tab-delimited columns, saved as UTF-8 without BOM. Some programs save text files in a different encoding by default, so confirm the encoding. |
.xls
|
Supported, with extra care | A plain table on one sheet, with no rich formatting (see below). This older Excel format often comes from older systems with limited export settings. |
Rich formatting in Excel files is anything beyond a plain table of data, such as:
- Multiple tabs (all data belongs on one sheet)
- Title rows, logos, or notes above the column headers
- Merged cells
- Colors, fills, or conditional formatting
- Formulas in place of plain values
- Blank rows or columns used for spacing
Set encoding and line endings
- Encoding. Datasheets are UTF-8 encoded without BOM. Other encodings can garble names with accents or special characters.
- Line endings. Every row ends with a standard line ending. A mismatch can cause a file to fail or load as a single row.
Assign record IDs
- Every record (student, parent, and so on) has a unique, persistent ID (ImportID).
- The left-most column is populated for every row. The ImportID is the recommended value for that column.
Structure columns and rows
- Column headers. Headers carry no rich formatting and no non-alphanumeric characters. Spaces, underscores, and hyphens are acceptable. Populated columns have no empty headers between them.
- Rows. Rows run without gaps. After more than 5 consecutive empty rows, Finalsite treats the datasheet as complete and stops processing it.
- One type per column. Each column holds one type of data. For example, a column of home phone numbers holds home phone numbers for every record, and business phone numbers go in a separate column.
- Contact information. The contact portion of the export is arranged so that each column contains a specific type, such as home phone.
Format data content
-
Dates. Dates use one consistent format throughout, either all
mm/dd/yyyyor alldd/mm/yyyy. - Departments and locations (faculty). Supported, including the option to remove users from locations or departments absent from the data. Names are consistent. Ideally, each name is an exact match for the corresponding group in Finalsite. Finalsite can translate names when guidance on the desired translation is provided.
- Usernames. Handled case by case. Finalsite can auto-populate usernames from the raw data (for example, by concatenating first and last names), or usernames can be included in the export.
- Passwords. Finalsite recommends that users set their own passwords on first login with the Forgot Password option.
Keep exports unedited
Data files stay exactly as exported from the SIS. Changes to column headers and manual edits of any kind happen in the source system. Re-saving a .txt or .xls export in Excel or Notepad can change the delimiter, encoding, or date format without a visible sign.
Step 5: Submit a request to Finalsite Support
After confirming that the system is outside the list of direct integrations and meets the requirements above, submit a request to Finalsite Support.
Gather request details
Include these details in the request:
- The name of the SIS, MIS, or database
- The data to sync and the roles to populate (for example, students, parents, faculty, rosters, groups)
- How often the system exports, and in which file format
- The preferred delivery method (Upload Utility, SFTP pull, or SFTP push)
- A sample export, if one is available
- Any questions or concerns about the process
Review what happens next
- Kickoff. Finalsite reviews the data and roles to be integrated, confirms the datasheets and datapoints, and agrees on how files are delivered.
- Mapping and testing. Finalsite configures the mapping and processes the sample data on a clone site or the live site, depending on the situation.
- Review. Finalsite reviews the results with the school and adjusts the mapping as needed.
- Pre-deployment work. Finalsite completes any additional preparation the situation calls for.
- Go live. Finalsite deploys the integration on the live site, and the datasheets are scheduled.
⚠️ Important Note
Data columns remain consistent after deployment. Removing or renaming a column halts processing until the change is accounted for in the integration configuration. Contact Finalsite Support before changing export columns.
Comments
Please Sign in to leave a comment if you don't see the comment box below.