layout input file
Use a layout input file to load layouts and default layouts into a store so that they can be used in the Commerce Composer tool. This input file loads only the empty layout.
To fill the layout with a container
and configured widgets, you must also use:
- layoutWidgetRelationship input file
- widgetnvp input file
For samples that demonstrate how to use this input file
in different load scenarios, see:
You can extract layout and default layout data with the Data Extract utility to create a
layout.csv file that you can load with the Data Load utility. For example, if you want to
copy or move layouts between stores or instances, such as for creating one or more test
environments.
Note: You must apply the interim fixes for APAR JR53438.fep and
APAR JR53438.fp to add support to the Data Extract utility for extracting Commerce Composer data.
The sample configuration files that are provided for you to use with the Data Extract utility, extract widget registration data
from the following database tables:For more information about extracting Commerce Composer data, see:
Definitions
- LayoutUniqueID
- (Integer) The internal reference number for the layout, for example, 50001.
The LayoutUniqueID is automatically generated when you load the layout.
In Delete mode, 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.
Maps to: PAGELAYOUT.PAGELAYOUT_ID
- LayoutName
- (String) The external reference name of the layout, for example, SampleHomePageLayout.
This name is displayed in the Commerce Composer tool to help business
users identify the layout. You can use any name. In Insert or Replace
mode, this field cannot be null and the name must be unique. In Delete
mode, either this field or the LayoutUniqueID field (see previous
column) is required.
Maps to: PAGELAYOUT.NAME
- PageGroup
- (String) If the layout is a default layout: the page group that
the default layout is for. Valid values for the Aurora starter store
are:
- Content
- Category
- Product
- Bundle
- Kit
- DynamicKit
- Search
If the layout is not a default layout, leave this column empty.
Maps to: PAGELAYOUT.PAGELAYOUTTYPE_ID
- TemplateName
- (String) The external reference name of the template that this
layout is based on, for example, Sample home page.
Maps to: PAGELAYOUT.NAME
- Description
- (String) The administrative description of the layout, for example, The
layout for the home page.
Maps to: PAGELAYOUT.DESCRIPTION
- DeviceClass
- (String) The type of device that the layout is designed for. Valid
values are:
- Web
- Designed for pages that are viewed on desktop, notebook, and tablet computers.
- Mobile
- Designed for pages that are viewed on mobile devices.
- Any
- Designed for pages that can be viewed on any device because the layout is responsive.
Maps to: PAGELAYOUT.DEVICETYPE
- State
- (Integer) The state of the layout. Valid values are:
- 0
- Inactive; do not make this layout available in the Commerce Composer tool.
- 1
- Active; make this layout available in the Commerce Composer tool.
- 2
- Mark for delete. To clean up layouts that are marked for deletion from the database, you must schedule the CleanPageLayoutsCmdImpl command. For more information, see Remove marked for delete Commerce Composer layouts.
Maps to: PAGELAYOUT.STATE
- IsTemplate
- (String) A flag indicating whether you are loading a template.
Set this value to FALSE.
Maps to: PAGELAYOUT.ISTEMPLATE
- IsDefault
- (String) A flag indicating whether you are loading a default
layout.
- TRUE
- This is a default layout.
- FALSE
- This is not a default layout.
Maps to: PAGELAYOUT.ISDEFAULT
- StartDate
- (Timestamp) The start date for the assignment of this layout to
a page or search term to take effect. If you do not specify a start
date, the layout is assigned immediately. The default timestamp format
is:
yyyy-MM-dd hh:mm:ss.nnnnnnExample: 2014-01-01 00:00:00.0Use the 24-hour clock.Maps to: PAGELAYOUT.STARTDATE
- EndDate
- (Timestamp) The end date for the assignment of this layout to
a page or search term. If you do not specify an end date, the layout
is assigned indefinitely. The default timestamp format is:
yyyy-MM-dd hh:mm:ss.nnnnnnExample: 2014-01-01 00:00:00.0Use the 24-hour clock.Maps to: PAGELAYOUT.ENDDATE
- Priority
- (Integer) The priority of this layout in relation to other layouts.
Assign a priority by entering a number between zero (lowest priority)
and one thousand (highest priority). If more than one layout is assigned
to or inherited by a page for a given time period, the layout with
the highest priority is applied on the storefront.
Maps to: PAGELAYOUT.PRIORITY
- Delete
- (String) A flag indicating whether to delete the row for this
layout from the database. Specify 1 to delete the row. Tip: Instead of using this column to delete a layout, consider scheduling the CleanPageLayoutsCmdImpl command. The command ensures that the referential integrity of the database is preserved. To mark the layout for deletion by the CleanPageLayoutsCmdImpl command, set the State column in this input file to 2 (Mark for delete).