Adding an instance
Introduction
Once a connector is installed or built using our connector builder, it becomes 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.
The steps
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 flow
s ➤ connectors & instances
to access the manage connectors
page.
Step 2 Find 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:

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:
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.
Step 6
Choose which authentication type
you wish to use for this instance, then click the next step
button:

Step 7 Enter valid credentials for this instance - for example:

Step 8
If the system associated with this connector requires a certificate to communicate with its server, click the certificates
option - from here, you can upload your certificate and (if required) enter the associated passphrase
:

Having entered authentication credentials and (optionally) added a certificate, click the next step
button.
Step 8
The instance is created for the associated connector and is now shown on the manage connectors
page - for example:

Last updated