Connection Documents

A connection document enables you to define connections to external data sources. connection documents contain access information for specific databases and users. When you create an activity, you make connection choices from the existing set of defined connections.

The information required in a connection document may be different for different database products, so while the connection documents provide standard connection name fields, there are sections and fields specific to the external system. Refer to the specific connector chapters in this manual for information about the type of connection you are creating. If you are using a premium connector, refer to the documentation provided with the connector.

The Lotus® connectors use a series of properties. When defining a connection to HCL Enterprise Integrator (HEI) or Domino® Enterprise Connection Services (DECS), values for these properties are specified in a connection document. When using a Lotus® Connector with LSX classes, values for these properties are specified by setting properties of the LCConnection class.

Most connection document fields are browseable, enabling easy point and click access.

Note: Although you can edit browseable fields, unpredictable results can occur when using a combination of browsing and manual field editing. If you choose to create the activity using the "browsing" feature, use this feature throughout the document. If manual entry is preferred, manually type throughout the document.

For more information about the LCConnection class properties, see the Lotus® Connector LotusScript® Extensions Guide.

Note: In order to connect to a supported data source, you must have the required connectivity software for that data source installed on your server. Before attempting to create a connection document, you should verify that all of your external system software is installed and current with all available maintenance releases and fix packs.
Note: To request the User Assistant, which displays basic usage instructions in the connection document, enable the User Assistant option on the HEI Administrator prior to creating a connection document.

Creating a New Connection Document in HEI

To create a new connection document in HEI, perform the following steps:

  1. Open the HEI Administrator database, decsadm.NSF.
  2. Optionally enable the User Assistant from the HEI Administrator Navigator panel.
  3. Click the Add Connection button on the HEI Administrator action bar.
  4. Select a connection data source type from the resultant list.

    You can remove any of the supported data sources from the list that you do not intend to use. Refer to the Notes® Application Developer's Guide for more information on how to remove a form from a menu.

  5. Complete the connection document as needed.
  6. Save and Close the connection document.
  7. Test the connection as described in the companion document Lotus® Connectors and Connectivity Guide.

Viewing or Editing Connection Documents in HEI

Once you create a connection document, it is visible in the connections view. To view or edit an existing connection document in HEI, do the following steps.

  1. Open the HCL Enterprise Integrator (HEI) Administrator database, decsadm.NSF.
  2. Click Connections from the HEI Administrator's Navigator panel.

    If you have connections that belong to a Category, you can also display using the Activities by Category selection.

  3. Select the desired connection from the view display on the HEI Administrator.
Note: You can also edit connections used by a particular activity by opening that activity document and clicking the Edit Connection button.

Creating a New Connection Document in DECS

To create a new connection document in Domino® Enterprise Connection Services (DECS), perform the following steps:

  1. Click the Connection button on the DECS Administrator navigator.
  2. Click the Add Connection button on the action bar.
  3. Select the desired connector type from the resultant display.
  4. Enter the required information in the resultant connection document.

Viewing or Editing Connection Documents in DECS

Once you create a connection document, it is visible in the connections view. To view or edit an existing connection document in DECS, perform the following steps.

  1. Click Connections from the Views area of the DECS Administrator.
  2. Select the desired connection from the resultant display.