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.
API (HTTP REST) Connector for Destinations
Send detected events to an external system over HTTP by configuring an API (HTTP REST) connector on a destination.
API Connector Configuration Properties

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
  Manage profile definitions and attributes through the HCL Detect UI or CLI.
- Feed Application
  Create and manage feed applications through the HCL Detect UI or CLI.
- About derived attribute functions
  Derived attribute functions enable you to offload complex calculations involving multiple tuple attributes to custom Python scripts.
- 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.
  - What is a Destination?
  - Available Commands
  - API (HTTP REST) Connector for Destinations
    Send detected events to an external system over HTTP by configuring an API (HTTP REST) connector on a destination.
  - Best Practices
    Recommendations for naming and validating destinations.
  - Complete Example: End-to-End Destination Setup
  - Sample JSON Payloads Reference
  - FAQ
  - Appendix: Field Reference
- Crypto Management
  Use CLI crypto utilities to encrypt and decrypt sensitive values used in Detect configuration workflows.
- Troubleshooting & Common Errors
- 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.

API Connector Configuration Properties

Platform API configuration properties

These properties are set once per API configuration in Unica Platform, under Affinium > UnicaDetect.


Property (display name)	Internal name	Required	Description
Target Endpoint	`api.target.endpoint`	Yes	URL that receives events by HTTP POST.
Authorization Type	`api.auth.type`	Yes	Authorization scheme: `NoAuth` (default), `Basic Auth`, or `Bearer Token`.
Authorization Endpoint	`api.auth.endpoint`	For Bearer Token	Token endpoint Detect calls to obtain an access token.
Auth credentials datasource Username	`api.auth.datasource.username`	For Basic Auth and Bearer Token	Username who created the Platform User Datasource.
Auth credentials datasource Name	`api.auth.datasource.name`	For Basic Auth and Bearer Token	Platform User Datasource name, for the above user, that stores the client credentials. In datasource, the password or client secret is Encrypted by Platform before storage.
Connection Timeout in Millis	`api.connection.timeout`	Yes	Maximum time, in milliseconds, to open the connection, including DNS resolution. Default: `5000` (5 seconds).
Read Timeout in Millis	`api.socket.timeout`	Yes	Maximum period of inactivity, in milliseconds, allowed between two consecutive data packets once the connection is open, including the token exchange for bearer authentication. The timer resets each time data arrives, so it limits idle time between packets, not the total response duration. Default: `10000` (10 seconds). Note: This setting does not indicate the total response duration. For more information, see "Read Timeouts" under "API Connector Delivery, Retry, and Failure Handling."

Note:

Administrators can also import these properties from an XML file using configTool, the same way Kafka cluster and data source configurations are imported. See the configTool usage described for Kafka clusters in the troubleshooting topics of this guide for the equivalent command syntax.

Destination-level connector properties

These properties are set per destination, in the api entry of connectorConfig in the destination's JSON payload.


Field	Required	Description
`connectorType`	Yes	Connector type identifier for the API connector.
`apiConfigName`	Yes	Name of the API configuration created in Platform.
`headers`	No	Optional custom HTTP headers sent with every request, as key-value pairs.