OS

From UG

Revision as of 05:39, 11 October 2013 (edit) Alex (Talk | contribs) (→Master Editor) ← Older edit		Current revision as of 00:18, 16 November 2013 (edit) (undo) Alex (Talk | contribs) (→Terminology)
(157 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 ==
-	* '''GLN''' - platform that is intermediary between Jaguar and all carriers for message exchange	+	* '''Booking Request (BR)''' (aka 300) - document advising details of cargo and exporter's requirements of its physical movement (Estimated data).
-	* '''Descartes''' - EDI vendor who owns GLN	+	* '''Shipping Instructions (SI)''' (aka 304) - same as BR but Actual and more detailed data.
-	== Business Need ==	+	* '''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.
-	Core needs is to automate the following:	+	* '''Descartes''' - EDI vendor, VAN
-	# book ocean with carrier	+	* '''Cargosmart''' - EDI vendor, VAN
-	# send  Shipping Instructions to carrier	+
-	# receive updates from carrier	+
-	== Business Analysis and Requirements ==	+	* '''GLN''' - '''VAN''' owned by '''Descartes'''
-	=== Current Biz Process ===	+	== Business Analysis ==
-	Currently operators book with and get updates from ocean carriers manually. After that they manually update CT/Master record with the information they received.	+	=== Core Business Need ===
-	=== Phases ===	+	Core need is to automate the following:
-	Phase one will cover OOCL carrier only.	+	# booking ocean with carrier
		+	# sending  Shipping Instructions to carrier
		+	# receiving updates from carrier
-	== Solution ==	+	=== Current Biz Process ===
-	=== Admin ===	+	Currently operators submit BR/SI to ocean carriers through the following options:
-	Add the following entities into the system manageable through Admin or Property file:	+	* online systems (OOCL, CargoSmart)
		+	* emails, xls
-	* GLN FTP credentials: url, uname, pwd	+	Phone calls used to escalate absence of space.
-	* List of steamshiplines participating: On/Off switch	+
-	* email notification group	+
-	* various core EDI related entities such as ISO container types;	+
-	* additional EDI related entities, full list contain 29 of them - see [[File:Codelists - SMF OCEAN - v01.18.xlsx ]]	+
-	=== Master Editor ===	+	They manually update CT/Master record with the Ocean Status information they received.
-	==== Master New Fields ====	+	There are some specifics across the offices and operators/client companies:
-	Add new fields - list TBD.	+	* In HK Shipper is required to send BR/SI to Jag so then Jag forwards these docs to Carrier with minor changes
-	==== Master Context Menu ====	+	* 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)
-	Add Booking Request button to initiate [[GLN 300]] message.	+	== Solution ==
-	==== Master Doc Tab ====	+	=== Phases ===
-	* modify MBL template to accomodate new fields	+	Phase one will cover possibly OOCL carrier only.
-	* on "generate report" send [[GLN 304]]	+
-	==== Master Comments Tab ====	+	=== Admin ===
-		+
-	Post all events/updates related to all messages here.	+
-		+
-	==== Validations ====	+
-		+
-	* Add required fields for transmissions - exact list TBD.	+
-		+
-	* Add validations related to message sequencing:	+
-	** prohibit sending Shipping Instructions before Booking Request	+
-		+
-	=== Messaging ===	+
-		+
-	==== Types of Messages ====	+
-		+
-	This is a list of EDI messages being used here to exchange info between Jaguar and Steamshiline through Descartes GLN:	+
-		+
-	* '''Booking Request''' ( [[GLN 300]] )	+
-	** The shipper or forwarder can use this transaction set to reserve cargo space.	+
-	** Also used for '''Booking Update''' and '''Booking Cancellation'''	+
-		+
-	* '''Booking Confirmation''' ( [[GLN 301]] )	+
-	** This message is used to confirm the Booking Request (Message 300).	+
-		+
-	* '''Ocean Shipping Instructions''' ( [[GLN 304]] )	+
-	** 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''' ( [[GLN 315]] )	+
-	** This message is used to report status or event details (cargo receipt, departure and arrival) for individual shipments.	+
-		+
-	==== Message Exchange Scenarios ====	+
-		+
-	* '''Scenario One (main):'''	+
-		+
-	1) Jag operator initiates Booking Request 300	+
-	Jaguar -> GLN -> Steamshipline	+
-		+
-	2) Steamshipline responds with Booking Confirmation 301	+
-	Jaguar <- GLN <- Steamshipline	+
-		+
-	3) Jag operator sends Ocean Shipping Instructions 304	+
-	Jaguar -> GLN -> Steamshipline	+
-		+
-	4) Steamshipline sends Shipment Status 315 with Actual Departure Date:	+
-	Jaguar <- GLN <- Steamshipline	+
-		+
-	5) Steamshipline sends Shipment Status 315 with Actual Arrival Date:	+
-	Jaguar <- GLN <- Steamshipline	+
-		+
-	=== Email Notifications ===	+
-		+
-	Notify group defined in Admin when these messages are received:	+
-		+
-	* 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]]	+	Add UI Admin for Ocean Status Module.
-	* [[Master#Steamshipline]]	+
-	* [[Master#Origin Terminal Estimated Date]]	+
-	* more filters TBD	+
-	Add these output fields:	+	See list of controls below:
-	* 300 message Status: yet, sent	+	==== Admin Controls ====
-	* 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 ====	+	===== FTP Credentials =====
-	Dashboard for exceptions (rejected messages, etc).	+	? Should we also have a choice of protocol/port or post it as a constant?
-	Details TBD.	+	* '''Address''' (sub-domain name?)
		+	** textbox
		+	** format/min/max TBD
-	==== Option 3 ====	+	* '''Login'''
		+	** textbox
		+	** format/min/max TBD
-	Impending cargo cut off report/dashboard.	+	* '''Password'''
		+	** textbox
		+	** format/min/max TBD
-	Impending documents cut off report/dashboard	+	Define above for:
		+	* test and prod environments (could be different)
		+	* inbound and outbound locations
-	=== Log ===	+	... need to finalize above with Misha/AK/Vlad?
-	Log all related events.	+	===== 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]
-	Human initiated:	+	===== Steamshiplines =====
-	* send 300	+
-	* send 304	+
-	EDI initiated:	+	Defines list of carriers that are currently connected for EDI exchange
-	* received 301	+	* multiselect
-	* received various 315	+
-	== SOWs ==	+	==== Connecting through VAN vs connecting directly ====
-	=== SOW 1 Admin ===	+	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
-	'''mantis''': TBD	+	==== Admin Misc ====
-	'''dev''': AK	+	'''Location/name''' of this Admin in CT2 menu:
		+	* Admin > EDI > Ocean EDI
		+	* move all EDIs to Admin > EDI (EUAN/Air Status, D2L, Trendset)
-	'''spec''': [[#Admin]]	+	'''Restrict access''' to this Admin (add an option to user access table)
-	=== SOW 2 Master Editor ===	+	=== Message Transport Level and Scheduled Process ===
-	'''mantis''': TBD	+	==== Message Transport level ====
-	'''dev''': AK	+	FTP protocol will be used on a transport level.
-	'''spec''': [[#Master Editor]]	+	Location of Inbound and Outbound folders TBD (Vendor speccific).
-	=== SOW 3 Messaging ===	+	FTP credentials are defined in [[#Ocean Status Admin]].
-	'''mantis''': TBD	+	==== Message process ====
-	'''dev''': Misha	+	One process will send/receive all messages accordingly to [[#Process Frequency]] defined in Admin.
-	'''spec''': [[#Messaging]]	+	=== Messages ===
-	=== SOW 4 Email Notifications ===	+	==== Message Flow ====
-	'''mantis''': TBD	+	Message Exchange Scenario that covers all message types:
-	'''dev''': AK	+	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
-	'''spec''': [[#Email Notifications]]	+	Specifics of each message are described in wikis below.
-	=== SOW 5 Reports ===	+	==== Booking Request ====
		+
		+	See [[EDI 300]]
-	'''mantis''': TBD	+	==== Booking Update and Cancellation ====
		+
		+	See [[EDI 300]]
-	'''dev''': Kostya	+	==== Booking Confirmation ====
-	'''spec''': [[#Reports]]	+	See [[EDI 300]]
-	=== SOW 6 Log ===	+	==== Ocean Shipping Instructions ====
-	'''mantis''': TBD	+	See [[EDI 304]]
-	'''dev''': AK	+	==== Shipment Status ====
-	'''spec''': [[#Log]]	+	See [[EDI 315]]

---

Current revision as of 00:18, 16 November 2013

Contents 1 Info 2 Terminology 3 Business Analysis 3.1 Core Business Need 3.2 Current Biz Process 4 Solution 4.1 Phases 4.2 Admin 4.2.1 Admin Controls 4.2.1.1 FTP Credentials 4.2.1.2 Frequency 4.2.1.3 Steamshiplines 4.2.2 Connecting through VAN vs connecting directly 4.2.3 Admin Misc 4.3 Message Transport Level and Scheduled Process 4.3.1 Message Transport level 4.3.2 Message process 4.4 Messages 4.4.1 Message Flow 4.4.2 Booking Request 4.4.3 Booking Update and Cancellation 4.4.4 Booking Confirmation 4.4.5 Ocean Shipping Instructions 4.4.6 Shipment Status

[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:

• option 1) through VAN
• option 2) directly to Steamshiplines
  • in this case #FTP Credentials and #Process Frequency are defined per Steamshipline

[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