Marketpath CMS Developer Tutorial Series

Exporting Content

Last Updated 3/9/2018

This lesson explains how to export content from a Marketpath CMS site. You can export lists of data to a CSV file, such as form submisions. You can also export a group of object types that define specific website functionality or features, such as a custom image gallery.

Marketpath CMS provides a very robust export tool to pull data and content from your site. You can export:

  1. lists of data, such as form submissions, authors, or datastore items
  2. custom modules comprised of templates, stylesheets, and Javascript
  3. entire websites

Exporting a List of Data to CSV or JSON

Exporting to a CSV or JSON file is a common action required of a CMS. To export data, go to Site -> Exports and click New. In this example, we will create a new export definition that exports form submission data from a form into a JSON file.

Steps

1) Give the export a descriptive name

2) select the export file type (CSV, XML, or JSON)

3) If you plan to reuse an export definition, uncheck the Expires checkbox and it will stay in your definitions list permanently. Otherwise, leave it checked and it will be automatically purged from your export list after 48 hours.

4) Add an email address that will be notified when the export has completed

5) Scroll down to the Form Submission object type and click the checkbox.

6) Change the drop down to Filter and click the area next to the label Form

7) Select the form whose data you want to export

8) For a simple list export, you shouldn't have to worry about any of the additional settings at the bottom of the definition, except for the Status Filter. Be sure it is set to untrashed. That is the default setting and means it will only export items that you have not trashed.

9) Now click the Run icon. This is the first icon next to your new export definition (the semi-circle with the arrow). 

When your export is complete you will receive an email notification. You can also click the Refresh action and wait for the status to change to completed.

Exporting a Custom Module

Best practices for front-end developers is to reuse code whenever possible to increase development efficiency. Basically, don't reinvent the wheel. If you maintain a code reuse frame of mind you should have various code modules, fragments and page types to save. These can consist of any number of objects in Marketpath CMS but typically are comprised of templates, stylesheets, Javascript, and images.

In this example, we will show how to export a gallery package called Renegade Gallery for reuse on other sites. 

Steps

1) Give it a recognizable name

2) set the Type to json

3) Check or uncheck the Expires checkbox, as desired

4) In this example, we are using a partial template, a Javascript file, and a stylesheet. Use the image below as a guide to making the proper selections for each object.

5) Select the Replace Guids with Names checkbox. This is important when importing code into another site. It will not try to save to an existing object with the same Guid value and then throw an exception.

6) You can select the Zip Files checkbox but in this case we have no images or documents. All the content will be stored in a single json file.

7) Uncheck Include Pages

8) Click Save

9) Click the Run icon to start the export

Exporting an Entire Site

If you have sites you want to copy and reuse, you can create an export job and import it into a new blank site. When you created your first site, if you selected a theme, it downloaded the export file from a full site export that we created for you. You can do the same thing!

To export an entire site:

Steps

1) Provide a friendly, understandable name

2) Select the Type as json

3) Choose whether or not the export expires

4) In Items, select the All checkbox

5) Select all check boxes in the Advanced section. 

6) Click Save and then Run on the correct export item in the exports list.

Expiring Exports

By default, exports are set to expire after 48 hours. Sometimes you want an export to NOT expire. Export file paths are unique for each export definition. If you create a new Full Site export, for example, the exported file will have a completely new URL to the zip file. If, instead, you want to make updates to the site and re-export the entire site with those changes, you can simply re-run the export and it will retain the original exported file URL. The original file will be overwritten.


---- End of Lesson ----

Question? Correction?

Let's work together to make our documentation as helpful as possible.

What is your name? 
What is your email address? 
Feedback: