Response Manifest Interface using CPS MANIFEST Software ...

Response 9x Manifest_CPS.doc

____________________________________________________________________________________

CoLinear Systems, Inc. 1 of 23 update: 07/19/2011

Support email: [email protected] http://support.colinear.com/doc

Response Manifest Interface using CPS MANIFEST Software

(Harveysoft)

o You must be on at least Response 8x build #3043 to configure CPS Manifest

software to work with Response o Nov 2007: This CPS Optional AVM module is NOT Supported by Response at this

time Per CPS NEW for November, 2007, the Address Verification Module (AVM) - With Harvey Software's CPS you can have address verification three ways with CPS! You can use the Standard CPS City, State and ZIP verification that has saved shippers money for over 10 years now. CPS shippers that use Endicia Internet Postage can use Endicia Address Verification. Or, you get CASS level address certification and automatic residential and commercial service correction by adding the optional Address Verification Module (AVM). CPS gives you unequalled choices to help get your packages to the right location at the right price.

PART I:

The files you need and what to do with them:

Download the CPS.zip file using the link here:

http://support.colinear.com/doc/Optional%20Modules/Manifest_cps.zip

the zip file contains:

Manifest_General.doc

Manifest_CPS.doc (THIS document)

Manifest_ODBC_Interface.doc

Manifest_CPS_ratebot_cls.doc

Cpsr4w.sql

Cpsdivision.vd7 (for multi-company users only)

(the are no .imm or .spe files for the Harvey interface, it is 100% ODBC)

1. Manifest_General.doc

Read over this. It applies to ALL manifest options.

2. Manifest_CPS.doc (THIS document)

To simplify the information in Manifest_General.doc, this will help you with what you

need to enter in R4W for your Harvey Manifest product. You should still review all info

in 'manifest_general .doc' for information not included here.

3. Manifest_ODBC_Interface.doc

http://support.colinear.com/doc/Optional%20Modules/Manifest_cps.zip


____________________________________________________________________________________



You will need to set up an ODBC Source for Harvey. You will be using ODBC to move

information to Harvey from Response and From Harvey back to Response tables. You

must review this document for more information

4. Cpsdivision.vd7 only used for true multi-company users who ALSO SHARE a single

CPS manifest station between all companies. If you’re not, skip to #5: This is a special case, and will be considered a billable project. This is because a special cpsr4w SQL view and trigger must be created for the companie(s) they want to share the manifest. We will remove mimport/mexport.int from the 00x folders so their mimport/mexport point to r4w_primary, create special cpsr4w view in r4w_primary (with custom SQL). This also requires setting sysfile.x10 in each division to a separate division indicator of A, B, C, D, etc. This cannot be deployed "unattended", contact [email protected] for more information.

This puts the trigger on the MIMPORT table. A "trigger" is function of a MS SQL

database. It can execute on record creation, change or delete. In this case when the

record is created, if mimport.shipper_comment not equal blank, the trigger

executes. Information on MS SQL triggers is beyond the scope of this document.

To install the trigger on MIMPORT, do the following:

copy cpsdivision.vd7 to \r4w\data and double-click on it. (see Q&A at end of this

document IF you need to uninstall this trigger)

*! see more at step 10, page 14… For the mapping back to Response, map

CUSTID to MIMPORT.SHIPPER_COMMENT.

The trigger will parse this information out to shipto_id and division_id and

remove the data from shipper_comment. Shipto_id and Division_id should NOT

be mapped to directly in this setup.

5. Memo for those who are not a multi-company or are using separate manifest

installations for each company:

MIMPORT.int and MEXPORT.int in your \r4w\001\ folder need to point to

R4W_001 if it exists. They should by default already do this.

If you are NOT multi-company, DO NOT map the DIVISION_ID (R4W) to

DEPARTMENT (CPS) on the write tab for the ODBC setup. CPS documents

that you can use/customize the department field to track which department you

are shipping with. Colinear documents that you use this field for multi-division

setup. (repeated on page 14)

6. CPSR4W.SQL

To create a SQL view you will need later at CPS setup, do this only one time:

Get your *CPSR4W.sql file from the CPSR4W.zip. You can also download from

here: http://support.colinear.com/download/cpsr4w.sql , copy this to your

\r4w\data folder. Open the file and copy/past the text into the Response Query

Executor and execute. This will create the ODBC interface view (the SQL

mailto:[email protected]

http://support.colinear.com/download/cpsr4w.sql


____________________________________________________________________________________



VIEW) so you can map the appropriate Response fields to CPS later in these

instruction.


____________________________________________________________________________________



Next are the manifest setup screens found in Response

Manifest Setup (Addons > manifest > ODBC > manifest setup):

Default file paths:

Export Path: Leave this blank for Harvey

Import Path: Leave this field blank for Harvey.

Number of days to keep history: We recommend 10 for all until you decide another

number is necessary.

Secondary Processes:

You will be sending/receiving Response data to the manifest system via ODBC, So you

will leave these fields blank

Options:

Use Ship Cross Reference File – (checked for CPS- Harvey)

Find Ship Method by description during import – (checked for CPS- Harvey)

Require Ship Type for Export – (checked for CPS- Harvey)


____________________________________________________________________________________



Use Country Cross Reference File – (checked ONLY if you need to create more than one

ship method for international shipping. Most users have a single “int’l best way” method

in Response for shipping outside the US and/or Canada)

Notes about the last three options:

Create export records during PickTick". will automatically creates records in the

Mexport table for the records that are printed. Otherwise you must choose add-

ons > manifest > export shipments to manifest and manually choose orders or

batches you want added to the Mexport table. Harvey gets shipping information

from Response via the Mexport table. The user must decide when he wants to

populate that table, during picktick print or manually as described here.

Export records to manifest after picktick (causes the SPE to run). Harvey users

will NOT check this box

Create customer service comments during confirm: must be chosen if you want

the tracking number to be created in a customer service comment when you

confirm the order. Other fields such as ship date, # of pkgs, total wgt, declared

value and shipper comments are included in the customer service comment too if

they are created by the manifest. Harvey users will usually want to check this box.

Make sure the Flag Option under File / Supervisor Options / Flag Options, Confirm tab,

“Using Harvey CPS Manifest” is checked. (8x build 3043 and greater)

Next two setup screens:

Import Manifest: Add-Ons > Manifest > File Based > Export Shipments screen:

Import Manifest: Add-Ons > Manifest > File Based > Import Shipments screen:

Harvey users use ODBC to write/read data to the MIMPORT file so you will NOT need

to use either of these views at all.

PART II.

CONFIGURING RESPONSE FOR CPS via ODBC (CPS is a product of Harvey Software)

1. CPS requires unique shipping method codes to differentiate residential and commercial

UPS deliveries. If you’re a B2C company, you’ll probably consider your existing codes


____________________________________________________________________________________



to be residential. Conversely, B2B companies typically deliver to a business address and,

therefore, their current shipping methods are best considered to correspond to commercial

deliveries.

For example … a B2C company might have the following UPS codes already defined in

Response shipping methods: UPS, UP1, UP2, UP3 (corresponding to residential ground,

next day, 2nd

day and 3-day, respectively). The following codes could be added to handle

UPS shipments commercial addresses: UPSC, UP1C, UP2C, UP3C. A B2C company

would do essentially the reverse. Their new codes for residential shipments might be

UPSR, UP1R, UP2R and UP3R. Bear mind that what you name these codes is

irrelevant. The important thing is that the CSR assign the appropriate shipping method in

Response for commercial and residential addresses. The way Response defaults this for

other manifest systems is simply by company name. If it’s blank Response presumes the

address is residential. Not blank and Response presumes the address is a commercial

one. Your CSRs must now make this decision and assign the appropriate code at order

entry.

2. CPS also requires two codes to designate a given shipping method in Response, i.e. the

carrier (e.g. UPS) and the service type (e.g. Ground/Residential). Each requires a specific

entry as pre-defined by Harvey Software. Your mission is to create the appropriate

entries in the Response shipping cross-reference table to translate the one Response

shipping method into two CPS shipping codes. The table below illustrates how this

works:

B2C shipping xref setup (note residential is the default)1

Response

Code

Description CPS

Carrier

CPS

Service

UPS UPS ground UPS @R03

UPSC UPS ground commercial UPS @@03

UP3 UPS three day UPS @R12

UP3C UPS three day commercial UPS @@12

UP1 UPS next day air UPS @R01

UP1C UPS next day air commercial UPS @@01

etc.

Valid carrier entries [CPS fieldname=SHIPPED] are:

UPS, FEX, FXG and USP2

Please refer to the list below and enter ALL of the codes you’ll be using into the Response

shipping method cross-reference file. {Please note that we removed all “letters” and

1 Please note that what we’re calling “carrier” above is stored in the field SHIPPED in CPS. What we’re calling

“service” is stored in their ZONE field.

2 FEX and FXG are FedX air and ground, respectively.


____________________________________________________________________________________



“international” shipments. These should be manually assigned at the CPS shipping station as

needed.}3 Full list of updated codes (8/7/12) can be found here.

http://support.colinear.com/doc/Optional%20Modules/CPSCompleteList_SmartZones.pdf

UPS

@@01 Next Day Air

@@13 Next Day Air Saver

@@15 Next Day Early AM

@@02 2nd Day Air

@@07 2nd Day Early AM

@@12 3rd Day Select

@R12 3rd Day Select - Residential

@@03 UPS Ground

@R01 Residential Next Day Air

@R13 Residential Next Day Air Saver

@R15 Residential Next Day Early AM

@R02 Residential 2nd Day Air

@R03 UPS Ground - Residential

FEX (Federal Express)

@@01 Priority Overnight Service

@@13 Standard Overnight Service

@@15 First Overnight Service

@@02 2 Day Service

@@08 Express Saver Service

@R15 First Overnight Residential

@R01 Priority Overnight Residential

@R13 Standard Overnight Residential

@R02 2nd Day Residential

@R08 Express Saver Residential

FXG (FedX Ground)

@@44 U.S. Commercial Ground

@R44 U.S. Residential Ground

@@80 Home Delivery

USP (USPS)

@@01 Express Mail

@@02 Priority Mail

@@03 Parcel Post Machineable

@@04 First Class Mail

3 To see all possible shipping codes open HELP in CPS and search for smartzone



____________________________________________________________________________________



To illustrate how the shipping x-ref entries are made, please see the sample screen below:

Notice that the carrier, UPS, is entered into the Manifest Ship Code field; and

the service type, @R03, is entered into the Ship Type field. For Next Day Air you’d enter

UPS and @R01. For 2nd

Day air, UPS and @R02. Similarly, for commercial service (notice

the above example presumes residential deliveries to be the default) the entries would be

UPS @@03, UPS @@01 and UPS @@02, respectively.

After creating the necessary Response shipping method codes to correspond to each

carrier/service you offer … and creating the appropriate cross-reference entries to the

corresponding CPS values … you must define the ODBC mappings between CPS and

Response using the CPS “External Link SetupUtility”

PART III: CPS SETUP

Your CPSR4W SQL View you created from page 2, step 5 should be in place before you

proceed with this CPS setup

1. Run the CPS “External Link SetupUtility” and choose the 32-bit ODBC driver option.

(this is on the Windows START menu in the CPS group of programs)


____________________________________________________________________________________



2. Next, choose the button to “Run the ODBC Administrator”

3. Next, you’ll ADD a new SQL data source as shown below.


____________________________________________________________________________________



4. Click FINISH and then name and describe this new data source. Call it CPSR4W, enter

the description and then point to your R4W SQL server. {Note that it is probably

R4W_PRIMARY and not SERVER2000 as in this example.}


____________________________________________________________________________________



5. Click next and complete the other entries as appropriate for your SQL Server installation.

Your Network Administrator should help you decide about authenticity of the Login ID

and how to obtain default settings for additional configuration options

The default database will be R4W_0??. Each company needs to know where they write

mexport data too. (your mexport.int files in r4w\data\ folder and any r4w\data\00x

folders will provide a clue). Those who have multi-company complist.fil but ONLY one

dataset being R4W_001, should use R4W_001 here


____________________________________________________________________________________



CPS suggests changing the long query timeout to 90000 (90 seconds) instead of

30000


____________________________________________________________________________________



6. Click on the Read tab, Login Info and then Get External.

7. Select your data source name (whatever you named it) and CPSR4W table from the list

of tables as shown above.


____________________________________________________________________________________



8. Next, you’ll map the fields for both the Read and Write tabs as shown below. Notice on

the Read tab how we’ve named the Response fields the same as the CPS fields to make

this easy to perform. Just link the fieldname on the Response (external) side to the

matching CPS fieldname on the left side until all Response fields have been mapped.

(exception: Response/external fields CPS DATE STAMP and CPS TIME STAMP do

NOT have to be mapped)

Do not map the PHONE field on the read tab for the ODBC setup. By default, if

the field is populated, it will print on the UPS labels. I doubt that customers will

appreciate their phone # on their ship label.

NOTE: Be sure this view shows “Link ON” after you complete matching up the fields.

9. VERY IMPORTANT: ALL USERS On the Read tab in the ODBC

setup, click the advanced and CHECK the "use first record if multiple"

box.


____________________________________________________________________________________



ADDENDUM to ODBC setup

A. If you are NOT a multi-division company, DO NOT map the DIVISION_ID (R4W) to

DEPARTMENT (CPS) on the write tab for the ODBC setup. CPS documents that you

can use/customize the department field to track which department you are shipping with.

Colinear documents that you use this field for multi-division setup.

B. All users: Do not map the PHONE field on the read tab for the ODBC setup. By

default, if the field is populated, it will print on the UPS labels. I doubt that customers

will appreciate their phone # on their ship label.

C: All users: Under the "Advanced" setting in the "read" setup for CPS, select the

checkbox which says "use first record found if multiples" or something along similar.

Without this option on you will have trouble getting CPS to see “second” shipments on

an order even though the second MEXPORT record is created. Configuring CPS to the "use first record if multiple" check box. maybe all the magic you need. Without explaining all the technical details, that setting isn't about suppressing multiple shiptos or second shipment on an order. It's about suppressing a smoke and mirror effect the coding in our CPS_R4W view might cause. This is due to the way we're linking several other tables into the CPS_R4W view after we find the mexport record. Mexport is the key piece driving the VIEW, but then Response finds pieces of data from other tables like lpicktrn, picbatch, shipto, etc to make all the magic work. Sometimes those create a mirror effect in the view and CPS will "see" two and balk. This is more likely to happen when a second shipment is created. So that's the reason behind using the checkbox. It's not suppressing legitimate mexport data from a backorder shipment or multiple shiptos. Those are layman's terms as Scott explained to me. I hope this makes sense for you because tech support staff typically cannot decipher the actual code in the SQL view. Bottom line is, that setting alone may resolve your issues with the backorders, without having to keep your mexport table purged

10. The Write Tab is configured differently. The Data Source Name is the NAME you

defined and may not be the exact name in the picture below. You must be able to Select

our TABLE “MIMPORT” as the source table for CPS Write Tab. The fieldnames here

are different so you must be careful to map them across exactly as indicated below and

only those fields as noted.

If you are NOT multi-company, DO NOT map the DIVISION_ID (R4W) to

DEPARTMENT (CPS) on the write tab for the ODBC setup. CPS documents that

you can use/customize the department field to track which department you are

shipping with. Colinear documents that you use this field for multi-division setup


____________________________________________________________________________________



NOTE: Be sure this view shows “Link ON” after you match up the fields.

*!! In regards to above: only for Multi – Company Response users who SHARE

a single Manifest station note: For the mapping back to Response, map CUSTID

to SHIPPER_COMMENT.

You previously created a trigger when you executed cpsdivision.vd7 from

\r4w\data. The trigger will parse this information out to shipto_id and division_id

and remove the data from shipper_comment. Shipto_id and Division_id should

NOT be mapped to directly on this write tab.

CPS fieldname RESPONSE fieldname CITY city

COD_AMOUNT cod_amt

Do not use! company_name dnu 9/21/04

Do not use! confirm_date

Do not use! confirm_time


____________________________________________________________________________________



COUNTRY Country

Do not use! created_by

LINE_2 customer_name

Do not use! customer_no

MANIF_DATE date_shipped

VALUE declared_value

DEPARTMENT division_id (multi-co see note

*!)

*skip export_date

*skip export_time

TYPE export_type

T_COST freight_cost

*skip handling_fee

PKG_NO import#_today

MANIF_DATE import_date

Do not use! last_edit

*skip n1

NO_PKGS No_packages

MCM_FIELD1 order_no

*skip other_charges

OVERSIZE Oversized

*future use Packer (optional, can be used

with CPS user defined field)

*future use Picker (optional, can be used

with CPS user defined field)

*skip print_batch_no

Do not use! prior_edit

DEPARTMENT ship_department

SHIPPED ship_key

Do not use! Shipmeth_code

*skip shipper_comment

CUSTID shipto_id (multi-co see note

*!)

STATE State

MCM_FIELD2 Status

WEIGHT total_weight

TRACKER tracking_no

ZIP Zip

ZONE ZONE

CPS RATEBOTS


____________________________________________________________________________________



11. CPS supports rate shopping through what it calls “RateBots.” These allow you to create

a group of carriers/services from which the lowest rate available for that shipment can be

selected at the shipping station. You can create a best-way RateBot for each of the

‘kinds’ of delivery schedules you offer, e.g. ground, 2nd

day, 3-day and overnight

shipments. That way, CPS will choose the lowest priced shipping method without the

CSR having to make this decision during order entry.

To do this, create the appropriate RateBots in CPS | Tools. A sample RateBot for 2-day

service (UPS and FEX) is shown below.


____________________________________________________________________________________



12. In order to use RateBots in Response you must enter it into the same shipping method

cross-reference table you previously keyed in your standard shipping methods. Before

you can do that, however, you must create these new shipping methods in File | Shipping

| Shipping Methods. So, for example, create BW2D as a new Response shipping method.

Next, load the Manifest Ship Method Cross reference table. For EVERY RateBot entry

be sure to key nothing in the Manifest Ship Code field. Manifest Ship Code must always

be blank if you want to rate shop. Then, enter the Response shipping method in its field

and, finally, the NAME of the RateBot (we called it “BW2D” above) into the Ship Type

field. The key here is to leave Manifest Ship Code blank and enter the RateBot name into

the Ship Type field.


____________________________________________________________________________________



An example above showing BW2D. Note that Manifest Ship Code is blank and Ship

Type contains the RateBot name we created in CPS.


____________________________________________________________________________________



Another example, this time for Best Way Next Day.

To assign best-way, second-day shipping to an order, just enter BW2D as the shipping

method in order entry. CPS will then do rate shopping for you at the time the package is

weighed and manifested.

This completes the Response/CPS Interface setup.

Sending data back to Response, refer to Manifest_general.doc and Manifest_odbc.doc

documents

We believe most users send data back from CPS to Response Mimport table via ODBC so we

refer you to those documents. If you are sending information from Harvey via a batch file,

contact support for more details


____________________________________________________________________________________



Q&A:

Q. When I try to enter Shiptype in manifest shipping xref, I can only enter 3 characters, but

Harvey needs 4?

A. Manifest Shipping Cross Reference field SHIPTYPE: changed from 3 characters to 4 with

chgfiles2018.vd7

Q. we had about 40 packages yesterday that wouldn't scan through CPS. The barcode does scan

and bring up the shipto ID but it doesn't find the record in the Mexport table.

I used database explorer to see if the order # and shipto ID's in question were in the table and

confirmed that they are. Although they all showed duplicate records.

I went through and deleted the duplicate records and then the packages seemed to scan fine at the

shipping station.

A. (from document above) C: All users: Under the "Advanced" setting in the "read" setup for

CPS, select the checkbox which says "use first record found if multiples" or something along

similar.

Q. Is there a way to uninstall cpsdivision.vd7 (i.e. remove the multi-co trigger for CPS manifest)

A. Yes, This is a SQL script:

drop trigger dbo.parsedivshipto

You can run this script in Query Analyzer or Response Query Executor


____________________________________________________________________________________



TECH: Document modification history

11/30/06: overhauled for 9x. Header/footers added, etc

3/13/08: page 12: added memo CPS suggests changing the long query timeout to 90000 (90

seconds) instead of 30000 if user is having problems with timeouts reported in their extlink.log

(CPS_ExternalLink.log)

7/19/2011, page 15, added some explanation about the requirement to Configuring CPS to the "use

first record if multiple" check box.

8/7/2012: added link for full codes



Response Manifest Interface using CPS MANIFEST Software ...

Documents

Transcript of Response Manifest Interface using CPS MANIFEST Software ...