Using Simplified SOAP Web Services

7/24/2019 Using Simplified SOAP Web Services

http://slidepdf.com/reader/full/using-simplified-soap-web-services 1/190

May 2015

Oracle Sales Cloud UsingSimplified SOAP Web Servicesfor Account, Household, andContact

Release 9



Copyright ©2005, 2014 Orac le and/ or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions on use

and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license

agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit,

distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering,

disassembly, or dec ompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you

find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf

of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated softwa re, any programs

installed on the hardware, and/or documentation, delivered to U.S. Government end users are “commercial

computer software” pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental

regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any

operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be

subjec t to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S.

Government.

This software or hardware is developed for general use in a variety of information management applica tions. It is not

developed or intended for use in any inherently dangerous applications, including applications that may create a

risk of personal injury. If you use this software or hardware in dangerous applica tions, then you shall be responsible to

take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Orac le Corporation

and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous

applications.

Orac le and J ava are registered trademarks of Orac le and/or its affiliates. Other names may be trademarks of theirrespective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used

under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD

logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a

registered trademark of The Open Group.

This software or hardware and doc umentation may provide acc ess to or information on content, products, and

services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all

warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its

affiliates will not be responsible for any loss, costs, or damages incurred due to your ac cess to or use of third-party

content, products, or services.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at

http://www.orac le.com/pls/topic/lookup?c tx=acc&id=docacc.

Access to Oracle Support

Oracle customers have access to electronic support through My Oracle Support. For information, visit

http://www.orac le.com/pls/topic/lookup?c tx=ac c&id=info or visit

http://www.orac le.com/pls/topic/lookup?ctx=ac c&id=trs if you are hearing impaired.

http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc


http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info


http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs







Orac le Sales Cloud Using Simplified SOAP Web Services for Acc ount, Household, and C ontac t

1 Introduction to Simplified Sales Cloud Web Services for Account,Household, and Contact ................................................................................................ 9

Overview of Oracle Sales Cloud Web Services ............................................................ 9

Overview of Simplified SOAP Web Services .................................................................. 9

Understanding the Process Flow for Consuming a SOAP Web Service................... 10

Searching for Relevant Web Services Using the OER ................................................ 11

Accessing WSDL URL ...................................................................................................... 12

Determining Which Web service to Use to Implement Your Use C ase ................... 12

Prototyping Payloads and Evaluating if a Web Service Meets Your BusinessRequirements Using the Fusion Service Tester....................................................... 13

Prototyping Payloads and Evaluating Web Services Using the J DeveloperHTTP Analyzer ............................................................................................................ 23

Prototyping Payloads and Evaluating Web Services Using Third Party Tools .... 24

2 How do I …? .............................................................................................................. 25

Managing Accounts Using the Simplified Sales Cloud Account Web Service(AccountService) ............................................................................................................ 25

Create an Account Programmatically Using createAccount ........................... 25

Search for an Account Programmatically Using findAccount........................... 27

Update an Account and its Primary Address Programmatically UsingupdateAccount ....................................................................................................... 28

Delete an Account Programmatically Using deleteAccount ............................ 29

Retrieve an Ac count Programmatically Using getAccount ............................... 29

Merge an account Programmatically Using mergeAccount ............................ 30

Perform a Specific Operation (Create, Update, Delete, or Merge) on a List

of Accounts Using processAccount ....................................................................... 31

Managing Contac ts Using the Simplified Sales Cloud Contac t Web Service(ContactService) ............................................................................................................ 32

Create a Contact Programmatically Using createContact .............................. 32

Search for a Contact Programmatically Using findC ontact .............................. 35

Update a C ontact and its Primary Address Programmatically UsingupdateContact ........................................................................................................ 35

Contents



Contents

Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and C ontact4

Delete a Contact Programmatically Using deleteContact ............................... 36

Retrieve a Contact Programmatically Using getContact .................................. 37

Merge a Contact Programmatically Using mergeContact ............................... 38

Perform a Specific Operation (Create, Update, Delete, or Merge) on a Listof C ontacts Using processContact ........................................................................ 39

Managing Households Using the Simplified Sales Cloud Household WebService .............................................................................................................................. 39

Create a Household Programmatically Using createHousehold ....................... 40

Search for a Household Programmatically Using findHousehold ...................... 41

Update a Household and its Primary Address Programmatically UsingupdateHousehold..................................................................................................... 42

Delete a Household Programmatically Using deleteHousehold ........................ 43

Retrieve a Household Programmatically Using getHousehold ........................... 44

Merge a Household Programmatically Using mergeHousehold ........................ 44 Perform a Specific Operation (Create, Update, Delete, or Merge) on a Listof Households Using proc essHousehold ................................................................ 45

Managing Addresses Using the Simplified Sales Cloud Address Web Service(AddressService) ............................................................................................................. 46

Create an Address Programmatically Using createAddress .............................. 46

Search for an Address Programmatically Using findAddress .............................. 47

Update an Address and Address Purpose Programmatically UsingupdateAddress ......................................................................................................... 48

Delete an Address Programmatically Using deleteAddress ............................... 50

Retrieve an Address Programmatically Using getAddress .................................. 51

Merge an Address Programmatically Using mergeAddress ............................... 51

Managing Relationships Using the Simplified Sales Cloud Relationship WebService .............................................................................................................................. 53

Create a Relationship Programmatically Using createRelationship .................. 53

Search for a Relationship Programmatically Using findRelationship ................. 55

Update a Relationship and its Primary Address Programmatically UsingupdateRelationship .................................................................................................. 56

Merge a Relationship Programmatically Using mergeRelationship ................... 56

Perform a Specific Operation (Create, Update, Delete, or Merge) on a Listof Relationships Using processRelationship ........................................................... 58

3 Invoking A Simplified Web Service Using Web Service Proxy Clients ................ 59

Points to Consider While Designing Web Service Proxy Clients ................................ 59

Invoking A Simplified Web Service Using A Static Proxy ............................................ 60

Authentication ................................................................................................................ 64

4 Sales Cloud Account Simplified Web Services Interface.................................... 67



Introduction to Simplified Sales Cloud Web Services for Account, Household, and Contact

▪Overview of Oracle Sales Cloud Web Services

Oracle Sales Cloud Using Simplified SOAP Web Services for Acc ount, Household, and Contac t 5

Operations ....................................................................................................................... 68

createAccount ......................................................................................................... 68

deleteAccount ......................................................................................................... 69

findAccount .............................................................................................................. 69 getAccount ............................................................................................................... 70

mergeAccount ......................................................................................................... 71

processAccount ....................................................................................................... 71

processCSAccount .................................................................................................. 72

updateAccount ....................................................................................................... 73

Sales Cloud Account SDO ............................................................................................. 74

5 Sales Cloud Contact Simplified Web Services Interface .................................... 95

Operations ....................................................................................................................... 96

getContact ............................................................................................................... 96 createContact ......................................................................................................... 97

updateContact ........................................................................................................ 97

deleteContact .......................................................................................................... 98

mergeContact .......................................................................................................... 99

findContact ............................................................................................................. 100

processContact ...................................................................................................... 100

processCSContact ................................................................................................. 101

Sales C loud Contact SDO ........................................................................................... 102

6 Sales Cloud Household Simplified Web Services Interface .............................. 123

Operations ..................................................................................................................... 123

getHousehold ......................................................................................................... 124

createHousehold .................................................................................................... 124

updateHousehold .................................................................................................. 125

deleteHousehold .................................................................................................... 126

mergeHousehold .................................................................................................... 127

findHousehold ......................................................................................................... 127

processHousehold .................................................................................................. 128

processCSHousehold ............................................................................................. 129

Sales Cloud Household SDO ....................................................................................... 130

7 Sales Cloud Relationship Simplified Web Services Interface ............................ 143

Operations ..................................................................................................................... 143

createRelationship ................................................................................................. 144

updateRelationship ................................................................................................ 144

deleteRelationship ................................................................................................. 145



Contents

Oracle Sales Cloud Using Simplified SOAP Web Services for Acc ount, Household, and C ontact6

mergeRelationship .................................................................................................. 146

findRelationship ....................................................................................................... 146

processRelationship ................................................................................................ 147

processCSRelationship ........................................................................................... 148

Sales Cloud Relationship SDO ..................................................................................... 149

8 Sales Cloud Address Simplified Web Services Interface ................................... 155

Operations ..................................................................................................................... 155

getAddress .............................................................................................................. 156

createAddress ......................................................................................................... 156

updateAddress ....................................................................................................... 157

mergeAddress ......................................................................................................... 158

deleteAddress ......................................................................................................... 159

findAddress .............................................................................................................. 159 processAddress ....................................................................................................... 160

processCSAddress .................................................................................................. 161

Sales Cloud Address SDO ............................................................................................ 162

Sales Cloud Address Purpose SDO ............................................................................. 171

Sales Cloud Primary Address SDO .............................................................................. 172

9 Appendix A: Downloading and Setting Up the Fusion Service Tester ............ 179

Installing J AVA on Windows machine ........................................................................ 179

Downloading the Fusion Service Tester ..................................................................... 179

Running the Fusion Service Tester Client .................................................................... 179

Importing a New certificate in the keystore (for IE) .................................................. 180

10 Appendix B: Sample Code: Static Web Service Proxy JAX-WS Style ........ 181

11 Appendix C: Extracting Oracle Public Certificate from Fusion WSDL ...... 189




▪Overview of Oracle Sales Cloud Web Services

Oracle Sales Cloud Using Simplified SOAP Web Services for Acc ount, Household, and C ontac t 7





Orac le Sales Cloud Using Simplified SOAP Web Services for Acc ount, Household, and C ontac t

Overview of Oracle Sales Cloud Web Services

Oracle Sales Cloud comes with SOAP Web services that you can use to:

• Develop cloud applications that call on and integrate with Oracle Sales Cloud todeliver some of their functionality. You could sell these applications in the OracleCloud Marketplace. These applications might deliver other functionality

independently or by integrating with third-party applications.

• Integrate suites of applications from third party vendors to Oracle Sales Cloud.

• Integrate different types of Oracle applications suites, such as Oracle E-BusinessSuite, with Oracle Sales Cloud.

• Customize and extend Oracle Sales Cloud applications to your business needs.

Overview of Simplified SOAP Web Services

The new and simplified SOAP Web services are a subset of Orac le Sales Cloud WebServices. These Web services make it easy to integrate accounts, contacts andhouseholds with other spoke systems. Simplified object structures represent logical viewsof ac counts, contac ts and households. You don’t need to know the full data model touse the services correc tly. Instead of calling multiple granular web services toorchestrate a set of customer record updates, you can now perform the most commoncustomer data management actions with new APIs. For example, you can use one APIcall to c reate ac count with locations and assoc iate the ac count with existing contacts.

The following top level SOAP services are available:

• Sales Cloud Account

• Sales Cloud Contact

• Sales Cloud Household

Use these services to create, edit, find, merge, and delete account, contac t, andhousehold objec ts. The services support commonly used profile attributes: one set ofindustry classification and parent node information attributes required to create anaccount hierarchy, address attributes, and one instance of different contact point typeattributes such as phone, mobile, fax, and email.

The following child services are also available and allow you to manage multipleaddresses and relationships for the three top level objec ts:

1 Introduction to Simplified SalesCloud Web Services for Account,Household, and Contact



Introduction to Simplified Sales Cloud Web Services for Account, Household, and Contact▪

Understanding the Process Flow for Consuming a SOAP Web Service

Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contac t10

• Sales Cloud Address

• Sales Cloud Relationship

Steps to Enable

There are no steps necessary to enable these enhancements.

Tips and Considerations

• Attributes that are available on the simplified pages by default are available withineach of the top-level services.

• The Sales Cloud Account service supports the management of an accounthierarchy for a given account.

• The Sales Cloud Address service can be used only if there is more than one addressrelated to the top level objec t.

• The top-level services do not support any relationships. Use the Sales Cloud

Relationship service to manage relationships between any two top-level objects.

Key Resources

• For more information about using Web Services in Oracle Sales Cloud, see:

• Getting Started with Web Services• Sales Cloud Web Services: (MOS article 1354841.1) • Import Web-Service Guide: (1605219.1)

Understanding the Process Flow for Consuming a SOAP Web

Service The following figure illustrates the typical stages of the process for consuming a SOAPWeb Service:

These stages are described below:

• Identifying the web services relevant to your business use c ase: Review the availableservices, for the objec t you want to work with, in Orac le Enterprise Repository and

https://support.oracle.com/epmos/main/downloadattachmentprocessor?attachid=1354841.1%3ACRM_WEBSERVICES&docType=WHITE%20PAPER&action=download

https://support.oracle.com/epmos/main/downloadattachmentprocessor?attachid=1605219.1%3AFILE_BASED_IMPORT&docType=REFERENCE&action=download

https://support.oracle.com/epmos/main/downloadattachmentprocessor?attachid=1605219.1%3AFILE_BASED_IMPORT&docType=REFERENCE&action=download

https://support.oracle.com/epmos/main/downloadattachmentprocessor?attachid=1354841.1%3ACRM_WEBSERVICES&docType=WHITE%20PAPER&action=download




▪Searching for Relevant Web Services Using the OER


decide which service you want to use. For more information, see Searching for WebServices in OER.

• Prototyping payloads and evaluating if a web service meets your business

requirements: You can do it by prototyping payloads and testing if the web servicecan actually perform the operations per your business requirements. You canprototype payloads and evaluate results using the Fusion Service Tester or the Oracle

J Developer HTTP Analyzer. Alternatively, you can use third party tools, such asWebInjec t, SoapUI, and Strom, to test the Sales Cloud web services. For moreinformation, see Determining Which Web service to Use to Implement Your Use C ase.

• Building Web service clients using an IDE: You can use an appropriate IDE to developa proxy client on a platform of your choice such as Java, .Net, or ASP to call Webservices and integrate applications with Oracle Sales Cloud. You can build a staticproxy, dynamic proxy, or a dynamic-static proxy depending on your businessrequirements. For more information, see Building Web Service C lients Using an IDE.

• Generating Keystore certificates: You have to generate keystore certificates only forrunning standalone J DK applications. You do not need to generate keystorecertificates if you are running within the Weblogic Server. For more information, seeGenerating Keystore certificates: Points to Consider.

Searching for Relevant Web Services Using the OER

The simplified Web services let you perform simple operations. For example, the SalesCloud Account service lets you manage (create, update, and delete) only simpleorganization accounts. You cannot use the Sales Cloud Account Web service tomanage organization accounts with additional names and identifiers, multiple sets ofaddresses, contac ts, industry classification information, e-mail and phone, and resourcesassoc iated with the sales profile.

To perform complex operations, you can use related services. For example, to managecomplex accounts you could use Sales Party, Sales Account Service, and so on.

You can identify the Web services relevant to your business use case by reviewing theavailable services, for the objec t you want to work with, in the Oracle EnterpriseRepository (OER).

The Orac le Enterprise Repository contains reference guides with detailed information onindividual Web services. The OER includes all information about web services such as theLBA information, operations available, related service data objects (SDOs), and the Webservice invocation methods.

The following types of assets can be accessed in the repository:

• ADF Business Components services

• ADF Business Components service data objec ts

• Service Oriented Architecture (SOA) composites

• SOA composite services

To access the information for a web service, follow these steps.




Ac cessing WSDL URL


1. Using your browser, enter http://fusionappsoer.orac le.com. Sign in as a user or aguest to Oracle Enterprise Repository.

2. Search for assets, using the Web service name for your Search String.

3. Navigate to the results, and click the Documentation tab. The Detail tab includes the service WSDL URL and an abstrac t WSDL URL. You can modifythe service WSDL URL to obtain the endpoint URL for the service.

Accessing WSDL URL

To get logical end point:

• Launch the OER (https://fusionappsoer.oracle.com/oer) and login as Guest.

• Search for the Web service that you need using an appropriate search string and

type. For example, for the Sales Cloud Account Web service, use the followingcombination:

• Search String: Sales Cloud Account• Type: ADF Service

• Selec t the service from the results sec tion and see the Details tab in the bottom. Thatwill have service logical end point as below. Service Path:http:/ /<crm_server:PortNumber>/crmCommonSalesParties/AccountService

• The part "http:/ /<crm_server:PortNumber>" is dynamic for every environment whereas "/crmCommonSalesParties/AccountService" is static for a given service version.

To get physical end point of any given instance:

• Launch Oracle Sales Cloud home page and login as a functional user.

• Navigate to an application's dashboard/workarea page that belongs to Sales CloudAccount. For example: In case of Financ ial Util Service navigate to Payables or incase of Purchase Order Service navigate to Procurement.

• Let’s take the Payables Invoice workbench as an example, you will see a URL in thebrowser similar to https:// <domainname>/payables/faces/InvoiceWorkbench. The<domainname> might be like https://<pod-name>.<lba>.xxx.oraclecloud.com.

• In this URL, take the "https://<domainname>". For example, in case of PayablesInvoice workbench URL just take till "payables". Then append the static context rootthat we extracted from OER - "/crmCommonSalesParties/AccountService" to it.

•

https://<domainname>/crmCommonSalesParties/AccountService is the WSDL URLfor Sales Cloud Account.

Determining Which Web service to Use to Implement Your Use

Case

Before you invest time and resources in building a custom proxy client application to callan Oracle Sales Cloud Web service, you much ascertain whether that Web services canmeet your business requirements. This sec tion outlines how you can identify the Web




▪Determining Which Web service to Use to Implement Your Use Case


service that you need to use to implement your specific use c ase. The sec tion describesthe different options available to you for evaluating Oracle Sales Cloud Web services,by prototyping their input payloads and evaluating output payloads and results.

You can test Oracle Sales Cloud Web services using the following tools:• Fusion Service Tester

• Oracle J Developer HTTP Analyzer

• Third party tools

Prototyping Payloads and Evaluating if a Web Service Meets Your Business

Requirements Using the Fusion Service Tester

You can use Oracle’s Fusion Service Tester application to test Oracle Sales Cloudservices. Review Appendix A to find out how to download it from the OER(https://fusionappsoer.oracle.com/oer/FusionServiceTester.zip) and set it up.

After completing the setup steps, you can run the startFusionServiceTester.bat to launchthe Fusion Service Tester application.

Evaluating the Simplified Account Service

Use this procedure to evaluate the simplified Account service (AccountService).

Prerequisites

• Ensure that the user credentials used to invoke the service has the required privilegeto create an ac count in Orac le Sales Cloud Applications.

• Optionally, if you want to designate an account owner to any account you mustensure that the account owner exists.

Identifying the Appropriate Web Service

1. Log in to Oracle Enterprise Repository.

2. Enter Account Service as the search string and select ADF Service in the Type field,and click Search.

3. Click Sales Cloud Account.

4. Note down the service interface name of the Web service ─ oracle.apps.crmCommon.salesParties.accountService.AccountService.

Extracting the Web Services URL

After you have identified the appropriate Web service in the “Identify the AppropriateWeb Service” section, perform the following steps.


• Navigate to an application's dashboard/workarea page that belongs to Sales CloudAccount. For example: Navigator > Customers > Create Account.

https://fusionappsoer.oracle.com/oer/FusionServiceTester.zip





Determining Which Web service to Use to Implement Your Use C ase


• Review the URL of the dashboard/workarea. You will see a URL in the browser similarto https://<domainname>/customer/fac es/C ustomerCtrWorkarea. The<domainname> might be like https://<pod-name>.<lba>.xxx.orac lecloud.com.

•

In this URL, take the "https://<domainname>". Then append the static context rootthat we extracted from OER - "/crmCommonSalesParties/AccountService" to it.

• https://<domainname>/crmCommonSalesParties/AccountService is the WSDL URLfor Sales Cloud Account.

If you have access to Oracle Enterprise Manager Fusion Applications Control, you canuse the following steps:

1. Log in to the Oracle Enterprise Manager Fusion Applications Control using the WebLogic Server credentials.

2. Selec t Orac le Fusion Customer Relationship Management from the navigation tree,and then select Fusion Applications.

3. From the tree, selec t CrmCommonApp, and then select CrmCommonApp (CRMCommonServer_1).

4. In the Web Services pane on the right side of the page, scroll to the service namethat you had noted down in the “Identifying the Appropriate Web Service” section,and click Test.

5. In the Test Web Service pane, copy the URL of a WSDL that appears in the WSDL fielduntil "?wsdl", and then paste to a notepad.

Deriving the Input Payload

Perform the following steps, after you have launched the WSDL URL in a web browser.

1. In the AccountsService endpoint page, select createAccount from the Operation

list.2. In the Parameters pane, under Account, enter the name of the account in the

OrganizationName field.

3. In the Parameters pane, under Account, enter an appropriate account type(ZCA_PROSPECT or ZCA_CUSTOMER) in the Type field.

4. Uncheck all the other fields.

5. Click the XML Source option that is next to the Operation list.

6. Copy the XML source and paste to a notepad.

Invoking the Web Service

Follow the below steps to invoke the Web service using Fusion Service Tester:

Note: You can also use your custom proxy client application, J Developer HTTP Ana lyzer, and third partytools, such as SoapUI, to call a simplified Oracle Sales Cloud Web service.

1. Launch the Fusion Service Tester. Review Appendix A to find out how to download itfrom OER (https://fusionappsoer.oracle.com/oer/FusionServiceTester.zip) and set itup.






2. In the WebService URL field, paste the WSDL URL that you derived following the stepsin the "Extracting the Web Services URL" section.

3. Enter the username and password c redentials.

4. In the Input Payload pane, paste the XML source that you derived following thesteps in the "Deriving the Input Payload" section.

5. Click Invoke. The Output Payload pane displays the output payload.

Testing the Results

1. Copy and paste the output payload to a notepad.

2. Verify if the account has been created.

3. Log in to Oracle Sales Cloud Applications.

4. In the Customers work area, search for the new account you have c reated using the

Manage C ustomers Classic UI page. You can also search using the Accountssimplified UI page.

5. Verify the account details.

Evaluating the Simplified Contact Service

Use this procedure to evaluate the simplified Contac t service (Contac tService).

Prerequisites

Ensure that the user credentials used to invoke the service has the required privilege tocreate a contact in Orac le Sales Cloud Applications.



2. Enter ContactService as the search string and select ADF Service in the Type field,and c lick Search.

3. Click Sales Cloud Contact.

4. Note down the service interface name of the Web service:oracle.apps.crmCommon.salesParties.contactService.ContactService.




• Navigate to an application's dashboard/workarea page that belongs to Sales CloudContact. For example: Navigator > Customers > Create Contact.

• Review the URL of the dashboard/workarea. You will see a URL in the browser similarto https://<domainname>/customer/faces/CustomerCtrWorkarea. The<domainname> might be like https://<pod-name>.<lba>.xxx.oraclecloud.com.






• In this URL, take the "https://<domainname>". Then append the static context rootthat we extracted from OER - "/crmCommonSalesParties/ContactService" to it.

• https://<domainname>/crmCommonSalesParties/C ontactService is the WSDL URL for

Sales Cloud C ontact.If you have access to Oracle Enterprise Manager Fusion Applications Control, use thefollowing steps:







Perform the following steps, after you have launched the WSDL URL in a web browser.

1. In the ContactService endpoint page, select createContact from the Operation list.

2. In the Parameters pane, under Contact, enter the first name and last name in theFirstName and LastName fields, respectively.

3. In the Parameters pane, under Contact, enter HZ_WS in the C reatedByModule field.

Note: HZ_WS is the inbuilt code for Web Services.

4. Uncheck all the other fields.

Note: In this example, the Type field is also unchecked. If you don’t enter a value in the Type field,then the type is Business Contact, by default.

5. Click the XML Source option.

Note: This option appears next to the Operation list.





1. Launch the Fusion Service Tester. Review Appendix A to find out how to download itfrom OER (https://fusionappsoer.oracle.com/oer/FusionServiceTester.zip) and set itup.





Oracle Sales Cloud Using Simplified SOAP Web Services for Acc ount, Household, and C ontact 17

2. In the WebService URL field, paste the WSDL URL that you derived following the stepsin the "Extracting the Web Services URL" section.




Evaluating the Results

1. Copy and paste the output payload to a notepad.

2. Verify if ZCA_Contact is assigned in the Type field, which is the default value forContact.


4. In the Customers work area, search for the new contac t that you have c reatedusing the Manage Contacts Classic UI page. You can also search using the Contacts

simplified UI page.5. Enter the first or last name in the Keywords field to search for the contact.

6. Verify the contact details.

Evaluating the Simplified Household Service

Use this procedure to evaluate the simplified Household service (HouseholdService).

Prerequisites

Ensure that the user credentials used to invoke the service has the required privilege to

create a household in Oracle Sales Cloud Applications.



2. Enter HouseholdService as the search string and selec t ADF Service in the Type field,and c lick Search.

3. Click Sales Cloud Household.

4. Note down the service interface name of the Web service:oracle.apps.crmCommon.salesParties.householdService.HouseholdService.




• Navigate to an application's dashboard/workarea page that belongs to Sales CloudAccount. For example: Navigator > Customers > Create Household.





Oracle Sales Cloud Using Simplified SOAP Web Services for Acc ount, Household, and Contac t18


•

In this URL, take the "https://<domainname>". Then append the static context rootthat we extracted from OER - "/crmCommonSalesParties/HouseholdService" to it.

• https://<domainname>/crmCommonSalesParties/HouseholdService is the WSDL URLfor Sales Cloud Household.




3. From the tree, select CrmCommonApp, and then select CrmCommonApp(CRMCommonServer_1).




After you have identified the appropriate web service in the “Identifying the

Appropriate Web Service” section, perform the following steps.1. Navigate to the HouseholdService endpoint page, as explained in the Extracting the

Web Services URL sec tion.

2. Select the createHousehold operation from the operation drop-down list.

3. Provide valid values to the mandatory fields.

4. In the parameters section, select the Include in Message checkbox if a parameter isnot mandatory and you're providing a value for it.

5. Click the XML Source radio button. This generates the input payload.










1. Launch the Fusion Service Tester. Review Appendix A to find out how to download itfrom OER (https://fusionappsoer.orac le.com/oer/FusionServiceTester.zip) and set itup.

2. In the Web Service URL field, paste the WSDL URL that you derived following the stepsin "Identifying the Appropriate Web Service" section.


4. In the Input Payload pane, paste the XML source that you derived from "Generatingthe Payload" section.



You can evaluate the results of the Web service call by verifying the creation of thehousehold in your Orac le Sales Cloud instance as follows:

1. Copy and paste the output payload to a notepad window.


3. In the Customers work area, search for the new household you have created usingthe Manage C ustomer Classic UI page. You can also search for it using theHouseholds simplified UI page.

4. Verify the household details. This confirms that the household has been c reated.

Evaluating the Simplified Relationship Service

Use this procedure to evaluate the simplified Relationship service (RelationshipService).

Prerequisites

Ensure that the user credentials used to invoke the service has the required privilege tocreate a relationship in Oracle Sales Cloud Applications.



2. Enter RelationshipService as the search string and selec t ADF Service in the Typefield, and click Search.

3. Click Sales Cloud Relationship.

4. Note down the service interface name of the Web service:oracle.apps.crmCommon.salesParties.relationshipService.RelationshipService.




• Navigate to an application's dashboard/workarea page that is related to SalesCloud Relationship. For example: Navigator > Customers.







•

In this URL, take the "https://<domainname>". Then append the static context rootthat we extracted from OER - "/crmCommonSalesParties/RelationshipService" to it.

• https://<domainname>/crmCommonSalesParties/RelationshipService is the WSDLURL for Sales Cloud Relationship.








After you have identified the appropriate web service in the “Identifying theAppropriate Web Service” section, perform the following steps.

1. Navigate to the RelationshipService endpoint page, as explained in the Identifyingthe Appropriate Web Service section.

2. Select the createRelationshp operation from the operation drop-down list.



5. Click the XML Source radio button. This generates the input payload.











2. In the Web Service URL field, paste the WSDL URL that you derived following the stepsin the "Identifying the Service" section.


4. In the Input Payload pane, paste the XML source that you derived following thesteps in the "Deriving the Input the Payload" sec tion.



You can evaluate the results of the Web service call by verifying the creation of therelationship in your Orac le Sales Cloud instance as follows:

1. Copy and paste the output payload to a notepad window


3. In the C ustomers work area, search for the customer (account or contac t) for whichyou created the relationship using the Manage Customer or the Manage Contac tClassic UI page. You can also search for it using the Account or Contac t simplified UIpage.

4. Verify the relationship details. This confirms that the relationship has been created.

Evaluating the Simplified Address Service

Use this procedure to evaluate the simplified Address service (AddressService).

Prerequisites

Ensure that the user credentials used to invoke the service has the required privilege tocreate an address in Oracle Sales Cloud Applications.



2. Enter AddressService as the search string and select ADF Service in the Type field,and c lick Search.

3. Click Sales Cloud Address.

4. Note down the service interface name of the Web service:

oracle.apps.crmCommon.salesParties.addressService.AddressService.









• Navigate to an application's dashboard/workarea page that is related to SalesCloud Address. For example: Navigator > Customers.

• Review the URL of the dashboard/workarea. You will see a URL in the browser similar

to https://<domainname>/customer/faces/CustomerCtrWorkarea. The<domainname> might be like https://<pod-name>.<lba>.xxx.oraclecloud.com.

• From this URL, take the "https://<domainname>". Then append the static contextroot that we extracted from OER - "/crmCommonSalesParties/AddressService" to it.

• https://<domainname>/crmCommonSalesParties/AddressService is the WSDL URL forSales Cloud Address.








After you have identified the appropriate web service in the “Identifying theAppropriate Web Service” section, perform the following steps.

1. Navigate to the AddressService endpoint page as explained in the Extracting theWeb Services URL sec tion.

2. Select the createAddress operation from the operation drop-down list.



5. Click the XML Source radio button. This generates the input payload.6. Copy the XML source and paste to a notepad.


Follow the below steps to invoke the Web service using the Fusion Service Tester:






Note: You can also use your custom proxy client application, J Developer HTTP Ana lyzer, and third partytools, such as SoapUI, to call a simplified Oracle Sales Cloud Web service Web service.


2. In the Web Service URL field, paste the WSDL URL that you derived following the stepsin the "Identifying the Service" section.





You can evaluate the results of the Web service call by verifying the creation of theaddress in your Orac le Sales Cloud instance as follows:

1. Copy and paste the output payload to a notepad window.

2. Verify the relationship details. This confirms that the household has been created.


4. In the C ustomers work area, search for the customer (account or contac t) for whichyou created the address using the Manage Customer or the Manage ContactClassic UI page. You can also search for it using the Account or Contac t simplified UIpage.

5. Verify the address details. This confirms that the address has been created.

Prototyping Payloads and Evaluating Web Services Using the JDeveloper HTTP

Analyzer

Use this procedure to prototype payloads and evaluate Web service call results usingthe J Developer HTTP Analyzer:

1. Launch J Developer IDE in Default role.

2. Click Tools and select the HTTP Analyzer

3. Click the Create A New Request icon.

4. In the HTTP Analyzer: Unsent Message page, Click Open WSDL button on the topright

5. Enter WSDL URL.

6. Click OK and wait for the J Developer to fetch the WSDL document.

7. Select an appropriate Web service operation.

8. Click on HTTP Content tab and paste an appropriate request payload.

9. Click SOAP Structure tab and click Request HTTP Headers






10. Click on the + (Add headers menu) icon (Sometimes, the + icon may not be visible. You may have to expand the Request HTTP Headers panel by dragging the splitterbar to the right.

11. Selec t Authorization basic.12. Enter Basic username:password such as Basic Sales_Admin: Welcome

13. Click Send Request.

14. Review the response and verify the operation result in your instance of Oracle SalesCloud.

Prototyping Payloads and Evaluating Web Services Using Third Party Tools

You can use third party tools, such as SoapUI, WebInject and Strom, to test the SalesCloud Web services. You can perform various types of Web service testing, based on

the third party tool you are using. For more information, see:• http://www.soapui.org

• https://storm.codeplex.com

• http://www.webinject.org

http://www.soapui.org/


https://storm.codeplex.com/






Orac le Sales Cloud Using Simplified SOAP Web Services for Acc ount, Household, and C ontac t 2

2 How do I …?

Managing Accounts Using the Simplified Sales Cloud Account

Web Service (AccountService)

An account is an organization or company that you want in your records for salespurposes. Accounts include organizations to which you sell, but do not includeindividuals.

Call the Sales Cloud Account service (AccountService) to create, update, find, anddelete organization accounts. When performing these operations, you can include onlyone address in the payload. You must use the Address web service to create an addressfor an account.

Create an Account Programmatically Using createAccount

You can create ac counts of the following types in Orac le Sales Cloud by calling thecreateAccount method:

• Customer: An account to whom you are actively selling or to whom you have soldpreviously. This was a Sales Account in Orac le Sales Cloud Release 7.

• Prospect: A new account to whom you plan to sell.

The sample code and payload for calling the createAccount method are as follows.

Sample XML Payload

Sample WSDL call for createAccount

https://<domainname>/crmCommonSalesParties/AccountService

Payload to create an account of the type prospect (ZCA_PROSPECT)

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<soap:Body>

<ns1:createAccountxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/accountService/types/">

<ns1:accountxmlns:ns2="http://xmlns.oracle.com/apps/crmCommon/salesParties/accountService/">

<ns2:OrganizationName>ResponsysCalifornia</ns2:OrganizationName>

<ns2:Type>ZCA_PROSPECT</ns2:Type>

<ns2:CreatedByModule>HZ_WS</ns2:CreatedByModule>

<ns2:PhoneCountryCode>1</ns2:PhoneCountryCode>



Contents


<ns2:PhoneAreaCode>650</ns2:PhoneAreaCode>

<ns2:PhoneNumber>8881111</ns2:PhoneNumber>

<ns2:PhoneExtension>123</ns2:PhoneExtension>

</ns1:account></ns1:createAccount>

</soap:Body>

</soap:Envelope>

This payload contains the minimum information to create a prospec t. It creates a newprospec t account with an organization name and contact phone number.

Payload to create an account of the type customer (ZCA_CUSTOMER)

This payload contains the information to create a customer. It creates a new customeraccount with profile and contac t information, a new address, and a relationshipbetween the newly created account and address to indicate the address is the primaryaddress for the customer.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<soap:Body>

<ns1:createAccountxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/accountService/types/">

<ns1:accountxmlns:ns2="http://xmlns.oracle.com/apps/crmCommon/salesParties/accountServ

ice/"><ns2:SourceSystem>CSV</ns2:SourceSystem>

<ns2:SourceSystemReferenceValue>SBS_ACCT_SSR_23417</ns2:SourceSystemReferenceValue>

<ns2:OrganizationName>Materials Process EngineeringLLC</ns2:OrganizationName>

<ns2:CEOName>Bob Doyle</ns2:CEOName>

<ns2:Type>ZCA_CUSTOMER</ns2:Type>

<ns2:IndustryCodeType>ONE VOICE</ns2:IndustryCodeType>

<ns2:IndustryCode>2700</ns2:IndustryCode>

<ns2:CreatedByModule>HZ_WS</ns2:CreatedByModule><ns2:PhoneCountryCode>1</ns2:PhoneCountryCode>



<ns2:FaxCountryCode>1</ns2:FaxCountryCode>

<ns2:FaxAreaCode>650</ns2:FaxAreaCode>

<ns2:FaxNumber>8882222</ns2:FaxNumber>

<ns2:EmailAddress>[email protected]</ns2:EmailAddress>



How do I …? ▪Managing Accounts Using the Simplified Sales Cloud Account Web Service

(AccountService)


<ns2:URL>https://www.wpi.edu/about/tour/washburn.html</ns2:URL>

<ns2:PrimaryAddressxmlns:ns3="http://xmlns.oracle.com/apps/crmCommon/salesParties/commonServi

ce/"><ns3:SourceSystem>CSV</ns3:SourceSystem>

<ns3:SourceSystemReferenceValue>SBS_ACCT_ADD_SSR_419</ns3:SourceSystemReferenceValue>

<ns3:AddressLine1>4578 El CaminoReal</ns3:AddressLine1>

<ns3:City>San Mateo</ns3:City>

<ns3:Country>US</ns3:Country>

<ns3:County>San Mateo</ns3:County>

<ns3:PostalCode>94401</ns3:PostalCode>

<ns3:State>CA</ns3:State></ns2:PrimaryAddress>

</ns1:account>

</ns1:createAccount>

</soap:Body>

</soap:Envelope>

Search for an Account Programmatically Using findAccount

You can search for accounts using the findAccount method. The sample payload forcalling the findAccount method is as follows. This sample payload finds all accounts thatcontain Alcoa in the organization name.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

<soap:Body>

<ns1:findAccountxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/accountService/types/">

<ns1:findCriteriaxmlns:ns2="http://xmlns.oracle.com/adf/svc/types/">

<ns2:filter>

<ns2:conjunction>And</ns2:conjunction>

<ns2:group>


<ns2:item>


<ns2:attribute>OrganizationName</ns2:attribute>

<ns2:operator>CONTAINS</ns2:operator>

<ns2:value>Alcoa</ns2:value>

</ns2:item>



Contents


</ns2:group>

</ns2:filter>

</ns1:findAccount>

</soap:Body></soap:Envelope>

Update an Account and its Primary Address Programmatically Using

updateAccount

You can update an account and its primary address by using the updateAccountmethod. When updating an account, you must provide the partyId of the account.

The sample payload for calling the updateAc count method is as follows. This samplepayload updates the profile information, contact information, and the primary addressfor the account with the PartyId 300100032610977.


<soap:Body>

<ns1:updateAccountxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/accountService/types/">


<ns2:PartyId>300100059083744</ns2:PartyId>

<ns2:CEOName>Mike Burns</ns2:CEOName>

<ns2:CEOTitle>MR</ns2:CEOTitle>

<ns2:Comments>Updating the organization information basedon recent changes as of 04/28/2104</ns2:Comments>





<ns2:PrimaryAddressxmlns:ns3="http://xmlns.oracle.com/apps/crmCommon/salesParties/commonService/">

<ns3:AddressLine1>21 El Camino Real</ns3:AddressLine1>

<ns3:AddressLine2>Suite 3001</ns3:AddressLine2>

<ns3:AddressLine3>West Wing</ns3:AddressLine3></ns2:PrimaryAddress>

</ns1:account>

</ns1:updateAccount>

</soap:Body>

</soap:Envelope>




(AccountService)


Delete an Account Programmatically Using deleteAccount

You can delete an account by using the deleteContact method. When deleting anaccount, you must provide any identifier of the account.

The sample payload for calling the deleteAccount method is as follows. In this samplepayload, we are providing the origin system and the origin system reference to identifythe account.


<soap:Body>

<ns1:deleteAccountxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/accountService/types/">

<ns1:account

xmlns:ns2="http://xmlns.oracle.com/apps/crmCommon/salesParties/accountService/">

<ns2:SourceSystem>CSV</ns2:SourceSystem>

<ns2:SourceSystemReferenceValue>SBS_ACCT_SSR_245401</ns2:SourceSystemReferenceValue>

</ns1:account>

</ns1:deleteAccount>

</soap:Body>

</soap:Envelope>

Retrieve an Account Programmatically Using getAccount

You can retrieve an account by using the getContact method. When retrieving anaccount, you must provide the PartyId of the account.

The sample payload for calling the getAccount method is as follows. In this samplepayload, we are retrieving the account with the partyId 300100059257833.


<soap:Body>

<ns1:getAccountxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/accountService/types/">


</ns1:getAccount>

</soap:Body>

</soap:Envelope>



Contents


Merge an account Programmatically Using mergeAccount

You can merge attribute information in an account using the mergeAccount method. The service updates the object if it exists, else creates a new account.

The sample payload for calling the mergeAccount method is as follows. In this samplepayload, we are updating the account with the partyId 300100059257833. The methodwill update the account if it exists, else it will create a new account.


<soap:Body>

<ns1:mergeAccountxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/accountService/types/">



<ns2:SourceSystemReferenceValue>300100059257833</ns2:SourceSystemReferenceValue>

<ns2:OrganizationName>Alcoa Systems</ns2:OrganizationName>

<ns2:OwnerPartyId>300447669257833</ns2:OwnerPartyId>

<ns2:OwnerPartyNumber>55748</ns2:OwnerPartyNumber>

<ns2:OwnerEmailAddress>[email protected]</ns2:OwnerEmailAddress>

<ns2:YearEstablished>1980</ns2:YearEstablished>

<ns2:YearIncorporated>1981</ns2:YearIncorporated><ns2:PrimaryAddress

xmlns:ns3="http://xmlns.oracle.com/apps/crmCommon/salesParties/commonService/">

<ns3:AddressLine1>#24823</ns3:AddressLine1>

<ns3:AddressLine2>Alcoa Drive</ns3:AddressLine2>

<ns3:AddressLine3>Redmond</ns3:AddressLine3>

<ns3:AddressLine4>CA</ns3:AddressLine4>

</ns2:PrimaryAddress>

</ns1:account>

</ns1:mergeAccount>





(AccountService)


Perform a Specific Operation (Create, Update, Delete, or Merge) on a List of

Accounts Using processAccount

You can perform create, update, delete, or merge operation on a list of accounts in

Oracle Sales Cloud by calling the processAccount method.

The sample payload for calling the processAccount method is as follows. This samplepayload creates two accounts using one API call.


<soap:Body>

<ns1:processAccountxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/accountService/types/">

<ns1:changeOperation>Create</ns1:changeOperation>


<ns2:OrganizationName>Pinnacle Energy Inc</ns2:OrganizationName>



</ns1:account>


<ns2:OrganizationName>Pinnacle

Financials</ns2:OrganizationName><ns2:CEOName>John Smith</ns2:CEOName>



</ns1:account>

<ns1:processControlxmlns:ns2="http://xmlns.oracle.com/adf/svc/types/">

<ns2:returnMode>Full</ns2:returnMode>

<ns2:exceptionReturnMode>Full</ns2:exceptionReturnMode>

<ns2:partialFailureAllowed>true</ns2:partialFailureAllowed>

</ns1:processControl>

</ns1:processAccount>

</soap:Body>

</soap:Envelope>



Contents


Managing Contacts Using the Simplified Sales Cloud Contact Web

Service (ContactService)

A contac t is a person who either has a relationship to other objects like account andhousehold or is a customer or prospect you direc tly sell to. Contac ts can be of thefollowing types:

• Business contacts: People related to accounts or households

• Customer: People to whom you sell direc tly

• Prospect: A new contact to whom you plan to sell

A contact could be either contact of an account or household in a B2B scenario or abuying customer in a B2C scenario.

Call the Sales Cloud Contac t service (Contac tService) to create, find, update, retrieve,delete, get, and merge contacts. When performing these operations, you can includeonly one (primary) address in the payload. When creating a contact with multipleaddresses you must use the PrimaryAddress child entity for one (primary) address andthe Address service for the rest of the addresses.

Create a Contact Programmatically Using createContact

You can create contac ts of the type, business, customer, or prospect, in Orac le SalesCloud by calling the createContact method. The sample payload for calling thecreateContact method is as follows.

Sample XML Payload

Payload to create an contact of the type business contact (ZCA_CONTACT)


<soap:Body>

<ns1:createContactxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/contactService/types/">

<ns1:contactxmlns:ns2="http://xmlns.oracle.com/apps/crmCommon/salesParties/contactService/">


<ns2:SourceSystemReferenceValue>SBS_CNT_24616</ns2:SourceSystemReferenceValue>

<ns2:FirstName>SBS_FN</ns2:FirstName>

<ns2:LastName>SBS_LN</ns2:LastName>

<ns2:WorkPhoneCountryCode>1</ns2:WorkPhoneCountryCode>

<ns2:WorkPhoneAreaCode>650</ns2:WorkPhoneAreaCode>

<ns2:WorkPhoneNumber>2276000</ns2:WorkPhoneNumber>

<ns2:WorkPhoneExtension>001</ns2:WorkPhoneExtension>

<ns2:MobileCountryCode>1</ns2:MobileCountryCode>



How do I …? ▪Managing C ontacts Using the Simplified Sales Cloud C ontact Web Service

(ContactService)


<ns2:MobileAreaCode>650</ns2:MobileAreaCode>

<ns2:MobileNumber>2276001</ns2:MobileNumber>

<ns2:MobileExtension>002</ns2:MobileExtension>

<ns2:FaxCountryCode>1</ns2:FaxCountryCode><ns2:FaxAreaCode>650</ns2:FaxAreaCode>

<ns2:FaxNumber>2276003</ns2:FaxNumber>

<ns2:FaxExtension>003</ns2:FaxExtension>



<ns2:ClassificationCategory>CUSTOMER_CATEGORY</ns2:ClassificationCategory>

<ns2:ClassificationCode>BROKER</ns2:ClassificationCode>


<ns3:AddressLine1>Commerce atMantri</ns3:AddressLine1>

<ns3:Country>IN</ns3:Country>


</ns1:contact>

</ns1:createContact>

</soap:Body>

</soap:Envelope>

Payload to create an contact of the type prospect (ZCA_PROSPECT)


<soap:Body>




<ns2:SourceSystemReferenceValue>SBS_CNT_CUST_24620_1</ns2:SourceSystemReferenceValue>



<ns2:ContactName>SBS FN LN</ns2:ContactName>


<ns2:FavoriteContactFlag>TRUE</ns2:FavoriteContactFlag>

<ns2:CreatedByModule>AMS</ns2:CreatedByModule>





Contents




<ns3:AddressLine1>PTP</ns3:AddressLine1>

<ns3:City>BENGALURU</ns3:City>


<ns3:State>KA</ns3:State>


</ns1:contact>


</soap:Body>

</soap:Envelope>

Payload to create an contact of the type customer (ZCA_CUSTOMER)


<soap:Body>




<ns2:SourceSystemReferenceValue>SBS_CNT_CUST_24620</ns2:SourceSystemReferenceValue>



<ns2:ContactName>SBS FN LN</ns2:ContactName>


<ns2:FavoriteContactFlag>TRUE</ns2:FavoriteContactFlag>






<ns3:AddressLine1>PTP</ns3:AddressLine1>

<ns3:City>BENGALURU</ns3:City>


<ns3:State>KA</ns3:State>




How do I …? ▪Managing C ontacts Using the Simplified Sales Cloud Contact Web Service

(ContactService)


</ns1:contact>


</soap:Body>

</soap:Envelope>

Search for a Contact Programmatically Using findContact

You can find contacts in Oracle Sales Cloud by calling the findContact method. Thesample payload for calling the findContac t method is as follows.

Sample XML Payload


<soap:Body>

<ns1:findContactxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/contactService/types/">


<ns2:fetchStart>0</ns2:fetchStart>

<ns2:fetchSize>-1</ns2:fetchSize>

<ns2:filter>


<ns2:group>


<ns2:upperCaseCompare></ns2:upperCaseCompare>

<ns2:item>



<ns2:attribute>PartyId</ns2:attribute>

<ns2:operator>=</ns2:operator>

<ns2:value>300100044016994</ns2:value>

</ns2:item>

</ns2:group>

</ns2:filter>

<ns2:excludeAttribute></ns2:excludeAttribute>

</ns1:findCriteria>

</ns1:findContact>


Update a Contact and its Primary Address Programmatically Using

updateContact

You can update a contact and its primary address in Oracle Sales Cloud by calling theupdateContact method. The sample payload for calling the updateContac t method isas follows.



Contents


Sample XML Payload


<soap:Body>

<ns1:updateContactxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/contactService/types/">




<ns2:FirstName>SBS_FN_SSR</ns2:FirstName>

<ns2:LastName>SBS_LN_SSR</ns2:LastName>

<ns2:Department>RESEARCH</ns2:Department><ns2:EmailAddress>[email protected]</ns2:EmailAddress>


<ns3:AddressLine1>UPDATE SSR LINE1</ns3:AddressLine1>


</ns1:contact>

</ns1:updateContact>

</soap:Body>

</soap:Envelope>

Delete a Contact Programmatically Using deleteContact

You can delete a contact and its relationship with the contact’s primary address inOracle Sales Cloud by calling the deleteContact method. The sample payload forcalling the deleteContact method is as follows.

Sample XML Payload

Party ID


<soap:Body>

<ns1:deleteContact

xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/contactService/types/">



</ns1:contact>

</ns1:deleteContact>



How do I …? ▪Managing C ontacts Using the Simplified Sales Cloud C ontact Web Service

(ContactService)


</soap:Body>

</soap:Envelope>

Party Number


<soap:Body>

<ns1:deleteContactxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/contactService/types/">


<ns2:PartyNumber>CDRM_737311</ns2:PartyNumber>

</ns1:contact>

</ns1:deleteContact></soap:Body>

</soap:Envelope>

SSR Value


<soap:Body>

<ns1:deleteContactxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/contactService/types/">




</ns1:contact>

</ns1:deleteContact>

</soap:Body>

</soap:Envelope>

Retrieve a Contact Programmatically Using getContact

You can retrieve a contact in Oracle Sales Cloud by calling the getContac t method. The sample payload for calling the getContac t method is as follows.

Sample XML Payload




Contents


<soap:Body>

<ns1:getContactxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/contactService/types/">


</ns1:getContact>

</soap:Body>

</soap:Envelope>

Merge a Contact Programmatically Using mergeContact

You can replace the existing contact details or create a new contact if it doesn’t already exist in Oracle Sales

Cloud by calling the mergeContact method. The sample payload for calling the mergeContact method is as

follows:

Sample XML Payload


<soap:Body>

<ns1:mergeContactxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/contactService/types/">



<ns2:SourceSystemReferenceValue>SBS_CNT_225607</ns2:SourceSystemReferenceV

alue><ns2:FirstName>SBS_FN_SSR_MERGE</ns2:FirstName>

<ns2:LastName>SBS_LN_SSR_MERGE</ns2:LastName>

<ns2:Department>RESEARCH</ns2:Department>



<ns3:AddressLine2>UPDATE SSR LINE1MERGE</ns3:AddressLine2>


</ns1:contact>

</ns1:mergeContact>

</soap:Body>

</soap:Envelope>



How do I …? ▪Managing Households Using the Simplified Sales Cloud Household Web

Service



Contacts Using processContact

You can perform a create, update, delete, or merge operation on a list of contac t rows

in Oracle Sales Cloud by calling the processContac t method. The sample payload forcalling the processContact method is as follows.

Sample XML Payload


<soap:Body>

<ns1:processContactxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/contactService/types/">



<ns2:FirstName>John</ns2:FirstName>

<ns2:LastName>Smith</ns2:LastName>


</ns1:contact>


<ns2:FirstName>George</ns2:FirstName>

<ns2:LastName>Clooney</ns2:LastName>


</ns1:contact>






</ns1:processContact>


Managing Households Using the Simplified Sales Cloud Household

Web Service

You can use household to track information about a groups of contac ts, including:



Contents


• Household members

• Sales Teams

• Relationships

• Leads and opportunities• Assets

• Notes, tasks, and appointments

• Conversations

Call the Sales Cloud Household service (HouseholdService) to create, update, find, anddelete the parties of type household. When performing these operations, you caninclude only one address in the payload. You must use the Address web service tocreate an address for a household.

Create a Household Programmatically Using createHousehold

You can create households in Oracle Sales Cloud by calling the createHouseholdmethod. The sample payload for calling the createHousehold method is as follows.

Sample XML Payload

Payload to create a household of the type prospect (ZCA_PROSPECT)


<soap:Body>

<ns1:createHouseholdxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/householdService/types/">

<ns1:householdxmlns:ns2="http://xmlns.oracle.com/apps/crmCommon/salesParties/householdService/">

<ns2:HouseholdName>SBS_HLD</ns2:HouseholdName>

<ns2:HouseholdSize>3</ns2:HouseholdSize>

<ns2:UniqueNameSuffix>Abc</ns2:UniqueNameSuffix>

<ns2:AverageAge>30</ns2:AverageAge>

<ns2:AnnualIncome>1000000</ns2:AnnualIncome>

<ns2:Child0to6Num>1</ns2:Child0to6Num>



<ns2:DependentsNum>2</ns2:DependentsNum>

<ns2:MedianAge>30</ns2:MedianAge>

<ns2:WealthAmt>10000000</ns2:WealthAmt>



<ns2:SourceSystemReferenceValue>SBS_HLD_131250</ns2:SourceSystemReferenceValue>




Service










<ns3:AddressLine1>300 OracleParkway</ns3:AddressLine1>

<ns3:City>Bengaluru</ns3:City>




</ns1:household>

</ns1:createHousehold>

</soap:Body>

</soap:Envelope>

Search for a Household Programmatically Using findHousehold

You can find household in Orac le Sales Cloud by calling the findHousehold method. Thepayload for calling the findHousehold method is as follows:

Sample XML Payload


<soap:Body>

<ns1:findHouseholdxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/householdService/types/">


<ns2:fetchStart></ns2:fetchStart>

<ns2:fetchSize></ns2:fetchSize>

<ns2:filter>

<ns2:conjunction>And</ns2:conjunction><ns2:group>



<ns2:item>



<ns2:attribute>PartyNumber</ns2:attribute>



Contents



<ns2:value>CDRM_747827</ns2:value>

</ns2:item>

</ns2:group></ns2:filter>


</ns1:findCriteria>

<ns1:findControlxmlns:ns2="http://xmlns.oracle.com/adf/svc/types/">

<ns2:retrieveAllTranslations></ns2:retrieveAllTranslations>

</ns1:findControl>

</ns1:findHousehold >

</soap:Body>

</soap:Envelope>

Update a Household and its Primary Address Programmatically Using

updateHousehold

You can update a household and its primary address in Orac le Sales Cloud by callingthe updateHousehold method. The sample payload for calling the updateHouseholdmethod is as follows:

Sample XML Payload


<soap:Body><ns1:updateHousehold

xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/householdService/types/">


<ns2:HouseholdName>UPDATED_SBS_HLD_227259</ns2:HouseholdName>










Service


<ns3:City>Shimoga</ns3:City>



</ns1:household></ns1:updateHousehold>

</soap:Body>

</soap:Envelope>

Delete a Household Programmatically Using deleteHousehold

You can delete a household and its relationship with the household’s primary address inOracle Sales Cloud by calling the deleteHousehold method. The sample payload forcalling the deleteHousehold method is as follows:

Sample XML Payload

Party ID


<soap:Body>

<ns1:deleteHouseholdxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/householdService/types/">



</ns1:household></ns1:deleteHousehold>

</soap:Body>

</soap:Envelope>

Party Number


<soap:Body>




</ns1:household>

</ns1:deleteHousehold>

</soap:Body>

</soap:Envelope>



Contents


SSR


<soap:Body>





</ns1:household>

</ns1:deleteHousehold>

</soap:Body>

</soap:Envelope>

Retrieve a Household Programmatically Using getHousehold

You can retrieve a household based on the primary key identifier in Orac le Sales Cloudby calling the getHousehold method. The sample payload for calling the getHouseholdmethod is as follows:

Sample XML Payload


<soap:Body>

<ns1:getHouseholdxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/householdService/types/">


</ns1:getHousehold>

</soap:Body>

</soap:Envelope>

Merge a Household Programmatically Using mergeHousehold

You can create a household or update a household if it already exists in Oracle SalesCloud by calling the mergeHousehold method. The sample payload for calling themergeHousehold method is as follows:

Sample XML Payload


<soap:Body>




Service


<ns1:mergeHouseholdxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/householdService/types/">

<ns1:household

xmlns:ns2="http://xmlns.oracle.com/apps/crmCommon/salesParties/householdService/">


<ns2:HouseholdName>UPDATED_SBS_HLD_227421</ns2:HouseholdName>



<ns3:SourceSystemReferenceValue>ADD_SBS_227421</ns3:SourceSystemReferenceValue>



<ns3:City>Shimoga</ns3:City>



</ns1:household>

</ns1:mergeHousehold>

</soap:Body>

</soap:Envelope>


Households Using processHousehold

You can perform create, update, delete, or merge operation on a list of household rowsin Oracle Sales Cloud by calling the processHousehold method. The sample payload forcalling the processHousehold method is as follows:

Sample XML Payload


<soap:Body>

<ns1:processHousehold

xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/householdService/types/">



<ns2:HouseholdName>Household1</ns2:HouseholdName>




Contents

Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact46


</ns1:household>


<ns2:HouseholdName>Household2</ns2:HouseholdName>



</ns1:household>






</ns1:processHousehold>

</soap:Body>

</soap:Envelope>

Managing Addresses Using the Simplified Sales Cloud Address

Web Service (AddressService)

Call the Sales Cloud Address service (AddressService) to provide a representation of theAddress entity in Orac le Sales Cloud.

Create an Address Programmatically Using createAddress

You can create addresses in Orac le Sales Cloud by calling the createAddress method. The sample payload for calling the createAddress method is as follows.

Sample XML Payload

Payload to create an address


<soap:Body>

<ns1:createAddressxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/addressService/types/">



How do I …? ▪Managing Addresses Using the Simplified Sales Cloud Address Web Service

(AddressService)


<ns1:addressxmlns:ns2="http://xmlns.oracle.com/apps/crmCommon/salesParties/addressService/">

<ns2:PrimaryFlag>true</ns2:PrimaryFlag>


<ns2:Address1>300 Oracle Parkway</ns2:Address1>

<ns2:City>Redwood City</ns2:City>

<ns2:State>CA</ns2:State>

<ns2:Country>US</ns2:Country>



<ns2:AddressNumber>SBS1291252</ns2:AddressNumber>

<ns2:SourceSystem>DNB</ns2:SourceSystem>

<ns2:SourceSystemReferenceValue>ADD1291253</ns2:SourceSystemReferenc

eValue>

<ns2:AddressPurpose>

<ns2:Purpose>BILL_TO</ns2:Purpose>

</ns2:AddressPurpose>


<ns2:Purpose>PAY_TO</ns2:Purpose>


</ns1:address>

</ns1:createAddress>

</soap:Body>

</soap:Envelope>

Search for an Address Programmatically Using findAddress

You can find address in Orac le Sales Cloud by calling the findAddress method. Thesample payload for calling the findAddress method is as follows.

Sample XML Payload


<soap:Body>

<ns1:findAddressxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/addressService/types/">




<ns2:filter>

<ns2:group>


<ns2:item>



Contents




<ns2:attribute>PartyId</ns2:attribute>

<ns2:operator>=</ns2:operator><ns2:value>300100046210740</ns2:value>

</ns2:item>

</ns2:group>

</ns2:filter>


</ns1:findCriteria>


<ns2:retrieveAllTranslations>TRUE</ns2:retrieveAllTranslations>

</ns1:findControl>

</ns1:findAddress>

</soap:Body>

</soap:Envelope>

Update an Address and Address Purpose Programmatically Using

updateAddress

You can update an address and Address Purpose in Oracle Sales Cloud by calling the

updateAddress method. The sample payload for calling the updateAddress method isas follows:

Sample XML Payload

Address ID


<soap:Body>

<ns1:updateAddressxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/addressService/types/">


<ns2:AddressId>300100089301612</ns2:AddressId>

<ns2:DoNotMailFlag>TRUE</ns2:DoNotMailFlag>

<ns2:Address1>400 Commerce at Mantri</ns2:Address1>





(AddressService)


<ns2:Description>Updating theAddressline1</ns2:Description>

</ns1:address>

</ns1:updateAddress>

</soap:Body>

</soap:Envelope>

Address Number


<soap:Body>


<ns1:address

xmlns:ns2="http://xmlns.oracle.com/apps/crmCommon/salesParties/addressService/">


<ns2:DoNotMailFlag>FALSE</ns2:DoNotMailFlag>

<ns2:Address1>400 PTP</ns2:Address1>

<ns2:City>BDVT</ns2:City>





</ns2:AddressPurpose></ns1:address>


</soap:Body>

</soap:Envelope>

Update with SSR


<soap:Body>



<ns2:PrimaryFlag>FALSE</ns2:PrimaryFlag>


<ns2:Address2>UPDATED</ns2:Address2>




Contents


<ns2:SourceSystemReferenceValue>ADD129103</ns2:SourceSystemReferenceValue>

</ns1:address>


</soap:Body>

</soap:Envelope>

Delete an Address Programmatically Using deleteAddress

You can delete an address in Oracle Sales Cloud by calling the deleteAddress method. The sample payload for calling the deleteAddress method is as follows:

Sample XML Payload

Address ID


<soap:Body>

<ns1:deleteAddressxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/addressService/types/">



</ns1:address>

</ns1:deleteAddress></soap:Body>

</soap:Envelope>

Address Number


<soap:Body>




</ns1:address>

</ns1:deleteAddress>

</soap:Body>

</soap:Envelope>




(AddressService)


Address SSR


<soap:Body>




<ns2:SourceSystemReferenceValue>ADDSSR01122</ns2:SourceSystemReferenceValue>

</ns1:address>

</ns1:deleteAddress>


Retrieve an Address Programmatically Using getAddress

You can retrieve an address in Oracle Sales Cloud by calling the getAddress method. The sample payload for calling the getAddress method is as follows:

Sample XML Payload


<soap:Body>

<ns1:getAddressxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/addressService/types/">


</ns1:getAddress>

</soap:Body>

</soap:Envelope>

Merge an Address Programmatically Using mergeAddress

You can merge an address in Orac le Sales Cloud by calling the mergeAddress method. The sample payload for calling the mergeAddress method is as follows:

Sample XML Payload

Address ID




Contents


<soap:Body>

<ns1:mergeAddressxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/addressService/types/">




<ns2:Address1>400 Commerce at Mantri_usingmerge</ns2:Address1>




<ns2:AddressId>300100032442943</ns2:AddressId><ns2:Purpose>BILL_TO</ns2:Purpose>


</ns1:address>

</ns1:mergeAddress>

</soap:Body>

</soap:Envelope>

Address Number


<soap:Body><ns1:mergeAddress

xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/addressService/types/">




<ns2:Address1>400 PTP UPDATE USING MERGE</ns2:Address1>

<ns2:City>BDVT</ns2:City>

<ns2:Description>Updating the

Addressline1</ns2:Description>





</ns1:address>

</ns1:mergeAddress>



How do I …? ▪Managing Relationships Using the Simplified Sales Cloud Relationship Web

Service


</soap:Body>

</soap:Envelope>

Update with SSR


<soap:Body>



<ns2:PrimaryFlag>TRUE</ns2:PrimaryFlag>


<ns2:Address2>UPDATED USING MERGE</ns2:Address2><ns2:SourceSystem>DNB</ns2:SourceSystem>

<ns2:SourceSystemReferenceValue>ADD129103</ns2:SourceSystemReferenceValue>



<ns2:Purpose>BILL_TO</ns2:Purpose>


</ns1:address>


</soap:Body>

</soap:Envelope>

Managing Relationships Using the Simplified Sales Cloud

Relationship Web Service

Call the Sales Cloud Relationship service (RelationshipService) to create, update,retrieve, and delete relationships.

Create a Relationship Programmatically Using createRelationship

You can create relationship in Oracle Sales Cloud by calling the createRelationship

method. The sample payload for calling the createRelationship method is as follows.

Sample XML Payload

Payload to create a relationship between a contact to account with Primary key and Alt Key

Primary Key


<soap:Body>



Contents


<ns1:createRelationshipxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/relationshipService/types/">

<ns1:relationship

xmlns:ns2="http://xmlns.oracle.com/apps/crmCommon/salesParties/relationshipService/">

<ns2:ObjectPartyId>300100039444422</ns2:ObjectPartyId>

<ns2:SubjectPartyId>300100039444433</ns2:SubjectPartyId>

<ns2:RelationshipType>CONTACT</ns2:RelationshipType>

<ns2:RelationshipCode>CONTACT_OF</ns2:RelationshipCode>

<ns2:StartDate>2020-11-17</ns2:StartDate>

<ns2:EndDate>2025-12-31</ns2:EndDate>


<ns2:Comments>FUTURE DATERELATIONSHIP</ns2:Comments>

</ns1:relationship>

</ns1:createRelationship>

</soap:Body>

</soap:Envelope>

Alternate Key


<soap:Body><ns1:createRelationship

xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/relationshipService/types/">

<ns1:relationshipxmlns:ns2="http://xmlns.oracle.com/apps/crmCommon/salesParties/relationshipService/">





<ns2:Comments>CURRENT DATE</ns2:Comments>

<ns2:SubjectPartyNumber>CDRM_414573</ns2:SubjectPartyNumber>

<ns2:ObjectPartyNumber>SBS_AACT_2171247</ns2:ObjectPartyNumber>

</ns1:relationship>

</ns1:createRelationship>

</soap:Body>

</soap:Envelope>




Service


Search for a Relationship Programmatically Using findRelationship

You can find relationship in Oracle Sales Cloud by calling the findRelationship method. The sample payload for calling the findRelationship method is as follows.

Sample XML Payload


<soap:Body>

<ns1:findRelationshipxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/relationshipService/types/">




<ns2:filter>


<ns2:group>



<ns2:item>



<ns2:attribute>SubjectPartyId</ns2:attribute>


<ns2:value>300100044841487</ns2:value>

</ns2:item>

<ns2:item>



<ns2:attribute>ObjectPartyId</ns2:attribute>


<ns2:value>300100044841494</ns2:value>

</ns2:item>

</ns2:group>

</ns2:filter><ns2:excludeAttribute></ns2:excludeAttribute>

</ns1:findCriteria>


<ns2:retrieveAllTranslations></ns2:retrieveAllTranslations>

</ns1:findControl>



Contents


</ns1:findRelationship>

</soap:Body>

</soap:Envelope>

Update a Relationship and its Primary Address Programmatically Using

updateRelationship

You can update a relationship and its primary address in Oracle Sales Cloud by callingthe updateRelationship method. The sample payload for calling the updateRelationshipmethod is as follows:

Sample XML Payload


<soap:Body>

<ns1:updateRelationshipxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/relationshipService/types/">







<ns2:Comments>Updating End Date</ns2:Comments>

</ns1:relationship>

</ns1:updateRelationship>

</soap:Body>

</soap:Envelope>

Merge a Relationship Programmatically Using mergeRelationship

You can merge a relationship by calling the mergeRelationship method. The samplepayload for calling the mergeRelationship method is as follows.

Sample XML Payload

Primary Key


<soap:Body>

<ns1:mergeRelationshipxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/relationshipService/types/">




Service





<ns2:RelationshipType>MEMBERSHIP</ns2:RelationshipType>

<ns2:RelationshipCode>MEMBER_OF</ns2:RelationshipCode>

<ns2:StartDate>2030-11-17</ns2:StartDate>



<ns2:Comments>FUTURE DATE RELATIONSHIP WITHCONTACT</ns2:Comments>

</ns1:relationship>

</ns1:mergeRelationship>

</soap:Body>

</soap:Envelope>

Alternate Key


<soap:Body>

<ns1:mergeRelationshipxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/relationshipService/types/">


<ns2:RelationshipType>MEMBERSHIP</ns2:RelationshipType>

<ns2:RelationshipCode>MEMBER_OF</ns2:RelationshipCode>



<ns2:Comments>CURRENT DATE</ns2:Comments>

<ns2:SubjectPartyNumber>CDRM_414607</ns2:SubjectPartyNumber>

<ns2:ObjectPartyNumber>CDRM_415617</ns2:ObjectPartyNumber>

</ns1:relationship>

</ns1:mergeRelationship>

</soap:Body>

</soap:Envelope>



Contents



Relationships Using processRelationship

You can perform a create, update, delete, or merge operation on a list of relationship

rows in Oracle Sales Cloud by calling the processRelationship method. The samplepayload for calling the processRelationship method is as follows.

Sample XML Payload


<soap:Body>

<ns1:processRelationshipxmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/relationshipService/types/">







</ns1:relationship>






</ns1:processRelationship>

</soap:Body>

</soap:Envelope>




You can use an appropriate IDE to develop a proxy client on a platform of your choicesuch as J ava, .Net, or ASP to call Web services and integrate applications with OracleSales Cloud using Web services. You c an use any IDE that supports the SOAP standardsand conforms to WS Security 1.1 policies to develop the client application. You canbuild a static proxy, dynamic proxy, or a dynamic-static proxy depending on yourbusiness requirements.

Points to Consider While Designing Web Service Proxy Clients

You must consider the pros and cons of static proxies:

• Pros:

• Proxy compiled at design time• Collec tion of classes usually generated (e.g. J AX-B), helps with the development• Quick and easy for POCs and implementations where the server contract

doesn’t change dramatically, or uses standard fields

• Cons

• If a developer adds a field to the Oracle Sales Cloud then these fields are addedto the WSDL. Unless the proxy is re-generated then these fields won’t be seen bythe code

You should also keep in mind the benefits of dynamic proxies:

• Compile nothing at development time, all resolved at runtime

• Application retrieves WSDL, dynamically constructs calls

• Able to manage customizations and dynamicity in WSDL

• More robust for production use

However, dynamic proxies are more complex to develop.

Some other factors that could impac t your choice of Web service proxy type arefollows:

• The need to add new custom fields or custom child objects changes the payload

• The need to integrate with multiple sales Cloud tenants, each having differentcustomizations

• Publishing applications to Oracle Marketplace, you want to make sure your webservice works on everyone's tenant instance

• Static Web Service proxies may not be able to manipulate new custom fields easily

3 Invoking A Simplified WebService Using Web Service ProxyClients



Contents


Invoking A Simplified Web Service Using A Static Proxy

Some of the IDEs that you can use to build Web service static proxy clients are J Developer, Eclipse, and NetBeans.

The following procedure describes how to build a Web service proxy client using Orac le J Developer.

1. Launch Oracle J Developer IDE in Default role.

2. Click on the File menu and select New

3. In the New Gallery dialog, select Generic Project and C lick OK

4. In the Create Generic Project Dialog, specify the Project Name and Direc tory, andthen click Finish.



Invoking A Simplified Web Service Using Web Service Proxy Clients▪Invoking A Simplified

Web Service Using A Static Proxy


5. Right click on the project and click on new (CTRL+N).

6. In the New Gallery dialog, under Business Tier selec t Web Services and then WebService Proxy

7. Click OK.

8. In the C reate Web Service Proxy wizard, click Next.



Contents

Oracle Sales Cloud Using Simplified SOAP Web Services for Acc ount, Household, and C ontac t62

9. Selec t JAX-WS Style and c lick Next.

10. Enter URL of the WSDL in the format :

http://<crm_server:PortNumber>/crmCommonSalesParties/AccountService?

WSDL.



Invoking A Simplified Web Service Using Web Service Proxy Clients▪Invoking A Simplified

Web Service Using A Static Proxy

Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and C ontact 63

11. Deselect Copy WSDL into Project.

12. Click Next.

13. Click Next.

14. Click Next.

15. Select oracle/wss11_saml_token_with_message_protection_client_policy



Contents


16. Click Next.

17. Click Finish and wait for proxy generation.

18. Double Click on AccountServiceSoapHttpPortClient.java which is basically the file tobe edited to invoke the service.

19. Add your custom code to call the desired methods, such as createAccount,

updateAccount, or deleteAc count, or with the required input parameters.

Note: See Appendix B for sample code to call the different methods. The appendix contains code for asample a static Web Service Proxy -J AX-WS Style built with Orac le J Developer Studio for the Sales CloudAccount Web service.

Authentication

In order to authenticate to the Sales Cloud application, one of the 2 security policieslisted below have to be adhered to. The policies are managed by Oracle Web ServicesManager.

• oracle/wss_username_token_over_ssl_client_policy This policy includes credentials in the WS-Security UsernameToken header in the SOAPrequest messages. The plain text mechanism is supported. The policy uses SSL forachieving transport layer security.

The following is an example of an authentication mechanism to Sales Cloud. This is acode snippet written in the J ava programming language, demonstrating theauthentication c ode to login to a Fusion environment using the username token over SSLpolicy. In order for this code snippet to run, the OWSM agent should be present and



Invoking A Simplified Web Service Using Web Service Proxy Clients▪Authentication


running. In this approach the OWSM agent is embedded in webLogic 11g or J Developer 11g.

Authentication - Username token over SSL

• oracle/wss11_username_token_with_message_protection_client_policy

The username_token_message_protection policy requires that the public Orac lecertificate (Service Public key) is referenced by the client as rcpt-key alias.

• rcpt-key-alias : Service Public keyEncrypting symmetric key which is used for SAML+Body signature/ encryption

One approach is to leverage the OWSM agent. In such an approach, a keystore needs

to be generated by the c lient and stored on the client machine. A keystore holds theuser alias, the appropriate keys and its corresponding values which are required in orderto authenticate to the Fusion environment.

The public Orac le certificate file can be obtained from the Fusion WSDL and can beimported to the keystore under the rcpt-key-alias. The Oracle certificate file can beimported to the keystore using the keytool commands listed below.

• Import Oracle certificate to a keystore file

• keytool -importcert -alias nameoforaclekey -file oraclecertificatefile.cer -keystoreoracle-keystore.jks -storepass keystorepassword

• List the contents of a keystore

•

keytool -list -keystore ".oracle-keystore.jks" The client should store the keystore file to their local machine and reference the keystorefile in their client application in order to authenticate to the Fusion environment.

The following is an example of an authentication mechanism to Sales Cloud. This is acode snippet written in the J ava programming language, demonstrating theauthentication code to login to a Fusion environment using the username token withmessage protection policy. In order for this code snippet to run, the OWSM agent should



Contents


be present and running. In this approach the OWSM agent is embedded in webLogic11g or J Developer 11g.

Authentication -- Username token and message protection

Note: The above examples represent a single approach to authenticate to Sales Cloud web servicesusing Java as the programming language and J Developer 11g as the IDE. Any development platformwhich c omplies with WS Security policies 1.1 can be used to authenticate to Sales Cloud web services.

For further information regarding extracting Oracle public certificate from a FusionWSDL, please refer to Appendix C: Extracting Oracle Public Certificate from Fusion WSDL



Orac le Sales Cloud Using Simplified SOAP Web Services for Acc ount, Household, and C ontact 6

Call the Sales Cloud Account service to create, update, find, and delete organizationaccounts. Organization accounts contain the following information: organizationprofile, sales profile, contact information (primary address, phone, fax, email and URL),industry classification and account hierarchy. This service manages “simple”organization accounts, and does not support organization accounts with additionalnames and identifiers, multiple sets of addresses, contacts, industry classificationinformation, email and phone and resources associated with the sales profile.

Related Services:

• Sales Cloud Address: This service can be used to add additional address to theorganization account, once it is created using the Sales Cloud Account service.

• Sales Cloud Relationship: This service can be used, in combination with the Contactservice, to define additional contacts on the organization account, once it iscreated using the Sales Cloud Account service.

• Sales Cloud Household: If you have requirements to create a household accountrather than an organization account, use this service instead.

• Sales Cloud Contac t: If you have requirements to create a contac t account ratherthan an organization account, use this service instead.

• Sales Party: This service is similar to the Sales Cloud Account service in that it createsorganization accounts. However, it is used for more complex organization accounts,has prerequisite invocation steps, and has a more complex hierarchical serviceinterface rather than flattened structure. If organization account requirements aremet by the Sales Cloud Account service, then use the Sales Cloud Account servicebecause it is easier to use.

• Sales Account Service: This service is used to add sales accounts to existing accountsin a multiple sales account scenarios. Although this service name is similar, thisservice is used for a different use case scenario.

Life Cycle

Active

QName

{http:// xmlns.oracle.com/apps/crmCommon/salesParties/accountService/}AccountService

Relationships

Type Relationship To

4 Sales Cloud Account SimplifiedWeb Services Interface



Sales Cloud Account Simplified Web Services Interface ▪



Handles Sales Cloud Account SDO

HandlesSales Cloud Primary AddressSDO

Body Text Body Text

Operations

Available Operations:

• createAccount

• deleteAccount

• findAccount

• getAccount

• mergeAccount

• processAccount

• processCSAccount

• updateAccount

createAccount

Creates an organization account and its primary address.

Life Cycle

Active

Request Payload

Element

Name

Type Description

account SalesCloudAccountSDO

The account to create.



Sales Cloud Account Simplified Web Services Interface ▪Operations


Response Payload

Name Type Description

result SalesCloudAccountSDO

The account which is created.

deleteAccount

Deletes an account and the relationship between the account and address objectsindicating the address is a primary address. The address object cannot be deletedusing this operation. To delete the address, use the Sales Cloud Address service.

Life Cycle

Active

Request Payload

Element

Name

Type Description

account SalesCloudAccount

SDO

The account to delete.

Response Payload


result MethodResult

Not applicable.

findAccount

Finds a list of accounts based matching the supplied criteria pertaining to the object.

Life Cycle

Active



Sales Cloud Account Simplified Web Services Interface ▪ Operations


Request Payload

Element

Name

Type Description

findC riteria FindC riteria The criteria used to find the account, such asthe filter,

the fetch size, and so on.

findC ontrol FindControl

Response Payload



The list of accounts that match the filter criteria.

getAccount

Retrieves the account based on the primary key identifier.

Life CycleActive

Request Payload

Element

Name

Type Description

PartyId Long The identifier of the account you want to retrieve.

Response Payload



The account matching the party Id specified.





mergeAccount

Merges an account with another account. The service updates the object if it exists, elseinserts the object.

Life Cycle

Active

Request Payload

Element

Name

Type Description

account Sales

CloudAccountSDO

The account to merge.

Response Payload


result AccountResult

Not applicable.

processAccount

Creates, updates, deletes, or merges a list of account rows. It performs the specifiedoperation on the accounts.

Life Cycle

Active

Request Payload

Element

Name

Type Description

changeOperation

string The action to perform on the account such asCreate, Update, Merge, or Delete.

account SalesCloud

A list of accounts to be processed.



Sales Cloud Account Simplified Web Services Interface ▪ Operations


AccountSDO

processControl

ProcessControl

Attribute to manage the account processing suchas whether the valid data will be committed ifthere are other invalid data in the same batch, orwhether the outbound will contain the keyattributes only or the full object.

Response Payload



A list of Accounts that are successfully processed.

processCSAccount

Creates, updates, or deletes a list of accounts. The operation and objects depend onthe C hangeSummary object specified.

Life Cycle

Active

Request Payload

Element

Name

Type Description

processData ProcessData

The object that is used to represent the changesthat have been made.

processControl

ProcessControl

Attribute to manage the account processing suchas whether the valid data will be committed ifthere are other invalid data in the same batch, orwhether the outbound will contain the keyattributes only or the full object.





Response Payload


result Proc essData

Result of the operation including the list of objec tscreated or updated. This also lists all warning andinformational messages.

updateAccount

An operation to update an account and primary address. When updating the primaryaddress information it is not necessary to include the primary or alternate keys for theprimary address. There is a one-to-one correspondence between the ac count andprimary address. If the alternate keys SourceSystem and SourceSystemReferenceValuein the primary address are spec ified and they do not match the values in the existingprimary address, then a new source system reference is created with the existing primaryaddress values and values specified in the request payload, and the primary address isupdated to point to the newly created address object.

Life Cycle

Active

Request Payload

Element

Name

Type Description

account SalesCloudAccountSDO

The account to update.

Response Payload


result AccountResult

The account which is updated.



Sales Cloud Account Simplified Web Services Interface ▪ Sales Cloud Account SDO


Sales Cloud Account SDO

An account for a c ustomer or prospect. This objec t is an aggregation of primaryaccount profile, and contac t information, and references a single primary address.

QName

{http://xmlns.oracle.com/apps/crmCommon/salesParties/accountService/}Account

Relationships


Contains Sales Cloud Primary Address SDO

Handled by Sales Cloud Account

Attributes (Alternate 1 – Keys/Label/Properties sec tions with description)


AnalysisFiscalYear

Properties

Creatable, Updateable

The fiscal year used as the source for financial

information.

BusinessReport Properties


The Dun & Bradstreet business information report.

BusinessScope string Properties


The class of business to which the accountbelongs, such as local, national, or international.

CEOName string Properties




Sales Cloud Account Simplified Web Services Interface ▪Sales Cloud Account SDO


The name of the organization’s chief executiveofficer.

CEOTitle string Properties


The formal title of the chief executive officer.

CertificationLevel

string Properties


The certification level the organization. A list ofvalid certification level codes is defined using thelookup HZ_PARTY_C ERT_LEVEL. Review the Reviewand update the codes using the Setup andMaintenance work area, Manage TradingCommunity Common Lookups task.

CertificationReasonCode

string Properties


The reason for the contac t's current certificationlevel assignment. A list of valid certification reason

codes are defined using the lookupHZ_PARTY_CERT_REASON. Review and update thecodes using the Setup and Maintenance workarea, Manage Trading Community CommonLookups task.

Comments string Properties


The corporate charter of the organization.

CongressionalDistrictCode

String PropertiesCreatable, Updateable

The U.S. Congressional district code for theaccount.

ControlYear Number Properties






The year when current ownership gained controlof the organization.

CorpCurrencyCode

String The corporate currency code used by the CRMExtensibility framework. It is defaulted to the valueset in the profile optionZCA_COMMON_CORPORATE_CURRENCY.

CorporationClass

string Properties


The taxation classification for corporation entitiessuch as Chapter S in the US.

CreatedBy String The user who created the account record.

CreatedByModule

String Properties

Creatable

The module that created the account record.

CreationDate Date The date when the record was created.

CurcyConvRateType

String The currency conversion rate type. This attribute isused by CRM Extensibility framework. A list of validvalues is defined in the lookupZCA_C OMMON_RATE_TYPE. Review and updatethe profile option using the Setup andMaintenance work area, Manage Currency ProfileOptions task.

CurrencyCode

String The currency code. This attribute is used by CRMExtensibility framework. A list of valid values isdefined in the lookupZCA_COMMON_CORPORATE_CURRENCY. Reviewand update the profile option using the Setup andMaintenance work area, Manage Currency ProfileOptions task.

CurrentFiscalYearPotentialRevenueAmou

Number Properties






nt

The estimated revenues that can be earned bythe organization during its current fiscal year.

DataCloudStatus

String Properties


The enrichment status of the contac t record fromData-as-a-Service. A list of valid values are definedin the lookup DATA_CLOUD_STATUS. Review andupdate the codes using the Setup andMaintenance work area, Manage StandardLookups task.

DisadvantageIndicator

boolean Properties


Indicates whether the organization is considereddisadvantaged by the US government under Title8A. If the value is Yes, the organization isconsidered disadvantaged under Title 8A. Thedefault value is No.

DomesticUltim

ateDUNSNumber

number Properties


The DUNS Number for the Domestic Ultimate. ADomestic Ultimate is the highest member of thesame country in the organization's hierarchy. Anorganization can be its own Domestic Ultimate.

DoNotConfuseWith

string Properties


Indicates that there is an organization that issimilarly named.

DUNSCreditRating

string Properties






The Dun & Bradstreet credit rating.

DUNSNumber number Properties


The DUNS Number in freeform text format. Thevalue not restricted to nine digit number.

EmailAddress string Properties


The e-mail address of the contact point for theorganization.

EmailFormat string Properties


The preferred format for e-mail addressed to thisorganization, such as HTML or ASCII.

EmployeesAtPrimaryAddress

Number Properties


The qualifier to calculate the estimated number ofemployees at the primary address. A list of validqualifier codes are defined using the lookupEMP_AT_PRIMARY_ADR_EST_IND. Review andupdate the codes using the Setup andMaintenance work area, Manage TradingCommunity Common Lookups task.

EmployeesAtPrimaryAddressEstimation

String Properties


The estimated minimum number of employees atthe primary address. A list of accepted values aredefined in the lookup typeEMP_AT_PRIMARY_ADR_MIN_IND. Review andupdate the values using the Setup andMaintenance work area, Manage Trading





Community Common Lookups task.

EmployeesAtPrimaryAddressMinimum

Number Properties


The qualifier to qualify calculation of employees atthe primary address as minimum.

EmployeesAtPrimaryAddress

Text

String Properties


The number of employees at the referencedaddress in text format.

EmployeesTotal

Number Properties


The total number of employees in the organization.

ExportIndicator

Boolean Properties


Indicates whether the organization is an exporter.If the value is Y, then the organization is anexporter. The default value is N.

FaxAreaC ode Number Properties


The area code for the fax number.

FaxCountryCo

de

Number Properties


The international country code for a fax number,such as 33 for France.

FaxExtension Number Properties






The extension to the fax number of theorganization.

FaxNumber Number Properties


The fax number of the organization in the localformat. The number should not include area code,country code, or extension.

FiscalYearend

Month

String Properties


The last month of a fiscal year for the organization. The list of accepted values is defined in the lookuptype MONTH.

FormattedFaxNumber

Number The formatted fax number of the organization.

FormattedPhoneNumber

Number The formatted phone number of the organization.

GeneralServicesAdministrationFlag

Boolean Properties


Indicates whether organization is a US federalagency supported by the General ServicesAdministration (GSA). If the value is Y, then theorganization is supported by GSA. The defaultvalue is N.

GlobalUltimateDUNSNumber

Number Properties


The DUNS Number for the Global Ultimate. AGlobal Ultimate is the highest member in theorganization's hierarchy. An organization can be itsown Global Ultimate.





GrowthStrategyDescription

String Properties


The user-defined description of growth strategy.

HomeCountry String Properties


The home country of the organization.

HQBranchIndicator

String Properties


The status of this site, such as HQ, a branch, or asingle location. A list of ac cepted values aredefined in the lookup type HQ_BRANCH_IND.

ImportIndicator

Boolean Properties


Indicates whether the organization is an importer.

If the value is Y, then the organization is animporter. The default value is N.

IndustryCode String Properties


The Industry classification code. The classificationcodes are defined for every classificationcategory as specified in IndustryCodeTypeattribute. Review and update the codes using theSetup and Maintenance work area, Manage

Classification Categories task.

IndustryCodeType

String The industry classification category code type. It isdefaulted to the value of profile optionMOT_INDUSTRY_CLASS_CATEGORY. Review andupdate the codes using the Setup andMaintenance work area, Manage ClassificationCategories task.





LaborSurplusIndicator

Boolean Properties


Indicates whether the organization operates in anarea with a labor surplus. If the value is Y, then theorganization operates in an area with a laborsurplus. The default value is N.

LastEnrichmentDate

Date Properties


The date when the record was last enriched.

LastUpdateDate

Date The date when the record was last updated.

LastUpdatedBy

String The user who last updated the record.

LastUpdateLogin

String The login of the user who last updated the record.

LegalStatus String Properties


The legal structure of the organization such aspartnership, corporation, and so on.

LineOfBusiness String Properties


The type of business ac tivities performed at thissite.

LocalActivityCode

String Properties


The local ac tivity classification code.

LocalActivityC String Properties





odeType Creatable, Updateable

The local ac tivity classification code type identifier.

LocalBusinessIdentifier

String Properties


The primary identifier assigned to a businesses by agovernment agency such as Chamber ofCommerce, or other authority. It is often used bycountries other than USA.

LocalBusinessI

dentifierType

String Properties


The lookup that represents most common businessidentifier in a country such as Chamber ofCommerce Number in Italy, GovernmentRegistration Number in Taiwan. A list of acceptedvalues is defined in the lookup typeLOCAL_BUS_IDEN_TYPE.

MinorityOwnedIndicator

Boolean Properties


Indicates whether the organization is primarilyowned by ethnic or racial minorities. If the value is

Y, then the organization is owned by ethnic orracial minorities. The default value is N.

MinorityOwnedType

String Properties


The type of minority-owned firm.

MissionStatement

String Properties


The corporate charter of organization in user-





defined text format.

NamedFlag Boolean Properties


Indicates if the sales account is a named salesaccount. If the value is True, then the account is anamed account. The default value is False.

NextFiscalYearPotentialRevenueAmount

Number Properties


The estimated revenue of the organization to beearned during its next fiscal year.

OrganizationName

String Properties

Creatable, Required, Updateable

The name of the account.

OrganizationSize

String Properties


The size of an organization based on revenue,number of employees, and so on. The acceptedvalues are defined in the lookup typeHZ_ORGANIZATION_SIZE.

OrganizationType

String Properties


The organization type value such as region,

division, and department.

OutOfBusinessIndicator

Boolean Properties


Indicates whether the organization is out ofbusiness. If the value is Y, then the organization is





out of business. The default value is N.

OwnerEmailAddress

String Properties


The e-mail address of the employee resource thatowns and manages the sales account. The owneris a valid employee resource defined within SalesCloud.

To assign an owner to the sales account, user canprovide one of the following attributes of theresource: PartyID, PartyNumber or Email Address.

This is provided if user wants to change the ownerof the account or create account with a differentowner than the login user. If provided thenOwnerPartyID, OwnerPartyNumber, andOwnerEmailAddress are used in this order todetermine the owner of the account.

OwnerPartyId String Properties


The unique identifier of a valid employee resourcewho owns and manages the sales account.

To assign an owner to the sales account, user canprovide one of the following attributes of theresource: PartyID, PartyNumber or Email Address.

This is provided if user wants to change the ownerof the account or create account with a differentowner than the login user. The OwnerPartyID,OwnerPartyNumber, and OwnerEmailAddress areused in this order to determine the owner for theaccount.

During create, if OwnerPartyID,OwnerPartyNumber or OwnerEmailAddress are notprovided, then the account is assigned by defaultto the login user's partyID.

OwnerPartyNumber

Number Properties






The party number of a valid employee resourcewho owns and manages the sales account. To

assign an owner to the sales account, user canprovide one of the following attributes of theresource: PartyID, PartyNumber or Email Address.

This is provided if user wants to change the ownerof the account or create account with a differentowner than the login user. The OwnerPartyID,OwnerPartyNumber, and OwnerEmailAddress areused in this order to determine the owner for theaccount.

ParentAccountPartyId

String Properties


The party Id of the parent ac count within thehierarchy. To assign a parent account to a salesaccount, you must provide the parent ac count'sparty ID, party number, or source systemreference.

ParentAccountPartyNumber

Number Properties


The party number of the parent ac count within thehierarchy.

To assign a parent account to the given account,provide parent account's Party Id, PartyNumber, orSource System Reference and SourceSystem. Theaccount hierarchy is updated based on theidentified parent account.

ParentAccountSourceSystem

String Properties


The source system of the parent account withinthe hierarchy.





To assign a parent account to the given account,provide Party ID, PartyNumber, or Source System

Reference and SourceSystem. The accounthierarchy is updated based on the identifiedparent account. Review and update the value forthis attribute using the Setup and Maintenancework area, Manage Trading Community CommonLookups task and editing the lookup typeHZ_ORIG_SYSTEMS_VL.

ParentAccountSourceSystemReferenceValue

String Properties


The source system reference of the parentaccount within the hierarchy.

To assign a parent account to an account,provide the parent account's Party ID,PartyNumber, or Source System Reference andSourceSystem.

The account hierarchy is updated based on theidentified parent account.

ParentDUNSNumber

Number PropertiesCreatable, Updateable

The DUNS Number of the organization or theparent entity that owns a majority stake of theorganization's capital stock. The parent entity canbe a subsidiary of another corporation. If theparent also has branches, then it is regarded asheadquarters as well as a parent company.

A headquarters is a business establishment that

has branches or divisions reporting to it, and isfinancially responsible for those branches ordivisions. If the headquarters has more than 50% ofcapital stock owned by another corporation, italso will be a subsidiary. If it owns more than 50% ofcapital stock of another corporation, then it is alsoa parent.





ParentOrSubsidiaryIndicator

String Properties


Indicates whether the organization is a parent orsubsidiary.

PartyId String The unique identifier of the account.

PartyNumber String Properties


The unique alternate identifier for the account

party. You can update the value if the profileoption HZ_GENERATE_PARTY_NUMBER is set to True.

The default value is a concatenation of the valuespecified in the profile option ZCA_PUID_PREFIXand a unique system generated sequencenumber.

PartyStatus String Indicates the status of the account. This is aninternally-used column and the values are definedin the lookup HZ_STATUS. Review and update thecodes using the Setup and Maintenance workarea, Manage Trading Community Common

Lookups task.

PartyUniqueName

String The unique account name displayed on accountrelated screens. The default value is theconcatenation of attributes AccountName andUniqueNameSuffix. If the attributeUniqueNameSuffix is nil, then the AccountName isconcatenated with a system generated number.

PhoneAreaCode

Number Properties


The area code for the telephone number.

PhoneCountryCode

Number Properties


The international country code for a telephone





number, such as 33 for France.

PhoneExtension

Number Properties


The extension to the phone number of theorganization.

PhoneNumber Number Properties


The phone number of the organization in the localformat. The number should not include area code,country code, or extension.

PreferredContactMethod

String Properties


The preferred contact method of the organization. The accepted values are defined in the lookuptype HZ_PREFERRED_CONTAC T_METHOD. Reviewand update the codes using the Setup andMaintenance work area, Manage Trading

Community Common Lookups task.

PreferredFunctionalCurrency

String Properties


The organization's default currency code. A list ofvalid currency codes are defined during theapplication setup.

PrimaryAddress

String Properties


The primary address of the account.

PrincipalName

String Properties






The name of the highest ranking person in theorganization.

PrincipalTitle String Properties


The title of the highest ranking person in theorganization.

PublicPrivateOwnershipFlag

Boolean Properties


Indicates whether the organization is publically orprivately owned. If the value is Y, then theorganization is a privately owned organization. Thedefault value is N.

RegistrationType

String Properties


Indicates the type of registration, such asnonprofit. The accepted values are defined in the

lookup type REGISTRATION_TYPE.

RentOrOwnIndicator

String Properties


Indicates if this contact owns or rents his or herresidence. A list of valid values for rent, own, andlease are defined in the lookup OWN_RENT_IND.Review and update the codes using the Setupand Maintenance work area, Manage StandardLookups task.

SiebelLocation

String Properties


The location of account. This is an optional part ofUser Primary Key.





SmallBusinessIndicator

Boolean Properties


Indicates whether the organization is consideredas a small business. If the value is Y, then theorganization is considered as a small business. Thedefault value is N.

SourceSystem String Properties

Creatable

The name of external source system where the

account party is imported from. The valuesconfigured in setup task Trading CommunitySource System.

SourceSystemReferenceValue

String Properties

Creatable

The unique identifier for the account party fromthe external source system spec ified in theattribute SourceSystem.

StockSymbol String Properties


The corporate stock symbol of the organization aslisted in stock exchanges.

TaxpayerIdentificationNumber

String Properties


The taxpayer identification number that is often aunique identifier of the organization, such asincome taxpayer Id in USA and fiscal code or NIFin Europe.

TotalEmployeesEstimatedIndicator

String Properties






Indicates if the employee total is estimated. Theaccepted values are defined in the lookup type

TOTAL_EMP_EST_IND.

TotalEmployeesIndicator

String Properties


Indicates if subsidiaries are included in thecalculation of total employees. The acceptedvalues are defined in the lookup type

TOTAL_EMPLOYEES_INDICATOR.

TotalEmployeesMinimumIndicator

String Properties


Indicates if the number is a minimum, maximum, oraverage number of total employees. Theaccepted values are defined in the lookup type

TOTAL_EMP_MIN_IND.

TotalEmployeesText

String Properties


The total number of employees in text format.

TotalPaymentAmount

Number Properties


The total amount of payment collected from theorganization.

Type String Properties


The account type that defines if the account is asales account or a prospect or any other partytype. The accepted values are defined in thelookup type ZCA_AC COUNT_TYPE. It is defaulted toZCA_CUSTOMER if no value is provided.





UniqueNameSuffix

String Properties


The suffix used to generate the attributePartyUniqueName. The suffix is concatenated tothe OrganizationName attribute to generate thePartyUniqueName. The primary address isdefaulted as the suffix.

URL String Properties


The uniform resource locator or a websitecontaining information about the organization.

WomanOwnedIndicator

String Properties


Indicates whether the organization is primarilyowned by women. If the value is Y, then theorganization is primarily owned by women. Thedefault value is N.

YearEstablished

Number Properties


The year that the organization started it businessoperations.

YearIncorporated

String Properties


The year that the business was formallyincorporated.






Call the Sales Cloud Contac t service (ContactService) to c reate, update, retrieve, anddelete contacts. The service includes attributes related to contact profile, sales profile,contact information, such as primary address, phone, fax, e-mail and URL, andclassifica tion. This service covers all frequently used operations for contact. However, thisservice does not support relationships, additional address, contact preferences, andmultiple instances of other child objec ts such as additional names, identifiers,classification, phone, fax, e-mail, etc.

Related Services:

• Sales Cloud Address: Service to add additional address to an existing contac t.

•

Sales Cloud Relationship: Service to define additional account relationships foran existing contac t that can be used in combination with the Account andHousehold service. Similarly, it can be used in combination with the Householdservice to create members or contact relationships for a given household.

• Sales Location and Person Service: Service to manage contac ts and theiraddresses.

• Sales Party: Service similar to the Sales Cloud Account service that createsorganization accounts. However, it is used for more complex organizationaccounts, has prerequisite invocation steps, and has a more complexhierarchical service interface rather than flattened structure. If organizationaccount requirements are met by the Sales Cloud Account service, then use the

Sales Cloud Account service because it is easier to use.• Sales Account Service: Service to add sales accounts to existing accounts in a

multiple sales account scenarios. Although this service name is similar, this serviceis used for a different use case scenario.

Life Cycle

Active

QName

{http:// xmlns.oracle.com/apps/crmCommon/salesParties/contac tService/}Contac tService

Relationships


Handles Sales Cloud Contact SDO

Handles Sales Cloud Primary Address SDO

5 Sales Cloud Contact SimplifiedWeb Services Interface



Sales Cloud Contact Simplified Web Services Interfac e ▪ Operations


Operations


• getContact

• createContact

• updateContact

• deleteContact

• mergeContact

• findContact

• processContact

• processCSContact

getContact

Retrieves the contact based on the primary key identifier.

Life Cycle

Active

Request Payload

Element

Name

Type Description

PartyId long The party identifier used to retrieve the contact.

Response Payload


result SalesCloudContactSDO

Contac t that matches the inbound key attributes.



Sales Cloud Contact Simplified Web Services Interface ▪Operations


createContact

Creates a contac t and its primary address.

Life CycleActive

Request Payload

Element

Name

Type Description

contact Sales CloudContact SDO

The contac t to be created along with its primaryaddress.

Response Payload


result {http://xmlns.oracle.com/apps/crmC

ommon/salesParties/contactService/

}ContactResult

The created contact.

updateContact

Updates a contact and its primary address. When updating the primary addressinformation it is not necessary to include the primary or alternate keys for the primaryaddress. There is a one-to-one correspondence between the contact and primaryaddress. If the alternate keys SourceSystem and SourceSystemReferenceValue in theprimary address are specified and they do not match the values in the existing primaryaddress, then no new address object is created. However, new SourceSystem or

SourceSystemReferenceValue are created for the existing primary address.Life Cycle

Active

Request Payload

Element Type Description



Sales Cloud Contact Simplified Web Services Interfac e ▪ Operations


Name

contact SalesCloudContactSDO

The contact to be updated along with its primaryaddress.

Response Payload


result {http://xmlns.oracle.

com/apps/crmC


}Contac tResult

The updated contact.

deleteContactDeletes a contac t and the relationship between the contac t and address objec tsindicating the address is a primary address. The address objec t cannot be deletedusing this operation. To delete the address, use the Sales Cloud Address service.

Life Cycle

Active

Request Payload

Element

Name

Type Description


The contact to be deleted along with itsrelationship with address objec ts.





Response Payload


result {http://xmlns.oracle.com/adf/svc/type

s/}MethodResult

mergeContact

Performs a merge on the contact. It will perform an update if the object exists or aninsert if the object doesn't exist.

Life Cycle

Active

Request Payload

Element

Name

Type Description


The contac t to be merged.

Response Payload


result {http://xmlns.oracle.

com/apps/crmC


}Contac t

The merged contact.



Sales Cloud Contact Simplified Web Services Interface ▪ Operations


Result

findContact

Finds a list of contacts based on matching the supplied criteria pertaining to the object.

Life Cycle

Active

Request Payload

Element

Name

Type Description

findCriteria {http:/ /xmlns.oracle.com/adf/svc/type

s/}FindCriteria

The criteria used to limit your query

result, such as the filter (where

clause), the fetch size, and so on.

findC ontrol {http://xmlns.oracle.com/adf/svc/type

s/}FindControl

The find control. Not currently used.

Response Payload


result SalesCloudContact

SDO

A list of contact that satisfy the inbound c riteria.

processContact

Performs a create, update, delete, or merge operation on a list of contac t rows. Itperforms the specified operation on the contac ts.





Life Cycle

Active

Request Payload

Element

Name

Type Description

changeOperation

string Indicates the action to be performed, such asCreate, Update, Merge, or Delete.


Properties

Unbounded

A list of contac t to be processed.

processControl

{http://xmlns.oracle.com/adf/svc/type

s/}Proc essControl

Control your bulk upload behavior, such aswhether the valid data will be committed if thereare other invalid data in the same batch, andwhether the outbound will contain the keyattributes only or the full object.

Response Payload


result SalesCloudContactSDO

A list of contact that are successfully processed.

processCSContact

Performs a create, update, or delete operation on a list of contac t rows. The operationand objects depend on the ChangeSummary object specified.

Life Cycle

Active



Sales Cloud Contact Simplified Web Services Interface ▪ Sales Cloud Contact SDO


Request Payload

Element

Name

Type Description

processData {http://xmlns.oracle.com/adf/svc/type

s/}Proc essData


processControl

{http:/ /xmlns.oracle.com/adf/

svc/types/}Proc essControl

Control your bulk upload behavior, such aswhether the valid data will be committed if thereare other invalid data in the same batch, and

whether the outbound will contain the keyattributes only or the full object.

Response Payload



s/}Proc essData

Result of the operation including a list ofcreated/updated data objects, and all warningand informational messages.

Sales Cloud Contact SDO

A contac t is a person who either has a relationship to other objects like account andhousehold or is a customer or prospect you direc tly sell to. A contac t could be either a

buying customer in a B2C scenario or contact of an account in a B2B scenario. Thisobjec t is an aggregation of person profile, and contac t information, and references asingle primary address.

QName

{http://xmlns.oracle.com/apps/crmCommon/salesParties/contac tService/}Contac t



Sales Cloud Contact Simplified Web Services Interface ▪Sales Cloud Contact SDO


Relationships


Contains Sales Cloud Primary Contact SDO

Handled by Sales Cloud Contact



AcademicTitle string Properties


The part of the person’s title that denotes theacademic qualification, such as Dr. J ane Smith.

AccountName string The name of the sales ac count that this contac tbelongs to.

AccountPartyId long Properties


The unique identifier of sales account that thiscontac t belongs to. To specify the account for acontact, you can provide an Account's party ID,PartyNumber, SourceSystem, orSourceSystemReference.

AccountPartyNumber

string Properties


The party number of the sales account that thiscontac t belongs to. To specify the account for acontact, you can provide an Account's party ID,PartyNumber, SourceSystem, orSourceSystemReference.

AccountSourceSystem

string Properties




Sales Cloud Contact Simplified Web Services Interface ▪ Sales Cloud Contact SDO


The source system code of the sales ac count thatthis contac t belongs to. To specify the account for

a contact, you can provide an Account's party ID,PartyNumber, SourceSystem, orSourceSystemReference.

AccountSourceSystemReferenceValue

string Properties


The source system reference value of the salesaccount that this contac t belongs to. To specifythe account for a contact, you can provide anAccount's party ID, PartyNumber, SourceSystem, orSourceSystemReference.

AssignmentExceptionFlag

boolean Properties


Indicates whether the sales account has therequired dimensions to allow assignment managerto assign territories to the sales account. If thevalue is True, then the sales account has therequired dimensions. The default is false.

CertificationLevel string Properties


The certification level of a contact. A list ofac cepted values are defined in the lookupHZ_PARTY_CERT_LEVEL. Review and update thevalue for this attribute using the Setup andMaintenance work area, Manage TradingCommunity Common Lookups task.


string Properties


The reason for the contact's current certificationlevel assignment. A list of accepted values aredefined using the lookup HZ_PARTY_C ERT_REASON.Review and update the value for this attribute





using the Setup and Maintenance work area,Manage Trading Community Common Lookupstask.

ClassificationCategory

string Properties


A valid c lassification category code for thecontact. This is defined by an admin and is markedas primary.

ClassificationCode

string Properties


A valid classification code corresponding to theclassification category, which is marked asprimary.



The textual comments about a contact.

ContactIsPrimaryForAccount

string PropertiesCreatable, Updateable

The preferred contact for the account.

ContactName string Properties


The derived name of the contac t.

ContactUniqueName

string The unique contac t name displayed on contac trelated screens. The default value forContactUniqueName is the concatenation ofattributes ContactName and UniqueNameSuffix. Ifthe attribute UniqueNameSuffix is nil, then theContactName is concatenated with a systemgenerated number.



Sales Cloud Contact Simplified Web Services Interfac e ▪ Sales Cloud Contact SDO


CorpCurrencyCode

string The corporate currency code assoc iated with thecontact. This attribute is used by CRM Extensibilityframework. A list of accepted values is defined in

the lookupZCA_COMMON_CORPORATE_CURRENCY. Reviewand update the profile option using the Setup andMaintenance work area, Manage TradingCommunity Common Lookups task.

CreatedBy string The user who created the contac t record.

CreatedByModule

string Properties

Creatable

The application module that created this contactrecord. The default value for CreatedByModule isHZ_WS for all Web service based creation.

A list of accepted values is defined in the lookuptype HZ_CREATED_BY_MODULES. Review andupdate the value for this attribute using the Setupand Maintenance task work area, Manage

Trading Community Common Lookups task.

CreationDate timestamp The date and time when the contac t record wascreated.

CurcyConvRateType

string The currency conversion rate type assoc iated withthe contact. This attribute is used by CRMExtensibility framework. A list of accepted values isdefined in the lookup ZCA_COMMON_RATE_TYPE.Review and update the value for this attributeusing the Setup and Maintenance work area,Manage Trading Community Common Lookupstask.

CurrencyCode string The currency code assoc iated with the contac t. This attribute is used by CRM Extensibility

framework. A list of accepted values is defined inthe lookupZCA_COMMON_CORPORATE_CURRENCY. Reviewand update the value for this attribute using theSetup and Maintenance work area, Manage

Trading Community Common Lookups task.

DataCloudStatus string Properties






The enrichment status of the contact record fromData c loud. A list of accepted values are definedin the lookup DATA_CLOUD_STATUS. Review andupdate the value for this attribute using the Setupand Maintenance work area, Manage StandardLookups task.

DateOfBirth date Properties


The date when the person was born.

DateOfDeath date Properties


The date when the person died.

DeceasedFlag boolean Properties


Indicates whether the person is deceased or not. Ifthe value is True, then the person is deceased. Thedefault is False.

DeclaredEthnicity string Properties


The declared ethnicity of the person.

Department string Properties


The free form text used to name the departmentfor the contact.

DepartmentCode string Properties






The department code for the contact. A list ofaccepted values is defined in the lookup

DEPARTMENT_TYPE. Review and update the valuefor this attribute using the Setup and Maintenancework area, Manage Contac t Lookups task.

DoNotCallFlag boolean Properties


Indicates if the user can call the person or not. Ifthe value is True, then the user must not call theperson. The default is False.

A list of accepted values is defined using thelookup YES_NO. Review and update the value forthis attribute using the Setup and Maintenancework area, Manage Common Lookups task.

DoNotContactFlag

boolean Properties


Indicates if the user can contac t the person or notby phone, e-mail, or mail. If the value is True, thenthe user must not contact the person. The defaultis False.


DoNotEmailFlag boolean Properties


Indicates if the user can e-mail the person or not. Ifthe value is True, then the user must not contactthe person by e-mail. The default is False.






DoNotMailFlag boolean Properties


Indicates if the user can send mail to the person ornot. If the value is True, then the user must notcontact the person by mail. The default is False.


EmailAddress string Properties


The e-mail address of the contac t point.

EmailFormat string Properties


The preferred format for e-mail addressed to thisaddress such as HTML or ASCII. A list of acceptedvalues is defined using the lookup EMAIL_FORMAT.

Review and update the value for this attributeusing the Setup and Maintenance work area,Manage Standard Lookups task.

ExistingC ustomerFlag

boolean Properties


Indicates whether there is an existing selling orbilling relationship with the sales account. If thevalue is true, then there is an existing relationshipwith the sales account. The default value is False.Such relationships are defined by the existence ofa Sell_To or Bill_To address.

ExistingC ustomerFlagLastUpdateDate

boolean Properties


The date when the ExistingCustomerFlag was last





modified. It is internally populated by theapplication.

FavoriteContactFlag

boolean Properties


Indicates whether the person is a key contact. Ifthe value is true, then person is a key contact. Thedefault value is False.

FaxAreaCode string Properties


The area code within a country code.

FaxCountryCode string Properties


The international country code for a telephonenumber, such as 33 for France.

FaxExtension string Properties


The additional number addressed after initialconnection to an internal telephone system.

FaxNumber string Properties


A telephone number formatted in the local formatwithout the area code, country code, or

extension.

FirstName string Properties


First name of the person.





FormattedFaxNumber

string The formatted fax number information.

FormattedMobileNumber

string The formatted mobile phone number information.

FormattedWorkPhoneNumber

string The formatted work phone number information.

Gender string Properties


The gender of the person, such as male, female,and unknown. A list of accepted values aredefined in the lookup HZ_GENDER. Review andupdate the value for this attribute using the Setupand Maintenance work area, Manage StandardLookups task.

HeadOfHouseholdFlag

boolean Properties


Indicates if the person is the head of thehousehold. If the value is True, then the person is

the head of the household. The default value isFalse.

HomePhoneAreaCode

string Properties



HomePhoneCountryCode

string Properties


The international country code for a telephonenumber, such as 33 for France.

HomePhoneNumber

string Properties






The home phone number formatted in the localformat without the area code, country code, or

extension.

HouseholdIncomeAmount

string Properties


The income of the household that this person is apart of.

HouseholdSize bigdec imal Properties


The size of the household this person is a part of.

Initials string Properties


The initials in the contac t’s name.

J obTitle string Properties


The free form text for job title.

J obTitleCode string Properties


The code given to the job title.

LastAssignmentD

ate

timestamp Properties


The date when the Sales Account TerritoryAssignment was last run by Assignment Manager.

LastAssignmentD timestamp The date and time when the Sales Account Territory Assignment was last run by Assignment





ateTime Manager.

LastContactDate timestamp Properties


The date when the contac t was last contacted.

LastEnrichmentDate

date Properties


The date when the contac t record was lastenriched with data from external sources by usingData-as-a-Service.

LastName string Properties


The last name of the person.

LastNamePrefix string Properties


The prefix for the last name of a person, such asfon, van. For example, if a person’s name is HansVan, the last name of the person is captured usingthis attribute.

LastUpdateDate timestamp The date and time when the contac t was lastupdated.

LastUpdatedBy string The user who last updated the contact record.

LastUpdateLogin string The session login associated to the user who lastupdated the contact record.

MaritalStatus string Properties


The marital status of the person. A list of acceptedvalues is defined in the lookup MARITAL_STATUS.Review and update the value for this attribute





using the Setup and Maintenance work area,Manage Standard Lookups task.

MaritalStatusEffectiveDate

date Properties


The date when the person's marital status waschanged.

MiddleName string Properties


The middle name of the person.

MobileAreaCode string Properties


The area code for the contac t's mobile phone.

MobileCountryCode

string Properties


The international country code for a contact’smobile phone number, such as 33 for France.

MobileExtension string Properties



MobileNumber string Properties


The mobile phone number formatted in the localformat. The number should not include area code,country code, or extension.

MyBusinessConta boolean Indicates if searching on business contact belongs





ct to login user. If the value is True, then the businesscontact belongs to login user. The default is false.

NamedFlag string Properties


Indicates whether a sales account is a namedsales account. If the value is true, then the salesaccount is a named sales account. The defaultvalue is False.

NameSuffix string Properties


The place in a family structure. For example, in"Tom J ones III", the "III".

Note string Properties


The note about the contac t.

OwnerEmailAddr

ess

string Properties


The e-mail address of a valid employee resourcewho owns and manages the sales account. Toassign an owner to the sales account, user canprovide one of the following attributes pertainingto the owner: PartyID, PartyNumber or E-mailAddress. This is provided if user wants to changethe owner of the contact or create contact with adifferent owner than the login user. If provided,then OwnerPartyID, OwnerPartyNumber, andOwnerEmailAddress are honored in this order todetermine the owner for the contac t.

OwnerName string The name of the sales account owner.

OwnerPartyId long Properties






The unique identifier of a valid employee resourcewho owns and manages the sales account. The

owner is a valid employee resource defined withinSales Cloud. To assign an owner to the salesaccount, user can provide one of the followingattributes pertaining to the owner: PartyID,PartyNumber, or E-mail Address. This is provided ifuser wants to change the owner of the contac t orcreate contac t with a different owner than thelogin user. If provided, then OwnerPartyID,OwnerPartyNumber, and OwnerEmailAddress arehonored in this order to determine the owner forthe contact. During c reate, if none of theOwnerPartyID, OwnerPartyNumber, or

OwnerEmailAddress is provided, then the contactis assigned by default to the login user. The loginuser's partyID is used to populate OwnerPartyID.

OwnerPartyNumber

string Properties


The party number of a valid employee resourcewho owns and manages the sales account. Toassign an owner to the sales account, user can

provide one of the following attributes pertainingto the owner: PartyID, PartyNumber, or E-mailAddress. This is provided if user wants to changethe owner of the contact or create contact with adifferent owner than the login user. If provided,then OwnerPartyID, OwnerPartyNumber, andOwnerEmailAddress are honored in this order todetermine the owner for the contac t.

PartyId long Keys

Primary Key

The unique internal identifier of a contac t party.One of PartyId, PartyNumber or PartySourceSystemand PartySourceSystemReferenceValue keys isrequired to uniquely identify the contact party.

PartyNumber string Keys





Alternate Key

Label

Registry ID (this would show when UI hint isspecified)

Properties

Updateable, Creatable

The unique alternate identifier for the contac tparty. The default value for PartyNumber is thevalue specified in the profile optionHZ_GENERATE_PARTY_NUMBER. You can updatethe PartyNumber depending on the profile optionHZ_GENERATE_PARTY_NUMBER. A list of acceptedvalues is defined in the profile optionHZ_GENERATE_PARTY_NUMBER. Review andupdate the value for this attribute using the Setupand Maintenance work area, Manage TradingCommunity Common Profile Options task.

PartyStatus string The status of the contact. A list of valid values aredefined in the lookup HZ_STATUS. Review andupdate the value for this attribute using the Setupand Maintenance work area, Manage StandardLookups task.

PersonalIncomeAmount

string Properties


The estimated gross annual income of the person.

PlaceOfBirth string Properties


The place where the person was born, such as cityor country.


string Properties






The preferred method to contac t the person. A listof accepted values is defined in the lookup

HZ_PREFERRED_CONTACT_METHOD. Review andupdate the value for this attribute using the Setupand Maintenance work area, Manage ContactPoint Lookups task.


string Properties


The default currency code for this contact. A list ofaccepted values is defined using the Setup andMaintenance work area, Manage Currencies task.

PreviousLastName

string Properties


The previous last name or surname of the person.

PrimaryAddress string Properties


The primary address of the contac t.

RecordSet string Properties


The search results displayed under the selectedrecord set.

RentOrOwnIndicator

string Properties


Indicates if this contact owns or rents his or herresidence. A list of valid values for rent, own, andlease is defined in the lookup OWN_RENT_IND.Review and update the value for this attributeusing the Setup and Maintenance work area,Manage Standard Lookups task.





SalesAffinityCode string Properties


The affinity of a contact to the deployingorganization. A list of accepted values are definedin the lookup HZ_SLS_CNTCT_AFFINITY_CODE.Review and update the value for this attributeusing the Setup and Maintenance work area,Manage Contact Lookups task.

SalesBuyingRoleCode

string Properties


The roles played by a contact in the buyingprocess, for example, dec ision maker or supportingrole. A list of accepted values is defined in thelookup HZ_SLS_CNTCT_BUY_ROLE_CODE. Reviewand update the values for this attribute using theSetup and Maintenance work area, ManageContact Lookups task.

SalesProfileStatus string Properties


A valid user defined status of the sales account.

SalesTeamMember

string Properties


The unique alternate identifier of the sales teammember.

Salutation string Properties


The size of the household this person is a part of.

SalutoryIntroduction

string Properties






The title or a salutary introduction for a contact,such as Mr., Herr, and so on. A list of accepted

values is defined in the lookup CONTACT_TITLE.Review and update the value for this attributeusing the Setup and Maintenance work area,Manage Standard Lookups task.

SecondLastName string Properties


The second last name for a person. A list ofaccepted values is defined in the lookupHZ_PERSON_PROFILES. Review and update thevalue for this attribute using the Setup andMaintenance work area, Manage StandardLookups task.

SourceSystem string Keys

Composite Alternate Key [SourceSystem andSourceSystemReference]

Properties

Creatable

The name of external source system where thecontact party is imported from. The values areconfigured in Setup and Maintenance work area,Manage Trading Community Source Systems task.

SourceSystemRef erenceValue

string Keys

Composite Alternate Key [SourceSystem,SourceSystemReference]

Properties

Creatable

The alternate unique identifier for the contac tparty from the external source system spec ified inthe attribute SourceSystem.





TaxpayerIdentificationNumber

string Properties


The taxpayer identification number, which is oftena unique identifier of the contact. The typicalvalues are taxpayer Id in USA or fiscal code or NIFin Europe.

Title string Properties


A professional or family title, such as Don or The

Right Honorable.

Type string Properties


The contac t party type that defines whether thecontact is a sales account, a prospect, a contactor any other user-defined party type. The defaultvalue is ZCA_CUSTOMER. A list of accepted valuesis defined in the lookup ZCA_CONTAC T_TYPE.Review and update the value for this attributeusing the Setup and Maintenance work area,Manage Standard Lookups task.

UniqueNameSuffix

string Properties


The system generated or manually overriddensuffix. The suffix is used to generate thePartyUniqueName attribute and is concatenatedto the ContactName attribute to generate the

PartyUniqueName. The primary address isdefaulted as the suffix.

WorkPhoneAreaCode

string Properties


The area code for the contact's work phone.





WorkPhoneCountryCode

string Properties


The international country code for a contact’swork phone number, such as 33 for France.

WorkPhoneExtension

string Properties



WorkPhoneNumber

string PropertiesCreatable, Updateable

The work phone number formatted in the localformat without the area code, country code, orextension.




Call the Sales Cloud Household service (HouseholdService) to create, update, find, anddelete the parties of type household. A household is a group that has accounts orcontacts as its members. This service covers attributes related to household profile, salesprofile, contact information (primary address, phone, and e-mail) and industryclassification. It does not support attributes for additional names and identifiers ormultiple sets of addresses, industry classifications, e-mail and phone numbers oradditional resources assoc iated with the sales profile.

Related Services:

• Sales Cloud Address: This service can be used to add additional address to an

existing household.• Sales Cloud Relationship: This service is used with the contact service to define

members or contacts for a household. It can be used with the account service todefine members for a household.

• Trading Community Location Service and Trading Community Group Service: Theseservices are used to manage households and their addresses.

Life Cycle

Active

QName

{http:/ /xmlns.orac le.com/apps/crmCommon/salesParties/householdService/}HouseholdService

Relationships


Handles Sales Cloud Household SDO

Handles Sales Cloud Primary Address SDO

Operations


• getHousehold

• createHousehold

• updateHousehold

6 Sales Cloud Household SimplifiedWeb Services Interface



Sales Cloud Household Simplified Web Services Interface ▪ Operations


• deleteHousehold

• mergeHousehold

• findHousehold

• processHousehold• processCSHousehold

getHousehold

Retrieves the household based on the primary key identifier.

Life Cycle

Active

Request Payload

Element

Name

Type Description

PartyId long The party identifier used to retrieve the household.

Response Payload


Return SalesCloudHousehold SDO

The household that matches the inbound keyattributes.

createHousehold

Creates a household and, optionally, its primary address.

Life Cycle

Active

Request Payload

Element

Name

Type Description

household Sales The household to be created.



Sales Cloud Household Simplified Web Services Interfac e ▪Operations


CloudHousehold SDO

Response Payload


result {http://xmlns.oracle.com/apps/crmCommon/salesParties/householdSe

rvice/ }HouseholdResult

The household that is created.

updateHousehold

Updates a household and its primary address. When updating the primary addressinformation it is not necessary to include the primary or alternate keys for the primaryaddress. There is a one-to-one correspondence between the account and primaryaddress. SourceSystem and SourceSystemReferenceValue are the alternate keys. If

SourceSystem and SourceSystemReferenceValue in the primary address are specifiedand they don’t match the values in the existing primary address, then a newSourceSystem/SourceSystemReferenceValue gets created for the existing primaryaddress.

Life Cycle

Active

Request Payload

Element

Name

Type Description

household SalesCloudHousehold SDO

The household to be updated.



Sales Cloud Household Simplified Web Services Interface ▪ Operations


Response Payload


Result {http://xmlns.oracle.com/apps/crmC

ommon/salesParties/householdServ

ice/ }HouseholdResult

The household that is updated.

deleteHousehold

Deletes a household and its relationship with the primary address. The address objectcan't be deleted using this operation. You can use the Sales Cloud Address service todelete an address.

Life Cycle

Active

Request Payload

Element

Name

Type Description

household SalesCloudHousehold SDO

The household to be deleted.

Response Payload


Result {http://xmlns.oracle.com/adf/svc/type

s/}MethodResult

Not applicable.





mergeHousehold

Merges the household and updates the record. If the household doesn’t exist, then theoperation inserts the household.

Life Cycle

Active

Request Payload

Element

Name

Type Description

household SalesCloudHousehol

d SDO

The household to be merged.

Response Payload


result {http://xmlns.oracle.com/apps/crmC

ommon/salesParties/householdServ

ice/}HouseholdResult

The household that is merged.

findHousehold

Finds a list of households matching the supplied criteria pertaining to the objec t.

Life Cycle

Active

Request Payload

Element

Name

Type Description







ype

s/}ProcessControl

attributes only or the full object.

Response Payload


Result SalesCloudHousehold SDO

A list of households that are successfullyprocessed.

processCSHousehold

Creates, updates, deletes, or merges a list of households. It performs the specifiedoperation on the households.

Life Cycle

Active

Request Payload

ElementName

Type Description

processData

{http://xmlns.oracle.com/adf/svc/type

s/}Proc essData


processControl

{http://xmlns.oracle.com

/adf/svc/type

s/}ProcessControl

Control your bulk upload behavior, such aswhether the valid data will be committed if there

are other invalid data in the same batch, andwhether the outbound will contain the keyattributes only or the full object.



Sales Cloud Household Simplified Web Services Interface ▪ Sales Cloud Household SDO


Response Payload



s/}Proc essData

Result of the operation including a list ofcreated/updated data objects, and all warningand informational messages.

Sales Cloud Household SDO

An object that includes attributes used to store values while creating or updating ahousehold. A household is a group that has a relationship with either an account or acontact.

QName

{http://xmlns.oracle.com/apps/cdm/foundation/parties/groupService/}Group

Relationships


Contains Sales Cloud Primary Address SDO

Handled By Sales Cloud Household



PartyId long Keys

Primary Key

The unique internal identifier of a household party. This attribute is generated internally by theapplication.

PartyNumber string

Keys

Alternate Key



Sales Cloud Household Simplified Web Services Interface ▪Sales Cloud Household SDO


Label

Registry ID (this would show when UI hint isspecified)

Properties

Updateable, Creatable

The unique alternate identifier for the householdparty. The default value is the value specified inthe profile option ZCA_PUID_PREFIX concatenatedwith a unique generated sequence number. The

value is updateable depending on the profileoption HZ_GENERATE_PARTY_NUMBER. A list of validvalues is defined in the profile optionHZ_GENERATE_PARTY_NUMBER. Review andupdate the codes using the Setup andMaintenance work area, Manage TradingCommunity Common Profile Options task.

AnnualIncome long

Properties


The annual income of the household. If notprovided, then the value is NULL.

AssignmentExceptionFlag

boolean

Properties

Read-only

Indicates whether the sales account had therequired dimensions to allow assignment managerto assign territories to the sales account. Possiblevalues are True or False.

AverageAge long Properties


The average age of the members of the





household.

CertificationLevel string

Properties


The certification level of a household. A list of validcertification level codes is defined in the lookupHZ_PARTY_C ERT_LEVEL. Review and update thecodes using the Setup and Maintenance task,Manage Trading Community Common Lookups.


string

Properties


The reason for the household current certificationlevel assignment. A list of valid certifica tion reasoncodes are defined using the lookupHZ_PARTY_CERT_REASON. Review and update thecodes using the Setup and Maintenance task,Manage Trading Community Common Lookups.

Child0to6Number long Properties


The number of children in the household less than6 years of age.



The number of children in the household between13 and 18 years of age.



The number of children in the household between7 and 12 year of age

ClassificationCateg strin Properties





ory g Creatable, Updateable

A valid c lassification category code for thehousehold which will be marked as primary and isdefined by an admin.

ClassificationCode String

Properties


A valid c lassification code corresponding to theclassification category and which will be markedas primary.

Comments String

PropertiesCreatable, Updateable

The textual comments about the household.

CorpCurrencyCode

string

The corporate currency code. A list of valid valuesis defined in the lookupZCA_COMMON_CORPORATE_CURRENCY. Reviewand update the profile option using the Setup andMaintenance work area, Manage Currency ProfileOptions task. This attribute is used by CRMExtensibility framework.

CreatedBy string

The user who created the record.

CreationDate string

Date and time when the record was created.

CurcyConvRateType

string

The currency conversion rate type assoc iated withthe household. This attribute is used by CRMExtensibility framework. A list of valid values isdefined in the lookup ZCA_COMMON_RATE_TYPE.Review and update the profile option using theSetup and Maintenance work area, ManageCurrency Profile Options task.

CurrencyCode string

The currency code attribute is used by CRMExtensibility framework. A list of valid values isdefined in the lookupZCA_COMMON_CORPORATE_CURRENCY. Review





and update the profile option using the Setup andMaintenance work area, Manage Currency ProfileOptions task.

DependentsNumber

long Properties


The number of dependents in the household.

EmailAddress String

Properties


The e-mail address of the contac t point.

EmailFormat String

Properties


Indicates the preferred format for e-mail, such asHTML or ASCII.

ExistingC ustomerFlag

Boolean

Properties

Read-only

Indicates whether there is an existing selling orbilling relationship with the sales account. If thevalue is true, then there is an existing relationshipwith the sales account. The default value is False.

ExistingC ustomerFlagLastUpdateDate

Date

Properties

Read-only

The date when the ExistingCustomerFlag was last

modified. It is internally populated by theapplication.

FormattedPhoneNumber

string

The formatted phone number information.





HouseholdName String

Properties


The unique identification number for this party.Data stored in this attribute comes fromPARTY_NUMBER in HZ_PARTIES.

HouseholdSize Long Properties


The size of the household or group.

LastAssignmentDate

Date

Properties

Read-only

The date when the Sales Account TerritoryAssignment was last run by Assignment Manager.

LastUpdateDate Timestamp

Properties

Required, Searchable

The date and time when the record was lastupdated.

LastUpdatedBy string

Properties


The user who last updated the record.

LastUpdateLogin string

Properties

Searchable


MedianAge Long Properties

Creatable, Searchable, Updateable

The median age of the members of the





household.

NamedFlag Boolean

Properties

Creatable, UpdateableIndicates whether a sales account is a namedsales account. Possible values are True or False. Ifthe value is True, then the sales account is anamed sales ac count.

OwnerEmailAddress string

Properties


The email address of valid employee resource that

owns and manages the sales account. To assignan owner to the sales account, you can eitherprovide owner's party ID, PartyNumber, or EmailAddress.

OwnerPartyId Long Properties


The unique identifier of a valid employee resourcewho owns and manages the sales account. Toassign an owner to the sales account, you mustprovide either owner's party identifier, partynumber, or email address.

OwnerPartyNumber String

Properties


Party Number of a valid employee resource whoowns and manages the sales account. To assignan owner to the sales account, you can eitherprovide owner's party ID, PartyNumber, or Email

Address.

PartyStatus String

The status of the household. This is an internalcolumn and you are not expected to pass in avalue. A list of valid statuses are defined in thelookup HZ_STATUS. Review and update the codesusing the Setup and Maintenance task, Manage

Trading Community Common Lookups.





PartyUniqueName string

The unique household name displayed onhousehold related screens. This is the derivedcolumn. For Organization, it is concatenation of

unique_name_alias and suffix. For Person, this isconcatenation of person_name and suffix.

PhoneAreaCode string

Properties



PhoneCountryCode

String

Properties


The International country code for a telephonenumber, such as 33 for France.

PhoneExtension String

Properties



PhoneNumber string

Properties


A telephone number formatted in the localformat. The number should not include area code,country code, or extension.


String

Properties


Indicates how a household prefers to becontacted. Validated against lookup typePREFERRED_CONTACT_METHOD. A list of validcodes is defined in the lookup HZ_PREFERENCE.Review and update the codes using the Setupand Maintenance task, Manage TradingCommunity Common Lookups.






String

Properties


The household’s default currency code. A list ofvalid currency codes are defined using the Setupand Maintenance work area, Manage CurrencyProfile Options task.

PrimaryAddress oracle.apps.crmCommon.salesParties.commonService.PrimaryAddres

s

Properties


The primary address of the household. Address

attributes of the household are grouped under aPrimaryAddress entity for clarity.

SourceSystem String

Properties

Creatable

The name of external source system, which isdefined by an admin as part of system setup. It ispart of Alternate Key (along withSourceSystemReference), and is mandatory ifPrimary Key or PartyNumberBusinessKey is notpassed in update.

SourceSystemReferenceValue

string

Properties

Creatable

The unique identifier for the household party fromthe external source system spec ified in theattribute SourceSystem. It is part of Alternate Key





(along with SourceSystemReference), and ismandatory if Primary Key orPartyNumberBusinessKey is not passed in update.

Type string

Properties


The household party type that defines whether thehousehold is a sales account or a prospect or anyother user-defined party type as specified usingthe lookup type ZCA_ HOUSEHOLD _TYPE. It isdefaulted to ZCA_C USTOMER if no value isprovided. Possible values are CUSTOMER orPROSPECT. A list of valid values is defined in the

lookup ZCA_HOUSEHOLD_TYPE. Review andupdate the codes using the Setup andMaintenance work area, Manage StandardLookups task.

UniqueNameSuffix String

Properties


The suffix used to generate the attributePartyUniqueName. The suffix is concatenated tothe householdName attribute to generate thePartyUniqueName. The primary address isdefaulted as the suffix.

Wea lthAmount {http://xmlns.oracle.com/adf /svc

/type

s/}AmountType

Properties


The household's wealth amount or net worth. Thevalue is NULL if not given.

LastAssignmentDat time The date and time when the Sales Account





eTime stamp

Territory Assignment was last run by AssignmentManager.

Note String

Properties


The note about the household.

OwnerName String

The name of a valid employee resource who ownsand manages the sales account.

PrimaryContactEmail

String

The e-mail address of the primary contact.

PrimaryContac tName

String

The name of the primary contact.

PrimaryContac tPartyId

String

Properties


The unique identifier of the primary contact. Tospecify the contac t for a household, you canprovide Contac t’s party ID, PartyNumber, or acombination of SourceSystem andSourceSystemReference.

PrimaryContac tPartyNumber

String

Properties


The party number of the primary contact. Tospecify the contac t for a household, you caneither provide Contact's party ID, PartyNumber, ora combination of SourceSystem andSourceSystemReference.

PrimaryContac tPhone

String

The phone number of the primary contact.

PrimaryContactSourceSystem

String

Properties






The SourceSystem of the primary contact. Tospecify the contact for a household, you caneither provide Contact's party ID, PartyNumber, ora combination of SourceSystem andSourceSystemReference.

PrimaryContactSourceSystemReferenceValue

String

Properties


The SourceSystemReference of the primarycontac t. To spec ify the contact for a household,you can either provide Contac t's party ID,PartyNumber, or a combination of SourceSystemand SourceSystemReference.

RecordSet String

The selected record set under which the searchresults are displayed.

SalesProfileStatus String

Properties


A valid user-defined status of the sales accountthat this household belongs to.

SalesTeamMember String

Properties


The sales team member who is assoc iated to asales account.






Call the Sales Cloud Relationship service (RelationshipService) to create, update,retrieve, and delete relationships. Accounts, contac ts and household could havevarious types of predefined relationships within Oracle Sales Cloud. A contac t can havea contac t relationship with an ac count or household while it could also be a member ofa household. Other such relationships could exist between two contacts or betweentwo accounts or households. This service is used to manage all such relationshipsbetween two parties. It is often used in conjunction with the Account, Contact orHousehold service to c reate the subject and objec t participating in the relationshipbefore using this service to actually create the relationship.

Related Services Trading Community Organization Service and trading Community Person Service aretwo other services that could be used to manage relationships.

Life Cycle

Active

QName

http:/ /xmlns.oracle.com/apps/crmCommon/salesParties/relationshipService/}Relation

shipService

Relationships


Handles Sales Cloud Relationship SDO

Operations


• createRelationship

• updateRelationship

• deleteRelationship

• mergeRelationship

• findRelationship

• processRelationship

• processCSRelationship

• getDfltObjAttrHints

7 Sales Cloud RelationshipSimplified Web Services Interface



Sales Cloud Relationship Simplified Web Services Interface ▪ Operations


• getServiceLastUpdateTime

• getEntityList

createRelationship

Creates a relationship.

Life Cycle

Active

Request Payload

Element

Name

Type Description

relationship SalesCloudRelationship SDO

The relationship to be created.

Response Payload


result SalesCloudRelationship SDO

The relationship which is created.

updateRelationship

Updates a relationship.

Life Cycle

Active



Sales Cloud Relationship Simplified Web Services Interface ▪Operations


Request Payload

Element

Name

Type Description

relationship Sales

Cloud

Relationsh

ip SDO

The relationship to be updated.

Response Payload


Result SalesCloudRelationship SDO

The relationship which is updated.

deleteRelationship

Deletes a relationship.

Life Cycle

Active

Request Payload

Element

Name

Type Description

relationship SalesCloudRelationship SDO

The relationship to be deleted.

Response Payload






Result void Not applicable

mergeRelationship

Merges a relationship. It will perform an update if the objec t exists or an insert if theobject doesn't already exist.

Life Cycle

Active

Request Payload

ElementName

Type Description

Relationship SalesCloudRelationship SDO

The relationship to be merged.

Response Payload



Merged Relationship

findRelationship

Finds a relationship.

Life Cycle

Active

Request Payload

Element

Name

Type Description



Sales Cloud Relationship Simplified Web Services Interface ▪Operations


findCriteria {http://xmlns.oracle.com/adf/

svc/types/}FindCriteria



clause), the fetch size, etc.

findC ontrol {http:/ /xmlns.oracle.com/adf/svc/type

s/}FindControl

Find Control. Not currently used.

Response Payload


result SalesCloudRelationship SDO

Properties

Unbounded

A list of Relationship that satisfy the

inbound criteria.

processRelationship

Performs a bulk load of relationship.

Life Cycle

Active

Request Payload

Element

Name

Type Description

changeOperation

string Indicates what action shall be

performed, such as Create, Update,

Merge, or Delete.

Relationship Sales Properties





CloudRelationship SDO

Unbounded

A list of Relationship to be processed.

processControl

{http:/ /xmlns.oracle.com/adf/svc/type

s/}Proc essControl

Control your bulk upload behavior,

such as whether the valid data will

be committed if there are other

invalid data in the same batch, and

whether the outbound will contain

the key attributes only or the full

object.

Response Payload



Properties

Unbounded

A list of Relationship that are successfullyprocessed.

processCSRelationship

Applies the changes back to the data source for a relationship.

Life Cycle

Active

Request Payload

Element

Name

Type Description

processData {http://xmlns.oracle.com/adf/svc/type

s/}Proc essData




Sales Cloud Relationship Simplified Web Services Interface ▪Sales Cloud Relationship SDO


processControl

{http://xmlns.oracle.com/adf/

svc/types/}Proc essControl

Control your bulk upload behavior, such aswhether the valid data will be committed if thereare other

invalid data in the same batch, and whether theoutbound will contain the key attributes only or thefull

object.

Response Payload



s/}Proc essData

Result of the operation including a list ofrelated/updated data objects, and all warningand informational messages.

Sales Cloud Relationship SDO

An object that includes attributes used to store values while creating or updating arelationship. Relationship is an object that stores attributes that define and categorize arelationship between 2 entities such as ac count, contact and household.

QName

{http:/ /xmlns.orac le.com/apps/crmCommon/salesParties/relationshipService/}Relation

ship

Relationships


Handled by Sales Cloud Relationship





Sales Cloud Relationship Simplified Web Services Interface ▪ Sales Cloud Relationship SDO


Objec tPartyId Long Properties

Creatable, Required, Searchable

The primary key identifier of the object in thisrelationship. Either one of Objec tPartyId,ObjectPartyNumber and ObjectSourceSystemalong with ObjectSourceSystemReferenceValuecombination is used to identify the object party ofthe relationship.

Subjec tPartyId Long Properties


The primary key identifier of the subject in thisrelationship. Either one of Subjec tPartyId,Subjec tPartyNumber and Subjec tSourceSystemalong with SubjectSourceSystemReferenceValuecombination is used to identify the subject party ofthe relationship.

RelationshipType String

Properties


The relationship type name. For example,

CUSTOMER_SUPPLIER. A list of valid relationshiptypes is defined in the lookupHZ_RELATIONSHIP_TYPE. Review and update thecodes using the Setup and Maintenance task,Manage Relationship Lookups.

RelationshipCode string

Properties


Indicates if this is a forward or a backwardrelationship code. A list of valid relationship codes

is defined in the lookup PARTY_RELATIONS_TYPE.Review and update the codes using the Setupand Maintenance task, Manage RelationshipLookups.

StartDate Date

Properties


The date when the relationship was established.




Oracle Sales Cloud Using Simplified SOAP Web Services for Acc ount, Household, and Contact 151

Defaulted to the system date.

EndDate Date

Properties

Creatable, Required, Searchable,Updateable

The date when the relationship ends.

CreatedByModule string

Properties

Creatable, Searchable

Application module that created this relationshiprecord. It is defaulted to value HZ_WS for all webservice based creation.

A list of valid c ertification level codes is defined inthe lookup HZ_CREATED_BY_MODULES. Reviewand update the codes using the Setup andMaintenance task, Manage Trading CommunityCommon Lookups.

Comments string

Properties


The user comments for this relationship.

Status string

Properties

Read-onlyIndicates whether this is an active or inactiverelationship. A for active, I for inactive. This is aninternal column and you are not expec ted to passin a value. A list of valid values is defined in thelookup HZ_STATUS. Review and update the codesusing the Setup and Maintenance work area,Manage Standard Lookups task.

CreatedBy String

Properties


The user who created the record.

CreationDate DateTime

Properties


The date and time when the record was created.

LastUpdateDate Dat Properties





eTime



LastUpdateLogin String

Properties

Searchable


LastUpdatedBy String

Properties



Subjec tPartyNumber

String

PropertiesCreatable, Required, Searchable,

Updateable

The alternate key identifier for the subject party ofthe relationship. One of Subjec tPartyId,SubjectPartyNumber, and a combination ofSubjec tSourceSystem andSubjectSourceSystemReferenceValue, is used toidentify the subjec t party of the relationship.

SubjectSourceSystem

String

Properties


The name of external source system for the subjectparty in the relationship, which are defined by anadmin as part of system setup. One ofSubjec tPartyId, Subjec tPartyNumber, and acombination of SubjectSourceSystem andSubjectSourceSystemReferenceValue, is used toidentify the subject party of the relationship. Thevalue for this attribute should be predefined in thelookup type HZ_ORIG_SYSTEMS_VL using the setuptask Manage Trading Community Source Systems.

SubjectSourceSystemReferenceValue

string

Properties


The identifier for the subject party in therelationship from external source system. One ofSubjectPartyId, SubjectPartyNumber, and acombination of SubjectSourceSystem and





SubjectSourceSystemReferenceValue, is used toidentify the subjec t party of the relationship.

Objec tSourceSystem

String

Properties


The name of external source system for the objectparty in the relationship, which are defined by anadmin as part of system setup. One ofObjectPartyId, ObjectPartyNumber, and acombination of ObjectSourceSystem andObjectSourceSystemReferenceValue, is used toidentify the object party of the relationship. Thevalue for this attribute should be predefined in thelookup type HZ_ORIG_SYSTEMS_VL using the setup

task Manage Trading Community Source Systems.

Objec tSourceSystemReferenceValue

String

Properties


The identifier for the object party in the relationshipfrom external source system. One of Objec tPartyId,ObjectPartyNumber, and a combination ofObjectSourceSystem andObjectSourceSystemReferenceValue, is used toidentify the objec t party of the relationship.

ObjectPartyNumber String PropertiesCreatable, Required, Searchable,

Updateable

The unique identification number for the objectparty of the relationship. One of ObjectPartyId,ObjectPartyNumber, and a combination ofObjectSourceSystem andObjectSourceSystemReferenceValue, is used toidentify the objec t party of the relationship.

RelationshipSourceS

ystem

Strin

g

Properties


The name of external source system for therelationship, which is defined by an admin as partof the system setup.

RelationshipSourceSystemReferenceVal

String

Properties






ue The identifier for the relationship with the externalsource system.




Call the Sales Cloud Address service (AddressService) to provide a representation of the Address entity in

Oracle Sales Cloud. This service exposes the key attributes of an Address and providesoperations to define and manage addresses. This service should be used to mangeaddresses in relation to a customer or prospect entity of type Account, Contact orHousehold. It is also used to manage multiple address purposes for a given address.

While this service is independent and could be used to create an address for an existingcustomer or prospect, it is often used in conjunction with the Account, Contac t orHousehold service to c reate the customer or prospec t first before using this service

Related Services:

Trading Community Location Service is an alternate service used to manage addressesand needs to be used in conjunction with either the Trading Community OrganizationService or Trading Community Person Service or Trading Community Group Servicedepending upon the context used to manage relationships.

Life Cycle

Active

QName

{http:/ /xmlns.orac le.com/apps/crmCommon/salesParties/addressService/}AddressService

Relationships


Handles Sales Cloud Address Purpose SDO

Handles Sales Cloud Address SDO

Operations


• getAddress

• createAddress

• updateAddress

• deleteAddress

8 Sales Cloud Address SimplifiedWeb Services Interface



Sales Cloud Address Simplified Web Services Interface ▪ Operations


• mergeAddress

• findAddress

• processAddress

• processCSAddress

getAddress

Retrieves the address based on the primary key identifier.

Life Cycle

Active

Request Payload

Element

Name

Type Description

addressId Long Party site identifier

Response Payload


result SalesCloudAddressSDO

Address that matches the inbound

key attributes.

createAddress

Creates an Address.

Life Cycle

Active

Request Payload

Element

Name

Type Description

address SalesCloud

Address to be created.



Sales Cloud Address Simplified Web Services Interface ▪Operations


AddressSDO

Response Payload


result {http://xmlns.oracle.com/apps/crmCommon/salesParties/

addressService/}AddressResult

The address which is created.

updateAddress

Updates an address. The address is identified by either providing the primary or alternatekeys of the Address, such AddressId, AddressNumber, SourceSystem or

SourceSystemReferenceValue.Life Cycle

Active

Request Payload

Element

Name

Type Description

address SalesCloud

AddressSDO

Address to be updated.

Response Payload






result {http://xmlns.oracle.com/app

s/crmCommon/salesParties/addressService/ }AddressResult

The address which is updated.

mergeAddressMerges an address. It will perform an update if the object exists or an insert if the objec tdoesn't already exist.

Life Cycle

Active

Request Payload

Element

Name

Type Description

address SalesCloudAddressSDO

Address to be merged.

Response Payload


result {http://xmlns.oracle.com/apps/crmCommon/salesParties/addressService/ }AddressResul

Merged Address







findCriteria {http:/ /xmlns.oracle.com/adf/

svc/types/}FindC riteria



clause), the fetch size, etc.

findC ontrol {http://xmlns.oracle.com/adf/svc/types/}FindC ontrol

Find Control. Not currently used.

Response Payload



A list of Address that satisfy the

inbound criteria.

processAddress

Bulk loads the Address. Performs a Create, Update, or Delete operation on a list ofAddress rows. Different operations may be applied to different objec ts, depending onwhat is specified in the C hangeSummary objec t.

Life Cycle

Active

Request Payload

Element Name Type Description

changeOperation

string Indicates what action shall be

performed, such as Create, Update,

Merge, or Delete.

address SalesCloudAddress

Properties

Unbounded



Sales Cloud Address Simplified Web Services Interface ▪Operations


SDO A list of Address to be processed.

processControl {http:/ /xmlns.oracle.com/adf/svc/types/}ProcessControl

Control your bulk upload behavior,

such as whether the valid data willbe committed if there are other

invalid data in the same batch, and

whether the outbound will contain

the key attributes only or the full

object.

Response Payload



Properties

Unbounded

A list of Address that are successfully processed.

processCSAddress

Applies the changes back to the data source for Address.

Life Cycle

Active

Request Payload

Element

Name

Type Description

processData {http:/ /xmlns.oracle.c

om/adf/svc/types/}ProcessData


processControl

{http:/ /xmlns.oracle.com/adf/svc/types/}Pr

Control your bulk upload behavior, such aswhether the valid data will be committed if thereare other

invalid data in the same batch, and whether the



Sales Cloud Address Simplified Web Services Interface ▪ Sales Cloud Address SDO

Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact162

ocessControl

outbound will contain the key attributes only or thefull

object.

Response Payload


result {http://xmlns.oracle.com/adf/svc/types/}Process

Data

Result of the operation including a list ofrelated/updated data objects, and all warningand informational messages.

Sales Cloud Address SDO

An object that includes attributes used to store values while creating or updating anaddress. An address represents the location information of an account, contac t orhousehold.

QName

{http:/ /xmlns.orac le.com/apps/crmCommon/salesParties/addressService/}Address

Relationships


Contains Sales Cloud Address Purpose SDO

Handled by Sales Cloud Address



PartyId long Properties

Creatable

Unique Identifier of the account, contac t or



Sales Cloud Address Simplified Web Services Interface ▪Sales Cloud Address SDO


household to which the address is assoc iated. Oneof PartyId, PartyNumber or PartySourceSystem andPartySourceSystemReferenceValue keys is requiredto uniquely identify the account, contac t orhousehold record with which the address isassociated.

PartyNumber string Properties

Creatable

Alternate unique identifier of the account, contac tor household to which the address is associated.One of PartyId, PartyNumber or PartySourceSystemand PartySourceSystemReferenceValue keys isrequired to identify the account, contac t orhousehold record with which the address isassociated. The default value is the valuespecified in the profile option ZCA_PUID_PREFIXconcatenated with a unique generatedsequence number. The value is updateabledepending on the profile optionHZ_GENERATE_PARTY_NUMBER. A list of valid valuesis defined in the profile optionHZ_GENERATE_PARTY_NUMBER. Review and

update the codes using the Setup andMaintenance work area, Manage TradingCommunity Common Profile Options task.

PartySourceSystem

string Properties

Creatable

Name of external source system of the account,contact or household with which the address isassoc iated. Part of Alternate Key for the account,contac t or household record (along withPartyourceSystemReferenceValue). One of

PartyId, PartyNumber or PartySourceSystem andPartySourceSystemReferenceValue keys is requiredto identify the account, contac t or householdrecord with which the address is assoc iated. Thevalue for this attribute should be predefined in thelookup type HZ_ORIG_SYSTEMS_VL using the setuptask Manage Trading Community Source Systems.





PartySourceSystemReferenceValue

string Properties

Creatable

Identifier from external source system for theaccount, contact or household with which theaddress is associated. Part of Alternate Key (alongwith PartySourceSystem). One of PartyId,PartyNumber or PartySourceSystem andPartySourceSystemReferenceValue keys is requiredto identify the account, contac t or householdrecord with which the address is associated.

AddressId long Keys

Primary Key

The unique address identifier that is internallygenerated during c reate. One of AddressId,AddressNumber or SourceSystem andSourceSystemReferenceValue keys is used toidentify the address record during update.

AddressNumber string Properties

Creatable

The alternate unique identifier for the address. Oneof AddressId, AddressNumber or SourceSystemand SourceSystemReferenceValue keys is used to

identify the address record during update. If notspecified, then it is automatically generated.Prefix defined as in profile option ZCA_PUID_PREFIXconcatenated with an internally generatedunique sequence number.



The user comments for the address

DoNotMailFlag boole

an

Properties


Indicates that this address should not be used formailing

CorpCurrencyCode

string Properties


The corporate currency code assoc iated with the





addresses. A list of valid values is defined in thelookup ZCA_COMMON_CORPORATE_CURRENCY.Review and update the profile option using theSetup and Maintenance work area, ManageCurrency Profile Options task.

CreatedBy string The user who created the record.

CreationDate dateTime

Date and time when the record was created.

CreatedByModule

string Application module that created this organizationrecord. Defaulted to value HZ_WS for all webservice based creation.

A list of valid c ertification level codes is defined in

the lookup HZ_CREATED_BY_MODULES. Reviewand update the codes using the Setup andMaintenance task, Manage Trading CommunityCommon Lookups.

CurcyConvRateType

string The currency conversion rate type associated withthe address. This attribute is used by CRMExtensibility framework. A list of valid values isdefined in the lookup ZCA_COMMON_RATE_TYPE.Review and update the profile option using theSetup and Maintenance work area, ManageCurrency Profile Options task.

CurrencyCode string The currency code related to the address. Thisattribute is used by CRM Extensibility framework. Alist of valid values is defined in the lookupZCA_COMMON_CORPORATE_CURRENCY. Reviewand update the profile option using the Setup andMaintenance work area, Manage Currency ProfileOptions task.

EndDateActive date Properties


Date after which this address is rendered inactive.

FormattedAddress

string The formatted address information.

FormattedMultilineAddress

string The formatted multiple line address information.







bute2 Creatable, Updateable

The additional address element to support flexibleaddress format.

AddrElementAttribute3

string Properties




string Properties




string Properties



Address1 string Properties


The first line for address.

Address2 string PropertiesCreatable, Updateable

The second line for address.



The third line for address.



The fourth line for address.

AddressLinesPhonetic

string Properties


The phonetic or Kana representation of the Kanjiaddress lines (used in J apan).





Building string Properties


The specific building name or number at a givenaddress.

City string Properties


The city element of Address.

ClliCode string Properties


The Common Language Location Identifier (CLLI)

code.

Country string Properties


The country code of the address.

County string Properties


The county element of the address.

DateValidated date PropertiesRead-only

Date on which the address was last validated.

Description string Properties


An extensive description of the location.

FloorNumber string Properties


The specific floor number at a given address or ina particular building when building number isprovided.

HouseType string Properties


Indicates the building type. A list of ̀ valid values





are defined in the lookup HZ_HOUSE_TYPE. Reviewand update the codes using the Setup andMaintenance work area, Manage StandardLookups task.

Latitude decimal

Properties


Used to store latitude information for the locationfor spatial proximity and containment purposes.

LocationDirections

string Properties


The directions to the location.

Longitude decimal

Properties


Used to store longitude information for the locationfor spatial proximity and containment purposes.

PostalCode string Properties


The postal code as defined by the formalcountrywide postal system.

PostalPlus4Code string Properties


The four digit extension to the United States PostalZIP code.

Province string Properties


The province element of Address.

State string Properties


The state element of Address.

ValidatedFlag boolean

Indicates whether the location was validated. Y forvalidated, N for invalidated. If the value is True,then the location is validated. The va lue isinternally set by system during address cleansing.





ValidationStartDate

date Date on which the validation starts. Internally setby system during address cleansing.

ValidationStatusCode

string Properties


The standardized status code that describes theresults of the validation. Internally set by systemduring address cleansing.

SourceSystem string Properties

Creatable

Composite alternate key: SourceSystem andSourceSystemReference

Name of external source system for the addressdenoted by a code, which is defined by anadministrator as part of system setup. The value forthis attribute should be predefined in the lookuptype HZ_ORIG_SYSTEMS_VL using the setup taskManage Trading Community Source Systems.SourceSystem and SourceSystemReferencecombination is unique and is used as the foreignkey to identify an address.


string Properties

Creatable

Composite alternate key: SourceSystem andSourceSystemReference

The unique identifier for the address from theexternal source. SourceSystem andSourceSystemReference combination is uniqueand is used as the foreign key to identify anaddress.

AddressPurpose SalesCloudAddressPurpose SDO

Properties


Reference to the address purpose child entity ofthis address



Sales Cloud Address Simplified Web Services Interface ▪Sales Cloud Address Purpose SDO


Sales Cloud Address Purpose SDO

An object that includes attributes used to store values while creating or updating theaddress purpose. The address purpose describes the use of an address. For example,

shipping address or billing address.

QName

{http:/ /xmlns.orac le.com/apps/crmCommon/salesParties/addressService/}AddressPurpose

Relationships


Contained by Sales Cloud Address SDO

Handled by Sales Cloud Address



AddressPurposeId long Keys

Primary Key

Address purpose unique internal identifier used foridentifying the address purpose record in case ofupdate. The identifier is internally generated duringcreate.

Purpose string Properties

Creatable

Indicates the use or purpose of the address e.g.billing, shipping etc. A list of valid values is definedin the lookup PARTY_SITE_USE_CODE. Review and

update the codes using the Setup andMaintenance work area, Manage StandardLookups task.

DeleteFlag boolean

Properties


Indicates if the address purpose is to be deleted.Valid values are Y or N. Mention Y for delete,



Sales Cloud Address Simplified Web Services Interface ▪ Sales Cloud Primary Address SDO


considered N by default

Sales Cloud Primary Address SDO

An object that includes attributes used to store values while creating or updating aprimary address. A primary address is the default communication address of an entityirrespec tive of the address purpose

QName

{http://xmlns.oracle.com/apps/crmCommon/salesParties/commonService/}PrimaryAddress

Relationships


Contained by Sales Cloud Account SDO

Contained by Sales Cloud Contact SDO

Contained by Sales Cloud Household SDO

Handled by Sales Cloud Account

Handled by Sales Cloud Contact

Handled by Sales Cloud Household



AddressId long Keys

Primary Key

Address internal unique identifier that is internallygenerated during c reate. One of AddressId,AddressNumber or SourceSystem andSourceSystemReferenceValue keys is used toidentify the address record during update.

AddressNumber string Properties



Sales Cloud Address Simplified Web Services Interface ▪Sales Cloud Primary Address SDO


Creatable

Alternate unique identifier for the address. One ofAddressId, AddressNumber or SourceSystem and

SourceSystemReferenceValue keys is used toidentify the address record during update. If notspecified, then it is automatically generated.Prefix defined as in profile option ZCA_PUID_PREFIXconcatenated with an internally generatedunique sequence number.

SourceSystem string Composite alternate key

SourceSystem and SourceSystemReference

Properties

Creatable

Name of external source system for the addressdenoted by a code, which is defined by anadministrator as part of system setup. The value forthis attribute should be predefined in the lookuptype HZ_ORIG_SYSTEMS_VL using the setup taskManage Trading Community Source Systems.SourceSystem and SourceSystemReferencecombination is unique and is used as the foreignkey to identify an address.


string Composite alternate key

SourceSystem and SourceSystemReference

Properties

Creatable

The unique identifier for the address from theexternal source. SourceSystem andSourceSystemReference c ombination is uniqueand is used as the foreign key to identify anaddress.

LocationId long Properties

Read-only

Unique identifier for the location record for thisaddress

PartyId Long Properties

Creatable





Unique Identifier of the account, contac t orhousehold to which the address is assoc iated. Oneof PartyId, PartyNumber or PartySourceSystem andPartySourceSystemReferenceValue keys is requiredto uniquely identify the account, contac t orhousehold record with which the address isassociated.


string Properties


Additional address element to support flexibleaddress format


string Properties

Creatable, UpdateableAdditional address element to support flexibleaddress format


string Properties




string Properties

Creatable, UpdateableAdditional address element to support flexibleaddress format


string Properties




Creatable, UpdateableFirst line for address



Second line for address







Third line for address



Fourth line for address

Building string Properties


Specific building name or number at a givenaddress

City string Properties


City element of Address.

Country string Properties


Country code of the address.

County string Properties


County element of Address.

FloorNumber string Properties


Specific floor number at a given address or in aparticular building when building number isprovided

PostalCode string Properties


Postal code as defined by the formal countrywidepostal system

PostalPlus4Code string Properties


Four digit extension to the United States Postal ZIP







Read-only

Date the address was last validated.

HouseType string PropertiesCreatable, Updateable

Indicates the building type. A list of valid values isdefined in the lookup HZ_HOUSE_TYPE. Review andupdate the codes using the Setup andMaintenance work area, Manage StandardLookups task.

LocationDirections

string Properties


Directions to the location

ValidatedFlag boolean

Indicates if the location was validated. Y forvalidated, N for invalidated. The value is internallyset by system during address cleansing.

ValidationStartDate

date Start date of the validation. Internally set by systemduring address cleansing.

FormattedAddress

string Formatted address information

FormattedMultilineAddress

string Formatted multiple line address information

CreatedBy string Who column that indicates the user who createdthe record.

CreationDate dateTime

Who column that indicates the date and time ofthe creation of the record.

LastUpdateDate dateTime

Who column that indicates the date and time ofthe last update of the record.

LastUpdateLogin string Who column that indicates the session loginassoc iated to the user who last updated therecord.

LastUpdatedBy string Who column that indicates the user who lastupdated the record.

DeleteFlag boole Properties





an Creatable, Updateable

Indicates if the primary address is to be deleted.Valid values are Y or N. Mention Y for delete,

considered N by default

CorpCurrencyCode

string Corporate currency code assoc iated with theaddresses. This attribute is used by CRM Extensibilityframework The value of the profile optionZCA_C OMMON_CORPORATE_CURRENCY is thedefault corporate currency value. Review andupdate the profile option using the Setup andMaintenance work area, Manage Profile Optionstask.

CurcyConvRateTy

pe

string Currency conversion rate type associated with the

address. This attribute is used by CRM Extensibilityframework. A list of valid values are defined in thelookup ZCA_C OMMON_RATE_TYPE. Review andupdate the profile option using the Setup andMaintenance work area, Manage Currency ProfileOptions task.

CurrencyCode string Currency Code related to the address. Thisattribute is used by CRM Extensibility framework. Alist of valid values are defined in the lookupZCA_COMMON_CORPORATE_CURRENCY. Reviewand update the profile option using the Setup and

Maintenance work area, Manage Currency ProfileOptions task.




You can use the Fusion Service Tester to easily test Oracle Sales Cloud Web services. Itcan be invoked by clicking a bat file or by running a jar file. You must download J ava onyour computer to run Fusion Service Tester:

Installing JAVA on Windows machine

1. Get the latest J DK version from the link:http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html .

2. Install J AVA from the executable.

3. Note down the path of bin direc tory in the J ava installation directory. The defaultpath is: C:\ Program Files\ J ava\ jdkx.x.x\ bin.

4. Set the System Environment variables.

A. Right-click on 'My Computer' and selec t 'Properties'.

B. Go to Advanced System Settings.

C. Click Environment Variables.

D. Set the PATH variable

E. If PATH is already present, double click it and append the bin path like";C:\ Program Files\ J ava\ jdkx.x.x\ bin;".

F. Else create a New Variable by clicking NEW. Provide variable name as "Path"

G. and variable value as path of bin direc tory "C:\ Program Files\ J ava\ jdkx.x.x\ bin;"

H. Click Ok.

5. Type " java -version " in the command prompt to test if installation is successful. A successfulinstallation will return version details.

Downloading the Fusion Service Tester

1. Login to OER(https://fusionappsoer.oracle.com)

2. Enter the following path in the browser window and press Enter:https://fusionappsoer.oracle.com/oer/FusionServiceTester.zip

Running the Fusion Service Tester Client

1. Navigate to the C lient code direc tory and Use the startFusionServiceTester.sh orstartFusionServiceTester.bat to start the Client.

2. Alternatively you can run the client using the following command:-

9 Appendix A: Downloading andSetting Up the Fusion Service Tester

https://fusionappsoer.oracle.com/



https://fusionappsoer.oracle.com/



Appendix A: Downloading and Setting Up the Fusion Service Tester ▪ Importing a New

certificate in the keystore (for IE)


java -Djavax.net.ssl.trustStore=default-keystore.jks -jarFusionServiceTester.jar

Note: If you get a SSL handshake error related to invalid certificate path, then additional setup mightbe needed to manually add the certificate in the truststore. To do that follow the below instruction

Importing a New certificate in the keystore (for IE)

1. Export the certificate from the browser to file using following steps

A. Open the SSL URL for any of the web service.

B. Click on the lock icon besides the URL.

C. Go to the connections tab and certificate information link.

D. Go to Details -> Copy to File -> NextE. Change the encoding to the Base-64 and click Next.

F. Provide the filename and c lick finish.

2. Then in the command prompt type the below command:

keytool -import -trustcacerts -file <filename> -alias <aliasname> -keystore default-keystore.jks -storepass welcome1





Appendix B: Sample Code: Static Web Service Proxy J AX-WS Style ▪ Importing a New



public void testCRUDOperations(PrintWriter out) {

out.println("Testing JCS/OSC CRUD operations with");

out.println("Endpoint: : " + endpoint);out.println("Username : " + osc_username);

out.println("Password: " + osc_password);

Date time = new Date();

// Global Try Catch

try {

// Setup SOAP Connection

// Workaround bug#18241690, to ensure Java Cloud uses thecorrect XLS transformer

System.setProperty("javax.xml.transform.TransformerFactory",

"com.sun.org.apache.xalan.internal.xsltc.trax.TransformerFactoryImpl");

// Set SSL SecurityPolicy, this examples assumes Httpsconnection not SAML

String SSLSecurityPolicy =

"oracle/wss_username_token_over_ssl_client_policy";

SecurityPolicyFeature[] m_securityFeature =

new SecurityPolicyFeature[] { newSecurityPolicyFeature(SSLSecurityPolicy) };

// Initiate account Service

accountService_Service = new AccountService_Service();

//m_securityFeature =

// new SecurityPolicyFeature[] { newSecurityPolicyFeature(SSLSecurityPolicy) };

// Connect to the JAXWS WebServiceEndpoint

AccountService accountService =

accountService_Service.getAccountServiceSoapHttpPort(m_securityFeature);

// Get the request context to set the outgoing addressingproperties

// Set the username,password and endpoint of the SOAP Service.These lines overrite what

WSBindingProvider wsbp = (WSBindingProvider)accountService;

wsbp.getRequestContext().put(WSBindingProvider.USERNAME_PROPERTY,

osc_username);

wsbp.getRequestContext().put(WSBindingProvider.PASSWORD_PROPERTY,

osc_password);







Appendix B: Sample Code: Static Web Service Proxy J AX-WS Style ▪Importing a New



if (mergeResult != null && mergeResult.getValue() != null &&

mergeResult.getValue().size() > 0) {

Account mergeAccResult =

(Account)mergeResult.getValue().get(0);out.println(" PartyId is: " +

mergeAccResult.getPartyId());

out.println(" PartyNumber is " +

mergeAccResult.getPartyNumber());

out.println(" Organization Name is " +

mergeAccResult.getOrganizationName());

}

//

// DELETE account

//// using the partyId to delete the party

// does it return anything?

out.println("Deleting Organization with party id " + partyId);

Account account = objectFactory.createAccount();

account.setPartyId(partyId);

accountService.deleteAccount(account);

//

// PROCESS account

//

// Used for batch operations. The same operation is perfomedon each object

out.println("Performing Batch creation of Organizations");

// Create the Account objects

Account account1 = objectFactory.createAccount();

account1.setPartyNumber("DHQA_06052150_A1");

account1.setOrganizationName("Process Merge Account 1");

//

Account account2 = objectFactory.createAccount();

account2.setPartyNumber("DHQA_06052150_A1_123");

account2.setOrganizationName("Process Merge Account 2");

// add them to a list

List<Account> accountList = new ArrayList<Account>();

accountList.add(account1);

accountList.add(account2);



Appendix B: Sample Code: Static Web Service Proxy J AX-WS Style ▪ Importing a New



//set the process control params

ProcessControl pc = new ProcessControl();

pc.setPartialFailureAllowed(true);

pc.setExceptionReturnMode(ReturnMode.FULL);pc.setReturnMode(ReturnMode.FULL);

// invoke the process operation. Here "merge" operation isbeing invoked

DataObjectResult processResults =

accountService.processAccount("Merge", accountList, pc);

List accountProcessResults = processResults.getValue();

for (Object o : accountProcessResults) {

Account processResult = (Account)o;

out.println(processResult.getPartyId());out.println(processResult.getPartyNumber());

out.println(processResult.getOrganizationName());

}

//

// FIND account

// finding accounts whose party numbers are given

//

// The following code implements this SOAP message

//

// <typ:findCriteria>

// <typ1:fetchStart>0</typ1:fetchStart>

// <typ1:fetchSize>10</typ1:fetchSize>

// <typ1:filter>

// <typ1:group>

//<typ1:upperCaseCompare>true</typ1:upperCaseCompare>

// <typ1:item>

// <typ1:upperCaseCompare/>

//<typ1:attribute>PartyNumber</typ1:attribute>

// <typ1:operator>IN</typ1:operator>

//<typ1:value>DHQA_06052150_A1</typ1:value>

//<typ1:value>DHQA_06052150_A1_123</typ1:value>

// </typ1:item>

// </typ1:group>

// </typ1:filter>



Appendix B: Sample Code: Static Web Service Proxy J AX-WS Style ▪Importing a New



// </typ:findCriteria>

FindCriteria fc = new FindCriteria();fc.setFetchSize(10); // Get max of 10 records

fc.setFetchStart(0); // Start at index 0

ViewCriteriaItem vcItem = new ViewCriteriaItem();

vcItem.setAttribute("PartyNumber");

vcItem.setOperator("IN");

vcItem.setUpperCaseCompare(true);

vcItem.getValue().add("DHQA_06052150_A1");

vcItem.getValue().add("DHQA_06052150_A1_123");

ViewCriteriaRow vcr = new ViewCriteriaRow();

vcr.getItem().add(vcItem);ViewCriteria vc = new ViewCriteria();

vc.getGroup().add(vcr);

fc.setFilter(vc);

//

// Now findCriteria is created add it to the calling objectand call the service

//

FindAccount facc = new FindAccount();

facc.setFindCriteria(fc);

DataObjectResult findResponse =

accountService.findAccount(fc, null);

if (findResponse != null && findResponse.getValue() != null) {

List findResults = findResponse.getValue();

for (Object o : findResults) {

Account findResult = (Account)o;

out.println(findResult.getPartyId());

out.println(findResult.getPartyNumber());

out.println(findResult.getOrganizationName());

}

}

} catch (Exception e) {

e.printStackTrace();

out.println(e.getLocalizedMessage());

}

return;

}

}






This is a sample certificate and the sections below illustrate how to extract the certificatefrom a WSDL and add to a keystore. The actual Oracle public certificate should beextracted from a Fusion WSDL.

In the Fusion WSDL, the encrypted certificate is stored in the following format:

<dsig:X509Certificate>MIICCzCCAXSgAwIBAgIETf8ZWjANBgkqhkiG9w0BAQUFADBKMRMwEQYKCZImiZPyLGQBGRYDY29tMSEwHwYKCZImiZPyLGQBGRYRb3JhY2xlb3V0c291cmNpbmcxEDAOBgNVBAMTB3NlcnZpY2UwHhcNMTEwNjIwMDk1NjQyWhcNMTExMjE3MDk1NjQyWjBKMRMwEQYKCZImiZPyLGQBGRYDY29tMSEwHwYKCZImiZPyLGQBGRYRb3JhY2xlb3V0c291cmNpbmcxEDAOBgNVBAMTB3NlcnZpY2UwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAJJsUQQHiE9qlTlv3n1jP3JhepkAwsxXsy5+DMifv2ZbB2haoCcJ319Nx06tg67QyS5E79iAs3rLE5W/2rEKXmWjJ74whX

0gJho+a+33EMLDuejehtx1d726CoYIvTpGl+6C+QH1R3N1MIEFWk0JuLod5YFgEXgXhNQuEFXz3UIbAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAGYQX4MKfFlwO1TuKpjtABEwveZKpyIvkfdCcqvZVpdIb7rNyCeVWOuSlpldgEQ4lUYo29IrFf50z/Rbuz4tu3JT8uB2cpRpX9GDUKq5MTx6efVUVH9EGK0sZZ8NbX2aeAlOq02Wau2T0og5IxID7KPcCU1qiRV0WA3ebd15vODk=</dsig:X509Certificate>

Copy the encrypted text to a text editor and remove the<dsig:X509Certificate> and </dsig:X509Certificate> tags. Add thefollowing lines before and after the encrypted text.

-----BEGIN CERTIFICATE-----

-----END CERTIFICATE-------

-----BEGIN CERTIFICATE-----MIICCzCCAXSgAwIBAgIETf8ZWjANBgkqhkiG9w0BAQUFADBKMRMwEQYKCZImiZPyLGQBGRYDY29tMSEwHwYKCZImiZPyLGQBGRYRb3JhY2xlb3V0c291cmNpbmcxEDAOBgNVBAMTB3NlcnZpY2UwHhcNMTEwNjIwMDk1NjQyWhcNMTExMjE3MDk1NjQyWjBKMRMwEQYKCZImiZPyLGQBGRYDY29tMSEwHwYKCZImiZPyLGQBGRYRb3JhY2xlb3V0c291cmNpbmcxEDAOBgNVBAMTB3NlcnZpY2UwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAJJsUQQHiE9qlTlv3n1jP3JhepkAwsxXsy5+DMifv2ZbB2haoCcJ319Nx06tg67QyS5E79iAs3rLE5W/2rEKXmWjJ74whX0gJho+a+33EMLDuejehtx1d726CoYIvTpGl+6C+QH1R3N1MIEFWk0JuLod5YFgEXgXhNQuEFXz3UIbAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAGYQX4MKfFlwO1TuKpjtABEwveZKpyIvkfdCcqvZVpdIb7rNyCeVWOuSlpldgEQ4lUYo29IrFf50z/Rbuz4tu3JT8uB2cpRpX9GDUKq5MTx6efVUVH9EGK0sZZ8NbX2aeAlOq02Wau2T0og5IxID7KPcCU1qiRV0WA3ebd15vODk=

-----END CERTIFICATE----

Save the file as yourcert.crt. The certificate can now be imported to the keystore underthe rcpt-key-alias. The Oracle certificate file can be imported to the keystore using thekeytool commands listed below.

Import Oracle certificate to a keystore file

keytool -importcert -alias nameoforaclekey -file oraclecertificatefile.cer-keystore oracle-keystore.jks -storepass keystorepassword

11 Appendix C: ExtractingOracle Public Certificate fromFusion WSDL



Documents

Using Simplified SOAP Web Services