layoutAssignment input file
Use a layoutAssignment input file to assign layouts to pages and search terms.
For a sample that demonstrates how to use this input file, see Sample: Loading Commerce Composer pages.
You can extract layout assignment data with the Data Extract utility to create a layoutAssignment.csv file that you can load with the Data Load utility. For example, if you want to copy or move Commerce Composer pages between stores or instances, such as for creating one or more test environments.
Definitions
- LayoutUniqueID
- (Integer) The internal reference number for the layout that you are assigning to a page, for
example, 50001. Either this field or the LayoutName field (see next column)
is required.Maps to:
- PAGELAYOUT.PAGELAYOUT_ID
- PLLOCATION.PAGELAYOUT_ID
- LayoutName
- (String) The external reference name for the layout that you are assigning to a page, for
example, SampleHomePageLayout. Either this field or the LayoutUniqueID field
(see previous column) is required.
- PAGELAYOUT.NAME
- PageGroup
- (String) The page group that the page belongs to. For example, if you are assigning a layout to
the Tableware category page, the PageGroup value is Category. Valid PageGroup
values for the Aurora starter store are:
- Content
- Category
- Product
- Bundle
- Kit
- DynamicKit
- Search (use this value if you are assigning the layout to a search term)
Maps to: PAGELAYOUT.PAGELAYOUTTYPE_ID
- PageAdminName
- (String) The identifier of the content page to which you want to assign the layout. Fill this
column only if the PageGroup column is set to Content; otherwise leave this
column empty. The PageAdminName is defined in the Page input file that was used
to load the content page.
Maps to: PLPAGE.ADMINNAME
- Identifier
- (String) The identifier of the category, product, bundle, kit, dynamic kit, or search term to
which you want to assign the layout. If you are assigning this layout to a content page, leave this
column empty.
Source of Identifier values
If the PageGroup value is... The Identifier value is... Category The IDENTIFIER value that is defined in the CATGROUP table for the category, for example, Tableware
. In the Catalogs tool, this is the Code value for the category.ProductBundleKitDynamicKit The PARTNUMBER value that is defined in the CATENTRY table for the product, bundle, kit, or dynamic kit, for example, AuroraWMDRS-1. In the Catalogs tool, this is the Code value for the product, bundle, kit, or dynamic kit. Search The exact search term that shoppers must search for in order for this layout to be used as the search results page. Example values are: - notebook
- notebooks
- laptop
- laptops
- laptop computer
Include each search term or phrase in a separate row in this input file.
- PropagateToSubLevels
- (Boolean) Use only when assigning layouts to category pages. Indicates whether to assign the
layout only to the category page, or to the category page and its subcategory pages. Valid values:
- TRUE
- Assign the layout to the category page and its subcategory pages. Subcategory pages include all levels in the hierarchy under the current category, not just the immediate subcategories.
- FALSE
- Assign the layout only to the category page.
For example, you might want to assign a layout to the Women category page and its subcategory pages:
If so, include the following values in this input file:
Example of the PropagateToSubLevels column set to TRUE
Identifier PropagateToSubLevels Women TRUE Conversely, if you want to assign the layout only to the Woman category page, include the following values in this input file:
Example of the PropagateToSubLevels column set to FALSE
Identifier PropagateToSubLevels Women FALSE - ApplyToSubPageType
- (Boolean) Use only when assigning layouts to all product, bundle, kit, or dynamic kit pages in a
specific category. Valid values:
- Product
- Assign the layout to all product pages in the specified category.
- Bundle
- Assign the layout to all bundle pages in the specified category.
- Kit
- Assign the layout to all kit pages in the specified category.
- DynamicKit
- Assign the layout to all dynamic kit pages in the specified category.
For example, you might want to assign a layout to all the product pages in the Appliances category:
If so, include the following values in this input file:
Example of the ApplyToSubPageType column set to TRUE
Identifier ApplyToSubPageType Appliances Product - Delete
- (String) A flag indicating whether to delete the layout assignment. Specify 1 to delete the row.