ODBC: Add a Store to ShipWorks
ShipWorks gives you the ability to connect to an external data source through ODBC (Open Database Connectivity). The ODBC connection can be used to both import data into ShipWorks and to export data from ShipWorks to an external data source.
-
In order to add an ODBC store to ShipWorks you must be running version 5.4 or later. You can check your current version of the ShipWorks software by clicking on the Help tab and then on the About ShipWorks button.
So that you can be sure that you have access to all of the latest tools and features that ShipWorks has to offer and so that you can ensure the steps in this article will work for you, we recommend making sure that you are running the latest version of the ShipWorks software. See our How Do I Upgrade ShipWorks help article for assistance with checking your version of ShipWorks or with upgrading to the latest version.
-
You will also need to be logged in to ShipWorks as a user with rights to add and/or edit a store.
-
Warehouse customers adding more than one ODBC store to ShipWorks will be prompted with an additional setup screen specific to configuring ODBC for Warehouse.
1. On the Setup Import Data Source screen, click the Data Source: drop-down menu and select the data source to which you wish to connect.
Note
If the data source to which you are attempting to connect is not shown in the list, you can click the Manage Data Sources button to open the Windows ODBC Data Source Administrator dialog from which you can add a custom data source. You may need to consult with your system administrator for information on how to add your data source.
2. If required, enter the username and password.
3. It is possible to test the connection to your data source by clicking on the Test Connection button. A dialog box will notify you of a successful connection or display an error message if the connection was not successful.
4. Once you have a successful connection, click Next.
There are several options available to you on the Import Settings screen. Let's take a look at these options.
NAME: You can assign a custom name to your data source within the ShipWorks software.
LOAD MAP: If you previously created an ODBC connection in ShipWorks, you can use this button to import a saved map of your ODBC settings. Since we are setting up your ODBC connection for the first time, we will skip this step.
DOWNLOAD: Allows you to specify how orders are imported into ShipWorks.
-
Orders by last modified date: Selecting this option tells ShipWorks to only import orders that are newer than the date and time of the last import.
-
All orders: Selecting this option tells ShipWorks to import all orders from your data source each time an import occurs.
-
On order search only: This option allows you to import specific orders only when a barcode is scanned.
COLUMN SOURCE: Allows you to specify from where you wish to import your data.
-
If you will be importing your data from a table, see the next section Importing From a Single Table.
-
Importing using a custom query? Jump to the Importing Data Using a Custom Query section.
Query: If your data will be imported from multiple tables or if you need to write a custom query, select this option. When selected, you will be given the following options:
-
Subquery(Recommended)
-
When subquery is selected, ShipWorks will use your query and filter the results based on the selected download option.
-
-
Parameterized Query
-
When Parameterized Query is selected, ShipWorks will give you a parameter to use when writing your query based on the selected download option. ShipWorks will run your query as is. This option is best for users who want full control over the import query or users whose ODBC driver does not support subqueries.
-
Warning
Custom query is an advanced feature meant to be used by customers who are familiar with SQL, etc. The software does not validate the queries used and incorrectly specified queries may adversely affect or corrupt your data. Click OK to accept this statement.
You will now be able to enter your query. You can test your query by clicking on the EXECUTE QUERY button. Remember, this will execute a live query against your data source. The top 25 results will be listed for your review.
Once you have all of your settings selected correctly on the Import Settings screen, click Next.
Continue with Column Mappings.
On the Column Mappings screen you will map the data from your data source to the available fields in ShipWorks.
Use the Item Settings section to specify how line items on your orders are to be handled.
All Items on a Single Row
A Single Row: Select this option if all of the line items for an order are on a single row.
Next, select the maximum number of line items that the orders will contain. Note that the Column Mappings column will automatically add a separate line item mapping for the number of items that you select.
If the line items on the orders have additional attributes that need to be mapped, select the number of attributes.
Line Items are on Multiple Rows
Multiple Rows: Select this option if the line items are on separate rows.
Next, select the column that uniquely identifies each order.
If the line items on the orders have additional attributes that need to be mapped, select the number of attributes.
The Column Mappings section allows you to map the data from your data source to the fields in the ShipWorks database. Please note that any fields indicated with a red asterisk ( * ) requires mapping.
Map the columns from your data source to the fields in ShipWorks by selecting the correct column form the Source Column drop-down menu for each row in the Column Mappings section, matching your source to the correct ShipWorks field.
Be sure to map the appropriate columns for the Order, Address, and Item sections.
Once all of your mappings are correctly completed, click Next.
On the Upload Options screen, select how you would like for ShipWorks to upload shipment details for your store. You have three available options.
a. Do not upload shipment details: Nothing is uploaded to any data source.
b. Upload shipment details to the same data source: Uploads shipment details back into the same data source that you have selected for importing. (see this section below)
c. Upload shipment details to a different data source: Select this option if you need to upload your shipment details into a separate data source from the source you selected for import. (see this section below)
1. Select the upload Shipment details to the same data source option. Then click Next.
2. The Upload Settings screen has several options. Let's explore them.
Name: You can assign a custom name to your data source within the ShipWorks software.
Load Map: If you previously created an ODBC connection in ShipWorks, you can use this button to import a saved map of your of your ODBC settings. Since we are setting up your ODBC connection for the first time, we will skip this step.
COLUMN SOURCE: Allows you to specify to where you wish to export your data.
Table: If all of your data will be exported into a single table, select this option. With Table selected you can then select to which table you will be exporting your data from the Table: drop-down menu.
Query: If your data will be exported into multiple tables or if you need to write a custom query, select this option. You can then enter your query in order to specify to where your data will be imported.
Warning
Custom query is an advanced feature meant to be used by customers who are familiar with SQL, etc. The software does not validate the queries used and incorrectly specified queries may adversely affect or corrupt your data. Click OK to accept this statement.
3. You will now be able to enter your query. You can test your query by clicking on the Execute Query button. Remember, this will execute a live query against your data source. The top 25 results will be listed for your review.
4. Once you have all of your setting selected correctly on the Upload Settingsscreen, click Next. (proceed to step 14 below)
1. Select the Upload shipment details to a different data sourceoption. Then click Next.
2. Please review how to connect to an external data source. Then, once connected to your data source, continue with Uploading Your Column Mappings.
1. On the Column Mappings screen, match the ShipWorks Fields to the source columns to which you would like the data to upload. Fields with a red asterisk ( * ) are required fields. Be sure to map the Shipment and Address fields as needed.
2. Once all of your source columns are mapped, click Next.
On the Store Setup screen, you can select the number of days of orders that you would like ShipWorks to import on the initial download. You can also specify whether or not you wish for ShipWorks to upload tracking information after a shipment is processed for this store.
1. To select a number of days of orders (other than 30) for ShipWorks to download, click the Edit link. (Only available when importing orders by Last Modified Date.)
2. Then, enter the number of days into the 'ShipWorks will download orders starting from: field. (Only available when importing orders by Last Modified Date.)
3. To disable ShipWorks from automatically uploading shipment data after processing a shipment, uncheck the box next to 'Update my online orders with the shipment details.'. (This option is not available if you selected Do not upload shipment details.)
4. Click Next.
CONGRATULATIONS!! You are now connected to your ODBC data source. Click Finish.
Still Need Help?
Please feel free to reach out to one of our awesome Technical Support Representatives in St. Louis. We are happy to help.
Have a comment to share about this article? We'd love to hear from you. You must be logged in to your Support Portal account to leave a comment.
Comments
0 comments