Home
HCL Domino Designer 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.
Connectors and Connectivity Guide
Chapter 12 Metaconnectors for HEI
This chapter provides an introduction to HEI Metaconnectors and contains information for creating and using the different types of Metaconnectors.
Order Metaconnector Properties
The Order metaconnector properties are described as follows.

HCL Domino Designer User Guide and Reference
This guide provides information on using HCL Domino Designer and programming language reference information.
- What's new in Domino Designer 14?
  The following features are new for developers in HCL Domino® Designer 14.
- What's new in Nomad Designer?
  HCL Nomad for web browsers v1.0.10 introduces the capability to design Notes databases. For more information, see HCL Nomad for web browsers User Documentation, Nomad web Designer.
- 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
    - Chapter 1 DCTEST and CONTEST
      This chapter provides information about DCTEST and CONTEST. These programs test system and application connectivity to external data sources.
    - Chapter 2 Connectivity
      This chapter provides instructions and information for setting up and testing connectivity to the following database systems:
    - Chapter 3 Introduction to Connectors
      This chapter provides introductory information about each of the supplied HCL Connectors.
    - Chapter 4 Connector for Notes®
      This chapter provides information about the Connector for Notes®, including descriptions of the fields in the connection document.
    - Chapter 5 Connector for DB2®
      This chapter provides information about the Connector for DB2®, including descriptions of the fields in the connection document.
    - Chapter 6 Connector for File System
      This chapter provides information about the Connector for File System, including descriptions of the fields in the connection document.
    - Chapter 7 Connector for ODBC
      This chapter provides information about the Connector for ODBC, including descriptions of the fields in the connection document.
    - Chapter 8 Connector for Oracle
      This chapter provides information about the Connector for Oracle, including descriptions of the fields in the connection document.
    - Chapter 9 Connector for OLE DB
      This chapter provides information about the Connector for OLE DB, including descriptions of the fields in the connection document.
    - Chapter 10 Connector for Sybase
      This chapter provides information about the Connector for Sybase, including descriptions of the fields in the connection document.
    - Chapter 11 Connector for Text
      This chapter provides information about the Connector for Text, including descriptions of the fields in the connection document.
    - Chapter 12 Metaconnectors for HEI
      This chapter provides an introduction to HEI Metaconnectors and contains information for creating and using the different types of Metaconnectors.
      - Introduction to Metaconnectors
        A metaconnector provides preprocessing operations on connection data prior to transfer within a defined activity form.
      - Collapse/Expand Metaconnector
        Use a Collapse/Expand Metaconnector to group or ungroup multiple records, with a common key value, into a single record with multivalue fields. The Collapse/Expand Metaconnector wraps another Connector or Metaconnector and collapses records on Fetch operations. It then expands them on write operations according to user-defined criteria. The Collapse/Expand Metaconnector has no effect on metadata operations; it simply passes through Create, Drop, and Action statements.
      - Collapse/Expand Metaconnection Document
        To create a new Collapse/Expand metaconnection document in HCL Enterprise Integrator (HEI) do the following.
      - Collapse/Expand Metaconnector Properties
        The Collapse/Expand Metaconnector Properties are described as follows.
      - Using the Collapse/Expand Metaconnector with a Replication Activity
        When using a Collapse/Expand Metaconnection with a Replication activity, the key fields and the grouping keys need to be the same and in the same order in the Metaconnection definition as in the Replication activity definition to work properly.
      - Collapse/Expand Metaconnector Data Types
        Since the Collapse/Expand Metaconnector has no external database, it always operates with HCL Enterprise Integrator (HEI) or Domino® Enterprise Connection Services (DECS) data types. For key fields, all HEI or DECS datatypes convert within their class (number, datetime, or stream); in addition, precision and overflow checking are performed as needed. For non-key fields, on Fetch, external single-value data types map to internal multivalue data types, and vice-versa on output. Therefore, an external number class type maps to a number list; a datetime to a datetime list; and text to a text list. Note that binary data types (unformatted BLOB or formatted binary types such as composite) cannot be mapped to multivalue types.
      - Meter Metaconnector
        Use the Meter metaconnector to track data flowing to and from another connection or metaconnection. The Meter metaconnector has no effect on any operations; it simply monitors the data transferred. Results from the metering are logged to a file. The specific information logged is configurable through use of the Meter metaconnection document.
      - Meter Metaconnection Document
        To create a new Meter metaconnection document in HCL Enterprise Integrator® (HEI), do the following.
      - Meter Metaconnector Properties
        The Meter Metaconnector Properties are described.
      - Supported characteristics of the Meter metaconnector
        The following list captures supported characteristics of the Meter metaconnector.
      - Order Metaconnector
        Use an Order metaconnector to obtain consistent ordering of result sets from other Connections. The Order metaconnector wraps another connector and orders the result set based on user-defined criteria. Order options are available. The Order Metaconnector has no effect on data operations, other than producing a result set or fetching - it simply passes through Insert, Update, Remove, Create, Drop, and Action statements.
      - Order Metaconnection Document
        To create a new Order metaconnection document in HCL Enterprise Integrator (HEI), do the following.
      - Order Metaconnector Properties
        The Order metaconnector properties are described as follows.
      - Using the Order Metaconnector with a Replication Activity
        Replication depends on an ascending sort to operate properly. Do not use the Sort Descending option of this metaconnector when performing Replication activities.
      - Order Metaconnector Data Types
        Since the Order Metaconnector has no external database, it always operates with HCL Enterprise Integrator (HEI) data types. All HEI data types convert within their class (number, datetime, or stream). Precision and overflow checking are performed as needed.
      - Trace Metaconnector
        The Trace Metaconnector allows you to trace events associated with a specified sub connection. You may specify options including where to capture data (either to the HCL Enterprise Integrator® (HEI) console or to a user-specified file name) and whether or not to include a timestamp with each trace log entry.
      - Trace Metaconnection Document
        To create a new Trace metaconnection document in HCL Enterprise Integrator (HEI) do the following.
      - Trace Metaconnector Properties
        The Trace Metaconnector options and their corresponding LotusScript® Extensions (LC LSX) properties are described as follows.
      - Example Trace Metaconnetor LC LSX Code
        Example Trace Metaconnector LotusScript® Extensions (LC LSX) code is shown as follows.
  - 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.
- 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.

Order Metaconnector Properties

The Order metaconnector properties are described as follows.


Field	Description
Name	Specifies a unique name that identifies this connection. The maximum number of characters allowed is 255.
Connection to Use	Specifies the name of the underlying connection which is providing the data.
Metadata Name	Specifies the name of the selected table. When you select the connection to use, the metadata name appears in this field.
Owner	Specifies the owner name of the selected metadata.
Sort Character Set (optional)	Specifies the optional character set to force text data into. By default, the underlying connection's character set is used. To provide a character set, use the corresponding constant suffix. Character sets are listed in the Connector LotusScript® Extensions Guide. For example, for character set codepage 932, represented by the HCL Enterprise Integrator (HEI) constant LCSTREAMFMT_CP932, enter "CP932" here.
Sorting Fields	Contains a list of fields in which to sort data. For activities where ordering is specified, such as Replication, these selections are overridden and therefore ignored in the connection document. For other activities, this is a place to provide the ordering (which was not available before).
Sorting Options	Specifies whether to sort in ascending (default) or descending order. HCL Enterprise Integrator (HEI) replication depends on an ascending sorting to operate properly. Do not use the Sort Descending option with a Replication activity.
Order	Specifies how text is to be sorted. The choices are listed as follows. Sort Text as Binary Sort Text with Case Sensitivity Sort Text without Case Sensitivity