runActivity
Runs an activity from a script.
Signature
runActivity(options)
Returns
Not applicable.
Parameters
| Name | Description | Type | Required |
| name | Specifies the name of the activity that the API launches. | String | ✅ |
| parameters | Specifies the parameters for the activity in an array. | JSON object | ❌ |
| contextPage | Specifies the name of the context page for the activity. By default, the activity runs in the primary page context. | String | ❌ |
| event | Specifies the event that launches the activity. | DOM event object | ✅ |
In the following example...
var options = {
name: “activityName ",
parameters: [{name: "param1", value: "Page1.prop1", isProperty: true}, {name: "param2", value: 123, isProperty: false}],
contextPage: "page1.page2 ",
event: eventObject
};
pega.api.ui.actions.runActivity(options);Previous topic refreshSection Next topic setValues