OS

From UG

(Difference between revisions)
Jump to: navigation, search
(→General Ocean Status Admin)
(→Terminology)
 
(38 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
-
Phase one will cover OOCL carrier only.
+
Phone calls used to escalate absence of space.
 +
They manually update CT/Master record with the Ocean Status information they received.
-
== General and Preliminary ==
+
There are some specifics across the offices and operators/client companies:
-
=== Ocean Status Admin ===
+
* In HK Shipper is required to send BR/SI to Jag so then Jag forwards these docs to Carrier with minor changes
-
Add UI Admin for Ocean Status Module.
+
* 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)
-
Controls:
+
== Solution ==
-
* '''FTP Credentials''':
+
=== Phases ===
-
** url textbox
+
-
** uname textbox
+
-
** pwd textbox
+
-
** for outbound and inbound messages
+
-
** for test and prod environments
+
-
* '''Period''' (min)
+
Phase one will cover possibly OOCL carrier only.
-
** how often we run Process that sends messages/checks for incoming
+
-
* '''Use Message <type X>'''
+
=== Admin ===
-
** checkbox
+
-
** on/off switch for activating each of four types of messages: 300, 301, 314, 315
+
-
* '''Steamshiplines''':
+
Add UI Admin for Ocean Status Module.
-
** carriers participating in EDI exchange
+
-
** multiselect
+
-
* '''Email Notification''':
+
See list of controls below:
-
** who will receive
+
-
** Jaguar Users only
+
-
** see [[Users Selector]]
+
-
Location of this Admin in CT2 menu:
+
==== Admin Controls ====
-
* Admin > EDI > Ocean Status
+
-
* move all EDIs to Admin > EDI (EUAN/Air Status, D2L, Trendset)
+
-
Restrict access to this Admin (add line to access table)
+
===== FTP Credentials =====
-
=== Message Transport Level and Scheduled Process ===
+
? Should we also have a choice of protocol/port or post it as a constant?
-
==== Message Transport level ====
+
* '''Address''' (sub-domain name?)
 +
** textbox
 +
** format/min/max TBD
-
FTP protocol will be used on a transport level.
+
* '''Login'''
 +
** textbox
 +
** format/min/max TBD
-
Location of Inbound and Outbound folders TBD.
+
* '''Password'''
 +
** textbox
 +
** format/min/max TBD
-
FTP credentials are defined in Admin.
+
Define above for:
 +
* test and prod environments (could be different)
 +
* inbound and outbound locations
-
==== Message process ====
+
... need to finalize above with Misha/AK/Vlad?
-
One process will send/receive all messages accordingly to frequency defined in Admin.
+
===== 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]
 +
===== Steamshiplines =====
-
=== HTS Feature ===
+
Defines list of carriers that are currently connected for EDI exchange
 +
* multiselect
-
==== HTS field ====
+
==== Connecting through VAN vs connecting directly ====
-
'''HTS''':
+
We are still considering options as far as how integrate:
-
* 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]]
+
* option 1) through VAN
-
* format:
+
* option 2) directly to Steamshiplines
-
** option 1: XXXX.XX, X represents number from 0 to 9
+
** in this case [[#FTP Credentials]] and [[#Process Frequency]] are defined per Steamshipline
-
** option 2: XXXX.XX.XX, X represents number from 0 to 9
+
-
* is an attribute of commodity table [[Commodity]]
+
-
==== HTS Functionality ====
+
==== Admin Misc ====
-
* for those CT records that correspond to Master that is used in EDI transmissions need additional column appear in CT Commodity table
+
'''Location/name''' of this Admin in CT2 menu:
 +
* Admin > EDI > Ocean EDI
 +
* move all EDIs to Admin > EDI (EUAN/Air Status, D2L, Trendset)
-
* If [[#HTS Spreadsheet]] is present then as user enters SKU system should auto-suggest HTS based on link in spreadsheet between SKU and HTS
+
'''Restrict access''' to this Admin (add an option to user access table)
-
*  If [[#HTS Spreadsheet]] is not present then it is a free entry
+
=== Message Transport Level and Scheduled Process ===
-
==== HTS Spreadsheet ====
+
==== Message Transport level ====
-
Under PO Issued By in ASN:
+
FTP protocol will be used on a transport level.
-
* Add option to upload separate xls that contains a list of SKUs and corresponding HTS
+
Location of Inbound and Outbound folders TBD (Vendor speccific).
-
== All Message Types ==
+
FTP credentials are defined in [[#Ocean Status Admin]].
-
This is a list of EDI messages being used here to exchange info between Jaguar and Steamshiline through VAN - see below.
+
==== Message process ====
-
===== Booking Request =====
+
One process will send/receive all messages accordingly to [[#Process Frequency]] defined in Admin.
-
+
-
See [[EDI 300]]
+
-
===== Booking Update and Cancellation =====
+
=== Messages ===
-
+
-
See [[EDI 300]]
+
-
 
+
-
===== Booking Confirmation =====
+
-
 
+
-
See [[EDI 301]]
+
-
 
+
-
===== Ocean Shipping Instructions =====
+
-
 
+
-
See [[EDI 304]]
+
-
 
+
-
===== Shipment Status =====
+
-
 
+
-
See [[EDI 315]]
+
-
==== Message Exchange Scenarios ====
+
==== Message Flow ====
-
===== Example 1 =====
+
Message Exchange Scenario that covers all message types:
  day 1:  (Booking Request 300)          JAG -> VAN -> CARRIER
  day 1:  (Booking Request 300)          JAG -> VAN -> CARRIER
Line 156: Line 144:
  .
  .
  day 35: (Shipment Status 315)        JAG <- VAN <- CARRIER
  day 35: (Shipment Status 315)        JAG <- VAN <- CARRIER
 +
.
 +
Note: VAN is optional
-
== Reporting and Notifications ==
+
Specifics of each message are described in wikis below.
-
=== Master Comments Tab ===
+
==== Booking Request ====
 +
 +
See [[EDI 300]]
-
Post all events/updates related to all messages here:
+
==== Booking Update and Cancellation ====
-
* Every time message was sent or received, content of the message, operator who initiated
+
 +
See [[EDI 300]]
-
=== Email Notifications ===
+
==== Booking Confirmation ====
-
Send email to the Email Notification group defined in Ocean Status Admin.
+
See [[EDI 300]]
-
Send in case of these situations:
+
==== Ocean Shipping Instructions ====
-
* 301 received with Rejected status
+
See [[EDI 304]]
-
* any 997 received with Rejected status
+
==== Shipment Status ====
-
Attach received 997 or 301 with rejection status.
+
See [[EDI 315]]
-
 
+
-
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 ===
+
-
 
+
-
==== Option 1 ====
+
-
 
+
-
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: yet, sent
+
-
* 301 message Status: confirmed, rejected, conditionally accepted, pending
+
-
* 304 message Status: yet, sent
+
-
* 315 message status: there are 10-20 possible values, show the last received
+
-
* more fields TBD
+
-
 
+
-
==== Option 2 ====
+
-
 
+
-
Dashboard for exceptions (rejected messages, etc).
+
-
 
+
-
Details TBD.
+
-
 
+
-
==== Option 3 ====
+
-
 
+
-
Impending cargo cut off report/dashboard.
+
-
 
+
-
Impending documents cut off report/dashboard
+
-
 
+
-
=== 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