registerWidgetdefdesc input file

If your Management Center implementation supports more than one language, we can load the display name and description for a widget in each additional supported language by using a registerWidgetdefdesc input file. This input file includes a subset of the columns in the registerWidgetdef input file so that the display name and description can be loaded separately. Tip: Alternatively, we can load the display name and description in multiple languages in the same registerWidgetdef input file that we use to register the widget. For an example, see Sample: Loading Commerce Composer widget descriptive information in multiple languages.

You do not need to use this input file if we are registering a widget in only the default language for a store. This language is the language specified in the business context of the environment configuration file. In that case, you need only the registerWidgetdef input file, which also contains the display name and description columns.

For a container, you do not typically need to use this input file because information about a container is not displayed in Management Center.

For a sample that demonstrates how to use this input file, see Sample: Loading Commerce Composer widget descriptive information in multiple languages.

Definitions

UniqueID

(Integer) The internal reference number for the widget definition, for example, 10001. This number is generated when you register the widget. Either this field or WidgetDefIdentifier field (see next column) is required.

Note: The sample CSV file does not include this column; the sample demonstrates the use of the WidgetDefIdentifier to uniquely identify a widget. Maps to:

• PLWIDGETDEFDESC.PLWIDGETDEF_ID

WidgetDefIdentifier

(String) The external reference name for the widget definition, for example, ContentRecommendation. This name is defined in the registerWidgetdef file. Either this field or the UniqueID field (see previous column) is required.

Maps to: PLWIDGETDEF.IDENTIFIER

LanguageId

(Integer) The language ID for the language-specific fields in this input file. If omitted, defaults to the language specified in the business context of the environment configuration file. Examples of valid values:

• -1 (for English)

• -2 (for French)

We can look up language ID values in the LANGUAGE table.

Maps to: PLWIDGETDEFDESC.LANGUAGE_ID

WidgetDisplayName

(String) The language-specific display name for the widget, for example, Content Recommendation Widget. This name is displayed in the Commerce Composer tool in Management Center to help business users identify the widget. Use the UTF-8 character set.

Maps to: PLWIDGETDEFDESC.DISPLAYNAME

WidgetDescription

The language-specific description for the widget, for example, Displays content, such as images, text, static HTML, and videos. Supports web activities.. This description is displayed in the Commerce Composer tool in Management Center to help business users identify the widget. Use the UTF-8 character set.

Maps to: PLWIDGETDEFDESC.DESCRIPTION

Delete

(String) A flag that indicates whether to delete the descriptive information about the widget. Specify 1 to delete the row.

Related concepts
Widgets for Commerce Composer
Commerce Composer widget library

Related tasks
Creating Commerce Composer widgets
Extracting Commerce Composer data with the Data Extract utility

Related reference
Commerce Composer samples
Sample: Extracting Commerce Composer data
Commerce Composer object input file definitions