Editing KPI Business Requirements & Software Requirements Specification

[[Category:DRs and KPIs]]

= Mantis =
''<Mantis Number(s) & Link>'' 

= Project Overview =
== Business Objective(s) ==
Key Performance Indicators (KPIs) are valuable metrics that clients and Jaguar Freight Services (JFS) can utilize to improve their supply chain management operations. These metrics report on cost performance, cycle time performance, load utilization performance, etc.. Examples include cost per pound, cycle time between shipment creation to approval, etc.. There are an infinite number of possibilities for what one might consider a KPI. It is up to the client and/or JFS management team to utilize these KPIs to identify weak areas of their operations and to develop strategic corrective action plans to improve logistics performance. 

The objective of the CyberTrax2 KPI project is to provide an easy to use, intuitive, interactive interface for both internal JFS management and external client users to view and report on KPIs. It is absolutely imperative that the accuracy and mechanics of KPIs are well understood by all.

== High Level Project Deliverables ==
* Batch Scheduling System
* Download to Excel (datadump)
* KPI Dashboard
* KPI Admin (user administration)
* KPI Editor (customizable Dashboard editor)

== Project Stakeholders & Roles ==
* Simon Kaye - CEO - Project Sponsor
* Marc Selter - VP - Product Manager
* Alex Dobrovolsky - Director of Technology - Solutions Architect
* Montira Renfrew - CT2 Systems Analyst 
* Mihail Tymoshenko - CT2 Software Developer (Elcosol)
* Denise Guastella - CT2 Support Manager
* Kostiantyn Ushakov - CEO/CTO Elcosol
* Perry Lee - CT2 Project Manager

== Project Scope ==
The below items are in-scope for this KPI project: 
* Design and implement a scalable KPI module that will satisfy all future KPI requirements for at least the next 3 years. 
** Design must take into consideration future KPIs requirements (Mobile, International, External Interfaces [Google Maps], etc..)
** Fill in existing gaps (functional & non-functional) in existing cost-based KPI module. 
** Design and Implement a KPI module for both Internal CT2 and Client CT2 applications. 
** Implement below KPIs
*** Cost-Based KPIs (gaps only)
*** Date-based KPIs 
*** Utilization/Optimization-based KPIs
*** International KPIs
**** Ocean (FCL & LCL)
**** Air
** Ability to overlap & report on multiple KPIs. 
* Design and implement an entitlements management module to administer KPI-based entitlements. This specific KPI entitlements management module will need to fall in line with I-Portal entitlements management framework.  

The below items are out-of-scope for this KPI project: 
* Address performance issues with any CT2 module outside of KPI. 
* Merge Internal CT2 and Client CT2 applications.
* Mobile KPI

=== Project Dependencies ===
* I-Portal Entitlements Management Framework must be designed prior to designing KPI Entitlement Management module. 

=== High-Level Timelines ===
This project will be delivered in phases. 

<table border="1">

<tr>
<th colspan="2">Phase</th>
<th>Start</th>
<th>Complete</th>
</tr>

<tr>
<td rowspan="5"> Phase I - Core KPI Framework / Address gaps in Cost-Based KPIs</td> 
<td>Requirements</td>
<td></td>
<td></td>
</tr>

<tr>
<td>Design</td>
<td></td>
<td></td>
</tr>

<tr>
<td>Construction</td>
<td></td>
<td></td>
</tr>

<tr>
<td>Verification</td>
<td></td>
<td></td>
</tr>

<tr>
<td>Maintenance</td>
<td></td>
<td></td>
</tr>

<tr>
<td rowspan="5"> Phase II - Date-Based KPIs </td> 
<td>Requirements</td>
<td></td>
<td></td>
</tr>

<tr>
<td>Design</td>
<td></td>
<td></td>
</tr>

<tr>
<td>Construction</td>
<td></td>
<td></td>
</tr>

<tr>
<td>Verification</td>
<td></td>
<td></td>
</tr>

<tr>
<td>Maintenance</td>
<td></td>
<td></td>
</tr>

<tr>
<td rowspan="5"> Phase III - Utilization/Optimization KPIs </td> 
<td>Requirements</td>
<td></td>
<td></td>
</tr>

<tr>
<td>Design</td>
<td></td>
<td></td>
</tr>

<tr>
<td>Construction</td>
<td></td>
<td></td>
</tr>

<tr>
<td>Verification</td>
<td></td>
<td></td>
</tr>

<tr>
<td>Maintenance</td>
<td></td>
<td></td>
</tr>

<tr>
<td rowspan="5"> Phase IV - International KPIs </td> 
<td>Requirements</td>
<td></td>
<td></td>
</tr>

<tr>
<td>Design</td>
<td></td>
<td></td>
</tr>

<tr>
<td>Construction</td>
<td></td>
<td></td>
</tr>

<tr>
<td>Verification</td>
<td></td>
<td></td>
</tr>

<tr>
<td>Maintenance</td>
<td></td>
<td></td>
</tr>

</table>

== Risks ==
''<Identify internal and external risks to the project: schedule, resources, technical, business, cost, market conditions, external vendors/partners, etc..>''

= Assumptions / Constraints =
Assumptions
* The KPI module will not require significant redeisgn within the next 3 years.
* Critical resources (0.5 FTE Analyst and 1 FTE Developer) will be fully allocated to this project for its entire duration. 
* All major requirements would have been identified during the requirements/design phase of this project. Any requirements identified post design-phase will have minimal impact on project schedule and scope.
* Project Team will document & provide walk-through of entire KPI design prior to construction. All project documents will be signed off prior to construction. 
* QA resource will be fully allocated to this project during verification phase(s). 
* Business unit will have adequate resources to perform UAT during verification phase(s). 
* Current CT2 Chart & Graph library (JFreeChart) is sufficient to satisfy existing & future KPI requirements. 
* CT2 will be able to satisfy all KPI requirements with existing development framework & libraries (ZK framework).
* All non-working periods (personal vacations, holidays, etc..) will be baked into project plan. 
* All resources will have acquire adequate knowledge of business & technology to fulfill their roles & responsibilities with minimal training. 

Constraints
* KPI module must not negatively impact the current performance of CyberTrax2. 
* KPI module must function under existing production server hardware. 
* All in-scope KPIs must be delivered and fully functional by end of year 2012. 
* Entire KPI project must be delivered with existing resources.

= Business Requirements =
''<List each business requirement under a separate heading. Also include process flows (UML, Sequence Diagrams, Swimlane, Flow chart, etc..) as applicable>'' 

''Idea: Provide tactical date-based KPI to meet Product management's immediate requirement for a demo-ready prototype.''

== BR1 [Core KPI Foundation] ==
=== BR1.1 [Overlapping KPIs] ===
* Need object reports/KPIs/Widgets to be available for Internal and External users
* Need special page (dashboard) with various panels
* Need flexible admin to manage dashboard on the System, Manager, and User levels
* Need ability for user to manage/organize their own widgets, panels, reports on their dashboard
* Need ability for user to manage multiple dashboards
* Need ability to manage specific information on chart and download to excel
* Need ability to define and add list of other KPI's which can be overlapped with current (depends from key entity)
* Need common filters for all KPIs
* Need Client Visibility rules for external users roles
* Need persistence (system must remember last state of dashboard for individual user to reproduce at the next login) 


==== GLOSSARY ====
'''Dashboard''' - it is a space between Header/Main Menu and Footer on a CT 2 Home page(refer to both Client and Internal Applications - slowly merging to one application). It contains various '''Panels '''("widgets") with valuable information such as "Weather", "RSS News feeds", "Cost and Value KPIs", "Reports Dashboard Panel", "Truck Dom Stats Dashboard Report", ...etc.
* Dashboard framework provides displaying of specific widgets on '''Dashboard area''' (Dashboard) of CT 2 Home Page only.
:* Dashboard area contains specific '''dashboard tabs''' (#Multiple dashboards) with sets of dashboard panels.
:** Each '''dashboard panel''' reflects specific widget with valuable information.

[[File:CT2 home layout.JPG]]

[[File:Multiple dashbords based on tabs.JPG]]

[[File:Dashboard-Area.GIF]]



'''Widgets''' - it is an element of a graphical user interface that displays an information arrangement and provides standardized data manipulation.
* Widgets in CT2 can be divided on following groups:
:* '''Informer''' - Actual information from external sources. ''Examples: RSS News Feed, World Financial Markets,... etc.''
:* '''Dashboard Reports''' - Summarized information calculated from CT2 DB. ''Examples: Truck Dom Stats, Scheduled Reports, Estimated GM,...etc.''


'''Panels''' - it is widget


'''Chart''' - it is a graphical representation of data, in which "the data is represented by symbols, such as bars in a bar chart, lines in a line chart, or slices in a pie chart". Charts are often used to ease understanding of large quantities of data and the relationships between parts of the data. Charts can usually be read more quickly than the raw data that they are produced from. Certain types of charts are more useful for presenting a given data set than others. For example, data that presents percentages in different groups are often displayed in a pie chart, but may be more easily understood when presented in a horizontal bar chart.On the other hand, data that represents numbers that change over a period of time might be best shown as a line chart.
Reference: "Cary Jensen, Loy Anderson (1992). Harvard graphics 3. http://en.wikipedia.org/wiki/Chart" [Accessed 04/11/2012]


'''DR KPI Level 1''' - it is a table of averaged KPI value (one or more) per specified time frame. 
* Time frame for KPI calculating set on KPI settings tab in My Profile section. 


'''DR KPI Level 2''' - it is a chart of one KPI that reflects averaged value of KPI's amount in relationship to certain parameter(s). 
* Level 2 consists of 3 sections: Parameters, Chart, Filters 


'''DR KPI Level 3''' - it is a spreadsheet of averaged KPI value (one or more) per specified time frame and specified output result. 
* Level 3 consists of Download to Excel functionality



==== ADMIN ====
* Create special page with various panels with ability to add additional page(s) to organize the layout of panels (Dashboard)
:* Provide ability to create additional page(s)
:* Provide ability to name/edit/remove each dashboard page
:* Provide ability to group panels to each dashboard (organize panels for each dashboard available from the default panels setting on the dashboard)
:* Provide ability to move the order of each dashboard tab
:* Provide ability to drag/drop panel(s) to each dashboard

* Create admin level to manage dashboard and panels across CT2 Home for both Internal and External users.
:* Consist of 3 levels of admin functionality:
:** ''System Level''
:** ''Admin Level''
:** ''User Level''

===== System Level=====
What: System level activates reports for whole system for user roles

* Need flexible admin to manage dashboard from System level to configure default setting for External and Internal users on CT2 Home
:* To keep list of all existing object reports and future object reports(widgets, reports, KPIs..etc) to be available for both External and Internal users
:* To be able to activate object reports in the system
:* To set default parameters of object reports
:* To group and categorize object reports to:
:** External Widgets - such as RSS News Feeds, Word Financial Markets, Quote of the Day, Testimonials, Weather...etc
:** Internal Reports - such as Truck Dom Stats, New Pending Address, QB Dashboard panel, Estimated Gross Margin panel, Profit sharing Panel,...etc
:** KPIs - such as Cost per pound, Cost per kilogram, ...etc
:** Scheduled Reports - such as daily report, in-transit report, ...etc


[[File:SystemLevel.JPG]]

[[File:DR Config SystemLevel.gif ]]

===== Admin Level=====
What: Admin Level gives permissions to current user to use reports selected from list

* Need flexible admin to manage dashboard from Admin level to configure user profile
:* To manage activated/inactivated panels 
:* To show list of all activated panels for External and Internal users
:* To activate panel(s) for certain user (user role)

[[File:AdminLevel.JPG]]

[[File:DR Config AdminLevel.gif]]

===== User Level =====
What: User Level provides user's abilities for managing panels and assigning reports to panels

* Need flexible user admin level "My Profile" for personal setting
:* To allow user to manage their own custom setting to activate/deactivate each panel and layout for panels on dashboard(s)
:** Solution for current state
:*** Client and Internal applications are separated. Internal Application does not have "My Profile". This functionality should be added on the Internal application as same as Client application. 
:*** "My Profile" should be built consistent way in order to reuse once two applications are merging
:** Solution for future state
:*** Merging Internal application to Client application to be only one application. This is related to I-portal. It is a dependency project.  
:* To remember user last setting state of panel(s) on dashboard(s) for each individual user
:* To use available functionality to custom organize panels and dashboards
:** Ability to manage and create any number of additional dashboard tabs and name/edit/remove them arbitrary
:*** See functionality and mock up 1 for [[#Adding dashboard tab]]
:*** See functionality and mock up 2 for [[#Naming and editing tab's name]]
:*** See functionality and mock up 3 for [[#Removing tab]] (reminder note: Validation/constraint and action should be listed)
:** Ability to assign any available panel(s) to any specific dashboard tab
:** Ability to activate/deactivate panels from the available list of panels to display it on dashboard and assign selected panel to specific tabe of dashboard where to be displayed
:** Ability to set custom parameters for value display on each panel
:** NOTE: Default setting - all panels on "Main Dashboard" tab.

[[File:UserLevel.gif]]

File:MyProfileADD.JPG

==== KPIs ====
'''Common Requirements for adding new KPI'''

To simplify further process of adding new KPI in CyberTrax we suggest use unified procedure of defining KPI.<br>

* STEP 1. MO requests a new KPI and provides information for analysis.
* STEP 2. BA prepares information for development as list of '''key''' parameters:
:*'''Key entity'''. Base of KPI or that for which the KPI is calculated.
::* ''Example:'' shipment ''(for CT-based KPI)'', load ''(for Load-based KPI)'', user ''(for User-based KPI)'', trucker ''(for Trucker-based KPI)''.
:*'''KPI function'''. Formula to calculate KPI. Result is always a number (integer or real).
::* Should be shown on '''Axis Y''' in its own measure unit.
::* ''Example:'' cost per pound/lane, created to approved/rejected/delivered.
:*'''KPI measure unit'''. Name of units in which the KPI is to be measured.
::* ''Example:'' USD (Cost and value KPIs), Day (Date KPIs).
:*'''Key Date rule'''. Points or expression for key events of KPI (created, approved, delivered etc).
::* Mostly depends from KPI family (cost, date) or KPI base (key entity).
::* ''Example:'' Created on Date, Approved Date, Actual/Estimated Delivery Date.
:*'''"Group By" methods'''. List of categories which can be used for grouping of KPI on Chart.
::* Will be shown on '''Axis X'''.
::* Each KPI has its own set of '''group by''' (default + specific).
::* Should correspond with the default settings (ideally be the same).
::* ''Example:'' days, weeks, months etc; carriers, users etc.
:*'''Filters'''.
::* Set of possible rules to select data slice by some value.
:::* Default set of filters.
:::* Specific filters for KPI family or one KPI.
:* '''Chart types'''.
::* ''Example:'' line, bar, pie. Note: for Group By = Carriers makes no sense to use linear chart.
:* '''XLS output fields'''.
::* Subset of values from KPI base object to output in spreadsheet (define default columns), their order of sequence, mapping and formatting.
::* ''Example:'' days, weeks, months etc; carriers, users etc.
:* '''Default settings'''.
::* '''''Time Frame'''''. Range of dates per which is calculated KPI value for Level 1. Also it used for visualization of KPI at first time opening of Level 2.
::* '''''Group By'''''. It defines method the grouping of subset of values of selected KPI per Time Frame on Chart (Level 2).
::* NOTE: Defaults should contain only appropriate values for certain KPI.
*STEP 3. Developer implements solution that suggested the BA with using prepared key information.

==== PANEL ====
Client visibility rule


 
Client Visibility Rules

Client Visibility Rules affect displaying of DR results in Client Application.

==== CHART ====
* To display value in different type of chart such as line, bar, pie, column, XY scatter, area chart.
* To display value of many KPIs on one chart to show the comparison for analysis (All value points in one graph)
* To use mouse over value on the chart

==== BR1.2 [Performance] ====
* Speed 
:* To display chart (from KPI value link, filter changing, etc)
:* To display value on the chart
:* To Download to excel for any report value 
:** IE. Problem: Performance for displaying yearly data value  

==== BR1.3 [Scalability] ====

=== BR2 [Cost-based KPIs] ===
* To be able to measure:
:* Cost Per Pound
:* Cost Per Kilogram
:* Cost Per Load
:* Cost Per Item/unit
:* Cost Per SKU
...
==== Logic ====
* Cost Per Pound
:* value from XML DocLoadPlan (TMS), Total Cost and Total Weight parameters what to be used for calculation of Cost per Pound
:*

=== BR3 [Date-based KPIs] ===

Measuring KPI date based pairing from date below:
* Shipment Created on Date
* Shipment Approved on Date
* Shipment Mode assigned on Date
* Shipment Picked up on Date
* Shipment Departure on Date
* Shipment Arrival on Date
* Shipment Custom Clearance on Date
* Shipment Delivery on Date

==== Define KPI ====
Core of '''date based''' KPI is number of days from the shipment '''X''' date to the shipment '''Y''' date
* It is a number of days from the two dates:
:* 1) '''Created To Approved on Date''' = Approved on Date - Created on Date
:** Number of days since the date of creation the shipment until the date of its approved
:* 2) '''Created To Mode Assigned on Date''' = Mode Assigned on Date - Created on Date
:** Number of days since the date of creation the shipment until the date of its mode Assigned
:* 3) '''Created To Picked up on Date''' = Picked up on Date - Created on Date
:** Number of days since the date of creation the shipment until the date of its picked up
:* 4) '''Created To Departure on Date''' = Departure on Date - Created on Date
:** Number of days since the date of creation the shipment until the date of its departure
:* 5) '''Created To Arrival on Date''' = Arrival on Date - Created on Date
:** Number of days since the date of creation the shipment until the date of its arrival
:* 6) '''Created To Custom Clearance on Date''' = Custom Clearance on Date - Created on Date
:** Number of days since the date of creation the shipment until the date of its custom clearance
:* 7) '''Created To Delivery on Date''' = Deliver on Date - Created on Date
:** Number of days since the date of creation the shipment until the date of its delivery
:* 8) '''Approved To Mode Assigned on Date''' = Mode Asssigned on Date - Approved on Date
:** Number of days since the date of approved the shipment until the date of its mode Assigned
:* 9) '''Approved To Picked up on Date''' = Picked up on Date - Approved on Date
:** Number of days since the date of approved the shipment until the date of its picked up
:* 10) '''Approved To Departure on Date''' = Departure on date - Approved on Date
:** Number of days since the date of approved the shipment until the date of its departure
:* 11) '''Approved To Arrival on Date''' = Arrival on Date - Approved on Date
:** Number of days since the date of approved the shipment until the date of its arrival
:* 12) '''Approved To Custom Clearance on Date''' = Custom Clearance on Date - Approved on Date
:** Number of days since the date of approved the shipment until the date of its custom clearance
:* 13) '''Approved To Delivery on Date''' = Delivery on Date - Approved on Date
:** Number of days since the date of approved the shipment until the date of its delivery
:* 14) '''Mode Assigned To Picked up on Date''' = Picked up on Date - Mode Assigned on Date
:** Number of days since the date of mode assigned the shipment until the date of its picked up
:* 15) '''Mode Assigned To Departure on Date''' = Departure on Date - Mode Assigned on Date
:** Number of days since the date of mode assigned the shipment until the date of its departure
:* 16) '''Mode Assigned To Arrival on Date''' = Arrival on Date - Mode Assigned on Date
:** Number of days since the date of mode assigned the shipment until the date of its arrival
:* 17) '''Mode Assigned To Custom Clearance on Date''' = Custom Clearance on Date - Mode Assigned on Date
:** Number of days since the date of mode assigned the shipment until the date of its custom clearance
:* 18) '''Mode Assigned To Delivery on Date''' = Delivery on Date - Mode Assigned on Date
:** Number of days since the date of mode assigned the shipment until the date of its delivery
:* 19) '''Picked up To Departure on Date''' = Departure on Date - Picked up on Date
:** Number of days since the date of picked up the shipment until the date of its departure
:* 20) '''Picked up To Arrival on Date''' = Arrival on Date - Picked up on Date
:** Number of days since the date of picked up the shipment until the date of its arrival
:* 21) '''Picked up To Custom Clearance on Date''' = Custom Clearance on Date - Picked up on Date
:** Number of days since the date of picked up the shipment until the date of its Custom Clearance
:* 22) '''Picked up To Delivery on Date''' = Deliver on Date - Picked up on Date
:** Number of days since the date of picked up the shipment until the date of its delivery
:* 23) '''Departure To Arrival on Date''' = Arrival on Date - Departure on Date
:** Number of days since the date of departure the shipment until the date of its arrival
:* 24) '''Departure To Custom Clearance on Date''' = Custom Clearance on Date - Departure on Date
:** Number of days since the date of departure the shipment until the date of its Custom Clearance
:* 25) '''Departure To Delivery on Date''' = Delivery on Date - Departure on Date
:** Number of days since the date of departure the shipment until the date of its delivery
:* 26) '''Arrival To Custom Clearance on Date''' = Custom Clearance on Date - Arrival on Date
:** Number of days since the date of arrival the shipment until the date of its Custom Clearance
:* 27) '''Arrival To Delivery on Date''' = Deliver on Date - Arrival on Date
:** Number of days since the date of arrival the shipment until the date of its delivery
:* 29) '''Custom Clearance To Delivery on Date''' = Delivery on Date - Custom Clearance on Date
:** Number of days since the date of custom clearance the shipment until the date of its delivery

==== Define key parameters ====
* '''KPI entity''' is a shipment.
* '''KPI function''' is difference in days between date of arrival of shipment and date of its creating in CT2.
* '''KPI measure unit''' is a day.
* '''Key Date rule'''. Key events based on following dates: 
:* Shipment Created on Date
:** Mapping: [[#CT_bo#Created_On_Date]] 
:* Shipment Approved on Date
:** Mapping: [[#CT_bo#Approved_On]]
:* Shipment Mode assigned on Date
:** Mapping: [[#Mode assigned_On]] THIS FIELD IS NOT EXIST>>>need to be added.
:* Shipment Picked up on Date
:** Mapping: [[#CT_bo#Actual_Pick_Up_Date]] col
:* Shipment Departure on Date
:** Mapping: [[#CT_bo#Airport_Of_Departure_Actual_Date]]
:* Shipment Arrival on Date
:** Mapping:
:* Shipment Custom Clearance on Date
:** Mapping:
:* Shipment Delivery on Date
:** Mapping: [[#CT_bo#Actual_Delivery_Date]] 

* For example: '''Created To Delivered''' KPI
** Rule: Report should handle CTs with Delivery Date within Time Frame (see below) and calculate KPI function for them. 
* '''Group By''' methods 
:* Standard methods: all Time (days, weeks, months, quarters, years); carriers, consignees, shippers.
:* Specific methods: planners. 
* '''Filters''' 
:* Standard filters: PO contains, SKU contains, Approved Date, Pick Up Date, Routed Date, Delivery Date, Carrier.
:* Specific filters: Planner. 
* ''' Chart types''' 
:* linear chart for every time grouping.
:* bar chart for grouping by carriers, planners etc. 
* '''Output fields'''
:* CT#.
:* Load #.
:* Created to Delivered (KPI column calculated as by formula Actual Delivery Date - Created On Date).
:* Created On Date.
:* Actual Delivery Date.
:* Shipper.
:* Consignee.
:* Carrier.
:* Pick Up Location.
:* Delivery Location.
:* Planner.        

NOTE: need to define and add to list other KPI's which can be overlapped with current (depends from key entity).

* Default settings (in My Profile section). 
* Time Frame: to be able select one from previous day/week/month/quarter/year.
* Group By: to be able select one from list included standard and specific "Group By" methods.

==== Implementation parts ====
* Use Client Visibility Rules when showing KPI info for external user(s)
* ........................Internal user(s)
* Settings 
:* Default: Values of KPI parameters should be set up in '''My Profile''' section
:* Date KPI panel setting should be added
:* Need ability to set up default values for parameters: 
:** "Time Frame"
:** "Group By" 

* '''Level 1''' 
:* '''Initial KPI displaying.'''
:** A table with 4 columns: 
:*** Name of KPI
:*** Time Frame range
:*** KPI value (+ KPI measure, maybe in round brackets)
:*** Change (KPI changes from past Time Frame)
:*** Headers: Name, Time Frame, KPI, Change 
:** Created to Delivered KPI on Level 1 (as well as Change) is average value for all shipments delivered per selected Time Frame: 
:*** 1) calculate difference '''Delivered-Created''' for every shipment 
:*** 2) get all days as amount of calculated differences 
:*** 3) divide obtained sum by number of handled shipments 

* '''Level 2''' 

:* '''Chart displaying'''
:** First time opened chart should be look in correspondence with default settings: 
:*** ''Group By'' and ''Time Period'' sections should be set in values specified in My Profile
:*** Chart type should be suitable for ''Group by'' value
:*** Filter Panel should be minimized and all filters are empty 
:**** except Delivery Date filter displayed start ("from") and end ("to") dates of Time Frame range 
:** Selecting of new "Group By" or "Time Period" values refreshes the chart without additional confirm
:** Changes on Filters Panel will update the chart after pressing of "Generate Result" 
:*** Delivery Date filter after manual update should used instead "Time Period" for chart displaying 

* '''Level 3''' 

:* '''preadsheet displaying'''
:** 1) Click on "Download to Excel" button and get file
:** OR
:** 2) Activate by clicking on or chart (when it is bar type), define output fields, click on the button

==== Logic ====

=== BR4 [Utilization / Optimization KPIs] ===

=== BR5 [International KPIs] ===

=== Business Process Flow 1... ===

=== Business Process Flow 2... ===

=== Business Process Flow 3... ===

== Functional/Non-Functional Requirements ==
''<Identify all functional and non-functional requirements. Maintain standard headings. If a specific requirement is not required, note as Not Applicable. Each functional requirement must trace back to a specific business requirement.>'' 

=== CyberTrax2 Internal Application ===
''<Identify all functional requirements for CT2 Internal Application>''
==== User Interface Requirements ====
==== Reporting Requirements ====
==== User Access / Security Requirements ====
==== Logging Requirements ====
==== Group / Master Requirements ====
==== Filtering Requirements ====
==== Archiving Requirements ====

=== CyberTrax2 Client Application ===
''<Identify all functional requirements for CT2 Client Application>''
==== User Interface Requirements ====
[[File:KPI Dashboard WireFrame Level1 v1.jpg]]

[[File:KPI Admin WireFrame Level1 v1.jpg]]

==== Reporting Requirements ====
==== User Access / Security Requirements ====
System Admin should be implemented. See [[#System_Level]]

==== Logging Requirements ====
Actions on System level and Admin level should be recorded in System Log.

==== Group / Master Requirements ====
==== Filtering Requirements ====
==== Archiving Requirements ====

==== Persistence ====
System must remember last state (location, state [open/closed], settings) of Dashboard for individual user to reproduce it at the next login.

=== Non-Functional Requirements ===
''<Identify all non-functional requirements for both CT2 Client Application and CT2 Internal Application>''
==== Performance Requirements ====
* Speed for loading chart
* Speed for loading overlapping multiple KPIs
* Speed for download to excel

==== Capacity Requirements ====
==== Support / Maintenance Requirements ====
===== User Guides =====
===== Training =====
===== Log(s) Accessibility =====
==== Testing Requirements ====
==== Security Requirements ====

== Technical Design & Solution ==
=== Mock ups ===
''<Include mock-ups of UI changes, report changes, etc..>''
==== Adding dashboard tab ====


==== Naming and editing tab's name ====


==== Removing tab ====

=== Technology Stack & Architecture ===
''<Include changes to existing Technology Stack & Architecture - new libraries, updated library versions, new software/hardware, new interfaces, etc..>''
=== Technical Diagrams ===
''(Flow Chart, Sequence, UML, Systems Architecture, Technical Architecture, Data Architecture, etc..)''

''<Include architecture diagrams and flow charts>''

[[File:KPI Batch Sequence v1.jpg]]

=== Web / Application (New/Modified classes, methods, etc..) ===
''<List new or modified classes and methods>''
=== Database (DDL changes - new/modified tables, indexes, stored procedures, etc..) ===
''<Summarize database changes>''
=== Configuration (Config File changes)===
''<Summarize config changes>''
=== Logging (Log File changes)===
''<Summarize Log File changes and locations>''
=== External Interfaces (EDI Message(s), external vendors) ===
''<Identify any new external interfaces. Include sample request and reply along with field definitions. Include Source/Target server(s)/webservice(s) and functional accounts. If this is a modification of an existing EDI message, include samples of current message(s) and new message(s)> ''

== SOW 1 ==
Mantis: [http://ct.jaguarfreight.com/mantis/view.php?id=3545 3545]

=== Business Requirements ===
* Proof of concept for batching data to improve performance
* Deliver first KPI panels, overlap multiple KPIs chart, interaction result based on filter(s), and download to excel ability
* Build KPI Dashboard first phase to be considered to future phases for flexibility
* Apply client visibility rules

=== Overlapping KPIs ===
* Create Batch Scheduling System to improve performance of KPIs
:* Create Background Process
:* Create Config File
:* Write logic to calculate KPI(s)
:** Create and Define Tables
:** Create and Define Classes
:* Write script to grab info to placeholder
* Batching calculation - to make performance better for the first batch then trigger any incremental every time there is a change

* '''DR KPI Level 1'''
:* '''Panels, Charts, Gauges and Filters''' display on the same level on the dashboard
:** '''Panel columns''' consist of:
:*** '''Heading of the top of panel''' contains category KPI report name such as Cost Based KPI, Date Based KPI
:*** '''KPI''' consists of a list of '''Name of object KPI report''' sush as Cost per item, Cost per pound under Cost based KPI panel, Created to Approved, Created to Delivery under Date based KPI panel
:*** '''Time frame for ATD''' is the name of selected time frame for ATD displays in column heading (dynamic per specified time frame selected) such as ''previous week, previous month, previous quarter, previous year'' and display value.
:**** Value: average value for specific time frame
:*** '''Changes percentage value''' contains percentage change of value per specified time frame compared to the same previous period
:**** Label: Change
:**** Formula: ''((data)/(previous data) - 1) * 100%''
:***** ''data'': data from time period defined in profile
:***** ''previous data'': data from previous same period (default is defined in user profile)
:*** '''Year to Date value''' contains average year to date value from year to date (previous week)
:**** Label: Year to Date
:*** '''Calculated value''' for specified time frame
:**** User can select time frame from provided list of values
:** '''Panel row''' consists of:
:*** Object report name , value 1, value 2, value 3 per row
:*** Total (x) is sum of Total cost Only (This is for cost based only)
:**** This shows total X per selected time frame and percentage change of total X compared to the same previous period
:**** Value: sum of all cost for specific time frame
:**** Change formula: ''((sum of values from period time frame)/(sum of values from previous period time frame) - 1) * 100%'' 
:*** See mock up below:


[[File:Panel1.JPG]]

NOTE: Each panel can consist of many KPIs. It is upon KPI(s) that users wish to see from their own visibility info.


:** '''Chart display''' allows overlap multiple KPIs charts into one chart display for data comparison with different criteria
:*** If Time based group by is selected, then displays overlap multiple KPIs in a chart
:*** If Non-time based group by is selected, then displays separated charts of each class of KPIs and allows overlapping multiple KPIs inside of the KPI class/catagory in a chart
:*** Axis Y of chart (vertical) is always the KPI value based such as Cost per pound, Cost per Item, etc 
:**** This could be dual Axis chart
:*** Axis X of chart (horizontal) can reflect time frame for ATD for group by data
:*** Define Scale
:*** Label for parameter from filters selected
:*** Define type of chart: Bar, Line, Scatter plot, etc
:**** 
:*** Download to Excel button
:**** Displays output list select option

[[File:Chart1.JPG]]


:** '''Gauges''' consists of:
:*** ????
:*** ????
:** '''Filters''' consists of two sections:
:*** '''Top section''': select parameters to display value
:****  Group by: 
:***** Carriers - if this is selected, shows result for previous average time frame
:***** Shippers - if this is selected, shows result for previous average time frame
:***** Consignees - if this is selected, shows result for previous average time frame
:***** Time - if time is selected, time frame for ATD criteria below will be applied
:**** Mode of Transportation:
:**** Show Result:
:***** Currency // this is currency for cost based only (show when cost based KPI is selected) - this should be able to set from Editor as well(TBD)
:**** Time Frame for ATD:
:***** '''Weekly'''   // if non-time filter selected, shows point of average data for previous week. If time filter is selected, shows point of value for weekly result for 12 weeks previously
:****** Data point of value starts every Monday (if current week is Week 15, then shows: Week 3, Week 4 Week 5, Week 6, Week 7, Week 8, Week 9, Week 10, Week 11, Week 12, Week 13, Week 14)
:***** '''Monthly'''  // if non-time filter selected, shows point of average data for previous month. If time filter is selected, shows point of value for monthly result for 12 months far back for current year and previous year comparison
:****** Blue line - if this month is April, shows Mar 2012, Feb 2012, Jan 2012, Dec 2012, Nov 2012, Oct 2012, Sep 2012, Aug 2012, July 2012, Jun 2012, May 2012, April 2012
:****** Red line - if this month is April,  shows Mar 2011, Feb 2011, Jan 2011, Dec 2011, Nov 2011, Oct 2011, Sep 2011, Aug 2011, July 2011, Jun 2011, May 2011, April 2011
:***** '''Quarterly'''  // if non-time filter selected, shows point of average data for previous quarter. If time filter is selected, shows point of value for quarterly result for 8 quarters data points
:****** Data point of value starts from the previous quarter, if today is in April month of 2012, show 1st QT 2012, 4th QT 2011, 3rd QT 2011, 2nd QT 2011, 1st QT 2011, 4th QT 2010, 3rd QR 2010, 2nd QT 2010
:***** '''Yearly'''  // if non-time filter selected, shows point of average data for previous year. If time filter is selected, shows point of value for yearly average result back to the first year that have the records for comparison.
:****** Data point of value starts from the previous year to years previously such as year 2012, 2011, 2010, 2009 etc.
:*** '''Bottom section''': filters to narrow result
:**** PO
:**** Item Code
:**** Mode of Transport
:**** Origin 
:**** Destination
:**** Carrier
:**** Shipper
:**** Consignees
* '''DR KPI Level 2'''      
:* Download to Excel (data dump)
:** Output fields: Define Field Mappings (CT to XLS)
:***
:***
:***
:***
:***
* '''Validation'''
      
--------------------------------------------
==== Cost Based KPI and Date Based KPI====
Questions: 
* 1) Group, master, load, shipment level - cost... need to be defined
** Is there a case that different shipper/consignee/ carrier shared the same cost in the group level?
*** Cost - per load and each load can consist of many CTs...but date based...we look at each CT
** Which KPIs that we consider result in shipment level
** Which KPIs that we consider result in group level
** Which KPIs that we consider result in Master level
** Will we ever look at result for different level??Load level...etc
* 2) Cost based - how to show useful data...rules need to be defined 
** How to consider cost for Close/Open file...since there are many of CTs/groups still are open
** Logic to close shipment after 90 days 120 days comes to play on this...how to handle.
* 3) Cost based and date based result data dump
:* How to show the result as Cost based shows per load and date based shows per shipment
:** How data dump will look like? As this will need to be common for all the KPIs (KISS)
 CT# Load#    Ttl Cost  Ttl Weight Create to Approved  Created to Delivered Carrier...etc
 CT1 Load 1   12.5      5          5                   20 
 CT2 Load 1   0?        0?         7                   15 
 CT3 Load 1   0?        0?         3                   8
* 4) MOT: Should it be a top level filter
:* Will user compare data across MOTs(compared all modes at once on the same chart) ? or look at each MOT separately?
* 5) Detail Requirements for mapping
* 6) List of fields for data dump
* 7) List of KPIs (3-4 KPIs that are most important to see)
* 8) Template of data for Chart Level 2 - should it be common for all KPIs and what fields??? with ability to download to excel (same as Dashboard Level 2)
* 9) Logics for gauges what parameters for each KPIs (Properties)
* 10) Filters need to be defined and mapped (to make sense)
* 11) Archive KPIs will be required?
* 12) What should be logged on the System Log?
* 13) Validation for KPIs - do we need any?
* 14) Currency for International offices - USD Value...and convert to other Currency using which rule? Do we have any rule in place - this needs to be consistence!