OS

From UG

Revision as of 07:04, 11 October 2013 (edit) Alex (Talk | contribs) (→SOWs) ← Older edit		Current revision as of 00:18, 16 November 2013 (edit) (undo) Alex (Talk | contribs) (→Terminology)
(145 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 groups	+
-	* ISO container size/types	+
-	* contract number+account bullet to Steamshipline entity (lane specific)	+
-	* commodity customs codes table (selected when SKU is defined)	+
-	=== CT Editor ===	+	They manually update CT/Master record with the Ocean Status information they received.
-	Add this attribute to commodity table (for each line):	+	There are some specifics across the offices and operators/client companies:
-	* HTS # (commodity customs code)	+	* In HK Shipper is required to send BR/SI to Jag so then Jag forwards these docs to Carrier with minor changes
-	** dropdown	+
-	** list of codes is defined in Admin	+
-	=== Master Editor ===	+	* 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)
-	==== Master New Fields ====	+	== Solution ==
-	Add new fields:	+	=== Phases ===
-	* Temperature Requirement (if RF containers are requested)	+	Phase one will cover possibly OOCL carrier only.
-	* Cargo Cut Off Date	+
-	* Documentation Cut Off Date	+
-	* CY open date	+
-	* CV cut-off date	+
-	* MBL Type (original / express)	+
-	* AES (Export Declaration #) ex USA	+
-	* AMS / ACI code	+
-	* Any wood packing material	+
-	==== Master Context Menu ====	+	=== Admin ===
-	Add Booking Request button to initiate [[GLN 300]] message.	+	Add UI Admin for Ocean Status Module.
-	==== Master Doc Tab ====	+	See list of controls below:
-	* modify MBL template to accomodate new fields	+	==== Admin Controls ====
-	* on "generate report" send [[GLN 304]]	+
-	==== Master Comments Tab ====	+	===== FTP Credentials =====
-	Post all events/updates related to all messages here.	+	? Should we also have a choice of protocol/port or post it as a constant?
-	==== Master Validations ====	+	* '''Address''' (sub-domain name?)
		+	** textbox
		+	** format/min/max TBD
-	* Add required fields for transmissions - exact list TBD.	+	* '''Login'''
		+	** textbox
		+	** format/min/max TBD
-	* Add validations related to message sequencing:	+	* '''Password'''
-	** prohibit sending Shipping Instructions before Booking Request	+	** textbox
		+	** format/min/max TBD
-	=== Messaging ===	+	Define above for:
		+	* test and prod environments (could be different)
		+	* inbound and outbound locations
-	==== Message Transport level ====	+	... need to finalize above with Misha/AK/Vlad?
-		+
-	FTP protocol will be used on a transport level.	+
-		+
-	Location of Inbound and Outbound folders TBD.	+
-		+
-	FTP credentials are defined in Admin.	+
-		+
-	==== All Message Types ====	+
-		+
-	This is a list of EDI messages being used here to exchange info between Jaguar and Steamshiline through Descartes GLN - see below.	+
-	===== Booking Request =====	+	===== Frequency =====
-	* see [[GLN 300]]	+	Frequency (in min) we run Process that sends outgoing messages and checks for incoming
-	** The shipper or forwarder can use this transaction set to reserve cargo space.	+	* numerical / min = 1 / max = 1440  [Note: 1440 min = 24 hours]
-	** Also used for '''Booking Update''' and '''Booking Cancellation'''	+
-	===== Booking Confirmation =====	+	===== Steamshiplines =====
-	* see [[GLN 301]]	+	Defines list of carriers that are currently connected for EDI exchange
-	** This message is used to confirm the Booking Request (Message 300).	+	* multiselect
-	===== Ocean Shipping Instructions =====	+	==== Connecting through VAN vs connecting directly ====
-	* see [[GLN 304]]	+	We are still considering options as far as how integrate:
-	** 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).	+	* option 1) through VAN
		+	* option 2) directly to Steamshiplines
		+	** in this case [[#FTP Credentials]] and [[#Process Frequency]] are defined per Steamshipline
-	===== Shipment Status =====	+	==== Admin Misc ====
-	* [[GLN 315]]	+	'''Location/name''' of this Admin in CT2 menu:
-	** This message is used to report status or event details (cargo receipt, departure and arrival) for individual shipments.	+	* Admin > EDI > Ocean EDI
		+	* move all EDIs to Admin > EDI (EUAN/Air Status, D2L, Trendset)
-	==== Message Exchange Scenarios ====	+	'''Restrict access''' to this Admin (add an option to user access table)
-	'''Scenario One (main):'''	+	=== Message Transport Level and Scheduled Process ===
-	1) Jag operator initiates Booking Request 300	+	==== Message Transport level ====
-	Jaguar -> GLN -> Steamshipline	+
-	2) Steamshipline responds with Booking Confirmation 301	+	FTP protocol will be used on a transport level.
-	Jaguar <- GLN <- Steamshipline	+
-	3) Jag operator sends Ocean Shipping Instructions 304	+	Location of Inbound and Outbound folders TBD (Vendor speccific).
-	Jaguar -> GLN -> Steamshipline	+
-	4) Steamshipline sends Shipment Status 315 with Actual Departure Date:	+	FTP credentials are defined in [[#Ocean Status Admin]].
-	Jaguar <- GLN <- Steamshipline	+
-	5) Steamshipline sends Shipment Status 315 with Actual Arrival Date:	+	==== Message process ====
-	Jaguar <- GLN <- Steamshipline	+
-	=== Email Notifications ===	+	One process will send/receive all messages accordingly to [[#Process Frequency]] defined in Admin.
-	Notify group defined in Admin when these messages are received:	+	=== Messages ===
-	* Booking Conf 301	+	==== Message Flow ====
-	* Status 315	+
-	=== Reports ===	+	Message Exchange Scenario that covers all message types:
-	==== Option 1 ====	+	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
-	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.	+	Specifics of each message are described in wikis below.
-	Add these filters to List Masters:	+	==== Booking Request ====
		+
		+	See [[EDI 300]]
-	* [[MOT]]	+	==== Booking Update and Cancellation ====
-	* [[Master#Steamshipline]]	+
-	* [[Master#Origin Terminal Estimated Date]]	+	See [[EDI 300]]
-	* 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''': 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 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