Page-Remove method
Use this method to delete one or more pages from the clipboard. The contents of the database are not affected.
As a sound development practice, design your activities or processing cycle to remove clipboard pages after they are no longer needed. A large clipboard can affect system performance. You can use the Performance tool to monitor the size (in bytes) of the clipboard.
To remove all User pages, create a Java step containing these two lines:
PRThread thread = tools.getThread();
thread.removeAllPages(null);You can use an activity to remove all user pages, either when developing or at appropriate points in an application.
Parameters
This method uses the page (if any) in the Step Page field plus an optional array of page names.
| Parameter | Description |
|---|---|
| Page | Optional. Enter the name of a top-level or embedded clipboard page to delete. |
Results
If the Step Page field is not blank, the page identified in that field is deleted. (You can't delete the primary page of the activity.)
In addition, the method finds each page (top-level or embedded) identified in the array and deletes the page.
If a page you specified is not found on the clipboard, the Page-Remove method reports a warning error, but does not fail.
This method does not alter the contents of the PegaRULES database.
Checking the method status
This method updates the pxMethodStatus property. See How to test method results using a transition.