Oracle CRM On Demand Documentation Library: Address

Oracle Web Services On Demand Guide > Oracle CRM On Demand Objects Accessible Through Web Services > Core Parent Objects (Web Services v2.0) >

Address

The shared address object stores information about addresses that can be shared between account, contact, dealer, and partner records.

Child Objects

Account, Contact, Custom Object 1 through 3, Custom Object 4 through 15, Dealer, Partner

NOTE: For the Account, Contact, Dealer, and Partner child objects, access is read-only.

Usage

This object is applicable only for companies that have the Enable Shared Addresses check box selected on the company profile. In this case, addresses can be associated with multiple account, contact, dealer, or partner records.

After a shared address object is inserted, it can be shared between accounts, contacts, dealers and partners by inserting a child shared address object for those record types. When a child shared address is inserted, it can be flagged as a billing address or shipping address for accounts, dealers, and partners, or as a primary contact address for contacts. When this occurs, the billing, shipping, or primary contact fields in the parent object are populated from the shared address fields. For more information about the shared address child object, see Shared Address.

NOTE: If the Validate Shared Addresses option is selected for the company, an address can only be shared after it is validated.

When a shared address is updated through the Address service, all shared address child objects for the address are updated. Also, the address fields in the associated account, contact, dealer, or partner objects are updated, if the address deleted was flagged as a billing, shipping, or primary contact address.

To delete a shared address, the Manage Addresses privilege is required. When a shared address is deleted through the Address service, all shared address child objects for the address are dissociated from their parent objects. Also, the address fields in the associated account, contact, dealer, or partner objects are deleted, if the address deleted was flagged as a billing, shipping, or primary contact address. For more information about the shared address functionality, see Oracle CRM On Demand Online Help.

Converting Unshared Addresses to Shared Addresses

Release 19 and earlier releases of Oracle CRM On Demand used unshared addresses. To convert unshared addresses from earlier releases to shared addresses, you can follow a procedure that uses the export and import functionality of the Oracle CRM On Demand UI as described in Oracle CRM On Demand Online Help.

You can also follow a procedure that uses UI export functionality and Web services calls to import data. This involves writing an application to read exported data from a file and then creating the SOAP requests to send to Oracle CRM On Demand. Sample SOAP request are shown in the procedure in this topic. However, it may be more efficient, especially if the conversion is a one-time process, to use the import functionality of the UI rather than Web services calls.

TIP: If the data files are large and the Web services or import operations take longer than you expect, then you can use Oracle Data Loader On Demand with the same input files and mapping files that are defined in the conversion procedure.

Before you begin: It is assumed that Oracle CRM On Demand Customer Care has upgraded your company to the current release. To complete this procedure, you must be a company administrator who can perform import and export operations, Web services calls, and customize Oracle CRM On Demand. You require the Manage Addresses privilege to enable shared address functionality.

NOTE: When moving to shared addresses from unshared addresses, you must use the Web Services v2.0 API for all Web services requests because the Web Services v1.0 API does not support access to shared addresses.

In the following procedure, the steps are performed in the Oracle CRM On Demand UI unless otherwise stated:

To convert unshared addresses to shared addresses

If it is selected, deselect the Enable Shared Addresses setting in the company profile.
Export the data from the address-related objects that you want to convert to shared addresses.
The list includes the following items:
- All account data sections including:
  - Accounts
  - Account Addresses
  - Contacts
  - Account Partners
  - Addresses
- All contact data sections including:
  - Contacts
  - Contact Addresses
  - Accounts
  - Addresses
- All dealer data sections including:
  - Dealer
  - Dealer Addresses
- All partner data sections including:
  - Partner
  - Partner Addresses
- All address data
  This export operation must export all the relevant account, contact, partner, dealer, and address data from Oracle CRM On Demand to an external file. You must be able to use the external file with the data correction and standardization method that you choose.
Correct and reformat the data so that importing these addresses into Oracle CRM On Demand does not result in duplicate data and so that the account, contact, dealer, and partner data is set up with the associated addresses.
It is likely that many duplicate and invalid addresses will exist after the export operation. For example, because addresses were not shared in earlier releases, contacts residing at the same location might have identical or similar addresses. However, minor differences might arise because of typing and other errors. For the duplicate addresses that are likely to occur, reimporting the records (for example, accounts) and associating them with newly created shared address records will not delete the preexisting address associations from the earlier release. Consequently, you must do the following:
- Verify your data and then remove duplicate records when preparing the address data that you want to import.
- Take ownership of the preexisting unshared address data associated with your account, contact, dealer, and partner records if you decide to associate those records with the shared address version of the address data. That is, you must remove and disassociate, and choose whether to retain the preexisting unshared address data.
  For information on preparing the data for import or use with Web services, see the following topics in Oracle CRM On Demand Online Help:
- Address Fields: Import Preparation
- Account Fields: Import Preparation
- Contact Fields: Import Preparation
- Dealer Fields: Import Preparation
- Partner Fields: Import Preparation
Import the address record data by using Web services calls to insert the Address record data into Oracle CRM On Demand.
Inserting the shared Address top-level record data is a prerequisite for inserting account, contact, dealer, and partner record data. The following is a sample SOAP request for inserting the data:

<?xml version="1.0" encoding="utf-16" standalone="no"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/ XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecuritysecext- 1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Header>

<wsse:Security>

   <wsse:UsernameToken>

   <wsse:Username>%%USERNAME%%</wsse:Username>

   <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-tokenprofile- 1.0#PasswordText">%%PASSWORD%%</wsse:Password>

   </wsse:UsernameToken>

</wsse:Security>

</soap:Header>

<soap:Body>

<SharedAddressInsert_Input xmlns="urn:crmondemand/ws/ecbs/sharedaddress/">

<ListOfSharedAddress>

   <SharedAddress>

      <AddressName>LS Address 8</AddressName>

      <PrimaryAddressLine1>30 Prospect Ave</PrimaryAddressLine1>

      <Country>USA</Country>

      <City>Hackensack</City>

      <StateProvince>NJ</StateProvince>

      <ZipCode>07601</ZipCode>

   </SharedAddress>

   <SharedAddress>

      <AddressName>LS Address 9</AddressName>

      <PrimaryAddressLine1>100 S Jackson Ave</PrimaryAddressLine1>

      <Country>USA</Country>

      <City>Pittsburgh</City>

      <StateProvince>PA</StateProvince>

      <ZipCode>15202</ZipCode>

   </SharedAddress>

</ListOfSharedAddress>

</SharedAddressInsert_Input>

</soap:Body>

</soap:Envelope>

Make sure that you retrieve the Address Ids from the SOAP response for the insert operations.
Import the account record data by using Web services calls to insert the Account-Address record data into Oracle CRM On Demand.
This insertion associates the shared addresses with the accounts. The following is a sample SOAP request for inserting the data. The <AddressId> values used are those retrieved from the response in the previous step:

<?xml version="1.0" encoding="utf-16" standalone="no"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/ XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecuritysecext- 1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Header>

<wsse:Security>

   <wsse:UsernameToken>

      <wsse:Username>%%USERNAME%%</wsse:Username>

      <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-tokenprofile- 1.0#PasswordText">%%PASSWORD%%</wsse:Password>

   </wsse:UsernameToken>

</wsse:Security>

</soap:Header>

<soap:Body>

<AccountExecute_Input xmlns="urn:crmondemand/ws/ecbs/account/">

<ListOfAccount>

   <Account operation="skipnode">

      <Id>1QA2-11V4OX</Id>

      <ListOfSharedAddress>

         <SharedAddress operation="insert">

            <AddressId>1QA2-1TAEXP</AddressId>

            <AddressType>Office</AddressType>

            <PrimaryBillingAddressFlag>true</PrimaryBillingAddressFlag>

            <PrimaryShippingAddressFlag>true</PrimaryShippingAddressFlag>

         </SharedAddress>

      </ListOfSharedAddress>

   </Account>

</ListOfAccount>

</AccountExecute_Input>

</soap:Body>

</soap:Envelope>
Import the contact record data by using Web services calls to insert the Contact-Address record data into Oracle CRM On Demand.
This insertion associates the shared addresses with the contacts. The following is a sample SOAP request for inserting the data:

<?xml version="1.0" encoding="utf-16" standalone="no"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/ XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecuritysecext- 1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Header>

<wsse:Security>

   <wsse:UsernameToken>

     <wsse:Username>%%USERNAME%%</wsse:Username>

      <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-tokenprofile- 1.0#PasswordText">%%PASSWORD%%</wsse:Password>

   </wsse:UsernameToken>

</wsse:Security>

</soap:Header>

<soap:Body>

<ContactExecute_Input xmlns="urn:crmondemand/ws/ecbs/contact/">

   <ListOfContact>

      <Contact operation="skipnode">

         <Id>1QA2-1S5XPM</Id>

         <ListOfSharedAddress>

         <SharedAddress operation="insert">

         <AddressId>1QA2-1TAEXP</AddressId>

         <AddressType>Office</AddressType>

        <PrimaryContactAddressFlag>true</PrimaryContactAddressFlag>

        </SharedAddress>

        </ListOfSharedAddress>

     </Contact>

  </ListOfContact>

</ContactExecute_Input>

</soap:Body>

</soap:Envelope>
Import the dealer record data by using Web services calls to insert the Dealer-Address record data into Oracle CRM On Demand.
This insertion associates the shared addresses with the dealers. The following is a sample SOAP request for inserting the data:

<?xml version="1.0" encoding="utf-16" standalone="no"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/ XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecuritysecext- 1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Header>

<wsse:Security>

   <wsse:UsernameToken>

      <wsse:Username>%%USERNAME%%</wsse:Username>

     <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-tokenprofile- 1.0#PasswordText">%%PASSWORD%%</wsse:Password>

   </wsse:UsernameToken>

</wsse:Security>

</soap:Header>

<soap:Body>

<DealerExecute_Input xmlns="urn:crmondemand/ws/ecbs/dealer/">

   <ListOfDealer>

      <Dealer operation="skipnode">

         <Id>1QA2-1FH4CA</Id>

         <ListOfSharedAddress>

         <SharedAddress operation="insert">

         <AddressId>1QA2-1TAEXP</AddressId>

         <AddressType>Office</AddressType>

         <PrimaryBillingAddressFlag>true</PrimaryBillingAddressFlag>

         <PrimaryShippingAddressFlag>true</PrimaryShippingAddressFlag>

         </SharedAddress>

         </ListOfSharedAddress>

      </Dealer>

   </ListOfDealer>

</DealerExecute_Input>

</soap:Body>

</soap:Envelope>
Import the partner record data by using Web services calls to insert the Partner-Address record data into Oracle CRM On Demand.
This insertion associates the shared addresses with the partners. The following is a sample SOAP request for inserting the data:

<?xml version="1.0" encoding="utf-16" standalone="no"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/ XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecuritysecext- 1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Header>

<wsse:Security>

   <wsse:UsernameToken>

      <wsse:Username>%%USERNAME%%</wsse:Username>

      <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-tokenprofile- 1.0#PasswordText">%%PASSWORD%%</wsse:Password>

   </wsse:UsernameToken>

</wsse:Security>

</soap:Header>

<soap:Body>

<PartnerInsert_Input xmlns="urn:crmondemand/ws/ecbs/partner/">

   <ListOfPartner>

      <Partner>

         <Id>1QA2-1U31RC</Id>

         <ListOfSharedAddress>

         <SharedAddress>

         <AddressId>1QA2-1TAEXP</AddressId>

         <AddressType>Office</AddressType>

         <PrimaryBillingAddressFlag>true</PrimaryBillingAddressFlag>

         <PrimaryShippingAddressFlag>true</PrimaryShippingAddressFlag>

         </SharedAddress>

         </ListOfSharedAddress>

      </Partner>

   </ListOfPartner>

</PartnerInsert_Input>

</soap:Body>

</soap:Envelope>
Confirm that the data has been inserted correctly.
Set up the page layouts for the appropriate roles in your company, and assign the appropriate access to the page layouts for the user's roles.
Update your users' roles to include access to the Address record type in step 2 of the Role Management wizard.
If you do not complete this step, then users cannot view address records. For example, if they attempt to associate an address record with an account, then an error message is displayed.
Select the Enable Shared Addresses setting in the company profile to enable shared addresses.
If your company uses applications that are external to Oracle CRM On Demand to mark addresses as valid, and if you want to use only those validated addresses in address picklists, address searches, and address associations, then select the Validate Shared Addresses setting in the company profile.
NOTE: The Validation Date in an address record must be set to mark the address as validated. For more information, see Oracle CRM On Demand Online Help.
(Optional) After you have verified that the inserted data is correct, you can delete the preexisting unshared address data by using Web services calls. The following is a sample SOAP request for deleting the unshared address data:
<?xml version="1.0" encoding="utf-16" standalone="no"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/ XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecuritysecext- 1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Header>

<wsse:Security>

<wsse:UsernameToken>

<wsse:Username>%%USERNAME%%</wsse:Username>

<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-tokenprofile- 1.0#PasswordText">%%PASSWORD%%</wsse:Password>

</wsse:UsernameToken>

</wsse:Security>

</soap:Header>

<soap:Body>

<AccountExecute_Input xmlns="urn:crmondemand/ws/ecbs/account/">

   <ListOfAccount>

      <Account operation="skipnode">

         <Id>1QA2-11V4OX</Id>

         <ListOfAddress>

            <Address operation="delete">

               <Id>1QA2-11V4OZ</Id>

            </Address>

         <Address operation="delete">

            <Id>1QA2-11V4P1</Id>

         </Address>

         </ListOfAddress>

      </Account>

   </ListOfAccount>

</AccountExecute_Input>

</soap:Body>

</soap:Envelope>

Methods Called

Table 330 details the methods called by the Address service.

Table 330. Methods Called by Address Service
Method	Name as Defined in Service
Delete	SharedAddressDelete
Execute	SharedAddressExecute
Insert	SharedAddressInsert
QueryPage	SharedAddressQueryPage
Update	SharedAddressUpdate

Fields

Table 331 details the required and read-only fields for the shared address object.

Table 331. Required and Read-Only Fields for the Shared Address Object
Field Name	Type
AddressName	Required
GeocodeMatchCode	Read-only
GeocodeMatchVector	Read-only
GeocodeStatus	Read-only
Audit Fields	Read-only

Table 332 details the pick map fields for the shared address object.

Table 332. Pick Maps Fields for the Shared Address Object
Pick Map Field	Maps To
CustomObjectnName	CustomObjectnId
CustomObjectnExternalSystemId	CustomObjectnId

Table 333 details the user keys for the shared address object.

Table 333. User Keys for the Shared Address Object
Field Name
Id
ExternalSystemId
AddressName

Table 334 details the picklists available for the shared address object.

Table 334. Picklists for the Shared Address Object
Field Name
CurrencyCode

Oracle Web Services On Demand Guide, Version 25.0 (Oracle CRM On Demand Release 37)		Copyright © 2018, Oracle and/or its affiliates. All rights reserved. Legal Notices.