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 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	Required	Not available	Select the type of the field. By default, the field type in the specified form is set. [string] [datetime] [double] [richtext]	Fields of which the field type is "Rich text" are set as [string].
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.
Use the field design formula	Optional	Not available	Select whether to use the field design formula. [Checked]: Executes the field design formula("Input translation formula" or "input validation formula") set in the database. [Not Checked]: (default) Do not execute the field design formula("Input translation formula" or "input validation formula") set in the database.	"Default formula" of field design formula is not supported.
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".

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.

Write settings

Item name	Required/Optional	Use of Variables	Description	Remarks
Update in initial value when input value is empty.	Optional	Not available	Selects the action when the input data is null or empty character. [Checked]: (default) Updates the field with initial value. [Not Checked]: Do not update the field.	Enabled when [Insert/Update] is selected in [Update mode]. The initial value varies depending on the type of the field.The initial value of each type are as follows. Text:null Date/Time: null Number:0 Rich-text:null

Key settings

Item name	Required/Optional	Use of Variables	Description	Remarks
Key	Optional	-	Specify the key. Reads data matching the specified key. 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 a column.	For the details about specifying the key, please refer to "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.

For key settings

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, "NoteID" 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.	Searches using "field data" as key, deletes the matching Notes documents. Inserts input data if no match exists.

If the input data of the field specified as [Key / Key name] is null at the time of [Insert/Update], all the documents in the database are subject to update.
If the field specified as [Key / Key name] is different from [Field definition / Field name], an error will occur at execution.
Do not use a field containing "Rich text" data as a key.
Fields of which the [Type] is [richtext] are not to be used as keys.
If a field which can be used as a key does not exist, the process will be proceeded as not being matched in the search.

Specification Limits

Multiple versions can not be used at the same time.

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

About data with field type "text"
- Null or empty string is written as null.
- 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 of Notes document before update
  
  123,abc
  
  Input data: "abc,aiu,123" (separated by ",")
  
  Field value of Notes document after update
  
  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.
- The time is in 24-hour format.
- Input data with omitted date is written as January 1st, 1970.Input data with omitted time is written as 00 hour 00 minute 00 second 000 millisecond.
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 "0".
About data with field type "Rich-text" or "Rich-text-lite"
- Cannot insert/update/delete preview image, icon image of rich-text data, attachments, attached images, OLE objects that have been converted to HTML format.
- If you specify [string] as [Type] and write text data, the field type is set as "Text".
  In that case, indents contained in text data are not displayed in the Notes client.
- If you specify [richtext] as [Type] to write text data, the field type is set as "Rich Text".
  In that case, indents contained in text data are displayed in the Notes client.
About writing to form with "Store form in document" set as valid
- In documents inserted or updated by executing the Write Form Processing, the "Store the form in the document" option will be invalid and inserted.
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.

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.

When data is inserted into another form in the same database on the same server, while the update key is “Universal ID”, “Note ID”, or “Key settings”, and [Update mode] is [Insert/Update], the read data is moved to the other form.

Field value of Notes document before update
123,abc

Field value of Notes document after update
abc,aiu,123

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] is not found.	Check the global resource specified in [Destination].
InputDataNotFoundException	[Input data] is not specified.	Specify [Input data] or draw a data flow.
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 4091: Invalid universal id	No document matching the "Universal ID" in the input data during operation [Insert/Update] or [Delete].	Please check [Input data].

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.