In This Guide

The CloudConvert plugin extracts text from files uploaded into Brightspot, and editors can search for those files using free text. For example, if you upload a Word file, the plugin extracts and indexes the text, making the file searchable.

The CloudConvert plugin works in conjunction with Digital Asset Management, which provides document, spreadsheet, and presentation content types. These content types support file uploads.

The plugin uses the CloudConvert API to convert document, spreadsheet, and presentation formats to text. The following table lists the formats you can convert.

File formats available with CloudConvert

html, doc, docx, odt, pdf, rtf
ppt, pptx
xls, xlsx, csv

Text extraction and thumbnail generation run as a background task.

Configuring CloudConvert

To configure CloudConvert:

  1. Obtain your Cloud Convert account’s API key.
  2. Click menu > Admin > Sites & Settings > Sites > Global. The Edit Global widget appears.
  3. Under Main > CloudConvert, set API Key with the value you obtained in step 1.
  4. Click Save.

Uploading a file to a Document, Presentation, or Spreadsheet content type triggers indexing of that file’s content.

Viewing CloudConvert tasks

Brightspot manages the extraction and indexing of a file’s text as a background task.

To view the status of a CloudConvert task:

  1. Navigate to Dari Standard Tools at http://<brightspot-host>/_debug/.
  2. Click Background Tasks.
  3. Scroll down to DocumentExtractionTask Executor.
Document extraction task

Uploading a file

You can upload a file, such as a presentation or spreadsheet, and other editors can search for the file using the file’s text. For example, if you upload a single file containing all of the adventures of Sherlock Holmes, other editors can find the file by searching on watson, baker streett, or mrs. hudson.

For a listing of supported file types, see the table File formats available with CloudConvert.

To upload a file:

  1. In the header, click add.
  2. Create a new DocumentPresentation or Spreadsheet.
  3. In the content edit form, set the applicable fields.
  4. From the File field, select New Upload, and click Choose.
  5. Navigate to and select the file.
  6. Click Publish, or click save to save a draft.

Brightspot extracts the file’s text. When the extraction is complete, Brightspot displays the text and a thumbnail under the content edit form’s METADATA tab. You can modify the thumbnail by clicking Edit. For information about editing images in Brightspot, see Image preparation.

Text extracted from a document
Text extracted from a document

Generated thumbnail
Generated thumbnail

When editors search for any of the terms in the extracted text, Brightspot lists the document in the search panel.