All Collections
Version 3.0
Implement
Platform SDK
When will my Portal or Sheet update current versions or create new versions?
When will my Portal or Sheet update current versions or create new versions?
Elisa Dinsmore avatar
Written by Elisa Dinsmore
Updated over a week ago

This article is for Flatfile's Portal 3.0 and Workspaces. If you'd like to check out the latest version of the Flatfile Data Exchange Platform, click here!

Sheet

There are a few parameters the Platform SDK looks for when determining whether to update a current Template or create a new one in your Dashboard. Uploading a Sheet from the Platform SDK takes the sheet input parameters you’ve provided and looks for a Template with a matching namespace, sheet name, teamId, and environment (test or prod).

If no Template is found, this method creates a new Template with all of the input parameters, checks to see if there are any linked sheets in the workbook deployment that should be linked to this Template and links them properly then returns the Template.

If a Template is found, then the method checks that the user has access to the Template and if so, creates a new sheet version then returns that Template. When creating a new sheet version, the API checks to see if the Data Hook® code has been modified and if so, deploys a new Data Hook version as well. It also checks to see if the jsonSchema for the Template has been modified, and if so it creates a new version of the Template. Otherwise, it updates the name, archived, jsonSchema, previewFieldKey, sheetCompute and deploymentId to the input params values then saves the Template. Please note: if field hooks or record hooks have been modified but nothing else on the sheet, a new template will not be created. Only the associated Data Hook record will be modified.

Portal

Similar to a Sheet, when deploying a Portal the Platform SDK looks for a Portal with the same name, teamId, and environment (test or prod). If no Portal that has all three matching values is found, a new Portal will be generated and linked to the sheet that was deployed.

If a Portal with all three values is found, the existing Portal is updated with the deployed helpContent, archived status, and schemaId of the deployed Portal (if it changes).

Did this answer your question?