Describing Dictionaries in SAP CPQ

Objectives

After completing this lesson, you will be able to:
  • Describe how SAP CPQ supports multiple languages
  • Describe the different types of dictionaries and common uses
  • Describe the logic for retrieving a dictionary for logged in user
  • Describe how entities created by admin are be translated

Dictionary

A dictionary in SAP CPQ contains a set of keys and values that are applicable on tenant level. Keys are only used in the code to reference key values that are visible in the application. The keys refer to UI content, such as button labels, tooltips, and more.

The Different Types of Dictionaries and Common Uses

The system distinguishes between two types of dictionaries:

System:

A system dictionary in SAP CPQ is available for each supported language. System dictionaries cannot be changed. No keys can be added. Keys can only be compared and exported. The names of system dictionaries appear in English and the language of the dictionary, for example Español / Spanish. These dictionaries are uploaded by default on all new tenants. If the business model does not require creating of custom key/value pairs, there's no need to manage dictionaries. The system dictionaries are managed and updated by the SAP CPQ Development team. Administrators have no authorization to change them.

Custom:

Custom dictionaries are created by administrators. Custom dictionaries are best used for overriding key values in default dictionaries. Administrators are advised not to change the existing keys or add new ones as this will require additional configuration in SAP CPQ so that the system will recognize them.

The new dictionary inherits values from the parent dictionary. The parent key/value pairs are not copied directly to the child dictionary, but they are stored in the background. To override the value of a key, copy and paste it to the child dictionary and change its value.

Custom dictionaries are created for different scenarios and support the following actions:

  • Limit visibility of the dictionary to users by applying visibility condition
  • Compare dictionaries for differences in values for the keys presented
  • Export/import dictionaries
  • The system exports dictionary values in XML format. The same format should be used for importing values

The Logic for Retrieving a Dictionary for Logged in User

SAP CPQ retrieve dictionaries for users. When users log into SAP CPQ, the system checks which dictionary is set as the default dictionary. The values from that dictionary will be used for naming buttons, tooltips, and more. Users can override the administrator's default dictionary by selecting User Page > User details > Default Dictionary by selecting a different dictionary. The system disregards the selection you made in Setup and reaches for the default dictionary. When multiple dictionaries are set as a default, the system will use rank to sort them. The dictionary with the lowest rank is retrieved first.

Translation of Entities, Created by an Admin

There are entities in SAP CPQ that you can create on your own, such as individual products and custom fields. These entities can be translated so that administrators and users from other countries can understand what they are and how they can be used.

Note

Multilanguage translations cannot be added to SAP CPQ via an API. They must be added manually.

Entities can be translated by selecting "Translate this item" from the menu to translate the following entity:

  • Products, Attributes, Categories, Guided Selling and Product Types in Product Catalog
  • Document Generation Templates, Custom Fields, Search Fields and Column Headings in Quotes
  • User Custom Fields in Users
  • Statuses, Actions, Item Actions and Approval Rules in Workflow/Approval
  • Customer Custom Fields in Customers/Customer Roles
  • Custom Actions in Develop
  • Countries/Regions and Tabs in General

Log in to track your progress & complete quizzes