Read Characters

Operation Name

Read Characters

Function Overview

Upload the image file available in DataSpider file system to Tegaki, and receive the result of characters reading.

Data Model

XML type.

Properties

For details on use of variables, refer to "Variables".
Basic settings
Item name Required/Optional Use of Variables Description Remarks
Name Required Not available Enter the name on the script canvas.  
Required settings
Item name Required/Optional Use of Variables Description Remarks
Destination Required Not available Select a global resource.
For details about how to configure global resource, refer to "Global Resource Properties".
  • [Add]:
    Add a new global resource.
  • [Edit list]:
    Global resource settings can be edited in "Edit resource list" screen.
  
Image file Required Available Specify the file path of the image (jpg or png format) available in DataSpider file system.

You can click [Browse] button to launch file chooser and find the file.
  • Wild cards ("*" and "?") can be used in image file name.
  • Specify the absolute path of the DataSpider file system as the file path.
  • Except for the path separator "/" and wild cards ("*"/"?"), Constrained characters of DataSpider File System cannot be used.
Template Required Available Specify the file path of the template available in DataSpider file system.

You can click [Browse] button to launch file chooser and find the file.
Field list Required - Displays the field list of the file specified in [Template].
  • Only the fields supported for reading are displayed. For more details, refer to "Specification limits".
Field list/Field name Required Not available The field name of the file specified in [Template] will be set by default.
Field list/Format Required Not available Specify the format for each [Field name].
  • [None]: (default)
    Does not convert.
  • [Get only numbers]:
    Removes all non-numeric characters and converts the numbers to half-width numbers.
  • [Convert to half-width alphanumeric characters]:
    When alphanumeric characters are available, converts those characters to half-width alphanumeric characters.
  • Only "0 to 9" are get by [Get only numbers]. Applicable only for Arabic numbers.
Property actions
Item name Description Remarks
Get the field list from template Reads the field list from the file specified in [Template] and sets it.
  • If you use a script variable for [Template], field list cannot be read.
Option settings
Item name Required/Optional Use of Variables Description Remarks
Trim the result data and get it. Optional Not available Select whether to trim or not the blank characters available before and after the read result data.
  • [Checked]: (default)
    Trims the blank characters available before and after the read result data.
  • [Not checked]:
    Does not trim the read result data.
  
Delete the data related to completed read request, from Tegaki. Optional Not available Select whether or not to delete the data related to completed read request, from Tegaki.
  • [Checked]: (default)
    Deletes the data for which reading is performed.
  • [Not checked]:
    Does not delete the data for which reading is performed.
  
Data processing method
Item name Required/Optional Use of Variables Description Remarks
Mass data processing Required Not available Select data processing method.
  • [Use script settings]: (default)
    Apply mass data processing settings of script property to adapter.
  • [Disable]:
    Mass data processing is not performed.
  • [Enable]:
    Mass data processing is performed.
  
Comment
Item name Required/Optional Use of Variables Description Remarks
Comment Optional Not available You can write a short description of this adapter.
The description will be reflected in the specifications.		  

Schema

Input schema

None.

Output schema

<?xml version="1.0"?>
<root>
  <result>
    <filepath />
    <requestid />
    <status />
    <field>
      <value />
      <confidence />
    </field>
  </result>
</root>
Element name Attribute name Description Remarks
root -    
result - Appears in each image file for which read has been performed.  
filepath - Outputs the file path of the image for which read has been performed.  
requestid - Outputs the request ID.  
status - Outputs the operation status.
  • COMPLETED: Operation completed successfully.
  • FAILED: Operation failed.
  
field - Appears for each field element defined in template file.  
value - Outputs the read result of the image file.  
confidence - Outputs the confidence rate of the read result of the image file.  

Loading schema in Mapper

Schema is loaded automatically.
See "Edit Schema" for details with regards to defining a schema.

Mass Data Processing

Mass Data Processing is supported.

Transaction

Transaction is not supported.

PSP Usage

PSP is not supported.

Available Component Variables

Component variable name Description Remarks
count The number of reading completed files is stored.
  • Default value is null.
message_category When an error occurs, the corresponding message code's category is stored.
  • Default value is null.
message_code When an error occurs, the corresponding message code is stored.
  • Default value is null.
message_level When an error occurs, the corresponding message code's severity is stored.
  • Default value is null.
error_type When an error occurs, the error type is stored.
  • Default value is null.
  • The error type will be in the following format.
    Example: "java.io.FileNotFoundException"
  • The contents that will be stored may vary depending on DataSpider Servista versions.
error_message When an error occurs, the error message is stored.
  • Default value is null.
  • The contents that will be stored may vary depending on DataSpider Servista versions.
error_trace When an error occurs, the error's trace information is stored.
  • Default value is null.
  • The contents that will be stored may vary depending on DataSpider Servista versions and client applications.

Specification limits

Major Exceptions

Exception name Cause Solution
ResourceNotFoundException
Resource definition is not found. Name: []		 [Destination] is not specified. Specify [Destination].
ResourceNotFoundException
Resource definition is not found. Name: [<global resource name>]		 The resource definition specified in [Destination] is not found. Check the global resource specified in [Destination].
InvalidPropertyConfigurationException
<property name> is not specified.		 [<property name>] is not specified. Specify [<property name>].
InvalidPropertyConfigurationException
<property Name> is not entered.		 [<property name>] is not entered. Enter [<property name>].
InvalidPropertyConfigurationException
Specified <property name> does not exist.		 Selected [<property name>] is not found. Specify an existing [<property name>].
org.apache.http.HttpException
 An error occurred during Tegaki processing. Check the settings and the input value according to the error message.
java.net.SocketTimeoutException Timeout occurred while connecting Tegaki Check the status of network and Tegaki. Or, check [Timeout] of the global resource specified in [Destination].