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 > PeopleSoft Enterprise > 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 a specific enterprise information system. The wizard creates a business integration module where all the artifacts and property values are saved.

Ensure that you configured the business object.

Use the Specify the Service Generation and Deployment Properties and Specify the Location Properties windows of the external service wizard to perform this task. The connection properties in this task are initialized to the values that the wizard used to connect to the enterprise information system. To configure the module to use other values, change the values here.

Procedure

1. In the Specify the Service Generation and Deployment Properties window, click Edit Operations if you want to review or modify the names, or add a description for the operations to the business objects that you are creating.

   Figure 1. Specify the Service Generation and Deployment Configuration window

   

   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 how you want the adapter to get the user name and password at run time.

   • To use a J2C authentication alias, select Using an existing JAAS alias (recommended) and type the name of the alias in J2C Authentication Data Entry. 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 activation specification properties, select Using security properties from managed connection factory and type the values in the User name and Password fields.

   • If you want 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. When the adapter files are 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 must run different versions of the adapter. You can use an embedded adapter 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. If you selected On server for use by multiple applications in the previous step, indicate how you want to specify the connection properties.

   • If you manually created and configured a managed connection factory or activation specification on the server or if you already deployed an application that connects to the same enterprise information system 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. The following figure shows the JNDI Lookup Name field.

     1. In Connection settings, select Use predefined connection properties.

     2. In JNDI Lookup Name, type the name of the JNDI data source for an existing managed connection factory or activation specification.

     3. Click Next to complete this task.

   • If this application is the first that connects to the enterprise information system 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.

5. Review and, if necessary, change the values of the required connection properties. The Host name, Port number, and Language code fields are initialized with the connection information that you specified when you started the wizard. You can also connect to an alternate enterprise information system, although the schema names must be the same in both. The format of the connection properties is specific to the enterprise information system. For more information about the properties, see Managed connection factory properties.
6. Each of the following areas under Advanced can be expanded to reveal additional fields:

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

   • Additional properties

   • Logging and tracing properties

   Figure 2. Advanced options for inbound processing

   

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

     

   • 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 Retry interval if connection fails, type the number of milliseconds to wait before trying to connect after a connection failure during polling. See Time between retries in case of system connection failure (RetryInterval).

     4. In Number of times to retry the system connection, type the number of times to try the connection again 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. Optionally, you can select Retry EIS connection on startup if you want the adapter to try a failed connection again when starting. See Retry EIS connection on startup (RetryConnectionOnStartup).

     7. 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. By default, the adapter processes all events that it finds when it polls. If you do not want it to process events that have timestamps later than the current time, select the Do not process events that have a timestamp in the future check box. See Do not process events that have a timestamp in the future (FilterFutureEvents)

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

     5. In Adapter Instance for event filtering, type a string value that determines whether this adapter instance processes specific events in the event store. See Adapter Instance for event filtering (AdapterInstanceEventFilter).
     6. 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).
   • Event configuration

     1. In Component interface name for event store, specify the component interface the adapter uses for event notification. See Component interface name for event notification (EventCIName).

     2. In Delimiter for keys in the event store, specify the delimiter for the object key name-value pair in the event table. See Delimiter for keys in the event store (EventKeyDelimiter).

     3. In Java date format for event timestamp, specify the format used to create the event timestamp. See Java date format for event timestamp (DateFormat).

   • Additional properties

     In Component interface for testing failed connection, enter the name of the interface. See Component interface for testing failed connection (PingCompInterface).

   • Logging and tracing properties

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

     2. Select Disguise user data as 'XXX' in log and trace files if you want to prevent sensitive user data from being written to log and trace files. See Disguise user data as "XXX" in log and trace files (hideConfidentialTrace).

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

8. In the Specify the Location Properties window, create a module.

   1. Click New in the Module field.

   2. Select a Business Integration Project Type window, select Create a module project or Create a mediation module project, then click Next.

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

   4. Specify whether you want to open the module in the assembly diagram (for module projects) or whether you want to create a mediation flow component (for mediation module projects). By default, these choices are selected.

   5. Click Finish. The new module is created. When the creation process is finished, the Create a Module window closes, and the new module appears in the Module list in the Specify the Location Properties window.

Results

The new module is added to the Business Integration 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:

Configuration properties

Globalization