The external documents connector relies on the use of a control file.
The following example uploads the official website of Fluid Topics with a short description and title. It also gives the external document some metadata attributes.
<?xml version="1.0" encoding="UTF-8"?>
<controlFile>
<resources>
<resource lang="en-US">
<title>Fluid Topics website</title>
<originId>fluid-topics-website</originId>
<originUrl>https://www.fluidtopics.com</originUrl>
<description>Consolidate your content and connect your customers with the right product knowledge, when and where they need it. Provide relevant, up-to-date, personalized and trusted answers!</description>
<metas>
<meta key="content_type">
<value>Website</value>
</meta>
<meta key="product">
<value>Fluid Topics</value>
</meta>
</metas>
</resource>
</resources>
</controlFile>
Elements | Required? | Description |
---|---|---|
title |
No | The title of the document in the search result. When not provided, the value of title is the value of originUrl . |
originUrl |
Yes | The URL of the document in the search result. |
originId |
No | When not provided, the value of originId is the value of originUrl , with :// and slashes replaced by dashes. If the URL ends with a slash, the slash is also not kept.For example, https://www.fluidtopics.com/product/content-delivery-platform/ becomes https-www.fluidtopics.com-product-content-delivery-platform . |
description |
No | The description of the document in the search result. Fluid Topics indexes the content of the description, which means that it is possible to search for a word in it. |
metas |
No | The metadata of the document. |
The previous example produces the following example:
It is possible to add multiple <resource>
elements to publish multiple external documents.