# mulesoft Oracle Siebel Connector - Full Documentation

<!-- document id=03de0817ca9cec18d974251a89de754acda784e26359c0336ef72fcb6f84f5f5 url=/mulesoft/current/en-us/siebel-connector/latest/index.md -->

---
product: Oracle Siebel Connector
version: 4.0
is-latest-version: true
---

# Oracle Siebel Connector 4.0

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

> [!NOTE] Siebel Connector 4.0.8 and later now supports IP22.

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

Siebel Connector has only one option for connecting with Siebel apps, which are categorized by
Siebel Objects and Services.

- Oracle Siebel Business Objects: Create, update, upsert, query, and delete Siebel business
  components.

- Oracle Siebel Integration Objects: Create, update, upsert, query, delete, query page, execute, and
  synchronize Siebel integration objects.

- Oracle Siebel Business Services: Execute Siebel business services.

All options are available after installing the Siebel connector.

The Siebel connector is built using the Siebel Java Data Beans interface. Java Data Beans provides a
native Java interface to access the Siebel Object Manager.

The Siebel Object Manager lets a connector use a generic interface that does not depend on a
customized installation. To discover the metadata of Siebel objects in design time, use DataSense in
Anypoint Studio. The Siebel connector takes advantage of the Siebel Repository to show a list of
available objects as well as their structures in a Siebel custom installation.

The objects can be business components, business objects, integration objects, or business services.

Release Notes:
[Oracle Siebel Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/siebel-connector-release-notes-mule-4)  
Exchange:
[Oracle Siebel Connector](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-oracle-siebel-jdb-connector/)

## Before You Begin

To use this information, you should be familiar with Oracle Siebel, Mule runtime engine (Mule),
Anypoint Connectors, Anypoint Studio, Mule concepts, elements in a Mule flow, and Global Elements.

You need login credentials to test your connection to your target resource.

To use this connector with Maven, view the pom.xml dependency information in the Dependency Snippets
in Anypoint Exchange.

Because of how closely the connector is coupled with Siebel CRM, you should have a working knowledge
of Siebel Business Components, Business Objects, Business Services, and Integration Objects.

The Siebel connector requires the following two Siebel JAR files: `Siebel.jar` and `SiebelJI_xxx`.

Choose the SiebelJI\_xxx.jar based on the locale of the Siebel installation. For instance, if the
locale of Siebel installation is US\_EN, use `SiebelJI_enu.jar`. The `Siebel.jar` and
`SiebelJI_enu.jar` are available in the `<%SIEBEL_HOME%>\8.1.1.11\Tools_1\CLASSES` folder on the
Siebel server. `%SIEBEL_HOME%` is the installation directory of Siebel.

The connector now is a conglomerate of the previous 3 modules (Oracle Siebel Business Objects,
Oracle Siebel Integration Objects, Oracle Siebel Business Services)

## POM File Information

```xml
<dependency>
  <groupId>com.mulesoft.connectors</groupId>
  <artifactId>mule-oracle-siebel-jdb-connector</artifactId>
  <version>x.y.z</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

Replace `x.y.z` with the version that corresponds to the connector you are using.

To obtain the most up-to-date `pom.xml` file information, access the connector in
[Anypoint Exchange](https://www.mulesoft.com/exchange/) and click **Dependency Snippets**.

## Add the Connector to a Studio Project

Anypoint Studio provides two ways to add the connector to your Studio project: from the Exchange
button in the Studio taskbar or from the Mule Palette view.

### Add the Connector Using Exchange

1.  In Studio, create a Mule project.

2.  Click the Exchange icon **(X)** in the upper-left of the Studio task bar.

3.  In Exchange, click **Login** and supply your Anypoint Platform username and password.

4.  In Exchange, search for "siebel".

5.  Select the connector and click **Add to project**.

6.  Follow the prompts to install the connector.

### Add the Connector in Studio

1.  In Studio, create a Mule project.

2.  In the Mule Palette view, click **(X) Search in Exchange**.

3.  In **Add Modules to Project**, type "siebel" in the search field.

4.  Click this connector’s name in **Available modules**.

5.  Click **Add**.

6.  Click **Finish**.

### Configure in Studio

1.  Drag the operation you want to execute to the Studio canvas.

2.  To create a new configuration for the Siebel connector, click the plus button in the Basic
    Settings area.

    ![Plug sign in properties window to create a new configuration](/mulesoft/current/en-us/siebel-connector/latest/_images/siebel-studio-create-config.png)

3.  Fill in the data in the configuration form.

    ![Global element properties window](/mulesoft/current/en-us/siebel-connector/latest/_images/siebel-studio-config.png)

    1.  For the Required Libraries sections, you have to add the Siebel.jar and SiebelJI\_xxx
        libraries that you previously downloaded.

        ![Maven dependency window with JAR files added](/mulesoft/current/en-us/siebel-connector/latest/_images/siebel-studio-add-jar.png)

        After you click Finish, the library is added as a dependency, but the Global Element
        Properties window does not change, just in case you want to add more dependencies throughout
        the Maven Dependency UI.

    2.  For the configuration section, the fields are:

        - Name - Enter a name for this Configuration to reference it later.

        - User - Enter the Siebel username to be used.

        - Password - Enter the corresponding Siebel password.

        - Server - Enter the server IP address of your Siebel instance.

        - Port - Enter the port number. Default value is 2321.

        - Server Name - Enter the Siebel Enterprise server name.

        - RSA Encryption - Choose if you want to use RSA encryption. Default value is false.

        - Object Manager - Enter the value of the Object Manager of your Siebel instance.

        - Language - Enter the language corresponding to the locale of the Siebel instance. Default
          value is ENU.

        - Encoding - Enter an encoding type supported by the Siebel server. Default value is utf8.

    3.  The General filters are composed of:

        - Default View Mode Bus Comp - Enter the default view for DataSense. The default value for
          this field is 3.

          Supported values:

          - 0 (SalesRepView):

        - Applies access control according to a single position or a sales team.

        - Displays records according to one of the following items: The user position or the sales
          team that includes a user’s position. The Visibility field or Visibility MVField of the
          business component determines the visibility.

          - 1 (ManagerView):

            Displays records that a user and others who report to the user can access. For example,
            it includes the records that Siebel CRM displays in the My Team’s Accounts visibility
            filter.

          - 2 (PersonalView):

            Displays records that a user can access, as determined by the Visibility Field property
            of the BusComp view mode object. For example, it includes the records that Siebel CRM
            displays in the My Accounts visibility filter.

          - 3 (AllView):

            Displays all records that includes a valid owner. For example, it includes the records
            that Siebel CRM displays in the All Accounts Across Organizations visibility filter.

        - Data Sense Filter Query Bus Objects - Use this field to write a query to filter the
          Business Objects metadata being downloaded into the application.

        - DataSense Filter Query Bus Comp - Use this field to write a query to filter the Business
          Components metadata being downloaded into the application.

        - DataSense Filter Query Int Objects - Use this field to write a query to filter the
          Integration Objects metadata being downloaded into the application.

        - Data Sense Filter Query - Use this field to write a query to filter the Business Services
          metadata being downloaded into the application.

        - Other - Use this field to define another query to filter the Business Objects, Services or
          Integration Objects metadata which is going to be downloaded into the application.

> [!NOTE] Limit the number of objects to retrieve through DataSense to a few objects using search
> specifications, otherwise retrieving metadata slows down Studio.

## Log Requests and Responses

To log requests and responses when using the connector, configure a logger by adding this line to
the `Loggers` element of the `log4j2.xml` configuration file for the Mule app:

```xml
<AsyncLogger name="org.mule.modules.siebel.internal.service"
   level="DEBUG"/>
```

The following example shows the `Loggers` element with the `AsyncLogger` line added:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
	<Appenders>
	    <Console name="Console" target="SYSTEM_OUT">
	    	<PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
		</Console>
	</Appenders>
	<Loggers>
		<AsyncLogger name="org.mule.modules.siebel.internal.service" level="DEBUG" additivity="false">
			<appender-ref ref="Console" level="debug"/>
		</AsyncLogger>
	</Loggers>
</Configuration>
```

You can view the app log as follows:

- If you’re running the app from the Anypoint Platform, the output is visible in the Anypoint Studio
  console window.

- If you’re running the app using Mule from the command line, the app log is visible in your OS
  console.

Unless the log file path was customized in the app’s log file (`log4j2.xml`), you can also view the
app log in this default location:

`MULE_HOME/logs/<app-name>.log`

For more information about the app log, see
[Configuring Logging](https://docs.mulesoft.com/mule-runtime/latest/logging-in-mule).

## Use Case: Studio

The Siebel Connector is an operation-based connector, which means that when you add the connector to
your flow you must specify an operation to perform.

### Example Use Cases

The following are common use cases for the Siebel v4.0.0 connector:

1.  Create a Business Component (Action, Account, etc.)

    1.  Create a new Mule project in Anypoint Studio.

    2.  Add a suitable Mule Inbound endpoint, such as the HTTP listener, to begin the flow.

    3.  Drag the Create business component operation from the Siebel JDB palette onto the canvas,
        then select it to open the properties editor.

    4.  Configure the operation’s parameters:

        ![Create business component operation properties window](/mulesoft/current/en-us/siebel-connector/latest/_images/siebel-studio-create.png)

    5.  Drag the Transform Message connector between the HTTP Listener and the Siebel connector on
        the flow.

    6.  Configure the input payload with the desired fields:

        ![Transform Message properties window with input payload configuration](/mulesoft/current/en-us/siebel-connector/latest/_images/siebel-studio-transform-create.png)

2.  Execute a Business Service (Create Contact, Create Account etc.)

    1.  Create a new Mule project in Anypoint Studio.

    2.  Add a suitable Mule Inbound endpoint, such as the HTTP listener, to begin the flow.

    3.  Drag the Execute business service operation from the Siebel JDB palette onto the canvas,
        then select it to open the properties editor.

    4.  Configure the operation’s parameters:

        ![Execute business service operation properties window](/mulesoft/current/en-us/siebel-connector/latest/_images/siebel-execute.png)

    5.  Drag the Transform Message connector between the HTTP Listener and the Siebel connector on
        the flow.

    6.  Configure the input payload with the desired fields:

        ![Transform Message properties window with input payload configuration](/mulesoft/current/en-us/siebel-connector/latest/_images/siebel-transform-execute.png)

3.  Execute Siebel Adapter (Creating an Integration Object)

    1.  Create a new Mule project in Anypoint Studio.

    2.  Add a suitable Mule Inbound endpoint, such as the HTTP listener, to begin the flow.

    3.  Drag the **Execute siebel adapter** operation from the Siebel JDB palette onto the canvas,
        then select it to open the properties editor.

    4.  Configure the operation’s parameters:

        ![Execute siebel adapter operation properties window](/mulesoft/current/en-us/siebel-connector/latest/_images/siebel-integration.png)

    5.  Drag the Transform Message connector between the HTTP Listener and the Siebel connector on
        the flow.

    6.  Configure the input payload with the desired fields:

        ![Transform Message properties window with input payload configuration](/mulesoft/current/en-us/siebel-connector/latest/_images/siebel-transform-integration.png)

## USE Case: XML

XML snippet from a project using the Siebel Connector:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
    xmlns:siebel="http://www.mulesoft.org/schema/mule/siebel"
    xmlns:http="http://www.mulesoft.org/schema/mule/http"
    xmlns="http://www.mulesoft.org/schema/mule/core"
    xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    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/http
    http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
    http://www.mulesoft.org/schema/mule/siebel
    http://www.mulesoft.org/schema/mule/siebel/current/mule-siebel.xsd
    http://www.mulesoft.org/schema/mule/ee/core
    http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">

    <configuration-properties file="mule-app.properties"/>

    <siebel:siebel-config
        name="Siebel_JDB_Siebel"
        doc:name="Siebel JDB Siebel"
        dataSenseFilterQueryBusComp="[Name] = 'Action'">
        <siebel:basic-connection
            user="${siebel.user}"
            password="${siebel.password}"
            server="${siebel.server}"
            serverName="${siebel.servername}"
            objectManager="${siebel.objectManager}"/>
    </siebel:siebel-config>

    <http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config">
        <http:listener-connection host="localhost" port="8081"/>
    </http:listener-config>

    <flow name="siebel-demosFlow1">
            <http:listener
                config-ref="HTTP_Listener_config"
                path="/create"
                doc:name="Listener"/>
            <ee:transform doc:name="Transform Message">
                <ee:message>
                    <ee:set-payload><![CDATA[%dw 2.0
                                        output application/java
                                        ---
                                        {
                                            "Type":payload.actionType as String,
                                            "Description": payload.description as String
                                        }]]>
                    </ee:set-payload>
                </ee:message>
            </ee:transform>
            <siebel:create-business-component
                config-ref="Siebel_JDB_Siebel"
                businessObjectComponentType="Action.Action"
                doc:name="Create business component"/>
            <ee:transform doc:name="Transform Message">
                <ee:message>
                    <ee:set-payload><![CDATA[%dw 2.0
                                        output application/json
                                        ---
                                        payload]]>
                    </ee:set-payload>
                </ee:message>
            </ee:transform>
        </flow>
</mule>
```

## See Also

[Salesforce Help](https://help.salesforce.com)

<!-- document id=ef7116352d7dbbde102a2f59bd5c43af07ad892562081b29778b0ed088db2553 url=/mulesoft/current/en-us/siebel-connector/latest/siebel-connector-reference.md -->

---
product: Oracle Siebel Connector
version: 4.0
is-latest-version: true
---

# Oracle Siebel Connector 4.0 Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

> [!NOTE] 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name for this configuration. Connectors reference the configuration with this name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p><a href="#siebel_basic">Username Password</a></p></div></div></td><td><div><div><p>The connection types to provide to this configuration.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Default View Mode Bus Comp</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div><div><p>3</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Data Sense Filter Query Bus Objects</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Data Sense Filter Query</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Data Sense Filter Query Bus Comp</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Data Sense Filter Query Int Objects</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DataSense Filters</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div><div><p>3</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Other</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Synchronized calls</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Expiration Policy</strong></p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Connection Types

##### Username Password

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>User</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Server</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>For multiple servers, the format must be: <code>VirtualServer1=vid1:ip1:port1,vid2:ip2:port2;</code>. The <strong>Port</strong> field below the <strong>Server</strong> field is ignored for multiple servers.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>2321</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Server Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>RSA Encryption</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Object Manager</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Language</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>ENU</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Encoding</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>utf8</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Supported Operations

- [Create Business Component](#createBusinessComponent)

- [Delete Business Component](#deleteBusinessComponent)

- [Execute](#execute)

- [Execute Business Service](#executeBusinessService)

- [Execute Siebel Adapter](#executeSiebelAdapter)

- [Query Business Components](#queryBusinessComponents)

- [Query Join Business Components](#queryJoinBusinessComponents)

- [Update Business Component](#updateBusinessComponent)

- [Upsert Business Component](#upsertBusinessComponent)

## Operations

### Create Business Component

`<siebel:create-business-component>`

Creates a new business component.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Business Object Component Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Siebel's business object component type.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Business Component Fields</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Map with the list of values to be added to the new component.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation's output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation's output and store the expression outcome in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr></tbody></table>

### For Configurations

- [Siebel](#siebel)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Business Object Component Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Siebel's business object component type.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Business Component Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>ID of the business component to be deleted.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>View Mode</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Siebel business component view mode.</p></div></div></td><td><div><div><p>3</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation's output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation's output and store the expression outcome in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Boolean</p></td></tr></tbody></table>

### For Configurations

- [Siebel](#siebel)

#### Throws

- SIEBEL:INVALID\_ATTACHMENT

- SIEBEL:CONNECTIVITY

- SIEBEL:RETRY\_EXHAUSTED

- SIEBEL:UNKNOWN

### Execute

`<siebel:execute>`

Executes a Siebel Service using SiebelPropertySets

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Service Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Siebel's business service.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Method Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Method to execute.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Input</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>SiebelPropertySet with the input args.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation's output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation's output and store the expression outcome in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Object</p></td></tr></tbody></table>

### For Configurations

- [Siebel](#siebel)

#### Throws

- SIEBEL:RETRY\_EXHAUSTED

- SIEBEL:CONNECTIVITY

### Execute Business Service

`<siebel:execute-business-service>`

Executes a Siebel Service using Maps instead of SiebelPropertySet.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Business Service</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Siebel's business service.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Input Properties</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Map containing the input parameters for the specified Siebel business service and method.</p></div><div><p>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.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation's output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation's output and store the expression outcome in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Object</p></td></tr></tbody></table>

### For Configurations

- [Siebel](#siebel)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Method</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>INSERT</p></li><li><p>UPSERT</p></li><li><p>UPDATE</p></li><li><p>DELETE</p></li><li><p>QUERY</p></li><li><p>QUERY_PAGE</p></li><li><p>EXECUTE</p></li><li><p>SYNCHRONIZE</p></li></ul></div></div></td><td><div><div><p>EAI Siebel Adapter method.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Integration Object</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Siebel's integration object.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Input Properties</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Map with the integration object fields.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation's output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation's output and store the expression outcome in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Object</p></td></tr></tbody></table>

### For Configurations

- [Siebel](#siebel)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Business Object Component Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Siebel's business object component type.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Query Definition</strong></p></td><td><div><div><p><a href="#QueryDefinition">Query Definition</a></p></div></div></td><td><div><div><p>Object defining the query to execute.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation's output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation's output and store the expression outcome in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Object</p></td></tr></tbody></table>

### For Configurations

- [Siebel](#siebel)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Business Object Component Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Siebel's business object component type.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Query To Join Definition</strong></p></td><td><div><div><p><a href="#QueryToJoinDefinition">Query To Join Definition</a></p></div></div></td><td><div><div><p>Object containing the join definition for the business object.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation's output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation's output and store the expression outcome in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Object</p></td></tr></tbody></table>

### For Configurations

- [Siebel](#siebel)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Business Object Component Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Siebel's business object component type.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Search Spec</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Map containing the spec for searching business components to update. For more information about the usage of search spec, refer to the <a href="https://docs.oracle.com/cd/E14004_01/books/ConfigApps/Applets9.html">Oracle documentation</a>.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Business Component Fields</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Map with the list of values to be updated in the component.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>View Mode</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Siebel business component view mode.</p></div></div></td><td><div><div><p>3</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation's output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation's output and store the expression outcome in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of String</p></td></tr></tbody></table>

### For Configurations

- [Siebel](#siebel)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Business Object Component Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Siebel's business object component type.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Business Component Fields</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Map with the list of values to be updated in the component.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Record Ids</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>List of fields to be taken as identifiers of the record to analyze if it should be created or not.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>View Mode</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Siebel business component view mode.</p></div></div></td><td><div><div><p>3</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation's output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation's output and store the expression outcome in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#UpsertResult">Upsert Result</a></p></td></tr></tbody></table>

### For Configurations

- [Siebel](#siebel)

#### Throws

- SIEBEL:INVALID\_ATTACHMENT

- SIEBEL:CONNECTIVITY

- SIEBEL:RETRY\_EXHAUSTED

- SIEBEL:UNKNOWN

## Types

### Reconnection

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Fails Deployment</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>The reconnection strategy to use.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to reconnect (in milliseconds).</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The number of reconnection attempts to make.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If false, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect Forever

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often in milliseconds to reconnect.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If false, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr></tbody></table>

### Expiration Policy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Idle Time</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>A time unit that qualifies the maxIdleTime attribute.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Query Definition

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Fields</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Records</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Search Expression</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Search Spec</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Sort Spec</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>View Mode</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Query To Join Definition

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Business Object Component Type To Join</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Fields</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Fields To Retrieve Join</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Join Condition</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Records</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Search Expression</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Search Spec</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>View Mode</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Upsert Result

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Created Object Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Updated Objects</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## See Also

[Salesforce Help](https://help.salesforce.com)