Transfer and Modal Functions

Eighteen PeopleCode functions are available to use for implementing transfers and creating modal windows. Some functions are available for use in fluid applications only, in classic applications only, or in other specific contexts. The information on these functions is presented in a table that has been split into four parts. See the legend that follows the table for an explanation of terms and abbreviations.

    Source Location Action Target Rel
Function Description FS CS AG/MD IG MW F2F F2C C2C C2F CW NW 2W Avail

PeopleCode Language Reference: DoModal function

Use the DoModal function to display a secondary page in a modal, secondary window with a child relationship to the parent window.

Y

Y

*

*

*

Y

N

Y

N

N

N

Y

pre-8.54

PeopleCode Language Reference: DoModalComponent function

Use the DoModalComponent function to display a secondary component in a modal, secondary window with a child relationship to the parent window.

Y

Y

*

*

*

Y

N

Y

N

N

N

Y

pre-8.54

PeopleCode Language Reference: DoModalComponentPopup function

Use DoModalComponentPopup as the recommended function to display a secondary fluid component in a modal, secondary window with a child relationship to the parent window. This function includes a modal_options parameter, which allows you to specify characteristics of the modal window such as height and width.

Y

N

*

*

*

Y

N

N

N

N

N

Y

8.54.00

PeopleCode Language Reference: DoModalPopup function

Use DoModalPopup as the recommended function to display a secondary fluid page in a modal, secondary window with a child relationship to the parent window. This function includes a modal_options parameter, which allows you to specify characteristics of the modal window such as height and width.

Y

N

*

*

*

Y

N

N

N

N

N

Y

8.54.00
    Source Location Action Target Rel
Function Description FS CS AG/MD IG MW F2F F2C C2C C2F CW NW 2W Avail

PeopleCode Language Reference: DoModalX function

Use the DoModalX function to display a secondary page modally when you do not want it to display in a modal, secondary window.

N

Y

*

N

N

N

N

Y

N

Y

N

N

pre-8.54

PeopleCode Language Reference: DoModalXComponent function

Use the DoModalXComponent function to display a secondary component modally when you do not want it to display in a modal, secondary window.

N

Y

*

N

N

N

N

Y

N

Y

N

N

pre-8.54

PeopleCode API Reference: RedirectURL method: Response class

Use the RedirectURL function in to navigate to the location specified by the URL parameter. 

N

Y

N

N

N

N

N

Y

Y

Y

N

N

pre-8.54

PeopleCode Language Reference: Transfer function

Use the Transfer function to exit the current context and transfer the user to another page.

Y

Y

Y1

Y2

Y2

Y

Y

Y

Y

Y1

Y1, 3

N

pre-8.54

PeopleCode Language Reference: TransferExact function

Use the TransferExact function to exit the current context and transfer the end user to another page using an exact match of all keys in the optional key list.

Y

Y

Y1

Y2

Y2

Y

Y

Y

Y

Y1

Y1, 3

N

pre-8.54

PeopleCode Language Reference: TransferExactTop function

Use the TransferExactTop function to exit the current context and transfer the user to another page using an exact match of all keys in the optional key list and by always replacing the current window .

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

N

N

8.59.01

PeopleCode Language Reference: TransferModeless function

Use the TransferModeless function to open a new page in a modeless window on top of the parent window.

N

Y

*

*

N

N

N

Y

N

N

N

Y

pre-8.54
    Source Location Action Target Rel
Function Description FS CS AG/MD IG MW F2F F2C C2C C2F CW NW 2W Avail

PeopleCode Language Reference: TransferTop function

Use the TransferTop function to exit the current context and transfer the user to another page by always replacing the current window.

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

N

N

8.55.13

PeopleCode Language Reference: ViewContentURL function

Use the ViewContentURL function to open a new browser window and navigate to the location specified by the URL parameter.

N

Y

N

N

N

N

N

Y

N

N

Y

N

pre-8.54

PeopleCode Language Reference: ViewContentURLClassic function

Use the ViewContentURLClassic function to navigate to the classic content specified by the URL parameter. 

Y

Y

Y1

Y

Y

N

Y

Y

N

Y

N

N

8.55.14

PeopleCode Language Reference: ViewContentURLFluid function

Use the ViewContentURLFluid function to navigate to the fluid content specified by the URL parameter. 

Y

Y

Y1

Y

Y

Y

N

N

Y

Y

N

N

8.55.14

PeopleCode Language Reference: ViewContentURLModeless function

Use the ViewContentURLModeless function to open a modeless modal window displaying the PeopleSoft component content (either classic or fluid) specified by the URL parameter.

Y

N

Y

Y

N

Y

Y

N

N

N

N

Y

8.55.11

PeopleCode Language Reference: ViewURL function

Use the ViewURL function to navigate to the location specified by the URL parameter.

Y

Y

N

N

N

Y

Y

Y

Y

Y

Y3

N

pre-8.54
    Source Location Action Target Rel
Function Description FS CS AG/MD IG MW F2F F2C C2C C2F CW NW 2W Avail

PeopleCode Language Reference: ViewURLModeless function

Use the ViewURLModeless function to open a modeless modal window displaying the non-component content (for example, an iScript or external content) specified by the URL parameter.

Y

N

Y

Y

N

N

N

N

N

N

N

Y

8.55.11

PeopleCode Language Reference: ViewURLTop function

Use the ViewURLTop function to exit the current context and navigate to the location specified by the URL parameter by always replacing the current window.

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

N

N

8.55.13
Legend  

FS

Fluid standalone

CS

Classic standalone

AG/MD

Activity guide (including fluid navigation collections) or master/detail

IG

Interactive grouplet

MW

Modeless window

F2F

Fluid-to-fluid

F2C

Fluid-to-classic

C2C

Classic-to-classic

C2F

Classic-to-fluid

CW

Current window

NW

New window

2W

Secondary window (modal or modeless)

*

Refer to the values for the source type as a standalone component

1

When AJAX transfers are not enabled (the default), the action exits the fluid wrapper and the content replaces the current window. If the transfer function is set to open a new window, the action opens a new window instead.

When AJAX transfers are enabled, the new content is displayed in the target content area of the fluid wrapper when the target is set to current window. If the transfer function is set to open a new window, this new window setting is overridden and the new content is also displayed in the target content area of the fluid wrapper except when the transfer is from classic content to other classic content. In that case, the new window setting is honored and the classic content is opened in a new window.

2

When the target setting is current window, the content replaces the current content.

3

On iOS only, when the Safari browser is in full screen mode and when content has been set to open in a new window, the content replaces the current window instead. 

Related Topics