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 6 LCFieldlist Class
This chapter provides information about the LCFieldlist class methods and properties.
LCFieldlist class overview
The LCFieldlist class represents metadata (the description of data from a data source) for a record and may reference data, in the form of LCFields, for one or more record values. A fieldlist is a list of fields and field names with a represented order. Fields within a fieldlist can be added, modified, retrieved, or listed in multiple ways. The fields, field names, and order are separate entities and only have relation within an individual fieldlist.

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.
    - 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.
      - LCFieldlist class overview
        The LCFieldlist class represents metadata (the description of data from a data source) for a record and may reference data, in the form of LCFields, for one or more record values. A fieldlist is a list of fields and field names with a represented order. Fields within a fieldlist can be added, modified, retrieved, or listed in multiple ways. The fields, field names, and order are separate entities and only have relation within an individual fieldlist.
      - Syntax for HEI Scripted Activities - 2
        When writing LotusScript® Extensions (LC LSX) scripts for HCL Enterprise Integrator (HEI) Scripted activities, you must specify Dim LCSession as a named session (this becomes the default log document name). LCConnections must also be dimensioned as existing, named HEI connection documents.
      - Accessing Field Data
        Field data within an LCFieldlist object may be accessed as a property by name. The data type of the property depends on the data type of the field. The property is an array of LotusScript® data types, as shown in the table as follows. For example, if a fieldlist has a field named OrderID, its first value may be obtained with the following script:
      - Fieldlist Merging and Mapping
        Fieldlist merging with LCFieldlistMerge and LCFieldlistMergeVirtual support field mapping. To perform mapping, two fieldlists are provided, one as the name source and the other as the field/data source. Depending on merge options, a mapping is produced between the names of the name source and the fields of the data source, and a third fieldlist is produced which references parts of the original fieldlists. When using virtual fields and LCFieldlistMergeVirtual, fields in the data fieldlist which match the supplied virtual code are excluded from mapping and are added to a separate new virtual fieldlist.
      - LCFieldlist Class Methods Summary
        The LCFieldlist class method is summarized here.
      - New Method for LCFieldlist
        This is the constructor for LCFieldlist.
      - Append Method for LCFieldlist
        This method creates a new field and appends it to an existing fieldlist.
      - Copy Method for LCFieldlist
        This method creates a duplicate copy of an LCFieldlist and all its data. Every field in the LCFieldlist is also duplicated, so you don't end up with two fieldlists that both refer to the same LCField objects.
      - CopyField Method for LCFieldlist
        This method copies an existing field and inserts a copy of the field within a fieldlist at a specified position.
      - CopyRef Method for LCFieldlist
        This method creates a new fieldlist object instance as a partial copy of another fieldlist. The fields in the original fieldlist are not copied, but are referenced.
      - GetField Method for LCFieldlist
        This method gets a field reference from a specified position in a fieldlist and places its value into a variable.
      - GetName Method for LCFieldlist
        This method obtains a copy of the name of a field within a fieldlist.
      - IncludeField Method for LCFieldlist
        This method includes an existing individual field in a fieldlist.
      - Insert Method for LCFieldlist
        This method inserts a new field into an existing fieldlist at a specified index position.
      - List Method for LCFieldlist
        This method retrieves information about one field in the fieldlist. By calling it repeatedly, you can iterate through the fields in the list.
      - Lookup Method for LCFieldlist
        This method locates a field from a fieldlist based on field name.
      - Map Method for LCFieldlist
        This method copies field references from one field list, into another field list. It's similar to the CopyRef method, except that you specify the names of fields you want to create new references to.
      - MapName Method for LCFieldlist
        This method maps fields with different names. Use this method for field mapping operations when the fieldnames are different in the source and target. This allows you to change field order and also exclude fields.
      - Merge Method for LCFieldlist
        This method merges two fieldlists, copying the names from one and taking the field objects from another to fill in a third mapping fieldlist. Use this method for field mapping operations when you either have a name fieldlist already built and/or you need to use fieldlist flags.
      - MergeVirtual Method for LCFieldlist
        This method merges two fieldlists to create new mapping and virtual fieldlists.
      - Remove Method for LCFieldlist
        This method removes an existing field from a fieldlist. This does not remove a column from associated metadata. See the earlier section entitled "Fieldlist Merging and Mapping" for related information about how removing or adding columns to a result set affects Fetch, Insert and other operational methods.
      - Replace Method for LCFieldlist
        This method creates a new LCField object and puts it into the fieldlist in place of an existing field. The data from the old field is not copied into the new field.
      - SetName Method for LCFieldlist
        This method changes the name of a field within a fieldlist.
    - 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.

LCFieldlist class overview

The LCFieldlist class represents metadata (the description of data from a data source) for a record and may reference data, in the form of LCFields, for one or more record values. A fieldlist is a list of fields and field names with a represented order. Fields within a fieldlist can be added, modified, retrieved, or listed in multiple ways. The fields, field names, and order are separate entities and only have relation within an individual fieldlist.

Many situations exist where the names or order must be changed to accommodate different connections, but the data needs to remain constant. In these situations, more than one fieldlist can be created, each referenced by the same fields using the Map, MapName, or Merge methods.

An LCFieldlist can be dimensioned to contain one row of fields (the default) or multiple rows, allowing array operations that fetch or update multiple entries in a result set in a single operation. If your external system data source supports array operations, this can substantially enhance performance. If it does not support array operations, you can still do multiple-row fetches and updates, but you get no performance gain from doing so.

In addition to regular LCField items, an LCFieldList can also contain one or more other LCFieldlists nested inside. This is done by using an LCField item containing a data value of type LCFIELDLIST. Refer to the LCField.SetFieldList and GetFieldList methods for examples. This is useful in situations where a one-to-many relationship exists between data in different tables. For example, suppose you have an order entry system with an order number and multiple line items in the order. You can create an LCFieldlist to work with these tables that contains the order number (a stream field) and a sublist that contains all the line items for that order.

This ability is just a convenience for maintaining data in memory; it's not currently possible to use these nested lists to read or update structured information in a single operation.