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 > JDBC > Configure the module for deployment > Configure the module for outbound processing

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.

This task is performed through the Specify the Service Generation and Deployment Properties and Specify the Location Properties windows of the external service wizard.

The connection properties in this task are initialized to the values that the wizard used to connect to the database. To configure the module to use other values, change the values here.

For example, to use the IBM Toolkit for Java™ native driver at run time on IBM i, set the driver information here.


Procedure

  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.

    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. By default, the adapter is configured to join the global transaction. The adapter uses the XA connection for global transaction. You can configure a XA connection by specifying either a predefined XA data source or XA database connection information. For a local transaction, clear the Join the global transaction check box. You can configure a local transaction by specifying either a predefined connection pool data source, local database connection information, predefined XA data source or XA data source connection information.

    If you select the Join the global transaction check box, the Database connection information list displays only the XA related database connection options. If an artifact from an earlier version contains only the local connection properties and the Join the global transaction check box was selected, after migration, the Database connection information list in the assembly editor displays the option for local database connection.

    If you do not specify a valid connection information for global transaction, the adapter returns the ResourceException.

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

  5. If you selected On server for use by multiple applications in the previous step, specify the connection properties used 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.

  6. In the Connection Properties area, specify how you want the adapter to establish database connection at run time. You can establish connection with the adapter at run time in one of the following ways:

    • To use a predefined XA data source on the server (for XA connection):

      1. Select the Join the global transaction check box.

      2. From the Database connection information list, select Specify predefined XA DataSource.

      3. In the Database system connection information area, enter the value in the XA DataSource JNDI name field. This value must be set to a JNDI data source that supports XA transactions that is created on the IBM BPM or WebSphere Enterprise Service Bus. For more information about this property, see XA DataSource JNDI name (XADataSourceJNDIName).

    • To specify the connection information to be saved in the adapter properties (for XA connection):

      1. Select the Join the global transaction check box.

      2. From the Database connection information list, select Specify XA database connection information.

        Using the Specify XA database connection information option, you can configure the adapter to support global transactions for Oracle and DB2 databases only.

      3. In the Database system connection information area, enter values in the XA DataSource name and XA database name fields for a DB2 database. For an Oracle database, enter values in the XA DataSource name and Database URL fields. For more information about these properties, see Database URL (DatabaseURL) and XA DataSource name (XADataSourceName).

    • To use a predefined connection pool data source (for local connection):
      1. Clear the Join the global transaction check box.

      2. From the Database connection information list, select Specify predefined connection pool DataSource.

      3. In the Database system connection information area, enter the name of the existing JNDI data source in the Connection pool DataSource JNDI name field. For more information about this property, see Connection pool DataSource JNDI name (PoolDataSourceJNDIName).

    • To specify connection information to be saved in the adapter properties (for local connection):
      1. Clear the Join the global transaction check box.

      2. From the Database connection information list, select Specify local database connection information.

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

  7. 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 Managed connection factory properties.

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

    • Additional connection configuration

      1. If you want to turn on AUTOCOMMIT for the database, select the Set Auto Commit on database connection check box. For more information about the property, see Auto commit (AutoCommit).
      2. Set Additional JDBC driver connection properties. For more information about the property, see Additional JDBC driver connection properties [name:value;name:value] (JDBCDriverConnectionProperties).
      3. Set SQL query to verify the connection. For more information about the property, see SQL query to verify the connection (PingQuery).

      4. In the Query timeout field, type the time in seconds, that the adapter must wait for a response to a database query. For more information about the property, see Query timeout (seconds) (QueryTimeOut).
      5. Set Return business object even when the stored procedure result set is empty. For more information about the property, see Return business object even when the stored procedure result set is empty (ReturnDummyBOForSP).

    • Logging and tracing

    • Bidi properties

      • To enable bidirectional support for the adapter at run time, select the Bidi transformation check box.
      • Set the properties, ordering schema, text direction, symmetric swapping, character shaping, and numeric shaping to control how bidirectional transformation is performed.

    • Connection retry settings

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

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

  10. 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 wanted 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 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 Module and click Next.

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

        For example, JDBCOutboundModule.

      4. If you want the service description files (the .import and .wsdl files) to be 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 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.

  11. Specify the namespace you want to use for your artifacts.

    • If you want the business objects in the module to use the default derived 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.

  12. Optional: Specify the folder within the new module where the service description will be 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.

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

  14. 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 the Library field.

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

  16. When you are finished setting properties, click Finish.


Results

The wizard exits. The module is created in the project and artifacts are generated.


What to do next

In some instances, you might need to use the assembly editor to complete the configuration. Then you can test or deploy your module.

Configure the module for outbound processing


Previous topic: Setting global properties for operations and creating wrapper business objects


Next topic: Completing the configuration


Related concepts:

Outbound processing

User authentication

Technical overview


Related reference:

Configuration properties

Solutions to common problems

Managed connection factory properties

Migration considerations