5Geographies
This chapter contains the following:
Overview of Geographies
How Geography Structure, Hierarchy, and Validation Fit Together
There are three components that are dependent on each other when defining a country: geography structure, geography hierarchy, and geography validation. Every country has to have the geography structure defined first before the hierarchy can be defined, and the geography hierarchy has to be defined before the validation can be defined.
Geography Structure
Firstly, you need to create a geography structure for each country to define which geography types are part of the country structure, and how the geography types are hierarchically related within the country structure. For example, you can create geography types called State, City, and Postal Code. Then you can rank the State geography type as the highest level within the country, the City as the second level, and the Postal Code as the lowest level within the country structure. Geography structure can be defined using the Manage Geographies task, or can be imported using tasks in the Define Geographies activity.
Geography Hierarchy
Once the geography structure is defined, the geographies for each geography type can be added to the hierarchy. For example, in the hierarchy of United States you can create a geography called California using a State geography type.
As part of managing the geography hierarchy you can view, create, edit, and delete the geographies for each geography type in the country structure. You can also add a primary and alternate name and code for each geography. A geography hierarchy can be created using the Manage Geographies task, or can be imported using tasks in the Define Geographies activity.
Geography Validation
After defining the geography hierarchy, you need to specify the geography validations for the country. You can choose which address style format you would like to use for the country, and for each selected address style format you can map geography types to address attributes. You can also select which geography types to include in geography or tax validation, and which geography types will display in a list of values during address entry in other user interfaces. The geography validation level for the country, such as error or warning, can also be selected.
Geography Structures
This topic describes geography structures and the tasks you can perform using geography structures.
A geography structure is a hierarchical grouping of geography types for a country. The following table describes the geography structure for the United States.
Level | Geography Type |
---|---|
1 |
State |
2 |
County |
3 |
City |
4 |
Postal Code |
You can use the geography structure to relate geography types for a country and define geography types for a country.
Relate Geography Types for a Country
You can determine how a country's geographies are hierarchically related by creating the hierarchy of the geography types in the geography structure. When you define a country's structure, the geography type Country is implicitly at the highest level of the geography structure with level as 1. The subsequent geography types that you add after country are numbered in sequence.
You must add a geography type as a level in the country structure before you can define a geography for that geography type in a country. For example, before defining the state of California, the State geography type must be added to the United States country structure. To quickly create country structure, you can copy a structure from another country and modify the geography types for the country.
Define Geography Types for a Country
You can use any of the master reference geography types to create your geography structure. If required, you can create a geography type, before adding it to the country structure. Each geography type is added at a lower level to the current lowest level.
You can use a geography type that you create within the country structure for other country structures as well.
Geography Hierarchy
This topic describes geography hierarchy and various aspects of geography hierarchy.
Geography hierarchy is a data model that creates conceptual parent-child relationships between geographies. At the highest level of the geography hierarchy is country, which is the parent, and the hierarchy contains several child geographies. The following table shows sample parent-child relationships in a geography.
California | Parent of San Mateo county |
---|---|
San Mateo County |
Parent of Redwood City |
Redwood City |
Parent of 94065 |
94065 |
Child |
When you enter just 94065, the application determines that the postal code is in California and the corresponding city is Redwood City.
The application uses geography hierarchy information to facilitate business processes that rely on geography information, such as, tax calculation, order sourcing rules, and sales territory definition. The geography hierarchy information is centrally located and shared among other application offerings.
The geography hierarchy includes:
-
Geography: Geography is a physical space with boundaries that's a defined instance of a geography type, such as country, state, province or city. For example, San Jose is a geography of the City geography type.
-
Geography type: Geography types are divisional grouping of user defined geographies, for example, Continent, Country Regions, and Tax Regions.
-
Geography usage: Geography usage indicates how a geography type or geography is used in the application.
-
Master reference geography hierarchy: The geography hierarchy data is considered the single source of reference for all geography related data such as geography types and geographies.
The geography usage for the entire hierarchy is the master reference, and defined geography types and geographies are the master reference geography types and geographies. For example, you can create geography types called State, City, and Postal Code. Then, you can rank the State as the highest level, City as the second level, and Postal Code as the lowest level within the country structure.
-
User defined zones: User defined zones are a collection of geographical data, created from master reference data for a specific purpose. For example, while the territory zones are collections of master reference geographies ordered with a hierarchy, the tax and shipping zones are without a hierarchical grouping.
Geography Validation
Geography validation determines the geography mapping and validation for a country's address styles, as well as the overall geography validation control for a country.
The No Styles Format address style format is the default address style format for a country. By defining the mapping and validation for this format you will ensure that validations can be performed for any address in the country. After the No Styles Format is defined you can set up additional mapping for specific address styles.
For each address style format, you can define the following:
-
Map to attribute
-
Enable list of values
-
Tax validation
-
Geography validation
-
Geography validation control
Attribute Mapping
For every address style format, you can map each geography type to an address attribute. For example, you can map the State geography type to the State address attribute for the United States, or map the State geography type to the County address attribute for the United Kingdom. The geography types that appear are based on how the country structure is defined. The list of address attributes that appear are based on address formats delivered with the application, or your customer defined address formats.
Enable List of Values
Once a geography type is mapped to an attribute, then you can specify whether the geography type will appear in a list of values during address entry in user interfaces. It is very important to review carefully if you want to enable a list of values. You should only enable a list of values if you have sufficient geography data imported or created for that geography. If the setup for master geography data is incomplete, then the geography data is either not imported or created. As a result, the list of values for the address attribute doesn't list any geography data.
Once you have enabled a list of values for an address attribute, you can only select the geography data available for the geography type. This means that if a specific geography value isn't available in the geography hierarchy, you can't create an address with a different geography value.
Tax Validation
You can also specify whether a geography type will be included in tax validation. For example, for the United States North America address style format you specify that County, State, and City are used for tax validation. This will mean that when a transaction involves an address with the North America address style, the address must have the correct county, state, and city combination based on the geography hierarchy data, to be considered valid for tax calculation.
Geography Validation
You must set up geography validation for those geography elements that you plan to use in your sales territories. Setting up validation also helps users fill in missing address information, and validate addresses during entry. For example, you can have users select states or other address elements from lists to ensure accuracy during entry, and you can have the application fill in missing values. For example, when the user enters a Postal Code, the application can retrieve the city and state.
You can specify whether a geography type will be included in geography validation. For example, when the user enters a United States address using the North America address style format, the address must have the correct country, state, and postal code combination based on geography hierarchy data to be considered geographically valid.
If an address element is mapped to a geography type, but not selected for geography validation usage, then during address entry suggested values are provided for the address element, but the address element isn't be validated.
You need to verify that the default mapping between Geography Type and Map to Attribute is valid in the Geography Mapping and Validation region and update it if required when you define geography validation. Oracle recommends that you use the following valid mapping for the countries that GBG | Loqate supports:
Country Name | Country Code | Geography Type | Map to Attribute |
---|---|---|---|
Andorra |
AD |
|
|
Angola |
AO |
|
|
Argentina |
AR |
|
|
Australia |
AU |
|
|
Austria |
AT |
|
|
Belgium |
BE |
|
|
Bolivia |
BO |
|
|
Bosnia and Herzegovina |
BA |
|
|
Brazil |
BR |
|
|
Bulgaria |
BG |
|
|
Canada |
CA |
|
|
Cayman Islands |
KY |
|
|
Chile |
CL |
|
|
China |
CN |
|
|
Croatia |
HR |
|
|
Cuba |
CU |
|
|
Cyprus |
CY |
|
|
Czech Republic |
CZ |
|
|
Denmark |
DK |
|
|
Dominican Republic |
DO |
|
|
Ecuador |
EC |
|
|
Estonia |
EE |
|
|
Finland |
FI |
|
|
France |
FR |
|
|
Germany |
DE |
|
|
Great Britain |
GB |
|
|
Greece |
GR |
|
|
Guadalupe |
GP |
|
|
Guam |
GU |
|
|
Guernsey |
GG |
|
|
Hungary |
HU |
|
|
Iceland |
IS |
|
|
India |
IN |
|
|
Indonesia |
ID |
|
|
Ireland |
IE |
|
|
Isles of Man |
IM |
|
|
Israel |
IL |
|
|
Italy |
IT |
|
|
Jamaica |
JM |
|
|
Japan |
JP |
|
|
Jordan |
JO |
|
|
Kenya |
KE |
|
|
Latvia |
LV |
|
|
Liechtenstein |
LI |
|
|
Lithuania |
LT |
|
|
Luxembourg |
LU |
|
|
Malaysia |
MY |
|
|
Malta |
MT |
|
|
Martinique |
MQ |
|
|
Mexico |
MX |
|
|
Netherlands |
NL |
|
|
New Zealand |
NZ |
|
|
Norway |
NO |
|
|
Oman |
OM |
|
|
Peru |
PE |
|
|
Poland |
PL |
|
|
Portugal |
PT |
|
|
Puerto Rico |
PR |
|
|
Qatar |
QA |
|
|
Reunion Island |
RE |
|
|
Romania |
RO |
|
|
Russia |
RU |
|
|
San Marino |
SM |
|
|
Singapore |
SG |
|
|
Slovakia |
SK |
|
|
Slovenia |
SI |
|
|
South Africa |
ZA |
|
|
South Korea |
KR |
|
|
Spain |
ES |
|
|
Sri Lanka |
LK |
|
|
Swaziland |
SZ |
|
|
Sweden |
SE |
|
|
Switzerland |
CH |
|
|
Taiwan |
TW |
|
|
Thailand |
TH |
|
|
Tunisia |
TN |
|
|
Turkey |
TR |
|
|
United Arab Emirates |
AE |
|
|
United States |
US |
|
|
Uruguay |
UY |
|
|
Vatican City |
VA |
|
|
Vietnam |
VN |
|
|
Geography Validation Control
You can select the geography validation level for a country. Validation will check if the entered address maps to the geography hierarchy data available for the country, and the geography validation control determines whether you can save an address that didn't pass validation during address entry. For example, if the validation level is Error, then an address can't be saved if the values don't match the geography hierarchy data.
These are the geography validation levels you can choose:
-
Error - only completely valid addresses can be saved, with all mandatory address elements entered.
-
No Validation - all addresses can be saved including incomplete and invalid addresses.
Regardless of the result of validation, the validation process will try to map any address attribute to a geography of the country, and store any mapping it could establish based on the available data. This is called Geography Name Referencing and it's executed as part of validation. The result of this referencing is used in several business processes in the application to map an address to a specific geography or zone.
The Geography Dimension value in territories is derived from sell-to addresses of sales accounts. To use geography dimensions in territories, you must validate the geography elements in the addresses, such as state, city, and postal code. You can validate the address by enabling geography validation for each country using the Manage Geographies task. Perform the following in the Manage Geographies task:
-
Enable at least one level in the geography hierarchy for geography validation.
-
Enable geography validation for all geography levels that you intend to use for territory definition for each country.
-
If needed, enable a list of values containing specific geography elements. This will help users search and select appropriate geography values during addresses entry and eliminate all possibilities of wrong address entry.
You can set geography validation control to Error in the Manage Geography Validation page. This ensures that users can only use valid geography elements in addresses.
Manage Geography Structures, Hierarchies, and Validation
This example shows how you can configure the geography structure, hierarchy, and validation for a country geography, using the United Kingdom country geography as an illustration.
The following table summarizes the key decisions for this scenario.
Decisions to Consider | In This Example |
---|---|
Copy an existing country structure? |
No, create a new country structure. |
What is the structure of the geography types? |
Create geography types with the following ranking structure:
|
What is the geography hierarchy? |
Create the following hierarchy:
|
Which address style format will you use when mapping geography validations? |
The default address style format called the No Styles Format. |
Are you using Oracle Fusion Tax for tax purposes? |
No, don't select Tax Validation for the geography types. |
Define the Geography Structure
You can add the County and Post Town geography types to the United Kingdom geography structure.
-
On the Manage Geographies page, enter GB in the Code field. Click Search.
-
On the Manage Geographies page, click Structure Defined.
-
On the Manage Geography Structure page, click the Create button next to the Copy Country Structure From field.
-
In the Geography Structure section, select the County list item in the Add Geography Type field.
-
Click Add.
-
Select the Post Town list item in the Add Geography Type field.
-
Click Add.
Define the Geography Hierarchy
You can add the geographies for the County and Post Town geography types using the geography hierarchy user interfaces to create the geography hierarchy for United Kingdom. You can also use the Manage File Import Activities task to import geography hierarchies using a CSV or XML file.
-
On the Manage Geographies page, enter GB in the Code field. Click Search.
-
On the Manage Geographies page, click Hierarchy Defined.
Note: If there are many child geographies for the selected parent geography, a message asking you to refine the search criteria is displayed. The child geographies are displayed after you refine the search criteria. If there are many search results, you may have to further refine the search criteria. -
In the Geography Hierarchy section, click United Kingdom to highlight the table row, and click Create.
-
In the Create County page, Primary and Alternate Names section, enter Berkshire in the Name field.
-
Click Save and Close.
-
In the Geography Hierarchy section, click Berkshire to highlight the table row, and click Create.
-
In the Create Post Town page, Primary and Alternate Names section, enter Reading in the Name field.
-
Click Save and Close.
Define the Geography Validations
You can define the geography mapping and validation for the United Kingdom default address style format to specify the geography validations for the geography types you added to United Kingdom. You can then map the geography types to attributes, enable the geography types for Lists of Values and Geography Validation, and set the geography validation level.
-
On the Manage Geographies page, click Validation Defined.
-
In the Address Style section, click No Styles Format to highlight the table row.
-
For the County geography type, click the County list item in the Map to Attribute field.
-
Select the Enable List of Values and Geography Validation options.
-
For the Post Town geography type, click the City list item in the Map to Attribute field.
-
Select the Geography Validation option.
-
In the Geography Validation Control section, select Error in the Geography Validation Level for Country list.
-
Click Save and Close.
Manage Territory Geography Splits
You must group territory geographies into group zones to manage territory geography level splits. Grouping the territory geographies involves two steps, selecting the geography level based on which you need grouping and initiating the grouping.
Select the Geography Level for Grouping
You can perform these steps to select the geography level based on which you want to create the group zones:
-
Sign in as a set up user such as Application Implementation Consultant.
-
In the Setup and Maintenance work area, go to the following:
-
Offering: Customer Data Management
-
Functional Area: Enterprise Profile
-
Task: Manage Geographies
-
-
Search for the country for which you want to enable territory geography level grouping.
-
Click Structure Defined. Manage Geography Structure page appears.
-
Select the Subject to Grouping check box corresponding to the geography type level for which you want to enable grouping.
You must select the geography level that suits your business requirements. For example, if your product delivery is based on postal code, and your territory geographies don't have higher levels of master geographies such as counties and cities, then you may have postal code splits. In this case you must select postal code as the geography type level for grouping.
Note: You can enable grouping for only one level at a time. -
Click Save and Close.
Initiate Grouping
Here are the steps to initiate grouping:
-
In the Setup and Maintenance work area, go to the following:
-
Offering: Sales
-
Functional Area: Territories
-
Task: Manage Territory Geographies
The Manage Territory Geographies page opens.
-
-
Click Initiate Grouping.
-
Click OK in response to the warning message and confirm the process.
Note: You can't automatically un-group the grouped territory geographies. You can manually undo the grouping process by recreating territory geography hierarchy either through the UI or import process.The geography level that you selected for grouping appears as an expandable Group Zone when the grouping is complete is shown in the following figure.
-
Click Save and Close.
How Territory Geographies are Grouped
This topic describes how we can overcome the problem of territory geography splits by grouping them into group zones.
You do a territory geography grouping when any of your territory geography levels has multiple splits. A territory geography splits occur when the lower level master geographies are added to territory geography hierarchy, while skipping the higher level master geographies. This may cause multiple occurrences of the lower geography level members in a territory geography hierarchy.
For example, postal code split happens when a postal code overlaps across many master geography levels such as cities and counties. Suppose that the business firm Vision Corp. delivers its product according to the postal codes. If counties and cities aren't included in the territory geography hierarchy of Vision Corp., then the end user can see the multiple occurrences of the postal code 97229.
When there is a territory geography level split, and if you want to group the split geographies, first you must specify the master geography level for which you want the grouping to be performed, then initiate grouping. When grouping is performed, all the splits of the selected master geography level get grouped under a new group zone. In the previous example, if you select postal code in the master geographies as the level for grouping and initiate the grouping process, then the 12 postal code splits for the postal code 97229 gets grouped together under one group zone named 97229. So, the Territory Manager user can define territories on a clean list of postal codes or their ranges, although some of those postal codes would in fact be the groupings of the postal code splits. The grouped splits are hidden for the Territory Manager user.
Best Practices for Managing Geography Mismatches
This topic employs a couple of use cases to illustrate the best practices for setting up Master Reference Geographies for sales customers using the Oracle Social Data and Insight Cloud Service for data enrichment and the Address Verification Cloud Service for address verification.
When you perform the real-time enrichment of accounts or contacts using the Oracle Social Data and Insight Cloud Service, if there's a geography data mismatch between the predefined master geography data and the Dun and Bradstreet (D&B) data, then the Service enriches the accounts and contacts data but you can't edit or save the enriched data unless the master geography data mismatches are resolved. In addition, you can verify the enriched address using the Address Verification Cloud Service, however, in case of mismatches between Address Verification Cloud Service (GBG | Loqate) and predefined master geography data you can't save the verified address.
The second use case describes the setup required to enable address verification and to avoid data conflicts between the Address Verification Cloud Service and master reference geography data.
Use Case 1
You're a sales customer using master reference geographies for territory assignments or tax calculation and have purchased Oracle Social Data and Insight Cloud Service for data enrichment as well as the Address Verification Cloud Service. In this case, while the GBG | Loqate geography reference data is configured as master geography, Tax calculation is being done using Vertex master geography data. Also, address validation is enabled based on the customer's requirement.
Best Practice: Review geography mapping for the countries where you do business. If the geography mapping for a specific country isn't mapped according to the country-specific address attributes, update the mapping. Oracle recommends performing enrichment before verifying address.
Suppose that you're doing real time enrichment of account or contact. If there's a geography data mismatch between the predefined master geography and the D&B data, the Oracle Social Data and Insight Cloud Service still enriches the accounts and contacts data but can't edit or save the enriched account or contact unless the master geography data mismatches are resolved. However, you can verify the enriched address using the address verification cloud service.
To save a verified address that has master geography data mismatch, you must add alternative names for the mismatched hierarchy elements in master geography. The following are the steps to add alternative name for the mismatched hierarchy element:
-
In the Setup and Maintenance work area, go to the following:
-
Offering: Customer Data Management
-
Functional Area: Enterprise Profile
-
Task: Manage Geographies
-
-
On the Manage Geographies page, search for the country by the name or country code, for example US.
-
Click the Go to Task button in the Hierarchy Defined column. The Manage Geographies Hierarchy page for the particular country appears.
Note: If there are many child geographies for the selected parent geography, a message asking you to refine the search criteria is displayed. The child geographies are displayed after you refine the search criteria. If there are many search results, you may have to further refine the search criteria. -
Highlight the mismatched hierarchy element, for example California State, and click the Edit icon.
-
Click the Add icon on the Edit page.
-
Add an alternative name CA for the California state geography element.
-
Click Save and Close
Once the alternative name is added for the mismatched hierarchy element in master geography, you can save the enriched address.
Use Case 2
You're a sales customer who doesn't use geographies for territory assignment or tax calculation and has purchased Oracle Social Data and Insight Cloud Service for data enrichment and the Address Verification Cloud Service for address verification. To enable address verification and to avoid data conflicts between the Address Verification Cloud Service and master reference geography data you must do the following setups:
-
Deselect the Enable List of Values option in the Geography Mapping and Validation region to avoid Address Verification Cloud Service data conflicts with master reference geography data. By deselecting this option you can avoid any UI level validation against master geographies while adding address.
-
Select Geography Validation Level for Country as No validation to verify address data by Address Verification Cloud Service.
Perform the following steps on the Manage Geography Validation page to enable address verification and to avoid data conflicts between the Address Verification Cloud Service and master reference geography data:
-
In the Setup and Maintenance work area, go to the following:
-
Offering: Customer Data Management
-
Functional Area: Enterprise Profile
-
Task: Manage Geographies
-
-
On the Manage Geographies page, search for the country by the name or country code, for example US.
-
Click the Go to Task button in the Validation Defined column. The Manage Geography Validation page appears.
-
Deselect the Enable List of Values check boxes for all the geography attributes to avoid any UI level validation against master geographies while entering the addresses. If the Enable List of Values check boxes are selected then, in case of data conflicts, Geography Naming References records aren't created.
If you're planning to create territories based on a particular Geography Type, such as County, then you must deselect all the Geography Validation levels under that Geography Type (in this case City and Postal Code) based on which you want to create the territory.
Import Geographies and Zones
How You Import Geographies
A geography, such as Tokyo or Peru, describes a boundary on the surface of the earth. You can create new geographies by importing data through interface tables. There are two options for populating the interface tables: using the tool of your preference to load the data or using file-based data import. If you plan to provide the data details in a source file, use the file-based import feature. If you will populate the interface table directly, run the geography loader process to import the data. Having a good understanding of the import entity, interface table, and destination table will help you prepare your import data.
Consider the following when importing geographies:
-
Oracle-licensed geography reference data
-
File-based import option
-
Geography loader process option
-
Import object entity, interface table, and destination tables
Oracle-Licensed Geography Reference Data
Oracle Applications Cloud includes third-party master geography data for multiple countries that can be imported. You can import Oracle-licensed data from GBG | Loqate, for those countries where the data is available, such as the U.S. You can import geography data using the Manage Geographies task. Search for the country, and select Import Geography Data from the Actions menu. If the licensed data isn't available or already set up for a particular country, then the Import Geography Data action is disabled.
File-Based Import Option
The file-based import process reads the data included in your XML or text file, populates the interface tables, and imports the data into the application destination tables.
To access the File-Based Data Import functionality, in the Setup and Maintenance work area, go to the following:
-
Offering: Customer Data Management
-
Functional Area: Enterprise Profile
-
Task: Manage Import Activities
For more information, see the Importing Geographies chapter in the Oracle CX Understanding File-Based Data Import and Export for CX Sales and Service guide.
Geography Loader Process Option
Populate the interface table with your import data, then to schedule the import of data from the interface table to the destination table, in the Setup and Maintenance work area, use the following:
-
Offering: Customer Data Management
-
Functional Area: Enterprise Profile
-
Task: Run Geography Loader
Import Object Entity, Interface Table, and Destination Tables
The geography import object consists of one entity and interface table that forms the geography. If you're using file-based import, you can map your source file data to import entity attributes that correspond to the interface table columns. The import activity process populates the interface table based on the mapping and your source file. If using the geography loader scheduled process, populate the interface table directly using your preferred tool.
If you need the unique IDs of existing application data for your import data, then, in the Setup and Maintenance work area, use the following to export the information:
-
Offering: Customer Data Management
-
Functional Area: Trading Community Foundation
-
Task: Schedule Export Processes
The following table lists the object entity, the interface table, the destination tables, and the resulting application object.
File-Based Import Entities | Interface Tables | Destination Tables | Application Object |
---|---|---|---|
ImpGeography |
HZ_IMP_GEOGRAPHIES_T |
HZ_GEOGRAPHIES HZ_GEOGRAPHY_IDENTIFIERS HZ_GEOGRAPHY_TYPES_B HZ_HIERARCHY_NODES |
Geography |
List of Available Countries with GBG | Loqate Geography Reference Data
Oracle Applications Cloud provides third-party GBG | Loqate geography data for import. Here's the list of countries for which the GBG | Loqate geography data is available for import.
Country Name | Country Code |
---|---|
Andorra |
AD |
Angola |
AO |
Argentina |
AR |
Australia |
AU |
Austria |
AT |
Belgium |
BE |
Bolivia |
BO |
Bosnia and Herzegovina |
BA |
Brazil |
BR |
Bulgaria |
BG |
Canada |
CA |
Cayman Islands |
KY |
Chile |
CL |
China |
CN |
Croatia |
HR |
Cuba |
CU |
Cyprus |
CY |
Czech Republic |
CZ |
Denmark |
DK |
Dominican Republic |
DO |
Ecuador |
EC |
Estonia |
EE |
Finland |
FI |
France |
FR |
Germany |
DE |
Great Britain |
GB |
Greece |
GR |
Guadalupe |
GP |
Guam |
GU |
Guernsey |
GG |
Hungary |
HU |
Iceland |
IS |
India |
IN |
Indonesia |
ID |
Ireland |
IE |
Isles of Man |
IM |
Israel |
IL |
Italy |
IT |
Jamaica |
JM |
Japan |
JP |
Jordan |
JO |
Kenya |
KE |
Latvia |
LV |
Liechtenstein |
LI |
Lithuania |
LT |
Luxembourg |
LU |
Malaysia |
MY |
Malta |
MT |
Martinique |
MQ |
Mexico |
MX |
Netherlands |
NL |
New Zealand |
NZ |
Norway |
NO |
Oman |
OM |
Peru |
PE |
Poland |
PL |
Portugal |
PT |
Puerto Rico |
PR |
Qatar |
QA |
Reunion Island |
RE |
Romania |
RO |
Russia |
RU |
San Marino |
SM |
Singapore |
SG |
Slovakia |
SK |
Slovenia |
SI |
South Africa |
ZA |
South Korea |
KR |
Spain |
ES |
Sri Lanka |
LK |
Swaziland |
SZ |
Sweden |
SE |
Switzerland |
CH |
Taiwan |
TW |
Thailand |
TH |
Tunisia |
TN |
Turkey |
TR |
United Arab Emirates |
AE |
United States |
US |
Uruguay |
UY |
Vatican City |
VA |
Vietnam |
VN |
Replace Existing Master Geography Data with Revised Oracle-Licensed Geography Data
You must import and set up reference geography data for the countries where you do business. Using the Oracle-licensed geography reference data, you no longer have to source geography data from a third party. You can import Oracle-licensed data from GBG | Loqate, including the country structure and hierarchy information, either to create a new geography setup or replace your existing geography data.
You can use the information in this section to replace existing geography data with GBG | Loqate geography data. You can follow these steps if you're using Nokia or any other geography data and now want to move to GBG | Loqate geography data.
Before you begin, perform the following steps:
-
Backup existing geography data including customizations, if any.
-
Backup territory geographies.
-
Perform impact analysis by contacting the support team to identify the use of geography IDs downstream.
Create an Export File of All Territories
In case you have implemented Customer Data Management along with the sales functionality, you must export all territories before deleting the master geography data because removing the master geography data invalidates the territory definitions that are based on the Geography dimension. You can either export the definitions of all territories to a file or make manual corrections. If there are a large number of territories, export the territories definition to a file for the territories import process. However, if there are very few affected territories, then you can choose to either export the territories definition to a file or make corrections manually.
This procedure is applicable only if there are territories defined using the Geography dimension.
Perform the following steps to create an export file of all territories.
-
From the Territories and Quotas work area, click View Active Territories in the Tasks pane.
-
In the View Active Territories page, select the territory at the highest level.
-
Click the Actions list, and select Export, and then Export Selected Territory Hierarchy.
-
In the Warning dialog box, click OK.
-
Click the Actions list and select Export, and then View Export Status.
-
Review the status of the export job and verify if it has completed successfully.
-
In the Exported Data File column, click the .zip file against your export job, and click Save. All the territories are exported to a compressed file on your system.
-
Click OK.
-
Click Done in the View Active Territories page.
Delete the Territory Geography Data
A territory definition has references to the territory geography data and master geography data. Territory geography data is based on the master geography data, in case you have implemented Customer Data Management along with the sales functionality, you must delete the territory geography data prior to deleting the master geography data. When you delete the territory geography data, all territories that are defined using geography dimension become invalid.
This procedure is applicable only if territory geographies are defined.
Perform the following steps to delete the territory geography data.
-
In the Setup and Maintenance work area, go to the following:
-
Offering: Sales
-
Functional Area: Territories
-
Task: Manage Territory Geographies
-
-
On the Manage Territory Geographies page, click View All Hierarchies.
-
Select the highest level node for the country for which you want to replace the master geography data and click the Delete icon.
-
In the Warning dialog box, click OK.
-
In the Confirmation dialog box, click OK. The parent node of the territory geography data and its children are deleted.
-
Repeat steps 3 to 5 to delete all the higher nodes in the territory geography data.
-
Click Save and Close.
The Territory Management application retains a copy of the dimension members referenced in the territory definitions. This copy is updated when you trigger the Load and Activate process from the Enable Dimensions and Metrics task. Therefore, although the territory geography data is deleted, the territory definitions may appear to remain valid.
Delete the Master Geography Data
Delete the existing geography data one country at a time. Use the Delete Master Geography Data for the Selected Country scheduled process to delete master geography data. We recommend that you raise a service request for assistance in deleting the geography data. For more information about the Delete Master Geography Data for the Selected Country scheduled process, see the related topics section.
Delete Geography Structure
If you have created a geography structure, it prevents the geography imports from working or working as desired. For example, if the geography structure exists, the Import Geography option may not be enabled for a country in Manage Geographies even if GBG | Loqate predefined geography data is available for that country and the geography hierarchy doesn't exist yet.
If the geography structure was created manually, you can follow these steps to delete it. However, we recommend that you raise a service request for assistance in deleting the geography structure.
-
In the Setup and Maintenance work are, go to the following:
-
Offering: Customer Data Management
-
Functional Area: Enterprise Profile
-
Task: Manage Geographies
-
-
On the Manage Geographies page, enter either the country name or the two-letter ISO code (for example, US), and click Search.
-
Select the country in the search results and click Actions > Manage Geography Structure.
-
In the Manage Geography Structure page, delete each level of the structure.
-
Click Save and Close.
You can now proceed to importing geography data.
Import Oracle-Licensed Geography Reference Data
Use this procedure to import GBG | Loqate geography data in Manage Geographies one country at a time. If the country data you want isn't supported by GBG | Loqate geo seed data and point the GBG | Loqate supported country list here, then the Import Geography Data action is disabled.
The geography data is provided by GBG | Loqate and is third-party content. As per Oracle policy, this software and documentation may provide access to or information about content and services from third parties. Oracle and its affiliates aren't responsible for and expressly disclaim all warranties of any kind with respect to third-party content and services. Oracle and its affiliates aren't responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.
Perform the following steps to import Oracle-licensed geography reference data.
-
In the Setup and Maintenance work area, go to the following:
-
Offering: Customer Data Management
-
Functional Area: Enterprise Profile
-
Task: Manage Geographies
-
-
On the Manage Geographies page, enter either the country name or the two-letter ISO code (for example, US), and click Search.
-
Select the country in the search results.
-
Click the Actions list, and select Import Geography Data.
-
In the Warning dialog box, click OK.
-
In the Confirmation dialog box, click OK.
The import of larger countries may require several hours to complete.
You can track the progress of the import process by selecting Scheduled Processes from the Navigator.
After the import is complete, you can search for the country again in the Manage Geographies page. Check marks now appear in the Structure Defined and Hierarchy Defined columns indicating the import completed successfully.
Next, click the Validation Defined icon to define the validations, enable List of Values, and choose address style format for a country as set up before. For more information, see the Geography Validation topic.
The Geocoding Defined and Address Cleansing Defined columns are used for additional features which you must license from Oracle and set up separately.
-
Geocoding makes it possible to display customers in the vicinity of a mobile address. You set up Geocoding Enabled for those countries where you're using Around Me functionality in CX Sales Cloud Mobile.
-
Cleansing makes it possible to validate addresses down to the street level.
Add any geography customizations.
Run the Geography Name Referencing Process
The Geography Name Referencing (GNR) process validates address elements in location tables, such as HZ_LOCATIONS, against the master geography data.
Perform the following steps to run the GNR process.
-
Navigate to Tools > Scheduled Processes work area.
-
On the Overview page, click Actions > Schedule New Process.
-
Click the Name list and search for Validate Geographies Against Master Geographies, and then click OK.
-
Click OK in the Schedule New Process dialog box.
-
In the Process Details dialog box, enter the following details:
-
Location Table Name: HZ_LOCATIONS
-
Run Type: ALL
-
Usage Code: GEOGRAPHY
-
-
Enter the country code in the Country Code field.
-
Click Submit.
-
In the Confirmation dialog box, click OK.
-
Click Close.
-
In the Scheduled Processes page, click the Refresh icon.
-
Verify if the status of the process has completed successfully.
Find the locations failing in Geography Name References using: https://cloudcustomerconnect.oracle.com/posts/b1e16b06ae. Fix Geography Name References failures by updating addresses with the latest geography data.
Recreate and Load the Territory Geography Data
In case you have implemented Customer Data Management along with the sales functionality, you can recreate the territory geography data, after the master geography data is imported, using either of the following methods:
-
Import process: If you created the original territory geography data using the import process, then use the same import file to recreate the territory geography structure. For more information about importing the territory geography data using the import file, see Importing Territory Geography Hierarchies Using File-Based Data Import: Quick Start in the Oracle CX Understanding File-Based Data Import and Export for CX Sales and B2B Service guide.
-
Manual creation process: You can manually recreate the territory geography data structures, as they existed before their deletion, using the Manage Territory Geographies task. For more information about creating zones and adding geographies to a zone, see Managing Territory Geographies in the Related Topics section.
After you have recreated the territory geography data, perform the following steps to load the data.
-
In the Setup and Maintenance work area, go to the following:
-
Offering: Sales
-
Functional Area: Territories
-
Task: Enable Dimensions and Metrics
-
-
On the Enable Dimensions and Metrics page, click the Actions list, and select Load and Activate. The process loads the territory geography data to make dimension members available for selection when defining territories.
-
In the Confirmation dialog box, click OK.
-
Click Done.
Restore the Invalid Territory Definitions
After recreating the territory geography hierarchies and running the Load and Activate option from the Enable Dimensions and Metrics task, the geography dimensions are populated with the new geography members. The geography members in the territory appear as invalid because your territories still reference the old copies of the dimension members that were deleted. The new members aren't referenced automatically by the territories. You must re-reference the territory definitions from the old geography dimension members to the new ones.
You can restore the invalid territory definitions by either importing the previously created export file or making manual corrections to the territories.
To restore valid territory definitions using territories import:
-
Open the export file you saved in the Creating an Export File of All Territories step. The compressed file contains four CSV files.
-
Open TERR_HEADER.CSV file.
-
Enter REPLACE in the Action column for all territories that are based on geography dimension.
-
Save the file in CSV format and compress it together with three other CSV files.
-
From the Territories and Quotas work area, click View Active Territories in the Tasks pane.
-
Click the Actions list, and select Import to Proposal, and then Import Territories.
-
Select the newly created compressed file and click OK.
-
Click the Actions list and select Import to Proposal, and then View Import Status.
-
Review the status of the export job and verify if it has completed successfully.
-
Click OK.
-
From the Tasks pane, click Manage Territory Proposals.
-
In the Manage Territory Proposals page, on the Current Territory Proposals table, search for the proposal with your import file name.
-
Click the import file name to open the territory proposal.
-
Click Edit Coverage to verify that the territory definitions are valid.
-
Verify that there are no values listed as invalid in the Selected Dimension Members section.
-
Click Save and Close.
-
Click Activate. The territory proposal of your import file is activated.
To restore valid territory definitions through manual corrections:
-
From the Territories and Quotas work area, click Manage Territory Proposals in the Tasks pane.
-
In the Manage Territory Proposals page, click the Create icon.
-
In the Create Territory Proposals dialog box, enter a name and click Save and View.
-
In the Territory Proposals page, add all the territories with the Geography dimension value other than the value Any to the proposal.
-
Select a territory and click Edit Coverage.
-
In the Edit Coverage page, select Geography from the Dimensions list. The invalid dimension members are displayed in the Selected Dimension Members pane.
-
Expand the values in the Available Dimension Members section or search for the member that has the same name as the one marked invalid in the Selected Dimension Members pane.
-
Select one or more new geography dimension members from Available Dimension Members pane and click Add icon to the Selected Dimension Members pane.
-
Click the Remove icon to remove the invalid members from the Selected Dimension Members pane.
-
Click Save and Close.
-
Repeat steps 4 to 10 for all territories that were based on Geography dimension.
-
Click Activate. After the activation process is complete, your territory definitions are valid again and are referencing to the new geography data.
Although this method is always applicable, it's most appropriate when you have to restore territory definitions for a smaller number of territories.
To run the batch assignment process for opportunities:
-
From Navigator, click Scheduled Processes.
-
In the Schedule Processes page, click Schedule New Process.
-
In the Schedule New Process dialog box, search for the Request Revenue Territory Assignment process and select it.
-
Click OK.
-
In the Process Details dialog box, enter OpenOpportunitiesByCreationDate in the View Criteria Name field. This selects all revenue lines belonging to open opportunities that were created in the last 'X' days.
-
Enter BindOptyCreationDateFrom= followed by the date.
For example, if BindOptyCreationDateFrom=2014-01-01, then all open opportunities which were created between 1st January 2014 till the current date, are processed.
-
Click Submit to schedule the process.
-
In the Confirmation dialog box, make a note of the process identifier for monitoring the process, and click OK.
-
Click Close.
-
In the Schedule Processes page, click the Refresh icon.
-
Review the status of the process job and verify if it has completed successfully.
Note: Review a small subset of the open opportunities to confirm that the territory assignment is as expected.
To run the batch assignment process for sales accounts:
-
Ensure that the ZCA_SA_AUTO_ASSIGN_ON_CREATE and ZCA_SA_AUTO_ASSIGN_ON_UPDATE profile options are set to Yes in the Manage Customer Center Profile Options task.
-
From Navigator, click Customers.
-
In the Customers page, click Create Account.
-
In the Create Account page, enter a name and address of the sales account, and select the Address is sell to check box.
-
Click Save and Close.
-
From Navigator, click Customers.
-
In the Search pane, search for the name of the sales account you created and select it.
-
In the section Customer Information, select Sales Account Team. The details of the sales account and territories associated with the sales account are displayed.
This indicates that the sales account was created successfully and the batch assignment was run automatically to assign the matching territories to the sales account.
To run the batch assignment process manually from the Scheduled Processes page, perform the following steps.
-
From Navigator, click Scheduled Processes.
-
In the Schedule Processes page, click Schedule New Process.
-
In the Schedule New Process dialog box, search for the Request Account Assignment process and select it.
-
Click OK.
-
Enter SalesAccount_Work_Object in the Work Object Code field and SalesAccountTerritory_Candidate_Object in the Candidate Object Code field.
-
Select Territory in the Assignment Mode list.
-
Enter AllSalesAccountsVC in the View Criteria Name field. This selects all sales accounts.
-
Click Submit to schedule the process.
-
In the Confirmation dialog box, make a note of the process identifier for monitoring the process, and click OK.
-
Click Close.
-
In the Schedule Processes page, click the Refresh icon.
-
Review the status of the process job and verify if it has completed successfully.
Note: Review a small subset of the accounts to confirm that the territory assignment is as expected.
Verify that the downstream applications using geography data is working fine.
How to Import Nokia Geography Data
We recommend that you use GBG | Loqate geography data. However, if you need to use Nokia data for one or more countries for business reasons you can do so.
By default, Import Geography Data task invokes GBG | Loqate geography data.
Perform these steps to import Nokia geography data:
-
Set the profile value of the ORA_HZ_ENABLE_DAAS_LOQATE profile option to No in the Setup and Maintenance work area by going to the following:
-
Offering: Sales
-
Functional Area: Sales Foundation
-
Task: Manage Administrator Profile Values
-
-
Import the Nokia geography data for a country as follows:
-
Navigate to the Manage Geographies task in the Setup and Maintenance work area by going to the following:
-
Offering: Sales
-
Functional Area: Sales Foundation
-
Task: Manage Geographies
-
-
On the Actions menu, Click Import Geography Data for a country.
Note: The Import Geography Data action is disabled for a country if the geography data for that country isn't available from GBG | Loqate or if the country data is already imported using either GBG | Loqate, Nokia, or any third party geography data.After the geography data is loaded, the data provider name (GBG | Loqate or Nokia) is displayed in the Hierarchy Defined section in Manage Geographies.
-
Create Countries
This procedure lists the steps to create countries in the application.
The countries are seeded in the application. If you're unable to find a specific country in the Manage Geographies page, then you can add it to the application.
For countries where GBG | Loqate geography data isn't available, you can purchase the geography data from a third-party data provider and load it into the application using File-Based Data Import. For more information, see the Importing Geographies chapter in the Oracle CX Understanding File-Based Data Import and Export for CX Sales and Service guide.
If countries aren't available in the application, then use the procedure outlined in this topic to create them.
Perform the following steps to create a new country.
-
In the Setup and Maintenance work area, go to the following:
-
Offering: Customer Data Management
-
Functional Area: Application Extensions
-
Task: Manage Territories
-
-
On the Manage Territories page, click the New icon.
-
Enter the following details:
-
Territory Code: Enter a unique code for the territory.
-
Territory Name: Enter a unique name for the territory.
-
Description: Enter a description for the territory.
-
-
Click Save and Close.
Note: After you have added a new country in the application, if you want to import the geography data for that country, then you must perform Step 5 to 10. -
In the Setup and Maintenance work area, go to the following:
-
Offering: Customer Data Management
-
Functional Area: Enterprise Profile
-
Task: Manage Geographies
-
-
On the Manage Geographies page, click Actions > Create Country.
-
In the Create Country dialog box, select the name of the country and click Save.
-
Click Done.
How Geography Import Objects Work Together
You use the Geography import object to import geographies and objects related to the geography. This topic describes the Geography import object and introduces:
-
Target import objects
-
Target import object attributes
-
Target import object attribute reference guide files used for evaluating and mapping source file data
Overview of Geography Target Import Objects
Use the Geography import object to import geographies and objects related to geographies. The Geography import object is split into smaller objects to organize the individual attributes of the geography.
The target import objects in the Geography import object contain information about the geography hierarchy. When updating an existing geography, you must provide the parent reference information of the existing geography.
Use the ImpGeography target import object to create and update geography information.
Geography Target Import Object Attributes
Compare attributes that you want to import with the available target object attributes and their valid values. Use a reference file to evaluate your source data and Sales and B2B Service attributes for mapping and validation. See the File-Based Data Import for CX Sales and B2B Service guide (https://docs.oracle.com/en/cloud/saas/sales/20a/oefbs/index.html). See the topic for your import object, which includes links to reference files for target import objects. A reference guide file includes:
-
Attribute descriptions
-
Default values
-
Validations for the attributes
Review the validation for each attribute to know if you need to do any setup tasks.
Define and Manage Import Mappings
You must define a mapping between your source data and a combination of the target object and target object attributes to import your source file data. To define and manage import mappings, do one of these:
-
Navigate to the following in the Setup and Maintenance work area:
-
Offering: Sales
-
Functional Area: Data Import and Export
-
Task: Manage File Import Mappings
-
-
Define the mapping when you define the import activity. Navigate to the following in the Setup and Maintenance work area:
-
Offering: Sales
-
Functional Area: Data Import and Export
-
Task: Manage File Import Activities
-
Reference Files for Geography Target Import Objects
To access reference files for this object's target import objects, see the File-Based Data Import for CX Sales and B2B Service guide (https://docs.oracle.com/en/cloud/saas/sales/20a/oefbs/index.html). See the topic for your import object, which includes links to reference files for target import objects.
Here is a list of reference files and their target import objects.
Target Import Object | Description | Attribute Reference File Names |
---|---|---|
ImpGeography |
Contains information that saves a country's geography hierarchy details, such as geography type, geography code, and so on. |
HZ_IMP_GEOGRAPHIES_T _Reference |
Overview of Geography Import
A geography is any region with a boundary around it. It might be a state, a country, a city, a county, or a ward. You must create or import geographies before you can associate them with company-specific zones and addresses.
You can import geography data from an external data source into CX Sales and B2B Service using the File-Based Data Import feature.
Consider the following questions when importing your data:
-
How does your legacy or source system store and represent the geography information when compared to CX Sales and B2B Service?
-
Do you have to configure values in CX Sales and B2B Service to map your existing data to the Geography import object?
-
Do you have to extend CX Sales and B2B Service to add attributes?
-
What import features are available to import your business data?
-
How do I verify my imported data?
How Business Objects are Structured
You must understand how your geography data corresponds with the data in CX Sales and B2B Service to map your legacy data to the data in CX Sales and B2B Service.
You must import a separate country structure import object for each country. Each of these import objects must contain the geography types that are used in the country's structure, organized in a hierarchy using geography level numbers. For example, if you're importing the country structure of Australia, the country structure might be:
-
Country
-
State
-
County
-
Town
-
ZIP
How Business Objects are Structured
Every import object is a collection of attributes that help to map your data to the Oracle Applications Cloud data and to support one-to-many relationships between the structural components of a geography.
You must know the attribute details of the import objects so that you can prepare your import data. You can use the import reference guide (File-Based Data Import for CXSales and B2B Service) files that contain:
-
Attribute descriptions
-
Values that populate attributes by default when you don't provide values
-
Validation information for each attribute
The validation information includes the navigation path to the task where you can define values in Oracle Application Cloud. For example, if you have values in your data that correlate to a choice list in Oracle Application Cloud, then the validation information provides the task name where you can define your values. For additional information, such as a list of reference guide file names and locations, see the topic How Geography Import Objects Work Together.
Configurable Attributes
Here is how you can configure the objects to import your legacy or source data:
-
Use the Application Composer to design your object model extensions and to generate the required artifacts to register your extensions.
-
Make the artifacts available for importing the object.
You can map these configurable attributes to your source file data. You can use the same source file to import both the configurable attributes and the standard import object attributes.
How You Import Geographies Using File-Based Data Import
You must first prepare a source data file to import geographies. The source file can be either an XML file or a text file, such as a CSV files.
You use the file import process to:
-
Read the data in your source file.
-
Populate the interface tables according to your mapping.
-
Import the data into the application destination tables.
The Define File Import Setup and Maintenance task list includes the tasks required to:
-
Configure the import objects
-
Create source-file mappings
-
Schedule the import activities
You can also access these tasks from the Data Import and Export functional area of the Sales offering.
You submit file import activities for each import object. When you're creating a new geography, you use the Geography object to import your data. You must have the Master Data Management Administrator job role to access and submit the import activities for geographies.
When importing geography information, you must provide the parent reference information for all parent levels for the entity.
How You Verify Your Imported Data
You can use the File Import activity reports to verify imported data. Alternatively, you can also navigate to the Geographies work area to view the geography information that you have imported.
Example of Importing Geographies
This example demonstrates how to import data using the File-Based Data Import tool. In this example, you have a source file containing geography data that you want to import into the application to make the geography data available for real time address validation and tax purposes.
The following table summarizes the key decisions that you must make in this scenario.
Decisions to Consider | In This Example |
---|---|
What type of object are you importing? |
Geography |
What file type are you using for your source data? |
Text file |
Where are you uploading your source data file from? |
Your desktop |
What data type is your source data file? |
Comma separated |
Which fields are you importing into the application? |
All, except for the RecordTypeCode field |
When do you want to process the import? |
Immediately |
Summary of the Tasks
You perform the following steps to create an import activity and activate the import:
-
Determining what information is in the source file.
-
Creating and scheduling the import activity.
-
Monitoring the import results.
Before You Start
-
Ensure that the combination of the Source ID and Parent Source ID values is unique for each row of data within a single import. However, your source data files don't need to have the same Source ID and Parent Source ID values as your previously imported geography data. If the geography structure levels and the parents for each geography value are the same, then the changed IDs will not affect the import.
-
Ensure that all the parents of a child geography are included in your data file so that the child geography can be added. For example, if you originally imported US, CA, and San Francisco, and now you want to import the city of San Jose in CA, then your data file must include US, CA, and San Jose.
-
Check that your source data file has the correct values for the geography data that you have already loaded. For example, if your initial import included the value US for country and CA as state, and in a subsequent import you have California as a state, then your geography import creates two state records (CA and California) in the application data, with the US as the country parent.
Determine What Information Is in the Source File
-
The source geography data files must include a unique Source ID value for each row of data and Parent Source ID value for the parent of that row of data. The Source or Parent Source IDs should not be longer than 18 characters.
-
You can structure your geography source data, as shown in the following table.
Geography Level Name Source ID Parent Source ID 1 (Country)
US
1
NA
2 (State)
CA
11
1
3 (County)
Alameda
111
11
4 (City)
Pleasanton
1111
111
4 (City)
Dublin
1112
111
Create and Schedule the Import Activity
You can create an import activity, enter the import details, and schedule the import. An import activity includes selecting the source file or file location, mapping the source file to the database, and scheduling the import.
-
Navigate to the following in the Setup and Maintenance work area:
-
Offering: Sales
-
Functional Area: Data Import and Export
-
Task: Manage File Import Activities
-
-
In the Manage Import Activities page, click Create.
-
In the Create Import Activity: Map Fields page, map each field from your source file to the target object and attribute, as shown in the following table.
Field Value Name
Master Reference Geographies
Object
Geography
File Type
Text File
File Selection
Specific file
Upload From
Desktop
File Name
Choose relevant file from desktop
Data Type
Comma separated
Note: Ensure that the file type that you select in the Create Import Activity: Set Up page matches the file type of the source data file. -
Click Next.
-
In the Create Import Activity: Map Fields page, map each field from your source file to the database object and attribute, as shown in the following table.
Column Header Example Value Ignore Object Attribute Primary Geography Name
Primary Geography Name
United States
Imp Geography
Primary Geography Name
Country Code
US
No
Imp Geography
Country Code
Record Type Code
0
Yes
Imp Geography
Record Type Code
Source ID
10265
No
Imp Geography
Source ID
Parent Source ID
1053
No
Imp Geography
Parent Source ID
If you don't want to import a column in the text file, then you can select Ignore.
Note: If you can't map the fields from your source file to the relevant target object, then see the import object spreadsheets. -
Click Next.
-
In the Create Import Activity: Create Schedule page, select Immediate in the Schedule field so that the import will start as soon as you activate it.
Instead of immediately importing the data, you can choose a date and time to start the import. You can also specify whether the import will be repeated and the frequency of the repeated import.
-
Click Next.
Monitor the Import Results
You can monitor the processing of the import activity and view the completion reports for both successful records and errors.
-
In the Create Import Activity: Review and Activate page, verify your import details in the Import Details, File Details, Import Options, and Schedule sections. Update the import details if required by navigating to the previous screens using the Back link.
-
Confirm your import details, and click Activate to submit the import.
After the import activity has finished, the Status field value changes to Completed.
Overview of Country Structure Import
You can import country structure data from an external data source into Sales and B2B Service using the File-Based Data Import feature. A country structure is a hierarchical grouping of geography types for a country. For example, the geography structure for United States has the geography type of State at the topmost level, followed by the County, the City, and the Postal Code.
You can use the country structure to store information about:
-
The relationships between geographies within a country
-
The types of geographies for a country
Consider the following questions when importing your data:
-
How does your legacy or source system store and represent the country structure information when compared to Sales and B2B Service?
-
Do you have to configure values in Sales and B2B Service to map your existing data to the Country Structure import object?
-
Do you have to extend Sales and B2B Service to add attributes?
-
What import features are available to import your business data?
-
How do I verify my imported data?
How Business Objects Are Structured
You must understand how your country structure data corresponds with the data in Sales and B2B Service to map your legacy data to the data in Sales and B2B Service.
You must import a separate country structure import object for each country. Each of these import objects must contain the geography types that are used in the country's structure, organized in a hierarchy using geography level numbers. For example, if you're importing the country structure of Australia, you need to follow this country structure:
-
Country
-
State
-
County
-
Town
-
ZIP
Import Object for the Country Structure
The import object for country structures is GeoStructureLevel.
How Business Object Attributes are Structured
Every import object is a collection of attributes that help to map your data to the Oracle Applications Cloud data and to support one-to-many relationships between the structural components of a country structure.
You must know the attribute details of the import objects so that you can prepare your import data. You can use the import reference guide (File-Based Data Import for CX Sales and B2B Service) files that contain:
-
Attribute descriptions
-
Values that populate attributes by default when you don't provide values
-
Validation information for each attribute
The validation information includes the navigation path to the task where you can define values in Oracle Application Cloud. For example, if you have values in your data that correlate to a choice list in Oracle Application Cloud, then the validation information provides the task name where you can define your values. For additional information, such as a list of reference guide file names and locations, see the topic How Country Structure Import Objects Work Together.
Configurable Attributes
Here is how you can configure the objects to import your legacy or source data:
-
Use the Application Composer to design your object model extensions and to generate the required artifacts to register your extensions.
-
Make the artifacts available for importing the object.
You can map these configurable attributes to your source file data. You can use the same source file to import both the configurable attributes and the standard import object attributes.
How You Import Country Structures Using File-Based Data Import
You must first prepare a source data file to import accounts. The source file can be either an XML file or a text file, such as a CSV files.
You use the file import process to:
-
Read the data in your source file.
-
Populate the interface tables according to your mapping.
-
Import the data into the application destination tables.
The Define File Import Setup and Maintenance task list includes the tasks required to:
-
Configure the import objects
-
Create source-file mappings
-
Schedule the import activities
You can also access these tasks from the Data Import and Export functional area of the Sales offering.
You must have the Master Data Management Administrator job role to access and submit the import activities for country structures.
How You Verify Your Imported Data
You can use the File Import activity reports to verify imported data. Alternatively, you can also navigate to the Country Structure work area to view the country structure information that you have imported.
How Country Structure Import Objects Work Together
You use the Country Structure import object to import country structures and objects related to the country structure. This topic describes the Country Structure import object and introduces:
-
Target objects
-
Target import object attributes
-
Target import object attribute reference guide files used for evaluating and mapping source file data
Overview of Country Structure Target Import Objects
Use the Country Structure import object to import country structures and objects related to country structures. The Country Structure import object is split into smaller objects to organize the individual attributes of the country structure. The target import objects in the Country Structure import object are grouped into information about the country structure and information about the other objects.
When updating an existing country structure, you must provide the parent reference information of the existing country structure. This reference information connects the imported geography structure to the existing one. Use the ImpGeoStructureLevel target import object to create and update country structure information.
Country Structure Target Import Object Attributes
Compare attributes that you want to import with the available target object attributes and their valid values. Use a reference file to evaluate your source data and attributes for mapping and validation. See the File-Based Data Import for CX Sales and B2B Service guide (https://docs.oracle.com/en/cloud/saas/sales/20a/oefbs/index.html). See the topic for your import object, which includes links to reference files for target import objects. A reference guide file includes:
-
Attribute descriptions
-
Default values
-
Validations for the attributes
Review the validation for each attribute to know if you need to do any setup tasks.
Define and Manage Import Mappings
You must define a mapping between your source data and a combination of the target object and target object attributes to import your source file data. To define and manage import mappings, do one of these:
-
Predefine the mappings in the Setup and Maintenance work area:
-
Offering: Sales
-
Functional Area: Data Import and Export
-
Task: Manage File Import Mappings
-
-
Define the mapping when creating an import activity in the Setup and Maintenance work area:
-
Offering: Sales
-
Functional Area: Data Import and Export
-
Task: Manage File Import Activities
-
Reference Files for Country Structure Target Import Objects
To access reference files for this object's target import objects, see the File-Based Data Import for CX Sales and B2B Service guide (https://docs.oracle.com/en/cloud/saas/sales/20a/oefbs/index.html). See the topic for your import object, which includes links to reference files for target import objects.
For detailed information about importing geographies using file-based import, refer to Document No. 1481758.1, Importing Master Reference Geography Data, on the Oracle Support site.
Here is a list of reference files and their target import objects.
Target Import Object | Description | Reference Guide File Name |
---|---|---|
ImpGeoStructureLevel |
Information that specifies a country's geography structure. |
HZ_IMP_GEO_STRUCTURE _LEVELS_Reference |
How You Import and Export Territory Geography Zones
Territory geography zones are geographical boundaries that you can set up to replicate your organization's regions, such as a Pacific Northwest sales region. You can set up territory geography zones in one application instance, and then after the territory geography zones are defined you can export the territory zones and import them into another application instance.
To define your territory geography zones and then import your territory zones into another application instance, you must complete the following steps:
-
Import the master reference geography data into the application.
-
Define your territory geography zones using the Manage Territory Geographies task.
-
Export the territory geography zones.
-
Import the territory geography zones into another application instance.
Import the Master Reference Geography Data
Firstly, you must import the master reference geography data. Master reference geography data includes geography elements, such as country, state, and city, and is required for any geographical information that you store in the application, such as address information used in customer and sales records. For more information, see the topic Geography Hierarchy: Explained. Master reference geography data can be imported into the application using the Manage File Import Activities task in Setup and Maintenance.
Define Your Territory Geography Zones
After the master reference geography data has been imported, you can then create your territory geography zones in the application using the Manage Territory Geographies task in Setup and Maintenance. For more information, see the Manage Territory Geographies topic in the Related Topics section.
Export the Territory Geography Zones
After you have completed importing the master reference geography data and defining your territory geography zone tasks, you can create a configuration package to export the territory zone data. For more information, refer to the Exporting Setup Data demo listed in the related topics section.
Import the Territory Geography Zones
After you have downloaded your configuration package for your territory geography zone setup, you can import the territory zones into another application instance.
Set Up Geocoding
Geocoding
This topic explains geocoding and how to enable this option in the application.
Geocoding is the process of finding latitude and longitude coordinates from geographic data such as street addresses or postal codes. Once these coordinates are available, you can use the spatial services feature to identify points of interest, such as customer and contact addresses, in the vicinity. The application integrates the Geocoding feature with eLocation (http://elocation.oracle.com/maps_oracle_dot_com_main.html), which is a Geocoding service provided by Oracle.
By default, the Geocoding option is turned off in the application. You can enable the Geocoding option by going to the Setup and Maintenance work area and performing the following:
-
Offering: Customer Data Management
-
Functional Area: Enterprise Profile
-
Task: Manage Geographies
If the Geocoding feature is enabled, the feature can be scheduled to run at regular time intervals. This ensures that newly created or updated locations are picked up and geocoded whenever you create or update an address using the user interface, web services, bulk import, or file-based import.
Set Up Geocoding
This procedure lists the steps to set up geocoding in Oracle Cloud applications.
Geocoding is a process that determines the latitude and longitude coordinates for a location. By default, geocoding is turned off in the application. You can use geocoding to display customers in the vicinity of a mobile address.
Enable Geocoding for a Country
To enable geocoding for a country, complete these steps:
-
In the Setup and Maintenance work area, go to the following:
-
Offering: Customer Data Management
-
Functional Area: Enterprise Profile
-
Task: Manage Geographies
-
-
On the Manage Geographies page, search for the country for which you want to enable geocoding. You can either search by the country name or country code.
-
Click Search. The search results for the matching country names are displayed.
-
Select the country for which you want to enable the geocoding option.
-
Select Geocoding Defined for the country.
Populate Location Latitude and Longitude Information
Once geocoding is enabled, you can schedule this feature to run at regular time intervals so that newly created or updated locations are picked up and geocoded. To schedule the geocoding feature to run at regular intervals, complete these steps:
-
Navigate to Tools > Scheduled Processes work area.
-
On the Overview page, click Actions > Schedule New Process.
-
Click the Name list and search for Populate Location Latitude and Longitude Information, and then click OK.
-
Enter the parameters such as Start Date and End Date, and click Submit.
Use Web Services to Populate Location Attributes for the Around Me Feature
Use this procedure to populate location attributes using Web services for the Around Me feature in countries that aren't supported by the eLocation service. The Around Me feature enables you to quickly locate information about your surroundings. This feature uses your current location to run a proximity search on objects with location information, such as contacts, opportunities, and customers.
Create an Address with the Location Attributes Using the LocationService Web Service
Perform the following steps to create an address with location attributes, such as latitude and longitude, using the createLocation operation.
-
Extract the Web Services URL
-
Sign in to the Oracle Enterprise Manager Applications Control using the WebLogic Server credentials.
-
Select Oracle Fusion Customer Relationship Management from the navigation tree, and then select
Fusion Applications.
-
From the tree, select CrmCommonApp, and then select
CrmCommonApp (CRMCommonServer_1)
. -
In the Web Services pane, click Test for the LocationServiceSoapHttpPort port.
-
In the Test Web Service pane, copy the URL of a WSDL that appears in the WSDL field until "?wsdl", and then paste to a notepad.
-
-
Derive the Payload
-
Launch the WSDL URL in a Web browser to open the LocationService endpoint page.
-
In the LocationServiceSoapHttpPort pane, select createLocation from the Operation list.
-
In the Location pane, complete the fields, as shown in the following table.
Field Value Country
CN
Address1
Chaoyang District
City
Shanghai
Postal Code
200233
State
China
CreatedByModule
AMS
Latitude
20.36789
Longitude
-39.34444
Note: Deselect all the other parameters in this Location pane. Also, deselect LocationProfile, OriginalSystemReference, and LocationInformation options. -
Click the XML Source option.
Note: This option appears next to the Operation list. -
Copy the XML source and paste to a notepad.
-
-
Call the Web Service
-
Open the Oracle Fusion Service Tester page.
-
In the WebService URL field, paste the WSDL URL that you derived from Step 5 of the Extracting the Web Services URL section.
-
Enter the user name and password credentials.
-
In the Payload pane, paste the XML source that you derived from Step 5 of the Deriving the Payload section.
-
Click
Invoke
. The Output Payload pane displays the output payload.
-
-
Test the Web Service
-
Sign in to the Oracle Fusion Applications Home Page.
-
Navigate to the Customer Center work area.
-
Search the address that you added.
-
Click the Addresses section.
-
From the Actions list, select the View Geography Information option.
-
Verify the latitude and longitude details.
-
Update the Location Attributes of an Address Using the LocationService Web Service
Perform the following steps to update the location attributes of an address, such as latitude and longitude, using the updateLocation operation.
-
Extract the Web Services URL
-
Sign in to the Oracle Enterprise Manager Applications Control using the WebLogic Server credentials.
-
Select Oracle Fusion Customer Relationship Management from the navigation tree, and then select Oracle Fusion Applications.
-
From the tree, select CrmCommonApp, and then select
CrmCommonApp (CRMCommonServer_1)
-
In the Web Services pane, click Test for the LocationServiceSoapHttpPort port.
-
In the Test Web Service pane, copy the URL of a WSDL that appears in the WSDL field until "?wsdl", and then paste to a notepad.
-
-
Derive the Payload
-
Launch the WSDL URL in a Web browser to open the LocationService endpoint page.
-
In the LocationServiceSoapHttpPort pane, select updateLocation from the Operation list.
-
In the Location pane, complete the fields, as shown in the following table.
Field Value LocationId
300100078489616
Note: Enter the location ID that was generated in Step 1 of the Testing the Results section.Latitude
30.36789
Longitude
-40.34444
Note: Deselect all the other parameters in this Location pane. Also, deselect LocationProfile, OriginalSystemReference, and LocationInformation options. -
Click the XML Source option.
Note: This option appears next to the Operation list. -
Copy the XML source and paste to a notepad.
-
-
Call the Web Service
-
Open the Oracle Fusion Service Tester page.
-
In the WebService URL field, paste the WSDL URL that you derived from Step 5 of the Extracting the Web Services URL section.
-
Enter the user name and password credentials.
-
In the Payload pane, paste the XML source that you derived from Step 5 of the Deriving the Payload section.
-
Click
Invoke
. The Output Payload pane displays the output payload.
-
-
Test the Web Service
-
Sign in to the Oracle Fusion Applications Home Page.
-
Navigate to the Customer Center work area.
-
Search the address that you updated.
-
Click the Addresses section.
-
From the Actions list, select the View Geography Information option.
-
Verify the latitude and longitude details.
-
How You Set up Address Cleansing
Address cleansing validates, corrects, and standardizes address information that you enter in the application. Address cleansing, unlike geography validation, validates both the geography attributes and the address line attributes.
To use the address cleansing functionality, you need to have license for the customer data quality application, because the feature is delivered using data quality integration.
You can specify the real-time address cleansing level for each country by choosing either of these options:
-
None: Specifies no real time address cleansing.
-
Optional: Provides option to cleanse addresses.
Once you have enabled address cleansing for a country, a Verify Address icon appears at address entry points in the application. Click the icon to perform address cleansing and receive a corrected, standardized address. If the application doesn't find a matching address, then an alert message is displayed.
FAQs for GBG | Loqate Support
How many countries does GBG | Loqate support?
GBG | Loqate supports 82 countries. Any additional country support beyond the 82 must be logged as an enhancement request. To log the enhancement request, go to Idea Lab.
Will I be charged for GBG | Loqate data?
There's no charge or licensing requirement for GBG | Loqate geography data.
I am an existing customer, how will I be impacted? Can I import both GBG | Loqate and Nokia geography data?
No. You can import either GBG | Loqate or Nokia geography data, but you can't import from both providers for a single country. We recommend that you use GBG | Loqate geography data because GBG | Loqate supports 82 countries including existing 62 Nokia supported countries.
If you're already using Nokia geography data, you can select one of these two options:
-
Option 1: You need not do anything and continue to use Nokia geography data. Oracle doesn't support any Nokia geography data fixes.
-
Option 2: You can replace Nokia geography data with GBG | Loqate geography data. This is a manual process today. You must follow manual steps and work closely with the support team to import new GBG | Loqate geography data. For more information about this process, see Replace Existing Master Geography Data with Revised Oracle-Licensed Geography Data section in this chapter.
How often are updates to Oracle licensed geography reference data available? How will I be informed about new countries that are supported by Oracle-licensed geography reference data?
The geography data is updated on a quarterly basis but the update of the latest geography data refresh isn't automated. You will be informed about the geography data refresh using release readiness documents.
How is the Geography Data updated? Are updates available for all countries at the same time or only some countries are updated at a time?
When you import the geography data for a country after Release 18C for the first time you would get the latest GBG | Loqate geography data. But if your GBG | Loqate geography data is more than three months old, you have to uptake the latest GBG | Loqate geography data by following Replace Existing Master Geography Data with Revised Oracle-Licensed Geography Data section in this chapter.
Can I import Vertex or other third-party geography data in Manage Geographies?
Yes, you can continue to import geography data of your choice. Oracle provides support for GBG | Loqate geography data out of the box.
Can I import geography data for multiple countries in one import job?
No. You can submit only one import job for a country. After submitting the import job, you can search for a different country and submit another import job for that country. Currently, you can only search and import GBG | Loqate data for one country at a time using the Manage Geographies task in Setup and Maintenance menu.
FAQs for Define Geographies
When do I define address cleansing?
When address data entered into the application must conform to a particular format, to achieve consistency in the representation of addresses. For example, making sure that the incoming data is stored following the correct postal address format.
Why can't I update a geography structure by copying an existing country structure?
You can only update a geography structure by adding existing geography types, or by creating new geography types and then adding them to the geography structure. You can only copy an existing country structure when you're defining a new country structure.
How many levels in a geography structure can I define?
We recommend that you add up to six levels, starting with country at level 1, while defining geography structures. If you add more than six levels containing list of values or validations, then the sixth level and above may not work as expected in the Address UI of accounts, contacts, suppliers, persons, and so on.
Why can't I delete a level of the country geography structure?
If a geography exists for a country geography structure level then you can't delete the level. For example, if a state geography has been created for the United States country geography structure, then the State level can't be deleted in the country geography structure.
Can I add any geography to the geography hierarchy?
Yes. However, the geography type for the geography that you want to add must be already added to the country geography structure.
Can I edit a specific geography in the geography hierarchy?
Yes. In the Manage Geography Hierarchy page you can edit details such as the geography's date range, primary and alternate names and codes, and parent geographies.
Can I add alternative names and codes for an existing country?
Yes. You can add alternative names and codes. Click Actions > Add on the Edit Country page.
How can I add a geography that's at a lower level to any geography in a geography hierarchy?
Select the geography that you want to create a geography at lower level, and then click the Create icon. This lets you create a geography for a geography type that's one level lower to the geography type you selected. The structure of the country's geography types are defined in the Manage Geography Structure page.
How can I verify whether the third-party geography structure and hierarchy I imported are available in the application?
You can track the progress of the geography structure and hierarchy import process by navigating to the Scheduled Processes page and viewing the status of the third-party geography data import process. Once the process completes, the status changes to Succeeded. You can then verify the newly imported geography structure and hierarchy in the Setup and Maintenance work area by navigating to the following: offering: Customer Data Management; functional area: Enterprise Profile; task: Manage Geographies, where you first loaded the third-party geography data.
How can I enable geocoding?
You can enable geocoding for a country by turning the Geocoding option for that country in the Setup and Maintenance work area by going to the following: offering: Customer Data Management; functional area: Enterprise Profile; task: Manage Geographies. Search for the country for which you want to enable geocoding and click the Geocoding Defined icon. If geocoding is enabled for a country, the Geocoding Defined icon displays a check mark.
Once you have enabled geocoding for a country, you must run the Run Geocode Generation ESS job on the Run Geocode Generation task. Before you run the job, however, ensure that you have specified the country code of the country for which you want to generate the geocodes.
Where can I view the geocode values of a location?
You can search for and view the geocode values of a party's location in the Party Center and the Customer Center pages. Navigate to the Addresses section of the party's profile and click either View, Columns, Latitude and View, Columns, Longitude, or View, Columns, Manage Columns, Latitude and Longitude. This displays the latitude and longitude, or geocode values, associated with the location of the party.
What are Spatial Services?
Spatial services allow users to find points of interest such as customers, contacts, and so on using the latitude and longitude coordinates of an address.
The Oracle Fusion Mobile Sales application provides these services for sales representatives to discover accounts and contacts around their location.
Where can I update and view the geography name reference information for parties?
To view the geography name reference information associated with parties, you need to ensure that you have created an address for the party. You can create or update party addresses in the Organizations, Persons, and Groups work areas.
Once you have updated an address, you must either wait for the Run Geocode Generation ESS job to run automatically as scheduled or start geocode generation manually from the Setup and Maintenance work area by navigating as follows: offering: Customer Data Management; functional area: Enterprise Profile; task: Run Geocode Generation.
Once the Run Geocode Generation job has updated the geography information for the country associated with the party you updated, you can search for and view the geography name reference information associated with the party in the Organizations, Persons, and Groups work areas. Navigate to the person, organization, or group whose address you want to verify and click Actions, View Geography Information. This displays a dialog box that displays the updated geography information, complete with address values enhanced using geography name reference.
How can I save an address that didn't pass geography validation?
Search and select for the country name in the Manage Geographies page, and then click the Validation Defined option. In the Manage Geography Validation page, select No Validation in the Geography Validation Level for Country drop-down list. This option saves addresses that don't pass the geography validation, including incomplete and invalid addresses.