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.
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.
ODBCConnection (LotusScript)
Represents the ODBC Data Access features for connecting to a data source.
ConnectTo (ODBCConnection - LotusScript)
Connects to a data source.

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.
  - 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.
    - Setting up LS:DO
      Setting up LS:DO requires several steps, in which you install any needed software, register your data sources, and then create your script. Review the following sections as you set up LS:DO for your application:
    - Using LS:DO
      Once you have set up LS:DO and your script, you are ready to access your external databases. With LS:DO, you can:
    - Tips and techniques
      This section presents specialized topics concerned with enhancing your LS:DO application:
    - ODBCConnection (LotusScript)
      Represents the ODBC Data Access features for connecting to a data source.
      - Examples: ODBCConnection class
        This agent declares a new ODBCConnection object and connects to a user-specified data source.
      - AutoCommit (ODBCConnection - LotusScript)
        Read-write. Indicates whether auto-commit mode is in effect.
      - CommitOnDisconnect (ODBCConnection - LotusScript)
        Read-write. Indicates whether pending transactions are committed or rolled back on disconnect.
      - DataSourceName (ODBCConnection - LotusScript)
        Read-only. The ODBC name of the connected data source.
      - GetLSDOMasterRevision (ODBCConnection - LotusScript)
        Read-only. The revision level of the ODBC LSX.
      - SilentMode (ODBCConnection - LotusScript)
        Read-write. Prevents display of a User ID and Password dialog box during program execution.
      - ThreadSafeDriver (ODBCConnection - LotusScript)
        Read-write. Indicates whether the ODBC driver for this connection is thread-safe.
      - CommitTransactions (ODBCConnection - LotusScript)
        Commits changes when transaction mode is in effect. This applies to all transactions pending through the connection, and takes no arguments.
      - ConnectTo (ODBCConnection - LotusScript)
        Connects to a data source.
        Examples: ConnectTo method
        The following form action gets the name of a data source, as well as an optional user name and password, and attempts to connect to the data source.
      - Disconnect (ODBCConnection - LotusScript)
        Disconnects from the data source.
      - GetError (ODBCConnection - LotusScript)
        Returns the latest error code for an ODBC object.
      - GetErrorMessage (ODBCConnection - LotusScript)
        Returns the short error message text associated with an error code.
      - GetExtendedErrorMessage (ODBCConnection - LotusScript)
        Returns the long, descriptive error message text associated with an error code.
      - IsConnected (ODBCConnection - LotusScript)
        Indicates whether the connection object still exists.
      - IsSupported (ODBCConnection - LotusScript)
        Indicates whether an option is supported by the data source.
      - ListDataSources (ODBCConnection - LotusScript)
        Lists all registered data sources as an array.
      - ListFields (ODBCConnection - LotusScript)
        Returns an array of field (column) names in a table.
      - ListProcedures (ODBCConnection - LotusScript)
        Lists the executable procedures at the connected data source.
      - ListTables (ODBCConnection - LotusScript)
        Lists the available tables in a connected data source.
      - RollbackTransactions (ODBCConnection - LotusScript)
        Rolls back changes when transaction mode is in effect. This applies to all uncommitted transactions pending through the connection, and takes no arguments.
    - ODBCQuery (LotusScript)
      Represents the ODBC data access features for defining an SQL statement.
    - ODBCResultSet (LotusScript)
      Represents the ODBC data access features for performing operations on a result set.
- 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.

ConnectTo (ODBCConnection - LotusScript)

Connects to a data source.

Defined in

ODBCConnection

Syntax

status = odbcConnection . ConnectTo( dataSourceName$ [ , userID$ [ , password$ ]] )

Parameters

dataSourceName$

String. The ODBC name of the data source to which you want to connect.

userID$

String. Optional. The name of the user ID.

password$

String. Optional. The password for the user ID.

Return value

True indicates that the connection to the data source was successfully achieved.
False indicates that the connection to the data source failed.

Usage

Use to establish a connection to a data source. The source must already be registered in the ODBC Driver Manager. This method does not automatically register data sources.

Errors

Cannot find named data source (DBstsCANF)

Unable to connect (DBstsCCON)

Unable to get user ID and password (DBstsACCS)

Events

BeforeConnect

AfterConnect

BeforeConnectTo

AfterConnectTo

Example