Home
IBM Domino Designer Basic User Guide and Reference
Basic product usage information and programming language reference information.
Lotus® Connectors
Lotus® Connectors provide native access to a wide variety of DBMS products, ODBC, the platform File system, Enterprise Resource Planning systems, and Transaction Processing systems.
LSX for Lotus® Connectors
LotusScrip Extensions for Lotus® Connectors (LC LSX) enhances the power of Notes® by extending its scripting to data outside of Notes through the use of Lotus Connectors. The programming model is independent of the individual connector. This eliminates the need to learn each individual system, while at the same time allowing experienced users to access the individual features of a specific system.
Chapter 2 LCConnection Class
This chapter provides information about the LCConnection class methods and properties.
Common Connector Properties
The following is a list of predefined properties common to all Lotus® connectors. Use these predefined properties with the LCConnection.GetProperty and LCConnection.SetProperty methods. See "Miscellaneous" under the "LCConnection Class Methods Summary" section as well as the entry for each method.

IBM Domino Designer Basic User Guide and Reference
Basic product usage information and programming language reference information.
- Application Design
  Welcome to the Application Design section of Domino® Designer Help.
- Domino® Designer templates
  The templates described in the following table are available with Domino® Designer and are specifically intended for use by application developers.
- Importing to and exporting from views
- Developing applications using MAPI
  Domino® Designer Release 6 and later supports the messaging application program interface (MAPI), which allows mail integration between Domino and a MAPI-compliant messaging application, such as Microsoft™ Outlook, Microsoft Office applications, or user-written C++ programs.
- Features to avoid using in Web applications
  Developers creating applications specifically for the Web, or for the dual purpose of serving Notes® and Web clients, should review the following tables for features that are not supported on the Web.
- URL commands for Web applications
  You have a variety of options for programming a Web site. You can directly manipulate objects such as documents or views in an application using Domino® URL commands. Adding Domino URL commands as HTML in forms gives users shortcuts for navigating databases and performing other tasks quickly.
- Application Management
  Welcome to the Application Management section of Domino® Designer Help.
- Composite Applications - Design and Management
  Composite applications are a key element in a service-oriented architecture (SOA) and contextual collaboration strategy. The ability to create and edit composite applications lets you easily integrate different types of components and technologies.
- DB2® Access views
  Domino® Designer includes two types of design elements to assist you in managing data contained in DB2® enabled Notes® databases:
- Programming Overview and User Interface
  This section contains general guidelines and examples that show where to use Java, LotusScript, and the formula language.
- Formula Language
  This section documents the formula language.
- LotusScript® Language
  Welcome to the LotusScript® Language section of Domino® Designer Help.
- LotusScript/COM/OLE Classes
- Java/CORBA Classes
  This section documents the Java/CORBA classes.
- Lotus® Connectors
  Lotus® Connectors provide native access to a wide variety of DBMS products, ODBC, the platform File system, Enterprise Resource Planning systems, and Transaction Processing systems.
  - Lotus® Connectors and Connectivity Guide
  - LSX for Lotus® Connectors
    LotusScrip Extensions for Lotus® Connectors (LC LSX) enhances the power of Notes® by extending its scripting to data outside of Notes through the use of Lotus Connectors. The programming model is independent of the individual connector. This eliminates the need to learn each individual system, while at the same time allowing experienced users to access the individual features of a specific system.
    - Chapter 1 Introduction
      This chapter provides an introduction to the LotusScript® Extension for Lotus® Connectors (LC LSX) and explains the organization of this manual.
    - Chapter 2 LCConnection Class
      This chapter provides information about the LCConnection class methods and properties.
      - LCConnection class overview
        The LCConnection class represents an instance of an individual Lotus® connector. One connection object should exist for each individual data connection through a connector. This is true when the connections are to the same Lotus connector as well as to different connectors. For example, transferring data from one DB2® table to another table in Oracle is best accomplished by creating two LCConnection objects, one for DB2 and one for Oracle, and fetching data from one and inserting it into the other.
      - Syntax for LEI Scripted Activities - 4
        When writing IBM® Lotus® Connector LotusScript® Extensions (LC LSX) scripts for IBM Lotus Enterprise Integrator® (LEI) Scripted activities, you must specify Dim LCSession as a named session (this becomes the default log document name). LCConnections must also be dimensioned as existing, named LEI connection documents.
      - LCConnection Properties
        All Connections have a set of properties with values that can be assigned and retrieved. All properties are represented by both an integer value (called a property token) and a name. Some property tokens are valid for all connectors, while others are connector-specific.
      - Common Connector Properties
        The following is a list of predefined properties common to all Lotus® connectors. Use these predefined properties with the LCConnection.GetProperty and LCConnection.SetProperty methods. See "Miscellaneous" under the "LCConnection Class Methods Summary" section as well as the entry for each method.
      - LCConnection Class Methods Summary
        The LCConnection class methods are summarized in the following sections.
      - New Method for LCConnection
        This is the constructor for objects of class LCConnection.
      - Action Method for LCConnection
        This method performs an action as defined by the actionType parameter. Not all available actions may be supported. If you use an unsupported action type, this method will generate the error LCFAIL_UNAVAILABLE.
      - Call Method for LCConnection
        This method is used to call a stored procedure and potentially produce a result set.
      - Catalog Method for LCConnection
        This method returns information about the data sources, metadata objects, stored procedures and fields available through a connection. Some connectors do not support all object types.
      - Connect Method for LCConnection
        This method establishes a connection to a connector. Multiple connections may be independently established to a single connector.
      - Copy Method for LCConnection
        This method makes a copy of an existing connection, including all property values. Note that while all properties are copied, the current state of the connection and result set are not copied.
      - Create Method for LCConnection
        This method creates a metadata object. Each connector supports only certain object types. Refer to the documentation for the specific connector to determine the object types it supports.
      - Disconnect Method for LCConnection
        This method disconnects from a data source. Any existing result set is cleared. For example, this method terminates the connection to DB2® established by the Connect method. Only the connection and state are terminated, in order that reconnection may occur.
      - Drop Method for LCConnection
        This method deletes (drops) a specified metadata object -- database, table, index, or view. The object isn't just removed from your local memory; it's irretrievably destroyed. Use this method with caution.
      - Execute Method for LCConnection
        This method executes a statement in connector-specific syntax, for example, an SQL statement for a relational database connector. For example, this method executes a DB2® SQL statement for the purposes of producing a result set.
      - Fetch Method for LCConnection
        This method obtains the next group of records from a result set. This method requires an active result set in the connection.
      - GetProperty Method for LCConnection
        This method retrieves a copy of the current value for a connection property. Note that use of dynamic properties is more efficient. For example, this method returns the value of a Lotus® Connector for DB2® property, specified by the PropertyToken parameter, in the DestField parameter. For DB2, all properties are supported except Password.
      - GetProperty<Type> Methods
        This method returns a connector property value as a specific data type. Supported data types include Boolean, Currency, Datetime, Float, Int, Numeric, and Text.
      - Insert Method for LCConnection
        This method inserts a specified number of records into the connection metadata. For example, this method inserts one or more records into the defined METADATA object in DB2®.
      - ListProperty Method for LCConnection
        This method obtains the first or next property information for properties supported by this connector.
      - LookupProperty Method for LCConnection
        This method determines if a connector supports a specified property.
      - Remove Method for LCConnection
        This method performs either a writeback result set remove or a keyed remove of records in the external system.
      - Select Method for LCConnection
        This method produces a result set from the current METADATA property and other properties.
      - SetProperty Method for LCConnection
        This method assigns the value for a connection property.
      - SetProperty<Type> methods for LCConnection
        These methods assign a Connection property value as a specific data type. Data types supported include: Boolean, Currency, Datetime, Float, Int, Numeric, and Text.
      - Update Method for LCConnection
        This method updates selected records in the connection metadata.
    - Chapter 3 LCCurrency Class
      This chapter provides information about the LCCurrency class methods and properties.
    - Chapter 4 LCDatetime Class
      This chapter provides information about the LCDatetime class methods and properties.
    - Chapter 5 LCField Class
      This chapter provides information about the LCField class methods and properties.
    - Chapter 6 LCFieldlist Class
      This chapter provides information about the LCFieldlist class methods and properties.
    - Chapter 7 LCNumeric Class
      This chapter provides information about the LCNumeric class methods and properties.
    - Chapter 8 LCSession Class
      This chapter provides information about LCSession class methods and properties.
    - Chapter 9 LCStream Class
      This chapter provides information about the LCStream class methods and properties.
    - Appendix A Error Messages
      This appendix provides information about error messages.
    - Appendix B Connector Property Tokens
      This appendix provides information about the property tokens used in the LotusScript® Extensions (LC LSX).
    - Appendix C Connector Properties
      This chapter provides information about connector properties. These properties are used when creating connections using the Lotus® Connector LotusScript® Extensions.
    - Appendix D Character Sets
      This appendix provides information about character sets, including character set translation, character sort order, and a list of the character sets supported by the Lotus® Connector LotusScript® Extensions (LC LSX).
    - Appendix E Additional Scripting Capability for LEI
      This appendix provides information about additional methods and properties provided for IBM® Lotus Enterprise Integrator® (LEI) with the LCSession class that expand on the IBM Lotus® Connector LotusScript® Extensions (LC LSX).
  - Accessing external databases through LS:DO
    LS:DO has been in maintenance mode since R5. Developers are advised not to use it. Developers should use the Lotus® Connector LSX for (LCLSX) when accessing external data sources.
- Javadoc™ for Domino® Designer related APIs
  As part of providing additional Java™ reference documentation, Domino® Designer ships with a help plugin that contains Javadoc™ for additional Domino Designer related APIs.
- Accessibility and keyboard shortcuts
  Accessibility features assist users who have a disability, such as restricted mobility or limited vision, to use information technology content successfully.

Common Connector Properties

The following is a list of predefined properties common to all Lotus® connectors. Use these predefined properties with the LCConnection.GetProperty and LCConnection.SetProperty methods. See "Miscellaneous" under the "LCConnection Class Methods Summary" section as well as the entry for each method.


Property	Name	Description
LCTOKEN_NAME	"Name"	String. Connector name. (Read only.) This is the same as the library name given in the New method.
LCTOKEN_CONNECTOR_CODE	"ConnectorCode"	Long. Connector Virtual Code. (Read only.)
LCTOKEN_CONNECTION_CODE	"ConnectionCode"	Long. Connection Virtual Code. (Read only.)
LCTOKEN_EVENT_ERROR	"EventError"	Long. Error code (LCFAIL_XXX constant) to treat as an event. When this error is generated, it is downgraded to an informational event. Set to LCSUCCESS to clear this property.
LCTOKEN_TEXT_FORMAT	" TextFormat"	Long. Stream format constant for text data passed between the connector and the external system. This property is generally read-only.
LCTOKEN_CHARACTER_SET	" CharacterSet"	String. Lotus® connector character set indicator. (Read only.)
LCTOKEN_IGNORE_ERROR	"IgnoreError"	Long. Lotus® connector status code to ignore.
LCTOKEN_CONNECTOR_NAME	"ConnectorName"	String. Use this property to specify which connector a metaconnector is filtering. This corresponds to the "Connection to use" field in the Metaconnection document in the LEI Administrator.
LCTOKEN_IS_CONNECTED	"IsConnected"	Boolean. TRUE following a successful Connect call, until Disconnect is called. FALSE otherwise.

Properties of a connection may also be accessed by name, for example, the following line of script sets the value of database property for a Lotus® Connector for DB2® to "HR."

Connection.Database = "HR"

Note: Connector-specific properties are listed in an appendix of this manual.