TECH REF: UPS Shipping Module

See Also

 

Quick Links:

 

UPS Shipping FAQ

 

 

Attention existing OmniRush systems (v5 / v6) configured for UPS shipping:  When OmniRush v8 is installed, the existing UPS functionality will be disabled until the v8 setup procedures are done.  This includes installation of ShipRush v3, and conversion to new templates.

 

UPS Shipping Setup:

The OmniRush UPS Module is bridge to the ShipRush UPS Pro SDK.  If ShipRush UPS Pro is already in use by desktop users, OmniRush can use it also.  If not, ShipRush UPS Pro can be installed on the OmniRush Server PC.

 

Configuration Options:

Stand Alone. ShipRush UPS Pro is installed on the OmniRush Server and is used only by OmniRush:

 

 

 

Multi-Use ShipRush-Centric. Existing ShipRush UPS Pro Server used by ShipRush Client users & the OmniRush Servers. Shipments are submitted via CRM/SQL system and the ShipRush GUI:

 

 

 

Multi-Use OmniRush-Centric. OmniRush and the ShipRush UPS Pro server are all on one PC. Shipments are submitted via CRM/SQL system and the ShipRush GUI:

 

 

All of the options shown above result in a single end of day and manifest for all OmniRush and interactive ShipRush users. If separate end of day processes are desired for each process, then OmniRush should use the first setup above (Stand Alone), and interactive ShipRush users should either use ShipRush Basic Edition or ShipRush Pro Edition with the ShipRush Pro Server on its own PC (e.g. a PC other than the OmniRush Server PC).

Advanced Configuration Steps

It is advised that the ShipRush Client on the OmniRush server be set to use direct ADO database access to the ShipRush server. This is advised in all configurations, even when the ShipRush server is installed on the OmniRush server.

Operating Environment

OmniRush is consuming the ShipRush UPS Pro SDK. This means the following:

 

  1. ShipRush UPS Pro, either Network Server or Client (if ShipRush v3 Pro Server is installed elsewhere on the network) is installed and operational on the OmniRush Server PC.

  2. ShipRush UPS Pro printing has been tested from the OmniRush Server PC

  3. OmniRush is logged in to Windows as the same user that configured and tested ShipRush above.

 

Why is #3 important? Because ShipRush maintains its configuration under the 'user profile' directory (at a command prompt, type set userprofile to see the current location). For example, for user Administrator, this directory might be:  

    "C:\Documents and Settings\Administrator\"

 

ShipRush Pro stores its configuration data in a directory underneath the user profile directory:

    "C:\Documents and Settings\Administrator\Application Data\z-firm llc\shiprush ...\"

 

This is significant because OmniRush requires that the ShipRush environment be operational. Since the ShipRush environment is dependent on the logged in user name, the OmniRush UPS shipping server may function as user 'A' but fail to run as user 'B.'

 

To rectify a situation in which the NT user name for OmniRush will change, two approaches are possible:

 

Copy Files Approach

 

In this approach, you manually create the ShipRush run time environment. For example, ShipRush was configured under user 'Administrator' but OmniRush will run as user 'ORUser.' In this case, we will simply copy all the contents of directory:

 

    "C:\Documents and Settings\Administrator\Application Data\z-firm llc\shiprush v3\"

 

To directory

 

    "C:\Documents and Settings\ORUser\Application Data\z-firm llc\shiprush v3\"

 

Note that "C:\Documents and Settings\ORUser\" should already exist before you attempt this copy operation. If it does not, that may not actually be the correct target directory.

 

Log In And Configure Approach

 

In this approach, simply log in to the OmniRush PC as the target user and start ShipRush. The ShipRush wizard will start. Go through the wizard, and at the end ShipRush will go to the Windows System Tray. Exit ShipRush and start OmniRush.

Operation:

During the day, as shipments are processed, they are actually processed by ShipRush.  The UPS track has a setting for Settlement Time.  At this time of day the Module will automatically:

 

  1. Trigger an End of Day in the ShipRush system, which:

    1. Prints the end of day bar code (which is scanned by the UPS driver)

    2. Prints the daily manifest (which lists all the shipments for the day with tracking #'s)

    3. Uploads the data file (aka PLD) file to UPS

Monitoring

There are different kinds of monitoring that can be done.

 

Shipment detail auditing / Accounting Dept Forwarding

 

Typically, this would be done by setting up a batch file to email the .TXT files in the \UPS Manifest\ directory to the accounting staff.  A simple batch file could scan for .TXT files, email them, and either delete or archive them.

 

Using ShipRush interactively, shipping history can be exported to CSV, XLS and other data formats.

 

Use the ShipRush v3 reporting feature to print reports or export shipment data to csv, excel, and other formats.

 

PLD Upload

The end-of-day barcode will indicate on it in clear text (near the bottom) if the PLD upload has been failing for more than a day.  Other ways of monitoring the upload are:

 

  1. Checking the ShipRush End of Day list for the status (via the View Shipments area of ShipRush)

 

Rate Files and Fuel Surcharges

Shipment rate file data is part of the ShipRush system.  New rates are provided with ShipRush updates.  

 

Fuel Surcharge

This is set in ShipRush Settings.

 

Overriding the Tracking URL

By default, OmniRush saves a tracking URL to the CRM/SQL system that can be used to track the shipment. In certain very specific cases, a site may need this URL directed to a custom tracking server of some kind.

 

This can be done with a registry key on the OmniRush Server machine. Use the carrier module needed:

 

HKLM\SOFTWARE\Z-Firm LLC\UPS Communication Module
HKLM\SOFTWARE\Z-Firm LLC\FedEx Communication Module
HKLM\SOFTWARE\Z-Firm LLC\Airborne Communication Module

 

Registry string name "TrackURLOverride"
Registry string format "http://url...%TRACKNO%...."

Sample registry value:
           http://my-custom-trackserver.mydomain.com/processRequest?tracknum=%TRACKNO%

%TRACKNO% will be replaced with shipment tracking number

 

UPS Shipping Module FAQ

I use my UPS Account # with other shipping software.  Can I use it with OmniRush also?

Yes.  A UPS Account number can be used concurrently with any number of shipping solutions, including those by UPS and third parties.

Do I need a modem to use OmniRush UPS shipping?

No. Any internet access method will work (e.g. DSL, T1, Cable, ISDN, etc.). A modem can also be used.

I do not have Internet access and want to use OmniRush UPS shipping.  Can I use a modem?  

During ShipRush setup, a dial up method and modem can be selected.

Can OmniRush do electronic call tags?

No.  Call tags are supported by the ShipRush for UPS software by Z-Firm.  See www.zfirm.com for information.

My software is configured to a kit of template names.  Do I have to change to the new templates?

No.  You can keep using the same template names.  Version 7 will accept either ZPK or FRU as the file extension for shipping templates.  The v7 sample templates are named FRU to differentiate them from prior versions.  The new templates can be renamed to ZPK to match the expected file names. Be sure to delete old templates, as they will fail with v7 of OmniRush.

What shippment parameters can I pass job by job?

The full list of OmniRush overrides is here.  

 

Shipment parameters (such as weight, size, class of service, etc.) can be defined %100 in the template, or can be set on the job with reference line codes.  Note that only a small number of shipment parameters can be set on the reference line.  These are:

 

Weight, Declared Value, COD Amount, COD Payment type

 

For example, this REF line for a regular ground shipment:

UPS_GND_BOX_1LB.ZPK

This will take all values from the template.

 

In this example, we override the weight, setting it to 12 lbs and the declared value, setting it to $1100:

UPS_GND_BOX_1LB.ZPK WGT:12 VAL:1100

 

In this example, we ship COD, with all the parameters coming from the shipping template:

UPS_COD_GND_1LB_10DOL.zpk

 

Now, we use the same template, but override the amount to $1100

UPS_COD_GND_1LB_10DOL.zpk COD:1100