Use the Apply-DataTransform method to invoke a data transform for updating an existing clipboard page or pages. (In contrast, use the Page-New method to create a new page and invoke a data transform in a single step.)
The calling activity can share its parameter page with the data transform (by selecting the Pass the current parameter page check box).
This method accepts two parameters:
Parameter |
Description |
| DataTransform |
Specify the data transform to be applied. To locate the data transform with rule resolution at runtime, the system uses the class of the activity's step page (specified in the row on the Activity rule form with the Apply-DataTransform method) as the initial Applies To key part, and searches the class hierarchy for a data transform with the name as specified in this DataTransform field. If the Step Page field is blank for this line on the Activity rule form, the system uses the Applies To key part of the activity as the initial Applies To key part to locate the data transform. Optionally, you can identify the Applies To key part of the data transform explicitly, using the format Apply-DataTransform Data-Admin-Operator-ID.pyDefault The explicit class format causes rule resolution to bypass all class hierarchy searches — the data transform must be present in the specific class identified before the dot. (Other aspects of rule resolution operate normally.) Because use of explicit class names can introduce inflexibility, complicate debugging, and reduce opportunities for rule reuse, avoid this format whenever possible. |
| Pass the current parameter page |
Select to have the values from the activity's parameter page be available to (shared with) the data transform, and vice versa. |
The system finds the data transform rule to invoke using the Applies To class of the step page (or the Applies To class of the activity, if a step page is not specified on the line for the Apply-DataTransform method in the activity) and the value in the DataTransform field.
The system invokes the actions in the data transform, evaluating rows of the rule in sequence. If the Pass the current parameter page is checked, values in that page can be altered by the data transform. If the data transform has the Call superclass data transform check box selected, data transforms from higher classes are applied first.
This method updates the pxMethodStatus property. See How to test method results using a transition.