EDI 300

From UG

Revision as of 22:10, 10 November 2013 (edit) Alex (Talk | contribs) (→Misc) ← Older edit		Current revision as of 15:10, 15 November 2013 (edit) (undo) Alex (Talk | contribs) (→CY Cutoff Date)
(127 intermediate revisions not shown)
Line 2:		Line 2:
	== Intro ==		== Intro ==
		+
		+	=== 300 ===
	EDI 300 is a '''Booking Request''' message.		EDI 300 is a '''Booking Request''' message.
Line 9:		Line 11:
	The shipper or forwarder can use this transaction set to reserve cargo space.		The shipper or forwarder can use this transaction set to reserve cargo space.
-	Types of 300 message:	+	=== 301 ===
-	* '''Initial Booking'''	+	EDI 301 is a '''Booking Confirmation''' message.
-	* '''Jaguar Booking Update''' - booking amendment, initiated by the customer. You can only send amendments on confirmed, conditionally accepted or pending bookings. For rejected bookings a new initial booking needs to be sent	+	This is '''incoming''' message sent by Carrier to Jaguar.
-		+
-	* '''Jaguar Booking Cancellation''' -  initiated by the customer. You can only send cancellations on confirmed, conditionally accepted or pending bookings.	+
-	* '''Carrier Booking Update''' - booking amendment, initiated by the carrier. Supported by some carriers.	+	This message is used to confirm/reject/update the Booking Request.
-		+
-	* '''Carrier Booking Cancellation''' -  initiated by the carrier.	+
	=== Message Flow ===		=== Message Flow ===
-	Below covers most scenarious except updates from carriers.	+	Below is a typical flow. See also [[#Actions]].
	[[File:300 and 301 exchange.png|700px]]		[[File:300 and 301 exchange.png|700px]]
		+
		+	=== Limitations ===
		+
		+	We impose this limitation:
		+
		+	At any moment in time there could be only one Booking Request/Update 300
		+	and related Booking Response 301
		+
		+	Theoretically we could send multiple alternative booking requests to:
		+
		+	* different steamshiplines (to maximize chance of any booking)
		+	* same steamshipline (say different dates)
		+
		+	but we are not going to support this now.
	== Business Process ==		== Business Process ==
-	=== Full Master BP ===	+	Below is defined for New Booking.
		+
		+	=== Actual Master BP ===
		+
		+	When Master contains '''actual''' data.
	* 1/ Combine CTs into GRPs and then into Master (currently not all operators are doing this at the moment of booking)		* 1/ Combine CTs into GRPs and then into Master (currently not all operators are doing this at the moment of booking)
	* 2/		* 2/
-	** Enter all required booking information such as containers, Vessel, Voyage, etc.	+	** Enter all missing booking related information (if any)
-	** Pass all [[#Validations]].	+	** Pass all validations.
		+
		+	* 3/ Send booking request from [[#EDI tab]]. Most data will come from Master fields.
-	* 3/ Send booking request by pressing a button in '''Master Context Menu'''. See [[#Master UI 1]].	+	=== Estimated Master BP ===
-	=== Empty Master BP ===	+	When Master contains '''estimated''' data.
	* 1/ create empty master from Master template		* 1/ create empty master from Master template
-	* 2/ steps 2,3 from [[#Regular BP]]	+	* 2/ steps 2,3 from [[#Actual Master BP]]
		+	** some data will be estimated and some of it entered on EDI template (example: weight per container)
	'''Note''': User will wrap CTs inside the master with one or more groups later on (before [[EDI 301]] is transmitted)		'''Note''': User will wrap CTs inside the master with one or more groups later on (before [[EDI 301]] is transmitted)
-	== Validations ==	+	== EDI tab ==
-	EDI transmission assumes strict validations.	+	This tab is active only if:
		+
		+	[[Master#Steamshipline]] in given Master is on the list of
		+	active carriers in OS Admin (see [[OS#Steamshiplines]])
		+	'''AND'''
		+	[[Master#Master Mode of Transport]] = Full Container Load (AW) OR
		+	Full Container Load (MLB)
		+
		+	NOTE:
		+	-----
		+	When Master MOT is set as FCL (AW or MLB) then CT/GRP could have MOT set as:
		+	FCL (AW) or
		+	FCL(MLB) or
		+	Client Consol
		+
		+	See mock up below.
		+
		+	[[File:EDI tab.JPG|700 px]]
		+
		+	=== Booking Request and Confirmation ===
		+
		+	'''Columns''':
		+
		+	* '''ANSI# ''' - 300 or 301 or 997
		+
		+	* '''Message type''' - Booking or Confirmation or Acknowledgement
		+
		+	* '''Date''' - date/time of update
		+
		+	* '''Event''' - see [[#Events]]
		+
		+	* '''By''' - Jag user name (First Name + Last Name) or CT2 or Carrier
		+
		+	* '''View Message''' - Link to human readable copy of a saved message
		+
		+	* '''XML''' - XML version of a message
		+
		+
		+	'''Rows''':
		+
		+	Each row corresponds to one update by operator or CT2 system or VAN/Carrier.
		+
		+	'''Actions''':
		+
		+	* '''create''' - see [[#300 Create]]
		+	* '''update''' - see [[#300 Update]]
		+	* '''cancel''' - see [[#300 Cancel]]
		+
		+	=== Shipping Instructions ===
		+
		+	See [[EDI 304]]
		+
		+	=== Status Updates ===
		+
		+	See [[EDI 315]]
		+
		+	=== Events ===
		+
		+	Each '''event''' relates to 300 message and leads to a new '''status''' with the same name.
		+
		+	'''300''':
		+	* '''created''' (new) - 300 was initiated by Jag user, XML created by CT2 and waiting scheduled time to be transmitted to VAN/Carrier
		+	* '''transmitted''' - 300 was posted into VAN/Carriers FTP folder, waiting to be read
		+	* '''updated''' - Jag user initiates updates to existing 300
		+	* '''cancelled''' - Jag user cancels existing 300
		+
		+	'''997''':
		+	* '''acknowledged''' - 300 has no errors (corresponds to 997 accepted) // set by VAN or carrier
		+	* '''error''' - significant errors found in 300 (syntax, structure, validations, etc)(corresponds to 997 rejected) // set by VAN or carrier
		+
		+	'''301''':
		+	* '''conditionally accepted''' - (300 was set as conditionally accepted by carrier)
		+	* '''pending''' - (300 was set as pending by carrier)
		+	* '''rejected''' (300 was rejected by carrier)
		+	* '''confirmed''' (300 was confirmed by carrier)
		+	* '''updated''' (300 was updated by carrier)
		+	* '''canceled''' (300 was canceled by carrier)
		+
		+	=== Message 300 ===
		+
		+	==== Actions ====
		+
		+	See actions available for each state:
		+
		+	[[File:Transition diagramm for 300 301.jpg| 700px]]
		+
		+	General Rule
		+	------------
		+	You can only send cancellations on confirmed,
		+	conditionally accepted or pending bookings.
		+
		+	==== 300 Create ====
		+
		+	Template to create new 300 request.
		+
		+	See [[#300 Message Form]]
		+
		+	Action Type displayed as Create.
		+
		+	==== 300 Update ====
		+
		+	Template to update 300 request.
		+
		+	Action Type displayed as Update.
		+
		+	See [[#300 Message Form]]
		+
		+	NOTE:
		+	-----
		+	System is not pulling data from last saved state of 300.
		+	System pulls from Master/other entities as if it is a new 300.
		+
		+	==== 300 Cancel ====
		+
		+	Present Confirmation pop-up:
		+
		+	Are you sure you want to cancel this Booking?
		+	[OK]  [Cancel]
		+
		+	On '''OK''':
		+	*  schedule cancellation message
		+	* send e-mail to user who submitted with details of submission
		+
		+	On '''Cancel''' return user to Master Editor.
		+
		+	==== 300 Message Form ====
		+
		+	Opens in pop-up.
		+
		+	Fields are defined in [[OOCL 300#300 Data Elements]].
		+
		+	All fields are read-only and are pulled from Master entity or other entities.
		+
		+	See mock up below.
		+
		+	[[File:300 template new general.JPG]]
		+
		+	==== Actions and Validations ====
		+
		+	If all required fields are present then show these buttons:
		+
		+	* '''Submit''' - submit message
		+	* '''Cancel''' - return to Est Tab
		+
		+	If not all required fields are present then indicate what fields needs to be filed in and show this button:
		+
		+	* '''OK''' - return to Est Tab
		+
		+	==== Reefer ====
		+
		+	If Cargo Nature = Reefer then "Reefer info section will be added".
-	All required fields mast be marked as "required". See [[#Master UI 1]].	+	TBD
-	On "Transmit" system should:	+	==== 300 Message View ====
-	* validate all fields and present user with all required fields. See [[#Required fields]]	+
-	* validate that all contents are assigned to containers in all CTs under Master	+
-	== Booking Menu ==	+	Is a read only version of [[#300 Message Form]] - without any action buttons.
-	* Add Buttons to initiate 300 messages:	+	=== Message 301 ===
-	** New Booking	+
-	** Update Booking	+
-	** Cancel Booking	+
-	* Buttons are active only if:	+	Once message is received appropriate fields in CT2 will be updated - see [[OOCL 300#301 Data Elements]].
-	** [[Master#Steamshipline]] in given Master is on the list of active carriers in OS Admin (see [[OS#Steamshiplines]]) AND	+
-	** MOT = FCL or Client Consol (hardcoded for now, in ph2 is a part of Admin)	+
-	* Messages will be scheduled as defined in [[OS#Frequency]] and confirmation pop-up will be shown.	+	==== 301 Message View ====
-	=== New Booking ===	+	Is a read only version of 301 Message sent by carriers.
-	* Once button is pressed system should:	+	Opens in pop-up.
-	** validate required fields	+
-	** show '''Booking Preview''' screen with all information that will be sent, missing required fields info and options to "Transmit" (disabled if not all mandatory fields are present) and "Go Back to Master Editor"	+
-	** on "Transmit" send 300 message	+
-	=== Update Booking ===	+	Fields are defined in [[OOCL 300#301 Data Elements]].
-	TBA	+
-	=== Cancel Booking ===	+	System will compare value of each field as received and as stored in Master and display appropriate field status for a user:
-	TBA	+
		+	* confirmed
		+	* new
		+	* changed
		+	See mock up below.
-	[[File:Book menu.png |400 px]]	+	[[File:301 example.JPG|500px]]
	== Reporting and Notifications ==		== Reporting and Notifications ==
Line 90:		Line 251:
	=== Master Comments Tab ===		=== Master Comments Tab ===
-	Post all events/updates related to all messages here:	+	Suggest not to duplicate here since we have log on EDI tab.
-	* Add record every time message was sent or received	+
-	* Record content of the message, operator who initiated.	+
	=== Email Notifications ===		=== Email Notifications ===
-	997?	+	Email all [[#Events]] to [[EDI 300#Export Operator]].
	==== Email Template ====		==== Email Template ====
Line 105:		Line 264:
	'''Sent''': <date>		'''Sent''': <date>
	'''To''': <user name>		'''To''': <user name>
-	'''Subject''': Rejected: <protocol number><message type><related master numbers>	+	'''Subject''': Rejected: <protocol number> <Event> <By> for <master number>
	Dear <user name>,		Dear <user name>,
-	The following transmission was rejected:	+	Status has changed for <master number>:
-	<protocol number><message type><related master numbers>	+	<protocol number> was <Event>
		+
		+	Updated by: <By>
	This is automated message generated by Cybertrax 2 System.		This is automated message generated by Cybertrax 2 System.
Line 117:		Line 278:
	</pre>		</pre>
-	* <protocol number>: 300, 301, etc	+	<Event> and <By> as defined in [[#Booking Request and Confirmation]].
-	* <protocol name>: Booking Request, etc	+
-	* <related master numbers>: Master numbers related to thi transmission. Example: M1234, M12414	+
	=== Reports ===		=== Reports ===
-	==== 997 Reporting ====	+	==== Updated List Masters Report ====
-	Optional for 300 (since we have 301 as a response).	+	At the core we need a report that lists Masters in the system.
-	Required for 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 Export Operator.
-	Dashboard similar to 997 dashboard in [[SI EDI]] (Data2Log).	+	Add these filters to List Masters:
-	Provides counter of Rejected messages.	+	* [[MOT]]
		+	* [[Master#Steamshipline]]
		+	* [[EDI 300#Created On Date]]
		+	* [[EDI 300#Export Operator]]
-	Must be based off of [[#List Masters]].	+	Add these output fields:
-	=== Log ===	+	* EDI Status
		+	** map to[[EDI 300#Events]]
-	Log all related events:	+	See mock up below.
-	* when Process started	+	[[File:List Masters.JPG | 700px]]
-	* when Process ended	+
-	* 300 sent	+
-	* 301 received	+
-	* 304 sent	+
-	* 315 received	+
-	* any 997 received	+
-	Additional info to include into log event description:	+	==== Rejected Booking Dashboard ====
-	* related list of Master numbers	+
-	* status for incoming messages (such as accepted/rejected)	+
-	== Data to Send ==	+	More details TBD once concept is approved.
-	* '''Traffic Mode'''	+	Based on [[#List Masters Report]]
-	** always = ''"FCL/FCL"''	+
-	=== Rate/Reference Information ===	+	Level 1.
-	* see [[#Contract Number]]	+	[[File:Rejected booking dashboard.JPG | 700px]]
-	=== Parties ===	+	Level 2.
-	* '''Shipper'''	+	[[File:List Masters BC status rejected.JPG | 700px]]
-	** [[Master#Master_Shipper]]	+
-	* '''Forwarder'''	+	==== Impending Events Dashboard ====
-	** [[Offices]] based on users login	+
-	* '''Consignee'''	+	* Impending cargo cut off report/dashboard.
-	** [[Master#Master_Consignee]]	+	* Impending documents cut off report/dashboard
-	=== Cargo ===	+	See mock up below.
-	* '''Outbound Traffic Mode'''	+	More details TBD once concept is approved.
-	** constant ''FCL: Full Container Load'' for FCL/FCL	+
-	* '''Inbound Traffic Mode'''	+	[[File:Impending db.JPG | 700px]]
-	** constant ''FCL: Full Container Load'' for FCL/FCL	+
-	* '''Cargo Nature'''	+	=== Log ===
-	** ''General / Reefer / Dangerous''	+
-	** use [[Master#Hazardous]], details TBD	+
		+	Log all [[#Events]].
-	* '''Cargo Descriptions'''	+	== Misc ==
-	** [[#Commodity]]	+
-	=== Routing ===	+	=== Move type ===
-	* '''Origin City'''	+	Need to change [[Master#Move Type/MBL]] list in Admin:
-	** for door/* moves: [[Master#Origin_Terminal]]	+
-	** for door/* moves: [[Master#Master_Pick-up]]	+
-	* '''Destination City'''	+	* archive "port to port" item
-	** for */port moves: [[Master#Destination_Terminal]]	+	* will have 4 items:
-	** for */port moves: [[Master#Master_Delivery_Address]]	+	** "door to port" rename into "door to cy"
		+	** "port to door" rename into "cy to door"
		+	** "door to door" leave as is
		+	** "cy/cy" rename into "cy to cy"
-	* '''Vessel Name'''	+	NOTE:
-	** [[Master#Vessel_Name]]	+	-----
		+	Alex: I feel we need to remove this from Admin and hard code
		+	as we say did with MOT.
		+	Marc: make this area very secure instead.
		+	Kostya: TBD
-	* '''Voyage Number'''	+	=== Jaguar Offices ===
-	** [[Master#Voyage_Num]]	+
-	* '''Intended Date Range'''	+	Tech Note
-	** sailing within X weeks from Date Y, details TBD	+	----------
		+	There is a problem.
		+	Office addr is stored in one field tblOffice.Address
		+	Need to re-factor DB table to add separate fields that hold Zip, City, etc
		+	and trigger to support existing field. Or other solution.
-	=== Container ===	+	=== Changes to Carriers Admin ===
-	For each size type:	+	==== Contract Number ====
-	* '''Quantity'''	+	Contract number for contract between Jaguar and Steamshipline.
-	** calculate from Master containers table	+
-	* '''Size Type'''	+	UI: Add to Admin > Carriers > Steamshiplines
-	** see [[#Container Type ISO Code]]	+
-	* '''Cargo Weight'''	+	* OOCL
-	** see [[OS#Add Weight per container]]	+	** Format: AN, 8 chars
		+	** example: MT136710
-	* '''Cargo Weight Unit''' (kg / lb)
-	** see [[OS#Add Weight per container]]
-	=== Trucking and Haulage ===	+	=== Changes to Container Size Type Admin ===
-	* '''Door Pickup'''	+	==== Container Size Type ISO Code ====
-	** options:  all 4 combinations of '''cy''' and '''door'''	+
-	** map to [[Master#Move_Type.2FMBL | Move Type/MBL ]] ''(Master Details tab. 2)''	+
-	*** cy = port	+
-	? do we need to add Appointment interface or always use "To be Advised"?	+	In Admin > Transportation > Container Size/Type
-	* '''Empty Container Pickup Request'''	+	* add field "ISO code", same format/validation as D2L codes
-	** O	+	* add Long Description field (100 char string)
-	** do we need this?	+
-	=== Special Requirements ===	+	NOTE:
		+	D2L codes are based on ISO but not identical.
		+	For example, open top type.
		+	In ISO it is tagged as "UT" or U0, U1 or .... or U5.
		+	In D2L classification it is "OT"
		+	References:
		+	ISO: http://en.wikipedia.org/wiki/ISO_6346
		+	D2L: [[File:Container_Codes.xls]]
		+	[[SI_EDI#SOW_18_Fix_Container_info]]
-	* '''Export Declaration'''	+	==== Reefer Indicator ====
-	** see [[#Export Declaration]]	+
-	* '''Special Stowage'''	+	Add "Reefer Indicator" attribute to container types. Values: "Y" or "No"
-	** see [[#Special Stowage]]	+
-	* '''Document Upload'''	+	=== Changes to Master Container Table ===
-	** O	+
-	** no need?	+
-	=== Booking Remarks ===	+	==== Container Weight ====
-	* [[#Booking Remarks]]	+	For every container table add columns/fields:
-	** OOCL Example: If an item is over one ton, enter the Gross Weight per package	+
-	== New Fields ==	+	* '''weight'''
		+	* '''unit'''
-	=== Export Declaration ===	+	Also add selector to choose one of the following:
-	* options:	+	* '''actual weight'''
-	** No Export Declaration	+	** calculated weight based on commodity assignments to containers
		+	** weight field will be read-only
-	=== Special Stowage ===	+	* '''estimated weight'''
		+	** in this case system will offer place to enter estimated weight required for EDI 300
		+	** this is for the case when no actual is available yet
		+	** store this into DB
-	* options:	+	* '''auto-populate max'''
-	** Stow below Deck	+	** in this case system will populate max weight for this type size of container
-	** Stow on Deck	+	** weight field will be read-only
-	** No Special Stowage	+	** default value
-	=== Booking Remarks ===	+	[[File:Container table.JPG| 700px]]
-	* required: N (used in some cases)	+	==== Container Weight Unit ====
-	* AN // size TBD	+
-	* UI: textarea	+
-	=== RF Temperature ===	+	Options:
-	* '''RF Temperature''' // Format: 9999.99 // Temperature Requirement for RF containers.	+	* kg
-	** UI: add to container profile; textfield; default = TBD	+	* lb
-	* '''RF Temperature Unit''' //  C (Celsius) or F(Farenheit) // Unit of measurement	+	==== Reefer Info ====
-	** 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.	+	If at least one contained is reefer - see [[#Reefer Indicator]] - then present additional form.
-	Editable in container table in M only or in CT as well when CTs are under Master.	+	Fields below are not per container - they are per container table / per Master.
-	==== Reefer Indicator ====	+	===== Generator Set =====
-	Add "Reefer Indicator" attribute to container types. Values: "Y" or "No"	+	One value from the list.
		+	Options: Not Required, Clip On, Underslung
-	=== Contract Number ===	+	UI: single select
-	Contract number for contract between Jaguar and Steamshipline.	+	===== RF Temperature =====
-	UI: Add to Admin > Carriers > Steamshiplines	+	* UI: textbox;
		+	* cannot be greater than 25 degrees Celsius or 77 degrees Fahrenheit and cannot be less than -30 degrees Celsius or -22 degrees Fahrenheit.
-	* OOCL	+	===== RF Temperature Unit =====
-	** Format: AN, 8 chars	+
-	** example: MT136710	+
-	=== AMS SCAC Code ===	+	* options: C (Celsius) or F(Farenheit) // Unit of measurement
		+	* UI: dropdown ; default = F;
-	* '''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'''.	+	===== Ventilation =====
-	=== Container Size Type ISO Code ===	+	* Numerical
		+	* min/max = 1/3 digits
-	* '''map''': see below	+	===== Ventilation Unit =====
-	* '''required''': Y	+
-	* '''EDI''':	+
-	* '''Notes''': cover all containers in the loop	+
		+	* options: Cubic Feet per minute, Cubic meter per hour, Degrees // Unit of measurement
		+	* UI: dropdown ; default = F;
-	Related to http://wiki.jaguarfreight.com/wiki/SI_EDI#SOW_18_Fix_Container_info	+	===== Sensitive Cargo =====
-	In Admin > Transportation > Container Size/Type	+	* options: Not Sensitive, Blood Plazma, Ice Cream, USDA Requirement
		+	* UI: dropdown ; default = F;
-	* add field "ISO code", same format/validation	+	===== CO2 =====
-	* add Long Description field (100 char string)	+
-	NOTE:	+	* Percentage of this gas.
-	D2L codes are based on ISO but not identical.	+	* numeric, 0 < x < 100
-	For example, open top type.	+
-	In ISO it is tagged as "UT" or U0, U1 or .... or U5.	+
-	In D2L classification it is "OT"	+
-	References:	+
-	ISO: http://en.wikipedia.org/wiki/ISO_6346	+
-	D2L: http://wiki.jaguarfreight.com/wiki/File:Container_Codes.xls	+
-	=== Est GW ===	+	===== O2 =====
-	* "Est GW" checkbox	+	* Percentage of this gas.
-	** NOTE: "Use Estimated Weight for Booking Request instead of actual?"	+	* numeric, 0 < x < 100
-	** above master container table	+
-	=== Add Weight per container ===	+	===== Container Atmosphere =====
-	* add extra column "GW" to cont table	+	One value from the list.
-	** with dropdown with '''unit''' (kg/lb) in the header of column	+
-	* if Est GW is checked then show show textfield in each line (float, format same as GW in commod table) else show calculated read only from CTs	+	Options:
-	** if CTs have mixed kg/lb then recalculate in '''unit''' above table	+	* AFAM,
		+	* CA,
		+	* MA,
		+	* Magnum,
		+	* No Preference
-	== Misc ==	+	UI: single select
-	=== Grouping inside Master ===	+	=== New Master Controls for 300 ===
-	Add ability to group/ungroup selected CTs inside the Master.	+	==== Hazardous ====
-	=== Extend Master Templates ===	+	[[Master#Hazardous]] is calculated from CTs that belong to Master.
-	Following additional fields must be copied at the moment of creating a template from Master Clone.	+	In there are no CTs in Master it would be set to No.
-	Add column / filter of user who created them.	+	We need to add option to set estimated hazardous:
		+	* checkbox "use estimated"
		+	** when use estimated is activated then show two options Y/N
-	== Reporting and Notifications ==	+	==== Special Stowage ====
-	=== Master Comments Tab ===	+	Add new Master field.
-	Post all events/updates related to all messages here:	+	Possible values:
-	* Add record every time message was sent or received	+
-	* Record content of the message, operator who initiated.	+
-	=== Email Notifications ===	+	* Stow below Deck
		+	* Stow on Deck
		+	* No Special Stowage
-	997?	+	UI: radio group
-	==== Email Template ====	+	Add to Master details bottom right - see mock up below.
-	<pre>	+	==== Booking Remarks ====
-	'''From''': cybertrax@jaguarfreight.com [cybertrax@jaguarfreight.com]	+	* AN // size 1000 chars
-	'''Sent''': <date>	+	* UI: textarea
-	'''To''': <user name>	+
-	'''Subject''': Rejected: <protocol number><message type><related master numbers>	+
-	Dear <user name>,	+	UI: Master Det tab, See mock up below.
-	The following transmission was rejected:	+	[[File:Special stowage.JPG|700px]]
-	<protocol number><message type><related master numbers>	+	=== New fields for 301 ===
-	This is automated message generated by Cybertrax 2 System.	+	==== CY Cutoff Date ====
-	</pre>	+	* // Date+Time // Last possible date cargo may be delivered to CY
		+	* Editable
		+	* M Det Tab, bottom right
-	* <protocol number>: 300, 301, etc	+	=== New Master Fields for reporting ===
-	* <protocol name>: Booking Request, etc	+
-	* <related master numbers>: Master numbers related to thi transmission. Example: M1234, M12414	+
-	=== Reports ===	+	==== Created On Date ====
-	==== 997 Reporting ====	+	* date Master was created
		+	* similar to this field that we have for CT
		+	* UI: read only
		+	* DB: name it CreatedOnDate
-	Optional for 300 (since we have 301 as a response).	+	==== Export Operator ====
-	Required for 304.	+	* Operator who is responsible for this record on Export side
		+	* default to user who created Master
		+	* UI: [[Users Selector]]
		+	* DB: name it ExportOperatorUserId
-	Dashboard similar to 997 dashboard in [[SI EDI]] (Data2Log).	+	=== Grouping inside Master ===
-	Provides counter of Rejected messages.	+	Add ability to group/ungroup selected CTs inside the Master.
-	Must be based off of [[#List Masters]].	+	=== Extended Master Templates ===
-	=== Log ===	+	Following additional fields must be copied at the moment of creating a template from Master Clone.
-	Log all related events:	+	Add column / filter of user who created them.
-	* when Process started	+	TBD: ask opers/team leads if they cross share
-	* when Process ended	+	or there is a benefit of cross sharing
-	* 300 sent	+
-	* 301 received	+
-	* 304 sent	+
-	* 315 received	+
-	* any 997 received	+
-	Additional info to include into log event description:	+	=== Make Address Text fields read only ===
-	* related list of Master numbers	+
-	* status for incoming messages (such as accepted/rejected)	+	Make the following fields read-only on Masters profile:
		+
		+	[[Master#Master Shipper Text]]
		+	[[Master#Master Consignee Text]]
		+	[[Master#Master Notify Text]]
		+	[[Master#Master Pick-up Text]]
		+	[[Master#Master Delivery Text]]
		+
		+	=== Tags for required fields ===
		+
		+	EDI transmission assumes strict validations.
		+
		+	All required fields mast be marked as colored "*" (say orange).
		+
		+	Add note (in orange): "* Required fields for Booking Confirmation"
	== EDI Vendor Implementations ==		== EDI Vendor Implementations ==
	* CargoSmart: [[CSmart 300]]		* CargoSmart: [[CSmart 300]]
		+
		+	== Wiki source files ==
		+
		+	[[File:BR+SI+designs Nov13a.xls]]

---

Current revision as of 15:10, 15 November 2013

Contents 1 Intro 1.1 300 1.2 301 1.3 Message Flow 1.4 Limitations 2 Business Process 2.1 Actual Master BP 2.2 Estimated Master BP 3 EDI tab 3.1 Booking Request and Confirmation 3.2 Shipping Instructions 3.3 Status Updates 3.4 Events 3.5 Message 300 3.5.1 Actions 3.5.2 300 Create 3.5.3 300 Update 3.5.4 300 Cancel 3.5.5 300 Message Form 3.5.6 Actions and Validations 3.5.7 Reefer 3.5.8 300 Message View 3.6 Message 301 3.6.1 301 Message View 4 Reporting and Notifications 4.1 Master Comments Tab 4.2 Email Notifications 4.2.1 Email Template 4.3 Reports 4.3.1 Updated List Masters Report 4.3.2 Rejected Booking Dashboard 4.3.3 Impending Events Dashboard 4.4 Log 5 Misc 5.1 Move type 5.2 Jaguar Offices 5.3 Changes to Carriers Admin 5.3.1 Contract Number 5.4 Changes to Container Size Type Admin 5.4.1 Container Size Type ISO Code 5.4.2 Reefer Indicator 5.5 Changes to Master Container Table 5.5.1 Container Weight 5.5.2 Container Weight Unit 5.5.3 Reefer Info 5.5.3.1 Generator Set 5.5.3.2 RF Temperature 5.5.3.3 RF Temperature Unit 5.5.3.4 Ventilation 5.5.3.5 Ventilation Unit 5.5.3.6 Sensitive Cargo 5.5.3.7 CO2 5.5.3.8 O2 5.5.3.9 Container Atmosphere 5.6 New Master Controls for 300 5.6.1 Hazardous 5.6.2 Special Stowage 5.6.3 Booking Remarks 5.7 New fields for 301 5.7.1 CY Cutoff Date 5.8 New Master Fields for reporting 5.8.1 Created On Date 5.8.2 Export Operator 5.9 Grouping inside Master 5.10 Extended Master Templates 5.11 Make Address Text fields read only 5.12 Tags for required fields 6 EDI Vendor Implementations 7 Wiki source files

[edit] Intro

[edit] 300

EDI 300 is a Booking Request message.

It is an outgoing Message: Jaguar sends info to Carrier.

The shipper or forwarder can use this transaction set to reserve cargo space.

[edit] 301

EDI 301 is a Booking Confirmation message.

This is incoming message sent by Carrier to Jaguar.

This message is used to confirm/reject/update the Booking Request.

[edit] Message Flow

Below is a typical flow. See also #Actions.

[edit] Limitations

We impose this limitation:

At any moment in time there could be only one Booking Request/Update 300 
and related Booking Response 301

Theoretically we could send multiple alternative booking requests to:

• different steamshiplines (to maximize chance of any booking)
• same steamshipline (say different dates)

but we are not going to support this now.

[edit] Business Process

Below is defined for New Booking.

[edit] Actual Master BP

When Master contains actual data.

• 1/ Combine CTs into GRPs and then into Master (currently not all operators are doing this at the moment of booking)

• 2/
  • Enter all missing booking related information (if any)
  • Pass all validations.

• 3/ Send booking request from #EDI tab. Most data will come from Master fields.

[edit] Estimated Master BP

When Master contains estimated data.

• 1/ create empty master from Master template
• 2/ steps 2,3 from #Actual Master BP
  • some data will be estimated and some of it entered on EDI template (example: weight per container)

Note: User will wrap CTs inside the master with one or more groups later on (before EDI 301 is transmitted)

[edit] EDI tab

This tab is active only if:

Master#Steamshipline in given Master is on the list of 
active carriers in OS Admin (see OS#Steamshiplines) 
AND
Master#Master Mode of Transport = Full Container Load (AW) OR
                                      Full Container Load (MLB) 

NOTE:
-----
When Master MOT is set as FCL (AW or MLB) then CT/GRP could have MOT set as:
FCL (AW) or
FCL(MLB) or
Client Consol 

See mock up below.

[edit] Booking Request and Confirmation

Columns:

• ANSI# - 300 or 301 or 997

• Message type - Booking or Confirmation or Acknowledgement

• Date - date/time of update

• Event - see #Events

• By - Jag user name (First Name + Last Name) or CT2 or Carrier

• View Message - Link to human readable copy of a saved message

• XML - XML version of a message

Rows:

Each row corresponds to one update by operator or CT2 system or VAN/Carrier.

Actions:

• create - see #300 Create
• update - see #300 Update
• cancel - see #300 Cancel

[edit] Shipping Instructions

See EDI 304

[edit] Status Updates

See EDI 315

[edit] Events

Each event relates to 300 message and leads to a new status with the same name.

300:

• created (new) - 300 was initiated by Jag user, XML created by CT2 and waiting scheduled time to be transmitted to VAN/Carrier
• transmitted - 300 was posted into VAN/Carriers FTP folder, waiting to be read
• updated - Jag user initiates updates to existing 300
• cancelled - Jag user cancels existing 300

997:

• acknowledged - 300 has no errors (corresponds to 997 accepted) // set by VAN or carrier
• error - significant errors found in 300 (syntax, structure, validations, etc)(corresponds to 997 rejected) // set by VAN or carrier

301:

• conditionally accepted - (300 was set as conditionally accepted by carrier)
• pending - (300 was set as pending by carrier)
• rejected (300 was rejected by carrier)
• confirmed (300 was confirmed by carrier)
• updated (300 was updated by carrier)
• canceled (300 was canceled by carrier)

[edit] Message 300

[edit] Actions

See actions available for each state:

General Rule
------------
You can only send cancellations on confirmed, 
conditionally accepted or pending bookings. 

[edit] 300 Create

Template to create new 300 request.

See #300 Message Form

Action Type displayed as Create.

[edit] 300 Update

Template to update 300 request.

Action Type displayed as Update.

See #300 Message Form

NOTE:
-----
System is not pulling data from last saved state of 300.
System pulls from Master/other entities as if it is a new 300.

[edit] 300 Cancel

Present Confirmation pop-up:

Are you sure you want to cancel this Booking?
[OK]  [Cancel]

On OK:

• schedule cancellation message
• send e-mail to user who submitted with details of submission

On Cancel return user to Master Editor.

[edit] 300 Message Form

Opens in pop-up.

Fields are defined in OOCL 300#300 Data Elements.

All fields are read-only and are pulled from Master entity or other entities.

See mock up below.

[edit] Actions and Validations

If all required fields are present then show these buttons:

• Submit - submit message
• Cancel - return to Est Tab

If not all required fields are present then indicate what fields needs to be filed in and show this button:

• OK - return to Est Tab

[edit] Reefer

If Cargo Nature = Reefer then "Reefer info section will be added".

TBD

[edit] 300 Message View

Is a read only version of #300 Message Form - without any action buttons.

[edit] Message 301

Once message is received appropriate fields in CT2 will be updated - see OOCL 300#301 Data Elements.

[edit] 301 Message View

Is a read only version of 301 Message sent by carriers.

Opens in pop-up.

Fields are defined in OOCL 300#301 Data Elements.

System will compare value of each field as received and as stored in Master and display appropriate field status for a user:

• confirmed
• new
• changed

See mock up below.

[edit] Reporting and Notifications

[edit] Master Comments Tab

Suggest not to duplicate here since we have log on EDI tab.

[edit] Email Notifications

Email all #Events to EDI 300#Export Operator.

[edit] Email Template

'''From''': cybertrax@jaguarfreight.com [cybertrax@jaguarfreight.com]
'''Sent''': <date>
'''To''': <user name>
'''Subject''': Rejected: <protocol number> <Event> <By> for <master number>

Dear <user name>,

Status has changed for <master number>:

<protocol number> was <Event> 

Updated by: <By>

This is automated message generated by Cybertrax 2 System.

<Event> and <By> as defined in #Booking Request and Confirmation.

[edit] Reports

[edit] Updated List Masters Report

At the core we need a report that lists Masters in the system.

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 Export Operator.

Add these filters to List Masters:

• MOT
• Master#Steamshipline
• EDI 300#Created On Date
• EDI 300#Export Operator

Add these output fields:

• EDI Status
  • map toEDI 300#Events

See mock up below.

[edit] Rejected Booking Dashboard

More details TBD once concept is approved.

Based on #List Masters Report

Level 1.

Level 2.

[edit] Impending Events Dashboard

• Impending cargo cut off report/dashboard.
• Impending documents cut off report/dashboard

See mock up below.

More details TBD once concept is approved.

[edit] Log

Log all #Events.

[edit] Misc

[edit] Move type

Need to change Master#Move Type/MBL list in Admin:

• archive "port to port" item
• will have 4 items:
  • "door to port" rename into "door to cy"
  • "port to door" rename into "cy to door"
  • "door to door" leave as is
  • "cy/cy" rename into "cy to cy"

NOTE:
-----
Alex: I feel we need to remove this from Admin and hard code 
as we say did with MOT.
Marc: make this area very secure instead.
Kostya: TBD

[edit] Jaguar Offices

Tech Note
----------
There is a problem.
Office addr is stored in one field tblOffice.Address
Need to re-factor DB table to add separate fields that hold Zip, City, etc
and trigger to support existing field. Or other solution. 

[edit] Changes to Carriers Admin

[edit] Contract Number

Contract number for contract between Jaguar and Steamshipline.

UI: Add to Admin > Carriers > Steamshiplines

• OOCL
  • Format: AN, 8 chars
  • example: MT136710

[edit] Changes to Container Size Type Admin

[edit] Container Size Type ISO Code

In Admin > Transportation > Container Size/Type

• add field "ISO code", same format/validation as D2L codes
• add Long Description field (100 char string)

NOTE:
D2L codes are based on ISO but not identical.
For example, open top type.
In ISO it is tagged as "UT" or U0, U1 or .... or U5.
In D2L classification it is "OT"
References:
ISO: http://en.wikipedia.org/wiki/ISO_6346
D2L: File:Container Codes.xls
SI_EDI#SOW_18_Fix_Container_info

[edit] Reefer Indicator

Add "Reefer Indicator" attribute to container types. Values: "Y" or "No"

[edit] Changes to Master Container Table

[edit] Container Weight

For every container table add columns/fields:

• weight
• unit

Also add selector to choose one of the following:

• actual weight
  • calculated weight based on commodity assignments to containers
  • weight field will be read-only

• estimated weight
  • in this case system will offer place to enter estimated weight required for EDI 300
  • this is for the case when no actual is available yet
  • store this into DB

• auto-populate max
  • in this case system will populate max weight for this type size of container
  • weight field will be read-only
  • default value

[edit] Container Weight Unit

Options:

• kg
• lb

[edit] Reefer Info

If at least one contained is reefer - see #Reefer Indicator - then present additional form.

Fields below are not per container - they are per container table / per Master.

[edit] Generator Set

One value from the list.

Options: Not Required, Clip On, Underslung

UI: single select

[edit] RF Temperature

• UI: textbox;
• cannot be greater than 25 degrees Celsius or 77 degrees Fahrenheit and cannot be less than -30 degrees Celsius or -22 degrees Fahrenheit.

[edit] RF Temperature Unit

• options: C (Celsius) or F(Farenheit) // Unit of measurement
• UI: dropdown ; default = F;

[edit] Ventilation

• Numerical
• min/max = 1/3 digits

[edit] Ventilation Unit

• options: Cubic Feet per minute, Cubic meter per hour, Degrees // Unit of measurement
• UI: dropdown ; default = F;

[edit] Sensitive Cargo

• options: Not Sensitive, Blood Plazma, Ice Cream, USDA Requirement
• UI: dropdown ; default = F;

[edit] CO2

• Percentage of this gas.
• numeric, 0 < x < 100

[edit] O2

• Percentage of this gas.
• numeric, 0 < x < 100

[edit] Container Atmosphere

One value from the list.

Options:

• AFAM,
• CA,
• MA,
• Magnum,
• No Preference

UI: single select

[edit] New Master Controls for 300

[edit] Hazardous

Master#Hazardous is calculated from CTs that belong to Master.

In there are no CTs in Master it would be set to No.

We need to add option to set estimated hazardous:

• checkbox "use estimated"
  • when use estimated is activated then show two options Y/N

[edit] Special Stowage

Add new Master field.

Possible values:

• Stow below Deck
• Stow on Deck
• No Special Stowage

UI: radio group

Add to Master details bottom right - see mock up below.

[edit] Booking Remarks

• AN // size 1000 chars
• UI: textarea

UI: Master Det tab, See mock up below.

[edit] New fields for 301

[edit] CY Cutoff Date

• // Date+Time // Last possible date cargo may be delivered to CY
• Editable
• M Det Tab, bottom right

[edit] New Master Fields for reporting

[edit] Created On Date

• date Master was created
• similar to this field that we have for CT
• UI: read only
• DB: name it CreatedOnDate

[edit] Export Operator

• Operator who is responsible for this record on Export side
• default to user who created Master
• UI: Users Selector
• DB: name it ExportOperatorUserId

[edit] Grouping inside Master

Add ability to group/ungroup selected CTs inside the Master.

[edit] Extended Master Templates

Following additional fields must be copied at the moment of creating a template from Master Clone.

Add column / filter of user who created them.

TBD: ask opers/team leads if they cross share 
     or there is a benefit of cross sharing

[edit] Make Address Text fields read only

Make the following fields read-only on Masters profile:

Master#Master Shipper Text
Master#Master Consignee Text
Master#Master Notify Text
Master#Master Pick-up Text
Master#Master Delivery Text

[edit] Tags for required fields

EDI transmission assumes strict validations.

All required fields mast be marked as colored "*" (say orange).

Add note (in orange): "* Required fields for Booking Confirmation"

[edit] EDI Vendor Implementations

• CargoSmart: CSmart 300

[edit] Wiki source files

File:BR+SI+designs Nov13a.xls