| Function |
Parameters |
Return Value |
Description |
PspElement.__enter__(self) |
|
The PspElement instance |
Enter the context. |
PspElement.__eq__(self, other) |
other: Another PspElement instance |
True or False |
Check if a PspElement is equal to another |
PspElement.__exit__(self, exc_type, exc_val, exc_tb) |
exc_type: Exception type
exc_val: Exception value
exc_tb: Traceback |
|
The PspElement is deleted when the context is left |
PspElement.__init__(self, uuid) |
uuid: UUID |
PspElement or None if the uuid isn't valid |
Initialize a new PspElement instance |
PspElement.can_be_deleted(self, show_error_dialog=False) |
show_error_dialog: Shows a dialog message when the element can't be deleted |
True or False |
Check if this PspElement may be deleted |
PspElement.create_child_psp_element(self, attributes=None) |
attributes: Dictionary of attribute/value pairs in DT 563 to set |
PspElement |
Create a child PspElement. It will belong to the same project and have its parent property set automatically |
PspElement.delete(self) |
|
|
Deletes the record from table 963 |
| Property |
Getter |
Setter |
Description |
| PspElement.amount_of_assigned_tasks |
 |
 |
The amount of tasks assigned to this element |
| PspElement.amount_of_child_elements |
|
|
The amount of child elements assigned to this element |
| PspElement.has_costs_or_effort_from_sap |
|
|
Returns True when any of the cost or effort fields are filled |
| PspElement.is_bottom_child_in_structure |
|
|
Returns True when there are no child elements |
| PspElement.level |
|
|
Returns the level of structure a PspElement is at. The top parent has level 1, his children level 2, their children level 3 and so on |
| PspElement.parent_element_sap_id |
|
|
Returns a ID generated like this: "Projekt-SAP-PSP-Element-ID" |
| PspElement.parent_psp |
|
|
Übergeordnetes SAP-PSP-Element |
| PspElement.parent_psp_element |
|
|
Returns a PspElement instance or None of the parent element |
| PspElement.project_id |
|
|
Projekt-ID |
| PspElement.psp_id |
|
|
SAP-PSP-Element-ID |
| PspElement.sap_costs |
|
|
Returns a named tuple with 3 attributes that tell you the costs: planned, actual and remaining |
| PspElement.sap_effort |
|
|
Returns a named tuple with 3 attributes that tell you the effort: planned, actual and remaining |
| PspElement.sum_of_costs_of_assigned_resources |
|
|
Returns a named tuple with 3 attributes that tell you the sum of the costs booked on the assigned resources: planned, actual and remaining |
| PspElement.sum_of_costs_of_assigned_resources_and_own_costs |
|
|
sap_costs + sum_of_costs_of_assigned_resources |
| PspElement.sum_of_effort_of_assigned_resources |
|
|
Returns a named tuple with 3 attributes that tell you the sum of the efforts booked on the assigned resources: planned, actual and remaining |
| PspElement.sum_of_effort_of_assigned_resources_and_own_effort |
|
|
sap_effort + sum_of_effort_of_assigned_resources |
| PspElement.summarized_costs |
|
|
Returns a named tuple with 3 attributes that tell you the sum of the costs imported from SAP combined with the costs booked in PLANTA: planned, actual and remaining |
| PspElement.summarized_effort |
|
|
Returns a named tuple with 3 attributes that tell you the sum of the effort imported from SAP combined with the costs booked in PLANTA: planned, actual and remaining |
| PspElement.tasks |
|
|
Return a list of psp_elements.Task instances where this element is assigned |
| Function |
Parameters |
Return Value |
Description |
Task.__init__(self, project_id, task_id) |
project_id: Projekt-ID
task_id: Vorgangs-ID |
The Task instance |
Initialize a new Task object |
Task.assign_psp_element(self, psp_element) |
psp_element: A PspElement instance |
True or False, depending on if the operation succeeded |
Assign a psp element to a task |
Task.can_psp_element_assignment_be_removed(self, show_error_dialog=False) |
show_error_dialog: Shows a dialog message when the psp element assignments to this task can't be removed |
True or False |
Checks if the psp element assignment can be removed from this task |
Task.can_psp_element_be_assigned(self, psp_element, show_error_dialog=False, ignore_current_assignment=False) |
psp_element: A PspElement instance
show_error_dialog: Shows a dialog message when the psp element can't be assigned to this task
ignore_current_assignment: Determines if the method should check for a existing assignment |
True or False |
Check if a psp element can be assigned to this task |
Task.clear_psp_element_assignment(self) |
|
True or False, depending on if the operation succeeded |
Remove the psp element assignment from this task |
. 
