Skip to content
  1. Extras
  2. msImportExport
  3. msImportExport 2.0

msImportExport 2.0

Import/export component.

Video overview

Video overview

RuTube

Supported file formats

  • CSV
  • XLSX
  • ODS
  • XML (export only)

Supported export types

Supported import types

Add-ons extending base component

System events

msieOnLoadServices - load services list

Event parameters

NameDescription
msieMsie class instance
modeservice type. Values: import; export

msieOnManagerCustomCssJs - load scripts

Event parameters

NameDescription
controllercontroller class instance
pagepage identifier

msieOnGetServiceFields - load fields list

Event parameters

NameDescription
msieMsie class instance
modeservice type. Values: import; export
serviceMsIeService class instance
fieldsfields list

msieOnExportStart - export start

Event parameters

NameDescription
workerclass instance
presetIdpreset ID
skipcancel action. Values: true; false. Default false
cachedwhether export runs in cached mode

msieOnExportBeforeFinish - export completion

Event parameters

NameDescription
workerclass instance
presetIdpreset ID
skipcancel action. Values: true; false. Default false
cachedwhether export runs in cached mode
fileexport file

msieOnExportBeforeArchive - before archiving export data

Event parameters

NameDescription
workerclass instance
presetIdpreset ID
skipcancel action. Values: true; false. Default false
filesfiles to archive

msieOnExportFinish - export end

Event parameters

NameDescription
workerclass instance
presetIdpreset ID
skipcancel action. Values: true; false. Default false
cachedwhether export runs in cached mode
fileexport file

msieOnExportPrepareQuery - prepare export query

Event parameters

NameDescription
workerclass instance
presetIdpreset ID
skipcancel action. Values: true; false. Default false
configarray with SQL query data

msieOnExportBeforePrepareRow msieOnExportAfterPrepareRow - prepare export row data

Event parameters

NameDescription
workerclass instance
presetIdpreset ID
skipcancel action. Values: true; false. Default false
dataTyperecord type. Values: keys; fields; records.
datadata array

msieOnExportBeforeWriteRow msieOnExportAfterWriteRow - write data to file

Event parameters

NameDescription
workerclass instance
presetIdpreset ID
skipcancel action. Values: true; false. Default false
dataTyperecord type. Values: keys; fields; records.
datadata array
optionsoptions array

msieOnImportStart - import start

Event parameters

NameDescription
workerclass instance
presetIdpreset ID
skipcancel action. Values: true; false. Default false
filesimport files array

msieOnImportBeforePrepare - prepare import data

Event parameters

NameDescription
workerclass instance
presetIdpreset ID
skipcancel action. Values: true; false. Default false
dataimport data array

msieOnImportAfterPrepare msieOnImportBeforePrepare - prepare import data

Event parameters

NameDescription
workerclass instance
presetIdpreset ID
skipcancel action. Values: true; false. Default false
dataimport data array
recordprepared import data
actionaction. Values: create; update

msieOnBeforeImport - import data

Event parameters

NameDescription
workerclass instance
presetIdpreset ID
skipcancel action. Values: true; false. Default false
dataimport data array
recordprepared import data
actionaction. Values: create; update
tvsTV fields array (only for quick update service)
poolQueryquick update SQL queries array (only for quick update service)

msieOnImport - import data

Event parameters

NameDescription
workerclass instance
presetIdpreset ID
skipcancel action. Values: true; false. Default false
dataimport data array
recordprepared import data
objectimport object data array
actionaction. Values: create; update

msieOnImportNotUnique - duplicate check

Event parameters

NameDescription
workerclass instance
presetIdpreset ID
skipcancel action. Values: true; false. Default false
dataimport data array
recordprepared import data
fieldcheck field name. Default "alias"
duplicateduplicate resource ID

msieOnImportFinish - import end

Event parameters

NameDescription
workerclass instance
presetIdpreset ID
skipcancel action. Values: true; false. Default false
idsarray of object IDs created/updated during import. Present only for MODX resource import services.

Note! Any service may add its own parameters to event lists. Check event parameters on add-on pages that add services.

Migrating from version 1 to 2

Version 2 is not compatible with version 1; you cannot simply upgrade. Best used on new projects.

If you still want to install version 2 on a site with version 1, remove version 1 first and manually delete these version 1 tables from the database:

  • msie_cron
  • msie_head_alias
  • msie_access_price
  • msie_presets_fields