Configuring a Site

Last Updated: 31 August, 2018

Note: This guide assumes you've already completed the steps to install the ElasticOCR solution in your SharePoint environment.

Enabling the Site Feature

The site feature must be enabled on any site that you wish to configure for ElasticOCR. These sites must exist within a web application that also has the ElasticOCR feature enabled. Browse to the site you wish to enable ElasticOCR on, and navigate to Site Contents, Settings, Manage Site Features.

Locate the “ElasticOCR” feature and click “Activate” to enable it.

2018-04-17 14_32_34-Site Features.png

Navigate back to Site Settings and verify successful activation by ensuring that an ElasticOCR group with link to “Configure ElasticOCR” has been added.

Click "Configure ElasticOCR" from the ElasticOCR group of the Site Settings page to open the ElasticOCR license and library configuration page.

2018-04-17 16_02_16-sp16.elasticocr.net_sites_ElasticOCRDemo_ElasticOCR_Config.aspx.png

Completing Site Configuration

Using the fields in the "License Configuration" panel, enter your License ID and App ID into the appropriate boxes. Once a valid license/app combination has been entered, a green bar will be displayed indicating your license is valid.

2018-04-17 16_03_41-sp16.elasticocr.net_sites_ElasticOCRDemo_ElasticOCR_Config.aspx.png

The "Library Configuration" panel displays a list of all document libraries contained within the site where you have installed the ElasticOCR app. Toggle the "Enable OCR" toggle to "On" for any library you wish to use ElasticOCR with.

2018-04-17 16_03_52-sp16.elasticocr.net_sites_ElasticOCRDemo_ElasticOCR_Config.aspx.png

Enable OCR - When set to "On", ElasticOCR capabilities are available to users when interacting with this library. Users may process a file with ElasticOCR by selecting one or more documents in the library and clicking "Process with ElasticOCR" on the ribbon, or by viewing an item's display properties and clicking "Process with ElasticOCR" on the ribbon.

Automatic OCR - When set to "On", documents are automatically processed by ElasticOCR when they are added to this library by a user.

Show OCR Status - When set to "On", ElasticOCR columns are displayed on the views of this library. These columns (OCR Date, and OCR Status) easily show a user whether ElasticOCR has processed, is currently processing, or has not processed a document in this library.

Delivery Behavior - Delivery behavior determines how a document is delivered back to this library after ElasticOCR has processed it. "Append OCR to Filename" will generate a new file with "_OCR" appended to the end of the original filename. "Save as a New Version" is available when versioning is enabled on a library, and will save the processed file as new version of the existing file. "Replace Existing File" is only available when versioning is disabled on a library, and replaces the original file with the processed file. The recommended setting is "Save as a New Version", as this preserves the original content without creating additional files.