Where Is Report

From UG

(Difference between revisions)
Jump to: navigation, search
(→BA)
(→Filters: added "Steamshipline Booking Number" filter; changed description of behaviour of "Master Airway Bills" filter.)
 
(55 intermediate revisions not shown)
Line 1: Line 1:
[[Category:OpsReps]]
[[Category:OpsReps]]
-
== Mantis ==
+
== Info ==
-
[http://mantis.jaguarfreight.com/mantis/view.php?id=1587 1587]
+
Parent Mantis - [http://mantis.jaguarfreight.com/mantis/view.php?id=1587 1587]
-
== Major revisions of this doc ==
+
== BR: Business Requirements ==
-
* --[[User:Alex|Alex]] 17:07, 31 July 2009 (UTC)  see post in tw#2
+
-
 
+
-
== Business Needs and Requirements ==
+
* Need to add text box for Steamship Lines Booking #
* Need to add text box for Steamship Lines Booking #
* For Container #, need option to search the last digit by typing * instead of typing any number between 0-9
* For Container #, need option to search the last digit by typing * instead of typing any number between 0-9
 +
* Need search feature to ignore upper/lower case letters when searching by a PO # of Item Code (aka SKU #)
-
== Specs ==
+
== SD: Systems Design ==
-
[[File:WhereIs.JPG | thumb|200px| Filters Page (example)]] 
+
-
[[file:WhereIsHTMLoutput.JPG | thumb|200px  |HTML output page (example)]]
+
-
'''ss1''' results in HTML
+
=== Summary ===
-
* see http://mantis.jaguarfreight.com/svn/ct2/SS/reports/where_is/v2/HTML_format_example.html
+
Where Is Report is one of core reports of CT2. It provides the ability to search and display shipments, which comply to user-defined conditions.
 +
* All needed '''User Defined Conditions''' ''(these are also called '''filters''')'' could be set in the [[#Filters | Filters]] section on the template of the Report.
 +
* Where Is Report '''NOT''' uses any '''Hard Coded Conditions'''.
-
'''ss2''' results in spreadsheet:
+
=== Interface ===
-
* see http://mantis.jaguarfreight.com/svn/ct2/SS/reports/where_is/v2/spreadsheet_format_example.html
+
Report is available right from the Main Menu of CT2. See [[#Figure 0: Main Menu item | Figure 0]].
-
NOTE: There is a similar report for Client App, see here: [[Client Where Is]]
+
In order to generate report user have to:
 +
* configure User Defined Conditions in the Filters section on the template (see [[#Figure 1: Where Is Report Filters | Figure 1]]) and
 +
* click appropriate button for needed action
-
== Use cases ==
+
==== Filters ====
-
== QA ==
+
Result of the Report that will be showed to user depends of the values of the following Filters ''(in that order of locating on the template)'':
-
== Look And Feel ==
+
* '''P.O. contains:'''.
-
== RFC ==
+
** Mapped to [http://mantis.jaguarfreight.com/wiki/Commodity#PO PO] from [http://mantis.jaguarfreight.com/wiki/Commodity Commodity Table] on ContTab of CT.
-
== Tweaks (v1.1) ==
+
* '''SKU contains:'''.
 +
** Mapped to [http://mantis.jaguarfreight.com/wiki/Commodity#SKU SKU] from [http://mantis.jaguarfreight.com/wiki/Commodity Commodity Table] on ContTab of CT.
 +
* '''Export Ref # contains:'''.
 +
** Mapped to [http://mantis.jaguarfreight.com/wiki/CT_bo#Export_Ref Export Ref] ''(a.k.a. GenTab.A)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#General_Fields GenTab] of CT.
 +
* '''Import Ref # contains:'''.
 +
** Mapped to [http://mantis.jaguarfreight.com/wiki/CT_bo#Import_Ref Import Ref] ''(a.k.a. GenTab.B)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#General_Fields GenTab] of CT.
 +
* '''Customer Ref # contains:'''.
 +
** Mapped to [http://mantis.jaguarfreight.com/wiki/CT_bo#Customer_Ref Customer Ref] ''(a.k.a. GenTab.C)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#General_Fields GenTab] of CT.
 +
* '''Jaguar 3rd Ref # contains:'''.
 +
** Mapped to [http://mantis.jaguarfreight.com/wiki/CT_bo#Jaguar_3rd_Ref Jaguar 3rd Ref] ''(a.k.a. GenTab.D)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#General_Fields GenTab] of CT.
 +
* '''Shippers:'''.
 +
** Mapped to [http://mantis.jaguarfreight.com/wiki/CT_bo#Shipper Shipper] ''(a.k.a. GenTab.2)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#General_Fields GenTab] of CT.
 +
* '''Consignees:'''.
 +
** Mapped to [http://mantis.jaguarfreight.com/wiki/CT_bo#Consignee Consignee] ''(a.k.a. GenTab.3)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#General_Fields GenTab] of CT.
 +
* '''Container #s:'''. This filter makes sense only for MOT = {Ocean-LCL, Ocean-FCL, Trucking-Ocean}.
 +
** Mapped to [http://mantis.jaguarfreight.com/wiki/Container#Container_Num Container Num] from [http://mantis.jaguarfreight.com/wiki/Container#Container_Num Containers Table] on ContTab of CT.
 +
** If "Container #s:" field is not empty:
 +
*** "Master Airway Bills" field should be hidden on the template.
 +
*** Report should be show records that are filtered by Ocean only. The records for different MOT must not be showing in this case.
 +
** When user enters number in, it should be tab over automatically for each box. For example, AAAA-111111-1 user must be able to enter 11 symbols without jump it to each box manually. There are 3 boxes with 4 chars, 6 digits, and 1 digit with automatically tab over when user are typing.
 +
** When searching for a container number with a missing the check digit (the last digit in the container number) then the last box can have an '''*''' placed in it. This would search all numbers from 0-9 as the check digit (''example'', by entering AAAA-123456-*, it would search from AAAA-123456-0 through AAAA-123456-9).
 +
* '''Master Airway Bills:'''. This filter makes sense only for MOT = {Air, Trucking-Air}.
 +
** Mapped to :
 +
*** [http://mantis.jaguarfreight.com/wiki/CT_bo#MAWB MAWB] ''(a.k.a. ExpTab.7)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#Export_Fields ExpTab] of CT for MOT=Air.
 +
*** [http://mantis.jaguarfreight.com/wiki/CT_bo#MAWB MAWB] ''(a.k.a. GenTab.air1)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#General_Fields GenTab] of CT for MOT=Trucking-Air.
 +
** If "Master Airway Bills" field is not empty:
 +
*** "Container #s:" and "Steamshipline Booking Number contains:" fields should be hidden on the template.
 +
*** Report should be show records that are filtered by AIR only. The records for different MOT must not be showing in this case.
 +
** When user enters number in, it should be tab over automatically for each box. For example, 111-1111-1111 user must be able to enter 11 digits without jump it to each box manually. There are 3 boxes with 3 digits, 4 digits, and 4 digits with automatically tab over when user are typing.
 +
* '''Steamshipline Booking Number contains:'''. This filter makes sense only for MOT = {Ocean-LCL, Ocean-FCL}.
 +
** Mapped to [http://mantis.jaguarfreight.com/wiki/CT_bo#Booking_Num Booking Num] ''(a.k.a. ExpTab.6)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#Export_Fields ExpTab] of CT.
 +
* '''Departure Date:''' A pair of "from" and "to" databoxes (to select range) .
 +
** Mapped to:
 +
*** [http://mantis.jaguarfreight.com/wiki/CT_bo#Origin_Terminal_Actual_Date Actual Time of Departure] ''(ATD a.k.a. ExpTab.11c)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#Export_Fields ExpTab] of CT for MOT={Air, Ocean}.
 +
**** If ATD is blank, then use [http://mantis.jaguarfreight.com/wiki/CT_bo#Origin_Terminal_Estimated_Date Estimated Time of Departure] ''(ETD a.k.a. ExpTab.11b)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#Export_Fields ExpTab] of CT.
 +
*** [http://mantis.jaguarfreight.com/wiki/CT_bo#Actual_Export_Pick_Up_Date Actual Export Pick Up Date] ''(a.k.a. GenTab.10)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#General_Fields GenTab] of CT for MOT={Trucking, Undefined}.
 +
**** If Actual Export Pick Up Date is blank, then use [http://mantis.jaguarfreight.com/wiki/CT_bo#Estimated_Export_Pick_Up_Date Estimated Export Pick Up Date] ''(a.k.a. GenTab.9)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#General_Fields GenTab] of CT.
 +
** Departure Date field logic to control all the dates : from date MUST not be after to date (chronologically).
 +
* '''Arrival Date:''' A pair of "from" and "to" databoxes (to select range) .
 +
** Mapped to:
 +
*** [http://mantis.jaguarfreight.com/wiki/CT_bo#Destination_Terminal_Actual_Date Actual Time of Arrival] ''(ATA a.k.a. ExpTab.15c)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#Export_Fields ExpTab] of CT for MOT=Ocean.
 +
**** If ATA is blank, then use [http://mantis.jaguarfreight.com/wiki/CT_bo#Destination_Terminal_Estimated_Date Estimated Time of Arrival] ''(ETA a.k.a. ExpTab.15b)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#Export_Fields ExpTab] of CT.
 +
*** [http://mantis.jaguarfreight.com/wiki/CT_bo#Destination_Terminal_Actual_Date Actual Time of Arrival] ''(ATA a.k.a. ExpTab.14c)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#Export_Fields ExpTab] of CT for MOT=Air.
 +
**** If ATA is blank, then use [http://mantis.jaguarfreight.com/wiki/CT_bo#Destination_Terminal_Estimated_Date Estimated Time of Arrival] ''(ETA a.k.a. ExpTab.14b)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#Export_Fields ExpTab] of CT.
 +
*** [http://mantis.jaguarfreight.com/wiki/CT_bo#Actual_Delivery_Date Actual Delivery Date] ''(ADD a.k.a. GenTab.y)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#General_Fields GenTab] of CT for MOT=Trucking.
 +
**** If Actual Delivery Date is blank, then use [http://mantis.jaguarfreight.com/wiki/CT_bo#Estimated_Delivery_Date Estimated Delivery Date] ''(EDD a.k.a. GenTab.x)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#General_Fields GenTab] of CT.
 +
** Arrival Date field logic to control all the dates the same as above: from date MUST not be after to date.
 +
* '''From Countries:'''.
 +
** Mapped to [http://mantis.jaguarfreight.com/wiki/CT_bo#Origin_Country Origin Country] ''(a.k.a. GenTab.11)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#General_Fields GenTab] of CT.
 +
* '''To Countries:'''.
 +
** Mapped to [http://mantis.jaguarfreight.com/wiki/CT_bo#Destination_Country Destination Country] ''(a.k.a. GenTab.12)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#General_Fields GenTab] of CT.
 +
* '''No Archived'''.
 +
** [[Checkbox]] that defines the presence of the [http://mantis.jaguarfreight.com/wiki/List_CTs#Archived_Tab "archived"] CTs in the result of the Report.
-
tw1) HTML paging
+
NOTES:
 +
* All Filters (except Date Filters and "No Archived" checkbox) are [http://mantis.jaguarfreight.com/wiki/Reports_Filters#Multiselect multiselect].
 +
* Every filter connected by '''AND''' and selections inside filter are connected by '''OR'''.
 +
<!-- ** Example: [[TBD]]. -->
 +
* Empty Filters don't affect on the result of the Report.
 +
* At least one Filter should be not empty. Otherwise, System shows the error message "You have not set any filter" and doesn't generate the Report.
-
tw2) Master Airway Bills and container# fields, when user enters number in, it should be tab over automatically for each box. For example, 111-1111-1111 user must be able to enter 11 digits without jump it to each box manually. There are 3 boxes with 3 digits, 4 digits, and 4 digits with automatically tab over when user are typing.
+
==== Action controls ====
-
* --[[User:Alex|Alex]] 17:06, 31 July 2009 (UTC) new: see [[Master Airway Bill field]]
+
* ''Generate Result'' button:  
 +
: to generate report
-
tw3) Logic for the Master Airway right now is not correct.
+
* ''Reset Form '' button:
-
* If Master Airway Bills field is not empty, show records that are filtered by AIR only. The records for different MOT must not be showing in this case.
+
: to clear form
-
* If Container #s: field is not empty, show records that are filtered by Ocean only. The records for different MOT must not be showing in this case.
+
-
tw4) Logic for '''Container #s:''' and '''Master Airway Bills''', it must be allowed user to choose one at the time. One field must be read only (grey out) when the other field is active.
+
=== Output ===
 +
The output results of Where Is Report is displayed in the new window (see [[#Figure 2: Where Is Report Output in HTML | Figure 2]]) and can be obtained in two formats:
 +
* first, it is generated in [[#HTML output form | HTML]],
 +
* then can be downloaded as a [[#Spreadsheet output form | spreadsheet]].
-
tw5) When user does not set any filter(s) and click "Generate results", it does not search anything and it must also notify user somehow as 2 options below:
+
==== HTML output form ====
-
* show an error message somewhere.
+
===== Header =====
-
* or "Generate result" button must be in a non-active mode or a grey out button.
+
* big bold label "Where Is"
 +
* two action buttons:
 +
** "Go Back" - allows go back to the template of the Report.
 +
** "Download to Excel" - allows to save the report in spreadsheet's form to user's computer.
 +
* list of selected [[#Filters | Filters]]
-
tw6) On the result page, Deliv Date and Comment columns should be merged and should not be showing both at the same time. See options below:
+
===== Body =====
-
*grey out one column when the other one is active.
+
This is a table that contains a list of CTs, which are separated by tabs in accordance with the appropriate [[CT#MOT | MOT]].
-
** If Deliv Date column is showed, Comment column must be greyed out or n/a.
+
-
** If Comment column is showed, Deliv Date column must be greyed out or n/a.
+
-
* OR merge both columns to one column
+
There are five tabs on the resulting table:
-
** show an active column only. For example, when Deliv Date field is active, there is no Comment column or vise versa.
+
* UNDEFINED - displays all found ''Undefined'' shipments
 +
* OCEAN-FCL - same as above but for ''Ocean-FCL (AW/MLB)'' shipments
 +
* OCEAN-LCL - for ''Ocean-LCL and Client Consol'' shipments
 +
* AIR - for ''AIR'' shipments
 +
* TRUCKING - for all kind of ''Trucking'' shipments
-
'''Note:'''  tw1-tw6 -- [[User:Tira|Tira]] 05:20 PM 27 July 2009 (UTC)
+
On the label of each tab also displays a count of found shipments.
-
tw7) --[[User:Alex|Alex]] 18:41, 31 July 2009 (UTC)  need Jag logo on xls version of report (top right)
+
===== Columns =====
 +
* '''CT #''' - [[CT#CT Num | CT Number]] with hyperlink to View CT form in Internal App
 +
* '''Shipper''' - Mapped to [[CT#Shipper | Shipper]]. Displays Shipper's Name with Shipper's city. ''Example:'' COSMETECH MABLY INTERNATIONAL - New York.
 +
* '''Consignee''' - Mapped to [[CT#Consignee | Consignee]]. Displays Consignee's Name with Consignee's city. Looks the same as above.
 +
* '''Dep Port''' - Location that shipment is moved from (port). Displays a pair of City and Country. ''Example:'' Hamburg, Germany.
 +
** Mapped to:
 +
*** [http://mantis.jaguarfreight.com/wiki/CT_bo#Origin_Terminal Origin Terminal] ''(a.k.a. ExpTab.11a)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#Export_Fields ExpTab] of CT for MOT={Air, Ocean}.
 +
*** City From [http://mantis.jaguarfreight.com/wiki/CT_bo#Shipper Shipper] ''(a.k.a. GenTab.2)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#General_Fields GenTab] of CT for MOT={Trucking, Undefined}.
 +
* '''Dest Port''' - Location that shipment is moved to (port). Displays a pair of City and Country the same as for '''Dep Port'''.
 +
*** [http://mantis.jaguarfreight.com/wiki/CT#Airport_Of_Destination Airport Of Destination] ''(a.k.a. ExpTab.14a)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#Export_Fields ExpTab] of CT for MOT=Air.
 +
*** [http://mantis.jaguarfreight.com/wiki/CT#Destination_Terminal Destination Terminal] ''(a.k.a. ExpTab.15a)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#Export_Fields ExpTab] of CT for MOT=Ocean.
 +
*** City From [http://mantis.jaguarfreight.com/wiki/CT_bo#Consignee Consignee] ''(a.k.a. GenTab.3)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#General_Fields GenTab] of CT for MOT={Trucking, Undefined}.
 +
* '''Dep Date''' - Actual (or Estimated) Date of Departure as define in [[#Filters | Filters]] section for Departure Date filter.
 +
* '''Arriv Date''' - Actual (or Estimated) Date of Arrival as define in [[#Filters | Filters]] section for Arrival Date filter.
 +
* '''Deliv Date/Comment''' - column that combines the two values which are used in mutually exclusive mode:
 +
** Actual Delivery Date:
 +
*** For MOT={Air, Ocean-LCL} is used [http://mantis.jaguarfreight.com/wiki/CT_bo#Actual_Delivery_Date Actual Delivery Date] ''(ADD a.k.a. ImpTab.11)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#Import_Fields ImpTab] of CT.
 +
**** If ADD is blank, then use [http://mantis.jaguarfreight.com/wiki/CT_bo#Estimated_Delivery_Date Estimated Delivery Date] ''(EDD a.k.a. ImpTab.10)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#Import_Fields ImpTab] of CT.
 +
*** For MOT=Ocean-FCL is used [http://mantis.jaguarfreight.com/wiki/Container#Actual_Delivery_Date Actual Delivery Date] ''(a.k.a. Cont.ADD)'' from [http://mantis.jaguarfreight.com/wiki/Container Container Table] (select latest across ALL containers).
 +
**** If Cont.ADD is blank, then use [http://mantis.jaguarfreight.com/wiki/Container#Estimated_Delivery_Date Estimated Delivery Date] ''(a.k.a. Cont.EDD)'' from [http://mantis.jaguarfreight.com/wiki/Container Container Table] of CT.
 +
*** For MOT=Trucking is used [[http://mantis.jaguarfreight.com/wiki/CT_bo#Actual_Delivery_Date Actual Delivery Date] ''(ADD a.k.a. GenTab.y)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#General_Fields GenTab] of CT for MOT=Trucking.
 +
**** If Actual Delivery Date is blank, then use [http://mantis.jaguarfreight.com/wiki/CT_bo#Estimated_Delivery_Date Estimated Delivery Date] ''(EDD a.k.a. GenTab.x)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#General_Fields GenTab] of CT.
 +
*** For MOT=Undefined is used a blank field.
 +
**[http://mantis.jaguarfreight.com/wiki/CT_bo#Delivery_Comment Delivery Comment] from [http://mantis.jaguarfreight.com/wiki/CT_bo#Import_Fields ImpTab] of CT.
-
tw8) --[[User:Alex|Alex]] 18:41, 31 July 2009 (UTC)  CBM - need 2 decimals not 3
+
===== Paging and Sorting =====
 +
* Output HTML table uses standart [http://mantis.jaguarfreight.com/wiki/Paging#ZK_standard ZK Paging] feature. Each page contains 20 lines.
 +
* Sorting of table proceeds by first column - [[CT#CT Num | CT Number]], in ascending order.
-
tw9) Must have logic to control all the dates (high priority) For example:
+
==== Spreadsheet output form ====
-
* Departure Date field logic : from date MUST not be after to date. (chronologically) -- [[User:Tira|Tira]] 4:09 PM 4 Aug 2009 (UTC)
+
===== Header =====
-
* Arrival Date field logic : from date MUST not be after to date. -- --[[User:Tira|Tira]] 11:20 PM 4 Aug 2009 (UTC)
+
* Title of the Report
 +
* Datetime stamp
 +
* Criteria(list of filters selected)
 +
* CT2 logo in the top right corner
-
'''Note:''' tw10) --[[user:Tira|Tira]] 2:35 PM 6 Sep 2009 (UTC)
+
===== Body =====
-
tw10) Where Is Report, Need to have a binoculars [[File:Binocular.JPG]] in front of the detail record that is searched for.
+
Output spreadsheet contains information in single tab "Where Is". This info is grouped by sections each of which corresponds to one MOT. At the beginning of each section displays its name in accordance with the MOT and the count of found documents. In the next line of section displayed columns' headers. Then, line by line displayed information for each PO from the shipments that were included to Report for this MOT.
-
For Example,
+
Sections are displayed in the next order:
 +
* UNDEFINED,
 +
* OCEAN-FCL,
 +
* OCEAN-LCL,
 +
* AIR,
 +
* TRUCKING.
-
Cybertrax> Where Is> set filter(s)> Generate result.
+
===== Columns =====
 +
* '''CT #''' - [[CT#CT Num | CT Number]] with hyperlink to View CT form in Internal App
 +
* '''Shipper''' - Mapped to [[CT#Shipper | Shipper]]. Displays Shipper's Name with Shipper's city in the same form as on the template.
 +
* '''P.O.''' - Mapped to [[Commodity#PO | PO]].
 +
* '''SKU''' - Mapped to [[Commodity#SKU | SKU]].
 +
* '''Quantity''' - Mapped to [[Commodity#Qty | Qty]].
 +
* '''Item Description''' - Mapped to [[Commodity#Description |Description]].
 +
* '''Gross Weight''' - Mapped to [[Commodity#Gross_Kg]].
 +
* '''Depart Port''' - The same as defined Dep Port column in [[#HTML output form | HTML output form]].
 +
* '''Dest Port''' - The same as defined Dest Port column in [[#HTML output form | HTML output form]].
 +
* '''Depart Date''' - Actual (or Estimated) Date of Departure as define in [[#Filters | Filters]] section for Departure Date filter.
 +
* '''Arriv Date''' - Actual (or Estimated) Date of Arrival as define in [[#Filters | Filters]] section for Arrival Date filter.
 +
* '''Deliv Date'''. Mapped to:
 +
** [http://mantis.jaguarfreight.com/wiki/CT_bo#Actual_Delivery_Date Actual Delivery Date] ''(ADD a.k.a. ImpTab.11)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#Import_Fields ImpTab] of CT for MOT={Air, Ocean-LCL}.
 +
*** If ADD is blank, then use [http://mantis.jaguarfreight.com/wiki/CT_bo#Estimated_Delivery_Date Estimated Delivery Date] ''(EDD a.k.a. ImpTab.10)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#Import_Fields ImpTab] of CT.
 +
** For MOT=Ocean-FCL is used [http://mantis.jaguarfreight.com/wiki/Container#Actual_Delivery_Date Actual Delivery Date] ''(a.k.a. Cont.ADD)'' from [http://mantis.jaguarfreight.com/wiki/Container Container Table] (select latest across ALL containers).
 +
*** If Cont.ADD is blank, then use [http://mantis.jaguarfreight.com/wiki/Container#Estimated_Delivery_Date Estimated Delivery Date] ''(a.k.a. Cont.EDD)'' from [http://mantis.jaguarfreight.com/wiki/Container Container Table] of CT.
 +
** For MOT=Trucking is used [[http://mantis.jaguarfreight.com/wiki/CT_bo#Actual_Delivery_Date Actual Delivery Date] ''(ADD a.k.a. GenTab.y)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#General_Fields GenTab] of CT for MOT=Trucking.
 +
*** If Actual Delivery Date is blank, then use [http://mantis.jaguarfreight.com/wiki/CT_bo#Estimated_Delivery_Date Estimated Delivery Date] ''(EDD a.k.a. GenTab.x)'' from [http://mantis.jaguarfreight.com/wiki/CT_bo#General_Fields GenTab] of CT.
 +
** For MOT=Undefined is used a blank field.
-
User can set any filters; In this case I set filter for SKU contain 1111, then click generate result.
+
===== Paging and Sorting =====
-
Then lists of CT# result is generated. Then I want to see CT# 33 detail, I clicks CT# 33 link.
+
* For the Spreadsheet output form a using of Paging is not required.
-
Then I view CT#33, I am supposed to see a binocular in front of P.O 123 (because this P.O contains SKU 1111)
+
* Sorting of Spreadsheet table proceeds by first column - [[CT#CT Num | CT Number]], in ascending order.
 +
** As far as table contains info by each PO from CT, it is required a nested sorting by line number of [[Commodity#PO | PO]] in [[Commodity | Commodity Table]] of CT.
-
'''Note:''' tw11)and tw12) --[[user:Tira|Tira]] 5:30 PM 2 Oct 2009 (UTC)
+
=== Figures ===
-
 
+
==== Figure 0: Main Menu item ====
-
tw11) Add a column for binocular(s) itself/themselves in front of P.O column
+
[[File:MainMenuWhereIs.gif]]
-
 
+
==== Figure 1: Where Is Report Filters ====
-
tw12) Change the binocular color to Orange to be more outstanding (please ask Slava to design it)
+
[[File:WhereIsFilters.gif]]
-
 
+
==== Figure 2: Where Is Report Output in HTML ====
-
=== Note About Containers ===
+
[[File:WhereIsOutputHTML.gif]]
-
* see [[Containers_and_Contents_Component#FCL_.2F_LCL_vs_Ocean-Truck]]
+
==== Figure 3: Where Is Report Output in Spreadsheet ====
-
 
+
[[File:WhereIsOutputSpreadsheet.gif|950px]]
-
=== Note about Archived CTs ===
+
-
They are not included into this Report
+
-
 
+
-
 
+
-
== Dev ==
+
-
 
+
-
Old specs: http://mantis.jaguarfreight.com/svn/ct2/SS/reports/where_is/v2/
+
[[Category:OpsRepsCore]]
[[Category:OpsRepsCore]]
== History ==
== History ==
 +
 +
previous version of spec - http://mantis.jaguarfreight.com/mediawiki-1.15.0/index.php?title=Where_Is_Report&oldid=10774
=== m2045 ===
=== m2045 ===
Line 103: Line 217:
* Need to add text box for the Steamship Lines Booking # which is found on the export tab under field # 6
* Need to add text box for the Steamship Lines Booking # which is found on the export tab under field # 6
* [http://mantis.jaguarfreight.com/mediawiki-1.15.0/index.php?title=Where_Is_Report&oldid=9498 current revision]
* [http://mantis.jaguarfreight.com/mediawiki-1.15.0/index.php?title=Where_Is_Report&oldid=9498 current revision]
 +
==== SA ====
 +
* Add a filter: Steamship Lines Booking #
 +
'''Steamship Lines Booking #'''
 +
* Label: Steamship Lines Booking # contains:
 +
* Widget: [[textbox]] , can be multiple selected
 +
* Location: After Master Airway Bills:
 +
* This field can be found on the ocean > export tab under field # 6
 +
 +
NOTE: this field is applied to Ocean shipments ONLY
=== m1875===
=== m1875===
Line 109: Line 232:
==== BA ====
==== BA ====
* We need the option to search the last digit of the container # by typing * instead of typing any number between 0-9
* We need the option to search the last digit of the container # by typing * instead of typing any number between 0-9
-
** [[File:CT1 Where Is Report.JPG]]
+
** See Example on how to search by using * symbol
 +
[[File:CT1 Where Is Report.JPG]]
 +
 
 +
* See Results from the search by using the * symbol
 +
[[File:CT1 Where Is Report Results.JPG]]
 +
 
 +
==== SA ====
 +
* Add logic for * symbol in order to search the all digit from 0-9 possibilities
 +
* [http://mantis.jaguarfreight.com/mediawiki-1.15.0/index.php?title=Where_Is_Report&oldid=9658 current revision]
 +
 
 +
=== m2068 ===
 +
 
 +
[http://mantis.jaguarfreight.com/mantis/view.php?id=2068 2068]
 +
 
 +
==== BA ====
 +
*When searching for a PO # of Item Code (aka SKU #) we need the search feature to ignore upper/lower case letters
 +
 
 +
* Closed m2068; cannot replicate.  Please ignore this request.
 +
 
 +
*Final version: http://mantis.jaguarfreight.com/mediawiki-1.15.0/index.php?title=Where_Is_Report&oldid=10773
 +
 
 +
==== SA ====
 +
[[#SD: Systems Design]]

Current revision as of 17:49, 23 November 2010

Contents

[edit] Info

Parent Mantis - 1587

[edit] BR: Business Requirements

  • Need to add text box for Steamship Lines Booking #
  • For Container #, need option to search the last digit by typing * instead of typing any number between 0-9
  • Need search feature to ignore upper/lower case letters when searching by a PO # of Item Code (aka SKU #)

[edit] SD: Systems Design

[edit] Summary

Where Is Report is one of core reports of CT2. It provides the ability to search and display shipments, which comply to user-defined conditions.

  • All needed User Defined Conditions (these are also called filters) could be set in the Filters section on the template of the Report.
  • Where Is Report NOT uses any Hard Coded Conditions.

[edit] Interface

Report is available right from the Main Menu of CT2. See Figure 0.

In order to generate report user have to:

  • configure User Defined Conditions in the Filters section on the template (see Figure 1) and
  • click appropriate button for needed action

[edit] Filters

Result of the Report that will be showed to user depends of the values of the following Filters (in that order of locating on the template):

  • P.O. contains:.
  • SKU contains:.
  • Export Ref # contains:.
  • Import Ref # contains:.
  • Customer Ref # contains:.
  • Jaguar 3rd Ref # contains:.
  • Shippers:.
  • Consignees:.
  • Container #s:. This filter makes sense only for MOT = {Ocean-LCL, Ocean-FCL, Trucking-Ocean}.
    • Mapped to Container Num from Containers Table on ContTab of CT.
    • If "Container #s:" field is not empty:
      • "Master Airway Bills" field should be hidden on the template.
      • Report should be show records that are filtered by Ocean only. The records for different MOT must not be showing in this case.
    • When user enters number in, it should be tab over automatically for each box. For example, AAAA-111111-1 user must be able to enter 11 symbols without jump it to each box manually. There are 3 boxes with 4 chars, 6 digits, and 1 digit with automatically tab over when user are typing.
    • When searching for a container number with a missing the check digit (the last digit in the container number) then the last box can have an * placed in it. This would search all numbers from 0-9 as the check digit (example, by entering AAAA-123456-*, it would search from AAAA-123456-0 through AAAA-123456-9).
  • Master Airway Bills:. This filter makes sense only for MOT = {Air, Trucking-Air}.
    • Mapped to :
      • MAWB (a.k.a. ExpTab.7) from ExpTab of CT for MOT=Air.
      • MAWB (a.k.a. GenTab.air1) from GenTab of CT for MOT=Trucking-Air.
    • If "Master Airway Bills" field is not empty:
      • "Container #s:" and "Steamshipline Booking Number contains:" fields should be hidden on the template.
      • Report should be show records that are filtered by AIR only. The records for different MOT must not be showing in this case.
    • When user enters number in, it should be tab over automatically for each box. For example, 111-1111-1111 user must be able to enter 11 digits without jump it to each box manually. There are 3 boxes with 3 digits, 4 digits, and 4 digits with automatically tab over when user are typing.
  • Steamshipline Booking Number contains:. This filter makes sense only for MOT = {Ocean-LCL, Ocean-FCL}.
  • Departure Date: A pair of "from" and "to" databoxes (to select range) .
  • Arrival Date: A pair of "from" and "to" databoxes (to select range) .
  • From Countries:.
  • To Countries:.
  • No Archived.

NOTES:

  • All Filters (except Date Filters and "No Archived" checkbox) are multiselect.
  • Every filter connected by AND and selections inside filter are connected by OR.
  • Empty Filters don't affect on the result of the Report.
  • At least one Filter should be not empty. Otherwise, System shows the error message "You have not set any filter" and doesn't generate the Report.

[edit] Action controls

  • Generate Result button:
to generate report
  • Reset Form button:
to clear form

[edit] Output

The output results of Where Is Report is displayed in the new window (see Figure 2) and can be obtained in two formats:

[edit] HTML output form

[edit] Header
  • big bold label "Where Is"
  • two action buttons:
    • "Go Back" - allows go back to the template of the Report.
    • "Download to Excel" - allows to save the report in spreadsheet's form to user's computer.
  • list of selected Filters
[edit] Body

This is a table that contains a list of CTs, which are separated by tabs in accordance with the appropriate MOT.

There are five tabs on the resulting table:

  • UNDEFINED - displays all found Undefined shipments
  • OCEAN-FCL - same as above but for Ocean-FCL (AW/MLB) shipments
  • OCEAN-LCL - for Ocean-LCL and Client Consol shipments
  • AIR - for AIR shipments
  • TRUCKING - for all kind of Trucking shipments

On the label of each tab also displays a count of found shipments.

[edit] Columns
  • CT # - CT Number with hyperlink to View CT form in Internal App
  • Shipper - Mapped to Shipper. Displays Shipper's Name with Shipper's city. Example: COSMETECH MABLY INTERNATIONAL - New York.
  • Consignee - Mapped to Consignee. Displays Consignee's Name with Consignee's city. Looks the same as above.
  • Dep Port - Location that shipment is moved from (port). Displays a pair of City and Country. Example: Hamburg, Germany.
    • Mapped to:
  • Dest Port - Location that shipment is moved to (port). Displays a pair of City and Country the same as for Dep Port.
  • Dep Date - Actual (or Estimated) Date of Departure as define in Filters section for Departure Date filter.
  • Arriv Date - Actual (or Estimated) Date of Arrival as define in Filters section for Arrival Date filter.
  • Deliv Date/Comment - column that combines the two values which are used in mutually exclusive mode:
[edit] Paging and Sorting
  • Output HTML table uses standart ZK Paging feature. Each page contains 20 lines.
  • Sorting of table proceeds by first column - CT Number, in ascending order.

[edit] Spreadsheet output form

[edit] Header
  • Title of the Report
  • Datetime stamp
  • Criteria(list of filters selected)
  • CT2 logo in the top right corner
[edit] Body

Output spreadsheet contains information in single tab "Where Is". This info is grouped by sections each of which corresponds to one MOT. At the beginning of each section displays its name in accordance with the MOT and the count of found documents. In the next line of section displayed columns' headers. Then, line by line displayed information for each PO from the shipments that were included to Report for this MOT.

Sections are displayed in the next order:

  • UNDEFINED,
  • OCEAN-FCL,
  • OCEAN-LCL,
  • AIR,
  • TRUCKING.
[edit] Columns
[edit] Paging and Sorting
  • For the Spreadsheet output form a using of Paging is not required.
  • Sorting of Spreadsheet table proceeds by first column - CT Number, in ascending order.
    • As far as table contains info by each PO from CT, it is required a nested sorting by line number of PO in Commodity Table of CT.

[edit] Figures

[edit] Figure 0: Main Menu item

File:MainMenuWhereIs.gif

[edit] Figure 1: Where Is Report Filters

File:WhereIsFilters.gif

[edit] Figure 2: Where Is Report Output in HTML

File:WhereIsOutputHTML.gif

[edit] Figure 3: Where Is Report Output in Spreadsheet

[edit] History

previous version of spec - http://mantis.jaguarfreight.com/mediawiki-1.15.0/index.php?title=Where_Is_Report&oldid=10774

[edit] m2045

2045

[edit] BA

  • Need to add text box for the Steamship Lines Booking # which is found on the export tab under field # 6
  • current revision

[edit] SA

  • Add a filter: Steamship Lines Booking #

Steamship Lines Booking #

  • Label: Steamship Lines Booking # contains:
  • Widget: textbox , can be multiple selected
  • Location: After Master Airway Bills:
  • This field can be found on the ocean > export tab under field # 6

NOTE: this field is applied to Ocean shipments ONLY

[edit] m1875

1875

[edit] BA

  • We need the option to search the last digit of the container # by typing * instead of typing any number between 0-9
    • See Example on how to search by using * symbol

File:CT1 Where Is Report.JPG

  • See Results from the search by using the * symbol

File:CT1 Where Is Report Results.JPG

[edit] SA

  • Add logic for * symbol in order to search the all digit from 0-9 possibilities
  • current revision

[edit] m2068

2068

[edit] BA

  • When searching for a PO # of Item Code (aka SKU #) we need the search feature to ignore upper/lower case letters
  • Closed m2068; cannot replicate. Please ignore this request.

[edit] SA

#SD: Systems Design

Retrieved from "https://wiki.jaguarfreight.com/Where_Is_Report"
Personal tools