Oracle Siebel Connector 4.0 Reference | MuleSoft Documentation
# Oracle Siebel Connector 4.0 Reference
Siebel Connector 4.0.8 and later now supports IP21.   
---  
Anypoint Connector for Oracle Siebel (Siebel Connector) lets you access connections between Mule runtime engine (Mule) integration apps and the Oracle Siebel customer relationship manager (CRM).
## Configurations
### Siebel
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
The name for this configuration. Connectors reference the configuration with this name.  
**Connection** |  Username Password |  The connection types to provide to this configuration.  
**Default View Mode Bus Comp**  
**Data Sense Filter Query Bus Objects**  
**Data Sense Filter Query**  
**Data Sense Filter Query Bus Comp**  
**Data Sense Filter Query Int Objects**  
**DataSense Filters**  
**Synchronized calls** |  Enable this checkbox to synchronize calls made to the operations. Do so only if making multiple calls at the same time results in error messages from Siebel.  
**Expiration Policy** |  Expiration Policy |  Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.  
#### Connection Types
##### Username Password
###### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
For multiple servers, the format must be: `VirtualServer1=vid1:ip1:port1,vid2:ip2:port2;`. The **Port** field below the **Server** field is ignored for multiple servers.  
**Server Name**  
**RSA Encryption**  
**Object Manager**  
**Reconnection** |  |  When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn't pass after exhausting the associated reconnection strategy.  
## Supported Operations
  * Create Business Component
  * Delete Business Component
  * Execute Business Service
  * Execute Siebel Adapter
  * Query Business Components
  * Query Join Business Components
  * Update Business Component
  * Upsert Business Component


## Operations
### Create Business Component
`<siebel:create-business-component>`
Creates a new business component. 
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Business Object Component Type** |  Siebel's business object component type.  
**Business Component Fields** |  Map with the list of values to be added to the new component.  
**Target Variable** |  The name of a variable to store the operation's output.  
**Target Value** |  An expression to evaluate against the operation's output and store the expression outcome in the target variable.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
### For Configurations
#### Throws
  * SIEBEL:INVALID_ATTACHMENT
  * SIEBEL:CONNECTIVITY
  * SIEBEL:RETRY_EXHAUSTED
  * SIEBEL:UNKNOWN


### Delete Business Component
`<siebel:delete-business-component>`
Deletes a Siebel business component record from Id. 
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Business Object Component Type** |  Siebel's business object component type.  
**Business Component Id** |  ID of the business component to be deleted.  
Siebel business component view mode.  
**Target Variable** |  The name of a variable to store the operation's output.  
**Target Value** |  An expression to evaluate against the operation's output and store the expression outcome in the target variable.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
### For Configurations
#### Throws
  * SIEBEL:INVALID_ATTACHMENT
  * SIEBEL:CONNECTIVITY
  * SIEBEL:RETRY_EXHAUSTED
  * SIEBEL:UNKNOWN


### Execute
`<siebel:execute>`
Executes a Siebel Service using SiebelPropertySets 
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Service Name** |  Siebel's business service.  
**Method Name** |  Method to execute.  
SiebelPropertySet with the input args.  
**Target Variable** |  The name of a variable to store the operation's output.  
**Target Value** |  An expression to evaluate against the operation's output and store the expression outcome in the target variable.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
### For Configurations
#### Throws
  * SIEBEL:RETRY_EXHAUSTED
  * SIEBEL:CONNECTIVITY


### Execute Business Service
`<siebel:execute-business-service>`
Executes a Siebel Service using Maps instead of SiebelPropertySet. 
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Business Service** |  Siebel's business service.  
**Input Properties** |  Map containing the input parameters for the specified Siebel business service and method. The structure of this map is dynamic and determined by the Siebel system at runtime. When configuring the operation in Anypoint Studio, the connector retrieves metadata from the Siebel system to identify the expected input parameters for the selected method. Anypoint Studio automatically presents the relevant fields and data types, so users do not need to manually define the schema.  
**Target Variable** |  The name of a variable to store the operation's output.  
**Target Value** |  An expression to evaluate against the operation's output and store the expression outcome in the target variable.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
### For Configurations
#### Throws
  * SIEBEL:RETRY_EXHAUSTED
  * SIEBEL:CONNECTIVITY


### Execute Siebel Adapter
`<siebel:execute-siebel-adapter>`
Execute an operation for a Siebel Integration Object using EAI Siebel Adapter. 
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
Enumeration, one of:
  * INSERT
  * UPSERT
  * UPDATE
  * DELETE
  * QUERY
  * QUERY_PAGE
  * EXECUTE
  * SYNCHRONIZE

|  EAI Siebel Adapter method.  
**Integration Object** |  Siebel's integration object.  
**Input Properties** |  Map with the integration object fields.  
**Target Variable** |  The name of a variable to store the operation's output.  
**Target Value** |  An expression to evaluate against the operation's output and store the expression outcome in the target variable.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
### For Configurations
#### Throws
  * SIEBEL:RETRY_EXHAUSTED
  * SIEBEL:CONNECTIVITY


### Query Business Components
`<siebel:query-business-components>`
Retrieves a list of business components depending on a given search spec or search expression. 
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Business Object Component Type** |  Siebel's business object component type.  
**Query Definition** |  Query Definition |  Object defining the query to execute.  
**Target Variable** |  The name of a variable to store the operation's output.  
**Target Value** |  An expression to evaluate against the operation's output and store the expression outcome in the target variable.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
Array of Object  
---  
### For Configurations
#### Throws
  * SIEBEL:INVALID_ATTACHMENT
  * SIEBEL:CONNECTIVITY
  * SIEBEL:RETRY_EXHAUSTED
  * SIEBEL:UNKNOWN
|  A retry strategy in case of connectivity errors.  
#### Output
### For Configurations
#### Throws
  * SIEBEL:RETRY_EXHAUSTED
  * SIEBEL:CONNECTIVITY


### Query Business Components
`<siebel:query-business-components>`
Retrieves a list of business components depending on a given search spec or search expression. 
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Business Object Component Type** |  Siebel's business object component type.  
**Query Definition** |  Query Definition |  Object defining the query to execute.  
**Target Variable** |  The name of a variable to store the operation's output.  
**Target Value** |  An expression to evaluate against the operation's output and store the expression outcome in the target variable.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
Array of Object  
---  
### For Configurations
#### Throws
  * SIEBEL:INVALID_ATTACHMENT
  * SIEBEL:CONNECTIVITY
  * SIEBEL:RETRY_EXHAUSTED
  * SIEBEL:UNKNOWN


### Query Join Business Components
`<siebel:query-join-business-components>`
Allows retrieving two different business object, joining them according to an specified criteria. 
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Business Object Component Type** |  Siebel's business object component type.  
**Query To Join Definition** |  Query To Join Definition |  Object containing the join definition for the business object.  
**Target Variable** |  The name of a variable to store the operation's output.  
**Target Value** |  An expression to evaluate against the operation's output and store the expression outcome in the target variable.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
Array of Object  
---  
### For Configurations
#### Throws
  * SIEBEL:INVALID_ATTACHMENT
  * SIEBEL:CONNECTIVITY
  * SIEBEL:RETRY_EXHAUSTED
  * SIEBEL:UNKNOWN


### Update Business Component
`<siebel:update-business-component>`
Updates Siebel business component from values map. 
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Business Object Component Type** |  Siebel's business object component type.  
**Search Spec** |  Map containing the spec for searching business components to update. For more information about the usage of search spec, refer to the Oracle documentation.  
**Business Component Fields** |  Map with the list of values to be updated in the component.  
Siebel business component view mode.  
**Target Variable** |  The name of a variable to store the operation's output.  
**Target Value** |  An expression to evaluate against the operation's output and store the expression outcome in the target variable.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
Array of String  
---  
### For Configurations
#### Throws
  * SIEBEL:INVALID_ATTACHMENT
  * SIEBEL:CONNECTIVITY
  * SIEBEL:RETRY_EXHAUSTED
  * SIEBEL:UNKNOWN


### Upsert Business Component
`<siebel:upsert-business-component>`
Creates or updates a business component depending on whether it already exists. To check if the record exists, it queries Siebel, taking into account the list of recordIds. If the list is null, it takes the Id field from the business component fields map. 
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Business Object Component Type** |  Siebel's business object component type.  
**Business Component Fields** |  Map with the list of values to be updated in the component.  
**Record Ids** |  Array of String |  List of fields to be taken as identifiers of the record to analyze if it should be created or not.  
Siebel business component view mode.  
**Target Variable** |  The name of a variable to store the operation's output.  
**Target Value** |  An expression to evaluate against the operation's output and store the expression outcome in the target variable.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output  
---  
### For Configurations
#### Throws
  * SIEBEL:INVALID_ATTACHMENT
  * SIEBEL:CONNECTIVITY
  * SIEBEL:RETRY_EXHAUSTED
  * SIEBEL:UNKNOWN


## Types
### Reconnection
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Fails Deployment** |  When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  The reconnection strategy to use.  
### Reconnect
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
How often to reconnect (in milliseconds).  
The number of reconnection attempts to make.  
If false, the reconnection strategy runs in a separate, non-blocking thread.  
### Reconnect Forever
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
How often in milliseconds to reconnect.  
If false, the reconnection strategy runs in a separate, non-blocking thread.  
### Expiration Policy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Max Idle Time** |  A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.  
Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  A time unit that qualifies the maxIdleTime attribute.  
### Query Definition
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Array of String  
**Search Expression**  
**Search Spec**  
### Query To Join Definition
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Business Object Component Type To Join**  
Array of String  
**Fields To Retrieve Join** |  Array of String  
**Join Condition**  
**Search Expression**  
**Search Spec**  
### Upsert Result
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Created Object Id**  
**Updated Objects** |  Array of String  
## See Also
MuleSoft Help Center