Identity Cloud

Page node

The Page node lets you combine multiple nodes that request input onto a single page for display to the user.

Drag and drop nodes onto the Page node to combine them. Only add nodes that use callbacks to request input. Don’t add other nodes, such as the Data Store Decision node and the Push Sender node to this node.

Compatibility

Product Compatible?

ForgeRock Identity Cloud

Yes

ForgeRock Access Management (self-managed)

Yes

ForgeRock Identity Platform (self-managed)

Yes

Inputs

The inputs are determined by the collective inputs of the contained nodes.

Dependencies

None.

Configuration

Property Usage

Page Header

Optional. A localized title for the Page node and the nodes contained within it. Use this when components of an authentication journey need a title; for example, dividing a registration flow into labeled sections.

Page Description

Optional. A localized description for the Page node and the nodes contained within it. Use this when you need additional descriptive text in an authentication journey. You can use HTML code to format the description.

Stage

An optional stage name to pass to the client to aid in rendering.

Submit Button Text

Optional. Use the Key and Value fields to set the text of the Submit button.

Page Footer

Optional. A localized footer for the page node and the nodes contained within it. Use this when you need additional descriptive text in an authentication journey. You can use HTML code to format the footer.

Theme

Optional. If using hosted pages, specify a theme to override this journey’s UI theme.

This node’s optional properties are passed in the response, but a self-hosted or custom UI must support these properties to make them visible to the end user.

Outputs

The outputs are determined by the collective outputs of the contained nodes.

Outcomes

The outcomes are determined by the last node in the Page node. Only the last node in the page can have more than one outcome path.

Errors

This node can log the following error messages:

Message Notes

Failed to collect inputs of contained node: <node-name>

The <node-name> could not retrieve required properties from the shared node state

Failed to collect outputs of contained node: <node-name>

The <node-name> could not retrieve required properties to include in the shared node state

Could not find the identity based on the information available on context

Failed to find the account profile with this username in this realm

An error occurred when trying to lock out the user account

Failed to update the account status; applies when locking and unlocking the account

This node can throw exceptions with the following messages during operation:

Message Notes

This page has no nodes in it, so cannot proceed

A Page node must contain at least one other node

No outcome and only metadata callbacks found

Failed to get to an outcome while processing the contained nodes

Node properties cannot be fetched

Failed to access the properties of a contained node

This node can throw exceptions with the following messages when saving the journey:

Message Notes

Illegal child node type: <node-type>

A Page node can’t contain a <node-type>

Node does not have any outcomes: <node-type>

The contained nodes must have at least a single outcome path

Only the last node in a page can have more than one outcome

Consider rearranging the contained nodes

Node does not exist: <node-id>

Use the journey editor to fix the problem

Could not load child node: <node>

Use the journey editor to fix the problem

Could not obtain outcomes for node: <node>

Use the journey editor to fix the problem

Example

The following example uses a Page node containing a Platform Username node, Platform Password node, and Choice Collector node:

Example journey showing Page node use

The flow prompts the user for all input on a single page:

User’s view of an example journey containing a Page node
Copyright © 2010-2024 ForgeRock, all rights reserved.