Setup Customer

Customer Registration Configuration

This article covers all settings related to customer registration and profile update.

To configure customer registration, follow these steps.

  1. On the InTouch home page, navigate to Profile > Organization Settings > Miscellaneous > Registration Configuration.
  2. Configure the required fields based on the description provided in the following table.
OPTIONDESCRIPTION
CONF_REGISTRATION_PRIMARY_KEYChoose the primary identifier of the customer. This is the unique identifier of the customer required for registration.
CONF_ALLOW_REGISTRATION_FROM_ANY_IDENTIFIERSSelect this to allow the registration of customers using any of the identifiers.
CONF_USERS_IS_EMAIL_REQUIREDCheck this if email id is a mandatory parameter to register a customer.
CONF_USERS_IS_EMAIL_UNIQUECheck this to make the email ID a unique identifier. If any registered email ID is registered the accounts will be merged automatically.
CONF_USERS_USE_EXTERNAL_IDCheck this to capture the external ID of customers while registering.
CONF_USERS_IS_EXTERNAL_ID_REQUIREDCheck this to make the external ID mandatory to register a customer. Not applicable if the external ID is the primary identifier.
CONF_USERS_IS_MOBILE_REQUIREDCheck this to make the mobile number mandatory to register a customer. Not applicable if mobile is the primary identifier.
CONF_ALLOW_MOBILE_UPDATECheck this to allow updating registered mobile numbers of customers.
CONF_ALLOW_EMAIL_UPDATECheck this to allow updating registered email IDs of customers.
CONF_LOYALTY_ALLOW_EXTERNAL_ID_UPDATECheck this to allow updating registered external IDs of customers.
CONF_PRIMARY_IDENTIFIER_STRICT_CHECKCheck this to verify if the primary identifier is already registered in a different account.
An error message will be displayed that the secondary identifier match is found in a different account but not the primary identifier.
CONF_SKIP_SECONDARY_ID_ON_PRIMARY_MISMATCHCheck this to skip account merging if only secondary identifiers match but primary identifiers are different.
A new customer will be created with the provided primary identifier. The secondary identifier will be ignored automatically.
USE_CRM_REGISTRATION_INFO_FROM_BASE_STORENA
CONF_GIFT_CARD_ENABLEDCheck this to enable gift card
CONF_ORG_CURRENCY_CODESet the ISO currency code of the org.
CONF_ORG_CURRENCY_SYMBOLSet the currency symbol of the org as per the currency code.
CONF_MIN_REGISTRATION_DATESet the minimum date and time from which the registration is valid. Registration fails if the registration date and time is prior to the value set herein ( especially through API or Data Import).
SERVER_VALIDATION_PIN_SMSConfigure the verification SMS that will be sent to customers to validate the registered mobile numbers. Use the tag {{pin}} to insert the verification PIN in the message.
For example, Please use the code {{pin}} to verify your mobile number.
SERVER_VALIDATION_PIN_EMAILConfigure the verification email that will be sent to customers to validate the registered email ID. Use the tag {{pin}} to insert the verification PIN in the message.
For example, Please use the code {{pin}} to verify your email ID.
CONF_LOYALTY_REGISTER_CUSTOMER_GENDERChoose the custom field for gender from the drop-down.
CONF_LOYALTY_REGISTER_CUSTOMER_AGEChoose the custom field for age from the drop-down.
CONF_CLIENT_V2_API_ENABLEDCheck this if sources other than InStore are supported for the org.
CONF_GEN_CARD_NUMBER_AS_EXTERNAL_ID_ENABLEDCheck this to enable generating external IDs automatically from the Capillary end.
SOURCE_ACCOUNTS_EXTERNALID_ENABLEDCheck this to enable support for external ID capture.
CONF_CARD_NUMBER_GENERATION_ENABLEDCheck this to enable generating card numbers automatically from the Capillary end.
CONF_CARD_NUMBER_SUFFIXSpecify the suffix you want to have for the external card (supports alphanumeric value).
CONF_CARD_NUMBER_PREFIXSpecify the prefix for the external card (supports alphanumeric value). For example, BRAND20.
CONF_CARD_NUMBER_LENGTHSpecify the length of the external card. You can have up to 50 characters.
CONF_CARD_NUMBER_OFFSETSpecify the card sequence numbers that you want to ignore from the top. For example, if you set 10, the first 10 cards will be considered invalid.
Check this to enable primary identifier checks when registering or updating customers.
CONF_IDENTIFIERS_SYNC_ENABLEDCheck this to update identifiers that are modified in a source automatically in other sources.
CONF_CLIENT_DEFAULT_COUNTRYCODE_PASSEDCheck this to auto select country code to the mobile number entered on the registration screen. The validation sequence will be as follows.
validates initial letters of mobile numbers for base or supported currency codes.
inserts each country code and validates the number. First with base country code, followed by supported country codes.

External ID configuration

You can use the below configurations to enable the generation of a customised external ID for the customers. Once this configuration is enabled, the external ID in the customer add API payload will be replaced with the generated external ID.

❗️

There is no UI to enable this configuration. You need to raise a JIRA ticket (sample ticket) to the sustenance team to enable these configurations. Turn around time is five days.

Configuration & DescriptionValue
CONF_CARD_NUMBER_GENERATION_ENABLED (Mandatory)
Enables external ID number generation.
0 - Disable
1 - Enable
SOURCE_ACCOUNTS_EXTERNALID_ENABLED (Mandatory)
Enables external ID generation only for the defined source account in the Customer ADD API.
["INSTORE:"] - Instore

["web_engage:1234"] -
Webengage where 1234 is the account id

["INSTORE:", "web_engage:1234"] - Both Instore and webengage where 1234 is account id.
CONF_CARD_CHECKSUM_DIGIT_ALGO (Mandatory)
Defines the algorithm to generate the checksum. The checksum is added as the last digit of the external ID.
LUHN_ALGO, MOD7_ALGO, AUTO_INC
CONF_CARD_NUMBER_LENGTH (Mandatory)
Defines the external ID length. This is the total length of the external id including prefix, suffix, and checksum.
Note: Suffix is not applicable for MOD7 and LUHN_ALGO (MOD10) algorithms.
Example: If card number length = 12, Prefix = 1234, Suffix = 3401, Offset = 3000, and algorithm = AUTO_INC, then card number can be 123430003401.
Integers ranging from 1-50.
CONF_CARD_NUMBER_OFFSET (Optional)
Defines the offset value for the external ID. For example for a card number series with offset value 3000, can be 111200000030004, 111200000030015 etc.
Any integer value
CONF_CARD_NUMBER_PREFIX (Optional)
Defines the prefix for the external ID number.
Any integer value but prefix + suffix + system-generated number should not be more than 50.
CONF_CARD_NUMBER_SUFFIX (Optional)
Defines the SUFFIX for the external ID number. This is only applicable for AUTO_INC alogrithm.
Any integer value but prefix + suffix + system-generated number should not be more than 50.
CONF_VALUES_TO_INCLUDE_FOR_CHECKSUM_DIGIT (Optional)
Specifies whether the prefix should be considered when generating the checksum value.
PREFIX - Prefix is considered
NONE - Prefix is not considered

Customer ingestion restriction configuration

❗️

There is no UI to enable this configuration. You need to raise a JIRA ticket (sample ticket) to the sustenance team to enable these configurations. Turn around time is five days.

CONF_RESTRICT_ORPHAN_V2_PROFILE - This configuration prevents the ingestion of a WebEngage profile into the Capillary platform for a specific customer if they do not already have an existing Instore profile.

Managing customer lifecycle with customer status

A customer status defines the relationship between a brand and a customer. For example, a customer who interacts often with the brand can be defined as an active customer. Further, these statuses can be used to run the loyalty program and assign coupons, reward points etc accordingly. For example, more offers can be offered to a customer to make an inactive customer to active customer..

Activating customer status

To activate customer status for your organisation, navigate to Organisation settings> Miscellaneous> Customer Status configuration and select the Enable customer status check box.

On enabling the customer status, the existing fraud status will be replaced by the customer status function.

Types of customer statuses

The various customer statuses available in the Capillary platform that you can configure are:

  1. Active
  2. Suspended
  3. Deleted
  4. Fraud suspected
  5. Fraud confirmed
  6. Internal
  7. Pending deletion

Creating a custom label

You can click the Create new label option in the customer label and enter a new label name to assign a custom name for the status. You can add multiple labels if required. The first status label that you create is set as the default status value.

Active customer status

The active status can be used to indicate that the customer is active.

📘

NOTES:

  • There are no restrictions for customers with Active status.
  • All customers are marked Active by default.

Suspended, Fraud suspected, Fraud confirmed, and Internal customer status

You can restrict the following operations for the users with Suspended, Fraud suspected, Fraud confirmed or Internal status.

RestrictionDescription
Block coupons redemptionRestrict from redeeming coupons.
Block issual of loyalty promotionsRestrict from receiving points.
Block identifier change and account mergeRestrict from account merging and identifier change requests.
Block issual of badgesThis is a future development feature.
Block issual of couponsRestrict from providing coupons.
Block enrollment into loyalty promotionsThis is a future development feature.
Block points allocationRestrict from providing points.

When this restriction is added on any label, then the points allocation from any points-related action (like transaction point allocation, allocation points, target point allocation, issue to the referrer, issue to referee, goodwill points, import profile) will be blocked for the customer.
Block points redemptionRestrict from redeeming points.
Block tier upgradeRestrict from tier upgrade.
Block transactionRestrict future transactions.
Mark transaction outlierMark the transactions made by the selected label(s) as outliers.

To restrict access, select the individual status labels or all the created status labels from the desired restriction drop-down. Click Select, and then click Update.

Deleted customer status

The deleted status allows you to block every action for customers with this status. To configure restriction, from the Block everything drop-down, select the individual custom labels or select all labels created for Deleted. Click Select and then click Update.

Pending deletion customer status

This status is used to indicate the status of customers for whom a deletion request is raised. For Pending Deletion, whenever a PII deletion request is triggered, a label Deletion_pending is automatically created and assigned to the customer, regardless of any other label that may have been created and set as default.