Write Form

Operation Name

Write Form

Function overview

Writes input data to the database.

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.
Input data	Required	Not available	Select the component 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 which is specified in [Form name].
Field definition / Field name	Required	Available	Enter the field name of form. By default, the field name in the specified form is set.
Field definition / Type name	Required	Not available	Select the type of the field. By default, the field type in the specified form is set. [string] [datetime] [double]	If you change the type of operation , refer to "operation of conversion"for more information.
Update mode	Required	Not available	Select how to update data. [Insert]: (Default) [Input data] is used to create new data. [Insert/Update]: [Input data] is used to update data. [Delete]: [Input data] is used to delete data.
Validity verification	Optional	Not available	Select whether to use an expression computed field formula and field design. [Checked]: Field design formulas or computed field formula that is set in the database ("default expression" or "input-translation formula") is executed. [Not Checked]: (default) Field design formulas or computed field formula that is set in the database ("default expression" or "input-translation formula") does not run.	The design equation field "input validation formula" is not supported.
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".
Use update key	Required	Not available	Select whether [Key] is used as an update key when specifying [Insert/Update] or [Delete] in [Update method]. [Use]: (default) [Do not use]:	For more information on how to set the refresh key, Refer to "For information about setting the update key".

Write settings

Item name	Required/Optional	Use of Variables	Description	Remarks
Update with null when null value is input	Optional	Not available	Select the data input is null if the operation contains the value. [Checked]: Updates the field with initial value. [Not Checked]: (default) Do not update the field.	Enabled when [Insert/Update] is selected in [Update mode].

Key settings

Item name	Required/Optional	Use of Variables	Description	Remarks
Key	Optional	-	Specify the key. If the field data specified as a key matches to data within the document, update or delete the document. Each column can be operated with the following buttons. [Add]: Add a column. [Up]: Move the order of the selected column upwards by one. [Down]: Move the order of the selected column downwards by one. [Delete]: Delete the column.	During the following settings enabled. Select [Insert/Update] or [Delete] for [Update method] How to [Use update key] in [Use] Select For more details, refer to "For key settings".
Key / Key name	Required	Available	Enter the name of the field.

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

<?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>

Output Schema

None.

Loading schema in Mapper

Schema is loaded automatically.

See "Edit Schema"for any details .

Transaction

Transaction is not supported.

PSP Usage

PSP is not supported.

Available Component variables

Component variable name	Description	Remarks
count	Returns the total number of documents written data.	The value defaults to null. The total number of documents inserted, updated and deleted.
insert_count	Returns the number of documents inserted.	The value defaults to null.
update_count	Returns the number of documents updated.	The value defaults to null.
delete_count	Returns the number of documents updated.	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 name] in [Field definition] are as follows.

[Type}	Operation	Remarks
[string]	Writes the input data is converted to type String.	Is converted to an empty or null.
[datetime]	Writes the input data is converted to type Date.	If the data input data can not be converted to type Date, not written. Is converted to an empty or null.
[double]	Writes the input data is converted to type Double.	If the data input data can not be converted to type Double can not write Is converted to an empty or null.

For key settings

When [Use update key] is [Use].

Input data	[Insert/Update] Action	[Delete] Action
"Universal ID" exists	Searches using "Universal ID" as key, updates the matching Notes documents. Error occurs if no match exists."Note ID" or key value specified in [Key] is ignored.	Searches using "Universal ID" as key, deletes the matching Notes documents. Error occurs if no match exists."Note ID" or key value specified in [Key] is ignored.
"Universal ID" does not exist, "Note ID" exists	Searches using "Note ID" as key, updates the matching Notes documents. Error occurs if no match exists. Key value specified in [Key] is ignored.	Searches using "Note ID" as key, deletes the matching Notes documents. Error occurs if no match exists. Key value specified in [Key] is ignored.
Neither "Universal ID" nor "Note ID" exist	Searches using field specified in [Key] as key, updates the matching Notes documents. Inserts input data if no match exists.Error occurs if an non-exist key is specified.	Searches using field specified in [Key] as key, deletes the matching Notes documents. Do not delete when no match existsError occurs if an non-exist key is specified.
Neither "Universal ID" nor "Note ID" exist, and [Key] is not set	Searches using "field data" as key, deletes the matching Notes documents. Inserts input data if no match exists. "Data field" that contains a null case, it is considered illegal as a key in an error.	Searches using "field data" as key, deletes the matching Notes documents. Do not delete when no match exists. "Data field" that contains a null case, it is considered illegal as a key in an error.

Selecting several [Key]s means making an AND condition.
[Key] does not exist in the database field names you specify in writing may be subject to all documents.

When [Use update key] is [Do not use].

Input data	[Insert/Update] Action	[Delete] Action
"Universal ID" exists	Searches using "Universal ID" as key, updates the matching Notes documents. Error occurs if no match exists. "Note ID" will be ignored.	Searches using "Universal ID" as key, deletes the matching Notes documents. Error occurs if no match exists. "Note ID" will be ignored.
"Universal ID" does not exist	Searches using "Note ID" as key, updates the matching Notes documents. Error occurs if no match exists.	Searches using "Note ID" as key, deletes the matching Notes documents. Error occurs if no match exists.
Neither "Universal ID" nor "Note ID" exist	Searches using "field data" as key, deletes the matching Notes documents. Inserts input data if no match exists. "Data field" that contains a null case, it is considered illegal as a key in an error.	Searches using "field data" as key, deletes the matching Notes documents. Do not delete when no match exists. "Data field" that contains a null case, it is considered illegal as a key in an error.

Specification Limits

The user access from this adapter to the database of Domino server is fixed as the user set in Notes client.
Moreover, it requires that the user's password is cleared, clear password at Notes client .
Notes users who are configured on the client, "Password quality scale" please allow the setting without a password.

Please don not start Notes client in the execution of this adapter.

Writing to the field types "creator", "name", "reader", "password", "expression" is not supported.

About data with field type "text"

Operations in which the input data is null or empty character are as follows.

[Update mode]	Operation	Results when input data is null	Results when input data is empty character
[Insert]	Insert	Insert null	Insert null
[Insert/Update]	Insert	Insert null	Insert null
[Insert/Update]	Update	Depends on the settings of the [Update with null when null value is input]	None

If multiple-value in the field is specified as the [Key] of [Insert/Update] or [Delete] matches the key using the first value of input data. Updates input data in case of [Insert/Update].
Example: Uses the first value of input data "abc" to match the key, and updates with the input data "abc,aiu,123)

Field value before updating the document

123,abc

Input data: "abc,aiu,123" (separated by ",")

Field values of the updated document

abc,aiu,123

About data with field types "text", "dialog list", "check box", "list box"
- Writing multiple value data is available for fields that multiple value is already set.
About data with field type "date/time"
- Cannot write multiple value data to the field set with multiple value.
- Null or empty string is written as null.
- Writing data to date from the year 1999 AD is not one.
  From one year to 49 years from 2001 to 2049 AD, 99 years from 50 years from 1950 to 1999, writes as.
- Input data with omitted time is written as 00 hour 00 minute 00 second 000 millisecond.
- Writing in milliseconds is not supported.
- The only time you can not write data.
About data with field type "Number"
- Cannot write multiple value data to the field set with multiple value.
- Null or empty string is written as null.
About data with field type "Rich-text" or "Rich-text-lite"
- Richtext data converted into HTML format, attachments, images, OLE objects Preview Image, write icon images are not attachments.
- In case of writing text data, the field type is written as "text".

Field value before updating the document
123,abc

Field values of the updated document
abc,aiu,123

[Form name] display name of the form "name" is displayed.
If "Alias" is set to the form, the first alias is shown. To show the last alias, the setting of property file needs to be modified.In addition, untitled form cannot be shown.
Details below.

Key

Location

Description

Remarks

notes.compat.220

$DATASPIDER_HOME/server/plugin/data_processing/share/classes/
lotusnotescommon.properties

true:(default)
"Alias" is set if no form of "name", if it is an alias for the last set [Form name] appears on.

Name First alias Last alias Display name

Yes Yes Yes First alias

Yes Yes No First alias

Yes No No Name
false:
"Alias" is set if no form of "name", if it is an alias for the last set [Form name] appears on.

Name First alias Last alias Display name

Yes Yes Yes Last alias

Yes Yes No First alias

Yes No No Name

Example:notes.compat.220=false

About writing to form with "Store form in document" set as valid
- The documents inserted/updated by executing Write Form is inserted with "Store form in document" set as invalid.
- Document write operation to update the form, which maintains the state of the document update.
The document field "for the result" or "show results of the subform," the field is [Field definition] do not appear.

The encode supported by this adapter is "Shift_JIS".

Fields deleted from Domino Designer may be sometimes displayed in [Field definition].
This operation is identical to the issue "Fields names deleted from [Fields and functions] in the Design Pane show up in Domino Designer".
For more details, please contact IBM.

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]
InputDataNotFoundException	[Input data] is not specified.	Specify [Input data] or draw a data flow.
InvalidPropertyConfigurationException [<Property name>] is not specified.	[<Property name>] is not specified.	Specify the [<Property name>].
LotusNotesException The UniversalID "(<Universal ID>)" is invalid.	No document matching the "Universal ID" in the input data during operation [Insert/Update] or [Delete].	Please check input data.
LotusNotesException no document in the database file "<Note ID>".	No document matching the "Notes ID" in the input data during operation [Insert/Update] or [Delete].	Please check input data.
LotusNotesException The column "<key name>" in input data is not found.	[Insert/Update] or [Delete] during processing, [Key name] field does not exist in the specified.	Please confirm [Key name].
LotusNotesException Cannot use the empty column "<field name>" as update key.	[Insert/Update] or [Delete] during processing, has been used as a key <field name> contains data from the null.	Please check input data.