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.
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).
LogTextEx Method for LCSession
This method adds a new external extended entry to the log for this activity.

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 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.
    - 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).
      - Expanded LCSession Functionality
        HCL Enterprise Integrator (HEI) expands the LCSession Class functionality with properties not available for non-HEI users. The LCSession class also provides additional methods to support activity-level properties and logging. The additional features of the Connector classes for HEI are only available when used in conjunction with HEI and the HEI Administrator.
      - Additional Scripting for HEI
        There are additional properties and methods provided for HCL Enterprise Integrator (HEI) with the LCSession class that expand on the Connector LotusScript® Extensions (LC LSX).
      - AddProperty Method for LCSession
        This method creates a new property and assigns it a property token.
      - GetProperty Method for LCSession
        This method obtains a copy of the current value for an activity property.
      - GetProperty<Type> Method for LCSession
        The GetProperty<Type> methods return a session property value as a specific data type. Supported data types are Boolean, Currency, Datetime, Float, Int, Numeric, and Text.
      - ListProperty Method for LCSession
        This method lets you retrieve information about each of the properties supported by the Session. Information about one property is returned with each call to ListProperty.
      - LookupProperty Method for LCSession
        This method determines if the specified property has been defined in the activity.
      - Log Method for LCSession
        This method adds a new entry to the log for this activity.
      - LogEx Method for LCSession
        This method adds a new extended entry to the log for this activity. The values supplied are a status code, such as you would supply to the Log method, plus various additional parameters that supply additional information about the particular error code being returned.
      - LogText Method for LCSession
        This method adds a new external entry to the log for this activity.
      - LogTextEx Method for LCSession
        This method adds a new external extended entry to the log for this activity.
      - RunActivity Method for LCSession
        This method causes one or more HEI activities to be executed.
      - SetProperty Method for LCSession
        This method assigns the current value for an activity property.
      - SetProperty<Type> Method for LCSession
        The SetProperty<Type> methods assign a property value as a specific data type. Supported data types include Boolean, Currency, Datetime, Float, Int, Numeric, and Text.
  - 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.

LogTextEx Method for LCSession

This method adds a new external extended entry to the log for this activity.

This Log method logs an external extended error or event; use LogText for external basic logs and Log or LogEx for HCL Enterprise Integrator (HEI) errors. When logging an error, the activity status is set, placing the activity into an error state. A message is composed from the external text, code, and additional parameters, and is added to any Log entry for this activity.

Defined In

LCSession Class

Syntax

lcSession. LogTextEx (logFlags, text, externalCode, int1, int2, int3, text1, text2, text3)

Parameters


Parameter	Description
logFlags	Long. Flags which affect his long entry. LCLOGSTREAMF_EVENT Log a non-error event.
text	String. External log text. See Usage.
externalCode	Long. External log code.
int1	Long. Optional extended parameters. See Usage
int2	Long. Optional extended parameters. See Usage
int3	Long. Optional extended parameters. See Usage.
text1	String. Optional extended parameters. See Usage.
text2	String. Optional extended parameters. See Usage.
text3	String. Optional extended parameters. See Usage.

Usage

The text in text for extended logs contains parameter substitution markers which indicate placement and formatting of extended parameters. These substitution markers are of the format "[[Lcxx]]", where "xx" can be any of the following values:

In Integer value, from parameter Int<n>

Tn Type constant LCTYPE_XXX, from parameter Int<n>

Pn Property token, from parameter Int<n>

On Object constant LCOBJECT_XXX, from parameter Int<n>

Sn Stream text, from parameter text<n>

X Stop indicator if all extended parameters are zero/null/empty

X( Left bound to remove if next parameter is zero/null/empty

X) Right bound to remove if next parameter is zero/null/empty

The method of variable substitution allows for relatively complex multiple-parameter log text, as well as grammar variations between languages. The following examples are the actual HEI resources for three extended status values to demonstrate how this formatting is used:


Value	Description
LCFAIL_DUPLICATE	"Duplicate object[[LCX]] '[[LCS1]]'".
LCFAIL_INVALID_METADATA	"Metadata object [[LCX(]]'[[LCS1]]' [[LCX)]]does not exist".
LCFAIL_TYPE_MISMATCH	"Type mismatch[[LCX(]] for field '[[LCS1]]'[[LCX)]][[LCX(]]; HEI: [[LCT1]][[LCX)]][[LCX(]], Database: [[LCT2]][[LCX)]]"