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-all-message-templates

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-all-message-templates`

Description

Retrieves all available message templates configured in Detect. Message templates define the message format for different destination types (Journey, Interact, CDP, Generic). Use this command to identify which templateId to use when creating destinations.

Syntax

Windows:

CliTool.bat get-all-message-templates

Linux :

./CliTool.sh get-all-message-templates

Parameters

This command does not require any parameters.

Example Execution

./CliTool.sh get-all-message-templates

Sample Output

Success:

Found 4 message templates:
Template ID: 1, Name: Journey, Type: JOURNEY
Template ID: 2, Name: Interact, Type: INTERACT
Template ID: 3, Name: CDP, Type: CDP
Template ID: 4, Name: Generic, Type: GENERIC

No Templates:


Found 0 message templates:

Understanding Template IDs


Template ID	Name	Type	Use Case
1	Journey	JOURNEY	Publishing customer journey events to HCL Journey
2	Interact	INTERACT	Sending real-time offer requests to HCL Interact
3	CDP	CDP	Synchronizing events to Customer Data Platforms
4	Generic	Generic	User-defined generic message formats

Use Cases

Before Creating Destination

# Check available templates
   ./CliTool.sh get-all-message-templates
   
   # Use appropriate templateId in destination JSON
   # Example: templateId: 1 for Journey destination

Documentation and Planning


   # List templates for deployment documentation
   ./CliTool.sh get-all-message-templates > message-templates-inventory.txt

Exit Codes

0 " Success (templates retrieved, may be empty)
1 " Error (connection failure)