Manipulate Modules from Sidebar Nav

Scott King — Thu, 29 Sep 2022 18:44:31 GMT

Current Revision posted to Dev Tutorials by Scott King on 9/29/2022 6:44:31 PM

A common use case for creating a custom module-list layout is to alter the list of modules that appear across the top Mega Menu and More Modules layouts. This can still be accomplished with the sidebar-nav layout, but as you may have guessed, your customization will need to be moved to a different layout. By default, the list of modules in sidebar is built in the sidebar-nav-item-group-modules layout.

Example: Hide Contacts Module for Non-Admin Users

If you had a previous custom layout to hide the Contacts module for non-admin users, it may have been similar to this:

./custom/clients/base/layouts/module-list/module-list.js

({
    extendsFrom: 'ModuleListLayout',
    
    initialize: function(options) {
        this._super('initialize', [options])
    },

    _addDefaultMenus: function() {
        var moduleList = app.metadata.getModuleNames({filter: 'display_tab', access: 'read'});
        
        if (app.user.get('type') !== 'admin'){
            moduleList = _.filter(moduleList, m => { if(m !== 'Contacts') return m });
        }

        _.each(moduleList, function(module) {
            this._addMenu(module, true);
        }, this);
    },
})

As mentioned, these changes are now home in a new layout: ./clients/base/layouts/sidebar-nav-item-group-modules. Using a similar pattern as above, we can hide this module in the sidebar-nav layout.

({
    extendsFrom: 'SidebarNavItemGroupModulesLayout',

    initialize: function(options) {
        this._super('initialize', [options])
    },

    _getDefaultModuleList: function() {
        let moduleList = app.metadata.getModuleNames({filter: 'display_tab', access: 'read'});

        if (app.user.get('type') === 'admin'){
            moduleList = _.filter(moduleList, m => { if(m !== 'Contacts') return m });
        }

        return _.without(moduleList, 'Home');
    },
})

Once these changes are added, you can run a Quick Repair and Rebuild and the list of modules will be updated.

Note: You may need to refresh the page to see the profile menu items removed.

Manipulate Modules from Sidebar Nav

Scott King — Tue, 27 Sep 2022 18:49:07 GMT

Revision 8 posted to Dev Tutorials by Scott King on 9/27/2022 6:49:07 PM

Example: Hide Contact Module for Non-Admin Users

If you had a previous custom layout to hide the Contacts module for non-admin users, it may have been similar to this:

./custom/clients/base/layouts/module-list/module-list.js

({
    extendsFrom: 'ModuleListLayout',
    
    initialize: function(options) {
        this._super('initialize', [options])
    },

    _addDefaultMenus: function() {
        var moduleList = app.metadata.getModuleNames({filter: 'display_tab', access: 'read'});
        
        if (app.user.get('type') !== 'admin'){
            moduleList = _.filter(moduleList, m => { if(m !== 'Contacts') return m });
        }

        _.each(moduleList, function(module) {
            this._addMenu(module, true);
        }, this);
    },
})

({
    extendsFrom: 'SidebarNavItemGroupModulesLayout',

    initialize: function(options) {
        this._super('initialize', [options])
    },

    _getDefaultModuleList: function() {
        let moduleList = app.metadata.getModuleNames({filter: 'display_tab', access: 'read'});

        if (app.user.get('type') === 'admin'){
            moduleList = _.filter(moduleList, m => { if(m !== 'Contacts') return m });
        }

        return _.without(moduleList, 'Home');
    },
})

Once these changes are added, you can run a Quick Repair and Rebuild and the list of modules will be updated.

Note: You may need to refresh the page to see the profile menu items removed.

Manipulate Modules from Sidebar Nav

Scott King — Tue, 27 Sep 2022 18:48:07 GMT

Revision 7 posted to Dev Tutorials by Scott King on 9/27/2022 6:48:07 PM

A common use case for creating a custom module-list layout is to alter the list of modules that appear across the top Mega Menu and More Modules layouts. This can still be accomplished with the sidebar-nav layout, but as you may have guessed, your customization will need to be moved to a different layout. By default, the list of Modules in sidebar is built in the sidebar-nav-item-group-modules layout.

Example: Hide Contact Module for Non-Admin Users

If you had a previous custom layout to hide the Contacts module for non-admin users, it may have been similar to this:

./custom/clients/base/layouts/module-list/module-list.js

({
    extendsFrom: 'ModuleListLayout',
    
    initialize: function(options) {
        this._super('initialize', [options])
    },

    _addDefaultMenus: function() {
        var moduleList = app.metadata.getModuleNames({filter: 'display_tab', access: 'read'});
        
        if (app.user.get('type') !== 'admin'){
            moduleList = _.filter(moduleList, m => { if(m !== 'Contacts') return m });
        }

        _.each(moduleList, function(module) {
            this._addMenu(module, true);
        }, this);
    },
})

({
    extendsFrom: 'SidebarNavItemGroupModulesLayout',

    initialize: function(options) {
        this._super('initialize', [options])
    },

    _getDefaultModuleList: function() {
        let moduleList = app.metadata.getModuleNames({filter: 'display_tab', access: 'read'});

        if (app.user.get('type') === 'admin'){
            moduleList = _.filter(moduleList, m => { if(m !== 'Contacts') return m });
        }

        return _.without(moduleList, 'Home');
    },
})

Run a Quick Repair and Rebuild to see these new changes.

Note: A refresh may be required.

Manipulate Modules from Sidebar Nav

Rafael Fernandes — Tue, 27 Sep 2022 13:58:06 GMT

Revision 6 posted to Dev Tutorials by Rafael Fernandes on 9/27/2022 1:58:06 PM

Hide Modules from the Module List

scott to work on an example.

({
    extendsFrom: 'ModuleListLayout',
    
    initialize: function(options) {
        this._super('initialize', [options])
    },

    /**
     * Adds all default menu views as components in both full and short
     * version.
     *
     * This will set the menu as sticky to differentiate from the others that
     * are added based on navigation/reference only.
     *
     * @private
     */
    _addDefaultMenus: function() {

        var moduleList = app.metadata.getModuleNames({filter: 'display_tab', access: 'read'})
        
        if (app.user.get('type') !== 'admin'){
            moduleList = _.filter(moduleList, m => { if(m!=='ADR_Administrador' && m!=='ACC_Accesos' && m!=='POL_Policies') return m })
        }

        _.each(moduleList, function(module) {
            this._addMenu(module, true)
        }, this)
    },
})

({
    /**
     * @copyright: redk - Get further, together
     * @author: Maria Samuels maria.samuels@redk.net
     * @jira: FIDSUPP-118
     */
    extendsFrom: 'ModuleMenuView',

    /**
     * Filters menu actions by ACLs for the current user.
     *
     * @param {Array} meta The menu metadata to check access.
     * @return {Array} Returns only the list of actions the user has access.
     */
    filterByAccess: function (meta) {

        var result = this._super('filterByAccess', [meta]);
        var spliceIdx = null;
        _.each(result, function (menuItem, idx) {
            if (menuItem.acl_action === 'product-massupdate'
                && app.user.get('type') !== 'admin'
                && !_.contains(app.user.get('roles') , 'Mass Update Products on RLIs')
            ) {
                spliceIdx = idx;
            }
        });
        if (!_.isNull(spliceIdx)) {
            result.splice(spliceIdx, 1);
        }

        return result;
    },
})

Manipulate Modules from Sidebar

Rafael Fernandes — Tue, 27 Sep 2022 13:56:16 GMT

Revision 5 posted to Dev Tutorials by Rafael Fernandes on 9/27/2022 1:56:16 PM

Hide Modules from the Module List

scott to work on an example.

({
    extendsFrom: 'ModuleListLayout',
    
    initialize: function(options) {
        this._super('initialize', [options])
    },

    /**
     * Adds all default menu views as components in both full and short
     * version.
     *
     * This will set the menu as sticky to differentiate from the others that
     * are added based on navigation/reference only.
     *
     * @private
     */
    _addDefaultMenus: function() {

        var moduleList = app.metadata.getModuleNames({filter: 'display_tab', access: 'read'})
        
        if (app.user.get('type') !== 'admin'){
            moduleList = _.filter(moduleList, m => { if(m!=='ADR_Administrador' && m!=='ACC_Accesos' && m!=='POL_Policies') return m })
        }

        _.each(moduleList, function(module) {
            this._addMenu(module, true)
        }, this)
    },
})

({
    /**
     * @copyright: redk - Get further, together
     * @author: Maria Samuels maria.samuels@redk.net
     * @jira: FIDSUPP-118
     */
    extendsFrom: 'ModuleMenuView',

    /**
     * Filters menu actions by ACLs for the current user.
     *
     * @param {Array} meta The menu metadata to check access.
     * @return {Array} Returns only the list of actions the user has access.
     */
    filterByAccess: function (meta) {

        var result = this._super('filterByAccess', [meta]);
        var spliceIdx = null;
        _.each(result, function (menuItem, idx) {
            if (menuItem.acl_action === 'product-massupdate'
                && app.user.get('type') !== 'admin'
                && !_.contains(app.user.get('roles') , 'Mass Update Products on RLIs')
            ) {
                spliceIdx = idx;
            }
        });
        if (!_.isNull(spliceIdx)) {
            result.splice(spliceIdx, 1);
        }

        return result;
    },
})

Manipulate Modules from the Module List

Rafael Fernandes — Tue, 27 Sep 2022 13:55:58 GMT

Revision 4 posted to Dev Tutorials by Rafael Fernandes on 9/27/2022 1:55:58 PM

Hide Modules from the Module List

scott to work on an example.

({
    extendsFrom: 'ModuleListLayout',
    
    initialize: function(options) {
        this._super('initialize', [options])
    },

    /**
     * Adds all default menu views as components in both full and short
     * version.
     *
     * This will set the menu as sticky to differentiate from the others that
     * are added based on navigation/reference only.
     *
     * @private
     */
    _addDefaultMenus: function() {

        var moduleList = app.metadata.getModuleNames({filter: 'display_tab', access: 'read'})
        
        if (app.user.get('type') !== 'admin'){
            moduleList = _.filter(moduleList, m => { if(m!=='ADR_Administrador' && m!=='ACC_Accesos' && m!=='POL_Policies') return m })
        }

        _.each(moduleList, function(module) {
            this._addMenu(module, true)
        }, this)
    },
})

({
    /**
     * @copyright: redk - Get further, together
     * @author: Maria Samuels maria.samuels@redk.net
     * @jira: FIDSUPP-118
     */
    extendsFrom: 'ModuleMenuView',

    /**
     * Filters menu actions by ACLs for the current user.
     *
     * @param {Array} meta The menu metadata to check access.
     * @return {Array} Returns only the list of actions the user has access.
     */
    filterByAccess: function (meta) {

        var result = this._super('filterByAccess', [meta]);
        var spliceIdx = null;
        _.each(result, function (menuItem, idx) {
            if (menuItem.acl_action === 'product-massupdate'
                && app.user.get('type') !== 'admin'
                && !_.contains(app.user.get('roles') , 'Mass Update Products on RLIs')
            ) {
                spliceIdx = idx;
            }
        });
        if (!_.isNull(spliceIdx)) {
            result.splice(spliceIdx, 1);
        }

        return result;
    },
})

Hide Modules from the Module List

Rafael Fernandes — Tue, 27 Sep 2022 13:42:16 GMT

Revision 3 posted to Dev Tutorials by Rafael Fernandes on 9/27/2022 1:42:16 PM

Hide Modules from the Module List

scott to work on an example.

({
    extendsFrom: 'ModuleListLayout',
    
    initialize: function(options) {
        this._super('initialize', [options])
    },

    /**
     * Adds all default menu views as components in both full and short
     * version.
     *
     * This will set the menu as sticky to differentiate from the others that
     * are added based on navigation/reference only.
     *
     * @private
     */
    _addDefaultMenus: function() {

        var moduleList = app.metadata.getModuleNames({filter: 'display_tab', access: 'read'})
        
        if (app.user.get('type') !== 'admin'){
            moduleList = _.filter(moduleList, m => { if(m!=='ADR_Administrador' && m!=='ACC_Accesos' && m!=='POL_Policies') return m })
        }

        _.each(moduleList, function(module) {
            this._addMenu(module, true)
        }, this)
    },
})

({
    /**
     * @copyright: redk - Get further, together
     * @author: Maria Samuels maria.samuels@redk.net
     * @jira: FIDSUPP-118
     */
    extendsFrom: 'ModuleMenuView',

    /**
     * Filters menu actions by ACLs for the current user.
     *
     * @param {Array} meta The menu metadata to check access.
     * @return {Array} Returns only the list of actions the user has access.
     */
    filterByAccess: function (meta) {

        var result = this._super('filterByAccess', [meta]);
        var spliceIdx = null;
        _.each(result, function (menuItem, idx) {
            if (menuItem.acl_action === 'product-massupdate'
                && app.user.get('type') !== 'admin'
                && !_.contains(app.user.get('roles') , 'Mass Update Products on RLIs')
            ) {
                spliceIdx = idx;
            }
        });
        if (!_.isNull(spliceIdx)) {
            result.splice(spliceIdx, 1);
        }

        return result;
    },
})

Hide Modules from the Module List

Rafael Fernandes — Fri, 23 Sep 2022 18:58:06 GMT

Revision 2 posted to Dev Tutorials by Rafael Fernandes on 9/23/2022 6:58:06 PM

Hide Modules from the Module List

scott to work on an example.

Hide Modules from the Module List

Rafael Fernandes — Tue, 20 Sep 2022 19:08:47 GMT

Revision 1 posted to Dev Tutorials by Rafael Fernandes on 9/20/2022 7:08:47 PM

Hide Modules from the Module List