Setting deployment properties for a runtime environment, WebSphere Adapter for Lotus Domino

IBM BPM, V8.0.1, All platforms > Authoring services in Integration Designer > Services and service-related functions > Access external services with adapters > Configure and using adapters > IBM WebSphere Adapters > Lotus Domino > Configure the module for deployment > Configure the module for inbound processing > Setting deployment properties and generating the service
Setting deployment properties for a runtime environment

The connection properties are initialized to the values that the wizard used to connect to the database. To configure the module to use other values, change values such as user name and password here.

This task is performed using the Specify the Service Generation and Deployment Properties window of the external service wizard.

To generate artifacts for your module follow this procedure:

Procedure

Optional: In the Specify the Service Generation and Deployment Properties window, click Edit Operations to review the names or add a description for the operations for the business objects that you are creating.
In Deployment Properties, specify how you want the adapter to connect to the Lotus Domino server by selecting any one of these authentication methods.

To use a J2C authentication alias, click Using an existing JAAS alias (recommended) and type the name of the alias in the J2C authentication data entry field. You can either specify an existing authentication alias or create one at any time before deploying the module. The name is case-sensitive and includes the node name.
To use the security properties from the managed connection properties, click Using security properties from the managed connection factory and enter the following information:

In the User name field, type the user name to connect to the Lotus Domino server.
In the Password field, type the password to connect to the Lotus Domino server.
The security properties are not encrypted and stored as plain text.

To use any other method of authenticating to the Lotus Domino server, click Other.

In the Deploy connector project field, specify whether to include the adapter files in the module. Select one of the following values:

With module for use by single application: With the adapter files embedded in the module, you can deploy the module to any application server. Use an embedded adapter when you have a single module using the adapter or if multiple modules need to run different versions of the adapter. Using an embedded adapter enables you to upgrade the adapter in a single module without the risk of destabilizing other modules by changing their adapter version.
On server for use by multiple applications: If you do not include the adapter files in a module, install them as a stand-alone adapter on each application server where you want to run the module. Use a stand-alone adapter when multiple modules can use the same version of the adapter and you want to administer the adapter in a central location. A stand-alone adapter can also reduce the resources required by running a single adapter instance for multiple modules.

If you selected On server for use by multiple applications in the previous step, specify how you want to set the connection properties at run time.

If you manually created and configured a managed connection factory or activation specification on the server or if you have already deployed an application that connects to the same Lotus Domino server using the same managed connection factory or activation specification properties, you can reuse the managed connection factory or activation specification by specifying the name of its Java™ Naming and Directory Interface (JNDI) data source:

In Connection properties, select Use predefined connection properties.
In JNDI Lookup Name, type the name of the JNDI data source for an existing managed connection factory or activation specification.
Click Next.

If this application is the first one that connects to the database with a specific user name and password, or if you want to administer the user name and password separately from other applications, select Specify connection properties.
Figure 1. Specify the service generation and deployment properties window

Optional: Review and if necessary, change the values of the required connection properties. The fields are initialized with the connection information you specified when you started the wizard.

Connection properties

In the Host name field, type the host name or IP address of the Lotus Domino server.
In the DIIOP port number field, type the port number of the Lotus Domino server. The default DIIOP port number is 63148.

Click Advanced. Expand the advanced sections to review and specify the following options:

Event polling configuration

In the Interval between polling periods (milliseconds) field, type the time in milliseconds, that the adapter waits between polling periods. For more information about the property, see Interval between polling periods (PollPeriod).
In the Maximum events in polling period field, type the number of events to deliver in each polling period. For more information about the property, see Maximum events in polling period (PollQuantity).
In the Time between retries in case of case of system connection failure (in milliseconds) field, type the time in milliseconds, that the adapter waits before trying to connect after a connection failure during polling. See Time between retries in case of system connection failure (RetryInterval).
In the Maximum number of retries in case of system connection failure field, type the number of times the adapter retries the connection before reporting a polling error. See Maximum number of retries in case of system connection failure (RetryLimit).
If you want the adapter to stop if polling errors occur, select the Stop the adapter when an error is encountered while polling check box. If you do not select this option, the adapter logs an exception but continues to run. See Stop the adapter when an error is encountered while polling (StopPollingOnError).
Select the Retry EIS connection on startup check box, if you want the adapter to retry a failed connection when starting. See Retry EIS connection on startup (RetryConnectionOnStartup).

Select the calendar based scheduling option to create calendar based polling for inbound activities.
You can schedule your business activities, when you create a new calendar in IBM Integration Designer. The option of working with the calendar based scheduling feature is only possible with IBM Integration Designer as the tooling environment. The following figure helps you to schedule a calendar polling option.
Figure 2. Polling based on business calendar

You can either select a blank calendar or create a new calendar for a module or library.
When you select a blank calendar, you will not be able to set predefined time intervals. You have to define your time intervals. When you create a calendar using a predefined template, you can define time intervals for each template.

To select an existing calendar for a module or library, click Browse. In the Select a Business Calendar window, you can search for existing calendar files ( *cal) in the IBM Integration Designer workspace.

In the Filter by name field, type the calendar name or name pattern. The calenders matching the pattern are displayed in the Matching business calendars area.
Select a calendar and click OK to return to the external service wizard.

To create a new calendar entry for a module or library, click New. The Create a business calendar window is displayed.

In the Module or library field, click Browse to select an existing calendar module or click New to create a module for the new calendar.
In the Folder field, click Browse to select an existing folder or create a new folder for the calendar.
In the Name field, enter a name for the new calendar.

To create a non template calendar, click Finish. Or
To generate the calendar based on a predefined template, click Next. In the Use a template window, select the Create a calendar using one of the templates check box and click Finish.

The new business calendar is created and available in the Business Integration view. Once you complete the wizard, you can view or modify the calendar schedules in the Business Integration view using the Business Calendar Editor. You can modify the intervals and exceptions, or add new entries for these elements. For more details about working with business calendars, see Business calendars.

You must deploy the Business Calendar module to the same IBM BPM or WebSphere Enterprise Service Bus instance, along with the inbound application. If you do not map these two connections to the same server instance, the inbound application using the business calendar will by default, poll as there is no calendar configured.

Event delivery configuration

In the Type of delivery field, select the delivery method. The methods are described in Delivery type (DeliveryType).
If you want to ensure that events are delivered only once and to only one export, select the Ensure assured-once event delivery check box. This option might reduce performance but does not result in duplicate or missing event delivery. For more information, see Ensure once-only event delivery (AssuredOnceDelivery).
In the Event types to process field, type a colon-separated list of the business objects for which you want the events delivered. Leave this field blank to receive events for all business object types.
In the Adapter Instance for event filtering field, type the connector id for which you want the events delivered. See Event groups to filter (AdapterInstanceEventFilter).
In the Retry limit for failed events field, specify the number of times to try to deliver an event after a delivery failure. See Retry limit for failed events (FailedEventRetryLimit).
In the Number of connections for event delivery area, specify the minimum and maximum number of connections to use to deliver events. See Minimum connections (MinimumConnections) and Maximum connections (MaximumConnections).

Processing methods for illegal XML characters

From the Illegal XML character processing drop-down list, select one of the options that correspond to your requirement:

Do not validate illegal XML characters, if you want to work with the default adapter behavior.
Throw exception if contents in the BO contains illegal XML characters, if you want to proceed after you get an exception message, and log the illegal XML characters in the trace file, at runtime.
Discard all illegal XML characters and related logs, if you want the adapter to discard the illegal XML characters, and log the characters in the trace file, at runtime.

Figure 3. Processing methods for illegal XML characters

Logging and tracing

If you have multiple instances of the adapter, enter a value in the Adapter ID that is unique for this instance. See Resource adapter properties.
You can select the Disguise user data as 'XXX' in log and trace files check box to prevent sensitive user data from being written to log and trace files.

Click Next.

Results
The Specify the Location Properties window is displayed.

Setting deployment properties and generating the service

Related concepts:

Inbound processing
User authentication

Related tasks:

Setting location properties for artifacts

Related reference:

Activation specification properties
Resource adapter properties
Inbound configuration properties
Globalization