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 and viewable in the identity schema for the current identity object.
| You can find more information about the identity schema in Advanced Identity Cloud identity schema. |
The node lets you configure whether the attributes are required to continue and whether to use a policy filter to validate the input values.
Example
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 Example: |
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 |
||
Date and time |
String format (date and time of day) Example: |
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
|
|
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 |
To render the date or datetime UI element to an end user with the Attribute Collector node, you must do the following:
-
Specify the property to use as date or datetime:
-
General purpose extension attributes. Recommended. Use OOTB indexed attributes:
-
Use the
Stringindexed properties, such asfrIndexedString1for date only. -
Use the
Dateindexed properties, such asfrIndexedDate1for datetime only.
-
-
Create your own custom attributes. Create custom attributes, prefixed with
custom_.
-
-
Apply formatting and policies to the property for
DateorDatetime.-
In the Advanced Identity Cloud admin UI, go to Identities > Configure > object type, for example, Alpha realm - User.
-
Switch to the Properties tab and select the property you specified.
-
Select one of the following from the Property Format list:
-
Datefor a date property. -
Date/Timefor a datetime property.
-
-
On the Validation tab, select one of the following checkboxes:
-
Valid formatted date for a date property.
-
Valid datetime for a datetime property.
-
-
-
Add the property name to the Attributes to Collect field in the Attribute Collector node.
For an in-depth use case, add the date or datetime property to an Attribute Collector node in a registration flow.
The following video shows an example of a journey collecting the datetime from an end user using the Attribute Collector node:
Availability
| Product | Available? |
|---|---|
PingOne 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.
Configuration
| Property | Usage |
|---|---|
Attributes to Collect |
A list of the attributes to collect from the client. The attributes must exist in the identity 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: Not enabled |
Validate Input |
Select this option to validate the collected attributes against the validation policies specified for the property. Learn more in Use policies to validate data. If you enable this option, the collected attributes must be user editable. How do I make an attribute user-editable?
Default: Not enabled |
Identity Attribute |
The property used to locate the identity. Default: |