Writing your own assignment module

Module customizing

• parent area: in this area the parent record(s) should be filtered e.g. in the PortfolioWatchlistAssignmentModule the portfolio is the parent
• source area: the area where all the child records are displayed in case of the PortfolioWatchlistAssignmentModule all projects that are assigned to the current portfolio
• assignment area: in this area new assignment records are created, the value of each data field is filled by looking for a matching datafield with the same python id in the parent or in the source area. If no matching python id is found the field will be ignored. The values can also be filled using a default value in the customizing of the data field.

In this example the assignment area looks like this:

• The project id and portfolio id are filled by looking up the values in the source and parent areas
  • In the source area there is a datafield with python id pr_id
  • The portfolio id on the other hand is not in the source area and thus will be filled from the parent area, which contains a datafield with the python id portfolio_id
• Because the records are inserted on mts level we can also use default values, in this example the watchlist that is edited is always from the currently logged in user, so we can use @1 as default value for the user_id

Necessary methods

• open_module_for_parents: This method opens the assignment module and should also do some checks:
  • Check that there is assignment data available using check_for_assignment_data
  • Make sure that all other criterias are met to make an assignment e.g. that a stakeholder record exists
  • If a check fails None should be returned and if the show_messages parameter is set it should also give a proper error message
• is_assigned: This method is necessary to check if a assignment already exists and needs to be implemented for each assignment individually
• id_field_py_id: This property should return the data field python id of the ID field by which a source record can be unambiguously identified, in the example bellow this is the project id
• make sure that the other properties match your customizing names and requirements

Example implementation from the PortfolioWatchlistAssignmentModule :

class PortfolioWatchlistAssignmentModule(AssignmentModuleBase):
    @property
    def no_data_available_message_id(self):
        return '1195'

    @classmethod
    def open_module_for_parents(cls, parents=None, show_messages=True, **kwargs):
        if parents and not isinstance(parents, list):
            parents = [parents]

        mod_obj = ppms.get_target_module()
        target = get_global_setting_value('edit_portfolio_watchlist', 'alpha120')
        with ppms.echo_disabled():
            target_mod_obj = mod_obj.open_module(target)
            target_mod_obj.set_current_L_var(16, parents)
            target_mod_obj.menu(MENU_FILTER)
            if not target_mod_obj.check_for_assignment_data(show_messages=show_messages):
                target_mod_obj.menu(MENU_CLOSE)
                return None
        return target_mod_obj

    @property
    def id_field_py_id(self):
        return 'pr_id'

    @staticmethod
    def is_assigned(parent_id, child_id):
        user = ppms.uvar_get('@1')
        assignment_record = ppms.search_record(534, [child_id, parent_id, user], ['uuid'])
        return bool(assignment_record)

Implementation for using marked records and working with radio buttons

Radio Buttons

• Create a normal yes/no type virtual dataitem
• Implement a value range which unchecks all other mts records in the processInput

Here is an example value range from the standard implementation:

def di065272_chosen_for_assignment_radio_checkInput(di, oldvalue):
    """This value range simulates a radio button."""
    records = di.get_dfs()[0].get_record().get_da().get_records()
    for record in records:
        if record.chosen_for_assignment_radio.get_raw_value():
            record.chosen_for_assignment_radio.set_raw_value(0)
    return di.get_value()

di065272_chosen_for_assignment_radio_checkInput.deps = ("",)

Marked records

Classes

AssignmentModuleBase

Methods

Classmethods

Staticmethods

Properties

Property	Getter	Setter	Description
AssignmentModuleBase.assignment_button_da_id			The data area python ID where the assignment button is located
AssignmentModuleBase.assignment_data_area			The data area python ID of the data area where the new assignment record is inserted
AssignmentModuleBase.button_df_id			The button data field ID of the assignment button
AssignmentModuleBase.checkbox_python_id			The python ID of the checkbox to mark source records
AssignmentModuleBase.id_field_py_id			The datafield python ID with which source records can be identified
AssignmentModuleBase.no_data_available_message_id			The message ID which is displayed when
AssignmentModuleBase.parent_data_areas			List of data areas where the data area python id starts with "parent"
AssignmentModuleBase.source_data_areas			List of data areas where the data area python id starts with "source"

RadiobuttonAssignmentModuleBase

Properties

Property	Getter	Setter	Description
RadiobuttonAssignmentModuleBase.checkbox_python_id			Datafield python id of the radio button

StakeholderAssignmentModuleBase

Staticmethods