3- SMCS Software Requirements.pdf

DRAFT

Software Requirements Specification

For

The Spectrum Management

Coordination System (SMCS)

Version 0.26 Defense Spectrum Organization

November 2018

Software Requirements Specification for the Spectrum Management Coordination System

Table of Contents

1.1 Purpose

1.2 Document Conventions

1.3 Intended Audience and Reading Suggestions

1.4 Product Scope

1.5 References

2.1 Product Perspective

2.2 Product Functions

2.3 Operating Environment

2.4 Design and Implementation Requirements

2.5 User Documentation

2.6 Assumptions and Dependencies

3.1 Coordination Request and Notification Processing

3.2 User Accounts, Permissions, and Responsibilities

3.3 Data Management

3.4 Data Analyses

3.5 Data Search

3.6 Data Visualization

3.7 Data Sharing and Reporting

4.1 User Interfaces

4.2 Hardware Interfaces

4.3 Software Interfaces

4.4 Communications Interfaces

5.1 Performance Requirements

5.2 Safety Requirements

5.3 Security Requirements

Revision History

Name Date Reason For Changes Version

V 0.26 31 May

Final MITRE Draft 0.26

List of Figures Figure 1 – SMCS Objective Capabilities Figure 2. SMCS Functionality (SV-4) Figure 3 Top-Level SMCS Use Case Taxonomy Figure 4. Use Cases for Coordination Request & Notifications Figure 5 – User Classes Figure 6. Basic User Account Sequences (combined) Figure 7. Data Access Use Case

List of Tables Table 1. References Table 2. Design and Implementation Requirements Table 3. User Account Requirements Table 4. Data Management Requirements Table 5. Data Analysis Requirements Table 6. Data Search Requirements Table 7. Data Visualization Requirements Table 8. Data Sharing Requirements Table 9. Communication Interface Requirements

1 Introduction

1.1 Purpose

This Software Requirements Specification (SRS) provides the requirements for the Spectrum Management Coordination System (SMCS). The SMCS is a software portal that provides functions which support coordination and frequency channel sharing. The initial version will support coordination within the 2025-2110 MHz band between DoD organizations and the Electronic News Gathering (ENG) community represented by the Society of Broadcast Engineers (SBE). The sharing arrangement between DoD and the ENG/SBE is defined within a separate Memorandum of Understanding (MOU) between the Department of Defense (DoD) and the ENG/SBE. Future versions of SMCS may support additional sharing scenarios.

This SRS is intended to provide the requirements to the SMCS contractor necessary to achieve a product that meets the Government’s needs.

1.2 Document Conventions

Specific requirements are provided in tables in the appropriate sections. All such requirements have identification numbers. The identification numbers are not sequential, and are provided only for tracking purposes.

1.3 Intended Audience and Reading Suggestions

This document is intended for several categories of readers. Primarily, the SRS serves as requirements communications between the Defense Spectrum Organization (DSO) and the SMCS Contractor. Additionally, the SRS describes SMCS characteristics to DoD oversight and other interested stakeholders.

1.4 Product Scope

For the initial version, the SMCS scope is limited to:

• An unclassified system, operating on the commercial, open Internet.

• Frequency sharing and coordination within the 2025-2110 MHz band. (this scope restriction may be altered in future versions of the SMCS.)

• Desktop Internet browsers such as Internet Explorer and Google Chrome (e.g., mobile applications are not in scope at this time).

• Users within either the DoD spectrum community or the ENG community. Other users may be included as SMCS users in some future versions of SMCS.

1.5 References

The following documents are relevant to discussions in this document, the SMCS project, and/or frequency sharing in the 2025-2110 MHz band.

Table 1. References

Background Brief The SMCS Background Information Briefing provides foundational information on SMCS mission requirements

MBSE http://www.omgwiki.org/MBSE/doku.php MOU Draft DISA-4 Memorandum of Understanding ORD SMCS Operational Requirements Document, DSO.

SMCS

Architecture

The SMCS Reference Architecture, which includes: NoMagic Cameo file, .jpgs of all diagrams, .xlsx of all data dictionaries, and an AV-1 view

SMCS Future Objectives List

The SMCS Future Objectives List describes capabilities to be developed within SMCS beyond the initial SMCS version build

SXXI Spectrum XXI: https://www.disa.mil/Mission- Support/Spectrum/GEMSIS/Spectrum-XXI

User Procedures The SMCS User Procedures Guide describes SMCS user activities

2 Overall Description

2.1 Product Perspective

The SMCS shall provide a mechanism that will automate and facilitate coordination of frequency sharing between DoD operations employing TRR, SUAS, HRV, TTNT, and other DoD capabilities to be determined and the incumbent ENG operations consisting of the Television Broadcast Auxiliary Service (BAS), the Cable Television Relay Service (CARS), and the Local Television Transmission Service (LTTS). Through the use of common data sets and associated functions, DoD and SBE users will be able to identify currently used/assigned frequencies; DoD users will be able to submit requests for frequency use, SBE users will be able to respond to DoD users requests and DoD users will negotiate frequency usage in situations of conflicting needs.

Users with specified permissions will be able to:

• Query a common database for current and planned spectrum usage, including location and time span

• Submit requests for reservation of future spectrum channels

• Determine 2025-2110 MHz spectrum access opportunities

• Display status logs, with timestamps, of current notifications and coordination requests

• Other tasks (TBD)

The following are long-term key SMCS objectives; these objectives will not be comprehensively addressed in the initial version of SMCS:

• OJ0001: The SMCS shall provide automation of end-to-end business process coordination workflow between DoD and SBE to provide access to the 2025-2110 MHz for DoD operations involving TRR, SUAS, HRV, TTNT and other DoD capabilities to be determined.

• OJ0002: The SMCS shall provide a database containing detailed operational and equipment characteristics configurations of all FCC-licensed Non-Federal users in the 2025 – 2100 MHz band, a repository of pre-coordinated access frequencies and locations and coordinated access data including a history of workflow between DoD and the broadcasters in the development of coordinated access data.

http://www.omgwiki.org/MBSE/doku.php https://www.disa.mil/Mission-Support/Spectrum/GEMSIS/Spectrum-XXI https://www.disa.mil/Mission-Support/Spectrum/GEMSIS/Spectrum-XXI

• OJ003: The SMCS shall provide an analysis capability to assess the potential for interference between DoD operations involving TRR, SUAS, HRV, TTNT, other DoD capabilities to be determined and ENG operations. This analysis will include the identification of spectrum access opportunities for the DoD operations.

Figure 1 – SMCS Objective Capabilities

2.2 Product Functions

The SMCS shall perform the following functions; details of each function are provided in Section 3 of this document:

• Coordination Request and/or Notification Processing

• Management of user Accounts, Permissions, and Responsibilities

• Data Management

• Data Analyses

• Data Search

• Data Visualization (with Assets & Boundaries)

2.3 Operating Environment

SMCS shall operate within the following environments:

• Web server

• Database

• Internet access (not DoD)

2.4 Design and Implementation Requirements

The following describes issues and implementation constraints that will limit options for future use. The SMCS developer shall implement:

• Model Based Systems Engineering (MBSE)

• Agile Development

The following Design and Implementation requirements in Table 2 shall be implemented:

Table 2. Design and Implementation Requirements

Rqmt 048 The SMCS System of Systems shall make maximum use of open interfaces between system modules. (Open Interfaces: no proprietary data or data formats shall be used within the interfaces between major modules.)

Interface metrics shall represent, at a minimum:

• Number of interfaces between major modules

• Number of message types per interface

• Message sizes on each interface

• Number of message interchanges for use cases

Metrics shall be measured at every design increment, and trends shall be calculated and presented.

2.5 User Documentation

The contractor shall deliver documentation and deliverables in accordance with the SMCS Performance Work Statement and the SMCS contract.

2.6 Assumptions and Dependencies

The use of the agile development construct is dependent upon a constant stream of user input and new features for implementation within SMCS.

3 System Features The major system features include:

• User Accounts, and their attributes and permissions (Section 3.1),

• Data management functions to allow creation, editing, and deletion of receiver and transmitter records by the assigned record owners (Section 3.3),

• Data search (Section 3.4),

• Spectrum Coordination Requests and Notification Processing (Section 3.1),

• Data Analyses (Section 3.4),

• Data Visualization (Section 3.6), and

• Data Sharing (Section 3.7).

An SV-4 System Functionality diagram is shown in Figure 2, and Figure 3 illustrates the overall use case diagram for the SMCS.

Figure 2. SMCS Functionality (SV-4)

Figure 3 Top-Level SMCS Use Case Taxonomy

3.1 Coordination Request and Notification Processing

This SMCS feature is the primary and most important feature. A Notification is submitted by a DoD user as an alert to the ENG community that a pre-coordinated frequency will be used by the DoD user. A Coordination Request is submitted when a DoD user has a need to use a frequency/ channel that is not identified as a pre-coordinated frequency. These two “use cases” share a number of common features.

3.1.1 Description and Priority

This feature shall be considered the highest priority for the SMCS. The reliability and usability of this feature shall be considered high priority, as users must be comfortable with this feature in order for them to use it as a primary tool.

3.1.2 Use Case for Collaboration Requests and Notifications

The use case diagram for this functionality is presented in Figure 4.

Figure 4. Use Cases for Coordination Request & Notifications

3.2 User Accounts, Permissions, and Responsibilities

The SMCS shall support the following classes of users:

• DoD Administrator: Administrative users responsible whose responsibilities include software update, database maintenance, and user account maintenance. The most complete and comprehensive category of administrative account.

• ENG Administrator: Administrative users responsible for the ENG accounts within the SMCS. No software maintenance permissions. Responsibilities include the monitoring and maintenance of ENG user accounts and ENG data.

• Regular User: The normal category of user, who has permissions to enter, edit, and delete the receiver and transmitter records of which they are the owners, enter Coordination Requests and Notifications, execute Analysis Functions and Map Functions. Regular users may be either DoD or ENG users.

A proposed class structure, with class attributes, is presented in Figure 5.

Figure 5 – User Classes

3.2.1 Description and Priority

This feature defines the minimal set of user accounts that shall be included in the SMCS, and is considered high priority, as these account types, and their functionality, is crucial to successful operations.

3.2.2 Stimulus/Response Sequences

Figure 6 is provided below as general guidance on the sequence for setting up a user account and then the user logging in, and an administrator deleting the account.

Figure 6. Basic User Account Sequences (combined)

3.2.3 Functional Requirements

Time response for

• Account Creation

• Login / Logoff

Shall support at least the following number of accounts per account type

• DoD Administrator

• ENG Administrator

• Regular User

The following user account related requirements in Table 3 shall be implemented:

Table 3. User Account Requirements

Rqmt 028 The SMCS shall implement a role-based permission scheme for all users (DoD and

ENG).

Rqmt 028a The SMCS shall have permission requirements on all SMCS functions.

Rqmt 028b The SMCS shall include permission attributes on all user accounts.

Rqmt 028c The SMCS shall only allow administrators to set the permission attributes on user accounts.

Rqmt 028d When users attempt to execute SMCS functions for which they are not authorized

(no permissions), the SMCS shall provide an indication to the user that they are not authorized to execute that function.

Rqmt 037 The SMCS shall require users to log in with their proper credentials before executing any other SMCS functions.

Rqmt 038 The SMCS shall have both administrative and regular user categories.

Rqmt 039 The SMCS shall only allow administrator users to execute administrative functions.

Rqmt 040 The SMCS shall allow administrators to delete obsolete or expired user accounts.

Rqmt 044 The SMCS shall maintain a "last logged in" attribute on all user accounts.

Rqmt 051 The SMCS SoS Software shall be update-able only by authorized administrators.

3.3 Data Management

3.3.1 Description and Priority

The data in the SMCS shall be managed to maintain the following characteristics:

• Consistency: The data shall be consistent across the database – contradictory records shall be flagged and brought to the owning user’s attention

• Up to date: All data records shall be monitored and owning users shall be requested to certify the data’s correctness periodically.

• Completeness: Criteria for data completeness shall be verified with the government and enforced via data management rules

• Data Security: The SMCS database shall be secure, in the sense that unauthorized access shall be prevented, and also in the sense that the data shall be survivable and recoverable in the case of system and/or software failures.

• Integrity: Provisions shall be made to protect the integrity of SMCS data – data shall not be changed except by authorized users, with audit logs.

Data management is considered a high-priority feature. Lack of sufficient data management capabilities could reduce user participation with the SMCS, which limit the effectiveness of the SMCS tool.

3.3.2 Use Case

The use case for data management is shown in Figure 7. A sequence diagram is not included because the specific message exchange sequences are expected to vary significantly depending on the nature of the data queries, update, deletions and so forth.

Figure 7. Data Access Use Case

More detailed definition of behaviors shall be defined by the contractor with government approval.

3.3.3 Functional Requirements

The following requirements in Table 4 shall be implemented:

Table 4. Data Management Requirements

Rqmt 014 The SMCS shall accept revisions to a Coordination Request or Notification and shall store those revisions in the history of the Request/Notification.

Rqmt 016 The SMCS shall alert the SBE and AFC if ENG or DoD users (respectively) own precoordinated access records that have not been updated or reviewed in the last year.

Rqmt 016a The SMCS shall maintain an attribute on all records which tracks the "last date modified or reviewed".

Rqmt 025 The SMCS shall provide a mechanism for the SBE to enter known upcoming events (with locations and channel requirements).

Rqmt 025a The SMCS shall provide a calendar pick list feature when entering upcoming events, Coordination Requests, or Notifications into the database.

Rqmts 025b When the SBE is entering upcoming events, the SMCS shall provide a pick list feature for selection of the AFCs whose operations might be affected by those events.

Rqmt 026 The SMCS shall provide authorized users with the ability to edit their own equipment records

Rqmt 031 The SMCS shall maintain a history of all modifications to Coordination Requests, which will include the changes made, timestamp, and the modifying user.

Rqmt 031a The SMCS shall restrict access to Coordination Request Histories to users with appropriate permissions.

Rqmt 032 The SMCS shall provide a list of ENG precoordinated access frequencies for each AFC AOR broken down by each DoD installation

Rqmt 033 The SMCS shall have a data export function that will allow authorized users to select data and then export that data in a selected format (e.g., .csv, or .xls).

Rqmt 036 The SMCS shall allow all authorized users to update their own records for equipment, equipment attributes, ownership, and location data.

3.4 Data Analyses

3.4.1 Description and Priority

The SMCS shall provide analytical capabilities to the user. These capabilities are not required in the initial SMCS build; however, data analysis capabilities are a high priority function for early implementation in future versions of SMCS. The data analysis capabilities required shall include, but not be limited to:

• Transmitter-receiver interference analyses

• Line of sight calculations

• Additional analytical capabilities will be defined as the project proceeds.

3.4.2 Stimulus/Response Sequences

Stimulus/Response sequences for the analysis functions have not yet been defined.

3.4.3 Functional Requirements

Full functional requirements for the analysis functions have not yet been defined; however, the following requirements in Table 5 shall be met:

Table 5. Data Analysis Requirements

Rqmt 008 The SMCS shall provide a response form to be filled out by SBE, AFC, or SMO that contains the choices “approve”, “deny”, “rejected with proposed restrictions”, and “approved with restrictions.” For any choice other than approve, this form shall allow the user to populate the following information, pick list of possible reasons (level the interference threshold was exceeded, coverage plots showing location of SBE transmitters was exceeded) and a list of possible mitigation (i.e. "movement to another location," "alternative frequencies," "temporal suggestions," and "antenna pointing angles/height") and a free text "Comment" field. The SMO can also upload analysis revised documents.

Rqmt 011 When SBE requests a channel be returned to the broadcasters, SMCS shall provide SBE a form that includes a list of proposed restrictions of DoD equipment operations including: movement to another location, alternative frequencies, temporal suggestions, antenna pointing angles/height, and free text. SMCS shall allow the data on this form to be modified by the AFC and then returned to SBE.

Rqmt 013 SMCS shall allow the SMO Service user to upload analysis documents as attachments to the Coordination Request prior to sending the Coordination Request to the AFC.

Rqmt 021 Twenty-four hours after a Notification has been submitted via SMCS, the SMCS shall send alerts to both the SBE and AFC that the Notification is considered approved and shall update the status of the Notification in the SMCS database.

Rqmt 043 The SMCS shall maintain a status on each coordination request or notification

Rqmt 074 The SMCS shall have a drop-down menu to allow DoD to select the appropriate ENG channels when building a coordination request for a given geographical area

Rqmt 075 The SMCS shall allow the SBE national coordinator to send coordination requests to Field Coordinators for review.

3.5 Data Search

3.5.1 Description and Priority

The SMCS shall provide a search capability to all users to conduct searches over the SMCS database. Searches shall be tailorable by combinations of relevant attributes, including (but not limited to):

• Receivers (including their attributes and locations)

• Transmitters (including their attributes and locations)

• Geographic regions

• Station attributes (call signs, locations, or other attributes)

• Record IDs

• Other search parameters as negotiated.

3.5.2 Functional Requirements

The following requirements in Table 6 shall be implemented with regards to Data Search:

Table 6. Data Search Requirements

Rqmt 041 The SMCS shall allow authorized users to execute queries for receiver or transmitter locations that meet user-specified criteria.

Rqmt 077 SMCS shall display for a given installation(s), a list of upcoming events that includes the frequency(s). A permission-limited list of multiple installations shall be selectable.

3.6 Data Visualization

3.6.1 Description and Priority

There are a variety of business processes within the spectrum sharing use cases where visualization of the data can prove beneficial. The visualization capabilities that shall be implemented include:

• Geographic contours of interference regions

• Geographic contour of transmitted power at a specified power level

• Maps of ENT receiver locations and/or DoD transmitter locations/operating regions

• Tabular data of receiver or transmitter assets within a specified geographic region

• Tabular data of scheduled frequency assignments or events within a specified geographic region Additional data visualization capabilities will be defined as the project proceeds.

3.6.2 Stimulus/Response Sequences

The data visualization functions are different enough so that the specification of a single sequence is not valuable. As the project proceeds, specific sequences shall be developed jointly between the contractor and the Government.

3.6.3 Functional Requirements

The following requirements in Table 7 shall be implemented with regard to data visualization functions:

Table 7. Data Visualization Requirements

Rqmt 005 The SMCS shall allow any authorized user to request a display that lists all broadcaster upcoming events for a given year that can be sorted by location area and/or date.

Rqmt 042 The SMCS shall be able to display upcoming events in a calendar-like output, filtered by location or channels, in response to user requests.

Rqmt 073 SMCS shall produce a schedule for users to see what has been coordinated for use over time.

Rqmt 076a The SMCS shall provide a single landing page to allow the user that submitted their request/notification to know where in the process their request/notification is.

Allow the user to see the status of all of their coordination requests and notifications (dashboard).

Rqmt 076b The SMCS shall provide the SBE national representative the ability to view the status of all coordination requests under consideration within SBE for oversight purposes.

Rqmt 076c The SMCS shall allow the SBE National Coordinator to take control of the coordination process if no local SBE coordinator is present or if the local coordinator is not available.

Rqmt 077 The SMCS shall allow the local SBE representative(s) the ability to view the status all coordination requests under their purview including an indication of the parties that require consultation.

Rqmt 078 The SMCS shall provide a dashboard of calendar views which depict coordination request and notifications on a given day for a specified location or group of locations..

3.7 Data Sharing and Reporting

3.7.1 Description and Priority

There are several forms of data sharing that shall be implemented within the SMCS. These shall include but not be limited to:

• Data Notifications: When certain types of data or information are entered (specific types to be determined by user groups during development), a notification or alert message shall be generated and sent to specified recipients (nominally the POC as listed within a specified data structure).

• Calendar Notifications & Alerts: Messages sent to specified users / administrators concerning upcoming calendar events

• Collaboration Messages: Messages and/or modified Coordination Requests between the DoD representative and the ENG representative.

• Data Downloads/Transfers: Users (particularly Administrators) shall have the ability to transfer data to other systems (to be specified).

3.7.2 Stimulus/Response Sequences

The data sharing and reporting functions are different enough so that the specification of a single sequence is not valuable. As the project proceeds, specific sequences shall be developed jointly between the contractor and the Government.

3.7.3 Functional Requirements

The following data sharing and reporting requirements in Table 8 shall be implemented:

Table 8. Data Sharing Requirements

Rqmt 001 The SMCS shall support Coordination Requests and Notification communications between the AFC and the SBE as well as within DoD and SBE.

Rqmt 002 The SMCS shall notify a process participant if another process participant generates an action for it.

Rqmt 004a The SMCS shall allow one AFC to select one or more other AFCs to receive Coordination Requests and Notification communications.

Rqmt 006 The SMCS shall provide users with a warning dialog box if and when data for a notification or coordination request coincides with the date of an upcoming event.

Rqmt 017 Provide an alert to the SMO when broadcast system parameters are changed by SBE or when new system data is uploaded

Rqmt 034 Provide users (including the ISM) access to the coordination status of each request.

Status includes: who has the request for action, if the request has a decision, or if the request is in negotiation

Rqmt 075 SMCS shall allow for the exchange of notification and coordination requests between the national and local SBE coordinators

4 External Interface Requirements

4.1 User Interfaces

The primary user interface will be via the open internet (unclassified, commercial internet).

There may be a direct interface for DoD Administrators only to the software via the servers hosting the software.

Via Internet: The primary user interface, for all classes of users, shall be via Internet. The output of all features described in Section 3 shall be provided over the internet connections to the user.

DoD Administrators may also have direct access to the servers that support the SMCS software.

The contractor shall present options for user interfaces at appropriate meetings and design reviews in accordance with the SMCS development contract.

4.2 Hardware Interfaces

Hardware interfaces are not anticipated as necessary for the SMCS. If hardware interfaces are necessary, the contractor shall propose and describe them, with rationale, at appropriate meetings and design reviews in accordance with the SMCS development contract.

4.3 Software Interfaces

No specific interfaces to other software systems are envisioned at this time, although future versions of SMCS may have requirements in this category. As software interfaces are necessary, the contractor shall propose and describe them, with rationale, at appropriate meetings and design reviews in accordance with the SMCS development contract.

4.4 Communications Interfaces

As a standalone web portal system, there are only a limited number of communications interfaces. The contractor shall propose two architecture options: one where administrators access the SMCS via the same internet interface as regular users, and another where administrators access the SMCS via a separate internet interface. The contractor shall present pros and cons of each option at appropriate meetings and design reviews in accordance with the SMCS development contract.

The contractor shall implement Communication Interface requirements as described in Table 9:

Table 9. Communication Interface Requirements

Rqmt 045 The SMCS System of Systems shall have an Internet-capable interface for administrators, DoD users, and commercial users.

Rqmt 046 The SMCS SoS shall be accessible with any standard internet browsers (IE, Chrome, Safari, Firefox)

Rqmt xyz The SMCS SoS shall have a management interface to its host server(s) for management and monitoring.

5 Other Nonfunctional Requirements

5.1 Performance Requirements

Performance requirements are specified in the appropriate preceding sections.

5.2 Safety Requirements

No safety requirements have been specified, since the SMCS SoS does not involve any life critical situations or functions and does not include any personal data or system critical data.

5.3 Security Requirements

The SMCS SoS shall be designed to handle only unclassified data. If there are future expansions that involve data transfers to classified DoD systems, the responsibility for safeguarding classified data shall be borne by the other classified DoD systems, and shall not reside within the SMCS Sos. The following security requirements in Table 10 shall be implemented:

Table 10. Security Requirements

Rqmt 047 The SMCS SoS shall handle only unclassified data.

Rqmt 052 The SMCS SoS shall implement security features that prevent unauthorized access, destruction or modification of data, or modification of software by unauthorized users.

Appendix A Glossary The terms and abbreviations used in this SRS are defined below.

Term or Abbreviation

Definition

AFC Area Frequency Coordinator AOR Area of Responsibility CR Coordination Request DoD Department of Defense DSO Defense Spectrum Organization ENG Electronic News Gathering FTP File Transfer Protocol HTTP Hypertext Transfer Protocol ISM Installation Spectrum Manager MBSE Model Based Systems Engineering SBE Society of Broadcast Engineers (used also to refer to the designated representative of the SBE for interaction with DoD) SMCS Spectrum Management Coordination System SMO Spectrum Management Office SoS System of Systems SXXI Spectrum 21