ImportExportHelper Class

Helper class for import/export process

Inheritance Hierarchy

System.Object
  CMS.CMSImportExport.ImportExportHelper

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

Syntax

public static class ImportExportHelper

The ImportExportHelper type exposes the following members.

Fields

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

Properties

	Name	Description
Public property Static member	AppCodeFolder	Name of the App_Code folder for current instance
Public property Static member	CompressionBufferSize	Size of buffer used to un/compress packages
Public property Static member	ExportObjectTree	Object tree.
Public property Static member	ImportObjectTree	Object tree.
Public property Static member	ImportWebSiteDirectory	Fictive web site directory for imported physical files (for testing purposes only).
Public property Static member	LangSuffixes	Language suffixes for code behind files
Public property Static member	ObjectTypeCycles	Indicates whether there is a cycle in dependencies among object types supported by import/export.
Public property Static member	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).
Public property Static member	SiteUtilsFolderPath	Site utils folder path (default: ~/CMSSiteUtils/)

Methods

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