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.
Additional Info
Requires Mule Enterprise License |
Yes |
Requires Entitlement |
Yes |
Mule Version |
3.7.0 or higher |
Configs
Configuration
<oracle-ebs:config>
Configuration
Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
name |
The name of this configuration. With this name can be later referenced. |
x |
||
username |
Oracle EBS Web Services Username. |
x |
||
password |
Oracle EBS Web Services Password. |
x |
||
host |
Oracle EBS Web Services Hostname. |
x |
||
port |
Oracle EBS Web Services Port. Default value is '8000'. |
8000 |
|
|
sslEnabled |
boolean |
Use SSL to communicate with Oracle EBS Web Services. |
false |
|
trustStorePath |
Path where the TrustStore is located. |
|
||
trustStorePassword |
Password for the TrustStore. |
|
||
disableCNCheck |
boolean |
Whether to disable or not the checking of the Common Name in the certificate. |
false |
|
customPlSqlNameList |
List of custom PL/SQL names for web services that will be gathered for Data Sense. |
|
||
responsibilityName |
Responsibility Name |
|
||
responsibilityApplName |
Responsibility Application Name. |
x |
||
securityGroupName |
Security Group Name. Default value is 'STANDARD'. |
STANDARD |
|
|
nlsLanguage |
NLS Language. Default value is 'AMERICAN'. |
AMERICAN |
|
|
orgId |
Org Id. Default value is '204'. |
204 |
|
JMS Configuration
<oracle-ebs:jmsconfig>
Connection Management
Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
name |
The name of this configuration. With this name can be later referenced. |
x |
||
username |
x |
|||
password |
x |
|||
host |
Oracle EBS Database Hostname. |
x |
||
port |
Oracle EBS Database Port. Default value is '1521'. |
1521 |
|
|
sid |
Oracle EBS Database SID. |
x |
JMS DB URL Configuration
<oracle-ebs:jmsdburlconfig>
Connection Management
Processors
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.
XML Sample
<oracle-ebs:find-parties config-ref="OracleEBS__Configuration">
<oracle-ebs:body ref = "#[map-payload:body]"/>
</oracle-ebs:find-parties>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
body |
DqmSearchServiceFindParties |
the request |
#[payload] |
|
Create email
<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__Configuration" 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 | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
The Email business object to be created |
#[payload] |
|
||
createdByModule |
The module saving this business object |
|
||
parentId |
TCA identifier for parent object. Either this parameter, or both the parentOrigSys and parentOrigSysRef parameters, must be given |
|
||
parentOrigSys |
Parent object original system name |
|
||
parentOrigSysRef |
Parent object original system reference |
|
||
parentObjType |
Parent object type. Validated against HZ_BUSINESS_OBJECTS lookup type |
|
||
validateObjFlag |
Indicates if the passed business object is to be validated for completeness if it is being created |
|
||
objSource |
The originating source system of the object create operation |
|
Returns
| Return Java Type | Description |
|---|---|
The Email business object that was created, returned as an output parameter |
Get email
<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__Configuration"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
id |
TCA identifier for the Email business object |
x |
||
origSys |
Email original system name |
|
||
origSysRef |
Email original system reference |
|
Returns
| Return Java Type | Description |
|---|---|
The retrieved Email business object |
Save email
<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__Configuration">
<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 | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
The Email business object to be saved |
#[payload] |
|
||
createdByModule |
The module saving this business object |
|
||
parentId |
TCA identifier for parent object. Either this parameter, or both the parentOrigSys and parentOrigSysRef parameters, must be given |
|
||
parentOrigSys |
Parent object original system name |
|
||
parentOrigSysRef |
Parent object original system reference |
|
||
parentObjType |
Parent object type. Validated against HZ_BUSINESS_OBJECTS lookup type |
|
||
validateObjFlag |
Indicates if the passed business object is to be validated for completeness if it is being created |
|
||
objSource |
The originating source system of the object create operation |
|
Returns
| Return Java Type | Description |
|---|---|
The Email business object that was saved, returned as an output parameter |
Update email
<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__Configuration">
<oracle-ebs:email ref = "#[map-payload:email]"/>
</oracle-ebs:update-email>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
The Email business object to be updated |
#[payload] |
|
||
createdByModule |
The module saving this business object |
|
||
objSrc |
The originating source system of the object update operation |
|
Returns
| Return Java Type | Description |
|---|---|
The Email business object that was updated, returned as an output parameter |
Create location
<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__Configuration">
<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 | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
location |
Location |
The Location business object to be created. |
#[payload] |
|
createdByModule |
The module Saving this business object. |
|
||
objSource |
Source system invokes the service on this Organization. |
|
||
validateObjFlag |
Indicates if the passed business object is to be validated for completeness if it is being saved. |
|
Returns
| Return Java Type | Description |
|---|---|
Location |
Create location result |
Get location
<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__Configuration"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
id |
TCA identifier for the Location business object. |
x |
||
origSys |
Location original system name. |
|
||
origSysRef |
Location original system reference. |
|
Returns
| Return Java Type | Description |
|---|---|
Location |
Get location result |
Save location
<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__Configuration">
<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 | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
location |
Location |
The Location business object to be saved. |
#[payload] |
|
createdByModule |
The module saving this business object. |
|
||
objSource |
Source system invokes the service on this Organization. |
|
||
validateObjFlag |
Indicates if the passed business object is to be validated for completeness if it is being saved. |
|
Returns
| Return Java Type | Description |
|---|---|
Location |
The Location business object that was saved. |
Update location
<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__Configuration">
<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 | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
location |
Location |
The Location business object to be updated. |
#[payload] |
|
createdByModule |
The module updating this business object. |
|
||
objSource |
The originating source system of the object update operation. |
|
Returns
| Return Java Type | Description |
|---|---|
Location |
The Location business object that was updated. |
Create organization
<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__Configuration">
<oracle-ebs:organization origSystem="SST" origSystemReference="System"
validatedFlag="Y" status="A"
categoryCode="MANUFACTURING" organizationName="MyOrganization"
organizationType="ORGANIZATION"/>
</oracle-ebs:create-organization>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
organization |
Organization |
The Organization business object to be created. |
#[payload] |
|
createdByModule |
The module creating this business object. |
|
||
objSource |
Source system invokes the service on this Organization. |
|
||
validateObjFlag |
Indicates if the passed business object is to be validated for completeness if it is being created |
|
Returns
| Return Java Type | Description |
|---|---|
Organization |
The Organization business object that was created. |
Get organization
<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__Configuration"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
id |
TCA identifier for the Organization business object |
x |
||
origSys |
Organization original system name |
|
||
origSysRef |
Organization original system reference |
|
Returns
| Return Java Type | Description |
|---|---|
Organization |
The retrieved ORGANIZATION business object. |
Save organization
<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__Configuration">
<oracle-ebs:organization origSystem="SST" origSystemReference="System"
validatedFlag="Y" status="I"
categoryCode="MANUFACTURING" organizationName="MyOrganization"
organizationType="ORGANIZATION"/>
</oracle-ebs:save-organization>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
organization |
Organization |
The Organization business object to be saved. |
#[payload] |
|
createdByModule |
The module Saving this business object. |
|
||
objSource |
Source system invokes the service on this Organization. |
|
||
validateObjFlag |
Indicates if the passed business object is to be validated for completeness if it is being saved. |
|
Returns
| Return Java Type | Description |
|---|---|
Organization |
The Organization business object that was saved. |
Update organization
<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__Configuration">
<oracle-ebs:organization organizationId="00990" status="I"/>
</oracle-ebs:update-organization>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
organization |
Organization |
The Organization business object to be updated. |
#[payload] |
|
createdByModule |
The module Saving this business object. |
|
||
objSource |
Source system invokes the service on this Organization. |
|
Returns
| Return Java Type | Description |
|---|---|
Organization |
The Organization business object that was updated. |
Get organizations created
<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__Configuration"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
eventId |
ID of BES event's raised when this business object was created. |
x |
Get organizations updated
<oracle-ebs:get-organizations-updated>
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-updated eventId="#[map-payload:id]" config-ref="OracleEBS__Configuration"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
eventId |
ID of BES event's raised when this business object was updated. |
x |
Create organization contact
<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__Configuration">
<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 | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
contact |
OrgContact |
The Organization Contact business object to be created |
#[payload] |
|
parentId |
TCA identifier for parent object. Either this parameter, or both the parentOrigSys and parentOrigSysRef parameters, must be given |
|
||
parentOrigSys |
Parent object original system name |
|
||
parentOrigSysRef |
Parent object original system reference |
|
||
validateObjFlag |
Indicates if the passed business object is to be validated for completeness if it is being created |
|
||
objSource |
The originating source system of the object create operation |
|
||
createdByModule |
The module saving this business object |
|
Returns
| Return Java Type | Description |
|---|---|
OrgContact |
The Organization Contact business object that was created, returned as an output parameter |
Get organization contact
<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__Configuration"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
id |
TCA identifier for the Organization Contact business object |
x |
||
origSys |
Organization Contact original system name |
|
||
origSysRef |
Organization Contact original system reference |
|
Returns
| Return Java Type | Description |
|---|---|
OrgContact |
The retrieved Organization Contact business object |
Save organization contact
<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__Configuration">
<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 | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
contact |
OrgContact |
The Organization Contact business object to be saved |
#[payload] |
|
createdByModule |
The module saving this business object |
|
||
parentId |
TCA identifier for parent object. Either this parameter, or both the parentOrigSys and parentOrigSysRef parameters, must be given |
|
||
parentOrigSys |
Parent object original system name |
|
||
parentOrigSysRef |
Parent object original system reference |
|
||
validateObjFlag |
Indicates if the passed business object is to be validated for completeness if it is being created |
|
||
objSource |
The originating source system of the object save operation |
|
Returns
| Return Java Type | Description |
|---|---|
OrgContact |
The Organization Contact business object that was saved, returned as an output parameter |
Update organization contact
<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__Configuration">
<oracle-ebs:contact orgContactId="5555555" status="I"/>
</oracle-ebs:update-organization-contact>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
contact |
OrgContact |
The Organization Contact business object to be updated |
#[payload] |
|
createdByModule |
The module saving this business object |
|
||
objSource |
The originating source system of the object update operation |
|
Returns
| Return Java Type | Description |
|---|---|
OrgContact |
The Organization Contact business object that was updated, returned as an output parameter |
Create organization customer
<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__Configuration">
<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 | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
customer |
OrgCustomer |
The Organization Customer business object to be created |
#[payload] |
|
createdByModule |
The module updating this business object |
|
||
objSource |
The originating source system of the object save operation |
|
||
validateObjFlag |
Indicates if the passed business object is to be validated for completeness. Default value: true |
true |
|
Returns
| Return Java Type | Description |
|---|---|
OrgCustomer |
The Organization Customer business object that was created, returned as an output parameter |
Get organization customer
<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__Configuration"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
id |
TCA identifier for the Organization Customer business object |
x |
||
origSys |
Parent object original system name. |
|
||
origSysRef |
Parent object original system reference. |
|
Returns
| Return Java Type | Description |
|---|---|
OrgCustomer |
The retrieved Organization Customer business object |
Save organization customer
<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__Configuration">
<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 | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
customer |
OrgCustomer |
The Organization Customer business object to be saved |
#[payload] |
|
createdByModule |
The module saving this business object |
|
||
objSource |
The originating source system of the object save operation |
|
||
validateObjFlag |
Indicates if the passed business object is to be validated for completeness if it is being created |
|
Returns
| Return Java Type | Description |
|---|---|
OrgCustomer |
The Organization Customer business object that was saved. |
Update organization customer
<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__Configuration">
<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 | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
customer |
OrgCustomer |
The Organization Customer business object to be updated |
#[payload] |
|
createdByModule |
The module updating this business object |
|
||
objSource |
The originating source system of the object update operation |
|
Returns
| Return Java Type | Description |
|---|---|
OrgCustomer |
The Organization Customer business object that was updated. |
Get organization customers created
<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__Configuration"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
eventId |
TCA identifier for the Organization Customer business object |
x |
Get organization customers updated
<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__Configuration"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
eventId |
TCA identifier for the Organization Customer business object |
x |
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.
XML Sample
<oracle-ebs:create-party-site createdByModule="TCA_V1_API" parentId="4429" parentObjType="ORG" config-ref="OracleEBS__Configuration">
<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 | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
partySite |
PartySite |
The Party Site business object to be created |
#[payload] |
|
createdByModule |
The module creating this business object |
|
||
parentId |
TCA identifier for parent object. Either this parameter, or both the parentOrigSys and parentOrigSysRef parameters, must be given |
|
||
parentOrigSys |
Parent object original system name |
|
||
parentOrigSysRef |
Parent object original system reference |
|
||
parentObjType |
Parent object type. Validated against HZ_BUSINESS_OBJECTS lookup type |
|
||
objSource |
The originating source system of the object create operation |
|
||
validateObjFlag |
Indicates if the passed business object is to be validated for completeness if it is being created |
|
Returns
| Return Java 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 |
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.
XML Sample
<oracle-ebs:get-party-site id="#[map-payload:id]" config-ref="OracleEBS__Configuration"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
id |
TCA identifier for the Party Site business object |
x |
||
origSys |
Party Site original system name |
|
||
origSysRef |
Party Site original system reference |
|
Returns
| Return Java Type | Description |
|---|---|
PartySite |
The retrieved Party Site business object |
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 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__Configuration">
<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 | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
partySite |
PartySite |
The Party Site business object to be saved |
#[payload] |
|
createdByModule |
The module saving this business object |
|
||
parentId |
TCA identifier for parent object. Either this parameter, or both the parentOrigSys and parentOrigSysRef parameters, must be given |
|
||
parentOrigSys |
Parent object original system name |
|
||
parentOrigSysRef |
Parent object original system reference |
|
||
parentObjType |
Parent object type. Validated against HZ_BUSINESS_OBJECTS lookup type |
|
||
objSource |
The originating source system of the object save operation |
|
||
validateObjFlag |
Indicates if the passed business object is to be validated for completeness if it is being created |
|
Returns
| Return Java Type | Description |
|---|---|
PartySite |
The Party Site business object that was saved, returned as an output parameter |
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.
XML Sample
<oracle-ebs:update-party-site config-ref="OracleEBS__Configuration">
<oracle-ebs:party-site partySiteId = "#[map-payload:id]" status = "#[map-payload:newStatus]"/>
</oracle-ebs:update-party-site>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
partySite |
PartySite |
The Party Site business object to be updated |
#[payload] |
|
createdByModule |
The module saving this business object |
|
||
objSource |
The originating source system of the object update operation |
|
Returns
| Return Java Type | Description |
|---|---|
PartySite |
The Party Site business object that was updated, returned as an output parameter |
Create person
<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__Configuration">
<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 | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
person |
Person |
The Person business object to be created |
#[payload] |
|
createdByModule |
The module creating this business object |
|
||
objSource |
The originating source system of the object create operation |
|
||
validateObjFlag |
Indicates if the passed business object is to be validated for completeness if it is being created |
|
Returns
| Return Java Type | Description |
|---|---|
Person |
The Person business object that was created, returned as an output parameter |
Get person
<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__Configuration"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
id |
TCA identifier for the Person business object |
x |
||
origSys |
Person original system name |
|
||
origSysRef |
Person original system reference |
|
Returns
| Return Java Type | Description |
|---|---|
Person |
The retrieved Person business object |
Get persons created
<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__Configuration"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
eventId |
ID of BES event's raised when this business object was created |
x |
Get persons updated
<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__Configuration"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
eventId |
of BES event's raised when this business object was updated |
x |
Save person
<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__Configuration">
<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 | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
person |
Person |
The Person business object to be saved |
#[payload] |
|
createdByModule |
The module saving this business object |
|
||
objSource |
The originating source system of the object save operation |
|
||
validateObjFlag |
Indicates if the passed business object is to be validated for completeness if it is being created |
|
Returns
| Return Java Type | Description |
|---|---|
Person |
The Person business object that was saved, returned as an output parameter |
Update person
<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__Configuration">
<oracle-ebs:person
personId="#[map-payload:id]"
validatedFlag="Y"
status="I"/>
</oracle-ebs:update-person>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
person |
Person |
The Person business object to be updated |
#[payload] |
|
createdByModule |
The module saving this business object |
|
||
objSource |
The originating source system of the object update operation |
|
Returns
| Return Java Type | Description |
|---|---|
Person |
The Person business object that was updated, returned as an output parameter |
Create person customer
<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__Configuration">
<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 | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
personCustomer |
PersonCustomer |
The Person Customer business object to be created |
#[payload] |
|
createdByModule |
The module saving this business object |
|
||
objSource |
Indicates if the passed business object is to be validated for completeness if it is being created |
|
||
validateObjFlag |
The originating source system of the object create operation |
|
Returns
| Return Java Type | Description |
|---|---|
PersonCustomer |
The Person Customer business object that was created, returned as an output parameter |
Get person customer
<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__Configuration"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
id |
TCA identifier for the Person Customer business object |
x |
||
origSys |
Person Customer original system name |
|
||
origSysRef |
Person Customer original system reference |
|
Returns
| Return Java Type | Description |
|---|---|
PersonCustomer |
The retrieved Person Customer business object |
Get person customers created
<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__Configuration"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
eventId |
ID of BES event's raised when this object was created. |
x |
Get person customers updated
<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__Configuration"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
eventId |
ID of BES event's raised when this object was updated. |
x |
Save person customer
<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__Configuration">
<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 | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
personCustomer |
PersonCustomer |
The Person Customer business object to be saved |
#[payload] |
|
createdByModule |
The module Saving this business object. |
|
||
objSource |
Source system invokes the service on this Organization. |
|
||
validateObjFlag |
Indicates if the passed business object is to be validated for completeness if it is being saved. |
|
Returns
| Return Java Type | Description |
|---|---|
PersonCustomer |
The Person Customer business object that was saved, returned as an output parameter |
Update person customer
<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__Configuration">
<oracle-ebs:person-customer ref = "#[map-payload:person-customer]"/>
</oracle-ebs:update-person-customer>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
personCustomer |
PersonCustomer |
The Person Customer business object to be updated |
#[payload] |
|
createdByModule |
The module Saving this business object. |
|
||
objSource |
Source system invokes the service on this Organization. |
|
Returns
| Return Java Type | Description |
|---|---|
PersonCustomer |
The Person Customer business object that was updated, returned as an output parameter |
Create phone
<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__Configuration">
<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 | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
phone |
Phone |
The Phone business object to be created |
#[payload] |
|
createdByModule |
The module saving this business object |
|
||
parentId |
TCA identifier for parent object. Either this parameter, or both the parentOrigSys and parentOrigSysRef parameters, must be given |
|
||
parentOrigSys |
Parent object original system name |
|
||
parentOrigSysRef |
Parent object original system reference |
|
||
parentObjType |
Parent object type. Validated against HZ_BUSINESS_OBJECTS lookup type |
|
||
validateObjFlag |
Indicates if the passed business object is to be validated for completeness if it is being created |
|
||
objSource |
The originating source system of the object create operation |
|
Returns
| Return Java Type | Description |
|---|---|
Phone |
The Phone business object that was created, returned as an output parameter |
Get phone
<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__Configuration"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
id |
TCA identifier for the Phone business object |
x |
||
origSys |
Phone original system name |
|
||
origSysRef |
Phone original system reference |
|
Returns
| Return Java Type | Description |
|---|---|
Phone |
The retrieved Phone business object |
Save phone
<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__Configuration">
<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 | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
phone |
Phone |
The Phone business object to be saved |
#[payload] |
|
createdByModule |
The module saving this business object |
|
||
parentId |
TCA identifier for parent object. Either this parameter, or both the parentOrigSys and parentOrigSysRef parameters, must be given |
|
||
parentOrigSys |
Parent object original system name |
|
||
parentOrigSysRef |
Parent object original system reference |
|
||
parentObjType |
Parent object type. Validated against HZ_BUSINESS_OBJECTS lookup type |
|
||
validateObjFlag |
Indicates if the passed business object is to be validated for completeness if it is being created |
|
||
objSource |
The originating source system of the object save operation |
|
Returns
| Return Java Type | Description |
|---|---|
Phone |
The Phone business object that was saved, returned as an output parameter |
Update phone
<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__Configuration">
<oracle-ebs:phone phoneId="#[map-payload:id]" status="I"/>
</oracle-ebs:update-phone>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
phone |
Phone |
The Phone business object to be updated |
#[payload] |
|
createdByModule |
The module saving this business object |
|
||
objSource |
The originating source system of the object update operation |
|
Returns
| Return Java Type | Description |
|---|---|
Phone |
The Phone business object that was updated, returned as an output parameter |
Create relationship
<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__Configuration">
<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 | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
relationship |
Relationship |
The Relationship business object to be created |
#[payload] |
|
createdByModule |
The module creating this business object |
|
Returns
| Return Java Type | Description |
|---|---|
Relationship |
The Relationship business object that was created, returned as an output parameter |
Get relationship
<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__Configuration"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
id |
TCA identifier for the Relationship business object |
x |
Returns
| Return Java Type | Description |
|---|---|
Relationship |
The retrieved Relationship business object |
Save relationship
<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__Configuration">
<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 | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
relationship |
Relationship |
The Relationship business object to be saved |
#[payload] |
|
createdByModule |
The module saving this business object |
|
Returns
| Return Java Type | Description |
|---|---|
Relationship |
The Relationship business object that was saved, returned as an output parameter |
Update relationship
<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__Configuration">
<oracle-ebs:relationship relationshipId="#[map-payload:id]" status="I"/>
</oracle-ebs:update-relationship>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
relationship |
Relationship |
The Relationship business object to be updated |
#[payload] |
|
Returns
| Return Java Type | Description |
|---|---|
Relationship |
The Relationship business object that was updated, returned as an output parameter |
Create web
<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__Configuration">
<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 | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
web |
Web |
The Web business object to be created |
#[payload] |
|
createdByModule |
The module saving this business object |
|
||
parentId |
TCA identifier for parent object. Either this parameter, or both the parentOrigSys and parentOrigSysRef parameters, must be given |
|
||
parentOrigSys |
Parent object original system name |
|
||
parentOrigSysRef |
Parent object original system reference |
|
||
parentObjType |
Parent object type. Validated against HZ_BUSINESS_OBJECTS lookup type |
|
||
validateObjFlag |
Indicates if the passed business object is to be validated for completeness if it is being created |
|
||
objSource |
The originating source system of the object create operation |
|
Returns
| Return Java Type | Description |
|---|---|
Web |
The Web business object that was created, returned as an output parameter |
Get web
<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__Configuration"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
id |
TCA identifier for the Web business object |
x |
||
origSys |
Web original system name |
|
||
sysRef |
Web original system reference |
|
Returns
| Return Java Type | Description |
|---|---|
Web |
The retrieved Web business object |
Save web
<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__Configuration">
<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 | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
web |
Web |
The Web business object to be saved |
#[payload] |
|
createdByModule |
The module saving this business object |
|
||
parentId |
TCA identifier for parent object. Either this parameter, or both the parentOrigSys and parentOrigSysRef parameters, must be given |
|
||
parentOrigSys |
Parent object original system name |
|
||
parentOrigSysRef |
Parent object original system reference |
|
||
parentObjType |
Parent object type. Validated against HZ_BUSINESS_OBJECTS lookup type |
|
||
validateObjFlag |
Indicates if the passed business object is to be validated for completeness if it is being created |
|
||
objSource |
The originating source system of the object create operation |
|
Returns
| Return Java Type | Description |
|---|---|
Web |
Save party site result |
Update web
<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__Configuration">
<oracle-ebs:web webId="#[map-payload:webID]"
url="#[map-payload:url]"/>
</oracle-ebs:update-web>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
web |
Web |
The Web business object to be updated |
#[payload] |
|
createdByModule |
The module saving this business object |
|
||
objSrc |
The originating source system of the object update operation |
|
Returns
| Return Java Type | Description |
|---|---|
Web |
The Web business object that was updated, returned as an output parameter |
Xml gateway
<oracle-ebs:xml-gateway>
Enqueues a message via XML Gateway Inbound.
XML Sample
<oracle-ebs:xml-gateway config-ref="OracleEBS__Configuration" transactionType="XKLB" transactionSubtype="ORDER_DETAILS_XO" documentNumber="1234" partyId="5678" partySiteId="9012"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
messageType |
Payload message format. This defaults to XML. Oracle XML Gateway currently supports only XML. |
XML |
|
|
messageStandard |
Message format standard as displayed in the Define Transactions form and entered in the Define XML Standards form. This defaults to OAG. |
OAG |
|
|
transactionType |
External Transaction Type for the business document from the Trading Partner table. |
x |
||
transactionSubtype |
External Transaction Subtype for the business document from the Trading Partner table. |
x |
||
documentNumber |
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. |
|
||
partyId |
The party identifier. Optional. |
|
||
partySiteId |
The party site identifier for the inbound XML document. |
x |
||
body |
XMLStreamReader |
The payload to be enqueued. |
#[payload] |
|
Returns
| Return Java Type | Description |
|---|---|
ReceiveDocumentResponse |
The response from the web service in charge of enqueuing the document. |
invoke PL/SQL
<oracle-ebs:invoke-pl-sql>
DataSense enabled
Calls a PL/SQL web service.
Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
type |
+++A String with the following format: <code>WSDL_NAME |
WSDL_OPERATION_NAME</code>+ |
||
x |
input |
XMLStreamReader |
Content to be processed. Cannot be null. |
Returns
| Return Java Type | Description |
|---|---|
XMLStreamReader |
An XMLStreamReader with the service response. |
Sources
Business events
<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__JMS_Configuration" durableSubscription="true"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
durableSubscription |
boolean |
Check this if you want to create a durable subscription to the topic. |
false |
|
subscriptionName |
The name of the durable subscription. If none specified, will default to 'muleBusinessEvents'. |
|
||
callback |
SourceCallback |
The SourceCallback callback to call when a business event is retrieved. |
x |
Returns
| Return Java Type | Description |
|---|---|
void |
Xml gateway outbound
<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__JMS_Configuration"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
callback |
SourceCallback |
The SourceCallback callback to call when a business event is retrieved. |
x |
Returns
| Return Java Type | Description |
|---|---|
void |