Skip to content

Commit 2696f65

Browse files
alegaussalegauss
committed
Add Dumont connector docs and update sidebars
Add new Dumont connector documentation (AEM, Asset, Database, Wordpress) and wire them into the Dumont sidebar as a Connectors category. Remove legacy docs: docs-dumont/developer-guide.md and docs-turing/connectors.md. Adjust docs-dumont/architecture.md (runtime updated to Java 21, Spring Boot 4 and minor diagram formatting). Also remove the connectors entry from the Turing sidebar to reflect the moved/updated content.
1 parent bc3c8a0 commit 2696f65

File tree

10 files changed

+274
-250
lines changed

10 files changed

+274
-250
lines changed

‎docs-dumont/architecture.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@ Dumont DEP provides a platform for data exchange across different systems and fo
2121

2222
```
2323
┌─────────────────────────────────────────────┐
24-
│ Dumont DEP │
24+
│ Dumont DEP │
2525
│ │
26-
│ ┌───────────┐ ┌──────────┐ ┌──────────┐ │
26+
│ ┌───────────┐ ┌──────────┐ ┌───────────┐ │
2727
│ │ Connectors│→ │ Pipeline │→ │ Output │ │
2828
│ │ (Input) │ │ Engine │ │ Connectors│ │
29-
│ └───────────┘ └──────────┘ └──────────┘ │
29+
│ └───────────┘ └──────────┘ └───────────┘ │
3030
│ │
3131
│ ┌──────────────────────────────────────┐ │
3232
│ │ REST API Gateway │ │
@@ -38,8 +38,7 @@ Dumont DEP provides a platform for data exchange across different systems and fo
3838

3939
| Component | Technology |
4040
|-----------|-----------|
41-
| Runtime | Java 21, Spring Boot 3 |
41+
| Runtime | Java 21, Spring Boot 4 |
4242
| Build | Maven |
4343
| Database | H2 (embedded), PostgreSQL (production) |
44-
| API | REST, OpenAPI 3.0 |
45-
| Messaging | Apache Kafka (optional) |
44+
| API | REST, OpenAPI 3.0 |

‎docs-dumont/connectors/aem.md‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
sidebar_position: 3
3+
title: AEM
4+
description: AEM (Adobe Experience Manager) Connector
5+
---
6+
7+
# AEM (Adobe Experience Manager)
8+
9+
Connector that indexes content from Adobe Experience Manager (AEM) into Viglet Dumont DEP, with support for custom extensions for content processing and incremental (delta) indexing.
10+
11+
## Prerequisites
12+
13+
- Java 21+
14+
- Maven 3.6+
15+
- Apache Ant
16+
- Adobe Experience Manager 6.5+
17+
- Viglet Dumont server running
18+
19+
## Installation
20+
21+
Go to [https://viglet.org/dumont/download/](https://viglet.org/dumont/download/) and click on "Integration > AEM Connector" link to download the connector.
22+
23+
To create a custom AEM plugin project, use the Maven archetype:
24+
25+
```shell
26+
mvn -B org.apache.maven.plugins:maven-archetype-plugin:3.2.1:generate \
27+
-D archetypeGroupId=com.adobe.aem \
28+
-D archetypeArtifactId=aem-project-archetype \
29+
-D archetypeVersion=44 \
30+
-D appTitle="Dumont AEM Service" \
31+
-D appId=aem-dumont-events \
32+
-D groupId=com.viglet.dumont \
33+
-D aemVersion=6.5.0
34+
```
35+
36+
## Quick Start
37+
38+
**Automated build:**
39+
40+
```shell
41+
compile-and-run.cmd
42+
```
43+
44+
This will clean, compile, package the plugin, and launch the connector.
45+
46+
**Manual build:**
47+
48+
```shell
49+
./mvnw clean install package
50+
ant wknd
51+
cd dist/wknd
52+
run.cmd
53+
```
54+
55+
## Configuration
56+
57+
Set environment variables for the Dumont server connection (e.g., in `scripts/wknd/env.cmd`):
58+
59+
```shell
60+
TURING_URL=http://localhost:2700
61+
TURING_API_KEY=your_api_key_here
62+
```
63+
64+
The AEM source configuration is defined in a JSON file (e.g., `wknd.json`) with the following settings:
65+
66+
| Setting | Description |
67+
|---------|-------------|
68+
| AEM Endpoint | AEM server URL (e.g., `http://localhost:4502`) |
69+
| Root Path | Content root path (e.g., `/content/wknd`) |
70+
| Content Type | AEM content type (e.g., `cq:Page`) |
71+
| Credentials | AEM author/publish authentication |
72+
| Site Mappings | Author and publish site mappings |
73+
| Locale | Locale settings for indexing |
74+
75+
## Custom Extensions
76+
77+
You can create custom extensions by implementing the following interfaces:
78+
79+
- **`DumAemExtContentInterface`** — Custom content processing logic.
80+
- **`DumAemExtDeltaDateInterface`** — Delta date processing for incremental indexing.
81+
82+
Register your custom classes in the configuration JSON file.
83+
84+
### Sample Extensions
85+
86+
The [AEM Plugin Sample](https://github.com/openviglet/dumont/tree/master/aem/aem-plugin-sample) provides working examples:
87+
88+
- **`DumAemExtSampleDeltaDate`** — Handles delta date processing for incremental indexing.
89+
- **`DumAemExtSampleModelJson`** — Processes AEM content fragments and model JSON data.
90+
91+
## Module Structure
92+
93+
The AEM connector is composed of three modules:
94+
95+
| Module | Description |
96+
|--------|-------------|
97+
| `aem-plugin` | Core AEM plugin with extension interfaces |
98+
| `aem-server` | Server component for running the connector |
99+
| `aem-plugin-sample` | Sample plugin with WKND site integration |

‎docs-dumont/connectors/asset.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
sidebar_position: 3
3+
title: Asset
4+
description: Asset Connector
5+
---
6+
7+
# Asset
8+
9+
Asset connector for indexing files with text extraction from Word, Excel, PDF and OCR for images.
10+
11+
## Installation
12+
13+
Go to [https://viglet.org/dumont/download/](https://viglet.org/dumont/download/) and click on "Integration > FileSystem Connector" link to download the `dumont-filesystem.jar`.
14+
15+
## Usage
16+
17+
```shell
18+
java -jar /appl/viglet/dumont/fs/dumont-filesystem.jar <PARAMETERS>
19+
```
20+
21+
## Example
22+
23+
```shell
24+
java -jar /appl/viglet/dumont/fs/dumont-filesystem.jar \
25+
--server http://localhost:2700 \
26+
--nlp <NLP_UUID> \
27+
--source-dir /path/to/files \
28+
--output-dir /path/to/output
29+
```
30+

‎docs-dumont/connectors/database.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
sidebar_position: 1
3+
title: Database
4+
description: Database Connector
5+
---
6+
7+
# Database
8+
9+
JDBC Connector that uses the same concept as [sqoop](https://sqoop.apache.org/), to create complex queries and map attributes to index based on the result.
10+
11+
## Installation
12+
13+
Go to [https://viglet.org/dumont/download/](https://viglet.org/dumont/download/) and click on "Integration > Database Connector" link to download the `dumont-jdbc.jar`.
14+
15+
## Usage
16+
17+
```shell
18+
java -jar /appl/viglet/dumont/jdbc/dumont-jdbc.jar <PARAMETERS>
19+
```
20+
21+
## Parameters
22+
23+
| Parameter | Description |
24+
|-----------|-------------|
25+
| `--connect` | JDBC connection string |
26+
| `--driver` | JDBC driver class name |
27+
| `--query` | SQL query to execute |
28+
| `--site` | Semantic Navigation Site name |
29+
| `--locale` | Locale for indexing |
30+
| `--chunk` | Number of rows per chunk |
31+
| `--server` | Dumont DEP server URL |
32+
| `--api-key` | API Key for authentication |
33+
| `--file-path-field` | Field containing file paths |
34+
| `--file-content-field` | Field for file content |
35+
| `--file-extension-field` | Field containing file extensions |
36+
| `--file-size-field` | Field containing file sizes |
37+
| `--multi-valued-separator` | Separator for multi-valued fields |
38+
| `--remove-html-tags-field` | Fields from which to remove HTML tags |
39+
40+
## Example
41+
42+
```shell
43+
java -jar /appl/viglet/dumont/jdbc/dumont-jdbc.jar \
44+
--connect "jdbc:mysql://localhost:3306/mydb" \
45+
--driver "org.mariadb.jdbc.Driver" \
46+
--query "SELECT id, title, content, url FROM articles" \
47+
--site "Sample" \
48+
--locale "en_US" \
49+
--chunk 100 \
50+
--server "http://localhost:2700" \
51+
--api-key "your-api-key"
52+
```

‎docs-dumont/connectors/wordpress.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
sidebar_position: 3
3+
title: Wordpress
4+
description: Wordpress Connector
5+
---
6+
7+
# Wordpress
8+
9+
Wordpress plugin that allows you to index posts.
10+
11+
## Installation
12+
13+
1. Upload the plugin folder to the `/wp-content/plugins/` directory.
14+
2. Activate the plugin through the 'Plugins' menu in WordPress.
15+
3. Configure the hostname, port and URI of Dumont DEP.
16+
4. Click the settings button to load posts.

‎docs-dumont/developer-guide.md‎

Lines changed: 0 additions & 100 deletions
This file was deleted.

0 commit comments

Comments
 (0)