mbu-dev-shared-components 1.2.1__tar.gz → 2.0.0__tar.gz

{mbu_dev_shared_components-1.2.1 → mbu_dev_shared_components-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mbu_dev_shared_components
-Version: 1.2.1
+Version: 2.0.0
 Summary: Shared components to use in RPA projects
 Author-email: MBU <rpa@mbu.aarhus.dk>
 Classifier: Programming Language :: Python :: 3

mbu_dev_shared_components-2.0.0/mbu_dev_shared_components/solteqtand/__init__.py

@@ -0,0 +1,32 @@
+"""
+This module provides the main entry point for the Solteq Tand application.
+"""
+from .application import (
+    app_handler,
+    appointment,
+    base_ui,
+    clinic,
+    document,
+    edi_portal,
+    event,
+    patient,
+    exceptions,
+    helper_functions,
+    SolteqTandApp
+)
+from .database import SolteqTandDatabase
+
+__all__ = [
+    "app_handler",
+    "appointment",
+    "base_ui",
+    "clinic",
+    "document",
+    "edi_portal",
+    "event",
+    "patient",
+    "exceptions",
+    "helper_functions",
+    "SolteqTandApp",
+    "SolteqTandDatabase"
+]

mbu_dev_shared_components-2.0.0/mbu_dev_shared_components/solteqtand/application/__init__.py

@@ -0,0 +1 @@
+from .app_handler import SolteqTandApp

mbu_dev_shared_components-2.0.0/mbu_dev_shared_components/solteqtand/application/app_handler.py

@@ -0,0 +1,134 @@
+
+import os
+import time
+import uiautomation as auto
+
+from .base_ui import BaseUI
+from .patient import PatientHandler
+from .document import DocumentHandler
+from .appointment import AppointmentHandler
+from .edi_portal import EDIHandler
+from .clinic import ClinicHandler
+from .event import EventHandler
+from .exceptions import (
+    ManualProcessingRequiredError,
+    NotMatchingError,
+    PatientNotFoundError,
+)
+
+
+class SolteqTandApp(
+    BaseUI,
+    PatientHandler,
+    DocumentHandler,
+    AppointmentHandler,
+    EDIHandler,
+    ClinicHandler,
+    EventHandler
+):
+    """
+    Main application handler for Solteq Tand, integrating various components.
+    
+    Inherits from:
+        BaseUI: Provides basic UI interaction methods.
+        PatientHandler: Handles patient-related operations.
+        DocumentHandler: Manages document operations.
+        AppointmentHandler: Manages appointment operations.
+        EDIHandler: Handles EDI portal interactions.
+        ClinicHandler: Manages clinic-related operations.
+        EventHandler: Processes events in the application.
+    """
+    
+    def __init__(self, app_path: str, username: str = None, password: str = None):
+        """
+        Initializes the Solteq Tand application handler.
+        
+        Args:
+            app_path (str): Path to the Solteq Tand application executable.
+        """
+        self.app_path = app_path
+        self.username = username
+        self.password = password
+        self.app_window = None
+    
+    def start_application(self):
+        """
+        Starts the application using the specified path.
+        """
+        os.startfile(self.app_path)
+
+    def login(self):
+        """
+        Logs into the application by entering the username and password.
+        Checks if the login window is open and ready.
+        Checks if the main window is opened and ready.
+        """
+        self.app_window = self.wait_for_control(
+            auto.WindowControl,
+            {'AutomationId': 'FormLogin'},
+            search_depth=3,
+            timeout=60
+        )
+        self.app_window.SetFocus()
+
+        username_box = self.app_window.EditControl(AutomationId="TextLogin")
+        username_box.SendKeys(text=self.username)
+
+        password_box = self.app_window.EditControl(AutomationId="TextPwd")
+        password_box.SendKeys(text=self.password)
+
+        login_button = self.app_window.PaneControl(AutomationId="ButtonLogin")
+        login_button.SetFocus()
+        login_button.SendKeys('{ENTER}')
+
+        self.app_window = self.wait_for_control(
+            auto.WindowControl,
+            {'AutomationId': 'FormFront'},
+            search_depth=2,
+            timeout=60
+        )
+
+    def open_sub_tab(self, sub_tab_name: str):
+        """
+        Opens a specific sub-tab in the patient's main card.
+
+        Args:
+            sub_tab_name (str): The name of the sub-tab to open (e.g., "Dokumenter").
+        """
+        sub_tab_button = self.app_window.TabItemControl(Name=sub_tab_name)
+        is_sub_tab_selected = sub_tab_button.GetPattern(10010).IsSelected
+
+        if not is_sub_tab_selected:
+            sub_tab_button.SetFocus()
+            sub_tab_button.SendKeys('{ENTER}')
+
+    def open_tab(self, tab_name: str):
+        """
+        Opens a specific tab in the patient's main card.
+        Poosibly functionality on other parts of Solteq with tabs as well.
+
+        Args:
+            tab_name (str): The name of the tab to open (e.g., "Frit valg").
+        """
+        match tab_name:
+            case "Stamkort":
+                tab_name_modified = "S&tamkort"
+            case "Fritvalg":
+                tab_name_modified = "F&ritvalg"
+            case "Journal":
+                tab_name_modified = "&Journal"
+            case "Oversigt":
+                tab_name_modified = "O&versigt"
+            case _:
+                tab_name_modified = tab_name
+
+        tab_button = self.find_element_by_property(
+            control=self.app_window,
+            control_type=auto.ControlType.TabItemControl,
+            name=tab_name_modified
+        )
+        is_tab_selected = tab_button.GetPattern(10010).IsSelected
+
+        if not is_tab_selected:
+            tab_button.SetFocus()
+            tab_button.SendKeys('{ENTER}')

mbu_dev_shared_components-2.0.0/mbu_dev_shared_components/solteqtand/application/appointment.py

@@ -0,0 +1,334 @@
+import uiautomation as auto
+
+from .base_ui import BaseUI
+from .exceptions import ManualProcessingRequiredError
+
+
+class AppointmentHandler(BaseUI):
+    """
+    Handles appointment-related UI interactions.
+    """
+
+    def get_list_of_appointments(self) -> dict: 
+        """
+        Gets list of appointments as found in patient window
+
+        Returns
+            booking_list_dict (dict): Dictionary with appointments and informations
+            booking_list_ctrls (list): List with the control related to each appointment
+
+        Todo: Assure that view is on patient
+        """
+        # Open "Stamkort"
+        self.open_tab("Stamkort")
+
+        # Read elements in list and check that expected element exists
+        # First get the list of appointments
+        list_parent = self.find_element_by_property(
+            control=self.app_window,
+            automation_id='ControlBookingDay'
+        )
+        booking_list_ctrl = self.find_element_by_property(
+            control=list_parent,
+            control_type=50008
+        )
+        # Initiate dictionary for list elements
+        booking_list = {'controls': []}
+        # Initiate list to hold headers
+        booking_list_keys = []
+        rowcount = 0
+
+        # Check for header
+        if booking_list_ctrl.GetFirstChildControl().ControlType == 50034:
+            # Loop through all elements in list
+            for elem in booking_list_ctrl.GetChildren():
+                # If header, then add each item to list of headers
+                if elem.ControlType == 50034:
+                    for colname in elem.GetChildren():
+                        booking_list_keys.append(colname.Name)
+                        booking_list[colname.Name] = []
+                # If listitem, then add each item to dict
+                if elem.ControlType == 50007:
+                    booking_list['controls'].append(elem)  # Adds the control to accessed later
+                    vals = elem.GetChildren()  # Extracts all information from control
+
+                    for headercount, val in enumerate(vals):
+                        booking_list[booking_list_keys[headercount]].append(val.Name)
+                    rowcount += 1
+
+        return booking_list
+
+    def change_appointment_status(
+            self,
+            appointment_control: auto.ControlType,
+            set_status: str,
+            send_msg: bool = False
+        ):
+        """
+        Changes status of appointment and optionally sends message
+
+        Args:
+            appointment_control (Control): Control element that identifies the appointment to be changed
+            set_status (str): The status which the appointment should be changed to.
+            send_msg (bool, optional): Indicates whether message should be sent when status is changed.
+        """
+        appointment_control.GetInvokePattern().Invoke()
+
+        # Find booking control
+        booking_control = self.wait_for_control(
+            control_type=auto.PaneControl,
+            search_params={
+                'AutomationId': 'ManageBookingControl'
+            },
+            search_depth=3
+        )
+
+        # Find appointment status dropdown
+        status_control = self.find_element_by_property(
+            control=booking_control,
+            control_type=50003,
+            name='Status'
+        )
+        # Get current status to reset if warning on save
+        current_status = status_control.GetValuePattern().Value
+
+        # Open dropdown
+        self.find_element_by_property(
+            control=status_control,
+            control_type=50000
+        ).GetInvokePattern().Invoke()
+
+        # Get list control for all status options
+        status_list_ctrl = self.wait_for_control(
+            control_type=auto.ListControl,
+            search_params={
+                'ClassName': 'ComboLBox'
+            }
+        )
+        # Load status options into dict with controls, names and lowercase names
+        status_dict = {
+            'ctrls' : [elem for elem in status_list_ctrl.GetChildren() if elem.ControlType == 50007],
+            'names' : [elem.Name for elem in status_list_ctrl.GetChildren() if elem.ControlType == 50007],
+            'names_lo': [elem.Name.lower() for elem in status_list_ctrl.GetChildren() if elem.ControlType == 50007]
+        }
+
+        # Set new status if valid, otherwise return error
+        if set_status.lower() in status_dict['names_lo']:
+            list_no = status_dict['names_lo'].index(set_status.lower())
+            status_dict['ctrls'][list_no].GetInvokePattern().Invoke()
+            # Click "Gem og udsend"
+            self.app_window = booking_control
+            if send_msg:
+                save_button = self.find_element_by_property(
+                    control=booking_control,
+                    automation_id = "ButtonSavePrint"
+                )
+            else:
+                save_button = self.find_element_by_property(
+                    control=booking_control,
+                    automation_id = "ButtonOk"
+                )
+            save_button.SendKeys('{ENTER}')
+            # Check for notification window pop up
+            try:
+                notification_ctrl = self.wait_for_control(
+                    control_type=auto.PaneControl,
+                    search_params={
+                        'AutomationId': 'BookingNotificationsControl'
+                    },
+                    search_depth=3,
+                    timeout=5
+                )
+                close_button = self.find_element_by_property(
+                    control=notification_ctrl,
+                    automation_id="ButtonCancel"
+                )
+                close_button.SendKeys('{ENTER}')
+                return
+            except TimeoutError:
+                pass
+
+            # Check for warning window pop up
+            try:
+                self.handle_error_on_booking_save(slct_button="ButtonChangeManual")
+                # Wait for status list to reappear
+                booking_control = self.wait_for_control(
+                    control_type=auto.PaneControl,
+                    search_params={
+                        'AutomationId': 'ManageBookingControl'
+                    },
+                    search_depth=3
+                )
+                # Open dropdown
+                self.find_element_by_property(
+                    control=status_control,
+                    control_type=50000
+                ).GetInvokePattern().Invoke()
+                # Reset to original value
+                list_no = status_dict['names_lo'].index(current_status.lower())
+                status_dict['ctrls'][list_no].GetInvokePattern().Invoke()
+                # Save original status
+                save_button = self.find_element_by_property(
+                    control=booking_control,
+                    automation_id = "ButtonOk"
+                )
+                save_button.SendKeys('{ENTER}')
+                # Accept despite warning
+                self.handle_error_on_booking_save(slct_button="ButtonOk")
+
+                raise ManualProcessingRequiredError
+            except TimeoutError:
+                pass
+
+            #   If warning when sending: press "ret manuelt" -> "annuler" -> return warning error 
+
+            return None
+        else:
+            print(f"{set_status} not in list. Possible status choices are: {', '.join(status_dict['names'])}")
+            raise Exception
+
+    def handle_error_on_booking_save(self, slct_button: str):
+        """Handle error window when saving booking. Select button to press"""
+        buttons = [
+            "ButtonFindNewTimeSlot",
+            "ButtonOk",
+            "ButtonChangeManual"
+        ]
+        if slct_button not in buttons:
+            print(f"{slct_button} not in buttons. Available buttons are {' '.join(buttons)}")
+            raise ValueError
+        warning_window = self.wait_for_control(
+            control_type=auto.WindowControl,
+            search_params={
+                "AutomationId": "FormBookingWarnings"
+            },
+            search_depth=5
+        )
+        button = self.find_element_by_property(
+            control=warning_window,
+            control_type=50033,
+            automation_id=slct_button
+        )
+        button.SendKeys("{ENTER}")
+
+    def get_appointments_aftalebog(
+            self,
+            close_after: bool = False,
+            headers_to_keep: list | None = None
+    ) -> dict:
+        """Function to retrive data on appointments in view in aftalebog"""
+
+        # Get list control
+        list_box = self.wait_for_control(
+            control_type=auto.GroupControl,
+            search_params={
+                "AutomationId": "GroupBoxView"
+            },
+            search_depth=5
+        )
+
+        appointment_list = self.find_element_by_property(
+            control=list_box,
+            control_type=50008
+        )
+
+        # Extract headers
+        appointment_headers = [
+            header.Name
+            for header in appointment_list.GetFirstChildControl().GetChildren()
+        ]
+
+        # Extract ListItem controls
+        appointment_ctrls = [
+            ctrl
+            for ctrl in appointment_list.GetChildren()
+            if ctrl.ControlType == 50007
+        ]
+
+        # Package data in dictionary
+        # Keep only selected headers if any selected.
+        if not headers_to_keep:
+            headers_to_keep = appointment_headers
+
+        appointment_data = {
+            j: {
+                k: v.Name
+                for k, v in zip(appointment_headers, ctrl.GetChildren())
+                if k in headers_to_keep
+            }
+            for j, ctrl in enumerate(appointment_ctrls)
+        }
+
+        if close_after:
+            # Should maybe be in a method of its own?
+            list_box.SendKeys('{Control}{F4}')
+            self.wait_for_control_to_disappear(
+                control_type=auto.WindowControl,
+                search_params={
+                    "AutomationId": "FormBooking"
+                }
+            )
+
+        return appointment_data
+
+    def create_booking_reminder(self, booking_reminder_data: dict):
+        """
+        Creates a booking reminder for the patient.
+        """
+        try:
+            self.open_tab("Stamkort")
+
+            create_booking_button = self.wait_for_control(
+                auto.PaneControl,
+                {"AutomationId": "ButtonBookingNew"},
+                search_depth=14
+                )
+            create_booking_button.GetLegacyIAccessiblePattern().DoDefaultAction()
+
+            booking_window = self.wait_for_control(
+                auto.WindowControl,
+                {"AutomationId": "MainFrame"},
+                search_depth=2
+                )
+
+            # Fill out ressourcer group
+            manage_booking = booking_window.PaneControl(AutomationId="viewPortPanel").PaneControl(AutomationId="ManageBookingControl")
+            resources_group = manage_booking.GroupControl(AutomationId="Ressourcer")
+
+            for child in resources_group.GetChildren():
+                if child.ControlTypeName == "ComboBoxControl":
+                    match child.Name:
+                        case "Aftaletype":
+                            child.GetPattern(auto.PatternId.ValuePattern).SetValue(booking_reminder_data["comboBoxBookingType"])
+                        case "Behandler":
+                            child.GetPattern(auto.PatternId.ValuePattern).SetValue(booking_reminder_data["comboBoxDentist"])
+                        case "Stol":
+                            child.GetPattern(auto.PatternId.ValuePattern).SetValue(booking_reminder_data["comboBoxChair"])
+
+            # Fill out date and time
+            date_and_time_group = manage_booking.GroupControl(AutomationId="GroupBox4")
+
+            for child in date_and_time_group.GetChildren():
+                match child.AutomationId:
+                    case "DateTimePickerStartTime":
+                        child.SendKeys(booking_reminder_data["dateTimePickerStartTime"])
+                    case "TextBoxDuration":
+                        if child.GetPattern(auto.PatternId.ValuePattern).Value != booking_reminder_data["textBoxDuration"]:
+                            child.GetPattern(auto.PatternId.ValuePattern).SetValue(booking_reminder_data["textBoxDuration"])
+                    case "ComboBoxStatus":
+                        if child.GetPattern(auto.PatternId.ValuePattern).Value != booking_reminder_data["comboBoxStatus"]:
+                            child.GetPattern(auto.PatternId.ValuePattern).SetValue(booking_reminder_data["comboBoxStatus"])
+                    case "DateTimePickerDate":
+                        child.SendKeys(booking_reminder_data["futureDate"])
+
+            manage_booking.PaneControl(AutomationId="ButtonOk").Click(simulateMove=True, waitTime=0)
+
+            booking_window_warning = self.wait_for_control(
+                auto.WindowControl,
+                {"AutomationId": "FormBookingWarnings"},
+                search_depth=4
+            )
+            booking_window_warning.PaneControl(AutomationId="ButtonOk").Click(simulateMove=True, waitTime=0)
+        except Exception as e:
+            print(f"Error while creating booking reminder: {e}")
+            raise

mbu_dev_shared_components-2.0.0/mbu_dev_shared_components/solteqtand/application/base_ui.py

@@ -0,0 +1,100 @@
+"""Base UI-Automation helper methods for SolteqTand project."""
+import time
+import uiautomation as auto
+
+
+class BaseUI:
+    """Base UI-Automation helper methods."""
+
+    def find_element_by_property(self, control, control_type=None, automation_id=None, name=None, class_name=None) -> auto.Control:
+        """
+        Uses GetChildren to traverse through controls and find an element based on the specified properties.
+
+        Args:
+            control (Control): The root control to search from (e.g., main window or pane).
+            control_type (ControlType, optional): ControlType to search for.
+            automation_id (str, optional): AutomationId of the target element.
+            name (str, optional): Name of the target element.
+            class_name (str, optional): ClassName of the target element.
+
+        Returns:
+            Control: The found element or None if no match is found.
+        """
+        children = control.GetChildren()
+
+        for child in children:
+            if (control_type is None or child.ControlType == control_type) and \
+            (automation_id is None or child.AutomationId == automation_id) and \
+            (name is None or child.Name == name) and \
+            (class_name is None or child.ClassName == class_name):
+                return child
+
+            found = self.find_element_by_property(child, control_type, automation_id, name, class_name)
+            if found:
+                return found
+
+        return None
+
+    def wait_for_control(self, control_type, search_params, search_depth=1, timeout=30, retry_interval=0.5):
+        """
+        Waits for a given control type to become available with the specified search parameters.
+
+        Args:
+            control_type: The type of control, e.g., auto.WindowControl, auto.ButtonControl, etc.
+            search_params (dict): Search parameters used to identify the control.
+                                The keys must match the properties used in the control type, e.g., 'AutomationId', 'Name'.
+            search_depth (int): How deep to search in the user interface.
+            timeout (int): Maximum time to wait for the control, in seconds.
+            retry_interval (float): Time to wait between retries, in seconds.
+
+        Returns:
+            Control: The control object if found, otherwise raises TimeoutError.
+
+        Raises:
+            TimeoutError: If the control is not found within the timeout period.
+        """
+        end_time = time.time() + timeout
+        while time.time() < end_time:
+            try:
+                control = control_type(searchDepth=search_depth, **search_params)
+                if control.Exists(0, 0):
+                    return control
+            except Exception as e:
+                print(f"Error while searching for control: {e}")
+
+            time.sleep(retry_interval)
+            print(f"Retrying to find control: {search_params}...")
+
+        raise TimeoutError(f"Control with parameters {search_params} was not found within the {timeout} second timeout.")
+
+    def wait_for_control_to_disappear(self, control_type, search_params, search_depth=1, timeout=30):
+        """
+        Waits for a given control type to disappear with the specified search parameters.
+
+        Args:
+            control_type: The type of control, e.g., auto.WindowControl, auto.ButtonControl, etc.
+            search_params (dict): Search parameters used to identify the control.
+                                The keys must match the properties used in the control type, e.g., 'AutomationId', 'Name'.
+            search_depth (int): How deep to search in the user interface.
+            timeout (int): How long to wait, in seconds.
+
+        Returns:
+            bool: True if the control disappeared within the timeout period, otherwise False.
+        """
+        end_time = time.time() + timeout
+        while time.time() < end_time:
+            try:
+                control = control_type(searchDepth=search_depth, **search_params)
+                if not control.Exists(0, 0):
+                    return True
+            except Exception as e:
+                print(f"Error while searching for control: {e}")
+
+            time.sleep(0.5)
+            print(f"Retrying to find control: {search_params}...")
+
+        raise TimeoutError(f"Control with parameters {search_params} did not disappear within the timeout period.")
+
+    def close_window(self, window_to_close: auto.WindowControl) -> None:
+        """Closes specified window by sending CTRL+F4 keystroke."""
+        window_to_close.SendKeys(text="^({F4})")

mbu_dev_shared_components-2.0.0/mbu_dev_shared_components/solteqtand/application/clinic.py

@@ -0,0 +1,75 @@
+import uiautomation as auto
+
+from .base_ui import BaseUI
+
+
+class ClinicHandler(BaseUI):
+    """
+    Handles changing the primart clinic for a patient (if it's not "Tandplejen Aarhus").
+    """
+
+    def change_primary_clinic(self, current_primary_clinic: str, is_field_locked: bool):
+        """
+        Changes the primary clinic for the patient.
+        """
+        try:
+            self.open_tab("Stamkort")
+
+            if current_primary_clinic != "Tandplejen Aarhus":
+                if is_field_locked:
+                    locked_field = self.wait_for_control(
+                        auto.CheckBoxControl,
+                        {'AutomationId': 'CheckPatientClinicRegLocked'},
+                        search_depth=9
+                    )
+
+                    if locked_field.GetPattern(auto.PatternId.TogglePattern).ToggleState:
+                        locked_field.GetPattern(auto.PatternId.TogglePattern).Toggle()
+                        locked_field.SendKeys('{Ctrl}s', waitTime=0)
+
+                box_clinic_parent = self.wait_for_control(
+                    auto.GroupControl,
+                    {'AutomationId': 'GroupBoxPatientDentalInfo'},
+                    search_depth=8
+                )
+                box_clinic = box_clinic_parent.PaneControl(
+                    searchDepth=2,
+                    AutomationId="ControlClinicSelectorPatientClinicReg"
+                    ).PaneControl(
+                        searchDepth=2,
+                        AutomationId="PictureBoxClinic"
+                        )
+                box_clinic.Click(simulateMove=False, waitTime=0)
+
+                clinic_list = self.wait_for_control(
+                    auto.WindowControl,
+                    {'AutomationId': 'FormFindClinics'},
+                    search_depth=2
+                )
+
+                clinic_list_items = clinic_list.ListControl(AutomationId="ListClinics").ListItemControl(Name="Tandplejen Aarhus")
+                clinic_list_items.GetPattern(10017).ScrollIntoView()
+                clinic_list_items.SetFocus()
+                clinic_list_items.DoubleClick(simulateMove=False, waitTime=0)
+
+                locked_field = self.wait_for_control(
+                    auto.CheckBoxControl,
+                    {'AutomationId': 'CheckPatientClinicRegLocked'},
+                    search_depth=9
+                )
+
+                if locked_field.GetPattern(auto.PatternId.TogglePattern).ToggleState == 0:
+                    locked_field.GetPattern(auto.PatternId.TogglePattern).Toggle()
+                    locked_field.SendKeys('{Ctrl}s', waitTime=0)
+
+                self.wait_for_control(
+                    auto.TextControl,
+                    {'Name': 'Patient er gemt.'},
+                    search_depth=3
+                )
+
+                print("Primary clinic changed successfully.")
+            print("Patient already has the primary clinic set to 'Tandplejen Aarhus'")
+        except Exception as e:
+            print(f"Error while changing primary clinic: {e}")
+            raise