For platform administrators
The pages described here are available to the Platform admin role, under Admin (the fingerprint icon in the left menu).
Architecture at a glance#
| Component | Role |
|---|---|
| Web application | The user interface, the REST API and the callback endpoint that receives AI results. |
| Hangfire server | Runs the scheduled system tasks that move documents through the pipeline. |
| CL-AI service | Queue-based AI workers (split, map JSON, compare, search, Q&A) that call the configured model providers. |
| CL-OCR service | Text extraction with the Auto, Paddle and Kreuzberg engines. |
| OpenSearch | Full-text, semantic (vector) and per-document-type indexes. Models and the hybrid search pipeline are provisioned automatically at start-up. |
| SQL Server | Organizations, documents, settings, logs and credits. |
| Alias service | Creates each organization's capture email alias in Exchange Online. |
System tasks#
Platform management → System Tasks lists the background jobs. For each task you can edit it, assign a Schedule, trigger it with Run now, or deactivate it.
| Task | What it does |
|---|---|
| Split documents | Sends uploaded PDFs to AI to be split into business documents before versioning; also removes originals when KeepOriginalAfterSplit = N. |
| Detect document versions | For organizations with versioning on, matches new uploads to existing documents and increases their version numbers. |
| Convert documents to text | Sends documents to the OCR service. |
| Index documents | Adds OCR-completed documents to OpenSearch. |
| Map JSON | Maps extracted content onto the document type's schema and adds it to the type's index. |
| Auto compare documents | Compares new versions with their previous version and emails the result. |
| Delete auto compare results | Removes comparison result files older than AutoCompareFileLifeTime days. |
| Capture mail | Reads the capture mailbox and saves attachments for the organization owning the addressed alias. |
| Delete handled mail | Deletes already captured mail from the capture mailbox. |
| Send emails | Sends queued emails. |
| Calculate storage cost | Charges each active organization its daily storage cost. |
| External service heartbeat check | Pings CL-AI, CL-OCR and OpenSearch and emails NotificationEmail on failure. |
| Clean up deleted tenants | Permanently removes organizations deleted more than DeletedTenantLifeTime days ago, with their data, files and indexes. |
| Reset All Cache | Clears the Redis and in-memory caches. |
Schedules#
Platform management → Task schedules holds reusable schedules (daily, daily recurring, weekly, monthly or a
custom cron expression) that you attach to system tasks. Schedule times use the Hangfire server time zone
(ServerTimeZone).
Dashboards#
- Hangfire Dashboard: live, scheduled, succeeded and failed job runs, with retry and delete actions.
- RQ Dashboard: the AI service's queues, workers and failed jobs.
Logs#
| Log | Contains |
|---|---|
| Activity Logs | User and system activity, with an AI summary of technical entries. |
| Error Logs | Exceptions, including mail capture problems and service failures. |
| Email Logs | Every email the platform sent. |
| AI service logs | Requests to and responses from the AI service. |
| OCR service logs | Requests to and responses from the OCR service. |
| AI job failures | AI jobs that failed, with their error, so you can see what was retried or gave up. |
All of them are grouped under Platform logs; organization managers see their own Activity and Email logs under Logs.
System parameters#
System administration → System parameters holds platform-wide settings. The most important ones:
| Parameter | Default | Meaning |
|---|---|---|
OCRBatchSize, OSBatchSize, AISplitBatchSize, AutoCompareBatchSize | 10 | Documents handled per task run. |
AIJobMaxRetryCount | 3 | Attempts before a document is marked Permanently failed. |
OSSemanticKValue | 5 | Nearest neighbours considered by semantic search. |
OSSemanticPipelineName | cldoc-rrf-pipeline | Hybrid search pipeline, created automatically. |
OSMaxTokenCount | 50000 | Largest content an index accepts. |
FreeCreditAmount | 100 | Welcome credits for new organizations. |
CreditAmountPer1Usd | 10 | Credits per US dollar. |
LowCreditAmount / LowCreditWarningAmount | 10 / 5 | Auto charge threshold / warning threshold. |
BaseTimeUnit / BaseSizeUnit / BaseTokenUnit | 1000 / 1000000 / 100 | Billing units: milliseconds, bytes, tokens. |
InvitationLinkLifeTime | 24 | Hours an invitation link stays valid. |
DeletedTenantLifeTime | 30 | Days before a deleted organization is purged. |
AutoCompareFileLifeTime | 7 | Days comparison results are kept. |
DefaultFilePath | …\Tenant_[tenantid]\Documents | Storage folder template for uploaded files. |
ExecuteEmails | Y | Y sends emails, N only records them, T sends them to EmailTestGroup. |
NotificationEmail | — | Receives external service failure alerts. |
ShowSelectAIProvider | N | Shows a model picker in the AI assistant. |
ShowLanguageResourceKey | N | Shows translation keys next to UI texts (for translators). |
Status id parameters (
WaitingForOCRStatusId, IndexedStatusId, …) tie the pipeline steps together. Change them only together with the document status table.
Other administration pages#
| Page | Purpose |
|---|---|
| Content Types | Accepted file extensions and their OCR engine. |
| Transaction Types | Credit rates per operation and priority. |
| Public Announcements | Messages shown on the What's new page (link at the bottom of the left menu) between a start and end date. |
| Settings → Email Templates, SMTP Servers | Content and delivery of system emails. |
| Settings → Page Parts | Editable HTML snippets, such as the setting explanations on Initial Setup. |
| Settings → Document Statuses, Log Entry Types, Access Roles | Reference lists used across the platform. |
| Language Settings → Languages, Language resources | Available languages and every UI text, editable without a release. |
| Cached Entries | Inspect and clear cached data. |
| Countries, States, Cities, Auto Numbers | Reference data. |
| Reference management | Master document types and industries, and reference parameters copied to new organizations. |