Property-Set method
Use this method to set the value of one or more specified properties.
Parameters
The Property-Set method uses an array of parameters. Each row of the array contains a property name or reference (the destination), and a value (the source). Order is significant.Parameter | Description |
PropertiesName |
Enter one or more target property references. If you precede the property with
a period but no page name, the system expects this property to be on the step page.
If the
Step Page
field for this step is blank, the system
uses the primary page of the activity.
For example:
For
|
PropertiesValue |
Enter an expression to compute a value for each property. For example. you can
enter:
|
Results
If the step page does not exist, the system creates a new page of the class identified in the Pages & Classes tab.
The system evaluates each expression identified in the properties values column of the parameter array and assigns the result to the property or property part you identified in the corresponding PropertiesName column.
Any property messages previously associated with the property are cleared.
If the Type of the expression doesn't match the Type of the destination, the value is converted following the same scheme as within expressions. See Data type conversions (casting) in expressions and property assignments.
Each property value is validated against the property rule.
Rows are processed in sequence, so a property that is set in one row (as a destination) may be a source in a later row.
Cautions
- You cannot use this method for a property that is also the target property of a Declare Expression rule.
- Do not attempt to set the value of a property that has a name starting with pz; changes to such properties are reserved.
- Use the standard activity Work-.UpdateStatus — not this method — to change the value of a work item status ( pyStatusWork property).
Checking the method status
This method updates the pxMethodStatus property. See How to test method results using a transition.Previous topic Property-Set-Stream method Next topic Property-Set-XML method