Modules MOD000855

Access

• Customizer → Module Customizer → Modules → Modules
• Menu items: Tools → Edit activated module (F9) → confirm the Load customizing for activated module? → Modules

In this module it is possible to

• create a new module
• edit module parameters
• create data areas, assign them to the module or delete the assignment
• edit the data area assignment parameters
• structure data areas
• assign submodules in order to customize module panels
• edit submodule parameters
• delete modules

Module Header

Module parameters (in the module header)

• In the module header, different important module parameters can be edited.
  • Further module parameters can be consulted and edited via the Open further module parameters button.
• In the Standard MV or User MV fields, the number of standard or user module variants of the respective module is displayed.
  • Via the links on the fields, the respective module variants can be viewed in the Module Variants module.
• In the Work area field, the number of work areas to which the module is assigned is displayed.
  • Via the link on the field you can view the work areas in the Use module variant can be.

Buttons (in the module header)

• Via Start module, the module which is displayed here in the customizer can be opened in the user view.
• Via Set data area positions, the positions and parent areas of the data areas are automatically set in accordance with the previously created structure. For further information, see the Structure Data Areas chapter.
• Via Show other module parameters you can open the Other Module Parameters module in which you can edit module parameters other than those already displayed in the form.
• Via Edit Python macro you can open the Python Macros module in which the Python macro of the module, if there is one, is displayed. If there is no Python macro in the module yet, click on the Insert template button which causes a template macro to be copied in automatically. For further information, see here.
• Via Edit Python macro in editor, an editor is opened.
  • Here, the behavior equates to that of the Edit Python macro button:
    • If a Python macro already exists, it will be displayed in the editor.
    • If there is no Python macro yet, click on the Insert template button to insert the default macro. Proceed as described above.
    • If no Python editor is stored in the Global Settings, the following message is displayed when you click on the button: Please define an editor!
    • If a wrong editor is specified, the Error executing python script: The system cannot find the specified file. message will be displayed.

Context Menus

Context menu on the module

• By right-clicking on the module header you can carry out the following actions:
  • Edit the Python module subclass via the eponymous context menu command.
    • If a python module subclass has been selected on the field of the same name, it is opened in the corresponding editor.
    • If no Python module subclass has been selected, you will be asked to name and therefore create a new subclass.
  • Via the context menu command of the same name, assign the module in the Assign Work Area module to a work area.
    • Tip: Alternatively you can directly assign the module to a work area via the Insert → WOrk area/module context menu in the Use module.
  • The Check use entry provides a means to check the use of the module.
    • When you select the command, a dialog message will be displayed asking you to select the area to be checked for use.
    • Afterwards, the respective data will be opened in the Object Use module.

Context menu on a data area

• By right-clicking on the required data area and selecting the respective command,
  • you can open and edit the respective data area in the Data Areas module. 
    • If you want to edit multiple data areas at once,
      • mark the data areas in question,
      • right-click on one of the marked records,
      • select Edit data area.
      • All marked areas will be opened in the Data Areas module where they can be edited.
  • see the data area use in the Data Area Use module of the same name.
    • The Data Area Use module can also be opened via the link on the UF field.

Note

• If you open the listbox on the MOD field in the empty Modules module, all modules and macros that have been created within the last 30 days, or for which changes have been made to the following areas, are displayed: header data (DT405), submodule assignments (DT404), data area assignments (DT406), data areas (DT410), and data fields (DT411).

Module Variants

Create a New Module

Procedure

• Enter a title for the new module in the Module field and save. A new ID number for the new module will be allocated automatically.
• The Class parameter is automatically filled with value 4 "Normal" data editing, which means that the module to be created is a normal user module. For the creation of special modules, e.g. a user menu module or a dialog module, the value must be changed accordingly.

Create a new module by copying

Information

• Alternatively, a module can be created by creating a copy of an already existing module. As a result, you generate a 1:1 copy of the source module.

 Procedure

• Enter the the ID of the user module to be copied to the Copy from data field in the Modules module (e.g. 0099JB for the Project Core Data module).
• By pressing ENTER, a new module ID will be generated in the MOD data field.
• Enter the new module title in the Module data field.
• Save. Upon saving, all parameters of the source module as well as its subobjects (submodules, data areas, module variants) are copied to the new module.

Edit Module Parameters

Information

• The module header contains some module parameters which must be set in accordance with the function to be customized.
• You will find further module parameters in the Other Module Parameters auxiliary module which can be opened by clicking on the eponymous button at the right margin of the module header.
• For a description of all module parameters, please click here. 

Create New Data Area

Procedure

• Right-click on the module header, or, if a module already has data areas, right-click in the line of one of the assigned data areas and select Insert → Data area assignment from the context menu.
  • A blank data area assignment record will be inserted.
• Click on the No name link.
  • The Data Areas module will be opened.
• Click on the 000 link next to the Data table field in the Data Areas module.
• The Data Dictionary module will be opened next to it.
• Enter or select the data table number of the data table the data of which you want to have in the DT field, e.g. DT461
  • All data items of the data table will then be displayed.
• Copy the ID number of the data item the data of which you want to be contained in the area to the DDI data field in the Data Areas module via Drag&Drop or enter the number manually.
  • In the Data Areas module, an ID number for the new data area will be generated automatically. 
• Save.

By carrying out the steps described above, a valid data area is created, however, it will still be empty. It must be filled with data fields (columns). For the procedure, please refer to the description of the  Data Areas module. A newly created data area must now be assigned to the module.  You can either do this now, while the data area is still empty, or after you have filled it with data fields. For more information on this subject, see the following chapter:

Assign a Data Area

 If a new data area has been created from the Modules module before, the following procedure applies:

• Copy the ID number of the newly created data area via Drag&Drop to the blank line in the DA field (which was inserted in the Modules module before).
• Define the position of the new data area within the module by entering the respective number in the data area assignment line in the Pos. parameter. Enter 1 for the first record.
  • If no data area position is defined and the module is started, the following message will be displayed: Module-area assignments not found.
  • Each data area which is additionally assigned must also receive a position number.
• Save.

If you want to insert an existing data area in an existing module, please proceed as follows:

• Right-click on the module header, or, if a module already has data areas, right-click in the line of one of the assigned data areas and select Insert → Data area assignment from the context menu.
  • A blank data area assignment record will be inserted.
• Enter the ID number of the required data area in the DA field.
• Define the position of the new data area within the module by entering the respective number in the data area assignment line in the Pos. parameter.
• Save.

Edit Data Area Assignment Parameters

Information

• The Modules module contains several parameters for each data area assignment which serve to define how the data area in question behaves within the user module to be edited. Besides the afore mentioned Pos. parameter which defines the position of the data area in the module, you can also define here
  • whether new records can be inserted in the corresponding area in the user module (Create and Insert checkboxes) or
  • whether deletion is allowed in the area (Delete checkbox) or
  • whether the area is visible to the user in the first place (Never show checkbox), etc. 
• Further parameters are contained in the invisible window (window 9) and can be unhidden for editing. For a description of all data area assignment parameters, please click here.

Structure Data Areas

If you assign multiple data areas to a user module and define their positions, their data would be displayed at the same level in the set order below one another in the user module. If you want to have the data in a module displayed hierarchically (e.g. if a module contains project and task data you want all tasks to be displayed under the corresponding project instead of the projects being displayed first and then all tasks), you should structure data areas in the module customizing.

Procedure 1

• In order to structure data areas, enter the position number of the parent area in the Parent area parameter for each data area except the first one.
• Save and refresh the display.
• All data areas are displayed indented, according to their defined position, so that the structure of the user module is immediately visible in the customizing module as well.

Procedure 2

• In order to structure the data areas, drag the data area assignment lines via the Drag&Drop move mimic (SHIFT + drag while holding down the left mouse button and release on or below the desired data area) to the desired position, so that the required structure becomes visible.
• Subsequently, click on the Set data area position button. As a result, the Pos. and Parent area parameters of the data areas will be set automatically in accordance with the previously created structure.
• Save.

Customize Module Panels

• In the Modules customizing module you can customize module panels. For a description of the procedure, see here.

Delete Module

• Mark the module via CTRL + click on the module title.
• Click on the Delete  button in the toolbar or select the Edit → Delete menu item.
  • The module and its assignments (data area and submodule assignments) will be deleted.
  • The data areas and submodules themselves will be retained.

Delete Data Area Assignments

• Mark the requested data area via CTRL + click.
• Click on the Delete  button in the toolbar or select the Edit → Delete menu item.
  • Only the data area assignment will be deleted, the data area itself will be retained. If it is not assigned to a module it is displayed in the Data Areas Without Assignments module and can be deleted either there or in the Data Areas module.