The first stage of adding a new system is to provide basic details - these determine how your system will be presented throughout Patchworks,
Step 1 Having launched the connector builder, the basic details page is displayed - this is where you provide a name and other general details for your new connector:
Complete fields on this page using the table below as a guide:
Step 2 Having entered all required details, click the next step button for connector variables.
| Field | Summary |
|---|---|
Enter a name for your new system
This name is displayed for this system throughout Patchworks - for example, in the marketplace.
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
Select system type
Choose the required system type (e.g. eCommerce, ERP, Warehouse) from the dropdown list. The selected system type is displayed in the marketplace for this system.
Select protocol
Upload an icon
Upload an icon to be displayed for this system throughout Patchworks - for example, in the marketplace and in the connector wizard when a connector is added for this system. The following image file types are supported:
.jpg
.gif
.png
.svg
Note: Images must be square and the file size cannot exceed 10MB.
Primary colour
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:
Choose the appropriate protocol for your connector protocol. For a REST or SOAP API, the protocol will be HTTP.
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:
