Automated Estimated Delivery Dates (component)

From UG

(Difference between revisions)
Jump to: navigation, search
(Created page with 'Category:OpsAdmin == General Info and Scope == * Classified As: misc * Parent Mantis: [http://mantis.jaguarfreight.com/mantis/view.php?id=1726 1726] * Prerequisites: ''…')
 
(10 intermediate revisions not shown)
Line 3: Line 3:
== General Info and Scope ==
== General Info and Scope ==
-
* Classified As: [[misc]]
+
* Classified As: [[component]]
* Parent Mantis: [http://mantis.jaguarfreight.com/mantis/view.php?id=1726 1726]
* Parent Mantis: [http://mantis.jaguarfreight.com/mantis/view.php?id=1726 1726]
* Prerequisites: ''any articles that must be read before to understand this?''
* Prerequisites: ''any articles that must be read before to understand this?''
=== Scope ===
=== Scope ===
-
* ''List what it covers and what it does not''
 
This covers just this component.
This covers just this component.
== Business Requirements ==
== Business Requirements ==
-
* ''This section is defined by [[Business Analyst]]''
+
 
-
* '' In this section this component/feature is defined from the business standpoint. All important points are listed. It could include some design details if business insists on specific design.''
+
The purpose of this feature is to estimate delivery date based on known:
 +
 
 +
* MOT (all LCL combined, Truck combined into one)
 +
* Client
 +
* Orgin Point, Country
 +
* Destination Point, Country
 +
* Transit Time in Days
 +
 
 +
Above record is entered into the system through Admin.
 +
 
 +
[[Gen Tab#Automated Estimated Delivery Date]] is displayed on Gen tab.
 +
 
 +
If appropriate record exists then system uses the following formula to calculate:
 +
 
 +
[[Gen Tab#Automated Estimated Delivery Date]] = [[Gen Tab#Notification Date]] + [[Transit Time in Days]]
 +
 
 +
If not this date is blank.
== Notes from Systems Architect ==
== Notes from Systems Architect ==
Line 22: Line 37:
* '' In some cases (component is non standard) we need to do ''preliminary'' not so detailed design before detailed final. And maybe even code it to create [[Prototype]]''
* '' In some cases (component is non standard) we need to do ''preliminary'' not so detailed design before detailed final. And maybe even code it to create [[Prototype]]''
* ''This section does not have to be too detailed or too formalized. We shall not spend too much time on Prototypes - they can change many times.''
* ''This section does not have to be too detailed or too formalized. We shall not spend too much time on Prototypes - they can change many times.''
 +
 +
==== needed changes ====
 +
* на экранной форме нужно добавить закладку для MOT = '''Trucking'''. See [[#Figure 2: | Figure 2: new form]]
 +
* на экранной форме нужно заменить две закладки для '''LCL AW''' и '''LCL MLB''' на одну закладку '''LCL'''. compare [[#Figure 1: | Figure 1: old form]] и [[#Figure 2: | Figure 2: new form]]
 +
* для перехода на модальный дизайн:
 +
** заменить набор кнопок "Delete Selected / Create New" ([[#Figure 1]]) на "Add,Edit,Remove" как на [[#Figure 2]]
 +
** использовать форму окна для создания и изменения даты Automated Estimated Delivery Date как на рис. [[#Figure 3 | Figure 2: add/edit new form]]
 +
 +
==== full description ====
 +
* Система позволяет автоматически рассчитывать предполагаемые даты доставки для всех типов шипментов (кроме Undefined):
 +
** Air
 +
** Ocean FCL
 +
** Ocean LCL
 +
** Trucking
 +
* Автоматический расчет предполагаемой даты доставки выполняется в шипменте на закладке GenTab
 +
** Расчетная дата отображается в поле GenTab.20.Automated Estimated Delivery Dates.
 +
* Для расчета предполагаемой даты доставки шипмента используется значение '''transit Time in Days''' из таблицы Automated Estimated Delivery Dates в разделе Admin
 +
** таблица разбита на пять одинаковых по форме частей, которые соответствуют Mode Of Transport (MOT) = {Air, Ocean FCL AW, Ocean FCL MLB, Ocean LCL, Trucking}.
 +
** каждая часть таблицы отображается на отдельной закладке. Фактически каждая закладка хранит данные для определённого значения MOT. Имена закладок: Air, FCL AW, FCL MLB, LCL, Truck.
 +
** на каждой из закладок в каждой строке таблицы хранится значение "transit Time in Days" для набора полей Клиент (Client), Точка Отправки (Orgin Point), Точка Доставки (Destination Point). это значение соответствует только MOT, указанному в имени закладки.
 +
** каждая строка таблицы содержит 4 столбца: имя клиента "Client"; страна отправки "Orgin Point, Country"; страна доставки "Destination Point, Country"; время транзита по маршруту "Origin Point - Destination Point", указанное в днях "transit Time in Days"
 +
** работа с таблицей происходит в модальном режиме:
 +
*** по нажатию одной из кнопок "Add, Edit, Remove" система выполняет соответствующие действия.
 +
*** для добавления/редактирования строки открывается отдельное окно с набором полей, которые соответствуют столбцам обрабатываемой строки.
 +
*** данные, введенные в этом окне, оттобразятся в таблице после их сохранения нажатием кнопки Save. При нажатии кнопки Cancel присходит отказ от изменений.
 +
*** перед удалением строки (после нажатия кнопки Remove) система предупреждает о выполнении операции сообщением "Are you sure you want to delete this ETD". Нажатие кнопки ОК подтвеждает удаление записи, нажатие кнопки Cancel означает отказ от удаления данной строки.
 +
* Для автоматического вычисления предполагаемой даты доставки в шипменте (CT) необходимо, чтобы MOT был установлен в значение, отличное от Undefined и были заполнены следующие поля шипмента:
 +
** GenTab.E0.Client
 +
** GenTab.11.Orgin Point
 +
** GenTab.12.Destination Point
 +
** GenTab.17.Notification Date
 +
* Если эти условия соблюдены и для заполненных полей шипмента найдено соответствие в таблице Automated Estimated Delivery Dates, предполагаемая дата доставки вычисляется по формуле:
 +
** Gen Tab#Automated Estimated Delivery Date = Gen Tab#Notification Date + Transit Time in Days
 +
* если какое-то из вышеуказанных условий не соблюдено, поле GenTab.20.Automated Estimated Delivery Date остается пустым.
== Detailed Design ==
== Detailed Design ==
Line 31: Line 80:
=== User Interface ===  
=== User Interface ===  
-
=== Functionality / Use Cases ===
+
=== "Normal" Functionality (Use Cases) ===
-
* '' This section you could spit into two. But often it is hard to do since often most of functionality is UI related''
+
-
=== Special Cases and Misc ===
+
=== "Abnormal" Functionality (Test Cases) ===
-
* '' If any exist''
+
* '' List unusual scenarios - things that users most of the time would not do but system must handle well ''
== QA ==
== QA ==
Line 41: Line 89:
''This section is to be written by [[QA Engineer]] or [[QA Manager]] or [[Systems Analyst]].
''This section is to be written by [[QA Engineer]] or [[QA Manager]] or [[Systems Analyst]].
-
=== Test Cases ===
 
-
* '' List unusual scenarios - things that user most of the time would not do but system must handle well ''
 
-
* '' Do not list [[Common Test Cases]] - link to them
 
== Look and Feel ==
== Look and Feel ==
Line 55: Line 100:
== Figures ==
== Figures ==
-
=== Figure 1:   ===
+
=== Figure 1: old form ===
-
+
[[File: AEDD_old.jpg]]
 +
=== Figure 2: new form ===
 +
[[File: AEDD_new_proto.jpg]]
 +
=== Figure 3: add/edit new form ===
 +
[[File: AEDD_add_edit_proto.jpg]]
 +
 
== Misc ==
== Misc ==
Line 76: Line 126:
=== Links to Archived / Old specs ===
=== Links to Archived / Old specs ===
 +
None.
 +
 +
 +
=== Tweak: Add truck mode; replace 2 LCL with 1; improve speed; migrate to "Modal design" ===
 +
==== Update General Info ====
 +
* mantis: http://mantis.jaguarfreight.com/mantis/view.php?id=1751
 +
 +
*    [[BR to be updated]]  //    [[Design to be updated]]  //  [[QA to be updated]]
 +
 +
==== Update Description ====
-
=== ..... <Update Summary> ..... ===
+
* Add truck mode - this is an additional tab
 +
* replace 2 LCL with 1 - transit Time in Days is defined ones for both LCL modes
 +
* improve speed
 +
* migrate to "Modal design" (for Add/Edit)
 +
=== <Update type>:<Update Summary> ===
==== Update General Info ====
==== Update General Info ====
* mantis: <link> ''if applicable''
* mantis: <link> ''if applicable''
-
* update type: [[Re-design]] / [[Tweak]] / Etc
 
-
* Spec updated?
 
-
** [[#Business Requirements]] - Y/N
 
-
** [[#Detailed Design]] - Y/N
 
-
** [[#QA]] - Y/N
 
-
* ''Ideally update all sections of spec (see above) right away. If you have no time to update spec now or multiple people have to be involved then define task here and come back to update later. In this case add links from here to [[:Category:Spec TBU]]. This would list spec as To Be Updated ([[TBU]]) in related category. See below.''
+
* If Y then remove this link from here --> [[BR to be updated]]
 +
*  If Y then remove this link from here --> [[Design to be updated]]
 +
*  If Y then remove this link from here --> [[QA to be updated]]
-
* If [[#Business Requirements]] (BR) section is not updated then add this wiki under [[:Category:BR TBU]]
+
* ''Update types: [[Re-design]] / [[Tweak]] / Etc ''
-
* If [[#Detailed Design]] (DD) section is not updated then add this wiki under [[:Category:DD TBU]]
+
* ''Ideally update all sections of spec (see above) right away. If you have no time to update spec now or multiple people have to be involved then define task here and come back to update later. In this case add links from here to "TBU wiki tag articles" - see above.
-
* If [[#QA]] (QA) section is not updated then add this wiki under [[:Category:QA TBU]]
+
==== Update Description ====
==== Update Description ====
* ''Briefly explain what was done and list links to updated sections.''
* ''Briefly explain what was done and list links to updated sections.''

Current revision as of 16:17, 9 February 2010


Contents

[edit] General Info and Scope

  • Classified As: component
  • Parent Mantis: 1726
  • Prerequisites: any articles that must be read before to understand this?

[edit] Scope

This covers just this component.

[edit] Business Requirements

The purpose of this feature is to estimate delivery date based on known:

  • MOT (all LCL combined, Truck combined into one)
  • Client
  • Orgin Point, Country
  • Destination Point, Country
  • Transit Time in Days

Above record is entered into the system through Admin.

Gen Tab#Automated Estimated Delivery Date is displayed on Gen tab.

If appropriate record exists then system uses the following formula to calculate:

Gen Tab#Automated Estimated Delivery Date = Gen Tab#Notification Date + Transit Time in Days

If not this date is blank.

[edit] Notes from Systems Architect

  • This section is defined by Systems Architect. It is written after #Business Requirements are defined.
  • The purpose of this section is to give direction to System Analysts who will write detailed specification.

[edit] Rapid Design

  • In some cases (component is non standard) we need to do preliminary not so detailed design before detailed final. And maybe even code it to create Prototype
  • This section does not have to be too detailed or too formalized. We shall not spend too much time on Prototypes - they can change many times.

[edit] needed changes

  • на экранной форме нужно добавить закладку для MOT = Trucking. See Figure 2: new form
  • на экранной форме нужно заменить две закладки для LCL AW и LCL MLB на одну закладку LCL. compare Figure 1: old form и Figure 2: new form
  • для перехода на модальный дизайн:
    • заменить набор кнопок "Delete Selected / Create New" (#Figure 1) на "Add,Edit,Remove" как на #Figure 2
    • использовать форму окна для создания и изменения даты Automated Estimated Delivery Date как на рис. Figure 2: add/edit new form

[edit] full description

  • Система позволяет автоматически рассчитывать предполагаемые даты доставки для всех типов шипментов (кроме Undefined):
    • Air
    • Ocean FCL
    • Ocean LCL
    • Trucking
  • Автоматический расчет предполагаемой даты доставки выполняется в шипменте на закладке GenTab
    • Расчетная дата отображается в поле GenTab.20.Automated Estimated Delivery Dates.
  • Для расчета предполагаемой даты доставки шипмента используется значение transit Time in Days из таблицы Automated Estimated Delivery Dates в разделе Admin
    • таблица разбита на пять одинаковых по форме частей, которые соответствуют Mode Of Transport (MOT) = {Air, Ocean FCL AW, Ocean FCL MLB, Ocean LCL, Trucking}.
    • каждая часть таблицы отображается на отдельной закладке. Фактически каждая закладка хранит данные для определённого значения MOT. Имена закладок: Air, FCL AW, FCL MLB, LCL, Truck.
    • на каждой из закладок в каждой строке таблицы хранится значение "transit Time in Days" для набора полей Клиент (Client), Точка Отправки (Orgin Point), Точка Доставки (Destination Point). это значение соответствует только MOT, указанному в имени закладки.
    • каждая строка таблицы содержит 4 столбца: имя клиента "Client"; страна отправки "Orgin Point, Country"; страна доставки "Destination Point, Country"; время транзита по маршруту "Origin Point - Destination Point", указанное в днях "transit Time in Days"
    • работа с таблицей происходит в модальном режиме:
      • по нажатию одной из кнопок "Add, Edit, Remove" система выполняет соответствующие действия.
      • для добавления/редактирования строки открывается отдельное окно с набором полей, которые соответствуют столбцам обрабатываемой строки.
      • данные, введенные в этом окне, оттобразятся в таблице после их сохранения нажатием кнопки Save. При нажатии кнопки Cancel присходит отказ от изменений.
      • перед удалением строки (после нажатия кнопки Remove) система предупреждает о выполнении операции сообщением "Are you sure you want to delete this ETD". Нажатие кнопки ОК подтвеждает удаление записи, нажатие кнопки Cancel означает отказ от удаления данной строки.
  • Для автоматического вычисления предполагаемой даты доставки в шипменте (CT) необходимо, чтобы MOT был установлен в значение, отличное от Undefined и были заполнены следующие поля шипмента:
    • GenTab.E0.Client
    • GenTab.11.Orgin Point
    • GenTab.12.Destination Point
    • GenTab.17.Notification Date
  • Если эти условия соблюдены и для заполненных полей шипмента найдено соответствие в таблице Automated Estimated Delivery Dates, предполагаемая дата доставки вычисляется по формуле:
    • Gen Tab#Automated Estimated Delivery Date = Gen Tab#Notification Date + Transit Time in Days
  • если какое-то из вышеуказанных условий не соблюдено, поле GenTab.20.Automated Estimated Delivery Date остается пустым.

[edit] Detailed Design

[edit] Summary

[edit] User Interface

[edit] "Normal" Functionality (Use Cases)

[edit] "Abnormal" Functionality (Test Cases)

  • List unusual scenarios - things that users most of the time would not do but system must handle well

[edit] QA

This section is to be written by QA Engineer or QA Manager or Systems Analyst.


[edit] Look and Feel


[edit] Figures

[edit] Figure 1: old form

File: AEDD_old.jpg

[edit] Figure 2: new form

File: AEDD_new_proto.jpg

[edit] Figure 3: add/edit new form

File: AEDD_add_edit_proto.jpg

[edit] Misc

[edit] Link to User Guide

[edit] Questions

[edit] Request For Comments (Suggestions and Ideas)

[edit] Known Non Critical Bugs

  • Critical bugs must be posted into Mantis

[edit] Implementation: Link To DB

[edit] Implementation: Link To Front End Code

[edit] Implementation: Link To Back End Code

[edit] History of Updates

[edit] Links to Archived / Old specs

None.


[edit] Tweak: Add truck mode; replace 2 LCL with 1; improve speed; migrate to "Modal design"

[edit] Update General Info

[edit] Update Description

  • Add truck mode - this is an additional tab
  • replace 2 LCL with 1 - transit Time in Days is defined ones for both LCL modes
  • improve speed
  • migrate to "Modal design" (for Add/Edit)

[edit] <Update type>:<Update Summary>

[edit] Update General Info

  • mantis: <link> if applicable
  • Update types: Re-design / Tweak / Etc
  • Ideally update all sections of spec (see above) right away. If you have no time to update spec now or multiple people have to be involved then define task here and come back to update later. In this case add links from here to "TBU wiki tag articles" - see above.

[edit] Update Description

  • Briefly explain what was done and list links to updated sections.
Retrieved from "https://wiki.jaguarfreight.com/Automated_Estimated_Delivery_Dates_(component)"
Personal tools