This page provides information about how to use custom attributes for the following scenario:
Data engineers and IT professionals want to streamline the integration of source systems by adding new columns to the data models. Following the integration of the ERP system with a loyalty program, they must be able to include specific fields from the new columns into the existing CDP integration.
Checklist for using custom attributes
Complete the following tasks to use custom attributes for the given scenario:
S.No. | Task | Additional information |
---|---|---|
1 | Choose a mapping integration method | The chosen method must align with your requirements for existing and new upstream source systems:
|
2 | Define and configure custom attributes | Use the CDP Studio Apps UI to complete this task. |
3 | Surface custom attributes | Surfacing custom attributes. |
4 | Verify the newly surfaced custom attributes in Campaigns+ | Verifying the newly surfaced custom attributes in Campaigns+ |
5 | Verify the newly surfaced custom attributes in Metrics | Verifying the newly surfaced custom attributes in Metrics |
6 | Verify the newly surfaced custom attributes in IQ | Verifying the newly surfaced custom attributes in IQ |
7 | Verify the newly surfaced custom attributes in Cloud Data Export | Verifying Cloud Data Export |
Surfacing custom attributes
- Sign in to your CDP user interface.
Click CDP Studio.
The CDP Studio landing page only displays the features that you can access.
Click Launch Custom Attributes.
The application displays the Surface Custom Attributes page.
- In the Please select the table for which custom attributes need to be surfaced dropdown, select
customer
. - In the Please select the custom attribute that you want to surface dropdown, select
c_customerstringattribute01
. - For the Please enter the display name for the custom attribute and Please enter a description for the custom attribute fields, do one of the following:
If system auto-populates the display name and description for the custom attribute, click Surface.
For example, the system auto-populates the display name as
Loyalty Enrollment Source
.- If system does not auto-populate the display name and description for the custom attribute:
In the Please enter the display name for the custom attribute field, enter a display name ensuring that first letter of each word is capitalized.
Enter only alphanumeric characters, numbers, spaces, and hyphens for display names or descriptions. 41 symbols are classified into the following categories:
Numbers:
0-9
are allowed.Punctuations:
.
,,
,;
,:
,?
,!
,'
,"
,-
,_
,/
,|
,{}
,()
,[]
,<>
are allowed and\
is not allowed.Arithmetic and Mathematical Symbols:
+
,-
,*
,/
,=
,%
are allowed.Miscellaneous Symbols:
@
,#
,$
,^
,&
,*
,~
,|
are allowed.
In the Please enter a description for the custom attribute field, enter a description.
Click Surface.
The system displays the following notifications on completion of surfacing.
- Repeat the same steps to surface more custom attributes.
Verifying the newly surfaced custom attributes in Campaign+
- Sign in to your CDP user interface.
- Navigate to Actions > Campaigns+.
- Click New Campaign.
- On the Setup page, provide a name and description (optional) for your campaign.
- Click Next.
In Include customers who, click the Add Group icon.
The system displays the Add Rule page.
- Click Customer Attributes.
Verify the newly surfaced custom attribute
Loyalty Enrollment Source
business filter.The system displays
Loyalty Enrollment Source
filter along with other Loyalty filters.The Custom Attribute Event serves as a refine filter for the
StoreVisit
event type, and provides a detailed filter within the event data.Search the Performed an event filter.
Select
StoreVisit
.Click Add Refinements to existing Rule.
Search the Loyalty filter.
Locate and apply the
Loyalty Program Status
filter from the search results.
Verifying the newly surfaced custom attributes in Metrics
- Sign in to your CDP user interface.
- Navigate to Analytics > Metrics.
- Click New.
- Select New Look.
Search for the Loyalty dimension and measure.
The system displays Loyalty Enrolment Source dimension along with other Loyalty filters.- To finalize the Look:
- Filter
Loyalty Enrollment Source
to In-Store Promo. Add dimensions and measures to your Look by using drag and drop or by clicking.
- Filter
Verifying the newly surfaced custom attributes in Interactive Queries
Click Interactive Queries.
- Click Create.
Select Query.
If the display name contains a space, enclose your new and renamed attribute in double quotation marks.
In the query editor, search for all newly renamed attributes.
For example,Loyalty Enrollment Source
,Loyalty Current Points
,Loyalty Enrollment Date
,Loyalty Remaining
, andPoints to Next Tier
.This example illustrates the renaming of
customerstringattribute01
toLoyalty Enrollment Source
.Before renaming:
After renaming:
Important considerations for migration
- To prevent confusion in user experience, a new entity schema is duplicated and migrated with a presentation prefix, such as
presentation.customersummary
. This helps to differentiate between the legacy and new entity schemas. Queries on custom attributes from the legacy entity are ineffective. Always use aggregate summary entities to query your custom attributes.
For example, build queries with the new
CustomerSummary
entity.Current Query (Legacy):
SELECT * FROM customersummary; Updated Query (New Entity): SELECT * FROM presentation.customersummary;
The IQ Export feature reflects the display names surfaced from the Custom Attributes (CDP Studio) application and exports the renamed custom attributes to your Service Cloud accordingly.
Verifying Data Export
Data Export | Available | Flow guide |
---|---|---|
Interactive Queries Export | Yes | The process follows the same flow as Interactive Queries. |
Cloud Data Export | Yes | The process follows the standard export procedure as described. |
Snowflake Data Share | No | Not offered |
- Navigate to Cloud Data Export.
Create a new Data Export file or open an existing one.
If required, provide a name for your export file.
Select the tables and Loyalty custom attributes that must be extracted to a cloud service.
- Navigate to the Customer folder.
- Search for the Loyalty Custom Attributes columns.
Click the Add (+) icon to select the Loyalty Custom Attributes columns for export.
- Set your delivery preferences by selecting the cloud service destination.
Review the Summary to ensure accuracy.
- To finalize the export, choose between Schedule and Save for Later or Send Now as an ad-hoc export.
For more information, see Using Custom Attributes API integration and Using Custom Attributes SFTP integration.