Skip to content
  1. Extras
  2. msBulkEditor
  3. Getting started
  4. System settings

System settings ​

Namespace msbulkeditor, DB keys: msbulkeditor_*.

General ​

KeyTypeDefaultDescription
msbulkeditor_chunk_sizenumber50Products per apply batch
msbulkeditor_expert_limitnumber5000Max products for “all matching filter”
msbulkeditor_preview_detail_limitnumber100Rows in detailed preview
msbulkeditor_history_retention_daysnumber90History retention (days)
msbulkeditor_enable_save_setting_userbooleanYesSave columns and expert mode in msbe_user_states
msbulkeditor_expert_modebooleanNoAllow expert mode in the UI
msbulkeditor_import_max_rowsnumber10000Max CSV/XLSX rows per upload

Scheduler ​

KeyTypeDefaultDescription
msbulkeditor_scheduler_enabledbooleanNo in transportHistory cleanup via Scheduler. With Scheduler installed, package install and update set Yes
msbulkeditor_cleanup_task_stubtextareaJSONInternal key: built-in cleanup without Scheduler. Not for manual edits

Task msbulkeditor / operation_cleanup deletes operations older than history_retention_days.

With Scheduler at install or update, the package sets msbulkeditor_scheduler_enabled = Yes and disables the stub. The next package update turns the setting on again even if you switched it off. The task still needs cron: php /path/to/assets/components/scheduler/run.php (usually daily).

Without Scheduler the transport value stays No. Plugin msbulkeditor_bootstrap on OnManagerPageInit runs cleanup at most once a day while msbulkeditor_cleanup_task_stub has enabled: true.

Permissions ​

Permissions are created on install. Assign them to the shop managers policy.

PermissionPurpose
msbulkeditor_viewGrid, preview, history (read), read and save UI state
msbulkeditor_editApply bulk operations
msbulkeditor_rollbackRoll back completed operations
msbulkeditor_presetsCreate / update / delete presets
msbulkeditor_import_exportImport and export files

The component page also opens with global view (read-only).

API route → permission ​

GroupRoutesPermission
Readhealth/ping, products/list, products/preview, products/progress, history/list, history/items, presets/list, ui/state/get, ui/state/save, fields/catalog, filters/references, bindings/checkview
Writeproducts/apply, bindings/applyedit
Rollbackproducts/rollbackrollback
Presetspresets/save, presets/deletepresets
Filesexport/run, import/run, import/parseimport_export

Presets and Import & export tabs are hidden without the matching permission. A direct URL without permission redirects to Products.

Production tips ​

  • Catalog > 5000 products: align expert_limit with RAM and PHP timeout. Lower chunk_size if a batch exceeds the time limit.
  • enable_save_setting_user = Yes: each manager keeps their own columns. No: the server does not store the layout, the browser still keeps a copy in localStorage.
  • expert_mode = No: explicit row selection only, lower risk of a mass mistake.

Paths ​

PathContents
core/components/msbulkeditor/PHP, processors, lexicon
assets/components/msbulkeditor/connector, JS/CSS bundle

Connector: assets/components/msbulkeditor/connector.php.

After a package update, clear the MODX cache and hard-reload the panel page (Ctrl/Cmd + Shift + R).

  • MODX events: plugins on apply and export
  • FAQ: permission and limit errors