draft - ultrasourceecom, isd v5

23
Integration Specifications UltraSourceusa.com B2B Website TO UltraSource AUTHORED BY Jeremy McLain DATE 21 January 2014

Upload: others

Post on 04-Feb-2022

1 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: DRAFT - ULTRASOURCEECOM, ISD v5

Integration Specifications

UltraSourceusa.com B2B Website

TO

UltraSource

AUTHORED BY

Jeremy McLain

DATE

21 January 2014

Page 2: DRAFT - ULTRASOURCEECOM, ISD v5

UltraSource, Integration Specifications 21 January 2014

2 :: 23

Table of Contents

1.0 Imports ....................................... .............................................................. 3

1.1 Customer File ......................................................................................................................................... 3

1.2 Sales Contact File ................................................................................................................................... 5

1.3 Sales Contact Cross Reference File ...................................................................................................... 7

1.4 Customer Contract Prices File ................................................................................................................ 8

1.5 Customer Orders File ........................................................................................................................... 10

1.6 Inventory Quantity File .......................................................................................................................... 11

1.7 UPS Tracking File ................................................................................................................................. 13

1.8 Order Shipping Information File ............................................................................................................ 13

2.0 Outputs ....................................... ........................................................... 14

2.1 Customer File ....................................................................................................................................... 14

2.2 Sales Contact File ................................................................................................................................. 16

2.3 Sales Contact Cross Reference File .................................................................................................... 17

2.4 Customer Order Lines File.................................................................................................................... 18

2.5 Customer Ship_to File .......................................................................................................................... 20

3.0 System Integrations ........................... ................................................... 21

3.1 Authorize.net ......................................................................................................................................... 21

3.2 UPS Address Validation ....................................................................................................................... 21

3.3 Avalara Avatax ...................................................................................................................................... 21

4.0 Appendices .................................... ........................................................ 23

4.1 Questions .............................................................................................................................................. 23

5.2 Document Versions .............................................................................................................................. 23

5.3 Approvals .............................................................................................................................................. 23

Page 3: DRAFT - ULTRASOURCEECOM, ISD v5

UltraSource, Integration Specifications 21 January 2014

3 :: 23

1.0 Imports

1.1 Customer File

1.1.1 Structure Custo mer File

Summary The system will be configured to import a Customer file once. Business Requirement Transmission Protocol SFTP Frequency One time import. Security SFTP Format .csv

Data Flow Future State

Error / Exception Handling N/A Directory Location Environment IP Address User Name Location

BETA Production

1.1.2 Mapping – Syteline S – Field S -

Table S –

Column S -

Required

M – Field M – Table M – Attribute

M - Custom

Notes

Customer #

Custaddr

Cust_num Y Syteline_id Customer_entity_varchar Syteline_id Y

Customer Name

Custaddr

Name N Company Customer_entity_varchar Company N

Country Custaddr

Country Y Country Customer_address_entity_varchar

Country N

Currency Custaddr

Curr_code Y Currency Customer_entity Currency Y Set to USD

Bank code

Customer

Bank_code Y Bank_code Customer_entity Bank_code Y Set to 01

Pay type Customer

Pay_type Y Pay_type Customer_entity Pay_type Y

SIC CODE

Customer

Sic_code Y Sic_code Customer_entity Sic_code Y

Invoice category

Customer

Inv_category

Y ??? ??? ??? Default is: DEFAULTCATEGORY

Salesperson

Customer

Uf_salesperson

Y Uf_salesperson

Customer_entity Uf_salesperson

Y Set to ecommerce

Address 1

Custaddr

Addr##1 N Street Customer_address_entity_text

Street N

Address 2

Custaddr

Addr##2 N Street Customer_address_entity_text

Street N

Address 3

Custaddr

Addr##3 N Addr##3 Customer_address_entity_text

Addr##3 Y

Address4

Custaddr

Addr##4 N Addr##4 Customer_address_entity_text

Addr##4 Y

City Custaddr

City N City Customer_address_entity_varhar

City N

State Custaddr

State N State Customer_address_entity_varchar

State N

Page 4: DRAFT - ULTRASOURCEECOM, ISD v5

UltraSource, Integration Specifications 21 January 2014

4 :: 23

S – Field S - Table

S – Column

S - Requir

ed

M – Field M – Table M – Attribute

M - Custom

Notes

Country Custaddr

Country Y Country Customer_address_entity_varchar

Country N

Postal code

Custaddr

Zip N Zip Customer_address_entity_varchar

Zip N

Tax code Customer

Tax_code1 Y Tax_code1 Customer_entity tax_code1 Y Add note

Creation date

Customer

Createdate Y Createdate Customer_entity Createdate N

Page 5: DRAFT - ULTRASOURCEECOM, ISD v5

UltraSource, Integration Specifications 21 January 2014

5 :: 23

1.2 Sales Contact File

1.2.1 Structure Sales Contact File

Summary The system will be configured to import a Sales Contact file once Business Requirement Transmission Protocol Frequency One time import Security Format

.csv Data Flow Future State

Error / Exception Handling Directory Location Environment IP Address User Name Location

BETA Production

1.2.2 Mapping S –

Field S -

Table S – Column S -

Required

M – Field M – Table M – Attribute M - Custom

Notes

Contact

Contacted

Contact_id Y Syteline_contact_ID

Customer_entity_varchar

Syteline Contact ID Y

Salutation

Contact

Uf_sl N Accountprefix Customer_entity_varchar

Accountprefix N

First name

Contact

Fname Y Firstname Customer_entity_varchar

Firstname N

Middle initial

Contact

Mi N Middlename Customer_entity_varchar

Middlename N

Last name

Contact

Lname Y Lastname Customer_entity_varchar

Lastname N

Full name

Contact

Uf_kochfullname Y Concatenated from Firstname,middlename,lastname

Customer_entity_var_char

Combination of existing attributes

Y Not a Custom attribute

Preferred name

Contact

Uf_prefname Y Uf_prefname Customer_entity_var_char

Preferred Name Y

Company

Contact

Company Y Company Address Company N

Addre

ss 1

Conta

ct

Addr##1 Y Customer_address

_entity_text

Street Customer_address

_entity_text

N

City Contact

City Y City Address Address N

State Contact

State Y Region_id Address Address N

Zip Contact

Zip Y Postcode Address Address N

Country

Contact

Country Y Country Address Address N

Office phone

Contact

Office_phone Y Telephone Customer_address_entity_varchar

Telephone N

Page 6: DRAFT - ULTRASOURCEECOM, ISD v5

UltraSource, Integration Specifications 21 January 2014

6 :: 23

S – Field

S - Table

S – Column S - Required

M – Field M – Table M – Attribute M - Custom

Notes

OK to Send Promotion

Contact

Ok_to_send_promo N Can_send_promo Customer_entity_int Can_send_promo Y

OK to send news

Contact

Ok_to_send_news N Can_send_news Customer_entity_int Can_send_news Y

OK to send other comm

Contact

Ok_to_send_other_communication

N Can_send_other_communication

Customer_entity_int Can_send_other_communication

Y

Ok to send email

Contact

Ok_to_send_email N Can_send_email Customer_entity_int Can_send_email Y

Page 7: DRAFT - ULTRASOURCEECOM, ISD v5

UltraSource, Integration Specifications 21 January 2014

7 :: 23

1.3 Sales Contact Cross Reference File

1.3.1 Structure Sales Contact Cross Reference File

Summary The system will be configured to import a Sales Contact Cross Reference file once. Business Requirement Transmission Protocol Frequency One time import Security Format

Data Flow Future State

Error / Exception Handling Directory Location Environment IP Address User Name Location

BETA Production

1.3.2 Mapping S –

Field S - Table S –

Column S -

Required

M – Field M – Table M – Attribute M - Custom Notes

Customer

Customer_contact

Cust_num

Y sytelineID Customer_entity_varchar

sytelineID Y

Cust_seq

Customer_contact

Cust_seq

Y Syteline cust seq

Customer_entity_int

Syteline_cust_seq

Y

Sales contact

Customer_contact

Contact_id

Y Syteline_conta

ct_ID

Customer_entity_v

archar

Syteline

Contact ID

Syteline_conta

ct_ID

Page 8: DRAFT - ULTRASOURCEECOM, ISD v5

UltraSource, Integration Specifications 21 January 2014

8 :: 23

1.4 Customer Contract Prices File

1.4.1 Structure Customer Contract Prices File

Summary The system will be configured to import a Customer Contract Prices file once. Business Requirement Transmission Protocol Frequency Security Format .csv

Data Flow Future State

Error / Exception Handling Directory Location Environment IP Address User Name Location

BETA Production

1.4.2 Mapping S –

Field S - Table S – Column S -

Required

M – Field M – Table M – Attribut

e

M - Custo

m

Notes

Item Itemcust Item Y Item Syteline_Special_Pricing

Item Y

Customer

Itemcust Cust_num Y Cust_num Syteline_Special_Pricing

Cust num

Y

Unit of measure

Itemcust u_m Y U_m Syteline_Special_Prici

ng

U_m Y

Item Itemcustprice

Item Y Item_price Syteline_Special_Prici

ng

Item price

Y

Customer

Itemcustprice

Cust_num Y Cus_num_price Syteline_Special_Prici

ng

Cus num price

Y

Effective date

Itemcustprice

Effect_date Y Effect_date Syteline_Special_Prici

ng

Effect date

Y

Break quantity 1

Itemcustprice

Brk_qty##1 N Brk_qty_1 Syteline_Special_Prici

ng

Brk qty 1

Y

Break quantity 2

Itemcustprice

Brk_qty##2 N Brk_qty_2 Syteline_Special_Prici

ng

Brk_qty 2

Y

Break quantity 3

Itemcustprice

Brk_qty##3 N Brk_qty_3 Syteline_Special_Prici

ng

Brk qty 3

Y

Break quantity 4

Itemcustprice

Brk_qty##4 N Brk_qty_4 Syteline_Special_Prici

ng

Brk qty 4

Y

Break quantity 5

Itemcustprice

Brk_qty##5 N Brk_qty_5 Syteline_Special_Prici

ng

Brk qty 5

Y

Break price 1

Itemcustprice

Brk_price##1 N Brk_price_1 Syteline_Special_Prici

ng

Brk price 1

Y

Break price 2

Itemcustprice

Brk_price##2 N Brk_price_2 Syteline_Special_Prici

ng

Brk price 2

Y

Page 9: DRAFT - ULTRASOURCEECOM, ISD v5

UltraSource, Integration Specifications 21 January 2014

9 :: 23

S – Field

S - Table S – Column S - Require

d

M – Field M – Table M – Attribut

e

M - Custo

m

Notes

Break price 3

Itemcustprice

Brk_price##3 N Brk_price_3 Syteline_Special_Prici

ng

Brk price 3

Y

Break price 4

Itemcustprice

Brk_price##4 N Brk_price_4 Syteline_Special_Prici

ng

Brk price 4

Y

Break price 5

Itemcustprice

Brk_price##5 N Brk_price_5 Syteline_Special_Prici

ng

Brk price 5

Y

Base code 1

Itemcustprice

Base_code##1

N Base_code_1 Syteline_Special_Prici

ng

Base code 1

Y

Base code 2

Itemcustprice

Base_code##2

N Base_code_2 Syteline_Special_Prici

ng

Base code 2

Y

Base code 3

Itemcustprice

Base_code##3

N Base_code_3 Syteline_Special_Prici

ng

Base code 3

Y

Base code 4

Itemcustprice

Base_code##4

N Base_code_4 Syteline_Special_Prici

ng

Base code 4

Y

Discount 1

Itemcustprice

Base_code##1

N Base_code_percent_1

Syteline_Special_Prici

ng

Base code percent 1

Y

Discount 2

Itemcustprice

Base_code##2

N Base_code_percent_2

Syteline_Special_Prici

ng

Base code percent 2

Y

Discount 3

Itemcustprice

Base_code##3

N Base_code_percent_3

Syteline_Special_Prici

ng

Base code percent 3

Y

Discount 4

Itemcustprice

Base_code##4

N Base_code_percent_4

Syteline_Special_Prici

ng

Base code percent 4

Y

Discount 5

Itemcustprice

Base_code##5

N Base_code_percent_5

Syteline_Special_Prici

ng

Base code percent 5

Y

Page 10: DRAFT - ULTRASOURCEECOM, ISD v5

UltraSource, Integration Specifications 21 January 2014

10 :: 23

1.5 Customer Orders File

1.5.1 Structure Customer Order s File

Summary The system will be configured to import Customer Orders file once. Business Requirement Transmission Protocol

Frequency Security Format SFTP XML Data Flow Current State Data Flow Future State Error / Exception Handling Business Rules

Notes Directory Location Environment IP Address User Name Location

BETA Production

1.5.2 Mapping

S – Field

S - Table S – Column S - Require

d

M – Field M – Table M – Attribut

e

M - Custo

m

Notes

Customer order num

Co Co_num Y Syteline_order_id

Sales_flat_order Syteline order id

Y

Order date

Co Order_date Y Created_at Sales_flat_order N

Ship to/bill to

Co Cust_seq Y 0 will be passed if ship to is same as bill to. Else 1 to 100 will indicate ship to address.

Ship code

Co Ship_code Y Ship_code Sales_flat_shipment Ship code

Y

Order header status

Co Stat Y Status Sales_flat_order N

Ship partial

Co Ship_partial N Partial Sales_flat_shipment Partial Y

Pick list notes

Co Uf_picklistnotes

N Comment Sales_flat_shipment_comment

N

ship via Ship_code

If shipment is paid by CC the ship via code ending with a D. If customer is using their

? Ship_via Sales_flat_order Ship Via

Y As an example, If we shipped 2nd day air and we were

Page 11: DRAFT - ULTRASOURCEECOM, ISD v5

UltraSource, Integration Specifications 21 January 2014

11 :: 23

S – Field

S - Table S – Column S - Require

d

M – Field M – Table M – Attribut

e

M - Custo

m

Notes

shipper number the

ship via code ending with a K. Will use

Ship Via codes from

Syteline

paying the freight the code would be U02D. If the customer was using their shipping number the code would be U02K. If the customer had terms and we were invoicing the freight the code would be U02P. I can provide the ship via codes with the correlation to the shipping method.

1.6 Inventory Quantity File

1.6.1 Structure Inventory Quantity File

Summary The system will be configured to import an Inventory Quantity file on a scheduled frequency. Business Requirement Transmission Protocol FTP Frequency Once a day. Security SFTP Format

Naming convention: Customer_YYYYMMDD_HHMM.csv Data Flow Future State Middleware will query Syteline via SQL and generate file. File will be FTP’ed and Magento will

pick up file for import.

Page 12: DRAFT - ULTRASOURCEECOM, ISD v5

UltraSource, Integration Specifications 21 January 2014

12 :: 23

Inventory Quantity File Error / Exception Handling Will exist on middleware and Magento and will generate emails on any import failures. Directory Location Environment IP Address User Name Location

BETA Production

1.6.2 Mapping

S – Field

S - Table S – Column S - Required

M – Field

M – Table M – Attribute

M - Custom

Notes

Item Itemwhse

Item Y Sku Catalog_product_entity N/A N

Quantity on hand

Itemwhse

SELECT

itemwhse.qty_on_hand,

itemwhse.qty_alloc_co

FROM

Koch_App.dbo.itemwhse

itemwhse

Y Qty Catalog_product_entity_int Qty N

Quantity allocated to an order

Itemwhse

Qty_alloc_co Y Qty Sales_flat_order_item Qty N

Quantity reserved to an order

Itemwhse

Qty_rsvd_co Y ? ? ?

Page 13: DRAFT - ULTRASOURCEECOM, ISD v5

UltraSource, Integration Specifications 21 January 2014

13 :: 23

1.7 UPS Tracking File

1.7.1 Structure UPS Tracking File

Summary The system will be configured to import a UPS Tracking file on a scheduled frequency. Business Requirement Transmission Protocol SOAP Calls Frequency Once a day. Security SFTP Format

Naming convention: UPS_Tracking_YYYYMMDD_HHMM.csv Data Flow Future State Middleware will query Syteline via SQL and generate file. File will be FTP’ed and Magento will

pick up file for import.

Error / Exception Handling Will exist on middleware and Magento and will generate emails on any import failures. Directory Location Environment IP Address User Name Location

BETA Production

1.7.2 Mapping S –

Field S -

Table S – Column S -

Required

M – Field M – Table M – Attribut

e

M - Custo

m

Notes

Case number

Ordercase

Casenumber Y Case_number

Sales_flat_shipment Case number

Y

Customer order

Ordercase

Co_num Y Order_id Sales_flat_shipment_order_id

N

Ship date

Ordercase

Shipdate Y Created_at Sales_flat_shipment N

Weight ordercase

Weight N Total_weight

Sales_flat_shipment N There is also a weight field in sales_flat_shipment_track.

Tracking number

Ordercase

Trackingnumber

N Track_number

Sales_flat_shipment_track

N

Number of pieces

ordercase

Numberpieces

N Qty Sales_flat_shipment_track

N

Customer number

Ordercase

Customernumber

N Syteline_id Customer_entity_varch

ar

Syteline

_id

Y Use sytline id to lookup magento customer id. Store magento customer id in sales_flat_shipment

1.8 Order Shipping Information File

1.8.1 Structure Order Shi pping Information File

Summary The system will be configured to import an Order Shipping Information file on a scheduled frequency.

Business Requirement

Page 14: DRAFT - ULTRASOURCEECOM, ISD v5

UltraSource, Integration Specifications 21 January 2014

14 :: 23

Order Shi pping Information File Transmission Protocol SOAP Calls Frequency Once a day. Security SFTP Format Webservice call

Naming convention: Order_Shipping_Information_YYYYMMDD_HHMM.csv Data Flow Future State Middleware will query Syteline via SQL and generate file.

Error / Exception Handling Will exist on middleware and Magento and will generate emails on any import failures. Directory Location Environment IP Address User Name Location

BETA Production

1.8.2 Mapping S –

Field S -

Table S –

Column S -

Required

M – Field M – Table M – Attrib

ute

M - Custo

m

Notes

Customer order

Co_ship

Co-num Y Syteline_order_id

Sales_flat_order Syteline order id

Y This will also go into sales_flat_shipment_order_id

Customer order line

Co_ship

Co_line Y Item_id Sales_flat_order_item Item id N That value will also go into sales_flat_shipment_item in the field order_item_id.

Customer order line release

Co_ship

Co_release

Y Syteline_co_release

Sales_flat_shipment Syteline co release

Y Default value is ‘0’. Field will always be ‘0’.

Quantity invoiced

Co_ship

Qty_invoiced

Y Qty_invoiced Sales_flat_shipment_item

Quantity invoice

N

Ship date

Co_ship

Ship_date

Y Created_at Sales_flat_shipment_created_at

Create at

N

Quantity shipped

Co_ship

Qty_shipped

Y Qty Sales_flat_shipment_item

Qty N

Quantity returned

Co_ship

Qty_returned

Y Syteline_qty_returned

Sales_flat_shipment_item

Syteline qty returned

Y

2.0 Outputs 2.1 Customer File

2.1.1 Structure Customer File

Summary The system will be configured to export a Customer file on a scheduled frequency. Business Requirement Transmission Protocol FTP

Page 15: DRAFT - ULTRASOURCEECOM, ISD v5

UltraSource, Integration Specifications 21 January 2014

15 :: 23

Customer File Frequency Every 15 minutes Security SFTP Format

Naming convention: Customer_YYYYMMDD_HHMM.xml Data Flow Future State Middleware will import a file from Magento and will query Syteline and write differences to

Syteline.

Error / Exception Handling Will exist on middleware and Magento and will generate emails on any import failures. Directory Location Environment IP Address User Name Location

BETA Production

2.1.2 Mapping S – Field S -

Table S –

Column S -

Required

M – Field M – Table M – Attribute

M - Custom

Notes

Customer #

Custaddr

Cust_num Y Syteline_id Customer_entity_varchar Syteline_id Y

Customer Name

Custaddr

Name N Company Customer_entity_varchar Company N

Country Custaddr

Country Y Country Customer_address_entity_varchar

Country N

Currency Custaddr

Curr_code Y Currency Core_config_data Currency Y Set to USD

Bank code

Customer

Bank_code Y Bank_code Core_config_data Bank_code Y Set to 01

Pay type Customer

Pay_type Y Pay_type Core_config_data Pay_type Y

SIC CODE

Customer

Sic_code Y Sic_code Core_config_data Sic_code Y

Invoice category

Customer

Inv_category

Y ??? ??? ??? Default is: DEFAULTCATEGORY

Salesperson

Customer

Uf_salesperson

Y Uf_salesperson

Core_config_data Uf_salesperson

Y Set to ecommerce

Address 1

Custaddr

Addr##1 N Street Customer_address_entity_text

Street N

Address 2

Custaddr

Addr##2 N Street Customer_address_entity_text

Street N

Address 3

Custaddr

Addr##3 N Addr##3 Customer_address_entity_text

Addr##3 Y

Address4

Custaddr

Addr##4 N Addr##4 Customer_address_entity_text

Addr##4 Y

City Custaddr

City N City Customer_address_entity_varhar

City N

State Custaddr

State N State Customer_address_entity_varchar

State N

Country Custaddr

Country Y Country Customer_address_entity_varchar

Country N

Postal code

Custaddr

Zip N Zip Customer_address_entity_varchar

Zip N

Tax code Customer

Tax_code1 Y Tax_code1 Customer_entity tax_code1 Y

Creation date

Customer

Createdate Y Createdate Customer_entity Createdate N

.

Page 16: DRAFT - ULTRASOURCEECOM, ISD v5

UltraSource, Integration Specifications 21 January 2014

16 :: 23

2.2 Sales Contact File

2.2.1 Structure Sales Contact File

Summar y The system will be configured to export a Sales Contact file on a scheduled frequency. Business Requirement Transmission Protocol FTP Frequency Every 15 minutes Security SFTP Format

Naming convention: Sales_Contact_YYYYMMDD_HHMM.xml Data Flo w Future State Middleware will import a file from Magento and will query Syteline and write differences to

Syteline.

Error / Exception Handling Will exist on middleware and Magento and will generate emails on any import failures. Directory Location Environment IP Address User Name Location

BETA Production

2.2.2 Mapping S –

Field S -

Table

S – Column S - Require

d

M – Field M – Table M – Attribute M - Custom Notes

Contact

Contacted

Contact_id Y Syteline_contact_ID

Customer_entity_varchar

Syteline Contact ID

Y

Salutation

Contact

Uf_sl N Accountprefix Customer_entity_varchar

Accountprefix N

First name

Contact

Fname Y Firstname Customer_entity_varchar

Firstname N

Middle initial

Contact

Mi N Middlename Customer_entity_varchar

Middlename N

Last name

Contact

Lname Y Lastname Customer_entity_varchar

Lastname N

Full name

Contact

Uf_kochfullname Y Concatenated from Firstname,middlename,lastname

Customer_entity_var_char

Combination of existing attributes

Y Not a Custom attribute

Preferred name

Contact

Uf_prefname Y Uf_prefname Customer_entity_var_char

Preferred Name Y

Company

Contact

Company Y Company Address Company N

Address 1

Contact

Addr##1 Y Customer_addre

ss_entity_text

Street N Customer_addr

ess_entity_text

City Contact

City Y City Address Address N

Page 17: DRAFT - ULTRASOURCEECOM, ISD v5

UltraSource, Integration Specifications 21 January 2014

17 :: 23

S – Field

S - Tabl

e

S – Column S - Require

d

M – Field M – Table M – Attribute M - Custom Notes

State Contact

State Y Region_id Address Address N

Zip Contact

Zip Y Postcode Address Address N

Country

Contact

Country Y Country Address Address N

Office phone

Contact

Office_phone Y Telephone Customer_address_entity_varchar

Telephone N

OK to Send Promotion

Contact

Ok_to_send_promo

N Can_send_promo

Customer_entity_int

Can_send_promo

Y

OK to send news

Contact

Ok_to_send_news N Can_send_news Customer_entity_int

Can_send_news Y

OK to send other comm

Contact

Ok_to_send_other_communication

N Can_send_other_communication

Customer_entity_int

Can_send_other_communication

Y

Ok to send email

Contact

Ok_to_send_email

N Can_send_email Customer_entity_int

Can_send_email Y

2.3 Sales Contact Cross Reference File

2.3.1 Structure Sales Contact Cross Reference File

Summary The system will be configured to export a Sales Contact Cross Reference file on a scheduled frequency.

Business Requirement Transmission Protocol SFTP Frequency Every 15 minutes. Security SFTP Format

Naming convention: Sales_Contact_Cross_Reference_YYYYMMDD_HHMM.xml Data Flow Future State Middleware will import a file from Magento and will query Syteline and write differences to

Syteline.

Error / Exception Handling Will exist on middleware and Magento and will generate emails on any import failures. Directory Location Environment IP Address User Name Location

BETA Production

Page 18: DRAFT - ULTRASOURCEECOM, ISD v5

UltraSource, Integration Specifications 21 January 2014

18 :: 23

2.3.2 Mapping S –

Field S - Table S –

Column

S - Requi

red

M – Field M – Table M – Attribute

M - Custom Notes

Customer

Customer_contact

Cust_num

Y sytelineID Customer_entity_varchar

sytelineID Y

Cust_seq

Customer_seq

Cust_seq

Y Syteline cust seq

Customer_entity_int

Syteline_cust_seq

Y This field

indicates

where the

product

needs to be

shipped. This

should be

cross-

referenced

back to the

“custaddr”

table to look

for the

cust_num/cus

t_seq

combination

to indicate

the complete

address for

the customer

Sales contact

Customer_contact

Contact_id

Y Syteline_cont

act_ID

Customer_entity_

varchar

Syteline

Contact ID

Syteline_cont

act_ID

2.4 Customer Order Lines File

2.4.1 Structure Customer Order Lines File

Summary The system will be configured to export a Customer Order Lines file on a scheduled frequency. Business Requirement Transmission Protocol SFTP Frequency Every 15 minutes Security SFTP Format

Naming convention: Customer_Order_Lines_YYYYMMDD_HHMM.xml Data Flow Future State Middleware will import a file from Magento and will query Syteline and write differences to

Syteline.

Error / Exception Handling Will exist on middleware and Magento and will generate emails on any import failures. Directory Location Environment IP Address User Name Location

BETA Production

Page 19: DRAFT - ULTRASOURCEECOM, ISD v5

UltraSource, Integration Specifications 21 January 2014

19 :: 23

2.4.2 Mapping S –

Field S -

Table

S – Column S - Requi

red

M – Field M – Table M – Attrib ute M - Custom

Notes

Order number

Coitem

Co_num Y Increment_id Sales_flat_order

Increment_id

Line Coitem

Co_line Y Item_id Sales_flat_order_item

Item_id N

Qty ordered

Coitem

Qty_ordered_conv Y Qty_ordered Sales_flat_order_item

Qty_ordered N

u/m Coitem

u_m Y U_m Sale_flat_order_item

U_m Y

Item Coitem

Item Y Sku Catalog_product_entity

N/A N

Unit price

Coitem

ROUND((ISNULL(QtyOrderedConv,0)) * (1 - (ISNULL(Disc,0)) /

100) * (ISNULL(PriceConv,0)),ISNULL(

CurrencyPlaces, (SELECT cur1.places FROM currparms,

currency cur1 WHERE cur1.curr_code =

currparms.curr_code)))

Y Price Sale_flat_order_item

Price N

Item description

Item Description N Name Sale_flat_order_item

Name N

Sales disc

Coitem

Disc N N/A N/A N/A N/A Excluded

Customer item

Coitem

Cust_item N N/A N/A N/A N/A Excluded

Status Coitem

Stat Y Default_item_status

Core_config_data

Default_item_status

Y Set to ‘Planned’

Due date

Coitem

Due_date N N/A N/A N/A N/A Excluded

Request date

Coitem

Promise_date N N/A N/A N/A N/A Excluded

Invoice frequency

Coitem

Inv_freq Y Inv_freq Core_config_data

Inv_freq Y Set to ‘W’

Page 20: DRAFT - ULTRASOURCEECOM, ISD v5

UltraSource, Integration Specifications 21 January 2014

20 :: 23

2.5 Customer Ship_to File

2.5.1 Structure Customer Ship_to File

Summary The system will be configured to export a Customer Ship_to file on a scheduled frequency. Business Require ment Transmission Protocol FTP Frequency Every 15 minutes Security SFTP Format

Naming convention: Customer_Ship_to_YYYYMMDD_HHMM.csv Data Flow Future State Middleware will query Syteline via SQL and generate file. File will be FTP’ed and Magento will

pick up file for import.

Error / Exception Handling Will exist on middleware and Magento and will generate emails on any import failures. Directory Location Environment IP Address User Name Location

BETA Production

2.5.2 Mapping S –

Field S -

Table S –

Column S -

Required

M – Field M – Table M – Attribute M - Custo

m

Notes

Customer #

Custaddr

Cust_num Y Value Customer_entity_var_char Customer syteline id

Y

Customer sequence

Customer

Cust_seq Y Syteline cust seq

Customer_entity_int Syteline_cust_seq

Y

Customer name

Custaddr

Name Y Concatenated first_name, last_name

Customer_entity_var_char N

Country

Custaddr

Country Y Country_id Address Country N

Address line 1

Custaddr

Addr##1 Y Street Customer_address_entity_te

xt

Street N

City Custaddr

City Y City Customer_Address_entity_v

ar_char

City N

State Custad

dr

State Y State Customer_Address_entity_v

ar_char

State N

Postal code

Custaddr

Zip Y Postcode Customer_address_entity_va

r_char

Zip/Postal

code

N

Ship to

email

Custad

dr

Ship_to_e

mail

Y Email Customer_entity Email N

Tax code

Customer

Tax_code1 Y Syteline_tax_c

ode

Customer_entity_int Syteline tax

code

Y Default =

"EXTRNL

" for US

and "NT"

for

Internatio

nal

Page 21: DRAFT - ULTRASOURCEECOM, ISD v5

UltraSource, Integration Specifications 21 January 2014

21 :: 23

3.0 System Integrations 3.1 Authorize.net

3.1.1 Structure Authorize. net

Summary The system will be configured to integrate with Authorize.net. Business Requirement Transmission Protocol The system will be configured to use Authorize.net’s web service for payment authorization.

DEG will not be responsible for troubleshooting any issues directly related to accessibility of this service.

Frequency Upon order submission (real-time). Security See www.authorize.net for details Format See www.authorize.net for details Validation See www.authorize.net for details Error / Exception Handling In the event that the web services are not available, the system is designed to handle those

scenarios with appropriate actions/error messages. Testing See www.authorize.net for details

3.2 UPS Address Validation

3.2.1 Structure UPS Address Validation

Summary The system will be integrated with UPS for address validation. Business Requirement Transmission Protocol The system will be configured to use the UPS web service for address validation. DEG will not

be responsible for troubleshooting any issues directly related to accessibility of this service. Frequency Upon submission of a new address in the shopping bag. Security See www.ups.com for details Format See www.ups.com for details Validation See www.ups.com for details Error / Exception Handling In the event that the web services are not available, the system is designed to handle those

scenarios with appropriate actions/error messages. Testing See www.ups.com for details

3.3 Avalara Avatax

3.3.1 Structure

Avalara Avatax

Summary The system will be integrated with Avalara Avatax for tax calculations. Business Requirement Transmission Protocol DEG will not be responsible for troubleshooting any issues directly related to accessibility of

this service. Frequency Upon checkout. Security See www.avalara.com for details

Page 22: DRAFT - ULTRASOURCEECOM, ISD v5

UltraSource, Integration Specifications 21 January 2014

22 :: 23

Avalara Avatax Format See www.avalara.com for details Validation See www.avalara.com for details Error / Exception Handling In the event that the web services are not available, the system is designed to handle those

scenarios with appropriate actions/error messages. Testing See www.avalara.com for details

Page 23: DRAFT - ULTRASOURCEECOM, ISD v5

UltraSource, Integration Specifications 21 January 2014

23 :: 23

4.0 Appendices

4.1 Questions ID Question Requirement Status Resolution

Q01

5.2 Document Versions Version Date Author Description

v01 06 December 2013 Jeremy McLain Initial draft v02 15 January 2014 Jeremy McLain Updated: 1.1.2 and 2.1.2 custaddr and curr_code. 1.2.2 and 2.2.2

contact_id. 1.5.2 Ship Via add note. 1.3.2 cust_seq. 1.8.2 Customer Order Line Release add note. 1.8.2 Quantity Returned add Magento fields. 2.3.2 cust_seq. 1.4.2 Added Magento fields.

v03 20 January 2014 Jeremy McLain Updated: 1.3.2 Cust_num to Cust_seq. Added 3.3 Avalara Avatax. Updated 1.6.2 Added Qty_rsvd_co

V04 20 January 2014 Jeremy McLain Updated 1.6.2 to: SELECT itemwhse.qty_on_hand, itemwhse.qty_alloc_co

FROM Koch_App.dbo.itemwhse itemwhse

V05 21 January 2014 Jeremy McLain Updated 1.2.2 Added Address Line 1, removed duplicate record for

Company.

Updated 2.2.2 Added Full Name, Preferred Name, Address Line 1, and

City. Removed duplicate record for Company.

5.3 Approvals Signature Date

______________________________________________________________________________________

Lavinia Ford, Marketing Manager, UltraSource

________________

______________________________________________________________________________________

Jeremy McLain, Business Analyst, DEG

________________