The Module Maintenance option is one of the Module Administration options located on the Menu/Admin command list. It is used to configure the individual modules which will be made available selectively to various users and on various eSeries pages. The Module Maintenance option allows you to specify the refresh rate and the cache controls for example, and to control whether end users can close or hide the modules once it has been made available to them.
Entries made can be updated using the Update button
on
the toolbar. Help for the individual fields in the program is provided
below.
ID: Each module is identified by a unique code. The F9 Lookup key can be used to select an existing module.
Title: Enter the module title. Variables such as {$username}, {$fullname}, {$environment_name}, {$environment_description} can be used to call up the relevant data for incorporation in the title at run time.
Description: Enter a description for the module to give an account of the functionality it provides.
Module URL: Enter the URL to be used to retrieve the module content.
Maintain URL: This URL points to an additional address which may be required by the module. It would be used to store a link to Favourites Management in the Favourites module or to point to a URL which allows the module to be configured in some way.
Help Link: A link can be entered here to any user-defined help which you may have made available for the module.
Refresh: Specifies the number of minutes after which the module should automatically refresh its own data. The refresh time is applicable only when the enabled checkbox is selected. The refreshing of a module is a background process; the complete page will not be refreshed. (Refer to the Page Maintenance program for options for complete page refresh).
Cache: If this box is checked, the module content is cached for the number of minutes specified in the Refresh field. If the box is cleared, the module data is always refreshed during each request. The cache settings are user specific.
Hide: If this box is checked, users will be able to hide (minimise) and show (maximise) the module within each page.
Close: If this box is checked, end users will be able to close the module from any page.
Active: If this box is cleared, the inactive module will not be available to add to pages and any previously included modules on the page will no longer be displayed.
Administration Module: If this box is checked, the module will be available only to administrators.
Note User Settings can be used to lock pages to prevent users from adding, moving or closing any module. They also determine what page should be displayed initially when users log on - typically a Home Page created specifically for the user.