Advanced Identity Cloud

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 identity schema (PingIDM schema) for the current identity object.

The node lets you configure whether the attributes are required to continue and whether to use a policy filter of the underlying identity service (PingIDM) to validate them.

Use the node alone or within a Page node.

Compatibility

Product Compatible?

Advanced Identity Cloud

Yes

PingAM (self-managed)

Yes 1

Ping Identity Platform (self-managed)

Yes

1 This functionality requires that you configure AM as part of a Ping Identity Platform deployment.

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 the underlying identity service (PingIDM) to store the user profile and perform validation.

Configuration

Property Usage

Attributes to Collect

A list of the attributes to collect based on those in the identity schema (PingIDM 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 identity schema (IDM schema) for each collected attribute.

Learn more in the documentation on using policies to validate data for:

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

  1. Go to Configure > Managed Objects > object-name.

  2. Click the pencil () icon, then click Show advanced options.

  3. Select the User Editable toggle.

Learn more in the documentation on property configuration properties for:

Default: false

Identity Attribute

The attribute used to identify the managed object in the underlying identity service (PingIDM).

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

These examples assume an Advanced Identity Cloud tenant or self-managed Ping Identity Platform deployment.

Add date and datetime fields to a journey

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

Date only

String format

Advanced Identity Cloud example: frIndexedString1

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)

Advanced Identity Cloud example: frIndexedDate1

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

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

Advanced Identity Cloud only

You can only use the date general purpose extension attributes for datetime. Don’t attempt to use the indexed date properties with the date format.

The rendering of the date to the end user changes, depending on the locale set in the browser. However, the server 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 do the following:

  • Advanced Identity Cloud

  • Ping Identity Platform

  1. Specify the property to use as date or datetime:

  2. Apply formatting and policies to the property in the IDM admin console for Date or Datetime.

  1. Specify the IDM property:

    • In the Ping 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.

      Learn more in Property Configuration Properties in the IDM documentation.

  2. Apply formatting and policies to the property in the IDM admin console for Date or Datetime.

Apply formatting and policies

  1. In the Advanced Identity Cloud admin console (Platform UI in self-managed deployments) go to Native Consoles > Identity Management.

  2. Select Configure > Managed Objects > object-type, for example, User or Alpha_user.

  3. Select the property to use.

  4. 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

  5. Click Save.

  6. On the Validation tab, click + Add Policy.

  7. In the Policy Id field, enter one of the following:

  8. Click Add.

  9. In your journey, in the Attribute Collector node, add the property name to the Attributes to Collect field.

    Advanced Identity Cloud provides the following properties:

    • For date property — frIndexedString1

    • For datetime property — frIndexedDate1

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

For Advanced Identity Cloud, you can find more information in User self-registration.

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