Where Is Report

From UG

Current revision as of 17:49, 23 November 2010

[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:.
  • Mapped to PO from Commodity Table on ContTab of CT.
• SKU contains:.
  • Mapped to SKU from Commodity Table on ContTab of CT.
• Export Ref # contains:.
  • Mapped to Export Ref (a.k.a. GenTab.A) from GenTab of CT.
• Import Ref # contains:.
  • Mapped to Import Ref (a.k.a. GenTab.B) from GenTab of CT.
• Customer Ref # contains:.
  • Mapped to Customer Ref (a.k.a. GenTab.C) from GenTab of CT.
• Jaguar 3rd Ref # contains:.
  • Mapped to Jaguar 3rd Ref (a.k.a. GenTab.D) from GenTab of CT.
• Shippers:.
  • Mapped to Shipper (a.k.a. GenTab.2) from GenTab of CT.
• Consignees:.
  • Mapped to Consignee (a.k.a. GenTab.3) from GenTab of CT.
• 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}.
  • Mapped to Booking Num (a.k.a. ExpTab.6) from ExpTab of CT.
• Departure Date: A pair of "from" and "to" databoxes (to select range) .
  • Mapped to:
    • Actual Time of Departure (ATD a.k.a. ExpTab.11c) from ExpTab of CT for MOT={Air, Ocean}.
      • If ATD is blank, then use Estimated Time of Departure (ETD a.k.a. ExpTab.11b) from ExpTab of CT.
    • Actual Export Pick Up Date (a.k.a. GenTab.10) from GenTab of CT for MOT={Trucking, Undefined}.
      • If Actual Export Pick Up Date is blank, then use Estimated Export Pick Up Date (a.k.a. GenTab.9) from 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:
    • Actual Time of Arrival (ATA a.k.a. ExpTab.15c) from ExpTab of CT for MOT=Ocean.
      • If ATA is blank, then use Estimated Time of Arrival (ETA a.k.a. ExpTab.15b) from ExpTab of CT.
    • Actual Time of Arrival (ATA a.k.a. ExpTab.14c) from ExpTab of CT for MOT=Air.
      • If ATA is blank, then use Estimated Time of Arrival (ETA a.k.a. ExpTab.14b) from ExpTab of CT.
    • Actual Delivery Date (ADD a.k.a. GenTab.y) from GenTab of CT for MOT=Trucking.
      • If Actual Delivery Date is blank, then use Estimated Delivery Date (EDD a.k.a. GenTab.x) from 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 Origin Country (a.k.a. GenTab.11) from GenTab of CT.
• To Countries:.
  • Mapped to Destination Country (a.k.a. GenTab.12) from GenTab of CT.
• No Archived.
  • Checkbox that defines the presence of the "archived" CTs in the result of the Report.

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:

• first, it is generated in HTML,
• then can be downloaded as a spreadsheet.

[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:
    • Origin Terminal (a.k.a. ExpTab.11a) from ExpTab of CT for MOT={Air, Ocean}.
    • City From Shipper (a.k.a. GenTab.2) from 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.
  • • Airport Of Destination (a.k.a. ExpTab.14a) from ExpTab of CT for MOT=Air.
    • Destination Terminal (a.k.a. ExpTab.15a) from ExpTab of CT for MOT=Ocean.
    • City From Consignee (a.k.a. GenTab.3) from GenTab of CT for MOT={Trucking, Undefined}.
• 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:
  • Actual Delivery Date:
    • For MOT={Air, Ocean-LCL} is used Actual Delivery Date (ADD a.k.a. ImpTab.11) from ImpTab of CT.
      • If ADD is blank, then use Estimated Delivery Date (EDD a.k.a. ImpTab.10) from ImpTab of CT.
    • For MOT=Ocean-FCL is used Actual Delivery Date (a.k.a. Cont.ADD) from Container Table (select latest across ALL containers).
      • If Cont.ADD is blank, then use Estimated Delivery Date (a.k.a. Cont.EDD) from Container Table of CT.
    • For MOT=Trucking is used [Actual Delivery Date (ADD a.k.a. GenTab.y) from GenTab of CT for MOT=Trucking.
      • If Actual Delivery Date is blank, then use Estimated Delivery Date (EDD a.k.a. GenTab.x) from GenTab of CT.
    • For MOT=Undefined is used a blank field.
  • Delivery Comment from ImpTab of CT.

[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

• CT # - CT Number with hyperlink to View CT form in Internal App
• Shipper - Mapped to Shipper. Displays Shipper's Name with Shipper's city in the same form as on the template.
• P.O. - Mapped to PO.
• SKU - Mapped to SKU.
• Quantity - Mapped to Qty.
• Item Description - Mapped to Description.
• Gross Weight - Mapped to Commodity#Gross_Kg.
• Depart Port - The same as defined Dep Port column in HTML output form.
• Dest Port - The same as defined Dest Port column in HTML output form.
• Depart 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. Mapped to:
  • Actual Delivery Date (ADD a.k.a. ImpTab.11) from ImpTab of CT for MOT={Air, Ocean-LCL}.
    • If ADD is blank, then use Estimated Delivery Date (EDD a.k.a. ImpTab.10) from ImpTab of CT.
  • For MOT=Ocean-FCL is used Actual Delivery Date (a.k.a. Cont.ADD) from Container Table (select latest across ALL containers).
    • If Cont.ADD is blank, then use Estimated Delivery Date (a.k.a. Cont.EDD) from Container Table of CT.
  • For MOT=Trucking is used [Actual Delivery Date (ADD a.k.a. GenTab.y) from GenTab of CT for MOT=Trucking.
    • If Actual Delivery Date is blank, then use Estimated Delivery Date (EDD a.k.a. GenTab.x) from GenTab of CT.
  • For MOT=Undefined is used a blank field.

[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

[edit] Figure 1: Where Is Report Filters

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

[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

• See Results from the search by using the * symbol

[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.

• Final version: http://mantis.jaguarfreight.com/mediawiki-1.15.0/index.php?title=Where_Is_Report&oldid=10773

[edit] SA

#SD: Systems Design