1 Supported Map Types
- 1.1 World
- 1.2 Continents
- 1.3 Countries
2 Fields Definition
3 Default Filters
4 Used Advanced Configuration Fields
- 4.1 Path
- 4.2 List of Advanced Configuration Fields
- 4.3 Example
5 Used Company Parameters
- 5.1 Configuration Company Parameters
  - 5.1.1 SIP_MapHierarchyConfig
    - 5.1.1.1 Path
    - 5.1.1.2 Example
  - 5.1.2 SIP_MapCodeOverrides
    - 5.1.2.1 Path
    - 5.1.2.2 Example
  - 5.1.3 SIP_GeoOverrides
    - 5.1.3.1 Path
- 5.2 Data Company Parameters
  - 5.2.1 SIP_Population
    - 5.2.1.1 Path
    - 5.2.1.2 Example
6 Data Requirements and Deployment
7 See Also

Supported Map Types

World

World Continents

Continents

Europe
North America
Asia
Oceania
Africa
South America

Countries

All the countries listed under the Countries heading on the Map Collection page are supported with the exception of countries that have more than one map – in this case only the primary map is supported (e.g., 'Burundi' is supported but 'Burundi, admin2' is not).

For more details see How to Add a Map to Dashboard.

Fields Definition

Fields displayed on the dashboard are calculated in the using the Advanced Configuration field notation:

Field	Formula

Field	Formula
Revenue	SUM(revenue)
Margin	SUM(grossMargin)
Quantity	SUM(quantity)
Margin %	SUM(grossMargin) / SUM(revenue) * 100
Deviation WAP	(item revenue / item quantity) - (total revenue / total quantity)
Revenue per Customer	(item revenue) / (number of customers in a given area)
Margin per Customer	(item grossMargin) / (number of customers in a given area)
Revenue per X People	X * (item revenue) / (population in given area)
Margin per X People	X * (item grossMargin) / (population in given area)

By default X is set to 1000.

Default Filters

The following default filters are applied on various fields to ensure proper calculations:

Only entries with not null grossMargin are considered.
Only entries with not null invoicePrice are considered.
Only entries with not null quantity are considered.
Only entries with not null continent are considered (if applicable).
Only entries with not null country are considered (if applicable).
Only entries with not null region are considered (if applicable).

Used Advanced Configuration Fields

Path

Administration > Configuration > System Configuration > Advanced Configuration Options

List of Advanced Configuration Fields

datamartName
pricingDate
productId
customerId (optional)
continent
country
region
grossMargin
quantity
invoicePrice

Example

Name	Value

Name

Value

SIP_AdvancedConfiguration

{
   "datamartName":"Standard_Sales_Data",
   "productId":"ProductId",
   "productName":"ProductName",
   "customerId":"CustomerId",
   "customerName":"name",
   "invoicePrice":"InvoicePrice",
   "quantity":"Quantity",
   "grossMargin":"GrossMargin",
   "costs":"OtherCOGS",
   "pricingDate":"PricingDate",
   "pricingDateYear":"PricingDateYear",
   "productDimensions":[
   ],
   "customerDimensions":[
   ],
   "continent":"Region",
   "country":"Country",
   "region":"City",
   "localListPrice":"LocalListPrice",
   "globalListPrice":"GlobalListPrice",
   "netPrice":"NetPrice",
   "breakdownMode":"Standard",
   "firstDayOfWeek":"Sunday"
}

Used Company Parameters

Configuration Company Parameters

SIP_MapHierarchyConfig

This CP allows you to define which hierarchy levels are used in the dashboard. This can be useful when users do not have data for the Country level but they do for Continents. This CP table also controls which inputs will be available on the dashboard configurator.

The hierarchy of the configuration needs to be kept: World → Continent → Country → Region

So you cannot use Regions if you do not have data for Continents/Countries. Each lower hierarchy level needs to have all the higher levels enabled. This also means that in order to use the World level, you need to have the Continent data in the DM.

Path

Company Parameters > SIP_MapHierarchyConfig

Column name

Label

Is Used

Value

World
Continent
Country
Region

Yes/No

Description

Describes which hierarchy level is being configured.

These values should not be edited.

Enables or disables the given configurator entry.

Example

Hierarchy Level	Label	Is Used

Hierarchy Level	Label	Is Used
World	World	Yes
Continent	Continent	Yes
Country	Country	Yes
Region	Region	No

SIP_MapCodeOverrides

This CP allows to map Datamart data to ISO codes, if it is not already in that form. This can be useful for users who do not store regional information in the ISO code format. Additionally this CP allows you to set up custom display labels for entries. If the ”User Display Label” is not set, the default label will be used. For example, it is possible to override the default label “United States of America” to “USA”.

Keep in mind that by default the Highmaps defined values of hierarchy level names are used. If any User Display Label is defined, all entries need to have the User Display Label defined.

Path

Company Parameters > SIP_MapCodeOverrides

Column name

Hierarchy Level

ISO Code

User DM Field

User Display Label

Value

Continent
Country
Region

{ISO code of the entry on the selected hierarchy level}

For regions use the ISO 3166-2 codes

{DM field representing the entry marked with ISO Code in user data}

{custom user label for the entry to be displayed on the chart}

Description

For example: Country

For example: US or US-NY

For example: USA

Example

Hierarchy Level	ISO Code	User DM Field	User Display Label

Hierarchy Level	ISO Code	User DM Field
Continent	AS	Asia
Continent	NA	America
Continent	EU	Europe
Country	DE	Germany
Country	US	USA

SIP_GeoOverrides

This CP allows to move country entries between continents. This can be useful if e.g. users have data for a country in different continent data. For example, users use the EMEA business region which leads to Oman being included in the EU data, but since it is not on the map it cannot be displayed. Users can then set the GeoOverride for Oman to be displayed in the Asia data set.

If a country is moved to a continent it does not belong to, its data will be displayed on a the world level but not on the continent level.

Path

Company Parameters > SIP_GeoOverrides

Column name

ISO Code

Parent ISO Code

Override ISO Code

Value

{ISO code of country to be moved}

{ISO code of the continent entry for the given country}

{ISO code of the continent for the country to be moved to}

Description

For example: OM

For example: EU

For the case described above, there would also need to be EMEA → EU mapping done in SIP_MapCodeOverrides.

For example: AS

Data Company Parameters

SIP_Population

Path

Company Parameters > SIP_Population

Column name

Continent

Country

Region

Sector

Population

Values

{2 letter ISO code of a continent}

{2 letter ISO code of a country}

{ISO code of a region}

{Code of a sector}

{given entry population}

Description

The default value is "*" (= none region specified for a given continent/country combination).

Each region needs its own population specified in order to work properly.

For regions use the ISO 3166-2 codes.

The default value is “*” (= none sector specified for given continent/country/region combination)

Note: Currently no Region maps are supported as stated at the Supported Maps page, the support will be added on demand. This field is prepared for future use.

Example

Continent	Country	Region	Sector	Population

Continent	Country	Region	Sector	Population
NA	CA	*	*	37,279,811
NA	US	*	*	329,093,110

Data Requirements and Deployment

Before deploying this package, it is possible to modify some parameters of this dashboard to adapt to an existing Datamart. The following fields are used for the setup:

Field Name	Description	Required	Note

Field Name	Description	Required	Note
Datamart	Datamart used in the analysis	Yes
Product Id	Product field in the transactional data	Yes
Customer Id	Customer field in the transactional data	No
Invoice Price	Field representing revenue in the transactional data	Yes
Gross Margin	Field representing margin in the transactional data	Yes
Pricing Date	Field representing date of the transaction in the transactional data	Yes
Quantity	Field representing quantity in the transactional data	Yes
Continent	Field representing continent in the transactional data	Yes	Required to display the world map.
Country	Field representing country in the transactional data	No	Required to display the country map on a given continent.
Region	Field representing region in the transactional data	No	Required to display the region map on a given country.

Accelerators Documentation

Regional Revenue and Margin Dashboard - Configuration Details

Supported Map Types

World

Continents

Countries

Fields Definition

Default Filters

Used Advanced Configuration Fields

Path

List of Advanced Configuration Fields

Example

Used Company Parameters

Configuration Company Parameters

SIP_MapHierarchyConfig

Path

Example

SIP_MapCodeOverrides

Path

Example

SIP_GeoOverrides

Path

Data Company Parameters

SIP_Population

Path

Example

Data Requirements and Deployment

See Also