Skip to main content

Modules

What are modules?​

One can visualise Modules as a Package of Tables, Menus and Pages that are related to each other. For example - a CRM module is a package of CRM related tables, pages and menus.

This is particularly helpful in managing the information infrastructure (tables / pages / menus) based on functional usage. For example - if an organisation does not want to use the CRM module, then they can simply disable the CRM module, and all the associated information infrastructure will be disabled from the system.

For product developers this is especially handy to create 'suites' of sub-systems within Rapid that can be toggled via policy, such as customers purchasing add-ons.

Adding a module to the system​

Please follow the below steps to add a module to the system:

  1. Goto Designer
  2. Click on Maintenance in Designer Sidebar
  3. Select Modules

Image showing Modules option in Designer Sidebar

  1. The Modules page (as shown below) will appear.
  2. Click Add module.
  3. A section will appear with an module icon. Type the module title - say - CRM.
  4. Click the save icon.

Image showing how to add a new module to system

This will add a new blank module to the system. This new module will not have any associated tables / menus / pages. Observe by default the module is in Enabled state. However, you can toggle it to disabled state, as needed.

Image showing a new module added to system

Associating information infrastructure to Modules​

Tables​

You can easily associate tables to a module. Please follow the steps:

  1. Goto Designer
  2. Navigate to your desired table.

Image showing selection of table in designer

  1. In the Options Tab, observe the dropdown field "Part of module".

Image showing module association field on Options tab

  1. Click on Part of module field and select the desired module title.
  2. Click Save.

Image showing table association with module

That's it! the subject table is now associated with your desired module.

To associate menus to a module, consider the following:

  1. In Designer, navigate to your desired menu.
  2. Observe two fields both titled as - "Part of module"
    a. The field on top right corner of the menu screen, corresponds to all the menus in the page. b. The field at the bottom centre of the screen, corresponds to individual menu item.

Image showing two options to associate menu and menu item to a module

Therefore, if you wish to associate all the menus, click a. and associate all menus on the page. If you wish to associate selected menu items, then goto the desired menu item, click b. and select module as desired.

Pages​

To associate pages to modules, consider the following:

  1. In Designer, navigate to your desired page.
  2. Observe the field on top right corner of the screen - "Part of module".

Image showing option to associate page to a module 3. This is the dropdown field. Select your desired module with which you wish to associate the page.
4. Click Save.

Now all the components present on the page will get associated to the module.

Image showing page associated with a module

Component​

It is possible to associate a specific component (within a page) to a module.

  1. Navigate to the desired page in Designer.
  2. Click on the Edit (Pencil) icon on the component you desire to associate.

Image highlighting component edit option

  1. An edit panel will open. In the Edit panel, locate the field "Part of module".
  2. Select your desired module to associate the subject component.
  3. Click Save to close the Edit panel.
  4. Click to save the Page.

Image showing component association with module in Edit panel

This will associate only the subject component to the module.

Enabling / Disabling modules​

You can enable or disable modules by a toggle button. Please consider the following steps:

  1. Goto Designer
  2. In Designer Sidebar, click Maintenance
  3. Select Modules

Image showing how to access modules from designer sidebar

All the existing modules in the system will appear as tiles. Image showing all modules as tiles

  1. Toggle the state of the module to enable / disable it from the system.

Image showing how to toggle modules to enable / disable them

What happens when you toggle a module?​

Associated information infrastructure elements get enabled / disabled based on the state of the module.

To demonstrate how it works, we will take two modules - CRM (enabled state) and HR (disabled state) as shown above.

Table​

The below image shows three cases:

Case 1: The Table is not associated to any module.
Result - the table appears in the Explorer sidebar

Image showing table appears when not associated with any module

Case 2: The Table is associated with CRM module.
Result - the table appears in the Explorer sidebar as CRM is in enabled state.

Image showing table appears when associated with an enabled module

Case 3: The Table is associated with HR module.
Result - the table does not appear in the Explorer sidebar as HR is in disabled state.

Image showing table disappears when associated with a disabled module

Case 1: The menu list is not associated to any module.
Result - All menu items appear in the command bar (Explorer) as configured.

Image showing menus appear when not associated with any module

Case 2: The menu list is associated to CRM module.
Result - the menu items appear in the command bar (Explorer) as CRM is in enabled state.

Image showing menus appear when associated with an enabled module

Case 3: The menu list is associated to HR module. Result - the menu items does not appear in the command bar (Explorer) as HR is in disabled state.

Image showing menus disappear when associated with a disabled module

Case 1: The menu item is not associated to any module.
Result - All menu item appears in the command bar (Explorer) as configured.

Image showing menu item appears when not associated with any module

Case 2: The menu item is associated to CRM module.
Result - the menu item appears in the command bar (Explorer) as CRM is in enabled state.

Image showing menu item appears when associated with an enabled module

Case 3: The menu item is associated to HR module. Result - the menu item does not appear in the command bar (Explorer) as HR is in disabled state.

Image showing menu item disappears when associated with a disabled module

Page​

Case 1: The page is not associated to any module.
Result - Page displays as configured in Explorer.

Image showing page enabled when not associated with any module

Case 2: The page is associated to CRM module.
Result - The page displays as CRM is in enabled state.

Image showing page enabled when associated with an enabled module

Case 3: The page is associated to HR module. Result - The page is disabled as HR is in disabled state.

Image showing page disabled when associated with a disabled module

Component​

Case 1: The component is associated to CRM module.
Result - The component displays as CRM is in enabled state.

Case 2: The component is associated to HR module. Result - The component is disabled as HR is in disabled state.

Image showing how components are enabled and disabled when associated with an enabled or disabled module