$installdefs parameter `schedulers` in manifest.php is not respected as documented while installing a module #5184

New issue

Open

opened 2026-02-20 16:31:04 -05:00 by deekerman · 1 comment

deekerman commented

2026-02-20 16:31:04 -05:00

Owner

Originally created by @isleshocky77 on GitHub (Apr 15, 2024).

Issue

The documentation Module Installer states that there is a key for schedulers which would be

An array of schedulers to be installed. Each entry is an array with a single key:

This means that these should be copied to the schedulers directory.

However, in practice, this functionality does not work.

If you look at the $manifestMap in ModuleInstall/ModuleScanner.php:51 as well $tasks ModuleInstall/ModuleInstaller.php:123 you'll see there isn't actually a definition for schedulers or a install_schedulers task.

The work around for this is you need to use the copy key like such

    'copy' => [
        [
            'from' => '<basepath>/schedulers/CustomModule.php',
            'to' => 'custom/Extension/modules/Schedulers/Ext/ScheduledTasks/CustomModule.php',
        ],
    ],

Expected Behavior

When installing a custom module with a manifest.php file that has a key for schedulers, it should install the Scheduler. as documented.

Actual Behavior

The key schedulers key in manifest is just ignored.

Possible Fix

Add the correct functionality to ModuleInstall/ModuleScanner.php:51 and ModuleInstall/ModuleInstaller.php:123

Steps to Reproduce

Create a Custom module
Update the manifest.php to have an array with a key of schedulers
Create in the module a Scheduler
Install the custom module through Module Loader
Look at scheduled jobs

Context

The documentation is wrong and takes a bit of debugging to figure out. You then need to use the copy key instead of a cleaner schedulers key for what is actually going on.

Your Environment

SuiteCRM Version used: 7.x
Browser name and version (e.g. Chrome Version 51.0.2704.63 (64-bit)): 123.0.6312.86

Originally created by @isleshocky77 on GitHub (Apr 15, 2024).     #### Issue   The documentation [Module Installer](https://docs.suitecrm.com/developer/module-installer/#:~:text=in%20the%20install.-,schedulers,-An%20array%20of) states that there is a key for `schedulers` which would be > An array of schedulers to be installed. Each entry is an array with a single key: This means that these should be copied to the `schedulers` directory. However, in practice, this functionality does not work. If you look at the `$manifestMap` in `ModuleInstall/ModuleScanner.php:51` as well `$tasks` `ModuleInstall/ModuleInstaller.php:123` you'll see there isn't actually a definition for `schedulers` or a `install_schedulers` task. The work around for this is you need to use the `copy` key like such ```php 'copy' => [ [ 'from' => '<basepath>/schedulers/CustomModule.php', 'to' => 'custom/Extension/modules/Schedulers/Ext/ScheduledTasks/CustomModule.php', ], ], ``` #### Expected Behavior  When installing a custom module with a `manifest.php` file that has a key for `schedulers`, it should install the Scheduler. as documented. #### Actual Behavior   The key `schedulers` key in manifest is just ignored. #### Possible Fix  Add the correct functionality to `ModuleInstall/ModuleScanner.php:51` and `ModuleInstall/ModuleInstaller.php:123` #### Steps to Reproduce   1. Create a Custom module 2. Update the `manifest.php` to have an array with a key of `schedulers` 3. Create in the module a Scheduler 4. Install the custom module through Module Loader 5. Look at scheduled jobs #### Context   The documentation is wrong and takes a bit of debugging to figure out. You then need to use the `copy` key instead of a cleaner `schedulers` key for what is actually going on. #### Your Environment  * SuiteCRM Version used: 7.x * Browser name and version (e.g. Chrome Version 51.0.2704.63 (64-bit)): 123.0.6312.86

deekerman added the

labels

2026-02-20 16:31:04 -05:00

deekerman commented

2026-02-20 16:31:06 -05:00

Author

Owner

@jobst commented on GitHub (Apr 22, 2025):

I just saw this as I am trying, too, to work out how to create scheduled jobs with MINIMAL follow ups required by the admin of a site.

As developers (I am creating a couple of modules one of which implements a caldav server) I should be able to create a number of scheduler jobs (e.g. once a day at 1am or every 15minutes) without ANY setup required by an admin.

The Module documentation explains how to do this, the code however does not implement what is explained in the documention (running the LATEST 7.14.6)

@jobst commented on GitHub (Apr 22, 2025): I just saw this as I am trying, too, to work out how to create scheduled jobs with MINIMAL follow ups required by the admin of a site. As developers (I am creating a couple of modules one of which implements a caldav server) I should be able to create a number of scheduler jobs (e.g. once a day at 1am or every 15minutes) without ANY setup required by an admin. The Module documentation explains how to do this, the code however does not implement what is explained in the documention (running the LATEST 7.14.6)