Welcome
Extending Platform
This section guides developers on customizing and extending Detect solutions. It covers the solution's folder structure, configuration files, integration methods, and provides insights into the Detect Expression Language and its built-in functions.
Folder Structure
This section provides an overview of the basic solution folder structure. It describes the contents of each folder and their purpose.

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.
Working with Platform
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.
Extending Platform
This section guides developers on customizing and extending Detect solutions. It covers the solution's folder structure, configuration files, integration methods, and provides insights into the Detect Expression Language and its built-in functions.
- Folder Structure
  This section provides an overview of the basic solution folder structure. It describes the contents of each folder and their purpose.
- drive.json File
  This page explains the structure and purpose of the drive.json file used in HCL Detect. It outlines required configurations including database settings, user profiles, communication parameters, system health metrics, and other operational settings. Proper setup of this file is essential before launching the application.
- Configurations
- Integrations
- Solution Source Code
  This page outlines the structure and components of a solution source in HCL Detect. It details how solutions are packaged, including profiles, feed models, applications, and configurations, enabling deployment and reuse across different environments.
- Detect Expression Language
- Detect Expression Language Built-in Functions
Platform 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.
PDF

Folder Structure

This section provides an overview of the basic solution folder structure. It describes the contents of each folder and their purpose.

A basic solution folder structure mainly consist of the following folders mentioned below. The structure is as follows:

                    .
├── acme
│   ├── etc
│   ├── jupyter
│   ├── lib
│   ├── python
│   └── web
├── drive
│   ├── bin
│   ├── doc
│   ├── etc
│   ├── include
│   ├── lib
│   └── python
├── external
│   ├── apache-tomcat-9.0.86
│   ├── boost-1.84.0-python-3.11.9
│   ├── gcc-8.2.0
│   ├── kafka_2.12-3.7.0
│   ├── pyenv-3.11.9
│   ├── redis-5.0.5
│   └── server-jre-1.8.0_202
├── HCLDetectv12.1.10-LICENSE.txt
└── HCLDetectv12.1.10-NOTICE.txt
                

Let's go through each folder and understand the contents within it.

acme folder

The acme folder is solution folder, which mainly contains the information specific to the customer code. The acme folder contains the following folders and file.

etc folder: contains configuration files related to the solution.
lib folder: stores files that are related to the build of the feed application.
python folder: contains source code files of the application results.
web: contains version information file.

drive folder

This folder contains the compiled code, executables and configuration files for the product.

etc folder: Contains the following files.
- drive.json- stores essential configurations including database details, time zone, location, metrics, admin credentials, and more. For more information on drive.json, refer drive.json File.
- runtime_environment.json - stores the specific performance and reliability requirements of a customer deployment. For more information on runtime environment, refer Configuring HCL Detect's Runtime Environment.

external folder

This folder stores runtime artifacts that the application use. It contains libraries and artifacts used by the product itself. These components may differ between versions.

To add feedback about this topic, select the following checkbox:

By clicking this box, you acknowledge that you are NOT a U.S. Federal Government employee or agency, nor are you submitting information with respect to or on behalf of one. HCL provides software and services to U.S. Federal Government customers through its partners Four, Inc. Contact this team at https://hcltechsw.com/resources/us-government-contact. Do not include any personal data in this Comment box. Note: To report a problem or question about the product software, do not use this form. Instead, go to the HCL Software Support site. Personal data should not be shared in this comment box. See our Privacy Statement to understand how personal data is used.