Software Requirements Specification to Distribute Manufacturing Data
Total Page:16
File Type:pdf, Size:1020Kb
NIST Advanced Manufacturing Series 300-2 Software Requirements Specification to Distribute Manufacturing Data Thomas Hedberg, Jr. Moneer Helu Marcus Newrock This publication is available free of charge from: https://doi.org/10.6028/NIST.AMS.300-2 NIST Advanced Manufacturing Series 300-2 Software Requirements Specification to Distribute Manufacturing Data Thomas Hedberg, Jr. Moneer Helu Systems Integration Division Engineering Laboratory Marcus Newrock Office of Data and Informatics Material Measurement Laboratory This publication is available free of charge from: https://doi.org/10.6028/NIST.AMS.300-2 December 2017 U.S. Department of Commerce Wilbur L. Ross, Jr., Secretary National Institute of Standards and Technology Walter Copan, NIST Director and Under Secretary of Commerce for Standards and Technology SRS to Distribute Manufacturing Data Hedberg, Helu, and Newrock ______________________________________________________________________________________________________ Contents 1 Introduction 1 1.1 Purpose ...................................... 1 1.2 Disclaimer ..................................... 1 This publication is available free of charge from: https://doi.org/10.6028/NIST.AMS.300-2 1.3 Scope ....................................... 1 1.4 Acronyms and abbreviations ........................... 1 1.5 Verbal Forms ................................... 3 1.5.1 Must .................................... 3 1.5.2 Should ................................... 3 1.5.3 May .................................... 3 1.6 References ..................................... 3 1.7 Overview ...................................... 3 2 General Description 4 2.1 System Perspective ................................ 4 2.1.1 Volatile Data Stream ........................... 4 2.1.2 Query-able Data Repository ....................... 4 2.2 System Functions ................................. 6 2.3 User Classes and Characteristics ......................... 6 2.4 Operating Environment ............................. 6 2.5 Design and Implementation Constraints . 7 2.6 User Documentation ............................... 7 2.7 Assumptions and Dependencies ......................... 7 3 External Interface Requirements 8 3.1 User Interfaces .................................. 8 3.1.1 Volatile Data Stream ........................... 8 3.1.2 Query-able Data Repository ....................... 8 3.2 Hardware Interfaces ................................ 8 3.3 Software Interfaces ................................ 8 3.3.1 Description of Services .......................... 9 3.4 Communication Interfaces ............................ 10 4 System Features 11 4.1 Component Functional Requirements ...................... 11 4.1.1 Volatile Data Stream ........................... 11 4.1.2 Query-able Data Repository ....................... 11 4.2 Data Curation ................................... 12 4.2.1 Description and Priority ......................... 12 4.2.2 Functional Requirements ......................... 12 4.3 Software System Administration ......................... 12 This publication freely available at: https://doi.org/10.6028/NIST.AMS.300-2 Page i SRS to Distribute Manufacturing Data Hedberg, Helu, and Newrock ______________________________________________________________________________________________________ 4.3.1 Description and Priority ......................... 12 4.3.2 Functional Requirements ......................... 12 5 Non-functional Requirements 14 5.1 Performance Requirements ............................ 14 5.2 Reliability Requirements ............................. 14 This publication is available free of charge from: https://doi.org/10.6028/NIST.AMS.300-2 5.3 Availability Requirements ............................ 14 5.4 Security Requirements .............................. 14 5.5 Maintainability Requirements .......................... 14 5.6 Business Rules .................................. 15 5.6.1 Super-User Role Business Rules ..................... 15 5.6.2 User Role Business Rules ......................... 15 Appendix A: Glossary 16 Appendix B: Analysis Models 18 This publication freely available at: https://doi.org/10.6028/NIST.AMS.300-2 Page ii SRS to Distribute Manufacturing Data Hedberg, Helu, and Newrock ______________________________________________________________________________________________________ List of Figures 1 Manufacturing-Monitoring System Stack . 5 This publication is available free of charge from: https://doi.org/10.6028/NIST.AMS.300-2 2 Example network diagram for a smart manufacturing system design to collect, curate, and disseminate manufacturing data. 19 This publication freely available at: https://doi.org/10.6028/NIST.AMS.300-2 Page iii SRS to Distribute Manufacturing Data Hedberg, Helu, and Newrock ______________________________________________________________________________________________________ 1. Introduction This section of the Software Requirements Specification (SRS) document provides the purpose of the SRS, copyright and commercial systems disclaimer, scope of the SRS, acronyms and abbreviations used in the SRS, the definition of verbal forms, list of references, and an overview of the SRS document's structure. This publication is available free of charge from: https://doi.org/10.6028/NIST.AMS.300-2 1.1 Purpose The purpose of this SRS document is to describe the requirements specifications for applications and a data repository to distribute manufacturing data. Prospective developers, technical-assessment personnel, and interested end-users are the intended audience of this SRS document. 1.2 Disclaimer The work presented in this SRS is an official contribution of the National Institute of Standards and Technology (NIST) and not subject to copyright in the United States. Cer- tain commercial systems are identified in this paper. Such identification does not imply recommendation or endorsement by NIST. Nor does it imply that the products identified are necessarily the best available for the purpose. 1.3 Scope A software system to distribute manufacturing data via a web service is the application being defined by this document. The software system contains two component applica- tions. The first component is an application to stream time-synchronized manufacturing data, herein referred to as the Volatile Data Stream (VDS). The second component is an application for querying a database containing manufacturing data, herein referred to as the Query-able Data Repository (QDR). The two components combined are herein referred to as the \software system." The software system enables researchers, practitioners, and solution providers to interact with real data generated from a manufacturing facility. The VDS supports real-time data- monitoring activities. The QDR enables object-of-interest observation. The data distributed via the software system enables research in manufacturing-related domains. The distributed data also supports the optimization and enhancement of practitioner processes. Lastly, the distributed data supports solution-provider development activities, such as designing, coding, testing, and debugging software applications. 1.4 Acronyms and abbreviations API Application Programming Interface 6, 7, 9, 11{13 ASCII American Standard Code for Information Interchange 9{11 This publication freely available at: https://doi.org/10.6028/NIST.AMS.300-2 Page 1 SRS to Distribute Manufacturing Data Hedberg, Helu, and Newrock ______________________________________________________________________________________________________ CRUD Create, Retrieve, Update, and Delete 9, 12, 13 CSV Comma Separated Value 8, 10, 11 HTML HyperText Markup Language 7 This publication is available free of charge from: https://doi.org/10.6028/NIST.AMS.300-2 HTTP HyperText Transfer Protocol 4 HTTPS HTTP Secure 10 JSON JavaScript Object Notation 8, 10, 11 MTBF Mean Time between Failures 14 MTTF Mean Time to Failures 14 MVC Model-View-Controller 8 NIST National Institute of Standards and Technology 1 NoSQL Not only Structured Query Language 6 PDF Portable Document Format 7 QDR Query-able Data Repository 1, 4, 6{12, 14, 15 QIF Quality Information Framework 9 REST Representational State Transfer 6, 7, 9{13 SRS Software Requirements Specification 1, 3, 4, 6, 8, 11, 12, 14 SSL Secure Sockets Layer 6 TLS Transport Layer Security 6 UI User Interface 6, 8, 9, 12 UUID Universally Unique Identifier 13 VDS Volatile Data Stream 1, 4, 6{11, 14, 15 XML Extensible Markup Language 4, 8{11 XSD XML Schema Definition 4, 8, 13 XSLT Extensible Stylesheet Lanaguage Transformation 8 This publication freely available at: https://doi.org/10.6028/NIST.AMS.300-2 Page 2 SRS to Distribute Manufacturing Data Hedberg, Helu, and Newrock ______________________________________________________________________________________________________ 1.5 Verbal Forms 1.5.1 Must The verbal form \must" indicates requirements to be followed strictly to conform to this document and from which no deviation is permitted. Must is synonymous with \shall." This publication is available free of charge from: https://doi.org/10.6028/NIST.AMS.300-2 1.5.2 Should The verbal form \should" indicates that a possibility among a set of possibilities is recommended as particularly suitable (without mentioning or excluding other possibilities) or that a certain course of action is preferred but not necessarily required. 1.5.3 May The verbal form \may" indicates a course of action permissible within the limits of the document. 1.6 References [1] MTConnect Institute (2014, Last Accessed June 2017) MTConnect Standard, Version 1.3, Standard.