User Documentation
Start typing to search…

Custom Fields

Introduction

Custom fields are user-defined attributes used to capture information not covered by standard or extended fields. They offer flexibility to store specialized data across entities such as customers, transactions, transaction line items, and coupons.

While custom fields are useful for capturing non-standard information, they can pose challenges in maintaining data consistency, generating accurate reports, and conducting reliable analysis.

Scope of custom fields

You can create custom fields for the following scopes:

  • Loyalty registration
  • Loyalty transaction
  • Customer feedback
  • Zone custom fields
  • Store custom fields
  • Points redemption
  • Voucher redemption (coupon redemption)
  • Customer advanced feedback
  • Customer preferences
  • Customer Card

Key limitations

  • Uncontrolled field values
    Custom fields often lack strict data entry rules, resulting in inconsistent or unclear data. For example, a gender field might have entries such as "M," "F," "Male," "Female," or "MF." These differences make it more challenging to filter, search, or report on the data, and often require manual effort to clean and standardize the values.

  • Limited reporting and analytics support
    Custom fields are less suitable for reporting and analytics than extended fields.

    • Custom fields cannot be used as dimensions in reports, which are essential for grouping and analyzing data.
    • Custom fields support only simple filtering, such as exact matches (regular expressions). They do not support advanced options, such as filtering by range or partial values. This limits their effectiveness in complex data searches.

  • Implications for CDP integration and data governance
    In Loyalty, custom and extended fields are often used interchangeably, such as in rule definitions. However, Customer Data Platforms (CDPs) enforce stricter standards to ensure data consistency and quality.

    The uncontrolled nature of custom field values can hinder their direct use in CDP-driven use cases like personalization, segmentation, and automated workflows unless rigorous validation and standardization practices are applied.

Creating a new custom field

To create a new custom field, perform the following:

  1. On InTouch, navigate to Organization Settings > Master Data Management > Data Model > Custom Fields.
  1. Click Add New Custom Field.

  1. Configure the new custom field.

📘

Note

Custom field names have a 20-character limit, and custom field values can contain up to 250 values.

Speical characters (! @ # $ % / ? . >) are not supported for custom field names.

The table shows the fields with their descriptions.

OPTION

DESCRIPTION

Disabled

Check this to hide the custom field on the UI.

Is Compulsory

Check this to make the field mandatory. This field applies to client-side applications like Instore and does not undergo any server-side validation.

Is Updatable

Check this to make the field value modifiable - once entered can be updated again when needed. This field applies to client-side applications like Instore and does not undergo any server-side validation.

Disable Custom Field

Check this to inactivate the custom field.

Field Name

Name of the field.

Field Type

Choose the input type - text, text area, select box, checkbox, radio button, button, email body, feedback, and so on. Based on the option you choose, you will see relevant configuration fields. For example, if it is a select box, you need to enter the supported values to select.

Field Scope

Choose the entry of the custom field from the options available.

  • Loyalty registration

  • Loyalty transaction

  • Customer feedback

  • Zone custom fields

  • Store custom fields

  • Points redemption

  • Voucher redemption (coupon redemption)

  • Customer advanced feedback

  • Customer preferences

Label

Enter the field name to appear on the UI

Default Values

Enter the values of the field in case of a selection field such as radio button, checkbox, select box, and so on.

Position

Specify the sequence order of the custom field. For example, 1 to appear in the first position of the form. This field applies to client-side applications like Instore and does not undergo any server-side validation.

Regular Expression for verification

Configure regex for the field value in the case of the free text field.

Error message for Regex Failure

Enter the error message to show in case of regex failure.

Help Text For The Field

Enter the help text(more information) you want to show for the field. This appears on the right of the field

Attributes (Format = Label:Value)

Enable Audit Trail

Select the checkbox if you want to enable audit logging of the custom field. You can add up to 5 custom fields for audit logging.

Is this pii data ?

Select the checkbox if you want to classify the custom field as PII data.

Is this psi data

Select the checkbox to classify the extended field as sensitive data. Refer to the PSI data documentation for more information on classifying PSI data .

  1. Click Submit.

The custom field is created.

Viewing a custom field

  1. To view the new custom field, navigate to Organization Settings > Master Data Management > Data Model > Custom Fields.

  2. Click the scope of the custom field .
    All custom fields within the scope are visible.

  3. Click the custom field to view.

Updating a custom field

To create a custom field, perform the following:

  1. On InTouch, navigate to Organization Settings > Master Data Management > Data Model > Custom Fields.
  1. Select the field you want to modify.
  2. Click Edit.
  1. Update the custom field according to your requirements.
  2. Click Submit.

Deleting a custom field

To delete a custom field, perform the following:

  1. On InTouch, navigate to Organization Settings > Master Data Management > Data Model > Custom Fields.
  2. Click the field you want to delete.
  3. Click Edit.
  4. Select the Disable Custom Field.
  1. Click Submit.

After you make changes in a custom field:

  • For Store Server, perform a complete sync from Settings or wait till the next auto-sync completes.
  • For Thin Client, restart your thin client and check if you are able to view the changes.

Converting custom field to extended field

To convert a custom field to an extended field, raise a ticket to the Platforms team requesting the conversion. The converted extended field is be used in reports and campaigns.

📘

NOTE:

  • The platforms team verifies whether the conversion is necessary; otherwise, the request is rejected.
  • The platforms team carries out the mapping of custom field to extended field.

Updated 7 days ago