Skip to main content

 –

Connector parameters in data pages

Suggest edit Updated on August 16, 2021

You can specify parameters in connectors to define the contract for calling the connector from a data page. When you configure a data page with a connector data source, you can provide values for the parameters that you define in the connector, and pass them to the data page. By defining parameters in a connector, you help users understand what inputs the connector expects.

You define parameters for a connector on the Parameters tab of a Connect REST rule. These parameters appear in a data page rule when you specify the connector as a data source. For example, you configure a data page to call a connector to retrieve a list of medical providers. The connector includes a parameter called ResultListLimit in which you can enter a value to limit the number of results that the data page displays to the end user.

Medical provider parameters
Parameters for a connector that retrieves list of medical
                            providers

You can then pass the parameter values in the following ways:

  • Copy values from the current parameter page to the new parameter page: You can choose to enter values for specific parameters that you want to copy onto the new parameter page. If you leave the Pass current parameter page check box unselected, you pass only the values of the parameters displayed in the Parameters for <connector name> dialog box to the data page.
  • Pass the current parameter page to another rule: To pass the entire content of the current parameter page, select the Pass current parameter page check box.

For more information, see the following documentation:

Valid parameter values

You can pass certain types of values to the data page depending on whether you are calling a REST connector as a data page source, or in a save plan.

Value typesREST connector as a sourceREST connector in a save plan
Literal values, such as text and numbers
Parameter page reference (Param.input parameter name)
Reference to a property on the primary page (.PropertyName)

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