Nav

Oracle Siebel Business Objects Connector API Reference

Oracle Siebel Java Data Beans connector

Additional Info

Requirement Required?

Requires Mule Enterprise License

Yes  

Requires Entitlement

Yes  

Mule Version

3.5.0 or higher

Configs


Configuration

<siebel:config>

Connection Management

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

user

String

Siebel username

x 

rsaEnabled

boolean

Siebel encryption type. Make sure your server is configured to support RSA encryption. By default it is set to false.

false

 

password

String

Siebel password

x 

server

String

Siebel server. The server IP.

x 

port

String

Siebel port. The server port used for the connection. By default it is 2321.

2321

 

serverName

String

Siebel Enterprise server name

x 

objectManager

String

Siebel Object Manager

x 

language

String

connection language

ENU

 

encoding

String

connection file encoding. It specifies the character encoding of the Siebel client. By default it is utf8.

utf8

 

defaultViewModeBusComp

int

Default view mode for DataSense purposes. By default it is set to '3' which means it will go through all the records for which there is a valid owner.

3

 

dataSenseFilterQueryBusComp

String

Query for filtering DataSense Business Components results.

 

defaultViewModeBusObjects

int

Default view mode for Business Objects discovery. By default it is set to '3' which means it will go through all the records for which there is a valid owner.

3

 

dataSenseFilterQueryBusObjects

String

Query for filtering DataSense Business Objects results

 

dataSenseHierarchicalDiscovery

Boolean

Indicates if the fields discovery will recreate hierarchical objects within business components. By default it is set to false.

false

 

Processors


Query Business Components

<siebel:query-business-components>

  DataSense enabled

Retrieves a list of business components depending on a given search spec or search expression

XML Sample


           
        
1
2
3
4
5
6
7
8
<siebel:query-business-components config-ref="Oracle_Siebel_Business_Objects" businessObjectComponentType="Action.Action" records="">
        <siebel:fields-to-retrieve>
                    <siebel:fields-to-retrieve>Description</siebel:fields-to-retrieve>
                </siebel:fields-to-retrieve>
        <siebel:search-spec>
            <siebel:search-spec key="Description">Action1</siebel:search-spec>
        </siebel:search-spec>
    </siebel:query-business-components>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

businessObjectComponentType

String

Siebel's business object component type

x 

fieldsToRetrieve

List<String>

list of fields to retrieve in the query

x 

searchSpec

Map<String,String>

map with search values to be used as filters in the query

 

searchExpression

String

search expression for Siebel's business components

 

sortSpec

String

sorting specification for Siebel's business components

 

viewMode

Integer

integer representing the visibility type for the Business Component: 0 (SalesRepView) 1 (ManagerView) 2 (PersonalView) 3 (AllView) 4 (NoneSetView)

3

 

records

String

integer representing the number of records returned by the query. By default it returns all the records.

 

Returns

Return Java Type Description

List<Map<String,Object>>

list of maps with the components values


Query Join Business Components

<siebel:query-join-business-components>

Allows retrieving two different business object, joining them according to an specified criteria

XML Sample


           
        
1
2
3
4
5
6
7
8
9
10
11
12
13
<siebel:query-join-business-components config-ref="Oracle_Siebel_Business_Objects" businessObjectComponentType="Opportunity.Opportunity" businessObjectComponentTypeToJoin="Opportunity.Opportunity Product">
        <siebel:fields-to-retrieve>
            <siebel:fields-to-retrieve>Id</siebel:fields-to-retrieve>
            <siebel:fields-to-retrieve>name</siebel:fields-to-retrieve>
        </siebel:fields-to-retrieve>
        <siebel:fields-to-retrieve-to-join>
            <siebel:fields-to-retrieve-to-join>Id</siebel:fields-to-retrieve-to-join>
            <siebel:fields-to-retrieve-to-join>Name</siebel:fields-to-retrieve-to-join>
        </siebel:fields-to-retrieve-to-join>
        <siebel:join-condition>
            <siebel:join-condition key="Id">Oppty Id</siebel:join-condition>
        </siebel:join-condition>
    </siebel:query-join-business-components>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

businessObjectComponentType

String

Siebel's business object component type

x 

fieldsToRetrieve

List<String>

list of fields to retrieve in the query

x 

searchSpec

Map<String,String>

map with search values to be used as filters in the query

 

searchExpression

String

search expression for Siebel's business components

 

businessObjectComponentTypeToJoin

String

Business object component to join

x 

fieldsToRetrieveToJoin

List<String>

fields to retrieve for the business component to join

x 

joinCondition

Map<String,String>

map containing the join condition for the business object. The structure is (key[field in object1], value[field in object 2])

x 

viewMode

Integer

Siebel business component view mode

3

 

nrRecords

String

number of records returned by the query

 

Returns

Return Java Type Description

List<Map<String,Object>>

list of maps with the components values


Create business component

<siebel:create-business-component>

  DataSense enabled

Creates a new business component

XML Sample


           
        
1
2
3
4
5
<siebel:create-business-component config-ref="Oracle_Siebel_Business_Objects" businessObjectComponentType="Action.Action">
        <siebel:business-component-fields>
            <siebel:business-component-field key="Description">New Action</siebel:business-component-field>
        </siebel:business-component-fields>
    </siebel:create-business-component>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

businessObjectComponentType

String

Siebel's business object component type

x 

businessComponentFields

Map<String,Object>

map with the list of values to be added to the new component

#[payload]

 

Returns

Return Java Type Description

CreateResult

created business component id


Update Business Component

<siebel:update-business-component>

  DataSense enabled

Updates Siebel business component from values map

XML Sample


           
        
1
2
3
4
5
6
7
8
<siebel:update-business-component config-ref="Oracle_Siebel_Business_Objects" businessObjectComponentType="Action.Action">
        <siebel:search-spec>
            <siebel:search-spec key="Id">1-EA-2223</siebel:search-spec>
        </siebel:search-spec>
        <siebel:business-component-fields>
            <siebel:business-component-field key="Description">New Action</siebel:business-component-field>
        </siebel:business-component-fields>
    </siebel:update-business-component>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

businessObjectComponentType

String

Siebel's business object component type

x 

searchSpec

Map<String,String>

map containing the spec for searching business components to update

x 

businessComponentFields

Map<String,Object>

map with the list of values to be updated in the component

#[payload]

 

viewMode

Integer

Siebel business component view mode

3

 

Returns

Return Java Type Description

UpdateResult

true if operation was successful


Upsert Business Component

<siebel:upsert-business-component>

  DataSense enabled

Creates or updates a business component depending if it exists or no. For checking if the record exists, it queries Siebel taking into account the list of idfields. If the list is null, it will take the Id field from the business component fields map.

XML Sample


           
        
1
2
3
4
5
6
7
8
9
<siebel:upsert-business-component config-ref="Oracle_Siebel_Business_Objects" businessObjectComponentType="Action.Action">
        <siebel:business-component-fields>
            <siebel:business-component-field key="Id">1-EA223</siebel:business-component-field>
            <siebel:business-component-field key="Description">New Action</siebel:business-component-field>
        </siebel:business-component-fields>
        <siebel:id-fields>
            <siebel:id-field>Description</siebel:id-field>
        </siebel:id-fields>
    </siebel:upsert-business-component>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

businessObjectComponentType

String

Siebel's business object component type

x 

businessComponentFields

Map<String,Object>

map with the list of values to be updated in the component

#[payload]

 

idFields

List<String>

list of fields to be taken as identifiers of the record to analyze if it should be created or not

 

viewMode

Integer

Siebel business component view mode

3

 

Returns

Return Java Type Description

UpsertResult

id of the created or updated business component


Delete Business Component

<siebel:delete-business-component>

  DataSense enabled

Deletes a Siebel business component record from Id

XML Sample

<siebel:delete-business-component config-ref="Oracle_Siebel_Business_Objects" businessObjectComponentType="Action.Action"
        businessComponentId="EJJ-11"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

businessObjectComponentType

String

Siebel's business object component type

x 

businessComponentId

String

id of the business component to be deleted

x 

viewMode

Integer

Siebel business component view mode

3

 

Returns

Return Java Type Description

boolean

true if the operation was successful

In this topic: