Setting deployment properties and generating the service, WebSphere Adapter for Siebel Business Applications

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 outbound 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. The module contains the artifacts that you deployed on the server, which includes the adapter runtime files and the selected business objects. To generate the module, use the following procedure.

Procedure

Optionally select Edit operations if you want to change the default operation name. 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

In the Edit Operation Names window, select the operation you want to edit, and then click Edit.
In the Add/Edit properties window, type a new operation name and description, and then click Finish.

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.

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.

In the J2C Authentication Data Entry field, enter the name you specified in the Security section of the Process Administrative Console.
Click Use discovered connection properties to set the properties.
If you select Use connection properties specified on server, you can configure properties later, using the Process Administrative Console.
In the Connection properties section, set or change any connection properties that apply to your configuration. See Managed connection factory properties for more information about these properties.
Properties marked with an asterisk (*) are required.

Optionally, specify advanced properties by clicking Advanced. Expand each of the following advanced sections to review the 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 the Advanced button

See Managed connection factory properties for more information about these optional properties.

Runtime configuration

To specify that the adapter throws an exception when no records are found in the RetrieveAll operation for a business object or a business service, select the Show error on empty result set check box.
To specify the code page that the adapter uses to connect to the Siebel Business Applications server, click Select and then select the value from the list. For more information, see Code page (codePage).
To specify that the adapter returns the elements with an empty string value in the response business object, select the Include empty elements in the output check box. See Include empty elements in the output (includeEmptyField).

Connection retry settings

To specify the number of times the adapter can attempt to reconnect to the Siebel Business Applications server in case of connection failure, set Maximum retries on connection failure to a value greater than or equal to zero. See Maximum retries in case of system connection failure (connectionRetryLimit).
To specify the time interval between attempts to connect to the Siebel Business Applications server if the connection fails, set Connection retry interval (in milliseconds) to a value in milliseconds. This property is enabled only when the connectionRetryLimit property has a value greater than zero. See Retry interval if connection fails (in milliseconds) (connectionRetryInterval).

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), select Disguise user data as "XXX" in log and trace files.

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.

Processing methods for illegal XML characters

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

Other properties

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

Click Next. The Specify the Location Properties window is displayed.
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 is displayed 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 can be replaced by the new version.

Otherwise, create a module:

Click New.
In the Select a Business Integration Project Type window, select Create a module project and click Next.
In the Create a Module window, type a name for the module.
For example, SiebelOutboundModule.
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.
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.
Click Finish to create the module.

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.

Optionally, 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.

In the Name field, accept the default import name or type a different name.
Optionally, 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.
Optionally, in Description, type a descriptive comment about the module.
When you finish setting the properties, click Finish.

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 outbound processing

Previous topic: Configure the selected objects

Related reference:

Inbound configuration properties
Outbound configuration properties
Globalization
Managed connection factory properties