org.mule.modules

mule-module-siebel

config

Namespace	http://www.mulesoft.org/schema/mule/siebel-bs
Schema Location	http://www.mulesoft.org/schema/mule/siebel-bs/current/mule-siebel-bs.xsd (View Schema)
Schema Version	1.0
Minimum Mule Version	3.4

Module Overview

Oracle Siebel Java Data Beans connector to connect to Siebel Business Services

Summary

Configuration
<siebel-bs:config> Configure an instance of this module

Message Processors
<siebel-bs:execute> Executes a Siebel Service using SiebelPropertySets

Configuration

To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:

<mule xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:siebel-bs="http://www.mulesoft.org/schema/mule/siebel-bs"
      xsi:schemaLocation="
               http://www.mulesoft.org/schema/mule/core
               http://www.mulesoft.org/schema/mule/core/current/mule.xsd
               http://www.mulesoft.org/schema/mule/siebel-bs
               http://www.mulesoft.org/schema/mule/siebel-bs/current/mule-siebel-bs.xsd">

      <!-- here goes your flows and configuration elements -->

</mule>

Connection Pool

This connector offers automatic connection management via the use of a connection pool. The pool will act a storage mechanism for all the connections that are in-use by the user of this connector.

Prior to execution of a processor, the connector will attempt to lookup an already established connection and if one doesn't exists it will create one. That lookup mechanism is done in the connection pool via the use of connection variables declared as keys.

The user of the connector can configure the pool by adding a connection-pooling-profile to the connector configuration like this:

    <siebel-bs:connection-pooling-profile maxActive="10" maxIdle="10"
                             exhaustedAction="WHEN_EXHAUSTED_GROW" maxWait="120" minEvictionMillis="60000" evictionCheckIntervalMillis="30000"/>

The following is a list of connection attributes, each connection attribute can be configured at the config element level or they can also be added to each processor. If they are used at the processor level they get the benefit of full expression resolution.

Connection Attributes
Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
busServiceUser		Siebel username	String	/	UTF-8
busServicePassword		Siebel password	String	/	UTF-8
busServiceServer		Siebel server	String	/	UTF-8
busServicePort	2321	Optional. Siebel port	String	/	UTF-8
busServiceName		Siebel Enterprise server name	String	/	UTF-8
busServiceObjectManager		Siebel Object Manager	String	/	UTF-8
busServiceLanguage	ENU	Optional. Connection language	String	/	UTF-8
busServiceEncoding	utf8	Optional. Connection file encoding	String	/	UTF-8

Reconnection Strategies

Reconnection Strategies specify how a connector behaves when its connection fails. You can control how Mule attempts to reconnect by specifying a number of criteria:

The type of exception
Number and frequency of reconnection attempts
The notifications generated, and more

With a reconnection strategy, you can better control the behavior of a failed connection, by configuring it, for example, to re-attempt the connection only once every 15 minutes, and to give up after 30 attempts. You can also send an automatic notification to your IT administrator whenever this reconnection strategy goes into effect. You can even define a strategy that attempts to reconnect only during business hours. Such a setting can prove useful if your server is frequently shut down for nightly maintenance.

Configuration

A reconnection strategy that allows the user to configure how many times a reconnection should be attempted and how long to wait between attempts.

    <siebel-bs:config>
         <reconnect count="5" frequency="1000"/>
    </siebel-bs:config>

Reconnect Attributes
Name	Default Value	Description
frequency	2000	Optional. How often (in ms) to reconnect
count	2	Optional. How many reconnection attempts to make

For more information about reconnection strategies in Mule, or even how to write your own custom reconnection strategy please check this section.

Message Processors

<siebel-bs:execute>

Executes a Siebel Service using SiebelPropertySets

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
serviceName		Siebel's business service	String	/	UTF-8
methodName		Method to be executed	String	/	UTF-8
input	#[payload]	Optional. SiebelPropertySet with the input args	SiebelPropertySet	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
busServiceUser		Optional. Siebel username	String	/	UTF-8
busServicePassword		Optional. Siebel password	String	/	UTF-8
busServiceServer		Optional. Siebel server	String	/	UTF-8
busServicePort	2321	Optional. Siebel port	String	/	UTF-8
busServiceName		Optional. Siebel Enterprise server name	String	/	UTF-8
busServiceObjectManager		Optional. Siebel Object Manager	String	/	UTF-8
busServiceLanguage	ENU	Optional. Connection language	String	/	UTF-8
busServiceEncoding	utf8	Optional. Connection file encoding	String	/	UTF-8

Returns

Return Type	Description
SiebelPropertySet	SiebelPropertySet with the results

Exception Payloads

Payload Class	Description
SiebelException	when the service fails

mule-module-siebel

Module Overview

Summary

Configuration

Connection Pool

Reconnection Strategies

Configuration

Message Processors

<siebel-bs:execute>

XML Sample

Attributes

Returns

Exception Payloads

Message Sources

Transformers