UPS WorldShip

From NewHaven Software Wiki

(Difference between revisions)
Jump to: navigation, search
Line 61: Line 61:
*Ship To::Residential Indicator <-> EXTERNAL_SHIPPING::RDI
*Ship To::Residential Indicator <-> EXTERNAL_SHIPPING::RDI
**Note that Worldship tries to write an Y/N for this value where CMS is expecting a 1/0 so you must use the translation option in Worldship per this video -
**Note that Worldship tries to write an Y/N for this value where CMS is expecting a 1/0 so you must use the translation option in Worldship.
=Setting up UPS Auto Import XML=
=Setting up UPS Auto Import XML=
For information on this please visit
For information on this please visit

Current revision as of 20:22, 10 September 2019



When shipping via UPS you have several options available to automated the transfer of package information from CMS to UPS. Using one of these integration options will streamline your shipping procedures and keep your shipping staff from having to type in any address or package information. This article will describe the available methods and how to configure CMS and Worldship for that integration.

  • Keyed Import method - The most commonly used. This connects Worldship to your CMS database so you can type or scan in a CMS package number in Worldship and it will retrieve the necessary package information from your CMS database. CMS can either pass the weight of the package to Worldship, you can have an electronic scale attached, or you can key in the weight into Worldship. For fast and accurate shipping we recommend using with an electronic scale. (Be sure to discuss with your UPS rep if you need a scale or any other hardware for shipping since they have technology allowances for most UPS shippers where they will pay for or provide a certain amount of hardware.)
  • XML Integration method - Our newest and most efficient integration. All shipping is done from the Manifest screen in CMS in a similar keyed import style as above. With this integration method CMS is able to "push" the package information to Worldship and tell it to print a label. This integration is identical to the Endicia integration for USPS shipping so your shipping staff has only one program and procedure to learn. The XML integration handles multiple package shipments much more efficiently as well.
  • Export - This was the earliest version of integration and is no longer supported as of version 7.0. This method required adding packages to the manifest and then exporting them in a batch to Worldship. Worldship can then print those labels in a batch as they are imported or one by one in a keyed import style. This style requires matching labels to packages after printing instead of immediately printing an individual label as the package is handled. This option is available only up to CMS version 6.0.3.

Keyed Import Method


The following is a list of instructions for first-time setup of Worldship with CMS.

  1. Copy the following pair of files from your CMS network drive to your c:\ProgramData\UPS\WSTD\IMPEXP\Shipment\ directory:
    • CMSPackages.dat
    • CMSPackagesExport.dat
    • (NOTE: You may or may not see the .dat at the end of the file name, depending on your system configuration.)
  2. Create a new DSN record in the ODBC Data Source Administrator that will allow the CMS System to communicate directly with UPS WorldShip. This is found by clicking the Windows Start button, then Settings, Control Panel, Administrative Tools, and then Data Sources (ODBC).
    • Once opened, select the System DSN tab, and then click the Add button.
    • Select Adaptive Server Anywhere 12.0, and then select Finish.
    • On the ODBC tab, enter CMSPackages for the Data source name, paying close attention to this CASE SENSITIVE name. It is important that this DSN be named exactly as it must match up with an existing UPS WorldShip map.
    • On the Login tab, enter cmsuser for the User ID and Password. The Password field will display only asterisks.
    • On the Database tab, the Server name is the CMS Sybase Server Name, not the server’s Windows name. The default name is NHSDataServer. The Database name is the CMS database, which is usually your company name.
    • Select OK.
  3. Repeat the steps above for another DSN named CMSPackagesExport.
  4. Next open UPS WorldShip.
  5. Click on Import/Export Data->Automatic Export During End-of-Day, and select Off.
  6. Click on Import/Export Data->Automatic Export after Processing Shipment, and select More.
  7. Choose CMSPackagesExport from the box and click Export.
  8. Click Import/Export Data->Keyed Import, and select CMSPackages (if it's on the list). If it is not, then select More, and choose it from the resulting popup.

Setting up multiple CMS companies/databases in WorldShip

  1. Follow the steps above to create the ODBC connections for CMSPackages and CMSPackagesExport.
  2. Create one of each ODBC connection to each CMS database that will be exporting to & importing from WorldShip. Remember that these names will be case-sensitive!
  3. Right-click these two files from the NewHaven Software directory on the CMS server and select Copy:
    • CMSPackages.dat
    • CMSPackagesExport.dat
  4. Navigate to the WorldShip install directory (for WorldShip 10 and above, this will be <drive letter>:\UPS\WSTD\ImpExp\Shipment), right-click anywhere inside this folder, and select Paste.
  5. Open UPS WorldShip.
  6. Click Import/Export Data->Connection Assistant...
  7. Select 'Create a new map for Import' and click Next.
  8. Select 'Shipment' from the Import Data Types drop-down, and click Next.
  9. Click the 'By Known ODBC Source' radio button, and select the DSN for your first CMS company. Click Next.
  10. Click the 'New Map based on existing map' radio button, enter a New Map Name that matches the DSN exactly, and select the CMSPackages map in the list. Click Next.
  11. Click Finish.
  12. Click OK in the resulting popup.
  13. When asked if you want to batch import, say No.

Repeat these steps for each company you want to set up.

To import from a given CMS database, simply click Import/Export Data->Keyed Import-><mapping_name> (if you haven't imported from a given company before, you'll need to select Other... and pick the mapping from the resulting popup.

Field Mappings


Field mappings used by Worldship to write back shipped package data to CMS's External_Shipping table.

  • Shipment Information::Service Type <-> EXTERNAL_SHIPPING::UPS_SHIPMETHOD
  • Package::Weight <-> EXTERNAL_SHIPPING::WEIGHT
  • Package::Tracking Number <-> EXTERNAL_SHIPPING::TRACKING_NUMBER
  • Package::Package Reference Charge <-> EXTERNAL_SHIPPING::COST
  • Ship To::Residential Indicator <-> EXTERNAL_SHIPPING::RDI
    • Note that Worldship tries to write an Y/N for this value where CMS is expecting a 1/0 so you must use the translation option in Worldship.

Setting up UPS Auto Import XML

For information on this please visit

Personal tools