Attribute Collector node

The Attribute Collector node collects the values of attributes for use later in the flow; for example, to populate a new account during registration.

This node supports three types of attributes:
string
boolean
number

To request a value, the attribute must be present in the IDM schema of the current identity object.

The node lets you configure whether the attributes are required to continue and whether to use a policy filter of IDM to validate them.

Use the node alone or within a Page node.

Compatibility

Product

Compatible?

ForgeRock Identity Cloud

Yes

ForgeRock Access Management (self-managed)

This functionality requires that you configure AM as part of a sample ForgeRock Identity Platform deployment.

Yes

ForgeRock Identity Platform (self-managed)

Yes

Inputs

For validation, this node reads the Identity Attribute (default: userName) from the shared node state. It uses the value to look up the identity object.

It prompts the user for the attributes to collect.

Dependencies

This node depends on IDM to store the user profile and perform validation.

Configuration

Property Usage

Property	Usage
Attributes to Collect	A list of the attributes to collect based on those in the IDM schema for the current identity object. Default: none
All Attributes Required	When enabled, all attributes collected in this node are required in order to continue. Default: false
Validate Input	When enabled, validate the content against any policies specified in the IDM schema for each collected attribute. For more information, refer to Use policies to validate data in the IDM documentation. If you enable this property, the collected identity attributes must be User Editable. To make an attribute user-editable in the IDM admin UI: Go to Configure > Managed Objects > object-name. Click the pencil () icon, then click Show advanced options. Select the User Editable toggle. For details, refer to Property Configuration Properties in the IDM documentation. Default: false
Identity Attribute	The attribute used to identify the managed object in IDM. Default: `userName`

Attributes to Collect

A list of the attributes to collect based on those in the IDM schema for the current identity object.

Default: none

All Attributes Required

When enabled, all attributes collected in this node are required in order to continue.

Default: false

Validate Input

When enabled, validate the content against any policies specified in the IDM schema for each collected attribute.

For more information, refer to Use policies to validate data in the IDM documentation.

If you enable this property, the collected identity attributes must be User Editable. To make an attribute user-editable in the IDM admin UI:

Go to Configure > Managed Objects > object-name.
Click the pencil () icon, then click Show advanced options.
Select the User Editable toggle.

For details, refer to Property Configuration Properties in the IDM documentation.

Default: false

Identity Attribute

The attribute used to identify the managed object in IDM.

Default: userName

Outputs

The node writes the attributes and their values to the shared node state.

Outcomes

Single outcome path; on success, downstream nodes can read the attributes from the shared node state.

Errors

This node does not log error or warning messages of its own.

Examples

Add date and datetime fields to a journey

This functionality requires that you configure AM as part of a sample ForgeRock Identity Platform deployment.

The Attribute Collector node lets you add properties (attributes) that follow a date or datetime (date and time of day). The format of the date comes from the locale set in your browser.

The following table displays the differences between date and datetime:

Display format Managed object field format Notes

Display format	Managed object field format	Notes
Date only	String format	The format of the date comes from the locale set in your browser. For example, if the locale is English, then the format presented to the end user is `MM-DD-YYYY`. If the local is French, the format is `DD-MM-YYYY`.
Date and time	String format (date and time of day)	The format of the date comes from the locale set in your browser. For example, if the locale is English (United States), then the format presented to the end user is `MM-DD-YYYY`. If the local is French, the format is `DD-MM-YYYY`.

Date only

String format

The format of the date comes from the locale set in your browser.

For example, if the locale is English, then the format presented to the end user is MM-DD-YYYY. If the local is French, the format is DD-MM-YYYY.

Date and time

String format (date and time of day)

The format of the date comes from the locale set in your browser.

For example, if the locale is English (United States), then the format presented to the end user is MM-DD-YYYY. If the local is French, the format is DD-MM-YYYY.

While the rendering of the date to the end user changes depending on the locale set in the browser, ForgeRock Identity Platform stores the date value in UTC format as YYYY-MM-DDHH:MM:SS. For example, 2023-09-13T08:01:00Z.

To render the date or datetime UI element to an end user with the Attribute Collector node, you must:

Specify the IDM property:
- In the Identity Platform admin UI, go to Configure > Managed Objects > Select object, for example, User.
- Use an existing string property or create your own string property. For more information, refer to Property Configuration Properties in the IDM documentation.
Apply formatting and policies to the property in the IDM admin UI for Date or Datetime.

Apply formatting and policies

In the Identity Cloud admin UI, go to Configure > Managed Objects > Select object, for example, User.
Select the property to use.
To select the format of the attribute, on the Details tab, click the Format field, and select one of the following:
- For date property — Date
- For datetime property — Datetime
Click Save.
On the Validation tab, click + Add Policy.
In the Policy Id field, enter one of the following:
- For date property — valid-formatted-date
- For datetime property — valid-datetime
  
  For more information on applying policies to properties, refer to Default policy reference.
Click Add.
In your journey, in the Attribute Collector node, add the property name to the Attributes to Collect field.

For an in-depth use case, add the date or datetime property to an Attribute Collector node in a registration flow. For more information, refer to User self-registration.

The following video shows an example of a journey collecting the datetime from an end user using the Attribute Collector node:

AM 7.5.0