Skip to main content

 –

getDataPage

Suggest edit Updated on July 21, 2021

Retrieves data page information from the clipboard in JSON format.

Signature

getDataPage(options)

Returns

JSON object with data from the clipboard.

Parameters

NameDescriptionTypeRequired
nameSpecifies the name of the target data page.String
parametersSpecifies the parameters for the data page in an array.JSON object
callbackSpecifies the callback function that you call with the data from the data page.String
eventSpecifies the event that launches the activity.DOM event object

JSON objects

dataTransform
Includes an array of parameter objects. isProperty indicates whether the parameter is a property or a literal constant. The default value of isProperty is false, which means that the parameter is a constant.
{
   "name":"dataTransformName",
   "parameters":[
      {
         "name":"param1",
         "value":"Page1.prop1",
         "isProperty":true
      },
      {
         "name":"param2",
         "value":123,
         "isProperty":false
      }
   ]
}
For example:
var options = {
                name: "dataPageName",
                parameters: [{name: "param1", value: "Page1.prop1", isProperty: true},  {name: "param2", value: 123, isProperty: false}],
                callback: callbackFunc,
                event: eventObject  
            };

            function callbackFunc(resultJSON){
                console.log(resultJSON)
            }

           pega.api.ui.actions.getDataPage(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