The Local Connector is a utility application that can be installed on a PC/Server, for sending orders data from a source system to the GoSweetSpot back-end.
This runs as a Windows Service on the machine, hence it does not require any active users to be logged in for it to work.
Step 1: Download
Minimum requirement is Microsoft .NET Framework v4.6.1 (Latest installer click here)
Latest Local Connector installer click here. (Current Version: V2022.9.7.1)
Step 2: Installation
Run the installer with Administrator privileges.
Right-click on the file and select Run as Administrator.
Follow the installation process till the end. Please ensure you select Create a desktop shortcut
Step 3: Configuration
Once installed, you will find a new shortcut icon on your desktop. Double click to launch
Proxy/Firewall Settings
If your network is protected by a firewall or proxy server, you might need to enter more details.
The most common use case for the Local Connector is to monitor and upload file drops on the host server or PC.
On the app, you will be presented with a Connector#, which uniquely identifies your install.
On the Ship site, navigate to Administration --> Integrations.
Select Local Connector to get started.
You can provide a meaningful Nickname to this connection.
The Connector# should be from above, as it appears on the app.
The Folder to Monitor is the folder location your other application is dropping the files into. Note that this application runs as a windows service, so network drives will need to be verified as connected.
File Filter - the application only uploads text based files. You can provide *.* or an appropriate filter here.
Field Delimiter - select the appropriate field separator
Field Mapping - map the order of fields as they are on the source file.
Once done, click Save Changes. Sample file formats attached below.
One you have made any changes, these need to be refreshed on the program. Click on Restart Service to refresh the configuration. If this fails, you will need to restart the windows service manually. Use the command line below to restart the service.
Command Line
Since this program runs as a Windows Service, the restart the application, follow these instructions.
Search CMD from the Windows menu to find Command Prompt. Right-click and Run as administrator.
To Stop the Local Connector
net stop gsslc
To Start the Local Connector
net start gsslc
Field Mapping Template
Please note you do not need to use all field mapping and can leave them blank except for the columns in red above or below.
| Column | Description | Allowed Text/Max Length |
| Order No (Required) | This can be anything. It allows you to search for your consignment in "Tracking & History" with the Order # you enter. |
String / 30 e.g. 'SO1234' |
| Name (Required) | Company name or receiver name |
String / 60 e.g. 'GoSweetSpot' |
| Street (Required) | The street name and number. |
String / 60 e.g. '41 Station Road' |
| Suburb (Required) | The name of the suburb, if no suburb is provided enter the same details as you would for the "State" field. |
String / 60 e.g. 'Penrose' |
| City/State (Required) | The town or city. |
String / 60 e.g. 'Auckland' |
| Country (Required) | The A2 (ISO) country code. eg. NZ, AU, etc. |
Letters / 2 e.g. 'NZ' |
| Building | The unit number, shop number, company name, or building name. |
String / 60 e.g. 'Unit 5 GSS Building' |
| PostCode | The postcode of the address you are sending to. If unknown, set it to "0". |
String / 10 e.g. '1061' |
| Delivery Instructions | A note is printed on the label. |
String / 120 e.g. 'Delivery at the front door' |
| Phone | The contact's phone number. |
Numbers / 30 e.g '021234567' |
| The contact's email address. |
String / 100 e.g. 'support@gosweetspot.com' |
|
| Contact Name | The name of your receiver. |
String / 60 e.g 'John Sweetspot' |
| Signature Requirement | Indicates whether a signature is required upon delivery of the shipment. |
'Y' or 'N' / 1 e.g. 'N' |
| Sent TT | Indicates whether a Track & Trace email will be sent. Note that a valid email address will also be required if this is marked 'Y'. |
'Y' or 'N' / 1 e.g. 'Y' |
| Delivery Reference | This can be anything. It allows you to search for your consignment in "Tracking & History" with the Delivery Reference you enter. |
String / 30 e.g. 'R#1256' |
| Order No/Delivery Reference | Provides the same information to the Order No and Delivery Reference field. |
String / 30 e.g. 'Order#5142' |
| Service | If you set your settings to print immediately, you can determine the service for the order. |
String / 50 e.g. 'Overnight' |
| Courier | If you set your settings to print immediately, you can determine the courier for the order. |
String / 50 e.g. 'Post Haste' |
| Package Name | You can determine what package you would like to use. Ensure that the user has access and is the correct name of the package. |
String / 30 e.g. 'GSS-DLE Satchel' |
| Height (cm) | Height of the package in cm. |
Decimal / 16 e.g. '10.55' |
| Width (cm) | Width of the package in cm. |
Decimal / 16 e.g. '1.891' |
| Length (cm) | Length of the package in cm. |
Decimal / 16 e.g. '15.6712' |
| Weight (kg) | Weight of the package in kg. |
Decimal / 16 e.g. '20.1' |
| Package Count | Number of packages required. |
Integer / 16 e.g. '2' |
| Cubic (M3) |
The total cubic measurement of the shipment. Note, this will provide an even number for the LxWxH. However, if measurement is also provided this will be ignored. e.g., 0.125 m3 = 50x50x50 (cm) |
Decimal / 16 e.g. '0.125' |
Known Issues:
When monitoring Linux-based file shares, the file uploads are not real-time. They are normally cleared on a timely sweep of the folder.
Depending on how the files are created and how quickly the creator releases the lock on the file, the LC might show "Access Denied" against a file, and then successfully upload it a little later.
- csv_sample.csv929 Bytes
- field samples and definitions.xlsx10 KB
- pipe_sample.txt929 Bytes
- tab_sample.txt929 Bytes
- GSSLocalConnectorInstaller2022.9.7.1.exe3 MB