widgetnvp input file

Use the widgetnvp input file to set the properties of widgets that have been added to a specific layout or template, including a default layout. We must provide the property name and value.

Use this input file only to load properties that can be stored as simple name-value pairs. If the widget supports more complex data structures, like language-specific data or marketing-related data such as marketing content, then we must use a custom widget manager class to store the property values.

For more information about widget properties, see Commerce Composer widget properties.

For a sample that demonstrates how to use this input file, see Sample: Loading Commerce Composer layouts.

We can extract widget name-value pair data with the Data Extract utility to create a widgetnvp.csv file that we can load with the Data Load utility. For example, to copy or move layouts between stores or instances, such as for creating one or more test environments. The sample configuration files provided for you to use with the Data Extract utility, extract widget name-value pair data from the following database tables:

• PLWIDGETNVP

For more information about extracting Commerce Composer data, see:

• Extracting Commerce Composer data with the Data Extract utility

• Sample: Extracting Commerce Composer widgets

• Sample: Extracting Commerce Composer layouts

Definitions

LayoutUniqueID

(Integer) The internal reference number for the layout or template containing the widget, for example, 50001. Either this field or the LayoutName field (see next column) is required.

Note: The sample CSV file does not include this column; the sample demonstrates the use of the LayoutName to uniquely identify the layout or template. Maps to:

• PAGELAYOUT.PAGELAYOUT_ID

• PLWIDGET.PAGELAYOUT_ID

LayoutName

(String) The external reference name for the layout or template containing the widget, for example, SampleHomePageLayout. Either this field or the LayoutUniqueID field (see previous column) is required.

Maps to: PAGELAYOUT.NAME

UniqueID

(Integer) The internal reference number of the widget for which we are defining properties, for example, 10001. Either this field or the AdminName field (see next column) is required.

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

Maps to: PLWIDGET.PLWIDGET_ID

AdminName

(String) A name to identify this widget within this specific layout or template, for example, HeaderLeftBannerContentWidget. This name is displayed in the Commerce Composer tool to help business users understand the purpose of the widget within this specific layout. This name is defined in the layoutWidgetRelationship input file (ChildWidgetAdminName column) that was used to add widgets to the layout or template. Either this field or the UniqueID field (see previous column) is required.

Maps to: PLWIDGET.ADMINNAME

Name

(String) The name of the property to set in the widget, for example, widgetOrientation or displayPreference.

Maps to: PLWIDGETNVP.NAME

Value

(String) The value of the property to set in the widget.

Maps to: PLWIDGETNVP.VALUE

Sequence

(Decimal) The sequence in which the property is saved in relation to other properties. If the sequence does not matter, use the value 0 for all properties.

For example, if the widget had three e-Marketing Spot properties, and if we wanted them saved in a specific order, you could set each property with a different sequence number. The property with the lowest sequence number is saved first.

Maps to: PLWIDGETNVP.SEQUENCE

Delete

(String) A flag that indicates whether to delete the property setting for 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 layouts
Sample: Extracting Commerce Composer data
Commerce Composer object input file definitions