Click or drag to resize
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
C#
public static class ImportExportHelper

The ImportExportHelper type exposes the following members.

Methods
  NameDescription
Public methodStatic memberAddExcludedSettingKey
Adds given setting key(s) to the excluded keys. Excluded keys are not exported nor imported.
Public methodStatic memberGenerateExportFileName
Returns a file name starting with given prefix, followed by the date, time and given extension.
Public methodStatic memberGetDependenciesList
Returns list of object types the given object type depends on.
Public methodStatic memberGetDocumentsDataWhereCondition
Gets where condition for specified object type based on documents. Uses the given condition object to build the where condition.
Public methodStatic memberGetExcludedSettingKeys
Returns set of excluded setting key names. Can return null if there are no excluded keys.
Public methodStatic memberGetExportFilePath
Returns the real file path for the specified path.
Public methodStatic memberGetObjectBackupFolder
Gets the backup folder for a given object
Public methodStatic memberGetObjectTypeName
Gets the name for the object type.
Public methodStatic memberGetObjectTypeSubFolder
Gets sub folder for specified object type.
Public methodStatic memberGetRealFilePath
Returns the real file path for the specified file.
Public methodStatic memberGetSafeObjectTypeName
Gets safe object type name.
Public methodStatic memberGetSiteUtilsFolder
Returns Site Utils folder physical path.
Public methodStatic memberGetSiteUtilsFolderRelativePath
Returns Site Utils folder relative path.
Public methodStatic memberGetTemporaryFolder
Returns Temporary folder physical path.
Public methodStatic memberInitSingleObjectExportSettings
Initialize provided export settings
Public methodStatic memberIsCMSObjectType
Returns true if object type is general object.
Public methodStatic memberIsCodeFile
Indicates if file is code file
Public methodStatic memberIsCommunityObjectType
Returns true if object type is from community module.
Public methodStatic memberIsDesignerCodeBehind
Indicates if file is designer code behind file
Public methodStatic memberIsEcommerceObjectType
Returns true if object type is from e-commerce module.
Public methodStatic memberIsLowerVersion
Returns true if the first given version is lower than the second one.
Public methodStatic memberIsPostProcessFile
Indicates if file should be post processed
Public methodStatic memberIsSettingKeyExcluded
Determines whether the given setting key is excluded from import/export.
Public methodStatic memberRemoveExcludedSettingKey
Removes given setting key(s) from the excluded keys. Excluded keys are not exported nor imported.
Public methodStatic memberRemoveExportExtension
Remove export extensions.
Public methodStatic memberRenameExportedFiles
Rename exported files.
Public methodStatic memberValidateExportFileName
Validate export file name.
Top
Fields
  NameDescription
Public fieldStatic memberAPPCODE_GLOBAL_FOLDER
AppCode global folder.
Public fieldStatic memberAPPCODE_SITE_FOLDER
AppCode site folder.
Public fieldStatic memberAPPDATA_SITE_FOLDER
AppData site folder.
Public fieldStatic memberATTACHMENT_FOLDER
Attachment folder.
Public fieldStatic memberBIZFORM_FOLDER
BizForm folder.
Public fieldStatic memberBIZFORM_PREFIX
Prefix for BizForm data object type.
Public fieldStatic memberBOARDMESSAGE_PREFIX
Prefix for board messages object type.
Public fieldStatic memberBOARDMESSAGES_FOLDER
Board messages folder.
Public fieldStatic memberCMS_INFO_TYPE
Info type for additional information.
Public fieldStatic memberCOMMUNITY_FOLDER
Community folder.
Public fieldStatic memberCONVERSION_FOLDER
Conversion folder.
Public fieldStatic memberCUSTOMTABLE_FOLDER
Custom table folder.
Public fieldStatic memberCUSTOMTABLE_PREFIX
Prefix for custom table data object type.
Public fieldStatic memberDATA_FOLDER
Data folder.
Public fieldStatic memberDOCTYPESICONS_FOLDER
Document types icons folder.
Public fieldStatic memberDOCUMENTS_FOLDER
Documents folder.
Public fieldStatic memberECOMMERCE_FOLDER
E-commerce folder.
Public fieldStatic memberEXPORT_BACKUP_PATH
Path where the backup Zip archive will be created.
Public fieldStatic memberEXPORT_EXTENSION
Export extension.
Public fieldStatic memberEXPORT_OBJECT_HEIGHT
Height of the export object modal window.
Public fieldStatic memberEXPORT_OBJECT_WIDTH
Width of the export object modal window.
Public fieldStatic memberEXPORTINFO_FILE
Export info file.
Public fieldStatic memberFILES_FOLDER
Templates folder.
Public fieldStatic memberFORMCONTROLS_FOLDER
Formuser controls folder.
Public fieldStatic memberFORUMPOST_PREFIX
Prefix for forum posts object type.
Public fieldStatic memberFORUMPOSTS_FOLDER
Forum posts folder.
Public fieldStatic memberGENERALOBJECTS_FOLDER
General objects folder.
Public fieldStatic memberGLOBAL_FOLDER
Global folder.
Public fieldStatic memberINFO_CURRENT_USER
Current user.
Public fieldStatic memberINFO_DOMAIN_NAME
Domain name.
Public fieldStatic memberINFO_HISTORY_DATE
History date.
Public fieldStatic memberINFO_HISTORY_NAME
History name.
Public fieldStatic memberINFO_HOTFIX_VERSION
Version of the hotfix.
Public fieldStatic memberINFO_MACHINE_NAME
Machine name.
Public fieldStatic memberINFO_SINGLE_OBJECT
Single object.
Public fieldStatic memberINFO_SITE_INCLUDED
Site included.
Public fieldStatic memberINFO_START_TIME
Start time of the process.
Public fieldStatic memberINFO_SYSTEM_VERSION
Version of the system.
Public fieldStatic memberINFO_SYSTEM_WEBAPP
Web application flag.
Public fieldStatic memberINFO_TIME_STAMP
Time stamp.
Public fieldStatic memberINFO_WEBTEMPLATE_FLAG
Webtemplate flag.
Public fieldStatic memberINLINECONTROLS_FOLDER
Inline controls folder.
Public fieldStatic memberMAX_FILE_LENGTH
Maximal length of the exported file name with path.
Public fieldStatic memberMEDIAFILE_PREFIX
Prefix for media files object type.
Public fieldStatic memberMEDIAFILES_FOLDER
Media files folder.
Public fieldStatic memberMETADATA_FOLDER
Meta files folder.
Public fieldStatic memberMODULE_NAME
Code name of the exported/imported module.
Public fieldStatic memberMODULES_FOLDER
Modules folder.
Public fieldStatic memberOBJECT_TYPE_TRANSLATION
Object translation.
Public fieldStatic memberOBJECT_VERSION_SUFFIX
Object versions suffix.
Public fieldStatic memberPACKAGE_EXTENSION
Export package extension.
Public fieldStatic memberSETTINGS_ADD_SITE_BINDINGS
Add site bindings in case the object is not imported (updated).
Public fieldStatic memberSETTINGS_ASSEMBLIES
Copy global folders.
Public fieldStatic memberSETTINGS_BIZFORM_DATA
Process BizForm data.
Public fieldStatic memberSETTINGS_BIZFORM_FILES_PHYSICAL
Copy BizForm files (physical files).
Public fieldStatic memberSETTINGS_BLOG_COMMENTS
Process blog comments.
Public fieldStatic memberSETTINGS_BOARD_MESSAGES
Process board messages.
Public fieldStatic memberSETTINGS_COPY_ASPX_TEMPLATES_FOLDER
Copy ASPX templates folder.
Public fieldStatic memberSETTINGS_COPY_FORUM_CUSTOM_LAYOUTS_FOLDER
Copy forum custom layouts folder.
Public fieldStatic memberSETTINGS_CUSTOMTABLE_DATA
Process custom table data.
Public fieldStatic memberSETTINGS_DELETE_SITE
Delete site after error during import.
Public fieldStatic memberSETTINGS_DELETE_TEMPORARY_FILES
Delete temporary files.
Public fieldStatic memberSETTINGS_DOC_ACLS
Document ACLs.
Public fieldStatic memberSETTINGS_DOC_HISTORY
Process documents history.
Public fieldStatic memberSETTINGS_DOC_RELATIONSHIPS
Process document relationships.
Public fieldStatic memberSETTINGS_EVENT_ATTENDEES
Process event attendees.
Public fieldStatic memberSETTINGS_FORUM_POSTS
Process forum posts.
Public fieldStatic memberSETTINGS_GLOBAL_FOLDERS
Copy global folders.
Public fieldStatic memberSETTINGS_GROUP_MEMBERSHIP
Indicates if group membership should be imported.
Public fieldStatic memberSETTINGS_MEDIA_FILES
Process media files.
Public fieldStatic memberSETTINGS_MEDIA_FILES_PHYSICAL
Copy media files (physical files).
Public fieldStatic memberSETTINGS_OVERWRITE_SYSTEM_QUERIES
Overwrite system queries.
Public fieldStatic memberSETTINGS_PAGETEMPLATE_SCOPES
Indicates if page template scopes should be imported.
Public fieldStatic memberSETTINGS_PAGETEMPLATE_VARIANTS
Indicates if web part/zone/widget variants should be imported with the page template.
Public fieldStatic memberSETTINGS_PROCESS_COMMUNITY
Process community objects.
Public fieldStatic memberSETTINGS_PROCESS_ECOMMERCE
Process e-commerce objects.
Public fieldStatic memberSETTINGS_RUN_SITE
Run site after import.
Public fieldStatic memberSETTINGS_SITE
Import / export site
Public fieldStatic memberSETTINGS_SITE_FOLDERS
Copy site folders.
Public fieldStatic memberSETTINGS_SKIP_OBJECT_ON_TRANSLATION_ERROR
Skip translation errors.
Public fieldStatic memberSETTINGS_TASKS
Process export tasks.
Public fieldStatic memberSETTINGS_UPDATE_SITE_DEFINITION
Update site definition if importing to the existing site.
Public fieldStatic memberSETTINGS_USER_DASHBOARDS
Indicates if user dashboards should be imported.
Public fieldStatic memberSETTINGS_USER_PERSONALIZATIONS
Indicates if user personalization should be imported.
Public fieldStatic memberSETTINGS_USER_SITE_DASHBOARDS
Indicates if user dashboards should be imported even if user isn't imported
Public fieldStatic memberSETTINGS_WEBTEMPLATE_EXPORT
Indicates that web template is exported.
Public fieldStatic memberSETTINGS_WORKFLOW_SCOPES
Indicates if workflow scopes should be imported.
Public fieldStatic memberSETTINGS_WORKFLOW_TRIGGERS
Indicates if workflow triggers should be imported.
Public fieldStatic memberSITE_FOLDER
Site folder.
Public fieldStatic memberSITE_MACRO
Site macro.
Public fieldStatic memberSKINS_FOLDER
Skins folder.
Public fieldStatic memberSRC_CONTAINERS_FOLDER
Web part containers folder.
Public fieldStatic memberSRC_FORUM_LAYOUTS_FOLDER
Forum custom layouts folder.
Public fieldStatic memberSRC_SKINS_FOLDER
Skins folder.
Public fieldStatic memberSRC_TEMPLATES_FOLDER
Templates folder.
Public fieldStatic memberTEMPLATES_FOLDER
Templates folder.
Public fieldStatic memberWEBPARTS_FOLDER
WebParts folder.
Top
Properties
  NameDescription
Public propertyStatic memberAppCodeFolder
Name of the App_Code folder for current instance
Public propertyStatic memberCompressionBufferSize
Size of buffer used to un/compress packages
Public propertyStatic memberImportWebSiteDirectory
Fictive web site directory for imported physical files (for testing purposes only).
Public propertyStatic memberLangSuffixes
Language suffixes for code behind files
Public propertyStatic memberObjectTree
Object tree.
Public propertyStatic memberObjectTypes
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 propertyStatic memberSiteUtilsFolderPath
Site utils folder path (default: ~/CMSSiteUtils/)
Top
See Also