KPI Business Requirements & Software Requirements Specification
From UG
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
- KPI Dashboards
- Multi-Level Interactive KPI Charts & Graphs
- KPI Entitlements Management
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.
| Phase | Start | Complete | |
|---|---|---|---|
| Phase I - Core KPI Framework / Address gaps in Cost-Based KPIs | Requirements | ||
| Design | |||
| Construction | |||
| Verification | |||
| Maintenance | |||
| Phase II - Date-Based KPIs | Requirements | ||
| Design | |||
| Construction | |||
| Verification | |||
| Maintenance | |||
| Phase III - Utilization/Optimization KPIs | Requirements | ||
| Design | |||
| Construction | |||
| Verification | |||
| Maintenance | |||
| Phase IV - International KPIs | Requirements | ||
| Design | |||
| Construction | |||
| Verification | |||
| Maintenance | |||
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 proejct 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 walkthrough 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 verfiication 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 fulfil 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]
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.
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
- Consist of 3 levels of admin functionality:
UNDER CONSTRUCTION-------------------------
System Level
- 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 allow ability to organize each groups of widgets or panel by catagories.
- IE. Weather and RSS News Feed can be set to be in the same catagory to show on one panel or it can be set to be independent panel.
- IE. Set all the Reports to be in one Panel to display on the dashboard. Panel can display many reports' summary for each line
Admin Level
- 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)
User Level
- 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.
- Solution for current state
- 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 number of dashboard tabs and name/edit/remove them
- 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 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.
- Ability to manage and create number of dashboard tabs and name/edit/remove them
- To allow user to manage their own custom setting to activate/deactivate each panel and layout for panels on dashboard(s)
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
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
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
Reporting Requirements
User Access / Security Requirements
Logging Requirements
Group / Master Requirements
Filtering Requirements
Archiving Requirements
Non-Functional Requirements
<Identify all non-functional requirements for both CT2 Client Application and CT2 Internal Application>
Performance Requirements
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>
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)>
