2024 07 17 release notes (core)

Release summary

This page summarises items scheduled for the following release to the Patchworks Production environment:

Patchworks core (backend)

Patchworks dashboard (frontend)

This release includes preparatory information for an upcoming change which affects the behaviour of filters when values are not of the expected data type. Please ensure that you check the Breaking changes section.

New features, updates, and enhancements of note are summarised by product area, below:

Process flows

Breaking changes

This release includes changes that may affect the behaviour of filters defined in existing process flows. Please follow the advice below to avoid any issues.

Filter validation enforcement

When defining process flow filters (for example, in a filter or route shape), you select a data field and then the corresponding data type for this field - for example:

In this release, we start to enforce the specified data type for any filters. For example, if a filter based on the customer_id field is defined to expect string data, but the incoming payload provides these values as numbers, this will cause a validation error.

What's happening?

Filter validation issues will be enforced in two phases:

Phase 1 is scheduled for implementation on the 17th July 2024. We recommend making the following checks before this time:

Filter & route shapes

Check any filter and route shapes in your process flows now, and ensure that defined data types reflect your source data. If you find a mismatch, you can:

  • Change the data type for the process filter, if appropriate

  • Apply a field transform (via a map shape) immediately before the filter step to convert incoming values to a different data type. Several transform functions are available which can help to change data from one type to another - please see Working with field mapping transformations for more information.

  • Change the data type for this value at source (if you have the option to do so)

Connector shapes

Check any connector shapes in your process flows, and ensure that defined data types reflect your source data. If you find a mismatch, action depends on whether the connector is a standard Patchworks connector or a custom connector that was built by your own company with the Connector builder:

  • For a standard Patchworks connector, it’s advisable to change the data type for this value at source. If this isn’t possible, you can edit the filter within the connector endpoint setup and change the data type to match source data. However, be aware that if you subsequently install a Patchworks update for this connector, your changes will be overwritten.

  • For custom connectors, you can edit the filter within the connector endpoint setup and change the data type to match source data.

After the release on the 17th July 2024, please review run logs for all of your active process flows and check if there are any warnings - for example:

You can filter your run logs list so that only entries with warnings are displayed.

If warnings are given, please check the associated process flow and make changes as detailed above.

Phase 2 action required

Phase 2 is scheduled for implementation on the 24th July 2024. We recommend checking run logs for your flows with extra care as soon as possible after this release, just in case validation issues are still present.

Please see release notes for the 24th July 2024 regarding Phase 2 of this change, and also Phase 2 of a similar change to transform validations.

Last updated