Software Documentation UPS Version 1.2 - FileMaker



Table of Contents NRGship Installation Mac OS X

1 1

Windows 2000/XP/Vista

1

First Time Setup Launch the Application

2 2

Licensing & Activation

3

15-day Demo

3

Paid Registration

3

UPS Account Setup

4

Configuring NRGship

6

Basic Info

6

Shipping Labels

6

Printers & Scales

6

QuickStart: Your First Shipment Using NRGship for UPS Screen Shot Tour

7 8 8

Ship Detail Screen

8

Options Screen

9

Rates and Selection Screen

10

Time in Transit Screen

11

Shipment Results Screen

12

Tracking

13

Address Book

14

Data Interchange

15

Import Scripts

15

Import Web .TAB File Import Web .XLS File Import Worldship .CSV File Import Yahoo Store Orders .CSV File Import X-Cart Orders.CSV File Import 3DCart Orders.CSV File Import Ship Data .TXT Import MYOB .TAB File Import Address Book from WorldShip Import Address Book from UPS Website Import Ship_In.XML Export Scripts Export Ship Response .TXT File Export WorldShip .CSV File Export XCart .CSV File Export Ship_Out.XML

16

16 16 16 16

Automation Scripts

16

Ship Found Set

16 16 16 16 16 16 16 16 17 17 17 17

Print Found Set Void Found Set Print Unprinted Laser Labels 2-Up Print Unprinted Laser Labels to Thermal Printer (WINDOWS ONLY!) Print Unprinted Labels to Thermal Track All Non-Delivered Packages Delete Ship Label Images > 15 Days Old Show Shipments Shipped not Printed Show Shipments Printed not Scanned Show Shipments with Exceptions MAC OS Features



15 15 15 15 15 15 15 15 15 15 15

Apple Backup QuickPick

17

Mac OS Address Book Integration

17

UPS Service FAQs Where is the Pickup Summary or "End of Day" Barcode?

18

Does NRGship support multiple UPS accounts?

18

How can I get FREE printer supplies?

18

Does NRGship support international shipping?

18

FileMaker Integration FileMaker Database Modifications

19 19

Integration Samples

19

Integration Scripts

19

External Integration Mac OS AppleScript Automation

19 19

Mac OS URL Automation

19

Post Shipment URL Handler

19

XML Schema

19

General Information



18

Multi-User Configuration

20 20

Upgrading From Previous Versions

20

FileMaker Extensions

20

Running Upgrade Scripts

20

Basic Setup and Integration Support

21

Purchasing NRGship

21

Contacting NRG Software

21

License Agreement

21

NRGship Installation Mac OS X Double-click on the Installer Script. It will install all required FileMaker plug-ins, OS X add-ons and create a folder in your Applications folder containing the solution database files. It will add necessary plug-ins to your FileMaker extensions folder and place zebra2844 and HIDScale into your Applications folder to support thermal label output and USB weight capture.

Windows 2000/XP/Vista Double-click on the NRGship installer. It will prompt you for a solution install location and allow you to choose your FileMaker Pro version for plug-in installation.

FileMaker Plug-in Management

During the installation process, the highlighted plug-in files below are placed into the FileMaker Pro Extensions folder on both Mac OS X and Windows.

FileMaker Extensions Folder

1

First Time Setup

Launch the Application Locate the folder where NRGship was installed. Double-click on the NRG_Package_UPSEd.fp7 file.

Solution folder after installation

The preferences layout will automatically open when you launch the application for the first time. If it is not open - simply click on the Preferences icon

which is located on the top right of the application.

2

Licensing & Activation The preferences window defaults to the Licensing tab. To get started, you must either request the 15-day demo period or bypass the demo by entering the Registration Code that you received at the time of your purchase.

15-day Demo Enter your company name and email address to request a 15-day demo period of the software. After doing so, a message will appear telling you that you can process up to 500 transactions over the next 15 days.

Paid Registration If you have already purchased NRGship - enter the registration code that was provided in your purchase confirmation.

Preferences Layout: Licensing

3

UPS Account Setup Once you have requested demo access or entered a license code, click the Open Wizard button to begin the UPS Licensing & Registration Wizard.

UPS Online® Tools Licensing & Registration Wizard – Step 1

Preferences Layout: Accounts

The wizard will run your through adding your UPS account for shipping. Click on Next to continue to Step 2.

4

UPS Online® Tools Licensing & Registration Wizard – Step 2

Read or print the UPS license by scrolling downward on the license text. Select the “Yes, I Do Agree” option and click on Next to continue to Step 3.

UPS Online® Tools Licensing & Registration Wizard – Step 3

Fill in ALL blanks and click Next to continue to Step 4. Note that the Postal Code you enter MUST match the Postal Code that matches your UPS Account Number. If you need to open a UPS account click on the link or call 1-800-PICK-UPS.

UPS Online® Tools Licensing & Registration Wizard – Step 4

Click Finish on Step 4 to complete the Licensing & Registration Wizard.

5

Configuring NRGship Once you have completed UPS account setup, you can adjust the default shipping values and label output settings by choosing Defaults within the Preferences layout.

Basic Info Default Account is the default account to use for new shipments. The name, address, city, state, zip code and phone will be auto-entered into the shipment based on the account settings. Package Type and Service are shipping defaults for new shipments Currency, Measurement and Weight are all default values based on your UPS account country of origin.

Shipping Labels Label Type allows you to select Laser, Thermal or Thermal DocTab as your default. If needed, you can select an alternate label path for label creation. Check the Ship and Print checkbox to automatically print labels upon shipment. Check the Delete on Delivery box to delete shipping label images upon delivery. (When set via the Track All function)

Printers & Scales Direct thermal (EPL) printing is supported on MacOS and Windows. On Windows to print to an Eltron/Zebra printer select the LPT Port which has been captured for the device. Network thermal printing is also provided for Eltron/Zebra printers with built-in or add-on print servers. These printers are great for environments where you would like to ship from multiple workstations with a shared label printer. Simply enter the IP# and username/password that is setup on the printer to direct thermal output to the shared printer. Mettler Toledo PS60 and Fairbanks Ultegra digital scales are supported when connected to serial ports on Mac or Windows computers. Keyspan USA-19HS serial to usb adapters have been fully tested and are recommended. Scales should be configured for UPS communications which is 9600 baud, 7 data bits, odd parity and two stop bits. USB scales which follow HID compliance can also be used. (MT PS60 Setup Info can be found in the Extras Folder)

6

QuickStart: Your First Shipment 1.

Open the NRGship solution

2.

Click on the Prefs button to set the application preferences. If you do not have a license key the software will work in demo mode for 15 days and will restrict you to 500 transactions

3.

Click Open Wizard to setup the UPS OnLine Tool preferences and complete the setup process

4.

After completing the Wizard adjust the solution preferences

5.

Click Exit to close the Preferences

6.

Back in the NRGship database, click New to create a new shipment record.

7.

Adjust the Ship To values and add a package

8.

Click on Ship to ship the package

9.

Click on Results to view ship results

10. Click View Label view the shipping label on-screen (non-thermal labels) 11. Click Print Label to print the shipping label to a thermal or laser printer Congratulations! You have just performed your first shipment direct from NRGship.

7

Using NRGship for UPS Screen Shot Tour Ship Detail Screen Click New to create a new shipment record. You must minimally enter the Shipper and Ship To information along with packaging type and weight for a single package. If you are shipping international or require ancillary services then you can set more values or click on the Options tab. Click Ship to ship your package. You can also retrieve Rates and Services or Time in Transit by clicking on the appropriate tabs. Once shipped, you can click on Results to view shipping rates and output the packaging labels. If you have a digital scale connected, you can click on the Scale icon to auto-enter the weight.

Shipping – Shipment Detail

8

Options Screen Under the Options tab you can specify On Call Air Pickup information, required information for international shipments, enable email notifications via UPS QuantumView, or setup special label messaging options, all which need to be set before selecting the Ship option.

Shipping – Shipment Options

9

Rates and Selection Screen Under Rates tab you can view the different UPS Services available for your packages along with estimated costs and time in transit. Once you have run rates and services, you can click on a row to choose the UPS service for your shipment.

Shipping – Rates & Selection

10

Time in Transit Screen Under the Transit tab you can view the different UPS Services available for your packages along with detailed time in transit information. You must enter a pickup date to query Time in Transit. Once you have queried time in transit, you can click on a row to choose the UPS service for your shipment.

Shipping – Time In Transit

11

Shipment Results Screen Under the Results tab you can view the tracking label (if Laser) along with the actual shipping costs for your packages. Click on Void to void your shipment if it will not be picked up for some reason, otherwise you will be invoiced for the shipment. Press view label to view the shipping label on-screen. Click Track to perform tracking on the UPS® Tracking Number. Press Print label to print a single package label to a thermal or laser printer.

Shipping – Results

12

Tracking You can track an individual shipment from the Ship Results or Track screen. First, find an existing shipment or create a new record and enter the UPS Tracking Number. Next, click on Track. The results of your track request will then be displayed with the most recent activity at the top of the list. If the package has been delivered then the package will be flagged internally as delivered. (Note that you must acknowledge the UPS Tracking terms and conditions by clicking the checkbox before you can successfully track)

Tracking – Results

13

Address Book If you find yourself shipping to the same address repeatedly, you may want to add it to your address book. By clicking Validate you can verify that an address falls within a proper CASS range for deliverability. (Note that NRG Software sells additional software that can provide DPV™ and RDI™ flags to insure that addresses are deliverable and whether they are business or residential according to the USPS®)

Address Book – Detail

14

Data Interchange A base set of scripts for importing, exporting and automating functions can be,found on the Scripts menu,

Import Scripts Import Web .TAB File This script is used to import a .tab delimited file (See file “web sample.txt” in the Extras folder) from a website into shipping and temp fields. The imported file is then parsed and fields are set to conform to UPS required values. Next the user runs the Ship Found Set script. Import Web .XLS File This script is used to import a Microsoft Excel file (See file “web sample.xls” in the Extras folder) from a website into shipping and temp fields. The imported file is then parsed and fields are set to conform to UPS required values. Next the user runs the Ship Found Set script. Import Worldship .CSV File This script will import a text file formatted for import into UPS WorldShip on Windows. This allows for automation with many UPS compatible ecommerce applications like osCommerce. (See file “worldship.csv” in the Extras folder) Import Yahoo Store Orders .CSV File This script will import a text file formatted by Yahoo Stores. This allows for automation with ecommerce applications like Yahoo! Stores. (See file “worldship.csv” in the Extras folder) Import X-Cart Orders.CSV File This script will import a text file formatted by X-Cart. Import 3DCart Orders.CSV File This script will import a text file formatted by 3DCart Import Ship Data .TXT This script is used for AppleScript automation. An import and conversion is done on a file named “ship_import.txt” located in the FileMaker Pro application folder. In the Extras folder you will find a sample file including header rows. Import MYOB .TAB File This script will import a text file formatted by MYOB. Import Address Book from WorldShip This script will import address book data from a WorldShip export. Import Address Book from UPS Website This script will import address book data exported from the UPS Website. Import Ship_In.XML This script will import XML data. (See file “ship_in.xml” in the Extras folder)

15

Export Scripts Export Ship Response .TXT File This script is used for AppleScript automation. An export of ship data (track # and rates) is done to a file named “ship_export.txt” located in the FileMaker Pro application folder. In the Extras folder you will find a sample file including header rows. Export WorldShip .CSV File This script will export a text file compatible with the WorldShip Export format. Export XCart .CSV File This script will export a text file compatible with the XCart Export format. Export Ship_Out.XML This script will export XML data. (see file “ship_out.xml” in the extras folder)

Automation Scripts Ship Found Set This script is run after all records are imported for a day. The user finds all new records and then ships them all. Next the user runs the Print All Unprinted script. Print Found Set This script will print labels for the found set of records Void Found Set This script will void shipments for the found set of records. Print Unprinted Laser Labels 2-Up This script finds all unprinted labels and outputs them to laser using the special 2-Up layout. Obtain UPS 2-up label stock to use this functionality. This script can be used with GIF and PNG label types. Print Unprinted Laser Labels to Thermal Printer (WINDOWS ONLY!) This script finds all unprinted labels and outputs them to thermal using a special layout sized for thermal labels. This script can be used with laser label types. Requires Eltron printer driver, and selection of printer in dialog to print labels. Print Unprinted Labels to Thermal This script finds all unprinted labels and outputs them to a thermal printer. You must select EPL as the label type. Output is supported on Mac OS and Windows. Track All Non-Delivered Packages Run this script as a daily process to track all non-delivered shipments. Shipments are flagged as delivered so they will no longer be tracked after delivery. Delete Ship Label Images > 15 Days Old For customers using laser images, the NRGShip database size can become quite a large file. In preferences, you can enable the option to delete images on delivery, or you can utilize this script to manually delete images 15 days after shipment.

16

Show Shipments Shipped not Printed This script will find all records which have been shipped but not printed. Show Shipments Printed not Scanned This script will run a track process on all undelivered packages. It will then search for packages which have not been scanned into the UPS system. Show Shipments with Exceptions This script will run a track process on all undelivered packages. It will then find any shipments which were flagged as an exception.

MAC OS Features Apple Backup QuickPick Included in the Extras folder is a plug-in for the Apple Backup application.

By installing these quick pick settings, your data and preferences can be easily backed up to .Mac accounts or external storage.

Mac OS Address Book Integration Included in the Extras folder is a Mac OS Address Book Plug-In.

By selecting a record in the Address Book, a contextual menu will be enabled to “Prepare UPS Shipment in NRGship for UPS”

17

UPS Service FAQs Where is the Pickup Summary or "End of Day" Barcode? You may be accustomed to giving a Pickup Summary Barcode to the UPS driver at the time of pickup. When using internet-based systems, such as the UPS web site or NRGship,no pickup summary is created, nor is one needed. Your UPS driver may still ask for one at time of pickup. Just tell the driver that www.ups.com was used to process the shipments, and that a bar code is not created and is not needed. If the driver still thinks it is required, show them the ‘bow tie’ box that is printed in the lower right corner of the shipping label—this should let the driver know that an end of day barcode is not needed. Sometimes, our customers encounter a driver that is so accustomed to the pickup summary bar code, that he does not know how to handle a large quantity of internet-processed shipments. Just instruct your driver that these packages are all legitimate shipments, and that he must accept them. If there are any issues in this regard, contact your UPS Account Executive or call 1-800-PICK-UPS.

Does NRGship support multiple UPS accounts? Yes. You can specify a "default" account for new shipments and use alternative settings for multi-location sites.

How can I get FREE printer supplies? If you ship via UPS, you can receive FREE printer supplies for thermal or laser output by accessing UPS supplies online.

Does NRGship support international shipping? Yes! You can ship FROM or TO international destinations. The following counties are valid as origin countries: Argentina, Australia, Austria, Belgium, Brazil, Canada, chile, China, Colombia, Costa Rica, Denmark, Dominican Republic, Finland, France, Germany, Greece, Guatemala, Hong Kong, India, Ireland, Israel, Italy, Japan, Malaysia, Mexico, Netherlands, New Zealand, Norway, Panama, Philippines, Portugal, Puerto Rico, Singapore, South Korea, Spain, Sweden, Switzerland, Taiwan, Thailand, United Kingdom and Unites States

18

FileMaker Integration FileMaker Database Modifications All data is stored in the database file NRG_Package_UPSEd_Data.fp7 which is unlocked for end-user modifications. Details can be found in the FileMaker Integration Documentation.

Integration Samples Connecting NRGship to your existing FileMaker Pro database is a very simple process. The FileMaker integration Documentation includes two sample integrations, an easy integration and a multi-database example.

Integration Scripts Integration scripts are outlined in the FileMaker Integration Documentation.

External Integration NRG Software has scripts and toolsets available for third party integrators. Contact NRG for more information.

Mac OS AppleScript Automation Simple AppleScript can be used which allows for automated import of shipments and export of tracking information. NRG has a script that will invoke the Import .TXT File With Ship Data and Automation – Export .TXT File With Ship Response scripts to allow for seamless integration. Alternate XML imports are also available which provides access to import/export of all ship data fields.

Mac OS URL Automation NRG has a URL helper that allows for seamless automation from web pages or other external applications with no need to import/export data. A simple URL link will create a new shipment record in the Toolkit. URL parameters match the XML element names.

Post Shipment URL Handler Upon successful shipment, NRGShip can invoke a user-defined URL. In addition, it will pass the Ship_ID, User_ID, User_Field01-User_Field19, Status and response fields via GET parameters so that the data can be utilized to update ship data in other systems.

XML Schema NRG has a simplified XML schema (ship request and ship response) for import/export.

19

General Information Multi-User Configuration NRGship can be used in single and multi-user environments. By default, the databases are configured for single-user use. To toggle modes, the database must first be opened in FileMaker Pro. Open the NRG_Package_UPSEd_Blackbox.fp7 file and select Set Multi-User [On], Set Multi-User [Hidden] or Set Single-User from the scripts menu. Once the files are set for multi-user they can be moved to FileMaker Pro Server and opened. Be sure to run the software installer on all workstations so required plug-ins are properly installed. * Note that multi-user installation requires a multi-user license. Please contact NRG Software for license upgrades

Upgrading From Previous Versions V1.2 is the first release of NRGship (formerly known as the Package Toolkit) which is Mac OS 10.5 (Leopard) and Intel native. (Leopard and Intel Mac are not required for version 1.2) Please note that the packaging types have been adjusted in NRGShip v1.2. Previous shipments with a packaging type of "Your Packaging" have been changed to "Package". In addition, the label type options have been changed from "EPL" to "Thermal", "EPL+" to "Thermal Doctab" and "PNG" to "Laser". Any custom integration scripts or field values that you may have added which set these fields will need to be changed to reflect the new terminology. Warning: Be sure to make backup files of your live data files before upgrading!

FileMaker Extensions If you are using a previous version of NRGship you should remove any existing FileMaker Extensions which had been installed (see list below) and you can disable Rosetta emulation on Intel macs by doing a Get Info on the FileMaker Pro application and unchecking the use Rosetta box. • JavaCompanion • shell.fmplugin • Troi Serial Plug-In • Troi Serial X extension

Upgrading and Running Upgrade Scripts In order to upgrade from previous versions (v1.1 or greater), here are the steps to perfrom while in single-user mode. 1.

Rename your old files from NRG_Package_UPSEd_Prefs.fp7 to NRG_Package_UPSEd_Prefs.bak.fp7 and NRG_Package_UPSEd_Data.fp7 to NRG_Package_UPSEd_Data.bak.fp7.

2.

Download v1.2 and run the installer

3.

Copy .bak.fp7 files from 1.1 directory into v1.2 directory

4.

Next, open the new NRG_Package_UPSEd_Data.fp7 file and invoke “Import Data from v1.1 thru v1.1.3” or “Import Data from v1.1.4” from the Scripts menu.

5.

Lastly, open the file NRG_Package_UPSEd_Blackbox.fp7 and select the “Import Preferences from v1.1 thru v1.1.3” or “Import Data from v1.1.4” from the Scripts menu.

The upgrade should be complete. If you incur an error message, please contact NRG Software for upgrade assistance.

20

Basic Setup and Integration Support Support for setup and initial configuration is available via email by sending a message to [email protected] or calling 262-432-0934. NRG Software is able to provide integration of NRGship with other databases or your data file downloads from your website for a nominal fee.

Purchasing NRGship NRGship is available for single and multi-user solutions starting at $499 per year. Visit NRGship.com for complete pricing options. Under the scripts menu, select Purchase NRGship to purchase online.

Contacting NRG Software Phone: 262-432-0934 Email: [email protected] Web:

http://www.nrgsoft.com

Mail:

NRG Software, LLC.



10437 Innovation Dr. #311



Milwaukee, WI 53226

License Agreement PLEASE READ THE ENCLOSED LICENSE AGREEMENT CAREFULLY BEFORE USING THIS SOFTWARE. BY USING THIS SOFTWARE, YOU AGREE TO BECOME BOUND BY THE TERMS OF THIS LICENSE. IF YOU DO NOT AGREE TO THE TERMS OF THIS LICENSE, DO NOT USE THIS SOFTWARE, AND PROMPTLY RETURN IT TO THE PLACE WHERE YOU OBTAINED IT FOR A FULL REFUND. ©1999-2008 NRG Software, LLC. - All rights reserved. Plugins are used under license from Troi Automatisering (http://www.troi.nl) Zebra2844 (MacOS thermal interface) is used under license from buyolympia.com (http://www.buyolympia.com) V1.2 - 4.1.2008 ajk

21