Skip to main content

 –

runActivity

Suggest edit Updated on July 21, 2021

Runs an activity from a script.

Signature

runActivity(options)

Returns

Not applicable.

Parameters

NameDescriptionTypeRequired
nameSpecifies the name of the activity that the API launches.String
parametersSpecifies the parameters for the activity in an array.JSON object
contextPageSpecifies the name of the context page for the activity. By default, the activity runs in the primary page context.String
eventSpecifies the event that launches the activity.DOM event object
For example:

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);
Did you find this content helpful? YesNo

Have a question? Get answers now.

Visit the Collaboration Center to ask questions, engage in discussions, share ideas, and help others.

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us