Configuration

Administrators configure document data extraction and download format conversion in the Global site. The services available depend on which DAM modules the project includes. For a list of modules, see the technical reference.

Configure document data extraction

Extraction services read the text from uploaded documents and generate thumbnails. Brightspot runs the first service in the list that supports the file type of the upload.

To configure document data extraction:

1. From the left navigation, under Admin, click Sites & Settings, then select the Global site.

2. Click the CMS tab.

3. Expand the DAM Document Data Extraction Settings cluster.

4. In the Extractor Services list, add one or more services, and complete the fields for each service.

   Using the following table as a reference, complete the fields as needed.

   Service	Supported files	Fields
   Pdf Document Data Extractor (PDFBox)	PDF	Disable Text Extraction? and Disable Thumbnail Extraction? checkboxes.
   CloudConvert	Not restricted by file type	Api Key, Webhook Signing Secret, Thumbnail Height, Thumbnail Width (both default to 100), and the two disable checkboxes (Disable Text Extraction? and Disable Thumbnail Extraction?).
   Textract Document Data Extractor	PDF, JPEG, and PNG	Thumbnail Extractor (optional), a service that generates the thumbnail. Textract does not generate thumbnails for PDF files itself, so select a PDF extractor to get one. For image files, Brightspot uses the image as the thumbnail.

5. Click Save.

note

The Textract Document Data Extractor runs only when you enable the Amazon Textract integration and supply its AWS settings. Textract runs asynchronously, so the text appears after Amazon Textract finishes processing the file.

To enable the Amazon Textract integration:

1. From the left navigation, under Admin, click Sites & Settings, then select the Global site.
2. Click the Integrations tab, and expand the AWS Textract cluster.
3. Toggle on the Enable Textract Service setting.
4. In the SQS Queue Name, Topic ARN, and Role ARN fields, type the values from your AWS console.
5. In the Minimum Block Confidence field, type a value from 0.0 to 100.0. Brightspot excludes text in blocks that fall below this confidence level.
6. Click Save.

For the AWS setup, including the role permissions that Textract requires, see Amazon Textract configuration.

The CloudConvert Api Key setting in the CloudConvert cluster is deprecated. Use the Api Key field in DAM Document Data Extraction Settings instead.

Configure Pandoc downloads

Pandoc converts documents to formats such as Word, EPUB, and Markdown during a download. Install Pandoc on the application server before you enable these options.

To configure Pandoc:

1. From the left navigation, under Admin, click Sites & Settings, then select the Global site.

2. Click the Pandoc tab.

3. Using the following table as a reference, complete the fields as needed.

   Field	Description
   Pandoc Executable	Path to the pandoc executable. Defaults to pandoc on the application server path.
   Pandoc Process Path	Additional directories to add to the path of the Pandoc process. For PDF output, the path must include pdflatex or wkhtmltopdf, depending on the converter.
   Disable Pandoc Download Options?	Select to hide Pandoc formats from the Download Options window.
   Pdf Converter	Converter that Pandoc uses for PDF output. Defaults to WKHTMLTOPDF.
   Markdown Flavor	Markdown variant to use for Markdown output. Defaults to EXTENDED.
   Epub Version	EPUB version to use for EPUB output. Defaults to V3.
   Default Pandoc Document Format	Format that is selected by default in the Download Options window.

4. Click Save.

Configure ImageMagick downloads

ImageMagick converts images to formats such as JPG, PNG, TIFF, and GIF during a download. Install ImageMagick on the application server before you enable these options.

To configure ImageMagick:

1. From the left navigation, under Admin, click Sites & Settings, then select the Global site.

2. Click the ImageMagick tab.

3. Using the following table as a reference, complete the fields as needed.

   Field	Description
   Image Magick Executable	Path to the convert executable. Defaults to convert on the application server path.
   Image Magick Process Path	Additional directories to add to the path of the ImageMagick process.
   Disable Image Magick Download Options?	Select to hide ImageMagick formats from the Download Options window.
   Default Image Magick Format	Format that is selected by default in the Download Options window.

4. Click Save.

Configure DocRaptor PDF downloads

DocRaptor converts HTML documents to PDF during a download.

To configure DocRaptor:

1. From the left navigation, under Admin, click Sites & Settings, then select the Global site.
2. Click the DocRaptor tab.
3. In the Api Key field, type your DocRaptor API key.
4. Click Save.

note

Outside of production, Brightspot sends documents to DocRaptor in test mode, so the PDF contains a watermark.