OS

From UG

(Difference between revisions)
Jump to: navigation, search
(→SOWs)
(→Terminology)
 
(77 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.
-
=== Admins and Codes ===
+
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
-
Some of these can be kept in Properties file and not UI.
+
* 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)
-
* FTP credentials: url, uname, pwd
+
== Solution ==
-
** outbound and inbound
+
-
** for test and prod envir
+
-
* Period (min)
+
=== Phases ===
-
* on/off switch for transmission/receiving each of four types of messages
+
Phase one will cover possibly OOCL carrier only.
-
* list of steamshiplines participating: On/Off switch
+
=== Admin ===
-
* email notification groups
+
Add UI Admin for Ocean Status Module.
-
TBD location/name of item in Admin, for example Air status/Ocean status together under Ops EDI.
+
See list of controls below:
-
==== Container Type Admin ====
+
==== Admin Controls ====
-
===== Container Type ISO Code =====
+
===== FTP Credentials =====
-
Related to http://wiki.jaguarfreight.com/wiki/SI_EDI#SOW_18_Fix_Container_info
+
? Should we also have a choice of protocol/port or post it as a constant?
-
In Admin > Transportation > Container Size/Type
+
* '''Address''' (sub-domain name?)
 +
** textbox
 +
** format/min/max TBD
-
If D2L codes are same as ISO then:
+
* '''Login'''
-
+
** textbox
-
* Rename "D2L codes" into "ISO code"
+
** format/min/max TBD
-
If D2L codes are NOT same as ISO then:
+
* '''Password'''
 +
** textbox
 +
** format/min/max TBD
-
* add additional field "ISO code", same format/validation
+
Define above for:
 +
* test and prod environments (could be different)
 +
* inbound and outbound locations
-
In both cases:
+
... need to finalize above with Misha/AK/Vlad?
-
===== Reefer Indicator =====
+
===== 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]
-
Add "Reefer Indicator" attribute to container types. Values: "Y" or "No"
+
===== Steamshiplines =====
-
==== Steamshipline Admin ====
+
Defines list of carriers that are currently connected for EDI exchange
 +
* multiselect
-
Add new attributes to Steamshipline object - see below.
+
==== Connecting through VAN vs connecting directly ====
-
===== Contract Number =====
+
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
-
Contract number for contract between Jaguar and Steamshipline.
+
==== Admin Misc ====
-
UI: Add to Admin > Carriers > Steamshiplines
+
'''Location/name''' of this Admin in CT2 menu:
 +
* Admin > EDI > Ocean EDI
 +
* move all EDIs to Admin > EDI (EUAN/Air Status, D2L, Trendset)
-
Format: TBD
+
'''Restrict access''' to this Admin (add an option to user access table)
-
===== Account Bullet =====
+
=== Message Transport Level and Scheduled Process ===
-
 
+
-
Additional info related to [[#Contract Number]].
+
-
 
+
-
This is lane (Country or Region) specific.
+
-
 
+
-
UI: Add to Admin > Carriers > Steamshiplines
+
-
 
+
-
Format: TBD
+
-
 
+
-
In Steamshipline Admin or Ocean Status Admin.
+
-
 
+
-
==== Misc Constants ====
+
-
 
+
-
===== AMS SCAC Code =====
+
-
 
+
-
* '''AMS SCAC Code''' -  SCAC/ACI Code.  For USA trade, this is a code with normally 4 digits for AMS filing, we need this code to submit AMS filing and Jaguar is registered. Our AMS SCAC code is '''JAFR'''.
+
-
 
+
-
==== Access ====
+
-
 
+
-
Restrict access.
+
-
 
+
-
=== HTS Feature ===
+
-
 
+
-
What:
+
-
 
+
-
* Add this field to commodity table (for each line): HTS Number
+
-
(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
+
-
* For both ASN and CT records
+
-
 
+
-
How: (ideas):
+
-
 
+
-
* UI: combobox? tree?
+
-
* how to upload into system and how to maintain it there?
+
-
* for ASN recs entered by Shipper on Client 
+
-
 
+
-
==== HTS Automation ====
+
-
 
+
-
* postpone for phase 2?
+
-
* 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 ===
+
-
 
+
-
==== New Container Fields ====
+
-
 
+
-
===== RF Temperature =====
+
-
 
+
-
* '''RF Temperature''' // Format: 9999.99 // Temperature Requirement for RF containers.
+
-
** UI: add to container profile; textfield; default = TBD
+
-
 
+
-
* '''RF Temperature Unit''' //  C (Celsius) or F(Farenheit) // Unit of measurement
+
-
** UI: add to container profile; dropdown ; default = TBD;
+
-
 
+
-
Above needs to be presented/validated only for RF type of containers - use [[#Reefer Indicator]] to distinguish.
+
-
 
+
-
Editable in M only or in CT as well when CTs are under Master.
+
-
 
+
-
==== New Master Fields ====
+
-
 
+
-
Add new attributes to Master Entity:
+
-
 
+
-
* '''Cargo Cut Off Date''' // Date+Time // Last possible date cargoes may be delivered to a ship or designated point.
+
-
** Read only, M Det Tab
+
-
 
+
-
* '''Documentation Cut Off Date''' // Date+Time // Last possible date documentation can be sent.
+
-
** Read only, M Det Tab
+
-
 
+
-
* '''CY open date''' // Date+Time // First possible date cargoes may be delivered to a ship or designated point.
+
-
 
+
-
* '''CY cut-off date''' - same as Cargo Cut Off Date?
+
-
 
+
-
* '''MBL Type''' // "original" or "express" // Defines what type of MBL is used. Takes one of two values: "original" or "express"
+
-
** UI: add to Master Gen Tab below "2. Move type/MBL", default to "original"
+
-
 
+
-
* '''AES Number''' // AN, 15 digits // aka Internal Transaction Number (ITN), id received from Automated Export System. The ITN consists of the letters “AES” followed by the ITN: for example, “AES X20080930987654. See also http://en.wikipedia.org/wiki/Automated_Export_System
+
-
 
+
-
* '''Wood packing material''' // "used" or "not used" // Any wooden packaging material is used or not, this is what we have to declare to the shipping line for every single booking to USA and Canada.
+
-
 
+
-
==== 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 Bill Of Lading
+
-
 
+
-
==== Master Comments Tab ====
+
-
 
+
-
Post all events/updates related to all messages here:
+
-
* Every time message was sent or received, content of the message, operator who initiated
+
-
 
+
-
=== Messaging ===
+
==== Message Transport level ====
==== Message Transport level ====
Line 198: 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]].
==== Message process ====
==== Message process ====
-
One process will send/receive all messages accordingly to frequency defined in Admin.
+
One process will send/receive all messages accordingly to [[#Process Frequency]] defined in Admin.
-
==== All Message Types ====
+
=== Messages ===
-
This is a list of EDI messages being used here to exchange info between Jaguar and Steamshiline through Descartes GLN - see below.
+
==== Message Flow ====
-
===== Booking Request =====
+
Message Exchange Scenario that covers all message types:
-
+
-
See [[EDI 300]]
+
-
 
+
-
===== Booking Confirmation =====
+
-
 
+
-
See [[EDI 301]]
+
-
 
+
-
===== Ocean Shipping Instructions =====
+
-
 
+
-
See [[EDI 304]]
+
-
 
+
-
===== Shipment Status =====
+
-
 
+
-
See [[EDI 315]]
+
-
 
+
-
==== Message Exchange Scenarios ====
+
-
 
+
-
===== Example 1 =====
+
-
  day 1: (Booking Request 300)          JAG -> VAN -> CARRIER
+
  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 4:  (Shipping Instructions 304)  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 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 ====
 +
 +
See [[EDI 300]]
-
Notify group defined in Admin when these messages are received:
+
==== Booking Confirmation ====
-
* Booking Conf 301
+
See [[EDI 300]]
-
* Status 315
+
-
=== Reports ===
+
==== Ocean Shipping Instructions ====
-
==== Option 1 ====
+
See [[EDI 304]]
-
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.
+
==== Shipment Status ====
-
Add these filters to List Masters:
+
See [[EDI 315]]
-
 
+
-
* [[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
+
-
 
+
-
== SOWs ==
+
-
 
+
-
=== SOW 1 Implement Admin ===
+
-
 
+
-
'''mantis''': [http://mantis.jaguarfreight.com/mantis/view.php?id=4332 4332]
+
-
 
+
-
'''dev''': AK
+
-
 
+
-
'''spec''': [[#Admins and Codes]]
+
-
 
+
-
=== SOW 2 Modify CT and Master Editor ===
+
-
 
+
-
'''mantis''': [http://mantis.jaguarfreight.com/mantis/view.php?id=4357 4357]
+
-
 
+
-
'''dev''': AK
+
-
 
+
-
'''spec''': [[#Master Editor]] and [[#CT Editor]]
+
-
 
+
-
=== SOW 3 Implement All Message Types ===
+
-
 
+
-
'''mantis''': [http://mantis.jaguarfreight.com/mantis/view.php?id=4334 4334]
+
-
 
+
-
'''dev''': Misha
+
-
 
+
-
'''spec''': [[#All Message Types]]
+
-
 
+
-
=== SOW 4 Implement Email Notifications ===
+
-
 
+
-
'''mantis''': [http://mantis.jaguarfreight.com/mantis/view.php?id=4335 4335]
+
-
 
+
-
'''dev''': AK
+
-
 
+
-
'''spec''': [[#Email Notifications]]
+
-
 
+
-
=== SOW 5 Implement Reports ===
+
-
 
+
-
'''mantis''': [http://mantis.jaguarfreight.com/mantis/view.php?id=4336 4336]
+
-
 
+
-
'''dev''': Kostya
+
-
 
+
-
'''spec''': [[#Reports]]
+
-
 
+
-
=== SOW 6 Implement Log ===
+
-
 
+
-
'''mantis''': [http://mantis.jaguarfreight.com/mantis/view.php?id=4337 4337]
+
-
 
+
-
'''dev''': AK
+
-
 
+
-
'''spec''': [[#Log]]
+
-
 
+
-
=== SOW 7 Implement Message Transport level ===
+
-
 
+
-
'''mantis''': [http://mantis.jaguarfreight.com/mantis/view.php?id=4338 4338]
+
-
 
+
-
'''dev''': AK
+
-
 
+
-
'''spec''': [[#Message Transport level]]
+
-
 
+
-
=== SOW 8 HTS Feature  ===
+
-
 
+
-
'''mantis''': [http://mantis.jaguarfreight.com/mantis/view.php?id=4333 4333]
+
-
 
+
-
'''dev''': AK
+
-
 
+
-
'''spec''': [[#HTS Feature]]
+

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