ImportExportHelper Class

Helper class for import/export process

Inheritance Hierarchy

SystemObject
CMS.CMSImportExportImportExportHelper

Namespace: CMS.CMSImportExport
Assembly: CMS.ImportExport (in CMS.ImportExport.dll) Version: 8.2.23

Syntax

Copy

public static class ImportExportHelper

The ImportExportHelper type exposes the following members.

Methods

	Name	Description
	AddExcludedSettingKey	Adds given setting key(s) to the excluded keys. Excluded keys are not exported nor imported.
	GenerateExportFileName	Returns a file name starting with given prefix, followed by the date, time and given extension.
	GetDependenciesList	Returns list of object types the given object type depends on.
	GetDocumentsDataWhereCondition	Gets where condition for specified object type based on documents. Uses the given condition object to build the where condition.
	GetExcludedSettingKeys	Returns set of excluded setting key names. Can return null if there are no excluded keys.
	GetExportFilePath	Returns the real file path for the specified path.
	GetObjectBackupFolder	Gets the backup folder for a given object
	GetObjectTypeName	Gets the name for the object type.
	GetObjectTypeSubFolder	Gets sub folder for specified object type.
	GetRealFilePath	Returns the real file path for the specified file.
	GetSafeObjectTypeName	Gets safe object type name.
	GetSiteUtilsFolder	Returns Site Utils folder physical path.
	GetSiteUtilsFolderRelativePath	Returns Site Utils folder relative path.
	GetTemporaryFolder	Returns Temporary folder physical path.
	InitSingleObjectExportSettings	Initialize provided export settings
	IsCMSObjectType	Returns true if object type is general object.
	IsCodeFile	Indicates if file is code file
	IsCommunityObjectType	Returns true if object type is from community module.
	IsDesignerCodeBehind	Indicates if file is designer code behind file
	IsEcommerceObjectType	Returns true if object type is from e-commerce module.
	IsLowerVersion	Returns true if the first given version is lower than the second one.
	IsPostProcessFile	Indicates if file should be post processed
	IsSettingKeyExcluded	Determines whether the given setting key is excluded from import/export.
	RemoveExcludedSettingKey	Removes given setting key(s) from the excluded keys. Excluded keys are not exported nor imported.
	RemoveExportExtension	Remove export extensions.
	RenameExportedFiles	Rename exported files.
	ValidateExportFileName	Validate export file name.

Top

Fields

	Name	Description
	APPCODE_GLOBAL_FOLDER	AppCode global folder.
	APPCODE_SITE_FOLDER	AppCode site folder.
	APPDATA_SITE_FOLDER	AppData site folder.
	ATTACHMENT_FOLDER	Attachment folder.
	BIZFORM_FOLDER	BizForm folder.
	BIZFORM_PREFIX	Prefix for BizForm data object type.
	BOARDMESSAGE_PREFIX	Prefix for board messages object type.
	BOARDMESSAGES_FOLDER	Board messages folder.
	CMS_INFO_TYPE	Info type for additional information.
	COMMUNITY_FOLDER	Community folder.
	CONVERSION_FOLDER	Conversion folder.
	CUSTOMTABLE_FOLDER	Custom table folder.
	CUSTOMTABLE_PREFIX	Prefix for custom table data object type.
	DATA_FOLDER	Data folder.
	DOCTYPESICONS_FOLDER	Document types icons folder.
	DOCUMENTS_FOLDER	Documents folder.
	ECOMMERCE_FOLDER	E-commerce folder.
	EXPORT_BACKUP_PATH	Path where the backup Zip archive will be created.
	EXPORT_EXTENSION	Export extension.
	EXPORT_OBJECT_HEIGHT	Height of the export object modal window.
	EXPORT_OBJECT_WIDTH	Width of the export object modal window.
	EXPORTINFO_FILE	Export info file.
	FILES_FOLDER	Templates folder.
	FORMCONTROLS_FOLDER	Formuser controls folder.
	FORUMPOST_PREFIX	Prefix for forum posts object type.
	FORUMPOSTS_FOLDER	Forum posts folder.
	GENERALOBJECTS_FOLDER	General objects folder.
	GLOBAL_FOLDER	Global folder.
	INFO_CURRENT_USER	Current user.
	INFO_DOMAIN_NAME	Domain name.
	INFO_HISTORY_DATE	History date.
	INFO_HISTORY_NAME	History name.
	INFO_HOTFIX_VERSION	Version of the hotfix.
	INFO_MACHINE_NAME	Machine name.
	INFO_SINGLE_OBJECT	Single object.
	INFO_SITE_INCLUDED	Site included.
	INFO_START_TIME	Start time of the process.
	INFO_SYSTEM_VERSION	Version of the system.
	INFO_SYSTEM_WEBAPP	Web application flag.
	INFO_TIME_STAMP	Time stamp.
	INFO_WEBTEMPLATE_FLAG	Webtemplate flag.
	INLINECONTROLS_FOLDER	Inline controls folder.
	MAX_FILE_LENGTH	Maximal length of the exported file name with path.
	MEDIAFILE_PREFIX	Prefix for media files object type.
	MEDIAFILES_FOLDER	Media files folder.
	METADATA_FOLDER	Meta files folder.
	MODULE_NAME	Code name of the exported/imported module.
	MODULES_FOLDER	Modules folder.
	OBJECT_TYPE_TRANSLATION	Object translation.
	OBJECT_VERSION_SUFFIX	Object versions suffix.
	PACKAGE_EXTENSION	Export package extension.
	SETTINGS_ADD_SITE_BINDINGS	Add site bindings in case the object is not imported (updated).
	SETTINGS_ASSEMBLIES	Copy global folders.
	SETTINGS_BIZFORM_DATA	Process BizForm data.
	SETTINGS_BIZFORM_FILES_PHYSICAL	Copy BizForm files (physical files).
	SETTINGS_BLOG_COMMENTS	Process blog comments.
	SETTINGS_BOARD_MESSAGES	Process board messages.
	SETTINGS_COPY_ASPX_TEMPLATES_FOLDER	Copy ASPX templates folder.
	SETTINGS_COPY_FORUM_CUSTOM_LAYOUTS_FOLDER	Copy forum custom layouts folder.
	SETTINGS_CUSTOMTABLE_DATA	Process custom table data.
	SETTINGS_DELETE_SITE	Delete site after error during import.
	SETTINGS_DELETE_TEMPORARY_FILES	Delete temporary files.
	SETTINGS_DOC_ACLS	Document ACLs.
	SETTINGS_DOC_HISTORY	Process documents history.
	SETTINGS_DOC_RELATIONSHIPS	Process document relationships.
	SETTINGS_EVENT_ATTENDEES	Process event attendees.
	SETTINGS_FORUM_POSTS	Process forum posts.
	SETTINGS_GLOBAL_FOLDERS	Copy global folders.
	SETTINGS_GROUP_MEMBERSHIP	Indicates if group membership should be imported.
	SETTINGS_MEDIA_FILES	Process media files.
	SETTINGS_MEDIA_FILES_PHYSICAL	Copy media files (physical files).
	SETTINGS_OVERWRITE_SYSTEM_QUERIES	Overwrite system queries.
	SETTINGS_PAGETEMPLATE_SCOPES	Indicates if page template scopes should be imported.
	SETTINGS_PAGETEMPLATE_VARIANTS	Indicates if web part/zone/widget variants should be imported with the page template.
	SETTINGS_PROCESS_COMMUNITY	Process community objects.
	SETTINGS_PROCESS_ECOMMERCE	Process e-commerce objects.
	SETTINGS_RUN_SITE	Run site after import.
	SETTINGS_SITE	Import / export site
	SETTINGS_SITE_FOLDERS	Copy site folders.
	SETTINGS_SKIP_OBJECT_ON_TRANSLATION_ERROR	Skip translation errors.
	SETTINGS_TASKS	Process export tasks.
	SETTINGS_UPDATE_SITE_DEFINITION	Update site definition if importing to the existing site.
	SETTINGS_USER_DASHBOARDS	Indicates if user dashboards should be imported.
	SETTINGS_USER_PERSONALIZATIONS	Indicates if user personalization should be imported.
	SETTINGS_USER_SITE_DASHBOARDS	Indicates if user dashboards should be imported even if user isn't imported
	SETTINGS_WEBTEMPLATE_EXPORT	Indicates that web template is exported.
	SETTINGS_WORKFLOW_SCOPES	Indicates if workflow scopes should be imported.
	SETTINGS_WORKFLOW_TRIGGERS	Indicates if workflow triggers should be imported.
	SITE_FOLDER	Site folder.
	SITE_MACRO	Site macro.
	SKINS_FOLDER	Skins folder.
	SRC_CONTAINERS_FOLDER	Web part containers folder.
	SRC_FORUM_LAYOUTS_FOLDER	Forum custom layouts folder.
	SRC_SKINS_FOLDER	Skins folder.
	SRC_TEMPLATES_FOLDER	Templates folder.
	TEMPLATES_FOLDER	Templates folder.
	WEBPARTS_FOLDER	WebParts folder.

Top

Properties

	Name	Description
	AppCodeFolder	Name of the App_Code folder for current instance
	CompressionBufferSize	Size of buffer used to un/compress packages
	ImportWebSiteDirectory	Fictive web site directory for imported physical files (for testing purposes only).
	LangSuffixes	Language suffixes for code behind files
	ObjectTree	Object tree.
	ObjectTypes	List of object types with flag if its global or not. Used by Import/Export, order of the elements matters (objects are in order for import, export order is reverse).
	SiteUtilsFolderPath	Site utils folder path (default: ~/CMSSiteUtils/)

Top

Reference

CMS.CMSImportExport Namespace