Overview

SynapOCR library provides functions for recognizing text in image files in conjunction with the Synap OCR engine server.

The features provided by the SynapOCR  library are as follows:

Recognize text: SynapOCRGetTextOnImage, SynapOCRGetTextOnAdvancedBoxes, SynapOCRGetTextOnForm
Query engine : SynapOCRGetEngineStatus

Common Properties

Common properties

Configure settings related to making requests to the SynapOCR server.

Common	Properties	Type	Required	Unit	Auto-setting	Description
Y	[Output] RESULT	Variable	Y	-	Y	Enter a variable to specify the result of the call.
Y	Engine URL	String	Y	-	Y	Enter the OCR engine address to call.
Y	API Key	String	Y	-	N	Enter your API Key.

MORE OPTIONS

MORE OPTIONS properties
Properties	Type	Required	Unit	Auto-setting	Description
On Error	Combination box	N	-	N	Specify an action to carry out when an error occurs at the time of execution. - If not specified: Output errors and exit the task. - --Ignore--: Ignore the error. - --Retry--: Try the activity one more time. - --Goto--: Try the scenario for the specified time if the activity fails. - _Event: Select an event created within the project.

DESCRIPTION

Properties	Type	Required	Unit	Auto-setting	Description
DESCRIPTION	Text	N	-	N	Enter the description for the activity card. The description entered in the DESCRIPTION field is used as the description of the activity. A representative value will be displayed in the absence of the DESCRIPTION input.

SynapOCRGetTextOnImage

Overview

This activity card, called Synap OCR's text recognition API, recognizes full text on images.

Application procedures

In the [Output] field, specify a variable to store the result of calling RESULT.
In the Engine URL field, enter the URL address and API Key to call.
In the ImageFile field, enter the text recognition target image file path.
Set the GetRawData property to select whether to get text recognition results in Json format.

Card properties

Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Image File	Variable	Y	-	N	Enter the OCR target image file path.
N	GetRawData	Toggle button	Y	-	Y	Specifies whether to get OCR results in Json format. (Default: Off)
Y	Common Properties	-	-	-	-	Common property of the SynapOCR library.
Y	MORE OPTIONS	-	-	-	-	Common property of the SynapOCR library.
Y	DESCRIPTION	-	-	-	-	Common property of the SynapOCR library.

Example of utilization

To perform text recognition use SynapOCRGetTextOnImage.

SynapOCRGETTextOnImage

Sample file

Menu > Help > Samples > Sample > SynapOCR > SynapOCR

Used variables

RESULT = Variable to store the result of the call
this.engineUrl = Variable to which OCR engine URL information will be assigned
this.apiKey = Variable to which the issued API Key information will be assigned
this.image = Variable to which OCR target image file path information will be assigned

Used properties

[Output] Result = RESULT
URL = this.engineUrl
API Key = this.apiKey
Image File = this.image
GetRawData = Off

Related/Similar activities

SynapOCRGetTextOnAdvancedBoxes, SynapOCRGetTextOnForm

SynapOCRGetTextOnAdvancedBoxes

Overview

This activity card calls Synap OCR's text recognition API; it recognizes text located within a specific area on an image.

Application procedures

In the [Output] field, specify a variable to store the result of calling RESULT.
In the Engine URL field, enter the URL address and API Key to call.
In the ImageFile field, enter the text recognition target image file path.
In the Advanced Boxes field, enter the area to recognize text in pixels.
Set the GetRawData property to select whether to get text recognition results in Json format.

Card properties

Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Image File	Variable	Y	-	N	Enter the OCR target image file path.
N	Advanced Boxes	String	Y	-	N	Enter the area within the OCR target image file in pixels. (left, top, width, height)
N	GetRawData	Toggle button	Y	-	Y	Set whether to get OCR results in Json format. (Default: Off)
Y	Common Properties	-	-	-	-	Common property of the SynapOCR library.
Y	MORE OPTIONS	-	-	-	-	Common property of the SynapOCR library.
Y	DESCRIPTION	-	-	-	-	Common property of the SynapOCR library.

Example of utilization

To perform text recognition use SynapOCRGetTextOnAdvancedBoxes.

SynapOCRGETTextOnAdvanceBoxes

Sample file

Menu > Help > Samples > Sample > SynapOCR > SynapOCR

Used variables

RESULT = Variable to store the result of the call
this.engineUrl = Variable to which OCR engine URL information will be assigned
this.apiKey = Variable to which the issued API Key information will be assigned
this.image = Variable to which OCR target image file path information will be assigned

Used properties

[Output] Result = RESULT
URL = this.engineUrl
API Key = this.apiKey
Image File = this.image
Advanced Boxes = '150,50,100,100'
GetRawData = Off

Related/Similar activities

SynapOCRGetTextOnImage, SynapOCRGetTextOnForm

SynapOCRGetTextOnForm

Overview

This activity card calls Synap OCR's text recognition API; it recognizes text on an image and returns a result based on the form registered in the OCR engine.

Application procedures

In the [Output] field, specify a variable to store the result of calling RESULT.
In the Engine URL field, enter the URL address and API Key to call.
In the ImageFile field, enter the text recognition target image file path.
In the Form ID field, enter the Form ID to be recognized.
Set the GetRawData property to select whether to get text recognition results in Json format.

Card properties

Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Image File	Variable	Y	-	N	Enter the OCR target image file path.
N	Form ID	String	Y	-	N	Enter the form ID to be recognized. If not set, all registered forms are applied.
N	GetRawData	Toggle button	Y	-	Y	Set whether to get OCR results in Json format. (Default: Off)
Y	Common Properties	-	-	-	-	Common property of the SynapOCR library.
Y	MORE OPTIONS	-	-	-	-	Ccommon property of the SynapOCR library.
Y	DESCRIPTION	-	-	-	-	Common property of the SynapOCR library.

Example of utilization

To perform text recognition use  SynapOCRGetTextOnForm.

SynapOCRGETTextOnForm

Sample file

Menu > Help > Samples > Sample > SynapOCR > SynapOCR

Used variables

RESULT = Variable to store the result of the call
this.engineUrl = Variable to which OCR engine URL information will be assigned
this.apiKey = Variable to which the issued API Key information will be assigned
this.image = Variable to which OCR target image file path information will be assigned

Used properties

[Output] Result = RESULT
URL = this.engineUrl
API Key = this.apiKey
Image File = this.image
GetRawData = Off

Related/Similar activities

SynapOCRGetTextOnImage, SynapOCRGetTextOnAdvancedBoxes

SynapOCRGetEngineStatus

Overview

This activity card invokes Synap OCR's engine status query API.

Application procedures

In the [Output] field, specify a variable to store the result of calling RESULT.
In the Engine URL field, enter the URL address and API Key to call.
In the ImageFile field, enter the text recognition target image file path.

Card properties

Common	Properties	Type	Required	Unit	Auto-setting	Description
N	GetRawData	Toggle button	Y	-	Y	Sets whether to get OCR results in Json format. (Default: Off)
Y	Common Properties	-	-	-	-	Common property of the SynapOCR library.
Y	MORE OPTIONS	-	-	-	-	Common property of the SynapOCR library.
Y	DESCRIPTION	-	-	-	-	Common property of the SynapOCR library.

Example of utilization

To retrieve engine status use information SynapOCRGetEngineStatus.

SynapOCRGETEngineStatus

Sample file

Menu > Help > Samples > Sample > SynapOCR > SynapOCR

Used variables

RESULT = Variable to store the result of the call
this.engineUrl = Variable to which OCR engine URL information will be assigned
this.apiKey = Variable to which the issued API Key information will be assigned

Used properties

[Output] Result = RESULT
URL = this.engineUrl
API Key = this.apiKey
GetRawData = Off