# Adding a service connector

## Introduction

In Patchworks, you can add **live** and **test** connectors using our intuitive **connector wizard**. Before adding a new connector, you will need:

* System credentials for your live/production environment (if you are adding a **live** connector)
* System credentials for your sandbox environment (if you are adding a **test** connector)
* To have completed any prerequisite steps specified by your system provider (for example, some systems require specific steps in their admin console to allow access by third-party systems.&#x20;

{% hint style="warning" %}
You can have one **testing** connector and one **live** connector per system (for example,  Shopify), **per company group**. \
\
If you require multiple live connectors for the same system (for example, you might have three Shopify stores for three different countries) you should ensure that [company groups](https://doc.wearepatchworks.com/product-documentation/patchworks-services/service-connectors/broken-reference) are added to your company profile.
{% endhint %}

## The steps

**Step 1**\
Select **connectors** from the left-hand navigation menu:

<div align="left"><figure><img src="https://content.gitbook.com/content/5mpqoXPMbUuPa8JpCLWe/blobs/8TzI9N7BJJ7W0uWSQ1Ca/add%20connector%20wizard%20a.png" alt=""><figcaption></figcaption></figure></div>

...the **manage your connectors** page is displayed:

<figure><img src="https://content.gitbook.com/content/5mpqoXPMbUuPa8JpCLWe/blobs/OWlCyHfQtkp3YVQJYqmi/all%20connectors.png" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
By default, the **live** **connectors** tab is displayed and you'll see any existing connectors that you've defined for live system environments. If you also have connectors defined for testing, you can access these via a **testing** tab - for example: \
\
![](https://content.gitbook.com/content/5mpqoXPMbUuPa8JpCLWe/blobs/WyYzJlCx0kz3Qq8o4JAo/testing%20connectors.png)
{% endhint %}

**Step 2**\
Click the **add connector** tile:&#x20;

<figure><img src="https://content.gitbook.com/content/5mpqoXPMbUuPa8JpCLWe/blobs/iCrsNTkkMgkruic8n1xG/add%20connector%20wizard%20b.png" alt=""><figcaption></figcaption></figure>

**Step 3**\
Select the system that you'd like to associate with this new connector

<figure><img src="https://content.gitbook.com/content/5mpqoXPMbUuPa8JpCLWe/blobs/MnH1KYeyREb9V3TeoYkJ/add%20connector%20wizard%20c.png" alt=""><figcaption></figcaption></figure>

**Step 4**\
The **connector wizard** is launched - this will walk you through all setup needed to create the connector:

![](https://content.gitbook.com/content/5mpqoXPMbUuPa8JpCLWe/blobs/El1CfCylYSjjvYKDvUOr/add%20connector%201.png)

On this first page, add general details as summarised below:

| Field                                            | Summary                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| ------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name[^1]                                         | Enter a name by which this connector should be identified throughout the system.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| Group[^2]                                        | <p>If your company is set up in Patchworks with multiple <a href="broken-reference">company groups</a>, use this dropdown list to choose which group this connector is for. <br><br>You can only have one <strong>live</strong> and one <strong>test</strong> connector per system, per <a href="broken-reference">company group</a>. If you require multiple live connectors for the same system (for example, you might have three Shopify stores for three different countries) you should ensure that <a href="broken-reference">company groups</a> are added to your company profile. </p> |
| [Testing or live system](#user-content-fn-3)[^3] | Use this dropdown list to choose whether this connector is for a test system, or live.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |

**Step 5**\
Click the **next step** button to continue to **timezone and date format** settings:

![](https://content.gitbook.com/content/5mpqoXPMbUuPa8JpCLWe/blobs/jXr9byEftQ2oX3BaKmhh/add%20connector%202.png)

Complete details on this page using the table below as a guide:

| Field                                 | Summary                                                                                                                                                                                                                                                                                                 |
| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Time zone](#user-content-fn-1)[^1]   | Use this dropdown list to choose the timezone in which you expect this connector to run.                                                                                                                                                                                                                |
| [Date format](#user-content-fn-2)[^2] | <p>Each time data is synced in Patchworks, dates are converted to UTC so that all transaction times are consistent for reporting purposes. <br><br>The default setting here will be correct for typical systems - you only need to change this field if you know that your system is an edge case. </p> |

{% hint style="info" %}
If needed, you can use wizard step buttons at the top of the page to go back to a previous page:

![](https://content.gitbook.com/content/5mpqoXPMbUuPa8JpCLWe/blobs/EtcFbGZVXlPfBnw9w3rm/wizard%20steps.png)
{% endhint %}

**Step 6**\
Click the **next step** button to continue to **authentication type** options - for example:

![](https://content.gitbook.com/content/5mpqoXPMbUuPa8JpCLWe/blobs/yvopWmqrhwLGlGycSsjp/add%20connector%203.png)

Authentication types vary from one system to another - in some cases, only one type is available, in others there will be multiple options.

**Step 7**\
Click the **next step** button to continue to **credentials** settings:

![](https://content.gitbook.com/content/5mpqoXPMbUuPa8JpCLWe/blobs/d2QpsHkSUuGziBEfH7iZ/add%20connector%204.png)

Required credentials will vary, depending on which system and authentication type you selected.

{% hint style="info" %}
Typically you will have received your credentials from the system provider directly, or sometimes they can be obtained from that system's admin console.&#x20;

Patchworks cannot obtain these details on your behalf however our [systems](https://doc.wearepatchworks.com/product-documentation/patchworks-services/service-connectors/broken-reference) section contains information that may help you to locate required information or complete prerequisite steps.
{% endhint %}

{% hint style="danger" %}
Credentials can be case-sensitive. Add them in the same case as they were given/displayed to you originally.
{% endhint %}

**Step 8**\
Click the **create connector** button to confirm details and add this connector.

[^1]: See item 1 in the screenshot above.

[^2]: See item 2 in the screenshot above.

[^3]: See item 3 in the screenshot above.
