Import and Export for Page Designer Pages and Components

You can import pages and components as content assets using the standard library import and export functionality. The type attribute distinguishes pages and components in the library from other content assets.

Pages use the following format for the type attribute:

page.<page_type_id>

For example, this snippet from a library import file includes a page named fixedlayout identified as type page.fixedlayout.

<content content-id="finishedsamplepage">
   <display-name xml:lang="x-default">Finished Sample Page</display-name>
   <display-name xml:lang="en-US">Finished Sample Page</display-name>
   <type>page.fixedlayout</type>
   <config>{
     "visibility" : [ ]
   }</config>
   <online-flag>true</online-flag>
   <searchable-flag>false</searchable-flag>
   <page-attributes/>
   <content-links>
       <content-link content-id="headlinebanner_newarrivals-womens" 
        type="page.fixedlayout.region1">
           <position>0.0</position>
       </content-link>
   </content-links>
   <sitemap-included-flag>false</sitemap-included-flag>
</content>

Components use the following format for the type attribute:

component.<component_type_id>

For example, this snippet from a library import file includes a component named producttile identified as type component.assets.producttile.

<content content-id="producttile_25696677">
        <display-name xml:lang="x-default">Product Tile 25696677</display-name>
        <type>component.assets.producttile</type>
        <config>{
          "visibility" : [ ]
        }</config>
        <data xml:lang="x-default">{
          "product" : "25696677"
        }</data>
        <data xml:lang="en-US">{
          "product" : "25696677"
        }</data>
        <online-flag>true</online-flag>
        <page-attributes/>
    </content>

Both pages and components must include a config attribute that describes visibility rules. Components must also include a data attribute that describes the component attributes set by the merchant. The config and data attributes must be defined as JSON snippets. Refer to the JSON schemas for details:

Page Designer JSON Schemas

In the following situations, the import is allowed to proceed, but might issue multiple warning messages:

• You have not yet uploaded the cartridge that contains the page and component types.
• The imported data is in conflict with the meta definitions for existing page and component types, for example, if an imported component has attributes that are not defined in the corresponding meta definition file.