Welcome
Administration
Learn about how to configure, manage, and maintain HCL Detect environments. It includes details on system setup, user management, and permissions, ensuring seamless operation and efficient deployment of your continuous delivery processes.
Destination Management
Use CLI commands to configure, validate, and manage destination endpoints for Detect event delivery.
Available Commands
get-destination-by-id

Getting Started
Welcome to the documentation for HCL Detect, where you can find information about how to install, maintain, and use this service.
Installation
Learn more about HCL Detect installation and deploying core components of the product.
Administration
Learn about how to configure, manage, and maintain HCL Detect environments. It includes details on system setup, user management, and permissions, ensuring seamless operation and efficient deployment of your continuous delivery processes.
- Introduction
  Use this guide to administer HCL Detect, including user and role access, CLI-based configuration and management tasks, DEL reference topics, and support resources.
- User & Role Management
  This page explains how to manage roles and permission in HCL Detect.
- Configuration Management
  Use CLI commands to query and validate the infrastructure settings required for Detect operations.
- Metadata Management
  Use CLI commands to discover data sources, search tables, and retrieve column metadata for Detect integrations.
- Profile Management
  Use CLI commands to create, update, query, and delete profile definitions used by Detect.
- Feed Application
  Use CLI commands to create and manage feed applications, including filtering and troubleshooting scenarios.
- Feed Parser Mapping
  Use CLI commands to define and maintain feed parser mappings between incoming feed fields and Detect target attributes.
- Destination Management
  Use CLI commands to configure, validate, and manage destination endpoints for Detect event delivery.
- Crypto Management
  Use CLI crypto utilities to encrypt and decrypt sensitive values used in Detect configuration workflows.
- Troubleshooting & Common Errors
- Support & Contact Information
- Detect Expression Language
- Detect Expression Language Built-in Functions
Working with the System
The section provides comprehensive instructions for creating, configuring, and managing marketing events. It covers topics such as defining audience conditions, setting up triggers, deploying events, and tracking their performance. Additionally, this section includes explanations of key terminology and offers advanced options to optimize event management.
System Data Model
This section provides detailed information about the internal tables used within the Detect module. It includes descriptions of each table's structure, purpose, and relationships, aiding administrators and developers in understanding and managing the underlying database schema effectively.

`get-destination-by-id`

Description

Retrieves detailed information about a specific destination by its unique ID. Returns the complete destination configuration including message template, connector settings, and attribute mappings.

Syntax

Windows:

CliTool.bat get-destination-by-id -id <destination-id>

Linux :

./CliTool.sh get-destination-by-id -id <destination-id>

Parameters


Parameter	Required	Type	Description
`-id`	Yes	integer	Unique ID of the destination to retrieve. Must be a positive integer.

Example Execution

Windows:

CliTool.bat get-destination-by-id -id 42

Linux :

./CliTool.sh get-destination-by-id -id 42

Sample Output

Success:

Destination details:DestinationDto(id=42, name=Customer Journey Events, description=Publishes journey events to Kafka, templateId=1, messageConfig={payloadEntrySourceCode=ES-001}, feedAttributeMapping=[...], connectorConfig=DestinationConfigDto(kafka=KafkaConnectionDetails(topic=journey-events, clusterName=primary-kafka-cluster), mariaDb=null))
Destination name: Customer Journey Events, Destination template : 1

Error:

Error retrieving destination: Destination with ID 999 not found

Use Cases

Verify Destination Configuration

# Check destination exists before using in trigger
   ./CliTool.sh get-destination-by-id -id 42

Export Destination for Documentation

# Export destination details to file
   ./CliTool.sh get-destination-by-id -id 42 > destination-42-details.txt

Pre-Update Verification

# Review current config before updating
   ./CliTool.sh get-destination-by-id -id 42
   ./CliTool.sh update-destination -id 42 -f updated-config.json

Exit Codes

0 " Success (destination found and retrieved)
1 " Error (destination not found, invalid ID format, connection error)