Updating a connector

Introduction

The manage connectors page is used to view and manage all connectors that you've installed or built. From here, you can make changes to any of your connectors.

It's important to understand the difference between updating a prebuilt Patchworks connector (which you installed via the marketplace) and updating a custom connector that was built by your organisation, using the connector builder.

Prebuilt connectors

Prebuilt connectors are managed by Patchworks. If the associated third-party system requires a general update, Patchworks will make this change and issue a new version of the connector in the marketplace.

Having installed a prebuilt connector, you can go on to update its settings if needed - for example, you might want to add an extra endpoint. If you do modify a prebuilt connector, you'll notice that it is updated to show version information, and who made the change:

If Patchworks issues an update for a modified connector, you can choose whether to overwrite your existing connector (including any customisations that you've made) or to install the updated version alongside your existing one.

Choosing to overwrite an existing connector will overwrite any customisations that may have been made to the existing connector by members of your team. If in doubt, don't overwrite!

Custom connectors

Custom connectors are built with the Patchworks connector builder and are managed by whoever builds them - Patchworks will never issue general updates for custom connectors.

The steps

Step 1 Log in to the Patchworks dashboard and select process flows > connectors & instances to access the manage connectors page.

Step 2 If a connector has a pending update, you'll see an update available button - click this. For example:

If this option is not shown, the connector is up to date.

Step 3 If Patchworks detects that your existing version of this connector has been modified, you are prompted to decide if you want to overwrite the current version (therefore overwriting any modifications that you've made) or install a new version - for example:

Step 4 Select your preferred update option:

What happens if I OVERWRITE an existing connector?

• If you or your team have modified your connector in any way, these changes will be lost.

• Existing instances do NOT need to be re-authenticated.

• If this connector is used in process flows, these flows will continue to run with existing instances.

What happens if I INSTALL alongside an existing connector?

• A new connector is installed alongside your existing (out-of-date) version.

• Your existing (out-of-date) version does not change.

• If this connector is used in process flows, these continue to run with the existing (out-of-date) connector. This may result in warnings or errors and results may not be as desired.

• To apply the new connector in process flows, you must add and authenticate new instances, then re-configure process flow connector shapes to use these.

Step 5 The update is completed. If you choose to install a new version of a customised connector, you will see that you now have two instances of that connector in your manage connectors list:

You can now apply your modifications to the new version, then create new instances and update connection shapes with these in affected process flows.