Sample JSON Files Reference

The CLI package includes comprehensive sample JSON files for all destination types and connector combinations. These files serve as templates and are located in the source repository. For more information, refer Configuration JSON Files.

File Naming Convention

  • Pattern: `create-destination-{DESTINATION}-{CONNECTOR}.json`
  • Components:
    • `{DESTINATION}`: `journey`, `interact`, `cdp`, `generic`
    • `{CONNECTOR}`: `kafka`, `db`, `kafka-db`

File Summary Table

Use the table below to select the appropriate sample file for your destination configuration needs:

File Name Destination Type Template ID Kafka MariaDB Use Case
Journey Destinations
create-destination-journey-kafka.json Journey 1 ✅ ❌ Journey events to Kafka only
create-destination-journey-db.json Journey 1 ❌ ✅ Journey events to database only
create-destination-journey-kafka-db.json Journey 1 ✅ ✅ Journey events to both Kafka and database
Interact Destinations
create-destination-interact-kafka.json Interact 2 ✅ ❌ Real-time offers via Kafka
create-destination-interact-db.json Interact 2 ❌ ✅ Offer logging to database
create-destination-interact-kafka-db.json Interact 2 ✅ ✅ Offers to both Kafka and database
CDP (Customer Data Platform) Destinations
create-destination-cdp-kafka.json CDP 3 ✅ ❌ CDP events to Kafka
create-destination-cdp-db.json CDP 3 ❌ ✅ CDP events to database
create-destination-cdp-kafka-db.json CDP 3 ✅ ✅ CDP events to both connectors
Generic Destinations
create-destination-generic-kafka.json Generic 4 ✅ ❌ Generic message formatted events to Kafka
create-destination-generic-db.json Generic 4 ❌ ✅ Generic message formatted events to database
create-destination-generic-kafka-db.json Generic 4 ✅ ✅ Generic message formatted events to both connectors

Connector Configuration Placeholders

Important: All sample files use placeholder values that must be replaced with actual configuration before use. Use the configuration commands to retrieve valid values.

Placeholder Pattern Replace With How to Find
<<JOURNEY_TOPIC_NAME>> Actual Kafka topic name Configure in your Kafka broker
<<JOURNEY_CLUSTER_NAME>> Configured Kafka cluster name Run get-all-kafka-cluster-names
<<JOURNEY_DATASOURCE_NAME>> Platform datasource name Run get-all-datasource-names-for-logged-in-user
<<JOURNEY_DATABASE_NAME>> MariaDB database/schema name Your MariaDB installation
<<INTERACT_TOPIC_NAME>> Kafka topic for Interact events Configure in your Kafka broker
<<INTERACT_CLUSTER_NAME>> Kafka cluster for Interact Run get-all-kafka-cluster-names
<<INTERACT_DATASOURCE_NAME>> Platform datasource for Interact Run get-all-datasource-names-for-logged-in-user
<<INTERACT_DATABASE_NAME>> Database for Interact events Your MariaDB installation
<<CDP_TOPIC_NAME>> Kafka topic for CDP events Configure in your Kafka broker
<<CDP_CLUSTER_NAME>> Kafka cluster for CDP Run get-all-kafka-cluster-names
<<CDP_DATASOURCE_NAME>> Platform datasource for CDP Run get-all-datasource-names-for-logged-in-user
<<CDP_DATABASE_NAME>> Database for CDP events Your MariaDB installation
<<GENERIC_TOPIC_NAME>> Kafka topic for generic events Configure in your Kafka broker
<<GENERIC_CLUSTER_NAME>> Generic Kafka cluster Run get-all-kafka-cluster-names
<<GENERIC_DATASOURCE_NAME>> Generic Platform datasource Run get-all-datasource-names-for-logged-in-user
<<GENERIC_DATABASE_NAME>> Database for generic events Your MariaDB installation

Quick Start Workflow

  1. Copy the appropriate sample file from <path-to-resource-folder>.
  2. Retrieve valid configuration values using configuration commands
  3. Replace all placeholder values (<<...>>) with actual values
  4. Customize the name, description, and feedAttributeMapping for your use case
  5. Execute the create-destination command with your JSON file

Example:


# Step 1: Copy sample file
cp <path-to-resource-folder>/create-destination-journey-kafka.json create-destination-journey-kafka.json

# Step 2: Get valid Kafka cluster names
./CliTool.sh get-all-kafka-cluster-names

# Step 3: Edit create-destination-journey-kafka.json and replace <<JOURNEY_CLUSTER_NAME>> with actual value and <<JOURNEY_TOPIC_NAME>> with appropriate value

# Step 4: Create the destination
./CliTool.sh create-destination -f create-destination-journey-kafka.json