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 > Siebel Business Applications > Configure the module for deployment > Configure the module for inbound processing

Setting deployment properties and generating the service

After you select and configure business objects for your module, you can use the external service wizard to configure properties that the adapter uses to connect to Siebel Business Applications. Then, the wizard creates a business integration module where all the artifacts and property values are saved.

Verify that you have configured the business object. The Specify the Service Generation and Deployment Properties window is displayed.

Generate the module which includes the adapter and configured business object. The module is the artifact you deploy on the server.

To generate the module, use the following procedure.

Procedure

1. Select Edit operations if you want to change the default operation name. Then, in the Edit Operation Names window, type a new name and optional description, and click OK.

   Figure 1. Specify the Service Generation and Deployment Properties window, showing the Connection properties section

   

   1. In the Edit Operation Names window, select the operation you want to edit, and then click Edit.

   2. In the Add/Edit properties window, type a new operation name and description, and then click Finish.

2. Specify the required security credentials in the Deployment Properties area:

   • To use a J2C authentication alias, select the Using an existing JAAS alias (recommended) field, and specify the name of the alias in the J2C Authentication Data Entry field.

     You can 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 managed connection properties, select the Using security properties from managed connection factory field, and type the values in the User name and Password fields.

   • To administer the user name and password from other mechanism, select Other.

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

4. In the J2C Authentication Data Entry field, enter the name you specified in the Security section of the administrative console.

5. Click Use discovered connection properties to set properties at this time.

   If you select Use connection properties specified on server, you can configure properties later, using the administrative console.

6. In the Connection properties section, set or change any connection properties that apply to your configuration. See Activation specification properties and Connection properties for the wizard for more information about these properties.

   Properties marked with an asterisk (*) are required.

7. Optional: Specify advanced properties by clicking Advanced. Expand each of the following group sections to review the advanced properties:

   • Processing methods for illegal XML characters
   • Event polling configuration
   • Event delivery configuration
   • Event configuration

   • Runtime configuration
   • Bidi properties

   • Logging and tracing properties
   • Other properties

   The following figure shows the advanced property sections on the Specify the Service Generation and Deployment Properties window.

   Figure 2. Specify the Service Generation and Deployment Properties window, showing the advanced property sections after clicking Advanced

   

   See Activation specification properties and Resource adapter properties for more information about these optional properties.

   • Event polling configuration

     1. In Interval between polling periods, type the number of milliseconds that the adapter waits between polling periods. See Interval between polling periods (pollPeriod).

     2. In Maximum events in polling period, type the number of events to deliver in each polling period. See Maximum events in polling period (pollQuantity).

     3. In Time between retries in case of system connection failure, type the number of milliseconds to wait before trying to connect after a connection failure during polling. For more information, see Time between retries in case of system connection failure (retryInterval).

     4. In Maximum number of retries in case of system connection failure, type the number of times to retry the connection before reporting a polling error. See Maximum number of retries in case of system connection failure (retryLimit).

     5. If you want the adapter to stop if polling errors occur, select Stop the adapter when an error is encountered while polling.

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

     6. You can select Retry EIS connection on startup if you want the adapter to retry an inbound connection that was not made to the Siebel application when starting. Only communication failures to the Siebel application are considered. See Retry EIS connection on startup (retryConnectionOnStartup).
     7. Polling based on business calendar:

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

     1. In Type of delivery, 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 Ensure once-only delivery. This option might reduce performance but does not result in duplicate or missing event delivery. See Ensure once-only event delivery (assuredOnceDelivery).

     3. In Event types to process, type a comma-separated list of the business objects for which you want events delivered. Leave this field blank to receive events for all business object types.

        For example, if you want to receive events only when the Customer and Order tables, but not other tables, are changed in the enterprise information system, set this field to Customer,Order.

        See Event types to process (EventTypeFilter).

     4. Under Number of connections for event delivery, 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

     1. 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 4. Processing methods for illegal XML characters

     

   • Event configuration

     • In Siebel business object name for event store field, specify the name of the business object in the event store where events are stored for inbound processing. See Siebel business object name for event store (SiebelBusinessObjectNameForEventStore).

     You cannot use multiple adapters for polling the same event.

   • Runtime configuration

     • In Code page field, specify the code page that the adapter uses to connect to the Siebel Business Applications server by clicking Select. Select the value from the displayed list. See Code page (codePage).

     • Select the Include empty elements in the output check box for the adapter to include the elements with empty string value in the response business object. See Include empty elements in the output (includeEmptyField)

     Figure 5. Runtime configuration

     

   • Bidi properties

     • In the Bidi properties area, select Bidi transformation.
     • Set the ordering schema, text direction, symmetric swapping, character shaping, and numeric shaping properties to control how bidirectional transformation is performed.

   • Logging and tracing

     • If you have multiple instances of the adapter, set Adapter ID to a value that is unique for this instance.

     • If you want to mask sensitive information in log and trace files (for example, if you want to avoid making customer information visible in these files) expand Logging and tracing, provide an ID for the adapter instance (or accept the default value), and select Disguise user data as "XXX" in log and trace files.

   • Other properties

     1. In Delimiter for event store, specify the delimiter used between two name value pairs containing the object key name and value. See Delimiter for keys in the event store (DelimiterForKeysInTheEventStore).

     2. Select Use Resonate for load balancing on Siebel server if you want to specify that the Siebel server uses resonate support. See Use resonate support for load balancing on Siebel server (UseResonateSupportForLoadBalancingOnSiebelServer).

8. Click Next. The Specify the Location Properties window is displayed.

9. In the Specify the Location Properties window, specify the name of the module you want to create. It can be a new or an existing module.

   • If the required module name appears in the Module list, select its name.

     If the module contains an interface or business object with the same name as any you are now configuring, the original interface or business object in the module will be replaced by the new version.

   • Otherwise, create a module:

     1. Click New.

     2. In the Select a Business Integration Project Type window, select Create a module project and click Next.

     3. In the Create a Module window, type a name for the module.

        For example, SiebelInboundModule.

     4. If you want the service description files (the .import and .wsdl files) to be located in the default folder in the module, leave Use default location selected. If you want to specify a different folder in the module, clear the option and then click Browse to specify a different folder in Location.

     5. If you want the module to be automatically opened in the assembly diagram in IBM Integration Designer when the wizard closes, select Open module assembly diagram. Otherwise, clear this option.

     6. Click Finish to create the module.

10. Specify the namespace you want to use for your business objects.

    • If you want the business objects in the module to use the default derived namespace, leave Use default namespace selected.

    • To specify a different namespace, clear the option and type a different value in Namespace.

11. Optional: Specify the folder within the new module where the service description is saved. In Folder, type the folder name or browse to an existing folder. If you do not specify a folder name, the artifacts (the import, XSD, and WSDL files) are stored in the root folder of the module, that is, the folder with the module name.

12. In the Name field, accept the default import name or type a different name.

13. If you want to save the business objects in a library where they can be used by other modules, select Save business objects to a library and specify the location of the library in Library.

14. Optional: In the Description field, type a descriptive comment about the module.

15. When you finish setting the properties, click Finish.

Results

The new module is added to the Java™ EE perspective.

What to do next

Export the module as an EAR file for deployment.

Configure the module for inbound processing

Previous topic: Configure the selected objects

Related reference:

Inbound configuration properties

Outbound configuration properties

Globalization