Module options

A module is a structured document that is composed of multiple artifacts. These artifacts or content of the modules are stored by default in a folder which is created in the same directory as the module. In the Modules Options tab, an administrator can change this default to specify another folder to store the multiple artifacts of a module. You can use drag-and-drop to move one or more folders and re-organize them. If your project area has not been enabled for configuration management, an administrator can schedule a refresh of the module view to ensure that the latest module content is loaded from the data warehouse.

Before you begin

If you have configuration management enabled for your project, you must have JazzAdmin or JazzProjectAdmin permission to create and modify modules.

If you have configuration management enabled for your project, you must have JazzAdmin or JazzProjectAdmin or have the Create Component permission to create and modify module content folder behavior.

Procedure

  1. From the Administration menu Admin menu, click Manage Project Properties.
    Note: If configuration management is enabled for your project, on the Administration menu, click Manage Component Properties.
  2. Click the Modules Options tab.
  3. In the Module Content folder set the default location to where the artifacts of a module are stored. Select any one of the options:
    • Same folder as the module, to save the artifacts in the same folder as the module.
    • Specified folder, to save the artifacts in a different folder. When a folder is selected as the common content folder, it is displayed with a different icon Common module content in the folder hierarchy.
      Note: If the Folder Structure option is selected for templates (see Creating templates for requirements projects or components) and the Specified folder option is used, the module template is saved in the Specified folder .
  4. Click Save.
    Note:
    • The Module Content folder setting will only affect new modules. The location of the content folders for existing modules will not be changed when the setting is changed.
    • To include the Module Content folder setting when creating templates (see Creating templates for requirements projects or components), make sure to include the project or component Folder Structure in the template.
    • When you Import Project or Component Properties, the Module Content folder setting does not get imported.

    Considerations when selecting Specified folder for module content:

    • When a Specified folder is selected for module content, the content for all modules will be saved under the common folder. In order to provide organization to the common folder, when a module is created, its folder hierarchy will be duplicated under the common folder. Example of module content folder structure
      In this example, a common module content folder named Base Artifacts is used for module content artifacts. A module Account Subsystem is created under User Requirements within the Non-Functional Requirements folder. Within the common module content folder, the module’s folder hierarchy is duplicated and the module’s content folder Account Subsystem artifacts is created.
      Note:
      • The Base Artifacts folder is not available on the Modules or Collections tab. You can access the folder on the All tab.
      • The folder hierarchy will only be duplicated when the module is created. If a module is moved to another folder or if a folder containing modules is moved, the common folder hierarchy will not be updated.
      • When folders are duplicated under the common module folder, the folders are assigned the same team area as the original folders.
    • When a Specified folder is selected for module content, the folder cannot be deleted. If you want to delete the folder, either select another folder as the common content folder or select the Same folder as the module option.
    • When a Specified folder is selected for module content, any user that has permission to create modules will automatically have permission to create folders under the common content folder when a module is created.

Refresh Module Views

Before you begin

To schedule module view refreshing, you must have the Manage View Schedule permission.

About this task

If your project area has not been enabled for configuration management, you can schedule to Refresh Module Views. Module views are loaded as collections into the data warehouse during the ETL process. A view can become outdated if someone updates its contents without editing the view itself. In Refresh Module Views schedule when the system checks for updates each day.

Procedure

  1. From the Administration menu Admin, click Manage Project Properties.
  2. Click the Modules Options tab.
  3. Use Add Module View to list the module views that need to be checked and ensure that they contain the latest content. When you add a view to the list, it is shown only if it is unique to the module and is shared. See Filters and views in modules.

video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki