Skip to main content
Back to Search AI connectors list dotCMS is a content management system designed for managing documentation. The dotCMS Connector integrates Search AI with your dotCMS instance to ingest content and use it to answer user queries.
SpecificationDetails
Repository typeCloud / On-Premise
Supported API versionv1
Supported contentFiles

​
Prerequisites

Search AI uses Basic Auth to connect to dotCMS. You need dotCMS user credentials with permissions to access the required resources.

​
Configure the dotCMS Connector

​
Authorization

Go to Content > Connectors and select DotCMS. Connector Home On the Authorization page, enter the following fields:
FieldDescription
NameUnique name for the connector
Host URLURL of the dotCMS application
UsernamedotCMS credentials
PassworddotCMS credentials
Connector Authorization Click Connect to initiate authorization. Once complete, you can select content to ingest and initiate synchronization.

​
Content Ingestion

Go to the Configuration tab and select the content to ingest. You can sync all content from the dotCMS account or select specific content.

​
Content Filters

To selectively ingest content, select Sync Specific Content and click Configure. Define rules using a parameter, operator, and value. Content Filters Supported filter parameters (based on dotCMS System Properties):
ParameterDescription
Base TypeBase content type in dotCMS. Refer to dotCMS base content types for supported values.
Content TypeVariable name for the Content Type defined for your content
LockedWhether the content is locked. Use true or false.
LiveWhether the content is published. Use true or false.
Language IDLanguage ID defined by dotCMS for language-specific ingestion
You can also add any other System Properties defined for your dotCMS content. The Operator field accepts values such as equals, not equal, and contains, depending on the selected parameter. Example: Ingest all content with Base Type set to “Page”: Content Filters Example: Ingest only live pages in a specific language: Content Filters
Note:
  • Use the OR operator to combine multiple rules for different content types.
  • Use the AND operator within a rule to apply multiple conditions.
  • You can use other System Properties defined by dotCMS to add rules. The parameters listed above are commonly used defaults.
  • Ensure property names and values exactly match the expected values in dotCMS. Refer to dotCMS System Properties documentation for details.

​
Content Sync Schedule

Manual sync — Click Sync Now to immediately ingest all updates from the dotCMS account. Content Sync Scheduled sync — Enable Schedule Sync and set the date, time, and frequency to keep content automatically up to date. Content Sync