--- title: Attribute Collector node description: Collects user attribute values during a journey for use in registration or profile update flows in PingAM. component: platform version: 7.5 page_id: platform:auth-node-ref:attribute-collector canonical_url: https://docs.pingidentity.com/platform/7.5/auth-node-ref/attribute-collector.html llms_txt: https://docs.pingidentity.com/platform/llms.txt docs_for_agents: https://developer.pingidentity.com/build-with-ai/docs-for-agents.md keywords: ["Nodes & Trees", "Journeys", "Authentication", "Schema", "Policy", "Custom Attributes"] page_aliases: ["auth-node-attribute-collector.adoc"] section_ids: availability: Availability inputs: Inputs dependencies: Dependencies configuration: Configuration outputs: Outputs outcomes: Outcomes errors: Errors examples: Examples add_date_and_datetime_fields_to_a_journey: Add date and datetime fields to a journey date-formatting-policies: Apply formatting and policies --- # 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 (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](page.html). ## Availability | Product | Available? | | --------------------------------------------------------------------------------------------------------------------------------------- | ---------- | | PingOne Advanced Identity Cloud | Yes | | PingAM (self-managed) This functionality requires that you configure AM as part of a sample Ping Identity Platform deployment. | Yes | | Ping 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 | | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 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.Learn more in [Use policies to validate data](https://docs.pingidentity.com/pingidm/7.5/objects-guide/policies.html#managed-object-property-config-properties) 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:1) Go to Configure > Managed Objects > *object-name*. 2) Click the pencil ([icon: pencil-alt, set=fa]) icon, then click Show advanced options. 3) Select the User Editable toggle.Learn more in [Property Configuration Properties](https://docs.pingidentity.com/pingidm/7.5/objects-guide/appendix-managed-objects.html#managed-object-property-config-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 Ping Identity Platform deployment](https://docs.pingidentity.com/platform/7.5/sample-setup/). | 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 | 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, Ping 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: 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](https://docs.pingidentity.com/pingidm/7.5/objects-guide/appendix-managed-objects.html#managed-object-property-config-properties) in the IDM documentation. 2. Apply [formatting and policies](#date-formatting-policies) to the property in the IDM admin UI for `Date` or `Datetime`. ### Apply formatting and policies 1. In the IDM admin UI, go to Configure > Managed Objects > *Select object*, for example, User. 2. Select the property to use. 3. 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` 4. Click Save. 5. On the Validation tab, click + Add Policy. 6. In the Policy Id field, enter one of the following: * For date property — `valid-formatted-date` * For datetime property — `valid-datetime` Learn more about applying policies to properties in [Default policy reference](https://docs.pingidentity.com/pingidm/7.5/objects-guide/configuring-default-policy.html#policy-reference). 7. Click Add. 8. 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. Learn more in [User self-registration](https://docs.pingidentity.com/pingoneaic/latest/self-service/self-registration.html). The following video shows an example of a journey collecting the datetime from an end user using the Attribute Collector node: **Video (Video)** <\_images/mp4/attribute-collector-datetime.mp4>