Home
HCL Domino Designer Basic User Guide and Reference
This guide provides information on using HCL Domino Designer and programming language reference information.
Connectors
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 Connectors
LotusScript® Extensions for Connectors (LC LSX) enhances the power of Notes® by extending its scripting to data outside of Notes through the use of 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 Connectors (LC LSX) and explains the organization of this manual.
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.

HCL Domino Designer Basic User Guide and Reference
This guide provides information on using HCL Domino Designer and programming language reference information.
- What's new in HCL Domino Designer 12?
  The following features are new for developers in HCL Domino® Designer 12.
- 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.
- Application Design
  Welcome to the Application Design section of Domino® Designer Help.
- Application Management
  Welcome to the Application Management section of Domino® Designer Help.
- Domino® Query Language
  Domino® Query Language (DQL) is a facility running on a Domino server that provides a terse, shorthand syntax for finding documents. It supports a wide variety and complexity of search terms. It leverages existing design elements, avoiding the need to write detailed code to access them. DQL consolidates all methods in Domino for searching document contents.
- 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.
- Connectors
  Connectors provide native access to a wide variety of DBMS products, ODBC, the platform File system, Enterprise Resource Planning systems, and Transaction Processing systems.
  - Connectors and Connectivity Guide
  - LSX for Connectors
    LotusScript® Extensions for Connectors (LC LSX) enhances the power of Notes® by extending its scripting to data outside of Notes through the use of 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 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.
      - Overview of the LotusScript® Extension for Connectors
        The 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 Connectors (LC LSX) extends these connectors to LotusScript.
      - Connectivity Software Requirements
        Access to supported 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 Connectors (LC LSX) using the following statement in your script:
      - Terms and Concepts
        Key terms are defined as follows.
      - LC Classes
        The 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 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 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 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 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 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 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 Connector LotusScript® Extensions (LC LSX) code performance. These techniques will be described.
      - Initialization File Variables
        HCL Enterprise Integrator (HEI) 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 HEI installation. You can use the notes.ini file to change these settings for DECS and HEI.
    - 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 Connector LotusScript® Extensions (LC LSX).
    - Appendix E Additional Scripting Capability for HEI
      This appendix provides information about additional methods and properties provided for HCL Enterprise Integrator (HEI) with the LCSession class that expand on the Connector LotusScript® Extensions (LC LSX).
  - Accessing external databases through LS:DO
    Developers are advised not to use LS:DO. Developers should use the 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.

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.

Dim Calendar as New LCDatetime (1998, 8, 7)
     'In this case hour, minute, second, and so on 
     'have been omitted at the end

When optional parameters that occur in the middle are omitted, the commas must remain.

Call session.GetStatus (ErrorText, , DBError)