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.

The use of the HEI Administrator and logging is determined when the LCSession class object is created. HEI Scripted activities require that the first Connector Class object created be an LCSession object.

When an HEI Scripted activity is run, all the property fields of the activity form are accessible in the script.

LCSession properties may be accessed through several techniques.

  • After creating the LCSession object, you may specify the property. For example, if session is the name of a LCSession object and CharacterSet is a property of the session, session. CharacterSet is the value of the item. When using the Notes® LotusScript® development environment, the debugger displays all session properties when inspecting variables.
  • You can use the GetProperty and SetProperty methods of LCSession to access the property as an LCField object.
  • You can use GetProperty<type> and SetProperty<type> to access the property as a specific data type.

HEI requires that you also provide a name for every session and the name of an existing connection document. You must specify Dim LCSession as a named session (this becomes the default log document name). LCConnections must be dimensioned as existing named connection documents that have been created in the HEI Administrator.

Example statement syntax is shown as follows:

Uselsx "*lsxlc"
Sub Initialize
	DIM MyLEISession As New LCSession ("MainLEISession")
	Dim MyNotesConnection as New LCConnection("MyNotesConn")
	Dim MyOracleConnection as New LCConnection("MyOracleConn")

In the preceding example, "MyNotesConnection" and "MyOracleConn" are assumed to be existing named connection documents in the HEI Administrator. When writing Connector LotusScript® Extensions (LC LSX) scripts for HEI, LCSession must be named. This name is used as the default log document name. Named sessions enable support of HEI activity log documents.