Clipboard page and property references

When you set or retrieve a value of a property, you can only set or retrieve it to or from a clipboard page. Most pages have an associated class and a name. The standard dot notation to reference a property is:


      pagename.
      propertyname

This notation works for both source and target.

In most situations, you can use the keywords local, param, parent, primary, and top in place of an explicit page name. The keywords are not case-sensitive: Param.Width, PARAM.Width and param.Width all refer to the same parameter.

  • You cannot use the parent keyword in a Data Transform form.

  • It is not recommended that you use the Top keyword in data transforms. There are situations where using Top does not work if a top-level page is not clearly defined (for example, if a row has both source and target pages).

  • References to properties must match the case of the Property Name field in the property definition — the Rule-Obj-Property instance.

  • The Primary keyword always references the Primary page. The "leading dot" notation (such as ".PropertyName") references the current step page, which might also be the current primary page (for instance, at the top level of an activity or data transform), but is not if you have changed the step page (for instance, in the context of an Update Page action in a data transform or within an activity step that specifies an explicit step page).

Note: You can use <CURRENT> in declarative rules (specifically when there is a declarative target present).
To work with: Use this format
A property on a named, top-level page. myPageName.myProperty
A property on the current Primary page. Primary.myProperty
A property on the in-context page for children actions in a data transform , or for nested steps in an activity.

For top level actions in a data transform, or top level steps in an activity, or any rule type that changes the Primary page when executed, this is equivalent to Primary.myProperty.

.myProperty
A parameter on the parameter page of an activity, data transform, or flow. (Technically, a parameter is not a property; no Rule-Obj-Property exists for it.) 

                Param.
                myParameter
A variable defined as a local variable on the Parameter tab of an activity form. (Technically, a local variable is not a property). 

                Local.
                myParameter
A property on an embedded page. 

                myPage.
                myEmbeddedPage.
                myProperty
The first element of a property of mode Value List. 

                myPage.
                myEmbeddedPage.
                myValueList
                (
                1
                )
The second element of a property of mode Value List on an embedded page. 

                myPage.
                myEmbeddedPage.
                myValueList
                (2)
The first element of a Value List on the primary page of an activity or a data transform, or on the in-context page for children actions in a data transform. 
.
                myValueList
                (1)
The element of a Value Group associated with the value MA on an embedded page. 

                myPage.myEmbeddedPage.myValueGroup(MA)

The first element of a Page List on myPage. 


                myPage.
                myPageList
                (
                1
                )
A property on the enclosing page of the current context, which is an embedded page. You can use this keyword twice to designate the grandparent page and so on.

The PARENT keyword is valid in Declare Expression rules, Declare Index rules, decision trees, map values, and decision tables, and within Java code. You can also use the PARENT keyword in the Step page field in activities.

In a Java step of an activity, the keyword parent refers to the parent page of the current step page, not of the primary page.

You cannot use this keyword in data transforms.

 

                parent.
                theproperty
              
parent.parent.parent.Loan(4).aproperty
A property on the top-level page of the current context that is an embedded page, for a rule that includes a Pages & Classes tab.

(When you use the TOP keyword in the rule form, on the form's Pages & Classes tab, add a row with TOP in the Page Name field and a class in the Class Name field.)

For examples on using the <current> keyword, see Obtaining a property value.
A property on a page accessed through a linked property. Linked property references are useful in harnesses, sections, and flow actions. .linkedpropertyname.propertyreference