--- title: "Using Custom Attributes" date: "2024-02-29T03:50:34+00:00" summary: "Learn how to use custom attributes to streamline data integration, add new columns, and include specific fields in CDP for data engineers and IT professionals." image: type: "page" url: "/customer-data-platform/using-custom-attributes" id: "a66c8015-4324-406d-8254-aef73f9912d0" --- 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: * Use the **Tracker API (DW Tracker)** for backend or server-side requests. * Implement preconfigured SFTP. 2 Define and configure custom attributes Use the CDP Studio Apps UI to complete this task. 3 Surface custom attributes [Surfacing custom attributes](#surfacing-custom-attributes). 4 Verify the newly surfaced custom attributes in Campaigns+ [Verifying the newly surfaced custom attributes in Campaigns+](#verifying-the-newly-surfaced-custom-attributes-in-campaign+) 5 Verify the newly surfaced custom attributes in Metrics [Verifying 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](#verifying-the-newly-surfaced-custom-attributes-in-interactive-queries) 7 Verify the newly surfaced custom attributes in Cloud Data Export [Verifying Cloud Data Export](#verifying-data-export) Surfacing custom attributes --------------------------- 1. [Sign in to your CDP user interface](../../getting-started/signin-cdp.html). 2. Click **CDP Studio**. The CDP Studio landing page only displays the features that you can access. 3. Click **Launch Custom Attributes**. The application displays the Surface Custom Attributes page. 4. In the **Please select the table for which custom attributes need to be surfaced** dropdown, select `customer`. 5. In the **Please select the custom attribute that you want to surface** dropdown, select `c_customerstringattribute01`**.** 6. 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: 1. 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. 2. In the **Please enter a description for the custom attribute** field, enter a description. ![cdp_surface-custom-attribute.png](https://acquia.widen.net/content/wpmaurzlbr/web/cdp_surface-custom-attribute.png?w=720&v=821103ca-4282-421b-ab17-7cea30b98c2d&itok=MU5BWhG-) 3. Click **Surface**. The system displays the following notifications on completion of surfacing. ![cdp_surface-notifications.png](https://acquia.widen.net/content/gi79xqnuig/web/cdp_surface-notifications.png?w=720&v=d313aefa-53fc-4768-96a6-ae977031b9e0&itok=vbSxyh_6) 7. Repeat the same steps to surface more custom attributes. Verifying the newly surfaced custom attributes in Campaign+ ----------------------------------------------------------- 1. [Sign in to your CDP user interface](../../getting-started/signin-cdp.html). 2. Navigate to **Actions** > **Campaigns+**. 3. Click **New Campaign**. 4. On the Setup page, provide a name and description (optional) for your campaign. 5. Click **Next**. 6. In **Include customers who**, click the **Add Group** icon. The system displays the Add Rule page. 7. Click **Customer Attributes**. 8. Verify the newly surfaced custom attribute `Loyalty Enrollment Source` business filter. The system displays `Loyalty Enrollment Source` filter along with other Loyalty filters. ![cdp_verify-surfaced-attribute.png](https://acquia.widen.net/content/kxc03f8ezf/web/cdp_verify-surfaced-attribute.png?w=720&v=ae9da39f-7892-43ea-868b-68d5107387fb&itok=Eoh6EQCk) The Custom Attribute Event serves as a refine filter for the `StoreVisit` event type, and provides a detailed filter within the event data. 9. Search the **Performed an event** filter. ![Interface for adding rules with search results and options for event-related actions displayed. Categories listed on the left sidebar.](https://acquia.widen.net/content/racwat16fz/web/cdp_performed-an-event-filter.png?w=720&v=b612873b-994c-496a-92a9-c79e453eaf36&itok=Mm1u1s6U) 10. Select `StoreVisit`. 11. Click **Add Refinements to existing Rule**. ![Filter settings interface showing an event "SlowWalk" set to occur within the last 5 minutes.](https://acquia.widen.net/content/dctwxvuiln/web/cdp_add-new-refinement.png?v=f825550a-77c4-44de-b06b-f9249c7ac270) 12. Search the **Loyalty** filter. ![Search interface for "Loyalty" with options: Event, Organization Summary, Product, Product Category, and Loyalty Program Status.](https://acquia.widen.net/content/enfbabxssh/web/cdp_loyalty-filter.png?w=480&v=d50f887b-a617-497e-8f8e-4a9b0c1e5edf&itok=oB7is_KZ) 13. Locate and apply the `Loyalty Program Status` filter from the search results. ![Filter settings showing "Store/Visit" event within the last 5 minutes, with "Loyalty Program Status" as "Enrolled."](https://acquia.widen.net/content/msmjnbsbdw/web/cdp_loyalty-program-status.png?v=6089b3b9-5f5a-4f95-b416-253f6c9c8b75) Verifying the newly surfaced custom attributes in Metrics --------------------------------------------------------- 1. [Sign in to your CDP user interface](../../getting-started/signin-cdp.html). 2. Navigate to **Analytics** > **Metrics**. 3. Click **New**. 4. Select **New Look**. 5. Search for the Loyalty dimension and measure. The system displays Loyalty Enrolment Source dimension along with other Loyalty filters. ![Search interface showing "Loyalty" fields under "Customer" dimensions and measures, including enrollment source, tier level, date, current points, and remaining points.](https://acquia.widen.net/content/t0knajdtsw/web/cdp_metrics-search.png?w=480&v=446eefb1-3548-4e49-a5f3-f0303487c3bb&itok=lPtpxrdm) 6. To finalize the Look: 1. Filter `Loyalty Enrollment Source` to **In-Store Promo**. 2. Add dimensions and measures to your Look by using drag and drop or by clicking. ![Dashboard showing customer loyalty data with filters for enrollment source, dates, current points, and points needed for next tier.](https://acquia.widen.net/content/3iidrjkgff/web/cdp_in-store-promo-filter.png?w=720&v=1bbbfaaa-94f6-414a-b256-d4859242e7ec&itok=CY0Za_fE) Verifying the newly surfaced custom attributes in Interactive Queries --------------------------------------------------------------------- Note This is an add-on subscription available only with an active subscription. 1. [Sign in to your CDP user interface](../../getting-started/signin-cdp.html). 2. Click **Interactive Queries**. 3. Click **Create**. 4. Select **Query**. If the display name contains a space, enclose your new and renamed attribute in double quotation marks. 5. In the query editor, search for all newly renamed attributes. For example, `Loyalty Enrollment Source`, `Loyalty Current Points`, `Loyalty Enrollment Date`, `Loyalty Remaining`, and `Points to Next Tier`.  ![SQL query selecting "Loyalty Enrollment Source" from the "presentation.customersummary" table.](https://acquia.widen.net/content/j8lyjttdmt/web/cdp_query-editor-search.png?v=c5620139-3a4e-4999-bf63-811f3b837ea6) This example illustrates the renaming of `customerstringattribute01` to `Loyalty Enrollment Source`. Before renaming: ![SQL query with autocomplete suggestions for "c_customer" attributes, including dateattribute01 to dateattribute10, displayed in a dropdown list.](https://acquia.widen.net/content/z2vwoiwebw/web/cdp_attribute-before-renaming.png?v=2a9de262-6372-4b36-8766-e2166f20e3c5) After renaming: ![SQL query with syntax highlighting, selecting "loyalty" from "p loyalty enrollment source" table.](https://acquia.widen.net/content/8gabihcjf8/web/cdp_attribute-after-renaming.png?v=a9211bf5-037e-4370-9976-075177ce5c48) ### 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 --------------------- Note This is an add-on subscription available only with an active subscription. **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 1. Navigate to **Cloud Data Export**. 2. Create a new Data Export file or open an existing one. If required, provide a name for your export file. 3. Select the tables and Loyalty custom attributes that must be extracted to a cloud service. ![Cloud Data Export interface showing options for selecting and customizing customer-specific content, with lists for loyalty program data and an empty selection area.](https://acquia.widen.net/content/edf2ktyetc/web/cdp_cloud-data-export.png?v=e9000e16-2a16-42b2-b227-a9ef7ef68ff2) 4. Navigate to the **Customer** folder. 5. Search for the **Loyalty Custom Attributes** columns. 6. Click the Add (**+**) icon to select the Loyalty Custom Attributes columns for export. ![Cloud Data Export interface showing available and selected content lists for customer data, with options like loyalty program status and enrollment details.](https://acquia.widen.net/content/d6xer8zc8x/web/cdp_cloud-data-export-content.png?v=e08c12bd-f38e-4e48-8639-bf4b75617236) 7. Set your delivery preferences by selecting the cloud service destination. 8. Review the **Summary** to ensure accuracy. ![Summary table with fields for ID, Creator, Last Updated By, and Content, displaying loyalty program details.](https://acquia.widen.net/content/y82vbtpglv/web/cdp_cloud-data-export-summary.png?v=5909acc4-ab17-4409-8526-821a902f41a0) 9. 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](/customer-data-platform/using-custom-attributes-api-integration "Using Custom Attributes API integration") and [Using Custom Attributes SFTP integration](/customer-data-platform/using-custom-attributes-sftp-integration "Using Custom Attributes SFTP integration").