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.
Create API Configuration in Platform

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.

Create API Configuration in Platform

Before you begin

You have administrator access to Unica Platform configuration.
You have the target endpoint URL, the authorization type, and any credentials the endpoint requires.

About this task

Define the connection details for an external REST endpoint once, as an API configuration in Unica Platform. Destinations refer to this configuration by name, instead of embedding connection details and credentials directly in the destination.

Procedure

Log in to Unica Platform as an administrator and navigate to Settings > Configuration.
Expand UnicaDetect > API Connectors.
Select New API Connector to create a configuration from the template.
Enter a name, and in Target Endpoint, enter the URL that receives events by HTTP POST, for example http://api.example.com/events.
From the Authorization Type drop-down menu, select the authorization scheme the endpoint requires.
1. Select NoAuth if the endpoint does not require an Authorization header. This is the default.
2. Select Basic Auth to send credentials as HTTP basic authentication.
3. Select Bearer Token to have Detect fetch and cache an access token.
Important:
When basic authentication or bearer token is selected, the corresponding user id and password has to be maintained in user's data source.
Set Connection Timeout in Millis and Read Timeout in Millis.

These control how long Detect waits to open a connection and to receive a response before treating the attempt as failed and eligible for retry. If you leave these blank, Detect uses default values; see API Connector Configuration Properties.
Save the configuration.

Results

The API configuration is available in Platform. You can now reference it by name from one or more destinations; see Configure Destination with API Connector.