Onboard Tenant Account

About this task

Important:
This topic applies only to AWS deployments.

After creating a tenant account in the admin portal, back-end onboarding is required to complete the setup process. This step ensures that the tenant is fully recognized by the system and properly integrated across all supporting services.

To enable full functionality, the tenant account must be registered in the application database. For clients with an associated campaign ID, this identifier must be inserted into the database and propagated across all dependent services. These tasks are typically performed by platform administrators or back-end operations teams to ensure smooth and secure onboarding.

Perform the user-interface steps for tenant onboarding.

Procedure

  1. Login to the aws account and click Create Key.
    AWS Customer managed keys
  2. Use the default values, and click Next.
    Configure key - Symmetric, Encrypt and decrypt
  3. In the Alias field, enter alias name and description, and Add tags, if required. Click Next.
    Add labels - Alias field
  4. Uncheck the Key deletion, and click Next.
    Key deletion checkbox
  5. Select the Key users with required role and permissions from EKS level to the AWS like put S3, Glue, Athena, and SQS.
    Define key usage permissions]
  6. After KMS key is created, copy and add the key in HCL CDP admin-ui.

Tenant Onboarding

Procedure

  1. After successful creation of a client, Login to HCL CDP Admin UI, and create an tenant accout. For more information on createing tenant account, refer.
  2. After successfully creating the tenant account, you will be navigated to the Client Onboarding page. Click CLIENT ONBOARDING.
    Client Onboarding Page
  3. In the Client Onboarding pop-up, a default CampaignID will be generated and assigned. Select the region and add the KMS key which is created from AWS.
  4. Click Submit.
    Client Onboarding Dialog Box
  5. After successful tenant creation, the Onboarding completed message will be displayed.
    Onboarding completed notification popup
  6. Run the following insert queries for CDPDashboards. Replace tenantId with newly onboarded tenantId. 
    INSERT INTO CDPDashboards (dashboardType,name,description,tenantId,layout,createdBy,updatedBy,createdOn,updatedOn,isActive) VALUES
(default,'Main CDP Dashboard','Main Dashboard <tenantId>',<tenantID>,1,NULL,'2026-03-16 11:15:26','2026-03-16 11:15:26',1)
    INSERT INTO CDPDashboards (dashboardType,name,description,tenantId,layout,createdBy,updatedBy,createdOn,updatedOn,isActive) VALUES
(cov,'COV Dashboard','COV Dashboard <tenantId>',<tenantID>,1,NULL,'2026-03-16 11:15:26','2026-03-16 11:15:26',1)
  7. Run below query to get DashboardId's. Replace newly created tenantId with newly onboarding tenantId. 
    select * from CDPDashboards where tenantId=<newly created tenant Id>;
  8. Replace the "dashboardID" with the ID of Main Dashboard from the table CDPDashboards and "covDashboardId" with the ID of COV Dashboard from the table CDPDashboards in below query. These IDs are obtained from the earlier query. 
    INSERT INTO CDPDashboardGroups (dashboardId,dashboardType,name,sequenceIndex,readOnly,layout,createdBy,updatedBy,createdOn,updatedOn,isActive) VALUES
 (dashboardID,'default','Performance Metrics',1,1,'{"cards": [{"h": 15, "w": 24, "x": 24, "y": 15, "type": 13, "cardId": 9, "isVisible": true}, {"h": 15, "w": 24, "x": 24, "y": 0, "type": 13, "cardId": 5, "isVisible": true}, {"h": 15, "w": 24, "x": 0, "y": 15, "type": 13, "cardId": 2, "isVisible": true}, {"h": 15, "w": 24, "x": 0, "y": 0, "type": 13, "cardId": 1, "isVisible": true}]}',1,NULL,'2026-03-16 11:15:26','2026-03-16 11:15:26',1),
 (dashboardID,'default','Revenue Overview',3,1,'{"cards": [{"h": 16, "w": 24, "x": 24, "y": 0, "type": 13, "cardId": 3, "isVisible": true}, {"h": 16, "w": 24, "x": 0, "y": 0, "type": 13, "cardId": 7, "isVisible": true}, {"h": 15, "w": 24, "x": 0, "y": 16, "type": 13, "cardId": 6, "isVisible": true}]}',1,NULL,'2026-03-16 11:15:26','2026-03-16 11:15:26',1),
 (dashboardID,'default','Channel Overview',2,1,'{"cards": [{"h": 16, "w": 48, "x": 0, "y": 0, "type": 3, "cardId": 4, "isVisible": true}]}',1,NULL,'2026-03-16 11:15:26','2026-03-16 11:15:26',1),
 (dashboardID,'default','All Widgets',9999,1,'{"cards": []}',1,NULL,'2026-03-16 11:15:26','2026-03-16 11:15:26',1),
 (covDashboardId,'cov','Demographic overview',1,1,'{"cards": [{"h": 15, "w": 24, "x": 0, "y": 0, "type": 13, "cardId": 43, "isVisible": true}, {"h": 15, "w": 24, "x": 24, "y": 0, "type": 13, "cardId": 45, "isVisible": true}, {"h": 17, "w": 24, "x": 24, "y": 15, "type": 13, "cardId": 46, "isVisible": true}, {"h": 17, "w": 24, "x": 0, "y": 15, "type": 13, "cardId": 42, "isVisible": true}]}',1,NULL,'2026-03-16 11:15:26','2026-03-16 11:15:26',1),
 (covDashboardId,'cov','All Widgets',9999,1,'{"cards": []}',1,NULL,'2026-03-16 11:15:26','2026-03-16 11:15:26',1);
  9. Update the defaultdashboard ID and cov dashboardId in the below query of DMPCampaign. 
    "dashboardConfig":{"default":{"id":<defaultdashboard Id>},"cov":{"id":<cov dashboardId>}}
  10. Update the query like shown below. Replace campaignId with newly onboarded tenantId. 
    update DMPCampaign set
Config='{"featureEnablingConfig":{"isDestinationEnabled":true,"isSourceConnectionEnabled":true,"isConnectionsEnabled":true,"sources":{"allEnabled":true},"destinations":{"allEnabled":true},"isCustomerPropertiesEnabled":true,"isCalculatedPropertiesEnabled":true,"isChannelsAvailable":true,"isSegmentsAvailable":true,"isReportingEnabled":true,"isFunnelReportsEnabled":true,"isPathMetricsReportsEnabled":true,"isUserReportsEnabled":false,"isCampaignReportsEnabled":false,"isSettingsAvailable":true,"isOfflineDataSourceEnabled":true,"isProfileUploadEnabled":true,"isCustomerOneViewEnabled":true,"isEventsReportsEnabled":true,"isTelemetryReportsEnabled":true,"isLiveEventEnabled":true,"isURLReportingEnabled":true,"isEventsDashboardEnabled":true,"eventOccurrenceEnabled":true,"isCampaignSummaryEnabled":true,"isAnalyticsEnabled":true,"eventTrendsEnabled":true,"isDashboardEnabled":true,"isCampaignEnabled":true,"cov":{"isCovBasicDetailsEnabled":true,"isCovAttributeEnabled":true,"isCovDeviceEnabled":true,"isCovCampaignEnabled":true,"isCovActivityEnabled":true,"isCovVoiceFlowEnabled":false},"isOldCovActivityEnabled":true,"isLinkEnabled":true,"isAngularChannels":true,"isAngularDashboard":true,"isAngularSegment":true,"isAngularCov":true},"BusinessGeo":{"region":"aps1","tkd":{"regionUrl":"http://your-tkd-domain.com:8001"},"dash":{"regionUrl":"http://your-dash-domain.com:8080"}},"isCustomListSegmentEnabled":true,"capsSettingsConfig":{},"cdnType":"cloudFront","tagInfo":{"__onsiteEndpoint__":"your-onsite-endpoint.example.com/","__analyzeUrl__":"https://your-analytics-domain.example.com/analyze/analyze.php","__fpcUrl__":"https://your-analytics-domain.example.com/analyze/cookieCallback.php?cb=","__curCamp__":"VIZVRM6536","__cookieDomain__":"your-cookie-domain.example.com","__domainList__":"your-brand-domain.example.com","__logLevelFlag__":1,"__advId__":6543,"version":"v3","uglify":true},"navConfig":{"dashboard":{"id":49},"campaign":{"id":50},"cov_basic":{"id":51,"ai_card_id":157},"cov_campaign":{"id":52}},"dashboardConfig":{"default":{"id":3},"cov":{"id":4}},"maxPasswordAgeInDays":"90"}'
where CampaignId=campaignId;