OS

From UG

(Difference between revisions)
Jump to: navigation, search
(→Terminology)
 
(28 intermediate revisions not shown)
Line 5: Line 5:
'''Mantis parent:''' 4172
'''Mantis parent:''' 4172
-
'''Mantis Category:''' Ocean Status
+
'''Mantis Category:''' proj: OS
'''Wiki category:''' [[:Category:Ocean Status]] - see all related wikis there
'''Wiki category:''' [[:Category:Ocean Status]] - see all related wikis there
-
== Definitions ==
+
== Terminology ==
 +
 
 +
* '''Booking Request (BR)''' (aka 300) - document advising details of cargo and exporter's requirements of its physical movement (Estimated data).
 +
 
 +
* '''Shipping Instructions (SI)''' (aka 304) - same as BR but Actual and more detailed data.
* '''VAN''' - A Value-added Network (VAN) is a hosted service offering that acts as an intermediary between business partners sharing standards based or proprietary data. In the context of this project we use VAN as an intermediary between Jaguar and all carriers for message exchange.
* '''VAN''' - A Value-added Network (VAN) is a hosted service offering that acts as an intermediary between business partners sharing standards based or proprietary data. In the context of this project we use VAN as an intermediary between Jaguar and all carriers for message exchange.
-
* '''GLN''' - '''VAN''' owned by '''Descartes'''
+
* '''Descartes''' - EDI vendor, VAN  
-
* '''Descartes''' - EDI vendor  
+
* '''Cargosmart''' - EDI vendor, VAN
 +
 
 +
* '''GLN''' - '''VAN''' owned by '''Descartes'''
-
* '''Cargosmart''' - EDI vendor
+
== Business Analysis ==
-
== Business Need ==
+
=== Core Business Need ===
-
Core needs is to automate the following:
+
Core need is to automate the following:
# booking ocean with carrier
# booking ocean with carrier
# sending  Shipping Instructions to carrier
# sending  Shipping Instructions to carrier
# receiving updates from carrier
# receiving updates from carrier
-
 
-
== Business Analysis and Requirements ==
 
=== Current Biz Process ===
=== Current Biz Process ===
-
Currently operators book with and get updates from ocean carriers manually. After that they manually update CT/Master record with the information they received.
+
Currently operators submit BR/SI to ocean carriers through the following options:
-
=== Phases ===
+
* online systems (OOCL, CargoSmart)
 +
* emails, xls
 +
 
 +
Phone calls used to escalate absence of space.
 +
 
 +
They manually update CT/Master record with the Ocean Status information they received.
 +
 
 +
There are some specifics across the offices and operators/client companies:
-
Phase one will cover OOCL carrier only.
+
* In HK Shipper is required to send BR/SI to Jag so then Jag forwards these docs to Carrier with minor changes
 +
* Some clients make decisions about what cargo to ship in the last moment. In such cases list of CTs in Master rec can be finalized also in the last moment. (HK and Arden in NY)
-
== Prerequisites ==
+
== Solution ==
 +
 
 +
=== Phases ===
 +
 
 +
Phase one will cover possibly OOCL carrier only.
=== Admin ===
=== Admin ===
Line 44: Line 60:
Add UI Admin for Ocean Status Module.
Add UI Admin for Ocean Status Module.
-
Controls:
+
See list of controls below:
-
* '''FTP Credentials''':
+
==== Admin Controls ====
-
** url textbox
+
-
** uname textbox
+
-
** pwd textbox
+
-
** for outbound and inbound messages
+
-
** for test and prod environments
+
-
* '''Period''' (min)
+
===== FTP Credentials =====
-
** how often we run Process that sends messages/checks for incoming
+
-
* '''Use Message <type X>'''
+
? Should we also have a choice of protocol/port or post it as a constant?
-
** checkbox
+
-
** on/off switch for activating each of four types of messages: 300, 301, 314, 315
+
-
* '''Steamshiplines''':
+
* '''Address''' (sub-domain name?)
-
** carriers participating in EDI exchange
+
** textbox
-
** multiselect
+
** format/min/max TBD
-
* '''Email Notification''':
+
* '''Login'''
-
** who will receive
+
** textbox
-
** Jaguar Users only
+
** format/min/max TBD
-
** see [[Users Selector]]
+
-
Location of this Admin in CT2 menu:
+
* '''Password'''
-
* Admin > EDI > Ocean Status
+
** textbox
-
* move all EDIs to Admin > EDI (EUAN/Air Status, D2L, Trendset)
+
** format/min/max TBD
-
Restrict access to this Admin (add line to access table)
+
Define above for:
 +
* test and prod environments (could be different)
 +
* inbound and outbound locations
-
=== Message Transport Level and Scheduled Process ===
+
... need to finalize above with Misha/AK/Vlad?
-
==== Message Transport level ====
+
===== Frequency =====
 +
 +
Frequency (in min) we run Process that sends outgoing messages and checks for incoming
 +
* numerical / min = 1 / max = 1440  [Note: 1440 min = 24 hours]
-
FTP protocol will be used on a transport level.
+
===== Steamshiplines =====
-
Location of Inbound and Outbound folders TBD (Vendor speccific).
+
Defines list of carriers that are currently connected for EDI exchange
 +
* multiselect
-
FTP credentials are defined in [[#Ocean Status Admin]].
+
==== Connecting through VAN vs connecting directly ====
-
==== Message process ====
+
We are still considering options as far as how integrate:
 +
* option 1) through VAN
 +
* option 2) directly to Steamshiplines
 +
** in this case [[#FTP Credentials]] and [[#Process Frequency]] are defined per Steamshipline
-
One process will send/receive all messages accordingly to frequency defined in Admin.
+
==== Admin Misc ====
-
Exception: 300 will be sent instantly.
+
'''Location/name''' of this Admin in CT2 menu:
 +
* Admin > EDI > Ocean EDI
 +
* move all EDIs to Admin > EDI (EUAN/Air Status, D2L, Trendset)
-
== HTS Feature ==
+
'''Restrict access''' to this Admin (add an option to user access table)
-
=== HTS field ===
+
=== Message Transport Level and Scheduled Process ===
-
'''HTS''':
+
==== Message Transport level ====
-
* meaning: Harmonized System Code that is classifying commodity. Example: '''2907.11.0000''' is for Phenol (Hydroxybenzene) and its salts. More info: [[Ocean_Status_Misc#HTS]]
+
-
* format:
+
-
** option 1: XXXX.XX, X represents number from 0 to 9
+
-
** option 2: XXXX.XX.XX, X represents number from 0 to 9
+
-
* is an attribute of commodity table [[Commodity]]
+
-
=== HTS Functionality ===
+
FTP protocol will be used on a transport level.
-
* for those CT records that correspond to Master that is used in EDI transmissions need additional column appear in CT Commodity table
+
Location of Inbound and Outbound folders TBD (Vendor speccific).
-
* If [[#HTS Spreadsheet]] is present then as user enters SKU system should auto-suggest HTS based on link in spreadsheet between SKU and HTS
+
FTP credentials are defined in [[#Ocean Status Admin]].
-
*  If [[#HTS Spreadsheet]] is not present then it is a free entry
+
==== Message process ====
-
=== HTS Spreadsheet ===
+
One process will send/receive all messages accordingly to [[#Process Frequency]] defined in Admin.
-
Under PO Issued By in ASN:
+
=== Messages ===
-
* Add option to upload separate xls that contains a list of SKUs and corresponding HTS
+
==== Message Flow ====
-
 
+
-
== Messages ==
+
Message Exchange Scenario that covers all message types:
Message Exchange Scenario that covers all message types:
Line 133: Line 144:
  .
  .
  day 35: (Shipment Status 315)        JAG <- VAN <- CARRIER
  day 35: (Shipment Status 315)        JAG <- VAN <- CARRIER
 +
.
 +
Note: VAN is optional
 +
Specifics of each message are described in wikis below.
-
EDI messages being used here to exchange info between Jaguar and Steamshiline through VAN - see below.
+
==== Booking Request ====
-
 
+
-
===== Booking Request =====
+
   
   
See [[EDI 300]]
See [[EDI 300]]
-
===== Booking Update and Cancellation =====
+
==== Booking Update and Cancellation ====
   
   
See [[EDI 300]]
See [[EDI 300]]
-
===== Booking Confirmation =====
+
==== Booking Confirmation ====
-
See [[EDI 301]]  
+
See [[EDI 300]]
-
===== Ocean Shipping Instructions =====
+
==== Ocean Shipping Instructions ====
See [[EDI 304]]  
See [[EDI 304]]  
-
===== Shipment Status =====
+
==== Shipment Status ====
See [[EDI 315]]
See [[EDI 315]]
-
 
-
== Reporting and Notifications ==
 
-
 
-
=== Master Comments Tab ===
 
-
 
-
Post all events/updates related to all messages here:
 
-
* Add record every time message was sent or received
 
-
* Record content of the message, operator who initiated.
 
-
 
-
=== Email Notifications ===
 
-
 
-
Send email to the Email Notification group defined in Ocean Status Admin.
 
-
 
-
Send in case of these situations:
 
-
 
-
* 301 received with Rejected status
 
-
 
-
* any 997 received with Rejected status
 
-
 
-
Attach received 997 or 301 with rejection status.
 
-
 
-
See e-mail below.
 
-
 
-
==== Email Template ====
 
-
 
-
<pre>
 
-
 
-
'''From''': cybertrax@jaguarfreight.com [cybertrax@jaguarfreight.com]
 
-
'''Sent''': <date>
 
-
'''To''': <user name>
 
-
'''Subject''': Rejected: <protocol number><message type><related master numbers>
 
-
 
-
Dear <user name>,
 
-
 
-
The following transmission was rejected:
 
-
 
-
<protocol number><message type><related master numbers>
 
-
 
-
This is automated message generated by Cybertrax 2 System.
 
-
 
-
</pre>
 
-
 
-
* <protocol number>: 300, 301, etc
 
-
* <protocol name>: Booking Request, etc
 
-
* <related master numbers>: Master numbers related to thi transmission. Example: M1234, M12414
 
-
 
-
=== Reports ===
 
-
 
-
==== List Masters ====
 
-
 
-
At the core we need a report that lists Masters in the system.
 
-
 
-
Increment existing List Masters report to enable operator to look at EDI activity for desired group of Masters singled out by applying certain filters such as Steamshipline and Estimated day of Departure or port.
 
-
 
-
Add these filters to List Masters:
 
-
 
-
* [[MOT]]
 
-
* [[Master#Steamshipline]]
 
-
* [[Master#Origin Terminal Estimated Date]]
 
-
* more filters TBD
 
-
 
-
Add these output fields:
 
-
 
-
* 300 message Status: new, transmitted, accepted, rejected
 
-
* 301 message Status: confirmed, rejected, conditionally accepted, pending
 
-
* 304 message Status: new, transmitted, accepted, rejected
 
-
* 315 message status: there are 10-20 possible values, show the last received
 
-
* more fields TBD
 
-
 
-
See mock up below.
 
-
 
-
[[File:List Masters.JPG | 700px]]
 
-
 
-
==== 997 Reporting ====
 
-
 
-
Optional for 300 (since we have 301 as a response).
 
-
 
-
Required for 304.
 
-
 
-
Dashboard similar to 997 dashboard in [[SI EDI]] (Data2Log).
 
-
 
-
Provides counter of Rejected messages.
 
-
 
-
Must be based off of [[#List Masters]].
 
-
 
-
==== Message specific Reports ====
 
-
 
-
Defined in respective wikis.
 
-
 
-
=== Log ===
 
-
 
-
Log all related events:
 
-
 
-
* when Process started
 
-
* when Process ended
 
-
* 300 sent
 
-
* 301 received
 
-
* 304 sent
 
-
* 315 received
 
-
* any 997 received
 
-
 
-
Additional info to include into log event description:
 
-
* related list of Master numbers
 
-
* status for incoming messages (such as accepted/rejected)
 

Current revision as of 00:18, 16 November 2013


Contents

[edit] Info

Mantis parent: 4172

Mantis Category: proj: OS

Wiki category: Category:Ocean Status - see all related wikis there

[edit] Terminology

  • Booking Request (BR) (aka 300) - document advising details of cargo and exporter's requirements of its physical movement (Estimated data).
  • Shipping Instructions (SI) (aka 304) - same as BR but Actual and more detailed data.
  • VAN - A Value-added Network (VAN) is a hosted service offering that acts as an intermediary between business partners sharing standards based or proprietary data. In the context of this project we use VAN as an intermediary between Jaguar and all carriers for message exchange.
  • Descartes - EDI vendor, VAN
  • Cargosmart - EDI vendor, VAN
  • GLN - VAN owned by Descartes

[edit] Business Analysis

[edit] Core Business Need

Core need is to automate the following:

  1. booking ocean with carrier
  2. sending Shipping Instructions to carrier
  3. receiving updates from carrier

[edit] Current Biz Process

Currently operators submit BR/SI to ocean carriers through the following options:

  • online systems (OOCL, CargoSmart)
  • emails, xls

Phone calls used to escalate absence of space.

They manually update CT/Master record with the Ocean Status information they received.

There are some specifics across the offices and operators/client companies:

  • In HK Shipper is required to send BR/SI to Jag so then Jag forwards these docs to Carrier with minor changes
  • Some clients make decisions about what cargo to ship in the last moment. In such cases list of CTs in Master rec can be finalized also in the last moment. (HK and Arden in NY)

[edit] Solution

[edit] Phases

Phase one will cover possibly OOCL carrier only.

[edit] Admin

Add UI Admin for Ocean Status Module.

See list of controls below:

[edit] Admin Controls

[edit] FTP Credentials

? Should we also have a choice of protocol/port or post it as a constant?

  • Address (sub-domain name?)
    • textbox
    • format/min/max TBD
  • Login
    • textbox
    • format/min/max TBD
  • Password
    • textbox
    • format/min/max TBD

Define above for:

  • test and prod environments (could be different)
  • inbound and outbound locations

... need to finalize above with Misha/AK/Vlad?

[edit] Frequency

Frequency (in min) we run Process that sends outgoing messages and checks for incoming

  • numerical / min = 1 / max = 1440 [Note: 1440 min = 24 hours]
[edit] Steamshiplines

Defines list of carriers that are currently connected for EDI exchange

  • multiselect

[edit] Connecting through VAN vs connecting directly

We are still considering options as far as how integrate:

[edit] Admin Misc

Location/name of this Admin in CT2 menu:

  • Admin > EDI > Ocean EDI
  • move all EDIs to Admin > EDI (EUAN/Air Status, D2L, Trendset)

Restrict access to this Admin (add an option to user access table)

[edit] Message Transport Level and Scheduled Process

[edit] Message Transport level

FTP protocol will be used on a transport level.

Location of Inbound and Outbound folders TBD (Vendor speccific).

FTP credentials are defined in #Ocean Status Admin.

[edit] Message process

One process will send/receive all messages accordingly to #Process Frequency defined in Admin.

[edit] Messages

[edit] Message Flow

Message Exchange Scenario that covers all message types: 

day 1:  (Booking Request 300)          JAG -> VAN -> CARRIER
.
day 1:  (Booking Confirmation 301)    JAG <- VAN <- CARRIER 
. 
day 3:  (Booking Update 300)          JAG -> VAN -> CARRIER
.
day 3:  (Booking Confirmation 301)    JAG <- VAN <- CARRIER
.
day 10: (Shipping Instructions 304)   JAG -> VAN -> CARRIER 
.
day 15: (Shipment Status 315)         JAG <- VAN <- CARRIER
.
day 35: (Shipment Status 315)         JAG <- VAN <- CARRIER
.
Note: VAN is optional

Specifics of each message are described in wikis below.

[edit] Booking Request

See EDI 300

[edit] Booking Update and Cancellation

See EDI 300

[edit] Booking Confirmation

See EDI 300

[edit] Ocean Shipping Instructions

See EDI 304

[edit] Shipment Status

See EDI 315

Retrieved from "https://wiki.jaguarfreight.com/OS"
Personal tools