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 > Email > Configure the module for deployment > Configure the module for inbound processing

Setting deployment and runtime properties for inbound processing

Using the external service wizard in IBM Integration Designer, select whether the module is used for outbound or inbound communication with the mail server. Then configure the connection properties. The connection properties are stored in the business object and contain the information that the adapter needs to make the connection between the inbound module and service.

Before you can set the connection properties in this section, create your module in IBM Integration Designer. It is displayed in the Business Integration pane below the adapter project. Also, create a staging directory on your local system for storing emails that is polled by the adapter but which are yet to be turned into business objects.

To set connection properties, follow this procedure. See Activation specification properties.


Procedure

  1. In the Select the Processing Direction window, select Inbound and click Next.

    Figure 1. Choosing inbound or outbound in the external service wizard

    The Specify the Security and Configuration Properties window opens.

  2. 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.

    Figure 2. Specifying inbound connection properties

  3. Browse for the Staging Directory you created on your local system. If you have not created a staging directory, create one and then restart the external service wizard.
  4. Define the Connection properties for your module. For more details about these properties, see Activation specification properties.

    1. Under the E-mail system connection information, type the Host name.
    2. Type the Port number.

    3. Select the email Protocol. For more information about the POP3 and IMAP email protocols, see Supported inbound protocols.

  5. Click Advanced and specify values as needed. These include activation specification properties designed to alter the default behavior of the adapter during inbound communication. For more information about any of the Advanced properties for event polling, event delivery, event persistence, archiving, or setting search criteria, see Activation specification properties.

    Figure 3. Advanced properties

    • Event delivery configuration

      1. In the Type of delivery field, select the delivery method. The methods are described in Delivery type (DeliveryType).

      2. 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).

      3. 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).
    • 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).

      • To specify the time interval between attempts to connect to the mail server if a connection fails, set Time between retries in case of system connection failure (in milliseconds) to a value in milliseconds. See Time between retries in case of system connection failure (RetryInterval).

      • To specify the number of connection exceptions during the inbound operation, set Maximum number of retries in case of system connection failure to a value greater than or equal to 0. 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 try 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 4. 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.

          1. 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.

          2. 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.

          1. 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.

          2. In the Folder field, click Browse to select an existing folder or create a new folder for the calendar.

          3. 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 persistence configuration

      1. Select Auto create event table check box if you want the adapter to create the Event Persistence table. See Event recovery table name property (EP_TableName).

      2. In the Event recovery data source (JNDI) name field, specify the JNDI name of the data source that event persistence uses to connect to the JDBC database. See Event recovery data source (JNDI) name property (EP_DataSource_JNDIName).

      3. In the User name used to connect to event data source field, specify the user name that the event persistence uses to connect to the database from the data source. See User name used to connect to event data source property (EP_UserName).

      4. In the Password used to connect to event data source field, specify the password that the event persistence uses to connect to the database from the data source. See Password used to connect to event data source property (EP_Password).

      5. In the Database schema name field, specify the schema name of the database that the event persistence uses. See Database schema name (EP_SchemaName).

    • Additional configuration

      1. Select the Enable transport security (SSL) check box if you want to enable SSL. See Enable transport security (SecureConnectionProperty).

      2. Select the Emit individual business objects from a multipart e-mail check box, to specify if the adapter creates individual business objects for each part of a multipart email. See Emit individual business objects from a multipart email (EmitIndividualBOs).

      3. In the Match all search criteria field, specify the search criteria to filter which events are polled from the mail server. The events that meet the ANDed conditions are polled. See Match all search criteria (MatchAllCriteria).

      4. In the Match some search criteria field, specify the search criteria to filter which events are polled from the mail server. The events that meet the ORed conditions are polled. See Match some search criteria (MatchSomeCriteria).

      5. In the Archive file naming pattern field, you can specify a comma-delimited pattern of header names which are used to name archived files stored in the archive folder. For more information, see Archive file naming pattern (ArchiveFile).
    • Bidi properties

      1. Select the Bidi transformation check box to specify bidirectional format. For more information about setting the Bidi properties, see Globalization.
    • Logging and tracing

      1. If you have multiple instances of the adapter, enter a value in the Adapter ID that is unique for this instance. See Adapter ID (AdapterID).

      2. 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.

  6. In Service properties, specify how you want the adapter to connect to the mail 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 activation specification, click Using security properties from the activation specification enter the following information:

      • In the User name field, type the user name for the mail server.

      • In the Password field, type the password for the mail server.

        The security properties are not encrypted and stored as plain text. If you are using an authentication alias, a user name and password are not necessary. Also, for outbound communication you do not need to enter a user name and password because a mail server uses an anonymous user name and password to send the emails.

    • To administer the user name and password from another mechanism, click Other.

  7. To use an existing function selector configuration, use the default value (EmailFunctionSelector). To configure a custom function selector, click Select. Clicking Select allows you to select a pre-configured function selector. You can configure a function selector if you want to implement a custom function selector. This configuration is an advanced concept. By default, the email function selector is used, which does not require any configuration.

  8. Select the Change logging properties for wizard check box if you want to define the level of logging for this module.


What to do next

Browse for or create a data binding for the module.

Configure the module for inbound processing


Next topic: Selecting a data type and operation name


Related concepts:

Inbound processing

User authentication


Related reference:

Activation specification properties

Resource adapter properties

Connection properties for the external service wizard

Inbound configuration properties

Globalization