Please note, there is no native error identification in the Flatfile Platform SDK. As you build out your workbooks, sheets, and Data Hooks®, we recommend committing as often as possible to more easily identify errors.
Flatfile has an ever growing library of code examples that will give you a framework for your needs. Flatfile is committed to allowing developers to write code using these frameworks and not be limited by exact examples. We encourage you to build to suit.
Building a Sheet Tester
The Platform SDK comes with a testing framework that can be adopted to ensure that your validations are working as expected before deploying and testing in your Dashboard or environment. Use of this sheet tester is highly recommended to ensure that you are able to test efficiently and discover any issues early on in your testing process. Instructions on how to use this to test can be found in our developer documentation here.
We recommend placing each sheet in a separate file and Primary workbook export (wrapper). If you are deploying sheets with LinkedFields, they do not need to be in the same file, but we recommend keeping them in the same folder.
Testing Linked Sheets
When testing Linked Sheets, there are two layers of testing that should be considered.
Right now, we cannot write unit tests for this layer. The mapping layer uses fuzzy AI matching that cannot be included in unit testing, as our unit tests do not include the customized logic necessary to do this. For this portion of linked field testing, we recommend testing in a Portal or Workspace after it has been deployed. Much of the matching and relational logic runs server side and would not be able to run in a self contained client side components like Data Hooks do. Testing the mapping side will require end to end testing and human click through, but you can have assurance that the sheets are linked if the schemas reference one another. As long as they are referenced properly, they are linked.
Our unit testing allows you to validate and normalize errors as your sheet would after the data is mapped. For testing linked sheets, we recommend using Jest tests as you normally would for non linked fields. Please note that right now, the getLinkedValue and setLinkedValue methods cannot be tested in our SheetTester and, like Mapping tests, will need to be tested in a Portal or Workspace.
Support or Questions during your Platform SDK UAT?
For any bugs or performance issues, contact our support team- email@example.com.
For requests for recommendations on implementation, workflow, folder structure, etc; reach out to your implementation team member and include firstname.lastname@example.org for a quick response.