OS

From UG

(Difference between revisions)
Jump to: navigation, search
(→Master Editor)
(→Terminology)
 
(117 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.
 +
 +
* '''Descartes''' - EDI vendor, VAN
 +
 +
* '''Cargosmart''' - EDI vendor, VAN
* '''GLN''' - '''VAN''' owned by '''Descartes'''
* '''GLN''' - '''VAN''' owned by '''Descartes'''
-
* '''Descartes''' - EDI vendor
+
== Business Analysis ==
-
* '''Cargosmart''' - EDI vendor
+
=== Core Business Need ===
-
== Business Need ==
+
Core need is to automate the following:
-
 
+
-
Core needs 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.
-
== Solution ==
+
They manually update CT/Master record with the Ocean Status information they received.
-
=== Admin ===
+
There are some specifics across the offices and operators/client companies:
-
Add the following entities into the system manageable through Admin or Property file:
+
* In HK Shipper is required to send BR/SI to Jag so then Jag forwards these docs to Carrier with minor changes
-
* GLN FTP credentials: url, uname, pwd
+
* 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)
-
* update frequency in secs
+
-
* on/off switch for transmission/receiving each of four types of messages
+
-
* List of steamshiplines participating: On/Off switch
+
== Solution ==
-
* email notification groups
+
-
* ISO container size/types (small chance that we need this!)
+
-
* contract number+account bullet to Steamshipline entity (lane specific)
+
-
* commodity customs codes table (HTS)
+
-
=== HTS Feature ===
+
=== Phases ===
-
What:
+
Phase one will cover possibly OOCL carrier only.
-
* Add this field to commodity table (for each line): HTS Number
+
=== Admin ===
-
(commodity customs code). See http://www.foreign-trade.com/reference/hscode.htm
+
-
* This field should be presented and (be required only) for records that will be booked/processed through EDI
+
Add UI Admin for Ocean Status Module.
-
* For both ASN and CT records
+
-
How: (ideas):
+
See list of controls below:
-
* UI: combobox? tree?
+
==== Admin Controls ====
-
* how to upload into system and how to maintain it there?
+
-
* for ASN recs entered by Shipper on Client 
+
-
* automation option:
+
===== FTP Credentials =====
-
** remember link btw HTS and SKU as it gets entered so we can do "auto-suggest"?
+
-
** upload xls with link btw SKU and xls? (PO Issued By specific?)
+
-
=== Changes in Master Object and Master Profile ===
+
? Should we also have a choice of protocol/port or post it as a constant?
-
==== New Master Fields ====
+
* '''Address''' (sub-domain name?)
 +
** textbox
 +
** format/min/max TBD
-
Add new fields:
+
* '''Login'''
 +
** textbox
 +
** format/min/max TBD
-
* Temperature Requirement (if RF containers are requested)
+
* '''Password'''
 +
** textbox
 +
** format/min/max TBD
-
** numerical from and numerical to
+
Define above for:
 +
* test and prod environments (could be different)
 +
* inbound and outbound locations
-
* Cargo Cut Off Date
+
... need to finalize above with Misha/AK/Vlad?
-
* Documentation Cut Off Date
+
===== 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]
-
* CY open date
+
===== Steamshiplines =====
-
* CY cut-off date
+
Defines list of carriers that are currently connected for EDI exchange
 +
* multiselect
-
* MBL Type (original / express)
+
==== Connecting through VAN vs connecting directly ====
-
* AES (Export Declaration #) ex USA
+
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
-
* AMS / ACI code
+
==== Admin Misc ====
-
* Any wood packing material
+
'''Location/name''' of this Admin in CT2 menu:
 +
* Admin > EDI > Ocean EDI
 +
* move all EDIs to Admin > EDI (EUAN/Air Status, D2L, Trendset)
-
==== Master General and Details Tab ====
+
'''Restrict access''' to this Admin (add an option to user access table)
-
* Add these fields to General Tab:
+
=== Message Transport Level and Scheduled Process ===
-
 
+
-
* Add these fields to Details Tab:
+
-
 
+
-
* Add validation pop-ups for required messages
+
-
 
+
-
==== Master Context Menu ====
+
-
 
+
-
Add Booking Request button to initiate [[300 Booking Request]] message.
+
-
 
+
-
Message will be sent immediately and confirmation pop-up will be shown.
+
-
 
+
-
==== Master Doc Tab ====
+
-
 
+
-
* detect that given master is a subject to EDI transmission (carrier is on the EDI list)
+
-
* modify MBL template to accommodate EDI case (add new fields)
+
-
* on "generate report" send [[304 Shipping Instructions]] and generate pdf, show confirmation
+
-
 
+
-
==== Master Comments Tab ====
+
-
 
+
-
Post all events/updates related to all messages here:
+
-
* Every time message was sent or received
+
-
 
+
-
=== Messaging ===
+
==== Message Transport level ====
==== Message Transport level ====
Line 130: Line 117:
FTP protocol will be used on a transport level.
FTP protocol will be used on a transport level.
-
Location of Inbound and Outbound folders TBD.
+
Location of Inbound and Outbound folders TBD (Vendor speccific).
-
FTP credentials are defined in Admin.
+
FTP credentials are defined in [[#Ocean Status Admin]].
-
==== All Message Types ====
+
==== Message process ====
-
This is a list of EDI messages being used here to exchange info between Jaguar and Steamshiline through Descartes GLN - see below.
+
One process will send/receive all messages accordingly to [[#Process Frequency]] defined in Admin.
-
===== Booking Request =====
+
=== Messages ===
-
+
-
* see [[300 Booking Request]]
+
-
** The shipper or forwarder can use this transaction set to reserve cargo space.
+
-
** Also used for '''Booking Update''' and '''Booking Cancellation'''
+
-
===== Booking Confirmation =====
+
==== Message Flow ====
-
* see [[301 Booking Confirmation]]
+
Message Exchange Scenario that covers all message types:
-
** This message is used to confirm the Booking Request (Message 300).
+
-
===== Ocean Shipping Instructions =====
+
  day 1: (Booking Request 300)          JAG -> VAN -> CARRIER
-
 
+
-
* see [[304 Shipping Instructions]]
+
-
** This message supplies the same information as the Shipper's Letter of Instruction. It provides all the information necessary to prepare and distribute a contract of carriage (ocean bill of lading and other shipping documents).
+
-
 
+
-
===== Shipment Status =====
+
-
 
+
-
* [[315 Shipment Status]]
+
-
** This message is used to report status or event details (cargo receipt, departure and arrival) for individual shipments.
+
-
 
+
-
==== Message Exchange Scenarios ====
+
-
 
+
-
===== Example 1 =====
+
-
 
+
-
  day 1: (Booking Request 300)          JAG -> VAN -> CARRIER
+
  .
  .
  day 1:  (Booking Confirmation 301)    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 4: (Shipping Instructions 304)  JAG -> VAN -> CARRIER  
+
  day 10: (Shipping Instructions 304)  JAG -> VAN -> CARRIER  
  .
  .
  day 15: (Shipment Status 315)        JAG <- VAN <- CARRIER
  day 15: (Shipment Status 315)        JAG <- VAN <- CARRIER
  .
  .
  day 35: (Shipment Status 315)        JAG <- VAN <- CARRIER
  day 35: (Shipment Status 315)        JAG <- VAN <- CARRIER
 +
.
 +
Note: VAN is optional
-
===== Example 2 =====
+
Specifics of each message are described in wikis below.
-
[[File:300 and 301 exchange.png|700px]]
+
==== Booking Request ====
 +
 +
See [[EDI 300]]
-
=== Email Notifications ===
+
==== Booking Update and Cancellation ====
-
 
+
-
Notify group defined in Admin when these messages are received:
+
See [[EDI 300]]
-
 
+
-
* Booking Conf 301
+
-
* Status 315
+
-
 
+
-
=== 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.
+
-
 
+
-
Human initiated:
+
-
* send 300
+
-
* send 304
+
-
 
+
-
EDI initiated:
+
-
* received 301
+
-
* received various 315
+
-
 
+
-
=== Access ===
+
-
 
+
-
Restrict access as required.
+
-
 
+
-
== SOWs ==
+
-
 
+
-
=== SOW 1 Implement Admin ===
+
-
 
+
-
'''mantis''': TBD
+
-
 
+
-
'''dev''': AK
+
-
 
+
-
'''spec''': [[#Admin]]
+
-
 
+
-
=== SOW 2 Modify CT and Master Editor ===
+
-
 
+
-
'''mantis''': TBD
+
-
 
+
-
'''dev''': AK
+
-
 
+
-
'''spec''': [[#Master Editor]] and [[#CT Editor]]
+
-
 
+
-
=== SOW 3 Implement All Message Types ===
+
-
 
+
-
'''mantis''': TBD
+
-
 
+
-
'''dev''': Misha
+
-
 
+
-
'''spec''': [[#All Message Types]]
+
-
 
+
-
=== SOW 4 Implement Email Notifications ===
+
-
 
+
-
'''mantis''': TBD
+
-
 
+
-
'''dev''': AK
+
-
 
+
-
'''spec''': [[#Email Notifications]]
+
-
 
+
-
=== SOW 5 Implement Reports ===
+
-
 
+
-
'''mantis''': TBD
+
-
 
+
-
'''dev''': Kostya
+
-
 
+
-
'''spec''': [[#Reports]]
+
-
 
+
-
=== SOW 6 Implement Log ===
+
-
 
+
-
'''mantis''': TBD
+
-
'''dev''': AK
+
==== Booking Confirmation ====
-
'''spec''': [[#Log]]
+
See [[EDI 300]]
-
=== SOW 7 Implement Message Transport level ===
+
==== Ocean Shipping Instructions ====
-
'''mantis''': TBD
+
See [[EDI 304]]
-
'''dev''': AK
+
==== Shipment Status ====
-
'''spec''': [[#Message Transport level]]
+
See [[EDI 315]]

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