Kentico CMS 6.0 Developer's Guide

Exporting a site

Exporting a site

Previous topic Next topic Mail us feedback on this topic!  

Exporting a site

Previous topic Next topic JavaScript is required for the print function Mail us feedback on this topic!  

Kentico CMS allows you to export whole website including its settings and related objects (such as document types, workflows, web parts, page templates, etc.) into a single file that can be imported on the same or different Kentico CMS instance.

 

Exporting a site

 

1. Go to Site Manager -> Sites and click the Export site icon next to the site you want to export. This will start the export wizard.

 

devguide_clip0316

 

2. In the first step of the wizard, you have to fill in the name of the export package and choose type of objects pre-selection:

 

File name

Name of the export package. A default name will be pre-filled and the package will be stored in <web project>\CMSSiteUtils\Export.

Preselect all objects

If chosen, all site objects will be preselected in the next step.

Preselect objects changed after specific date

If chosen, only objects changed after the specified date will be selected in the next step.

Use previous export settings

If chosen, settings used in a previous export selected from the list below will be used.

 

Select the option that suits your purposes and click the Next button.

 

devguide_clip0319

 

3. In Step 2, you can select which objects will be exported. The tree on the left represents object categories. These reflect the sections of the administration interface under that the objects can be found. The Site category contains objects related to the selected website. The Global objects category contains global objects that can be used by all sites.

 

By selecting a category, a set of check boxes appears in the right part of the screen, letting you select which objects will be exported. If you select the root of the tree (All objects), you will be offered with the following options:

 

Global selection

Load default selection

If clicked, object preselection will be done based on your choice in Step 1.

Select all objects

If clicked, all objects will be preselected.

Deselect all objects

If clicked, all objects will be deselected.

Export settings

Export tasks

If enabled, delete tasks (incremental deployment) will be included in the package.

Export files

Some objects in the database are linked with physical files in the file system. If you check this check-box, these files will be exported along with the database objects.

Export global folders

If enabled, global files under the folders listed below will be exported:

- <web project>\App_Code\Global

- <web project>\CMSGlobalFiles

Export assembly files

If enabled, bound assembly files will be exported together with notification gateways, payment options, integration connectors, scheduled tasks and smart search indexes.

Export site folders

If enabled, files under the folders listed below will be exported:

- <web project>\App_Code\<site code name>

- <web project>\<site code name>

Export ASPX templates folder

If enabled, the folder with ASPX page templates will be exported:

- <web project>\CMSTemplates

Export forum custom layouts folder

If enabled, folder with custom forum layouts will be exported:

- <webproject>\CMSModules\Forums\Controls\Layouts\Custom

 

devguide_clip0317

 

4. The following categories contain extra options to be set:

 

Custom tables

Export custom table data

If checked, custom table records (the actual data stored in the tables) will be exported along with the selected custom tables.

Documents

Export documents

If checked, documents will be exported

Export document histories

If checked, histories of all exported documents will be exported.

Export document relationships

If checked, relationships of all exported documents will be exported.

Export document level permissions

If checked, document security settings made in CMS Desk will be exported.

Export blog comments

If checked, blog comments will be exported.

Export event attendees

If checked, event attendees will be exported for all exported events.

Forms

Export forms data

If checked, stored forms' data will be exported together with the exported forms.

Export physical files

If checked, physical files saved within form records (if there are some) will also be imported.

Forums

Export forum posts

If checked, forum posts will be exported together with the exported forums.

Message boards

Export board messages

If checked, board messages will be exported together with particular message boards.

Media libraries

Export media files

If checked, media files stored in the database will be exported.

Export physical files

If checked, physical media files stored in the file system will be exported. This option is not selected by default as it may cause the package size grow extremely large; instead, it is recommended to export these files manually.

 

5. If you have the "Log export tasks" option enabled in Site Manager -> Settings -> Versioning & synchronization -> Staging, a list of object deletion tasks may also be displayed at the bottom of the list. This happens when some objects have been deleted (just as the two web part containers in the screenshot below). If you leave the check-boxes checked, the objects will be deleted after importing the package on the target server.

 

devguide_clip0318

 

6. After making all required selections, click Next to proceed to the next step. A log appears, showing you the progress of exporting. You can abort exporting by clicking the Cancel button at any time. When exporting finishes, a message appears at the top of the log, telling you the full path to the exported file. Click the Finish button.

 

devguide_clip0320

 

7. You will be redirected back to Site manager -> Sites. Now you can copy the exported package to the target installation of Kentico CMS, into the <web project>\CMSSiteUtils\Import folder and use the Import site or objects wizard described in the Importing a site or objects topic.