Nav

Siebel Connector Reference

Configurations


Siebel

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types that can be provided to this configuration.

x

Default View Mode Bus Comp

Number

3

Data Sense Flter Query Bus Objects

String

Data Sense Filter Query

String

Data Sense Filter Query Bus Comp

String

Data Sense Filter Query Int Objects

String

DataSense Filters

Number

3

Other

Boolean

true

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime purges the instances when it sees it fit.

Connection Types

Username Password
Parameters
Name Type Description Default Value Required

User

String

x

Password

String

x

Server

String

x

Port

String

2321

Server Name

String

x

RSA Encryption

Boolean

false

Object Manager

String

x

Language

String

ENU

Encoding

String

utf8

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

Operations

Create Business Component

<siebel:create-business-component>

Creates a new business component.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Business Object Component Type

String

Siebel’s business object component type

x

Business Component Fields

Object

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

#[payload]

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Throws

  • SIEBEL:CONNECTIVITY

  • SIEBEL:INVALID_ATTACHMENT

  • SIEBEL:RETRY_EXHAUSTED

  • SIEBEL:CONNECTIVITY

  • SIEBEL:UNKNOWN

Delete Business Component

<siebel:delete-business-component>

Deletes a Siebel business component record from an ID.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Business Object Component Type

String

Siebel’s business object component type

x

Business Component Id

String

id of the business component to be deleted

x

View Mode

Number

Siebel business component view mode

3

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Boolean

For Configurations

Throws

  • SIEBEL:CONNECTIVITY

  • SIEBEL:INVALID_ATTACHMENT

  • SIEBEL:RETRY_EXHAUSTED

  • SIEBEL:CONNECTIVITY

  • SIEBEL:UNKNOWN

Execute

<siebel:execute>

Executes a Siebel Service using SiebelPropertySets.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Service Name

String

Siebel’s business service

x

Method Name

String

Method to be executed.

x

Input

Object

SiebelPropertySet with the input args

#[payload]

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

Throws

  • SIEBEL:CONNECTIVITY

  • SIEBEL:RETRY_EXHAUSTED

Execute Business Service

<siebel:execute-business-service>

Executes a Siebel Service using Maps instead of SiebelPropertySet.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Business Service

String

Siebel’s business service

x

Input Properties

Object

Map with the input for the method

#[payload]

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

Throws

  • SIEBEL:CONNECTIVITY

  • SIEBEL:RETRY_EXHAUSTED

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

String

The name of the configuration to use.

x

Method

Enumeration, one of:

  • INSERT

  • UPSERT

  • UPDATE

  • DELETE

  • QUERY

  • QUERY_PAGE

  • EXECUTE

  • SYNCHRONIZE

EAI Siebel Adapter method

x

Integration Object

String

Siebel’s integration object

x

Input Properties

Object

Map with the integration object fields

#[payload]

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

Throws

  • SIEBEL:CONNECTIVITY

  • SIEBEL:RETRY_EXHAUSTED

Query Business Components

<siebel:query-business-components>

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Business Object Component Type

String

Siebel’s business object component type

x

Query Definition

Object defining the query to be executed.

#[payload]

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Object

For Configurations

Throws

  • SIEBEL:CONNECTIVITY

  • SIEBEL:INVALID_ATTACHMENT

  • SIEBEL:RETRY_EXHAUSTED

  • SIEBEL:CONNECTIVITY

  • SIEBEL:UNKNOWN

Query Join Business Components

<siebel:query-join-business-components>

Allows retrieving two different business objects and joining them according to criteria.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Business Object Component Type

String

Siebel’s business object component type

x

Query To Join Definition

object containing the join definition for the business object.

#[payload]

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Object

For Configurations

Throws

  • SIEBEL:CONNECTIVITY

  • SIEBEL:INVALID_ATTACHMENT

  • SIEBEL:RETRY_EXHAUSTED

  • SIEBEL:CONNECTIVITY

  • SIEBEL:UNKNOWN

Update Business Component

<siebel:update-business-component>

Updates Siebel business component from values map.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Business Object Component Type

String

Siebel’s business object component type

x

Search Spec

Object

map containing the spec for searching business components to update

x

Business Component Fields

Object

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

#[payload]

View Mode

Number

Siebel business component view mode

3

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of String

For Configurations

Throws

  • SIEBEL:CONNECTIVITY

  • SIEBEL:INVALID_ATTACHMENT

  • SIEBEL:RETRY_EXHAUSTED

  • SIEBEL:CONNECTIVITY

  • SIEBEL:UNKNOWN

Upsert Business Component

<siebel:upsert-business-component>

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

String

The name of the configuration to use.

x

Business Object Component Type

String

Siebel’s business object component type

x

Business Component Fields

Object

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

#[payload]

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

View Mode

Number

Siebel business component view mode

3

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

For Configurations

Throws

  • SIEBEL:CONNECTIVITY

  • SIEBEL:INVALID_ATTACHMENT

  • SIEBEL:RETRY_EXHAUSTED

  • SIEBEL:CONNECTIVITY

  • SIEBEL:UNKNOWN

Types

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Reconnection Strategy

The reconnection strategy to use

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

Count

Number

How many reconnection attempts to make

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

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

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

Query Definition

Field Type Description Default Value Required

Fields

Array of String

Records

String

Search Expression

String

Search Spec

Object

Sort Spec

String

View Mode

Number

Query To Join Definition

Field Type Description Default Value Required

Business Object Component Type To Join

String

Fields

Array of String

Fields To Retrieve Join

Array of String

Join Condition

Object

Records

String

Search Expression

String

Search Spec

Object

View Mode

Number

Upsert Result

Field Type Description Default Value Required

Created Object Id

String

Updated Objects

Array of String