template input file

Use the template input file to load layout templates into a store so that they can be used in the Commerce Composer tool. This input file loads an empty layout template. For samples that demonstrate how to use this input file in different load scenarios, see:

• Sample: Loading Commerce Composer layout templates

• Sample: Loading Commerce Composer layouts

• Sample: Loading Commerce Composer widgets

We can extract layout template data with the Data Extract utility to create a template.csv file that we can load with the Data Load utility. For example, to copy or move templates 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 template data from the following database tables:

• PAGELAYOUT

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

• Sample: Extracting Commerce Composer layout templates

• Sample: Extracting Commerce Composer pages

Definitions

LayoutUniqueID

(Integer) The internal reference number for the template, for example, 50001. The LayoutUniqueID is automatically generated when loading the template. 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 template.

Maps to: PAGELAYOUT.PAGELAYOUT_ID

LayoutName

(String) The external reference name of the template, for example, Any page, eight slots, tabs. This name is displayed in Commerce Composer tool to help business users identify the template. We 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

Description

(String) The description of the template, for example, Eight-slot template with left sidebar. Includes two optional tabs. The description is displayed in Commerce Composer tool to help business users understand the structure or purpose of the template.

Maps to: PAGELAYOUT.DESCRIPTION

DeviceClass

(String) The class of device that the template 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 template is responsive.

Maps to: PAGELAYOUT.DEVICETYPE

State

(Integer) The state of the template. Valid values are:

0

Inactive; do not make this template available in the Commerce Composer tool.

1

Active; make this template available in the Commerce Composer tool.

2

Mark for delete. To clean up templates that are marked for deletion from the database, we must schedule the CleanPageLayoutsCmdImpl command. See Remove marked for delete Commerce Composer layouts.

Maps to: PAGELAYOUT.STATE

IsTemplate

(String) A flag indicating whether we are loading a template. Set this value to TRUE.

Maps to: PAGELAYOUT.ISTEMPLATE

IsDefault

(String) A flag indicating whether we are loading a default layout. Set this value to FALSE.

Maps to: PAGELAYOUT.ISDEFAULT

Delete

(String) A flag indicating whether to delete the row for this template from the database. Specify 1 to delete the row. Tip: Instead of using this column to delete a template, consider scheduling the CleanPageLayoutsCmdImpl command. The command ensures that the referential integrity of the database is preserved. To mark the template for deletion by the CleanPageLayoutsCmdImpl command, set the State column in this input file to 2 (Mark for delete).

Related concepts
Layouts, layout templates, and default layouts
Commerce Composer layout architecture
Commerce Composer layout template architecture

Related tasks
Extracting Commerce Composer data with the Data Extract utility

Related reference
Commerce Composer samples
Sample: Extracting Commerce Composer widgets
Sample: Extracting Commerce Composer layout templates
Sample: Extracting Commerce Composer layouts
Sample: Extracting Commerce Composer pages
Sample: Extracting Commerce Composer data
Commerce Composer object input file definitions