V6 B2B Upload Checklist
Our B2B (Business to Business) interface looks after data/file upload/download of
Consignment data between Omnix and 3rd party systems. This is an automated process
which will upload/download data based on various triggers (on receipt, time intervals,
workflow stage, etc.).
This document describes the steps & details required to implement an interface with a
Customer.
1. Customer must provide the customer code for the shipper and a user who is been
associated to this shipper.
Cust_code
User_id
_ _ _ _ _ _ _ _ _ ] up to 10 characters
_ _ _ _ _ _ _ _ _ ] in capital letters
2. Customer need choose the type of upload protocol for this shipper, eg. MAIL (email)
or sFTP, or HTTP, etc. (secure protocols like sFTP or HTTPs is preferred)
For MAIL, we require the sender email address which the shipper will send through
email as a attachment. Customer can also choose to accept all files send from an email
domain name.
Email
Domain
_ _ _ _ _ _ _ _ _ _ _ @ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _.com.au
www._ _ _ _ _ _ _ _ _ _ _ _ _.com.au
For sFTP, we need the name of the FTP folder on the server (require IP address), user &
password. If this does not exists we can set this up for you.
Server IP Address
Path
User
Password
_ _ _. _ _ _._ _ _._ _ _
/_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
] will be assigned
]
3. Omnix provides a number of standard file format templates for uploading & parcing of
data, which include XML, CSV & EXCEL. Sample templates are attached for use and will
streamline the upload of data.
In addition a custom format can be supported, however this will take time to develop,
test & deploy and all cost will need to be bourne by the Customer. In this case the
Customer need to provide details of their custom format, including, file type, column
headings, default values (and their meaning), any business logic (rate basis), units of
measure, etc. We will use this information to develop conversion logic which tells where
and how to populate each node from their file.
© Omnix 2013
Last Updated 28/06/13
A Sample data file is required from Customer for testing purpose.
Omnix does provide a standard CSV download utility in the Customer web interface for
all users with access (login/password). In addition custom downloads can also be
developed at the Customer's cost to automated downloads, which can be based on time
intervals or stage/data driven.
These can be customised in terms of data format/type, protocol, etc.
4. Omnix can then provide an estimate of time needed to complete work (Modspec) and
on sign off by the Customer commence the work and initial test.
5. Omnix will install the new interface on the Customer server for live testing
(Acceptance Testing).
6. Special Logic
Function
Insert/Update Logic;
Duplicate Flag
Update/Insert
Level
Action
Value
Global
Customer
Customer
Set flag (Y/N)
Set flag (Y/N)
Update (time limit days)
Insert (new)
…..........
…..........
.....30(default)
…..>30...
7. Your Site specific requirements;
Job Types
….............................................................................................
Services Types ….............................................................................................
Vehicle Types ….............................................................................................
Freight Classes ….............................................................................................
Products (global) …...........................................................................................
© Omnix 2013
Last Updated 28/06/13