Client Main Report

From UG

Current revision as of 14:42, 11 June 2014

[edit] Dev

Mantis parent: 0000591:Client.Reports

[edit] Business Requirements

Client Main Report is reusing the code from Internal App Main Report. There are some similarities and differences in term of list of filters, output and design.

It allows client to create a report for his/her company's shipments. This applies client's visibility's rules.

[edit] Specs

• See Main report specs from Internal App > Main Report at Main Wizard Report
• There are 4 different categories for filters:
  • General Filters
  • Transportation Filters
  • Date Filters
  • Output
• Some filters require Client visibility rule
• There is Reset Form button; It allows user to clear all the filters to the fresh beginning stage
• There is Generate Result button; system will generate result after user clicks this button
• Label of filters' names can be different from Internal Main Report
• Each filter has "clr" button in order to clear info for a specific filter
• See #Figure 1. Main report

[edit] General Filters

• All the same as Main report (Internal App) but these filters drop down list MUST be Client specific: Auto populated; it should show only the specific list for client:
  • Client Company
    • Show/hide Client Companies list filter. When there is only client company in the filter, this filter section should be invisible. If there is more than one client companies, this filter becomes visible.
  • Shipper
  • Consignee
  • Origin Country
  • Destination Country
  • Origin Region
  • Destination Region
  • Shipping Terms
  • Pickup Locations
  • Delivery Locations
• The rest of filters are not required Client specific: Auto populated
  • P.O. contains:
  • SKU contains:
  • Customer Ref # contains:
  • Booking # contains: is applied only for OCEAN CTs
• List of filters that are not required, compare to Main Wizard Report on Internal App
  • Export Ref # contains:
  • Import Ref # contains:
  • Jaguar 3rd Ref # contains:
  • Remove Cargo Locations
• Transport Mode filters in General filters Tab has a logic connecting to Transportation Filters.
  • IF client selects ANY OCEAN for transport mode, Transportation Filters tab will provide ONLY lists of ocean filters as below:
    • Container#s
    • Shipping Line
    • Origin Port/Terminal
    • Destination Port/Terminal
    • Vessel Name Contains
  • IF client select AIR for transport mode, Transportation Filters tab will provide ONLY lists of air filters as below:
    • Airlines
    • Origin Airport
    • Destination Airport
  • IF client selects Truck-Domestic for transport mode, Transportation Filters tab will provide ONLY lists of Truck-Domestic filters as below:
    • Pickup Trucker: The list must be auto populated only specific list that is applied to specific client.
    • Delivery Trucker: The list must be auto populated only specific list that is applied to specific client.
    • Pickup Trailer# contains: Text box for user’s input
    • Delivery Trailer# contains: Text box for user’s input
    • Origin City contains: Text box for user’s input
    • Destination City contains: Text box for user’s input
    • Origin State: The list of State(US) must be auto populated only specific list that is applied to specific client.
    • Destination State: The list of State(US) must be auto populated only specific list that is applied to specific client.
    • Origin Zip code contains: The list of zipcode
    • Destination Zip code contains: The list of zipcode
• Transport Mode filter list should includes all modes and Undefined mode as listed option
• There is a filter Archived Check box, same as internal application main report that default to No Archived

[edit] Transportation Filters

• Transportation Filters
  • AIR filters will ONLY show when client clicks AIR for Transport Mode in General filter tab
    • These filters drop down list MUST be Client specific: Auto populated; it should show only the specific list for client:
      • Airlines
      • Origin Airport
      • Destination Airport
  • OCEAN filters will ONLY show when client clicks ANY OCEAN for Transport Mode in General filter tab
    • These filters drop down list MUST be Client specific: Auto populated; it should show only the specific list for client:
      • Container#s
      • Shipping Line
      • Origin Port/Terminal
      • Destination Port/Terminal
      • Vessel Name Contains
  • TRUCK There is no any filters on Transportation filters except Truck- Domestic
    • TRUCK-DOMESTIC filters will ONLY show when client clicks Truck-Domestic for Transport Mode in General filter tab
      • These filters drop down list MUST be Client specific: Auto populated; it should show only the specific list for client:
        • Pickup Trucker
        • Delivery Trucker
        • Pickup Trailer# contains: Text box for user’s input
        • Delivery Trailer# contains: Text box for user’s input
        • Origin City contains
        • Destination City contains
        • Origin State
        • Destination State
        • Origin Zip code contains
        • Destination Zip code contains
      • Please NOTE that city, state, and zip code are for US and CANADA ONLY
• Transport Mode filter list should includes all modes and Undefined mode as listed option
• See #Figure 2. Transportation Filters for the case of no transport mode is selected or Truck mode(s) is selected from general filters
• List of filters that are not required, compare to Main Wizard Report on Internal App
  • • Pickup Truckers
    • Delivery Truckers
    • Co-Loader Ocean
    • Co-Loader Air

[edit] Date Filters

• Order of Filters from the top to the bottom"
  • Estimated Pickup Date:
  • Actual Pickup Date:
  • Estimated Departure Date:
  • Actual Departure Date:
  • Estimated Arrival Date:
  • Actual Arrival Date:
  • Estimated Delivery Date:
  • Actual Delivery Date:
• Date Logics:
  • "Delivery Date" cannot be before "Arrival Date", "Departure Date", and "Pickup Date"
  • "Arrival Date" cannot be before "Departure Date", and "Pickup Date"
  • "Departure Date" cannot be before "Pickup Date"
• Must have "clear" button for every date field .
• See #Figure 3. Date Filters

[edit] Output

• Output consists of a long list of headings
• Output list is multi-selected
• Default: selected output list should be listed on the right box and the rest should be in output dropdown list
• User is able to manage the order of the output heading list by moving up and down
• User is able to add/remove the output heading list by moving it to the left or right
• See #Figure 4. Output
• Label output heading as listed below
  • Field // Apply to Mode // Default on the right box
  • CT# // All modes // Yes
  • Shipper // All modes // Yes
  • Consignee // All modes // Yes
  • Transport Mode // All modes // Yes
  • Departure // All modes // Yes
  • Destination // All modes // Yes
  • Actual Departure Date // All modes // Yes
  • Actual Arrival Date // All modes // Yes
  • Actual Delivery Date // All modes // Yes
  • Commodity Item PO# // All modes // No
  • Commodity Item SKU# // All modes // No
  • Commodity Item Description // All modes // No
  • Commodity Item Quantity // All modes // No
  • Commodity Item Total Pallets // All modes // No
  • Commodity Item Total Loose Packages // All modes // No
  • Commodity Item Gross Kg // All modes // No
  • Chargeable Weight // All modes // No
  • Departure Region // All modes // No
  • Destination Region // All modes // No
  • Notification Date // All modes // No
  • Authorization Date // All modes // No
  • Estimated Departure Date // All modes // No
  • Estimated Arrival Date // All modes // No
  • Estimated Delivery Date // All modes // No
  • Estimated Collection Date // All modes // No
  • Actual Collection Date // All modes // No
  • Vessel name // OCEAN // No
  • Flight Number // AIR // No
  • HAWB# // AIR // No
  • Container Description // OCEAN // No
  • Shipping Line // OCEAN // No
  • Airline // AIR // No
  • Commodity Item Extra Field 1 // All modes // No
  • Commodity Item Extra Field 2 // All modes // No
  • Commodity Item Extra Field 3 // All modes // No
  • Steamshipline Booking # // OCEAN // No
  • Commodity Item Gross Lb // All modes // No
  • Pickup Trucker // TRUCK-DOMESTIC // No
  • Delivery Trucker // TRUCK-DOMESTIC // No
  • Pickup Trailer# // TRUCK-DOMESTIC // No
  • Delivery Trailer# // TRUCK-DOMESTIC // No
  • Origin City // TRUCK-DOMESTIC // No
  • Origin State // TRUCK-DOMESTIC // No
  • Origin Zip Code // TRUCK-DOMESTIC // No
  • Destination City // TRUCK-DOMESTIC // No
  • Destination State // TRUCK-DOMESTIC // No
  • Destination Zip Code // TRUCK-DOMESTIC // No

More information from fields above:

Air

ETD :ExpTab 11b. Airport of Departure:
ATD :ExpTab 11c. ATD - Actual Time of Dept:
ETA :ExpTab 14b. ETA - Est Time of Arrival:
ATA :ExpTab 14c. ATA - Actual Time of Arrival:
Estimate Collection Date: GenTab 9. Estimated Export Pick-Up Date:
Actual Collection Date: GenTab 10. Actual Export Pick-Up Date:
Requested Delivery Date: ImpTab b.Estimated Delivery Date:
Actual Delivery Date: ImpTab b.Actual Delivery Date:

Ocean

ETD :ExpTab 12b. ETD:
ATD :ExpTab 12c. ATD:
ETA :ExpTab 14b. ETA:
ATA :ExpTab 14c. ATA:
Estimate Collection Date: ContTab for FCL shipment, GenTab 9. Estimated Export Pick-Up Date: for LCL
Actual Collection Date: ContTab for FCL shipment, GenTab 10. Actual Export Pick-Up Date: for LCL
Requested Delivery Date: ContTab for FCL shipment, ImpTab 10. Estimated Delivery Date: for LCL
Actual Delivery Date: ContTab for FCL shipment, ImpTab 11. Actual Delivery Date: for LCL

Truck

ETD :GenTab 9. Estimated Export Pick-Up Date:
ATD :GenTab 10. Actual Export Pick-Up Date:
ETA :GenTab x. Estimated Delivery:
ATA :GenTab y. Actual Delivery:
Estimate Collection Date: GenTab 9. Estimated Export Pick-Up Date:
Actual Collection Date: GenTab 10. Actual Export Pick-Up Date:
Requested Delivery Date: GenTab x. Estimated Delivery:
Actual Delivery Date: GenTab y. Actual Delivery:

[edit] Report output

• HTML and xls
• Show record() count on the report to indicate that how many shipments per mode

[edit] Figures

[edit] Figure 1. Main report

[edit] Figure 2. Transportation Filters

[edit] Figure 3. Date Filters

[edit] Figure 4. Output

[edit] Figure 5. Transportation for Truck-Domestic

[edit] Tweaks version 1.1.a

Note: tweaks below applies to both Main and In-transit report Tira 9:50 28 Oct 2009

tw1) Add summary shipment record() count on the report to indicate that how many shipments...

tw2) Create a HTML result page before excel report

tw3) Create download to excel button -> generate xls report

[edit] Tweak version 1.1.b

tw1) Main Report - List of Transport Mode (filter) MUST include "UNDEFINED" as well in order to see Undefined shipments -- Tira 11:00 AM Feb 2, 2010

[edit] m2040

Mantis: 2047

[edit] SA

• Add Booking # filter

Booking #

• Label: Booking # contains:
• Widget: textbox , can be multiple selected
• Location: After Customer Ref # contains:

• Add Booking # on Output tab

• Default: on the left side dropdown list

NOTE: this field is applied to Ocean shipments ONLY

[edit] m2444

• 0002444: (Client Report: Main) Add No Archived Checkbox, same as internal application main report

As on http://mantis.jaguarfreight.com/wiki/Main_Report#Figure_3:_Main_Report_General_Filters

default to = Not Archived

• spec updated? Yes

[edit] m2236

• Mantis: 2236
• See Transportation Filter
• See #Figure 5. Transportation for Truck-Domestic
• Spec is updated: Y

[edit] RFC

rfc1) Simon would like to have dynamic filters for Client App by setting filters in Admin Mode for Non-jaguar Users -- Tira 12:33PM 19 Aug 2009 (UTC)

[edit] SOW

[edit] SOW 1 Enable sales invoices as output for clients with filter the output only specific bill to party visibility

• mantis: 4560

[edit] Core Requirements

• Re-implement sales invoice as a Main Report output for clients BUT filter the output to show ONLY invoices issued to a bill to party that listed in the Client User's E0 Client Profile.
• Include only “related bill to parties” invoices from a client interface

• see Client Profile – Part H >>> maybe a simple “enable client visibility” check box in that section with list of users who hve access to this invoices and see this fields as output in report.

[edit] Solution

• Client user can ONLY see what is linked to his E0

• Client User Admin - Enable Financial section on user profile

• Client Company Admin - Bill to parties linked

• Main report (client) - sales invoices output

• Select client users have visibility (it's a user specific access)

• Client Company Admin > enable list of users to see Financial data
• Mirroring enable list of users

[edit] SOW 2 Client Visibility for Invoices in Main report

• mantis: 4604

[edit] Core Requirements

• This is updated logic for filtering financial information in Client Application.
• Where we are today:

• user will see ALL Invoices for ALL "Bill To Party" Companies linked to ALL "E0. Client Company" from Client User Admin

• Where we want to go:

• user can see Invoices issued for only "Bill To Parties" selected in Client Company Admin for the CT's "E0. Client Company" to be visible (not implemented yet)

[edit] Solution

Logic Hierarchy for Client User:

• The FIRST question: Does the CLIENT want ANYONE to see FINANCIALS?

• E0 Client Profile > Check Box > Financial Visibility: yes / no (default is NO)

• The SECOND questions (only if first question answer is YES): What client users does the CLIENT allow to have visibility to financials?

• if first question answer is NO then NO USERS can have visibility.

[edit] Examples

• User Profile Admin section. User A is Client User for "E0. Client Company" = {Elizabeth Arden; EA DOM}
• Client Company Admin section. "E0. Client Company" linked to "Bill To Party":

• for Elizabeth Arden = {Elizabeth Arden Roanoke; EA Geneva}
• for EA DOM = {EA Domestic}

• Scenario 1.
• E0 Visibility set for Client User in Client Company Admin to:

• Elizabeth Arden - Yes,
• EA DOM - Yes.

• Enabled visibility:

• If EA DOM has a "EA Geneva" invoice, User A cannot see that invoice (only EA Domestic).

• Scenario 2
• E0 Visibility set for Client User in Client Company Admin to:

• Elizabeth Arden - No,
• EA DOM - Yes.

• Enabled visibility:

• Only CT's for E0 EADOM will "show" financial visibility to User A.
• This user will NOT see any financial information for E0 Elizabeth Arden CT's.