Module Management
From DotProjectWiki
SYSTEM ADMIN MANUAL LINKS
The System Admin > View Modules option is used to manage the module / menu listings within dotProject.
In a number of cases modules can also be configured from this location but this is not mandatory and very much depends on how the developing programmer has opted to provide / needed configuration options.
Contents |
1 View Modules Listing
The main module listing shows all modules installed within your dotProject environment. See also Add On Installation
| Arrows | Up and Down arrows used to set the listing order, and therefore the display order. See Changing Module Listing Order below. |
| Module | Module Name - as set by the Developer |
| Status | Indicates the status of the module and/or provides options for changing that Status. See Module Status below. |
| Type | This indicates the type of module. Core indicates that it is a basic of dotProject, delivered with and supported by the Dev Team. User indicates that the module could be delivered as part of the basic package or could be an Add On Module, it's a programmers choice as to how they label the module. Addon clearly indicates that the module is not part of the basic product, has been incorporated outside the basic dotProject installation and is not supported by the Dev Team |
| Version | Version string for the individual module (not the overall dp version - that's on the main login screen). |
| Menu Text | The name of the Module as it appears on the menu / module listing |
| Menu Icon | The filename of the menu icon that is used when the module is displayed |
| Menu Status | Indicates whether the module is visible on the menu (keep in mind that making a module visible won't solve anything if the user roles you are using do not provide Access to that module). |
| Display Order | Numeric listing of the display order |
Most of the elements in this listing are not adjustable by the System Admin, but are setup as part of the programming elements.
2 Changing Module Listing Order
Modules are incorporated in the menu listing in the order that they are displayed in the View Modules Screen.
To change the order of your menu, change the order of the modules here using the ^ V arrows on the left hand side of the screen.
3 Module Status
The Module Status (as opposed to the Menu Status) is used to control the module itself.
The options that you have will vary slightly depending on requirements stipulated by the developer:
| install | Newly installed modules (particularly addon modules) may need to be installed in the dotProject hierarchy - not just copied into the relevant directory. If they require triggering / installation then there will be an install option in the Module Status column |
| active | Indicates that the module is active / usable. Click on that to change the status to disabled |
| disabled | Indicates that the module has been disabled. Click to activate |
| remove | To remove the module from the Module listing, click on remove (you may also have to remove the files from the physical directory). |
| upgrade | If a module requires upgrading, once the files have been copied to the relevant directory you may have to click on the upgrade option to trigger the upgrade. This should not be required in the event that a system wide upgrade has been done. |
| configure | This option will take you to a configuration option for the individual module. As these options vary from module to module, please refer to System Administration for details. |
(Not all modules will include a configuration option - it's up to the developer).
4 Enable in the Menus
Modules appearing or not appearing in the menu listing can be controlled via the Menu Status option. It's a toggle setting - click on it to change the status / click again to change again. Most modules will have an option of:
- visible
- hidden
