Structuring Scroll Path Syntax

PeopleTools offers two legacy constructions for scroll paths: a standard scroll path syntax (Record.recordname) and an alternative syntax using a Scroll.scrollname expression. The latter is more powerful in that it can process some rare cases where a Record.recordname expression results in an ambiguous reference.

Scroll Path Syntax with Record.recordname

Here is the standard scroll path syntax:

[Record.level1_recname, level1_row, [Record.level2_recname, level2_row, ]] Record.⇒
target_recname

If the target level (the level you want to reference) is one, you must supply only the Record.target_recname parameter. If the target scroll level is greater than one, you must provide scroll name and row level parameters for all hierarchically superior scroll levels, beginning at level one. The following table indicates the scroll path syntax for the three possible target scroll levels:

Target Level	Scroll Path Syntax
1	Record.target_recname
2	Record.level1_recname, level1_row, Record.target_recname
3	Record.level1_recname, level1_row, Record.level2_⇒ recname, level2_row, Record.target_recname

If you are referring to a row or a buffer field, additional parameters are required after the scroll path.

The following table describes the standard scroll path syntax parameters:

Syntax Parameters	Description
Record.level1_recname	Specifies the name of a record associated with scroll level one, normally the primary scroll record. This parameter is required if the target scroll level is two or three.
level1_row	An integer that selects a row on scroll level one. This parameter is required if the target scroll level is two or three.
Record.level2_recname	Specifies the name of a record associated with scroll level two, normally the primary scroll record. This parameter is required if the target row is on scroll level three.
level2_row	An integer that selects a row on scroll level two. This parameter is required if the target row is on scroll level three.
Record.target_recname	Specifies a record associated with the target scroll level, generally the primary scroll record. The scroll can be on level one, two, or three of the active page.

Scroll Path Syntax with Scroll.scrollname

As an alternative to Record.recordname expressions in scroll path constructions, PeopleTools permits use of a Scroll.scrollname expression. Scroll paths using Scroll.scrollname are functionally identical to those using Record.recordname, except that Scroll.scrollname expressions are more strict: they can refer only to a scroll level’s primary record; whereas Record.recordname expressions can refer to any record in the scroll level, which in some rare cases can result in ambiguous references. (This can occur, for example, if the Record.recordname expression inadvertently references a related display record in another page in the component.) Use of Record.recordname is still permitted, and there is no requirement to use the Scroll.scrollname alternative unless it is needed to avoid an ambiguous reference.

The scrollname is the same as the scroll level’s primary record name.

The scroll name cannot be viewed or changed through the PeopleSoft Application Designer interface. Here is the complete scroll path syntax using Scroll.scrollname expressions:

[Scroll.level1_scrollname, level1_row, [Scroll.level2_scrollname, level2_row, ]], ⇒
Scroll.target_scrollname

The target scroll level in this construction is the scroll level that you want to specify. If the target level is one, you need to supply only the Scroll.target_scrollname parameter. If the target scroll level is greater than one, you need to provide scroll name and row-level parameters for hierarchically superior scroll levels, beginning at level one. The following table indicates the scroll path syntax for the three possible target scroll levels:

Target Level	Scroll Path Syntax
1	Scroll.target_scrollname
2	Scroll.level1_scrollname, level1_row, Scroll.target_⇒ scrollname
3	Scroll.level1_scrollname, level1_row, Scroll.level2_⇒ scrollname, level2_row, Scroll.target_scrollname

If the component you are referring to is a row or a buffer field, additional parameters are required after the scroll path.

The following table describes the alternative scroll path syntax parameters:

Parameter	Description
Scroll.level1_scrollname	Specifies the name of the page’s level-one scroll area. This is always the same as the name of the scroll level’s primary scroll record. This parameter is required if the target scroll level is two or three.
level1_row	An integer that selects a row on scroll level one. This parameter is required if the target scroll level is two or three.
Scroll.level2_scrollname	Specifies the name of the page’s level two scroll area. This is always the same as the name of the scroll level’s primary scroll record. This parameter is required if the target row is on scroll level three.
level2_row	An integer that selects a row on scroll level two. This parameter is required if the target row is on scroll level three.
Scroll.target_scrollname	The scroll name of the target scroll level, which can be level one, two, or three of the active page.