LotusWriter

Not available in Community Designer

Short Description
Ports
Metadata
LotusWriter Attributes
See also

Short Description

LotusWriter writes data into Lotus Domino databases. Data records are stored as Lotus documents in the database.

ComponentData output Input ports Output ports Transformation Transf. required Java CTL Auto-propagated metadata
LotusWriterLotus Notes10-1
no
no
no
no
no

Ports

Port typeNumberRequiredDescriptionMetadata
Input0
yes
for input data records 
Output0
no
for invalid data records 

Metadata

LotusWriter does not propagate metadata.

LotusWriter has no metadata templates.

LotusWriter Attributes

AttributeReqDescriptionPossible values
Basic
Domino connection
yes
ID of the connection to the Lotus Domino database. 
Mode
no
Write mode. Insert mode always creates new documents in the database. Update mode requires View to be specified. Update operation first finds all documents in the View with same key values as incoming data record. After that either all found documents are updated, or only the first one is updated. "insert" (default) | "update"
View
no
The name of the View in a Lotus database within which the data records will be updated. 
Advanced
Mapping
no
When no mapping is provided, new documents will get the exact same set of fields as retrieved from the input port. With mapping, it is possible to customize which fields will be written to Lotus documents. Fields can be written with different names and order, some can be skipped and some written multiple times with different names. Often it is desirable to work with fields from the Document Lotus form. Mapping of input port fields onto Document form fields can be established in this attribute.docFieldX := inFieldY; ...
Compute with form
no
When enabled, computation will be launched on the newly created document. The computation is typically defined in a Document form. This form is used by the users of Lotus Notes to create new documents. The computation may for example fill-in empty fields with default values or perform data conversions.true (default) | false
Skip invalid documents
no
When enabled, documents marked by Lotus as invalid will not be saved into the Lotus database. This setting requires the Compute with form attribute to be enabled, otherwise validation will not be performed. Validation is performed by the computing Document form action.true | false (default)
Update mode
no
Toggles the usage of lazy update mode and behavior when multiple documents are found for update. Lazy update mode only updates the document when values get actually changed - written value (after optional computation) is different from the original value. When multiple documents are found to be updated, either only first one can be updated, or all of them can be updated."Lazy, first match" (default) | "Lazy, all matches" | "Eager, first match" | "Eager, all matches"
Multi-value fields
no
Denotes input fields which should be treated as multi-value fields. Multi-value field will be split into multiple strings by using the separator specified in the Multi-value separator attribute. The resulting array of values will then be stored as a multi-value vector into the Lotus database.semicolon separated list of input fields
Multi-value separator
no
A string that will be used to separate values from multi-value Lotus fields.";" (default) | "," | ":" | "|" | "\t" | other character or string

Details

LotusWriter is a component which can write data records to Lotus databases. The writing is done by connecting to a Lotus Domino server.

The data records are written to a Lotus database as Documents. A document in Lotus is a list of key-value pairs. Every field of written data record will produce one key-value pair, where key will be given by the field name and value by the value of the field.

The user of this component needs to provide a Java library for connecting to Lotus. The library can be found in the installation of Lotus Notes or Lotus Domino. LotusWriter component is not able to communicate with Lotus unless the path to this library is provided or the library is placed on the user's classpath. The path to the library can be specified in the details of Lotus connection (see Lotus Connections).

See also

LotusReader
Common Properties of Components
Common Properties of Writers
Chapter 56, Writers