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 8 LCSession Class
This chapter provides information about LCSession class methods and properties.
LCSession Class Methods Summary
This section lists the methods that are available to both Domino® Enterprise Connection Services (DECS) and IBM® Lotus Enterprise Integrator® (LEI) users.

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.
    - 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.
      - LCSession class overview
        The LCSession class represents the Lotus® Connectors environment of the current script, providing access to the available connectors and Metaconnectors, as well as the current error status. The status property and methods are useful when writing error handling code and reporting errors as text messages.
      - LCSession Class Properties Summary
        All sessions have a set of predefined 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.
      - LCSession Class Methods Summary
        This section lists the methods that are available to both Domino® Enterprise Connection Services (DECS) and IBM® Lotus Enterprise Integrator® (LEI) users.
      - New Method for LCSession
        This is the constructor method for the LCSession object.
      - ClearStatus Method for LCSession
        This method resets or clears the LCSession status after an error.
      - GetStatus Method for LCSession
        This method retrieves the current status value of a session.
      - GetStatusText Method for LCSession
        This method returns the message text corresponding to an LCStatus code.
      - ListConnector Method for LCSession
        This method lists through all valid connectors for a LotusScript® Extensions (LC LSX) installation.
      - ListMetaconnector Method for LCSession
        This method lists all valid metaconnectors for a Lotus® connectors installation. Metaconnectors add an extra layer of functionality between the actual data source and your program, letting you do such things as sort the records as you read them, or automatically meter accesses. Supplied metaconnectors are described in the Lotus Connectors and Connectivity Guide.
      - LookupConnector Method for LCSession
        This method looks up a connector name to determine if it exists and returns information about the connector. Metaconnectors add an extra layer of functionality between the actual data source and your program, letting you do such things as sort the records as you read them, or automatically track accesses. Supplied metaconnectors are described in the Lotus® Connectors and Connectivity Guide.
      - LookupMetaConnector Method for LCSession
        This method looks up a metaconnector name to determine if it exists and returns information about the metaconnector. Metaconnectors add an extra layer of functionality between the actual data source and your program, letting you do such things as sort the records as you read them, or automatically track accesses. Supplied metaconnectors are described in the Lotus® Connectors and Connectivity Guide
      - Sleep Method for LCSession
        This method forces a script execution to sleep for the specified length of time.
    - 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.

LCSession Class Methods Summary

This section lists the methods that are available to both Domino® Enterprise Connection Services (DECS) and IBM® Lotus Enterprise Integrator® (LEI) users.

There are several additional LCSession methods available only to LEI users. See Appendix E for detailed information.


Method	Description
LCSession.ClearStatus	Clear the Session status, putting the Session in a non-error state.
LCSession.GetStatus	Obtain the current Session status.
LCSession.GetStatusText	Obtain the error text string corresponding to a status code.
LCSession.ListConnector	List through all installed connectors available for LotusScript® Extension for Lotus® connectors.
LCSession.ListMetaConnector	List through all installed metaconnectors available for a LotusScript® Extension for Lotus® connectors installation.
LCSession.LookupConnector	Determines if a specified connector is available.
LCSession.LookupMetaConnector	Determines if a specified metaconnector is available.
LCSession.Sleep	Suspends script execution for a specified period of time.