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.
Feed Application
Use CLI commands to create and manage feed applications, including filtering and troubleshooting scenarios.
Command examples

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.

Command examples

The examples below assume you are running from tools/detect-cli so the relative JSON paths work as written.

Create feed application

Command:

java -jar detect-cli.jar create-feed-application -f "<path-to-resource-folder>/create_feed_application_kafka.json"

Sample payload from create_feed_application_kafka.json:

{
  "name": "feedAP1",
  "batchSize": 10,
  "connectorProperties": {
    "connectorType": "KAFKA",
    "topic": "TEST_1",
    "groupId": "detect",
    "clusterName": "k8s-cluster"
  },
  "enabled": true
}

Expected console pattern:

Feed application created successfully with ID: <generatedId>

Update feed application

Command:

java -jar detect-cli.jar update-feed-application -id 101 -f "<path-to-resource-folder>/update_feed_application_kafka.json"

Sample payload from update_feed_application_kafka.json:

{
  "name": "feedAP1",
  "batchSize": 10,
  "connectorProperties": {
    "connectorType": "KAFKA",
    "topic": "TEST_1",
    "groupId": "detect",
    "clusterName": "k8s-cluster"
  },
  "enabled": true
}

Expected console pattern:

Feed application updated successfully with ID: 101

Get feed application by id

Command:

java -jar detect-cli.jar get-feed-application -id 101

Expected console pattern:

Feed Application: <FeedApplicationDto>

Get all feed applications

Basic example:

java -jar detect-cli.jar get-all-feed-applications -page 0 -size 10

Filter by search text:

java -jar detect-cli.jar get-all-feed-applications -search "feedAP" -page 0 -size 10

Filter by Kafka connector type and enabled status:

java -jar detect-cli.jar get-all-feed-applications -byInputConnectorType KAFKA -isEnabled true -page 0 -size 10

Expected console pattern:

Feed Applications: <PageResponse<FeedApplicationDto>>

Delete feed application

Command:

java -jar detect-cli.jar delete-feed-application -id 101

Expected console pattern:

Delete result: <ResponseBooleanWithMessageDto>

Get feed application names

Command:

java -jar detect-cli.jar get-feed-application-names

Expected console pattern:

Feed Application Names: <ListOfNamesDto>