Managing User Properties

The User Properties tab is used to define and manage custom user property schema, including property types, redaction settings, transformations, and expiration rules.

Understanding User Properties Action

Data Redaction

Data Redaction masks personally identifiable information (PII) for compliance purposes (e.g., GDPR).

When enabled:

• Redacted values are hidden in the UI.

• Redacted values are excluded from database queries and API responses.

• The original data remains stored in the database.

Deletion

Deleting a user property removes it from the UI and reporting interfaces. If devices continue sending data for the deleted property via SDK or API, the property will reappear as new data is received. To prevent re-creation, remove the property from the SDK implementation.

User Property Fields Overview

1. Property Name: The name of the user property.

2. Data Redaction: Indicates whether masking is enabled.

3. Expiration: Displays the configured expiration rule.

4. Property Type: Shows the type of the user property.

5. Data Type: Defines the stored data type (e.g., string, number, array).

User Properties Transformation

Transformations allow modifying the user property structure or values. Supported transformation types:

• Merge Custom Property

• Modify Custom Property Value

• Rename Custom Property

Transformations can be applied to:

• Incoming data

• Existing data

• Both

Transformations applied to existing data are irreversible.

Merge Custom Property

Merges multiple custom user properties into a single property. Use this when consolidating properties that represent similar or overlapping data. To utilize this, follow the steps below:

1. Click Create New.

2. Select Create New Transformation.

3. Choose Merge Custom Property.

4. Select source properties.

5. Provide the target property name.

6. Select the transformation method (Incoming, Existing, or Both).

7. Click Save.

Modify Custom Property Value

Modify Custom Property allows you to change the values of existing custom properties using regular expressions. To modify a custom property value, follow these steps:

1. Click Create New Transformation.

2. Select Modify Custom Property Value.

3. Choose the property.

4. Define a regular expression or a specific value.

5. Enter the replacement value.

6. Select the transformation method.

7. Click Save.

Rename Custom Property

Rename Custom Property lets you rename an existing custom property either with a specific value or using regular expressions. Follow these steps to rename a custom property:

1. Click Create New Transformation.

2. Select Rename Custom Property.

3. Choose the property.

4. Enter the new property name.

5. Select transformation scope (Incoming, Existing, or Both).

6. Click Save.

Editing User Properties

To edit a user property:

1. Open the property drawer via the ellipsis menu.

2. Select Edit.

3. Update data type or enable Data Redaction.

4. Click Save.

Expiration of User Properties

There are two ways to set expiration dates for user properties:

1. At the End of the Session: Clears the property value at the end of the user session. Suitable for temporary attributes (e.g., session-based preferences).

2. After a Given Number of Days- This option allows you to set an expiration period for a user property based on a specified number of days. For example, you may want to track a 7-day trial subscription, after which the related user property should expire. The property is marked as expired when next received and the property is permanently removed during the cleanup process.

You can also enable Data Redaction when setting an expiration.