Read Full-Text Search

Operation Name

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]	For information about operations in changed types, refer to "Operations of Type Conversion".
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 when 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	Required	Available	Enter the delimiter of multiple values.	Delimiters of multiple values can be specified freely. The default value is ",". Multiple values can only be retrieved when the type of the field is "text".
Get attachment	Optional	Not available	Select whether to get the attachments in Notes document. [Checked]: (default) Get an attachment inNotes document. [Not Checked]: Do not get the attachment in Notes document.
Destination to save attachment	Required	Available	Select or input directory to save the attached file in the document. Click [Browse] button to activate the file Selectr and Select the directory.	[Get attachment] if you check to enable. 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 "/"..

Property Action

Item name	Description	Remarks
Reset forms and fields	Resets the form list of [Form name] and [Field definition].	If any form or field is added or modified by Domino Designer, the change can be reflected by using this property action. The change of form or field is only reflected in this operation.

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]	Convert all fields regardless of field types into the String type and read.
[datetime]	If the field type is "Numeric type", convert the field into the Date type and read. Cannot read if field type is "text" and cannot be converted to Double type.	e.g.) If data read from the field is "1", it will be converted into "1970-01-01T09:00:00.001+0900" (when the time zone is set to the Japanese Standard Time).
[double]	If the field type is "Date/time", convert the long value stored in data into the Double type and read. Cannot read if field type is "text" and cannot be converted to Double type.	e.g.) If data read from the field is "1970-01-01T09:00:00.001+0900", it will be converted into "1" (when the time zone is set to the 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

Multiple versions can not be used at the same time.

In case of Read Full-text Search, Notes database must be indexed in advance.

Data with the field type "expression" cannot be loaded.

About data with field types "text", "dialog list", "check box", "list box"
- For multiple values, [Delimiter] separated by a specified read.
About data with field type "date/time"
- Data will be formatted as "yyyy-MM-dd'T'HH:mm:ss.SSSZZ".
- About the notation of years from January 1st of 1950 to December 31th of 1999, only the last 2 digits(5x~9x) is read.
- For multiple values, only the first value is read.
About data with field type "Number"
- Data is get as Double type.Can represent the real part, the maximum is 17 digits "1.7976931348623157 E308", minimum value "4.9E-324d" will be. In addition, the specifications of type conforms to the Double type of Java.
- For multiple values, only the first value is read.
About data with field type "Rich-text" or "Rich-text-lite"
- Reads only the text data and attachments in Notes document.
  Files attached by using "File Upload Control" in "Built-in Design Elements" cannot be retrieved.
- If the attachment name includes "Constrained Characters of DataSpider File System", it will be converted to" _ "(underscore characters ) to get.
The document field "for the result" or "show results of the subform," the field is [Field definition] do not appear.

Regardless of the field type, [Type] in [Field definition] in a sub form is set as [string].
Select [Type] of [Field definition] manually.

The range of character codes supported as Shift_JIS code is as the following range defined in JISX0201/JISX0208 coded character sets.
- 1 byte characters: 0x20 - 0x7E, 0xA1 - 0xDF
- 2 byte characters: Characters defined as Shift_JIS among 0x8140 - 0xEAA4
The following vendor-defined external characters(NEC special characters, IBM extended characters) and user-defined external characters are not supported.
- NEC special characters: 0x8740 - 0x8790, 0xED40 - 0xEEFC
- IBM extended characters: 0xFA40 - 0xFBFC
- User-defined external characters: 0xF040 - 0xF9F0
Although some versions of Notes may be able to output the external characters, it is not intended in the specification to guarantee the operation.

If an alias is defined in a form, both the form name and the alias name are displayed in [Form name].
Selecting the last alias to enable a form defined an alias.

If an invalid [Destination] is specified, it may take some time to open a property setting dialog.

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 selected in [Destination] is not found.	Check the global resource specified in [Destination].
InvalidPropertyConfigurationException Property "<property name>" value "" is incorrect.	[<Property name>] is not specified.	Specify the [<Property name>].
InvalidPropertyConfigurationException Given <property name> "<value of the property>" not found.	[<Property Name>] not found in the specified property value.	[<Property Name>] Please check the value of the property specified.
LotusDominoException 4005: Notes error: Query is not understandable ( ) -- No document in the database file "<database>" matches the criteria.	[Search string] contains invalid characters.	Check [Search string].

Notes

About the log of server console and server.log stating "Cannot get form list"
During the creation of script in Designer, the log "ds.kernel.mgr.dpc|WARN| Cannot get view list.""The following message appears with a log, you may not be able to get done and field definitions are updated list of forms of property.
- NotesException: Session closed due to communications failure
- NotesException: Object no longer exists on server
- NotesException: Bulk recycler is not running
- org.omg.CORBA.INV_OBJREF: vmcid: 0x49423000 minor code: 2449 completed: No
- org.omg.CORBA.INV_OBJREF: vmcid: 0x49420000 minor code: 64 completed: No
This is caused by the lost of connection because the operation of getting form or updating column has not been executed for time longer than the "Idle session timeout" set in DIIOP Server.
"Get form list" in Properties and update of column definition can be enabled again by closing and reopening the project.
If this case occurs frequently, please check the setting of "Idle session timeout" of the DIIOP Server.