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.
Configuration Management
Use CLI commands to query and validate the infrastructure settings required for Detect operations.
Execution & Syntax

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.

Execution & Syntax

Script Locations

The CLI ships with OS-specific wrapper scripts. On a production (customer) installation, these scripts are copied to the tools/bin directory under HCL_UNICA_DETECT_HOME. In the source repository they are located under:


OS	Production location
Windows	`%HCL_UNICA_DETECT_HOME%\tools\bin\CliTool.bat`
Windows	`%HCL_UNICA_DETECT_HOME%\tools\bin\setenv.bat`
Linux	`$HCL_UNICA_DETECT_HOME/tools/bin/CliTool.sh`
Linux	`$HCL_UNICA_DETECT_HOME/tools/bin/setenv.sh`

Note: setenv.bat / setenv.sh are sourced automatically by CliTool.bat / CliTool.sh. Before running the CLI, open the appropriate setenv script and verify that JAVA_HOME and HCL_UNICA_DETECT_HOME point to the correct installation directories for your environment.

Running the CLI

Windows (production):

cd %HCL_UNICA_DETECT_HOME%\tools\bin
CliTool.bat <command> [options]

Linux (production):

cd $HCL_UNICA_DETECT_HOME/tools/bin
./CliTool.sh <command> [options]

Note: Linux only: Ensure the script is executable before first use:

chmod +x $HCL_UNICA_DETECT_HOME/tools/bin/CliTool.sh
chmod +x $HCL_UNICA_DETECT_HOME/tools/bin/setenv.sh

Running Directly with Java (Advanced)

If you prefer to invoke the CLI without the wrapper scripts:

Windows:

java -cp "%HCL_UNICA_DETECT_HOME%\tools\lib\*" com.hcl.unica.detect.cli.CLIMain <command> [options]

Linux :

java -cp "$HCL_UNICA_DETECT_HOME/tools/lib/*" com.hcl.unica.detect.cli.CLIMain <command> [options]

Tip: On Windows use ; as the classpath separator. On Linux use :.

Getting Help

Windows:

CliTool.bat --help
CliTool.bat get-all-datasource-names-for-logged-in-user --help

Linux :

./CliTool.sh --help
./CliTool.sh get-all-kafka-cluster-names --help