Notes® Connector Properties

The following table defines the properties for the Connector for Notes®.

Token

Name/Description

Type

LCTOKEN_SERVER

Server

Notes® server. If not supplied, the local Notes® database will be accessed.

Text

LCTOKEN_DATABASE

Database

Notes® database filepath, not the title. Required. Primarily used for establishing a connection.

Text

LCTOKEN_METADATA

Metadata

Notes® form name. Unlike many other connectors, Notes® Execute operations also require a Metadata property value, since the selection formula does not include metadata information.

Text

LCTOKEN_INDEX

Index

Notes® view name.

Text

LCTOKEN_MAP_NAME

MapByName

Whether to map by name or position when transferring data between data source and target.

Boolean

LCTOKEN_WRITEBACK

Writeback

Whether to perform writeback or non-writeback operations.

Boolean

LCTOKEN_FIELDNAMES

FieldNames

Text list of fields to select - used for Select operations

Text List

LCTOKEN_ORDERNAMES

OrderNames

Text list of fields to order results by - used for Select operations

Text List

LCTOKEN_CONDITION

Condition

Notes-specific syntax conditional clause used for Select operations (part of a Notes® selection formula). This must be valid syntax for a "select <condition>" formula.

Text

LCTOKEN_STAMPFIELD

StampField

Field name of timestamp field - used for Select operations. Using StampField without a view (DB search instead) only works when the timestamp field is "@Modified", and the LoadModified property is set to TRUE. When not using this new property, a view search is still required (although if no view property is set, a temporary one will be created).

Text

LCTOKEN_BASESTAMP

BaseStamp

Minimum timestamp value to include in results - used for Select operations

Datetime

LCTOKEN_MAXSTAMP

MaxStamp

During a Select operation, set by the connector to the current/maximum timestamp value - set by Select operations.

Datetime

1.00

Port

Port name to locate the server on. No value searches all ports.

Text

2.00

EnforceForm

Whether to enforce the form design on documents created and accessed.

0 -- The connection does not execute any Notes® form- and field-related formulas.

1 -- Executes all Notes® field-related formulas (default value, input translation, and computed field) as part of the session. This option may cause slower data transfer as a result of formula calculations. This option does not execute @DB functions.

2 -- The session sets all field flags as defined in the form but does not execute any formulas. As a result, special types, indicated in Notes® by flags --such as reader and author names--are assigned in new documents as indicated in the form. This option avoids the overhead of computing field formulas.

Integer

3.00

MultiValueAsText

Whether to represent all multi-value Notes® types (text list, number list, and datetime list) as text values. This can make type transformation between non-Notes connectors that do not support multi-value types more straightforward.

Boolean

4.00

BulkStore

Whether to buffer all document modifications for bulk submittal at disconnection. This increases performance, but prevents access to those changes until disconnection.

Boolean

5.00

FilePath

Directory on the Domino® server into which attachments are extracted to and attached from when using the FILE virtual field or the LoadFile property. By default, the current working directory is used.

Text

6.00

UpdateViews

Whether to update all views in the database during disconnection. After making extensive changes, the initial opening of a view can perform a time-consuming update.

Boolean

7.00

CreateDatabase

Whether to create a database during connection if one does not exist. The database is blank, unless a database template is specified with the TemplateServer and TemplateDatabase properties.

Boolean

8.00

TemplateServer

Notes® Server where the database specified at TemplateDatabase resides. This template is used in conjunction with the CreateDatabase option. No value uses the local Notes® installation

Text

9.00

TemplateDatabase

Notes® template database filepath on TemplateServer. This template is used in conjunction with the CreateDatabase option.

Text

10.00

View

Notes® view to open for Execute or to use for keyed operations. The view's result set replaces any Statement submitted to Execute.

Text

11.00

Agent

Notes® agent to run for an Execute operation on the result set produced by either the Statement parameter or the View property.

Text

12.00

FullTextQuery

Notes® full text query for an Execute operation on the result set produced by either the Statement parameter or the View property, and any Agent property.

Text

13.00

TextMaxLength

Notes® text data is limited to slightly less than 64K. To simplify data creation on other connectors with shorter text columns, specify a value to assign as the maximum length for text metadata in any result set produced.

Integer

14.00

FetchViewData

Whether to fetch data from view columns rather than from document fields. Requires a View property value.

Boolean

15.00

AllForms

Whether to include documents of all forms. By default, only documents of the form indicated by the metadata property value are included. When including documents of other forms, fields in the indicated metadata are used in place of those document's forms.

Boolean

16.00

ViewResponses

Whether to include view response docu- ments. By default, only main topics are included. Requires a View property value.

Boolean

17.00

LoadUnid

Whether to add a UNID virtual field to the result set produced by an Execute or Select operation.

Boolean

18.00

LoadNoteid

Whether to add a NOTEID virtual field to the result set produced by an Execute or Select operation.

Boolean

19.00

LoadRef

Whether to add a REF virtual field to the result set produced by an Execute or Select operation.

Boolean

20.00

LoadFile

Whether to add a FILE virtual field to the result set produced by an Execute or Select operation.

Boolean

21.00

CopyHierarchy

Whether to add a LCXHIER virtual field to the result set produced by an Execute operation.

Boolean

22.00

CopyFile

Whether to add a LCXFILE virtual field to the result set produced by an Execute or Select operation.

Boolean

23.00

ExecuteDelete

Whether to delete the result set produced during an Execute operation. This property is to simulate native DELETE statements provided on some other connectors.

Boolean

24.00

InsertMail

Whether to reroute Inserted documents as mail. Normal Notes® addressing information, such as the required SendTo field, is used.

Boolean

25.00

MailEmbedForm

Whether to embed the form in documents mailed through the InsertMail property. Use when the target form is not available in the recipients' mail database.

Boolean

26.00

Encrypt

Encrypts all encryption-enabled fields in the form of the target document. To use private encryption keys (the default is to use the public key), provide one or more private encryption key names, separated by commas or semicolons in EncryptKeyList. These keys must be available on the Domino® server.

Boolean

27.00

EncryptKeyList

One or more private encryption key names separated by commas or semicolons, to be used by Encrypt. Valid only if Encrypt is True.

Text list

28.00

PurgeDeleteStubs

Clears all deletion stubs from the Notes® database when disconnecting. It is strongly recommended that this only be used with UpdateViews, since once the stubs are deleted, they will not be properly removed from views.

Boolean

29.00

SearchNoCase

Makes view searches case-insensitive (they are case-sensitive by default).

Boolean

30.00

AlterView

When the LSX does a Select operation with the connector's View property set, AlterView=True allows the script to modify or create the view if it doesn't already exist or doesn't have the proper formatting. Necessary for select operations when a view and stampfield are specified.

Boolean

31.00

LoadModified

Set to add a field "@Modified" to the result set, which contains the Notes® implicit document timestamp. This field can only be read and attempts to set it will be ignored.

Boolean

32.00

StampViewKey

Indicates the value for the first key value for keyed operations when the view is an LSX-created view for timestamp selection. Zero means don't use. 1 is the value for docs outside the timestamp selection range, 2 is the value for docs inside the range. When performing a timestamp selection, this is automatically set to 1 by the connector, and reset to zero when clearing the result set, and should only be used or altered with great care.

Integer

33.00

CopyCompSpecial

Copies any composite support fields associated with transferred documents. This includes the fields, links, and fonts to return full fidelity of composed data.

To use this option from an activity with manual field mapping, add a field 'LCXHIER' to both field lists (this is not necessary for automatic field mapping by name or position).

Boolean

34.00

DeleteDatabase

Deletes the database specified in the activity upon connection. This is used together with Creation to delete and then recreate the database prior to population.

Boolean

35.00

PostFetchFormula

Enter the Notes® formula that will execute just after the data is fetched. The data is altered as part of the fetch/select operation.

Text

36.00

PreInsertFormula

Enter the Notes® formula that will execute just before the selected data is inserted into the target. The data is changed as part of the insert operation.

Text

37.00

PreUpdateFormula

Enter the Notes® formula that will execute before the data in the designated target is updated. The transformation will take place as part of the update operation.

Text

38.00

AddSubformList

To support computed subforms, list all of the subforms to include here. All fields in these subforms will be considered to be part of the form.

Text List