Client Shipment List

From UG

Revision as of 03:28, 22 July 2009 (edit) Montira (Talk | contribs) (→Use cases) ← Older edit		Current revision as of 21:40, 29 November 2010 (edit) (undo) Montira (Talk | contribs) (→Table)
(135 intermediate revisions not shown)
Line 1:		Line 1:
-	== Dev ==	+	[[Category:Client]]
-	* http://mantis.jaguarfreight.com/mantis/view.php?id=921	+	== Mantis ==
		+	* Parent Mantis:[http://mantis.jaguarfreight.com/mantis/view.php?id=921 921]
-	== Specs ==	+	== Biz Analyst Intro ==
-	ss0) This component is very similar to List CTs in Internal(Jaguar) App.	+	Shipment List provides list of CTs that are undefined, live, delivered, and Archived in the system. This applies to Client visibility rule
-	ss1) This panel shows CTs visible to logged user.See '''CT visibility rules''' below.	+	== Business Requirements and Needs ==
		+	User needs:
		+	* A panel where he can see all shipments (allowed for that user to see).
		+	* Way to create and manage a list of most important shipments and monitor them
		+	* Way to create nickname for most important shipments
		+	* Provide a filter that can segregate modes on shipment list
-	ss2) It has a number of related CT reports arranged using tabs:	+	== Sys Analyst Intro ==
		+	* Create a Panel that is almost similar to "Jag App List All" except:
		+	:* Truck CTs are displayed on the same tabs as other modes
		+	:* It consists of 4 tabs:
		+	:** Undefined
		+	:** Live
		+	:** Delivered
		+	:** Archived
		+	:** Default to Live tab
		+	* Deleted CTs are not included on the reports.
		+	* CTs shipment list must apply client visibility rule
		+	* Create an ability to add nickname and add CT to Watch List
		+	:* Watch List will be displayed on another page
		+	:* CTs that are on Watch List, MUST be listed on Shipment List as well
		+	* Create an ability to show shipment detail
		+	* Panel should show 15 shipment records per page
		+	* Provide check boxes to filters shipments as user can segregate any modes they want. It is always default to all modes of transportation for the fresh account. Client can manage their own setting by checking/unchecking MOT of shipments list. It will show the last updated filters.
		+	* Create a Search shipment line feature
		+	* Shipment record on shipment list shows:
		+	:* MOT
		+	:* Nickname
		+	:* CT#
		+	:* Created On Date
		+	:* Shipper
		+	:* Consignee
		+	:* Auth (Undefined Mode ONLY)
		+	* Shipment records can be sorted by column throughout all pages
		+	* Nickname on Shipment List is held when user removes shipment from Watch List
-	* Undefined	+	== Design ==
-	* Live	+
-	* Delivered	+
-	* Archived	+
-	ss2a) Conditions for CT appearence on particular tab (Undefine, Live, Delivered, or Archived) is the same as here: http://mantis.jaguarfreight.com/wiki/List_CTs#Definition_of_UNDEFINED_LIVE_DELIVERED_ARCHIVED	+	* This component is similar to List CTs in Internal(Jaguar) App. But it is not same, for example columns are different, Truck mode does not have its own tab, client visibility, etc.
		+	* See [[#Figure 1. Live Shipment List]]
		+	* See [[#Figure 2. Undefined Shipment List]]
		+	* See [[#Figure 3. Delivered Shipment List]]
		+	* See [[#Figure 4. Archived Shipment List]]
-	ss3) Fields on reports (same for all):	+	=== Filters ===
-	* [[MOT]]	+	* This panel shows ONLY CTs visible to logged user.See [[Client visibility rule]]
-	* Nickname	+
		+	* Conditions for CT appearence on particular tab (Undefine, Live, Delivered, or Archived) is the same as here: [http://mantis.jaguarfreight.com/wiki/List_CTs#Definition_of_UNDEFINED_LIVE_DELIVERED_ARCHIVED Definition]
		+
		+	=== MOT ===
		+	See [http://mantis.jaguarfreight.com/wiki/List_CTs#Ver_3.0_major_re-design Updated MOT]
		+
		+	=== Table ===
		+
		+	'''Table Fields definition'''  (same for all tabs):
		+
		+	* [[MOT]]
		+	:* Type: icon - Air , Ocean, or Truck
		+	* Nickname
		+	:* Type:[[alphanumeric]]
		+	:* Widget: [[textbox]]
		+	:* Visible Chars: 13
		+	:** Max Chars: [[TBD]]
	* CT#		* CT#
		+	:* Show CT#
		+	:* Double click on CT record, it forwards to CT Shipment Details Page
	* Created On		* Created On
		+	:* Mapping: [[CT#Created_On]]
		+	:* Format: DD MON YYYY
		+	:** For ex, 17 Jul 2009
	* Shipper		* Shipper
		+	:* Mapping: [[CT#Shipper]]
		+	:* Display only Company-City
	* Consignee		* Consignee
		+	:* Mapping: [[CT#Consignee]]
		+	:* Display only Company-City
		+	* Auth
		+	:* Display Pending for CT that is waiting for approval from operator
		+	:* Widget: Green circle with check mark
-	ss4) '''Add to Watch List Feature'''	+	'''Table Paging:'''
-	It allows to add any CT from List All to Watch List.	+	* Uses standard ZK paging.
-	Use case:	+	* 15 CTs per page
-	# point cursor into Nickname field for desired CT	+
-	# enter nickname	+	'''Table Sorting:'''
-	# click "Add to Watch List"	+	* Sort: Ascending/Descending per column throughout all pages
		+	* Use standard ZK sorting (click on table header)
		+
		+	'''Table Searching:'''
		+	* Search Line
		+	:* Type: filter by Nickname, Shipper, and Consignee
		+	:* Widget: [[textbox]]
		+	:* Note: similar to Addrbook
		+	:* Apply for: search throughout all tabs.
		+
		+	'''Table MOT Filter:'''
		+	* Filter
		+	:* Location: In front of MOT (Air, Ocean, Trucking-Air, Trucking-Ocean, Trucking-Domestic)
		+	:* Widget: [[Checkbox]]
		+	:* Note: Provide check boxes to filter shipments as user can segregate any modes they want. It is always default to all modes of transportation for fresh account, see [[#Figure 5. Segregate Shipment List ]]There is a default setting that can be managed through an individual’s client shipment list.
		+
		+	'''Default order:'''
		+	* show sorted by CT#, latest at the top, throughout all pages and all tabs
		+
		+	'''Default tab:'''
		+	* Live
		+
		+	'''Link from CT to Shipment details: '''
-	ss5) Selecting CT
	Two options:		Two options:
	* double click		* double click
-	* select and click on "Show selected button"	+	* select CT record and click on "Show selected button"
	In both cases CT Details page would open up.		In both cases CT Details page would open up.
-	ss6) Paging	+	=== Button ===
		+	* Apply Filter
		+	:* Search lines for shipments that contains ... search throughout all tabs.
		+	* Clear
		+	:* Clear info on search line value input
		+	* Add to Watch List
		+	:* Add shipment to Watch List
		+	* Show Selected
		+	:* Show shipment detail for a specific shipment
-	No paging.	+	=== Add to Watch List and Add Nickname Feature ===
		+	* It allows user to add any CT from Shipment List to Watch List
-	=== CT Visibility rule ===	+	=== Archived Tab ===
-	ss1) It controls what CTs client user can see. We have the following rule - client user can see only:	+	* Shipment should move from Delivered Tab to Archived Tab when its shipment actual delivery date pass 180 days.
-	* CTs with E0 field that equals to ANY client set in table Admin.NonJagUserProfile.PartB.	+	== Use Cases ==
-	* TBD	+
-	== Use cases ==	+	=== UC1 ===
-	uc1) Undefined tab	+	'''Problem:''' User wants to see what shipments are ''live'', ''undefined'', ''delivered'' or ''archived''
-	* go to the undefined tab on the Client App and it must show the list of all undefined CT	+
-	* The list of undefined consists of Nickname:, CT#:, Created On Date:, Shipper:, and Consignee: fields	+
-	* Nickname is a text box. It allows user to type any name they want to enter in order to add to Watch list	+
-	* CT# , Created on Date, Shipper and Consignee are generated by the system	+
		+	'''Solution:''' click on appropriate tab
-	uc2) Live tab	+	=== UC2 ===
-	* go to the live tab on the Client App and it must show the list of CT that is live	+
-	* The list of Live CT consists of MOT:,, Nickname:, CT#:, Created On Date:, Shipper:, and Consignee: fields	+
-	* Nickname is a text box. It allows user to type any name they want to enter in order to add to Watch list	+
-	* CT# , Created on Date, Shipper and Consignee are generated by the system	+
-	* CT is live if the following conditions are met:	+
-	** If MOT is AIR then ActualDeliveryDate in Import Tab must be empty.	+
-	** If MOT is oceanLCL then ImportTab.ActualDeliveryDateDATEBOX must be empty	+
-	** If MOT is oceanFCL then ComTable.ContainerTable.ActualDeliveryDateDATEBOX must be empty (for at least one container)	+
-	** If MOT is truckAir then GenTab.y.ActualDelivery must be empty	+
-	** If MOT is truckOcn then GenTab.y.ActualDelivery must be empty	+
-	** If MOT is truckDom then GenTab.y.ActualDelivery must be empty	+
		+	'''Problem:''' User wants to see shipment details for particular CT
-	Uc3) Delivered Tab	+	'''Solution:'''
-	* go to the delivered tab on the Client App and it must show the list of CT that is delivered	+	* option1) double click on the shipment record OR
-	* The list of delivered CT consists of MOT:, Nickname:, CT#:, Created On Date:, Shipper:, and Consignee: fields	+	* option2) click on the shipment record and press "Show Selected"
-	* Nickname is a text box. It allows user to type any name they want to enter in order to add to Watch list	+
-	* CT# , Created on Date, Shipper and Consignee are generated by the system	+
-	* CT is "delivered" if the following conditions are met:	+
-	** If MOT is Air then ImportTab.ActualDeliveryDateDATEBOX must not be empty	+
-	** If MOT is oceanLCL then ImportTab.ActualDeliveryDateDATEBOX must not be empty	+
-	** If MOT is oceanFCL then ComTable.ContainerTable.ActualDeliveryDateDATEBOX must not be empty (for all containers)	+
-	** If MOT is truckAir then GenTab.y.ActualDelivery must not be empty	+
-	** If MOT is truckOcn then GenTab.y.ActualDelivery must not be empty	+
-	** If MOT is truckDom then GenTab.y.ActualDelivery must not be empty	+
		+	=== UC3 ===
-	Uc4) Archived Tab	+	'''Problem:'''  User wants to add CT to Watch List and add Nickname
-	* go to the archived tab on the Client App and it must show the list of CT that is archived	+
-	* The list of archived CT consists of MOT:, Nickname:, CT#:, Created On Date:, Shipper:, and Consignee: fields	+
-	* Nickname is a text box. It allows user to type any name they want to enter in order to add to Watch list	+
-	* CT# , Created on Date, Shipper and Consignee are generated by the system	+
-	* CT is "archived" if the following conditions are met:	+
-	** If MOT is Air then ImportTab.ActualDeliveryDateDATEBOX value is 6 month (or more) older than todays date	+
-	** If MOT is oceanLCL then ImportTab.ActualDeliveryDateDATEBOX value is 6 month (or more) older than todays date	+
-	** If ActualDeliveryDate for ALL containers and compare the most recent value with todays date)	+
-	** If MOT is truckAir then GenTab.y.ActualDelivery: value is 6 month (or more) older than todays date	+
-	** If MOT is truckOcn then GenTab.y.ActualDelivery: value is 6 month (or more) older than todays date	+
-	** If MOT is truckDom then GenTab.y.ActualDelivery: value is 6 month (or more) older than todays date	+
		+	'''Solution:'''
-	uc5) Add Watch List button	+	1. Select CT (with no nickname)
-	* Add a nickname on the CT record and click "Add Watch List", the record should present on the watch list page	+
-	* If a nickname field is not entered and user clicks "Add Watch List", nothing should happen	+
		+	2. Enter Nickname into textbox
		+	* If Nickname is not entered and add CT to Watch List, warning message pop-up shows: You must enter Nickname for shipment before you add to Watch List. [OK]
		+
		+	3. (optional) repeat step 2 for any number of CTs
-	uc6) Show Selected button	+	4. click on "Add to Watch List" button
-	* double click on the CT record,	+
-	== QA ==	+	5. pop-up appears "Add selected shipments to Watch List? [Yes][No]"
		+	* If Yes then pop-up appears "X CT's has been added to Watch List [OK]"
		+	:* Click "OK"
		+	:* system displays new Nickname(s) on Shipment List
		+	* If No then nothing happens
-	qa1) test uc1 uc4	+	=== UC4 ===
-	qa2) test on all supported platforms	+
-	== Look And Feel ==	+	'''Problem:''' User wants to search for shipment that has shipper name xxxx
-	== RFC ==	+	'''Solution:'''
		+	* Type shipper name on the search line
		+	* Click "Apply Filter"
		+	* System will show the records that contain the shipper name that user searches for throughout all tabs.
-	[[Category:Client]]	+	=== UC5 ===
		+
		+	'''Problem:''' User wants to add existing monitored CT to Watch List
		+
		+	'''Solution:'''
		+	* Select CT that is already on watch list
		+	* Click "Add to watch list"
		+	* System shows warning message that "This shipment is already on Watch List"[OK]
		+
		+	=== UC6 ===
		+
		+	'''Problem:''' User wants to add CT to Watch List without naming nickname
		+
		+	'''Solution:'''
		+	* Select CT that is not on watch list
		+	* Leave nickname textbox empty
		+	* Click "Add to watch list"
		+	* System must show message warning "You must enter Nickname for shipment before you add to Watch List"[OK]
		+
		+	=== UC7 ===
		+
		+	'''Problem:''' User wants to segregate shipments by MOT
		+
		+	'''Solution:'''
		+	* User selects only checkbox(es) that are in front of the MOT in order to view specific MOT
		+	* User view MOT selected shipments throughout all tabs
		+	* Shipment list only shows MOT(s) that are selected or set on user profile
		+	* When user refreshes the page, filters should be set as the last filter value setting updated
		+
		+	== Test Cases and QA ==
		+	* Test all possibly use cases
		+
		+	== Figures ==
		+	=== Figure 1. Live Shipment List ===
		+	[[File:ShipmentList.JPG]]
		+
		+	=== Figure 2. Undefined Shipment List ===
		+	[[File:UndefinedMot.JPG]]
		+
		+	=== Figure 3. Delivered Shipment List ===
		+	[[File:Delivered.JPG]]
		+
		+	=== Figure 4. Archived Shipment List ===
		+	[[File:ArchivedShipment.JPG]]
		+
		+	=== Figure 5. Segregate Shipment List ===
		+	[[File:SegregateShipmentByMOT.JPG]]
		+
		+	== History ==
		+	=== m1868 ===
		+	* Ability to held nickname on Shipment List when user removes shipment from Watch List
		+	* See [http://mantis.jaguarfreight.com/wiki/Client_Watch_List#m1868 Client Watch List]
		+	* Spec is updated: Y

---

Current revision as of 21:40, 29 November 2010

Contents 1 Mantis 2 Biz Analyst Intro 3 Business Requirements and Needs 4 Sys Analyst Intro 5 Design 5.1 Filters 5.2 MOT 5.3 Table 5.4 Button 5.5 Add to Watch List and Add Nickname Feature 5.6 Archived Tab 6 Use Cases 6.1 UC1 6.2 UC2 6.3 UC3 6.4 UC4 6.5 UC5 6.6 UC6 6.7 UC7 7 Test Cases and QA 8 Figures 8.1 Figure 1. Live Shipment List 8.2 Figure 2. Undefined Shipment List 8.3 Figure 3. Delivered Shipment List 8.4 Figure 4. Archived Shipment List 8.5 Figure 5. Segregate Shipment List 9 History 9.1 m1868

[edit] Mantis

• Parent Mantis:921

[edit] Biz Analyst Intro

Shipment List provides list of CTs that are undefined, live, delivered, and Archived in the system. This applies to Client visibility rule

[edit] Business Requirements and Needs

User needs:

• A panel where he can see all shipments (allowed for that user to see).
• Way to create and manage a list of most important shipments and monitor them
• Way to create nickname for most important shipments
• Provide a filter that can segregate modes on shipment list

[edit] Sys Analyst Intro

• Create a Panel that is almost similar to "Jag App List All" except:

• Truck CTs are displayed on the same tabs as other modes
• It consists of 4 tabs:
  • Undefined
  • Live
  • Delivered
  • Archived
  • Default to Live tab

• Deleted CTs are not included on the reports.
• CTs shipment list must apply client visibility rule
• Create an ability to add nickname and add CT to Watch List

• Watch List will be displayed on another page
• CTs that are on Watch List, MUST be listed on Shipment List as well

• Create an ability to show shipment detail
• Panel should show 15 shipment records per page
• Provide check boxes to filters shipments as user can segregate any modes they want. It is always default to all modes of transportation for the fresh account. Client can manage their own setting by checking/unchecking MOT of shipments list. It will show the last updated filters.
• Create a Search shipment line feature
• Shipment record on shipment list shows:

• MOT
• Nickname
• CT#
• Created On Date
• Shipper
• Consignee
• Auth (Undefined Mode ONLY)

• Shipment records can be sorted by column throughout all pages
• Nickname on Shipment List is held when user removes shipment from Watch List

[edit] Design

• This component is similar to List CTs in Internal(Jaguar) App. But it is not same, for example columns are different, Truck mode does not have its own tab, client visibility, etc.
• See #Figure 1. Live Shipment List
• See #Figure 2. Undefined Shipment List
• See #Figure 3. Delivered Shipment List
• See #Figure 4. Archived Shipment List

[edit] Filters

• This panel shows ONLY CTs visible to logged user.See Client visibility rule

• Conditions for CT appearence on particular tab (Undefine, Live, Delivered, or Archived) is the same as here: Definition

[edit] MOT

See Updated MOT

[edit] Table

Table Fields definition (same for all tabs):

• MOT

• Type: icon - Air , Ocean, or Truck

• Nickname

• Type:alphanumeric
• Widget: textbox
• Visible Chars: 13
  • Max Chars: TBD

• CT#

• Show CT#
• Double click on CT record, it forwards to CT Shipment Details Page

• Created On

• Mapping: CT#Created_On
• Format: DD MON YYYY
  • For ex, 17 Jul 2009

• Shipper

• Mapping: CT#Shipper
• Display only Company-City

• Consignee

• Mapping: CT#Consignee
• Display only Company-City

• Auth

• Display Pending for CT that is waiting for approval from operator
• Widget: Green circle with check mark

Table Paging:

• Uses standard ZK paging.
• 15 CTs per page

Table Sorting:

• Sort: Ascending/Descending per column throughout all pages
• Use standard ZK sorting (click on table header)

Table Searching:

• Search Line

• Type: filter by Nickname, Shipper, and Consignee
• Widget: textbox
• Note: similar to Addrbook
• Apply for: search throughout all tabs.

Table MOT Filter:

• Filter

• Location: In front of MOT (Air, Ocean, Trucking-Air, Trucking-Ocean, Trucking-Domestic)
• Widget: Checkbox
• Note: Provide check boxes to filter shipments as user can segregate any modes they want. It is always default to all modes of transportation for fresh account, see #Figure 5. Segregate Shipment List There is a default setting that can be managed through an individual’s client shipment list.

Default order:

• show sorted by CT#, latest at the top, throughout all pages and all tabs

Default tab:

• Live

Link from CT to Shipment details:

Two options:

• double click
• select CT record and click on "Show selected button"

In both cases CT Details page would open up.

[edit] Button

• Apply Filter

• Search lines for shipments that contains ... search throughout all tabs.

• Clear

• Clear info on search line value input

• Add to Watch List

• Add shipment to Watch List

• Show Selected

• Show shipment detail for a specific shipment

[edit] Add to Watch List and Add Nickname Feature

• It allows user to add any CT from Shipment List to Watch List

[edit] Archived Tab

• Shipment should move from Delivered Tab to Archived Tab when its shipment actual delivery date pass 180 days.

[edit] Use Cases

[edit] UC1

Problem: User wants to see what shipments are live, undefined, delivered or archived

Solution: click on appropriate tab

[edit] UC2

Problem: User wants to see shipment details for particular CT

Solution:

• option1) double click on the shipment record OR
• option2) click on the shipment record and press "Show Selected"

[edit] UC3

Problem: User wants to add CT to Watch List and add Nickname

Solution:

1. Select CT (with no nickname)

2. Enter Nickname into textbox

• If Nickname is not entered and add CT to Watch List, warning message pop-up shows: You must enter Nickname for shipment before you add to Watch List. [OK]

3. (optional) repeat step 2 for any number of CTs

4. click on "Add to Watch List" button

5. pop-up appears "Add selected shipments to Watch List? [Yes][No]"

• If Yes then pop-up appears "X CT's has been added to Watch List [OK]"

• Click "OK"
• system displays new Nickname(s) on Shipment List

• If No then nothing happens

[edit] UC4

Problem: User wants to search for shipment that has shipper name xxxx

Solution:

• Type shipper name on the search line
• Click "Apply Filter"
• System will show the records that contain the shipper name that user searches for throughout all tabs.

[edit] UC5

Problem: User wants to add existing monitored CT to Watch List

Solution:

• Select CT that is already on watch list
• Click "Add to watch list"
• System shows warning message that "This shipment is already on Watch List"[OK]

[edit] UC6

Problem: User wants to add CT to Watch List without naming nickname

Solution:

• Select CT that is not on watch list
• Leave nickname textbox empty
• Click "Add to watch list"
• System must show message warning "You must enter Nickname for shipment before you add to Watch List"[OK]

[edit] UC7

Problem: User wants to segregate shipments by MOT

Solution:

• User selects only checkbox(es) that are in front of the MOT in order to view specific MOT
• User view MOT selected shipments throughout all tabs
• Shipment list only shows MOT(s) that are selected or set on user profile
• When user refreshes the page, filters should be set as the last filter value setting updated

[edit] Test Cases and QA

• Test all possibly use cases

[edit] Figures

[edit] Figure 1. Live Shipment List

[edit] Figure 2. Undefined Shipment List

[edit] Figure 3. Delivered Shipment List

[edit] Figure 4. Archived Shipment List

[edit] Figure 5. Segregate Shipment List

[edit] History

[edit] m1868

• Ability to held nickname on Shipment List when user removes shipment from Watch List
• See Client Watch List
• Spec is updated: Y