Notable additions and updates to the Flatfile platform
lastActivityAt
- Your Insight into Space DynamicslastActivityAt
is designed to provide you with comprehensive insights into the activity within your Spaces. Here’s what you need to know:What is lastActivityAt? An optional datetime attribute that marks the date of the last significant activity within a Space. Activities considered include, but are not limited to, adding records to a sheet, uploading files, or altering the configuration of a workbook.Precision and Insight: Tracked with second-by-second-level precision, lastActivityAt
offers a valuable overview of your Space’s engagement and operational dynamics, helping you understand user behavior and space utilization better.Reach out with feedback as we continue to enhance the utility of this feature to support your needs better.Learn more@flatfile/plugin-record-hook
We’ve resolved a critical bug in the RecordHook functionality, where metadata
wasn’t correctly assigned during record updates. By overhaulubg the workflow for setting and clearing metadata across various scenarios, we’ve can ensure accurate and consistent metadata management.GET /spaces
Endpoint with Namespace Parameter SupportWe’ve upgraded the GET /spaces
endpoint to support an empty value for the namespace
query parameter. This update allows for more nuanced filtering, specifically enabling the identification of spaces without a namespace. When the namespace parameter is omitted entirely, the endpoint now returns spaces across all namespaces, providing greater flexibility in data retrieval and management.trackChanges
functionalityFor users utilizing the trackChanges
on their Workbooks (disables your actions until all commits are complete), we’ve addressed a critical workflow concern.Changes in a Reference field result in the creation of a new commit event, which was leaving the original commit incomplete. Furthermore, this new commit wasn’t triggering an event emission, leading to a chain of incomplete commits.We’ve refined the commit completion process: now, commits will be marked as complete whenever the user explicitly references a commit in an update request.This adjustment is handled out of the box with @flatfile/plugin-record-hook
and ensures a more streamlined and reliable change tracking experience.toolbarBlocking
job mode beyond individual Sheets. Now, when it’s applied to Workbook-mounted actions, this mode also disables workbook actions (including all of the Sheets actions/toolbars) during a job’s progress. By its nature, it also still allows interaction with the actual data tables.This enhancement provides more consistent control throughout your entire Workbook, ensuring tasks are completed efficiently and without accidental interference or unintended navigation.Learn morePATCH
endpoint, you can update actions without needing to include the fields
property in your payload.This refinement simplifies the update process, focusing solely on the changes you intend to make.See the endpointnull
in the searchValue
parameter to locate empty cells. However, this method posed ambiguity as it didn’t clearly distinguish between an exact search for null values and a partial search for the string “null”.Now, to accurately search for cells with null values, you should use empty double quotes ""
in the searchValue
parameter.See the endpointinputForm
fieldsWe’ve enhanced the inputForm
feature in Actions by supporting defaultValue
settings for enums, strings, and textarea field types.Usage/space/us_sp_1234/files?mode=export
Usage/workbooks/{workbookId}/commits
endpoint. This improvement streamlines the process of retrieving all commits associated with a specific workbook, offering a more efficient way to determine the completion status of all processing activities on that workbook.While this enhancement primarily benefits the Flatfile UI, the endpoint is fully exposed, making it a valuable tool for developers looking to optimize commit retrieval and processing status checks in their own applications.See the endpointconstraints
parameter in your Action that includes type: hasAllValid,
to disable actions when there are invalid records.Learn moreaccessToken
would categorize all user activities under an anonymous guest. Now, if you know the guestId
, interactions in Flatfile can be tied back to that person.This is made possible with a new endpoint, /guests/:guestId/token, which generates an accessToken, and can be used to load the Flatfile space at http://platform.flatfile.com/space/:spaceId?token=:accessToken.With this method, Guests are now accurately named and identifiable, enhancing user recognition and auditing.See the endpoint.mappingConfidenceThreshold
. This parameter empowers you to fine-tune your experience when working with automatically suggested fields during mapping jobs.With mappingConfidenceThreshold
, you have the flexibility to configure the minimum required confidence level. Think of it as a precision control, offering you the choice between conservative (exact match) or liberal (fuzzy matching) settings.How it worksSet the value greater than 0 and up to a maximum of 1, for a more precise control over the mapping process:column.header.fontFamily
property.Learn morearchivedAt
property of the space to null via the PATCH /spaces/:spaceId
endpoint.GET /workbooks
query. It now filters out workbooks linked to previously deleted Spaces, ensuring that only relevant and active workbooks are displayed. This update is helpful for Spaces deleted before this improvement was implemented.commit:completed
. This event signals the end of all processing tasks.settings
parameter in your sheet that includes trackChanges: true,
to disable actions on both Sheets and Workbooks until any pending commits have been completed.Learn moretoolbar-blocking
We’re excited to introduce a third job mode called toolbarBlocking
alongside the existing foreground
and background
modes. With this new mode, toolbarBlocking
, you have the flexibility to disable the Sheet Toolbar and Column Header Menus while still allowing users to enter records manually.Learn moreembed
HTML entity into your markdown body and providing the sheet ID, workbook ID, and name, you can effortlessly embed Sheets into Documents. Additionally, you have the flexibility to choose whether the embedded Sheet starts in an expanded or collapsed state when the document is loaded.sheets.lock
and sheets.unlock
.With the introduction of these API actions, you gain the ability to manage sheet locking within your application. The sheets.lock
action allows you to lock a sheet, preventing any further modifications to its content. Conversely, the sheets.unlock
action enables you to release the lock and restore full editing capabilities to the sheet.These new API actions provide greater control and flexibility when it comes to managing sheet access and data integrity.See the endpointtreatments
. This property allows users to define specific descriptors for each Document. When a Document is assigned the “ephemeral” treatment, it will transform into a full-screen overlay, visible exclusively within the Spaces dashboard, while being discreetly tucked away from the Spaces sidebar.This enhancement enhances user creativity and provides the freedom to tailor document-driven interactions precisely to their needs.estimatedCompletionAt
parameter. Setting the estimated time of completion for the job leads to more informative and interactive features in the UI.string
: For capturing text-based information.textarea
: Ideal for longer text entries or descriptions.number
: To collect numeric data.boolean
: For simple yes/no or true/false responses.enum
: Enables users to select from a predefined list of options.namespace
on Space creation is now easier than ever. Rather than manually typing the namespaces into a free-form text field, you can simply choose from a dropdown menu of available options. The available namespaces are conveniently listed within the namespaces
array of the Environment, providing a more efficient and accurate way to handle namespace selection.metadata
on your Workbook, providing you with a flexible way to store additional information related to it. Whether you’re creating a new Workbook or updating an existing one, you have the option to enrich your Workbooks with meaningful metadata.word-break
property, your validation messages will now display lengthy messages more elegantly.primary:true
concept on Actions didn’t affect Sheet actions, leaving them all in the “more actions” drop-down. But now, setting primary to true will showcase these actions right in the Sheet toolbar, as buttons with clear, user-friendly text.primaryWorkbook
, ensuring a smoother experience for users.job:ready
timeout to 10 minutes, aligning it with the extractor timeout. This adjustment provides more time for all jobs running within an Agent.acknowledge: false
outcome => message
. This approach ensures that your job completion status is promptly communicated to the end user.acknowledge: true
acknowledge
option is configured as true
, a persistent full-screen modal is presented. This modal remains visible until the user interacts by clicking the “Continue” button, acknowledging the outcome.Usagenext
action links. Now, you can display links to external URLs, trigger downloads, or retry jobes upon job completion/failure.UsagehasSelection
flag. When added as a constraint, this flag disables Actions if no records are selected in the Sheet or Workbook, ensuring Actions are only triggered when relevant data is chosen.number
fields, the query value is now cast to a number and then compared with the parsed “shadow” value. This rectifies issues related to numeric comparisons. Additionally, we’ve resolved a bug where numbers with no digits before the decimal point (e.g., “.3”) were not being properly parsed into shadow values.Advanced Date Field Handling: For date
fields, query values are now attempted to be parsed into dates. On the SQL side, a CASE
statement is employed to parse the stored values into dates for accurate comparison. To accommodate SQL-side date parsing requirements, we’ve integrated a regex pattern to detect YYYY-MM-DD
, m/d/yy
, and m/d/yyyy
formats. This ensures correct parsing and comparison of date values.Fix for Invalid Number Input: We’ve resolved a bug where changing a number field to an invalid number left the previous “shadow” value intact. Now, in such cases, the previous shadow value is properly cleared, leading to consistent and accurate behavior.These updates contribute to improved query handling, better data integrity, and a more seamless experience when working with number and date fields.PATCH /sheets
endpoint has been upgraded to accept both an array of SheetUpdates and an array of SheetConfigs (backwards compatible). This expanded capability empowers users with more flexible and efficient options when updating Sheets.tooltip
to Actions, allowing the addition of tooltips. These tooltips are now visible in the user interface for both buttons and list items whenever the associated Action is enabled. This enhancement provides users with clear and context-aware explanations for enabled Actions, contributing to an improved overall user experience.enum
values of various types such as string
, integer
, or boolean
. This modification effectively resolves a server error response that was previously encountered when utilizing such enum
values within the API.In addition, the loading state of the “Continue” button has been refined to ensure smooth recovery from server errors. This adjustment enhances the overall user experience by providing more graceful handling of unexpected issues during the process.access:[]
) now shows a lock icon on the
Sheet tab.metadata
> userInfo
will now display in the Spaces list.metadata
string array./transform
(AI-powered)/query
(AI-powered)/search
(global search)/filter
(Flatfile Query Language, ffql)/in
(field-specific search)