The Confluence source allows DDF to pull pages/comments/attachments from a Confluence REST API and turns the results into Metacards the system can use.
...
Source Configuration Properties
| Name | Description |
|---|---|
| Confluence Rest URL | The Confluence Rest API endpoint URL. Example: https://<host>:<port>/rest/api/content |
| Username | Username to use with HTTP Basic Authentication. This auth info will overwrite any federated auth info. Only set this if the Confluence endpoint requires basic authentication. |
| Password | Password to use with HTTP Basic Authentication. This auth info will overwrite any federated auth info. Only set this if the Confluence endpoint requires basic authentication. |
| Include Page Contents In Results | Flag indicating if Confluence page contents should be included in the returned results.If page contents not included in results then the returned metacards will not have the `description` or `metadata` fields set |
| Include Archived Spaces | Flag indicating if archived confluence spaces should be included in search results |
| Confluence Space | The confluence space to perform searches in. If no space is specified all visible spaces will be searched.A confluence space must be set in order for wildcard only searches to work |
| Availability Poll Interval | Availability polling interval in milliseconds |
Confluence Query Restrictions
...
| Note | ||
|---|---|---|
| ||
Depending on your version of Confluence, when downloading attachments you might get redirected to a different download URL. If this happens the default |
Common Taxonomy Attributes (https://codice.atlassian.net/wiki/display/DDF/Attributes)
Constraints
| Attribute Name | Source | Query Restrictions |
|---|---|---|
created | history.createDate | >, <, = |
description | First 256 characters of the Confluence entry body | Not directly queryable. |
| id | Uses the Confluence id as the metacard id. | =, != |
metadata | Tika-like formatted xml containing the entire text body of the Confluence entry | Queryable via `anyText` ~, !~ |
modified | history.lastModified.when | >, <, = |
resource-download-url | _links.download | Not directly queryable. |
resource-size | extensions.fileSize | Not directly queryable. |
resource-uri | _links.download | Not directly queryable. |
title | title | =, !=, ~, !~ |
| associations.external | _links.webui, _links.base, space._links.webui | Not directly queryable. |
contact.contributor-name | history.contributors.publishers.users.username | =, != |
contact.creator-name | history.createdBy.username | =, != |
| media.type | metadata.mediaType | Not directly queryable. |
metacard.created | history.createDate | >, <, = |
metacard.modified | history.lastModified.when | >, <, = |
| security.access-groups | restrictions.read.restrictions.group.name | Not directly queryable. |
| security.access-individuals | restrictions.read.restrictions.user.username | Not directly queryable. |
| topic.keyword | metadata.labels.results.name | =, != |
Custom Confluence Metacard Attributes
confluence.type
| topic.category | type | =, != |
| topic.vocabulary | https://developer.atlassian.com/confdev/confluence-server-rest-api/advanced-searching-using-cql/cql-field-reference#CQLFieldReference-titleTitleType |
confluence.restriction-groups
...
Constraints
...
confluence.restriction-users
Constraints
confluence.link
...
Constraints
...
| Not directly queryable |
confluence.base-url
Constraints
| . |
confluence.space
...
Constraints
...
Some Examples from the DDF Search UI
(Page result left, attachment result right)
Example Metadata
...