PanaMMS Product Development Toughpad-SRS V0.4

Software Requirement Specification

Version No.: 0.4

Date: 21-Sep-2013

Project Name: PanaCMMS Product Development

Project Code: C/130439

Copyright Notice

The contents of this document are proprietary to Panasonic and shall not be disclosed, disseminated, copied, or used except for purposes expressly authorized in writing by Panasonic.

Software RequirementSpecification

Revision History

Version No Date Prepared by / Modified by

Significant Changes

0.1 05-Aug-2013 Vignesh Srinivasan, Lakshmi Kothandapani

Initial draft

0.2 07-Aug-2013 Vignesh Srinivasan, Lakshmi Kothandapani, Naveen Ganapathy

Sections 3 & 4 &Glossary updated

0.3 08-Aug-2013 Vignesh Srinivasan, Lakshmi Kothandapani, Naveen Ganapathy

Flowchart included.Section 7. References updated

0.4 21-Sep-2013 Vidya K S Updated with Augmented Reality Requirements

Glossary

Abbreviation Description

APK Android application package file

HTML Hyper Text Markup Language

MMS Maintenance Management System

NA Not Applicable

PFSA Panasonic Factory Solutions Company of America

UI User Interface

PanaCIM Manufacturing Execution System of Panasonic

HCLT Confidential of 31


Table Of Contents

1 Introduction.................................................................................................................5

1.1 Purpose......................................................................................................................... 5

1.2 Scope............................................................................................................................ 5

2 Overview of the Document........................................................................7

3 System Context........................................................................................8

3.1 Product Perspective.......................................................................................................8

3.1.1 System Overview & Context Diagram................................................................................8

3.1.2 Operational Concepts and Scenarios................................................................................9

3.1.3 System Interface................................................................................................................9

3.1.4 Memory Constraints.........................................................................................................10

3.1.5 Operations....................................................................................................................... 10

3.1.6 Site Adaptation Requirements.........................................................................................10

3.2 Product Functions........................................................................................................10

3.3 Constraints..................................................................................................................11

3.4 Assumptions and Dependencies.................................................................................11

3.5 Apportioning of Requirements.....................................................................................11

4 Specific Requirements............................................................................12

4.1 Organizational Requirements......................................................................................12

4.2 Business requirements................................................................................................12

4.3 User Requirements......................................................................................................12

4.4 External Interface Requirements.................................................................................12

4.5 Functional Requirements / System Features...............................................................12

4.5.1 Equipment Profile.............................................................................................................12

4.5.2 Native Android Requirements..........................................................................................17

4.6 Performance Requirements.........................................................................................24

4.7 Acceptance Criteria.....................................................................................................25



4.8 Logical Database Requirements..................................................................................25

4.9 Design Constraints......................................................................................................25

4.10 Testing Requirements..................................................................................................25

4.11 Compliance to Standards............................................................................................25

4.12 Software System Attributes.........................................................................................25

4.12.1 Functionality.....................................................................................................................25

4.13 Statutory and Regulatory Requirements......................................................................27

4.14 Organizing Specific Requirements...............................................................................28

4.14.1 System Mode................................................................................................................... 28

4.14.2 User Class....................................................................................................................... 28

4.14.3 Objects............................................................................................................................. 28

4.14.4 Features........................................................................................................................... 28

4.15 Implementation schedule (Optional)............................................................................28

4.16 Acceptance..................................................................................................................28

5 Derived Requirements............................................................................29

6 Validation..............................................................................................30

6.1.1 Validation strategy...........................................................................................................30

6.1.2 Validation criteria.............................................................................................................30

6.1.3 Validation Constraints......................................................................................................30

7 References.................................................................................................................31



1 Introduction

MMS is aimed to automate the maintenance activities within the factory to track the maintenance process. Main part of MMS is developed as a desktop application to provide a standalone product that can track maintenance events, technicians, parts, and documents for any facility regardless of them using PanaCIM. MMS Toughpad application is an extension of the desktop application developed in order to facilitate the maintenance execution workflow in a factory and is intended to be used by the Maintenance Technician.

1.1 Purpose

The purpose of this document is to elaborate the software requirements for the MMS Toughpad Application. This document is intended for the product manager, application developers and quality assurance engineers.

1.2 Scope

The application is designed to perform preventive and reactive maintenance activities using Toughpad. This system will be designed to maximize the productivity of the Maintenance Technician during maintenance execution. The system will provide access to all the components that will be required to perform the maintenance execution effectively.

More specifically, this application is designed to allow Maintenance Technician to do the following:

Login using Login id and password

View My Tasks

View Repair Tickets

View Maintenance Orders

Create Maintenance Orders

Create Repair Tickets

Update Work Order

Cancel Work Order

Hold the Work Order

Scan On/Scan Off on to Work Order

Update Checklist, parts used, resource used and comments for a Maintenance execution



View Reports – For Maintenance Efficiency

Search and View Equipment Profile

View Reference Manuals/ Support Documents

View / Update User Preferences

Logout

The scope of the document is to elaborate on the software requirements of the MMS Toughpad Application, its constraints and other considerations needed to be addressed during the application development.



2 Overview of the Document

This document elaborates on the software requirements of the product. It will explain the purpose and features of the system, what the system will do and the constraints under which it must operate.



3 System Context

3.1 Product Perspective

This Maintenance Management System (MMS) Toughpad application is envisioned to provide end to end functionality to automate the maintenance execution workflows on a factory plant for Maintenance Technician role. The product will have the ability to manage maintenance events with access security and provide information to track the maintenance effort and also provide an augmented view of the product to facilitate the equipment maintenance.

3.1.1 System Overview & Context Diagram

The system is proposed to be used for both preventive and reactive maintenance activities. The following picture explains the various scenarios and work flow :

Figure 1: Maintenance Cycle - Scheduled



Figure 2: Repair Ticket Life Cycle

3.1.2 Operational Concepts and Scenarios

Refer section 4.5 Functional Requirements / System Features

3.1.3 System Interface

User Interface

Toughpad shall have tough screen interface

Hardware Interface

Toughpad shall support the following hardware interfaces:

Camera

Operating System

Application shall support the following versions of Android:

4.0.x, 4.1.x, 4.2.x



Software Interfaces

The system shall provide the following software support:

1. Security Support for WAP

2. Support of HTML5

Communication Interfaces

Toughpad shall have the ability to connect to Factory intranet using WI-FI.

3.1.4 Memory Constraints

Minimum 32MB of free memory shall be needed to run the Toughpad application uninterrupted without Memory low warnings and errors.

3.1.5 Operations

NA

3.1.6 Site Adaptation Requirements

The application shall run flawless in 10.1" 1024*768 Panasonic Toughpad and shall be built responsive to support a wide range of devices in future.

3.2 Product Functions

The product functions shall comprise of the following:

User Authentication using Login id and password

View My Tasks

View Repair Tickets

View Maintenance Orders

Create Maintenance Orders

Create Repair Tickets

Update Work Order

Cancel Work Order

Hold the Work Order

Scan On/Scan Off on to Work Order



Update Checklist, parts used, resource used and comments for a Maintenance execution

View Reports – For Maintenance Efficiency

Search and View Equipment Profile

View Reference Manuals/ Support Documents

View / Update User Preferences

3.3 Constraints

The product is designed to be used in 10.1" 1024*768 Panasonic Toughpad within the intranet of the organization and accommodate other devices in future.

3.4 Assumptions and Dependencies

MMS Application shall work only in Intranet network of the Factory.

MMS Application shall be only supported in the 10.1 inch 1024*768 Toughpad configurations

MMS Application shall support the following android versions – 4.0.x, 4.1.x, 4.2.x

MMS Application webview shall support HTML5

3.5 Apportioning of Requirements

Covered as part of MMS Server requirements - in scope / out of scope req list to be populated


Bala, 08/12/13,

Are we going to use any specific HTML5 features?

Vignesh, 08/12/13,

No specific HTML5 features supported in the current phase.


4 Specific Requirements

4.1 Organizational Requirements

<<Need input from Panasonic>>

4.2 Business requirements

Providing Toughpad based maintenance work flow improves the usability of the application making it mobile. This provides convenience to the Maintenance Technicians and also reduces the amount of space occupied in the factory floor for desktops. Additional features like Augmented Reality provided as part of the application, increases the ease of the maintenance activity.

4.3 User Requirements

Only Maintenance Technician shall have the ability to use the Toughpad application to perform PFSA maintenance activities.

4.4 External Interface Requirements

NA

4.5 Functional Requirements / System Features

The functional requirements for MMS project are divided into following categories, and the naming conventions used are as follows:

1. The Setting Requirements start with prefix UCS.

2. The Equipment Requirements start with prefix UCE.

3. The Maintenance Requirements start with prefix UCM.

4. The Alert Requirements start with prefix UCA.

5. The Reports Requirements start with prefix UCR.

6. Native Android Requirements start with prefix UCN.

4.5.1 Equipment Profile

The requirements with respect to the Equipment Profile are captured here.

UCE-01: Equipment Profile – List



Title Equipment Profile – List Actors UserStatus Closed

Description Application shall provide an option to view the Equipment list in the system.Flow of Events

1. User selects Equipment Profile from the fly out menu

2. All the existing Equipment Profiles are fetched from the server and displayed in the grid with Equipment Name, Area, Location and Model No. List supports pagination.

3. User can filter the data using Area, Equipment Name in the grid.

4. The list is sortable.

Sub-flow/Alternate Flows/ Scenarios When there is a problem in connecting with the server, connection error is

displayed on the screen.

Special Requirements

None

Assumptions NonePre-conditions 1.Touchpad application must have been installed in the device.

2. User must have logged into the application with sufficient rights to perform this action.

Post-conditions Equipment profile List is displayed.User interface Equipment Profile-ListBusiness Rules NoneEntities/Business Concepts

Equipment Profile View

Related Use Cases NAIssues NoneReference Documents: Mobile Maintenance_02.pdf

UCE-02: Equipment Profile – General

Title Equipment Profile – General Actors UserStatus Closed

Description Application shall allow the User to view the Equipment General Details in a separate tab.

Flow of Events1. Equipment Profile Detail screen is displayed with General tab as default

selection.

2. Information about the following for the equipment is displayed: Primary, Secondary, Subgroup, Model Number, Serial Number, Equipment barcode, Area, Location, Cost Centre, Next Planned maintenance Due Date, Date of Manufacturing, Installation Date, Company Asset Tag, Machine Counter, Voltage Requirements, Host name & IP Address & will also have information whether it requires air supply or not . It also displays whether the equipment is active or not.






None

Assumptions NonePre-conditions 1.Touchpad application would have been installed in the device.

2. User must have logged into the application with sufficient rights to perform this action.3. User must have selected Equipment Profile from the fly out menu.4. User must have selected an item from the list displayed.5. Data must have been fetched from the server and populated for the user.

Post-conditions Equipment profile with General tab details is displayed.User interface Equipment Profile-GeneralBusiness Rules NoneEntities/Business Concepts

Equipment Profile - Detail View


UCE-03: Equipment Profile - Attributes

Title Equipment Profile – AttributesActors UserStatus Closed

Description Application shall allow the User to view the Equipment Attribute Details in a separate tab.

Flow of Events1. Click on the Attributes tab in Equipment Profile

2. User will be able to vie w the Attributes relevant to the equipment if any with description and value.

3. User will be able to modify the value of the Attribute and Save.

4. Clicking the Reset button will discard the modification and set fields to original state

5. User will be able to sort the list displayed.

Sub-flow/Alternate Flows/ Scenarios 1. On Clicking Save button, validation is made for all the fields and

corresponding validation message is displayed in case of errors.

2. When there is a problem in connecting with the server, connection error is displayed on the screen.


None

Assumptions None



Pre-conditions1. User must have logged in with sufficient rights to perform this action

2. User must have clicked Equipment Profile in the fly out menu.

3. User must have clicked on a row in the list displayed.

4. Data must have been fetched from the server and populated for the user.

Post-conditions Equipment profile with Attributes will be displayed and stored with modifications made.

User interface Equipment Profile – AttributesBusiness Rules NoneEntities/Business Concepts


Related Use Cases NoneIssues NoneReference Documents: Mobile Maintenance_02.pdf

UCE-04: Equipment Profile - Parts List

Title Equipment Profile – Parts List Actors UserStatus Closed

Description Application shall allow the User to view the Equipment Parts List Details in a separate tab.

Flow of Events1. Click on the Spare Parts tab in Equipment Profile page

2. The list of Spare Parts relevant to the equipment will be displayed along with its description.

3. The list displayed will be sortable.




None

Assumptions NonePre-conditions

1. The user must be logged in with sufficient rights to perform this action

2. User must have clicked Equipment Profile in the flyout menu.



Post-conditions Equipment profile with Spare Parts tab details will be displayedUser interface Equipment Profile – Parts ListBusiness Rules NoneEntities/Business Concepts

Equipment Profile - Detail view

Related Use Cases None



Issues NoneReference Documents: Mobile Maintenance_02.pdf

UCE-05: Equipment Profile – Documents

Title Equipment Profile – Documents Actors UserStatus Closed

Description Application shall allow the User to view the Equipment Document Details in a separate tab.

Flow of Events1. Click on the Documents tab in Equipment Profile screen.

2. The list of documents relevant to the equipment along with version will be displayed

3. The list displayed will be sortable.

Sub-flow/Alternate Flows/ Scenarios

When there is a problem in connecting with the server, connection error is displayed on the screen.


None


1. The user must be logged in with sufficient rights to perform this action




Post-conditions Equipment profile with Document tab details is displayedUser interface Equipment Profile-DocumentsBusiness Rules NoneEntities/Business Concepts



UCE-06: Equipment Profile - Comments

Title Equipment Profile – CommentsActors UserStatus Closed

Description Application shall allow the User to view the Equipment related Comments Details in a separate tab.



Flow of Events1. Click on the Comments tab in Equipment Profile

2. User will be able to vie w the comments relevant to the equipment along with User ID, Date and time.

3. User will be able to add/modify comments to the Equipment.

4. User will be able to take an image with Toughpad camera and upload it in the comments.

5. User ID, Date and time details will be recorded for the comments modified / added.

6. Clicking the Reset button will discard the modification and set fields to original state

7. Save Button will save the changes made.

8. User will be able to sort the list displayed.

Sub-flow/Alternate Flows/ Scenarios 1. On Clicking Save button, validation is made for all the fields and

corresponding validation message is displayed in case of errors.

2. When there is a problem in connecting with the server, connection error is displayed on the screen.


None


1. The user is logged in with sufficient rights to perform this action




Post-conditions Equipment profile with comments will be displayed and stored with modifications made.

User interface Equipment Profile – CommentsBusiness Rules NoneEntities/Business Concepts



4.5.2 Native Android Requirements

Functionalities to be implemented using native android components are covered here.



UCN-01: Native Android – Application Launch/ Brought to Foreground

Title Application Launch/ Brought to ForegroundActors UserStatus ClosedDescription The application shall follow the flow specified in this table when launched or

brought to foreground.Flow of Events 1. User taps on the application icon for the first time.

2. Application splash screen is displayed3. After a few seconds, application login screen is displayed.


After application launch and login, the user works on some other application for some time and then taps on the application icon. If he had worked on some other application for XX seconds or more, the application login screen is displayed. Else, the user's last working screen is displayed.


None

Assumptions NonePre-conditions User has the application installed in the toughpad. Post-conditions Application is launched or resumedUser interface NoneBusiness Rules NoneEntities/Business Concepts

Application Launch / Brought to foreground




Flow Chart



UCN-02 : Native Android - Version check

Title Version Check / Application UpdateActors User Status ClosedDescription The application shall be automatically updated with the latest version on its

launch or resume Flow of Events 1. User taps on the application icon

2. Application splash screen is displayed3. The latest version of the application that is available in the server is fetched

and is compared with the version in the toughpad4. In case of mismatch, user is notified and once the user accepts, latest

version application is downloaded from the server and installed using android installer and the application is relaunched. If user doesn't accept, the application is closed.


If there is some problem during download or the apk file is corrupted or incorrect, an error message is shown on the screen and the old application is relaunched.


None

Assumptions NonePre-conditions User has the application installed in the toughpadPost-conditions Application is updated with the latest version.User interface Application splash screenBusiness Rules NoneEntities/Business Concepts

Application Update




Flow chart



UCN-03: Native Android – Scan ON / Scan OFF

Title Maintenance Technician Scan ON / Scan OFFActors User Status ClosedDescription When the Maintenance Technician presses Scan ON / Scan OFF, the

equipment bar code shall be scanned and the equipment information shall be retrieved and sent to the server

Flow of Events 1. User taps on Scan ON/Scan OFF button against the Work Order2. Scanner Camera view is displayed3. User scans the equipment barcode4. The equipment details in the bar code are sent to the server.5. Scan ON/Scan OFF activity is used to track Maintenance execution

duration for that particular equipment.Sub-flow/Alternate Flows/ Scenarios

If the barcode is unreadable or the server is unreachable an error is thrown on the screen.


Application should support a wide range of barcodes.

Assumptions NonePre-conditions 1. User has the application installed in the toughpad.

2. User has logged into the application and is in Maintenance Execution screen.Post-conditions Scan ON - Scan OFF duration is used for tracking the maintenance execution

duration.User interface Maintenance Execution screenBusiness Rules NoneEntities/Business Concepts

Application - Scan ON - Scan OFF


Flow Chart



UCN-04: Native Android – Augmented Maintenance View ( Incomplete )

Title Augmented Maintenance ViewActors User Status OpenDescription When the Maintenance Technician focuses the camera on the equipment, the

maintenances done on / due for the equipment shall be displayed in an augmented view along with equipment status with respect to factory line.

Flow of Events 1. User focuses the camera on the equipment.2. The top 3 maintenances done on the equipment is displayed.3. The checklist followed for the top most maintenance is displayed with the

area of maintenance in the equipment marked.4. User is allowed to scroll through the maintenance list and view the checklist

followed for each maintenance activity and also the area of the equipment on which the maintenance happened.

5. User is also allowed to view the list of upcoming maintenance when he does a horizontal swipe on the maintenance table.

6. User can see the checklist that will be followed and the area of the equipment in which the maintenance is upcoming for the topmost item on the list by default.

7. User is allowed to select an item in the list for which, the checklist to be followed and the area of the equipment on which the maintenance is upcoming should be displayed.

8. The status of the equipment with respect to the factory line is displayed in the bottom of the screen with the equipment highlighted as red ( Faulty ) or green ( Healthy ) in the picture of the factory line.

Sub-flow/Alternate Flows/ ScenariosSpecial RequirementsAssumptions NonePre-conditions 1. User has the application installed in the toughpad.

2. User has logged into the application and is in Maintenance Execution screen.3. User must have selected augmented view.

Post-conditions Augmented maintenance history / plan for the equipment is displayed.User interface Maintenance Execution screenBusiness Rules NoneEntities/Business Concepts

Augmented Maintenance View


4.6 Performance Requirements

All application views other than augmented reality shall respond within 6 seconds under the good network coverage and speed.


Naveen Ganapathy, 09/21/13,

To be revisited


4.7 Acceptance Criteria

All the maintenance execution workflows and Augmented Reality features shall be addressed in the Toughpad application.

4.8 Logical Database Requirements

This is covered as part of SRS_MMS.doc

4.9 Design Constraints

The system shall be designed under following constraints:

1. The system will be used within Intranet of an organization.

2. The system will not have access to internet. Hence, resources from internet will not be used or accessed by the application.

3. The application shall operate in 10.1" 1024*768 Panasonic Toughpad and shall be accommodative to work in other resolution devices in future.

4.10 Testing Requirements

Unit testing would be performed at HCL

System testing performed by HCL

Acceptance testing performed at PFSA(Panasonic)

System requirement document would be used to translate and develop test cases along with other documents

Panasonic would also identify certain customers for beta testing

4.11 Compliance to Standards

Refer development coding standards attached

4.12 Software System Attributes

4.12.1 Functionality

4.12.1.1 Suitability

NA



4.12.1.2 Interoperability

It is the ability of a system or a product to work with other systems or products without special effort on the part of the customer. The application is designed to work with MMS Server as web client.

4.12.1.3 Security

Authentication

Authentication mechanism provided in the MMS Server is adapted in the mobile application.

Authorization

Authorization mechanism of the MMS Server is adapted in the mobile application.

STRIDE threads

NA

Assembly signature for identity and integrity

Out of scope

4.12.1.4 Reliability

This Product would perform a required function under stated conditions for a specified period of time.Removing faults or issues with serious consequences is the most important objective.

4.12.1.5 Usability

Panasonic guidelines are followed for logo, Color used and size of the logo .Given detail in the document Panasonic_LogoManual_en.pdf

4.12.1.6 Efficiency

All pages shall respond within 5 seconds

4.12.1.7 Maintainability



Maintainability includes Application release / support, Error Logging, audit trail, UI message handling .Error Logging mechanism will be handled in Database or Flat file.

4.12.1.8 Portability

Not applicable

4.12.1.9 Availability

The system should be available 24*7. Though downtime input has to come from Panasonic. The Application would be down only during the downtime. Downtime notification in the UI would be provided based on the duration specified by Panasonic.

4.12.1.10 Safety

NA

4.12.1.11 Environmental

NA

4.12.1.12 Other Requirements

NA

4.12.1.13 Reusability

This single-minded model purpose renders the components reusable wherever there are similar needs required. Generic and reusable framework, custom controls with common styles, themes to be uniform.

4.12.1.14 Data Versioning/auditing

NA

4.12.1.15 Integration

Integration with PanaCIM is not in the scope

4.12.1.16 Failover Clustering

Not in scope

4.13 Statutory and Regulatory Requirements

The application shall adhere to Panasonic Statutory and Regulatory Requirements



4.14 Organizing Specific Requirements

4.14.1 System Mode

The application shall always work in integration with MMS Server as web client.

4.14.2 User Class

Maintenance Technician shall only be authorized to use the application.

4.14.3 Objects

NA

4.14.4 Features

All the features are captured in the above Section 4.5 (System features) in a detailed manner.

4.15 Implementation schedule (Optional)

Refer Panasonic_Maintenace PMP for project schedule.

4.16 Acceptance

No major severity testing issues.



5 Derived Requirements

Derived requirements are captured in the above Section 4 in a detailed manner.



6 Validation

6.1.1 Validation strategy

NA

6.1.2 Validation criteria

NA

6.1.3 Validation Constraints

NA



7 References

S. No. Document Name / Links Version No. Remarks

1 Mobile Maintenance_02.pdf 0.2 Requirements document

2 MMS Software Architecture 1.0 Architecture document of Desktop Version

3 AR_Usecase.pptx NA Augmented Reality Uses cases that was discussed during the workshop and after

4 https://static.googleusercontent.com/external_content/untrusted_dlcp/source.android.com/en//compatibility/android-4.2-cdd.pdf

http://www-images.panasonic.com/business/toughpad/us/downloads/FZ-A1/Panasonic-Toughpad-A1-Spec-Sheet.pdf

NA Google user interface standards for mobile development





https://static.googleusercontent.com/external_content/untrusted_dlcp/source.android.com/en/compatibility/android-4.2-cdd.pdf



PanaMMS Product Development Toughpad-SRS V0.4

Documents

Transcript of PanaMMS Product Development Toughpad-SRS V0.4