Freight and Shipping Tools
  1. EBMS Knowledge Base
  2. Sales
  3. Freight and Shipping Tools

Interfacing UPS WorldShip with EBMS

Jump to: Connect EBMS and WorldShip | Connect Fields | Export Info to EBMS | Mapping Table

The EBMS Shipping Manager module allows the importing and exporting of address and tracking information between UPS WorldShip and EBMS. UPS WorldShip is a shipping Software provided by UPS (United Parcel Service) to weigh packages and print shipping labels before shipping.

The EBMS software can push the shipping preferences selected within the EBMS order entry system. Shipping details such as the customer's name, email address, destination address, insurance options, etc. are pushed directly to UPS. Shipping details such as tracking information can be communicated from UPS WorldShip back to EBMS. Shipment and Insurance costs returned from UPS WorldShip can then be applied to the Invoice total.

The configuration the UPS WorldShip interface is a technical process that should be handled by the company IT staff or other technical individuals. This section includes multiple steps. Please complete all steps before using the WorldShip interface with EBMS. 

Complete each of the following steps to interface EBMS to WorldShip:

  1. Network the UPS WorldShip shipping computer to allow access to the EBMS data.

  2. Add UPS to the shipper list. Review Set Up Shippers for instructions.

  3. Configure an ODBC driver on the shipping computer. Review Configuring ODBC Database Drivers for instructions.

  4. Configure the communication to pull shipping information from the EBMS software: Complete the following steps to launch the UPS WorldShip Connection Assistant to map communication to import shipping information from EBMS:

  • Launch the UPS WorldShip software and Select Import-Export > Tools Connection Assistant as shown below:
  • Select Create a New Map for Import option as shown above and click Next.  
  • Select Shipment as the Import Data Types option and click Next to open the following wizard page:
  • Select the EBMSUPS ODBC Sources as shown above. Review the Configuring ODBC Database Drivers if the EBMS ODBC driver source does not appear.
  • Set the EBMS username as the ID and Password that is used to access EBMS data. The username and password should be set with the same credentials as the ODBC driver.   The username must be prefixed with the 3-character EBMS Company ID found in File > Company Information > Advanced tab > Company ID. In the User Name example shown above, the QUA represents the Company ID and the UPS text is the username.  Review the Creating Users and Assigning Rights for more details on creating users and setting passwords.
  • Click Next to open the next page as shown below:
  • Select New Map and enter EBMSUPS into New Map Name entry as shown above and click Next.
  • Click Finish to complete the wizard and open the following import map dialog.

Complete the following steps to connect the UPS WorldShip Shipment Information field:

  1. Select ARSMSHIP from the ODBC Tables drop-down menu, as shown above.
  2. Select Shipment Information from the WorldShip Fields drop-down menu.
  3. Click on the METHOD field from the ODBC Tables > ARSMSHIP fields in the left column and click on Service Type in the right column.
  4. Click the Connect button to associate the EBMS field to the WorldShip field.

Complete the following steps to connect the UPS WorldShip Ship To fields:

  1. Change the WorldShip Fields drop-down setting to Ship To but keep the ODBC Tables set to ARSMSHIP.
  2. Select the INVOICE field from the ODBC Tables > ARSMSHIP field in the left column and the Tax_ID field from WorldShip Fields > Ship To and clicking the Connect button.

Connect each EBMS ODBC field with the corresponding WorldShip Ship To field described within the import field mapping table at the end of this section.

Connect each EBMS ODBC field within the ODBC Tables > ARSMSHIP table with the corresponding WorldShip Fields > Package field as listed in the mapping table at the end of this section.

Connect each EBMS ODBC field within the ODBC Tables > ARSMSHIPDET table with the corresponding WorldShip Fields > Package field as listed in the mapping table at the end of this section.


Define Primary Key for Import by selecting the INVOICE Column Name within the EBMS ODBC Table > ARSMSHIP and clicking the Define Primary Key for Import button, as shown below:


Associate child EBMS files to ARSMSHIP tables by completing the following steps:

  1. Click on the Define Foreign Key Relationships button to open the following dialog:
  2. Since the main EBMS shipment export table is ARSMSHIP, select ARSMSHIP in the Relate From: table and select ARSMSHIPDET in the Relate To: table, as shown above. In EBMS, ARSMSHIP stands for A/R Shipping Manager and ARSMSHIPDET stands for A/R Shipping Manager Detailed.
  3. Select the main key field ARSMSHIP > AUTOID in the lower left pane and relate to the ARSMSHIPDET > SHIP_AID field in the lower right pane and click Add Relationship button.
  4. Click OK to Save.

Complete the following steps to launch the UPS WorldShip Connection Assistant to map communication to export tracking and billing information to EBMS:

  1. Launch the UPS WorldShip software:

  2. Select Import-Export > ToolsConnection Assistant from the WorldShip menu to launch the following wizard:

  3. Select Create a new map for Export option as shown above and click Next.

  4. Select Export Data Types option to Shipment as shown above and click Next.

  5. Select the EBMSUPS ODBC Sources as shown above. Review the Configuring ODBC Database Drivers if the EBMS ODBC driver source does not appear.

  6. Set the EBMS username as the ID and Password that is used to access EBMS data. Use the same username and password described earlier in this article. Click Next to continue to the next page as shown below:

  7. Select the New Map option and enter a New Map Name such as UPSEBMS since the data will be exported to EBMS. Click Next.

  8. Click Finish to complete the wizard and open the following export map dialog.

Select the WorldShip Fields drop-down setting of Shipment Information and select ARSMSHIPINFO from the ODBC Tables drop-down menu. Map each WorldShip field to the corresponding EBMS field as shown above. Utilize the export field mapping table below to identify the appropriate field association.

How to group multiple packages in UPS WorldShip:

The following steps are needed to configure and group multiple packages within UPS WorldShip. The step is done to connect multiple packages with a common tracking number. This option will allow the user to attach multiple packages, including WorldShip calculated handling fees, to a single EBMS invoice. This option may not be important if the cost is calculated within the EBMS sales invoice rather than calculated by WorldShip.

Set the following additional WorldShip Fields for Shipment Information settings to group multiple packages:    

    1. Copy the Shipment Information > Total Shipment and Handling Published... within WorldShip to the ARSMSHIPINFO > SHIP_COST field instead of copying Package > Package Published Charge to ARSMSHIPINFO > Cost.

    2. Copy the Shipment Information > Lead Tracking Number within WorldShip to the ARSMSHIPINFO > TRACK_NO instead of copying Package > Tracking Number. See the details within the export field mapping table at the end of this section.

    3. Click OK to save.

Select the WorldShip Fields drop-down option of Ship To and map each WorldShip field to the corresponding ODBC Tables > ARSMSHIPINFO field, as listed in the export field mapping table below.

Select the WorldShip Fields drop-down menu option of Package and map each WorldShip field to the corresponding ODBC Tables > ARSMSHIPINFO field as listed in the export field mapping table.


Complete the following steps to set up automatic exports:  

This automatic process is important to push information back to EBMS after WorldShip as processed the shipment.

Select Import-Export > Export After Shipment Processing from the main WorldShip menu as shown below:


Select the More... option from the submenu to select the EBMS export table as shown below:

Select the UPSEBMS ODBC DSN file as shown above. In this example, the ODBC DSN is listed as EbmsData. Review the Configuring ODBC Database Drivers if the EBMS ODBC source does not appear.

Click Export to select the EBMS file to export automatically. The UPSEBMS file will appear on the menu as shown above.


Test the connection between EBMS and UPS WorldShip:

Review Using EBMS Data within UPS WorldShip to test connection.

Go to Import-Export > Create/Edit Map to edit the field mapping relationships between EBMS and UPS WorldShip if any information is not being copied between EBMS and UPS.


Import map will read from the EBMS ARSMSHIP and ARSHIPDET tables via the ODBC Connection and import into WorldShip.

Export map will copy data to the EBMS ARSMSHIPINFO table from the ARSMSHIP in the ODBC Tables drop-down.

Field Mapping Table

EBMS Table UPS Import Fields UPS Export Fields EBMS Table
ARSMSHIP Shipment Information Shipment Information ARSMSHIPINFO
METHOD Service Type Service Type SRVC_TYPE
ARSMSHIP Ship To Collection Date SHIP_DATE
INVOICE Tax_ID (needed for write back) Package (Alternative fields when grouping multiple packages in WorldShip) ARSMSHIPINFO
C_NAME Company or Name Total Shipment and Handling Published... COST
C_ADDRESS1 Address 1 Lead Tracking Number TRACK_NO
C_ADDRESS2 Address 2 Ship To ARSMSHIPINFO
C_CITY City or Town Tax ID INVOICE
C_STATE State / Province / County Residential Indicator RESIDENTL
C_ZIP Postal Code Package ARSMSHIPINFO
C_COUNTRY Country / Territory Void Indicator VOIDED
C_PHONE Telephone Package Published Charge (ignore setting if packages are grouped) SHIP_COST
C_EMAIL Email Address Tracking Number TRACK_NO
RESIDENTIAL Residential Indicator Weight WEIGHT
ARSMSHIP Package Reference3 ID
PO_NO Reference 1    
C_ID Reference 2    
NTF_OPT QVN Option    
C_EMAIL QVN Failed Email Address    
NTF_MEMO QVN Memo    
INSURE_CHG Declared Value Option    
INSURE_AMT Declared Value Amount    
COD_OPTION COD Option    
COD_AMOUNT COD Amount    
LIFT_GATE not used    
SHIPPER not used    
RECNOS not used    
ARSMSHIPDET Defined as a Foreign Key Package    
ARINV_AID SHIP_AID