org.mule.modules.oracle

oracle-ebs-connector

config

Namespace	http://www.mulesoft.org/schema/mule/oracle-ebs
Schema Location	http://www.mulesoft.org/schema/mule/oracle-ebs/current/mule-oracle-ebs.xsd (View Schema)
Schema Version	1.0
Minimum Mule Version	3.7

Module Overview

Extracts a particular OrgCustomer 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.

Summary

Configuration
<oracle-ebs:config> Configure an instance of this module

Message Sources
<oracle-ebs:business-events> Subscribes to the `WF_JMS_JMS_OUT` topic and retrieves any business event enqueued to it.
<oracle-ebs:xml-gateway-outbound> Subscribes to the `ECX_OUTBOUND` queue and retrieves any messages enqueued to it.

Message Processors
<oracle-ebs:create-email> Creates a Email business object.
<oracle-ebs:create-location> Creates a Location business object.
<oracle-ebs:create-organization> Creates a Organization business object.
<oracle-ebs:create-organization-contact> Creates a OrgContact business object.
<oracle-ebs:create-organization-customer> Creates an Organization Customer business object.
<oracle-ebs:create-party-site> Creates a Party Site business object.
<oracle-ebs:create-person> Creates a Person business object.
<oracle-ebs:create-person-customer> Creates a Person Customer business object.
<oracle-ebs:create-phone> Creates a Phone business object.
<oracle-ebs:create-relationship> Creates a Relationship business object.
<oracle-ebs:create-web> Creates a Web business object.
<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.
<oracle-ebs:get-email> Extracts a particular Email business object from TCA.
<oracle-ebs:get-location> Extracts a particular Location business object from TCA.
<oracle-ebs:get-organization> Extracts a particular Organization business object from TCA.
<oracle-ebs:get-organization-contact> Extracts a particular OrgContact business object from TCA.
<oracle-ebs:get-organization-customer> Extracts a particular OrgCustomer business object from TCA.
<oracle-ebs:get-organization-customers-created> Extracts a particular Organization Customer object from TCA.
<oracle-ebs:get-organization-customers-updated> Extracts a particular Organization customers object from TCA.
<oracle-ebs:get-organizations-created> Extracts a particular Organization business object from TCA.
<oracle-ebs:get-organizations-updated> Extracts a particular Organization business object from TCA.
<oracle-ebs:get-party-site> Extracts a particular Party Site business object from TCA.
<oracle-ebs:get-person> Extracts a particular Person business object from TCA.
<oracle-ebs:get-person-customer> Extracts a particular PersonCustomer business object from TCA.
<oracle-ebs:get-person-customers-created> Extracts a particular Person Customer Created business object from TCA.
<oracle-ebs:get-person-customers-updated> Extracts a particular Person Customer Updated business object from TCA.
<oracle-ebs:get-persons-created> Extracts a particular Person Created business object from TCA.
<oracle-ebs:get-persons-updated> Extracts a particular Person Updated business object from TCA.
<oracle-ebs:get-phone> Extracts a particular Phone business object from TCA.
<oracle-ebs:get-relationship> Extracts a particular Relationship business object from TCA.
<oracle-ebs:get-web> Extracts a particular Web business object from TCA.
<oracle-ebs:invoke-pl-sql> Calls a PL/SQL web service.
<oracle-ebs:save-email> Saves a Email business object.
<oracle-ebs:save-location> Saves a Location business object.
<oracle-ebs:save-organization> Saves a Organization business object.
<oracle-ebs:save-organization-contact> Saves a OrgContact business object.
<oracle-ebs:save-organization-customer> Saves a OrgCustomer business object.
<oracle-ebs:save-party-site> Saves a Party Site business object.
<oracle-ebs:save-person> Saves a Person business object.
<oracle-ebs:save-person-customer> Saves a Person Customer business object.
<oracle-ebs:save-phone> Saves a Phone business object.
<oracle-ebs:save-relationship> Saves a Relationship business object.
<oracle-ebs:save-web> Saves a Phone business object.
<oracle-ebs:update-email> Updates a Email business object.
<oracle-ebs:update-location> Updates a Location business object.
<oracle-ebs:update-organization> Updates a Organization business object.
<oracle-ebs:update-organization-contact> Updates a OrgContact business object.
<oracle-ebs:update-organization-customer> Updates a OrgCustomer business object.
<oracle-ebs:update-party-site> Updates a Party Site business object.
<oracle-ebs:update-person> Updates a Person business object.
<oracle-ebs:update-person-customer> Updates a Person Customer business object.
<oracle-ebs:update-phone> Updates a Phone business object.
<oracle-ebs:update-relationship> Updates a Relationship business object.
<oracle-ebs:update-web> Updates a Web business object.
<oracle-ebs:xml-gateway> Enqueues a message via XML Gateway Inbound.

Configuration

To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:

<mule xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:oracle-ebs="http://www.mulesoft.org/schema/mule/oracle-ebs"
      xsi:schemaLocation="
               http://www.mulesoft.org/schema/mule/core
               http://www.mulesoft.org/schema/mule/core/current/mule.xsd
               http://www.mulesoft.org/schema/mule/oracle-ebs
               http://www.mulesoft.org/schema/mule/oracle-ebs/current/mule-oracle-ebs.xsd">

      <!-- here goes your flows and configuration elements -->

</mule>

Message Processors

<oracle-ebs:create-email>

Creates a Email 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.

 XML Sample
<oracle-ebs:create-email config-ref="OracleEBS__ConnectionManagement" createdByModule="TCA_V2_API" parentId="1000" parentObjType="ORG" validateObjFlag="N">
    <oracle-ebs:email actionType="CREATE" origSystem="SST" origSystemReference="Salesforce"
                        status="A" parentObjectType="PERSON" parentObjectId="401749"
                        primaryFlag="N" contactPointPurpose="BUSINESS" primaryByPurpose="N"
                      	actualContentSource="USER_ENTERED" emailFormat="MAILHTML" emailAddress="test@test.com">
        <oracle-ebs:contact-pref-objs>
            <oracle-ebs:contact-pref-obj
                    actionType="CREATE"
            		parentObjectType="PERSON"
            		parentObjectId="401749"
            		contactType="EMAIL"
            		preferenceCode="DO_NOT"
            		preferenceStartDate="#[payload.yesterday]"
            		preferenceStartTimeHr="10"
            		preferenceEndTimeHr="22"
            		preferenceStartTimeMi="0"
            		preferenceEndTimeMi="0"
            		requestedBy="PARTY"
            		status="A"
            		/>
        </oracle-ebs:contact-pref-objs>
    </oracle-ebs:email>
</oracle-ebs:create-email>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
email	#[payload]	The Email business object to be created	Email	/
createdByModule		Optional. The module saving this business object	String	/	UTF-8
parentId		Optional. TCA identifier for parent object. Either this parameter, or both the parentOrigSys and parentOrigSysRef parameters, must be given	BigDecimal	/
parentOrigSys		Optional. Parent object original system name	String	/	UTF-8
parentOrigSysRef		Optional. Parent object original system reference	String	/	UTF-8
parentObjType		Optional. Parent object type. Validated against HZ_BUSINESS_OBJECTS lookup type	String	/	UTF-8
validateObjFlag		Optional. Indicates if the passed business object is to be validated for completeness if it is being created	String	/	UTF-8
objSource		Optional. The originating source system of the object create operation	String	/	UTF-8

Returns

Return Type	Description
Email	The Email business object that was created, returned as an output parameter

<oracle-ebs:create-location>

Creates a Location 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.

 XML Sample
<oracle-ebs:create-location config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:location origSystemReference="GK1234"
        country="US"
        address1="Address Value"
        city="Maysville"
        postalCode="41056"
        county="Mason"
        addressKey="adressKeyValue"
        validatedFlag="N"
        />
</oracle-ebs:create-location>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
location	#[payload]	The Location business object to be created.	Location	/
createdByModule		Optional. The module Saving this business object.	String	/	UTF-8
objSource		Optional. Source system invokes the service on this Organization.	String	/	UTF-8
validateObjFlag		Optional. Indicates if the passed business object is to be validated for completeness if it is being saved.	String	/	UTF-8

Returns

Return Type	Description
Location	Create location result

<oracle-ebs:create-organization>

Creates a Organization 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.

 XML Sample
<oracle-ebs:create-organization createdByModule="HZ_WS" config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:organization origSystem="SST" origSystemReference="System"
         validatedFlag="Y" status="A"
         categoryCode="MANUFACTURING" organizationName="MyOrganization"
         organizationType="ORGANIZATION"/>
</oracle-ebs:create-organization>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
organization	#[payload]	The Organization business object to be created.	Organization	/
createdByModule		Optional. The module creating this business object.	String	/	UTF-8
objSource		Optional. Source system invokes the service on this Organization.	String	/	UTF-8
validateObjFlag		Optional. Indicates if the passed business object is to be validated for completeness if it is being created	String	/	UTF-8

Returns

Return Type	Description
Organization	The Organization business object that was created.

<oracle-ebs:create-organization-contact>

Creates a OrgContact 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.

 XML Sample
<oracle-ebs:create-organization-contact createdByModule="TCA_V1_API" validateObjFlag="Y" parentId="401799" config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:contact actionType="CREATE" organizationId="401799" origSystem="SST" origSystemReference="OrganizationRef" comments="Comments about contact"
        relationshipCode="CONTACT_OF" relationshipType="CONTACT" relationshipComments="Relationship Comments"
        startDate="#[payload.yesterday]" status="A">
            <oracle-ebs:contact-pref-objs>
                 <oracle-ebs:contact-pref-obj parentObjectType="ORG"
                     parentObjectId="401799"
                     contactType="MAIL"
                     preferenceCode="DO_NOT"
                     preferenceStartDate="#[payload.yesterday]"
                     preferenceStartTimeHr="09"
                     preferenceEndTimeHr="22"
                     preferenceStartTimeMi="0" preferenceEndTimeMi="0"
                     requestedBy="INTERNAL"
                     status="A"/>
             </oracle-ebs:contact-pref-objs>
            <oracle-ebs:org-contact-role-objs>
                 <oracle-ebs:org-contact-role-obj origSystem="SST"
                     origSystemReference="ORGCONTROLE1234"
                     roleType="CONTACT"
                     primaryFlag="N"
                     roleLevel="N"
                     primaryContactPerRoleType="N" status="A"/>
            </oracle-ebs:org-contact-role-objs>
            <oracle-ebs:person-profile-obj origSystem="SST"
                 origSystemReference="PERSON1234"
                 validatedFlag="N"
                 status="A"
                 personFirstName="Foo"
                 personMiddleName="F."
                 personLastName="Foo"
                 deceasedFlag="N"/>
    </oracle-ebs:contact>
</oracle-ebs:create-organization-contact>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
contact	#[payload]	The Organization Contact business object to be created	OrgContact	/
parentId		Optional. TCA identifier for parent object. Either this parameter, or both the parentOrigSys and parentOrigSysRef parameters, must be given	BigDecimal	/
parentOrigSys		Optional. Parent object original system name	String	/	UTF-8
parentOrigSysRef		Optional. Parent object original system reference	String	/	UTF-8
validateObjFlag		Optional. Indicates if the passed business object is to be validated for completeness if it is being created	String	/	UTF-8
objSource		Optional. The originating source system of the object create operation	String	/	UTF-8
createdByModule		Optional. The module saving this business object	String	/	UTF-8

Returns

Return Type	Description
OrgContact	The Organization Contact business object that was created, returned as an output parameter

<oracle-ebs:create-organization-customer>

Creates an Organization 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.

 XML Sample
<oracle-ebs:create-organization-customer createdByModule="TCA_V1_API" validateObjFlag="N" config-ref="OracleEBS__ConnectionManagement">
	<oracle-ebs:customer actionType="CREATE">
	    <oracle-ebs:account-objs>
	        <oracle-ebs:account-obj
                actionType="CREATE" origSystem="SST"
                origSystemReference="OrigSys" status="A"
                customerType="R" customerClassCode="High Technology"
                salesChannelCode="COMMERCIAL"   priceListId="1000"
                fobPoint="Destination" shipPartial="Y"
                warehouseId="207" taxRoundingRule="NEAREST"
                accountName="myAccount" comments="Webservice Test"
                shipSetsIncludeLinesFlag="N" createdByModule="TCA_V1_API">
                <oracle-ebs:cust-profile-obj
                    actionType="CREATE"
                    status="A"
                    creditAnalystId="10035"
                    creditChecking="N"
                    tolerance="10"
                    discountTerms="Y"
                    dunningLetters="N"
                    interestCharges="N"
                    sendStatements="Y"
                    creditBalanceStatements="Y"
                    creditHold="N"
                    profileClassId="2103"
                    creditRating="Excellent"
                    riskCode="Low"
                    standardTerms="1042"
                    overrideTerms="Y"
                    dunningLetterSetId="1"
                    interestPeriodDays="30"
                    paymentGraceDays="0"
                    discountGraceDays="0"
                    statementCycleId="1000"
                    accountStatus="Preferred"
                    percentCollectable="99"
                    taxPrintingOption="TOTAL ONLY"
                    chargeOnFinChargeFlag="N"
                    groupingRuleId="-1"
                    consInvFlag="N"
                    consInvType="DETAIL"
                    reviewCycle="MONTHLY"
                    creditClassification="LOW"/>
            </oracle-ebs:account-obj>
	    </oracle-ebs:account-objs>
	</oracle-ebs:customer>
</oracle-ebs:create-organization-customer>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
customer	#[payload]	The Organization Customer business object to be created	OrgCustomer	/
createdByModule		Optional. The module updating this business object	String	/	UTF-8
objSource		Optional. The originating source system of the object save operation	String	/	UTF-8
validateObjFlag	true	Indicates if the passed business object is to be validated for completeness. Default value: true	String	/	UTF-8

Returns

Return Type	Description
OrgCustomer	The Organization Customer business object that was created, returned as an output parameter

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

 XML Sample
<oracle-ebs:create-party-site createdByModule="TCA_V1_API" parentId="4429" parentObjType="ORG" config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:party-site
        actionType="CREATE"
        origSystem="SST"
        origSystemReference="OrigSystemRef"
        parentObjectType="ORG"
        parentObjectId="4429"
        identifyingAddressFlag="N"
        status="A"
        partySiteName="GKPARTYSITE1234"
        createdByModule="TCA_V1_API">
        <oracle-ebs:contact-pref-objs>
            <oracle-ebs:contact-pref-obj
                parentObjectType="PARTY_SITE"
                contactType="MAIL"
                preferenceCode="DO_NOT"
                requestedBy="INTERNAL"
                status="A"
                createdByModule="TCA_V1_API"/>
        </oracle-ebs:contact-pref-objs>
        <oracle-ebs:location-obj
                country="US"
                address1="11 Imaging Place"
                city="Oakdale"
                postalCode="55128-3414"
                state="MN"
                county="Washington"
                salesTaxInsideCityLimits="1"/>
        <oracle-ebs:party-site-use-objs>
            <oracle-ebs:party-site-use-obj
                siteUseType="BILL_TO"
                primaryPerType="Y"
                status="A"/>
            <oracle-ebs:party-site-use-obj
                    siteUseType="SHIP_TO"
                    primaryPerType="Y"
                    status="A"/>
        </oracle-ebs:party-site-use-objs>
    </oracle-ebs:party-site>
</oracle-ebs:create-party-site>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
partySite	#[payload]	The Party Site business object to be created	PartySite	/
createdByModule		Optional. The module creating this business object	String	/	UTF-8
parentId		Optional. TCA identifier for parent object. Either this parameter, or both the parentOrigSys and parentOrigSysRef parameters, must be given	BigDecimal	/
parentOrigSys		Optional. Parent object original system name	String	/	UTF-8
parentOrigSysRef		Optional. Parent object original system reference	String	/	UTF-8
parentObjType		Optional. Parent object type. Validated against HZ_BUSINESS_OBJECTS lookup type	String	/	UTF-8
objSource		Optional. The originating source system of the object create operation	String	/	UTF-8
validateObjFlag		Optional. Indicates if the passed business object is to be validated for completeness if it is being created	String	/	UTF-8

Returns

Return Type	Description
PartySite	The Party Site business object that was created, returned as an output parameterThe Party Site business object that was created, returned as an output parameter

<oracle-ebs:create-person>

Creates a Person 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.

 XML Sample
<oracle-ebs:create-person createdByModule="TCA_V2_API" validateObjFlag="N" config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:person
        actionType="CREATE"
        origSystem="SST"
        origSystemReference="#[map-payload:origSystemReferebce]"
        validatedFlag="N"
        status="A"
        categoryCode="PROFESSIONAL"
        salutation="Dr."
        personPreNameAdjunct="MR."
        personFirstName="John"
        personMiddleName="B"
        personLastName="Power"
        personNameSuffix="PMP"
        personTitle="Mr"
        personIdenType="DRIVERS_LICENSE"
        personIdentifier="xxxxxxxxx"
        dateOfBirth="#[map-payload:dateOfBirth]"
        placeOfBirth="Kansas"
        deceasedFlag="N"/>
</oracle-ebs:create-person>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
person	#[payload]	The Person business object to be created	Person	/
createdByModule		Optional. The module creating this business object	String	/	UTF-8
objSource		Optional. The originating source system of the object create operation	String	/	UTF-8
validateObjFlag		Optional. Indicates if the passed business object is to be validated for completeness if it is being created	String	/	UTF-8

Returns

Return Type	Description
Person	The Person business object that was created, returned as an output parameter

<oracle-ebs:create-person-customer>

Creates a Person 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.

 XML Sample
<oracle-ebs:create-person-customer createdByModule="TCA_V2_API" validateObjFlag="N" config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:person-customer actionType="CREATE">
        <oracle-ebs:account-objs>
            <oracle-ebs:account-obj actionType="CREATE"
                origSystem="SST"
                origSystemReference="SysRef"
                status="A"
                customerType="R"
                customerClassCode="High Technology"
                salesChannelCode="COMMERCIAL"
                priceListId="1000"
                fobPoint="Destination"
                shipPartial="Y"
                warehouseId="207"
                taxRoundingRule="NEAREST"
                accountName="AccName"
                comments="From Webservice"
                shipSetsIncludeLinesFlag="N"
                createdByModule="TCA_V1_API">
                <oracle-ebs:cust-profile-obj
                    actionType="CREATE"
                    status="A"
                    creditAnalystId="10035"
                    creditChecking="N"
                    tolerance="10"
                    discountTerms="Y"
                    dunningLetters="N"
                    interestCharges="N"
                    sendStatements="Y"
                    creditBalanceStatements="Y"
                    creditHold="N"
                    profileClassId="2103"
                    creditRating="Excellent"
                    riskCode="Low"
                    standardTerms="1042"
                    overrideTerms="Y"
                    dunningLetterSetId="1"
                    interestPeriodDays="30"
                    paymentGraceDays="0"
                    discountGraceDays="0"
                    statementCycleId="1000"
                    accountStatus="Preferred"
                    percentCollectable="99"
                    taxPrintingOption="TOTAL ONLY"
                    chargeOnFinChargeFlag="N"
                    groupingRuleId="-1"
                    consInvFlag="N"
                    consInvType="DETAIL"
                    reviewCycle="MONTHLY"
                    creditClassification="LOW"/>
            </oracle-ebs:account-obj>
        </oracle-ebs:account-objs>
        <oracle-ebs:person-obj actionType="CREATE"
        		origSystem="SST"
        		origSystemReference="SystemRef"
        		validatedFlag="N"
        		status="A"
        		categoryCode="PROFESSIONAL"
        		salutation="Dr."
        		personPreNameAdjunct="MR."
        		personFirstName="John"
        		personMiddleName="B"
        		personLastName="Foo"
        		personNameSuffix="PMP"
        		personTitle="Mr"
        		personIdenType="DRIVERS_LICENSE"
        		personIdentifier="SomeId"
        		dateOfBirth="#[map-payload:dateOfBirth]"
        		placeOfBirth="Zumpa"
        		deceasedFlag="N"/>
    </oracle-ebs:person-customer>
</oracle-ebs:create-person-customer>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
personCustomer	#[payload]	The Person Customer business object to be created	PersonCustomer	/
createdByModule		Optional. The module saving this business object	String	/	UTF-8
objSource		Optional. Indicates if the passed business object is to be validated for completeness if it is being created	String	/	UTF-8
validateObjFlag		Optional. The originating source system of the object create operation	String	/	UTF-8

Returns

Return Type	Description
PersonCustomer	The Person Customer business object that was created, returned as an output parameter

<oracle-ebs:create-phone>

Creates a Phone 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.

 XML Sample
<oracle-ebs:create-phone createdByModule="TCA_V2_API" parentId="1000" parentObjType="ORG" validateObjFlag="N" config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:phone actionType="CREATE"
        origSystem="SST"
        origSystemReference="#[map-payload:origSystemRef]"
        status="A"
        parentObjectType="ORG"
        parentObjectId="1000"
        primaryFlag="N"
        contactPointPurpose="BUSINESS"
        primaryByPurpose="N"
        actualContentSource="USER_ENTERED"
        phoneAreaCode="650"
        phoneCountryCode="1"
        phoneNumber="797 7979"
        phoneExtension="8888"
        phoneLineType="GEN"/>
</oracle-ebs:create-phone>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
phone	#[payload]	The Phone business object to be created	Phone	/
createdByModule		Optional. The module saving this business object	String	/	UTF-8
parentId		Optional. TCA identifier for parent object. Either this parameter, or both the parentOrigSys and parentOrigSysRef parameters, must be given	BigDecimal	/
parentOrigSys		Optional. Parent object original system name	String	/	UTF-8
parentOrigSysRef		Optional. Parent object original system reference	String	/	UTF-8
parentObjType		Optional. Parent object type. Validated against HZ_BUSINESS_OBJECTS lookup type	String	/	UTF-8
validateObjFlag		Optional. Indicates if the passed business object is to be validated for completeness if it is being created	String	/	UTF-8
objSource		Optional. The originating source system of the object create operation	String	/	UTF-8

Returns

Return Type	Description
Phone	The Phone business object that was created, returned as an output parameter

<oracle-ebs:create-relationship>

Creates a Relationship 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.

 XML Sample
<oracle-ebs:create-relationship createdByModule="TCA_V2_API" config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:relationship actionType="CREATE"
        parentObjectType="PERSON"
        parentObjectId="402784"
        relatedObjectId="4429"
        relatedObjectType="ORG"
        relationshipCode="CONTACT_OF"
        relationshipType="CONTACT"
        comments="Comment added from from Webservice"
        startDate="#[map-payload:yesterday]"
        status="A"/>
</oracle-ebs:create-relationship>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
relationship	#[payload]	The Relationship business object to be created	Relationship	/
createdByModule		Optional. The module creating this business object	String	/	UTF-8

Returns

Return Type	Description
Relationship	The Relationship business object that was created, returned as an output parameter

<oracle-ebs:create-web>

Creates a Web 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.

 XML Sample
<oracle-ebs:create-web createdByModule="TCA_V2_API" parentId="1000" parentObjType="ORG" validateObjFlag="N" config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:web actionType="CREATE"
        origSystem="SST"
        origSystemReference="OrgiSysRef"
        status="A"
        parentObjectType="ORG"
        parentObjectId="1000"
        primaryFlag="N"
        contactPointPurpose="SALESURL"
        primaryByPurpose="N"
        actualContentSource="USER_ENTERED"
        webType="com"
        url="www.donotcontact.com"/>
</oracle-ebs:create-web>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
web	#[payload]	The Web business object to be created	Web	/
createdByModule		Optional. The module saving this business object	String	/	UTF-8
parentId		Optional. TCA identifier for parent object. Either this parameter, or both the parentOrigSys and parentOrigSysRef parameters, must be given	BigDecimal	/
parentOrigSys		Optional. Parent object original system name	String	/	UTF-8
parentOrigSysRef		Optional. Parent object original system reference	String	/	UTF-8
parentObjType		Optional. Parent object type. Validated against HZ_BUSINESS_OBJECTS lookup type	String	/	UTF-8
validateObjFlag		Optional. Indicates if the passed business object is to be validated for completeness if it is being created	String	/	UTF-8
objSource		Optional. The originating source system of the object create operation	String	/	UTF-8

Returns

Return Type	Description
Web	The Web business object that was created, returned as an output parameter

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

 XML Sample
<oracle-ebs:find-parties config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:body ref = "#[map-payload:body]"/>
</oracle-ebs:find-parties>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
body	#[payload]	The request	DqmSearchServiceFindParties	/

Returns

Return Type	Description
List<MatchedParty>	List of Matched Party objects.

<oracle-ebs:get-email>

Extracts a particular Email 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.

 XML Sample
<oracle-ebs:get-email id="#[map-payload:id]" config-ref="OracleEBS__ConnectionManagement"/>

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
id	TCA identifier for the Email business object	BigDecimal	/
origSys	Optional. Email original system name	String	/	UTF-8
origSysRef	Optional. Email original system reference	String	/	UTF-8

Returns

Return Type	Description
Email	The retrieved Email business object

<oracle-ebs:get-location>

Extracts a particular Location 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.

 XML Sample
<oracle-ebs:get-location id="#[map-payload:id]" config-ref="OracleEBS__ConnectionManagement"/>

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
id	TCA identifier for the Location business object.	BigDecimal	/
origSys	Optional. Location original system name.	String	/	UTF-8
origSysRef	Optional. Location original system reference.	String	/	UTF-8

Returns

Return Type	Description
Location	Get location result

<oracle-ebs:get-organization>

Extracts a particular Organization 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.

 XML Sample
<oracle-ebs:get-organization id="#[map-payload:id]" config-ref="OracleEBS__ConnectionManagement"/>

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
id	TCA identifier for the Organization business object	BigDecimal	/
origSys	Optional. Organization original system name	String	/	UTF-8
origSysRef	Optional. Organization original system reference	String	/	UTF-8

Returns

Return Type	Description
Organization	The retrieved ORGANIZATION business object.

<oracle-ebs:get-organization-contact>

Extracts a particular OrgContact 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.

 XML Sample
<oracle-ebs:get-organization-contact id="#[map-payload:id]" config-ref="OracleEBS__ConnectionManagement"/>

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
id	TCA identifier for the Organization Contact business object	BigDecimal	/
origSys	Optional. Organization Contact original system name	String	/	UTF-8
origSysRef	Optional. Organization Contact original system reference	String	/	UTF-8

Returns

Return Type	Description
OrgContact	The retrieved Organization Contact business object

<oracle-ebs:get-organization-customer>

Extracts a particular OrgCustomer 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.

 XML Sample
<oracle-ebs:get-organization-customer id="#[map-payload:id]" config-ref="OracleEBS__ConnectionManagement"/>

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
id	TCA identifier for the Organization Customer business object	BigDecimal	/
origSys	Optional. Parent object original system name.	String	/	UTF-8
origSysRef	Optional. Parent object original system reference.	String	/	UTF-8

Returns

Return Type	Description
OrgCustomer	The retrieved Organization Customer business object

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

Extracts a particular Organization 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.

 XML Sample
<oracle-ebs:get-organization-customers-created eventId="#[map-payload:id]" config-ref="OracleEBS__ConnectionManagement"/>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
eventId		TCA identifier for the Organization Customer business object	BigDecimal	/

Returns

Return Type	Description
List<OrgCustomer>	The retrieved Organization Customer business object

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

Extracts a particular Organization 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.

 XML Sample
<oracle-ebs:get-organization-customers-updated eventId="#[map-payload:id]" config-ref="OracleEBS__ConnectionManagement"/>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
eventId		TCA identifier for the Organization Customer business object	BigDecimal	/

Returns

Return Type	Description
List<OrgCustomer>	The retrieved Organization Customer business object

<oracle-ebs:get-organizations-created>

Extracts a particular Organization 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.

 XML Sample
<oracle-ebs:get-organizations-created  eventId="#[map-payload:id]" config-ref="OracleEBS__ConnectionManagement"/>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
eventId		ID of BES event's raised when this business object was created.	BigDecimal	/

Returns

Return Type	Description
List<Organization>	The retrieved Organization business object

<oracle-ebs:get-organizations-updated>

 XML Sample
<oracle-ebs:get-organizations-updated  eventId="#[map-payload:id]" config-ref="OracleEBS__ConnectionManagement"/>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
eventId		ID of BES event's raised when this business object was updated.	BigDecimal	/

Returns

Return Type	Description
List<Organization>	The retrieved organization business object.

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

 XML Sample
<oracle-ebs:get-party-site id="#[map-payload:id]" config-ref="OracleEBS__ConnectionManagement"/>

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
id	TCA identifier for the Party Site business object	BigDecimal	/
origSys	Optional. Party Site original system name	String	/	UTF-8
origSysRef	Optional. Party Site original system reference	String	/	UTF-8

Returns

Return Type	Description
PartySite	The retrieved Party Site business object

<oracle-ebs:get-person>

Extracts a particular Person 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.

 XML Sample
<oracle-ebs:get-person id="#[map-payload:id]" config-ref="OracleEBS__ConnectionManagement"/>

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
id	TCA identifier for the Person business object	BigDecimal	/
origSys	Optional. Person original system name	String	/	UTF-8
origSysRef	Optional. Person original system reference	String	/	UTF-8

Returns

Return Type	Description
Person	The retrieved Person business object

<oracle-ebs:get-person-customer>

Extracts a particular PersonCustomer 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.

 XML Sample
<oracle-ebs:get-person-customer id="#[map-payload:id]" config-ref="OracleEBS__ConnectionManagement"/>

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
id	TCA identifier for the Person Customer business object	BigDecimal	/
origSys	Optional. Person Customer original system name	String	/	UTF-8
origSysRef	Optional. Person Customer original system reference	String	/	UTF-8

Returns

Return Type	Description
PersonCustomer	The retrieved Person Customer business object

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

Extracts a particular Person 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.

 XML Sample
<oracle-ebs:get-person-customers-created eventId="#[map-payload:id]" config-ref="OracleEBS__ConnectionManagement"/>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
eventId		ID of BES event's raised when this object was created.	BigDecimal	/

Returns

Return Type	Description
List<PersonCustomer>	The retrieved Person Customer business object

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

Extracts a particular Person 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.

 XML Sample
<oracle-ebs:get-person-customers-updated eventId="#[map-payload:id]" config-ref="OracleEBS__ConnectionManagement"/>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
eventId		ID of BES event's raised when this object was updated.	BigDecimal	/

Returns

Return Type	Description
List<PersonCustomer>	The retrieved Person Customer business object

<oracle-ebs:get-persons-created>

Extracts a particular Person 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.

 XML Sample
<oracle-ebs:get-persons-created eventId="#[map-payload:id]" config-ref="OracleEBS__ConnectionManagement"/>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
eventId		ID of BES event's raised when this business object was created	BigDecimal	/

Returns

Return Type	Description
List<Person>	The retrieved Person business object

<oracle-ebs:get-persons-updated>

Extracts a particular Person 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.

 XML Sample
<oracle-ebs:get-persons-updated eventId="#[map-payload:id]" config-ref="OracleEBS__ConnectionManagement"/>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
eventId		Of BES event's raised when this business object was updated	BigDecimal	/

Returns

Return Type	Description
List<Person>	The retrieved Person business object

<oracle-ebs:get-phone>

Extracts a particular Phone 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.

 XML Sample
<oracle-ebs:get-phone id="#[map-payload:id]" config-ref="OracleEBS__ConnectionManagement"/>

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
id	TCA identifier for the Phone business object	BigDecimal	/
origSys	Optional. Phone original system name	String	/	UTF-8
origSysRef	Optional. Phone original system reference	String	/	UTF-8

Returns

Return Type	Description
Phone	The retrieved Phone business object

<oracle-ebs:get-relationship>

Extracts a particular Relationship 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.

 XML Sample
<oracle-ebs:get-relationship id="#[map-payload:id]" config-ref="OracleEBS__ConnectionManagement"/>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
id		TCA identifier for the Relationship business object	BigDecimal	/

Returns

Return Type	Description
Relationship	The retrieved Relationship business object

<oracle-ebs:get-web>

Extracts a particular Web 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.

 XML Sample
<oracle-ebs:get-web id="#[map-payload:id]" config-ref="OracleEBS__ConnectionManagement"/>

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
id	TCA identifier for the Web business object	BigDecimal	/
origSys	Optional. Web original system name	String	/	UTF-8
sysRef	Optional. Web original system reference	String	/	UTF-8

Returns

Return Type	Description
Web	The retrieved Web business object

<oracle-ebs:invoke-pl-sql>

Calls a PL/SQL web service.

 XML Sample
<oracle-ebs:invoke-pl-sql config-ref="OracleEBS__ConnectionManagement" type="FND_WEB_SEC#VALIDATE_LOGIN"/>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
type		A String with the following format: `WSDL_NAME\|\|WSDL_OPERATION_NAME`	String	/	UTF-8
input	#[payload]	Content to be processed. Cannot be null.	XMLStreamReader	/

Returns

Return Type	Description
XMLStreamReader	An XMLStreamReader with the service response.

<oracle-ebs:save-email>

Saves a Email 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 will be processed as if the respective API procedure is being called (createEmail or updateEmail). Please 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.

 XML Sample
<oracle-ebs:save-email config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:email actionType="CREATE" origSystem="SST" origSystemReference="Salesforce"
                                status="A" parentObjectType="PERSON" parentObjectId="401749"
                                primaryFlag="N" contactPointPurpose="BUSINESS" primaryByPurpose="N"
                              	actualContentSource="USER_ENTERED" emailFormat="MAILHTML" emailAddress="test@test.com">
        <oracle-ebs:contact-pref-objs>
            <oracle-ebs:contact-pref-obj
                    actionType="CREATE"
                    parentObjectType="PERSON"
                    parentObjectId="401749"
                    contactType="EMAIL"
                    preferenceCode="DO_NOT"
                    preferenceStartDate="#[payload.yesterday]"
                    preferenceStartTimeHr="10"
                    preferenceEndTimeHr="22"
                    preferenceStartTimeMi="0"
                    preferenceEndTimeMi="0"
                    requestedBy="PARTY"
                    status="A"
                    />
        </oracle-ebs:contact-pref-objs>
    </oracle-ebs:email>
</oracle-ebs:save-email>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
email	#[payload]	The Email business object to be saved	Email	/
createdByModule		Optional. The module saving this business object	String	/	UTF-8
parentId		Optional. TCA identifier for parent object. Either this parameter, or both the parentOrigSys and parentOrigSysRef parameters, must be given	BigDecimal	/
parentOrigSys		Optional. Parent object original system name	String	/	UTF-8
parentOrigSysRef		Optional. Parent object original system reference	String	/	UTF-8
parentObjType		Optional. Parent object type. Validated against HZ_BUSINESS_OBJECTS lookup type	String	/	UTF-8
validateObjFlag		Optional. Indicates if the passed business object is to be validated for completeness if it is being created	String	/	UTF-8
objSource		Optional. The originating source system of the object create operation	String	/	UTF-8

Returns

Return Type	Description
Email	The Email business object that was saved, returned as an output parameter

<oracle-ebs:save-location>

Saves a Location 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 will be processed as if the respective API procedure is being called (createLocation or updateLocation). Please 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.

 XML Sample
<oracle-ebs:save-location config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:location
        locationId="59486"
        origSystemReference="GK1234"
        country="US"
        address1="Address Value"
        city="Maysville"
        postalCode="41056"
        county="Mason"
        addressKey="adressKeyValue"
        validatedFlag="N"
        />
</oracle-ebs:save-location>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
location	#[payload]	The Location business object to be saved.	Location	/
createdByModule		Optional. The module saving this business object.	String	/	UTF-8
objSource		Optional. Source system invokes the service on this Organization.	String	/	UTF-8
validateObjFlag		Optional. Indicates if the passed business object is to be validated for completeness if it is being saved.	String	/	UTF-8

Returns

Return Type	Description
Location	The Location business object that was saved.

<oracle-ebs:save-organization>

Saves a Organization 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 will be processed as if the respective API procedure is being called (createOrganization or updateOrganization). Please 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.

 XML Sample
<oracle-ebs:save-organization config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:organization origSystem="SST" origSystemReference="System"
         validatedFlag="Y" status="I"
         categoryCode="MANUFACTURING" organizationName="MyOrganization"
         organizationType="ORGANIZATION"/>
</oracle-ebs:save-organization>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
organization	#[payload]	The Organization business object to be saved.	Organization	/
createdByModule		Optional. The module Saving this business object.	String	/	UTF-8
objSource		Optional. Source system invokes the service on this Organization.	String	/	UTF-8
validateObjFlag		Optional. Indicates if the passed business object is to be validated for completeness if it is being saved.	String	/	UTF-8

Returns

Return Type	Description
Organization	The Organization business object that was saved.

<oracle-ebs:save-organization-contact>

Saves a OrgContact 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 will be processed as if the respective API procedure is being called (createOrgContact or updateOrgContact). Please 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.

 XML Sample
<oracle-ebs:save-organization-contact config-ref="OracleEBS__ConnectionManagement">
            <oracle-ebs:contact actionType="CREATE" organizationId="401799" origSystem="SST" origSystemReference="OrganizationRef" comments="Comments about contact"
            		relationshipCode="CONTACT_OF" relationshipType="CONTACT" relationshipComments="Relationship Comments"
            		startDate="#[payload.yesterday]" status="A">
                <oracle-ebs:contact-pref-objs>
                    <oracle-ebs:contact-pref-obj parentObjectType="ORG"
                        parentObjectId="401799"
                        contactType="MAIL"
                        preferenceCode="DO_NOT"
                        preferenceStartDate="#[payload.yesterday]"
                        preferenceStartTimeHr="09"
                        preferenceEndTimeHr="22"
                        preferenceStartTimeMi="0" preferenceEndTimeMi="0"
                        requestedBy="INTERNAL"
                        status="A"
                    />
                </oracle-ebs:contact-pref-objs>
                <oracle-ebs:org-contact-role-objs>
                        <oracle-ebs:org-contact-role-obj origSystem="SST"
                            origSystemReference="ORGCONTROLE1234"
                            roleType="CONTACT"
                            primaryFlag="N"
                            roleLevel="N"
                            primaryContactPerRoleType="N" status="A"
                        />
                  </oracle-ebs:org-contact-role-objs>
                  <oracle-ebs:person-profile-obj origSystem="SST"
                        origSystemReference="PERSON1234"
                        validatedFlag="N"
                        status="A"
                        personFirstName="Foo"
                        personMiddleName="F."
                        personLastName="Foo"
                        deceasedFlag="N"/>
            </oracle-ebs:contact>
</oracle-ebs:save-organization-contact>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
contact	#[payload]	The Organization Contact business object to be saved	OrgContact	/
createdByModule		Optional. The module saving this business object	String	/	UTF-8
parentId		Optional. TCA identifier for parent object. Either this parameter, or both the parentOrigSys and parentOrigSysRef parameters, must be given	BigDecimal	/
parentOrigSys		Optional. Parent object original system name	String	/	UTF-8
parentOrigSysRef		Optional. Parent object original system reference	String	/	UTF-8
validateObjFlag		Optional. Indicates if the passed business object is to be validated for completeness if it is being created	String	/	UTF-8
objSource		Optional. The originating source system of the object save operation	String	/	UTF-8

Returns

Return Type	Description
OrgContact	The Organization Contact business object that was saved, returned as an output parameter

<oracle-ebs:save-organization-customer>

Saves a OrgCustomer 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 will be processed as if the respective API procedure is being called (createOrgCustomer or updateOrgCustomer). Please 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.

 XML Sample
<oracle-ebs:save-organization-customer createdByModule="TCA_V1_API" validateObjFlag="N" config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:customer actionType="UPDATE">
        <oracle-ebs:account-objs>
            <oracle-ebs:account-obj
                  actionType="UPDATE" origSystem="SST"
                  origSystemReference="OrigSys" status="A"
                  customerType="R" customerClassCode="High Technology"
                  salesChannelCode="COMMERCIAL"   priceListId="1000"
                  fobPoint="Destination" shipPartial="Y"
                  warehouseId="207" taxRoundingRule="NEAREST"
                  accountName="myAccount" comments="Webservice Test"
                  shipSetsIncludeLinesFlag="N" createdByModule="TCA_V1_API">
                  <oracle-ebs:cust-profile-obj
                          actionType="CREATE"
                          status="A"
                          creditAnalystId="10035"
                          creditChecking="N"
                          tolerance="10"
                          discountTerms="Y"
                          dunningLetters="N"
                          interestCharges="N"
                          sendStatements="Y"
                          creditBalanceStatements="Y"
                          creditHold="N"
                          profileClassId="2103"
                          creditRating="Excellent"
                          riskCode="Low"
                          standardTerms="1042"
                          overrideTerms="Y"
                          dunningLetterSetId="1"
                          interestPeriodDays="30"
                          paymentGraceDays="0"
                          discountGraceDays="0"
                          statementCycleId="1000"
                          accountStatus="Preferred"
                          percentCollectable="99"
                          taxPrintingOption="TOTAL ONLY"
                          chargeOnFinChargeFlag="N"
                          groupingRuleId="-1"
                          consInvFlag="N"
                          consInvType="DETAIL"
                          reviewCycle="MONTHLY"
                          creditClassification="LOW"/>
              </oracle-ebs:account-obj>
        </oracle-ebs:account-objs>
    </oracle-ebs:customer>
</oracle-ebs:save-organization-customer>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
customer	#[payload]	The Organization Customer business object to be saved	OrgCustomer	/
createdByModule		Optional. The module saving this business object	String	/	UTF-8
objSource		Optional. The originating source system of the object save operation	String	/	UTF-8
validateObjFlag		Optional. Indicates if the passed business object is to be validated for completeness if it is being created	String	/	UTF-8

Returns

Return Type	Description
OrgCustomer	The Organization Customer business object that was saved.

<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 will be processed as if the respective API procedure is being called (createPartySite or updatePartySite). Please 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.

 XML Sample
<oracle-ebs:save-party-site config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:party-site
        actionType="CREATE"
        origSystem="SST"
        origSystemReference="OrigSystemRef"
        parentObjectType="ORG"
        parentObjectId="4429"
        identifyingAddressFlag="N"
        status="A"
        partySiteName="GKPARTYSITE1234"
        createdByModule="TCA_V1_API">
        <oracle-ebs:contact-pref-objs>
            <oracle-ebs:contact-pref-obj
                parentObjectType="PARTY_SITE"
                contactType="MAIL"
                preferenceCode="DO_NOT"
                requestedBy="INTERNAL"
                status="A"
                createdByModule="TCA_V1_API"/>
        </oracle-ebs:contact-pref-objs>
        <oracle-ebs:location-obj
                country="US"
                address1="11 Imaging Place"
                city="Oakdale"
                postalCode="55128-3414"
                state="MN"
                county="Washington"
                salesTaxInsideCityLimits="1"/>
        <oracle-ebs:party-site-use-objs>
            <oracle-ebs:party-site-use-obj
                siteUseType="BILL_TO"
                primaryPerType="Y"
                status="A"/>
            <oracle-ebs:party-site-use-obj
                    siteUseType="SHIP_TO"
                    primaryPerType="Y"
                    status="A"/>
        </oracle-ebs:party-site-use-objs>
    </oracle-ebs:party-site>
</oracle-ebs:save-party-site>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
partySite	#[payload]	The Party Site business object to be saved	PartySite	/
createdByModule		Optional. The module saving this business object	String	/	UTF-8
parentId		Optional. TCA identifier for parent object. Either this parameter, or both the parentOrigSys and parentOrigSysRef parameters, must be given	BigDecimal	/
parentOrigSys		Optional. Parent object original system name	String	/	UTF-8
parentOrigSysRef		Optional. Parent object original system reference	String	/	UTF-8
parentObjType		Optional. Parent object type. Validated against HZ_BUSINESS_OBJECTS lookup type	String	/	UTF-8
objSource		Optional. The originating source system of the object save operation	String	/	UTF-8
validateObjFlag		Optional. Indicates if the passed business object is to be validated for completeness if it is being created	String	/	UTF-8

Returns

Return Type	Description
PartySite	The Party Site business object that was saved, returned as an output parameter

<oracle-ebs:save-person>

Saves a Person 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 will be processed as if the respective API procedure is being called (createPerson or updatePerson). Please 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.

 XML Sample
<oracle-ebs:save-person config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:person
        actionType="CREATE"
        origSystem="SST"
        origSystemReference="#[map-payload:origSystemReferebce]"
        validatedFlag="N"
        status="A"
        categoryCode="PROFESSIONAL"
        salutation="Dr."
        personPreNameAdjunct="MR."
        personFirstName="John"
        personMiddleName="B"
        personLastName="Power"
        personNameSuffix="PMP"
        personTitle="Mr"
        personIdenType="DRIVERS_LICENSE"
        personIdentifier="xxxxxxxxx"
        dateOfBirth="#[map-payload:dateOfBirth]"
        placeOfBirth="Kansas"
        deceasedFlag="N"/>
</oracle-ebs:save-person>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
person	#[payload]	The Person business object to be saved	Person	/
createdByModule		Optional. The module saving this business object	String	/	UTF-8
objSource		Optional. The originating source system of the object save operation	String	/	UTF-8
validateObjFlag		Optional. Indicates if the passed business object is to be validated for completeness if it is being created	String	/	UTF-8

Returns

Return Type	Description
Person	The Person business object that was saved, returned as an output parameter

<oracle-ebs:save-person-customer>

Saves a Person 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 will be processed as if the respective API procedure is being called (createPersonCustomer or updatePersonCustomer). Please 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.

 XML Sample
<oracle-ebs:save-person-customer config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:person-customer actionType="CREATE">
                <oracle-ebs:account-objs>
                    <oracle-ebs:account-obj actionType="CREATE"
                        origSystem="SST"
                        origSystemReference="SysRef"
                        status="A"
                        customerType="R"
                        customerClassCode="High Technology"
                        salesChannelCode="COMMERCIAL"
                        priceListId="1000"
                        fobPoint="Destination"
                        shipPartial="Y"
                        warehouseId="207"
                        taxRoundingRule="NEAREST"
                        accountName="AccName"
                        comments="From Webservice"
                        shipSetsIncludeLinesFlag="N"
                        createdByModule="TCA_V1_API">
                        <oracle-ebs:cust-profile-obj
                            actionType="CREATE"
                            status="A"
                            creditAnalystId="10035"
                            creditChecking="N"
                            tolerance="10"
                            discountTerms="Y"
                            dunningLetters="N"
                            interestCharges="N"
                            sendStatements="Y"
                            creditBalanceStatements="Y"
                            creditHold="N"
                            profileClassId="2103"
                            creditRating="Excellent"
                            riskCode="Low"
                            standardTerms="1042"
                            overrideTerms="Y"
                            dunningLetterSetId="1"
                            interestPeriodDays="30"
                            paymentGraceDays="0"
                            discountGraceDays="0"
                            statementCycleId="1000"
                            accountStatus="Preferred"
                            percentCollectable="99"
                            taxPrintingOption="TOTAL ONLY"
                            chargeOnFinChargeFlag="N"
                            groupingRuleId="-1"
                            consInvFlag="N"
                            consInvType="DETAIL"
                            reviewCycle="MONTHLY"
                            creditClassification="LOW"/>
                    </oracle-ebs:account-obj>
                </oracle-ebs:account-objs>
                <oracle-ebs:person-obj actionType="CREATE"
                		origSystem="SST"
                		origSystemReference="SystemRef"
                		validatedFlag="N"
                		status="A"
                		categoryCode="PROFESSIONAL"
                		salutation="Dr."
                		personPreNameAdjunct="MR."
                		personFirstName="John"
                		personMiddleName="B"
                		personLastName="Foo"
                		personNameSuffix="PMP"
                		personTitle="Mr"
                		personIdenType="DRIVERS_LICENSE"
                		personIdentifier="SomeId"
                		dateOfBirth="#[map-payload:dateOfBirth]"
                		placeOfBirth="Zumpa"
                		deceasedFlag="N"/>
            </oracle-ebs:person-customer>
</oracle-ebs:save-person-customer>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
personCustomer	#[payload]	The Person Customer business object to be saved	PersonCustomer	/
createdByModule		Optional. The module Saving this business object.	String	/	UTF-8
objSource		Optional. Source system invokes the service on this Organization.	String	/	UTF-8
validateObjFlag		Optional. Indicates if the passed business object is to be validated for completeness if it is being saved.	String	/	UTF-8

Returns

Return Type	Description
PersonCustomer	The Person Customer business object that was saved, returned as an output parameter

<oracle-ebs:save-phone>

Saves a Phone 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 will be processed as if the respective API procedure is being called (createPhone or updatePhone). Please 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.

 XML Sample
<oracle-ebs:save-phone config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:phone actionType="CREATE"
        origSystem="SST"
        origSystemReference="#[map-payload:origSystemRef]"
        status="A"
        parentObjectType="ORG"
        parentObjectId="1000"
        primaryFlag="N"
        contactPointPurpose="BUSINESS"
        primaryByPurpose="N"
        actualContentSource="USER_ENTERED"
        phoneAreaCode="650"
        phoneCountryCode="1"
        phoneNumber="797 7979"
        phoneExtension="8888"
        phoneLineType="GEN"/>
</oracle-ebs:save-phone>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
phone	#[payload]	The Phone business object to be saved	Phone	/
createdByModule		Optional. The module saving this business object	String	/	UTF-8
parentId		Optional. TCA identifier for parent object. Either this parameter, or both the parentOrigSys and parentOrigSysRef parameters, must be given	BigDecimal	/
parentOrigSys		Optional. Parent object original system name	String	/	UTF-8
parentOrigSysRef		Optional. Parent object original system reference	String	/	UTF-8
parentObjType		Optional. Parent object type. Validated against HZ_BUSINESS_OBJECTS lookup type	String	/	UTF-8
validateObjFlag		Optional. Indicates if the passed business object is to be validated for completeness if it is being created	String	/	UTF-8
objSource		Optional. The originating source system of the object save operation	String	/	UTF-8

Returns

Return Type	Description
Phone	The Phone business object that was saved, returned as an output parameter

<oracle-ebs:save-relationship>

Saves a Relationship 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 will be processed as if the respective API procedure is being called (createRelationship or updateRelationship). Please 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.

 XML Sample
<oracle-ebs:save-relationship config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:relationship actionType="CREATE"
                parentObjectType="PERSON"
                parentObjectId="402784"
                relatedObjectId="4429"
                relatedObjectType="ORG"
                relationshipCode="CONTACT_OF"
                relationshipType="CONTACT"
                comments="Comment added from from Webservice"
                startDate="#[map-payload:yesterday]"
                status="A"/>
</oracle-ebs:save-relationship>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
relationship	#[payload]	The Relationship business object to be saved	Relationship	/
createdByModule		Optional. The module saving this business object	String	/	UTF-8

Returns

Return Type	Description
Relationship	The Relationship business object that was saved, returned as an output parameter

<oracle-ebs:save-web>

Saves a Phone 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 will be processed as if the respective API procedure is being called (createWeb or updateWeb). Please 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.

 XML Sample
<oracle-ebs:save-web config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:web actionType="CREATE"
        origSystem="SST"
        origSystemReference="OrgiSysRef"
        status="A"
        parentObjectType="ORG"
        parentObjectId="1000"
        primaryFlag="N"
        contactPointPurpose="SALESURL"
        primaryByPurpose="N"
        actualContentSource="USER_ENTERED"
        webType="com"
        url="www.donotcontact.com"/>
</oracle-ebs:save-web>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
web	#[payload]	The Web business object to be saved	Web	/
createdByModule		Optional. The module saving this business object	String	/	UTF-8
parentId		Optional. TCA identifier for parent object. Either this parameter, or both the parentOrigSys and parentOrigSysRef parameters, must be given	BigDecimal	/
parentOrigSys		Optional. Parent object original system name	String	/	UTF-8
parentOrigSysRef		Optional. Parent object original system reference	String	/	UTF-8
parentObjType		Optional. Parent object type. Validated against HZ_BUSINESS_OBJECTS lookup type	String	/	UTF-8
validateObjFlag		Optional. Indicates if the passed business object is to be validated for completeness if it is being created	String	/	UTF-8
objSource		Optional. The originating source system of the object create operation	String	/	UTF-8

Returns

Return Type	Description
Web	Save party site result

<oracle-ebs:update-email>

Updates a Email 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.

 XML Sample
<oracle-ebs:update-email config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:email ref = "#[map-payload:email]"/>
</oracle-ebs:update-email>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
email	#[payload]	The Email business object to be updated	Email	/
createdByModule		Optional. The module saving this business object	String	/	UTF-8
objSrc		Optional. The originating source system of the object update operation	String	/	UTF-8

Returns

Return Type	Description
Email	The Email business object that was updated, returned as an output parameter

<oracle-ebs:update-location>

Updates a Location 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.

 XML Sample
<oracle-ebs:update-location config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:location origSystemReference="GK1234"
        country="US"
        address1="Address Value"
        city="Maysville"
        postalCode="41056"
        county="Mason"
        addressKey="adressKeyValue"
        validatedFlag="N"
        />
</oracle-ebs:update-location>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
location	#[payload]	The Location business object to be updated.	Location	/
createdByModule		Optional. The module updating this business object.	String	/	UTF-8
objSource		Optional. The originating source system of the object update operation.	String	/	UTF-8

Returns

Return Type	Description
Location	The Location business object that was updated.

<oracle-ebs:update-organization>

Updates a Organization 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.

 XML Sample
<oracle-ebs:update-organization config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:organization organizationId="00990" status="I"/>
</oracle-ebs:update-organization>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
organization	#[payload]	The Organization business object to be updated.	Organization	/
createdByModule		Optional. The module Saving this business object.	String	/	UTF-8
objSource		Optional. Source system invokes the service on this Organization.	String	/	UTF-8

Returns

Return Type	Description
Organization	The Organization business object that was updated.

<oracle-ebs:update-organization-contact>

Updates a OrgContact 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.

 XML Sample
<oracle-ebs:update-organization-contact config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:contact orgContactId="5555555" status="I"/>
</oracle-ebs:update-organization-contact>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
contact	#[payload]	The Organization Contact business object to be updated	OrgContact	/
createdByModule		Optional. The module saving this business object	String	/	UTF-8
objSource		Optional. The originating source system of the object update operation	String	/	UTF-8

Returns

Return Type	Description
OrgContact	The Organization Contact business object that was updated, returned as an output parameter

<oracle-ebs:update-organization-customer>

Updates a OrgCustomer 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.

 XML Sample
<oracle-ebs:update-organization-customer config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:customer actionType="UPDATE">
        <oracle-ebs:account-objs>
            <oracle-ebs:account-obj
                  actionType="UPDATE" custAcctId="999" origSystem="SST"
                  origSystemReference="OrigSys" status="I"
                  shipSetsIncludeLinesFlag="N" createdByModule="TCA_V1_API">
                  <oracle-ebs:cust-profile-obj
                          custAcctProfileId="870" actionType="UPDATE"
                          status="I"/>
              </oracle-ebs:account-obj>
        </oracle-ebs:account-objs>
    </oracle-ebs:customer>
</oracle-ebs:update-organization-customer>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
customer	#[payload]	The Organization Customer business object to be updated	OrgCustomer	/
createdByModule		Optional. The module updating this business object	String	/	UTF-8
objSource		Optional. The originating source system of the object update operation	String	/	UTF-8

Returns

Return Type	Description
OrgCustomer	The Organization Customer business object that was updated.

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

 XML Sample
<oracle-ebs:update-party-site config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:party-site partySiteId = "#[map-payload:id]" status = "#[map-payload:newStatus]"/>
</oracle-ebs:update-party-site>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
partySite	#[payload]	The Party Site business object to be updated	PartySite	/
createdByModule		Optional. The module saving this business object	String	/	UTF-8
objSource		Optional. The originating source system of the object update operation	String	/	UTF-8

Returns

Return Type	Description
PartySite	The Party Site business object that was updated, returned as an output parameter

<oracle-ebs:update-person>

Updates a Person 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.

 XML Sample
<oracle-ebs:update-person config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:person
       personId="#[map-payload:id]"
       validatedFlag="Y"
       status="I"/>
</oracle-ebs:update-person>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
person	#[payload]	The Person business object to be updated	Person	/
createdByModule		Optional. The module saving this business object	String	/	UTF-8
objSource		Optional. The originating source system of the object update operation	String	/	UTF-8

Returns

Return Type	Description
Person	The Person business object that was updated, returned as an output parameter

<oracle-ebs:update-person-customer>

Updates a Person 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.

 XML Sample
<oracle-ebs:update-person-customer config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:person-customer ref = "#[map-payload:person-customer]"/>
</oracle-ebs:update-person-customer>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
personCustomer	#[payload]	The Person Customer business object to be updated	PersonCustomer	/
createdByModule		Optional. The module Saving this business object.	String	/	UTF-8
objSource		Optional. Source system invokes the service on this Organization.	String	/	UTF-8

Returns

Return Type	Description
PersonCustomer	The Person Customer business object that was updated, returned as an output parameter

<oracle-ebs:update-phone>

Updates a Phone 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.

 XML Sample
<oracle-ebs:update-phone config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:phone phoneId="#[map-payload:id]" status="I"/>
</oracle-ebs:update-phone>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
phone	#[payload]	The Phone business object to be updated	Phone	/
createdByModule		Optional. The module saving this business object	String	/	UTF-8
objSource		Optional. The originating source system of the object update operation	String	/	UTF-8

Returns

Return Type	Description
Phone	The Phone business object that was updated, returned as an output parameter

<oracle-ebs:update-relationship>

Updates a Relationship 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.

 XML Sample
<oracle-ebs:update-relationship config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:relationship relationshipId="#[map-payload:id]" status="I"/>
</oracle-ebs:update-relationship>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
relationship	#[payload]	The Relationship business object to be updated	Relationship	/

Returns

Return Type	Description
Relationship	The Relationship business object that was updated, returned as an output parameter

<oracle-ebs:update-web>

Updates a Web 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.

 XML Sample
<oracle-ebs:update-web config-ref="OracleEBS__ConnectionManagement">
    <oracle-ebs:web webId="#[map-payload:webID]"
                url="#[map-payload:url]"/>
</oracle-ebs:update-web>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
web	#[payload]	The Web business object to be updated	Web	/
createdByModule		Optional. The module saving this business object	String	/	UTF-8
objSrc		Optional. The originating source system of the object update operation	String	/	UTF-8

Returns

Return Type	Description
Web	The Web business object that was updated, returned as an output parameter

<oracle-ebs:xml-gateway>

Enqueues a message via XML Gateway Inbound.

 XML Sample
<oracle-ebs:xml-gateway config-ref="OracleEBS__ConnectionManagement" transactionType="XKLB" transactionSubtype="ORDER_DETAILS_XO" documentNumber="1234" partyId="5678" partySiteId="9012"/>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
messageType	XML	Payload message format. This defaults to XML. Oracle XML Gateway currently supports only XML.	String	/	UTF-8
messageStandard	OAG	Message format standard as displayed in the Define Transactions form and entered in the Define XML Standards form. This defaults to OAG.	String	/	UTF-8
transactionType		External Transaction Type for the business document from the Trading Partner table.	String	/	UTF-8
transactionSubtype		External Transaction Subtype for the business document from the Trading Partner table.	String	/	UTF-8
documentNumber		Optional. 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.	String	/	UTF-8
partyId		Optional. The party identifier. Optional.	String	/	UTF-8
partySiteId		The party site identifier for the inbound XML document.	String	/	UTF-8
body	#[payload]	The payload to be enqueued.	XMLStreamReader	/

Returns

Return Type	Description
ReceiveDocumentResponse	The response from the web service in charge of enqueuing the document.

Exception Payloads

Payload Class	Description
TransformerException	If the XML body cannot be parsed.

Message Sources

<oracle-ebs:business-events>

Subscribes to the WF_JMS_JMS_OUT topic and retrieves any business event enqueued to it.

 XML Sample
<oracle-ebs:business-events config-ref="OracleEBS__Configuration"/>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
callback		The SourceCallback callback to call when a business event is retrieved.	SourceCallback	/

<oracle-ebs:xml-gateway-outbound>

Subscribes to the ECX_OUTBOUND queue and retrieves any messages enqueued to it.

 XML Sample
<oracle-ebs:xml-gateway-outbound config-ref="OracleEBS__Configuration"/>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
callback		The SourceCallback callback to call when a business event is retrieved.	SourceCallback	/