Est Tab

From UG

(Difference between revisions)
Jump to: navigation, search
(→SOW 8)
(→SOW 1 Add Populate ETOC from selected CT)
 
(12 intermediate revisions not shown)
Line 3: Line 3:
== Info ==
== Info ==
-
In mantis:
+
== Business Need ==
-
* '''parent''': 4088
+
* To enter estimated charges (on sales side)
-
* '''categories''':
+
* Ops instructed to enter by Arrival date
-
** Ops: CT Editor: Est Tab
+
-
** etc
+
-
* '''project''': Est Module
+
-
== Business need ==
+
== Component Description ==
-
 
+
-
Core need is to create way of entering '''estimated''' sales and cost of a shipment into a system before actual is known.
+
-
 
+
-
Motivation behind it: data collected will be used in various reports: CPU KPIs, Total Cost, etc.
+
-
 
+
-
Urgency: we need it ASAP because for non-closed CTs we must pull costs from here (into KPIs).
+
-
 
+
-
== Implementation ==
+
-
 
+
-
Several times we attempted to design and implement this in the past.
+
-
 
+
-
Module that addresses that we called Est(imation) Module.
+
-
 
+
-
UI is located on Est Tab of a CT profile.
+
-
 
+
-
See it documented here: [[:Category:Estimated P and L]].
+
-
 
+
-
== SOWs ==
+
-
 
+
-
=== SOW 1 Re-design Est Tab ===
+
-
 
+
-
'''mantis''': 4050
+
-
 
+
-
'''spec''': below
+
-
 
+
-
==== Intro ====
+
-
 
+
-
===== This is a refactoring =====
+
-
 
+
-
We need to re-work what we have in two places.
+
-
 
+
-
* remove/rework existing code on Est Tab (on CT Editor)
+
-
* incorporate estimation form features on Imp tab into a new module
+
-
* remove related existing functionality on Imp Tab
+
-
 
+
-
==== UI ====
+
-
<!--old:  [[File:Estimation module.JPG | 700px]] -->
+
-
 
+
-
Below are post implementation screen shots.
+
-
 
+
-
===== Figure 1 =====
+
-
 
+
-
UI without container charges:
+
-
 
+
-
[[File:Est tab new.JPG | 800px]]
+
-
 
+
-
===== Figure 2 =====
+
-
 
+
-
UI with container charges:
+
-
 
+
-
[[File:Est tab new w cont.JPG | 800px]]
+
-
 
+
-
==== Functionality ====
+
To enter charges user have to navigate to Est Tab.
To enter charges user have to navigate to Est Tab.
-
There he can add, remove, edit information in a table like format.
+
User can add, remove, edit information in a table like format.
-
 
+
-
===== General controls =====
+
-
See '''Section A''' on [[#Figure 1]].
+
=== General controls ===
* user have to save changes using "Save" button
* user have to save changes using "Save" button
* user can add and delete lines using '''Add''' and '''Remove''' buttons
* user can add and delete lines using '''Add''' and '''Remove''' buttons
-
===== Interface for non 13xx codes =====
+
=== Table of Estimated Charge Codes ===
-
In this case table has the following columns:
+
==== Sales section ====
-
'''Section B1:'''
+
Columns related to Estimated Sales.
-
* CC#
+
* '''CC#'''
-
** combobox with list of all charge codes defined in the system
+
** combobox with list of all [[Charge Code Admin |charge codes]] defined in the system
** selected by user
** selected by user
** required
** required
-
* Unit
+
* '''Unit'''
-
** unit of measurement associated with CC (as defined in "CBV Type default to:" param in cc admin)
+
** dropdown
-
** label values - see [[#Unit abbrevs]]
+
** see [[Sales Invoice#Unit]]
-
** pre-filled by system
+
 +
* '''DC''' - option to turn on/off the distribution by containers (for OCEAN CTs only)
 +
** checkbox
 +
** when checked Quantity/Rate/Amount will accomodate container entry
-
'''Section B2:'''
+
* '''Bill To Party'''
-
* Vendor
+
* '''Sale Quantity'''
-
** required
+
-
** entered by user
+
-
** combobox
+
-
 
+
-
* Cost Quantity
+
** required
** required
** pre-filled by system as defined in CC Admin > Quantity Field default to
** pre-filled by system as defined in CC Admin > Quantity Field default to
-
* Cost Rate
+
* '''Sale Rate'''
** required
** required
** entered by user
** entered by user
-
* Cost Amount
+
* '''Sale Amount'''
** required
** required
** not editable
** not editable
-
** calculated by system: Cost Quantity X Cost Rate
+
** calculated by system: Sale Quantity X Sale Rate
-
* Cost Curr
+
* '''Curr'''
-
** required
+
** required  
** entered by user
** entered by user
-
'''Section B3:'''
+
* '''M/I'''
 +
 
 +
* '''CBV'''
-
* Bill To Party
+
* '''CT#'''
 +
 
 +
* '''VAT'''
 +
 
 +
==== Cost section ====
 +
 
 +
Columns related to Estimated Cost.
 +
 
 +
* '''Vendor'''
** required
** required
** entered by user
** entered by user
 +
** combobox
-
* Sale Quantity
+
* '''Cost Quantity'''
** required
** required
** pre-filled by system as defined in CC Admin > Quantity Field default to
** pre-filled by system as defined in CC Admin > Quantity Field default to
-
* Sale Rate
+
* '''Cost Rate'''
** required
** required
** entered by user
** entered by user
-
* Sale Amount
+
* '''Cost Amount'''
** required
** required
** not editable
** not editable
-
** calculated by system: Sale Quantity X Sale Rate
+
** calculated by system: Cost Quantity X Cost Rate
-
* Sale Curr
+
* '''Curr'''
-
** required  
+
** required
** entered by user
** entered by user
-
'''Section B4:'''
+
* '''M/I'''
-
* VAT
+
* '''CBV'''
-
** entered by user, options: Y/N
+
-
* P/L, USD
+
* '''CT#'''
-
** not editable
+
-
** calc by system: Sale Amount - Cost Amount
+
-
* Description
+
* '''Office'''
-
** required
+
-
** pre-filled by system (as defined in CC Admin)
+
-
** editable by user
+
-
'''Section C:'''
+
* '''Description'''
-
Displays totals for:
+
=== Use cases ===
-
* Cost Amount
+
-
* Sale Amount
+
-
* P/L, USD
+
-
===== Interface for 13xx codes =====
+
==== Main case ====
-
In this case interface is slightly different to accommodate entering container info - see [[#Automate entering container related charges into TOC]]
+
Create several lines. Click save
-
===== Updates to relevant fields on other tabs =====
+
==== Updates to relevant fields on other tabs ====
Any values that are used on Est Tab and updated on other tabs of CT Editor (such as gross weight) should be updated on Est Tab and relevant amounts automatically re-calculated.
Any values that are used on Est Tab and updated on other tabs of CT Editor (such as gross weight) should be updated on Est Tab and relevant amounts automatically re-calculated.
-
===== Multi editing =====
+
==== Multi editing ====
To change value for the same attribute (for example: Cost Curr) on multiple lines user can:
To change value for the same attribute (for example: Cost Curr) on multiple lines user can:
Line 179: Line 120:
System will update this attribute for lines selected.
System will update this attribute for lines selected.
-
===== Validation =====
+
==== Validation ====
* Each line should have info for:  
* Each line should have info for:  
Line 189: Line 130:
* this is for all MOTs
* this is for all MOTs
-
* ideal location is Est Tab
 
-
* use [[Combobox#v2]]
 
-
==== Automate entering container related charges into TOC ====
+
== SOWs ==
-
 
+
-
* New version of TOC should have automation for entering container related charges.
+
-
 
+
-
* System will pre-fill TOC with container related information:
+
-
** for every "FCL related charge code" (hardcoded to 13**) that user enters system would add automatically as many lines as there are size/type combinations for assigned containers currently in a shipment; it will pre-fill number of such combinations (non editable) and allow to enter rate per each size/type
+
-
** system would also add line for totals
+
-
 
+
-
* see [[#Figure 2]]
+
-
 
+
-
===== DC column =====
+
-
 
+
-
Sometimes we need to enter '''ONE''' line per 13** code.
+
-
 
+
-
To do that user have to check "DC" column. After it is checked system will change screen to offer only one line (as with non 13** codes).
+
-
 
+
-
===== Container updates =====
+
-
 
+
-
Provide user who deletes, adds containers to shipment a warning that these operations might affect content of Est Tab.
+
-
 
+
-
If user insists then system will let user to proceed but will update Est Tab accordingly.
+
-
 
+
-
=== SOW 2 TMS charges should populate Est tab automatically ===
+
-
 
+
-
'''mant''': 4062
+
-
 
+
-
'''spec:''' below
+
-
 
+
-
Every time we get XML with charges from Desc TMS we store them in DB. At the same time we should display them on Est Tab.
+
-
 
+
-
* post into Sales section
+
-
 
+
-
* what cc code it will populate:
+
-
** Freight: 1598 Domestic Trucking TMS
+
-
** Other: 1506
+
-
 
+
-
* if charge codes above do not exist system will not populate
+
-
 
+
-
* do we distribute charges across CTs in the load?
+
-
** yes, Based on CBV type = Gross Weight
+
-
 
+
-
* charges that come from TMS are editable in CT2 internal by operator
+
-
 
+
-
* Bill To: post Bill To that is set in E0 that is linked to TMS in the system
+
-
** where to find that link in the system: [[TMS#Bill To Party]]
+
-
 
+
-
* Description = associated with CC
+
-
 
+
-
* Qty = 1
+
-
 
+
-
* Rate = value from TMS
+
-
 
+
-
* Currency = main currency in the system (USD)
+
-
 
+
-
=== SOW 3 Automate entering container related charges into TOC ===
+
-
 
+
-
'''mantis''': 4145
+
-
 
+
-
'''spec''':
+
-
 
+
-
This was merged into SOW 1. See [[#Automate entering container related charges into TOC]].
+
-
 
+
-
=== SOW 4 Changes to Arrival Notices pdfs ===
+
-
 
+
-
'''mantis''':  4150
+
-
 
+
-
moved to: [[Arrival Notice#SOW 4 Changes to Arrival Notices pdfs]]
+
-
 
+
-
=== SOW 5 Sales Invoice v2 ===
+
-
 
+
-
'''mantis''':  4149
+
-
 
+
-
'''spec''':
+
-
 
+
-
moved to [[Sales_Invoice#SOW_5_Sales_Invoice_v2]]
+
-
 
+
-
 
+
-
=== SOW 6 Add Est Tab to CT Viewer ===
+
-
 
+
-
'''mantis''':  0004202
+
-
 
+
-
'''spec''':
+
-
 
+
-
When CT is closed we should see Est tab with data that is read only.
+
-
 
+
-
=== SOW 7  ===
+
-
 
+
-
==== Change in logic for population from TMS ====
+
-
 
+
-
'''mantis''': 4233
+
-
 
+
-
Changes:
+
-
 
+
-
* what cc code it will populate:
+
-
** Freight: 1598
+
-
** Other: 1597 (used to be 1506)
+
-
 
+
-
* fill in Vendor field
+
-
** map to TMS Carrier
+
-
 
+
-
* pre fill Cost side as well:
+
-
** Quantity, Rate, Currency
+
-
** identically as Sales side
+
-
 
+
-
=== SOW 8 Mid October Refactoring ===
+
-
 
+
-
mantis: 0004127
+
-
 
+
-
spec:
+
-
 
+
-
* Keep '''one''' table where costs and sales (estimated) can be entered
+
-
 
+
-
* 1) TOC for Sales and Purchases will be “copies” of “Actual Invoice” and “Purchase Invoices” TOC’s
+
-
Except for “bill to” and “vendor” that will be included at the line level
+
-
* 2) All other functionalities from Sales/Purchase (actual) will be maintained
+
=== SOW 1 Add Populate ETOC from selected CT ===
-
* 3) All “amounts” will be changed from a  xx  /  xx  format to a    single    xxx.xx  format
+
mantis: '''0004375'''
-
* 4) Bill to / Vendor Columns will be smaller -> All columns will be kept “as small as possible”,
+
spec: see below
-
“shipments” column will include 1 or 2 or 3 (number) but not the words “shipments”
+
-
* 5) I/M will be available twice on each line … 1x for sales and 1x for costs
+
'''Requirements''':
 +
* Ability to fill in ETOC quickly for CT#1 if it is similar to ETOC of existing known CT#2
 +
* Sales part only
-
* 6) The “bottom recap/P&L section” will be removed from the EPLTOC      AND    the line item level P&L column will also be removed.
+
'''Details''' (per Marc):
-
* 7) “UNIT” is for SALES ONLY -> Unit is primarily a “print on actual sales invoice” concern / function
+
Add button "Select ETOC from CT#" + textbox
 +
Once user enters CT# and clicks button system should populate data from ETOC from CT#2. See details below.
-
* 8) Each ESPLTOC is a “child” of the CT record in which it was created / edited / saved
+
* Populate Sale section only
 +
* Populate all columns except Q
 +
* Pre-fill Q as usual for current record
 +
* Populate only lines created by current user office
 +
* Only allow copy from same E0 and same MOT
 +
* In case of Containers: pull rates for cont size/type that match; if no mach then leave rate as 0.

Current revision as of 03:00, 21 November 2013


Contents

[edit] Info

[edit] Business Need

  • To enter estimated charges (on sales side)
  • Ops instructed to enter by Arrival date

[edit] Component Description

To enter charges user have to navigate to Est Tab.

User can add, remove, edit information in a table like format.

[edit] General controls

  • user have to save changes using "Save" button
  • user can add and delete lines using Add and Remove buttons

[edit] Table of Estimated Charge Codes

[edit] Sales section

Columns related to Estimated Sales.

  • CC#
    • combobox with list of all charge codes defined in the system
    • selected by user
    • required
  • DC - option to turn on/off the distribution by containers (for OCEAN CTs only)
    • checkbox
    • when checked Quantity/Rate/Amount will accomodate container entry
  • Bill To Party
  • Sale Quantity
    • required
    • pre-filled by system as defined in CC Admin > Quantity Field default to
  • Sale Rate
    • required
    • entered by user
  • Sale Amount
    • required
    • not editable
    • calculated by system: Sale Quantity X Sale Rate
  • Curr
    • required
    • entered by user
  • M/I
  • CBV
  • CT#
  • VAT

[edit] Cost section

Columns related to Estimated Cost.

  • Vendor
    • required
    • entered by user
    • combobox
  • Cost Quantity
    • required
    • pre-filled by system as defined in CC Admin > Quantity Field default to
  • Cost Rate
    • required
    • entered by user
  • Cost Amount
    • required
    • not editable
    • calculated by system: Cost Quantity X Cost Rate
  • Curr
    • required
    • entered by user
  • M/I
  • CBV
  • CT#
  • Office
  • Description

[edit] Use cases

[edit] Main case

Create several lines. Click save

[edit] Updates to relevant fields on other tabs

Any values that are used on Est Tab and updated on other tabs of CT Editor (such as gross weight) should be updated on Est Tab and relevant amounts automatically re-calculated.

[edit] Multi editing

To change value for the same attribute (for example: Cost Curr) on multiple lines user can:

  • select desired lines
  • change value on one line

System will update this attribute for lines selected.

[edit] Validation

  • Each line should have info for:
    • General + Sales Charges OR
    • General + Costs OR
    • General + Sales Charges + Costs
[edit] Misc
  • this is for all MOTs

[edit] SOWs

[edit] SOW 1 Add Populate ETOC from selected CT

mantis: 0004375

spec: see below

Requirements:

  • Ability to fill in ETOC quickly for CT#1 if it is similar to ETOC of existing known CT#2
  • Sales part only

Details (per Marc):

Add button "Select ETOC from CT#" + textbox Once user enters CT# and clicks button system should populate data from ETOC from CT#2. See details below.

  • Populate Sale section only
  • Populate all columns except Q
  • Pre-fill Q as usual for current record
  • Populate only lines created by current user office
  • Only allow copy from same E0 and same MOT
  • In case of Containers: pull rates for cont size/type that match; if no mach then leave rate as 0.
Retrieved from "https://wiki.jaguarfreight.com/Est_Tab"
Personal tools