Table of Contents

Article

refreshHarness: Public JS API for control actions

refreshHarness

Refresh the current harness.

Syntax

var options ={<br />
event: eventObject,<br />
dataTransform: dataTransformJSObject,<br />
activity: activityJSObject,<br />
submitOnRefresh: booleanVal<br />
};


pega.api.ui.actions.refreshHarness(options);

Parameters

This API accepts a JavaScript object which can have the following key-values:

  • event: The event refers to a DOM eventObject.
  • dataTransform: Optional. This is a JSObject with the following key-values:

{name: “dataTransformName", parameters: [{name: "param1", value: "Page1.prop1", isProperty: true}, {name: "param2", value: 123, isProperty: false}]}

  • activity: Optional. This is a JSObject with the following key-values:

{name: “activityName", parameters: [{name: "param1", value: "Page1.prop1", isProperty: true}, {name: "param2", value: 123, isProperty: false}]}

  • submitOnRefresh: Optional. This is a boolean value which can be set to true to submit editable data on the form to the clipboard. The default value is true. In this case the user-modified data will always be saved to clipboard.

Published February 15, 2017 — Updated April 6, 2017


50% found this useful

Have a question? Get answers now.

Visit the Pega Support Community to ask questions, engage in discussions, and help others.