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 1 Introduction
This chapter provides an introduction to the LotusScript® Extension for Lotus® Connectors (LC LSX) and explains the organization of this manual.
Connectivity Software Requirements
Access to supported Lotus® connectors may require software to be installed on the Domino® server or the Notes® client from which the LC LSX scripts are run.

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.
      - Organization of This Manual
        The following table describes the organization of this documentation and the information contained in each section.
      - Related Documentation
        This section lists documentation that you may find useful as you learn about and use the various Connectors.
      - Contact and Support Information
        The IBM® developerWorks® site contains a variety of useful information and links:
      - Overview of the LotusScript® Extension for Lotus® Connectors
        The Lotus® Connectors provide native access to a wide variety of database management system (DBMS) products, ODBC, the platform File system, Enterprise Resource Planning systems, and Transaction Processing systems. The LotusScript® Extension for Lotus Connectors (LC LSX) extends these connectors to LotusScript.
      - Connectivity Software Requirements
        Access to supported Lotus® connectors may require software to be installed on the Domino® server or the Notes® client from which the LC LSX scripts are run.
      - Loading and Registering the LC LSX
        You must load the LotusScript® Extensions for Lotus® Connectors (LC LSX) using the following statement in your script:
      - Terms and Concepts
        Key terms are defined as follows.
      - LC Classes
        The Lotus® connectors provides external data and system access to the LotusScript® environment. The LSX classes consist of LCConnection, LCFieldlist and LCField, and four advanced data types, LCStream, LCNumeric, LCCurrency, and LCDatetime. In addition to these seven classes, there is also an LCSession class. Each of these classes and their primary usage is described as follows.
      - Working with the LC LSX
        A typical use of the Lotus® connectors is to gather, create, or modify data in an external system. For example, a Notes® application has a number of data fields on a form. Once the user input is complete, a button activates the script to take the form data and establish a connection to Oracle, locating corresponding information from one or more tables and updating the Notes form. The script is responsible for the following tasks:
      - Connection Pooling
        Connection pooling is part of the common LC API. The Lotus® Connector LotusScript® Extesnions (LSX) provides an end-user interface to the pooling code. The functionality is switched off by default, this minimizes any potential adverse behavior connection pooling might introduce to existing code.
      - LotusScript® and Notes®
        Use of the Lotus® Connectors LotusScript® Extensions (LC LSX) is limited to the Notes® environment and Notes applications. The connectors only have context within the Domino® server and Notes client.
      - Security and Access
        Agents or other LotusScript® code that uses the Notes® connector or File connector must be signed with a Notes ID that has permission to run unrestricted agents. This also applies to any script libraries used by such code. Specifically, connections through these connectors will be blocked with an error unless the signing Notes ID has this permission.
      - LC LSX Data Types
        Standard and advanced Lotus® Connector LotusScript® Extensions (LC LSX) data types are described as follows.
      - Arrays and Indexes
        The default for array indexes in LotusScript® is 0 based. For example, elements of an array are specified as Elem(0), Elem(1), Elem(2), etc. The "Option Base n" LotusScript option lets you make the default lower bound of an unspecified array something other than 0. The Lotus® Connector LotusScript Extensions (LC LSX) do not support this syntax. It is recommended, for consistency, that within scripts which use an LC LSX, such as the Lotus connectors, this option not be used.
      - Working with Multiple Rows of Data
        The Fetch, Insert, Update, Remove methods of a connection use a RecordCount parameter and may operate on more than a single row at a time. However, the LCFiedllist parameter must have been created to hold more than one record for this to work. You may operate on fewer records than the Fieldlist was created with, but not more.
      - Optional Parameters
        Some methods have optional parameters. The LotusScript® keyword "Nothing" is used for output parameters that the user is not interested in receiving. If one or more optional parameters are at the end of a call, they may simply be ignored as in the case of a datetime. For example, a datetime with only the date portion provided is created using the following statement.
      - Performance
        Certain techniques can be used to increase Lotus® Connector LotusScript® Extensions (LC LSX) code performance. These techniques will be described.
      - Initialization File Variables
        IBM® Lotus Enterprise Integrator® (LEI) and Domino® Enterprise Connection Services (DECS) set and use certain environment variable settings in the notes.ini file. Some of these variables are set based on choices you make during the Domino or LEI installation. You can use the notes.ini file to change these settings for DECS and LEI.
    - Chapter 2 LCConnection Class
      This chapter provides information about the LCConnection class methods and properties.
    - 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.

Connectivity Software Requirements

Access to supported Lotus® connectors may require software to be installed on the Domino® server or the Notes® client from which the LC LSX scripts are run.

See the Lotus® Connectors and Connectivity Guide for information about software that may be required to access a particular data source.