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.
Crypto Management
Use CLI crypto utilities to encrypt and decrypt sensitive values used in Detect configuration workflows.
Command Details
encrypt

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.

`encrypt`

Description

The encrypt command takes a plaintext string and produces an encrypted value using the Detect encryption key. The resulting encrypted string can be stored in configuration files or databases instead of the original plaintext.

Syntax

encrypt -p "<plaintext_to_encrypt>" [-key-file-path "<path_to_key_properties_file>"]

Examples

Encrypt using the default key:

CliTool.bat encrypt -p "MySecretPassword"

Linux :

./CliTool.sh encrypt -p "MySecretPassword"

Note: Currently, the encrypt syntax does not support properties files.

Parameters


Parameter	Required	Description
`-p <plaintext_to_encrypt>`	Yes	The plaintext string value to encrypt. Enclose in quotes if the value contains spaces or special characters.
`-key-file-path <path_to_file>`	No	Path to a `.properties` file containing the active encryption key. If omitted, the default built-in key is used and a warning is printed.

Sample Output

Encrypted value: aGVsbG8gd29ybGQ=...

Note:

The -p flag must immediately precede the plaintext value.
If -key-file-path is not provided, the command will print:
[WARN] No key file path provided, using default key.
Store the resulting encrypted value " it is required as input to the decrypt command.