The Module Categories page enables you to configure new menu subitems under existing modules leading to a page where Model Objects or Custom Forms of the same category will be listed.

For example, when you use Actionable Insights, you want to be able to quickly access the Watchers page from the Actionable Insights module menu. On this page, you create a new category Watchers and select Actionable Insights as the module under which the Watchers menu item will be available.

Open

Create a Module Category

1. Go to Administration > Configuration > System Configuration > Module Categories and click the New Category button.

2. Give the new Category a name and optionally also a label. If label is not set, the menu item will use the unique name.

3. Add translations for the label in singular and plural forms. The singular is used for button labels like Create New or Save. The plural is used in menu items, label/title of the list page and in breadcrumb navigation. You must enter at least the singular for the default locale (the one with null value in the Locale column).

4. Select the preferred Type:

   • Model Object – If selected, this module category will be available for selection when creating a Model Class.

   • Custom Forms – If selected, this module category will be available for selection when creating a Custom Form Type.

5. Enter a Path (the part of the URL identifying this category). The object list page will be available at the URL /module-path/category-path.

6. Select a Module under which the Module Category will be listed in the application menu.

7. Optionally select user groups for which the elements in this Module Category will be visible/editable. See User Group Entitlements in Module Categories below.

8. Click Add.

When you select a Module Category, the following actions are available:

• Edit

• Duplicate

• Delete

User Group Entitlements in Module Categories

The user group entitlement settings on the Module Categories page do not set accessibility of module categories on this page, they are visible and editable to all users with the General Admin role. The purpose of the settings here is to enable/disable access to the elements that belong to the Module Categories.

If restrictions are set, users belonging to at least the view group, will be able to see the elements and their menu (see the image above).

There are three user group settings available for a Module Category:

• Manage Elements – Users can add, edit and delete elements belonging to this Module Category.

• Edit Elements – Users can edit elements belonging to this Module Category but cannot delete them or add new ones.

• View Elements – Users can only see the elements belonging to this Module Category – no editing is allowed.

The general entitlement concept rules apply but possible combinations with user group settings on the level of Custom Form Type and Custom Form or Model Class and Model Object have to be taken into account.

• If you have manage/edit access to a Module Category then you can manage/edit all Custom Forms whose Type is associated with that Module Category.

  • Except if there is a User Group (Can Use) set on the Custom Form Type for a group that you are not in then you cannot see the Custom Forms of that Custom Form Type.

  • Except if there is a User Group (Edit) set on the Custom Form for a group that you are not in then you cannot edit, only view that Custom Form.

• If you only have view access to a Module Category then you can view but not edit all Custom Forms whose Custom Form Type is associated with that Module Category.

  • Except if there is a User Group (Can Use) set on the Custom Form Type for a group that you are not in then you cannot see the Custom Forms of that Custom Form Type.

  • Except if there is a User Group (View Details) set on the Custom Form for a group that you are not in then you cannot see that Custom Form.

Accessibility rules for Models / Model Classes are similar.

• If you have manage/edit access to a Module Category then you can manage/edit all Model Objects whose Model Class is associated with that Module Category.

  • Except if there is a User Group (Manage Elements) set on the Model Class for a group that you are not in then you cannot add or delete the Model Objects of that Model Class.

  • Except if there is a User Group (Edit Elements) set on the Model Class for a group that you are not in then you cannot edit the Model Objects of that Model Class.

  • Except if there is a User Group (View Elements) set on the Model Class for a group that you are not in then you cannot see the Model Objects of that Model Class.

• If you only have view access to a Module Category then you can view but not edit all Model Objects whose Model Class is associated with that Module Category.

  • Except if there is a User Group (Manage/Edit Elements) set on the Model Class for a group that you are not in then you cannot see the Model Objects of that Model Class.

  • Except if there is a User Group (View Elements) set on the Model Object for a group that you are not in then you cannot see that Model Object.