If an instance is no longer required, you can remove it from your manage connectors page.
Before you can remove connector instances, you may need to complete some housekeeping. An instance cannot be removed if it's currently configured in any process flows (irrespective of whether the process flows are enabled or disabled). If the instances that you need to remove are used in any process flow connection shapes, these shapes need to be reconfigured or removed first.
Step 1 Log in to the Patchworks dashboard and select process flows > connectors & instances to access the manage connectors page.
Step 2 Find the required connector and instance.
Step 3 Click the settings 'cog' icon associated with the instance that you want to remove - for example:
Step 3 Click the 'trash' icon:
Step 4 When prompted, type confirm to confirm that you wish to proceed:
Step 5 If this instance is found to be configured in any process flows, you'll be prompted to update these before trying again. Otherwise, the instance is removed immediately.
An instance of a connector is unique to your company, personalised with your own credentials and settings. Any instances that you add are available for use in process flows when you add a connection shape.
This section includes guidance for key tasks that you may need to perform when working with connector instances.
To learn more about what instances are and their relationship with connectors and process flows, please see the Connectors & instances page.
Once a connector is installed (or built with our connector builder), it's available on your manage connectors page. From here, you can add any required instances.
Every instance requires authentication credentials that allow you to access the associated third-party application - you'll need these to hand before starting the steps detailed on this page. Typically, you'll create one instance for each set of credentials that you have for a given connector that you want to use in process flows.
To add an instance for one of your installed connectors, follow the steps below.
Step 1 Log in to the Patchworks dashboard and select process flows > connectors & instances to access the manage connectors page.
Step 2 Find the required connector.
If you can't find the connector here, it means the connector is not installed. In this case, navigate to the Patchworks marketplace and install the required connector.
Step 3 Click the add new instance button:
Step 4 The new instance wizard is launched - enter a name for this instance, then click the next step button:
The name entered here is what your users will see when they choose an instance to associate with connector shapes in process flows. It's advisable to ensure that the name reflects what this instance is for (e.g. Shopify - UK, for a UK instance of a connector).
Step 5 Update settings as appropriate - settings defined here take effect wherever this instance is configured in process flow connector shapes:
Available options are summarised below:
Step 6 Choose which authentication method you wish to use for this instance, then click the next step button:
Any authentication methods defined for the underlying connector will be available for selection. Often there will only be one however, if multiple authentication methods are shown, choose the one associated with the credentials that you have available.
Step 7 Enter valid credentials for this instance, then click the next step button:
Only valid credentials can be saved. Required credentials will vary, depending on the selected authentication type. Any fields that are shown in the advanced section are not typically required for standard use.
Step 8 The instance is created for the associated connector and is now shown on the manage connectors page - for example:
Once an instance is added, it becomes available for selection in connection shapes when you build process flows.
Having added an instance, you can make changes to basic details and authentication details, at any time. If you update an instance that has already been used in , your changes will be cascaded down to them automatically.
To update an existing instance for one of your installed connectors, follow the steps below.
Step 1 Log in to the and select process flows > connectors & instances to access the manage connectors page.
Step 2 Find the required connector and instance.
If you can't find the connector here, it means the connector is not . In this case, navigate to the and install the required connector.
Step 3 Click the 'cog' icon associated with the instance that you want to update - for example:
Step 4 The instance settings page is displayed - from here you can view/update instance details:
Available options are summarised below:
Step 5 Click the authentication tab to view/update authentication details:
If you update authentication fields, credentials are checked - only valid credentials can be saved.
Step 6 Click the save instance details button to confirm any changes:
Option | Summary |
---|---|
Option | Summary |
---|
Please see for more information about these fields.
The request tab confirms any information that is being passed for validation, and the response tab shows response information for the authentication request. Here you'll see a response code, body content (typically the failure message associated with the response code) and header details.
Time zone
Used to convert the time in any date/time filters that are applied when this instance is used in process flows.
Date format
The expected date format when this instance is used in process flows.
Rate limit amount Rate limit unit
Determines the rate at which Patchworks is allowed to make API requests to the associated system when using this instance of the connector. If the rate limit for an instance is exceeded, remaining requests are queued and sent when the rate limit is released again.
Default settings are provided but you may need to adjust this to suit your specific needs. For example, you might have a plan which allows you a higher rate limit, or you might have multiple instances for the same connector running at the same time, which all need to share a rate limit. If you're not aware of any specific requirements, leave the default settings as they are.
Connection pool
If the connector associated with this instance has a concurrency limit and you have configured connection pools, these are available for selection here. For more information see our Connection pools page.
Name | The name for this instance to be applied throughout Patchworks. |
Connection pool | If the connector associated with this instance has a concurrency limit and you have configured connection pools, these are available for selection here. To remove a connection pool associated with an instance, click the 'cross' icon: |
Time zone | Used to convert the time in any date/time filters that are applied when this instance is used in process flows. |
Date format | The expected date format when this instance is used in process flows. |
Rate limit amount Rate limit unit | Determines the rate at which Patchworks is allowed to make API requests to the associated system when using this instance of the connector. If the rate limit for an instance is exceeded, remaining requests are queued and sent when the rate limit is released again. Default settings are provided but you may need to adjust this to suit your specific needs. For example, you might have a plan which allows you a higher rate limit, or you might have multiple instances for the same connector running at the same time, which all need to share a rate limit. If you're not aware of any specific requirements, leave the default settings as they are. |
For more information see our page.
Any instances that have been added for your installed connectors are displayed with those connectors on the manage connectors page - for example:
For information please see Accessing your connectors.