Setting deployment properties and generating the service

After you select and configure business objects for your module, use the external service wizard to configure properties that the adapter uses to connect to a specific database. The wizard creates a new business integration module where all the artifacts and property values are saved.

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

2. In the Deployment Properties area, specify how you want the adapter to get the user name and password at run time.
   • To use a J2C authentication alias, click Using an existing JAAS alias (recommended) and enter 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, click Using security properties from the managed connection factory and enter values in the User name and Password fields.
   • To administer the user name and password from another mechanism, click Other.
   Note: If you use local connection information to establish the database connection, a security credential is required. You can select either Using an existing JAAS alias (recommended) or Using security properties from the managed connection factory as the security mechanism. If you use an existing data source on the server, the security credential is not required. In this case, you can select Other as the security mechanism. Also, if you set the J2C authentication data entry field or set the User name and Password fields, they override the user name and password in the data source.
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, you must 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 adapters in the previous step, specify the connection properties to connect 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 database 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:
     1. From the Connection settings list, select Use predefined connection properties.
     2. In the JNDI Lookup Name field, type the name of the JNDI data source for an existing managed connection factory or activation specification.

        The following figure shows typical settings for reusing a managed connection factory or activation specification for a stand-alone deployment of the adapter.

        

     3. Click Next to complete this task.
   • If this is the first application 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.
5. In the Connection Properties area, specify how you want the adapter to establish database connection at run time.
   • To use an existing data source on the server:
     1. From the Database connection information list, select Specify predefined DataSource.
     2. In the Database system connection information area, enter the name of an existing JNDI data source in the DataSource JNDI name field. For more information about this property, see Data source JNDI name (DataSourceJNDIName).
   • To specify the connection information to be saved in the adapter properties:
     1. From the Database connection information list, select Specify database connection information.
     2. In the Database system connection information area, enter values in the Database URL and JDBC driver class name fields. For more information about these properties, see Database URL (DatabaseURL) and JDBC driver class (JDBCDriverClass).
6. 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. You can change the values to specify a different user name and password at run time. You can also connect to an alternate database, although the schema names must be the same in both databases. The format of the connection properties is database-specific. For more information about the properties, see Activation specification properties.
7. Optional: Specify advanced properties by clicking Advanced. Expand each of the advanced sections to review the properties.
   • Event polling and processing configuration
     
     1. 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).
     2. 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).
     3. 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. For more information, see Time between retries in case of system connection failure (RetryInterval).
     4. 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. For more information, 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 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. For more information, see Stop the adapter when an error is encountered while polling (StopPollingOnError).
     6. Select the Retry EIS connection on startup check box, if you want the adapter to retry a failed connection when starting. For more information, 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. You can either select a blank calendar or create a new calendar for a module or library.

        Note: 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.

        Note: You must deploy the Business Calendar module to the same IBM Business Process Manager 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.
     8. In the Timeout period for HA Active-Active event processing (seconds) field, specify the time in seconds, for the timeout period for processing the HA Active-Active event. To enable inbound Active-Active mode, set Enable High Availability support (enableHASupport) to false. For more information, see Timeout period for HA Active-Active event processing (seconds)
   • 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. 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 time stamp in the future check box. For more information, see Do not process events that have a timestamp in the future (FilterFutureEvents).
     4. In the Event types to process field, type the required values:

        Table 1. Event type values

        Values	Description
        ,	To separate different filters, which are compatible with earlier versions.
        :	To separate the business object name and the operation name.
        |	To separate different supported values.

        For example, to receive events related to the Customer and Order business objects only, specify SchemaNameCustomerBG,SchemaNameOrderBG. To receive events related to the Customer business object with only the Create operation, and Order business object with the Create or Delete operation, specify SchemaNameCustomerBG:Create,SchemaNameOrderBG:Create|Delete. Use the real schema name to replace the SchemaName in the example.

        For more information, see Event types to process (EventTypeFilter).

     5. In the Adapter Instance for event filtering field, specify the connector ID where the events will be delivered. For more information, see Adapter Instance for event filtering (AdapterInstanceEventFilter).
     6. In the Retry limit for failed events field, specify the number of times to try to deliver an event after a delivery failure. For more information, see Retry limit for failed events (FailedEventRetryLimit).
     7. In the Number of connections for event delivery area, specify the minimum and maximum number of connections to use to deliver events. For more information, see Minimum connections (MinimumConnections) and Maximum connections (MaximumConnections).
   • Processing methods for illegal XML characters
     
     • To work with the default adapter behavior, select Do not validate illegal XML characters.
     • To proceed after you get an exception message, and log the illegal XML characters in the trace file at run time, select Throw exception if contents in the BO contains illegal XML characters.
     • To discard the illegal XML characters, and log the characters in the trace file at run time, select Discard all illegal XML characters and related logs.
   • Additional connection configuration
     
     1. Set Additional JDBC driver connection properties. See more information about the property in Additional JDBC driver connection properties [name:value;name:value] (JDBCDriverConnectionProperties).
     2. Set SQL query to verify the connection. See more information about the property in SQL query to verify the connection (PingQuery).
     3. In the Query timeout (seconds) field, type the length of time, in seconds, that the adapter must wait for a response to a database query. See more information about the property in Query timeout (seconds) (QueryTimeOut).
     4. Set Return business object even when the stored procedure result set is empty. See more information about the property in Return business object even when the stored procedure result set is empty (ReturnDummyBOForSP).
   • Event configuration
     
     1. In the Event order by field, indicate the order in which events are retrieved and processed. This is a comma-separated list of column names from the event table, plus the keywords that control the sort order for each column. Use asc for ascending order and desc for descending order. For more information, see Event order by (EventOrderBy).
     2. In the Event table name field, accept the default name of the table that contains the event store, or type a different table name. For more information, see Event table name (EventTableName).
     3. In the Stored procedure to run before poll field, specify the name of a stored procedure or stored function to run before the actual poll query is called. For more information, see Stored procedure to run before polling (SPBeforePoll).
     4. In the Stored procedure to run after poll field, specify the name of a stored procedure or stored function to run after each polling cycle. For more information, see Stored procedure to run after polling (SPAfterPoll).
     5. In the Event query type for processing events field, select the type of event processing you want to use:
        • To use the standard event processing provided by the adapter, select Standard.
        • To provide your own queries to customize event processing, select User-Defined (Dynamic). If you select this option, complete the additional fields described in the following table.
          Note: When you are using custom event processing, the properties Do not process events that have a timestamp in the future (FilterFutureEvents), Event types to process (EventTypeFilter), and Adapter Instance for event filtering (AdapterInstanceEventFilter) are not supported.

          Field	What to specify	For more information
          User-defined delete query	The name of the query, stored procedure, or stored function that is run after each event is processed to delete records that can be deleted after the event is delivered.	User-defined delete query (CustomDeleteQuery)
          User-defined event query	The name of the query, stored procedure, or stored function that performs the polling for events.	User-defined event query (CustomEventQuery) Using JDBC event table for user-defined event query.
          User-defined update query for failed event delivery	The name of the query, stored procedure, or stored function that is run when an event is not delivered successfully.	User-defined update query for failed event delivery (CustomUpdateQueryForFailedEvent)
          User-defined update query	The name of the query, stored procedure, or stored function that is run after each event is processed to prevent the event from being picked up for processing in a subsequent event cycle.	User-defined update query (CustomUpdateQuery)

   • Logging and tracing
     
     1. If you have multiple instances of the adapter, set Adapter ID to a value that is unique for this instance. See more information about the property in Adapter ID (AdapterID).
     2. If you want to mask certain information so that the information is not displayed in the logs or traces, select the Disguise user data as "XXX" in log and trace files field.
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. This can be a new or existing module.
   • If the module name appears in the Module list, select its name.
     Important: 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 is replaced by the new version.
   • Otherwise, create a new module:
     1. Click New.
     2. In the Select a Business Integration Project Type window, select the Module and click Next.
     3. In the Create a Module window, type a name for the module. For example, JDBCInboundModule.
     4. If you want the service description files (the .export and .wsdl files) to be in the default folder in the module, leave the Use default location check box selected. If you want to specify a different folder in the module, clear the option and click Browse to specify user a different folder in the Location field.
     5. If you want the module to be automatically opened in the assembly diagram in IBM Integration Designer when the wizard closes, select the Open the module assembly diagram check box. Otherwise, clear this option.
     6. Click Finish to create the new 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 namespace, select the Use the default namespace check box.
    • To specify a different namespace, clear the Use the default namespace check box and type a different value in the Namespace field.
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 export, 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 name of the import or type a different name.
13. Optional: 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 are finished setting properties, click Finish.