dataconnection (Domino DTD)

Containment Hierarchy

Contained by: %design.elements;

Contains: %named.design.note.prolog;, %note.epilog;

Syntax

<!ELEMENT dataconnection (%named.design.note.prolog; , %note.epilog; )>

Content

%named.design.note.prolog; , %note.epilog;

Contains any of the contents of the %named.design.note.prolog; entity, followed by any of the contents of the %note.epilog; entity.

Attributes

<!ATTLIST dataconnection

>

blockkeyfieldupdates

Indicates whether to allow the key field to be updated. Default is false.

class

Type of data source the external connection is being made to. See the %dataconnections.class; entity for a list of options.

conflictdetection

Boolean value. If true, instructs Notes/Domino to throw an error when there is a data conflict during a transfer. Default is false.

connections

Maximum number of concurrent connections that should be made to an external data source.

database*

Name of the external database you want to access. This attribute is only an option if the type attribute equals DB2, Sybase, or OLE DB.

datasource*

Data source name of the external database you want to access. This attribute is only an option if the type attribute equals OLE DB.

disablehttpcaching

Indicates whether the server should cache data extracted from the external database. If the data source contains mostly static data, you may want to disable caching. Do not disable caching for a transactional processing system where the data is frequently changing. Default is false.

fieldsgetdecserrors

Indicates whether errors on individual field updates should be recorded in the corresponding Notes fields. If false, fields remain blank if there is an error in the data transfer.

hoststring*

Host string of the external database you want to access. This attribute is only an option if the type attribute equals Oracle or Oracle 8.

objectcreate

Name of the procedure to associate with the Create event.

objectdelete

Name of the procedure to associate with the Delete event.

objectname

Name of the metadata object to connect to.

objectopen

Name of the procedure to associate with the Open event.

objectowner

Owner of the metadata object to connect to.

objecttype

Type of object to access data from in the external data source. See the dataconnection.object.types; entity for a list of options.

objectupdate

Name of the procedure to associate with the Update event.

ondatamismatch

Instructs Notes/Domino on how to proceed if it encounters a data conflict. See the %dataconnection.ondatamismatch.values; entity for a list of options.

onmissingrecord

Instructs Notes/Domino on how to proceed if it encounters a missing record. See the %dataconnection.onmissingrecord.values; entity for a list of options.

password

Password associated with the user name authorized to access the third party database.

spacetrim

Indicates whether to trim the leading and trailing spaces of a field, and if so, which fields to trim. See the %dataconnect.spacetrim.values; entity for a list of options.

sqlserver*

Name of the SQL server hosting the Sybase database you want to access. This attribute is only an option if the type attribute equals Sybase.

type

Vendor type of the third-party data source. The choices for this attribute depend on the class type. See the %dataconnection.types; entity for a list of options.

updatechangedfieldsonly

If true, triggers the exchange of data only when an update to a field has been made.

username

User name authorized to access the third-party database.

*These attributes indicate the name of the third-party database to access. The vendor-type determines which attributes are required. The following table illustrates which data source name attributes are required for the specified data connection types:

Defined entities for <dataconnection> element

The %dataconnect.spacetrim.values; entity defines which fields to trim leading and trailing spaces from.

Syntax:

<!ENTITY % dataconnect.spacetrim.values " none | nonkeyfields | allfields ">

The following options specify to trim the leading and trailing spaces from:

allfields

All of the fields.

none

None of the fields.

nonkeyfields

Only the non-key fields.

The %dataconnection.class; entity defines the class options of data sources that you can connect to using Domino.

Syntax:

<!ENTITY % dataconnection.class " rdbms ">

The following option specifies that the data source for the external connections is:

rdbms

A relational database management system.

The %dataconnection.customizedproperties.values; entity defines the customizations you can make that are specific and unique to the data source you are accessing.

Syntax:

<!ENTITY % dataconnection.customizedproperties.values " %db2properties; | %oledbproperties; | %odbcproperties; ">

The following options specify that additional customizations are available for the following data sources (See their entity descriptions for a list of their attributes.):

%db2properties;

%oleproperties;

%odbcproperties;

The %dataconnection.object.types; entity defines the types of objects you can connect to using Domino.

Syntax:

<!ENTITY % dataconnection.object.types " table | view | procedure ">

procedure

Commands with which you create, update, and query a database. This option is not applicable to ODBC data sources.

table

Data table which is a collection of records with fields in a database.

view

Data view.

The %dataconnection.ondatamismatch.values; entity defines how the Domino server should handle data conflicts.

Syntax:

<!ENTITY % dataconnection.ondatamismatch.values " error | precisionloss | datatruncation ">

datatruncation

Specifies that the server should allow data truncation. Data truncation is not performed on key fields. You might want to allow for this in order to enable the extraction of a string, for example, from a field in a database having a greater maximum allowable string length to a Notes field having a smaller maximum allowable length.

error

Specifies that the server should return an error on data conflict.

precisionloss

Specifies that the server should allow precision loss. You might want to allow for this in order to enable the extraction of a number, for example, from a field in a database that records numbers with more extensive precision than a Notes database does.

The %dataconnection.onmissingrecord.values; entity defines how the Domino server should behave when it encounters a missing record.

Syntax:

<!ENTITY % dataconnection.onmissingrecord.values " error | ignore | externalrecord ">

error

Specifies that the server should return an error message when it encounters a missing record in the external data source.

externalrecord

Specifies that a record should be created in the external data source to prevent the data transferal from stopping. Creates a stub in the external data source.

ignore

Specifies that the server should ignore any missing record errors encountered and continue the retrieval.

The %dataconnection.types; entity defines the types of data sources you can connect to using Notes/Domino.

Syntax:

<!ENTITY % dataconnection.types " db2 | oracle | sybase | odbc2 | oracle8 | oledb ">

The %db2properties; entity defines the additional property settings you can make for data from a DB2 database.

Syntax:

<!ENTITY % db2properties " 

">

The %odbcproperties; entity defines the additional property settings you can make for data from an ODBC database.

Syntax:

<!ENTITY % db2properties " 

">

The %oledbproperties; entity defines the additional property settings you can make for data from an OLE database.

Syntax:

<!ENTITY % db2properties " 

">