Setup Entities and Fields

View and Configure Extended Fields for the org

View Extended fields on InTouch

To view extended fields of your organization:

1. On InTouch navigate to Settings > Master Data Management > Data Model > Extended Fields.

You will see extended fields of each vertical as shown below.

Click on each vertical to see the extended fields enabled for your org.

Edit extended fields & Add enum values using InTouch

You can update an extended field to show/hide it, set the position on the UI, choose whether mandatory or optional, and add enum values. The extended field format is longtext, which supports up to 4GB of text.

To add custom enum values to an extended field, click on the extended field

1. To see extended fields of a vertical, click the respective + icon.

Configure org extended fields and enum values through API

You can view the list of extended fields enabled for an organization through a V2 API.

Request: https://{host}/v2/extendedFields

Method: GET

Sample Request: https://newapi.nightly.capillary.in/v2/extendedFields

Sample Response:

{
"entity": {
"CUSTOMER": [
{
"name": "gender",
"createdBy": -1,
"createdOn": "2017-04-12",
"modifiedBy": -1,
"modifiedOn": "2017-04-12",
"label": "Gender",
"entityType": "CUSTOMER",
"dataType": "STANDARD_ENUM"
},
{
"name": "marital_status",
"createdBy": -1,
"createdOn": "2017-05-18",
"modifiedBy": -1,
"modifiedOn": "2017-05-18",
"label": "Marital Status",
"entityType": "CUSTOMER",
"dataType": "STANDARD_ENUM"
},
{
"name": "Age",
"createdBy": -1,
"createdOn": "2017-05-18",
"modifiedBy": -1,
"modifiedOn": "2017-05-18",
"label": "amount",
"entityType": "CUSTOMER",
"dataType": "INTEGER"
},
{
"name": "Region",
"createdBy": -1,
"createdOn": "2017-05-18",
"modifiedBy": -1,
"modifiedOn": "2017-05-18",
"label": "Region",
"entityType": "CUSTOMER",
"dataType": "CUSTOM_ENUM"
},
{
"name": "dob",
"createdBy": -1,
"createdOn": "2017-06-13",
"modifiedBy": -1,
"modifiedOn": "2017-06-13",
"label": "Date of Birth",
"entityType": "CUSTOMER",
"dataType": "DATETIME"
},
{
"name": "ssnNumber",
"createdBy": -1,
"createdOn": "2017-06-13",
"modifiedBy": -1,
"modifiedOn": "2017-06-13",
"label": "SSN Number",
"entityType": "CUSTOMER",
"dataType": "STRING"
},
{
"name": "nationality",
"createdBy": -1,
"createdOn": "2017-06-13",
"modifiedBy": -1,
"modifiedOn": "2017-06-13",
"label": "Nationality",
"entityType": "CUSTOMER",
"dataType": "STRING"
},
{
"name": "language",
"createdBy": -1,
"createdOn": "2017-06-13",
"modifiedBy": -1,
"modifiedOn": "2017-06-13",
"label": "Preferred Language",
"entityType": "CUSTOMER",
"dataType": "STRING"
},
{
"name": "ethnicity",
"createdBy": -1,
"createdOn": "2017-07-20",
"modifiedBy": -1,
"modifiedOn": "2017-07-20",
"label": "Ethnicity",
"entityType": "CUSTOMER",
"dataType": "STRING"
},
{
"name": "zip",
"createdBy": -1,
"createdOn": "2017-07-20",
"modifiedBy": -1,
"modifiedOn": "2017-07-20",
"label": "Zip Code",
"entityType": "CUSTOMER",
"dataType": "STRING"
}
],
"REGULAR_LINEITEM": [
{
"name": "associate",
"createdBy": -1,
"createdOn": "2017-04-12",
"modifiedBy": -1,
"modifiedOn": "2017-04-12",
"label": "Associate",
"entityType": "REGULAR_LINEITEM",
"dataType": "CUSTOM_ENUM"
},
{
"name": "uuid",
"createdBy": -1,
"createdOn": "2017-04-12",
"modifiedBy": -1,
"modifiedOn": "2017-04-12",
"label": "UUID",
"entityType": "REGULAR_LINEITEM",
"dataType": "STRING"
      },

"warnings": [],
"errors": [],
"success": true
}

Creating reports using extended fields

To display the extended fields on Insights and use this data for creating reports, perform the following:

1. Create a JIRA ticket to the Sustenance team and create a vertical level field on Capillary platform.
2. Create a JIRA ticket to the Insights team and create audience filter for the extended field.

Convert custom field to extended field

Once you have the custom field created, raise a ticket to the Platforms team requesting the conversion to the extended field. Once it is created, you can use the field in reports and campaigns.

However, the team verifies the request and decides whether to convert to the extended field.

📘

• The team might reject the request if the custom field is too specific and does not make general sense.
• The platform team takes care of mapping custom field values to extended fields.

Custom Fields

Custom fields are columns that store special or custom information related to customers, transactions, transaction line-items, coupons, and so on. As there is no control over the field values, it is difficult to run reports on custom fields. For example, if the custom field Gender has values M, F, and MF, it becomes difficult for an analyst to work directly on such data.

Create new custom fields

On InTouch, navigate to Profile > Organization Settings > Master Data Management > Data Model > Custom Fields.

The following are different entries for which you can create custom fields.

• 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

To see the custom fields of an entry, click the respective + icon.

To create a new custom field, click Add new custom field. The maximum number of characters supported for a custom field name is 20, and the maximum number of supported values for the custom field value is 250.

Fill in the fields and click Submit.

📘

When you make changes in a custom field

• For Store Server, do a complete sync from Settings or wait until the next auto-sync completes (usually every one hour).
• For Thin Client, please restart your thin client and check whether you are able to see the changes.