Introduction

Welcome to the admin guide, this is where we will discuss how to install and configure the ILC Shipworks Integration service.

Installation

The installer will ask what folder you'd like to install to, what name you'd like to see in the start menu, ask if you'd like a desktop shortcut, and then review your selections.

After installing the files it will ask to launch, which will open the admin control panel.

Configuration

The admin control panel is where you can configure the database, api server, integration and behavior settings. All of these are also contained in the json config file located in the installation path if you'd like to edit them in a text editor.

Once configuration is complete, click on save, then close the window

Navigate to the Installation folder: C:\Program Files (x86)\ILC ShipWorks Integrator, open a command prompt or powershell and run the ShipWorks.Fishbowl.Service.exe
C:\Program Files (x86)\ILC ShipWorks Integrator>ShipWorks.Fishbowl.Service.exe

It should look something like this:

You can check the Service if it started correctly via the URL

You will also need to check that the integration is confirmed under Fishbowl Integrated Application found under Setup->Settings->Integrated Apps in Fishbowl

ShipWorks Configuration

Ensure ShipWorks is properly installed and licensed, a trial account can be used but make sure to apply a license at a later date.

Launch ShipWorks, open the Manage tab, and click on Stores. This will open the Manage Stores pop up dialogue. Click the Add Store button and follow the initial set up process.

Select "Generic - Module" and click next.

Enter the following data from the configuration file and click next:

• Username: Fishbowl Location Group

• Password: AuthPass value

• Module URL: The full URL that is accessible from all ShipWorks clients with the URL Key as below

Edit the store and contact information as needed

At the end you will be presented with options on how far back to download orders. By default the application will download only SHIPMENTS, not Sales Orders
Always keep the "Upload the shipment tracking number" option checked

Process a sales order into the Entered Status in Shipping for the order to appear in ShipWorks

Download orders from Fishbowl into ShipWorks via the download button under the Home tab

After you have verified that you can download orders, close the command prompt and start the service SWFB - DEFAULT in windows.

Data Mapping

The SQL folder contains the queries used to pull fishbowl data that is sent to ShipWorks. You can manually edit these queries to adjust the mapping but be very careful to back up the original files so they can be reverted in case there are any syntax errors that may break the integration.

Order Header

The order header sql maps information about the overall shipment including order number, carrier settings, shipping address, and custom fields.

Order Items

The order item sql contains mapping information for the line items of the shipment that are being sent to ShipWorks. This includes product, description, and pricing information as well as pack dimensions, weight, and custom field data.