# Module Definition

Use snap-in Module configuration/Module definition to change basic technical settings for this module on data management level.

Attention: Changes have a major impact on the functioning of this module.


Module definition snap-in of the "Files" module

# Module Definition Fields

# Friendly Name Template

Defines the way the friendly name for each bean in this module is generated, e.g. {name} or {subject}. The friendly name is generated with the Template Engine.

# Create Module Table

If "true" or not chosen, a module table was created for this module in the database. If "false", no module table was generated. Without a table, reading and writing of records is not possible for this module.

Please note: We do not recommend changing the default. Changing the default from "true" to "false" will not delete the table from the database though.

# Enable Hierarchical Tree Structure

If enabled, it is possible to build a hierarchy for each record of this module with PID and has_child. This tree structure can be used to visualize relations e.g. in feature Evolution tree. If disabled, no such relations will be stored and existing relations of PID and has_child can no longer be taken into account.

# Show Module in Role Configuration

If enabled, this module is displayed in the Role configuration and its settings (permissions and presets) can be customized role-specific. If enabled, custom settings made for roles will apply.

Please note: If disabled, all custom role settings made for this module (tables ce_role, ce_role_accs stored in the database) will be ignored. Only default XML values will apply then. The module will not be displayed in the Role configuration anymore.

# Enable Record-specific Permissions for Users

If enabled, you get the possibility to give additional rights to a user, e.g. when assigning a user to a collection or task. You can thus assign read, edit, delete, or assign rights for a record even if a user has fewer (e.g. only reading) rights on this module's records. Note that you cannot remove rights of a user using this feature.

# Enable Record-specific Permissions for User Roles

If enabled, you get the possibility to give additional rights to a role, e.g. when assigning a role to a collection or task. You can thus assign read, edit, delete, or assign rights for a record even if a role has fewer (e.g. only reading) rights on this module's records. Note that you cannot remove rights of a user using this feature.

# Enable Check for Owner Permissions

If enabled, the ownership of a record will be extra checked and verified, used e.g. for the update or request management.

# Database Cleanup (Interval in Days)

Here you can define an interval (in days) in which all deleted records of this module will automatically be deleted permanently from the database. Deleted objects are set to "1" in the database. They are also listed in snap-in Deleted objects where you can also delete all or selected objects permanently.

# Object Renderer Set

This field is a required field. Choose the module's default object renderer set from the drop-down. It will be the fallback object renderer set. Object renderer sets can be configured in admin snap-in Module configuration/{module}/Object renderer set (more details).

# Layout Set

If required, you may assign a default layout set for this module. It will be the fallback layout set. Layout sets can be configured in admin snap-in Module configuration/{module}/Layout set (more details).

If enabled, a real-time search is performed with each new character input. Thus, search results will show live while entering a search term.

Please note: If search queries take too long in a module, disabling real-time search may help.

# Personal Settings

If set to "true", this module will appear in a user's personal system settings (via Profile/System settings).
Here, a user can click a module to get to see and edit all available presets for the selected module.

Request missing documentation