Application Launcher

This page provides information about the Custom Attributes API integration process for the following scenario:

Data engineers want to streamline data management processes through API integrations for daily flat file transfers. Their objective is to manage data with more flexibility and less manual tasks.

Important considerations

The following are the important considerations to manage and configure API integration:

Self-Service Integration: Manage and monitor your mapping configurations for custom calculations.
Extract, Transform, and Load (ETL) Tool Requirement: Use an ETL tool to transform your source system schema to match the CDP schema on a one-to-one basis. This is crucial as the API requires a consistent object format for upstream requests.
Scheduling and Ingestion: When enhancing an existing integration with this feature, the scheduling automatically aligns with your 24-hour pipeline refresh cycle. This applies unless you request a change to the scheduling.

When developing a fully automated solution and streamlining the process, see the API policy page to ensure the successful construction of your automated framework.

Important

You cannot modify custom attribute names as they are fixed and serve as placeholders in the data model. Ensure that you make a note of the placeholder attributes that are mapped to your source system fields.

Checklist for testing and pushing a payload of email events

Use the following checklist to test and push a payload of email events from an ESP to CDP:

S.No.	Task
1	Create an integration user account
2	Initiate your payload test

Initiating a payload test

Set up Payload Push in Postman with the following steps:
- Set up Postman.
- Click Add folder to create a new folder for Payload.
- In Name, enter All Types of Scenarios.
- Create a request to POST.
- In Name, enter Scenario - Pushing ERP New Loyalty Columns.
- Click Params.
- Select Key as scheme and Value as a1user.
  
  Post URL: https://api7-green.agilone.com/v2/*TENANTID*/dw/tracker?scheme=a1user.
  The following are the URL parameters:
  Cloud Region URL Endpoint Parameter Description
  AWS api7-green.agilone.com/v2
  api7-green indicates the AWS service endpoint to upload data to the DW tracker.
  /v2 indicates the version of the API.

Cloud Region	URL Endpoint	Parameter Description
AWS	api7-green.agilone.com/v2	`api7-green` indicates the AWS service endpoint to upload data to the DW tracker. `/v2` indicates the version of the API.

Validating data in CDP

Note

Ensure that you have the necessary add-on subscription for Interactive Queries.

Use the following procedure to validate data integration in the CDP:

Sign in to your CDP user interface.
Navigate to Interactive Queries > Queries.
Click Create to initiate a new query.
In the left panel, check the list of entities.
This list enables API data validation through entities starting with zone.datavalidation.dw_batch_<name entity>.

Querying entities

Query each entity individually or combine them based on the validation requirements.

Example: Querying individual batch entities

-- Customer entity
SELECT * 
FROM zone_datavalidation.dw_batch_customer;
-- Event entity
SELECT * 
FROM zone_datavalidation.dw_batch_event;

Example: Combining batch entities

SELECT *
FROM zone_datavalidation.dw_batch_customer AS c
LEFT JOIN zone_datavalidation.dw_batch_event AS e
  ON c.customer_id = e.customer_id;  -- Replace with the actual join key

Users create a view based on the entities and validations necessary for reviewing the dataset from the API integration.

Refer to CDP referential integrity IDs to understand the primary key relationships used for table joins. This step helps to validate how entity fields align with upstream data mappings.

This page provides information about the Custom Attributes API integration process for the following scenario:

Data engineers want to streamline data management processes through API integrations for daily flat file transfers. Their objective is to manage data with more flexibility and less manual tasks.

Important considerations

The following are the important considerations to manage and configure API integration:

Self-Service Integration: Manage and monitor your mapping configurations for custom calculations.
Extract, Transform, and Load (ETL) Tool Requirement: Use an ETL tool to transform your source system schema to match the CDP schema on a one-to-one basis. This is crucial as the API requires a consistent object format for upstream requests.
Scheduling and Ingestion: When enhancing an existing integration with this feature, the scheduling automatically aligns with your 24-hour pipeline refresh cycle. This applies unless you request a change to the scheduling.

When developing a fully automated solution and streamlining the process, see the API policy page to ensure the successful construction of your automated framework.

Important

Checklist for testing and pushing a payload of email events

Use the following checklist to test and push a payload of email events from an ESP to CDP:

S.No.	Task
1	Create an integration user account
2	Initiate your payload test

Initiating a payload test

Set up Payload Push in Postman with the following steps:
- Set up Postman.
- Click Add folder to create a new folder for Payload.
- In Name, enter All Types of Scenarios.
- Create a request to POST.
- In Name, enter Scenario - Pushing ERP New Loyalty Columns.
- Click Params.
- Select Key as scheme and Value as a1user.
  
  Post URL: https://api7-green.agilone.com/v2/*TENANTID*/dw/tracker?scheme=a1user.
  The following are the URL parameters:
  Cloud Region URL Endpoint Parameter Description
  AWS api7-green.agilone.com/v2
  api7-green indicates the AWS service endpoint to upload data to the DW tracker.
  /v2 indicates the version of the API.

Cloud Region	URL Endpoint	Parameter Description
AWS	api7-green.agilone.com/v2	`api7-green` indicates the AWS service endpoint to upload data to the DW tracker. `/v2` indicates the version of the API.

Validating data in CDP

Note

Ensure that you have the necessary add-on subscription for Interactive Queries.

Use the following procedure to validate data integration in the CDP:

Sign in to your CDP user interface.
Navigate to Interactive Queries > Queries.
Click Create to initiate a new query.
In the left panel, check the list of entities.
This list enables API data validation through entities starting with zone.datavalidation.dw_batch_<name entity>.

Querying entities

Query each entity individually or combine them based on the validation requirements.

Example: Querying individual batch entities

-- Customer entity
SELECT * 
FROM zone_datavalidation.dw_batch_customer;
-- Event entity
SELECT * 
FROM zone_datavalidation.dw_batch_event;

Example: Combining batch entities

SELECT *
FROM zone_datavalidation.dw_batch_customer AS c
LEFT JOIN zone_datavalidation.dw_batch_event AS e
  ON c.customer_id = e.customer_id;  -- Replace with the actual join key

Users create a view based on the entities and validations necessary for reviewing the dataset from the API integration.

Refer to CDP referential integrity IDs to understand the primary key relationships used for table joins. This step helps to validate how entity fields align with upstream data mappings.

This page provides information about the Custom Attributes API integration process for the following scenario:

Data engineers want to streamline data management processes through API integrations for daily flat file transfers. Their objective is to manage data with more flexibility and less manual tasks.

Important considerations

The following are the important considerations to manage and configure API integration:

Self-Service Integration: Manage and monitor your mapping configurations for custom calculations.
Extract, Transform, and Load (ETL) Tool Requirement: Use an ETL tool to transform your source system schema to match the CDP schema on a one-to-one basis. This is crucial as the API requires a consistent object format for upstream requests.
Scheduling and Ingestion: When enhancing an existing integration with this feature, the scheduling automatically aligns with your 24-hour pipeline refresh cycle. This applies unless you request a change to the scheduling.

When developing a fully automated solution and streamlining the process, see the API policy page to ensure the successful construction of your automated framework.

Important

Checklist for testing and pushing a payload of email events

Use the following checklist to test and push a payload of email events from an ESP to CDP:

S.No.	Task
1	Create an integration user account
2	Initiate your payload test

Initiating a payload test

Set up Payload Push in Postman with the following steps:
- Set up Postman.
- Click Add folder to create a new folder for Payload.
- In Name, enter All Types of Scenarios.
- Create a request to POST.
- In Name, enter Scenario - Pushing ERP New Loyalty Columns.
- Click Params.
- Select Key as scheme and Value as a1user.
  
  Post URL: https://api7-green.agilone.com/v2/*TENANTID*/dw/tracker?scheme=a1user.
  The following are the URL parameters:
  Cloud Region URL Endpoint Parameter Description
  AWS api7-green.agilone.com/v2
  api7-green indicates the AWS service endpoint to upload data to the DW tracker.
  /v2 indicates the version of the API.

Cloud Region	URL Endpoint	Parameter Description
AWS	api7-green.agilone.com/v2	`api7-green` indicates the AWS service endpoint to upload data to the DW tracker. `/v2` indicates the version of the API.

Validating data in CDP

Note

Ensure that you have the necessary add-on subscription for Interactive Queries.

Use the following procedure to validate data integration in the CDP:

Sign in to your CDP user interface.
Navigate to Interactive Queries > Queries.
Click Create to initiate a new query.
In the left panel, check the list of entities.
This list enables API data validation through entities starting with zone.datavalidation.dw_batch_<name entity>.

Querying entities

Query each entity individually or combine them based on the validation requirements.

Example: Querying individual batch entities

-- Customer entity
SELECT * 
FROM zone_datavalidation.dw_batch_customer;
-- Event entity
SELECT * 
FROM zone_datavalidation.dw_batch_event;

Example: Combining batch entities

SELECT *
FROM zone_datavalidation.dw_batch_customer AS c
LEFT JOIN zone_datavalidation.dw_batch_event AS e
  ON c.customer_id = e.customer_id;  -- Replace with the actual join key

Users create a view based on the entities and validations necessary for reviewing the dataset from the API integration.

Refer to CDP referential integrity IDs to understand the primary key relationships used for table joins. This step helps to validate how entity fields align with upstream data mappings.

Set up Body Payload in Postman with the following steps:

Click Body.

The following is the sample code:

{
    "Events":[
        {
          "SourceSystemID":"ERP",
          "TenantId":"465",
          "Type":"StoreVisit",
          "SourceCustomerNumber":"L01",
          "Email":"[email protected]",
          "EventTimeStamp":{{epochVariable}},
          "c_eventstringattribute01":"Enrolled"
        }  
    ],
    "Customers":[
        {
          "SourceSystemID":"ERP",
          "SourceCustomerNumber":"L01",
          "FirstName":"Jane",
          "LastName":"Smith",
          "Email":"[email protected]",
          "c_customerstringattribute02":"Gold",
          "c_customerdateattribute02":"2023-11-20",
          "c_customerintergerattribute01":"10010",
          "c_customerintergerattribute02":"9990",
          "c_customerstringattribute03":"In-Store Promo"
          }
    ]         
}

Click Pre-request Script and add the provided Postman script.
The system populates the current epoch date as {{epochVariable}}. For example:
```
function epoch (date) {
  pm.collectionVariables.set("epochVariable", Date.parse(date))
      console.log(pm.collectionVariables.get("epochVariable"))
}
const dateToday = new Date() 
const timestamp = epoch(dateToday)
```
The EventTimeStamp object contains the date and time when the payload is pushed to CDP.
Click Save and click Send.
For successful requests, Postman displays Status: 200 OK.

Set up Body Payload in Postman with the following steps:

Click Body.

The following is the sample code:

{
    "Events":[
        {
          "SourceSystemID":"ERP",
          "TenantId":"465",
          "Type":"StoreVisit",
          "SourceCustomerNumber":"L01",
          "Email":"[email protected]",
          "EventTimeStamp":{{epochVariable}},
          "c_eventstringattribute01":"Enrolled"
        }  
    ],
    "Customers":[
        {
          "SourceSystemID":"ERP",
          "SourceCustomerNumber":"L01",
          "FirstName":"Jane",
          "LastName":"Smith",
          "Email":"[email protected]",
          "c_customerstringattribute02":"Gold",
          "c_customerdateattribute02":"2023-11-20",
          "c_customerintergerattribute01":"10010",
          "c_customerintergerattribute02":"9990",
          "c_customerstringattribute03":"In-Store Promo"
          }
    ]         
}

Click Pre-request Script and add the provided Postman script.
The system populates the current epoch date as {{epochVariable}}. For example:
```
function epoch (date) {
  pm.collectionVariables.set("epochVariable", Date.parse(date))
      console.log(pm.collectionVariables.get("epochVariable"))
}
const dateToday = new Date() 
const timestamp = epoch(dateToday)
```
The EventTimeStamp object contains the date and time when the payload is pushed to CDP.
Click Save and click Send.
For successful requests, Postman displays Status: 200 OK.

Important considerations

Checklist for testing and pushing a payload of email events

Initiating a payload test

Validating data in CDP

Querying entities

Important considerations

Checklist for testing and pushing a payload of email events

Initiating a payload test

Validating data in CDP

Querying entities

Important considerations

Checklist for testing and pushing a payload of email events

Initiating a payload test

Validating data in CDP

Querying entities

Did not find what you were looking for?

Did not find what you were looking for?

Using Custom Attributes API integration

Important considerations

Checklist for testing and pushing a payload of email events

Initiating a payload test

Validating data in CDP

Querying entities

Using Custom Attributes API integration

Important considerations

Checklist for testing and pushing a payload of email events

Initiating a payload test

Validating data in CDP

Querying entities

Using Custom Attributes API integration

Important considerations

Checklist for testing and pushing a payload of email events

Initiating a payload test

Validating data in CDP

Querying entities

Did not find what you were looking for?

Did not find what you were looking for?