Read Full-Text Search

Operation Name

Read Full-Text Search

Function overview

Read data using full-text search.

Data Model

Data model of this type of component is table model type.

Properties

For information about using 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 Global Resources.
Refer to " Global Resource Properties " for global resource settings .
  • [Add]:
    Adds new global resource.
  • [Edit list]:
    Global resource settings can be managed from "Edit Resource list".
  
Form name Required Available Select or enter a form name.
  • If a script variable is specified, [Field definition] is left unconfigured.
Field definition Required - Display the field definition of the form specified in [Form name].  
Field definition / Field name Required Available Enter the name of the field.
By default, the field name in the specified form is set. 		 
Field definition / Type Required Not available Select the type of the field.
By default, the field type in the specified form is set.
  • [string]
  • [datetime]
  • [double]
Search string Required Available Enter a search string.
  • For more information about the search string, please{ refer to " here ".
Maximum number of retrieved documents Optional Available Enter the number of documents to retrieve.
  • The default value is "0", "0" is set if omitted.
  • If "0" is specified, gets all documents in the form.
  • If the specified value exceeds the number of all documents in the form, gets all the documents in the form.
Delimiter Optional Available Enter the delimiter of multiple values.
  • Delimiters of multiple values can be specified freely.
  • The default value is ",", "," is set if omitted.
  • Multiple values ??can only be retrieved when the type of the field is "text".
Destination to save attachment Required Available Select or enter the directory to save HTML files in richtext and attachments.

Click [Browse] button to activate the file Selectr and Select the directory.
  • The default value is "/tmp".
  • Please specify the absolute path of the DataSpider file system as the file path.
  • Constrained Characters of DataSpider File System cannnot be used, except for the path separator "/"..
  • If unexisted directory is specified, an error will occur every time you run the program.
Save each rich text document in a directory Required Available Select whether you save HTML files and attachments in the directory of the same name as a universal ID or not.
  • [Checked]:
    Create a directory of the same name as a universal ID under the directory specified in [Destination to save attachment].
  • [Not Checked]: (default)
    Save under the directory specified in [Destination to save attachment].
  • If it is not checked, of the attachments sharing the same name, only one of them will be retrieved.
Data processing method
Item name Required/Optional Use of Variables Description Remarks
Mass data processing Required Not available Select a 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" encoding="UTF-8" ?>
&lt;table&gt;
  &lt;row&gt;
    <column>UniversalID</column>
    <column>NoteID</column>
    <column>field data</column>
    :
  &lt;/row&gt;
  &lt;row&gt;
    :
  &lt;/row&gt;
</table>

Loading schema in Mapper

Schema is loaded automatically.
See "Edit Schema"for any details .

Mass data processing

Mass data processing is supported.

PSP Usage

PSP is not supported.

Available Component variables

Component variable name Description Remarks
count Returns the number of read data.
  • The value defaults to null.
message_category Stroes the category to which corresponding message code belongs to, when an error occurs.
  • The value defaults to null.
message_code Stores its corresponding message code of occured error.
  • The value defaults to null.
message_level Stores the severity of the corresponding message code of the occured error.
  • The value defaults to null.
error_type Stores the type of the occured error.
  • The value defaults to null.
  • Error is represented in the format depicted below.
    Example:java.io.FileNotFoundException
  • The message may vary depending on DataSpider Servista version.
error_message Stores the error message for the occured error.
  • The value defaults to null.
  • The message may vary depending on DataSpider Servista version.
error_trace Stores stack trace of the occurred error.
  • The value defaults to null.
  • The message may vary depending on DataSpider Servista version or the client application used.

Operation of Type Conversion

Operations of type conversion when specifying [Type] in [Field definition] are as follows.

[Type} Operation Remarks
[string]
  • Regardless of the type of the field, converts all type String to read.
  
[datetime]
  • The field type "number" if, based on the value read is converted to type Date.
  • Cannot read if field type is "text" and cannot be converted to Date type.
  • Example: If the data read from the field is "1", it is converted to "1970-01-01T09:00:00.001+0900"(If the timezone of the OS is Japanese standard time".
[double]
  • The field type "Date/time", the data is holding the long value read is converted to type Double.
  • Cannot read if field type is "text" and cannot be converted to Double type.
  • Example: If the data read from the field is "1", it is converted to "1970-01-01T09:00:00.001+0900"(If the timezone of the OS is Japanese standard time".

How to specify search strings

The method to specify search strings depends on the search function of Notes.
For information about the search function of Notes, refer to the technical information provided by IBM, "How to search by the search engine(GTR)" (reference#: 1464610).

Specification Limits

Main exceptions

Exception name Cause Solution
ResourceNotFoundException
Resource definition could not be found.Name: []		 [Destination] is not specified. Specify [Destination].
ResourceNotFoundException
Resource definition could not be found.Name: [<name of Global Resources>]		 Resource definition specified in [Destination] does not exist. Check the global resource specified in [Destination]
InvalidPropertyConfigurationException
[<Property name>] is not specified.		 [<Property name>] is not specified. Specify the [<Property name>].
LotusNotesException
[STATUS: 3842] Database is not full-text indexed.		 The database to connect is not indexed. Please create the index of the database to connect.
LotusNotesException
[STATUS:3849] Does not understand the criteria		 [Search string] contains invalid characters. Check [Search string].