Export Step 1 of 2

You are here: Administrators Reference > Exporting and Importing Objects > Export Overview > Export – Step 1 of 2

Export Step 1 of 2

CommonSpot exports custom field types, render handlers, metadata forms, and custom Elements as zip files. While including a readme file or 'post import script' file is optional, you should always add a ReadMe.txt file that describes the object.

New in CommonSpot 10.5 is the Export Utility's ability to remember auxiliary files and prepopulate them during second and subsequent exports of the same object.

When you are exporting one of these objects, you are actually exporting a collection of CommonSpot files. In many cases, you must export all of the files. However, there are some cases where a part of the object is optional. For example, when exporting a custom Element, including a render handler is optional.

Export dialogs contain the following fields:

Name - Required. This field is pre-populated with a default name for the export packet (.zip file). While you can change this default name to whatever you like, it must not contain spaces. The text in the figure above contains additional information about the contents of this field.
Items to Export - Each object has at least one and possibly more required items and may have optional items. Use the links at the top of the Items to Export section to show or hide objects. Optional items do not have to be included for the object to function properly, when imported.

Name field: Items exported a second time will not append the date and guid to the filename.

Check the box next to "This Custom Element requires the ADF to be installed." if this is true. During import, the process will attempt to detect the ADF, and refuse the import if the ADF is not running.

mouseover to enlarge

Readme File Name - You can optionally include a readme file in the export archive. You must build the readme file separately. To include it, enter the full path to the readme file or click the Browse button to locate it. The readme filename cannot contain spaces and must have a .txt extension. This file only displays during the import process and is deleted once the import is completed.
Post Import Script File Name: If you wish to execute a script after the import completes, please choose a script file. The file name cannot contain spaces and must have an extension of '.cfm'. You might use this to run a script using the API to populate data into a custom element used as the source of a Select List field. The Post Import Script is deleted after it has run to prevent unintended consequences of running it more than once. Importing the Custom Element again, depending on how you wrote your code, may add additional rows to the custom element. The internal module that runs to process your script will, by default, only allow it to run if there is no data in your custom element.
Additional Files: You may pick additional files to include in the export by clicking the "Select" link, which opens the Select Files dialog. The Select Files dialog also has a Select list to choose a subfolder from which to locate your file.

Select Files Dialog

After completing this dialog, click Export to continue to the second step of the Export process.

Related Links

You can download PDF versions of the Content Contributor's, Administrator's, and Elements Reference documents from the support section of paperthin.com (requires login).

The following guides are available from the support site and are in the /docs/directory of your CommonSpot Server:

You can also download these other guides from the support section of paperthin.com (with login):

For technical support:

http://www.paperthin.com/support/