ARAS Requirements Engineering Student Guide Version 12.0R1

Page 1 Requirements Engineering Student Guide

Copyright © 2018 by Aras Corporation. This material may be distributed only subject to the terms and conditions set forth in the Open Publication License, V1.0 or later (the latest version is presently available at http://www.opencontent.org/openpub/). Distribution of substantively modified versions of this document is prohibited without the explicit permission of the copyright holder. Distribution of the work or derivative of the work in any standard (paper) book form for a commercial purpose is prohibited unless prior permission is obtained from the copyright holder. Aras Innovator, Aras, and the Aras Corp "A" logo are registered trademarks of Aras Corporation in the United States and other countries. All other trademarks referenced herein are the property of their respective owners. Microsoft, Office, SQL Server, IIS and Windows are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Notice of Liability The information contained in this document is distributed on an "As Is" basis, without warranty of any kind, express or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose or a warranty of non-infringement. Aras shall have no liability to any person or entity with respect to any loss or damage caused or alleged to be caused directly or indirectly by the information contained in this document or by the software or hardware products described herein.

Revision JANUARY 2020

Page 2 Table of Contents

Unit 1 Introduction ...... 5 Unit 2 Requirements ...... 17 Unit 3 Requirement Relationships ...... 31

Page 3 Requirements Engineering Student Guide

This page intentionally left blank.

Page 4

Unit 1 Introduction

Overview: In this unit, you are introduced to the Aras Requirements Engineering application and you learn about some of its features.

For additional information, please refer to the following guides: • Aras Requirements Engineering 12.0R1 - User Guide • Aras Requirements Engineering 11.0R1 - Installation Guide • Aras Requirements Engineering 12.0R1 - Administrator Guide • Objectives: ✓ Describe the features of Requirements Engineering

Page 5 Requirements Engineering Student Guide

Requirements Engineering (RE)

▪ The editor is based on Tech Individual Requirements Docs Framework are Reusable ▪ Includes Requirement flexibility

▪ Includes Visual Collaboration

Editing and Collaboration on full Requirement Document

Requirements Engineering (RE) Aras Requirement Engineering supports a set of use cases for the authoring and editing of documents, as well as requirements, and links to those requirements.

Page 6 Unit 1 – Introduction

Why embed Requirements into PLM?

Source: Forrester, March 2018 Requirements management remains an obstacle for IoT product development, in large part due to siloed tool sets.

Why embed Requirements into PLM? Management of requirements is important for any company that is developing products based upon customer needs. This is becoming more critical with the ever-increasing complexity of products and systems. Requirements allow you to: • Express the needs of a customer • Understand what the product is supposed to do • Identify key building blocks of products & systems • Verify that you are building what you mean to build • Define & validate your design and quality goals

As such, requirements are: • Part of the overall system configuration • An important IP asset • Critical to the ability to develop complex systems

Aras Requirements Engineering supports the capture, tracing, and validation of requirements throughout the development process.

Page 7 Requirements Engineering Student Guide

Requirements Engineering (RE) Licensing

▪ Requirements Engineering does not require a Subscription license

Requirements Engineering (RE) Licensing The Requirements Engineering application does not require a Subscription license.

Page 8 Unit 1 – Introduction

Requirement Reuse

▪ Requirements can be created without a Requirement Document

▪ The same Requirement can be assigned to multiple Requirement Documents

Requirement Reuse In RE, you can create a Requirement without a Requirement Document. And, you can assign the same Requirement to multiple Requirement Documents. You create Requirements independently from Requirements Documents. You can also create a Requirement from within a Requirements Document. Regardless of how a you create a Requirement, any Requirement can be related to any number of Requirements Documents.

Page 9 Requirements Engineering Student Guide

RE Metadata editing

▪ Requirement and Requirement Document metadata is edited in Form views

▪ Includes standard PLM item attributes such as Release and Lifecycle states

▪ Includes categorization via customizable lists and tags

RE Metadata editing You edit Requirement and Requirement Document metadata in their Form views. Requirement and Requirement Document items include standard PLM item attributes such as Release and Lifecycle states. They also include categorizing them using customizable lists and tags: • Type (classification) (required) • Category (list) • Group (list) • Tier (list) • Complexity (tag) • Priority (tag) • Risk (tag)

The Type defines the structure of the Requirement content (the TDF XML elements). • This definition can’t be revised once the Requirement is saved. • The application is configured with identical definitions for all Type selections.

Page 10 Unit 1 – Introduction

Relationships

▪ Requirements and Requirement Documents can be related to multiple PLM items via the Form view

▪ The Documents tab allows them to be related to Aras documents

▪ The Related Parts tab allows them to be linked to a Part

▪ The External Links tab allows them to be linked to a Part

▪ Outgoing and Incoming Links allows them to be linked to an item of the same type

Relationships Aras Requirements Engineering supports a set of use cases for the authoring and editing of documents, as well as requirements, and links to those requirements.

Page 11 Requirements Engineering Student Guide

Tabular view of Requirement Document

▪ The Requirement Document Form presents a tabular view of the related Requirements as Content

▪ The table can be sorted by any column, Table rows can be filtered by values, and Table cells can be edited

▪ Requirement Content edits are done in the Editor view

Tabular view of Requirement Document You can create Requirements independently from Requirements Documents. You can also create Requirements from within a Requirements Document. Regardless of how you create a Requirement, every Requirement can be related to any number of Requirements Documents. The Requirement Document Form presents a tabular view of the related Requirements as Content. You can sort the table by any column. You can filter Table rows by values and the Table cells can be edited. You perform Requirement Content edits such as Add, Remove, and Chapter manipulation in the Editor view.

Page 12 Unit 1 – Introduction

Requirements and Requirement Documents

▪ The Requirement Document Editor (view) shows all related Requirements as chapters

▪ The Chapter tree allows Insertion, Removal, and Shifting of Requirements

▪ Requirement content is dynamically aggregated into a single HTML rendered document

▪ Requirement content and structure can be edited in this view

Requirements and Requirement Documents The Requirement Document Editor (view) shows all related Requirements as chapters. While the Chapter tree allows you to insert, remove, and shift Requirements. As you work, Requirement content is dynamically aggregated into a single HTML rendered document. And, you can edit Requirement content and structure in this view. You can also use find to search text throughout the aggregated content.

Page 13 Requirements Engineering Student Guide

Document view of a Requirement

▪ Requirement Content is edited and viewed as an HTML rendered document

▪ TDF (Tech Doc framework) allows unique document structure definitions per type of Requirement

▪ Users manipulate structural elements in the document via an Element Tree pane

▪ Users create permissible content in the Content panel

▪ TDF supports an extensive list of content elements

Document view of a Requirement Requirement Content is also edited and viewed as an HTML rendered document. The TDF (Tech Doc framework) allows unique document structure definitions per type of Requirement. As a user, you can manipulate structural elements in the document using the Element Tree panel. The TDF supports an extensive list of content elements, some of which are: • Text • List • Graphics • Table

In addition, you use the Content panel to create and edit the permissible content for each structured element.

Page 14 Unit 1 – Introduction

Visual Collaboration

▪ Requirements and Requirement Documents items are integrated with the Visual Collaboration panel

▪ Requirement content is not yet supported with markups

Visual Collaboration Requirements and Requirement Documents items are integrated with the Visual Collaboration panel; however, Requirement content is not yet supported with markups.

Page 15 Requirements Engineering Student Guide

Summary

In this unit, you learned about the Aras Requirements Engineering application. You should now be able to: ✓ Describe the features of Requirements Engineering

Page 16

Unit 2 Requirements

Overview: In this unit, you learn how to create both a Requirement and a Requirements Document and add Requirements to a Requirements Document.

Objectives: ✓ Create a Requirement ✓ Edit a Requirement ✓ Create a Requirements Document ✓ Add a Requirement to a Requirements Document ✓ Create a Requirement from within a Requirements Document

Page 17 Requirements Engineering Student Guide

Create a new Requirement

Create a new Requirement You can create Requirements independently from Requirements Documents. You can also create Requirements from within a Requirements Document. Regardless of how you create a Requirement, every Requirement can be related to any number of Requirements Documents. To Create a Requirement: You can create Requirements by using the right mouse button on Requirements in the TOC and selecting Create New Requirement from the context menu. Or, you can click on Requirements in the TOC and then on the Requirements Item panel, click Create new Requirement. 1. Create a new Requirement. 2. The system automatically populates the following fields when you save the item record. • Requirement Number • Revision • State

Saving a new Requirement with one of the save commands completes its definition and exposes the Editor view for creating content.

Page 18 Unit 2 – Requirements

4. Fill in Type field (required). • Type defines the structure of the Requirement content (TDF XML elements). • This definition cannot be revised once the Requirement is saved. • The application is configured with identical definitions for all Type selections. 5. Fill in the rest of required fields • Managed By defines who manages the Requirement. • Complexity, Priority, and Risk capture various characterizations of the Requirement. The application does not interpret these fields in any way. 6. Fill in other fields (optional). • The Owned By field defines who owns the Requirement. • The Category, Group, and Tier fields capture various characterizations of the Requirement. The application does not interpret these fields in any way. 7. Define relationships (optional) A Requirement can relate to various other items. Unless otherwise indicated, these relationships involve items managed by the Aras PLM platform.

 Try It – Create a Requirement In this exercise, you create a new requirement. 1. Login to Aras Innovator as the user pestudent with password innovator. 2. From the TOC, open the Requirements Engineering category. 3. Create a new requirement and fill in the following fields:

Title Managed by Owned by Type Category RE Requirements RE Requirements Overview Requirement Configuration Manager Engineer

4. Save the Requirement item.

Saving a new Requirement completes its definition and exposes the Editor view for creating content.

Page 19 Requirements Engineering Student Guide

Edit Requirement content

Requirement Editor

Element Tree Content Panel

How to Edit Requirement content Saving a new Requirement completes its definition and exposes the Editor view for creating and editing content. 1. Open an existing Requirement and click on the Requirement Editor icon (visible after you save the Requirement for the first time). • The Editor toolbar shows editing commands applicable to the selected content element • The Element tree shows the element tree of the Requirement content • The Content panel shows a document view of the Requirement content

2. Right mouse click anywhere over the empty space of the Element tree or the Content panel to display the Content Element selection menu and select an appropriate content element action. • You can find the details of the Technical Document Framework (TDF) content editing in the Technical Documents User Guide. • If you are an Aras Subscriber, you can refer to the Technical Documents Online Learning course. • Some elements require the insertion of additional elements (such as Text for a List-Item) to be able to enter text.

3. Clicking either the Save or the Done button saves the Requirement content.

Page 20 Unit 2 – Requirements

 Try It – Edit Requirement content In this exercise, you edit a Requirement’s content. 1. With the Requirement open from the previous exercise, click to open the Requirement Editor (side bar). 2. In the Requirement Editor, right click an empty area in the Element Tree panel and select Add > Text. 3. In the Content panel, enter the following text: Information provided in this section provides an overview of the document’s purpose. Hint: You can use Windows Cut and Paste functionality for the Text element. 4. Click the Done button to save and unclaim the Requirement item.

 Try It – Add additional requirements You can add new requirements from within an existing requirement. 1. With the requirement tab open from the previous exercise, click the More (3 ellipses) button, and select Create New Requirement. 2. Enter the following data into the new requirement:

Title Managed by Owned by Type Category Requirements Requirements Printer Overview Requirement Configuration Manager Engineer

3. Save the Requirement and open the requirement Editor and add a Text element with the folowing (or similar) text. (Hint: You can use Windows Cut and Paste functionality.) The intent of this guide is not to introduce new requirements, but to explain appropriate existing requirements and standards with supplemental considerations to address the best route to conformity for devices and their chosen markets.

4. Click the Done button to save and unclaim the Requirement item.

Page 21 Requirements Engineering Student Guide

5. Add three more requirements using the following data. (You can use Windows Cut and Paste functionality for the Text element.) Title Managed by Owned by Type Category Requirements Requirements Requirements Requirement Configuration Manager Engineer [Text element} Information provided in this section defines requirements. Requirements Requirements Primary Use Requirement Configuration Manager Engineer [Text element} The printer shall be designed for short runs of hand-held mechanical parts and/or assemblies. Size and Requirements Requirements Requirement Configuration Movability Manager Engineer [Text element} The printer shall be designed as a desk/table top unit that can be readily moved by no more than two people.

6. Save and Unclaim each Requirement. 7. Close all open tabs when finished.

Page 22 Unit 2 – Requirements

Create a new Requirements Document

Requirements Document Editor

Create a Requirements Document You can create Requirements Documents by using the right mouse button on Requirements Document and selecting Create New Requirements Document from the context menu. Or, you can click on Requirements Document in the TOC and then on the Requirements Document Item panel, click Create new Requirements Document. 1. Create a new Requirements Document. 2. The system automatically populates the following fields when you save the Requirements Document Item record. • Requirements Document Number • Revision • State

Saving a new Requirements Document with one of the save commands completes its definition and exposes the Requirements Document Editor view for creating and editing content. 3. Fill in the rest of required fields • The Managed By field defines who manages the Requirements Document. • The Title defines the Requirements Document title.

4. Fill in other fields (optional) • The Owned By field defines who owns the Requirements Document. • The Category, Group, and Tier fields capture various characterizations of the Requirements Document. The application does not interpret these fields in any way.

The initial Save creates the Requirements Document item and exposes the Requirements Document Editor button.

Page 23 Requirements Engineering Student Guide

 Try It – Create a Requirements Document 1. Create a New Requirements Document and enter the following field values:

Field Value Managed By Requirements Manager Title Printer server and client requirements Owned By Requirements Engineer Description Printer server and client requirements Category Configuration

2. Save the Requirements Document item.

Saving a new Requirements Document with one of the save commands completes its definition and exposes the Editor view for creating content.

Page 24 Unit 2 – Requirements

Add a Requirement to a Requirements Document

Editor toolbar

Content panel

Chapter tree

Element tree

How to add a Requirement to a Requirements Document Open a Requirements Document for content editing by clicking on the Requirements Document Editor button. • The Editor toolbar shows editing commands applicable to the selected content element. • The Chapter tree shows chapter assignments/organization of the related Requirements. • The Element tree shows the element tree of the selected Requirement content. • Content panel shows an aggregated content view of all the related Requirements.

Right mouse click anywhere in the Chapter tree open area and select an appropriate action.

The system adds new Requirements as a new Chapter in the Requirements Document just below the selected chapter. • Create Requirement displays a dialog window for a new Requirement. • Pick Requirement displays a search dialog window to select from existing Requirements. • Paste pastes a copy of a previously copied Requirement.

There are several ways you can add a second indented requirement. • One, right click an empty area of the Chapter Tree, pick the requirement, right click and choose Move > Indent. • Two, right click the last indented requirement, pick the requirement, right click and choose Move > Unindent.

Page 25 Requirements Engineering Student Guide

 Try It – Add a Requirement to a Requirements Document In this exercise, you add Requirements to a Requirements Document. 1. With your Requirements Document open from the previous exercise, click to open the Requirements Document Editor. 2. Right mouse click an open area in the Chapter Tree and click to select Pick Requirement. 3. In the Search dialog window, search for and select the Overview requirement you created earlier in this course. 4. Insert an indented requirement by right clicking on the Overview requirement, selecting Pick Requirement, and choosing the Printer Overview requirement. 5. Create a second “Chapter” by clicking an open area in the Chapter Tree and again clicking to select Pick Requirement. 6. This time select the Requirements requirement. 7. Create an indented requirement by right clicking on the Requirements requirement, selecting Pick Requirement, and choosing the Primary Use requirement. 8. Repeat the previous step to create a second indented requirement by choosing the Size and Movability requirement, and then indenting appropriately. 9. Your Chapter tree should look like this one:

10. If Primary Use is listed second, you can use the RMB and choose Move > Up (or down, indented, unindented.) 11. If Size and Movability is indebted too much, you can use the RMB and choose Move > Unindented (or up, down indented.) 12. Save the Requirements Document.

Page 26 Unit 2 – Requirements

 Try It – Create a Requirement from within a Requirements Document In this exercise, you create and add a Requirement to a Requirements Document from within the Requirements Document. 1. With your Requirements Document open from the previous exercise, right mouse click an empty area in the Chapter Tree, and click to select Create Requirement. 2. In the New Requirement dialog box, enter in the following field values:

Field Value Managed By Requirements Manager Title Printer – Client Workstations Owned By Requirements Engineer Type Requirement Category Configuration

3. Click off the dialog box in an empty area to close it and save the Requirements Document item.

 Try it – Edit a Requirement from a Requirements Document You can also edit a Requirement from within a Requirements Document by opening it from within the Requirements Document. 1. In the Chapter Tree, right mouse click on the new Requirement you just added (Printer – Client Workstations) and click to select View Requirement. Notice that the Requirement opens in a new tab. It is the same as if you opened it from the Requirements Search Grid. 2. With the Requirement open, click the Edit button, and change the Title to: Printer – Server Workstations. 3. Save the Requirement, open the Requirement Editor, right mouse click in the Content Panel, and choose Add > Table. 4. In the (Table) Attributes Dialog box, choose 3 Columns and 4 Rows, then click the OK button. 5. Before you can enter text into the table, for the Table Entry element (Table Cell), you must Insert a Graphic, a List or a Text element. 6. In the first Table cell (Entry element), right click, and choose Insert > Text. 7. For the text, enter: Processor.

Page 27 Requirements Engineering Student Guide

8. Continue Inserting Text elements using the following table: Hint: You can simply tab to the next table cell, right mouse click, and Insert > Text.

Processor RAM Free HD Space Two 2 GHz 4 GB 2 GB HD / 100 Or one 2 GHz w/ dual core Add 2 GB ea 15K users Add 1 CPU ea 15K users

9. Save the record and then use the formatting toolbar to both Bold and Center the table’s first row of text. Hint: Click the Entry element in the Element tree panel to display the formatting toolbar and use it to center the text.)

10. Save and Unclaim (click Done) and Close the Requirement. 11. Notice the changed requirement in the Requirements Document. 12. Save and Unclaim (click Done) and Close the Requirements Document.

Page 28 Unit 2 – Requirements

Summary

In this unit, you learned how to create both a Requirement and a Requirements Document and add Requirements to a Requirements Document. You should now be able to: ✓ Create a Requirement ✓ Edit a Requirement ✓ Create a Requirements Document ✓ Add a requirement to a requirement document ✓ Create a Requirement from within a Requirements Document

Page 29 Requirements Engineering Student Guide

This page intentionally left blank.

Page 30

Unit 3 Requirement Relationships

Overview: In this unit, you learn about the various relationships available to Requirements, how to add a Requirement or Requirements Document to a part.

Objectives: ✓ Describe the available Requirements relationships ✓ Link a Requirements Document to a part

Page 31 Requirements Engineering Student Guide

Define Requirement relationships

▪ The Documents tab allows to relate various types of documents with a Requirement

▪ The Related Parts tab allows you to see what Parts are related to the Requirement

▪ The External Links tab allows you to create links to information external to the PLM platform

▪ The Outgoing Links tab allows you to relate other Requirements with the Requirement

▪ The Incoming Links tab allows you to see what other Requirements are related to the Requirement

Define Requirement relationships A Requirement can relate to various other items. Unless otherwise indicated, these relationships involve items managed by the Aras PLM platform. The Documents tab allows you to relate various types of documents with this Requirement: • These relationships imply dependency of this Requirement on the related items. • To create a new relationship, click on the Documents tab and then click on the New relationship button in the tab's tool bar. • There are two types of Documents that can be related: a Document item or a Requirements Document item. • Selection of a Requirements Document indicates that it was derived from this Requirement.

The Related Parts tab allows you to see what Parts are related to this Requirement. These relationships are created from Parts (as opposed to the Related Parts tab) and they do not imply dependency of the Requirement on these related items. The External Links tab allows you to create links to information external to the PLM platform • This information is not managed by the Aras PLM platform but it may provide some context for this Requirement. • These relationships are created in a similar way to the Documents relationships.

The Outgoing Links tab allows you to relate other Requirements to this Requirement. • These relationships are created in a similar way to the Documents relationships. • The Selection of a Requirement indicates that it was derived from this Requirement.

The Incoming Links tab allows you to see what other Requirements are related to this Requirement. These relationships are created from the related Requirement's Outgoing links tabs (as opposed to this Requirement's Outgoing links tab) and they do not imply dependency of the Requirement on these related items.

Page 32 Unit 3 - Requirement Relationships

Add a Requirement or Requirements Document to a Part

Add a Requirement or a Requirements Document to a Part Use the Requirements or the Requirements Document tabs to associate a Requirement or a Requirements Document with a part. The Related Parts tab on the Requirement or the Requirements Document show displays the related parts. These relationships are created from Parts and they do not imply dependency of the Requirement on these related items.

 Try It – Add a Requirement and a Requirement Document to a Part In this exercise, you add a Requirements Document to a part item. 1. From the TOC, open the Design category and click to select Parts. 2. Search for and open the C4704AX DesignJet 2000CX Printer for editing. 3. Open the Requirements Document tab and click the Add Requirements Document button. 4. In the Search dialog window, find and select the Printer server and client requirements Requirements Document. 5. Click the OK button. 6. Save and Unclaim (click Done) and Close the Part item record.

Page 33 Requirements Engineering Student Guide

Summary

In this unit, you learned how to create both a Requirement and a Requirements Document and add Requirements to a Requirements Document. You should now be able to: ✓ Describe the available Requirements relationships ✓ Link a Requirements Document to a part

Page 34