Interface Customizing New from S 39.5.4

Create New Mapping Function

• Mapping functions are stored under ppms.interface and must be importable.
• The ppms.interface package provides three basic class: BaseConverter, BaseEnricher as well as BaseValidator.

Parameter

• Each class possesses the PARAMETERS class attribute. Here, a dictionary the key value pair of which shows the parameters with the help of which this interface component can be configured is expected.
• Here, the key is the text displayed to the user and the value is the default setting.
• The value of own parameters can be accessed within the instance via the parameters attribute.

Example

• Here, a validator is defined, that checks whether the transferred value equates to the configured value. For this purpose, a key value pair is defined in the PARAMETERS class attribute, the key of which is the text "value" and has no default value.
• The configured parameters are accessed via the self parameters within the check method. As a result, the value of the value parameter is opened.
• Afterwards it is checked whether the transferred value equates to the configured value.

from ppms.interface import BaseValidator, InvalidRecordException

class Equals(BaseValidator):
    PARAMETERS = {'value': ''}
    
    def check(self, value):
        check_value = self.parameters['value']
        
        if value != check_value:
            raise InvalidRecordException('"%s" is not equal to "%s"' % (value, check_value))

Create New Validator

• Create a new file at ppms.interface and define a new class that inherits from BaseValidator.
• Here, the check(self, parameter) method must be implemented.
• The method must throw the InvalidRecordException if the validation has failed.

Example: Validator, that checks whether a particular task exists

from ppms.interface import BaseValidator, InvalidRecordException

class TaskExists(BaseValidator):
    PARAMETERS = {'project': ''}
    
    def check(self, value):
        pr_id = self.parameters['project']
        
        task_record = ppms.search_record(463, [pr_id, task_id], [1097, 1098], True)
        
        if task_record is None:
            raise InvalidRecordException('There is no task "%s" in project "%s"' % (task_id, pr_id))

Create New Enricher

• Create a new file at ppms.interface and define a new class that inherits from BaseEnricher.
• Here, the enrich(self, parameter) method must be implemented.
• The method must return the edited value.

Example: Enricher for replacing a text by another one.

from ppms.interface import BaseEnricher

class Replacer(BaseEnricher):
    """Gives access to the str.replace function"""
    PARAMETERS = {'old_value': '',
                  'new_value': ''}
    
    def enrich(self, arg):
        return arg.replace(self.parameters['old_value'], 
                           self.parameters['new_value'])

Create New Converter

• Create a new file at ppms.interface and define a new class that inherits from BaseConverter.
• Here, the convert(self, parameter) method must be implemented.
• The method must return the converted value.

Example: Converter for converting a text to upper-case letters

from ppms.interface import BaseConverter

class ToUppercase(BaseConverter):
    def convert(self, value):
        return value.upper()

Create New Module Class

• The module classes implement individual transfer logic and constitute dock points to other systems.
• Each module class to be used for the interface must inherit from the BaseInterfaceModule class.
• The module class parameters work the same way as the interface component parameters.
• The basic class defines 6 methods, 3 for import and 3 for export.

Create New Pool Table

Notes

Data item	DI Python ID	SQL ID	Column type	DB length	DF length	Miscellaneous
Interface configuration	config_id	CONFIG_ID	UUID	16	36	filter criteria to DT560
Status	status	STATUS	Number without decimal place, up to 4 places	2	2
Transferred on	transferred_on	TRANSFERRED_ON	Alpha	80	80