Interface Library

MtsResourceModule

Note

• Both global and dynamic variables can be used in the parameters.
  • Using invalid variables leads to undefined behavior.

Python Module Subclasses

PPMSCSVModule

• Can write CSV files which can be read by PPMS 38.
  • The format of these CSV files looks as follows:

@BEGIN GLOBAL SEPARATOR ; ESCAPE @ @END GLOBAL @BEGIN MODULE MODULE @ @END MODULE wert_1;wert_2 wert_1;wert_2

MtsModule

• Sends and writes data in PLANTA using the Mts layer.
• All data that was sent from this module is of the strings type, and as a recipient, the module also expects all values to be strings.
• Data fields which occur in the mapping but are not available in the data area are ignored without warning.
• Data fields in window 9 are not filled.
• The module determines the table to which is imported on the basis of the DDI.
  • This info is used to identify the primary keys in this data area and to fill them first.
  • This behavior enables the update of existing records if the complete primary key is included in the delivery.
• Provides a field length check.
  • The field length check is not carried out for date fields.

Note

• MtsModule interprets the following input as valid values for checkboxes:
  • Deactivated: 'N', '@N', '0', '', 'FALSE'
  • Activated: 'Y', '@Y', '1', 'J', 'TRUE', 'X'

MtsProjectModule

• Sends and writes data in PLANTA using the Mts layer.
• All data that was sent from this module is of the strings type, and as a recipient, the module also expects all values to be strings.
• Data fields which occur in the mapping but are not available in the data area are ignored without warning.
• Data fields in window 9 are not filled.
• The module determines the table to which is imported on the basis of the DDI.
  • This info is used to identify the primary keys in this data area and to fill them first.
  • This behavior enables the update of existing records if the complete primary key is included in the delivery.
• Provides a field length check.
  • The field length check is not carried out for date fields.

MtsLiabilityModule

Function and use analogously to MtsModule except for the following differences:

• Upon data import, all liability values are cleared, i.e. the following DIs are set to 0 system-wide.
  • DI060503 Liability (DT282)
  • DI060189 Liability (DT281)
• The pool records which are imported by the interface are marked with a liability flag.
• Upon import, all pool records which are flagged as liability and have not yet been transferred are deleted. Values which have already been transferred remain in the pool for archiving.
• If all yearly tranches have been imported correctly, the following Dis are stamped:
  • DI064672 Date of last liability import
  • DI064673 Time of last liability import

MtsPoolModule

• Works like an MtsModule but stamps Status and Transferred on in DT 567.
• The module only works correctly if the pool table has been customized correctly (see Interface Customizing).

Information

• The constellation allows for a more flexible customizing. You can now import to a "technical" data area which contains the raw fields and is then exported from a processed data area which processes data using functions like grouping or summarization.

CSVModule

• Can read and write CSV files
  • It can only import files that can be accessed from the application server using the user which runs the PLANTA service.
• Here you can take a plain dummy data area with a field as a data area.
• If the module is used as a source module and the readheader parameter is 1, the source mappings correspond to the column names in the file.
  • If the parameter is 0, the position is used for column definition instead.
• If the module is used as a target module and the writeheader parameter is 1, the target mappings correspond to the column names in the file.
  • If the parameter is 0, the position is used for column definition instead.

Notes

• After a file has been imported successfully, the UUID of the interface configuration is written in the file name and the file is moved to the directory configured via archive_dir.
• If a CSV export is carried out, placeholders can be used in the filepath parameter in order to format a time stamp. The possible placeholders can be found in the Python documentation.

The most common encoding values are:

MultiCSVModule

Information

• This module subclass equates to the CSVModule module subclass.
• It only differs in the filepath parameter.
  • If several files are found, no error is displayed when using MultiCSVModule, but the files are imported/exported one by one in the sequence of their file names.

ClientCSVModule

Information

• This module subclass equates to the CSVModule module subclass.
  • In contrast to this module subclass, however, the filepath and archive_dir parameters do not exist here.
• Unlike the CSVModule, ClientCSVModule can import/export files which are accessible for the user that opens the PLANTA Client.

MtsLoadModule

• Imports load records and stamps them in the Imported on and Imported by fields (DT472 Loads).
• Exports load records and stamps them in the SAP status, Exported on and Exported by fields (DT472 Loads).

MtsExportPoolLoadModule

• Works like MtsPoolModule but additionally stamps SAP status, Exported on and Exported by (DT472 Loads).
• Can only be used for export interfaces.

MtsResourceModule

• Module subclass for the import of resources and their corresponding data (person, user, role, stakeholder)
  • Since currently the creation and update of resource data still make high demands on the module subclass, an import with the standard MtsModule presents some difficulties.
  • MtsResourceModule meets these demands and allows, e.g., for the batch-import of resource data.
• If you want to use an individual interface, you have to create a subclass of MtsResourceModule and adjust the PERSON_DA, ROLE_DA, RESOURCE_DA and STAKEHOLDER_DA class attributes to the customizing IDs of the respective data areas.
  • The standard MtsResourceModule points to the data areas of the Employee Import standard interface.
• If the ROLE_DA attribute points to a valid role data area, the 01100214 MP user and 01100225 Employee standard roles are assigned to users.
  • The roles assigned by default can be defined according to the customer’s requirements in the Standard roles for fast creation of employee template in the Global Settings module.

BAPIModule

Note

• If you want to customize an interface with BAPI connection, please contact your PLANTA consultant.

GermanHolidayImportModule

• Imports German holidays from a web service to PLANTA calendars. For more information, see Calendar.

AbsenceImportModule

• Imports absences in the period table
• Since the period table contains one record per day, the imported data is duplicated for each day between start_date and end_date (including start and end date).
• The absence_type column expects a numeric value which you can find in the table below.
• The values can be inserted using a mapping function like e.g. ConstantValue or Replacer.

ConversionFactorImport

Subclass of MtsModule which is able to update data in the conversion factor table.

• Parameters like MtsModule

BAPIProjectGetInfo

• Can only be used as a source module
• In parameters like BAPIModule with additional project_definition you have to enter the SAP project ID to import the WBS structure for this module.

BAPIBUS2054GetData

• Can only be used as a source module
• In parameters like BAPIModule with additional project_definition you have to enter the SAP project ID to import the WBS structure for this module.

Mapping Functions

Information

• The following mapping functions can be used according to the type.

Enricher

ConstantBoolValue

• Returns the true/false boolean value depending on the configuration
• Input value: is not considered
• Output value: boolean value (true/false)

VariableReader

• Reads the value from an arbitrary variable and returns it
• Input value: not relevant
• Output value: variable content

Slicer

• Enables you to apply the Slice function from Python to a value.
• This can be used in order to cut off parts of the text or to invert the text.
• Input value: text
• Output value: text

Replacer

• Replaces a value by another one
• Input value: text
• Output value: text

ConstantValue

• Returns a constant value
• Input value: is not considered
• Output value: text

Stripper

• Cuts off the specified signs before and after a value

LeftStripper

• Cuts off the specified characters at the beginning of a value.

RightStripper

• Cuts off the specified characters at the end of a value.

GetResAssignmentAttribute

• Returns the value of a DI from DT466 and writes a note in the log-file if it could not be found in DT466.
• Input value: is not considered
• Output value: text

GetPersonId

• Has been replaced by the validator ConvertResourceIdToPersonId

Concatenator

• Adds the configured string to the input value
• Input value: text
• Output value: text

Rounder

• Rounds the input value to the defined number of digits
• Input value: number
• Output value: text

GetResourceAttribute

• Returns the value of a DI from DT467 and writes a note in the log-file if it could not be found in DT467.
• Input value: is not considered.
• Output value: text

LeftPadder

• Extends the entered string on the left by the defined signs and sets the entire string to the defined length

Example

• Input string: "foo"
  • fillchar: \s
  • width: 5
• Output string: " foo"

RightPadder

• Extends the entered string on the right by the defined signs and sets the entire string to the defined length

Example

• Input string "foo"
  • fillchar: x
  • width: 5
• Output string: "fooxx"

DataitemReplacer

• Replaces the input value (in case it is empty) with the value of another data item
• Output value: input value (if not empty), otherwise the value of the specified data item

GetPLANTAIdFromExternalId

• Specifies the PLANTA UUID for the specified ID from an external system, provided that it is linked
• Input value: ID from an external system
• Output value: PLANTA UUID

GetValueFromUuid

• Specifies the value of a data item for a record with the specified UUID
• Input value: PLANTA UUID
• Output value: value of the data item

Converter

ToUppercase

• Changes a value to UPPER CASE LETTERS
• Input value: text
• Output value: text

ToString

• Changes a value to a text value
• Input value: arbitrary
• Output value: text

ToInt

• Changes a value to an integer
• Input value: arbitrary
• Output value: integer

ToFloat

• Changes a value to a floating point number
• Input value: arbitrary
• Output value: floating point number

StringToPLANTADate

• Converts a text into the PLANTA date format
• Input value: text
• Output value: integer

PLANTADateToString

• Converts the PLANTA date format into a text
• Input value: integer
• Output value: text

ConvertFunctionalProjectIDToTechnical

• Has no parameters and takes a functional project ID as a value and returns the technical project ID or None.

ConvertResourceIdToPersonId

• Returns the value of Person for the code which is passed as a value.
• Input value: a valid Code
• Output value: value of the Person field

ConvertTrailingSignToLeadingSign

• Has no parameters and converts a number, like e.g. 10- to -10

UnicodeNormalizer

• Uses compatible decomposition (NFKD) to convert the special signs that are not shown by PLANTA project into signs that can be displayed by PLANTA project.

ConvertPSPtoUUID

• Takes the "project" parameter and converts the passed WBS ID to a UUID.

ConvertValidFromToConversionFactorItemId

• Checks whether there is a record with the transferred date value for the respective conversion factor ID the Valid from value of which corresponds to the date. If it does, the position is returned (DI000343).

ConvertDateToYear

• Converts a date into a year.

ConvertProjectToAttribute

• Fetches the value from the configured DI for the specified project
• Input value: technical project ID
• Output value: text

ConvertPLANTAUserToPulseUser

• Returns the PLANTA pulse user for a PLANTA project user
• Input value: user code from DT511 (DI010323)
• Output value: PLANTA pulse ID of the user or None

ConvertPLANTAIdToPulseId

• Converts a PLANTA project UUID into a PLANTA pulse ID
• Input value: UUID
• Output value: PLANTA pulse ID of the object or None

ConvertResourceAssignmentUuidToPulseBoardId

• Converts the UUID of a resource assignment into the board ID of the task
• Input value: UUID of a resource assignment (DI060939)
• Output value: board ID of the task

ConvertToJiraField

• Converts the value into a json value which can be processed by Jira

ConvertSecondsToHours

• Converts seconds into hours and returns them as float

ConvertJiraIdToPLANTAId

• Converts a Jira ID into a PLANTA project UUID
• Input value: ID of a Jira object

ConvertUuidToAttribute

• Returns the value of the specified data item of a record with the specified PLANTA project UUID from the specified table
• Input value: UUID of a PLANTA project object

Validators

• All validators have two parameters:
  • child_when_invalid: Here, the name of one of the children of the validator can be entered. If the validator fails, only this child is carried out. If the validator is successful, the child_when_invalid string is ignored.
  • mark_record_as_invalid : If this parameter is at 1, the record is marked as invalid and is not transferred when the validator fails. If the parameter is at 0, only this column is ignored upon transfer.

IsTrue

• Checks whether the value is logically true

ExistsAsPK

• Checks whether the transferred value is a primary key in the configured table

IsInList

• Checks whether the transferred value is in the configured value list

Equals

• Has been replaced by the validator ComparesTo

Contains

• Checks whether the configured value exists in the transferred value

TaskExists

• Checks whether the transferred value is a valid task ID in the configured project

ResIsAssignedToTask

• Checks whether the transferred value is a valid resource assignment in the configured project and task
• Additionally, the validator can create a resource assignment if none exists.

ComparesTo

• Compares values. The validator fails if the comparison fails.
• Input value = arbitrary

YearlyTrancheExists

• Checks whether the passed year is available in the budget of the project as a yearly tranche.

AlreadyMapped

• Checks whether the ID passed from an external system has already been assigned to a PLANTA project object

IsInCalendar

• Checks whether the transferred date lies within the calendar periods
• Input value: date string in DD.MM.YY format

System check classes

Note

• Furthermore, individual check categories can be created. For more information on this, see Customize Individual System Check Class.