Free MuleSoft CONNECT Keynote & Expo Pass Available!

Register now+
Nav

Oracle EBS 12.1 Connector Reference

Extension class.

Configurations


JMS Configuration

Default configuration for Oracle EBS operations.

Name Type Description Default Value Required

Name

String

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

x

Connection

  • JMS Parameter Config

  • JMS Url Config

The connection types that can be provided to this configuration.

x

Read Receive Timeout

Number

30000.

Expiration Policy

ExpirationPolicy

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 actually purges the instances when it sees it fit.

Connection Types

JMS Parameter Config

Name Type Description Default Value Required

Username

String

x

Password

String

x

Host

String

x

Port

String

1521.

Database SID

String

x

Reconnection

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.

JMS Url Config

Name Type Description Default Value Required

Username

String

x

Password

String

x

URL

String

x

Reconnection

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.

Associated Sources

  • BusinessEventsSource

  • XmlGatewayOutboundSource


PL-SQL

Default configuration for Oracle EBS operations.

Name Type Description Default Value Required

Name

String

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

x

Connection

Plsql

The connection types that can be provided to this configuration.

x

Expiration Policy

ExpirationPolicy

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

PL-SQL
Name Type Description Default Value Required

Custom PL/SQL name list)

Array of String

Username

String

x

Password

String

x

Host

String

x

Port

String

8000.

SSL

Boolean

false.

Responsibility name

String

Responsibility application name

String

x

Security group name

String

STANDARD.

NLS language

String

AMERICAN.

Org. ID

String

204.

Reconnection

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.

Associated Operations

  • invokePlSql


Web Services

Default configuration for Oracle EBS operations.

Name Type Description Default Value Required

Name

String

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

x

Connection

Web Services

The connection types that can be provided to this configuration.

x

Expiration Policy

ExpirationPolicy

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

Web Services
Name Type Description Default Value Required

TrustStore file name

String

Path where the TrustStore is located.

TrustStore password

String

Password for the TrustStore.

Disable Common Name checking

Boolean

Whether to disable or not the checking of the Common Name in the certificate.

false.

Username

String

x

Password

String

x

Host

String

x

Port

String

8000.

SSL

Boolean

false.

Responsibility name

String

Responsibility application name

String

x

Security group name

String

STANDARD.

NLS language

String

AMERICAN.

Org. ID

String

204.

Reconnection

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.

Associated Operations

  • createEmail

  • createLocation

  • createOrganization

  • createOrganizationContact

  • createOrganizationCustomer

  • createPartySite

  • createPerson

  • createPersonCustomer

  • createPhone

  • createRelationship

  • createWeb

  • findParties

  • getCreatedOrganizationCustomers

  • getEmail

  • getLocation

  • getOrganization

  • getOrganizationContact

  • getOrganizationCustomer

  • getOrganizationsCreated

  • getOrganizationsUpdated

  • getPartySite

  • getPerson

  • getPersonCustomer

  • getPersonCustomersCreated

  • getPersonCustomersUpdated

  • getPersonsCreated

  • getPersonsUpdated

  • getPhone

  • getRelationship

  • getUpdatedOrganizationCustomers

  • getWeb

  • saveEmail

  • saveLocation

  • saveOrganization

  • saveOrganizationContact

  • saveOrganizationCustomer

  • savePartySite

  • savePerson

  • savePersonCustomer

  • savePhone

  • saveRelationship

  • saveWeb

  • updateEmail

  • updateLocation

  • updateOrganization

  • updateOrganizationContact

  • updateOrganizationCustomer

  • updatePartySite

  • updatePerson

  • updatePersonCustomer

  • updatePhone

  • updateRelationship

  • updateWeb

  • xmlGateway

Operations

Invoke Pl Sql

<oracle-ebs:invoke-pl-sql>

Calls a PL/SQL web service.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Input

Binary

Content to be processed. Cannot be null.

#[payload]

Streaming Strategy

  • repeatable-in-memory-stream

  • repeatable-file-store-stream

  • non-repeatable-stream

Configure if repeatable streams should be used and their behavior.

PL/SQL

String

x

Operation

String

x

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

  • plsql-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Create Email

<oracle-ebs:create-email>

Creates a EmailDTO business object. You pass object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object’s business object attributes, the object type also includes lower-level embedded child entities or objects that can be simultaneously created.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

The EmailDTO business object (in json format) to be created.

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Create Location

<oracle-ebs:create-location>

Creates a LocationDTO business object. You pass object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object’s business object attributes, the object type also includes lower-level embedded child entities or objects that can be simultaneously created.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

The Location to create.

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Create Organization

<oracle-ebs:create-organization>

Creates a OrganizationDTO business object. You pass object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object’s business object attributes, the object type also includes lower-level embedded child entities or objects that can be simultaneously created.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Create Organization Contact

<oracle-ebs:create-organization-contact>

Creates a OrgContactDTO business object. You pass object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object’s business object attributes, the object type also includes lower-level embedded child entities or objects that can be simultaneously created.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Create Organization Customer

<oracle-ebs:create-organization-customer>

Creates an OrganizationDTO Customer business object. You pass object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object’s business object attributes, the object type also includes lower-level embedded child entities or objects that can be simultaneously created.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Create Party Site

<oracle-ebs:create-party-site>

Creates a Party Site business object. You pass object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object’s business object attributes, the object type also includes lower-level embedded child entities or objects that can be simultaneously created.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Create Person

<oracle-ebs:create-person>

Creates a PersonDTO business object. You pass object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object’s business object attributes, the object type also includes lower-level embedded child entities or objects that can be simultaneously created.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Create Person Customer

<oracle-ebs:create-person-customer>

Creates a PersonDTO Customer business object. You pass object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object’s business object attributes, the object type also includes lower-level embedded child entities or objects that can be simultaneously created.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Create Phone

<oracle-ebs:create-phone>

Creates a PhoneDTO business object. You pass object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object’s business object attributes, the object type also includes lower-level embedded child entities or objects that can be simultaneously created.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Create Relationship

<oracle-ebs:create-relationship>

Creates a RelationshipDTO business object. You pass object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object’s business object attributes, the object type also includes lower-level embedded child entities or objects that can be simultaneously created.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Create Web

<oracle-ebs:create-web>

Creates a WebDTO business object. You pass object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object’s business object attributes, the object type also includes lower-level embedded child entities or objects that can be simultaneously created.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:RETRY_EXHAUSTED

Find Parties

<oracle-ebs:find-parties>

Takes a list of Search Party objects and returns a list of Matched Party objects based on the search criteria and match rule id.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Criteria

String

the request.

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Get Created Organization Customers

<oracle-ebs:get-created-organization-customers>

Extracts a particular OrganizationDTO Customer object from TCA. You pass the Oracle Business Event System event’s identification information to the operation, and it returns the identified business object as it exists in TCA.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Event Id

Number

TCA identifier for the OrganizationDTO Customer business object.

x

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Get Email

<oracle-ebs:get-email>

Extracts a particular EmailDTO business object from TCA. You pass the object’s identification information to the operation, and it returns the identified business object as it exists in TCA.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

Number

TCA identifier for the EmailDTO business object.

x

Orig Sys

String

EmailDTO original system name.

Orig Sys Ref

String

EmailDTO original system reference.

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Get Location

<oracle-ebs:get-location>

Extracts a particular LocationDTO business object from TCA. You pass the object’s identification information to the operation, and it returns the identified business object as it exists in TCA.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

Number

TCA identifier for the LocationDTO business object.

x

Orig Sys

String

LocationDTO original system name.

Orig Sys Ref

String

LocationDTO original system reference.

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Get Organization

<oracle-ebs:get-organization>

Extracts a particular OrganizationDTO business object from TCA. You pass the object’s identification information to the operation, and it returns the identified business object as it exists in TCA.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

Number

TCA identifier for the OrganizationDTO business object.

x

Orig Sys

String

OrganizationDTO original system name.

Orig Sys Ref

String

OrganizationDTO original system reference.

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Get Organization Contact

<oracle-ebs:get-organization-contact>

Extracts a particular OrgContactDTO business object from TCA. You pass the object’s identification information to the operation, and it returns the identified business object as it exists in TCA.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

Number

TCA identifier for the OrganizationDTO Contact business object.

x

Orig Sys

String

OrganizationDTO Contact original system name.

Orig Sys Ref

String

OrganizationDTO Contact original system reference.

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Get Organization Customer

<oracle-ebs:get-organization-customer>

Extracts a particular OrgCustomerDTO business object from TCA. You pass the object’s identification information to the operation, and it returns the identified business object as it exists in TCA.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

Number

TCA identifier for the OrganizationDTO Customer business object.

x

Orig Sys

String

Parent object original system name.

Orig Sys Ref

String

Parent object original system reference.

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Get Organizations Created

<oracle-ebs:get-organizations-created>

Extracts a particular OrganizationDTO business object from TCA. You pass the Oracle Business Event System event’s identification information to the operation, and it returns the identified business object as it exists in TCA.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Event Id

Number

ID of BES event’s raised when this business object was created.

x

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Get Organizations Updated

<oracle-ebs:get-organizations-updated>

Extracts a particular OrganizationDTO business object from TCA. You pass the Oracle Business Event System event’s identification information to the operation, and it returns the identified business object as it exists in TCA.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Event Id

Number

ID of BES event’s raised when this business object was updated.

x

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Get Party Site

<oracle-ebs:get-party-site>

Extracts a particular Party Site business object from TCA. You pass the object’s identification information to the operation, and it returns the identified business object as it exists in TCA.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

Number

TCA identifier for the Party Site business object.

x

Orig Sys

String

Party Site original system name.

Orig Sys Ref

String

Party Site original system reference.

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Get Person

<oracle-ebs:get-person>

Extracts a particular PersonDTO business object from TCA. You pass the object’s identification information to the operation, and it returns the identified business object as it exists in TCA.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

Number

TCA identifier for the PersonDTO business object.

x

Orig Sys

String

PersonDTO original system name.

Orig Sys Ref

String

PersonDTO original system reference.

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Get Person Customer

<oracle-ebs:get-person-customer>

Extracts a particular PersonCustomerDTO business object from TCA. You pass the object’s identification information to the operation, and it returns the identified business object as it exists in TCA.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

Number

TCA identifier for the PersonDTO Customer business object.

x

Orig Sys

String

PersonDTO Customer original system name.

Orig Sys Ref

String

PersonDTO Customer original system reference.

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Get Person Customers Created

<oracle-ebs:get-person-customers-created>

Extracts a particular PersonDTO Customer Created business object from TCA. You pass the object’s identification information to the operation, and it returns the identified business object as it exists in TCA.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Event Id

Number

ID of BES event’s raised when this object was created.

x

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Get Person Customers Updated

<oracle-ebs:get-person-customers-updated>

Extracts a particular PersonDTO Customer Updated business object from TCA. You pass the object’s identification information to the operation, and it returns the identified business object as it exists in TCA.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Event Id

Number

ID of BES event’s raised when this object was updated.

x

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Get Persons Created

<oracle-ebs:get-persons-created>

Extracts a particular PersonDTO Created business object from TCA. You pass the object’s identification information to the operation, and it returns the identified business object as it exists in TCA.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Event Id

Number

ID of BES event’s raised when this business object was created.

x

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Get Persons Updated

<oracle-ebs:get-persons-updated>

Extracts a particular PersonDTO Updated business object from TCA. You pass the object’s identification information to the operation, and it returns the identified business object as it exists in TCA.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Event Id

Number

of BES event’s raised when this business object was updated.

x

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Get Phone

<oracle-ebs:get-phone>

Extracts a particular PhoneDTO business object from TCA. You pass the object’s identification information to the operation, and it returns the identified business object as it exists in TCA.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

Number

TCA identifier for the PhoneDTO business object.

x

Orig Sys

String

PhoneDTO original system name.

Orig Sys Ref

String

PhoneDTO original system reference.

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Get Relationship

<oracle-ebs:get-relationship>

Extracts a particular RelationshipDTO business object from TCA. You pass the object’s identification information to the operation, and it returns the identified business object as it exists in TCA.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

Number

TCA identifier for the RelationshipDTO business object.

x

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Get Updated Organization Customers

<oracle-ebs:get-updated-organization-customers>

Extracts a particular OrganizationDTO customers object from TCA. You pass the Oracle Business Event System event’s identification information to the operation, and it returns the identified business object as it exists in TCA.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Event Id

Number

TCA identifier for the OrganizationDTO Customer business object.

x

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Get Web

<oracle-ebs:get-web>

Extracts a particular WebDTO business object from TCA. You pass the object’s identification information to the operation, and it returns the identified business object as it exists in TCA.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

Number

TCA identifier for the WebDTO business object.

x

Orig Sys

String

WebDTO original system name.

Sys Ref

String

WebDTO original system reference.

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:RETRY_EXHAUSTED

Save Email

<oracle-ebs:save-email>

Saves a EmailDTO business object. You pass new or modified object data to the operation, packaged within an object type defined specifically for the business operation. The service then determines if the object exists in TCA, based upon the provided identification information, and creates or updates the object. For either case, the object type that you provide is processed as if the respective API procedure is being called (createEmail or updateEmail). See those operations for more details. In addition to the object’s business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

The EmailDTO business object (in json format) to be saved.

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Save Location

<oracle-ebs:save-location>

Saves a LocationDTO business object. You pass new or modified object data to the operation, packaged within an object type defined specifically for the business operation. The service then determines if the object exists in TCA, based upon the provided identification information, and creates or updates the object. For either case, the object type that you provide is processed as if the respective API procedure is being called (createLocation or updateLocation). See those operations for more details. In addition to the object’s business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

The LocationDTO business object (in json format) to be saved.

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Save Organization

<oracle-ebs:save-organization>

Saves a OrganizationDTO business object. You pass new or modified object data to the operation, packaged within an object type defined specifically for the business operation. The service then determines if the object exists in TCA, based upon the provided identification information, and creates or updates the object. For either case, the object type that you provide is processed as if the respective API procedure is being called (createOrganization or updateOrganization). See those operations for more details. In addition to the object’s business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Save Organization Contact

<oracle-ebs:save-organization-contact>

Saves a OrgContactDTO business object. You pass new or modified object data to the operation, packaged within an object type defined specifically for the business operation. The service then determines if the object exists in TCA, based upon the provided identification information, and creates or updates the object. For either case, the object type that you provide is processed as if the respective API procedure is being called (createOrgContact or updateOrgContact). See those operations for more details. In addition to the object’s business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Save Organization Customer

<oracle-ebs:save-organization-customer>

Saves a OrgCustomerDTO business object. You pass new or modified object data to the operation, packaged within an object type defined specifically for the business operation. The service then determines if the object exists in TCA, based upon the provided identification information, and creates or updates the object. For either case, the object type that you provide is processed as if the respective API procedure is being called (createOrgCustomer or updateOrgCustomer). See those operations for more details. In addition to the object’s business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Save Party Site

<oracle-ebs:save-party-site>

Saves a Party Site business object. You pass new or modified object data to the operation, packaged within an object type defined specifically for the business operation. The service then determines if the object exists in TCA, based upon the provided identification information, and creates or updates the object. For either case, the object type that you provide is processed as if the respective API procedure is being called (createPartySite or updatePartySite). See those operations for more details. In addition to the object’s business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Save Person

<oracle-ebs:save-person>

Saves a PersonDTO business object. You pass new or modified object data to the operation, packaged within an object type defined specifically for the business operation. The service then determines if the object exists in TCA, based upon the provided identification information, and creates or updates the object. For either case, the object type that you provide is processed as if the respective API procedure is being called (createPerson or updatePerson). See those operations for more details. In addition to the object’s business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Save Person Customer

<oracle-ebs:save-person-customer>

Saves a PersonDTO Customer business object. You pass new or modified object data to the operation, packaged within an object type defined specifically for the business operation. The service then determines if the object exists in TCA, based upon the provided identification information, and creates or updates the object. For either case, the object type that you provide is processed as if the respective API procedure is being called (createPersonCustomer or updatePersonCustomer). See those operations for more details. In addition to the object’s business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Save Phone

<oracle-ebs:save-phone>

Saves a PhoneDTO business object. You pass new or modified object data to the operation, packaged within an object type defined specifically for the business operation. The service then determines if the object exists in TCA, based upon the provided identification information, and creates or updates the object. For either case, the object type that you provide is processed as if the respective API procedure is being called (createPhone or updatePhone). See those operations for more details. In addition to the object’s business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Save Relationship

<oracle-ebs:save-relationship>

Saves a RelationshipDTO business object. You pass new or modified object data to the operation, packaged within an object type defined specifically for the business operation. The service then determines if the object exists in TCA, based upon the provided identification information, and creates or updates the object. For either case, the object type that you provide is processed as if the respective API procedure is being called (createRelationship or updateRelationship). See those operations for more details. In addition to the object’s business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Save Web

<oracle-ebs:save-web>

Saves a PhoneDTO business object. You pass new or modified object data to the operation, packaged within an object type defined specifically for the business operation. The service then determines if the object exists in TCA, based upon the provided identification information, and creates or updates the object. For either case, the object type that you provide is processed as if the respective API procedure is being called (createWeb or updateWeb). See those operations for more details. In addition to the object’s business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:RETRY_EXHAUSTED

Update Email

<oracle-ebs:update-email>

Updates a EmailDTO business object. You pass any modified object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object’s business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

The EmailDTO business object (in json format) to be updated.

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Update Location

<oracle-ebs:update-location>

Updates a LocationDTO business object. You pass any modified object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object’s business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

The LocationDTO business object (in json format) to be updated.

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Update Organization

<oracle-ebs:update-organization>

Updates a OrganizationDTO business object. You pass any modified object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object’s business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Update Organization Contact

<oracle-ebs:update-organization-contact>

Updates a OrgContactDTO business object. You pass any modified object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object’s business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Update Organization Customer

<oracle-ebs:update-organization-customer>

Updates a OrgCustomerDTO business object. You pass any modified object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object’s business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Update Party Site

<oracle-ebs:update-party-site>

Updates a Party Site business object. You pass any modified object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object’s business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Update Person

<oracle-ebs:update-person>

Updates a PersonDTO business object. You pass any modified object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object’s business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Update Person Customer

<oracle-ebs:update-person-customer>

Updates a PersonDTO Customer business object. You pass any modified object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object’s business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Update Phone

<oracle-ebs:update-phone>

Updates a PhoneDTO business object. You pass any modified object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object’s business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Update Relationship

<oracle-ebs:update-relationship>

Updates a RelationshipDTO business object. You pass any modified object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object’s business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CANNOT_REACH

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:ILLEGAL_ARGUMENT

  • ORACLE-EBS:INVALID_CREDENTIALS

  • ORACLE-EBS:IO_EXCEPTION

  • ORACLE-EBS:PASSWORD

  • ORACLE-EBS:RETRY_EXHAUSTED

  • ORACLE-EBS:UNKNOWN

  • ORACLE-EBS:UNSUPPORTED_OPERATION

Update Web

<oracle-ebs:update-web>

Updates a WebDTO business object. You pass any modified object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object’s business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

String

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:RETRY_EXHAUSTED

Xml Gateway

<oracle-ebs:xml-gateway>

Enqueues a message via XML Gateway Inbound.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Message Type

String

Payload message format. This defaults to XML. Oracle XML Gateway currently supports only XML.

XML

Message Standard

String

Message format standard as displayed in the Define Transactions form and entered in the Define XML Standards form. This defaults to OAG.

OAG.

Transaction Type

String

External Transaction Type for the business document from the Trading Partner table.

x

Transaction Subtype

String

External Transaction Subtype for the business document from the Trading Partner table.

x

Document Number

String

The document identifier used to identify the transaction, such as a purchase order or invoice number. This parameter is not used by the XML Gateway, but it may be passed on inbound messages. Optional.

Party Id

String

The party identifier. Optional.

Party Site Id

String

The party site identifier for the inbound XML document.

x

Body

Any

The payload to be enqueued.

#[payload]

Target Variable

String

The name of a variable on which the operation’s output is placed.

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • web-services-config

Throws

  • ORACLE-EBS:CONNECTIVITY

  • ORACLE-EBS:RETRY_EXHAUSTED

Sources

Business Events Source

<oracle-ebs:business-events-source>

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Durable Subscription

Boolean

false.

Subscription Name

String

Redelivery Policy

RedeliveryPolicy

Defines a policy for processing the redelivery of the same message.

Streaming Strategy

  • repeatable-in-memory-stream

  • repeatable-file-store-stream

  • non-repeatable-stream

Configure if repeatable streams should be used and their behaviour.

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Any

For Configurations

  • jms-config

Xml Gateway Outbound Source

<oracle-ebs:xml-gateway-outbound-source>

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Redelivery Policy

RedeliveryPolicy

Defines a policy for processing the redelivery of the same message.

Streaming Strategy

  • repeatable-in-memory-stream

  • repeatable-file-store-stream

  • non-repeatable-stream

Configure if repeatable streams should be used and their behaviour.

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Any

For Configurations

  • jms-config

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 fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

  • reconnect

  • reconnect-forever

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

Redelivery Policy

Field Type Description Default Value Required

Max Redelivery Count

Number

The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message

Message Digest Algorithm

String

The secure hashing algorithm to use. If not set, the default is SHA-256.

Id Expression

String

Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false.

Object Store

ObjectStore

The object store where the redelivery counter for each message is going to be stored.

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

This is the amount of memory to allocate to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it expands by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, and that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

Max Buffer Size

Number

This is the maximum amount of memory to use. If more than that is used, then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

Repeatable File Store Stream

Field Type Description Default Value Required

Max In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it starts to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed