Data Page form
Completing the Parameters tab
  1. About 
  2. New 
  3. Definition 
  4. Load Management 
  5. Parameters 
  6. Pages & Classes 
  7. Test Cases 
  8. Usage 
  9. History 
  10. More... 
  

Your application can automatically send parameter values to data pages from either UI elements or non-UI rules like data transforms or activities.

Each time you reference a data page with different parameters, it creates an instance of the data page on the clipboard: a data page that provides customer information creates a new instance of itself whenever its parameter values (for instance, the Customer ID) change. You can have multiple instances of a data page on the clipboard, each one created by a reference with different parameters from the others; or, if you have checked the Limit to a single data page check box on the Load Management tab, each new reference to the data page creates an instance of the data page that overwrites any existing instance.

Subsequent references to a data page using parameters that result in a reference to an existing instance of the data page on the clipboard refer to that existing data page unless the conditional refresh strategy (see below) indicates the page should be reloaded on each reference.

Specifying parameters

Use this tab to list and describe parameters the data page requires. Add rows in the display by clicking the Add add row icon.

For each parameter provide the following information:

Field Description
Name Each property needs a name that is unique within this data page. The name should begin with a letter and can include letters, numbers, and the dash and underscore characters.
Description Provide a short description for the property. This description appears only at design time, to help developers work with the property.
Data Type

Select a data type. The options are:

  • String
  • Boolean (true/false)
  • Integer
Required Choose Yes to set this property as required; choose No to make it optional. Required parameters must be passed to the data page in order for it to load.
In/Out Select In or Out to indicate whether the parameter is used for input to or output from this data page.
Default Value Optional. You can enter a literal constant value that appears as the default parameter value when the system presents a parameter prompt form to a user invoking this data page.
SmartPrompt type

Optional. For some parameters, you can configure SmartPrompt facilities to list a set of values for the parameter that a person can choose from when specifying the parameter values.

The values listed by SmartPrompt must be a key part to a concrete class with one to three key parts.

To enable SmartPrompt operation, enter a class name here (such as Rule-Obj-FieldValue or Data-Party-Gov) to create a configuration that, at runtime, allows a user to enter this parameter using SmartPrompt. Click the edit icon edit icon to the right of the field to create a new class.
Validate As

Optional. Identify a property that further qualifies the SmartPrompt operation.

If you selected Rule-Obj-FieldValue in the SmartPrompt Rule field, enter here the second key part of the field value rules to appear at runtime in SmartPrompt lists.

If you selected another class in the SmartPrompt Rule field, identify a property that is a key part of the indicated class, if the class key contains more than one key part.

Passing parameters to data pages

From UI elements

For elements like drop-down lists and radio buttons:

From sections

When you add a section to a section, you can pass parameters to the data page the section invokes for its properties in the Using Page section of the Include Section Rule dialog. See Harness, Section, and Flow Action forms - including a section.

 

From non-UI rules

Presume you have a data page named D_Customer, with parameters CustID and DetailLevel that let you specify the customer and the level of detail the instance of the data page holds, reference the data page using this syntax:

D_Customer[CustID:myCustomer, DetailLevel:Full]

 

If the data page requires only a single parameter, you can provide the parameter without specifying the parameter name. If D_Customer has a single parameter, CustID, use this syntax:

 

D_Customer[myCustomer]

 

Note: The system accepts either of the above syntaxes to reference a data page only in a field where the Expression Builder is enabled. For example, you cannot use the syntax in the findPage() PublicAPI method.

 

Non-UI rules from which you can pass parameters to data pages include:

Activity Batch Process Case Match
Collection Constraints Data Transform
Decision Table Decision Tree Declare Expression
Function Alias Infer Interaction
Map Values Property Alias Scorecard
Strategy When  

 

From autogenerated properties

You can pass parameters from any autogenerated property to its data page, using the General tab of the property rule, by setting the data access type to Automatic reference to class instance (Linked) and completing the additional fields that appear. See Properties rule - completing the General tab.

Data pages and Report Definitions

Note: Report definitions cannot reference data pages that themselves take parameters (such as D_page1[param1:D_page2[param2:Param.P1],param2:pxRequestor.pyUserIdentifier].pyLabel) to populate columns, although they can directly reference properties in a data page (such as D_page1.companyName).

Related Topics IconRelated information

Open topic with navigation