Automated Estimated Delivery Dates (component)

From UG

Contents 1 General Info and Scope 1.1 Scope 2 Business Requirements 3 Notes from Systems Architect 4 Rapid Design 4.1 needed changes 4.2 full description 5 Detailed Design 5.1 Summary 5.2 User Interface 5.3 "Normal" Functionality (Use Cases) 5.4 "Abnormal" Functionality (Test Cases) 6 QA 7 Look and Feel 8 Figures 8.1 Figure 1: old form 8.2 Figure 2: new form 8.3 Figure 3: add/edit new form 9 Misc 9.1 Link to User Guide 9.2 Questions 9.3 Request For Comments (Suggestions and Ideas) 9.4 Known Non Critical Bugs 9.5 Implementation: Link To DB 9.6 Implementation: Link To Front End Code 9.7 Implementation: Link To Back End Code 10 History of Updates 10.1 Links to Archived / Old specs 10.2 Tweak: Add truck mode; replace 2 LCL with 1; improve speed; migrate to "Modal design" 10.2.1 Update General Info 10.2.2 Update Description 10.3 <Update type>:<Update Summary> 10.3.1 Update General Info 10.3.2 Update Description

General Info and Scope

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

Scope

This covers just this component.

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.

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.

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.

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

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

• This section is defined by Systems Analyst.
• It contains detailed technical design is written after #Business Requirements and #Technical Requirements are defined.

Summary

User Interface

"Normal" Functionality (Use Cases)

"Abnormal" Functionality (Test Cases)

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

QA

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

Look and Feel

• This section is to be written / defined by Graphic Designer and UI Designer.
• This includes:
  • final graphics
  • final layout
• Layout defined here should refine, provide more detials to "functional definitions" of UI as defined in #User Interface and Functionality section above

Figures

Figure 1: old form

Figure 2: new form

Figure 3: add/edit new form

Misc

Link to User Guide

Questions

Request For Comments (Suggestions and Ideas)

Known Non Critical Bugs

• Critical bugs must be posted into Mantis

Implementation: Link To DB

Implementation: Link To Front End Code

Implementation: Link To Back End Code

History of Updates

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

• 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

• mantis: <link> if applicable

• 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

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

Update Description

• Briefly explain what was done and list links to updated sections.