# 2024 10 16 release notes (core)

### Release summary <a href="#release-summary" id="release-summary"></a>

This page summarises items scheduled for the following release to the Patchworks Core Production environment.&#x20;

| Release version | Release date            |
| --------------- | ----------------------- |
| v2024-10-16     | 16th October 2024 @ 9am |

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

* ​[Process flows](https://app.gitbook.com/o/QK9606D86GQKTsWinNMs/s/LYNcUBVQwSkOMG6KjZfz/~/diff/~/changes/1264/~/revisions/YonwsYh0CeVfExW3wO6H/release-information/core-release-notes/2024-09-11-release-notes-core#process-flows)
* [Connector builder](#connector-builder)
* [Custom scripts](#custom-scripts)
* [Breaking change](#breaking-change-connector-endpoints-where-body-content-is-set-to-none)

{% hint style="danger" %}
This update introduces a feature flag 'switch on' for a change that could cause some existing connector endpoints to break. The change [(CPT-1085)](#connector-builder) relates to connector endpoints that SEND data via the request *body,* where the *body format* is set to *none*.&#x20;

We have identified customers with existing endpoints that would be adversely affected by this change and we're in the process of reaching out to resolve any issues directly. If you are affected, this feature will NOT be switched on - all of your connectors will continue to operate normally.&#x20;

If you are *not* affected, this feature will be switched on as part of this release. &#x20;

Please check the [Breaking changes](#breaking-change-connector-endpoints-where-body-content-is-set-to-none) section below for more information.
{% endhint %}

## Process flows <a href="#process-flows" id="process-flows"></a>

<table><thead><tr><th width="180">Type<select><option value="edbc33cea7f34e16b3a205c7a65c3172" label="New" color="blue"></option><option value="d8457d8925c74fab90fa132d141b764b" label="Change" color="blue"></option><option value="030babd6286a4fe19214da74af9afb98" label="Enhancement" color="blue"></option><option value="9a29ee576f43448f9b1623baca59c3db" label="Bug" color="blue"></option><option value="L09Gy6z2y7VD" label="Breaking change" color="blue"></option></select></th><th width="426">Summary</th><th>Ref #</th></tr></thead><tbody><tr><td><span data-option="edbc33cea7f34e16b3a205c7a65c3172">New</span></td><td><strong>Try/catch shape</strong><br>Our new <em>try/catch</em> shape gives you full control over how process flow exceptions are handled. Errors are caught, removed from the flow and sent down your defined path (for example, you might use the <a href="/pages/qJOdm6pHm3I8Ovog6Ola">notify shape</a> to alert contacts about issues and/or add exceptions to a <a href="/pages/aGi157tdOz4wMkNdBOWh">cache</a> for follow-up processing).  <br><img src="https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2F7ebRB4tRIozWxpBMCAoN%2Ficons8-google-docs-20.svg?alt=media&#x26;token=ac61da4e-764c-452c-b9b5-d65f188769c9" alt=""> <a href="/pages/YZid3TGyza7ptthhXJRv">Try/catch shape</a></td><td>CPT-3167</td></tr><tr><td><span data-option="edbc33cea7f34e16b3a205c7a65c3172">New</span></td><td><strong>Queue priority setting for process flows</strong><br>A new <code>queue priority</code> option is available in process flow settings. Use this to determine whether runs for this flow should be picked from your <a href="/pages/RVdm7LuBhWXjhM0Cyuq9#working-with-your-run-queue">queue</a> as a <code>high</code>, <code>low</code>, or <code>regular</code> priority (the default is <code>regular</code>).<br><img src="https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2F7ebRB4tRIozWxpBMCAoN%2Ficons8-google-docs-20.svg?alt=media&#x26;token=ac61da4e-764c-452c-b9b5-d65f188769c9" alt=""> <a href="/pages/z6PdL9vs3J07w3LXGTw8">Process flow settings</a></td><td>CPT-3436</td></tr><tr><td><span data-option="9a29ee576f43448f9b1623baca59c3db">Bug</span></td><td><strong>Improved error message for invalid endpoint URL</strong><br>If a connector request is calling / (i.e. the endpoint URL has not been defined), a clear message is now displayed in run logs, advising the user to check the request endpoint (previously an internal error message was given). <br><img src="https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2F7ebRB4tRIozWxpBMCAoN%2Ficons8-google-docs-20.svg?alt=media&#x26;token=ac61da4e-764c-452c-b9b5-d65f188769c9" alt=""> <a href="/pages/RVdm7LuBhWXjhM0Cyuq9">Run logs</a></td><td>CPT-3523</td></tr></tbody></table>

## Connector builder

<table><thead><tr><th width="180">Type<select><option value="edbc33cea7f34e16b3a205c7a65c3172" label="New" color="blue"></option><option value="d8457d8925c74fab90fa132d141b764b" label="Change" color="blue"></option><option value="030babd6286a4fe19214da74af9afb98" label="Enhancement" color="blue"></option><option value="9a29ee576f43448f9b1623baca59c3db" label="Bug" color="blue"></option><option value="L09Gy6z2y7VD" label="Breaking change" color="blue"></option></select></th><th width="426">Summary</th><th>Ref #</th></tr></thead><tbody><tr><td><span data-option="L09Gy6z2y7VD">Breaking change</span></td><td><p><strong>Body content none for SEND endpoints</strong><br>This update introduces a feature flag to manage a potentially breaking change for connector endpoints SENDing requests with <code>body format</code> set to <code>none</code>. <br><br>Affected customers have been identified and will receive an email detailing affected endpoints. This change will stay switched OFF for affected customers. For everyone else, it is switched ON as part of this release.</p><p></p><p>For more information please see our <a href="#breaking-change-connector-endpoints-where-body-content-is-set-to-none">Breaking changes</a> section below.  </p></td><td>CPT-1085</td></tr><tr><td><span data-option="9a29ee576f43448f9b1623baca59c3db">Bug</span></td><td><strong>Endpoint names should not be unique between connectors</strong><br>Fixed an issue where a <code>duplicate name</code> error was incorrectly prompted when attempting to create an endpoint with the same name as another endpoint associated with a <em>different</em> connector. Endpoint names are not unique between connectors. <br><img src="https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2F7ebRB4tRIozWxpBMCAoN%2Ficons8-google-docs-20.svg?alt=media&#x26;token=ac61da4e-764c-452c-b9b5-d65f188769c9" alt=""> <a href="/pages/Bj90c9fEXrJRJcUWC9J1">Connector endpoints</a></td><td>CPT-3551</td></tr></tbody></table>

## Custom scripts

<table><thead><tr><th width="180">Type<select><option value="edbc33cea7f34e16b3a205c7a65c3172" label="New" color="blue"></option><option value="d8457d8925c74fab90fa132d141b764b" label="Change" color="blue"></option><option value="030babd6286a4fe19214da74af9afb98" label="Enhancement" color="blue"></option><option value="9a29ee576f43448f9b1623baca59c3db" label="Bug" color="blue"></option><option value="L09Gy6z2y7VD" label="Breaking change" color="blue"></option></select></th><th width="426">Summary</th><th>Ref #</th></tr></thead><tbody><tr><td><span data-option="030babd6286a4fe19214da74af9afb98">Enhancement</span></td><td><p><strong>Additional libraries for PHP and C#</strong></p><ul><li>The <a href="https://phpspreadsheet.readthedocs.io/en/latest/">phpSpreadsheet</a> library has been added for PHP 8.1 and 8.2, allowing you to read and write various spreadsheet file formats.</li><li>For C#, <a href="https://www.nuget.org/packages/System.Xml.ReaderWriter">System.Xml.ReaderWriter</a> and <a href="https://www.nuget.org/packages?q=Newtonsoft.Json">Newtonsoft.Json</a> libraries have been added. </li></ul><p><img src="https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2F7ebRB4tRIozWxpBMCAoN%2Ficons8-google-docs-20.svg?alt=media&#x26;token=ac61da4e-764c-452c-b9b5-d65f188769c9" alt=""> <a href="/pages/oZoHN71i3KN7FMkgdP1x">Custom scripting</a></p></td><td>CPT-3527</td></tr></tbody></table>

## Breaking change: c**onnector endpoints where body content is set to none**&#x20;

When configuring connector endpoints which are set to `SEND` data via the request `body`, behaviour associated with the `body format` / `none` setting has changed.

Previously, if a connector endpoint includes static body content - or if your API passed payloads into the body - this content was passed into the request body even if the `body format` option was set to `none`.  Now, all request body content is ignored if the `body format` option is set to `none`.&#x20;

However, this change is behind a 'feature flag' which means this feature change is be switched on for customers in a controlled way. &#x20;

### Why the change?

This change has been released to prevent content from being sent erroneously.&#x20;

An example of this  is where an endpoint is defined to send specified JSON content in the `body` with the `body format` set to `raw/json`.&#x20;

Before this update, if this option was subsequently changed to `none` (because existing JSON content is no longer required) but the specified content was not removed, it would continue to be sent. &#x20;

### Who is affected?

* If you have built connectors (using our [connector builder](/product-documentation/developer-hub/connector-builder.md)) with an API that SENDs incoming payloads in the request `body`, you may be affected.&#x20;
* A handful of Patchworks marketplace connectors are affected.

### What do I need to do?

We have identified customers who may be affected and in these cases, this feature change is switched OFF. This means there is no change to how your connectors (and therefore process flows) behave.&#x20;

#### If you are affected

If you are affected, we will be reaching out individually by email, before our release on the 16th October 2024.  In this email, we will list any affected connectors and process flows. Then, you can either:

* Check/update your own endpoints (see instructions [below](#how-to-change-the-body-format-for-a-connector-endpoint)) - then [notify Patchworks](#i-fixed-my-own-endpoints-how-do-i-notify-patchworks) that you're happy for this feature change to be switched on

OR

* [Raise a support ticket](/product-documentation/raising-a-support-ticket.md) for Patchworks assistance with required fixes and then switch the feature change on

#### If you are NOT affected

All affected customers will be notified before the 16th October 2024. If you don't receive an email, you are not affected by this change and it will be switched ON from the 16th October 2024.&#x20;

### I'm affected. Is there a deadline for fixing my endpoints?

No. This feature change will remain switched off for affected customers until either:

* You notify Patchworks that you've [fixed your own endpoints](#how-to-change-the-body-format-for-a-connector-endpoint) and are ready for the feature change to be switched ON

OR

* You have completed the required fixes on a call with Patchworks and confirmed that you're happy for the feature change to be switched ON.

{% hint style="warning" %}
Whilst there is no deadline, we strongly recommend that you take the time to ensure that affected endpoints are fixed so we can switch the feature change ON for your company profile. This will ensure that the `body format` / `none` option functions as expected, removing the risk of payloads being passed inadvertently.
{% endhint %}

### I've fixed my own endpoints - how do I notify Patchworks?

If you've [fixed your own endpoints](#how-to-change-the-body-format-for-a-connector-endpoint) and are ready for the feature change to be switched ON, please [get in touch with support](/product-documentation/raising-a-support-ticket.md). The feature change will then be switched on as soon as possible, and you will be notified when this is complete.

### How to change the body format for a connector endpoint

If you want to check/update your connector endpoints, the required steps are detailed below.

**Step 1**\
Log in to the Patchworks dashboard, then select **process flow**s > **connectors & instances**:

<div align="left"><figure><img src="/files/EjvsaJVsf2B33MDObR75" alt="" width="169"><figcaption></figcaption></figure></div>

**Step 2**\
Click the **settings icon** associated with a connector that you want to update:

<div align="left"><figure><img src="/files/j4lTuwvIaqpmnrGG8svj" alt=""><figcaption></figcaption></figure></div>

**Step 3**\
Click the **endpoints** tab:

<div align="left"><figure><img src="/files/LQld9fpejIZqAr33KsHC" alt="" width="563"><figcaption></figcaption></figure></div>

**Step 4**\
Click the name of the endpoint that you want to update:

<div align="left"><figure><img src="/files/kw1MLnCLNERKphRRqmVU" alt=""><figcaption></figcaption></figure></div>

{% hint style="info" %}
If the connector includes a lot of endpoints, use CTRL+F to search for a specific part of the endpoint name.
{% endhint %}

**Step 5**\
Click the **body** tab from the endpoint setup page:

<figure><img src="/files/QHCpCGOjQQj3wxPaeId7" alt=""><figcaption></figcaption></figure>

{% hint style="warning" %}
You only need to change `SEND` endpoints where the `body format`option is set to `none` and you expect `body`content to be passed into the request.&#x20;
{% endhint %}

**Step 6**\
Click in the **body format** field and select **raw** from the dropdown list:

<figure><img src="/files/mMy7u79I3ckeGh3FCcFV" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
With this setting, any incoming payload will be sent in the request body.&#x20;
{% endhint %}

**Step 7**\
Set the **data type** as required (the default is JSON):

<figure><img src="/files/8R6P4ltCOfsQl00VJibl" alt=""><figcaption></figcaption></figure>

**Step 8**\
Click the **save and go back** button at the bottom of the page.

**Step 9**\
Repeat for each affected endpoint.

**Step 10**\
This step is only required if affected endpoints are associated with a connector that has been uploaded to your private marketplace:

* If an affected connector exists in your private marketplace, you should re-upload it so the latest version is available in future. See [Changing a private marketplace connector](broken://pages/nGgbS7NyccMfO4ZIp3C6#changing-a-private-marketplace-connector) for more information.
* If an affected connector is part of a private marketplace *process flow*, you should delete the existing process flow from your marketplace and upload the latest version. See [Changing other private marketplace resources](broken://pages/nGgbS7NyccMfO4ZIp3C6#changing-other-private-marketplace-resources) for more information.
* If an affected connector is part of a private marketplace *blueprint*, you should re-upload it so the latest version is available in future. See [Changing a private marketplace blueprint](broken://pages/nGgbS7NyccMfO4ZIp3C6#changing-a-private-marketplace-blueprint) for more information.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.wearepatchworks.com/product-documentation/release-information/core-release-notes/2024-10-16-release-notes-core.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.