Issuu on Google+

1 About Windchill RequirementsLink Windchill RequirementsLink is a Windchill product that links requirements and product designs so that you can assess the impact of both design and requirement changes, while improving the ability to consistently meet design standards and customer needs in support of Systems Engineering practices. Windchill RequirementsLink facilitates management of requirements through all stages of the product development. With Windchill RequirementsLink, you can capture market and customer needs using several different tools. You can create requirements as discrete objects from any context folder browser toolbar or from within a specification. Rich text formatting allows you to provide a robust description. Requirements come with several attributes such as priority or health status that can be used to facilitate analysis and ranking activities. Your site can add additional attributes to meet your specific needs. You can organize requirements into specifications or sections within a specification to manage your requirements as a set. The Specification Structure table, available from the specification information page, provides a workbench for creating, modifying, and organizing requirement structure and changes to the requirements over time. A Microsoft Word import feature, available from any context folder browser toolbar, allows you capture requirement specifications that have been written in Microsoft Word. You must format your specification using specific Microsoft Word styles so that Windchill RequirementsLink can correctly identify the sections, requirements, and descriptions of the specification. Once imported into Windchill RequirementsLink, you can continue to evolve the content by using Windchill’s web-based user interface. You can export your specification into HTML or PDF format, but you cannot export a specification from Windchill RequirementsLink and import it back into the system. You can use Microsoft Excel to create and edit requirements by importing and exporting the requirements into and from Windchill RequirementsLink. If, for example, you want to work on authoring requirements while not connected to Windchill RequirementsLink, you can download an Excel spreadsheet from the File menu from any context folder browser. You can use the spreadsheet that you download as a template for entering your requirements. The template has columns

1


for the various requirement attributes and some built-in constraints specific to the definition of requirements at your site to make it easy to work in this mode. Exporting and importing requirements to Excel is an efficient way to edit requirement attributes and make mass changes to a single attribute value (such as changing the priority of all of your requirements). However, if you need to provide requirement descriptions with complex descriptions that include tables and formulas, you should create and evolve your requirements using the Windchill RequirementsLink user interface and importing to Microsoft Word. You can capture the current content of your specification at any time by creating a baseline of the specification. You will want to create baselines for events such as product development milestones prior to exporting your specification to send to a customer. You can view your baselines from the Specification Structure table on the specification information page. You can compare your last baseline with your current specification to get details on how your specification has changed. You can assign life cycles and workflows to manage the definition of requirements and the approval of requirement specifications. You can also track the change history for requirements and specifications and compare two iterations to see the differences. Information comparison allows you to compare attributes, specification structure changes, and links. With Windchill RequirementsLink, you can manage and communicate formal change to requirements and specifications using the standard change processes and revision control in Windchill. Requirements traceability documents the relationships between requirements and other development objects. Traceability helps project managers and engineers understand the relationships that exist between requirements and requirements-related information, resulting in better visibility to requirements, a better ability to understand design intent, and a better ability to assess the impact of a change. In Windchill RequirementsLink, traceability is established by linking a specification, section, or requirement to another object from various information pages. You can add links between individual requirements within and across specifications, and to any design data managed in Windchill. Windchill RequirementsLink provides four different link types: derive, verify, satisfy, and allocate. Different types of Windchill objects can be linked depending on the link type. Your site can configure the types of links and the objects that can be linked for each link type. In Windchill RequirementsLink, you can view single-level or multi-level traceability to analyze design intent or the impact of a change from the information page of an object. You can use the orphan requirements report, available from the Reports tab, to illustrate which requirements have been overlooked in design. You can generate a traceability matrix report to show where and how requirements are satisfied. Marking links as suspect provides a lightweight change mechanism to notify users working on deliverables downstream in the product development process that their definitions may need to change, based on the changes made to the upstream object. 2


You can mark a link as suspect when editing a requirement or use the Mark Downstream Links Suspect action. You can clear suspect links from traceability tables after you have had an opportunity to analyze the upstream changes. You can use Windchill RequirementsLink to ensure that requirements are verified properly by establishing verification requirements that describe the method (for example, test or simulation) to use to verify that requirements are met by underlying designs or the final product. Verification requirements can be established at each level of requirement decomposition in your system design. When defining requirements, you can identify the function, performance, or other requirements in a specification that require verification. You can create verification requirements that define how requirements are verified during validation and verification processes and organize them into text specifications. Finally, you can establish traceability between requirements and verification requirements to ensure all appropriate requirements have an appropriate verification requirement. Using Windchill RequirementsLink reports you can monitor track and report on requirement verification status, progress, and results.

3


2 About Requirements A requirement is a condition or capability needed by a user to solve a problem or achieve an objective. In Windchill RequirementsLink, you can create requirements, manage them as discrete objects, and establish traceability between requirements, the product structure, and other design data managed in Windchill. Windchill RequirementsLink has built-in support for verifying requirements. You can group requirements into a specification or a section within a specification so they can be managed as a set. Windchill RequirementsLink can be tailored to manage the types of requirements and traceability links needed by your company. Windchill RequirementsLink is shipped with two types: a requirement and a verification requirement. A requirement has a unique identifying number, name, description, and other attributes to support the product development process Related Links Requirement Information Page Requirement Attributes Creating a Requirement About Verification Requirements Creating a Verification Requirement About Requirements Traceability

4


Requirement Information Page This information page is a collection point for all information related to a requirement, including its description and attributes. The entire description of a requirement is displayed near the top of the information page. Other information is accessible, such as tables with history, related objects, collaboration, and so forth. The information page of a requirement is accessed by clicking the information icon or selecting View Information in the actions list of a table. When you navigate to the information page for a requirement, single-level traceability tables from the related objects menu are shown by default. The single-level traceability tables allow you to see the traceability links defined for the requirement. From the information page, you can perform actions on a requirement as well as view attributes and all related information. Status The information page displays the requirement icon . The following images can appear to indicate the Windchill status of the requirement. Ima ge

Status

Description

Pending change

Indicates that a revision has been proposed to a released version of the object. The pending change indicator provides advanced warning, so that proper planning can take place.

Shared from PDM

Indicates that the object is being shared from PDM. Shared object are readable in the project and are viewable by members of that project.

Shared to ProjectLink

Indicates that the object is being shared with a project. When an object is shared to a project, the owner of that object can still modify it within PDM.

Requirement Actions The following actions, listed in alphabetical order, are available for working with the requirement. The availability of these options depends on the status of the requirement as well as your access to it.

5


Note

If you are not viewing the latest iteration of the requirement, a Go to Latest link appears next to the actions list. You cannot see actions to change the requirement if you are viewing a non-latest iteration. Clicking the Go to Latest link takes you to the latest copy of the requirement.

6

Action

Description

Add Downstream Traceability Link

Creates a traceability link between the requirement and another object (such as requirement, part, or document) downstream in the product development process. This link indicates that the downstream object is in some way dependent upon the requirement.

Add to Baseline

Initiates the operation to add the most recent iteration of the requirement to a baseline. You can search for an existing baseline or create a new baseline.

Add to My Notebook

Opens the Add to My Notebook window, allowing you to select a folder location in your notebook in which to create a link to this requirement.

Add to Project

Share or check out the requirement to a project. Sharing causes a requirement to be visible in the project. Checking out causes a project-specific version of the requirement to be created in the project. That version can be modified and then checked back into the product from which it was checked out. The window displayed when you select Add to Project allows you to set whether the object is shared or checked out.

Add Upstream Traceability Link

Creates a traceability link between the requirement and another object (such as requirement, part, or document) upstream in the product development process. This link indicates the requirement is in some way dependent upon the upstream object.

Copy

Copies the requirement to the clipboard, from which it can be pasted to a new location. The window displayed when you paste the requirement within a project allows you to set whether the requirement is shared or checked out.

Delete

Opens the Delete window to delete a requirement and any associated objects. You can delete all iterations of each selected object, delete all revisions of each selected object, or delete the latest iterations of each selected


Action

Description object.

Delete Non-latest Iterations Edit

Removes all but the most recent iteration of the current revision of a requirement. Opens the Edit Requirement window from which you can modify the attributes of the requirement. You must have modify content permission if the requirement has attachments that you want to edit. Note

Requirements are automatically checked out and checked back in when you perform this action. Information Compare

Allows you to compare the details of this requirement with another requirement.

Manage Security

Opens a window from which you can display and update the current permissions on the requirement for any user, group, or organization that you can access. If you have the required permissions, you can change the current access control permissions that are in place for the requirement. For help on using this action, click the help icon that is on the Access table in the window. If security labels are enabled for your system, you will have a Security Labels tab. Clicking the tab allows you to view and set the security label values for each label defined for the requirement.

Mark Downstream Links Suspect

Indicates that downstream objects may require action or review. Marking links as suspect provides an informal change notification mechanism to notify users working with object downstream in the product development process that the content of their design artifacts may need to change based on the changes made to the upstream object.

Move

Transfers all versions of the requirement to a different location.

New Change Request

Creates a new change request for the requirement. A change request can be created in response to one or more problem reports or without any reference to a problem report.

New Problem Report

Creates a new problem report for the requirement. A problem report is created to document a problem or

7


Action

Description request a product enhancement.

New Verification Requirement

Promote

Creates a verification requirement for this requirement. The default name of the verification requirement created is Verify requirement name. A verify link is automatically added between the requirement and its verification requirement. Creates a promotion request to advance the requirement to another life cycle state. Tip

Use Promote for a set of requirements and Set State to set the state of an individual requirement. Reassign Life Cycle State

Allows you to reassign the life cycle template for the requirement. This action is shown only if the user preference has been enabled.

Set State

Allows you to change the life cycle state of the requirement. If the requirement is currently part of one or more workflow processes, the processes are listed on the dialog. You can terminate a related workflow process by selecting the Terminate running related processes check box.

Subscribe

Allows you to subscribe to one or more events associated with the requirement.

Requirement Attributes A subset of attributes, which communicates the unique identity of the requirement, appears on the top of the page. . The description also appears in its entirety at the top of the page. Click More Attributes to view the other attributes available for the requirement. For descriptions of the requirement attributes, see Requirements Attributes. On the More Attributes table, the following actions are available. Icon

Description Opens the Edit Requirement window where you can modify requirement attributes, if you have the necessary access permission. Allows you to enter characters or numbers to find in the table.

8


Related Links About Requirements

Requirement Attributes The following table describes (in alphabetical order) attributes related to requirements. Attributes are values that you enter when creating or editing a requirement, or properties that are assigned to a requirement. The attributes display in fields and columns throughout Windchill. Note

Your site may define other attributes for a requirement in addition to those that appear below. Also, your site determines which attributes display, whether they are mandatory or optional, and the order and grouping of the attributes. Field

Description

Contact

The person acting as the owner of the requirement. This is the person to contact for questions or issues related to the requirement. This field is required.

Context

The specific product, library, project, or program with which the requirement is contained.

Created By

The person who created the requirement.

Created On

The date the requirement was created.

Description

Serves as the main content of a requirement. Requirement descriptions can include tables, be expressed using rich text formatting, and can be augmented with file-based content managed as attachments to the requirement’s description. Note

Rich text formats include such things as bold and italic font settings, bulleted or numbered lists, and so forth.

9


Field

Description This formatting appears wherever the description displays. There are limitations with using all the rich formats in the Microsoft Excel integration and for Windchill Business Reporting Reports.

Health Status

Indicates the health of a requirement. A typical use of Health Status is to indicate whether a requirement is valid (that is, whether or not the requirement is technically feasible). For example, if the requirement is new and hasn’t been implemented in the past, the owner may set the Health Status to Red until a more detailed engineering evaluation has confirmed that underlying requirements or designs can fulfill this requirement. At that point, the Health Status can be set to Green. If the requirement is well understood at the time of creation, its Health Status can be set to Green. Available options are: ● Unavailable ● Green ● Yellow ● Red

Last Modified

The date and time the requirement was last updated.

Life Cycle Template

The template that determines the life cycle process used for the requirement.

Location

The folder where the requirement is stored in the database.

Modified By

The person that last modified the requirement.

Name

Identifies the name or short description of the requirement. The name is used as a way to quickly and easily identify a requirement in tables and views without having to view its entire description. This field is required when you create a new requirement. Enter up to 150 characters.

Number

Uniquely identifies the requirement through either a default–generated number or through a number generated according to your site rules. Note

10


Field

Description Microsoft Word and Excel integrations require that your site automatically generate the number.

Priority

Indicates the relative importance of the requirement. The priority is typically in relation to the other requirements in a specification, but it can also be used to indicate priority relative to other requirements in a folder, project, product, or some context determined by the contact for the requirement. Possible values are: ● Unavailable ● High ● Medium ● Low

State Status

The current life cycle state of the requirement. Identifies the status of the requirement within Windchill. Possible values are: ● Checked-out from PDM— indicates that the requirement has been checked out from PDM to the project. Requirements checked out from PDM are locked in their original location, and a project-specific version of the requirement is created in the project. ● Shared from PDM—indicates that the requirement is being shared from a product or library. Shared requirements are readable in the project and are viewable by members of that project.

Team Template

The team template associated with the requirement.

Type

The type of the requirement and is required when you create a new requirement. The options available depend on the types created and used at your site. Your Windchill RequirementsLink system is shipped with two requirement types: Requirement and Verification Requirement.

Verification Required

The indication of whether the requirement must be verified. This attribute is typically determined by the

11


Field

Description creator and is used to generate status reports related to requirement verification.

Version

The revision and iteration of the requirement (for example, A.1).

Related Links About Requirements

Creating a Requirement Use the following procedure to create a requirement. To access the New Requirement window, click the new requirement icon on the toolbar of the Folder Contents and Specification Structure tables or select File▶ New Requirement from the Folder Contents table. Note

A requirement is always created within the context (for example, the product or project) in which you are currently working. If you want to create a requirement in a different context, you must first switch to that context. Creating a requirement from within the specification structure automatically associates it as a direct member of the specification or as a direct member of a section if you are working within a section of a specification. The New Requirement window divides the creation of the requirement into the following steps: Tip

Steps do not necessarily need to be completed in the order in which they are listed. You may navigate to any step for which the link is enabled. A link is only enabled for a step when that step is completed. 1. Define Object — Identifies the context (such as the product or library) in which the requirement belongs and allows for identifying the type. 2. Set Attributes — Identifies descriptive attributes for the requirement. For descriptions of requirement attributes, see Requirement Attributes.

12


Note

You have the ability to use rich text formatting for the description of a requirement. This formatting appears wherever the description displays. 3. Set Attachments — Attaches file-based content managed as secondary content to augment the requirement. 4. If you would like the window to remain open for you to create additional requirements, click Apply. Click Finish to complete the creation of the requirement. The requirement appears at the bottom of the table, with the row highlighted momentarily. The new requirement is linked to the specification if the action is launched from the Specification Structure table. Related Links About Requirements

About Verification Requirements A verification requirement is a special type of requirement designed to work with the base requirement type to capture and track the verification methodology, verification status, and verification results associated with a requirement. A verification requirement addresses whether the product, its elements, interfaces, and incremental work products satisfy their requirements. One or more verification requirements, describing how the requirement is verified, can point to a single requirement. The verification requirement states the methodology that is used to verify the requirement and the acceptance criteria that is used to judge the verification status of a verification requirement (for example, the verification requirement description or values of specific attributes on the verification requirement object, can describe its acceptance criteria). Multiple verification requirements can point to a single requirement because several different methods of verification may be used to test specific criteria. A verification requirement can also point to several requirements. The methodology and acceptance criteria can be used to verify portions of one or more Requirements.

13


Related Links About Requirements

Creating a Verification Requirement You can create verification requirements can be created either from a toolbar action or from a row level action of a requirement. If you create a verification requirement from a row level action, a Verify link is created between the requirement from which the action was launched and the verification requirement. Use the following procedure to create a verification requirement. To access the New Verification Requirement window, select the New Verification Requirement action from the actions list of a requirement in the Folder Contents table or on the information page of a requirement. You can also create a verification requirement by selecting the new requirement icon from the toolbar of the Folder Content table. Note

A requirement is always created within the context (for example, the product or project) in which you are currently working. If you want to create a requirement in a different context, you must first switch to that context. The New Verification Requirement window divides the creation of the requirement into the following steps: Tip

Steps do not necessarily need to be completed in the order in which they are listed. You may navigate to any step for which the link is enabled. A link is only enabled for a step when that step is completed. 1. Define Object — Identifies the context of the object and that it is a verification requirement type. Note

If you selected the new requirement icon from the toolbar of the Folder Content table, select Verification Requirement from the Type drop-down. If you launched New Verification Requirement as a requirement action, the Verification Requirement type is already determined. 2. Set Attributes — Identifies descriptive attributes for the requirement. For descriptions of requirement attributes, see Requirement Attributes.

14


Note

You have the ability to use rich text formatting for the description of a requirement. This formatting appears wherever the description displays. 3. Set Attachments — Attaches files you want to associate with the requirement. If you would like the window to remain open for you to create additional verification requirements, click Apply. Click Finish to complete the creation of the requirement. The requirement appears at the bottom of the table, with the row highlighted momentarily. The new verification requirement is linked to the originating requirement by a Verifies trace link. Related Links About Requirements

About Requirements Traceability Requirements traceability is the ability to describe and follow how a requirement is flowed-down or decomposed into further detail, through its development in both a forward and backward direction. It allows you to track a requirement from its origins, through its development and specification, to its subsequent deployment and use, and through periods of on going refinement and iteration in any of these phases. Requirements come from different sources (for example, a marketing person describing customer needs within a particular market segment) and flow down through the design process (for example, a systems engineer decomposing the requirement into technical requirements) until they are implemented in a component design. Requirements traceability is the interrelationships among requirements and other important related product data. Traceability is established by associating, or linking, a requirement to another supported object. Traceability helps project managers and engineers understand the relationships that exist between requirements and requirements-related information, resulting in better visibility in Engineering to requirements, a better ability to understand design intent, and a better ability to assess the impact of a change. There are downstream and upstream traceability links. An object with a

15


downstream link to a requirement is in some way dependent on that requirement. For instance, consider Requirement A and Requirement B. A and B are linked with a Derive type link. B is downstream from A. This means that B is derived from A. So B is the downstream object, and it is dependent on A in some way because if A changes, B may need to change. So, in reverse, requirement (or any object) with an upstream— linked object is somehow dependent upon that upstream object. Related Links Multi-Level Traceability Upstream Traceability Table Downstream Traceability Table Single-Level Traceability Specification Membership Table About Requirements

Multi-Level Traceability Multi-level traceability allows a user to understand both direct and indirect links between requirements and other objects. It is the ability to traverse the network of links to understand indirect relationships between the requirement and other objects. The complete picture provided by multi-level traceability is especially useful for tasks such as analyzing a requirement in conjunction with a change request. From the information page of a requirement, select Related Objectsâ–ś Multi-Level Traceability . The lower portion of the page displays two tables: the Upstream Traceability table and the Downstream Traceability table. At the top of each table is the requirement that is in the current context (for example, the requirement you are tracing to or from). Expanding on a node in the traceability tree allows you to see all the requirements directly linked to that node. Expanding the nodes in the tree allow you to see the entire graph of requirements. Related Links

16


About Requirements Traceability

Upstream Traceability Table The Upstream Traceability table can be accessed by selecting the Multi-Level Traceability from the Related Objects navigation menu on the specification, section, or requirement information page. Expanding a node in the Upstream Traceability table (using the expand glyph to that object.

) shows you all upstream traceability links related

Changing the Table View You can choose what is displayed in the Upstream Traceability table by selecting a view from the View drop-down list at the top of the table . The drop-down list includes a view for each type of link provided by Windchill RequirementsLink and Default, which displays all upstream traceability links. Column Information The columns available in the Upstream Traceability table give you specific information about the objects listed. Columns such as Name, Link Type, Number, Actions, and Version may appear. Actions The following actions may be available on the Upstream Traceability table toolbar: Icon

Description Click the remove icon to remove any selected objects from the table, removing the link relationship. Click the clear suspect icon to remove the suspect link on the selected object, indicating that you have evaluated the change. Click to open the Add Upstream Traceability Link window, allowing you to add traceability links to the selected object or, if no object is selected, to the root of

17


Icon

Description the table. Click to locate a string value in the table.

Related Links About Requirements Traceability

Downstream Traceability Table The Downstream Traceability table can be accessed by selecting the Multi-Level Traceability from the Related Objects navigation menu on the specification, section, or requirement information page. Expanding a node in the Downstream Traceability table (using the expand glyph to that object.

) shows you all upstream traceability links related

Changing the Table View You can choose what is displayed in the Downstream Traceability table by selecting a view from the View drop-down list at the top of the table. The drop-down list includes a view for each type of link provided by Windchill RequirementsLink and Default, which displays all upstream traceability links. Column Information The columns available in the Downstream Traceability table give you specific information about the objects listed. Columns such as Name, Link Type, Number, Actions, and Version may appear. Actions The following actions may be available on the Downstream Traceability table toolbar:

18


Icon

Description Click the remove icon to remove any selected objects from the table, removing the link relationship. Click to open the Add Downstream Traceability Link window, allowing you to add traceability links to the selected object or, if no object is selected, to the root of the table. Click to locate a string value in the table.

Related Links About Requirements Traceability

Single-Level Traceability Note

Single-level traceability displays, by default, on the lower portion of the information page of a requirement. Single– level traceability is a view that quickly and easily allows you to see a single-level representation of requirements traceability for a single object, so that you can view the direct relationships in both directions. Select Related Objects▜ Single-Level Traceability from the information page of the object. Two tables are displayed horizontally separated by the icon representing the context object. The table on the left contains the directly-related objects upstream from the context object, the table on the right contains directly-related objects the downstream from the context object. The Single-Level Traceability pane displays the directly-related object between the Related Upstream Objects table and the Related Downstream Objects table. Clicking the name of an object in either table results in navigating to the information page of that object and automatically loads the single-level traceability of that selected object.

19


Column Information The columns available in the Related Upstream Objects table give you specific information about the tasks listed. Columns such as Number, Name, and Association Type may appear by default. You can define your own views to add or remove columns if the wish. The same columns appear in the Related Downstream Objects table, but are in the reverse order. If a downstream link has been marked suspect, that is that downstream objects may require action or review, there is suspect status glyph in the Related Downstream Objects table indicating the link has been marked suspect. Actions The following actions may be available on either table toolbar: Icon

Description Click the add icon to add either upstream or downstream traceability links. Click the find in list icon to enter characters or numbers you want to locate in the table.

The following row action may be available on either table: Icon

Description Click the remove icon to remove either upstream or downstream traceability links.

Related Links About Requirements Traceability

Specification Membership Table The Specification Membership table appears on the lower portion of the specification or specification member information page by selecting the Specifications from the Related Objects navigation menu.

20


The Specification Membership table displays all specifications and sections of which the current object is a member. The table indicates the relationship of the object to the members in the table as direct or indirect. Direct means the current object is a direct child of the member. Indirect means that the current object is an descendant of the member but not a direct child. The top-level specification is always the first entry in the Specification Membership table. For example, if you are on the information page of a requirement that belongs to a section that belongs to a specification, the table displays the section as the last line and indicates the membership as Direct, and the line above displays the specification to which the section belongs and indicates the membership as Indirect. Column Information The columns available in the Specification Membership table give you specific information about the objects listed. Columns such as Name, Number, Membership, Actions, Version, State, and Context may appear. Actions The following action may be available on the Specification Membership table toolbar: Icon

Description Click to locate where a string value appears in the table.

Most actions available from the information page of an object are also available as row actions in the Specification Membership table. Related Links About Requirements Traceability

21


3 Modifying Requirements

22


Editing a Requirement Note

To edit a requirement, you do not have to explicitly check it out. The system does it for you. The object is checked out for you and your changes are checked in automatically when you click Finish. If you have the necessary permissions, you can do the following: ● Change the name and description ● Change the health status, contact, and priority attributes ● Indicate that verification is required ● Add, remove, or edit attachments ● Add comments From the requirement information page or as a row action of the requirement in the Folder Contents table or the Specification Structure table, select Edit from the actions list. If this action does not appear in the list, you do not have the permissions required. The Edit Requirement window divides the editing of a requirement into three steps: 1. Set Attributes Add, change, replace, or remove attributes. 2. Set Attachments Use the Attachments table to add, remove, or edit any attachments which are meaningful in the context of this requirement. For more information, access the online help from the Attachments table. 3. Add Comments Add comments that would provide information about the edit. 4. After making the desired changes, click Finish. A new iteration of the requirement is created. You can use the Iteration History table (see History▶ Iteration on the information page) to compare changes made to a requirement during an edit session.

Revising a Requirement If you want to indicate that a significant change is being made to the requirement (for example, an update changes the intent of a requirement), you can create a new

23


revision of the requirement. Your requirement must be in a revisable state (revisable states can be configured by your site; the default is that you cannot revise a requirement in the In Work state). If you have the necessary permissions, you can select New Revision from the information page actions or from the row-level actions. You can also use the File▶ New▶ Revision from the folder browser. Note

When you have successfully created a new revision, the traceability links are automatically carried forward to the new version. You need to assess where these traceability links still apply and remove any links that are no longer relevant for the new revision of the requirement. You can view the Revision History table by selecting Revision from the History navigation menu.

Deleting a Requirement The following restrictions apply: ● You must have delete permission for the requirement. ● The requirement cannot be linked to a specification ● Any of the iterations of the requirement cannot have downstream or upstream traceability links. ● The requirement should not be involved in a pending change ● The requirement should not be a part of baseline You can delete a requirement in the following ways: ● Clicking the delete icon

in the folder browser toolbar

● Selecting Edit▶ Delete from the folder browser. ● Selecting the row-level action. ● Selecting the action from the information page of the requirement.

24


4 About Specifications In Windchill RequirementsLink, you can formally collect requirements into a specification, which typically describes the set of requirements that need to be met by a project, product, or component within a product. . This specification has a unique identifier, consisting of name, number, and version. It has an optional attributes, such as description, related secondary content, its own life cycle A specification can contain one or more specifications, one or more sections, and one or more requirements. A requirement, section, or specification can belong to only one specification. Sections are used to hierarchically organize requirements. The requirements in a specification are a flat list. For example, if you want to organize all your performance requirements together, create a section called Performance to organize and add all the performance-related requirements to this section within the specification. You can create specifications from the folder browser. The New Specification window allows you to define attributes and attachments associated with the specification. Building the structure of the specification, including the sections and requirements is done from the specification information page, using the Specification Structure table. A specification is also created automatically when a Microsoft Word document is imported (if you have the Windchill RequirementsLink license to author requirements in Microsoft Word). You can create a baseline of your specification to reflect its contents at various points in time. You can view baselines of your specifications in the Specification Structure table by selecting the baseline name in the View drop-down. You cannot add more than one version of a requirement to a specification. The requirements, sections, and specifications in a specification are the latest iteration of the version of the objects added to the specification. If a later version of specification member is available, the later version does not automatically appear in the specification. If there is a newer version of the requirement, you can see the glyph what glyph is this and how can I address how to add the latest revision of a requirement to the spec that indicates a newer version of the requirement exists. You can use the Member Status view on the Specification Structure table to determine if a later revision is available. When revising a specification, the existing requirement version is carried forward.

25


The latest specification structure view does not reflect that the requirements within a section or specification have changed. The Member Status view on the Specification Structure table displays status if new members have been added or if members have been removed or modified since the last baseline. In addition to adding traceability links to individual requirements, you can also add traceability links to the specification as a whole. Any existing traceability links associated with a specification included in a parent specification are visible when viewing traceability links for the parent specification. Related Links Specification Information Page Specification Attributes Creating a Specification Adding a Specification Member to a Specification Sections Specification Structure Table Specification Membership Table Removing a Specification or Specification Member Saving a Copy of a Specification Using Drag-and-Drop in the Specification Structure Table

26


Specification Information Page This information page displays information about a specification and allows you to interact with it. The information page of a specification is accessed by clicking the information icon or selecting View Information in the actions list of a table. When you first navigate to the specification information page, the Structure navigation menu in the lower portion of the page displays the Specification Structure table. From the information page, you can perform actions on a specification as well as view attributes and additional information. Windchill Status The information page displays the specification icon . The following images can appear to indicate the Windchill status of the requirement. Image

Status

Description

Pending change

Indicates that a revision has been proposed to a released version of the object. The pending change indicator provides advanced warning, so that proper planning can take place.

Checked out to a project

Indicates that the object has been checked out to a project from PDM, resulting in the creation of a project-specific version of the object. Objects checked out to a project can still be modified in PDM.

Checkedout from PDM

Indicates that the object has been checked out from PDM to the project, such as during the Add to Project operation. Objects checked out from PDM are locked in their original location, and a project-specific version of the object is created in the project.

Shared from PDM

Indicates that the object is being shared from PDM. Shared object are readable in the project and are viewable by members of that project.

Shared to ProjectLi nk

Indicates that the object is being shared with a project. When an object is shared to a project, the owner of that object can still modify it within PDM.

27


Specification Actions The following options, listed in alphabetical order, are available for working with the specification. The availability of these options depends on the status of the specification as well as your access to it.

28

Action

Description

Add Downstream Traceability Link

Creates a traceability link between the specification and another object (such as requirement, part, or document). This link indicates that the downstream object is in some way dependent upon the specification.

Add to Baseline

Initiates the operation to add the most recent iteration of the specification to a baseline. You can search for an existing baseline or create a new baseline.

Add to My Notebook

Opens the Add to My Notebook window, allowing you to select a folder location in your notebook in which to create a link to this specification.

Add to Project

Share or check out the specification to a project. Sharing causes a specification to be visible in the project. Checking out causes a project-specific version of the specification to be created in the project. That version can be modified and then checked back into the product from which it was checked out. The window displayed when you select Add to Project allows you to set whether the object is shared or checked out.

Add Upstream Traceability Link

Creates a traceability link between the specification and another object (such as requirement, part, or document) upstream in the product development process. This link indicates that the upstream object is in some way dependent upon the specification.

Convert Type

Opens the Convert Type window, allowing you to convert the specification to another type.

Copy

Copies the definition of the specification and any attachments to a new location. You can rename your copy when you paste it to the new location. Use the Save As action if you want to copy the specification and all of its members.

Delete

Opens the Delete window to delete a specification and any associated objects. You can delete all iterations of each selected object, delete all revisions of each selected object, or delete the latest iterations of each selected object. The delete operation deletes only the specification and the member links. If you want to delete all the requirements and sections of a


Action

Description specification you must explicitly collect them.

Delete Non-latest Iteration

Removes all but the most recent iteration of the current version of a specification.

Download Excel Template

Provides a correctly-formatted template to use with Microsoft Excel.

Edit

Opens the Edit Specification window from which you can modify the attributes of the specification. You must have modify permissions for the specification.

Export to File

Opens the Export to File window, allowing you to export the specification to a PDF file or to an HTML page.

Information Compare

Allows you to compare the details of this specification with another specification.

Manage Security

Opens a window from which you can display and update the current permissions on the specification for any user, group, or organization that you can access. If you have the required permissions, you can change the current access control permissions that are in place for the specification. For help on using this action, click the help icon that is on the Access table in the window.

Mark Downstream Link Suspect

Indicates that downstream objects may require action or review. Marking links as suspect provides an informal change notification mechanism to notify downstream consumers that their definitions may need to change based on the changes made to the upstream object.

Move

Transfers all versions of the specification to a different location.

New Change Request

Creates a new change request for the specification. A change request can be created in response to one or more problem reports or without any reference to a problem report.

New Problem Report

Creates a new problem report for the specification. A problem report is created to document a problem or request a product enhancement.

New Requiremen t

Creates a new requirement and adds it to the specification.

29


Action

Description

New Revision

Creates a new revision of the specification. This action is available only if you have permission to revise a specification.

New Section

Creates a section that can be used to organize requirements within a specification. They can be thought of as organizational nodes within a tree that allow requirements, other sections, or specifications to be added underneath them.

Promote

Creates a promotion request to advance the specification to another state.

Reassign Life Cycles

Allows you to reassign the life cycle template for the specification. This action is shown only if the user preference has been enabled.

Save As

Makes a copy of the specification and all of its members. Note

Traceability links are not copied when you initiate a Save as operation. Set State

Allows you to change the life cycle state of the specification. If the specification is currently part of one or more workflow processes, the processes are listed on the dialog. You can terminate a related workflow process by selecting the Terminate running related processes check box.

Subscribe

Set up individuals or groups to receive e-mail notifications when certain events or actions occur on an object. For more information about events, access the online help from the Subscribe window.

Specification Attributes In addition to the description of the specification, a subset of attributes that communicate the unique identity of the specification, appears on the top of the page. Click More Attributes to view the other attributes available for the specification. For descriptions of the specification attributes, see Specification Attributes. On the Attachments table, the following actions are available. Icon

Description Allows you to download selected files to another location. Opens the Edit Specification window in which you can modify

30


Icon

Description attributes and attachments, if you have the necessary access permission. Allows you to enter characters or numbers to find in the table.

Related Links About Specifications

Specification Attributes The following table describes (in alphabetical order) attributes related to specifications. Attributes are values that you enter when creating or editing a specification, or properties that are assigned to a specification. The attributes display in fields and columns throughout Windchill. Note

Your site may define other attributes for a specification in addition to those that appear below. Also, your site determines which attributes display, whether they are mandatory or optional, and the order and grouping of the attributes. Field

Description

Contact

The person acting as the owner of the specification. This is the person to contact for questions or issues related to the specification. This field is required.

Context

The specific product, library, project, or program with which the specification is associated.

Created By

The person who created the specification.

Created On

The date the specification was created.

31


Field Description

Description The description is optional. It can be used to provide an introduction or some other free-form commentary about the requirements contained in the specification. Note

Rich text formats include such things as bold and italic font settings, bulleted or numbered lists, and so forth. This formatting appears wherever the description displays. There are limitations with using all the rich formats in the Microsoft Excel Integration and for Windchill Business Reporting Reports. Health Status

Indicates the health of a specification. A typical use of Health Status is to indicate whether a specification is valid (that is, whether or not the specification is technically feasible). Available options are: ● Unavailable ● Green ● Yellow ● Red

Last Modified

The date and time the specification was last updated.

Life Cycle Template

The template that determines the life cycle process used for the specification.

Location

The folder where the specification is stored in the database.

Modified By

The person that last modified the specification.

Name

Identifies the name of the specification. This field is required when you create a new specification. Enter up to 150 characters.

Number

Uniquely identifies the specification through either a default-generated number or through a number generated according to your site rules. If numbers are not generated automatically, enter up to 40 characters. If numbers are generated automatically at your site, the word Generated appears in this field. The requirement number must be unique. Note

Microsoft Word and Excel integrations require that your site

32


Field

Description automatically generate the number.

Priority

Indicates the relative importance of the specification. Possible values are: ● Unavailable ● High ● Medium ● Low

State Status

The current life cycle state of the specification. Identifies the status of the specification . Possible values are: ● Checked-out from PDM— indicates that the requirement has been checked out from PDM to the project. Requirements checked out from PDM are locked in their original location, and a project-specific version of the requirement is created in the project. ● Shared from PDM—indicates that the requirement is being shared from a product or library. Shared requirements are readable in the project and are viewable by members of that project.

Team Template

The team template associated with the specification.

Type

The type of the specification. This is required when you create a new specification. The options available depend on the types created and used at your site.

Version

The revision and iteration of the specification (for example, A.1)

Related Links About Specifications

33


Creating a Specification Use the following procedure to create a new specification. To access the New Specification window, click the new specification icon on the toolbar or select File▶ New Specification from the Folder Contents table. Note

A specification is always created within the context (for example, the product or project) in which you are currently working. If you want to create a specification in a different context, you must first switch to that context. The New Specification window divides the creation of the specification into the following steps: Tip

Steps do not necessarily need to be completed in the order in which they are listed. You may navigate to any step for which the link is enabled. A link is only enabled for a step when that step is completed. 1. Define Object — Identifies specification type. . If there is only one type of specification defined for your site, the window automatically advances through this step. 2. Set Attributes — Identifies descriptive attributes for the specification. For descriptions of specification attributes, see Specification Attributes. Note

You have the ability to use rich text formatting for the description of a specification. This formatting appears wherever the description displays. 3. Set Attachments — Attaches files you want to associate with the specification. 4. Click Finish or Apply to complete the creation of the specification. The specification appears at the bottom of the table, with the row highlighted momentarily. If you click Apply, the New Specification window remains open for you to create additional specifications. Related Links About Specifications

34


Adding a Specification Member to a Specification Use the following procedure to add requirements, sections, or specifications to a specification: 1. The Structure third-level navigation on the information page of the specification displays the Specification Structure table. Click the add specification member icon on the toolbar. 2. The Add Specification Members window appears. 3. Specify the search criteria for the specification member . 4. Click Search to locate specification members matching your criteria. The results are displayed in the Search table. 5. From the Search table, select the requirements you want to add. 6. Click OK to add the requirement. Related Links About Specifications

Sections A section is a member of a specification that helps you to hierarchically organize the requirements within your specification. Sections can contain other sections as members, and this is how hierarchy is built. A section allows you to organize requirements, by grouping them, within a specification. A requirement can belong to only one section. A requirement cannot belong to another requirement. If you want to organize your requirements in a structure, you should use a section to group them. If you want to use a requirement in multiple sections, you must copy the

35


requirement, paste it in the Folder Contents table, create new traceability links for the copy, and copy to the new section. A section can belong to only one specification. If you want to use a section in more than one specification, you will need to initiate a Save As action on the section to create a copy of the section and all of its requirements. You must create new traceability links for the copies. You can determine where a section and it members were copied from by viewing the Save-As History table for the section (select History▶ Save-As on the section information page). Each section has a unique identifying name, number, and other attributes. Note

The default view for the Folder Contents table does not display sections. If you want to view sections in the Folder Contents table, customize your table to display them. Select Customize from the View drop-down at the top of the table. For more information, click the help button on the Customize View List table. The only way to create a new section is within the context of a specification. However, you can convert a specification to a section. Sections can have structure, similar to specifications. Related Links Creating a Section About Specifications

Creating a Section Note

You must have permission to modify the specification and to create a section in order to perform this action. You can create sections from the following locations: ● The actions drop-down list on the specification information page ● The toolbar action on the Specification Structure table

36


â—? A row-level action on a specification in the Specification Structure table â—? The action Import from Word automatically creates sections based on the structure of the Microsoft Word document. See Importing a Specification into Word. You can create sections in a specification by either selecting the specification or by not selecting anything. The section will be created within the root specification. You can create sections within a section by selecting the section and clicking the new section icon on the toolbar. You cannot create sections within a requirement. To create a section, use the following procedure: 1. Click the new section icon on the toolbar of the Specification Structure table or select the New Section action on the specification in the table or on the specification information page. The New Section window opens. 2. Enter the name and the description in the appropriate fields. Entering a meaningful name is important because the name shows up in the Specification Structure table. Description is optional, and it is akin to a short paragraph following a Section title in a document. Note

If security labels are enabled on the system, there is a second step, which is the security label step. 3. Click OK if this is the only section you want to create, click Apply if you would like to continue creating sections without closing the New Section window. The New Section window contains the following fields: Field

Description

Product, Library, Project, or Program

The name of the context in which the section is created. This cannot be changed.

Type

The type is Section.

Name

The identifier for the section. This is a required field.

Description

The description is optional. It can be used to provide an introduction or some other free-form commentary about the requirements contained in the section. Note

You have the ability to use rich text formatting for the description of the section. This formatting appears wherever the description displays.

37


The Attributes table contains the following fields: Field

Description

Number

The numerical identifier of the section. If numbers are generated automatically at your site, the word Generated appears in this field. The section number must be unique.

Health Status

Indicates the health of a section. A typical use of Health Status is to indicate whether a section is valid. For example, if the section is new and hasn’t been implemented in the past, the owner may set the Health Status to Red until a more detailed engineering evaluation has confirmed that underlying requirements or designs can fulfill this section. At that point, the Health Status can be set to Green. If the section is well understood at the time of creation, its Health Status can be set to Green. Available options are: ● Unavailable ● Green ● Yellow ● Red

Contact Priority

The person that is responsible for this section. Indicates the relative importance of the section. The priority is typically in relation to the other sections in a specification, but it can also be used to indicate priority relative to other sections in a folder, project, product, or some context determined by the contact for the section. Possible values are: ● Unavailable ● High ● Medium ● Low

Location

38

The folder where the section is stored in the database. You can change the location by clicking the set location icon and indicating a new location.


Related Links Sections

Specification Structure Table The Specification Structure table appears on the lower portion of the specification information page by default or can be accessed by selecting the Structure navigation menu. You can use drag and drop to reorder your specification members in the Specification Structure table.

Changing the Table View You can choose what is displayed in the Specification Structure table by selecting a view from the Specification Structure View drop-down list above the table. For example, you can choose the Latest view to see the structure view of the latest version of the specification and its members. If you have any baselined versions of the structure, you can select the baseline name from the Specification Structure View drop-down list to view where the specification and its members were at the time of the baseline of the specification. If you customize a view, you use the View drop-down list in the title bar of the Specification Structure table to select your customized view. If you prefer to see the structure as a list, you can select List from the View As drop-down above the Specification Structure table. This view does not provide indentation to show membership. If you prefer to see any changes that have occurred to the structure since the last baseline, you can select the Member Status view while looking at the Latest Specification Structure View. This view shows specification members that have been added, removed, or modified since the last baseline. The following status glyphs may appear in the Member Status view of the Specification Structure table:

Glyph

Description

39


Glyph

Description A member has been removed A member has been changed This is a new member The member is not the latest version. If you think you may want to replace the member with the latest version, click the icon. See Replacing a Requirement with the Latest Version in a Specification

You can also view the historical view of a specification structure by navigating to an earlier iteration of the specification itself. Column Information The columns available in the Specification Structure table give you specific information about the objects listed. Columns such as Name, Number, Actions,and Version may appear. Actions The following actions may be available all on the Specification Structure table toolbar: Icon

Description Click the remove icon to remove any selected objects from the structure. Places the selected objects on the Windchill clipboard Click the expand icon to expand the nodes of the structure to view all objects. Note

The first time you view the information page, the structure expands only one level. Windchill RequirementsLink remembers what you have expanded and collapsed so that when you navigate away and return to the structure, you view it as you left it. When nothing is selected and you click this action, the entire structure is expanded. Click the collapse icon to collapse the nodes of the structure to hide objects.

40


Icon

Description When nothing is selected and you click this action, all is collapsed and only the root is showing. Click to open the Add Specification Member window, allowing you to add requirements to the specification. Click to paste objects that exist on the Windchill clipboard. Click to open the New Section window, allowing you to create a new section. Click to open the New Requirement window, allowing you to create a new requirement and automatically add it to the specification. Click to open the Import from Excel window, allowing you to import an Excel spreadsheetof requirements to create or update. Click to export the requirement into an Excel spreadsheet If you have not downloaded a template the template will automatically be download populated with the requirements.

Related Links About Specifications

Specification Membership Table The Specification Membership table appears on the lower portion of the specification or specification member information page by selecting the Specifications from the Related Objects navigation menu. The Specification Membership table displays all specifications and sections of

41


which the current object is a member. The table indicates the relationship of the object to the members in the table as direct or indirect. Direct means the current object is a direct child of the member. Indirect means that the current object is an descendant of the member but not a direct child. The top-level specification is always the first entry in the Specification Membership table. For example, if you are on the information page of a requirement that belongs to a section that belongs to a specification, the table displays the section as the last line and indicates the membership as Direct, and the line above displays the specification to which the section belongs and indicates the membership as Indirect. Column Information The columns available in the Specification Membership table give you specific information about the objects listed. Columns such as Name, Number, Membership, Actions, Version, State, and Context may appear. Actions The following action may be available on the Specification Membership table toolbar: Icon

Description Click to locate where a string value appears in the table.

Most actions available from the information page of an object are also available as row actions in the Specification Membership table. Related Links About Specifications

42


Removing a Specification or Specification Member Note

You must have permission to modify the parent specification in order to remove a member of the specification. To remove a specification or a specification member , do the following: 1. From the Specification Structure table on the specification information page, select the object you want to remove and click the remove object icon in the toolbar. 2. The Specification Structure table refreshes, showing the object removed. Related Links About Specifications

Saving a Copy of a Specification You can save a copy of a specification by using the Save As action. Selecting the action opens the Save As window, allowing you to set a new location for the specification The Save As action is available from the following places: â—? Row-level action of a specification in the Folder Contents table â—? Action on the specification information page To save a copy of specification, along with all of its members, to a new specification, use the following procedure: 1. Select the Save As action. 2. Enter a name in the Specification Name field. The name of the copied member sections and requirements are retained as is. 3. The default location is that of the original specification. If you want to change that, click the set location icon .

43


4. Click OK to complete the save of the specification. The specification appears at the bottom of the table, with the row highlighted momentarily. An entry appears in the Save-As History table. Related Links About Specifications

Using Drag-and-Drop in the Specification Structure Table When you hover over the type icon of a specification member in the Specification Structure table, you can see a drag-and-drop symbol. The symbol is defined by the browser that you are using. You can then drag the specification member to a new place in the structure. Your drop target is identified by the horizontal line that is displayed. If you drag-and-drop a section, all of its members move with the section. You must have access to any target specification or section. Related Links About Specifications

44


5 Modifying Specifications

45


Editing a Specification If you have the necessary permissions, you can do the following: ● Change the name and description ● Change the health status, contact, and priority attributes ● Add, remove, or edit attachments ● Add comments From the specification information page or as a row action of the specification in the Folder Contents table or Specification Structure table, select Edit from the actions list. If this action does not appear in the list, you do not have the permissions required. The Edit Specification window divides the editing of a specification into three steps: 1. Set Attributes Add, change, replace, or remove attributes. 2. Set Attachments Use the Attachments table to add, remove, or edit any attachments which are meaningful in the context of this specification . For more information, access the online help from the Attachments table. 3. Add Comments Add comments that would provide information about the edit. 4. After making the desired changes, click Finish.

46


6 Comparing Information Use the following procedure to compare information of the same requirement or specification: 1. Select Information Compare from the Actions list on the information page or click the information compare icon on a table toolbar. The Find Object window appears. Note

If you click the information compare icon on a table, you will bypass the Find Object window. In this case, proceed to step 5 to select the comparison options for the report. 2. Enter any desired search criteria and then click Search. The results are displayed in the Search table. 3. From the Search table, select the objects you want to compare. 4. Click OK. The Comparison Options window appears. 5. Select the check boxes to indicate what you want to display in the comparison report. Options may include Select All, Attributes, Attachments, Specification Members, Downstream Linked Objects, Upstream Linked Objects, Specifications

6. Click OK to generate the report. A report appears and displays the results of the comparison. Only information that is different between the comparison objects is shown in the report. Related Links Comparison Report Replacing a Requirement with the Latest Version in a Specification

47


Comparison Report When you compare two or more requirements or specifications by using the Information Compare action on a information page, a Comparison Report window appears. The comparison report includes comparison information on: ● Attributes ● Attachments ● Downstream linked objects ● Upstream linked objects ● Specifications or Specification members, depending on the object Note

Only information that is not the same for compared objects displays. A "--" entry in the comparison report output either means the attribute is not defined or has its value currently not set. Related Links Comparing Information

Replacing a Requirement with the Latest Version in a Specification You can determine if a later revision of a requirement is available. You may or may

48


not want to incorporate the later version into your specification, depending on the circumstances. You can examine the differences between the current version in the specification and the latest version available and replace it, if needed. Select Latest from the Specification Structure View drop-down above the Specification Structure table and select the Member Status table view . This view shows any requirements that have a later version than what is currently in the specification. Selecting the non-latest version glyph opens the Replace With Latest Version window. This window allows you to see the current version and the latest version. Use the following procedure: 1. Click Compare Versions to select the options you want to compare. 2. Click OK to view the Comparison Report. 3. Click Close to return to the Replace With Latest Version window. 4. Click Replace. Related Links Comparing Information

49


7 About Traceability Links Traceability refers to the ability to describe and follow the life of a requirement, in both forwards and backwards direction. Traceability links are used to indicate that relationship. There are four types of traceability links shipped with Windchill RequirementsLink. Your site may have added, removed, or changed the traceability links to meet the needs of your company. The provided links are as follows: ● Allocate ● Derive ● Satisfy ● Verify The following table shows the default link types and objects which can use them: Link Type Allocate

Icon

Description Distributes requirements to features, functions, products, components, parts, and so forth. Note

Features and function can be represented as requirements or parts

Relationship Possibilities Requirement allocates to document, workgroup manager CAD document, part, requirement, section, or specification Verification requirement allocates to document, workgroup manager CAD document, part, requirement, section, or specification Specification allocates to document, workgroup manager CAD documents, part, requirement, section, or

50


Link Type

Icon

Description

Relationship Possibilities specification

Derive

Satisfy

Verify

Shows how an upstream requirement is decomposed into more detail. For example, for the upstream requirement to be met, its downstream derive requirements need to be satisfied by some product design. Another example looks at this from the perspective of the downstream requirement, the upstream requirements it was derived from, illustrates the reason for the requirements existence.

Part derives a requirement, section, or specification Document derives a workgroup manager CAD document, requirement, section, or specification Workgroup manager CAD document derives a requirement, section, or specification Requirement derives a document, workgroup manager CAD document, part, requirement, or specification Verification requirement derives a document, workgroup manager CAD document, part, requirement, section, or specification Specification derives a document, workgroup manager CAD document, part, requirement, section, or specification

Indicates which design Part satisfies requirement, elements fulfill a section, or specification requirement. Document satisfies Note Design elements can requirement, section, or specification be represented as Workgroup manager CAD parts or documents document satisfies requirement, section, or specification Indicates link between requirement and the verification requirement that

Verification requirement verifies a requirement

51


Link Type

Icon

Description fulfills it.

Related Links Adding a Traceability Link Removing a Traceability Link Marking a Traceability Link as Suspect Clearing a Suspect Link

52

Relationship Possibilities


Adding a Traceability Link Use the following procedure to create a traceability link. From the information page of the requirement, select Multi-Level Traceability or Single Level Traceability from the Related Objects third-level navigation menu. Click the add traceability link icon in the toolbar of the tables. From the New Traceability Link window, use the following procedure to create a traceability link: 1. From the Type drop-down list, select the type of traceability link you want to create. 2. You can paste an object from the clipboard or click the add icon . The Find Object window opens, allowing you to search for and select the object to which you want to create a traceability link. If the object you are searching for is not valid for the link type, it is not returned in the search results. 3. After you have selected your object, click OK . The Proposed Linked Objects table is populated with the object. 4. If you want the Add Traceability Link window to remain open for you to create more traceability links, click Apply. Click OK if you have completed adding your traceability links. Related Links Adding an Upstream Traceability Link Adding a Downstream Traceability Link About Traceability Links

Adding an Upstream Traceability Link A upstream traceability link is one that indicates that the current object is in some way dependent upon the upstream object. For example, since the customer requirement is upstream from the system requirement, the system requirement is in some way dependent upon the customer requirement. If the customer requirement is modified, the owner of the system requirement should evaluate the modification to

53


determine whether the system requirement needs to be modified also. Use the following procedure to create a upstream traceability link: 1. From the action list on the information page of a specification or specification member or as a row-level action, select New Upstream Traceability Link. The Add Upstream Traceability Link window opens. 2. Select the type of traceability link from the Type drop-down list. For more information, see About Traceability Links. 3. You can paste an object from the clipboard or click the add icon . The Find Object window opens, allowing you to search for and select the object to which you want to create a traceability link. If the object you are searching for is not valid for the link type, it is not returned in the search results. 4. After you have selected your object, click OK. The Upstream Traceability Link table is populated with the object. 5. If you want the Add Upstream Traceability Link window to remain open for you to create more traceability links, click Apply. Click OK if you have completed adding your traceability links. Related Links Adding a Traceability Link

Adding a Downstream Traceability Link A downstream traceability link is one that indicates that the downstream object is in some way dependent upon the current object. Use the following procedure to create a downstream traceability link: 1. From the action list on the information page of a specification or specification member or as a row-level , select New Downstream Traceability Link. The Add Downstream Traceability Link window opens. 2. Select the type of traceability link from the Type drop-down list. For more information, see About Traceability Links. 3. You can paste an object from the clipboard or click the add icon . The Find Object window opens, allowing you to search for and select the object to which

54


you want to create a traceability link. If the object you are searching for is not valid for the link type, it is not returned in the search results. 4. After you have selected your object, click OK . The Downstream Traceability Link table is populated with the object. 5. If you want the Add Downstream Traceability Link window to remain open for you to create more traceability links, click Apply. Click OK if you have completed adding your traceability links. Related Links Adding a Traceability Link

Removing a Traceability Link Use the following procedure to remove a traceability link: 1. From the information page of the requirement, select Multi-Level Traceability or Single-Level Traceability from the Related Objects third-level navigation menu. 2. Click the remove relationship icon in the toolbar of the Upstream Traceability table or the Downstream Traceability table. When the relationship is removed, the table is refreshed to reflect the changes. Related Links About Traceability Links

55


Marking a Traceability Link as Suspect Suspect flags on traceability links indicate to downstream consumers that modifications have been made. Suspect flags apply only to trace links, not allocate links. Marking links as suspect provides a lightweight change mechanism to notify downstream consumers that their definitions may need to change, based on the changes made to the upstream object. The process of marking a link suspect is manual; the rules of what constitutes a significant change that might impact a design deliverable downstream in the product development process vary greatly. A requirement may be edited to add more detail or to correct a typo, in which case, you would not want to mark a link as suspect because the change would not cause a significant downstream impact. However, a major change to a requirement may be significant enough to require marking links to downstream deliverables. Marking a link as suspect marks only the direct link between the objects (for example, the link between a system requirement and the design requirement). Indirect links that are further downstream (for example, the link between the design requirement and the part) are not marked suspect. Traceability links on parts, documents, CAD documents (Burst Configurations and Workgroup Manager CAD Documents), and requirements can be marked suspect by using the Mark Traceability Links Suspect action on the information page or as a row action of the object. This action is available only if the following conditions are met: ● You have modify permissions on the object ● The object has downstream traceability links ● The downstream traceability links have a suspect attribute A message confirming the action displays. Links that are marked as suspect are indicated by the suspect link glyph in the traceability tables. You can also mark downstream linked objects as suspect when editing a requirement. On the first step of the Edit Requirement window, there is a checkbox labeled Mark Downstream Links Suspect. If this box is checked, then after the successful edit, the suspect flag is set to true for all downstream traceability links with suspect support. Related Links About Traceability Links

56


Clearing a Suspect Link Downstream objects show the links marked suspect on the upstream traceability tree for their objects. When you decide to clear the suspect link, indicating that you have evaluated the change, use the Clear Suspect Link action. To clear a suspect link, use the following procedure. 1. From the Related Objects navigation menu on the information page of the requirement, select Multi-Level Traceability. 2. From the Upstream Traceability table, select the objects on which you want to clear suspect links. 3. Click the clear suspect icon

in the toolbar.

If some of the links selected are not suspect, they are ignored by the action. If none of the links selected are suspect, no action occurs and the object is not iterated. Related Links About Traceability Links

57


8 About Using Microsoft Excel with Windchill RequirementsLink Windchill RequirementsLink allows you to use Microsoft Excel with your requirements. You have the following capabilities: ● Importing an Excel spreadsheet ● Downloading an Excel spreadsheet template ● Exporting requirements to Excel ● Modifying attributes Note

Read the instruction sheet carefully before using the template.

Related Links Exporting to Excel Downloading an Excel Template Importing from Excel Modifying Attributes and Requirements Using Excel

58


Exporting to Excel You can export requirements to a Microsoft Excel spreadsheet. The exported Excel workbook contains a sheet for every requirement type that you can use, even if there are no requirements of that type at the time of exporting. The sheet tabs match the names of the type. Each sheet displays the attributes specific to that type as columns. Note

The workbook will also include any requirement types added by your site. When you export a specification from the Specification Structure table, all selected requirements and the requirements belonging to all selected sections and specifications are exported. If nothing is selected, all the requirements in the specification are exported. You can export requirements when viewing a baseline. All selected requirements and the requirements belonging to all selected sections and specifications are exported. If nothing is selected, all the requirements in the baseline are exported. You can export to Excel in the following ways: ● Select File▶ Requirements▶ Export to Excel from the Folder Contents table ● Select the Export to Excel action on the requirement information page. ● Click the export to Excel icon

in the Specification Structure table toolbar

Use the following procedure to export requirements to a spreadsheet: 1. Select or click the action. 2. Microsoft Excel opens displaying the Requirement sheet. Note

If you see a warning about the file format not matching the file extension, click Yes. 3. The attributes of the requirement display as columns in the spreadsheet. You can edit this Excel workbook, save it as an XML file, and then re-import back into Windchill RequirementsLink Note

The Instructions sheet provides guidelines for working with the Excel workbook. Do not delete the last two sheets of the workbook or any re-import will fail. Related Links

59


About Using Microsoft Excel with Windchill RequirementsLink

Downloading an Excel Template Using the Microsoft Excel template allows you to import requirement information from a Microsoft Excel spreadsheet into Windchill RequirementsLink. This template spreadsheet contains proper formatting of columns. You can download the Excel template by using the Download Excel Template action from the following places: ● File▶ Requirements▶ Download Excel Template from the Folder Contents table ● A row-level action of a specification in the Folder Contents table ● A row-level action of a specification in the Specification Structure table ● An action on the specification information page The Excel template contains the following sheets: ● Requirements—one sheet for each type of requirement defined in Windchill ● Instructions ● Constraints ● Export Information Note

Read the instruction sheet carefully before using the template. Related Links About Using Microsoft Excel with Windchill RequirementsLink

60


Importing from Excel Note

Microsoft Excel 2003 and later versions are supported. If you using Microsoft Excel 2007, be sure to save your spreadsheet as type XML Spreadsheet 2003 (*.xml). You can create requirements by importing a Microsoft Excel spreadsheet.Windchill RequirementsLink provides a pre-formatted workbook template containing sheets for all requirement types. By populating the template correctly, your import will succeed. Use the following procedure to import an Excel spreadsheet: 1. To download the template for use, select File▶ Requirements▶ Download Excel Template from the Folder Contents table. 2. From the Folder Contents table, select File▶ Requirements▶ Import from Excel, or from the toolbar of the Specification Structure table on a specification information page, click the import from Excel icon . Note

You can select a specification into which the requirements will be imported. 3. In the Import from Excel window, click Browse to select the file to import. 4. The Location field displays the location in which new requirements in the spreadsheet are created. If you would like to change the location, click the set location icon to select your new location. 5. Click OK to complete the action. The number of created and modified requirements display. When importing new requirements in the Specification Structure table, they are automatically added to the selected or current specification. If a single specification is selected in the Specification Structure table, new requirements are added to the specification If no specifications are selected in the structure tree, the new requirements are imported under the context-object specification Related Links About Using Microsoft Excel with Windchill RequirementsLink

61


Modifying Attributes and Requirements Using Excel You can use Microsoft Excel to make modifications to attributes of existing requirements and to specify attributes of new requirements. Use the following procedure to modify requirements using an Excel spreadsheet: 1. Export the requirements to Excel. See Exporting to Excel. 2. Make modifications to the requirements in Excel. 3. Import the spreadsheet. See Importing from Excel. 4. Modifications to attributes and any additional requirements are reflected in Windchill RequirementsLink. Related Links About Using Microsoft Excel with Windchill RequirementsLink

62


9 Using Microsoft Word Documents with Windchill RequirementsLink Note

If you belong to the RequirementsLinkAuthorWithWord group, you can use Microsoft Word to author your specification and import it into Windchill RequirementsLink. By importing a Microsoft Word document, you can create a specification with sections and requirements. The names and descriptions of each section and requirement imported are imported. Correctly using Word styles provides you with the ability to have your specification structured with sections and requirements. The import establishes structure which can be manipulated within the Specification Structure table by using drag-and-drop or adding or removing specification members, but you cannot export that structure to Microsoft Word. A sample Word document is available for your use. Related Links Importing a Specification from Word Microsoft Word Styles for Importing Specifications

63


Importing a Specification from Word You can create a specification by importing a Microsoft Word document. The Word import feature begins parsing the document at the first occurrence of the Word style Title. The text of the first usage of the Word style Title is the specification name. Any information before the first occurrence of the Word style Title is ignored. The Word import feature continues parsing the document to the end of the document or until it encounters a second occurrence of the Word style Title. The content represents sections or requirements imported into the specification. Sections are created wherever requirements or subsections exist. Such membership hierarchy builds the specification structure. Word styles Heading 1 through Heading 5 become sections or requirements. When the import is complete, the Word document itself is attached to the specification as an attachment. Windchill RequirementsLink supplies a sample Microsoft Word document (WordImportSample.doc) that illustrates how to use Word styles to correctly identify specification membership (sections and requirements) to allow proper importing. You can find the sample document at the following location: <Windchill>\codebase\CambridgeDocs3\SampleData\REQLSamples\

By preparing your Word document correctly, you can import the document and create the specification with correctly ordered structure. Note

At this time, Windchill RequirementsLink supports only Word documents with a .doc extension. Be sure to save your file as that file type. Images in Word documents are not supported and are ignored during the import process. From the toolbar of the Folder Contents table, click the Import from Word icon The Import Specification from Word window divides the operation into the following steps: 1. Define Object â&#x20AC;&#x201D; Identifies the specification type. Select from the Type drop-down list. 2. Select Word Document â&#x20AC;&#x201D; Allows you browse for a Word document and select it. You must also select the type of requirement that will be imported and the location you want the specification, and its sections and requirements to be created, if it should go in a context other than the default. There are other attributes that you can specify, such as Number, Health Status, Contact, Priority, and any soft attributes of the selected type for the specification. Note

The Word document must be formatted correctly in order for the import to build the correct structure in the Specification Structure table.

64


The number must be auto-generated through object initialization rules. 3. Preview Requirements â&#x20AC;&#x201D; Allows you to preview the sections and requirements that will be included in the specification that you import. The structure of the specification is collapsed and shows only the names of the sections and requirements. Click the names to view or hide the content. 4. Click Finish to complete the import of the specification. The specification and any descendant sections and requirements display in the Folder Content table. The Word document is attached to the specification. You are redirected to the specification information page. Related Links Using Microsoft Word Documents with Windchill RequirementsLink

Microsoft Word Styles for Importing Specifications Note

A sample Microsoft Word document is provided with your system. If, however, you would like to format a current Word document to import into Windchill RequirementsLink, use the styles as directed below. In order for a Microsoft Word document to be correctly imported into a specification, the document must use the following styles: Style

Semantics Description

Title

The name of the specification. Any content between style Title and Style Heading 1 is imported into the specification as its description. Any content before the style Title or after the second style Title is not imported into the specification.

Heading 1 through Heading 5

The name of a section or requirement. The content following the name until

65


Style

Semantics Description another name is identified is imported as the description. These styles are also used to establish the member structure within the specification. For example, Heading 2 can be used underneath Heading 1 to represent a child of a member. If the member has children, it will be imported as a section. If the member does not have children, it is imported as a requirement.

Related Links Using Microsoft Word Documents with Windchill RequirementsLink

66


10 Requirements Reports If you have Windchill Business Reporting installed, there are several reports that you can run to determine status of your requirements. They include the following: ● Orphan Requirement Report ● Requirement Verification Needed Report ● Requirement Verification Status Report ● Requirement Traceability Matrix Report Orphan Requirement Report To determine which requirements in a specification have yet to be linked via a specific traceability link type to an underlying requirement, run this report that identifies orphan requirements within the specification. To generate the Orphan Requirement Report, enter values in the following fields: Field

Description

Specification

Enter the name of the specification for which you want the report or click Find to search for the specification.

Traceability Link Type

Select from the drop-down list the appropriate link type. Link types include Downstream Verifies, Upstream Verifies, Downstream Derivation, Upstream Derivation, Downstream Satisfies, Upstream Satisfies, Downstream Allocation, and Upstream Allocation

Click Generate to run the report. The report displays indicating all of the requirements in the given specification that do not have the specified link type established.

67


Requirement Verification Needed Report To determine which requirements in a specification still need to be verified, run this report. The report lists each requirement in the specification that has been identified as needing verification but does not have an associated verification requirement. To generate the Requirement Verification Needed Report, enter the name of the specification for which you want the report or click Find to search for the specification. Click Generate to run the report. The report displays indicating all of the requirement in the given specification that still need to be verified. Requirement Verification Status Report To determine the verification status of all requirements in a specification, run this report. To generate the Requirement Verification Status Report, enter the name of the specification for which you want the report or click Find to search for the specification. Click Generate to run the report. The report displays indicating the status of all of the verification requirements in the given specification. Requirement Traceability Matrix Report To provide a single-level traceability matrix between all requirements found within two specification, run this report. This report is an efficient way to verify the completeness of traceability link definition between two specifications. For example, if you need to confirm that all the requirements in your system specification have a derive link established to all the requirements in a customer requirements document, you can run this report. To generate the Requirement Traceability Matrix Report, enter values in the following fields:

68

Field

Description

Source Specification

Enter the name of the specification you want as your source specification or click Find to search for the specification.

Target Specification

Enter the name of the specification you want as your target specification or click Find to search for the specification.

Traceability Link Type

Select from the drop-down list the appropriate link type. Link types


Field

Description include Verifies, Derivation, Satisfies, and Allocation

Click Generate to run the report. The report displays the traceability matrix.

69


11 About Windchill RequirementsLink Administration There are administrative tasks and information associated with Windchill RequirementsLink. The following topics are provided: ● Configuring Requirements Traceability Links ● Life Cycle Management ● Administering Requirement Authors Groups ● Access Control Utilities Related Links Configuring Requirements Traceability Links Life Cycle Management Administering Requirement Authors Groups Access Control Utilities

70


Configuring Requirements Traceability Links Windchill RequirementsLink is delivered with a set of predefined requirement traceability links. The set of links delivered with the product may be more or less than you need for your site. You can add or remove links and edit the link configuration to fit your specific needs. Any changes made to the link configuration are automatically reflected in the type picker and validation for the Add Upstream Traceability Link and Add Downstream Traceability Link windows. The traceability links types are of type configurable describe link and their definitions can be viewed and edited from the Type and Attribute Manager. There are two types of traceability links defined: Allocate and Trace. Trace links have subtypes defined for Derive, Satisfy, and Verify. Allocate, Derive, Satisfy, and Verify are delivered with predefined relationship constraints. The relationship constraints define the valid parent and child object types that can be created with the link. You can view predefined relationship constraints for the requirement traceability links from the Type and Attribute Manager. You can edit the predefined constraints on the relationship to fit the needs at your site by adding, deleting, or editing the relationship constraints. You can define new types of requirements traceability links by defining subtypes of Requirement Traceability Links, Allocate, or Trace link types. The requirement traceability links are not defined with attributes and you cannot add attributes to requirement traceability links. For the information about configurable links and relationship constraints see the online help accessible from the Type and Attribute Manager. Related Links About Windchill RequirementsLink Administration

Life Cycle Management Requirements, sections, and specifications ship with a default life cycle template that you can use or modify. The states defined for the default life cycle template

71


include In Work, Completed, Accepted, and Obsolete. Default Life Cycle Template Transitions There are transitions defined for the default life cycle template. The transition allows specific actions to complete, provided you have the necessary access control permissions to specific states. All transitions are defined for the Set State and Promote actions. You can promote or set state from any state to any state. The following transitions are defined for the Revise action. ● From Accepted to In Work ● From Completed to In Work ● From Obsolete to In Work The following transitions are defined for the change process actions. ● From In Work to Accepted ● From Completed to Accepted Related Links About Windchill RequirementsLink Administration

Administering Requirement Authors Groups In order to fully use the capabilities of Windchill RequirementsLink, an administrator must add users to an authoring group. RequirementsLink Author Group A group named RequirementsLink Author enables administrators to manage their Windchill RequirementsLink licenses. Add all users who will be using a Windchill RequirementsLink license to this group. Only users in the RequirementsLink

72


Author group are able to view actions to create and edit requirements, sections, specifications, and traceability links. You must also set the required access control permissions for requirements, sections, and specifications; adding users to this group does not automatically create access control rules. Users who are not in the RequirementsLink Author group are able to view requirements objects if their access permissions allow them, but they will not see the actions to manipulate the objects. RequirementsLink Author With Word Group A group named RequirementsLink Author With Word enables administrators to manage their Windchill RequirementsLink licenses allowing interaction with Microsoft Word. Add all users who will be using a Windchill RequirementsLink license with Word to this group. Users in the RequirementsLink AuthorWithWord group are able to do all those things that the RequirementsLinkAuthor group can do and, additionally, import Word documents. Other Groups If you would rather use a different group name to manage your Windchill RequirementsLink licences, you can do so. Change the site preference called Licensed RequirementsLink Authors Group to the name of the group you want to use for your Windchill RequirementsLink Author users. Only users in the group that you specify in the preference are able to view the actions to create and edit requirements, sections, and specifications. Change the site preference called Licensed RequirementsLink Authors with Word Group to the name of the group you want to use for your Windchill RequirementsLink Author with Word group. Related Links About Windchill RequirementsLink Administration

Access Control Utilities Two utilities are provided to jump-start your access control rule definition for Windchill RequirementsLink. Each of these utilities can be run after you have installed Windchill RequirementsLink.

73


The first utility creates the following access control rules for each application context defined at your site:

74

Domain

Type

State

Principal

Grant Permissions

Default

Requirement

All

Team Members

Read, Download

Default

Requirement

All

Collaboration Manager

Change Permission

Default

Requirement

Accepted

Team Members

Revise

Default

Requirement

In Work

Team Members

Modify, Modify Content, Create by Move, Create, Change Domain, Change Context, Delete

Default

Section

All

Team Members

Read, Download

Default

Section

All

Collaboration Manager

Change Permission

Default

Section

Accepted

Team Members

Revise

Default

Section

In Work

Team Members

Modify, Modify Content, Create by Move, Create, Change Domain, Change Context, Delete

Default

Managed Specification

All

Team Members

Read, Download

Default

Managed Specification

All

Collaboration Manager

Change Permission

Default

Managed Specification

Accepted

Team Members

Revise

Default

Managed

In Work

Team Members

Modify, Modify


Domain

Type

State

Principal

Specification

Grant Permissions Content, Create by Move, Create, Change Domain, Change Context, Delete

From windchill shell, run the following command to add Windchill RequirementsLink-specific access rules to all existing products and libraries: windchill com.ptc.windchill.enterprise.requirement.util. REQLContainerACLPatcher

Domain

Type

State

Principal

Grant Permissions

Default

Requirement

All

Team Members

Read, Download

Default

Requirement

All

Collaboration Manager

Change Permission

Default

Requirement

Accepted

Team Members

Revise

Default

Requirement

In Work

Team Members

Modify, Modify Content, Create by Move, Create, Change Domain, Change Context, Delete

Default

Section

All

Team Members

Read, Download

Default

Section

All

Collaboration Manager

Change Permission

Default

Section

Accepted

Team Members

Revise

Default

Section

In Work

Team Members

Modify, Modify Content, Create by Move, Create, Change Domain,

75


Domain

Type

State

Principal

Grant Permissions Change Context, Delete

Default

Managed Specification

All

Team Members

Read, Download

Default

Managed Specification

All

Collaboration Manager

Change Permission

Default

Managed Specification

Accepted

Team Members

Revise

Default

Managed Specification

In Work

Team Members

Modify, Modify Content, Create by Move, Create, Change Domain, Change Context, Delete

From windchill shell, run the following command to add Windchill RequirementsLink-specific access rules to all existing product and library templates: windchill com.ptc.windchill.enterprise.requirement.util. REQLContainerTemplateACLPatcher

Related Links About Windchill RequirementsLink Administration

76


turning effect