Ocean Docs Commodity Table (feature)

From UG

Revision as of 20:10, 15 January 2010 (edit) Alex (Talk | contribs) (Created page with 'Category: Ops Pdfs Common == Parent Mantis == [http://mantis.jaguarfreight.com/mantis/view.php?id=tbd tbd] == Business Needs and Requirements == == Technical Specification…') ← Older edit		Current revision as of 12:22, 5 August 2011 (edit) (undo) Roman (Talk | contribs)
(62 intermediate revisions not shown)
Line 1:		Line 1:
-	[[Category: Ops Pdfs Common]]	+	[[Category:OpsPdfsMisc]]
-	== Parent Mantis ==	+	== Prerequisites, Classified As, Parent Mantis ==
-	[http://mantis.jaguarfreight.com/mantis/view.php?id=tbd tbd]	+
		+	* Classified As:  (large) [[component]]
		+	* [[Parent Mantis]]: [http://mantis.jaguarfreight.com/mantis/view.php?id=1680 1680]
		+
		+	* Prerequisites:
		+	** read [[Generic Docs Commodity Table (feature)]] - describes "super-class" of Docs Commodity Table feature.
	== Business Needs and Requirements ==		== Business Needs and Requirements ==
Line 10:		Line 15:
	=== Summary ===		=== Summary ===
-	This is a super class for all Docs Commodity Tables. It has most generic functionality that is inherited by more specific tables.	+	List of documents that have commodity table design as defined here:
-	=== User Interface and Functionality ===	+	Ocean docs:
-	Template - see [[#Figure 1: Generic Docs Commodity Table Template]].	+	* [[Arrival Notice Ocean]]
		+	* [[Delivery Order Ocean]]
		+	* [[Freight Release]]
		+	* [[HBL]]
		+	* [[MBL (M)]]
-	Pdf - see [[#Figure 2: Generic Docs Commodity Table Pdf]].	+	Truck docs:
-	=== Buttons ===	+	* [[Delivery Order Trucking Ocean]]
-	==== Line Up ====	+	=== Assumptions ===
-	* Line could be selected and then moved up the list until top is reached	+	* User should not really generate pdf with "unassigned" commodities (both FCL and LCL).
-	* At first no line is selected	+	** In this case please give Error pop-up message "Error: At least one commodity item in CT# XXX is unassigned. " Block pdf generation.
-	* Once some line is selected system should hold selection until template is refreshed	+	** This case applies for all docs listed above, except "Dock Receipt" and "Delivery Order for Export case". For Delivery Order case, as system blocks pdf generation from the beginning before user even selects Export radio button, since it is default to Import.
		+	*** For Delivery Order case, system should allow user to select Export/Import radio button before allowing to generate pdf/ block pdf generation with "Unassigned" commodities. This case will block for Import, but not for export. Container(s) is assigned later on for the export case.
		+	*** For Dock Receipt case, it should not block generating pdf at all, since this document, user enter container information later.
		+	* For LCL there is additional condition: all commodities in one CT must be assigned to only one container.
		+	** In this case please give Error pop-up message "Error: All commodities in LCL CT# XXX must be assigned to only one container" Block pdf generation.
-	==== Line Down ====	+	* If there is no commodity table A in a shipment defined (commodity table A is empty)
		+	** In this case please give Error pop-up message "Error: Commodity Table A in a shipment cannot be empty." Block pdf generation.
-	* Line could be selected and then moved down the list until bottom is reached	+	* In case of groups and Masters same as above.
-	* At first no line is selected	+
-	* Once some line is selected system should hold selection until template is refreshed	+
-	==== Insert Line ====	+	=== User Interface and Functionality ===
-	* User selects line, clicks "Insert Blank Line"	+	==== Use case A: CT No Group No Master 2 ctnrs 3 commods ====
-	* System must insert line '''above''' selected	+
-	* Once a line is selected system should hold selection until template is refreshed. This is more convenient if user wants to insert several lines at a time	+
-	==== Delete line ====	+	Example: see Figure 1,2,3.
-	* User can select lines and click "Delete". System would delete selected line and move all lines below one line up.	+	This is the simplest case:
-	* As usual keep selected line selected	+	* only one CT
		+	* CT does not belong to any Master
		+	* CT does not belong to any Group
-	==== Clear ====	+	==== Use case B: 2 CTs Grouped No Master No Container overlap ====
-	* User can select lines and click "Clear". All data will be cleared.
-	=== Sections ===
-	==== Header ====	+	This case is built upon previous. We grouped CT from Case A with additional CT that has one container.
-	* See sec 1 on [#Figure 1: Generic Docs Commodity Table Template].	+	But still no Master.
-	* Has a check box to select all rows.	+	Example: see Figure 4,5,6. This is a Group Generate case.
-		+
-	==== Columns ====	+
-	There could be any number of columns.	+	Indiv Generate should give same result as case A.
-	Additional functionality could be included - see child types/classes.	+	==== Use case C: 2 CTs Grouped In a Master No Container overlap ====
-	First column contains checkboxes that are used for row manipulation.	+	Let's add group in case B to empty Master.
-	==== Cells ====	+	In this case (Master exists) system should give same result as in case B.
-	Inside of every cell on template we could have textbox, textarea, etc. Data type could be string, number, etc.	+	==== Use case D: 2 CTs Grouped In a Master One Container overlap ====
-	==== Rows ====	+	Now let's expand once more on previous case. Let's:
-	There could be any number of rows.	+	* add CCCC container to CT# *11
		+	* add one more commodity in CT# *11 to container CCCC
-	See [#Buttons] section for various operations you can perform with rows.	+	For group generate case - see See Figures 7,8,9.
-	Additional functionality could be included - see child types/classes.	+	Indiv Generate case is already defined - see case A.
-	==== Totals ====	+	=== Volume logic ===
-	See sec 4 on [#Figure 1: Generic Docs Commodity Table Template].	+	==== LCL ====
		+	If CT group contains LCL CTs and user is trying to "group generate" pdf then it is possible to meaningfully pre-fill Volume column.
-	If column contains data of numerical types then system must calculate and display read only total in [[textbox]].	+	Above True for indiv CT as well.
-	See [[Precision]].	+	==== FCL ====
		+	If CT group contains FCL CTs and user is trying to "group generate" pdf then it is NOT possible to meaningfully pre-fill CT column in some cases. It is because we might have 2 blocks with same CT but different container. At the same time in the system we do not store volume per commodity line or per container. So we can not calculate volume per block.
-	=== Special Cases: Multiple Pages ===	+	Therefore in case of "group generate for FCL CTs" system must default to all 0s on template and let user edit manually.
-	* Print totals on every page? Not generic. See specific doc.	+	! In case user leaves 0s on template in volume column - print blank on pdf (do not print 0s).
		+	Also in this case show [[#FCL volume statistics on pdf]].
		+	For indiv CT show 0 for volume as well.
		+
		+	=== Special Case: Volume Validation for HBL (LCL case) ===
		+
		+	In case of HBL (LCL case) issue Error Window when user clicks "Show Template" if ContTab, Table B, Total (in cbm) = 0. Do not generate template.
		+
		+	=== Misc ===
		+
		+	* see [[Palets / cartons / loose count (feature)]]
		+	* KG/LB, CBM/KG, HU/AMS  and related functionality - see [[Measurement Unit Converters (feature)]]
		+	* ! "No. of Pieces" column (as seen on Templates Figures) should be renamed into "PCS" and have HU/AMS dropdown functionality attached to it - see [[Measurement Unit Converters (feature)]]
	=== Look And Feel ===		=== Look And Feel ===
-	* TBD:	+	* See [[Generic Docs Commodity Table (feature)#Look And Feel]]
-	** values left/right aligned?	+
-	** distance to vertical/horizontal lines	+	* See Figures for examples
-	** etc	+
		+	==== Naming / style for table header  ====
		+
		+	* Must be same on template and pdf
		+
		+	===== HBL =====
		+	see [[#Figure 10: HBL Commod table header]]
		+
		+	===== Freight Release =====
		+	see [[#Figure 11: Freight Release Commod table header]]
		+
		+	===== All others =====
		+	see [[#Figure 12: Ocean Commod table header]]
	=== Figures ===		=== Figures ===
-	==== Figure 1: Generic Docs Commodity Table Template ====	+	==== Figure 1: FCL Commod Table CT No Group  ctnrs 3 commods (Cont Tab) ====
-	[[File:Generic Docs Commodity Table Template.JPG]]	+	[[File:FCL Commod Table CT No Group No Master 2 ctnrs 3 commods (Cont Tab).JPG]]
-	==== Figure 2: Generic Docs Commodity Table Pdf ====	+	==== Figure 2: FCL Commod Table CT No Group  2 ctnrs 3 commods (Template) ====
-	[[File:Generic Docs Commodity Table Pdf.JPG]]	+	[[File:FCL Commod Table CT No Group No Master 2 ctnrs 3 commods (Template).JPG]]
-	== RFC ==	+	==== Figure 3: FCL Commod Table CT No Group  2 ctnrs 3 commods (Pdf) ====
-	== Known Non Critical Bugs and Issues ==	+	[[File:FCL Commod Table CT No Group No Master 2 ctnrs 3 commods (Pdf).JPG]]
-	* Do we want to have bar only above totals or across entire table	+	==== Figure 4: 2 CTs Grouped  No Container overlap (Cont Tab CT2) ====
-	* What is the Insert logic for fixed lines document (like HAWB)?	+	[[File:2 CTs Grouped No Master No Container overlap (Cont Tab CT2).JPG]]
-	** option1) no Insert button	+
-	** option2) insert up to max# of lines and then display warning pop-up	+	==== Figure 5: 2 CTs Grouped  No Container overlap [Group generate] (Template) ====
		+
		+	[[File:2 CTs Grouped No Master No Container overlap (Template).JPG]]
		+
		+	==== Figure 6: 2 CTs Grouped  No Container overlap [Group generate] (Pdf)  ====
		+
		+	[[File:2 CTs Grouped No Master No Container overlap (Pdf).JPG]]
		+
		+	==== Figure 7: 2 CTs Grouped  One Container overlap (Cont Tab) ====
		+	[[File:FCL 2 CTs Grouped in Master One Container overlap (Cont Tab 300011).JPG]]
		+
		+
		+	==== Figure 8: 2 CTs Grouped  One Container overlap [Group generate] (Template)  ====
		+
		+	[[File:FCL 2 CTs Grouped One Container overlap (Template).JPG]]
		+
		+	==== Figure 9: 2 CTs Grouped  One Container overlap [Group generate] (Pdf)  ====
		+
		+
		+	[[File:FCL 2 CTs Grouped in Master One Container overlap (Pdf).JPG]]
		+
		+
		+	==== Figure 10: HBL Commod table header ====
		+
		+	[[File:HBL Commod table header.JPG]]
		+
		+	==== Figure 11: Freight Release Commod table header ====
		+
		+	[[File:Freight Release Commod table header.JPG]]
		+
		+	==== Figure 12: Ocean Commod table header ====
		+
		+	[[File:Ocean Commod table header.JPG]]
		+
		+	== RFC (Ideas for Future Discussion) ==
		+
		+	1)  '''FCL volume statistics on pdf '''
		+	This is a string to be shown on pdf template above commodity table. It must show volume for all CTs participating in pdf.
		+
		+	Example:
		+
		+	''CT#123444: 3.12 cft; CT#123444: 1.01 cft; ''
		+
		+	2) Multiple blocks per container case: show one check box per container so that you can move everything that belong to one container together.
		+
		+	== Known Non Critical Bugs and Issues ==
		+
		+	* does it matter where / how CT# is displayed - before or after descr, etc?
	== History ==		== History ==
Line 121:		Line 203:
	See [[Commodity Table for Pdfs]]		See [[Commodity Table for Pdfs]]
		+
		+	=== SA ===
		+	==== M1995 ====
		+
		+	* Mantis [http://mantis.jaguarfreight.com/mantis/view.php?id=1995 1995]
		+	* To allow PDF generation for ONLY Ocean Dock Receipts & "Export" Delivery Orders without a container # being assigned. At the moment of these 2 document generation, we do not know the container number (it comes late) and now system blocs pdf generation.
		+	* See [[#Assumptions]]
	== DB ==		== DB ==

---

Current revision as of 12:22, 5 August 2011

Contents 1 Prerequisites, Classified As, Parent Mantis 2 Business Needs and Requirements 3 Technical Specification 3.1 Summary 3.2 Assumptions 3.3 User Interface and Functionality 3.3.1 Use case A: CT No Group No Master 2 ctnrs 3 commods 3.3.2 Use case B: 2 CTs Grouped No Master No Container overlap 3.3.3 Use case C: 2 CTs Grouped In a Master No Container overlap 3.3.4 Use case D: 2 CTs Grouped In a Master One Container overlap 3.4 Volume logic 3.4.1 LCL 3.4.2 FCL 3.5 Special Case: Volume Validation for HBL (LCL case) 3.6 Misc 3.7 Look And Feel 3.7.1 Naming / style for table header 3.7.1.1 HBL 3.7.1.2 Freight Release 3.7.1.3 All others 3.8 Figures 3.8.1 Figure 1: FCL Commod Table CT No Group ctnrs 3 commods (Cont Tab) 3.8.2 Figure 2: FCL Commod Table CT No Group 2 ctnrs 3 commods (Template) 3.8.3 Figure 3: FCL Commod Table CT No Group 2 ctnrs 3 commods (Pdf) 3.8.4 Figure 4: 2 CTs Grouped No Container overlap (Cont Tab CT2) 3.8.5 Figure 5: 2 CTs Grouped No Container overlap [Group generate] (Template) 3.8.6 Figure 6: 2 CTs Grouped No Container overlap [Group generate] (Pdf) 3.8.7 Figure 7: 2 CTs Grouped One Container overlap (Cont Tab) 3.8.8 Figure 8: 2 CTs Grouped One Container overlap [Group generate] (Template) 3.8.9 Figure 9: 2 CTs Grouped One Container overlap [Group generate] (Pdf) 3.8.10 Figure 10: HBL Commod table header 3.8.11 Figure 11: Freight Release Commod table header 3.8.12 Figure 12: Ocean Commod table header 4 RFC (Ideas for Future Discussion) 5 Known Non Critical Bugs and Issues 6 History 6.1 Old spec 6.2 SA 6.2.1 M1995 7 DB

[edit] Prerequisites, Classified As, Parent Mantis

• Classified As: (large) component
• Parent Mantis: 1680

• Prerequisites:
  • read Generic Docs Commodity Table (feature) - describes "super-class" of Docs Commodity Table feature.

[edit] Business Needs and Requirements

[edit] Technical Specification

[edit] Summary

List of documents that have commodity table design as defined here:

Ocean docs:

• Arrival Notice Ocean
• Delivery Order Ocean
• Freight Release
• HBL
• MBL (M)

Truck docs:

• Delivery Order Trucking Ocean

[edit] Assumptions

• User should not really generate pdf with "unassigned" commodities (both FCL and LCL).
  • In this case please give Error pop-up message "Error: At least one commodity item in CT# XXX is unassigned. " Block pdf generation.
  • This case applies for all docs listed above, except "Dock Receipt" and "Delivery Order for Export case". For Delivery Order case, as system blocks pdf generation from the beginning before user even selects Export radio button, since it is default to Import.
    • For Delivery Order case, system should allow user to select Export/Import radio button before allowing to generate pdf/ block pdf generation with "Unassigned" commodities. This case will block for Import, but not for export. Container(s) is assigned later on for the export case.
    • For Dock Receipt case, it should not block generating pdf at all, since this document, user enter container information later.
• For LCL there is additional condition: all commodities in one CT must be assigned to only one container.
  • In this case please give Error pop-up message "Error: All commodities in LCL CT# XXX must be assigned to only one container" Block pdf generation.

• If there is no commodity table A in a shipment defined (commodity table A is empty)
  • In this case please give Error pop-up message "Error: Commodity Table A in a shipment cannot be empty." Block pdf generation.

• In case of groups and Masters same as above.

[edit] User Interface and Functionality

[edit] Use case A: CT No Group No Master 2 ctnrs 3 commods

Example: see Figure 1,2,3.

This is the simplest case:

• only one CT
• CT does not belong to any Master
• CT does not belong to any Group

[edit] Use case B: 2 CTs Grouped No Master No Container overlap

This case is built upon previous. We grouped CT from Case A with additional CT that has one container.

But still no Master.

Example: see Figure 4,5,6. This is a Group Generate case.

Indiv Generate should give same result as case A.

[edit] Use case C: 2 CTs Grouped In a Master No Container overlap

Let's add group in case B to empty Master.

In this case (Master exists) system should give same result as in case B.

[edit] Use case D: 2 CTs Grouped In a Master One Container overlap

Now let's expand once more on previous case. Let's:

• add CCCC container to CT# *11
• add one more commodity in CT# *11 to container CCCC

For group generate case - see See Figures 7,8,9.

Indiv Generate case is already defined - see case A.

[edit] Volume logic

[edit] LCL

If CT group contains LCL CTs and user is trying to "group generate" pdf then it is possible to meaningfully pre-fill Volume column.

Above True for indiv CT as well.

[edit] FCL

If CT group contains FCL CTs and user is trying to "group generate" pdf then it is NOT possible to meaningfully pre-fill CT column in some cases. It is because we might have 2 blocks with same CT but different container. At the same time in the system we do not store volume per commodity line or per container. So we can not calculate volume per block.

Therefore in case of "group generate for FCL CTs" system must default to all 0s on template and let user edit manually.

! In case user leaves 0s on template in volume column - print blank on pdf (do not print 0s).

Also in this case show #FCL volume statistics on pdf.

For indiv CT show 0 for volume as well.

[edit] Special Case: Volume Validation for HBL (LCL case)

In case of HBL (LCL case) issue Error Window when user clicks "Show Template" if ContTab, Table B, Total (in cbm) = 0. Do not generate template.

[edit] Misc

• see Palets / cartons / loose count (feature)
• KG/LB, CBM/KG, HU/AMS and related functionality - see Measurement Unit Converters (feature)
•  ! "No. of Pieces" column (as seen on Templates Figures) should be renamed into "PCS" and have HU/AMS dropdown functionality attached to it - see Measurement Unit Converters (feature)

[edit] Look And Feel

• See Generic Docs Commodity Table (feature)#Look And Feel

• See Figures for examples

[edit] Naming / style for table header

• Must be same on template and pdf

[edit] HBL

see #Figure 10: HBL Commod table header

[edit] Freight Release

see #Figure 11: Freight Release Commod table header

[edit] All others

see #Figure 12: Ocean Commod table header

[edit] Figures

[edit] Figure 1: FCL Commod Table CT No Group ctnrs 3 commods (Cont Tab)

[edit] Figure 2: FCL Commod Table CT No Group 2 ctnrs 3 commods (Template)

[edit] Figure 3: FCL Commod Table CT No Group 2 ctnrs 3 commods (Pdf)

[edit] Figure 4: 2 CTs Grouped No Container overlap (Cont Tab CT2)

[edit] Figure 5: 2 CTs Grouped No Container overlap [Group generate] (Template)

[edit] Figure 6: 2 CTs Grouped No Container overlap [Group generate] (Pdf)

[edit] Figure 7: 2 CTs Grouped One Container overlap (Cont Tab)

[edit] Figure 8: 2 CTs Grouped One Container overlap [Group generate] (Template)

[edit] Figure 9: 2 CTs Grouped One Container overlap [Group generate] (Pdf)

[edit] Figure 10: HBL Commod table header

[edit] Figure 11: Freight Release Commod table header

[edit] Figure 12: Ocean Commod table header

[edit] RFC (Ideas for Future Discussion)

1) FCL volume statistics on pdf This is a string to be shown on pdf template above commodity table. It must show volume for all CTs participating in pdf.

Example:

CT#123444: 3.12 cft; CT#123444: 1.01 cft;

2) Multiple blocks per container case: show one check box per container so that you can move everything that belong to one container together.

[edit] Known Non Critical Bugs and Issues

• does it matter where / how CT# is displayed - before or after descr, etc?

[edit] History

[edit] Old spec

See Commodity Table for Pdfs

[edit] SA

[edit] M1995

• Mantis 1995
• To allow PDF generation for ONLY Ocean Dock Receipts & "Export" Delivery Orders without a container # being assigned. At the moment of these 2 document generation, we do not know the container number (it comes late) and now system blocs pdf generation.
• See #Assumptions

[edit] DB