Using Parameters and Parameter Values Fields
Parameters are a special type of long text field. You can make the default fields visible on item types, but you cannot create new Parameters or Parameter Values fields.
You use these fields to specify valid parameters and parameter values for an item type. Users can then specify the appropriate parameters for individual items.
|
|
As a best practice, avoid using special characters in a Parameter name. You may not get the intended result during Parameter Value substitution. If required, use only the following special characters as they are supported in a Parameter name:
• “_”
• “-”
• “$”
|
Parameters allow you to reuse an item in different contexts by being able to specify unique item values for each context. Parameters are typically used in the requirements management and test management domains. For example, you could have a test case item with parameters that display different values for different test sessions.
|
|
When you launch the Document view or refresh the Document view, the parameter values are not displayed by default. The parameter values are displayed when you click the Parameter Values column. Alternatively, you can enable display of the parameter values in the Document view by inserting a parameter name in any rich text field of the item in the {{parameter name}} format. For example, if one of the parameter name is max_width, insert the parameter name as {{max_width}} in the corresponding rich text field. When you open or refresh the Document view, the view displays the parameter values for the max_width and other parameters in the Parameter Values column.
|
Example
The ABC watch company produces a number of waterproof watch models. Each watch is tested underwater, but the depth requirement is different for each model. If the waterproof depth is a parameter value, then the same test can be used for each model, but the value of the depth parameter will change based on the model being tested. If there are multiple tests for the different amounts of time the watch should work underwater, making the depth a parameter also ensures that if the depth requirement for a model changes, all the tests for that model would use the new value.
Windchill RV&S determines what parameters can be specified and what parameter values are substituted in text fields based on items that are related to the item being edited or viewed.
How Windchill RV&S Determines Parameters and Parameter Values for an Item
Windchill RV&S uses the following process to determine the parameters and parameter values that display in a Parameter Values field when viewing an item, and that are substituted for parameter names in short and long text fields when viewing an item.
Windchill RV&S searches a hierarchy of items that are related to the current item. It searches for parameters and parameter values that are defined in the related item, or that are shared with the related item through a Field Value Attribute (FVA) field backed by a parameters or parameter values field.
The following hierarchy of related items is considered when determining parameters and parameter values for an item:
1. Shared parameters from a related project item. For example, the related project item has an FVA field that displays a parameter value from the application item.
2. Parameters defined in the related project item.
3. Shared parameters from a related test session item.
4. Parameters defined in the related test session item.
5. Shared parameters from a related document content item linked through a Shares relationship.
6. Parameters defined in a related document content item linked through a Shares relationship.
7. Shared parameters from the closest related document root item, for example, a test suite.
8. Parameters defined in the closest related document root item.
The next two steps only apply when substituting parameters in FVA fields backed by a text field with parameter substitution, or when substituting parameters in text fields for items in a relationship table field.
9. Shared parameters from the item containing the backing field or from the item represented by the table row.
10. Parameters defined in the item containing the backing field for an FVA field or in the item represented by the table row.
11. Shared parameters on the current item.
12. Parameters defined in the current item.
Parameter values higher in the hierarchy are overridden by parameter values lower in the hierarchy, unless the parameter value is locked, in which case the value locked at the highest point in the hierarchy is used. If the relationship does not exist, Windchill RV&S skips that step and continues down the hierarchy.
|
|
If you change a parameter value in an item, and you have an item that is lower in the hierarchy open, you must refresh the view of the lower level item in order to see the updates.
|
Example
The ABC watch company produces a number of waterproof watch models. Each watch is tested underwater, but the depth requirement is different for each model. The waterproof depth is a parameter.
If the following parameters and parameter values are defined:
• The project item for the new waterproof watches has a Depth parameter with a value of 25 metres.
• The test suite for watch model A has a Depth parameter value with a value of 25 metres.
• The test suite for watch model B had a value of 10 metres.
• The test cases, which are shared across the test suites for watch models A and B, specify the depth parameter in a text field: {{Depth}}.
When viewing the test cases for the model A test suite, a value of 25 metres displays in the text field.
When viewing the test cases for the model B test suite, a value of 10 metres displays in the text field.
