refreshHarness
Refreshes the current harness.
Signature
refreshHarness(options)
Returns
Not applicable.
Parameters
Name | Description | Type | Required |
event | Specifies the event that launches the refresh. | DOM event object | ✅ |
dataTransform | Specifies the data transform that the harness runs on refresh. | JSON object | ❌ |
activity | Specifies the activity that the harness launches on refresh. | JSON object | ❌ |
submitOnRefresh | Specifies if the system submits editable data from the form to the
clipboard. The default value is true . | Boolean | ❌ |
JSON objects
- dataTransform
- Includes an array of parameter objects.
isProperty
indicates whether the parameter is a property or a literal constant. The default value ofisProperty
isfalse
, which means that the parameter is a constant.{ "name":"dataTransformName", "parameters":[ { "name":"param1", "value":"Page1.prop1", "isProperty":true }, { "name":"param2", "value":123, "isProperty":false } ] }
- activity
- Includes an array of parameter objects.
isProperty
indicates whether the parameter is a property or a literal constant. The default value ofisProperty
isfalse
, which means that the parameter is a constant.{ "name":"activityName", "parameters":[ { "name":"param1", "value":"Page1.prop1", "isProperty":true }, { "name":"param2", "value":123, "isProperty":false } ] }
Previous topic openURLInWindow Next topic refreshSection