Configuring the App

Last Updated: 31 August, 2018

Note: This guide assumes you've already completed the steps to install the ElasticOCR app in your tenancy.

Adding the ElasticOCR App to a Site

From the Site Contents screen or the settings gear in the suite bar, select "Add an App".

If you are installing the ElasticOCR app on the root site of your tenant (ie: company.sharepoint.com), review be sure to review and complete the steps in Special Considerations for Root Sites prior to adding the app.

2018-04-27 12_15_37-ElasticOCR Team Site - Home.png

Select "ElasticOCR" from the list of "Apps you can add".

Accept the trust dialog by clicking "Trust It".

The "ElasticOCR" app is now being added to your site, and will appear grayed out until it is ready to be launched.

2018-04-27 12_16_37-Site Contents.png

Once the app has completed installing, it will become clickable.


Configuring the ElasticOCR App on a Site

From the "Site Contents" screen, click on the "ElasticOCR" app to launch it.

Office 365 will briefly display a "Working on it" spinner while you are redirected to the ElasticOCR app.

2018-04-27 12_17_30-Working on it....png

If this is the first time you have launched the app, you'll briefly see a message while we configure the app for use.

2018-04-27 13_20_10-https___elasticocrtest-e90cd7cd7752e6.sharepoint.com_sites_demo_ElasticOCR_Elast.png

When the "Get Started" button illuminates, click it to open the app.

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.

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.

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.


Special Considerations for Root Sites

The root site collection in your Office 365 SharePoint tenant may look the same as all of your other site collections, but has a number of unique characteristics under the covers. One of those unique characteristics is a feature that prevents scripts from running that might be used to customize the site. ElasticOCR requires these permissions to accurately deploy and manage the document processing jobs you submit for processing. Prior to adding the ElasticOCR app to a tenant's root site collection, you must run the following PowerShell script as a Global Administrator of your Office 365 tenant.

Connect-SPOService
Set-SPOsite https://company.sharepoint.com -DenyAddAndCustomizePages 0

Additional information about this command can be found here.