# 1: Basic details

## Introduction

The first stage of adding a new system is to provide basic details - these determine how your system will be presented throughout Patchworks,

## What you need to do

**Step 1** \
Having[ launched the connector builder](/product-documentation/developer-hub/connector-builder/accessing-the-connector-builder.md), the **basic details** page is displayed - this is where you provide a name and other general details for your new connector:

<div align="left"><figure><img src="/files/Zz5BDjJMSbAsBKwsvAig" alt="" width="375"><figcaption></figcaption></figure></div>

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

| Field                                   | Summary                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Enter a name for your new system        | This name is displayed for this system throughout Patchworks - for example, in the [marketplace](/product-documentation/marketplace/the-patchworks-marketplace.md).                                                                                                                                                                                                                                                                                                                                                   |
| Enter a version for your new connector  | Enter version information for this connector - for example: Version 1 - 28th July 2023.                                                                                                                                                                                                                                                                                                                                                                                                                               |
| Enter a description for your new system | <p>Enter a description to provide a bit more information about this system. Text entered here is displayed beneath the connector title, whenever it is displayed in the system. For example:<br><img src="/files/AlrbJ0rxXUr0U5TwwgQ9" alt=""></p>                                                                                                                                                                                                                                                                    |
| Select system type                      | Choose the required system type (e.g. eCommerce, ERP, Warehouse) from the dropdown list. The selected system type may determine what options are prompted subsequently. It's also used to categorise this connector.is displayed in the [marketplace](/product-documentation/marketplace/the-patchworks-marketplace.md) for this system.                                                                                                                                                                              |
| Select protocol                         | Choose the appropriate protocol for your connector protocol. <img src="/files/SQLJTyh7dnCup0hVzTVb" alt="" data-size="line">For a REST or SOAP API, the protocol will be `HTTP`.                                                                                                                                                                                                                                                                                                                                      |
| Date format                             | Enter the expected date format for data received from or sent to this system.                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| Rate limit / Rate limit unit            | <p>Determines the rate at which Patchworks is allowed to make API requests to the associated system. You will usually find this information in the API documentation for the system you're building against. </p><p></p><p>The rate limit defined here is used as the default when anyone <a href="/pages/8b0V4AbjjCtqyMhraqE5">adds an instance</a> for this connector. If required, this default value can be changed per instance (for example, if you have multiple instances sharing the same rate limit).  </p> |
| Upload an icon                          | <p>Upload an icon to be displayed for this system throughout Patchworks - for example, in the <a href="/pages/uVJlVUDxjvJi3MgSFEPB">marketplace</a> and in the connector wizard when a connector is added for this system. The following image file types are supported:</p><ul><li>.jpg</li><li>.gif</li><li>.png</li><li>.svg</li></ul><p><strong>Note:</strong> Images must be square and the file size cannot exceed 10MB.</p>                                                                                    |
| Primary colour                          | Use the colour picker to select a background colour for your icon. This can be used to ensure that all of your connector icons are displayed in a consistent form: ![](/files/g1m3XC0jBrDjnRhivoAU)                                                                                                                                                                                                                                                                                                                   |

**Step 2**\
Having entered all required details, click the **next step** button for [connector variables](/product-documentation/developer-hub/connector-builder/building-your-own-connector/2-connector-variables.md).


---

# 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/developer-hub/connector-builder/building-your-own-connector/1-basic-details.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.
