Module Category defines a new menu item, which opens a page with list of objects of certain type.
Configuration is via page
Use Case Example
You have some Model Objects, which would be normally listed under , but because they are strongly related to your functionality configured in another application module (e.g. Actionable Insights), you would like to provide easy access to users by providing special menu item under your module, which would display list of the objects you need.
Fields
(String) Name of this category. Must be unique within the partition.
module(Application Module) Under which module menu will this menu item appear.
label(String) Label of the menu item, as displayed to the end-user.
objectsTypeCodeTypeCode of the objects, which will be listed on the list page. Supported types are Model Object (MO) and Custom Form (CFO).
path(String) Path to be used in the URL. Can be also used to refer this menu item from links. Limit chars used to lower case letters, no spaces, possibly "" and "-". For example, if you define the value as "cfo_mca", and module to _Pricefx Processes, then the URL will contain "/processes/cfo_mca".
elementsUserGroupViewDetails(Comma separated list of user groups unique names.) Users can view elements in this category but not edit them.
elementsUserGroupEdit(Comma separated list of user groups unique names.) Users can edit elements in this category but not create/delete them.
elementsUserGroupManage(Comma separated list of user groups unique names.) User can create/edit/delete elements in this category.
Associating Elements to a Module Category
Once a Module Category is defined for a given element type (defined by the objectsTypeCode field), any element type (e.g., MC, CFOT) can be associated to that Module Category by setting their moduleCategoryUN field to the unique name of the Module Category.
Any elements of that type will then appear in the MCA instead of their usual place.
User will be able to create elements of that type only in that MCA.
Access Rights Details
Effective user access rights for elements like Model or Custom Form are evaluated from top to bottom:
-
Role
-
Module Category user groups
-
Element Type user groups (where applicable)
-
For Custom Form Type, see Custom Form > Access Entitlement
-
-
Element user groups (where applicable)
-
For Custom Form, see Custom Form > Access Entitlement
-
The lower you go, the more restrictive the access rights are, because the effective rights of certain level are an intersection of the level rights with the rights of the upper levels too.
For example, if you will have a Module Category page with list of Custom Forms of certain Custom Form Type, then the access to the particular Custom Form will be driven by intersection of all the rights, i.e. Role, Module Category groups, Custom Form Type groups and also by the groups of Custom Form itself.