File details - cms_block.csv

Last updated:
Edit on GitHub

This document describes the cms_block.csv file to configure CMS Block information on your Spryker Demo Shop.

To import the file, run:

data:import:cms-block

Import file parameters

The file should have the following parameters:

PARAMETER REQUIRED TYPE REQUIREMENTS OR COMMENTS DESCRIPTION
block_key ✓ String Block key identifier
block_name ✓ String Must be unique. Human-readable name. Name of the block.
template_name String Alphabetical identifier of the slot. It will be shown in the Back Office.
template_path String Must be a valid path to a twig template. Path to the Twig file template.
active Boolean
  • Inactive = 0
  • Active = 1
  • If empty during the import, the block will be imported as inactive.
 Indicates if the block is active or inactive.
placeholder.title.{ANY_LOCALE_NAME}*
Example value: placeholder.title.en_US		 String Placeholder for block title, translated into the specified locale (US for our example).
placeholder.description.{ANY_LOCALE_NAME}*
Example value: placeholder.description.en_US		 String Placeholder for block description, translated into the specified locale (US for our example).
placeholder.link.{ANY_LOCALE_NAME}*
Example value: placeholder.link.en_US		 String Placeholder for block link, translated into the specified locale (US for our example).
placeholder.content.{ANY_LOCALE_NAME}*
Example value: placeholder.content.en_US		 String Placeholder for block content, translated into the specified locale (US for our example).

*ANY_LOCALE_NAME: Locale date is dynamic in data importers. It means that ANY_LOCALE_NAME postfix can be changed, removed, and any number of columns with different locales can be added to the CSV files.

Import file dependencies

This file has no dependencies.

Import template file and content example

Find the template and an example of the file below:

FILE DESCRIPTION
cms_block.csv template Exemplary import file with headers only.
cms_block.csv Exemplary import file with Demo Shop data.